Module framework

Expand description

Rendering framework.

Modules§

buffer: Buffer is a type-agnostic data storage located directly in GPU memory. It could be considered as a data block which content is a pile of bytes, whose meaning is defined externally.
core: Core data structures and algorithms used throughout Fyrox.
error: Contains all possible errors that may occur during rendering, initialization of renderer structures, or GAPI.
framebuffer: Frame buffer is a set of images that is used as a storage for an image generated by a renderer. It consists of one or more color buffers and an optional depth/stencil buffer. See FrameBuffer docs for more info.
geometry_buffer: Geometry buffer is a mesh buffer, that could contain multiple vertex buffers and only one element buffer.
gl
gpu_program
gpu_texture: Texture is an image that used to fill faces to add details to them. It could also be used as a generic and mostly unlimited capacity storage for arbitrary data.
query
read_buffer
server: Graphics server is an abstraction layer over various graphics APIs used on different platforms supported by the engine.
stats
uniform: Uniform buffer is a special byte storage that ensures correct data alignment suitable for GPU. Current implementation supports std140 data layout scheme.

BlendEquation: An equation used for blending a source pixel color with the destination color (the one that is already in a frame buffer). This equation has different modes for rgb/alpha parts.
BlendFunc: Blending function defines sources of data for both operands in blending equation (separately for RGB and Alpha parts). Default blending function is replacing destination values with the source ones.
BlendParameters: Blending parameters (such as blending function and its equation).
ColorMask: A mask that defines which colors will be stored in a frame buffer during rendering operation. By default, all colors are stored (every field is set to true).
DrawParameters: A set of drawing parameters, that are used during draw call. It defines pretty much all pipeline settings all at once.
ScissorBox: A rectangular area that defines which pixels will be rendered in a frame buffer or not.
StencilFunc: Defines a function that used in a stencil test.
StencilOp: A set of actions that will be performed with the stencil buffer during various testing stages.

BlendFactor: Defines a set values (per color) for blending operation.
BlendMode: Defines an operation used in blending equation.
CompareFunc: A function used to compare two values. Usually it is used for depth and stencil testing.
CullFace: A face side to cull.
ElementKind: Element kind of geometry.
ElementRange: A range of elements (usually it’s triangles) to draw in a draw call.
PolygonFace: Defines a polygon face that will be rendered. This is usually used for back face culling. Default value is PolygonFace::FrontAndBack.
PolygonFillMode: A set of possible polygon filling modes.
StencilAction: An action with the stencil value in the stencil buffer is the stencil test passed.