This class contains shadow mapping resources. More...

#include <OpenGl_ShadowMap.hxx>

Inheritance diagram for OpenGl_ShadowMap:

[legend]

Public Member Functions
	OpenGl_ShadowMap ()
	Empty constructor.

void	Release (OpenGl_Context *theCtx) override
	Releases all OpenGL resources.

size_t	EstimatedDataSize () const override
	Returns estimated GPU memory usage for holding data without considering overheads and allocation alignment rules.

	~OpenGl_ShadowMap () override
	Destructor.

bool	IsValid () const
	Return TRUE if defined.

const occ::handle< OpenGl_FrameBuffer > &	FrameBuffer () const
	Return framebuffer.

const occ::handle< OpenGl_Texture > &	Texture () const
	Return depth texture.

const occ::handle< Graphic3d_CLight > &	LightSource () const
	Return light source casting the shadow or NULL if undefined.

void	SetLightSource (const occ::handle< Graphic3d_CLight > &theLight)
	Set light source casting the shadow.

const occ::handle< Graphic3d_Camera > &	Camera () const
	Return rendering camera.

const NCollection_Mat4< float > &	LightSourceMatrix () const
	Return light source mapping matrix.

void	SetLightSourceMatrix (const NCollection_Mat4< float > &theMat)
	Set light source mapping matrix.

float	ShadowMapBias () const
	Returns shadowmap bias.

void	SetShadowMapBias (float theBias)
	Sets shadowmap bias.

bool	UpdateCamera (const Graphic3d_CView &theView, const gp_XYZ *theOrigin=nullptr)
	Compute camera.

Public Member Functions inherited from OpenGl_NamedResource
	OpenGl_NamedResource (const TCollection_AsciiString &theId)
	Empty constructor.

const TCollection_AsciiString &	ResourceId () const
	Return resource name.

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

	~OpenGl_Resource () override
	Destructor. Inheritors should call Clean (NULL) within it.

virtual void	DumpJson (Standard_OStream &theOStream, int theDepth=-1) const
	Dumps the content of me into the stream.

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

Protected Attributes inherited from OpenGl_NamedResource
TCollection_AsciiString	myResourceId
	resource name

Detailed Description

This class contains shadow mapping resources.

Constructor & Destructor Documentation

◆ OpenGl_ShadowMap()

OpenGl_ShadowMap::OpenGl_ShadowMap ( )

Empty constructor.

◆ ~OpenGl_ShadowMap()

OpenGl_ShadowMap::~OpenGl_ShadowMap ( )

override

Destructor.

Member Function Documentation

◆ Camera()

const occ::handle< Graphic3d_Camera > & OpenGl_ShadowMap::Camera ( ) const

inline

Return rendering camera.

◆ EstimatedDataSize()

size_t OpenGl_ShadowMap::EstimatedDataSize ( ) const

overridevirtual

Returns estimated GPU memory usage for holding data without considering overheads and allocation alignment rules.

Implements OpenGl_Resource.

◆ FrameBuffer()

const occ::handle< OpenGl_FrameBuffer > & OpenGl_ShadowMap::FrameBuffer ( ) const

inline

Return framebuffer.

◆ IsValid()

bool OpenGl_ShadowMap::IsValid ( ) const

Return TRUE if defined.

◆ LightSource()

const occ::handle< Graphic3d_CLight > & OpenGl_ShadowMap::LightSource ( ) const

inline

Return light source casting the shadow or NULL if undefined.

◆ LightSourceMatrix()

const NCollection_Mat4< float > & OpenGl_ShadowMap::LightSourceMatrix ( ) const

inline

Return light source mapping matrix.

◆ Release()

void OpenGl_ShadowMap::Release ( OpenGl_Context * theCtx )

overridevirtual

Releases all OpenGL resources.

Implements OpenGl_Resource.

◆ SetLightSource()

void OpenGl_ShadowMap::SetLightSource ( const occ::handle< Graphic3d_CLight > & theLight )

inline

Set light source casting the shadow.

◆ SetLightSourceMatrix()

void OpenGl_ShadowMap::SetLightSourceMatrix ( const NCollection_Mat4< float > & theMat )

inline

Set light source mapping matrix.

◆ SetShadowMapBias()

void OpenGl_ShadowMap::SetShadowMapBias ( float theBias )

inline

Sets shadowmap bias.

◆ ShadowMapBias()

float OpenGl_ShadowMap::ShadowMapBias ( ) const

inline

Returns shadowmap bias.

◆ Texture()

const occ::handle< OpenGl_Texture > & OpenGl_ShadowMap::Texture ( ) const

Return depth texture.

◆ UpdateCamera()

bool OpenGl_ShadowMap::UpdateCamera	(	const Graphic3d_CView &	theView,
		const gp_XYZ *	theOrigin = nullptr )

Compute camera.

Parameters

[in]	theView	active view
[in]	theOrigin	when not-NULL - displace shadow map camera to specified Z-Layer origin

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

OpenGl_ShadowMap.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OpenGl_ShadowMap()

◆ ~OpenGl_ShadowMap()

Member Function Documentation

◆ Camera()

◆ EstimatedDataSize()

◆ FrameBuffer()

◆ IsValid()

◆ LightSource()

◆ LightSourceMatrix()

◆ Release()

◆ SetLightSource()

◆ SetLightSourceMatrix()

◆ SetShadowMapBias()

◆ ShadowMapBias()

◆ Texture()

◆ UpdateCamera()