thindx 0.0.0-unsound.5

Thin DirectX wrappers
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
131
132
133
134
135
136
137
138
139
140

#[allow(unused_imports)] use crate::*;

use winapi::um::d3dcompiler::*;

const D3D_BLOB_DEBUG_NAME : D3D_BLOB_PART = 12; // not part of winapi 0.3.9



/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/d3dcompiler/ne-d3dcompiler-d3d_blob_part)\]
/// D3D_BLOB_PART
///
/// Values that identify parts of the content of an arbitrary length data buffer.
///
/// ### Remarks
/// These values are passed to the [d3d::Compiler::get_blob_part] or [d3d::Compiler::set_blob_part] functions.
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(transparent)] pub struct BlobPart(D3D_BLOB_PART);
#[doc(hidden)] pub use BlobPart as Blob;

enumish! {
    BlobPart => D3D_BLOB_PART;
    InputSignatureBlob, OutputSignatureBlob, InputAndOutputSignatureBlob, PatchConstantSignatureBlob, AllSignatureBlob,
    DebugInfo, LegacyShader, XnaPrepassShader, XnaShader, Pdb, PrivateData, RootSignature, DebugName,
    TestAlternateShader, TestCompileDetails, TestCompilePerf, TestCompileReport,
}

#[allow(missing_docs)]
#[allow(non_upper_case_globals)] impl Blob { // These are enum-like
    pub const InputSignatureBlob               : Blob = Blob(D3D_BLOB_INPUT_SIGNATURE_BLOB);
    pub const OutputSignatureBlob              : Blob = Blob(D3D_BLOB_OUTPUT_SIGNATURE_BLOB);
    pub const InputAndOutputSignatureBlob      : Blob = Blob(D3D_BLOB_INPUT_AND_OUTPUT_SIGNATURE_BLOB);
    pub const PatchConstantSignatureBlob       : Blob = Blob(D3D_BLOB_PATCH_CONSTANT_SIGNATURE_BLOB);
    pub const AllSignatureBlob                 : Blob = Blob(D3D_BLOB_ALL_SIGNATURE_BLOB);
    pub const DebugInfo                        : Blob = Blob(D3D_BLOB_DEBUG_INFO);
    pub const LegacyShader                     : Blob = Blob(D3D_BLOB_LEGACY_SHADER);
    pub const XnaPrepassShader                 : Blob = Blob(D3D_BLOB_XNA_PREPASS_SHADER);
    pub const XnaShader                        : Blob = Blob(D3D_BLOB_XNA_SHADER);

    /// The blob part is program database (PDB) information.
    ///
    /// ### Remarks
    /// *   This was introduced by d3dcompiler_44.dll, and is unavailable in earlier versions.
    pub const Pdb                              : Blob = Blob(D3D_BLOB_PDB);

    /// The blob part is private data.
    ///
    /// ### Remarks
    /// *   This was introduced by d3dcompiler_44.dll, and is unavailable in earlier versions.
    pub const PrivateData                      : Blob = Blob(D3D_BLOB_PRIVATE_DATA);

    /// The blob part is a root signature. Refer to [Specifying Root Signatures in HLSL] for more information on using Direct3D12 with HLSL.
    ///
    /// [Specifying Root Signatures in HLSL]:   https://docs.microsoft.com/en-us/windows/desktop/direct3d12/specifying-root-signatures-in-hlsl
    ///
    /// ### Remarks
    /// *   This was introduced by d3dcompiler_47.dll, and is unavailable in earlier versions.
    pub const RootSignature                    : Blob = Blob(D3D_BLOB_ROOT_SIGNATURE);

    /// The blob part is the debug name of the shader. If the application does not specify the debug name itself,
    /// an auto-generated name matching the PDB file of the shader is provided instead.
    ///
    /// ### Remarks
    /// *   This was introduced by d3dcompiler_47.dll, and is unavailable in earlier versions.
    pub const DebugName                        : Blob = Blob(D3D_BLOB_DEBUG_NAME);

    /// ### Remarks
    /// *   This requires a special test version of d3dcompiler.
    pub const TestAlternateShader              : Blob = Blob(D3D_BLOB_TEST_ALTERNATE_SHADER);

    /// ### Remarks
    /// *   This requires a special test version of d3dcompiler.
    pub const TestCompileDetails               : Blob = Blob(D3D_BLOB_TEST_COMPILE_DETAILS);

    /// ### Remarks
    /// *   This requires a special test version of d3dcompiler.
    pub const TestCompilePerf                  : Blob = Blob(D3D_BLOB_TEST_COMPILE_PERF);

    /// ### Remarks
    /// *   This requires a special test version of d3dcompiler.
    pub const TestCompileReport                : Blob = Blob(D3D_BLOB_TEST_COMPILE_REPORT);
}

