Graphics.Vulkan.Image

vkCreateImage

vkCreateImage :: VkDevice -> Ptr VkImageCreateInfo -> Ptr VkAllocationCallbacks -> Ptr VkImage -> IO VkResult

VkImageCreateFlags

newtype VkImageCreateFlagBits

Constructors

VkImageCreateFlagBits VkFlags

Instances

Eq VkImageCreateFlagBits

Methods

(==) :: VkImageCreateFlagBits -> VkImageCreateFlagBits -> Bool

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

Storable VkImageCreateFlagBits

Methods

sizeOf :: VkImageCreateFlagBits -> Int

alignment :: VkImageCreateFlagBits -> Int

peekElemOff :: Ptr VkImageCreateFlagBits -> Int -> IO VkImageCreateFlagBits

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

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

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

peek :: Ptr VkImageCreateFlagBits -> IO VkImageCreateFlagBits

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

Bits VkImageCreateFlagBits

Methods

(.&.) :: VkImageCreateFlagBits -> VkImageCreateFlagBits -> VkImageCreateFlagBits

(.|.) :: VkImageCreateFlagBits -> VkImageCreateFlagBits -> VkImageCreateFlagBits

xor :: VkImageCreateFlagBits -> VkImageCreateFlagBits -> VkImageCreateFlagBits

complement :: VkImageCreateFlagBits -> VkImageCreateFlagBits

shift :: VkImageCreateFlagBits -> Int -> VkImageCreateFlagBits

rotate :: VkImageCreateFlagBits -> Int -> VkImageCreateFlagBits

zeroBits :: VkImageCreateFlagBits

bit :: Int -> VkImageCreateFlagBits

setBit :: VkImageCreateFlagBits -> Int -> VkImageCreateFlagBits

clearBit :: VkImageCreateFlagBits -> Int -> VkImageCreateFlagBits

complementBit :: VkImageCreateFlagBits -> Int -> VkImageCreateFlagBits

testBit :: VkImageCreateFlagBits -> Int -> Bool

bitSizeMaybe :: VkImageCreateFlagBits -> Maybe Int

bitSize :: VkImageCreateFlagBits -> Int

isSigned :: VkImageCreateFlagBits -> Bool

shiftL :: VkImageCreateFlagBits -> Int -> VkImageCreateFlagBits

unsafeShiftL :: VkImageCreateFlagBits -> Int -> VkImageCreateFlagBits

shiftR :: VkImageCreateFlagBits -> Int -> VkImageCreateFlagBits

unsafeShiftR :: VkImageCreateFlagBits -> Int -> VkImageCreateFlagBits

rotateL :: VkImageCreateFlagBits -> Int -> VkImageCreateFlagBits

rotateR :: VkImageCreateFlagBits -> Int -> VkImageCreateFlagBits

popCount :: VkImageCreateFlagBits -> Int

FiniteBits VkImageCreateFlagBits

Methods

finiteBitSize :: VkImageCreateFlagBits -> Int

countLeadingZeros :: VkImageCreateFlagBits -> Int

countTrailingZeros :: VkImageCreateFlagBits -> Int

type VkImageCreateFlags = VkImageCreateFlagBits

Alias for VkImageCreateFlagBits

pattern VK_IMAGE_CREATE_SPARSE_BINDING_BIT :: VkImageCreateFlagBits

Image should support sparse backing

pattern VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT :: VkImageCreateFlagBits

Image should support sparse backing with partial residency

pattern VK_IMAGE_CREATE_SPARSE_ALIASED_BIT :: VkImageCreateFlagBits

Image should support constent data access to physical memory blocks mapped into multiple locations of sparse images

pattern VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT :: VkImageCreateFlagBits

Allows image views to have different format than the base image

pattern VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT :: VkImageCreateFlagBits

Allows creating image views with cube type from the created image

VkImageUsageFlags

newtype VkImageUsageFlagBits

Constructors

VkImageUsageFlagBits VkFlags

Instances

Eq VkImageUsageFlagBits

Methods

(==) :: VkImageUsageFlagBits -> VkImageUsageFlagBits -> Bool

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

Storable VkImageUsageFlagBits

Methods

sizeOf :: VkImageUsageFlagBits -> Int

alignment :: VkImageUsageFlagBits -> Int

peekElemOff :: Ptr VkImageUsageFlagBits -> Int -> IO VkImageUsageFlagBits

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

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

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

peek :: Ptr VkImageUsageFlagBits -> IO VkImageUsageFlagBits

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

Bits VkImageUsageFlagBits

Methods

