floatfield.h File Reference
#include "fvstypes.h"
Go to the source code of this file.
Typedef Documentation
|
the implementation of the object is private and must not be known by the user. Use this handle to manipulate the floating point field through the functions provided hereunder. |
Function Documentation
|
Create a new floating point field object. - Returns:
- NULL if allocation failed, otherwise a new object handle.
|
|
Destroy an existing floating point field object. - Parameters:
-
field | pointer to a floating point field object |
- Returns:
- nothing.
|
|
Set the size if a floating point field. The memory allocation is done automatically when needed and the function returns an error if it failed. - Parameters:
-
field | a floating point field object |
width | width in pixels |
height | height in pixels |
- Returns:
- an error code.
|
|
Copy a source image into a destination image. The memory allocation and resizing is done automatically when needed. - Parameters:
-
destination | a destination floating point field object |
source | a source floating point field object |
- Returns:
- an error code.
|
|
Clear an image. Resets the contents of a floating point field to zero. - Parameters:
-
field | a floating point field object |
- Returns:
- an error code.
|
|
Set all values in the floating point field to a specific value. - Parameters:
-
field | a floating point field object |
value | the value of every pixel after the call |
- Returns:
- an error code.
|
|
Set a floating point value in a floating point field at specified coordinates. - Parameters:
-
field | a floating point field object |
x | x-coordinate |
y | y-coordinate |
val | value to set |
- Returns:
- nothing
|
|
This function returns the value for the x and y coordinates. - Parameters:
-
field | a floating point field object |
x | x-coordinate |
y | y-coordinate |
- Returns:
- the floating point value
|
|
Returns a pointer to the floating point field buffer. - Parameters:
-
field | a floating point field object |
- Returns:
- a pointer to the beginning of the memory buffer
|
|
Retrieve the floating point field width. - Parameters:
-
field | a floating point field object |
- Returns:
- the width in pixels
|
|
Retrieve the floating point field height. - Parameters:
-
field | a floating point field object |
- Returns:
- the heigth in pixels
|
|
Get the pitch. The pitch of a floating point field is not necessary the width that was specified when setting the size. In the floating point field, the value at position (x,y) in the buffer is at address x + y * pitch. - Parameters:
-
field | a floating point field object |
- Returns:
- the pitch in bytes
|