Crate blue_engine_dynamic Copy item path Source engine contains defintions of top level functionality of the Engine error interal error definitions of the engine objects contains the definition for Object type, which is a type that make it easier to manage data for rendering. prelude contains all the declarations such as structs, exports, enums, … render contains definition for rendering part of the engine. utils Utilities for the engine (soon moving to it’s own
crate ). Backends Represents the backends that wgpu will use. Camera Container for the camera feature. The settings here are needed for
algebra equations needed for camera vision and movement. Please leave it to the renderer to handle CameraContainer Container for Cameras CommandEncoder Encodes a series of GPU operations. Engine The engine is the main starting point of using the Blue Engine.
Everything that runs on Blue Engine will be under this struct.
The structure of engine is monolithic, but the underlying data and the way it works is not.
It gives a set of default data to work with,
but also allow you to go beyond that and work as low level as you wish to. EngineSettings Descriptor and settings for a window. Instance Instance buffer data storage InstanceRaw Instance buffer data that is sent to GPU Object Objects make it easier to work with Blue Engine, it automates most of work needed for
creating 3D objects and showing them on screen. A range of default objects are available
as well as ability to customize each of them and even create your own! You can also
customize almost everything there is about them! ObjectSettings Extra settings to customize objects on time of creation ObjectStorage A unified way to handle objects Operations Pair of load and store operations for an attachment aspect. Pipeline Container for pipeline values. Each pipeline takes only 1 vertex shader,
1 fragment shader, 1 texture data, and optionally a vector of uniform data. RenderPassColorAttachment Describes a color attachment to a RenderPass RenderPassDescriptor Describes the attachments of a render pass. Renderer Main renderer class. this will contain all methods and data related to the renderer ShaderSettings These definitions are taken from wgpu API docs SignalStorage Handles the live events in the engine TextureView Handle to a texture view. Vertex Will contain all details about a vertex and will be sent to GPU VertexBuffers Container for vertex and index buffer LoadOp Operation to perform to the output attachment at the start of a render pass. MemoryHints Hints to the device about the memory allocation strategy. PipelineData Container for pipeline data. Allows for sharing resources with other objects Projection Container for the projection used by the camera RotateAmount Defines how the rotation amount is RotateAxis Defines how the rotation axis is TextureData Defines how the texture data is TextureMode Defines how the borders of texture would look like DEPTH_FORMAT Depth Format Pod Marker trait for “plain old data”. Signal Allows all events to be fetched directly, making it easier to add custom additions to the engine. Zeroable Trait for types that can be safely created with
zeroed pixel_to_cartesian This function helps in converting pixel value to the value that is between -1 and +1 CullMode Face of a vertex. FrontFace Vertex winding order which classifies the “front” face of a triangle. IndexFormat Format of indices used with pipeline. Matrix2 A 2x2 column major matrix. Matrix3 A 3x3 column major matrix. Matrix4 A 4x4 column major matrix. PolygonMode Type of drawing mode for polygons PowerPreference Power Preference when choosing a physical adapter. Quaternion A quaternion representing an orientation. ShaderPrimitive Primitive type the input mesh is composed of. Shaders Shaders are programs that runs on the GPU Textures Textures are image data that are sent to GPU to be set to a surface UniformBuffers Uniform Buffers are small amount of data that are sent from CPU to GPU UnsignedIntType The uint type used for indices and more Vector2 A 2-dimensional vector. Vector3 A 3-dimensional vector. Vector4 A 4-dimensional vector. WindowSize To hold the width and height of the engine frames Pod Derive the Pod trait for a struct Zeroable Derive the Zeroable trait for a type.