Image_SupportedFormats Class Reference

Structure holding information about supported texture formats. More...

#include <Image_SupportedFormats.hxx>

Inheritance diagram for Image_SupportedFormats:

Public Member Functions
	Image_SupportedFormats ()
	Empty constructor.
bool	IsSupported (Image_Format theFormat) const
	Return TRUE if image format is supported.
void	Add (Image_Format theFormat)
	Set if image format is supported or not.
bool	HasCompressed () const
	Return TRUE if there are compressed image formats supported.
bool	IsSupported (Image_CompressedFormat theFormat) const
	Return TRUE if compressed image format is supported.
void	Add (Image_CompressedFormat theFormat)
	Set if compressed image format is supported or not.
void	Clear ()
	Reset flags.
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 ()
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.
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.
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.
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.
Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.
Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.
virtual void	Delete () const
	Memory deallocator for transient classes.

Protected Attributes
NCollection_Array1< bool >	myFormats
	list of supported formats
Standard_Boolean	myHasCompressed
	flag indicating that some compressed image formats are supported

Additional Inherited Members
typedef void	base_type
	Returns a type descriptor about this object.
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

Structure holding information about supported texture formats.

Constructor & Destructor Documentation

Image_SupportedFormats()

Image_SupportedFormats::Image_SupportedFormats

(

)

Empty constructor.

Member Function Documentation

Add() [1/2]

void Image_SupportedFormats::Add ( Image_CompressedFormat theFormat )

inline

Set if compressed image format is supported or not.

Add() [2/2]

void Image_SupportedFormats::Add ( Image_Format theFormat )

inline

Set if image format is supported or not.

Clear()

void Image_SupportedFormats::Clear ( )

inline

Reset flags.

HasCompressed()

bool Image_SupportedFormats::HasCompressed ( ) const

inline

Return TRUE if there are compressed image formats supported.

IsSupported() [1/2]

bool Image_SupportedFormats::IsSupported ( Image_CompressedFormat theFormat ) const

inline

Return TRUE if compressed image format is supported.

IsSupported() [2/2]

bool Image_SupportedFormats::IsSupported ( Image_Format theFormat ) const

inline

Return TRUE if image format is supported.

Field Documentation

myFormats

NCollection_Array1<bool> Image_SupportedFormats::myFormats

protected

list of supported formats

myHasCompressed

Standard_Boolean Image_SupportedFormats::myHasCompressed

protected

flag indicating that some compressed image formats are supported

---

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

• Image_SupportedFormats.hxx