You.i Engine
CYID3D11FramebufferObject Class Reference

Detailed Description

IYIGPUObject implementation for OpenGL Framebuffers.

#include <renderer/YiD3D11FramebufferObject.h>

Inheritance diagram for CYID3D11FramebufferObject:

Public Member Functions

 CYID3D11FramebufferObject (bool screenBuffer=false)
 
virtual ~CYID3D11FramebufferObject ()
 
virtual void Load (const std::shared_ptr< CYIAssetHardware > &pAsset) override
 
virtual void Unload () override
 
virtual void Use () const override
 
bool HasDepth () const
 
bool HasColor () const
 
- Public Member Functions inherited from CYID3D11AbstractBufferObject
 CYID3D11AbstractBufferObject (int32_t handle)
 
virtual ~CYID3D11AbstractBufferObject ()
 
virtual uint32_t GetHandle ()
 
- Public Member Functions inherited from CYIBufferObject
 CYIBufferObject ()
 
virtual ~CYIBufferObject ()
 
virtual void * Map ()
 
virtual void Unmap (size_t size)
 
- Public Member Functions inherited from IYIGPUObject
 IYIGPUObject ()
 
virtual ~IYIGPUObject ()
 
Status GetStatus () const
 

Protected Member Functions

virtual void Generate () override
 
virtual void Free () override
 
virtual void InvalidateHandle () override
 

Protected Attributes

bool m_hasColor
 
bool m_hasDepth
 
bool m_screenBuffer
 
bool m_platformSupportsDepthTextures
 
bool m_platformSupportsPackedDepthStencil
 
ID3D11RenderTargetView * m_pRenderTargetView
 
ID3D11DepthStencilView * m_pDepthStencilView
 
- Protected Attributes inherited from CYID3D11AbstractBufferObject
uint32_t m_handle
 
- Protected Attributes inherited from IYIGPUObject
Status m_status
 

Additional Inherited Members

- Public Types inherited from IYIGPUObject
enum  Status {
  Status::Invalid,
  Status::Unloaded,
  Status::LoadedFresh,
  Status::LoadedStale
}
 

Constructor & Destructor Documentation

◆ CYID3D11FramebufferObject()

CYID3D11FramebufferObject::CYID3D11FramebufferObject ( bool  screenBuffer = false)

Upon creation, a framebuffer will generate a valid handle in graphics memory

screenBuffer is a boolean flag indicating whether the framebuffer represents the screen.

◆ ~CYID3D11FramebufferObject()

virtual CYID3D11FramebufferObject::~CYID3D11FramebufferObject ( )
virtual

Upon deletion, a framebuffer will free all of its memory and invalidate its handle.

Warning
The textures contained inside the FBO are managed separately, only the FBO will be destroyed

Member Function Documentation

◆ Free()

virtual void CYID3D11FramebufferObject::Free ( )
overrideprotectedvirtual

Deallocates the GPU memory associated with this object.

Implements IYIGPUObject.

◆ Generate()

virtual void CYID3D11FramebufferObject::Generate ( )
overrideprotectedvirtual

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

Implements IYIGPUObject.

◆ HasColor()

bool CYID3D11FramebufferObject::HasColor ( ) const

◆ HasDepth()

bool CYID3D11FramebufferObject::HasDepth ( ) const

◆ InvalidateHandle()

virtual void CYID3D11FramebufferObject::InvalidateHandle ( )
overrideprotectedvirtual

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 CYID3D11FramebufferObject::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.

◆ Unload()

virtual void CYID3D11FramebufferObject::Unload ( )
overridevirtual

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

Implements IYIGPUObject.

◆ Use()

virtual void CYID3D11FramebufferObject::Use ( ) const
overridevirtual

Makes the GPU Object active, called by the renderer

Implements IYIGPUObject.

Member Data Documentation

◆ m_hasColor

bool CYID3D11FramebufferObject::m_hasColor
protected

◆ m_hasDepth

bool CYID3D11FramebufferObject::m_hasDepth
protected

◆ m_pDepthStencilView

ID3D11DepthStencilView* CYID3D11FramebufferObject::m_pDepthStencilView
protected

◆ m_platformSupportsDepthTextures

bool CYID3D11FramebufferObject::m_platformSupportsDepthTextures
protected

◆ m_platformSupportsPackedDepthStencil

bool CYID3D11FramebufferObject::m_platformSupportsPackedDepthStencil
protected

◆ m_pRenderTargetView

ID3D11RenderTargetView* CYID3D11FramebufferObject::m_pRenderTargetView
protected

◆ m_screenBuffer

bool CYID3D11FramebufferObject::m_screenBuffer
protected

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