Cogs.Core
|
Provides effects and shader management functionality. More...
#include <IEffects.h>
Public Member Functions | |
virtual EffectHandle | loadEffect (const EffectDescription &description)=0 |
Load an effect from the given description. | |
virtual EffectHandle | loadEffect (const StringView &fileName, EffectFlags::EEffectFlags effectFlags=EffectFlags::None)=0 |
Load the given single file effect. | |
virtual EffectHandle | loadComputeEffect (const StringView &fileName, EffectFlags::EEffectFlags effectFlags=EffectFlags::None)=0 |
Load the compute shader with the given file name and create an effect. | |
virtual EffectHandle | loadComputeEffect (const StringView &fileName, const PreprocessorDefinitions &definitions, EffectFlags::EEffectFlags effectFlags=EffectFlags::None)=0 |
Load the compute shader with the given file name and create an effect. | |
virtual EffectHandle | loadEffect (const StringView &vsFileName, const StringView &psFileName, EffectFlags::EEffectFlags effectFlags=EffectFlags::None)=0 |
Load an effect created from the vertex and pixel shader files given. | |
virtual EffectHandle | loadEffect (const StringView &vsFileName, const StringView &psFileName, const PreprocessorDefinitions &definitions, EffectFlags::EEffectFlags effectFlags=EffectFlags::None)=0 |
Load an effect created from the vertex and pixel shader files given, applying the given preprocessor definitions to the shaders. | |
virtual EffectHandle | loadEffectSource (const StringView &vsSource, const StringView &psSource, EffectFlags::EEffectFlags effectFlags=EffectFlags::None)=0 |
Load an effect created from the vertex and pixel shader sources given. | |
virtual EffectHandle | loadEffectSource (const StringView &vsSource, const StringView &gsSource, const StringView &psSource, EffectFlags::EEffectFlags effectFlags=EffectFlags::None)=0 |
Load an effect created from the vertex, geometry, and pixel shader sources given. | |
virtual EffectHandle | loadEffectSource (const StringView &vsSource, const StringView &psSource, const PreprocessorDefinitions &definitions, EffectFlags::EEffectFlags effectFlags=EffectFlags::None)=0 |
Load an effect created from the vertex and pixel shader sources given, applying the given preprocessor definitions to the shaders. | |
virtual EffectHandle | loadEffectSource (const StringView &vsSource, const StringView &gsSource, const StringView &psSource, const PreprocessorDefinitions &definitions, EffectFlags::EEffectFlags effectFlags=EffectFlags::None)=0 |
Load an effect created from the vertex, geometry, and pixel shader sources given, applying the given preprocessor definitions to the shaders. | |
virtual void | releaseEffect (EffectHandle effectHandle)=0 |
Release the effect with the given handle, freeing all resources generated during program loading. | |
virtual EffectVariableHandle | getEffectVariable (EffectHandle effectHandle, const StringView &name)=0 |
Get a handle to the variable with the given name in the effect with the given effectHandle. | |
virtual ConstantBufferBindingHandle | getConstantBufferBinding (EffectHandle effectHandle, const StringView &name)=0 |
Get a handle to a constant buffer binding, mapping how to bind a constant buffer to the given effect. | |
virtual TextureBindingHandle | getTextureBinding (EffectHandle effectHandle, const StringView &name, const unsigned int slot)=0 |
Get a handle to a texture object binding, mapping how to bind textures to the given effect. | |
virtual BufferBindingHandle | getBufferBinding (EffectHandle effectHandle, const StringView &name)=0 |
Get a handle to a buffer binding. | |
virtual void | releaseBufferBinding (BufferBindingHandle bufferBindingHandle)=0 |
Release a handle to a buffer binding. | |
virtual SamplerStateBindingHandle | getSamplerStateBinding (EffectHandle effectHandle, const StringView &name, const unsigned int slot)=0 |
Get a handle to a sampler state object binding, mapping how to bind the sampler state to the given effect. | |
virtual void | releaseResources ()=0 |
Release all allocated effect resources. | |
virtual void | annotate (EffectHandle handle, const StringView &name) |
Associate a name with an object for use in graphics debugging. | |
virtual void | annotateVS (EffectHandle handle, const StringView &name) |
Associate a name with an object for use in graphics debugging. | |
virtual void | annotateGS (EffectHandle handle, const StringView &name) |
Associate a name with an object for use in graphics debugging. | |
virtual void | annotatePS (EffectHandle handle, const StringView &name) |
Associate a name with an object for use in graphics debugging. | |
virtual void | annotateCS (EffectHandle handle, const StringView &name) |
Associate a name with an object for use in graphics debugging. | |
virtual void | setIOHandler (IIOHandler *handler)=0 |
Sets an external I/O handler to use for I/O operations. | |
virtual IIOHandler * | getIOHandler () |
Gets the external I/O handler. | |
Provides effects and shader management functionality.
Definition at line 147 of file IEffects.h.
|
inlinevirtual |
Associate a name with an object for use in graphics debugging.
Reimplemented in Cogs::EffectsD3D11, Cogs::EffectsGL20, Cogs::EffectsNull, and Cogs::EffectsWebGPU.
Definition at line 320 of file IEffects.h.
|
inlinevirtual |
Associate a name with an object for use in graphics debugging.
Reimplemented in Cogs::EffectsD3D11, Cogs::EffectsGL20, Cogs::EffectsNull, and Cogs::EffectsWebGPU.
Definition at line 340 of file IEffects.h.
|
inlinevirtual |
Associate a name with an object for use in graphics debugging.
Reimplemented in Cogs::EffectsD3D11, Cogs::EffectsGL20, Cogs::EffectsNull, and Cogs::EffectsWebGPU.
Definition at line 330 of file IEffects.h.
|
inlinevirtual |
Associate a name with an object for use in graphics debugging.
Reimplemented in Cogs::EffectsD3D11, Cogs::EffectsGL20, Cogs::EffectsNull, and Cogs::EffectsWebGPU.
Definition at line 335 of file IEffects.h.
|
inlinevirtual |
Associate a name with an object for use in graphics debugging.
Reimplemented in Cogs::EffectsD3D11, Cogs::EffectsGL20, Cogs::EffectsNull, and Cogs::EffectsWebGPU.
Definition at line 325 of file IEffects.h.
|
pure virtual |
Get a handle to a buffer binding.
Implemented in Cogs::EffectsCommon, Cogs::EffectsGL20, and Cogs::EffectsWebGPU.
|
pure virtual |
Get a handle to a constant buffer binding, mapping how to bind a constant buffer to the given effect.
The binding object can then be used to effectively bind the constant buffer before drawing, and avoid having to do name based lookups at runtime.
effectHandle | Valid handle to an effect. |
name | Name of the constant buffer as used in shaders. |
Implemented in Cogs::EffectsCommon, Cogs::EffectsGL20, Cogs::EffectsGLES30, and Cogs::EffectsWebGPU.
|
pure virtual |
Get a handle to the variable with the given name in the effect with the given effectHandle.
effectHandle | Valid handle to an effect. |
name | Name of the variable get a handle to. |
Implemented in Cogs::EffectsCommon, and Cogs::EffectsGLES30.
|
inlinevirtual |
Gets the external I/O handler.
Reimplemented in Cogs::EffectsCommon.
Definition at line 352 of file IEffects.h.
|
pure virtual |
Get a handle to a sampler state object binding, mapping how to bind the sampler state to the given effect.
The name is used to lookup a shader-defined sampler state object if supported. If named sampler states are not supported, the given slot is used to bind the sampler state.
In scenarios where no sampler state usage is defined in the shader, the sampler state object should be bound to a slot with the same number as the texture slot the sampler should be applied to.
effectHandle | Valid handle to an effect. |
name | Name of the sampler state object as used in shaders in the effect. If not supported by the graphics device, this field is ignored. |
slot | Slot number to bind the sampler state object to. The slot number is by default used to apply the sampler state when sampling from textures bound with the same slot index. On supported systems this may be remapped in the shaders. |
Implemented in Cogs::EffectsWebGPU, Cogs::EffectsCommon, Cogs::EffectsGL20, and Cogs::EffectsGLES30.
|
pure virtual |
Get a handle to a texture object binding, mapping how to bind textures to the given effect.
The name is used to lookup how to make textures set using this binding be bound to the shader variable of the same name. The slot number is used to bind the texture if no direct slot is given by the shader.
effectHandle | Valid handle to an effect. |
name | Name of the texture object as used in shaders in the effect. |
slot | Slot number to bind the texture object to. If multiple textures are bound to the same effect, the slot numbers must be unique and ranging from zero to the maximum number of texture slots for the graphics device. |
Implemented in Cogs::EffectsCommon, Cogs::EffectsGL20, Cogs::EffectsGLES30, and Cogs::EffectsWebGPU.
|
pure virtual |
Load the compute shader with the given file name and create an effect.
fileName | File name of a compute shader. |
definitions | A set of preprocessor definitions to apply to the shader source. |
Implemented in Cogs::EffectsNull, Cogs::EffectsWebGPU, Cogs::EffectsD3D11, Cogs::EffectsD3D12, Cogs::EffectsGL20, Cogs::EffectsGLES30, and Cogs::EffectsVK.
|
pure virtual |
Load the compute shader with the given file name and create an effect.
fileName | File name of a compute shader. |
Implemented in Cogs::EffectsNull, Cogs::EffectsWebGPU, Cogs::EffectsD3D11, Cogs::EffectsD3D12, Cogs::EffectsGL20, Cogs::EffectsGLES30, and Cogs::EffectsVK.
|
pure virtual |
Load an effect from the given description.
description | Effect description. |
Implemented in Cogs::EffectsCommon.
|
pure virtual |
Load the given single file effect.
fileName | File name of an effect to load. Must be a valid single file effect (for D3D11 typically .fx file). |
Implemented in Cogs::EffectsCommon.
|
pure virtual |
Load an effect created from the vertex and pixel shader files given, applying the given preprocessor definitions to the shaders.
vsFileName | File name for the vertex shader. |
psFileName | File name for the pixel shader. |
definitions | A list of preprocessor definitions (key, value pairs) to apply to the shaders before compilation. |
Implemented in Cogs::EffectsCommon.
|
pure virtual |
Load an effect created from the vertex and pixel shader files given.
vsFileName | File name for the vertex shader. |
psFileName | File name for the pixel shader. |
Implemented in Cogs::EffectsCommon.
|
pure virtual |
Load an effect created from the vertex, geometry, and pixel shader sources given, applying the given preprocessor definitions to the shaders.
vsSource | Source code for the vertex shader. |
gsSource | Source code for the geometry shader. |
psSource | Source code for the pixel shader. |
definitions | A list of preprocessor definitions (key, value pairs) to apply to the shaders before compilation. |
effectFlags | Flags to describe effect source. |
Implemented in Cogs::EffectsCommon.
|
pure virtual |
Load an effect created from the vertex, geometry, and pixel shader sources given.
vsSource | Source code for the vertex shader. |
gsSource | Source code for the geometry shader. |
psSource | Source code for the pixel shader. |
effectFlags | Flags to describe effect source. |
Implemented in Cogs::EffectsCommon.
|
pure virtual |
Load an effect created from the vertex and pixel shader sources given, applying the given preprocessor definitions to the shaders.
vsSource | Source code for the vertex shader. |
psSource | Source code for the pixel shader. |
definitions | A list of preprocessor definitions (key, value pairs) to apply to the shaders before compilation. |
effectFlags | Flags to describe effect source. |
Implemented in Cogs::EffectsCommon.
|
pure virtual |
Load an effect created from the vertex and pixel shader sources given.
vsSource | Source code for the vertex shader. |
psSource | Source code for the pixel shader. |
effectFlags | Flags to describe effect source. |
Implemented in Cogs::EffectsCommon.
|
pure virtual |
Release a handle to a buffer binding.
Implemented in Cogs::EffectsCommon, Cogs::EffectsGL20, and Cogs::EffectsWebGPU.
|
pure virtual |
Release the effect with the given handle, freeing all resources generated during program loading.
effectHandle | Valid handle to a previously created effect. |
Implemented in Cogs::EffectsNull, Cogs::EffectsVK, Cogs::EffectsWebGPU, Cogs::EffectsD3D12, Cogs::EffectsGLES30, Cogs::EffectsD3D11, and Cogs::EffectsGL20.
|
pure virtual |
Release all allocated effect resources.
Implemented in Cogs::EffectsD3D12, Cogs::EffectsGLES30, Cogs::EffectsD3D11, Cogs::EffectsNull, Cogs::EffectsGL20, Cogs::EffectsVK, and Cogs::EffectsWebGPU.
|
pure virtual |
Sets an external I/O handler to use for I/O operations.
handler | Pointer to user implemented I/O handler. |
Implemented in Cogs::EffectsCommon.