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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
use crate::*;
use crate::ctypes::*;
use crate::d3d::*;
use crate::d3d11::*;
use std::ptr::*;
/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/d3d11shader/nn-d3d11shader-id3d11shaderreflection)\]
/// ID3D11ShaderReflection
///
/// A shader-reflection interface accesses shader information.
///
/// ### Example
/// ```rust
/// # use thindx::*;
/// let d3dc = d3d::Compiler::load_system(47).unwrap();
/// let vs = d3dc.compile_from_file(
/// r"test\data\basic.hlsl", None, None, "vs_main", "vs_4_0",
/// d3d::Compile::Debug, d3d::CompileEffect::None
/// ).unwrap();
/// let _vs : d3d11::ShaderReflection = d3dc.reflect(&vs).unwrap();
/// let vs = d3dc.reflect11(&vs).unwrap();
/// ```
///
/// ### See Also
/// * [d3d::Compiler::reflect]
/// * [d3d::Compiler::reflect11]
/// * [examples::d3dcompiler_04_reflect_shader]
#[derive(Clone)] #[repr(transparent)]
pub struct ShaderReflection(pub(crate) mcom::Rc<winapi::um::d3d11shader::ID3D11ShaderReflection>);
convert!(unsafe ShaderReflection => Unknown, winapi::um::d3d11shader::ID3D11ShaderReflection);
impl ShaderReflection {
/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/d3d11shader/nf-d3d11shader-id3d11shaderreflection-getbitwiseinstructioncount)\]
/// ID3D11ShaderReflection::GetBitwiseInstructionCount
///
/// Gets the number of bitwise instructions.
///
/// ### Example
/// ```rust
/// # use thindx::*;
/// # let d3dc = d3d::Compiler::load_system(47).unwrap();
/// # let vs = d3dc.compile_from_file(r"test\data\basic.hlsl", None, None, "vs_main", "vs_4_0", d3d::Compile::Debug, d3d::CompileEffect::None).unwrap();
/// # let vs = d3dc.reflect11(&vs).unwrap();
/// let count = vs.get_bitwise_instruction_count();
/// ```
pub fn get_bitwise_instruction_count(&self) -> u32 {
unsafe { self.0.GetBitwiseInstructionCount() }
}
/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/d3d11shader/nf-d3d11shader-id3d11shaderreflection-getconstantbufferbyindex)\]
/// ID3D11ShaderReflection::GetConstantBufferByIndex
///
/// Get a constant buffer by index.
///
/// ### Returns
/// * If the index is out of bounds, a stub object will still be returned. The stub object will return [E::FAIL] from most methods.
///
/// ### Example
/// ```rust
/// # use thindx::*;
/// # let d3dc = d3d::Compiler::load_system(47).unwrap();
/// # let vs = d3dc.compile_from_file(r"test\data\basic.hlsl", None, None, "vs_main", "vs_4_0", d3d::Compile::Debug, d3d::CompileEffect::None).unwrap();
/// # let vs = d3dc.reflect11(&vs).unwrap();
/// let cb0 = vs.get_constant_buffer_by_index(0);
/// let _ = cb0.get_desc().unwrap();
///
/// let cb1 = vs.get_constant_buffer_by_index(1);
/// assert_eq!(Some(E::FAIL), cb1.get_desc().err().map(|err| err.kind()));
/// #
/// # assert_eq!(Some(E::FAIL), vs.get_constant_buffer_by_index(100).get_desc().err().map(|err| err.kind()));
/// # assert_eq!(Some(E::FAIL), vs.get_constant_buffer_by_index(10000).get_desc().err().map(|err| err.kind()));
/// # assert_eq!(Some(E::FAIL), vs.get_constant_buffer_by_index(1000000).get_desc().err().map(|err| err.kind()));
/// # assert_eq!(Some(E::FAIL), vs.get_constant_buffer_by_index(!0-100).get_desc().err().map(|err| err.kind()));
/// # assert_eq!(Some(E::FAIL), vs.get_constant_buffer_by_index(!0-16).get_desc().err().map(|err| err.kind()));
/// # assert_eq!(Some(E::FAIL), vs.get_constant_buffer_by_index(!0-10).get_desc().err().map(|err| err.kind()));
/// # assert_eq!(Some(E::FAIL), vs.get_constant_buffer_by_index(!0-4).get_desc().err().map(|err| err.kind()));
/// # assert_eq!(Some(E::FAIL), vs.get_constant_buffer_by_index(!0-1).get_desc().err().map(|err| err.kind()));
/// # assert_eq!(Some(E::FAIL), vs.get_constant_buffer_by_index(!0).get_desc().err().map(|err| err.kind()));
/// ```
//#allow_missing_argument_docs
pub fn get_constant_buffer_by_index(&self, index: u32) -> ShaderReflectionConstantBuffer {
let ptr = unsafe { self.0.GetConstantBufferByIndex(index) };
unsafe { ShaderReflectionConstantBuffer::from_raw(self, ptr) }
}
/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/d3d11shader/nf-d3d11shader-id3d11shaderreflection-getconstantbufferbyname)\]
/// ID3D11ShaderReflection::GetConstantBufferByName
///
/// Get a constant buffer by name.
///
/// ### Returns
/// * If the name doesn't match a valid constant buffer, a stub object will still be returned. The stub object will return [E::FAIL] from most methods.
///
/// ### Example
/// ```rust
/// # use thindx::*;
/// # let d3dc = d3d::Compiler::load_system(47).unwrap();
/// # let vs = d3dc.compile_from_file(r"test\data\basic.hlsl", None, None, "vs_main", "vs_4_0", d3d::Compile::Debug, d3d::CompileEffect::None).unwrap();
/// # let vs = d3dc.reflect11(&vs).unwrap();
/// let cb0 = vs.get_constant_buffer_by_name("ExampleCBuffer");
/// let _ = cb0.get_desc().unwrap();
///
/// let cb1 = vs.get_constant_buffer_by_name("Invalid");
/// assert_eq!(Some(E::FAIL), cb1.get_desc().err().map(|err| err.kind()));
/// #
/// # assert_eq!(Some(E::FAIL), vs.get_constant_buffer_by_name("").get_desc().err().map(|err| err.kind()));
/// # assert_eq!(Some(E::FAIL), vs.get_constant_buffer_by_name("ExampleCBuffer\0").get_desc().err().map(|err| err.kind()));
/// ```
//#allow_missing_argument_docs
pub fn get_constant_buffer_by_name(&self, name: impl TryIntoAsCStr) -> ShaderReflectionConstantBuffer {
let name = name.try_into().ok();
let name = name.as_ref().map_or(cstr!("").as_cstr(), |n| n.as_cstr());
let ptr = unsafe { self.0.GetConstantBufferByName(name) };
unsafe { ShaderReflectionConstantBuffer::from_raw(self, ptr) }
}
/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/d3d11shader/nf-d3d11shader-id3d11shaderreflection-getconversioninstructioncount)\]
/// ID3D11ShaderReflection::GetConversionInstructionCount
///
/// Gets the number of conversion instructions.
///
/// ### Example
/// ```rust
/// # use thindx::*;
/// # let d3dc = d3d::Compiler::load_system(47).unwrap();
/// # let vs = d3dc.compile_from_file(r"test\data\basic.hlsl", None, None, "vs_main", "vs_4_0", d3d::Compile::Debug, d3d::CompileEffect::None).unwrap();
/// # let vs = d3dc.reflect11(&vs).unwrap();
/// let count : u32 = vs.get_conversion_instruction_count();
/// ```
pub fn get_conversion_instruction_count(&self) -> u32 {
unsafe { self.0.GetConversionInstructionCount() }
}
/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/d3d11shader/nf-d3d11shader-id3d11shaderreflection-getdesc)\]
/// ID3D11ShaderReflection::GetDesc
///
/// Get a shader description.
///
/// ### Errors
/// * ...perhaps [`E::FAIL`] if reflection was called on invalid or incompatible bytecode?
///
/// ### Example
/// ```rust
/// # use thindx::*;
/// # let d3dc = d3d::Compiler::load_system(47).unwrap();
/// # let vs = d3dc.compile_from_file(r"test\data\basic.hlsl", None, None, "vs_main", "vs_4_0", d3d::Compile::Debug, d3d::CompileEffect::None).unwrap();
/// # let vs = d3dc.reflect11(&vs).unwrap();
/// let desc = vs.get_desc().unwrap();
/// assert_eq!(desc.version.shver(), d3d11::ShVer::VertexShader);
/// assert_eq!(desc.version.major(), 4);
/// assert_eq!(desc.version.minor(), 0);
/// ```
pub fn get_desc(&self) -> Result<ShaderDesc, MethodError> {
let mut desc = ShaderDesc::default();
let hr = unsafe { self.0.GetDesc(desc.as_mut_ptr()) };
MethodError::check("ID3D11ShaderReflection::GetDesc", hr)?;
Ok(desc)
}
/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/d3d11shader/nf-d3d11shader-id3d11shaderreflection-getgsinputprimitive)\]
/// ID3D11ShaderReflection::GetGSInputPrimitive
///
/// Gets the geometry-shader input-primitive description.
///
/// ### Returns
/// * [`d3d::Primitive::Undefined`] if `self` is not a geometry shader
///
/// ### Example
/// ```rust
/// # use thindx::*;
/// # let d3dc = d3d::Compiler::load_system(47).unwrap();
/// # let vs = d3dc.compile_from_file(r"test\data\basic.hlsl", None, None, "vs_main", "vs_4_0", d3d::Compile::Debug, d3d::CompileEffect::None).unwrap();
/// # let vs = d3dc.reflect11(&vs).unwrap();
/// assert_eq!(vs.get_gs_input_primitive(), d3d::Primitive::Undefined);
/// ```
pub fn get_gs_input_primitive(&self) -> Primitive {
Primitive::from_unchecked(unsafe { self.0.GetGSInputPrimitive() })
}
/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/d3d11shader/nf-d3d11shader-id3d11shaderreflection-getinputparameterdesc)\]
/// ID3D11ShaderReflection::GetInputParameterDesc
///
/// Get an input-parameter description for a shader.
///
/// ### Errors
/// * [E::INVALIDARG] - if `parameter_index` >= `self.get_desc().unwrap().input_parameters`
///
/// ### Example
/// ```rust
/// # use thindx::*;
/// # let d3dc = d3d::Compiler::load_system(47).unwrap();
/// # let vs = d3dc.compile_from_file(r"test\data\basic.hlsl", None, None, "vs_main", "vs_4_0", d3d::Compile::Debug, d3d::CompileEffect::None).unwrap();
/// # let vs = d3dc.reflect11(&vs).unwrap();
/// assert_eq!(0, vs.get_input_parameter_desc(0).unwrap().semantic_index);
/// assert_eq!(0, vs.get_input_parameter_desc(1).unwrap().semantic_index);
/// assert_eq!(E::INVALIDARG, vs.get_input_parameter_desc(2).unwrap_err().kind());
/// # assert_eq!(E::INVALIDARG, vs.get_input_parameter_desc(100).unwrap_err().kind());
/// # assert_eq!(E::INVALIDARG, vs.get_input_parameter_desc(10000).unwrap_err().kind());
/// # assert_eq!(E::INVALIDARG, vs.get_input_parameter_desc(1000000).unwrap_err().kind());
/// # assert_eq!(E::INVALIDARG, vs.get_input_parameter_desc(!0-100).unwrap_err().kind());
/// # assert_eq!(E::INVALIDARG, vs.get_input_parameter_desc(!0-16).unwrap_err().kind());
/// # assert_eq!(E::INVALIDARG, vs.get_input_parameter_desc(!0-8).unwrap_err().kind());
/// # assert_eq!(E::INVALIDARG, vs.get_input_parameter_desc(!0-4).unwrap_err().kind());
/// # assert_eq!(E::INVALIDARG, vs.get_input_parameter_desc(!0-1).unwrap_err().kind());
/// # assert_eq!(E::INVALIDARG, vs.get_input_parameter_desc(!0).unwrap_err().kind());
/// ```
//#allow_missing_argument_docs
pub fn get_input_parameter_desc(&self, parameter_index: u32) -> Result<SignatureParameterDesc, MethodError> {
let mut desc = SignatureParameterDesc::default();
let hr = unsafe { self.0.GetInputParameterDesc(parameter_index, desc.as_mut_ptr()) };
MethodError::check("ID3D11ShaderReflection::GetInputParameterDesc", hr)?;
Ok(desc)
}
/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/d3d11shader/nf-d3d11shader-id3d11shaderreflection-getminfeaturelevel)\]
/// ID3D11ShaderReflection::GetMinFeatureLevel
///
/// Gets the minimum feature level.
///
/// ### Errors
/// * ...?
///
/// ### Example
/// ```rust
/// # use thindx::*;
/// # let d3dc = d3d::Compiler::load_system(47).unwrap();
/// # let vs = d3dc.compile_from_file(r"test\data\basic.hlsl", None, None, "vs_main", "vs_4_0", d3d::Compile::Debug, d3d::CompileEffect::None).unwrap();
/// # let vs = d3dc.reflect11(&vs).unwrap();
/// assert_eq!(vs.get_min_feature_level().unwrap(), d3d::FeatureLevel::_10_0);
/// ```
pub fn get_min_feature_level(&self) -> Result<FeatureLevel, MethodError> {
let mut fl = 0;
let hr = unsafe { self.0.GetMinFeatureLevel(&mut fl) };
MethodError::check("ID3D11ShaderReflection::GetMinFeatureLevel", hr)?;
Ok(FeatureLevel::from_unchecked(fl))
}
/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/d3d11shader/nf-d3d11shader-id3d11shaderreflection-getmovcinstructioncount)\]
/// ID3D11ShaderReflection::GetMovcInstructionCount
///
/// Gets the number of Movc instructions.
///
/// ### Example
/// ```rust
/// # use thindx::*;
/// # let d3dc = d3d::Compiler::load_system(47).unwrap();
/// # let vs = d3dc.compile_from_file(r"test\data\basic.hlsl", None, None, "vs_main", "vs_4_0", d3d::Compile::Debug, d3d::CompileEffect::None).unwrap();
/// # let vs = d3dc.reflect11(&vs).unwrap();
/// let count = vs.get_movc_instruction_count();
/// ```
pub fn get_movc_instruction_count(&self) -> u32 {
unsafe { self.0.GetMovcInstructionCount() }
}
/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/d3d11shader/nf-d3d11shader-id3d11shaderreflection-getmovinstructioncount)\]
/// ID3D11ShaderReflection::GetMovInstructionCount
///
/// Gets the number of Mov instructions.
///
/// ### Example
/// ```rust
/// # use thindx::*;
/// # let d3dc = d3d::Compiler::load_system(47).unwrap();
/// # let vs = d3dc.compile_from_file(r"test\data\basic.hlsl", None, None, "vs_main", "vs_4_0", d3d::Compile::Debug, d3d::CompileEffect::None).unwrap();
/// # let vs = d3dc.reflect11(&vs).unwrap();
/// let count : u32 = vs.get_mov_instruction_count();
/// ```
pub fn get_mov_instruction_count(&self) -> u32 {
unsafe { self.0.GetMovInstructionCount() }
}
/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/d3d11shader/nf-d3d11shader-id3d11shaderreflection-getnuminterfaceslots)\]
/// ID3D11ShaderReflection::GetNumInterfaceSlots
///
/// Gets the number of interface slots in a shader.
///
/// ### Example
/// ```rust
/// # use thindx::*;
/// # let d3dc = d3d::Compiler::load_system(47).unwrap();
/// # let vs = d3dc.compile_from_file(r"test\data\basic.hlsl", None, None, "vs_main", "vs_4_0", d3d::Compile::Debug, d3d::CompileEffect::None).unwrap();
/// # let vs = d3dc.reflect11(&vs).unwrap();
/// let slots : u32 = vs.get_num_interface_slots();
/// ```
pub fn get_num_interface_slots(&self) -> u32 {
unsafe { self.0.GetNumInterfaceSlots() }
}
/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/d3d11shader/nf-d3d11shader-id3d11shaderreflection-getoutputparameterdesc)\]
/// ID3D11ShaderReflection::GetOutputParameterDesc
///
/// Get an output-parameter description for a shader.
///
/// ### Errors
/// * [E::INVALIDARG] - if `parameter_index` >= `self.get_desc().unwrap().output_parameters`
///
/// ### Example
/// ```rust
/// # use thindx::*;
/// # let d3dc = d3d::Compiler::load_system(47).unwrap();
/// # let vs = d3dc.compile_from_file(r"test\data\basic.hlsl", None, None, "vs_main", "vs_4_0", d3d::Compile::Debug, d3d::CompileEffect::None).unwrap();
/// # let vs = d3dc.reflect11(&vs).unwrap();
/// assert_eq!(0, vs.get_output_parameter_desc(0).unwrap().semantic_index);
/// assert_eq!(0, vs.get_output_parameter_desc(1).unwrap().semantic_index);
/// assert_eq!(E::INVALIDARG, vs.get_output_parameter_desc(2).unwrap_err().kind());
/// # assert_eq!(E::INVALIDARG, vs.get_output_parameter_desc(100).unwrap_err().kind());
/// # assert_eq!(E::INVALIDARG, vs.get_output_parameter_desc(10000).unwrap_err().kind());
/// # assert_eq!(E::INVALIDARG, vs.get_output_parameter_desc(1000000).unwrap_err().kind());
/// # assert_eq!(E::INVALIDARG, vs.get_output_parameter_desc(!0-100).unwrap_err().kind());
/// # assert_eq!(E::INVALIDARG, vs.get_output_parameter_desc(!0-16).unwrap_err().kind());
/// # assert_eq!(E::INVALIDARG, vs.get_output_parameter_desc(!0-8).unwrap_err().kind());
/// # assert_eq!(E::INVALIDARG, vs.get_output_parameter_desc(!0-4).unwrap_err().kind());
/// # assert_eq!(E::INVALIDARG, vs.get_output_parameter_desc(!0-1).unwrap_err().kind());
/// # assert_eq!(E::INVALIDARG, vs.get_output_parameter_desc(!0).unwrap_err().kind());
/// ```
//#allow_missing_argument_docs
pub fn get_output_parameter_desc(&self, parameter_index: u32) -> Result<SignatureParameterDesc, MethodError> {
let mut desc = SignatureParameterDesc::default();
let hr = unsafe { self.0.GetOutputParameterDesc(parameter_index, desc.as_mut_ptr()) };
MethodError::check("ID3D11ShaderReflection::GetOutputParameterDesc", hr)?;
Ok(desc)
}
/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/d3d11shader/nf-d3d11shader-id3d11shaderreflection-getpatchconstantparameterdesc)\]
/// ID3D11ShaderReflection::GetPatchConstantParameterDesc
///
/// Get a patch-constant parameter description for a shader.
///
/// ### Errors
/// * [E::INVALIDARG] - if `parameter_index` >= `self.get_desc().unwrap().patch_constant_parameters`
///
/// ### Example
/// ```rust
/// # use thindx::*;
/// # let d3dc = d3d::Compiler::load_system(47).unwrap();
/// # let vs = d3dc.compile_from_file(r"test\data\basic.hlsl", None, None, "vs_main", "vs_4_0", d3d::Compile::Debug, d3d::CompileEffect::None).unwrap();
/// # let vs = d3dc.reflect11(&vs).unwrap();
/// // TODO: proper examples
/// assert_eq!(E::INVALIDARG, vs.get_patch_constant_parameter_desc(2).unwrap_err().kind());
/// # assert_eq!(E::INVALIDARG, vs.get_patch_constant_parameter_desc(100).unwrap_err().kind());
/// # assert_eq!(E::INVALIDARG, vs.get_patch_constant_parameter_desc(10000).unwrap_err().kind());
/// # assert_eq!(E::INVALIDARG, vs.get_patch_constant_parameter_desc(1000000).unwrap_err().kind());
/// # assert_eq!(E::INVALIDARG, vs.get_patch_constant_parameter_desc(!0-100).unwrap_err().kind());
/// # assert_eq!(E::INVALIDARG, vs.get_patch_constant_parameter_desc(!0-16).unwrap_err().kind());
/// # assert_eq!(E::INVALIDARG, vs.get_patch_constant_parameter_desc(!0-8).unwrap_err().kind());
/// # assert_eq!(E::INVALIDARG, vs.get_patch_constant_parameter_desc(!0-4).unwrap_err().kind());
/// # assert_eq!(E::INVALIDARG, vs.get_patch_constant_parameter_desc(!0-1).unwrap_err().kind());
/// # assert_eq!(E::INVALIDARG, vs.get_patch_constant_parameter_desc(!0).unwrap_err().kind());
/// ```
//#allow_missing_argument_docs
pub fn get_patch_constant_parameter_desc(&self, parameter_index: u32) -> Result<SignatureParameterDesc, MethodError> {
let mut desc = SignatureParameterDesc::default();
let hr = unsafe { self.0.GetPatchConstantParameterDesc(parameter_index, desc.as_mut_ptr()) };
MethodError::check("ID3D11ShaderReflection::GetPatchConstantParameterDesc", hr)?;
Ok(desc)
}
/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/d3d11shader/nf-d3d11shader-id3d11shaderreflection-getrequiresflags)\]
/// ID3D11ShaderReflection::GetRequiresFlags
///
/// Gets a group of flags that indicates the requirements of a shader.
///
/// ### Example
/// ```rust
/// # use thindx::*;
/// # let d3dc = d3d::Compiler::load_system(47).unwrap();
/// # let vs = d3dc.compile_from_file(r"test\data\basic.hlsl", None, None, "vs_main", "vs_4_0", d3d::Compile::Debug, d3d::CompileEffect::None).unwrap();
/// # let vs = d3dc.reflect11(&vs).unwrap();
/// assert_eq!(vs.get_requires_flags(), d3d::ShaderRequires::None);
/// ```
pub fn get_requires_flags(&self) -> ShaderRequires {
ShaderRequires::from_unchecked(unsafe { self.0.GetRequiresFlags() })
}
/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/d3d11shader/nf-d3d11shader-id3d11shaderreflection-getresourcebindingdesc)\]
/// ID3D11ShaderReflection::GetResourceBindingDesc
///
/// Get a description of how a resource is bound to a shader.
///
/// ### Errors
/// * [E::INVALIDARG] - if `resource_index` >= `self.get_desc().unwrap().bound_resources`
///
/// ### Example
/// ```rust
/// # use thindx::*;
/// # let d3dc = d3d::Compiler::load_system(47).unwrap();
/// # let vs = d3dc.compile_from_file(r"test\data\basic.hlsl", None, None, "vs_main", "vs_4_0", d3d::Compile::Debug, d3d::CompileEffect::None).unwrap();
/// # let vs = d3dc.reflect11(&vs).unwrap();
/// let ex = vs.get_resource_binding_desc(0).unwrap();
/// assert_eq!(ex.ty, d3d::SIT::CBuffer);
///
/// let err = vs.get_resource_binding_desc(1).err().unwrap().kind();
/// assert_eq!(err, E::INVALIDARG);
/// #
/// # assert_eq!(vs.get_resource_binding_desc(100).err().unwrap().kind(), E::INVALIDARG);
/// # assert_eq!(vs.get_resource_binding_desc(10000).err().unwrap().kind(), E::INVALIDARG);
/// # assert_eq!(vs.get_resource_binding_desc(1000000).err().unwrap().kind(), E::INVALIDARG);
/// # assert_eq!(vs.get_resource_binding_desc(!0-100).err().unwrap().kind(), E::INVALIDARG);
/// # assert_eq!(vs.get_resource_binding_desc(!0-16).err().unwrap().kind(), E::INVALIDARG);
/// # assert_eq!(vs.get_resource_binding_desc(!0-10).err().unwrap().kind(), E::INVALIDARG);
/// # assert_eq!(vs.get_resource_binding_desc(!0-8).err().unwrap().kind(), E::INVALIDARG);
/// # assert_eq!(vs.get_resource_binding_desc(!0-4).err().unwrap().kind(), E::INVALIDARG);
/// # assert_eq!(vs.get_resource_binding_desc(!0-1).err().unwrap().kind(), E::INVALIDARG);
/// # assert_eq!(vs.get_resource_binding_desc(!0).err().unwrap().kind(), E::INVALIDARG);
/// ```
//#allow_missing_argument_docs
pub fn get_resource_binding_desc(&self, resource_index: u32) -> Result<ShaderInputBindDesc, MethodError> {
let mut desc = ShaderInputBindDesc::default();
let hr = unsafe { self.0.GetResourceBindingDesc(resource_index, desc.as_mut_ptr()) };
MethodError::check("ID3D11ShaderReflection::GetResourceBindingDesc", hr)?;
Ok(desc)
}
/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/d3d11shader/nf-d3d11shader-id3d11shaderreflection-getresourcebindingdescbyname)\]
/// ID3D11ShaderReflection::GetResourceBindingDescByName
///
/// Get a description of how a resource is bound to a shader.
///
/// ### Errors
/// * [E::INVALIDARG] - If `name` doesn't name a valid resource binding for the shader
///
/// ### Example
/// ```rust
/// # use thindx::*;
/// # let d3dc = d3d::Compiler::load_system(47).unwrap();
/// # let vs = d3dc.compile_from_file(r"test\data\basic.hlsl", None, None, "vs_main", "vs_4_0", d3d::Compile::Debug, d3d::CompileEffect::None).unwrap();
/// # let vs = d3dc.reflect11(&vs).unwrap();
/// let ex = vs.get_resource_binding_desc_by_name("ExampleCBuffer").unwrap();
/// assert_eq!(ex.ty, d3d::SIT::CBuffer);
///
/// let err = vs.get_resource_binding_desc_by_name("Invalid").err().unwrap().kind();
/// assert_eq!(err, E::INVALIDARG);
/// #
/// # assert_eq!(vs.get_resource_binding_desc_by_name("ExampleCBuffer\0").err().unwrap().kind(), E::INVALIDARG);
/// # assert_eq!(vs.get_resource_binding_desc_by_name("").err().unwrap().kind(), E::INVALIDARG);
/// ```
//#allow_missing_argument_docs
pub fn get_resource_binding_desc_by_name(&self, name: impl TryIntoAsCStr) -> Result<ShaderInputBindDesc, MethodError> {
let name = name.try_into();
let name = name.as_ref().map_or(null(), |name| name.as_cstr());
let mut desc = ShaderInputBindDesc::default();
let hr = unsafe { self.0.GetResourceBindingDescByName(name, desc.as_mut_ptr()) };
MethodError::check("ID3D11ShaderReflection::GetResourceBindingDescByName", hr)?;
Ok(desc)
}
/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/d3d11shader/nf-d3d11shader-id3d11shaderreflection-getthreadgroupsize)\]
/// ID3D11ShaderReflection::GetThreadGroupSize
///
/// Retrieves the sizes, in units of threads, of the X, Y, and Z dimensions of the shader's thread-group grid.
///
/// ### Returns
/// * `(0, 0, 0)` if not specified
///
/// ### Example
/// ```rust
/// # use thindx::*;
/// # let d3dc = d3d::Compiler::load_system(47).unwrap();
/// # let vs = d3dc.compile_from_file(r"test\data\basic.hlsl", None, None, "vs_main", "vs_4_0", d3d::Compile::Debug, d3d::CompileEffect::None).unwrap();
/// # let vs = d3dc.reflect11(&vs).unwrap();
/// assert_eq!(vs.get_thread_group_size(), (0, 0, 0));
/// ```
pub fn get_thread_group_size(&self) -> (u32, u32, u32) {
let (mut x, mut y, mut z) = (0, 0, 0);
let _total = unsafe { self.0.GetThreadGroupSize(&mut x, &mut y, &mut z) };
debug_assert_eq!(_total, x*y*z, "ID3D11ShaderReflection::GetThreadGroupSize was supposed to return x*y*z");
(x, y, z)
}
/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/d3d11shader/nf-d3d11shader-id3d11shaderreflection-getvariablebyname)\]
/// ID3D11ShaderReflection::GetVariableByName
///
/// Gets a variable by name.
///
/// ### Returns
/// * If `name` doesn't name a valid cbuffer variable, a stub object will still be returned. The stub object will return [E::FAIL] from most methods.
///
/// ### Example
/// ```rust
/// # use thindx::*;
/// # let d3dc = d3d::Compiler::load_system(47).unwrap();
/// # let vs = d3dc.compile_from_file(r"test\data\basic.hlsl", None, None, "vs_main", "vs_4_0", d3d::Compile::Debug, d3d::CompileEffect::None).unwrap();
/// # let vs = d3dc.reflect11(&vs).unwrap();
/// let tint = vs.get_variable_by_name("tint").get_desc().unwrap();
/// assert_eq!(tint.start_offset, 0, "unexpected tint.start_offset");
/// assert_eq!(tint.size, 16, "unexpected tint.size");
///
/// let invalid = vs.get_variable_by_name("invalid").get_desc().unwrap_err();
/// assert_eq!(invalid.kind(), E::FAIL);
/// #
/// # assert_eq!(vs.get_variable_by_name("tint\0").get_desc().unwrap_err().kind(), E::FAIL);
/// # assert_eq!(vs.get_variable_by_name("").get_desc().unwrap_err().kind(), E::FAIL);
/// ```
//#allow_missing_argument_docs
pub fn get_variable_by_name(&self, name: impl TryIntoAsCStr) -> ShaderReflectionVariable {
let name = name.try_into().ok();
let name = name.as_ref().map_or(cstr!("").as_cstr(), |n| n.as_cstr());
let ptr = unsafe { self.0.GetVariableByName(name) };
unsafe { ShaderReflectionVariable::from_raw(self, ptr) }
}
/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/d3d11shader/nf-d3d11shader-id3d11shaderreflection-issamplefrequencyshader)\]
/// ID3D11ShaderReflection::IsSampleFrequencyShader
///
/// Indicates whether a shader is a sample frequency shader.
///
/// ### Example
/// ```rust
/// # use thindx::*;
/// # let d3dc = d3d::Compiler::load_system(47).unwrap();
/// # let vs = d3dc.compile_from_file(r"test\data\basic.hlsl", None, None, "vs_main", "vs_4_0", d3d::Compile::Debug, d3d::CompileEffect::None).unwrap();
/// # let vs = d3dc.reflect11(&vs).unwrap();
/// assert_eq!(vs.is_sample_frequency_shader(), false);
/// ```
pub fn is_sample_frequency_shader(&self) -> bool {
0 != unsafe { self.0.IsSampleFrequencyShader() }
}
}