#include <stdbool.h>
#include <stdint.h>
#include <stddef.h>
#include <vkd3d_types.h>

Include dependency graph for vkd3d_shader.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	vkd3d_shader_compile_option

struct	vkd3d_shader_code

struct	vkd3d_shader_descriptor_binding

struct	vkd3d_shader_parameter_immediate_constant

struct	vkd3d_shader_parameter_immediate_constant1

struct	vkd3d_shader_parameter_specialization_constant

struct	vkd3d_shader_parameter_buffer

struct	vkd3d_shader_parameter

struct	vkd3d_shader_parameter1

struct	vkd3d_shader_resource_binding

struct	vkd3d_shader_combined_resource_sampler

struct	vkd3d_shader_uav_counter_binding

struct	vkd3d_shader_push_constant_buffer

struct	vkd3d_shader_interface_info

struct	vkd3d_shader_transform_feedback_element

struct	vkd3d_shader_transform_feedback_info

struct	vkd3d_shader_descriptor_offset

struct	vkd3d_shader_descriptor_offset_info

struct	vkd3d_shader_compile_info

struct	vkd3d_shader_spirv_target_info

struct	vkd3d_shader_spirv_domain_shader_target_info

struct	vkd3d_shader_macro

struct	vkd3d_shader_preprocess_info

struct	vkd3d_shader_hlsl_source_info

struct	vkd3d_shader_static_sampler_desc

struct	vkd3d_shader_descriptor_range

struct	vkd3d_shader_root_descriptor_table

struct	vkd3d_shader_root_constants

struct	vkd3d_shader_root_descriptor

struct	vkd3d_shader_root_parameter

struct	vkd3d_shader_root_signature_desc

struct	vkd3d_shader_descriptor_range1

struct	vkd3d_shader_root_descriptor_table1

struct	vkd3d_shader_root_descriptor1

struct	vkd3d_shader_root_parameter1

struct	vkd3d_shader_root_signature_desc1

struct	vkd3d_shader_versioned_root_signature_desc

struct	vkd3d_shader_descriptor_info

struct	vkd3d_shader_scan_descriptor_info

struct	vkd3d_shader_combined_resource_sampler_info

struct	vkd3d_shader_scan_combined_resource_sampler_info

struct	vkd3d_shader_signature_element

struct	vkd3d_shader_signature

struct	vkd3d_shader_dxbc_section_desc

struct	vkd3d_shader_dxbc_desc

struct	vkd3d_shader_scan_signature_info

struct	vkd3d_shader_varying_map

struct	vkd3d_shader_varying_map_info

struct	vkd3d_shader_parameter_info

Macros
#define	VKD3D_SHADER_DUMMY_SAMPLER_INDEX ~0u

#define	VKD3D_SHADER_SWIZZLE_MASK (0xffu)

#define	VKD3D_SHADER_SWIZZLE_SHIFT(idx) (8u * (idx))

#define	VKD3D_SHADER_SWIZZLE(x, y, z, w)

#define	VKD3D_SHADER_NO_SWIZZLE VKD3D_SHADER_SWIZZLE(X, Y, Z, W)

#define	VKD3D_SHADER_API VKD3D_IMPORT

Typedefs
typedef int(*	PFN_vkd3d_shader_open_include) (const char filename, bool local, const char parent_data, void context, struct vkd3d_shader_code out)

typedef void(*	PFN_vkd3d_shader_close_include) (const struct vkd3d_shader_code code, void context)

typedef const char (	PFN_vkd3d_shader_get_version) (unsigned int major, unsigned int minor)

typedef enum vkd3d_shader_source_type (	PFN_vkd3d_shader_get_supported_source_types) (unsigned int *count)

typedef enum vkd3d_shader_target_type (	PFN_vkd3d_shader_get_supported_target_types) (enum vkd3d_shader_source_type source_type, unsigned int *count)

typedef int(*	PFN_vkd3d_shader_compile) (const struct vkd3d_shader_compile_info compile_info, struct vkd3d_shader_code out, char **messages)

typedef void(*	PFN_vkd3d_shader_free_messages) (char *messages)

typedef void(*	PFN_vkd3d_shader_free_shader_code) (struct vkd3d_shader_code *code)

typedef int(*	PFN_vkd3d_shader_parse_root_signature) (const struct vkd3d_shader_code dxbc, struct vkd3d_shader_versioned_root_signature_desc root_signature, char **messages)

typedef void(*	PFN_vkd3d_shader_free_root_signature) (struct vkd3d_shader_versioned_root_signature_desc *root_signature)

typedef int(*	PFN_vkd3d_shader_serialize_root_signature) (const struct vkd3d_shader_versioned_root_signature_desc root_signature, struct vkd3d_shader_code dxbc, char **messages)

typedef int(*	PFN_vkd3d_shader_convert_root_signature) (struct vkd3d_shader_versioned_root_signature_desc dst, enum vkd3d_shader_root_signature_version version, const struct vkd3d_shader_versioned_root_signature_desc src)

typedef int(*	PFN_vkd3d_shader_scan) (const struct vkd3d_shader_compile_info compile_info, char *messages)

typedef void(*	PFN_vkd3d_shader_free_scan_descriptor_info) (struct vkd3d_shader_scan_descriptor_info *scan_descriptor_info)

typedef int(*	PFN_vkd3d_shader_parse_input_signature) (const struct vkd3d_shader_code dxbc, struct vkd3d_shader_signature signature, char **messages)

typedef struct vkd3d_shader_signature_element (	PFN_vkd3d_shader_find_signature_element) (const struct vkd3d_shader_signature signature, const char semantic_name, unsigned int semantic_index, unsigned int stream_index)

typedef void(*	PFN_vkd3d_shader_free_shader_signature) (struct vkd3d_shader_signature *signature)

typedef void(*	PFN_vkd3d_shader_preprocess) (struct vkd3d_shader_compile_info compile_info, struct vkd3d_shader_code out, char **messages)

typedef void(*	PFN_vkd3d_shader_set_log_callback) (PFN_vkd3d_log callback)

typedef void(*	PFN_vkd3d_shader_free_dxbc) (struct vkd3d_shader_dxbc_desc *dxbc)

typedef int(*	PFN_vkd3d_shader_parse_dxbc) (const struct vkd3d_shader_code dxbc, uint32_t flags, struct vkd3d_shader_dxbc_desc desc, char **messages)

typedef int(*	PFN_vkd3d_shader_serialize_dxbc) (size_t section_count, const struct vkd3d_shader_dxbc_section_desc sections, struct vkd3d_shader_code dxbc, char **messages)

typedef void(*	PFN_vkd3d_shader_build_varying_map) (const struct vkd3d_shader_signature output_signature, const struct vkd3d_shader_signature input_signature, unsigned int count, struct vkd3d_shader_varying_map varyings)

typedef void(*	PFN_vkd3d_shader_free_scan_signature_info) (struct vkd3d_shader_scan_signature_info *info)

typedef void(*	PFN_vkd3d_shader_free_scan_combined_resource_sampler_info) (struct vkd3d_shader_scan_combined_resource_sampler_info *info)

