The IConstants video object interface.
More...
#include "murl_video_i_constants.h"
Inherited by Murl::Video::Constants, and Murl::Video::Vulkan::Constants.
The IConstants video object interface.
This interface represents a container object holding references to one or more individual IConstantBuffer objects.
Used internally by Graph::FixedParameters and Graph::GenericParameters.
◆ GetObjectInterface() [1/2]
| virtual IObject* Murl::Video::IConstants::GetObjectInterface |
( |
| ) |
|
|
pure virtual |
◆ GetObjectInterface() [2/2]
| virtual const IObject* Murl::Video::IConstants::GetObjectInterface |
( |
| ) |
const |
|
pure virtual |
◆ Enable()
| virtual Bool Murl::Video::IConstants::Enable |
( |
| ) |
|
|
pure virtual |
Enable the constants container.
- Returns
- true if successful.
◆ Disable()
| virtual Bool Murl::Video::IConstants::Disable |
( |
| ) |
|
|
pure virtual |
Disable the constants container.
- Returns
- true if successful.
◆ Set()
| virtual Bool Murl::Video::IConstants::Set |
( |
IProgram * |
currentProgram | ) |
|
|
pure virtual |
Attach the constants container to the current GPU program.
- Parameters
-
| currentProgram | The current GPU program. |
- Returns
- true if successful.
◆ AddConstantBuffer() [1/4]
Add a single default constant buffer.
- Parameters
-
| constantBuffer | The constant buffer to add. |
- Returns
- The zero-based index of the constant buffer in the container, or -1 if failed.
◆ AddConstantBuffer() [2/4]
Add a single predefined constant buffer.
- Parameters
-
| item | The predefined item. |
| constantBuffer | The constant buffer to add. |
- Returns
- The zero-based index of the constant buffer in the container, or -1 if failed.
◆ AddConstantBuffer() [3/4]
Add a single custom constant buffer, by its unique integer ID in the renderer.
- Parameters
-
| id | The buffer's unique integer ID. |
| constantBuffer | The constant buffer to add. |
- Returns
- The zero-based index of the constant buffer in the container, or -1 if failed.
◆ AddConstantBuffer() [4/4]
Add a single custom constant buffer, by its actual name.
- Parameters
-
| name | The buffer name. |
| constantBuffer | The constant buffer to add. |
- Returns
- The zero-based index of the constant buffer in the container, or -1 if failed.
◆ RemoveAllConstantBuffers()
| virtual Bool Murl::Video::IConstants::RemoveAllConstantBuffers |
( |
| ) |
|
|
pure virtual |
Remove all present constant buffers from the container.
- Returns
- true if successful.
◆ GetConstantBufferIndex() [1/3]
Get the index of a predefined constant buffer in the container.
- Parameters
-
| item | The constant buffer item to query. |
- Returns
- The zero-based index of the buffer, or -1 if not found.
◆ GetConstantBufferIndex() [2/3]
| virtual SInt32 Murl::Video::IConstants::GetConstantBufferIndex |
( |
SInt32 |
id | ) |
const |
|
pure virtual |
Get the index of a custom constant buffer in the container, by its unique integer ID.
- Parameters
-
| id | The unique integer ID of the constant buffer to query. |
- Returns
- The zero-based index of the buffer, or -1 if not found.
◆ GetConstantBufferIndex() [3/3]
| virtual SInt32 Murl::Video::IConstants::GetConstantBufferIndex |
( |
const String & |
name | ) |
const |
|
pure virtual |
Get the index of a custom constant buffer in the container, by its actual name.
- Parameters
-
- Returns
- The zero-based index of the buffer, or -1 if not found.
◆ GetNumberOfConstantBuffers()
| virtual UInt32 Murl::Video::IConstants::GetNumberOfConstantBuffers |
( |
| ) |
const |
|
pure virtual |
Get the total number of individual constant buffers present in the container.
- Returns
- The number of constant buffers present.
◆ GetConstantBufferItem()
◆ GetConstantBufferId()
| virtual SInt32 Murl::Video::IConstants::GetConstantBufferId |
( |
UInt32 |
index | ) |
const |
|
pure virtual |
Get the unique integer ID of a constant buffer at a given index.
- Parameters
-
- Returns
- The unique ID, or -1 if the index is out of range.
◆ GetConstantBuffer()
Get the constant buffer at a given index.
- Parameters
-
- Returns
- The buffer, or null if the index is out of range.
◆ AreEqual()
| virtual Bool Murl::Video::IConstants::AreEqual |
( |
const IConstants * |
other | ) |
const |
|
pure virtual |
Check if the container is equal to another one.
- Parameters
-
| other | The container to compare with. |
- Returns
- true if the containers are equal.
◆ GetSignature()
| virtual UInt32 Murl::Video::IConstants::GetSignature |
( |
| ) |
const |
|
pure virtual |
The documentation for this interface was generated from the following file:
