Path: blob/master/servers/rendering/rendering_device_commons.h
10277 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#include <algorithm>3637#define STEPIFY(m_number, m_alignment) ((((m_number) + ((m_alignment) - 1)) / (m_alignment)) * (m_alignment))3839// This may one day be used in Godot for interoperability between C arrays, Vector and LocalVector.40// (See https://github.com/godotengine/godot-proposals/issues/5144.)41template <typename T>42class VectorView {43const T *_ptr = nullptr;44const uint32_t _size = 0;4546public:47const T &operator[](uint32_t p_index) {48DEV_ASSERT(p_index < _size);49return _ptr[p_index];50}5152_ALWAYS_INLINE_ const T *ptr() const { return _ptr; }53_ALWAYS_INLINE_ uint32_t size() const { return _size; }5455VectorView() = default;56VectorView(const T &p_ptr) :57// With this one you can pass a single element very conveniently!58_ptr(&p_ptr),59_size(1) {}60VectorView(const T *p_ptr, uint32_t p_size) :61_ptr(p_ptr), _size(p_size) {}62VectorView(const Vector<T> &p_lv) :63_ptr(p_lv.ptr()), _size(p_lv.size()) {}64VectorView(const LocalVector<T> &p_lv) :65_ptr(p_lv.ptr()), _size(p_lv.size()) {}66};6768class RenderingDeviceCommons : public Object {69////////////////////////////////////////////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_MAX_BIT = TEXTURE_USAGE_TRANSIENT_BIT,424};425426struct TextureFormat {427DataFormat format = DATA_FORMAT_R8_UNORM;428uint32_t width = 1;429uint32_t height = 1;430uint32_t depth = 1;431uint32_t array_layers = 1;432uint32_t mipmaps = 1;433TextureType texture_type = TEXTURE_TYPE_2D;434TextureSamples samples = TEXTURE_SAMPLES_1;435uint32_t usage_bits = 0;436Vector<DataFormat> shareable_formats;437bool is_resolve_buffer = false;438bool is_discardable = false;439440bool operator==(const TextureFormat &b) const {441if (format != b.format) {442return false;443} else if (width != b.width) {444return false;445} else if (height != b.height) {446return false;447} else if (depth != b.depth) {448return false;449} else if (array_layers != b.array_layers) {450return false;451} else if (mipmaps != b.mipmaps) {452return false;453} else if (texture_type != b.texture_type) {454return false;455} else if (samples != b.samples) {456return false;457} else if (usage_bits != b.usage_bits) {458return false;459} else if (shareable_formats != b.shareable_formats) {460return false;461} else if (is_resolve_buffer != b.is_resolve_buffer) {462return false;463} else if (is_discardable != b.is_discardable) {464return false;465} else {466return true;467}468}469};470471enum TextureSwizzle {472TEXTURE_SWIZZLE_IDENTITY,473TEXTURE_SWIZZLE_ZERO,474TEXTURE_SWIZZLE_ONE,475TEXTURE_SWIZZLE_R,476TEXTURE_SWIZZLE_G,477TEXTURE_SWIZZLE_B,478TEXTURE_SWIZZLE_A,479TEXTURE_SWIZZLE_MAX480};481482enum TextureSliceType {483TEXTURE_SLICE_2D,484TEXTURE_SLICE_CUBEMAP,485TEXTURE_SLICE_3D,486TEXTURE_SLICE_2D_ARRAY,487TEXTURE_SLICE_MAX488};489490/*****************/491/**** SAMPLER ****/492/*****************/493494enum SamplerFilter {495SAMPLER_FILTER_NEAREST,496SAMPLER_FILTER_LINEAR,497};498499enum SamplerRepeatMode {500SAMPLER_REPEAT_MODE_REPEAT,501SAMPLER_REPEAT_MODE_MIRRORED_REPEAT,502SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE,503SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER,504SAMPLER_REPEAT_MODE_MIRROR_CLAMP_TO_EDGE,505SAMPLER_REPEAT_MODE_MAX506};507508enum SamplerBorderColor {509SAMPLER_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK,510SAMPLER_BORDER_COLOR_INT_TRANSPARENT_BLACK,511SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_BLACK,512SAMPLER_BORDER_COLOR_INT_OPAQUE_BLACK,513SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_WHITE,514SAMPLER_BORDER_COLOR_INT_OPAQUE_WHITE,515SAMPLER_BORDER_COLOR_MAX516};517518struct SamplerState {519SamplerFilter mag_filter = SAMPLER_FILTER_NEAREST;520SamplerFilter min_filter = SAMPLER_FILTER_NEAREST;521SamplerFilter mip_filter = SAMPLER_FILTER_NEAREST;522SamplerRepeatMode repeat_u = SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE;523SamplerRepeatMode repeat_v = SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE;524SamplerRepeatMode repeat_w = SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE;525float lod_bias = 0.0f;526bool use_anisotropy = false;527float anisotropy_max = 1.0f;528bool enable_compare = false;529CompareOperator compare_op = COMPARE_OP_ALWAYS;530float min_lod = 0.0f;531float max_lod = 1e20; // Something very large should do.532SamplerBorderColor border_color = SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_BLACK;533bool unnormalized_uvw = false;534};535536/**********************/537/**** VERTEX ARRAY ****/538/**********************/539540enum IndexBufferFormat {541INDEX_BUFFER_FORMAT_UINT16,542INDEX_BUFFER_FORMAT_UINT32,543};544545enum VertexFrequency {546VERTEX_FREQUENCY_VERTEX,547VERTEX_FREQUENCY_INSTANCE,548};549550struct VertexAttribute {551uint32_t location = 0; // Shader location.552uint32_t offset = 0;553DataFormat format = DATA_FORMAT_MAX;554uint32_t stride = 0;555VertexFrequency frequency = VERTEX_FREQUENCY_VERTEX;556};557558/*********************/559/**** FRAMEBUFFER ****/560/*********************/561562static const int32_t ATTACHMENT_UNUSED = -1;563564/****************/565/**** SHADER ****/566/****************/567568enum ShaderStage {569SHADER_STAGE_VERTEX,570SHADER_STAGE_FRAGMENT,571SHADER_STAGE_TESSELATION_CONTROL,572SHADER_STAGE_TESSELATION_EVALUATION,573SHADER_STAGE_COMPUTE,574SHADER_STAGE_MAX,575SHADER_STAGE_VERTEX_BIT = (1 << SHADER_STAGE_VERTEX),576SHADER_STAGE_FRAGMENT_BIT = (1 << SHADER_STAGE_FRAGMENT),577SHADER_STAGE_TESSELATION_CONTROL_BIT = (1 << SHADER_STAGE_TESSELATION_CONTROL),578SHADER_STAGE_TESSELATION_EVALUATION_BIT = (1 << SHADER_STAGE_TESSELATION_EVALUATION),579SHADER_STAGE_COMPUTE_BIT = (1 << SHADER_STAGE_COMPUTE),580};581582enum ShaderLanguage {583SHADER_LANGUAGE_GLSL,584SHADER_LANGUAGE_HLSL,585};586587enum ShaderLanguageVersion {588SHADER_LANGUAGE_VULKAN_VERSION_1_0 = (1 << 22),589SHADER_LANGUAGE_VULKAN_VERSION_1_1 = (1 << 22) | (1 << 12),590SHADER_LANGUAGE_VULKAN_VERSION_1_2 = (1 << 22) | (2 << 12),591SHADER_LANGUAGE_VULKAN_VERSION_1_3 = (1 << 22) | (3 << 12),592SHADER_LANGUAGE_VULKAN_VERSION_1_4 = (1 << 22) | (4 << 12),593SHADER_LANGUAGE_OPENGL_VERSION_4_5_0 = 450,594};595596enum ShaderSpirvVersion {597SHADER_SPIRV_VERSION_1_0 = (1 << 16),598SHADER_SPIRV_VERSION_1_1 = (1 << 16) | (1 << 8),599SHADER_SPIRV_VERSION_1_2 = (1 << 16) | (2 << 8),600SHADER_SPIRV_VERSION_1_3 = (1 << 16) | (3 << 8),601SHADER_SPIRV_VERSION_1_4 = (1 << 16) | (4 << 8),602SHADER_SPIRV_VERSION_1_5 = (1 << 16) | (5 << 8),603SHADER_SPIRV_VERSION_1_6 = (1 << 16) | (6 << 8),604};605606struct ShaderStageSPIRVData {607ShaderStage shader_stage = SHADER_STAGE_MAX;608Vector<uint8_t> spirv;609};610611/*********************/612/**** UNIFORM SET ****/613/*********************/614615static const uint32_t MAX_UNIFORM_SETS = 16;616617enum UniformType {618UNIFORM_TYPE_SAMPLER, // For sampling only (sampler GLSL type).619UNIFORM_TYPE_SAMPLER_WITH_TEXTURE, // For sampling only, but includes a texture, (samplerXX GLSL type), first a sampler then a texture.620UNIFORM_TYPE_TEXTURE, // Only texture, (textureXX GLSL type).621UNIFORM_TYPE_IMAGE, // Storage image (imageXX GLSL type), for compute mostly.622UNIFORM_TYPE_TEXTURE_BUFFER, // Buffer texture (or TBO, textureBuffer type).623UNIFORM_TYPE_SAMPLER_WITH_TEXTURE_BUFFER, // Buffer texture with a sampler(or TBO, samplerBuffer type).624UNIFORM_TYPE_IMAGE_BUFFER, // Texel buffer, (imageBuffer type), for compute mostly.625UNIFORM_TYPE_UNIFORM_BUFFER, // Regular uniform buffer (or UBO).626UNIFORM_TYPE_STORAGE_BUFFER, // Storage buffer ("buffer" qualifier) like UBO, but supports storage, for compute mostly.627UNIFORM_TYPE_INPUT_ATTACHMENT, // Used for sub-pass read/write, for mobile mostly.628UNIFORM_TYPE_MAX629};630631/******************/632/**** PIPELINE ****/633/******************/634635enum PipelineSpecializationConstantType {636PIPELINE_SPECIALIZATION_CONSTANT_TYPE_BOOL,637PIPELINE_SPECIALIZATION_CONSTANT_TYPE_INT,638PIPELINE_SPECIALIZATION_CONSTANT_TYPE_FLOAT,639};640641struct PipelineSpecializationConstant {642PipelineSpecializationConstantType type = {};643uint32_t constant_id = 0xffffffff;644union {645uint32_t int_value = 0;646float float_value;647bool bool_value;648};649};650651/*******************/652/**** RENDERING ****/653/*******************/654655// ----- PIPELINE -----656657enum RenderPrimitive {658RENDER_PRIMITIVE_POINTS,659RENDER_PRIMITIVE_LINES,660RENDER_PRIMITIVE_LINES_WITH_ADJACENCY,661RENDER_PRIMITIVE_LINESTRIPS,662RENDER_PRIMITIVE_LINESTRIPS_WITH_ADJACENCY,663RENDER_PRIMITIVE_TRIANGLES,664RENDER_PRIMITIVE_TRIANGLES_WITH_ADJACENCY,665RENDER_PRIMITIVE_TRIANGLE_STRIPS,666RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_AJACENCY, // TODO: Fix typo in "ADJACENCY" (in 5.0).667RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_RESTART_INDEX,668RENDER_PRIMITIVE_TESSELATION_PATCH,669RENDER_PRIMITIVE_MAX670};671672enum PolygonCullMode {673POLYGON_CULL_DISABLED,674POLYGON_CULL_FRONT,675POLYGON_CULL_BACK,676POLYGON_CULL_MAX677};678679enum PolygonFrontFace {680POLYGON_FRONT_FACE_CLOCKWISE,681POLYGON_FRONT_FACE_COUNTER_CLOCKWISE,682};683684enum StencilOperation {685STENCIL_OP_KEEP,686STENCIL_OP_ZERO,687STENCIL_OP_REPLACE,688STENCIL_OP_INCREMENT_AND_CLAMP,689STENCIL_OP_DECREMENT_AND_CLAMP,690STENCIL_OP_INVERT,691STENCIL_OP_INCREMENT_AND_WRAP,692STENCIL_OP_DECREMENT_AND_WRAP,693STENCIL_OP_MAX694};695696enum LogicOperation {697LOGIC_OP_CLEAR,698LOGIC_OP_AND,699LOGIC_OP_AND_REVERSE,700LOGIC_OP_COPY,701LOGIC_OP_AND_INVERTED,702LOGIC_OP_NO_OP,703LOGIC_OP_XOR,704LOGIC_OP_OR,705LOGIC_OP_NOR,706LOGIC_OP_EQUIVALENT,707LOGIC_OP_INVERT,708LOGIC_OP_OR_REVERSE,709LOGIC_OP_COPY_INVERTED,710LOGIC_OP_OR_INVERTED,711LOGIC_OP_NAND,712LOGIC_OP_SET,713LOGIC_OP_MAX714};715716enum BlendFactor {717BLEND_FACTOR_ZERO,718BLEND_FACTOR_ONE,719BLEND_FACTOR_SRC_COLOR,720BLEND_FACTOR_ONE_MINUS_SRC_COLOR,721BLEND_FACTOR_DST_COLOR,722BLEND_FACTOR_ONE_MINUS_DST_COLOR,723BLEND_FACTOR_SRC_ALPHA,724BLEND_FACTOR_ONE_MINUS_SRC_ALPHA,725BLEND_FACTOR_DST_ALPHA,726BLEND_FACTOR_ONE_MINUS_DST_ALPHA,727BLEND_FACTOR_CONSTANT_COLOR,728BLEND_FACTOR_ONE_MINUS_CONSTANT_COLOR,729BLEND_FACTOR_CONSTANT_ALPHA,730BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA,731BLEND_FACTOR_SRC_ALPHA_SATURATE,732BLEND_FACTOR_SRC1_COLOR,733BLEND_FACTOR_ONE_MINUS_SRC1_COLOR,734BLEND_FACTOR_SRC1_ALPHA,735BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA,736BLEND_FACTOR_MAX737};738739enum BlendOperation {740BLEND_OP_ADD,741BLEND_OP_SUBTRACT,742BLEND_OP_REVERSE_SUBTRACT,743BLEND_OP_MINIMUM,744BLEND_OP_MAXIMUM, // Yes, this one is an actual operator.745BLEND_OP_MAX746};747748struct PipelineRasterizationState {749bool enable_depth_clamp = false;750bool discard_primitives = false;751bool wireframe = false;752PolygonCullMode cull_mode = POLYGON_CULL_DISABLED;753PolygonFrontFace front_face = POLYGON_FRONT_FACE_CLOCKWISE;754bool depth_bias_enabled = false;755float depth_bias_constant_factor = 0.0f;756float depth_bias_clamp = 0.0f;757float depth_bias_slope_factor = 0.0f;758float line_width = 1.0f;759uint32_t patch_control_points = 1;760};761762struct PipelineMultisampleState {763TextureSamples sample_count = TEXTURE_SAMPLES_1;764bool enable_sample_shading = false;765float min_sample_shading = 0.0f;766Vector<uint32_t> sample_mask;767bool enable_alpha_to_coverage = false;768bool enable_alpha_to_one = false;769};770771struct PipelineDepthStencilState {772bool enable_depth_test = false;773bool enable_depth_write = false;774CompareOperator depth_compare_operator = COMPARE_OP_ALWAYS;775bool enable_depth_range = false;776float depth_range_min = 0;777float depth_range_max = 0;778bool enable_stencil = false;779780struct StencilOperationState {781StencilOperation fail = STENCIL_OP_ZERO;782StencilOperation pass = STENCIL_OP_ZERO;783StencilOperation depth_fail = STENCIL_OP_ZERO;784CompareOperator compare = COMPARE_OP_ALWAYS;785uint32_t compare_mask = 0;786uint32_t write_mask = 0;787uint32_t reference = 0;788};789790StencilOperationState front_op;791StencilOperationState back_op;792};793794struct PipelineColorBlendState {795bool enable_logic_op = false;796LogicOperation logic_op = LOGIC_OP_CLEAR;797798struct Attachment {799bool enable_blend = false;800BlendFactor src_color_blend_factor = BLEND_FACTOR_ZERO;801BlendFactor dst_color_blend_factor = BLEND_FACTOR_ZERO;802BlendOperation color_blend_op = BLEND_OP_ADD;803BlendFactor src_alpha_blend_factor = BLEND_FACTOR_ZERO;804BlendFactor dst_alpha_blend_factor = BLEND_FACTOR_ZERO;805BlendOperation alpha_blend_op = BLEND_OP_ADD;806bool write_r = true;807bool write_g = true;808bool write_b = true;809bool write_a = true;810};811812static PipelineColorBlendState create_disabled(int p_attachments = 1) {813PipelineColorBlendState bs;814for (int i = 0; i < p_attachments; i++) {815bs.attachments.push_back(Attachment());816}817return bs;818}819820static PipelineColorBlendState create_blend(int p_attachments = 1) {821PipelineColorBlendState bs;822for (int i = 0; i < p_attachments; i++) {823Attachment ba;824ba.enable_blend = true;825ba.src_color_blend_factor = BLEND_FACTOR_SRC_ALPHA;826ba.dst_color_blend_factor = BLEND_FACTOR_ONE_MINUS_SRC_ALPHA;827ba.src_alpha_blend_factor = BLEND_FACTOR_SRC_ALPHA;828ba.dst_alpha_blend_factor = BLEND_FACTOR_ONE_MINUS_SRC_ALPHA;829830bs.attachments.push_back(ba);831}832return bs;833}834835Vector<Attachment> attachments; // One per render target texture.836Color blend_constant;837};838839enum PipelineDynamicStateFlags {840DYNAMIC_STATE_LINE_WIDTH = (1 << 0),841DYNAMIC_STATE_DEPTH_BIAS = (1 << 1),842DYNAMIC_STATE_BLEND_CONSTANTS = (1 << 2),843DYNAMIC_STATE_DEPTH_BOUNDS = (1 << 3),844DYNAMIC_STATE_STENCIL_COMPARE_MASK = (1 << 4),845DYNAMIC_STATE_STENCIL_WRITE_MASK = (1 << 5),846DYNAMIC_STATE_STENCIL_REFERENCE = (1 << 6),847};848849/**************/850/**** MISC ****/851/**************/852853// This enum matches VkPhysicalDeviceType (except for `DEVICE_TYPE_MAX`).854// Unlike VkPhysicalDeviceType, DeviceType is exposed to the scripting API.855enum DeviceType {856DEVICE_TYPE_OTHER,857DEVICE_TYPE_INTEGRATED_GPU,858DEVICE_TYPE_DISCRETE_GPU,859DEVICE_TYPE_VIRTUAL_GPU,860DEVICE_TYPE_CPU,861DEVICE_TYPE_MAX862};863864// Defined in an API-agnostic way.865// Some may not make sense for the underlying API; in that case, 0 is returned.866enum DriverResource {867DRIVER_RESOURCE_LOGICAL_DEVICE,868DRIVER_RESOURCE_PHYSICAL_DEVICE,869DRIVER_RESOURCE_TOPMOST_OBJECT,870DRIVER_RESOURCE_COMMAND_QUEUE,871DRIVER_RESOURCE_QUEUE_FAMILY,872DRIVER_RESOURCE_TEXTURE,873DRIVER_RESOURCE_TEXTURE_VIEW,874DRIVER_RESOURCE_TEXTURE_DATA_FORMAT,875DRIVER_RESOURCE_SAMPLER,876DRIVER_RESOURCE_UNIFORM_SET,877DRIVER_RESOURCE_BUFFER,878DRIVER_RESOURCE_COMPUTE_PIPELINE,879DRIVER_RESOURCE_RENDER_PIPELINE,880#ifndef DISABLE_DEPRECATED881DRIVER_RESOURCE_VULKAN_DEVICE = DRIVER_RESOURCE_LOGICAL_DEVICE,882DRIVER_RESOURCE_VULKAN_PHYSICAL_DEVICE = DRIVER_RESOURCE_PHYSICAL_DEVICE,883DRIVER_RESOURCE_VULKAN_INSTANCE = DRIVER_RESOURCE_TOPMOST_OBJECT,884DRIVER_RESOURCE_VULKAN_QUEUE = DRIVER_RESOURCE_COMMAND_QUEUE,885DRIVER_RESOURCE_VULKAN_QUEUE_FAMILY_INDEX = DRIVER_RESOURCE_QUEUE_FAMILY,886DRIVER_RESOURCE_VULKAN_IMAGE = DRIVER_RESOURCE_TEXTURE,887DRIVER_RESOURCE_VULKAN_IMAGE_VIEW = DRIVER_RESOURCE_TEXTURE_VIEW,888DRIVER_RESOURCE_VULKAN_IMAGE_NATIVE_TEXTURE_FORMAT = DRIVER_RESOURCE_TEXTURE_DATA_FORMAT,889DRIVER_RESOURCE_VULKAN_SAMPLER = DRIVER_RESOURCE_SAMPLER,890DRIVER_RESOURCE_VULKAN_DESCRIPTOR_SET = DRIVER_RESOURCE_UNIFORM_SET,891DRIVER_RESOURCE_VULKAN_BUFFER = DRIVER_RESOURCE_BUFFER,892DRIVER_RESOURCE_VULKAN_COMPUTE_PIPELINE = DRIVER_RESOURCE_COMPUTE_PIPELINE,893DRIVER_RESOURCE_VULKAN_RENDER_PIPELINE = DRIVER_RESOURCE_RENDER_PIPELINE,894#endif895};896897enum Limit {898LIMIT_MAX_BOUND_UNIFORM_SETS,899LIMIT_MAX_FRAMEBUFFER_COLOR_ATTACHMENTS,900LIMIT_MAX_TEXTURES_PER_UNIFORM_SET,901LIMIT_MAX_SAMPLERS_PER_UNIFORM_SET,902LIMIT_MAX_STORAGE_BUFFERS_PER_UNIFORM_SET,903LIMIT_MAX_STORAGE_IMAGES_PER_UNIFORM_SET,904LIMIT_MAX_UNIFORM_BUFFERS_PER_UNIFORM_SET,905LIMIT_MAX_DRAW_INDEXED_INDEX,906LIMIT_MAX_FRAMEBUFFER_HEIGHT,907LIMIT_MAX_FRAMEBUFFER_WIDTH,908LIMIT_MAX_TEXTURE_ARRAY_LAYERS,909LIMIT_MAX_TEXTURE_SIZE_1D,910LIMIT_MAX_TEXTURE_SIZE_2D,911LIMIT_MAX_TEXTURE_SIZE_3D,912LIMIT_MAX_TEXTURE_SIZE_CUBE,913LIMIT_MAX_TEXTURES_PER_SHADER_STAGE,914LIMIT_MAX_SAMPLERS_PER_SHADER_STAGE,915LIMIT_MAX_STORAGE_BUFFERS_PER_SHADER_STAGE,916LIMIT_MAX_STORAGE_IMAGES_PER_SHADER_STAGE,917LIMIT_MAX_UNIFORM_BUFFERS_PER_SHADER_STAGE,918LIMIT_MAX_PUSH_CONSTANT_SIZE,919LIMIT_MAX_UNIFORM_BUFFER_SIZE,920LIMIT_MAX_VERTEX_INPUT_ATTRIBUTE_OFFSET,921LIMIT_MAX_VERTEX_INPUT_ATTRIBUTES,922LIMIT_MAX_VERTEX_INPUT_BINDINGS,923LIMIT_MAX_VERTEX_INPUT_BINDING_STRIDE,924LIMIT_MIN_UNIFORM_BUFFER_OFFSET_ALIGNMENT,925LIMIT_MAX_COMPUTE_SHARED_MEMORY_SIZE,926LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_X,927LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Y,928LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Z,929LIMIT_MAX_COMPUTE_WORKGROUP_INVOCATIONS,930LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_X,931LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Y,932LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Z,933LIMIT_MAX_VIEWPORT_DIMENSIONS_X,934LIMIT_MAX_VIEWPORT_DIMENSIONS_Y,935LIMIT_SUBGROUP_SIZE,936LIMIT_SUBGROUP_MIN_SIZE,937LIMIT_SUBGROUP_MAX_SIZE,938LIMIT_SUBGROUP_IN_SHADERS, // Set flags using SHADER_STAGE_VERTEX_BIT, SHADER_STAGE_FRAGMENT_BIT, etc.939LIMIT_SUBGROUP_OPERATIONS,940LIMIT_METALFX_TEMPORAL_SCALER_MIN_SCALE = 46,941LIMIT_METALFX_TEMPORAL_SCALER_MAX_SCALE,942LIMIT_MAX_SHADER_VARYINGS,943};944945enum Features {946SUPPORTS_MULTIVIEW,947SUPPORTS_HALF_FLOAT,948SUPPORTS_ATTACHMENT_VRS,949SUPPORTS_METALFX_SPATIAL,950SUPPORTS_METALFX_TEMPORAL,951// 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.952SUPPORTS_FRAGMENT_SHADER_WITH_ONLY_SIDE_EFFECTS,953SUPPORTS_BUFFER_DEVICE_ADDRESS,954SUPPORTS_IMAGE_ATOMIC_32_BIT,955SUPPORTS_VULKAN_MEMORY_MODEL,956};957958enum SubgroupOperations {959SUBGROUP_BASIC_BIT = 1,960SUBGROUP_VOTE_BIT = 2,961SUBGROUP_ARITHMETIC_BIT = 4,962SUBGROUP_BALLOT_BIT = 8,963SUBGROUP_SHUFFLE_BIT = 16,964SUBGROUP_SHUFFLE_RELATIVE_BIT = 32,965SUBGROUP_CLUSTERED_BIT = 64,966SUBGROUP_QUAD_BIT = 128,967};968969////////////////////////////////////////////970// PROTECTED STUFF971// Not exposed by RenderingDevice, but shared972// with RenderingDeviceDriver for convenience.973////////////////////////////////////////////974protected:975/*****************/976/**** GENERIC ****/977/*****************/978979static const char *const FORMAT_NAMES[DATA_FORMAT_MAX];980981/*****************/982/**** TEXTURE ****/983/*****************/984985static const uint32_t MAX_IMAGE_FORMAT_PLANES = 2;986987static const uint32_t TEXTURE_SAMPLES_COUNT[TEXTURE_SAMPLES_MAX];988989static void get_compressed_image_format_block_dimensions(DataFormat p_format, uint32_t &r_w, uint32_t &r_h);990uint32_t get_compressed_image_format_block_byte_size(DataFormat p_format) const;991static uint32_t get_compressed_image_format_pixel_rshift(DataFormat p_format);992static 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);993static uint32_t get_image_required_mipmaps(uint32_t p_width, uint32_t p_height, uint32_t p_depth);994static bool format_has_stencil(DataFormat p_format);995static uint32_t format_get_plane_count(DataFormat p_format);996997/*****************/998/**** SAMPLER ****/999/*****************/10001001static const Color SAMPLER_BORDER_COLOR_VALUE[SAMPLER_BORDER_COLOR_MAX];10021003/**********************/1004/**** VERTEX ARRAY ****/1005/**********************/10061007static uint32_t get_format_vertex_size(DataFormat p_format);10081009public:1010/*****************/1011/**** TEXTURE ****/1012/*****************/10131014static uint32_t get_image_format_pixel_size(DataFormat p_format);10151016/****************/1017/**** SHADER ****/1018/****************/10191020static const char *SHADER_STAGE_NAMES[SHADER_STAGE_MAX];10211022struct ShaderUniform {1023UniformType type = UniformType::UNIFORM_TYPE_MAX;1024bool writable = false;1025uint32_t binding = 0;1026BitField<ShaderStage> stages = {};1027uint32_t length = 0; // Size of arrays (in total elements), or ubos (in bytes * total elements).10281029bool operator!=(const ShaderUniform &p_other) const {1030return binding != p_other.binding || type != p_other.type || writable != p_other.writable || stages != p_other.stages || length != p_other.length;1031}10321033bool operator<(const ShaderUniform &p_other) const {1034if (binding != p_other.binding) {1035return binding < p_other.binding;1036}1037if (type != p_other.type) {1038return type < p_other.type;1039}1040if (writable != p_other.writable) {1041return writable < p_other.writable;1042}1043if (stages != p_other.stages) {1044return stages < p_other.stages;1045}1046if (length != p_other.length) {1047return length < p_other.length;1048}1049return false;1050}1051};10521053struct ShaderSpecializationConstant : public PipelineSpecializationConstant {1054BitField<ShaderStage> stages = {};10551056bool operator<(const ShaderSpecializationConstant &p_other) const { return constant_id < p_other.constant_id; }1057};10581059struct ShaderReflection {1060uint64_t vertex_input_mask = 0;1061uint32_t fragment_output_mask = 0;1062bool is_compute = false;1063bool has_multiview = false;1064uint32_t compute_local_size[3] = {};1065uint32_t push_constant_size = 0;10661067Vector<Vector<ShaderUniform>> uniform_sets;1068Vector<ShaderSpecializationConstant> specialization_constants;1069Vector<ShaderStage> stages_vector;1070BitField<ShaderStage> stages_bits = {};1071BitField<ShaderStage> push_constant_stages = {};1072};10731074static Error reflect_spirv(VectorView<ShaderStageSPIRVData> p_spirv, ShaderReflection &r_reflection);1075};107610771078