Base interface for all dynamic objects in the engine. More...

#include <Object.h>

Inheritance diagram for Diligent.IObject:

Public Member Functions
virtual void DILIGENT_CALL_TYPE	QueryInterface (const INTERFACE_ID &IID, IObject **ppInterface)=0
	Queries the specific interface.

template<typename DerivedType, typename = typename std::enable_if<std::is_base_of<IObject, DerivedType>::value>::type>
void	QueryInterface (const INTERFACE_ID &IID, DerivedType **ppInterface)

virtual ReferenceCounterValueType DILIGENT_CALL_TYPE	AddRef ()=0
	Increments the number of strong references by 1.

virtual ReferenceCounterValueType DILIGENT_CALL_TYPE	Release ()=0

virtual IReferenceCounters *DILIGENT_CALL_TYPE	GetReferenceCounters () const =0

Detailed Description

Base interface for all dynamic objects in the engine.

Member Function Documentation

◆ AddRef()

virtual ReferenceCounterValueType DILIGENT_CALL_TYPE Diligent.IObject.AddRef ( )

pure virtual

Increments the number of strong references by 1.

Remarks: This method is equivalent to GetReferenceCounters()->AddStrongRef().
The method is thread-safe and does not require explicit synchronization.

Returns: The number of strong references after incrementing the counter.

Note: In a multithreaded environment, the returned number may not be reliable as other threads may simultaneously change the actual value of the counter.

◆ GetReferenceCounters()

virtual IReferenceCounters *DILIGENT_CALL_TYPE Diligent.IObject.GetReferenceCounters ( ) const

pure virtual

Returns the pointer to IReferenceCounters interface of the associated reference counters object. The method does NOT increment the number of strong references to the returned object.

◆ QueryInterface() [1/2]

template<typename DerivedType, typename = typename std::enable_if<std::is_base_of<IObject, DerivedType>::value>::type>

void Diligent.IObject.QueryInterface	(	const INTERFACE_ID &	IID,
		DerivedType **	ppInterface )

inline

Template version of QueryInterface that avoids the need to manually cast the returned interface pointer.

◆ QueryInterface() [2/2]

virtual void DILIGENT_CALL_TYPE Diligent.IObject.QueryInterface	(	const INTERFACE_ID &	IID,
		IObject **	ppInterface )

pure virtual

Queries the specific interface.

Parameters

[in]	IID	- Unique identifier of the requested interface.
[out]	ppInterface	- Memory address where the pointer to the requested interface will be written. If the interface is not supported, null pointer will be returned.

Remarks: The method increments the number of strong references by 1. The interface must be released by a call to Release() method when it is no longer needed.

◆ Release()

virtual ReferenceCounterValueType DILIGENT_CALL_TYPE Diligent.IObject.Release ( )

pure virtual

Decrements the number of strong references by 1 and destroys the object when the counter reaches zero.

Remarks: This method is equivalent to GetReferenceCounters()->ReleaseStrongRef().
The method is thread-safe and does not require explicit synchronization.

Returns: The number of strong references after decrementing the counter.

Note: In a multithreaded environment, the returned number may not be reliable as other threads may simultaneously change the actual value of the counter. The only reliable value is 0 as the object is destroyed when the last strong reference is released.

Public Member Functions

Detailed Description

Member Function Documentation

◆ AddRef()

◆ GetReferenceCounters()

◆ QueryInterface() [1/2]

◆ QueryInterface() [2/2]

◆ Release()