Open CASCADE Technology  7.7.0.dev
Public Member Functions | Static Public Member Functions

Image_PixMap Class Reference

Class represents packed image plane. More...

#include <Image_PixMap.hxx>

Inheritance diagram for Image_PixMap:
Inheritance graph
[legend]

Public Member Functions

Image_Format Format () const
 Return pixel format. More...
 
void SetFormat (const Image_Format thePixelFormat)
 Override pixel format specified by InitXXX() methods. Will throw exception if pixel size of new format is not equal to currently initialized format. Intended to switch formats indicating different interpretation of the same data (e.g. ImgGray and ImgAlpha). More...
 
Standard_Size Width () const
 Return image width in pixels. More...
 
Standard_Size Height () const
 Return image height in pixels. More...
 
Standard_Size Depth () const
 Return image depth in pixels. More...
 
Standard_Size SizeX () const
 Return image width in pixels. More...
 
Standard_Size SizeY () const
 Return image height in pixels. More...
 
Standard_Size SizeZ () const
 Return image depth in pixels. More...
 
NCollection_Vec3< Standard_SizeSizeXYZ () const
 Return image width x height x depth in pixels. More...
 
Standard_Real Ratio () const
 Return width / height. More...
 
bool IsEmpty () const
 Return true if data is NULL. More...
 
 Image_PixMap ()
 Empty constructor. Initialize the NULL image plane. More...
 
virtual ~Image_PixMap ()
 Destructor. More...
 
Quantity_ColorRGBA PixelColor (Standard_Integer theX, Standard_Integer theY, Standard_Boolean theToLinearize=false) const
 Returns the pixel color. This function is relatively slow. Beware that this method takes coordinates in opposite order in contrast to ::Value() and ::ChangeValue(). More...
 
void SetPixelColor (const Standard_Integer theX, const Standard_Integer theY, const Quantity_Color &theColor, const Standard_Boolean theToDeLinearize=false)
 Sets the pixel color. This function is relatively slow. Beware that this method takes coordinates in opposite order in contrast to ::Value() and ::ChangeValue(). More...
 
void SetPixelColor (const Standard_Integer theX, const Standard_Integer theY, const Quantity_ColorRGBA &theColor, const Standard_Boolean theToDeLinearize=false)
 Sets the pixel color. This function is relatively slow. Beware that this method takes coordinates in opposite order in contrast to ::Value() and ::ChangeValue(). More...
 
virtual bool InitWrapper (Image_Format thePixelFormat, Standard_Byte *theDataPtr, const Standard_Size theSizeX, const Standard_Size theSizeY, const Standard_Size theSizeRowBytes=0)
 Initialize image plane as wrapper over alien data. Data will not be copied! Notice that caller should ensure that data pointer will not be released during this wrapper lifetime. You may call InitCopy() to perform data copying. More...
 
virtual bool InitTrash (Image_Format thePixelFormat, const Standard_Size theSizeX, const Standard_Size theSizeY, const Standard_Size theSizeRowBytes=0)
 Initialize image plane with required dimensions. Memory will be left uninitialized (performance trick). More...
 
virtual bool InitCopy (const Image_PixMap &theCopy)
 Initialize by copying data. If you want to copy alien data you should create wrapper using InitWrapper() before. More...
 
bool InitZero (Image_Format thePixelFormat, const Standard_Size theSizeX, const Standard_Size theSizeY, const Standard_Size theSizeRowBytes=0, const Standard_Byte theValue=0)
 Initialize image plane with required dimensions. Buffer will be zeroed (black color for most formats). More...
 
virtual void Clear ()
 Method correctly deallocate internal buffer. More...
 
virtual bool InitWrapper3D (Image_Format thePixelFormat, Standard_Byte *theDataPtr, const NCollection_Vec3< Standard_Size > &theSizeXYZ, const Standard_Size theSizeRowBytes=0)
 Initialize 2D/3D image as wrapper over alien data. Data will not be copied! Notice that caller should ensure that data pointer will not be released during this wrapper lifetime. You may call InitCopy() to perform data copying. More...
 
