Graphics.Vulkan.Extensions.VK_NN_vi_surface

Documentation

newtype VkViSurfaceCreateFlagsNN

Constructors

VkViSurfaceCreateFlagsNN VkFlags

Instances

Eq VkViSurfaceCreateFlagsNN

Methods

(==) :: VkViSurfaceCreateFlagsNN -> VkViSurfaceCreateFlagsNN -> Bool

(/=) :: VkViSurfaceCreateFlagsNN -> VkViSurfaceCreateFlagsNN -> Bool

Ord VkViSurfaceCreateFlagsNN

Methods

compare :: VkViSurfaceCreateFlagsNN -> VkViSurfaceCreateFlagsNN -> Ordering

(<) :: VkViSurfaceCreateFlagsNN -> VkViSurfaceCreateFlagsNN -> Bool

(<=) :: VkViSurfaceCreateFlagsNN -> VkViSurfaceCreateFlagsNN -> Bool

(>) :: VkViSurfaceCreateFlagsNN -> VkViSurfaceCreateFlagsNN -> Bool

(>=) :: VkViSurfaceCreateFlagsNN -> VkViSurfaceCreateFlagsNN -> Bool

max :: VkViSurfaceCreateFlagsNN -> VkViSurfaceCreateFlagsNN -> VkViSurfaceCreateFlagsNN

min :: VkViSurfaceCreateFlagsNN -> VkViSurfaceCreateFlagsNN -> VkViSurfaceCreateFlagsNN

Read VkViSurfaceCreateFlagsNN

Methods

readsPrec :: Int -> ReadS VkViSurfaceCreateFlagsNN

readList :: ReadS [VkViSurfaceCreateFlagsNN]

readPrec :: ReadPrec VkViSurfaceCreateFlagsNN

readListPrec :: ReadPrec [VkViSurfaceCreateFlagsNN]

Show VkViSurfaceCreateFlagsNN

Methods

showsPrec :: Int -> VkViSurfaceCreateFlagsNN -> ShowS

show :: VkViSurfaceCreateFlagsNN -> String

showList :: [VkViSurfaceCreateFlagsNN] -> ShowS

Storable VkViSurfaceCreateFlagsNN

Methods

sizeOf :: VkViSurfaceCreateFlagsNN -> Int

alignment :: VkViSurfaceCreateFlagsNN -> Int

peekElemOff :: Ptr VkViSurfaceCreateFlagsNN -> Int -> IO VkViSurfaceCreateFlagsNN

pokeElemOff :: Ptr VkViSurfaceCreateFlagsNN -> Int -> VkViSurfaceCreateFlagsNN -> IO ()

peekByteOff :: Ptr b -> Int -> IO VkViSurfaceCreateFlagsNN

pokeByteOff :: Ptr b -> Int -> VkViSurfaceCreateFlagsNN -> IO ()

peek :: Ptr VkViSurfaceCreateFlagsNN -> IO VkViSurfaceCreateFlagsNN

poke :: Ptr VkViSurfaceCreateFlagsNN -> VkViSurfaceCreateFlagsNN -> IO ()

Bits VkViSurfaceCreateFlagsNN

Methods

(.&.) :: VkViSurfaceCreateFlagsNN -> VkViSurfaceCreateFlagsNN -> VkViSurfaceCreateFlagsNN

(.|.) :: VkViSurfaceCreateFlagsNN -> VkViSurfaceCreateFlagsNN -> VkViSurfaceCreateFlagsNN

xor :: VkViSurfaceCreateFlagsNN -> VkViSurfaceCreateFlagsNN -> VkViSurfaceCreateFlagsNN

complement :: VkViSurfaceCreateFlagsNN -> VkViSurfaceCreateFlagsNN

shift :: VkViSurfaceCreateFlagsNN -> Int -> VkViSurfaceCreateFlagsNN

rotate :: VkViSurfaceCreateFlagsNN -> Int -> VkViSurfaceCreateFlagsNN

zeroBits :: VkViSurfaceCreateFlagsNN

