gulkan-device: Gulkan Reference Manual

Functions

GulkanDevice *	gulkan_device_new ()
gboolean	gulkan_device_create ()
gboolean	gulkan_device_create_from_vk ()
gboolean	gulkan_device_memory_type_from_properties ()
VkDevice	gulkan_device_get_handle ()
VkPhysicalDevice	gulkan_device_get_physical_handle ()
gboolean	gulkan_device_get_memory_fd ()
void	gulkan_device_wait_idle ()
void	gulkan_device_print_memory_properties ()
void	gulkan_device_print_memory_budget ()
VkDeviceSize	gulkan_device_get_heap_budget ()
GulkanQueue *	gulkan_device_get_graphics_queue ()
GulkanQueue *	gulkan_device_get_transfer_queue ()
VkPhysicalDeviceProperties *	gulkan_device_get_physical_device_properties ()
gboolean	gulkan_device_create_shader_module ()

Types and Values

#define	GULKAN_TYPE_DEVICE
	GulkanDevice

Object Hierarchy

    GObject
    ╰── GulkanDevice

Includes

#include <gulkan.h>

Description

Functions

gulkan_device_new ()

GulkanDevice *
gulkan_device_new (void);

gulkan_device_create ()

gboolean
gulkan_device_create (GulkanDevice *self,
                      GulkanInstance *instance,
                      VkPhysicalDevice device,
                      GSList *extensions);

Parameters

self	a GulkanDevice
instance	a GulkanInstance
device	a VkPhysicalDevice
extensions	A list of extensions to enable.	[element-type utf8]

Returns

TRUE on success

gulkan_device_create_from_vk ()

gboolean
gulkan_device_create_from_vk (GulkanDevice *self,
                              VkPhysicalDevice vk_physical_device,
                              VkDevice vk_device,
                              uint32_t graphics_queue_index,
                              uint32_t transfer_queue_index);

Parameters

self	a GulkanDevice
vk_physical_device	a VkPhysicalDevice
vk_device	a VkDevice
graphics_queue_index	The index of a graphics queue
transfer_queue_index	The index of a transfer queue

Returns

TRUE on success

gulkan_device_memory_type_from_properties ()

gboolean
gulkan_device_memory_type_from_properties
                               (GulkanDevice *self,
                                uint32_t memory_type_bits,
                                VkMemoryPropertyFlags memory_property_flags,
                                uint32_t *type_index_out);

gulkan_device_get_handle ()

VkDevice
gulkan_device_get_handle (GulkanDevice *self);

Parameters

self

a GulkanDevice

Returns

a VkDevice.

[transfer none]

gulkan_device_get_physical_handle ()

VkPhysicalDevice
gulkan_device_get_physical_handle (GulkanDevice *self);

Parameters

self

a GulkanDevice

Returns

a VkPhysicalDevice.

[transfer none]

gulkan_device_get_memory_fd ()

gboolean
gulkan_device_get_memory_fd (GulkanDevice *self,
                             VkDeviceMemory image_memory,
                             int *fd);

gulkan_device_wait_idle ()

void
gulkan_device_wait_idle (GulkanDevice *self);

gulkan_device_print_memory_properties ()

void
gulkan_device_print_memory_properties (GulkanDevice *self);

gulkan_device_print_memory_budget ()

void
gulkan_device_print_memory_budget (GulkanDevice *self);

gulkan_device_get_heap_budget ()

VkDeviceSize
gulkan_device_get_heap_budget (GulkanDevice *self,
                               uint32_t i);

Parameters

self	a GulkanDevice
i	the the memory heap number

Returns

a VkDeviceSize.

[transfer none]

gulkan_device_get_graphics_queue ()

GulkanQueue *
gulkan_device_get_graphics_queue (GulkanDevice *self);

Parameters

self

a GulkanDevice

Returns

the graphics queue.

[transfer none]

gulkan_device_get_transfer_queue ()

GulkanQueue *
gulkan_device_get_transfer_queue (GulkanDevice *self);

Parameters

self

a GulkanDevice

Returns

the transfer queue.

[transfer none]

gulkan_device_get_physical_device_properties ()

VkPhysicalDeviceProperties *
gulkan_device_get_physical_device_properties
                               (GulkanDevice *self);

Parameters

self

a GulkanDevice

Returns

a VkPhysicalDeviceProperties.

[transfer none]

gulkan_device_create_shader_module ()

gboolean
gulkan_device_create_shader_module (GulkanDevice *self,
                                    const gchar *resource_name,
                                    VkShaderModule *module);

Parameters

self	a GulkanDevice
resource_name	the name of the GResource to use
module	the created VkShaderModule.	[out]

Returns

TRUE if the shader has been created

Types and Values

GULKAN_TYPE_DEVICE

#define GULKAN_TYPE_DEVICE gulkan_device_get_type ()

GulkanDevice

typedef struct _GulkanDevice GulkanDevice;