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

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

//! Render target specification.

use std::fmt;

// TODO: Really tighten up the terminology here.

/// A depth value, specifying which plane to select out of a 3D texture.
pub type Layer = u16;
/// Mipmap level to select in a texture.
pub type Level = u8;
/// A single depth value from a depth buffer.
pub type Depth = f32;
/// A single value from a stencil stencstencil buffer.
pub type Stencil = u8;

/// A screen space rectangle
#[allow(missing_docs)]
#[derive(Copy, Clone, PartialEq, Debug)]
pub struct Rect {
    pub x: u16,
    pub y: u16,
    pub w: u16,
    pub h: u16,
}

/// A color with floating-point components.
pub type ColorValue = [f32; 4];

bitflags!(
    /// Output mask, used for blitting and clearing
    flags Mask: u8 {
        const COLOR     = 0x01,
        const COLOR0    = 0x01,
        const COLOR1    = 0x02,
        const COLOR2    = 0x04,
        const COLOR3    = 0x08,
        const DEPTH     = 0x40,
        const STENCIL   = 0x80
    }
);

impl fmt::Debug for Mask {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "Mask({})", self.bits())
    }
}

bitflags!(
    /// Mirroring flags, used for blitting
    #[derive(Debug)]
    flags Mirror: u8 {
        const MIRROR_X  = 0x01,
        const MIRROR_Y  = 0x02,
    }
);

/// How to clear a frame.
#[derive(Copy)]
pub struct ClearData {
    /// The color to clear the frame with
    pub color: ColorValue,
    /// The depth value to clear the frame with
    pub depth: Depth,
    /// The stencil value to clear the frame with
    pub stencil: Stencil,
}

impl Clone for ClearData {
    fn clone(&self) -> ClearData {
        ClearData {
            color: self.color,
            depth: self.depth,
            stencil: self.stencil,
        }
    }
}

impl fmt::Debug for ClearData {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f,
            "ClearData {{ color: {:?}, depth: {:?}, stencil: {:?} }}",
            &self.color[..], self.depth, self.stencil)
    }
}