Enumerations
enum	vkd3d_shader_api_version { VKD3D_SHADER_API_VERSION_1_0 , VKD3D_SHADER_API_VERSION_1_1 , VKD3D_SHADER_API_VERSION_1_2 , VKD3D_SHADER_API_VERSION_1_3 , VKD3D_SHADER_API_VERSION_1_4 , VKD3D_SHADER_API_VERSION_1_5 , VKD3D_SHADER_API_VERSION_1_6 , VKD3D_SHADER_API_VERSION_1_7 , VKD3D_SHADER_API_VERSION_1_8 , VKD3D_SHADER_API_VERSION_1_9 , VKD3D_SHADER_API_VERSION_1_10 , VKD3D_SHADER_API_VERSION_1_11 , VKD3D_SHADER_API_VERSION_1_12 , VKD3D_SHADER_API_VERSION_1_13 , VKD3D_SHADER_API_VERSION_1_14 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_structure_type { VKD3D_SHADER_STRUCTURE_TYPE_COMPILE_INFO , VKD3D_SHADER_STRUCTURE_TYPE_INTERFACE_INFO , VKD3D_SHADER_STRUCTURE_TYPE_SCAN_DESCRIPTOR_INFO , VKD3D_SHADER_STRUCTURE_TYPE_SPIRV_DOMAIN_SHADER_TARGET_INFO , VKD3D_SHADER_STRUCTURE_TYPE_SPIRV_TARGET_INFO , VKD3D_SHADER_STRUCTURE_TYPE_TRANSFORM_FEEDBACK_INFO , VKD3D_SHADER_STRUCTURE_TYPE_HLSL_SOURCE_INFO , VKD3D_SHADER_STRUCTURE_TYPE_PREPROCESS_INFO , VKD3D_SHADER_STRUCTURE_TYPE_DESCRIPTOR_OFFSET_INFO , VKD3D_SHADER_STRUCTURE_TYPE_SCAN_SIGNATURE_INFO , VKD3D_SHADER_STRUCTURE_TYPE_VARYING_MAP_INFO , VKD3D_SHADER_STRUCTURE_TYPE_SCAN_COMBINED_RESOURCE_SAMPLER_INFO , VKD3D_SHADER_STRUCTURE_TYPE_PARAMETER_INFO , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_compile_option_buffer_uav { VKD3D_SHADER_COMPILE_OPTION_BUFFER_UAV_STORAGE_TEXEL_BUFFER = 0x00000000 , VKD3D_SHADER_COMPILE_OPTION_BUFFER_UAV_STORAGE_BUFFER = 0x00000001 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_compile_option_typed_uav { VKD3D_SHADER_COMPILE_OPTION_TYPED_UAV_READ_FORMAT_R32 = 0x00000000 , VKD3D_SHADER_COMPILE_OPTION_TYPED_UAV_READ_FORMAT_UNKNOWN = 0x00000001 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_compile_option_formatting_flags { VKD3D_SHADER_COMPILE_OPTION_FORMATTING_NONE = 0x00000000 , VKD3D_SHADER_COMPILE_OPTION_FORMATTING_COLOUR = 0x00000001 , VKD3D_SHADER_COMPILE_OPTION_FORMATTING_INDENT = 0x00000002 , VKD3D_SHADER_COMPILE_OPTION_FORMATTING_OFFSETS = 0x00000004 , VKD3D_SHADER_COMPILE_OPTION_FORMATTING_HEADER = 0x00000008 , VKD3D_SHADER_COMPILE_OPTION_FORMATTING_RAW_IDS = 0x00000010 , VKD3D_SHADER_COMPILE_OPTION_FORMATTING_IO_SIGNATURES = 0x00000020 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_compile_option_pack_matrix_order { VKD3D_SHADER_COMPILE_OPTION_PACK_MATRIX_ROW_MAJOR = 0x00000001 , VKD3D_SHADER_COMPILE_OPTION_PACK_MATRIX_COLUMN_MAJOR = 0x00000002 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_compile_option_backward_compatibility { VKD3D_SHADER_COMPILE_OPTION_BACKCOMPAT_MAP_SEMANTIC_NAMES = 0x00000001 , VKD3D_SHADER_COMPILE_OPTION_DOUBLE_AS_FLOAT_ALIAS = 0x00000002 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_compile_option_fragment_coordinate_origin { VKD3D_SHADER_COMPILE_OPTION_FRAGMENT_COORDINATE_ORIGIN_UPPER_LEFT = 0x00000000 , VKD3D_SHADER_COMPILE_OPTION_FRAGMENT_COORDINATE_ORIGIN_LOWER_LEFT = 0x00000001 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_compile_option_feature_flags { VKD3D_SHADER_COMPILE_OPTION_FEATURE_INT64 = 0x00000001 , VKD3D_SHADER_COMPILE_OPTION_FEATURE_FLOAT64 = 0x00000002 , VKD3D_SHADER_COMPILE_OPTION_FEATURE_WAVE_OPS = 0x00000004 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_parse_dxbc_flags { VKD3D_SHADER_PARSE_DXBC_IGNORE_CHECKSUM = 0x00000001 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_compile_option_name { VKD3D_SHADER_COMPILE_OPTION_STRIP_DEBUG = 0x00000001 , VKD3D_SHADER_COMPILE_OPTION_BUFFER_UAV = 0x00000002 , VKD3D_SHADER_COMPILE_OPTION_FORMATTING = 0x00000003 , VKD3D_SHADER_COMPILE_OPTION_API_VERSION = 0x00000004 , VKD3D_SHADER_COMPILE_OPTION_TYPED_UAV = 0x00000005 , VKD3D_SHADER_COMPILE_OPTION_WRITE_TESS_GEOM_POINT_SIZE = 0x00000006 , VKD3D_SHADER_COMPILE_OPTION_PACK_MATRIX_ORDER = 0x00000007 , VKD3D_SHADER_COMPILE_OPTION_BACKWARD_COMPATIBILITY = 0x00000008 , VKD3D_SHADER_COMPILE_OPTION_FRAGMENT_COORDINATE_ORIGIN = 0x00000009 , VKD3D_SHADER_COMPILE_OPTION_FEATURE = 0x0000000a , VKD3D_SHADER_COMPILE_OPTION_CHILD_EFFECT = 0x0000000b , VKD3D_SHADER_COMPILE_OPTION_WARN_IMPLICIT_TRUNCATION = 0x0000000c , VKD3D_SHADER_COMPILE_OPTION_INCLUDE_EMPTY_BUFFERS_IN_EFFECTS = 0x0000000d , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_visibility { VKD3D_SHADER_VISIBILITY_ALL = 0 , VKD3D_SHADER_VISIBILITY_VERTEX = 1 , VKD3D_SHADER_VISIBILITY_HULL = 2 , VKD3D_SHADER_VISIBILITY_DOMAIN = 3 , VKD3D_SHADER_VISIBILITY_GEOMETRY = 4 , VKD3D_SHADER_VISIBILITY_PIXEL = 5 , VKD3D_SHADER_VISIBILITY_COMPUTE = 1000000000 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_descriptor_type { VKD3D_SHADER_DESCRIPTOR_TYPE_SRV = 0x0 , VKD3D_SHADER_DESCRIPTOR_TYPE_UAV = 0x1 , VKD3D_SHADER_DESCRIPTOR_TYPE_CBV = 0x2 , VKD3D_SHADER_DESCRIPTOR_TYPE_SAMPLER = 0x3 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_binding_flag { VKD3D_SHADER_BINDING_FLAG_BUFFER = 0x00000001 , VKD3D_SHADER_BINDING_FLAG_IMAGE = 0x00000002 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_parameter_type { VKD3D_SHADER_PARAMETER_TYPE_UNKNOWN , VKD3D_SHADER_PARAMETER_TYPE_IMMEDIATE_CONSTANT , VKD3D_SHADER_PARAMETER_TYPE_SPECIALIZATION_CONSTANT , VKD3D_SHADER_PARAMETER_TYPE_BUFFER , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_parameter_data_type { VKD3D_SHADER_PARAMETER_DATA_TYPE_UNKNOWN , VKD3D_SHADER_PARAMETER_DATA_TYPE_UINT32 , VKD3D_SHADER_PARAMETER_DATA_TYPE_FLOAT32 , VKD3D_SHADER_PARAMETER_DATA_TYPE_FLOAT32_VEC4 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_parameter_name { VKD3D_SHADER_PARAMETER_NAME_UNKNOWN , VKD3D_SHADER_PARAMETER_NAME_RASTERIZER_SAMPLE_COUNT , VKD3D_SHADER_PARAMETER_NAME_ALPHA_TEST_FUNC , VKD3D_SHADER_PARAMETER_NAME_ALPHA_TEST_REF , VKD3D_SHADER_PARAMETER_NAME_FLAT_INTERPOLATION , VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_MASK , VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_0 , VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_1 , VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_2 , VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_3 , VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_4 , VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_5 , VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_6 , VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_7 , VKD3D_SHADER_PARAMETER_NAME_POINT_SIZE , VKD3D_SHADER_PARAMETER_NAME_POINT_SIZE_MIN , VKD3D_SHADER_PARAMETER_NAME_POINT_SIZE_MAX , VKD3D_SHADER_PARAMETER_NAME_POINT_SPRITE , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_d3dbc_constant_register { VKD3D_SHADER_D3DBC_FLOAT_CONSTANT_REGISTER = 0x0 , VKD3D_SHADER_D3DBC_INT_CONSTANT_REGISTER = 0x1 , VKD3D_SHADER_D3DBC_BOOL_CONSTANT_REGISTER = 0x2 }

enum	vkd3d_shader_source_type { VKD3D_SHADER_SOURCE_NONE , VKD3D_SHADER_SOURCE_DXBC_TPF , VKD3D_SHADER_SOURCE_HLSL , VKD3D_SHADER_SOURCE_D3D_BYTECODE , VKD3D_SHADER_SOURCE_DXBC_DXIL , VKD3D_SHADER_SOURCE_FX , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_target_type { VKD3D_SHADER_TARGET_NONE , VKD3D_SHADER_TARGET_SPIRV_BINARY , VKD3D_SHADER_TARGET_SPIRV_TEXT , VKD3D_SHADER_TARGET_D3D_ASM , VKD3D_SHADER_TARGET_D3D_BYTECODE , VKD3D_SHADER_TARGET_DXBC_TPF , VKD3D_SHADER_TARGET_GLSL , VKD3D_SHADER_TARGET_FX , VKD3D_SHADER_TARGET_MSL , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_log_level { VKD3D_SHADER_LOG_NONE , VKD3D_SHADER_LOG_ERROR , VKD3D_SHADER_LOG_WARNING , VKD3D_SHADER_LOG_INFO , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_spirv_environment { VKD3D_SHADER_SPIRV_ENVIRONMENT_NONE , VKD3D_SHADER_SPIRV_ENVIRONMENT_OPENGL_4_5 , VKD3D_SHADER_SPIRV_ENVIRONMENT_VULKAN_1_0 , VKD3D_SHADER_SPIRV_ENVIRONMENT_VULKAN_1_1 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_spirv_extension { VKD3D_SHADER_SPIRV_EXTENSION_NONE , VKD3D_SHADER_SPIRV_EXTENSION_EXT_DEMOTE_TO_HELPER_INVOCATION , VKD3D_SHADER_SPIRV_EXTENSION_EXT_DESCRIPTOR_INDEXING , VKD3D_SHADER_SPIRV_EXTENSION_EXT_STENCIL_EXPORT , VKD3D_SHADER_SPIRV_EXTENSION_EXT_VIEWPORT_INDEX_LAYER , VKD3D_SHADER_SPIRV_EXTENSION_EXT_FRAGMENT_SHADER_INTERLOCK , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_tessellator_output_primitive { VKD3D_SHADER_TESSELLATOR_OUTPUT_POINT = 0x1 , VKD3D_SHADER_TESSELLATOR_OUTPUT_LINE = 0x2 , VKD3D_SHADER_TESSELLATOR_OUTPUT_TRIANGLE_CW = 0x3 , VKD3D_SHADER_TESSELLATOR_OUTPUT_TRIANGLE_CCW = 0x4 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_tessellator_partitioning { VKD3D_SHADER_TESSELLATOR_PARTITIONING_INTEGER = 0x1 , VKD3D_SHADER_TESSELLATOR_PARTITIONING_POW2 = 0x2 , VKD3D_SHADER_TESSELLATOR_PARTITIONING_FRACTIONAL_ODD = 0x3 , VKD3D_SHADER_TESSELLATOR_PARTITIONING_FRACTIONAL_EVEN = 0x4 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_filter { VKD3D_SHADER_FILTER_MIN_MAG_MIP_POINT = 0x000 , VKD3D_SHADER_FILTER_MIN_MAG_POINT_MIP_LINEAR = 0x001 , VKD3D_SHADER_FILTER_MIN_POINT_MAG_LINEAR_MIP_POINT = 0x004 , VKD3D_SHADER_FILTER_MIN_POINT_MAG_MIP_LINEAR = 0x005 , VKD3D_SHADER_FILTER_MIN_LINEAR_MAG_MIP_POINT = 0x010 , VKD3D_SHADER_FILTER_MIN_LINEAR_MAG_POINT_MIP_LINEAR = 0x011 , VKD3D_SHADER_FILTER_MIN_MAG_LINEAR_MIP_POINT = 0x014 , VKD3D_SHADER_FILTER_MIN_MAG_MIP_LINEAR = 0x015 , VKD3D_SHADER_FILTER_ANISOTROPIC = 0x055 , VKD3D_SHADER_FILTER_COMPARISON_MIN_MAG_MIP_POINT = 0x080 , VKD3D_SHADER_FILTER_COMPARISON_MIN_MAG_POINT_MIP_LINEAR = 0x081 , VKD3D_SHADER_FILTER_COMPARISON_MIN_POINT_MAG_LINEAR_MIP_POINT = 0x084 , VKD3D_SHADER_FILTER_COMPARISON_MIN_POINT_MAG_MIP_LINEAR = 0x085 , VKD3D_SHADER_FILTER_COMPARISON_MIN_LINEAR_MAG_MIP_POINT = 0x090 , VKD3D_SHADER_FILTER_COMPARISON_MIN_LINEAR_MAG_POINT_MIP_LINEAR = 0x091 , VKD3D_SHADER_FILTER_COMPARISON_MIN_MAG_LINEAR_MIP_POINT = 0x094 , VKD3D_SHADER_FILTER_COMPARISON_MIN_MAG_MIP_LINEAR = 0x095 , VKD3D_SHADER_FILTER_COMPARISON_ANISOTROPIC = 0x0d5 , VKD3D_SHADER_FILTER_MINIMUM_MIN_MAG_MIP_POINT = 0x100 , VKD3D_SHADER_FILTER_MINIMUM_MIN_MAG_POINT_MIP_LINEAR = 0x101 , VKD3D_SHADER_FILTER_MINIMUM_MIN_POINT_MAG_LINEAR_MIP_POINT = 0x104 , VKD3D_SHADER_FILTER_MINIMUM_MIN_POINT_MAG_MIP_LINEAR = 0x105 , VKD3D_SHADER_FILTER_MINIMUM_MIN_LINEAR_MAG_MIP_POINT = 0x110 , VKD3D_SHADER_FILTER_MINIMUM_MIN_LINEAR_MAG_POINT_MIP_LINEAR = 0x111 , VKD3D_SHADER_FILTER_MINIMUM_MIN_MAG_LINEAR_MIP_POINT = 0x114 , VKD3D_SHADER_FILTER_MINIMUM_MIN_MAG_MIP_LINEAR = 0x115 , VKD3D_SHADER_FILTER_MINIMUM_ANISOTROPIC = 0x155 , VKD3D_SHADER_FILTER_MAXIMUM_MIN_MAG_MIP_POINT = 0x180 , VKD3D_SHADER_FILTER_MAXIMUM_MIN_MAG_POINT_MIP_LINEAR = 0x181 , VKD3D_SHADER_FILTER_MAXIMUM_MIN_POINT_MAG_LINEAR_MIP_POINT = 0x184 , VKD3D_SHADER_FILTER_MAXIMUM_MIN_POINT_MAG_MIP_LINEAR = 0x185 , VKD3D_SHADER_FILTER_MAXIMUM_MIN_LINEAR_MAG_MIP_POINT = 0x190 , VKD3D_SHADER_FILTER_MAXIMUM_MIN_LINEAR_MAG_POINT_MIP_LINEAR = 0x191 , VKD3D_SHADER_FILTER_MAXIMUM_MIN_MAG_LINEAR_MIP_POINT = 0x194 , VKD3D_SHADER_FILTER_MAXIMUM_MIN_MAG_MIP_LINEAR = 0x195 , VKD3D_SHADER_FILTER_MAXIMUM_ANISOTROPIC = 0x1d5 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_texture_address_mode { VKD3D_SHADER_TEXTURE_ADDRESS_MODE_WRAP = 0x1 , VKD3D_SHADER_TEXTURE_ADDRESS_MODE_MIRROR = 0x2 , VKD3D_SHADER_TEXTURE_ADDRESS_MODE_CLAMP = 0x3 , VKD3D_SHADER_TEXTURE_ADDRESS_MODE_BORDER = 0x4 , VKD3D_SHADER_TEXTURE_ADDRESS_MODE_MIRROR_ONCE = 0x5 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_comparison_func { VKD3D_SHADER_COMPARISON_FUNC_NEVER = 0x1 , VKD3D_SHADER_COMPARISON_FUNC_LESS = 0x2 , VKD3D_SHADER_COMPARISON_FUNC_EQUAL = 0x3 , VKD3D_SHADER_COMPARISON_FUNC_LESS_EQUAL = 0x4 , VKD3D_SHADER_COMPARISON_FUNC_GREATER = 0x5 , VKD3D_SHADER_COMPARISON_FUNC_NOT_EQUAL = 0x6 , VKD3D_SHADER_COMPARISON_FUNC_GREATER_EQUAL = 0x7 , VKD3D_SHADER_COMPARISON_FUNC_ALWAYS = 0x8 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_static_border_colour { VKD3D_SHADER_STATIC_BORDER_COLOUR_TRANSPARENT_BLACK = 0x0 , VKD3D_SHADER_STATIC_BORDER_COLOUR_OPAQUE_BLACK = 0x1 , VKD3D_SHADER_STATIC_BORDER_COLOUR_OPAQUE_WHITE = 0x2 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_root_parameter_type { VKD3D_SHADER_ROOT_PARAMETER_TYPE_DESCRIPTOR_TABLE = 0x0 , VKD3D_SHADER_ROOT_PARAMETER_TYPE_32BIT_CONSTANTS = 0x1 , VKD3D_SHADER_ROOT_PARAMETER_TYPE_CBV = 0x2 , VKD3D_SHADER_ROOT_PARAMETER_TYPE_SRV = 0x3 , VKD3D_SHADER_ROOT_PARAMETER_TYPE_UAV = 0x4 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_root_signature_flags { VKD3D_SHADER_ROOT_SIGNATURE_FLAG_NONE = 0x00 , VKD3D_SHADER_ROOT_SIGNATURE_FLAG_ALLOW_INPUT_ASSEMBLER_INPUT_LAYOUT = 0x01 , VKD3D_SHADER_ROOT_SIGNATURE_FLAG_DENY_VERTEX_SHADER_ROOT_ACCESS = 0x02 , VKD3D_SHADER_ROOT_SIGNATURE_FLAG_DENY_HULL_SHADER_ROOT_ACCESS = 0x04 , VKD3D_SHADER_ROOT_SIGNATURE_FLAG_DENY_DOMAIN_SHADER_ROOT_ACCESS = 0x08 , VKD3D_SHADER_ROOT_SIGNATURE_FLAG_DENY_GEOMETRY_SHADER_ROOT_ACCESS = 0x10 , VKD3D_SHADER_ROOT_SIGNATURE_FLAG_DENY_PIXEL_SHADER_ROOT_ACCESS = 0x20 , VKD3D_SHADER_ROOT_SIGNATURE_FLAG_ALLOW_STREAM_OUTPUT = 0x40 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_root_descriptor_flags { VKD3D_SHADER_ROOT_DESCRIPTOR_FLAG_NONE = 0x0 , VKD3D_SHADER_ROOT_DESCRIPTOR_FLAG_DATA_VOLATILE = 0x2 , VKD3D_SHADER_ROOT_DESCRIPTOR_FLAG_DATA_STATIC_WHILE_SET_AT_EXECUTE = 0x4 , VKD3D_SHADER_ROOT_DESCRIPTOR_FLAG_DATA_STATIC = 0x8 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_descriptor_range_flags { VKD3D_SHADER_DESCRIPTOR_RANGE_FLAG_NONE = 0x0 , VKD3D_SHADER_DESCRIPTOR_RANGE_FLAG_DESCRIPTORS_VOLATILE = 0x1 , VKD3D_SHADER_DESCRIPTOR_RANGE_FLAG_DATA_VOLATILE = 0x2 , VKD3D_SHADER_DESCRIPTOR_RANGE_FLAG_DATA_STATIC_WHILE_SET_AT_EXECUTE = 0x4 , VKD3D_SHADER_DESCRIPTOR_RANGE_FLAG_DATA_STATIC = 0x8 , VKD3D_SHADER_DESCRIPTOR_RANGE_FLAG_DESCRIPTORS_STATIC_KEEPING_BUFFER_BOUNDS_CHECKS = 0x10000 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_root_signature_version { VKD3D_SHADER_ROOT_SIGNATURE_VERSION_1_0 = 0x1 , VKD3D_SHADER_ROOT_SIGNATURE_VERSION_1_1 = 0x2 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_resource_type { VKD3D_SHADER_RESOURCE_NONE = 0x0 , VKD3D_SHADER_RESOURCE_BUFFER = 0x1 , VKD3D_SHADER_RESOURCE_TEXTURE_1D = 0x2 , VKD3D_SHADER_RESOURCE_TEXTURE_2D = 0x3 , VKD3D_SHADER_RESOURCE_TEXTURE_2DMS = 0x4 , VKD3D_SHADER_RESOURCE_TEXTURE_3D = 0x5 , VKD3D_SHADER_RESOURCE_TEXTURE_CUBE = 0x6 , VKD3D_SHADER_RESOURCE_TEXTURE_1DARRAY = 0x7 , VKD3D_SHADER_RESOURCE_TEXTURE_2DARRAY = 0x8 , VKD3D_SHADER_RESOURCE_TEXTURE_2DMSARRAY = 0x9 , VKD3D_SHADER_RESOURCE_TEXTURE_CUBEARRAY = 0xa , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_resource_data_type { VKD3D_SHADER_RESOURCE_DATA_UNORM = 0x1 , VKD3D_SHADER_RESOURCE_DATA_SNORM = 0x2 , VKD3D_SHADER_RESOURCE_DATA_INT = 0x3 , VKD3D_SHADER_RESOURCE_DATA_UINT = 0x4 , VKD3D_SHADER_RESOURCE_DATA_FLOAT = 0x5 , VKD3D_SHADER_RESOURCE_DATA_MIXED = 0x6 , VKD3D_SHADER_RESOURCE_DATA_DOUBLE = 0x7 , VKD3D_SHADER_RESOURCE_DATA_CONTINUED = 0x8 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_descriptor_info_flag { VKD3D_SHADER_DESCRIPTOR_INFO_FLAG_UAV_COUNTER = 0x00000001 , VKD3D_SHADER_DESCRIPTOR_INFO_FLAG_UAV_READ = 0x00000002 , VKD3D_SHADER_DESCRIPTOR_INFO_FLAG_SAMPLER_COMPARISON_MODE = 0x00000004 , VKD3D_SHADER_DESCRIPTOR_INFO_FLAG_UAV_ATOMICS = 0x00000008 , VKD3D_SHADER_DESCRIPTOR_INFO_FLAG_RAW_BUFFER = 0x00000010 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_component_type { VKD3D_SHADER_COMPONENT_VOID = 0x0 , VKD3D_SHADER_COMPONENT_UINT = 0x1 , VKD3D_SHADER_COMPONENT_INT = 0x2 , VKD3D_SHADER_COMPONENT_FLOAT = 0x3 , VKD3D_SHADER_COMPONENT_BOOL = 0x4 , VKD3D_SHADER_COMPONENT_DOUBLE = 0x5 , VKD3D_SHADER_COMPONENT_UINT64 = 0x6 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_sysval_semantic { VKD3D_SHADER_SV_NONE = 0x00 , VKD3D_SHADER_SV_POSITION = 0x01 , VKD3D_SHADER_SV_CLIP_DISTANCE = 0x02 , VKD3D_SHADER_SV_CULL_DISTANCE = 0x03 , VKD3D_SHADER_SV_RENDER_TARGET_ARRAY_INDEX = 0x04 , VKD3D_SHADER_SV_VIEWPORT_ARRAY_INDEX = 0x05 , VKD3D_SHADER_SV_VERTEX_ID = 0x06 , VKD3D_SHADER_SV_PRIMITIVE_ID = 0x07 , VKD3D_SHADER_SV_INSTANCE_ID = 0x08 , VKD3D_SHADER_SV_IS_FRONT_FACE = 0x09 , VKD3D_SHADER_SV_SAMPLE_INDEX = 0x0a , VKD3D_SHADER_SV_TESS_FACTOR_QUADEDGE = 0x0b , VKD3D_SHADER_SV_TESS_FACTOR_QUADINT = 0x0c , VKD3D_SHADER_SV_TESS_FACTOR_TRIEDGE = 0x0d , VKD3D_SHADER_SV_TESS_FACTOR_TRIINT = 0x0e , VKD3D_SHADER_SV_TESS_FACTOR_LINEDET = 0x0f , VKD3D_SHADER_SV_TESS_FACTOR_LINEDEN = 0x10 , VKD3D_SHADER_SV_TARGET = 0x40 , VKD3D_SHADER_SV_DEPTH = 0x41 , VKD3D_SHADER_SV_COVERAGE = 0x42 , VKD3D_SHADER_SV_DEPTH_GREATER_EQUAL = 0x43 , VKD3D_SHADER_SV_DEPTH_LESS_EQUAL = 0x44 , VKD3D_SHADER_SV_STENCIL_REF = 0x45 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_minimum_precision { VKD3D_SHADER_MINIMUM_PRECISION_NONE = 0 , VKD3D_SHADER_MINIMUM_PRECISION_FLOAT_16 = 1 , VKD3D_SHADER_MINIMUM_PRECISION_FIXED_8_2 = 2 , VKD3D_SHADER_MINIMUM_PRECISION_INT_16 = 4 , VKD3D_SHADER_MINIMUM_PRECISION_UINT_16 = 5 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

enum	vkd3d_shader_swizzle_component { VKD3D_SHADER_SWIZZLE_X = 0x0 , VKD3D_SHADER_SWIZZLE_Y = 0x1 , VKD3D_SHADER_SWIZZLE_Z = 0x2 , VKD3D_SHADER_SWIZZLE_W = 0x3 , VKD3D_FORCE_32_BIT_ENUM =(VKD3D_SHADER_API_VERSION) }

Functions
static uint32_t	vkd3d_shader_create_swizzle (enum vkd3d_shader_swizzle_component x, enum vkd3d_shader_swizzle_component y, enum vkd3d_shader_swizzle_component z, enum vkd3d_shader_swizzle_component w)

VKD3D_SHADER_API const char *	vkd3d_shader_get_version (unsigned int major, unsigned int minor)

VKD3D_SHADER_API enum vkd3d_shader_source_type *	vkd3d_shader_get_supported_source_types (unsigned int *count)

VKD3D_SHADER_API enum vkd3d_shader_target_type *	vkd3d_shader_get_supported_target_types (enum vkd3d_shader_source_type source_type, unsigned int *count)

VKD3D_SHADER_API int	vkd3d_shader_compile (const struct vkd3d_shader_compile_info compile_info, struct vkd3d_shader_code out, char **messages)

VKD3D_SHADER_API void	vkd3d_shader_free_messages (char *messages)

VKD3D_SHADER_API void	vkd3d_shader_free_shader_code (struct vkd3d_shader_code *code)

VKD3D_SHADER_API int	vkd3d_shader_parse_root_signature (const struct vkd3d_shader_code dxbc, struct vkd3d_shader_versioned_root_signature_desc root_signature, char **messages)

VKD3D_SHADER_API void	vkd3d_shader_free_root_signature (struct vkd3d_shader_versioned_root_signature_desc *root_signature)

VKD3D_SHADER_API int	vkd3d_shader_serialize_root_signature (const struct vkd3d_shader_versioned_root_signature_desc root_signature, struct vkd3d_shader_code dxbc, char **messages)

VKD3D_SHADER_API int	vkd3d_shader_convert_root_signature (struct vkd3d_shader_versioned_root_signature_desc dst, enum vkd3d_shader_root_signature_version version, const struct vkd3d_shader_versioned_root_signature_desc src)

VKD3D_SHADER_API int	vkd3d_shader_scan (const struct vkd3d_shader_compile_info compile_info, char *messages)

VKD3D_SHADER_API void	vkd3d_shader_free_scan_descriptor_info (struct vkd3d_shader_scan_descriptor_info *scan_descriptor_info)

VKD3D_SHADER_API int	vkd3d_shader_parse_input_signature (const struct vkd3d_shader_code dxbc, struct vkd3d_shader_signature signature, char **messages)

VKD3D_SHADER_API struct vkd3d_shader_signature_element *	vkd3d_shader_find_signature_element (const struct vkd3d_shader_signature signature, const char semantic_name, unsigned int semantic_index, unsigned int stream_index)

VKD3D_SHADER_API void	vkd3d_shader_free_shader_signature (struct vkd3d_shader_signature *signature)

VKD3D_SHADER_API int	vkd3d_shader_preprocess (const struct vkd3d_shader_compile_info compile_info, struct vkd3d_shader_code out, char **messages)

VKD3D_SHADER_API void	vkd3d_shader_set_log_callback (PFN_vkd3d_log callback)

VKD3D_SHADER_API void	vkd3d_shader_free_dxbc (struct vkd3d_shader_dxbc_desc *dxbc)

VKD3D_SHADER_API int	vkd3d_shader_parse_dxbc (const struct vkd3d_shader_code dxbc, uint32_t flags, struct vkd3d_shader_dxbc_desc desc, char **messages)

VKD3D_SHADER_API int	vkd3d_shader_serialize_dxbc (size_t section_count, const struct vkd3d_shader_dxbc_section_desc sections, struct vkd3d_shader_code dxbc, char **messages)

VKD3D_SHADER_API void	vkd3d_shader_free_scan_signature_info (struct vkd3d_shader_scan_signature_info *info)

VKD3D_SHADER_API void	vkd3d_shader_build_varying_map (const struct vkd3d_shader_signature output_signature, const struct vkd3d_shader_signature input_signature, unsigned int count, struct vkd3d_shader_varying_map varyings)

VKD3D_SHADER_API void	vkd3d_shader_free_scan_combined_resource_sampler_info (struct vkd3d_shader_scan_combined_resource_sampler_info *info)

Detailed Description

This file contains definitions for the vkd3d-shader library.

The vkd3d-shader library provides multiple utilities related to the compilation, transformation, and reflection of GPU shaders.

Since: 1.2

Definition in file vkd3d_shader.h.

Macro Definition Documentation

◆ VKD3D_SHADER_API

#define VKD3D_SHADER_API VKD3D_IMPORT

Definition at line 2445 of file vkd3d_shader.h.

◆ VKD3D_SHADER_DUMMY_SAMPLER_INDEX

#define VKD3D_SHADER_DUMMY_SAMPLER_INDEX ~0u

Definition at line 964 of file vkd3d_shader.h.

◆ VKD3D_SHADER_NO_SWIZZLE

#define VKD3D_SHADER_NO_SWIZZLE VKD3D_SHADER_SWIZZLE(X, Y, Z, W)

The identity swizzle ".xyzw".

Definition at line 2265 of file vkd3d_shader.h.

◆ VKD3D_SHADER_SWIZZLE

#define VKD3D_SHADER_SWIZZLE	(	x,
		y,
		z,
		w
	)

Value:

