NEWS
COMMUNITY
STORE
TUTORIALS
ROKOJORI
NEWSLETTER
SIGN UPLOGIN
LOGOUTNEWS
COMMUNITY
STORE
TUTORIALS
On startup, Godot creates a global RenderingDevice which can be retrieved using [method RenderingServer.get_rendering_device]. This global RenderingDevice performs drawing to the screen.
Local RenderingDevices: Using [method RenderingServer.create_local_rendering_device], you can create "secondary" rendering devices to perform drawing and GPU compute operations on separate threads.
Note: RenderingDevice assumes intermediate knowledge of modern graphics APIs such as Vulkan, Direct3D 12, Metal or WebGPU. These graphics APIs are lower-level than OpenGL or Direct3D 11, requiring you to perform what was previously done by the graphics driver itself. If you have difficulty understanding the concepts used in this class, follow the [url=https://vulkan-tutorial.com/]Vulkan Tutorial[/url] or [url=https://vkguide.dev/]Vulkan Guide[/url]. It's recommended to have existing modern OpenGL or Direct3D 11 knowledge before attempting to learn a low-level graphics API.
Note: RenderingDevice is not available when running in headless mode or when using the Compatibility rendering method.
DEVICE_TYPE_OTHER:null = 0
Rendering device type does not match any of the other enum values or is unknown.
DEVICE_TYPE_INTEGRATED_GPU:null = 1
Rendering device is an integrated GPU, which is typically (but not always) slower than dedicated GPUs (DEVICE_TYPE_DISCRETE_GPU). On Android and iOS, the rendering device type is always considered to be DEVICE_TYPE_INTEGRATED_GPU.
DEVICE_TYPE_DISCRETE_GPU:null = 2
Rendering device is a dedicated GPU, which is typically (but not always) faster than integrated GPUs (DEVICE_TYPE_INTEGRATED_GPU).
DEVICE_TYPE_VIRTUAL_GPU:null = 3
Rendering device is an emulated GPU in a virtual environment. This is typically much slower than the host GPU, which means the expected performance level on a dedicated GPU will be roughly equivalent to DEVICE_TYPE_INTEGRATED_GPU. Virtual machine GPU passthrough (such as VFIO) will not report the device type as DEVICE_TYPE_VIRTUAL_GPU. Instead, the host GPU's device type will be reported as if the GPU was not emulated.
DEVICE_TYPE_CPU:null = 4
Rendering device is provided by software emulation (such as Lavapipe or [url=https://github.com/google/swiftshader]SwiftShader[/url]). This is the slowest kind of rendering device available; it's typically much slower than DEVICE_TYPE_INTEGRATED_GPU.
DEVICE_TYPE_MAX:null = 5
Represents the size of the DeviceType enum.
DRIVER_RESOURCE_LOGICAL_DEVICE:null = 0
Specific device object based on a physical device (
- Vulkan: Vulkan device driver resource (
- D3D12: D3D12 device driver resource (
- Metal: Metal device driver resource (
DRIVER_RESOURCE_PHYSICAL_DEVICE:null = 1
Physical device the specific logical device is based on (
- Vulkan:
- D3D12:
DRIVER_RESOURCE_TOPMOST_OBJECT:null = 2
Top-most graphics API entry object (
- Vulkan:
DRIVER_RESOURCE_COMMAND_QUEUE:null = 3
The main graphics-compute command queue (
- Vulkan:
- D3D12:
- Metal:
DRIVER_RESOURCE_QUEUE_FAMILY:null = 4
The specific family the main queue belongs to (
- Vulkan: The queue family index, a
DRIVER_RESOURCE_TEXTURE:null = 5
- Vulkan:
- D3D12:
DRIVER_RESOURCE_TEXTURE_VIEW:null = 6
The view of an owned or shared texture.
- Vulkan:
- D3D12:
DRIVER_RESOURCE_TEXTURE_DATA_FORMAT:null = 7
The native id of the data format of the texture.
- Vulkan:
- D3D12:
DRIVER_RESOURCE_SAMPLER:null = 8
- Vulkan:
DRIVER_RESOURCE_UNIFORM_SET:null = 9
- Vulkan:
DRIVER_RESOURCE_BUFFER:null = 10
Buffer of any kind of (storage, vertex, etc.).
- Vulkan:
- D3D12:
DRIVER_RESOURCE_COMPUTE_PIPELINE:null = 11
- Vulkan:
- Metal:
DRIVER_RESOURCE_RENDER_PIPELINE:null = 12
- Vulkan:
- Metal:
DRIVER_RESOURCE_VULKAN_DEVICE:null = 0
DRIVER_RESOURCE_VULKAN_PHYSICAL_DEVICE:null = 1
DRIVER_RESOURCE_VULKAN_INSTANCE:null = 2
DRIVER_RESOURCE_VULKAN_QUEUE:null = 3
DRIVER_RESOURCE_VULKAN_QUEUE_FAMILY_INDEX:null = 4
DRIVER_RESOURCE_VULKAN_IMAGE:null = 5
DRIVER_RESOURCE_VULKAN_IMAGE_VIEW:null = 6
DRIVER_RESOURCE_VULKAN_IMAGE_NATIVE_TEXTURE_FORMAT:null = 7
DRIVER_RESOURCE_VULKAN_SAMPLER:null = 8
DRIVER_RESOURCE_VULKAN_DESCRIPTOR_SET:null = 9
DRIVER_RESOURCE_VULKAN_BUFFER:null = 10
DRIVER_RESOURCE_VULKAN_COMPUTE_PIPELINE:null = 11
DRIVER_RESOURCE_VULKAN_RENDER_PIPELINE:null = 12
DATA_FORMAT_R4G4_UNORM_PACK8:null = 0
4-bit-per-channel red/green channel data format, packed into 8 bits. Values are in the
Note: More information on all data formats can be found on the [url=https://registry.khronos.org/vulkan/specs/1.1/html/vkspec.html#_identification_of_formats]Identification of formats[/url] section of the Vulkan specification, as well as the [url=https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkFormat.html]VkFormat[/url] enum.
DATA_FORMAT_R4G4B4A4_UNORM_PACK16:null = 1
4-bit-per-channel red/green/blue/alpha channel data format, packed into 16 bits. Values are in the
DATA_FORMAT_B4G4R4A4_UNORM_PACK16:null = 2
4-bit-per-channel blue/green/red/alpha channel data format, packed into 16 bits. Values are in the
DATA_FORMAT_R5G6B5_UNORM_PACK16:null = 3
Red/green/blue channel data format with 5 bits of red, 6 bits of green and 5 bits of blue, packed into 16 bits. Values are in the
DATA_FORMAT_B5G6R5_UNORM_PACK16:null = 4
Blue/green/red channel data format with 5 bits of blue, 6 bits of green and 5 bits of red, packed into 16 bits. Values are in the
DATA_FORMAT_R5G5B5A1_UNORM_PACK16:null = 5
Red/green/blue/alpha channel data format with 5 bits of red, 6 bits of green, 5 bits of blue and 1 bit of alpha, packed into 16 bits. Values are in the
DATA_FORMAT_B5G5R5A1_UNORM_PACK16:null = 6
Blue/green/red/alpha channel data format with 5 bits of blue, 6 bits of green, 5 bits of red and 1 bit of alpha, packed into 16 bits. Values are in the
DATA_FORMAT_A1R5G5B5_UNORM_PACK16:null = 7
Alpha/red/green/blue channel data format with 1 bit of alpha, 5 bits of red, 6 bits of green and 5 bits of blue, packed into 16 bits. Values are in the
DATA_FORMAT_R8_UNORM:null = 8
8-bit-per-channel unsigned floating-point red channel data format with normalized value. Values are in the
DATA_FORMAT_R8_SNORM:null = 9
8-bit-per-channel signed floating-point red channel data format with normalized value. Values are in the
DATA_FORMAT_R8_USCALED:null = 10
8-bit-per-channel unsigned floating-point red channel data format with scaled value (value is converted from integer to float). Values are in the
DATA_FORMAT_R8_SSCALED:null = 11
8-bit-per-channel signed floating-point red channel data format with scaled value (value is converted from integer to float). Values are in the
DATA_FORMAT_R8_UINT:null = 12
8-bit-per-channel unsigned integer red channel data format. Values are in the
DATA_FORMAT_R8_SINT:null = 13
8-bit-per-channel signed integer red channel data format. Values are in the
DATA_FORMAT_R8_SRGB:null = 14
8-bit-per-channel unsigned floating-point red channel data format with normalized value and nonlinear sRGB encoding. Values are in the
DATA_FORMAT_R8G8_UNORM:null = 15
8-bit-per-channel unsigned floating-point red/green channel data format with normalized value. Values are in the
DATA_FORMAT_R8G8_SNORM:null = 16
8-bit-per-channel signed floating-point red/green channel data format with normalized value. Values are in the
DATA_FORMAT_R8G8_USCALED:null = 17
8-bit-per-channel unsigned floating-point red/green channel data format with scaled value (value is converted from integer to float). Values are in the
DATA_FORMAT_R8G8_SSCALED:null = 18
8-bit-per-channel signed floating-point red/green channel data format with scaled value (value is converted from integer to float). Values are in the
DATA_FORMAT_R8G8_UINT:null = 19
8-bit-per-channel unsigned integer red/green channel data format. Values are in the
DATA_FORMAT_R8G8_SINT:null = 20
8-bit-per-channel signed integer red/green channel data format. Values are in the
DATA_FORMAT_R8G8_SRGB:null = 21
8-bit-per-channel unsigned floating-point red/green channel data format with normalized value and nonlinear sRGB encoding. Values are in the
DATA_FORMAT_R8G8B8_UNORM:null = 22
8-bit-per-channel unsigned floating-point red/green/blue channel data format with normalized value. Values are in the
DATA_FORMAT_R8G8B8_SNORM:null = 23
8-bit-per-channel signed floating-point red/green/blue channel data format with normalized value. Values are in the
DATA_FORMAT_R8G8B8_USCALED:null = 24
8-bit-per-channel unsigned floating-point red/green/blue channel data format with scaled value (value is converted from integer to float). Values are in the
DATA_FORMAT_R8G8B8_SSCALED:null = 25
8-bit-per-channel signed floating-point red/green/blue channel data format with scaled value (value is converted from integer to float). Values are in the
DATA_FORMAT_R8G8B8_UINT:null = 26
8-bit-per-channel unsigned integer red/green/blue channel data format. Values are in the
DATA_FORMAT_R8G8B8_SINT:null = 27
8-bit-per-channel signed integer red/green/blue channel data format. Values are in the
DATA_FORMAT_R8G8B8_SRGB:null = 28
8-bit-per-channel unsigned floating-point red/green/blue channel data format with normalized value and nonlinear sRGB encoding. Values are in the
DATA_FORMAT_B8G8R8_UNORM:null = 29
8-bit-per-channel unsigned floating-point blue/green/red channel data format with normalized value. Values are in the
DATA_FORMAT_B8G8R8_SNORM:null = 30
8-bit-per-channel signed floating-point blue/green/red channel data format with normalized value. Values are in the
DATA_FORMAT_B8G8R8_USCALED:null = 31
8-bit-per-channel unsigned floating-point blue/green/red channel data format with scaled value (value is converted from integer to float). Values are in the
DATA_FORMAT_B8G8R8_SSCALED:null = 32
8-bit-per-channel signed floating-point blue/green/red channel data format with scaled value (value is converted from integer to float). Values are in the
DATA_FORMAT_B8G8R8_UINT:null = 33
8-bit-per-channel unsigned integer blue/green/red channel data format. Values are in the
DATA_FORMAT_B8G8R8_SINT:null = 34
8-bit-per-channel signed integer blue/green/red channel data format. Values are in the
DATA_FORMAT_B8G8R8_SRGB:null = 35
8-bit-per-channel unsigned floating-point blue/green/red data format with normalized value and nonlinear sRGB encoding. Values are in the
DATA_FORMAT_R8G8B8A8_UNORM:null = 36
8-bit-per-channel unsigned floating-point red/green/blue/alpha channel data format with normalized value. Values are in the
DATA_FORMAT_R8G8B8A8_SNORM:null = 37
8-bit-per-channel signed floating-point red/green/blue/alpha channel data format with normalized value. Values are in the
DATA_FORMAT_R8G8B8A8_USCALED:null = 38
8-bit-per-channel unsigned floating-point red/green/blue/alpha channel data format with scaled value (value is converted from integer to float). Values are in the
DATA_FORMAT_R8G8B8A8_SSCALED:null = 39
8-bit-per-channel signed floating-point red/green/blue/alpha channel data format with scaled value (value is converted from integer to float). Values are in the
DATA_FORMAT_R8G8B8A8_UINT:null = 40
8-bit-per-channel unsigned integer red/green/blue/alpha channel data format. Values are in the
DATA_FORMAT_R8G8B8A8_SINT:null = 41
8-bit-per-channel signed integer red/green/blue/alpha channel data format. Values are in the
DATA_FORMAT_R8G8B8A8_SRGB:null = 42
8-bit-per-channel unsigned floating-point red/green/blue/alpha channel data format with normalized value and nonlinear sRGB encoding. Values are in the
DATA_FORMAT_B8G8R8A8_UNORM:null = 43
8-bit-per-channel unsigned floating-point blue/green/red/alpha channel data format with normalized value. Values are in the
DATA_FORMAT_B8G8R8A8_SNORM:null = 44
8-bit-per-channel signed floating-point blue/green/red/alpha channel data format with normalized value. Values are in the
DATA_FORMAT_B8G8R8A8_USCALED:null = 45
8-bit-per-channel unsigned floating-point blue/green/red/alpha channel data format with scaled value (value is converted from integer to float). Values are in the
DATA_FORMAT_B8G8R8A8_SSCALED:null = 46
8-bit-per-channel signed floating-point blue/green/red/alpha channel data format with scaled value (value is converted from integer to float). Values are in the
DATA_FORMAT_B8G8R8A8_UINT:null = 47
8-bit-per-channel unsigned integer blue/green/red/alpha channel data format. Values are in the
DATA_FORMAT_B8G8R8A8_SINT:null = 48
8-bit-per-channel signed integer blue/green/red/alpha channel data format. Values are in the
DATA_FORMAT_B8G8R8A8_SRGB:null = 49
8-bit-per-channel unsigned floating-point blue/green/red/alpha channel data format with normalized value and nonlinear sRGB encoding. Values are in the
DATA_FORMAT_A8B8G8R8_UNORM_PACK32:null = 50
8-bit-per-channel unsigned floating-point alpha/red/green/blue channel data format with normalized value, packed in 32 bits. Values are in the
DATA_FORMAT_A8B8G8R8_SNORM_PACK32:null = 51
8-bit-per-channel signed floating-point alpha/red/green/blue channel data format with normalized value, packed in 32 bits. Values are in the
DATA_FORMAT_A8B8G8R8_USCALED_PACK32:null = 52
8-bit-per-channel unsigned floating-point alpha/red/green/blue channel data format with scaled value (value is converted from integer to float), packed in 32 bits. Values are in the
DATA_FORMAT_A8B8G8R8_SSCALED_PACK32:null = 53
8-bit-per-channel signed floating-point alpha/red/green/blue channel data format with scaled value (value is converted from integer to float), packed in 32 bits. Values are in the
DATA_FORMAT_A8B8G8R8_UINT_PACK32:null = 54
8-bit-per-channel unsigned integer alpha/red/green/blue channel data format, packed in 32 bits. Values are in the
DATA_FORMAT_A8B8G8R8_SINT_PACK32:null = 55
8-bit-per-channel signed integer alpha/red/green/blue channel data format, packed in 32 bits. Values are in the
DATA_FORMAT_A8B8G8R8_SRGB_PACK32:null = 56
8-bit-per-channel unsigned floating-point alpha/red/green/blue channel data format with normalized value and nonlinear sRGB encoding, packed in 32 bits. Values are in the
DATA_FORMAT_A2R10G10B10_UNORM_PACK32:null = 57
Unsigned floating-point alpha/red/green/blue channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of red, 10 bits of green and 10 bits of blue. Values are in the
DATA_FORMAT_A2R10G10B10_SNORM_PACK32:null = 58
Signed floating-point alpha/red/green/blue channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of red, 10 bits of green and 10 bits of blue. Values are in the
DATA_FORMAT_A2R10G10B10_USCALED_PACK32:null = 59
Unsigned floating-point alpha/red/green/blue channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of red, 10 bits of green and 10 bits of blue. Values are in the
DATA_FORMAT_A2R10G10B10_SSCALED_PACK32:null = 60
Signed floating-point alpha/red/green/blue channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of red, 10 bits of green and 10 bits of blue. Values are in the
DATA_FORMAT_A2R10G10B10_UINT_PACK32:null = 61
Unsigned integer alpha/red/green/blue channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of red, 10 bits of green and 10 bits of blue. Values are in the
DATA_FORMAT_A2R10G10B10_SINT_PACK32:null = 62
Signed integer alpha/red/green/blue channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of red, 10 bits of green and 10 bits of blue. Values are in the
DATA_FORMAT_A2B10G10R10_UNORM_PACK32:null = 63
Unsigned floating-point alpha/blue/green/red channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of blue, 10 bits of green and 10 bits of red. Values are in the
DATA_FORMAT_A2B10G10R10_SNORM_PACK32:null = 64
Signed floating-point alpha/blue/green/red channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of blue, 10 bits of green and 10 bits of red. Values are in the
DATA_FORMAT_A2B10G10R10_USCALED_PACK32:null = 65
Unsigned floating-point alpha/blue/green/red channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of blue, 10 bits of green and 10 bits of red. Values are in the
DATA_FORMAT_A2B10G10R10_SSCALED_PACK32:null = 66
Signed floating-point alpha/blue/green/red channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of blue, 10 bits of green and 10 bits of red. Values are in the
DATA_FORMAT_A2B10G10R10_UINT_PACK32:null = 67
Unsigned integer alpha/blue/green/red channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of blue, 10 bits of green and 10 bits of red. Values are in the
DATA_FORMAT_A2B10G10R10_SINT_PACK32:null = 68
Signed integer alpha/blue/green/red channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of blue, 10 bits of green and 10 bits of red. Values are in the
DATA_FORMAT_R16_UNORM:null = 69
16-bit-per-channel unsigned floating-point red channel data format with normalized value. Values are in the
DATA_FORMAT_R16_SNORM:null = 70
16-bit-per-channel signed floating-point red channel data format with normalized value. Values are in the
DATA_FORMAT_R16_USCALED:null = 71
16-bit-per-channel unsigned floating-point red channel data format with scaled value (value is converted from integer to float). Values are in the
DATA_FORMAT_R16_SSCALED:null = 72
16-bit-per-channel signed floating-point red channel data format with scaled value (value is converted from integer to float). Values are in the
DATA_FORMAT_R16_UINT:null = 73
16-bit-per-channel unsigned integer red channel data format. Values are in the
DATA_FORMAT_R16_SINT:null = 74
16-bit-per-channel signed integer red channel data format. Values are in the
DATA_FORMAT_R16_SFLOAT:null = 75
16-bit-per-channel signed floating-point red channel data format with the value stored as-is.
DATA_FORMAT_R16G16_UNORM:null = 76
16-bit-per-channel unsigned floating-point red/green channel data format with normalized value. Values are in the
DATA_FORMAT_R16G16_SNORM:null = 77
16-bit-per-channel signed floating-point red/green channel data format with normalized value. Values are in the
DATA_FORMAT_R16G16_USCALED:null = 78
16-bit-per-channel unsigned floating-point red/green channel data format with scaled value (value is converted from integer to float). Values are in the
DATA_FORMAT_R16G16_SSCALED:null = 79
16-bit-per-channel signed floating-point red/green channel data format with scaled value (value is converted from integer to float). Values are in the
DATA_FORMAT_R16G16_UINT:null = 80
16-bit-per-channel unsigned integer red/green channel data format. Values are in the
DATA_FORMAT_R16G16_SINT:null = 81
16-bit-per-channel signed integer red/green channel data format. Values are in the
DATA_FORMAT_R16G16_SFLOAT:null = 82
16-bit-per-channel signed floating-point red/green channel data format with the value stored as-is.
DATA_FORMAT_R16G16B16_UNORM:null = 83
16-bit-per-channel unsigned floating-point red/green/blue channel data format with normalized value. Values are in the
DATA_FORMAT_R16G16B16_SNORM:null = 84
16-bit-per-channel signed floating-point red/green/blue channel data format with normalized value. Values are in the
DATA_FORMAT_R16G16B16_USCALED:null = 85
16-bit-per-channel unsigned floating-point red/green/blue channel data format with scaled value (value is converted from integer to float). Values are in the
DATA_FORMAT_R16G16B16_SSCALED:null = 86
16-bit-per-channel signed floating-point red/green/blue channel data format with scaled value (value is converted from integer to float). Values are in the
DATA_FORMAT_R16G16B16_UINT:null = 87
16-bit-per-channel unsigned integer red/green/blue channel data format. Values are in the
DATA_FORMAT_R16G16B16_SINT:null = 88
16-bit-per-channel signed integer red/green/blue channel data format. Values are in the
DATA_FORMAT_R16G16B16_SFLOAT:null = 89
16-bit-per-channel signed floating-point red/green/blue channel data format with the value stored as-is.
DATA_FORMAT_R16G16B16A16_UNORM:null = 90
16-bit-per-channel unsigned floating-point red/green/blue/alpha channel data format with normalized value. Values are in the
DATA_FORMAT_R16G16B16A16_SNORM:null = 91
16-bit-per-channel signed floating-point red/green/blue/alpha channel data format with normalized value. Values are in the
DATA_FORMAT_R16G16B16A16_USCALED:null = 92
16-bit-per-channel unsigned floating-point red/green/blue/alpha channel data format with scaled value (value is converted from integer to float). Values are in the
DATA_FORMAT_R16G16B16A16_SSCALED:null = 93
16-bit-per-channel signed floating-point red/green/blue/alpha channel data format with scaled value (value is converted from integer to float). Values are in the
DATA_FORMAT_R16G16B16A16_UINT:null = 94
16-bit-per-channel unsigned integer red/green/blue/alpha channel data format. Values are in the
DATA_FORMAT_R16G16B16A16_SINT:null = 95
16-bit-per-channel signed integer red/green/blue/alpha channel data format. Values are in the
DATA_FORMAT_R16G16B16A16_SFLOAT:null = 96
16-bit-per-channel signed floating-point red/green/blue/alpha channel data format with the value stored as-is.
DATA_FORMAT_R32_UINT:null = 97
32-bit-per-channel unsigned integer red channel data format. Values are in the
DATA_FORMAT_R32_SINT:null = 98
32-bit-per-channel signed integer red channel data format. Values are in the
DATA_FORMAT_R32_SFLOAT:null = 99
32-bit-per-channel signed floating-point red channel data format with the value stored as-is.
DATA_FORMAT_R32G32_UINT:null = 100
32-bit-per-channel unsigned integer red/green channel data format. Values are in the
DATA_FORMAT_R32G32_SINT:null = 101
32-bit-per-channel signed integer red/green channel data format. Values are in the
DATA_FORMAT_R32G32_SFLOAT:null = 102
32-bit-per-channel signed floating-point red/green channel data format with the value stored as-is.
DATA_FORMAT_R32G32B32_UINT:null = 103
32-bit-per-channel unsigned integer red/green/blue channel data format. Values are in the
DATA_FORMAT_R32G32B32_SINT:null = 104
32-bit-per-channel signed integer red/green/blue channel data format. Values are in the
DATA_FORMAT_R32G32B32_SFLOAT:null = 105
32-bit-per-channel signed floating-point red/green/blue channel data format with the value stored as-is.
DATA_FORMAT_R32G32B32A32_UINT:null = 106
32-bit-per-channel unsigned integer red/green/blue/alpha channel data format. Values are in the
DATA_FORMAT_R32G32B32A32_SINT:null = 107
32-bit-per-channel signed integer red/green/blue/alpha channel data format. Values are in the
DATA_FORMAT_R32G32B32A32_SFLOAT:null = 108
32-bit-per-channel signed floating-point red/green/blue/alpha channel data format with the value stored as-is.
DATA_FORMAT_R64_UINT:null = 109
64-bit-per-channel unsigned integer red channel data format. Values are in the
DATA_FORMAT_R64_SINT:null = 110
64-bit-per-channel signed integer red channel data format. Values are in the
DATA_FORMAT_R64_SFLOAT:null = 111
64-bit-per-channel signed floating-point red channel data format with the value stored as-is.
DATA_FORMAT_R64G64_UINT:null = 112
64-bit-per-channel unsigned integer red/green channel data format. Values are in the
DATA_FORMAT_R64G64_SINT:null = 113
64-bit-per-channel signed integer red/green channel data format. Values are in the
DATA_FORMAT_R64G64_SFLOAT:null = 114
64-bit-per-channel signed floating-point red/green channel data format with the value stored as-is.
DATA_FORMAT_R64G64B64_UINT:null = 115
64-bit-per-channel unsigned integer red/green/blue channel data format. Values are in the
DATA_FORMAT_R64G64B64_SINT:null = 116
64-bit-per-channel signed integer red/green/blue channel data format. Values are in the
DATA_FORMAT_R64G64B64_SFLOAT:null = 117
64-bit-per-channel signed floating-point red/green/blue channel data format with the value stored as-is.
DATA_FORMAT_R64G64B64A64_UINT:null = 118
64-bit-per-channel unsigned integer red/green/blue/alpha channel data format. Values are in the
DATA_FORMAT_R64G64B64A64_SINT:null = 119
64-bit-per-channel signed integer red/green/blue/alpha channel data format. Values are in the
DATA_FORMAT_R64G64B64A64_SFLOAT:null = 120
64-bit-per-channel signed floating-point red/green/blue/alpha channel data format with the value stored as-is.
DATA_FORMAT_B10G11R11_UFLOAT_PACK32:null = 121
Unsigned floating-point blue/green/red data format with the value stored as-is, packed in 32 bits. The format's precision is 10 bits of blue channel, 11 bits of green channel and 11 bits of red channel.
DATA_FORMAT_E5B9G9R9_UFLOAT_PACK32:null = 122
Unsigned floating-point exposure/blue/green/red data format with the value stored as-is, packed in 32 bits. The format's precision is 5 bits of exposure, 9 bits of blue channel, 9 bits of green channel and 9 bits of red channel.
DATA_FORMAT_D16_UNORM:null = 123
16-bit unsigned floating-point depth data format with normalized value. Values are in the
DATA_FORMAT_X8_D24_UNORM_PACK32:null = 124
24-bit unsigned floating-point depth data format with normalized value, plus 8 unused bits, packed in 32 bits. Values for depth are in the
DATA_FORMAT_D32_SFLOAT:null = 125
32-bit signed floating-point depth data format with the value stored as-is.
DATA_FORMAT_S8_UINT:null = 126
8-bit unsigned integer stencil data format.
DATA_FORMAT_D16_UNORM_S8_UINT:null = 127
16-bit unsigned floating-point depth data format with normalized value, plus 8 bits of stencil in unsigned integer format. Values for depth are in the
DATA_FORMAT_D24_UNORM_S8_UINT:null = 128
24-bit unsigned floating-point depth data format with normalized value, plus 8 bits of stencil in unsigned integer format. Values for depth are in the
DATA_FORMAT_D32_SFLOAT_S8_UINT:null = 129
32-bit signed floating-point depth data format with the value stored as-is, plus 8 bits of stencil in unsigned integer format. Values for stencil are in the
DATA_FORMAT_BC1_RGB_UNORM_BLOCK:null = 130
VRAM-compressed unsigned red/green/blue channel data format with normalized value. Values are in the
DATA_FORMAT_BC1_RGB_SRGB_BLOCK:null = 131
VRAM-compressed unsigned red/green/blue channel data format with normalized value and nonlinear sRGB encoding. Values are in the
DATA_FORMAT_BC1_RGBA_UNORM_BLOCK:null = 132
VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value. Values are in the
DATA_FORMAT_BC1_RGBA_SRGB_BLOCK:null = 133
VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value and nonlinear sRGB encoding. Values are in the
DATA_FORMAT_BC2_UNORM_BLOCK:null = 134
VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value. Values are in the
DATA_FORMAT_BC2_SRGB_BLOCK:null = 135
VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value and nonlinear sRGB encoding. Values are in the
DATA_FORMAT_BC3_UNORM_BLOCK:null = 136
VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value. Values are in the
DATA_FORMAT_BC3_SRGB_BLOCK:null = 137
VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value and nonlinear sRGB encoding. Values are in the
DATA_FORMAT_BC4_UNORM_BLOCK:null = 138
VRAM-compressed unsigned red channel data format with normalized value. Values are in the
DATA_FORMAT_BC4_SNORM_BLOCK:null = 139
VRAM-compressed signed red channel data format with normalized value. Values are in the
DATA_FORMAT_BC5_UNORM_BLOCK:null = 140
VRAM-compressed unsigned red/green channel data format with normalized value. Values are in the
DATA_FORMAT_BC5_SNORM_BLOCK:null = 141
VRAM-compressed signed red/green channel data format with normalized value. Values are in the
DATA_FORMAT_BC6H_UFLOAT_BLOCK:null = 142
VRAM-compressed unsigned red/green/blue channel data format with the floating-point value stored as-is. The format's precision is between 10 and 13 bits for the red/green/blue channels. Using BC6H texture compression (also known as BPTC HDR).
DATA_FORMAT_BC6H_SFLOAT_BLOCK:null = 143
VRAM-compressed signed red/green/blue channel data format with the floating-point value stored as-is. The format's precision is between 10 and 13 bits for the red/green/blue channels. Using BC6H texture compression (also known as BPTC HDR).
DATA_FORMAT_BC7_UNORM_BLOCK:null = 144
VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value. Values are in the
DATA_FORMAT_BC7_SRGB_BLOCK:null = 145
VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value and nonlinear sRGB encoding. Values are in the
DATA_FORMAT_ETC2_R8G8B8_UNORM_BLOCK:null = 146
VRAM-compressed unsigned red/green/blue channel data format with normalized value. Values are in the
DATA_FORMAT_ETC2_R8G8B8_SRGB_BLOCK:null = 147
VRAM-compressed unsigned red/green/blue channel data format with normalized value and nonlinear sRGB encoding. Values are in the
DATA_FORMAT_ETC2_R8G8B8A1_UNORM_BLOCK:null = 148
VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value. Values are in the
DATA_FORMAT_ETC2_R8G8B8A1_SRGB_BLOCK:null = 149
VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value and nonlinear sRGB encoding. Values are in the
DATA_FORMAT_ETC2_R8G8B8A8_UNORM_BLOCK:null = 150
VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value. Values are in the
DATA_FORMAT_ETC2_R8G8B8A8_SRGB_BLOCK:null = 151
VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value and nonlinear sRGB encoding. Values are in the
DATA_FORMAT_EAC_R11_UNORM_BLOCK:null = 152
11-bit VRAM-compressed unsigned red channel data format with normalized value. Values are in the
DATA_FORMAT_EAC_R11_SNORM_BLOCK:null = 153
11-bit VRAM-compressed signed red channel data format with normalized value. Values are in the
DATA_FORMAT_EAC_R11G11_UNORM_BLOCK:null = 154
11-bit VRAM-compressed unsigned red/green channel data format with normalized value. Values are in the
DATA_FORMAT_EAC_R11G11_SNORM_BLOCK:null = 155
11-bit VRAM-compressed signed red/green channel data format with normalized value. Values are in the
DATA_FORMAT_ASTC_4x4_UNORM_BLOCK:null = 156
VRAM-compressed unsigned floating-point data format with normalized value, packed in 4×4 blocks (highest quality). Values are in the
DATA_FORMAT_ASTC_4x4_SRGB_BLOCK:null = 157
VRAM-compressed unsigned floating-point data format with normalized value and nonlinear sRGB encoding, packed in 4×4 blocks (highest quality). Values are in the
DATA_FORMAT_ASTC_5x4_UNORM_BLOCK:null = 158
VRAM-compressed unsigned floating-point data format with normalized value, packed in 5×4 blocks. Values are in the
DATA_FORMAT_ASTC_5x4_SRGB_BLOCK:null = 159
VRAM-compressed unsigned floating-point data format with normalized value and nonlinear sRGB encoding, packed in 5×4 blocks. Values are in the
DATA_FORMAT_ASTC_5x5_UNORM_BLOCK:null = 160
VRAM-compressed unsigned floating-point data format with normalized value, packed in 5×5 blocks. Values are in the
DATA_FORMAT_ASTC_5x5_SRGB_BLOCK:null = 161
VRAM-compressed unsigned floating-point data format with normalized value and nonlinear sRGB encoding, packed in 5×5 blocks. Values are in the
DATA_FORMAT_ASTC_6x5_UNORM_BLOCK:null = 162
VRAM-compressed unsigned floating-point data format with normalized value, packed in 6×5 blocks. Values are in the
DATA_FORMAT_ASTC_6x5_SRGB_BLOCK:null = 163
VRAM-compressed unsigned floating-point data format with normalized value and nonlinear sRGB encoding, packed in 6×5 blocks. Values are in the
DATA_FORMAT_ASTC_6x6_UNORM_BLOCK:null = 164
VRAM-compressed unsigned floating-point data format with normalized value, packed in 6×6 blocks. Values are in the
DATA_FORMAT_ASTC_6x6_SRGB_BLOCK:null = 165
VRAM-compressed unsigned floating-point data format with normalized value and nonlinear sRGB encoding, packed in 6×6 blocks. Values are in the
DATA_FORMAT_ASTC_8x5_UNORM_BLOCK:null = 166
VRAM-compressed unsigned floating-point data format with normalized value, packed in 8×5 blocks. Values are in the
DATA_FORMAT_ASTC_8x5_SRGB_BLOCK:null = 167
VRAM-compressed unsigned floating-point data format with normalized value and nonlinear sRGB encoding, packed in 8×5 blocks. Values are in the
DATA_FORMAT_ASTC_8x6_UNORM_BLOCK:null = 168
VRAM-compressed unsigned floating-point data format with normalized value, packed in 8×6 blocks. Values are in the
DATA_FORMAT_ASTC_8x6_SRGB_BLOCK:null = 169
VRAM-compressed unsigned floating-point data format with normalized value and nonlinear sRGB encoding, packed in 8×6 blocks. Values are in the
DATA_FORMAT_ASTC_8x8_UNORM_BLOCK:null = 170
VRAM-compressed unsigned floating-point data format with normalized value, packed in 8×8 blocks. Values are in the
DATA_FORMAT_ASTC_8x8_SRGB_BLOCK:null = 171
VRAM-compressed unsigned floating-point data format with normalized value and nonlinear sRGB encoding, packed in 8×8 blocks. Values are in the
DATA_FORMAT_ASTC_10x5_UNORM_BLOCK:null = 172
VRAM-compressed unsigned floating-point data format with normalized value, packed in 10×5 blocks. Values are in the
DATA_FORMAT_ASTC_10x5_SRGB_BLOCK:null = 173
VRAM-compressed unsigned floating-point data format with normalized value and nonlinear sRGB encoding, packed in 10×5 blocks. Values are in the
DATA_FORMAT_ASTC_10x6_UNORM_BLOCK:null = 174
VRAM-compressed unsigned floating-point data format with normalized value, packed in 10×6 blocks. Values are in the
DATA_FORMAT_ASTC_10x6_SRGB_BLOCK:null = 175
VRAM-compressed unsigned floating-point data format with normalized value and nonlinear sRGB encoding, packed in 10×6 blocks. Values are in the
DATA_FORMAT_ASTC_10x8_UNORM_BLOCK:null = 176
VRAM-compressed unsigned floating-point data format with normalized value, packed in 10×8 blocks. Values are in the
DATA_FORMAT_ASTC_10x8_SRGB_BLOCK:null = 177
VRAM-compressed unsigned floating-point data format with normalized value and nonlinear sRGB encoding, packed in 10×8 blocks. Values are in the
DATA_FORMAT_ASTC_10x10_UNORM_BLOCK:null = 178
VRAM-compressed unsigned floating-point data format with normalized value, packed in 10×10 blocks. Values are in the
DATA_FORMAT_ASTC_10x10_SRGB_BLOCK:null = 179
VRAM-compressed unsigned floating-point data format with normalized value and nonlinear sRGB encoding, packed in 10×10 blocks. Values are in the
DATA_FORMAT_ASTC_12x10_UNORM_BLOCK:null = 180
VRAM-compressed unsigned floating-point data format with normalized value, packed in 12×10 blocks. Values are in the
DATA_FORMAT_ASTC_12x10_SRGB_BLOCK:null = 181
VRAM-compressed unsigned floating-point data format with normalized value and nonlinear sRGB encoding, packed in 12×10 blocks. Values are in the
DATA_FORMAT_ASTC_12x12_UNORM_BLOCK:null = 182
VRAM-compressed unsigned floating-point data format with normalized value, packed in 12 blocks (lowest quality). Values are in the
DATA_FORMAT_ASTC_12x12_SRGB_BLOCK:null = 183
VRAM-compressed unsigned floating-point data format with normalized value and nonlinear sRGB encoding, packed in 12 blocks (lowest quality). Values are in the
DATA_FORMAT_G8B8G8R8_422_UNORM:null = 184
8-bit-per-channel unsigned floating-point green/blue/red channel data format with normalized value. Values are in the
DATA_FORMAT_B8G8R8G8_422_UNORM:null = 185
8-bit-per-channel unsigned floating-point blue/green/red channel data format with normalized value. Values are in the
DATA_FORMAT_G8_B8_R8_3PLANE_420_UNORM:null = 186
8-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, stored across 3 separate planes (green + blue + red). Values are in the
DATA_FORMAT_G8_B8R8_2PLANE_420_UNORM:null = 187
8-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, stored across 2 separate planes (green + blue/red). Values are in the
DATA_FORMAT_G8_B8_R8_3PLANE_422_UNORM:null = 188
8-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, stored across 2 separate planes (green + blue + red). Values are in the
DATA_FORMAT_G8_B8R8_2PLANE_422_UNORM:null = 189
8-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, stored across 2 separate planes (green + blue/red). Values are in the
DATA_FORMAT_G8_B8_R8_3PLANE_444_UNORM:null = 190
8-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, stored across 3 separate planes. Values are in the
DATA_FORMAT_R10X6_UNORM_PACK16:null = 191
10-bit-per-channel unsigned floating-point red channel data with normalized value, plus 6 unused bits, packed in 16 bits. Values are in the
DATA_FORMAT_R10X6G10X6_UNORM_2PACK16:null = 192
10-bit-per-channel unsigned floating-point red/green channel data with normalized value, plus 6 unused bits after each channel, packed in 2×16 bits. Values are in the
DATA_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16:null = 193
10-bit-per-channel unsigned floating-point red/green/blue/alpha channel data with normalized value, plus 6 unused bits after each channel, packed in 4×16 bits. Values are in the
DATA_FORMAT_G10X6B10X6G10X6R10X6_422_UNORM_4PACK16:null = 194
10-bit-per-channel unsigned floating-point green/blue/green/red channel data with normalized value, plus 6 unused bits after each channel, packed in 4×16 bits. Values are in the
DATA_FORMAT_B10X6G10X6R10X6G10X6_422_UNORM_4PACK16:null = 195
10-bit-per-channel unsigned floating-point blue/green/red/green channel data with normalized value, plus 6 unused bits after each channel, packed in 4×16 bits. Values are in the
DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_420_UNORM_3PACK16:null = 196
10-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Packed in 3×16 bits and stored across 2 separate planes (green + blue + red). Values are in the
DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16:null = 197
10-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Packed in 3×16 bits and stored across 2 separate planes (green + blue/red). Values are in the
DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_422_UNORM_3PACK16:null = 198
10-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Packed in 3×16 bits and stored across 3 separate planes (green + blue + red). Values are in the
DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_422_UNORM_3PACK16:null = 199
10-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Packed in 3×16 bits and stored across 3 separate planes (green + blue/red). Values are in the
DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_444_UNORM_3PACK16:null = 200
10-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Packed in 3×16 bits and stored across 3 separate planes (green + blue + red). Values are in the
DATA_FORMAT_R12X4_UNORM_PACK16:null = 201
12-bit-per-channel unsigned floating-point red channel data with normalized value, plus 6 unused bits, packed in 16 bits. Values are in the
DATA_FORMAT_R12X4G12X4_UNORM_2PACK16:null = 202
12-bit-per-channel unsigned floating-point red/green channel data with normalized value, plus 6 unused bits after each channel, packed in 2×16 bits. Values are in the
DATA_FORMAT_R12X4G12X4B12X4A12X4_UNORM_4PACK16:null = 203
12-bit-per-channel unsigned floating-point red/green/blue/alpha channel data with normalized value, plus 6 unused bits after each channel, packed in 4×16 bits. Values are in the
DATA_FORMAT_G12X4B12X4G12X4R12X4_422_UNORM_4PACK16:null = 204
12-bit-per-channel unsigned floating-point green/blue/green/red channel data with normalized value, plus 6 unused bits after each channel, packed in 4×16 bits. Values are in the
DATA_FORMAT_B12X4G12X4R12X4G12X4_422_UNORM_4PACK16:null = 205
12-bit-per-channel unsigned floating-point blue/green/red/green channel data with normalized value, plus 6 unused bits after each channel, packed in 4×16 bits. Values are in the
DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_420_UNORM_3PACK16:null = 206
12-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Packed in 3×16 bits and stored across 2 separate planes (green + blue + red). Values are in the
DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_420_UNORM_3PACK16:null = 207
12-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Packed in 3×16 bits and stored across 2 separate planes (green + blue/red). Values are in the
DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_422_UNORM_3PACK16:null = 208
12-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Packed in 3×16 bits and stored across 3 separate planes (green + blue + red). Values are in the
DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_422_UNORM_3PACK16:null = 209
12-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Packed in 3×16 bits and stored across 3 separate planes (green + blue/red). Values are in the
DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_444_UNORM_3PACK16:null = 210
12-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Packed in 3×16 bits and stored across 3 separate planes (green + blue + red). Values are in the
DATA_FORMAT_G16B16G16R16_422_UNORM:null = 211
16-bit-per-channel unsigned floating-point green/blue/red channel data format with normalized value. Values are in the
DATA_FORMAT_B16G16R16G16_422_UNORM:null = 212
16-bit-per-channel unsigned floating-point blue/green/red channel data format with normalized value. Values are in the
DATA_FORMAT_G16_B16_R16_3PLANE_420_UNORM:null = 213
16-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Stored across 2 separate planes (green + blue + red). Values are in the
DATA_FORMAT_G16_B16R16_2PLANE_420_UNORM:null = 214
16-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Stored across 2 separate planes (green + blue/red). Values are in the
DATA_FORMAT_G16_B16_R16_3PLANE_422_UNORM:null = 215
16-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Stored across 3 separate planes (green + blue + red). Values are in the
DATA_FORMAT_G16_B16R16_2PLANE_422_UNORM:null = 216
16-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Stored across 3 separate planes (green + blue/red). Values are in the
DATA_FORMAT_G16_B16_R16_3PLANE_444_UNORM:null = 217
16-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Stored across 3 separate planes (green + blue + red). Values are in the
DATA_FORMAT_ASTC_4x4_SFLOAT_BLOCK:null = 218
DATA_FORMAT_ASTC_5x4_SFLOAT_BLOCK:null = 219
DATA_FORMAT_ASTC_5x5_SFLOAT_BLOCK:null = 220
DATA_FORMAT_ASTC_6x5_SFLOAT_BLOCK:null = 221
DATA_FORMAT_ASTC_6x6_SFLOAT_BLOCK:null = 222
DATA_FORMAT_ASTC_8x5_SFLOAT_BLOCK:null = 223
DATA_FORMAT_ASTC_8x6_SFLOAT_BLOCK:null = 224
DATA_FORMAT_ASTC_8x8_SFLOAT_BLOCK:null = 225
DATA_FORMAT_ASTC_10x5_SFLOAT_BLOCK:null = 226
DATA_FORMAT_ASTC_10x6_SFLOAT_BLOCK:null = 227
DATA_FORMAT_ASTC_10x8_SFLOAT_BLOCK:null = 228
DATA_FORMAT_ASTC_10x10_SFLOAT_BLOCK:null = 229
DATA_FORMAT_ASTC_12x10_SFLOAT_BLOCK:null = 230
DATA_FORMAT_ASTC_12x12_SFLOAT_BLOCK:null = 231
DATA_FORMAT_MAX:null = 232
Represents the size of the DataFormat enum.
BARRIER_MASK_VERTEX:null = 1
Vertex shader barrier mask.
BARRIER_MASK_FRAGMENT:null = 8
Fragment shader barrier mask.
BARRIER_MASK_COMPUTE:null = 2
Compute barrier mask.
BARRIER_MASK_TRANSFER:null = 4
Transfer barrier mask.
BARRIER_MASK_RASTER:null = 9
Raster barrier mask (vertex and fragment). Equivalent to
BARRIER_MASK_ALL_BARRIERS:null = 32767
Barrier mask for all types (vertex, fragment, compute, transfer).
BARRIER_MASK_NO_BARRIER:null = 32768
No barrier for any type.
TEXTURE_TYPE_1D:null = 0
1-dimensional texture.
TEXTURE_TYPE_2D:null = 1
2-dimensional texture.
TEXTURE_TYPE_3D:null = 2
3-dimensional texture.
TEXTURE_TYPE_CUBE:null = 3
Cubemap texture.
TEXTURE_TYPE_1D_ARRAY:null = 4
Array of 1-dimensional textures.
TEXTURE_TYPE_2D_ARRAY:null = 5
Array of 2-dimensional textures.
TEXTURE_TYPE_CUBE_ARRAY:null = 6
Array of Cubemap textures.
TEXTURE_TYPE_MAX:null = 7
Represents the size of the TextureType enum.
TEXTURE_SAMPLES_1:null = 0
Perform 1 texture sample (this is the fastest but lowest-quality for antialiasing).
TEXTURE_SAMPLES_2:null = 1
Perform 2 texture samples.
TEXTURE_SAMPLES_4:null = 2
Perform 4 texture samples.
TEXTURE_SAMPLES_8:null = 3
Perform 8 texture samples. Not supported on mobile GPUs (including Apple Silicon).
TEXTURE_SAMPLES_16:null = 4
Perform 16 texture samples. Not supported on mobile GPUs and many desktop GPUs.
TEXTURE_SAMPLES_32:null = 5
Perform 32 texture samples. Not supported on most GPUs.
TEXTURE_SAMPLES_64:null = 6
Perform 64 texture samples (this is the slowest but highest-quality for antialiasing). Not supported on most GPUs.
TEXTURE_SAMPLES_MAX:null = 7
Represents the size of the TextureSamples enum.
TEXTURE_USAGE_SAMPLING_BIT:null = 1
Texture can be sampled.
TEXTURE_USAGE_COLOR_ATTACHMENT_BIT:null = 2
Texture can be used as a color attachment in a framebuffer.
TEXTURE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT:null = 4
Texture can be used as a depth/stencil attachment in a framebuffer.
TEXTURE_USAGE_DEPTH_RESOLVE_ATTACHMENT_BIT:null = 4096
Texture can be used as a depth/stencil resolve attachment in a framebuffer.
TEXTURE_USAGE_STORAGE_BIT:null = 8
Texture can be used as a [url=https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#descriptorsets-storageimage]storage image[/url].
TEXTURE_USAGE_STORAGE_ATOMIC_BIT:null = 16
Texture can be used as a [url=https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#descriptorsets-storageimage]storage image[/url] with support for atomic operations.
TEXTURE_USAGE_CPU_READ_BIT:null = 32
Texture can be read back on the CPU using texture_get_data faster than without this bit, since it is always kept in the system memory.
TEXTURE_USAGE_CAN_UPDATE_BIT:null = 64
Texture can be updated using texture_update.
TEXTURE_USAGE_CAN_COPY_FROM_BIT:null = 128
Texture can be a source for texture_copy.
TEXTURE_USAGE_CAN_COPY_TO_BIT:null = 256
Texture can be a destination for texture_copy.
TEXTURE_USAGE_INPUT_ATTACHMENT_BIT:null = 512
Texture can be used as a [url=https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#descriptorsets-inputattachment]input attachment[/url] in a framebuffer.
TEXTURE_SWIZZLE_IDENTITY:null = 0
Return the sampled value as-is.
TEXTURE_SWIZZLE_ZERO:null = 1
Always return
TEXTURE_SWIZZLE_ONE:null = 2
Always return
TEXTURE_SWIZZLE_R:null = 3
Sample the red color channel.
TEXTURE_SWIZZLE_G:null = 4
Sample the green color channel.
TEXTURE_SWIZZLE_B:null = 5
Sample the blue color channel.
TEXTURE_SWIZZLE_A:null = 6
Sample the alpha channel.
TEXTURE_SWIZZLE_MAX:null = 7
Represents the size of the TextureSwizzle enum.
TEXTURE_SLICE_2D:null = 0
2-dimensional texture slice.
TEXTURE_SLICE_CUBEMAP:null = 1
Cubemap texture slice.
TEXTURE_SLICE_3D:null = 2
3-dimensional texture slice.
SAMPLER_FILTER_NEAREST:null = 0
Nearest-neighbor sampler filtering. Sampling at higher resolutions than the source will result in a pixelated look.
SAMPLER_FILTER_LINEAR:null = 1
Bilinear sampler filtering. Sampling at higher resolutions than the source will result in a blurry look.
SAMPLER_REPEAT_MODE_REPEAT:null = 0
Sample with repeating enabled.
SAMPLER_REPEAT_MODE_MIRRORED_REPEAT:null = 1
Sample with mirrored repeating enabled. When sampling outside the
SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE:null = 2
Sample with repeating disabled. When sampling outside the
SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER:null = 3
Sample with repeating disabled. When sampling outside the
SAMPLER_REPEAT_MODE_MIRROR_CLAMP_TO_EDGE:null = 4
Sample with mirrored repeating enabled, but only once. When sampling in the
SAMPLER_REPEAT_MODE_MAX:null = 5
Represents the size of the SamplerRepeatMode enum.
SAMPLER_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK:null = 0
Return a floating-point transparent black color when sampling outside the
SAMPLER_BORDER_COLOR_INT_TRANSPARENT_BLACK:null = 1
Return an integer transparent black color when sampling outside the
SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_BLACK:null = 2
Return a floating-point opaque black color when sampling outside the
SAMPLER_BORDER_COLOR_INT_OPAQUE_BLACK:null = 3
Return an integer opaque black color when sampling outside the
SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_WHITE:null = 4
Return a floating-point opaque white color when sampling outside the
SAMPLER_BORDER_COLOR_INT_OPAQUE_WHITE:null = 5
Return an integer opaque white color when sampling outside the
SAMPLER_BORDER_COLOR_MAX:null = 6
Represents the size of the SamplerBorderColor enum.
VERTEX_FREQUENCY_VERTEX:null = 0
Vertex attribute addressing is a function of the vertex. This is used to specify the rate at which vertex attributes are pulled from buffers.
VERTEX_FREQUENCY_INSTANCE:null = 1
Vertex attribute addressing is a function of the instance index. This is used to specify the rate at which vertex attributes are pulled from buffers.
INDEX_BUFFER_FORMAT_UINT16:null = 0
Index buffer in 16-bit unsigned integer format. This limits the maximum index that can be specified to
INDEX_BUFFER_FORMAT_UINT32:null = 1
Index buffer in 32-bit unsigned integer format. This limits the maximum index that can be specified to
STORAGE_BUFFER_USAGE_DISPATCH_INDIRECT:null = 1
BUFFER_CREATION_DEVICE_ADDRESS_BIT:null = 1
Optionally, set this flag if you wish to use buffer_get_device_address functionality. You must first check the GPU supports it:
BUFFER_CREATION_AS_STORAGE_BIT:null = 2
Set this flag so that it is created as storage. This is useful if Compute Shaders need access (for reading or writing) to the buffer, e.g. skeletal animations are processed in Compute Shaders which need access to vertex buffers, to be later consumed by vertex shaders as part of the regular rasterization pipeline.
BUFFER_CREATION_ACCELERATION_STRUCTURE_BUILD_INPUT_READ_ONLY_BIT:null = 8
Allows usage of this buffer as input data for an acceleration structure build operation. You must first check that the GPU supports it:
ACCELERATION_STRUCTURE_ALLOW_UPDATE_BIT:null = 1
Allows the acceleration structure to be updated after it has been built.
ACCELERATION_STRUCTURE_ALLOW_COMPACTION_BIT:null = 2
Allows the acceleration structure to be compacted to reduce memory usage after it has been built.
ACCELERATION_STRUCTURE_PREFER_FAST_TRACE_BIT:null = 4
Prioritizes ray traversal performance over build performance when building the acceleration structure.
ACCELERATION_STRUCTURE_PREFER_FAST_BUILD_BIT:null = 8
Prioritizes build performance over ray traversal performance when building the acceleration structure.
ACCELERATION_STRUCTURE_LOW_MEMORY_BIT:null = 16
Reduces the memory usage of the acceleration structure, potentially at the cost of reduced ray traversal performance.
ACCELERATION_STRUCTURE_GEOMETRY_OPAQUE_BIT:null = 1
An opaque geometry does not invoke the any hit shaders.
ACCELERATION_STRUCTURE_GEOMETRY_NO_DUPLICATE_ANY_HIT_INVOCATION_BIT:null = 2
This geometry only calls the any hit shader a single time for each primitive.
ACCELERATION_STRUCTURE_INSTANCE_TRIANGLE_FACING_CULL_DISABLE_BIT:null = 1
Disables triangle face culling for this instance during ray traversal.
ACCELERATION_STRUCTURE_INSTANCE_TRIANGLE_FLIP_FACING_BIT:null = 2
Flips the triangle facing direction for this instance during ray traversal.
ACCELERATION_STRUCTURE_INSTANCE_FORCE_OPAQUE_BIT:null = 4
Forces all geometries in this instance to be treated as opaque, preventing any hit shaders from being invoked.
ACCELERATION_STRUCTURE_INSTANCE_FORCE_NO_OPAQUE_BIT:null = 8
Forces all geometries in this instance to be treated as non-opaque, allowing any hit shaders to be invoked.
UNIFORM_TYPE_SAMPLER:null = 0
Sampler uniform.
UNIFORM_TYPE_SAMPLER_WITH_TEXTURE:null = 1
Sampler uniform with a texture.
UNIFORM_TYPE_TEXTURE:null = 2
Texture uniform.
UNIFORM_TYPE_IMAGE:null = 3
Image uniform.
UNIFORM_TYPE_TEXTURE_BUFFER:null = 4
Texture buffer uniform.
UNIFORM_TYPE_SAMPLER_WITH_TEXTURE_BUFFER:null = 5
Sampler uniform with a texture buffer.
UNIFORM_TYPE_IMAGE_BUFFER:null = 6
Image buffer uniform.
UNIFORM_TYPE_UNIFORM_BUFFER:null = 7
Uniform buffer uniform.
UNIFORM_TYPE_STORAGE_BUFFER:null = 8
[url=https://vkguide.dev/docs/chapter-4/storage_buffers/]Storage buffer[/url] uniform.
UNIFORM_TYPE_INPUT_ATTACHMENT:null = 9
Input attachment uniform.
UNIFORM_TYPE_UNIFORM_BUFFER_DYNAMIC:null = 10
Same as UNIFORM_TYPE_UNIFORM_BUFFER but for buffers created with BUFFER_CREATION_DYNAMIC_PERSISTENT_BIT.
Note: This flag is not available to GD users due to being too dangerous (i.e. wrong usage can result in visual glitches).
It's exposed in case GD users receive a buffer created with such flag from Godot.
UNIFORM_TYPE_STORAGE_BUFFER_DYNAMIC:null = 11
Same as UNIFORM_TYPE_STORAGE_BUFFER but for buffers created with BUFFER_CREATION_DYNAMIC_PERSISTENT_BIT.
Note: This flag is not available to GD users due to being too dangerous (i.e. wrong usage can result in visual glitches).
It's exposed in case GD users receive a buffer created with such flag from Godot.
UNIFORM_TYPE_ACCELERATION_STRUCTURE:null = 12
Acceleration structure uniform.
UNIFORM_TYPE_MAX:null = 13
Represents the size of the UniformType enum.
RENDER_PRIMITIVE_POINTS:null = 0
Point rendering primitive (with constant size, regardless of distance from camera).
RENDER_PRIMITIVE_LINES:null = 1
Line list rendering primitive. Lines are drawn separated from each other.
RENDER_PRIMITIVE_LINES_WITH_ADJACENCY:null = 2
[url=https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#drawing-line-lists-with-adjacency]Line list rendering primitive with adjacency.[/url]
Note: Adjacency is only useful with geometry shaders, which Godot does not expose.
RENDER_PRIMITIVE_LINESTRIPS:null = 3
Line strip rendering primitive. Lines drawn are connected to the previous vertex.
RENDER_PRIMITIVE_LINESTRIPS_WITH_ADJACENCY:null = 4
[url=https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#drawing-line-strips-with-adjacency]Line strip rendering primitive with adjacency.[/url]
Note: Adjacency is only useful with geometry shaders, which Godot does not expose.
RENDER_PRIMITIVE_TRIANGLES:null = 5
Triangle list rendering primitive. Triangles are drawn separated from each other.
RENDER_PRIMITIVE_TRIANGLES_WITH_ADJACENCY:null = 6
[url=https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#drawing-triangle-lists-with-adjacency]Triangle list rendering primitive with adjacency.[/url]
Note: Adjacency is only useful with geometry shaders, which Godot does not expose.
RENDER_PRIMITIVE_TRIANGLE_STRIPS:null = 7
Triangle strip rendering primitive. Triangles drawn are connected to the previous triangle.
RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_AJACENCY:null = 8
[url=https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#drawing-triangle-strips-with-adjacency]Triangle strip rendering primitive with adjacency.[/url]
Note: Adjacency is only useful with geometry shaders, which Godot does not expose.
RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_RESTART_INDEX:null = 9
Triangle strip rendering primitive with primitive restart enabled. Triangles drawn are connected to the previous triangle, but a primitive restart index can be specified before drawing to create a second triangle strip after the specified index.
Note: Only compatible with indexed draws.
RENDER_PRIMITIVE_TESSELATION_PATCH:null = 10
Tessellation patch rendering primitive. Only useful with tessellation shaders, which can be used to deform these patches.
RENDER_PRIMITIVE_MAX:null = 11
Represents the size of the RenderPrimitive enum.
POLYGON_CULL_DISABLED:null = 0
Do not use polygon front face or backface culling.
POLYGON_CULL_FRONT:null = 1
Use polygon frontface culling (faces pointing towards the camera are hidden).
POLYGON_CULL_BACK:null = 2
Use polygon backface culling (faces pointing away from the camera are hidden).
POLYGON_FRONT_FACE_CLOCKWISE:null = 0
Clockwise winding order to determine which face of a polygon is its front face.
POLYGON_FRONT_FACE_COUNTER_CLOCKWISE:null = 1
Counter-clockwise winding order to determine which face of a polygon is its front face.
STENCIL_OP_KEEP:null = 0
Keep the current stencil value.
STENCIL_OP_ZERO:null = 1
Set the stencil value to
STENCIL_OP_REPLACE:null = 2
Replace the existing stencil value with the new one.
STENCIL_OP_INCREMENT_AND_CLAMP:null = 3
Increment the existing stencil value and clamp to the maximum representable unsigned value if reached. Stencil bits are considered as an unsigned integer.
STENCIL_OP_DECREMENT_AND_CLAMP:null = 4
Decrement the existing stencil value and clamp to the minimum value if reached. Stencil bits are considered as an unsigned integer.
STENCIL_OP_INVERT:null = 5
Bitwise-invert the existing stencil value.
STENCIL_OP_INCREMENT_AND_WRAP:null = 6
Increment the stencil value and wrap around to
STENCIL_OP_DECREMENT_AND_WRAP:null = 7
Decrement the stencil value and wrap around to the maximum representable unsigned if reaching the minimum. Stencil bits are considered as an unsigned integer.
STENCIL_OP_MAX:null = 8
Represents the size of the StencilOperation enum.
COMPARE_OP_NEVER:null = 0
"Never" comparison (opposite of COMPARE_OP_ALWAYS).
COMPARE_OP_LESS:null = 1
"Less than" comparison.
COMPARE_OP_EQUAL:null = 2
"Equal" comparison.
COMPARE_OP_LESS_OR_EQUAL:null = 3
"Less than or equal" comparison.
COMPARE_OP_GREATER:null = 4
"Greater than" comparison.
COMPARE_OP_NOT_EQUAL:null = 5
"Not equal" comparison.
COMPARE_OP_GREATER_OR_EQUAL:null = 6
"Greater than or equal" comparison.
COMPARE_OP_ALWAYS:null = 7
"Always" comparison (opposite of COMPARE_OP_NEVER).
COMPARE_OP_MAX:null = 8
Represents the size of the CompareOperator enum.
LOGIC_OP_CLEAR:null = 0
Clear logic operation (result is always
LOGIC_OP_AND:null = 1
AND logic operation.
LOGIC_OP_AND_REVERSE:null = 2
AND logic operation with the destination operand being inverted. See also LOGIC_OP_AND_INVERTED.
LOGIC_OP_COPY:null = 3
Copy logic operation (keeps the source value as-is). See also LOGIC_OP_COPY_INVERTED and LOGIC_OP_NO_OP.
LOGIC_OP_AND_INVERTED:null = 4
AND logic operation with the source operand being inverted. See also LOGIC_OP_AND_REVERSE.
LOGIC_OP_NO_OP:null = 5
No-op logic operation (keeps the destination value as-is). See also LOGIC_OP_COPY.
LOGIC_OP_XOR:null = 6
Exclusive or (XOR) logic operation.
LOGIC_OP_OR:null = 7
OR logic operation.
LOGIC_OP_NOR:null = 8
Not-OR (NOR) logic operation.
LOGIC_OP_EQUIVALENT:null = 9
Not-XOR (XNOR) logic operation.
LOGIC_OP_INVERT:null = 10
Invert logic operation.
LOGIC_OP_OR_REVERSE:null = 11
OR logic operation with the destination operand being inverted. See also LOGIC_OP_OR_REVERSE.
LOGIC_OP_COPY_INVERTED:null = 12
NOT logic operation (inverts the value). See also LOGIC_OP_COPY.
LOGIC_OP_OR_INVERTED:null = 13
OR logic operation with the source operand being inverted. See also LOGIC_OP_OR_REVERSE.
LOGIC_OP_NAND:null = 14
Not-AND (NAND) logic operation.
LOGIC_OP_SET:null = 15
SET logic operation (result is always
LOGIC_OP_MAX:null = 16
Represents the size of the LogicOperation enum.
BLEND_FACTOR_ZERO:null = 0
Constant
BLEND_FACTOR_ONE:null = 1
Constant
BLEND_FACTOR_SRC_COLOR:null = 2
Color blend factor is
BLEND_FACTOR_ONE_MINUS_SRC_COLOR:null = 3
Color blend factor is
BLEND_FACTOR_DST_COLOR:null = 4
Color blend factor is
BLEND_FACTOR_ONE_MINUS_DST_COLOR:null = 5
Color blend factor is
BLEND_FACTOR_SRC_ALPHA:null = 6
Color and alpha blend factor is
BLEND_FACTOR_ONE_MINUS_SRC_ALPHA:null = 7
Color and alpha blend factor is
BLEND_FACTOR_DST_ALPHA:null = 8
Color and alpha blend factor is
BLEND_FACTOR_ONE_MINUS_DST_ALPHA:null = 9
Color and alpha blend factor is
BLEND_FACTOR_CONSTANT_COLOR:null = 10
Color blend factor is
BLEND_FACTOR_ONE_MINUS_CONSTANT_COLOR:null = 11
Color blend factor is
BLEND_FACTOR_CONSTANT_ALPHA:null = 12
Color and alpha blend factor is
BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA:null = 13
Color and alpha blend factor is
BLEND_FACTOR_SRC_ALPHA_SATURATE:null = 14
Color blend factor is
BLEND_FACTOR_SRC1_COLOR:null = 15
Color blend factor is
BLEND_FACTOR_ONE_MINUS_SRC1_COLOR:null = 16
Color blend factor is
BLEND_FACTOR_SRC1_ALPHA:null = 17
Color and alpha blend factor is
BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA:null = 18
Color and alpha blend factor is
BLEND_FACTOR_MAX:null = 19
Represents the size of the BlendFactor enum.
BLEND_OP_ADD:null = 0
Additive blending operation (
BLEND_OP_SUBTRACT:null = 1
Subtractive blending operation (
BLEND_OP_REVERSE_SUBTRACT:null = 2
Reverse subtractive blending operation (
BLEND_OP_MINIMUM:null = 3
Minimum blending operation (keep the lowest value of the two).
BLEND_OP_MAXIMUM:null = 4
Maximum blending operation (keep the highest value of the two).
BLEND_OP_MAX:null = 5
Represents the size of the BlendOperation enum.
DYNAMIC_STATE_LINE_WIDTH:null = 1
Allows dynamically changing the width of rendering lines.
DYNAMIC_STATE_DEPTH_BIAS:null = 2
Allows dynamically changing the depth bias.
DYNAMIC_STATE_BLEND_CONSTANTS:null = 4
DYNAMIC_STATE_DEPTH_BOUNDS:null = 8
DYNAMIC_STATE_STENCIL_COMPARE_MASK:null = 16
DYNAMIC_STATE_STENCIL_WRITE_MASK:null = 32
DYNAMIC_STATE_STENCIL_REFERENCE:null = 64
INITIAL_ACTION_LOAD:null = 0
Load the previous contents of the framebuffer.
INITIAL_ACTION_CLEAR:null = 1
Clear the whole framebuffer or its specified region.
INITIAL_ACTION_DISCARD:null = 2
Ignore the previous contents of the framebuffer. This is the fastest option if you'll overwrite all of the pixels and don't need to read any of them.
INITIAL_ACTION_MAX:null = 3
Represents the size of the InitialAction enum.
INITIAL_ACTION_CLEAR_REGION:null = 1
INITIAL_ACTION_CLEAR_REGION_CONTINUE:null = 1
INITIAL_ACTION_KEEP:null = 0
INITIAL_ACTION_DROP:null = 2
INITIAL_ACTION_CONTINUE:null = 0
FINAL_ACTION_STORE:null = 0
Store the result of the draw list in the framebuffer. This is generally what you want to do.
FINAL_ACTION_DISCARD:null = 1
Discard the contents of the framebuffer. This is the fastest option if you don't need to use the results of the draw list.
FINAL_ACTION_MAX:null = 2
Represents the size of the FinalAction enum.
FINAL_ACTION_READ:null = 0
FINAL_ACTION_CONTINUE:null = 0
SHADER_STAGE_VERTEX:null = 0
Vertex shader stage. This can be used to manipulate vertices from a shader (but not create new vertices).
SHADER_STAGE_FRAGMENT:null = 1
Fragment shader stage (called "pixel shader" in Direct3D). This can be used to manipulate pixels from a shader.
SHADER_STAGE_TESSELATION_CONTROL:null = 2
Tessellation control shader stage. This can be used to create additional geometry from a shader.
SHADER_STAGE_TESSELATION_EVALUATION:null = 3
Tessellation evaluation shader stage. This can be used to create additional geometry from a shader.
SHADER_STAGE_COMPUTE:null = 4
Compute shader stage. This can be used to run arbitrary computing tasks in a shader, performing them on the GPU instead of the CPU.
SHADER_STAGE_RAYGEN:null = 5
Ray generation shader stage. This can be used to generate primary rays.
SHADER_STAGE_ANY_HIT:null = 6
Any hit shader stage. Invoked when ray intersections are not opaque. This can be used to specify what happens when a ray hits any of the geometry in the scene.
SHADER_STAGE_CLOSEST_HIT:null = 7
Closest hit shader stage. This can be used to specify what happens when a ray hits the closest geometry in the scene.
SHADER_STAGE_MISS:null = 8
Miss shader stage. This can be used to specify what happens if a ray does not hit anything in the scene.
SHADER_STAGE_INTERSECTION:null = 9
Intersection shader stage. The intersection shader for triangles is built-in. This can be used to compute ray intersections with primitives that are not triangles.
SHADER_STAGE_MAX:null = 10
Represents the size of the ShaderStage enum.
SHADER_STAGE_VERTEX_BIT:null = 1
Vertex shader stage bit (see also SHADER_STAGE_VERTEX).
SHADER_STAGE_FRAGMENT_BIT:null = 2
Fragment shader stage bit (see also SHADER_STAGE_FRAGMENT).
SHADER_STAGE_TESSELATION_CONTROL_BIT:null = 4
Tessellation control shader stage bit (see also SHADER_STAGE_TESSELATION_CONTROL).
SHADER_STAGE_TESSELATION_EVALUATION_BIT:null = 8
Tessellation evaluation shader stage bit (see also SHADER_STAGE_TESSELATION_EVALUATION).
SHADER_STAGE_COMPUTE_BIT:null = 16
Compute shader stage bit (see also SHADER_STAGE_COMPUTE).
SHADER_STAGE_RAYGEN_BIT:null = 32
Ray generation shader stage bit (see also SHADER_STAGE_RAYGEN).
SHADER_STAGE_ANY_HIT_BIT:null = 64
Any hit shader stage bit (see also SHADER_STAGE_ANY_HIT).
SHADER_STAGE_CLOSEST_HIT_BIT:null = 128
Closest hit shader stage bit (see also SHADER_STAGE_CLOSEST_HIT).
SHADER_STAGE_MISS_BIT:null = 256
Miss shader stage bit (see also SHADER_STAGE_MISS).
SHADER_STAGE_INTERSECTION_BIT:null = 512
Intersection shader stage bit (see also SHADER_STAGE_INTERSECTION).
SHADER_LANGUAGE_GLSL:null = 0
Khronos' GLSL shading language (used natively by OpenGL and Vulkan). This is the language used for core Godot shaders.
SHADER_LANGUAGE_HLSL:null = 1
Microsoft's High-Level Shading Language (used natively by Direct3D, but can also be used in Vulkan).
PIPELINE_SPECIALIZATION_CONSTANT_TYPE_BOOL:null = 0
Boolean specialization constant.
PIPELINE_SPECIALIZATION_CONSTANT_TYPE_INT:null = 1
Integer specialization constant.
PIPELINE_SPECIALIZATION_CONSTANT_TYPE_FLOAT:null = 2
Floating-point specialization constant.
SUPPORTS_METALFX_SPATIAL:null = 3
Support for MetalFX spatial upscaling.
SUPPORTS_METALFX_TEMPORAL:null = 4
Support for MetalFX temporal upscaling.
SUPPORTS_BUFFER_DEVICE_ADDRESS:null = 6
Features support for buffer device address extension.
SUPPORTS_IMAGE_ATOMIC_32_BIT:null = 7
Support for 32-bit image atomic operations.
SUPPORTS_RAY_QUERY:null = 11
Support for ray query extension.
Note: This is currently only supported when using Vulkan. This is not supported on macOS and iOS (even on hardware supporting raytracing) due to MoltenVK limitations.
SUPPORTS_RAYTRACING_PIPELINE:null = 12
Support for raytracing pipeline extension.
Note: This is currently only supported when using Vulkan. This is not supported on macOS and iOS (even on hardware supporting raytracing) due to MoltenVK limitations.
SUPPORTS_HDR_OUTPUT:null = 13
Support for high dynamic range (HDR) output.
LIMIT_MAX_BOUND_UNIFORM_SETS:null = 0
Maximum number of uniform sets that can be bound at a given time.
LIMIT_MAX_FRAMEBUFFER_COLOR_ATTACHMENTS:null = 1
Maximum number of color framebuffer attachments that can be used at a given time.
LIMIT_MAX_TEXTURES_PER_UNIFORM_SET:null = 2
Maximum number of textures that can be used per uniform set.
LIMIT_MAX_SAMPLERS_PER_UNIFORM_SET:null = 3
Maximum number of samplers that can be used per uniform set.
LIMIT_MAX_STORAGE_BUFFERS_PER_UNIFORM_SET:null = 4
Maximum number of [url=https://vkguide.dev/docs/chapter-4/storage_buffers/]storage buffers[/url] per uniform set.
LIMIT_MAX_STORAGE_IMAGES_PER_UNIFORM_SET:null = 5
Maximum number of storage images per uniform set.
LIMIT_MAX_UNIFORM_BUFFERS_PER_UNIFORM_SET:null = 6
Maximum number of uniform buffers per uniform set.
LIMIT_MAX_DRAW_INDEXED_INDEX:null = 7
Maximum index for an indexed draw command.
LIMIT_MAX_FRAMEBUFFER_HEIGHT:null = 8
Maximum height of a framebuffer (in pixels).
LIMIT_MAX_FRAMEBUFFER_WIDTH:null = 9
Maximum width of a framebuffer (in pixels).
LIMIT_MAX_TEXTURE_ARRAY_LAYERS:null = 10
Maximum number of texture array layers.
LIMIT_MAX_TEXTURE_SIZE_1D:null = 11
Maximum supported 1-dimensional texture size (in pixels on a single axis).
LIMIT_MAX_TEXTURE_SIZE_2D:null = 12
Maximum supported 2-dimensional texture size (in pixels on a single axis).
LIMIT_MAX_TEXTURE_SIZE_3D:null = 13
Maximum supported 3-dimensional texture size (in pixels on a single axis).
LIMIT_MAX_TEXTURE_SIZE_CUBE:null = 14
Maximum supported cubemap texture size (in pixels on a single axis of a single face).
LIMIT_MAX_TEXTURES_PER_SHADER_STAGE:null = 15
Maximum number of textures per shader stage.
LIMIT_MAX_SAMPLERS_PER_SHADER_STAGE:null = 16
Maximum number of samplers per shader stage.
LIMIT_MAX_STORAGE_BUFFERS_PER_SHADER_STAGE:null = 17
Maximum number of [url=https://vkguide.dev/docs/chapter-4/storage_buffers/]storage buffers[/url] per shader stage.
LIMIT_MAX_STORAGE_IMAGES_PER_SHADER_STAGE:null = 18
Maximum number of storage images per shader stage.
LIMIT_MAX_UNIFORM_BUFFERS_PER_SHADER_STAGE:null = 19
Maximum number of uniform buffers per uniform set.
LIMIT_MAX_PUSH_CONSTANT_SIZE:null = 20
Maximum size of a push constant. A lot of devices are limited to 128 bytes, so try to avoid exceeding 128 bytes in push constants to ensure compatibility even if your GPU is reporting a higher value.
LIMIT_MAX_UNIFORM_BUFFER_SIZE:null = 21
Maximum size of a uniform buffer.
LIMIT_MAX_VERTEX_INPUT_ATTRIBUTE_OFFSET:null = 22
Maximum vertex input attribute offset.
LIMIT_MAX_VERTEX_INPUT_ATTRIBUTES:null = 23
Maximum number of vertex input attributes.
LIMIT_MAX_VERTEX_INPUT_BINDINGS:null = 24
Maximum number of vertex input bindings.
LIMIT_MAX_VERTEX_INPUT_BINDING_STRIDE:null = 25
Maximum vertex input binding stride.
LIMIT_MIN_UNIFORM_BUFFER_OFFSET_ALIGNMENT:null = 26
Minimum uniform buffer offset alignment.
LIMIT_MAX_COMPUTE_SHARED_MEMORY_SIZE:null = 27
Maximum shared memory size for compute shaders.
LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_X:null = 28
Maximum number of workgroups for compute shaders on the X axis.
LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Y:null = 29
Maximum number of workgroups for compute shaders on the Y axis.
LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Z:null = 30
Maximum number of workgroups for compute shaders on the Z axis.
LIMIT_MAX_COMPUTE_WORKGROUP_INVOCATIONS:null = 31
Maximum number of workgroup invocations for compute shaders.
LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_X:null = 32
Maximum workgroup size for compute shaders on the X axis.
LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Y:null = 33
Maximum workgroup size for compute shaders on the Y axis.
LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Z:null = 34
Maximum workgroup size for compute shaders on the Z axis.
LIMIT_MAX_VIEWPORT_DIMENSIONS_X:null = 35
Maximum viewport width (in pixels).
LIMIT_MAX_VIEWPORT_DIMENSIONS_Y:null = 36
Maximum viewport height (in pixels).
LIMIT_METALFX_TEMPORAL_SCALER_MIN_SCALE:null = 46
Returns the smallest value for [member ProjectSettings.rendering/scaling_3d/scale] when using the MetalFX temporal upscaler.
Note: The returned value is multiplied by a factor of
LIMIT_METALFX_TEMPORAL_SCALER_MAX_SCALE:null = 47
Returns the largest value for [member ProjectSettings.rendering/scaling_3d/scale] when using the MetalFX temporal upscaler.
Note: The returned value is multiplied by a factor of
MEMORY_TEXTURES:null = 0
Memory taken by textures.
MEMORY_BUFFERS:null = 1
Memory taken by buffers.
MEMORY_TOTAL:null = 2
Total memory taken. This is greater than the sum of MEMORY_TEXTURES and MEMORY_BUFFERS, as it also includes miscellaneous memory usage.
INVALID_ID:null = -1
Returned by functions that return an ID if a value is invalid.
INVALID_FORMAT_ID:null = -1
Returned by functions that return a format ID if a value is invalid.
NONE:null = 0
No breadcrumb marker will be added.
REFLECTION_PROBES:null = 65536
During a GPU crash in dev or debug mode, Godot's error message will include
SKY_PASS:null = 131072
During a GPU crash in dev or debug mode, Godot's error message will include
LIGHTMAPPER_PASS:null = 196608
During a GPU crash in dev or debug mode, Godot's error message will include
SHADOW_PASS_DIRECTIONAL:null = 262144
During a GPU crash in dev or debug mode, Godot's error message will include
SHADOW_PASS_CUBE:null = 327680
During a GPU crash in dev or debug mode, Godot's error message will include
OPAQUE_PASS:null = 393216
During a GPU crash in dev or debug mode, Godot's error message will include
ALPHA_PASS:null = 458752
During a GPU crash in dev or debug mode, Godot's error message will include
TRANSPARENT_PASS:null = 524288
During a GPU crash in dev or debug mode, Godot's error message will include
POST_PROCESSING_PASS:null = 589824
During a GPU crash in dev or debug mode, Godot's error message will include
BLIT_PASS:null = 655360
During a GPU crash in dev or debug mode, Godot's error message will include
UI_PASS:null = 720896
During a GPU crash in dev or debug mode, Godot's error message will include
DEBUG_PASS:null = 786432
During a GPU crash in dev or debug mode, Godot's error message will include
DRAW_DEFAULT_ALL:null = 0
Do not clear or ignore any attachments.
DRAW_CLEAR_COLOR_0:null = 1
Clear the first color attachment.
DRAW_CLEAR_COLOR_1:null = 2
Clear the second color attachment.
DRAW_CLEAR_COLOR_2:null = 4
Clear the third color attachment.
DRAW_CLEAR_COLOR_3:null = 8
Clear the fourth color attachment.
DRAW_CLEAR_COLOR_4:null = 16
Clear the fifth color attachment.
DRAW_CLEAR_COLOR_5:null = 32
Clear the sixth color attachment.
DRAW_CLEAR_COLOR_6:null = 64
Clear the seventh color attachment.
DRAW_CLEAR_COLOR_7:null = 128
Clear the eighth color attachment.
DRAW_CLEAR_COLOR_MASK:null = 255
Mask for clearing all color attachments.
DRAW_CLEAR_COLOR_ALL:null = 255
Clear all color attachments.
DRAW_IGNORE_COLOR_0:null = 256
Ignore the previous contents of the first color attachment.
DRAW_IGNORE_COLOR_1:null = 512
Ignore the previous contents of the second color attachment.
DRAW_IGNORE_COLOR_2:null = 1024
Ignore the previous contents of the third color attachment.
DRAW_IGNORE_COLOR_3:null = 2048
Ignore the previous contents of the fourth color attachment.
DRAW_IGNORE_COLOR_4:null = 4096
Ignore the previous contents of the fifth color attachment.
DRAW_IGNORE_COLOR_5:null = 8192
Ignore the previous contents of the sixth color attachment.
DRAW_IGNORE_COLOR_6:null = 16384
Ignore the previous contents of the seventh color attachment.
DRAW_IGNORE_COLOR_7:null = 32768
Ignore the previous contents of the eighth color attachment.
DRAW_IGNORE_COLOR_MASK:null = 65280
Mask for ignoring all the previous contents of the color attachments.
DRAW_IGNORE_COLOR_ALL:null = 65280
Ignore the previous contents of all color attachments.
DRAW_CLEAR_DEPTH:null = 65536
Clear the depth attachment.
DRAW_IGNORE_DEPTH:null = 131072
Ignore the previous contents of the depth attachment.
DRAW_CLEAR_STENCIL:null = 262144
Clear the stencil attachment.
DRAW_IGNORE_STENCIL:null = 524288
Ignore the previous contents of the stencil attachment.
DRAW_CLEAR_ALL:null = 327935
Clear all attachments.
DRAW_IGNORE_ALL:null = 720640
Ignore the previous contents of all attachments.
This method does nothing.
Builds the blas.
Creates a new Bottom-Level Acceleration Structure (BLAS). It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method.
Prints an error if:
- the size isn't a multiple of four
- the region specified by offset + size_bytes exceeds the buffer
- a draw list is currently active (created by draw_list_begin)
- a compute list is currently active (created by compute_list_begin)
Prints an error if:
- size exceeds the size of either src_buffer or dst_buffer at their corresponding offsets
- a draw list is currently active (created by draw_list_begin)
- a compute list is currently active (created by compute_list_begin)
Returns a copy of the data of the specified buffer, optionally offset_bytes and size_bytes can be set to copy only a portion of the buffer.
Note: This method will block the GPU from working until the data is retrieved. Refer to buffer_get_data_async for an alternative that returns the data in more performant way.
Asynchronous version of buffer_get_data. RenderingDevice will call callback in a certain amount of frames with the data the buffer had at the time of the request.
Note: At the moment, the delay corresponds to the amount of frames specified by [member ProjectSettings.rendering/rendering_device/vsync/frame_queue_size].
Note: Downloading large buffers can have a prohibitive cost for real-time even when using the asynchronous method due to hardware bandwidth limitations. When dealing with large resources, you can adjust settings such as [member ProjectSettings.rendering/rendering_device/staging_buffer/block_size_kb] to improve the transfer speed at the cost of extra memory.
Returns the address of the given buffer which can be passed to shaders in any way to access underlying data. Buffer must have been created with this feature enabled.
Note: You must check that the GPU supports this functionality by calling has_feature with SUPPORTS_BUFFER_DEVICE_ADDRESS as a parameter.
Prints an error if:
- the region specified by offset + size_bytes exceeds the buffer
- a draw list is currently active (created by draw_list_begin)
- a compute list is currently active (created by compute_list_begin)
Creates a timestamp marker with the specified name. This is used for performance reporting with the get_captured_timestamp_cpu_time, get_captured_timestamp_gpu_time and get_captured_timestamp_name methods.
Raises a Vulkan compute barrier in the specified compute_list.
Starts a list of compute commands created with the compute_* methods. The returned value should be passed to other compute_list_* functions.
Multiple compute lists cannot be created at the same time; you must finish the previous compute list first using compute_list_end.
A simple compute operation might look like this (code is not a complete example):
Tells the GPU what compute pipeline to use when processing the compute list. If the shader has changed since the last time this function was called, Godot will unbind all descriptor sets and will re-bind them inside compute_list_dispatch.
Binds the uniform_set to this compute_list. Godot ensures that all textures in the uniform set have the correct Vulkan access masks. If Godot had to change access masks of textures, it will raise a Vulkan image memory barrier.
Submits the compute list for processing on the GPU. This is the compute equivalent to draw_list_draw.
Submits the compute list for processing on the GPU with the given group counts stored in the buffer at offset. Buffer must have been created with STORAGE_BUFFER_USAGE_DISPATCH_INDIRECT flag.
Finishes a list of compute commands created with the compute_* methods.
Sets the push constant data to buffer for the specified compute_list. The shader determines how this binary data is used. The buffer's size in bytes must also be specified in size_bytes (this can be obtained by calling the [method PackedByteArray.size] method on the passed buffer).
Creates a new compute pipeline. It can be accessed with the RID that is returned.
Returns true if the compute pipeline specified by the compute_pipeline RID is valid, false otherwise.
Create a new local RenderingDevice. This is most useful for performing compute operations on the GPU independently from the rest of the engine.
Create a command buffer debug label region that can be displayed in third-party tools such as [url=https://renderdoc.org/]RenderDoc[/url]. All regions must be ended with a draw_command_end_label call. When viewed from the linear series of submissions to a single queue, calls to draw_command_begin_label and draw_command_end_label must be matched and balanced.
The
Ends the command buffer debug label region started by a draw_command_begin_label call.
This method does nothing.
Starts a list of raster drawing commands created with the draw_* methods. The returned value should be passed to other draw_list_* functions.
Multiple draw lists cannot be created at the same time; you must finish the previous draw list first using draw_list_end.
A simple drawing operation might look like this (code is not a complete example):
The draw_flags indicates if the texture attachments of the framebuffer should be cleared or ignored. Only one of the two flags can be used for each individual attachment. Ignoring an attachment means that any contents that existed before the draw list will be completely discarded, reducing the memory bandwidth used by the render pass but producing garbage results if the pixels aren't replaced. The default behavior allows the engine to figure out the right operation to use if the texture is discardable, which can result in increased performance. See RDTextureFormat or texture_set_discardable.
The breadcrumb parameter can be an arbitrary 32-bit integer that is useful to diagnose GPU crashes. If Godot is built in dev or debug mode; when the GPU crashes Godot will dump all shaders that were being executed at the time of the crash and the breadcrumb is useful to diagnose what passes did those shaders belong to.
It does not affect rendering behavior and can be set to 0. It is recommended to use BreadcrumbMarker enumerations for consistency but it's not required. It is also possible to use bitwise operations to add extra data. e.g.
High-level variant of draw_list_begin, with the parameters automatically being adjusted for drawing onto the window specified by the screen ID.
Note: Cannot be used with local RenderingDevices, as these don't have a screen. If called on a local RenderingDevice, draw_list_begin_for_screen returns INVALID_ID.
This method does nothing and always returns an empty PackedInt64Array.
Binds index_array to the specified draw_list.
Binds render_pipeline to the specified draw_list.
Binds uniform_set to the specified draw_list. A set_index must also be specified, which is an identifier starting from 0 that must match the one expected by the draw list.
Binds vertex_array to the specified draw_list.
Binds a set of vertex_buffers directly to the specified draw_list using vertex_format without creating a vertex array RID. Provide the number of vertices in vertex_count; optional per-buffer byte offsets may also be supplied.
Removes and disables the scissor rectangle for the specified draw_list. See also draw_list_enable_scissor.
Submits draw_list for rendering on the GPU. This is the raster equivalent to compute_list_dispatch.
Submits draw_list for rendering on the GPU with the given parameters stored in the buffer at offset. Parameters being integers: vertex count, instance count, first vertex, first instance. And when using indices: index count, instance count, first index, vertex offset, first instance. Buffer must have been created with STORAGE_BUFFER_USAGE_DISPATCH_INDIRECT flag.
Creates a scissor rectangle and enables it for the specified draw_list. Scissor rectangles are used for clipping by discarding fragments that fall outside a specified rectangular portion of the screen. See also draw_list_disable_scissor.
Note: The specified rect is automatically intersected with the screen's dimensions, which means it cannot exceed the screen's dimensions.
Finishes a list of raster drawing commands created with the draw_* methods.
Sets blend constants for the specified draw_list to color. Blend constants are used only if the graphics pipeline is created with DYNAMIC_STATE_BLEND_CONSTANTS flag set.
Sets the push constant data to buffer for the specified draw_list. The shader determines how this binary data is used. The buffer's size in bytes must also be specified in size_bytes (this can be obtained by calling the [method PackedByteArray.size] method on the passed buffer).
Switches to the next draw pass.
This method does nothing and always returns an empty PackedInt64Array.
Creates a new framebuffer. It can be accessed with the RID that is returned.
Creates a new empty framebuffer. It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method.
Creates a new multipass framebuffer. It can be accessed with the RID that is returned.
Creates a new framebuffer format with the specified attachments and view_count. Returns the new framebuffer's unique framebuffer format ID.
If view_count is greater than or equal to
Creates a new empty framebuffer format with the specified number of samples and returns its ID.
Creates a multipass framebuffer format with the specified attachments, passes and view_count and returns its ID. If view_count is greater than or equal to 2 , enables multiview which is used for VR rendering. This requires support for the Vulkan multiview extension.
Returns the number of texture samples used for the given framebuffer format ID (returned by framebuffer_get_format).
Returns the format ID of the framebuffer specified by the framebuffer RID. This ID is guaranteed to be unique for the same formats and does not need to be freed.
Tries to free an object in the RenderingDevice. To avoid memory leaks, this should be called after using an object as memory management does not occur automatically when using RenderingDevice directly.
This method does nothing.
Returns the timestamp in CPU time for the rendering step specified by index (in microseconds since the engine started). See also get_captured_timestamp_gpu_time and capture_timestamp.
Returns the timestamp in GPU time for the rendering step specified by index (in microseconds since the engine started). See also get_captured_timestamp_cpu_time and capture_timestamp.
Returns the timestamp's name for the rendering step specified by index. See also capture_timestamp.
Returns the total number of timestamps (rendering steps) available for profiling.
Returns the index of the last frame rendered that has rendering timestamps available for querying.
Returns how many allocations the GPU has performed for internal driver structures.
This is only used by Vulkan in debug builds and can return 0 when this information is not tracked or unknown.
Same as get_device_allocation_count but filtered for a given object type.
The type argument must be in range
This is only used by Vulkan in debug builds and can return 0 when this information is not tracked or unknown.
Same as get_device_total_memory but filtered for a given object type.
The type argument must be in range
This is only used by Vulkan in debug builds and can return 0 when this information is not tracked or unknown.
Returns the name of the video adapter (e.g. "GeForce GTX 1080/PCIe/SSE2"). Equivalent to [method RenderingServer.get_video_adapter_name]. See also get_device_vendor_name.
Returns the universally unique identifier for the pipeline cache. This is used to cache shader files on disk, which avoids shader recompilations on subsequent engine runs. This UUID varies depending on the graphics card model, but also the driver version. Therefore, updating graphics drivers will invalidate the shader cache.
Returns how much bytes the GPU is using.
This is only used by Vulkan in debug builds and can return 0 when this information is not tracked or unknown.
Returns the vendor of the video adapter (e.g. "NVIDIA Corporation"). Equivalent to [method RenderingServer.get_video_adapter_vendor]. See also get_device_name.
Returns how many allocations the GPU driver has performed for internal driver structures.
This is only used by Vulkan in debug builds and can return 0 when this information is not tracked or unknown.
Same as get_driver_allocation_count but filtered for a given object type.
The type argument must be in range
This is only used by Vulkan in debug builds and can return 0 when this information is not tracked or unknown.
Returns string report in CSV format using the following methods:
- get_tracked_object_name
- get_tracked_object_type_count
- get_driver_total_memory
- get_driver_allocation_count
- get_driver_memory_by_object_type
- get_driver_allocs_by_object_type
- get_device_total_memory
- get_device_allocation_count
- get_device_memory_by_object_type
- get_device_allocs_by_object_type
This is only used by Vulkan in debug builds. Godot must also be started with the
Same as get_driver_total_memory but filtered for a given object type.
The type argument must be in range
This is only used by Vulkan in debug builds and can return 0 when this information is not tracked or unknown.
Returns how much bytes the GPU driver is using for internal driver structures.
This is only used by Vulkan in debug builds and can return 0 when this information is not tracked or unknown.
Returns the frame count kept by the graphics API. Higher values result in higher input lag, but with more consistent throughput. For the main RenderingDevice, frames are cycled (usually 3 with triple-buffered V-Sync enabled). However, local RenderingDevices only have 1 frame.
Returns the memory usage in bytes corresponding to the given type. When using Vulkan, these statistics are calculated by [url=https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator]Vulkan Memory Allocator[/url].
Returns a string with a performance report from the past frame. Updates every frame.
Returns the name of the type of object for the given type_index. This value must be in range [0; get_tracked_object_type_count - 1] . If get_tracked_object_type_count is 0, then type argument is ignored and always returns the same string.
The return value is important because it gives meaning to the types passed to get_driver_memory_by_object_type, get_driver_allocs_by_object_type, get_device_memory_by_object_type, and get_device_allocs_by_object_type. Examples of strings it can return (not exhaustive):
- DEVICE_MEMORY
- PIPELINE_CACHE
- SWAPCHAIN_KHR
- COMMAND_POOL
Thus if e.g.
This is only used by Vulkan in debug builds. Godot must also be started with the
Returns how many types of trackable objects there are.
This is only used by Vulkan in debug builds. Godot must also be started with the
Returns true if the feature is supported by the GPU.
Creates a new hit shader binding table (SBT). It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method.
This will be freed automatically when the raytracing_pipeline is freed.
The hit SBT resizes itself as needed. initial_hit_group_capacity is used to allocate the initial backing memory.
Allocates a contiguous range of SBT entries from hit_sbt.
The returned value should be assigned to [member RDAccelerationStructureInstance.hit_sbt_range].
During ray traversal, hit group index is computed as:
(geometry index in [member RDAccelerationStructureInstance.blas])
× (SBT stride used in
+ (SBT offset used in
+ (range offset)
hit_group_count must be large enough to cover all SBT entries that may be indexed by this equation. This typically corresponds to:
(geometry count in [member RDAccelerationStructureInstance.blas])
× (SBT stride used in
The allocated range is uninitialized and must be filled using hit_sbt_range_update.
Frees a hit SBT range previously allocated with hit_sbt_range_alloc.
The range must not be in use by any acceleration structure after being freed.
Updates the contents of a hit SBT range.
hit_group_indices specifies indices into the hit group array provided in raytracing_pipeline_create.
The offset parameter specifies where within the allocated range the writing begins. This allows partial updates of a range. However, the complete range must be fully initialized before it is used in a raytracing dispatch.
Sets a new raytracing_pipeline for hit_sbt.
The new pipeline must be a superset of the previous one. Existing hit groups must keep the same order and new hit groups should be appended to the end. This preserves existing SBT entries.
The previous pipeline must remain valid during the call.
Creates a new index array. It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method.
This will be freed automatically when the index_buffer is freed.
Creates a new index buffer. It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method.
Returns the value of the specified limit. This limit varies depending on the current graphics hardware (and sometimes the driver version). If the given limit is exceeded, rendering errors will occur.
Limits for various graphics hardware can be found in the [url=https://vulkan.gpuinfo.org/]Vulkan Hardware Database[/url].
Starts a list of raytracing commands. The returned value should be passed to other raytracing_list_* functions.
Multiple raytracing lists cannot be created at the same time; you must finish the previous raytracing list first using raytracing_list_end.
A simple raytracing operation might look like this (code is not a complete example):
Binds raytracing_pipeline to the specified raytracing_list.
Binds the uniform_set to this raytracing_list.
Finishes a list of raytracing commands created with the raytracing_* methods.
Sets the push constant data to buffer for the specified raytracing_list. The shader determines how this binary data is used. The buffer's size in bytes must also be specified in size_bytes (this can be obtained by calling the [method PackedByteArray.size] method on the passed buffer).
raygen_shader_index selects the ray generation shader from the pipeline bound with raytracing_list_bind_raytracing_pipeline.
hit_sbt must use the same pipeline bound to raytracing_list.
Creates a new raytracing pipeline. It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method.
Each shader must provide the required stage. All stages must use compatible pipeline layouts. The pipeline selects the required stage from each shader.
Input order defines stable indices used by the API:
- raygen_shaders is indexed in raytracing_list_trace_rays.
- miss_shaders is indexed in
- hit_groups is indexed in hit_sbt_range_update.
Returns true if the raytracing pipeline specified by the raytracing_pipeline RID is valid, false otherwise.
Creates a new render pipeline. It can be accessed with the RID that is returned.
Creates a new sampler. It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method.
Returns the framebuffer format of the given screen.
Note: Only the main RenderingDevice returned by [method RenderingServer.get_rendering_device] has a format. If called on a local RenderingDevice, this method prints an error and returns INVALID_ID.
Returns the window height matching the graphics API context for the given window ID (in pixels). Despite the parameter being named screen, this returns the window size. See also screen_get_width.
Note: Only the main RenderingDevice returned by [method RenderingServer.get_rendering_device] has a height. If called on a local RenderingDevice, this method prints an error and returns INVALID_ID.
Returns the window width matching the graphics API context for the given window ID (in pixels). Despite the parameter being named screen, this returns the window size. See also screen_get_height.
Note: Only the main RenderingDevice returned by [method RenderingServer.get_rendering_device] has a width. If called on a local RenderingDevice, this method prints an error and returns INVALID_ID.
The following types of resources can be named: texture, sampler, vertex buffer, index buffer, uniform buffer, texture buffer, storage buffer, uniform set buffer, shader, render pipeline and compute pipeline. Framebuffers cannot be named. Attempting to name an incompatible resource type will print an error.
Note: Resource names are only set when the engine runs in verbose mode ([method OS.is_stdout_verbose] =
Compiles a binary shader from spirv_data and returns the compiled binary data as a PackedByteArray. This compiled shader is specific to the GPU model and driver version used; it will not work on different GPU models or even different driver versions. See also shader_compile_spirv_from_source.
name is an optional human-readable name that can be given to the compiled shader for organizational purposes.
Compiles a SPIR-V from the shader source code in shader_source and returns the SPIR-V as an RDShaderSPIRV. This intermediate language shader is portable across different GPU models and driver versions, but cannot be run directly by GPUs until compiled into a binary shader using shader_compile_binary_from_spirv.
If allow_cache is
Creates a new shader instance from a binary compiled shader. It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method. See also shader_compile_binary_from_spirv and shader_create_from_spirv.
Creates a new shader instance from SPIR-V intermediate code. It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method. See also shader_compile_spirv_from_source and shader_create_from_bytecode.
Create a placeholder RID by allocating an RID without initializing it for use in shader_create_from_bytecode. This allows you to create an RID for a shader and pass it around, but defer compiling the shader to a later time.
Returns the internal vertex input mask. Internally, the vertex input mask is an unsigned integer consisting of the locations (specified in GLSL via. layout(location = ...) ) of the input variables (specified in GLSL by the in keyword).
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method.
Pushes the frame setup and draw command buffers then marks the local device as currently processing (which allows calling sync).
Note: Only available in local RenderingDevices.
Forces a synchronization between the CPU and GPU, which may be required in certain cases. Only call this when needed, as CPU-GPU synchronization has a performance cost.
Creates a new texture buffer. It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method.
Clears the specified texture by replacing all of its pixels with the specified color. base_mipmap and mipmap_count determine which mipmaps of the texture are affected by this clear operation, while base_layer and layer_count determine which layers of a 3D texture (or texture array) are affected by this clear operation. For 2D textures (which only have one layer by design), base_layer must be 0 and layer_count must be 1 .
Note: texture can't be cleared while a draw list that uses it as part of a framebuffer is being created. Ensure the draw list is finalized (and that the color/depth texture using it is not set to FINAL_ACTION_CONTINUE) to clear this texture.
Copies the from_texture to to_texture with the specified from_pos, to_pos and size coordinates. For 2-dimensional textures, from_pos and to_pos must have a Z axis of 0 , and size must have a Z axis of 1 . Source and destination mipmaps/layers must also be specified, with these parameters being 0 for textures without mipmaps or single-layer textures. Returns [constant @GlobalScope.OK] if the texture copy was successful or [constant @GlobalScope.ERR_INVALID_PARAMETER] otherwise.
Note: from_texture texture can't be copied while a draw list that uses it as part of a framebuffer is being created. Ensure the draw list is finalized (and that the color/depth texture using it is not set to FINAL_ACTION_CONTINUE) to copy this texture.
Note: from_texture texture requires the TEXTURE_USAGE_CAN_COPY_FROM_BIT to be retrieved.
Note: to_texture can't be copied while a draw list that uses it as part of a framebuffer is being created. Ensure the draw list is finalized (and that the color/depth texture using it is not set to FINAL_ACTION_CONTINUE) to copy this texture.
Note: to_texture requires the TEXTURE_USAGE_CAN_COPY_TO_BIT to be retrieved.
Note: from_texture and to_texture must be of the same type (color or depth).
Creates a new texture. It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method.
Note: data takes an Array of PackedByteArrays. For TEXTURE_TYPE_1D, TEXTURE_TYPE_2D, and TEXTURE_TYPE_3D types, this array should only have one element, a PackedByteArray containing all the data for the texture. For
Note: Not to be confused with [method RenderingServer.texture_2d_create], which creates the Godot-specific Texture2D resource as opposed to the graphics API's own texture type.
Creates a shared texture using the specified view and the texture information from with_texture.
Creates a shared texture using the specified view and the texture information from with_texture's layer and mipmap. The number of included mipmaps from the original texture can be controlled using the mipmaps parameter. Only relevant for textures with multiple layers, such as 3D textures, texture arrays and cubemaps. For single-layer textures, use texture_create_shared.
For 2D textures (which only have one layer), layer must be
Note: Layer slicing is only supported for 2D texture arrays, not 3D textures or cubemaps.
This will be freed automatically when the with_texture is freed.
Note: texture can't be retrieved while a draw list that uses it as part of a framebuffer is being created. Ensure the draw list is finalized (and that the color/depth texture using it is not set to FINAL_ACTION_CONTINUE) to retrieve this texture. Otherwise, an error is printed and an empty PackedByteArray is returned.
Note: texture requires the TEXTURE_USAGE_CAN_COPY_FROM_BIT to be retrieved. Otherwise, an error is printed and an empty PackedByteArray is returned.
Note: This method will block the GPU from working until the data is retrieved. Refer to texture_get_data_async for an alternative that returns the data in more performant way.
Asynchronous version of texture_get_data. RenderingDevice will call callback in a certain amount of frames with the data the texture had at the time of the request.
Note: At the moment, the delay corresponds to the amount of frames specified by [member ProjectSettings.rendering/rendering_device/vsync/frame_queue_size].
Note: Downloading large textures can have a prohibitive cost for real-time even when using the asynchronous method due to hardware bandwidth limitations. When dealing with large resources, you can adjust settings such as [member ProjectSettings.rendering/rendering_device/staging_buffer/texture_download_region_size_px] and [member ProjectSettings.rendering/rendering_device/staging_buffer/block_size_kb] to improve the transfer speed at the cost of extra memory.
Returns the data format used to create this texture.
Returns the internal graphics handle for this texture object. For use when communicating with third-party APIs mostly with GDExtension.
Note: This function returns a
Returns true if the texture is discardable, false otherwise. See RDTextureFormat or texture_set_discardable.
Resolves the from_texture texture onto to_texture with multisample antialiasing enabled. This must be used when rendering a framebuffer for MSAA to work. Returns [constant @GlobalScope.OK] if successful, [constant @GlobalScope.ERR_INVALID_PARAMETER] otherwise.
Note: from_texture and to_texture textures must have the same dimension, format and type (color or depth).
Note: from_texture can't be copied while a draw list that uses it as part of a framebuffer is being created. Ensure the draw list is finalized (and that the color/depth texture using it is not set to FINAL_ACTION_CONTINUE) to resolve this texture.
Note: from_texture requires the TEXTURE_USAGE_CAN_COPY_FROM_BIT to be retrieved.
Note: from_texture must be multisampled and must also be 2D (or a slice of a 3D/cubemap texture).
Note: to_texture can't be copied while a draw list that uses it as part of a framebuffer is being created. Ensure the draw list is finalized (and that the color/depth texture using it is not set to FINAL_ACTION_CONTINUE) to resolve this texture.
Note: to_texture texture requires the TEXTURE_USAGE_CAN_COPY_TO_BIT to be retrieved.
Note: to_texture texture must not be multisampled and must also be 2D (or a slice of a 3D/cubemap texture).
Updates the discardable property of texture.
If a texture is discardable, its contents do not need to be preserved between frames. This flag is only relevant when the texture is used as target in a draw list.
This information is used by RenderingDevice to figure out if a texture's contents can be discarded, eliminating unnecessary writes to memory and boosting performance.
Updates texture data with new data, replacing the previous data in place. The updated texture data must have the same dimensions and format. For 2D textures (which only have one layer), layer must be 0 . Returns [constant @GlobalScope.OK] if the update was successful, [constant @GlobalScope.ERR_INVALID_PARAMETER] otherwise.
Note: Updating textures is forbidden during creation of a draw or compute list.
Note: The existing texture can't be updated while a draw list that uses it as part of a framebuffer is being created. Ensure the draw list is finalized (and that the color/depth texture using it is not set to FINAL_ACTION_CONTINUE) to update this texture.
Note: The existing texture requires the TEXTURE_USAGE_CAN_UPDATE_BIT to be updatable.
Builds the tlas. The contents of previous builds are discarded.
Any BLAS provided through the [member RDAccelerationStructureInstance.blas] member must already have been built using the blas_build method.
The number of instances can be equal to or smaller than the maximum instance count provided in the tlas_create method.
Note: Freeing or rebuilding any of the provided BLASes after this method invalidates the TLAS and requires it to be rebuilt.
Creates a new Top-Level Acceleration Structure (TLAS). It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method.
Creates a new uniform buffer. It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method.
Creates a new uniform set. It can be accessed with the RID that is returned.
Checks if the uniform_set is valid, i.e. is owned.
Creates a vertex array based on the specified buffers. Optionally, offsets (in bytes) may be defined for each buffer.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method.
This will be freed automatically when any of the src_buffers is freed.
Creates a new vertex buffer. It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingDevice's free_rid method.
Creates a new vertex format with the specified vertex_descriptions. Returns a unique vertex format ID corresponding to the newly created vertex format.
