Vulkan.Extensions.VK_FUCHSIA_imagepipe_surface

Name

VK_FUCHSIA_imagepipe_surface - instance extension

VK_FUCHSIA_imagepipe_surface

Name String

VK_FUCHSIA_imagepipe_surface

Extension Type

Instance extension

Registered Extension Number

215

Revision

1

Extension and Version Dependencies

• Requires support for Vulkan 1.0
• Requires VK_KHR_surface to be enabled

Contact

• Craig Stout @cdotstout%0A*Here describe the issue or question you have about the VK_FUCHSIA_imagepipe_surface extension*

Other Extension Metadata

Last Modified Date

2018-07-27

IP Status

No known IP claims.

Contributors

• Craig Stout, Google
• Ian Elliott, Google
• Jesse Hall, Google

Description

The VK_FUCHSIA_imagepipe_surface extension is an instance extension. It provides a mechanism to create a SurfaceKHR object (defined by the VK_KHR_surface extension) that refers to a Fuchsia imagePipeHandle.

New Commands

• createImagePipeSurfaceFUCHSIA

New Structures

• ImagePipeSurfaceCreateInfoFUCHSIA

New Bitmasks

• ImagePipeSurfaceCreateFlagsFUCHSIA

New Enum Constants

• FUCHSIA_IMAGEPIPE_SURFACE_EXTENSION_NAME

• FUCHSIA_IMAGEPIPE_SURFACE_SPEC_VERSION

• Extending StructureType:

  • STRUCTURE_TYPE_IMAGEPIPE_SURFACE_CREATE_INFO_FUCHSIA

Version History

• Revision 1, 2018-07-27 (Craig Stout)

  • Initial draft.

See Also

ImagePipeSurfaceCreateFlagsFUCHSIA, ImagePipeSurfaceCreateInfoFUCHSIA, createImagePipeSurfaceFUCHSIA

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.

Documentation

createImagePipeSurfaceFUCHSIA

Arguments

:: forall io. MonadIO io

=> Instance

instance is the instance to associate with the surface.

-> ImagePipeSurfaceCreateInfoFUCHSIA

pCreateInfo is a pointer to a ImagePipeSurfaceCreateInfoFUCHSIA 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

vkCreateImagePipeSurfaceFUCHSIA - Create a SurfaceKHR object for a Fuchsia ImagePipe

Valid Usage (Implicit)

• instance must be a valid Instance handle

• pCreateInfo must be a valid pointer to a valid ImagePipeSurfaceCreateInfoFUCHSIA 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

See Also

VK_FUCHSIA_imagepipe_surface, AllocationCallbacks, ImagePipeSurfaceCreateInfoFUCHSIA, Instance, SurfaceKHR

data ImagePipeSurfaceCreateInfoFUCHSIA

VkImagePipeSurfaceCreateInfoFUCHSIA - Structure specifying parameters of a newly created ImagePipe surface object

Valid Usage (Implicit)

See Also

VK_FUCHSIA_imagepipe_surface, ImagePipeSurfaceCreateFlagsFUCHSIA, StructureType, createImagePipeSurfaceFUCHSIA

Constructors

ImagePipeSurfaceCreateInfoFUCHSIA

Fields

• flags :: ImagePipeSurfaceCreateFlagsFUCHSIA

  flags is reserved for future use.

  flags must be 0

• imagePipeHandle :: Zx_handle_t

  imagePipeHandle is a zx_handle_t referring to the ImagePipe to associate with the surface.

  imagePipeHandle must be a valid zx_handle_t

Instances

Storable ImagePipeSurfaceCreateInfoFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_imagepipe_surface

Methods

sizeOf :: ImagePipeSurfaceCreateInfoFUCHSIA -> Int

alignment :: ImagePipeSurfaceCreateInfoFUCHSIA -> Int

peekElemOff :: Ptr ImagePipeSurfaceCreateInfoFUCHSIA -> Int -> IO ImagePipeSurfaceCreateInfoFUCHSIA

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

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

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

peek :: Ptr ImagePipeSurfaceCreateInfoFUCHSIA -> IO ImagePipeSurfaceCreateInfoFUCHSIA

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

Show ImagePipeSurfaceCreateInfoFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_imagepipe_surface

Methods

showsPrec :: Int -> ImagePipeSurfaceCreateInfoFUCHSIA -> ShowS

show :: ImagePipeSurfaceCreateInfoFUCHSIA -> String

showList :: [ImagePipeSurfaceCreateInfoFUCHSIA] -> ShowS

Eq ImagePipeSurfaceCreateInfoFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_imagepipe_surface

Methods

(==) :: ImagePipeSurfaceCreateInfoFUCHSIA -> ImagePipeSurfaceCreateInfoFUCHSIA -> Bool

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

FromCStruct ImagePipeSurfaceCreateInfoFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_imagepipe_surface

Methods

