renoir::IRenderingLibrary Class Reference

This class encapsulates the global Rendering library. More...

#include <Coherent/renoir/include/RenoirCore/CoherentRenderingLibrary.h>

Inherited by renoir::Library.

Public Member Functions
virtual void	InitializeOnRenderThread (RendererBackend *backend)=0
	Registers the Rendering Library with a render thread and sets the rendering backend. More...
virtual void	DestroyRenderingResources ()=0
	Frees all rendering resources used by the Rendering Library that are shared in the Library.
virtual void	Uninitialize ()=0
	Destroys the renderer.
virtual const char *	GetVersion () const =0
	Gets the version of the Rendering Library.
virtual void	GetTextureCacheCountStats (unsigned &allocated, unsigned &capacity) const =0
	Gets info about the number of objects statistic of a internal texture cache. More...
virtual void	GetTextureCacheBytesStats (unsigned &allocated, unsigned &capacity) const =0
	Gets info about the bytes statistic of a internal texture cache. More...
virtual void	SetTextureCacheCountCapacity (unsigned capacity)=0
	Sets the number of objects of a internal texture cache. More...
virtual void	SetTextureCacheBytesCapacity (unsigned capacity)=0
	Sets the bytes of a internal texture cache. More...
virtual void	ClearTextureCache ()=0
	Clears the internal texture cache. More...
virtual void	GetScratchLayerCacheBytesStats (unsigned &allocated, unsigned &capacity) const =0
	Gets info about the amount of bytes allocated and the maximum capacity for objects in the internal per-frame layer cache. More...
virtual void	SetScratchLayerCacheBytesCapacity (unsigned capacity)=0
	Sets the maximum capacity in bytes for the internal per-frame layer cache. More...
virtual void	GetScratchLayerCacheCountStats (unsigned &count, unsigned &capacity) const =0
	Gets info about the allocated count and the maximum capacity for objects in the internal per-frame layer cache. More...
virtual void	SetScratchLayerCacheCountCapacity (unsigned capacity)=0
	Sets the maximum amount of objects for the internal per-frame layer cache. More...
virtual void	GetScratchTextureCacheBytesStats (unsigned &allocated, unsigned &capacity) const =0
	Gets info about the amount of bytes allocated and the maximum capacity for objects in the internal per-frame scratch texture cache. More...
virtual void	SetScratchTextureCacheBytesCapacity (unsigned capacity)=0
	Sets the maximum capacity in bytes for the internal per-frame scratch texture cache. More...
virtual void	GetScratchTextureCacheCountStats (unsigned &count, unsigned &capacity) const =0
	Gets info about the allocated count and the maximum capacity for objects in the internal per-frame scratch texture cache. More...
virtual void	SetScratchTextureCacheCountCapacity (unsigned capacity)=0
	Sets the maximum amount of objects for the internal per-frame scratch texture cache. More...
virtual void	ClearScratchLayersCache ()=0
	Clears the internal scratch layers cache. More...
virtual void	ClearScratchTexturesCache ()=0
	Clears the internal scratch texture cache. More...
virtual void	ClearTextAtlases ()=0
	Clears the internal fonts textures cache. More...

Static Public Member Functions
static RENOIR_API IRenderingLibrary *	Initialize (const RenderingLibraryParams &params)
	Initializes the library. More...

Detailed Description

This class encapsulates the global Rendering library.

Member Function Documentation

ClearScratchLayersCache()

virtual void renoir::IRenderingLibrary::ClearScratchLayersCache ( )

pure virtual

Clears the internal scratch layers cache.

Note

You must call this on the render thread.

ClearScratchTexturesCache()

virtual void renoir::IRenderingLibrary::ClearScratchTexturesCache ( )

pure virtual

Clears the internal scratch texture cache.

Note

You must call this on the render thread.

ClearTextAtlases()

virtual void renoir::IRenderingLibrary::ClearTextAtlases ( )

pure virtual

Clears the internal fonts textures cache.

Note

You must call this on the render thread.

ClearTextureCache()

virtual void renoir::IRenderingLibrary::ClearTextureCache ( )

pure virtual

Clears the internal texture cache.

Note

You must call this on the render thread.

GetScratchLayerCacheBytesStats()

virtual void renoir::IRenderingLibrary::GetScratchLayerCacheBytesStats ( unsigned &  allocated, unsigned &  capacity  ) const

