Epok Engine

EPOK RUNTIME

epok::SkyGradient::draw

Function template · 1 overload

Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.

Function template

Returns false when the camera cannot be resolved; the caller then clears with the flat sky colour instead.

Belongs to
epok::SkyGradient
Header
sky_gradient.hpp
Overloads
1

Declaration

template
Declaration
template <class Gpu> bool draw(Gpu& gpu, const SkyGradientView& view, const SkyGradientColors& colors)

Returns false when the camera cannot be resolved; the caller then clears with the flat sky colour instead.

ParameterTypeMeaning
gpuGpu &Not documented; consult the linked header.
viewconst SkyGradientView &Not documented; consult the linked header.
colorsconst SkyGradientColors &Not documented; consult the linked header.

Returns: bool. Consult the linked header for its meaning.

Example sketch

C++ example
#include "sky_gradient.hpp"

// Replace these template arguments with types or values accepted by the declaration:
// Gpu

// Assume these named values have been initialized with valid data:
// Gpu & gpu
// const SkyGradientView & view
// const SkyGradientColors & colors

epok::SkyGradient& object = /* obtain a valid instance */;

auto result = object.draw<Gpu>(gpu, view, colors);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in runtime/sky_gradient.hpp:130