Node that reads back data from GPU buffer to CPU. More...

#include <ComputeOutNode.hpp>

Inheritance diagram for MayaFlux::Nodes::GpuSync::ComputeOutNode:

Collaboration diagram for MayaFlux::Nodes::GpuSync::ComputeOutNode:

Public Member Functions
	ComputeOutNode (const std::shared_ptr< Buffers::VKBuffer > &buffer, size_t element_count)
	Construct with GPU buffer and element count.

void	compute_frame () override
	Compute GPU data for this frame.

const std::vector< double > &	get_readback_data () const
	Get full readback array.

double	get_element (size_t index) const
	Get specific element from readback data.

size_t	get_element_count () const
	Get number of elements.

std::shared_ptr< Buffers::VKBuffer >	get_gpu_buffer () const
	Get GPU buffer.

bool	needs_gpu_update () const override
	Mark if this node needs GPU binding update.

void	clear_gpu_update_flag () override
	Clear the "needs update" flag after GPU binding.

Public Member Functions inherited from MayaFlux::Nodes::GpuSync::GpuSync
	~GpuSync () override=default

double	process_sample (double) override
	Single sample processing hook.

std::vector< double >	process_batch (unsigned int num_samples) override
	Batch processing for GPU nodes.

Public Member Functions inherited from MayaFlux::Nodes::Node
virtual	~Node ()=default
	Virtual destructor for proper cleanup of derived classes.

virtual void	on_tick (const NodeHook &callback)
	Registers a callback to be called on each tick.

virtual void	on_tick_if (const NodeHook &callback, const NodeCondition &condition)
	Registers a conditional callback.

virtual bool	remove_hook (const NodeHook &callback)
	Removes a previously registered callback.

virtual bool	remove_conditional_hook (const NodeCondition &callback)
	Removes a previously registered conditional callback.

virtual void	remove_all_hooks ()
	Removes all registered callbacks.

virtual void	reset_processed_state ()
	Resets the processed state of the node and any attached input nodes.

virtual double	get_last_output ()
	Retrieves the most recent output value produced by the node.

void	register_channel_usage (uint32_t channel_id)
	Mark the specificed channel as a processor/user.

void	unregister_channel_usage (uint32_t channel_id)
	Removes the specified channel from the usage tracking.

bool	is_used_by_channel (uint32_t channel_id) const
	Checks if the node is currently used by a specific channel.

void	request_reset_from_channel (uint32_t channel_id)
	Requests a reset of the processed state from a specific channel.

const std::atomic< uint32_t > &	get_channel_mask () const
	Retrieves the current bitmask of active channels using this node.

NodeContext &	get_last_context ()
	Retrieves the last created context object.

void	set_gpu_compatible (bool compatible)
	Sets whether the node is compatible with GPU processing.

bool	is_gpu_compatible () const
	Checks if the node supports GPU processing.

std::span< const float >	get_gpu_data_buffer () const
	Provides access to the GPU data buffer.

virtual void	save_state ()=0
	Saves the node's current state for later restoration Recursively cascades through all connected modulator nodes Protected - only NodeSourceProcessor and NodeBuffer can call.

virtual void	restore_state ()=0
	Restores the node's state from the last save Recursively cascades through all connected modulator nodes Protected - only NodeSourceProcessor and NodeBuffer can call.

Private Attributes
std::shared_ptr< Buffers::VKBuffer >	m_gpu_buffer

std::vector< double >	m_readback_data

size_t	m_element_count

Additional Inherited Members
Public Attributes inherited from MayaFlux::Nodes::Node
bool	m_fire_events_during_snapshot = false
	Internal flag controlling whether notify_tick fires during state snapshots Default: false (events don't fire during isolated buffer processing) Can be exposed in future if needed via concrete implementation in parent.

std::atomic< Utils::NodeState >	m_state { Utils::NodeState::INACTIVE }
	Atomic state flag tracking the node's processing status.

std::atomic< uint32_t >	m_modulator_count { 0 }
	Counter tracking how many other nodes are using this node as a modulator.

Protected Member Functions inherited from MayaFlux::Nodes::GpuSync::GpuSync
std::unique_ptr< NodeContext >	create_context (double) override
	GPU sync nodes don't produce scalar contexts.

void	notify_tick (double) override
	GPU sync nodes don't emit tick callbacks.

Protected Member Functions inherited from MayaFlux::Nodes::Node
virtual void	reset_processed_state_internal ()
	Resets the processed state of the node directly.

Protected Attributes inherited from MayaFlux::Nodes::Node
double	m_last_output { 0 }
	The most recent sample value generated by this oscillator.

bool	m_gpu_compatible {}
	Flag indicating if the node supports GPU processing This flag is set by derived classes to indicate whether the node can be processed on the GPU.

std::unique_ptr< NodeContext >	m_last_context
	The last context object created for callbacks.

std::vector< float >	m_gpu_data_buffer
	GPU data buffer for context objects.

std::vector< NodeHook >	m_callbacks
	Collection of standard callback functions.

std::vector< std::pair< NodeHook, NodeCondition > >	m_conditional_callbacks
	Collection of conditional callback functions with their predicates.

Detailed Description

Node that reads back data from GPU buffer to CPU.

Facilitates GPU → CPU data transfer by downloading compute shader results into a CPU-accessible vector. Useful for feedback loops where GPU computation results need to influence CPU-side node processing or decision-making.

Usage: // GPU computes particle collisions auto collision_buffer = std::make_shared<VKBuffer>(...); auto collision_node = std::make_shared<ComputeOutNode>(collision_buffer, 1);

// Node reads collision count from GPU double collision_count = collision_node->process_sample();

Definition at line 27 of file ComputeOutNode.hpp.

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description