        (VKD3D_SHADER_SWIZZLE_ ## x << VKD3D_SHADER_SWIZZLE_SHIFT(0) \
                | VKD3D_SHADER_SWIZZLE_ ## y << VKD3D_SHADER_SWIZZLE_SHIFT(1) \
                | VKD3D_SHADER_SWIZZLE_ ## z << VKD3D_SHADER_SWIZZLE_SHIFT(2) \
                | VKD3D_SHADER_SWIZZLE_ ## w << VKD3D_SHADER_SWIZZLE_SHIFT(3))

A helper macro which returns a vkd3d-shader swizzle with the given components. The components are specified as the suffixes to members of vkd3d_shader_swizzle_component. For example, the swizzle ".xwyy" can be represented as:

VKD3D_SHADER_SWIZZLE(X, W, Y, Y)

X

Definition: rawriter_test.cpp:12

Y

#define Y(I)

W

Definition: polytest.cpp:36

VKD3D_SHADER_SWIZZLE

#define VKD3D_SHADER_SWIZZLE(x, y, z, w)

Definition: vkd3d_shader.h:2258

Definition at line 2258 of file vkd3d_shader.h.

◆ VKD3D_SHADER_SWIZZLE_MASK

#define VKD3D_SHADER_SWIZZLE_MASK (0xffu)

A mask selecting one component from a vkd3d-shader swizzle. The component has type vkd3d_shader_swizzle_component.

Definition at line 2245 of file vkd3d_shader.h.

◆ VKD3D_SHADER_SWIZZLE_SHIFT

#define VKD3D_SHADER_SWIZZLE_SHIFT ( idx ) (8u * (idx))

The offset, in bits, of the nth parameter of a vkd3d-shader swizzle.

Definition at line 2247 of file vkd3d_shader.h.

Typedef Documentation

◆ PFN_vkd3d_shader_build_varying_map

typedef void(* PFN_vkd3d_shader_build_varying_map) (const struct vkd3d_shader_signature *output_signature, const struct vkd3d_shader_signature *input_signature, unsigned int *count, struct vkd3d_shader_varying_map *varyings)

Type of vkd3d_shader_build_varying_map().

Since: 1.9

Definition at line 3079 of file vkd3d_shader.h.

◆ PFN_vkd3d_shader_close_include

typedef void(* PFN_vkd3d_shader_close_include) (const struct vkd3d_shader_code *code, void *context)

Type of a callback function which will be used to close preprocessor includes.

This callback function is passed as part of struct vkd3d_shader_preprocess_info.

Parameters

code	Contents of the included file, which were allocated by the vkd3d_shader_preprocess_info.pfn_open_include callback. The user must free them.
context	The user-defined pointer passed to struct vkd3d_shader_preprocess_info.

Definition at line 1479 of file vkd3d_shader.h.

◆ PFN_vkd3d_shader_compile

typedef int(* PFN_vkd3d_shader_compile) (const struct vkd3d_shader_compile_info *compile_info, struct vkd3d_shader_code *out, char **messages)

Type of vkd3d_shader_compile().

Definition at line 3024 of file vkd3d_shader.h.

◆ PFN_vkd3d_shader_convert_root_signature

typedef int(* PFN_vkd3d_shader_convert_root_signature) (struct vkd3d_shader_versioned_root_signature_desc *dst, enum vkd3d_shader_root_signature_version version, const struct vkd3d_shader_versioned_root_signature_desc *src)

Type of vkd3d_shader_convert_root_signature().

Definition at line 3043 of file vkd3d_shader.h.

◆ PFN_vkd3d_shader_find_signature_element

typedef struct vkd3d_shader_signature_element *(* PFN_vkd3d_shader_find_signature_element) (const struct vkd3d_shader_signature *signature, const char *semantic_name, unsigned int semantic_index, unsigned int stream_index)

Type of vkd3d_shader_find_signature_element().

Definition at line 3053 of file vkd3d_shader.h.

◆ PFN_vkd3d_shader_free_dxbc

typedef void(* PFN_vkd3d_shader_free_dxbc) (struct vkd3d_shader_dxbc_desc *dxbc)

Type of vkd3d_shader_free_dxbc().

Since: 1.7

Definition at line 3070 of file vkd3d_shader.h.

◆ PFN_vkd3d_shader_free_messages

typedef void(* PFN_vkd3d_shader_free_messages) (char *messages)

Type of vkd3d_shader_free_messages().

Definition at line 3027 of file vkd3d_shader.h.

◆ PFN_vkd3d_shader_free_root_signature

typedef void(* PFN_vkd3d_shader_free_root_signature) (struct vkd3d_shader_versioned_root_signature_desc *root_signature)

Type of vkd3d_shader_free_root_signature().

Definition at line 3035 of file vkd3d_shader.h.

◆ PFN_vkd3d_shader_free_scan_combined_resource_sampler_info

typedef void(* PFN_vkd3d_shader_free_scan_combined_resource_sampler_info) (struct vkd3d_shader_scan_combined_resource_sampler_info *info)

Type of vkd3d_shader_free_scan_combined_resource_sampler_info().

Since: 1.10

Definition at line 3086 of file vkd3d_shader.h.

◆ PFN_vkd3d_shader_free_scan_descriptor_info

typedef void(* PFN_vkd3d_shader_free_scan_descriptor_info) (struct vkd3d_shader_scan_descriptor_info *scan_descriptor_info)

Type of vkd3d_shader_free_scan_descriptor_info().

Definition at line 3049 of file vkd3d_shader.h.

◆ PFN_vkd3d_shader_free_scan_signature_info

typedef void(* PFN_vkd3d_shader_free_scan_signature_info) (struct vkd3d_shader_scan_signature_info *info)

Type of vkd3d_shader_free_scan_signature_info().

Since: 1.9

Definition at line 3083 of file vkd3d_shader.h.

◆ PFN_vkd3d_shader_free_shader_code

typedef void(* PFN_vkd3d_shader_free_shader_code) (struct vkd3d_shader_code *code)

Type of vkd3d_shader_free_shader_code().

Definition at line 3029 of file vkd3d_shader.h.

◆ PFN_vkd3d_shader_free_shader_signature

typedef void(* PFN_vkd3d_shader_free_shader_signature) (struct vkd3d_shader_signature *signature)

Type of vkd3d_shader_free_shader_signature().

Definition at line 3060 of file vkd3d_shader.h.

◆ PFN_vkd3d_shader_get_supported_source_types

typedef enum vkd3d_shader_source_type *(* PFN_vkd3d_shader_get_supported_source_types) (unsigned int *count)

Type of vkd3d_shader_get_supported_source_types().

Definition at line 3016 of file vkd3d_shader.h.

◆ PFN_vkd3d_shader_get_supported_target_types

typedef enum vkd3d_shader_target_type *(* PFN_vkd3d_shader_get_supported_target_types) (enum vkd3d_shader_source_type source_type, unsigned int *count)

Type of vkd3d_shader_get_supported_target_types().

Definition at line 3016 of file vkd3d_shader.h.

◆ PFN_vkd3d_shader_get_version

typedef const char *(* PFN_vkd3d_shader_get_version) (unsigned int *major, unsigned int *minor)

Type of vkd3d_shader_get_version().

Definition at line 3016 of file vkd3d_shader.h.

◆ PFN_vkd3d_shader_open_include

typedef int(* PFN_vkd3d_shader_open_include) (const char *filename, bool local, const char *parent_data, void *context, struct vkd3d_shader_code *out)

Type of a callback function which will be used to open preprocessor includes.

This callback function is passed as part of struct vkd3d_shader_preprocess_info.

If this function fails, vkd3d-shader will emit a compilation error, and the pfn_close_include callback will not be called.

Parameters

filename	Unquoted string used as an argument to the #include directive.
local	Whether the #include directive is requesting a local (i.e. double-quoted) or system (i.e. angle-bracketed) include.
parent_data	Unprocessed source code of the file in which this #include directive is evaluated. This parameter may be NULL.
context	The user-defined pointer passed to struct vkd3d_shader_preprocess_info.
out	Output location for the full contents of the included file. The code need not be allocated using standard vkd3d functions, but must remain valid until the corresponding call to pfn_close_include. If this function fails, the contents of this parameter are ignored.

Returns: A member of vkd3d_result.

Definition at line 1463 of file vkd3d_shader.h.

◆ PFN_vkd3d_shader_parse_dxbc

typedef int(* PFN_vkd3d_shader_parse_dxbc) (const struct vkd3d_shader_code *dxbc, uint32_t flags, struct vkd3d_shader_dxbc_desc *desc, char **messages)

Type of vkd3d_shader_parse_dxbc().

Since: 1.7

Definition at line 3072 of file vkd3d_shader.h.

◆ PFN_vkd3d_shader_parse_input_signature

typedef int(* PFN_vkd3d_shader_parse_input_signature) (const struct vkd3d_shader_code *dxbc, struct vkd3d_shader_signature *signature, char **messages)

Type of vkd3d_shader_parse_input_signature().

Definition at line 3053 of file vkd3d_shader.h.

◆ PFN_vkd3d_shader_parse_root_signature

typedef int(* PFN_vkd3d_shader_parse_root_signature) (const struct vkd3d_shader_code *dxbc, struct vkd3d_shader_versioned_root_signature_desc *root_signature, char **messages)

Type of vkd3d_shader_parse_root_signature().

Definition at line 3032 of file vkd3d_shader.h.

◆ PFN_vkd3d_shader_preprocess

typedef void(* PFN_vkd3d_shader_preprocess) (struct vkd3d_shader_compile_info *compile_info, struct vkd3d_shader_code *out, char **messages)

Type of vkd3d_shader_preprocess().

Since: 1.3

Definition at line 3063 of file vkd3d_shader.h.

◆ PFN_vkd3d_shader_scan

typedef int(* PFN_vkd3d_shader_scan) (const struct vkd3d_shader_compile_info *compile_info, char **messages)

Type of vkd3d_shader_scan().

Definition at line 3047 of file vkd3d_shader.h.

◆ PFN_vkd3d_shader_serialize_dxbc

typedef int(* PFN_vkd3d_shader_serialize_dxbc) (size_t section_count, const struct vkd3d_shader_dxbc_section_desc *sections, struct vkd3d_shader_code *dxbc, char **messages)

Type of vkd3d_shader_serialize_dxbc().

Since: 1.7

Definition at line 3075 of file vkd3d_shader.h.

◆ PFN_vkd3d_shader_serialize_root_signature

typedef int(* PFN_vkd3d_shader_serialize_root_signature) (const struct vkd3d_shader_versioned_root_signature_desc *root_signature, struct vkd3d_shader_code *dxbc, char **messages)

Type of vkd3d_shader_serialize_root_signature().

Definition at line 3038 of file vkd3d_shader.h.

◆ PFN_vkd3d_shader_set_log_callback

typedef void(* PFN_vkd3d_shader_set_log_callback) (PFN_vkd3d_log callback)

Type of vkd3d_shader_set_log_callback().

Since: 1.4

Definition at line 3067 of file vkd3d_shader.h.

Enumeration Type Documentation

◆ vkd3d_shader_api_version

enum vkd3d_shader_api_version

Since: 1.3

Enumerator
VKD3D_SHADER_API_VERSION_1_0
VKD3D_SHADER_API_VERSION_1_1
VKD3D_SHADER_API_VERSION_1_2
VKD3D_SHADER_API_VERSION_1_3
VKD3D_SHADER_API_VERSION_1_4
VKD3D_SHADER_API_VERSION_1_5
VKD3D_SHADER_API_VERSION_1_6
VKD3D_SHADER_API_VERSION_1_7
VKD3D_SHADER_API_VERSION_1_8
VKD3D_SHADER_API_VERSION_1_9
VKD3D_SHADER_API_VERSION_1_10
VKD3D_SHADER_API_VERSION_1_11
VKD3D_SHADER_API_VERSION_1_12
VKD3D_SHADER_API_VERSION_1_13
VKD3D_SHADER_API_VERSION_1_14
VKD3D_FORCE_32_BIT_ENUM

Definition at line 43 of file vkd3d_shader.h.

{
    VKD3D_SHADER_API_VERSION_1_0,
    VKD3D_SHADER_API_VERSION_1_1,
    VKD3D_SHADER_API_VERSION_1_2,
    VKD3D_SHADER_API_VERSION_1_3,
    VKD3D_SHADER_API_VERSION_1_4,
    VKD3D_SHADER_API_VERSION_1_5,
    VKD3D_SHADER_API_VERSION_1_6,
    VKD3D_SHADER_API_VERSION_1_7,
    VKD3D_SHADER_API_VERSION_1_8,
    VKD3D_SHADER_API_VERSION_1_9,
    VKD3D_SHADER_API_VERSION_1_10,
    VKD3D_SHADER_API_VERSION_1_11,
    VKD3D_SHADER_API_VERSION_1_12,
    VKD3D_SHADER_API_VERSION_1_13,
    VKD3D_SHADER_API_VERSION_1_14,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_API_VERSION),
};

◆ vkd3d_shader_binding_flag

enum vkd3d_shader_binding_flag

Enumerator
VKD3D_SHADER_BINDING_FLAG_BUFFER
VKD3D_SHADER_BINDING_FLAG_IMAGE
VKD3D_FORCE_32_BIT_ENUM

Definition at line 466 of file vkd3d_shader.h.

{
    VKD3D_SHADER_BINDING_FLAG_BUFFER = 0x00000001,
    VKD3D_SHADER_BINDING_FLAG_IMAGE  = 0x00000002,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_BINDING_FLAG),
};

◆ vkd3d_shader_comparison_func

enum vkd3d_shader_comparison_func

Enumerator
VKD3D_SHADER_COMPARISON_FUNC_NEVER
VKD3D_SHADER_COMPARISON_FUNC_LESS
VKD3D_SHADER_COMPARISON_FUNC_EQUAL
VKD3D_SHADER_COMPARISON_FUNC_LESS_EQUAL
VKD3D_SHADER_COMPARISON_FUNC_GREATER
VKD3D_SHADER_COMPARISON_FUNC_NOT_EQUAL
VKD3D_SHADER_COMPARISON_FUNC_GREATER_EQUAL
VKD3D_SHADER_COMPARISON_FUNC_ALWAYS
VKD3D_FORCE_32_BIT_ENUM

Definition at line 1628 of file vkd3d_shader.h.

{
    VKD3D_SHADER_COMPARISON_FUNC_NEVER         = 0x1,
    VKD3D_SHADER_COMPARISON_FUNC_LESS          = 0x2,
    VKD3D_SHADER_COMPARISON_FUNC_EQUAL         = 0x3,
    VKD3D_SHADER_COMPARISON_FUNC_LESS_EQUAL    = 0x4,
    VKD3D_SHADER_COMPARISON_FUNC_GREATER       = 0x5,
    VKD3D_SHADER_COMPARISON_FUNC_NOT_EQUAL     = 0x6,
    VKD3D_SHADER_COMPARISON_FUNC_GREATER_EQUAL = 0x7,
    VKD3D_SHADER_COMPARISON_FUNC_ALWAYS        = 0x8,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_COMPARISON_FUNC),
};

◆ vkd3d_shader_compile_option_backward_compatibility

enum vkd3d_shader_compile_option_backward_compatibility

Individual options to enable various backward compatibility features.

Since: 1.10

Enumerator

VKD3D_SHADER_COMPILE_OPTION_BACKCOMPAT_MAP_SEMANTIC_NAMES

Causes compiler to convert SM1-3 semantics to corresponding System Value semantics, when compiling HLSL sources for SM4+ targets.

This option does the following conversions:

POSITION to SV_Position for vertex shader outputs, pixel shader inputs, and geometry shader inputs and outputs;
COLORN to SV_TargetN for pixel shader outputs;
DEPTH to SV_Depth for pixel shader outputs.

VKD3D_SHADER_COMPILE_OPTION_DOUBLE_AS_FLOAT_ALIAS

Causes 'double' to behave as an alias for 'float'. This option only applies to HLSL sources with shader model 1-3 target profiles. Without this option using the 'double' type produces compilation errors in these target profiles.

This option is disabled by default.

Since: 1.14

VKD3D_FORCE_32_BIT_ENUM

Definition at line 180 of file vkd3d_shader.h.

{
    VKD3D_SHADER_COMPILE_OPTION_BACKCOMPAT_MAP_SEMANTIC_NAMES = 0x00000001,
    VKD3D_SHADER_COMPILE_OPTION_DOUBLE_AS_FLOAT_ALIAS = 0x00000002,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_COMPILE_OPTION_BACKWARD_COMPATIBILITY),
};

◆ vkd3d_shader_compile_option_buffer_uav

enum vkd3d_shader_compile_option_buffer_uav

Determines how buffer UAVs are stored.

This also affects UAV counters in Vulkan environments. In OpenGL environments, atomic counter buffers are always used for UAV counters.

Enumerator
VKD3D_SHADER_COMPILE_OPTION_BUFFER_UAV_STORAGE_TEXEL_BUFFER	Use buffer textures for buffer UAVs. This is the default value.
VKD3D_SHADER_COMPILE_OPTION_BUFFER_UAV_STORAGE_BUFFER	Use storage buffers for buffer UAVs.
VKD3D_FORCE_32_BIT_ENUM

Definition at line 125 of file vkd3d_shader.h.

{
    VKD3D_SHADER_COMPILE_OPTION_BUFFER_UAV_STORAGE_TEXEL_BUFFER = 0x00000000,
    VKD3D_SHADER_COMPILE_OPTION_BUFFER_UAV_STORAGE_BUFFER       = 0x00000001,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_COMPILE_OPTION_BUFFER_UAV),
};

◆ vkd3d_shader_compile_option_feature_flags

enum vkd3d_shader_compile_option_feature_flags

Advertises feature availability.

Since: 1.11

Enumerator
VKD3D_SHADER_COMPILE_OPTION_FEATURE_INT64	The SPIR-V target environment supports 64-bit integer types. This corresponds to the "shaderInt64" feature in the Vulkan API, and the "GL_ARB_gpu_shader_int64" extension in the OpenGL API.
VKD3D_SHADER_COMPILE_OPTION_FEATURE_FLOAT64	The SPIR-V target environment supports 64-bit floating-point types. This corresponds to the "shaderFloat64" feature in the Vulkan API, and the "GL_ARB_gpu_shader_fp64" extension in the OpenGL API.
VKD3D_SHADER_COMPILE_OPTION_FEATURE_WAVE_OPS	The SPIR-V target environment supports wave operations. This flag is valid only in VKD3D_SHADER_SPIRV_ENVIRONMENT_VULKAN_1_1 or greater, and corresponds to the following minimum requirements in VkPhysicalDeviceSubgroupProperties: subgroupSize >= 4. supportedOperations has BASIC, VOTE, ARITHMETIC, BALLOT, SHUFFLE and QUAD bits set. supportedStages include COMPUTE and FRAGMENT. Since 1.12
VKD3D_FORCE_32_BIT_ENUM

Definition at line 227 of file vkd3d_shader.h.

{
    VKD3D_SHADER_COMPILE_OPTION_FEATURE_INT64         = 0x00000001,
    VKD3D_SHADER_COMPILE_OPTION_FEATURE_FLOAT64       = 0x00000002,
    VKD3D_SHADER_COMPILE_OPTION_FEATURE_WAVE_OPS      = 0x00000004,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_COMPILE_OPTION_FEATURE_FLAGS),
};

◆ vkd3d_shader_compile_option_formatting_flags

enum vkd3d_shader_compile_option_formatting_flags

Enumerator
VKD3D_SHADER_COMPILE_OPTION_FORMATTING_NONE
VKD3D_SHADER_COMPILE_OPTION_FORMATTING_COLOUR
VKD3D_SHADER_COMPILE_OPTION_FORMATTING_INDENT
VKD3D_SHADER_COMPILE_OPTION_FORMATTING_OFFSETS
VKD3D_SHADER_COMPILE_OPTION_FORMATTING_HEADER
VKD3D_SHADER_COMPILE_OPTION_FORMATTING_RAW_IDS
VKD3D_SHADER_COMPILE_OPTION_FORMATTING_IO_SIGNATURES	Emit the signatures when disassembling a shader. Since 1.12
VKD3D_FORCE_32_BIT_ENUM

Definition at line 152 of file vkd3d_shader.h.

{
    VKD3D_SHADER_COMPILE_OPTION_FORMATTING_NONE    = 0x00000000,
    VKD3D_SHADER_COMPILE_OPTION_FORMATTING_COLOUR  = 0x00000001,
    VKD3D_SHADER_COMPILE_OPTION_FORMATTING_INDENT  = 0x00000002,
    VKD3D_SHADER_COMPILE_OPTION_FORMATTING_OFFSETS = 0x00000004,
    VKD3D_SHADER_COMPILE_OPTION_FORMATTING_HEADER  = 0x00000008,
    VKD3D_SHADER_COMPILE_OPTION_FORMATTING_RAW_IDS = 0x00000010,
    VKD3D_SHADER_COMPILE_OPTION_FORMATTING_IO_SIGNATURES = 0x00000020,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_COMPILE_OPTION_FORMATTING_FLAGS),
};

◆ vkd3d_shader_compile_option_fragment_coordinate_origin

enum vkd3d_shader_compile_option_fragment_coordinate_origin

Determines the origin of fragment coordinates.

Since: 1.10

Enumerator
VKD3D_SHADER_COMPILE_OPTION_FRAGMENT_COORDINATE_ORIGIN_UPPER_LEFT	Fragment coordinates originate from the upper-left. This is the default; it's also the only value supported by Vulkan environments.
VKD3D_SHADER_COMPILE_OPTION_FRAGMENT_COORDINATE_ORIGIN_LOWER_LEFT	Fragment coordinates originate from the lower-left. This matches the traditional behaviour of OpenGL environments.
VKD3D_FORCE_32_BIT_ENUM

Definition at line 214 of file vkd3d_shader.h.

{
    VKD3D_SHADER_COMPILE_OPTION_FRAGMENT_COORDINATE_ORIGIN_UPPER_LEFT = 0x00000000,
    VKD3D_SHADER_COMPILE_OPTION_FRAGMENT_COORDINATE_ORIGIN_LOWER_LEFT = 0x00000001,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_COMPILE_OPTION_FRAGMENT_COORDINATE_ORIGIN),
};

◆ vkd3d_shader_compile_option_name

enum vkd3d_shader_compile_option_name

Enumerator
VKD3D_SHADER_COMPILE_OPTION_STRIP_DEBUG	If value is nonzero, do not include debug information in the compiled shader. The default value is zero. This option is supported by vkd3d_shader_compile(). However, not all compilers support generating debug information.
VKD3D_SHADER_COMPILE_OPTION_BUFFER_UAV	value is a member of enum vkd3d_shader_compile_option_buffer_uav.
VKD3D_SHADER_COMPILE_OPTION_FORMATTING	value is a member of enum vkd3d_shader_compile_option_formatting_flags.
VKD3D_SHADER_COMPILE_OPTION_API_VERSION	value is a member of enum vkd3d_shader_api_version. Since 1.3
VKD3D_SHADER_COMPILE_OPTION_TYPED_UAV	value is a member of enum vkd3d_shader_compile_option_typed_uav. Since 1.5
VKD3D_SHADER_COMPILE_OPTION_WRITE_TESS_GEOM_POINT_SIZE	If value is nonzero, write the point size for Vulkan tessellation and geometry shaders. This option should be enabled if and only if the shaderTessellationAndGeometryPointSize feature is enabled. The default value is nonzero, i.e. write the point size. This option is supported by vkd3d_shader_compile() for the SPIR-V target type and Vulkan targets; it should not be enabled otherwise. Since 1.7
VKD3D_SHADER_COMPILE_OPTION_PACK_MATRIX_ORDER	This option specifies default matrix packing order for HLSL sources. Explicit variable modifiers or pragmas will take precedence. value is a member of enum vkd3d_shader_compile_option_pack_matrix_order. Since 1.9
VKD3D_SHADER_COMPILE_OPTION_BACKWARD_COMPATIBILITY	This option is used to enable various backward compatibility features. value is a mask of values from enum vkd3d_shader_compile_option_backward_compatibility. Since 1.10
VKD3D_SHADER_COMPILE_OPTION_FRAGMENT_COORDINATE_ORIGIN	This option specifies the origin of fragment coordinates for SPIR-V targets. value is a member of enum vkd3d_shader_compile_option_fragment_coordinate_origin. Since 1.10
VKD3D_SHADER_COMPILE_OPTION_FEATURE	This option specifies the shader features available in the target environment. These are not extensions, i.e. they are always supported by the driver, but may not be supported by the available hardware. value is a member of enum vkd3d_shader_compile_option_feature_flags. Since 1.11
VKD3D_SHADER_COMPILE_OPTION_CHILD_EFFECT	If value is non-zero compilation will produce a child effect using shared object descriptions, as instructed by the "shared" modifier. Child effects are supported with fx_4_0, and fx_4_1 profiles. This option and "shared" modifiers are ignored for the fx_5_0 profile and non-fx profiles. The fx_2_0 profile does not have a separate concept of child effects, variables marked with "shared" modifier will be marked as such in a binary. Since 1.12
VKD3D_SHADER_COMPILE_OPTION_WARN_IMPLICIT_TRUNCATION	If value is nonzero, emit a compile warning warn when vectors or matrices are truncated in an implicit conversion. If warnings are disabled, this option has no effect. This option has no effects for targets other than HLSL. The default value is nonzero, i.e. enable implicit truncation warnings. Since 1.12
VKD3D_SHADER_COMPILE_OPTION_INCLUDE_EMPTY_BUFFERS_IN_EFFECTS	If value is nonzero, empty constant buffers descriptions are written out in the output effect binary. This option applies only to fx_4_0 and fx_4_1 profiles and is otherwise ignored. Since 1.12
VKD3D_FORCE_32_BIT_ENUM

Definition at line 264 of file vkd3d_shader.h.

{
    VKD3D_SHADER_COMPILE_OPTION_STRIP_DEBUG = 0x00000001,
    VKD3D_SHADER_COMPILE_OPTION_BUFFER_UAV  = 0x00000002,
    VKD3D_SHADER_COMPILE_OPTION_FORMATTING  = 0x00000003,
    VKD3D_SHADER_COMPILE_OPTION_API_VERSION = 0x00000004,
    VKD3D_SHADER_COMPILE_OPTION_TYPED_UAV   = 0x00000005,
    VKD3D_SHADER_COMPILE_OPTION_WRITE_TESS_GEOM_POINT_SIZE = 0x00000006,
    VKD3D_SHADER_COMPILE_OPTION_PACK_MATRIX_ORDER = 0x00000007,
    VKD3D_SHADER_COMPILE_OPTION_BACKWARD_COMPATIBILITY = 0x00000008,
    VKD3D_SHADER_COMPILE_OPTION_FRAGMENT_COORDINATE_ORIGIN = 0x00000009,
    VKD3D_SHADER_COMPILE_OPTION_FEATURE = 0x0000000a,
    VKD3D_SHADER_COMPILE_OPTION_CHILD_EFFECT = 0x0000000b,
    VKD3D_SHADER_COMPILE_OPTION_WARN_IMPLICIT_TRUNCATION = 0x0000000c,
    VKD3D_SHADER_COMPILE_OPTION_INCLUDE_EMPTY_BUFFERS_IN_EFFECTS = 0x0000000d,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_COMPILE_OPTION_NAME),
};

◆ vkd3d_shader_compile_option_pack_matrix_order

enum vkd3d_shader_compile_option_pack_matrix_order

Determines how matrices are stored.

Since: 1.9

Enumerator
VKD3D_SHADER_COMPILE_OPTION_PACK_MATRIX_ROW_MAJOR
VKD3D_SHADER_COMPILE_OPTION_PACK_MATRIX_COLUMN_MAJOR
VKD3D_FORCE_32_BIT_ENUM

Definition at line 171 of file vkd3d_shader.h.

{
    VKD3D_SHADER_COMPILE_OPTION_PACK_MATRIX_ROW_MAJOR    = 0x00000001,
    VKD3D_SHADER_COMPILE_OPTION_PACK_MATRIX_COLUMN_MAJOR = 0x00000002,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_COMPILE_OPTION_PACK_MATRIX_ORDER),
};

◆ vkd3d_shader_compile_option_typed_uav

enum vkd3d_shader_compile_option_typed_uav

Determines how typed UAVs are declared.

Since: 1.5

Enumerator
VKD3D_SHADER_COMPILE_OPTION_TYPED_UAV_READ_FORMAT_R32	Use R32(u)i/R32f format for UAVs which are read from. This is the default value.
VKD3D_SHADER_COMPILE_OPTION_TYPED_UAV_READ_FORMAT_UNKNOWN	Use Unknown format for UAVs which are read from. This should only be set if shaderStorageImageReadWithoutFormat is enabled in the target environment.
VKD3D_FORCE_32_BIT_ENUM

Definition at line 139 of file vkd3d_shader.h.

{
    VKD3D_SHADER_COMPILE_OPTION_TYPED_UAV_READ_FORMAT_R32     = 0x00000000,
    VKD3D_SHADER_COMPILE_OPTION_TYPED_UAV_READ_FORMAT_UNKNOWN = 0x00000001,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_COMPILE_OPTION_TYPED_UAV),
};

◆ vkd3d_shader_component_type

enum vkd3d_shader_component_type

Data type of a shader varying, returned as part of struct vkd3d_shader_signature_element.

Enumerator
VKD3D_SHADER_COMPONENT_VOID	The varying has no type.
VKD3D_SHADER_COMPONENT_UINT	32-bit unsigned integer.
VKD3D_SHADER_COMPONENT_INT	32-bit signed integer.
VKD3D_SHADER_COMPONENT_FLOAT	32-bit IEEE floating-point.
VKD3D_SHADER_COMPONENT_BOOL	Boolean.
VKD3D_SHADER_COMPONENT_DOUBLE	64-bit IEEE floating-point.
VKD3D_SHADER_COMPONENT_UINT64	64-bit unsigned integer. Since 1.11
VKD3D_FORCE_32_BIT_ENUM

Definition at line 2047 of file vkd3d_shader.h.

{
    VKD3D_SHADER_COMPONENT_VOID     = 0x0,
    VKD3D_SHADER_COMPONENT_UINT     = 0x1,
    VKD3D_SHADER_COMPONENT_INT      = 0x2,
    VKD3D_SHADER_COMPONENT_FLOAT    = 0x3,
    VKD3D_SHADER_COMPONENT_BOOL     = 0x4,
    VKD3D_SHADER_COMPONENT_DOUBLE   = 0x5,
    VKD3D_SHADER_COMPONENT_UINT64   = 0x6,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_COMPONENT_TYPE),
};

◆ vkd3d_shader_d3dbc_constant_register

enum vkd3d_shader_d3dbc_constant_register

Symbolic register indices for mapping uniform constant register sets in legacy Direct3D bytecode to constant buffer views in the target environment.

Members of this enumeration are used in vkd3d_shader_resource_binding::register_index.

Since: 1.9

Enumerator
VKD3D_SHADER_D3DBC_FLOAT_CONSTANT_REGISTER	The float constant register set, c# in Direct3D assembly.
VKD3D_SHADER_D3DBC_INT_CONSTANT_REGISTER	The integer constant register set, i# in Direct3D assembly.
VKD3D_SHADER_D3DBC_BOOL_CONSTANT_REGISTER	The boolean constant register set, b# in Direct3D assembly.

Definition at line 912 of file vkd3d_shader.h.

{
    VKD3D_SHADER_D3DBC_FLOAT_CONSTANT_REGISTER  = 0x0,
    VKD3D_SHADER_D3DBC_INT_CONSTANT_REGISTER    = 0x1,
    VKD3D_SHADER_D3DBC_BOOL_CONSTANT_REGISTER   = 0x2,
};

◆ vkd3d_shader_descriptor_info_flag

enum vkd3d_shader_descriptor_info_flag

Additional flags describing a shader descriptor, returned as part of struct vkd3d_shader_descriptor_info.

Enumerator
VKD3D_SHADER_DESCRIPTOR_INFO_FLAG_UAV_COUNTER	The descriptor is a UAV resource, whose counter is read from or written to by the shader.
VKD3D_SHADER_DESCRIPTOR_INFO_FLAG_UAV_READ	The descriptor is a UAV resource, which is read from by the shader.
VKD3D_SHADER_DESCRIPTOR_INFO_FLAG_SAMPLER_COMPARISON_MODE	The descriptor is a comparison sampler.
VKD3D_SHADER_DESCRIPTOR_INFO_FLAG_UAV_ATOMICS	The descriptor is a UAV resource, on which the shader performs atomic ops. Since 1.6
VKD3D_SHADER_DESCRIPTOR_INFO_FLAG_RAW_BUFFER	The descriptor is a raw (byte-addressed) buffer. Since 1.9
VKD3D_FORCE_32_BIT_ENUM

Definition at line 1897 of file vkd3d_shader.h.

{
    VKD3D_SHADER_DESCRIPTOR_INFO_FLAG_UAV_COUNTER             = 0x00000001,
    VKD3D_SHADER_DESCRIPTOR_INFO_FLAG_UAV_READ                = 0x00000002,
    VKD3D_SHADER_DESCRIPTOR_INFO_FLAG_SAMPLER_COMPARISON_MODE = 0x00000004,
    VKD3D_SHADER_DESCRIPTOR_INFO_FLAG_UAV_ATOMICS             = 0x00000008,
    VKD3D_SHADER_DESCRIPTOR_INFO_FLAG_RAW_BUFFER              = 0x00000010,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_DESCRIPTOR_INFO_FLAG),
};

◆ vkd3d_shader_descriptor_range_flags

enum vkd3d_shader_descriptor_range_flags

Enumerator
VKD3D_SHADER_DESCRIPTOR_RANGE_FLAG_NONE
VKD3D_SHADER_DESCRIPTOR_RANGE_FLAG_DESCRIPTORS_VOLATILE
VKD3D_SHADER_DESCRIPTOR_RANGE_FLAG_DATA_VOLATILE
VKD3D_SHADER_DESCRIPTOR_RANGE_FLAG_DATA_STATIC_WHILE_SET_AT_EXECUTE
VKD3D_SHADER_DESCRIPTOR_RANGE_FLAG_DATA_STATIC
VKD3D_SHADER_DESCRIPTOR_RANGE_FLAG_DESCRIPTORS_STATIC_KEEPING_BUFFER_BOUNDS_CHECKS	Since 1.11
VKD3D_FORCE_32_BIT_ENUM

Definition at line 1753 of file vkd3d_shader.h.

{
    VKD3D_SHADER_DESCRIPTOR_RANGE_FLAG_NONE                             = 0x0,
    VKD3D_SHADER_DESCRIPTOR_RANGE_FLAG_DESCRIPTORS_VOLATILE             = 0x1,
    VKD3D_SHADER_DESCRIPTOR_RANGE_FLAG_DATA_VOLATILE                    = 0x2,
    VKD3D_SHADER_DESCRIPTOR_RANGE_FLAG_DATA_STATIC_WHILE_SET_AT_EXECUTE = 0x4,
    VKD3D_SHADER_DESCRIPTOR_RANGE_FLAG_DATA_STATIC                      = 0x8,
    VKD3D_SHADER_DESCRIPTOR_RANGE_FLAG_DESCRIPTORS_STATIC_KEEPING_BUFFER_BOUNDS_CHECKS = 0x10000,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_DESCRIPTOR_RANGE_FLAGS),
};

◆ vkd3d_shader_descriptor_type

enum vkd3d_shader_descriptor_type

The type of a shader resource descriptor.

Enumerator
VKD3D_SHADER_DESCRIPTOR_TYPE_SRV	The descriptor is a shader resource view. In Direct3D assembly, this is bound to a t# register.
VKD3D_SHADER_DESCRIPTOR_TYPE_UAV	The descriptor is an unordered access view. In Direct3D assembly, this is bound to a u# register.
VKD3D_SHADER_DESCRIPTOR_TYPE_CBV	The descriptor is a constant buffer view. In Direct3D assembly, this is bound to a cb# register.
VKD3D_SHADER_DESCRIPTOR_TYPE_SAMPLER	The descriptor is a sampler. In Direct3D assembly, this is bound to an s# register.
VKD3D_FORCE_32_BIT_ENUM

Definition at line 419 of file vkd3d_shader.h.

{
    VKD3D_SHADER_DESCRIPTOR_TYPE_SRV     = 0x0,
    VKD3D_SHADER_DESCRIPTOR_TYPE_UAV     = 0x1,
    VKD3D_SHADER_DESCRIPTOR_TYPE_CBV     = 0x2,
    VKD3D_SHADER_DESCRIPTOR_TYPE_SAMPLER = 0x3,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_DESCRIPTOR_TYPE),
};

◆ vkd3d_shader_filter

enum vkd3d_shader_filter

Enumerator
VKD3D_SHADER_FILTER_MIN_MAG_MIP_POINT
VKD3D_SHADER_FILTER_MIN_MAG_POINT_MIP_LINEAR
VKD3D_SHADER_FILTER_MIN_POINT_MAG_LINEAR_MIP_POINT
VKD3D_SHADER_FILTER_MIN_POINT_MAG_MIP_LINEAR
VKD3D_SHADER_FILTER_MIN_LINEAR_MAG_MIP_POINT
VKD3D_SHADER_FILTER_MIN_LINEAR_MAG_POINT_MIP_LINEAR
VKD3D_SHADER_FILTER_MIN_MAG_LINEAR_MIP_POINT
VKD3D_SHADER_FILTER_MIN_MAG_MIP_LINEAR
VKD3D_SHADER_FILTER_ANISOTROPIC
VKD3D_SHADER_FILTER_COMPARISON_MIN_MAG_MIP_POINT
VKD3D_SHADER_FILTER_COMPARISON_MIN_MAG_POINT_MIP_LINEAR
VKD3D_SHADER_FILTER_COMPARISON_MIN_POINT_MAG_LINEAR_MIP_POINT
VKD3D_SHADER_FILTER_COMPARISON_MIN_POINT_MAG_MIP_LINEAR
VKD3D_SHADER_FILTER_COMPARISON_MIN_LINEAR_MAG_MIP_POINT
VKD3D_SHADER_FILTER_COMPARISON_MIN_LINEAR_MAG_POINT_MIP_LINEAR
VKD3D_SHADER_FILTER_COMPARISON_MIN_MAG_LINEAR_MIP_POINT
VKD3D_SHADER_FILTER_COMPARISON_MIN_MAG_MIP_LINEAR
VKD3D_SHADER_FILTER_COMPARISON_ANISOTROPIC
VKD3D_SHADER_FILTER_MINIMUM_MIN_MAG_MIP_POINT
VKD3D_SHADER_FILTER_MINIMUM_MIN_MAG_POINT_MIP_LINEAR
VKD3D_SHADER_FILTER_MINIMUM_MIN_POINT_MAG_LINEAR_MIP_POINT
VKD3D_SHADER_FILTER_MINIMUM_MIN_POINT_MAG_MIP_LINEAR
VKD3D_SHADER_FILTER_MINIMUM_MIN_LINEAR_MAG_MIP_POINT
VKD3D_SHADER_FILTER_MINIMUM_MIN_LINEAR_MAG_POINT_MIP_LINEAR
VKD3D_SHADER_FILTER_MINIMUM_MIN_MAG_LINEAR_MIP_POINT
VKD3D_SHADER_FILTER_MINIMUM_MIN_MAG_MIP_LINEAR
VKD3D_SHADER_FILTER_MINIMUM_ANISOTROPIC
VKD3D_SHADER_FILTER_MAXIMUM_MIN_MAG_MIP_POINT
VKD3D_SHADER_FILTER_MAXIMUM_MIN_MAG_POINT_MIP_LINEAR
VKD3D_SHADER_FILTER_MAXIMUM_MIN_POINT_MAG_LINEAR_MIP_POINT
VKD3D_SHADER_FILTER_MAXIMUM_MIN_POINT_MAG_MIP_LINEAR
VKD3D_SHADER_FILTER_MAXIMUM_MIN_LINEAR_MAG_MIP_POINT
VKD3D_SHADER_FILTER_MAXIMUM_MIN_LINEAR_MAG_POINT_MIP_LINEAR
VKD3D_SHADER_FILTER_MAXIMUM_MIN_MAG_LINEAR_MIP_POINT
VKD3D_SHADER_FILTER_MAXIMUM_MIN_MAG_MIP_LINEAR
VKD3D_SHADER_FILTER_MAXIMUM_ANISOTROPIC
VKD3D_FORCE_32_BIT_ENUM

Definition at line 1575 of file vkd3d_shader.h.

{
    VKD3D_SHADER_FILTER_MIN_MAG_MIP_POINT                          = 0x000,
    VKD3D_SHADER_FILTER_MIN_MAG_POINT_MIP_LINEAR                   = 0x001,
    VKD3D_SHADER_FILTER_MIN_POINT_MAG_LINEAR_MIP_POINT             = 0x004,
    VKD3D_SHADER_FILTER_MIN_POINT_MAG_MIP_LINEAR                   = 0x005,
    VKD3D_SHADER_FILTER_MIN_LINEAR_MAG_MIP_POINT                   = 0x010,
    VKD3D_SHADER_FILTER_MIN_LINEAR_MAG_POINT_MIP_LINEAR            = 0x011,
    VKD3D_SHADER_FILTER_MIN_MAG_LINEAR_MIP_POINT                   = 0x014,
    VKD3D_SHADER_FILTER_MIN_MAG_MIP_LINEAR                         = 0x015,
    VKD3D_SHADER_FILTER_ANISOTROPIC                                = 0x055,
    VKD3D_SHADER_FILTER_COMPARISON_MIN_MAG_MIP_POINT               = 0x080,
    VKD3D_SHADER_FILTER_COMPARISON_MIN_MAG_POINT_MIP_LINEAR        = 0x081,
    VKD3D_SHADER_FILTER_COMPARISON_MIN_POINT_MAG_LINEAR_MIP_POINT  = 0x084,
    VKD3D_SHADER_FILTER_COMPARISON_MIN_POINT_MAG_MIP_LINEAR        = 0x085,
    VKD3D_SHADER_FILTER_COMPARISON_MIN_LINEAR_MAG_MIP_POINT        = 0x090,
    VKD3D_SHADER_FILTER_COMPARISON_MIN_LINEAR_MAG_POINT_MIP_LINEAR = 0x091,
    VKD3D_SHADER_FILTER_COMPARISON_MIN_MAG_LINEAR_MIP_POINT        = 0x094,
    VKD3D_SHADER_FILTER_COMPARISON_MIN_MAG_MIP_LINEAR              = 0x095,
    VKD3D_SHADER_FILTER_COMPARISON_ANISOTROPIC                     = 0x0d5,
    VKD3D_SHADER_FILTER_MINIMUM_MIN_MAG_MIP_POINT                  = 0x100,
    VKD3D_SHADER_FILTER_MINIMUM_MIN_MAG_POINT_MIP_LINEAR           = 0x101,
    VKD3D_SHADER_FILTER_MINIMUM_MIN_POINT_MAG_LINEAR_MIP_POINT     = 0x104,
    VKD3D_SHADER_FILTER_MINIMUM_MIN_POINT_MAG_MIP_LINEAR           = 0x105,
    VKD3D_SHADER_FILTER_MINIMUM_MIN_LINEAR_MAG_MIP_POINT           = 0x110,
    VKD3D_SHADER_FILTER_MINIMUM_MIN_LINEAR_MAG_POINT_MIP_LINEAR    = 0x111,
    VKD3D_SHADER_FILTER_MINIMUM_MIN_MAG_LINEAR_MIP_POINT           = 0x114,
    VKD3D_SHADER_FILTER_MINIMUM_MIN_MAG_MIP_LINEAR                 = 0x115,
    VKD3D_SHADER_FILTER_MINIMUM_ANISOTROPIC                        = 0x155,
    VKD3D_SHADER_FILTER_MAXIMUM_MIN_MAG_MIP_POINT                  = 0x180,
    VKD3D_SHADER_FILTER_MAXIMUM_MIN_MAG_POINT_MIP_LINEAR           = 0x181,
    VKD3D_SHADER_FILTER_MAXIMUM_MIN_POINT_MAG_LINEAR_MIP_POINT     = 0x184,
    VKD3D_SHADER_FILTER_MAXIMUM_MIN_POINT_MAG_MIP_LINEAR           = 0x185,
    VKD3D_SHADER_FILTER_MAXIMUM_MIN_LINEAR_MAG_MIP_POINT           = 0x190,
    VKD3D_SHADER_FILTER_MAXIMUM_MIN_LINEAR_MAG_POINT_MIP_LINEAR    = 0x191,
    VKD3D_SHADER_FILTER_MAXIMUM_MIN_MAG_LINEAR_MIP_POINT           = 0x194,
    VKD3D_SHADER_FILTER_MAXIMUM_MIN_MAG_MIP_LINEAR                 = 0x195,
    VKD3D_SHADER_FILTER_MAXIMUM_ANISOTROPIC                        = 0x1d5,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_FILTER),
};

◆ vkd3d_shader_log_level

enum vkd3d_shader_log_level

Describes the minimum severity of compilation messages returned by vkd3d_shader_compile() and similar functions.

Enumerator
VKD3D_SHADER_LOG_NONE	No messages will be returned.
VKD3D_SHADER_LOG_ERROR	Only fatal errors which prevent successful compilation will be returned.
VKD3D_SHADER_LOG_WARNING	Non-fatal warnings and fatal errors will be returned.
VKD3D_SHADER_LOG_INFO	All messages, including general informational messages, will be returned.
VKD3D_FORCE_32_BIT_ENUM

Definition at line 1276 of file vkd3d_shader.h.

{
    VKD3D_SHADER_LOG_NONE,
    VKD3D_SHADER_LOG_ERROR,
    VKD3D_SHADER_LOG_WARNING,
    VKD3D_SHADER_LOG_INFO,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_LOG_LEVEL),
};

◆ vkd3d_shader_minimum_precision

enum vkd3d_shader_minimum_precision

Minimum interpolation precision of a shader varying, returned as part of struct vkd3d_shader_signature_element.

Enumerator
VKD3D_SHADER_MINIMUM_PRECISION_NONE
VKD3D_SHADER_MINIMUM_PRECISION_FLOAT_16	16-bit floating-point.
VKD3D_SHADER_MINIMUM_PRECISION_FIXED_8_2	10-bit fixed point (2 integer and 8 fractional bits).
VKD3D_SHADER_MINIMUM_PRECISION_INT_16	16-bit signed integer.
VKD3D_SHADER_MINIMUM_PRECISION_UINT_16	16-bit unsigned integer.
VKD3D_FORCE_32_BIT_ENUM

Definition at line 2124 of file vkd3d_shader.h.

{
    VKD3D_SHADER_MINIMUM_PRECISION_NONE      = 0,
    VKD3D_SHADER_MINIMUM_PRECISION_FLOAT_16  = 1,
    VKD3D_SHADER_MINIMUM_PRECISION_FIXED_8_2 = 2,
    VKD3D_SHADER_MINIMUM_PRECISION_INT_16    = 4,
    VKD3D_SHADER_MINIMUM_PRECISION_UINT_16   = 5,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_MINIMUM_PRECISION),
};

◆ vkd3d_shader_parameter_data_type

enum vkd3d_shader_parameter_data_type

The format of data provided to the shader, used in struct vkd3d_shader_parameter and struct vkd3d_shader_parameter1.

Enumerator
VKD3D_SHADER_PARAMETER_DATA_TYPE_UNKNOWN
VKD3D_SHADER_PARAMETER_DATA_TYPE_UINT32	The parameter is provided as a 32-bit unsigned integer.
VKD3D_SHADER_PARAMETER_DATA_TYPE_FLOAT32	The parameter is provided as a 32-bit float. Since 1.13
VKD3D_SHADER_PARAMETER_DATA_TYPE_FLOAT32_VEC4	The parameter is provided as a 4-dimensional vector of 32-bit floats. This parameter must be used with struct vkd3d_shader_parameter1; it cannot be used with struct vkd3d_shader_parameter. Since 1.14
VKD3D_FORCE_32_BIT_ENUM

Definition at line 503 of file vkd3d_shader.h.

{
    VKD3D_SHADER_PARAMETER_DATA_TYPE_UNKNOWN,
    VKD3D_SHADER_PARAMETER_DATA_TYPE_UINT32,
    VKD3D_SHADER_PARAMETER_DATA_TYPE_FLOAT32,
    VKD3D_SHADER_PARAMETER_DATA_TYPE_FLOAT32_VEC4,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_PARAMETER_DATA_TYPE),
};

◆ vkd3d_shader_parameter_name

enum vkd3d_shader_parameter_name

Names a specific shader parameter, used in struct vkd3d_shader_parameter and struct vkd3d_shader_parameter1.

Enumerator
VKD3D_SHADER_PARAMETER_NAME_UNKNOWN
VKD3D_SHADER_PARAMETER_NAME_RASTERIZER_SAMPLE_COUNT	The sample count of the framebuffer, as returned by the HLSL function GetRenderTargetSampleCount() or the GLSL builtin gl_NumSamples. This parameter should be specified when compiling to SPIR-V, which provides no builtin ability to query this information from the shader. The default value is 1. The data type for this parameter must be VKD3D_SHADER_PARAMETER_DATA_TYPE_UINT32.
VKD3D_SHADER_PARAMETER_NAME_ALPHA_TEST_FUNC	Alpha test comparison function. When this parameter is provided, if the alpha component of the pixel shader colour output at location 0 fails the test, as defined by this function and the reference value provided by VKD3D_SHADER_PARAMETER_NAME_ALPHA_TEST_REF, the fragment will be discarded. This parameter, along with VKD3D_SHADER_PARAMETER_NAME_ALPHA_TEST_REF, can be used to implement fixed function alpha test, as present in Direct3D versions up to 9, if the target environment does not support alpha test as part of its own fixed-function API (as Vulkan and core OpenGL). The default value is VKD3D_SHADER_COMPARISON_FUNC_ALWAYS. The data type for this parameter must be VKD3D_SHADER_PARAMETER_DATA_TYPE_UINT32. The value specified must be a member of enum vkd3d_shader_comparison_func. Only VKD3D_SHADER_PARAMETER_TYPE_IMMEDIATE_CONSTANT is supported in this version of vkd3d-shader. Since 1.13
VKD3D_SHADER_PARAMETER_NAME_ALPHA_TEST_REF	Alpha test reference value. See VKD3D_SHADER_PARAMETER_NAME_ALPHA_TEST_FUNC for documentation of alpha test. The default value is zero. Since 1.13
VKD3D_SHADER_PARAMETER_NAME_FLAT_INTERPOLATION	Whether to use flat interpolation for fragment shader colour inputs. If the value is nonzero, inputs whose semantic usage is COLOR will use flat interpolation instead of linear. This parameter is ignored if the shader model is 4 or greater, since only shader model 3 and below do not specify the interpolation mode in the shader bytecode. This parameter can be used to implement fixed function shade mode, as present in Direct3D versions up to 9, if the target environment does not support shade mode as part of its own fixed-function API (as Vulkan and core OpenGL). The data type for this parameter must be VKD3D_SHADER_PARAMETER_DATA_TYPE_UINT32. The default value is zero, i.e. use linear interpolation. Only VKD3D_SHADER_PARAMETER_TYPE_IMMEDIATE_CONSTANT is supported in this version of vkd3d-shader. Since 1.13
VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_MASK	A mask of enabled clip planes. When this parameter is provided to a vertex shader, for each nonzero bit of this mask, a user clip distance will be generated from vertex position in clip space, and the clip plane defined by the indexed vector, taken from the VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_# parameter. Regardless of the specific clip planes which are enabled, the clip distances which are output are a contiguous array starting from clip distance 0. This affects the interface of OpenGL. For example, if only clip planes 1 and 3 are enabled (and so the value of the mask is 0xa), the user should enable only GL_CLIP_DISTANCE0 and GL_CLIP_DISTANCE1. The default value is zero, i.e. do not enable any clip planes. The data type for this parameter must be VKD3D_SHADER_PARAMETER_DATA_TYPE_UINT32. Only VKD3D_SHADER_PARAMETER_TYPE_IMMEDIATE_CONSTANT is supported in this version of vkd3d-shader. If the source shader writes clip distances and this parameter is nonzero, compilation fails. Since 1.14
VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_0	Clip plane values. See VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_MASK for documentation of clip planes. These enum values are contiguous and arithmetic may safely be performed on them. That is, VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_[n] is VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_0 plus n. The data type for each parameter must be VKD3D_SHADER_PARAMETER_DATA_TYPE_FLOAT32_VEC4. The default value for each plane is a (0, 0, 0, 0) vector. Since 1.14
VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_1
VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_2
VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_3
VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_4
VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_5
VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_6
VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_7
VKD3D_SHADER_PARAMETER_NAME_POINT_SIZE	Point size. When this parameter is provided to a vertex, tessellation, or geometry shader, and the source shader does not write point size, it specifies a uniform value which will be written to point size. If the source shader writes point size, this parameter is ignored. This parameter can be used to implement fixed function point size, as present in Direct3D versions 8 and 9, if the target environment does not support point size as part of its own fixed-function API (as Vulkan and core OpenGL). The data type for this parameter must be VKD3D_SHADER_PARAMETER_DATA_TYPE_FLOAT32. Since 1.14
VKD3D_SHADER_PARAMETER_NAME_POINT_SIZE_MIN	Minimum point size. When this parameter is provided to a vertex, tessellation, or geometry shader, and the source shader writes point size or uses the VKD3D_SHADER_PARAMETER_NAME_POINT_SIZE parameter, the point size will be clamped to the provided minimum value. If point size is not written in one of these ways, this parameter is ignored. If this parameter is not provided, the point size will not be clamped to a minimum size by vkd3d-shader. This parameter can be used to implement fixed function point size, as present in Direct3D versions 8 and 9, if the target environment does not support point size as part of its own fixed-function API (as Vulkan and core OpenGL). The data type for this parameter must be VKD3D_SHADER_PARAMETER_DATA_TYPE_FLOAT32. Since 1.14
VKD3D_SHADER_PARAMETER_NAME_POINT_SIZE_MAX	Maximum point size. This parameter has identical behaviour to VKD3D_SHADER_PARAMETER_NAME_POINT_SIZE_MIN, except that it provides the maximum size rather than the minimum. Since 1.14
VKD3D_SHADER_PARAMETER_NAME_POINT_SPRITE	Whether texture coordinate inputs should take their values from the point coordinate. When this parameter is provided to a pixel shader, and the value is nonzero, any fragment shader input with the semantic name "TEXCOORD" takes its value from the point coordinates instead of from the previous shader. The point coordinates here are defined as a four-component vector whose X and Y components are the X and Y coordinates of the fragment within a point being rasterized, and whose Z and W components are zero. In GLSL, the X and Y components are drawn from gl_PointCoord; in SPIR-V, they are drawn from a variable with the BuiltinPointCoord decoration. This includes t# fragment shader inputs in shader model 2 shaders, as well as texture sampling in shader model 1 shaders. This parameter can be used to implement fixed function point sprite, as present in Direct3D versions 8 and 9, if the target environment does not support point sprite as part of its own fixed-function API (as Vulkan and core OpenGL). The data type for this parameter must be VKD3D_SHADER_PARAMETER_DATA_TYPE_UINT32. The default value is zero, i.e. use the original varyings. Only VKD3D_SHADER_PARAMETER_TYPE_IMMEDIATE_CONSTANT is supported in this version of vkd3d-shader. Since 1.14
VKD3D_FORCE_32_BIT_ENUM

Definition at line 525 of file vkd3d_shader.h.

{
    VKD3D_SHADER_PARAMETER_NAME_UNKNOWN,
    VKD3D_SHADER_PARAMETER_NAME_RASTERIZER_SAMPLE_COUNT,
    VKD3D_SHADER_PARAMETER_NAME_ALPHA_TEST_FUNC,
    VKD3D_SHADER_PARAMETER_NAME_ALPHA_TEST_REF,
    VKD3D_SHADER_PARAMETER_NAME_FLAT_INTERPOLATION,
    VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_MASK,
    VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_0,
    VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_1,
    VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_2,
    VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_3,
    VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_4,
    VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_5,
    VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_6,
    VKD3D_SHADER_PARAMETER_NAME_CLIP_PLANE_7,
    VKD3D_SHADER_PARAMETER_NAME_POINT_SIZE,
    VKD3D_SHADER_PARAMETER_NAME_POINT_SIZE_MIN,
    VKD3D_SHADER_PARAMETER_NAME_POINT_SIZE_MAX,
    VKD3D_SHADER_PARAMETER_NAME_POINT_SPRITE,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_PARAMETER_NAME),
};

◆ vkd3d_shader_parameter_type

enum vkd3d_shader_parameter_type

The manner in which a parameter value is provided to the shader, used in struct vkd3d_shader_parameter and struct vkd3d_shader_parameter1.

Enumerator
VKD3D_SHADER_PARAMETER_TYPE_UNKNOWN
VKD3D_SHADER_PARAMETER_TYPE_IMMEDIATE_CONSTANT	The parameter value is embedded directly in the shader.
VKD3D_SHADER_PARAMETER_TYPE_SPECIALIZATION_CONSTANT	The parameter value is provided to the shader via specialization constants. This value is only supported for the SPIR-V target type.
VKD3D_SHADER_PARAMETER_TYPE_BUFFER	The parameter value is provided to the shader as part of a uniform buffer. Since 1.13
VKD3D_FORCE_32_BIT_ENUM

Definition at line 478 of file vkd3d_shader.h.

{
    VKD3D_SHADER_PARAMETER_TYPE_UNKNOWN,
    VKD3D_SHADER_PARAMETER_TYPE_IMMEDIATE_CONSTANT,
    VKD3D_SHADER_PARAMETER_TYPE_SPECIALIZATION_CONSTANT,
    VKD3D_SHADER_PARAMETER_TYPE_BUFFER,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_PARAMETER_TYPE),
};

◆ vkd3d_shader_parse_dxbc_flags

enum vkd3d_shader_parse_dxbc_flags

Flags for vkd3d_shader_parse_dxbc().

Since: 1.12

Enumerator
VKD3D_SHADER_PARSE_DXBC_IGNORE_CHECKSUM	Ignore the checksum and continue parsing even if it is incorrect.
VKD3D_FORCE_32_BIT_ENUM

Definition at line 255 of file vkd3d_shader.h.

{
    VKD3D_SHADER_PARSE_DXBC_IGNORE_CHECKSUM           = 0x00000001,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_PARSE_DXBC_FLAGS),
};

◆ vkd3d_shader_resource_data_type

enum vkd3d_shader_resource_data_type

The type of the data contained in a shader resource, returned as part of struct vkd3d_shader_descriptor_info. All formats are 32-bit.

Enumerator
VKD3D_SHADER_RESOURCE_DATA_UNORM	Unsigned normalized integer.
VKD3D_SHADER_RESOURCE_DATA_SNORM	Signed normalized integer.
VKD3D_SHADER_RESOURCE_DATA_INT	Signed integer.
VKD3D_SHADER_RESOURCE_DATA_UINT	Unsigned integer.
VKD3D_SHADER_RESOURCE_DATA_FLOAT	IEEE single-precision floating-point.
VKD3D_SHADER_RESOURCE_DATA_MIXED	Undefined/type-less. Since 1.3
VKD3D_SHADER_RESOURCE_DATA_DOUBLE	IEEE double-precision floating-point. Since 1.3
VKD3D_SHADER_RESOURCE_DATA_CONTINUED	Continuation of the previous component. For example, 64-bit double-precision floating-point data may be returned as two 32-bit components, with the first component (containing the LSB) specified as VKD3D_SHADER_RESOURCE_DATA_DOUBLE, and the second component specified as VKD3D_SHADER_RESOURCE_DATA_CONTINUED. Since 1.3
VKD3D_FORCE_32_BIT_ENUM

Definition at line 1867 of file vkd3d_shader.h.

{
    VKD3D_SHADER_RESOURCE_DATA_UNORM     = 0x1,
    VKD3D_SHADER_RESOURCE_DATA_SNORM     = 0x2,
    VKD3D_SHADER_RESOURCE_DATA_INT       = 0x3,
    VKD3D_SHADER_RESOURCE_DATA_UINT      = 0x4,
    VKD3D_SHADER_RESOURCE_DATA_FLOAT     = 0x5,
    VKD3D_SHADER_RESOURCE_DATA_MIXED     = 0x6,
    VKD3D_SHADER_RESOURCE_DATA_DOUBLE    = 0x7,
    VKD3D_SHADER_RESOURCE_DATA_CONTINUED = 0x8,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_RESOURCE_DATA_TYPE),
};

◆ vkd3d_shader_resource_type

enum vkd3d_shader_resource_type

The type of a shader resource, returned as part of struct vkd3d_shader_descriptor_info.

Enumerator
VKD3D_SHADER_RESOURCE_NONE	The type is invalid or not applicable for this descriptor. This value is returned for samplers.
VKD3D_SHADER_RESOURCE_BUFFER	Dimensionless buffer.
VKD3D_SHADER_RESOURCE_TEXTURE_1D	1-dimensional texture.
VKD3D_SHADER_RESOURCE_TEXTURE_2D	2-dimensional texture.
VKD3D_SHADER_RESOURCE_TEXTURE_2DMS	Multisampled 2-dimensional texture.
VKD3D_SHADER_RESOURCE_TEXTURE_3D	3-dimensional texture.
VKD3D_SHADER_RESOURCE_TEXTURE_CUBE	Cubemap texture.
VKD3D_SHADER_RESOURCE_TEXTURE_1DARRAY	1-dimensional array texture.
VKD3D_SHADER_RESOURCE_TEXTURE_2DARRAY	2-dimensional array texture.
VKD3D_SHADER_RESOURCE_TEXTURE_2DMSARRAY	Multisampled 2-dimensional array texture.
VKD3D_SHADER_RESOURCE_TEXTURE_CUBEARRAY	Cubemap array texture.
VKD3D_FORCE_32_BIT_ENUM

Definition at line 1832 of file vkd3d_shader.h.

{
    VKD3D_SHADER_RESOURCE_NONE              = 0x0,
    VKD3D_SHADER_RESOURCE_BUFFER            = 0x1,
    VKD3D_SHADER_RESOURCE_TEXTURE_1D        = 0x2,
    VKD3D_SHADER_RESOURCE_TEXTURE_2D        = 0x3,
    VKD3D_SHADER_RESOURCE_TEXTURE_2DMS      = 0x4,
    VKD3D_SHADER_RESOURCE_TEXTURE_3D        = 0x5,
    VKD3D_SHADER_RESOURCE_TEXTURE_CUBE      = 0x6,
    VKD3D_SHADER_RESOURCE_TEXTURE_1DARRAY   = 0x7,
    VKD3D_SHADER_RESOURCE_TEXTURE_2DARRAY   = 0x8,
    VKD3D_SHADER_RESOURCE_TEXTURE_2DMSARRAY = 0x9,
    VKD3D_SHADER_RESOURCE_TEXTURE_CUBEARRAY = 0xa,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_RESOURCE_TYPE),
};

◆ vkd3d_shader_root_descriptor_flags

enum vkd3d_shader_root_descriptor_flags

Enumerator
VKD3D_SHADER_ROOT_DESCRIPTOR_FLAG_NONE
VKD3D_SHADER_ROOT_DESCRIPTOR_FLAG_DATA_VOLATILE
VKD3D_SHADER_ROOT_DESCRIPTOR_FLAG_DATA_STATIC_WHILE_SET_AT_EXECUTE
VKD3D_SHADER_ROOT_DESCRIPTOR_FLAG_DATA_STATIC
VKD3D_FORCE_32_BIT_ENUM

Definition at line 1743 of file vkd3d_shader.h.

{
    VKD3D_SHADER_ROOT_DESCRIPTOR_FLAG_NONE                             = 0x0,
    VKD3D_SHADER_ROOT_DESCRIPTOR_FLAG_DATA_VOLATILE                    = 0x2,
    VKD3D_SHADER_ROOT_DESCRIPTOR_FLAG_DATA_STATIC_WHILE_SET_AT_EXECUTE = 0x4,
    VKD3D_SHADER_ROOT_DESCRIPTOR_FLAG_DATA_STATIC                      = 0x8,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_ROOT_DESCRIPTOR_FLAGS),
};

◆ vkd3d_shader_root_parameter_type

enum vkd3d_shader_root_parameter_type

Enumerator
VKD3D_SHADER_ROOT_PARAMETER_TYPE_DESCRIPTOR_TABLE
VKD3D_SHADER_ROOT_PARAMETER_TYPE_32BIT_CONSTANTS
VKD3D_SHADER_ROOT_PARAMETER_TYPE_CBV
VKD3D_SHADER_ROOT_PARAMETER_TYPE_SRV
VKD3D_SHADER_ROOT_PARAMETER_TYPE_UAV
VKD3D_FORCE_32_BIT_ENUM

Definition at line 1696 of file vkd3d_shader.h.

{
    VKD3D_SHADER_ROOT_PARAMETER_TYPE_DESCRIPTOR_TABLE = 0x0,
    VKD3D_SHADER_ROOT_PARAMETER_TYPE_32BIT_CONSTANTS  = 0x1,
    VKD3D_SHADER_ROOT_PARAMETER_TYPE_CBV              = 0x2,
    VKD3D_SHADER_ROOT_PARAMETER_TYPE_SRV              = 0x3,
    VKD3D_SHADER_ROOT_PARAMETER_TYPE_UAV              = 0x4,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_ROOT_PARAMETER_TYPE),
};

◆ vkd3d_shader_root_signature_flags

enum vkd3d_shader_root_signature_flags

Enumerator
VKD3D_SHADER_ROOT_SIGNATURE_FLAG_NONE
VKD3D_SHADER_ROOT_SIGNATURE_FLAG_ALLOW_INPUT_ASSEMBLER_INPUT_LAYOUT
VKD3D_SHADER_ROOT_SIGNATURE_FLAG_DENY_VERTEX_SHADER_ROOT_ACCESS
VKD3D_SHADER_ROOT_SIGNATURE_FLAG_DENY_HULL_SHADER_ROOT_ACCESS
VKD3D_SHADER_ROOT_SIGNATURE_FLAG_DENY_DOMAIN_SHADER_ROOT_ACCESS
VKD3D_SHADER_ROOT_SIGNATURE_FLAG_DENY_GEOMETRY_SHADER_ROOT_ACCESS
VKD3D_SHADER_ROOT_SIGNATURE_FLAG_DENY_PIXEL_SHADER_ROOT_ACCESS
VKD3D_SHADER_ROOT_SIGNATURE_FLAG_ALLOW_STREAM_OUTPUT
VKD3D_FORCE_32_BIT_ENUM

Definition at line 1719 of file vkd3d_shader.h.

{
    VKD3D_SHADER_ROOT_SIGNATURE_FLAG_NONE                               = 0x00,
    VKD3D_SHADER_ROOT_SIGNATURE_FLAG_ALLOW_INPUT_ASSEMBLER_INPUT_LAYOUT = 0x01,
    VKD3D_SHADER_ROOT_SIGNATURE_FLAG_DENY_VERTEX_SHADER_ROOT_ACCESS     = 0x02,
    VKD3D_SHADER_ROOT_SIGNATURE_FLAG_DENY_HULL_SHADER_ROOT_ACCESS       = 0x04,
    VKD3D_SHADER_ROOT_SIGNATURE_FLAG_DENY_DOMAIN_SHADER_ROOT_ACCESS     = 0x08,
    VKD3D_SHADER_ROOT_SIGNATURE_FLAG_DENY_GEOMETRY_SHADER_ROOT_ACCESS   = 0x10,
    VKD3D_SHADER_ROOT_SIGNATURE_FLAG_DENY_PIXEL_SHADER_ROOT_ACCESS      = 0x20,
    VKD3D_SHADER_ROOT_SIGNATURE_FLAG_ALLOW_STREAM_OUTPUT                = 0x40,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_ROOT_SIGNATURE_FLAGS),
};

◆ vkd3d_shader_root_signature_version

enum vkd3d_shader_root_signature_version

Enumerator
VKD3D_SHADER_ROOT_SIGNATURE_VERSION_1_0
VKD3D_SHADER_ROOT_SIGNATURE_VERSION_1_1
VKD3D_FORCE_32_BIT_ENUM

Definition at line 1810 of file vkd3d_shader.h.

{
    VKD3D_SHADER_ROOT_SIGNATURE_VERSION_1_0 = 0x1,
    VKD3D_SHADER_ROOT_SIGNATURE_VERSION_1_1 = 0x2,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_ROOT_SIGNATURE_VERSION),
};

◆ vkd3d_shader_source_type

enum vkd3d_shader_source_type

The format of a shader to be compiled or scanned.

Enumerator
VKD3D_SHADER_SOURCE_NONE	The shader has no type or is to be ignored. This is not a valid value for vkd3d_shader_compile() or vkd3d_shader_scan().
VKD3D_SHADER_SOURCE_DXBC_TPF	A 'Tokenized Program Format' shader embedded in a DXBC container. This is the format used for Direct3D shader model 4 and 5 shaders.
VKD3D_SHADER_SOURCE_HLSL	High-Level Shader Language source code. Since 1.3
VKD3D_SHADER_SOURCE_D3D_BYTECODE	Legacy Direct3D byte-code. This is the format used for Direct3D shader model 1, 2, and 3 shaders. Since 1.3
VKD3D_SHADER_SOURCE_DXBC_DXIL	A 'DirectX Intermediate Language' shader embedded in a DXBC container. This is the format used for Direct3D shader model 6 shaders. Since 1.9
VKD3D_SHADER_SOURCE_FX	Binary format used by Direct3D 9/10.x/11 effects. Input is a raw FX section without container. Since 1.14
VKD3D_FORCE_32_BIT_ENUM

Definition at line 1194 of file vkd3d_shader.h.

{
    VKD3D_SHADER_SOURCE_NONE,
    VKD3D_SHADER_SOURCE_DXBC_TPF,
    VKD3D_SHADER_SOURCE_HLSL,
    VKD3D_SHADER_SOURCE_D3D_BYTECODE,
    VKD3D_SHADER_SOURCE_DXBC_DXIL,
    VKD3D_SHADER_SOURCE_FX,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_SOURCE_TYPE),
};

◆ vkd3d_shader_spirv_environment

enum vkd3d_shader_spirv_environment

Enumerator
VKD3D_SHADER_SPIRV_ENVIRONMENT_NONE
VKD3D_SHADER_SPIRV_ENVIRONMENT_OPENGL_4_5
VKD3D_SHADER_SPIRV_ENVIRONMENT_VULKAN_1_0
VKD3D_SHADER_SPIRV_ENVIRONMENT_VULKAN_1_1	Since 1.12
VKD3D_FORCE_32_BIT_ENUM

Definition at line 1337 of file vkd3d_shader.h.

{
    VKD3D_SHADER_SPIRV_ENVIRONMENT_NONE,
    VKD3D_SHADER_SPIRV_ENVIRONMENT_OPENGL_4_5,
    VKD3D_SHADER_SPIRV_ENVIRONMENT_VULKAN_1_0, /* default target */
    VKD3D_SHADER_SPIRV_ENVIRONMENT_VULKAN_1_1,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_SPIRV_ENVIRONMENT),
};

◆ vkd3d_shader_spirv_extension

enum vkd3d_shader_spirv_extension

Enumerator
VKD3D_SHADER_SPIRV_EXTENSION_NONE
VKD3D_SHADER_SPIRV_EXTENSION_EXT_DEMOTE_TO_HELPER_INVOCATION
VKD3D_SHADER_SPIRV_EXTENSION_EXT_DESCRIPTOR_INDEXING	Since 1.3
VKD3D_SHADER_SPIRV_EXTENSION_EXT_STENCIL_EXPORT	Since 1.3
VKD3D_SHADER_SPIRV_EXTENSION_EXT_VIEWPORT_INDEX_LAYER	Since 1.11
VKD3D_SHADER_SPIRV_EXTENSION_EXT_FRAGMENT_SHADER_INTERLOCK	Since 1.12
VKD3D_FORCE_32_BIT_ENUM

Definition at line 1348 of file vkd3d_shader.h.

{
    VKD3D_SHADER_SPIRV_EXTENSION_NONE,
    VKD3D_SHADER_SPIRV_EXTENSION_EXT_DEMOTE_TO_HELPER_INVOCATION,
    VKD3D_SHADER_SPIRV_EXTENSION_EXT_DESCRIPTOR_INDEXING,
    VKD3D_SHADER_SPIRV_EXTENSION_EXT_STENCIL_EXPORT,
    VKD3D_SHADER_SPIRV_EXTENSION_EXT_VIEWPORT_INDEX_LAYER,
    VKD3D_SHADER_SPIRV_EXTENSION_EXT_FRAGMENT_SHADER_INTERLOCK,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_SPIRV_EXTENSION),
};

◆ vkd3d_shader_static_border_colour

enum vkd3d_shader_static_border_colour

Enumerator
VKD3D_SHADER_STATIC_BORDER_COLOUR_TRANSPARENT_BLACK
VKD3D_SHADER_STATIC_BORDER_COLOUR_OPAQUE_BLACK
VKD3D_SHADER_STATIC_BORDER_COLOUR_OPAQUE_WHITE
VKD3D_FORCE_32_BIT_ENUM

Definition at line 1642 of file vkd3d_shader.h.

{
    VKD3D_SHADER_STATIC_BORDER_COLOUR_TRANSPARENT_BLACK = 0x0,
    VKD3D_SHADER_STATIC_BORDER_COLOUR_OPAQUE_BLACK      = 0x1,
    VKD3D_SHADER_STATIC_BORDER_COLOUR_OPAQUE_WHITE      = 0x2,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_STATIC_BORDER_COLOUR),
};

◆ vkd3d_shader_structure_type

enum vkd3d_shader_structure_type

The type of a chained structure.

Enumerator
VKD3D_SHADER_STRUCTURE_TYPE_COMPILE_INFO	The structure is a vkd3d_shader_compile_info structure.
VKD3D_SHADER_STRUCTURE_TYPE_INTERFACE_INFO	The structure is a vkd3d_shader_interface_info structure.
VKD3D_SHADER_STRUCTURE_TYPE_SCAN_DESCRIPTOR_INFO	The structure is a vkd3d_shader_scan_descriptor_info structure.
VKD3D_SHADER_STRUCTURE_TYPE_SPIRV_DOMAIN_SHADER_TARGET_INFO	The structure is a vkd3d_shader_spirv_domain_shader_target_info structure.
VKD3D_SHADER_STRUCTURE_TYPE_SPIRV_TARGET_INFO	The structure is a vkd3d_shader_spirv_target_info structure.
VKD3D_SHADER_STRUCTURE_TYPE_TRANSFORM_FEEDBACK_INFO	The structure is a vkd3d_shader_transform_feedback_info structure.
VKD3D_SHADER_STRUCTURE_TYPE_HLSL_SOURCE_INFO	The structure is a vkd3d_shader_hlsl_source_info structure. Since 1.3
VKD3D_SHADER_STRUCTURE_TYPE_PREPROCESS_INFO	The structure is a vkd3d_shader_preprocess_info structure. Since 1.3
VKD3D_SHADER_STRUCTURE_TYPE_DESCRIPTOR_OFFSET_INFO	The structure is a vkd3d_shader_descriptor_offset_info structure. Since 1.3
VKD3D_SHADER_STRUCTURE_TYPE_SCAN_SIGNATURE_INFO	The structure is a vkd3d_shader_scan_signature_info structure. Since 1.9
VKD3D_SHADER_STRUCTURE_TYPE_VARYING_MAP_INFO	The structure is a vkd3d_shader_varying_map_info structure. Since 1.9
VKD3D_SHADER_STRUCTURE_TYPE_SCAN_COMBINED_RESOURCE_SAMPLER_INFO	The structure is a vkd3d_shader_scan_combined_resource_sampler_info structure. Since 1.10
VKD3D_SHADER_STRUCTURE_TYPE_PARAMETER_INFO	The structure is a vkd3d_shader_parameter_info structure. Since 1.13
VKD3D_FORCE_32_BIT_ENUM

Definition at line 65 of file vkd3d_shader.h.

{
    VKD3D_SHADER_STRUCTURE_TYPE_COMPILE_INFO,
    VKD3D_SHADER_STRUCTURE_TYPE_INTERFACE_INFO,
    VKD3D_SHADER_STRUCTURE_TYPE_SCAN_DESCRIPTOR_INFO,
    VKD3D_SHADER_STRUCTURE_TYPE_SPIRV_DOMAIN_SHADER_TARGET_INFO,
    VKD3D_SHADER_STRUCTURE_TYPE_SPIRV_TARGET_INFO,
    VKD3D_SHADER_STRUCTURE_TYPE_TRANSFORM_FEEDBACK_INFO,
 
    VKD3D_SHADER_STRUCTURE_TYPE_HLSL_SOURCE_INFO,
    VKD3D_SHADER_STRUCTURE_TYPE_PREPROCESS_INFO,
    VKD3D_SHADER_STRUCTURE_TYPE_DESCRIPTOR_OFFSET_INFO,
    VKD3D_SHADER_STRUCTURE_TYPE_SCAN_SIGNATURE_INFO,
    VKD3D_SHADER_STRUCTURE_TYPE_VARYING_MAP_INFO,
    VKD3D_SHADER_STRUCTURE_TYPE_SCAN_COMBINED_RESOURCE_SAMPLER_INFO,
    VKD3D_SHADER_STRUCTURE_TYPE_PARAMETER_INFO,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_STRUCTURE_TYPE),
};

◆ vkd3d_shader_swizzle_component

enum vkd3d_shader_swizzle_component

Possible values for a single component of a vkd3d-shader swizzle.

Enumerator
VKD3D_SHADER_SWIZZLE_X
VKD3D_SHADER_SWIZZLE_Y
VKD3D_SHADER_SWIZZLE_Z
VKD3D_SHADER_SWIZZLE_W
VKD3D_FORCE_32_BIT_ENUM

Definition at line 2191 of file vkd3d_shader.h.

{
    VKD3D_SHADER_SWIZZLE_X = 0x0,
    VKD3D_SHADER_SWIZZLE_Y = 0x1,
    VKD3D_SHADER_SWIZZLE_Z = 0x2,
    VKD3D_SHADER_SWIZZLE_W = 0x3,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_SWIZZLE_COMPONENT),
};

◆ vkd3d_shader_sysval_semantic

enum vkd3d_shader_sysval_semantic

System value semantic, returned as part of struct vkd3d_shader_signature.

Enumerator
VKD3D_SHADER_SV_NONE	No system value.
VKD3D_SHADER_SV_POSITION	Vertex position; SV_Position in Direct3D.
VKD3D_SHADER_SV_CLIP_DISTANCE	Clip distance; SV_ClipDistance in Direct3D.
VKD3D_SHADER_SV_CULL_DISTANCE	Cull distance; SV_CullDistance in Direct3D.
VKD3D_SHADER_SV_RENDER_TARGET_ARRAY_INDEX	Render target layer; SV_RenderTargetArrayIndex in Direct3D.
VKD3D_SHADER_SV_VIEWPORT_ARRAY_INDEX	Viewport index; SV_ViewportArrayIndex in Direct3D.
VKD3D_SHADER_SV_VERTEX_ID	Vertex ID; SV_VertexID in Direct3D.
VKD3D_SHADER_SV_PRIMITIVE_ID	Primitive ID; SV_PrimitiveID in Direct3D.
VKD3D_SHADER_SV_INSTANCE_ID	Instance ID; SV_InstanceID in Direct3D.
VKD3D_SHADER_SV_IS_FRONT_FACE	Whether the triangle is front-facing; SV_IsFrontFace in Direct3D.
VKD3D_SHADER_SV_SAMPLE_INDEX	Sample index; SV_SampleIndex in Direct3D.
VKD3D_SHADER_SV_TESS_FACTOR_QUADEDGE
VKD3D_SHADER_SV_TESS_FACTOR_QUADINT
VKD3D_SHADER_SV_TESS_FACTOR_TRIEDGE
VKD3D_SHADER_SV_TESS_FACTOR_TRIINT
VKD3D_SHADER_SV_TESS_FACTOR_LINEDET
VKD3D_SHADER_SV_TESS_FACTOR_LINEDEN
VKD3D_SHADER_SV_TARGET	Render target; SV_Target in Direct3D. Since 1.9
VKD3D_SHADER_SV_DEPTH	Depth; SV_Depth in Direct3D. Since 1.9
VKD3D_SHADER_SV_COVERAGE	Sample mask; SV_Coverage in Direct3D. Since 1.9
VKD3D_SHADER_SV_DEPTH_GREATER_EQUAL	Depth, which is guaranteed to be greater than or equal to the current depth; SV_DepthGreaterEqual in Direct3D. Since 1.9
VKD3D_SHADER_SV_DEPTH_LESS_EQUAL	Depth, which is guaranteed to be less than or equal to the current depth; SV_DepthLessEqual in Direct3D. Since 1.9
VKD3D_SHADER_SV_STENCIL_REF	Stencil reference; SV_StencilRef in Direct3D. Since 1.9
VKD3D_FORCE_32_BIT_ENUM

Definition at line 2068 of file vkd3d_shader.h.

{
    VKD3D_SHADER_SV_NONE                      = 0x00,
    VKD3D_SHADER_SV_POSITION                  = 0x01,
    VKD3D_SHADER_SV_CLIP_DISTANCE             = 0x02,
    VKD3D_SHADER_SV_CULL_DISTANCE             = 0x03,
    VKD3D_SHADER_SV_RENDER_TARGET_ARRAY_INDEX = 0x04,
    VKD3D_SHADER_SV_VIEWPORT_ARRAY_INDEX      = 0x05,
    VKD3D_SHADER_SV_VERTEX_ID                 = 0x06,
    VKD3D_SHADER_SV_PRIMITIVE_ID              = 0x07,
    VKD3D_SHADER_SV_INSTANCE_ID               = 0x08,
    VKD3D_SHADER_SV_IS_FRONT_FACE             = 0x09,
    VKD3D_SHADER_SV_SAMPLE_INDEX              = 0x0a,
    VKD3D_SHADER_SV_TESS_FACTOR_QUADEDGE      = 0x0b,
    VKD3D_SHADER_SV_TESS_FACTOR_QUADINT       = 0x0c,
    VKD3D_SHADER_SV_TESS_FACTOR_TRIEDGE       = 0x0d,
    VKD3D_SHADER_SV_TESS_FACTOR_TRIINT        = 0x0e,
    VKD3D_SHADER_SV_TESS_FACTOR_LINEDET       = 0x0f,
    VKD3D_SHADER_SV_TESS_FACTOR_LINEDEN       = 0x10,
    VKD3D_SHADER_SV_TARGET                    = 0x40,
    VKD3D_SHADER_SV_DEPTH                     = 0x41,
    VKD3D_SHADER_SV_COVERAGE                  = 0x42,
    VKD3D_SHADER_SV_DEPTH_GREATER_EQUAL       = 0x43,
    VKD3D_SHADER_SV_DEPTH_LESS_EQUAL          = 0x44,
    VKD3D_SHADER_SV_STENCIL_REF               = 0x45,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_SYSVAL_SEMANTIC),
};

◆ vkd3d_shader_target_type

enum vkd3d_shader_target_type

The output format of a compiled shader.

Enumerator
VKD3D_SHADER_TARGET_NONE	The shader has no type or is to be ignored. This is not a valid value for vkd3d_shader_compile().
VKD3D_SHADER_TARGET_SPIRV_BINARY	A SPIR-V shader in binary form. This is the format used for Vulkan shaders.
VKD3D_SHADER_TARGET_SPIRV_TEXT
VKD3D_SHADER_TARGET_D3D_ASM	Direct3D shader assembly. Since 1.3
VKD3D_SHADER_TARGET_D3D_BYTECODE	Legacy Direct3D byte-code. This is the format used for Direct3D shader model 1, 2, and 3 shaders. Since 1.3
VKD3D_SHADER_TARGET_DXBC_TPF	A 'Tokenized Program Format' shader embedded in a DXBC container. This is the format used for Direct3D shader model 4 and 5 shaders. Since 1.3
VKD3D_SHADER_TARGET_GLSL	An 'OpenGL Shading Language' shader. Since 1.3
VKD3D_SHADER_TARGET_FX	Binary format used by Direct3D 9/10.x/11 effects profiles. Output is a raw FX section without container. Since 1.11
VKD3D_SHADER_TARGET_MSL	A 'Metal Shading Language' shader. Since 1.14
VKD3D_FORCE_32_BIT_ENUM

Definition at line 1228 of file vkd3d_shader.h.

{
    VKD3D_SHADER_TARGET_NONE,
    VKD3D_SHADER_TARGET_SPIRV_BINARY,
    VKD3D_SHADER_TARGET_SPIRV_TEXT,
    VKD3D_SHADER_TARGET_D3D_ASM,
    VKD3D_SHADER_TARGET_D3D_BYTECODE,
    VKD3D_SHADER_TARGET_DXBC_TPF,
    VKD3D_SHADER_TARGET_GLSL,
    VKD3D_SHADER_TARGET_FX,
    VKD3D_SHADER_TARGET_MSL,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_TARGET_TYPE),
};

◆ vkd3d_shader_tessellator_output_primitive

enum vkd3d_shader_tessellator_output_primitive

Enumerator
VKD3D_SHADER_TESSELLATOR_OUTPUT_POINT
VKD3D_SHADER_TESSELLATOR_OUTPUT_LINE
VKD3D_SHADER_TESSELLATOR_OUTPUT_TRIANGLE_CW
VKD3D_SHADER_TESSELLATOR_OUTPUT_TRIANGLE_CCW
VKD3D_FORCE_32_BIT_ENUM

Definition at line 1385 of file vkd3d_shader.h.

{
    VKD3D_SHADER_TESSELLATOR_OUTPUT_POINT        = 0x1,
    VKD3D_SHADER_TESSELLATOR_OUTPUT_LINE         = 0x2,
    VKD3D_SHADER_TESSELLATOR_OUTPUT_TRIANGLE_CW  = 0x3,
    VKD3D_SHADER_TESSELLATOR_OUTPUT_TRIANGLE_CCW = 0x4,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_TESSELLATOR_OUTPUT_PRIMITIVE),
};

◆ vkd3d_shader_tessellator_partitioning

enum vkd3d_shader_tessellator_partitioning

Enumerator
VKD3D_SHADER_TESSELLATOR_PARTITIONING_INTEGER
VKD3D_SHADER_TESSELLATOR_PARTITIONING_POW2
VKD3D_SHADER_TESSELLATOR_PARTITIONING_FRACTIONAL_ODD
VKD3D_SHADER_TESSELLATOR_PARTITIONING_FRACTIONAL_EVEN
VKD3D_FORCE_32_BIT_ENUM

Definition at line 1395 of file vkd3d_shader.h.

{
    VKD3D_SHADER_TESSELLATOR_PARTITIONING_INTEGER         = 0x1,
    VKD3D_SHADER_TESSELLATOR_PARTITIONING_POW2            = 0x2,
    VKD3D_SHADER_TESSELLATOR_PARTITIONING_FRACTIONAL_ODD  = 0x3,
    VKD3D_SHADER_TESSELLATOR_PARTITIONING_FRACTIONAL_EVEN = 0x4,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_TESSELLATOR_PARTITIONING),
};

◆ vkd3d_shader_texture_address_mode

enum vkd3d_shader_texture_address_mode

Enumerator
VKD3D_SHADER_TEXTURE_ADDRESS_MODE_WRAP
VKD3D_SHADER_TEXTURE_ADDRESS_MODE_MIRROR
VKD3D_SHADER_TEXTURE_ADDRESS_MODE_CLAMP
VKD3D_SHADER_TEXTURE_ADDRESS_MODE_BORDER
VKD3D_SHADER_TEXTURE_ADDRESS_MODE_MIRROR_ONCE
VKD3D_FORCE_32_BIT_ENUM

Definition at line 1617 of file vkd3d_shader.h.

{
    VKD3D_SHADER_TEXTURE_ADDRESS_MODE_WRAP        = 0x1,
    VKD3D_SHADER_TEXTURE_ADDRESS_MODE_MIRROR      = 0x2,
    VKD3D_SHADER_TEXTURE_ADDRESS_MODE_CLAMP       = 0x3,
    VKD3D_SHADER_TEXTURE_ADDRESS_MODE_BORDER      = 0x4,
    VKD3D_SHADER_TEXTURE_ADDRESS_MODE_MIRROR_ONCE = 0x5,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_TEXTURE_ADDRESS_MODE),
};

◆ vkd3d_shader_visibility

enum vkd3d_shader_visibility

Describes which shader stages a resource is visible to.

Enumerator
VKD3D_SHADER_VISIBILITY_ALL	The resource is visible to all shader stages.
VKD3D_SHADER_VISIBILITY_VERTEX	The resource is visible only to the vertex shader.
VKD3D_SHADER_VISIBILITY_HULL	The resource is visible only to the hull shader.
VKD3D_SHADER_VISIBILITY_DOMAIN	The resource is visible only to the domain shader.
VKD3D_SHADER_VISIBILITY_GEOMETRY	The resource is visible only to the geometry shader.
VKD3D_SHADER_VISIBILITY_PIXEL	The resource is visible only to the pixel shader.
VKD3D_SHADER_VISIBILITY_COMPUTE	The resource is visible only to the compute shader.
VKD3D_FORCE_32_BIT_ENUM

Definition at line 382 of file vkd3d_shader.h.

{
    VKD3D_SHADER_VISIBILITY_ALL = 0,
    VKD3D_SHADER_VISIBILITY_VERTEX = 1,
    VKD3D_SHADER_VISIBILITY_HULL = 2,
    VKD3D_SHADER_VISIBILITY_DOMAIN = 3,
    VKD3D_SHADER_VISIBILITY_GEOMETRY = 4,
    VKD3D_SHADER_VISIBILITY_PIXEL = 5,
 
    VKD3D_SHADER_VISIBILITY_COMPUTE = 1000000000,
 
    VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_VISIBILITY),
};

