载入中...
搜索中...
未找到
Public 成员函数 | 静态 Public 成员函数 | Public 属性 | 静态 Public 属性 | 所有成员列表
eve::graphics::WaterStyleConfig结构体 参考

Versioned, backend-neutral configuration for the built-in stylized water surface. 更多...

#include <WaterStyleConfig.h>

Public 成员函数

Result< void > validate () const
 Validate finite values and authored ranges without mutating runtime state.
 
Result< Value > toValue () const
 Encode the canonical version-one representation. Unknown fields are rejected.
 
Result< std::string > toJson () const
 Serialize canonical JSON after validation.
 

静态 Public 成员函数

static Result< WaterStyleConfig > fromValue (const Value &value)
 Decode version one transactionally; unknown fields and future versions are rejected.
 
static Result< WaterStyleConfig > fromJson (std::string_view json)
 Parse JSON and decode version one transactionally.
 

Public 属性

glm::vec3 deepColor {0.02F, 0.16F, 0.24F}
 
glm::vec3 shallowColor {0.10F, 0.48F, 0.58F}
 
glm::vec3 foamColor {0.85F, 0.93F, 1.0F}
 
glm::vec3 reflectionTint {0.70F, 0.85F, 1.0F}
 
float waveSpeed = 1.2F
 
float waveAmplitude = 0.35F
 
float waveScale = 14.0F
 
float waveSharpness = 1.0F
 
float rippleAmplitude = 0.60F
 
int rippleCount = 6
 
float rippleInterval = 1.6F
 
float depthDistance = 5.0F
 
float opacity = 0.88F
 
float foamWidth = 0.45F
 
float foamSoftness = 0.08F
 
float foamStrength = 0.85F
 
float fresnelPower = 5.0F
 
float reflectionIntensity = 0.60F
 
float sunIntensity = 0.90F
 
bool screenSpaceReflection = false
 
float screenSpaceReflectionStrength = 0.85F
 
float refractionStrength = 0.025F
 
float causticsStrength = 0.35F
 
float causticsScale = 3.5F
 

静态 Public 属性

static constexpr std::string_view SchemaId = "eve.graphics.stylized-water"
 
static constexpr std::uint32_t SchemaVersion = 1
 

详细描述

Versioned, backend-neutral configuration for the built-in stylized water surface.

在文件 WaterStyleConfig.h 第 15 行定义.

成员函数说明

◆ fromJson()

Result< WaterStyleConfig > eve::graphics::WaterStyleConfig::fromJson ( std::string_view  json)
static

Parse JSON and decode version one transactionally.

在文件 WaterStyleConfig.cpp 第 190 行定义.

引用了 eve::Result< T >::failure(), eve::Value::fromJson(), fromValue() , 以及 value.

被这些函数引用 eve::graphics::Water::applyConfigJson().

◆ fromValue()

Result< WaterStyleConfig > eve::graphics::WaterStyleConfig::fromValue ( const Value &  value)
static

Decode version one transactionally; unknown fields and future versions are rejected.

在文件 WaterStyleConfig.cpp 第 133 行定义.

引用了 colors, depth, eve::Diagnostic::error(), eve::Result< T >::failure(), eve::InvalidArgument, lighting, output, root, SchemaId, eve::Result< T >::success(), eve::UnknownVersion, valid , 以及 value.

被这些函数引用 fromJson().

◆ toJson()

Result< std::string > eve::graphics::WaterStyleConfig::toJson ( ) const

Serialize canonical JSON after validation.

在文件 WaterStyleConfig.cpp 第 196 行定义.

引用了 eve::Result< T >::failure(), toValue() , 以及 value.

被这些函数引用 eve::graphics::Water::configJson().

◆ toValue()

Result< Value > eve::graphics::WaterStyleConfig::toValue ( ) const

Encode the canonical version-one representation. Unknown fields are rejected.

在文件 WaterStyleConfig.cpp 第 109 行定义.

引用了 causticsScale, causticsStrength, colors, deepColor, depth, depthDistance, eve::Result< T >::failure(), foamColor, foamSoftness, foamStrength, foamWidth, fresnelPower, lighting, eve::Value::object(), opacity, reflectionIntensity, reflectionTint, refractionStrength, rippleAmplitude, rippleCount, rippleInterval, SchemaId, SchemaVersion, screenSpaceReflection, screenSpaceReflectionStrength, shallowColor, eve::Result< T >::success(), sunIntensity, valid, validate(), waveAmplitude, waveScale, waveSharpness , 以及 waveSpeed.

