For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /server-graphics/classes/BiomeColorGrading.md.

Class: BiomeColorGrading experimental

biome

Beta

用于影响 Vibrant Visuals(灵动视效)的颜色分级。

Used to affect color grading for Vibrant Visuals

Methods

resetHighlightsContrast()

resetHighlightsContrast(): void

World Mutation Beta

Returns

void

Remarks

将高光的对比度重置为资源包设定的值。

Resets the contrast of highlights to the value set by resource packs

Throws

This function can throw errors.

EngineError


resetHighlightsGain()

resetHighlightsGain(): void

World Mutation Beta

Returns

void

Remarks

将高光的增益重置为资源包设定的值。

Resets the gain of highlights to the value set by resource packs

Throws

This function can throw errors.

EngineError


resetHighlightsGamma()

resetHighlightsGamma(): void

World Mutation Beta

Returns

void

Remarks

将高光的伽马值重置为资源包设定的值。

Resets the gamma of highlights to the value set by resource packs

Throws

This function can throw errors.

EngineError


resetHighlightsMin()

resetHighlightsMin(): void

World Mutation Beta

Returns

void

Remarks

将高光下限重置为资源包设定的值。

Resets the highlights min to the value set by resource packs

Throws

This function can throw errors.

EngineError


resetHighlightsOffset()

resetHighlightsOffset(): void

World Mutation Beta

Returns

void

Remarks

将高光的偏移量重置为资源包设定的值。

Resets the offset of highlights to the value set by resource packs

Throws

This function can throw errors.

EngineError


resetHighlightsSaturation()

resetHighlightsSaturation(): void

World Mutation Beta

Returns

void

Remarks

将高光的饱和度重置为资源包设定的值。

Resets the saturation of highlights to the value set by resource packs

Throws

This function can throw errors.

EngineError


resetMidtonesContrast()

resetMidtonesContrast(): void

World Mutation Beta

Returns

void

Remarks

将中间调的对比度重置为资源包设定的值。

Resets the contrast of midtones to the value set by resource packs

Throws

This function can throw errors.

EngineError


resetMidtonesGain()

resetMidtonesGain(): void

World Mutation Beta

Returns

void

Remarks

将中间调的增益重置为资源包设定的值。

Resets the gain of midtones to the value set by resource packs

Throws

This function can throw errors.

EngineError


resetMidtonesGamma()

resetMidtonesGamma(): void

World Mutation Beta

Returns

void

Remarks

将中间调的伽马值重置为资源包设定的值。

Resets the gamma of midtones to the value set by resource packs

Throws

This function can throw errors.

EngineError


resetMidtonesOffset()

resetMidtonesOffset(): void

World Mutation Beta

Returns

void

Remarks

将中间调的偏移量重置为资源包设定的值。

Resets the offset of midtones to the value set by resource packs

Throws

This function can throw errors.

EngineError


resetMidtonesSaturation()

resetMidtonesSaturation(): void

World Mutation Beta

Returns

void

Remarks

将中间调的饱和度重置为资源包设定的值。

Resets the saturation of midtones to the value set by resource packs

Throws

This function can throw errors.

EngineError


resetShadowsContrast()

resetShadowsContrast(): void

World Mutation Beta

Returns

void

Remarks

将阴影的对比度重置为资源包设定的值。

Resets the contrast of shadows to the value set by resource packs

Throws

This function can throw errors.

EngineError


resetShadowsGain()

resetShadowsGain(): void

World Mutation Beta

Returns

void

Remarks

将阴影的增益重置为资源包设定的值。

Resets the gain of shadows to the value set by resource packs

Throws

This function can throw errors.

EngineError


resetShadowsGamma()

resetShadowsGamma(): void

World Mutation Beta

Returns

void

Remarks

将阴影的伽马值重置为资源包设定的值。

Resets the gamma of shadows to the value set by resource packs

Throws

This function can throw errors.

EngineError


resetShadowsMax()

resetShadowsMax(): void

World Mutation Beta

Returns

void

Remarks

将阴影上限重置为资源包设定的值。

Resets the shadows max to the value set by resource packs

Throws

This function can throw errors.

EngineError


resetShadowsOffset()

resetShadowsOffset(): void

