Path: blob/master/servers/rendering/rendering_device_commons.h
22517 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};318319enum ColorSpace {320COLOR_SPACE_REC709_LINEAR,321COLOR_SPACE_REC709_NONLINEAR_SRGB,322COLOR_SPACE_MAX,323};324325// Breadcrumb markers are useful for debugging GPU crashes (i.e. DEVICE_LOST). Internally326// they're just an uint32_t to "tag" a GPU command. These are only used for debugging and do not327// (or at least shouldn't) alter the execution behavior in any way.328//329// When a GPU crashes and Godot was built in dev or debug mode; Godot will dump what commands330// were being executed and what tag they were marked with.331// This makes narrowing down the cause of a crash easier. Note that a GPU can be executing332// multiple commands at the same time. It is also useful to identify data hazards.333//334// For example if each LIGHTMAPPER_PASS must be executed in sequential order, but dumps335// indicated that pass (LIGHTMAPPER_PASS | 5) was being executed at the same time as336// (LIGHTMAPPER_PASS | 4), that would indicate there is a missing barrier or a render graph bug.337//338// The enums are bitshifted by 16 bits so it's possible to add user data via bitwise operations.339// Using this enum is not mandatory; but it is recommended so that all subsystems agree what each340// ID means when dumping info.341enum BreadcrumbMarker {342NONE = 0,343// Environment344REFLECTION_PROBES = 1u << 16u,345SKY_PASS = 2u << 16u,346// Light mapping347LIGHTMAPPER_PASS = 3u << 16u,348// Shadows349SHADOW_PASS_DIRECTIONAL = 4u << 16u,350SHADOW_PASS_CUBE = 5u << 16u,351// Geometry passes352OPAQUE_PASS = 6u << 16u,353ALPHA_PASS = 7u << 16u,354TRANSPARENT_PASS = 8u << 16u,355// Screen effects356POST_PROCESSING_PASS = 9u << 16u,357BLIT_PASS = 10u << 16u,358UI_PASS = 11u << 16u,359// Other360DEBUG_PASS = 12u << 16u,361};362363enum CompareOperator {364COMPARE_OP_NEVER,365COMPARE_OP_LESS,366COMPARE_OP_EQUAL,367COMPARE_OP_LESS_OR_EQUAL,368COMPARE_OP_GREATER,369COMPARE_OP_NOT_EQUAL,370COMPARE_OP_GREATER_OR_EQUAL,371COMPARE_OP_ALWAYS,372COMPARE_OP_MAX373};374375/*****************/376/**** TEXTURE ****/377/*****************/378379enum TextureType {380TEXTURE_TYPE_1D,381TEXTURE_TYPE_2D,382TEXTURE_TYPE_3D,383TEXTURE_TYPE_CUBE,384TEXTURE_TYPE_1D_ARRAY,385TEXTURE_TYPE_2D_ARRAY,386TEXTURE_TYPE_CUBE_ARRAY,387TEXTURE_TYPE_MAX,388};389390enum TextureSamples {391TEXTURE_SAMPLES_1,392TEXTURE_SAMPLES_2,393TEXTURE_SAMPLES_4,394TEXTURE_SAMPLES_8,395TEXTURE_SAMPLES_16,396TEXTURE_SAMPLES_32,397TEXTURE_SAMPLES_64,398TEXTURE_SAMPLES_MAX,399};400401enum TextureUsageBits {402TEXTURE_USAGE_SAMPLING_BIT = (1 << 0),403TEXTURE_USAGE_COLOR_ATTACHMENT_BIT = (1 << 1),404TEXTURE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT = (1 << 2),405TEXTURE_USAGE_STORAGE_BIT = (1 << 3),406TEXTURE_USAGE_STORAGE_ATOMIC_BIT = (1 << 4),407TEXTURE_USAGE_CPU_READ_BIT = (1 << 5),408TEXTURE_USAGE_CAN_UPDATE_BIT = (1 << 6),409TEXTURE_USAGE_CAN_COPY_FROM_BIT = (1 << 7),410TEXTURE_USAGE_CAN_COPY_TO_BIT = (1 << 8),411TEXTURE_USAGE_INPUT_ATTACHMENT_BIT = (1 << 9),412TEXTURE_USAGE_VRS_ATTACHMENT_BIT = (1 << 10),413// When set, the texture is not backed by actual memory. It only ever lives in the cache.414// This is particularly useful for:415// 1. Depth/stencil buffers that are not needed after producing the colour output.416// 2. MSAA surfaces that are immediately resolved (i.e. its raw content isn't needed).417//418// This flag heavily improves performance & saves memory on TBDR GPUs (e.g. mobile).419// On Desktop this flag won't save memory but it still instructs the render graph that data will420// be discarded aggressively which may still improve some performance.421//422// It is not valid to perform copies from/to this texture, since it doesn't occupy actual RAM.423// It is also not valid to sample from this texture except using subpasses or via read/write424// pixel shader extensions (e.g. VK_EXT_rasterization_order_attachment_access).425//426// Try to set this bit as much as possible. If you set it, validation doesn't complain427// and it works fine on mobile, then go ahead.428TEXTURE_USAGE_TRANSIENT_BIT = (1 << 11),429TEXTURE_USAGE_DEPTH_RESOLVE_ATTACHMENT_BIT = (1 << 12),430TEXTURE_USAGE_MAX_BIT = TEXTURE_USAGE_DEPTH_RESOLVE_ATTACHMENT_BIT,431};432433struct TextureFormat {434DataFormat format = DATA_FORMAT_R8_UNORM;435uint32_t width = 1;436uint32_t height = 1;437uint32_t depth = 1;438uint32_t array_layers = 1;439uint32_t mipmaps = 1;440TextureType texture_type = TEXTURE_TYPE_2D;441TextureSamples samples = TEXTURE_SAMPLES_1;442uint32_t usage_bits = 0;443Vector<DataFormat> shareable_formats;444bool is_resolve_buffer = false;445bool is_discardable = false;446447bool operator==(const TextureFormat &b) const {448if (format != b.format) {449return false;450} else if (width != b.width) {451return false;452} else if (height != b.height) {453return false;454} else if (depth != b.depth) {455return false;456} else if (array_layers != b.array_layers) {457return false;458} else if (mipmaps != b.mipmaps) {459return false;460} else if (texture_type != b.texture_type) {461return false;462} else if (samples != b.samples) {463return false;464} else if (usage_bits != b.usage_bits) {465return false;466} else if (shareable_formats != b.shareable_formats) {467return false;468} else if (is_resolve_buffer != b.is_resolve_buffer) {469return false;470} else if (is_discardable != b.is_discardable) {471return false;472} else {473return true;474}475}476};477478enum TextureSwizzle {479TEXTURE_SWIZZLE_IDENTITY,480TEXTURE_SWIZZLE_ZERO,481TEXTURE_SWIZZLE_ONE,482TEXTURE_SWIZZLE_R,483TEXTURE_SWIZZLE_G,484TEXTURE_SWIZZLE_B,485TEXTURE_SWIZZLE_A,486TEXTURE_SWIZZLE_MAX487};488489enum TextureSliceType {490TEXTURE_SLICE_2D,491TEXTURE_SLICE_CUBEMAP,492TEXTURE_SLICE_3D,493TEXTURE_SLICE_2D_ARRAY,494TEXTURE_SLICE_MAX495};496497/*****************/498/**** SAMPLER ****/499/*****************/500501enum SamplerFilter {502SAMPLER_FILTER_NEAREST,503SAMPLER_FILTER_LINEAR,504};505506enum SamplerRepeatMode {507SAMPLER_REPEAT_MODE_REPEAT,508SAMPLER_REPEAT_MODE_MIRRORED_REPEAT,509SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE,510SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER,511SAMPLER_REPEAT_MODE_MIRROR_CLAMP_TO_EDGE,512SAMPLER_REPEAT_MODE_MAX513};514515enum SamplerBorderColor {516SAMPLER_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK,517SAMPLER_BORDER_COLOR_INT_TRANSPARENT_BLACK,518SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_BLACK,519SAMPLER_BORDER_COLOR_INT_OPAQUE_BLACK,520SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_WHITE,521SAMPLER_BORDER_COLOR_INT_OPAQUE_WHITE,522SAMPLER_BORDER_COLOR_MAX523};524525struct SamplerState {526SamplerFilter mag_filter = SAMPLER_FILTER_NEAREST;527SamplerFilter min_filter = SAMPLER_FILTER_NEAREST;528SamplerFilter mip_filter = SAMPLER_FILTER_NEAREST;529SamplerRepeatMode repeat_u = SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE;530SamplerRepeatMode repeat_v = SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE;531SamplerRepeatMode repeat_w = SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE;532float lod_bias = 0.0f;533bool use_anisotropy = false;534float anisotropy_max = 1.0f;535bool enable_compare = false;536CompareOperator compare_op = COMPARE_OP_ALWAYS;537float min_lod = 0.0f;538float max_lod = 1e20; // Something very large should do.539SamplerBorderColor border_color = SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_BLACK;540bool unnormalized_uvw = false;541};542543/**********************/544/**** VERTEX ARRAY ****/545/**********************/546547enum IndexBufferFormat {548INDEX_BUFFER_FORMAT_UINT16,549INDEX_BUFFER_FORMAT_UINT32,550};551552enum VertexFrequency {553VERTEX_FREQUENCY_VERTEX,554VERTEX_FREQUENCY_INSTANCE,555};556557struct VertexAttribute {558uint32_t binding = UINT32_MAX; // Attribute buffer binding index. When set to UINT32_MAX, it uses the index of the attribute in the layout.559uint32_t location = 0; // Shader location.560uint32_t offset = 0;561DataFormat format = DATA_FORMAT_MAX;562uint32_t stride = 0;563VertexFrequency frequency = VERTEX_FREQUENCY_VERTEX;564};565566struct VertexAttributeBinding {567uint32_t stride = 0;568VertexFrequency frequency = VERTEX_FREQUENCY_VERTEX;569570VertexAttributeBinding() = default;571VertexAttributeBinding(uint32_t p_stride, VertexFrequency p_frequency) :572stride(p_stride),573frequency(p_frequency) {}574};575576typedef HashMap<uint32_t, VertexAttributeBinding> VertexAttributeBindingsMap;577578/*********************/579/**** FRAMEBUFFER ****/580/*********************/581582static const int32_t ATTACHMENT_UNUSED = -1;583584/****************/585/**** SHADER ****/586/****************/587588enum ShaderStage {589SHADER_STAGE_VERTEX,590SHADER_STAGE_FRAGMENT,591SHADER_STAGE_TESSELATION_CONTROL,592SHADER_STAGE_TESSELATION_EVALUATION,593SHADER_STAGE_COMPUTE,594SHADER_STAGE_RAYGEN,595SHADER_STAGE_ANY_HIT,596SHADER_STAGE_CLOSEST_HIT,597SHADER_STAGE_MISS,598SHADER_STAGE_INTERSECTION,599SHADER_STAGE_MAX,600SHADER_STAGE_VERTEX_BIT = (1 << SHADER_STAGE_VERTEX),601SHADER_STAGE_FRAGMENT_BIT = (1 << SHADER_STAGE_FRAGMENT),602SHADER_STAGE_TESSELATION_CONTROL_BIT = (1 << SHADER_STAGE_TESSELATION_CONTROL),603SHADER_STAGE_TESSELATION_EVALUATION_BIT = (1 << SHADER_STAGE_TESSELATION_EVALUATION),604SHADER_STAGE_COMPUTE_BIT = (1 << SHADER_STAGE_COMPUTE),605SHADER_STAGE_RAYGEN_BIT = (1 << SHADER_STAGE_RAYGEN),606SHADER_STAGE_ANY_HIT_BIT = (1 << SHADER_STAGE_ANY_HIT),607SHADER_STAGE_CLOSEST_HIT_BIT = (1 << SHADER_STAGE_CLOSEST_HIT),608SHADER_STAGE_MISS_BIT = (1 << SHADER_STAGE_MISS),609SHADER_STAGE_INTERSECTION_BIT = (1 << SHADER_STAGE_INTERSECTION),610};611612enum ShaderLanguage {613SHADER_LANGUAGE_GLSL,614SHADER_LANGUAGE_HLSL,615};616617enum ShaderLanguageVersion {618SHADER_LANGUAGE_VULKAN_VERSION_1_0 = (1 << 22),619SHADER_LANGUAGE_VULKAN_VERSION_1_1 = (1 << 22) | (1 << 12),620SHADER_LANGUAGE_VULKAN_VERSION_1_2 = (1 << 22) | (2 << 12),621SHADER_LANGUAGE_VULKAN_VERSION_1_3 = (1 << 22) | (3 << 12),622SHADER_LANGUAGE_VULKAN_VERSION_1_4 = (1 << 22) | (4 << 12),623SHADER_LANGUAGE_OPENGL_VERSION_4_5_0 = 450,624};625626enum ShaderSpirvVersion {627SHADER_SPIRV_VERSION_1_0 = (1 << 16),628SHADER_SPIRV_VERSION_1_1 = (1 << 16) | (1 << 8),629SHADER_SPIRV_VERSION_1_2 = (1 << 16) | (2 << 8),630SHADER_SPIRV_VERSION_1_3 = (1 << 16) | (3 << 8),631SHADER_SPIRV_VERSION_1_4 = (1 << 16) | (4 << 8),632SHADER_SPIRV_VERSION_1_5 = (1 << 16) | (5 << 8),633SHADER_SPIRV_VERSION_1_6 = (1 << 16) | (6 << 8),634};635636struct ShaderStageSPIRVData {637ShaderStage shader_stage = SHADER_STAGE_MAX;638Vector<uint8_t> spirv;639Vector<uint64_t> dynamic_buffers;640};641642/*********************/643/**** UNIFORM SET ****/644/*********************/645646static const uint32_t MAX_UNIFORM_SETS = 16;647648// Keep the enum values in sync with the `SHADER_UNIFORM_NAMES` values (file rendering_device.cpp).649enum UniformType {650UNIFORM_TYPE_SAMPLER, // For sampling only (sampler GLSL type).651UNIFORM_TYPE_SAMPLER_WITH_TEXTURE, // For sampling only, but includes a texture, (samplerXX GLSL type), first a sampler then a texture.652UNIFORM_TYPE_TEXTURE, // Only texture, (textureXX GLSL type).653UNIFORM_TYPE_IMAGE, // Storage image (imageXX GLSL type), for compute mostly.654UNIFORM_TYPE_TEXTURE_BUFFER, // Buffer texture (or TBO, textureBuffer type).655UNIFORM_TYPE_SAMPLER_WITH_TEXTURE_BUFFER, // Buffer texture with a sampler(or TBO, samplerBuffer type).656UNIFORM_TYPE_IMAGE_BUFFER, // Texel buffer, (imageBuffer type), for compute mostly.657UNIFORM_TYPE_UNIFORM_BUFFER, // Regular uniform buffer (or UBO).658UNIFORM_TYPE_STORAGE_BUFFER, // Storage buffer ("buffer" qualifier) like UBO, but supports storage, for compute mostly.659UNIFORM_TYPE_INPUT_ATTACHMENT, // Used for sub-pass read/write, for mobile mostly.660UNIFORM_TYPE_UNIFORM_BUFFER_DYNAMIC, // Same as UNIFORM but created with BUFFER_USAGE_DYNAMIC_PERSISTENT_BIT.661UNIFORM_TYPE_STORAGE_BUFFER_DYNAMIC, // Same as STORAGE but created with BUFFER_USAGE_DYNAMIC_PERSISTENT_BIT.662UNIFORM_TYPE_ACCELERATION_STRUCTURE, // Bounding Volume Hierarchy (Top + Bottom Level acceleration structures), for raytracing only.663UNIFORM_TYPE_MAX664};665666/******************/667/**** PIPELINE ****/668/******************/669670enum PipelineSpecializationConstantType {671PIPELINE_SPECIALIZATION_CONSTANT_TYPE_BOOL,672PIPELINE_SPECIALIZATION_CONSTANT_TYPE_INT,673PIPELINE_SPECIALIZATION_CONSTANT_TYPE_FLOAT,674};675676struct PipelineSpecializationConstant {677PipelineSpecializationConstantType type = {};678uint32_t constant_id = 0xffffffff;679union {680uint32_t int_value = 0;681float float_value;682bool bool_value;683};684};685686/*******************/687/**** RENDERING ****/688/*******************/689690// ----- PIPELINE -----691692// Rendering Shader Container expects this type to be 4 bytes for proper alignment with the shaders.693enum PipelineType : uint32_t {694PIPELINE_TYPE_RASTERIZATION,695PIPELINE_TYPE_COMPUTE,696PIPELINE_TYPE_RAYTRACING,697};698699enum RenderPrimitive {700RENDER_PRIMITIVE_POINTS,701RENDER_PRIMITIVE_LINES,702RENDER_PRIMITIVE_LINES_WITH_ADJACENCY,703RENDER_PRIMITIVE_LINESTRIPS,704RENDER_PRIMITIVE_LINESTRIPS_WITH_ADJACENCY,705RENDER_PRIMITIVE_TRIANGLES,706RENDER_PRIMITIVE_TRIANGLES_WITH_ADJACENCY,707RENDER_PRIMITIVE_TRIANGLE_STRIPS,708RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_AJACENCY, // TODO: Fix typo in "ADJACENCY" (in 5.0).709RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_RESTART_INDEX,710RENDER_PRIMITIVE_TESSELATION_PATCH,711RENDER_PRIMITIVE_MAX712};713714enum PolygonCullMode {715POLYGON_CULL_DISABLED,716POLYGON_CULL_FRONT,717POLYGON_CULL_BACK,718POLYGON_CULL_MAX719};720721enum PolygonFrontFace {722POLYGON_FRONT_FACE_CLOCKWISE,723POLYGON_FRONT_FACE_COUNTER_CLOCKWISE,724};725726enum StencilOperation {727STENCIL_OP_KEEP,728STENCIL_OP_ZERO,729STENCIL_OP_REPLACE,730STENCIL_OP_INCREMENT_AND_CLAMP,731STENCIL_OP_DECREMENT_AND_CLAMP,732STENCIL_OP_INVERT,733STENCIL_OP_INCREMENT_AND_WRAP,734STENCIL_OP_DECREMENT_AND_WRAP,735STENCIL_OP_MAX736};737738enum LogicOperation {739LOGIC_OP_CLEAR,740LOGIC_OP_AND,741LOGIC_OP_AND_REVERSE,742LOGIC_OP_COPY,743LOGIC_OP_AND_INVERTED,744LOGIC_OP_NO_OP,745LOGIC_OP_XOR,746LOGIC_OP_OR,747LOGIC_OP_NOR,748LOGIC_OP_EQUIVALENT,749LOGIC_OP_INVERT,750LOGIC_OP_OR_REVERSE,751LOGIC_OP_COPY_INVERTED,752LOGIC_OP_OR_INVERTED,753LOGIC_OP_NAND,754LOGIC_OP_SET,755LOGIC_OP_MAX756};757758enum BlendFactor {759BLEND_FACTOR_ZERO,760BLEND_FACTOR_ONE,761BLEND_FACTOR_SRC_COLOR,762BLEND_FACTOR_ONE_MINUS_SRC_COLOR,763BLEND_FACTOR_DST_COLOR,764BLEND_FACTOR_ONE_MINUS_DST_COLOR,765BLEND_FACTOR_SRC_ALPHA,766BLEND_FACTOR_ONE_MINUS_SRC_ALPHA,767BLEND_FACTOR_DST_ALPHA,768BLEND_FACTOR_ONE_MINUS_DST_ALPHA,769BLEND_FACTOR_CONSTANT_COLOR,770BLEND_FACTOR_ONE_MINUS_CONSTANT_COLOR,771BLEND_FACTOR_CONSTANT_ALPHA,772BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA,773BLEND_FACTOR_SRC_ALPHA_SATURATE,774BLEND_FACTOR_SRC1_COLOR,775BLEND_FACTOR_ONE_MINUS_SRC1_COLOR,776BLEND_FACTOR_SRC1_ALPHA,777BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA,778BLEND_FACTOR_MAX779};780781enum BlendOperation {782BLEND_OP_ADD,783BLEND_OP_SUBTRACT,784BLEND_OP_REVERSE_SUBTRACT,785BLEND_OP_MINIMUM,786BLEND_OP_MAXIMUM, // Yes, this one is an actual operator.787BLEND_OP_MAX788};789790struct PipelineRasterizationState {791bool enable_depth_clamp = false;792bool discard_primitives = false;793bool wireframe = false;794PolygonCullMode cull_mode = POLYGON_CULL_DISABLED;795PolygonFrontFace front_face = POLYGON_FRONT_FACE_CLOCKWISE;796bool depth_bias_enabled = false;797float depth_bias_constant_factor = 0.0f;798float depth_bias_clamp = 0.0f;799float depth_bias_slope_factor = 0.0f;800float line_width = 1.0f;801uint32_t patch_control_points = 1;802};803804struct PipelineMultisampleState {805TextureSamples sample_count = TEXTURE_SAMPLES_1;806bool enable_sample_shading = false;807float min_sample_shading = 0.0f;808Vector<uint32_t> sample_mask;809bool enable_alpha_to_coverage = false;810bool enable_alpha_to_one = false;811};812813struct PipelineDepthStencilState {814bool enable_depth_test = false;815bool enable_depth_write = false;816CompareOperator depth_compare_operator = COMPARE_OP_ALWAYS;817bool enable_depth_range = false;818float depth_range_min = 0;819float depth_range_max = 0;820bool enable_stencil = false;821822struct StencilOperationState {823StencilOperation fail = STENCIL_OP_ZERO;824StencilOperation pass = STENCIL_OP_ZERO;825StencilOperation depth_fail = STENCIL_OP_ZERO;826CompareOperator compare = COMPARE_OP_ALWAYS;827uint32_t compare_mask = 0;828uint32_t write_mask = 0;829uint32_t reference = 0;830};831832StencilOperationState front_op;833StencilOperationState back_op;834};835836struct PipelineColorBlendState {837bool enable_logic_op = false;838LogicOperation logic_op = LOGIC_OP_CLEAR;839840struct Attachment {841bool enable_blend = false;842BlendFactor src_color_blend_factor = BLEND_FACTOR_ZERO;843BlendFactor dst_color_blend_factor = BLEND_FACTOR_ZERO;844BlendOperation color_blend_op = BLEND_OP_ADD;845BlendFactor src_alpha_blend_factor = BLEND_FACTOR_ZERO;846BlendFactor dst_alpha_blend_factor = BLEND_FACTOR_ZERO;847BlendOperation alpha_blend_op = BLEND_OP_ADD;848bool write_r = true;849bool write_g = true;850bool write_b = true;851bool write_a = true;852};853854static PipelineColorBlendState create_disabled(int p_attachments = 1) {855PipelineColorBlendState bs;856for (int i = 0; i < p_attachments; i++) {857bs.attachments.push_back(Attachment());858}859return bs;860}861862static PipelineColorBlendState create_blend(int p_attachments = 1) {863PipelineColorBlendState bs;864for (int i = 0; i < p_attachments; i++) {865Attachment ba;866ba.enable_blend = true;867ba.src_color_blend_factor = BLEND_FACTOR_SRC_ALPHA;868ba.dst_color_blend_factor = BLEND_FACTOR_ONE_MINUS_SRC_ALPHA;869ba.src_alpha_blend_factor = BLEND_FACTOR_SRC_ALPHA;870ba.dst_alpha_blend_factor = BLEND_FACTOR_ONE_MINUS_SRC_ALPHA;871872bs.attachments.push_back(ba);873}874return bs;875}876877Vector<Attachment> attachments; // One per render target texture.878Color blend_constant;879};880881enum PipelineDynamicStateFlags {882DYNAMIC_STATE_LINE_WIDTH = (1 << 0),883DYNAMIC_STATE_DEPTH_BIAS = (1 << 1),884DYNAMIC_STATE_BLEND_CONSTANTS = (1 << 2),885DYNAMIC_STATE_DEPTH_BOUNDS = (1 << 3),886DYNAMIC_STATE_STENCIL_COMPARE_MASK = (1 << 4),887DYNAMIC_STATE_STENCIL_WRITE_MASK = (1 << 5),888DYNAMIC_STATE_STENCIL_REFERENCE = (1 << 6),889};890891/**************/892/**** MISC ****/893/**************/894895// Defined in an API-agnostic way.896// Some may not make sense for the underlying API; in that case, 0 is returned.897enum DriverResource {898DRIVER_RESOURCE_LOGICAL_DEVICE,899DRIVER_RESOURCE_PHYSICAL_DEVICE,900DRIVER_RESOURCE_TOPMOST_OBJECT,901DRIVER_RESOURCE_COMMAND_QUEUE,902DRIVER_RESOURCE_QUEUE_FAMILY,903DRIVER_RESOURCE_TEXTURE,904DRIVER_RESOURCE_TEXTURE_VIEW,905DRIVER_RESOURCE_TEXTURE_DATA_FORMAT,906DRIVER_RESOURCE_SAMPLER,907DRIVER_RESOURCE_UNIFORM_SET,908DRIVER_RESOURCE_BUFFER,909DRIVER_RESOURCE_COMPUTE_PIPELINE,910DRIVER_RESOURCE_RENDER_PIPELINE,911#ifndef DISABLE_DEPRECATED912DRIVER_RESOURCE_VULKAN_DEVICE = DRIVER_RESOURCE_LOGICAL_DEVICE,913DRIVER_RESOURCE_VULKAN_PHYSICAL_DEVICE = DRIVER_RESOURCE_PHYSICAL_DEVICE,914DRIVER_RESOURCE_VULKAN_INSTANCE = DRIVER_RESOURCE_TOPMOST_OBJECT,915DRIVER_RESOURCE_VULKAN_QUEUE = DRIVER_RESOURCE_COMMAND_QUEUE,916DRIVER_RESOURCE_VULKAN_QUEUE_FAMILY_INDEX = DRIVER_RESOURCE_QUEUE_FAMILY,917DRIVER_RESOURCE_VULKAN_IMAGE = DRIVER_RESOURCE_TEXTURE,918DRIVER_RESOURCE_VULKAN_IMAGE_VIEW = DRIVER_RESOURCE_TEXTURE_VIEW,919DRIVER_RESOURCE_VULKAN_IMAGE_NATIVE_TEXTURE_FORMAT = DRIVER_RESOURCE_TEXTURE_DATA_FORMAT,920DRIVER_RESOURCE_VULKAN_SAMPLER = DRIVER_RESOURCE_SAMPLER,921DRIVER_RESOURCE_VULKAN_DESCRIPTOR_SET = DRIVER_RESOURCE_UNIFORM_SET,922DRIVER_RESOURCE_VULKAN_BUFFER = DRIVER_RESOURCE_BUFFER,923DRIVER_RESOURCE_VULKAN_COMPUTE_PIPELINE = DRIVER_RESOURCE_COMPUTE_PIPELINE,924DRIVER_RESOURCE_VULKAN_RENDER_PIPELINE = DRIVER_RESOURCE_RENDER_PIPELINE,925#endif926};927928enum Limit {929LIMIT_MAX_BOUND_UNIFORM_SETS,930LIMIT_MAX_FRAMEBUFFER_COLOR_ATTACHMENTS,931LIMIT_MAX_TEXTURES_PER_UNIFORM_SET,932LIMIT_MAX_SAMPLERS_PER_UNIFORM_SET,933LIMIT_MAX_STORAGE_BUFFERS_PER_UNIFORM_SET,934LIMIT_MAX_STORAGE_IMAGES_PER_UNIFORM_SET,935LIMIT_MAX_UNIFORM_BUFFERS_PER_UNIFORM_SET,936LIMIT_MAX_DRAW_INDEXED_INDEX,937LIMIT_MAX_FRAMEBUFFER_HEIGHT,938LIMIT_MAX_FRAMEBUFFER_WIDTH,939LIMIT_MAX_TEXTURE_ARRAY_LAYERS,940LIMIT_MAX_TEXTURE_SIZE_1D,941LIMIT_MAX_TEXTURE_SIZE_2D,942LIMIT_MAX_TEXTURE_SIZE_3D,943LIMIT_MAX_TEXTURE_SIZE_CUBE,944LIMIT_MAX_TEXTURES_PER_SHADER_STAGE,945LIMIT_MAX_SAMPLERS_PER_SHADER_STAGE,946LIMIT_MAX_STORAGE_BUFFERS_PER_SHADER_STAGE,947LIMIT_MAX_STORAGE_IMAGES_PER_SHADER_STAGE,948LIMIT_MAX_UNIFORM_BUFFERS_PER_SHADER_STAGE,949LIMIT_MAX_PUSH_CONSTANT_SIZE,950LIMIT_MAX_UNIFORM_BUFFER_SIZE,951LIMIT_MAX_VERTEX_INPUT_ATTRIBUTE_OFFSET,952LIMIT_MAX_VERTEX_INPUT_ATTRIBUTES,953LIMIT_MAX_VERTEX_INPUT_BINDINGS,954LIMIT_MAX_VERTEX_INPUT_BINDING_STRIDE,955LIMIT_MIN_UNIFORM_BUFFER_OFFSET_ALIGNMENT,956LIMIT_MAX_COMPUTE_SHARED_MEMORY_SIZE,957LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_X,958LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Y,959LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Z,960LIMIT_MAX_COMPUTE_WORKGROUP_INVOCATIONS,961LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_X,962LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Y,963LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Z,964LIMIT_MAX_VIEWPORT_DIMENSIONS_X,965LIMIT_MAX_VIEWPORT_DIMENSIONS_Y,966LIMIT_SUBGROUP_SIZE,967LIMIT_SUBGROUP_MIN_SIZE,968LIMIT_SUBGROUP_MAX_SIZE,969LIMIT_SUBGROUP_IN_SHADERS, // Set flags using SHADER_STAGE_VERTEX_BIT, SHADER_STAGE_FRAGMENT_BIT, etc.970LIMIT_SUBGROUP_OPERATIONS,971LIMIT_METALFX_TEMPORAL_SCALER_MIN_SCALE = 46,972LIMIT_METALFX_TEMPORAL_SCALER_MAX_SCALE,973LIMIT_MAX_SHADER_VARYINGS,974};975976enum Features {977SUPPORTS_MULTIVIEW,978SUPPORTS_HALF_FLOAT,979SUPPORTS_ATTACHMENT_VRS,980SUPPORTS_METALFX_SPATIAL,981SUPPORTS_METALFX_TEMPORAL,982// 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.983SUPPORTS_FRAGMENT_SHADER_WITH_ONLY_SIDE_EFFECTS,984SUPPORTS_BUFFER_DEVICE_ADDRESS,985SUPPORTS_IMAGE_ATOMIC_32_BIT,986SUPPORTS_VULKAN_MEMORY_MODEL,987SUPPORTS_FRAMEBUFFER_DEPTH_RESOLVE,988SUPPORTS_POINT_SIZE,989SUPPORTS_RAY_QUERY,990SUPPORTS_RAYTRACING_PIPELINE,991SUPPORTS_HDR_OUTPUT,992};993994enum SubgroupOperations {995SUBGROUP_BASIC_BIT = 1,996SUBGROUP_VOTE_BIT = 2,997SUBGROUP_ARITHMETIC_BIT = 4,998SUBGROUP_BALLOT_BIT = 8,999SUBGROUP_SHUFFLE_BIT = 16,1000SUBGROUP_SHUFFLE_RELATIVE_BIT = 32,1001SUBGROUP_CLUSTERED_BIT = 64,1002SUBGROUP_QUAD_BIT = 128,1003};10041005////////////////////////////////////////////1006// PROTECTED STUFF1007// Not exposed by RenderingDevice, but shared1008// with RenderingDeviceDriver for convenience.1009////////////////////////////////////////////1010protected:1011/*****************/1012/**** GENERIC ****/1013/*****************/10141015static const char *const FORMAT_NAMES[DATA_FORMAT_MAX];10161017/*****************/1018/**** TEXTURE ****/1019/*****************/10201021static const uint32_t MAX_IMAGE_FORMAT_PLANES = 2;10221023static const uint32_t TEXTURE_SAMPLES_COUNT[TEXTURE_SAMPLES_MAX];10241025static void get_compressed_image_format_block_dimensions(DataFormat p_format, uint32_t &r_w, uint32_t &r_h);1026uint32_t get_compressed_image_format_block_byte_size(DataFormat p_format) const;1027static uint32_t get_compressed_image_format_pixel_rshift(DataFormat p_format);1028static 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);1029static uint32_t get_image_required_mipmaps(uint32_t p_width, uint32_t p_height, uint32_t p_depth);1030static bool format_has_depth(DataFormat p_format);1031static bool format_has_stencil(DataFormat p_format);1032static uint32_t format_get_plane_count(DataFormat p_format);10331034/*****************/1035/**** SAMPLER ****/1036/*****************/10371038static const Color SAMPLER_BORDER_COLOR_VALUE[SAMPLER_BORDER_COLOR_MAX];10391040/**********************/1041/**** VERTEX ARRAY ****/1042/**********************/10431044static uint32_t get_format_vertex_size(DataFormat p_format);10451046public:1047/*****************/1048/**** TEXTURE ****/1049/*****************/10501051static uint32_t get_image_format_pixel_size(DataFormat p_format);10521053/****************/1054/**** SHADER ****/1055/****************/10561057static const char *SHADER_STAGE_NAMES[SHADER_STAGE_MAX];10581059struct ShaderUniform {1060UniformType type = UniformType::UNIFORM_TYPE_MAX;1061bool writable = false;1062uint32_t binding = 0;1063BitField<ShaderStage> stages = {};1064uint32_t length = 0; // Size of arrays (in total elements), or ubos (in bytes * total elements).10651066bool operator!=(const ShaderUniform &p_other) const {1067return binding != p_other.binding || type != p_other.type || writable != p_other.writable || stages != p_other.stages || length != p_other.length;1068}10691070bool operator<(const ShaderUniform &p_other) const {1071if (binding != p_other.binding) {1072return binding < p_other.binding;1073}1074if (type != p_other.type) {1075return type < p_other.type;1076}1077if (writable != p_other.writable) {1078return writable < p_other.writable;1079}1080if (stages != p_other.stages) {1081return stages < p_other.stages;1082}1083if (length != p_other.length) {1084return length < p_other.length;1085}1086return false;1087}1088};10891090struct ShaderSpecializationConstant : public PipelineSpecializationConstant {1091BitField<ShaderStage> stages = {};10921093bool operator<(const ShaderSpecializationConstant &p_other) const { return constant_id < p_other.constant_id; }1094};10951096struct ShaderReflection {1097uint64_t vertex_input_mask = 0;1098uint32_t fragment_output_mask = 0;1099PipelineType pipeline_type = PIPELINE_TYPE_RASTERIZATION;1100bool has_multiview = false;1101bool has_dynamic_buffers = false;1102uint32_t compute_local_size[3] = {};1103uint32_t push_constant_size = 0;11041105Vector<Vector<ShaderUniform>> uniform_sets;1106Vector<ShaderSpecializationConstant> specialization_constants;1107Vector<ShaderStage> stages_vector;1108BitField<ShaderStage> stages_bits = {};1109BitField<ShaderStage> push_constant_stages = {};1110};1111};111211131114