Vulkan.Extensions.VK_KHR_android_surface

Documentation

createAndroidSurfaceKHR

Arguments

:: forall io. MonadIO io

=> Instance

instance is the instance to associate the surface with.

-> AndroidSurfaceCreateInfoKHR

pCreateInfo is a pointer to a AndroidSurfaceCreateInfoKHR structure containing parameters affecting the creation of the surface object.

-> ("allocator" ::: Maybe AllocationCallbacks)

pAllocator is the allocator used for host memory allocated for the surface object when there is no more specific allocator available (see Memory Allocation).

-> io SurfaceKHR

vkCreateAndroidSurfaceKHR - Create a SurfaceKHR object for an Android native window

Description

During the lifetime of a surface created using a particular ANativeWindow handle any attempts to create another surface for the same ANativeWindow and any attempts to connect to the same ANativeWindow through other platform mechanisms will fail.

Note

In particular, only one SurfaceKHR can exist at a time for a given window. Similarly, a native window cannot be used by both a SurfaceKHR and EGLSurface simultaneously.

If successful, createAndroidSurfaceKHR increments the ANativeWindow’s reference count, and destroySurfaceKHR will decrement it.

On Android, when a swapchain’s imageExtent does not match the surface’s currentExtent, the presentable images will be scaled to the surface’s dimensions during presentation. minImageExtent is (1,1), and maxImageExtent is the maximum image size supported by the consumer. For the system compositor, currentExtent is the window size (i.e. the consumer’s preferred size).

Valid Usage (Implicit)

• instance must be a valid Instance handle

• pCreateInfo must be a valid pointer to a valid AndroidSurfaceCreateInfoKHR structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pSurface must be a valid pointer to a SurfaceKHR handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_NATIVE_WINDOW_IN_USE_KHR

See Also

AllocationCallbacks, AndroidSurfaceCreateInfoKHR, Instance, SurfaceKHR

data AndroidSurfaceCreateInfoKHR

VkAndroidSurfaceCreateInfoKHR - Structure specifying parameters of a newly created Android surface object

Valid Usage (Implicit)

See Also

AndroidSurfaceCreateFlagsKHR, StructureType, createAndroidSurfaceKHR

Constructors

AndroidSurfaceCreateInfoKHR

Fields

• flags :: AndroidSurfaceCreateFlagsKHR

  flags is reserved for future use.

  flags must be 0

• window :: Ptr ANativeWindow

  window is a pointer to the ANativeWindow to associate the surface with.

  window must point to a valid Android ANativeWindow

Instances

Eq AndroidSurfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_android_surface

Methods

(==) :: AndroidSurfaceCreateInfoKHR -> AndroidSurfaceCreateInfoKHR -> Bool

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

Show AndroidSurfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_android_surface

Methods

showsPrec :: Int -> AndroidSurfaceCreateInfoKHR -> ShowS

show :: AndroidSurfaceCreateInfoKHR -> String

showList :: [AndroidSurfaceCreateInfoKHR] -> ShowS

Generic AndroidSurfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_android_surface

Associated Types

type Rep AndroidSurfaceCreateInfoKHR :: Type -> Type

Methods

from :: AndroidSurfaceCreateInfoKHR -> Rep AndroidSurfaceCreateInfoKHR x

to :: Rep AndroidSurfaceCreateInfoKHR x -> AndroidSurfaceCreateInfoKHR

Storable AndroidSurfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_android_surface

Methods

sizeOf :: AndroidSurfaceCreateInfoKHR -> Int

alignment :: AndroidSurfaceCreateInfoKHR -> Int

peekElemOff :: Ptr AndroidSurfaceCreateInfoKHR -> Int -> IO AndroidSurfaceCreateInfoKHR

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

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

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

peek :: Ptr AndroidSurfaceCreateInfoKHR -> IO AndroidSurfaceCreateInfoKHR

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

FromCStruct AndroidSurfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_android_surface

Methods

peekCStruct :: Ptr AndroidSurfaceCreateInfoKHR -> IO AndroidSurfaceCreateInfoKHR

ToCStruct AndroidSurfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_android_surface

Methods

withCStruct :: AndroidSurfaceCreateInfoKHR -> (Ptr AndroidSurfaceCreateInfoKHR -> IO b) -> IO b

pokeCStruct :: Ptr AndroidSurfaceCreateInfoKHR -> AndroidSurfaceCreateInfoKHR -> IO b -> IO b

