OpenXR.Core10.Image

Documentation

enumerateSwapchainFormats :: forall io. MonadIO io => Session -> io (Result, "formats" ::: Vector Int64)

xrEnumerateSwapchainFormats - Enumerates swapchain formats

Parameter Descriptions

• session is the session that enumerates the supported formats.

• formatCapacityInput is the capacity of the formats, or 0 to retrieve the required capacity.
• formatCountOutput is a pointer to the count of uint64_t formats written, or a pointer to the required capacity in the case that formatCapacityInput is 0.
• formats is a pointer to an array of int64_t format ids, but can be NULL if formatCapacityInput is 0. The format ids are specific to the specified graphics API.
• See Buffer Size Parameters chapter for a detailed description of retrieving the required formats size.

Description

enumerateSwapchainFormats enumerates the texture formats supported by the current session. The type of formats returned are dependent on the graphics API specified in createSession. For example, if a DirectX graphics API was specified, then the enumerated formats correspond to the DXGI formats, such as DXGI_FORMAT_R8G8B8A8_UNORM_SRGB. Texture formats should be in order from highest to lowest runtime preference.

With an OpenGL-based graphics API, the texture formats correspond to OpenGL internal formats.

With a Direct3D-based graphics API, enumerateSwapchainFormats never returns typeless formats (e.g. DXGI_FORMAT_R8G8B8A8_TYPELESS). Only concrete formats are returned, and only concrete formats may be specified by applications for swapchain creation.

Runtimes must always return identical buffer contents from this enumeration for the lifetime of the session.

Valid Usage (Implicit)

• session must be a valid Session handle

• formatCountOutput must be a pointer to a uint32_t value
• If formatCapacityInput is not 0, formats must be a pointer to an array of formatCapacityInput int64_t values

Return Codes

Success

• SUCCESS
• SESSION_LOSS_PENDING

Failure

• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_SIZE_INSUFFICIENT
• ERROR_VALIDATION_FAILURE

See Also

Session, createSwapchain

createSwapchain

Arguments

:: forall a io. (Extendss SwapchainCreateInfo a, PokeChain a, MonadIO io)

=> Session

session is the session that creates the image.

session must be a valid Session handle

-> SwapchainCreateInfo a

createInfo is a pointer to an SwapchainCreateInfo structure containing parameters to be used to create the image.

createInfo must be a pointer to a valid SwapchainCreateInfo structure

-> io (Result, Swapchain)

xrCreateSwapchain - Creates an XrSwapchain

Parameter Descriptions

Description

Creates an Swapchain handle. The returned swapchain handle may be subsequently used in API calls. Multiple Swapchain handles may exist simultaneously, up to some limit imposed by the runtime. The Swapchain handle must be eventually freed via the destroySwapchain function. The runtime must return ERROR_SWAPCHAIN_FORMAT_UNSUPPORTED if the image format specified in the SwapchainCreateInfo is unsupported. The runtime must return ERROR_FEATURE_UNSUPPORTED if any bit of the create flags specified in the SwapchainCreateInfo is unsupported.

Return Codes

Success

• SUCCESS
• SESSION_LOSS_PENDING

Failure

• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_RUNTIME_FAILURE
• ERROR_LIMIT_REACHED
• ERROR_HANDLE_INVALID
• ERROR_OUT_OF_MEMORY
• ERROR_SWAPCHAIN_FORMAT_UNSUPPORTED
• ERROR_FEATURE_UNSUPPORTED
• ERROR_VALIDATION_FAILURE

See Also

Session, Swapchain, SwapchainCreateInfo, acquireSwapchainImage, destroySwapchain, enumerateSwapchainFormats, enumerateSwapchainImages, releaseSwapchainImage

withSwapchain :: forall a io r. (Extendss SwapchainCreateInfo a, PokeChain a, MonadIO io) => Session -> SwapchainCreateInfo a -> (io (Result, Swapchain) -> ((Result, Swapchain) -> io ()) -> r) -> r

A convenience wrapper to make a compatible pair of calls to createSwapchain and destroySwapchain

To ensure that destroySwapchain is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

destroySwapchain

Arguments

:: forall io. MonadIO io

=> Swapchain

swapchain is the swapchain to destroy.

-> io ()

xrDestroySwapchain - Destroys an XrSwapchain

Parameter Descriptions

Description

All submitted graphics API commands that refer to swapchain must have completed execution. Runtimes may continue to utilize swapchain images after destroySwapchain is called.

