gfx 0.17.0

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

// Copyright 2014 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.

//! Shader parameter handling.

#[cfg(feature = "mint")]
use mint;

use std::error::Error;
use std::fmt;
pub use core::shade::{self as core, ConstFormat, Formatted, Usage};

#[allow(missing_docs)]
pub trait ToUniform: Copy {
    fn convert(self) -> core::UniformValue;
}

macro_rules! impl_uniforms {
    ( $( $ty_src:ty = $ty_dst:ident ,)* ) => {
        $(
            impl ToUniform for $ty_src {
                fn convert(self) -> core::UniformValue {
                    core::UniformValue::$ty_dst(self.into())
                }
            }
        )*
    }
}

impl_uniforms! {
    i32 = I32,
    f32 = F32,
    [i32; 2] = I32Vector2,
    [i32; 3] = I32Vector3,
    [i32; 4] = I32Vector4,
    [f32; 2] = F32Vector2,
    [f32; 3] = F32Vector3,
    [f32; 4] = F32Vector4,
    [[f32; 2]; 2] = F32Matrix2,
    [[f32; 3]; 3] = F32Matrix3,
    [[f32; 4]; 4] = F32Matrix4,
}

#[cfg(feature = "mint")]
impl_uniforms! {
    mint::Point2<f32> = F32Vector2,
    mint::Point3<f32> = F32Vector3,
    mint::Vector2<f32> = F32Vector2,
    mint::Vector3<f32> = F32Vector3,
    mint::Vector4<f32> = F32Vector4,
    mint::ColumnMatrix2<f32> = F32Matrix2,
    mint::ColumnMatrix3<f32> = F32Matrix3,
    mint::ColumnMatrix4<f32> = F32Matrix4,
}

/// Program linking error
#[derive(Clone, Debug, PartialEq)]
pub enum ProgramError {
    /// Unable to compile the vertex shader
    Vertex(core::CreateShaderError),
    /// Unable to compile the hull shader
    Hull(core::CreateShaderError),
    /// Unable to compile the domain shader
    Domain(core::CreateShaderError),
    /// Unable to compile the geometry shader
    Geometry(core::CreateShaderError),
    /// Unable to compile the pixel shader
    Pixel(core::CreateShaderError),
    /// Unable to link
    Link(core::CreateProgramError),
}

impl fmt::Display for ProgramError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match *self {
            ProgramError::Vertex(ref e) => write!(f, "{}: {}", self.description(), e),
            ProgramError::Hull(ref e) => write!(f, "{}: {}", self.description(), e),
            ProgramError::Domain(ref e) => write!(f, "{}: {}", self.description(), e),
            ProgramError::Geometry(ref e) => write!(f, "{}: {}", self.description(), e),
            ProgramError::Pixel(ref e) => write!(f, "{}: {}", self.description(), e),
            ProgramError::Link(ref e) => write!(f, "{}: {}", self.description(), e),
        }
    }
}

impl Error for ProgramError {
    fn description(&self) -> &str {
        match *self {
            ProgramError::Vertex(_) => "Unable to compile the vertex shader",
            ProgramError::Hull(_) => "Unable to compile the hull shader",
            ProgramError::Domain(_) => "Unable to compile the domain shader",
            ProgramError::Geometry(_) => "Unable to compile the geometry shader",
            ProgramError::Pixel(_) => "Unable to compile the pixel shader",
            ProgramError::Link(_) => "Unable to link",
        }
    }

    fn cause(&self) -> Option<&Error> {
        match *self {
            ProgramError::Vertex(ref e) => Some(e),
            ProgramError::Hull(ref e) => Some(e),
            ProgramError::Domain(ref e) => Some(e),
            ProgramError::Geometry(ref e) => Some(e),
            ProgramError::Pixel(ref e) => Some(e),
            ProgramError::Link(ref e) => Some(e),
        }
    }
}