virtual bool InitTrash3D (Image_Format thePixelFormat, const NCollection_Vec3< Standard_Size > &theSizeXYZ, const Standard_Size theSizeRowBytes=0)
 Initialize 2D/3D image with required dimensions. Memory will be left uninitialized (performance trick). More...
 
bool InitZero3D (Image_Format thePixelFormat, const NCollection_Vec3< Standard_Size > &theSizeXYZ, const Standard_Size theSizeRowBytes=0, const Standard_Byte theValue=0)
 Initialize 2D/3D image with required dimensions. Buffer will be zeroed (black color for most formats). More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Static Public Member Functions

static bool IsBigEndianHost ()
 Determine Big-Endian at runtime. More...
 
static Standard_Size SizePixelBytes (const Image_Format thePixelFormat)
 Return bytes reserved for one pixel (may include extra bytes for alignment). More...
 
static bool SwapRgbaBgra (Image_PixMap &theImage)
 Auxiliary method for swapping bytes between RGB and BGR formats. This method modifies the image data but does not change pixel format! Method will fail if pixel format is not one of the following: More...
 
static void ToBlackWhite (Image_PixMap &theImage)
 Convert image to Black/White. More...
 
static bool FlipY (Image_PixMap &theImage)
 Reverse line order as it draws it from bottom to top. More...
 
static const Handle< NCollection_BaseAllocator > & DefaultAllocator ()
 Return default image data allocator. More...
 
static Standard_CString ImageFormatToString (Image_Format theFormat)
 Return string representation of pixel format. More...
 
static Standard_CString ImageFormatToString (Image_CompressedFormat theFormat)
 Return string representation of compressed pixel format. More...
 
static Quantity_ColorRGBA ColorFromRawPixel (const Standard_Byte *theRawValue, const Image_Format theFormat, const Standard_Boolean theToLinearize=false)
 Convert raw pixel value into Quantity_ColorRGBA. This function is relatively slow. More...
 
static void ColorToRawPixel (Standard_Byte *theRawValue, const Image_Format theFormat, const Quantity_ColorRGBA &theColor, const Standard_Boolean theToDeLinearize=false)
 Set raw pixel value from Quantity_ColorRGBA. This function is relatively slow. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

low-level API for batch-processing (pixels reading / comparison / modification)

Image_PixMapData myData
 data buffer More...
 
Image_Format myImgFormat
 pixel format More...
 
static float ConvertFromHalfFloat (const uint16_t theHalf)
 Convert 16-bit half-float value into 32-bit float (simple conversion). More...
 
static uint16_t ConvertToHalfFloat (const float theFloat)
 Convert 32-bit float value into IEEE-754 16-bit floating-point format without infinity: 1-5-10, exp-15, +-131008.0, +-6.1035156E-5, +-5.9604645E-8, 3.311 digits. More...
 
bool IsTopDown () const
 Returns TRUE if image data is stored from Top to the Down. By default Bottom Up order is used instead (topmost scanlines starts from the bottom in memory). which is most image frameworks naturally support. More...
 
void SetTopDown (const bool theIsTopDown)
 Setup scanlines order in memory - top-down or bottom-up. Drawers should explicitly specify this value if current state IsTopDown() was ignored! More...
 
Standard_Size TopDownInc () const
 Returns +1 if scanlines ordered in Top->Down order in memory and -1 otherwise. More...
 
const Standard_ByteData () const
 Return data pointer for low-level operations (copying entire buffer, parsing with extra tools etc.). More...
 
Standard_ByteChangeData ()
 Return data pointer for low-level operations (copying entire buffer, parsing with extra tools etc.). More...
 
const Standard_ByteRow (Standard_Size theRow) const
 Return data pointer to requested row (first column). Indexation starts from 0. More...
 
Standard_ByteChangeRow (Standard_Size theRow)
 Return data pointer to requested row (first column). Indexation starts from 0. More...
 
const Standard_ByteSlice (Standard_Size theSlice) const
 Return data pointer to requested 2D slice. Indexation starts from 0. More...
 
Standard_ByteChangeSlice (Standard_Size theSlice)
 Return data pointer to requested 2D slice. Indexation starts from 0. More...
 
const Standard_ByteSliceRow (Standard_Size theSlice, Standard_Size theRow) const
 Return data pointer to requested row (first column). Indexation starts from 0. More...
 
Standard_ByteChangeSliceRow (Standard_Size theSlice, Standard_Size theRow)
 Return data pointer to requested row (first column). Indexation starts from 0. More...
 
Standard_Size SizePixelBytes () const
 Return bytes reserved for one pixel (may include extra bytes for alignment). More...
 
Standard_Size SizeRowBytes () const
 Return bytes reserved per row. Could be larger than needed to store packed row (extra bytes for alignment etc.). More...
 
Standard_Size RowExtraBytes () const
 Return the extra bytes in the row. More...
 
Standard_Size MaxRowAligmentBytes () const
 Compute the maximal row alignment for current row size. More...
 
Standard_Size SizeSliceBytes () const
 Return number of bytes per 2D slice. More...
 
Standard_Size SizeBytes () const
 Return buffer size. More...
 
template<typename ColorType_t >
const ColorType_t & Value (Standard_Size theRow, Standard_Size theCol) const
 Access image pixel with specified color type. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in the decreasing majority following memory layout - e.g. row first, column next. More...
 
template<typename ColorType_t >
ColorType_t & ChangeValue (Standard_Size theRow, Standard_Size theCol)
 Access image pixel with specified color type. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in the decreasing majority following memory layout - e.g. row first, column next. More...
 
const Standard_ByteRawValue (Standard_Size theRow, Standard_Size theCol) const
 Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in the decreasing majority following memory layout - e.g. row first, column next. More...
 
Standard_ByteChangeRawValue (Standard_Size theRow, Standard_Size theCol)
 Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in the decreasing majority following memory layout - e.g. row first, column next. More...
 
template<typename ColorType_t >
const ColorType_t & ValueXY (Standard_Size theX, Standard_Size theY) const
 Access image pixel with specified color type. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y order. More...
 
template<typename ColorType_t >
ColorType_t & ChangeValueXY (Standard_Size theX, Standard_Size theY)
 Access image pixel with specified color type. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y order. More...
 
const Standard_ByteRawValueXY (Standard_Size theX, Standard_Size theY) const
 Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y order. More...
 
Standard_ByteChangeRawValueXY (Standard_Size theX, Standard_Size theY)
 Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y order. More...
 
template<typename ColorType_t >
const ColorType_t & ValueXYZ (Standard_Size theX, Standard_Size theY, Standard_Size theZ) const
 Access image pixel with specified color type. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y, Z order. More...
 
template<typename ColorType_t >
ColorType_t & ChangeValueXYZ (Standard_Size theX, Standard_Size theY, Standard_Size theZ)
 Access image pixel with specified color type. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y, Z order. More...
 
const Standard_ByteRawValueXYZ (Standard_Size theX, Standard_Size theY, Standard_Size theZ) const
 Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y, Z order. More...
 
Standard_ByteChangeRawValueXYZ (Standard_Size theX, Standard_Size theY, Standard_Size theZ)
 Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y, Z order. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 

Detailed Description

Class represents packed image plane.

Constructor & Destructor Documentation

◆ Image_PixMap()

Image_PixMap::Image_PixMap ( )

Empty constructor. Initialize the NULL image plane.

◆ ~Image_PixMap()

virtual Image_PixMap::~Image_PixMap ( )
virtual

Destructor.

Member Function Documentation

◆ ChangeData()

Standard_Byte* Image_PixMap::ChangeData ( )
inline

Return data pointer for low-level operations (copying entire buffer, parsing with extra tools etc.).

◆ ChangeRawValue()

Standard_Byte* Image_PixMap::ChangeRawValue ( Standard_Size  theRow,
Standard_Size  theCol 
)
inline

Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in the decreasing majority following memory layout - e.g. row first, column next.

