Crate rend3

Easy to use, customizable, efficient 3D renderer library built on wgpu.

Library is under active development. While internals will likely change quite a bit, the external api will only experience minor changes as features are added.

To use rend3 add the following to your Cargo.toml:

rend3 = "0.1.0"

Screenshots

Examples

Take a look at the examples getting started with the api.

Purpose

rend3 tries to fulfill the following usecases:

1. Games and visualizations that need a customizable and efficient renderer.
2. Small projects that just want to put objects on screen, but want lighting and effects.
3. A small cog in a big machine: a renderer doesn’t interfere with the rest of the program.

rend3 is not:

1. A renderer for insane production value AAA games. AAA games have requirements far beyond any possible indie game and would be unreasonable to target.
2. A framework or engine. It does not include all the parts needed to make an advanced game or simulation nor care how you structure your program. I do have plans for a rend3-util (or similar) crate that is a very basic framework for the second use case listed above.

GPU Mode

On Vulkan and DX12, we can enable “gpu mode”, which uses modern bindless resources and gpu-based culling. This reduces CPU load and allows sigifigantly more powerful culling.

Future Plans

I have grand plans for this library. An overview can be found in the issue tracker under the enhancement label.

Helping Out

We welcome all contributions and ideas. If you want to participate or have ideas for this library, we’d love to hear them!

Modules

resources

Managers for various type of resources.

types

Reexport of rend3_types with some added wgpu re-exports.

util

Utilities and isolated bits of functionality that need a home.

Macros

format_sso

Similar to the format macro, but creates a SsoString.

Structs

InstanceAdapterDevice

Container for Instance/Adapter/Device/Queue etc.

PotentialAdapter

Validated set of features and limits for a given T.

Renderer

Core struct which contains the renderer world. Primary way to interact with the world.

Enums

LimitType

Enum mapping to each of a device’s limit.

ModeData

Stores two different types of data depending on the renderer mode.

RendererInitializationError

Reason why the renderer failed to initialize.

RendererMode

Determines if a more-compatible CPU driven rendering, or faster GPU driven rendering.

Constants

CPU_REQUIRED_FEATURES

Features required to run in cpu-mode.

CPU_REQUIRED_LIMITS

Limits required to run in cpu-mode.

GPU_REQUIRED_FEATURES

Features required to run in gpu-mode.

GPU_REQUIRED_LIMITS

Limits required to run in gpu-mode.

INTERNAL_SHADOW_DEPTH_FORMAT

Format of all shadow maps.

MAX_UNIFORM_BUFFER_BINDING_SIZE

Largest uniform buffer binding needed to run rend3.

OPTIONAL_FEATURES

Features that rend3 can use if it they are available, but we don’t require.

SHADOW_DIMENSIONS

Resolution of all shadow maps.

Traits

RenderRoutine

Routine which renders the current state of the renderer. The rend3-pbr crate offers a PBR, clustered-forward implementation of the render routine.

Functions

check_features

Check that all required features for a given mode are present in the feature set given.

check_limits

Check that all required limits for a given mode are present in the given limit set.

configure_surface

Convinence function that re-configures the surface with the expected usages.

create_iad

Creates an Instance/Adapter/Device/Queue using the given choices. Tries to get the best combination.