Graphics.Vulkan.Marshal.Create

This module is not part of auto-generated code based on vk.xml. It is also not included into Vulkan. It just provides convenient helpers for creation of vulkan structures.

Documentation

data CreateVkStruct x (fs :: [Symbol]) a

Safely fill-in a new vulkan structure

Instances

Monad (CreateVkStruct x fs)

Defined in Graphics.Vulkan.Marshal.Create

Methods

(>>=) :: CreateVkStruct x fs a -> (a -> CreateVkStruct x fs b) -> CreateVkStruct x fs b

(>>) :: CreateVkStruct x fs a -> CreateVkStruct x fs b -> CreateVkStruct x fs b

return :: a -> CreateVkStruct x fs a

Functor (CreateVkStruct x fs)

Defined in Graphics.Vulkan.Marshal.Create

Methods

fmap :: (a -> b) -> CreateVkStruct x fs a -> CreateVkStruct x fs b

(<$) :: a -> CreateVkStruct x fs b -> CreateVkStruct x fs a

Applicative (CreateVkStruct x fs)

Defined in Graphics.Vulkan.Marshal.Create

Methods

pure :: a -> CreateVkStruct x fs a

(<*>) :: CreateVkStruct x fs (a -> b) -> CreateVkStruct x fs a -> CreateVkStruct x fs b

liftA2 :: (a -> b -> c) -> CreateVkStruct x fs a -> CreateVkStruct x fs b -> CreateVkStruct x fs c

(*>) :: CreateVkStruct x fs a -> CreateVkStruct x fs b -> CreateVkStruct x fs b

(<*) :: CreateVkStruct x fs a -> CreateVkStruct x fs b -> CreateVkStruct x fs a

createVk :: forall a fs. (VulkanMarshal a, HandleRemFields a fs) => CreateVkStruct a fs () -> a

Create a vulkan structure.

Use smart creation functions like setVk, setStrRef, setListRef, etc to keep GC aware of references between dependent structures.

createVk produces at most one weak reference to a created structure with a set of haskell and C finalizers. These finalizers make sure all malloced memory is released and no managed memory gets purged too early.

(&*) :: CreateVkStruct x as () -> CreateVkStruct x bs () -> CreateVkStruct x (Union x as bs) () infixl 1

Combine multiple field writes.

set :: forall fname x. CanWriteField fname x => FieldType fname x -> CreateVkStruct x '[fname] ()

writeField wrapped into CreateVkStruct monad.

setAt :: forall fname i x. (CanWriteFieldArray fname x, IndexInBounds fname i x, KnownNat i) => FieldType fname x -> CreateVkStruct x '[fname] ()

writeFieldArray wrapped into CreateVkStruct monad.

setVk :: forall fname x afs a. (CanWriteField fname x, a ~ FieldType fname x, VulkanMarshal a, HandleRemFields a afs) => CreateVkStruct a afs () -> CreateVkStruct x '[fname] ()

Write fields of a member struct.

setVkRef :: forall fname x a. (CanWriteField fname x, FieldType fname x ~ Ptr a, VulkanMarshal a) => a -> CreateVkStruct x '[fname] ()

Write a pointer to a vulkan structure - member of current structure and make sure the member exists as long as this structure exists.

Prefer this function to using unsafePtr a, because the latter does not keep the dependency information in GC, which results in member structure being garbage-collected and the reference being invalid.

setStr :: forall fname x. (CanWriteFieldArray fname x, FieldType fname x ~ CChar) => String -> CreateVkStruct x '[fname] ()

Write a String into a vulkan struct in-place.

setStrRef :: forall fname x. (CanWriteField fname x, FieldType fname x ~ CString) => String -> CreateVkStruct x '[fname] ()

Allocate memory for a CString, store it, and write a pointer to it into vulkan structure.

This function also attaches a reliable finalizer to the vulkan struct, so that the allocated memory is freed when the structure is GCed.

