CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
OdGiImageBGRA32 Class Reference

#include <GiImage.h>

Public Member Functions

 OdGiImageBGRA32 ()
 
 OdGiImageBGRA32 (OdUInt32 imageWidth, OdUInt32 imageHeight, OdGiPixelBGRA32 *imageData)
 
OdGiPixelBGRA32image () const
 
OdUInt32 width () const
 
OdUInt32 height () const
 
void setImage (OdUInt32 imageWidth, OdUInt32 imageHeight, OdGiPixelBGRA32 *imageData)
 

Detailed Description

This class defines image color parameters in RGB format, which stores an integer for red, green, and blue values, and includes a value for alpha-shading.

Corresponding C++ library: TD_Gi

<group OdGi_Classes>

Definition at line 323 of file GiImage.h.

Constructor & Destructor Documentation

◆ OdGiImageBGRA32() [1/2]

OdGiImageBGRA32::OdGiImageBGRA32 ( )
inline

Constructor for the OdGiImageBGRA32 class. Creates an object with no underlaying image and with 0 width and height.

Definition at line 329 of file GiImage.h.

◆ OdGiImageBGRA32() [2/2]

OdGiImageBGRA32::OdGiImageBGRA32 ( OdUInt32  imageWidth,
OdUInt32  imageHeight,
OdGiPixelBGRA32 imageData 
)
inline

Constructor for the OdGiImageBGRA32 class. Creates an image with specified width, height and pixel data.

Parameters
imageWidth[in] Image width in pixels.
imageHeight[in] Image height in pixels.
imageData[in] Pointer to an array of OdGiPixelBGRA32 objects that represent image pixels.

Definition at line 343 of file GiImage.h.

Member Function Documentation

◆ height()

OdUInt32 OdGiImageBGRA32::height ( ) const
inline

Retrieves a height of this image in pixels.

Returns
image height in pixels.

Gets the height of an image.

Definition at line 409 of file GiImage.h.

◆ image()

OdGiPixelBGRA32 * OdGiImageBGRA32::image ( ) const
inline

Retrieves pixel data of this image.

Returns
pointer to an array of OdGiPixelBGRA32 objects that represent pixels of this image.

Gets the buffer data of an image.

Definition at line 393 of file GiImage.h.

◆ setImage()

void OdGiImageBGRA32::setImage ( OdUInt32  imageWidth,
OdUInt32  imageHeight,
OdGiPixelBGRA32 imageData 
)
inline

Specifies image parameters.

Parameters
imageWidth[in] Image width in pixels.
imageHeight[in] Image height in pixels.
imageData[in] Pointer to an array of OdGiPixelBGRA32 objects that represent image pixels.

Sets the buffer data, width, and height of an image.

Definition at line 417 of file GiImage.h.

◆ width()

OdUInt32 OdGiImageBGRA32::width ( ) const
inline

Retrieves a width of this image in pixels.

Returns
image width in pixels.

Gets the width of an image.

Definition at line 401 of file GiImage.h.


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