Crate blue_engine_dynamic Copy item path Source 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 ). window contains definition for creation of window and instance creation. 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. EventLoop Provides a way to retrieve events from the system and from the windows that were registered to
the events loop. InputHelper main struct Instance Instance buffer data storage InstanceRaw Instance buffer data that is sent to GPU KeyEvent Describes a keyboard input targeting a window. LogicalPosition A position represented in logical pixels. LogicalSize A size represented in logical pixels. LogicalUnit A logical pixel unit. 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. PhysicalPosition A position represented in physical pixels. PhysicalSize A size represented in physical pixels. PhysicalUnit A physical pixel unit. 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 Window A wrapper for winit window to make it easier to use and more ergonomic. WindowDescriptor Descriptor and settings for a window. DeviceEvent Represents raw hardware events that are not associated with any particular window. ElementState Describes the input state of a key. Event Describes a generic event. Fullscreen Fullscreen modes. Key Key represents the meaning of a keypress. KeyCode Code representing the location of a physical key 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. MouseButton Describes a button of a mouse controller. PipelineData Container for pipeline data. Allows for sharing resources with other objects PixelUnit A pixel unit that’s either physical or logical. Position A position that’s either physical or logical. Projection Container for the projection used by the camera RotateAmount Defines how the rotation amount is RotateAxis Defines how the rotation axis is Size A size that’s either physical or logical. TextureData Defines how the texture data is TextureMode Defines how the borders of texture would look like WindowEvent Describes an event from a [Window]. DEPTH_FORMAT Depth Format Pixel 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. StringBuffer A unified way to handle strings StringBufferTrait A trait for StringBuffer 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 validate_scale_factor Checks that the scale factor is a normal positive f64. 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. Pod Derive the Pod trait for a struct Zeroable Derive the Zeroable trait for a type.