| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Vulkan.Extensions.VK_EXT_metal_surface
Description
Name
VK_EXT_metal_surface - instance extension
VK_EXT_metal_surface
- Name String
VK_EXT_metal_surface
- Extension Type
- Instance extension
- Registered Extension Number
- 218
- Revision
- 1
- Extension and Version Dependencies
- Requires Vulkan 1.0
- Requires
VK_KHR_surface
- Contact
Other Extension Metadata
- Last Modified Date
- 2018-10-01
- IP Status
- No known IP claims.
- Contributors
- Dzmitry Malyshau, Mozilla Corp.
Description
The VK_EXT_metal_surface extension is an instance extension. It
provides a mechanism to create a SurfaceKHR
object (defined by the VK_KHR_surface extension) from CAMetalLayer,
which is the native rendering surface of Apple’s Metal framework.
New Base Types
New Commands
New Structures
New Bitmasks
New Enum Constants
Version History
Revision 1, 2018-10-01 (Dzmitry Malyshau)
- Initial version
See Also
CAMetalLayer, MetalSurfaceCreateFlagsEXT,
MetalSurfaceCreateInfoEXT, createMetalSurfaceEXT
Document Notes
For more information, see the Vulkan Specification
This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.
Synopsis
- createMetalSurfaceEXT :: forall io. MonadIO io => Instance -> MetalSurfaceCreateInfoEXT -> ("allocator" ::: Maybe AllocationCallbacks) -> io SurfaceKHR
- data MetalSurfaceCreateInfoEXT = MetalSurfaceCreateInfoEXT {}
- newtype MetalSurfaceCreateFlagsEXT = MetalSurfaceCreateFlagsEXT Flags
- type EXT_METAL_SURFACE_SPEC_VERSION = 1
- pattern EXT_METAL_SURFACE_SPEC_VERSION :: forall a. Integral a => a
- type EXT_METAL_SURFACE_EXTENSION_NAME = "VK_EXT_metal_surface"
- pattern EXT_METAL_SURFACE_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a
- data CAMetalLayer
- newtype SurfaceKHR = SurfaceKHR Word64
Documentation
createMetalSurfaceEXT Source #
Arguments
| :: forall io. MonadIO io | |
| => Instance |
|
| -> MetalSurfaceCreateInfoEXT |
|
| -> ("allocator" ::: Maybe AllocationCallbacks) |
|
| -> io SurfaceKHR |
vkCreateMetalSurfaceEXT - Create a VkSurfaceKHR object for CAMetalLayer
Valid Usage (Implicit)
-
instancemust be a validInstancehandle
-
pCreateInfomust be a valid pointer to a validMetalSurfaceCreateInfoEXTstructure - If
pAllocatoris notNULL,pAllocatormust be a valid pointer to a validAllocationCallbacksstructure -
pSurfacemust be a valid pointer to aSurfaceKHRhandle
Return Codes
See Also
AllocationCallbacks,
Instance, MetalSurfaceCreateInfoEXT,
SurfaceKHR
data MetalSurfaceCreateInfoEXT Source #
VkMetalSurfaceCreateInfoEXT - Structure specifying parameters of a newly created Metal surface object
Valid Usage (Implicit)
See Also
MetalSurfaceCreateFlagsEXT,
StructureType,
createMetalSurfaceEXT
Constructors
| MetalSurfaceCreateInfoEXT | |
Fields
| |
Instances
newtype MetalSurfaceCreateFlagsEXT Source #
VkMetalSurfaceCreateFlagsEXT - Reserved for future use
Description
MetalSurfaceCreateFlagsEXT is a bitmask type for setting a mask, but
is currently reserved for future use.
See Also
Constructors
| MetalSurfaceCreateFlagsEXT Flags |
Instances
type EXT_METAL_SURFACE_SPEC_VERSION = 1 Source #
pattern EXT_METAL_SURFACE_SPEC_VERSION :: forall a. Integral a => a Source #
type EXT_METAL_SURFACE_EXTENSION_NAME = "VK_EXT_metal_surface" Source #
pattern EXT_METAL_SURFACE_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a Source #
data CAMetalLayer Source #
newtype SurfaceKHR Source #
VkSurfaceKHR - Opaque handle to a surface object
Description
The VK_KHR_surface extension declares the SurfaceKHR object, and
provides a function for destroying SurfaceKHR objects. Separate
platform-specific extensions each provide a function for creating a
SurfaceKHR object for the respective platform. From the application’s
perspective this is an opaque handle, just like the handles of other
Vulkan objects.
See Also
PhysicalDeviceSurfaceInfo2KHR,
SwapchainCreateInfoKHR,
createAndroidSurfaceKHR,
createDirectFBSurfaceEXT,
createDisplayPlaneSurfaceKHR,
createHeadlessSurfaceEXT,
createIOSSurfaceMVK,
createImagePipeSurfaceFUCHSIA,
createMacOSSurfaceMVK,
createMetalSurfaceEXT,
createStreamDescriptorSurfaceGGP,
createViSurfaceNN,
createWaylandSurfaceKHR,
createWin32SurfaceKHR,
createXcbSurfaceKHR,
createXlibSurfaceKHR,
destroySurfaceKHR,
getDeviceGroupSurfacePresentModesKHR,
getPhysicalDevicePresentRectanglesKHR,
getPhysicalDeviceSurfaceCapabilities2EXT,
getPhysicalDeviceSurfaceCapabilitiesKHR,
getPhysicalDeviceSurfaceFormatsKHR,
getPhysicalDeviceSurfacePresentModesKHR,
getPhysicalDeviceSurfaceSupportKHR
Constructors
| SurfaceKHR Word64 |