◆ ChangeRawValueXY()

Standard_Byte* Image_PixMap::ChangeRawValueXY ( Standard_Size  theX,
Standard_Size  theY 
)
inline

Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y order.

◆ ChangeRawValueXYZ()

Standard_Byte* Image_PixMap::ChangeRawValueXYZ ( Standard_Size  theX,
Standard_Size  theY,
Standard_Size  theZ 
)
inline

Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y, Z order.

◆ ChangeRow()

Standard_Byte* Image_PixMap::ChangeRow ( Standard_Size  theRow)
inline

Return data pointer to requested row (first column). Indexation starts from 0.

◆ ChangeSlice()

Standard_Byte* Image_PixMap::ChangeSlice ( Standard_Size  theSlice)
inline

Return data pointer to requested 2D slice. Indexation starts from 0.

◆ ChangeSliceRow()

Standard_Byte* Image_PixMap::ChangeSliceRow ( Standard_Size  theSlice,
Standard_Size  theRow 
)
inline

Return data pointer to requested row (first column). Indexation starts from 0.

◆ ChangeValue()

template<typename ColorType_t >
ColorType_t& Image_PixMap::ChangeValue ( Standard_Size  theRow,
Standard_Size  theCol 
)
inline

Access image pixel with specified color type. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in the decreasing majority following memory layout - e.g. row first, column next.

◆ ChangeValueXY()

template<typename ColorType_t >
ColorType_t& Image_PixMap::ChangeValueXY ( Standard_Size  theX,
Standard_Size  theY 
)
inline

Access image pixel with specified color type. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y order.

◆ ChangeValueXYZ()

template<typename ColorType_t >
ColorType_t& Image_PixMap::ChangeValueXYZ ( Standard_Size  theX,
Standard_Size  theY,
Standard_Size  theZ 
)
inline

Access image pixel with specified color type. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y, Z order.

◆ Clear()

virtual void Image_PixMap::Clear ( )
virtual

Method correctly deallocate internal buffer.

Reimplemented in Image_AlienPixMap.

◆ ColorFromRawPixel()

static Quantity_ColorRGBA Image_PixMap::ColorFromRawPixel ( const Standard_Byte theRawValue,
const Image_Format  theFormat,
const Standard_Boolean  theToLinearize = false 
)
static

Convert raw pixel value into Quantity_ColorRGBA. This function is relatively slow.

Parameters
[in]theRawValuepointer to pixel definition
[in]theFormatpixel format
[in]theToLinearizewhen TRUE, the color stored in non-linear color space (e.g. Image_Format_RGB) will be linearized
Returns
the pixel color

◆ ColorToRawPixel()

static void Image_PixMap::ColorToRawPixel ( Standard_Byte theRawValue,
const Image_Format  theFormat,
const Quantity_ColorRGBA theColor,
const Standard_Boolean  theToDeLinearize = false 
)
static

Set raw pixel value from Quantity_ColorRGBA. This function is relatively slow.

Parameters
[out]theRawValuepointer to pixel definition to modify
[in]theFormatpixel format
[in]theColorcolor value to convert from
[in]theToDeLinearizewhen TRUE, the gamma correction will be applied for storing in non-linear color space (e.g. Image_Format_RGB)

◆ ConvertFromHalfFloat()

static float Image_PixMap::ConvertFromHalfFloat ( const uint16_t  theHalf)
inlinestatic

Convert 16-bit half-float value into 32-bit float (simple conversion).

◆ ConvertToHalfFloat()

static uint16_t Image_PixMap::ConvertToHalfFloat ( const float  theFloat)
inlinestatic

Convert 32-bit float value into IEEE-754 16-bit floating-point format without infinity: 1-5-10, exp-15, +-131008.0, +-6.1035156E-5, +-5.9604645E-8, 3.311 digits.

◆ Data()

const Standard_Byte* Image_PixMap::Data ( ) const
inline

Return data pointer for low-level operations (copying entire buffer, parsing with extra tools etc.).

◆ DefaultAllocator()