withZeroCStruct :: (Ptr AndroidSurfaceCreateInfoKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr AndroidSurfaceCreateInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero AndroidSurfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_android_surface

Methods

zero :: AndroidSurfaceCreateInfoKHR

type Rep AndroidSurfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_android_surface

type Rep AndroidSurfaceCreateInfoKHR = D1 ('MetaData "AndroidSurfaceCreateInfoKHR" "Vulkan.Extensions.VK_KHR_android_surface" "vulkan-3.4-inplace" 'False) (C1 ('MetaCons "AndroidSurfaceCreateInfoKHR" 'PrefixI 'True) (S1 ('MetaSel ('Just "flags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AndroidSurfaceCreateFlagsKHR) :*: S1 ('MetaSel ('Just "window") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Ptr ANativeWindow))))

newtype AndroidSurfaceCreateFlagsKHR

VkAndroidSurfaceCreateFlagsKHR - Reserved for future use

Description

AndroidSurfaceCreateFlagsKHR is a bitmask type for setting a mask, but is currently reserved for future use.

See Also

AndroidSurfaceCreateInfoKHR

Constructors

AndroidSurfaceCreateFlagsKHR Flags

Instances

Eq AndroidSurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_android_surface

Methods

(==) :: AndroidSurfaceCreateFlagsKHR -> AndroidSurfaceCreateFlagsKHR -> Bool

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

Ord AndroidSurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_android_surface

Methods

compare :: AndroidSurfaceCreateFlagsKHR -> AndroidSurfaceCreateFlagsKHR -> Ordering

(<) :: AndroidSurfaceCreateFlagsKHR -> AndroidSurfaceCreateFlagsKHR -> Bool

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

(>) :: AndroidSurfaceCreateFlagsKHR -> AndroidSurfaceCreateFlagsKHR -> Bool

(>=) :: AndroidSurfaceCreateFlagsKHR -> AndroidSurfaceCreateFlagsKHR -> Bool

max :: AndroidSurfaceCreateFlagsKHR -> AndroidSurfaceCreateFlagsKHR -> AndroidSurfaceCreateFlagsKHR

min :: AndroidSurfaceCreateFlagsKHR -> AndroidSurfaceCreateFlagsKHR -> AndroidSurfaceCreateFlagsKHR

Read AndroidSurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_android_surface

Methods

readsPrec :: Int -> ReadS AndroidSurfaceCreateFlagsKHR

readList :: ReadS [AndroidSurfaceCreateFlagsKHR]

readPrec :: ReadPrec AndroidSurfaceCreateFlagsKHR

readListPrec :: ReadPrec [AndroidSurfaceCreateFlagsKHR]

Show AndroidSurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_android_surface

Methods

showsPrec :: Int -> AndroidSurfaceCreateFlagsKHR -> ShowS

show :: AndroidSurfaceCreateFlagsKHR -> String

showList :: [AndroidSurfaceCreateFlagsKHR] -> ShowS

Storable AndroidSurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_android_surface

Methods

sizeOf :: AndroidSurfaceCreateFlagsKHR -> Int

alignment :: AndroidSurfaceCreateFlagsKHR -> Int

peekElemOff :: Ptr AndroidSurfaceCreateFlagsKHR -> Int -> IO AndroidSurfaceCreateFlagsKHR

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

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

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

peek :: Ptr AndroidSurfaceCreateFlagsKHR -> IO AndroidSurfaceCreateFlagsKHR

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

Bits AndroidSurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_android_surface

Methods

(.&.) :: AndroidSurfaceCreateFlagsKHR -> AndroidSurfaceCreateFlagsKHR -> AndroidSurfaceCreateFlagsKHR

(.|.) :: AndroidSurfaceCreateFlagsKHR -> AndroidSurfaceCreateFlagsKHR -> AndroidSurfaceCreateFlagsKHR

xor :: AndroidSurfaceCreateFlagsKHR -> AndroidSurfaceCreateFlagsKHR -> AndroidSurfaceCreateFlagsKHR

complement :: AndroidSurfaceCreateFlagsKHR -> AndroidSurfaceCreateFlagsKHR

shift :: AndroidSurfaceCreateFlagsKHR -> Int -> AndroidSurfaceCreateFlagsKHR

rotate :: AndroidSurfaceCreateFlagsKHR -> Int -> AndroidSurfaceCreateFlagsKHR

zeroBits :: AndroidSurfaceCreateFlagsKHR

bit :: Int -> AndroidSurfaceCreateFlagsKHR

setBit :: AndroidSurfaceCreateFlagsKHR -> Int -> AndroidSurfaceCreateFlagsKHR

clearBit :: AndroidSurfaceCreateFlagsKHR -> Int -> AndroidSurfaceCreateFlagsKHR

complementBit :: AndroidSurfaceCreateFlagsKHR -> Int -> AndroidSurfaceCreateFlagsKHR

testBit :: AndroidSurfaceCreateFlagsKHR -> Int -> Bool

bitSizeMaybe :: AndroidSurfaceCreateFlagsKHR -> Maybe Int

bitSize :: AndroidSurfaceCreateFlagsKHR -> Int

isSigned :: AndroidSurfaceCreateFlagsKHR -> Bool

shiftL :: AndroidSurfaceCreateFlagsKHR -> Int -> AndroidSurfaceCreateFlagsKHR

unsafeShiftL :: AndroidSurfaceCreateFlagsKHR -> Int -> AndroidSurfaceCreateFlagsKHR

shiftR :: AndroidSurfaceCreateFlagsKHR -> Int -> AndroidSurfaceCreateFlagsKHR

unsafeShiftR :: AndroidSurfaceCreateFlagsKHR -> Int -> AndroidSurfaceCreateFlagsKHR

rotateL :: AndroidSurfaceCreateFlagsKHR -> Int -> AndroidSurfaceCreateFlagsKHR

rotateR :: AndroidSurfaceCreateFlagsKHR -> Int -> AndroidSurfaceCreateFlagsKHR

popCount :: AndroidSurfaceCreateFlagsKHR -> Int

Zero AndroidSurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_android_surface

Methods

zero :: AndroidSurfaceCreateFlagsKHR

type KHR_ANDROID_SURFACE_SPEC_VERSION = 6

pattern KHR_ANDROID_SURFACE_SPEC_VERSION :: forall a. Integral a => a

type KHR_ANDROID_SURFACE_EXTENSION_NAME = "VK_KHR_android_surface"

pattern KHR_ANDROID_SURFACE_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

data ANativeWindow

newtype SurfaceKHR

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, createDisplayPlaneSurfaceKHR, createHeadlessSurfaceEXT, createIOSSurfaceMVK, createImagePipeSurfaceFUCHSIA, createMacOSSurfaceMVK, createMetalSurfaceEXT, createStreamDescriptorSurfaceGGP, createViSurfaceNN, createWaylandSurfaceKHR, createWin32SurfaceKHR, createXcbSurfaceKHR, createXlibSurfaceKHR, destroySurfaceKHR, getDeviceGroupSurfacePresentModesKHR, getPhysicalDevicePresentRectanglesKHR, getPhysicalDeviceSurfaceCapabilities2EXT, getPhysicalDeviceSurfaceCapabilitiesKHR, getPhysicalDeviceSurfaceFormatsKHR, getPhysicalDeviceSurfacePresentModesKHR, getPhysicalDeviceSurfaceSupportKHR

Constructors

SurfaceKHR Word64

Instances

Eq SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

(==) :: SurfaceKHR -> SurfaceKHR -> Bool

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

Ord SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

compare :: SurfaceKHR -> SurfaceKHR -> Ordering

(<) :: SurfaceKHR -> SurfaceKHR -> Bool

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

(>) :: SurfaceKHR -> SurfaceKHR -> Bool

(>=) :: SurfaceKHR -> SurfaceKHR -> Bool

max :: SurfaceKHR -> SurfaceKHR -> SurfaceKHR

min :: SurfaceKHR -> SurfaceKHR -> SurfaceKHR

Show SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

showsPrec :: Int -> SurfaceKHR -> ShowS

show :: SurfaceKHR -> String

showList :: [SurfaceKHR] -> ShowS

Storable SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

sizeOf :: SurfaceKHR -> Int

alignment :: SurfaceKHR -> Int

peekElemOff :: Ptr SurfaceKHR -> Int -> IO SurfaceKHR

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

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

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

peek :: Ptr SurfaceKHR -> IO SurfaceKHR

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

Zero SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

zero :: SurfaceKHR

HasObjectType SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

objectTypeAndHandle :: SurfaceKHR -> (ObjectType, Word64)

IsHandle SurfaceKHR

Defined in Vulkan.Extensions.Handles