comp_window_peek.h

Go to the documentation of this file.

// Copyright 2022, Simon Zeni <simon@bl4ckb0ne.ca>
// Copyright 2025-2026, NVIDIA CORPORATION.
// SPDX-License-Identifier: BSL-1.0
/*!
 * @file
 * @brief Displays the content of one or both eye onto a desktop window
 * @author Simon Zeni <simon@bl4ckb0ne.ca>
 * @ingroup comp_main
 */
 
#pragma once
 
#include "xrt/xrt_config_have.h"
 
#ifndef XRT_FEATURE_WINDOW_PEEK
#error "XRT_FEATURE_WINDOW_PEEK not enabled"
#endif
 
#include "os/os_threading.h"
 
struct comp_compositor;
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum comp_window_peek_eye
{
        COMP_WINDOW_PEEK_EYE_LEFT = 0,
        COMP_WINDOW_PEEK_EYE_RIGHT = 1,
        COMP_WINDOW_PEEK_EYE_BOTH = 2,
};
 
struct comp_window_peek;
 
struct comp_window_peek *
comp_window_peek_create(struct comp_compositor *c);
 
void
comp_window_peek_destroy(struct comp_window_peek **w_ptr);
 
void
comp_window_peek_blit(struct comp_window_peek *w, VkImage src, int32_t width, int32_t height);
 
/*!
 *
 * Getter for the peek window's eye enum.
 * This is a getter function so that struct comp_window_peek can be private.
 *
 * @param[in] w The peek window struct this compositor has.
 * @return The eye that the peek window wants to display.
 *
 */
enum comp_window_peek_eye
comp_window_peek_get_eye(struct comp_window_peek *w);
 
/*!
 * Gets the required vulkan instance extensions for comp_window_peek support
 *
 * @param[inout] out_required_builder  builder for the list of required instance extensions to enable,
 *                                     the builder may already contain some/all of the required, duplicates will
 *                                     not be added.
 */
bool
comp_window_peek_get_vk_instance_exts(struct u_extension_list_builder *out_required_builder);
 
#ifdef __cplusplus
}
#endif