A powerful graphics library based on Sokol GFX, written in C99. More...

#include "sokol_gfx.h"
#include <stdbool.h>
#include <stddef.h>

Include dependency graph for pico_gfx.h:

Classes
struct	pg_blend_mode_t
	Blend mode. More...

struct	pg_vertex_buf_t
	Vertex buffer description. More...

struct	pg_vertex_attr_t
	Vertex attribute description. More...

struct	pg_pipeline_layout_t
	Pipeline layout. More...

struct	pg_pipeline_opts_t
	Pipeline creation options. More...

struct	pg_texture_opts_t
	Texture creation options. More...

struct	pg_sampler_opts_t
	Sampler options. More...

struct	pg_shader_internal_t

Macros
#define	PG_MAX_VERTEX_ATTRIBUTES SG_MAX_VERTEX_ATTRIBUTES

#define	PG_MAX_VERTEX_BUFFERS SG_MAX_VERTEXBUFFER_BINDSLOTS

#define	PG_MAX_TEXTURE_SLOTS SG_MAX_IMAGE_BINDSLOTS

#define	PG_MAX_SAMPLER_SLOTS SG_MAX_SAMPLER_BINDSLOTS

#define	pg_create_shader(ctx, prefix)
	Creates the shader with the given prefix The prefix should refer to the shader program name in a shader compiled by `sokol-shdc`. For example the sprite shader in the examples would have the prefix 'shader' (without quotation marks)

Typedefs
typedef struct pg_ctx_t	pg_ctx_t
	Contains core data/state for an instance of the graphics library.

typedef struct pg_pipeline_t	pg_pipeline_t
	Render state information.

typedef struct pg_shader_t	pg_shader_t
	Vertex/fragment shader program.

typedef struct pg_texture_t	pg_texture_t
	Represents an image or render target in VRAM.

typedef struct pg_sampler_t	pg_sampler_t
	Represents sampler.

typedef struct pg_buffer_t	pg_buffer_t
	A vertex or index array buffer.

typedef struct pg_pipeline_opts_t	pg_pipeline_opts_t
	Pipeline creation options.

typedef struct pg_texture_opts_t	pg_texture_opts_t
	Texture creation options.

Enumerations
enum	pg_backend_t { PG_BACKEND_GL , PG_BACKEND_GLES , PG_BACKEND_D3D , PG_BACKEND_METAL , PG_BACKEND_WGPU }
	Graphics backends. More...

enum	pg_primitive_t { PG_DEFAULT_PRIMITIVE , PG_POINTS , PG_LINES , PG_LINE_STRIP , PG_TRIANGLES , PG_TRIANGLE_STRIP }
	Drawing primitives. More...

enum	pg_blend_factor_t { PG_DEFAULT_BLEND_FACTOR , PG_ZERO , PG_ONE , PG_SRC_COLOR , PG_ONE_MINUS_SRC_COLOR , PG_DST_COLOR , PG_ONE_MINUS_DST_COLOR , PG_SRC_ALPHA , PG_ONE_MINUS_SRC_ALPHA , PG_DST_ALPHA , PG_ONE_MINUS_DST_ALPHA }
	Blend factors. More...

enum	pg_blend_eq_t { PG_DEFAULT_BLEND_EQ , PG_ADD , PG_SUBTRACT , PG_REVERSE_SUBTRACT }
	Blend equations. More...

enum	pg_vertex_format_t { PG_VERTEX_FORMAT_INVALID , PG_VERTEX_FORMAT_FLOAT , PG_VERTEX_FORMAT_FLOAT2 , PG_VERTEX_FORMAT_FLOAT3 , PG_VERTEX_FORMAT_FLOAT4 , PG_VERTEX_FORMAT_BYTE4 , PG_VERTEX_FORMAT_BYTE4N , PG_VERTEX_FORMAT_UBYTE4 , PG_VERTEX_FORMAT_UBYTE4N , PG_VERTEX_FORMAT_SHORT2 , PG_VERTEX_FORMAT_SHORT2N , PG_VERTEX_FORMAT_USHORT2N , PG_VERTEX_FORMAT_SHORT4 , PG_VERTEX_FORMAT_SHORT4N , PG_VERTEX_FORMAT_USHORT4N , PG_VERTEX_FORMAT_UINT10_N2 , PG_VERTEX_FORMAT_HALF2 , PG_VERTEX_FORMAT_HALF4 }
	Vertex attribute pixel formats. More...