World Mutation Beta

Returns

void

Remarks

将阴影的偏移量重置为资源包设定的值。

Resets the offset of shadows to the value set by resource packs

Throws

This function can throw errors.

EngineError


resetShadowsSaturation()

resetShadowsSaturation(): void

World Mutation Beta

Returns

void

Remarks

将阴影的饱和度重置为资源包设定的值。

Resets the saturation of shadows to the value set by resource packs

Throws

This function can throw errors.

EngineError


resetTemperature()

resetTemperature(): void

World Mutation Beta

Returns

void

Remarks

将色温重置为资源包设定的值。

Resets the temperature to the value set by resource packs

Throws

This function can throw errors.

EngineError


setHighlightsContrast()

setHighlightsContrast(highlightsContrast): void

World Mutation Beta

Parameters

highlightsContrast

Vector3

一个 Vector3(取值范围 [0.0f, 4.0f])。用于设置高光的对比度。 对比度描述色调范围,即图像中亮像素与暗像素之间的亮度差异。 高对比度的图像其像素亮度值分布范围很广,而低对比度的图像 其像素亮度值分布范围相对较窄。值为 1.0 时不改变原图像的对比度。 值为 0.0 时会得到一张完全褪色的灰色图像。大于 1.0 的值会在 最终图像中提高高光亮度并加深阴影。

A Vector3 (range [0.0f, 4.0f]). Used to set the contrast of highlights. Describes the tonal range, the difference in luminance between the bright and dark pixels in an image. An image with high contrast will have pixels with a wide range of luminance values, whereas an image with low contrast will have pixels of a relatively small luminance range. A value of 1.0 results in no change in contrast to the original image. A value of 0.0 results in a completely washed-out, gray image. Values > 1.0 increase the brightness of highlights while darkening the shadows in the final image.

Returns

void

Remarks

设置 Vibrant Visuals 中颜色分级的高光对比度。

Sets the contrast of highlights for color grading in Vibrant Visuals

Throws

This function can throw errors.

InvalidArgumentError


setHighlightsGain()

setHighlightsGain(highlightsGain): void

World Mutation Beta

Parameters

highlightsGain

Vector3

一个 Vector3(取值范围 [0.0f, 10.0f])。用于设置高光的增益。 增益是应用于各颜色通道的乘法因子,用于调整高光范围的整体亮度强度。 值为 1.0 时不改变原图像。值 < 1.0 会使图像变暗,值 > 1.0 会使其变亮。 值为 0.0 时会完全抵消该颜色通道。增益是乘法性的,因此对较亮像素的 影响比对较暗像素更强。

A Vector3 (range [0.0f, 10.0f]). Used to set the gain of highlights. A multiplication factor applied to each color channel to adjust the overall luminance intensity of the highlight range. A value of 1.0 results in no change to the original image. Values < 1.0 darken the image while values > 1.0 brighten it. A value of 0.0 cancels out the color channel completely. Gain is multiplicative and therefore has a stronger effect on brighter pixels than darker pixels.

Returns

void

Remarks

设置 Vibrant Visuals 中颜色分级的高光增益。

Sets the gain of highlights for color grading in Vibrant Visuals

Throws

This function can throw errors.

InvalidArgumentError


setHighlightsGamma()

setHighlightsGamma(highlightsGamma): void

World Mutation Beta

Parameters

highlightsGamma

Vector3

一个 Vector3(取值范围 [0.0f, 4.0f])。用于设置高光的伽马值。 伽马值是在颜色分级和色调映射之后应用于最终颜色的指数因子, 用于调整图像的整体亮度强度。伽马值的标准值为 2.2。较低的值会 加深最终图像,较高的值则会使其变亮。伽马值过高会使最终图像 显得褪色。

A Vector3 (range [0.0f, 4.0f]). Used to set the gamma of highlights. An exponential factor applied to the final color after both color grading and tone mapping to adjust the overall luminance intensity of the image. The standard value for gamma is 2.2. Lower values darken the final image, whereas higher values brighten it. Too high a gamma will cause the final image to appear washed-out.

Returns

void

Remarks

设置 Vibrant Visuals 中颜色分级的高光伽马值。

Sets the gamma of highlights for color grading in Vibrant Visuals

