spark::render::IPushConstantsLayout Class Reference

Interface for a push constants layout. More...

#include <PushConstantsLayout.h>

Inheritance diagram for spark::render::IPushConstantsLayout:

Public Member Functions
virtual unsigned int	size () const noexcept=0
	Get the size (in bytes) of the push constants backing memory.
virtual const IPushConstantsRange &	range (ShaderStage stage) const =0
	Get the push constants range associated with the shader stage provided.
std::vector< const IPushConstantsRange * >	ranges () const noexcept
	Get all push constants ranges .

Detailed Description

Interface for a push constants layout.

Member Function Documentation

range()

virtual const IPushConstantsRange & spark::render::IPushConstantsLayout::range ( ShaderStage stage ) const

nodiscardpure virtual

Get the push constants range associated with the shader stage provided.

Returns

The push constants range associated with the shader stage provided.

Exceptions

spark::base::ArgumentOutOfRangeException	if no range is mapped to the provided shader stage.
spark::base::BadArgumentException	if stage contains multiple shader stages.

Implemented in spark::render::PushConstantsLayout< PushConstantsRangeType >, spark::render::PushConstantsLayout< VulkanPushConstantsRange >, and spark::render::vk::VulkanPushConstantsLayout.

ranges()

std::vector< const IPushConstantsRange * > spark::render::IPushConstantsLayout::ranges ( ) const

inlinenodiscardnoexcept

Get all push constants ranges .

Returns

All push constants ranges .

size()

virtual unsigned int spark::render::IPushConstantsLayout::size ( ) const

nodiscardpure virtualnoexcept

Get the size (in bytes) of the push constants backing memory.

Returns

The size (in bytes) of the push constants backing memory.

Implemented in spark::render::vk::VulkanPushConstantsLayout.