gfx 0.18.3

A high-performance, bindless graphics API
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

// Copyright 2015 The Gfx-rs Developers.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Macro for implementing Structure for vertex and constant buffers.

#[doc(hidden)]
#[macro_export]
macro_rules! gfx_impl_struct {
    ($runtime_format:ty : $compile_format:path = $root:ident {
        $( $field:ident: $ty:ty = $name:expr, )*
    }) => (gfx_impl_struct_meta! {
        impl_struct_meta $runtime_format : $compile_format = $root {
            $( $field : $ty = $name, )*
        }
    })
}
#[doc(hidden)]
#[macro_export]
macro_rules! gfx_impl_struct_meta {
    ($(#[$attr:meta])* impl_struct_meta $runtime_format:ty : $compile_format:path = $root:ident {
        $( $(#[$field_attr:meta])* $field:ident: $ty:ty = $name:expr, )*
    }) => {
        #[allow(missing_docs)]
        #[derive(Clone, Copy, Debug, PartialEq)]
        $(#[$attr])*
        pub struct $root {
            $( $(#[$field_attr])* pub $field: $ty, )*
        }

        unsafe impl $crate::traits::Pod for $root {}

        impl $crate::pso::buffer::Structure<$runtime_format> for $root {
            fn query(name: &str) -> ::std::option::Option<$crate::pso::buffer::Element<$runtime_format>> {
                use std::mem::{size_of, transmute};
                use $crate::pso::buffer::{Element, ElemOffset};
                // using "1" here as a simple non-zero pointer addres
                let tmp: &$root = unsafe{ transmute(1usize) };
                let base = tmp as *const _ as usize;
                //HACK: special treatment of array queries
                let (sub_name, big_offset) = {
                    let mut split = name.split(|c| c == '[' || c == ']');
                    let _ = split.next().unwrap();
                    match split.next() {
                        Some(s) => {
                            let array_id: ElemOffset = s.parse().unwrap();
                            let sub_name = match split.next() {
                                Some(s) if s.starts_with('.') => &s[1..],
                                _ => name,
                            };
                            (sub_name, array_id * (size_of::<$root>() as ElemOffset))
                        },
                        None => (name, 0),
                    }
                };
                match sub_name {
                $(
                    $name => Some(Element {
                        format: <$ty as $compile_format>::get_format(),
                        offset: ((&tmp.$field as *const _ as usize) - base) as ElemOffset + big_offset,
                    }),
                )*
                    _ => None,
                }
            }
        }
    }
}

/// Defines a structure that is used in a vertex buffer.
#[macro_export]
macro_rules! gfx_vertex_struct {
    ($root:ident {
        $( $field:ident: $ty:ty = $name:expr, )*
    }) => (gfx_vertex_struct_meta! {
        vertex_struct_meta $root {
            $( $field : $ty = $name, )*
        }
    })
}

#[doc(hidden)]
#[macro_export]
macro_rules! gfx_vertex_struct_meta {
    ($(#[$attr:meta])* vertex_struct_meta $root:ident {
        $( $(#[$field_attr:meta])* $field:ident: $ty:ty = $name:expr, )*
    }) => (gfx_impl_struct_meta!{
        $(#[$attr])* #[repr(C)] impl_struct_meta
        $crate::format::Format : $crate::format::Formatted =
        $root {
            $( $(#[$field_attr])* $field: $ty = $name, )*
        }
    })
}

/// Defines a structure that is used in a constant buffer.
#[macro_export]
macro_rules! gfx_constant_struct {
    ($root:ident {
        $( $field:ident: $ty:ty = $name:expr, )*
    }) => (gfx_constant_struct_meta!{
        constant_struct_meta $root {
            $( $field : $ty = $name, )*
        }
    })
}

#[doc(hidden)]
#[macro_export]
macro_rules! gfx_constant_struct_meta {
    ($(#[$attr:meta])* constant_struct_meta $root:ident {
        $( $(#[$field_attr:meta])* $field:ident: $ty:ty = $name:expr, )*
    }) => (gfx_impl_struct_meta!{
        $(#[$attr])* #[repr(C)] impl_struct_meta
        $crate::shade::ConstFormat : $crate::shade::Formatted =
        $root {
            $( $(#[$field_attr])* $field: $ty = $name, )*
        }
    })
}