LiteFX 0.3.1.2022
Computer Graphics Engine
LiteFX::Rendering::IPushConstantsRange Class Referenceabstract

Describes a range within a IPushConstantsLayout. More...

#include <rendering_api.hpp>

Inherited by LiteFX::Rendering::Backends::DirectX12PushConstantsRange, and LiteFX::Rendering::Backends::VulkanPushConstantsRange.

Public Member Functions

virtual ~IPushConstantsRange () noexcept=default
 
virtual const UInt32space () const noexcept=0
 Returns the shader space the push constants can be accessed from. More...
 
virtual const UInt32binding () const noexcept=0
 Returns the binding point or register, the push constants are made available at. More...
 
virtual const UInt32offset () const noexcept=0
 Returns the offset from the push constants backing memory block, the range starts at. More...
 
virtual const UInt32size () const noexcept=0
 Returns the size (in bytes) of the range. More...
 
virtual const ShaderStage & stage () const noexcept=0
 Returns the shader stage(s), the range is accessible from. More...
 

Detailed Description

Describes a range within a IPushConstantsLayout.

Constructor & Destructor Documentation

◆ ~IPushConstantsRange()

virtual LiteFX::Rendering::IPushConstantsRange::~IPushConstantsRange ( )
virtualdefaultnoexcept

Member Function Documentation

◆ binding()

virtual const UInt32 & LiteFX::Rendering::IPushConstantsRange::binding ( ) const
pure virtualnoexcept

Returns the binding point or register, the push constants are made available at.

Returns
The binding point or register, the push constants are made available at.

Implemented in LiteFX::Rendering::Backends::DirectX12PushConstantsRange, and LiteFX::Rendering::Backends::VulkanPushConstantsRange.

◆ offset()

virtual const UInt32 & LiteFX::Rendering::IPushConstantsRange::offset ( ) const
pure virtualnoexcept

Returns the offset from the push constants backing memory block, the range starts at.

Returns
The offset from the push constants backing memory block, the range starts at.
See also
size

Implemented in LiteFX::Rendering::Backends::DirectX12PushConstantsRange, and LiteFX::Rendering::Backends::VulkanPushConstantsRange.

◆ size()

virtual const UInt32 & LiteFX::Rendering::IPushConstantsRange::size ( ) const
pure virtualnoexcept

Returns the size (in bytes) of the range.

Returns
The size (in bytes) of the range.
See also
offset

Implemented in LiteFX::Rendering::Backends::DirectX12PushConstantsRange, and LiteFX::Rendering::Backends::VulkanPushConstantsRange.

◆ space()

virtual const UInt32 & LiteFX::Rendering::IPushConstantsRange::space ( ) const
pure virtualnoexcept

Returns the shader space the push constants can be accessed from.

Returns
The shader space the push constants can be accessed from.

Implemented in LiteFX::Rendering::Backends::DirectX12PushConstantsRange, and LiteFX::Rendering::Backends::VulkanPushConstantsRange.

◆ stage()

virtual const ShaderStage & LiteFX::Rendering::IPushConstantsRange::stage ( ) const
pure virtualnoexcept

Returns the shader stage(s), the range is accessible from.

Returns
The shader stage(s), the range is accessible from.

Implemented in LiteFX::Rendering::Backends::DirectX12PushConstantsRange, and LiteFX::Rendering::Backends::VulkanPushConstantsRange.