vulkan-2.1.0.0: Bindings to the Vulkan graphics API.

Safe HaskellNone
LanguageHaskell2010

Graphics.Vulkan.Extensions.VK_NN_vi_surface

Synopsis

Documentation

newtype VkViSurfaceCreateFlagsNN Source #

Instances
Eq VkViSurfaceCreateFlagsNN Source # 
Instance details
Ord VkViSurfaceCreateFlagsNN Source # 
Instance details
Read VkViSurfaceCreateFlagsNN Source # 
Instance details
Show VkViSurfaceCreateFlagsNN Source # 
Instance details
Storable VkViSurfaceCreateFlagsNN Source # 
Instance details
Bits VkViSurfaceCreateFlagsNN Source # 
Instance details
FiniteBits VkViSurfaceCreateFlagsNN Source # 
Instance details

vkCreateViSurfaceNN :: ("instance" ::: VkInstance) -> ("pCreateInfo" ::: Ptr VkViSurfaceCreateInfoNN) -> ("pAllocator" ::: Ptr VkAllocationCallbacks) -> ("pSurface" ::: Ptr VkSurfaceKHR) -> IO VkResult Source #

vkCreateViSurfaceNN - Create a VkSurfaceKHR object for a VI layer

Parameters

  • instance is the instance with which to associate the surface.
  • pCreateInfo is a pointer to an instance of the VkViSurfaceCreateInfoNN structure containing parameters affecting the creation of the surface object.
  • pAllocator is the allocator used for host memory allocated for the surface object when there is no more specific allocator available (see Memory Allocation).
  • pSurface points to a VkSurfaceKHR handle in which the created surface object is returned.

Description

During the lifetime of a surface created using a particular nn::vi::NativeWindowHandle any attempts to create another surface for the same nn::vi::Layer and any attempts to connect to the same nn::vi::Layer through other platform mechanisms will have undefined results.

The currentExtent of a VI surface is always undefined. Applications are expected to choose an appropriate size for the swapchain’s imageExtent (e.g., by matching the the result of a call to nn::vi::GetDisplayResolution).

Valid Usage (Implicit)

  • instance must be a valid VkInstance handle
  • pCreateInfo must be a valid pointer to a valid VkViSurfaceCreateInfoNN structure
  • If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
  • pSurface must be a valid pointer to a VkSurfaceKHR handle

Return Codes

[Success] - VK_SUCCESS

[Failure] - VK_ERROR_OUT_OF_HOST_MEMORY

  • VK_ERROR_OUT_OF_DEVICE_MEMORY
  • VK_ERROR_NATIVE_WINDOW_IN_USE_KHR

See Also

VkAllocationCallbacks, VkInstance, VkSurfaceKHR, VkViSurfaceCreateInfoNN

data VkViSurfaceCreateInfoNN Source #

VkViSurfaceCreateInfoNN - Structure specifying parameters of a newly created VI surface object

Valid Usage

  • window must be a valid nn::vi::NativeWindowHandle

Valid Usage (Implicit)

  • sType must be VK_STRUCTURE_TYPE_VI_SURFACE_CREATE_INFO_NN
  • pNext must be NULL
  • flags must be 0

See Also

VkStructureType, VkViSurfaceCreateFlagsNN, vkCreateViSurfaceNN

Constructors

VkViSurfaceCreateInfoNN 

Fields