Namespace GstVulkan

Index

Enumerations

Classes

Interfaces

Variables

Functions

Variables

Const CAPS_FEATURE_MEMORY_VULKAN_BUFFER

CAPS_FEATURE_MEMORY_VULKAN_BUFFER: string

Const CAPS_FEATURE_MEMORY_VULKAN_IMAGE

CAPS_FEATURE_MEMORY_VULKAN_IMAGE: string

Const VULKAN_BUFFER_MEMORY_ALLOCATOR_NAME

VULKAN_BUFFER_MEMORY_ALLOCATOR_NAME: string

Const VULKAN_DEVICE_CONTEXT_TYPE_STR

VULKAN_DEVICE_CONTEXT_TYPE_STR: string

Const VULKAN_DISPLAY_CONTEXT_TYPE_STR

VULKAN_DISPLAY_CONTEXT_TYPE_STR: string

Const VULKAN_IMAGE_MEMORY_ALLOCATOR_NAME

VULKAN_IMAGE_MEMORY_ALLOCATOR_NAME: string

Const VULKAN_INSTANCE_CONTEXT_TYPE_STR

VULKAN_INSTANCE_CONTEXT_TYPE_STR: string

Const VULKAN_MAX_COMPONENTS

VULKAN_MAX_COMPONENTS: number

Const VULKAN_MEMORY_ALLOCATOR_NAME

VULKAN_MEMORY_ALLOCATOR_NAME: string

Const VULKAN_NON_DISPATCHABLE_HANDLE_FORMAT

VULKAN_NON_DISPATCHABLE_HANDLE_FORMAT: string

The printf format specifier for raw Vulkan non dispatchable handles.

Const VULKAN_QUEUE_CONTEXT_TYPE_STR

VULKAN_QUEUE_CONTEXT_TYPE_STR: string

Const VULKAN_SWAPPER_VIDEO_FORMATS

VULKAN_SWAPPER_VIDEO_FORMATS: string

Functions

context_get_vulkan_device

context_get_vulkan_device(context: Gst.Context, device: VulkanDevice): boolean

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:109
Parameters
- context: Gst.Context
- device: VulkanDevice
Returns boolean

context_get_vulkan_display

context_get_vulkan_display(context: Gst.Context, display: VulkanDisplay): boolean

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:110
Parameters
- context: Gst.Context
- display: VulkanDisplay
Returns boolean

context_get_vulkan_instance

context_get_vulkan_instance(context: Gst.Context, instance: VulkanInstance): boolean

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:111
Parameters
- context: Gst.Context
- instance: VulkanInstance
Returns boolean

context_get_vulkan_queue

context_get_vulkan_queue(context: Gst.Context, queue: VulkanQueue): boolean

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:112
Parameters
- context: Gst.Context
- queue: VulkanQueue
Returns boolean

context_set_vulkan_device

context_set_vulkan_device(context: Gst.Context, device: VulkanDevice): void

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:118
Sets device on context

Parameters
- context: Gst.Context
  
  a #GstContext
- device: VulkanDevice
  
  a #GstVulkanDevice
Returns void

context_set_vulkan_display

context_set_vulkan_display(context: Gst.Context, display: VulkanDisplay): void

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:124
Sets display on context

Parameters
- context: Gst.Context
  
  a #GstContext
- display: VulkanDisplay
  
  a #GstVulkanDisplay
Returns void

context_set_vulkan_instance

context_set_vulkan_instance(context: Gst.Context, instance: VulkanInstance): void

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:130
Sets instance on context

Parameters
- context: Gst.Context
  
  a #GstContext
- instance: VulkanInstance
  
  a #GstVulkanInstance
Returns void

context_set_vulkan_queue

context_set_vulkan_queue(context: Gst.Context, queue: VulkanQueue): void

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:136
Sets queue on context

Parameters
- context: Gst.Context
  
  a #GstContext
- queue: VulkanQueue
  
  a #GstVulkanQueue
Returns void

is_vulkan_buffer_memory