Throws

This function can throw errors.

InvalidArgumentError


setHighlightsMin()

setHighlightsMin(highlightsMin): void

World Mutation Beta

Parameters

highlightsMin

number

一个数字(取值范围 [1.0f, 20.0f])。用于设置高光下限。 该因子与场景的平均亮度相乘,用于确定哪些像素被视为高光。 亮度大于 HighlightsMin * AverageLuminance 的像素将应用高光组的 颜色分级值。值为 1.0 表示高光占据平均亮度及以上的整个取值范围。 更高的值会提高像素被视为高光所需的最低亮度值。此值不应等于 ShadowsMax。

A number (range [1.0f, 20.0f]). Used to set the highlights min. A factor multiplied by the average luminance of the scene to determine which pixels are considered highlights. Pixels with luminance greater than HighlightsMin * AverageLuminance will have the highlights set of color grading values applied. A value of 1.0 indicates highlights occupy the entire range of values including and above the average luminance. Higher values will cause the minimum required luminance value for a pixel to be considered a highlight to rise. This value should not be equal to ShadowsMax.

Returns

void

Remarks

设置 Vibrant Visuals 中颜色分级的高光下限。

Sets the highlights min for color grading in Vibrant Visuals

Throws

This function can throw errors.

InvalidArgumentError


setHighlightsOffset()

setHighlightsOffset(highlightsOffset): void

World Mutation Beta

Parameters

highlightsOffset

Vector3

一个 Vector3(取值范围 [-1.0f, 1.0f])。用于设置高光的偏移量。 偏移量是一个加法因子,它先与场景的平均亮度相乘,再加到指定的 颜色通道上,用于调整图像的整体亮度强度。值为 0.0 时不产生变化。 值 > 0.0 会使图像变亮,值 < 0.0 会使其变暗。偏移量是加法性的, 因此对较暗像素的影响比对较亮像素更强。

A Vector3 (range [-1.0f, 1.0f]). Used to set the offset of highlights. An additive factor that is multiplied by the average luminance of the scene and then added to a given color channel to adjust the overall luminance intensity of the image. A value of 0.0 results in no change. Values > 0.0 brighten the image, values < 0.0 darken it. Offset is additive and therefore has a stronger effect on darker pixels than brighter pixels.

Returns

void

Remarks

设置 Vibrant Visuals 中颜色分级的高光偏移量。

Sets the offset of highlights for color grading in Vibrant Visuals

Throws

This function can throw errors.

InvalidArgumentError


setHighlightsSaturation()

setHighlightsSaturation(highlightsSaturation): void

World Mutation Beta

Parameters

highlightsSaturation

Vector3

一个 Vector3(取值范围 [0.0f, 10.0f])。用于设置高光的饱和度。 饱和度决定颜色的色相强度。值为 1.0 时不改变原图像的饱和度。 值为 0.0 时会得到一张灰度图像。值 > 1.0 会增强颜色的强度。

A Vector3 (range [0.0f, 10.0f]). Used to set the saturation of highlights. Determines the hue intensity of colors. A value of 1.0 results in no change in saturation to the original image. A value of 0.0 results in a grayscale image. Values > 1.0 increase the intensity of colors.

Returns

void

Remarks

设置 Vibrant Visuals 中颜色分级的高光饱和度。

Sets the saturation of highlights for color grading in Vibrant Visuals

Throws

This function can throw errors.

InvalidArgumentError


setMidtonesContrast()

setMidtonesContrast(midtonesContrast): void

World Mutation Beta

Parameters

midtonesContrast

Vector3

一个 Vector3(取值范围 [0.0f, 4.0f])。用于设置中间调的对比度。 对比度描述色调范围,即图像中亮像素与暗像素之间的亮度差异。 高对比度的图像其像素亮度值分布范围很广,而低对比度的图像 其像素亮度值分布范围相对较窄。值为 1.0 时不改变原图像的对比度。 值为 0.0 时会得到一张完全褪色的灰色图像。大于 1.0 的值会在 最终图像中提高高光亮度并加深阴影。

