CeresEngine 0.2.0
A game development framework
Loading...
Searching...
No Matches
CeresEngine::RendererRenderable::Element Class Referencefinal

The rendering element for the renderable sub-meshes. More...

#include <CeresEngine/Renderer/RendererRenderable.hpp>

Inheritance diagram for CeresEngine::RendererRenderable::Element:
CeresEngine::RendererElement

Public Member Functions

 Element (RendererRenderable &renderable, const SubMesh &subMesh, UInt32 subMeshIndex)
 
 ~Element () final=default
 
const GPUVertexFormatgetVertexFormat () const noexcept final
 Returns the vertex format which the graphics pipeline must be compatible with.
 
void draw (GPUCommandBuffer &commandBuffer) const final
 Submits a draw command with the given renderer element.
 
const GPUVertexBuffergetVertexBuffer () const noexcept final
 
const GPUIndexBuffergetIndexBuffer () const noexcept final
 
const RendererMaterialgetMaterial () const noexcept final
 The material for the render element.
 
AABox getBoundingBox () const final
 Gets the renderable bounding box.
 
Sphere getBoundingSphere () const final
 Gets the renderable bounding sphere.
 
- Public Member Functions inherited from CeresEngine::RendererElement
virtual ~RendererElement ()=default
 

Private Attributes

RendererRenderablemRenderable
 The owning renderable object.
 
SubMesh mSubMesh
 The sub-mesh for the renderable element.
 
UInt32 mSubMeshIndex
 The sub-mesh index for the renderable element.
 

Detailed Description

The rendering element for the renderable sub-meshes.

Constructor & Destructor Documentation

◆ Element()

CeresEngine::RendererRenderable::Element::Element ( RendererRenderable renderable,
const SubMesh subMesh,
UInt32  subMeshIndex 
)
explicit

◆ ~Element()

CeresEngine::RendererRenderable::Element::~Element ( )
finaldefault

Member Function Documentation

◆ draw()

void CeresEngine::RendererRenderable::Element::draw ( GPUCommandBuffer commandBuffer) const
finalvirtual

Submits a draw command with the given renderer element.

Implements CeresEngine::RendererElement.

◆ getBoundingBox()

AABox CeresEngine::RendererRenderable::Element::getBoundingBox ( ) const
inlinefinalvirtual

Gets the renderable bounding box.

Implements CeresEngine::RendererElement.

◆ getBoundingSphere()

Sphere CeresEngine::RendererRenderable::Element::getBoundingSphere ( ) const
inlinefinalvirtual

Gets the renderable bounding sphere.

Implements CeresEngine::RendererElement.

◆ getIndexBuffer()

const GPUIndexBuffer & CeresEngine::RendererRenderable::Element::getIndexBuffer ( ) const
inlinefinalvirtualnoexcept

◆ getMaterial()

const RendererMaterial & CeresEngine::RendererRenderable::Element::getMaterial ( ) const
finalvirtualnoexcept

The material for the render element.

Implements CeresEngine::RendererElement.

◆ getVertexBuffer()

const GPUVertexBuffer & CeresEngine::RendererRenderable::Element::getVertexBuffer ( ) const
inlinefinalvirtualnoexcept

◆ getVertexFormat()

const GPUVertexFormat & CeresEngine::RendererRenderable::Element::getVertexFormat ( ) const
finalvirtualnoexcept

Returns the vertex format which the graphics pipeline must be compatible with.

Implements CeresEngine::RendererElement.

Member Data Documentation

◆ mRenderable

RendererRenderable& CeresEngine::RendererRenderable::Element::mRenderable
private

The owning renderable object.

◆ mSubMesh

SubMesh CeresEngine::RendererRenderable::Element::mSubMesh
private

The sub-mesh for the renderable element.

◆ mSubMeshIndex

UInt32 CeresEngine::RendererRenderable::Element::mSubMeshIndex
private

The sub-mesh index for the renderable element.


The documentation for this class was generated from the following file: