C/C++ SDK / C++ layer / Functions

Functions and aliases

Free functions and type aliases of namespace kroys in kroys/plugin.hpp.

Headerkroys/plugin.hpp

REFERENCE

Members

Functions

#[[nodiscard]] inline bool Succeeded(Result result);

True when result is KROYS_OK.

function

#[[nodiscard]] constexpr uint32_t Rgba(uint8_t r, uint8_t g, uint8_t b, uint8_t a = 255u);

Packs a color for the UI and viewport APIs.

function

#inline void WriteBytes(const KroysByteSink* sink, std::string_view bytes);

A byte sink as a std::string appender.

function

Aliases

#using Result = KroysResult;

Same as the C type KroysResult.

aliaswraps KroysResult

#using Handle = KroysHandle;

Same as the C type KroysHandle.

aliaswraps KroysHandle

#using ComponentType = KroysComponentType;

Same as the C type KroysComponentType.

aliaswraps KroysComponentType

plugin.hpp

using Result = KroysResult;
using Handle = KroysHandle;
using ComponentType = KroysComponentType;
[[nodiscard]] inline bool Succeeded(Result result);
[[nodiscard]] constexpr uint32_t Rgba(uint8_t r, uint8_t g, uint8_t b, uint8_t a = 255u);
inline void WriteBytes(const KroysByteSink* sink, std::string_view bytes);

KroysEngine 0.1.0 documentation, built from the engine repository by Tools/BuildDocsSite.py.