rafx 0.0.16

Rendering framework built on an extensible asset pipeline
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

//! NOTE: **docs.rs may not generate complete documentation for rafx because it does not enable all
//! of the features in cargo when building the docs.** To generate complete documentation locally,
//! run `cargo doc --no-deps --open` in the root of the crate.
//!
//! Rafx is a multi-backend renderer that prioritizes performance, flexibility, and productivity. It
//! optionally integrates with the [`distill`](https://github.com/amethyst/distill) asset
//! pipeline to provide workflows and tools suitable for real-world projects with multidisciplinary
//! teams.
//!
//! > **Note:** Additional documentation describing aspects of `rafx`'s design, usage, and architecture
//! can be found on [GitHub](https://github.com/aclysma/rafx/blob/master/docs/index.md).
//!
//! This crate contains several layers:
//!  * [`rafx_api`]: Low-level graphics API abstraction
//!  * [`rafx_framework`]: Mid-level framework that eases resource management, lifetime handling,
//!     and draw call dispatching
//!  * [`rafx_assets`]: Asset layer that integrates with the
//!     [`distill`](https://github.com/amethyst/distill) asset pipeline
//!      * NOTE: The published version in crates.io does not include rafx-assets as `distill` is not
//!        published yet
//!
//! Rafx also provides tools for building shaders and packing assets.
//!
//! Rafx supports most mainstream platforms via `vulkan` and `metal` backends. OpenGL ES 2.0/3.0 backends
//! are work-in-progress and they support less features due to API limitations ( see [backends] ).
//! Proprietary platforms can be supported by adding an additional backend.
//!
//! [backends]: https://github.com/aclysma/rafx/tree/master/docs/api/backends

#[doc(inline)]
pub use rafx_base as base;

#[doc(inline)]
pub use rafx_api as api;

#[doc(inline)]
pub use rafx_api::RafxResult;

#[cfg(feature = "assets")]
#[doc(inline)]
pub use rafx_assets as assets;

#[cfg(feature = "framework")]
#[doc(inline)]
pub use rafx_framework as framework;
#[cfg(feature = "framework")]
pub use rafx_framework::declare_render_feature;
#[cfg(feature = "framework")]
pub use rafx_framework::declare_render_feature_flag;
#[cfg(feature = "framework")]
pub use rafx_framework::declare_render_phase;
#[cfg(feature = "framework")]
pub use rafx_framework::graph;
#[cfg(feature = "framework")]
pub use rafx_framework::render_features;
#[cfg(feature = "framework")]
pub use rafx_framework::visibility;
#[cfg(feature = "framework")]
pub mod render_feature_extract_job_predule {
    pub use rafx_framework::render_features::render_features_prelude::*;
    pub use std::sync::Arc;
}
#[cfg(feature = "framework")]
pub mod render_feature_prepare_job_predule {
    pub use rafx_framework::render_features::render_features_prelude::*;
    pub use std::sync::Arc;
}
#[cfg(feature = "framework")]
pub mod render_feature_write_job_prelude {
    pub use rafx_api::RafxResult;
    pub use rafx_framework::render_features::render_features_prelude::*;
    pub use std::sync::Arc;
}
#[cfg(feature = "framework")]
pub mod render_feature_renderer_prelude {
    pub use rafx_api::extra::upload::RafxTransferUpload;
    pub use rafx_api::RafxResult;
    #[cfg(feature = "assets")]
    pub use rafx_assets::AssetManager;
    #[cfg(feature = "assets")]
    pub use rafx_assets::AssetResource;
    pub use rafx_base::resource_map::ResourceMap;
    pub use rafx_framework::render_features::render_features_prelude::*;
    pub use rafx_framework::RenderResources;
    #[cfg(feature = "renderer")]
    pub use rafx_renderer::RenderFeaturePlugin;
    pub use std::sync::Arc;
}
#[cfg(feature = "framework")]
pub mod render_feature_mod_prelude {
    pub use rafx_framework::render_features::{
        RenderFeature, RenderFeatureDebugConstants, RenderFeatureFlag, RenderFeatureFlagIndex,
        RenderFeatureIndex,
    };
    pub use std::convert::TryInto;
}

#[cfg(feature = "framework")]
#[doc(inline)]
pub use rafx_visibility;

#[cfg(feature = "renderer")]
#[doc(inline)]
pub use rafx_renderer as renderer;