Crate fyrox

3D and 2D Game Engine.

Re-exports

pub use crate::core::rand;

pub use fxhash;

pub use lazy_static;

pub use tbc;

pub use walkdir;

Modules

animation

asset

Resource management

core

Core data structures and algorithms used throughout Fyrox.

dpi

UI scaling is important, so read the docs for this module if you don’t want to be confused.

engine

Engine is container for all subsystems (renderer, ui, sound, resource manager). It also creates a window and an OpenGL context.

error

event

The Event enum and assorted supporting types.

event_loop

The EventLoop struct and assorted supporting types, including ControlFlow.

gui

Extendable, retained mode, graphics API agnostic UI library.

material

Material is a set of parameters for a shader. This module contains everything related to materials.

monitor

Types useful for interacting with a user’s monitors.

platform

Contains traits with platform-specific methods in them.

plugin

Everything related to plugins. See Plugin docs for more info.

renderer

Renderer is a “workhorse” of the engine, it draws scenes (both 3D and 2D), user interface, debug geometry and has an ability to add user-defined render passes. Current renderer implementation is not very flexible, but should cover 95% of use cases.

resource

Everything related to resources.

scene

Contains all structures and methods to create and manage 3D scenes.

script

utils

Utilities module provides set of commonly used algorithms.

window

The Window struct and associated types.

Macros

define_is_as

Defines as_(variant), as_mut_(variant) and is_(variant) methods.

define_with

Defines a builder’s with_xxx method.

handle_collection_property_changed

A helper macro that allows you to handle object’s property changed message. Such messages may come from editor’s Inspector. It handles CollectionChanged variant of the message. The type of the collection item must have a method called on_property_changed - you could use newtype for that (see examples).

handle_object_property_changed

A helper macro that allows you to handle object’s property changed message. Such messages may come from editor’s Inspector. It handles Object variant of the message.

impl_directly_inheritable_entity_trait

Implements DirectlyInheritableEntity trait for a specified object.

impl_query_component

Implements NodeTrait::query_component_ref and NodeTrait::query_component_mut in a much shorter way.

Structs

Context

Represents an OpenGL Context.

ContextBuilder

An object that allows you to build Contexts, RawContext<T>s and WindowedContext<T>s.

ContextWrapper

A context which has an underlying window, which may or may not be stored separately.

GlAttributes

Attributes to use when creating an OpenGL Context.

PixelFormat

Describes a possible format.

PixelFormatRequirements

Describes how the backend should choose a pixel format.

PossiblyCurrent

A type that Contexts which might possibly be currently current on some thread take as a generic.

Rect

Enums

Api

All APIs related to OpenGL that you can possibly get while using glutin.

ContextError

Error that can happen when manipulating an OpenGL Context.

CreationError

Error that can happen while creating a window or a headless renderer.

GlProfile

Describes the requested OpenGL Context profiles.

GlRequest

Describes the OpenGL API and version that are being requested when a context is created.

NotCurrent

A type that Contexts which are not currently current on any thread take as a generic.

ReleaseBehavior

The behavior of the driver when you change the current context.

Robustness

Specifies the tolerance of the OpenGL Context to faults. If you accept raw OpenGL commands and/or raw shader code from an untrusted source, you should definitely care about this.

Statics

GL_CORE

The minimum core profile GL context. Useful for getting the minimum required GL version while still running on OSX, which often forbids the compatibility profile features.

Traits

ContextCurrentState

A trait implemented on both NotCurrent and PossiblyCurrent.

Type Definitions

RawContext

Represents an OpenGL Context which has an underlying window that is stored separately.

WindowedContext

Represents an OpenGL Context and the Window with which it is associated.