is_vulkan_buffer_memory(mem: Memory): boolean

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:137
Parameters
- mem: Memory
Returns boolean

is_vulkan_image_memory

is_vulkan_image_memory(mem: Memory): boolean

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:138
Parameters
- mem: Memory
Returns boolean

is_vulkan_memory

is_vulkan_memory(mem: Memory): boolean

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:139
Parameters
- mem: Memory
Returns boolean

vulkan_buffer_memory_alloc

vulkan_buffer_memory_alloc(device: VulkanDevice, size: number, usage: BufferUsageFlags, mem_prop_flags: MemoryPropertyFlags): Memory

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:147
Allocate a new #GstVulkanBufferMemory.

Parameters
- device: VulkanDevice
  
  a #GstVulkanDevice
- size: number
  
  size of the new buffer
- usage: BufferUsageFlags
  
  buffer usage flags
- mem_prop_flags: MemoryPropertyFlags
  
  memory properties flags for the backing memory
Returns Memory

vulkan_buffer_memory_init_once

vulkan_buffer_memory_init_once(): void

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:152
Initializes the Vulkan buffer memory allocator. It is safe to call this function multiple times. This must be called before any other #GstVulkanBufferMemory operation.

Returns void

vulkan_buffer_memory_wrapped

vulkan_buffer_memory_wrapped(device: VulkanDevice, buffer: Vulkan.Buffer, usage: BufferUsageFlags, user_data: object, notify: GLib.DestroyNotify): Memory

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:161
Allocated a new wrapped #GstVulkanBufferMemory with buffer.

Parameters
- device: VulkanDevice
  
  a #GstVulkanDevice
- buffer: Vulkan.Buffer
  
  a #VkBuffer
- usage: BufferUsageFlags
  
  usage flags of buffer
- user_data: object
  
  user data to call notify with
- notify: GLib.DestroyNotify
  
  a #GDestroyNotify called when buffer is no longer in use
Returns Memory

vulkan_create_shader

vulkan_create_shader(device: VulkanDevice, code: string, size: number): VulkanHandle

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:162
Parameters
- device: VulkanDevice
- code: string
- size: number
Returns VulkanHandle

vulkan_display_type_to_extension_string

vulkan_display_type_to_extension_string(type: VulkanDisplayType): string

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:163
Parameters
- type: VulkanDisplayType
Returns string

vulkan_ensure_element_data

vulkan_ensure_element_data(element: Gst.Element, display_ptr: VulkanDisplay, instance_ptr: VulkanInstance): [boolean, VulkanDisplay, VulkanInstance]

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:176
Perform the steps necessary for retrieving a #GstVulkanInstance and (optionally) an #GstVulkanDisplay from the surrounding elements or from the application using the #GstContext mechanism.

If the contents of display_ptr or instance_ptr are not %NULL, then no #GstContext query is necessary and no #GstVulkanInstance or #GstVulkanDisplay retrieval is performed.

Parameters
- element: Gst.Element
  
  a #GstElement
- display_ptr: VulkanDisplay
  
  the resulting #GstVulkanDisplay
- instance_ptr: VulkanInstance
  
  the resulting #GstVulkanInstance
Returns [boolean, VulkanDisplay, VulkanInstance]

vulkan_error_quark

vulkan_error_quark(): Quark

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:177
Returns Quark

vulkan_format_get_info

vulkan_format_get_info(format: Vulkan.Format): VulkanFormatInfo

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:178
Parameters
- format: Vulkan.Format
Returns VulkanFormatInfo

vulkan_get_or_create_image_view

vulkan_get_or_create_image_view(image: VulkanImageMemory): VulkanImageView

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:179
Parameters
- image: VulkanImageMemory
Returns VulkanImageView

vulkan_global_context_query

vulkan_global_context_query(element: Gst.Element, context_type: string): void

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:186
Performs the steps necessary for executing a context query including posting a message for the application to respond.

Parameters
- element: Gst.Element
  
  a #GstElement
- context_type: string
  
  the context type to query for
