Vulkan.Extensions.VK_GGP_stream_descriptor_surface

Documentation

createStreamDescriptorSurfaceGGP

Arguments

:: forall io. MonadIO io

=> Instance

instance is the instance to associate with the surface.

-> StreamDescriptorSurfaceCreateInfoGGP

pCreateInfo is a pointer to a StreamDescriptorSurfaceCreateInfoGGP structure containing parameters that affect 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

vkCreateStreamDescriptorSurfaceGGP - Create a SurfaceKHR object for a Google Games Platform stream

Valid Usage (Implicit)

• instance must be a valid Instance handle

• pCreateInfo must be a valid pointer to a valid StreamDescriptorSurfaceCreateInfoGGP 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, Instance, StreamDescriptorSurfaceCreateInfoGGP, SurfaceKHR

data StreamDescriptorSurfaceCreateInfoGGP

VkStreamDescriptorSurfaceCreateInfoGGP - Structure specifying parameters of a newly created Google Games Platform stream surface object

Valid Usage (Implicit)

See Also

StreamDescriptorSurfaceCreateFlagsGGP, StructureType, createStreamDescriptorSurfaceGGP

Constructors

StreamDescriptorSurfaceCreateInfoGGP

Fields

• flags :: StreamDescriptorSurfaceCreateFlagsGGP

  flags is reserved for future use.

  flags must be 0

• streamDescriptor :: GgpStreamDescriptor

  streamDescriptor is a GgpStreamDescriptor referring to the GGP stream descriptor to associate with the surface.

  streamDescriptor must be a valid GgpStreamDescriptor

Instances

Eq StreamDescriptorSurfaceCreateInfoGGP

Defined in Vulkan.Extensions.VK_GGP_stream_descriptor_surface

Methods

(==) :: StreamDescriptorSurfaceCreateInfoGGP -> StreamDescriptorSurfaceCreateInfoGGP -> Bool

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

Show StreamDescriptorSurfaceCreateInfoGGP

Defined in Vulkan.Extensions.VK_GGP_stream_descriptor_surface

Methods

showsPrec :: Int -> StreamDescriptorSurfaceCreateInfoGGP -> ShowS

show :: StreamDescriptorSurfaceCreateInfoGGP -> String

showList :: [StreamDescriptorSurfaceCreateInfoGGP] -> ShowS

Generic StreamDescriptorSurfaceCreateInfoGGP

Defined in Vulkan.Extensions.VK_GGP_stream_descriptor_surface

Associated Types

type Rep StreamDescriptorSurfaceCreateInfoGGP :: Type -> Type

Methods

from :: StreamDescriptorSurfaceCreateInfoGGP -> Rep StreamDescriptorSurfaceCreateInfoGGP x

to :: Rep StreamDescriptorSurfaceCreateInfoGGP x -> StreamDescriptorSurfaceCreateInfoGGP

Storable StreamDescriptorSurfaceCreateInfoGGP

Defined in Vulkan.Extensions.VK_GGP_stream_descriptor_surface

Methods

sizeOf :: StreamDescriptorSurfaceCreateInfoGGP -> Int

alignment :: StreamDescriptorSurfaceCreateInfoGGP -> Int

peekElemOff :: Ptr StreamDescriptorSurfaceCreateInfoGGP -> Int -> IO StreamDescriptorSurfaceCreateInfoGGP

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

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

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

peek :: Ptr StreamDescriptorSurfaceCreateInfoGGP -> IO StreamDescriptorSurfaceCreateInfoGGP

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

FromCStruct StreamDescriptorSurfaceCreateInfoGGP

Defined in Vulkan.Extensions.VK_GGP_stream_descriptor_surface

Methods

peekCStruct :: Ptr StreamDescriptorSurfaceCreateInfoGGP -> IO StreamDescriptorSurfaceCreateInfoGGP

ToCStruct StreamDescriptorSurfaceCreateInfoGGP

Defined in Vulkan.Extensions.VK_GGP_stream_descriptor_surface

Methods

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

pokeCStruct :: Ptr StreamDescriptorSurfaceCreateInfoGGP -> StreamDescriptorSurfaceCreateInfoGGP -> IO b -> IO b

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

