Graphic3d_TextureParams Class Reference

This class describes texture parameters. More...

#include <Graphic3d_TextureParams.hxx>

Inheritance diagram for Graphic3d_TextureParams:

Public Member Functions
	Graphic3d_TextureParams ()
	Default constructor.
	~Graphic3d_TextureParams () override
	Destructor.
Graphic3d_TextureUnit	TextureUnit () const
	Default texture unit to be used, default is Graphic3d_TextureUnit_BaseColor.
void	SetTextureUnit (Graphic3d_TextureUnit theUnit)
	Setup default texture unit.
bool	IsModulate () const
void	SetModulate (const bool theToModulate)
bool	IsRepeat () const
void	SetRepeat (const bool theToRepeat)
Graphic3d_TypeOfTextureFilter	Filter () const
void	SetFilter (const Graphic3d_TypeOfTextureFilter theFilter)
Graphic3d_LevelOfTextureAnisotropy	AnisoFilter () const
void	SetAnisoFilter (const Graphic3d_LevelOfTextureAnisotropy theLevel)
float	Rotation () const
	Return rotation angle in degrees; 0 by default. Complete transformation matrix: Rotation -> Translation -> Scale.
void	SetRotation (const float theAngleDegrees)
const NCollection_Vec2< float > &	Scale () const
	Return scale factor; (1.0; 1.0) by default, which means no scaling. Complete transformation matrix: Rotation -> Translation -> Scale.
void	SetScale (const NCollection_Vec2< float > theScale)
const NCollection_Vec2< float > &	Translation () const
	Return translation vector; (0.0; 0.0), which means no translation. Complete transformation matrix: Rotation -> Translation -> Scale.
void	SetTranslation (const NCollection_Vec2< float > theVec)
Graphic3d_TypeOfTextureMode	GenMode () const
const NCollection_Vec4< float > &	GenPlaneS () const
const NCollection_Vec4< float > &	GenPlaneT () const
void	SetGenMode (const Graphic3d_TypeOfTextureMode theMode, const NCollection_Vec4< float > thePlaneS, const NCollection_Vec4< float > thePlaneT)
	Setup texture coordinates generation mode.
int	BaseLevel () const
int	MaxLevel () const
	Return maximum texture mipmap array level; 1000 by default. Real rendering limit will take into account mipmap generation flags and presence of mipmaps in loaded image.
void	SetLevelsRange (int theFirstLevel, int theSecondLevel=0)
	Setups texture mipmap array levels range. The lowest value will be the base level. The remaining one will be the maximum level.
unsigned int	SamplerRevision () const
	Return modification counter of parameters related to sampler state.
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.

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

This class describes texture parameters.

Constructor & Destructor Documentation

Graphic3d_TextureParams()

Graphic3d_TextureParams::Graphic3d_TextureParams

(

)

Default constructor.

~Graphic3d_TextureParams()

Graphic3d_TextureParams::~Graphic3d_TextureParams ( )

override

Destructor.

Member Function Documentation

AnisoFilter()

Graphic3d_LevelOfTextureAnisotropy Graphic3d_TextureParams::AnisoFilter ( ) const

inline

Returns

level of anisontropy texture filter. Default value is Graphic3d_LOTA_OFF.

BaseLevel()

int Graphic3d_TextureParams::BaseLevel ( ) const

inline

Returns

base texture mipmap level; 0 by default.

Filter()

Graphic3d_TypeOfTextureFilter Graphic3d_TextureParams::Filter ( ) const

inline

Returns

texture interpolation filter. Default value is Graphic3d_TOTF_NEAREST.

GenMode()

Graphic3d_TypeOfTextureMode Graphic3d_TextureParams::GenMode ( ) const

inline

Returns

texture coordinates generation mode. Default value is Graphic3d_TOTM_MANUAL.

GenPlaneS()

const NCollection_Vec4< float > & Graphic3d_TextureParams::GenPlaneS ( ) const

