XII Release 0.1.0
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | List of all members
xiiTexConv Class Reference
Inheritance diagram for xiiTexConv:
[legend]

Classes

struct  KeyEnumValuePair
 

Public Types

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

Public Member Functions

virtual xiiApplication::Execution Run () override
 Main run function which is called periodically. This function must be overridden.
 
virtual xiiResult 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.
 
xiiResult ParseCommandLine ()
 
xiiResult ParseMode ()
 
xiiResult ParseCompareMode ()
 
xiiResult ParseOutputType ()
 
xiiResult DetectOutputFormat ()
 
xiiResult ParseInputFiles ()
 
xiiResult ParseOutputFiles ()
 
xiiResult ParseChannelMappings ()
 
xiiResult ParseChannelSliceMapping (xiiInt32 iSlice)
 
xiiResult ParseChannelMappingConfig (xiiTexConvChannelMapping &out_mapping, xiiStringView sCfg, xiiInt32 iChannelIndex, bool bSingleChannel)
 
xiiResult ParseUsage ()
 
xiiResult ParseMipmapMode ()
 
xiiResult ParseTargetPlatform ()
 
xiiResult ParseCompressionMode ()
 
xiiResult ParseWrapModes ()
 
xiiResult ParseFilterModes ()
 
xiiResult ParseResolutionModifiers ()
 
xiiResult ParseMiscOptions ()
 
xiiResult ParseAssetHeader ()
 
xiiResult ParseBumpMapFilter ()
 
xiiResult ParseUIntOption (xiiStringView sOption, xiiInt32 iMinValue, xiiInt32 iMaxValue, xiiUInt32 &ref_uiResult) const
 
xiiResult ParseStringOption (xiiStringView sOption, const xiiDynamicArray< KeyEnumValuePair > &allowed, xiiInt32 &ref_iResult) const
 
void PrintOptionValues (xiiStringView sOption, const xiiDynamicArray< KeyEnumValuePair > &allowed) const
 
void PrintOptionValuesHelp (xiiStringView sOption, const xiiDynamicArray< KeyEnumValuePair > &allowed) const
 
bool ParseFile (xiiStringView sOption, xiiString &ref_sResult) const
 
bool IsTexFormat () const
 
xiiResult WriteTexFile (xiiStreamWriter &inout_stream, const xiiImage &image)
 
xiiResult WriteOutputFile (xiiStringView sFile, const xiiImage &image)
 
- Public Member Functions inherited from xiiApplication
 xiiApplication (xiiStringView sAppName)
 Constructor.
 
virtual ~xiiApplication ()
 Virtual destructor.
 
void SetApplicationName (xiiStringView sAppName)
 Changes the application name.
 
const xiiString & 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 xiiStartup::ShutdownHighLevelSystems() has been executed.
 
virtual void AfterCoreSystemsShutdown ()
 This function is called after xiiStartup::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 (xiiInt32 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.
 
xiiInt32 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 (xiiUInt32 uiArgumentCount, const char **pArguments)
 Will set the command line arguments that were passed to the app by the OS. This is automatically called by XII_APPLICATION_ENTRY_POINT() and XII_CONSOLEAPP_ENTRY_POINT().
 
xiiUInt32 GetArgumentCount () const
 Returns the number of command line arguments that were passed to the application.
 
const char * GetArgument (xiiUInt32 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.
 
XII_ALWAYS_INLINE bool WasQuitRequested () const
 Returns whether RequestQuit() was called.
 

Additional Inherited Members

- Static Public Member Functions inherited from xiiApplication
static xiiApplication * GetApplicationInstance ()
 Returns the one instance of xiiApplication that is available.
 
- Protected Attributes inherited from xiiApplication
bool m_bWasQuitRequested = false
 

Member Function Documentation

◆ AfterCoreSystemsStartup()

void xiiTexConv::AfterCoreSystemsStartup ( )
overridevirtual

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

xiiApplication will automatically call xiiStartup::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 xiiStartup and xiiSubSystem.

Reimplemented from xiiApplication.

◆ BeforeCoreSystemsShutdown()

void xiiTexConv::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 xiiStartup::ShutdownCoreSystems() is called and thus everything, including allocators, is shut down. To shut down entire subsystems, you should, however, use the features provided by xiiStartup and xiiSubSystem.

Reimplemented from xiiApplication.

◆ BeforeCoreSystemsStartup()

xiiResult xiiTexConv::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, xiiStartup::StartupCoreSystems() is automatically called. If you need to set up custom allocators, this is the place to do this.

Reimplemented from xiiApplication.

◆ Run()

xiiApplication::Execution xiiTexConv::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 xiiApplication.

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