enum	pg_buffer_usage_t { PG_USAGE_STATIC , PG_USAGE_DYNAMIC , PG_USAGE_STREAM }
	Buffer update criteria. More...

Functions
void	pg_init (void)
	Loads pico_gfx and sokol_gfx.

void	pg_shutdown (void)
	Tears down pico_gfx and sokol_gfx.

pg_ctx_t *	pg_create_context (int window_width, int window_height, void *mem_ctx)
	Creates a graphics context.

void	pg_destroy_context (pg_ctx_t *ctx)
	Destroys a graphics context.

pg_backend_t	pg_backend (void)
	Returns the backend in use at runtime.

void	pg_set_window_size (pg_ctx_t *ctx, int width, int height, bool reset)
	Sets the window dimensions.

void	pg_get_window_size (pg_ctx_t ctx, int width, int *height)
	Gets the window size.

void	pg_begin_pass (pg_ctx_t ctx, pg_texture_t target, bool clear)
	Starts a render pass (mandatory)

void	pg_end_pass (pg_ctx_t *ctx)
	Ends a render pass (mandatory)

void	pg_flush (pg_ctx_t *ctx)
	Flush commands.

void	pg_push_state (pg_ctx_t *ctx)
	Pushes the active state onto the stack.

void	pg_pop_state (pg_ctx_t *ctx)
	Pops a state off the stack and makes it the active state.

void	pg_set_clear_color (pg_ctx_t *ctx, float r, float g, float b, float a)
	Sets the clear color state to be placed at the top of the state stack.

void	pg_reset_clear_color (pg_ctx_t *ctx)

void	pg_set_viewport (pg_ctx_t *ctx, int x, int y, int w, int h)
	Sets the viewport state to be placed at the top of the state stack.

void	pg_reset_viewport (pg_ctx_t *ctx)

void	pg_set_scissor (pg_ctx_t *ctx, int x, int y, int w, int h)
	Sets the scissor state to be placed at the top of the state stack.

void	pg_reset_scissor (pg_ctx_t *ctx)

void	pg_set_pipeline (pg_ctx_t ctx, pg_pipeline_t pipeline)
	Sets the pipeline state.

void	pg_reset_pipeline (pg_ctx_t *ctx)

void	pg_bind_buffer (pg_ctx_t ctx, int slot, pg_buffer_t buffer)
	Binds a buffer to the specified slot.

void	pg_reset_buffers (pg_ctx_t *ctx)
	Clears buffer bindings.

void	pg_set_index_buffer (pg_ctx_t ctx, pg_buffer_t buffer)
	Sets the active index buffer.

void	pg_reset_index_buffer (pg_ctx_t *ctx)
	Disables indexed rednering.

void	pg_bind_texture (pg_shader_t shader, const char name, pg_texture_t *texture)
	Binds a texture to a slot in the current state.

void	pg_reset_textures (pg_shader_t *shader)
	Resets the texture bindings for the current state.

void	pg_bind_sampler (pg_shader_t shader, const char name, pg_sampler_t *sampler)
	Binds a sampler to a slot in the current state.

void	pg_reset_samplers (pg_shader_t *shader)
	Resets the sampler bindings for the current state.

void	pg_reset_state (pg_ctx_t *ctx)
	Resets the active state to defaults.

void	pg_destroy_shader (pg_shader_t *shader)
	Destroys a shader.

uint32_t	pg_get_shader_id (const pg_shader_t *shader)
	Returns a shader ID.

void	pg_set_uniform_block (pg_shader_t shader, const char name, const void *data)
	Sets a uniform block (UB)

pg_pipeline_t *	pg_create_pipeline (pg_ctx_t ctx, pg_shader_t shader, const pg_pipeline_opts_t *opts)
	Creates a rendering pipeline (encapsulates render state)

void	pg_destroy_pipeline (pg_pipeline_t *pipeline)
	Destroys a render pipeline.

pg_shader_t *	pg_get_shader (const pg_pipeline_t *pipeline)
	Returns the shader associated with the pipeline.

const pg_blend_mode_t *	pg_get_blend_mode (const pg_pipeline_t *pipeline)
	Returns the blend mode associated with the pipeline.

