CeresEngine::GLSampler Class Reference

#include <CeresEngine/RenderAPI/OpenGL/GLSampler.hpp>

Inheritance diagram for CeresEngine::GLSampler:

Public Member Functions
	GLSampler (GLDevicePtr device, const GPUSamplerDescriptor &descriptor)
	~GLSampler () override
GLuint	handle () const
Public Member Functions inherited from CeresEngine::GPUSampler
	GPUSampler (const GPUSampler &)=delete
	Deleted copy constructor.
GPUSampler &	operator= (const GPUSampler &)=delete
	GPUSampler (GPUSampler &&)=delete
	Deleted move constructor.
GPUSampler &	operator= (GPUSampler &&)=delete
	TDeviceObject (GPUDevice &device, const Descriptor &descriptor)
	Inherited constructors.
	TDeviceObject (const TDeviceObject &)=delete
	Inherited constructors.
	TDeviceObject (TDeviceObject &&)=delete
	Inherited constructors.
Public Member Functions inherited from CeresEngine::TDeviceObject< GPUSamplerDescriptor >
	TDeviceObject (GPUDevice &device, const Descriptor &descriptor)
	Initializes a new RenderAPI device object instance.
	TDeviceObject (const TDeviceObject &)=delete
	TDeviceObject (TDeviceObject &&)=delete
	~TDeviceObject () override=default
TDeviceObject &	operator= (const TDeviceObject &)=delete
TDeviceObject &	operator= (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
GPUObject &	operator= (const GPUObject &)=delete
	GPUObject (GPUObject &&)=delete
GPUObject &	operator= (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.

Private Attributes
const GPUSamplerDescriptor	descriptorGL
	A structure that describes the sampler and it's properties.
GLObjectHandle<&glad_glGenSamplers, &glad_glDeleteSamplers >	samplerID {}
	The OpenGL sampler object.

Additional Inherited Members
Public Types inherited from CeresEngine::TDeviceObject< GPUSamplerDescriptor >
using	Descriptor = GPUSamplerDescriptor
	An type-alias to the descriptor struct type.
Static Public Member Functions inherited from CeresEngine::GLObject< ChildTypeName, ParentType >
static RC< ChildTypeName >	cast (const RC< ParentType > &ptr)
	Casts a RC containing a ParentType pointer to a pointer to a pointer to a ChildTypeName.
static RC< ChildTypeName >	safeCast (const RC< ParentType > &ptr)
	Safely casts a RC containing a ParentType pointer to a pointer to a pointer to a ChildTypeName.
static ChildTypeName &	cast (ParentType &object)
	Casts a object of type ParentType to a object of type ChildTypeName.
static const ChildTypeName &	cast (const ParentType &object)
	Casts a object of type ParentType to a object of type ChildTypeName.
static ChildTypeName *	cast (ParentType *object)
	Casts a object of type ParentType to a object of type ChildTypeName.
static const ChildTypeName *	cast (const ParentType *object)
	Casts a object of type ParentType to a object of type ChildTypeName.
static ChildTypeName *	safeCast (ParentType *object)
	Casts a object of type ParentType to a object of type ChildTypeName.
static const ChildTypeName *	safeCast (const ParentType *object)
	Casts a object of type ParentType to a object of type ChildTypeName.
Public Attributes inherited from CeresEngine::TDeviceObject< GPUSamplerDescriptor >
const Descriptor &	descriptor
	A structure that describes the object and it's properties.
Public Attributes inherited from CeresEngine::GPUDeviceObject
GPUDevice &	device
	The owning device this object was created from.
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.
Protected Member Functions inherited from CeresEngine::GLDeviceObject< GLSampler, GPUSampler >
	GLDeviceObject (GLDevicePtr device)
	Creates a new GLDeviceObject from the given device.
Protected Attributes inherited from CeresEngine::GLDeviceObject< GLSampler, GPUSampler >
GLDevice &	deviceGL
	The owning GLDevice instance.

Constructor & Destructor Documentation

GLSampler()

CeresEngine::GLSampler::GLSampler	(	GLDevicePtr	device,
		const GPUSamplerDescriptor &	descriptor
	)

~GLSampler()

CeresEngine::GLSampler::~GLSampler ( )

override

Member Function Documentation

handle()

GLuint CeresEngine::GLSampler::handle ( ) const

inline

Returns

The OpenGL object handle

Member Data Documentation

descriptorGL

const GPUSamplerDescriptor CeresEngine::GLSampler::descriptorGL

private

A structure that describes the sampler and it's properties.

samplerID

GLObjectHandle<& glad_glGenSamplers , & glad_glDeleteSamplers > CeresEngine::GLSampler::samplerID {}

private

The OpenGL sampler object.

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/RenderAPI/OpenGL/GLSampler.hpp