Open CASCADE Technology  7.4.1.dev
Public Member Functions | Protected Attributes
Image_CompressedPixMap Class Reference

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:
Inheritance graph
[legend]

Public Member Functions

Image_Format BaseFormat () const
 Return base (uncompressed) pixel format. More...
 
void SetBaseFormat (Image_Format theFormat)
 Set base (uncompressed) pixel format. More...
 
Image_CompressedFormat CompressedFormat () const
 Return compressed format. More...
 
void SetCompressedFormat (Image_CompressedFormat theFormat)
 Set compressed format. More...
 
const Handle< NCollection_Buffer > & FaceData () const
 Return raw (compressed) data. More...
 
void SetFaceData (const Handle< NCollection_Buffer > &theBuffer)
 Set raw (compressed) data. More...
 
const NCollection_Array1< Standard_Integer > & MipMaps () const
 Return Array of mipmap sizes, including base level. More...
 
NCollection_Array1< Standard_Integer > & ChangeMipMaps ()
 Return Array of mipmap sizes, including base level. More...
 
Standard_Boolean IsCompleteMipMapSet () const
 Return TRUE if complete mip map level set (up to 1x1 resolution). More...
 
void SetCompleteMipMapSet (Standard_Boolean theIsComplete)
 Set if complete mip map level set (up to 1x1 resolution). More...
 
Standard_Size FaceBytes () const
 Return surface length in bytes. More...
 
void SetFaceBytes (Standard_Size theSize)
 Set surface length in bytes. More...
 
Standard_Integer SizeX () const
 Return surface width. More...
 
Standard_Integer SizeY () const
 Return surface height. More...
 
void SetSize (Standard_Integer theSizeX, Standard_Integer theSizeY)
 Set surface width x height. More...
 
bool IsTopDown () const
 Return TRUE if image layout is top-down (always true). More...
 
Standard_Integer NbFaces () const
 Return number of faces in the file; should be 6 for cubemap. More...
 
void SetNbFaces (Standard_Integer theSize)
 Set number of faces in the file. More...
 
 Image_CompressedPixMap ()
 Empty constructor. 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...
 

Protected Attributes

NCollection_Array1< Standard_IntegermyMipMaps
 Array of mipmap sizes, including base level. More...
 
Handle< NCollection_BuffermyFaceData
 raw compressed data More...
 
Standard_Size myFaceBytes
 surface length in bytes More...
 
Standard_Integer myNbFaces
 number of faces in the file More...
 
Standard_Integer mySizeX
 surface width More...
 
Standard_Integer mySizeY
 surface height More...
 
Image_Format myBaseFormat
 base (uncompressed) pixel format More...
 
Image_CompressedFormat myFormat
 compressed format More...
 
Standard_Boolean myIsCompleteMips
 flag indicating complete mip map level set (up to 1x1 resolution) More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. 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...
 

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<Standard_Integer>& Image_CompressedPixMap::ChangeMipMaps ( )
inline

Return Array of mipmap sizes, including base level.

◆ CompressedFormat()

Image_CompressedFormat Image_CompressedPixMap::CompressedFormat ( ) const
inline

Return compressed format.

◆ FaceBytes()

Standard_Size Image_CompressedPixMap::FaceBytes ( ) const
inline

Return surface length in bytes.

◆ FaceData()

const Handle< NCollection_Buffer >& Image_CompressedPixMap::FaceData ( ) const
inline

Return raw (compressed) data.

◆ IsCompleteMipMapSet()

Standard_Boolean 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<Standard_Integer>& Image_CompressedPixMap::MipMaps ( ) const
inline

Return Array of mipmap sizes, including base level.

◆ NbFaces()

Standard_Integer 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 ( Standard_Boolean  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 ( Standard_Size  theSize)
inline

Set surface length in bytes.

◆ SetFaceData()

void Image_CompressedPixMap::SetFaceData ( const Handle< NCollection_Buffer > &  theBuffer)
inline

Set raw (compressed) data.

◆ SetNbFaces()

void Image_CompressedPixMap::SetNbFaces ( Standard_Integer  theSize)
inline

Set number of faces in the file.

◆ SetSize()

void Image_CompressedPixMap::SetSize ( Standard_Integer  theSizeX,
Standard_Integer  theSizeY 
)
inline

Set surface width x height.

◆ SizeX()

Standard_Integer Image_CompressedPixMap::SizeX ( ) const
inline

Return surface width.

◆ SizeY()

Standard_Integer Image_CompressedPixMap::SizeY ( ) const
inline

Return surface height.

Field Documentation

◆ myBaseFormat

Image_Format Image_CompressedPixMap::myBaseFormat
protected

base (uncompressed) pixel format

◆ myFaceBytes

Standard_Size Image_CompressedPixMap::myFaceBytes
protected

surface length in bytes

◆ myFaceData

Handle< NCollection_Buffer > Image_CompressedPixMap::myFaceData
protected

raw compressed data

◆ myFormat

Image_CompressedFormat Image_CompressedPixMap::myFormat
protected

compressed format

◆ myIsCompleteMips

Standard_Boolean Image_CompressedPixMap::myIsCompleteMips
protected

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

◆ myMipMaps

NCollection_Array1<Standard_Integer> Image_CompressedPixMap::myMipMaps
protected

Array of mipmap sizes, including base level.

◆ myNbFaces

Standard_Integer Image_CompressedPixMap::myNbFaces
protected

number of faces in the file

◆ mySizeX

Standard_Integer Image_CompressedPixMap::mySizeX
protected

surface width

◆ mySizeY

Standard_Integer Image_CompressedPixMap::mySizeY
protected

surface height


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