Loading...
Searching...
No Matches
MayaFlux::Buffers::TextBuffer Class Reference
TextureBuffer specialization for CPU-composited glyph textures. More...
#include <TextBuffer.hpp>
Inheritance diagram for MayaFlux::Buffers::TextBuffer: Collaboration diagram for MayaFlux::Buffers::TextBuffer:Public Member Functions | |
| void | append_accumulated_text (std::string_view s) |
| void | clear_accumulated_text () |
| const std::string & | get_accumulated_text () const |
| Full accumulated text composited into this buffer since the last repress(). | |
| uint32_t | get_budget_height () const |
| Full allocated GPU texture height. | |
| uint32_t | get_budget_width () const |
| Full allocated GPU texture width. | |
| uint32_t & | get_cursor_x () |
| const uint32_t & | get_cursor_x () const |
| Horizontal pen position in pixels for the next impress() run. | |
| uint32_t & | get_cursor_y () |
| const uint32_t & | get_cursor_y () const |
| Vertical baseline position in pixels for the next impress() run. | |
| uint32_t | get_render_bounds_h () const |
| uint32_t | get_render_bounds_w () const |
| bool | has_budget () const |
| Whether this buffer was created with a pre-allocated budget exceeding the initial content dimensions. | |
| void | reset_cursor () |
| Resets the write cursor to the origin. | |
| void | set_accumulated_text (std::string_view s) |
| void | set_budget (uint32_t w, uint32_t h) |
| Sets the budget dimensions for this buffer. | |
| void | set_render_bounds (uint32_t w, uint32_t h) |
| Hard render bounds. | |
| void | setup_rendering (const RenderConfig &config) override |
| Delegates to TextureBuffer::setup_rendering, then enables streaming mode on the TextureProcessor and alpha blending on the RenderProcessor. | |
| TextureBuffer (uint32_t width, uint32_t height, Portal::Graphics::ImageFormat format, const void *initial_pixel_data=nullptr) | |
| Create texture buffer with dimensions. | |
| Public Member Functions inherited from MayaFlux::Buffers::TextureBuffer | |
| void | clear_dirty_flag () |
| Portal::Graphics::ImageFormat | get_format () const |
| std::shared_ptr< Core::VKImage > | get_gpu_texture () |
| Get the GPU texture image. | |
| std::shared_ptr< Core::VKImage > | get_gpu_texture () const |
| uint32_t | get_height () const |
| const std::vector< uint8_t > & | get_pixel_data () const |
| std::vector< uint8_t > & | get_pixel_data_mutable () |
| glm::vec2 | get_position () const |
| std::shared_ptr< RenderProcessor > | get_render_processor () const override |
| Get a RenderProcessor suitable for rendering this buffer. | |
| float | get_rotation () const |
| glm::vec2 | get_scale () const |
| std::shared_ptr< Core::VKImage > | get_texture () const |
| Get GPU texture image Suitable for binding to shaders via RenderProcessor::bind_texture() | |
| std::shared_ptr< TextureProcessor > | get_texture_processor () const |
| uint32_t | get_width () const |
| bool | has_texture () const |
| bool | is_texture_dirty () const |
| void | mark_pixels_dirty () |
| Mark pixel data as changed Use this if you modify pixel data in-place without calling set_pixel_data() | |
| void | mark_texture_dirty () |
| void | resize_texture (uint32_t new_width, uint32_t new_height) |
| Reallocate the GPU texture at new dimensions. | |
| void | set_custom_vertices (const std::vector< Nodes::TextureQuadVertex > &vertices) |
| void | set_gpu_texture (std::shared_ptr< Core::VKImage > image) |
| Inject a pre-existing GPU texture, bypassing TextureProcessor allocation. | |
| void | set_pixel_data (const void *data, size_t size) |
| Replace pixel data. | |
| void | set_position (float x, float y) |
| Set screen position (NDC or pixel coords depending on rendering setup) | |
| void | set_rotation (float angle_radians) |
| Set rotation around center. | |
| void | set_scale (float width, float height) |
| Set display size. | |
| void | setup_processors (ProcessingToken token) override |
| Setup processors with a processing token. | |
| TextureBuffer (uint32_t width, uint32_t height, Portal::Graphics::ImageFormat format, const void *initial_pixel_data=nullptr) | |
| Create texture buffer with dimensions. | |
| void | use_default_quad () |
| Reset to default fullscreen quad Uses position and scale to generate quad geometry. | |
| ~TextureBuffer () 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< 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 | 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 VKBufferResources & | get_buffer_resources () |
| Get all buffer resources at once. | |
| std::vector< Kakshya::DataVariant > | get_data () |
| Read buffer contents as Kakshya DataVariant. | |
| std::shared_ptr< Buffers::BufferProcessor > | get_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. | |
| EngineContext & | get_engine_context () |
| const EngineContext & | get_engine_context () const |
| vk::Format | get_format () const |
| Convert modality to a recommended VkFormat. | |
| 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. | |
| 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) | |
| std::shared_ptr< Core::Window > | get_pipeline_window (RenderPipelineID id) const |
| Get the window associated with this buffer. | |
| std::shared_ptr< Buffers::BufferProcessingChain > | get_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. | |
| 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::VertexLayout > | get_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_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) | |
| 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. | |
Private Attributes | |
| std::string | m_accumulated_text |
| uint32_t | m_budget_height {} |
| Allocated GPU texture height when a budget was requested. | |
| uint32_t | m_budget_width {} |
| Allocated GPU texture width when a budget was requested. | |
| uint32_t | m_cursor_x {} |
| uint32_t | m_cursor_y {} |
| uint32_t | m_render_bounds_h { 720 } |
| uint32_t | m_render_bounds_w { 1280 } |
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 } |
| 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 | |
| RenderConfig | m_render_config |
| bool | m_render_config_dirty {} |
Detailed Description
TextureBuffer specialization for CPU-composited glyph textures.
Encodes two invariants that hold for all pre-multiplied RGBA glyph coverage textures: streaming mode is enabled on the TextureProcessor to avoid per-frame staging buffer allocation under animated text, and alpha blending is enabled on the RenderProcessor so glyph coverage composites correctly over whatever is behind it.
Produced by Portal::Text::InkPress. Callers interact with it identically to TextureBuffer – set_position, set_scale, setup_rendering – with no knowledge of the invariants required.
When constructed with a budget (via Portal::Text::press overload accepting budget_width/budget_height), the GPU texture is allocated at the budget dimensions and the unused region is zero-filled (fully transparent). Subsequent Portal::Text::repress calls composite into the allocated region without reallocating unless the new content exceeds the budget and the policy is RedrawPolicy::Fit.
Prefer pre-allocating a budget and using Portal::Text::impress for incremental text updates. RedrawPolicy::Fit on every repress call reallocates the VKImage and rebuilds the descriptor on each update.
Definition at line 32 of file TextBuffer.hpp.
The documentation for this class was generated from the following files:
