Loading...
Searching...
No Matches
MayaFlux::Buffers::VideoContainerBuffer Class Reference
TextureBuffer implementation backed by a VideoStreamContainer. More...
#include <VideoContainerBuffer.hpp>
Inheritance diagram for MayaFlux::Buffers::VideoContainerBuffer:
Collaboration diagram for MayaFlux::Buffers::VideoContainerBuffer:
Public Member Functions | |
| VideoContainerBuffer (const std::shared_ptr< Kakshya::StreamContainer > &container, Portal::Graphics::ImageFormat format=Portal::Graphics::ImageFormat::RGBA8) | |
| Construct a VideoContainerBuffer from a video container. | |
| ~VideoContainerBuffer () override=default | |
| void | setup_processors (ProcessingToken token) override |
| Override to wire VideoStreamReader as default and TextureProcessor as preprocessor. | |
| std::shared_ptr< Kakshya::StreamContainer > | get_container () const |
| Get the backing video container. | |
| void | set_container (const std::shared_ptr< Kakshya::StreamContainer > &container) |
| Replace the backing container at runtime. | |
| std::shared_ptr< VideoStreamReader > | get_video_reader () const |
| Get the VideoStreamReader processor. | |
| Public Member Functions inherited from MayaFlux::Buffers::TextureBuffer | |
| TextureBuffer (uint32_t width, uint32_t height, Portal::Graphics::ImageFormat format, const void *initial_pixel_data=nullptr) | |
| Create texture buffer with dimensions. | |
| ~TextureBuffer () override=default | |
| uint32_t | get_width () const |
| uint32_t | get_height () const |
| Portal::Graphics::ImageFormat | get_format () const |
| std::shared_ptr< Core::VKImage > | get_texture () const |
| Get GPU texture image Suitable for binding to shaders via RenderProcessor::bind_texture() | |
| bool | has_texture () const |
| std::shared_ptr< TextureProcessor > | get_texture_processor () const |
| void | set_pixel_data (const void *data, size_t size) |
| Replace pixel data. | |
| void | mark_pixels_dirty () |
| Mark pixel data as changed Use this if you modify pixel data in-place without calling set_pixel_data() | |
| void | set_position (float x, float y) |
| Set screen position (NDC or pixel coords depending on rendering setup) | |
| void | set_scale (float width, float height) |
| Set display size. | |
| void | set_rotation (float angle_radians) |
| Set rotation around center. | |
| glm::vec2 | get_position () const |
| glm::vec2 | get_scale () const |
| float | get_rotation () const |
| void | set_custom_vertices (const std::vector< QuadVertex > &vertices) |
| void | use_default_quad () |
| Reset to default fullscreen quad Uses position and scale to generate quad geometry. | |
| const std::vector< uint8_t > & | get_pixel_data () const |
| void | mark_texture_dirty () |
| bool | is_texture_dirty () const |
| void | clear_dirty_flag () |
| void | setup_rendering (const RenderConfig &config) |
| Setup rendering with RenderProcessor. | |
| std::shared_ptr< RenderProcessor > | get_render_processor () const |
| Public Member Functions inherited from MayaFlux::Buffers::VKBuffer | |
| VKBuffer (size_t size_bytes, Usage usage, Kakshya::DataModality modality) | |
| Construct an unregistered VKBuffer. | |
| VKBuffer ()=default | |
| ~VKBuffer () override | |
| Virtual destructor. | |
| void | clear () override |
| Clear buffer contents. | |
| std::vector< Kakshya::DataVariant > | get_data () |
| Read buffer contents as Kakshya DataVariant. | |
| void | set_data (const std::vector< Kakshya::DataVariant > &data) |
| Write data into the buffer. | |
| void | resize (size_t new_size, bool preserve_data=false) |
| Resize buffer and recreate GPU resources if needed. | |
| size_t | get_size () const |
| Get current logical size in bytes. | |
| void | process_default () override |
| Run the buffer's default processor (if set and enabled) | |
| void | set_default_processor (const std::shared_ptr< BufferProcessor > &processor) override |
| Set the buffer's default processor. | |
| std::shared_ptr< Buffers::BufferProcessor > | get_default_processor () const override |
| Get the currently attached default processor. | |
| std::shared_ptr< Buffers::BufferProcessingChain > | get_processing_chain () override |
| Access the buffer's processing chain. | |
| void | set_processing_chain (const std::shared_ptr< BufferProcessingChain > &chain, bool force=false) override |
| Replace the buffer's processing chain. | |
| bool | has_data_for_cycle () const override |
| Checks if the buffer has data for the current processing cycle. | |
| bool | needs_removal () const override |
| Checks if the buffer should be removed from processing chains. | |
| 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 | enforce_default_processing (bool should_process) override |
| Controls whether the buffer should use default processing. | |
| bool | needs_default_processing () override |
| Checks if the buffer should undergo default processing. | |
| bool | try_acquire_processing () override |
| Try to acquire processing lock for this buffer. | |
| void | release_processing () override |
| Release previously acquired processing lock. | |
| bool | is_processing () const override |
| Query whether the buffer is currently being processed. | |
| vk::Buffer & | get_buffer () |
| Get VkBuffer handle (VK_NULL_HANDLE if not registered) | |
| vk::DeviceSize | get_size_bytes () const |
| vk::Format | get_format () const |
| Convert modality to a recommended VkFormat. | |
| bool | is_initialized () const |
| Check whether Vulkan handles are present (buffer registered) | |
| Kakshya::DataModality | get_modality () const |
| Get the buffer's semantic modality. | |
| const std::vector< Kakshya::DataDimension > & | get_dimensions () const |
| Get the inferred data dimensions for the buffer contents. | |
| void | set_modality (Kakshya::DataModality modality) |
| Update the semantic modality and re-infer dimensions. | |
| Usage | get_usage () const |
| Retrieve the declared usage intent. | |
| void | set_buffer (vk::Buffer buffer) |
| Set VkBuffer handle after backend allocation. | |
| void | set_memory (vk::DeviceMemory memory) |
| Set device memory handle after backend allocation. | |
| void | set_mapped_ptr (void *ptr) |
| Set mapped host pointer (for host-visible allocations) | |
| void | set_buffer_resources (const VKBufferResources &resources) |
| Set all buffer resources at once. | |
| const VKBufferResources & | get_buffer_resources () |
| Get all buffer resources at once. | |
| bool | is_host_visible () const |
| Whether this VKBuffer should be host-visible. | |
| vk::BufferUsageFlags | get_usage_flags () const |
| Get appropriate VkBufferUsageFlags for creation based on Usage. | |
| vk::MemoryPropertyFlags | get_memory_properties () const |
| Get appropriate VkMemoryPropertyFlags for allocation based on Usage. | |
| void * | get_mapped_ptr () const |
| Get mapped host pointer (nullptr if not host-visible or unmapped) | |
| void | mark_dirty_range (size_t offset, size_t size) |
| Get device memory handle. | |
| void | mark_invalid_range (size_t offset, size_t size) |
| Mark a range as invalid (needs download) | |
| 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. | |
| void | set_pipeline_window (RenderPipelineID id, const std::shared_ptr< Core::Window > &window) |
| Associate this buffer with a window for rendering. | |
| std::shared_ptr< Core::Window > | get_pipeline_window (RenderPipelineID id) const |
| Get the window associated with this buffer. | |
| bool | has_render_pipeline () const |
| Check if this buffer has a rendering pipeline configured. | |
| std::unordered_map< RenderPipelineID, std::shared_ptr< Core::Window > > | get_render_pipelines () const |
| Get all render pipelines associated with this buffer. | |
| void | set_pipeline_command (RenderPipelineID pipeline_id, CommandBufferID cmd_id) |
| Store recorded command buffer for a pipeline. | |
| CommandBufferID | get_pipeline_command (RenderPipelineID pipeline_id) const |
| Get recorded command buffer for a pipeline. | |
| void | clear_pipeline_commands () |
| Clear all recorded commands (called after presentation) | |
| void | set_vertex_layout (const Kakshya::VertexLayout &layout) |
| Set vertex layout for this buffer. | |
| std::optional< Kakshya::VertexLayout > | get_vertex_layout () const |
| Get vertex layout if set. | |
| bool | has_vertex_layout () const |
| Check if this buffer has vertex layout configured. | |
| void | clear_vertex_layout () |
| Clear vertex layout. | |
| std::shared_ptr< Buffer > | clone_to (uint8_t dest_desc) override |
| Creates a clone of this buffer for a specific channel or usage enum. | |
| std::shared_ptr< VKBuffer > | clone_to (Usage usage) |
| Create a clone of this buffer with the same data and properties. | |
| void | force_internal_usage (bool internal) override |
| Set whether this buffer is for internal engine usage. | |
| bool | is_internal_only () const override |
| Check whether this buffer is for internal engine usage. | |
| PipelineContext & | get_pipeline_context () |
| Access the pipeline context for custom metadata (non-const) | |
| const PipelineContext & | get_pipeline_context () const |
| Access the pipeline context for custom metadata (const) | |
| virtual void | mark_render_config_dirty (bool is_dirty=true) |
| Mark config as changed (processors will detect and react) | |
| bool | is_render_config_dirty () const |
| Check if config has changed since last frame. | |
| RenderConfig | get_render_config () const |
| Get the current render configuration. | |
| virtual void | set_render_config (const RenderConfig &config) |
| Update the render configuration and mark as dirty. | |
| Public Member Functions inherited from MayaFlux::Buffers::Buffer | |
| virtual | ~Buffer ()=default |
| Virtual destructor for proper resource management. | |
Private Attributes | |
| std::shared_ptr< Kakshya::StreamContainer > | m_container |
| std::shared_ptr< VideoStreamReader > | m_video_reader |
Additional Inherited Members | |
| Public Types inherited from MayaFlux::Buffers::VKBuffer | |
| enum class | Usage : uint8_t { STAGING , DEVICE , COMPUTE , VERTEX , INDEX , UNIFORM } |
| using | RenderConfig = Portal::Graphics::RenderConfig |
| Protected Member Functions inherited from MayaFlux::Buffers::TextureBuffer | |
| void | set_texture_processor (const std::shared_ptr< TextureProcessor > &processor) |
| Allow inherited classes to set the TextureProcessor directly. | |
| Protected Member Functions inherited from MayaFlux::Buffers::VKBuffer | |
| 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 | |
| bool | m_render_config_dirty {} |
| RenderConfig | m_render_config |
Detailed Description
TextureBuffer implementation backed by a VideoStreamContainer.
VideoContainerBuffer is the video counterpart of SoundContainerBuffer. It bridges the Kakshya container system and the Vulkan rendering pipeline by wiring a VideoStreamReader as the default processor and repositioning the inherited TextureProcessor as the chain preprocessor.
Execution order per frame cycle (via process_complete):
- Default processor → VideoStreamReader pulls frame from container, writes RGBA pixels into TextureBuffer via set_pixel_data(), marks texture dirty.
- Preprocessor → TextureProcessor detects dirty flag, uploads pixels to GPU VKImage, updates quad geometry.
- Chain processors → User-added effects, compute shaders, etc.
- Postprocessor → (available for user)
- Final processor → RenderProcessor draws textured quad to window.
This mirrors the audio pipeline exactly:
Audio: SoundStreamContainer → ContiguousAccessProcessor → SoundStreamReader → AudioBuffer → speakers
Video: VideoStreamContainer → FrameAccessProcessor → VideoStreamReader → VideoContainerBuffer → TextureProcessor → RenderProcessor → window
The buffer inherits all TextureBuffer capabilities: pixel storage with dirty tracking, quad geometry with transform support, GPU texture access, and RenderProcessor integration via setup_rendering().
Definition at line 162 of file VideoContainerBuffer.hpp.
The documentation for this class was generated from the following files:
