mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-01-12 15:04:10 +00:00
85184f305a
* Bump API patch number and header version number to 25 for this update.
* Structurally change the specification so that multiple extensions are
included in the +1.0+ git branch, and specifications will include or not
include those extensions at build time based on options passed to the
Makefile. See +doc/specs/vulkan/README.html+ and the ``Layers and
Extensions'' section of the ``Vulkan Documentation and Extensions''
document for more information on this change.
* Register and publish new extensions in the single-branch form:
** +VK_NV_external_memory_capabilities+
** +VK_NV_external_memory+
** +VK_NV_external_memory_win32+
** +VK_NV_win32_keyed_mutex+
Github Issues:
* Clarify description of GetInstanceProcAddr and GetDeviceProcAddr (public
issue 212).
* Add SPIR-V <<textures-operation-validation, instruction validation>> for
single-sampled images (public issue 316).
* Fix spelling of ``tesselation'' in a few places and note it as an
exception to the American spelling rules convention (public issue
327).
* Fix Makefile to create output directory for ``styleguide''
target (public issue 329).
* Fix numerous minor issues with incorrectly tags on enumerant names and
table titles (public issue 330).
* Generate specversion.txt date in UTC time and RFC 2822 format
(public issue 335).
* Convert link to the SPIR-V Specification for
flink:VkShaderModuleCreateInfo into an internal link to the normative
reference (public issue 336).
* Add ename:VK_ERROR_OUT_OF_MEMORY error code to
flink:vkCreateDebugReportCallbackEXT (public issue 337).
Internal Issues:
* Update style guide regarding use of code:NULL and dname:VK_NULL_HANDLE
(internal issue 393).
* Change the definition of latexmath:[$q$] in the
<<textures-image-level-selection,texture image level selection>> section
to be the index of the maximum defined level for the view, not the
number of levels in the view (internal issue 406).
* Allow developers to override dname:VK_DEFINE_NON_DISPATCHABLE_HANDLE
with their own binary-compatible definition (internal issue 439).
* Fix +vk_platform.h+ conditional logic causing compile failure with some
Android compilers (internal issue 441).
* Implement the single-branch model as described above (internal issue
461).
Other Issues:
135 lines
4.5 KiB
Plaintext
135 lines
4.5 KiB
Plaintext
// Copyright (c) 2014-2016 Khronos Group. This work is licensed under a
|
|
// Creative Commons Attribution 4.0 International License; see
|
|
// http://creativecommons.org/licenses/by/4.0/
|
|
|
|
VkResult(3)
|
|
===========
|
|
|
|
Name
|
|
----
|
|
VkResult - Vulkan command return codes
|
|
|
|
C Specification
|
|
---------------
|
|
|
|
// refBegin VkResult Vulkan command return codes
|
|
|
|
While the core Vulkan API is not designed to capture incorrect usage,
|
|
some circumstances still require return codes. Commands in Vulkan return
|
|
their status via return codes that are in one of two categories:
|
|
|
|
* Successful completion codes are returned when a command needs to
|
|
communicate success or status information. All successful completion
|
|
codes are non-negative values.
|
|
* Run time error codes are returned when a command needs to communicate a
|
|
failure that could only be detected at run time. All run time error
|
|
codes are negative values.
|
|
|
|
All return codes in Vulkan are reported via basetype:VkResult return
|
|
values. The possible codes are:
|
|
|
|
include::../api/enums/VkResult.txt[]
|
|
|
|
|
|
Description
|
|
-----------
|
|
|
|
[[fundamentals-successcodes]]
|
|
.Success codes
|
|
* ename:VK_SUCCESS
|
|
Command successfully completed
|
|
* ename:VK_NOT_READY
|
|
A fence or query has not yet completed
|
|
* ename:VK_TIMEOUT
|
|
A wait operation has not completed in the specified time
|
|
* ename:VK_EVENT_SET
|
|
An event is signaled
|
|
* ename:VK_EVENT_RESET
|
|
An event is unsignaled
|
|
* ename:VK_INCOMPLETE
|
|
A return array was too small for the result
|
|
ifdef::VK_KHR_swapchain[]
|
|
include::../chapters/VK_KHR_swapchain/VkResultSuccessDescriptions_swapchain.txt[]
|
|
endif::VK_KHR_swapchain[]
|
|
|
|
[[fundamentals-errorcodes]]
|
|
.Error codes
|
|
* ename:VK_ERROR_OUT_OF_HOST_MEMORY
|
|
A host memory allocation has failed.
|
|
* ename:VK_ERROR_OUT_OF_DEVICE_MEMORY
|
|
A device memory allocation has failed.
|
|
* ename:VK_ERROR_INITIALIZATION_FAILED
|
|
Initialization of an object could not be completed for
|
|
implementation-specific reasons.
|
|
* ename:VK_ERROR_DEVICE_LOST
|
|
The logical or physical device has been lost. See
|
|
<<devsandqueues-lost-device,Lost Device>>
|
|
* ename:VK_ERROR_MEMORY_MAP_FAILED
|
|
Mapping of a memory object has failed.
|
|
* ename:VK_ERROR_LAYER_NOT_PRESENT
|
|
A requested layer is not present or could not be loaded.
|
|
* ename:VK_ERROR_EXTENSION_NOT_PRESENT
|
|
A requested extension is not supported.
|
|
* ename:VK_ERROR_FEATURE_NOT_PRESENT
|
|
A requested feature is not supported.
|
|
* ename:VK_ERROR_INCOMPATIBLE_DRIVER
|
|
The requested version of Vulkan is not supported by the driver or
|
|
is otherwise incompatible for implementation-specific reasons.
|
|
* ename:VK_ERROR_TOO_MANY_OBJECTS
|
|
Too many objects of the type have already been created.
|
|
* ename:VK_ERROR_FORMAT_NOT_SUPPORTED
|
|
A requested format is not supported on this device.
|
|
* ename:VK_ERROR_FRAGMENTED_POOL
|
|
A requested pool allocation has failed due to fragmentation of the
|
|
pool's memory.
|
|
ifdef::VK_KHR_surface[]
|
|
include::../chapters/VK_KHR_surface/VkResultErrorDescriptions_surface.txt[]
|
|
endif::VK_KHR_surface[]
|
|
ifdef::VK_KHR_swapchain[]
|
|
include::../chapters/VK_KHR_swapchain/VkResultErrorDescriptions_swapchain.txt[]
|
|
endif::VK_KHR_swapchain[]
|
|
ifdef::VK_KHR_display_swapchain[]
|
|
include::../chapters/VK_KHR_display_swapchain/VkResultErrorDescriptions_display_swapchain.txt[]
|
|
endif::VK_KHR_display_swapchain[]
|
|
ifdef::VK_NV_glsl_shader[]
|
|
* ename:VK_ERROR_INVALID_SHADER_NV
|
|
One or more shaders failed to compile or link. More details are
|
|
reported back to the application via pname:VK_EXT_debug_report
|
|
if enabled.
|
|
endif::VK_NV_glsl_shader[]
|
|
|
|
If a command returns a run time error, it will leave any result pointers
|
|
unmodified, unless other behavior is explicitly defined in the specification.
|
|
|
|
Out of memory errors do not damage any currently existing Vulkan objects.
|
|
Objects that have already been successfully created can: still be used by
|
|
the application.
|
|
|
|
Performance-critical commands generally do not have return codes. If a run
|
|
time error occurs in such commands, the implementation will defer reporting
|
|
the error until a specified point. For commands that record into
|
|
command buffers (ftext:vkCmd*) run time errors are reported by
|
|
fname:vkEndCommandBuffer.
|
|
|
|
// refEnd VkResult TBD
|
|
|
|
|
|
See Also
|
|
--------
|
|
|
|
No cross-references are available
|
|
|
|
|
|
Document Notes
|
|
--------------
|
|
|
|
For more information, see the Vulkan Specification at URL
|
|
|
|
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#VkResult
|
|
|
|
This page is extracted from the Vulkan Specification.
|
|
Fixes and changes should be made to the Specification,not directly.
|
|
|
|
include::footer.txt[]
|
|
|