Open 3D Engine Atom Gem API Reference 24.09.2
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AtomToolsFramework::PreviewRenderer Class Referencefinal

Processes requests for setting up content that gets rendered to a texture and captured to an image. More...

#include <PreviewRenderer.h>

Inherits AtomToolsFramework::PreviewRendererInterface, PreviewerFeatureProcessorProviderBus::Handler, and AZ::SystemTickBus::Handler.

Public Member Functions

 AZ_CLASS_ALLOCATOR (PreviewRenderer, AZ::SystemAllocator)
 
 AZ_RTTI (PreviewRenderer, "{60FCB7AB-2A94-417A-8C5E-5B588D17F5D1}", PreviewRendererInterface)
 
 PreviewRenderer (const AZStd::string &sceneName, const AZStd::string &pipelineName)
 
void AddCaptureRequest (const PreviewRendererCaptureRequest &captureRequest) override
 
AZ::RPI::ScenePtr GetScene () const override
 
AZ::RPI::ViewPtr GetView () const override
 
AZ::Uuid GetEntityContextId () const override
 
void ProcessCaptureRequests ()
 
void CancelCaptureRequest ()
 
void CompleteCaptureRequest ()
 
void LoadContent ()
 
void UpdateLoadContent ()
 
void CancelLoadContent ()
 
void PoseContent ()
 
AZ::Render::FrameCaptureId StartCapture ()
 
void EndCapture ()
 
- Public Member Functions inherited from AtomToolsFramework::PreviewRendererInterface
 AZ_RTTI (PreviewRendererInterface, "{C5B5E3D0-0055-4C08-9B98-FDBBB5F05BED}")
 

Detailed Description

Processes requests for setting up content that gets rendered to a texture and captured to an image.

Member Function Documentation

◆ AddCaptureRequest()

void AtomToolsFramework::PreviewRenderer::AddCaptureRequest ( const PreviewRendererCaptureRequest & captureRequest)
overridevirtual

◆ GetEntityContextId()

AZ::Uuid AtomToolsFramework::PreviewRenderer::GetEntityContextId ( ) const
overridevirtual

◆ GetScene()

AZ::RPI::ScenePtr AtomToolsFramework::PreviewRenderer::GetScene ( ) const
overridevirtual

◆ GetView()

AZ::RPI::ViewPtr AtomToolsFramework::PreviewRenderer::GetView ( ) const
overridevirtual

The documentation for this class was generated from the following file: