vkmEngine 1.0.0
A C++ game engine · vkmengine.com
Loading...
Searching...
No Matches
Vkm::Engine::RenderSettings Struct Reference

Editable render tuning: pass toggles + per-effect parameters. More...

#include <render_settings.h>

Static Public Member Functions

static bool isMsaaSampleCount (uint32_t samples)
 Whether samples is one of MSAA_SAMPLE_COUNTS.

Public Attributes

bool ssr = true
 Screen-space reflections, over the probes and the sky.
float gtaoRadius = 0.6f
 World-space sample radius, MIN_GTAO_RADIUS..MAX_GTAO_RADIUS.
float gtaoIntensity = 1.0f
 Occlusion strength.
float gtaoPower = 1.5f
 Contrast curve.
float ssrMaxRoughness = 0.6f
 Rougher surfaces reflect the probes and the sky alone.
float ssrMaxDistance = 50.0f
 World-space trace length.
float bloomStrength = 0.06f
 Bloom scale, added pre-tonemap.
float bloomThreshold = 1.0f
 On a pixel's brightest channel (linear HDR).
float bloomKnee = 0.5f
 Soft-knee width around the threshold.
float bloomRadius = 0.005f
 Upsample tent radius, fraction of frame width.
float exposure = 0.0f
 A fixed exposure in stops: the frame is scaled by 2^exposure before the tonemap.
float cullMaxDistance = 500.0f
 World-space.
float cullMinPixels = 3.0f
 Screen-pixel size; 0 disables.
uint32_t msaaSamples = 4
 Scene-pass MSAA samples, one of MSAA_SAMPLE_COUNTS; post runs on the resolved buffer.
TextureFiltering textureFiltering = TextureFiltering::Trilinear
 The frame's default texel sampling; TextureParams::filterOverride outranks it.
uint32_t textureAnisotropy = 16
 Degree when the mode is Trilinear (1 = off); clamped to the driver's ceiling.
uint32_t shadowResolution = 4096
 Per-tile shadow-atlas resolution (1024/2048/4096); costly to raise.
bool grid = false
 Editor ground grid.

Static Public Attributes

static constexpr float MIN_GTAO_RADIUS = 0.05f
 The search divides by the radius, so it is never zero.
static constexpr float MAX_GTAO_RADIUS = 5.0f
 Past this the search reads the screen, not a neighbourhood.
static constexpr uint32_t MSAA_SAMPLE_COUNTS [] = {1, 2, 4, 8}
 1 is off.

Detailed Description

Editable render tuning: pass toggles + per-effect parameters.

Carried on FrameContext::render; copied into RenderView::settings each frame.

Member Function Documentation

◆ isMsaaSampleCount()

bool Vkm::Engine::RenderSettings::isMsaaSampleCount ( uint32_t samples)
inlinestatic

Whether samples is one of MSAA_SAMPLE_COUNTS.

Parameters
samplesA requested msaaSamples.
Returns
True when it is allowed.

Member Data Documentation

◆ exposure

float Vkm::Engine::RenderSettings::exposure = 0.0f

A fixed exposure in stops: the frame is scaled by 2^exposure before the tonemap.

Authored, never adapted; 0 is as lit.

◆ textureFiltering

TextureFiltering Vkm::Engine::RenderSettings::textureFiltering = TextureFiltering::Trilinear

The frame's default texel sampling; TextureParams::filterOverride outranks it.

textureAnisotropy is ignored unless this is Trilinear. Unrelated to MaterialAsset::anisotropy (the BRDF lobe).


The documentation for this struct was generated from the following file: