LLGL::RenderSystemChild Class Reference

Base class for all interfaces whose instances are owned by the RenderSystem. More...

#include <RenderSystemChild.h>

Inheritance diagram for LLGL::RenderSystemChild:

Public Member Functions
virtual void	SetDebugName (const char *name)
	Sets the name of this class instance for debugging purposes.
Public Member Functions inherited from LLGL::Interface
virtual bool	IsInstanceOf (int id) const
	Returns true if this object is an instance of the specified interface.
Public Member Functions inherited from LLGL::NonCopyable
	NonCopyable (const NonCopyable &)=delete
NonCopyable &	operator= (const NonCopyable &)=delete
virtual	~NonCopyable ()=default

Additional Inherited Members
Protected Member Functions inherited from LLGL::NonCopyable
	NonCopyable ()=default

Detailed Description

Base class for all interfaces whose instances are owned by the RenderSystem.

Member Function Documentation

SetDebugName()

virtual void LLGL::RenderSystemChild::SetDebugName ( const char * name )

virtual

Sets the name of this class instance for debugging purposes.

Parameters

[in]

name

Pointer to a NUL-terminated string that specifies the new name of this instance. Specifying a null pointer effectively removes the name from the object. The implementation of this function may alter the actual name depending on how many internal objects need to be labeled.

Remarks

This is used for debugging purposes only and the implementation is undefined, i.e. if the respective render system does not support debug labels this function call will be ignored silently.

This function is especially useful in conjunction with diagnostic tools (such as RenderDoc) to better identify objects in the event history.

The default implementation has no effect.

See also

CommandBuffer::PushDebugGroup

CommandBuffer::PopDebugGroup

BufferDescriptor::debugName

CommandBufferDescriptor::debugName

ComputePipelineDescriptor::debugName

GraphicsPipelineDescriptor::debugName

PipelineLayoutDescriptor::debugName

RenderPassDescriptor::debugName

RenderTargetDescriptor::debugName

ResourceHeapDescriptor::debugName

SamplerDescriptor::debugName

ShaderDescriptor::debugName

SwapChainDescriptor::debugName

TextureDescriptor::debugName

---

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

• RenderSystemChild.h