Module rokol::gfx[−][src]

Expand description

Graphics (FFI)

Resource types

BakedResource implementations:

Buffer: index or vertex buffer
Image: 2D or 3D image
Pass: offscreen rendering pass
Pipeline: vertex-layouts, shader and render states
Shader: vertex and fragment shaders with shader-parameter declarations

Be sure to specify uniform names when making Shader.

Render loop

For example, for one frame with one screen rendering pass:

begin_default_pass (screen rendering pass)
- Optionally viewport and scissor
- apply_pipeline (vertex-layouts, shader and render states)
- apply_uniforms (set shader uniform block with index)
- apply_bindings (Bindings: vertex and index buffer and images, basically a mesh)
- draw
end_pass
commit

References

Sokol articles (The Brain Dump)
- A Tour of sokol_gfx.h (2017)
- A small sokol_gfx.h API update (2019)
- Sokol headers: spring 2020 update (2020)
- Upcoming Sokol header API changes (Feb 2021)
Learn OpenGL
Learn OpenGL Examples (with Sokol in C)
zig-renderkit

Structs

Pass action

Enums

Defines what action should be performed at the start of a render pass:

The source and destination factors in blending operations.

Index | Vertex

", !=, >, >=, <, <=, true, false

Front | Back | None

CCW | CW

The filtering mode when sampling a texture image

2D | 3D | Array | Cube

UInt16 | UInt32

Actions to be performed at the start of a rendering pass in begin_pass or begin_default_pass

Pixel format

Common subset of 3D primitive types supported across all 3D APIs. Field of PipelineDesc.

Update strategy of buffers and images

Float | SInt | UInt

Fs | Vs

Mat4 | Float | Float2 | Float3 | Float4

Data type of a vertex component

The texture coordinates wrapping mode when sampling a texture image

Traits

Buffer | Image | Pipeline | Pass | Shader

Functions

Appends vertices/indices to vertex/index buffer

Applies buffer Bindings: vertex/index buffer and images

Applies Pipeline: vertex-layouts, shader and render states)

Applies uniform data to shader

begin_default_pass

Screen rendering pass. Pass framebuffer size as arguments

begin_default_pass_f

Screen rendering pass. Pass framebuffer size as arguments

Offscreeen rendering pass

[Non-Sokol] Helper for creating dynamic vertex buffer

draw(base_elems, n_elems, n_instances)

[Non-Sokol] Helper for creating index buffer

ibuf_desc_immutable

[Non-Sokol] Helper for creating index buffer

Discard output fragments outside of this rectangle

Sets up sokol_gfx.h. You’d want to use glue code in this crate.

shader_desc ^⚠

[Non-Sokol] Helper for making shaders

Cleans up sokol_gfx.h

update_buffer ^⚠

Uploads vertices/indices to vertex/index buffer

update_image ^⚠

Only one update per frame is allowed for buffer and image resources

[Non-Sokol] Helper for creating dynamic vertex buffer

vbuf_desc_immutable

[Non-Sokol] Helper for creating immutable vertex buffer

Output rectangle space

Type Definitions

Vertex/index buffer and image slots

(Resource) Handle (ID) of vertex | index buffer

BufferLayoutDesc

An RGBA color value (f32)

ColorAttachmentAction

D3D11ContextDesc

DepthAttachmentAction

(Resource) Handle (ID) of image

The width and height are scaled size (e.g. if on 2x DPI monitor display with 2560x1440 pixels, give scaled size of 1280x720.

MetalContextDesc

(Resource) Handle(ID) of rendering pass

PassAttachmentDesc

(Resource) Handle (ID) of pipeline object: vertex layouts, shader and render states

PixelFormatInfo

Can be created from &[u8]

SetupContextDesc

Field of SetupDesc

setup parameters

(Resource) Handle (ID) of shader

ShaderImageDesc

ShaderStageDesc

ShaderUniformBlockDesc

ShaderUniformDesc

StencilAttachmentAction

WgpuContextDesc

Derive Macros

Implements [LayoutDesc] constructor (i.e., layout_desc method)