endstone/util

varBIT_MASKstaticconstexpr

int BIT_MASK

varDEFAULT_ALPHAstaticconstexpr

int DEFAULT_ALPHA

methColorconstexpr

constexpr Color(const std::uint8_t red, const std::uint8_t green, const std::uint8_t blue, const std::uint8_t alpha = DEFAULT_ALPHA)

methgetRedconst

int getRed() const

Gets the red component of the color.

methsetRedconst

Color setRed(const int red) const

Creates a new Color object with specified component.

methgetGreenconst

int getGreen() const

Gets the green component of the color.

methsetGreenconst

Color setGreen(const int green) const

Creates a new Color object with specified component.

methgetBlueconst

int getBlue() const

Gets the blue component of the color.

methsetBlueconst

Color setBlue(const int blue) const

Creates a new Color object with specified component.

methgetAlphaconst

int getAlpha() const

Gets the alpha component of the color.

methsetAlphaconst

Color setAlpha(const int alpha) const

Creates a new Color object with specified component.

methasRGBAconst

int asRGBA() const

Gets the color as an RGBA integer.

methasABGRconst

int asABGR() const

Gets the color as an ABGR integer.

methasRGBconst

int asRGB() const

Gets the color as an RGB integer.

methasBGRconst

int asBGR() const

Gets the color as an BGR integer.

methoperator==const

bool operator==(const Color& other) const

methoperator!=const

bool operator!=(const Color& other) const

methfromRGBAstatic

Color fromRGBA(int red, int green, int blue, int alpha)

Creates a new Color object from a red, green, blue, and alpha.

methfromRGBstatic

Color fromRGB(const int red, const int green, const int blue)

Creates a new Color object from a red, green, and blue.

methfromBGRstatic

Color fromBGR(const int blue, const int green, const int red)

Creates a new Color object from a blue, green, and red.

methfromRGBAstatic

Color fromRGBA(const int rgba)

Creates a new color object from an integer that contains the red, green, blue, and alpha bytes.

methfromABGRstatic

Color fromABGR(const int abgr)

Creates a new color object from an integer that contains the alpha, blue, green, and red bytes.

methfromRGBstatic

Color fromRGB(const int rgb)

Creates a new color object from an integer that contains the red, green, and blue bytes in the lowest order 24 bits.

methfromBGRstatic

Color fromBGR(const int bgr)

varWHITEstaticconstexpr

auto WHITE

varBLACKstaticconstexpr

auto BLACK

enumType

Type

methImageexplicit

Image(const Type type, const int width, const int height)

Create an empty image (all pixels transparent black).

methImage

Image(Type type, int width, int height, const T& data)

methgetWidthconst

int getWidth() const

Get the image width.

methgetHeightconst

int getHeight() const

Get the image height.

methgetDepthconst

int getDepth() const

Get the image depth.

methgetColorconst

Color getColor(const int x, const int y) const

Get the color of a pixel.

methsetColor

void setColor(const int x, const int y, const Color color)

Set the color of a pixel.

methgetDataconst

std::string_view getData() const

Gets the raw pixel buffer (row-major, H x W x D).

methfromArraystatic

Result<Image> fromArray(Type type, const int width, const int height, const std::vector<unsigned char>& array)

Creates an image from the pixel data in a byte array.

methfromBufferstatic

Result<Image> fromBuffer(Type type, const int width, const int height, std::string_view buffer)

Creates an image from the pixel data in a byte buffer.

typepointer_type

std::shared_ptr<T> pointer_type

methNotNull

NotNull() =delete

methNotNull

NotNull(std::shared_ptr<T> ptr)

methNotNull

NotNull(const NotNull& other) =default

methoperator=

NotNull& operator=(const NotNull& other) =default

methgetconstnoexcept

const pointer_type& get() const noexcept

methoperator->constnoexcept

T* operator->() const noexcept

methoperator*constnoexcept

T& operator*() const noexcept

methNotNull

NotNull(std::nullptr_t) =delete

methoperator=

NotNull& operator=(std::nullptr_t) =delete

methoperator++

NotNull& operator++() =delete

methoperator--

