MayaFlux 0.4.0
Digital-First Multimedia Processing Framework
Loading...
Searching...
No Matches
MayaFlux::Buffers::ComputeMeshBuffer Class Reference

VKBuffer that evaluates a SpatialField isosurface via marching cubes on the GPU and renders directly without CPU readback. More...

#include <ComputeMeshBuffer.hpp>

+ Inheritance diagram for MayaFlux::Buffers::ComputeMeshBuffer:
+ Collaboration diagram for MayaFlux::Buffers::ComputeMeshBuffer:

Public Member Functions

 ComputeMeshBuffer (const glm::vec3 &bounds_min, const glm::vec3 &bounds_max, uint32_t res_x, uint32_t res_y, uint32_t res_z, float iso_level=0.0F, std::string field_shader="sdf_field_gyroid.comp")
 Construct in GPU-field mode.
 
 ComputeMeshBuffer (Kinesis::SpatialField field, const glm::vec3 &bounds_min, const glm::vec3 &bounds_max, uint32_t res_x, uint32_t res_y, uint32_t res_z, float iso_level=0.0F)
 
std::shared_ptr< SDFFieldProcessorget_field_processor () const
 Access the field processor to drive time or bounds from a metro.
 
void set_bounds (const glm::vec3 &bounds_min, const glm::vec3 &bounds_max)
 Replace the evaluation volume and mark dirty.
 
void set_dirty ()
 Request a re-dispatch on the next graphics frame.
 
void set_field (Kinesis::SpatialField field)
 Replace the scalar field and mark dirty.
 
void set_iso_level (float iso_level)
 Replace the iso_level threshold and mark dirty.
 
void set_resolution (uint32_t res_x, uint32_t res_y, uint32_t res_z)
 Replace the grid resolution.
 
void set_texture (std::shared_ptr< Core::VKImage > image, std::string binding="diffuseTex")
 Bind a diffuse texture sampled in the fragment shader.
 
void setup_processors (ProcessingToken token) override
 Setup processors with a processing token.
 
void setup_rendering (const RenderConfig &config)
 Create the RenderProcessor and attach it to the processing chain.
 
 ~ComputeMeshBuffer () override=default
 
- Public Member Functions inherited from MayaFlux::Buffers::VKBuffer
void clear () override
 Clear buffer contents.
 
void clear_pipeline_commands ()
 Clear all recorded commands (called after presentation)
 
void clear_vertex_layout ()
 Clear vertex layout.
 
std::shared_ptr< Bufferclone_to (uint8_t dest_desc) override
 Creates a clone of this buffer for a specific channel or usage enum.
 
std::shared_ptr< VKBufferclone_to (Usage usage)
 Create a clone of this buffer with the same data and properties.
 
void enforce_default_processing (bool should_process) override
 Controls whether the buffer should use default processing.
 
void force_internal_usage (bool internal) override
 Set whether this buffer is for internal engine usage.
 
std::vector< std::pair< size_t, size_t > > get_and_clear_dirty_ranges ()
 Retrieve and clear all dirty ranges.
 
std::vector< std::pair< size_t, size_t > > get_and_clear_invalid_ranges ()
 Retrieve and clear all invalid ranges.
 
vk::Buffer & get_buffer ()
 Get VkBuffer handle (VK_NULL_HANDLE if not registered)
 
const VKBufferResourcesget_buffer_resources ()
 Get all buffer resources at once.
 
std::vector< Kakshya::DataVariantget_data ()
 Read buffer contents as Kakshya DataVariant.
 
std::shared_ptr< Buffers::BufferProcessorget_default_processor () const override
 Get the currently attached default processor.
 
uint64_t get_device_address () const
 Get the Vulkan device address for this buffer (if applicable)
 
const std::vector< Kakshya::DataDimension > & get_dimensions () const
 Get the inferred data dimensions for the buffer contents.
 
EngineContextget_engine_context ()
 
const EngineContextget_engine_context () const
 
vk::Buffer get_index_buffer () const
 Return the raw index buffer handle.
 
size_t get_index_buffer_size () const
 Number of bytes in the index buffer.
 
void * get_mapped_ptr () const
 Get mapped host pointer (nullptr if not host-visible or unmapped)
 
vk::MemoryPropertyFlags get_memory_properties () const
 Get appropriate VkMemoryPropertyFlags for allocation based on Usage.
 
Kakshya::DataModality get_modality () const
 Get the buffer's semantic modality.
 
CommandBufferID get_pipeline_command (RenderPipelineID pipeline_id) const
 Get recorded command buffer for a pipeline.
 
PipelineContextget_pipeline_context ()
 Access the pipeline context for custom metadata (non-const)
 
const PipelineContextget_pipeline_context () const
 Access the pipeline context for custom metadata (const)
 
std::shared_ptr< Core::Windowget_pipeline_window (RenderPipelineID id) const
 Get the window associated with this buffer.
 
std::shared_ptr< Buffers::BufferProcessingChainget_processing_chain () override
 Access the buffer's processing chain.
 
RenderConfig get_render_config () const
 Get the current render configuration.
 
std::unordered_map< RenderPipelineID, std::shared_ptr< Core::Window > > get_render_pipelines () const
 Get all render pipelines associated with this buffer.
 
virtual std::shared_ptr< RenderProcessorget_render_processor () const
 Get a RenderProcessor suitable for rendering this buffer.
 
size_t get_size () const
 Get current logical size in bytes.
 
vk::DeviceSize get_size_bytes () const
 
Usage get_usage () const
 Retrieve the declared usage intent.
 
vk::BufferUsageFlags get_usage_flags () const
 Get appropriate VkBufferUsageFlags for creation based on Usage.
 
std::optional< Kakshya::VertexLayoutget_vertex_layout () const
 Get vertex layout if set.
 
bool has_data_for_cycle () const override
 Checks if the buffer has data for the current processing cycle.
 
bool has_index_buffer () const
 True when an index buffer has been associated with this buffer.
 
bool has_render_pipeline () const
 Check if this buffer has a rendering pipeline configured.
 
bool has_vertex_layout () const
 Check if this buffer has vertex layout configured.
 
bool is_host_visible () const
 Whether this VKBuffer should be host-visible.
 
bool is_initialized () const
 Check whether Vulkan handles are present (buffer registered)
 
bool is_internal_only () const override
 Check whether this buffer is for internal engine usage.
 
bool is_processing () const override
 Query whether the buffer is currently being processed.
 
bool is_render_config_dirty () const
 Check if config has changed since last frame.
 
void mark_dirty_range (size_t offset, size_t size)
 Get device memory handle.
 
void mark_for_processing (bool has_data) override
 Marks the buffer's data availability for the current processing cycle.
 
void mark_for_removal () override
 Marks the buffer for removal from processing chains.
 
void mark_invalid_range (size_t offset, size_t size)
 Mark a range as invalid (needs download)
 
virtual void mark_render_config_dirty (bool is_dirty=true)
 Mark config as changed (processors will detect and react)
 
bool needs_default_processing () override
 Checks if the buffer should undergo default processing.
 
bool needs_depth_attachment () const
 Check if this buffer requires depth attachment for rendering.
 
bool needs_removal () const override
 Checks if the buffer should be removed from processing chains.
 
void process_default () override
 Run the buffer's default processor (if set and enabled)
 
void release_processing () override
 Release previously acquired processing lock.
 
void resize (size_t new_size, bool preserve_data=false)
 Resize buffer and recreate GPU resources if needed.
 
void set_buffer (vk::Buffer buffer)
 Set VkBuffer handle after backend allocation.
 
void set_buffer_resources (const VKBufferResources &resources)
 Set all buffer resources at once.
 
void set_data (const std::vector< Kakshya::DataVariant > &data)
 Write data into the buffer.
 
void set_default_processor (const std::shared_ptr< BufferProcessor > &processor) override
 Set the buffer's default processor.
 
void set_index_resources (vk::Buffer buf, vk::DeviceMemory mem, size_t size)
 Store raw index buffer handles produced by the geometry upload path.
 
void set_mapped_ptr (void *ptr)
 Set mapped host pointer (for host-visible allocations)
 
void set_memory (vk::DeviceMemory memory)
 Set device memory handle after backend allocation.
 
void set_modality (Kakshya::DataModality modality)
 Update the semantic modality and re-infer dimensions.
 
void set_needs_depth_attachment (bool needs)
 Mark this buffer as requiring depth testing when rendered.
 
void set_pipeline_command (RenderPipelineID pipeline_id, CommandBufferID cmd_id)
 Store recorded command buffer for a pipeline.
 
void set_pipeline_window (RenderPipelineID id, const std::shared_ptr< Core::Window > &window)
 Associate this buffer with a window for rendering.
 
void set_processing_chain (const std::shared_ptr< BufferProcessingChain > &chain, bool force=false) override
 Replace the buffer's processing chain.
 
virtual void set_render_config (const RenderConfig &config)
 Update the render configuration and mark as dirty.
 
void set_render_processor (std::shared_ptr< RenderProcessor > rp)
 
void set_vertex_layout (const Kakshya::VertexLayout &layout)
 Set vertex layout for this buffer.
 
bool try_acquire_processing () override
 Try to acquire processing lock for this buffer.
 
 VKBuffer ()=default
 
 VKBuffer (size_t size_bytes, Usage usage, Kakshya::DataModality modality=Kakshya::DataModality::VERTICES_3D)
 Construct an unregistered VKBuffer.
 
 ~VKBuffer () override
 Virtual destructor.
 
- Public Member Functions inherited from MayaFlux::Buffers::Buffer
virtual ~Buffer ()=default
 Virtual destructor for proper resource management.
 

Static Private Member Functions

static size_t worst_case_bytes (uint32_t res_x, uint32_t res_y, uint32_t res_z) noexcept
 

Private Attributes

glm::vec3 m_bounds_max
 
glm::vec3 m_bounds_min
 
std::string m_diffuse_binding { "diffuseTex" }
 
std::shared_ptr< Core::VKImagem_diffuse_texture
 
Kinesis::SpatialField m_field
 
std::shared_ptr< SDFFieldProcessorm_field_processor
 
std::string m_field_shader
 
bool m_gpu_field {}
 
float m_iso_level
 
std::shared_ptr< SDFPrepProcessorm_prep_processor
 
uint32_t m_res_x
 
uint32_t m_res_y
 
uint32_t m_res_z
 
std::shared_ptr< SDFMeshProcessorm_sdf_processor
 

Additional Inherited Members

- Public Types inherited from MayaFlux::Buffers::VKBuffer
using RenderConfig = Portal::Graphics::RenderConfig
 
enum class  Usage : uint8_t {
  STAGING , DEVICE , COMPUTE , VERTEX ,
  INDEX , UNIFORM , UNIFORM_BDA , STORAGE_BDA ,
  HOST_STORAGE
}
 
- Protected Member Functions inherited from MayaFlux::Buffers::VKBuffer
void apply_render_config (const RenderConfig &config, const ShaderConfig &shader_config)
 Configure the internal m_render_processor from a RenderConfig.
 
void apply_render_config (std::shared_ptr< RenderProcessor > &render_processor, const RenderConfig &config, const ShaderConfig &shader_config)
 Configure a RenderProcessor, creating one if null.
 
void set_default_render_config (const RenderConfig &config)
 Called by derived classes to set their context-specific defaults.
 
- Protected Attributes inherited from MayaFlux::Buffers::VKBuffer
RenderConfig m_render_config
 
bool m_render_config_dirty {}
 
std::shared_ptr< RenderProcessorm_render_processor
 

Detailed Description

VKBuffer that evaluates a SpatialField isosurface via marching cubes on the GPU and renders directly without CPU readback.

SDFMeshProcessor dispatches mc_emit.comp into this buffer each dirty frame. RenderProcessor draws from the same VKBuffer. No CPU-GPU round-trip occurs after the initial lookup table upload.

Usage:

auto buf = std::make_shared<ComputeMeshBuffer>(
make_field(), glm::vec3(-1.6F), glm::vec3(1.6F), 40, 40, 40)
buf->setup_rendering({ .target_window = window });
schedule_metro(1.0 / 60.0, [buf, make_field]() {
buf->set_field(make_field());
buf->set_dirty();
@ FRAME_ACCURATE
Coroutine is frame-accurate.
void schedule_metro(double interval_seconds, std::function< void()> callback, std::string name, Vruta::ProcessingToken token)
Creates a metronome task and addes it to the default scheduler list for evaluation.
Definition Chronie.cpp:38
static constexpr DomainSpec Graphics
Domain constant for Graphics domain.
Definition Creator.hpp:308

Definition at line 36 of file ComputeMeshBuffer.hpp.


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