gli-rs 0.3.1

Rust binding for OpenGL Image(GLI)
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


use crate::ffi::root::gli;
use crate::format::Format;

use std::fmt;


#[derive(Debug, Clone, Eq, PartialEq)]
pub struct Target(pub(crate) gli::target);

impl Target {

    /// Check whether a target is a 1D target.
    #[inline]
    pub fn is_target_1d(&self) -> bool {
        match *self {
            | Target::TARGET_1D
            | Target::TARGET_1D_ARRAY => true,
            | _ => false,
        }
    }

    /// Check whether a target is an array target.
    #[inline]
    pub fn is_target_array(&self) -> bool {
        match *self {
            | Target::TARGET_1D_ARRAY
            | Target::TARGET_2D_ARRAY
            | Target::TARGET_CUBE_ARRAY => true,
            | _ => false
        }
    }

    /// Check whether a target is a cube map target.
    #[inline]
    pub fn is_target_cube(&self) -> bool {
        match *self {
            | Target::TARGET_CUBE
            | Target::TARGET_CUBE_ARRAY => true,
            | _ => false,
        }
    }

    /// Check whether a target is a rectangle target.
    #[inline]
    pub fn is_target_rect(&self) -> bool {
        match *self {
            | Target::TARGET_RECT
            | Target::TARGET_RECT_ARRAY => true,
            | _ => false,
        }
    }
}

impl Target {
    pub const TARGET_FIRST      : Target = Target(gli::target_TARGET_FIRST);
    pub const TARGET_1D         : Target = Target(gli::target_TARGET_1D);
    pub const TARGET_1D_ARRAY   : Target = Target(gli::target_TARGET_1D_ARRAY);
    pub const TARGET_2D         : Target = Target(gli::target_TARGET_2D);
    pub const TARGET_2D_ARRAY   : Target = Target(gli::target_TARGET_2D_ARRAY);
    pub const TARGET_3D         : Target = Target(gli::target_TARGET_3D);
    pub const TARGET_RECT       : Target = Target(gli::target_TARGET_RECT);
    pub const TARGET_RECT_ARRAY : Target = Target(gli::target_TARGET_RECT_ARRAY);
    pub const TARGET_CUBE       : Target = Target(gli::target_TARGET_CUBE);
    pub const TARGET_CUBE_ARRAY : Target = Target(gli::target_TARGET_CUBE_ARRAY);
    pub const TARGET_LAST       : Target = Target(gli::target_TARGET_LAST);
}

impl fmt::Display for Target {

    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match *self {
            | Target::TARGET_1D         => write!(f, stringify!(Target::TARGET_1D        )),
            | Target::TARGET_1D_ARRAY   => write!(f, stringify!(Target::TARGET_1D_ARRAY  )),
            | Target::TARGET_2D         => write!(f, stringify!(Target::TARGET_2D        )),
            | Target::TARGET_2D_ARRAY   => write!(f, stringify!(Target::TARGET_2D_ARRAY  )),
            | Target::TARGET_3D         => write!(f, stringify!(Target::TARGET_3D        )),
            | Target::TARGET_RECT       => write!(f, stringify!(Target::TARGET_RECT      )),
            | Target::TARGET_RECT_ARRAY => write!(f, stringify!(Target::TARGET_RECT_ARRAY)),
            | Target::TARGET_CUBE       => write!(f, stringify!(Target::TARGET_CUBE      )),
            | Target::TARGET_CUBE_ARRAY => write!(f, stringify!(Target::TARGET_CUBE_ARRAY)),
            | _ => write!(f, "Unknown target"),
        }
    }
}

/// Evaluate whether a target and format combinaison is only supported by the DDS container through GLI DDS extension.
pub fn is_dds_ext(target: Target, fmt: Format) -> bool {
    unsafe {
        crate::ffi::root::bindings::DX::is_dds_ext(target.0, fmt.0)
    }
}