Function Documentation

◆ vkd3d_shader_build_varying_map()

VKD3D_SHADER_API void vkd3d_shader_build_varying_map	(	const struct vkd3d_shader_signature *	output_signature,
		const struct vkd3d_shader_signature *	input_signature,
		unsigned int *	count,
		struct vkd3d_shader_varying_map *	varyings
	)

Build a mapping of output varyings in a shader stage to input varyings in the following shader stage.

This mapping should be used in struct vkd3d_shader_varying_map_info to compile the first shader.

Parameters

output_signature	The output signature of the first shader.
input_signature	The input signature of the second shader.
count	On output, contains the number of entries written into "varyings".
varyings	Pointer to an output array of varyings. This must point to space for N varyings, where N is the number of elements in the input signature.

Remarks: Valid legacy Direct3D pixel shaders have at most 12 varying inputs: 10 inter-stage varyings, face, and position. Therefore, in practice, it is safe to call this function with a pre-allocated array with a fixed size of 12.

Since: 1.9

Definition at line 2271 of file vkd3d_shader_main.c.

{
    unsigned int count = 0;
    unsigned int i;
 
    TRACE("output_signature %p, input_signature %p, ret_count %p, varyings %p.\n",
            output_signature, input_signature, ret_count, varyings);
 
    for (i = 0; i < input_signature->element_count; ++i)
    {
        const struct vkd3d_shader_signature_element *input_element, *output_element;
 
        input_element = &input_signature->elements[i];
 
        if (input_element->sysval_semantic != VKD3D_SHADER_SV_NONE)
            continue;
 
        varyings[count].input_register_index = input_element->register_index;
        varyings[count].input_mask = input_element->mask;
 
        if ((output_element = vkd3d_shader_find_signature_element(output_signature,
                input_element->semantic_name, input_element->semantic_index, 0)))
        {
            varyings[count].output_signature_index = output_element - output_signature->elements;
        }
        else
        {
            varyings[count].output_signature_index = output_signature->element_count;
        }
 
        ++count;
    }
 
    *ret_count = count;
}

