stable/opengl_interop/opengl_interop_user_guide.md

Go to the documentation of this file.

<!-- Copyright (c) 2015, NVIDIA CORPORATION.  All rights reserved. -->

@defgroup vwx_sample_opengl_interop OpenGL Interop Sample App
@brief OpenGL Interop Sample user guide.
@ingroup nvx_samples
@{

<a name="Introduction">
## Introduction ##

`nvx_sample_opengl_interop` shows the interoperability of VisionWorks with OpenGL.

`nvx_sample_opengl_interop` is installed in the following directory:

    /usr/share/visionworks/sources/samples/opengl_interop

For the steps to build sample applications, see the @ref nvx_samples_and_demos section for your OS.

<a name="Executing">
## Executing the  OpenGL Interop Sample ##

    ./nvx_sample_opengl_interop [options]

### Command Line Options ###

This topic provides a list of supported options and the values they consume.

#### \-s, \--source ####
- Parameter: [inputUri]
- Description: Specifies the input URI. Accepted parameters include a video (in .avi format), an image or an image sequence (.png, .jpg, .jpeg, .bmp, .tiff), camera to grab frames.
- Usage:

    - `--source=/path/to/video.avi` for video
    - `--source=/path/to/image.png` for image
    - `--source=/path/to/image_%04d_sequence.png` for image sequence sequence
    - `--source="device:///v4l2?index=0"` for the first V4L2 camera
    - `--source="device:///v4l2?index=1"` for the second V4L2 camera.
    - `--source="device:///nvcamera?index=0"` for the GStreamer NVIDIA camera (Jetson TX1 only).
    - `--source="device:///nvmedia?config=dvp-ov10635-yuv422-ab-e2379&number=4"` for the GStreamer NVIDIA camera (Vibrante for Linux only).

@note The V4L platform has a permissions issue. The hardware decoder is used and the sample must be
executed with super user permissions, i.e., with `sudo`.

#### \-h, \--help ####
- Description: Prints the help message.

### Operational Keys ###
- Use `ESC` to close the sample.

@}