pg_texture_t *	pg_create_texture (pg_ctx_t ctx, int width, int height, const uint8_t data, size_t size, const pg_texture_opts_t *opts)
	Creates a texture from an RGBA8 image.

pg_texture_t *	pg_create_render_texture (pg_ctx_t ctx, int width, int height, const pg_texture_opts_t opts)
	Creates a render target.

void	pg_destroy_texture (pg_texture_t *texture)
	Destroys a texture.

uint32_t	pg_get_texture_id (const pg_texture_t *texture)
	Returns a texture ID.

void	pg_get_texture_size (const pg_texture_t texture, int width, int *height)
	Gets a texture's dimensions.

void	pg_update_texture (pg_texture_t texture, char data, int width, int height)
	Updates a texture with the given data. This can only be called once per frame.

pg_sampler_t *	pg_create_sampler (pg_ctx_t ctx, const pg_sampler_opts_t opts)
	Creates a sampler represents an object that can control how shaders transform and filter texture resource data.

void	pg_destroy_sampler (pg_sampler_t *sampler)
	Destroys a sampler object.

pg_buffer_t *	pg_create_vertex_buffer (pg_ctx_t ctx, pg_buffer_usage_t usage, const void data, size_t count, size_t max_elements, size_t element_size)
	Creates a vertex buffer.

pg_buffer_t *	pg_create_index_buffer (pg_ctx_t ctx, pg_buffer_usage_t usage, const void data, size_t count, size_t max_elements)
	Creates a vertex buffer.

void	pg_destroy_buffer (pg_buffer_t *buffer)
	Destroys a vertex or index buffer.

void	pg_update_buffer (pg_buffer_t buffer, void data, size_t count)

int	pg_append_buffer (pg_buffer_t buffer, void data, size_t count)
	Appends data to a buffer. This can happen more than once per frame, and cannot happen after an update.

int	pg_get_buffer_offset (pg_buffer_t *buffer)
	Returns the buffer offset.

void	pg_set_buffer_offset (pg_buffer_t *buffer, int offset)
	Sets the buffer offset.

void	pg_reset_buffer (pg_buffer_t *buffer)
	Destroys and recreates buffer.

void	pg_draw (const pg_ctx_t *ctx, size_t start, size_t count, size_t instances)
	Draws from the buffers that are bound to the current state.

pg_shader_t *	pg_create_shader_internal (pg_ctx_t *ctx, pg_shader_internal_t internal)

Detailed Description

A powerful graphics library based on Sokol GFX, written in C99.

Licensing information at end of header

Compatibility

This library is compatible with the sokol_gfx header file: https://github.com/empyreanx/pico_headers/blob/main/examples_pico_gfx/sokol_gfx.h

pico_gfx may not reflect current revisions in the https://github.com/floooh/sokol repository.

Features:

Written in C99
Two header library for easy build system integration
Easy to use low-level constructs (buffers, render passes, pipelines, and samplers)
Flexible pipeline configuration
Simple state management system (state stack)
Render to texture
Custom shaders via the sokol shader compiler
Simple and concise API
Permissive license (zlib or public domain)

Summary:

pico_gfx is a thin wrapper for sokol_gfx, a low-level graphics library that supports OpenGL, Metal, D3D, and WebGPU. pico_gfx is designed make the common case intuitive and convenient. It provides access to low-level constructs, such as buffers, render passes and pipelines, in a way that is easy to use and understand.

pico_gfx comes with three examples; basic quad rendering (to a render texture and the screen), a scene graph demo, and a particle system demo. These are the best source of information regadring how to use the API.

In constrast with earlier versions, pico_gfx no longer includes a default shader or pipeline. This was a hard decision to make, but the header is less cluttered, and more generic. It is also hard to define what default really means. Pipeline layouts must now be specified explicitly. The examples demonstrate several ways of doing this.

Shaders must be compiled with the sokol compiler (sokol-shdc). Binary versions of which can be found here. The source code for the compiler can be found here. An example of how to use the compiler can be found in the build_pico_gfx_shader directory. There are also two compiled shaders included with the examples that are more or less generic for rendering sprites and particles.

One thing pico_gfx does not support (and neither does sokol_gfx) is window and graphics context creation. See here for some examples. It is worth mentioning that SDL2 can supply both a window and OpenGL context out of the box. SDL2 is used in the demos.

