Castor3D 0.17.0
Multiplatform 3D engine
Public Member Functions | List of all members
castor3d::DebugDrawer Class Reference

#include <DebugDrawer.hpp>

Inheritance diagram for castor3d::DebugDrawer:
Inheritance graph
[legend]
Collaboration diagram for castor3d::DebugDrawer:
Collaboration graph
[legend]

Public Member Functions

C3D_API DebugDrawer (crg::FramePassGroup &graph, crg::FramePass const *previous, RenderDevice const &device, RenderTarget &parent, crg::ImageViewIdArray colour, Texture const &depth, uint32_t const *passIndex)
 Constructor.
 
C3D_API void addAabbs (ashes::VkDescriptorSetLayoutBindingArray const &descriptorBindings, ashes::WriteDescriptorSetArray const &descriptorWrites, VkDeviceSize instanceCount, ashes::PipelineShaderStageCreateInfoArray const &shader, bool enableDepthTest)
 Adds a buffer containing AABBs to draw.
 
C3D_API void addDrawable (DebugVertexBuffers vertexBuffers, DebugIndexBuffer indexBuffer, ashes::VkVertexInputAttributeDescriptionArray const &vertexAttributes, ashes::VkVertexInputBindingDescriptionArray const &vertexBindings, ashes::VkDescriptorSetLayoutBindingArray const &descriptorBindings, ashes::WriteDescriptorSetArray const &descriptorWrites, VkDeviceSize instanceCount, ashes::PipelineShaderStageCreateInfoArray const &shader, bool enableDepthTest)
 Adds a buffer containing AABBs to draw.
 
crg::FramePass const & getLastPass () const noexcept
 
- Public Member Functions inherited from castor::OwnedBy< RenderTarget >
RenderTarget * getOwner () const noexcept
 
void setOwner (RenderTarget &owner) noexcept
 

Additional Inherited Members

- Protected Member Functions inherited from castor::OwnedBy< RenderTarget >
 OwnedBy (RenderTarget &owner) noexcept
 Constructor.
 

Constructor & Destructor Documentation

◆ DebugDrawer()

C3D_API castor3d::DebugDrawer::DebugDrawer ( crg::FramePassGroup & graph,
crg::FramePass const * previous,
RenderDevice const & device,
RenderTarget & parent,
crg::ImageViewIdArray colour,
Texture const & depth,
uint32_t const * passIndex )

Constructor.

Parameters
[in]graphThe graph.
[in]previousThe previous pass.
[in]deviceThe GPU device.
[in]parentThe parent render target.
[in]colourThe target colour image.
[in]depthThe target depth image.
[in]passIndexThe pass index, to select the appropriate shader.

Member Function Documentation

◆ addAabbs()

C3D_API void castor3d::DebugDrawer::addAabbs ( ashes::VkDescriptorSetLayoutBindingArray const & descriptorBindings,
ashes::WriteDescriptorSetArray const & descriptorWrites,
VkDeviceSize instanceCount,
ashes::PipelineShaderStageCreateInfoArray const & shader,
bool enableDepthTest )

Adds a buffer containing AABBs to draw.

Parameters
[in]descriptorBindingsThe shader data bindings.
[in]descriptorWritesThe shader data.
[in]instanceCountThe number of instances to draw.
[in]shaderThe shader used to draw the AABB.
[in]enableDepthTesttrue to enable depth test.

◆ addDrawable()

C3D_API void castor3d::DebugDrawer::addDrawable ( DebugVertexBuffers vertexBuffers,
DebugIndexBuffer indexBuffer,
ashes::VkVertexInputAttributeDescriptionArray const & vertexAttributes,
ashes::VkVertexInputBindingDescriptionArray const & vertexBindings,
ashes::VkDescriptorSetLayoutBindingArray const & descriptorBindings,
ashes::WriteDescriptorSetArray const & descriptorWrites,
VkDeviceSize instanceCount,
ashes::PipelineShaderStageCreateInfoArray const & shader,
bool enableDepthTest )

Adds a buffer containing AABBs to draw.

Parameters
[in]vertexBuffersThe geometry vertex buffers.
[in]indexBufferThe geometry index buffers.
[in]vertexAttributesThe geometry vertex attributes.
[in]vertexBindingsThe geometry vertex bindings.
[in]descriptorBindingsThe shader data bindings.
[in]descriptorWritesThe shader data.
[in]instanceCountThe number of instances to draw.
[in]shaderThe shader used to draw the geometries.
[in]enableDepthTesttrue to enable depth test.

◆ getLastPass()

crg::FramePass const & castor3d::DebugDrawer::getLastPass ( ) const
inlinenoexcept

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