OdGiPixelBGRA32 Class Reference

#include <GiImage.h>

Public Member Functions
	OdGiPixelBGRA32 ()
	OdGiPixelBGRA32 (OdUInt32 bgra)
	OdGiPixelBGRA32 (OdUInt8 blue, OdUInt8 green, OdUInt8 red, OdUInt8 alpha)
OdUInt32	getBGRA () const
OdUInt32	getRGBA () const
OdUInt8	blue () const
OdUInt8	green () const
OdUInt8	red () const
OdUInt8	alpha () const
void	setBGRA (OdUInt32 bgra)
void	setBGRA (OdUInt8 blue, OdUInt8 green, OdUInt8 red, OdUInt8 alpha)
void	setRGBA (OdUInt32 rgba)
void	setRGBA (OdUInt8 red, OdUInt8 green, OdUInt8 blue, OdUInt8 alpha)
void	setBlue (OdUInt8 blue)
void	setGreen (OdUInt8 green)
void	setRed (OdUInt8 red)
void	setAlpha (OdUInt8 alpha)

Detailed Description

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

Corresponding C++ library: TD_Gi

<group OdGi_Classes>

Definition at line 43 of file GiImage.h.

Constructor & Destructor Documentation

OdGiPixelBGRA32() [1/3]

OdGiPixelBGRA32::OdGiPixelBGRA32 ( )

inline

Constructor for the OdGiPixelBGRA32 class. Creates an object that represent a fully opaque black color.

Definition at line 49 of file GiImage.h.

OdGiPixelBGRA32() [2/3]

OdGiPixelBGRA32::OdGiPixelBGRA32 ( OdUInt32  bgra )

inline

Constructor for the OdGiPixelBGRA32 class. Creates an object with a specified value which represents a color in a decimal format.

Parameters

bgra	[in] Color in decimal format.

Definition at line 60 of file GiImage.h.

OdGiPixelBGRA32() [3/3]

OdGiPixelBGRA32::OdGiPixelBGRA32 ( OdUInt8  blue, OdUInt8  green, OdUInt8  red, OdUInt8  alpha  )

inline

Constructor for the OdGiPixelBGRA32 class. Creates an object with specified blue, red, green and alpha values.

Parameters

blue	[in] Blue color component.
green	[in] Green color component.
red	[in] Red color component.
alpha	[in] Alpha color component.

Definition at line 73 of file GiImage.h.

Member Function Documentation

alpha()

OdUInt8 OdGiPixelBGRA32::alpha ( ) const

inline

Retrieves alpha component of the color.

Returns

alpha component as OdUInt8 value.

Gets the alpha shading value of the color.

Definition at line 240 of file GiImage.h.

blue()

OdUInt8 OdGiPixelBGRA32::blue ( ) const

inline

Retrieves blue component of the color.

Returns

blue component as OdUInt8 value.

Gets the blue value of the color.

Definition at line 216 of file GiImage.h.

getBGRA()

OdUInt32 OdGiPixelBGRA32::getBGRA ( ) const

inline

Retrieves color in BGRA format.

Returns

Color in BGRA format as decimal value.

Gets the color values in blue, green, red, alpha order.

Definition at line 200 of file GiImage.h.

getRGBA()

OdUInt32 OdGiPixelBGRA32::getRGBA ( ) const

inline

Retrieves color in RGBA format.

Returns

Color in RGBA format as decimal value.

Gets the color values in red, green, blue, alpha order.

Definition at line 208 of file GiImage.h.

green()

OdUInt8 OdGiPixelBGRA32::green ( ) const

inline

Retrieves green component of the color.

Returns

green component as OdUInt8 value.

Gets the green value of the color.

Definition at line 224 of file GiImage.h.

red()

OdUInt8 OdGiPixelBGRA32::red ( ) const

inline

Retrieves red component of the color.

Returns

red component as OdUInt8 value.

Gets the red value of the color.

Definition at line 232 of file GiImage.h.

setAlpha()

void OdGiPixelBGRA32::setAlpha ( OdUInt8  alpha )

inline

Specifies alpha component of color.

Parameters

alpha

[in] Alpha color component.

Sets the alpha-shading value of a color.

Definition at line 310 of file GiImage.h.

setBGRA() [1/2]

void OdGiPixelBGRA32::setBGRA ( OdUInt32  bgra )

inline

Specifies a new color.

Parameters

bgra	[in] BGRA color in decimal format.

Sets the color values in blue, green, red, alpha order.

Definition at line 248 of file GiImage.h.

setBGRA() [2/2]

void OdGiPixelBGRA32::setBGRA ( OdUInt8  blue, OdUInt8  green, OdUInt8  red, OdUInt8  alpha  )

inline

Specifies a color with individual blue, green, red and alpha values.

Parameters

blue	[in] Blue color component.
green	[in] Green color component.
red	[in] Red color component.
alpha	[in] Alpha color component.

Sets the color values in blue, green, red, alpha order.

Definition at line 256 of file GiImage.h.

setBlue()

void OdGiPixelBGRA32::setBlue ( OdUInt8  blue )

inline

Specifies a blue component of color.

Parameters

blue	[in] Blue color component.

Sets the blue value of a color.

Definition at line 286 of file GiImage.h.

setGreen()

void OdGiPixelBGRA32::setGreen ( OdUInt8  green )

inline

Specifies a green component of color.

Parameters

green

[in] Green color component.

Sets the green value of a color.

Definition at line 294 of file GiImage.h.

setRed()

void OdGiPixelBGRA32::setRed ( OdUInt8  red )

inline

Specifies a red component of color.

Parameters

red	[in] Red color component.

Sets the red value of a color.

Definition at line 302 of file GiImage.h.

setRGBA() [1/2]

void OdGiPixelBGRA32::setRGBA ( OdUInt32  rgba )

inline

Specifies a new color.

Parameters

rgba	[in] RGBA color in decimal format.

Sets the color values in red, green, blue, alpha order.

Definition at line 267 of file GiImage.h.

setRGBA() [2/2]

void OdGiPixelBGRA32::setRGBA ( OdUInt8  red, OdUInt8  green, OdUInt8  blue, OdUInt8  alpha  )

inline

Specifies a color with individual red, green, blue and alpha values.

Parameters

red	[in] Red color component.
green	[in] Green color component.
blue	[in] Blue color component.
alpha	[in] Alpha color component.

Sets the color values in red, green, blue, alpha order.

Definition at line 275 of file GiImage.h.

---

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

• GiImage.h