Murl::Video::IIndices Interface Referenceabstract
The IIndices video object interface. More...
#include "murl_video_i_indices.h"
Inheritance diagram for Murl::Video::IIndices:
Public Member Functions | |
| virtual SInt32 | AddIndexBuffer (IIndexBuffer *indexBuffer)=0 |
| Add a single default index buffer. More... | |
| virtual SInt32 | AddIndexBuffer (IEnums::IndexBufferItem item, IIndexBuffer *indexBuffer)=0 |
| Add a single predefined index buffer. More... | |
| virtual SInt32 | AddIndexBuffer (SInt32 id, IIndexBuffer *indexBuffer)=0 |
| Add a single custom index buffer, by its unique integer ID in the renderer. More... | |
| virtual SInt32 | AddIndexBuffer (const String &name, IIndexBuffer *indexBuffer)=0 |
| Add a single custom index buffer, by its actual name. More... | |
| virtual Bool | RemoveAllIndexBuffers ()=0 |
| Remove all present index buffers from the container. More... | |
| virtual SInt32 | GetIndexBufferIndex (IEnums::IndexBufferItem item) const =0 |
| Get the index of a predefined index buffer in the container. More... | |
| virtual SInt32 | GetIndexBufferIndex (SInt32 id) const =0 |
| Get the index of a custom index buffer in the container, by its unique integer ID. More... | |
| virtual SInt32 | GetIndexBufferIndex (const String &name) const =0 |
| Get the index of a custom index buffer in the container, by its actual name. More... | |
| virtual UInt32 | GetNumberOfIndexBuffers () const =0 |
| Get the total number of individual index buffers present in the container. More... | |
| virtual IEnums::IndexBufferItem | GetIndexBufferItem (UInt32 index) const =0 |
| Get the predefined index buffer item at a given index. More... | |
| virtual SInt32 | GetIndexBufferId (UInt32 index) const =0 |
| Get the unique integer ID of a index buffer at a given index. More... | |
| virtual IIndexBuffer * | GetIndexBuffer (UInt32 index) const =0 |
| Get the index buffer at a given index. More... | |
| UInt32 | GetSignature () const override=0 |
| Get the signature, obtained via IRenderer::AcquireIndicesSignature(). More... | |
 Public Member Functions inherited from Murl::Video::IDrawable | |
| virtual IObject * | GetObjectInterface ()=0 |
| Get the mutable Video::IObject interface. More... | |
| virtual const IObject * | GetObjectInterface () const =0 |
| Get the constant Video::IObject interface. More... | |
| virtual Bool | Draw ()=0 |
| Draw the object. More... | |
| virtual Bool | IsDynamicBatchingAllowed () const =0 |
| Check if the drawable allows for dynamic batching. More... | |
| virtual Bool | HasDataToDraw () const =0 |
| Check if the drawable is actually containing any geometry data. More... | |
| virtual UInt32 | GetNumberOfBones () const =0 |
| Get the number of bones affecting the drawable. More... | |
Detailed Description
The IIndices video object interface.
This interface represents a container object holding references to one or more individual IIndexBuffer objects.
Used internally by various geometry graph nodes, such as Graph::GenericGeometry, Graph::ResourceMeshGeometry and others.
Member Function Documentation
◆ AddIndexBuffer() [1/4]
|
pure virtual |
Add a single default index buffer.
- Parameters
-
indexBuffer The index buffer to add.
- Returns
- The zero-based index of the index buffer in the container, or -1 if failed.
◆ AddIndexBuffer() [2/4]
|
pure virtual |
Add a single predefined index buffer.
- Parameters
-
item The predefined item. indexBuffer The index buffer to add.
- Returns
- The zero-based index of the index buffer in the container, or -1 if failed.
◆ AddIndexBuffer() [3/4]
|
pure virtual |
Add a single custom index buffer, by its unique integer ID in the renderer.
- Parameters
-
id The buffer's unique integer ID. indexBuffer The index buffer to add.
- Returns
- The zero-based index of the index buffer in the container, or -1 if failed.
◆ AddIndexBuffer() [4/4]
|
pure virtual |
Add a single custom index buffer, by its actual name.
- Parameters
-
name The buffer name. indexBuffer The index buffer to add.
- Returns
- The zero-based index of the index buffer in the container, or -1 if failed.
◆ RemoveAllIndexBuffers()
|
pure virtual |
Remove all present index buffers from the container.
- Returns
- true if successful.
◆ GetIndexBufferIndex() [1/3]
|
pure virtual |
Get the index of a predefined index buffer in the container.
- Parameters
-
item The index buffer item to query.
- Returns
- The zero-based index of the buffer, or -1 if not found.
◆ GetIndexBufferIndex() [2/3]
Get the index of a custom index buffer in the container, by its unique integer ID.
- Parameters
-
id The unique integer ID of the index buffer to query.
- Returns
- The zero-based index of the buffer, or -1 if not found.
◆ GetIndexBufferIndex() [3/3]
Get the index of a custom index buffer in the container, by its actual name.
- Parameters
-
name The buffer name.
- Returns
- The zero-based index of the buffer, or -1 if not found.
◆ GetNumberOfIndexBuffers()
|
pure virtual |
Get the total number of individual index buffers present in the container.
- Returns
- The number of index buffers present.
◆ GetIndexBufferItem()
|
pure virtual |
Get the predefined index buffer item at a given index.
- Parameters
-
index The index of the buffer to query, from 0 to GetNumberOfIndexBuffers()-1.
- Returns
- The predefined buffer item, or IEnums::CONSTANT_BUFFER_ITEM_DEFAULT if the index is out of range.
◆ GetIndexBufferId()
Get the unique integer ID of a index buffer at a given index.
- Parameters
-
index The index of the buffer to query, from 0 to GetNumberOfIndexBuffers()-1.
- Returns
- The unique ID, or -1 if the index is out of range.
◆ GetIndexBuffer()
|
pure virtual |
Get the index buffer at a given index.
- Parameters
-
index The index of the buffer to query, from 0 to GetNumberOfIndexBuffers()-1.
- Returns
- The buffer, or null if the index is out of range.
◆ GetSignature()
|
overridepure virtual |
Get the signature, obtained via IRenderer::AcquireIndicesSignature().
- Returns
- The buffer signature.
Implements Murl::Video::IDrawable.
The documentation for this interface was generated from the following file:
- murl_video_i_indices.h