Referenced by shader_spirv_compile_arguments_init().

◆ vkd3d_shader_compile()

VKD3D_SHADER_API int vkd3d_shader_compile	(	const struct vkd3d_shader_compile_info *	compile_info,
		struct vkd3d_shader_code *	out,
		char **	messages
	)

Transform a form of GPU shader source code or byte code into another form of source code or byte code.

This version of vkd3d-shader supports the following transformations:

VKD3D_SHADER_SOURCE_DXBC_TPF to VKD3D_SHADER_TARGET_SPIRV_BINARY
VKD3D_SHADER_SOURCE_DXBC_TPF to VKD3D_SHADER_TARGET_SPIRV_TEXT (if vkd3d was compiled with SPIRV-Tools)
VKD3D_SHADER_SOURCE_DXBC_TPF to VKD3D_SHADER_TARGET_D3D_ASM
VKD3D_SHADER_SOURCE_D3D_BYTECODE to VKD3D_SHADER_TARGET_SPIRV_BINARY
VKD3D_SHADER_SOURCE_D3D_BYTECODE to VKD3D_SHADER_TARGET_SPIRV_TEXT (if vkd3d was compiled with SPIRV-Tools)
VKD3D_SHADER_SOURCE_D3D_BYTECODE to VKD3D_SHADER_TARGET_D3D_ASM
VKD3D_SHADER_SOURCE_HLSL to VKD3D_SHADER_TARGET_SPIRV_BINARY
VKD3D_SHADER_SOURCE_HLSL to VKD3D_SHADER_TARGET_SPIRV_TEXT (if vkd3d was compiled with SPIRV-Tools)
VKD3D_SHADER_SOURCE_HLSL to VKD3D_SHADER_TARGET_D3D_ASM
VKD3D_SHADER_SOURCE_HLSL to VKD3D_SHADER_TARGET_D3D_BYTECODE
VKD3D_SHADER_SOURCE_HLSL to VKD3D_SHADER_TARGET_DXBC_TPF
VKD3D_SHADER_SOURCE_HLSL to VKD3D_SHADER_TARGET_FX
VKD3D_SHADER_SOURCE_FX to VKD3D_SHADER_TARGET_D3D_ASM

Supported transformations can also be detected at runtime with the functions vkd3d_shader_get_supported_source_types() and vkd3d_shader_get_supported_target_types().

Depending on the source and target types, this function may support the following chained structures:

Parameters

compile_info	A chained structure containing compilation parameters.
out	A pointer to a vkd3d_shader_code structure in which the compiled code will be stored. The compiled shader is allocated by vkd3d-shader and should be freed with vkd3d_shader_free_shader_code() when no longer needed.
messages	Optional output location for error or informational messages produced by the compiler. This string is null-terminated and UTF-8 encoded. The messages are allocated by vkd3d-shader and should be freed with vkd3d_shader_free_messages() when no longer needed. The messages returned can be regulated with the log_level member of struct vkd3d_shader_compile_info. Regardless of the requested level, if this parameter is NULL, no compilation messages will be returned. If no messages are produced by the compiler, this parameter may receive NULL instead of a valid string pointer.

Returns: A member of vkd3d_result.

Definition at line 1708 of file vkd3d_shader_main.c.

