|
796 | 796 | Returns the data format used to create this texture. |
797 | 797 | </description> |
798 | 798 | </method> |
799 | | - <method name="texture_get_native_handle"> |
| 799 | + <method name="texture_get_native_handle" is_deprecated="true"> |
800 | 800 | <return type="int" /> |
801 | 801 | <param index="0" name="texture" type="RID" /> |
802 | 802 | <description> |
803 | 803 | Returns the internal graphics handle for this texture object. For use when communicating with third-party APIs mostly with GDExtension. |
804 | 804 | [b]Note:[/b] This function returns a [code]uint64_t[/code] which internally maps to a [code]GLuint[/code] (OpenGL) or [code]VkImage[/code] (Vulkan). |
| 805 | + [i]Deprecated.[/i] Use [method get_driver_resource] with [constant DRIVER_RESOURCE_TEXTURE] instead. |
805 | 806 | </description> |
806 | 807 | </method> |
807 | 808 | <method name="texture_is_format_supported_for_usage" qualifiers="const"> |
|
928 | 929 | <constant name="DEVICE_TYPE_MAX" value="5" enum="DeviceType"> |
929 | 930 | Represents the size of the [enum DeviceType] enum. |
930 | 931 | </constant> |
931 | | - <constant name="DRIVER_RESOURCE_VULKAN_DEVICE" value="0" enum="DriverResource"> |
932 | | - Vulkan device driver resource. This is a "global" resource and ignores the RID passed in |
| 932 | + <constant name="DRIVER_RESOURCE_LOGICAL_DEVICE" value="0" enum="DriverResource"> |
| 933 | + Specific device object based on a physical device. |
| 934 | + - Vulkan: Vulkan device driver resource ([code]VkDevice[/code]). ([code]rid[/code] argument doesn't apply.) |
933 | 935 | </constant> |
934 | | - <constant name="DRIVER_RESOURCE_VULKAN_PHYSICAL_DEVICE" value="1" enum="DriverResource"> |
935 | | - Physical device (graphics card) driver resource. |
| 936 | + <constant name="DRIVER_RESOURCE_PHYSICAL_DEVICE" value="1" enum="DriverResource"> |
| 937 | + Physical device the specific logical device is based on. |
| 938 | + - Vulkan: [code]VkDevice[/code]. ([code]rid[/code] argument doesn't apply.) |
936 | 939 | </constant> |
937 | | - <constant name="DRIVER_RESOURCE_VULKAN_INSTANCE" value="2" enum="DriverResource"> |
938 | | - Vulkan instance driver resource. |
| 940 | + <constant name="DRIVER_RESOURCE_TOPMOST_OBJECT" value="2" enum="DriverResource"> |
| 941 | + Top-most graphics API entry object. |
| 942 | + - Vulkan: [code]VkInstance[/code]. ([code]rid[/code] argument doesn't apply.) |
939 | 943 | </constant> |
940 | | - <constant name="DRIVER_RESOURCE_VULKAN_QUEUE" value="3" enum="DriverResource"> |
941 | | - Vulkan queue driver resource. |
| 944 | + <constant name="DRIVER_RESOURCE_COMMAND_QUEUE" value="3" enum="DriverResource"> |
| 945 | + The main graphics-compute command queue. |
| 946 | + - Vulkan: [code]VkQueue[/code]. ([code]rid[/code] argument doesn't apply.) |
942 | 947 | </constant> |
943 | | - <constant name="DRIVER_RESOURCE_VULKAN_QUEUE_FAMILY_INDEX" value="4" enum="DriverResource"> |
944 | | - Vulkan queue family index driver resource. |
| 948 | + <constant name="DRIVER_RESOURCE_QUEUE_FAMILY" value="4" enum="DriverResource"> |
| 949 | + The specific family the main queue belongs to. |
| 950 | + - Vulkan: the queue family index, an [code]uint32_t[/code]. ([code]rid[/code] argument doesn't apply.) |
945 | 951 | </constant> |
946 | | - <constant name="DRIVER_RESOURCE_VULKAN_IMAGE" value="5" enum="DriverResource"> |
947 | | - Vulkan image driver resource. |
| 952 | + <constant name="DRIVER_RESOURCE_TEXTURE" value="5" enum="DriverResource"> |
| 953 | + - Vulkan: [code]VkImage[/code]. |
948 | 954 | </constant> |
949 | | - <constant name="DRIVER_RESOURCE_VULKAN_IMAGE_VIEW" value="6" enum="DriverResource"> |
950 | | - Vulkan image view driver resource. |
| 955 | + <constant name="DRIVER_RESOURCE_TEXTURE_VIEW" value="6" enum="DriverResource"> |
| 956 | + The view of an owned or shared texture. |
| 957 | + - Vulkan: [code]VkImageView[/code]. |
951 | 958 | </constant> |
952 | | - <constant name="DRIVER_RESOURCE_VULKAN_IMAGE_NATIVE_TEXTURE_FORMAT" value="7" enum="DriverResource"> |
953 | | - Vulkan image native texture format driver resource. |
| 959 | + <constant name="DRIVER_RESOURCE_TEXTURE_DATA_FORMAT" value="7" enum="DriverResource"> |
| 960 | + The native id of the data format of the texture. |
| 961 | + - Vulkan: [code]VkFormat[/code]. |
954 | 962 | </constant> |
955 | | - <constant name="DRIVER_RESOURCE_VULKAN_SAMPLER" value="8" enum="DriverResource"> |
956 | | - Vulkan sampler driver resource. |
| 963 | + <constant name="DRIVER_RESOURCE_SAMPLER" value="8" enum="DriverResource"> |
| 964 | + - Vulkan: [code]VkSampler[/code]. |
957 | 965 | </constant> |
958 | | - <constant name="DRIVER_RESOURCE_VULKAN_DESCRIPTOR_SET" value="9" enum="DriverResource"> |
959 | | - Vulkan [url=https://vkguide.dev/docs/chapter-4/descriptors/]descriptor set[/url] driver resource. |
| 966 | + <constant name="DRIVER_RESOURCE_UNIFORM_SET" value="9" enum="DriverResource"> |
| 967 | + - Vulkan: [code]VkDescriptorSet[/code]. |
960 | 968 | </constant> |
961 | | - <constant name="DRIVER_RESOURCE_VULKAN_BUFFER" value="10" enum="DriverResource"> |
962 | | - Vulkan buffer driver resource. |
| 969 | + <constant name="DRIVER_RESOURCE_BUFFER" value="10" enum="DriverResource"> |
| 970 | + Buffer of any kind of (storage, vertex, etc.). |
| 971 | + - Vulkan: [code]VkBuffer[/code]. |
963 | 972 | </constant> |
964 | | - <constant name="DRIVER_RESOURCE_VULKAN_COMPUTE_PIPELINE" value="11" enum="DriverResource"> |
965 | | - Vulkan compute pipeline driver resource. |
| 973 | + <constant name="DRIVER_RESOURCE_COMPUTE_PIPELINE" value="11" enum="DriverResource"> |
| 974 | + - Vulkan: [code]VkPipeline[/code]. |
966 | 975 | </constant> |
967 | | - <constant name="DRIVER_RESOURCE_VULKAN_RENDER_PIPELINE" value="12" enum="DriverResource"> |
968 | | - Vulkan render pipeline driver resource. |
| 976 | + <constant name="DRIVER_RESOURCE_RENDER_PIPELINE" value="12" enum="DriverResource"> |
| 977 | + - Vulkan: [code]VkPipeline[/code]. |
| 978 | + </constant> |
| 979 | + <constant name="DRIVER_RESOURCE_VULKAN_DEVICE" value="0" enum="DriverResource" is_deprecated="true"> |
| 980 | + [i]Deprecated.[/i] Use [constant DRIVER_RESOURCE_LOGICAL_DEVICE]. |
| 981 | + </constant> |
| 982 | + <constant name="DRIVER_RESOURCE_VULKAN_PHYSICAL_DEVICE" value="1" enum="DriverResource" is_deprecated="true"> |
| 983 | + [i]Deprecated.[/i] Use [constant DRIVER_RESOURCE_PHYSICAL_DEVICE]. |
| 984 | + </constant> |
| 985 | + <constant name="DRIVER_RESOURCE_VULKAN_INSTANCE" value="2" enum="DriverResource" is_deprecated="true"> |
| 986 | + [i]Deprecated.[/i] Use [constant DRIVER_RESOURCE_TOPMOST_OBJECT]. |
| 987 | + </constant> |
| 988 | + <constant name="DRIVER_RESOURCE_VULKAN_QUEUE" value="3" enum="DriverResource" is_deprecated="true"> |
| 989 | + [i]Deprecated.[/i] Use [constant DRIVER_RESOURCE_COMMAND_QUEUE]. |
| 990 | + </constant> |
| 991 | + <constant name="DRIVER_RESOURCE_VULKAN_QUEUE_FAMILY_INDEX" value="4" enum="DriverResource" is_deprecated="true"> |
| 992 | + [i]Deprecated.[/i] Use [constant DRIVER_RESOURCE_QUEUE_FAMILY]. |
| 993 | + </constant> |
| 994 | + <constant name="DRIVER_RESOURCE_VULKAN_IMAGE" value="5" enum="DriverResource" is_deprecated="true"> |
| 995 | + [i]Deprecated.[/i] Use [constant DRIVER_RESOURCE_TEXTURE]. |
| 996 | + </constant> |
| 997 | + <constant name="DRIVER_RESOURCE_VULKAN_IMAGE_VIEW" value="6" enum="DriverResource" is_deprecated="true"> |
| 998 | + [i]Deprecated.[/i] Use [constant DRIVER_RESOURCE_TEXTURE_VIEW]. |
| 999 | + </constant> |
| 1000 | + <constant name="DRIVER_RESOURCE_VULKAN_IMAGE_NATIVE_TEXTURE_FORMAT" value="7" enum="DriverResource" is_deprecated="true"> |
| 1001 | + [i]Deprecated.[/i] Use [constant DRIVER_RESOURCE_TEXTURE_DATA_FORMAT]. |
| 1002 | + </constant> |
| 1003 | + <constant name="DRIVER_RESOURCE_VULKAN_SAMPLER" value="8" enum="DriverResource" is_deprecated="true"> |
| 1004 | + [i]Deprecated.[/i] Use [constant DRIVER_RESOURCE_SAMPLER]. |
| 1005 | + </constant> |
| 1006 | + <constant name="DRIVER_RESOURCE_VULKAN_DESCRIPTOR_SET" value="9" enum="DriverResource" is_deprecated="true"> |
| 1007 | + [i]Deprecated.[/i] Use [constant DRIVER_RESOURCE_UNIFORM_SET]. |
| 1008 | + </constant> |
| 1009 | + <constant name="DRIVER_RESOURCE_VULKAN_BUFFER" value="10" enum="DriverResource" is_deprecated="true"> |
| 1010 | + [i]Deprecated.[/i] Use [constant DRIVER_RESOURCE_BUFFER]. |
| 1011 | + </constant> |
| 1012 | + <constant name="DRIVER_RESOURCE_VULKAN_COMPUTE_PIPELINE" value="11" enum="DriverResource" is_deprecated="true"> |
| 1013 | + [i]Deprecated.[/i] Use [constant DRIVER_RESOURCE_COMPUTE_PIPELINE]. |
| 1014 | + </constant> |
| 1015 | + <constant name="DRIVER_RESOURCE_VULKAN_RENDER_PIPELINE" value="12" enum="DriverResource" is_deprecated="true"> |
| 1016 | + [i]Deprecated.[/i] Use [constant DRIVER_RESOURCE_RENDER_PIPELINE]. |
969 | 1017 | </constant> |
970 | 1018 | <constant name="DATA_FORMAT_R4G4_UNORM_PACK8" value="0" enum="DataFormat"> |
971 | 1019 | 4-bit-per-channel red/green channel data format, packed into 8 bits. Values are in the [code][0.0, 1.0][/code] range. |
|
0 commit comments