被这些函数引用 toJson().

◆ validate()

Result< void > eve::graphics::WaterStyleConfig::validate ( ) const

Validate finite values and authored ranges without mutating runtime state.

在文件 WaterStyleConfig.cpp 第 70 行定义.

引用了 causticsScale, causticsStrength, color, deepColor, depthDistance, eve::Diagnostic::error(), eve::Result< T >::failure(), foamColor, foamSoftness, foamStrength, foamWidth, fresnelPower, eve::InvalidArgument, opacity, reflectionIntensity, reflectionTint, refractionStrength, rippleAmplitude, rippleInterval, screenSpaceReflectionStrength, shallowColor, eve::Result< T >::success(), sunIntensity, waveAmplitude, waveScale, waveSharpness , 以及 waveSpeed.

被这些函数引用 toValue().

类成员变量说明

◆ causticsScale

float eve::graphics::WaterStyleConfig::causticsScale = 3.5F

在文件 WaterStyleConfig.h 第 48 行定义.

被这些函数引用 eve::graphics::Water::bindParams(), toValue() , 以及 validate().

◆ causticsStrength

float eve::graphics::WaterStyleConfig::causticsStrength = 0.35F

在文件 WaterStyleConfig.h 第 47 行定义.

被这些函数引用 eve::graphics::Water::bindParams(), toValue() , 以及 validate().

◆ deepColor

glm::vec3 eve::graphics::WaterStyleConfig::deepColor {0.02F, 0.16F, 0.24F}

在文件 WaterStyleConfig.h 第 19 行定义.

被这些函数引用 eve::graphics::Water::bindParams(), eve::graphics::Water::setWaterColor(), toValue() , 以及 validate().

◆ depthDistance

float eve::graphics::WaterStyleConfig::depthDistance = 5.0F

在文件 WaterStyleConfig.h 第 32 行定义.

被这些函数引用 eve::graphics::Water::bindParams(), toValue() , 以及 validate().

◆ foamColor

glm::vec3 eve::graphics::WaterStyleConfig::foamColor {0.85F, 0.93F, 1.0F}

在文件 WaterStyleConfig.h 第 21 行定义.

被这些函数引用 eve::graphics::Water::bindParams(), toValue() , 以及 validate().

◆ foamSoftness

float eve::graphics::WaterStyleConfig::foamSoftness = 0.08F

在文件 WaterStyleConfig.h 第 36 行定义.

被这些函数引用 eve::graphics::Water::bindParams(), toValue() , 以及 validate().

◆ foamStrength

float eve::graphics::WaterStyleConfig::foamStrength = 0.85F

在文件 WaterStyleConfig.h 第 37 行定义.

被这些函数引用 eve::graphics::Water::bindParams(), toValue() , 以及 validate().

◆ foamWidth

float eve::graphics::WaterStyleConfig::foamWidth = 0.45F

在文件 WaterStyleConfig.h 第 35 行定义.

被这些函数引用 eve::graphics::Water::bindParams(), eve::graphics::Water::setEdgeFalloff(), toValue() , 以及 validate().

◆ fresnelPower

float eve::graphics::WaterStyleConfig::fresnelPower = 5.0F

在文件 WaterStyleConfig.h 第 39 行定义.

被这些函数引用 eve::graphics::Water::bindParams(), toValue() , 以及 validate().

◆ opacity

float eve::graphics::WaterStyleConfig::opacity = 0.88F

在文件 WaterStyleConfig.h 第 33 行定义.

被这些函数引用 eve::graphics::Water::bindParams(), toValue() , 以及 validate().

◆ reflectionIntensity

float eve::graphics::WaterStyleConfig::reflectionIntensity = 0.60F

在文件 WaterStyleConfig.h 第 40 行定义.

被这些函数引用 eve::graphics::Water::bindParams(), eve::graphics::Water::setReflectionIntensity(), toValue() , 以及 validate().

◆ reflectionTint

glm::vec3 eve::graphics::WaterStyleConfig::reflectionTint {0.70F, 0.85F, 1.0F}

在文件 WaterStyleConfig.h 第 22 行定义.