peekCStruct :: Ptr ImagePipeSurfaceCreateInfoFUCHSIA -> IO ImagePipeSurfaceCreateInfoFUCHSIA

ToCStruct ImagePipeSurfaceCreateInfoFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_imagepipe_surface

Methods

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

pokeCStruct :: Ptr ImagePipeSurfaceCreateInfoFUCHSIA -> ImagePipeSurfaceCreateInfoFUCHSIA -> IO b -> IO b

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

pokeZeroCStruct :: Ptr ImagePipeSurfaceCreateInfoFUCHSIA -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ImagePipeSurfaceCreateInfoFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_imagepipe_surface

Methods

zero :: ImagePipeSurfaceCreateInfoFUCHSIA

newtype ImagePipeSurfaceCreateFlagsFUCHSIA

VkImagePipeSurfaceCreateFlagsFUCHSIA - Reserved for future use

Description

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

See Also

VK_FUCHSIA_imagepipe_surface, ImagePipeSurfaceCreateInfoFUCHSIA

Constructors

ImagePipeSurfaceCreateFlagsFUCHSIA Flags

Instances

Storable ImagePipeSurfaceCreateFlagsFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_imagepipe_surface

Methods

sizeOf :: ImagePipeSurfaceCreateFlagsFUCHSIA -> Int

alignment :: ImagePipeSurfaceCreateFlagsFUCHSIA -> Int

peekElemOff :: Ptr ImagePipeSurfaceCreateFlagsFUCHSIA -> Int -> IO ImagePipeSurfaceCreateFlagsFUCHSIA

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

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

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

peek :: Ptr ImagePipeSurfaceCreateFlagsFUCHSIA -> IO ImagePipeSurfaceCreateFlagsFUCHSIA

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

Bits ImagePipeSurfaceCreateFlagsFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_imagepipe_surface

Methods

(.&.) :: ImagePipeSurfaceCreateFlagsFUCHSIA -> ImagePipeSurfaceCreateFlagsFUCHSIA -> ImagePipeSurfaceCreateFlagsFUCHSIA

(.|.) :: ImagePipeSurfaceCreateFlagsFUCHSIA -> ImagePipeSurfaceCreateFlagsFUCHSIA -> ImagePipeSurfaceCreateFlagsFUCHSIA

xor :: ImagePipeSurfaceCreateFlagsFUCHSIA -> ImagePipeSurfaceCreateFlagsFUCHSIA -> ImagePipeSurfaceCreateFlagsFUCHSIA

complement :: ImagePipeSurfaceCreateFlagsFUCHSIA -> ImagePipeSurfaceCreateFlagsFUCHSIA

shift :: ImagePipeSurfaceCreateFlagsFUCHSIA -> Int -> ImagePipeSurfaceCreateFlagsFUCHSIA

rotate :: ImagePipeSurfaceCreateFlagsFUCHSIA -> Int -> ImagePipeSurfaceCreateFlagsFUCHSIA

zeroBits :: ImagePipeSurfaceCreateFlagsFUCHSIA

bit :: Int -> ImagePipeSurfaceCreateFlagsFUCHSIA

setBit :: ImagePipeSurfaceCreateFlagsFUCHSIA -> Int -> ImagePipeSurfaceCreateFlagsFUCHSIA

clearBit :: ImagePipeSurfaceCreateFlagsFUCHSIA -> Int -> ImagePipeSurfaceCreateFlagsFUCHSIA

complementBit :: ImagePipeSurfaceCreateFlagsFUCHSIA -> Int -> ImagePipeSurfaceCreateFlagsFUCHSIA

testBit :: ImagePipeSurfaceCreateFlagsFUCHSIA -> Int -> Bool

bitSizeMaybe :: ImagePipeSurfaceCreateFlagsFUCHSIA -> Maybe Int

bitSize :: ImagePipeSurfaceCreateFlagsFUCHSIA -> Int

isSigned :: ImagePipeSurfaceCreateFlagsFUCHSIA -> Bool

shiftL :: ImagePipeSurfaceCreateFlagsFUCHSIA -> Int -> ImagePipeSurfaceCreateFlagsFUCHSIA

unsafeShiftL :: ImagePipeSurfaceCreateFlagsFUCHSIA -> Int -> ImagePipeSurfaceCreateFlagsFUCHSIA

shiftR :: ImagePipeSurfaceCreateFlagsFUCHSIA -> Int -> ImagePipeSurfaceCreateFlagsFUCHSIA

unsafeShiftR :: ImagePipeSurfaceCreateFlagsFUCHSIA -> Int -> ImagePipeSurfaceCreateFlagsFUCHSIA

rotateL :: ImagePipeSurfaceCreateFlagsFUCHSIA -> Int -> ImagePipeSurfaceCreateFlagsFUCHSIA

rotateR :: ImagePipeSurfaceCreateFlagsFUCHSIA -> Int -> ImagePipeSurfaceCreateFlagsFUCHSIA

popCount :: ImagePipeSurfaceCreateFlagsFUCHSIA -> Int

FiniteBits ImagePipeSurfaceCreateFlagsFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_imagepipe_surface

Methods

finiteBitSize :: ImagePipeSurfaceCreateFlagsFUCHSIA -> Int

countLeadingZeros :: ImagePipeSurfaceCreateFlagsFUCHSIA -> Int

countTrailingZeros :: ImagePipeSurfaceCreateFlagsFUCHSIA -> Int

Read ImagePipeSurfaceCreateFlagsFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_imagepipe_surface

Methods

readsPrec :: Int -> ReadS ImagePipeSurfaceCreateFlagsFUCHSIA

readList :: ReadS [ImagePipeSurfaceCreateFlagsFUCHSIA]

readPrec :: ReadPrec ImagePipeSurfaceCreateFlagsFUCHSIA

readListPrec :: ReadPrec [ImagePipeSurfaceCreateFlagsFUCHSIA]

Show ImagePipeSurfaceCreateFlagsFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_imagepipe_surface

Methods

showsPrec :: Int -> ImagePipeSurfaceCreateFlagsFUCHSIA -> ShowS

show :: ImagePipeSurfaceCreateFlagsFUCHSIA -> String

showList :: [ImagePipeSurfaceCreateFlagsFUCHSIA] -> ShowS

Eq ImagePipeSurfaceCreateFlagsFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_imagepipe_surface

Methods

(==) :: ImagePipeSurfaceCreateFlagsFUCHSIA -> ImagePipeSurfaceCreateFlagsFUCHSIA -> Bool

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

Ord ImagePipeSurfaceCreateFlagsFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_imagepipe_surface

Methods

compare :: ImagePipeSurfaceCreateFlagsFUCHSIA -> ImagePipeSurfaceCreateFlagsFUCHSIA -> Ordering

(<) :: ImagePipeSurfaceCreateFlagsFUCHSIA -> ImagePipeSurfaceCreateFlagsFUCHSIA -> Bool

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

(>) :: ImagePipeSurfaceCreateFlagsFUCHSIA -> ImagePipeSurfaceCreateFlagsFUCHSIA -> Bool

(>=) :: ImagePipeSurfaceCreateFlagsFUCHSIA -> ImagePipeSurfaceCreateFlagsFUCHSIA -> Bool

max :: ImagePipeSurfaceCreateFlagsFUCHSIA -> ImagePipeSurfaceCreateFlagsFUCHSIA -> ImagePipeSurfaceCreateFlagsFUCHSIA

min :: ImagePipeSurfaceCreateFlagsFUCHSIA -> ImagePipeSurfaceCreateFlagsFUCHSIA -> ImagePipeSurfaceCreateFlagsFUCHSIA

Zero ImagePipeSurfaceCreateFlagsFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_imagepipe_surface

Methods

zero :: ImagePipeSurfaceCreateFlagsFUCHSIA

type FUCHSIA_IMAGEPIPE_SURFACE_SPEC_VERSION = 1

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

type FUCHSIA_IMAGEPIPE_SURFACE_EXTENSION_NAME = "VK_FUCHSIA_imagepipe_surface"

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

type Zx_handle_t = 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

VK_KHR_surface, PhysicalDeviceSurfaceInfo2KHR, SwapchainCreateInfoKHR, createAndroidSurfaceKHR, createDirectFBSurfaceEXT, createDisplayPlaneSurfaceKHR, createHeadlessSurfaceEXT, createIOSSurfaceMVK, createImagePipeSurfaceFUCHSIA, createMacOSSurfaceMVK, createMetalSurfaceEXT, createScreenSurfaceQNX, createStreamDescriptorSurfaceGGP, createViSurfaceNN, createWaylandSurfaceKHR, createWin32SurfaceKHR, createXcbSurfaceKHR, createXlibSurfaceKHR, destroySurfaceKHR, getDeviceGroupSurfacePresentModesKHR, getPhysicalDevicePresentRectanglesKHR, getPhysicalDeviceSurfaceCapabilities2EXT, getPhysicalDeviceSurfaceCapabilitiesKHR, getPhysicalDeviceSurfaceFormatsKHR, getPhysicalDeviceSurfacePresentModesKHR, getPhysicalDeviceSurfaceSupportKHR

Constructors

SurfaceKHR Word64

Instances

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 ()

Show SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

showsPrec :: Int -> SurfaceKHR -> ShowS

show :: SurfaceKHR -> String

showList :: [SurfaceKHR] -> ShowS

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

HasObjectType SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

objectTypeAndHandle :: SurfaceKHR -> (ObjectType, Word64)

IsHandle SurfaceKHR

Defined in Vulkan.Extensions.Handles

Zero SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

zero :: SurfaceKHR