NotNull& operator--() =delete

methoperator++

NotNull operator++(int) =delete

methoperator--

NotNull operator--(int) =delete

methoperator+=

NotNull& operator+=(std::ptrdiff_t) =delete

methoperator-=

NotNull& operator-=(std::ptrdiff_t) =delete

methoperator[]const

void operator[](std::ptrdiff_t) const =delete

methswapnoexcept

void swap(NotNull& other) noexcept

methNullableconstexprnoexcept

constexpr Nullable() noexcept=default

methNullableconstexprnoexcept

constexpr Nullable(std::nullptr_t) noexcept

methNullable

Nullable(std::shared_ptr<T> ptr)

methNullable

Nullable(const NotNull<T>& other)

methgetconstnoexcept

const std::shared_ptr<T>& get() const noexcept

methoperator->constnoexcept

T* operator->() const noexcept

methoperator*constnoexcept

T& operator*() const noexcept

methoperator boolconstexplicitnoexcept

operator bool() const noexcept

methoperator==const

bool operator==(const Nullable&) const =default

methoperator!=const

bool operator!=(const Nullable&) const =default

methoperator==constnoexcept

bool operator==(std::nullptr_t) const noexcept

methoperator!=constnoexcept

bool operator!=(std::nullptr_t) const noexcept

methSocketAddress

SocketAddress() =default

methSocketAddress

SocketAddress(std::string hostname, std::uint32_t port)

methgetHostnameconst

const std::string& getHostname() const

Gets the hostname.

methgetPortconst

std::uint32_t getPort() const

Gets the port number.

methoperator==const

bool operator==(const SocketAddress& other) const =default

vardata

std::uint8_t data

methbeginnoexcept

std::uint8_t* begin() noexcept

methbeginconstnoexcept

const uint8_t* begin() const noexcept

methendnoexcept

std::uint8_t* end() noexcept

methendconstnoexcept

const uint8_t* end() const noexcept

methisNilconstnoexcept

bool isNil() const noexcept

methversionconstnoexcept

int version() const noexcept

methswapnoexcept

void swap(UUID& rhs) noexcept

methstrconst

std::string str() const

methsizestaticconstexprnoexcept

std::size_t size() noexcept

varx_protected

float x_

vary_protected

float y_

varz_protected

float z_

methVectorconstexpr

constexpr Vector() =default

Construct the vector with all components as 0.

methVectorconstexpr

constexpr Vector(T x, T y, T z)

Construct the vector with provided components.

methVector

Vector(const Vector& other) =default

methVectornoexcept

Vector(Vector&& other) noexcept=default

methoperator=

Vector& operator=(const Vector& other) =default

methoperator=noexcept

Vector& operator=(Vector&& other) noexcept=default

methgetXconstconstexpr

float getX() const

Gets the X component.

methsetXconstexpr

Vector& setX(T x)

Set the X component.

methgetYconstconstexpr

float getY() const

Gets the Y component.

methsetYconstexpr

Vector& setY(T y)

Set the Y component.

methgetZconstconstexpr

float getZ() const

Gets the Z component.

methsetZconstexpr

Vector& setZ(T z)

Set the Z component.

methgetBlockXconst

int getBlockX() const

Gets the floored value of the X component, indicating the block that this vector is contained with.

methgetBlockYconst

int getBlockY() const

Gets the floored value of the Y component, indicating the block that this vector is contained with.

methgetBlockZconst

int getBlockZ() const

Gets the floored value of the Z component, indicating the block that this vector is contained with.

methoperator+constconstexpr

Vector operator+(const Vector& other) const

methoperator-constconstexpr

Vector operator-(const Vector& other) const

methoperator*constconstexpr

Vector operator*(const Vector& other) const

methoperator/constconstexpr

Vector operator/(const Vector& other) const

methoperator+=

Vector& operator+=(const Vector& other)

methoperator-=

Vector& operator-=(const Vector& other)

methoperator*=

Vector& operator*=(const Vector& other)

methoperator/=

Vector& operator/=(const Vector& other)

methoperator+constconstexpr

Vector operator+(T scalar) const

methoperator-constconstexpr

