Debian Codegraph @

media_driver/agnostic/gen12/hw/mhw_state_heap_hwcmd_g12_X.h

raw
1 /*
2 * Copyright (c) 2015-2019, 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_g12_X.h
24 //! \brief Auto-generated constructors for MHW and states.
25 //! \details This file may not be included outside of g12_X as other components
26 //! should use MHW interface to interact with MHW commands and states.
27 //!
28
29 // DO NOT EDIT
30
31 #ifndef __MHW_STATE_HEAP_HWCMD_G12_X_H__
32 #define __MHW_STATE_HEAP_HWCMD_G12_X_H__
33
34 #pragma once
35 #include <cstdint>
36 #include <cstddef>
37
38
39 #pragma pack(1)
40
41 class mhw_state_heap_g12_X
42 {
43 public:
44 // Internal Macros
45 #define __CODEGEN_MAX(_a, _b) (((_a) > (_b)) ? (_a) : (_b))
46 #define __CODEGEN_BITFIELD(l, h) (h) - (l) + 1
47 #define __CODEGEN_OP_LENGTH_BIAS 2
48 #define __CODEGEN_OP_LENGTH(x) (uint32_t)((__CODEGEN_MAX(x, __CODEGEN_OP_LENGTH_BIAS)) - __CODEGEN_OP_LENGTH_BIAS)
49
50 static uint32_t GetOpLength(uint32_t uiLength) { return __CODEGEN_OP_LENGTH(uiLength); }
51
52 //!
53 //! \brief INTERFACE_DESCRIPTOR_DATA
54 //! \details
55 //!
56 //!
57 struct INTERFACE_DESCRIPTOR_DATA_CMD
58 {
59 union
60 {
61 struct
62 {
63 uint32_t Reserved0 : __CODEGEN_BITFIELD( 0, 5) ; //!< Reserved
64 uint32_t KernelStartPointer : __CODEGEN_BITFIELD( 6, 31) ; //!< Kernel Start Pointer
65 };
66 uint32_t Value;
67 } DW0;
68 union
69 {
70 struct
71 {
72 uint32_t KernelStartPointerHigh : __CODEGEN_BITFIELD( 0, 15) ; //!< Kernel Start Pointer High
73 uint32_t Reserved48 : __CODEGEN_BITFIELD(16, 31) ; //!< Reserved
74 };
75 uint32_t Value;
76 } DW1;
77 union
78 {
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 struct
100 {
101 uint32_t Reserved96 : __CODEGEN_BITFIELD( 0, 1) ; //!< Reserved
102 uint32_t SamplerCount : __CODEGEN_BITFIELD( 2, 4) ; //!< SAMPLER_COUNT
103 uint32_t SamplerStatePointer : __CODEGEN_BITFIELD( 5, 31) ; //!< Sampler State Pointer
104 };
105 uint32_t Value;
106 } DW3;
107 union
108 {
109 struct
110 {
111 uint32_t BindingTableEntryCount : __CODEGEN_BITFIELD( 0, 4) ; //!< Binding Table Entry Count
112 uint32_t BindingTablePointer : __CODEGEN_BITFIELD( 5, 20) ; //!< Binding Table Pointer
113 uint32_t Reserved149 : __CODEGEN_BITFIELD(21, 31) ; //!< Reserved
114 };
115 uint32_t Value;
116 } DW4;
117 union
118 {
119 struct
120 {
121 uint32_t ConstantUrbEntryReadOffset : __CODEGEN_BITFIELD( 0, 15) ; //!< Constant URB Entry Read Offset
122 uint32_t ConstantIndirectUrbEntryReadLength : __CODEGEN_BITFIELD(16, 31) ; //!< Constant/Indirect URB Entry Read Length
123 };
124 uint32_t Value;
125 } DW5;
126 union
127 {
128 struct
129 {
130 uint32_t NumberOfThreadsInGpgpuThreadGroup : __CODEGEN_BITFIELD( 0, 9) ; //!< Number of Threads in GPGPU Thread Group
131 uint32_t Reserved202 : __CODEGEN_BITFIELD(10, 12) ; //!< Reserved
132 uint32_t OverDispatchControl : __CODEGEN_BITFIELD(13, 14) ; //!< OVER_DISPATCH_CONTROL
133 uint32_t Reserved207 : __CODEGEN_BITFIELD(15, 15) ; //!< Reserved
134 uint32_t SharedLocalMemorySize : __CODEGEN_BITFIELD(16, 20) ; //!< SHARED_LOCAL_MEMORY_SIZE
135 uint32_t BarrierEnable : __CODEGEN_BITFIELD(21, 21) ; //!< Barrier Enable
136 uint32_t RoundingMode : __CODEGEN_BITFIELD(22, 23) ; //!< ROUNDING_MODE
137 uint32_t Reserved216 : __CODEGEN_BITFIELD(24, 31) ; //!< Reserved
138 };
139 uint32_t Value;
140 } DW6;
141 union
142 {
143 struct
144 {
145 uint32_t CrossThreadConstantDataReadLength : __CODEGEN_BITFIELD( 0, 7) ; //!< Cross-Thread Constant Data Read Length
146 uint32_t Reserved232 : __CODEGEN_BITFIELD( 8, 31) ; //!< Reserved
147 };
148 uint32_t Value;
149 } DW7;
150
151 //! \name Local enumerations
152
153 //! \brief FLOATING_POINT_MODE
154 //! \details
155 //! Specifies the floating point mode used by the dispatched thread.
156 enum FLOATING_POINT_MODE
157 {
158 FLOATING_POINT_MODE_IEEE_754 = 0, //!< No additional details
159 FLOATING_POINT_MODE_ALTERNATE = 1, //!< No additional details
160 };
161
162 //! \brief THREAD_PRIORITY
163 //! \details
164 //! Specifies the priority of the thread for dispatch.
165 enum THREAD_PRIORITY
166 {
167 THREAD_PRIORITY_NORMALPRIORITY = 0, //!< No additional details
168 THREAD_PRIORITY_HIGHPRIORITY = 1, //!< No additional details
169 };
170
171 //! \brief SINGLE_PROGRAM_FLOW
172 //! \details
173 //! Specifies whether the kernel program has a single program flow (SIMDnxm
174 //! with m = 1) or multiple program flows (SIMDnxm with m > 1).
175 enum SINGLE_PROGRAM_FLOW
176 {
177 SINGLE_PROGRAM_FLOW_MULTIPLE = 0, //!< No additional details
178 SINGLE_PROGRAM_FLOW_SINGLE = 1, //!< No additional details
179 };
180
181 //! \brief DENORM_MODE
182 //! \details
183 //! This field specifies how Float denormalized numbers are handles in the
184 //! dispatched thread.
185 enum DENORM_MODE
186 {
187 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.
188 DENORM_MODE_SETBYKERNEL = 1, //!< Denorms will be handled in by kernel.
189 };
190
191 //! \brief THREAD_PREEMPTION_DISABLE
192 //! \details
193 //! This field specifies whether, when dispatched, the thread is allowed to
194 //! stop in middle on receiving mid-thread pre-emption request.
195 enum THREAD_PREEMPTION_DISABLE
196 {
197 THREAD_PREEMPTION_DISABLE_DISABLE = 0, //!< Thread is pre-empted on receiving pre-emption indication.
198 THREAD_PREEMPTION_DISABLE_ENABLE = 1, //!< Thread is preempted only in case of page-fault.
199 };
200
201 //! \brief SAMPLER_COUNT
202 //! \details
203 //! Specifies how many samplers (in multiples of 4) the kernel uses. Used
204 //! only for prefetching the associated sampler state entries.
205 //! This field is ignored for child threads.
206 //! If this field is not zero, sampler state is prefetched for the
207 //! first instance of a root thread upon the startup of the media
208 //! pipeline.
209 enum SAMPLER_COUNT
210 {
211 SAMPLER_COUNT_NOSAMPLERSUSED = 0, //!< No additional details
212 SAMPLER_COUNT_BETWEEN1AND4SAMPLERSUSED = 1, //!< No additional details
213 SAMPLER_COUNT_BETWEEN5AND8SAMPLERSUSED = 2, //!< No additional details
214 SAMPLER_COUNT_BETWEEN9AND12SAMPLERSUSED = 3, //!< No additional details
215 SAMPLER_COUNT_BETWEEN13AND16SAMPLERSUSED = 4, //!< No additional details
216 };
217
218 //! \brief OVER_DISPATCH_CONTROL
219 //! \details
220 //! Over Dispatch Control that enables and controls the amount of GPGPU
221 //! thread over dispatch.
222 enum OVER_DISPATCH_CONTROL
223 {
224 OVER_DISPATCH_CONTROL_NONE = 0, //!< No additional details
225 OVER_DISPATCH_CONTROL_LOW = 1, //!< No additional details
226 OVER_DISPATCH_CONTROL_HIGH = 2, //!< No additional details
227 OVER_DISPATCH_CONTROL_NORMAL = 3, //!< No additional details
228 };
229
230 //! \brief SHARED_LOCAL_MEMORY_SIZE
231 //! \details
232 //! This field indicates how much Shared Local Memory the thread group
233 //! requires. The amount is specified in 4k blocks, but only powers of 2 are
234 //! allowed: 0, 4k, 8k, 16k, 32k and 64k per half-slice.
235 enum SHARED_LOCAL_MEMORY_SIZE
236 {
237 SHARED_LOCAL_MEMORY_SIZE_ENCODES0K = 0, //!< No SLM used
238 SHARED_LOCAL_MEMORY_SIZE_ENCODES1K = 1, //!< No additional details
239 SHARED_LOCAL_MEMORY_SIZE_ENCODES2K = 2, //!< No additional details
240 SHARED_LOCAL_MEMORY_SIZE_ENCODES4K = 3, //!< No additional details
241 SHARED_LOCAL_MEMORY_SIZE_ENCODES8K = 4, //!< No additional details
242 SHARED_LOCAL_MEMORY_SIZE_ENCODES16K = 5, //!< No additional details
243 SHARED_LOCAL_MEMORY_SIZE_ENCODES32K = 6, //!< No additional details
244 SHARED_LOCAL_MEMORY_SIZE_ENCODES64K = 7, //!< No additional details
245 };
246
247 enum ROUNDING_MODE
248 {
249 ROUNDING_MODE_RTNE = 0, //!< Round to Nearest Even
250 ROUNDING_MODE_RU = 1, //!< Round toward +Infinity
251 ROUNDING_MODE_RD = 2, //!< Round toward -Infinity
252 ROUNDING_MODE_RTZ = 3, //!< Round toward Zero
253 };
254
255 //! \name Initializations
256
257 //! \brief Explicit member initialization function
258 INTERFACE_DESCRIPTOR_DATA_CMD();
259
260 static const size_t dwSize = 8;
261 static const size_t byteSize = 32;
262 };
263
264 //!
265 //! \brief BINDING_TABLE_STATE
266 //! \details
267 //! The binding table binds surfaces to logical resource indices used by
268 //! shaders and other compute engine kernels. It is stored as an array of up
269 //! to 256 elements, each of which contains one dword as defined here. The
270 //! start of each element is spaced one dword apart. The first element of
271 //! the binding table is aligned to a 64-byte boundary. Binding table
272 //! indexes beyond 256 will automatically be mapped to entry 0 by the HW, w/
273 //! the exception of any messages which support the special indexes 240
274 //! through 255, inclusive.
275 //!
276 struct BINDING_TABLE_STATE_CMD
277 {
278 union
279 {
280 //!< DWORD 0
281 struct
282 {
283 uint32_t Reserved0 : __CODEGEN_BITFIELD( 0, 5) ; //!< Reserved
284 uint32_t SurfaceStatePointer : __CODEGEN_BITFIELD( 6, 31) ; //!< Surface State Pointer
285 };
286 uint32_t Value;
287 } DW0;
288
289 //! \name Local enumerations
290
291 //! \name Initializations
292
293 //! \brief Explicit member initialization function
294 BINDING_TABLE_STATE_CMD();
295
296 static const size_t dwSize = 1;
297 static const size_t byteSize = 4;
298 };
299
300 //!
301 //! \brief RENDER_SURFACE_STATE
302 //! \details
303 //! This is the normal surface state used by all messages that use
304 //! SURFACE_STATE except those that use MEDIA_SURFACE_STATE.
305 //!
306 struct RENDER_SURFACE_STATE_CMD
307 {
308 union
309 {
310 struct
311 {
312 uint32_t CubeFaceEnablePositiveZ : __CODEGEN_BITFIELD( 0, 0) ; //!< Cube Face Enable - Positive Z
313 uint32_t CubeFaceEnableNegativeZ : __CODEGEN_BITFIELD( 1, 1) ; //!< Cube Face Enable - Negative Z
314 uint32_t CubeFaceEnablePositiveY : __CODEGEN_BITFIELD( 2, 2) ; //!< Cube Face Enable - Positive Y
315 uint32_t CubeFaceEnableNegativeY : __CODEGEN_BITFIELD( 3, 3) ; //!< Cube Face Enable - Negative Y
316 uint32_t CubeFaceEnablePositiveX : __CODEGEN_BITFIELD( 4, 4) ; //!< Cube Face Enable - Positive X
317 uint32_t CubeFaceEnableNegativeX : __CODEGEN_BITFIELD( 5, 5) ; //!< Cube Face Enable - Negative X
318 uint32_t MediaBoundaryPixelMode : __CODEGEN_BITFIELD( 6, 7) ; //!< MEDIA_BOUNDARY_PIXEL_MODE
319 uint32_t RenderCacheReadWriteMode : __CODEGEN_BITFIELD( 8, 8) ; //!< RENDER_CACHE_READ_WRITE_MODE
320 uint32_t SamplerL2OutOfOrderModeDisable : __CODEGEN_BITFIELD( 9, 9) ; //!< Sampler L2 Out of Order Mode Disable
321 uint32_t VerticalLineStrideOffset : __CODEGEN_BITFIELD(10, 10) ; //!< Vertical Line Stride Offset
322 uint32_t VerticalLineStride : __CODEGEN_BITFIELD(11, 11) ; //!< Vertical Line Stride
323 uint32_t TileMode : __CODEGEN_BITFIELD(12, 13) ; //!< TILE_MODE
324 uint32_t SurfaceHorizontalAlignment : __CODEGEN_BITFIELD(14, 15) ; //!< SURFACE_HORIZONTAL_ALIGNMENT
325 uint32_t SurfaceVerticalAlignment : __CODEGEN_BITFIELD(16, 17) ; //!< SURFACE_VERTICAL_ALIGNMENT
326 uint32_t SurfaceFormat : __CODEGEN_BITFIELD(18, 26) ; //!< SURFACE_FORMAT
327 uint32_t AstcEnable : __CODEGEN_BITFIELD(27, 27) ; //!< ASTC_Enable
328 uint32_t SurfaceArray : __CODEGEN_BITFIELD(28, 28) ; //!< Surface Array
329 uint32_t SurfaceType : __CODEGEN_BITFIELD(29, 31) ; //!< SURFACE_TYPE
330 };
331 uint32_t Value;
332 } DW0;
333 union
334 {
335 struct
336 {
337 uint32_t SurfaceQpitch : __CODEGEN_BITFIELD( 0, 14) ; //!< Surface QPitch
338 uint32_t SampleTapDiscardDisable : __CODEGEN_BITFIELD(15, 15) ; //!< SAMPLE_TAP_DISCARD_DISABLE
339 uint32_t Reserved48 : __CODEGEN_BITFIELD(16, 16) ; //!< Reserved
340 uint32_t DoubleFetchDisable : __CODEGEN_BITFIELD(17, 17) ; //!< DOUBLE_FETCH_DISABLE
341 uint32_t CornerTexelMode : __CODEGEN_BITFIELD(18, 18) ; //!< CORNER_TEXEL_MODE
342 uint32_t BaseMipLevel : __CODEGEN_BITFIELD(19, 23) ; //!< Base Mip Level
343 uint32_t MemoryObjectControlState : __CODEGEN_BITFIELD(24, 30) ; //!< Memory Object Control State
344 uint32_t EnableUnormPathInColorPipe : __CODEGEN_BITFIELD(31, 31) ; //!< ENABLE_UNORM_PATH_IN_COLOR_PIPE
345 };
346 uint32_t Value;
347 } DW1;
348 union
349 {
350 struct
351 {
352 uint32_t Width : __CODEGEN_BITFIELD( 0, 13) ; //!< Width
353 uint32_t Reserved78 : __CODEGEN_BITFIELD(14, 15) ; //!< Reserved
354 uint32_t Height : __CODEGEN_BITFIELD(16, 29) ; //!< Height
355 uint32_t Reserved94 : __CODEGEN_BITFIELD(30, 30) ; //!< Reserved
356 uint32_t DepthStencilResource : __CODEGEN_BITFIELD(31, 31) ; //!< Depth/Stencil Resource
357 };
358 uint32_t Value;
359 } DW2;
360 union
361 {
362 struct
363 {
364 uint32_t SurfacePitch : __CODEGEN_BITFIELD( 0, 17) ; //!< Surface Pitch
365 uint32_t NullProbingEnable : __CODEGEN_BITFIELD(18, 18) ; //!< NULL_PROBING_ENABLE
366 uint32_t StandardTilingModeExtensions : __CODEGEN_BITFIELD(19, 19) ; //!< STANDARD_TILING_MODE_EXTENSIONS
367 uint32_t TileAddressMappingMode : __CODEGEN_BITFIELD(20, 20) ; //!< TILE_ADDRESS_MAPPING_MODE
368 uint32_t Depth : __CODEGEN_BITFIELD(21, 31) ; //!< Depth
369 };
370 uint32_t Value;
371 } DW3;
372 union
373 {
374 struct
375 {
376 uint32_t MultisamplePositionPaletteIndex : __CODEGEN_BITFIELD( 0, 2) ; //!< Multisample Position Palette Index
377 uint32_t NumberOfMultisamples : __CODEGEN_BITFIELD( 3, 5) ; //!< NUMBER_OF_MULTISAMPLES
378 uint32_t MultisampledSurfaceStorageFormat : __CODEGEN_BITFIELD( 6, 6) ; //!< MULTISAMPLED_SURFACE_STORAGE_FORMAT
379 uint32_t RenderTargetViewExtent : __CODEGEN_BITFIELD( 7, 17) ; //!< Render Target View Extent
380 uint32_t MinimumArrayElement : __CODEGEN_BITFIELD(18, 28) ; //!< Minimum Array Element
381 uint32_t RenderTargetAndSampleUnormRotation : __CODEGEN_BITFIELD(29, 30) ; //!< RENDER_TARGET_AND_SAMPLE_UNORM_ROTATION
382 uint32_t DecompressInL3 : __CODEGEN_BITFIELD(31, 31) ; //!< DECOMPRESS_IN_L3
383 };
384 uint32_t Value;
385 } DW4;
386 union
387 {
388 struct
389 {
390 uint32_t MipCountLod : __CODEGEN_BITFIELD( 0, 3) ; //!< MIP Count / LOD
391 uint32_t SurfaceMinLod : __CODEGEN_BITFIELD( 4, 7) ; //!< Surface Min LOD
392 uint32_t MipTailStartLod : __CODEGEN_BITFIELD( 8, 11) ; //!< Mip Tail Start LOD
393 uint32_t Reserved172 : __CODEGEN_BITFIELD(12, 13) ; //!< Reserved
394 uint32_t CoherencyType : __CODEGEN_BITFIELD(14, 14) ; //!< COHERENCY_TYPE
395 uint32_t Reserved175 : __CODEGEN_BITFIELD(15, 17) ; //!< Reserved
396 uint32_t TiledResourceMode : __CODEGEN_BITFIELD(18, 19) ; //!< TILED_RESOURCE_MODE
397 uint32_t EwaDisableForCube : __CODEGEN_BITFIELD(20, 20) ; //!< EWA_DISABLE_FOR_CUBE
398 uint32_t YOffset : __CODEGEN_BITFIELD(21, 23) ; //!< Y Offset
399 uint32_t Reserved184 : __CODEGEN_BITFIELD(24, 24) ; //!< Reserved
400 uint32_t XOffset : __CODEGEN_BITFIELD(25, 31) ; //!< X Offset
401 };
402 uint32_t Value;
403 } DW5;
404 union
405 {
406 struct
407 {
408 uint32_t AuxiliarySurfaceMode : __CODEGEN_BITFIELD( 0, 2) ; //!< AUXILIARY_SURFACE_MODE, ([Surface Format] != 'PLANAR')
409 uint32_t Reserved195 : __CODEGEN_BITFIELD( 3, 31) ; //!< Reserved, ([Surface Format] != 'PLANAR')
410 } Obj0;
411 struct
412 {
413 uint32_t Reserved192 : __CODEGEN_BITFIELD( 0, 2) ; //!< Reserved, ([Surface Format] != 'PLANAR')
414 uint32_t AuxiliarySurfacePitch : __CODEGEN_BITFIELD( 3, 12) ; //!< Auxiliary Surface Pitch, ([Surface Format] != 'PLANAR')
415 uint32_t Reserved205 : __CODEGEN_BITFIELD(13, 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 YOffsetForUOrUvPlane : __CODEGEN_BITFIELD( 0, 13) ; //!< Y Offset for U or UV Plane, ([Surface Format] == 'PLANAR')
422 uint32_t Reserved206 : __CODEGEN_BITFIELD(14, 15) ; //!< Reserved, ([Surface Format] == 'PLANAR')
423 uint32_t XOffsetForUOrUvPlane : __CODEGEN_BITFIELD(16, 29) ; //!< X Offset for U or UV Plane, ([Surface Format] == 'PLANAR')
424 uint32_t HalfPitchForChroma : __CODEGEN_BITFIELD(30, 30) ; //!< HALF_PITCH_FOR_CHROMA, ([Surface Format] == 'PLANAR')
425 uint32_t SeparateUvPlaneEnable : __CODEGEN_BITFIELD(31, 31) ; //!< Separate UV Plane Enable, ([Surface Format] == 'PLANAR')
426 } Obj2;
427 struct
428 {
429 uint32_t Reserved192 : __CODEGEN_BITFIELD( 0, 14) ; //!< Reserved, ([Surface Format] == 'PLANAR')
430 uint32_t YuvInterpolationEnable : __CODEGEN_BITFIELD(15, 15) ; //!< YUV_INTERPOLATION_ENABLE,
431 uint32_t Reserved208 : __CODEGEN_BITFIELD(16, 31) ; //!< Reserved,
432 } Obj3;
433 uint32_t Value;
434 } DW6;
435 union
436 {
437 struct
438 {
439 uint32_t ResourceMinLod : __CODEGEN_BITFIELD( 0, 11) ; //!< Resource Min LOD
440 uint32_t Reserved236 : __CODEGEN_BITFIELD(12, 15) ; //!< Reserved
441 uint32_t ShaderChannelSelectAlpha : __CODEGEN_BITFIELD(16, 18) ; //!< SHADER_CHANNEL_SELECT_ALPHA
442 uint32_t ShaderChannelSelectBlue : __CODEGEN_BITFIELD(19, 21) ; //!< SHADER_CHANNEL_SELECT_BLUE
443 uint32_t ShaderChannelSelectGreen : __CODEGEN_BITFIELD(22, 24) ; //!< SHADER_CHANNEL_SELECT_GREEN
444 uint32_t ShaderChannelSelectRed : __CODEGEN_BITFIELD(25, 27) ; //!< SHADER_CHANNEL_SELECT_RED
445 uint32_t Reserved252 : __CODEGEN_BITFIELD(28, 29) ; //!< Reserved
446 uint32_t MemoryCompressionEnable : __CODEGEN_BITFIELD(30, 30) ; //!< Memory Compression Enable
447 uint32_t MemoryCompressionMode : __CODEGEN_BITFIELD(31, 31) ; //!< MEMORY_COMPRESSION_MODE
448 };
449 uint32_t Value;
450 } DW7;
451 union
452 {
453 struct
454 {
455 uint64_t SurfaceBaseAddress ; //!< Surface Base Address
456 };
457 uint32_t Value[2];
458 } DW8_9;
459 union
460 {
461 struct
462 {
463 uint64_t QuiltWidth : __CODEGEN_BITFIELD( 0, 4) ; //!< Quilt Width,
464 uint64_t QuiltHeight : __CODEGEN_BITFIELD( 5, 9) ; //!< Quilt Height,
465 uint64_t ClearValueAddressEnable : __CODEGEN_BITFIELD(10, 10) ; //!< CLEAR_VALUE_ADDRESS_ENABLE,
466 uint64_t ProceduralTexture : __CODEGEN_BITFIELD(11, 11) ; //!< Procedural Texture,
467 uint64_t Reserved332 : __CODEGEN_BITFIELD(12, 31) ; //!< Reserved,
468 uint64_t YOffsetForVPlane : __CODEGEN_BITFIELD(32, 45) ; //!< Y Offset for V Plane, ([Surface Format] == 'PLANAR')
469 uint64_t Reserved366 : __CODEGEN_BITFIELD(46, 63) ; //!< Reserved, ([Surface Format] == 'PLANAR')
470 } Obj0;
471 struct
472 {
473 uint64_t Reserved320 : __CODEGEN_BITFIELD( 0, 47) ; //!< Reserved, ([Surface Format] == 'PLANAR')
474 uint64_t XOffsetForVPlane : __CODEGEN_BITFIELD(48, 61) ; //!< X Offset for V Plane, ([Surface Format] == 'PLANAR')
475 uint64_t Reserved382 : __CODEGEN_BITFIELD(62, 63) ; //!< Reserved, ([Surface Format] == 'PLANAR')
476 } Obj1;
477 struct
478 {
479 uint64_t Reserved320 : __CODEGEN_BITFIELD( 0, 11) ; //!< Reserved, ([Surface Format] == 'PLANAR')
480 uint64_t AuxiliarySurfaceBaseAddress : __CODEGEN_BITFIELD(12, 63) ; //!< Auxiliary Surface Base Address, ([Surface Format] != 'PLANAR') AND [Memory Compression Enable] == 0
481 } Obj2;
482 uint32_t Value[2];
483 } DW10_11;
484 union
485 {
486 struct
487 {
488 uint32_t Reserved384 : __CODEGEN_BITFIELD( 0, 5) ; //!< Reserved
489 uint32_t ClearAddressLow : __CODEGEN_BITFIELD( 6, 31) ; //!< Clear Address Low
490 };
491 uint32_t Value;
492 } DW12;
493 union
494 {
495 struct
496 {
497 uint32_t ClearAddressHigh : __CODEGEN_BITFIELD( 0, 15) ; //!< Clear Address High
498 uint32_t Reserved432 : __CODEGEN_BITFIELD(16, 31) ; //!< Reserved
499 };
500 uint32_t Value;
501 } DW13;
502 union
503 {
504 struct
505 {
506 uint32_t Reserved448 ; //!< Reserved
507 };
508 uint32_t Value;
509 } DW14;
510 union
511 {
512 struct
513 {
514 uint32_t Reserved480 ; //!< Reserved
515 };
516 uint32_t Value;
517 } DW15;
518
519 //! \name Local enumerations
520
521 //! \brief MEDIA_BOUNDARY_PIXEL_MODE
522 //! \details
523 //!
524 //! For 2D Non-Array Surfaces accessed via the Data Port Media Block
525 //! Read Message or Data Port Transpose Read message:
526 //! This field enables control of which rows are returned on vertical
527 //! out-of-bounds reads using the Data Port Media Block Read Message or Data
528 //! Port Transpose Read message. In the description below, frame mode refers
529 //! to Vertical Line Stride = 0, field mode is Vertical Line
530 //! Stride = 1 in which only the even or odd rows are addressable. The
531 //! frame refers to the entire surface, while the field refers only to the
532 //! even or odd rows within the surface.
533 //! For Other Surfaces:
534 //! Reserved : MBZ
535 enum MEDIA_BOUNDARY_PIXEL_MODE
536 {
537 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.
538 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.
539 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.
540 };
541
542 //! \brief RENDER_CACHE_READ_WRITE_MODE
543 //! \details
544 //! For Surfaces accessed via the Data Port to Render Cache:
545 //! This field specifies the way Render Cache treats a write request. If
546 //! unset, Render Cache allocates a write-only cache line for a write miss.
547 //! If set, Render Cache allocates a read-write cache line for a write
548 //! miss.
549 //! For Surfaces accessed via the Sampling Engine or Data Port to
550 //! Texture Cache or Data Cache:
551 //! This field is reserved : MBZ
552 enum RENDER_CACHE_READ_WRITE_MODE
553 {
554 RENDER_CACHE_READ_WRITE_MODE_WRITE_ONLYCACHE = 0, //!< Allocating write-only cache for a write miss
555 RENDER_CACHE_READ_WRITE_MODE_READ_WRITECACHE = 1, //!< Allocating read-write cache for a write miss
556 };
557
558 //! \brief TILE_MODE
559 //! \details
560 //! This field specifies the type of memory tiling (Linear, XMajor, or
561 //! YMajor) employed to tile this surface. See Memory Interface
562 //! Functions for details on memory tiling and restrictions.
563 enum TILE_MODE
564 {
565 TILE_MODE_LINEAR = 0, //!< Linear mode (no tiling)
566 TILE_MODE_XMAJOR = 2, //!< X major tiling
567 TILE_MODE_YMAJOR = 3, //!< Y major tiling
568 };
569
570 //! \brief SURFACE_HORIZONTAL_ALIGNMENT
571 //! \details
572 //! For Sampling Engine and Render Target Surfaces: This field specifies the
573 //! horizontal alignment requirement for the surface.
574 enum SURFACE_HORIZONTAL_ALIGNMENT
575 {
576 SURFACE_HORIZONTAL_ALIGNMENT_HALIGN4 = 1, //!< Horizontal alignment factor j = 4
577 SURFACE_HORIZONTAL_ALIGNMENT_HALIGN8 = 2, //!< Horizontal alignment factor j = 8
578 SURFACE_HORIZONTAL_ALIGNMENT_HALIGN16 = 3, //!< Horizontal alignment factor j = 16
579 };
580
581 //! \brief SURFACE_VERTICAL_ALIGNMENT
582 //! \details
583 //! For Sampling Engine and Render Target Surfaces: This field
584 //! specifies the vertical alignment requirement in elements for the
585 //! surface. Refer to the "Memory Data Formats" chapter for details on how
586 //! this field changes the layout of the surface in memory. An
587 //! element is defined as a pixel in uncompresed surface formats, and
588 //! as a compression block in compressed surface formats. For
589 //! MSFMT_DEPTH_STENCIL type multisampled surfaces, an element is a sample.
590 enum SURFACE_VERTICAL_ALIGNMENT
591 {
592 SURFACE_VERTICAL_ALIGNMENT_VALIGN4 = 1, //!< Vertical alignment factor j = 4
593 SURFACE_VERTICAL_ALIGNMENT_VALIGN8 = 2, //!< Vertical alignment factor j = 8
594 SURFACE_VERTICAL_ALIGNMENT_VALIGN16 = 3, //!< Vertical alignment factor j = 16
595 };
596
597 //! \brief SURFACE_FORMAT
598 //! \details
599 //! This field specifies the format of the surface or element within this
600 //! surface. This field is ignored for all data port messages other than the
601 //! render target message and streamed vertex buffer write message. Some
602 //! forms of the media block messages use the surface format.
603 enum SURFACE_FORMAT
604 {
605 SURFACE_FORMAT_R32G32B32A32FLOAT = 0, //!< No additional details
606 SURFACE_FORMAT_R32G32B32A32SINT = 1, //!< No additional details
607 SURFACE_FORMAT_R32G32B32A32UINT = 2, //!< No additional details
608 SURFACE_FORMAT_R32G32B32A32UNORM = 3, //!< No additional details
609 SURFACE_FORMAT_R32G32B32A32SNORM = 4, //!< No additional details
610 SURFACE_FORMAT_R64G64FLOAT = 5, //!< No additional details
611 SURFACE_FORMAT_R32G32B32X32FLOAT = 6, //!< No additional details
612 SURFACE_FORMAT_R32G32B32A32SSCALED = 7, //!< No additional details
613 SURFACE_FORMAT_R32G32B32A32USCALED = 8, //!< No additional details
614 SURFACE_FORMAT_R32G32B32A32SFIXED = 32, //!< No additional details
615 SURFACE_FORMAT_R64G64PASSTHRU = 33, //!< No additional details
616 SURFACE_FORMAT_R32G32B32FLOAT = 64, //!< No additional details
617 SURFACE_FORMAT_R32G32B32SINT = 65, //!< No additional details
618 SURFACE_FORMAT_R32G32B32UINT = 66, //!< No additional details
619 SURFACE_FORMAT_R32G32B32UNORM = 67, //!< No additional details
620 SURFACE_FORMAT_R32G32B32SNORM = 68, //!< No additional details
621 SURFACE_FORMAT_R32G32B32SSCALED = 69, //!< No additional details
622 SURFACE_FORMAT_R32G32B32USCALED = 70, //!< No additional details
623 SURFACE_FORMAT_R32G32B32SFIXED = 80, //!< No additional details
624 SURFACE_FORMAT_R16G16B16A16UNORM = 128, //!< No additional details
625 SURFACE_FORMAT_R16G16B16A16SNORM = 129, //!< No additional details
626 SURFACE_FORMAT_R16G16B16A16SINT = 130, //!< No additional details
627 SURFACE_FORMAT_R16G16B16A16UINT = 131, //!< No additional details
628 SURFACE_FORMAT_R16G16B16A16FLOAT = 132, //!< No additional details
629 SURFACE_FORMAT_R32G32FLOAT = 133, //!< No additional details
630 SURFACE_FORMAT_R32G32SINT = 134, //!< No additional details
631 SURFACE_FORMAT_R32G32UINT = 135, //!< No additional details
632 SURFACE_FORMAT_R32FLOATX8X24TYPELESS = 136, //!< No additional details
633 SURFACE_FORMAT_X32TYPELESSG8X24UINT = 137, //!< No additional details
634 SURFACE_FORMAT_L32A32FLOAT = 138, //!< No additional details
635 SURFACE_FORMAT_R32G32UNORM = 139, //!< No additional details
636 SURFACE_FORMAT_R32G32SNORM = 140, //!< No additional details
637 SURFACE_FORMAT_R64FLOAT = 141, //!< No additional details
638 SURFACE_FORMAT_R16G16B16X16UNORM = 142, //!< No additional details
639 SURFACE_FORMAT_R16G16B16X16FLOAT = 143, //!< No additional details
640 SURFACE_FORMAT_A32X32FLOAT = 144, //!< No additional details
641 SURFACE_FORMAT_L32X32FLOAT = 145, //!< No additional details
642 SURFACE_FORMAT_I32X32FLOAT = 146, //!< No additional details
643 SURFACE_FORMAT_R16G16B16A16SSCALED = 147, //!< No additional details
644 SURFACE_FORMAT_R16G16B16A16USCALED = 148, //!< No additional details
645 SURFACE_FORMAT_R32G32SSCALED = 149, //!< No additional details
646 SURFACE_FORMAT_R32G32USCALED = 150, //!< No additional details
647 SURFACE_FORMAT_R32G32SFIXED = 160, //!< No additional details
648 SURFACE_FORMAT_R64PASSTHRU = 161, //!< No additional details
649 SURFACE_FORMAT_B8G8R8A8UNORM = 192, //!< No additional details
650 SURFACE_FORMAT_B8G8R8A8UNORMSRGB = 193, //!< No additional details
651 SURFACE_FORMAT_R10G10B10A2UNORM = 194, //!< No additional details
652 SURFACE_FORMAT_R10G10B10A2UNORMSRGB = 195, //!< No additional details
653 SURFACE_FORMAT_R10G10B10A2UINT = 196, //!< No additional details
654 SURFACE_FORMAT_R10G10B10SNORMA2UNORM = 197, //!< No additional details
655 SURFACE_FORMAT_R8G8B8A8UNORM = 199, //!< No additional details
656 SURFACE_FORMAT_R8G8B8A8UNORMSRGB = 200, //!< No additional details
657 SURFACE_FORMAT_R8G8B8A8SNORM = 201, //!< No additional details
658 SURFACE_FORMAT_R8G8B8A8SINT = 202, //!< No additional details
659 SURFACE_FORMAT_R8G8B8A8UINT = 203, //!< No additional details
660 SURFACE_FORMAT_R16G16UNORM = 204, //!< No additional details
661 SURFACE_FORMAT_R16G16SNORM = 205, //!< No additional details
662 SURFACE_FORMAT_R16G16SINT = 206, //!< No additional details
663 SURFACE_FORMAT_R16G16UINT = 207, //!< No additional details
664 SURFACE_FORMAT_R16G16FLOAT = 208, //!< No additional details
665 SURFACE_FORMAT_B10G10R10A2UNORM = 209, //!< No additional details
666 SURFACE_FORMAT_B10G10R10A2UNORMSRGB = 210, //!< No additional details
667 SURFACE_FORMAT_R11G11B10FLOAT = 211, //!< No additional details
668 SURFACE_FORMAT_R10G10B10FLOATA2UNORM = 213, //!< No additional details
669 SURFACE_FORMAT_R32SINT = 214, //!< No additional details
670 SURFACE_FORMAT_R32UINT = 215, //!< No additional details
671 SURFACE_FORMAT_R32FLOAT = 216, //!< No additional details
672 SURFACE_FORMAT_R24UNORMX8TYPELESS = 217, //!< No additional details
673 SURFACE_FORMAT_X24TYPELESSG8UINT = 218, //!< No additional details
674 SURFACE_FORMAT_L32UNORM = 221, //!< No additional details
675 SURFACE_FORMAT_A32UNORM = 222, //!< No additional details
676 SURFACE_FORMAT_L16A16UNORM = 223, //!< No additional details
677 SURFACE_FORMAT_I24X8UNORM = 224, //!< No additional details
678 SURFACE_FORMAT_L24X8UNORM = 225, //!< No additional details
679 SURFACE_FORMAT_A24X8UNORM = 226, //!< No additional details
680 SURFACE_FORMAT_I32FLOAT = 227, //!< No additional details
681 SURFACE_FORMAT_L32FLOAT = 228, //!< No additional details
682 SURFACE_FORMAT_A32FLOAT = 229, //!< No additional details
683 SURFACE_FORMAT_X8B8UNORMG8R8SNORM = 230, //!< No additional details
684 SURFACE_FORMAT_A8X8UNORMG8R8SNORM = 231, //!< No additional details
685 SURFACE_FORMAT_B8X8UNORMG8R8SNORM = 232, //!< No additional details
686 SURFACE_FORMAT_B8G8R8X8UNORM = 233, //!< No additional details
687 SURFACE_FORMAT_B8G8R8X8UNORMSRGB = 234, //!< No additional details
688 SURFACE_FORMAT_R8G8B8X8UNORM = 235, //!< No additional details
689 SURFACE_FORMAT_R8G8B8X8UNORMSRGB = 236, //!< No additional details
690 SURFACE_FORMAT_R9G9B9E5SHAREDEXP = 237, //!< No additional details
691 SURFACE_FORMAT_B10G10R10X2UNORM = 238, //!< No additional details
692 SURFACE_FORMAT_L16A16FLOAT = 240, //!< No additional details
693 SURFACE_FORMAT_R32UNORM = 241, //!< No additional details
694 SURFACE_FORMAT_R32SNORM = 242, //!< No additional details
695 SURFACE_FORMAT_R10G10B10X2USCALED = 243, //!< No additional details
696 SURFACE_FORMAT_R8G8B8A8SSCALED = 244, //!< No additional details
697 SURFACE_FORMAT_R8G8B8A8USCALED = 245, //!< No additional details
698 SURFACE_FORMAT_R16G16SSCALED = 246, //!< No additional details
699 SURFACE_FORMAT_R16G16USCALED = 247, //!< No additional details
700 SURFACE_FORMAT_R32SSCALED = 248, //!< No additional details
701 SURFACE_FORMAT_R32USCALED = 249, //!< No additional details
702 SURFACE_FORMAT_B5G6R5UNORM = 256, //!< No additional details
703 SURFACE_FORMAT_B5G6R5UNORMSRGB = 257, //!< No additional details
704 SURFACE_FORMAT_B5G5R5A1UNORM = 258, //!< No additional details
705 SURFACE_FORMAT_B5G5R5A1UNORMSRGB = 259, //!< No additional details
706 SURFACE_FORMAT_B4G4R4A4UNORM = 260, //!< No additional details
707 SURFACE_FORMAT_B4G4R4A4UNORMSRGB = 261, //!< No additional details
708 SURFACE_FORMAT_R8G8UNORM = 262, //!< No additional details
709 SURFACE_FORMAT_R8G8SNORM = 263, //!< No additional details
710 SURFACE_FORMAT_R8G8SINT = 264, //!< No additional details
711 SURFACE_FORMAT_R8G8UINT = 265, //!< No additional details
712 SURFACE_FORMAT_R16UNORM = 266, //!< No additional details
713 SURFACE_FORMAT_R16SNORM = 267, //!< No additional details
714 SURFACE_FORMAT_R16SINT = 268, //!< No additional details
715 SURFACE_FORMAT_R16UINT = 269, //!< No additional details
716 SURFACE_FORMAT_R16FLOAT = 270, //!< No additional details
717 SURFACE_FORMAT_A8P8UNORMPALETTE0 = 271, //!< No additional details
718 SURFACE_FORMAT_A8P8UNORMPALETTE1 = 272, //!< No additional details
719 SURFACE_FORMAT_I16UNORM = 273, //!< No additional details
720 SURFACE_FORMAT_L16UNORM = 274, //!< No additional details
721 SURFACE_FORMAT_A16UNORM = 275, //!< No additional details
722 SURFACE_FORMAT_L8A8UNORM = 276, //!< No additional details
723 SURFACE_FORMAT_I16FLOAT = 277, //!< No additional details
724 SURFACE_FORMAT_L16FLOAT = 278, //!< No additional details
725 SURFACE_FORMAT_A16FLOAT = 279, //!< No additional details
726 SURFACE_FORMAT_L8A8UNORMSRGB = 280, //!< No additional details
727 SURFACE_FORMAT_R5G5SNORMB6UNORM = 281, //!< No additional details
728 SURFACE_FORMAT_B5G5R5X1UNORM = 282, //!< No additional details
729 SURFACE_FORMAT_B5G5R5X1UNORMSRGB = 283, //!< No additional details
730 SURFACE_FORMAT_R8G8SSCALED = 284, //!< No additional details
731 SURFACE_FORMAT_R8G8USCALED = 285, //!< No additional details
732 SURFACE_FORMAT_R16SSCALED = 286, //!< No additional details
733 SURFACE_FORMAT_R16USCALED = 287, //!< No additional details
734 SURFACE_FORMAT_P8A8UNORMPALETTE0 = 290, //!< No additional details
735 SURFACE_FORMAT_P8A8UNORMPALETTE1 = 291, //!< No additional details
736 SURFACE_FORMAT_A1B5G5R5UNORM = 292, //!< No additional details
737 SURFACE_FORMAT_A4B4G4R4UNORM = 293, //!< No additional details
738 SURFACE_FORMAT_L8A8UINT = 294, //!< No additional details
739 SURFACE_FORMAT_L8A8SINT = 295, //!< No additional details
740 SURFACE_FORMAT_R8UNORM = 320, //!< No additional details
741 SURFACE_FORMAT_R8SNORM = 321, //!< No additional details
742 SURFACE_FORMAT_R8SINT = 322, //!< No additional details
743 SURFACE_FORMAT_R8UINT = 323, //!< No additional details
744 SURFACE_FORMAT_A8UNORM = 324, //!< No additional details
745 SURFACE_FORMAT_I8UNORM = 325, //!< No additional details
746 SURFACE_FORMAT_L8UNORM = 326, //!< No additional details
747 SURFACE_FORMAT_P4A4UNORMPALETTE0 = 327, //!< No additional details
748 SURFACE_FORMAT_A4P4UNORMPALETTE0 = 328, //!< No additional details
749 SURFACE_FORMAT_R8SSCALED = 329, //!< No additional details
750 SURFACE_FORMAT_R8USCALED = 330, //!< No additional details
751 SURFACE_FORMAT_P8UNORMPALETTE0 = 331, //!< No additional details
752 SURFACE_FORMAT_L8UNORMSRGB = 332, //!< No additional details
753 SURFACE_FORMAT_P8UNORMPALETTE1 = 333, //!< No additional details
754 SURFACE_FORMAT_P4A4UNORMPALETTE1 = 334, //!< No additional details
755 SURFACE_FORMAT_A4P4UNORMPALETTE1 = 335, //!< No additional details
756 SURFACE_FORMAT_Y8UNORM = 336, //!< No additional details
757 SURFACE_FORMAT_L8UINT = 338, //!< No additional details
758 SURFACE_FORMAT_L8SINT = 339, //!< No additional details
759 SURFACE_FORMAT_I8UINT = 340, //!< No additional details
760 SURFACE_FORMAT_I8SINT = 341, //!< No additional details
761 SURFACE_FORMAT_DXT1RGBSRGB = 384, //!< No additional details
762 SURFACE_FORMAT_R1UNORM = 385, //!< SET0_LEGACY: Undefined behavior if used in any feature added for GEN11+. See Legacy sampler feature page for detalls
763 SURFACE_FORMAT_YCRCBNORMAL = 386, //!< No additional details
764 SURFACE_FORMAT_YCRCBSWAPUVY = 387, //!< No additional details
765 SURFACE_FORMAT_P2UNORMPALETTE0 = 388, //!< No additional details
766 SURFACE_FORMAT_P2UNORMPALETTE1 = 389, //!< No additional details
767 SURFACE_FORMAT_BC1UNORM = 390, //!< (DXT1)
768 SURFACE_FORMAT_BC2UNORM = 391, //!< (DXT2/3)
769 SURFACE_FORMAT_BC3UNORM = 392, //!< (DXT4/5)
770 SURFACE_FORMAT_BC4UNORM = 393, //!< No additional details
771 SURFACE_FORMAT_BC5UNORM = 394, //!< No additional details
772 SURFACE_FORMAT_BC1UNORMSRGB = 395, //!< (DXT1_SRGB)
773 SURFACE_FORMAT_BC2UNORMSRGB = 396, //!< (DXT2/3_SRGB)
774 SURFACE_FORMAT_BC3UNORMSRGB = 397, //!< (DXT4/5_SRGB)
775 SURFACE_FORMAT_MONO8 = 398, //!< SET0_LEGACY: Undefined behavior if used in any feature added for GEN11+. See Legacy sampler feature page for detalls
776 SURFACE_FORMAT_YCRCBSWAPUV = 399, //!< No additional details
777 SURFACE_FORMAT_YCRCBSWAPY = 400, //!< No additional details
778 SURFACE_FORMAT_DXT1RGB = 401, //!< No additional details
779 SURFACE_FORMAT_FXT1 = 402, //!< SET0_LEGACY: Undefined behavior if used in any feature added for GEN11+. See Legacy sampler feature page for detalls
780 SURFACE_FORMAT_R8G8B8UNORM = 403, //!< No additional details
781 SURFACE_FORMAT_R8G8B8SNORM = 404, //!< No additional details
782 SURFACE_FORMAT_R8G8B8SSCALED = 405, //!< No additional details
783 SURFACE_FORMAT_R8G8B8USCALED = 406, //!< No additional details
784 SURFACE_FORMAT_R64G64B64A64FLOAT = 407, //!< No additional details
785 SURFACE_FORMAT_R64G64B64FLOAT = 408, //!< No additional details
786 SURFACE_FORMAT_BC4SNORM = 409, //!< No additional details
787 SURFACE_FORMAT_BC5SNORM = 410, //!< No additional details
788 SURFACE_FORMAT_R16G16B16FLOAT = 411, //!< No additional details
789 SURFACE_FORMAT_R16G16B16UNORM = 412, //!< No additional details
790 SURFACE_FORMAT_R16G16B16SNORM = 413, //!< No additional details
791 SURFACE_FORMAT_R16G16B16SSCALED = 414, //!< No additional details
792 SURFACE_FORMAT_R16G16B16USCALED = 415, //!< No additional details
793 SURFACE_FORMAT_BC6HSF16 = 417, //!< No additional details
794 SURFACE_FORMAT_BC7UNORM = 418, //!< No additional details
795 SURFACE_FORMAT_BC7UNORMSRGB = 419, //!< No additional details
796 SURFACE_FORMAT_BC6HUF16 = 420, //!< No additional details
797 SURFACE_FORMAT_PLANAR4208 = 421, //!< No additional details
798 SURFACE_FORMAT_PLANAR42016 = 422, //!< No additional details
799 SURFACE_FORMAT_R8G8B8UNORMSRGB = 424, //!< No additional details
800 SURFACE_FORMAT_ETC1RGB8 = 425, //!< No additional details
801 SURFACE_FORMAT_ETC2RGB8 = 426, //!< No additional details
802 SURFACE_FORMAT_EACR11 = 427, //!< No additional details
803 SURFACE_FORMAT_EACRG11 = 428, //!< No additional details
804 SURFACE_FORMAT_EACSIGNEDR11 = 429, //!< No additional details
805 SURFACE_FORMAT_EACSIGNEDRG11 = 430, //!< No additional details
806 SURFACE_FORMAT_ETC2SRGB8 = 431, //!< No additional details
807 SURFACE_FORMAT_R16G16B16UINT = 432, //!< No additional details
808 SURFACE_FORMAT_R16G16B16SINT = 433, //!< No additional details
809 SURFACE_FORMAT_R32SFIXED = 434, //!< No additional details
810 SURFACE_FORMAT_R10G10B10A2SNORM = 435, //!< No additional details
811 SURFACE_FORMAT_R10G10B10A2USCALED = 436, //!< No additional details
812 SURFACE_FORMAT_R10G10B10A2SSCALED = 437, //!< No additional details
813 SURFACE_FORMAT_R10G10B10A2SINT = 438, //!< No additional details
814 SURFACE_FORMAT_B10G10R10A2SNORM = 439, //!< No additional details
815 SURFACE_FORMAT_B10G10R10A2USCALED = 440, //!< No additional details
816 SURFACE_FORMAT_B10G10R10A2SSCALED = 441, //!< No additional details
817 SURFACE_FORMAT_B10G10R10A2UINT = 442, //!< No additional details
818 SURFACE_FORMAT_B10G10R10A2SINT = 443, //!< No additional details
819 SURFACE_FORMAT_R64G64B64A64PASSTHRU = 444, //!< No additional details
820 SURFACE_FORMAT_R64G64B64PASSTHRU = 445, //!< No additional details
821 SURFACE_FORMAT_ETC2RGB8PTA = 448, //!< No additional details
822 SURFACE_FORMAT_ETC2SRGB8PTA = 449, //!< No additional details
823 SURFACE_FORMAT_ETC2EACRGBA8 = 450, //!< No additional details
824 SURFACE_FORMAT_ETC2EACSRGB8A8 = 451, //!< No additional details
825 SURFACE_FORMAT_R8G8B8UINT = 456, //!< No additional details
826 SURFACE_FORMAT_R8G8B8SINT = 457, //!< No additional details
827 SURFACE_FORMAT_RAW = 511, //!< No additional details
828 };
829
830 //! \brief SURFACE_TYPE
831 //! \details
832 //! This field defines the type of the surface.
833 enum SURFACE_TYPE
834 {
835 SURFACE_TYPE_SURFTYPE1D = 0, //!< Defines a 1-dimensional map or array of maps
836 SURFACE_TYPE_SURFTYPE2D = 1, //!< Defines a 2-dimensional map or array of maps
837 SURFACE_TYPE_SURFTYPE3D = 2, //!< Defines a 3-dimensional (volumetric) map
838 SURFACE_TYPE_SURFTYPECUBE = 3, //!< Defines a cube map or array of cube maps
839 SURFACE_TYPE_SURFTYPEBUFFER = 4, //!< Defines an element in a buffer
840 SURFACE_TYPE_SURFTYPESTRBUF = 5, //!< Defines a structured buffer surface
841 SURFACE_TYPE_SURFTYPENULL = 7, //!< Defines a null surface
842 };
843
844 //! \brief SAMPLE_TAP_DISCARD_DISABLE
845 //! \details
846 //! This bit forces sample tap discard filter mode to be disabled for this
847 //! surface state. This bit must be set for surfaces which are no Alpha
848 //! Channel such as R8G8B8_UNORM.
849 enum SAMPLE_TAP_DISCARD_DISABLE
850 {
851 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.
852 SAMPLE_TAP_DISCARD_DISABLE_ENABLE = 1, //!< When programmed to 1h, Sample Tap Discard filter mode will be disabled even if enabled through Sampler State
853 };
854
855 //! \brief DOUBLE_FETCH_DISABLE
856 //! \details
857 //! This bit is intended to disable the "double fetch" of adjacent
858 //! cache-lines in most all cases. Double fetch is a performance mode, but
859 //! for some surface types for formats it may be lower performance due to
860 //! fetching unused cache-lines.
861 enum DOUBLE_FETCH_DISABLE
862 {
863 DOUBLE_FETCH_DISABLE_ENABLE = 0, //!< When programmed to 0h, double fetches are allowed.
864 DOUBLE_FETCH_DISABLE_DISABLE = 1, //!< When programmed to 1h, double fetches are disabled.
865 };
866
867 //! \brief CORNER_TEXEL_MODE
868 //! \details
869 //! This field, when ENABLED, indicates when a surface is using corner
870 //! texel-mode for sampling.
871 //! Corner Texel Mode is ignored for Planar YUV/YCrCb surface
872 //! formats.
873 //! Corner Texel Mode is ignored for sample_8X8 and sample_unorm messasge
874 //! types.
875 //! <!--StartFragment-->Does not support legacy sampler features set0 See
876 //! legacy sampler page for more details<!--EndFragment-->
877 enum CORNER_TEXEL_MODE
878 {
879 CORNER_TEXEL_MODE_DISABLE = 0, //!< When programmed to 0h, Corner Texel Mode is disabled. This means texel references are shifted a half-texel from the upper-right corner of the texture map which is the standard texel referencemode.
880 CORNER_TEXEL_MODE_ENABLE = 1, //!< When programmed to 1h, Corner Texel Mode is enabled. The location of a sampled texel on a texture map is shifted a half-texel to the upper-left, meaning texel (0,0) isin the exact upper-left corner of the surface.
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_DISABLE = 0, //!< Disables Unorm path in Color Pipe.
890 ENABLE_UNORM_PATH_IN_COLOR_PIPE_ENABLE = 1, //!< Enables Unorm Path in Color Pipe.
891 };
892
893 //! \brief NULL_PROBING_ENABLE
894 //! \details
895 //! This field is applicable for Render Targets only. It is used for
896 //! enabling NULL tile probing as defined under Tiled Resources. This
897 //! probing guarantees consistent read data return after previous write
898 //! including fast clears. SW must enable this bit for render target only if
899 //! surface contains NULL tiles and read after write consistency is
900 //! required.
901 enum NULL_PROBING_ENABLE
902 {
903 NULL_PROBING_ENABLE_DISABLE = 0, //!< No additional details
904 NULL_PROBING_ENABLE_ENABLE = 1, //!< No additional details
905 };
906
907 //! \brief STANDARD_TILING_MODE_EXTENSIONS
908 //! \details
909 //! It changes in the MIP Tail Packing. When enabled (programmed to 1h),
910 //! MIP Tail packing for Volumetric and 1D are changed as defined in the
911 //! Surface Layout and Tiling section.
912 //!
913 enum STANDARD_TILING_MODE_EXTENSIONS
914 {
915 STANDARD_TILING_MODE_EXTENSIONS_DISABLE = 0, //!< When programmed to 0h, the Gen11 extensions to support Standard Tiling are disabled. Behvaior reverts to Gen10 and Gen9 Miptail packing.
916 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.
917 };
918
919 //! \brief TILE_ADDRESS_MAPPING_MODE
920 //! \details
921 //! This field is used to select between Gen9 Tile Address Mapping mode and
922 //! Gen10 for TileYs and TileYf.
923 enum TILE_ADDRESS_MAPPING_MODE
924 {
925 TILE_ADDRESS_MAPPING_MODE_GEN9 = 0, //!< Gen9 Tile Address Mapping ModeThis field should always be programmed to 0h. Gen9 Tiling mode is the standard tile layout for 3D.
926 TILE_ADDRESS_MAPPING_MODE_GEN10 = 1, //!< Gen10+ Tile Address Mapping Mode (for Standard Tiling).This field should NOT be programmed to 1h as the Gen10 Tiling Address Mapping mode is not supported by SW.
927 };
928
929 //! \brief NUMBER_OF_MULTISAMPLES
930 //! \details
931 //! This field indicates the number of multisamples on the surface.
932 enum NUMBER_OF_MULTISAMPLES
933 {
934 NUMBER_OF_MULTISAMPLES_MULTISAMPLECOUNT1 = 0, //!< No additional details
935 NUMBER_OF_MULTISAMPLES_MULTISAMPLECOUNT2 = 1, //!< No additional details
936 NUMBER_OF_MULTISAMPLES_MULTISAMPLECOUNT4 = 2, //!< No additional details
937 NUMBER_OF_MULTISAMPLES_MULTISAMPLECOUNT8 = 3, //!< No additional details
938 NUMBER_OF_MULTISAMPLES_MULTISAMPLECOUNT16 = 4, //!< No additional details
939 };
940
941 //! \brief MULTISAMPLED_SURFACE_STORAGE_FORMAT
942 //! \details
943 //! This field indicates the storage format of the multisampled surface.
944 enum MULTISAMPLED_SURFACE_STORAGE_FORMAT
945 {
946 MULTISAMPLED_SURFACE_STORAGE_FORMAT_MSS = 0, //!< Multsampled surface was/is rendered as a render target
947 MULTISAMPLED_SURFACE_STORAGE_FORMAT_DEPTHSTENCIL = 1, //!< Multisampled surface was rendered as a depth or stencil buffer
948 };
949
950 //! \brief RENDER_TARGET_AND_SAMPLE_UNORM_ROTATION
951 //! \details
952 //! For Render Target Surfaces:
953 //! This field specifies the rotation of this render target surface
954 //! when being written to memory.
955 enum RENDER_TARGET_AND_SAMPLE_UNORM_ROTATION
956 {
957 RENDER_TARGET_AND_SAMPLE_UNORM_ROTATION_0DEG = 0, //!< No rotation (0 degrees)
958 RENDER_TARGET_AND_SAMPLE_UNORM_ROTATION_90DEG = 1, //!< Rotate by 90 degrees
959 RENDER_TARGET_AND_SAMPLE_UNORM_ROTATION_180DEG = 2, //!< Rotate by 180 degrees [for sample_unorm message]
960 RENDER_TARGET_AND_SAMPLE_UNORM_ROTATION_270DEG = 3, //!< Rotate by 270 degrees
961 };
962
963 enum DECOMPRESS_IN_L3
964 {
965 DECOMPRESS_IN_L3_DISABLE = 0, //!< When this field is set to 0h, the associated compressible surface, when accessed by sampler, can be compressed in L3. If the surface is not compressible, this bit field is ignored.
966 DECOMPRESS_IN_L3_ENABLE = 1, //!< When this field is set to 1h, the associated compressible surface, when accessed by sampler, will be uncompressed in L3. If the surface is not compressible, this bit field is ignored.
967 };
968
969 //! \brief COHERENCY_TYPE
970 //! \details
971 //! Specifies the type of coherency maintained for this surface.
972 enum COHERENCY_TYPE
973 {
974 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).
975 COHERENCY_TYPE_IACOHERENT = 1, //!< Surface memory is kept coherent with CPU (LLC).
976 };
977
978 //! \brief TILED_RESOURCE_MODE
979 //! \details
980 //! For Sampling Engine, Render Target, and Typed/Untyped Surfaces:
981 //! This field specifies the tiled resource mode.
982 //!
983 //! For other surfaces:
984 //! This field is ignored.
985 enum TILED_RESOURCE_MODE
986 {
987 TILED_RESOURCE_MODE_NONE = 0, //!< No tiled resource
988 TILED_RESOURCE_MODE_4KB = 1, //!< 4KB tiled resources
989 TILED_RESOURCE_MODE_TILEYF = 1, //!< 4KB tiled resources
990 TILED_RESOURCE_MODE_64KB = 2, //!< 64KB tiled resources
991 TILED_RESOURCE_MODE_TILEYS = 2, //!< 64KB tiled resources
992 };
993
994 //! \brief EWA_DISABLE_FOR_CUBE
995 //! \details
996 //! Specifies if EWA mode for LOD quality improvement needs to be disabled
997 //! for cube maps.
998 enum EWA_DISABLE_FOR_CUBE
999 {
1000 EWA_DISABLE_FOR_CUBE_ENABLE = 0, //!< EWA is enabled for cube maps
1001 EWA_DISABLE_FOR_CUBE_DISABLE = 1, //!< EWA is disabled for cube maps
1002 };
1003
1004 //! \brief AUXILIARY_SURFACE_MODE
1005 //! \details
1006 //! Specifies what type of surface the Auxiliary surface is. The Auxiliary
1007 //! surface has its own base address and pitch, but otherwise shares or
1008 //! overrides other fields set for the primary surface, detailed in the
1009 //! programming notes below.
1010 enum AUXILIARY_SURFACE_MODE
1011 {
1012 AUXILIARY_SURFACE_MODE_AUXNONE = 0, //!< No Auxiliary surface is used
1013 AUXILIARY_SURFACE_MODE_AUXCCSD = 1, //!< The Auxiliary surface is a CCS (Color Control Surface) with color compression disabled. The Auxiliary surface is a MCS (Multisample Control Surface) with MSAA compression disabled. MCS is tiled y
1014 AUXILIARY_SURFACE_MODE_AUXAPPEND = 2, //!< The Auxiliary surface is an append buffer
1015 AUXILIARY_SURFACE_MODE_AUXMCSLCE = 4, //!< Enables lossless compresion on the top of MSAA compression for RTs with Number of Multisamples not equal to MULTISAMPLECOUNT_1.CCS is tiling format is linear.MCS tiling format is always tiledY.
1016 AUXILIARY_SURFACE_MODE_AUXCCSE = 5, //!< If Number of multisamples = 1, programming this value means lossless compression is enabled for that surface.Auxiliary surface is a CCS with linear tiling. If Number of multisamples > 1, programming this value means MSAA compression is enabled for that surface. Auxillary surafce is MSC with tile y.
1017 };
1018
1019 //! \brief YUV_INTERPOLATION_ENABLE
1020 //! \details
1021 //! This bit controls whether a Non-Planar YUV4:2:2 and Planar YUV4:2:0
1022 //! surface use interpolated or replicated U and V channels for input to the
1023 //! Sampler filter. Programming to 1h causes interpolation of U and V
1024 //! channels. In this case the chrominance for odd pixels is computed by an
1025 //! interpolation between adjacent even pixels. Programming to 0h causes the
1026 //! chrominance to be copied from the pixel to the left.
1027 enum YUV_INTERPOLATION_ENABLE
1028 {
1029 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).
1030 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.
1031 };
1032
1033 //! \brief HALF_PITCH_FOR_CHROMA
1034 //! \details
1035 //! style="font-family: &quot;Arial&quot;,&quot;sans-serif&quot;;
1036 //! font-size: 10pt; mso-fareast-font-family: &quot;Times New Roman&quot;;
1037 //! mso-ansi-language: EN-US; mso-fareast-language: EN-US;
1038 //! mso-bidi-language: AR-SA;"><font color="#000000">This bit enables
1039 //! support for half-pitch chroma planes for Planar YUV surfaces. It is
1040 //! ignored for Non-Planar surfaces. For planar surfaces it allows the
1041 //! chroma planes to be one-half the width of a the Y (Luma)
1042 //! plane.</font>
1043 //! style="font-family: &quot;Arial&quot;,&quot;sans-serif&quot;;
1044 //! font-size: 10pt; mso-fareast-font-family: &quot;Times New Roman&quot;;
1045 //! mso-ansi-language: EN-US; mso-fareast-language: EN-US;
1046 //! mso-bidi-language: AR-SA;"><font color="#000000">For example, should be
1047 //! set to 0h for NV12 surfaces.</font>
1048 //! style="font-family: &quot;Arial&quot;,&quot;sans-serif&quot;;
1049 //! font-size: 10pt; mso-fareast-font-family: &quot;Times New Roman&quot;;
1050 //! mso-ansi-language: EN-US; mso-fareast-language: EN-US;
1051 //! mso-bidi-language: AR-SA;"><font color="#000000">Must be set to 1h for
1052 //! YV12 surfaces.</font>
1053 enum HALF_PITCH_FOR_CHROMA
1054 {
1055 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>
1056 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>
1057 };
1058
1059 //! \brief SHADER_CHANNEL_SELECT_ALPHA
1060 //! \details
1061 //! See Shader Channel Select Red for details.
1062 enum SHADER_CHANNEL_SELECT_ALPHA
1063 {
1064 SHADER_CHANNEL_SELECT_ALPHA_ZERO = 0, //!< No additional details
1065 SHADER_CHANNEL_SELECT_ALPHA_ONE = 1, //!< No additional details
1066 SHADER_CHANNEL_SELECT_ALPHA_RED = 4, //!< Shader channel is set to surface red channel
1067 SHADER_CHANNEL_SELECT_ALPHA_GREEN = 5, //!< Shader channel is set to surface green channel
1068 SHADER_CHANNEL_SELECT_ALPHA_BLUE = 6, //!< Shader channel is set to surface blue channel
1069 SHADER_CHANNEL_SELECT_ALPHA_ALPHA = 7, //!< Shader channel is set to surface alpha channel
1070 };
1071
1072 //! \brief SHADER_CHANNEL_SELECT_BLUE
1073 //! \details
1074 //! See Shader Channel Select Red for details.
1075 enum SHADER_CHANNEL_SELECT_BLUE
1076 {
1077 SHADER_CHANNEL_SELECT_BLUE_ZERO = 0, //!< No additional details
1078 SHADER_CHANNEL_SELECT_BLUE_ONE = 1, //!< No additional details
1079 SHADER_CHANNEL_SELECT_BLUE_RED = 4, //!< Shader channel is set to surface red channel
1080 SHADER_CHANNEL_SELECT_BLUE_GREEN = 5, //!< Shader channel is set to surface green channel
1081 SHADER_CHANNEL_SELECT_BLUE_BLUE = 6, //!< Shader channel is set to surface blue channel
1082 SHADER_CHANNEL_SELECT_BLUE_ALPHA = 7, //!< Shader channel is set to surface alpha channel
1083 };
1084
1085 //! \brief SHADER_CHANNEL_SELECT_GREEN
1086 //! \details
1087 //! See Shader Channel Select Red for details.
1088 enum SHADER_CHANNEL_SELECT_GREEN
1089 {
1090 SHADER_CHANNEL_SELECT_GREEN_ZERO = 0, //!< No additional details
1091 SHADER_CHANNEL_SELECT_GREEN_ONE = 1, //!< No additional details
1092 SHADER_CHANNEL_SELECT_GREEN_RED = 4, //!< Shader channel is set to surface red channel
1093 SHADER_CHANNEL_SELECT_GREEN_GREEN = 5, //!< Shader channel is set to surface green channel
1094 SHADER_CHANNEL_SELECT_GREEN_BLUE = 6, //!< Shader channel is set to surface blue channel
1095 SHADER_CHANNEL_SELECT_GREEN_ALPHA = 7, //!< Shader channel is set to surface alpha channel
1096 };
1097
1098 //! \brief SHADER_CHANNEL_SELECT_RED
1099 //! \details
1100 //! Specifies which surface channel is read or written in the Red shader
1101 //! channel.
1102 enum SHADER_CHANNEL_SELECT_RED
1103 {
1104 SHADER_CHANNEL_SELECT_RED_ZERO = 0, //!< No additional details
1105 SHADER_CHANNEL_SELECT_RED_ONE = 1, //!< No additional details
1106 SHADER_CHANNEL_SELECT_RED_RED = 4, //!< Shader channel is set to surface red channel
1107 SHADER_CHANNEL_SELECT_RED_GREEN = 5, //!< Shader channel is set to surface green channel
1108 SHADER_CHANNEL_SELECT_RED_BLUE = 6, //!< Shader channel is set to surface blue channel
1109 SHADER_CHANNEL_SELECT_RED_ALPHA = 7, //!< Shader channel is set to surface alpha channel
1110 };
1111
1112 //! \brief MEMORY_COMPRESSION_MODE
1113 //! \details
1114 //! MBZ: Only Horizontal mode is supported.
1115 enum MEMORY_COMPRESSION_MODE
1116 {
1117 MEMORY_COMPRESSION_MODE_HORIZONTAL = 0, //!< No additional details
1118 };
1119
1120 //! \brief CLEAR_VALUE_ADDRESS_ENABLE
1121 //! \details
1122 //! This field enables HW Managed Clear Value Layout for the Surface State.
1123 //! If this bit is enabled, Clear Value Address is present instead of
1124 //! explicit clear values.
1125 enum CLEAR_VALUE_ADDRESS_ENABLE
1126 {
1127 CLEAR_VALUE_ADDRESS_ENABLE_DISABLE = 0, //!< Clear values are present in the surface state explicitly.
1128 CLEAR_VALUE_ADDRESS_ENABLE_ENABLE = 1, //!< Clear value Address is present instead of explicit clear values.
1129 };
1130
1131 //! \name Initializations
1132
1133 //! \brief Explicit member initialization function
1134 RENDER_SURFACE_STATE_CMD();
1135
1136 static const size_t dwSize = 16;
1137 static const size_t byteSize = 64;
1138 };
1139
1140 //!
1141 //! \brief MEDIA_SURFACE_STATE
1142 //! \details
1143 //! This is the SURFACE_STATE used by only deinterlace, sample_8x8, and VME
1144 //! messages.
1145 //!
1146 struct MEDIA_SURFACE_STATE_CMD
1147 {
1148 union
1149 {
1150 struct
1151 {
1152 uint32_t Reserved0 : __CODEGEN_BITFIELD( 0, 15) ; //!< Reserved
1153 uint32_t YOffset : __CODEGEN_BITFIELD(16, 19) ; //!< Y Offset
1154 uint32_t XOffset : __CODEGEN_BITFIELD(20, 26) ; //!< X Offset
1155 uint32_t Reserved27 : __CODEGEN_BITFIELD(27, 29) ; //!< Reserved
1156 uint32_t Rotation : __CODEGEN_BITFIELD(30, 31) ; //!< ROTATION
1157 };
1158 uint32_t Value;
1159 } DW0;
1160 union
1161 {
1162 struct
1163 {
1164 uint32_t CrVCbUPixelOffsetVDirection : __CODEGEN_BITFIELD( 0, 1) ; //!< CRVCBU_PIXEL_OFFSET_V_DIRECTION
1165 uint32_t PictureStructure : __CODEGEN_BITFIELD( 2, 3) ; //!< PICTURE_STRUCTURE
1166 uint32_t Width : __CODEGEN_BITFIELD( 4, 17) ; //!< Width
1167 uint32_t Height : __CODEGEN_BITFIELD(18, 31) ; //!< Height
1168 };
1169 uint32_t Value;
1170 } DW1;
1171 union
1172 {
1173 struct
1174 {
1175 uint32_t TileMode : __CODEGEN_BITFIELD( 0, 1) ; //!< TILE_MODE
1176 uint32_t HalfPitchForChroma : __CODEGEN_BITFIELD( 2, 2) ; //!< Half Pitch for Chroma
1177 uint32_t SurfacePitch : __CODEGEN_BITFIELD( 3, 20) ; //!< Surface Pitch
1178 uint32_t AddressControl : __CODEGEN_BITFIELD(21, 21) ; //!< ADDRESS_CONTROL
1179 uint32_t MemoryCompressionEnable : __CODEGEN_BITFIELD(22, 22) ; //!< Memory Compression Enable
1180 uint32_t MemoryCompressionType : __CODEGEN_BITFIELD(23, 23) ; //!< MEMORY_COMPRESSION_TYPE
1181 uint32_t CrVCbUPixelOffsetVDirectionMsb : __CODEGEN_BITFIELD(24, 24) ; //!< CRVCBU_PIXEL_OFFSET_V_DIRECTION_MSB
1182 uint32_t CrVCbUPixelOffsetUDirection : __CODEGEN_BITFIELD(25, 25) ; //!< CRVCBU_PIXEL_OFFSET_U_DIRECTION
1183 uint32_t InterleaveChroma : __CODEGEN_BITFIELD(26, 26) ; //!< Interleave Chroma
1184 uint32_t SurfaceFormat : __CODEGEN_BITFIELD(27, 31) ; //!< SURFACE_FORMAT
1185 };
1186 uint32_t Value;
1187 } DW2;
1188 union
1189 {
1190 struct
1191 {
1192 uint32_t YOffsetForUCb : __CODEGEN_BITFIELD( 0, 13) ; //!< Y Offset for U(Cb)
1193 uint32_t Reserved110 : __CODEGEN_BITFIELD(14, 15) ; //!< Reserved
1194 uint32_t XOffsetForUCb : __CODEGEN_BITFIELD(16, 29) ; //!< X Offset for U(Cb)
1195 uint32_t Reserved126 : __CODEGEN_BITFIELD(30, 31) ; //!< Reserved
1196 };
1197 uint32_t Value;
1198 } DW3;
1199 union
1200 {
1201 struct
1202 {
1203 uint32_t YOffsetForVCr : __CODEGEN_BITFIELD( 0, 14) ; //!< Y Offset for V(Cr)
1204 uint32_t Reserved143 : __CODEGEN_BITFIELD(15, 15) ; //!< Reserved
1205 uint32_t XOffsetForVCr : __CODEGEN_BITFIELD(16, 29) ; //!< X Offset for V(Cr)
1206 uint32_t Reserved158 : __CODEGEN_BITFIELD(30, 31) ; //!< Reserved
1207 };
1208 uint32_t Value;
1209 } DW4;
1210 union
1211 {
1212 struct
1213 {
1214 uint32_t SurfaceMemoryObjectControlState : __CODEGEN_BITFIELD( 0, 6) ; //!< SURFACE_MEMORY_OBJECT_CONTROL_STATE
1215 uint32_t Reserved167 : __CODEGEN_BITFIELD( 7, 17) ; //!< Reserved
1216 uint32_t TiledResourceMode : __CODEGEN_BITFIELD(18, 19) ; //!< TILED_RESOURCE_MODE
1217 uint32_t Reserved180 : __CODEGEN_BITFIELD(20, 29) ; //!< Reserved
1218 uint32_t VerticalLineStrideOffset : __CODEGEN_BITFIELD(30, 30) ; //!< Vertical Line Stride Offset
1219 uint32_t VerticalLineStride : __CODEGEN_BITFIELD(31, 31) ; //!< Vertical Line Stride
1220 };
1221 uint32_t Value;
1222 } DW5;
1223 union
1224 {
1225 struct
1226 {
1227 uint32_t SurfaceBaseAddress ; //!< Surface Base Address
1228 };
1229 uint32_t Value;
1230 } DW6;
1231 union
1232 {
1233 struct
1234 {
1235 uint32_t SurfaceBaseAddressHigh : __CODEGEN_BITFIELD( 0, 15) ; //!< Surface Base Address High
1236 uint32_t Reserved240 : __CODEGEN_BITFIELD(16, 31) ; //!< Reserved
1237 };
1238 uint32_t Value;
1239 } DW7;
1240
1241 //! \name Local enumerations
1242
1243 //! \brief ROTATION
1244 //! \details
1245 //! Rotation is only supported only with AVS function messages and not with
1246 //! HDC direct write and 16x8 AVS messages.
1247 enum ROTATION
1248 {
1249 ROTATION_NOROTATIONOR0DEGREE = 0, //!< No additional details
1250 ROTATION_90DEGREEROTATION = 1, //!< No additional details
1251 ROTATION_180DEGREEROTATION = 2, //!< No additional details
1252 ROTATION_270DEGREEROTATION = 3, //!< No additional details
1253 };
1254
1255 //! \brief CRVCBU_PIXEL_OFFSET_V_DIRECTION
1256 //! \details
1257 //! Specifies the distance to the U/V values with respect to the even
1258 //! numbered Y channels in the V direction
1259 enum CRVCBU_PIXEL_OFFSET_V_DIRECTION
1260 {
1261 CRVCBU_PIXEL_OFFSET_V_DIRECTION_UNNAMED0 = 0, //!< No additional details
1262 };
1263
1264 //! \brief PICTURE_STRUCTURE
1265 //! \details
1266 //! Specifies the encoding of the current picture.
1267 enum PICTURE_STRUCTURE
1268 {
1269 PICTURE_STRUCTURE_FRAMEPICTURE = 0, //!< No additional details
1270 PICTURE_STRUCTURE_TOPFIELDPICTURE = 1, //!< No additional details
1271 PICTURE_STRUCTURE_BOTTOMFIELDPICTURE = 2, //!< No additional details
1272 PICTURE_STRUCTURE_INVALID_NOTALLOWED = 3, //!< No additional details
1273 };
1274
1275 //! \brief TILE_MODE
1276 //! \details
1277 //! This field specifies the type of memory tiling (Linear, WMajor, XMajor,
1278 //! or YMajor) employed to tile this surface. See Memory Interface Functions
1279 //! for details on memory tiling and restrictions.
1280 enum TILE_MODE
1281 {
1282 TILE_MODE_TILEMODELINEAR = 0, //!< Linear mode (no tiling)
1283 TILE_MODE_TILEMODEXMAJOR = 2, //!< X major tiling
1284 TILE_MODE_TILEMODEYMAJOR = 3, //!< Y major tiling
1285 };
1286
1287 enum ADDRESS_CONTROL
1288 {
1289 ADDRESS_CONTROL_CLAMP = 0, //!< Clamp
1290 ADDRESS_CONTROL_MIRROR = 1, //!< Mirror
1291 };
1292
1293 //! \brief MEMORY_COMPRESSION_TYPE
1294 //! \details
1295 //! Specifies the type of memory compression used.
1296 enum MEMORY_COMPRESSION_TYPE
1297 {
1298 MEMORY_COMPRESSION_TYPE_MEDIACOMPRESSION = 0, //!< No additional details
1299 MEMORY_COMPRESSION_TYPE_RENDERCOMPRESSION = 1, //!< No additional details
1300 };
1301
1302 //! \brief CRVCBU_PIXEL_OFFSET_V_DIRECTION_MSB
1303 //! \details
1304 //! Specifies the distance to the U/V values with respect to the even
1305 //! numbered Y channels in the V direction
1306 enum CRVCBU_PIXEL_OFFSET_V_DIRECTION_MSB
1307 {
1308 CRVCBU_PIXEL_OFFSET_V_DIRECTION_MSB_UNNAMED0 = 0, //!< No additional details
1309 };
1310
1311 //! \brief CRVCBU_PIXEL_OFFSET_U_DIRECTION
1312 //! \details
1313 //! Specifies the distance to the U/V values with respect to the even
1314 //! numbered Y channels in the U direction
1315 enum CRVCBU_PIXEL_OFFSET_U_DIRECTION
1316 {
1317 CRVCBU_PIXEL_OFFSET_U_DIRECTION_UNNAMED0 = 0, //!< No additional details
1318 };
1319
1320 //! \brief SURFACE_FORMAT
1321 //! \details
1322 //! Specifies the format of the surface. All of the Y and G channels will
1323 //! use table 0 and all of the Cr/Cb/R/B channels will use table 1.
1324 enum SURFACE_FORMAT
1325 {
1326 SURFACE_FORMAT_YCRCBNORMAL = 0, //!< No additional details
1327 SURFACE_FORMAT_YCRCBSWAPUVY = 1, //!< No additional details
1328 SURFACE_FORMAT_YCRCBSWAPUV = 2, //!< No additional details
1329 SURFACE_FORMAT_YCRCBSWAPY = 3, //!< No additional details
1330 SURFACE_FORMAT_PLANAR4208 = 4, //!< No additional details
1331 SURFACE_FORMAT_R10G10B10A2UNORM = 8, //!< Sample_8x8 only
1332 SURFACE_FORMAT_R8G8B8A8UNORM = 9, //!< Sample_8x8 AVS only
1333 SURFACE_FORMAT_R8B8UNORM_CRCB = 10, //!< Sample_8x8 AVS only
1334 SURFACE_FORMAT_R8UNORM_CRCB = 11, //!< Sample_8x8 AVS only
1335 SURFACE_FORMAT_Y8UNORM = 12, //!< Sample_8x8 AVS only
1336 SURFACE_FORMAT_A8Y8U8V8UNORM = 13, //!< Sample_8x8 AVS only
1337 SURFACE_FORMAT_B8G8R8A8UNORM = 14, //!< Sample_8x8 AVS only
1338 SURFACE_FORMAT_R16G16B16A16 = 15, //!< Sample_8x8 AVS only
1339 SURFACE_FORMAT_PLANAR4228 = 18, //!< Sample_8x8 AVS only
1340 SURFACE_FORMAT_PLANAR42016 = 23, //!< Sample_8x8 AVS only
1341 SURFACE_FORMAT_R16B16UNORM_CRCB = 24, //!< Sample_8x8 AVS only
1342 SURFACE_FORMAT_R16UNORM_CRCB = 25, //!< Sample_8x8 AVS only
1343 SURFACE_FORMAT_Y16UNORM = 26, //!< Sample_8x8 AVS only
1344 };
1345
1346 //! \brief SURFACE_MEMORY_OBJECT_CONTROL_STATE
1347 //! \details
1348 //! This 7-bit field is used in various state commands and indirect state
1349 //! objects to define cacheability and other attributes related to memory
1350 //! objects.
1351 enum SURFACE_MEMORY_OBJECT_CONTROL_STATE
1352 {
1353 SURFACE_MEMORY_OBJECT_CONTROL_STATE_DEFAULTVAUEDESC = 0, //!< No additional details
1354 };
1355
1356 //! \brief TILED_RESOURCE_MODE
1357 //! \details
1358 //! For Sampling Engine, Render Target, and Typed/Untyped Surfaces:
1359 //! This field specifies the tiled resource mode.
1360 //! For other surfaces:
1361 //! This field is ignored.
1362 enum TILED_RESOURCE_MODE
1363 {
1364 TILED_RESOURCE_MODE_TRMODENONE = 0, //!< No tiled resource
1365 TILED_RESOURCE_MODE_TRMODETILEYF = 1, //!< 4KB tiled resources
1366 TILED_RESOURCE_MODE_TRMODETILEYS = 2, //!< 64KB tiled resources
1367 };
1368
1369 //! \name Initializations
1370
1371 //! \brief Explicit member initialization function
1372 MEDIA_SURFACE_STATE_CMD();
1373
1374 static const size_t dwSize = 8;
1375 static const size_t byteSize = 32;
1376 };
1377
1378 //!
1379 //! \brief SAMPLER_STATE
1380 //! \details
1381 //! This is the normal sampler state used by all messages that use
1382 //! SAMPLER_STATE except sample_8x8 and deinterlace. The sampler state is
1383 //! stored as an array of up to 16 elements, each of which contains the
1384 //! dwords described here. The start of each element is spaced 4 dwords
1385 //! apart. The first element of the sampler state array is aligned to a
1386 //! 32-byte boundary.
1387 //!
1388 struct SAMPLER_STATE_CMD
1389 {
1390 union
1391 {
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 struct
1410 {
1411 uint32_t CubeSurfaceControlMode : __CODEGEN_BITFIELD( 0, 0) ; //!< CUBE_SURFACE_CONTROL_MODE
1412 uint32_t ShadowFunction : __CODEGEN_BITFIELD( 1, 3) ; //!< SHADOW_FUNCTION
1413 uint32_t ChromakeyMode : __CODEGEN_BITFIELD( 4, 4) ; //!< CHROMAKEY_MODE
1414 uint32_t ChromakeyIndex : __CODEGEN_BITFIELD( 5, 6) ; //!< ChromaKey Index
1415 uint32_t ChromakeyEnable : __CODEGEN_BITFIELD( 7, 7) ; //!< ChromaKey Enable
1416 uint32_t MaxLod : __CODEGEN_BITFIELD( 8, 19) ; //!< Max LOD
1417 uint32_t MinLod : __CODEGEN_BITFIELD(20, 31) ; //!< Min LOD
1418 };
1419 uint32_t Value;
1420 } DW1;
1421 union
1422 {
1423 struct
1424 {
1425 uint32_t LodClampMagnificationMode : __CODEGEN_BITFIELD( 0, 0) ; //!< LOD_CLAMP_MAGNIFICATION_MODE
1426 uint32_t SrgbDecode : __CODEGEN_BITFIELD( 1, 1) ; //!< SRGB_DECODE
1427 uint32_t ReturnFilterWeightForNullTexels : __CODEGEN_BITFIELD( 2, 2) ; //!< RETURN_FILTER_WEIGHT_FOR_NULL_TEXELS
1428 uint32_t ReturnFilterWeightForBorderTexels : __CODEGEN_BITFIELD( 3, 3) ; //!< RETURN_FILTER_WEIGHT_FOR_BORDER_TEXELS
1429 uint32_t Reserved68 : __CODEGEN_BITFIELD( 4, 5) ; //!< Reserved
1430 uint32_t IndirectStatePointer : __CODEGEN_BITFIELD( 6, 23) ; //!< Indirect State Pointer
1431 uint32_t Reserved88 : __CODEGEN_BITFIELD(24, 31) ; //!< Reserved
1432 };
1433 uint32_t Value;
1434 } DW2;
1435 union
1436 {
1437 struct
1438 {
1439 uint32_t TczAddressControlMode : __CODEGEN_BITFIELD( 0, 2) ; //!< TCZ_ADDRESS_CONTROL_MODE
1440 uint32_t TcyAddressControlMode : __CODEGEN_BITFIELD( 3, 5) ; //!< TCY_ADDRESS_CONTROL_MODE
1441 uint32_t TcxAddressControlMode : __CODEGEN_BITFIELD( 6, 8) ; //!< TCX_ADDRESS_CONTROL_MODE
1442 uint32_t ReductionTypeEnable : __CODEGEN_BITFIELD( 9, 9) ; //!< Reduction Type Enable
1443 uint32_t NonNormalizedCoordinateEnable : __CODEGEN_BITFIELD(10, 10) ; //!< Non-normalized Coordinate Enable
1444 uint32_t TrilinearFilterQuality : __CODEGEN_BITFIELD(11, 12) ; //!< TRILINEAR_FILTER_QUALITY
1445 uint32_t RAddressMinFilterRoundingEnable : __CODEGEN_BITFIELD(13, 13) ; //!< R Address Min Filter Rounding Enable
1446 uint32_t RAddressMagFilterRoundingEnable : __CODEGEN_BITFIELD(14, 14) ; //!< R Address Mag Filter Rounding Enable
1447 uint32_t VAddressMinFilterRoundingEnable : __CODEGEN_BITFIELD(15, 15) ; //!< V Address Min Filter Rounding Enable
1448 uint32_t VAddressMagFilterRoundingEnable : __CODEGEN_BITFIELD(16, 16) ; //!< V Address Mag Filter Rounding Enable
1449 uint32_t UAddressMinFilterRoundingEnable : __CODEGEN_BITFIELD(17, 17) ; //!< U Address Min Filter Rounding Enable
1450 uint32_t UAddressMagFilterRoundingEnable : __CODEGEN_BITFIELD(18, 18) ; //!< U Address Mag Filter Rounding Enable
1451 uint32_t MaximumAnisotropy : __CODEGEN_BITFIELD(19, 21) ; //!< MAXIMUM_ANISOTROPY
1452 uint32_t ReductionType : __CODEGEN_BITFIELD(22, 23) ; //!< REDUCTION_TYPE
1453 uint32_t AllowLowQualityLodCalculation : __CODEGEN_BITFIELD(24, 24) ; //!< Allow low quality LOD calculation
1454 uint32_t Reserved121 : __CODEGEN_BITFIELD(25, 31) ; //!< Reserved
1455 };
1456 uint32_t Value;
1457 } DW3;
1458
1459 //! \name Local enumerations
1460
1461 //! \brief LOD_ALGORITHM
1462 //! \details
1463 //! Controls which algorithm is used for LOD calculation. Generally, the EWA
1464 //! approximation algorithm results in higher image quality than the legacy
1465 //! algorithm.
1466 enum LOD_ALGORITHM
1467 {
1468 LOD_ALGORITHM_LEGACY = 0, //!< Use the legacy algorithm for non-anisotropic filtering
1469 LOD_ALGORITHM_EWAAPPROXIMATION = 1, //!< Use the new EWA approximation algorithm for anisotropic filtering
1470 };
1471
1472 //! \brief MIN_MODE_FILTER
1473 //! \details
1474 //! This field determines how texels are sampled/filtered when a texture is
1475 //! being "minified" (shrunk). For volume maps, this filter mode selection
1476 //! also applies to the 3rd (inter-layer) dimension.See Mag Mode Filter
1477 enum MIN_MODE_FILTER
1478 {
1479 MIN_MODE_FILTER_NEAREST = 0, //!< Sample the nearest texel
1480 MIN_MODE_FILTER_LINEAR = 1, //!< Bilinearly filter the 4 nearest texels
1481 MIN_MODE_FILTER_ANISOTROPIC = 2, //!< Perform an "anisotropic" filter on the chosen mip level
1482 };
1483
1484 //! \brief MAG_MODE_FILTER
1485 //! \details
1486 //! This field determines how texels are sampled/filtered when a texture is
1487 //! being "magnified" (enlarged). For volume maps, this filter mode
1488 //! selection also applies to the 3rd (inter-layer) dimension.
1489 enum MAG_MODE_FILTER
1490 {
1491 MAG_MODE_FILTER_NEAREST = 0, //!< Sample the nearest texel
1492 MAG_MODE_FILTER_LINEAR = 1, //!< Bilinearly filter the 4 nearest texels
1493 MAG_MODE_FILTER_ANISOTROPIC = 2, //!< Perform an "anisotropic" filter on the chosen mip level
1494 };
1495
1496 //! \brief MIP_MODE_FILTER
1497 //! \details
1498 //! This field determines if and how mip map levels are chosen and/or
1499 //! combined when texture filtering.
1500 enum MIP_MODE_FILTER
1501 {
1502 MIP_MODE_FILTER_NONE = 0, //!< Disable mip mapping - force use of the mipmap level corresponding to Min LOD.
1503 MIP_MODE_FILTER_NEAREST = 1, //!< Nearest, Select the nearest mip map
1504 MIP_MODE_FILTER_LINEAR = 3, //!< Linearly interpolate between nearest mip maps (combined with linear min/mag filters this is analogous to "Trilinear" filtering).
1505 };
1506
1507 //! \brief COARSE_LOD_QUALITY_MODE
1508 //! \details
1509 //! This field configures the coarse LOD image quality mode for the
1510 //! sample_d, sample_l, and sample_b messages in the sampling engine. In
1511 //! general, performance will increase and power consumption will decrease
1512 //! with each step of reduced quality (performance gain for sample_l and
1513 //! sample_b will be minimal).
1514 enum COARSE_LOD_QUALITY_MODE
1515 {
1516 COARSE_LOD_QUALITY_MODE_DISABLED = 0, //!< Full quality is enabled, matching prior products
1517 };
1518
1519 //! \brief LOD_PRECLAMP_MODE
1520 //! \details
1521 //! This field determines whether the computed LOD is clamped to
1522 //! [max,min] mip level
1523 //! before the mag-vs-min determination is performed.
1524 enum LOD_PRECLAMP_MODE
1525 {
1526 LOD_PRECLAMP_MODE_NONE = 0, //!< LOD PreClamp disabled
1527 LOD_PRECLAMP_MODE_OGL = 2, //!< LOD PreClamp enabled (OGL mode)
1528 };
1529
1530 //! \brief TEXTURE_BORDER_COLOR_MODE
1531 //! \details
1532 //! For some surface formats, the 32 bit border color is decoded differently
1533 //! based on the border color mode. In addition, the default value of
1534 //! channels not included in the surface may be affected by this field.
1535 //! Refer to the "Sampler Output Channel Mapping" table for the values of
1536 //! these channels, and for surface formats that may only support one of
1537 //! these modes. Also refer to the definition of SAMPLER_BORDER_COLOR_STATE
1538 //! for more details on the behavior of the two modes defined by this field.
1539 enum TEXTURE_BORDER_COLOR_MODE
1540 {
1541 TEXTURE_BORDER_COLOR_MODE_OGL = 0, //!< New mode for interpreting the border color
1542 TEXTURE_BORDER_COLOR_MODE_8BIT = 1, //!< Earlier mode for interpreting the border color
1543 };
1544
1545 //! \brief CUBE_SURFACE_CONTROL_MODE
1546 //! \details
1547 //! When sampling from a SURFTYPE_CUBE surface, this field controls whether
1548 //! the TC* Address Control Mode fields are interpreted as programmed or
1549 //! overridden to TEXCOORDMODE_CUBE.
1550 enum CUBE_SURFACE_CONTROL_MODE
1551 {
1552 CUBE_SURFACE_CONTROL_MODE_PROGRAMMED = 0, //!< No additional details
1553 CUBE_SURFACE_CONTROL_MODE_OVERRIDE = 1, //!< No additional details
1554 };
1555
1556 //! \brief SHADOW_FUNCTION
1557 //! \details
1558 //! This field is used for shadow mapping support via the sample_c message
1559 //! type, and specifies the specific comparison operation to be used. The
1560 //! comparison is between the texture sample red channel (except for
1561 //! alpha-only formats which use the alpha channel), and the "ref" value
1562 //! provided in the input message.
1563 enum SHADOW_FUNCTION
1564 {
1565 SHADOW_FUNCTION_PREFILTEROPALWAYS = 0, //!< No additional details
1566 SHADOW_FUNCTION_PREFILTEROPNEVER = 1, //!< No additional details
1567 SHADOW_FUNCTION_PREFILTEROPLESS = 2, //!< No additional details
1568 SHADOW_FUNCTION_PREFILTEROPEQUAL = 3, //!< No additional details
1569 SHADOW_FUNCTION_PREFILTEROPLEQUAL = 4, //!< No additional details
1570 SHADOW_FUNCTION_PREFILTEROPGREATER = 5, //!< No additional details
1571 SHADOW_FUNCTION_PREFILTEROPNOTEQUAL = 6, //!< No additional details
1572 SHADOW_FUNCTION_PREFILTEROPGEQUAL = 7, //!< No additional details
1573 };
1574
1575 //! \brief CHROMAKEY_MODE
1576 //! \details
1577 //! This field specifies the behavior of the device in the event of a
1578 //! ChromaKey match. This field is ignored if ChromaKey is disabled.
1579 enum CHROMAKEY_MODE
1580 {
1581 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.
1582 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.
1583 };
1584
1585 //! \brief LOD_CLAMP_MAGNIFICATION_MODE
1586 //! \details
1587 //! This field allows the flexibility to control how LOD clamping is handled
1588 //! when in magnification mode.
1589 enum LOD_CLAMP_MAGNIFICATION_MODE
1590 {
1591 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.
1592 LOD_CLAMP_MAGNIFICATION_MODE_MIPFILTER = 1, //!< When in magnification mode, Sampler will clamp LOD based on the value of Mip Mode Filter.
1593 };
1594
1595 //! \brief SRGB_DECODE
1596 //! \details
1597 //! This bit controls whether the 3D sampler will decode an sRGB
1598 //! formatted surface into RGB prior to any filtering operation.
1599 //! When set, it does not convert to linear RGB (via a reverse gamma
1600 //! conversion). This bit is ignored for ASTC formats, which are always
1601 //! converted to linear RGB prior to filtering.
1602 enum SRGB_DECODE
1603 {
1604 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.
1605 SRGB_DECODE_SKIPDECODEEXT = 1, //!< When set to 1h, the 3D sampler will not convert texels to linear RGB before filtering and returning results.
1606 };
1607
1608 //! \brief RETURN_FILTER_WEIGHT_FOR_NULL_TEXELS
1609 //! \details
1610 //! This bit, when set, causes samples to return filter_weight of all
1611 //! non-NULL texels in the Alpha channel; Red, Green, and Blue channels are
1612 //! contain the filter result with NULL texels excluded; A non-NULL texel is
1613 //! a texel which does not reference a Null Tile.
1614 //! For cases where Tiled_Resource_Mode is TR_NONE, the result will
1615 //! always be 1.0 since no texels would be NULL.
1616 //! For cases where the surface format contains an Alpha channel, the
1617 //! result returned will be overridden to return the filter weight.
1618 //! For cases where the surface format does not contain Alpha, the result
1619 //! will still be returned in the Alpha Channel.
1620 enum RETURN_FILTER_WEIGHT_FOR_NULL_TEXELS
1621 {
1622 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.
1623 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.
1624 };
1625
1626 //! \brief RETURN_FILTER_WEIGHT_FOR_BORDER_TEXELS
1627 //! \details
1628 //! This bit, when set, returns the filter_weight in the Alpha channel of
1629 //! all non-border texels. Red, Green, and Blue channels will contain the
1630 //! sample result with border texels excluded.
1631 //! For cases where the surface format contains an Alpha channel, the
1632 //! result returned will be ovewritten to return the filter weight.
1633 //! For cases where the surface format does not contain Alpha, the result
1634 //! will still be returned in the Alpha Channel.
1635 enum RETURN_FILTER_WEIGHT_FOR_BORDER_TEXELS
1636 {
1637 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.
1638 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.
1639 };
1640
1641 //! \brief TCZ_ADDRESS_CONTROL_MODE
1642 //! \details
1643 //! Controls how the 3rd (TCZ) component of input texture coordinates are
1644 //! mapped to texture map addresses - specifically, how coordinates
1645 //! "outside" the texture are handled (wrap/clamp/mirror).See Address TCX
1646 //! Control Mode above for details
1647 enum TCZ_ADDRESS_CONTROL_MODE
1648 {
1649 TCZ_ADDRESS_CONTROL_MODE_WRAP = 0, //!< Map is repeated in the U direction
1650 TCZ_ADDRESS_CONTROL_MODE_MIRROR = 1, //!< Map is mirrored in the U direction
1651 TCZ_ADDRESS_CONTROL_MODE_CLAMP = 2, //!< Map is clamped to the edges of the accessed map
1652 TCZ_ADDRESS_CONTROL_MODE_CUBE = 3, //!< For cube-mapping, filtering in edges access adjacent map faces
1653 TCZ_ADDRESS_CONTROL_MODE_CLAMPBORDER = 4, //!< Map is infinitely extended with the border color
1654 TCZ_ADDRESS_CONTROL_MODE_MIRRORONCE = 5, //!< Map is mirrored once about origin, then clamped
1655 TCZ_ADDRESS_CONTROL_MODE_HALFBORDER = 6, //!< Map is infinitely extended with the average of the nearest edge texel and the border color
1656 TCZ_ADDRESS_CONTROL_MODE_MIRROR101 = 7, //!< Map is mirrored one time in each direction, but the first pixel of the reflected image is skipped, and the reflected image is effectively 1 pixel less in that direction.May only be used on 2D surfaces.
1657 };
1658
1659 //! \brief TCY_ADDRESS_CONTROL_MODE
1660 //! \details
1661 //! Controls how the 2nd (TCY, aka V) component of input texture coordinates
1662 //! are mapped to texture map addresses - specifically, how coordinates
1663 //! "outside" the texture are handled (wrap/clamp/mirror). See Address TCX
1664 //! Control Mode above for details
1665 enum TCY_ADDRESS_CONTROL_MODE
1666 {
1667 TCY_ADDRESS_CONTROL_MODE_WRAP = 0, //!< Map is repeated in the U direction
1668 TCY_ADDRESS_CONTROL_MODE_MIRROR = 1, //!< Map is mirrored in the U direction
1669 TCY_ADDRESS_CONTROL_MODE_CLAMP = 2, //!< Map is clamped to the edges of the accessed map
1670 TCY_ADDRESS_CONTROL_MODE_CUBE = 3, //!< For cube-mapping, filtering in edges access adjacent map faces
1671 TCY_ADDRESS_CONTROL_MODE_CLAMPBORDER = 4, //!< Map is infinitely extended with the border color
1672 TCY_ADDRESS_CONTROL_MODE_MIRRORONCE = 5, //!< Map is mirrored once about origin, then clamped
1673 TCY_ADDRESS_CONTROL_MODE_HALFBORDER = 6, //!< Map is infinitely extended with the average of the nearest edge texel and the border color
1674 TCY_ADDRESS_CONTROL_MODE_MIRROR101 = 7, //!< Map is mirrored one time in each direction, but the first pixel of the reflected image is skipped, and the reflected image is effectively 1 pixel less in that direction.May only be used on 2D surfaces.
1675 };
1676
1677 //! \brief TCX_ADDRESS_CONTROL_MODE
1678 //! \details
1679 //! Controls how the 1st (TCX, aka U) component of input texture coordinates
1680 //! are mapped to texture map addresses - specifically, how coordinates
1681 //! "outside" the texture are handled (wrap/clamp/mirror). The setting of
1682 //! this field is subject to being overridden by the Cube Surface Control
1683 //! Mode field when sampling from a SURFTYPE_CUBE surface.
1684 enum TCX_ADDRESS_CONTROL_MODE
1685 {
1686 TCX_ADDRESS_CONTROL_MODE_WRAP = 0, //!< Map is repeated in the U direction
1687 TCX_ADDRESS_CONTROL_MODE_MIRROR = 1, //!< Map is mirrored in the U direction
1688 TCX_ADDRESS_CONTROL_MODE_CLAMP = 2, //!< Map is clamped to the edges of the accessed map
1689 TCX_ADDRESS_CONTROL_MODE_CUBE = 3, //!< For cube-mapping, filtering in edges access adjacent map faces
1690 TCX_ADDRESS_CONTROL_MODE_CLAMPBORDER = 4, //!< Map is infinitely extended with the border color
1691 TCX_ADDRESS_CONTROL_MODE_MIRRORONCE = 5, //!< Map is mirrored once about origin, then clamped
1692 TCX_ADDRESS_CONTROL_MODE_HALFBORDER = 6, //!< Map is infinitely extended with the average of the nearest edge texel and the border color
1693 TCX_ADDRESS_CONTROL_MODE_MIRROR101 = 7, //!< Map is mirrored one time in each direction, but the first pixel of the reflected image is skipped, and the reflected image is effectively 1 pixel less in that direction.May only be used on 2D surfaces.
1694 };
1695
1696 //! \brief TRILINEAR_FILTER_QUALITY
1697 //! \details
1698 //! Selects the quality level for the trilinear filter.
1699 enum TRILINEAR_FILTER_QUALITY
1700 {
1701 TRILINEAR_FILTER_QUALITY_FULL = 0, //!< Full Quality. Both mip maps are sampled under all circumstances.
1702 TRILINEAR_FILTER_QUALITY_TRIQUALHIGHMAGCLAMPMIPFILTER = 1, //!< High Quality.
1703 TRILINEAR_FILTER_QUALITY_MED = 2, //!< Medium Quality.
1704 TRILINEAR_FILTER_QUALITY_LOW = 3, //!< Low Quality.
1705 };
1706
1707 //! \brief MAXIMUM_ANISOTROPY
1708 //! \details
1709 //! This field clamps the maximum value of the anisotropy ratio used by the
1710 //! MAPFILTER_ANISOTROPIC filter (Min or Mag Mode Filter).
1711 enum MAXIMUM_ANISOTROPY
1712 {
1713 MAXIMUM_ANISOTROPY_RATIO21 = 0, //!< At most a 2:1 aspect ratio filter is used
1714 MAXIMUM_ANISOTROPY_RATIO41 = 1, //!< At most a 4:1 aspect ratio filter is used
1715 MAXIMUM_ANISOTROPY_RATIO61 = 2, //!< At most a 6:1 aspect ratio filter is used
1716 MAXIMUM_ANISOTROPY_RATIO81 = 3, //!< At most a 8:1 aspect ratio filter is used
1717 MAXIMUM_ANISOTROPY_RATIO101 = 4, //!< At most a 10:1 aspect ratio filter is used
1718 MAXIMUM_ANISOTROPY_RATIO121 = 5, //!< At most a 12:1 aspect ratio filter is used
1719 MAXIMUM_ANISOTROPY_RATIO141 = 6, //!< At most a 14:1 aspect ratio filter is used
1720 MAXIMUM_ANISOTROPY_RATIO161 = 7, //!< At most a 16:1 aspect ratio filter is used
1721 };
1722
1723 //! \brief REDUCTION_TYPE
1724 //! \details
1725 //! This field defines the type of reduction that will be performed on the
1726 //! texels in the footprint defined by the Min/Mag/Mip Filter Mode
1727 //! fields. This field is ignored if Reduction Type Enable is
1728 //! disabled.
1729 enum REDUCTION_TYPE
1730 {
1731 REDUCTION_TYPE_STDFILTER = 0, //!< standard filter
1732 REDUCTION_TYPE_COMPARISON = 1, //!< comparison followed by standard filter
1733 REDUCTION_TYPE_MINIMUM = 2, //!< minimum of footprint
1734 REDUCTION_TYPE_MAXIMUM = 3, //!< maximum of footprint
1735 };
1736
1737 //! \name Initializations
1738
1739 //! \brief Explicit member initialization function
1740 SAMPLER_STATE_CMD();
1741
1742 static const size_t dwSize = 4;
1743 static const size_t byteSize = 16;
1744 };
1745
1746 //!
1747 //! \brief SAMPLER_STATE_8x8_AVS_COEFFICIENTS
1748 //! \details
1749 //! ExistsIf = AVS &amp;&amp; (Function_mode = 0)
1750 //!
1751 struct SAMPLER_STATE_8x8_AVS_COEFFICIENTS_CMD
1752 {
1753 union
1754 {
1755 struct
1756 {
1757 uint32_t Table0XFilterCoefficientN0 : __CODEGEN_BITFIELD( 0, 7) ; //!< Table 0X Filter Coefficient[n,0]
1758 uint32_t Table0YFilterCoefficientN0 : __CODEGEN_BITFIELD( 8, 15) ; //!< Table 0Y Filter Coefficient[n,0]
1759 uint32_t Table0XFilterCoefficientN1 : __CODEGEN_BITFIELD(16, 23) ; //!< Table 0X Filter Coefficient[n,1]
1760 uint32_t Table0YFilterCoefficientN1 : __CODEGEN_BITFIELD(24, 31) ; //!< Table 0Y Filter Coefficient[n,1]
1761 };
1762 uint32_t Value;
1763 } DW0;
1764 union
1765 {
1766 struct
1767 {
1768 uint32_t Table0XFilterCoefficientN2 : __CODEGEN_BITFIELD( 0, 7) ; //!< Table 0X Filter Coefficient[n,2]
1769 uint32_t Table0YFilterCoefficientN2 : __CODEGEN_BITFIELD( 8, 15) ; //!< Table 0Y Filter Coefficient[n,2]
1770 uint32_t Table0XFilterCoefficientN3 : __CODEGEN_BITFIELD(16, 23) ; //!< Table 0X Filter Coefficient[n,3]
1771 uint32_t Table0YFilterCoefficientN3 : __CODEGEN_BITFIELD(24, 31) ; //!< Table 0Y Filter Coefficient[n,3]
1772 };
1773 uint32_t Value;
1774 } DW1;
1775 union
1776 {
1777 struct
1778 {
1779 uint32_t Table0XFilterCoefficientN4 : __CODEGEN_BITFIELD( 0, 7) ; //!< Table 0X Filter Coefficient[n,4]
1780 uint32_t Table0YFilterCoefficientN4 : __CODEGEN_BITFIELD( 8, 15) ; //!< Table 0Y Filter Coefficient[n,4]
1781 uint32_t Table0XFilterCoefficientN5 : __CODEGEN_BITFIELD(16, 23) ; //!< Table 0X Filter Coefficient[n,5]
1782 uint32_t Table0YFilterCoefficientN5 : __CODEGEN_BITFIELD(24, 31) ; //!< Table 0Y Filter Coefficient[n,5]
1783 };
1784 uint32_t Value;
1785 } DW2;
1786 union
1787 {
1788 struct
1789 {
1790 uint32_t Table0XFilterCoefficientN6 : __CODEGEN_BITFIELD( 0, 7) ; //!< Table 0X Filter Coefficient[n,6]
1791 uint32_t Table0YFilterCoefficientN6 : __CODEGEN_BITFIELD( 8, 15) ; //!< Table 0Y Filter Coefficient[n,6]
1792 uint32_t Table0XFilterCoefficientN7 : __CODEGEN_BITFIELD(16, 23) ; //!< Table 0X Filter Coefficient[n,7]
1793 uint32_t Table0YFilterCoefficientN7 : __CODEGEN_BITFIELD(24, 31) ; //!< Table 0Y Filter Coefficient[n,7]
1794 };
1795 uint32_t Value;
1796 } DW3;
1797 union
1798 {
1799 struct
1800 {
1801 uint32_t Reserved128 : __CODEGEN_BITFIELD( 0, 15) ; //!< Reserved
1802 uint32_t Table1XFilterCoefficientN2 : __CODEGEN_BITFIELD(16, 23) ; //!< Table 1X Filter Coefficient[n,2]
1803 uint32_t Table1XFilterCoefficientN3 : __CODEGEN_BITFIELD(24, 31) ; //!< Table 1X Filter Coefficient[n,3]
1804 };
1805 uint32_t Value;
1806 } DW4;
1807 union
1808 {
1809 struct
1810 {
1811 uint32_t Table1XFilterCoefficientN4 : __CODEGEN_BITFIELD( 0, 7) ; //!< Table 1X Filter Coefficient[n,4]
1812 uint32_t Table1XFilterCoefficientN5 : __CODEGEN_BITFIELD( 8, 15) ; //!< Table 1X Filter Coefficient[n,5]
1813 uint32_t Reserved176 : __CODEGEN_BITFIELD(16, 31) ; //!< Reserved
1814 };
1815 uint32_t Value;
1816 } DW5;
1817 union
1818 {
1819 struct
1820 {
1821 uint32_t Reserved192 : __CODEGEN_BITFIELD( 0, 15) ; //!< Reserved
1822 uint32_t Table1YFilterCoefficientN2 : __CODEGEN_BITFIELD(16, 23) ; //!< Table 1Y Filter Coefficient[n,2]
1823 uint32_t Table1YFilterCoefficientN3 : __CODEGEN_BITFIELD(24, 31) ; //!< Table 1Y Filter Coefficient[n,3]
1824 };
1825 uint32_t Value;
1826 } DW6;
1827 union
1828 {
1829 struct
1830 {
1831 uint32_t Table1YFilterCoefficientN4 : __CODEGEN_BITFIELD( 0, 7) ; //!< Table 1Y Filter Coefficient[n,4]
1832 uint32_t Table1YFilterCoefficientN5 : __CODEGEN_BITFIELD( 8, 15) ; //!< Table 1Y Filter Coefficient[n,5]
1833 uint32_t Reserved240 : __CODEGEN_BITFIELD(16, 31) ; //!< Reserved
1834 };
1835 uint32_t Value;
1836 } DW7;
1837
1838 //! \name Local enumerations
1839
1840 //! \name Initializations
1841
1842 //! \brief Explicit member initialization function
1843 SAMPLER_STATE_8x8_AVS_COEFFICIENTS_CMD();
1844
1845 static const size_t dwSize = 8;
1846 static const size_t byteSize = 32;
1847 };
1848
1849 //!
1850 //! \brief SAMPLER_STATE_8x8_AVS
1851 //! \details
1852 //! ExistsIf = AVS
1853 //!
1854 struct SAMPLER_STATE_8x8_AVS_CMD
1855 {
1856 uint32_t Reserved0[3]; //!< Reserved
1857 union
1858 {
1859 struct
1860 {
1861 uint32_t Reserved96 : __CODEGEN_BITFIELD( 0, 27) ; //!< Reserved
1862 uint32_t Enable8TapFilter : __CODEGEN_BITFIELD(28, 29) ; //!< ENABLE_8_TAP_FILTER
1863 uint32_t Reserved126 : __CODEGEN_BITFIELD(30, 31) ; //!< Reserved
1864 };
1865 uint32_t Value;
1866 } DW3;
1867 union
1868 {
1869 struct
1870 {
1871 uint32_t Reserved128 : __CODEGEN_BITFIELD( 0, 10) ; //!< Reserved
1872 uint32_t ShuffleOutputwritebackForSample8X8 : __CODEGEN_BITFIELD(11, 11) ; //!< SHUFFLE_OUTPUTWRITEBACK_FOR_SAMPLE_8X8
1873 uint32_t Reserved140 : __CODEGEN_BITFIELD(12, 31) ; //!< Reserved
1874 };
1875 uint32_t Value;
1876 } DW4;
1877 uint32_t Reserved160[11]; //!< Reserved
1878 SAMPLER_STATE_8x8_AVS_COEFFICIENTS_CMD FilterCoefficient016[17]; //!< DW16..151, Filter Coefficient[0..16]
1879 union
1880 {
1881 struct
1882 {
1883 uint32_t TransitionAreaWith8Pixels : __CODEGEN_BITFIELD( 0, 2) ; //!< Transition Area with 8 Pixels
1884 uint32_t Reserved4867 : __CODEGEN_BITFIELD( 3, 3) ; //!< Reserved
1885 uint32_t TransitionAreaWith4Pixels : __CODEGEN_BITFIELD( 4, 6) ; //!< Transition Area with 4 Pixels
1886 uint32_t Reserved4871 : __CODEGEN_BITFIELD( 7, 7) ; //!< Reserved
1887 uint32_t MaxDerivative8Pixels : __CODEGEN_BITFIELD( 8, 15) ; //!< Max Derivative 8 Pixels
1888 uint32_t MaxDerivative4Pixels : __CODEGEN_BITFIELD(16, 23) ; //!< Max Derivative 4 Pixels
1889 uint32_t DefaultSharpnessLevel : __CODEGEN_BITFIELD(24, 31) ; //!< DEFAULT_SHARPNESS_LEVEL
1890 };
1891 uint32_t Value;
1892 } DW152;
1893 union
1894 {
1895 struct
1896 {
1897 uint32_t RgbAdaptive : __CODEGEN_BITFIELD( 0, 0) ; //!< RGB_ADAPTIVE
1898 uint32_t AdaptiveFilterForAllChannels : __CODEGEN_BITFIELD( 1, 1) ; //!< ADAPTIVE_FILTER_FOR_ALL_CHANNELS
1899 uint32_t Reserved4898 : __CODEGEN_BITFIELD( 2, 20) ; //!< Reserved
1900 uint32_t BypassYAdaptiveFiltering : __CODEGEN_BITFIELD(21, 21) ; //!< BYPASS_Y_ADAPTIVE_FILTERING
1901 uint32_t BypassXAdaptiveFiltering : __CODEGEN_BITFIELD(22, 22) ; //!< BYPASS_X_ADAPTIVE_FILTERING
1902 uint32_t Reserved4919 : __CODEGEN_BITFIELD(23, 31) ; //!< Reserved
1903 };
1904 uint32_t Value;
1905 } DW153;
1906 uint32_t Reserved4928[6]; //!< Reserved
1907 SAMPLER_STATE_8x8_AVS_COEFFICIENTS_CMD FilterCoefficient1731[15]; //!< DW160..279, Filter Coefficient[17..31]
1908
1909 //! \name Local enumerations
1910
1911 //! \brief ENABLE_8_TAP_FILTER
1912 //! \details
1913 //! Adaptive Filtering (Mode = 11) ExistsIf:
1914 //! R10G10B10A2_UNORM R8G8B8A8_UNORM (AYUV also) R8B8G8A8_UNORM
1915 //! B8G8R8A8_UNORM R16G16B16A16
1916 enum ENABLE_8_TAP_FILTER
1917 {
1918 ENABLE_8_TAP_FILTER_UNNAMED0 = 0, //!< 4-tap filter is only done on all channels.
1919 ENABLE_8_TAP_FILTER_UNNAMED1 = 1, //!< Enable 8-tap Adaptive filter on G-channel. 4-tap filter on other channels.
1920 ENABLE_8_TAP_FILTER_UNNAMED2 = 2, //!< 8-tap filter is done on all channels (UV-ch uses the Y-coefficients)
1921 ENABLE_8_TAP_FILTER_UNNAMED3 = 3, //!< Enable 8-tap Adaptive filter all channels (UV-ch uses the Y-coefficients).
1922 };
1923
1924 enum SHUFFLE_OUTPUTWRITEBACK_FOR_SAMPLE_8X8
1925 {
1926 SHUFFLE_OUTPUTWRITEBACK_FOR_SAMPLE_8X8_UNNAMED0 = 0, //!< Writeback same as Original Sample_8x8
1927 SHUFFLE_OUTPUTWRITEBACK_FOR_SAMPLE_8X8_UNNAMED1 = 1, //!< Writeback of Sample_8x8 Is Modified to Suite Sample_Unorm
1928 };
1929
1930 //! \brief DEFAULT_SHARPNESS_LEVEL
1931 //! \details
1932 //! When adaptive scaling is off, determines the balance between sharp and
1933 //! smooth scalers.
1934 enum DEFAULT_SHARPNESS_LEVEL
1935 {
1936 DEFAULT_SHARPNESS_LEVEL_UNNAMED0 = 0, //!< Contribute 1 from the smooth scalar
1937 DEFAULT_SHARPNESS_LEVEL_UNNAMED255 = 255, //!< Contribute 1 from the sharp scalar
1938 };
1939
1940 //! \brief RGB_ADAPTIVE
1941 //! \details
1942 //! This should be always set to 0 for YUV input and can be enabled/disabled
1943 //! for RGB input.
1944 //! This should be enabled only if we enable 8-tap adaptive filter for
1945 //! RGB input.
1946 enum RGB_ADAPTIVE
1947 {
1948 RGB_ADAPTIVE_DISBLE = 0, //!< Disable the RGB Adaptive equation and use G-Ch directly for adaptive filter
1949 RGB_ADAPTIVE_ENABLE = 1, //!< Enable the RGB Adaptive filter using the equation (Y=(R+2G+B)>>2)
1950 };
1951
1952 //! \brief ADAPTIVE_FILTER_FOR_ALL_CHANNELS
1953 //! \details
1954 //! Only to be enabled if 8-tap Adaptive filter mode is on, eElse it should
1955 //! be disabled.
1956 enum ADAPTIVE_FILTER_FOR_ALL_CHANNELS
1957 {
1958 ADAPTIVE_FILTER_FOR_ALL_CHANNELS_DISBLE = 0, //!< Disable Adaptive Filter on UV/RB Channels
1959 ADAPTIVE_FILTER_FOR_ALL_CHANNELS_ENABLE = 1, //!< Enable Adaptive Filter on UV/RB Channels
1960 };
1961
1962 //! \brief BYPASS_Y_ADAPTIVE_FILTERING
1963 //! \details
1964 //! When disabled, the Y direction will use Default Sharpness Level
1965 //! to blend between the smooth and sharp filters rather than the calculated
1966 //! value.
1967 enum BYPASS_Y_ADAPTIVE_FILTERING
1968 {
1969 BYPASS_Y_ADAPTIVE_FILTERING_ENABLE = 0, //!< Enable Y Adaptive Filtering
1970 BYPASS_Y_ADAPTIVE_FILTERING_DISBLE = 1, //!< Disable Y Adaptive Filtering
1971 };
1972
1973 //! \brief BYPASS_X_ADAPTIVE_FILTERING
1974 //! \details
1975 //! When disabled, the X direction will use Default Sharpness Level
1976 //! to blend between the smooth and sharp filters rather than the calculated
1977 //! value.
1978 enum BYPASS_X_ADAPTIVE_FILTERING
1979 {
1980 BYPASS_X_ADAPTIVE_FILTERING_ENABLE = 0, //!< Enable X Adaptive Filtering
1981 BYPASS_X_ADAPTIVE_FILTERING_DISBLE = 1, //!< Disable X Adaptive Filtering
1982 };
1983
1984 //! \name Initializations
1985
1986 //! \brief Explicit member initialization function
1987 SAMPLER_STATE_8x8_AVS_CMD();
1988
1989 static const size_t dwSize = 280;
1990 static const size_t byteSize = 1120;
1991 };
1992
1993 //!
1994 //! \brief SAMPLER_INDIRECT_STATE
1995 //! \details
1996 //! Note: There are three variations of this structure, defined separately
1997 //! because their payloads have different lengths. Currently only
1998 //! SAMPLER_INDIRECT_STATE_BORDER_COLOR is fully defined. 
1999 //! This structure is pointed to by Indirect State Pointer (SAMPLER_STATE).
2000 //! The interpretation of the border color depends on the Texture Border
2001 //! Color Mode field in SAMPLER_STATE as follows:
2002 //!
2003 //! In 8BIT mode, the border color is 8-bit UNORM format, regardless of the
2004 //! surface format chosen. For surface formats with one or more channels
2005 //! missing (i.e. R5G6R5_UNORM is missing the alpha channel), the value from
2006 //! the border color, if selected, will be used even for the missing
2007 //! channels.
2008 //!
2009 //! In OGL mode, the format of the border color is R32G32B32A32_FLOAT,
2010 //! R32G32B32A32_SINT, or R32G32B32A32_UINT, depending on the surface format
2011 //! chosen. For surface formats with one or more channels missing, the value
2012 //! from the border color is not used for the missing channels, resulting in
2013 //! these channels resulting in the overall default value (0 for colors and
2014 //! 1 for alpha) regardless of whether border color is chosen. The surface
2015 //! formats with "L" and "I" have special behavior with respect to the
2016 //! border color. The border color value used for the replicated channels
2017 //! (RGB for "L" formats and RGBA for "I" formats) comes from the red
2018 //! channel of border color. In these cases, the green and blue channels,
2019 //! and also alpha for "I", of the border color are ignored.
2020 //!
2021 //!
2022 //!
2023 //!
2024 //!
2025 //! The format of this state depends on the Texture Border Color Mode field.
2026 //!
2027 //! 8BIT mode is not supported for surfaces with more than 16 bits in any
2028 //! channel, other than 32-bit float formats which are supported.
2029 //! The conditions under which this color is used depend on the Surface
2030 //! Type - 1D/2D/3D surfaces use the border color when the coordinates
2031 //! extend beyond the surface extent; cube surfaces use the border color for
2032 //! "empty" (disabled) faces.
2033 //! The border color itself is accessed through the texture cache hierarchy
2034 //! rather than the state cache hierarchy. Thus, if the border color is
2035 //! changed in memory, the texture cache must be invalidated and the state
2036 //! cache does not need to be invalidated.
2037 //! MAPFILTER_MONO: The border color is ignored. Border color is fixed at
2038 //! a value of 0 by hardware.
2039 //!
2040 //!
2041 struct SAMPLER_INDIRECT_STATE_CMD
2042 {
2043 union
2044 {
2045 struct
2046 {
2047 uint32_t BorderColorRed : __CODEGEN_BITFIELD( 0, 7) ; //!< Border Color Red, Structure[SAMPLER_STATE][Texture Border Color Mode] == '8BIT'
2048 uint32_t BorderColorGreen : __CODEGEN_BITFIELD( 8, 15) ; //!< Border Color Green, Structure[SAMPLER_STATE][Texture Border Color Mode] == '8BIT'
2049 uint32_t Reserved16 : __CODEGEN_BITFIELD(16, 31) ; //!< Reserved, Structure[SAMPLER_STATE][Texture Border Color Mode] == '8BIT'
2050 } Obj0;
2051 struct
2052 {
2053 uint32_t Reserved0 : __CODEGEN_BITFIELD( 0, 15) ; //!< Reserved, Structure[SAMPLER_STATE][Texture Border Color Mode] == '8BIT'
2054 uint32_t BorderColorBlue : __CODEGEN_BITFIELD(16, 23) ; //!< Border Color Blue, Structure[SAMPLER_STATE][Texture Border Color Mode] == '8BIT'
2055 uint32_t BorderColorAlpha : __CODEGEN_BITFIELD(24, 31) ; //!< Border Color Alpha, Structure[SAMPLER_STATE][Texture Border Color Mode] == '8BIT'
2056 } Obj1;
2057 struct
2058 {
2059 uint32_t BorderColorRed ; //!< Border Color Red, Structure[SAMPLER_STATE][Texture Border Color Mode] == 'OGL'
2060 } Obj2;
2061 uint32_t Value;
2062 } DW0;
2063 union
2064 {
2065 struct
2066 {
2067 uint32_t BorderColorGreen ; //!< Border Color Green, Structure[SAMPLER_STATE][Texture Border Color Mode] == 'OGL'
2068 };
2069 uint32_t Value;
2070 } DW1;
2071 union
2072 {
2073 struct
2074 {
2075 uint32_t BorderColorBlue ; //!< Border Color Blue, Structure[SAMPLER_STATE][Texture Border Color Mode] == 'OGL'
2076 };
2077 uint32_t Value;
2078 } DW2;
2079 union
2080 {
2081 struct
2082 {
2083 uint32_t BorderColorAlpha ; //!< Border Color Alpha, Structure[SAMPLER_STATE][Texture Border Color Mode] == 'OGL'
2084 };
2085 uint32_t Value;
2086 } DW3;
2087 uint32_t Reserved128[12]; //!< Reserved
2088
2089 //! \name Local enumerations
2090
2091 //! \name Initializations
2092
2093 //! \brief Explicit member initialization function
2094 SAMPLER_INDIRECT_STATE_CMD();
2095
2096 static const size_t dwSize = 16;
2097 static const size_t byteSize = 64;
2098 };
2099
2100 };
2101
2102 #pragma pack()
2103
2104 #endif // __MHW_STATE_HEAP_HWCMD_G12_X_H__