Valid Usage (Implicit)

• swapchain must be a valid Swapchain handle

Thread Safety

• Access to swapchain, and any child handles, must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_HANDLE_INVALID

See Also

Swapchain, createSwapchain

enumerateSwapchainImages :: forall a io. (Inherits SwapchainImageBaseHeader a, ToCStruct a, FromCStruct a, MonadIO io) => Swapchain -> io (Result, "images" ::: Vector a)

xrEnumerateSwapchainImages - Gets images from an XrSwapchain

Parameter Descriptions

• swapchain is the Swapchain to get images from.

• imageCapacityInput is the capacity of the images array, or 0 to indicate a request to retrieve the required capacity.
• imageCountOutput is a pointer to the count of images written, or a pointer to the required capacity in the case that imageCapacityInput is 0.
• images is a pointer to an array of graphics API-specific XrSwapchainImage structures based off of SwapchainImageBaseHeader. It can be NULL if imageCapacityInput is 0.
• See Buffer Size Parameters chapter for a detailed description of retrieving the required images size.

Description

Fills an array of graphics API-specific XrSwapchainImage structures. The resources must be constant and valid for the lifetime of the Swapchain.

Runtimes must always return identical buffer contents from this enumeration for the lifetime of the swapchain.

Note: images is a pointer to an array of structures of graphics API-specific type, not an array of structure pointers.

Valid Usage (Implicit)

• swapchain must be a valid Swapchain handle

• imageCountOutput must be a pointer to a uint32_t value
• If imageCapacityInput is not 0, images must be a pointer to an array of imageCapacityInput SwapchainImageBaseHeader-based structures. See also: SwapchainImageD3D11KHR, SwapchainImageD3D12KHR, SwapchainImageOpenGLESKHR, SwapchainImageOpenGLKHR, SwapchainImageVulkanKHR

Return Codes

Success

• SUCCESS
• SESSION_LOSS_PENDING

Failure

• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_RUNTIME_FAILURE
• ERROR_SIZE_INSUFFICIENT
• ERROR_HANDLE_INVALID
• ERROR_VALIDATION_FAILURE

See Also

Swapchain, SwapchainImageBaseHeader, createSwapchain

acquireSwapchainImage

Arguments

:: forall io. MonadIO io

=> Swapchain

swapchain is the swapchain from which to acquire an image.

-> ("acquireInfo" ::: Maybe SwapchainImageAcquireInfo)

acquireInfo exists for extensibility purposes, it is NULL or a pointer to a valid SwapchainImageAcquireInfo.

-> io (Result, "index" ::: Word32)

xrAcquireSwapchainImage - Acquire a swapchain image

Parameter Descriptions

Description

Acquires the image corresponding to the index position in the array returned by enumerateSwapchainImages. The runtime must return ERROR_CALL_ORDER_INVALID if index has already been acquired and not yet released with releaseSwapchainImage. If the swapchain was created with the XR_SWAPCHAIN_CREATE_STATIC_IMAGE_BIT set in SwapchainCreateInfo::createFlags, this function must not have been previously called for this swapchain. The runtime must return ERROR_CALL_ORDER_INVALID if a swapchain created with the XR_SWAPCHAIN_CREATE_STATIC_IMAGE_BIT set in SwapchainCreateInfo::createFlags and this function has been successfully called previously for this swapchain.

Valid Usage (Implicit)

• swapchain must be a valid Swapchain handle

• If acquireInfo is not NULL, acquireInfo must be a pointer to a valid SwapchainImageAcquireInfo structure
• index must be a pointer to a uint32_t value

Return Codes

Success

• SUCCESS
• SESSION_LOSS_PENDING

Failure

• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_VALIDATION_FAILURE
• ERROR_CALL_ORDER_INVALID

See Also

Swapchain, SwapchainImageAcquireInfo, createSwapchain, destroySwapchain, enumerateSwapchainImages, releaseSwapchainImage, waitSwapchainImage

waitSwapchainImage

Arguments

:: forall io. MonadIO io

=> Swapchain

swapchain is the swapchain from which to wait for an image.

swapchain must be a valid Swapchain handle

-> SwapchainImageWaitInfo

waitInfo is a pointer to an SwapchainImageWaitInfo structure.

waitInfo must be a pointer to a valid SwapchainImageWaitInfo structure

-> io Result

xrWaitSwapchainImage - Wait for a swapchain image to be available

Parameter Descriptions

Description