Another library that supports window/context creation on all supported backends is sokol_app, but it has yet to be tested with pico_gfx.

The state that pico_gfx manages includes:

- Pipelines/shaders
- Uniform blocks
- Vertex buffers
- Index buffers
- Clear color
- Viewport
- Scissor
- Textures
- Samplers

Most changes to the state can be isolated by using the state stack (pg_push_state/pg_pop_state). Simply push the current state onto the stack, make some local changes, and then pop the stack to restore the original state. The exceptions are textures and samplers that are shader state and not global state.

Shaders expose uniforms in blocks.They may then be set by calling pg_set_uniform_block. This functions operate on structs supplied by a compiled shader,

Please see the examples for more details.

C++

In this iteration, pico_gfx is a C only library. Proper C++ compatibility may be introduced in the future.

Build:

To use this library in your project, add

‍#define PICO_GFX_IMPLEMENTATION #include "pico_gfx.h"

to a source file.

IMPORTANT: sokol_gfx.h must be in the include path!

You must also define one of

#define PICO_GFX_GL #define PICO_GFX_GLES #define PICO_GFX_D3D #define PICO_GFX_METAL #define PICO_GFX_WEBGPU

before including pico_gfx.h

See the examples for build details.

Constants:

PICO_GFX_HASHTABLE_KEY_SIZE (default: 16)
PICO_GFX_STACK_MAX_SIZE (default: 16)

Customization:

NDEBUG
PICO_GFX_ASSERT
PICO_GFX_LOG
PICO_GFX_MALLOC
PICO_GFX_REALLOC
PICO_GFX_FREE

The above (constants/macros) must be defined before PICO_GFX_IMPLEMENTATION

Macro Definition Documentation

◆ PG_MAX_VERTEX_ATTRIBUTES

#define PG_MAX_VERTEX_ATTRIBUTES SG_MAX_VERTEX_ATTRIBUTES

◆ PG_MAX_VERTEX_BUFFERS

#define PG_MAX_VERTEX_BUFFERS SG_MAX_VERTEXBUFFER_BINDSLOTS

◆ PG_MAX_TEXTURE_SLOTS

#define PG_MAX_TEXTURE_SLOTS SG_MAX_IMAGE_BINDSLOTS

◆ PG_MAX_SAMPLER_SLOTS

#define PG_MAX_SAMPLER_SLOTS SG_MAX_SAMPLER_BINDSLOTS

◆ pg_create_shader

#define pg_create_shader	(	ctx,
		prefix
	)

Value:

    pg_create_shader_internal(          \
        ctx,                            \
        (pg_shader_internal_t)          \
        {                               \
            prefix##_shader_desc,       \
            prefix##_attr_slot,         \
            prefix##_image_slot,        \
            prefix##_sampler_slot,      \
            prefix##_uniformblock_slot, \
            prefix##_uniformblock_size, \
        }                               \
    )

Creates the shader with the given prefix The prefix should refer to the shader program name in a shader compiled by sokol-shdc. For example the sprite shader in the examples would have the prefix 'shader' (without quotation marks)

Typedef Documentation

◆ pg_ctx_t

typedef struct pg_ctx_t pg_ctx_t

Contains core data/state for an instance of the graphics library.

◆ pg_pipeline_t

typedef struct pg_pipeline_t pg_pipeline_t

Render state information.

◆ pg_shader_t

typedef struct pg_shader_t pg_shader_t

Vertex/fragment shader program.

◆ pg_texture_t

typedef struct pg_texture_t pg_texture_t

Represents an image or render target in VRAM.

◆ pg_sampler_t

typedef struct pg_sampler_t pg_sampler_t

Represents sampler.

◆ pg_buffer_t

typedef struct pg_buffer_t pg_buffer_t

A vertex or index array buffer.

◆ pg_pipeline_opts_t

typedef struct pg_pipeline_opts_t pg_pipeline_opts_t

Pipeline creation options.

◆ pg_texture_opts_t

typedef struct pg_texture_opts_t pg_texture_opts_t

Texture creation options.

Enumeration Type Documentation

◆ pg_backend_t

enum pg_backend_t

Graphics backends.

Enumerator
PG_BACKEND_GL
PG_BACKEND_GLES
PG_BACKEND_D3D
PG_BACKEND_METAL
PG_BACKEND_WGPU