static const Handle< NCollection_BaseAllocator >& Image_PixMap::DefaultAllocator ( )
static

Return default image data allocator.

◆ Depth()

Standard_Size Image_PixMap::Depth ( ) const
inline

Return image depth in pixels.

◆ FlipY()

static bool Image_PixMap::FlipY ( Image_PixMap theImage)
static

Reverse line order as it draws it from bottom to top.

◆ Format()

Image_Format Image_PixMap::Format ( ) const
inline

Return pixel format.

◆ Height()

Standard_Size Image_PixMap::Height ( ) const
inline

Return image height in pixels.

◆ ImageFormatToString() [1/2]

static Standard_CString Image_PixMap::ImageFormatToString ( Image_CompressedFormat  theFormat)
static

Return string representation of compressed pixel format.

◆ ImageFormatToString() [2/2]

static Standard_CString Image_PixMap::ImageFormatToString ( Image_Format  theFormat)
static

Return string representation of pixel format.

◆ InitCopy()

virtual bool Image_PixMap::InitCopy ( const Image_PixMap theCopy)
virtual

Initialize by copying data. If you want to copy alien data you should create wrapper using InitWrapper() before.

Reimplemented in Image_AlienPixMap.

◆ InitTrash()

virtual bool Image_PixMap::InitTrash ( Image_Format  thePixelFormat,
const Standard_Size  theSizeX,
const Standard_Size  theSizeY,
const Standard_Size  theSizeRowBytes = 0 
)
virtual

Initialize image plane with required dimensions. Memory will be left uninitialized (performance trick).

Reimplemented in Image_AlienPixMap.

◆ InitTrash3D()

virtual bool Image_PixMap::InitTrash3D ( Image_Format  thePixelFormat,
const NCollection_Vec3< Standard_Size > &  theSizeXYZ,
const Standard_Size  theSizeRowBytes = 0 
)
virtual

Initialize 2D/3D image with required dimensions. Memory will be left uninitialized (performance trick).

◆ InitWrapper()

virtual bool Image_PixMap::InitWrapper ( Image_Format  thePixelFormat,
Standard_Byte theDataPtr,
const Standard_Size  theSizeX,
const Standard_Size  theSizeY,
const Standard_Size  theSizeRowBytes = 0 
)
virtual

Initialize image plane as wrapper over alien data. Data will not be copied! Notice that caller should ensure that data pointer will not be released during this wrapper lifetime. You may call InitCopy() to perform data copying.

◆ InitWrapper3D()

virtual bool Image_PixMap::InitWrapper3D ( Image_Format  thePixelFormat,
Standard_Byte theDataPtr,
const NCollection_Vec3< Standard_Size > &  theSizeXYZ,
const Standard_Size  theSizeRowBytes = 0 
)
virtual

Initialize 2D/3D image as wrapper over alien data. Data will not be copied! Notice that caller should ensure that data pointer will not be released during this wrapper lifetime. You may call InitCopy() to perform data copying.

◆ InitZero()

bool Image_PixMap::InitZero ( Image_Format  thePixelFormat,
const Standard_Size  theSizeX,
const Standard_Size  theSizeY,
const Standard_Size  theSizeRowBytes = 0,
const Standard_Byte  theValue = 0 
)
inline

Initialize image plane with required dimensions. Buffer will be zeroed (black color for most formats).

◆ InitZero3D()

bool Image_PixMap::InitZero3D ( Image_Format  thePixelFormat,
const NCollection_Vec3< Standard_Size > &  theSizeXYZ,
const Standard_Size  theSizeRowBytes = 0,
const Standard_Byte  theValue = 0 
)

Initialize 2D/3D image with required dimensions. Buffer will be zeroed (black color for most formats).

◆ IsBigEndianHost()

static bool Image_PixMap::IsBigEndianHost ( )
inlinestatic

Determine Big-Endian at runtime.

◆ IsEmpty()

bool Image_PixMap::IsEmpty ( ) const
inline

Return true if data is NULL.

◆ IsTopDown()