Vector operator-(T scalar) const

methoperator*constconstexpr

Vector operator*(T scalar) const

methoperator/constconstexpr

Vector operator/(T scalar) const

methoperator==constnoexcept

bool operator==(const Vector& other) const noexcept

methoperator!=constnoexcept

bool operator!=(const Vector& other) const noexcept

methlengthconst

float length() const

Gets the magnitude of the vector, defined as sqrt(x^2+y^2+z^2).

methlengthSquaredconstconstexpr

float lengthSquared() const

Gets the magnitude of the vector squared.

methdistanceconst

float distance(const Vector& other) const

Get the distance between this vector and another.

methdistanceSquaredconstconstexpr

float distanceSquared(const Vector& other) const

Get the squared distance between this vector and another.

methangleconst

float angle(const Vector& other) const

Gets the angle between this vector and another in radians.

methmidpointconstexpr

Vector& midpoint(const Vector& other)

Sets this vector to the midpoint between this vector and another.

methgetMidpointconstconstexpr

Vector getMidpoint(const Vector& other) const

Gets a new midpoint vector between this vector and another.

methdotconstconstexpr

float dot(const Vector& other) const

Calculates the dot product of this vector with another. The dot product is defined as x1*x2+y1*y2+z1*z2. The returned value is a scalar.

methcrossProductconstexpr

Vector& crossProduct(const Vector& other)

Calculates the cross-product of this vector with another.

The cross-product is defined as:

• x = y1 * z2 - y2 * z1
• y = z1 * x2 - z2 * x1
• z = x1 * y2 - x2 * y1

methgetCrossProductconstconstexpr

Vector getCrossProduct(const Vector& other) const

Calculates the cross-product of this vector with another without mutating the original.

The cross-product is defined as:

• x = y1 * z2 - y2 * z1
• y = z1 * x2 - z2 * x1
• z = x1 * y2 - x2 * y1

methnormalize

Vector& normalize()

Converts this vector to a unit vector (a vector with length of 1).

methzeroconstexpr

Vector& zero()

Zero this vector's components.

methisZeroconstconstexpr

bool isZero() const

Check whether or not each component of this vector is equal to 0.

methnormalizeZerosconstexpr

Vector& normalizeZeros()

Converts each component of value -0.0 to 0.0.

methisInAABBconstconstexpr

bool isInAABB(const Vector& min, const Vector& max) const

Returns whether this vector is in an axis-aligned bounding box.

The minimum and maximum vectors given must be truly the minimum and maximum X, Y and Z components.

methisInSphereconstconstexpr

bool isInSphere(const Vector& origin, float radius) const

Returns whether this vector is within a sphere.

methisNormalizedconst

bool isNormalized() const

Returns if a vector is normalized.

methrotateAroundX

Vector& rotateAroundX(float angle)

Rotates the vector around the x-axis.

methrotateAroundY

Vector& rotateAroundY(float angle)

Rotates the vector around the y-axis.

methrotateAroundZ

Vector& rotateAroundZ(float angle)

Rotates the vector around the z-axis.

methrotateAroundAxis

Vector& rotateAroundAxis(const Vector& axis, float angle)

Rotates the vector around a given arbitrary axis in 3-dimensional space.

Rotation will follow the general Right-Hand-Rule, which means rotation will be counterclockwise when the axis is pointing towards the observer.

This method will always make sure the provided axis is a unit vector, to not modify the length of the vector when rotating. If you are experienced with the scaling of a non-unit axis vector, you can use rotateAroundNonUnitAxis(Vector, float).

methrotateAroundNonUnitAxis

Vector& rotateAroundNonUnitAxis(const Vector& axis, float angle)

Rotates the vector around a given arbitrary axis in 3-dimensional space.

Rotation will follow the general Right-Hand-Rule, which means rotation will be counterclockwise when the axis is pointing towards the observer.

Note that the vector length will change accordingly to the axis vector length. If the provided axis is not a unit vector, the rotated vector will not have its previous length. The scaled length of the resulting vector will be related to the axis vector. If you are not sure about the scaling of the vector, use rotateAroundAxis(Vector, float).