2 // Copyright (C) 2002-2005 3Dlabs Inc. Ltd.
3 // Copyright (C) 2012-2013 LunarG, Inc.
4 // Copyright (C) 2017 ARM Limited.
5 // Modifications Copyright (C) 2020 Advanced Micro Devices, Inc. All rights reserved.
7 // All rights reserved.
9 // Redistribution and use in source and binary forms, with or without
10 // modification, are permitted provided that the following conditions
13 // Redistributions of source code must retain the above copyright
14 // notice, this list of conditions and the following disclaimer.
16 // Redistributions in binary form must reproduce the above
17 // copyright notice, this list of conditions and the following
18 // disclaimer in the documentation and/or other materials provided
19 // with the distribution.
21 // Neither the name of 3Dlabs Inc. Ltd. nor the names of its
22 // contributors may be used to endorse or promote products derived
23 // from this software without specific prior written permission.
25 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
28 // FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
29 // COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
30 // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
31 // BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
32 // LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
33 // CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34 // LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
35 // ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 // POSSIBILITY OF SUCH DAMAGE.
39 #ifndef _BASICTYPES_INCLUDED_
40 #define _BASICTYPES_INCLUDED_
45 // Basic type. Arrays, vectors, sampler details, etc., are orthogonal to this.
70 // SPIR-V type defined by spirv_type
74 // HLSL types that live only temporarily.
81 // Storage qualifiers. Should align with different kinds of storage or
82 // resource or GLSL storage qualifier. Expansion is deprecated.
84 // N.B.: You probably DON'T want to add anything here, but rather just add it
85 // to the built-in variables. See the comment above TBuiltInVariable.
87 // A new built-in variable will normally be an existing qualifier, like 'in', 'out', etc.
88 // DO NOT follow the design pattern of, say EvqInstanceId, etc.
90 enum TStorageQualifier {
91 EvqTemporary, // For temporaries (within a function), read/write
92 EvqGlobal, // For globals read/write
93 EvqConst, // User-defined constant values, will be semantically constant and constant folded
94 EvqVaryingIn, // pipeline input, read only, also supercategory for all built-ins not included in this enum (see TBuiltInVariable)
95 EvqVaryingOut, // pipeline output, read/write, also supercategory for all built-ins not included in this enum (see TBuiltInVariable)
96 EvqUniform, // read only, shared with app
97 EvqBuffer, // read/write, shared with app
98 EvqShared, // compute shader's read/write 'shared' qualifier
100 EvqSpirvStorageClass, // spirv_storage_class
110 EvqtaskPayloadSharedEXT,
113 EvqIn, // also, for 'in' in the grammar before we know if it's a pipeline input or an 'in' parameter
114 EvqOut, // also, for 'out' in the grammar before we know if it's a pipeline output or an 'out' parameter
116 EvqConstReadOnly, // input; also other read-only types having neither a constant value nor constant-value semantics
118 // built-ins read by vertex shader
122 // built-ins written by vertex shader
127 // built-ins read by fragment shader
132 // built-ins written by fragment shader
142 // Subcategories of the TStorageQualifier, simply to give a direct mapping
143 // between built-in variable names and an numerical value (the enum).
145 // For backward compatibility, there is some redundancy between the
146 // TStorageQualifier and these. Existing members should both be maintained accurately.
147 // However, any new built-in variable (and any existing non-redundant one)
148 // must follow the pattern that the specific built-in is here, and only its
149 // general qualifier is in TStorageQualifier.
151 // Something like gl_Position, which is sometimes 'in' and sometimes 'out'
152 // shows up as two different built-in variables in a single stage, but
153 // only has a single enum in TBuiltInVariable, so both the
154 // TStorageQualifier and the TBuitinVariable are needed to distinguish
157 enum TBuiltInVariable {
162 EbvLocalInvocationId,
163 EbvGlobalInvocationId,
164 EbvLocalInvocationIndex,
168 EbvSubGroupInvocation,
175 EbvSubgroupInvocation2,
205 EbvFrontSecondaryColor,
206 EbvBackSecondaryColor,
233 EbvBaryCoordNoPerspCentroid,
234 EbvBaryCoordNoPerspSample,
236 EbvBaryCoordSmoothCentroid,
237 EbvBaryCoordSmoothSample,
238 EbvBaryCoordPullModel,
244 EbvPrimitiveShadingRateKHR,
247 EbvFragInvocationCountEXT,
249 EbvSecondaryFragDataEXT,
250 EbvSecondaryFragColorEXT,
253 EbvSecondaryPositionNV,
254 EbvSecondaryViewportMaskNV,
255 EbvPositionPerViewNV,
256 EbvViewportMaskPerViewNV,
257 EbvFragFullyCoveredNV,
259 EbvInvocationsPerPixelNV,
263 EbvInstanceCustomIndex,
266 EbvWorldRayDirection,
268 EbvObjectRayDirection,
282 EbvBaryCoordNoPerspNV,
284 EbvBaryCoordNoPerspEXT,
288 EbvPrimitiveIndicesNV,
289 EbvClipDistancePerViewNV,
290 EbvCullDistancePerViewNV,
293 EbvMeshViewIndicesNV,
295 EbvPrimitivePointIndicesEXT,
296 EbvPrimitiveLineIndicesEXT,
297 EbvPrimitiveTriangleIndicesEXT,
306 // HLSL built-ins that live only temporarily, until they get remapped
307 // to one of the above.
314 // structbuffer types
315 EbvAppendConsume, // no need to differentiate append and consume
316 EbvRWStructuredBuffer,
318 EbvByteAddressBuffer,
319 EbvRWByteAddressBuffer,
321 // ARM specific core builtins
331 // In this enum, order matters; users can assume higher precision is a bigger value
333 enum TPrecisionQualifier {
341 __inline const char* GetStorageQualifierString(TStorageQualifier q) { return ""; }
342 __inline const char* GetPrecisionQualifierString(TPrecisionQualifier p) { return ""; }
344 // These will show up in error messages
345 __inline const char* GetStorageQualifierString(TStorageQualifier q)
348 case EvqTemporary: return "temp"; break;
349 case EvqGlobal: return "global"; break;
350 case EvqConst: return "const"; break;
351 case EvqConstReadOnly: return "const (read only)"; break;
353 case EvqSpirvStorageClass: return "spirv_storage_class"; break;
355 case EvqVaryingIn: return "in"; break;
356 case EvqVaryingOut: return "out"; break;
357 case EvqUniform: return "uniform"; break;
358 case EvqBuffer: return "buffer"; break;
359 case EvqShared: return "shared"; break;
360 case EvqIn: return "in"; break;
361 case EvqOut: return "out"; break;
362 case EvqInOut: return "inout"; break;
363 case EvqVertexId: return "gl_VertexId"; break;
364 case EvqInstanceId: return "gl_InstanceId"; break;
365 case EvqPosition: return "gl_Position"; break;
366 case EvqPointSize: return "gl_PointSize"; break;
367 case EvqClipVertex: return "gl_ClipVertex"; break;
368 case EvqFace: return "gl_FrontFacing"; break;
369 case EvqFragCoord: return "gl_FragCoord"; break;
370 case EvqPointCoord: return "gl_PointCoord"; break;
371 case EvqFragColor: return "fragColor"; break;
372 case EvqFragDepth: return "gl_FragDepth"; break;
373 case EvqFragStencil: return "gl_FragStencilRefARB"; break;
374 case EvqPayload: return "rayPayloadNV"; break;
375 case EvqPayloadIn: return "rayPayloadInNV"; break;
376 case EvqHitAttr: return "hitAttributeNV"; break;
377 case EvqCallableData: return "callableDataNV"; break;
378 case EvqCallableDataIn: return "callableDataInNV"; break;
379 case EvqtaskPayloadSharedEXT: return "taskPayloadSharedEXT"; break;
380 case EvqHitObjectAttrNV:return "hitObjectAttributeNV"; break;
381 default: return "unknown qualifier";
385 __inline const char* GetBuiltInVariableString(TBuiltInVariable v)
388 case EbvNone: return "";
389 case EbvNumWorkGroups: return "NumWorkGroups";
390 case EbvWorkGroupSize: return "WorkGroupSize";
391 case EbvWorkGroupId: return "WorkGroupID";
392 case EbvLocalInvocationId: return "LocalInvocationID";
393 case EbvGlobalInvocationId: return "GlobalInvocationID";
394 case EbvLocalInvocationIndex: return "LocalInvocationIndex";
395 case EbvNumSubgroups: return "NumSubgroups";
396 case EbvSubgroupID: return "SubgroupID";
397 case EbvSubGroupSize: return "SubGroupSize";
398 case EbvSubGroupInvocation: return "SubGroupInvocation";
399 case EbvSubGroupEqMask: return "SubGroupEqMask";
400 case EbvSubGroupGeMask: return "SubGroupGeMask";
401 case EbvSubGroupGtMask: return "SubGroupGtMask";
402 case EbvSubGroupLeMask: return "SubGroupLeMask";
403 case EbvSubGroupLtMask: return "SubGroupLtMask";
404 case EbvSubgroupSize2: return "SubgroupSize";
405 case EbvSubgroupInvocation2: return "SubgroupInvocationID";
406 case EbvSubgroupEqMask2: return "SubgroupEqMask";
407 case EbvSubgroupGeMask2: return "SubgroupGeMask";
408 case EbvSubgroupGtMask2: return "SubgroupGtMask";
409 case EbvSubgroupLeMask2: return "SubgroupLeMask";
410 case EbvSubgroupLtMask2: return "SubgroupLtMask";
411 case EbvVertexId: return "VertexId";
412 case EbvInstanceId: return "InstanceId";
413 case EbvVertexIndex: return "VertexIndex";
414 case EbvInstanceIndex: return "InstanceIndex";
415 case EbvBaseVertex: return "BaseVertex";
416 case EbvBaseInstance: return "BaseInstance";
417 case EbvDrawId: return "DrawId";
418 case EbvPosition: return "Position";
419 case EbvPointSize: return "PointSize";
420 case EbvClipVertex: return "ClipVertex";
421 case EbvClipDistance: return "ClipDistance";
422 case EbvCullDistance: return "CullDistance";
423 case EbvNormal: return "Normal";
424 case EbvVertex: return "Vertex";
425 case EbvMultiTexCoord0: return "MultiTexCoord0";
426 case EbvMultiTexCoord1: return "MultiTexCoord1";
427 case EbvMultiTexCoord2: return "MultiTexCoord2";
428 case EbvMultiTexCoord3: return "MultiTexCoord3";
429 case EbvMultiTexCoord4: return "MultiTexCoord4";
430 case EbvMultiTexCoord5: return "MultiTexCoord5";
431 case EbvMultiTexCoord6: return "MultiTexCoord6";
432 case EbvMultiTexCoord7: return "MultiTexCoord7";
433 case EbvFrontColor: return "FrontColor";
434 case EbvBackColor: return "BackColor";
435 case EbvFrontSecondaryColor: return "FrontSecondaryColor";
436 case EbvBackSecondaryColor: return "BackSecondaryColor";
437 case EbvTexCoord: return "TexCoord";
438 case EbvFogFragCoord: return "FogFragCoord";
439 case EbvInvocationId: return "InvocationID";
440 case EbvPrimitiveId: return "PrimitiveID";
441 case EbvLayer: return "Layer";
442 case EbvViewportIndex: return "ViewportIndex";
443 case EbvPatchVertices: return "PatchVertices";
444 case EbvTessLevelOuter: return "TessLevelOuter";
445 case EbvTessLevelInner: return "TessLevelInner";
446 case EbvBoundingBox: return "BoundingBox";
447 case EbvTessCoord: return "TessCoord";
448 case EbvColor: return "Color";
449 case EbvSecondaryColor: return "SecondaryColor";
450 case EbvFace: return "Face";
451 case EbvFragCoord: return "FragCoord";
452 case EbvPointCoord: return "PointCoord";
453 case EbvFragColor: return "FragColor";
454 case EbvFragData: return "FragData";
455 case EbvFragDepth: return "FragDepth";
456 case EbvFragStencilRef: return "FragStencilRef";
457 case EbvSampleId: return "SampleId";
458 case EbvSamplePosition: return "SamplePosition";
459 case EbvSampleMask: return "SampleMaskIn";
460 case EbvHelperInvocation: return "HelperInvocation";
462 case EbvBaryCoordNoPersp: return "BaryCoordNoPersp";
463 case EbvBaryCoordNoPerspCentroid: return "BaryCoordNoPerspCentroid";
464 case EbvBaryCoordNoPerspSample: return "BaryCoordNoPerspSample";
465 case EbvBaryCoordSmooth: return "BaryCoordSmooth";
466 case EbvBaryCoordSmoothCentroid: return "BaryCoordSmoothCentroid";
467 case EbvBaryCoordSmoothSample: return "BaryCoordSmoothSample";
468 case EbvBaryCoordPullModel: return "BaryCoordPullModel";
470 case EbvViewIndex: return "ViewIndex";
471 case EbvDeviceIndex: return "DeviceIndex";
473 case EbvFragSizeEXT: return "FragSizeEXT";
474 case EbvFragInvocationCountEXT: return "FragInvocationCountEXT";
476 case EbvSecondaryFragDataEXT: return "SecondaryFragDataEXT";
477 case EbvSecondaryFragColorEXT: return "SecondaryFragColorEXT";
479 case EbvViewportMaskNV: return "ViewportMaskNV";
480 case EbvSecondaryPositionNV: return "SecondaryPositionNV";
481 case EbvSecondaryViewportMaskNV: return "SecondaryViewportMaskNV";
482 case EbvPositionPerViewNV: return "PositionPerViewNV";
483 case EbvViewportMaskPerViewNV: return "ViewportMaskPerViewNV";
484 case EbvFragFullyCoveredNV: return "FragFullyCoveredNV";
485 case EbvFragmentSizeNV: return "FragmentSizeNV";
486 case EbvInvocationsPerPixelNV: return "InvocationsPerPixelNV";
487 case EbvLaunchId: return "LaunchIdNV";
488 case EbvLaunchSize: return "LaunchSizeNV";
489 case EbvInstanceCustomIndex: return "InstanceCustomIndexNV";
490 case EbvGeometryIndex: return "GeometryIndexEXT";
491 case EbvWorldRayOrigin: return "WorldRayOriginNV";
492 case EbvWorldRayDirection: return "WorldRayDirectionNV";
493 case EbvObjectRayOrigin: return "ObjectRayOriginNV";
494 case EbvObjectRayDirection: return "ObjectRayDirectionNV";
495 case EbvRayTmin: return "ObjectRayTminNV";
496 case EbvRayTmax: return "ObjectRayTmaxNV";
497 case EbvHitT: return "HitTNV";
498 case EbvHitKind: return "HitKindNV";
499 case EbvIncomingRayFlags: return "IncomingRayFlagsNV";
500 case EbvObjectToWorld: return "ObjectToWorldNV";
501 case EbvWorldToObject: return "WorldToObjectNV";
502 case EbvCurrentRayTimeNV: return "CurrentRayTimeNV";
504 case EbvBaryCoordEXT:
505 case EbvBaryCoordNV: return "BaryCoordKHR";
506 case EbvBaryCoordNoPerspEXT:
507 case EbvBaryCoordNoPerspNV: return "BaryCoordNoPerspKHR";
509 case EbvTaskCountNV: return "TaskCountNV";
510 case EbvPrimitiveCountNV: return "PrimitiveCountNV";
511 case EbvPrimitiveIndicesNV: return "PrimitiveIndicesNV";
512 case EbvClipDistancePerViewNV: return "ClipDistancePerViewNV";
513 case EbvCullDistancePerViewNV: return "CullDistancePerViewNV";
514 case EbvLayerPerViewNV: return "LayerPerViewNV";
515 case EbvMeshViewCountNV: return "MeshViewCountNV";
516 case EbvMeshViewIndicesNV: return "MeshViewIndicesNV";
517 // GL_EXT_mesh_shader
518 case EbvPrimitivePointIndicesEXT: return "PrimitivePointIndicesEXT";
519 case EbvPrimitiveLineIndicesEXT: return "PrimitiveLineIndicesEXT";
520 case EbvPrimitiveTriangleIndicesEXT: return "PrimitiveTriangleIndicesEXT";
521 case EbvCullPrimitiveEXT: return "CullPrimitiveEXT";
523 case EbvWarpsPerSM: return "WarpsPerSMNV";
524 case EbvSMCount: return "SMCountNV";
525 case EbvWarpID: return "WarpIDNV";
526 case EbvSMID: return "SMIDNV";
528 case EbvShadingRateKHR: return "ShadingRateKHR";
529 case EbvPrimitiveShadingRateKHR: return "PrimitiveShadingRateKHR";
531 default: return "unknown built-in variable";
535 __inline const char* GetPrecisionQualifierString(TPrecisionQualifier p)
538 case EpqNone: return ""; break;
539 case EpqLow: return "lowp"; break;
540 case EpqMedium: return "mediump"; break;
541 case EpqHigh: return "highp"; break;
542 default: return "unknown precision qualifier";
547 __inline bool isTypeSignedInt(TBasicType type)
560 __inline bool isTypeUnsignedInt(TBasicType type)
573 __inline bool isTypeInt(TBasicType type)
575 return isTypeSignedInt(type) || isTypeUnsignedInt(type);
578 __inline bool isTypeFloat(TBasicType type)
590 __inline int getTypeRank(TBasicType type)
617 } // end namespace glslang
619 #endif // _BASICTYPES_INCLUDED_