/* * Mesa 3-D graphics library * * Copyright (C) 1999-2008 Brian Paul All Rights Reserved. * Copyright (C) 2009 VMware, Inc. All Rights Reserved. * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), * to deal in the Software without restriction, including without limitation * the rights to use, copy, modify, merge, publish, distribute, sublicense, * and/or sell copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included * in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR * OTHER DEALINGS IN THE SOFTWARE. */ #ifndef SHADER_ENUMS_H #define SHADER_ENUMS_H #include /* Project-wide (GL and Vulkan) maximum. */ #define MAX_DRAW_BUFFERS 8 #ifdef __cplusplus extern "C" { #endif /** * Shader stages. * * The order must match how shaders are ordered in the pipeline. * The GLSL linker assumes that if i is the maximum number of * invocations in a sub-group. The maximum * supported in this extension is 64." * * The spec defines this as a uniform. However, it's highly unlikely that * implementations actually treat it as a uniform (which is loaded from a * constant buffer). Most likely, this is an implementation-wide constant, * or perhaps something that depends on the shader stage. */ SYSTEM_VALUE_SUBGROUP_SIZE, /** * From the GL_ARB_shader_ballot spec: * * "The variable holds the index of the * invocation within sub-group. This variable is in the range 0 to * -1, where is the total * number of invocations in a sub-group." */ SYSTEM_VALUE_SUBGROUP_INVOCATION, /** * From the GL_ARB_shader_ballot spec: * * "The variables provide a bitmask for all * invocations, with one bit per invocation starting with the least * significant bit, according to the following table, * * variable equation for bit values * -------------------- ------------------------------------ * gl_SubGroupEqMaskARB bit index == gl_SubGroupInvocationARB * gl_SubGroupGeMaskARB bit index >= gl_SubGroupInvocationARB * gl_SubGroupGtMaskARB bit index > gl_SubGroupInvocationARB * gl_SubGroupLeMaskARB bit index <= gl_SubGroupInvocationARB * gl_SubGroupLtMaskARB bit index < gl_SubGroupInvocationARB */ SYSTEM_VALUE_SUBGROUP_EQ_MASK, SYSTEM_VALUE_SUBGROUP_GE_MASK, SYSTEM_VALUE_SUBGROUP_GT_MASK, SYSTEM_VALUE_SUBGROUP_LE_MASK, SYSTEM_VALUE_SUBGROUP_LT_MASK, /*@}*/ /** * Builtin variables added by VK_KHR_subgroups */ /*@{*/ SYSTEM_VALUE_NUM_SUBGROUPS, SYSTEM_VALUE_SUBGROUP_ID, /*@}*/ /*@}*/ /** * \name Vertex shader system values */ /*@{*/ /** * OpenGL-style vertex ID. * * Section 2.11.7 (Shader Execution), subsection Shader Inputs, of the * OpenGL 3.3 core profile spec says: * * "gl_VertexID holds the integer index i implicitly passed by * DrawArrays or one of the other drawing commands defined in section * 2.8.3." * * Section 2.8.3 (Drawing Commands) of the same spec says: * * "The commands....are equivalent to the commands with the same base * name (without the BaseVertex suffix), except that the ith element * transferred by the corresponding draw call will be taken from * element indices[i] + basevertex of each enabled array." * * Additionally, the overview in the GL_ARB_shader_draw_parameters spec * says: * * "In unextended GL, vertex shaders have inputs named gl_VertexID and * gl_InstanceID, which contain, respectively the index of the vertex * and instance. The value of gl_VertexID is the implicitly passed * index of the vertex being processed, which includes the value of * baseVertex, for those commands that accept it." * * gl_VertexID gets basevertex added in. This differs from DirectX where * SV_VertexID does \b not get basevertex added in. * * \note * If all system values are available, \c SYSTEM_VALUE_VERTEX_ID will be * equal to \c SYSTEM_VALUE_VERTEX_ID_ZERO_BASE plus * \c SYSTEM_VALUE_BASE_VERTEX. * * \sa SYSTEM_VALUE_VERTEX_ID_ZERO_BASE, SYSTEM_VALUE_BASE_VERTEX */ SYSTEM_VALUE_VERTEX_ID, /** * Instanced ID as supplied to gl_InstanceID * * Values assigned to gl_InstanceID always begin with zero, regardless of * the value of baseinstance. * * Section 11.1.3.9 (Shader Inputs) of the OpenGL 4.4 core profile spec * says: * * "gl_InstanceID holds the integer instance number of the current * primitive in an instanced draw call (see section 10.5)." * * Through a big chain of pseudocode, section 10.5 describes that * baseinstance is not counted by gl_InstanceID. In that section, notice * * "If an enabled vertex attribute array is instanced (it has a * non-zero divisor as specified by VertexAttribDivisor), the element * index that is transferred to the GL, for all vertices, is given by * * floor(instance/divisor) + baseinstance * * If an array corresponding to an attribute required by a vertex * shader is not enabled, then the corresponding element is taken from * the current attribute state (see section 10.2)." * * Note that baseinstance is \b not included in the value of instance. */ SYSTEM_VALUE_INSTANCE_ID, /** * Vulkan InstanceIndex. * * InstanceIndex = gl_InstanceID + gl_BaseInstance */ SYSTEM_VALUE_INSTANCE_INDEX, /** * DirectX-style vertex ID. * * Unlike \c SYSTEM_VALUE_VERTEX_ID, this system value does \b not include * the value of basevertex. * * \sa SYSTEM_VALUE_VERTEX_ID, SYSTEM_VALUE_BASE_VERTEX */ SYSTEM_VALUE_VERTEX_ID_ZERO_BASE, /** * Value of \c basevertex passed to \c glDrawElementsBaseVertex and similar * functions. * * \sa SYSTEM_VALUE_VERTEX_ID, SYSTEM_VALUE_VERTEX_ID_ZERO_BASE */ SYSTEM_VALUE_BASE_VERTEX, /** * Depending on the type of the draw call (indexed or non-indexed), * is the value of \c basevertex passed to \c glDrawElementsBaseVertex and * similar, or is the value of \c first passed to \c glDrawArrays and * similar. * * \note * It can be used to calculate the \c SYSTEM_VALUE_VERTEX_ID as * \c SYSTEM_VALUE_VERTEX_ID_ZERO_BASE plus \c SYSTEM_VALUE_FIRST_VERTEX. * * \sa SYSTEM_VALUE_VERTEX_ID_ZERO_BASE, SYSTEM_VALUE_VERTEX_ID */ SYSTEM_VALUE_FIRST_VERTEX, /** * If the Draw command used to start the rendering was an indexed draw * or not (~0/0). Useful to calculate \c SYSTEM_VALUE_BASE_VERTEX as * \c SYSTEM_VALUE_IS_INDEXED_DRAW & \c SYSTEM_VALUE_FIRST_VERTEX. */ SYSTEM_VALUE_IS_INDEXED_DRAW, /** * Value of \c baseinstance passed to instanced draw entry points * * \sa SYSTEM_VALUE_INSTANCE_ID */ SYSTEM_VALUE_BASE_INSTANCE, /** * From _ARB_shader_draw_parameters: * * "Additionally, this extension adds a further built-in variable, * gl_DrawID to the shading language. This variable contains the index * of the draw currently being processed by a Multi* variant of a * drawing command (such as MultiDrawElements or * MultiDrawArraysIndirect)." * * If GL_ARB_multi_draw_indirect is not supported, this is always 0. */ SYSTEM_VALUE_DRAW_ID, /*@}*/ /** * \name Geometry shader system values */ /*@{*/ SYSTEM_VALUE_INVOCATION_ID, /**< (Also in Tessellation Control shader) */ /*@}*/ /** * \name Fragment shader system values */ /*@{*/ SYSTEM_VALUE_FRAG_COORD, SYSTEM_VALUE_POINT_COORD, SYSTEM_VALUE_LINE_COORD, /**< Coord along axis perpendicular to line */ SYSTEM_VALUE_FRONT_FACE, SYSTEM_VALUE_SAMPLE_ID, SYSTEM_VALUE_SAMPLE_POS, SYSTEM_VALUE_SAMPLE_MASK_IN, SYSTEM_VALUE_HELPER_INVOCATION, SYSTEM_VALUE_COLOR0, SYSTEM_VALUE_COLOR1, /*@}*/ /** * \name Tessellation Evaluation shader system values */ /*@{*/ SYSTEM_VALUE_TESS_COORD, SYSTEM_VALUE_VERTICES_IN, /**< Tessellation vertices in input patch */ SYSTEM_VALUE_PRIMITIVE_ID, SYSTEM_VALUE_TESS_LEVEL_OUTER, /**< TES input */ SYSTEM_VALUE_TESS_LEVEL_INNER, /**< TES input */ SYSTEM_VALUE_TESS_LEVEL_OUTER_DEFAULT, /**< TCS input for passthru TCS */ SYSTEM_VALUE_TESS_LEVEL_INNER_DEFAULT, /**< TCS input for passthru TCS */ /*@}*/ /** * \name Compute shader system values */ /*@{*/ SYSTEM_VALUE_LOCAL_INVOCATION_ID, SYSTEM_VALUE_LOCAL_INVOCATION_INDEX, SYSTEM_VALUE_GLOBAL_INVOCATION_ID, SYSTEM_VALUE_BASE_GLOBAL_INVOCATION_ID, SYSTEM_VALUE_GLOBAL_INVOCATION_INDEX, SYSTEM_VALUE_WORK_GROUP_ID, SYSTEM_VALUE_NUM_WORK_GROUPS, SYSTEM_VALUE_LOCAL_GROUP_SIZE, SYSTEM_VALUE_GLOBAL_GROUP_SIZE, SYSTEM_VALUE_WORK_DIM, SYSTEM_VALUE_USER_DATA_AMD, /*@}*/ /** Required for VK_KHR_device_group */ SYSTEM_VALUE_DEVICE_INDEX, /** Required for VK_KHX_multiview */ SYSTEM_VALUE_VIEW_INDEX, /** * Driver internal vertex-count, used (for example) for drivers to * calculate stride for stream-out outputs. Not externally visible. */ SYSTEM_VALUE_VERTEX_CNT, /** * Required for AMD_shader_explicit_vertex_parameter and also used for * varying-fetch instructions. * * The _SIZE value is "primitive size", used to scale i/j in primitive * space to pixel space. */ SYSTEM_VALUE_BARYCENTRIC_PERSP_PIXEL, SYSTEM_VALUE_BARYCENTRIC_PERSP_SAMPLE, SYSTEM_VALUE_BARYCENTRIC_PERSP_CENTROID, SYSTEM_VALUE_BARYCENTRIC_PERSP_SIZE, SYSTEM_VALUE_BARYCENTRIC_LINEAR_PIXEL, SYSTEM_VALUE_BARYCENTRIC_LINEAR_CENTROID, SYSTEM_VALUE_BARYCENTRIC_LINEAR_SAMPLE, SYSTEM_VALUE_BARYCENTRIC_PULL_MODEL, /** * \name Ray tracing shader system values */ /*@{*/ SYSTEM_VALUE_RAY_LAUNCH_ID, SYSTEM_VALUE_RAY_LAUNCH_SIZE, SYSTEM_VALUE_RAY_WORLD_ORIGIN, SYSTEM_VALUE_RAY_WORLD_DIRECTION, SYSTEM_VALUE_RAY_OBJECT_ORIGIN, SYSTEM_VALUE_RAY_OBJECT_DIRECTION, SYSTEM_VALUE_RAY_T_MIN, SYSTEM_VALUE_RAY_T_MAX, SYSTEM_VALUE_RAY_OBJECT_TO_WORLD, SYSTEM_VALUE_RAY_WORLD_TO_OBJECT, SYSTEM_VALUE_RAY_HIT_KIND, SYSTEM_VALUE_RAY_FLAGS, SYSTEM_VALUE_RAY_GEOMETRY_INDEX, SYSTEM_VALUE_RAY_INSTANCE_CUSTOM_INDEX, /*@}*/ /** * IR3 specific geometry shader and tesselation control shader system * values that packs invocation id, thread id and vertex id. Having this * as a nir level system value lets us do the unpacking in nir. */ SYSTEM_VALUE_GS_HEADER_IR3, SYSTEM_VALUE_TCS_HEADER_IR3, /** * Fragment shading rate used for KHR_fragment_shading_rate (Vulkan). */ SYSTEM_VALUE_FRAG_SHADING_RATE, SYSTEM_VALUE_MAX /**< Number of values */ } gl_system_value; const char *gl_system_value_name(gl_system_value sysval); /** * The possible interpolation qualifiers that can be applied to a fragment * shader input in GLSL. * * Note: INTERP_MODE_NONE must be 0 so that memsetting the * ir_variable data structure to 0 causes the default behavior. */ enum glsl_interp_mode { INTERP_MODE_NONE = 0, INTERP_MODE_SMOOTH, INTERP_MODE_FLAT, INTERP_MODE_NOPERSPECTIVE, INTERP_MODE_EXPLICIT, INTERP_MODE_COLOR, /**< glShadeModel determines the interp mode */ INTERP_MODE_COUNT /**< Number of interpolation qualifiers */ }; enum glsl_interface_packing { GLSL_INTERFACE_PACKING_STD140, GLSL_INTERFACE_PACKING_SHARED, GLSL_INTERFACE_PACKING_PACKED, GLSL_INTERFACE_PACKING_STD430 }; const char *glsl_interp_mode_name(enum glsl_interp_mode qual); /** * Fragment program results */ typedef enum { FRAG_RESULT_DEPTH = 0, FRAG_RESULT_STENCIL = 1, /* If a single color should be written to all render targets, this * register is written. No FRAG_RESULT_DATAn will be written. */ FRAG_RESULT_COLOR = 2, FRAG_RESULT_SAMPLE_MASK = 3, /* FRAG_RESULT_DATAn are the per-render-target (GLSL gl_FragData[n] * or ARB_fragment_program fragment.color[n]) color results. If * any are written, FRAG_RESULT_COLOR will not be written. * FRAG_RESULT_DATA1 and up are simply for the benefit of * gl_frag_result_name() and not to be construed as an upper bound */ FRAG_RESULT_DATA0 = 4, FRAG_RESULT_DATA1, FRAG_RESULT_DATA2, FRAG_RESULT_DATA3, FRAG_RESULT_DATA4, FRAG_RESULT_DATA5, FRAG_RESULT_DATA6, FRAG_RESULT_DATA7, } gl_frag_result; const char *gl_frag_result_name(gl_frag_result result); #define FRAG_RESULT_MAX (FRAG_RESULT_DATA0 + MAX_DRAW_BUFFERS) /** * \brief Layout qualifiers for gl_FragDepth. * * Extension AMD_conservative_depth allows gl_FragDepth to be redeclared with * a layout qualifier. * * \see enum ir_depth_layout */ enum gl_frag_depth_layout { FRAG_DEPTH_LAYOUT_NONE, /**< No layout is specified. */ FRAG_DEPTH_LAYOUT_ANY, FRAG_DEPTH_LAYOUT_GREATER, FRAG_DEPTH_LAYOUT_LESS, FRAG_DEPTH_LAYOUT_UNCHANGED }; /** * \brief Buffer access qualifiers */ enum gl_access_qualifier { ACCESS_COHERENT = (1 << 0), ACCESS_RESTRICT = (1 << 1), ACCESS_VOLATILE = (1 << 2), /* The memory used by the access/variable is not read. */ ACCESS_NON_READABLE = (1 << 3), /* The memory used by the access/variable is not written. */ ACCESS_NON_WRITEABLE = (1 << 4), /** The access may use a non-uniform buffer or image index */ ACCESS_NON_UNIFORM = (1 << 5), /* This has the same semantics as NIR_INTRINSIC_CAN_REORDER, only to be * used with loads. In other words, it means that the load can be * arbitrarily reordered, or combined with other loads to the same address. * It is implied by ACCESS_NON_WRITEABLE and a lack of ACCESS_VOLATILE. */ ACCESS_CAN_REORDER = (1 << 6), /** Use as little cache space as possible. */ ACCESS_STREAM_CACHE_POLICY = (1 << 7), }; /** * \brief Blend support qualifiers */ enum gl_advanced_blend_mode { BLEND_NONE = 0, BLEND_MULTIPLY, BLEND_SCREEN, BLEND_OVERLAY, BLEND_DARKEN, BLEND_LIGHTEN, BLEND_COLORDODGE, BLEND_COLORBURN, BLEND_HARDLIGHT, BLEND_SOFTLIGHT, BLEND_DIFFERENCE, BLEND_EXCLUSION, BLEND_HSL_HUE, BLEND_HSL_SATURATION, BLEND_HSL_COLOR, BLEND_HSL_LUMINOSITY, }; enum blend_func { BLEND_FUNC_ADD, BLEND_FUNC_SUBTRACT, BLEND_FUNC_REVERSE_SUBTRACT, BLEND_FUNC_MIN, BLEND_FUNC_MAX, }; enum blend_factor { BLEND_FACTOR_ZERO, BLEND_FACTOR_SRC_COLOR, BLEND_FACTOR_SRC1_COLOR, BLEND_FACTOR_DST_COLOR, BLEND_FACTOR_SRC_ALPHA, BLEND_FACTOR_SRC1_ALPHA, BLEND_FACTOR_DST_ALPHA, BLEND_FACTOR_CONSTANT_COLOR, BLEND_FACTOR_CONSTANT_ALPHA, BLEND_FACTOR_SRC_ALPHA_SATURATE, }; enum gl_tess_spacing { TESS_SPACING_UNSPECIFIED, TESS_SPACING_EQUAL, TESS_SPACING_FRACTIONAL_ODD, TESS_SPACING_FRACTIONAL_EVEN, }; /** * A compare function enum for use in compiler lowering passes. This is in * the same order as GL's compare functions (shifted down by GL_NEVER), and is * exactly the same as gallium's PIPE_FUNC_*. */ enum compare_func { COMPARE_FUNC_NEVER, COMPARE_FUNC_LESS, COMPARE_FUNC_EQUAL, COMPARE_FUNC_LEQUAL, COMPARE_FUNC_GREATER, COMPARE_FUNC_NOTEQUAL, COMPARE_FUNC_GEQUAL, COMPARE_FUNC_ALWAYS, }; /** * Arrangements for grouping invocations from NV_compute_shader_derivatives. * * The extension provides new layout qualifiers that support two different * arrangements of compute shader invocations for the purpose of derivative * computation. When specifying * * layout(derivative_group_quadsNV) in; * * compute shader invocations are grouped into 2x2x1 arrays whose four local * invocation ID values follow the pattern: * * +-----------------+------------------+ * | (2x+0, 2y+0, z) | (2x+1, 2y+0, z) | * +-----------------+------------------+ * | (2x+0, 2y+1, z) | (2x+1, 2y+1, z) | * +-----------------+------------------+ * * where Y increases from bottom to top. When specifying * * layout(derivative_group_linearNV) in; * * compute shader invocations are grouped into 2x2x1 arrays whose four local * invocation index values follow the pattern: * * +------+------+ * | 4n+0 | 4n+1 | * +------+------+ * | 4n+2 | 4n+3 | * +------+------+ * * If neither layout qualifier is specified, derivatives in compute shaders * return zero, which is consistent with the handling of built-in texture * functions like texture() in GLSL 4.50 compute shaders. */ enum gl_derivative_group { DERIVATIVE_GROUP_NONE = 0, DERIVATIVE_GROUP_QUADS, DERIVATIVE_GROUP_LINEAR, }; enum float_controls { FLOAT_CONTROLS_DEFAULT_FLOAT_CONTROL_MODE = 0x0000, FLOAT_CONTROLS_DENORM_PRESERVE_FP16 = 0x0001, FLOAT_CONTROLS_DENORM_PRESERVE_FP32 = 0x0002, FLOAT_CONTROLS_DENORM_PRESERVE_FP64 = 0x0004, FLOAT_CONTROLS_DENORM_FLUSH_TO_ZERO_FP16 = 0x0008, FLOAT_CONTROLS_DENORM_FLUSH_TO_ZERO_FP32 = 0x0010, FLOAT_CONTROLS_DENORM_FLUSH_TO_ZERO_FP64 = 0x0020, FLOAT_CONTROLS_SIGNED_ZERO_INF_NAN_PRESERVE_FP16 = 0x0040, FLOAT_CONTROLS_SIGNED_ZERO_INF_NAN_PRESERVE_FP32 = 0x0080, FLOAT_CONTROLS_SIGNED_ZERO_INF_NAN_PRESERVE_FP64 = 0x0100, FLOAT_CONTROLS_ROUNDING_MODE_RTE_FP16 = 0x0200, FLOAT_CONTROLS_ROUNDING_MODE_RTE_FP32 = 0x0400, FLOAT_CONTROLS_ROUNDING_MODE_RTE_FP64 = 0x0800, FLOAT_CONTROLS_ROUNDING_MODE_RTZ_FP16 = 0x1000, FLOAT_CONTROLS_ROUNDING_MODE_RTZ_FP32 = 0x2000, FLOAT_CONTROLS_ROUNDING_MODE_RTZ_FP64 = 0x4000, }; /** * Enums to describe sampler properties used by OpenCL's inline constant samplers. * These values match the meanings described in the SPIR-V spec. */ enum cl_sampler_addressing_mode { SAMPLER_ADDRESSING_MODE_NONE = 0, SAMPLER_ADDRESSING_MODE_CLAMP_TO_EDGE = 1, SAMPLER_ADDRESSING_MODE_CLAMP = 2, SAMPLER_ADDRESSING_MODE_REPEAT = 3, SAMPLER_ADDRESSING_MODE_REPEAT_MIRRORED = 4, }; enum cl_sampler_filter_mode { SAMPLER_FILTER_MODE_NEAREST = 0, SAMPLER_FILTER_MODE_LINEAR = 1, }; #ifdef __cplusplus } /* extern "C" */ #endif #endif /* SHADER_ENUMS_H */