IRenderEffectFactory

Description

interface Tinman.Engine.Rendering.IRenderEffectFactory

Extended by

Example_DemoFactory sealed

Base interface for classes that create IRenderEffectBase objects for specific RenderEffectParameters objects.

Public / Methods

Can​Create​Render​Effect

public method CanCreateRenderEffect → (2)

context in : IGraphicsContext

[not-null]
The owning graphics context.

parameters in : RenderEffectParameters

[not-null]
The render effect parameters object.

returns → bool

false iff CreateRenderEffect returns null,
true otherwise.

Checks if this IRenderEffectFactory is capable of creating an instance of IRenderEffectBase for the given render effect parameters.

Create​Render​Effect

[OwnerReturn]
public method CreateRenderEffect → (2)

context in : IGraphicsContext

[not-null]
The owning graphics context.

parameters in : RenderEffectParameters

[not-null]
The render effect parameters object.

returns → IRenderEffectBase

The IRenderEffectBase object in state LifecycleState.Created or null if the given parameters in object is not applicable to this factory.

Creates an instance of IRenderEffectBase for the given render effect parameters.

The documentation of the concrete implementation class of parameters in depicts the render effect interface that will be implemented by the returned object.

IOException

If an error has occurred while loading the shader binary and/or metadata.

ValidatingException

If the shader metadata has an unsupported format and cannot be decoded.

RenderException

If a graphics subsystem error has occurred.