Path: blob/master/servers/rendering/rendering_device_commons.h
20806 views
/**************************************************************************/1/* rendering_device_commons.h */2/**************************************************************************/3/* This file is part of: */4/* GODOT ENGINE */5/* https://godotengine.org */6/**************************************************************************/7/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */8/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */9/* */10/* Permission is hereby granted, free of charge, to any person obtaining */11/* a copy of this software and associated documentation files (the */12/* "Software"), to deal in the Software without restriction, including */13/* without limitation the rights to use, copy, modify, merge, publish, */14/* distribute, sublicense, and/or sell copies of the Software, and to */15/* permit persons to whom the Software is furnished to do so, subject to */16/* the following conditions: */17/* */18/* The above copyright notice and this permission notice shall be */19/* included in all copies or substantial portions of the Software. */20/* */21/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */22/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */23/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */24/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */25/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */26/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */27/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */28/**************************************************************************/2930#pragma once3132#include "core/object/object.h"33#include "core/variant/type_info.h"3435#define STEPIFY(m_number, m_alignment) ((((m_number) + ((m_alignment) - 1)) / (m_alignment)) * (m_alignment))3637// This may one day be used in Godot for interoperability between C arrays, Vector and LocalVector.38// (See https://github.com/godotengine/godot-proposals/issues/5144.)39template <typename T>40class VectorView {41const T *_ptr = nullptr;42const uint32_t _size = 0;4344public:45const T &operator[](uint32_t p_index) {46DEV_ASSERT(p_index < _size);47return _ptr[p_index];48}4950_ALWAYS_INLINE_ const T *ptr() const { return _ptr; }51_ALWAYS_INLINE_ uint32_t size() const { return _size; }5253VectorView() = default;54VectorView(const T &p_ptr) :55// With this one you can pass a single element very conveniently!56_ptr(&p_ptr),57_size(1) {}58VectorView(const T *p_ptr, uint32_t p_size) :59_ptr(p_ptr), _size(p_size) {}60VectorView(const Vector<T> &p_lv) :61_ptr(p_lv.ptr()), _size(p_lv.size()) {}62VectorView(const LocalVector<T> &p_lv) :63_ptr(p_lv.ptr()), _size(p_lv.size()) {}64};6566class RenderingDeviceCommons : public Object {67GDSOFTCLASS(RenderingDeviceCommons, Object);6869////////////////////////////////////////////70// PUBLIC STUFF71// Exposed by RenderingDevice, and shared72// with RenderingDeviceDriver.73////////////////////////////////////////////74public:75static const bool command_pool_reset_enabled = true;7677/*****************/78/**** GENERIC ****/79/*****************/8081static const int INVALID_ID = -1;8283enum DataFormat {84DATA_FORMAT_R4G4_UNORM_PACK8,85DATA_FORMAT_R4G4B4A4_UNORM_PACK16,86DATA_FORMAT_B4G4R4A4_UNORM_PACK16,87DATA_FORMAT_R5G6B5_UNORM_PACK16,88DATA_FORMAT_B5G6R5_UNORM_PACK16,89DATA_FORMAT_R5G5B5A1_UNORM_PACK16,90DATA_FORMAT_B5G5R5A1_UNORM_PACK16,91DATA_FORMAT_A1R5G5B5_UNORM_PACK16,92DATA_FORMAT_R8_UNORM,93DATA_FORMAT_R8_SNORM,94DATA_FORMAT_R8_USCALED,95DATA_FORMAT_R8_SSCALED,96DATA_FORMAT_R8_UINT,97DATA_FORMAT_R8_SINT,98DATA_FORMAT_R8_SRGB,99DATA_FORMAT_R8G8_UNORM,100DATA_FORMAT_R8G8_SNORM,101DATA_FORMAT_R8G8_USCALED,102DATA_FORMAT_R8G8_SSCALED,103DATA_FORMAT_R8G8_UINT,104DATA_FORMAT_R8G8_SINT,105DATA_FORMAT_R8G8_SRGB,106DATA_FORMAT_R8G8B8_UNORM,107DATA_FORMAT_R8G8B8_SNORM,108DATA_FORMAT_R8G8B8_USCALED,109DATA_FORMAT_R8G8B8_SSCALED,110DATA_FORMAT_R8G8B8_UINT,111DATA_FORMAT_R8G8B8_SINT,112DATA_FORMAT_R8G8B8_SRGB,113DATA_FORMAT_B8G8R8_UNORM,114DATA_FORMAT_B8G8R8_SNORM,115DATA_FORMAT_B8G8R8_USCALED,116DATA_FORMAT_B8G8R8_SSCALED,117DATA_FORMAT_B8G8R8_UINT,118DATA_FORMAT_B8G8R8_SINT,119DATA_FORMAT_B8G8R8_SRGB,120DATA_FORMAT_R8G8B8A8_UNORM,121DATA_FORMAT_R8G8B8A8_SNORM,122DATA_FORMAT_R8G8B8A8_USCALED,123DATA_FORMAT_R8G8B8A8_SSCALED,124DATA_FORMAT_R8G8B8A8_UINT,125DATA_FORMAT_R8G8B8A8_SINT,126DATA_FORMAT_R8G8B8A8_SRGB,127DATA_FORMAT_B8G8R8A8_UNORM,128DATA_FORMAT_B8G8R8A8_SNORM,129DATA_FORMAT_B8G8R8A8_USCALED,130DATA_FORMAT_B8G8R8A8_SSCALED,131DATA_FORMAT_B8G8R8A8_UINT,132DATA_FORMAT_B8G8R8A8_SINT,133DATA_FORMAT_B8G8R8A8_SRGB,134DATA_FORMAT_A8B8G8R8_UNORM_PACK32,135DATA_FORMAT_A8B8G8R8_SNORM_PACK32,136DATA_FORMAT_A8B8G8R8_USCALED_PACK32,137DATA_FORMAT_A8B8G8R8_SSCALED_PACK32,138DATA_FORMAT_A8B8G8R8_UINT_PACK32,139DATA_FORMAT_A8B8G8R8_SINT_PACK32,140DATA_FORMAT_A8B8G8R8_SRGB_PACK32,141DATA_FORMAT_A2R10G10B10_UNORM_PACK32,142DATA_FORMAT_A2R10G10B10_SNORM_PACK32,143DATA_FORMAT_A2R10G10B10_USCALED_PACK32,144DATA_FORMAT_A2R10G10B10_SSCALED_PACK32,145DATA_FORMAT_A2R10G10B10_UINT_PACK32,146DATA_FORMAT_A2R10G10B10_SINT_PACK32,147DATA_FORMAT_A2B10G10R10_UNORM_PACK32,148DATA_FORMAT_A2B10G10R10_SNORM_PACK32,149DATA_FORMAT_A2B10G10R10_USCALED_PACK32,150DATA_FORMAT_A2B10G10R10_SSCALED_PACK32,151DATA_FORMAT_A2B10G10R10_UINT_PACK32,152DATA_FORMAT_A2B10G10R10_SINT_PACK32,153DATA_FORMAT_R16_UNORM,154DATA_FORMAT_R16_SNORM,155DATA_FORMAT_R16_USCALED,156DATA_FORMAT_R16_SSCALED,157DATA_FORMAT_R16_UINT,158DATA_FORMAT_R16_SINT,159DATA_FORMAT_R16_SFLOAT,160DATA_FORMAT_R16G16_UNORM,161DATA_FORMAT_R16G16_SNORM,162DATA_FORMAT_R16G16_USCALED,163DATA_FORMAT_R16G16_SSCALED,164DATA_FORMAT_R16G16_UINT,165DATA_FORMAT_R16G16_SINT,166DATA_FORMAT_R16G16_SFLOAT,167DATA_FORMAT_R16G16B16_UNORM,168DATA_FORMAT_R16G16B16_SNORM,169DATA_FORMAT_R16G16B16_USCALED,170DATA_FORMAT_R16G16B16_SSCALED,171DATA_FORMAT_R16G16B16_UINT,172DATA_FORMAT_R16G16B16_SINT,173DATA_FORMAT_R16G16B16_SFLOAT,174DATA_FORMAT_R16G16B16A16_UNORM,175DATA_FORMAT_R16G16B16A16_SNORM,176DATA_FORMAT_R16G16B16A16_USCALED,177DATA_FORMAT_R16G16B16A16_SSCALED,178DATA_FORMAT_R16G16B16A16_UINT,179DATA_FORMAT_R16G16B16A16_SINT,180DATA_FORMAT_R16G16B16A16_SFLOAT,181DATA_FORMAT_R32_UINT,182DATA_FORMAT_R32_SINT,183DATA_FORMAT_R32_SFLOAT,184DATA_FORMAT_R32G32_UINT,185DATA_FORMAT_R32G32_SINT,186DATA_FORMAT_R32G32_SFLOAT,187DATA_FORMAT_R32G32B32_UINT,188DATA_FORMAT_R32G32B32_SINT,189DATA_FORMAT_R32G32B32_SFLOAT,190DATA_FORMAT_R32G32B32A32_UINT,191DATA_FORMAT_R32G32B32A32_SINT,192DATA_FORMAT_R32G32B32A32_SFLOAT,193DATA_FORMAT_R64_UINT,194DATA_FORMAT_R64_SINT,195DATA_FORMAT_R64_SFLOAT,196DATA_FORMAT_R64G64_UINT,197DATA_FORMAT_R64G64_SINT,198DATA_FORMAT_R64G64_SFLOAT,199DATA_FORMAT_R64G64B64_UINT,200DATA_FORMAT_R64G64B64_SINT,201DATA_FORMAT_R64G64B64_SFLOAT,202DATA_FORMAT_R64G64B64A64_UINT,203DATA_FORMAT_R64G64B64A64_SINT,204DATA_FORMAT_R64G64B64A64_SFLOAT,205DATA_FORMAT_B10G11R11_UFLOAT_PACK32,206DATA_FORMAT_E5B9G9R9_UFLOAT_PACK32,207DATA_FORMAT_D16_UNORM,208DATA_FORMAT_X8_D24_UNORM_PACK32,209DATA_FORMAT_D32_SFLOAT,210DATA_FORMAT_S8_UINT,211DATA_FORMAT_D16_UNORM_S8_UINT,212DATA_FORMAT_D24_UNORM_S8_UINT,213DATA_FORMAT_D32_SFLOAT_S8_UINT,214DATA_FORMAT_BC1_RGB_UNORM_BLOCK,215DATA_FORMAT_BC1_RGB_SRGB_BLOCK,216DATA_FORMAT_BC1_RGBA_UNORM_BLOCK,217DATA_FORMAT_BC1_RGBA_SRGB_BLOCK,218DATA_FORMAT_BC2_UNORM_BLOCK,219DATA_FORMAT_BC2_SRGB_BLOCK,220DATA_FORMAT_BC3_UNORM_BLOCK,221DATA_FORMAT_BC3_SRGB_BLOCK,222DATA_FORMAT_BC4_UNORM_BLOCK,223DATA_FORMAT_BC4_SNORM_BLOCK,224DATA_FORMAT_BC5_UNORM_BLOCK,225DATA_FORMAT_BC5_SNORM_BLOCK,226DATA_FORMAT_BC6H_UFLOAT_BLOCK,227DATA_FORMAT_BC6H_SFLOAT_BLOCK,228DATA_FORMAT_BC7_UNORM_BLOCK,229DATA_FORMAT_BC7_SRGB_BLOCK,230DATA_FORMAT_ETC2_R8G8B8_UNORM_BLOCK,231DATA_FORMAT_ETC2_R8G8B8_SRGB_BLOCK,232DATA_FORMAT_ETC2_R8G8B8A1_UNORM_BLOCK,233DATA_FORMAT_ETC2_R8G8B8A1_SRGB_BLOCK,234DATA_FORMAT_ETC2_R8G8B8A8_UNORM_BLOCK,235DATA_FORMAT_ETC2_R8G8B8A8_SRGB_BLOCK,236DATA_FORMAT_EAC_R11_UNORM_BLOCK,237DATA_FORMAT_EAC_R11_SNORM_BLOCK,238DATA_FORMAT_EAC_R11G11_UNORM_BLOCK,239DATA_FORMAT_EAC_R11G11_SNORM_BLOCK,240DATA_FORMAT_ASTC_4x4_UNORM_BLOCK,241DATA_FORMAT_ASTC_4x4_SRGB_BLOCK,242DATA_FORMAT_ASTC_5x4_UNORM_BLOCK,243DATA_FORMAT_ASTC_5x4_SRGB_BLOCK,244DATA_FORMAT_ASTC_5x5_UNORM_BLOCK,245DATA_FORMAT_ASTC_5x5_SRGB_BLOCK,246DATA_FORMAT_ASTC_6x5_UNORM_BLOCK,247DATA_FORMAT_ASTC_6x5_SRGB_BLOCK,248DATA_FORMAT_ASTC_6x6_UNORM_BLOCK,249DATA_FORMAT_ASTC_6x6_SRGB_BLOCK,250DATA_FORMAT_ASTC_8x5_UNORM_BLOCK,251DATA_FORMAT_ASTC_8x5_SRGB_BLOCK,252DATA_FORMAT_ASTC_8x6_UNORM_BLOCK,253DATA_FORMAT_ASTC_8x6_SRGB_BLOCK,254DATA_FORMAT_ASTC_8x8_UNORM_BLOCK,255DATA_FORMAT_ASTC_8x8_SRGB_BLOCK,256DATA_FORMAT_ASTC_10x5_UNORM_BLOCK,257DATA_FORMAT_ASTC_10x5_SRGB_BLOCK,258DATA_FORMAT_ASTC_10x6_UNORM_BLOCK,259DATA_FORMAT_ASTC_10x6_SRGB_BLOCK,260DATA_FORMAT_ASTC_10x8_UNORM_BLOCK,261DATA_FORMAT_ASTC_10x8_SRGB_BLOCK,262DATA_FORMAT_ASTC_10x10_UNORM_BLOCK,263DATA_FORMAT_ASTC_10x10_SRGB_BLOCK,264DATA_FORMAT_ASTC_12x10_UNORM_BLOCK,265DATA_FORMAT_ASTC_12x10_SRGB_BLOCK,266DATA_FORMAT_ASTC_12x12_UNORM_BLOCK,267DATA_FORMAT_ASTC_12x12_SRGB_BLOCK,268DATA_FORMAT_G8B8G8R8_422_UNORM,269DATA_FORMAT_B8G8R8G8_422_UNORM,270DATA_FORMAT_G8_B8_R8_3PLANE_420_UNORM,271DATA_FORMAT_G8_B8R8_2PLANE_420_UNORM,272DATA_FORMAT_G8_B8_R8_3PLANE_422_UNORM,273DATA_FORMAT_G8_B8R8_2PLANE_422_UNORM,274DATA_FORMAT_G8_B8_R8_3PLANE_444_UNORM,275DATA_FORMAT_R10X6_UNORM_PACK16,276DATA_FORMAT_R10X6G10X6_UNORM_2PACK16,277DATA_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16,278DATA_FORMAT_G10X6B10X6G10X6R10X6_422_UNORM_4PACK16,279DATA_FORMAT_B10X6G10X6R10X6G10X6_422_UNORM_4PACK16,280DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_420_UNORM_3PACK16,281DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16,282DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_422_UNORM_3PACK16,283DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_422_UNORM_3PACK16,284DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_444_UNORM_3PACK16,285DATA_FORMAT_R12X4_UNORM_PACK16,286DATA_FORMAT_R12X4G12X4_UNORM_2PACK16,287DATA_FORMAT_R12X4G12X4B12X4A12X4_UNORM_4PACK16,288DATA_FORMAT_G12X4B12X4G12X4R12X4_422_UNORM_4PACK16,289DATA_FORMAT_B12X4G12X4R12X4G12X4_422_UNORM_4PACK16,290DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_420_UNORM_3PACK16,291DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_420_UNORM_3PACK16,292DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_422_UNORM_3PACK16,293DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_422_UNORM_3PACK16,294DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_444_UNORM_3PACK16,295DATA_FORMAT_G16B16G16R16_422_UNORM,296DATA_FORMAT_B16G16R16G16_422_UNORM,297DATA_FORMAT_G16_B16_R16_3PLANE_420_UNORM,298DATA_FORMAT_G16_B16R16_2PLANE_420_UNORM,299DATA_FORMAT_G16_B16_R16_3PLANE_422_UNORM,300DATA_FORMAT_G16_B16R16_2PLANE_422_UNORM,301DATA_FORMAT_G16_B16_R16_3PLANE_444_UNORM,302DATA_FORMAT_ASTC_4x4_SFLOAT_BLOCK, // HDR variant.303DATA_FORMAT_ASTC_5x4_SFLOAT_BLOCK, // HDR variant.304DATA_FORMAT_ASTC_5x5_SFLOAT_BLOCK, // HDR variant.305DATA_FORMAT_ASTC_6x5_SFLOAT_BLOCK, // HDR variant.306DATA_FORMAT_ASTC_6x6_SFLOAT_BLOCK, // HDR variant.307DATA_FORMAT_ASTC_8x5_SFLOAT_BLOCK, // HDR variant.308DATA_FORMAT_ASTC_8x6_SFLOAT_BLOCK, // HDR variant.309DATA_FORMAT_ASTC_8x8_SFLOAT_BLOCK, // HDR variant.310DATA_FORMAT_ASTC_10x5_SFLOAT_BLOCK, // HDR variant.311DATA_FORMAT_ASTC_10x6_SFLOAT_BLOCK, // HDR variant.312DATA_FORMAT_ASTC_10x8_SFLOAT_BLOCK, // HDR variant.313DATA_FORMAT_ASTC_10x10_SFLOAT_BLOCK, // HDR variant.314DATA_FORMAT_ASTC_12x10_SFLOAT_BLOCK, // HDR variant.315DATA_FORMAT_ASTC_12x12_SFLOAT_BLOCK, // HDR variant.316DATA_FORMAT_MAX,317};318319// Breadcrumb markers are useful for debugging GPU crashes (i.e. DEVICE_LOST). Internally320// they're just an uint32_t to "tag" a GPU command. These are only used for debugging and do not321// (or at least shouldn't) alter the execution behavior in any way.322//323// When a GPU crashes and Godot was built in dev or debug mode; Godot will dump what commands324// were being executed and what tag they were marked with.325// This makes narrowing down the cause of a crash easier. Note that a GPU can be executing326// multiple commands at the same time. It is also useful to identify data hazards.327//328// For example if each LIGHTMAPPER_PASS must be executed in sequential order, but dumps329// indicated that pass (LIGHTMAPPER_PASS | 5) was being executed at the same time as330// (LIGHTMAPPER_PASS | 4), that would indicate there is a missing barrier or a render graph bug.331//332// The enums are bitshifted by 16 bits so it's possible to add user data via bitwise operations.333// Using this enum is not mandatory; but it is recommended so that all subsystems agree what each334// ID means when dumping info.335enum BreadcrumbMarker {336NONE = 0,337// Environment338REFLECTION_PROBES = 1u << 16u,339SKY_PASS = 2u << 16u,340// Light mapping341LIGHTMAPPER_PASS = 3u << 16u,342// Shadows343SHADOW_PASS_DIRECTIONAL = 4u << 16u,344SHADOW_PASS_CUBE = 5u << 16u,345// Geometry passes346OPAQUE_PASS = 6u << 16u,347ALPHA_PASS = 7u << 16u,348TRANSPARENT_PASS = 8u << 16u,349// Screen effects350POST_PROCESSING_PASS = 9u << 16u,351BLIT_PASS = 10u << 16u,352UI_PASS = 11u << 16u,353// Other354DEBUG_PASS = 12u << 16u,355};356357enum CompareOperator {358COMPARE_OP_NEVER,359COMPARE_OP_LESS,360COMPARE_OP_EQUAL,361COMPARE_OP_LESS_OR_EQUAL,362COMPARE_OP_GREATER,363COMPARE_OP_NOT_EQUAL,364COMPARE_OP_GREATER_OR_EQUAL,365COMPARE_OP_ALWAYS,366COMPARE_OP_MAX367};368369/*****************/370/**** TEXTURE ****/371/*****************/372373enum TextureType {374TEXTURE_TYPE_1D,375TEXTURE_TYPE_2D,376TEXTURE_TYPE_3D,377TEXTURE_TYPE_CUBE,378TEXTURE_TYPE_1D_ARRAY,379TEXTURE_TYPE_2D_ARRAY,380TEXTURE_TYPE_CUBE_ARRAY,381TEXTURE_TYPE_MAX,382};383384enum TextureSamples {385TEXTURE_SAMPLES_1,386TEXTURE_SAMPLES_2,387TEXTURE_SAMPLES_4,388TEXTURE_SAMPLES_8,389TEXTURE_SAMPLES_16,390TEXTURE_SAMPLES_32,391TEXTURE_SAMPLES_64,392TEXTURE_SAMPLES_MAX,393};394395enum TextureUsageBits {396TEXTURE_USAGE_SAMPLING_BIT = (1 << 0),397TEXTURE_USAGE_COLOR_ATTACHMENT_BIT = (1 << 1),398TEXTURE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT = (1 << 2),399TEXTURE_USAGE_STORAGE_BIT = (1 << 3),400TEXTURE_USAGE_STORAGE_ATOMIC_BIT = (1 << 4),401TEXTURE_USAGE_CPU_READ_BIT = (1 << 5),402TEXTURE_USAGE_CAN_UPDATE_BIT = (1 << 6),403TEXTURE_USAGE_CAN_COPY_FROM_BIT = (1 << 7),404TEXTURE_USAGE_CAN_COPY_TO_BIT = (1 << 8),405TEXTURE_USAGE_INPUT_ATTACHMENT_BIT = (1 << 9),406TEXTURE_USAGE_VRS_ATTACHMENT_BIT = (1 << 10),407// When set, the texture is not backed by actual memory. It only ever lives in the cache.408// This is particularly useful for:409// 1. Depth/stencil buffers that are not needed after producing the colour output.410// 2. MSAA surfaces that are immediately resolved (i.e. its raw content isn't needed).411//412// This flag heavily improves performance & saves memory on TBDR GPUs (e.g. mobile).413// On Desktop this flag won't save memory but it still instructs the render graph that data will414// be discarded aggressively which may still improve some performance.415//416// It is not valid to perform copies from/to this texture, since it doesn't occupy actual RAM.417// It is also not valid to sample from this texture except using subpasses or via read/write418// pixel shader extensions (e.g. VK_EXT_rasterization_order_attachment_access).419//420// Try to set this bit as much as possible. If you set it, validation doesn't complain421// and it works fine on mobile, then go ahead.422TEXTURE_USAGE_TRANSIENT_BIT = (1 << 11),423TEXTURE_USAGE_DEPTH_RESOLVE_ATTACHMENT_BIT = (1 << 12),424TEXTURE_USAGE_MAX_BIT = TEXTURE_USAGE_DEPTH_RESOLVE_ATTACHMENT_BIT,425};426427struct TextureFormat {428DataFormat format = DATA_FORMAT_R8_UNORM;429uint32_t width = 1;430uint32_t height = 1;431uint32_t depth = 1;432uint32_t array_layers = 1;433uint32_t mipmaps = 1;434TextureType texture_type = TEXTURE_TYPE_2D;435TextureSamples samples = TEXTURE_SAMPLES_1;436uint32_t usage_bits = 0;437Vector<DataFormat> shareable_formats;438bool is_resolve_buffer = false;439bool is_discardable = false;440441bool operator==(const TextureFormat &b) const {442if (format != b.format) {443return false;444} else if (width != b.width) {445return false;446} else if (height != b.height) {447return false;448} else if (depth != b.depth) {449return false;450} else if (array_layers != b.array_layers) {451return false;452} else if (mipmaps != b.mipmaps) {453return false;454} else if (texture_type != b.texture_type) {455return false;456} else if (samples != b.samples) {457return false;458} else if (usage_bits != b.usage_bits) {459return false;460} else if (shareable_formats != b.shareable_formats) {461return false;462} else if (is_resolve_buffer != b.is_resolve_buffer) {463return false;464} else if (is_discardable != b.is_discardable) {465return false;466} else {467return true;468}469}470};471472enum TextureSwizzle {473TEXTURE_SWIZZLE_IDENTITY,474TEXTURE_SWIZZLE_ZERO,475TEXTURE_SWIZZLE_ONE,476TEXTURE_SWIZZLE_R,477TEXTURE_SWIZZLE_G,478TEXTURE_SWIZZLE_B,479TEXTURE_SWIZZLE_A,480TEXTURE_SWIZZLE_MAX481};482483enum TextureSliceType {484TEXTURE_SLICE_2D,485TEXTURE_SLICE_CUBEMAP,486TEXTURE_SLICE_3D,487TEXTURE_SLICE_2D_ARRAY,488TEXTURE_SLICE_MAX489};490491/*****************/492/**** SAMPLER ****/493/*****************/494495enum SamplerFilter {496SAMPLER_FILTER_NEAREST,497SAMPLER_FILTER_LINEAR,498};499500enum SamplerRepeatMode {501SAMPLER_REPEAT_MODE_REPEAT,502SAMPLER_REPEAT_MODE_MIRRORED_REPEAT,503SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE,504SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER,505SAMPLER_REPEAT_MODE_MIRROR_CLAMP_TO_EDGE,506SAMPLER_REPEAT_MODE_MAX507};508509enum SamplerBorderColor {510SAMPLER_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK,511SAMPLER_BORDER_COLOR_INT_TRANSPARENT_BLACK,512SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_BLACK,513SAMPLER_BORDER_COLOR_INT_OPAQUE_BLACK,514SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_WHITE,515SAMPLER_BORDER_COLOR_INT_OPAQUE_WHITE,516SAMPLER_BORDER_COLOR_MAX517};518519struct SamplerState {520SamplerFilter mag_filter = SAMPLER_FILTER_NEAREST;521SamplerFilter min_filter = SAMPLER_FILTER_NEAREST;522SamplerFilter mip_filter = SAMPLER_FILTER_NEAREST;523SamplerRepeatMode repeat_u = SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE;524SamplerRepeatMode repeat_v = SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE;525SamplerRepeatMode repeat_w = SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE;526float lod_bias = 0.0f;527bool use_anisotropy = false;528float anisotropy_max = 1.0f;529bool enable_compare = false;530CompareOperator compare_op = COMPARE_OP_ALWAYS;531float min_lod = 0.0f;532float max_lod = 1e20; // Something very large should do.533SamplerBorderColor border_color = SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_BLACK;534bool unnormalized_uvw = false;535};536537/**********************/538/**** VERTEX ARRAY ****/539/**********************/540541enum IndexBufferFormat {542INDEX_BUFFER_FORMAT_UINT16,543INDEX_BUFFER_FORMAT_UINT32,544};545546enum VertexFrequency {547VERTEX_FREQUENCY_VERTEX,548VERTEX_FREQUENCY_INSTANCE,549};550551struct VertexAttribute {552uint32_t binding = UINT32_MAX; // Attribute buffer binding index. When set to UINT32_MAX, it uses the index of the attribute in the layout.553uint32_t location = 0; // Shader location.554uint32_t offset = 0;555DataFormat format = DATA_FORMAT_MAX;556uint32_t stride = 0;557VertexFrequency frequency = VERTEX_FREQUENCY_VERTEX;558};559560struct VertexAttributeBinding {561uint32_t stride = 0;562VertexFrequency frequency = VERTEX_FREQUENCY_VERTEX;563564VertexAttributeBinding() = default;565VertexAttributeBinding(uint32_t p_stride, VertexFrequency p_frequency) :566stride(p_stride),567frequency(p_frequency) {}568};569570typedef HashMap<uint32_t, VertexAttributeBinding> VertexAttributeBindingsMap;571572/*********************/573/**** FRAMEBUFFER ****/574/*********************/575576static const int32_t ATTACHMENT_UNUSED = -1;577578/****************/579/**** SHADER ****/580/****************/581582enum ShaderStage {583SHADER_STAGE_VERTEX,584SHADER_STAGE_FRAGMENT,585SHADER_STAGE_TESSELATION_CONTROL,586SHADER_STAGE_TESSELATION_EVALUATION,587SHADER_STAGE_COMPUTE,588SHADER_STAGE_RAYGEN,589SHADER_STAGE_ANY_HIT,590SHADER_STAGE_CLOSEST_HIT,591SHADER_STAGE_MISS,592SHADER_STAGE_INTERSECTION,593SHADER_STAGE_MAX,594SHADER_STAGE_VERTEX_BIT = (1 << SHADER_STAGE_VERTEX),595SHADER_STAGE_FRAGMENT_BIT = (1 << SHADER_STAGE_FRAGMENT),596SHADER_STAGE_TESSELATION_CONTROL_BIT = (1 << SHADER_STAGE_TESSELATION_CONTROL),597SHADER_STAGE_TESSELATION_EVALUATION_BIT = (1 << SHADER_STAGE_TESSELATION_EVALUATION),598SHADER_STAGE_COMPUTE_BIT = (1 << SHADER_STAGE_COMPUTE),599SHADER_STAGE_RAYGEN_BIT = (1 << SHADER_STAGE_RAYGEN),600SHADER_STAGE_ANY_HIT_BIT = (1 << SHADER_STAGE_ANY_HIT),601SHADER_STAGE_CLOSEST_HIT_BIT = (1 << SHADER_STAGE_CLOSEST_HIT),602SHADER_STAGE_MISS_BIT = (1 << SHADER_STAGE_MISS),603SHADER_STAGE_INTERSECTION_BIT = (1 << SHADER_STAGE_INTERSECTION),604};605606enum ShaderLanguage {607SHADER_LANGUAGE_GLSL,608SHADER_LANGUAGE_HLSL,609};610611enum ShaderLanguageVersion {612SHADER_LANGUAGE_VULKAN_VERSION_1_0 = (1 << 22),613SHADER_LANGUAGE_VULKAN_VERSION_1_1 = (1 << 22) | (1 << 12),614SHADER_LANGUAGE_VULKAN_VERSION_1_2 = (1 << 22) | (2 << 12),615SHADER_LANGUAGE_VULKAN_VERSION_1_3 = (1 << 22) | (3 << 12),616SHADER_LANGUAGE_VULKAN_VERSION_1_4 = (1 << 22) | (4 << 12),617SHADER_LANGUAGE_OPENGL_VERSION_4_5_0 = 450,618};619620enum ShaderSpirvVersion {621SHADER_SPIRV_VERSION_1_0 = (1 << 16),622SHADER_SPIRV_VERSION_1_1 = (1 << 16) | (1 << 8),623SHADER_SPIRV_VERSION_1_2 = (1 << 16) | (2 << 8),624SHADER_SPIRV_VERSION_1_3 = (1 << 16) | (3 << 8),625SHADER_SPIRV_VERSION_1_4 = (1 << 16) | (4 << 8),626SHADER_SPIRV_VERSION_1_5 = (1 << 16) | (5 << 8),627SHADER_SPIRV_VERSION_1_6 = (1 << 16) | (6 << 8),628};629630struct ShaderStageSPIRVData {631ShaderStage shader_stage = SHADER_STAGE_MAX;632Vector<uint8_t> spirv;633Vector<uint64_t> dynamic_buffers;634};635636/*********************/637/**** UNIFORM SET ****/638/*********************/639640static const uint32_t MAX_UNIFORM_SETS = 16;641642// Keep the enum values in sync with the `SHADER_UNIFORM_NAMES` values (file rendering_device.cpp).643enum UniformType {644UNIFORM_TYPE_SAMPLER, // For sampling only (sampler GLSL type).645UNIFORM_TYPE_SAMPLER_WITH_TEXTURE, // For sampling only, but includes a texture, (samplerXX GLSL type), first a sampler then a texture.646UNIFORM_TYPE_TEXTURE, // Only texture, (textureXX GLSL type).647UNIFORM_TYPE_IMAGE, // Storage image (imageXX GLSL type), for compute mostly.648UNIFORM_TYPE_TEXTURE_BUFFER, // Buffer texture (or TBO, textureBuffer type).649UNIFORM_TYPE_SAMPLER_WITH_TEXTURE_BUFFER, // Buffer texture with a sampler(or TBO, samplerBuffer type).650UNIFORM_TYPE_IMAGE_BUFFER, // Texel buffer, (imageBuffer type), for compute mostly.651UNIFORM_TYPE_UNIFORM_BUFFER, // Regular uniform buffer (or UBO).652UNIFORM_TYPE_STORAGE_BUFFER, // Storage buffer ("buffer" qualifier) like UBO, but supports storage, for compute mostly.653UNIFORM_TYPE_INPUT_ATTACHMENT, // Used for sub-pass read/write, for mobile mostly.654UNIFORM_TYPE_UNIFORM_BUFFER_DYNAMIC, // Same as UNIFORM but created with BUFFER_USAGE_DYNAMIC_PERSISTENT_BIT.655UNIFORM_TYPE_STORAGE_BUFFER_DYNAMIC, // Same as STORAGE but created with BUFFER_USAGE_DYNAMIC_PERSISTENT_BIT.656UNIFORM_TYPE_ACCELERATION_STRUCTURE, // Bounding Volume Hierarchy (Top + Bottom Level acceleration structures), for raytracing only.657UNIFORM_TYPE_MAX658};659660/******************/661/**** PIPELINE ****/662/******************/663664enum PipelineSpecializationConstantType {665PIPELINE_SPECIALIZATION_CONSTANT_TYPE_BOOL,666PIPELINE_SPECIALIZATION_CONSTANT_TYPE_INT,667PIPELINE_SPECIALIZATION_CONSTANT_TYPE_FLOAT,668};669670struct PipelineSpecializationConstant {671PipelineSpecializationConstantType type = {};672uint32_t constant_id = 0xffffffff;673union {674uint32_t int_value = 0;675float float_value;676bool bool_value;677};678};679680/*******************/681/**** RENDERING ****/682/*******************/683684// ----- PIPELINE -----685686// Rendering Shader Container expects this type to be 4 bytes for proper alignment with the shaders.687enum PipelineType : uint32_t {688PIPELINE_TYPE_RASTERIZATION,689PIPELINE_TYPE_COMPUTE,690PIPELINE_TYPE_RAYTRACING,691};692693enum RenderPrimitive {694RENDER_PRIMITIVE_POINTS,695RENDER_PRIMITIVE_LINES,696RENDER_PRIMITIVE_LINES_WITH_ADJACENCY,697RENDER_PRIMITIVE_LINESTRIPS,698RENDER_PRIMITIVE_LINESTRIPS_WITH_ADJACENCY,699RENDER_PRIMITIVE_TRIANGLES,700RENDER_PRIMITIVE_TRIANGLES_WITH_ADJACENCY,701RENDER_PRIMITIVE_TRIANGLE_STRIPS,702RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_AJACENCY, // TODO: Fix typo in "ADJACENCY" (in 5.0).703RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_RESTART_INDEX,704RENDER_PRIMITIVE_TESSELATION_PATCH,705RENDER_PRIMITIVE_MAX706};707708enum PolygonCullMode {709POLYGON_CULL_DISABLED,710POLYGON_CULL_FRONT,711POLYGON_CULL_BACK,712POLYGON_CULL_MAX713};714715enum PolygonFrontFace {716POLYGON_FRONT_FACE_CLOCKWISE,717POLYGON_FRONT_FACE_COUNTER_CLOCKWISE,718};719720enum StencilOperation {721STENCIL_OP_KEEP,722STENCIL_OP_ZERO,723STENCIL_OP_REPLACE,724STENCIL_OP_INCREMENT_AND_CLAMP,725STENCIL_OP_DECREMENT_AND_CLAMP,726STENCIL_OP_INVERT,727STENCIL_OP_INCREMENT_AND_WRAP,728STENCIL_OP_DECREMENT_AND_WRAP,729STENCIL_OP_MAX730};731732enum LogicOperation {733LOGIC_OP_CLEAR,734LOGIC_OP_AND,735LOGIC_OP_AND_REVERSE,736LOGIC_OP_COPY,737LOGIC_OP_AND_INVERTED,738LOGIC_OP_NO_OP,739LOGIC_OP_XOR,740LOGIC_OP_OR,741LOGIC_OP_NOR,742LOGIC_OP_EQUIVALENT,743LOGIC_OP_INVERT,744LOGIC_OP_OR_REVERSE,745LOGIC_OP_COPY_INVERTED,746LOGIC_OP_OR_INVERTED,747LOGIC_OP_NAND,748LOGIC_OP_SET,749LOGIC_OP_MAX750};751752enum BlendFactor {753BLEND_FACTOR_ZERO,754BLEND_FACTOR_ONE,755BLEND_FACTOR_SRC_COLOR,756BLEND_FACTOR_ONE_MINUS_SRC_COLOR,757BLEND_FACTOR_DST_COLOR,758BLEND_FACTOR_ONE_MINUS_DST_COLOR,759BLEND_FACTOR_SRC_ALPHA,760BLEND_FACTOR_ONE_MINUS_SRC_ALPHA,761BLEND_FACTOR_DST_ALPHA,762BLEND_FACTOR_ONE_MINUS_DST_ALPHA,763BLEND_FACTOR_CONSTANT_COLOR,764BLEND_FACTOR_ONE_MINUS_CONSTANT_COLOR,765BLEND_FACTOR_CONSTANT_ALPHA,766BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA,767BLEND_FACTOR_SRC_ALPHA_SATURATE,768BLEND_FACTOR_SRC1_COLOR,769BLEND_FACTOR_ONE_MINUS_SRC1_COLOR,770BLEND_FACTOR_SRC1_ALPHA,771BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA,772BLEND_FACTOR_MAX773};774775enum BlendOperation {776BLEND_OP_ADD,777BLEND_OP_SUBTRACT,778BLEND_OP_REVERSE_SUBTRACT,779BLEND_OP_MINIMUM,780BLEND_OP_MAXIMUM, // Yes, this one is an actual operator.781BLEND_OP_MAX782};783784struct PipelineRasterizationState {785bool enable_depth_clamp = false;786bool discard_primitives = false;787bool wireframe = false;788PolygonCullMode cull_mode = POLYGON_CULL_DISABLED;789PolygonFrontFace front_face = POLYGON_FRONT_FACE_CLOCKWISE;790bool depth_bias_enabled = false;791float depth_bias_constant_factor = 0.0f;792float depth_bias_clamp = 0.0f;793float depth_bias_slope_factor = 0.0f;794float line_width = 1.0f;795uint32_t patch_control_points = 1;796};797798struct PipelineMultisampleState {799TextureSamples sample_count = TEXTURE_SAMPLES_1;800bool enable_sample_shading = false;801float min_sample_shading = 0.0f;802Vector<uint32_t> sample_mask;803bool enable_alpha_to_coverage = false;804bool enable_alpha_to_one = false;805};806807struct PipelineDepthStencilState {808bool enable_depth_test = false;809bool enable_depth_write = false;810CompareOperator depth_compare_operator = COMPARE_OP_ALWAYS;811bool enable_depth_range = false;812float depth_range_min = 0;813float depth_range_max = 0;814bool enable_stencil = false;815816struct StencilOperationState {817StencilOperation fail = STENCIL_OP_ZERO;818StencilOperation pass = STENCIL_OP_ZERO;819StencilOperation depth_fail = STENCIL_OP_ZERO;820CompareOperator compare = COMPARE_OP_ALWAYS;821uint32_t compare_mask = 0;822uint32_t write_mask = 0;823uint32_t reference = 0;824};825826StencilOperationState front_op;827StencilOperationState back_op;828};829830struct PipelineColorBlendState {831bool enable_logic_op = false;832LogicOperation logic_op = LOGIC_OP_CLEAR;833834struct Attachment {835bool enable_blend = false;836BlendFactor src_color_blend_factor = BLEND_FACTOR_ZERO;837BlendFactor dst_color_blend_factor = BLEND_FACTOR_ZERO;838BlendOperation color_blend_op = BLEND_OP_ADD;839BlendFactor src_alpha_blend_factor = BLEND_FACTOR_ZERO;840BlendFactor dst_alpha_blend_factor = BLEND_FACTOR_ZERO;841BlendOperation alpha_blend_op = BLEND_OP_ADD;842bool write_r = true;843bool write_g = true;844bool write_b = true;845bool write_a = true;846};847848static PipelineColorBlendState create_disabled(int p_attachments = 1) {849PipelineColorBlendState bs;850for (int i = 0; i < p_attachments; i++) {851bs.attachments.push_back(Attachment());852}853return bs;854}855856static PipelineColorBlendState create_blend(int p_attachments = 1) {857PipelineColorBlendState bs;858for (int i = 0; i < p_attachments; i++) {859Attachment ba;860ba.enable_blend = true;861ba.src_color_blend_factor = BLEND_FACTOR_SRC_ALPHA;862ba.dst_color_blend_factor = BLEND_FACTOR_ONE_MINUS_SRC_ALPHA;863ba.src_alpha_blend_factor = BLEND_FACTOR_SRC_ALPHA;864ba.dst_alpha_blend_factor = BLEND_FACTOR_ONE_MINUS_SRC_ALPHA;865866bs.attachments.push_back(ba);867}868return bs;869}870871Vector<Attachment> attachments; // One per render target texture.872Color blend_constant;873};874875enum PipelineDynamicStateFlags {876DYNAMIC_STATE_LINE_WIDTH = (1 << 0),877DYNAMIC_STATE_DEPTH_BIAS = (1 << 1),878DYNAMIC_STATE_BLEND_CONSTANTS = (1 << 2),879DYNAMIC_STATE_DEPTH_BOUNDS = (1 << 3),880DYNAMIC_STATE_STENCIL_COMPARE_MASK = (1 << 4),881DYNAMIC_STATE_STENCIL_WRITE_MASK = (1 << 5),882DYNAMIC_STATE_STENCIL_REFERENCE = (1 << 6),883};884885/**************/886/**** MISC ****/887/**************/888889// This enum matches VkPhysicalDeviceType (except for `DEVICE_TYPE_MAX`).890// Unlike VkPhysicalDeviceType, DeviceType is exposed to the scripting API.891enum DeviceType {892DEVICE_TYPE_OTHER,893DEVICE_TYPE_INTEGRATED_GPU,894DEVICE_TYPE_DISCRETE_GPU,895DEVICE_TYPE_VIRTUAL_GPU,896DEVICE_TYPE_CPU,897DEVICE_TYPE_MAX898};899900// Defined in an API-agnostic way.901// Some may not make sense for the underlying API; in that case, 0 is returned.902enum DriverResource {903DRIVER_RESOURCE_LOGICAL_DEVICE,904DRIVER_RESOURCE_PHYSICAL_DEVICE,905DRIVER_RESOURCE_TOPMOST_OBJECT,906DRIVER_RESOURCE_COMMAND_QUEUE,907DRIVER_RESOURCE_QUEUE_FAMILY,908DRIVER_RESOURCE_TEXTURE,909DRIVER_RESOURCE_TEXTURE_VIEW,910DRIVER_RESOURCE_TEXTURE_DATA_FORMAT,911DRIVER_RESOURCE_SAMPLER,912DRIVER_RESOURCE_UNIFORM_SET,913DRIVER_RESOURCE_BUFFER,914DRIVER_RESOURCE_COMPUTE_PIPELINE,915DRIVER_RESOURCE_RENDER_PIPELINE,916#ifndef DISABLE_DEPRECATED917DRIVER_RESOURCE_VULKAN_DEVICE = DRIVER_RESOURCE_LOGICAL_DEVICE,918DRIVER_RESOURCE_VULKAN_PHYSICAL_DEVICE = DRIVER_RESOURCE_PHYSICAL_DEVICE,919DRIVER_RESOURCE_VULKAN_INSTANCE = DRIVER_RESOURCE_TOPMOST_OBJECT,920DRIVER_RESOURCE_VULKAN_QUEUE = DRIVER_RESOURCE_COMMAND_QUEUE,921DRIVER_RESOURCE_VULKAN_QUEUE_FAMILY_INDEX = DRIVER_RESOURCE_QUEUE_FAMILY,922DRIVER_RESOURCE_VULKAN_IMAGE = DRIVER_RESOURCE_TEXTURE,923DRIVER_RESOURCE_VULKAN_IMAGE_VIEW = DRIVER_RESOURCE_TEXTURE_VIEW,924DRIVER_RESOURCE_VULKAN_IMAGE_NATIVE_TEXTURE_FORMAT = DRIVER_RESOURCE_TEXTURE_DATA_FORMAT,925DRIVER_RESOURCE_VULKAN_SAMPLER = DRIVER_RESOURCE_SAMPLER,926DRIVER_RESOURCE_VULKAN_DESCRIPTOR_SET = DRIVER_RESOURCE_UNIFORM_SET,927DRIVER_RESOURCE_VULKAN_BUFFER = DRIVER_RESOURCE_BUFFER,928DRIVER_RESOURCE_VULKAN_COMPUTE_PIPELINE = DRIVER_RESOURCE_COMPUTE_PIPELINE,929DRIVER_RESOURCE_VULKAN_RENDER_PIPELINE = DRIVER_RESOURCE_RENDER_PIPELINE,930#endif931};932933enum Limit {934LIMIT_MAX_BOUND_UNIFORM_SETS,935LIMIT_MAX_FRAMEBUFFER_COLOR_ATTACHMENTS,936LIMIT_MAX_TEXTURES_PER_UNIFORM_SET,937LIMIT_MAX_SAMPLERS_PER_UNIFORM_SET,938LIMIT_MAX_STORAGE_BUFFERS_PER_UNIFORM_SET,939LIMIT_MAX_STORAGE_IMAGES_PER_UNIFORM_SET,940LIMIT_MAX_UNIFORM_BUFFERS_PER_UNIFORM_SET,941LIMIT_MAX_DRAW_INDEXED_INDEX,942LIMIT_MAX_FRAMEBUFFER_HEIGHT,943LIMIT_MAX_FRAMEBUFFER_WIDTH,944LIMIT_MAX_TEXTURE_ARRAY_LAYERS,945LIMIT_MAX_TEXTURE_SIZE_1D,946LIMIT_MAX_TEXTURE_SIZE_2D,947LIMIT_MAX_TEXTURE_SIZE_3D,948LIMIT_MAX_TEXTURE_SIZE_CUBE,949LIMIT_MAX_TEXTURES_PER_SHADER_STAGE,950LIMIT_MAX_SAMPLERS_PER_SHADER_STAGE,951LIMIT_MAX_STORAGE_BUFFERS_PER_SHADER_STAGE,952LIMIT_MAX_STORAGE_IMAGES_PER_SHADER_STAGE,953LIMIT_MAX_UNIFORM_BUFFERS_PER_SHADER_STAGE,954LIMIT_MAX_PUSH_CONSTANT_SIZE,955LIMIT_MAX_UNIFORM_BUFFER_SIZE,956LIMIT_MAX_VERTEX_INPUT_ATTRIBUTE_OFFSET,957LIMIT_MAX_VERTEX_INPUT_ATTRIBUTES,958LIMIT_MAX_VERTEX_INPUT_BINDINGS,959LIMIT_MAX_VERTEX_INPUT_BINDING_STRIDE,960LIMIT_MIN_UNIFORM_BUFFER_OFFSET_ALIGNMENT,961LIMIT_MAX_COMPUTE_SHARED_MEMORY_SIZE,962LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_X,963LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Y,964LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Z,965LIMIT_MAX_COMPUTE_WORKGROUP_INVOCATIONS,966LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_X,967LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Y,968LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Z,969LIMIT_MAX_VIEWPORT_DIMENSIONS_X,970LIMIT_MAX_VIEWPORT_DIMENSIONS_Y,971LIMIT_SUBGROUP_SIZE,972LIMIT_SUBGROUP_MIN_SIZE,973LIMIT_SUBGROUP_MAX_SIZE,974LIMIT_SUBGROUP_IN_SHADERS, // Set flags using SHADER_STAGE_VERTEX_BIT, SHADER_STAGE_FRAGMENT_BIT, etc.975LIMIT_SUBGROUP_OPERATIONS,976LIMIT_METALFX_TEMPORAL_SCALER_MIN_SCALE = 46,977LIMIT_METALFX_TEMPORAL_SCALER_MAX_SCALE,978LIMIT_MAX_SHADER_VARYINGS,979};980981enum Features {982SUPPORTS_MULTIVIEW,983SUPPORTS_HALF_FLOAT,984SUPPORTS_ATTACHMENT_VRS,985SUPPORTS_METALFX_SPATIAL,986SUPPORTS_METALFX_TEMPORAL,987// If not supported, a fragment shader with only side effects (i.e., writes to buffers, but doesn't output to attachments), may be optimized down to no-op by the GPU driver.988SUPPORTS_FRAGMENT_SHADER_WITH_ONLY_SIDE_EFFECTS,989SUPPORTS_BUFFER_DEVICE_ADDRESS,990SUPPORTS_IMAGE_ATOMIC_32_BIT,991SUPPORTS_VULKAN_MEMORY_MODEL,992SUPPORTS_FRAMEBUFFER_DEPTH_RESOLVE,993SUPPORTS_POINT_SIZE,994SUPPORTS_RAY_QUERY,995SUPPORTS_RAYTRACING_PIPELINE,996};997998enum SubgroupOperations {999SUBGROUP_BASIC_BIT = 1,1000SUBGROUP_VOTE_BIT = 2,1001SUBGROUP_ARITHMETIC_BIT = 4,1002SUBGROUP_BALLOT_BIT = 8,1003SUBGROUP_SHUFFLE_BIT = 16,1004SUBGROUP_SHUFFLE_RELATIVE_BIT = 32,1005SUBGROUP_CLUSTERED_BIT = 64,1006SUBGROUP_QUAD_BIT = 128,1007};10081009////////////////////////////////////////////1010// PROTECTED STUFF1011// Not exposed by RenderingDevice, but shared1012// with RenderingDeviceDriver for convenience.1013////////////////////////////////////////////1014protected:1015/*****************/1016/**** GENERIC ****/1017/*****************/10181019static const char *const FORMAT_NAMES[DATA_FORMAT_MAX];10201021/*****************/1022/**** TEXTURE ****/1023/*****************/10241025static const uint32_t MAX_IMAGE_FORMAT_PLANES = 2;10261027static const uint32_t TEXTURE_SAMPLES_COUNT[TEXTURE_SAMPLES_MAX];10281029static void get_compressed_image_format_block_dimensions(DataFormat p_format, uint32_t &r_w, uint32_t &r_h);1030uint32_t get_compressed_image_format_block_byte_size(DataFormat p_format) const;1031static uint32_t get_compressed_image_format_pixel_rshift(DataFormat p_format);1032static uint32_t get_image_format_required_size(DataFormat p_format, uint32_t p_width, uint32_t p_height, uint32_t p_depth, uint32_t p_mipmaps, uint32_t *r_blockw = nullptr, uint32_t *r_blockh = nullptr, uint32_t *r_depth = nullptr);1033static uint32_t get_image_required_mipmaps(uint32_t p_width, uint32_t p_height, uint32_t p_depth);1034static bool format_has_depth(DataFormat p_format);1035static bool format_has_stencil(DataFormat p_format);1036static uint32_t format_get_plane_count(DataFormat p_format);10371038/*****************/1039/**** SAMPLER ****/1040/*****************/10411042static const Color SAMPLER_BORDER_COLOR_VALUE[SAMPLER_BORDER_COLOR_MAX];10431044/**********************/1045/**** VERTEX ARRAY ****/1046/**********************/10471048static uint32_t get_format_vertex_size(DataFormat p_format);10491050public:1051/*****************/1052/**** TEXTURE ****/1053/*****************/10541055static uint32_t get_image_format_pixel_size(DataFormat p_format);10561057/****************/1058/**** SHADER ****/1059/****************/10601061static const char *SHADER_STAGE_NAMES[SHADER_STAGE_MAX];10621063struct ShaderUniform {1064UniformType type = UniformType::UNIFORM_TYPE_MAX;1065bool writable = false;1066uint32_t binding = 0;1067BitField<ShaderStage> stages = {};1068uint32_t length = 0; // Size of arrays (in total elements), or ubos (in bytes * total elements).10691070bool operator!=(const ShaderUniform &p_other) const {1071return binding != p_other.binding || type != p_other.type || writable != p_other.writable || stages != p_other.stages || length != p_other.length;1072}10731074bool operator<(const ShaderUniform &p_other) const {1075if (binding != p_other.binding) {1076return binding < p_other.binding;1077}1078if (type != p_other.type) {1079return type < p_other.type;1080}1081if (writable != p_other.writable) {1082return writable < p_other.writable;1083}1084if (stages != p_other.stages) {1085return stages < p_other.stages;1086}1087if (length != p_other.length) {1088return length < p_other.length;1089}1090return false;1091}1092};10931094struct ShaderSpecializationConstant : public PipelineSpecializationConstant {1095BitField<ShaderStage> stages = {};10961097bool operator<(const ShaderSpecializationConstant &p_other) const { return constant_id < p_other.constant_id; }1098};10991100struct ShaderReflection {1101uint64_t vertex_input_mask = 0;1102uint32_t fragment_output_mask = 0;1103PipelineType pipeline_type = PIPELINE_TYPE_RASTERIZATION;1104bool has_multiview = false;1105bool has_dynamic_buffers = false;1106uint32_t compute_local_size[3] = {};1107uint32_t push_constant_size = 0;11081109Vector<Vector<ShaderUniform>> uniform_sets;1110Vector<ShaderSpecializationConstant> specialization_constants;1111Vector<ShaderStage> stages_vector;1112BitField<ShaderStage> stages_bits = {};1113BitField<ShaderStage> push_constant_stages = {};1114};1115};111611171118