Elaztek Developer Hub
Blamite Game Engine - Tool (Library)
A command-line utility that aids in the creation of Blamite Cache (.map) Files.
BitmapsCommand Class Reference

Class for the Bitmaps command. More...

#include <BitmapsCommand.hpp>

+ Inheritance diagram for BitmapsCommand:
+ Collaboration diagram for BitmapsCommand:

Public Member Functions

 BitmapsCommand ()
 
int execute (std::vector< std::string > args)
 Executes the command. More...
 
- Public Member Functions inherited from ToolCommand
std::string GetCommandName ()
 Retrieves the name of the command. More...
 
std::string GetSyntax ()
 Retrieves the syntax of the command. More...
 
std::string GetDescription ()
 Retrieves the description of the command. More...
 

Additional Inherited Members

- Protected Attributes inherited from ToolCommand
std::string command = ""
 The name of the command. More...
 
std::string syntax = ""
 The syntax of the command. This should include the command name, as well as any arguments. More...
 
std::string description = ""
 A description of the command. More...
 

Detailed Description

Class for the Bitmaps command.

This command reads standard image files and converts them into bitmap tags for use within the engine.

The total list of supported formats (according to the SAIL library used for conversion) includes: apng, avif, bmp, cur, gif, ico, jpeg, jpeg2k, pcx, png, qoi, svg, tga, tiff, wal, webp, xbm

Constructor & Destructor Documentation

◆ BitmapsCommand()

BitmapsCommand::BitmapsCommand ( )
inline

Member Function Documentation

◆ execute()

int BitmapsCommand::execute ( std::vector< std::string >  args)
inlinevirtual

Executes the command.

Parameters
args- A list of arguments provided to the command.
Returns
The command execution result. Will return 0 if the command completed successfully. If an error occurred, this will usually return a negative number.

Reimplemented from ToolCommand.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

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