pure virtual

Gets info about the amount of bytes allocated and the maximum capacity for objects in the internal per-frame layer cache.

Note

This cache is used for surfaces that can be packed with other surfaces.

You must call this on the render thread.

GetScratchLayerCacheCountStats()

virtual void renoir::IRenderingLibrary::GetScratchLayerCacheCountStats ( unsigned &  count, unsigned &  capacity  ) const

pure virtual

Gets info about the allocated count and the maximum capacity for objects in the internal per-frame layer cache.

Note

This cache is used for surfaces that can be packed with other surfaces.

You must call this on the render thread.

GetScratchTextureCacheBytesStats()

virtual void renoir::IRenderingLibrary::GetScratchTextureCacheBytesStats ( unsigned &  allocated, unsigned &  capacity  ) const

pure virtual

Gets info about the amount of bytes allocated and the maximum capacity for objects in the internal per-frame scratch texture cache.

Note

This cache is used for surfaces that require an exact size and are not packed with other surfaces.

You must call this on the render thread.

GetScratchTextureCacheCountStats()

virtual void renoir::IRenderingLibrary::GetScratchTextureCacheCountStats ( unsigned &  count, unsigned &  capacity  ) const

pure virtual

Gets info about the allocated count and the maximum capacity for objects in the internal per-frame scratch texture cache.

Note

This cache is used for surfaces that can be packed with other surfaces.

You must call this on the render thread.

GetTextureCacheBytesStats()

virtual void renoir::IRenderingLibrary::GetTextureCacheBytesStats ( unsigned &  allocated, unsigned &  capacity  ) const

pure virtual

Gets info about the bytes statistic of a internal texture cache.

Note

You must call this on the render thread.

GetTextureCacheCountStats()

virtual void renoir::IRenderingLibrary::GetTextureCacheCountStats ( unsigned &  allocated, unsigned &  capacity  ) const

pure virtual

Gets info about the number of objects statistic of a internal texture cache.

Note

You must call this on the render thread.

Initialize()

static RENOIR_API IRenderingLibrary* renoir::IRenderingLibrary::Initialize ( const RenderingLibraryParams &  params )

static

Initializes the library.

Parameters

params

the initialization parameters of the library.

Returns

A library object

Note

you can have only one library active at a time

InitializeOnRenderThread()

virtual void renoir::IRenderingLibrary::InitializeOnRenderThread ( RendererBackend *  backend )

pure virtual

Registers the Rendering Library with a render thread and sets the rendering backend.

Parameters

backend

Backend to be used in the render thread

Note

You must call this on the render thread.

SetScratchLayerCacheBytesCapacity()

virtual void renoir::IRenderingLibrary::SetScratchLayerCacheBytesCapacity ( unsigned  capacity )

pure virtual

Sets the maximum capacity in bytes for the internal per-frame layer cache.

Note

You must call this on the render thread.

SetScratchLayerCacheCountCapacity()

virtual void renoir::IRenderingLibrary::SetScratchLayerCacheCountCapacity ( unsigned  capacity )

pure virtual

Sets the maximum amount of objects for the internal per-frame layer cache.

Note

You must call this on the render thread.

SetScratchTextureCacheBytesCapacity()

virtual void renoir::IRenderingLibrary::SetScratchTextureCacheBytesCapacity ( unsigned  capacity )

pure virtual

Sets the maximum capacity in bytes for the internal per-frame scratch texture cache.

Note

You must call this on the render thread.

SetScratchTextureCacheCountCapacity()

virtual void renoir::IRenderingLibrary::SetScratchTextureCacheCountCapacity ( unsigned  capacity )

pure virtual

Sets the maximum amount of objects for the internal per-frame scratch texture cache.

Note

You must call this on the render thread.

SetTextureCacheBytesCapacity()

virtual void renoir::IRenderingLibrary::SetTextureCacheBytesCapacity ( unsigned  capacity )

pure virtual

Sets the bytes of a internal texture cache.

Note

You must call this on the render thread.

SetTextureCacheCountCapacity()

virtual void renoir::IRenderingLibrary::SetTextureCacheCountCapacity ( unsigned  capacity )

pure virtual

Sets the number of objects of a internal texture cache.

Note

You must call this on the render thread.