MayaFlux::Buffers::ShaderProcessor Class Reference

Abstract base class for shader-based buffer processing. More...

#include <ShaderProcessor.hpp>

Inheritance diagram for MayaFlux::Buffers::ShaderProcessor:

Collaboration diagram for MayaFlux::Buffers::ShaderProcessor:

Public Types
enum class	BufferUsageHint : uint8_t { NONE = 0 , INPUT_READ = 1 << 0 , OUTPUT_WRITE = 1 << 1 , BIDIRECTIONAL = INPUT_READ | OUTPUT_WRITE }
	Get buffer usage characteristics needed for safe data flow. More...

Public Member Functions
	ShaderProcessor (const std::string &shader_path)
	Construct processor with shader path.
	ShaderProcessor (ShaderConfig config)
	Construct processor with full configuration.
	~ShaderProcessor () override
void	processing_function (const std::shared_ptr< Buffer > &buffer) override
	The core processing function that must be implemented by derived classes.
void	on_attach (const std::shared_ptr< Buffer > &buffer) override
	Called when this processor is attached to a buffer.
void	on_detach (const std::shared_ptr< Buffer > &buffer) override
	Called when this processor is detached from a buffer.
bool	is_compatible_with (const std::shared_ptr< Buffer > &buffer) const override
	Checks if this processor can handle the specified buffer type.
void	bind_buffer (const std::string &descriptor_name, const std::shared_ptr< VKBuffer > &buffer)
	Bind a VKBuffer to a named shader descriptor.
void	unbind_buffer (const std::string &descriptor_name)
	Unbind a buffer from a descriptor.
std::shared_ptr< VKBuffer >	get_bound_buffer (const std::string &descriptor_name) const
	Get bound buffer for a descriptor name.
void	auto_bind_buffer (const std::shared_ptr< VKBuffer > &buffer)
	Auto-bind buffer based on attachment order.
bool	hot_reload_shader ()
	Hot-reload shader from ShaderFoundry.
void	set_shader (const std::string &shader_path)
	Update shader path and reload.
const std::string &	get_shader_path () const
	Get current shader path.
void	set_push_constant_size (size_t size)
	Set push constant size.
template<typename T >
void	set_push_constant_size ()
	Set push constant size from type.
template<typename T >
void	set_push_constant_data (const T &data)
	Update push constant data (type-safe)
void	set_push_constant_data_raw (const void *data, size_t size)
	Update push constant data (raw bytes)
const std::vector< uint8_t > &	get_push_constant_data () const
	Get current push constant data.
std::vector< uint8_t > &	get_push_constant_data ()
void	set_specialization_constant (uint32_t constant_id, uint32_t value)
	Set specialization constant.
void	clear_specialization_constants ()
	Clear all specialization constants.
void	set_config (const ShaderConfig &config)
	Update entire configuration.
const ShaderConfig &	get_config () const
	Get current configuration.
void	add_binding (const std::string &descriptor_name, const ShaderBinding &binding)
	Add descriptor binding configuration.
virtual BufferUsageHint	get_buffer_usage_hint (const std::string &descriptor_name) const
	Get buffer usage hint for a descriptor.
virtual bool	is_in_place_operation (const std::string &descriptor_name) const
	Check if shader modifies a specific buffer in-place.
bool	has_binding (const std::string &descriptor_name) const
	Check if a descriptor binding exists.
std::vector< std::string >	get_binding_names () const
	Get all configured descriptor names.
bool	are_bindings_complete () const
	Check if all required bindings are satisfied.
bool	is_shader_loaded () const
	Check if shader is loaded.
bool	are_descriptors_ready () const
	Check if descriptors are initialized.
size_t	get_bound_buffer_count () const
	Get number of bound buffers.
virtual std::shared_ptr< VKBuffer >	get_output_buffer () const
	Get the output buffer after compute dispatch.
virtual bool	has_executed () const
	Check if compute has been executed at least once.
Public Member Functions inherited from MayaFlux::Buffers::BufferProcessor
virtual	~BufferProcessor ()=default
	Virtual destructor for proper cleanup of derived classes.
void	process (const std::shared_ptr< Buffer > &buffer)
	Applies a computational transformation to the data in the provided buffer.
virtual void	set_processing_token (ProcessingToken token)
	Gets the preferred processing backend for this processor.
virtual ProcessingToken	get_processing_token () const
	Gets the current processing token for this buffer.

Protected Member Functions
virtual void	on_before_compile (const std::string &shader_path)
	Called before shader compilation.