bool Image_PixMap::IsTopDown ( ) const
inline

Returns TRUE if image data is stored from Top to the Down. By default Bottom Up order is used instead (topmost scanlines starts from the bottom in memory). which is most image frameworks naturally support.

Notice that access methods within this class automatically convert input row-index to apply this flag! You should use this flag only if interconnect with alien APIs and buffers.

Returns
true if image data is top-down

◆ MaxRowAligmentBytes()

Standard_Size Image_PixMap::MaxRowAligmentBytes ( ) const
inline

Compute the maximal row alignment for current row size.

Returns
maximal row alignment in bytes (up to 16 bytes).

◆ PixelColor()

Quantity_ColorRGBA Image_PixMap::PixelColor ( Standard_Integer  theX,
Standard_Integer  theY,
Standard_Boolean  theToLinearize = false 
) const
inline

Returns the pixel color. This function is relatively slow. Beware that this method takes coordinates in opposite order in contrast to ::Value() and ::ChangeValue().

Parameters
[in]theXcolumn index from left, starting from 0
[in]theYrow index from top, starting from 0
[in]theToLinearizewhen TRUE, the color stored in non-linear color space (e.g. Image_Format_RGB) will be linearized
Returns
the pixel color

◆ Ratio()

Standard_Real Image_PixMap::Ratio ( ) const
inline

Return width / height.

◆ RawValue()

const Standard_Byte* Image_PixMap::RawValue ( Standard_Size  theRow,
Standard_Size  theCol 
) const
inline

Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in the decreasing majority following memory layout - e.g. row first, column next.

◆ RawValueXY()

const Standard_Byte* Image_PixMap::RawValueXY ( Standard_Size  theX,
Standard_Size  theY 
) const
inline

Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y order.

◆ RawValueXYZ()

const Standard_Byte* Image_PixMap::RawValueXYZ ( Standard_Size  theX,
Standard_Size  theY,
Standard_Size  theZ 
) const
inline

Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y, Z order.

◆ Row()

const Standard_Byte* Image_PixMap::Row ( Standard_Size  theRow) const
inline

Return data pointer to requested row (first column). Indexation starts from 0.

◆ RowExtraBytes()

Standard_Size Image_PixMap::RowExtraBytes ( ) const
inline

Return the extra bytes in the row.

◆ SetFormat()

void Image_PixMap::SetFormat ( const Image_Format  thePixelFormat)

Override pixel format specified by InitXXX() methods. Will throw exception if pixel size of new format is not equal to currently initialized format. Intended to switch formats indicating different interpretation of the same data (e.g. ImgGray and ImgAlpha).

◆ SetPixelColor() [1/2]

void Image_PixMap::SetPixelColor ( const Standard_Integer  theX,
const Standard_Integer  theY,
const Quantity_Color theColor,
const Standard_Boolean  theToDeLinearize = false 
)
inline

Sets the pixel color. This function is relatively slow. Beware that this method takes coordinates in opposite order in contrast to ::Value() and ::ChangeValue().

Parameters
[in]theXcolumn index from left
[in]theYrow index from top
[in]theColorcolor to store
[in]theToDeLinearizewhen TRUE, the gamma correction will be applied for storing in non-linear color space (e.g. Image_Format_RGB)

◆ SetPixelColor() [2/2]

void Image_PixMap::SetPixelColor ( const Standard_Integer  theX,
const Standard_Integer  theY,
const Quantity_ColorRGBA theColor,
const Standard_Boolean  theToDeLinearize = false 
)
inline

Sets the pixel color. This function is relatively slow. Beware that this method takes coordinates in opposite order in contrast to ::Value() and ::ChangeValue().

Parameters
[in]theXcolumn index from left
[in]theYrow index from top
[in]theColorcolor to store
[in]theToDeLinearizewhen TRUE, the gamma correction will be applied for storing in non-linear color space (e.g. Image_Format_RGB)

◆ SetTopDown()

void Image_PixMap::SetTopDown ( const bool  theIsTopDown)
inline

