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

contextGetVulkanDevice

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

- Defined in GstVulkan-1.0.d.ts:108
Parameters
- context: Gst.Context
- device: VulkanDevice
Returns boolean

contextGetVulkanDisplay

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

- Defined in GstVulkan-1.0.d.ts:109
Parameters
- context: Gst.Context
- display: VulkanDisplay
Returns boolean

contextGetVulkanInstance

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

- Defined in GstVulkan-1.0.d.ts:110
Parameters
- context: Gst.Context
- instance: VulkanInstance
Returns boolean

contextGetVulkanQueue

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

- Defined in GstVulkan-1.0.d.ts:111
Parameters
- context: Gst.Context
- queue: VulkanQueue
Returns boolean

contextSetVulkanDevice

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

- Defined in GstVulkan-1.0.d.ts:117
Sets device on context

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

contextSetVulkanDisplay

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

- Defined in GstVulkan-1.0.d.ts:123
Sets display on context

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

contextSetVulkanInstance

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

- Defined in GstVulkan-1.0.d.ts:129
Sets instance on context

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

contextSetVulkanQueue

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

- Defined in GstVulkan-1.0.d.ts:135
Sets queue on context

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

isVulkanBufferMemory

isVulkanBufferMemory(mem: Memory): boolean

- Defined in GstVulkan-1.0.d.ts:136
Parameters
- mem: Memory
Returns boolean

isVulkanImageMemory

isVulkanImageMemory(mem: Memory): boolean

- Defined in GstVulkan-1.0.d.ts:137
Parameters
- mem: Memory
Returns boolean

isVulkanMemory

isVulkanMemory(mem: Memory): boolean

- Defined in GstVulkan-1.0.d.ts:138
Parameters
- mem: Memory
Returns boolean

vulkanBufferMemoryAlloc

vulkanBufferMemoryAlloc(device: VulkanDevice, size: number, usage: BufferUsageFlags, memPropFlags: MemoryPropertyFlags): Memory

- Defined in GstVulkan-1.0.d.ts:146
Allocate a new #GstVulkanBufferMemory.

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

vulkanBufferMemoryInitOnce

vulkanBufferMemoryInitOnce(): void

- Defined in GstVulkan-1.0.d.ts:151
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

vulkanBufferMemoryWrapped

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

- Defined in GstVulkan-1.0.d.ts:160
Allocated a new wrapped #GstVulkanBufferMemory with buffer.

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

vulkanCreateShader

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

- Defined in GstVulkan-1.0.d.ts:161
Parameters
- device: VulkanDevice
- code: string
- size: number
Returns VulkanHandle

vulkanDisplayTypeToExtensionString

vulkanDisplayTypeToExtensionString(type: VulkanDisplayType): string

- Defined in GstVulkan-1.0.d.ts:162
Parameters
- type: VulkanDisplayType
Returns string

vulkanEnsureElementData

vulkanEnsureElementData(element: Gst.Element, displayPtr: VulkanDisplay, instancePtr: VulkanInstance): [boolean, VulkanDisplay, VulkanInstance]

- Defined in GstVulkan-1.0.d.ts:175
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
- displayPtr: VulkanDisplay
  
  the resulting #GstVulkanDisplay
- instancePtr: VulkanInstance
  
  the resulting #GstVulkanInstance
Returns [boolean, VulkanDisplay, VulkanInstance]

vulkanErrorQuark

vulkanErrorQuark(): Quark

- Defined in GstVulkan-1.0.d.ts:176
Returns Quark

vulkanFormatGetInfo

vulkanFormatGetInfo(format: Vulkan.Format): VulkanFormatInfo

- Defined in GstVulkan-1.0.d.ts:177
Parameters
- format: Vulkan.Format
Returns VulkanFormatInfo

vulkanGetOrCreateImageView

vulkanGetOrCreateImageView(image: VulkanImageMemory): VulkanImageView

- Defined in GstVulkan-1.0.d.ts:178
Parameters
- image: VulkanImageMemory
Returns VulkanImageView

vulkanGlobalContextQuery

vulkanGlobalContextQuery(element: Gst.Element, contextType: string): void

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

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

vulkanHandleContextQuery

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

- Defined in GstVulkan-1.0.d.ts:186
Parameters
- element: Gst.Element
- query: Gst.Query
- display: VulkanDisplay
- instance: VulkanInstance
- device: VulkanDevice
Returns boolean

vulkanHandleSetContext

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

- Defined in GstVulkan-1.0.d.ts:198
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]

vulkanImageMemoryAlloc

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

- Defined in GstVulkan-1.0.d.ts:209
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
- memPropFlags: MemoryPropertyFlags
  
  VkDeviceMemory property flags for the new image
