diff mbox series

[FFmpeg-devel] doc/ffmpeg: Document device selection for Vulkan

Message ID 8622368e-7d82-6c6c-ccb9-834a83665eeb@jkqxz.net
State New
Headers show
Series [FFmpeg-devel] doc/ffmpeg: Document device selection for Vulkan
Related show

Checks

Context Check Description
andriy/ffmpeg-patchwork pending
andriy/ffmpeg-patchwork success Applied patch
andriy/ffmpeg-patchwork success Configure finished
andriy/ffmpeg-patchwork success Make finished
andriy/ffmpeg-patchwork success Make fate finished

Commit Message

Mark Thompson Feb. 9, 2020, 7:19 p.m. UTC
---
 doc/ffmpeg.texi | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

Comments

Mark Thompson Feb. 9, 2020, 8:41 p.m. UTC | #1
On 09/02/2020 19:19, Mark Thompson wrote:
> ---
>  doc/ffmpeg.texi | 14 ++++++++++++++
>  1 file changed, 14 insertions(+)
> 
> diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
> index dd461c02fc..29753f06ca 100644
> --- a/doc/ffmpeg.texi
> +++ b/doc/ffmpeg.texi
> @@ -1029,6 +1029,20 @@ Choose the GPU device on the second platform supporting the @emph{cl_khr_fp16}
>  extension.
>  @end table
>  
> +@item vulkan
> +If @var{device} is an integer, it selects the device by its index in a
> +system-dependent list of devices.  If @var{device} is any other string, it
> +selects the first device with a name containing that string as a substring.
> +
> +Examples:
> +@table @emph
> +@item -init_hw_device vulkan:1
> +Choose the second device on the system.
> +
> +@item -init_hw_device vulkan:RADV
> +Choose the first device with a name containing the string @emph{RADV}.
> +@end table
> +
>  @end table
>  
>  @item -init_hw_device @var{type}[=@var{name}]@@@var{source}
> 

> 19:53 < Lynne> jkqxz: patch lgtm

Applied.

Thanks,

- Mark
diff mbox series

Patch

diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
index dd461c02fc..29753f06ca 100644
--- a/doc/ffmpeg.texi
+++ b/doc/ffmpeg.texi
@@ -1029,6 +1029,20 @@  Choose the GPU device on the second platform supporting the @emph{cl_khr_fp16}
 extension.
 @end table
 
+@item vulkan
+If @var{device} is an integer, it selects the device by its index in a
+system-dependent list of devices.  If @var{device} is any other string, it
+selects the first device with a name containing that string as a substring.
+
+Examples:
+@table @emph
+@item -init_hw_device vulkan:1
+Choose the second device on the system.
+
+@item -init_hw_device vulkan:RADV
+Choose the first device with a name containing the string @emph{RADV}.
+@end table
+
 @end table
 
 @item -init_hw_device @var{type}[=@var{name}]@@@var{source}