◆ pg_primitive_t

enum pg_primitive_t

Drawing primitives.

Enumerator
PG_DEFAULT_PRIMITIVE
PG_POINTS	Array of points.
PG_LINES	Each adjacent pair of points forms a line.
PG_LINE_STRIP	Array of points where every pair forms a lines.
PG_TRIANGLES	Each adjacent triple forms an individual triangle.
PG_TRIANGLE_STRIP	Array of points where every triple forms a triangle.

◆ pg_blend_factor_t

enum pg_blend_factor_t

Blend factors.

Enumerator
PG_DEFAULT_BLEND_FACTOR
PG_ZERO	(0, 0, 0, 0)
PG_ONE	(1, 1, 1, 1)
PG_SRC_COLOR	(src.r, src.g, src.b, src.a)
PG_ONE_MINUS_SRC_COLOR	(1, 1, 1, 1) - (src.r, src.g, src.b, src.a)
PG_DST_COLOR	(dst.r, dst.g, dst.b, dst.a)
PG_ONE_MINUS_DST_COLOR	(1, 1, 1, 1) - (dst.r, dst.g, dst.b, dst.a)
PG_SRC_ALPHA	(src.a, src.a, src.a, src.a)
PG_ONE_MINUS_SRC_ALPHA	(1, 1, 1, 1) - (src.a, src.a, src.a, src.a)
PG_DST_ALPHA	(dst.a, dst.a, dst.a, dst.a)
PG_ONE_MINUS_DST_ALPHA	(1, 1, 1, 1) - (dst.a, dst.a, dst.a, dst.a)

◆ pg_blend_eq_t

enum pg_blend_eq_t

Blend equations.

Enumerator
PG_DEFAULT_BLEND_EQ
PG_ADD	result = src * src_factor + dst * dst_factor
PG_SUBTRACT	result = src * src_factor - dst * dst_factor
PG_REVERSE_SUBTRACT	result = dst * dst_factor - src * src_factor

◆ pg_vertex_format_t

enum pg_vertex_format_t

Vertex attribute pixel formats.

Enumerator
PG_VERTEX_FORMAT_INVALID
PG_VERTEX_FORMAT_FLOAT
PG_VERTEX_FORMAT_FLOAT2
PG_VERTEX_FORMAT_FLOAT3
PG_VERTEX_FORMAT_FLOAT4
PG_VERTEX_FORMAT_BYTE4
PG_VERTEX_FORMAT_BYTE4N
PG_VERTEX_FORMAT_UBYTE4
PG_VERTEX_FORMAT_UBYTE4N
PG_VERTEX_FORMAT_SHORT2
PG_VERTEX_FORMAT_SHORT2N
PG_VERTEX_FORMAT_USHORT2N
PG_VERTEX_FORMAT_SHORT4
PG_VERTEX_FORMAT_SHORT4N
PG_VERTEX_FORMAT_USHORT4N
PG_VERTEX_FORMAT_UINT10_N2
PG_VERTEX_FORMAT_HALF2
PG_VERTEX_FORMAT_HALF4

◆ pg_buffer_usage_t

enum pg_buffer_usage_t

Buffer update criteria.

Enumerator
PG_USAGE_STATIC	Buffer is immutable (cannot be updated)
PG_USAGE_DYNAMIC	Buffer is updated on average less than once per frame.
PG_USAGE_STREAM	Buffer is updated possibly more than once per frame.

Function Documentation

◆ pg_init()

void pg_init ( void )

Loads pico_gfx and sokol_gfx.

IMPORTANT: A valid graphics API context (OpenGL, Metal, D3D) must exist for this function to succeed. This function must be called before any other pico_gfx functions.

NOTE: This function calls sg_setup.

◆ pg_shutdown()

void pg_shutdown ( void )

Tears down pico_gfx and sokol_gfx.

NOTE: This function calls sg_shutdown

◆ pg_create_context()

pg_ctx_t * pg_create_context	(	int	window_width,
		int	window_height,
		void *	mem_ctx
	)

Creates a graphics context.

Parameters

window_width	The window width
window_height	The window height

◆ pg_destroy_context()

void pg_destroy_context ( pg_ctx_t * ctx )

Destroys a graphics context.

◆ pg_backend()

pg_backend_t pg_backend ( void )

