You.i Engine
CYIGNMTextureObject Class Reference

Detailed Description

IYIGPUObject implementation for GNM textures on PS4.

#include <renderer/YiGNMTextureObject.h>

Inheritance diagram for CYIGNMTextureObject:

Public Member Functions

 CYIGNMTextureObject ()
 
virtual ~CYIGNMTextureObject ()
 
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 (int32_t width, int32_t height, IYIMaterialFactory::ColorSpace format, IYIMaterialFactory::TextureType type, CYIGNMFramebufferObject *pFrameBufferObject=nullptr)
 
void LoadEmpty ()
 
void Bind (uint32_t slot=0) const
 
void ReconfigureWrapMode (CYIAssetTextureBase::WrapMode wrapS, CYIAssetTextureBase::WrapMode wrapT)
 
sce::Gnm::Texture * GetGnmTexture ()
 
- Public Member Functions inherited from CYIGNMAbstractBufferObject
 CYIGNMAbstractBufferObject (int32_t handle)
 
virtual ~CYIGNMAbstractBufferObject ()
 
virtual void SetTarget (uint32_t target)
 
uint32_t GetTarget () const
 
virtual uint32_t GetHandle ()
 
- Public Member Functions inherited from IYIGPUObject
 IYIGPUObject ()
 
virtual ~IYIGPUObject ()
 
Status GetStatus () const
 

Additional Inherited Members

- Public Types inherited from IYIGPUObject
enum  Status {
  Status::Invalid,
  Status::Unloaded,
  Status::LoadedFresh,
  Status::LoadedStale
}
 
- Protected Attributes inherited from CYIGNMAbstractBufferObject
uint32_t m_handle
 
uint32_t m_target
 
- Protected Attributes inherited from IYIGPUObject
Status m_status
 

Constructor & Destructor Documentation

◆ CYIGNMTextureObject()

CYIGNMTextureObject::CYIGNMTextureObject ( )

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

◆ ~CYIGNMTextureObject()

virtual CYIGNMTextureObject::~CYIGNMTextureObject ( )
virtual

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

Member Function Documentation

◆ Bind()

void CYIGNMTextureObject::Bind ( uint32_t  slot = 0) const

◆ Configure()

void CYIGNMTextureObject::Configure ( int32_t  width,
int32_t  height,
IYIMaterialFactory::ColorSpace  format,
IYIMaterialFactory::TextureType  type,
CYIGNMFramebufferObject pFrameBufferObject = nullptr 
)

Parameters used are identical to those used for OpenGL's glTexImage2D(). Direct3D equivalents are implemented.

◆ Free()

virtual void CYIGNMTextureObject::Free ( )
overridevirtual

Deallocates the GPU memory associated with this object.

Implements IYIGPUObject.

◆ Generate()

virtual void CYIGNMTextureObject::Generate ( )
overridevirtual

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

Implements IYIGPUObject.

◆ GetGnmTexture()

sce::Gnm::Texture* CYIGNMTextureObject::GetGnmTexture ( )

◆ InvalidateHandle()

virtual void CYIGNMTextureObject::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.

◆ Load()

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

Loads the software data from the associated CYIAsset into graphics memory. If the 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 Status documentation for more details.

Implements IYIGPUObject.

◆ LoadEmpty()

void CYIGNMTextureObject::LoadEmpty ( )

◆ ReconfigureWrapMode()

void CYIGNMTextureObject::ReconfigureWrapMode ( CYIAssetTextureBase::WrapMode  wrapS,
CYIAssetTextureBase::WrapMode  wrapT 
)

Reconfigures the current texture's wrap modes.

Warning
The change takes effect after the texture has been bound. If the texture is already bound, it must be rebound for the new mode to take effect.

◆ Unload()

virtual void CYIGNMTextureObject::Unload ( )
overridevirtual

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

Implements IYIGPUObject.

◆ Use()

virtual void CYIGNMTextureObject::Use ( ) const
overridevirtual

Makes the GPU Object active, called by the renderer

Implements IYIGPUObject.


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