BufferGfx
Describes a graphics buffer. The other DMAI modules perform graphics operations on instances of this module. This module is a submodule of the Buffer module, and all the Buffer module functions can also be used on a BufferGfx instance. Typical usage below for a D1 PAL sized buffer of color type UYVY (no error checking):.
More...
|
Data Structures |
struct | BufferGfx_Dimensions |
| Describes the dimensions of a graphics Buffer. More...
|
struct | BufferGfx_Attrs |
| Describes the attributes used to create a BufferGfx instance. More...
|
Functions |
Buffer_Attrs * | BufferGfx_getBufferAttrs (BufferGfx_Attrs *gfxAttrs) |
| Get the basic Buffer_Attrs of a BufferGfx_Attrs structure.
|
Int32 | BufferGfx_calcSize (VideoStd_Type videoStd, ColorSpace_Type colorSpace) |
| Calculate the size of a Buffer given a VideoStd_Type and a ColorSpace_Type.
|
Int32 | BufferGfx_calcSizeDim (BufferGfx_Dimensions *dimPtr, ColorSpace_Type colorSpace) |
| Calculate the size of a Buffer given BufferGfx_Dimensions and a ColorSpace_Type.
|
Int | BufferGfx_calcDimensions (VideoStd_Type videoStd, ColorSpace_Type colorSpace, BufferGfx_Dimensions *dimPtr) |
| Calculate the dimensions of a Buffer given a VideoStd_Type and a ColorSpace_Type.
|
Int32 | BufferGfx_calcLineLength (Int32 width, ColorSpace_Type colorSpace) |
| Calculate the line length (pitch) of a Buffer given a ColorSpace_Type.
|
Int32 | BufferGfx_getFrameType (Buffer_Handle hBuf) |
| Get the frame type of a BufferGfx instance.
|
Void | BufferGfx_setFrameType (Buffer_Handle hBuf, Int32 frameType) |
| Set the frame type of a BufferGfx instance,.
|
ColorSpace_Type | BufferGfx_getColorSpace (Buffer_Handle hBuf) |
| Get the ColorSpace_Type of a BufferGfx instance.
|
Void | BufferGfx_setColorSpace (Buffer_Handle hBuf, ColorSpace_Type colorSpace) |
| Set the ColorSpace_Type of a BufferGfx instance.
|
Void | BufferGfx_getDimensions (Buffer_Handle hBuf, BufferGfx_Dimensions *dimPtr) |
| Get the BufferGfx_Dimensions of a BufferGfx instance. If the current dimensions are not set (all fields set to 0), the original dimensions will be returned, otherwise the current dimensions are returned.
|
Int | BufferGfx_setDimensions (Buffer_Handle hBuf, BufferGfx_Dimensions *dimPtr) |
| Set the current BufferGfx_Dimensions of a BufferGfx instance.
|
Void | BufferGfx_resetDimensions (Buffer_Handle hBuf) |
| Reset the dimensions to the original create time dimensions.
|
Int | BufferGfx_setMaxDimensions (Buffer_Handle hBuf, BufferGfx_Dimensions *dimPtr) |
| Set the maximum dimensions of a Buffer reference.
|
Variables |
const BufferGfx_Attrs | BufferGfx_Attrs_DEFAULT |
| The default BufferGfx_Attrs used to create a BufferGfx instance.
|
Detailed Description
Describes a graphics buffer. The other DMAI modules perform graphics operations on instances of this module. This module is a submodule of the Buffer module, and all the Buffer module functions can also be used on a BufferGfx instance. Typical usage below for a D1 PAL sized buffer of color type UYVY (no error checking):.
Function Documentation
Calculate the size of a Buffer given a VideoStd_Type and a ColorSpace_Type.
- Parameters:
-
- Return values:
-
| Size | estimation in bytes of the graphics Buffer. |
| Negative value | for failure, see Dmai.h. |
Calculate the size of a Buffer given BufferGfx_Dimensions and a ColorSpace_Type.
- Parameters:
-
[in] | dimPtr | Dimensions of the graphics Buffer. |
[in] | colorSpace | Color space type, see ColorSpace_Type. |
- Return values:
-
| Size | estimation in bytes of the graphics Buffer. |
Calculate the dimensions of a Buffer given a VideoStd_Type and a ColorSpace_Type.
- Parameters:
-
- Return values:
-
| Dmai_EOK | for success. |
| Negative value | for failure, see Dmai.h. |
Calculate the line length (pitch) of a Buffer given a ColorSpace_Type.
- Parameters:
-
[in] | colorSpace | Color space type, see ColorSpace_Type. |
[in] | width | The width to calculate the line length for. |
- Return values:
-
| Line length | as a result of the calculation. |
| Negative value | for failure, see Dmai.h. |
Get the frame type of a BufferGfx instance.
- Parameters:
-
[in] | hBuf | Handle to the Buffer to get the frame type for. |
- Return values:
-
Void BufferGfx_setFrameType |
( |
Buffer_Handle |
hBuf, |
|
|
Int32 |
frameType | |
|
) |
| | |
Set the frame type of a BufferGfx instance,.
- Parameters:
-
[in] | hBuf | Handle to the graphics Buffer to get the frame type for. |
[in] | frameType | Frane type to set the Buffer to. |
Get the ColorSpace_Type of a BufferGfx instance.
- Parameters:
-
[in] | hBuf | Handle to the graphics Buffer to get the color space type for |
- Return values:
-
Set the ColorSpace_Type of a BufferGfx instance.
- Parameters:
-
[in] | hBuf | Handle to the graphics Buffer to set the color space type for |
[in] | colorSpace | ColorSpace_Type to set the Buffer to. |
Get the BufferGfx_Dimensions of a BufferGfx instance. If the current dimensions are not set (all fields set to 0), the original dimensions will be returned, otherwise the current dimensions are returned.
- Parameters:
-
[in] | hBuf | Handle to the graphics Buffer to get the dimensions for. |
[out] | dimPtr | Dimensions of the graphics Buffer is returned here. |
Set the current BufferGfx_Dimensions of a BufferGfx instance.
- Parameters:
-
[in] | hBuf | Handle to the graphics Buffer to set the dimensions for. |
[out] | dimPtr | Dimensions of the graphics Buffer to set. |
- Return values:
-
| Dmai_EOK | for success. |
| Negative value | for failure, see Dmai.h. |
Reset the dimensions to the original create time dimensions.
- Parameters:
-
[in] | hBuf | Handle to the graphics Buffer to reset the dimensions for. |
Set the maximum dimensions of a Buffer reference.
- Parameters:
-
[in] | hBuf | Handle to the graphics Buffer reference to set the maximum dimensions of. |
[in] | dimPtr | Maximum dimensions to set. |
- Return values:
-
| Dmai_EOK | for success. |
| Negative value | for failure, see Dmai.h. |
Variable Documentation