Crate re_renderer

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

• arrow — Support for Arrow datatypes for end-to-end zero-copy.
• 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.

Re-exports

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

Modules

• allocator 🔒
  High level GPU memory allocators.
• color 🔒
• colormap 🔒
• config
• context 🔒
• debug_label 🔒
• depth_offset 🔒
• draw_phases 🔒
• error_handling 🔒
• external
• file_resolver 🔒
  This module implements one half of our cross-platform #import system.
• file_server 🔒
• file_system 🔒
• global_bindings 🔒
• importer
• line_drawable_builder 🔒
• mesh
• point_cloud_builder 🔒
• queueable_draw_data 🔒
• rect 🔒
• renderer
• resource_managers
  Resource managers are concerned with mapping (typically) higher level user data to their Gpu representation.
• size 🔒
• texture_info
• transform 🔒
  Transformation utilities.
• video
• view_builder
• wgpu_buffer_types 🔒
  Explicitly padded and/or aligned types following wgsl rules. See wgsl spec on alignment and size
• wgpu_resources 🔒
  Wgpu resource pools are concerned with handling low level gpu resources efficiently.

Macros

• include_file
  A macro to read the contents of a file on disk, and resolve #import clauses as required.
• include_shader_module
  Create a shader module using the include_file! macro and set the path name as debug string.

Structs

• Color32
  This format is used for space-efficient color representation (32 bits).
• DebugLabel
  Label for resources. Optimized out in release builds.
• FileResolver
  The FileResolver handles both resolving import clauses and doing the actual string interpolation.
• FileServer
  A file server capable of watching filesystem events in the background and resolve #import clauses in files.
• Hsva
  Hue, saturation, value, alpha. All in the range [0, 1]. No premultiplied alpha.
• ImportClause
  A pre-parsed import clause, as in #import <something>.
• 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.
• 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.
• 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.
• RenderContext
  Any resource involving wgpu rendering which can be re-used across different scenes. I.e. render pipelines, resource pools, etc.
• 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.
• Size
  A size of something in either scene units or ui points.
• WgpuResourcePoolStatistics

Enums

• Colormap
• CpuWriteGpuReadError
• 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. This is a perceptually uniform colormap which is robust to color blindness. It is especially suited for visualizing signed values. It interpolates from cyan to blue to dark gray to brass to yellow.
• 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.
• 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

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