Before an application can begin writing to a swapchain image, it must first wait on the image to avoid writing to it before the compositor has finished reading from it. waitSwapchainImage will implicitly wait on the oldest acquired swapchain image which has not yet been successfully waited on. Once a swapchain image has been successfully waited on, it must be released before waiting on the next acquired swapchain image.

This function may block for longer than the timeout specified in SwapchainImageWaitInfo due to scheduling or contention.

If the timeout expires without the image becoming available for writing, TIMEOUT_EXPIRED must be returned. If waitSwapchainImage returns TIMEOUT_EXPIRED, the next call to waitSwapchainImage will wait on the same image index again until the function succeeds with SUCCESS. Note that this is not an error code; XR_SUCCEEDED(XR_TIMEOUT_EXPIRED) is true.

The runtime must return ERROR_CALL_ORDER_INVALID if no image has been acquired by calling acquireSwapchainImage.

Return Codes

Success

• SUCCESS
• TIMEOUT_EXPIRED
• SESSION_LOSS_PENDING

Failure

• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_VALIDATION_FAILURE
• ERROR_CALL_ORDER_INVALID

See Also

Swapchain, SwapchainImageWaitInfo, acquireSwapchainImage, createSwapchain, destroySwapchain, enumerateSwapchainImages, releaseSwapchainImage

waitSwapchainImageSafe

Arguments

:: forall io. MonadIO io

=> Swapchain

swapchain is the swapchain from which to wait for an image.

swapchain must be a valid Swapchain handle

-> SwapchainImageWaitInfo

waitInfo is a pointer to an SwapchainImageWaitInfo structure.

waitInfo must be a pointer to a valid SwapchainImageWaitInfo structure

-> io Result

A variant of waitSwapchainImage which makes a *safe* FFI call

releaseSwapchainImage

Arguments

:: forall io. MonadIO io

=> Swapchain

swapchain is the Swapchain from which to release an image.

-> ("releaseInfo" ::: Maybe SwapchainImageReleaseInfo)

releaseInfo exists for extensibility purposes, it is NULL or a pointer to a valid SwapchainImageReleaseInfo.

-> io Result

xrReleaseSwapchainImage - Release a swapchain image

Parameter Descriptions

Description

If the swapchain was created with the XR_SWAPCHAIN_CREATE_STATIC_IMAGE_BIT set in SwapchainCreateInfo::createFlags structure, this function must not have been previously called for this swapchain.

The runtime must return ERROR_CALL_ORDER_INVALID if no image has been waited on by calling waitSwapchainImage.

Valid Usage (Implicit)

• swapchain must be a valid Swapchain handle

• If releaseInfo is not NULL, releaseInfo must be a pointer to a valid SwapchainImageReleaseInfo structure

Return Codes

Success

• SUCCESS
• SESSION_LOSS_PENDING

Failure

• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_VALIDATION_FAILURE
• ERROR_CALL_ORDER_INVALID

See Also

Swapchain, SwapchainImageReleaseInfo, acquireSwapchainImage, createSwapchain, destroySwapchain, enumerateSwapchainImages, waitSwapchainImage

data SwapchainCreateInfo (es :: [Type])

XrSwapchainCreateInfo - Creation info for a swapchain

Valid Usage (Implicit)

See Also

SessionCreateFlags, StructureType, SwapchainCreateFlags, SwapchainUsageFlags, createSession, createSwapchain, createSwapchainAndroidSurfaceKHR, enumerateSwapchainFormats

Constructors

SwapchainCreateInfo

Fields

• next :: Chain es

  next is NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR.

  next must be NULL or a valid pointer to the next structure in a structure chain. See also: SecondaryViewConfigurationSwapchainCreateInfoMSFT

• createFlags :: SwapchainCreateFlags

  createFlags is a bitmask of XrSwapchainCreateFlagBits describing additional properties of the swapchain.

  createFlags must be 0 or a valid combination of XrSwapchainCreateFlagBits values

• usageFlags :: SwapchainUsageFlags

  usageFlags is a bitmask of SwapchainUsageFlagBits describing the intended usage of the swapchain’s images. The usage flags define how the corresponding graphics API objects are created. A mismatch may result in swapchain images that do not support the application’s usage.

  usageFlags must be 0 or a valid combination of SwapchainUsageFlagBits values