Returns Memory

vulkanImageMemoryInitOnce

vulkanImageMemoryInitOnce(): void

- Defined in GstVulkan-1.0.d.ts:214
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

vulkanImageMemoryWrapped

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

- Defined in GstVulkan-1.0.d.ts:215
Parameters
- device: VulkanDevice
- image: Vulkan.Image
- format: Vulkan.Format
- width: number
- height: number
- tiling: ImageTiling
- usage: ImageUsageFlags
- userData: object
- notify: GLib.DestroyNotify
Returns Memory

vulkanLocalContextQuery

vulkanLocalContextQuery(element: Gst.Element, contextType: string): Gst.Query

- Defined in GstVulkan-1.0.d.ts:222
Performs the steps necessary for executing a context query between only other elements in the pipeline

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

vulkanMemoryAlloc

vulkanMemoryAlloc(device: VulkanDevice, memoryTypeIndex: number, params: AllocationParams, size: number, memPropFlags: MemoryPropertyFlags): Memory

- Defined in GstVulkan-1.0.d.ts:231
Allocated a new #GstVulkanMemory.

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

vulkanMemoryFindMemoryTypeIndexWithTypeProperties

vulkanMemoryFindMemoryTypeIndexWithTypeProperties(device: VulkanDevice, typeBits: number, properties: MemoryPropertyFlags, typeIndex: number): boolean

- Defined in GstVulkan-1.0.d.ts:232
Parameters
- device: VulkanDevice
- typeBits: number
- properties: MemoryPropertyFlags
- typeIndex: number
Returns boolean

vulkanMemoryHeapFlagsToString

vulkanMemoryHeapFlagsToString(propBits: MemoryHeapFlags): string

- Defined in GstVulkan-1.0.d.ts:233
Parameters
- propBits: MemoryHeapFlags
Returns string

vulkanMemoryInitOnce

vulkanMemoryInitOnce(): void

- Defined in GstVulkan-1.0.d.ts:238
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

vulkanMemoryPropertyFlagsToString

vulkanMemoryPropertyFlagsToString(propBits: MemoryPropertyFlags): string

- Defined in GstVulkan-1.0.d.ts:239
Parameters
- propBits: MemoryPropertyFlags
Returns string

vulkanRunQuery

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

- Defined in GstVulkan-1.0.d.ts:240
Parameters
- element: Gst.Element
- query: Gst.Query
- direction: Gst.PadDirection
Returns boolean

vulkanSampleCountFlagsToString

vulkanSampleCountFlagsToString(sampleCountBits: SampleCountFlags): string

- Defined in GstVulkan-1.0.d.ts:241
Parameters
- sampleCountBits: SampleCountFlags
Returns string

vulkanTrashMiniObjectUnref

vulkanTrashMiniObjectUnref(device: VulkanDevice, userData: object): void

- Defined in GstVulkan-1.0.d.ts:242
Parameters
- device: VulkanDevice
- userData: object
Returns void

vulkanTrashObjectUnref

vulkanTrashObjectUnref(device: VulkanDevice, userData: object): void

- Defined in GstVulkan-1.0.d.ts:243
Parameters
- device: VulkanDevice
- userData: object
Returns void

vulkanWindowErrorQuark

vulkanWindowErrorQuark(): Quark

- Defined in GstVulkan-1.0.d.ts:244
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

contextGetVulkanDevice

Parameters

context: Gst.Context

device: VulkanDevice

Returns boolean

contextGetVulkanDisplay

Parameters

context: Gst.Context

display: VulkanDisplay

Returns boolean

contextGetVulkanInstance

Parameters

context: Gst.Context

instance: VulkanInstance

Returns boolean

contextGetVulkanQueue

Parameters

context: Gst.Context

queue: VulkanQueue

Returns boolean

contextSetVulkanDevice

Parameters

context: Gst.Context

device: VulkanDevice

Returns void

contextSetVulkanDisplay

Parameters

context: Gst.Context

display: VulkanDisplay

Returns void

contextSetVulkanInstance

Parameters

context: Gst.Context

instance: VulkanInstance

Returns void

contextSetVulkanQueue

Parameters

context: Gst.Context

queue: VulkanQueue

Returns void

isVulkanBufferMemory

Parameters

mem: Memory

Returns boolean

isVulkanImageMemory

Parameters

mem: Memory

Returns boolean

isVulkanMemory

Parameters

mem: Memory

Returns boolean

vulkanBufferMemoryAlloc

Parameters

device: VulkanDevice

size: number

usage: BufferUsageFlags

memPropFlags: MemoryPropertyFlags

Returns Memory

vulkanBufferMemoryInitOnce