inline

Returns

texture coordinates generation plane S.

GenPlaneT()

const NCollection_Vec4< float > & Graphic3d_TextureParams::GenPlaneT ( ) const

inline

Returns

texture coordinates generation plane T.

IsModulate()

bool Graphic3d_TextureParams::IsModulate ( ) const

inline

Returns

TRUE if the texture is modulate. Default value is FALSE.

IsRepeat()

bool Graphic3d_TextureParams::IsRepeat ( ) const

inline

Returns

TRUE if the texture repeat is enabled. Default value is FALSE.

MaxLevel()

int Graphic3d_TextureParams::MaxLevel ( ) const

inline

Return maximum texture mipmap array level; 1000 by default. Real rendering limit will take into account mipmap generation flags and presence of mipmaps in loaded image.

Rotation()

float Graphic3d_TextureParams::Rotation ( ) const

inline

Return rotation angle in degrees; 0 by default. Complete transformation matrix: Rotation -> Translation -> Scale.

SamplerRevision()

unsigned int Graphic3d_TextureParams::SamplerRevision ( ) const

inline

Return modification counter of parameters related to sampler state.

Scale()

const NCollection_Vec2< float > & Graphic3d_TextureParams::Scale ( ) const

inline

Return scale factor; (1.0; 1.0) by default, which means no scaling. Complete transformation matrix: Rotation -> Translation -> Scale.

SetAnisoFilter()

void Graphic3d_TextureParams::SetAnisoFilter

(

const Graphic3d_LevelOfTextureAnisotropy

theLevel

)

Parameters

theLevel

level of anisontropy texture filter.

SetFilter()

void Graphic3d_TextureParams::SetFilter

(

const Graphic3d_TypeOfTextureFilter

theFilter

)

Parameters

theFilter

texture interpolation filter.

SetGenMode()

void Graphic3d_TextureParams::SetGenMode	(	const Graphic3d_TypeOfTextureMode	theMode,
		const NCollection_Vec4< float >	thePlaneS,
		const NCollection_Vec4< float >	thePlaneT )

Setup texture coordinates generation mode.

SetLevelsRange()

void Graphic3d_TextureParams::SetLevelsRange ( int theFirstLevel, int theSecondLevel = 0 )

inline

Setups texture mipmap array levels range. The lowest value will be the base level. The remaining one will be the maximum level.

SetModulate()

void Graphic3d_TextureParams::SetModulate

(

const bool

theToModulate

)

Parameters

theToModulate

turn modulation on/off.

SetRepeat()

void Graphic3d_TextureParams::SetRepeat

(

const bool

theToRepeat

)

Parameters

theToRepeat

turn texture repeat mode ON or OFF (clamping).

SetRotation()

void Graphic3d_TextureParams::SetRotation

(

const float

theAngleDegrees

)

Parameters

theAngleDegrees

rotation angle.

SetScale()

void Graphic3d_TextureParams::SetScale

(

const NCollection_Vec2< float >

theScale

)

Parameters

theScale

scale factor.

SetTextureUnit()

void Graphic3d_TextureParams::SetTextureUnit ( Graphic3d_TextureUnit theUnit )

inline

Setup default texture unit.

SetTranslation()

void Graphic3d_TextureParams::SetTranslation

(

const NCollection_Vec2< float >

theVec

)

Parameters

theVec

translation vector.

TextureUnit()

Graphic3d_TextureUnit Graphic3d_TextureParams::TextureUnit ( ) const

inline

Default texture unit to be used, default is Graphic3d_TextureUnit_BaseColor.

Translation()

const NCollection_Vec2< float > & Graphic3d_TextureParams::Translation ( ) const

inline

Return translation vector; (0.0; 0.0), which means no translation. Complete transformation matrix: Rotation -> Translation -> Scale.

---

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

• Graphic3d_TextureParams.hxx