Forge
Image Class Reference

#include <image.h>

Public Member Functions

FGAPI Image (unsigned pWidth, unsigned pHeight, ChannelFormat pFormat, dtype pDataType)
 Creates a Image object. More...
 
FGAPI Image (const Image &other)
 Copy constructor of Image. More...
 
FGAPI ~Image ()
 Image Destructor. More...
 
FGAPI unsigned width () const
 Get Image width. More...
 
FGAPI unsigned height () const
 Get Image height. More...
 
FGAPI ChannelFormat pixelFormat () const
 Get Image's channel format. More...
 
FGAPI dtype channelType () const
 Get Image's integral data type. More...
 
FGAPI unsigned pbo () const
 Get the OpenGL Pixel Buffer Object identifier. More...
 
FGAPI unsigned size () const
 Get the OpenGL Pixel Buffer Object resource size. More...
 
FGAPI internal::_Image * get () const
 Get the handle to internal implementation of Image. More...
 

Constructor & Destructor Documentation

◆ Image() [1/2]

FGAPI Image ( unsigned  pWidth,
unsigned  pHeight,
ChannelFormat  pFormat,
dtype  pDataType 
)

Creates a Image object.

Parameters
[in]pWidthWidth of the image
[in]pHeightHeight of the image
[in]pFormatColor channel format of image, uses one of the values of ChannelFormat
[in]pDataTypetakes one of the values of dtype that indicates the integral data type of histogram data

◆ Image() [2/2]

FGAPI Image ( const Image other)

Copy constructor of Image.

Parameters
[in]otheris the Image of which we make a copy of.

◆ ~Image()

FGAPI ~Image ( )

Image Destructor.

Member Function Documentation

◆ channelType()

FGAPI dtype channelType ( ) const

Get Image's integral data type.

Returns
dtype value of Image

◆ get()

FGAPI internal::_Image* get ( ) const

Get the handle to internal implementation of Image.

◆ height()

FGAPI unsigned height ( ) const

Get Image height.

Returns
image width

◆ pbo()

FGAPI unsigned pbo ( ) const

Get the OpenGL Pixel Buffer Object identifier.

Returns
OpenGL PBO resource id.

◆ pixelFormat()

FGAPI ChannelFormat pixelFormat ( ) const

Get Image's channel format.

Returns
ChannelFormat value of Image

◆ size()

FGAPI unsigned size ( ) const

Get the OpenGL Pixel Buffer Object resource size.

Returns
OpenGL PBO resource size.

◆ width()

FGAPI unsigned width ( ) const

Get Image width.

Returns
image width

The documentation for this class was generated from the following file: