Vulkan-Docs/doc/specs/vulkan/man/VkFlags.txt

54 lines
1.2 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/
VkFlags(3)
==========
Name
----
VkFlags - Vulkan bitmasks
C Specification
---------------
// refBegin VkFlags - Vulkan bitmasks
A collection of flags is represented by a bitmask using the type
basetype:VkFlags:
include::../api/basetypes/VkFlags.txt[]
Description
-----------
Bitmasks are passed to many commands and structures to compactly represent
options, but basetype:VkFlags is not used directly in the API. Instead, a
etext:Vk*Flags type which is an alias of basetype:VkFlags, and whose name
matches the corresponding etext:Vk*FlagBits that are valid for that type, is
used. These aliases are described in the <<boilerplate-flags,Flag Types>>
appendix of the Specification.
// refEnd VkFlags VkColorComponentFlags
See Also
--------
elink:VkColorComponentFlags
Document Notes
--------------
For more information, see the Vulkan Specification at URL
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#VkFlags
This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.
include::footer.txt[]