GLContext

Description

abstract class Tinman.Engine.API.GLContext

Derived from

GraphicsContext abstract
IRenderContextDependent

Extended by

OpenGLContext sealed
OpenGLESContext sealed

Abstract base class for IGraphicsContext implementations that use a GL-style API.

Public / Attributes

Debug​Frequent​Error​Checks

[DebugHelper] [ShutdownClear]
public static attribute DebugFrequentErrorChecks → (bool)

Perform GL error checks with GLBase.ErrorReset2 more often?

Defaults to false.

Debug​Output​Source​And​Errors

[DebugHelper] [ShutdownClear]
public static attribute DebugOutputSourceAndErrors → (bool)

Output GLSL source code and compiler / linker errors to the local GLSL program cache directory (configured via IGraphicsContextFactory.ShaderRepository)?

Defaults to false.

Default​Frame​Buffer​Object

public attribute DefaultFrameBufferObject → (get,set)

value : int32

The framebuffer object to use for RenderTargets.None.

The default framebuffer object.

Defaults to 0.

Default​Frame​Buffer​Srgb

public attribute DefaultFrameBufferSrgb → (get,set)

value : bool

true to enable the sRGB fix for the default framebuffer,
false to disable it.

Enables the sRGB fix (see remarks) for the default framebuffer, whose behaviour is implementation-specific.

When the sRGB fix is enabled, GL.FRAMEBUFFER_SRGB resp. GLES.FRAMEBUFFER_SRGB_EXT will be disabled with when a swap chain writes to the default framebuffer object. Otherwise, it will stay enabled (after having been set by IGraphicsContext.SetRenderTarget). Defaults to true.

See also

GLContext.DefaultFrameBufferObject

Protected / Constructors

GLContext

protected constructor GLContext → (3)

renderContext in : RenderContext own

[not-null]
The GL render context.

multiSample in : MultiSampleType

The maximum multi-sample setting to use.

shaderRepository in : Path

[not-null]
See IGraphicsContextFactory.ShaderRepository.

Creates a new instance of GraphicsContext.

Protected / Methods

Compute​Maximum​Texture​Size

[Pure]
protected method ComputeMaximumTextureSize → (1)

size in : int32

The maximum texture size that has been provided externally (in megabytes) or 0 to set the default value.

returns → int32

The maximum texture size, in megabytes.

Computes the maximum texture size.

Compute​Video​Memory

[Pure]
protected method ComputeVideoMemory → (1)

memory in : int32

The video memory size that has been provided externally (in megabytes) or 0 to try to determine the amount of video memory automatically.

returns → int32

The amount of video memory, in megabytes.

Computes the amount of available video memory.

Frame​Buffer​Apply

protected method FrameBufferApply → (1)

targets in : RenderTargets

The render target set.

Applies the given render targets in.

Frame​Buffer​Object​Create

[OwnerReturn]
protected abstract method FrameBufferObjectCreate → (1)

targets in : RenderTargets

The render target set.

returns → int32

The framebuffer object.

Creates a framebuffer object for the given render target set.

Frame​Buffer​Object​Delete

protected abstract method FrameBufferObjectDelete → (1)

fbo in : int32 own

The framebuffer object.

Deletes the given framebuffer object.

Frame​Buffer​Object​Set

protected abstract method FrameBufferObjectSet → (1)

fbo in : int32

The framebuffer object or 0 for the default framebuffer.

Applies the given framebuffer object for subsequent use.

Input​Layout​Apply_​Buffer

protected method InputLayoutApply_Buffer → (1)

buffer in : IGeometryBuffer

The mapping or null.

Applies the given buffer in to the input layout.

Vertex​Array​Object​Create

[OwnerReturn]
protected abstract method VertexArrayObjectCreate → (3)

buffer in : IGeometryBuffer

The geometry buffer (vertex / index buffer).

program in : int32

The program name (vertex attribute locations).

mapping in : Mapping2D<int32>

Mapping between vertex elements and attribute location.

returns → int32

The created vertex array object.

Creates a vertex array object for the given input.

Vertex​Array​Object​Delete

protected abstract method VertexArrayObjectDelete → (1)

vao in : int32 own

The vertex array object.

Deletes the given vertex array object.

Vertex​Array​Object​Set

protected abstract method VertexArrayObjectSet → (1)

vao in : int32

The vertex array object or 0 for none.

Applies the given vertex array object for subsequent use.

Protected / Attributes

multi​Sample

protected attribute multiSample → (int32)

The maximum multi-sample count or 0 if multi-sampling is not available.

render​Context

[Owner]
protected attribute renderContext → (RenderContext)

The GL render context.