bit :: Int -> VkViSurfaceCreateFlagsNN

setBit :: VkViSurfaceCreateFlagsNN -> Int -> VkViSurfaceCreateFlagsNN

clearBit :: VkViSurfaceCreateFlagsNN -> Int -> VkViSurfaceCreateFlagsNN

complementBit :: VkViSurfaceCreateFlagsNN -> Int -> VkViSurfaceCreateFlagsNN

testBit :: VkViSurfaceCreateFlagsNN -> Int -> Bool

bitSizeMaybe :: VkViSurfaceCreateFlagsNN -> Maybe Int

bitSize :: VkViSurfaceCreateFlagsNN -> Int

isSigned :: VkViSurfaceCreateFlagsNN -> Bool

shiftL :: VkViSurfaceCreateFlagsNN -> Int -> VkViSurfaceCreateFlagsNN

unsafeShiftL :: VkViSurfaceCreateFlagsNN -> Int -> VkViSurfaceCreateFlagsNN

shiftR :: VkViSurfaceCreateFlagsNN -> Int -> VkViSurfaceCreateFlagsNN

unsafeShiftR :: VkViSurfaceCreateFlagsNN -> Int -> VkViSurfaceCreateFlagsNN

rotateL :: VkViSurfaceCreateFlagsNN -> Int -> VkViSurfaceCreateFlagsNN

rotateR :: VkViSurfaceCreateFlagsNN -> Int -> VkViSurfaceCreateFlagsNN

popCount :: VkViSurfaceCreateFlagsNN -> Int

FiniteBits VkViSurfaceCreateFlagsNN

Methods

finiteBitSize :: VkViSurfaceCreateFlagsNN -> Int

countLeadingZeros :: VkViSurfaceCreateFlagsNN -> Int

countTrailingZeros :: VkViSurfaceCreateFlagsNN -> Int

pattern VK_STRUCTURE_TYPE_VI_SURFACE_CREATE_INFO_NN :: VkStructureType

pattern VK_NN_VI_SURFACE_SPEC_VERSION :: Integral a => a

pattern VK_NN_VI_SURFACE_EXTENSION_NAME :: (Eq a, IsString a) => a

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

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

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

• vkSType :: VkStructureType

  sType is the type of this structure.

• vkPNext :: Ptr ()

  pNext is NULL or a pointer to an extension-specific structure.

• vkFlags :: VkViSurfaceCreateFlagsNN

  flags is reserved for future use.

• vkWindow :: Ptr ()

  window is the nn::vi::NativeWindowHandle for the nn::vi::Layer with which to associate the surface.

Instances

Eq VkViSurfaceCreateInfoNN

Methods

(==) :: VkViSurfaceCreateInfoNN -> VkViSurfaceCreateInfoNN -> Bool

(/=) :: VkViSurfaceCreateInfoNN -> VkViSurfaceCreateInfoNN -> Bool

Show VkViSurfaceCreateInfoNN

Methods

showsPrec :: Int -> VkViSurfaceCreateInfoNN -> ShowS

show :: VkViSurfaceCreateInfoNN -> String

showList :: [VkViSurfaceCreateInfoNN] -> ShowS

Storable VkViSurfaceCreateInfoNN

Methods

sizeOf :: VkViSurfaceCreateInfoNN -> Int

alignment :: VkViSurfaceCreateInfoNN -> Int

peekElemOff :: Ptr VkViSurfaceCreateInfoNN -> Int -> IO VkViSurfaceCreateInfoNN

pokeElemOff :: Ptr VkViSurfaceCreateInfoNN -> Int -> VkViSurfaceCreateInfoNN -> IO ()

peekByteOff :: Ptr b -> Int -> IO VkViSurfaceCreateInfoNN

pokeByteOff :: Ptr b -> Int -> VkViSurfaceCreateInfoNN -> IO ()

peek :: Ptr VkViSurfaceCreateInfoNN -> IO VkViSurfaceCreateInfoNN

poke :: Ptr VkViSurfaceCreateInfoNN -> VkViSurfaceCreateInfoNN -> IO ()