Module let_engine::prelude

usage:

use let_engine::prelude::*;

• imports everything this engine has to offer.

Re-exports

• pub use glam;
• pub use crate::directions::*;
• pub use crate::*;

Modules

• data
  Holds model related data structures like Vertices and premade models as well as a circle maker macro.
• dpi
  UI scaling is important, so read the docs for this module if you don’t want to be confused.
• joints
  Wrapping of Rapiers joints to be used with Let Engine and Glam.
• labels
  Default labels given by the engine.
• materials
  Material related settings that determine the way the scene gets rendered.
• model
• physics
  Physics related structs.
• scenes
• textures
  Texture related options.
• vulkan

Macros

• font
  Loads a font to the engine using binary true type font data of the inserted &[u8] and returns a Font.
• make_circle
  A macro that makes it easy to create circles.
• material
  Loads a new material.
• model
  Loads a model to the engine using the vertex and index data of the inserted Data and returns a Model.
• raw_shader
  Loads a shader from glsl bytes. Takes &[u8] and returns Shaders. Those shaders can be used when making materials.
• texture
  Loads a texture to the engine using one of the supported file formats and returns a Texture.
• texture_from_raw
  Loads a texture to the engine using raw image bytes and context and returns a Texture.
• write_descriptor
  Describes a write operation for a descriptor. Used with materials to interact with custom shaders inside them.

Structs

• Appearance
  Holds everything about the appearance of objects like textures, vetex/index data, color and material.
• CameraSettings
  Settings that determine your camera vision.
• Collider
• ColliderBuilder
• Data
  Vertex and index data for the appearance and shape of objects. Has 3 simple presets.
• FixedJoint
  A fixed joint, locks all relative motion between two bodies.
• FixedJointBuilder
  Create fixed joints using the builder pattern.
• Font
  A font to be used with the default label system.
• GenericJoint
  A generic joint.
• GenericJointBuilder
  Create generic joints using the builder pattern.
• Icon
  An icon used for the window titlebar, taskbar, etc.
• ImpulseJointHandle
  The unique identifier of a joint added to the joint set. The unique identifier of a collider added to a collider set.
• IntegrationParameters
  Parameters for a time-step of the physics engine.
• JointAxesMask
  A bit mask identifying multiple degrees of freedom of a joint.
• KeyboardInput
• Label
  A Label object made to display text.
• LabelCreateInfo
  Info to create default label objects with.
• Layer
  A layer struct holding it’s own object hierarchy, camera and physics iteration.
• LockedAxes
  Flags affecting the behavior of the constraints solver for a given contact manifold.
• LogicalPosition
  A position represented in logical pixels.
• LogicalSize
  A size represented in logical pixels.
• Material
  A material holding the way an object should be drawn.
• MaterialSettings
  Vertex and fragment shaders of a material as well as the topology and line width, if the topology is set to LineList or LineStrip.
• MaterialSettingsBuilder
  Builder for MaterialSettings.
• Model
  The model of an object made of vertices and indices.
• ModifiersState
  Represents the current state of the keyboard modifiers
• Node
  Node structure for the layer.
• Object
  Default object without any additional fields.
• PhysicalPosition
  A position represented in physical pixels.
• PhysicalSize
  A size represented in physical pixels.
• PrismaticJoint
  A prismatic joint, locks all relative motion between two bodies except for translation along the joint’s principal axis.
• PrismaticJointBuilder
  Create prismatic joints using the builder pattern.
• Resources
  All the resources kept in the game engine like textures, fonts, sounds and models.
• RevoluteJoint
  A revolute joint, locks all relative motion except for rotation along the joint’s principal axis.
• RevoluteJointBuilder
  Create revolute joints using the builder pattern.
• RigidBody
• RigidBodyActivation
  The rb_activation status of a body.
• RigidBodyBuilder
  A builder for rigid-bodies.
• RopeJoint
  A rope joint, limits the maximum distance between two bodies
• RopeJointBuilder
  Create rope joints using the builder pattern.
• Sampler
  The sampler of the texture that determines how the shader should handle textures.
• SamplerBuilder
  Builder for Sampler.
• Scene
  The whole scene seen with all it’s layers.
• Shaders
  Holds compiled shaders in form of ShaderModules to use in a material.
• Shape
• Sound
• Texture
  A texture to be used with materials.
• TextureSettings
  The main texture settings.
• Transform
  Holds position size and rotation of an object.
• VHACDParameters
  Parameters controlling the VHACD convex decomposition.
• Vec2
  A 2-dimensional vector.
• Vertex
• Window
  A struct representing the window.
• WindowBuilder
  A builder describing the initial state of the window.

Enums

• AddressMode
  Handling of pixels outside the position range of the texture.
• BorderColor
  The color to use for the border of an image.
• CameraScaling
  The 4 Camera scaling modes determine how far you can see when the window changes scale. For 2D games those are a problem because there will always be someone with a monitor or window with a weird aspect ratio that can see much more than others when it’s not on stretch mode. Those are the options in this game engine:
• CoefficientCombineRule
  Rules used to combine two coefficients.
• CursorGrabMode
  The behavior of cursor grabbing.
• CursorIcon
  Describes the appearance of the mouse cursor.
• ElementState
  Describes the input state of a key.
• Event
• Filter
  Filtering mode
• Format
  Formats for the texture from raw data.
• ImageFormat
  An enumeration of supported image formats. Not all formats support both encoding and decoding.
• InputEvent
• MaterialSettingsBuilderError
  Error type for MaterialSettingsBuilder
• MouseButton
  Describes a button of a mouse controller.
• Position
  A position that’s either physical or logical.
• RigidBodyType
  The status of a body, governing the way it is affected by external forces.
• SamplerBuilderError
  Error type for SamplerBuilder
• ScrollDelta
• Size
  A size that’s either physical or logical.
• Topology
  The way in which an object gets drawn using it’s vertices and indices.
• UserAttentionType
  Platform-specific
• VirtualKeyCode
  Symbolic name for a keyboard key.
• WindowEvent
• WindowLevel
  A window level groups windows with respect to their z-position.

Constants

• SQUARE
• SQUARE_ID
• TRIANGLE
• TRIANGLE_ID

Traits

• GameObject
  The trait that automatically gets implemented to each object you give the object attribute.
• Pixel

Functions

• load_sound
  Not done.
• tvert
  Creates a vertex with given x and y coordinates for position and given tx and ty coordinates for the UV texture mapping for those points.
• validate_scale_factor
  Checks that the scale factor is a normal positive f64.
• vec2
  Creates a 2-dimensional vector.
• vert
  Creates a vertex with given x and y coordinates for both position and texture position.

Type Aliases

• RigidBodyParent

Attribute Macros

• object
  Implements GameObject on a struct and automaically adds the fields transform, appearance, id and layer to update from and to. Also adds 2 functions. Update and Sync. Update updates the object from the layer system and sync syncs the object to the layer. Those functions panic when the object isn’t initialized to the layer yet.
• objectinit_without_implements