(.&.) :: VkImageUsageFlagBits -> VkImageUsageFlagBits -> VkImageUsageFlagBits

(.|.) :: VkImageUsageFlagBits -> VkImageUsageFlagBits -> VkImageUsageFlagBits

xor :: VkImageUsageFlagBits -> VkImageUsageFlagBits -> VkImageUsageFlagBits

complement :: VkImageUsageFlagBits -> VkImageUsageFlagBits

shift :: VkImageUsageFlagBits -> Int -> VkImageUsageFlagBits

rotate :: VkImageUsageFlagBits -> Int -> VkImageUsageFlagBits

zeroBits :: VkImageUsageFlagBits

bit :: Int -> VkImageUsageFlagBits

setBit :: VkImageUsageFlagBits -> Int -> VkImageUsageFlagBits

clearBit :: VkImageUsageFlagBits -> Int -> VkImageUsageFlagBits

complementBit :: VkImageUsageFlagBits -> Int -> VkImageUsageFlagBits

testBit :: VkImageUsageFlagBits -> Int -> Bool

bitSizeMaybe :: VkImageUsageFlagBits -> Maybe Int

bitSize :: VkImageUsageFlagBits -> Int

isSigned :: VkImageUsageFlagBits -> Bool

shiftL :: VkImageUsageFlagBits -> Int -> VkImageUsageFlagBits

unsafeShiftL :: VkImageUsageFlagBits -> Int -> VkImageUsageFlagBits

shiftR :: VkImageUsageFlagBits -> Int -> VkImageUsageFlagBits

unsafeShiftR :: VkImageUsageFlagBits -> Int -> VkImageUsageFlagBits

rotateL :: VkImageUsageFlagBits -> Int -> VkImageUsageFlagBits

rotateR :: VkImageUsageFlagBits -> Int -> VkImageUsageFlagBits

popCount :: VkImageUsageFlagBits -> Int

FiniteBits VkImageUsageFlagBits

Methods

finiteBitSize :: VkImageUsageFlagBits -> Int

countLeadingZeros :: VkImageUsageFlagBits -> Int

countTrailingZeros :: VkImageUsageFlagBits -> Int

type VkImageUsageFlags = VkImageUsageFlagBits

Alias for VkImageUsageFlagBits

pattern VK_IMAGE_USAGE_TRANSFER_SRC_BIT :: VkImageUsageFlagBits

Can be used as a source of transfer operations

pattern VK_IMAGE_USAGE_TRANSFER_DST_BIT :: VkImageUsageFlagBits

Can be used as a destination of transfer operations

pattern VK_IMAGE_USAGE_SAMPLED_BIT :: VkImageUsageFlagBits

Can be sampled from (SAMPLED_IMAGE and COMBINED_IMAGE_SAMPLER descriptor types)

pattern VK_IMAGE_USAGE_STORAGE_BIT :: VkImageUsageFlagBits

Can be used as storage image (STORAGE_IMAGE descriptor type)

pattern VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT :: VkImageUsageFlagBits

Can be used as framebuffer color attachment

pattern VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT :: VkImageUsageFlagBits

Can be used as framebuffer depth/stencil attachment

pattern VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT :: VkImageUsageFlagBits

Image data not needed outside of rendering

pattern VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT :: VkImageUsageFlagBits

Can be used as framebuffer input attachment

newtype VkImage

Constructors

VkImage Word64

Instances

Eq VkImage

Methods

(==) :: VkImage -> VkImage -> Bool

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

Storable VkImage

Methods

sizeOf :: VkImage -> Int

alignment :: VkImage -> Int

peekElemOff :: Ptr VkImage -> Int -> IO VkImage

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

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

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

peek :: Ptr VkImage -> IO VkImage

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

VkImageAspectFlags

newtype VkImageAspectFlagBits

Constructors

VkImageAspectFlagBits VkFlags

Instances

Eq VkImageAspectFlagBits

Methods

(==) :: VkImageAspectFlagBits -> VkImageAspectFlagBits -> Bool

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

Storable VkImageAspectFlagBits

Methods

sizeOf :: VkImageAspectFlagBits -> Int

alignment :: VkImageAspectFlagBits -> Int

peekElemOff :: Ptr VkImageAspectFlagBits -> Int -> IO VkImageAspectFlagBits

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

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

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

peek :: Ptr VkImageAspectFlagBits -> IO VkImageAspectFlagBits

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

Bits VkImageAspectFlagBits

Methods

(.&.) :: VkImageAspectFlagBits -> VkImageAspectFlagBits -> VkImageAspectFlagBits

(.|.) :: VkImageAspectFlagBits -> VkImageAspectFlagBits -> VkImageAspectFlagBits