Returns the backend in use at runtime.

◆ pg_set_window_size()

void pg_set_window_size	(	pg_ctx_t *	ctx,
		int	width,
		int	height,
		bool	reset
	)

Sets the window dimensions.

Parameters

ctx	The graphics context
width	The window width
height	The window height
reset	Resets the viewport and scissor if true

◆ pg_get_window_size()

void pg_get_window_size	(	pg_ctx_t *	ctx,
		int *	width,
		int *	height
	)

Gets the window size.

◆ pg_begin_pass()

void pg_begin_pass	(	pg_ctx_t *	ctx,
		pg_texture_t *	target,
		bool	clear
	)

Starts a render pass (mandatory)

NOTE: The default pass should be the last pass of a frame.

Parameters

ctx	The graphics context
pass	The render pass (NULL for the default pass)
clear	Clears the render target or window

◆ pg_end_pass()

void pg_end_pass ( pg_ctx_t * ctx )

Ends a render pass (mandatory)

◆ pg_flush()

void pg_flush ( pg_ctx_t * ctx )

Flush commands.

Must be called at the end of a frame (after pg_end_pass).

◆ pg_push_state()

void pg_push_state ( pg_ctx_t * ctx )

Pushes the active state onto the stack.

State consists of the pipeline, draw color, scissor, viewport, and default MVP transform, buffers, textures, and samplers

◆ pg_pop_state()

void pg_pop_state ( pg_ctx_t * ctx )

Pops a state off the stack and makes it the active state.

◆ pg_set_clear_color()

void pg_set_clear_color	(	pg_ctx_t *	ctx,
		float	r,
		float	g,
		float	b,
		float	a
	)

Sets the clear color state to be placed at the top of the state stack.

◆ pg_reset_clear_color()

void pg_reset_clear_color ( pg_ctx_t * ctx )

Resets the clear color

◆ pg_set_viewport()

void pg_set_viewport	(	pg_ctx_t *	ctx,
		int	x,
		int	y,
		int	w,
		int	h
	)

Sets the viewport state to be placed at the top of the state stack.

◆ pg_reset_viewport()

void pg_reset_viewport ( pg_ctx_t * ctx )

Resets the viewport

◆ pg_set_scissor()

void pg_set_scissor	(	pg_ctx_t *	ctx,
		int	x,
		int	y,
		int	w,
		int	h
	)

Sets the scissor state to be placed at the top of the state stack.

◆ pg_reset_scissor()

void pg_reset_scissor ( pg_ctx_t * ctx )

Resets the scissor

◆ pg_set_pipeline()

void pg_set_pipeline	(	pg_ctx_t *	ctx,
		pg_pipeline_t *	pipeline
	)

Sets the pipeline state.

Parameters

ctx	The graphics context
pipeline	The pipeline to be activated

◆ pg_reset_pipeline()

void pg_reset_pipeline ( pg_ctx_t * ctx )

Resets the pipeline

◆ pg_bind_buffer()

void pg_bind_buffer	(	pg_ctx_t *	ctx,
		int	slot,
		pg_buffer_t *	buffer
	)

Binds a buffer to the specified slot.

◆ pg_reset_buffers()

void pg_reset_buffers ( pg_ctx_t * ctx )

Clears buffer bindings.

◆ pg_set_index_buffer()

void pg_set_index_buffer	(	pg_ctx_t *	ctx,
		pg_buffer_t *	buffer
	)

Sets the active index buffer.

If an index buffer is set, pg_draw will use indexing.

◆ pg_reset_index_buffer()

void pg_reset_index_buffer ( pg_ctx_t * ctx )

Disables indexed rednering.

◆ pg_bind_texture()

void pg_bind_texture	(	pg_shader_t *	shader,
		const char *	name,
		pg_texture_t *	texture
	)

Binds a texture to a slot in the current state.

Parameters

shader	The shader associated with the texture
slot	The binding slot
texture	The texture to bind

◆ pg_reset_textures()

void pg_reset_textures ( pg_shader_t * shader )

Resets the texture bindings for the current state.

◆ pg_bind_sampler()

void pg_bind_sampler	(	pg_shader_t *	shader,
		const char *	name,
		pg_sampler_t *	sampler
	)

Binds a sampler to a slot in the current state.

Parameters

