xiiGPUResourcePool Class Reference

This class serves as a pool for GPU related resources (e.g. buffers and textures required for rendering). Note that the functions creating and returning render targets are thread safe (by using a mutex). More...

#include <GPUResourcePool.h>

Classes
struct	BufferHandleWithAge
struct	TextureHandleWithAge

Public Member Functions
xiiSharedPtr< xiiGALTexture >	GetRenderTarget (const xiiGALTextureCreationDescription &textureDesc)
	Returns a render target handle for the given texture description Note that you should return the handle to the pool and never destroy it directly with the device.
xiiSharedPtr< xiiGALTexture >	GetRenderTarget (xiiUInt32 uiWidth, xiiUInt32 uiHeight, xiiEnum< xiiGALResourceFormat > format, xiiEnum< xiiGALMSAASampleCount > sampleCount=xiiGALMSAASampleCount::OneSample, xiiUInt32 uiSliceColunt=1, bool bIsArray=false)
	Convenience functions which creates a texture description fit for a 2d render target without a mip chains.
void	ReturnRenderTarget (xiiSharedPtr< xiiGALTexture > hRenderTarget)
	Returns a render target to the pool so other consumers can use it. Note that targets which are returned to the pool are susceptible to destruction due to garbage collection.
xiiSharedPtr< xiiGALBuffer >	GetBuffer (const xiiGALBufferCreationDescription &bufferDesc)
	Returns a buffer handle for the given buffer description.
void	ReturnBuffer (xiiSharedPtr< xiiGALBuffer > hBuffer)
	Returns a buffer to the pool so other consumers can use it.
void	RunGC (xiiUInt32 uiMinimumAge)
	Tries to free resources which are currently in the pool. Triggered automatically due to allocation number / size thresholds but can be triggered manually (e.g. after editor window resize)

Static Public Member Functions
static xiiGPUResourcePool *	GetDefaultInstance ()
static void	SetDefaultInstance (xiiGPUResourcePool *pDefaultInstance)

Protected Member Functions
void	CheckAndPotentiallyRunGC ()
void	UpdateMemoryStats () const
void	GALDeviceEventHandler (const xiiGALDeviceEvent &e)

Protected Attributes
xiiEventSubscriptionID	m_GALDeviceEventSubscriptionID
xiiUInt64	m_uiMemoryThresholdForGC = 256 * 1024 * 1024
xiiUInt64	m_uiCurrentlyAllocatedMemory = 0
xiiUInt16	m_uiNumAllocationsThresholdForGC = 128
xiiUInt16	m_uiNumAllocationsSinceLastGC = 0
xiiUInt16	m_uiFramesThresholdSinceLastGC = 60
	Every 60 frames resources unused for more than 10 frames in a row are GCed.
xiiUInt16	m_uiFramesSinceLastGC = 0
xiiMap< xiiUInt32, xiiDynamicArray< TextureHandleWithAge > >	m_AvailableTextures
xiiSet< xiiSharedPtr< xiiGALTexture > >	m_TexturesInUse
xiiMap< xiiUInt32, xiiDynamicArray< BufferHandleWithAge > >	m_AvailableBuffers
xiiSet< xiiSharedPtr< xiiGALBuffer > >	m_BuffersInUse
xiiMutex	m_Lock
xiiSharedPtr< xiiGALDevice >	m_pDevice

Detailed Description

This class serves as a pool for GPU related resources (e.g. buffers and textures required for rendering). Note that the functions creating and returning render targets are thread safe (by using a mutex).

Member Function Documentation

RunGC()

void xiiGPUResourcePool::RunGC

(

xiiUInt32

uiMinimumAge

)

Tries to free resources which are currently in the pool. Triggered automatically due to allocation number / size thresholds but can be triggered manually (e.g. after editor window resize)

Parameters

uiMinimumAge

How many frames at least the resource needs to have been unused before it will be GCed.

---

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

• /home/runner/work/XII/XII/Source/Engine/GraphicsCore/GPUResourcePool/GPUResourcePool.h
• /home/runner/work/XII/XII/Source/Engine/GraphicsCore/GPUResourcePool/Implementation/GPUResourcePool.cpp