A Vector3 (range [0.0f, 4.0f]). Used to set the contrast of midtones. Describes the tonal range, the difference in luminance between the bright and dark pixels in an image. An image with high contrast will have pixels with a wide range of luminance values, whereas an image with low contrast will have pixels of a relatively small luminance range. A value of 1.0 results in no change in contrast to the original image. A value of 0.0 results in a completely washed-out, gray image. Values > 1.0 increase the brightness of highlights while darkening the shadows in the final image.

Returns

void

Remarks

设置 Vibrant Visuals 中颜色分级的中间调对比度。

Sets the contrast of midtones for color grading in Vibrant Visuals

Throws

This function can throw errors.

InvalidArgumentError


setMidtonesGain()

setMidtonesGain(midtonesGain): void

World Mutation Beta

Parameters

midtonesGain

Vector3

一个 Vector3(取值范围 [0.0f, 10.0f])。用于设置中间调的增益。 增益是应用于各颜色通道的乘法因子,用于调整中间调范围的整体亮度强度。 值为 1.0 时不改变原图像。值 < 1.0 会使图像变暗,值 > 1.0 会使其变亮。 值为 0.0 时会完全抵消该颜色通道。增益是乘法性的,因此对较亮像素的 影响比对较暗像素更强。

A Vector3 (range [0.0f, 10.0f]). Used to set the gain of midtones. A multiplication factor applied to each color channel to adjust the overall luminance intensity of the midtone range. A value of 1.0 results in no change to the original image. Values < 1.0 darken the image while values > 1.0 brighten it. A value of 0.0 cancels out the color channel completely. Gain is multiplicative and therefore has a stronger effect on brighter pixels than darker pixels.

Returns

void

Remarks

设置 Vibrant Visuals 中颜色分级的中间调增益。

Sets the gain of midtones for color grading in Vibrant Visuals

Throws

This function can throw errors.

InvalidArgumentError


setMidtonesGamma()

setMidtonesGamma(midtonesGamma): void

World Mutation Beta

Parameters

midtonesGamma

Vector3

一个 Vector3(取值范围 [0.0f, 4.0f])。用于设置中间调的伽马值。 伽马值是在颜色分级和色调映射之后应用于最终颜色的指数因子, 用于调整图像的整体亮度强度。伽马值的标准值为 2.2。较低的值会 加深最终图像,较高的值则会使其变亮。伽马值过高会使最终图像 显得褪色。

A Vector3 (range [0.0f, 4.0f]). Used to set the gamma of midtones. An exponential factor applied to the final color after both color grading and tone mapping to adjust the overall luminance intensity of the image. The standard value for gamma is 2.2. Lower values darken the final image, whereas higher values brighten it. Too high a gamma will cause the final image to appear washed-out.

Returns

void

Remarks

设置 Vibrant Visuals 中颜色分级的中间调伽马值。

Sets the gamma of midtones for color grading in Vibrant Visuals

Throws

This function can throw errors.

InvalidArgumentError


setMidtonesOffset()

setMidtonesOffset(midtonesOffset): void

World Mutation Beta

Parameters

midtonesOffset

Vector3

一个 Vector3(取值范围 [-1.0f, 1.0f])。用于设置中间调的偏移量。 偏移量是一个加法因子,它先与场景的平均亮度相乘,再加到指定的 颜色通道上,用于调整图像的整体亮度强度。值为 0.0 时不产生变化。 值 > 0.0 会使图像变亮,值 < 0.0 会使其变暗。偏移量是加法性的, 因此对较暗像素的影响比对较亮像素更强。

A Vector3 (range [-1.0f, 1.0f]). Used to set the offset of midtones. An additive factor that is multiplied by the average luminance of the scene and then added to a given color channel to adjust the overall luminance intensity of the image. A value of 0.0 results in no change. Values > 0.0 brighten the image, values < 0.0 darken it. Offset is additive and therefore has a stronger effect on darker pixels than brighter pixels.

Returns

void

Remarks

设置 Vibrant Visuals 中颜色分级的中间调偏移量。

Sets the offset of midtones for color grading in Vibrant Visuals

Throws

This function can throw errors.

InvalidArgumentError


setMidtonesSaturation()

setMidtonesSaturation(midtonesSaturation): void

World Mutation Beta

Parameters

midtonesSaturation

Vector3

