Module pigeon_2d::pigeon

Contains code to manage pigeon Contains the managing code for pigeon as well as the draw functions. It comes with a basic version of Pigeon able to draw the basic primatives but its recommended that you create your own using the pigeon! macro.

Usage

I highly recommend looking at the examples to get a good idea of how pigeon operates and how to use it.

Drawing

To draw in pigeon, call the [draw] function. It takes in a reference to a function that you’ll create that takes a [Container] as an input. In your function you can use the other functions generated by the pigeon! macro for each pipeline that add any shapes that can be broken down into that pipelines vertices and add them to the [Container]. Everything in the [Container] gets drawn to the screen.

Modules

custom_render

Specialised draw functions allowing you direct access to the wgpu::RenderPass

Structs

Container

Used as an intermediate, it contains the breakdowns for various pipelines

Pigeon

The manager for pigeon. Contains the important things like the pipelines and the Painter

Constants

OPENGL_TO_WGPU_MATRIX

Functions

add_quad

add_triangle

draw

Used to draw you shapes in pigeon. Takes in your draw function which will fill a Container with whatever you want drawn this pass.