Inheritance diagram for plTexConv:

Classes
struct	KeyEnumValuePair

Public Types
using	SUPER = plApplication

Public Types inherited from plApplication
enum class	Execution { Continue , Quit }
	Defines the possible return values for the plApplication::Run() function. More...

Public Member Functions
virtual Execution	Run () override
	Main run function which is called periodically. This function must be overridden.

virtual plResult	BeforeCoreSystemsStartup () override
	This function is called before any kind of engine initialization is done.

virtual void	AfterCoreSystemsStartup () override
	This function is called after basic engine initialization has been done.

virtual void	BeforeCoreSystemsShutdown () override
	This function is called after the application main loop has run for the last time, before engine deinitialization.

plResult	ParseCommandLine ()

plResult	ParseMode ()

plResult	ParseCompareMode ()

plResult	ParseOutputType ()

plResult	DetectOutputFormat ()

plResult	ParseInputFiles ()

plResult	ParseOutputFiles ()

plResult	ParseChannelMappings ()

plResult	ParseChannelSliceMapping (plInt32 iSlice)

plResult	ParseChannelMappingConfig (plTexConvChannelMapping &out_mapping, plStringView sCfg, plInt32 iChannelIndex, bool bSingleChannel)

plResult	ParseUsage ()

plResult	ParseMipmapMode ()

plResult	ParseTargetPlatform ()

plResult	ParseCompressionMode ()

plResult	ParseWrapModes ()

plResult	ParseFilterModes ()

plResult	ParseResolutionModifiers ()

plResult	ParseMiscOptions ()

plResult	ParseAssetHeader ()

plResult	ParseBumpMapFilter ()

plResult	ParseUIntOption (plStringView sOption, plInt32 iMinValue, plInt32 iMaxValue, plUInt32 &ref_uiResult) const

plResult	ParseStringOption (plStringView sOption, const plDynamicArray< KeyEnumValuePair > &allowed, plInt32 &ref_iResult) const

void	PrintOptionValues (plStringView sOption, const plDynamicArray< KeyEnumValuePair > &allowed) const

void	PrintOptionValuesHelp (plStringView sOption, const plDynamicArray< KeyEnumValuePair > &allowed) const

bool	ParseFile (plStringView sOption, plString &ref_sResult) const

bool	IsTexFormat () const

plResult	WriteTexFile (plStreamWriter &inout_stream, const plImage &image)

plResult	WriteOutputFile (plStringView sFile, const plImage &image)

Public Member Functions inherited from plApplication
	plApplication (plStringView sAppName)
	Constructor.

virtual	~plApplication ()
	Virtual destructor.

void	SetApplicationName (plStringView sAppName)
	Changes the application name.

const plString &	GetApplicationName () const
	Returns the application name.

virtual void	BeforeHighLevelSystemsShutdown ()
	This function is called after the application main loop has run for the last time, before engine deinitialization.

virtual void	AfterHighLevelSystemsShutdown ()
	Called after plStartup::ShutdownHighLevelSystems() has been executed.

virtual void	AfterCoreSystemsShutdown ()
	This function is called after plStartup::ShutdownCoreSystems() has been called.

virtual void	BeforeEnterBackground ()
	This function is called when an application is moved to the background.

virtual void	BeforeEnterForeground ()
	This function is called whenever an application is resumed from background mode.

void	SetReturnCode (plInt32 iReturnCode)
	Sets the value that the application will return to the OS. You can call this function at any point during execution to update the return value of the application. Default is zero.

plInt32	GetReturnCode () const
	Returns the currently set value that the application will return to the OS.

virtual const char *	TranslateReturnCode () const
	If the return code is not zero, this function might be called to get a string to print the error code in human readable form.

void	SetCommandLineArguments (plUInt32 uiArgumentCount, const char **pArguments)
	Will set the command line arguments that were passed to the app by the OS. This is automatically called by PL_APPLICATION_ENTRY_POINT() and PL_CONSOLEAPP_ENTRY_POINT().

plUInt32	GetArgumentCount () const
	Returns the number of command line arguments that were passed to the application.

const char *	GetArgument (plUInt32 uiArgument) const
	Returns one of the command line arguments that was passed to the application.

const char **	GetArgumentsArray () const
	Returns the complete array of command line arguments that were passed to the application.

void	EnableMemoryLeakReporting (bool bEnable)

bool	IsMemoryLeakReportingEnabled () const

virtual void	RequestQuit ()
	Calling this function requests that the application quits after the current invocation of Run() finishes.

PL_ALWAYS_INLINE bool	WasQuitRequested () const
	Returns whether RequestQuit() was called.

Additional Inherited Members
Static Public Member Functions inherited from plApplication
static plApplication *	GetApplicationInstance ()
	Returns the one instance of plApplication that is available.

Protected Attributes inherited from plApplication
bool	m_bWasQuitRequested = false

Member Function Documentation

◆ AfterCoreSystemsStartup()

void plTexConv::AfterCoreSystemsStartup ( )

overridevirtual

This function is called after basic engine initialization has been done.

plApplication will automatically call plStartup::StartupCoreSystems() to initialize the application. This function can be overridden to do additional application specific initialization. To startup entire subsystems, you should however use the features provided by plStartup and plSubSystem.

Reimplemented from plApplication.

◆ BeforeCoreSystemsShutdown()

void plTexConv::BeforeCoreSystemsShutdown ( )

overridevirtual

This function is called after the application main loop has run for the last time, before engine deinitialization.

Override this function to do application specific deinitialization that still requires a running engine. After this function returns plStartup::ShutdownCoreSystems() is called and thus everything, including allocators, is shut down. To shut down entire subsystems, you should, however, use the features provided by plStartup and plSubSystem.

Reimplemented from plApplication.

◆ BeforeCoreSystemsStartup()

plResult plTexConv::BeforeCoreSystemsStartup ( )

overridevirtual

This function is called before any kind of engine initialization is done.

Override this function to be able to configure subsystems, before they are initialized. After this function returns, plStartup::StartupCoreSystems() is automatically called. If you need to set up custom allocators, this is the place to do this.

Reimplemented from plApplication.

◆ Run()

plApplication::Execution plTexConv::Run ( )

overridevirtual

Main run function which is called periodically. This function must be overridden.

Return Execution::Quit when the application should quit. You may set a return code via SetReturnCode() beforehand.

Implements plApplication.

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

Code/Tools/TexConv/TexConv.h
Code/Tools/TexConv/ParseChannelMapping.cpp
Code/Tools/TexConv/ParseOptions.cpp
Code/Tools/TexConv/ParseUtils.cpp
Code/Tools/TexConv/TexConv.cpp

Classes

Public Types

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ AfterCoreSystemsStartup()

◆ BeforeCoreSystemsShutdown()

◆ BeforeCoreSystemsStartup()

◆ Run()