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.
Public Member Functions | Static Public Attributes | List of all members
ImageProcessingAtom::ImageBuilderRequests Class Referenceabstract

Inherits AZ::EBusTraits.

Public Member Functions

virtual IImageObjectPtr CreateImage (AZ::u32 width, AZ::u32 height, AZ::u32 maxMipCount, EPixelFormat pixelFormat)=0
 Create an image object.
 
virtual 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)=0
 Convert an image and save its products to the specified folder.
 
virtual IImageObjectPtr ConvertImageObjectInMemory (IImageObjectPtr imageObject, const AZStd::string &presetName, const AZStd::string &platformName, const AZ::Data::AssetId &sourceAssetId, const AZStd::string &sourceAssetName)=0
 Convert an image and return its product instead ot saving it to the disk.
 
virtual bool DoesSupportPlatform (const AZStd::string &platformId)=0
 Return whether the specified platform is supported by the image builder.
 
virtual bool IsPresetFormatSquarePow2 (const AZStd::string &presetName, const AZStd::string &platformName)=0
 Return whether the specified preset requires an image to be square and a power of 2.
 
virtual FileMask GetFileMask (AZStd::string_view imageFilePath)=0
 Extract the file mask of a file path.
 
virtual AZStd::vector< AZStd::string > GetFileMasksForPreset (const PresetName &presetName)=0
 Return all file masks associated with this preset.
 
virtual AZStd::vector< PresetName > GetPresetsForFileMask (const FileMask &fileMask)=0
 Return all preset names associated with this file mask.
 
virtual PresetName GetDefaultPreset ()=0
 Return the default opaque preset name.
 
virtual PresetName GetDefaultAlphaPreset ()=0
 Return the default alpha preset name.
 
virtual bool IsValidPreset (PresetName presetName)=0
 Return true if the preset name is valid.
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 
static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single
 
The documentation for this class was generated from the following file: