C# Class Axiom.RenderSystems.OpenGL.GLRTTManager

Abstract Factory for RenderTextures.
Inheritance: IDisposable
Show file Open project: WolfgangSt/axiom Class Usage Examples

Public Methods

Method Description
Bind ( RenderTarget target ) : void

Bind a certain render target.
CheckFormat ( PixelFormat format ) : bool

Check if a certain format is usable as rendertexture format
CreateMultiRenderTarget ( string name ) : Axiom.Graphics.MultiRenderTarget

Create a multi render target
CreateRenderTexture ( string name, Axiom.RenderSystems.OpenGL.GLSurfaceDesc target, bool writeGamma, int fsaa ) : RenderTexture

Create a texture rendertarget object
Dispose ( ) : void
GetSupportedAlternative ( PixelFormat format ) : PixelFormat

Get the closest supported alternative format. If format is supported, returns format.
Unbind ( RenderTarget target ) : void

Unbind a certain render target. This is called before binding another RenderTarget, and before the context is switched. It can be used to do a copy, or just be a noop if direct binding is used.

Protected Methods

Method Description
GLRTTManager ( Axiom.RenderSystems.OpenGL.BaseGLSupport glSupport ) : System

Internal constructor. This class cannot be instantiated externally.

Protected internal because this singleton will actually hold the instance of a subclass created by a render system plugin.

dispose ( bool disposeManagedResources ) : void

Class level dispose method

When implementing this method in an inherited class the following template should be used; protected override void dispose( bool disposeManagedResources ) { if ( !isDisposed ) { if ( disposeManagedResources ) { // Dispose managed resources. } // There are no unmanaged resources to release, but // if we add them, they need to be released here. } // If it is available, make the call to the // base class's Dispose(Boolean) method base.dispose( disposeManagedResources ); }

Method Details

Bind() public abstract method

Bind a certain render target.
public abstract Bind ( RenderTarget target ) : void
target Axiom.Graphics.RenderTarget
return void

CheckFormat() public abstract method

Check if a certain format is usable as rendertexture format
public abstract CheckFormat ( PixelFormat format ) : bool
format PixelFormat
return bool

CreateMultiRenderTarget() public method

Create a multi render target
public CreateMultiRenderTarget ( string name ) : Axiom.Graphics.MultiRenderTarget
name string
return Axiom.Graphics.MultiRenderTarget

CreateRenderTexture() public abstract method

Create a texture rendertarget object
public abstract CreateRenderTexture ( string name, Axiom.RenderSystems.OpenGL.GLSurfaceDesc target, bool writeGamma, int fsaa ) : RenderTexture
name string
target Axiom.RenderSystems.OpenGL.GLSurfaceDesc
writeGamma bool
fsaa int
return Axiom.Graphics.RenderTexture

Dispose() public method

public Dispose ( ) : void
return void

GLRTTManager() protected method

Internal constructor. This class cannot be instantiated externally.
Protected internal because this singleton will actually hold the instance of a subclass created by a render system plugin.
protected GLRTTManager ( Axiom.RenderSystems.OpenGL.BaseGLSupport glSupport ) : System
glSupport Axiom.RenderSystems.OpenGL.BaseGLSupport
return System

GetSupportedAlternative() public method

Get the closest supported alternative format. If format is supported, returns format.
public GetSupportedAlternative ( PixelFormat format ) : PixelFormat
format PixelFormat
return PixelFormat

Unbind() public abstract method

Unbind a certain render target. This is called before binding another RenderTarget, and before the context is switched. It can be used to do a copy, or just be a noop if direct binding is used.
public abstract Unbind ( RenderTarget target ) : void
target Axiom.Graphics.RenderTarget
return void

dispose() protected method

Class level dispose method
When implementing this method in an inherited class the following template should be used; protected override void dispose( bool disposeManagedResources ) { if ( !isDisposed ) { if ( disposeManagedResources ) { // Dispose managed resources. } // There are no unmanaged resources to release, but // if we add them, they need to be released here. } // If it is available, make the call to the // base class's Dispose(Boolean) method base.dispose( disposeManagedResources ); }
protected dispose ( bool disposeManagedResources ) : void
disposeManagedResources bool True if Unmanaged resources should be released.
return void