Returns void

vulkan_handle_context_query

vulkan_handle_context_query(element: Gst.Element, query: Gst.Query, display: VulkanDisplay, instance: VulkanInstance, device: VulkanDevice): boolean

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:187
Parameters
- element: Gst.Element
- query: Gst.Query
- display: VulkanDisplay
- instance: VulkanInstance
- device: VulkanDevice
Returns boolean

vulkan_handle_set_context

vulkan_handle_set_context(element: Gst.Element, context: Gst.Context, display: VulkanDisplay, instance: VulkanInstance): [boolean, VulkanDisplay, VulkanInstance]

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:199
Helper function for implementing #GstElementClass.set_context() in Vulkan capable elements.

Retrieve's the #GstVulkanDisplay or #GstVulkanInstance in context and places the result in display or instance respectively.

Parameters
- element: Gst.Element
  
  a #GstElement
- context: Gst.Context
  
  a #GstContext
- display: VulkanDisplay
  
  location of a #GstVulkanDisplay
- instance: VulkanInstance
  
  location of a #GstVulkanInstance
Returns [boolean, VulkanDisplay, VulkanInstance]

vulkan_image_memory_alloc

vulkan_image_memory_alloc(device: VulkanDevice, format: Vulkan.Format, width: number, height: number, tiling: ImageTiling, usage: ImageUsageFlags, mem_prop_flags: MemoryPropertyFlags): Memory

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:210
Allocated a new #GstVulkanImageMemory.

Parameters
- device: VulkanDevice
  
  a #GstVulkanDevice
- format: Vulkan.Format
  
  the VkFormat for the new image
- width: number
  
  width for the new image
- height: number
  
  height for the new image
- tiling: ImageTiling
  
  tiling for the new image
- usage: ImageUsageFlags
  
  usage flags for the new image
- mem_prop_flags: MemoryPropertyFlags
  
  VkDeviceMemory property flags for the new image
Returns Memory

vulkan_image_memory_init_once

vulkan_image_memory_init_once(): void

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:215
Initializes the Vulkan image memory allocator. It is safe to call this function multiple times. This must be called before any other #GstVulkanImageMemory operation.

Returns void

vulkan_image_memory_wrapped

vulkan_image_memory_wrapped(device: VulkanDevice, image: Vulkan.Image, format: Vulkan.Format, width: number, height: number, tiling: ImageTiling, usage: ImageUsageFlags, user_data: object, notify: GLib.DestroyNotify): Memory

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:216
Parameters
- device: VulkanDevice
- image: Vulkan.Image
- format: Vulkan.Format
- width: number
- height: number
- tiling: ImageTiling
- usage: ImageUsageFlags
- user_data: object
- notify: GLib.DestroyNotify
Returns Memory

vulkan_local_context_query

vulkan_local_context_query(element: Gst.Element, context_type: string): Gst.Query

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:223
Performs the steps necessary for executing a context query between only other elements in the pipeline

Parameters
- element: Gst.Element
  
  a #GstElement
- context_type: string
  
  the context type to query for
Returns Gst.Query

vulkan_memory_alloc

vulkan_memory_alloc(device: VulkanDevice, memory_type_index: number, params: AllocationParams, size: number, mem_prop_flags: MemoryPropertyFlags): Memory

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:232
Allocated a new #GstVulkanMemory.

Parameters
- device: VulkanDevice
  
  a #GstVulkanDevice
- memory_type_index: number
  
  the Vulkan memory type index
- params: AllocationParams
  
  a #GstAllocationParams
- size: number
  
  the size to allocate
- mem_prop_flags: MemoryPropertyFlags
Returns Memory

vulkan_memory_find_memory_type_index_with_type_properties

vulkan_memory_find_memory_type_index_with_type_properties(device: VulkanDevice, type_bits: number, properties: MemoryPropertyFlags, type_index: number): boolean

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:233
Parameters
- device: VulkanDevice
- type_bits: number
- properties: MemoryPropertyFlags
- type_index: number
Returns boolean

