Functions

	context_new_hip_device (device)
	hip_ensure_element_data (element, vendor, device_id, device)
	hip_handle_context_query (element, query, device)
	hip_handle_set_context (element, context, vendor, device_id, device)
	hip_load_library (vendor)
	hip_rtc_compile (device, source, options, num_options)
	hip_rtc_load_library (vendor)
	is_hip_memory (mem)

Details

GstHip.context_new_hip_device(device)

Parameters:

device (GstHip.HipDevice) – a GstHip.HipDevice

Returns:

a new Gst.Context embedding the device

Return type:

Gst.Context

New in version 1.28.

GstHip.hip_ensure_element_data(element, vendor, device_id, device)

Parameters:

• element (Gst.Element) – the Gst.Element running the query

• vendor (GstHip.HipVendor) – a GstHip.HipVendor

• device_id (int) – preferred device-id, pass device_id >=0 when the device_id explicitly required. Otherwise, set -1.

• device (GstHip.HipDevice) – the resulting GstHip.HipDevice

Returns:

whether a GstHip.HipDevice exists in device

device:

the resulting GstHip.HipDevice

Return type:

(bool, device: GstHip.HipDevice)

Perform the steps necessary for retrieving a GstHip.HipDevice from the surrounding elements or from the application using the Gst.Context mechanism.

If the content of device is not None, then no Gst.Context query is necessary for GstHip.HipDevice.

New in version 1.28.

GstHip.hip_handle_context_query(element, query, device)

Parameters:

• element (Gst.Element) – a Gst.Element

• query (Gst.Query) – a Gst.Query of type Gst.QueryType.CONTEXT

• device (GstHip.HipDevice or None) – a GstHip.HipDevice

Returns:

Whether the query was successfully responded to from the passed context.

Return type:

bool

New in version 1.28.

GstHip.hip_handle_set_context(element, context, vendor, device_id, device)

Parameters:

• element (Gst.Element) – a Gst.Element

• context (Gst.Context) – a Gst.Context

• vendor (GstHip.HipVendor) – a GstHip.HipVendor

• device_id (int) – preferred device-id, pass device_id >=0 when the device_id explicitly required. Otherwise, set -1.

• device (GstHip.HipDevice) – location of a GstHip.HipDevice

Returns:

whether the device could be set successfully

device:

location of a GstHip.HipDevice

Return type:

(bool, device: GstHip.HipDevice)

Helper function for implementing Gst.Element.do_set_context() in HIP capable elements.

Retrieves the GstHip.HipDevice in context and places the result in device.

New in version 1.28.

GstHip.hip_load_library(vendor)

Parameters:

vendor (GstHip.HipVendor) – a GstHip.HipVendor

Returns:

True if succeeded

Return type:

bool

Opens vendor specific runtime libraries

New in version 1.28.

GstHip.hip_rtc_compile(device, source, options, num_options)

Parameters:

• device (GstHip.HipDevice) – a GstHip.HipDevice

• source (str) – HIP kernel source

• options (str) – array of compile option string

• num_options (int) – option array size

Returns:

Compiled kernel blob or None if failed. *

Return type:

str or None

Compiles source with given compile options

New in version 1.28.

GstHip.hip_rtc_load_library(vendor)

Parameters:

vendor (GstHip.HipVendor) – a GstHip.HipVendor

Returns:

True if succeeded

Return type:

bool

Opens vendor specific runtime compiler libraries

New in version 1.28.

GstHip.is_hip_memory(mem)

Parameters:

mem (Gst.Memory) – a Gst.Memory

Returns:

True if mem is a GstHip.HipMemory

Return type:

bool

New in version 1.28.