xor :: VkImageAspectFlagBits -> VkImageAspectFlagBits -> VkImageAspectFlagBits

complement :: VkImageAspectFlagBits -> VkImageAspectFlagBits

shift :: VkImageAspectFlagBits -> Int -> VkImageAspectFlagBits

rotate :: VkImageAspectFlagBits -> Int -> VkImageAspectFlagBits

zeroBits :: VkImageAspectFlagBits

bit :: Int -> VkImageAspectFlagBits

setBit :: VkImageAspectFlagBits -> Int -> VkImageAspectFlagBits

clearBit :: VkImageAspectFlagBits -> Int -> VkImageAspectFlagBits

complementBit :: VkImageAspectFlagBits -> Int -> VkImageAspectFlagBits

testBit :: VkImageAspectFlagBits -> Int -> Bool

bitSizeMaybe :: VkImageAspectFlagBits -> Maybe Int

bitSize :: VkImageAspectFlagBits -> Int

isSigned :: VkImageAspectFlagBits -> Bool

shiftL :: VkImageAspectFlagBits -> Int -> VkImageAspectFlagBits

unsafeShiftL :: VkImageAspectFlagBits -> Int -> VkImageAspectFlagBits

shiftR :: VkImageAspectFlagBits -> Int -> VkImageAspectFlagBits

unsafeShiftR :: VkImageAspectFlagBits -> Int -> VkImageAspectFlagBits

rotateL :: VkImageAspectFlagBits -> Int -> VkImageAspectFlagBits

rotateR :: VkImageAspectFlagBits -> Int -> VkImageAspectFlagBits

popCount :: VkImageAspectFlagBits -> Int

FiniteBits VkImageAspectFlagBits

Methods

finiteBitSize :: VkImageAspectFlagBits -> Int

countLeadingZeros :: VkImageAspectFlagBits -> Int

countTrailingZeros :: VkImageAspectFlagBits -> Int

type VkImageAspectFlags = VkImageAspectFlagBits

Alias for VkImageAspectFlagBits

pattern VK_IMAGE_ASPECT_COLOR_BIT :: VkImageAspectFlagBits

pattern VK_IMAGE_ASPECT_DEPTH_BIT :: VkImageAspectFlagBits

pattern VK_IMAGE_ASPECT_STENCIL_BIT :: VkImageAspectFlagBits

pattern VK_IMAGE_ASPECT_METADATA_BIT :: VkImageAspectFlagBits

data VkSubresourceLayout

Constructors

VkSubresourceLayout

Fields

• vkOffset :: VkDeviceSize
• vkSize :: VkDeviceSize
• vkRowPitch :: VkDeviceSize
• vkArrayPitch :: VkDeviceSize
• vkDepthPitch :: VkDeviceSize

Instances

Eq VkSubresourceLayout

Methods

(==) :: VkSubresourceLayout -> VkSubresourceLayout -> Bool

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

Storable VkSubresourceLayout

Methods

sizeOf :: VkSubresourceLayout -> Int

alignment :: VkSubresourceLayout -> Int

peekElemOff :: Ptr VkSubresourceLayout -> Int -> IO VkSubresourceLayout

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

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

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

peek :: Ptr VkSubresourceLayout -> IO VkSubresourceLayout

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

VkImageTiling

newtype VkImageTiling

Constructors

VkImageTiling Int32

Instances

Eq VkImageTiling

Methods

(==) :: VkImageTiling -> VkImageTiling -> Bool

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

Storable VkImageTiling

Methods

sizeOf :: VkImageTiling -> Int

alignment :: VkImageTiling -> Int

peekElemOff :: Ptr VkImageTiling -> Int -> IO VkImageTiling

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

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

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

peek :: Ptr VkImageTiling -> IO VkImageTiling

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

pattern VK_IMAGE_TILING_OPTIMAL :: VkImageTiling

pattern VK_IMAGE_TILING_LINEAR :: VkImageTiling

VkImageLayout

newtype VkImageLayout

Constructors

VkImageLayout Int32

Instances

Eq VkImageLayout

Methods

(==) :: VkImageLayout -> VkImageLayout -> Bool

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

Storable VkImageLayout

Methods

sizeOf :: VkImageLayout -> Int

alignment :: VkImageLayout -> Int

peekElemOff :: Ptr VkImageLayout -> Int -> IO VkImageLayout

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

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

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

peek :: Ptr VkImageLayout -> IO VkImageLayout

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

pattern VK_IMAGE_LAYOUT_UNDEFINED :: VkImageLayout