vulkan_memory_heap_flags_to_string

vulkan_memory_heap_flags_to_string(prop_bits: MemoryHeapFlags): string

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:234
Parameters
- prop_bits: MemoryHeapFlags
Returns string

vulkan_memory_init_once

vulkan_memory_init_once(): void

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:239
Initializes the Vulkan memory allocator. It is safe to call this function multiple times. This must be called before any other #GstVulkanMemory operation.

Returns void

vulkan_memory_property_flags_to_string

vulkan_memory_property_flags_to_string(prop_bits: MemoryPropertyFlags): string

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:240
Parameters
- prop_bits: MemoryPropertyFlags
Returns string

vulkan_run_query

vulkan_run_query(element: Gst.Element, query: Gst.Query, direction: Gst.PadDirection): boolean

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:241
Parameters
- element: Gst.Element
- query: Gst.Query
- direction: Gst.PadDirection
Returns boolean

vulkan_sample_count_flags_to_string

vulkan_sample_count_flags_to_string(sample_count_bits: SampleCountFlags): string

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:242
Parameters
- sample_count_bits: SampleCountFlags
Returns string

vulkan_trash_mini_object_unref

vulkan_trash_mini_object_unref(device: VulkanDevice, user_data: object): void

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:243
Parameters
- device: VulkanDevice
- user_data: object
Returns void

vulkan_trash_object_unref

vulkan_trash_object_unref(device: VulkanDevice, user_data: object): void

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:244
Parameters
- device: VulkanDevice
- user_data: object
Returns void

vulkan_window_error_quark

vulkan_window_error_quark(): Quark

- Defined in @types/Gjs/GstVulkan-1.0.d.ts:245
Returns Quark

Index

Enumerations

Classes

Interfaces

Variables

Functions

Variables

Const CAPS_FEATURE_MEMORY_VULKAN_BUFFER

Const CAPS_FEATURE_MEMORY_VULKAN_IMAGE

Const VULKAN_BUFFER_MEMORY_ALLOCATOR_NAME

Const VULKAN_DEVICE_CONTEXT_TYPE_STR

Const VULKAN_DISPLAY_CONTEXT_TYPE_STR

Const VULKAN_IMAGE_MEMORY_ALLOCATOR_NAME

Const VULKAN_INSTANCE_CONTEXT_TYPE_STR

Const VULKAN_MAX_COMPONENTS

Const VULKAN_MEMORY_ALLOCATOR_NAME

Const VULKAN_NON_DISPATCHABLE_HANDLE_FORMAT

Const VULKAN_QUEUE_CONTEXT_TYPE_STR

Const VULKAN_SWAPPER_VIDEO_FORMATS

Functions

context_get_vulkan_device

Parameters

context: Gst.Context

device: VulkanDevice

Returns boolean

context_get_vulkan_display

Parameters

context: Gst.Context

display: VulkanDisplay

Returns boolean

context_get_vulkan_instance

Parameters

context: Gst.Context

instance: VulkanInstance

Returns boolean

context_get_vulkan_queue

Parameters

context: Gst.Context

queue: VulkanQueue

Returns boolean

context_set_vulkan_device

Parameters

context: Gst.Context

device: VulkanDevice

Returns void

context_set_vulkan_display

Parameters

context: Gst.Context

display: VulkanDisplay

Returns void

context_set_vulkan_instance

Parameters

context: Gst.Context

instance: VulkanInstance

Returns void

context_set_vulkan_queue

Parameters

context: Gst.Context

queue: VulkanQueue

Returns void

is_vulkan_buffer_memory

Parameters

mem: Memory

Returns boolean

is_vulkan_image_memory

Parameters

mem: Memory

Returns boolean

is_vulkan_memory

Parameters

mem: Memory

Returns boolean

vulkan_buffer_memory_alloc

Parameters

device: VulkanDevice

size: number

usage: BufferUsageFlags

mem_prop_flags: MemoryPropertyFlags

Returns Memory

vulkan_buffer_memory_init_once