shader	The shader associated with the sampler
slot	The binding slot
sampler	The sampler to bind

◆ pg_reset_samplers()

void pg_reset_samplers ( pg_shader_t * shader )

Resets the sampler bindings for the current state.

◆ pg_reset_state()

void pg_reset_state ( pg_ctx_t * ctx )

Resets the active state to defaults.

◆ pg_destroy_shader()

void pg_destroy_shader ( pg_shader_t * shader )

Destroys a shader.

◆ pg_get_shader_id()

uint32_t pg_get_shader_id ( const pg_shader_t * shader )

Returns a shader ID.

◆ pg_set_uniform_block()

void pg_set_uniform_block	(	pg_shader_t *	shader,
		const char *	name,
		const void *	data
	)

Sets a uniform block (UB)

Parameters

shader	The shader owning the UB
name	The name of the UB as supplied by `sokol_shdc`
data	The data to set (must be the whole UB)

◆ pg_create_pipeline()

pg_pipeline_t * pg_create_pipeline	(	pg_ctx_t *	ctx,
		pg_shader_t *	shader,
		const pg_pipeline_opts_t *	opts
	)

Creates a rendering pipeline (encapsulates render state)

Parameters

shader	The shader used by this pipeline
opts	Pipeline creation options (required!)

Returns: A render pipeline object

◆ pg_destroy_pipeline()

void pg_destroy_pipeline ( pg_pipeline_t * pipeline )

Destroys a render pipeline.

◆ pg_get_shader()

pg_shader_t * pg_get_shader ( const pg_pipeline_t * pipeline )

Returns the shader associated with the pipeline.

◆ pg_get_blend_mode()

const pg_blend_mode_t * pg_get_blend_mode ( const pg_pipeline_t * pipeline )

Returns the blend mode associated with the pipeline.

◆ pg_create_texture()

pg_texture_t * pg_create_texture	(	pg_ctx_t *	ctx,
		int	width,
		int	height,
		const uint8_t *	data,
		size_t	size,
		const pg_texture_opts_t *	opts
	)

Creates a texture from an RGBA8 image.

Parameters

width	Image width
height	Image height
data	Image data (format must be RGBA8)
size	Size of the data in bytes
opts	Texture creation options (NULL for defaults)

Returns: A texture created from a bitmap

◆ pg_create_render_texture()

pg_texture_t * pg_create_render_texture	(	pg_ctx_t *	ctx,
		int	width,
		int	height,
		const pg_texture_opts_t *	opts
	)

Creates a render target.

Parameters

width	Render target width
height	Render target height
opts	Texture creation options (NULL for defaults)

Returns: A render texture

◆ pg_destroy_texture()

void pg_destroy_texture ( pg_texture_t * texture )

Destroys a texture.

◆ pg_get_texture_id()

uint32_t pg_get_texture_id ( const pg_texture_t * texture )

Returns a texture ID.

◆ pg_get_texture_size()

void pg_get_texture_size	(	const pg_texture_t *	texture,
		int *	width,
		int *	height
	)

Gets a texture's dimensions.

◆ pg_update_texture()

void pg_update_texture	(	pg_texture_t *	texture,
		char *	data,
		int	width,
		int	height
	)

Updates a texture with the given data. This can only be called once per frame.

◆ pg_create_sampler()

pg_sampler_t * pg_create_sampler	(	pg_ctx_t *	ctx,
		const pg_sampler_opts_t *	opts
	)

Creates a sampler represents an object that can control how shaders transform and filter texture resource data.

Parameters

opts	Sampler options

◆ pg_destroy_sampler()

void pg_destroy_sampler ( pg_sampler_t * sampler )

Destroys a sampler object.

◆ pg_create_vertex_buffer()

pg_buffer_t * pg_create_vertex_buffer	(	pg_ctx_t *	ctx,
		pg_buffer_usage_t	usage,
		const void *	data,
		size_t	count,
		size_t	max_elements,
		size_t	element_size
	)

Creates a vertex buffer.

Parameters

usage	Determines whether the buffer is static, dynamic, or streaming
data	Vertex data elements (can be NULL)
count	The number of elements (can be zero)
max_elements	The maximum number of elements in the buffer
element_size	The size (in bytes) of each individual element

◆ pg_create_index_buffer()

