X11DisplayOp

🚧 Documentation is under development

The Holoscan SDK guide is currently under active development. Some sections may be incomplete or change without notice.

Questions? Contact RidgeRun or email to support@ridgerun.com.

Holoscan SDK

< >

Contents Pin

• Overview
  • Scope and Release Coverage
  • How Can RidgeRun Help?
  • Holoscan SDK at a Glance
  • Why the API Changed
  • Architecture and Execution Model
• Build, Run, and Validate
  • Build the SDK on AGX Orin
  • Running and Stopping
  • Run SDK Examples
• Core Concepts
  • Operators and Graphs
    • Operator Lifecycle
    • Ports, Samples, and Payload Types
    • Temporal Contracts and Input Selection
    • Building Graphs and Queue Policies
    • Fan-Out, Fan-In, Mux, and Demux
    • Execution Planning and Capacity
      • Automatic Partitioning and Plan Inspection
      • Rates, Queue Sizing, and Derived Tensor Capacity
    • Dynamic Graph Behavior
  • Tensor Data and Memory
    • Tensor Contracts and Memory Types
    • Sensor Payloads and Schemas
    • Allocation Ownership and Tensor Pools
    • Zero-Copy Data Flow and CUDA Stream Ordering
    • Copy Paths and Memory Conversion
    • External Memory: VPI, PVA, NvSci, and DLPack
  • Interprocess Communication
    • Channels and HoloMQ
    • External Endpoints and Endpoint Catalogs
    • Descriptor-Tensor External Topics
    • Standalone ChannelRuntime Clients
    • Dynamic External Peers
• Application and Operator Development
  • Building an HSDK Application
  • Writing a Minimal Operator
  • Typed Parameters and Configuration
  • Reading, Writing, and Forwarding Data
  • Writing Tensor Operators
  • Complete Operator Patterns
  • Authoring Runtime Behavior
  • Runtime Parameter Updates
  • Lifecycle Callbacks and Restart Control
  • Performance and Debugging
  • SDK Source Map
• Operator Reference
  • Core Operators
    • ConvertToOp
    • CopyMakeBorderOp
    • CustomCropOp
    • HolovizOp
    • InferenceOp
    • NonMaximumSuppressionOp
    • NormalizeOp
    • ReformatOp
    • RemapOp
    • ResizeOp
  • Holoscan Camera
    • Overview
    • Build and Installation
    • V4L2CaptureOp
    • SIPLCaptureOp
  • Holoscan RidgeRun
    • Overview
    • Build and Installation
    • ArgusCameraOp
    • V4L2SourceOp
    • V4L2UserPtrSourceOp
    • BgraToPlanarTensorOp
    • RawBayerToBgraOp
    • RawBayerToYoloTensorOp
    • YuyvToBgraOp
    • TensorRtInferenceOp
    • DrmDisplayOp
    • DrmBgraDisplayOp
    • X11DisplayOp
    • CudaCompositorOp
    • DepthColorizerOp
    • FakesinkOp
    • FrameSkipperOp
    • InterprocessSrcOp
    • TestPatternOp
• Migration from Holoscan 4.x
  • Concept Map
  • Applications, Fragments, and Graphs
  • Conditions and Temporal Contracts
  • Code-Level API Evolution
• Examples
  • Core
    • Vision Pipeline Example
    • Managed Run Control Example
    • Automatic Partitioning Example
    • Rate-Aware Ports and Tensor Pool Capacity Example
    • CUDA Green Context Example
    • Inference Example
    • Descriptor-Tensor External Topic Example
    • HoloMQ Example
  • Holoscan Camera
    • SIPL Frame Saver Example
    • SIPL Stereo Monitor Example
  • Holoscan RidgeRun
    • Interprocess External-Endpoint Demo
• Benchmark and Use Cases
  • Holoscan vs GStreamer
    • Overview
    • Capture and Display
      • Execution context
      • G2G latency
      • CPU utilization
      • GPU utilization
      • Process memory (RSS)
      • Results
      • Analysis
    • Capture and Inference
      • Execution context
      • Software interlatency
      • Inference processing time
      • CPU utilization
      • GPU utilization
      • Process memory (RSS)
      • Results
      • Analysis
    • Compare the workloads
    • Implemented Applications
    • Framework Selection
  • Interprocess

Preliminary reference

This reference is preliminary. The set of available operators and HSDK applications, along with their APIs and documented behavior, may change in future releases.

X11DisplayOp

X11DisplayOp displays a contiguous CUDA BGRA tensor in an X11 window. It copies each frame into XImage-owned host storage and presents it through Xlib.

X11 display integration

Bring processed camera images into your X11 application. Contact RidgeRun for help integrating the display and measuring how it affects performance.

Input arguments

Argument	Meaning
width, height	Positive dimensions of the input BGRA tensor and window image.
title	Window title; defaults to Holoscan V4L2 Depth in the operator API.

Ports and data contract

Port	Memory	Queue	Trigger	Contract
input	CUDA device, contiguous	SDK default	OnEach	U8 rank-3 tensor with shape [height, width, 4] in BGRA order. Each sample is consumed by the display endpoint.

Example

ArgusCameraOp -> X11DisplayOp
V4L2UserPtrSourceOp -> RawBayerToBgraOp -> X11DisplayOp
TestPatternOp -> X11DisplayOp

Build

Follow Holoscan RidgeRun Build and Installation for the module build and installation. The operator-specific include, target, and runtime requirements are listed below.

Include x11_display/x11_display.hpp and link holoscan::x11_display. X11 development libraries and a valid DISPLAY connection are required for rendering.

Display requirements

At start() the operator creates the X11 window, graphics context and XImage. It accepts only a little-endian 32-bit TrueColor visual whose channel masks and row stride match packed BGRA. An incompatible visual disables the sink instead of silently swapping channels or presenting skewed rows. The window title is set from the constructor argument, and pressing q, Q or Escape, or closing the window, raises the application's stop signal.

Each compute validates the exact configured contiguous CUDA uint8 shape, copies the frame to XImage-owned host memory on the Holoscan CUDA stream, calls XPutImage, flushes the display and processes pending events. If X11 was disabled during startup, valid input frames are still consumed and no output is emitted. Cleanup destroys the XImage, window, graphics context and display connection.

Display and measurement scope

The X11 path includes a device-to-host presentation copy and desktop-server work. It should not be treated as equivalent to a headless fakesink or exclusive DRM/KMS output.

Source reference

You can find the source code at X11DisplayOp.

Related pages

• RawBayerToBgraOp produces the raw-camera BGRA input.
• YuyvToBgraOp converts packed YUYV before display.

Holoscan SDK

Back to top ↑ < >