{
    struct vkd3d_shader_message_context message_context;
    struct shader_dump_data dump_data;
    int ret;
 
    TRACE("compile_info %p, out %p, messages %p.\n", compile_info, out, messages);
 
    if (messages)
        *messages = NULL;
 
    if ((ret = vkd3d_shader_validate_compile_info(compile_info, true)) < 0)
        return ret;
 
    init_scan_signature_info(compile_info);
 
    vkd3d_shader_message_context_init(&message_context, compile_info->log_level);
 
    fill_shader_dump_data(compile_info, &dump_data);
    vkd3d_shader_dump_shader(&dump_data, compile_info->source.code, compile_info->source.size, true);
 
    if (compile_info->source_type == VKD3D_SHADER_SOURCE_HLSL)
    {
        ret = compile_hlsl(compile_info, out, &message_context);
    }
    else if (compile_info->source_type == VKD3D_SHADER_SOURCE_FX)
    {
        ret = fx_parse(compile_info, out, &message_context);
    }
    else
    {
        uint64_t config_flags = vkd3d_shader_init_config_flags();
        struct vsir_program program;
 
        if (!(ret = vsir_parse(compile_info, config_flags, &message_context, &program)))
        {
            ret = vsir_program_compile(&program, config_flags, compile_info, out, &message_context);
            vsir_program_cleanup(&program);
        }
    }
 
    if (ret >= 0)
        vkd3d_shader_dump_shader(&dump_data, out->code, out->size, false);
 
    vkd3d_shader_message_context_trace_messages(&message_context);
    if (!vkd3d_shader_message_context_copy_messages(&message_context, messages))
        ret = VKD3D_ERROR_OUT_OF_MEMORY;
    vkd3d_shader_message_context_cleanup(&message_context);
    return ret;
}

Referenced by compile_hlsl_cs(), compile_hlsl_shader(), create_shader_stage(), D3DCompile2(), D3DDisassemble(), fx_4_parse_shader_initializer(), shader_glsl_generate_vkd3d_shader(), shader_spirv_compile_shader(), and shader_trace().

◆ vkd3d_shader_convert_root_signature()

VKD3D_SHADER_API int vkd3d_shader_convert_root_signature	(	struct vkd3d_shader_versioned_root_signature_desc *	dst,
		enum vkd3d_shader_root_signature_version	version,
		const struct vkd3d_shader_versioned_root_signature_desc *	src
	)

Convert a structural representation of a root signature to a different version of structural representation.

This function corresponds to ID3D12VersionedRootSignatureDeserializer::GetRootSignatureDescAtVersion().

Parameters

dst	A pointer to a vkd3d_shader_versioned_root_signature_desc structure in which the converted signature will be stored. Members of dst may be allocated by vkd3d-shader. The signature should be freed with vkd3d_shader_free_root_signature() when no longer needed.
version	The desired version to convert src to. This version must not be equal to src->version.
src	Input root signature description.

Returns: A member of vkd3d_result.

Definition at line 1756 of file dxbc.c.

{
    int ret;
 
    TRACE("dst %p, version %#x, src %p.\n", dst, version, src);
 
    if (src->version == version)
    {
        WARN("Nothing to convert.\n");
        return VKD3D_ERROR_INVALID_ARGUMENT;
    }
 
    if (version != VKD3D_SHADER_ROOT_SIGNATURE_VERSION_1_0 && version != VKD3D_SHADER_ROOT_SIGNATURE_VERSION_1_1)
    {
        WARN("Root signature version %#x not supported.\n", version);
        return VKD3D_ERROR_INVALID_ARGUMENT;
    }
 
    if (src->version != VKD3D_SHADER_ROOT_SIGNATURE_VERSION_1_0
            && src->version != VKD3D_SHADER_ROOT_SIGNATURE_VERSION_1_1)
    {
        WARN("Root signature version %#x not supported.\n", src->version);
        return VKD3D_ERROR_INVALID_ARGUMENT;
    }
 
    memset(dst, 0, sizeof(*dst));
    dst->version = version;
 
    if (version == VKD3D_SHADER_ROOT_SIGNATURE_VERSION_1_0)
    {
        ret = convert_root_signature_to_v1_0(dst, src);
    }
    else
    {
        VKD3D_ASSERT(version == VKD3D_SHADER_ROOT_SIGNATURE_VERSION_1_1);
        ret = convert_root_signature_to_v1_1(dst, src);
    }
 
    return ret;
}

Referenced by d3d12_versioned_root_signature_deserializer_GetRootSignatureDescAtVersion(), and vkd3d_parse_root_signature_v_1_0().

◆ vkd3d_shader_create_swizzle()

static uint32_t vkd3d_shader_create_swizzle	(	enum vkd3d_shader_swizzle_component	x,
		enum vkd3d_shader_swizzle_component	y,
		enum vkd3d_shader_swizzle_component	z,
		enum vkd3d_shader_swizzle_component	w
	)

inlinestatic

Build a vkd3d-shader swizzle with the given components.

Definition at line 2268 of file vkd3d_shader.h.

{
    return ((x & VKD3D_SHADER_SWIZZLE_MASK) << VKD3D_SHADER_SWIZZLE_SHIFT(0))
            | ((y & VKD3D_SHADER_SWIZZLE_MASK) << VKD3D_SHADER_SWIZZLE_SHIFT(1))
            | ((z & VKD3D_SHADER_SWIZZLE_MASK) << VKD3D_SHADER_SWIZZLE_SHIFT(2))
            | ((w & VKD3D_SHADER_SWIZZLE_MASK) << VKD3D_SHADER_SWIZZLE_SHIFT(3));
}

Referenced by src_param_init_scalar(), swizzle_from_sm1(), swizzle_from_sm4(), vsir_program_lower_sm1_sincos(), vsir_program_lower_texkill(), and vsir_swizzle_from_hlsl().

◆ vkd3d_shader_find_signature_element()

VKD3D_SHADER_API struct vkd3d_shader_signature_element * vkd3d_shader_find_signature_element	(	const struct vkd3d_shader_signature *	signature,
		const char *	semantic_name,
		unsigned int	semantic_index,
		unsigned int	stream_index
	)

Find a single element of a parsed input signature.

Parameters

signature	The parsed input signature. This structure is normally populated by vkd3d_shader_parse_input_signature().
semantic_name	Semantic name of the desired element. This function performs a case-insensitive comparison with respect to the ASCII plane.
semantic_index	Semantic index of the desired element.
stream_index	Geometry shader stream index of the desired element. If the signature is not a geometry shader output signature, this parameter must be set to 0.

Returns: A description of the element matching the requested parameters, or NULL if no such element was found. If not NULL, the return value points into the signature parameter and should not be explicitly freed.

Definition at line 1885 of file vkd3d_shader_main.c.

{
    struct vkd3d_shader_signature_element *e;
    unsigned int i;
 
    TRACE("signature %p, semantic_name %s, semantic_index %u, stream_index %u.\n",
            signature, debugstr_a(semantic_name), semantic_index, stream_index);
 
    e = signature->elements;
    for (i = 0; i < signature->element_count; ++i)
    {
        if (!ascii_strcasecmp(e[i].semantic_name, semantic_name)
                && e[i].semantic_index == semantic_index
                && e[i].stream_index == stream_index)
            return &e[i];
    }
 
    return NULL;
}

Referenced by d3d12_pipeline_state_init_graphics(), and vkd3d_shader_build_varying_map().

◆ vkd3d_shader_free_dxbc()

VKD3D_SHADER_API void vkd3d_shader_free_dxbc ( struct vkd3d_shader_dxbc_desc * dxbc )

Free the contents of a vkd3d_shader_dxbc_desc structure allocated by another vkd3d-shader function, such as vkd3d_shader_parse_dxbc().

This function may free the vkd3d_shader_dxbc_desc::sections member, but does not free the structure itself.

Parameters

dxbc	The vkd3d_shader_dxbc_desc structure to free.

Since: 1.7

Definition at line 290 of file dxbc.c.

{
    TRACE("dxbc %p.\n", dxbc);
 
    vkd3d_free(dxbc->sections);
}

Referenced by d3d10_effect_parse(), d3dcompiler_get_blob_part(), d3dcompiler_shader_reflection_init(), d3dcompiler_strip_shader(), for_each_dxbc_section(), parse_fx10_preshader(), vkd3d_shader_parse_dxbc(), vkd3d_shader_parse_dxbc_source_type(), and wined3d_shader_extract_from_dxbc().

◆ vkd3d_shader_free_messages()

VKD3D_SHADER_API void vkd3d_shader_free_messages ( char * messages )

Free shader messages allocated by another vkd3d-shader function, such as vkd3d_shader_compile().

Parameters

messages Messages to free. This pointer is optional and may be NULL, in which case no action will be taken.

Definition at line 728 of file vkd3d_shader_main.c.

{
    TRACE("messages %p.\n", messages);
 
    vkd3d_free(messages);
}

Referenced by compile_hlsl_shader(), D3DCompile2(), D3DDisassemble(), preprocess_shader(), shader_glsl_generate_vkd3d_shader(), shader_spirv_compile_shader(), shader_spirv_scan_shader(), shader_trace(), vkd3d_serialize_root_signature(), and vkd3d_serialize_versioned_root_signature().

◆ vkd3d_shader_free_root_signature()

VKD3D_SHADER_API void vkd3d_shader_free_root_signature ( struct vkd3d_shader_versioned_root_signature_desc * root_signature )

Free a structural representation of a shader root signature allocated by vkd3d_shader_convert_root_signature() or vkd3d_shader_parse_root_signature().

This function may free members of struct vkd3d_shader_versioned_root_signature_desc, but does not free the structure itself.

Parameters

root_signature Signature description to free.

Definition at line 1825 of file vkd3d_shader_main.c.

{
    TRACE("desc %p.\n", desc);
 
    if (desc->version == VKD3D_SHADER_ROOT_SIGNATURE_VERSION_1_0)
    {
        vkd3d_shader_free_root_signature_v_1_0(&desc->u.v_1_0);
    }
    else if (desc->version == VKD3D_SHADER_ROOT_SIGNATURE_VERSION_1_1)
    {
        vkd3d_shader_free_root_signature_v_1_1(&desc->u.v_1_1);
    }
    else if (desc->version)
    {
        FIXME("Unknown version %#x.\n", desc->version);
        return;
    }
 
    desc->version = 0;
}

Referenced by d3d12_root_signature_create(), d3d12_root_signature_deserializer_Release(), d3d12_versioned_root_signature_deserializer_Release(), vkd3d_parse_root_signature_v_1_0(), and vkd3d_shader_parse_root_signature().

◆ vkd3d_shader_free_scan_combined_resource_sampler_info()

VKD3D_SHADER_API void vkd3d_shader_free_scan_combined_resource_sampler_info ( struct vkd3d_shader_scan_combined_resource_sampler_info * info )

Free members of struct vkd3d_shader_scan_combined_resource_sampler_info allocated by vkd3d_shader_scan().

This function may free members of vkd3d_shader_scan_combined_resource_sampler_info, but does not free the structure itself.

Parameters

info	Combined resource-sampler information to free.

Since: 1.10

Definition at line 1760 of file vkd3d_shader_main.c.

{
    TRACE("info %p.\n", info);
 
    vkd3d_free(info->combined_samplers);
}

Referenced by vsir_program_compile(), and vsir_program_scan().

◆ vkd3d_shader_free_scan_descriptor_info()

VKD3D_SHADER_API void vkd3d_shader_free_scan_descriptor_info ( struct vkd3d_shader_scan_descriptor_info * scan_descriptor_info )

Free members of struct vkd3d_shader_scan_descriptor_info() allocated by vkd3d_shader_scan().

This function may free members of vkd3d_shader_scan_descriptor_info, but does not free the structure itself.

Parameters

scan_descriptor_info Descriptor information to free.

Definition at line 1768 of file vkd3d_shader_main.c.

{
    TRACE("scan_descriptor_info %p.\n", scan_descriptor_info);
 
    vkd3d_free(scan_descriptor_info->descriptors);
}

Referenced by d3d12_pipeline_state_find_and_init_uav_counters(), shader_spirv_destroy(), shader_spirv_destroy_compute_vk(), and vsir_program_scan().

◆ vkd3d_shader_free_scan_signature_info()

VKD3D_SHADER_API void vkd3d_shader_free_scan_signature_info ( struct vkd3d_shader_scan_signature_info * info )

Free members of struct vkd3d_shader_scan_signature_info allocated by vkd3d_shader_scan().

This function may free members of vkd3d_shader_scan_signature_info, but does not free the structure itself.

Parameters

info	Scan information to free.

Since: 1.9

Definition at line 1775 of file vkd3d_shader_main.c.

{
    TRACE("info %p.\n", info);
 
    vkd3d_shader_free_shader_signature(&info->input);
    vkd3d_shader_free_shader_signature(&info->output);
    vkd3d_shader_free_shader_signature(&info->patch_constant);
}

Referenced by shader_spirv_destroy(), and vsir_program_scan().

◆ vkd3d_shader_free_shader_code()

VKD3D_SHADER_API void vkd3d_shader_free_shader_code ( struct vkd3d_shader_code * code )

Free shader code allocated by another vkd3d-shader function, such as vkd3d_shader_compile().

This function frees the vkd3d_shader_code::code member, but does not free the structure itself.

Parameters

code	Code to free.

Definition at line 1784 of file vkd3d_shader_main.c.

{
    TRACE("shader_code %p.\n", shader_code);
 
    vkd3d_free((void *)shader_code->code);
}

Referenced by compile_hlsl(), create_shader_stage(), create_uav_pipeline(), D3DCompile2(), d3dcompiler_get_blob_part(), d3dcompiler_strip_shader(), D3DDisassemble(), fx_4_parse_shader_initializer(), hlsl_compile_shader(), hlsl_emit_bytecode(), preprocess_shader(), shader_glsl_generate_vkd3d_shader(), shader_spirv_compile_shader(), shader_trace(), spirv_compiler_generate_spirv(), tpf_compile(), vkd3d_serialize_root_signature(), vkd3d_serialize_versioned_root_signature(), vkd3d_uav_clear_state_init(), and vsir_program_trace().

◆ vkd3d_shader_free_shader_signature()

VKD3D_SHADER_API void vkd3d_shader_free_shader_signature ( struct vkd3d_shader_signature * signature )

Free a structural representation of a shader input signature allocated by vkd3d_shader_parse_input_signature().

This function may free members of struct vkd3d_shader_signature, but does not free the structure itself.

Parameters

signature Signature description to free.

Definition at line 1907 of file vkd3d_shader_main.c.

{
    TRACE("signature %p.\n", signature);
 
    for (unsigned int i = 0; i < signature->element_count; ++i)
    {
        vkd3d_free((void *)signature->elements[i].semantic_name);
    }
    vkd3d_free(signature->elements);
    signature->elements = NULL;
}

Referenced by d3d11_input_layout_to_wined3d_declaration(), d3d12_pipeline_state_init_graphics(), and vkd3d_shader_free_scan_signature_info().

◆ vkd3d_shader_get_supported_source_types()

VKD3D_SHADER_API enum vkd3d_shader_source_type * vkd3d_shader_get_supported_source_types ( unsigned int * count )

Returns the source types supported, with any target type, by vkd3d_shader_compile(). Future versions of the library may introduce additional source types; callers should ignore unrecognised source types.

Use vkd3d_shader_get_supported_target_types() to determine which target types are supported for each source type.

Parameters

count Output location for the size, in elements, of the returned array.

Returns: Pointer to an array of source types supported by this version of vkd3d-shader. This array may be a pointer to static data in libvkd3d-shader; it should not be freed.

Definition at line 1937 of file vkd3d_shader_main.c.

{
    static const enum vkd3d_shader_source_type types[] =
    {
        VKD3D_SHADER_SOURCE_DXBC_TPF,
        VKD3D_SHADER_SOURCE_HLSL,
        VKD3D_SHADER_SOURCE_D3D_BYTECODE,
#ifdef VKD3D_SHADER_UNSUPPORTED_DXIL
        VKD3D_SHADER_SOURCE_DXBC_DXIL,
#endif
        VKD3D_SHADER_SOURCE_FX,
    };
 
    TRACE("count %p.\n", count);
 
    *count = ARRAY_SIZE(types);
    return types;
}

Referenced by vkd3d_shader_validate_compile_info().

◆ vkd3d_shader_get_supported_target_types()

VKD3D_SHADER_API enum vkd3d_shader_target_type * vkd3d_shader_get_supported_target_types	(	enum vkd3d_shader_source_type	source_type,
		unsigned int *	count
	)

Returns the target types supported, with the given source type, by vkd3d_shader_compile(). Future versions of the library may introduce additional target types; callers should ignore unrecognised target types.

Parameters

source_type	Source type for which to enumerate supported target types.
count	Output location for the size, in elements, of the returned array.

Returns: Pointer to an array of target types supported by this version of vkd3d-shader. This array may be a pointer to static data in libvkd3d-shader; it should not be freed.

Definition at line 1956 of file vkd3d_shader_main.c.

{
    static const enum vkd3d_shader_target_type dxbc_tpf_types[] =
    {
        VKD3D_SHADER_TARGET_SPIRV_BINARY,
#ifdef HAVE_SPIRV_TOOLS
        VKD3D_SHADER_TARGET_SPIRV_TEXT,
#endif
        VKD3D_SHADER_TARGET_D3D_ASM,
#ifdef VKD3D_SHADER_UNSUPPORTED_GLSL
        VKD3D_SHADER_TARGET_GLSL,
#endif
#ifdef VKD3D_SHADER_UNSUPPORTED_MSL
        VKD3D_SHADER_TARGET_MSL,
#endif
    };
 
    static const enum vkd3d_shader_target_type hlsl_types[] =
    {
        VKD3D_SHADER_TARGET_SPIRV_BINARY,
#ifdef HAVE_SPIRV_TOOLS
        VKD3D_SHADER_TARGET_SPIRV_TEXT,
#endif
        VKD3D_SHADER_TARGET_D3D_ASM,
        VKD3D_SHADER_TARGET_D3D_BYTECODE,
        VKD3D_SHADER_TARGET_DXBC_TPF,
        VKD3D_SHADER_TARGET_FX,
    };
 
    static const enum vkd3d_shader_target_type d3dbc_types[] =
    {
        VKD3D_SHADER_TARGET_SPIRV_BINARY,
#ifdef HAVE_SPIRV_TOOLS
        VKD3D_SHADER_TARGET_SPIRV_TEXT,
#endif
        VKD3D_SHADER_TARGET_D3D_ASM,
    };
 
#ifdef VKD3D_SHADER_UNSUPPORTED_DXIL
    static const enum vkd3d_shader_target_type dxbc_dxil_types[] =
    {
        VKD3D_SHADER_TARGET_SPIRV_BINARY,
# ifdef HAVE_SPIRV_TOOLS
        VKD3D_SHADER_TARGET_SPIRV_TEXT,
# endif
        VKD3D_SHADER_TARGET_D3D_ASM,
    };
#endif
 
    static const enum vkd3d_shader_target_type fx_types[] =
    {
        VKD3D_SHADER_TARGET_D3D_ASM,
    };
 
    TRACE("source_type %#x, count %p.\n", source_type, count);
 
    switch (source_type)
    {
        case VKD3D_SHADER_SOURCE_DXBC_TPF:
            *count = ARRAY_SIZE(dxbc_tpf_types);
            return dxbc_tpf_types;
 
        case VKD3D_SHADER_SOURCE_HLSL:
            *count = ARRAY_SIZE(hlsl_types);
            return hlsl_types;
 
        case VKD3D_SHADER_SOURCE_D3D_BYTECODE:
            *count = ARRAY_SIZE(d3dbc_types);
            return d3dbc_types;
 
#ifdef VKD3D_SHADER_UNSUPPORTED_DXIL
        case VKD3D_SHADER_SOURCE_DXBC_DXIL:
            *count = ARRAY_SIZE(dxbc_dxil_types);
            return dxbc_dxil_types;
#endif
 
        case VKD3D_SHADER_SOURCE_FX:
            *count = ARRAY_SIZE(fx_types);
            return fx_types;
 
        default:
            *count = 0;
            return NULL;
    }
}

Referenced by vkd3d_shader_validate_compile_info().

◆ vkd3d_shader_get_version()

VKD3D_SHADER_API const char * vkd3d_shader_get_version	(	unsigned int *	major,
		unsigned int *	minor
	)

Returns the current version of this library.

Parameters

major	Output location for the major version of this library.
minor	Output location for the minor version of this library.

Returns: A human-readable string describing the library name and version. This string is null-terminated and UTF-8 encoded. This may be a pointer to static data in libvkd3d-shader; it should not be freed.

Definition at line 1919 of file vkd3d_shader_main.c.

{
    int x, y;
 
    TRACE("major %p, minor %p.\n", major, minor);
 
    if (major || minor)
    {
        vkd3d_parse_version(PACKAGE_VERSION, &x, &y);
        if (major)
            *major = x;
        if (minor)
            *minor = y;
    }
 
    return "vkd3d-shader " PACKAGE_VERSION VKD3D_VCS_ID;
}

Referenced by msl_generator_generate(), shader_glsl_alloc(), vkd3d_glsl_generator_generate(), wined3d_spirv_shader_backend_init_vk(), write_sm1_uniforms(), and write_sm4_rdef().

◆ vkd3d_shader_parse_dxbc()

VKD3D_SHADER_API int vkd3d_shader_parse_dxbc	(	const struct vkd3d_shader_code *	dxbc,
		uint32_t	flags,
		struct vkd3d_shader_dxbc_desc *	desc,
		char **	messages
	)

Parse a DXBC blob contained in a vkd3d_shader_code structure.

Parameters

dxbc	A vkd3d_shader_code structure containing the DXBC blob to parse.
flags	A combination of zero or more elements of enum vkd3d_shader_parse_dxbc_flags.
desc	A vkd3d_shader_dxbc_desc structure describing the contents of the DXBC blob. Its vkd3d_shader_dxbc_section_desc structures will contain pointers into the input blob; its contents are only valid while the input blob is valid. The contents of this structure should be freed with vkd3d_shader_free_dxbc() when no longer needed.
messages	Optional output location for error or informational messages produced by the parser. This string is null-terminated and UTF-8 encoded. The messages are allocated by vkd3d-shader and should be freed with vkd3d_shader_free_messages() when no longer needed. If no messages are produced by the parser, this parameter may receive NULL instead of a valid string pointer.

Returns: A member of vkd3d_result.

Since: 1.7

Definition at line 320 of file dxbc.c.

