CeresEngine 0.2.0
A game development framework
Loading...
Searching...
No Matches
CeresEngine::GPUShader Class Reference

#include <CeresEngine/RenderAPI/GPUShader.hpp>

Inheritance diagram for CeresEngine::GPUShader:
CeresEngine::TDeviceObject< GPUShaderDescriptor > CeresEngine::GPUDeviceObject CeresEngine::GPUObject CeresEngine::GLShader CeresEngine::MKShader CeresEngine::MTShader CeresEngine::NLShader CeresEngine::VKShader CeresEngine::WGShader

Public Member Functions

 GPUShader (GPUDevice &device, const Descriptor &descriptor, const GPUShaderReflectionDescriptor &reflection)
 Initializes a new Shader object instance.
 
 GPUShader (const GPUShader &)=delete
 Deleted copy constructor.
 
GPUShaderoperator= (const GPUShader &)=delete
 
 GPUShader (GPUShader &&)=delete
 Deleted move constructor.
 
GPUShaderoperator= (GPUShader &&)=delete
 
const GPUShaderReflectionDescriptorreflect () const
 Extracts reflection information from the shader.
 
- Public Member Functions inherited from CeresEngine::TDeviceObject< GPUShaderDescriptor >
 TDeviceObject (GPUDevice &device, const Descriptor &descriptor)
 Initializes a new RenderAPI device object instance.
 
 TDeviceObject (const TDeviceObject &)=delete
 
 TDeviceObject (TDeviceObject &&)=delete
 
 ~TDeviceObject () override=default
 
TDeviceObjectoperator= (const TDeviceObject &)=delete
 
TDeviceObjectoperator= (TDeviceObject &&)=delete
 
- Public Member Functions inherited from CeresEngine::GPUDeviceObject
 GPUDeviceObject (GPUDevice &device)
 
 ~GPUDeviceObject () override
 
- Public Member Functions inherited from CeresEngine::GPUObject
 GPUObject ()=default
 
virtual ~GPUObject ()=default
 
 GPUObject (const GPUObject &)=delete
 
GPUObjectoperator= (const GPUObject &)=delete
 
 GPUObject (GPUObject &&)=delete
 
GPUObjectoperator= (GPUObject &&)=delete
 
void retain () noexcept
 Retains the object by increment it's reference count by one.
 
bool release () noexcept
 Releases the object by decrementing it's reference count by one.
 

Public Attributes

const GPUShaderReflectionDescriptorreflection
 The shader reflection descriptor.
 
- Public Attributes inherited from CeresEngine::TDeviceObject< GPUShaderDescriptor >
const Descriptordescriptor
 A structure that describes the object and it's properties.
 
- Public Attributes inherited from CeresEngine::GPUDeviceObject
GPUDevicedevice
 The owning device this object was created from.
 

Additional Inherited Members

- Public Types inherited from CeresEngine::TDeviceObject< GPUShaderDescriptor >
using Descriptor = GPUShaderDescriptor
 An type-alias to the descriptor struct type.
 
- Protected Member Functions inherited from CeresEngine::GPUObject
virtual void destroy () noexcept
 A internal method called by the system when the object reference count reaches zero.
 

Constructor & Destructor Documentation

◆ GPUShader() [1/3]

CeresEngine::GPUShader::GPUShader ( GPUDevice device,
const Descriptor descriptor,
const GPUShaderReflectionDescriptor reflection 
)
inlineexplicit

Initializes a new Shader object instance.

◆ GPUShader() [2/3]

CeresEngine::GPUShader::GPUShader ( const GPUShader )
delete

Deleted copy constructor.

◆ GPUShader() [3/3]

CeresEngine::GPUShader::GPUShader ( GPUShader &&  )
delete

Deleted move constructor.

Member Function Documentation

◆ operator=() [1/2]

GPUShader & CeresEngine::GPUShader::operator= ( const GPUShader )
delete

◆ operator=() [2/2]

GPUShader & CeresEngine::GPUShader::operator= ( GPUShader &&  )
delete

◆ reflect()

const GPUShaderReflectionDescriptor & CeresEngine::GPUShader::reflect ( ) const
inline

Extracts reflection information from the shader.

Returns
The reflected shader descriptor.

Member Data Documentation

◆ reflection

const GPUShaderReflectionDescriptor& CeresEngine::GPUShader::reflection

The shader reflection descriptor.

Can be used to enumerate shader input, output, parameters and other introspectable data.


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