OrbitEngine::Graphics namespace

Namespaces

namespace priv

Classes

class Atlas

Generic 2D atlas class.

struct Batch2DVertex

template<typename V>

class BatchRenderer2D

template<typename T, unsigned int N = 1>

class Bitmap

A 2D bitmap image with N channels of elements T.

template<typename T, unsigned int N = 1>

class BitmapAtlas

A 2D bitmap atlas.

class BRDFLUT

class Buffer

struct CameraBuffer

class ColorModule

class CommandBuffer

class D3DBuffer

template<class CB>

class D3DConstantBuffer

class D3DDepthTexture

class D3DFrameBuffer

class D3DIndexBuffer

class D3DMappedResource

class D3DMesh

struct D3DRendererCache

class D3DRenderTexture

class D3DResource

class D3DShader

class D3DStates

class D3DTexture

class D3DVertexBuffer

class DeferredRenderer

class DirectionalLight

class EmissionModule

Affects the rate of particle creation.

class EnviromentMap

class Font

Represents a single typeface.

class FontCollection

A collection of Glyphs and metadata.

class ForwardRenderer

class FrameBuffer

template<class T>

class GenericLight

class GLBuffer

class GLFrameBuffer

class GLIndexBuffer

class GLMesh

class GLShader

class GLStates

class GLTexture

template<class T>

class GLUniformBuffer

class GLVertexArrays

class GLVertexBuffer

struct GlyphMetrics

Single glyph metrics.

class ImGuiRenderer

class Light

class LookUpTexture

class ManagedShader

class MappedResource

class Material

struct MaterialUniforms

class Mesh

struct MeshEntry

class MeshGenerator

struct MMatrix

class Model

struct ObjectBuffer

struct PaintStyle

struct Particle

class ParticleEmitter

class ParticleModule

Base particle module.

class ParticleSystem

struct Path

struct PathPoint

class PathRenderer

class PathRenderer2D

struct PathRenderer2DVertex

struct PathRendererCall

struct PathRendererUniformData

class Pipeline

struct PMatrix

class PointLight

struct PVMatrices

struct RenderCommand

class Renderer

class Renderer2D

class Renderer3D

class Shader

struct ShaderAttribute

struct ShaderBuffer

struct ShaderCompilationResult

class ShaderCompiler

class ShaderLoader

class ShaderPass

struct ShaderReflection

struct ShaderResource

struct ShaderUniform

class ShapeModule

Defines the shape from which the particles can be emitted, and their initial direction and speed.

class SizeModule

class Skybox

class SpriteBatcher

class SpriteRenderer

class States

class SurfaceShader

class TextRenderer2D

struct TextRenderer2DVertex

struct TextStyle

class Texture

class TextureArrayHandler

class TextureAtlas

A 2D texture atlas.

struct TextureFormatProperties

class TextureModule

struct TextureProperties

struct TextureSampleProperties

template<class T>

class UniformsPack

struct Vertex3D

class VertexBuffer

struct VertexElement

class VertexLayout

class VKFrameBuffer

class VKPipeline

class VKShader

struct VMatrix

Enums

enum SimulationSpace { LOCAL, WORLD }

enum PathRendererCommandType { MOVETO = 0, LINETO, BEZIERTO, CLOSE }

enum MaterialMapType { ALBEDO = 0, METALLIC, ROUGHNESS, NORMALS }

enum BufferType { VERTEX = 0, INDEX, CONSTANT }

enum BufferMode { DEFAULT = 0, DYNAMIC }

enum BlitOperation { DEPTH }

enum MappedPointerMode { READ, WRITE }

enum Topology { POINTS, TRIANGLES, TRIANGLES_STRIP, TRIANGLES_FAN, QUADS, PATCHES }

enum ShaderType { UNKNOWN = 0, VERTEX, VERTEX = 0, FRAGMENT, GEOMETRY, TESS_CONTROL, TESS_EVAL }

enum ShaderUniformType { UNKNOWN, BOOL, INT, UINT, HALF, FLOAT, DOUBLE }

enum BlendState { SRC_ALPHA = 0, ONE_ALPHA, NO_COLOR, ONE_ONE, ONE_ZERO, DISABLED }

enum CullMode { FRONT = 0, BACK, WIREFRAME, NONE }

enum FunctionMode { NEVER = 0, LESS, EQUAL, LESS_EQUAL, GREATER, NOT_EQUAL, GREATER_EQUAL, ALWAYS, DISABLED }

enum StencilOperation { ZERO = 0, KEEP, SEPARATE_INCR_DECR }

enum TextureFormat { R8 = 0, RGB, R16, RG8, RG32F, RGB8, RGB32F, RGB16F, RGBA, RGBA8, RGBA32F, SRC_ALPHA, SRC_ALPHA = 0, LUMINANCE_ALPHA, DEPTH, DEPTH, DEPTH_STENCIL }

enum TextureFilter { ANISOTROPIC = 0, LINEAR, NEAREST }

enum TextureWrap { REPEAT = 0, MIRROR_REPEAT, CLAMP, CLAMP_TO_EDGE, CLAMP_TO_BORDER }

enum TextureDataType { UNSIGNED_INT, UNSIGNED_BYTE, FLOAT, FLOAT }

enum TextureDimension { TEXTURE1D, TEXTURE2D, TEXTURE2DARRAY, TEXTURE3D, CUBEMAP }

enum GlyphRenderMode { GRAY = 0, SDF = 1, PSDF = 2, MSDF = 3, COLOR = 4 }

enum SDFMode { SDF, PSDF, MSDF }

msdfgen's modes

Typedefs

using ShaderSources = std::map<ShaderType, std::string>

using ShaderReflections = std::map<ShaderType, ShaderReflection>

using ShaderDefinitions = std::set<std::string>

using FrameIndex = unsigned int

Frame identifier within an atlas. It must be unique and does not have to be sequential.

using BitmapRGB = Bitmap<unsigned char, 3>

using BitmapRGBA = Bitmap<unsigned char, 4>

using BitmapAtlasRGB = BitmapAtlas<unsigned char, 3>

using BitmapAtlasRGBA = BitmapAtlas<unsigned char, 4>

using GlyphCodepoint = unsigned int

Unicode codepoint.

using FontSize = unsigned int

Font sizes specified in pixels.

Functions

template<typename T, unsigned int N, typename U, unsigned int M>

auto ConvertBitmap(const Bitmap<T, N>& input) -> Bitmap<U, M>

Convert between bitmaps.

template<>

auto ConvertBitmap(const Bitmap<unsigned char, 1>& input) -> BitmapRGB

Convert from unsigned char 8bit (grayscale) to unsigned char 24bit (RGB)

template<>

auto ConvertBitmap(const Bitmap<unsigned char, 1>& input) -> BitmapRGBA

Convert from unsigned char 8bit (grayscale) to unsigned char 32bit (RGBA)

template<>

auto ConvertBitmap(const Bitmap<unsigned char, 3>& input) -> BitmapRGBA

Convert from unsigned char 24bit (RGB) to unsigned char 32bit (RGBA)

template<>

auto ConvertBitmap(const Bitmap<unsigned char, 4>& input) -> BitmapRGB

Convert from unsigned char 32bit (RGBA) to unsigned char 24bit (RGB) (drop alpha)

template<>

auto ConvertBitmap(const Bitmap<float, 1>& input) -> BitmapRGB

Convert from float 8bit (grayscale) to unsigned char 24bit (RGB)

template<>

auto ConvertBitmap(const Bitmap<float, 3>& input) -> BitmapRGB

Convert from float 24bit (RGB) to unsigned char 24bit (RGB)

auto ConvertBGRAtoRGBA(const Bitmap<unsigned char, 4>& input) -> BitmapRGBA

Convert a RGBA bitmap from BGRA to RGBA.

auto ConvertAlphaToWhiteRGBA(const Bitmap<unsigned char, 1>& input) -> BitmapRGBA

auto ReadImage(const std::string& path, unsigned int& width, unsigned int& height, unsigned int& bpp, bool force32bits = false) -> unsigned char*

Reads an image from disk.

auto ReadImage(unsigned char* file_data, size_t file_size, unsigned int& width, unsigned int& height, unsigned int& bpp, bool force32bits = false) -> unsigned char*

Reads an image from disk.

auto WritePNG(const std::string& path, unsigned int width, unsigned int height, unsigned int bpp, unsigned char* data) -> bool

Writes a PNG file to disk.

auto GenerateBitmapFromOutline(FT_Outline* outline, SDFMode mode, double range) -> BitmapRGB

Generates a BitmapRGB from a FreeType outline using msdfgen's signed distance field method.

auto GenerateBitmapFromSVGPath(const std::string& svg_path, SDFMode mode, double range, Math::Vec2i& center, double scale = 1, bool square = false) -> BitmapRGB

Generates a BitmapRGB from a SVG path using msdfgen's signed distance field method.

Enum documentation

enum OrbitEngine::Graphics::GlyphRenderMode

#include <OE/Graphics/Font.hpp>

Example: Grinning Face emoji (U+1F600) and **&** glyphs at 128px

GRAY

SDF/PSDF

MSDF

COLOR

Enumerators
GRAY	monochrome
SDF	SDFMode::SDF.
PSDF	SDFMode::PSDF.
MSDF	SDFMode::MSDF.
COLOR	full color with alpha (e.g. emojis)

Typedef documentation

Function documentation

Bitmap<unsigned char, 1> bitmap_grayscale(128, 128);

// ... do something with bitmap_grayscale

bitmap_grayscale.savePNG("image-8bit.png");

BitmapRGB bitmap_rgb = ConvertBitmap(bitmap_grayscale); // or Bitmap<unsigned char, 3>

bitmap_rgb.savePNG("image-24bit.png");