CYIGLTextureObject Class Reference

Detailed Description

IYIGPUObject implementation for OpenGL textures.

This class is able to encapsulate any OpenGL texture types that can be generated via glGenTextures(), such as GL_TEXTURE_2D

#include <renderer/YiGLTextureObject.h>

Inheritance diagram for CYIGLTextureObject:

Public Member Functions
	CYIGLTextureObject ()
virtual	~CYIGLTextureObject ()
virtual void	Load (const std::shared_ptr< CYIAssetHardware > &pAsset) override
virtual void	Unload () override
virtual void	Use () const override
virtual void	Generate () override
virtual void	Free () override
virtual void	InvalidateHandle () override
void	Configure (GLint level, GLint internalFormat, GLsizei width, GLsizei height, GLint border, GLenum format, GLenum type)
Public Member Functions inherited from CYIGLAbstractBufferObject
	CYIGLAbstractBufferObject (GLuint handle)
virtual	~CYIGLAbstractBufferObject ()
virtual void	SetTarget (GLenum target)
virtual GLenum	GetTarget ()
virtual GLuint	GetHandle ()
Public Member Functions inherited from CYIBufferObject
	CYIBufferObject ()
virtual	~CYIBufferObject ()
virtual void *	Map ()
virtual void	Unmap (uint32_t uSize)
Public Member Functions inherited from IYIGPUObject
	IYIGPUObject ()
virtual	~IYIGPUObject ()
YI_GPU_OBJECT_STATUS	GetStatus () const

Protected Attributes
GLint	m_level
GLint	m_internalFormat
GLsizei	m_width
GLsizei	m_height
GLint	m_border
GLenum	m_format
GLenum	m_type
bool	m_bNeedsFullReload
Protected Attributes inherited from CYIGLAbstractBufferObject
GLuint	m_handle
GLenum	m_target
Protected Attributes inherited from IYIGPUObject
YI_GPU_OBJECT_STATUS	m_status

Friends
class	CYIGLFramebufferObject

Additional Inherited Members
Public Types inherited from IYIGPUObject
enum	YI_GPU_OBJECT_STATUS {   INVALID,   UNLOADED,   LOADED_FRESH,   LOADED_STALE }

Constructor & Destructor Documentation

CYIGLTextureObject::CYIGLTextureObject

(

)

Upon creation, a texture object will generate a valid handle in graphics memory

virtual CYIGLTextureObject::~CYIGLTextureObject ( )

virtual

Upon deletion, a texture object will free all of its memory and invalidate its handle

Member Function Documentation

void CYIGLTextureObject::Configure	(	GLint	level,
		GLint	internalFormat,
		GLsizei	width,
		GLsizei	height,
		GLint	border,
		GLenum	format,
		GLenum	type
	)

Parameters are identical to those used for glTexImage2D(). See OpenGL documentation for your platform for details.

The data in pixels as interpreted to be in the format colorspace will be written to the appropriate mipmap level in order to create a width by height texture in the internalFormat colorspace. If the GL version on the target platform supports borders, a border pixels width border will be applied to the image.

virtual void CYIGLTextureObject::Free ( )

overridevirtual

Deallocates the GPU memory associated with this object.

Implements IYIGPUObject.

virtual void CYIGLTextureObject::Generate ( )

overridevirtual

Generates a valid handle. No GPU memory is allocated until Load() is called.

Implements IYIGPUObject.

virtual void CYIGLTextureObject::InvalidateHandle ( )

overridevirtual

This function can be called to invalidate the buffer handle without freeing the associated memory.

This can be used if the GL context is lost and GPU memory is freed implicitly. Calling Free() on this object will result in a crash if the handle is no longer pointing to valid memory, and a new handle may not be created with Generate() if the current handle is valid. This function allows you to inform the buffer object that the GL data has been freed externally and that the handle should be disconnected.

Warning

Calling this function without being sure that the handle has been freed in GPU memory will result in a memory leak. Use at your own risk.

Implements IYIGPUObject.

virtual void CYIGLTextureObject::Load ( const std::shared_ptr< CYIAssetHardware > &  pHWAsset )

overridevirtual

Loads the software data from the associated CYIAsset into graphics memory. If the YI_GPU_OBJECT_STATUS is LOADED_FRESH upon a call to load, meaning that data was previously successfully loaded, the status may become LOADED_STALE in the case where this load failed. See the YI_GPU_OBJECT_STATUS documentation for more details.

Implements IYIGPUObject.

virtual void CYIGLTextureObject::Unload ( )

overridevirtual

Frees any previously loaded data from video memory, but retains the handle.

Implements IYIGPUObject.

virtual void CYIGLTextureObject::Use ( ) const

overridevirtual

Makes the GPU Object active, called by the renderer

Implements IYIGPUObject.

Friends And Related Function Documentation

friend class CYIGLFramebufferObject

friend

Member Data Documentation

bool CYIGLTextureObject::m_bNeedsFullReload

protected

GLint CYIGLTextureObject::m_border

protected

GLenum CYIGLTextureObject::m_format

protected

GLsizei CYIGLTextureObject::m_height

protected

GLint CYIGLTextureObject::m_internalFormat

protected

GLint CYIGLTextureObject::m_level

protected

GLenum CYIGLTextureObject::m_type

protected

GLsizei CYIGLTextureObject::m_width

protected

---

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

• renderer/YiGLTextureObject.h