render_context

Structs

`AlphaMaskPaint`

Vector paint used to construct a surface-local alpha mask.

Properties

`Color`

Linear RGBA color used by the low-level renderer.

Implementations

`hlca`

pub fn hlca(h: f32, l: f32, c: f32, a: f32) -> Self

Construct a color from HLC/Lab-style components plus alpha.

`hsva`

pub fn hsva(h: f32, s: f32, v: f32, a: f32) -> Self

Construct a color from HSV plus alpha, with hue normalized to 0.0-1.0.

`rgba`

pub fn rgba(r: f32, g: f32, b: f32, a: f32) -> Self

Construct a color from linear RGBA channels in the range 0.0-1.0.

`DrawRange`

Normalized visible range for a stroked vector path.

`GradientStop`

One color stop in a GPU gradient fill.

`Material`

Light-reactive material coefficients for a tessellated vector path.

Properties

`ResourceChurnStats`

Resource churn counters for renderer profiling. Effect counters are available with the opt-in shaders Cargo feature.

Properties

`effect_pipeline_compilations`

Type: u64

`mesh_texture_bytes`

Type: u64

Bytes allocated for mesh textures during this sample (not current residency).

`mesh_coefficient_upload_bytes`

Type: u64

`vector_geometry_cache_misses`

Type: u64

`vector_geometry_cache_evictions`

Type: u64

`vector_resource_create_bytes`

Type: u64

`vector_resource_update_bytes`

Type: u64

`vector_resource_cache_misses`

Type: u64

`vector_resource_cache_evictions`

Type: u64

`texture_cache_hits`

Type: u64

Tile-local bindings created using an already resident sibling image texture.

`SceneLight`

A resolved scene light for the low-level renderer.

Properties

`SceneLighting`

Resolved lighting state for one retained vector scene.

Properties

`Stroke`

Stroke style for a tessellated vector path.

Properties

`WgpuRenderer`

Retained scene renderer that records Pax vector/image commands and flushes them through wgpu.

Transform and clip identities remain stable until their owning node releases them. GPU uniform pages grow with scene demand; the 480-entry page size is not a scene limit. Moving or fading retained geometry updates transform pages without retessellating or uploading vertex/index buffers.

Implementations

`begin_shader_effect`

pub fn begin_shader_effect(&mut self, id: u32, z: i32, effect: &ShaderEffect, transform: Transform2D, size: (f64, f64), scopes: &[OpacityScope], children: &[u32]) -> bool

Start a GPU-only filter boundary. A true return requests an initial source replay. Available with the opt-in shaders Cargo feature.

`end_shader_effect`

pub fn end_shader_effect(&mut self)

Finish the GPU-only filter boundary. Requires the shaders Cargo feature.

`begin_alpha_source`

pub fn begin_alpha_source(&mut self, mapping: Transform2D, feather: f32)

Records a detached source in the current mask owner's surface coordinates. Source clips and opacity are independent of the consuming content; its enclosing mask is applied afterward.

`end_alpha_source`

pub fn end_alpha_source(&mut self)

Restores the consumer and installs a reference to the source's retained alpha texture.

`clip_alpha`

pub fn clip_alpha(&mut self, paints: Vec<AlphaMaskPaint>, feather: f32)

Installs a painted alpha mask in the current save/restore scope.

`current_transform`

pub fn current_transform(&self) -> Transform2D

Current transform at the top of the render-state stack.

`draw_image`

pub fn draw_image(&mut self, image_key: &str, image_version: u64, image: &Image, rect: Box2D)

Image identity and version must identify the same pixels across renderers sharing a GPU context. Change the version when replacing image content.

`draw_image_with_opacity`

pub fn draw_image_with_opacity(&mut self, image_key: &str, image_version: u64, image: &Image, rect: Box2D, opacity: f32)

Multiplies source pixel alpha by opacity without reuploading the texture. Sibling tiles share resident image pixels, but keep their own draw bindings. Identity/version follows the same contract as [Self::draw_image].

`fill_path`

pub fn fill_path(&mut self, path: Path, fill: Fill)

Queue a filled vector path into the current retained node.

`fill_path_with_material_and_opacity`

pub fn fill_path_with_material_and_opacity(&mut self, path: Path, fill: Fill, material: Material, opacity: f32)

Queue a filled vector path with material response and an extra opacity multiplier.

`fill_path_with_material_and_opacity_and_smoothing`

pub fn fill_path_with_material_and_opacity_and_smoothing(&mut self, path: Path, fill: Fill, material: Material, opacity: f32, smoothing: PathSmoothing)

Queue a filled vector path with material response, opacity, and optional smoothing.

`fill_path_with_opacity`

pub fn fill_path_with_opacity(&mut self, path: Path, fill: Fill, opacity: f32)

Queue a filled vector path with an extra opacity multiplier.

`new`

