Path: blob/master/servers/rendering/rendering_device_commons.h
11352 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 {69GDSOFTCLASS(RenderingDeviceCommons, Object);7071////////////////////////////////////////////72// PUBLIC STUFF73// Exposed by RenderingDevice, and shared74// with RenderingDeviceDriver.75////////////////////////////////////////////76public:77static const bool command_pool_reset_enabled = true;7879/*****************/80/**** GENERIC ****/81/*****************/8283static const int INVALID_ID = -1;8485enum DataFormat {86DATA_FORMAT_R4G4_UNORM_PACK8,87DATA_FORMAT_R4G4B4A4_UNORM_PACK16,88DATA_FORMAT_B4G4R4A4_UNORM_PACK16,89DATA_FORMAT_R5G6B5_UNORM_PACK16,90DATA_FORMAT_B5G6R5_UNORM_PACK16,91DATA_FORMAT_R5G5B5A1_UNORM_PACK16,92DATA_FORMAT_B5G5R5A1_UNORM_PACK16,93DATA_FORMAT_A1R5G5B5_UNORM_PACK16,94DATA_FORMAT_R8_UNORM,95DATA_FORMAT_R8_SNORM,96DATA_FORMAT_R8_USCALED,97DATA_FORMAT_R8_SSCALED,98DATA_FORMAT_R8_UINT,99DATA_FORMAT_R8_SINT,100DATA_FORMAT_R8_SRGB,101DATA_FORMAT_R8G8_UNORM,102DATA_FORMAT_R8G8_SNORM,103DATA_FORMAT_R8G8_USCALED,104DATA_FORMAT_R8G8_SSCALED,105DATA_FORMAT_R8G8_UINT,106DATA_FORMAT_R8G8_SINT,107DATA_FORMAT_R8G8_SRGB,108DATA_FORMAT_R8G8B8_UNORM,109DATA_FORMAT_R8G8B8_SNORM,110DATA_FORMAT_R8G8B8_USCALED,111DATA_FORMAT_R8G8B8_SSCALED,112DATA_FORMAT_R8G8B8_UINT,113DATA_FORMAT_R8G8B8_SINT,114DATA_FORMAT_R8G8B8_SRGB,115DATA_FORMAT_B8G8R8_UNORM,116DATA_FORMAT_B8G8R8_SNORM,117DATA_FORMAT_B8G8R8_USCALED,118DATA_FORMAT_B8G8R8_SSCALED,119DATA_FORMAT_B8G8R8_UINT,120DATA_FORMAT_B8G8R8_SINT,121DATA_FORMAT_B8G8R8_SRGB,122DATA_FORMAT_R8G8B8A8_UNORM,123DATA_FORMAT_R8G8B8A8_SNORM,124DATA_FORMAT_R8G8B8A8_USCALED,125DATA_FORMAT_R8G8B8A8_SSCALED,126DATA_FORMAT_R8G8B8A8_UINT,127DATA_FORMAT_R8G8B8A8_SINT,128DATA_FORMAT_R8G8B8A8_SRGB,129DATA_FORMAT_B8G8R8A8_UNORM,130DATA_FORMAT_B8G8R8A8_SNORM,131DATA_FORMAT_B8G8R8A8_USCALED,132DATA_FORMAT_B8G8R8A8_SSCALED,133DATA_FORMAT_B8G8R8A8_UINT,134DATA_FORMAT_B8G8R8A8_SINT,135DATA_FORMAT_B8G8R8A8_SRGB,136DATA_FORMAT_A8B8G8R8_UNORM_PACK32,137DATA_FORMAT_A8B8G8R8_SNORM_PACK32,138DATA_FORMAT_A8B8G8R8_USCALED_PACK32,139DATA_FORMAT_A8B8G8R8_SSCALED_PACK32,140DATA_FORMAT_A8B8G8R8_UINT_PACK32,141DATA_FORMAT_A8B8G8R8_SINT_PACK32,142DATA_FORMAT_A8B8G8R8_SRGB_PACK32,143DATA_FORMAT_A2R10G10B10_UNORM_PACK32,144DATA_FORMAT_A2R10G10B10_SNORM_PACK32,145DATA_FORMAT_A2R10G10B10_USCALED_PACK32,146DATA_FORMAT_A2R10G10B10_SSCALED_PACK32,147DATA_FORMAT_A2R10G10B10_UINT_PACK32,148DATA_FORMAT_A2R10G10B10_SINT_PACK32,149DATA_FORMAT_A2B10G10R10_UNORM_PACK32,150DATA_FORMAT_A2B10G10R10_SNORM_PACK32,151DATA_FORMAT_A2B10G10R10_USCALED_PACK32,152DATA_FORMAT_A2B10G10R10_SSCALED_PACK32,153DATA_FORMAT_A2B10G10R10_UINT_PACK32,154DATA_FORMAT_A2B10G10R10_SINT_PACK32,155DATA_FORMAT_R16_UNORM,156DATA_FORMAT_R16_SNORM,157DATA_FORMAT_R16_USCALED,158DATA_FORMAT_R16_SSCALED,159DATA_FORMAT_R16_UINT,160DATA_FORMAT_R16_SINT,161DATA_FORMAT_R16_SFLOAT,162DATA_FORMAT_R16G16_UNORM,163DATA_FORMAT_R16G16_SNORM,164DATA_FORMAT_R16G16_USCALED,165DATA_FORMAT_R16G16_SSCALED,166DATA_FORMAT_R16G16_UINT,167DATA_FORMAT_R16G16_SINT,168DATA_FORMAT_R16G16_SFLOAT,169DATA_FORMAT_R16G16B16_UNORM,170DATA_FORMAT_R16G16B16_SNORM,171DATA_FORMAT_R16G16B16_USCALED,172DATA_FORMAT_R16G16B16_SSCALED,173DATA_FORMAT_R16G16B16_UINT,174DATA_FORMAT_R16G16B16_SINT,175DATA_FORMAT_R16G16B16_SFLOAT,176DATA_FORMAT_R16G16B16A16_UNORM,177DATA_FORMAT_R16G16B16A16_SNORM,178DATA_FORMAT_R16G16B16A16_USCALED,179DATA_FORMAT_R16G16B16A16_SSCALED,180DATA_FORMAT_R16G16B16A16_UINT,181DATA_FORMAT_R16G16B16A16_SINT,182DATA_FORMAT_R16G16B16A16_SFLOAT,183DATA_FORMAT_R32_UINT,184DATA_FORMAT_R32_SINT,185DATA_FORMAT_R32_SFLOAT,186DATA_FORMAT_R32G32_UINT,187DATA_FORMAT_R32G32_SINT,188DATA_FORMAT_R32G32_SFLOAT,189DATA_FORMAT_R32G32B32_UINT,190DATA_FORMAT_R32G32B32_SINT,191DATA_FORMAT_R32G32B32_SFLOAT,192DATA_FORMAT_R32G32B32A32_UINT,193DATA_FORMAT_R32G32B32A32_SINT,194DATA_FORMAT_R32G32B32A32_SFLOAT,195DATA_FORMAT_R64_UINT,196DATA_FORMAT_R64_SINT,197DATA_FORMAT_R64_SFLOAT,198DATA_FORMAT_R64G64_UINT,199DATA_FORMAT_R64G64_SINT,200DATA_FORMAT_R64G64_SFLOAT,201DATA_FORMAT_R64G64B64_UINT,202DATA_FORMAT_R64G64B64_SINT,203DATA_FORMAT_R64G64B64_SFLOAT,204DATA_FORMAT_R64G64B64A64_UINT,205DATA_FORMAT_R64G64B64A64_SINT,206DATA_FORMAT_R64G64B64A64_SFLOAT,207DATA_FORMAT_B10G11R11_UFLOAT_PACK32,208DATA_FORMAT_E5B9G9R9_UFLOAT_PACK32,209DATA_FORMAT_D16_UNORM,210DATA_FORMAT_X8_D24_UNORM_PACK32,211DATA_FORMAT_D32_SFLOAT,212DATA_FORMAT_S8_UINT,213DATA_FORMAT_D16_UNORM_S8_UINT,214DATA_FORMAT_D24_UNORM_S8_UINT,215DATA_FORMAT_D32_SFLOAT_S8_UINT,216DATA_FORMAT_BC1_RGB_UNORM_BLOCK,217DATA_FORMAT_BC1_RGB_SRGB_BLOCK,218DATA_FORMAT_BC1_RGBA_UNORM_BLOCK,219DATA_FORMAT_BC1_RGBA_SRGB_BLOCK,220DATA_FORMAT_BC2_UNORM_BLOCK,221DATA_FORMAT_BC2_SRGB_BLOCK,222DATA_FORMAT_BC3_UNORM_BLOCK,223DATA_FORMAT_BC3_SRGB_BLOCK,224DATA_FORMAT_BC4_UNORM_BLOCK,225DATA_FORMAT_BC4_SNORM_BLOCK,226DATA_FORMAT_BC5_UNORM_BLOCK,227DATA_FORMAT_BC5_SNORM_BLOCK,228DATA_FORMAT_BC6H_UFLOAT_BLOCK,229DATA_FORMAT_BC6H_SFLOAT_BLOCK,230DATA_FORMAT_BC7_UNORM_BLOCK,231DATA_FORMAT_BC7_SRGB_BLOCK,232DATA_FORMAT_ETC2_R8G8B8_UNORM_BLOCK,233DATA_FORMAT_ETC2_R8G8B8_SRGB_BLOCK,234DATA_FORMAT_ETC2_R8G8B8A1_UNORM_BLOCK,235DATA_FORMAT_ETC2_R8G8B8A1_SRGB_BLOCK,236DATA_FORMAT_ETC2_R8G8B8A8_UNORM_BLOCK,237DATA_FORMAT_ETC2_R8G8B8A8_SRGB_BLOCK,238DATA_FORMAT_EAC_R11_UNORM_BLOCK,239DATA_FORMAT_EAC_R11_SNORM_BLOCK,240DATA_FORMAT_EAC_R11G11_UNORM_BLOCK,241DATA_FORMAT_EAC_R11G11_SNORM_BLOCK,242DATA_FORMAT_ASTC_4x4_UNORM_BLOCK,243DATA_FORMAT_ASTC_4x4_SRGB_BLOCK,244DATA_FORMAT_ASTC_5x4_UNORM_BLOCK,245DATA_FORMAT_ASTC_5x4_SRGB_BLOCK,246DATA_FORMAT_ASTC_5x5_UNORM_BLOCK,247DATA_FORMAT_ASTC_5x5_SRGB_BLOCK,248DATA_FORMAT_ASTC_6x5_UNORM_BLOCK,249DATA_FORMAT_ASTC_6x5_SRGB_BLOCK,250DATA_FORMAT_ASTC_6x6_UNORM_BLOCK,251DATA_FORMAT_ASTC_6x6_SRGB_BLOCK,252DATA_FORMAT_ASTC_8x5_UNORM_BLOCK,253DATA_FORMAT_ASTC_8x5_SRGB_BLOCK,254DATA_FORMAT_ASTC_8x6_UNORM_BLOCK,255DATA_FORMAT_ASTC_8x6_SRGB_BLOCK,256DATA_FORMAT_ASTC_8x8_UNORM_BLOCK,257DATA_FORMAT_ASTC_8x8_SRGB_BLOCK,258DATA_FORMAT_ASTC_10x5_UNORM_BLOCK,259DATA_FORMAT_ASTC_10x5_SRGB_BLOCK,260DATA_FORMAT_ASTC_10x6_UNORM_BLOCK,261DATA_FORMAT_ASTC_10x6_SRGB_BLOCK,262DATA_FORMAT_ASTC_10x8_UNORM_BLOCK,263DATA_FORMAT_ASTC_10x8_SRGB_BLOCK,264DATA_FORMAT_ASTC_10x10_UNORM_BLOCK,265DATA_FORMAT_ASTC_10x10_SRGB_BLOCK,266DATA_FORMAT_ASTC_12x10_UNORM_BLOCK,267DATA_FORMAT_ASTC_12x10_SRGB_BLOCK,268DATA_FORMAT_ASTC_12x12_UNORM_BLOCK,269DATA_FORMAT_ASTC_12x12_SRGB_BLOCK,270DATA_FORMAT_G8B8G8R8_422_UNORM,271DATA_FORMAT_B8G8R8G8_422_UNORM,272DATA_FORMAT_G8_B8_R8_3PLANE_420_UNORM,273DATA_FORMAT_G8_B8R8_2PLANE_420_UNORM,274DATA_FORMAT_G8_B8_R8_3PLANE_422_UNORM,275DATA_FORMAT_G8_B8R8_2PLANE_422_UNORM,276DATA_FORMAT_G8_B8_R8_3PLANE_444_UNORM,277DATA_FORMAT_R10X6_UNORM_PACK16,278DATA_FORMAT_R10X6G10X6_UNORM_2PACK16,279DATA_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16,280DATA_FORMAT_G10X6B10X6G10X6R10X6_422_UNORM_4PACK16,281DATA_FORMAT_B10X6G10X6R10X6G10X6_422_UNORM_4PACK16,282DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_420_UNORM_3PACK16,283DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16,284DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_422_UNORM_3PACK16,285DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_422_UNORM_3PACK16,286DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_444_UNORM_3PACK16,287DATA_FORMAT_R12X4_UNORM_PACK16,288DATA_FORMAT_R12X4G12X4_UNORM_2PACK16,289DATA_FORMAT_R12X4G12X4B12X4A12X4_UNORM_4PACK16,290DATA_FORMAT_G12X4B12X4G12X4R12X4_422_UNORM_4PACK16,291DATA_FORMAT_B12X4G12X4R12X4G12X4_422_UNORM_4PACK16,292DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_420_UNORM_3PACK16,293DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_420_UNORM_3PACK16,294DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_422_UNORM_3PACK16,295DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_422_UNORM_3PACK16,296DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_444_UNORM_3PACK16,297DATA_FORMAT_G16B16G16R16_422_UNORM,298DATA_FORMAT_B16G16R16G16_422_UNORM,299DATA_FORMAT_G16_B16_R16_3PLANE_420_UNORM,300DATA_FORMAT_G16_B16R16_2PLANE_420_UNORM,301DATA_FORMAT_G16_B16_R16_3PLANE_422_UNORM,302DATA_FORMAT_G16_B16R16_2PLANE_422_UNORM,303DATA_FORMAT_G16_B16_R16_3PLANE_444_UNORM,304DATA_FORMAT_ASTC_4x4_SFLOAT_BLOCK, // HDR variant.305DATA_FORMAT_ASTC_5x4_SFLOAT_BLOCK, // HDR variant.306DATA_FORMAT_ASTC_5x5_SFLOAT_BLOCK, // HDR variant.307DATA_FORMAT_ASTC_6x5_SFLOAT_BLOCK, // HDR variant.308DATA_FORMAT_ASTC_6x6_SFLOAT_BLOCK, // HDR variant.309DATA_FORMAT_ASTC_8x5_SFLOAT_BLOCK, // HDR variant.310DATA_FORMAT_ASTC_8x6_SFLOAT_BLOCK, // HDR variant.311DATA_FORMAT_ASTC_8x8_SFLOAT_BLOCK, // HDR variant.312DATA_FORMAT_ASTC_10x5_SFLOAT_BLOCK, // HDR variant.313DATA_FORMAT_ASTC_10x6_SFLOAT_BLOCK, // HDR variant.314DATA_FORMAT_ASTC_10x8_SFLOAT_BLOCK, // HDR variant.315DATA_FORMAT_ASTC_10x10_SFLOAT_BLOCK, // HDR variant.316DATA_FORMAT_ASTC_12x10_SFLOAT_BLOCK, // HDR variant.317DATA_FORMAT_ASTC_12x12_SFLOAT_BLOCK, // HDR variant.318DATA_FORMAT_MAX,319};320321// Breadcrumb markers are useful for debugging GPU crashes (i.e. DEVICE_LOST). Internally322// they're just an uint32_t to "tag" a GPU command. These are only used for debugging and do not323// (or at least shouldn't) alter the execution behavior in any way.324//325// When a GPU crashes and Godot was built in dev or debug mode; Godot will dump what commands326// were being executed and what tag they were marked with.327// This makes narrowing down the cause of a crash easier. Note that a GPU can be executing328// multiple commands at the same time. It is also useful to identify data hazards.329//330// For example if each LIGHTMAPPER_PASS must be executed in sequential order, but dumps331// indicated that pass (LIGHTMAPPER_PASS | 5) was being executed at the same time as332// (LIGHTMAPPER_PASS | 4), that would indicate there is a missing barrier or a render graph bug.333//334// The enums are bitshifted by 16 bits so it's possible to add user data via bitwise operations.335// Using this enum is not mandatory; but it is recommended so that all subsystems agree what each336// ID means when dumping info.337enum BreadcrumbMarker {338NONE = 0,339// Environment340REFLECTION_PROBES = 1u << 16u,341SKY_PASS = 2u << 16u,342// Light mapping343LIGHTMAPPER_PASS = 3u << 16u,344// Shadows345SHADOW_PASS_DIRECTIONAL = 4u << 16u,346SHADOW_PASS_CUBE = 5u << 16u,347// Geometry passes348OPAQUE_PASS = 6u << 16u,349ALPHA_PASS = 7u << 16u,350TRANSPARENT_PASS = 8u << 16u,351// Screen effects352POST_PROCESSING_PASS = 9u << 16u,353BLIT_PASS = 10u << 16u,354UI_PASS = 11u << 16u,355// Other356DEBUG_PASS = 12u << 16u,357};358359enum CompareOperator {360COMPARE_OP_NEVER,361COMPARE_OP_LESS,362COMPARE_OP_EQUAL,363COMPARE_OP_LESS_OR_EQUAL,364COMPARE_OP_GREATER,365COMPARE_OP_NOT_EQUAL,366COMPARE_OP_GREATER_OR_EQUAL,367COMPARE_OP_ALWAYS,368COMPARE_OP_MAX369};370371/*****************/372/**** TEXTURE ****/373/*****************/374375enum TextureType {376TEXTURE_TYPE_1D,377TEXTURE_TYPE_2D,378TEXTURE_TYPE_3D,379TEXTURE_TYPE_CUBE,380TEXTURE_TYPE_1D_ARRAY,381TEXTURE_TYPE_2D_ARRAY,382TEXTURE_TYPE_CUBE_ARRAY,383TEXTURE_TYPE_MAX,384};385386enum TextureSamples {387TEXTURE_SAMPLES_1,388TEXTURE_SAMPLES_2,389TEXTURE_SAMPLES_4,390TEXTURE_SAMPLES_8,391TEXTURE_SAMPLES_16,392TEXTURE_SAMPLES_32,393TEXTURE_SAMPLES_64,394TEXTURE_SAMPLES_MAX,395};396397enum TextureUsageBits {398TEXTURE_USAGE_SAMPLING_BIT = (1 << 0),399TEXTURE_USAGE_COLOR_ATTACHMENT_BIT = (1 << 1),400TEXTURE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT = (1 << 2),401TEXTURE_USAGE_STORAGE_BIT = (1 << 3),402TEXTURE_USAGE_STORAGE_ATOMIC_BIT = (1 << 4),403TEXTURE_USAGE_CPU_READ_BIT = (1 << 5),404TEXTURE_USAGE_CAN_UPDATE_BIT = (1 << 6),405TEXTURE_USAGE_CAN_COPY_FROM_BIT = (1 << 7),406TEXTURE_USAGE_CAN_COPY_TO_BIT = (1 << 8),407TEXTURE_USAGE_INPUT_ATTACHMENT_BIT = (1 << 9),408TEXTURE_USAGE_VRS_ATTACHMENT_BIT = (1 << 10),409// When set, the texture is not backed by actual memory. It only ever lives in the cache.410// This is particularly useful for:411// 1. Depth/stencil buffers that are not needed after producing the colour output.412// 2. MSAA surfaces that are immediately resolved (i.e. its raw content isn't needed).413//414// This flag heavily improves performance & saves memory on TBDR GPUs (e.g. mobile).415// On Desktop this flag won't save memory but it still instructs the render graph that data will416// be discarded aggressively which may still improve some performance.417//418// It is not valid to perform copies from/to this texture, since it doesn't occupy actual RAM.419// It is also not valid to sample from this texture except using subpasses or via read/write420// pixel shader extensions (e.g. VK_EXT_rasterization_order_attachment_access).421//422// Try to set this bit as much as possible. If you set it, validation doesn't complain423// and it works fine on mobile, then go ahead.424TEXTURE_USAGE_TRANSIENT_BIT = (1 << 11),425TEXTURE_USAGE_MAX_BIT = TEXTURE_USAGE_TRANSIENT_BIT,426};427428struct TextureFormat {429DataFormat format = DATA_FORMAT_R8_UNORM;430uint32_t width = 1;431uint32_t height = 1;432uint32_t depth = 1;433uint32_t array_layers = 1;434uint32_t mipmaps = 1;435TextureType texture_type = TEXTURE_TYPE_2D;436TextureSamples samples = TEXTURE_SAMPLES_1;437uint32_t usage_bits = 0;438Vector<DataFormat> shareable_formats;439bool is_resolve_buffer = false;440bool is_discardable = false;441442bool operator==(const TextureFormat &b) const {443if (format != b.format) {444return false;445} else if (width != b.width) {446return false;447} else if (height != b.height) {448return false;449} else if (depth != b.depth) {450return false;451} else if (array_layers != b.array_layers) {452return false;453} else if (mipmaps != b.mipmaps) {454return false;455} else if (texture_type != b.texture_type) {456return false;457} else if (samples != b.samples) {458return false;459} else if (usage_bits != b.usage_bits) {460return false;461} else if (shareable_formats != b.shareable_formats) {462return false;463} else if (is_resolve_buffer != b.is_resolve_buffer) {464return false;465} else if (is_discardable != b.is_discardable) {466return false;467} else {468return true;469}470}471};472473enum TextureSwizzle {474TEXTURE_SWIZZLE_IDENTITY,475TEXTURE_SWIZZLE_ZERO,476TEXTURE_SWIZZLE_ONE,477TEXTURE_SWIZZLE_R,478TEXTURE_SWIZZLE_G,479TEXTURE_SWIZZLE_B,480TEXTURE_SWIZZLE_A,481TEXTURE_SWIZZLE_MAX482};483484enum TextureSliceType {485TEXTURE_SLICE_2D,486TEXTURE_SLICE_CUBEMAP,487TEXTURE_SLICE_3D,488TEXTURE_SLICE_2D_ARRAY,489TEXTURE_SLICE_MAX490};491492/*****************/493/**** SAMPLER ****/494/*****************/495496enum SamplerFilter {497SAMPLER_FILTER_NEAREST,498SAMPLER_FILTER_LINEAR,499};500501enum SamplerRepeatMode {502SAMPLER_REPEAT_MODE_REPEAT,503SAMPLER_REPEAT_MODE_MIRRORED_REPEAT,504SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE,505SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER,506SAMPLER_REPEAT_MODE_MIRROR_CLAMP_TO_EDGE,507SAMPLER_REPEAT_MODE_MAX508};509510enum SamplerBorderColor {511SAMPLER_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK,512SAMPLER_BORDER_COLOR_INT_TRANSPARENT_BLACK,513SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_BLACK,514SAMPLER_BORDER_COLOR_INT_OPAQUE_BLACK,515SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_WHITE,516SAMPLER_BORDER_COLOR_INT_OPAQUE_WHITE,517SAMPLER_BORDER_COLOR_MAX518};519520struct SamplerState {521SamplerFilter mag_filter = SAMPLER_FILTER_NEAREST;522SamplerFilter min_filter = SAMPLER_FILTER_NEAREST;523SamplerFilter mip_filter = SAMPLER_FILTER_NEAREST;524SamplerRepeatMode repeat_u = SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE;525SamplerRepeatMode repeat_v = SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE;526SamplerRepeatMode repeat_w = SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE;527float lod_bias = 0.0f;528bool use_anisotropy = false;529float anisotropy_max = 1.0f;530bool enable_compare = false;531CompareOperator compare_op = COMPARE_OP_ALWAYS;532float min_lod = 0.0f;533float max_lod = 1e20; // Something very large should do.534SamplerBorderColor border_color = SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_BLACK;535bool unnormalized_uvw = false;536};537538/**********************/539/**** VERTEX ARRAY ****/540/**********************/541542enum IndexBufferFormat {543INDEX_BUFFER_FORMAT_UINT16,544INDEX_BUFFER_FORMAT_UINT32,545};546547enum VertexFrequency {548VERTEX_FREQUENCY_VERTEX,549VERTEX_FREQUENCY_INSTANCE,550};551552struct VertexAttribute {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};559560/*********************/561/**** FRAMEBUFFER ****/562/*********************/563564static const int32_t ATTACHMENT_UNUSED = -1;565566/****************/567/**** SHADER ****/568/****************/569570enum ShaderStage {571SHADER_STAGE_VERTEX,572SHADER_STAGE_FRAGMENT,573SHADER_STAGE_TESSELATION_CONTROL,574SHADER_STAGE_TESSELATION_EVALUATION,575SHADER_STAGE_COMPUTE,576SHADER_STAGE_MAX,577SHADER_STAGE_VERTEX_BIT = (1 << SHADER_STAGE_VERTEX),578SHADER_STAGE_FRAGMENT_BIT = (1 << SHADER_STAGE_FRAGMENT),579SHADER_STAGE_TESSELATION_CONTROL_BIT = (1 << SHADER_STAGE_TESSELATION_CONTROL),580SHADER_STAGE_TESSELATION_EVALUATION_BIT = (1 << SHADER_STAGE_TESSELATION_EVALUATION),581SHADER_STAGE_COMPUTE_BIT = (1 << SHADER_STAGE_COMPUTE),582};583584enum ShaderLanguage {585SHADER_LANGUAGE_GLSL,586SHADER_LANGUAGE_HLSL,587};588589enum ShaderLanguageVersion {590SHADER_LANGUAGE_VULKAN_VERSION_1_0 = (1 << 22),591SHADER_LANGUAGE_VULKAN_VERSION_1_1 = (1 << 22) | (1 << 12),592SHADER_LANGUAGE_VULKAN_VERSION_1_2 = (1 << 22) | (2 << 12),593SHADER_LANGUAGE_VULKAN_VERSION_1_3 = (1 << 22) | (3 << 12),594SHADER_LANGUAGE_VULKAN_VERSION_1_4 = (1 << 22) | (4 << 12),595SHADER_LANGUAGE_OPENGL_VERSION_4_5_0 = 450,596};597598enum ShaderSpirvVersion {599SHADER_SPIRV_VERSION_1_0 = (1 << 16),600SHADER_SPIRV_VERSION_1_1 = (1 << 16) | (1 << 8),601SHADER_SPIRV_VERSION_1_2 = (1 << 16) | (2 << 8),602SHADER_SPIRV_VERSION_1_3 = (1 << 16) | (3 << 8),603SHADER_SPIRV_VERSION_1_4 = (1 << 16) | (4 << 8),604SHADER_SPIRV_VERSION_1_5 = (1 << 16) | (5 << 8),605SHADER_SPIRV_VERSION_1_6 = (1 << 16) | (6 << 8),606};607608struct ShaderStageSPIRVData {609ShaderStage shader_stage = SHADER_STAGE_MAX;610Vector<uint8_t> spirv;611};612613/*********************/614/**** UNIFORM SET ****/615/*********************/616617static const uint32_t MAX_UNIFORM_SETS = 16;618619enum UniformType {620UNIFORM_TYPE_SAMPLER, // For sampling only (sampler GLSL type).621UNIFORM_TYPE_SAMPLER_WITH_TEXTURE, // For sampling only, but includes a texture, (samplerXX GLSL type), first a sampler then a texture.622UNIFORM_TYPE_TEXTURE, // Only texture, (textureXX GLSL type).623UNIFORM_TYPE_IMAGE, // Storage image (imageXX GLSL type), for compute mostly.624UNIFORM_TYPE_TEXTURE_BUFFER, // Buffer texture (or TBO, textureBuffer type).625UNIFORM_TYPE_SAMPLER_WITH_TEXTURE_BUFFER, // Buffer texture with a sampler(or TBO, samplerBuffer type).626UNIFORM_TYPE_IMAGE_BUFFER, // Texel buffer, (imageBuffer type), for compute mostly.627UNIFORM_TYPE_UNIFORM_BUFFER, // Regular uniform buffer (or UBO).628UNIFORM_TYPE_STORAGE_BUFFER, // Storage buffer ("buffer" qualifier) like UBO, but supports storage, for compute mostly.629UNIFORM_TYPE_INPUT_ATTACHMENT, // Used for sub-pass read/write, for mobile mostly.630UNIFORM_TYPE_MAX631};632633/******************/634/**** PIPELINE ****/635/******************/636637enum PipelineSpecializationConstantType {638PIPELINE_SPECIALIZATION_CONSTANT_TYPE_BOOL,639PIPELINE_SPECIALIZATION_CONSTANT_TYPE_INT,640PIPELINE_SPECIALIZATION_CONSTANT_TYPE_FLOAT,641};642643struct PipelineSpecializationConstant {644PipelineSpecializationConstantType type = {};645uint32_t constant_id = 0xffffffff;646union {647uint32_t int_value = 0;648float float_value;649bool bool_value;650};651};652653/*******************/654/**** RENDERING ****/655/*******************/656657// ----- PIPELINE -----658659enum RenderPrimitive {660RENDER_PRIMITIVE_POINTS,661RENDER_PRIMITIVE_LINES,662RENDER_PRIMITIVE_LINES_WITH_ADJACENCY,663RENDER_PRIMITIVE_LINESTRIPS,664RENDER_PRIMITIVE_LINESTRIPS_WITH_ADJACENCY,665RENDER_PRIMITIVE_TRIANGLES,666RENDER_PRIMITIVE_TRIANGLES_WITH_ADJACENCY,667RENDER_PRIMITIVE_TRIANGLE_STRIPS,668RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_AJACENCY, // TODO: Fix typo in "ADJACENCY" (in 5.0).669RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_RESTART_INDEX,670RENDER_PRIMITIVE_TESSELATION_PATCH,671RENDER_PRIMITIVE_MAX672};673674enum PolygonCullMode {675POLYGON_CULL_DISABLED,676POLYGON_CULL_FRONT,677POLYGON_CULL_BACK,678POLYGON_CULL_MAX679};680681enum PolygonFrontFace {682POLYGON_FRONT_FACE_CLOCKWISE,683POLYGON_FRONT_FACE_COUNTER_CLOCKWISE,684};685686enum StencilOperation {687STENCIL_OP_KEEP,688STENCIL_OP_ZERO,689STENCIL_OP_REPLACE,690STENCIL_OP_INCREMENT_AND_CLAMP,691STENCIL_OP_DECREMENT_AND_CLAMP,692STENCIL_OP_INVERT,693STENCIL_OP_INCREMENT_AND_WRAP,694STENCIL_OP_DECREMENT_AND_WRAP,695STENCIL_OP_MAX696};697698enum LogicOperation {699LOGIC_OP_CLEAR,700LOGIC_OP_AND,701LOGIC_OP_AND_REVERSE,702LOGIC_OP_COPY,703LOGIC_OP_AND_INVERTED,704LOGIC_OP_NO_OP,705LOGIC_OP_XOR,706LOGIC_OP_OR,707LOGIC_OP_NOR,708LOGIC_OP_EQUIVALENT,709LOGIC_OP_INVERT,710LOGIC_OP_OR_REVERSE,711LOGIC_OP_COPY_INVERTED,712LOGIC_OP_OR_INVERTED,713LOGIC_OP_NAND,714LOGIC_OP_SET,715LOGIC_OP_MAX716};717718enum BlendFactor {719BLEND_FACTOR_ZERO,720BLEND_FACTOR_ONE,721BLEND_FACTOR_SRC_COLOR,722BLEND_FACTOR_ONE_MINUS_SRC_COLOR,723BLEND_FACTOR_DST_COLOR,724BLEND_FACTOR_ONE_MINUS_DST_COLOR,725BLEND_FACTOR_SRC_ALPHA,726BLEND_FACTOR_ONE_MINUS_SRC_ALPHA,727BLEND_FACTOR_DST_ALPHA,728BLEND_FACTOR_ONE_MINUS_DST_ALPHA,729BLEND_FACTOR_CONSTANT_COLOR,730BLEND_FACTOR_ONE_MINUS_CONSTANT_COLOR,731BLEND_FACTOR_CONSTANT_ALPHA,732BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA,733BLEND_FACTOR_SRC_ALPHA_SATURATE,734BLEND_FACTOR_SRC1_COLOR,735BLEND_FACTOR_ONE_MINUS_SRC1_COLOR,736BLEND_FACTOR_SRC1_ALPHA,737BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA,738BLEND_FACTOR_MAX739};740741enum BlendOperation {742BLEND_OP_ADD,743BLEND_OP_SUBTRACT,744BLEND_OP_REVERSE_SUBTRACT,745BLEND_OP_MINIMUM,746BLEND_OP_MAXIMUM, // Yes, this one is an actual operator.747BLEND_OP_MAX748};749750struct PipelineRasterizationState {751bool enable_depth_clamp = false;752bool discard_primitives = false;753bool wireframe = false;754PolygonCullMode cull_mode = POLYGON_CULL_DISABLED;755PolygonFrontFace front_face = POLYGON_FRONT_FACE_CLOCKWISE;756bool depth_bias_enabled = false;757float depth_bias_constant_factor = 0.0f;758float depth_bias_clamp = 0.0f;759float depth_bias_slope_factor = 0.0f;760float line_width = 1.0f;761uint32_t patch_control_points = 1;762};763764struct PipelineMultisampleState {765TextureSamples sample_count = TEXTURE_SAMPLES_1;766bool enable_sample_shading = false;767float min_sample_shading = 0.0f;768Vector<uint32_t> sample_mask;769bool enable_alpha_to_coverage = false;770bool enable_alpha_to_one = false;771};772773struct PipelineDepthStencilState {774bool enable_depth_test = false;775bool enable_depth_write = false;776CompareOperator depth_compare_operator = COMPARE_OP_ALWAYS;777bool enable_depth_range = false;778float depth_range_min = 0;779float depth_range_max = 0;780bool enable_stencil = false;781782struct StencilOperationState {783StencilOperation fail = STENCIL_OP_ZERO;784StencilOperation pass = STENCIL_OP_ZERO;785StencilOperation depth_fail = STENCIL_OP_ZERO;786CompareOperator compare = COMPARE_OP_ALWAYS;787uint32_t compare_mask = 0;788uint32_t write_mask = 0;789uint32_t reference = 0;790};791792StencilOperationState front_op;793StencilOperationState back_op;794};795796struct PipelineColorBlendState {797bool enable_logic_op = false;798LogicOperation logic_op = LOGIC_OP_CLEAR;799800struct Attachment {801bool enable_blend = false;802BlendFactor src_color_blend_factor = BLEND_FACTOR_ZERO;803BlendFactor dst_color_blend_factor = BLEND_FACTOR_ZERO;804BlendOperation color_blend_op = BLEND_OP_ADD;805BlendFactor src_alpha_blend_factor = BLEND_FACTOR_ZERO;806BlendFactor dst_alpha_blend_factor = BLEND_FACTOR_ZERO;807BlendOperation alpha_blend_op = BLEND_OP_ADD;808bool write_r = true;809bool write_g = true;810bool write_b = true;811bool write_a = true;812};813814static PipelineColorBlendState create_disabled(int p_attachments = 1) {815PipelineColorBlendState bs;816for (int i = 0; i < p_attachments; i++) {817bs.attachments.push_back(Attachment());818}819return bs;820}821822static PipelineColorBlendState create_blend(int p_attachments = 1) {823PipelineColorBlendState bs;824for (int i = 0; i < p_attachments; i++) {825Attachment ba;826ba.enable_blend = true;827ba.src_color_blend_factor = BLEND_FACTOR_SRC_ALPHA;828ba.dst_color_blend_factor = BLEND_FACTOR_ONE_MINUS_SRC_ALPHA;829ba.src_alpha_blend_factor = BLEND_FACTOR_SRC_ALPHA;830ba.dst_alpha_blend_factor = BLEND_FACTOR_ONE_MINUS_SRC_ALPHA;831832bs.attachments.push_back(ba);833}834return bs;835}836837Vector<Attachment> attachments; // One per render target texture.838Color blend_constant;839};840841enum PipelineDynamicStateFlags {842DYNAMIC_STATE_LINE_WIDTH = (1 << 0),843DYNAMIC_STATE_DEPTH_BIAS = (1 << 1),844DYNAMIC_STATE_BLEND_CONSTANTS = (1 << 2),845DYNAMIC_STATE_DEPTH_BOUNDS = (1 << 3),846DYNAMIC_STATE_STENCIL_COMPARE_MASK = (1 << 4),847DYNAMIC_STATE_STENCIL_WRITE_MASK = (1 << 5),848DYNAMIC_STATE_STENCIL_REFERENCE = (1 << 6),849};850851/**************/852/**** MISC ****/853/**************/854855// This enum matches VkPhysicalDeviceType (except for `DEVICE_TYPE_MAX`).856// Unlike VkPhysicalDeviceType, DeviceType is exposed to the scripting API.857enum DeviceType {858DEVICE_TYPE_OTHER,859DEVICE_TYPE_INTEGRATED_GPU,860DEVICE_TYPE_DISCRETE_GPU,861DEVICE_TYPE_VIRTUAL_GPU,862DEVICE_TYPE_CPU,863DEVICE_TYPE_MAX864};865866// Defined in an API-agnostic way.867// Some may not make sense for the underlying API; in that case, 0 is returned.868enum DriverResource {869DRIVER_RESOURCE_LOGICAL_DEVICE,870DRIVER_RESOURCE_PHYSICAL_DEVICE,871DRIVER_RESOURCE_TOPMOST_OBJECT,872DRIVER_RESOURCE_COMMAND_QUEUE,873DRIVER_RESOURCE_QUEUE_FAMILY,874DRIVER_RESOURCE_TEXTURE,875DRIVER_RESOURCE_TEXTURE_VIEW,876DRIVER_RESOURCE_TEXTURE_DATA_FORMAT,877DRIVER_RESOURCE_SAMPLER,878DRIVER_RESOURCE_UNIFORM_SET,879DRIVER_RESOURCE_BUFFER,880DRIVER_RESOURCE_COMPUTE_PIPELINE,881DRIVER_RESOURCE_RENDER_PIPELINE,882#ifndef DISABLE_DEPRECATED883DRIVER_RESOURCE_VULKAN_DEVICE = DRIVER_RESOURCE_LOGICAL_DEVICE,884DRIVER_RESOURCE_VULKAN_PHYSICAL_DEVICE = DRIVER_RESOURCE_PHYSICAL_DEVICE,885DRIVER_RESOURCE_VULKAN_INSTANCE = DRIVER_RESOURCE_TOPMOST_OBJECT,886DRIVER_RESOURCE_VULKAN_QUEUE = DRIVER_RESOURCE_COMMAND_QUEUE,887DRIVER_RESOURCE_VULKAN_QUEUE_FAMILY_INDEX = DRIVER_RESOURCE_QUEUE_FAMILY,888DRIVER_RESOURCE_VULKAN_IMAGE = DRIVER_RESOURCE_TEXTURE,889DRIVER_RESOURCE_VULKAN_IMAGE_VIEW = DRIVER_RESOURCE_TEXTURE_VIEW,890DRIVER_RESOURCE_VULKAN_IMAGE_NATIVE_TEXTURE_FORMAT = DRIVER_RESOURCE_TEXTURE_DATA_FORMAT,891DRIVER_RESOURCE_VULKAN_SAMPLER = DRIVER_RESOURCE_SAMPLER,892DRIVER_RESOURCE_VULKAN_DESCRIPTOR_SET = DRIVER_RESOURCE_UNIFORM_SET,893DRIVER_RESOURCE_VULKAN_BUFFER = DRIVER_RESOURCE_BUFFER,894DRIVER_RESOURCE_VULKAN_COMPUTE_PIPELINE = DRIVER_RESOURCE_COMPUTE_PIPELINE,895DRIVER_RESOURCE_VULKAN_RENDER_PIPELINE = DRIVER_RESOURCE_RENDER_PIPELINE,896#endif897};898899enum Limit {900LIMIT_MAX_BOUND_UNIFORM_SETS,901LIMIT_MAX_FRAMEBUFFER_COLOR_ATTACHMENTS,902LIMIT_MAX_TEXTURES_PER_UNIFORM_SET,903LIMIT_MAX_SAMPLERS_PER_UNIFORM_SET,904LIMIT_MAX_STORAGE_BUFFERS_PER_UNIFORM_SET,905LIMIT_MAX_STORAGE_IMAGES_PER_UNIFORM_SET,906LIMIT_MAX_UNIFORM_BUFFERS_PER_UNIFORM_SET,907LIMIT_MAX_DRAW_INDEXED_INDEX,908LIMIT_MAX_FRAMEBUFFER_HEIGHT,909LIMIT_MAX_FRAMEBUFFER_WIDTH,910LIMIT_MAX_TEXTURE_ARRAY_LAYERS,911LIMIT_MAX_TEXTURE_SIZE_1D,912LIMIT_MAX_TEXTURE_SIZE_2D,913LIMIT_MAX_TEXTURE_SIZE_3D,914LIMIT_MAX_TEXTURE_SIZE_CUBE,915LIMIT_MAX_TEXTURES_PER_SHADER_STAGE,916LIMIT_MAX_SAMPLERS_PER_SHADER_STAGE,917LIMIT_MAX_STORAGE_BUFFERS_PER_SHADER_STAGE,918LIMIT_MAX_STORAGE_IMAGES_PER_SHADER_STAGE,919LIMIT_MAX_UNIFORM_BUFFERS_PER_SHADER_STAGE,920LIMIT_MAX_PUSH_CONSTANT_SIZE,921LIMIT_MAX_UNIFORM_BUFFER_SIZE,922LIMIT_MAX_VERTEX_INPUT_ATTRIBUTE_OFFSET,923LIMIT_MAX_VERTEX_INPUT_ATTRIBUTES,924LIMIT_MAX_VERTEX_INPUT_BINDINGS,925LIMIT_MAX_VERTEX_INPUT_BINDING_STRIDE,926LIMIT_MIN_UNIFORM_BUFFER_OFFSET_ALIGNMENT,927LIMIT_MAX_COMPUTE_SHARED_MEMORY_SIZE,928LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_X,929LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Y,930LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Z,931LIMIT_MAX_COMPUTE_WORKGROUP_INVOCATIONS,932LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_X,933LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Y,934LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Z,935LIMIT_MAX_VIEWPORT_DIMENSIONS_X,936LIMIT_MAX_VIEWPORT_DIMENSIONS_Y,937LIMIT_SUBGROUP_SIZE,938LIMIT_SUBGROUP_MIN_SIZE,939LIMIT_SUBGROUP_MAX_SIZE,940LIMIT_SUBGROUP_IN_SHADERS, // Set flags using SHADER_STAGE_VERTEX_BIT, SHADER_STAGE_FRAGMENT_BIT, etc.941LIMIT_SUBGROUP_OPERATIONS,942LIMIT_METALFX_TEMPORAL_SCALER_MIN_SCALE = 46,943LIMIT_METALFX_TEMPORAL_SCALER_MAX_SCALE,944LIMIT_MAX_SHADER_VARYINGS,945};946947enum Features {948SUPPORTS_MULTIVIEW,949SUPPORTS_HALF_FLOAT,950SUPPORTS_ATTACHMENT_VRS,951SUPPORTS_METALFX_SPATIAL,952SUPPORTS_METALFX_TEMPORAL,953// 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.954SUPPORTS_FRAGMENT_SHADER_WITH_ONLY_SIDE_EFFECTS,955SUPPORTS_BUFFER_DEVICE_ADDRESS,956SUPPORTS_IMAGE_ATOMIC_32_BIT,957SUPPORTS_VULKAN_MEMORY_MODEL,958};959960enum SubgroupOperations {961SUBGROUP_BASIC_BIT = 1,962SUBGROUP_VOTE_BIT = 2,963SUBGROUP_ARITHMETIC_BIT = 4,964SUBGROUP_BALLOT_BIT = 8,965SUBGROUP_SHUFFLE_BIT = 16,966SUBGROUP_SHUFFLE_RELATIVE_BIT = 32,967SUBGROUP_CLUSTERED_BIT = 64,968SUBGROUP_QUAD_BIT = 128,969};970971////////////////////////////////////////////972// PROTECTED STUFF973// Not exposed by RenderingDevice, but shared974// with RenderingDeviceDriver for convenience.975////////////////////////////////////////////976protected:977/*****************/978/**** GENERIC ****/979/*****************/980981static const char *const FORMAT_NAMES[DATA_FORMAT_MAX];982983/*****************/984/**** TEXTURE ****/985/*****************/986987static const uint32_t MAX_IMAGE_FORMAT_PLANES = 2;988989static const uint32_t TEXTURE_SAMPLES_COUNT[TEXTURE_SAMPLES_MAX];990991static void get_compressed_image_format_block_dimensions(DataFormat p_format, uint32_t &r_w, uint32_t &r_h);992uint32_t get_compressed_image_format_block_byte_size(DataFormat p_format) const;993static uint32_t get_compressed_image_format_pixel_rshift(DataFormat p_format);994static 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);995static uint32_t get_image_required_mipmaps(uint32_t p_width, uint32_t p_height, uint32_t p_depth);996static bool format_has_stencil(DataFormat p_format);997static uint32_t format_get_plane_count(DataFormat p_format);998999/*****************/1000/**** SAMPLER ****/1001/*****************/10021003static const Color SAMPLER_BORDER_COLOR_VALUE[SAMPLER_BORDER_COLOR_MAX];10041005/**********************/1006/**** VERTEX ARRAY ****/1007/**********************/10081009static uint32_t get_format_vertex_size(DataFormat p_format);10101011public:1012/*****************/1013/**** TEXTURE ****/1014/*****************/10151016static uint32_t get_image_format_pixel_size(DataFormat p_format);10171018/****************/1019/**** SHADER ****/1020/****************/10211022static const char *SHADER_STAGE_NAMES[SHADER_STAGE_MAX];10231024struct ShaderUniform {1025UniformType type = UniformType::UNIFORM_TYPE_MAX;1026bool writable = false;1027uint32_t binding = 0;1028BitField<ShaderStage> stages = {};1029uint32_t length = 0; // Size of arrays (in total elements), or ubos (in bytes * total elements).10301031bool operator!=(const ShaderUniform &p_other) const {1032return binding != p_other.binding || type != p_other.type || writable != p_other.writable || stages != p_other.stages || length != p_other.length;1033}10341035bool operator<(const ShaderUniform &p_other) const {1036if (binding != p_other.binding) {1037return binding < p_other.binding;1038}1039if (type != p_other.type) {1040return type < p_other.type;1041}1042if (writable != p_other.writable) {1043return writable < p_other.writable;1044}1045if (stages != p_other.stages) {1046return stages < p_other.stages;1047}1048if (length != p_other.length) {1049return length < p_other.length;1050}1051return false;1052}1053};10541055struct ShaderSpecializationConstant : public PipelineSpecializationConstant {1056BitField<ShaderStage> stages = {};10571058bool operator<(const ShaderSpecializationConstant &p_other) const { return constant_id < p_other.constant_id; }1059};10601061struct ShaderReflection {1062uint64_t vertex_input_mask = 0;1063uint32_t fragment_output_mask = 0;1064bool is_compute = false;1065bool has_multiview = false;1066uint32_t compute_local_size[3] = {};1067uint32_t push_constant_size = 0;10681069Vector<Vector<ShaderUniform>> uniform_sets;1070Vector<ShaderSpecializationConstant> specialization_constants;1071Vector<ShaderStage> stages_vector;1072BitField<ShaderStage> stages_bits = {};1073BitField<ShaderStage> push_constant_stages = {};1074};1075};107610771078