• format :: Int64

  format is a graphics API-specific texture format identifier. For example, if the graphics API specified in createSession is Vulkan, then this format is a Vulkan format such as VK_FORMAT_R8G8B8A8_SRGB. The format identifies the format that the runtime will interpret the texture as upon submission. Valid formats are indicated by enumerateSwapchainFormats.

• sampleCount :: Word32

  sampleCount is the number of sub-data element samples in the image, must not be 0 or greater than the graphics API’s maximum limit.

• width :: Word32

  width is the width of the image, must not be 0 or greater than the graphics API’s maximum limit.

• height :: Word32

  height is the height of the image, must not be 0 or greater than the graphics API’s maximum limit.

• faceCount :: Word32

  faceCount is the number of faces, which can be either 6 (for cubemaps) or 1.

• arraySize :: Word32

  arraySize is the number of array layers in the image or 1 for a 2D image, must not be 0 or greater than the graphics API’s maximum limit.

• mipCount :: Word32

  mipCount describes the number of levels of detail available for minified sampling of the image, must not be 0 or greater than the graphics API’s maximum limit.

Instances

Extensible SwapchainCreateInfo

Defined in OpenXR.Core10.Image

Methods

extensibleTypeName :: String

getNext :: forall (es :: [Type]). SwapchainCreateInfo es -> Chain es

setNext :: forall (ds :: [Type]) (es :: [Type]). SwapchainCreateInfo ds -> Chain es -> SwapchainCreateInfo es

extends :: forall e b proxy. Typeable e => proxy e -> (Extends SwapchainCreateInfo e => b) -> Maybe b

Show (Chain es) => Show (SwapchainCreateInfo es)

Defined in OpenXR.Core10.Image

Methods

showsPrec :: Int -> SwapchainCreateInfo es -> ShowS

show :: SwapchainCreateInfo es -> String

showList :: [SwapchainCreateInfo es] -> ShowS

es ~ ('[] :: [Type]) => Zero (SwapchainCreateInfo es)

Defined in OpenXR.Core10.Image

Methods

zero :: SwapchainCreateInfo es

(Extendss SwapchainCreateInfo es, PokeChain es) => ToCStruct (SwapchainCreateInfo es)

Defined in OpenXR.Core10.Image

Methods

withCStruct :: SwapchainCreateInfo es -> (Ptr (SwapchainCreateInfo es) -> IO b) -> IO b

pokeCStruct :: Ptr (SwapchainCreateInfo es) -> SwapchainCreateInfo es -> IO b -> IO b

withZeroCStruct :: (Ptr (SwapchainCreateInfo es) -> IO b) -> IO b

pokeZeroCStruct :: Ptr (SwapchainCreateInfo es) -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

(Extendss SwapchainCreateInfo es, PeekChain es) => FromCStruct (SwapchainCreateInfo es)

Defined in OpenXR.Core10.Image

Methods

peekCStruct :: Ptr (SwapchainCreateInfo es) -> IO (SwapchainCreateInfo es)

data SwapchainImageBaseHeader

XrSwapchainImageBaseHeader - Image base header for a swapchain image

Member Descriptions

Description

The SwapchainImageBaseHeader is a base structure that can be overridden by a graphics API-specific XrSwapchainImage* child structure.

Valid Usage (Implicit)

See Also

StructureType, enumerateSwapchainImages

Constructors

SwapchainImageBaseHeader

Fields

• type' :: StructureType

  type is the StructureType of this structure. This base structure itself has no associated StructureType value.

  type must be one of the following XrStructureType values: TYPE_SWAPCHAIN_IMAGE_D3D11_KHR, TYPE_SWAPCHAIN_IMAGE_D3D12_KHR, TYPE_SWAPCHAIN_IMAGE_OPENGL_ES_KHR, TYPE_SWAPCHAIN_IMAGE_OPENGL_KHR, TYPE_SWAPCHAIN_IMAGE_VULKAN_KHR

Instances

Eq SwapchainImageBaseHeader

Defined in OpenXR.Core10.Image

Methods

(==) :: SwapchainImageBaseHeader -> SwapchainImageBaseHeader -> Bool

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

Show SwapchainImageBaseHeader

Defined in OpenXR.Core10.Image

Methods

showsPrec :: Int -> SwapchainImageBaseHeader -> ShowS

show :: SwapchainImageBaseHeader -> String

showList :: [SwapchainImageBaseHeader] -> ShowS

Storable SwapchainImageBaseHeader

Defined in OpenXR.Core10.Image

Methods

sizeOf :: SwapchainImageBaseHeader -> Int

alignment :: SwapchainImageBaseHeader -> Int

peekElemOff :: Ptr SwapchainImageBaseHeader -> Int -> IO SwapchainImageBaseHeader

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

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

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

peek :: Ptr SwapchainImageBaseHeader -> IO SwapchainImageBaseHeader

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

Zero SwapchainImageBaseHeader

Defined in OpenXR.Core10.Image

Methods

zero :: SwapchainImageBaseHeader

ToCStruct SwapchainImageBaseHeader

Defined in OpenXR.Core10.Image

Methods

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

pokeCStruct :: Ptr SwapchainImageBaseHeader -> SwapchainImageBaseHeader -> IO b -> IO b

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

pokeZeroCStruct :: Ptr SwapchainImageBaseHeader -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct SwapchainImageBaseHeader

Defined in OpenXR.Core10.Image

Methods

peekCStruct :: Ptr SwapchainImageBaseHeader -> IO SwapchainImageBaseHeader

Inheritable SwapchainImageBaseHeader

Defined in OpenXR.Core10.Image

Methods

peekSomeCChild :: Ptr (SomeChild SwapchainImageBaseHeader) -> IO (SomeChild SwapchainImageBaseHeader)

class ToCStruct a => IsSwapchainImage a where

Methods

toSwapchainImageBaseHeader :: a -> SwapchainImageBaseHeader

Instances

IsSwapchainImage SwapchainImageD3D11KHR

Defined in OpenXR.Extensions.XR_KHR_D3D11_enable

Methods

toSwapchainImageBaseHeader :: SwapchainImageD3D11KHR -> SwapchainImageBaseHeader

IsSwapchainImage SwapchainImageD3D12KHR

Defined in OpenXR.Extensions.XR_KHR_D3D12_enable

Methods

toSwapchainImageBaseHeader :: SwapchainImageD3D12KHR -> SwapchainImageBaseHeader

IsSwapchainImage SwapchainImageOpenGLKHR

Defined in OpenXR.Extensions.XR_KHR_opengl_enable

Methods

toSwapchainImageBaseHeader :: SwapchainImageOpenGLKHR -> SwapchainImageBaseHeader

IsSwapchainImage SwapchainImageOpenGLESKHR

Defined in OpenXR.Extensions.XR_KHR_opengl_es_enable

Methods

toSwapchainImageBaseHeader :: SwapchainImageOpenGLESKHR -> SwapchainImageBaseHeader

IsSwapchainImage SwapchainImageVulkanKHR

Defined in OpenXR.Extensions.XR_KHR_vulkan_enable

Methods

toSwapchainImageBaseHeader :: SwapchainImageVulkanKHR -> SwapchainImageBaseHeader

data SwapchainImageAcquireInfo

XrSwapchainImageAcquireInfo - Describes a swapchain image acquisition

Member Descriptions

Description

Because this structure only exists to support extension-specific structures, acquireSwapchainImage will accept a NULL argument for acquireInfo for applications that are not using any relevant extensions.

Valid Usage (Implicit)

See Also

StructureType, acquireSwapchainImage

Constructors

SwapchainImageAcquireInfo

Instances

Eq SwapchainImageAcquireInfo

Defined in OpenXR.Core10.Image

Methods

(==) :: SwapchainImageAcquireInfo -> SwapchainImageAcquireInfo -> Bool

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

Show SwapchainImageAcquireInfo

Defined in OpenXR.Core10.Image

Methods

showsPrec :: Int -> SwapchainImageAcquireInfo -> ShowS

show :: SwapchainImageAcquireInfo -> String

showList :: [SwapchainImageAcquireInfo] -> ShowS

Storable SwapchainImageAcquireInfo

Defined in OpenXR.Core10.Image

Methods

sizeOf :: SwapchainImageAcquireInfo -> Int

alignment :: SwapchainImageAcquireInfo -> Int

peekElemOff :: Ptr SwapchainImageAcquireInfo -> Int -> IO SwapchainImageAcquireInfo

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

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

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

peek :: Ptr SwapchainImageAcquireInfo -> IO SwapchainImageAcquireInfo

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

Zero SwapchainImageAcquireInfo

Defined in OpenXR.Core10.Image

Methods

zero :: SwapchainImageAcquireInfo

ToCStruct SwapchainImageAcquireInfo

Defined in OpenXR.Core10.Image

Methods

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

pokeCStruct :: Ptr SwapchainImageAcquireInfo -> SwapchainImageAcquireInfo -> IO b -> IO b

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

pokeZeroCStruct :: Ptr SwapchainImageAcquireInfo -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct SwapchainImageAcquireInfo

Defined in OpenXR.Core10.Image

Methods

peekCStruct :: Ptr SwapchainImageAcquireInfo -> IO SwapchainImageAcquireInfo

data SwapchainImageWaitInfo

XrSwapchainImageWaitInfo - Describes a swapchain image wait operation

Valid Usage (Implicit)

See Also

https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrDuration, StructureType, waitSwapchainImage

Constructors

SwapchainImageWaitInfo

Fields

• timeout :: Duration

  timeout indicates how many nanoseconds the call should block waiting for the image to become available for writing.

Instances

Eq SwapchainImageWaitInfo

Defined in OpenXR.Core10.Image

Methods

(==) :: SwapchainImageWaitInfo -> SwapchainImageWaitInfo -> Bool

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

Show SwapchainImageWaitInfo

Defined in OpenXR.Core10.Image

Methods

showsPrec :: Int -> SwapchainImageWaitInfo -> ShowS

show :: SwapchainImageWaitInfo -> String

showList :: [SwapchainImageWaitInfo] -> ShowS

Storable SwapchainImageWaitInfo

Defined in OpenXR.Core10.Image

Methods

sizeOf :: SwapchainImageWaitInfo -> Int

alignment :: SwapchainImageWaitInfo -> Int

peekElemOff :: Ptr SwapchainImageWaitInfo -> Int -> IO SwapchainImageWaitInfo

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

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

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

peek :: Ptr SwapchainImageWaitInfo -> IO SwapchainImageWaitInfo

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

Zero SwapchainImageWaitInfo

Defined in OpenXR.Core10.Image

Methods

zero :: SwapchainImageWaitInfo

ToCStruct SwapchainImageWaitInfo

Defined in OpenXR.Core10.Image

Methods

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

pokeCStruct :: Ptr SwapchainImageWaitInfo -> SwapchainImageWaitInfo -> IO b -> IO b

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

pokeZeroCStruct :: Ptr SwapchainImageWaitInfo -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct SwapchainImageWaitInfo

Defined in OpenXR.Core10.Image

Methods

peekCStruct :: Ptr SwapchainImageWaitInfo -> IO SwapchainImageWaitInfo

data SwapchainImageReleaseInfo

XrSwapchainImageReleaseInfo - Describes a swapchain image release

Member Descriptions

Description

Because this structure only exists to support extension-specific structures, releaseSwapchainImage will accept a NULL argument for releaseInfo for applications that are not using any relevant extensions.

Valid Usage (Implicit)

See Also

StructureType, releaseSwapchainImage

Constructors

SwapchainImageReleaseInfo

Instances

Eq SwapchainImageReleaseInfo

Defined in OpenXR.Core10.Image

Methods

(==) :: SwapchainImageReleaseInfo -> SwapchainImageReleaseInfo -> Bool

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

Show SwapchainImageReleaseInfo

Defined in OpenXR.Core10.Image

Methods

showsPrec :: Int -> SwapchainImageReleaseInfo -> ShowS

show :: SwapchainImageReleaseInfo -> String

showList :: [SwapchainImageReleaseInfo] -> ShowS

Storable SwapchainImageReleaseInfo

Defined in OpenXR.Core10.Image

Methods

sizeOf :: SwapchainImageReleaseInfo -> Int

alignment :: SwapchainImageReleaseInfo -> Int

peekElemOff :: Ptr SwapchainImageReleaseInfo -> Int -> IO SwapchainImageReleaseInfo

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

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

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

peek :: Ptr SwapchainImageReleaseInfo -> IO SwapchainImageReleaseInfo

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

Zero SwapchainImageReleaseInfo

Defined in OpenXR.Core10.Image

Methods

zero :: SwapchainImageReleaseInfo

ToCStruct SwapchainImageReleaseInfo

Defined in OpenXR.Core10.Image

Methods

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

pokeCStruct :: Ptr SwapchainImageReleaseInfo -> SwapchainImageReleaseInfo -> IO b -> IO b

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

pokeZeroCStruct :: Ptr SwapchainImageReleaseInfo -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct SwapchainImageReleaseInfo

Defined in OpenXR.Core10.Image

Methods

peekCStruct :: Ptr SwapchainImageReleaseInfo -> IO SwapchainImageReleaseInfo