#[doc(hidden)] impl Blob { // Ctrl+C Ctrl+V support
    pub const INPUT_SIGNATURE_BLOB             : Blob = Blob(D3D_BLOB_INPUT_SIGNATURE_BLOB);
    pub const OUTPUT_SIGNATURE_BLOB            : Blob = Blob(D3D_BLOB_OUTPUT_SIGNATURE_BLOB);
    pub const INPUT_AND_OUTPUT_SIGNATURE_BLOB  : Blob = Blob(D3D_BLOB_INPUT_AND_OUTPUT_SIGNATURE_BLOB);
    pub const PATCH_CONSTANT_SIGNATURE_BLOB    : Blob = Blob(D3D_BLOB_PATCH_CONSTANT_SIGNATURE_BLOB);
    pub const ALL_SIGNATURE_BLOB               : Blob = Blob(D3D_BLOB_ALL_SIGNATURE_BLOB);
    pub const DEBUG_INFO                       : Blob = Blob(D3D_BLOB_DEBUG_INFO);
    pub const LEGACY_SHADER                    : Blob = Blob(D3D_BLOB_LEGACY_SHADER);
    pub const XNA_PREPASS_SHADER               : Blob = Blob(D3D_BLOB_XNA_PREPASS_SHADER);
    pub const XNA_SHADER                       : Blob = Blob(D3D_BLOB_XNA_SHADER);

    /// The blob part is program database (PDB) information.
    ///
    /// ### Remarks
    /// *   This was introduced by d3dcompiler_44.dll, and is unavailable in earlier versions.
    pub const PDB                              : Blob = Blob(D3D_BLOB_PDB);

    /// The blob part is private data.
    ///
    /// ### Remarks
    /// *   This was introduced by d3dcompiler_44.dll, and is unavailable in earlier versions.
    pub const PRIVATE_DATA                     : Blob = Blob(D3D_BLOB_PRIVATE_DATA);

    /// The blob part is a root signature. Refer to [Specifying Root Signatures in HLSL] for more information on using Direct3D12 with HLSL.
    ///
    /// [Specifying Root Signatures in HLSL]:   https://docs.microsoft.com/en-us/windows/desktop/direct3d12/specifying-root-signatures-in-hlsl
    ///
    /// ### Remarks
    /// *   This was introduced by d3dcompiler_47.dll, and is unavailable in earlier versions.
    pub const ROOT_SIGNATURE                   : Blob = Blob(D3D_BLOB_ROOT_SIGNATURE);

    /// The blob part is the debug name of the shader. If the application does not specify the debug name itself,
    /// an auto-generated name matching the PDB file of the shader is provided instead.
    ///
    /// ### Remarks
    /// *   This was introduced by d3dcompiler_47.dll, and is unavailable in earlier versions.
    pub const DEBUG_NAME                       : Blob = Blob(D3D_BLOB_DEBUG_NAME);

    /// ### Remarks
    /// *   This requires a special test version of d3dcompiler.
    pub const TEST_ALTERNATE_SHADER            : Blob = Blob(D3D_BLOB_TEST_ALTERNATE_SHADER);

    /// ### Remarks
    /// *   This requires a special test version of d3dcompiler.
    pub const TEST_COMPILE_DETAILS             : Blob = Blob(D3D_BLOB_TEST_COMPILE_DETAILS);

    /// ### Remarks
    /// *   This requires a special test version of d3dcompiler.
    pub const TEST_COMPILE_PERF                : Blob = Blob(D3D_BLOB_TEST_COMPILE_PERF);

    /// ### Remarks
    /// *   This requires a special test version of d3dcompiler.
    pub const TEST_COMPILE_REPORT              : Blob = Blob(D3D_BLOB_TEST_COMPILE_REPORT);
}

impl Default for Blob {
    fn default() -> Self { Blob(0) }
}