setStrListRef :: forall fname x. (CanWriteField fname x, FieldType fname x ~ Ptr CString) => [String] -> CreateVkStruct x '[fname] ()

Allocate memory for an array of elements, store them, and write a pointer to the array into vulkan structure.

This function also attaches a reliable finalizer to the vulkan struct, so that the array memory is freed when the structure is GCed.

This function writes null pointer if used with an empty list.

setStrListCountAndRef :: forall countfname listfname x. (CanWriteField countfname x, CanWriteField listfname x, FieldType countfname x ~ Word32, FieldType listfname x ~ Ptr CString) => [String] -> CreateVkStruct x (Union x '[countfname] '[listfname]) ()

Equivalent to set on a count field and setStrListRef on a corresponding list field, where the count is set to the length of the list.

setListRef :: forall fname x a. (CanWriteField fname x, FieldType fname x ~ Ptr a, Storable a) => [a] -> CreateVkStruct x '[fname] ()

Allocate memory for an array of elements, store them, and write a pointer to the array into vulkan structure.

This function also attaches a reliable finalizer to the vulkan struct, so that the array memory is freed when the structure is GCed.

This function writes null pointer if used with an empty list.

setListCountAndRef :: forall countfname listfname x a. (CanWriteField countfname x, CanWriteField listfname x, FieldType countfname x ~ Word32, FieldType listfname x ~ Ptr a, Storable a) => [a] -> CreateVkStruct x (Union x '[countfname] '[listfname]) ()

Equivalent to set on a count field and setListRef on a corresponding list field, where the count is set to the length of the list.

class SetOptionalFields (x :: Type) (fs :: [Symbol]) where

Methods

setOptionalFields :: CreateVkStruct x fs ()

Instances

SetOptionalFields x ('[] :: [Symbol])

Defined in Graphics.Vulkan.Marshal.Create

Methods

setOptionalFields :: CreateVkStruct x '[] ()

(SetOptionalFields x fs, FieldMustBeOptional f x, Storable (FieldType f x), HasField f x) => SetOptionalFields x (f ': fs)

Defined in Graphics.Vulkan.Marshal.Create

Methods

setOptionalFields :: CreateVkStruct x (f ': fs) ()

class CUnionType x ~ isUnion => HandleRemainingFields (x :: Type) (fs :: [Symbol]) (isUnion :: Bool) where

Notify user if some required fields are missing and fill in optional fields.

Methods

handleRemFields :: CreateVkStruct x fs ()

Instances

(SetOptionalFields x (Difference (StructFieldNames x) fs), CUnionType x ~ 'False) => HandleRemainingFields x fs 'False

Defined in Graphics.Vulkan.Marshal.Create

Methods

handleRemFields :: CreateVkStruct x fs ()

(TypeError (SetUnionMsg x) :: Constraint, CUnionType x ~ 'True) => HandleRemainingFields x ('[] :: [Symbol]) 'True

Defined in Graphics.Vulkan.Marshal.Create

Methods

handleRemFields :: CreateVkStruct x '[] ()

(TypeError (SetUnionMsg x) :: Constraint, CUnionType x ~ 'True) => HandleRemainingFields x (a ': (b ': fs)) 'True

Defined in Graphics.Vulkan.Marshal.Create

Methods

handleRemFields :: CreateVkStruct x (a ': (b ': fs)) ()

CUnionType x ~ 'True => HandleRemainingFields x '[f] 'True

Defined in Graphics.Vulkan.Marshal.Create

Methods

handleRemFields :: CreateVkStruct x '[f] ()

type HandleRemFields x fs = HandleRemainingFields x fs (CUnionType x)

Notify user if some required fields are missing.

unsafeIOCreate :: (Ptr x -> IO a) -> CreateVkStruct x fs a

Unsafe perform arbitrary IO action with a pointer to data under construction. This is used to add more functionality to this monad.