vreVirtualRealityChannel.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file vreVirtualRealityChannel.h
//! \brief Defines specialized virtual reality channel for VR-Engage
//!
//! This file contains the DtVreVirtualRealityChannel class which extends the
//! base DtVirtualRealityChannel class to provide VR-Engage specific behavior
//! for head-mounted display (HMD) rendering. It ensures proper render-to-texture
//! functionality for VR visualization and handles texture format updates.
//! \ingroup vreVirtualReality
 
#pragma once
 
#include "vrePlayerStation/export.h"
#include <vrvVirtualReality/DtVirtualRealityChannel.h>
 
namespace makVre
{
//! \brief Specialized virtual reality channel for VR-Engage
//!
//! DtVreVirtualRealityChannel extends the base DtVirtualRealityChannel to provide
//! VR-Engage specific behavior for head-mounted display (HMD) rendering. It enforces
//! render-to-texture mode which is essential for proper VR visualization, and
//! provides methods to rebuild the render texture when needed. This class ensures
//! that the post-processing manager cannot disable render-to-texture mode, which
//! would break VR functionality.
//! \ingroup vreVirtualReality
class PLAYERSTATION_DLL DtVreVirtualRealityChannel : public makVrv::DtVirtualRealityChannel
{
public:
   //! \brief Constructor
   //! \param de Reference to the display engine
   //! \param window Pointer to the OSG window this channel renders to
   //! \param config Channel configuration parameters
   //!
   //! Creates a new virtual reality channel for the specified window and configuration.
   //! This initializes a channel that renders the scene from the perspective of an
   //! HMD eye position.
   DtVreVirtualRealityChannel(makVrv::DtDe& de, makVrv::DtOsgWindow* window, makVrv::DtChannelConfiguration& config);
 
   //! \brief Destructor
   //!
   //! Cleans up resources used by the virtual reality channel.
   virtual ~DtVreVirtualRealityChannel() override;
 
   //! \brief Controls render-to-texture mode for this channel
   //! \param enabled Whether render-to-texture should be enabled
   //!
   //! Overridden to enforce render-to-texture mode for VR channels. This
   //! implementation ignores attempts to disable render-to-texture, since
   //! VR channels are only useful with render-to-texture enabled. This
   //! prevents the post-processing manager from automatically disabling it
   //! when there are no active post-processors, which would break VR functionality.
   virtual void setRenderToTexture(bool enabled) override;
 
   //! \brief Initializes or reinitializes the render texture
   //!
   //! Overridden to provide additional signaling when the texture changes.
   //! This ensures that any components depending on the texture are notified
   //! when it's recreated, allowing them to update their references accordingly.
   virtual void initializeRenderTexture() override;
 
   //! \brief Forces a rebuild of the render texture
   //!
   //! Marks the render texture format as dirty, which will cause it to be
   //! rebuilt during the next frame. This is useful when the texture format
   //! needs to be updated due to changes in rendering requirements or when
   //! the texture needs to be recreated for any other reason.
   virtual void dirtyRenderTextureFormat();
};
 
//! \brief Factory class for creating VR-Engage virtual reality channels
//!
//! DtVreVirtualRealityChannelCreator implements the factory pattern for creating
//! DtVreVirtualRealityChannel instances. It allows the channel system to create
//! virtual reality channels without knowing the specific implementation details.
//! \ingroup vreVirtualReality
class PLAYERSTATION_DLL DtVreVirtualRealityChannelCreator : public makVrv::DtChannelCreator
{
public:
   //! \brief Creates a new virtual reality channel
   //! \param de Reference to the display engine
   //! \param window Pointer to the window this channel will render to
   //! \param config Channel configuration parameters
   //! \return Pointer to the newly created channel
   //!
   //! Factory method that creates a new DtVreVirtualRealityChannel instance
   //! with the specified parameters.
   virtual makVrv::DtChannel* create(
      makVrv::DtDe& de, makVrv::DtWindow* window, makVrv::DtChannelConfiguration& config) override;
};
} // namespace makVre