37 const unsigned pWidth,
const unsigned pHeight,
153 const int pX,
const int pY,
const int pWidth,
const int pHeight);
189 FGAPI Image(
const unsigned pWidth,
const unsigned pHeight,
276 const int pX,
const int pY,
const int pVPW,
const int pVPH)
const;
FGAPI fg_err fg_get_image_pixelformat(fg_channel_format *pOut, const fg_image pImage)
Get the channel format of the image.
FGAPI Image(const unsigned pWidth, const unsigned pHeight, const ChannelFormat pFormat=FG_RGBA, const dtype pDataType=f32)
Creates a Image object.
FGAPI unsigned height() const
Get Image height.
FGAPI fg_err fg_set_image_alpha(fg_image pImage, const float pAlpha)
Set a global alpha value for rendering the image.
Definition: defines.h:193
FGAPI ChannelFormat pixelFormat() const
Get Image's channel format.
Four(Red, Green, Blue & Alpha) channels.
Definition: defines.h:113
FGAPI void render(const Window &pWindow, const int pX, const int pY, const int pVPW, const int pVPH) const
Render the image to given window.
FGAPI fg_err fg_get_image_width(unsigned *pOut, const fg_image pImage)
Get the width of the image.
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.
FGAPI void keepAspectRatio(const bool pKeep)
Set option to inform whether to maintain aspect ratio of original image.
dtype
Definition: defines.h:188
FGAPI fg_err fg_get_image_height(unsigned *pOut, const fg_image pImage)
Get the height of the image.
fg_channel_format
Definition: defines.h:108
FGAPI unsigned size() const
Get the image data size in bytes.
#define FGAPI
Definition: defines.h:28
FGAPI fg_err fg_retain_image(fg_image *pOut, fg_image pImage)
Increment the internal reference counter for image resource.
FGAPI fg_err fg_get_image_size(unsigned *pOut, const fg_image pImage)
Get the image buffer size in bytes.
FGAPI unsigned pixels() const
Get the resource id of image buffer.
FGAPI dtype channelType() const
Get Image's integral data type.
void * fg_image
Definition: defines.h:43
FGAPI ~Image()
Image Destructor.
fg_err
Definition: defines.h:49
FGAPI fg_err fg_release_image(fg_image pImage)
Destroy image object.
FGAPI fg_err fg_get_pixel_buffer(unsigned *pOut, const fg_image pImage)
Get the image buffer resource identifier.
FGAPI unsigned width() const
Get Image width.
Image is plain rendering of an image over the window or sub-region of it.
Definition: image.h:174
Window is where other objects such as Images, Plots etc.
Definition: window.h:300
FGAPI void setAlpha(const float pAlpha)
Set a global alpha value for rendering the image.
void * fg_window
Definition: defines.h:40
FGAPI fg_err fg_get_image_type(fg_dtype *pOut, const fg_image pImage)
Get the pixel data type of the image.
fg_dtype
Definition: defines.h:150
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.
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.