Crate re_renderer

Expand description

Rerun’s renderer.

A wgpu based renderer wgpu for all your visualization needs. Used in re_runner to display the contents of any view contents other than pure UI.

§Feature flags

import-obj (enabled by default) — Support importing .obj files
import-gltf (enabled by default) — Support importing .gltf and .glb files
import-stl (enabled by default) — Support importing binary & ascii .stl files
serde — Enable (de)serialization using serde.

§Draw recording overview

ViewBuilder are the main entry point for all draw operations. Each ViewBuilder represents a rectangular screen area that is composited into the target surface via ViewBuilder::composite.

A user supplies renderer::DrawDatas to the ViewBuilder. Upon submission, the ViewBuilder collects the Drawables from the QueueableDrawData and adds them to the appropriate work queues of each draw phase. Drawables map roughly 1:1 to wgpu draw calls and have a renderer::DrawData type specific payload that identifies them within their renderer::DrawData.

Depending on the DrawPhase sorting of drawables may occur: for instance DrawPhase::Transparent sorts far to near to facilitate blending, whereas other phases aggressively bundle by renderer::DrawData types to minimize state changes.

Each renderer::DrawData is associated with a single renderer::Renderer. These encapsulate the knowledge (i.e. renderpipelines etc.) of how to render a certain kind of primitive. Unlike renderer::DrawDatas, renderer::Renderers are immutable and long-lived.

Re-exports§

pub use importer::CpuMeshInstance;
pub use importer::CpuModel;
pub use importer::CpuModelMeshKey;
pub use texture_info::Texture2DBufferInfo;
pub use view_builder::RenderMode;
pub use view_builder::ViewBuilder;
pub use view_builder::ViewPickingConfiguration;

Modules§

device_caps
external
importer
mesh
renderer
resource_managers: Resource managers are concerned with mapping (typically) higher level user data to their Gpu representation.
texture_info
video
view_builder
wgpu_buffer_types: Explicitly padded and/or aligned types following wgsl rules. See wgsl spec on alignment and size

Macros§

include_file
include_shader_module: Create a shader module using the include_file! macro and set the path name as debug string.

Structs§

BindGroupDesc
BindGroupLayoutDesc
Color32: This format is used for space-efficient color representation (32 bits).
DebugLabel: Label for resources. Optimized out in release builds.
DrawPhaseManager: Manages the drawables for all active phases.
Drawable: A single drawable item within a given crate::renderer::DrawData.
DrawableCollector: Collector injected into crate::renderer::DrawData::collect_drawables in order to build up drawable list.
FileResolver: The FileResolver handles both resolving import clauses and doing the actual string interpolation.
FileServer: A noop implementation of a FileServer.
GlobalBindings: Global bindings which are always available on bind group 0 for all crate::renderer::Renderer.
GpuBindGroup: A reference-counter baked bind group.
GpuBindGroupLayoutHandle
GpuPipelineLayoutPool
GpuRenderPipelineHandle
GpuRenderPipelinePool
GpuShaderModuleHandle
GpuShaderModulePool
Hsva: Hue, saturation, value, alpha. All in the range [0, 1]. No premultiplied alpha.
ImportClause: A pre-parsed import clause, as in #import <something>.
LineBatchBuilder
LineDrawableBuilder: Builder for a vector of line strips, making it easy to create crate::renderer::LineDrawData.
LineStripBuilder
OutlineConfig
OutlineMaskPreference: What outline (if any) should be drawn.
OutlineMaskProcessor
PickingLayerId: Combination of PickingLayerObjectId and PickingLayerInstanceId.
PickingLayerInstanceId: The second 64bit of the picking layer.
PickingLayerObjectId: The first 64bit of the picking layer.
PickingLayerProcessor: Manages the rendering of the picking layer pass, its render targets & readback buffer.
PipelineLayoutDesc
PointCloudBatchBuilder
PointCloudBuilder: Builder for point clouds, making it easy to create crate::renderer::PointCloudDrawData.
QueueableDrawData: Type erased draw data that can be submitted directly to the view builder.
RectF32: A 2D rectangle with float coordinates.
RectInt: A 2D rectangle with integer coordinates.
RectTransform: Defines a transformation from a rectangular region of interest into a rectangular target region.
RenderConfig: Configures global properties of the renderer.
RenderContext: Any resource involving wgpu rendering which can be re-used across different scenes. I.e. render pipelines, resource pools, etc.
RenderPipelineDesc: Renderpipeline descriptor, can be converted into wgpu::RenderPipeline (which isn’t hashable or comparable)
RendererTypeId: Unique identifier for a Renderer type.
Rgba: 0-1 linear space RGBA color with premultiplied alpha.
Rgba32Unmul: RGBA color in sRGB gamma space, with separate/unmultiplied linear alpha.
ScreenshotProcessor
SearchPath: Specifies where to look for imports when both absolute and relative resolution fail.
ShaderModuleDesc
Size: A size of something in either scene units or ui points.
UnalignedColor32: ecolor::Color32 but without repr(align(4)), since that is not compatible with repr(packed).
VertexBufferLayout: A copy of wgpu::VertexBufferLayout with a smallvec for the attributes.
WgpuResourcePoolStatistics

Enums§

BindGroupEntry
Colormap
CpuWriteGpuReadError
DrawPhase: Determines a (very rough) order of rendering and describes the active wgpu::RenderPass.
MsaaMode: Controls MSAA (Multi-Sampling Anti-Aliasing)
RenderContextError

Traits§

FileSystem: A very limited filesystem, just enough for our internal needs.

Functions§

adapter_info_summary: A human-readable summary about an adapter
colormap_cyan_to_yellow_srgb: Returns a gamma-space sRGB in 0-255 range.
colormap_inferno_srgb: Returns sRGB polynomial approximation from Inferno color map, assuming t is normalized.
colormap_magma_srgb: Returns sRGB polynomial approximation from Magma color map, assuming t is normalized.
colormap_plasma_srgb: Returns sRGB polynomial approximation from Plasma color map, assuming t is normalized.
colormap_srgb
colormap_turbo_srgb: Returns sRGB polynomial approximation from Turbo color map, assuming t is normalized.
colormap_viridis_srgb: Returns sRGB polynomial approximation from Viridis color map, assuming t is normalized.
create_and_fill_uniform_buffer: See create_and_fill_uniform_buffer.
create_and_fill_uniform_buffer_batch: Utility for fast & efficient creation of uniform buffers from a series of structs.
get_filesystem: Returns the recommended filesystem handle for the current platform.
grayscale_srgb: Returns an sRGB gray value, assuming t is normalized.
new_recommended_file_resolver: Returns the recommended FileResolver for the current platform/target.
pad_rgb_to_rgba: Pad RGB to RGBA with the given alpha.

Type Aliases§

DepthOffset: Depth offset used to resolve z-fighting between 2D primitives.
GpuReadbackIdentifier: Identifier used to identify a buffer upon retrieval of the data.
GpuRenderPipelinePoolAccessor
RecommendedFileResolver: The recommended FileResolver type for the current platform/target.