Setup scanlines order in memory - top-down or bottom-up. Drawers should explicitly specify this value if current state IsTopDown() was ignored!

Parameters
theIsTopDowntop-down flag

◆ SizeBytes()

Standard_Size Image_PixMap::SizeBytes ( ) const
inline

Return buffer size.

◆ SizePixelBytes() [1/2]

Standard_Size Image_PixMap::SizePixelBytes ( ) const
inline

Return bytes reserved for one pixel (may include extra bytes for alignment).

◆ SizePixelBytes() [2/2]

static Standard_Size Image_PixMap::SizePixelBytes ( const Image_Format  thePixelFormat)
static

Return bytes reserved for one pixel (may include extra bytes for alignment).

◆ SizeRowBytes()

Standard_Size Image_PixMap::SizeRowBytes ( ) const
inline

Return bytes reserved per row. Could be larger than needed to store packed row (extra bytes for alignment etc.).

◆ SizeSliceBytes()

Standard_Size Image_PixMap::SizeSliceBytes ( ) const
inline

Return number of bytes per 2D slice.

◆ SizeX()

Standard_Size Image_PixMap::SizeX ( ) const
inline

Return image width in pixels.

◆ SizeXYZ()

NCollection_Vec3<Standard_Size> Image_PixMap::SizeXYZ ( ) const
inline

Return image width x height x depth in pixels.

◆ SizeY()

Standard_Size Image_PixMap::SizeY ( ) const
inline

Return image height in pixels.

◆ SizeZ()

Standard_Size Image_PixMap::SizeZ ( ) const
inline

Return image depth in pixels.

◆ Slice()

const Standard_Byte* Image_PixMap::Slice ( Standard_Size  theSlice) const
inline

Return data pointer to requested 2D slice. Indexation starts from 0.

◆ SliceRow()

const Standard_Byte* Image_PixMap::SliceRow ( Standard_Size  theSlice,
Standard_Size  theRow 
) const
inline

Return data pointer to requested row (first column). Indexation starts from 0.

◆ SwapRgbaBgra()

static bool Image_PixMap::SwapRgbaBgra ( Image_PixMap theImage)
static

Auxiliary method for swapping bytes between RGB and BGR formats. This method modifies the image data but does not change pixel format! Method will fail if pixel format is not one of the following:

  • Image_Format_RGB32 / Image_Format_BGR32
  • Image_Format_RGBA / Image_Format_BGRA
  • Image_Format_RGB / Image_Format_BGR
  • Image_Format_RGBF / Image_Format_BGRF
  • Image_Format_RGBAF / Image_Format_BGRAF

◆ ToBlackWhite()

static void Image_PixMap::ToBlackWhite ( Image_PixMap theImage)
static

Convert image to Black/White.

◆ TopDownInc()

Standard_Size Image_PixMap::TopDownInc ( ) const
inline

Returns +1 if scanlines ordered in Top->Down order in memory and -1 otherwise.

Returns
scanline increment for Top->Down iteration

◆ Value()

template<typename ColorType_t >
const ColorType_t& Image_PixMap::Value ( Standard_Size  theRow,
Standard_Size  theCol 
) const
inline

Access image pixel with specified color type. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in the decreasing majority following memory layout - e.g. row first, column next.

◆ ValueXY()

template<typename ColorType_t >
const ColorType_t& Image_PixMap::ValueXY ( Standard_Size  theX,
Standard_Size  theY 
) const
inline

Access image pixel with specified color type. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y order.

◆ ValueXYZ()

template<typename ColorType_t >
const ColorType_t& Image_PixMap::ValueXYZ ( Standard_Size  theX,
Standard_Size  theY,
Standard_Size  theZ 
) const
inline

Access image pixel with specified color type. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y, Z order.

◆ Width()

Standard_Size Image_PixMap::Width ( ) const
inline

Return image width in pixels.

Field Documentation

◆ myData

Image_PixMapData Image_PixMap::myData
protected

data buffer

◆ myImgFormat

Image_Format Image_PixMap::myImgFormat
protected

pixel format


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