pg_buffer_t * pg_create_index_buffer	(	pg_ctx_t *	ctx,
		pg_buffer_usage_t	usage,
		const void *	data,
		size_t	count,
		size_t	max_elements
	)

Creates a vertex buffer.

Parameters

usage	Determines whether the buffer is static, dynamic, or streaming
data	Index data (can be NULL)
count	The number of indices (can be zero)
max_elements	The maximum number of indices in the buffer

◆ pg_destroy_buffer()

void pg_destroy_buffer ( pg_buffer_t * buffer )

Destroys a vertex or index buffer.

◆ pg_update_buffer()

void pg_update_buffer	(	pg_buffer_t *	buffer,
		void *	data,
		size_t	count
	)

Replaces the data in a buffer. This may only happen once per frame and cannot happen after appending data

◆ pg_append_buffer()

int pg_append_buffer	(	pg_buffer_t *	buffer,
		void *	data,
		size_t	count
	)

Appends data to a buffer. This can happen more than once per frame, and cannot happen after an update.

◆ pg_get_buffer_offset()

int pg_get_buffer_offset ( pg_buffer_t * buffer )

Returns the buffer offset.

◆ pg_set_buffer_offset()

void pg_set_buffer_offset	(	pg_buffer_t *	buffer,
		int	offset
	)

Sets the buffer offset.

◆ pg_reset_buffer()

void pg_reset_buffer ( pg_buffer_t * buffer )

Destroys and recreates buffer.

◆ pg_draw()

void pg_draw	(	const pg_ctx_t *	ctx,
		size_t	start,
		size_t	count,
		size_t	instances
	)

Draws from the buffers that are bound to the current state.

Parameters

ctx	The graphics context
start	The position of the first element
count	The number of elements to draw
instances	The number of instances

◆ pg_create_shader_internal()

pg_shader_t * pg_create_shader_internal	(	pg_ctx_t *	ctx,
		pg_shader_internal_t	internal
	)

Classes

Macros

Typedefs

Enumerations

Functions

Detailed Description

Licensing information at end of header

Compatibility

Features:

Summary:

C++

Build:

Constants:

Customization:

Macro Definition Documentation

◆ PG_MAX_VERTEX_ATTRIBUTES

◆ PG_MAX_VERTEX_BUFFERS

◆ PG_MAX_TEXTURE_SLOTS

◆ PG_MAX_SAMPLER_SLOTS

◆ pg_create_shader

Typedef Documentation

◆ pg_ctx_t

◆ pg_pipeline_t

◆ pg_shader_t

◆ pg_texture_t

◆ pg_sampler_t

◆ pg_buffer_t

◆ pg_pipeline_opts_t

◆ pg_texture_opts_t

Enumeration Type Documentation

◆ pg_backend_t

◆ pg_primitive_t

◆ pg_blend_factor_t

◆ pg_blend_eq_t

◆ pg_vertex_format_t

◆ pg_buffer_usage_t

Function Documentation

◆ pg_init()

◆ pg_shutdown()

◆ pg_create_context()

◆ pg_destroy_context()

◆ pg_backend()

◆ pg_set_window_size()

◆ pg_get_window_size()

◆ pg_begin_pass()

◆ pg_end_pass()

◆ pg_flush()

◆ pg_push_state()

◆ pg_pop_state()

◆ pg_set_clear_color()

◆ pg_reset_clear_color()

◆ pg_set_viewport()

◆ pg_reset_viewport()

◆ pg_set_scissor()

◆ pg_reset_scissor()

◆ pg_set_pipeline()

◆ pg_reset_pipeline()

◆ pg_bind_buffer()

◆ pg_reset_buffers()

◆ pg_set_index_buffer()

◆ pg_reset_index_buffer()

◆ pg_bind_texture()

◆ pg_reset_textures()

◆ pg_bind_sampler()

◆ pg_reset_samplers()

◆ pg_reset_state()

◆ pg_destroy_shader()

◆ pg_get_shader_id()

◆ pg_set_uniform_block()

◆ pg_create_pipeline()

◆ pg_destroy_pipeline()

◆ pg_get_shader()

◆ pg_get_blend_mode()

◆ pg_create_texture()

◆ pg_create_render_texture()

◆ pg_destroy_texture()

◆ pg_get_texture_id()

◆ pg_get_texture_size()

◆ pg_update_texture()

◆ pg_create_sampler()