virtual void	on_shader_loaded (Portal::Graphics::ShaderID shader_id)
	Called after shader is loaded.
virtual void	on_before_pipeline_create (Portal::Graphics::ComputePipelineID pipeline_id)
	Called before pipeline creation.
virtual void	on_pipeline_created (Portal::Graphics::ComputePipelineID pipeline_id)
	Called after pipeline is created.
virtual void	on_before_descriptors_create ()
	Called before descriptor sets are created.
virtual void	on_descriptors_created ()
	Called after descriptor sets are created.
virtual bool	on_before_execute (Portal::Graphics::CommandBufferID cmd_id, const std::shared_ptr< VKBuffer > &buffer)
	Called before each process callback.
virtual void	on_after_execute (Portal::Graphics::CommandBufferID cmd_id, const std::shared_ptr< VKBuffer > &buffer)
	Called after each process callback.
virtual void	initialize_pipeline (const std::shared_ptr< VKBuffer > &buffer)=0
virtual void	initialize_descriptors (const std::shared_ptr< VKBuffer > &buffer)=0
virtual void	execute_shader (const std::shared_ptr< VKBuffer > &buffer)=0
virtual void	update_descriptors (const std::shared_ptr< VKBuffer > &buffer)
virtual void	cleanup ()
Protected Member Functions inherited from MayaFlux::Buffers::VKBufferProcessor
void	initialize_buffer_service ()
void	initialize_compute_service ()

Protected Attributes
ShaderConfig	m_config
Portal::Graphics::ShaderID	m_shader_id = Portal::Graphics::INVALID_SHADER
std::vector< Portal::Graphics::DescriptorSetID >	m_descriptor_set_ids
Portal::Graphics::CommandBufferID	m_last_command_buffer = Portal::Graphics::INVALID_COMMAND_BUFFER
std::unordered_map< std::string, std::shared_ptr< VKBuffer > >	m_bound_buffers
std::shared_ptr< VKBuffer >	m_last_processed_buffer
std::vector< uint8_t >	m_push_constant_data
bool	m_initialized {}
bool	m_needs_pipeline_rebuild = true
bool	m_needs_descriptor_rebuild = true
size_t	m_auto_bind_index {}
Protected Attributes inherited from MayaFlux::Buffers::VKBufferProcessor
Registry::Service::BufferService *	m_buffer_service = nullptr
Registry::Service::ComputeService *	m_compute_service = nullptr
Protected Attributes inherited from MayaFlux::Buffers::BufferProcessor
ProcessingToken	m_processing_token { ProcessingToken::AUDIO_BACKEND }

Private Member Functions
void	initialize_shader ()

Detailed Description

Abstract base class for shader-based buffer processing.

ShaderProcessor provides the foundational infrastructure for managing shader resources, descriptor sets, and buffer bindings. It is designed to be stage-agnostic, serving as the common parent for specialized processors like ComputeProcessor and RenderProcessor.

Core Responsibilities:

• Shader Management: Loads and manages shader modules via Portal::Graphics::ShaderFoundry.
• Descriptor Management: Handles descriptor set allocation, updates, and binding.
• Buffer Binding: Maps logical names (e.g., "input", "output") to physical VKBuffers.
• Constants: Manages push constants and specialization constants.
• Hot-Reload: Supports runtime shader reloading and pipeline invalidation.

It does NOT define specific pipeline creation or execution logic (e.g., dispatch vs draw), leaving those details to derived classes (ComputeProcessor, RenderProcessor).

Quality-of-life features:

• Data movement hints: Query buffer usage (input/output/in-place) for automation.
• Binding introspection: Validate if required bindings are satisfied.
• State queries: Track processing state for chain management.

Design Philosophy:

• Inheritance-focused: Provides the "plumbing" for shader processors without dictating the pipeline type.
• Buffer-agnostic: Works with any VKBuffer modality/usage.
• Flexible binding: Decouples logical shader parameters from physical buffers.

Integration:

• Base class for ComputeProcessor (Compute Pipelines)
• Base class for RenderProcessor (Graphics Pipelines)
• Base class for NodeBindingsProcessor (Node-driven parameters)

Usage (via derived classes): // Compute example auto compute = std::make_shared<ComputeProcessor>("shaders/kernel.comp"); compute->bind_buffer("data", buffer);

// Graphics example auto render = std::make_shared<RenderProcessor>(config); render->bind_buffer("vertices", vertex_buffer);

Definition at line 90 of file ShaderProcessor.hpp.

---

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

• ShaderProcessor.hpp
• ShaderProcessor.cpp