被这些函数引用 eve::graphics::Water::bindParams(), eve::graphics::Water::setReflectionTint(), toValue() , 以及 validate().

◆ refractionStrength

float eve::graphics::WaterStyleConfig::refractionStrength = 0.025F

在文件 WaterStyleConfig.h 第 45 行定义.

被这些函数引用 eve::graphics::Water::bindParams(), toValue() , 以及 validate().

◆ rippleAmplitude

float eve::graphics::WaterStyleConfig::rippleAmplitude = 0.60F

在文件 WaterStyleConfig.h 第 28 行定义.

被这些函数引用 eve::graphics::Water::bindParams(), eve::graphics::Water::setRippleAmplitude(), toValue() , 以及 validate().

◆ rippleCount

int eve::graphics::WaterStyleConfig::rippleCount = 6

在文件 WaterStyleConfig.h 第 29 行定义.

被这些函数引用 eve::graphics::Water::bindParams(), eve::graphics::Water::setRippleCount() , 以及 toValue().

◆ rippleInterval

float eve::graphics::WaterStyleConfig::rippleInterval = 1.6F

在文件 WaterStyleConfig.h 第 30 行定义.

被这些函数引用 eve::graphics::Water::bindParams(), eve::graphics::Water::setRippleInterval(), toValue() , 以及 validate().

◆ SchemaId

constexpr std::string_view eve::graphics::WaterStyleConfig::SchemaId = "eve.graphics.stylized-water"
staticconstexpr

在文件 WaterStyleConfig.h 第 16 行定义.

被这些函数引用 fromValue() , 以及 toValue().

◆ SchemaVersion

constexpr std::uint32_t eve::graphics::WaterStyleConfig::SchemaVersion = 1
staticconstexpr

在文件 WaterStyleConfig.h 第 17 行定义.

被这些函数引用 toValue().

◆ screenSpaceReflection

bool eve::graphics::WaterStyleConfig::screenSpaceReflection = false

在文件 WaterStyleConfig.h 第 42 行定义.

被这些函数引用 eve::graphics::Water::bindParams(), eve::graphics::Water::setScreenSpaceReflection() , 以及 toValue().

◆ screenSpaceReflectionStrength

float eve::graphics::WaterStyleConfig::screenSpaceReflectionStrength = 0.85F

在文件 WaterStyleConfig.h 第 43 行定义.

被这些函数引用 eve::graphics::Water::bindParams(), eve::graphics::Water::setScreenSpaceReflection(), toValue() , 以及 validate().

◆ shallowColor

glm::vec3 eve::graphics::WaterStyleConfig::shallowColor {0.10F, 0.48F, 0.58F}

在文件 WaterStyleConfig.h 第 20 行定义.

被这些函数引用 eve::graphics::Water::bindParams(), toValue() , 以及 validate().

◆ sunIntensity

float eve::graphics::WaterStyleConfig::sunIntensity = 0.90F

在文件 WaterStyleConfig.h 第 41 行定义.

被这些函数引用 eve::graphics::Water::bindParams(), eve::graphics::Water::setSunIntensity(), toValue() , 以及 validate().

◆ waveAmplitude

float eve::graphics::WaterStyleConfig::waveAmplitude = 0.35F

在文件 WaterStyleConfig.h 第 25 行定义.

被这些函数引用 eve::graphics::Water::bindParams(), eve::graphics::Water::setWaveAmplitude(), toValue() , 以及 validate().

◆ waveScale

float eve::graphics::WaterStyleConfig::waveScale = 14.0F

在文件 WaterStyleConfig.h 第 26 行定义.

被这些函数引用 eve::graphics::Water::bindParams(), eve::graphics::Water::setWaveScale(), toValue() , 以及 validate().

◆ waveSharpness

float eve::graphics::WaterStyleConfig::waveSharpness = 1.0F

在文件 WaterStyleConfig.h 第 27 行定义.

被这些函数引用 eve::graphics::Water::bindParams(), toValue() , 以及 validate().

◆ waveSpeed

float eve::graphics::WaterStyleConfig::waveSpeed = 1.2F

在文件 WaterStyleConfig.h 第 24 行定义.

被这些函数引用 eve::graphics::Water::bindParams(), eve::graphics::Water::setWaveSpeed(), toValue() , 以及 validate().

该结构体的文档由以下文件生成: