Open 3D Engine Atom Gem API Reference  23.05.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 | Static Public Member Functions | List of all members
ImageProcessingAtom::BuilderPluginComponent Class Reference

BuilderPluginComponent is to handle the lifecycle of ImageBuilder module. More...

#include <ImageBuilderComponent.h>

Inherits Component, Handler, and Handler.

Public Member Functions

void Init () override
 
void Activate () override
 
void Deactivate () override
 
IImageObjectPtr LoadImage (const AZStd::string &filePath) override
 
IImageObjectPtr LoadImagePreview (const AZStd::string &filePath) override
 
IImageObjectPtr CreateImage (AZ::u32 width, AZ::u32 height, AZ::u32 maxMipCount, EPixelFormat pixelFormat) override
 
AZStd::vector
< AssetBuilderSDK::JobProduct > 		ConvertImageObject (IImageObjectPtr imageObject, const AZStd::string &presetName, const AZStd::string &platformName, const AZStd::string &outputDir, const AZ::Data::AssetId &sourceAssetId, const AZStd::string &sourceAssetName) override
 
IImageObjectPtr ConvertImageObjectInMemory (IImageObjectPtr imageObject, const AZStd::string &presetName, const AZStd::string &platformName, const AZ::Data::AssetId &sourceAssetId, const AZStd::string &sourceAssetName) override
 
bool DoesSupportPlatform (const AZStd::string &platformId) override
 
bool IsPresetFormatSquarePow2 (const AZStd::string &presetName, const AZStd::string &platformName) override
 
FileMask GetFileMask (AZStd::string_view imageFilePath) override
 
AZStd::vector< AZStd::string > GetFileMasksForPreset (const PresetName &presetName) override
 
AZStd::vector< PresetName > GetPresetsForFileMask (const FileMask &fileMask) override
 
PresetName GetDefaultPreset () override
 
PresetName GetDefaultAlphaPreset () override
 
bool IsValidPreset (PresetName presetName) override
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &incompatible)
 

Detailed Description

BuilderPluginComponent is to handle the lifecycle of ImageBuilder module.

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