pokeZeroCStruct :: Ptr StreamDescriptorSurfaceCreateInfoGGP -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero StreamDescriptorSurfaceCreateInfoGGP

Defined in Vulkan.Extensions.VK_GGP_stream_descriptor_surface

Methods

zero :: StreamDescriptorSurfaceCreateInfoGGP

type Rep StreamDescriptorSurfaceCreateInfoGGP

Defined in Vulkan.Extensions.VK_GGP_stream_descriptor_surface

type Rep StreamDescriptorSurfaceCreateInfoGGP = D1 ('MetaData "StreamDescriptorSurfaceCreateInfoGGP" "Vulkan.Extensions.VK_GGP_stream_descriptor_surface" "vulkan-3.5-inplace" 'False) (C1 ('MetaCons "StreamDescriptorSurfaceCreateInfoGGP" 'PrefixI 'True) (S1 ('MetaSel ('Just "flags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 StreamDescriptorSurfaceCreateFlagsGGP) :*: S1 ('MetaSel ('Just "streamDescriptor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GgpStreamDescriptor)))

newtype StreamDescriptorSurfaceCreateFlagsGGP

VkStreamDescriptorSurfaceCreateFlagsGGP - Reserved for future use

Description

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

See Also

StreamDescriptorSurfaceCreateInfoGGP

Constructors

StreamDescriptorSurfaceCreateFlagsGGP Flags

Instances

Eq StreamDescriptorSurfaceCreateFlagsGGP

Defined in Vulkan.Extensions.VK_GGP_stream_descriptor_surface

Methods

(==) :: StreamDescriptorSurfaceCreateFlagsGGP -> StreamDescriptorSurfaceCreateFlagsGGP -> Bool

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

Ord StreamDescriptorSurfaceCreateFlagsGGP

Defined in Vulkan.Extensions.VK_GGP_stream_descriptor_surface

Methods

compare :: StreamDescriptorSurfaceCreateFlagsGGP -> StreamDescriptorSurfaceCreateFlagsGGP -> Ordering

(<) :: StreamDescriptorSurfaceCreateFlagsGGP -> StreamDescriptorSurfaceCreateFlagsGGP -> Bool

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

(>) :: StreamDescriptorSurfaceCreateFlagsGGP -> StreamDescriptorSurfaceCreateFlagsGGP -> Bool

(>=) :: StreamDescriptorSurfaceCreateFlagsGGP -> StreamDescriptorSurfaceCreateFlagsGGP -> Bool

max :: StreamDescriptorSurfaceCreateFlagsGGP -> StreamDescriptorSurfaceCreateFlagsGGP -> StreamDescriptorSurfaceCreateFlagsGGP

min :: StreamDescriptorSurfaceCreateFlagsGGP -> StreamDescriptorSurfaceCreateFlagsGGP -> StreamDescriptorSurfaceCreateFlagsGGP

Read StreamDescriptorSurfaceCreateFlagsGGP

Defined in Vulkan.Extensions.VK_GGP_stream_descriptor_surface

Methods

readsPrec :: Int -> ReadS StreamDescriptorSurfaceCreateFlagsGGP

readList :: ReadS [StreamDescriptorSurfaceCreateFlagsGGP]

readPrec :: ReadPrec StreamDescriptorSurfaceCreateFlagsGGP

readListPrec :: ReadPrec [StreamDescriptorSurfaceCreateFlagsGGP]

Show StreamDescriptorSurfaceCreateFlagsGGP

Defined in Vulkan.Extensions.VK_GGP_stream_descriptor_surface

Methods

showsPrec :: Int -> StreamDescriptorSurfaceCreateFlagsGGP -> ShowS

show :: StreamDescriptorSurfaceCreateFlagsGGP -> String

showList :: [StreamDescriptorSurfaceCreateFlagsGGP] -> ShowS

Storable StreamDescriptorSurfaceCreateFlagsGGP

Defined in Vulkan.Extensions.VK_GGP_stream_descriptor_surface

Methods

sizeOf :: StreamDescriptorSurfaceCreateFlagsGGP -> Int

alignment :: StreamDescriptorSurfaceCreateFlagsGGP -> Int

peekElemOff :: Ptr StreamDescriptorSurfaceCreateFlagsGGP -> Int -> IO StreamDescriptorSurfaceCreateFlagsGGP

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

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

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

peek :: Ptr StreamDescriptorSurfaceCreateFlagsGGP -> IO StreamDescriptorSurfaceCreateFlagsGGP

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

Bits StreamDescriptorSurfaceCreateFlagsGGP

Defined in Vulkan.Extensions.VK_GGP_stream_descriptor_surface

Methods

(.&.) :: StreamDescriptorSurfaceCreateFlagsGGP -> StreamDescriptorSurfaceCreateFlagsGGP -> StreamDescriptorSurfaceCreateFlagsGGP

(.|.) :: StreamDescriptorSurfaceCreateFlagsGGP -> StreamDescriptorSurfaceCreateFlagsGGP -> StreamDescriptorSurfaceCreateFlagsGGP

xor :: StreamDescriptorSurfaceCreateFlagsGGP -> StreamDescriptorSurfaceCreateFlagsGGP -> StreamDescriptorSurfaceCreateFlagsGGP

complement :: StreamDescriptorSurfaceCreateFlagsGGP -> StreamDescriptorSurfaceCreateFlagsGGP

shift :: StreamDescriptorSurfaceCreateFlagsGGP -> Int -> StreamDescriptorSurfaceCreateFlagsGGP

rotate :: StreamDescriptorSurfaceCreateFlagsGGP -> Int -> StreamDescriptorSurfaceCreateFlagsGGP

zeroBits :: StreamDescriptorSurfaceCreateFlagsGGP

bit :: Int -> StreamDescriptorSurfaceCreateFlagsGGP

setBit :: StreamDescriptorSurfaceCreateFlagsGGP -> Int -> StreamDescriptorSurfaceCreateFlagsGGP

clearBit :: StreamDescriptorSurfaceCreateFlagsGGP -> Int -> StreamDescriptorSurfaceCreateFlagsGGP

complementBit :: StreamDescriptorSurfaceCreateFlagsGGP -> Int -> StreamDescriptorSurfaceCreateFlagsGGP

testBit :: StreamDescriptorSurfaceCreateFlagsGGP -> Int -> Bool

bitSizeMaybe :: StreamDescriptorSurfaceCreateFlagsGGP -> Maybe Int

bitSize :: StreamDescriptorSurfaceCreateFlagsGGP -> Int

isSigned :: StreamDescriptorSurfaceCreateFlagsGGP -> Bool

shiftL :: StreamDescriptorSurfaceCreateFlagsGGP -> Int -> StreamDescriptorSurfaceCreateFlagsGGP

unsafeShiftL :: StreamDescriptorSurfaceCreateFlagsGGP -> Int -> StreamDescriptorSurfaceCreateFlagsGGP

shiftR :: StreamDescriptorSurfaceCreateFlagsGGP -> Int -> StreamDescriptorSurfaceCreateFlagsGGP

unsafeShiftR :: StreamDescriptorSurfaceCreateFlagsGGP -> Int -> StreamDescriptorSurfaceCreateFlagsGGP

rotateL :: StreamDescriptorSurfaceCreateFlagsGGP -> Int -> StreamDescriptorSurfaceCreateFlagsGGP

rotateR :: StreamDescriptorSurfaceCreateFlagsGGP -> Int -> StreamDescriptorSurfaceCreateFlagsGGP

popCount :: StreamDescriptorSurfaceCreateFlagsGGP -> Int

Zero StreamDescriptorSurfaceCreateFlagsGGP

Defined in Vulkan.Extensions.VK_GGP_stream_descriptor_surface

Methods

zero :: StreamDescriptorSurfaceCreateFlagsGGP

type GGP_STREAM_DESCRIPTOR_SURFACE_SPEC_VERSION = 1

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

type GGP_STREAM_DESCRIPTOR_SURFACE_EXTENSION_NAME = "VK_GGP_stream_descriptor_surface"

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

type GgpStreamDescriptor = Word32

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