一个 Vector3(取值范围 [0.0f, 10.0f])。用于设置中间调的饱和度。 饱和度决定颜色的色相强度。值为 1.0 时不改变原图像的饱和度。 值为 0.0 时会得到一张灰度图像。值 > 1.0 会增强颜色的强度。

A Vector3 (range [0.0f, 10.0f]). Used to set the saturation of midtones. Determines the hue intensity of colors. A value of 1.0 results in no change in saturation to the original image. A value of 0.0 results in a grayscale image. Values > 1.0 increase the intensity of colors.

Returns

void

Remarks

设置 Vibrant Visuals 中颜色分级的中间调饱和度。

Sets the saturation of midtones for color grading in Vibrant Visuals

Throws

This function can throw errors.

InvalidArgumentError


setShadowsContrast()

setShadowsContrast(shadowsContrast): void

World Mutation Beta

Parameters

shadowsContrast

Vector3

一个 Vector3(取值范围 [0.0f, 4.0f])。用于设置阴影的对比度。 对比度描述色调范围,即图像中亮像素与暗像素之间的亮度差异。 高对比度的图像其像素亮度值分布范围很广,而低对比度的图像 其像素亮度值分布范围相对较窄。值为 1.0 时不改变原图像的对比度。 值为 0.0 时会得到一张完全褪色的灰色图像。大于 1.0 的值会在 最终图像中提高高光亮度并加深阴影。

A Vector3 (range [0.0f, 4.0f]). Used to set the contrast of shadows. Describes the tonal range, the difference in luminance between the bright and dark pixels in an image. An image with high contrast will have pixels with a wide range of luminance values, whereas an image with low contrast will have pixels of a relatively small luminance range. A value of 1.0 results in no change in contrast to the original image. A value of 0.0 results in a completely washed-out, gray image. Values > 1.0 increase the brightness of highlights while darkening the shadows in the final image.

Returns

void

Remarks

设置 Vibrant Visuals 中颜色分级的阴影对比度。

Sets the contrast of shadows for color grading in Vibrant Visuals

Throws

This function can throw errors.

InvalidArgumentError


setShadowsGain()

setShadowsGain(shadowsGain): void

World Mutation Beta

Parameters

shadowsGain

Vector3

一个 Vector3(取值范围 [0.0f, 10.0f])。用于设置阴影的增益。 增益是应用于各颜色通道的乘法因子,用于调整阴影范围的整体亮度强度。 值为 1.0 时不改变原图像。值 < 1.0 会使图像变暗,值 > 1.0 会使其变亮。 值为 0.0 时会完全抵消该颜色通道。增益是乘法性的,因此对较亮像素的 影响比对较暗像素更强。

A Vector3 (range [0.0f, 10.0f]). Used to set the gain of shadows. A multiplication factor applied to each color channel to adjust the overall luminance intensity of the shadow range. A value of 1.0 results in no change to the original image. Values < 1.0 darken the image while values > 1.0 brighten it. A value of 0.0 cancels out the color channel completely. Gain is multiplicative and therefore has a stronger effect on brighter pixels than darker pixels.

Returns

void

Remarks

设置 Vibrant Visuals 中颜色分级的阴影增益。

Sets the gain of shadows for color grading in Vibrant Visuals

Throws

This function can throw errors.

InvalidArgumentError


setShadowsGamma()

setShadowsGamma(shadowsGamma): void

World Mutation Beta

Parameters

shadowsGamma

Vector3

一个 Vector3(取值范围 [0.0f, 4.0f])。用于设置阴影的伽马值。 伽马值是在颜色分级和色调映射之后应用于最终颜色的指数因子, 用于调整图像的整体亮度强度。伽马值的标准值为 2.2。较低的值会 加深最终图像,较高的值则会使其变亮。伽马值过高会使最终图像 显得褪色。

A Vector3 (range [0.0f, 4.0f]). Used to set the gamma of shadows. An exponential factor applied to the final color after both color grading and tone mapping to adjust the overall luminance intensity of the image. The standard value for gamma is 2.2. Lower values darken the final image, whereas higher values brighten it. Too high a gamma will cause the final image to appear washed-out.

Returns

void

Remarks

设置 Vibrant Visuals 中颜色分级的阴影伽马值。

