Compressed pixmap data definition. It is defined independently from Image_PixMap, which defines only uncompressed formats. More...

#include <Image_CompressedPixMap.hxx>

Inheritance diagram for Image_CompressedPixMap:

[legend]

Public Member Functions
Image_Format	BaseFormat () const
	Return base (uncompressed) pixel format.

void	SetBaseFormat (Image_Format theFormat)
	Set base (uncompressed) pixel format.

Image_CompressedFormat	CompressedFormat () const
	Return compressed format.

void	SetCompressedFormat (Image_CompressedFormat theFormat)
	Set compressed format.

const occ::handle< NCollection_Buffer > &	FaceData () const
	Return raw (compressed) data.

void	SetFaceData (const occ::handle< NCollection_Buffer > &theBuffer)
	Set raw (compressed) data.

const NCollection_Array1< int > &	MipMaps () const
	Return Array of mipmap sizes, including base level.

NCollection_Array1< int > &	ChangeMipMaps ()
	Return Array of mipmap sizes, including base level.

bool	IsCompleteMipMapSet () const
	Return TRUE if complete mip map level set (up to 1x1 resolution).

void	SetCompleteMipMapSet (bool theIsComplete)
	Set if complete mip map level set (up to 1x1 resolution).

size_t	FaceBytes () const
	Return surface length in bytes.

void	SetFaceBytes (size_t theSize)
	Set surface length in bytes.

int	SizeX () const
	Return surface width.

int	SizeY () const
	Return surface height.

void	SetSize (int theSizeX, int theSizeY)
	Set surface width x height.

bool	IsTopDown () const
	Return TRUE if image layout is top-down (always true).

int	NbFaces () const
	Return number of faces in the file; should be 6 for cubemap.

void	SetNbFaces (int theSize)
	Set number of faces in the file.

	Image_CompressedPixMap ()
	Empty constructor.

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()=default
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.

bool	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.

bool	IsKind (const char *const 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.

Standard_Transient *	This () 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.

int	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.

int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.

virtual void	Delete () const
	Memory deallocator for transient classes.

Protected Attributes
NCollection_Array1< int >	myMipMaps
	Array of mipmap sizes, including base level.

occ::handle< NCollection_Buffer >	myFaceData
	raw compressed data

size_t	myFaceBytes
	surface length in bytes

int	myNbFaces
	number of faces in the file

int	mySizeX
	surface width

int	mySizeY
	surface height

Image_Format	myBaseFormat
	base (uncompressed) pixel format

Image_CompressedFormat	myFormat
	compressed format

bool	myIsCompleteMips
	flag indicating complete mip map level set (up to 1x1 resolution)

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Detailed Description

Compressed pixmap data definition. It is defined independently from Image_PixMap, which defines only uncompressed formats.

Constructor & Destructor Documentation

◆ Image_CompressedPixMap()

Image_CompressedPixMap::Image_CompressedPixMap ( )

inline

Empty constructor.

Member Function Documentation

◆ BaseFormat()

Image_Format Image_CompressedPixMap::BaseFormat ( ) const

inline

Return base (uncompressed) pixel format.

◆ ChangeMipMaps()

NCollection_Array1< int > & Image_CompressedPixMap::ChangeMipMaps ( )

inline

Return Array of mipmap sizes, including base level.

◆ CompressedFormat()

Image_CompressedFormat Image_CompressedPixMap::CompressedFormat ( ) const

inline

Return compressed format.

◆ FaceBytes()

size_t Image_CompressedPixMap::FaceBytes ( ) const

inline

Return surface length in bytes.

◆ FaceData()

const occ::handle< NCollection_Buffer > & Image_CompressedPixMap::FaceData ( ) const

inline

Return raw (compressed) data.

◆ IsCompleteMipMapSet()

bool Image_CompressedPixMap::IsCompleteMipMapSet ( ) const

inline

Return TRUE if complete mip map level set (up to 1x1 resolution).

◆ IsTopDown()

bool Image_CompressedPixMap::IsTopDown ( ) const

inline

Return TRUE if image layout is top-down (always true).

◆ MipMaps()

const NCollection_Array1< int > & Image_CompressedPixMap::MipMaps ( ) const

inline

Return Array of mipmap sizes, including base level.

◆ NbFaces()

int Image_CompressedPixMap::NbFaces ( ) const

inline

Return number of faces in the file; should be 6 for cubemap.

◆ SetBaseFormat()

void Image_CompressedPixMap::SetBaseFormat ( Image_Format theFormat )

inline

Set base (uncompressed) pixel format.

◆ SetCompleteMipMapSet()

void Image_CompressedPixMap::SetCompleteMipMapSet ( bool theIsComplete )

inline

Set if complete mip map level set (up to 1x1 resolution).

◆ SetCompressedFormat()

void Image_CompressedPixMap::SetCompressedFormat ( Image_CompressedFormat theFormat )

inline

Set compressed format.

◆ SetFaceBytes()

void Image_CompressedPixMap::SetFaceBytes ( size_t theSize )

inline

Set surface length in bytes.

◆ SetFaceData()

void Image_CompressedPixMap::SetFaceData ( const occ::handle< NCollection_Buffer > & theBuffer )

inline

Set raw (compressed) data.

◆ SetNbFaces()

void Image_CompressedPixMap::SetNbFaces ( int theSize )

inline

Set number of faces in the file.

◆ SetSize()

void Image_CompressedPixMap::SetSize	(	int	theSizeX,
		int	theSizeY )

inline

Set surface width x height.

◆ SizeX()

int Image_CompressedPixMap::SizeX ( ) const

inline

Return surface width.

◆ SizeY()

int Image_CompressedPixMap::SizeY ( ) const

inline

Return surface height.

Field Documentation

◆ myBaseFormat

Image_Format Image_CompressedPixMap::myBaseFormat

protected

base (uncompressed) pixel format

◆ myFaceBytes

size_t Image_CompressedPixMap::myFaceBytes

protected

surface length in bytes

◆ myFaceData

occ::handle<NCollection_Buffer> Image_CompressedPixMap::myFaceData

protected

raw compressed data

◆ myFormat

Image_CompressedFormat Image_CompressedPixMap::myFormat

protected

compressed format

◆ myIsCompleteMips

bool Image_CompressedPixMap::myIsCompleteMips

protected

flag indicating complete mip map level set (up to 1x1 resolution)

◆ myMipMaps

NCollection_Array1<int> Image_CompressedPixMap::myMipMaps

protected

Array of mipmap sizes, including base level.

◆ myNbFaces

int Image_CompressedPixMap::myNbFaces

protected

number of faces in the file

◆ mySizeX

int Image_CompressedPixMap::mySizeX

protected

surface width

◆ mySizeY

int Image_CompressedPixMap::mySizeY

protected

surface height

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

Image_CompressedPixMap.hxx

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Image_CompressedPixMap()

Member Function Documentation

◆ BaseFormat()

◆ ChangeMipMaps()

◆ CompressedFormat()

◆ FaceBytes()

◆ FaceData()

◆ IsCompleteMipMapSet()

◆ IsTopDown()

◆ MipMaps()

◆ NbFaces()

◆ SetBaseFormat()

◆ SetCompleteMipMapSet()

◆ SetCompressedFormat()

◆ SetFaceBytes()

◆ SetFaceData()

◆ SetNbFaces()

◆ SetSize()

◆ SizeX()

◆ SizeY()

Field Documentation

◆ myBaseFormat

◆ myFaceBytes

◆ myFaceData

◆ myFormat

◆ myIsCompleteMips

◆ myMipMaps

◆ myNbFaces

◆ mySizeX

◆ mySizeY