LiteFX::Rendering::StateResource Class Reference

Base class for a resource that can be identified by a name string within a DeviceState. More...

#include <rendering_api.hpp>

Inherits LiteFX::Rendering::IStateResource.

Inherited by LiteFX::Rendering::FrameBuffer< IDirectX12Image > [virtual], LiteFX::Rendering::FrameBuffer< IVulkanImage > [virtual], LiteFX::Rendering::Pipeline< DirectX12PipelineLayout, DirectX12ShaderProgram > [virtual], LiteFX::Rendering::Pipeline< VulkanPipelineLayout, VulkanShaderProgram > [virtual], LiteFX::Rendering::RenderPass< DirectX12Queue, DirectX12FrameBuffer > [virtual], LiteFX::Rendering::RenderPass< VulkanQueue, VulkanFrameBuffer > [virtual], LiteFX::Rendering::Backends::DirectX12BottomLevelAccelerationStructure [virtual], LiteFX::Rendering::Backends::DirectX12Buffer [virtual], LiteFX::Rendering::Backends::DirectX12Image [virtual], LiteFX::Rendering::Backends::DirectX12Sampler [virtual], LiteFX::Rendering::Backends::DirectX12TopLevelAccelerationStructure [virtual], LiteFX::Rendering::Backends::VulkanBottomLevelAccelerationStructure [virtual], LiteFX::Rendering::Backends::VulkanBuffer [virtual], LiteFX::Rendering::Backends::VulkanImage [virtual], LiteFX::Rendering::Backends::VulkanSampler [virtual], LiteFX::Rendering::Backends::VulkanTopLevelAccelerationStructure [virtual], LiteFX::Rendering::FrameBuffer< TImage > [virtual], LiteFX::Rendering::Pipeline< TPipelineLayout, TShaderProgram > [virtual], and LiteFX::Rendering::RenderPass< TCommandQueue, TFrameBuffer > [virtual].

Classes
class	StateResourceImpl

Public Member Functions
	~StateResource () noexcept override
	Releases the state resource instance.
const String &	name () const noexcept override
	Returns the name of the resource. Returns The name of the resource.
Public Member Functions inherited from LiteFX::Rendering::IStateResource
virtual	~IStateResource () noexcept=default
	Releases the state resource instance.

Protected Member Functions
	StateResource ()
	Initializes a new state resource instance with a default name.
	StateResource (StringView name)
	Initializes a new state resource instance.
	StateResource (StateResource &&) noexcept
StateResource &	operator= (StateResource &&) noexcept
	StateResource (const StateResource &)=delete
StateResource &	operator= (const StateResource &)=delete
String &	name () noexcept
Protected Member Functions inherited from LiteFX::Rendering::IStateResource
	IStateResource () noexcept=default
	IStateResource (const IStateResource &)=delete
	IStateResource (IStateResource &&) noexcept=default
IStateResource &	operator= (const IStateResource &)=delete
IStateResource &	operator= (IStateResource &&) noexcept=default

Detailed Description

Base class for a resource that can be identified by a name string within a DeviceState.

Constructor & Destructor Documentation

StateResource() [1/4]

StateResource::StateResource ( )

protected

Initializes a new state resource instance with a default name.

StateResource() [2/4]

StateResource::StateResource ( StringView name )

explicitprotected

Initializes a new state resource instance.

Parameters

name	The name of the resource.

StateResource() [3/4]

StateResource::StateResource ( StateResource && )

protecteddefaultnoexcept

StateResource() [4/4]

LiteFX::Rendering::StateResource::StateResource ( const StateResource & )

protecteddelete

~StateResource()

StateResource::~StateResource ( )

overridedefaultnoexcept

Releases the state resource instance.

Member Function Documentation

name() [1/2]

const String & StateResource::name ( ) const

overridevirtualnoexcept

Returns the name of the resource.

Returns

The name of the resource.

Implements LiteFX::Rendering::IStateResource.

name() [2/2]

String & StateResource::name ( )

protectednoexcept

operator=() [1/2]

StateResource & LiteFX::Rendering::StateResource::operator= ( const StateResource & )

protecteddelete

operator=() [2/2]

StateResource & StateResource::operator= ( StateResource && )

protecteddefaultnoexcept