Open 3D Engine Atom Gem API Reference 25.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
AtomToolsFramework::PreviewContent Class Referenceabstract

Interface for describing scene content that will be rendered using the PreviewRenderer. More...

#include <PreviewContent.h>

Public Member Functions

 AZ_CLASS_ALLOCATOR (PreviewContent, AZ::SystemAllocator)
 
virtual void Load ()=0
 Initiate loading of scene content, models, materials, etc.
 
virtual bool IsReady () const =0
 Return true if content is loaded and ready to render.
 
virtual bool IsError () const =0
 Return true if content failed to load.
 
virtual void ReportErrors ()=0
 Report any issues encountered while loading.
 
virtual void Update ()=0
 Prepare or pose content before rendering.
 
virtual bool IsReadyToRender ()=0
 

Detailed Description

Interface for describing scene content that will be rendered using the PreviewRenderer.

Member Function Documentation

◆ IsReadyToRender()

virtual bool AtomToolsFramework::PreviewContent::IsReadyToRender ( )
pure virtual

Returns true when it is guaranteed that the content is in GPU memory and ready to render.

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