Implicit layout an image is when its contents are undefined due to various reasons (e.g. right after creation)

pattern VK_IMAGE_LAYOUT_GENERAL :: VkImageLayout

General layout when image can be used for any kind of access

pattern VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL :: VkImageLayout

Optimal layout when image is only used for color attachment read/write

pattern VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL :: VkImageLayout

Optimal layout when image is only used for depthstencil attachment readwrite

pattern VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL :: VkImageLayout

Optimal layout when image is used for read only depth/stencil attachment and shader access

pattern VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL :: VkImageLayout

Optimal layout when image is used for read only shader access

pattern VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL :: VkImageLayout

Optimal layout when image is used only as source of transfer operations

pattern VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL :: VkImageLayout

Optimal layout when image is used only as destination of transfer operations

pattern VK_IMAGE_LAYOUT_PREINITIALIZED :: VkImageLayout

Initial layout used when the data is populated by the CPU

VkImageType

newtype VkImageType

Constructors

VkImageType Int32

Instances

Eq VkImageType

Methods

(==) :: VkImageType -> VkImageType -> Bool

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

Storable VkImageType

Methods

sizeOf :: VkImageType -> Int

alignment :: VkImageType -> Int

peekElemOff :: Ptr VkImageType -> Int -> IO VkImageType

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

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

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

peek :: Ptr VkImageType -> IO VkImageType

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

pattern VK_IMAGE_TYPE_1D :: VkImageType

pattern VK_IMAGE_TYPE_2D :: VkImageType

pattern VK_IMAGE_TYPE_3D :: VkImageType

vkDestroyImage

vkDestroyImage :: VkDevice -> VkImage -> Ptr VkAllocationCallbacks -> IO ()

data VkImageSubresource

Constructors

VkImageSubresource

Fields

• vkAspectMask :: VkImageAspectFlags
• vkMipLevel :: Word32
• vkArrayLayer :: Word32

Instances

Eq VkImageSubresource

Methods

(==) :: VkImageSubresource -> VkImageSubresource -> Bool

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

Storable VkImageSubresource

Methods

sizeOf :: VkImageSubresource -> Int

alignment :: VkImageSubresource -> Int

peekElemOff :: Ptr VkImageSubresource -> Int -> IO VkImageSubresource

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

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

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

peek :: Ptr VkImageSubresource -> IO VkImageSubresource

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

data VkImageSubresourceRange

Constructors

VkImageSubresourceRange

Fields

• vkAspectMask :: VkImageAspectFlags
• vkBaseMipLevel :: Word32
• vkLevelCount :: Word32
• vkBaseArrayLayer :: Word32
• vkLayerCount :: Word32

Instances

Eq VkImageSubresourceRange

Methods

(==) :: VkImageSubresourceRange -> VkImageSubresourceRange -> Bool

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

Storable VkImageSubresourceRange

Methods

sizeOf :: VkImageSubresourceRange -> Int

alignment :: VkImageSubresourceRange -> Int

peekElemOff :: Ptr VkImageSubresourceRange -> Int -> IO VkImageSubresourceRange

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

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

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

peek :: Ptr VkImageSubresourceRange -> IO VkImageSubresourceRange

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

vkGetImageSubresourceLayout

vkGetImageSubresourceLayout :: VkDevice -> VkImage -> Ptr VkImageSubresource -> Ptr VkSubresourceLayout -> IO ()

data VkImageCreateInfo

Constructors

VkImageCreateInfo

Fields

• vkSType :: VkStructureType
• vkPNext :: Ptr Void
• vkFlags :: VkImageCreateFlags
• vkImageType :: VkImageType
• vkFormat :: VkFormat
• vkExtent :: VkExtent3D
• vkMipLevels :: Word32
• vkArrayLayers :: Word32
• vkSamples :: VkSampleCountFlagBits
• vkTiling :: VkImageTiling
• vkUsage :: VkImageUsageFlags
• vkSharingMode :: VkSharingMode
• vkQueueFamilyIndexCount :: Word32
• vkPQueueFamilyIndices :: Ptr Word32
• vkInitialLayout :: VkImageLayout

Instances

Eq VkImageCreateInfo

Methods

(==) :: VkImageCreateInfo -> VkImageCreateInfo -> Bool

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

Storable VkImageCreateInfo

Methods

sizeOf :: VkImageCreateInfo -> Int

alignment :: VkImageCreateInfo -> Int

peekElemOff :: Ptr VkImageCreateInfo -> Int -> IO VkImageCreateInfo

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

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

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

peek :: Ptr VkImageCreateInfo -> IO VkImageCreateInfo

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