{
    struct vkd3d_shader_message_context message_context;
    int ret;
 
    TRACE("dxbc {%p, %zu}, flags %#x, desc %p, messages %p.\n", dxbc->code, dxbc->size, flags, desc, messages);
 
    if (messages)
        *messages = NULL;
    vkd3d_shader_message_context_init(&message_context, VKD3D_SHADER_LOG_INFO);
 
    ret = parse_dxbc(dxbc, &message_context, NULL, flags, desc);
 
    vkd3d_shader_message_context_trace_messages(&message_context);
    if (!vkd3d_shader_message_context_copy_messages(&message_context, messages) && ret >= 0)
    {
        vkd3d_shader_free_dxbc(desc);
        ret = VKD3D_ERROR_OUT_OF_MEMORY;
    }
    vkd3d_shader_message_context_cleanup(&message_context);
 
    if (ret < 0)
        memset(desc, 0, sizeof(*desc));
 
    return ret;
}

Referenced by d3d10_effect_parse(), d3dcompiler_get_blob_part(), d3dcompiler_shader_reflection_init(), d3dcompiler_strip_shader(), parse_fx10_preshader(), vkd3d_shader_parse_dxbc_source_type(), and wined3d_shader_extract_from_dxbc().

◆ vkd3d_shader_parse_input_signature()

VKD3D_SHADER_API int vkd3d_shader_parse_input_signature	(	const struct vkd3d_shader_code *	dxbc,
		struct vkd3d_shader_signature *	signature,
		char **	messages
	)

Read the input signature of a compiled DXBC shader, returning a structural description which can be easily parsed by C code.

This function parses a compiled shader. To parse a standalone root signature, use vkd3d_shader_parse_root_signature().

This function only parses DXBC shaders, and only retrieves the input signature. To retrieve signatures from other shader types, or other signature types, use vkd3d_shader_scan() and struct vkd3d_shader_scan_signature_info. This function returns the same input signature that is returned in struct vkd3d_shader_scan_signature_info.

Parameters

dxbc	Compiled byte code, in DXBC format.
signature	Output location in which the parsed root signature will be stored. Members of signature may be allocated by vkd3d-shader. The signature should be freed with vkd3d_shader_free_shader_signature() when no longer needed. The signature may contain pointers into the input shader, and should only be accessed while the input shader remains valid.
messages	Optional output location for error or informational messages produced by the parser. This string is null-terminated and UTF-8 encoded. The messages are allocated by vkd3d-shader and should be freed with vkd3d_shader_free_messages() when no longer needed. If no messages are produced by the parser, this parameter may receive NULL instead of a valid string pointer.

Returns: A member of vkd3d_result.

Definition at line 1858 of file vkd3d_shader_main.c.

{
    struct vkd3d_shader_message_context message_context;
    struct shader_signature shader_signature;
    int ret;
 
    TRACE("dxbc {%p, %zu}, signature %p, messages %p.\n", dxbc->code, dxbc->size, signature, messages);
 
    if (messages)
        *messages = NULL;
    vkd3d_shader_message_context_init(&message_context, VKD3D_SHADER_LOG_INFO);
 
    ret = shader_parse_input_signature(dxbc, &message_context, &shader_signature);
    vkd3d_shader_message_context_trace_messages(&message_context);
    if (!vkd3d_shader_message_context_copy_messages(&message_context, messages))
        ret = VKD3D_ERROR_OUT_OF_MEMORY;
 
    vkd3d_shader_message_context_cleanup(&message_context);
 
    if (!vkd3d_shader_signature_from_shader_signature(signature, &shader_signature))
        ret = VKD3D_ERROR_OUT_OF_MEMORY;
 
    shader_signature_cleanup(&shader_signature);
    return ret;
}

Referenced by d3d11_input_layout_to_wined3d_declaration(), and d3d12_pipeline_state_init_graphics().

◆ vkd3d_shader_parse_root_signature()

VKD3D_SHADER_API int vkd3d_shader_parse_root_signature	(	const struct vkd3d_shader_code *	dxbc,
		struct vkd3d_shader_versioned_root_signature_desc *	root_signature,
		char **	messages
	)

Convert a byte code description of a shader root signature to a structural description which can be easily parsed by C code.

This function corresponds to ID3D12VersionedRootSignatureDeserializer::GetUnconvertedRootSignatureDesc().

This function performs the reverse transformation of vkd3d_shader_serialize_root_signature().

This function parses a standalone root signature, and should not be confused with vkd3d_shader_parse_input_signature().

Parameters

dxbc	Compiled byte code, in DXBC format.
root_signature	Output location in which the decompiled root signature will be stored. Members of root_signature may be allocated by vkd3d-shader. The signature should be freed with vkd3d_shader_free_root_signature() when no longer needed.
messages	Optional output location for error or informational messages produced by the parser. This string is null-terminated and UTF-8 encoded. The messages are allocated by vkd3d-shader and should be freed with vkd3d_shader_free_messages() when no longer needed. If no messages are produced by the parser, this parameter may receive NULL instead of a valid string pointer.

Returns: A member of vkd3d_result.

Definition at line 1043 of file dxbc.c.

{
    struct vkd3d_shader_message_context message_context;
    int ret;
 
    TRACE("dxbc {%p, %zu}, root_signature %p, messages %p.\n", dxbc->code, dxbc->size, root_signature, messages);
 
    memset(root_signature, 0, sizeof(*root_signature));
    if (messages)
        *messages = NULL;
    vkd3d_shader_message_context_init(&message_context, VKD3D_SHADER_LOG_INFO);
 
    ret = for_each_dxbc_section(dxbc, &message_context, NULL, rts0_handler, root_signature);
    vkd3d_shader_message_context_trace_messages(&message_context);
    if (!vkd3d_shader_message_context_copy_messages(&message_context, messages))
        ret = VKD3D_ERROR_OUT_OF_MEMORY;
 
    vkd3d_shader_message_context_cleanup(&message_context);
    if (ret < 0)
        vkd3d_shader_free_root_signature(root_signature);
 
    return ret;
}

Referenced by d3d12_versioned_root_signature_deserializer_init(), and vkd3d_parse_root_signature_v_1_0().

◆ vkd3d_shader_preprocess()

VKD3D_SHADER_API int vkd3d_shader_preprocess	(	const struct vkd3d_shader_compile_info *	compile_info,
		struct vkd3d_shader_code *	out,
		char **	messages
	)

Preprocess the given source code.

This function supports the following chained structures:

vkd3d_shader_preprocess_info

Parameters

compile_info	A chained structure containing compilation parameters.
out	A pointer to a vkd3d_shader_code structure in which the preprocessed code will be stored. The preprocessed shader is allocated by vkd3d-shader and should be freed with vkd3d_shader_free_shader_code() when no longer needed.
messages	Optional output location for error or informational messages produced by the preprocessor. This string is null-terminated and UTF-8 encoded. The messages are allocated by vkd3d-shader and should be freed with vkd3d_shader_free_messages() when no longer needed. The messages returned can be regulated with the log_level member of struct vkd3d_shader_compile_info. Regardless of the requested level, if this parameter is NULL, no compilation messages will be returned. If no messages are produced by the preprocessor, this parameter may receive NULL instead of a valid string pointer.

Returns: A member of vkd3d_result.

Since: 1.3

Definition at line 2043 of file vkd3d_shader_main.c.

{
    struct vkd3d_shader_message_context message_context;
    int ret;
 
    TRACE("compile_info %p, out %p, messages %p.\n", compile_info, out, messages);
 
    if (messages)
        *messages = NULL;
 
    if ((ret = vkd3d_shader_validate_compile_info(compile_info, false)) < 0)
        return ret;
 
    vkd3d_shader_message_context_init(&message_context, compile_info->log_level);
 
    ret = preproc_lexer_parse(compile_info, out, &message_context);
 
    vkd3d_shader_message_context_trace_messages(&message_context);
    if (!vkd3d_shader_message_context_copy_messages(&message_context, messages))
        ret = VKD3D_ERROR_OUT_OF_MEMORY;
    vkd3d_shader_message_context_cleanup(&message_context);
    return ret;
}

Referenced by preprocess_shader().

◆ vkd3d_shader_scan()

VKD3D_SHADER_API int vkd3d_shader_scan	(	const struct vkd3d_shader_compile_info *	compile_info,
		char **	messages
	)

Parse shader source code or byte code, returning various types of requested information.

The source_type member of compile_info must be set to the type of the shader.

The target_type member may be set to VKD3D_SHADER_TARGET_NONE, in which case vkd3d_shader_scan() will return information about the shader in isolation. Alternatively, it may be set to a valid compilation target for the shader, in which case vkd3d_shader_scan() will return information that reflects the interface for a shader as it will be compiled to that target. In this case other chained structures may be appended to compile_info as they would be passed to vkd3d_shader_compile(), and interpreted accordingly, such as vkd3d_shader_spirv_target_info.

(For a hypothetical example, suppose the source shader distinguishes float and integer texture data, but the target environment does not support integer textures. In this case vkd3d_shader_compile() might translate integer operations to float. Accordingly using VKD3D_SHADER_TARGET_NONE would accurately report whether the texture expects integer or float data, but using the relevant specific target type would report VKD3D_SHADER_RESOURCE_DATA_FLOAT.)

Currently this function supports the following code types:

VKD3D_SHADER_SOURCE_DXBC_TPF
VKD3D_SHADER_SOURCE_D3D_BYTECODE

Parameters

compile_info

A chained structure containing scan parameters.
The scanner supports the following chained structures:

vkd3d_shader_scan_descriptor_info
vkd3d_shader_scan_signature_info
vkd3d_shader_scan_combined_resource_sampler_info
Although the compile_info parameter is read-only, chained structures passed to this function need not be, and may serve as output parameters, depending on their structure type.

messages Optional output location for error or informational messages produced by the parser.
This string is null-terminated and UTF-8 encoded.
The messages are allocated by vkd3d-shader and should be freed with vkd3d_shader_free_messages() when no longer needed.
The messages returned can be regulated with the log_level member of struct vkd3d_shader_compile_info. Regardless of the requested level, if this parameter is NULL, no compilation messages will be returned.
If no messages are produced by the parser, this parameter may receive NULL instead of a valid string pointer.

Returns: A member of vkd3d_result.

Definition at line 1595 of file vkd3d_shader_main.c.

{
    struct vkd3d_shader_message_context message_context;
    struct shader_dump_data dump_data;
    int ret;
 
    TRACE("compile_info %p, messages %p.\n", compile_info, messages);
 
    if (messages)
        *messages = NULL;
 
    if ((ret = vkd3d_shader_validate_compile_info(compile_info, false)) < 0)
        return ret;
 
    init_scan_signature_info(compile_info);
 
    vkd3d_shader_message_context_init(&message_context, compile_info->log_level);
 
    fill_shader_dump_data(compile_info, &dump_data);
    vkd3d_shader_dump_shader(&dump_data, compile_info->source.code, compile_info->source.size, true);
 
    if (compile_info->source_type == VKD3D_SHADER_SOURCE_HLSL)
    {
        FIXME("HLSL support not implemented.\n");
        ret = VKD3D_ERROR_NOT_IMPLEMENTED;
    }
    else
    {
        uint64_t config_flags = vkd3d_shader_init_config_flags();
        struct vsir_program program;
 
        if (!(ret = vsir_parse(compile_info, config_flags, &message_context, &program)))
        {
            ret = vsir_program_scan(&program, compile_info, &message_context, NULL);
            vsir_program_cleanup(&program);
        }
    }
 
    vkd3d_shader_message_context_trace_messages(&message_context);
    if (!vkd3d_shader_message_context_copy_messages(&message_context, messages))
        ret = VKD3D_ERROR_OUT_OF_MEMORY;
    vkd3d_shader_message_context_cleanup(&message_context);
    return ret;
}

Referenced by shader_spirv_scan_shader(), and vkd3d_scan_dxbc().

◆ vkd3d_shader_serialize_dxbc()

VKD3D_SHADER_API int vkd3d_shader_serialize_dxbc	(	size_t	section_count,
		const struct vkd3d_shader_dxbc_section_desc *	sections,
		struct vkd3d_shader_code *	dxbc,
		char **	messages
	)

Serialize a DXBC description into a blob stored in a vkd3d_shader_code structure.

Parameters

section_count	The number of DXBC sections to serialize.
sections	An array of vkd3d_shader_dxbc_section_desc structures to serialize.
dxbc	A pointer to a vkd3d_shader_code structure in which the serialized blob will be stored. The output blob is allocated by vkd3d-shader and should be freed with vkd3d_shader_free_shader_code() when no longer needed.
messages	Optional output location for error or informational messages produced by the serializer. This string is null-terminated and UTF-8 encoded. The messages are allocated by vkd3d-shader and should be freed with vkd3d_shader_free_messages() when no longer needed. If no messages are produced by the serializer, this parameter may receive NULL instead of a valid string pointer.

Returns: A member of vkd3d_result.

Since: 1.7

Definition at line 53 of file dxbc.c.

{
    size_t size_position, offsets_position, checksum_position, i;
    struct vkd3d_bytecode_buffer buffer = {0};
    uint32_t checksum[4];
 
    TRACE("section_count %zu, sections %p, dxbc %p, messages %p.\n", section_count, sections, dxbc, messages);
 
    if (messages)
        *messages = NULL;
 
    put_u32(&buffer, TAG_DXBC);
 
    checksum_position = bytecode_get_size(&buffer);
    for (i = 0; i < 4; ++i)
        put_u32(&buffer, 0);
 
    put_u32(&buffer, 1); /* version */
    size_position = put_u32(&buffer, 0);
    put_u32(&buffer, section_count);
 
    offsets_position = bytecode_get_size(&buffer);
    for (i = 0; i < section_count; ++i)
        put_u32(&buffer, 0);
 
    for (i = 0; i < section_count; ++i)
    {
        set_u32(&buffer, offsets_position + i * sizeof(uint32_t), bytecode_align(&buffer));
        put_u32(&buffer, sections[i].tag);
        put_u32(&buffer, sections[i].data.size);
        bytecode_put_bytes(&buffer, sections[i].data.code, sections[i].data.size);
    }
    set_u32(&buffer, size_position, bytecode_get_size(&buffer));
 
    compute_dxbc_checksum(buffer.data, buffer.size, checksum);
    for (i = 0; i < 4; ++i)
        set_u32(&buffer, checksum_position + i * sizeof(uint32_t), checksum[i]);
 
    if (!buffer.status)
    {
        dxbc->code = buffer.data;
        dxbc->size = buffer.size;
    }
    return buffer.status;
}

Referenced by D3DCompile2(), d3dcompiler_get_blob_part(), d3dcompiler_strip_shader(), and dxbc_writer_write().

◆ vkd3d_shader_serialize_root_signature()

VKD3D_SHADER_API int vkd3d_shader_serialize_root_signature	(	const struct vkd3d_shader_versioned_root_signature_desc *	root_signature,
		struct vkd3d_shader_code *	dxbc,
		char **	messages
	)

Convert a structural description of a shader root signature to a byte code format capable of being read by ID3D12Device::CreateRootSignature. The compiled signature is compatible with Microsoft D3D 12.

This function corresponds to D3D12SerializeVersionedRootSignature().

Parameters

root_signature	Description of the root signature.
dxbc	A pointer to a vkd3d_shader_code structure in which the compiled code will be stored. The compiled signature is allocated by vkd3d-shader and should be freed with vkd3d_shader_free_shader_code() when no longer needed.
messages	Optional output location for error or informational messages produced by the serializer. This string is null-terminated and UTF-8 encoded. The messages are allocated by vkd3d-shader and should be freed with vkd3d_shader_free_messages() when no longer needed. If no messages are produced by the serializer, this parameter may receive NULL instead of a valid string pointer.

Returns: A member of vkd3d_result.

Definition at line 1447 of file dxbc.c.

{
    struct root_signature_writer_context context;
    size_t total_size, chunk_size;
    uint32_t checksum[4];
    unsigned int i;
    int ret;
 
    TRACE("root_signature %p, dxbc %p, messages %p.\n", root_signature, dxbc, messages);
 
    if (messages)
        *messages = NULL;
 
    memset(&context, 0, sizeof(context));
    vkd3d_shader_message_context_init(&context.message_context, VKD3D_SHADER_LOG_INFO);
 
    if (root_signature->version != VKD3D_SHADER_ROOT_SIGNATURE_VERSION_1_0
            && root_signature->version != VKD3D_SHADER_ROOT_SIGNATURE_VERSION_1_1)
    {
        ret = VKD3D_ERROR_INVALID_ARGUMENT;
        WARN("Root signature version %#x not supported.\n", root_signature->version);
        vkd3d_shader_error(&context.message_context, NULL, VKD3D_SHADER_ERROR_RS_INVALID_VERSION,
                "Root signature version %#x is not supported.", root_signature->version);
        goto done;
    }
 
    if ((ret = validate_root_signature_desc(root_signature, &context.message_context)) < 0)
        goto done;
 
    memset(dxbc, 0, sizeof(*dxbc));
    shader_write_root_signature_header(&context);
 
    if ((ret = shader_write_root_signature(&context, root_signature)) < 0)
    {
        vkd3d_free(context.buffer.data);
        goto done;
    }
 
    if (context.buffer.status)
    {
        vkd3d_shader_error(&context.message_context, NULL, VKD3D_SHADER_ERROR_RS_OUT_OF_MEMORY,
                "Out of memory while writing root signature.");
        vkd3d_free(context.buffer.data);
        goto done;
    }
 
    total_size = bytecode_get_size(&context.buffer);
    chunk_size = get_chunk_offset(&context);
    set_u32(&context.buffer, context.total_size_position, total_size);
    set_u32(&context.buffer, context.chunk_position - sizeof(uint32_t), chunk_size);
 
    dxbc->code = context.buffer.data;
    dxbc->size = total_size;
 
    compute_dxbc_checksum(dxbc->code, dxbc->size, checksum);
    for (i = 0; i < 4; ++i)
        set_u32(&context.buffer, (i + 1) * sizeof(uint32_t), checksum[i]);
 
    ret = VKD3D_OK;
 
done:
    vkd3d_shader_message_context_trace_messages(&context.message_context);
    if (!vkd3d_shader_message_context_copy_messages(&context.message_context, messages))
        ret = VKD3D_ERROR_OUT_OF_MEMORY;
    vkd3d_shader_message_context_cleanup(&context.message_context);
    return ret;
}

Referenced by vkd3d_serialize_root_signature(), and vkd3d_serialize_versioned_root_signature().

◆ vkd3d_shader_set_log_callback()

VKD3D_SHADER_API void vkd3d_shader_set_log_callback ( PFN_vkd3d_log callback )

Set a callback to be called when vkd3d-shader outputs debug logging.

If NULL, or if this function has not been called, libvkd3d-shader will print all enabled log output to stderr.

Parameters

callback Callback function to set.

Since: 1.4

Definition at line 2068 of file vkd3d_shader_main.c.

{
    vkd3d_dbg_set_log_callback(callback);
}

Referenced by vkd3d_set_log_callback().

Classes

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ VKD3D_SHADER_API

◆ VKD3D_SHADER_DUMMY_SAMPLER_INDEX

◆ VKD3D_SHADER_NO_SWIZZLE

◆ VKD3D_SHADER_SWIZZLE

◆ VKD3D_SHADER_SWIZZLE_MASK

◆ VKD3D_SHADER_SWIZZLE_SHIFT

Typedef Documentation

◆ PFN_vkd3d_shader_build_varying_map

◆ PFN_vkd3d_shader_close_include

◆ PFN_vkd3d_shader_compile

◆ PFN_vkd3d_shader_convert_root_signature

◆ PFN_vkd3d_shader_find_signature_element

◆ PFN_vkd3d_shader_free_dxbc

◆ PFN_vkd3d_shader_free_messages

◆ PFN_vkd3d_shader_free_root_signature

◆ PFN_vkd3d_shader_free_scan_combined_resource_sampler_info

◆ PFN_vkd3d_shader_free_scan_descriptor_info

◆ PFN_vkd3d_shader_free_scan_signature_info

◆ PFN_vkd3d_shader_free_shader_code

◆ PFN_vkd3d_shader_free_shader_signature

◆ PFN_vkd3d_shader_get_supported_source_types

◆ PFN_vkd3d_shader_get_supported_target_types

◆ PFN_vkd3d_shader_get_version

◆ PFN_vkd3d_shader_open_include

◆ PFN_vkd3d_shader_parse_dxbc

◆ PFN_vkd3d_shader_parse_input_signature

◆ PFN_vkd3d_shader_parse_root_signature

◆ PFN_vkd3d_shader_preprocess

◆ PFN_vkd3d_shader_scan

◆ PFN_vkd3d_shader_serialize_dxbc

◆ PFN_vkd3d_shader_serialize_root_signature

◆ PFN_vkd3d_shader_set_log_callback

Enumeration Type Documentation

◆ vkd3d_shader_api_version

◆ vkd3d_shader_binding_flag

◆ vkd3d_shader_comparison_func

◆ vkd3d_shader_compile_option_backward_compatibility

◆ vkd3d_shader_compile_option_buffer_uav

◆ vkd3d_shader_compile_option_feature_flags

◆ vkd3d_shader_compile_option_formatting_flags

◆ vkd3d_shader_compile_option_fragment_coordinate_origin

◆ vkd3d_shader_compile_option_name

◆ vkd3d_shader_compile_option_pack_matrix_order

◆ vkd3d_shader_compile_option_typed_uav

◆ vkd3d_shader_component_type

◆ vkd3d_shader_d3dbc_constant_register

◆ vkd3d_shader_descriptor_info_flag

◆ vkd3d_shader_descriptor_range_flags

◆ vkd3d_shader_descriptor_type

◆ vkd3d_shader_filter

◆ vkd3d_shader_log_level

◆ vkd3d_shader_minimum_precision

◆ vkd3d_shader_parameter_data_type

◆ vkd3d_shader_parameter_name

◆ vkd3d_shader_parameter_type

◆ vkd3d_shader_parse_dxbc_flags

◆ vkd3d_shader_resource_data_type

◆ vkd3d_shader_resource_type

◆ vkd3d_shader_root_descriptor_flags

◆ vkd3d_shader_root_parameter_type

◆ vkd3d_shader_root_signature_flags

◆ vkd3d_shader_root_signature_version

◆ vkd3d_shader_source_type

◆ vkd3d_shader_spirv_environment

◆ vkd3d_shader_spirv_extension

◆ vkd3d_shader_static_border_colour

◆ vkd3d_shader_structure_type

◆ vkd3d_shader_swizzle_component

◆ vkd3d_shader_sysval_semantic

◆ vkd3d_shader_target_type

◆ vkd3d_shader_tessellator_output_primitive

◆ vkd3d_shader_tessellator_partitioning

◆ vkd3d_shader_texture_address_mode