Surface

The Surface class represents a rendering surface, encapsulating the properties and configurations related to a graphical context and its associated platform. It provides methods for querying and manipulating surface characteristics, such as the platform, size, multisampling options, layers, and formats. The class supports configuring the surface color and depth layers, as well as its associated formats, allowing for fine control over how rendering operations are performed on that surface. It also supports features like multisampling and layer management for advanced rendering scenarios.

#include <platform/TellusimSurface.h>

Constructors

Surface()
explicit Surface(Context &context)
explicit Surface(Platform platform)

Methods

Context platform.

Platform getPlatform() const
const char *getPlatformName() const

---

Surface device index.

uint32_t getIndex() const

---

Surface size.

void setSize(uint32_t width, uint32_t height)
uint32_t getWidth() const
uint32_t getHeight() const

---

Surface multisample.

void setMultisample(uint32_t multisample)
uint32_t getMultisample() const
bool hasMultisample() const

---

Surface layers.

void setColorLayer(uint32_t layer, uint32_t layers)
void setDepthLayer(uint32_t layer, uint32_t layers)
uint32_t getColorLayer() const
uint32_t getDepthLayer() const
uint32_t getColorLayers() const
uint32_t getDepthLayers() const
bool hasColorLayers() const
bool hasDepthLayers() const

---

Surface formats.

void setColorFormat(Format format)
void setDepthFormat(Format format)
Format getColorFormat() const
Format getDepthFormat() const