Forge
|
Functions | |
FGAPI fg_err | fg_create_image (fg_image *pImage, const unsigned pWidth, const unsigned pHeight, const fg_channel_format pFormat, const fg_dtype pType) |
Create a Image object. More... | |
FGAPI fg_err | fg_retain_image (fg_image *pOut, fg_image pImage) |
Increment the internal reference counter for image resource. More... | |
FGAPI fg_err | fg_release_image (fg_image pImage) |
Destroy image object. More... | |
FGAPI fg_err | fg_set_image_alpha (fg_image pImage, const float pAlpha) |
Set a global alpha value for rendering the image. More... | |
FGAPI fg_err | fg_set_image_aspect_ratio (fg_image pImage, const bool pKeepRatio) |
Set option to inform whether to maintain aspect ratio of original image. More... | |
FGAPI fg_err | fg_get_image_width (unsigned *pOut, const fg_image pImage) |
Get the width of the image. More... | |
FGAPI fg_err | fg_get_image_height (unsigned *pOut, const fg_image pImage) |
Get the height of the image. More... | |
FGAPI fg_err | fg_get_image_pixelformat (fg_channel_format *pOut, const fg_image pImage) |
Get the channel format of the image. More... | |
FGAPI fg_err | fg_get_image_type (fg_dtype *pOut, const fg_image pImage) |
Get the pixel data type of the image. More... | |
FGAPI fg_err | fg_get_pixel_buffer (unsigned *pOut, const fg_image pImage) |
Get the image buffer resource identifier. More... | |
FGAPI fg_err | fg_get_image_size (unsigned *pOut, const fg_image pImage) |
Get the image buffer size in bytes. More... | |
FGAPI fg_err | fg_render_image (const fg_window pWindow, const fg_image pImage, const int pX, const int pY, const int pWidth, const int pHeight) |
Render the image to given window. More... | |
FGAPI fg_err fg_create_image | ( | fg_image * | pImage, |
const unsigned | pWidth, | ||
const unsigned | pHeight, | ||
const fg_channel_format | pFormat, | ||
const fg_dtype | pType | ||
) |
Create a Image object.
[out] | pImage | will be set to created Image object |
[in] | pWidth | Width of the image |
[in] | pHeight | Height of the image |
[in] | pFormat | Color channel format of image, uses one of the values of fg_channel_format |
[in] | pType | takes one of the values of fg_dtype that indicates the integral data type of histogram data |
Get the height of the image.
[out] | pOut | will be set to the height of the image |
[in] | pImage | is the image handle |
FGAPI fg_err fg_get_image_pixelformat | ( | fg_channel_format * | pOut, |
const fg_image | pImage | ||
) |
Get the channel format of the image.
[out] | pOut | will be set to the channel format of the image |
[in] | pImage | is the image handle |
Get the image buffer size in bytes.
[out] | pOut | will be set to the image buffer size in bytes |
[in] | pImage | is the image handle |
Get the pixel data type of the image.
[out] | pOut | will be set to the pixel data type of the image |
[in] | pImage | is the image handle |
Get the width of the image.
[out] | pOut | will be set to the width of the image |
[in] | pImage | is the image handle |
Get the image buffer resource identifier.
[out] | pOut | will be set to the image resource identifier |
[in] | pImage | is the image handle |
FGAPI fg_err fg_render_image | ( | const fg_window | pWindow, |
const fg_image | pImage, | ||
const int | pX, | ||
const int | pY, | ||
const int | pWidth, | ||
const int | pHeight | ||
) |
Render the image to given window.
[in] | pWindow | is target window to where image will be rendered |
[in] | pImage | is the image handle |
[in] | pX | is x coordinate of origin of viewport in window coordinates |
[in] | pY | is y coordinate of origin of viewport in window coordinates |
[in] | pWidth | is the width of the viewport |
[in] | pHeight | is the height of the viewport |
Increment the internal reference counter for image resource.
[out] | pOut | is new reference to existing image resource |
[in] | pImage | is the input image resource handle |
Set a global alpha value for rendering the image.
[in] | pImage | is the image handle |
[in] | pAlpha |
Set option to inform whether to maintain aspect ratio of original image.
[in] | pImage | is the image handle |
[in] | pKeepRatio | informs the image object if original aspect ratio has to be maintained |