pub fn new(render_backend: RenderBackend<'w>) -> Self

Create a retained renderer around a low-level RenderBackend.

`reset_retained_scene`

pub fn reset_retained_scene(&mut self)

Drop retained scene state for a surface that has been rebound to a new tile origin.

`set_node_opacity_scopes`

pub fn set_node_opacity_scopes(&mut self, node_id: u32, scopes: &[OpacityScope])

Updates group presentation without changing a node's paint or image resources.

`set_scene_lighting`

pub fn set_scene_lighting(&mut self, lighting: SceneLighting) -> bool

Upload changed surface-local lighting, returning whether retained pixels need redraw. Only lights used by this surface's lit vector draws invalidate its contents. Repeating the same value does not upload a uniform or dirty the scene. Each new renderer receives its own initial upload, even for default lighting.

`set_surface_transform`

pub fn set_surface_transform(&mut self, transform: Transform2D)

Set the base transform for the physical surface tile being rendered.

`share_vector_caches_from`

pub fn share_vector_caches_from(&mut self, other: &Self)

Share vector resource caches with another renderer for the same logical layer.

`shared_gpu_context`

pub fn shared_gpu_context(&self) -> SharedGpuContext

Reuse this logical layer's GPU context when creating another physical tile. The returned handle keeps the device and pipelines alive, not this tile's surface or scene.

`stroke_path`

pub fn stroke_path(&mut self, path: Path, stroke: Stroke)

Queue a stroked vector path into the current retained node.

`stroke_path_with_draw_range_and_material_and_opacity`

pub fn stroke_path_with_draw_range_and_material_and_opacity(&mut self, path: Path, stroke: Stroke, material: Material, opacity: f32, draw_range: DrawRange)

Queue a draw-ranged stroked vector path with material response and an extra opacity multiplier.

`stroke_path_with_draw_range_and_material_and_opacity_and_smoothing`

pub fn stroke_path_with_draw_range_and_material_and_opacity_and_smoothing(&mut self, path: Path, stroke: Stroke, material: Material, opacity: f32, draw_range: DrawRange, smoothing: PathSmoothing)

Queue a draw-ranged stroked vector path with material response, opacity, and optional smoothing.

`stroke_path_with_material_and_opacity`

pub fn stroke_path_with_material_and_opacity(&mut self, path: Path, stroke: Stroke, material: Material, opacity: f32)

Queue a stroked vector path with material response and an extra opacity multiplier.

`stroke_path_with_material_and_opacity_and_smoothing`

pub fn stroke_path_with_material_and_opacity_and_smoothing(&mut self, path: Path, stroke: Stroke, material: Material, opacity: f32, smoothing: PathSmoothing)

Queue a stroked vector path with material response, opacity, and optional smoothing.

`stroke_path_with_opacity`

pub fn stroke_path_with_opacity(&mut self, path: Path, stroke: Stroke, opacity: f32)

Queue a stroked vector path with an extra opacity multiplier.

`take_resource_churn_stats`

pub fn take_resource_churn_stats(&mut self) -> ResourceChurnStats

Return and reset accumulated resource churn counters.

Enums

`Fill`

Fill style for a tessellated vector path.

Variants

`Mesh` { `rows`: `Vec`<`Vec`<([`f32`; 2], `Color`)>>, `pos`: `Point2D`, `main_axis`: `Vector2D`, `off_axis`: `Vector2D` }

Row-connected mesh in normalized paint coordinates. The axes map that domain to scene coordinates; row order fixes connectivity independently of each anchor's x/y position.

`Blend`(`Vec`<(`Fill`, `f32`)>)

Weighted premultiplied paint mixture, sampled before compositing.

`Solid`(`Color`)

`Gradient` { `gradient_type`: `GradientType`, `pos`: `Point2D`, `main_axis`: `Vector2D`, `off_axis`: `Vector2D`, `stops`: `Vec`<`GradientStop`> }

`Radial`

Unit outer circle centered at pos, mapped by main_axis/off_axis. Stops are normalized (0..1); the focal point is in that unit circle's space.

Pax Docs

Mesh { rows: Vec<Vec<([f32; 2], Color)>>, pos: Point2D, main_axis: Vector2D, off_axis: Vector2D }

Blend(Vec<(Fill, f32)>)

Solid(Color)

Gradient { gradient_type: GradientType, pos: Point2D, main_axis: Vector2D, off_axis: Vector2D, stops: Vec<GradientStop> }

Radial

`Mesh` { `rows`: `Vec`<`Vec`<([`f32`; 2], `Color`)>>, `pos`: `Point2D`, `main_axis`: `Vector2D`, `off_axis`: `Vector2D` }

`Blend`(`Vec`<(`Fill`, `f32`)>)

`Solid`(`Color`)

`Gradient` { `gradient_type`: `GradientType`, `pos`: `Point2D`, `main_axis`: `Vector2D`, `off_axis`: `Vector2D`, `stops`: `Vec`<`GradientStop`> }

`Radial`