Open 3D Engine TextureAtlas Gem API Reference  24.09
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 | Public Attributes | List of all members
TextureAtlasBuilder::AtlasBuilderInput Struct Reference

Struct that is used to communicate input commands. More...

#include <AtlasBuilderWorker.h>

Public Member Functions

 AZ_CLASS_ALLOCATOR (AtlasBuilderInput, AZ::SystemAllocator)
 
 AZ_TYPE_INFO (AtlasBuilderInput, "{F54477F9-1BDE-4274-8CC0-8320A3EF4A42}")
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
static AtlasBuilderInput ReadFromFile (const AZStd::string &path, const AZStd::string &directory, bool &valid)
 
static void AddFilesUsingWildCard (AZStd::vector< AZStd::string > &paths, const AZStd::string &insert)
 Resolves any wild cards in paths.
 
static void RemoveFilesUsingWildCard (AZStd::vector< AZStd::string > &paths, const AZStd::string &remove)
 Removes anything that matches the wildcard.
 
static bool DoesPathnameMatchWildCard (const AZStd::string &rule, const AZStd::string &path)
 Compare considering wildcards.
 
static bool DoesWildCardDirectoryIncludePathname (const AZStd::string &rule, const AZStd::string &path)
 As FollowsRule but allows extra items after the last '/'.
 
static bool TokenMatchesWildcard (const AZStd::string &rule, const AZStd::string &token)
 Helper function for DoesPathnameMatchWildCard.
 
static void AddFolderContents (AZStd::vector< AZStd::string > &paths, const AZStd::string &insert, bool &valid)
 Resolves any folder paths into image file paths.
 
static void RemoveFolderContents (AZStd::vector< AZStd::string > &paths, const AZStd::string &remove)
 Resolves remove commands for folders.
 

Public Attributes

bool m_forceSquare
 
bool m_forcePowerOf2
 
bool m_includeWhiteTexture
 
int m_maxDimension
 
int m_padding
 
AZ::Color m_unusedColor
 
AZStd::string m_presetName
 
AZStd::vector< AZStd::string > m_filePaths
 

Detailed Description

Struct that is used to communicate input commands.

Member Function Documentation

◆ ReadFromFile()

static AtlasBuilderInput TextureAtlasBuilder::AtlasBuilderInput::ReadFromFile ( const AZStd::string &  path,
const AZStd::string &  directory,
bool &  valid 
)
static

Attempts to read the input from a .texatlas file. "valid" is for reporting exceptions and telling the asset proccesor to fail the job. Supports parsing through a human readable custom parser.

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