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.
PassTemplatesAutoLoader.h File Reference

Contains the definition of the PassTemplatesAutoLoader which provides a data-driven alternative for Gems and Projects to load custom PassTemplates. More...

#include <AzCore/Component/Component.h>
#include <Atom/RPI.Public/Pass/PassSystemInterface.h>

Classes

class  AZ::RPI::PassTemplatesAutoLoader
 A data-driven System Component that loads PassTemplates across all Gems and the Game Project. @detail This service provides an opt-in mechanism for Gems and any Game Project to load custom PassTemplates.azasset WITHOUT having to write C++ code. This system component works as a convenience service because there's already an API in AZ::RPI::PassSystemInterface::OnReadyLoadTemplatesEvent that helps Gems and Game Projects load their custom PassTemplates (*.azasset), the problem is, of course, that C++ code needs to be written to invoque the API. And this is where this System Component comes to the rescue. How it works? This service, at startup time, looks across all active Gems for assets with the following naming convention: "Passes/<Gem Name>/AutoLoadPassTemplates.azassset". or (Applicable to the Game Project) "Passes/<Project Name>/AutoLoadPassTemplates.azassset". or (Applicable to the Game Project) "Assets/Passes/<Project Name>/AutoLoadPassTemplates.azassset". If any of those asset paths exist, this service will automatically add those PassTemplates to the PassLibrary. More...
 

Namespaces

namespace  AZ
 This file holds useful material related utility functions.
 

Detailed Description

Contains the definition of the PassTemplatesAutoLoader which provides a data-driven alternative for Gems and Projects to load custom PassTemplates.