mirror of
https://github.com/gfx-rs/wgpu.git
synced 2025-02-18 18:02:48 +00:00
Document some Expression, EntryPoint, and Module rules.
This commit is contained in:
parent
636b8ed606
commit
8aae069f22
@ -1451,6 +1451,9 @@ pub struct Function {
|
||||
/// Local variables defined and used in the function.
|
||||
pub local_variables: Arena<LocalVariable>,
|
||||
/// Expressions used inside this function.
|
||||
///
|
||||
/// An `Expression` must occur before all other `Expression`s that use its
|
||||
/// value.
|
||||
pub expressions: Arena<Expression>,
|
||||
/// Map of expressions that have associated variable names
|
||||
pub named_expressions: NamedExpressions,
|
||||
@ -1503,6 +1506,8 @@ pub struct Function {
|
||||
#[cfg_attr(feature = "deserialize", derive(Deserialize))]
|
||||
pub struct EntryPoint {
|
||||
/// Name of this entry point, visible externally.
|
||||
///
|
||||
/// Entry point names for a given `stage` must be distinct within a module.
|
||||
pub name: String,
|
||||
/// Shader stage.
|
||||
pub stage: ShaderStage,
|
||||
@ -1536,6 +1541,9 @@ pub struct Module {
|
||||
/// Storage for the global variables defined in this module.
|
||||
pub global_variables: Arena<GlobalVariable>,
|
||||
/// Storage for the functions defined in this module.
|
||||
///
|
||||
/// Each function must appear in this arena strictly before all its callers.
|
||||
/// Recursion is not supported.
|
||||
pub functions: Arena<Function>,
|
||||
/// Entry points.
|
||||
pub entry_points: Vec<EntryPoint>,
|
||||
|
Loading…
Reference in New Issue
Block a user