48 releases

0.17.1 Jan 3, 2018
0.17.0 Dec 30, 2017
0.16.3 Jan 3, 2018
0.16.2 Dec 6, 2017
0.2.4 Mar 14, 2015

#8 in Graphics APIs

Download history 966/week @ 2018-05-27 1875/week @ 2018-06-03 1766/week @ 2018-06-10 1514/week @ 2018-06-17 990/week @ 2018-06-24 1669/week @ 2018-07-01 1098/week @ 2018-07-08 1267/week @ 2018-07-15 956/week @ 2018-07-22 970/week @ 2018-07-29 1505/week @ 2018-08-05 1403/week @ 2018-08-12 1276/week @ 2018-08-19

5,377 downloads per month
Used in 94 crates (54 directly)

Apache-2.0

279KB
5.5K SLoC


lib.rs:

gfx

An efficient, low-level, bindless graphics API for Rust.

Overview

Command buffers and encoders

A command buffer is a serialized list of drawing and compute commands. Unlike with vulkan, command buffers are not what you use to create commands, but only the result of creating these commands. Gfx, borrowing metal's terminology, uses encoders to build command buffers. This means that, in general, users of the gfx crate don't manipulate command buffers directly much and interact mostly with encoders.

Manipulating an Encoder in gfx corresponds to interacting with:

  • a VkCommandBuffer in vulkan,
  • a MTLCommandEncoder in metal,
  • an ID3D12GraphicsCommandList in D3D12.

OpenGL and earlier versions of D3D don't have an explicit notion of command buffers or encoders (with the exception of draw indirect commands in late versions of OpenGL, which can be seen as a GPU-side command buffer). They are managed implicitly by the driver.

See:

Factory

The factory is what lets you allocate GPU resources such as buffers and textures.

Each gfx backend provides its own factory type which implements both:

gfx::Factory is roughly equivalent to:

  • VkDevice in vulkan,
  • ID3D11Device in D3D11,
  • MTLDevice in metal.

OpenGL does not have a notion of factory (resources are created directly off of the global context). D3D11 has a DXGI factory but it is only used to interface with other processes and the window manager, resources like textures are usually created using the device.

Device

See the gfx::Device trait.

Pipeline state (PSO)

See the documentation of the gfx::pso module.

Memory management

Handles internally use atomically reference counted pointers to deal with memory management. GPU resources are not destroyed right away when all references to them are gone. Instead they are destroyed the next time Device::cleanup is called.

Examples

See the examples in the repository.

Useful resources

Dependencies

~1MB
~23K SLoC