Debian Codegraph @

media_driver/agnostic/gen11/hw/mhw_state_heap_hwcmd_g11_X.h

raw
1 /*
2 * Copyright (c) 2017, Intel Corporation
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included
12 * in all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
18 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20 * OTHER DEALINGS IN THE SOFTWARE.
21 */
22 //!
23 //! \file mhw_state_heap_hwcmd_g11_X.h
24 //! \brief Auto-generated constructors for MHW and states.
25 //! \details This file may not be included outside of g11_X as other components
26 //! should use MHW interface to interact with MHW commands and states.
27 //!
28 #ifndef __MHW_STATE_HEAP_HWCMD_G11_X_H__
29 #define __MHW_STATE_HEAP_HWCMD_G11_X_H__
30
31 #pragma once
32 #include <cstdint>
33 #include <cstddef>
34
35
36 #pragma pack(1)
37
38 class mhw_state_heap_g11_X
39 {
40 public:
41 // Internal Macros
42 #define __CODEGEN_MAX(_a, _b) (((_a) > (_b)) ? (_a) : (_b))
43 #define __CODEGEN_BITFIELD(l, h) (h) - (l) + 1
44 #define __CODEGEN_OP_LENGTH_BIAS 2
45 #define __CODEGEN_OP_LENGTH(x) (uint32_t)((__CODEGEN_MAX(x, __CODEGEN_OP_LENGTH_BIAS)) - __CODEGEN_OP_LENGTH_BIAS)
46
47 static uint32_t GetOpLength(uint32_t uiLength) { return __CODEGEN_OP_LENGTH(uiLength); }
48
49 //!
50 //! \brief INTERFACE_DESCRIPTOR_DATA
51 //! \details
52 //!
53 //!
54 struct INTERFACE_DESCRIPTOR_DATA_CMD
55 {
56 union
57 {
58 //!< DWORD 0
59 struct
60 {
61 uint32_t Reserved0 : __CODEGEN_BITFIELD( 0, 5) ; //!< Reserved
62 uint32_t KernelStartPointer : __CODEGEN_BITFIELD( 6, 31) ; //!< Kernel Start Pointer
63 };
64 uint32_t Value;
65 } DW0;
66 union
67 {
68 //!< DWORD 1
69 struct
70 {
71 uint32_t KernelStartPointerHigh : __CODEGEN_BITFIELD( 0, 15) ; //!< Kernel Start Pointer High
72 uint32_t Reserved48 : __CODEGEN_BITFIELD(16, 31) ; //!< Reserved
73 };
74 uint32_t Value;
75 } DW1;
76 union
77 {
78 //!< DWORD 2
79 struct
80 {
81 uint32_t Reserved64 : __CODEGEN_BITFIELD( 0, 6) ; //!< Reserved
82 uint32_t SoftwareExceptionEnable : __CODEGEN_BITFIELD( 7, 7) ; //!< Software Exception Enable
83 uint32_t Reserved72 : __CODEGEN_BITFIELD( 8, 10) ; //!< Reserved
84 uint32_t MaskStackExceptionEnable : __CODEGEN_BITFIELD(11, 11) ; //!< Mask Stack Exception Enable
85 uint32_t Reserved76 : __CODEGEN_BITFIELD(12, 12) ; //!< Reserved
86 uint32_t IllegalOpcodeExceptionEnable : __CODEGEN_BITFIELD(13, 13) ; //!< Illegal Opcode Exception Enable
87 uint32_t Reserved78 : __CODEGEN_BITFIELD(14, 15) ; //!< Reserved
88 uint32_t FloatingPointMode : __CODEGEN_BITFIELD(16, 16) ; //!< FLOATING_POINT_MODE
89 uint32_t ThreadPriority : __CODEGEN_BITFIELD(17, 17) ; //!< THREAD_PRIORITY
90 uint32_t SingleProgramFlow : __CODEGEN_BITFIELD(18, 18) ; //!< SINGLE_PROGRAM_FLOW
91 uint32_t DenormMode : __CODEGEN_BITFIELD(19, 19) ; //!< DENORM_MODE
92 uint32_t ThreadPreemptionDisable : __CODEGEN_BITFIELD(20, 20) ; //!< THREAD_PREEMPTION_DISABLE
93 uint32_t Reserved85 : __CODEGEN_BITFIELD(21, 31) ; //!< Reserved
94 };
95 uint32_t Value;
96 } DW2;
97 union
98 {
99 //!< DWORD 3
100 struct
101 {
102 uint32_t Reserved96 : __CODEGEN_BITFIELD( 0, 1) ; //!< Reserved
103 uint32_t SamplerCount : __CODEGEN_BITFIELD( 2, 4) ; //!< SAMPLER_COUNT
104 uint32_t SamplerStatePointer : __CODEGEN_BITFIELD( 5, 31) ; //!< Sampler State Pointer
105 };
106 uint32_t Value;
107 } DW3;
108 union
109 {
110 //!< DWORD 4
111 struct
112 {
113 uint32_t BindingTableEntryCount : __CODEGEN_BITFIELD( 0, 4) ; //!< Binding Table Entry Count
114 uint32_t BindingTablePointer : __CODEGEN_BITFIELD( 5, 15) ; //!< Binding Table Pointer
115 uint32_t Reserved144 : __CODEGEN_BITFIELD(16, 31) ; //!< Reserved
116 };
117 uint32_t Value;
118 } DW4;
119 union
120 {
121 //!< DWORD 5
122 struct
123 {
124 uint32_t ConstantUrbEntryReadOffset : __CODEGEN_BITFIELD( 0, 15) ; //!< Constant URB Entry Read Offset
125 uint32_t ConstantIndirectUrbEntryReadLength : __CODEGEN_BITFIELD(16, 31) ; //!< Constant/Indirect URB Entry Read Length
126 };
127 uint32_t Value;
128 } DW5;
129 union
130 {
131 //!< DWORD 6
132 struct
133 {
134 uint32_t NumberOfThreadsInGpgpuThreadGroup : __CODEGEN_BITFIELD( 0, 9) ; //!< Number of Threads in GPGPU Thread Group
135 uint32_t Reserved202 : __CODEGEN_BITFIELD(10, 15) ; //!< Reserved
136 uint32_t SharedLocalMemorySize : __CODEGEN_BITFIELD(16, 20) ; //!< SHARED_LOCAL_MEMORY_SIZE
137 uint32_t BarrierEnable : __CODEGEN_BITFIELD(21, 21) ; //!< Barrier Enable
138 uint32_t RoundingMode : __CODEGEN_BITFIELD(22, 23) ; //!< ROUNDING_MODE
139 uint32_t Reserved216 : __CODEGEN_BITFIELD(24, 31) ; //!< Reserved
140 };
141 uint32_t Value;
142 } DW6;
143 union
144 {
145 //!< DWORD 7
146 struct
147 {
148 uint32_t CrossThreadConstantDataReadLength : __CODEGEN_BITFIELD( 0, 7) ; //!< Cross-Thread Constant Data Read Length
149 uint32_t Reserved232 : __CODEGEN_BITFIELD( 8, 31) ; //!< Reserved
150 };
151 uint32_t Value;
152 } DW7;
153
154 //! \name Local enumerations
155
156 //! \brief FLOATING_POINT_MODE
157 //! \details
158 //! Specifies the floating point mode used by the dispatched thread.
159 enum FLOATING_POINT_MODE
160 {
161 FLOATING_POINT_MODE_IEEE_754 = 0, //!< No additional details
162 FLOATING_POINT_MODE_ALTERNATE = 1, //!< No additional details
163 };
164
165 //! \brief THREAD_PRIORITY
166 //! \details
167 //! Specifies the priority of the thread for dispatch.
168 enum THREAD_PRIORITY
169 {
170 THREAD_PRIORITY_NORMALPRIORITY = 0, //!< No additional details
171 THREAD_PRIORITY_HIGHPRIORITY = 1, //!< No additional details
172 };
173
174 //! \brief SINGLE_PROGRAM_FLOW
175 //! \details
176 //! Specifies whether the kernel program has a single program flow (SIMDnxm
177 //! with m = 1) or multiple program flows (SIMDnxm with m &gt; 1).
178 enum SINGLE_PROGRAM_FLOW
179 {
180 SINGLE_PROGRAM_FLOW_MULTIPLE = 0, //!< No additional details
181 SINGLE_PROGRAM_FLOW_SINGLE = 1, //!< No additional details
182 };
183
184 //! \brief DENORM_MODE
185 //! \details
186 //! This field specifies how Float denormalized numbers are handles in the
187 //! dispatched thread.
188 enum DENORM_MODE
189 {
190 DENORM_MODE_FTZ = 0, //!< Float denorms will be flushed to zero when appearing as inputs; denorms will never come out of instructions. Double precision float and half precision float numbers are not flushed to zero.
191 DENORM_MODE_SETBYKERNEL = 1, //!< Denorms will be handled in by kernel.
192 };
193
194 //! \brief THREAD_PREEMPTION_DISABLE
195 //! \details
196 //! &lt;p&gt;This field specifies whether, when dispatched, the thread is
197 //! allowed to stop in middle on receiving mid-thread pre-emption
198 //! request.&lt;/p&gt;
199 enum THREAD_PREEMPTION_DISABLE
200 {
201 THREAD_PREEMPTION_DISABLE_DISABLE = 0, //!< Thread is pre-empted on receiving pre-emption indication.
202 THREAD_PREEMPTION_DISABLE_ENABLE = 1, //!< Thread is preempted only in case of page-fault.
203 };
204
205 //! \brief SAMPLER_COUNT
206 //! \details
207 //! Specifies how many samplers (in multiples of 4) the kernel uses. Used
208 //! only for prefetching the associated sampler state entries.
209 //! <i>This field is ignored for child threads.</i>
210 //! <i>If this field is not zero, sampler state is prefetched for the
211 //! first instance of a root thread upon the startup of the media
212 //! pipeline.</i>
213 enum SAMPLER_COUNT
214 {
215 SAMPLER_COUNT_NOSAMPLERSUSED = 0, //!< No additional details
216 SAMPLER_COUNT_BETWEEN1AND4SAMPLERSUSED = 1, //!< No additional details
217 SAMPLER_COUNT_BETWEEN5AND8SAMPLERSUSED = 2, //!< No additional details
218 SAMPLER_COUNT_BETWEEN9AND12SAMPLERSUSED = 3, //!< No additional details
219 SAMPLER_COUNT_BETWEEN13AND16SAMPLERSUSED = 4, //!< No additional details
220 };
221
222 //! \brief SHARED_LOCAL_MEMORY_SIZE
223 //! \details
224 //! This field indicates how much SharedLocalMemory the thread group
225 //! requires. The amount is specified in 4k blocks, but only powers of 2 are
226 //! allowed: 0, 4k, 8k, 16k, 32k and 64k per half-slice.
227 enum SHARED_LOCAL_MEMORY_SIZE
228 {
229 SHARED_LOCAL_MEMORY_SIZE_ENCODES0K = 0, //!< No SLM used
230 SHARED_LOCAL_MEMORY_SIZE_ENCODES1K = 1, //!< No additional details
231 SHARED_LOCAL_MEMORY_SIZE_ENCODES2K = 2, //!< No additional details
232 SHARED_LOCAL_MEMORY_SIZE_ENCODES4K = 3, //!< No additional details
233 SHARED_LOCAL_MEMORY_SIZE_ENCODES8K = 4, //!< No additional details
234 SHARED_LOCAL_MEMORY_SIZE_ENCODES16K = 5, //!< No additional details
235 SHARED_LOCAL_MEMORY_SIZE_ENCODES32K = 6, //!< No additional details
236 SHARED_LOCAL_MEMORY_SIZE_ENCODES64K = 7, //!< No additional details
237 };
238
239 enum ROUNDING_MODE
240 {
241 ROUNDING_MODE_RTNE = 0, //!< Round to Nearest Even
242 ROUNDING_MODE_RU = 1, //!< Round toward +Infinity
243 ROUNDING_MODE_RD = 2, //!< Round toward -Infinity
244 ROUNDING_MODE_RTZ = 3, //!< Round toward Zero
245 };
246
247 //! \name Initializations
248
249 //! \brief Explicit member initialization function
250 INTERFACE_DESCRIPTOR_DATA_CMD();
251
252 static const size_t dwSize = 8;
253 static const size_t byteSize = 32;
254 };
255
256 //!
257 //! \brief BINDING_TABLE_STATE
258 //! \details
259 //! The binding table binds surfaces to logical resource indices used by
260 //! shaders and other compute engine kernels. It is stored as an array of up
261 //! to 256 elements, each of which contains one dword as defined here. The
262 //! start of each element is spaced one dword apart. The first element of
263 //! the binding table is aligned to a 64-byte boundary. Binding table
264 //! indexes beyond 256 will automatically be mapped to entry 0 by the HW, w/
265 //! the exception of any messages which support the special indexes 240
266 //! through 255, inclusive.
267 //!
268 struct BINDING_TABLE_STATE_CMD
269 {
270 union
271 {
272 //!< DWORD 0
273 struct
274 {
275 uint32_t Reserved0 : __CODEGEN_BITFIELD( 0, 5) ; //!< Reserved
276 uint32_t SurfaceStatePointer : __CODEGEN_BITFIELD( 6, 31) ; //!< Surface State Pointer
277 };
278 uint32_t Value;
279 } DW0;
280
281 //! \name Local enumerations
282
283 //! \name Initializations
284
285 //! \brief Explicit member initialization function
286 BINDING_TABLE_STATE_CMD();
287
288 static const size_t dwSize = 1;
289 static const size_t byteSize = 4;
290 };
291
292 //!
293 //! \brief RENDER_SURFACE_STATE
294 //! \details
295 //! This is the normal surface state used by all messages that use
296 //! SURFACE_STATE except those that use MEDIA_SURFACE_STATE.
297 //!
298 struct RENDER_SURFACE_STATE_CMD
299 {
300 union
301 {
302 //!< DWORD 0
303 struct
304 {
305 uint32_t CubeFaceEnablePositiveZ : __CODEGEN_BITFIELD( 0, 0) ; //!< Cube Face Enable - Positive Z, [Surface Type] == 'SURFTYPE_CUBE'
306 uint32_t CubeFaceEnableNegativeZ : __CODEGEN_BITFIELD( 1, 1) ; //!< Cube Face Enable - Negative Z, [Surface Type] == 'SURFTYPE_CUBE'
307 uint32_t CubeFaceEnablePositiveY : __CODEGEN_BITFIELD( 2, 2) ; //!< Cube Face Enable - Positive Y, [Surface Type] == 'SURFTYPE_CUBE'
308 uint32_t CubeFaceEnableNegativeY : __CODEGEN_BITFIELD( 3, 3) ; //!< Cube Face Enable - Negative Y, [Surface Type] == 'SURFTYPE_CUBE'
309 uint32_t CubeFaceEnablePositiveX : __CODEGEN_BITFIELD( 4, 4) ; //!< Cube Face Enable - Positive X, [Surface Type] == 'SURFTYPE_CUBE'
310 uint32_t CubeFaceEnableNegativeX : __CODEGEN_BITFIELD( 5, 5) ; //!< Cube Face Enable - Negative X, [Surface Type] == 'SURFTYPE_CUBE'
311 uint32_t MediaBoundaryPixelMode : __CODEGEN_BITFIELD( 6, 7) ; //!< MEDIA_BOUNDARY_PIXEL_MODE
312 uint32_t RenderCacheReadWriteMode : __CODEGEN_BITFIELD( 8, 8) ; //!< RENDER_CACHE_READ_WRITE_MODE
313 uint32_t SamplerL2OutOfOrderModeDisable : __CODEGEN_BITFIELD( 9, 9) ; //!< Sampler L2 Out of Order Mode Disable
314 uint32_t VerticalLineStrideOffset : __CODEGEN_BITFIELD(10, 10) ; //!< Vertical Line Stride Offset
315 uint32_t VerticalLineStride : __CODEGEN_BITFIELD(11, 11) ; //!< Vertical Line Stride
316 uint32_t TileMode : __CODEGEN_BITFIELD(12, 13) ; //!< TILE_MODE
317 uint32_t SurfaceHorizontalAlignment : __CODEGEN_BITFIELD(14, 15) ; //!< SURFACE_HORIZONTAL_ALIGNMENT
318 uint32_t SurfaceVerticalAlignment : __CODEGEN_BITFIELD(16, 17) ; //!< SURFACE_VERTICAL_ALIGNMENT
319 uint32_t SurfaceFormat : __CODEGEN_BITFIELD(18, 26) ; //!< SURFACE_FORMAT
320 uint32_t AstcEnable : __CODEGEN_BITFIELD(27, 27) ; //!< ASTC_Enable
321 uint32_t SurfaceArray : __CODEGEN_BITFIELD(28, 28) ; //!< Surface Array
322 uint32_t SurfaceType : __CODEGEN_BITFIELD(29, 31) ; //!< SURFACE_TYPE
323 };
324 uint32_t Value;
325 } DW0;
326 union
327 {
328 //!< DWORD 1
329 struct
330 {
331 uint32_t SurfaceQpitch : __CODEGEN_BITFIELD( 0, 14) ; //!< Surface QPitch
332 uint32_t SampleTapDiscardDisable : __CODEGEN_BITFIELD(15, 15) ; //!< SAMPLE_TAP_DISCARD_DISABLE
333 uint32_t Reserved48 : __CODEGEN_BITFIELD(16, 17) ; //!< Reserved
334 uint32_t CornerTexelMode : __CODEGEN_BITFIELD(18, 18) ; //!< CORNER_TEXEL_MODE
335 uint32_t BaseMipLevel : __CODEGEN_BITFIELD(19, 23) ; //!< Base Mip Level
336 uint32_t MemoryObjectControlState : __CODEGEN_BITFIELD(24, 30) ; //!< Memory Object Control State
337 uint32_t EnableUnormPathInColorPipe : __CODEGEN_BITFIELD(31, 31) ; //!< ENABLE_UNORM_PATH_IN_COLOR_PIPE
338 };
339 uint32_t Value;
340 } DW1;
341 union
342 {
343 //!< DWORD 2
344 struct
345 {
346 uint32_t Width : __CODEGEN_BITFIELD( 0, 13) ; //!< Width
347 uint32_t Reserved78 : __CODEGEN_BITFIELD(14, 15) ; //!< Reserved
348 uint32_t Height : __CODEGEN_BITFIELD(16, 29) ; //!< Height
349 uint32_t Reserved94 : __CODEGEN_BITFIELD(30, 31) ; //!< Reserved
350 };
351 uint32_t Value;
352 } DW2;
353 union
354 {
355 //!< DWORD 3
356 struct
357 {
358 uint32_t SurfacePitch : __CODEGEN_BITFIELD( 0, 17) ; //!< Surface Pitch
359 uint32_t Reserved114 : __CODEGEN_BITFIELD(18, 18) ; //!< Reserved
360 uint32_t StandardTilingModeExtensions : __CODEGEN_BITFIELD(19, 19) ; //!< STANDARD_TILING_MODE_EXTENSIONS
361 uint32_t TileAddressMappingMode : __CODEGEN_BITFIELD(20, 20) ; //!< TILE_ADDRESS_MAPPING_MODE
362 uint32_t Depth : __CODEGEN_BITFIELD(21, 31) ; //!< Depth
363 };
364 uint32_t Value;
365 } DW3;
366 union
367 {
368 //!< DWORD 4
369 struct
370 {
371 uint32_t MultisamplePositionPaletteIndex : __CODEGEN_BITFIELD( 0, 2) ; //!< Multisample Position Palette Index, [Surface Type] != 'SURFTYPE_STRBUF'
372 uint32_t NumberOfMultisamples : __CODEGEN_BITFIELD( 3, 5) ; //!< NUMBER_OF_MULTISAMPLES, [Surface Type] != 'SURFTYPE_STRBUF'
373 uint32_t MultisampledSurfaceStorageFormat : __CODEGEN_BITFIELD( 6, 6) ; //!< MULTISAMPLED_SURFACE_STORAGE_FORMAT, [Surface Type] != 'SURFTYPE_STRBUF'
374 uint32_t RenderTargetViewExtent : __CODEGEN_BITFIELD( 7, 17) ; //!< Render Target View Extent, [Surface Type] != 'SURFTYPE_STRBUF'
375 uint32_t MinimumArrayElement : __CODEGEN_BITFIELD(18, 28) ; //!< Minimum Array Element, [Surface Type] != 'SURFTYPE_STRBUF'
376 uint32_t RenderTargetAndSampleUnormRotation : __CODEGEN_BITFIELD(29, 30) ; //!< RENDER_TARGET_AND_SAMPLE_UNORM_ROTATION, [Surface Type] != 'SURFTYPE_STRBUF'
377 uint32_t Reserved159 : __CODEGEN_BITFIELD(31, 31) ; //!< Reserved, [Surface Type] != 'SURFTYPE_STRBUF'
378 };
379 uint32_t Value;
380 } DW4;
381 union
382 {
383 //!< DWORD 5
384 struct
385 {
386 uint32_t MipCountLod : __CODEGEN_BITFIELD( 0, 3) ; //!< MIP Count / LOD
387 uint32_t SurfaceMinLod : __CODEGEN_BITFIELD( 4, 7) ; //!< Surface Min LOD
388 uint32_t MipTailStartLod : __CODEGEN_BITFIELD( 8, 11) ; //!< Mip Tail Start LOD
389 uint32_t Reserved172 : __CODEGEN_BITFIELD(12, 13) ; //!< Reserved
390 uint32_t CoherencyType : __CODEGEN_BITFIELD(14, 14) ; //!< COHERENCY_TYPE
391 uint32_t Reserved175 : __CODEGEN_BITFIELD(15, 17) ; //!< Reserved
392 uint32_t TiledResourceMode : __CODEGEN_BITFIELD(18, 19) ; //!< TILED_RESOURCE_MODE
393 uint32_t EwaDisableForCube : __CODEGEN_BITFIELD(20, 20) ; //!< EWA_DISABLE_FOR_CUBE
394 uint32_t YOffset : __CODEGEN_BITFIELD(21, 23) ; //!< Y Offset
395 uint32_t Reserved184 : __CODEGEN_BITFIELD(24, 24) ; //!< Reserved
396 uint32_t XOffset : __CODEGEN_BITFIELD(25, 31) ; //!< X Offset
397 };
398 uint32_t Value;
399 } DW5;
400 union
401 {
402 //!< DWORD 6
403 struct
404 {
405 uint32_t YOffsetForUOrUvPlane : __CODEGEN_BITFIELD( 0, 13) ; //!< Y Offset for U or UV Plane, ([Surface Format] == 'PLANAR')
406 uint32_t Reserved206 : __CODEGEN_BITFIELD(14, 15) ; //!< Reserved, ([Surface Format] == 'PLANAR')
407 uint32_t XOffsetForUOrUvPlane : __CODEGEN_BITFIELD(16, 29) ; //!< X Offset for U or UV Plane, ([Surface Format] == 'PLANAR')
408 uint32_t HalfPitchForChroma : __CODEGEN_BITFIELD(30, 30) ; //!< HALF_PITCH_FOR_CHROMA, ([Surface Format] == 'PLANAR')
409 uint32_t SeparateUvPlaneEnable : __CODEGEN_BITFIELD(31, 31) ; //!< Separate UV Plane Enable, ([Surface Format] == 'PLANAR')
410 } Obj0;
411 struct
412 {
413 uint32_t AuxiliarySurfaceMode : __CODEGEN_BITFIELD( 0, 2) ; //!< AUXILIARY_SURFACE_MODE, ([Surface Format] != 'PLANAR')
414 uint32_t AuxiliarySurfacePitch : __CODEGEN_BITFIELD( 3, 11) ; //!< Auxiliary Surface Pitch, ([Surface Format] != 'PLANAR')
415 uint32_t Reserved204 : __CODEGEN_BITFIELD(12, 15) ; //!< Reserved, ([Surface Format] != 'PLANAR')
416 uint32_t AuxiliarySurfaceQpitch : __CODEGEN_BITFIELD(16, 30) ; //!< Auxiliary Surface QPitch, ([Surface Format] != 'PLANAR')
417 uint32_t Reserved223 : __CODEGEN_BITFIELD(31, 31) ; //!< Reserved, ([Surface Format] != 'PLANAR')
418 } Obj1;
419 struct
420 {
421 uint32_t Reserved192 : __CODEGEN_BITFIELD( 0, 14) ; //!< Reserved, ([Surface Format] != 'PLANAR')
422 uint32_t YuvInterpolationEnable : __CODEGEN_BITFIELD(15, 15) ; //!< YUV_INTERPOLATION_ENABLE,
423 uint32_t Reserved208 : __CODEGEN_BITFIELD(16, 31) ; //!< Reserved,
424 } Obj2;
425 uint32_t Value;
426 } DW6;
427 union
428 {
429 //!< DWORD 7
430 struct
431 {
432 uint32_t ResourceMinLod : __CODEGEN_BITFIELD( 0, 11) ; //!< Resource Min LOD
433 uint32_t Reserved236 : __CODEGEN_BITFIELD(12, 15) ; //!< Reserved
434 uint32_t ShaderChannelSelectAlpha : __CODEGEN_BITFIELD(16, 18) ; //!< SHADER_CHANNEL_SELECT_ALPHA
435 uint32_t ShaderChannelSelectBlue : __CODEGEN_BITFIELD(19, 21) ; //!< SHADER_CHANNEL_SELECT_BLUE
436 uint32_t ShaderChannelSelectGreen : __CODEGEN_BITFIELD(22, 24) ; //!< SHADER_CHANNEL_SELECT_GREEN
437 uint32_t ShaderChannelSelectRed : __CODEGEN_BITFIELD(25, 27) ; //!< SHADER_CHANNEL_SELECT_RED
438 uint32_t Reserved252 : __CODEGEN_BITFIELD(28, 29) ; //!< Reserved
439 uint32_t MemoryCompressionEnable : __CODEGEN_BITFIELD(30, 30) ; //!< Memory Compression Enable
440 uint32_t MemoryCompressionMode : __CODEGEN_BITFIELD(31, 31) ; //!< MEMORY_COMPRESSION_MODE
441 };
442 uint32_t Value;
443 } DW7;
444 union
445 {
446 //!< DWORD 8..9
447 struct
448 {
449 uint64_t SurfaceBaseAddress ; //!< Surface Base Address
450 };
451 uint32_t Value[2];
452 } DW8_9;
453 union
454 {
455 //!< DWORD 10..11
456 struct
457 {
458 uint64_t QuiltWidth : __CODEGEN_BITFIELD( 0, 4) ; //!< Quilt Width,
459 uint64_t QuiltHeight : __CODEGEN_BITFIELD( 5, 9) ; //!< Quilt Height,
460 uint64_t ClearValueAddressEnable : __CODEGEN_BITFIELD(10, 10) ; //!< CLEAR_VALUE_ADDRESS_ENABLE,
461 uint64_t Reserved331 : __CODEGEN_BITFIELD(11, 63) ; //!< Reserved,
462 } Obj0;
463 struct
464 {
465 uint64_t Reserved320 : __CODEGEN_BITFIELD( 0, 11) ; //!< Reserved,
466 uint64_t AuxiliarySurfaceBaseAddress : __CODEGEN_BITFIELD(12, 63) ; //!< Auxiliary Surface Base Address, ([Surface Format] != 'PLANAR') AND [Memory Compression Enable] == 0
467 } Obj1;
468 struct
469 {
470 uint64_t Reserved320 : __CODEGEN_BITFIELD( 0, 20) ; //!< Reserved,
471 uint64_t AuxiliaryTableIndexForMediaCompressedSurface : __CODEGEN_BITFIELD(21, 31) ; //!< Auxiliary Table Index for Media Compressed Surface, [Memory Compression Enable] ==1
472 uint64_t Reserved352 : __CODEGEN_BITFIELD(32, 63) ; //!< Reserved, [Memory Compression Enable] ==1
473 } Obj2;
474 struct
475 {
476 uint64_t Reserved320 : __CODEGEN_BITFIELD( 0, 31) ; //!< Reserved, [Memory Compression Enable] ==1
477 uint64_t YOffsetForVPlane : __CODEGEN_BITFIELD(32, 45) ; //!< Y Offset for V Plane, ([Surface Format] == 'PLANAR')
478 uint64_t Reserved366 : __CODEGEN_BITFIELD(46, 47) ; //!< Reserved, ([Surface Format] == 'PLANAR')
479 uint64_t XOffsetForVPlane : __CODEGEN_BITFIELD(48, 61) ; //!< X Offset for V Plane, ([Surface Format] == 'PLANAR')
480 uint64_t Reserved382 : __CODEGEN_BITFIELD(62, 63) ; //!< Reserved, ([Surface Format] == 'PLANAR')
481 } Obj3;
482 uint32_t Value[2];
483 } DW10_11;
484 union
485 {
486 //!< DWORD 12
487 struct
488 {
489 uint32_t RedClearColor ; //!< Red Clear Color
490 };
491 uint32_t Value;
492 } DW12;
493 union
494 {
495 //!< DWORD 13
496 struct
497 {
498 uint32_t ClearDepthAddressHigh : __CODEGEN_BITFIELD( 0, 15) ; //!< Clear Depth Address High, ([Auxiliary Surface Mode] == 'AUX_HIZ') AND ([Clear Value Address Enable] == 'Enable')
499 uint32_t Reserved432 : __CODEGEN_BITFIELD(16, 31) ; //!< Reserved, ([Auxiliary Surface Mode] == 'AUX_HIZ') AND ([Clear Value Address Enable] == 'Enable')
500 } Obj0;
501 struct
502 {
503 uint32_t ClearColorAddressHigh : __CODEGEN_BITFIELD( 0, 15) ; //!< Clear Color Address High, (([Auxiliary Surface Mode] == 'AUX_CCS_D' OR [Auxiliary Surface Mode] == 'AUX_CCS_E') AND [Clear Value Address Enable] == 'Enable')
504 uint32_t Reserved432 : __CODEGEN_BITFIELD(16, 31) ; //!< Reserved, (([Auxiliary Surface Mode] == 'AUX_CCS_D' OR [Auxiliary Surface Mode] == 'AUX_CCS_E') AND [Clear Value Address Enable] == 'Enable')
505 } Obj1;
506 struct
507 {
508 uint32_t GreenClearColor ; //!< Green Clear Color, (([Auxiliary Surface Mode] == 'AUX_CCS_D' OR [Auxiliary Surface Mode] == 'AUX_CCS_E') AND [Clear Value Address Enable] == 'Disable')
509 } Obj2;
510 uint32_t Value;
511 } DW13;
512 union
513 {
514 //!< DWORD 14
515 struct
516 {
517 uint32_t BlueClearColor ; //!< Blue Clear Color, (([Auxiliary Surface Mode] == 'AUX_CCS_D' OR [Auxiliary Surface Mode] == 'AUX_CCS_E') AND [Clear Value Address Enable] == 'Disable')
518 };
519 uint32_t Value;
520 } DW14;
521 union
522 {
523 //!< DWORD 15
524 struct
525 {
526 uint32_t AlphaClearColor ; //!< Alpha Clear Color, (([Auxiliary Surface Mode] == 'AUX_CCS_D' OR [Auxiliary Surface Mode] == 'AUX_CCS_E') AND [Clear Value Address Enable] == 'Disable')
527 };
528 uint32_t Value;
529 } DW15;
530
531 //! \name Local enumerations
532
533 //! \brief MEDIA_BOUNDARY_PIXEL_MODE
534 //! \details
535 //! <div id="GroupContent-248" class="GroupContent UseCKEdit">
536 //! <p><b>For 2D Non-Array Surfaces accessed via the Data Port Media Block
537 //! Read Message or Data Port Transpose Read message:</b><br />
538 //! This field enables control of which rows are returned on vertical
539 //! out-of-bounds reads using the Data Port Media Block Read Message or Data
540 //! Port Transpose Read message. In the description below, frame mode refers
541 //! to <b>Vertical Line Stride</b> = 0, field mode is <b>Vertical Line
542 //! Stride</b> = 1 in which only the even or odd rows are addressable. The
543 //! frame refers to the entire surface, while the field refers only to the
544 //! even or odd rows within the surface.</p>
545 //! <p><b>For Other Surfaces:</b><br />
546 //! Reserved : MBZ</p></div>
547 enum MEDIA_BOUNDARY_PIXEL_MODE
548 {
549 MEDIA_BOUNDARY_PIXEL_MODE_NORMALMODE = 0, //!< The row returned on an out-of-bound access is the closest row in the frame or field. Rows from the opposite field are never returned.
550 MEDIA_BOUNDARY_PIXEL_MODE_PROGRESSIVEFRAME = 2, //!< The row returned on an out-of-bound access is the closest row in the frame, even if in field mode.
551 MEDIA_BOUNDARY_PIXEL_MODE_INTERLACEDFRAME = 3, //!< In field mode, the row returned on an out-of-bound access is the closest row in the field. In frame mode, even out-of-bound rows return the nearest even row while odd out-of-bound rows return the nearest odd row.
552 };
553
554 //! \brief RENDER_CACHE_READ_WRITE_MODE
555 //! \details
556 //! <p><b>For Surfaces accessed via the Data Port to Render Cache:</b><br />
557 //! This field specifies the way Render Cache treats a write request. If
558 //! unset, Render Cache allocates a write-only cache line for a write miss.
559 //! If set, Render Cache allocates a read-write cache line for a write
560 //! miss.</p>
561 //! <p><b>For Surfaces accessed via the Sampling Engine or Data Port to
562 //! Texture Cache or Data Cache:</b><br />
563 //! This field is reserved : MBZ</p>
564 enum RENDER_CACHE_READ_WRITE_MODE
565 {
566 RENDER_CACHE_READ_WRITE_MODE_WRITE_ONLYCACHE = 0, //!< Allocating write-only cache for a write miss
567 RENDER_CACHE_READ_WRITE_MODE_READ_WRITECACHE = 1, //!< Allocating read-write cache for a write miss
568 };
569
570 //! \brief TILE_MODE
571 //! \details
572 //! This field specifies the type of memory tiling (Linear, WMajor, XMajor,
573 //! or YMajor) employed to tile this surface. See <em>Memory Interface
574 //! Functions</em> for details on memory tiling and restrictions.
575 enum TILE_MODE
576 {
577 TILE_MODE_LINEAR = 0, //!< Linear mode (no tiling)
578 TILE_MODE_WMAJOR = 1, //!< W major tiling
579 TILE_MODE_XMAJOR = 2, //!< X major tiling
580 TILE_MODE_YMAJOR = 3, //!< Y major tiling
581 };
582
583 //! \brief SURFACE_HORIZONTAL_ALIGNMENT
584 //! \details
585 //! For Sampling Engine and Render Target Surfaces: This field specifies the
586 //! horizontal alignment requirement for the surface.
587 enum SURFACE_HORIZONTAL_ALIGNMENT
588 {
589 SURFACE_HORIZONTAL_ALIGNMENT_HALIGN4 = 1, //!< Horizontal alignment factor j = 4
590 SURFACE_HORIZONTAL_ALIGNMENT_HALIGN8 = 2, //!< Horizontal alignment factor j = 8
591 SURFACE_HORIZONTAL_ALIGNMENT_HALIGN16 = 3, //!< Horizontal alignment factor j = 16
592 };
593
594 //! \brief SURFACE_VERTICAL_ALIGNMENT
595 //! \details
596 //! <b>For Sampling Engine and Render Target Surfaces:</b> This field
597 //! specifies the vertical alignment requirement in elements for the
598 //! surface. Refer to the "Memory Data Formats" chapter for details on how
599 //! this field changes the layout of the surface in memory. An
600 //! <i>element</i> is defined as a pixel in uncompresed surface formats, and
601 //! as a compression block in compressed surface formats. For
602 //! MSFMT_DEPTH_STENCIL type multisampled surfaces, an element is a sample.
603 enum SURFACE_VERTICAL_ALIGNMENT
604 {
605 SURFACE_VERTICAL_ALIGNMENT_VALIGN4 = 1, //!< Vertical alignment factor j = 4
606 SURFACE_VERTICAL_ALIGNMENT_VALIGN8 = 2, //!< Vertical alignment factor j = 8
607 SURFACE_VERTICAL_ALIGNMENT_VALIGN16 = 3, //!< Vertical alignment factor j = 16
608 };
609
610 //! \brief SURFACE_FORMAT
611 //! \details
612 //! This field specifies the format of the surface or element within this
613 //! surface. This field is ignored for all data port messages other than the
614 //! render target message and streamed vertex buffer write message. Some
615 //! forms of the media block messages use the surface format.
616 enum SURFACE_FORMAT
617 {
618 SURFACE_FORMAT_R32G32B32A32FLOAT = 0, //!< No additional details
619 SURFACE_FORMAT_R32G32B32A32SINT = 1, //!< No additional details
620 SURFACE_FORMAT_R32G32B32A32UINT = 2, //!< No additional details
621 SURFACE_FORMAT_R32G32B32A32UNORM = 3, //!< No additional details
622 SURFACE_FORMAT_R32G32B32A32SNORM = 4, //!< No additional details
623 SURFACE_FORMAT_R64G64FLOAT = 5, //!< No additional details
624 SURFACE_FORMAT_R32G32B32X32FLOAT = 6, //!< No additional details
625 SURFACE_FORMAT_R32G32B32A32SSCALED = 7, //!< No additional details
626 SURFACE_FORMAT_R32G32B32A32USCALED = 8, //!< No additional details
627 SURFACE_FORMAT_R32G32B32A32SFIXED = 32, //!< No additional details
628 SURFACE_FORMAT_R64G64PASSTHRU = 33, //!< No additional details
629 SURFACE_FORMAT_R32G32B32FLOAT = 64, //!< No additional details
630 SURFACE_FORMAT_R32G32B32SINT = 65, //!< No additional details
631 SURFACE_FORMAT_R32G32B32UINT = 66, //!< No additional details
632 SURFACE_FORMAT_R32G32B32UNORM = 67, //!< No additional details
633 SURFACE_FORMAT_R32G32B32SNORM = 68, //!< No additional details
634 SURFACE_FORMAT_R32G32B32SSCALED = 69, //!< No additional details
635 SURFACE_FORMAT_R32G32B32USCALED = 70, //!< No additional details
636 SURFACE_FORMAT_R32G32B32SFIXED = 80, //!< No additional details
637 SURFACE_FORMAT_R16G16B16A16UNORM = 128, //!< No additional details
638 SURFACE_FORMAT_R16G16B16A16SNORM = 129, //!< No additional details
639 SURFACE_FORMAT_R16G16B16A16SINT = 130, //!< No additional details
640 SURFACE_FORMAT_R16G16B16A16UINT = 131, //!< No additional details
641 SURFACE_FORMAT_R16G16B16A16FLOAT = 132, //!< No additional details
642 SURFACE_FORMAT_R32G32FLOAT = 133, //!< No additional details
643 SURFACE_FORMAT_R32G32SINT = 134, //!< No additional details
644 SURFACE_FORMAT_R32G32UINT = 135, //!< No additional details
645 SURFACE_FORMAT_R32FLOATX8X24TYPELESS = 136, //!< No additional details
646 SURFACE_FORMAT_X32TYPELESSG8X24UINT = 137, //!< No additional details
647 SURFACE_FORMAT_L32A32FLOAT = 138, //!< No additional details
648 SURFACE_FORMAT_R32G32UNORM = 139, //!< No additional details
649 SURFACE_FORMAT_R32G32SNORM = 140, //!< No additional details
650 SURFACE_FORMAT_R64FLOAT = 141, //!< No additional details
651 SURFACE_FORMAT_R16G16B16X16UNORM = 142, //!< No additional details
652 SURFACE_FORMAT_R16G16B16X16FLOAT = 143, //!< No additional details
653 SURFACE_FORMAT_A32X32FLOAT = 144, //!< No additional details
654 SURFACE_FORMAT_L32X32FLOAT = 145, //!< No additional details
655 SURFACE_FORMAT_I32X32FLOAT = 146, //!< No additional details
656 SURFACE_FORMAT_R16G16B16A16SSCALED = 147, //!< No additional details
657 SURFACE_FORMAT_R16G16B16A16USCALED = 148, //!< No additional details
658 SURFACE_FORMAT_R32G32SSCALED = 149, //!< No additional details
659 SURFACE_FORMAT_R32G32USCALED = 150, //!< No additional details
660 SURFACE_FORMAT_R32G32SFIXED = 160, //!< No additional details
661 SURFACE_FORMAT_R64PASSTHRU = 161, //!< No additional details
662 SURFACE_FORMAT_B8G8R8A8UNORM = 192, //!< No additional details
663 SURFACE_FORMAT_B8G8R8A8UNORMSRGB = 193, //!< No additional details
664 SURFACE_FORMAT_R10G10B10A2UNORM = 194, //!< No additional details
665 SURFACE_FORMAT_R10G10B10A2UNORMSRGB = 195, //!< No additional details
666 SURFACE_FORMAT_R10G10B10A2UINT = 196, //!< No additional details
667 SURFACE_FORMAT_R10G10B10SNORMA2UNORM = 197, //!< No additional details
668 SURFACE_FORMAT_R8G8B8A8UNORM = 199, //!< No additional details
669 SURFACE_FORMAT_R8G8B8A8UNORMSRGB = 200, //!< No additional details
670 SURFACE_FORMAT_R8G8B8A8SNORM = 201, //!< No additional details
671 SURFACE_FORMAT_R8G8B8A8SINT = 202, //!< No additional details
672 SURFACE_FORMAT_R8G8B8A8UINT = 203, //!< No additional details
673 SURFACE_FORMAT_R16G16UNORM = 204, //!< No additional details
674 SURFACE_FORMAT_R16G16SNORM = 205, //!< No additional details
675 SURFACE_FORMAT_R16G16SINT = 206, //!< No additional details
676 SURFACE_FORMAT_R16G16UINT = 207, //!< No additional details
677 SURFACE_FORMAT_R16G16FLOAT = 208, //!< No additional details
678 SURFACE_FORMAT_B10G10R10A2UNORM = 209, //!< No additional details
679 SURFACE_FORMAT_B10G10R10A2UNORMSRGB = 210, //!< No additional details
680 SURFACE_FORMAT_R11G11B10FLOAT = 211, //!< No additional details
681 SURFACE_FORMAT_R32SINT = 214, //!< No additional details
682 SURFACE_FORMAT_R32UINT = 215, //!< No additional details
683 SURFACE_FORMAT_R32FLOAT = 216, //!< No additional details
684 SURFACE_FORMAT_R24UNORMX8TYPELESS = 217, //!< No additional details
685 SURFACE_FORMAT_X24TYPELESSG8UINT = 218, //!< No additional details
686 SURFACE_FORMAT_L32UNORM = 221, //!< No additional details
687 SURFACE_FORMAT_A32UNORM = 222, //!< No additional details
688 SURFACE_FORMAT_L16A16UNORM = 223, //!< No additional details
689 SURFACE_FORMAT_I24X8UNORM = 224, //!< No additional details
690 SURFACE_FORMAT_L24X8UNORM = 225, //!< No additional details
691 SURFACE_FORMAT_A24X8UNORM = 226, //!< No additional details
692 SURFACE_FORMAT_I32FLOAT = 227, //!< No additional details
693 SURFACE_FORMAT_L32FLOAT = 228, //!< No additional details
694 SURFACE_FORMAT_A32FLOAT = 229, //!< No additional details
695 SURFACE_FORMAT_X8B8UNORMG8R8SNORM = 230, //!< No additional details
696 SURFACE_FORMAT_A8X8UNORMG8R8SNORM = 231, //!< No additional details
697 SURFACE_FORMAT_B8X8UNORMG8R8SNORM = 232, //!< No additional details
698 SURFACE_FORMAT_B8G8R8X8UNORM = 233, //!< No additional details
699 SURFACE_FORMAT_B8G8R8X8UNORMSRGB = 234, //!< No additional details
700 SURFACE_FORMAT_R8G8B8X8UNORM = 235, //!< No additional details
701 SURFACE_FORMAT_R8G8B8X8UNORMSRGB = 236, //!< No additional details
702 SURFACE_FORMAT_R9G9B9E5SHAREDEXP = 237, //!< No additional details
703 SURFACE_FORMAT_B10G10R10X2UNORM = 238, //!< No additional details
704 SURFACE_FORMAT_L16A16FLOAT = 240, //!< No additional details
705 SURFACE_FORMAT_R32UNORM = 241, //!< No additional details
706 SURFACE_FORMAT_R32SNORM = 242, //!< No additional details
707 SURFACE_FORMAT_R10G10B10X2USCALED = 243, //!< No additional details
708 SURFACE_FORMAT_R8G8B8A8SSCALED = 244, //!< No additional details
709 SURFACE_FORMAT_R8G8B8A8USCALED = 245, //!< No additional details
710 SURFACE_FORMAT_R16G16SSCALED = 246, //!< No additional details
711 SURFACE_FORMAT_R16G16USCALED = 247, //!< No additional details
712 SURFACE_FORMAT_R32SSCALED = 248, //!< No additional details
713 SURFACE_FORMAT_R32USCALED = 249, //!< No additional details
714 SURFACE_FORMAT_B5G6R5UNORM = 256, //!< No additional details
715 SURFACE_FORMAT_B5G6R5UNORMSRGB = 257, //!< No additional details
716 SURFACE_FORMAT_B5G5R5A1UNORM = 258, //!< No additional details
717 SURFACE_FORMAT_B5G5R5A1UNORMSRGB = 259, //!< No additional details
718 SURFACE_FORMAT_B4G4R4A4UNORM = 260, //!< No additional details
719 SURFACE_FORMAT_B4G4R4A4UNORMSRGB = 261, //!< No additional details
720 SURFACE_FORMAT_R8G8UNORM = 262, //!< No additional details
721 SURFACE_FORMAT_R8G8SNORM = 263, //!< No additional details
722 SURFACE_FORMAT_R8G8SINT = 264, //!< No additional details
723 SURFACE_FORMAT_R8G8UINT = 265, //!< No additional details
724 SURFACE_FORMAT_R16UNORM = 266, //!< No additional details
725 SURFACE_FORMAT_R16SNORM = 267, //!< No additional details
726 SURFACE_FORMAT_R16SINT = 268, //!< No additional details
727 SURFACE_FORMAT_R16UINT = 269, //!< No additional details
728 SURFACE_FORMAT_R16FLOAT = 270, //!< No additional details
729 SURFACE_FORMAT_A8P8UNORMPALETTE0 = 271, //!< No additional details
730 SURFACE_FORMAT_A8P8UNORMPALETTE1 = 272, //!< No additional details
731 SURFACE_FORMAT_I16UNORM = 273, //!< No additional details
732 SURFACE_FORMAT_L16UNORM = 274, //!< No additional details
733 SURFACE_FORMAT_A16UNORM = 275, //!< No additional details
734 SURFACE_FORMAT_L8A8UNORM = 276, //!< No additional details
735 SURFACE_FORMAT_I16FLOAT = 277, //!< No additional details
736 SURFACE_FORMAT_L16FLOAT = 278, //!< No additional details
737 SURFACE_FORMAT_A16FLOAT = 279, //!< No additional details
738 SURFACE_FORMAT_L8A8UNORMSRGB = 280, //!< No additional details
739 SURFACE_FORMAT_R5G5SNORMB6UNORM = 281, //!< No additional details
740 SURFACE_FORMAT_B5G5R5X1UNORM = 282, //!< No additional details
741 SURFACE_FORMAT_B5G5R5X1UNORMSRGB = 283, //!< No additional details
742 SURFACE_FORMAT_R8G8SSCALED = 284, //!< No additional details
743 SURFACE_FORMAT_R8G8USCALED = 285, //!< No additional details
744 SURFACE_FORMAT_R16SSCALED = 286, //!< No additional details
745 SURFACE_FORMAT_R16USCALED = 287, //!< No additional details
746 SURFACE_FORMAT_P8A8UNORMPALETTE0 = 290, //!< No additional details
747 SURFACE_FORMAT_P8A8UNORMPALETTE1 = 291, //!< No additional details
748 SURFACE_FORMAT_A1B5G5R5UNORM = 292, //!< No additional details
749 SURFACE_FORMAT_A4B4G4R4UNORM = 293, //!< No additional details
750 SURFACE_FORMAT_L8A8UINT = 294, //!< No additional details
751 SURFACE_FORMAT_L8A8SINT = 295, //!< No additional details
752 SURFACE_FORMAT_R8UNORM = 320, //!< No additional details
753 SURFACE_FORMAT_R8SNORM = 321, //!< No additional details
754 SURFACE_FORMAT_R8SINT = 322, //!< No additional details
755 SURFACE_FORMAT_R8UINT = 323, //!< No additional details
756 SURFACE_FORMAT_A8UNORM = 324, //!< No additional details
757 SURFACE_FORMAT_I8UNORM = 325, //!< No additional details
758 SURFACE_FORMAT_L8UNORM = 326, //!< No additional details
759 SURFACE_FORMAT_P4A4UNORMPALETTE0 = 327, //!< No additional details
760 SURFACE_FORMAT_A4P4UNORMPALETTE0 = 328, //!< No additional details
761 SURFACE_FORMAT_R8SSCALED = 329, //!< No additional details
762 SURFACE_FORMAT_R8USCALED = 330, //!< No additional details
763 SURFACE_FORMAT_P8UNORMPALETTE0 = 331, //!< No additional details
764 SURFACE_FORMAT_L8UNORMSRGB = 332, //!< No additional details
765 SURFACE_FORMAT_P8UNORMPALETTE1 = 333, //!< No additional details
766 SURFACE_FORMAT_P4A4UNORMPALETTE1 = 334, //!< No additional details
767 SURFACE_FORMAT_A4P4UNORMPALETTE1 = 335, //!< No additional details
768 SURFACE_FORMAT_Y8UNORM = 336, //!< No additional details
769 SURFACE_FORMAT_L8UINT = 338, //!< No additional details
770 SURFACE_FORMAT_L8SINT = 339, //!< No additional details
771 SURFACE_FORMAT_I8UINT = 340, //!< No additional details
772 SURFACE_FORMAT_I8SINT = 341, //!< No additional details
773 SURFACE_FORMAT_DXT1RGBSRGB = 384, //!< No additional details
774 SURFACE_FORMAT_R1UNORM = 385, //!< No additional details
775 SURFACE_FORMAT_YCRCBNORMAL = 386, //!< No additional details
776 SURFACE_FORMAT_YCRCBSWAPUVY = 387, //!< No additional details
777 SURFACE_FORMAT_P2UNORMPALETTE0 = 388, //!< No additional details
778 SURFACE_FORMAT_P2UNORMPALETTE1 = 389, //!< No additional details
779 SURFACE_FORMAT_BC1UNORM = 390, //!< No additional details
780 SURFACE_FORMAT_BC2UNORM = 391, //!< No additional details
781 SURFACE_FORMAT_BC3UNORM = 392, //!< No additional details
782 SURFACE_FORMAT_BC4UNORM = 393, //!< No additional details
783 SURFACE_FORMAT_BC5UNORM = 394, //!< No additional details
784 SURFACE_FORMAT_BC1UNORMSRGB = 395, //!< No additional details
785 SURFACE_FORMAT_BC2UNORMSRGB = 396, //!< No additional details
786 SURFACE_FORMAT_BC3UNORMSRGB = 397, //!< No additional details
787 SURFACE_FORMAT_MONO8 = 398, //!< No additional details
788 SURFACE_FORMAT_YCRCBSWAPUV = 399, //!< No additional details
789 SURFACE_FORMAT_YCRCBSWAPY = 400, //!< No additional details
790 SURFACE_FORMAT_DXT1RGB = 401, //!< No additional details
791 SURFACE_FORMAT_FXT1 = 402, //!< No additional details
792 SURFACE_FORMAT_R8G8B8UNORM = 403, //!< No additional details
793 SURFACE_FORMAT_R8G8B8SNORM = 404, //!< No additional details
794 SURFACE_FORMAT_R8G8B8SSCALED = 405, //!< No additional details
795 SURFACE_FORMAT_R8G8B8USCALED = 406, //!< No additional details
796 SURFACE_FORMAT_R64G64B64A64FLOAT = 407, //!< No additional details
797 SURFACE_FORMAT_R64G64B64FLOAT = 408, //!< No additional details
798 SURFACE_FORMAT_BC4SNORM = 409, //!< No additional details
799 SURFACE_FORMAT_BC5SNORM = 410, //!< No additional details
800 SURFACE_FORMAT_R16G16B16FLOAT = 411, //!< No additional details
801 SURFACE_FORMAT_R16G16B16UNORM = 412, //!< No additional details
802 SURFACE_FORMAT_R16G16B16SNORM = 413, //!< No additional details
803 SURFACE_FORMAT_R16G16B16SSCALED = 414, //!< No additional details
804 SURFACE_FORMAT_R16G16B16USCALED = 415, //!< No additional details
805 SURFACE_FORMAT_BC6HSF16 = 417, //!< No additional details
806 SURFACE_FORMAT_BC7UNORM = 418, //!< No additional details
807 SURFACE_FORMAT_BC7UNORMSRGB = 419, //!< No additional details
808 SURFACE_FORMAT_BC6HUF16 = 420, //!< No additional details
809 SURFACE_FORMAT_PLANAR4208 = 421, //!< No additional details
810 SURFACE_FORMAT_PLANAR42016 = 422, //!< No additional details
811 SURFACE_FORMAT_R8G8B8UNORMSRGB = 424, //!< No additional details
812 SURFACE_FORMAT_ETC1RGB8 = 425, //!< No additional details
813 SURFACE_FORMAT_ETC2RGB8 = 426, //!< No additional details
814 SURFACE_FORMAT_EACR11 = 427, //!< No additional details
815 SURFACE_FORMAT_EACRG11 = 428, //!< No additional details
816 SURFACE_FORMAT_EACSIGNEDR11 = 429, //!< No additional details
817 SURFACE_FORMAT_EACSIGNEDRG11 = 430, //!< No additional details
818 SURFACE_FORMAT_ETC2SRGB8 = 431, //!< No additional details
819 SURFACE_FORMAT_R16G16B16UINT = 432, //!< No additional details
820 SURFACE_FORMAT_R16G16B16SINT = 433, //!< No additional details
821 SURFACE_FORMAT_R32SFIXED = 434, //!< No additional details
822 SURFACE_FORMAT_R10G10B10A2SNORM = 435, //!< No additional details
823 SURFACE_FORMAT_R10G10B10A2USCALED = 436, //!< No additional details
824 SURFACE_FORMAT_R10G10B10A2SSCALED = 437, //!< No additional details
825 SURFACE_FORMAT_R10G10B10A2SINT = 438, //!< No additional details
826 SURFACE_FORMAT_B10G10R10A2SNORM = 439, //!< No additional details
827 SURFACE_FORMAT_B10G10R10A2USCALED = 440, //!< No additional details
828 SURFACE_FORMAT_B10G10R10A2SSCALED = 441, //!< No additional details
829 SURFACE_FORMAT_B10G10R10A2UINT = 442, //!< No additional details
830 SURFACE_FORMAT_B10G10R10A2SINT = 443, //!< No additional details
831 SURFACE_FORMAT_R64G64B64A64PASSTHRU = 444, //!< No additional details
832 SURFACE_FORMAT_R64G64B64PASSTHRU = 445, //!< No additional details
833 SURFACE_FORMAT_ETC2RGB8PTA = 448, //!< No additional details
834 SURFACE_FORMAT_ETC2SRGB8PTA = 449, //!< No additional details
835 SURFACE_FORMAT_ETC2EACRGBA8 = 450, //!< No additional details
836 SURFACE_FORMAT_ETC2EACSRGB8A8 = 451, //!< No additional details
837 SURFACE_FORMAT_R8G8B8UINT = 456, //!< No additional details
838 SURFACE_FORMAT_R8G8B8SINT = 457, //!< No additional details
839 SURFACE_FORMAT_RAW = 511, //!< No additional details
840 };
841
842 //! \brief SURFACE_TYPE
843 //! \details
844 //! This field defines the type of the surface.
845 enum SURFACE_TYPE
846 {
847 SURFACE_TYPE_SURFTYPE1D = 0, //!< Defines a 1-dimensional map or array of maps
848 SURFACE_TYPE_SURFTYPE2D = 1, //!< Defines a 2-dimensional map or array of maps
849 SURFACE_TYPE_SURFTYPE3D = 2, //!< Defines a 3-dimensional (volumetric) map
850 SURFACE_TYPE_SURFTYPECUBE = 3, //!< Defines a cube map or array of cube maps
851 SURFACE_TYPE_SURFTYPEBUFFER = 4, //!< Defines an element in a buffer
852 SURFACE_TYPE_SURFTYPESTRBUF = 5, //!< Defines a structured buffer surface
853 SURFACE_TYPE_SURFTYPENULL = 7, //!< Defines a null surface
854 };
855
856 //! \brief SAMPLE_TAP_DISCARD_DISABLE
857 //! \details
858 //! This bit forces sample tap discard filter mode to be disabled for this
859 //! surface state. This bit must be set for surfaces which are no Alpha
860 //! Channel such as R8G8B8_UNORM.
861 enum SAMPLE_TAP_DISCARD_DISABLE
862 {
863 SAMPLE_TAP_DISCARD_DISABLE_DISABLE = 0, //!< When programmed to 0h, Sample Tap Discard filter mode is allowed and is not disabled by this bit. This bit is ignored if Sample Tap Discard is not enabled in the Sampler State.
864 SAMPLE_TAP_DISCARD_DISABLE_ENABLE = 1, //!< When programmed to 1h, Sample Tap Discard filter mode will be disabled even if enabled through Sampler State
865 };
866
867 //! \brief CORNER_TEXEL_MODE
868 //! \details
869 //! <p>This field, when ENABLED, indicates when a surface is using corner
870 //! texel-mode for sampling.</p>
871 //! <p>Corner Texel Mode is ignored for Planar YUV/YCrCb surface
872 //! formats.</p>
873 //! <p>Corner Texel Mode is ignored for sample_8X8 and sample_unorm messasge
874 //! types.</p>
875 //! <p>Does not support legacy sampler features set0 See legacy sampler page
876 //! for more details</p>
877 enum CORNER_TEXEL_MODE
878 {
879 CORNER_TEXEL_MODE_DISABLE = 0, //!< When programmed to 0h, Corner Texel Mode is disabled. This means texel coordinate references use standard texel reference mode, with respect to the center of the texel.
880 CORNER_TEXEL_MODE_ENABLE = 1, //!< When programmed to 1h, Corner Texel Mode is enabled. Texel coordinate references are with respect to the upper left corner of a texel.
881 };
882
883 //! \brief ENABLE_UNORM_PATH_IN_COLOR_PIPE
884 //! \details
885 //! Enables Unorm Path (fixed Point Conversion of floating point for fill
886 //! and blend in DAPRSS) in color Pipe.
887 enum ENABLE_UNORM_PATH_IN_COLOR_PIPE
888 {
889 ENABLE_UNORM_PATH_IN_COLOR_PIPE_UNNAMED0 = 0, //!< Disables Unorm path in Color Pipe.
890 ENABLE_UNORM_PATH_IN_COLOR_PIPE_UNNAMED1 = 1, //!< Enables Unorm Path in Color Pipe.
891 };
892
893 //! \brief STANDARD_TILING_MODE_EXTENSIONS
894 //! \details
895 //! <p>It changes in the MIP Tail Packing. When enabled (programmed to 1h),
896 //! MIP Tail packing for Volumetric and 1D are changed as defined in the
897 //! Surface Layout and Tiling</b><br />
898 //! <p></p>
899 enum STANDARD_TILING_MODE_EXTENSIONS
900 {
901 STANDARD_TILING_MODE_EXTENSIONS_DISABLE = 0, //!< When programmed to 0h, the Gen11 extensions to support Standard Tiling are disabled. Behavior reverts to Gen10 and Gen9 Miptail packing.
902 STANDARD_TILING_MODE_EXTENSIONS_ENABLE = 1, //!< When programmed to 1h, the Gen11 changes to support Standard Tiling Extensions are enabled. See the Surface Layout and Tiling section for details.
903 };
904
905 //! \brief TILE_ADDRESS_MAPPING_MODE
906 //! \details
907 //! This field is used to select between Gen9 Tile Address Mapping mode and
908 //! Gen10 for TileYs and TileYf.
909 enum TILE_ADDRESS_MAPPING_MODE
910 {
911 TILE_ADDRESS_MAPPING_MODE_GEN9 = 0, //!< Gen9 Tile Address Mapping ModeThou shalt program the bit to 0h. Thou shalt NOT program the bit to 1h. Thou shalt not program the bit to 2h. 3h is right out. The number of the programming shall be 0h and 0h shall be the number of the programming. Fractional numbers, being evil in our site (and impossible) must also not be used. Great disappointment and functional woes shall be seen if this bit is not programmed to 0h.
912 TILE_ADDRESS_MAPPING_MODE_GEN10 = 1, //!< Gen10+ Tile Address Mapping Mode (for Standard Tiling).<!--StartFragment-->Thou shalt not program the bit to 1h. Thou shalt program the bit to 0h. Thou shalt not program the bit to 2h. 3h is right out. The number of the programming shall be 0h and 0h shall be the number of the programming. Fractional numbers, being evil in our site (and impossible) must also not be used. Great disappointment and functional woes shall be seen if this bit is not programmed to 0h.<!--EndFragment-->
913 };
914
915 //! \brief NUMBER_OF_MULTISAMPLES
916 //! \details
917 //! This field indicates the number of multisamples on the surface.
918 enum NUMBER_OF_MULTISAMPLES
919 {
920 NUMBER_OF_MULTISAMPLES_MULTISAMPLECOUNT1 = 0, //!< No additional details
921 NUMBER_OF_MULTISAMPLES_MULTISAMPLECOUNT2 = 1, //!< No additional details
922 NUMBER_OF_MULTISAMPLES_MULTISAMPLECOUNT4 = 2, //!< No additional details
923 NUMBER_OF_MULTISAMPLES_MULTISAMPLECOUNT8 = 3, //!< No additional details
924 NUMBER_OF_MULTISAMPLES_MULTISAMPLECOUNT16 = 4, //!< No additional details
925 };
926
927 //! \brief MULTISAMPLED_SURFACE_STORAGE_FORMAT
928 //! \details
929 //! This field indicates the storage format of the multisampled surface.
930 enum MULTISAMPLED_SURFACE_STORAGE_FORMAT
931 {
932 MULTISAMPLED_SURFACE_STORAGE_FORMAT_MSS = 0, //!< Multisampled surface was/is rendered as a render target
933 MULTISAMPLED_SURFACE_STORAGE_FORMAT_DEPTHSTENCIL = 1, //!< Multisampled surface was rendered as a depth or stencil buffer
934 };
935
936 //! \brief RENDER_TARGET_AND_SAMPLE_UNORM_ROTATION
937 //! \details
938 //! <b>For Render Target Surfaces:</b>
939 //! This field specifies the rotation of this render target surface
940 //! when being written to memory.
941 enum RENDER_TARGET_AND_SAMPLE_UNORM_ROTATION
942 {
943 RENDER_TARGET_AND_SAMPLE_UNORM_ROTATION_0DEG = 0, //!< No rotation (0 degrees)
944 RENDER_TARGET_AND_SAMPLE_UNORM_ROTATION_90DEG = 1, //!< Rotate by 90 degrees
945 RENDER_TARGET_AND_SAMPLE_UNORM_ROTATION_180DEG = 2, //!< Rotate by 180 degrees [for sample_unorm message]
946 RENDER_TARGET_AND_SAMPLE_UNORM_ROTATION_270DEG = 3, //!< Rotate by 270 degrees
947 };
948
949 //! \brief COHERENCY_TYPE
950 //! \details
951 //! Specifies the type of coherency maintained for this surface.
952 enum COHERENCY_TYPE
953 {
954 COHERENCY_TYPE_GPUCOHERENT = 0, //!< Surface memory is kept coherent with GPU threads using GPU read/write ordering rules. Surface memory is backed by system memory but is not kept coherent with CPU (LLC).
955 COHERENCY_TYPE_IACOHERENT = 1, //!< Surface memory is kept coherent with CPU (LLC).
956 };
957
958 //! \brief TILED_RESOURCE_MODE
959 //! \details
960 //! <b>For Sampling Engine, Render Target, and Typed/Untyped Surfaces:</b>
961 //! This field specifies the tiled resource mode.
962 //!
963 //! <b>For other surfaces:</b>
964 //! This field is ignored.
965 enum TILED_RESOURCE_MODE
966 {
967 TILED_RESOURCE_MODE_NONE = 0, //!< No tiled resource
968 TILED_RESOURCE_MODE_4KB = 1, //!< 4KB tiled resources
969 TILED_RESOURCE_MODE_TILEYF = 1, //!< 4KB tiled resources
970 TILED_RESOURCE_MODE_64KB = 2, //!< 64KB tiled resources
971 TILED_RESOURCE_MODE_TILEYS = 2, //!< 64KB tiled resources
972 };
973
974 //! \brief EWA_DISABLE_FOR_CUBE
975 //! \details
976 //! Specifies if EWA mode for LOD quality improvement needs to be disabled
977 //! for cube maps.
978 enum EWA_DISABLE_FOR_CUBE
979 {
980 EWA_DISABLE_FOR_CUBE_ENABLE = 0, //!< EWA is enabled for cube maps
981 EWA_DISABLE_FOR_CUBE_DISABLE = 1, //!< EWA is disabled for cube maps
982 };
983
984 //! \brief AUXILIARY_SURFACE_MODE
985 //! \details
986 //! Specifies what type of surface the Auxiliary surface is. The Auxiliary
987 //! surface has its own base address and pitch, but otherwise shares or
988 //! overrides other fields set for the primary surface, detailed in the
989 //! programming notes below.
990 enum AUXILIARY_SURFACE_MODE
991 {
992 AUXILIARY_SURFACE_MODE_AUXNONE = 0, //!< No Auxiliary surface is used
993 AUXILIARY_SURFACE_MODE_AUXCCSD = 1, //!< The Auxiliary surface is a CCS (Color Control Surface) with compression disabled or an MCS with compression enabled, depending on Number of Multisamples. MCS (Multisample Control Surface) is a special type of CCS.
994 AUXILIARY_SURFACE_MODE_AUXAPPEND = 2, //!< The Auxiliary surface is an append buffer
995 AUXILIARY_SURFACE_MODE_AUXHIZ = 3, //!< The Auxiliary surface is a hierarchical depth buffer
996 AUXILIARY_SURFACE_MODE_AUXCCSE = 5, //!< The Auxiliary surface is a CCS with compression enabled or an MCS with compression enabled, depending on Number of Multisamples.
997 };
998
999 //! \brief YUV_INTERPOLATION_ENABLE
1000 //! \details
1001 //! This bit controls whether a Non-Planar YUV4:2:2 and Planar YUV4:2:0
1002 //! surface use interpolated or replicated U and V channels for input to the
1003 //! Sampler filter. Programming to 1h causes interpolation of U and V
1004 //! channels. In this case the chrominance for odd pixels is computed by an
1005 //! interpolation between adjacent even pixels. Programming to 0h causes the
1006 //! chrominance to be copied from the pixel to the left.
1007 enum YUV_INTERPOLATION_ENABLE
1008 {
1009 YUV_INTERPOLATION_ENABLE_DISABLE = 0, //!< Programming to 0h causes the sampler to replicate U and V channels.  This will lead to lower quality in certain cases where the YUV surface is being filtered (e.g. linear).
1010 YUV_INTERPOLATION_ENABLE_ENABLE = 1, //!< Programming to 1h causes the sampler to interpolate the U and V channels between the horizonally neighboring pixels.  This will improvie image quality if the surface is being filtered.
1011 };
1012
1013 //! \brief HALF_PITCH_FOR_CHROMA
1014 //! \details
1015 //! <p><span style="font-family: &quot;Arial&quot;,&quot;sans-serif&quot;;
1016 //! font-size: 10pt; mso-fareast-font-family: &quot;Times New Roman&quot;;
1017 //! mso-ansi-language: EN-US; mso-fareast-language: EN-US;
1018 //! mso-bidi-language: AR-SA;"><font color="#000000">This bit enables
1019 //! support for half-pitch chroma planes for Planar YUV surfaces. It is
1020 //! ignored for Non-Planar surfaces. For planar surfaces it allows the
1021 //! chroma planes to be one-half the width of a the Y (Luma)
1022 //! plane.</font></span></p>
1023 //! <p><span style="font-family: &quot;Arial&quot;,&quot;sans-serif&quot;;
1024 //! font-size: 10pt; mso-fareast-font-family: &quot;Times New Roman&quot;;
1025 //! mso-ansi-language: EN-US; mso-fareast-language: EN-US;
1026 //! mso-bidi-language: AR-SA;"><font color="#000000">For example, should be
1027 //! set to 0h for NV12 surfaces.</font></span></p>
1028 //! <p><span style="font-family: &quot;Arial&quot;,&quot;sans-serif&quot;;
1029 //! font-size: 10pt; mso-fareast-font-family: &quot;Times New Roman&quot;;
1030 //! mso-ansi-language: EN-US; mso-fareast-language: EN-US;
1031 //! mso-bidi-language: AR-SA;"><font color="#000000">Must be set to 1h for
1032 //! YV12 surfaces.</font></span></p>
1033 enum HALF_PITCH_FOR_CHROMA
1034 {
1035 HALF_PITCH_FOR_CHROMA_DISABLE = 0, //!< <font color="#000000">Setting this bit to 0h (default) causes Chroma planes to be treated as full width (same as Y plane).</font>
1036 HALF_PITCH_FOR_CHROMA_ENABLE = 1, //!< <font color="#000000">Setting this bit to 1h causes Chroma planes (U and V) to be treated as half the width of the Luma (Y) plane.</font>
1037 };
1038
1039 //! \brief SHADER_CHANNEL_SELECT_ALPHA
1040 //! \details
1041 //! See <b>Shader Channel Select Red</b> for details.
1042 enum SHADER_CHANNEL_SELECT_ALPHA
1043 {
1044 SHADER_CHANNEL_SELECT_ALPHA_ZERO = 0, //!< No additional details
1045 SHADER_CHANNEL_SELECT_ALPHA_ONE = 1, //!< No additional details
1046 SHADER_CHANNEL_SELECT_ALPHA_RED = 4, //!< No additional details
1047 SHADER_CHANNEL_SELECT_ALPHA_GREEN = 5, //!< No additional details
1048 SHADER_CHANNEL_SELECT_ALPHA_BLUE = 6, //!< No additional details
1049 SHADER_CHANNEL_SELECT_ALPHA_ALPHA = 7, //!< No additional details
1050 };
1051
1052 //! \brief SHADER_CHANNEL_SELECT_BLUE
1053 //! \details
1054 //! See <b>Shader Channel Select Red</b> for details.
1055 enum SHADER_CHANNEL_SELECT_BLUE
1056 {
1057 SHADER_CHANNEL_SELECT_BLUE_ZERO = 0, //!< No additional details
1058 SHADER_CHANNEL_SELECT_BLUE_ONE = 1, //!< No additional details
1059 SHADER_CHANNEL_SELECT_BLUE_RED = 4, //!< No additional details
1060 SHADER_CHANNEL_SELECT_BLUE_GREEN = 5, //!< No additional details
1061 SHADER_CHANNEL_SELECT_BLUE_BLUE = 6, //!< No additional details
1062 SHADER_CHANNEL_SELECT_BLUE_ALPHA = 7, //!< No additional details
1063 };
1064
1065 //! \brief SHADER_CHANNEL_SELECT_GREEN
1066 //! \details
1067 //! See <b>Shader Channel Select Red</b> for details.
1068 enum SHADER_CHANNEL_SELECT_GREEN
1069 {
1070 SHADER_CHANNEL_SELECT_GREEN_ZERO = 0, //!< No additional details
1071 SHADER_CHANNEL_SELECT_GREEN_ONE = 1, //!< No additional details
1072 SHADER_CHANNEL_SELECT_GREEN_RED = 4, //!< No additional details
1073 SHADER_CHANNEL_SELECT_GREEN_GREEN = 5, //!< No additional details
1074 SHADER_CHANNEL_SELECT_GREEN_BLUE = 6, //!< No additional details
1075 SHADER_CHANNEL_SELECT_GREEN_ALPHA = 7, //!< No additional details
1076 };
1077
1078 //! \brief SHADER_CHANNEL_SELECT_RED
1079 //! \details
1080 //! Specifies which surface channel is read or written in the Red shader
1081 //! channel.
1082 enum SHADER_CHANNEL_SELECT_RED
1083 {
1084 SHADER_CHANNEL_SELECT_RED_ZERO = 0, //!< No additional details
1085 SHADER_CHANNEL_SELECT_RED_ONE = 1, //!< No additional details
1086 SHADER_CHANNEL_SELECT_RED_RED = 4, //!< No additional details
1087 SHADER_CHANNEL_SELECT_RED_GREEN = 5, //!< No additional details
1088 SHADER_CHANNEL_SELECT_RED_BLUE = 6, //!< No additional details
1089 SHADER_CHANNEL_SELECT_RED_ALPHA = 7, //!< No additional details
1090 };
1091
1092 //! \brief MEMORY_COMPRESSION_MODE
1093 //! \details
1094 //! Distinguishes Vertical from Horizontal compression.
1095 enum MEMORY_COMPRESSION_MODE
1096 {
1097 MEMORY_COMPRESSION_MODE_HORIZONTAL = 0, //!< No additional details
1098 MEMORY_COMPRESSION_MODE_VERTICAL = 1, //!< No additional details
1099 };
1100
1101 //! \brief CLEAR_VALUE_ADDRESS_ENABLE
1102 //! \details
1103 //! This field enables HW Managed Clear Value Layout for the Surface State.
1104 //! If this bit is enabled, Clear Value Address is present instead of
1105 //! explicit clear values.
1106 enum CLEAR_VALUE_ADDRESS_ENABLE
1107 {
1108 CLEAR_VALUE_ADDRESS_ENABLE_DISABLE = 0, //!< Clear values are present in the surface state explicitly.
1109 CLEAR_VALUE_ADDRESS_ENABLE_ENABLE = 1, //!< Clear value Address is present instead of explicit clear values.
1110 };
1111
1112 //! \name Initializations
1113
1114 //! \brief Explicit member initialization function
1115 RENDER_SURFACE_STATE_CMD();
1116
1117 static const size_t dwSize = 16;
1118 static const size_t byteSize = 64;
1119 };
1120
1121 //!
1122 //! \brief MEDIA_SURFACE_STATE
1123 //! \details
1124 //! This is the SURFACE_STATE used by only deinterlace, sample_8x8, and VME
1125 //! messages.
1126 //!
1127 struct MEDIA_SURFACE_STATE_CMD
1128 {
1129 union
1130 {
1131 //!< DWORD 0
1132 struct
1133 {
1134 uint32_t Reserved0 : __CODEGEN_BITFIELD( 0, 15) ; //!< Reserved
1135 uint32_t YOffset : __CODEGEN_BITFIELD(16, 19) ; //!< Y Offset, [Surface Format] is one of Planar Formats
1136 uint32_t XOffset : __CODEGEN_BITFIELD(20, 26) ; //!< X Offset, [Surface Format] is one of Planar Formats
1137 uint32_t Reserved27 : __CODEGEN_BITFIELD(27, 29) ; //!< Reserved, [Surface Format] is one of Planar Formats
1138 uint32_t Rotation : __CODEGEN_BITFIELD(30, 31) ; //!< ROTATION
1139 };
1140 uint32_t Value;
1141 } DW0;
1142 union
1143 {
1144 //!< DWORD 1
1145 struct
1146 {
1147 uint32_t CrVCbUPixelOffsetVDirection : __CODEGEN_BITFIELD( 0, 1) ; //!< CRVCBU_PIXEL_OFFSET_V_DIRECTION
1148 uint32_t PictureStructure : __CODEGEN_BITFIELD( 2, 3) ; //!< PICTURE_STRUCTURE
1149 uint32_t Width : __CODEGEN_BITFIELD( 4, 17) ; //!< Width
1150 uint32_t Height : __CODEGEN_BITFIELD(18, 31) ; //!< Height
1151 };
1152 uint32_t Value;
1153 } DW1;
1154 union
1155 {
1156 //!< DWORD 2
1157 struct
1158 {
1159 uint32_t TileMode : __CODEGEN_BITFIELD( 0, 1) ; //!< TILE_MODE
1160 uint32_t HalfPitchForChroma : __CODEGEN_BITFIELD( 2, 2) ; //!< Half Pitch for Chroma
1161 uint32_t SurfacePitch : __CODEGEN_BITFIELD( 3, 20) ; //!< Surface Pitch
1162 uint32_t AddressControl : __CODEGEN_BITFIELD(21, 21) ; //!< ADDRESS_CONTROL
1163 uint32_t MemoryCompressionEnable : __CODEGEN_BITFIELD(22, 22) ; //!< Memory Compression Enable
1164 uint32_t MemoryCompressionMode : __CODEGEN_BITFIELD(23, 23) ; //!< MEMORY_COMPRESSION_MODE
1165 uint32_t CrVCbUPixelOffsetVDirectionMsb : __CODEGEN_BITFIELD(24, 24) ; //!< CRVCBU_PIXEL_OFFSET_V_DIRECTION_MSB
1166 uint32_t CrVCbUPixelOffsetUDirection : __CODEGEN_BITFIELD(25, 25) ; //!< CRVCBU_PIXEL_OFFSET_U_DIRECTION
1167 uint32_t InterleaveChroma : __CODEGEN_BITFIELD(26, 26) ; //!< Interleave Chroma
1168 uint32_t SurfaceFormat : __CODEGEN_BITFIELD(27, 31) ; //!< SURFACE_FORMAT
1169 };
1170 uint32_t Value;
1171 } DW2;
1172 union
1173 {
1174 //!< DWORD 3
1175 struct
1176 {
1177 uint32_t YOffsetForUCb : __CODEGEN_BITFIELD( 0, 13) ; //!< Y Offset for U(Cb)
1178 uint32_t Reserved110 : __CODEGEN_BITFIELD(14, 15) ; //!< Reserved
1179 uint32_t XOffsetForUCb : __CODEGEN_BITFIELD(16, 29) ; //!< X Offset for U(Cb)
1180 uint32_t Reserved126 : __CODEGEN_BITFIELD(30, 31) ; //!< Reserved
1181 };
1182 uint32_t Value;
1183 } DW3;
1184 union
1185 {
1186 //!< DWORD 4
1187 struct
1188 {
1189 uint32_t YOffsetForVCr : __CODEGEN_BITFIELD( 0, 14) ; //!< Y Offset for V(Cr)
1190 uint32_t Reserved143 : __CODEGEN_BITFIELD(15, 15) ; //!< Reserved
1191 uint32_t XOffsetForVCr : __CODEGEN_BITFIELD(16, 29) ; //!< X Offset for V(Cr)
1192 uint32_t Reserved158 : __CODEGEN_BITFIELD(30, 31) ; //!< Reserved
1193 };
1194 uint32_t Value;
1195 } DW4;
1196 union
1197 {
1198 //!< DWORD 5
1199 struct
1200 {
1201 uint32_t SurfaceMemoryObjectControlState : __CODEGEN_BITFIELD( 0, 6) ; //!< SURFACE_MEMORY_OBJECT_CONTROL_STATE
1202 uint32_t Reserved167 : __CODEGEN_BITFIELD( 7, 17) ; //!< Reserved
1203 uint32_t TiledResourceMode : __CODEGEN_BITFIELD(18, 19) ; //!< TILED_RESOURCE_MODE
1204 uint32_t Depth : __CODEGEN_BITFIELD(20, 23) ; //!< Depth
1205 uint32_t Reserved184 : __CODEGEN_BITFIELD(24, 29) ; //!< Reserved
1206 uint32_t VerticalLineStrideOffset : __CODEGEN_BITFIELD(30, 30) ; //!< Vertical Line Stride Offset
1207 uint32_t VerticalLineStride : __CODEGEN_BITFIELD(31, 31) ; //!< Vertical Line Stride
1208 };
1209 uint32_t Value;
1210 } DW5;
1211 union
1212 {
1213 //!< DWORD 6
1214 struct
1215 {
1216 uint32_t SurfaceBaseAddress ; //!< Surface Base Address
1217 };
1218 uint32_t Value;
1219 } DW6;
1220 union
1221 {
1222 //!< DWORD 7
1223 struct
1224 {
1225 uint32_t SurfaceBaseAddressHigh : __CODEGEN_BITFIELD( 0, 15) ; //!< Surface Base Address High
1226 uint32_t Reserved240 : __CODEGEN_BITFIELD(16, 31) ; //!< Reserved
1227 };
1228 uint32_t Value;
1229 } DW7;
1230
1231 //! \name Local enumerations
1232
1233 //! \brief ROTATION
1234 //! \details
1235 //! Rotation is only supported only with AVS function messages and not with
1236 //! HDC direct write and 16x8 AVS messages.
1237 enum ROTATION
1238 {
1239 ROTATION_NOROTATIONOR0DEGREE = 0, //!< No additional details
1240 ROTATION_90DEGREEROTATION = 1, //!< No additional details
1241 ROTATION_180DEGREEROTATION = 2, //!< No additional details
1242 ROTATION_270DEGREEROTATION = 3, //!< No additional details
1243 };
1244
1245 //! \brief CRVCBU_PIXEL_OFFSET_V_DIRECTION
1246 //! \details
1247 //! Specifies the distance to the U/V values with respect to the even
1248 //! numbered Y channels in the V direction
1249 enum CRVCBU_PIXEL_OFFSET_V_DIRECTION
1250 {
1251 CRVCBU_PIXEL_OFFSET_V_DIRECTION_UNNAMED0 = 0, //!< No additional details
1252 };
1253
1254 //! \brief PICTURE_STRUCTURE
1255 //! \details
1256 //! Specifies the encoding of the current picture.
1257 enum PICTURE_STRUCTURE
1258 {
1259 PICTURE_STRUCTURE_FRAMEPICTURE = 0, //!< No additional details
1260 PICTURE_STRUCTURE_TOPFIELDPICTURE = 1, //!< No additional details
1261 PICTURE_STRUCTURE_BOTTOMFIELDPICTURE = 2, //!< No additional details
1262 PICTURE_STRUCTURE_INVALID_NOTALLOWED = 3, //!< No additional details
1263 };
1264
1265 //! \brief TILE_MODE
1266 //! \details
1267 //! This field specifies the type of memory tiling (Linear, WMajor, XMajor,
1268 //! or YMajor) employed to tile this surface. See Memory Interface Functions
1269 //! for details on memory tiling and restrictions.
1270 enum TILE_MODE
1271 {
1272 TILE_MODE_TILEMODELINEAR = 0, //!< Linear mode (no tiling)
1273 TILE_MODE_TILEMODEXMAJOR = 2, //!< X major tiling
1274 TILE_MODE_TILEMODEYMAJOR = 3, //!< Y major tiling
1275 };
1276
1277 enum ADDRESS_CONTROL
1278 {
1279 ADDRESS_CONTROL_CLAMP = 0, //!< Clamp
1280 ADDRESS_CONTROL_MIRROR = 1, //!< Mirror
1281 };
1282
1283 //! \brief MEMORY_COMPRESSION_MODE
1284 //! \details
1285 //! Distinguishes Vertical from Horizontal compression.
1286 enum MEMORY_COMPRESSION_MODE
1287 {
1288 MEMORY_COMPRESSION_MODE_HORIZONTALCOMPRESSIONMODE = 0, //!< No additional details
1289 MEMORY_COMPRESSION_MODE_VERTICALCOMPRESSIONMODE = 1, //!< No additional details
1290 };
1291
1292 //! \brief CRVCBU_PIXEL_OFFSET_V_DIRECTION_MSB
1293 //! \details
1294 //! Specifies the distance to the U/V values with respect to the even
1295 //! numbered Y channels in the V direction
1296 enum CRVCBU_PIXEL_OFFSET_V_DIRECTION_MSB
1297 {
1298 CRVCBU_PIXEL_OFFSET_V_DIRECTION_MSB_UNNAMED0 = 0, //!< No additional details
1299 };
1300
1301 //! \brief CRVCBU_PIXEL_OFFSET_U_DIRECTION
1302 //! \details
1303 //! Specifies the distance to the U/V values with respect to the even
1304 //! numbered Y channels in the U direction
1305 enum CRVCBU_PIXEL_OFFSET_U_DIRECTION
1306 {
1307 CRVCBU_PIXEL_OFFSET_U_DIRECTION_UNNAMED0 = 0, //!< No additional details
1308 };
1309
1310 //! \brief SURFACE_FORMAT
1311 //! \details
1312 //! Specifies the format of the surface. All of the Y and G channels will
1313 //! use table 0 and all of the Cr/Cb/R/B channels will use table 1.
1314 enum SURFACE_FORMAT
1315 {
1316 SURFACE_FORMAT_YCRCBNORMAL = 0, //!< No additional details
1317 SURFACE_FORMAT_YCRCBSWAPUVY = 1, //!< No additional details
1318 SURFACE_FORMAT_YCRCBSWAPUV = 2, //!< No additional details
1319 SURFACE_FORMAT_YCRCBSWAPY = 3, //!< No additional details
1320 SURFACE_FORMAT_PLANAR4208 = 4, //!< No additional details
1321 SURFACE_FORMAT_Y8UNORMVA = 5, //!< Sample_8x8 only except AVS
1322 SURFACE_FORMAT_Y16SNORM = 6, //!< Sample_8x8 only except AVS
1323 SURFACE_FORMAT_Y16UNORMVA = 7, //!< Sample_8x8 only except AVS
1324 SURFACE_FORMAT_R10G10B10A2UNORM = 8, //!< Sample_8x8 only
1325 SURFACE_FORMAT_R8G8B8A8UNORM = 9, //!< Sample_8x8 AVS only
1326 SURFACE_FORMAT_R8B8UNORM_CRCB = 10, //!< Sample_8x8 AVS only
1327 SURFACE_FORMAT_R8UNORM_CRCB = 11, //!< Sample_8x8 AVS only
1328 SURFACE_FORMAT_Y8UNORM = 12, //!< Sample_8x8 AVS only
1329 SURFACE_FORMAT_A8Y8U8V8UNORM = 13, //!< Sample_8x8 AVS only
1330 SURFACE_FORMAT_B8G8R8A8UNORM = 14, //!< Sample_8x8 AVS only
1331 SURFACE_FORMAT_R16G16B16A16 = 15, //!< Sample_8x8 AVS only
1332 SURFACE_FORMAT_Y1UNORM = 16, //!< Sample_8x8 only for boolean surfaces (1bit/pixel)
1333 SURFACE_FORMAT_Y32UNORM = 17, //!< For Integral Image (32bpp)
1334 SURFACE_FORMAT_PLANAR4228 = 18, //!< Sample_8x8 AVS only
1335 SURFACE_FORMAT_FMSTRBUFY1 = 19, //!< Structure Buffer 1bit/element Sample_8x8 only feature matching
1336 SURFACE_FORMAT_FMSTRBUFY8 = 20, //!< Structure Buffer 8bit/element Sample_8x8 only feature matching
1337 SURFACE_FORMAT_FMSTRBUFY16 = 21, //!< Structure Buffer 16bit/element Sample_8x8 only feature matching
1338 SURFACE_FORMAT_FMSTRBUFY32 = 22, //!< Used for Index Table only. 32bit per entry.
1339 SURFACE_FORMAT_PLANAR42016 = 23, //!< Sample_8x8 AVS only
1340 SURFACE_FORMAT_R16B16UNORM_CRCB = 24, //!< Sample_8x8 AVS only
1341 SURFACE_FORMAT_R16UNORM_CRCB = 25, //!< Sample_8x8 AVS only
1342 SURFACE_FORMAT_Y16UNORM = 26, //!< Sample_8x8 AVS only
1343 };
1344
1345 //! \brief SURFACE_MEMORY_OBJECT_CONTROL_STATE
1346 //! \details
1347 //! This 7-bit field is used in various state commands and indirect state
1348 //! objects to define cacheability and other attributes related to memory
1349 //! objects.
1350 enum SURFACE_MEMORY_OBJECT_CONTROL_STATE
1351 {
1352 SURFACE_MEMORY_OBJECT_CONTROL_STATE_DEFAULTVAUEDESC = 0, //!< No additional details
1353 };
1354
1355 //! \brief TILED_RESOURCE_MODE
1356 //! \details
1357 //! <b>For Sampling Engine, Render Target, and Typed/Untyped Surfaces:</b>
1358 //! This field specifies the tiled resource mode.
1359 //! <b>For other surfaces:</b>
1360 //! This field is ignored.
1361 enum TILED_RESOURCE_MODE
1362 {
1363 TILED_RESOURCE_MODE_TRMODENONE = 0, //!< No tiled resource
1364 TILED_RESOURCE_MODE_TRMODETILEYF = 1, //!< 4KB tiled resources
1365 TILED_RESOURCE_MODE_TRMODETILEYS = 2, //!< 64KB tiled resources
1366 };
1367
1368 //! \name Initializations
1369
1370 //! \brief Explicit member initialization function
1371 MEDIA_SURFACE_STATE_CMD();
1372
1373 static const size_t dwSize = 8;
1374 static const size_t byteSize = 32;
1375 };
1376
1377 //!
1378 //! \brief SAMPLER_STATE
1379 //! \details
1380 //! This is the normal sampler state used by all messages that use
1381 //! SAMPLER_STATE except sample_8x8 and deinterlace. The sampler state is
1382 //! stored as an array of up to 16 elements, each of which contains the
1383 //! dwords described here. The start of each element is spaced 4 dwords
1384 //! apart. The first element of the sampler state array is aligned to a
1385 //! 32-byte boundary.
1386 //!
1387 struct SAMPLER_STATE_CMD
1388 {
1389 union
1390 {
1391 //!< DWORD 0
1392 struct
1393 {
1394 uint32_t LodAlgorithm : __CODEGEN_BITFIELD( 0, 0) ; //!< LOD_ALGORITHM
1395 uint32_t TextureLodBias : __CODEGEN_BITFIELD( 1, 13) ; //!< Texture LOD Bias
1396 uint32_t MinModeFilter : __CODEGEN_BITFIELD(14, 16) ; //!< MIN_MODE_FILTER
1397 uint32_t MagModeFilter : __CODEGEN_BITFIELD(17, 19) ; //!< MAG_MODE_FILTER
1398 uint32_t MipModeFilter : __CODEGEN_BITFIELD(20, 21) ; //!< MIP_MODE_FILTER
1399 uint32_t CoarseLodQualityMode : __CODEGEN_BITFIELD(22, 26) ; //!< COARSE_LOD_QUALITY_MODE
1400 uint32_t LodPreclampMode : __CODEGEN_BITFIELD(27, 28) ; //!< LOD_PRECLAMP_MODE
1401 uint32_t TextureBorderColorMode : __CODEGEN_BITFIELD(29, 29) ; //!< TEXTURE_BORDER_COLOR_MODE
1402 uint32_t CpsLodCompensationEnable : __CODEGEN_BITFIELD(30, 30) ; //!< CPS LOD Compensation Enable
1403 uint32_t SamplerDisable : __CODEGEN_BITFIELD(31, 31) ; //!< Sampler Disable
1404 };
1405 uint32_t Value;
1406 } DW0;
1407 union
1408 {
1409 //!< DWORD 1
1410 struct
1411 {
1412 uint32_t CubeSurfaceControlMode : __CODEGEN_BITFIELD( 0, 0) ; //!< CUBE_SURFACE_CONTROL_MODE
1413 uint32_t ShadowFunction : __CODEGEN_BITFIELD( 1, 3) ; //!< SHADOW_FUNCTION
1414 uint32_t ChromakeyMode : __CODEGEN_BITFIELD( 4, 4) ; //!< CHROMAKEY_MODE
1415 uint32_t ChromakeyIndex : __CODEGEN_BITFIELD( 5, 6) ; //!< ChromaKey Index
1416 uint32_t ChromakeyEnable : __CODEGEN_BITFIELD( 7, 7) ; //!< ChromaKey Enable
1417 uint32_t MaxLod : __CODEGEN_BITFIELD( 8, 19) ; //!< Max LOD
1418 uint32_t MinLod : __CODEGEN_BITFIELD(20, 31) ; //!< Min LOD
1419 };
1420 uint32_t Value;
1421 } DW1;
1422 union
1423 {
1424 //!< DWORD 2
1425 struct
1426 {
1427 uint32_t LodClampMagnificationMode : __CODEGEN_BITFIELD( 0, 0) ; //!< LOD_CLAMP_MAGNIFICATION_MODE
1428 uint32_t SrgbDecode : __CODEGEN_BITFIELD( 1, 1) ; //!< SRGB_DECODE
1429 uint32_t ReturnFilterWeightForNullTexels : __CODEGEN_BITFIELD( 2, 2) ; //!< RETURN_FILTER_WEIGHT_FOR_NULL_TEXELS
1430 uint32_t ReturnFilterWeightForBorderTexels : __CODEGEN_BITFIELD( 3, 3) ; //!< RETURN_FILTER_WEIGHT_FOR_BORDER_TEXELS
1431 uint32_t Reserved68 : __CODEGEN_BITFIELD( 4, 5) ; //!< Reserved
1432 uint32_t IndirectStatePointer : __CODEGEN_BITFIELD( 6, 23) ; //!< Indirect State Pointer
1433 uint32_t Reserved88 : __CODEGEN_BITFIELD(24, 31) ; //!< Reserved
1434 };
1435 uint32_t Value;
1436 } DW2;
1437 union
1438 {
1439 //!< DWORD 3
1440 struct
1441 {
1442 uint32_t TczAddressControlMode : __CODEGEN_BITFIELD( 0, 2) ; //!< TCZ_ADDRESS_CONTROL_MODE
1443 uint32_t TcyAddressControlMode : __CODEGEN_BITFIELD( 3, 5) ; //!< TCY_ADDRESS_CONTROL_MODE
1444 uint32_t TcxAddressControlMode : __CODEGEN_BITFIELD( 6, 8) ; //!< TCX_ADDRESS_CONTROL_MODE
1445 uint32_t ReductionTypeEnable : __CODEGEN_BITFIELD( 9, 9) ; //!< Reduction Type Enable
1446 uint32_t NonNormalizedCoordinateEnable : __CODEGEN_BITFIELD(10, 10) ; //!< Non-normalized Coordinate Enable
1447 uint32_t TrilinearFilterQuality : __CODEGEN_BITFIELD(11, 12) ; //!< TRILINEAR_FILTER_QUALITY
1448 uint32_t RAddressMinFilterRoundingEnable : __CODEGEN_BITFIELD(13, 13) ; //!< R Address Min Filter Rounding Enable
1449 uint32_t RAddressMagFilterRoundingEnable : __CODEGEN_BITFIELD(14, 14) ; //!< R Address Mag Filter Rounding Enable
1450 uint32_t VAddressMinFilterRoundingEnable : __CODEGEN_BITFIELD(15, 15) ; //!< V Address Min Filter Rounding Enable
1451 uint32_t VAddressMagFilterRoundingEnable : __CODEGEN_BITFIELD(16, 16) ; //!< V Address Mag Filter Rounding Enable
1452 uint32_t UAddressMinFilterRoundingEnable : __CODEGEN_BITFIELD(17, 17) ; //!< U Address Min Filter Rounding Enable
1453 uint32_t UAddressMagFilterRoundingEnable : __CODEGEN_BITFIELD(18, 18) ; //!< U Address Mag Filter Rounding Enable
1454 uint32_t MaximumAnisotropy : __CODEGEN_BITFIELD(19, 21) ; //!< MAXIMUM_ANISOTROPY
1455 uint32_t ReductionType : __CODEGEN_BITFIELD(22, 23) ; //!< REDUCTION_TYPE
1456 uint32_t Reserved120 : __CODEGEN_BITFIELD(24, 31) ; //!< Reserved
1457 };
1458 uint32_t Value;
1459 } DW3;
1460
1461 //! \name Local enumerations
1462
1463 //! \brief LOD_ALGORITHM
1464 //! \details
1465 //! Controls which algorithm is used for LOD calculation. Generally, the EWA
1466 //! approximation algorithm results in higher image quality than the legacy
1467 //! algorithm.
1468 enum LOD_ALGORITHM
1469 {
1470 LOD_ALGORITHM_LEGACY = 0, //!< Use the legacy algorithm for anisotropic filtering
1471 LOD_ALGORITHM_EWAAPPROXIMATION = 1, //!< Use the new EWA approximation algorithm for anisotropic filtering
1472 };
1473
1474 //! \brief MIN_MODE_FILTER
1475 //! \details
1476 //! This field determines how texels are sampled/filtered when a texture is
1477 //! being "minified" (shrunk). For volume maps, this filter mode selection
1478 //! also applies to the 3rd (inter-layer) dimension.See Mag Mode Filter
1479 enum MIN_MODE_FILTER
1480 {
1481 MIN_MODE_FILTER_NEAREST = 0, //!< Sample the nearest texel
1482 MIN_MODE_FILTER_LINEAR = 1, //!< Bilinearly filter the 4 nearest texels
1483 MIN_MODE_FILTER_ANISOTROPIC = 2, //!< Perform an "anisotropic" filter on the chosen mip level
1484 MIN_MODE_FILTER_MONO = 6, //!< Perform a monochrome convolution filter
1485 };
1486
1487 //! \brief MAG_MODE_FILTER
1488 //! \details
1489 //! This field determines how texels are sampled/filtered when a texture is
1490 //! being "magnified" (enlarged). For volume maps, this filter mode
1491 //! selection also applies to the 3rd (inter-layer) dimension.
1492 enum MAG_MODE_FILTER
1493 {
1494 MAG_MODE_FILTER_NEAREST = 0, //!< Sample the nearest texel
1495 MAG_MODE_FILTER_LINEAR = 1, //!< Bilinearly filter the 4 nearest texels
1496 MAG_MODE_FILTER_ANISOTROPIC = 2, //!< Perform an "anisotropic" filter on the chosen mip level
1497 MAG_MODE_FILTER_MONO = 6, //!< Perform a monochrome convolution filter
1498 };
1499
1500 //! \brief MIP_MODE_FILTER
1501 //! \details
1502 //! This field determines if and how mip map levels are chosen and/or
1503 //! combined when texture filtering.
1504 enum MIP_MODE_FILTER
1505 {
1506 MIP_MODE_FILTER_NONE = 0, //!< Disable mip mapping - force use of the mipmap level corresponding to Min LOD.
1507 MIP_MODE_FILTER_NEAREST = 1, //!< Nearest, Select the nearest mip map
1508 MIP_MODE_FILTER_LINEAR = 3, //!< Linearly interpolate between nearest mip maps (combined with linear min/mag filters this is analogous to "Trilinear" filtering).
1509 };
1510
1511 //! \brief COARSE_LOD_QUALITY_MODE
1512 //! \details
1513 //! This field configures the coarse LOD image quality mode for the
1514 //! sample_d, sample_l, and sample_b messages in the sampling engine. In
1515 //! general, performance will increase and power consumption will decrease
1516 //! with each step of reduced quality (performance gain for sample_l and
1517 //! sample_b will be minimal).
1518 enum COARSE_LOD_QUALITY_MODE
1519 {
1520 COARSE_LOD_QUALITY_MODE_DISABLED = 0, //!< Full quality is enabled, matching prior products
1521 };
1522
1523 //! \brief LOD_PRECLAMP_MODE
1524 //! \details
1525 //! <p>This field determines whether the computed LOD is clamped to
1526 //! [max,min] mip level
1527 //! before the mag-vs-min determination is performed.</p>
1528 enum LOD_PRECLAMP_MODE
1529 {
1530 LOD_PRECLAMP_MODE_NONE = 0, //!< LOD PreClamp disabled
1531 LOD_PRECLAMP_MODE_OGL = 2, //!< LOD PreClamp enabled (OGL mode)
1532 };
1533
1534 //! \brief TEXTURE_BORDER_COLOR_MODE
1535 //! \details
1536 //! For some surface formats, the 32 bit border color is decoded differently
1537 //! based on the border color mode. In addition, the default value of
1538 //! channels not included in the surface may be affected by this field.
1539 //! Refer to the "Sampler Output Channel Mapping" table for the values of
1540 //! these channels, and for surface formats that may only support one of
1541 //! these modes. Also refer to the definition of SAMPLER_BORDER_COLOR_STATE
1542 //! for more details on the behavior of the two modes defined by this field.
1543 enum TEXTURE_BORDER_COLOR_MODE
1544 {
1545 TEXTURE_BORDER_COLOR_MODE_OGL = 0, //!< OGL mode for interpreting the border color
1546 TEXTURE_BORDER_COLOR_MODE_8BIT = 1, //!< 8 bit and earlier mode for interpreting the border color
1547 };
1548
1549 //! \brief CUBE_SURFACE_CONTROL_MODE
1550 //! \details
1551 //! When sampling from a SURFTYPE_CUBE surface, this field controls whether
1552 //! the TC* Address Control Mode fields are interpreted as programmed or
1553 //! overridden to TEXCOORDMODE_CUBE.
1554 enum CUBE_SURFACE_CONTROL_MODE
1555 {
1556 CUBE_SURFACE_CONTROL_MODE_PROGRAMMED = 0, //!< No additional details
1557 CUBE_SURFACE_CONTROL_MODE_OVERRIDE = 1, //!< No additional details
1558 };
1559
1560 //! \brief SHADOW_FUNCTION
1561 //! \details
1562 //! This field is used for shadow mapping support via the sample_c message
1563 //! type, and specifies the specific comparison operation to be used. The
1564 //! comparison is between the texture sample red channel (except for
1565 //! alpha-only formats which use the alpha channel), and the "ref" value
1566 //! provided in the input message.
1567 enum SHADOW_FUNCTION
1568 {
1569 SHADOW_FUNCTION_PREFILTEROPALWAYS = 0, //!< No additional details
1570 SHADOW_FUNCTION_PREFILTEROPNEVER = 1, //!< No additional details
1571 SHADOW_FUNCTION_PREFILTEROPLESS = 2, //!< No additional details
1572 SHADOW_FUNCTION_PREFILTEROPEQUAL = 3, //!< No additional details
1573 SHADOW_FUNCTION_PREFILTEROPLEQUAL = 4, //!< No additional details
1574 SHADOW_FUNCTION_PREFILTEROPGREATER = 5, //!< No additional details
1575 SHADOW_FUNCTION_PREFILTEROPNOTEQUAL = 6, //!< No additional details
1576 SHADOW_FUNCTION_PREFILTEROPGEQUAL = 7, //!< No additional details
1577 };
1578
1579 //! \brief CHROMAKEY_MODE
1580 //! \details
1581 //! This field specifies the behavior of the device in the event of a
1582 //! ChromaKey match. This field is ignored if ChromaKey is disabled.
1583 enum CHROMAKEY_MODE
1584 {
1585 CHROMAKEY_MODE_KEYFILTERKILLONANYMATCH = 0, //!< In this mode, if any contributing texel matches the chroma key, the corresponding pixel mask bit for that pixel is cleared. The result of this operation is observable only if the Killed Pixel Mask Return flag is set on the input message.
1586 CHROMAKEY_MODE_KEYFILTERREPLACEBLACK = 1, //!< In this mode, each texel that matches the chroma key is replaced with (0,0,0,0) (black with alpha=0) prior to filtering. For YCrCb surface formats, the black value is A=0, R(Cr)=0x80, G(Y)=0x10, B(Cb)=0x80. This will tend to darken/fade edges of keyed regions. Note that the pixel pipeline must be programmed to use the resulting filtered texel value to gain the intended effect, e.g., handle the case of a totally keyed-out region (filtered texel alpha==0) through use of alpha test, etc.
1587 };
1588
1589 //! \brief LOD_CLAMP_MAGNIFICATION_MODE
1590 //! \details
1591 //! This field allows the flexibility to control how LOD clamping is handled
1592 //! when in magnification mode.
1593 enum LOD_CLAMP_MAGNIFICATION_MODE
1594 {
1595 LOD_CLAMP_MAGNIFICATION_MODE_MIPNONE = 0, //!< When in magnification mode, Sampler will clamp LOD as if the Mip Mode Filteris MIPFILTER_NONE. This is how OpenGL defines magnification, and therefore it isexpected that those drivers would not set this bit.
1596 LOD_CLAMP_MAGNIFICATION_MODE_MIPFILTER = 1, //!< When in magnification mode, Sampler will clamp LOD based on the value of Mip Mode Filter.
1597 };
1598
1599 //! \brief SRGB_DECODE
1600 //! \details
1601 //! <p>This bit controls whether the 3D sampler will decode an sRGB
1602 //! formatted surface into RGB prior to any filtering operation.</p>
1603 //! <p>When set, it does not convert to linear RGB (via a reverse gamma
1604 //! conversion). This bit is ignored for ASTC formats, which are always
1605 //! converted to linear RGB prior to filtering.</p>
1606 enum SRGB_DECODE
1607 {
1608 SRGB_DECODE_DECODEEXT = 0, //!< When set to 0h, the 3D sampler will convert texels from an sRGB surface to linear RGB prior to filtering and/or returning the value.
1609 SRGB_DECODE_SKIPDECODEEXT = 1, //!< When set to 1h, the 3D sampler will not convert texels to linear RGB before filtering and returning results.
1610 };
1611
1612 //! \brief RETURN_FILTER_WEIGHT_FOR_NULL_TEXELS
1613 //! \details
1614 //! <p>This bit, when set, causes samples to return filter_weight of all
1615 //! non-NULL texels in the Alpha channel; Red, Green, and Blue channels are
1616 //! contain the filter result with NULL texels excluded; A non-NULL texel is
1617 //! a texel which does not reference a Null Tile.</p>
1618 //! <p>For cases where Tiled_Resource_Mode is TR_NONE, the result will
1619 //! always be 1.0 since no texels would be NULL.</p>
1620 //! <p>For cases where the surface format contains an Alpha channel, the
1621 //! result returned will be overridden to return the filter weight.</p>
1622 //! <p>For cases where the surface format does not contain Alpha, the result
1623 //! will still be returned in the Alpha Channel.</p>
1624 enum RETURN_FILTER_WEIGHT_FOR_NULL_TEXELS
1625 {
1626 RETURN_FILTER_WEIGHT_FOR_NULL_TEXELS_DISABLE = 0, //!< When programmed to 0h, filter weight will not be returned, and normal data will be returned on the Alpha channel.
1627 RETURN_FILTER_WEIGHT_FOR_NULL_TEXELS_ENABLE = 1, //!< When programmed to 1h, filter weight will be returned on the Alpha channel rather than the normal data expected on the Alpha channel.
1628 };
1629
1630 //! \brief RETURN_FILTER_WEIGHT_FOR_BORDER_TEXELS
1631 //! \details
1632 //! <p>This bit, when set, returns the filter_weight in the Alpha channel of
1633 //! all non-border texels. Red, Green, and Blue channels will contain the
1634 //! sample result with border texels excluded.</p>
1635 //! <p>For cases where the surface format contains an Alpha channel, the
1636 //! result returned will be ovewritten to return the filter weight.</p>
1637 //! <p>For cases where the surface format does not contain Alpha, the result
1638 //! will still be returned in the Alpha Channel.</p>
1639 enum RETURN_FILTER_WEIGHT_FOR_BORDER_TEXELS
1640 {
1641 RETURN_FILTER_WEIGHT_FOR_BORDER_TEXELS_DISABLE = 0, //!< When programmed to 0h, normal data will be returned on RGBA channels, including contribution from border color texels.
1642 RETURN_FILTER_WEIGHT_FOR_BORDER_TEXELS_ENABLE = 1, //!< When programmed to 1h, RGB channels return filter data contributed from non-border color texels, and A channel returns filter weight of contributing texels.
1643 };
1644
1645 //! \brief TCZ_ADDRESS_CONTROL_MODE
1646 //! \details
1647 //! Controls how the 3rd (TCZ) component of input texture coordinates are
1648 //! mapped to texture map addresses - specifically, how coordinates
1649 //! "outside" the texture are handled (wrap/clamp/mirror).See Address TCX
1650 //! Control Mode above for details
1651 enum TCZ_ADDRESS_CONTROL_MODE
1652 {
1653 TCZ_ADDRESS_CONTROL_MODE_WRAP = 0, //!< No additional details
1654 TCZ_ADDRESS_CONTROL_MODE_MIRROR = 1, //!< No additional details
1655 TCZ_ADDRESS_CONTROL_MODE_CLAMP = 2, //!< No additional details
1656 TCZ_ADDRESS_CONTROL_MODE_CUBE = 3, //!< No additional details
1657 TCZ_ADDRESS_CONTROL_MODE_CLAMPBORDER = 4, //!< No additional details
1658 TCZ_ADDRESS_CONTROL_MODE_MIRRORONCE = 5, //!< No additional details
1659 TCZ_ADDRESS_CONTROL_MODE_HALFBORDER = 6, //!< No additional details
1660 TCZ_ADDRESS_CONTROL_MODE_MIRROR101 = 7, //!< No additional details
1661 };
1662
1663 //! \brief TCY_ADDRESS_CONTROL_MODE
1664 //! \details
1665 //! Controls how the 2nd (TCY, aka V) component of input texture coordinates
1666 //! are mapped to texture map addresses - specifically, how coordinates
1667 //! "outside" the texture are handled (wrap/clamp/mirror). See Address TCX
1668 //! Control Mode above for details
1669 enum TCY_ADDRESS_CONTROL_MODE
1670 {
1671 TCY_ADDRESS_CONTROL_MODE_WRAP = 0, //!< No additional details
1672 TCY_ADDRESS_CONTROL_MODE_MIRROR = 1, //!< No additional details
1673 TCY_ADDRESS_CONTROL_MODE_CLAMP = 2, //!< No additional details
1674 TCY_ADDRESS_CONTROL_MODE_CUBE = 3, //!< No additional details
1675 TCY_ADDRESS_CONTROL_MODE_CLAMPBORDER = 4, //!< No additional details
1676 TCY_ADDRESS_CONTROL_MODE_MIRRORONCE = 5, //!< No additional details
1677 TCY_ADDRESS_CONTROL_MODE_HALFBORDER = 6, //!< No additional details
1678 TCY_ADDRESS_CONTROL_MODE_MIRROR101 = 7, //!< No additional details
1679 };
1680
1681 //! \brief TCX_ADDRESS_CONTROL_MODE
1682 //! \details
1683 //! Controls how the 1st (TCX, aka U) component of input texture coordinates
1684 //! are mapped to texture map addresses - specifically, how coordinates
1685 //! "outside" the texture are handled (wrap/clamp/mirror). The setting of
1686 //! this field is subject to being overridden by the Cube Surface Control
1687 //! Mode field when sampling from a SURFTYPE_CUBE surface.
1688 enum TCX_ADDRESS_CONTROL_MODE
1689 {
1690 TCX_ADDRESS_CONTROL_MODE_WRAP = 0, //!< No additional details
1691 TCX_ADDRESS_CONTROL_MODE_MIRROR = 1, //!< No additional details
1692 TCX_ADDRESS_CONTROL_MODE_CLAMP = 2, //!< No additional details
1693 TCX_ADDRESS_CONTROL_MODE_CUBE = 3, //!< No additional details
1694 TCX_ADDRESS_CONTROL_MODE_CLAMPBORDER = 4, //!< No additional details
1695 TCX_ADDRESS_CONTROL_MODE_MIRRORONCE = 5, //!< No additional details
1696 TCX_ADDRESS_CONTROL_MODE_HALFBORDER = 6, //!< No additional details
1697 TCX_ADDRESS_CONTROL_MODE_MIRROR101 = 7, //!< No additional details
1698 };
1699
1700 //! \brief TRILINEAR_FILTER_QUALITY
1701 //! \details
1702 //! Selects the quality level for the trilinear filter.
1703 enum TRILINEAR_FILTER_QUALITY
1704 {
1705 TRILINEAR_FILTER_QUALITY_FULL = 0, //!< Full Quality. Both mip maps are sampled under all circumstances.
1706 TRILINEAR_FILTER_QUALITY_TRIQUALHIGHMAGCLAMPMIPFILTER = 1, //!< If [Trilinear Filter Quality Mode Gen11] High Quality. Same as full quality. <!--StartFragment-->Same as full quality. When in magnification mode, Sampler will clamp LOD based on the value of Mip Mode Filter.<!--EndFragment-->If [Trilinear Filter Quality Mode] LOD values which are within 12.5% of an integer LOD value are rounded to that value prior to filtering and filtering effectively becomes the same as MIP Nearest.
1707 TRILINEAR_FILTER_QUALITY_MED = 2, //!< If [Trilinear Filter Quality Mode Gen11] Medium Quality. If the contribution of one mip map is less than 25%, only the other mip map contributes.If [Trilinear Filter Quality Mode] LOD values which are within 16.67% of an integer LOD value are rounded to that value prior to filtering and filtering effectively becomes the same as MIP Nearest.
1708 TRILINEAR_FILTER_QUALITY_LOW = 3, //!< If [Trilinear Filter Quality Mode Gen11] Low Quality. If the contribution of one mip map is less than 37.5%, only the other mip map contributes.If [Trilinear Filter Quality Mode] Should not be used.
1709 };
1710
1711 //! \brief MAXIMUM_ANISOTROPY
1712 //! \details
1713 //! This field clamps the maximum value of the anisotropy ratio used by the
1714 //! MAPFILTER_ANISOTROPIC filter (Min or Mag Mode Filter).
1715 enum MAXIMUM_ANISOTROPY
1716 {
1717 MAXIMUM_ANISOTROPY_RATIO21 = 0, //!< At most a 2:1 aspect ratio filter is used
1718 MAXIMUM_ANISOTROPY_RATIO41 = 1, //!< At most a 4:1 aspect ratio filter is used
1719 MAXIMUM_ANISOTROPY_RATIO61 = 2, //!< At most a 6:1 aspect ratio filter is used
1720 MAXIMUM_ANISOTROPY_RATIO81 = 3, //!< At most a 8:1 aspect ratio filter is used
1721 MAXIMUM_ANISOTROPY_RATIO101 = 4, //!< At most a 10:1 aspect ratio filter is used
1722 MAXIMUM_ANISOTROPY_RATIO121 = 5, //!< At most a 12:1 aspect ratio filter is used
1723 MAXIMUM_ANISOTROPY_RATIO141 = 6, //!< At most a 14:1 aspect ratio filter is used
1724 MAXIMUM_ANISOTROPY_RATIO161 = 7, //!< At most a 16:1 aspect ratio filter is used
1725 };
1726
1727 //! \brief REDUCTION_TYPE
1728 //! \details
1729 //! This field defines the type of reduction that will be performed on the
1730 //! texels in the footprint defined by the <b>Min/Mag/Mip Filter Mode</b>
1731 //! fields. This field is ignored if <b>Reduction Type Enable</b> is
1732 //! disabled.
1733 enum REDUCTION_TYPE
1734 {
1735 REDUCTION_TYPE_STDFILTER = 0, //!< standard filter
1736 REDUCTION_TYPE_COMPARISON = 1, //!< comparison followed by standard filter
1737 REDUCTION_TYPE_MINIMUM = 2, //!< minimum of footprint
1738 REDUCTION_TYPE_MAXIMUM = 3, //!< maximum of footprint
1739 };
1740
1741 //! \name Initializations
1742
1743 //! \brief Explicit member initialization function
1744 SAMPLER_STATE_CMD();
1745
1746 static const size_t dwSize = 4;
1747 static const size_t byteSize = 16;
1748 };
1749
1750 //!
1751 //! \brief SAMPLER_STATE_8x8_AVS_COEFFICIENTS
1752 //! \details
1753 //! ExistsIf = AVS &amp;&amp; (Function_mode = 0)
1754 //!
1755 struct SAMPLER_STATE_8x8_AVS_COEFFICIENTS_CMD
1756 {
1757 union
1758 {
1759 //!< DWORD 0
1760 struct
1761 {
1762 uint32_t Table0XFilterCoefficientN0 : __CODEGEN_BITFIELD( 0, 7) ; //!< Table 0X Filter Coefficient[n,0]
1763 uint32_t Table0YFilterCoefficientN0 : __CODEGEN_BITFIELD( 8, 15) ; //!< Table 0Y Filter Coefficient[n,0]
1764 uint32_t Table0XFilterCoefficientN1 : __CODEGEN_BITFIELD(16, 23) ; //!< Table 0X Filter Coefficient[n,1]
1765 uint32_t Table0YFilterCoefficientN1 : __CODEGEN_BITFIELD(24, 31) ; //!< Table 0Y Filter Coefficient[n,1]
1766 };
1767 uint32_t Value;
1768 } DW0;
1769 union
1770 {
1771 //!< DWORD 1
1772 struct
1773 {
1774 uint32_t Table0XFilterCoefficientN2 : __CODEGEN_BITFIELD( 0, 7) ; //!< Table 0X Filter Coefficient[n,2]
1775 uint32_t Table0YFilterCoefficientN2 : __CODEGEN_BITFIELD( 8, 15) ; //!< Table 0Y Filter Coefficient[n,2]
1776 uint32_t Table0XFilterCoefficientN3 : __CODEGEN_BITFIELD(16, 23) ; //!< Table 0X Filter Coefficient[n,3]
1777 uint32_t Table0YFilterCoefficientN3 : __CODEGEN_BITFIELD(24, 31) ; //!< Table 0Y Filter Coefficient[n,3]
1778 };
1779 uint32_t Value;
1780 } DW1;
1781 union
1782 {
1783 //!< DWORD 2
1784 struct
1785 {
1786 uint32_t Table0XFilterCoefficientN4 : __CODEGEN_BITFIELD( 0, 7) ; //!< Table 0X Filter Coefficient[n,4]
1787 uint32_t Table0YFilterCoefficientN4 : __CODEGEN_BITFIELD( 8, 15) ; //!< Table 0Y Filter Coefficient[n,4]
1788 uint32_t Table0XFilterCoefficientN5 : __CODEGEN_BITFIELD(16, 23) ; //!< Table 0X Filter Coefficient[n,5]
1789 uint32_t Table0YFilterCoefficientN5 : __CODEGEN_BITFIELD(24, 31) ; //!< Table 0Y Filter Coefficient[n,5]
1790 };
1791 uint32_t Value;
1792 } DW2;
1793 union
1794 {
1795 //!< DWORD 3
1796 struct
1797 {
1798 uint32_t Table0XFilterCoefficientN6 : __CODEGEN_BITFIELD( 0, 7) ; //!< Table 0X Filter Coefficient[n,6]
1799 uint32_t Table0YFilterCoefficientN6 : __CODEGEN_BITFIELD( 8, 15) ; //!< Table 0Y Filter Coefficient[n,6]
1800 uint32_t Table0XFilterCoefficientN7 : __CODEGEN_BITFIELD(16, 23) ; //!< Table 0X Filter Coefficient[n,7]
1801 uint32_t Table0YFilterCoefficientN7 : __CODEGEN_BITFIELD(24, 31) ; //!< Table 0Y Filter Coefficient[n,7]
1802 };
1803 uint32_t Value;
1804 } DW3;
1805 union
1806 {
1807 //!< DWORD 4
1808 struct
1809 {
1810 uint32_t Reserved128 : __CODEGEN_BITFIELD( 0, 15) ; //!< Reserved
1811 uint32_t Table1XFilterCoefficientN2 : __CODEGEN_BITFIELD(16, 23) ; //!< Table 1X Filter Coefficient[n,2]
1812 uint32_t Table1XFilterCoefficientN3 : __CODEGEN_BITFIELD(24, 31) ; //!< Table 1X Filter Coefficient[n,3]
1813 };
1814 uint32_t Value;
1815 } DW4;
1816 union
1817 {
1818 //!< DWORD 5
1819 struct
1820 {
1821 uint32_t Table1XFilterCoefficientN4 : __CODEGEN_BITFIELD( 0, 7) ; //!< Table 1X Filter Coefficient[n,4]
1822 uint32_t Table1XFilterCoefficientN5 : __CODEGEN_BITFIELD( 8, 15) ; //!< Table 1X Filter Coefficient[n,5]
1823 uint32_t Reserved176 : __CODEGEN_BITFIELD(16, 31) ; //!< Reserved
1824 };
1825 uint32_t Value;
1826 } DW5;
1827 union
1828 {
1829 //!< DWORD 6
1830 struct
1831 {
1832 uint32_t Reserved192 : __CODEGEN_BITFIELD( 0, 15) ; //!< Reserved
1833 uint32_t Table1YFilterCoefficientN2 : __CODEGEN_BITFIELD(16, 23) ; //!< Table 1Y Filter Coefficient[n,2]
1834 uint32_t Table1YFilterCoefficientN3 : __CODEGEN_BITFIELD(24, 31) ; //!< Table 1Y Filter Coefficient[n,3]
1835 };
1836 uint32_t Value;
1837 } DW6;
1838 union
1839 {
1840 //!< DWORD 7
1841 struct
1842 {
1843 uint32_t Table1YFilterCoefficientN4 : __CODEGEN_BITFIELD( 0, 7) ; //!< Table 1Y Filter Coefficient[n,4]
1844 uint32_t Table1YFilterCoefficientN5 : __CODEGEN_BITFIELD( 8, 15) ; //!< Table 1Y Filter Coefficient[n,5]
1845 uint32_t Reserved240 : __CODEGEN_BITFIELD(16, 31) ; //!< Reserved
1846 };
1847 uint32_t Value;
1848 } DW7;
1849
1850 //! \name Local enumerations
1851
1852 //! \name Initializations
1853
1854 //! \brief Explicit member initialization function
1855 SAMPLER_STATE_8x8_AVS_COEFFICIENTS_CMD();
1856
1857 static const size_t dwSize = 8;
1858 static const size_t byteSize = 32;
1859 };
1860
1861 //!
1862 //! \brief SAMPLER_STATE_8x8_AVS
1863 //! \details
1864 //! ExistsIf = AVS &amp;&amp; (Function_mode = 0)
1865 //!
1866 struct SAMPLER_STATE_8x8_AVS_CMD
1867 {
1868 union
1869 {
1870 //!< DWORD 0
1871 struct
1872 {
1873 uint32_t GainFactor : __CODEGEN_BITFIELD( 0, 5) ; //!< GAIN_FACTOR
1874 uint32_t WeakEdgeThreshold : __CODEGEN_BITFIELD( 6, 11) ; //!< WEAK_EDGE_THRESHOLD
1875 uint32_t StrongEdgeThreshold : __CODEGEN_BITFIELD(12, 17) ; //!< STRONG_EDGE_THRESHOLD
1876 uint32_t R3XCoefficient : __CODEGEN_BITFIELD(18, 22) ; //!< R3X_COEFFICIENT
1877 uint32_t R3CCoefficient : __CODEGEN_BITFIELD(23, 27) ; //!< R3C_COEFFICIENT
1878 uint32_t Reserved28 : __CODEGEN_BITFIELD(28, 31) ; //!< Reserved
1879 };
1880 uint32_t Value;
1881 } DW0;
1882 union
1883 {
1884 //!< DWORD 1
1885 struct
1886 {
1887 uint32_t Reserved32 ; //!< Reserved
1888 };
1889 uint32_t Value;
1890 } DW1;
1891 union
1892 {
1893 //!< DWORD 2
1894 struct
1895 {
1896 uint32_t GlobalNoiseEstimation : __CODEGEN_BITFIELD( 0, 7) ; //!< GLOBAL_NOISE_ESTIMATION
1897 uint32_t NonEdgeWeight : __CODEGEN_BITFIELD( 8, 10) ; //!< NON_EDGE_WEIGHT
1898 uint32_t RegularWeight : __CODEGEN_BITFIELD(11, 13) ; //!< REGULAR_WEIGHT
1899 uint32_t StrongEdgeWeight : __CODEGEN_BITFIELD(14, 16) ; //!< STRONG_EDGE_WEIGHT
1900 uint32_t R5XCoefficient : __CODEGEN_BITFIELD(17, 21) ; //!< R5X_COEFFICIENT
1901 uint32_t R5CxCoefficient : __CODEGEN_BITFIELD(22, 26) ; //!< R5CX_COEFFICIENT
1902 uint32_t R5CCoefficient : __CODEGEN_BITFIELD(27, 31) ; //!< R5C_COEFFICIENT
1903 };
1904 uint32_t Value;
1905 } DW2;
1906 union
1907 {
1908 //!< DWORD 3
1909 struct
1910 {
1911 uint32_t SinAlpha : __CODEGEN_BITFIELD( 0, 7) ; //!< Sin(alpha)
1912 uint32_t CosAlpha : __CODEGEN_BITFIELD( 8, 15) ; //!< Cos(alpha)
1913 uint32_t SatMax : __CODEGEN_BITFIELD(16, 21) ; //!< SAT_MAX
1914 uint32_t HueMax : __CODEGEN_BITFIELD(22, 27) ; //!< HUE_MAX
1915 uint32_t Enable8TapFilter : __CODEGEN_BITFIELD(28, 29) ; //!< ENABLE_8_TAP_FILTER
1916 uint32_t Ief4SmoothEnable : __CODEGEN_BITFIELD(30, 30) ; //!< IEF4SMOOTH_ENABLE_
1917 uint32_t SkinToneTunedIefEnable : __CODEGEN_BITFIELD(31, 31) ; //!< SKIN_TONE_TUNED_IEF__ENABLE
1918 };
1919 uint32_t Value;
1920 } DW3;
1921 union
1922 {
1923 //!< DWORD 4
1924 struct
1925 {
1926 uint32_t S3U : __CODEGEN_BITFIELD( 0, 10) ; //!< S3U
1927 uint32_t ShuffleOutputwritebackForSample8X8 : __CODEGEN_BITFIELD(11, 11) ; //!< SHUFFLE_OUTPUTWRITEBACK_FOR_SAMPLE_8X8
1928 uint32_t DiamondMargin : __CODEGEN_BITFIELD(12, 14) ; //!< DIAMOND_MARGIN
1929 uint32_t VyStdEnable : __CODEGEN_BITFIELD(15, 15) ; //!< VY_STD_Enable
1930 uint32_t UMid : __CODEGEN_BITFIELD(16, 23) ; //!< U_MID
1931 uint32_t VMid : __CODEGEN_BITFIELD(24, 31) ; //!< V_MID
1932 };
1933 uint32_t Value;
1934 } DW4;
1935 union
1936 {
1937 //!< DWORD 5
1938 struct
1939 {
1940 uint32_t DiamondDv : __CODEGEN_BITFIELD( 0, 6) ; //!< DIAMOND_DV
1941 uint32_t DiamondTh : __CODEGEN_BITFIELD( 7, 12) ; //!< DIAMOND_TH
1942 uint32_t DiamondAlpha : __CODEGEN_BITFIELD(13, 20) ; //!< Diamond_alpha
1943 uint32_t HsMargin : __CODEGEN_BITFIELD(21, 23) ; //!< HS_MARGIN
1944 uint32_t DiamondDu : __CODEGEN_BITFIELD(24, 30) ; //!< DIAMOND_DU
1945 uint32_t Skindetailfactor : __CODEGEN_BITFIELD(31, 31) ; //!< SKINDETAILFACTOR_
1946 };
1947 uint32_t Value;
1948 } DW5;
1949 union
1950 {
1951 //!< DWORD 6
1952 struct
1953 {
1954 uint32_t YPoint1 : __CODEGEN_BITFIELD( 0, 7) ; //!< Y_POINT_1
1955 uint32_t YPoint2 : __CODEGEN_BITFIELD( 8, 15) ; //!< Y_POINT_2
1956 uint32_t YPoint3 : __CODEGEN_BITFIELD(16, 23) ; //!< Y_POINT_3
1957 uint32_t YPoint4 : __CODEGEN_BITFIELD(24, 31) ; //!< Y_POINT_4
1958 };
1959 uint32_t Value;
1960 } DW6;
1961 union
1962 {
1963 //!< DWORD 7
1964 struct
1965 {
1966 uint32_t InvMarginVyl : __CODEGEN_BITFIELD( 0, 15) ; //!< INV_Margin_VYL
1967 uint32_t Reserved240 : __CODEGEN_BITFIELD(16, 31) ; //!< Reserved
1968 };
1969 uint32_t Value;
1970 } DW7;
1971 union
1972 {
1973 //!< DWORD 8
1974 struct
1975 {
1976 uint32_t InvMarginVyu : __CODEGEN_BITFIELD( 0, 15) ; //!< INV_Margin_VYU
1977 uint32_t P0L : __CODEGEN_BITFIELD(16, 23) ; //!< P0L
1978 uint32_t P1L : __CODEGEN_BITFIELD(24, 31) ; //!< P1L
1979 };
1980 uint32_t Value;
1981 } DW8;
1982 union
1983 {
1984 //!< DWORD 9
1985 struct
1986 {
1987 uint32_t P2L : __CODEGEN_BITFIELD( 0, 7) ; //!< P2L
1988 uint32_t P3L : __CODEGEN_BITFIELD( 8, 15) ; //!< P3L
1989 uint32_t B0L : __CODEGEN_BITFIELD(16, 23) ; //!< B0L
1990 uint32_t B1L : __CODEGEN_BITFIELD(24, 31) ; //!< B1L
1991 };
1992 uint32_t Value;
1993 } DW9;
1994 union
1995 {
1996 //!< DWORD 10
1997 struct
1998 {
1999 uint32_t B2L : __CODEGEN_BITFIELD( 0, 7) ; //!< B2L
2000 uint32_t B3L : __CODEGEN_BITFIELD( 8, 15) ; //!< B3L
2001 uint32_t S0L : __CODEGEN_BITFIELD(16, 26) ; //!< S0L
2002 uint32_t YSlope2 : __CODEGEN_BITFIELD(27, 31) ; //!< Y_Slope_2
2003 };
2004 uint32_t Value;
2005 } DW10;
2006 union
2007 {
2008 //!< DWORD 11
2009 struct
2010 {
2011 uint32_t S1L : __CODEGEN_BITFIELD( 0, 10) ; //!< S1L
2012 uint32_t S2L : __CODEGEN_BITFIELD(11, 21) ; //!< S2L
2013 uint32_t Reserved374 : __CODEGEN_BITFIELD(22, 31) ; //!< Reserved
2014 };
2015 uint32_t Value;
2016 } DW11;
2017 union
2018 {
2019 //!< DWORD 12
2020 struct
2021 {
2022 uint32_t S3L : __CODEGEN_BITFIELD( 0, 10) ; //!< S3L
2023 uint32_t P0U : __CODEGEN_BITFIELD(11, 18) ; //!< P0U
2024 uint32_t P1U : __CODEGEN_BITFIELD(19, 26) ; //!< P1U
2025 uint32_t YSlope1 : __CODEGEN_BITFIELD(27, 31) ; //!< Y_Slope1
2026 };
2027 uint32_t Value;
2028 } DW12;
2029 union
2030 {
2031 //!< DWORD 13
2032 struct
2033 {
2034 uint32_t P2U : __CODEGEN_BITFIELD( 0, 7) ; //!< P2U
2035 uint32_t P3U : __CODEGEN_BITFIELD( 8, 15) ; //!< P3U
2036 uint32_t B0U : __CODEGEN_BITFIELD(16, 23) ; //!< B0U
2037 uint32_t B1U : __CODEGEN_BITFIELD(24, 31) ; //!< B1U
2038 };
2039 uint32_t Value;
2040 } DW13;
2041 union
2042 {
2043 //!< DWORD 14
2044 struct
2045 {
2046 uint32_t B2U : __CODEGEN_BITFIELD( 0, 7) ; //!< B2U
2047 uint32_t B3U : __CODEGEN_BITFIELD( 8, 15) ; //!< B3U
2048 uint32_t S0U : __CODEGEN_BITFIELD(16, 26) ; //!< S0U
2049 uint32_t Reserved475 : __CODEGEN_BITFIELD(27, 31) ; //!< Reserved
2050 };
2051 uint32_t Value;
2052 } DW14;
2053 union
2054 {
2055 //!< DWORD 15
2056 struct
2057 {
2058 uint32_t S1U : __CODEGEN_BITFIELD( 0, 10) ; //!< S1U
2059 uint32_t S2U : __CODEGEN_BITFIELD(11, 21) ; //!< S2U
2060 uint32_t Reserved502 : __CODEGEN_BITFIELD(22, 31) ; //!< Reserved
2061 };
2062 uint32_t Value;
2063 } DW15;
2064
2065 mhw_state_heap_g11_X::SAMPLER_STATE_8x8_AVS_COEFFICIENTS_CMD FilterCoefficient016[17]; //!< Filter Coefficient[0..16]
2066
2067 union
2068 {
2069 //!< DWORD 152
2070 struct
2071 {
2072 uint32_t TransitionAreaWith8Pixels : __CODEGEN_BITFIELD( 0, 2) ; //!< Transition Area with 8 Pixels
2073 uint32_t Reserved4867 : __CODEGEN_BITFIELD( 3, 3) ; //!< Reserved
2074 uint32_t TransitionAreaWith4Pixels : __CODEGEN_BITFIELD( 4, 6) ; //!< Transition Area with 4 Pixels
2075 uint32_t Reserved4871 : __CODEGEN_BITFIELD( 7, 7) ; //!< Reserved
2076 uint32_t MaxDerivative8Pixels : __CODEGEN_BITFIELD( 8, 15) ; //!< Max Derivative 8 Pixels
2077 uint32_t MaxDerivative4Pixels : __CODEGEN_BITFIELD(16, 23) ; //!< Max Derivative 4 Pixels
2078 uint32_t DefaultSharpnessLevel : __CODEGEN_BITFIELD(24, 31) ; //!< DEFAULT_SHARPNESS_LEVEL
2079 };
2080 uint32_t Value;
2081 } DW152;
2082 union
2083 {
2084 //!< DWORD 153
2085 struct
2086 {
2087 uint32_t RgbAdaptive : __CODEGEN_BITFIELD( 0, 0) ; //!< RGB_ADAPTIVE
2088 uint32_t AdaptiveFilterForAllChannels : __CODEGEN_BITFIELD( 1, 1) ; //!< ADAPTIVE_FILTER_FOR_ALL_CHANNELS
2089 uint32_t Reserved4898 : __CODEGEN_BITFIELD( 2, 20) ; //!< Reserved
2090 uint32_t BypassYAdaptiveFiltering : __CODEGEN_BITFIELD(21, 21) ; //!< BYPASS_Y_ADAPTIVE_FILTERING
2091 uint32_t BypassXAdaptiveFiltering : __CODEGEN_BITFIELD(22, 22) ; //!< BYPASS_X_ADAPTIVE_FILTERING
2092 uint32_t Reserved4919 : __CODEGEN_BITFIELD(23, 31) ; //!< Reserved
2093 };
2094 uint32_t Value;
2095 } DW153;
2096
2097 uint32_t Reserved4928[6]; //!< Reserved
2098
2099
2100 mhw_state_heap_g11_X::SAMPLER_STATE_8x8_AVS_COEFFICIENTS_CMD FilterCoefficient1731[15]; //!< Filter Coefficient[17..31]
2101
2102
2103 //! \name Local enumerations
2104
2105 //! \brief GAIN_FACTOR
2106 //! \details
2107 //! User control sharpening strength
2108 enum GAIN_FACTOR
2109 {
2110 GAIN_FACTOR_UNNAMED44 = 44, //!< No additional details
2111 };
2112
2113 //! \brief WEAK_EDGE_THRESHOLD
2114 //! \details
2115 //! If <b>Strong Edge Threshold</b> &gt; EM &gt; <b>Weak Edge Threshold</b>,
2116 //! the basic VSA detects a weak edge.
2117 enum WEAK_EDGE_THRESHOLD
2118 {
2119 WEAK_EDGE_THRESHOLD_UNNAMED1 = 1, //!< No additional details
2120 };
2121
2122 //! \brief STRONG_EDGE_THRESHOLD
2123 //! \details
2124 //! If EM &gt; <b>Strong Edge Threshold</b>, the basic VSA detects a strong
2125 //! edge.
2126 enum STRONG_EDGE_THRESHOLD
2127 {
2128 STRONG_EDGE_THRESHOLD_UNNAMED8 = 8, //!< No additional details
2129 };
2130
2131 //! \brief R3X_COEFFICIENT
2132 //! \details
2133 //! IEF smoothing coefficient, see IEF map.
2134 enum R3X_COEFFICIENT
2135 {
2136 R3X_COEFFICIENT_UNNAMED5 = 5, //!< No additional details
2137 };
2138
2139 //! \brief R3C_COEFFICIENT
2140 //! \details
2141 //! IEF smoothing coefficient, see IEF map.
2142 enum R3C_COEFFICIENT
2143 {
2144 R3C_COEFFICIENT_UNNAMED5 = 5, //!< No additional details
2145 };
2146
2147 //! \brief GLOBAL_NOISE_ESTIMATION
2148 //! \details
2149 //! Global noise estimation of previous frame.
2150 enum GLOBAL_NOISE_ESTIMATION
2151 {
2152 GLOBAL_NOISE_ESTIMATION_UNNAMED255 = 255, //!< No additional details
2153 };
2154
2155 //! \brief NON_EDGE_WEIGHT
2156 //! \details
2157 //! Sharpening strength when no edge is found in basic VSA.
2158 enum NON_EDGE_WEIGHT
2159 {
2160 NON_EDGE_WEIGHT_UNNAMED1 = 1, //!< No additional details
2161 };
2162
2163 //! \brief REGULAR_WEIGHT
2164 //! \details
2165 //! Sharpening strength when a weak edge is found in basic VSA.
2166 enum REGULAR_WEIGHT
2167 {
2168 REGULAR_WEIGHT_UNNAMED2 = 2, //!< No additional details
2169 };
2170
2171 //! \brief STRONG_EDGE_WEIGHT
2172 //! \details
2173 //! Sharpening strength when a strong edge is found in basic VSA.
2174 enum STRONG_EDGE_WEIGHT
2175 {
2176 STRONG_EDGE_WEIGHT_UNNAMED7 = 7, //!< No additional details
2177 };
2178
2179 //! \brief R5X_COEFFICIENT
2180 //! \details
2181 //! IEF smoothing coefficient, see IEF map.
2182 enum R5X_COEFFICIENT
2183 {
2184 R5X_COEFFICIENT_UNNAMED7 = 7, //!< No additional details
2185 };
2186
2187 //! \brief R5CX_COEFFICIENT
2188 //! \details
2189 //! IEF smoothing coefficient, see IEF map.
2190 enum R5CX_COEFFICIENT
2191 {
2192 R5CX_COEFFICIENT_UNNAMED7 = 7, //!< No additional details
2193 };
2194
2195 //! \brief R5C_COEFFICIENT
2196 //! \details
2197 //! IEF smoothing coefficient, see IEF map.
2198 enum R5C_COEFFICIENT
2199 {
2200 R5C_COEFFICIENT_UNNAMED7 = 7, //!< No additional details
2201 };
2202
2203 //! \brief SAT_MAX
2204 //! \details
2205 //! Rectangle half length
2206 enum SAT_MAX
2207 {
2208 SAT_MAX_UNNAMED31 = 31, //!< No additional details
2209 };
2210
2211 //! \brief HUE_MAX
2212 //! \details
2213 //! Rectangle half width.
2214 enum HUE_MAX
2215 {
2216 HUE_MAX_UNNAMED14 = 14, //!< No additional details
2217 };
2218
2219 //! \brief ENABLE_8_TAP_FILTER
2220 //! \details
2221 //! <i><b>Adaptive Filtering (Mode = 11) ExistsIf:</b></i>
2222 //! <p></p> R10G10B10A2_UNORM R8G8B8A8_UNORM (AYUV also) R8B8G8A8_UNORM
2223 //! B8G8R8A8_UNORM R16G16B16A16
2224 enum ENABLE_8_TAP_FILTER
2225 {
2226 ENABLE_8_TAP_FILTER_UNNAMED0 = 0, //!< 4-tap filter is only done on all channels.
2227 ENABLE_8_TAP_FILTER_UNNAMED1 = 1, //!< Enable 8-tap Adaptive filter on G-channel. 4-tap filter on other channels.
2228 ENABLE_8_TAP_FILTER_UNNAMED2 = 2, //!< 8-tap filter is done on all channels (UV-ch uses the Y-coefficients)
2229 ENABLE_8_TAP_FILTER_UNNAMED3 = 3, //!< Enable 8-tap Adaptive filter all channels (UV-ch uses the Y-coefficients).
2230 };
2231
2232 enum IEF4SMOOTH_ENABLE_
2233 {
2234 IEF4SMOOTH_ENABLE_UNNAMED0 = 0, //!< IEF is operating as a content adaptive detail filter based on 5x5 region
2235 IEF4SMOOTH_ENABLE_UNNAMED1 = 1, //!< IEF is operating as a content adaptive smooth filter based on 3x3 region
2236 };
2237
2238 //! \brief SKIN_TONE_TUNED_IEF__ENABLE
2239 //! \details
2240 //! Control bit to enable the skin tone tuned IEF.
2241 enum SKIN_TONE_TUNED_IEF__ENABLE
2242 {
2243 SKIN_TONE_TUNED_IEF_ENABLE_UNNAMED1 = 1, //!< No additional details
2244 };
2245
2246 enum SHUFFLE_OUTPUTWRITEBACK_FOR_SAMPLE_8X8
2247 {
2248 SHUFFLE_OUTPUTWRITEBACK_FOR_SAMPLE_8X8_UNNAMED0 = 0, //!< Writeback same as Original Sample_8x8
2249 SHUFFLE_OUTPUTWRITEBACK_FOR_SAMPLE_8X8_UNNAMED1 = 1, //!< Writeback of Sample_8x8 Is Modified to Suite Sample_Unorm
2250 };
2251
2252 enum DIAMOND_MARGIN
2253 {
2254 DIAMOND_MARGIN_UNNAMED4 = 4, //!< No additional details
2255 };
2256
2257 //! \brief U_MID
2258 //! \details
2259 //! Rectangle middle-point U coordinate.
2260 enum U_MID
2261 {
2262 U_MID_UNNAMED110 = 110, //!< No additional details
2263 };
2264
2265 //! \brief V_MID
2266 //! \details
2267 //! Rectangle middle-point V coordinate.
2268 enum V_MID
2269 {
2270 V_MID_UNNAMED154 = 154, //!< No additional details
2271 };
2272
2273 //! \brief DIAMOND_DV
2274 //! \details
2275 //! Rhombus center shift in the hue-direction, relative to the rectangle
2276 //! center.
2277 enum DIAMOND_DV
2278 {
2279 DIAMOND_DV_UNNAMED0 = 0, //!< No additional details
2280 };
2281
2282 //! \brief DIAMOND_TH
2283 //! \details
2284 //! Half length of the rhombus axis in the sat-direction.
2285 enum DIAMOND_TH
2286 {
2287 DIAMOND_TH_UNNAMED35 = 35, //!< No additional details
2288 };
2289
2290 //! \brief HS_MARGIN
2291 //! \details
2292 //! Defines rectangle margin
2293 enum HS_MARGIN
2294 {
2295 HS_MARGIN_UNNAMED3 = 3, //!< No additional details
2296 };
2297
2298 //! \brief DIAMOND_DU
2299 //! \details
2300 //! Rhombus center shift in the sat-direction, relative to the rectangle
2301 //! center.
2302 enum DIAMOND_DU
2303 {
2304 DIAMOND_DU_UNNAMED2 = 2, //!< No additional details
2305 };
2306
2307 //! \brief SKINDETAILFACTOR_
2308 //! \details
2309 //! This flag bit is in operation only when the control bit <b>Skin Tone
2310 //! TunedIEF_Enable</b> is on.
2311 enum SKINDETAILFACTOR_
2312 {
2313 SKINDETAILFACTOR_UNNAMED0 = 0, //!< sign(SkinDetailFactor) is equal to -1, and the content of the detected skin tone area is detail revealed.
2314 SKINDETAILFACTOR_UNNAMED1 = 1, //!< sign(SkinDetailFactor) is equal to +1, and the content of the detected skin tone area is not detail revealed.
2315 };
2316
2317 //! \brief Y_POINT_1
2318 //! \details
2319 //! First point of the Y piecewise linear membership function.
2320 enum Y_POINT_1
2321 {
2322 Y_POINT_1_UNNAMED46 = 46, //!< No additional details
2323 };
2324
2325 //! \brief Y_POINT_2
2326 //! \details
2327 //! Second point of the Y piecewise linear membership function.
2328 enum Y_POINT_2
2329 {
2330 Y_POINT_2_UNNAMED47 = 47, //!< No additional details
2331 };
2332
2333 //! \brief Y_POINT_3
2334 //! \details
2335 //! Third point of the Y piecewise linear membership function.
2336 enum Y_POINT_3
2337 {
2338 Y_POINT_3_UNNAMED254 = 254, //!< No additional details
2339 };
2340
2341 //! \brief Y_POINT_4
2342 //! \details
2343 //! Fourth point of the Y piecewise linear membership function.
2344 enum Y_POINT_4
2345 {
2346 Y_POINT_4_UNNAMED255 = 255, //!< No additional details
2347 };
2348
2349 //! \brief P0L
2350 //! \details
2351 //! Y Point 0 of the lower part of the detection PWLF.
2352 enum P0L
2353 {
2354 P0L_UNNAMED46 = 46, //!< No additional details
2355 };
2356
2357 //! \brief P1L
2358 //! \details
2359 //! Y Point 1 of the lower part of the detection PWLF.
2360 enum P1L
2361 {
2362 P1L_UNNAMED216 = 216, //!< No additional details
2363 };
2364
2365 //! \brief P2L
2366 //! \details
2367 //! Y Point 2 of the lower part of the detection PWLF.
2368 enum P2L
2369 {
2370 P2L_UNNAMED236 = 236, //!< No additional details
2371 };
2372
2373 //! \brief P3L
2374 //! \details
2375 //! Y Point 3 of the lower part of the detection PWLF.
2376 enum P3L
2377 {
2378 P3L_UNNAMED236 = 236, //!< No additional details
2379 };
2380
2381 //! \brief B0L
2382 //! \details
2383 //! V Bias 0 of the lower part of the detection PWLF.
2384 enum B0L
2385 {
2386 B0L_UNNAMED133 = 133, //!< No additional details
2387 };
2388
2389 //! \brief B1L
2390 //! \details
2391 //! V Bias 1 of the lower part of the detection PWLF.
2392 enum B1L
2393 {
2394 B1L_UNNAMED130 = 130, //!< No additional details
2395 };
2396
2397 enum B2L
2398 {
2399 B2L_UNNAMED130 = 130, //!< No additional details
2400 };
2401
2402 //! \brief B3L
2403 //! \details
2404 //! V Bias 3 of the lower part of the detection PWLF.
2405 enum B3L
2406 {
2407 B3L_UNNAMED130 = 130, //!< No additional details
2408 };
2409
2410 //! \brief P0U
2411 //! \details
2412 //! Y Point 0 of the upper part of the detection PWLF.
2413 enum P0U
2414 {
2415 P0U_UNNAMED46 = 46, //!< No additional details
2416 };
2417
2418 //! \brief P1U
2419 //! \details
2420 //! Y Point 1 of the upper part of the detection PWLF.
2421 enum P1U
2422 {
2423 P1U_UNNAMED66 = 66, //!< No additional details
2424 };
2425
2426 //! \brief P2U
2427 //! \details
2428 //! Y Point 2 of the upper part of the detection PWLF.
2429 enum P2U
2430 {
2431 P2U_UNNAMED150 = 150, //!< No additional details
2432 };
2433
2434 //! \brief P3U
2435 //! \details
2436 //! Y Point 3 of the upper part of the detection PWLF.
2437 enum P3U
2438 {
2439 P3U_UNNAMED236 = 236, //!< No additional details
2440 };
2441
2442 //! \brief B0U
2443 //! \details
2444 //! V Bias 0 of the upper part of the detection PWLF.
2445 enum B0U
2446 {
2447 B0U_UNNAMED143 = 143, //!< No additional details
2448 };
2449
2450 //! \brief B1U
2451 //! \details
2452 //! V Bias 1 of the upper part of the detection PWLF.
2453 enum B1U
2454 {
2455 B1U_UNNAMED163 = 163, //!< No additional details
2456 };
2457
2458 //! \brief B2U
2459 //! \details
2460 //! V Bias 2 of the upper part of the detection PWLF.
2461 enum B2U
2462 {
2463 B2U_UNNAMED200 = 200, //!< No additional details
2464 };
2465
2466 //! \brief B3U
2467 //! \details
2468 //! V Bias 3 of the upper part of the detection PWLF.
2469 enum B3U
2470 {
2471 B3U_UNNAMED140 = 140, //!< No additional details
2472 };
2473
2474 //! \brief DEFAULT_SHARPNESS_LEVEL
2475 //! \details
2476 //! When adaptive scaling is off, determines the balance between sharp and
2477 //! smooth scalers.
2478 enum DEFAULT_SHARPNESS_LEVEL
2479 {
2480 DEFAULT_SHARPNESS_LEVEL_UNNAMED0 = 0, //!< Contribute 1 from the smooth scalar
2481 DEFAULT_SHARPNESS_LEVEL_UNNAMED255 = 255, //!< Contribute 1 from the sharp scalar
2482 };
2483
2484 //! \brief RGB_ADAPTIVE
2485 //! \details
2486 //! This should be always set to 0 for YUV input and can be enabled/disabled
2487 //! for RGB input.
2488 //! This should be enabled only if we enable 8-tap adaptive filter for
2489 //! RGB input.
2490 enum RGB_ADAPTIVE
2491 {
2492 RGB_ADAPTIVE_DISBLE = 0, //!< Disable the RGB Adaptive equation and use G-Ch directly for adaptive filter
2493 RGB_ADAPTIVE_ENABLE = 1, //!< Enable the RGB Adaptive filter using the equation (Y=(R+2G+B)>>2)
2494 };
2495
2496 //! \brief ADAPTIVE_FILTER_FOR_ALL_CHANNELS
2497 //! \details
2498 //! Only to be enabled if 8-tap Adaptive filter mode is on, eElse it should
2499 //! be disabled.
2500 enum ADAPTIVE_FILTER_FOR_ALL_CHANNELS
2501 {
2502 ADAPTIVE_FILTER_FOR_ALL_CHANNELS_DISBLE = 0, //!< Disable Adaptive Filter on UV/RB Channels
2503 ADAPTIVE_FILTER_FOR_ALL_CHANNELS_ENABLE = 1, //!< Enable Adaptive Filter on UV/RB Channels
2504 };
2505
2506 //! \brief BYPASS_Y_ADAPTIVE_FILTERING
2507 //! \details
2508 //! When disabled, the Y direction will use <b>Default Sharpness Level</b>
2509 //! to blend between the smooth and sharp filters rather than the calculated
2510 //! value.
2511 enum BYPASS_Y_ADAPTIVE_FILTERING
2512 {
2513 BYPASS_Y_ADAPTIVE_FILTERING_ENABLE = 0, //!< Enable Y Adaptive Filtering
2514 BYPASS_Y_ADAPTIVE_FILTERING_DISBLE = 1, //!< Disable Y Adaptive Filtering
2515 };
2516
2517 //! \brief BYPASS_X_ADAPTIVE_FILTERING
2518 //! \details
2519 //! When disabled, the X direction will use <b>Default Sharpness Level</b>
2520 //! to blend between the smooth and sharp filters rather than the calculated
2521 //! value.
2522 enum BYPASS_X_ADAPTIVE_FILTERING
2523 {
2524 BYPASS_X_ADAPTIVE_FILTERING_ENABLE = 0, //!< Enable X Adaptive Filtering
2525 BYPASS_X_ADAPTIVE_FILTERING_DISBLE = 1, //!< Disable X Adaptive Filtering
2526 };
2527
2528 //! \name Initializations
2529
2530 //! \brief Explicit member initialization function
2531 SAMPLER_STATE_8x8_AVS_CMD();
2532
2533 static const size_t dwSize = 280;
2534 static const size_t byteSize = 1120;
2535 };
2536
2537 //!
2538 //! \brief SAMPLER_STATE_8x8_CONVOLVE_COEFFICIENTS
2539 //! \details
2540 //! Function: 0001b ExistsIf: [Convolve] &amp;&amp; [SKL_mode==0] &amp;&amp;
2541 //! [(Kernel Size) =< (15x15)]
2542 //!
2543 //! Function: 1010b ExistsIf: "[1Pixel Convolution ] &amp;&amp; [(Kernel
2544 //! Size) =< (15x15)]
2545 //!
2546 //! Function: 0001b ExistsIf: [Convolve] &amp;&amp; [SKL_mode==1] &amp;&amp;
2547 //! [(Kernel Size) > (15x15)]
2548 //!
2549 struct SAMPLER_STATE_8x8_CONVOLVE_COEFFICIENTS_CMD
2550 {
2551 union
2552 {
2553 //!< DWORD 0
2554 struct
2555 {
2556 uint32_t FilterCoefficient00 : __CODEGEN_BITFIELD( 0, 15) ; //!< Filter Coefficient[0,0]
2557 uint32_t FilterCoefficient01 : __CODEGEN_BITFIELD(16, 31) ; //!< Filter Coefficient[0,1]
2558 };
2559 uint32_t Value;
2560 } DW0;
2561 union
2562 {
2563 //!< DWORD 1
2564 struct
2565 {
2566 uint32_t FilterCoefficient02 : __CODEGEN_BITFIELD( 0, 15) ; //!< Filter Coefficient[0,2]
2567 uint32_t FilterCoefficient03 : __CODEGEN_BITFIELD(16, 31) ; //!< Filter Coefficient[0,3]
2568 };
2569 uint32_t Value;
2570 } DW1;
2571 union
2572 {
2573 //!< DWORD 2
2574 struct
2575 {
2576 uint32_t FilterCoefficient04 : __CODEGEN_BITFIELD( 0, 15) ; //!< Filter Coefficient[0,4]
2577 uint32_t FilterCoefficient05 : __CODEGEN_BITFIELD(16, 31) ; //!< Filter Coefficient[0,5]
2578 };
2579 uint32_t Value;
2580 } DW2;
2581 union
2582 {
2583 //!< DWORD 3
2584 struct
2585 {
2586 uint32_t FilterCoefficient06 : __CODEGEN_BITFIELD( 0, 15) ; //!< Filter Coefficient[0,6]
2587 uint32_t FilterCoefficient07 : __CODEGEN_BITFIELD(16, 31) ; //!< Filter Coefficient[0,7]
2588 };
2589 uint32_t Value;
2590 } DW3;
2591 union
2592 {
2593 //!< DWORD 4
2594 struct
2595 {
2596 uint32_t FilterCoefficient08 : __CODEGEN_BITFIELD( 0, 15) ; //!< Filter Coefficient[0,8]
2597 uint32_t FilterCoefficient09 : __CODEGEN_BITFIELD(16, 31) ; //!< Filter Coefficient[0,9]
2598 };
2599 uint32_t Value;
2600 } DW4;
2601 union
2602 {
2603 //!< DWORD 5
2604 struct
2605 {
2606 uint32_t FilterCoefficient010 : __CODEGEN_BITFIELD( 0, 15) ; //!< Filter Coefficient[0,10]
2607 uint32_t FilterCoefficient011 : __CODEGEN_BITFIELD(16, 31) ; //!< Filter Coefficient[0,11]
2608 };
2609 uint32_t Value;
2610 } DW5;
2611 union
2612 {
2613 //!< DWORD 6
2614 struct
2615 {
2616 uint32_t FilterCoefficient012 : __CODEGEN_BITFIELD( 0, 15) ; //!< Filter Coefficient[0,12]
2617 uint32_t FilterCoefficient013 : __CODEGEN_BITFIELD(16, 31) ; //!< Filter Coefficient[0,13]
2618 };
2619 uint32_t Value;
2620 } DW6;
2621 union
2622 {
2623 //!< DWORD 7
2624 struct
2625 {
2626 uint32_t FilterCoefficient014 : __CODEGEN_BITFIELD( 0, 15) ; //!< Filter Coefficient[0,14]
2627 uint32_t FilterCoefficient015 : __CODEGEN_BITFIELD(16, 31) ; //!< Filter Coefficient[0,15]
2628 };
2629 uint32_t Value;
2630 } DW7;
2631
2632 //! \name Local enumerations
2633
2634 //! \name Initializations
2635
2636 //! \brief Explicit member initialization function
2637 SAMPLER_STATE_8x8_CONVOLVE_COEFFICIENTS_CMD();
2638
2639 static const size_t dwSize = 8;
2640 static const size_t byteSize = 32;
2641 };
2642
2643 //!
2644 //! \brief SAMPLER_STATE_8x8_CONVOLVE
2645 //! \details
2646 //! Function: 0001b ExistsIf: [Convolve] &amp;&amp; [SKL_mode==0] &amp;&amp;
2647 //! [(Kernel Size) =< (15x15)]
2648 //!
2649 //! Function: 1010b ExistsIf: "[1Pixel Convolution ] &amp;&amp; [(Kernel
2650 //! Size) =< (15x15)]
2651 //!
2652 //! Function: 0001b ExistsIf: [Convolve] &amp;&amp; [SKL_mode==1] &amp;&amp;
2653 //! [(Kernel Size) > (15x15)]
2654 //!
2655 struct SAMPLER_STATE_8x8_CONVOLVE_CMD
2656 {
2657 union
2658 {
2659 //!< DWORD 0
2660 struct
2661 {
2662 uint32_t Height : __CODEGEN_BITFIELD( 0, 3) ; //!< HEIGHT
2663 uint32_t Width : __CODEGEN_BITFIELD( 4, 7) ; //!< WIDTH
2664 uint32_t ScaleDownValue : __CODEGEN_BITFIELD( 8, 11) ; //!< Scale down value
2665 uint32_t SizeOfTheCoefficient : __CODEGEN_BITFIELD(12, 12) ; //!< SIZE_OF_THE_COEFFICIENT
2666 uint32_t Reserved13 : __CODEGEN_BITFIELD(13, 15) ; //!< Reserved
2667 uint32_t MsbHeight : __CODEGEN_BITFIELD(16, 16) ; //!< MSB_HEIGHT
2668 uint32_t Reserved17 : __CODEGEN_BITFIELD(17, 19) ; //!< Reserved
2669 uint32_t MsbWidth : __CODEGEN_BITFIELD(20, 20) ; //!< MSB_WIDTH
2670 uint32_t Reserved21 : __CODEGEN_BITFIELD(21, 31) ; //!< Reserved
2671 };
2672 uint32_t Value;
2673 } DW0;
2674
2675 uint32_t Reserved32[15]; //!< Reserved
2676
2677
2678 mhw_state_heap_g11_X::SAMPLER_STATE_8x8_CONVOLVE_COEFFICIENTS_CMD FilterCoefficient300310[62]; //!< Filter Coefficient[30:0,31:0]
2679
2680
2681 //! \name Local enumerations
2682
2683 enum SIZE_OF_THE_COEFFICIENT
2684 {
2685 SIZE_OF_THE_COEFFICIENT_8BIT = 0, //!< The lower 8 bits of the accumulator is forced to zero or ignored during the accumulation operation.
2686 SIZE_OF_THE_COEFFICIENT_16BIT = 1, //!< The lower 8 bits are also included for the operation. The final result of the accumulator is shifted before clamping the result as specified by the Scale down value.:Result[15:0] = Clamp(Accum[40:12] >> scale_down)
2687 };
2688
2689 //! \brief MSB_HEIGHT
2690 //! \details
2691 //! It contains the MSB HEIGHT of the kernel and is used to extend the
2692 //! kernel width range to 31.
2693 //! Used along with bits[3:0] which represents the LSB for the kernel
2694 //! Height.
2695 enum MSB_HEIGHT
2696 {
2697 MSB_HEIGHT_NOCHANGE = 0, //!< No Change to the Filter Size
2698 MSB_HEIGHT_EXTENDED = 1, //!< Extends the filter size height upto 31.
2699 };
2700
2701 //! \brief MSB_WIDTH
2702 //! \details
2703 //! It contains the MSB Width of the kernel and is used to extend the kernel
2704 //! width range to 31.
2705 //! Used along with bits[3:0] which represents the LSB for the kernel
2706 //! Height.
2707 enum MSB_WIDTH
2708 {
2709 MSB_WIDTH_NOCHANGE = 0, //!< No Change to the Filter Size
2710 MSB_WIDTH_EXTENDED = 1, //!< Extends the Filter Size Width upto 31.
2711 };
2712
2713 //! \name Initializations
2714
2715 //! \brief Explicit member initialization function
2716 SAMPLER_STATE_8x8_CONVOLVE_CMD();
2717
2718 static const size_t dwSize = 512;
2719 static const size_t byteSize = 2048;
2720 };
2721
2722 //!
2723 //! \brief SAMPLER_STATE_8x8_ERODE_DILATE_MINMAXFILTER
2724 //! \details
2725 //! The table is valid for the following funstions: 0100 - Erode 0101 -
2726 //! Dilate 0011 - MinMaxFilter
2727 //!
2728 //! The table is valid for the following funstions: 0100 - Erode &amp;&amp;
2729 //! (Function_mode==0) 0101 - Dilate &amp;&amp; (Function_mode==0) 0011 -
2730 //! MinMaxFilter &amp;&amp; (Function_mode==0)
2731 //!
2732 //! Max kernel size is 15x15. For sizes less than 15x15 the coefficients not
2733 //! used should be zeroed out.
2734 //!
2735 struct SAMPLER_STATE_8x8_ERODE_DILATE_MINMAXFILTER_CMD
2736 {
2737 union
2738 {
2739 //!< DWORD 0
2740 struct
2741 {
2742 uint32_t HeightOfTheKernel : __CODEGEN_BITFIELD( 0, 3) ; //!< Height Of The Kernel
2743 uint32_t WidthOfTheKernel : __CODEGEN_BITFIELD( 4, 7) ; //!< Width Of The Kernel
2744 uint32_t Reserved8 : __CODEGEN_BITFIELD( 8, 15) ; //!< Reserved
2745 uint32_t BitMask16ForRow0150 : __CODEGEN_BITFIELD(16, 31) ; //!< 16bit Mask for Row0 [15:0]
2746 };
2747 uint32_t Value;
2748 } DW0;
2749 union
2750 {
2751 //!< DWORD 1
2752 struct
2753 {
2754 uint32_t BitMask16ForRow1150 : __CODEGEN_BITFIELD( 0, 15) ; //!< 16bit Mask for Row1 [15:0]
2755 uint32_t BitMask16ForRow2150 : __CODEGEN_BITFIELD(16, 31) ; //!< 16bit Mask for Row2 [15:0]
2756 };
2757 uint32_t Value;
2758 } DW1;
2759 union
2760 {
2761 //!< DWORD 2
2762 struct
2763 {
2764 uint32_t BitMask16ForRow3150 : __CODEGEN_BITFIELD( 0, 15) ; //!< 16bit Mask for Row3 [15:0]
2765 uint32_t BitMask16ForRow4150 : __CODEGEN_BITFIELD(16, 31) ; //!< 16bit Mask for Row4 [15:0]
2766 };
2767 uint32_t Value;
2768 } DW2;
2769 union
2770 {
2771 //!< DWORD 3
2772 struct
2773 {
2774 uint32_t BitMask16ForRow5150 : __CODEGEN_BITFIELD( 0, 15) ; //!< 16bit Mask for Row5 [15:0]
2775 uint32_t BitMask16ForRow6150 : __CODEGEN_BITFIELD(16, 31) ; //!< 16bit Mask for Row6 [15:0]
2776 };
2777 uint32_t Value;
2778 } DW3;
2779 union
2780 {
2781 //!< DWORD 4
2782 struct
2783 {
2784 uint32_t BitMask16ForRow7150 : __CODEGEN_BITFIELD( 0, 15) ; //!< 16bit Mask for Row7 [15:0]
2785 uint32_t BitMask16ForRow8150 : __CODEGEN_BITFIELD(16, 31) ; //!< 16bit Mask for Row8 [15:0]
2786 };
2787 uint32_t Value;
2788 } DW4;
2789 union
2790 {
2791 //!< DWORD 5
2792 struct
2793 {
2794 uint32_t BitMask16ForRow9150 : __CODEGEN_BITFIELD( 0, 15) ; //!< 16bit Mask for Row9 [15:0]
2795 uint32_t BitMask16ForRow10150 : __CODEGEN_BITFIELD(16, 31) ; //!< 16bit Mask for Row10 [15:0]
2796 };
2797 uint32_t Value;
2798 } DW5;
2799 union
2800 {
2801 //!< DWORD 6
2802 struct
2803 {
2804 uint32_t BitMask16ForRow11150 : __CODEGEN_BITFIELD( 0, 15) ; //!< 16bit Mask for Row11 [15:0]
2805 uint32_t BitMask16ForRow12150 : __CODEGEN_BITFIELD(16, 31) ; //!< 16bit Mask for Row12 [15:0]
2806 };
2807 uint32_t Value;
2808 } DW6;
2809 union
2810 {
2811 //!< DWORD 7
2812 struct
2813 {
2814 uint32_t BitMask16ForRow13150 : __CODEGEN_BITFIELD( 0, 15) ; //!< 16bit Mask for Row13 [15:0]
2815 uint32_t BitMask16ForRow14150 : __CODEGEN_BITFIELD(16, 31) ; //!< 16bit Mask for Row14 [15:0]
2816 };
2817 uint32_t Value;
2818 } DW7;
2819
2820 //! \name Local enumerations
2821
2822 //! \name Initializations
2823
2824 //! \brief Explicit member initialization function
2825 SAMPLER_STATE_8x8_ERODE_DILATE_MINMAXFILTER_CMD();
2826
2827 static const size_t dwSize = 8;
2828 static const size_t byteSize = 32;
2829 };
2830
2831 //!
2832 //! \brief SAMPLER_INDIRECT_STATE
2833 //! \details
2834 //! Note: There are three variations of this structure, defined separately
2835 //! because their payloads have different lengths. Currently only
2836 //! SAMPLER_INDIRECT_STATE_BORDER_COLOR is fully defined. 
2837 //! This structure is pointed to by Indirect State Pointer (SAMPLER_STATE).
2838 //! The interpretation of the border color depends on the Texture Border
2839 //! Color Mode field in SAMPLER_STATE as follows:
2840 //!
2841 //! In 8 bit mode, the border color is 8-bit UNORM format, regardless of the
2842 //! surface format chosen. For surface formats with one or more channels
2843 //! missing (i.e. R5G6R5_UNORM is missing the alpha channel), the value from
2844 //! the border color, if selected, will be used even for the missing
2845 //! channels.
2846 //!
2847 //! In OGL mode, the format of the border color is R32G32B32A32_FLOAT,
2848 //! R32G32B32A32_SINT, or R32G32B32A32_UINT, depending on the surface format
2849 //! chosen. For surface formats with one or more channels missing, the value
2850 //! from the border color is not used for the missing channels, resulting in
2851 //! these channels resulting in the overall default value (0 for colors and
2852 //! 1 for alpha) regardless of whether border color is chosen. The surface
2853 //! formats with "L" and "I" have special behavior with respect to the
2854 //! border color. The border color value used for the replicated channels
2855 //! (RGB for "L" formats and RGBA for "I" formats) comes from the red
2856 //! channel of border color. In these cases, the green and blue channels,
2857 //! and also alpha for "I", of the border color are ignored.
2858 //!
2859 //!
2860 //!
2861 //!
2862 //!
2863 //! The format of this state depends on the Texture Border Color Mode field.
2864 //!
2865 //! 8 bit mode is not supported for surfaces with more than 16 bits in any
2866 //! channel, other than 32-bit float formats which are supported.
2867 //! The conditions under which this color is used depend on the Surface
2868 //! Type - 1D/2D/3D surfaces use the border color when the coordinates
2869 //! extend beyond the surface extent; cube surfaces use the border color for
2870 //! "empty" (disabled) faces.
2871 //! The border color itself is accessed through the texture cache hierarchy
2872 //! rather than the state cache hierarchy. Thus, if the border color is
2873 //! changed in memory, the texture cache must be invalidated and the state
2874 //! cache does not need to be invalidated.
2875 //! MAPFILTER_MONO: The border color is ignored. Border color is fixed at
2876 //! a value of 0 by hardware.
2877 //!
2878 //!
2879 struct SAMPLER_INDIRECT_STATE_CMD
2880 {
2881 union
2882 {
2883 //!< DWORD 0
2884 struct
2885 {
2886 uint32_t BorderColorRed ; //!< Border Color Red, Structure[SAMPLER_STATE][Texture Border Color Mode] == 'OGL'
2887 } Obj0;
2888 struct
2889 {
2890 uint32_t BorderColorRed : __CODEGEN_BITFIELD( 0, 7) ; //!< Border Color Red, Structure[SAMPLER_STATE][Texture Border Color Mode] == '8BIT'
2891 uint32_t BorderColorGreen : __CODEGEN_BITFIELD( 8, 15) ; //!< Border Color Green, Structure[SAMPLER_STATE][Texture Border Color Mode] == '8BIT'
2892 uint32_t BorderColorBlue : __CODEGEN_BITFIELD(16, 23) ; //!< Border Color Blue, Structure[SAMPLER_STATE][Texture Border Color Mode] == '8BIT'
2893 uint32_t BorderColorAlpha : __CODEGEN_BITFIELD(24, 31) ; //!< Border Color Alpha, Structure[SAMPLER_STATE][Texture Border Color Mode] == '8BIT'
2894 } Obj1;
2895 uint32_t Value;
2896 } DW0;
2897 union
2898 {
2899 //!< DWORD 1
2900 struct
2901 {
2902 uint32_t BorderColorGreen ; //!< Border Color Green, Structure[SAMPLER_STATE][Texture Border Color Mode] == 'OGL'
2903 };
2904 uint32_t Value;
2905 } DW1;
2906 union
2907 {
2908 //!< DWORD 2
2909 struct
2910 {
2911 uint32_t BorderColorBlue ; //!< Border Color Blue, Structure[SAMPLER_STATE][Texture Border Color Mode] == 'OGL'
2912 };
2913 uint32_t Value;
2914 } DW2;
2915 union
2916 {
2917 //!< DWORD 3
2918 struct
2919 {
2920 uint32_t BorderColorAlpha ; //!< Border Color Alpha, Structure[SAMPLER_STATE][Texture Border Color Mode] == 'OGL'
2921 };
2922 uint32_t Value;
2923 } DW3;
2924
2925 uint32_t Reserved128[12]; //!< Reserved
2926
2927
2928 //! \name Local enumerations
2929
2930 //! \name Initializations
2931
2932 //! \brief Explicit member initialization function
2933 SAMPLER_INDIRECT_STATE_CMD();
2934
2935 static const size_t dwSize = 16;
2936 static const size_t byteSize = 64;
2937 };
2938
2939 };
2940
2941 #pragma pack()
2942
2943 #endif // __MHW_STATE_HEAP_HWCMD_G11_X_H__