Sets the gamma of shadows for color grading in Vibrant Visuals

Throws

This function can throw errors.

InvalidArgumentError


setShadowsMax()

setShadowsMax(shadowsMax): void

World Mutation Beta

Parameters

shadowsMax

number

一个数字(取值范围 [0.0f, 1.0f])。用于设置阴影上限。 该因子与场景的平均亮度相乘,用于确定哪些像素被视为阴影。 亮度小于 ShadowsMax * AverageLuminance 的像素将应用阴影组的 颜色分级值。值为 1.0 表示阴影占据平均亮度及以下的整个取值范围。 更低的值会降低像素被视为阴影所需的最高亮度值。此值不应等于 HighlightsMin。

A number (range [0.0f, 1.0f]). Used to set the shadows max. A factor multiplied by the average luminance of the scene to determine which pixels are considered shadows. Pixels with luminance less than ShadowsMax * AverageLuminance will have the shadows set of color grading values applied. A value of 1.0 indicates shadows occupy the entire range of values including and up to the average luminance. Lower values will cause the maximum required luminance value for a pixel to be considered a shadow to drop. This value should not be equal to HighlightsMin.

Returns

void

Remarks

设置 Vibrant Visuals 中颜色分级的阴影上限。

Sets the shadows max for color grading in Vibrant Visuals

Throws

This function can throw errors.

InvalidArgumentError


setShadowsOffset()

setShadowsOffset(shadowsOffset): void

World Mutation Beta

Parameters

shadowsOffset

Vector3

一个 Vector3(取值范围 [-1.0f, 1.0f])。用于设置阴影的偏移量。 偏移量是一个加法因子,它先与场景的平均亮度相乘,再加到指定的 颜色通道上,用于调整图像的整体亮度强度。值为 0.0 时不产生变化。 值 > 0.0 会使图像变亮,值 < 0.0 会使其变暗。偏移量是加法性的, 因此对较暗像素的影响比对较亮像素更强。

A Vector3 (range [-1.0f, 1.0f]). Used to set the offset of shadows. An additive factor that is multiplied by the average luminance of the scene and then added to a given color channel to adjust the overall luminance intensity of the image. A value of 0.0 results in no change. Values > 0.0 brighten the image, values < 0.0 darken it. Offset is additive and therefore has a stronger effect on darker pixels than brighter pixels.

Returns

void

Remarks

设置 Vibrant Visuals 中颜色分级的阴影偏移量。

Sets the offset of shadows for color grading in Vibrant Visuals

Throws

This function can throw errors.

InvalidArgumentError


setShadowsSaturation()

setShadowsSaturation(shadowsSaturation): void

World Mutation Beta

Parameters

shadowsSaturation

Vector3

一个 Vector3(取值范围 [0.0f, 10.0f])。用于设置阴影的饱和度。 饱和度决定颜色的色相强度。值为 1.0 时不改变原图像的饱和度。 值为 0.0 时会得到一张灰度图像。值 > 1.0 会增强颜色的强度。

A Vector3 (range [0.0f, 10.0f]). Used to set the saturation of shadows. Determines the hue intensity of colors. A value of 1.0 results in no change in saturation to the original image. A value of 0.0 results in a grayscale image. Values > 1.0 increase the intensity of colors.

Returns

void

Remarks

设置 Vibrant Visuals 中颜色分级的阴影饱和度。

Sets the saturation of shadows for color grading in Vibrant Visuals

Throws

This function can throw errors.

InvalidArgumentError


setTemperature()

setTemperature(temperature): void

World Mutation Beta

Parameters

temperature

number

一个数字(取值范围 [1000.0f, 15000.0f])。用于设置色温。 即以开尔文(Kelvin)为单位测量的整体图像色温。默认值为 6500.0, 即标准的「日光」照明。

A number (range [1000.0f, 15000.0f]). Used to set the temperature. The overall image temperature measured in Kelvin. The default value is 6500.0, the standard "daylight" illumination.

Returns

void

Remarks

设置 Vibrant Visuals 中颜色分级的色温。

Sets the temperature for color grading in Vibrant Visuals

Throws

This function can throw errors.

InvalidArgumentError

同领域相关