Image is plain rendering of an image over the window or sub-region of it.
More...
#include <image.h>
Image is plain rendering of an image over the window or sub-region of it.
- Examples:
- cpu/fractal.cpp, cpu/histogram.cpp, opencl/fractal.cpp, and opencl/histogram.cpp.
◆ Image() [1/3]
Creates a Image object.
- Parameters
-
[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 ChannelFormat |
[in] | pDataType | takes one of the values of dtype that indicates the integral data type of histogram data |
◆ Image() [2/3]
Copy constructor of Image.
- Parameters
-
[in] | pOther | is the Image of which we make a copy of. |
◆ Image() [3/3]
Construct Image ojbect from fg_image resource handle.
- Parameters
-
[in] | pHandle | is the input fg_image resource handle |
- Note
- This kind of construction assumes ownership of the resource handle is released during the Image object's destruction.
◆ ~Image()
◆ channelType()
◆ get()
Get the handle to internal implementation of Image.
◆ height()
FGAPI unsigned height |
( |
| ) |
const |
Get Image height.
- Returns
- image width
◆ keepAspectRatio()
FGAPI void keepAspectRatio |
( |
const bool |
pKeep | ) |
|
Set option to inform whether to maintain aspect ratio of original image.
- Parameters
-
◆ pixelFormat()
◆ pixels()
FGAPI unsigned pixels |
( |
| ) |
const |
◆ render()
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.
- Parameters
-
[in] | pWindow | is target window to where image will be rendered |
[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] | pVPW | is the width of the viewport |
[in] | pVPH | is the height of the viewport |
◆ setAlpha()
FGAPI void setAlpha |
( |
const float |
pAlpha | ) |
|
Set a global alpha value for rendering the image.
- Parameters
-
◆ size()
FGAPI unsigned size |
( |
| ) |
const |
◆ width()
FGAPI unsigned width |
( |
| ) |
const |
Get Image width.
- Returns
- image width
The documentation for this class was generated from the following file: