RenderingServer
Низкоуровневый API управления ресурсами и экземплярами рендеринга.
Обычный MeshInstance3D уже управляет размещением меша и его связью с деревом. Прямое использование RenderingServer позволяет самостоятельно создать экземпляр через RID, но требует управления сценарием мира, преобразованием, видимостью и сроком жизни.
InstanceCreate создаёт собственный RID. Назначьте ему Mesh RID и World3D.Scenario, удерживайте сильные ссылки на ресурсы и освободите собственный экземпляр через FreeRid. Заимствованный RID мира не принадлежит этому коду. Руководство проверяет rendering instance; оно не реализует ECS, физику или streaming.
Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.
Свойства2
RenderLoopEnabledСвойство
public static bool RenderLoopEnabled { get; set; }Если false, отключает рендеринг полностью, но логика движка все еще обрабатывается. Вы можете вызвать RenderingServer.ForceDraw, чтобы нарисовать кадр даже при отключенном рендеринге.
SingletonСвойство
public static RenderingServerInstance Singleton { get; }Методы568
AreaLightCreateRid
public static Rid AreaLightCreate();Создаёт новую область света и добавляет его к RenderingServer1. Доступ к нему можно получить через RID Вернули. RID могут использоваться в большинстве light_* RenderingServer функции.
Как только закончите с вашим RIDВы захотите освободить RID с использованием RenderingServer's RenderingServer.FreeRid Метод.
Для того чтобы поместиться в сцену, прикрепите эту зону свет к случаю с использованием RenderingServer.InstanceSetBase с использованием возвращенных RID.
Примечание: Эквивалентный узел: AreaLight3D.
RidBakeRenderUV2Reckfell.Collections.Array<Image>
public static Reckfell.Collections.Array<Image> BakeRenderUV2(Rid @base, Reckfell.Collections.Array<Rid> materialOverrides, Vector2I imageSize);Обеспечивает материальные данные Mesh Прошёл base параметр с факультативным material_overrides на набор из Images размера image_size1. Возвращает целый ряд Images со свойствами материала, указанными в RenderingServer.BakeChannels.
| Имя | Тип | По умолчанию |
|---|---|---|
base | Rid | — |
materialOverrides | Reckfell.Collections.Array<Rid> | — |
imageSize | Vector2I | — |
Reckfell.Collections.Array<Image>CallOnRenderThreadvoid
public static void CallOnRenderThread(Callable callable);Поскольку реальная логика RenderingServer может выполняться в отдельном потоке, доступ к его внутренним функциям из основного (или любого другого) потока приведёт к ошибкам. Чтобы упростить запуск кода, который может безопасно обращаться к внутренним функциям рендеринга (например, RenderingDevice и аналогичным классам RD), передайте вызываемый объект через эту функцию, чтобы он выполнялся в потоке рендеринга.
| Имя | Тип | По умолчанию |
|---|---|---|
callable | Callable | — |
CameraAttributesCreateRid
public static Rid CameraAttributesCreate();Создает объект атрибутов камеры и добавляет его в RenderingServer. К нему можно получить доступ с помощью возвращаемого RID. Этот RID будет использоваться во всех функциях camera_attributes_ RenderingServer.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer.FreeRid RenderingServer.
Примечание: Эквивалентный ресурс — CameraAttributes.
RidCameraAttributesSetAutoExposurevoid
public static void CameraAttributesSetAutoExposure(Rid cameraAttributes, bool enable, float minSensitivity, float maxSensitivity, float speed, float scale);Устанавливает параметры для использования с эффектом автоэкспозиции. Эти параметры имеют то же значение, что и их аналоги в CameraAttributes и CameraAttributesPractical.
| Имя | Тип | По умолчанию |
|---|---|---|
cameraAttributes | Rid | — |
enable | bool | — |
minSensitivity | float | — |
maxSensitivity | float | — |
speed | float | — |
scale | float | — |
CameraAttributesSetDofBlurvoid
public static void CameraAttributesSetDofBlur(Rid cameraAttributes, bool farEnable, float farDistance, float farTransition, bool nearEnable, float nearDistance, float nearTransition, float amount);Устанавливает параметры, которые будут использоваться с эффектом размытия глубины резкости (DOF). Эти параметры имеют то же значение, что и их аналоги в CameraAttributesPractical.
| Имя | Тип | По умолчанию |
|---|---|---|
cameraAttributes | Rid | — |
farEnable | bool | — |
farDistance | float | — |
farTransition | float | — |
nearEnable | bool | — |
nearDistance | float | — |
nearTransition | float | — |
amount | float | — |
CameraAttributesSetDofBlurBokehShapevoid
public static void CameraAttributesSetDofBlurBokehShape(RenderingServer.DofBokehShape shape);Устанавливает форму узора боке DOF на shape. Различные формы могут использоваться для достижения художественного эффекта или для достижения целевых показателей производительности.
| Имя | Тип | По умолчанию |
|---|---|---|
shape | RenderingServer.DofBokehShape | — |
CameraAttributesSetDofBlurQualityvoid
public static void CameraAttributesSetDofBlurQuality(RenderingServer.DofBlurQuality quality, bool useJitter);Устанавливает уровень качества эффекта размытия DOF на quality. use_jitter можно использовать для дрожания образцов, взятых во время прохода размытия, чтобы скрыть артефакты за счет большей размытости.
| Имя | Тип | По умолчанию |
|---|---|---|
quality | RenderingServer.DofBlurQuality | — |
useJitter | bool | — |
CameraAttributesSetExposurevoid
public static void CameraAttributesSetExposure(Rid cameraAttributes, float multiplier, float normalization);Устанавливает значения экспозиции, которые будут использоваться рендерерами. Величина нормализации используется для включения заданного значения экспозиции (EV) в расчеты рендеринга для уменьшения динамического диапазона сцены. Коэффициент нормализации можно рассчитать из значения экспозиции (EV100) следующим образом:
Значение экспозиции можно рассчитать на основе диафрагмы (в ступенях), выдержки (в секундах) и чувствительности (в ISO) следующим образом:
| Имя | Тип | По умолчанию |
|---|---|---|
cameraAttributes | Rid | — |
multiplier | float | — |
normalization | float | — |
CameraCreateRid
public static Rid CameraCreate();Создает 3D-камеру и добавляет ее в RenderingServer. Доступ к ней можно получить с помощью возвращаемого RID. Этот RID будет использоваться во всех функциях camera_* RenderingServer.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer.FreeRid RenderingServer.
Примечание: Эквивалентный узел — Camera3D.
RidCameraSetCameraAttributesvoid
public static void CameraSetCameraAttributes(Rid camera, Rid effects);Устанавливает camera_attributes, созданные с помощью RenderingServer.CameraAttributesCreate, для указанной камеры.
| Имя | Тип | По умолчанию |
|---|---|---|
camera | Rid | — |
effects | Rid | — |
CameraSetCompositorvoid
public static void CameraSetCompositor(Rid camera, Rid compositor);Устанавливает композитор, используемый этой камерой. Эквивалентно Camera3D.Compositor.
| Имя | Тип | По умолчанию |
|---|---|---|
camera | Rid | — |
compositor | Rid | — |
CameraSetCullMaskvoid
public static void CameraSetCullMask(Rid camera, uint layers);Устанавливает маску отбраковки, связанную с этой камерой. Маска отбраковки описывает, какие 3D-слои визуализируются этой камерой. Эквивалентно Camera3D.CullMask.
| Имя | Тип | По умолчанию |
|---|---|---|
camera | Rid | — |
layers | uint | — |
CameraSetEnvironmentvoid
public static void CameraSetEnvironment(Rid camera, Rid env);Устанавливает среду, используемую этой камерой. Эквивалентно Camera3D.Environment.
| Имя | Тип | По умолчанию |
|---|---|---|
camera | Rid | — |
env | Rid | — |
CameraSetFrustumvoid
public static void CameraSetFrustum(Rid camera, float size, Vector2 offset, float zNear, float zFar);Устанавливает камеру для использования проекции усеченной пирамиды. Этот режим позволяет настраивать аргумент offset для создания эффектов "наклонной пирамиды".
| Имя | Тип | По умолчанию |
|---|---|---|
camera | Rid | — |
size | float | — |
offset | Vector2 | — |
zNear | float | — |
zFar | float | — |
CameraSetOrthogonalvoid
public static void CameraSetOrthogonal(Rid camera, float size, float zNear, float zFar);Устанавливает камеру на использование ортогональной проекции, также известной как ортографическая проекция. Объекты остаются того же размера на экране, независимо от того, как далеко они находятся.
| Имя | Тип | По умолчанию |
|---|---|---|
camera | Rid | — |
size | float | — |
zNear | float | — |
zFar | float | — |
CameraSetPerspectivevoid
public static void CameraSetPerspective(Rid camera, float fovyDegrees, float zNear, float zFar);Устанавливает камеру на использование перспективной проекции. Объекты на экране становятся меньше, когда они находятся далеко.
| Имя | Тип | По умолчанию |
|---|---|---|
camera | Rid | — |
fovyDegrees | float | — |
zNear | float | — |
zFar | float | — |
CameraSetTransformvoid
public static void CameraSetTransform(Rid camera, Transform3D transform);Устанавливает Transform3D камеры.
| Имя | Тип | По умолчанию |
|---|---|---|
camera | Rid | — |
transform | Transform3D | — |
CameraSetUseVerticalAspectvoid
public static void CameraSetUseVerticalAspect(Rid camera, bool enable);Если true, сохраняет горизонтальное соотношение сторон, которое эквивалентно Camera3D.KeepAspectEnum.Width. Если false, сохраняет вертикальное соотношение сторон, которое эквивалентно Camera3D.KeepAspectEnum.Height.
| Имя | Тип | По умолчанию |
|---|---|---|
camera | Rid | — |
enable | bool | — |
CameraSetXRProjectionsvoid
public static void CameraSetXRProjections(Rid camera, Reckfell.Collections.Array<Projection> projections, Reckfell.Collections.Array<Transform3D> offsets = null);Устанавливает камеру для использования любого набора projections. Вы можете указать один проекция для каждого просмотра, установленного на портале просмотра. Если просмотр выравнивается (например, расстояние окуляра) и/или искажается, то эти данные могут быть представлены через offsets.
| Имя | Тип | По умолчанию |
|---|---|---|
camera | Rid | — |
projections | Reckfell.Collections.Array<Projection> | — |
offsets | Reckfell.Collections.Array<Transform3D> | null |
CanvasCreateRid
public static Rid CanvasCreate();Создает холст и возвращает назначенный Rid. К нему можно получить доступ с помощью возвращаемого RID. Этот RID будет использоваться во всех функциях canvas_* RenderingServer.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer.FreeRid RenderingServer.
У холста нет эквивалента Resource или Entity.
RidCanvasItemAddAnimationSlicevoid
public static void CanvasItemAddAnimationSlice(Rid item, double animationLength, double sliceBegin, double sliceEnd, double offset = 0d);Последующие команды рисования будут игнорироваться, если они не попадают в указанный фрагмент анимации. Это более быстрый способ реализовать анимацию, которая зацикливается на фоне, а не перерисовывается постоянно.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
animationLength | double | — |
sliceBegin | double | — |
sliceEnd | double | — |
offset | double | 0d |
CanvasItemAddCircle2 перегрузки
public static void CanvasItemAddCircle(Rid item, Vector2 pos, float radius, Color color);Рисует круг на CanvasItem, на который указывает item Rid. См. также CanvasItem.DrawCircle.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
pos | Vector2 | — |
radius | float | — |
color | Color | — |
public static void CanvasItemAddCircle(Rid item, Vector2 pos, float radius, Color color, bool antialiased = false);Рисует круг на CanvasItem, на который указывает item Rid. См. также CanvasItem.DrawCircle.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
pos | Vector2 | — |
radius | float | — |
color | Color | — |
antialiased | bool | false |
CanvasItemAddClipIgnorevoid
public static void CanvasItemAddClipIgnore(Rid item, bool ignore);Если ignore имеет значение true, игнорировать обрезку элементов, нарисованных с помощью этого элемента холста, пока это не будет вызвано снова с ignore, установленным на false.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
ignore | bool | — |
CanvasItemAddEllipsevoid
public static void CanvasItemAddEllipse(Rid item, Vector2 pos, float major, float minor, Color color, bool antialiased = false);Рисует эллипс с большой полуосью major и малой полуосью minor на объекте CanvasItem, на который указывает item Rid. См. также CanvasItem.DrawEllipse.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
pos | Vector2 | — |
major | float | — |
minor | float | — |
color | Color | — |
antialiased | bool | false |
CanvasItemAddLcdTextureRectRegionvoid
public static void CanvasItemAddLcdTextureRectRegion(Rid item, Rect2 rect, Rid texture, Rect2 srcRect, Color modulate);См. также CanvasItem.DrawLcdTextureRectRegion.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
rect | Rect2 | — |
texture | Rid | — |
srcRect | Rect2 | — |
modulate | Color | — |
CanvasItemAddLinevoid
public static void CanvasItemAddLine(Rid item, Vector2 from, Vector2 to, Color color, float width = -1f, bool antialiased = false);Рисует линию на CanvasItem, на которую указывает item Rid. См. также CanvasItem.DrawLine.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
from | Vector2 | — |
to | Vector2 | — |
color | Color | — |
width | float | -1f |
antialiased | bool | false |
CanvasItemAddMeshvoid
public static void CanvasItemAddMesh(Rid item, Rid mesh, Transform2D? transform = default, Color? modulate = default, Rid texture = default);Рисует сетку, созданную с помощью RenderingServer.MeshCreate с заданными transform, modulate color и texture. Используется внутренне MeshInstance2D.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
mesh | Rid | — |
transform | Transform2D? | default |
modulate | Color? | default |
texture | Rid | default |
transformЕсли параметр не имеет значения, то значение по умолчанию: Transform2D.Identity.
modulateЕсли параметр не имеет значения, то значение по умолчанию: new Color(1.0f, 1.0f, 1.0f, 1.0f).
CanvasItemAddMsdfTextureRectRegionvoid
public static void CanvasItemAddMsdfTextureRectRegion(Rid item, Rect2 rect, Rid texture, Rect2 srcRect, Color? modulate = default, int outlineSize = 0, float pxRange = 1f, float scale = 1f);См. также CanvasItem.DrawMsdfTextureRectRegion.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
rect | Rect2 | — |
texture | Rid | — |
srcRect | Rect2 | — |
modulate | Color? | default |
outlineSize | int | 0 |
pxRange | float | 1f |
scale | float | 1f |
modulateЕсли параметр не имеет значения, то значение по умолчанию: new Color(1.0f, 1.0f, 1.0f, 1.0f).
CanvasItemAddMultiline4 перегрузки
public static void CanvasItemAddMultiline(Rid item, Vector2[] points, Color[] colors, float width);Рисует 2D-мультилинию на CanvasItem, на которую указывает item Rid. См. также CanvasItem.DrawMultiline и CanvasItem.DrawMultilineColors.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
points | Vector2[] | — |
colors | Color[] | — |
width | float | — |
public static void CanvasItemAddMultiline(Rid item, Vector2[] points, Color[] colors, float width = -1f, bool antialiased = false);Рисует 2D-мультилинию на CanvasItem, на которую указывает item Rid. См. также CanvasItem.DrawMultiline и CanvasItem.DrawMultilineColors.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
points | Vector2[] | — |
colors | Color[] | — |
width | float | -1f |
antialiased | bool | false |
public static void CanvasItemAddMultiline(Rid item, ReadOnlySpan<Vector2> points, ReadOnlySpan<Color> colors, float width);Рисует 2D-мультилинию на CanvasItem, на которую указывает item Rid. См. также CanvasItem.DrawMultiline и CanvasItem.DrawMultilineColors.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
points | ReadOnlySpan<Vector2> | — |
colors | ReadOnlySpan<Color> | — |
width | float | — |
public static void CanvasItemAddMultiline(Rid item, ReadOnlySpan<Vector2> points, ReadOnlySpan<Color> colors, float width, bool antialiased);Рисует 2D-мультилинию на CanvasItem, на которую указывает item Rid. См. также CanvasItem.DrawMultiline и CanvasItem.DrawMultilineColors.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
points | ReadOnlySpan<Vector2> | — |
colors | ReadOnlySpan<Color> | — |
width | float | — |
antialiased | bool | — |
CanvasItemAddMultimeshvoid
public static void CanvasItemAddMultimesh(Rid item, Rid mesh, Rid texture = default);Рисует 2D MultiMesh на CanvasItem, на который указывает item Rid. См. также CanvasItem.DrawMultimesh.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
mesh | Rid | — |
texture | Rid | default |
CanvasItemAddNinePatchvoid
public static void CanvasItemAddNinePatch(Rid item, Rect2 rect, Rect2 source, Rid texture, Vector2 topleft, Vector2 bottomright, RenderingServer.NinePatchAxisMode xAxisMode = RenderingServer.NinePatchAxisMode.Stretch, RenderingServer.NinePatchAxisMode yAxisMode = RenderingServer.NinePatchAxisMode.Stretch, bool drawCenter = true, Color? modulate = default);Рисует прямоугольник из девяти частей на CanvasItem, на который указывает item Rid.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
rect | Rect2 | — |
source | Rect2 | — |
texture | Rid | — |
topleft | Vector2 | — |
bottomright | Vector2 | — |
xAxisMode | RenderingServer.NinePatchAxisMode | RenderingServer.NinePatchAxisMode.Stretch |
yAxisMode | RenderingServer.NinePatchAxisMode | RenderingServer.NinePatchAxisMode.Stretch |
drawCenter | bool | true |
modulate | Color? | default |
modulateЕсли параметр не имеет значения, то значение по умолчанию: new Color(1.0f, 1.0f, 1.0f, 1.0f).
CanvasItemAddParticlesvoid
public static void CanvasItemAddParticles(Rid item, Rid particles, Rid texture);Рисует частицы на CanvasItem, на который указывает item Rid.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
particles | Rid | — |
texture | Rid | — |
CanvasItemAddPolygon2 перегрузки
public static void CanvasItemAddPolygon(Rid item, Vector2[] points, Color[] colors, Vector2[] uvs = null, Rid texture = default);Рисует 2D-полигон на CanvasItem, на который указывает item Rid. Если вам нужна большая гибкость (например, возможность использовать кости), используйте RenderingServer.CanvasItemAddTriangleArray. См. также CanvasItem.DrawPolygon.
Примечание: Если вы часто перерисовываете один и тот же полигон с большим количеством вершин, рассмотрите возможность предварительного расчета триангуляции с помощью Geometry2D.TriangulatePolygon и использования CanvasItem.DrawMesh, CanvasItem.DrawMultimesh или RenderingServer.CanvasItemAddTriangleArray.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
points | Vector2[] | — |
colors | Color[] | — |
uvs | Vector2[] | null |
texture | Rid | default |
uvsЕсли параметр не имеет значения, то значение по умолчанию: Array.Empty<Vector2>().
public static void CanvasItemAddPolygon(Rid item, ReadOnlySpan<Vector2> points, ReadOnlySpan<Color> colors, ReadOnlySpan<Vector2> uvs, Rid texture);Рисует 2D-полигон на CanvasItem, на который указывает item Rid. Если вам нужна большая гибкость (например, возможность использовать кости), используйте RenderingServer.CanvasItemAddTriangleArray. См. также CanvasItem.DrawPolygon.
Примечание: Если вы часто перерисовываете один и тот же полигон с большим количеством вершин, рассмотрите возможность предварительного расчета триангуляции с помощью Geometry2D.TriangulatePolygon и использования CanvasItem.DrawMesh, CanvasItem.DrawMultimesh или RenderingServer.CanvasItemAddTriangleArray.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
points | ReadOnlySpan<Vector2> | — |
colors | ReadOnlySpan<Color> | — |
uvs | ReadOnlySpan<Vector2> | — |
texture | Rid | — |
CanvasItemAddPolyline2 перегрузки
public static void CanvasItemAddPolyline(Rid item, Vector2[] points, Color[] colors, float width = -1f, bool antialiased = false);Рисует 2D-полилинию на CanvasItem, на который указывает item Rid. См. также CanvasItem.DrawPolyline и CanvasItem.DrawPolylineColors.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
points | Vector2[] | — |
colors | Color[] | — |
width | float | -1f |
antialiased | bool | false |
public static void CanvasItemAddPolyline(Rid item, ReadOnlySpan<Vector2> points, ReadOnlySpan<Color> colors, float width, bool antialiased);Рисует 2D-полилинию на CanvasItem, на который указывает item Rid. См. также CanvasItem.DrawPolyline и CanvasItem.DrawPolylineColors.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
points | ReadOnlySpan<Vector2> | — |
colors | ReadOnlySpan<Color> | — |
width | float | — |
antialiased | bool | — |
CanvasItemAddPrimitive2 перегрузки
public static void CanvasItemAddPrimitive(Rid item, Vector2[] points, Color[] colors, Vector2[] uvs, Rid texture);Рисует 2D-примитив на CanvasItem, на который указывает item Rid. См. также CanvasItem.DrawPrimitive.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
points | Vector2[] | — |
colors | Color[] | — |
uvs | Vector2[] | — |
texture | Rid | — |
public static void CanvasItemAddPrimitive(Rid item, ReadOnlySpan<Vector2> points, ReadOnlySpan<Color> colors, ReadOnlySpan<Vector2> uvs, Rid texture);Рисует 2D-примитив на CanvasItem, на который указывает item Rid. См. также CanvasItem.DrawPrimitive.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
points | ReadOnlySpan<Vector2> | — |
colors | ReadOnlySpan<Color> | — |
uvs | ReadOnlySpan<Vector2> | — |
texture | Rid | — |
CanvasItemAddRect2 перегрузки
public static void CanvasItemAddRect(Rid item, Rect2 rect, Color color);Рисует прямоугольник на CanvasItem, на который указывает item Rid. См. также CanvasItem.DrawRect.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
rect | Rect2 | — |
color | Color | — |
public static void CanvasItemAddRect(Rid item, Rect2 rect, Color color, bool antialiased = false);Рисует прямоугольник на CanvasItem, на который указывает item Rid. См. также CanvasItem.DrawRect.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
rect | Rect2 | — |
color | Color | — |
antialiased | bool | false |
CanvasItemAddSetTransformvoid
public static void CanvasItemAddSetTransform(Rid item, Transform2D transform);Устанавливает Transform2D, который будет использоваться для преобразования последующих команд элемента холста.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
transform | Transform2D | — |
CanvasItemAddTextureRectvoid
public static void CanvasItemAddTextureRect(Rid item, Rect2 rect, Rid texture, bool tile = false, Color? modulate = default, bool transpose = false);Рисует 2D-текстурированный прямоугольник на CanvasItem, на который указывает item Rid. См. также CanvasItem.DrawTextureRect и Texture2D.DrawRect.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
rect | Rect2 | — |
texture | Rid | — |
tile | bool | false |
modulate | Color? | default |
transpose | bool | false |
modulateЕсли параметр не имеет значения, то значение по умолчанию: new Color(1.0f, 1.0f, 1.0f, 1.0f).
CanvasItemAddTextureRectRegionvoid
public static void CanvasItemAddTextureRectRegion(Rid item, Rect2 rect, Rid texture, Rect2 srcRect, Color? modulate = default, bool transpose = false, bool clipUV = true);Рисует указанную область 2D-текстурированного прямоугольника на CanvasItem, на который указывает item Rid. См. также CanvasItem.DrawTextureRectRegion и Texture2D.DrawRectRegion.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
rect | Rect2 | — |
texture | Rid | — |
srcRect | Rect2 | — |
modulate | Color? | default |
transpose | bool | false |
clipUV | bool | true |
modulateЕсли параметр не имеет значения, то значение по умолчанию: new Color(1.0f, 1.0f, 1.0f, 1.0f).
CanvasItemAddTriangleArray2 перегрузки
public static void CanvasItemAddTriangleArray(Rid item, int[] indices, Vector2[] points, Color[] colors, Vector2[] uvs = null, int[] bones = null, float[] weights = null, Rid texture = default, int count = -1);Рисует массив треугольников на CanvasItem, на который указывает item Rid. Он используется внутренне Line2D и StyleBoxFlat для рендеринга. RenderingServer.CanvasItemAddTriangleArray очень гибкий, но более сложный в использовании, чем RenderingServer.CanvasItemAddPolygon.
Примечание: Если count установлен на неотрицательное значение, будут нарисованы только первые count * 3 индексы (соответствующие [пропуск кода]count` треугольников). В противном случае нарисованы все индексы.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
indices | int[] | — |
points | Vector2[] | — |
colors | Color[] | — |
uvs | Vector2[] | null |
bones | int[] | null |
weights | float[] | null |
texture | Rid | default |
count | int | -1 |
uvsЕсли параметр не имеет значения, то значение по умолчанию: Array.Empty<Vector2>().
bonesЕсли параметр не имеет значения, то значение по умолчанию: Array.Empty<int>().
weightsЕсли параметр не имеет значения, то значение по умолчанию: Array.Empty<float>().
public static void CanvasItemAddTriangleArray(Rid item, ReadOnlySpan<int> indices, ReadOnlySpan<Vector2> points, ReadOnlySpan<Color> colors, ReadOnlySpan<Vector2> uvs, ReadOnlySpan<int> bones, ReadOnlySpan<float> weights, Rid texture, int count);Рисует массив треугольников на CanvasItem, на который указывает item Rid. Он используется внутренне Line2D и StyleBoxFlat для рендеринга. RenderingServer.CanvasItemAddTriangleArray очень гибкий, но более сложный в использовании, чем RenderingServer.CanvasItemAddPolygon.
Примечание: Если count установлен на неотрицательное значение, будут нарисованы только первые count * 3 индексы (соответствующие [пропуск кода]count` треугольников). В противном случае нарисованы все индексы.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
indices | ReadOnlySpan<int> | — |
points | ReadOnlySpan<Vector2> | — |
colors | ReadOnlySpan<Color> | — |
uvs | ReadOnlySpan<Vector2> | — |
bones | ReadOnlySpan<int> | — |
weights | ReadOnlySpan<float> | — |
texture | Rid | — |
count | int | — |
CanvasItemAttachSkeletonvoid
public static void CanvasItemAttachSkeleton(Rid item, Rid skeleton);Прикрепляет скелет к CanvasItem. Удаляет предыдущий скелет.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
skeleton | Rid | — |
CanvasItemClearvoid
public static void CanvasItemClear(Rid item);Очищает CanvasItem и удаляет все команды в нем.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
CanvasItemCreateRid
public static Rid CanvasItemCreate();Создает новый экземпляр CanvasItem и возвращает его Rid. К нему можно получить доступ с помощью возвращаемого RID. Этот RID будет использоваться во всех функциях canvas_item_* RenderingServer.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer.FreeRid RenderingServer.
Примечание: Эквивалентный узел — CanvasItem.
RidCanvasItemGetInstanceShaderParameterVariant
public static Variant CanvasItemGetInstanceShaderParameter(Rid instance, StringName parameter);Читает значение параметра из реестра экземпляра canvas item. Отсутствующая запись даёт Nil; возвращённое значение само по себе не доказывает, что имя объявлено текущим шейдером.
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
parameter | StringName | — |
instanceRID canvas item, например результат CanvasItem.GetCanvasItem().
parameterТочное имя instance uniform с учётом регистра.
VariantЗначение записи экземпляра либо Nil.
CanvasItemGetInstanceShaderParameterDefaultValueVariant
public static Variant CanvasItemGetInstanceShaderParameterDefaultValue(Rid instance, StringName parameter);Возвращает известное реестру экземпляра объявленное значение по умолчанию. До подготовки материалов или для отсутствующего имени может вернуть Nil; это не текущее переопределение.
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
parameter | StringName | — |
instanceRID canvas item, например результат CanvasItem.GetCanvasItem().
parameterТочное имя instance uniform с учётом регистра.
VariantОбъявленный default, известный реестру, либо Nil.
CanvasItemGetInstanceShaderParameterListReckfell.Collections.Array<Reckfell.Collections.Dictionary>
public static Reckfell.Collections.Array<Reckfell.Collections.Dictionary> CanvasItemGetInstanceShaderParameterList(Rid instance);Обновляет грязные canvas items и возвращает описания доступных параметров экземпляра. Это метаданные, не список глобальных параметров и не значения ShaderMaterial.
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
instanceRID canvas item, например результат CanvasItem.GetCanvasItem().
Reckfell.Collections.Array<Reckfell.Collections.Dictionary>Коллекция словарей метаданных параметров экземпляра.
CanvasItemResetPhysicsInterpolationvoid
public static void CanvasItemResetPhysicsInterpolation(Rid item);Предотвращает интерполяцию физики для текущего физического тика. Это полезно при перемещении элемента холста в новое место, чтобы обеспечить мгновенное изменение, а не интерполяцию из предыдущего места.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
CanvasItemSetCanvasGroupModevoid
public static void CanvasItemSetCanvasGroupMode(Rid item, RenderingServer.CanvasGroupMode mode, float clearMargin = 5f, bool fitEmpty = false, float fitMargin = 0f, bool blurMipmaps = false);Устанавливает режим группы холста, используемый во время 2D-рендеринга для элемента холста, указанного в item RID. Для более быстрой, но более ограниченной обрезки используйте RenderingServer.CanvasItemSetClip.
Примечание: Эквивалентная функциональность узла находится в CanvasGroup и CanvasItem.ClipChildren.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
mode | RenderingServer.CanvasGroupMode | — |
clearMargin | float | 5f |
fitEmpty | bool | false |
fitMargin | float | 0f |
blurMipmaps | bool | false |
CanvasItemSetClipvoid
public static void CanvasItemSetClip(Rid item, bool clip);Если clip равен true, элемент холста, указанный RID item, не будет рисовать ничего за пределами координат его прямоугольника. Это отсечение быстрое, но работает только с прямоугольниками, выровненными по осям. Это означает, что вращение игнорируется прямоугольником отсечения. Для более сложных форм отсечения используйте вместо этого RenderingServer.CanvasItemSetCanvasGroupMode.
Примечание: Эквивалентная функциональность узла находится в Label.ClipText, RichTextLabel (всегда включен) и других.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
clip | bool | — |
CanvasItemSetCopyToBackbuffervoid
public static void CanvasItemSetCopyToBackbuffer(Rid item, bool enabled, Rect2 rect);Устанавливает CanvasItem для копирования прямоугольника в фоновый буфер.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
enabled | bool | — |
rect | Rect2 | — |
CanvasItemSetCustomRectvoid
public static void CanvasItemSetCustomRect(Rid item, bool useCustomRect, Rect2? rect = default);Если use_custom_rect равен true, устанавливает пользовательский прямоугольник видимости (используемый для отбраковки) на rect для элемента холста, указанного item. Установка пользовательского прямоугольника видимости может снизить нагрузку на ЦП при рисовании большого количества 2D-экземпляров. Если use_custom_rect равен false, автоматически вычисляет прямоугольник видимости на основе команд рисования элемента холста.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
useCustomRect | bool | — |
rect | Rect2? | default |
rectЕсли параметр не имеет значения, то значение по умолчанию: new Rect2(new Vector2(0.0f, 0.0f), new Vector2(0.0f, 0.0f)).
CanvasItemSetDefaultTextureFiltervoid
public static void CanvasItemSetDefaultTextureFilter(Rid item, RenderingServer.CanvasItemTextureFilter filter);Устанавливает режим фильтра текстуры по умолчанию для элемента холста, указанного в item RID. Эквивалентно CanvasItem.TextureFilter.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
filter | RenderingServer.CanvasItemTextureFilter | — |
CanvasItemSetDefaultTextureRepeatvoid
public static void CanvasItemSetDefaultTextureRepeat(Rid item, RenderingServer.CanvasItemTextureRepeat repeat);Устанавливает режим повторения текстуры по умолчанию для элемента холста, указанного в item RID. Эквивалентно CanvasItem.TextureRepeat.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
repeat | RenderingServer.CanvasItemTextureRepeat | — |
CanvasItemSetDistanceFieldModevoid
public static void CanvasItemSetDistanceFieldMode(Rid item, bool enabled);Если enabled равно true, включает режим многоканальной визуализации поля расстояний со знаком для элемента холста, указанного в item RID. Это предназначено для использования при визуализации шрифтов или специально сгенерированных изображений с помощью msdfgen.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
enabled | bool | — |
CanvasItemSetDrawBehindParentvoid
public static void CanvasItemSetDrawBehindParent(Rid item, bool enabled);Если enabled равно true, рисует элемент холста, указанный RID item, позади его родителя. Эквивалентно CanvasItem.ShowBehindParent.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
enabled | bool | — |
CanvasItemSetDrawIndexvoid
public static void CanvasItemSetDrawIndex(Rid item, int index);Устанавливает индекс для CanvasItem.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
index | int | — |
CanvasItemSetInstanceShaderParametervoid
public static void CanvasItemSetInstanceShaderParameter(Rid instance, StringName parameter, Variant value);Записывает низкоуровневое значение параметра экземпляра canvas item. Для обычного сброса к объявленному default используйте CanvasItem.SetInstanceShaderParameter с Nil: метод уровня сцены сначала разрешает default. Значение Object этим реестром не поддерживается.
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
parameter | StringName | — |
value | Variant | — |
instanceRID canvas item, например результат CanvasItem.GetCanvasItem().
parameterТочное имя instance uniform с учётом регистра.
valueЗначение совместимого типа. Nil в override снимает его; низкоуровневый instance setter не заменяет сброс метода CanvasItem.
CanvasItemSetInterpolatedvoid
public static void CanvasItemSetInterpolated(Rid item, bool interpolated);Если interpolated равен true, включается интерполяция физики для элемента холста.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
interpolated | bool | — |
CanvasItemSetLightMaskvoid
public static void CanvasItemSetLightMask(Rid item, int mask);Устанавливает свет mask для элемента холста, указанного в item RID. Эквивалентно CanvasItem.LightMask.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
mask | int | — |
CanvasItemSetMaterialvoid
public static void CanvasItemSetMaterial(Rid item, Rid material);Устанавливает новый material для элемента холста, указанного в item RID. Эквивалентно CanvasItem.Material.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
material | Rid | — |
CanvasItemSetModulatevoid
public static void CanvasItemSetModulate(Rid item, Color color);Умножает цвет элемента холста, указанного RID item, влияя на его дочерние элементы. См. также RenderingServer.CanvasItemSetSelfModulate. Эквивалентно CanvasItem.Modulate.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
color | Color | — |
CanvasItemSetParentvoid
public static void CanvasItemSetParent(Rid item, Rid parent);Устанавливает родительский CanvasItem для CanvasItem. Элемент унаследует преобразование, модуляцию и видимость от своего родителя, как узлы CanvasItem в дереве сцены.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
parent | Rid | — |
CanvasItemSetSelfModulatevoid
public static void CanvasItemSetSelfModulate(Rid item, Color color);Умножает цвет элемента холста, указанного RID item, не влияя на его дочерние элементы. См. также RenderingServer.CanvasItemSetModulate. Эквивалентно CanvasItem.SelfModulate.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
color | Color | — |
CanvasItemSetSortChildrenByYvoid
public static void CanvasItemSetSortChildrenByY(Rid item, bool enabled);Если enabled равно true, дочерние узлы с самой низкой позицией Y рисуются перед узлами с более высокой позицией Y. Сортировка по Y влияет только на дочерние элементы, которые наследуются от элемента холста, указанного в item RID, а не на сам элемент холста. Эквивалентно CanvasItem.YSortEnabled.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
enabled | bool | — |
CanvasItemSetTransformvoid
public static void CanvasItemSetTransform(Rid item, Transform2D transform);Устанавливает transform элемента холста, указанного RID item. Это влияет на то, где и как будет нарисован элемент. Преобразования дочерних элементов холста умножаются на преобразование их родительского элемента. Эквивалентно Entity2D.Transform.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
transform | Transform2D | — |
CanvasItemSetUseParentMaterialvoid
public static void CanvasItemSetUseParentMaterial(Rid item, bool enabled);Устанавливает, использует ли CanvasItem материал своего родителя.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
enabled | bool | — |
CanvasItemSetVisibilityLayervoid
public static void CanvasItemSetVisibilityLayer(Rid item, uint visibilityLayer);Устанавливает слой видимости рендеринга, связанный с этим CanvasItem. Только узлы Viewport с соответствующей маской рендеринга будут рендерить этот CanvasItem.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
visibilityLayer | uint | — |
CanvasItemSetVisibilityNotifiervoid
public static void CanvasItemSetVisibilityNotifier(Rid item, bool enable, Rect2 area, Callable enterCallable, Callable exitCallable);Устанавливает заданный CanvasItem как уведомитель видимости. area определяет область обнаружения видимости. enter_callable вызывается, когда CanvasItem попадает на экран, exit_callable вызывается, когда CanvasItem покидает экран. Если enable равен false, элемент больше не будет функционировать как уведомитель.
Этот метод можно использовать для ручной имитации VisibleOnScreenNotifier2D.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
enable | bool | — |
area | Rect2 | — |
enterCallable | Callable | — |
exitCallable | Callable | — |
CanvasItemSetVisiblevoid
public static void CanvasItemSetVisible(Rid item, bool visible);Устанавливает видимость CanvasItem.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
visible | bool | — |
CanvasItemSetZAsRelativeToParentvoid
public static void CanvasItemSetZAsRelativeToParent(Rid item, bool enabled);Если эта опция включена, Z-индекс родителя будет добавлен к Z-индексу дочернего элемента.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
enabled | bool | — |
CanvasItemSetZIndexvoid
public static void CanvasItemSetZIndex(Rid item, int zIndex);Устанавливает индекс Z CanvasItem, т. е. порядок его отрисовки (меньшие индексы отрисовываются первыми).
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
zIndex | int | — |
CanvasItemTransformPhysicsInterpolationvoid
public static void CanvasItemTransformPhysicsInterpolation(Rid item, Transform2D transform);Преобразует как текущее, так и предыдущее сохраненное преобразование для элемента холста. Это позволяет преобразовывать элемент холста, не создавая «сбоев» в интерполяции, что особенно полезно для больших миров, использующих смещающееся начало координат.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
transform | Transform2D | — |
CanvasLightAttachToCanvasvoid
public static void CanvasLightAttachToCanvas(Rid light, Rid canvas);Прикрепляет подсветку холста к холсту. Удаляет ее с предыдущего холста.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
canvas | Rid | — |
CanvasLightCreateRid
public static Rid CanvasLightCreate();Создает источник света на холсте и добавляет его в RenderingServer. Доступ к нему можно получить с помощью возвращаемого RID. Этот RID будет использоваться во всех функциях RenderingServer canvas_light_*.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer RenderingServer.FreeRid.
Примечание: Эквивалентный узел — Light2D.
RidCanvasLightOccluderAttachToCanvasvoid
public static void CanvasLightOccluderAttachToCanvas(Rid occluder, Rid canvas);Прикрепляет к холсту светозащитный элемент. Удаляет его с предыдущего холста.
| Имя | Тип | По умолчанию |
|---|---|---|
occluder | Rid | — |
canvas | Rid | — |
CanvasLightOccluderCreateRid
public static Rid CanvasLightOccluderCreate();Создает световой окклюдер и добавляет его в RenderingServer. Доступ к нему можно получить с помощью возвращаемого RID. Этот RID будет использоваться во всех функциях RenderingServer canvas_light_occluder_*.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer RenderingServer.FreeRid.
Примечание: Эквивалентный узел — LightOccluder2D.
RidCanvasLightOccluderResetPhysicsInterpolationvoid
public static void CanvasLightOccluderResetPhysicsInterpolation(Rid occluder);Предотвращает интерполяцию физики для текущего физического тика. Это полезно при перемещении окклюдера в новое место, чтобы обеспечить мгновенное изменение, а не интерполяцию из предыдущего места.
| Имя | Тип | По умолчанию |
|---|---|---|
occluder | Rid | — |
CanvasLightOccluderSetAsSdfCollisionvoid
public static void CanvasLightOccluderSetAsSdfCollision(Rid occluder, bool enable);Включает или отключает использование световой окклюдер элемента в качестве поля знакового расстояния для столкновений 2D частиц.
| Имя | Тип | По умолчанию |
|---|---|---|
occluder | Rid | — |
enable | bool | — |
CanvasLightOccluderSetEnabledvoid
public static void CanvasLightOccluderSetEnabled(Rid occluder, bool enabled);Включает или выключает светозащитный экран.
| Имя | Тип | По умолчанию |
|---|---|---|
occluder | Rid | — |
enabled | bool | — |
CanvasLightOccluderSetInterpolatedvoid
public static void CanvasLightOccluderSetInterpolated(Rid occluder, bool interpolated);Если interpolated равен true, включается физическая интерполяция для светового окклюдера.
| Имя | Тип | По умолчанию |
|---|---|---|
occluder | Rid | — |
interpolated | bool | — |
CanvasLightOccluderSetLightMaskvoid
public static void CanvasLightOccluderSetLightMask(Rid occluder, int mask);Световая маска. Более подробную информацию о световых масках см. в LightOccluder2D.
| Имя | Тип | По умолчанию |
|---|---|---|
occluder | Rid | — |
mask | int | — |
CanvasLightOccluderSetPolygonvoid
public static void CanvasLightOccluderSetPolygon(Rid occluder, Rid polygon);Устанавливает полигон окклюдера света.
| Имя | Тип | По умолчанию |
|---|---|---|
occluder | Rid | — |
polygon | Rid | — |
CanvasLightOccluderSetTransformvoid
public static void CanvasLightOccluderSetTransform(Rid occluder, Transform2D transform);Устанавливает Transform2D светового окклюдера.
| Имя | Тип | По умолчанию |
|---|---|---|
occluder | Rid | — |
transform | Transform2D | — |
CanvasLightOccluderTransformPhysicsInterpolationvoid
public static void CanvasLightOccluderTransformPhysicsInterpolation(Rid occluder, Transform2D transform);Преобразует как текущее, так и предыдущее сохраненное преобразование для светового окклюдера. Это позволяет преобразовывать окклюдер, не создавая «сбоев» в интерполяции, что особенно полезно для больших миров, использующих смещающееся начало координат.
| Имя | Тип | По умолчанию |
|---|---|---|
occluder | Rid | — |
transform | Transform2D | — |
CanvasLightResetPhysicsInterpolationvoid
public static void CanvasLightResetPhysicsInterpolation(Rid light);Предотвращает интерполяцию физики для текущего физического тика. Это полезно при перемещении элемента холста в новое место, чтобы обеспечить мгновенное изменение, а не интерполяцию из предыдущего места.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
CanvasLightSetBlendModevoid
public static void CanvasLightSetBlendMode(Rid light, RenderingServer.CanvasLightBlendMode mode);Устанавливает режим смешивания для данного источника света на холсте на mode. Эквивалентно Light2D.BlendMode.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
mode | RenderingServer.CanvasLightBlendMode | — |
CanvasLightSetColorvoid
public static void CanvasLightSetColor(Rid light, Color color);Устанавливает цвет света.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
color | Color | — |
CanvasLightSetEnabledvoid
public static void CanvasLightSetEnabled(Rid light, bool enabled);Включает или выключает подсветку холста.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
enabled | bool | — |
CanvasLightSetEnergyvoid
public static void CanvasLightSetEnergy(Rid light, float energy);Устанавливает энергию полотняного светильника.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
energy | float | — |
CanvasLightSetHeightvoid
public static void CanvasLightSetHeight(Rid light, float height);Устанавливает высоту холста-светильника.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
height | float | — |
CanvasLightSetInterpolatedvoid
public static void CanvasLightSetInterpolated(Rid light, bool interpolated);Если interpolated равен true, включается физическая интерполяция для источника света на холсте.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
interpolated | bool | — |
CanvasLightSetItemCullMaskvoid
public static void CanvasLightSetItemCullMask(Rid light, int mask);Световая маска. Более подробную информацию о световых масках см. в LightOccluder2D.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
mask | int | — |
CanvasLightSetItemShadowCullMaskvoid
public static void CanvasLightSetItemShadowCullMask(Rid light, int mask);Двоичная маска, используемая для определения того, на какие слои влияют тени этого источника света. См. LightOccluder2D для получения дополнительной информации о масках света.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
mask | int | — |
CanvasLightSetLayerRangevoid
public static void CanvasLightSetLayerRange(Rid light, int minLayer, int maxLayer);Диапазон слоев, который визуализируется с помощью этого источника света.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
minLayer | int | — |
maxLayer | int | — |
CanvasLightSetModevoid
public static void CanvasLightSetMode(Rid light, RenderingServer.CanvasLightMode mode);Устанавливает режим light холста.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
mode | RenderingServer.CanvasLightMode | — |
CanvasLightSetShadowColorvoid
public static void CanvasLightSetShadowColor(Rid light, Color color);Устанавливает цвет тени источника света на холсте.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
color | Color | — |
CanvasLightSetShadowEnabledvoid
public static void CanvasLightSetShadowEnabled(Rid light, bool enabled);Включает или отключает тень от источника света на холсте.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
enabled | bool | — |
CanvasLightSetShadowFiltervoid
public static void CanvasLightSetShadowFilter(Rid light, RenderingServer.CanvasLightShadowFilter filter);Устанавливает фильтр тени света холста.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
filter | RenderingServer.CanvasLightShadowFilter | — |
CanvasLightSetShadowSmoothvoid
public static void CanvasLightSetShadowSmooth(Rid light, float smooth);Сглаживает тень. Чем ниже, тем глаже.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
smooth | float | — |
CanvasLightSetTexturevoid
public static void CanvasLightSetTexture(Rid light, Rid texture);Устанавливает текстуру, используемую PointLight2D. Эквивалентно PointLight2D.Texture.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
texture | Rid | — |
CanvasLightSetTextureOffsetvoid
public static void CanvasLightSetTextureOffset(Rid light, Vector2 offset);Устанавливает смещение текстуры PointLight2D. Эквивалентно PointLight2D.Offset.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
offset | Vector2 | — |
CanvasLightSetTextureScalevoid
public static void CanvasLightSetTextureScale(Rid light, float scale);Устанавливает масштабный коэффициент текстуры PointLight2D. Эквивалентно PointLight2D.TextureScale.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
scale | float | — |
CanvasLightSetTransformvoid
public static void CanvasLightSetTransform(Rid light, Transform2D transform);Устанавливает Transform2D источника света на холсте.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
transform | Transform2D | — |
CanvasLightSetZRangevoid
public static void CanvasLightSetZRange(Rid light, int minZ, int maxZ);Устанавливает диапазон Z объектов, на которые будет воздействовать этот свет. Эквивалентно Light2D.RangeZMin и Light2D.RangeZMax.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
minZ | int | — |
maxZ | int | — |
CanvasLightTransformPhysicsInterpolationvoid
public static void CanvasLightTransformPhysicsInterpolation(Rid light, Transform2D transform);Преобразует как текущее, так и предыдущее сохраненное преобразование для источника света на холсте. Это позволяет преобразовывать источник света, не создавая «сбоев» в интерполяции, что особенно полезно для больших миров, использующих смещающееся начало координат.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
transform | Transform2D | — |
CanvasOccluderPolygonCreateRid
public static Rid CanvasOccluderPolygonCreate();Создает новый многоугольник окклюдера света и добавляет его в RenderingServer. К нему можно получить доступ с помощью возвращаемого RID. Этот RID будет использоваться во всех функциях RenderingServer canvas_occluder_polygon_*.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer RenderingServer.FreeRid.
Примечание: Эквивалентный ресурс — OccluderPolygon2D.
RidCanvasOccluderPolygonSetCullModevoid
public static void CanvasOccluderPolygonSetCullMode(Rid occluderPolygon, RenderingServer.CanvasOccluderPolygonCullMode mode);Устанавливает режим отбраковки полигона окклюдера.
| Имя | Тип | По умолчанию |
|---|---|---|
occluderPolygon | Rid | — |
mode | RenderingServer.CanvasOccluderPolygonCullMode | — |
CanvasOccluderPolygonSetShape2 перегрузки
public static void CanvasOccluderPolygonSetShape(Rid occluderPolygon, Vector2[] shape, bool closed);Задает форму многоугольника окклюдера.
| Имя | Тип | По умолчанию |
|---|---|---|
occluderPolygon | Rid | — |
shape | Vector2[] | — |
closed | bool | — |
public static void CanvasOccluderPolygonSetShape(Rid occluderPolygon, ReadOnlySpan<Vector2> shape, bool closed);Задает форму многоугольника окклюдера.
| Имя | Тип | По умолчанию |
|---|---|---|
occluderPolygon | Rid | — |
shape | ReadOnlySpan<Vector2> | — |
closed | bool | — |
CanvasSetDisableScalevoid
public static void CanvasSetDisableScale(bool disable);Если disable имеет значение true, 2D-рендеринг игнорирует масштаб холста, определенный для каждого слоя холста. Это влияет на CanvasLayer со свойством CanvasLayer.FollowViewportEnabled, установленным в true.
В редакторе по умолчанию это значение установлено в true, а при включении Вид > Предварительный просмотр масштаба холста в верхней части окна просмотра 2D-редактора устанавливается в false.
Примечание: Установка этого значения в true не влияет на поведение CanvasLayer.Scale, Entity2D.Scale или Control.Scale.
| Имя | Тип | По умолчанию |
|---|---|---|
disable | bool | — |
CanvasSetItemMirroringvoid
public static void CanvasSetItemMirroring(Rid canvas, Rid item, Vector2 mirroring);Копия элемента холста будет нарисована с локальным смещением mirroring.
Примечание: Это эквивалентно вызову RenderingServer.CanvasSetItemRepeat как canvas_set_item_repeat(item, mirroring, 1), с дополнительной проверкой, гарантирующей, что canvas является родителем item.
| Имя | Тип | По умолчанию |
|---|---|---|
canvas | Rid | — |
item | Rid | — |
mirroring | Vector2 | — |
CanvasSetItemRepeatvoid
public static void CanvasSetItemRepeat(Rid item, Vector2 repeatSize, int repeatTimes);Копия элемента холста будет нарисована с локальным смещением repeat_size на количество раз repeat_times. По мере увеличения repeat_times копии будут расходиться от исходной текстуры.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
repeatSize | Vector2 | — |
repeatTimes | int | — |
CanvasSetModulatevoid
public static void CanvasSetModulate(Rid canvas, Color color);Модулирует все цвета на заданном холсте.
| Имя | Тип | По умолчанию |
|---|---|---|
canvas | Rid | — |
color | Color | — |
CanvasSetShadowTextureSizevoid
public static void CanvasSetShadowTextureSize(int size);Устанавливает ProjectSettings.rendering/2d/shadow_atlas/size для использования при рендеринге тени Light2D (в пикселях). Значение округляется до ближайшей степени 2.
| Имя | Тип | По умолчанию |
|---|---|---|
size | int | — |
CanvasTextureCreateRid
public static Rid CanvasTextureCreate();Создает текстуру холста и добавляет ее в RenderingServer. Доступ к ней можно получить с помощью возвращаемого RID. Этот RID будет использоваться во всех функциях RenderingServer canvas_texture_*.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer RenderingServer.FreeRid. См. также RenderingServer.Texture2DCreate.
Примечание: Эквивалентный ресурс — CanvasTexture, и он предназначен только для использования в 2D-рендеринге, а не в 3D.
RidCanvasTextureSetChannelvoid
public static void CanvasTextureSetChannel(Rid canvasTexture, RenderingServer.CanvasTextureChannel channel, Rid texture);Устанавливает channel's texture для холстовой текстуры, указанной canvas_texture RID. Эквивалентность CanvasTexture.DiffuseTexture, CanvasTexture.NormalTexture и CanvasTexture.SpecularTexture.
| Имя | Тип | По умолчанию |
|---|---|---|
canvasTexture | Rid | — |
channel | RenderingServer.CanvasTextureChannel | — |
texture | Rid | — |
CanvasTextureSetShadingParametersvoid
public static void CanvasTextureSetShadingParameters(Rid canvasTexture, Color baseColor, float shininess);Устанавливает base_color и shininess для использования в текстуре холста, указанной в canvas_texture RID. Эквивалентно CanvasTexture.SpecularColor и CanvasTexture.SpecularShininess.
| Имя | Тип | По умолчанию |
|---|---|---|
canvasTexture | Rid | — |
baseColor | Color | — |
shininess | float | — |
CanvasTextureSetTextureFiltervoid
public static void CanvasTextureSetTextureFilter(Rid canvasTexture, RenderingServer.CanvasItemTextureFilter filter);Устанавливает режим текстуры filter, который будет использоваться для текстуры холста, указанной в RID canvas_texture.
| Имя | Тип | По умолчанию |
|---|---|---|
canvasTexture | Rid | — |
filter | RenderingServer.CanvasItemTextureFilter | — |
CanvasTextureSetTextureRepeatvoid
public static void CanvasTextureSetTextureRepeat(Rid canvasTexture, RenderingServer.CanvasItemTextureRepeat repeat);Устанавливает режим текстуры repeat, который будет использоваться для текстуры холста, указанной в RID canvas_texture.
| Имя | Тип | По умолчанию |
|---|---|---|
canvasTexture | Rid | — |
repeat | RenderingServer.CanvasItemTextureRepeat | — |
CompositorCreateRid
public static Rid CompositorCreate();Создает новый композитор и добавляет его в RenderingServer. К нему можно получить доступ с помощью возвращаемого RID.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer.FreeRid RenderingServer.
RidCompositorEffectCreateRid
public static Rid CompositorEffectCreate();Создает новый эффект рендеринга и добавляет его в RenderingServer. К нему можно получить доступ с помощью возвращаемого RID.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer.FreeRid RenderingServer.
RidCompositorEffectSetCallbackvoid
public static void CompositorEffectSetCallback(Rid effect, RenderingServer.CompositorEffectCallbackType callbackType, Callable callback);Устанавливает тип обратного вызова (callback_type) и метод обратного вызова (callback) для этого эффекта рендеринга.
| Имя | Тип | По умолчанию |
|---|---|---|
effect | Rid | — |
callbackType | RenderingServer.CompositorEffectCallbackType | — |
callback | Callable | — |
CompositorEffectSetEnabledvoid
public static void CompositorEffectSetEnabled(Rid effect, bool enabled);Включает/отключает этот эффект рендеринга.
| Имя | Тип | По умолчанию |
|---|---|---|
effect | Rid | — |
enabled | bool | — |
CompositorEffectSetFlagvoid
public static void CompositorEffectSetFlag(Rid effect, RenderingServer.CompositorEffectFlags flag, bool set);Устанавливает флаг (flag) для этого эффекта рендеринга на true или false (set).
| Имя | Тип | По умолчанию |
|---|---|---|
effect | Rid | — |
flag | RenderingServer.CompositorEffectFlags | — |
set | bool | — |
CompositorSetCompositorEffectsvoid
public static void CompositorSetCompositorEffects(Rid compositor, Reckfell.Collections.Array<Rid> effects);Устанавливает эффект композитора для указанного композитора RID. effects должна быть массивом, содержащим МПОГ, RenderingServer.CompositorEffectCreate.
| Имя | Тип | По умолчанию |
|---|---|---|
compositor | Rid | — |
effects | Reckfell.Collections.Array<Rid> | — |
CreateLocalRenderingDeviceRenderingDevice
public static RenderingDevice CreateLocalRenderingDevice();Создает RenderingDevice, который можно использовать для выполнения операций рисования и вычисления в отдельном потоке. Не может рисовать на экране или обмениваться данными с глобальным RenderingDevice.
Примечание: При использовании драйвера рендеринга OpenGL или при работе в режиме headless эта функция всегда возвращает null.
RenderingDeviceDebugCanvasItemGetRectRect2
public static Rect2 DebugCanvasItemGetRect(Rid item);Возвращает ограничивающий прямоугольник для элемента холста в локальном пространстве, рассчитанный рендерером. Эта граница используется внутренне для отбраковки.
Предупреждение: Эта функция предназначена для отладки в редакторе и будет проходить и возвращать ноль Rect2 в экспортированных проектах.
| Имя | Тип | По умолчанию |
|---|---|---|
item | Rid | — |
Rect2DecalCreateRid
public static Rid DecalCreate();Создает декаль и добавляет ее в RenderingServer. Доступ к ней можно получить с помощью возвращаемого RID. Этот RID будет использоваться во всех функциях RenderingServer decal_*.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer RenderingServer.FreeRid.
Чтобы разместить на сцене, прикрепите эту декаль к экземпляру с помощью RenderingServer.InstanceSetBase, используя возвращаемый RID.
Примечание: Эквивалентный узел — Decal.
RidDecalSetAlbedoMixvoid
public static void DecalSetAlbedoMix(Rid decal, float albedoMix);Устанавливает albedo_mix в декале, указанном decal RID. Эквивалентно Decal.AlbedoMix.
| Имя | Тип | По умолчанию |
|---|---|---|
decal | Rid | — |
albedoMix | float | — |
DecalSetCullMaskvoid
public static void DecalSetCullMask(Rid decal, uint mask);Устанавливает отбраковку mask в декале, указанном decal RID. Эквивалентно Decal.CullMask.
| Имя | Тип | По умолчанию |
|---|---|---|
decal | Rid | — |
mask | uint | — |
DecalSetDistanceFadevoid
public static void DecalSetDistanceFade(Rid decal, bool enabled, float begin, float length);Устанавливает параметры затухания расстояния в декале, указанном в decal RID. Эквивалентно Decal.DistanceFadeEnabled, Decal.DistanceFadeBegin и Decal.DistanceFadeLength.
| Имя | Тип | По умолчанию |
|---|---|---|
decal | Rid | — |
enabled | bool | — |
begin | float | — |
length | float | — |
DecalSetEmissionEnergyvoid
public static void DecalSetEmissionEnergy(Rid decal, float energy);Устанавливает эмиссию energy в наклейке, указанной decal RID. Эквивалентно Decal.EmissionEnergy.
| Имя | Тип | По умолчанию |
|---|---|---|
decal | Rid | — |
energy | float | — |
DecalSetFadevoid
public static void DecalSetFade(Rid decal, float above, float below);Устанавливает верхний затухание (above) и нижний затухание (below) в декале, указанном в decal RID. Эквивалентно Decal.UpperFade и Decal.LowerFade.
| Имя | Тип | По умолчанию |
|---|---|---|
decal | Rid | — |
above | float | — |
below | float | — |
DecalSetModulatevoid
public static void DecalSetModulate(Rid decal, Color color);Устанавливает множитель цвета в декале, указанный в decal RID, на color. Эквивалентно Decal.Modulate.
| Имя | Тип | По умолчанию |
|---|---|---|
decal | Rid | — |
color | Color | — |
DecalSetNormalFadevoid
public static void DecalSetNormalFade(Rid decal, float fade);Устанавливает нормальный fade в декале, указанном decal RID. Эквивалентно Decal.NormalFade.
| Имя | Тип | По умолчанию |
|---|---|---|
decal | Rid | — |
fade | float | — |
DecalSetSizevoid
public static void DecalSetSize(Rid decal, Vector3 size);Устанавливает size декали, указанный в decal RID. Эквивалентно Decal.Size.
| Имя | Тип | По умолчанию |
|---|---|---|
decal | Rid | — |
size | Vector3 | — |
DecalSetTexturevoid
public static void DecalSetTexture(Rid decal, RenderingServer.DecalTexture type, Rid texture);Устанавливает texture в указанном слоте текстуры type для указанной декали. Эквивалентно Decal.SetTexture.
| Имя | Тип | По умолчанию |
|---|---|---|
decal | Rid | — |
type | RenderingServer.DecalTexture | — |
texture | Rid | — |
DecalsSetFiltervoid
public static void DecalsSetFilter(RenderingServer.DecalFilter filter);Устанавливает режим текстуры filter для использования при рендеринге декалей. Этот параметр является глобальным и не может быть установлен для каждой декали.
| Имя | Тип | По умолчанию |
|---|---|---|
filter | RenderingServer.DecalFilter | — |
DirectionalLightCreateRid
public static Rid DirectionalLightCreate();Создает направленный свет и добавляет его в RenderingServer. Доступ к нему можно получить с помощью возвращаемого RID. Этот RID можно использовать в большинстве функций RenderingServer light_*.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer RenderingServer.FreeRid.
Чтобы разместить в сцене, прикрепите этот направленный свет к экземпляру с помощью RenderingServer.InstanceSetBase, используя возвращаемый RID.
Примечание: Эквивалентный узел — DirectionalLight3D.
RidDirectionalShadowAtlasSetSizevoid
public static void DirectionalShadowAtlasSetSize(int size, bool is16Bits);Устанавливает size направленных световых теней в 3D. См. также ProjectSettings.rendering/lights_and_shadows/directional_shadow/size. Этот параметр является глобальным и не может быть установлен для каждого окна просмотра.
| Имя | Тип | По умолчанию |
|---|---|---|
size | int | — |
is16Bits | bool | — |
DirectionalSoftShadowFilterSetQualityvoid
public static void DirectionalSoftShadowFilterSetQuality(RenderingServer.ShadowQuality quality);Устанавливает фильтр quality для направленных световых теней в 3D. См. также ProjectSettings.rendering/lights_and_shadows/directional_shadow/soft_shadow_filter_quality. Этот параметр является глобальным и не может быть установлен для каждого окна просмотра.
| Имя | Тип | По умолчанию |
|---|---|---|
quality | RenderingServer.ShadowQuality | — |
EnvironmentBakePanoramaImage
public static Image EnvironmentBakePanorama(Rid environment, bool bakeIrradiance, Vector2I size);Генерирует и возвращает Image, содержащий карту сияния для указанного environment RID неба. Это поддерживает встроенный материал неба и пользовательские шейдеры неба. Если bake_irradiance имеет значение true, карта сияния сохраняется вместо карты сияния. Карта сияния используется для рендеринга отражённого света, а карта сияния используется для рендеринга окружающего света. Рекомендуется ознакомиться также с RenderingServer.SkyBakePanorama.
Примечание: Изображение сохраняется в линейном цветовом пространстве без выполнения тональной компрессии, что означает, что оно будет выглядеть слишком темным при просмотре напрямую в редакторе изображений.
Примечание: size должен иметь соотношение сторон 2:1, чтобы сгенерированная панорама имела квадратные пиксели. Для карт сияния нет смысла использовать высоту больше, чем Sky.RadianceSize, так как это не увеличит детализацию. Карты освещённости содержат только низкочастотные данные, поэтому обычно нет смысла выходить за пределы размера 128×64 пикселей при сохранении карты освещённости.
| Имя | Тип | По умолчанию |
|---|---|---|
environment | Rid | — |
bakeIrradiance | bool | — |
size | Vector2I | — |
ImageEnvironmentCreateRid
public static Rid EnvironmentCreate();Создает среду и добавляет ее в RenderingServer. Доступ к ней можно получить с помощью возвращаемого RID. Этот RID будет использоваться во всех функциях environment_* RenderingServer.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer.FreeRid RenderingServer.
Примечание: Эквивалентный ресурс — Environment.
RidEnvironmentGlowSetUseBicubicUpscalevoid
public static void EnvironmentGlowSetUseBicubicUpscale(bool enable);Если enable имеет значение true, включается бикубический upscaling для свечения, что улучшает качество за счет производительности. Эквивалентно ProjectSettings.rendering/environment/glow/upscale_mode.
Примечание: Этот параметр эффективен только при использовании методов рендеринга Forward+ или Mobile, так как Compatibility использует другую реализацию свечения.
| Имя | Тип | По умолчанию |
|---|---|---|
enable | bool | — |
EnvironmentSetAdjustmentvoid
public static void EnvironmentSetAdjustment(Rid env, bool enable, float brightness, float contrast, float saturation, bool use1DColorCorrection, Rid colorCorrection);Устанавливает значения, которые будут использоваться с эффектом постобработки "adjustments". Подробнее см. Environment.
| Имя | Тип | По умолчанию |
|---|---|---|
env | Rid | — |
enable | bool | — |
brightness | float | — |
contrast | float | — |
saturation | float | — |
use1DColorCorrection | bool | — |
colorCorrection | Rid | — |
EnvironmentSetAmbientLightvoid
public static void EnvironmentSetAmbientLight(Rid env, Color color, RenderingServer.EnvironmentAmbientSource ambient = RenderingServer.EnvironmentAmbientSource.Bg, float energy = 1f, float skyContribution = 0f, RenderingServer.EnvironmentReflectionSource reflectionSource = RenderingServer.EnvironmentReflectionSource.Bg);Устанавливает значения, которые будут использоваться для рендеринга окружающего освещения. Подробнее см. в Environment.
| Имя | Тип | По умолчанию |
|---|---|---|
env | Rid | — |
color | Color | — |
ambient | RenderingServer.EnvironmentAmbientSource | RenderingServer.EnvironmentAmbientSource.Bg |
energy | float | 1f |
skyContribution | float | 0f |
reflectionSource | RenderingServer.EnvironmentReflectionSource | RenderingServer.EnvironmentReflectionSource.Bg |
EnvironmentSetBackgroundvoid
public static void EnvironmentSetBackground(Rid env, RenderingServer.EnvironmentBG bg);Устанавливает фоновый режим среды. Эквивалентно Environment.BackgroundMode.
| Имя | Тип | По умолчанию |
|---|---|---|
env | Rid | — |
bg | RenderingServer.EnvironmentBG | — |
EnvironmentSetBgColorvoid
public static void EnvironmentSetBgColor(Rid env, Color color);Color - отображается для прозрачных участков сцены. RenderingServer.EnvironmentBG.Color фоновый режим.
| Имя | Тип | По умолчанию |
|---|---|---|
env | Rid | — |
color | Color | — |
EnvironmentSetBgEnergyvoid
public static void EnvironmentSetBgEnergy(Rid env, float multiplier, float exposureValue);Устанавливает интенсивность цвета фона.
| Имя | Тип | По умолчанию |
|---|---|---|
env | Rid | — |
multiplier | float | — |
exposureValue | float | — |
EnvironmentSetCameraIdvoid
public static void EnvironmentSetCameraId(Rid env, int id);Устанавливает идентификатор камеры, который будет использоваться в качестве фона среды.
| Имя | Тип | По умолчанию |
|---|---|---|
env | Rid | — |
id | int | — |
EnvironmentSetCanvasMaxLayervoid
public static void EnvironmentSetCanvasMaxLayer(Rid env, int maxLayer);Устанавливает максимальный слой, который будет использоваться при использовании режима фона Canvas.
| Имя | Тип | По умолчанию |
|---|---|---|
env | Rid | — |
maxLayer | int | — |
EnvironmentSetFog2 перегрузки
public static void EnvironmentSetFog(Rid env, bool enable, Color lightColor, float lightEnergy, float sunScatter, float density, float height, float heightDensity, float aerialPerspective, float skyAffect);Настраивает туман для указанного RID среды. См. свойства fog_* в Environment для получения дополнительной информации.
| Имя | Тип | По умолчанию |
|---|---|---|
env | Rid | — |
enable | bool | — |
lightColor | Color | — |
lightEnergy | float | — |
sunScatter | float | — |
density | float | — |
height | float | — |
heightDensity | float | — |
aerialPerspective | float | — |
skyAffect | float | — |
public static void EnvironmentSetFog(Rid env, bool enable, Color lightColor, float lightEnergy, float sunScatter, float density, float height, float heightDensity, float aerialPerspective, float skyAffect, RenderingServer.EnvironmentFogMode fogMode = RenderingServer.EnvironmentFogMode.Exponential);Настраивает туман для указанного RID среды. См. свойства fog_* в Environment для получения дополнительной информации.
| Имя | Тип | По умолчанию |
|---|---|---|
env | Rid | — |
enable | bool | — |
lightColor | Color | — |
lightEnergy | float | — |
sunScatter | float | — |
density | float | — |
height | float | — |
heightDensity | float | — |
aerialPerspective | float | — |
skyAffect | float | — |
fogMode | RenderingServer.EnvironmentFogMode | RenderingServer.EnvironmentFogMode.Exponential |
EnvironmentSetFogDepthvoid
public static void EnvironmentSetFogDepth(Rid env, float curve, float begin, float end);Настраивает глубину тумана для указанного RID среды. Действует только тогда, когда режим тумана среды равен RenderingServer.EnvironmentFogMode.Depth. Для получения дополнительной информации см. свойства fog_depth_* в Environment.
| Имя | Тип | По умолчанию |
|---|---|---|
env | Rid | — |
curve | float | — |
begin | float | — |
end | float | — |
EnvironmentSetGlow2 перегрузки
public static void EnvironmentSetGlow(Rid env, bool enable, ReadOnlySpan<float> levels, float intensity, float strength, float mix, float bloomThreshold, RenderingServer.EnvironmentGlowBlendMode blendMode, float hdrBleedThreshold, float hdrBleedScale, float hdrLuminanceCap, float glowMapStrength, Rid glowMap);Настраивает свечение для указанного RID среды. См. свойства glow_* в Environment для получения дополнительной информации.
| Имя | Тип | По умолчанию |
|---|---|---|
env | Rid | — |
enable | bool | — |
levels | ReadOnlySpan<float> | — |
intensity | float | — |
strength | float | — |
mix | float | — |
bloomThreshold | float | — |
blendMode | RenderingServer.EnvironmentGlowBlendMode | — |
hdrBleedThreshold | float | — |
hdrBleedScale | float | — |
hdrLuminanceCap | float | — |
glowMapStrength | float | — |
glowMap | Rid | — |
public static void EnvironmentSetGlow(Rid env, bool enable, float[] levels, float intensity, float strength, float mix, float bloomThreshold, RenderingServer.EnvironmentGlowBlendMode blendMode, float hdrBleedThreshold, float hdrBleedScale, float hdrLuminanceCap, float glowMapStrength, Rid glowMap);Настраивает свечение для указанного RID среды. См. свойства glow_* в Environment для получения дополнительной информации.
| Имя | Тип | По умолчанию |
|---|---|---|
env | Rid | — |
enable | bool | — |
levels | float[] | — |
intensity | float | — |
strength | float | — |
mix | float | — |
bloomThreshold | float | — |
blendMode | RenderingServer.EnvironmentGlowBlendMode | — |
hdrBleedThreshold | float | — |
hdrBleedScale | float | — |
hdrLuminanceCap | float | — |
glowMapStrength | float | — |
glowMap | Rid | — |
EnvironmentSetSdfgivoid
public static void EnvironmentSetSdfgi(Rid env, bool enable, int cascades, float minCellSize, RenderingServer.EnvironmentSdfgiyScale yScale, bool useOcclusion, float bounceFeedback, bool readSky, float energy, float normalBias, float probeBias);Настраивает глобальное освещение поля расстояний со знаком для указанного RID окружения. Для получения дополнительной информации см. свойства sdfgi_* в Environment.
| Имя | Тип | По умолчанию |
|---|---|---|
env | Rid | — |
enable | bool | — |
cascades | int | — |
minCellSize | float | — |
yScale | RenderingServer.EnvironmentSdfgiyScale | — |
useOcclusion | bool | — |
bounceFeedback | float | — |
readSky | bool | — |
energy | float | — |
normalBias | float | — |
probeBias | float | — |
EnvironmentSetSdfgiFramesToConvergevoid
public static void EnvironmentSetSdfgiFramesToConverge(RenderingServer.EnvironmentSdfgiFramesToConverge frames);Устанавливает количество кадров, используемых для сходящегося знакового поля расстояний глобального освещения. Эквивалентно ProjectSettings.rendering/global_illumination/sdfgi/frames_to_converge.
| Имя | Тип | По умолчанию |
|---|---|---|
frames | RenderingServer.EnvironmentSdfgiFramesToConverge | — |
EnvironmentSetSdfgiFramesToUpdateLightvoid
public static void EnvironmentSetSdfgiFramesToUpdateLight(RenderingServer.EnvironmentSdfgiFramesToUpdateLight frames);Устанавливает скорость обновления для непрямого освещения динамических источников света при вычислении глобального освещения поля расстояний со знаком. Эквивалентно ProjectSettings.rendering/global_illumination/sdfgi/frames_to_update_lights.
| Имя | Тип | По умолчанию |
|---|---|---|
frames | RenderingServer.EnvironmentSdfgiFramesToUpdateLight | — |
EnvironmentSetSdfgiRayCountvoid
public static void EnvironmentSetSdfgiRayCount(RenderingServer.EnvironmentSdfgiRayCount rayCount);Устанавливает количество лучей для каждого рамы при вычислении подписанного расстояния глобального освещения. ProjectSettings.rendering/global_illumination/sdfgi/probe_ray_count.
| Имя | Тип | По умолчанию |
|---|---|---|
rayCount | RenderingServer.EnvironmentSdfgiRayCount | — |
EnvironmentSetSkyvoid
public static void EnvironmentSetSky(Rid env, Rid sky);Устанавливает Sky для использования в качестве фона окружающей среды при использовании неба BGMode. Эквивалентно Environment.Sky.
| Имя | Тип | По умолчанию |
|---|---|---|
env | Rid | — |
sky | Rid | — |
EnvironmentSetSkyCustomFovvoid
public static void EnvironmentSetSkyCustomFov(Rid env, float scale);Устанавливает пользовательское поле зрения для фона Sky. Эквивалентно Environment.SkyCustomFov.
| Имя | Тип | По умолчанию |
|---|---|---|
env | Rid | — |
scale | float | — |
EnvironmentSetSkyOrientationvoid
public static void EnvironmentSetSkyOrientation(Rid env, Basis orientation);Устанавливает вращение фона Sky, выраженное как Basis. Эквивалентно Environment.SkyRotation, где вектор вращения используется для построения Basis.
| Имя | Тип | По умолчанию |
|---|---|---|
env | Rid | — |
orientation | Basis | — |
EnvironmentSetSsaovoid
public static void EnvironmentSetSsao(Rid env, bool enable, float radius, float intensity, float power, float detail, float horizon, float sharpness, float lightAffect, float aOChannelAffect);Устанавливает переменные, которые будут использоваться с эффектом постобработки экранного пространства окружающего света (SSAO). Подробнее см. Environment.
| Имя | Тип | По умолчанию |
|---|---|---|
env | Rid | — |
enable | bool | — |
radius | float | — |
intensity | float | — |
power | float | — |
detail | float | — |
horizon | float | — |
sharpness | float | — |
lightAffect | float | — |
aOChannelAffect | float | — |
EnvironmentSetSsaoQualityvoid
public static void EnvironmentSetSsaoQuality(RenderingServer.EnvironmentSsaoQuality quality, bool halfSize, float adaptiveTarget, int blurPasses, float fadeOutFrom, float fadeOutTo);Устанавливает уровень качества эффекта постобработки экранного пространства Внешнее перекрытие (SSAO). Подробнее см. Environment.
| Имя | Тип | По умолчанию |
|---|---|---|
quality | RenderingServer.EnvironmentSsaoQuality | — |
halfSize | bool | — |
adaptiveTarget | float | — |
blurPasses | int | — |
fadeOutFrom | float | — |
fadeOutTo | float | — |
EnvironmentSetSsilQualityvoid
public static void EnvironmentSetSsilQuality(RenderingServer.EnvironmentSsilQuality quality, bool halfSize, float adaptiveTarget, int blurPasses, float fadeOutFrom, float fadeOutTo);Устанавливает уровень качества эффекта постобработки непрямого освещения экранного пространства (SSIL). Подробнее см. в разделе Environment.
| Имя | Тип | По умолчанию |
|---|---|---|
quality | RenderingServer.EnvironmentSsilQuality | — |
halfSize | bool | — |
adaptiveTarget | float | — |
blurPasses | int | — |
fadeOutFrom | float | — |
fadeOutTo | float | — |
EnvironmentSetSsrvoid
public static void EnvironmentSetSsr(Rid env, bool enable, int maxSteps, float fadeIn, float fadeOut, float depthTolerance);Устанавливает переменные, которые будут использоваться с эффектом постобработки Отражения экранного пространства (SSR). Подробнее см. Environment.
| Имя | Тип | По умолчанию |
|---|---|---|
env | Rid | — |
enable | bool | — |
maxSteps | int | — |
fadeIn | float | — |
fadeOut | float | — |
depthTolerance | float | — |
EnvironmentSetSsrHalfSizevoid
public static void EnvironmentSetSsrHalfSize(bool halfSize);Определяет, будут ли отражения в экранном пространстве отображаться в полном или половинном размере. Отображение в половинном размере происходит быстрее, но может выглядеть пикселизированным или вызывать мерцание.
| Имя | Тип | По умолчанию |
|---|---|---|
halfSize | bool | — |
EnvironmentSetSsrRoughnessQualityvoid · Устарело
public static void EnvironmentSetSsrRoughnessQuality(RenderingServer.EnvironmentSsrRoughnessQuality quality);| Имя | Тип | По умолчанию |
|---|---|---|
quality | RenderingServer.EnvironmentSsrRoughnessQuality | — |
EnvironmentSetTonemapvoid
public static void EnvironmentSetTonemap(Rid env, RenderingServer.EnvironmentToneMapper toneMapper, float exposure, float white);Устанавливает переменные, которые будут использоваться с эффектом постобработки "tonemap". Подробнее см. Environment.
| Имя | Тип | По умолчанию |
|---|---|---|
env | Rid | — |
toneMapper | RenderingServer.EnvironmentToneMapper | — |
exposure | float | — |
white | float | — |
EnvironmentSetTonemapAgxContrastvoid
public static void EnvironmentSetTonemapAgxContrast(Rid env, float agxContrast);Более подробную информацию см. в Environment.TonemapAgxContrast.
| Имя | Тип | По умолчанию |
|---|---|---|
env | Rid | — |
agxContrast | float | — |
EnvironmentSetVolumetricFogvoid
public static void EnvironmentSetVolumetricFog(Rid env, bool enable, float density, Color albedo, Color emission, float emissionEnergy, float anisotropy, float length, float detailSpread, float gIInject, bool temporalReprojection, float temporalReprojectionAmount, float ambientInject, float skyAffect);Устанавливает переменные, которые будут использоваться с эффектом постобработки объемного тумана. Подробнее см. Environment.
| Имя | Тип | По умолчанию |
|---|---|---|
env | Rid | — |
enable | bool | — |
density | float | — |
albedo | Color | — |
emission | Color | — |
emissionEnergy | float | — |
anisotropy | float | — |
length | float | — |
detailSpread | float | — |
gIInject | float | — |
temporalReprojection | bool | — |
temporalReprojectionAmount | float | — |
ambientInject | float | — |
skyAffect | float | — |
EnvironmentSetVolumetricFogFilterActivevoid
public static void EnvironmentSetVolumetricFogFilterActive(bool active);Позволяет фильтровать объемный буфер рассеивания тумана. Это приводит к гораздо более гладким объемам с очень небольшим количеством артефактов недостаточной выборки.
| Имя | Тип | По умолчанию |
|---|---|---|
active | bool | — |
EnvironmentSetVolumetricFogVolumeSizevoid
public static void EnvironmentSetVolumetricFogVolumeSize(int size, int depth);Устанавливает разрешение буфера froxel объемного тумана. size изменяется в зависимости от соотношения сторон экрана и затем используется для установки ширины и высоты буфера. В то время как depth напрямую используется для установки глубины буфера.
| Имя | Тип | По умолчанию |
|---|---|---|
size | int | — |
depth | int | — |
FogVolumeCreateRid
public static Rid FogVolumeCreate();Создает новый объем тумана и добавляет его в RenderingServer. К нему можно получить доступ с помощью возвращаемого RID. Этот RID будет использоваться во всех функциях fog_volume_* RenderingServer.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer.FreeRid RenderingServer.
Примечание: Эквивалентный узел — FogVolume.
RidFogVolumeSetMaterialvoid
public static void FogVolumeSetMaterial(Rid fogVolume, Rid material);Устанавливает Material объема тумана. Может быть FogMaterial или пользовательским ShaderMaterial.
| Имя | Тип | По умолчанию |
|---|---|---|
fogVolume | Rid | — |
material | Rid | — |
FogVolumeSetShapevoid
public static void FogVolumeSetShape(Rid fogVolume, RenderingServer.FogVolumeShape shape);Устанавливает форму объема тумана на RenderingServer.FogVolumeShape.Ellipsoid, RenderingServer.FogVolumeShape.Cone, RenderingServer.FogVolumeShape.Cylinder, RenderingServer.FogVolumeShape.Box или RenderingServer.FogVolumeShape.World.
| Имя | Тип | По умолчанию |
|---|---|---|
fogVolume | Rid | — |
shape | RenderingServer.FogVolumeShape | — |
FogVolumeSetSizevoid
public static void FogVolumeSetSize(Rid fogVolume, Vector3 size);Устанавливает размер объема тумана, когда форма имеет значение RenderingServer.FogVolumeShape.Ellipsoid, RenderingServer.FogVolumeShape.Cone, RenderingServer.FogVolumeShape.Cylinder или RenderingServer.FogVolumeShape.Box.
| Имя | Тип | По умолчанию |
|---|---|---|
fogVolume | Rid | — |
size | Vector3 | — |
ForceDrawvoid
public static void ForceDraw(bool swapBuffers = true, double frameStep = 0d);Вызывает одновременную перерисовку всех вьюпортов. Должен вызываться из основного потока.
| Имя | Тип | По умолчанию |
|---|---|---|
swapBuffers | bool | true |
frameStep | double | 0d |
ForceSyncvoid
public static void ForceSync();Запускает синхронизацию между CPU и GPU, которая может потребоваться в определенных случаях. Вызывайте это только при необходимости, так как синхронизация CPU-GPU имеет эксплуатационные издержки.
FreeRidvoid
public static void FreeRid(Rid rid);Освобождает принадлежащий вызывающему серверный объект. Копии RID не сбрасываются автоматически; не вызывайте повторно для устаревшего значения.
| Имя | Тип | По умолчанию |
|---|---|---|
rid | Rid | — |
GISetUseHalfResolutionvoid
public static void GISetUseHalfResolution(bool halfResolution);Если half_resolution равен true, рендеринг буферов VoxelGI и SDFGI (Environment.SdfgiEnabled) с уменьшенным вдвое разрешением по каждой оси (например, 960×540 при размере области просмотра 1920×1080). Это значительно повышает производительность при включении VoxelGI или SDFGI за счет артефактов, которые могут быть видны на краях полигонов. Потеря качества становится менее заметной по мере увеличения разрешения области просмотра. Рендеринг LightmapGI не зависит от этой настройки. Эквивалентно ProjectSettings.rendering/global_illumination/gi/use_half_resolution.
| Имя | Тип | По умолчанию |
|---|---|---|
halfResolution | bool | — |
GetCurrentRenderingDriverNamestring
public static string GetCurrentRenderingDriverName();Возвращает имя фактически активного графического драйвера, а не метода рендеринга. Для диагностики записывайте вместе с GetCurrentRenderingMethod: одно имя метода не определяет API. На этом Windows-runtime проверены opengl3 и vulkan; другие платформенные драйверы не проверялись.
stringИмя активного драйвера, например opengl3 или vulkan. Это не оценка производительности и не список всех доступных драйверов.
GetCurrentRenderingMethodstring
public static string GetCurrentRenderingMethod();Возвращает текущий метод рендеринга для выбора допустимых настроек. Не заменяет проверку возможностей конкретного устройства и результата кадра.
stringИмя вроде gl_compatibility, forward_plus или mobile. Пример проверяет первые два на текущем ПК; Mobile/MetalFX/XR не проверены.
GetDefaultClearColorColor
public static Color GetDefaultClearColor();Возвращает цвет очистки по умолчанию, который используется, когда не выбран определенный цвет очистки. См. также RenderingServer.SetDefaultClearColor.
ColorGetFrameSetupTimeCpudouble
public static double GetFrameSetupTimeCpu();Возвращает время, необходимое для настройки рендеринга на ЦП в миллисекундах. Это значение является общим для всех вьюпортов и не требует, чтобы RenderingServer.ViewportSetMeasureRenderTime был включен на запрашиваемом вьюпорте. См. также RenderingServer.ViewportGetMeasuredRenderTimeCpu.
doubleGetRenderingDeviceRenderingDevice
public static RenderingDevice GetRenderingDevice();Возвращает общее RenderingDevice, используемое движком. В проверенных Mobile/Vulkan и Forward+/Vulkan доступно; в Compatibility/OpenGL отсутствует. Headless-путь также не предоставляет глобальное графическое устройство. Заимствованный объект не следует освобождать или Dispose; это не созданное вами локальное устройство.
RenderingDeviceОбщее устройство либо null, если данный путь его не предоставляет. Проверяйте null перед запросами; отсутствие устройства не означает отсутствие любых графических возможностей.
GetRenderingInfoulong
public static ulong GetRenderingInfo(RenderingServer.RenderingInfo info);Возвращает статистику о движке рендеринга, которую можно использовать для профилирования производительности. См. также RenderingServer.ViewportGetRenderInfo, который возвращает информацию, специфичную для области просмотра.
Примечание: В настоящее время только 3D-рендеринг учитывается некоторыми из этих значений, такими как количество вызовов отрисовки.
Примечание: Информация о рендеринге недоступна, пока движок не отрисует хотя бы 2 кадра. Если информация о рендеринге недоступна, RenderingServer.GetRenderingInfo возвращает 0. Чтобы успешно вывести информацию о рендеринге в _ready(), используйте следующее:
| Имя | Тип | По умолчанию |
|---|---|---|
info | RenderingServer.RenderingInfo | — |
ulongGetShaderParameterListReckfell.Collections.Array<Reckfell.Collections.Dictionary>
public static Reckfell.Collections.Array<Reckfell.Collections.Dictionary> GetShaderParameterList(Rid shader);Возвращает параметры шейдера.
| Имя | Тип | По умолчанию |
|---|---|---|
shader | Rid | — |
Reckfell.Collections.Array<Reckfell.Collections.Dictionary>GetTestCubeRid
public static Rid GetTestCube();Возвращает RID тестового куба. Эта сетка будет создана и возвращена при первом вызове RenderingServer.GetTestCube, затем она будет кэширована для последующих вызовов. См. также RenderingServer.MakeSphereMesh.
RidGetTestTextureRid
public static Rid GetTestTexture();Возвращает RID текстуры 256×256 с тестовым узором на ней (в формате Image.Format.Rgb8). Эта текстура будет создана и возвращена при первом вызове RenderingServer.GetTestTexture, затем она будет кэширована для последующих вызовов. См. также RenderingServer.GetWhiteTexture.
Пример: Получите тестовую текстуру и примените ее к узлу Sprite2D:
RidGetVideoAdapterApiVersionstring
public static string GetVideoAdapterApiVersion();Возвращает версию графического видеоадаптера используемого в данный момент (например, "1.2.189" для Vulkan, "3.3.0 NVIDIA 510.60.02" для OpenGL). Эта версия может отличаться от фактической последней версии, поддерживаемой оборудованием, так как Reckfell не всегда может запрашивать последнюю версию. См. также OS.GetVideoAdapterDriverInfo.
Примечание: При запуске headless или двоичный сервер эта функция возвращает пустую строку.
stringGetVideoAdapterNamestring
public static string GetVideoAdapterName();Возвращает имя видеоадаптера (например, "GeForce GTX 1080/PCIe/SSE2"). Примечание: При запуске headless или серверного двоичного файла эта функция возвращает пустую строку. Примечание: На веб-платформе некоторые браузеры, такие как Firefox, могут сообщать другое, фиксированное имя графического процессора, например "GeForce GTX 980" (независимо от фактической модели графического процессора пользователя). Это делается для того, чтобы затруднить отпечатки пальцев.
stringGetVideoAdapterTypeRenderingDevice.DeviceType
public static RenderingDevice.DeviceType GetVideoAdapterType();Возвращает тип видеоадаптера. Поскольку выделенные графические карты определенного поколения обычно будут значительно быстрее интегрированных графических карт того же поколения, тип устройства можно использовать в качестве основы для автоматической регулировки графических настроек. Однако это не всегда так, поэтому обязательно предоставьте пользователям возможность вручную переопределять графические настройки.
Примечание: При использовании драйвера рендеринга OpenGL или при работе в режиме headless эта функция всегда возвращает RenderingDevice.DeviceType.Other.
RenderingDevice.DeviceTypeGetVideoAdapterVendorstring
public static string GetVideoAdapterVendor();Возвращает поставщика видеоадаптера (например, «Корпорация NVIDIA»). Примечание: При запуске headless или серверного двоичного файла эта функция возвращает пустую строку.
stringGetWhiteTextureRid
public static Rid GetWhiteTexture();Возвращает идентификатор белой текстуры 4×4 (в формате Image.Format.Rgb8). Эта текстура будет создана и возвращена при первом вызове RenderingServer.GetWhiteTexture, затем она будет кэширована для последующих вызовов. См. также RenderingServer.GetTestTexture.
Пример: Получите белую текстуру и примените ее к узлу Sprite2D:
RidGlobalShaderParameterAddvoid
public static void GlobalShaderParameterAdd(StringName name, RenderingServer.GlobalShaderParameterType type, Variant defaultValue);Регистрирует глобальный shader-параметр с именем, типом и базовым значением. Имя не должно уже существовать; настройка shader_globals проекта также является регистрацией. Создайте параметр до загрузки использующего шейдера.
| Имя | Тип | По умолчанию |
|---|---|---|
name | StringName | — |
type | RenderingServer.GlobalShaderParameterType | — |
defaultValue | Variant | — |
nameТочное имя параметра с учётом регистра.
typeТип глобального параметра, совпадающий с объявлением шейдера.
defaultValueБазовое значение зарегистрированного типа.
GlobalShaderParameterGetVariant
public static Variant GlobalShaderParameterGet(StringName name);Читает базовое, не эффективное override-значение в контексте редактора. В игровом запуске эта версия сообщает ошибку и возвращает Nil; это не поддерживаемый runtime getter. Храните текущие значения в C#.
| Имя | Тип | По умолчанию |
|---|---|---|
name | StringName | — |
nameТочное имя параметра с учётом регистра.
VariantБазовое значение в редакторе; Nil при отсутствии или отклонённом игровом вызове.
GlobalShaderParameterGetListReckfell.Collections.Array<StringName>
public static Reckfell.Collections.Array<StringName> GlobalShaderParameterGetList();Возвращает отсортированные имена глобальных параметров в контексте редактора; игровой вызов отклоняется с ошибкой и пустым результатом. GLES3 дополнительно допускает контекст Project Manager. Не используйте для runtime-проверки перед Add.
Reckfell.Collections.Array<StringName>Отсортированная коллекция StringName для редакторского контекста.
GlobalShaderParameterGetTypeRenderingServer.GlobalShaderParameterType
public static RenderingServer.GlobalShaderParameterType GlobalShaderParameterGetType(StringName name);Читает тип зарегистрированного глобального параметра в контексте редактора. Для отсутствующего имени возвращает Max; игровой вызов отклоняется с ошибкой и также даёт Max.
| Имя | Тип | По умолчанию |
|---|---|---|
name | StringName | — |
nameТочное имя параметра с учётом регистра.
RenderingServer.GlobalShaderParameterTypeЗарегистрированный тип либо Max при отсутствии/отклонённом вызове.
GlobalShaderParameterRemovevoid
public static void GlobalShaderParameterRemove(StringName name);Удаляет глобальную регистрацию; отсутствующее имя пропускается. Сначала прекратите использование зависимых материалов/шейдеров: удаление ещё используемого параметра может сделать их вывод неверным.
| Имя | Тип | По умолчанию |
|---|---|---|
name | StringName | — |
nameТочное имя параметра с учётом регистра.
GlobalShaderParameterSetvoid
public static void GlobalShaderParameterSet(StringName name, Variant value);Меняет базовое значение зарегистрированного глобального параметра. При активном override обновляет основу, но видимый override сохраняется до снятия. Храните нужное значение на стороне приложения вместо runtime Get.
| Имя | Тип | По умолчанию |
|---|---|---|
name | StringName | — |
value | Variant | — |
nameТочное имя параметра с учётом регистра.
valueНовое базовое значение объявленного типа, не отключающее активный override.
GlobalShaderParameterSetOverridevoid
public static void GlobalShaderParameterSetOverride(StringName name, Variant value);Устанавливает приоритетное переопределение зарегистрированного параметра. Nil снимает его и возвращает текущее базовое значение; неподдерживаемое значение Object отклоняется. Отсутствующий параметр этот вызов не создаёт.
| Имя | Тип | По умолчанию |
|---|---|---|
name | StringName | — |
value | Variant | — |
nameТочное имя параметра с учётом регистра.
valueЗначение совместимого типа. Nil в override снимает его; низкоуровневый instance setter не заменяет сброс метода CanvasItem.
HasChangedbool
public static bool HasChanged();Возвращает true, если были внесены изменения в данные RenderingServer. В этом случае обычно вызывается RenderingServer.ForceDraw.
boolHasFeaturebool · Устарело
public static bool HasFeature(RenderingServer.Features feature);Этот метод ничего не делает и всегда возвращает false.
| Имя | Тип | По умолчанию |
|---|---|---|
feature | RenderingServer.Features | — |
boolHasOsFeaturebool
public static bool HasOsFeature(string feature);Returns (Возврат) true если: OS поддерживает определенный feature. Возможные особенности: s3tc, rgtc, bptc, etc, etc2, astc, и astc_hdr.
| Имя | Тип | По умолчанию |
|---|---|---|
feature | string | — |
boolInstanceAttachObjectInstanceIdvoid
public static void InstanceAttachObjectInstanceId(Rid instance, ulong id);Прикрепляет уникальный Object К примеру, документы. Object Идентификационный номер должен быть приложен к примеру для надлежащего отсечения RenderingServer.InstancesCullAabb, RenderingServer.InstancesCullConvex, и RenderingServer.InstancesCullRay.
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
id | ulong | — |
InstanceAttachSkeletonvoid
public static void InstanceAttachSkeleton(Rid instance, Rid skeleton);Прикрепляет скелет к экземпляру. Удаляет предыдущий скелет из экземпляра.
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
skeleton | Rid | — |
InstanceCreateRid
public static Rid InstanceCreate();Создаёт собственный RID rendering instance. Для отображения назначьте base, scenario и transform; при завершении вызовите FreeRid.
RidInstanceCreate2Rid
public static Rid InstanceCreate2(Rid @base, Rid scenario);Создает визуальный экземпляр, добавляет его в RenderingServer и задает как базу, так и сценарий. Доступ к нему можно получить с помощью возвращаемого RID. Этот RID будет использоваться во всех функциях instance_* RenderingServer.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer.FreeRid RenderingServer. Это сокращение для использования RenderingServer.InstanceCreate и установки базы и сценария вручную.
| Имя | Тип | По умолчанию |
|---|---|---|
base | Rid | — |
scenario | Rid | — |
RidInstanceGeometryGetShaderParameterVariant
public static Variant InstanceGeometryGetShaderParameter(Rid instance, StringName parameter);Возвращает значение шейдерной формы для каждого экземпляра из указанного экземпляра 3D-геометрии. Эквивалентно GeometryInstance3D.GetInstanceShaderParameter.
Примечание: Имена параметров шейдера для каждого экземпляра чувствительны к регистру.
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
parameter | StringName | — |
VariantInstanceGeometryGetShaderParameterDefaultValueVariant
public static Variant InstanceGeometryGetShaderParameterDefaultValue(Rid instance, StringName parameter);Возвращает значение по умолчанию для шейдера-единообразного экземпляра из указанного экземпляра 3D-геометрии. Эквивалентно GeometryInstance3D.GetInstanceShaderParameter.
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
parameter | StringName | — |
VariantInstanceGeometryGetShaderParameterListReckfell.Collections.Array<Reckfell.Collections.Dictionary>
public static Reckfell.Collections.Array<Reckfell.Collections.Dictionary> InstanceGeometryGetShaderParameterList(Rid instance);Возвращает словарь имен униформ шейдера для каждого экземпляра униформ шейдера для каждого экземпляра из указанного экземпляра 3D-геометрии. Возвращаемый словарь находится в формате PropertyInfo с ключами name, class_name, type, hint, hint_string и usage. Эквивалентно GeometryInstance3D.GetInstanceShaderParameter.
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
Reckfell.Collections.Array<Reckfell.Collections.Dictionary>InstanceGeometrySetCastShadowsSettingvoid
public static void InstanceGeometrySetCastShadowsSetting(Rid instance, RenderingServer.ShadowCastingSetting shadowCastingSetting);Устанавливает настройку отбрасывания тени. Эквивалентно GeometryInstance3D.CastShadow.
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
shadowCastingSetting | RenderingServer.ShadowCastingSetting | — |
InstanceGeometrySetFlagvoid
public static void InstanceGeometrySetFlag(Rid instance, RenderingServer.InstanceFlags flag, bool enabled);Устанавливает flag для заданного instance на enabled.
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
flag | RenderingServer.InstanceFlags | — |
enabled | bool | — |
InstanceGeometrySetLightmapvoid
public static void InstanceGeometrySetLightmap(Rid instance, Rid lightmap, Rect2 lightmapUVScale, int lightmapSlice);Устанавливает экземпляр карты освещения GI для использования с указанным экземпляром 3D-геометрии. Масштаб UV карты освещения для указанного экземпляра (эквивалент GeometryInstance3D.GILightmapScale) и срез атласа карты освещения также должны быть указаны.
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
lightmap | Rid | — |
lightmapUVScale | Rect2 | — |
lightmapSlice | int | — |
InstanceGeometrySetLodBiasvoid
public static void InstanceGeometrySetLodBias(Rid instance, float lodBias);Устанавливает уровень смещения детализации, используемый при рендеринге указанного экземпляра 3D-геометрии. Более высокие значения приводят к более высокой детализации с большего расстояния. Эквивалентно GeometryInstance3D.LodBias.
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
lodBias | float | — |
InstanceGeometrySetMaterialOverlayvoid
public static void InstanceGeometrySetMaterialOverlay(Rid instance, Rid material);Низкоуровневая установка дополнительного material overlay у RenderingServer instance. Это отдельный проход с собственными глубиной/смешиванием, не безусловный слой сверху. Передавайте RID Material, не Shader или локального RenderingDevice. Пустой RID снимает назначение. Владение ресурсом этот вызов не заменяет.
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
material | Rid | — |
instanceRID существующего RenderingServer instance геометрии.
materialRID живого Material или пустой RID для снятия назначения.
InstanceGeometrySetMaterialOverridevoid
public static void InstanceGeometrySetMaterialOverride(Rid instance, Rid material);Низкоуровневая установка базового material override у RenderingServer instance. Заменяет выбор материалов поверхностей. Передавайте RID Material, не Shader или локального RenderingDevice. Пустой RID снимает назначение. Владение ресурсом этот вызов не заменяет.
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
material | Rid | — |
instanceRID существующего RenderingServer instance геометрии.
materialRID живого Material или пустой RID для снятия назначения.
InstanceGeometrySetShaderParametervoid
public static void InstanceGeometrySetShaderParameter(Rid instance, StringName parameter, Variant value);Устанавливает униформу теневой системы на каждый патрубок на заданную геометрию 3D. GeometryInstance3D.SetInstanceShaderParameter.
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
parameter | StringName | — |
value | Variant | — |
InstanceGeometrySetTransparencyvoid
public static void InstanceGeometrySetTransparency(Rid instance, float transparency);Устанавливает прозрачность для данного случая геометрии. GeometryInstance3D.Transparency.
Транспарентность 0.0 полностью непрозрачна, в то время как 1.0 - полностью прозрачны. 0.0 (исключительно) заставит материалы геометрии пройти через прозрачный трубопровод, который медленнее доставлять и может проявлять проблемы из-за неправильной транспарентности сортировки. transparency на величину, превышающую 0.0 (исключительно) отключит тень.
В пространственных теннисах, 1.0 - transparency установлен в качестве значения по умолчанию ALPHA Встроенный.
Примечание: transparency зажимается между 0.0 и 1.0Таким образом, это имущество не может быть использовано для того, чтобы сделать прозрачные материалы более непрозрачными, чем они были изначально.
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
transparency | float | — |
InstanceGeometrySetVisibilityRangevoid
public static void InstanceGeometrySetVisibilityRange(Rid instance, float min, float max, float minMargin, float maxMargin, RenderingServer.VisibilityRangeFadeMode fadeMode);Устанавливает значения диапазона видимости для данного экземпляра геометрии. Эквивалентно GeometryInstance3D.VisibilityRangeBegin и связанным свойствам.
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
min | float | — |
max | float | — |
minMargin | float | — |
maxMargin | float | — |
fadeMode | RenderingServer.VisibilityRangeFadeMode | — |
InstanceResetPhysicsInterpolationvoid
public static void InstanceResetPhysicsInterpolation(Rid instance);| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
InstanceSetBasevoid
public static void InstanceSetBase(Rid instance, Rid @base);Устанавливает базу экземпляра. Базой может быть любой из 3D-объектов, созданных в RenderingServer, который может быть отображен. Например, любой из типов освещения, сетка, мультисетка, система частиц, зонд отражения, декаль, карта освещения, воксельное GI и уведомители видимости — все это типы, которые можно задать в качестве базы экземпляра для отображения в сценарии.
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
base | Rid | — |
InstanceSetBlendShapeWeightvoid
public static void InstanceSetBlendShapeWeight(Rid instance, int shape, float weight);Устанавливает вес для заданной формы смешивания, связанной с этим экземпляром.
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
shape | int | — |
weight | float | — |
InstanceSetCustomAabbvoid
public static void InstanceSetCustomAabb(Rid instance, Aabb aabb);Задаёт пользовательские локальные границы экземпляра рендеринга; default(Aabb) снимает замену. Extra visibility margin применяется после выбора этих границ, до мировой трансформации. Прямой вызов не обновляет сохранённое GeometryInstance3D.CustomAabb и не меняет Mesh.GetAabb(). Для обычного Entity предпочитайте свойство обёртки, чтобы её состояние оставалось согласованным.
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
aabb | Aabb | — |
instanceRID экземпляра RenderingServer, не RID ресурса Mesh. Передача заимствованного RID не даёт права освобождать его.
aabbЛокальный Aabb замены; default(Aabb) восстанавливает границы, определяемые источником геометрии.
InstanceSetExtraVisibilityMarginvoid
public static void InstanceSetExtraVisibilityMargin(Rid instance, float margin);Задаёт запас, которым сервер расширяет выбранные локальные границы перед трансформацией экземпляра. Запас действует и при CustomAabb, но не меняет геометрию или коллизию. Прямой вызов не обновляет сохранённое GeometryInstance3D.ExtraCullMargin. Используйте неотрицательное значение; проверка отрицательного аргумента в обёртке GeometryInstance3D не является контрактом этого низкоуровневого вызова.
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
margin | float | — |
instanceRID экземпляра рендеринга. Не передавайте RID меша или другого ресурса и не освобождайте заимствованный RID после настройки.
marginДополнительное расширение во все стороны в локальных единицах; 0 снимает запас. Мировой результат зависит от трансформации экземпляра.
InstanceSetIgnoreCullingvoid
public static void InstanceSetIgnoreCulling(Rid instance, bool enabled);Если true, то игнорируется вся отсечка для указанного экземпляра 3D-геометрии, включая отсечку по пирамиде видимости, отсечку по окклюзии и отсечку по слою. Это не то же самое, что GeometryInstance3D.IgnoreOcclusionCulling, который игнорирует только отсечку по окклюзии, но оставляет отсечку по пирамиде видимости и по слою без изменений.
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
enabled | bool | — |
InstanceSetInterpolatedvoid
public static void InstanceSetInterpolated(Rid instance, bool interpolated);| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
interpolated | bool | — |
InstanceSetLayerMaskvoid
public static void InstanceSetLayerMask(Rid instance, uint mask);Устанавливает слои рендеринга, на которых будет отрисован этот экземпляр. Эквивалентно VisualInstance3D.Layers.
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
mask | uint | — |
InstanceSetPivotDatavoid
public static void InstanceSetPivotData(Rid instance, float sortingOffset, bool useAabbCenter);Устанавливает смещение сортировки и переключается между использованием ограничивающей рамки или начала координат экземпляра для сортировки по глубине.
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
sortingOffset | float | — |
useAabbCenter | bool | — |
InstanceSetScenariovoid
public static void InstanceSetScenario(Rid instance, Rid scenario);Задает сценарий, в котором находится экземпляр. Сценарий — это трехмерный мир, в котором будут отображаться объекты.
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
scenario | Rid | — |
InstanceSetSurfaceOverrideMaterialvoid
public static void InstanceSetSurfaceOverrideMaterial(Rid instance, int surface, Rid material);Устанавливает переопределяющий материал определенной поверхности. Эквивалентно MeshInstance3D.SetSurfaceOverrideMaterial.
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
surface | int | — |
material | Rid | — |
InstanceSetTransformvoid
public static void InstanceSetTransform(Rid instance, Transform3D transform);Устанавливает преобразование мирового пространства экземпляра. Эквивалентно Entity3D.GlobalTransform.
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
transform | Transform3D | — |
InstanceSetVisibilityParentvoid
public static void InstanceSetVisibilityParent(Rid instance, Rid parent);Устанавливает родительский элемент видимости для данного экземпляра. Эквивалентно Entity3D.VisibilityParent.
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
parent | Rid | — |
InstanceSetVisiblevoid
public static void InstanceSetVisible(Rid instance, bool visible);Устанавливает, будет ли экземпляр отрисован или нет. Эквивалентно Entity3D.Visible.
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
visible | bool | — |
InstanceTeleportvoid
public static void InstanceTeleport(Rid instance);Сбрасывает векторы движения и другие интерполируемые значения. Используйте этот метод после телепортации меша из одной позиции в другую, чтобы избежать артефактов размытия в движении (ghosting).
| Имя | Тип | По умолчанию |
|---|---|---|
instance | Rid | — |
InstancesCullAabblong[]
public static long[] InstancesCullAabb(Aabb aabb, Rid scenario = default);Возвращает массив идентификаторов объектов, пересекающихся с предоставленным AABB. Рассматриваются только 3D-узлы, которые наследуются от VisualInstance3D, например MeshInstance3D или DirectionalLight3D. Используйте @GlobalScope.instance_from_id для получения фактических узлов. Необходимо предоставить RID сценария, который доступен в World3D, который вы хотите запросить. Это принудительно обновит все ресурсы, поставленные в очередь на обновление.
Предупреждение: Эта функция в первую очередь предназначена для использования в редакторе. Для внутриигровых случаев использования предпочитайте физическое столкновение.
| Имя | Тип | По умолчанию |
|---|---|---|
aabb | Aabb | — |
scenario | Rid | default |
long[]InstancesCullConvexlong[]
public static long[] InstancesCullConvex(Reckfell.Collections.Array<Plane> convex, Rid scenario = default);Возвращает массив идентификаторов объектов, пересекающихся с предоставленной выпуклой формой. Рассматриваются только 3D-узлы, которые наследуются от VisualInstance3D, такие как MeshInstance3D или DirectionalLight3D. Используйте @GlobalScope.instance_from_id для получения фактических узлов. Необходимо предоставить RID сценария, который доступен в World3D, который вы хотите запросить. Это принудительно обновит все ресурсы, поставленные в очередь на обновление.
Предупреждение: Эта функция в первую очередь предназначена для использования в редакторе. Для внутриигровых случаев использования предпочитайте физическое столкновение.
| Имя | Тип | По умолчанию |
|---|---|---|
convex | Reckfell.Collections.Array<Plane> | — |
scenario | Rid | default |
long[]InstancesCullRaylong[]
public static long[] InstancesCullRay(Vector3 from, Vector3 to, Rid scenario = default);Возвращает массив идентификаторов объектов, пересекающихся с предоставленным 3D-лучом. Рассматриваются только 3D-узлы, которые наследуются от VisualInstance3D, например MeshInstance3D или DirectionalLight3D. Используйте @GlobalScope.instance_from_id для получения фактических узлов. Необходимо предоставить RID сценария, который доступен в World3D, который вы хотите запросить. Это принудительно обновит все ресурсы, поставленные в очередь на обновление.
Предупреждение: Эта функция в первую очередь предназначена для использования в редакторе. Для внутриигровых случаев использования предпочитайте физическое столкновение.
| Имя | Тип | По умолчанию |
|---|---|---|
from | Vector3 | — |
to | Vector3 | — |
scenario | Rid | default |
long[]IsOnRenderThreadbool
public static bool IsOnRenderThread();Возвращает true, если наш код в данный момент выполняется в потоке рендеринга.
boolIsRenderLoopEnabledbool
public static bool IsRenderLoopEnabled();boolLightAreaSetNormalizeEnergyvoid
public static void LightAreaSetNormalizeEnergy(Rid light, bool enable);Определяет, нормализуется ли (делится) энергия AreaLight3D на его площадь. Если установлено значение true, изменение размера не влияет на общую выходную энергию. Эквивалентно AreaLight3D.AreaNormalizeEnergy.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
enable | bool | — |
LightAreaSetSizevoid
public static void LightAreaSetSize(Rid light, Vector2 size);Устанавливает размеры (ширину и высоту) в метрах для этого площадного света. Эквивалентно AreaLight3D.AreaSize.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
size | Vector2 | — |
LightDirectionalSetBlendSplitsvoid
public static void LightDirectionalSetBlendSplits(Rid light, bool enable);Если true, этот направленный свет будет смешиваться между разделениями карты теней, что приведет к более плавному переходу между ними. Эквивалентно DirectionalLight3D.DirectionalShadowBlendSplits.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
enable | bool | — |
LightDirectionalSetShadowModevoid
public static void LightDirectionalSetShadowMode(Rid light, RenderingServer.LightDirectionalShadowMode mode);Устанавливает режим тени для этого направленного света. Эквивалентно DirectionalLight3D.DirectionalShadowMode.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
mode | RenderingServer.LightDirectionalShadowMode | — |
LightDirectionalSetSkyModevoid
public static void LightDirectionalSetSkyMode(Rid light, RenderingServer.LightDirectionalSkyMode mode);Если true, этот свет не будет использоваться ни для чего, кроме шейдеров неба. Используйте это для источников света, которые влияют на ваш шейдер неба, и которые вы хотите скрыть от влияния на остальную часть сцены. Например, вы можете захотеть включить это, когда солнце в вашем шейдере неба опускается за горизонт.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
mode | RenderingServer.LightDirectionalSkyMode | — |
LightOmniSetShadowModevoid
public static void LightOmniSetShadowMode(Rid light, RenderingServer.LightOmniShadowMode mode);Устанавливает, использовать ли двойной параболоид или кубическую карту для карты теней. Двойной параболоид быстрее, но может страдать от артефактов. Эквивалентно OmniLight3D.OmniShadowMode.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
mode | RenderingServer.LightOmniShadowMode | — |
LightProjectorsSetFiltervoid
public static void LightProjectorsSetFilter(RenderingServer.LightProjectorFilter filter);Устанавливает режим фильтра текстуры для использования при рендеринге проекторов света. Этот параметр является глобальным и не может быть установлен для каждого источника света.
| Имя | Тип | По умолчанию |
|---|---|---|
filter | RenderingServer.LightProjectorFilter | — |
LightSetAllowContactShadowsvoid
public static void LightSetAllowContactShadows(Rid light, bool enable);Если true, позволяет сенсорно-пространственным контактам для этого света. ProjectSettings.rendering/lights_and_shadows/contact_shadow/enabled Включено. Light3D.ShadowContactShadowsAllow.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
enable | bool | — |
LightSetBakeModevoid
public static void LightSetBakeMode(Rid light, RenderingServer.LightBakeMode bakeMode);Устанавливает режим запекания для указанного 3D-света. Эквивалентно Light3D.LightBakeMode.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
bakeMode | RenderingServer.LightBakeMode | — |
LightSetColorvoid
public static void LightSetColor(Rid light, Color color);Устанавливает цвет света. Эквивалентно Light3D.LightColor.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
color | Color | — |
LightSetCullMaskvoid
public static void LightSetCullMask(Rid light, uint mask);Устанавливает маску отбраковки для этого 3D-света. Свет влияет только на объекты в выбранных слоях. Эквивалентно Light3D.LightCullMask.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
mask | uint | — |
LightSetDistanceFadevoid
public static void LightSetDistanceFade(Rid decal, bool enabled, float begin, float shadow, float length);Устанавливает расстояние затухания для этого 3D-света. Это действует как форма уровня детализации (LOD) и может использоваться для улучшения производительности. Эквивалентно Light3D.DistanceFadeEnabled, Light3D.DistanceFadeBegin, Light3D.DistanceFadeShadow и Light3D.DistanceFadeLength.
| Имя | Тип | По умолчанию |
|---|---|---|
decal | Rid | — |
enabled | bool | — |
begin | float | — |
shadow | float | — |
length | float | — |
LightSetMaxSdfgiCascadevoid
public static void LightSetMaxSdfgiCascade(Rid light, uint cascade);Устанавливает максимальный каскад SDFGI, в котором визуализируется непрямое освещение 3D-света. Более высокие значения позволяют визуализировать свет в SDFGI дальше от камеры.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
cascade | uint | — |
LightSetNegativevoid
public static void LightSetNegative(Rid light, bool enable);Если true, 3D-свет будет вычитать свет вместо добавления света. Эквивалентно Light3D.LightNegative.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
enable | bool | — |
LightSetParamvoid
public static void LightSetParam(Rid light, RenderingServer.LightParam param, float value);Устанавливает указанный параметр 3D-освещения. Эквивалентно Light3D.SetParam.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
param | RenderingServer.LightParam | — |
value | float | — |
LightSetProjectorvoid
public static void LightSetProjector(Rid light, Rid texture);Устанавливает текстуру проектора для использования с указанным 3D-освещением. Эквивалентно Light3D.LightProjector.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
texture | Rid | — |
LightSetReverseCullFaceModevoid
public static void LightSetReverseCullFaceMode(Rid light, bool enabled);Если true, то отменяется отбраковка задней поверхности сетки. Это может быть полезно, когда у вас есть плоская сетка, за которой находится свет. Если вам нужно отбросить тень на обе стороны сетки, настройте сетку на использование двухсторонних теней с помощью RenderingServer.InstanceGeometrySetCastShadowsSetting. Эквивалентно Light3D.ShadowReverseCullFace.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
enabled | bool | — |
LightSetShadowvoid
public static void LightSetShadow(Rid light, bool enabled);Если true, свет будет отбрасывать тени. Эквивалентно Light3D.ShadowEnabled.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
enabled | bool | — |
LightSetShadowCasterMaskvoid
public static void LightSetShadowCasterMask(Rid light, uint mask);Устанавливает маску отбрасывателя тени для этого 3D-света. Тени будут отбрасываться только с использованием объектов в выбранных слоях. Эквивалентно Light3D.ShadowCasterMask.
| Имя | Тип | По умолчанию |
|---|---|---|
light | Rid | — |
mask | uint | — |
LightmapCreateRid
public static Rid LightmapCreate();Создает новый экземпляр глобального освещения карты освещения и добавляет его в RenderingServer. Доступ к нему можно получить с помощью возвращаемого RID. Этот RID будет использоваться во всех функциях lightmap_* RenderingServer.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer.FreeRid RenderingServer.
Примечание: Эквивалентный узел — LightmapGI.
RidLightmapGetProbeCaptureBspTreeint[]
public static int[] LightmapGetProbeCaptureBspTree(Rid lightmap);Возвращает данные BSP-дерева, используемые для ускорения поиска зондов. Данные BSP структурированы как последовательность из шести 32-битных значений со знаком на узел BSP в следующем порядке: float plane_x, float plane_y, float plane_z, float plane_distance, int32_t over, int32_t under. Пустой лист обозначается значением -2147483648 (минимальное 32-битное целое со знаком). См. также RenderingServer.LightmapSetProbeCaptureData.
| Имя | Тип | По умолчанию |
|---|---|---|
lightmap | Rid | — |
int[]LightmapGetProbeCapturePointsVector3[]
public static Vector3[] LightmapGetProbeCapturePoints(Rid lightmap);Возвращает позиции в локальном пространстве каждой точки захвата зонда карты освещения. Имейте в виду, что экземпляр карты освещения может иметь ненулевое преобразование, которое повлияет на положение точек захвата зонда. См. также RenderingServer.LightmapSetProbeCaptureData.
| Имя | Тип | По умолчанию |
|---|---|---|
lightmap | Rid | — |
Vector3[]LightmapGetProbeCaptureShColor[]
public static Color[] LightmapGetProbeCaptureSh(Rid lightmap);Возвращает данные сферических гармоник L0, L1 и L2 для каждой точки захвата зонда карты освещения. Это задается как 9 значений Color на зонд, что означает, что размер возвращаемых данных всегда в 9 раз больше количества точек зонда. См. также RenderingServer.LightmapSetProbeCaptureData.
| Имя | Тип | По умолчанию |
|---|---|---|
lightmap | Rid | — |
Color[]LightmapGetProbeCaptureTetrahedraint[]
public static int[] LightmapGetProbeCaptureTetrahedra(Rid lightmap);Возвращает данные тетраэдризации, используемые для интерполяции между точками захвата зонда карты освещения. Каждый тетраэдр задается как последовательность из 4 чисел, каждое из которых является индексом в массиве точек захвата зонда, возвращаемом RenderingServer.LightmapGetProbeCapturePoints. См. также RenderingServer.LightmapSetProbeCaptureData.
| Имя | Тип | По умолчанию |
|---|---|---|
lightmap | Rid | — |
int[]LightmapSetBakedExposureNormalizationvoid
public static void LightmapSetBakedExposureNormalization(Rid lightmap, float bakedExposure);Используется для информирования рендерера о том, какое значение нормализации экспозиции использовалось при запекании карты освещения. Это значение будет использоваться и модулироваться во время выполнения, чтобы гарантировать, что карта освещения поддерживает постоянный уровень экспозиции, даже если нормализация экспозиции по всей сцене изменяется во время выполнения. Для получения дополнительной информации см. RenderingServer.CameraAttributesSetExposure.
| Имя | Тип | По умолчанию |
|---|---|---|
lightmap | Rid | — |
bakedExposure | float | — |
LightmapSetProbeBoundsvoid
public static void LightmapSetProbeBounds(Rid lightmap, Aabb bounds);Устанавливает границы, в которых этот экземпляр карты освещения должен визуально влиять, как с точки зрения статического запекания карты освещения, так и глобального освещения на основе зондов.
| Имя | Тип | По умолчанию |
|---|---|---|
lightmap | Rid | — |
bounds | Aabb | — |
LightmapSetProbeCaptureData2 перегрузки
public static void LightmapSetProbeCaptureData(Rid lightmap, Vector3[] points, Color[] pointSh, int[] tetrahedra, int[] bspTree);Устанавливает данные захвата зонда для данного экземпляра карты освещения. См. RenderingServer.LightmapGetProbeCapturePoints, RenderingServer.LightmapGetProbeCaptureSh, RenderingServer.LightmapGetProbeCaptureTetrahedra и RenderingServer.LightmapGetProbeCaptureBspTree для ожидаемых форматов данных.
| Имя | Тип | По умолчанию |
|---|---|---|
lightmap | Rid | — |
points | Vector3[] | — |
pointSh | Color[] | — |
tetrahedra | int[] | — |
bspTree | int[] | — |
public static void LightmapSetProbeCaptureData(Rid lightmap, ReadOnlySpan<Vector3> points, ReadOnlySpan<Color> pointSh, ReadOnlySpan<int> tetrahedra, ReadOnlySpan<int> bspTree);Устанавливает данные захвата зонда для данного экземпляра карты освещения. См. RenderingServer.LightmapGetProbeCapturePoints, RenderingServer.LightmapGetProbeCaptureSh, RenderingServer.LightmapGetProbeCaptureTetrahedra и RenderingServer.LightmapGetProbeCaptureBspTree для ожидаемых форматов данных.
| Имя | Тип | По умолчанию |
|---|---|---|
lightmap | Rid | — |
points | ReadOnlySpan<Vector3> | — |
pointSh | ReadOnlySpan<Color> | — |
tetrahedra | ReadOnlySpan<int> | — |
bspTree | ReadOnlySpan<int> | — |
LightmapSetProbeCaptureUpdateSpeedvoid
public static void LightmapSetProbeCaptureUpdateSpeed(float speed);Независимая от частоты кадров скорость обновления при отображении динамического освещения объектов из LightmapProbe. Более высокие значения ускоряют обновление динамического освещения объектов. Более высокие значения могут предотвратить отображение «устаревшего» непрямого освещения на быстро движущихся объектах за счет возможного мерцания при перемещении объекта из яркой области в затененную. См. также ProjectSettings.rendering/lightmapping/probe_capture/update_speed.
| Имя | Тип | По умолчанию |
|---|---|---|
speed | float | — |
LightmapSetProbeInteriorvoid
public static void LightmapSetProbeInterior(Rid lightmap, bool interior);Устанавливает, следует ли считать экземпляр карты освещения внутренним (когда interior равен true). Если карта освещения помечена как внутренняя, окружающее освещение игнорируется при запекании карт освещения.
| Имя | Тип | По умолчанию |
|---|---|---|
lightmap | Rid | — |
interior | bool | — |
LightmapSetTexturesvoid
public static void LightmapSetTextures(Rid lightmap, Rid light, bool usesSh);Установите текстуры на данном экземпляре GI lightmap в массив текстур, на который указывает RID light. Если текстура карты освещения была запечена с LightmapGI.Directional, установленным на true, то uses_sh также должен быть true.
| Имя | Тип | По умолчанию |
|---|---|---|
lightmap | Rid | — |
light | Rid | — |
usesSh | bool | — |
LightmapsSetBicubicFiltervoid
public static void LightmapsSetBicubicFilter(bool enable);Переключает, следует ли использовать бикубический фильтр при выборке карт освещения. Это сглаживает их внешний вид за счет производительности.
| Имя | Тип | По умолчанию |
|---|---|---|
enable | bool | — |
MakeSphereMeshRid
public static Rid MakeSphereMesh(int latitudes, int longitudes, float radius);Возвращает сетку сферы с заданным числом горизонтальных подразделений, вертикальных подразделений и радиусом. См. также RenderingServer.GetTestCube.
| Имя | Тип | По умолчанию |
|---|---|---|
latitudes | int | — |
longitudes | int | — |
radius | float | — |
RidMaterialCreateRid
public static Rid MaterialCreate();Создает пустой материал и добавляет его в RenderingServer. К нему можно получить доступ с помощью возвращаемого RID. Этот RID будет использоваться во всех функциях RenderingServer material_*.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer RenderingServer.FreeRid.
Примечание: Эквивалентный ресурс — Material.
RidMaterialGetParamVariant
public static Variant MaterialGetParam(Rid material, StringName parameter);Возвращает значение определенного параметра материала.
| Имя | Тип | По умолчанию |
|---|---|---|
material | Rid | — |
parameter | StringName | — |
VariantMaterialSetNextPassvoid
public static void MaterialSetNextPass(Rid material, Rid nextMaterial);Устанавливает следующий материал объекта.
| Имя | Тип | По умолчанию |
|---|---|---|
material | Rid | — |
nextMaterial | Rid | — |
MaterialSetParamvoid
public static void MaterialSetParam(Rid material, StringName parameter, Variant value);Устанавливает параметр материала.
| Имя | Тип | По умолчанию |
|---|---|---|
material | Rid | — |
parameter | StringName | — |
value | Variant | — |
MaterialSetRenderPriorityvoid
public static void MaterialSetRenderPriority(Rid material, int priority);Устанавливает приоритет рендеринга материала.
| Имя | Тип | По умолчанию |
|---|---|---|
material | Rid | — |
priority | int | — |
MaterialSetShadervoid
public static void MaterialSetShader(Rid shaderMaterial, Rid shader);Устанавливает шейдер материала шейдера.
| Имя | Тип | По умолчанию |
|---|---|---|
shaderMaterial | Rid | — |
shader | Rid | — |
MaterialSetUseDebandingvoid
public static void MaterialSetUseDebanding(bool enable);При использовании рендерера Mobile метод RenderingServer.MaterialSetUseDebanding можно использовать для включения или отключения функции устранения полос в 3D-материалах (BaseMaterial3D и ShaderMaterial).
Метод RenderingServer.MaterialSetUseDebanding не оказывает никакого эффекта при использовании рендерера Compatibility или Forward+. В Forward+ вместо этого можно использовать устранение полос в Viewport.
См. также ProjectSettings.rendering/anti_aliasing/quality/use_debanding и RenderingServer.ViewportSetUseDebanding.
| Имя | Тип | По умолчанию |
|---|---|---|
enable | bool | — |
MeshAddSurfacevoid
public static void MeshAddSurface(Rid mesh, Reckfell.Collections.Dictionary surface);Создает новую поверхность для данной mesh. Эквивалентно RenderingServer.MeshAddSurfaceFromArrays, но принимает один аргумент Reckfell.Collections.Dictionary вместо отдельных аргументов. Словарь должен иметь следующую структуру:
См. также RenderingServer.MeshGetSurface, которая возвращает данные в той же структуре, определенной выше.
| Имя | Тип | По умолчанию |
|---|---|---|
mesh | Rid | — |
surface | Reckfell.Collections.Dictionary | — |
MeshAddSurfaceFromArraysvoid
public static void MeshAddSurfaceFromArrays(Rid mesh, RenderingServer.PrimitiveType primitive, Reckfell.Collections.Array arrays, Reckfell.Collections.Array blendShapes = null, Reckfell.Collections.Dictionary lods = null, RenderingServer.ArrayFormat compressFormat = RenderingServer.ArrayFormat.FlagFormatVersion1);Создает новую поверхность для данной mesh. RenderingServer.MeshGetSurfaceCount станет индексом поверхности для этой новой поверхности.
Поверхности создаются для рендеринга с использованием primitive, который может быть любым из значений, определенных в Mesh.PrimitiveType.
Аргумент arrays — это массив массивов. Каждый из элементов Mesh.ArrayType.Max содержит массив с некоторыми данными сетки для этой поверхности, как описано соответствующим членом Mesh.ArrayType, или null, если он не используется поверхностью. Например, arrays[Mesh.ArrayType.Index](/ru/docs/api/mesh#member-index-23499c80bb), если он используется. Аргумент blend_shapes— это массив данных вершин для каждой формы смешивания. Каждый элемент — это массив той же структуры, что иarrays, но [Mesh.ArrayType.Vertex](/ru/docs/api/mesh#member-vertex-87b0249d36), [Mesh.ArrayType.Normal](/ru/docs/api/mesh#member-normal-138d58cd86) и [Mesh.ArrayType.Tangent](/ru/docs/api/mesh#member-tangent-14eb4ead6f) устанавливаются тогда и только тогда, когда они установлены в arrays, а все остальные записи — null. Аргумент lods — это словарь с ключами [int[]](/ru/docs/api/packedint32array). Каждая запись в словаре представляет уровень детализации поверхности, где значение — это массив [Mesh.ArrayType.Index](/ru/docs/api/mesh#member-index-23499c80bb), используемый для уровня детализации, а ключ примерно пропорционален расстоянию, на котором используются характеристики детализации. То есть, увеличение ключа детализации также увеличивает расстояние, на котором объекты должны находиться от камеры, прежде чем будет использован детализация. Аргумент compress_format представляет собой побитовое ИЛИ, при необходимости: одного значения [RenderingServer.ArrayFormat](/ru/docs/api/renderingserver#enum-arrayformat), сдвинутого влево на ARRAY_FORMAT_CUSTOMn_SHIFT для каждого используемого пользовательского канала, [RenderingServer.ArrayFormat.FlagUseDynamicUpdate](/ru/docs/api/renderingserver#member-flagusedynamicupdate-d4feaa23f9), [RenderingServer.ArrayFormat.FlagUse8BoneWeights](/ru/docs/api/renderingserver#member-flaguse8boneweights-3c033c78c7) или [RenderingServer.ArrayFormat.FlagUsesEmptyVertexArray](/ru/docs/api/renderingserver#member-flagusesemptyvertexarray-07eec33ad4). См. [ArrayMesh.AddSurfaceFromArrays](/ru/docs/api/arraymesh#member-addsurfacefromarrays-7effbb836f) и [ImporterMesh.AddSurface`](/ru/docs/api/importermesh#member-addsurface-da30efdaa3) для более высокоуровневых эквивалентов этого метода.
Примечание: При использовании индексов рекомендуется использовать только точки, линии или треугольники.
| Имя | Тип | По умолчанию |
|---|---|---|
mesh | Rid | — |
primitive | RenderingServer.PrimitiveType | — |
arrays | Reckfell.Collections.Array | — |
blendShapes | Reckfell.Collections.Array | null |
lods | Reckfell.Collections.Dictionary | null |
compressFormat | RenderingServer.ArrayFormat | RenderingServer.ArrayFormat.FlagFormatVersion1 |
MeshClearvoid
public static void MeshClear(Rid mesh);Удаляет все поверхности из сетки.
| Имя | Тип | По умолчанию |
|---|---|---|
mesh | Rid | — |
MeshCreateRid
public static Rid MeshCreate();Создает новую сетку и добавляет ее в RenderingServer. Доступ к ней можно получить с помощью возвращаемого RID. Этот RID будет использоваться во всех функциях RenderingServer mesh_*.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer RenderingServer.FreeRid.
Чтобы разместить в сцене, прикрепите эту сетку к экземпляру с помощью RenderingServer.InstanceSetBase, используя возвращаемый RID.
Примечание: Эквивалентный ресурс — Mesh.
RidMeshCreateFromSurfacesRid
public static Rid MeshCreateFromSurfaces(Reckfell.Collections.Array<Reckfell.Collections.Dictionary> surfaces, int blendShapeCount = 0);Создаёт новую сетку с предопределёнными для нее поверхностями и добавляет сетку к RenderingServer1. Доступ к нему можно получить через RID Вернули. RID будет использоваться во всех mesh_* RenderingServer Этот метод более эффективен для создания ячеек с несколькими поверхностями по сравнению с созданием пустой сетки RenderingServer.MeshCreate и добавляют поверхности, RenderingServer.MeshAddSurface.
Каждый элемент surfaces система должна соответствовать той же структуре, которая описана RenderingServer.MeshAddSurface. . . . . blend_shape_count параметр должен соответствовать данным о форме смеси, определенным на всех поверхностях.
Как только закончите с вашим RIDВы захотите освободить RID с использованием RenderingServer's RenderingServer.FreeRid Метод.
Чтобы попасть в сцену, прикрепите эту сетку к случаю с использованием RenderingServer.InstanceSetBase с использованием возвращенных RID.
Примечание: Эквивалентный ресурс: Mesh.
| Имя | Тип | По умолчанию |
|---|---|---|
surfaces | Reckfell.Collections.Array<Reckfell.Collections.Dictionary> | — |
blendShapeCount | int | 0 |
RidMeshGetBlendShapeCountint
public static int MeshGetBlendShapeCount(Rid mesh);Возвращает количество смешанных форм сетки.
| Имя | Тип | По умолчанию |
|---|---|---|
mesh | Rid | — |
intMeshGetBlendShapeModeRenderingServer.BlendShapeMode
public static RenderingServer.BlendShapeMode MeshGetBlendShapeMode(Rid mesh);Возвращает режим смешивания форм сетки.
| Имя | Тип | По умолчанию |
|---|---|---|
mesh | Rid | — |
RenderingServer.BlendShapeModeMeshGetCustomAabbAabb
public static Aabb MeshGetCustomAabb(Rid mesh);Возвращает пользовательский aabb сетки.
| Имя | Тип | По умолчанию |
|---|---|---|
mesh | Rid | — |
AabbMeshGetSurfaceReckfell.Collections.Dictionary
public static Reckfell.Collections.Dictionary MeshGetSurface(Rid mesh, int surface);Возвращает полигональную сетку поверхности в виде словаря, имеющего одинаковую структуру, как описано в RenderingServer.MeshAddSurface.
| Имя | Тип | По умолчанию |
|---|---|---|
mesh | Rid | — |
surface | int | — |
Reckfell.Collections.DictionaryMeshGetSurfaceCountint
public static int MeshGetSurfaceCount(Rid mesh);Возвращает количество поверхностей сетки.
| Имя | Тип | По умолчанию |
|---|---|---|
mesh | Rid | — |
intMeshSetBlendShapeModevoid
public static void MeshSetBlendShapeMode(Rid mesh, RenderingServer.BlendShapeMode mode);Устанавливает режим смешивания форм сетки.
| Имя | Тип | По умолчанию |
|---|---|---|
mesh | Rid | — |
mode | RenderingServer.BlendShapeMode | — |
MeshSetCustomAabbvoid
public static void MeshSetCustomAabb(Rid mesh, Aabb aabb);Устанавливает пользовательский aabb сетки.
| Имя | Тип | По умолчанию |
|---|---|---|
mesh | Rid | — |
aabb | Aabb | — |
MeshSetShadowMeshvoid
public static void MeshSetShadowMesh(Rid mesh, Rid shadowMesh);Устанавливает необязательную вторую сетку, которая может использоваться для рендеринга теней и предварительного прохода глубины. Может использоваться для повышения производительности путем предоставления сетки с объединенными вершинами и только данными о положении вершин (без нормалей, UV, цветов и т. д.). Примечание: Эта сетка должна иметь точно такие же положения вершин, как и исходная сетка (включая LOD исходной сетки, если они есть). Если положения вершин отличаются, то сетка не будет отрисовываться правильно.
| Имя | Тип | По умолчанию |
|---|---|---|
mesh | Rid | — |
shadowMesh | Rid | — |
MeshSurfaceGetArraysReckfell.Collections.Array
public static Reckfell.Collections.Array MeshSurfaceGetArrays(Rid mesh, int surface);Возвращает массивы буферов поверхности сетки.
| Имя | Тип | По умолчанию |
|---|---|---|
mesh | Rid | — |
surface | int | — |
Reckfell.Collections.ArrayMeshSurfaceGetAttributeBufferRdRidRid
public static Rid MeshSurfaceGetAttributeBufferRdRid(Rid mesh, int surface);Возвращает RenderingDevice Rid ручка буфера атрибута данной поверхности ячеи (Color:: УФ, УФ2, УФ0-3). Rid можно использовать, как любой другой буфер RenderingDeviceТаким образом, атрибуты поверхности можно прочитать или записать из вычислительного тендера без круглосуточной трансмиссии процессора.
Для того чтобы связать буфер в качестве буфера для хранения в вычислении, поверхность должна быть создана с помощью RenderingServer.ArrayFormat.FlagUseStorageBuffer Флаг установлен в его формате.
Возвращает инвалида Rid если поверхность не имеет буфера атрибута или если ретранслятор не разоблачает RenderingDevice Rids (такие, как OpenGL).
| Имя | Тип | По умолчанию |
|---|---|---|
mesh | Rid | — |
surface | int | — |
RidMeshSurfaceGetBlendShapeArraysReckfell.Collections.Array<Reckfell.Collections.Array>
public static Reckfell.Collections.Array<Reckfell.Collections.Array> MeshSurfaceGetBlendShapeArrays(Rid mesh, int surface);Возвращает массивы поверхности сетки для смешанных форм.
| Имя | Тип | По умолчанию |
|---|---|---|
mesh | Rid | — |
surface | int | — |
Reckfell.Collections.Array<Reckfell.Collections.Array>MeshSurfaceGetFormatAttributeStrideuint
public static uint MeshSurfaceGetFormatAttributeStride(RenderingServer.ArrayFormat format, int vertexCount);Возвращает шаг буфера атрибутов для сетки с заданным format.
| Имя | Тип | По умолчанию |
|---|---|---|
format | RenderingServer.ArrayFormat | — |
vertexCount | int | — |
uintMeshSurfaceGetFormatIndexStrideuint
public static uint MeshSurfaceGetFormatIndexStride(RenderingServer.ArrayFormat format, int vertexCount);Возвращает шаг индексного буфера для сетки с заданным format.
| Имя | Тип | По умолчанию |
|---|---|---|
format | RenderingServer.ArrayFormat | — |
vertexCount | int | — |
uintMeshSurfaceGetFormatNormalTangentStrideuint
public static uint MeshSurfaceGetFormatNormalTangentStride(RenderingServer.ArrayFormat format, int vertexCount);Возвращает шаг комбинированных нормалей и касательных для сетки с заданным format. Важно отметить, что, хотя нормали и касательные находятся в буфере вершин с вершинами, они только чередуются друг с другом и поэтому имеют шаг, отличный от позиций вершин.
| Имя | Тип | По умолчанию |
|---|---|---|
format | RenderingServer.ArrayFormat | — |
vertexCount | int | — |
uintMeshSurfaceGetFormatOffsetuint
public static uint MeshSurfaceGetFormatOffset(RenderingServer.ArrayFormat format, int vertexCount, int arrayIndex);Возвращает смещение заданного атрибута на array_index в начале соответствующего буфера.
| Имя | Тип | По умолчанию |
|---|---|---|
format | RenderingServer.ArrayFormat | — |
vertexCount | int | — |
arrayIndex | int | — |
uintMeshSurfaceGetFormatSkinStrideuint
public static uint MeshSurfaceGetFormatSkinStride(RenderingServer.ArrayFormat format, int vertexCount);Возвращает шаг буфера кожи для сетки с заданным format.
| Имя | Тип | По умолчанию |
|---|---|---|
format | RenderingServer.ArrayFormat | — |
vertexCount | int | — |
uintMeshSurfaceGetFormatVertexStrideuint
public static uint MeshSurfaceGetFormatVertexStride(RenderingServer.ArrayFormat format, int vertexCount);Возвращает шаг позиций вершин для сетки с заданным format. Важно отметить, что позиции вершин сохраняются последовательно и не чередуются с другими атрибутами в буфере вершин (нормалями и касательными).
| Имя | Тип | По умолчанию |
|---|---|---|
format | RenderingServer.ArrayFormat | — |
vertexCount | int | — |
uintMeshSurfaceGetIndexBufferRdRidRid
public static Rid MeshSurfaceGetIndexBufferRdRid(Rid mesh, int surface);Возвращает RenderingDevice Rid ручка индексного буфера данной поверхности ячеек. Возвращение Rid можно использовать, как любой другой буфер RenderingDevice, так что индексы можно прочитать или написать из вычисления тендера без круговой трансляции процессора.
Для того чтобы связать буфер в качестве буфера для хранения в вычислении, поверхность должна быть создана с помощью RenderingServer.ArrayFormat.FlagUseStorageBuffer Флаг установлен в его формате.
Возвращает инвалида Rid если поверхность не индексирована или если ретранслятор не разоблачает RenderingDevice Rids (такие, как OpenGL).
| Имя | Тип | По умолчанию |
|---|---|---|
mesh | Rid | — |
surface | int | — |
RidMeshSurfaceGetMaterialRid
public static Rid MeshSurfaceGetMaterial(Rid mesh, int surface);Возвращает материал поверхности сетки.
| Имя | Тип | По умолчанию |
|---|---|---|
mesh | Rid | — |
surface | int | — |
RidMeshSurfaceGetSkinBufferRdRidRid
public static Rid MeshSurfaceGetSkinBufferRdRid(Rid mesh, int surface);Возвращает RenderingDevice Rid ручная ручка кожного буфера данной поверхности ячеек (костей, весов). Rid можно использовать, как любой другой буфер RenderingDevice, так что данные о коже можно прочитать или записать из вычислительного тендера без круглой трансформации процессора.
Этот буфер создается с использованием хранилищ-буфера бит, когда поверхность имеет данные об обесцвечивании, так что он может быть связан как хранилище в вычислении даже без RenderingServer.ArrayFormat.FlagUseStorageBuffer.
Возвращает инвалида Rid если поверхность не имеет буфера для кожуры или если репродукция не разоблачает RenderingDevice Rids (такие, как OpenGL).
| Имя | Тип | По умолчанию |
|---|---|---|
mesh | Rid | — |
surface | int | — |
RidMeshSurfaceGetVertexBufferRdRidRid
public static Rid MeshSurfaceGetVertexBufferRdRid(Rid mesh, int surface);Возвращает RenderingDevice Rid ручка верхней части буфера данной поверхности ячеек (Vertex, Real, Tangent). Возвращение Rid можно использовать, как любой другой буфер RenderingDevice, так что поверхностные вершины можно прочитать или написать из вычислительного тендера без круглосуточного процессора. Mesh эквивалент RenderingServer.MultimeshGetBufferRdRid и предназначено для работы сетчатых труб, приводимых в действие GPU (процедурные ячеки, ленточные тропы, ткань, волосы, трава) ReckfellExtension.
Для того чтобы связать буфер в качестве буфера для хранения в вычислении, поверхность должна быть создана с помощью RenderingServer.ArrayFormat.FlagUseStorageBuffer Флаг установлен в его формате.
Возвращает инвалида Rid если поверхность не имеет верхнего буфера или если повторная передача не разоблачает RenderingDevice Rids (такие, как OpenGL).
| Имя | Тип | По умолчанию |
|---|---|---|
mesh | Rid | — |
surface | int | — |
RidMeshSurfaceRemovevoid
public static void MeshSurfaceRemove(Rid mesh, int surface);Удалить поверхность на данном индексе из Mesh, смещенные поверхности с более высоким индексом вниз на единицу.
| Имя | Тип | По умолчанию |
|---|---|---|
mesh | Rid | — |
surface | int | — |
MeshSurfaceSetMaterialvoid
public static void MeshSurfaceSetMaterial(Rid mesh, int surface, Rid material);Устанавливает материал поверхности сетки.
| Имя | Тип | По умолчанию |
|---|---|---|
mesh | Rid | — |
surface | int | — |
material | Rid | — |
MeshSurfaceUpdateAttributeRegion2 перегрузки
public static void MeshSurfaceUpdateAttributeRegion(Rid mesh, int surface, int offset, byte[] data);Обновляет буфер атрибута поверхности сетки с указанным data. Ожидаемые данные по каждому атрибуту составляют 8 или 12 байт (4 байт на один параметр) float, 2 поплавка в расчете на Vector2, и 3 поплавка на 1 Vector3) в зависимости от того, используется ли сетка Vector2 или Vector3 Это значение может быть определено с помощью RenderingServer.MeshSurfaceGetFormatAttributeStride вместо этого.
Исходная точка обновления может быть изменена с помощью offset. Стоимость offset в большинстве случаев должно быть кратным 12 байтам, чтобы привести их в соответствие с каждым атрибутом.
A Vector3[] мест расположения атрибутов может быть преобразована в a byte[] использование PackedVector3Array.to_byte_array для использования в data.
| Имя | Тип | По умолчанию |
|---|---|---|
mesh | Rid | — |
surface | int | — |
offset | int | — |
data | byte[] | — |
public static void MeshSurfaceUpdateAttributeRegion(Rid mesh, int surface, int offset, ReadOnlySpan<byte> data);Обновляет буфер атрибута поверхности сетки с указанным data. Ожидаемые данные по каждому атрибуту составляют 8 или 12 байт (4 байт на один параметр) float, 2 поплавка в расчете на Vector2, и 3 поплавка на 1 Vector3) в зависимости от того, используется ли сетка Vector2 или Vector3 Это значение может быть определено с помощью RenderingServer.MeshSurfaceGetFormatAttributeStride вместо этого.
Исходная точка обновления может быть изменена с помощью offset. Стоимость offset в большинстве случаев должно быть кратным 12 байтам, чтобы привести их в соответствие с каждым атрибутом.
A Vector3[] мест расположения атрибутов может быть преобразована в a byte[] использование PackedVector3Array.to_byte_array для использования в data.
| Имя | Тип | По умолчанию |
|---|---|---|
mesh | Rid | — |
surface | int | — |
offset | int | — |
data | ReadOnlySpan<byte> | — |
MeshSurfaceUpdateIndexRegion2 перегрузки
public static void MeshSurfaceUpdateIndexRegion(Rid mesh, int surface, int offset, byte[] data);Обновляет индексный буфер поверхности меша переданными data. Ожидаемые данные — 16- или 32-битные беззнаковые целые числа, что можно определить с помощью RenderingServer.MeshSurfaceGetFormatIndexStride.
| Имя | Тип | По умолчанию |
|---|---|---|
mesh | Rid | — |
surface | int | — |
offset | int | — |
data | byte[] | — |
public static void MeshSurfaceUpdateIndexRegion(Rid mesh, int surface, int offset, ReadOnlySpan<byte> data);Обновляет индексный буфер поверхности меша переданными data. Ожидаемые данные — 16- или 32-битные беззнаковые целые числа, что можно определить с помощью RenderingServer.MeshSurfaceGetFormatIndexStride.
| Имя | Тип | По умолчанию |
|---|---|---|
mesh | Rid | — |
surface | int | — |
offset | int | — |
data | ReadOnlySpan<byte> | — |
MeshSurfaceUpdateSkinRegion2 перегрузки
public static void MeshSurfaceUpdateSkinRegion(Rid mesh, int surface, int offset, byte[] data);Обновляет кожный буфер поверхности сетки с помощью указанного data. Ожидаемые данные на кожу составляют 8 или 12 байт (4 байт на кожу float, 2 поплавка в расчете на Vector2, и 3 поплавка на 1 Vector3) в зависимости от того, используется ли сетка Vector2 или Vector3 Это значение может быть определено с помощью RenderingServer.MeshSurfaceGetFormatSkinStride вместо этого.
Исходная точка обновления может быть изменена с помощью offset. Стоимость offset в большинстве случаев должно быть кратно 12 байтов для приведения в соответствие с каждой кожей.
A Vector3[] локации кожи могут быть преобразованы в a byte[] использование PackedVector3Array.to_byte_array для использования в data.
| Имя | Тип | По умолчанию |
|---|---|---|
mesh | Rid | — |
surface | int | — |
offset | int | — |
data | byte[] | — |
public static void MeshSurfaceUpdateSkinRegion(Rid mesh, int surface, int offset, ReadOnlySpan<byte> data);Обновляет кожный буфер поверхности сетки с помощью указанного data. Ожидаемые данные на кожу составляют 8 или 12 байт (4 байт на кожу float, 2 поплавка в расчете на Vector2, и 3 поплавка на 1 Vector3) в зависимости от того, используется ли сетка Vector2 или Vector3 Это значение может быть определено с помощью RenderingServer.MeshSurfaceGetFormatSkinStride вместо этого.
Исходная точка обновления может быть изменена с помощью offset. Стоимость offset в большинстве случаев должно быть кратно 12 байтов для приведения в соответствие с каждой кожей.
A Vector3[] локации кожи могут быть преобразованы в a byte[] использование PackedVector3Array.to_byte_array для использования в data.
| Имя | Тип | По умолчанию |
|---|---|---|
mesh | Rid | — |
surface | int | — |
offset | int | — |
data | ReadOnlySpan<byte> | — |
MeshSurfaceUpdateVertexRegion2 перегрузки
public static void MeshSurfaceUpdateVertexRegion(Rid mesh, int surface, int offset, byte[] data);Обновляет верхний буфер сетчатой поверхности с помощью указанного data. Предполагается, что данные на вершину составляют 8 или 12 байтов (4 байт на вершину) float, 2 поплавка в расчете на Vector2, и 3 поплавка на 1 Vector3) в зависимости от того, используется ли сетка Vector2 или Vector3 Это значение может быть определено с помощью RenderingServer.MeshSurfaceGetFormatVertexStride вместо этого.
Исходная точка обновления может быть изменена с помощью offset. Стоимость offset В большинстве случаев должно быть кратно 12 байтов, чтобы привести их в соответствие с вершиной.
A Vector3[] Вертикальные точки могут быть преобразованы в а/ byte[] использование PackedVector3Array.to_byte_array для использования в data.
| Имя | Тип | По умолчанию |
|---|---|---|
mesh | Rid | — |
surface | int | — |
offset | int | — |
data | byte[] | — |
public static void MeshSurfaceUpdateVertexRegion(Rid mesh, int surface, int offset, ReadOnlySpan<byte> data);Обновляет верхний буфер сетчатой поверхности с помощью указанного data. Предполагается, что данные на вершину составляют 8 или 12 байтов (4 байт на вершину) float, 2 поплавка в расчете на Vector2, и 3 поплавка на 1 Vector3) в зависимости от того, используется ли сетка Vector2 или Vector3 Это значение может быть определено с помощью RenderingServer.MeshSurfaceGetFormatVertexStride вместо этого.
Исходная точка обновления может быть изменена с помощью offset. Стоимость offset В большинстве случаев должно быть кратно 12 байтов, чтобы привести их в соответствие с вершиной.
A Vector3[] Вертикальные точки могут быть преобразованы в а/ byte[] использование PackedVector3Array.to_byte_array для использования в data.
| Имя | Тип | По умолчанию |
|---|---|---|
mesh | Rid | — |
surface | int | — |
offset | int | — |
data | ReadOnlySpan<byte> | — |
MultimeshAllocateData2 перегрузки
public static void MultimeshAllocateData(Rid multimesh, int instances, RenderingServer.MultimeshTransformFormat transformFormat, bool colorFormat, bool customDataFormat);Настраивает мультимеш с использованием указанных данных. Количество экземпляров задается instances. Формат преобразований экземпляров задается transform_format, который должен быть установлен в соответствии с тем, предназначен ли мультимеш для рендеринга в 2D или 3D. Если color_format равен true, каждый экземпляр будет иметь связанный цвет. Если custom_data_format равен true, каждый экземпляр будет иметь связанный вектор пользовательских данных. Если use_indirect равен true, для этого мультимеша будет создан буфер косвенных команд, позволяющий изменять количество экземпляров непосредственно на GPU. См. также RenderingServer.MultimeshGetCommandBufferRdRid.
| Имя | Тип | По умолчанию |
|---|---|---|
multimesh | Rid | — |
instances | int | — |
transformFormat | RenderingServer.MultimeshTransformFormat | — |
colorFormat | bool | — |
customDataFormat | bool | — |
public static void MultimeshAllocateData(Rid multimesh, int instances, RenderingServer.MultimeshTransformFormat transformFormat, bool colorFormat = false, bool customDataFormat = false, bool useIndirect = false);Настраивает мультимеш с использованием указанных данных. Количество экземпляров задается instances. Формат преобразований экземпляров задается transform_format, который должен быть установлен в соответствии с тем, предназначен ли мультимеш для рендеринга в 2D или 3D. Если color_format равен true, каждый экземпляр будет иметь связанный цвет. Если custom_data_format равен true, каждый экземпляр будет иметь связанный вектор пользовательских данных. Если use_indirect равен true, для этого мультимеша будет создан буфер косвенных команд, позволяющий изменять количество экземпляров непосредственно на GPU. См. также RenderingServer.MultimeshGetCommandBufferRdRid.
| Имя | Тип | По умолчанию |
|---|---|---|
multimesh | Rid | — |
instances | int | — |
transformFormat | RenderingServer.MultimeshTransformFormat | — |
colorFormat | bool | false |
customDataFormat | bool | false |
useIndirect | bool | false |
MultimeshCreateRid
public static Rid MultimeshCreate();Создает новую мультисетку на RenderingServer и возвращает дескриптор Rid. Этот RID будет использоваться во всех функциях RenderingServer multimesh_*.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer.FreeRid RenderingServer.
Чтобы разместить в сцене, прикрепите эту мультисетку к экземпляру с помощью RenderingServer.InstanceSetBase, используя возвращенный RID.
Примечание: Эквивалентный ресурс — MultiMesh.
RidMultimeshGetAabbAabb
public static Aabb MultimeshGetAabb(Rid multimesh);Вычисляет и возвращает выровненную по осям ограничивающую рамку, которая охватывает все экземпляры внутри мультисетки.
| Имя | Тип | По умолчанию |
|---|---|---|
multimesh | Rid | — |
AabbMultimeshGetBufferfloat[]
public static float[] MultimeshGetBuffer(Rid multimesh);Возвращает данные MultiMesh (например, преобразования экземпляров, цвета и т. д.). Подробности о возвращаемых данных см. в RenderingServer.MultimeshSetBuffer.
Примечание: Если буфер находится во внутреннем кэше движка, его придется извлечь из памяти GPU и, возможно, распаковать. Это означает, что RenderingServer.MultimeshGetBuffer — потенциально медленная операция, и ее следует избегать, когда это возможно.
| Имя | Тип | По умолчанию |
|---|---|---|
multimesh | Rid | — |
float[]MultimeshGetBufferRdRidRid
public static Rid MultimeshGetBufferRdRid(Rid multimesh);Возвращает дескриптор RenderingDevice Rid MultiMesh, который можно использовать как любой другой буфер на устройстве рендеринга.
| Имя | Тип | По умолчанию |
|---|---|---|
multimesh | Rid | — |
RidMultimeshGetCommandBufferRdRidRid
public static Rid MultimeshGetCommandBufferRdRid(Rid multimesh);Возвращает дескриптор RenderingDevice Rid буфера команд MultiMesh. Этот Rid действителен только в том случае, если use_indirect установлен в true при выделении данных через RenderingServer.MultimeshAllocateData. Его можно использовать для прямого изменения количества экземпляров через буфер.
Структура данных зависит как от того, сколько поверхностей содержит сетка, так и от того, индексирована она или нет, в буфере есть 5 целых чисел, последнее из которых не используется, если сетка не индексирована.
Каждое из значений в буфере соответствует этим параметрам:
Indexed:
0 - indexCount;
1 - instanceCount;
2 - firstIndex;
3 - vertexOffset;
4 - firstInstance;
Non-indexed:
0 - vertexCount;
1 - instanceCount;
2 - firstVertex;
3 - firstInstance;
4 - unused;| Имя | Тип | По умолчанию |
|---|---|---|
multimesh | Rid | — |
RidMultimeshGetCustomAabbAabb
public static Aabb MultimeshGetCustomAabb(Rid multimesh);Возвращает пользовательский AABB, определенный для этого ресурса MultiMesh.
| Имя | Тип | По умолчанию |
|---|---|---|
multimesh | Rid | — |
AabbMultimeshGetInstanceCountint
public static int MultimeshGetInstanceCount(Rid multimesh);Возвращает количество экземпляров, выделенных для этой мультисетки.
| Имя | Тип | По умолчанию |
|---|---|---|
multimesh | Rid | — |
intMultimeshGetMeshRid
public static Rid MultimeshGetMesh(Rid multimesh);Возвращает RID сетки, которая будет использоваться при рисовании этой мультисетки.
| Имя | Тип | По умолчанию |
|---|---|---|
multimesh | Rid | — |
RidMultimeshGetVisibleInstancesint
public static int MultimeshGetVisibleInstances(Rid multimesh);Возвращает количество видимых экземпляров для этой мультисетки.
| Имя | Тип | По умолчанию |
|---|---|---|
multimesh | Rid | — |
intMultimeshInstanceGetColorColor
public static Color MultimeshInstanceGetColor(Rid multimesh, int index);Возвращает цвет, которым будет модулироваться указанный экземпляр.
| Имя | Тип | По умолчанию |
|---|---|---|
multimesh | Rid | — |
index | int | — |
ColorMultimeshInstanceGetCustomDataColor
public static Color MultimeshInstanceGetCustomData(Rid multimesh, int index);Возвращает пользовательские данные, связанные с указанным экземпляром.
| Имя | Тип | По умолчанию |
|---|---|---|
multimesh | Rid | — |
index | int | — |
ColorMultimeshInstanceGetTransformTransform3D
public static Transform3D MultimeshInstanceGetTransform(Rid multimesh, int index);Возвращает Transform3D указанного экземпляра.
| Имя | Тип | По умолчанию |
|---|---|---|
multimesh | Rid | — |
index | int | — |
Transform3DMultimeshInstanceGetTransform2DTransform2D
public static Transform2D MultimeshInstanceGetTransform2D(Rid multimesh, int index);Возвращает Transform2D указанного экземпляра. Для использования, когда мультисетка настроена на использование 2D-преобразований.
| Имя | Тип | По умолчанию |
|---|---|---|
multimesh | Rid | — |
index | int | — |
Transform2DMultimeshInstanceResetPhysicsInterpolationvoid
public static void MultimeshInstanceResetPhysicsInterpolation(Rid multimesh, int index);Предотвращает интерполяцию физики для указанного экземпляра в течение текущего такта физики. Это полезно при перемещении экземпляра в новое место, чтобы обеспечить мгновенное изменение, а не интерполяцию из предыдущего места.
| Имя | Тип | По умолчанию |
|---|---|---|
multimesh | Rid | — |
index | int | — |
MultimeshInstanceSetColorvoid
public static void MultimeshInstanceSetColor(Rid multimesh, int index, Color color);Устанавливает цвет, которым будет модулироваться этот экземпляр. Эквивалентно MultiMesh.SetInstanceColor.
| Имя | Тип | По умолчанию |
|---|---|---|
multimesh | Rid | — |
index | int | — |
color | Color | — |
MultimeshInstanceSetCustomDatavoid
public static void MultimeshInstanceSetCustomData(Rid multimesh, int index, Color customData);Устанавливает пользовательские данные для этого экземпляра. Пользовательские данные передаются как Color, но интерпретируются как vec4 в шейдере. Эквивалентно MultiMesh.SetInstanceCustomData.
| Имя | Тип | По умолчанию |
|---|---|---|
multimesh | Rid | — |
index | int | — |
customData | Color | — |
MultimeshInstanceSetTransformvoid
public static void MultimeshInstanceSetTransform(Rid multimesh, int index, Transform3D transform);Устанавливает Transform3D для этого экземпляра. Эквивалентно MultiMesh.SetInstanceTransform.
| Имя | Тип | По умолчанию |
|---|---|---|
multimesh | Rid | — |
index | int | — |
transform | Transform3D | — |
MultimeshInstanceSetTransform2Dvoid
public static void MultimeshInstanceSetTransform2D(Rid multimesh, int index, Transform2D transform);Устанавливает Transform2D для этого экземпляра. Для использования, когда multimesh используется в 2D. Эквивалентно MultiMesh.SetInstanceTransform2D.
| Имя | Тип | По умолчанию |
|---|---|---|
multimesh | Rid | — |
index | int | — |
transform | Transform2D | — |
MultimeshInstancesResetPhysicsInterpolationvoid
public static void MultimeshInstancesResetPhysicsInterpolation(Rid multimesh);Предотвращает интерполяцию физических параметров для всех экземпляров во время текущего физического цикла. Это полезно при перемещении всех экземпляров в новые места, чтобы обеспечить мгновенные изменения, а не интерполяцию от предыдущих местоположений.
| Имя | Тип | По умолчанию |
|---|---|---|
multimesh | Rid | — |
MultimeshSetBuffer2 перегрузки
public static void MultimeshSetBuffer(Rid multimesh, ReadOnlySpan<float> buffer);Установите все данные, которые будут использоваться для рисования multimesh сразу в buffer (например, преобразования экземпляров и цвета). Размер buffer должен соответствовать количеству экземпляров, умноженному на размер данных для каждого экземпляра (который зависит от включенных полей MultiMesh). В противном случае выводится сообщение об ошибке и ничего не отображается. См. также RenderingServer.MultimeshGetBuffer.
Размер данных для каждого экземпляра и ожидаемый порядок данных:
2D:
- Position: 8 floats (8 floats for Transform2D)
- Position + Vertex color: 12 floats (8 floats for Transform2D, 4 floats for Color)
- Position + Custom data: 12 floats (8 floats for Transform2D, 4 floats of custom data)
- Position + Vertex color + Custom data: 16 floats (8 floats for Transform2D, 4 floats for Color, 4 floats of custom data)
3D:
- Position: 12 floats (12 floats for Transform3D)
- Position + Vertex color: 16 floats (12 floats for Transform3D, 4 floats for Color)
- Position + Custom data: 16 floats (12 floats for Transform3D, 4 floats of custom data)
- Position + Vertex color + Custom data: 20 floats (12 floats for Transform3D, 4 floats for Color, 4 floats of custom data)Преобразования случаются в основном ряде, а именно:
- Для
Transform2D:: float- Заказ:(x.x, y.x, padding_float, origin.x, x.y, y.y, padding_float, origin.y). - Для
Transform3D:: float- Заказ:(basis.x.x, basis.y.x, basis.z.x, origin.x, basis.x.y, basis.y.y, basis.z.y, origin.y, basis.x.z, basis.y.z, basis.z.z, origin.z).
| Имя | Тип | По умолчанию |
|---|---|---|
multimesh | Rid | — |
buffer | ReadOnlySpan<float> | — |
public static void MultimeshSetBuffer(Rid multimesh, float[] buffer);Установите все данные, которые будут использоваться для рисования multimesh сразу в buffer (например, преобразования экземпляров и цвета). Размер buffer должен соответствовать количеству экземпляров, умноженному на размер данных для каждого экземпляра (который зависит от включенных полей MultiMesh). В противном случае выводится сообщение об ошибке и ничего не отображается. См. также RenderingServer.MultimeshGetBuffer.
Размер данных для каждого экземпляра и ожидаемый порядок данных:
2D:
- Position: 8 floats (8 floats for Transform2D)
- Position + Vertex color: 12 floats (8 floats for Transform2D, 4 floats for Color)
- Position + Custom data: 12 floats (8 floats for Transform2D, 4 floats of custom data)
- Position + Vertex color + Custom data: 16 floats (8 floats for Transform2D, 4 floats for Color, 4 floats of custom data)
3D:
- Position: 12 floats (12 floats for Transform3D)
- Position + Vertex color: 16 floats (12 floats for Transform3D, 4 floats for Color)
- Position + Custom data: 16 floats (12 floats for Transform3D, 4 floats of custom data)
- Position + Vertex color + Custom data: 20 floats (12 floats for Transform3D, 4 floats for Color, 4 floats of custom data)Преобразования случаются в основном ряде, а именно:
- Для
Transform2D:: float- Заказ:(x.x, y.x, padding_float, origin.x, x.y, y.y, padding_float, origin.y). - Для
Transform3D:: float- Заказ:(basis.x.x, basis.y.x, basis.z.x, origin.x, basis.x.y, basis.y.y, basis.z.y, origin.y, basis.x.z, basis.y.z, basis.z.z, origin.z).
| Имя | Тип | По умолчанию |
|---|---|---|
multimesh | Rid | — |
buffer | float[] | — |
MultimeshSetBufferInterpolated2 перегрузки
public static void MultimeshSetBufferInterpolated(Rid multimesh, ReadOnlySpan<float> buffer, ReadOnlySpan<float> bufferPrevious);Альтернативная версия RenderingServer.MultimeshSetBuffer для использования с интерполяцией физики.
Принимает как массив текущих данных, так и массив данных для предыдущего тика физики.
| Имя | Тип | По умолчанию |
|---|---|---|
multimesh | Rid | — |
buffer | ReadOnlySpan<float> | — |
bufferPrevious | ReadOnlySpan<float> | — |
public static void MultimeshSetBufferInterpolated(Rid multimesh, float[] buffer, float[] bufferPrevious);Альтернативная версия RenderingServer.MultimeshSetBuffer для использования с интерполяцией физики.
Принимает как массив текущих данных, так и массив данных для предыдущего тика физики.
| Имя | Тип | По умолчанию |
|---|---|---|
multimesh | Rid | — |
buffer | float[] | — |
bufferPrevious | float[] | — |
MultimeshSetCustomAabbvoid
public static void MultimeshSetCustomAabb(Rid multimesh, Aabb aabb);Устанавливает пользовательский AABB для этого ресурса MultiMesh.
| Имя | Тип | По умолчанию |
|---|---|---|
multimesh | Rid | — |
aabb | Aabb | — |
MultimeshSetMeshvoid
public static void MultimeshSetMesh(Rid multimesh, Rid mesh);Устанавливает сетку, которая будет отрисована мультисеткой. Эквивалентно MultiMesh.Mesh.
| Имя | Тип | По умолчанию |
|---|---|---|
multimesh | Rid | — |
mesh | Rid | — |
MultimeshSetPhysicsInterpolatedvoid
public static void MultimeshSetPhysicsInterpolated(Rid multimesh, bool interpolated);Включает и выключает физическую интерполяцию для этого ресурса MultiMesh.
| Имя | Тип | По умолчанию |
|---|---|---|
multimesh | Rid | — |
interpolated | bool | — |
MultimeshSetPhysicsInterpolationQualityvoid
public static void MultimeshSetPhysicsInterpolationQuality(Rid multimesh, RenderingServer.MultimeshPhysicsInterpolationQuality quality);Устанавливает качество интерполяции физики для MultiMesh.
Значение RenderingServer.MultimeshPhysicsInterpolationQuality.Fast дает быструю, но низкокачественную интерполяцию, значение RenderingServer.MultimeshPhysicsInterpolationQuality.High дает более медленную, но более качественную интерполяцию.
| Имя | Тип | По умолчанию |
|---|---|---|
multimesh | Rid | — |
quality | RenderingServer.MultimeshPhysicsInterpolationQuality | — |
MultimeshSetVisibleInstancesvoid
public static void MultimeshSetVisibleInstances(Rid multimesh, int visible);Устанавливает количество экземпляров, видимых в данный момент времени. Если -1, все выделенные экземпляры отрисовываются. Эквивалентно MultiMesh.VisibleInstanceCount.
| Имя | Тип | По умолчанию |
|---|---|---|
multimesh | Rid | — |
visible | int | — |
OccluderCreateRid
public static Rid OccluderCreate();Создает экземпляр occluder и добавляет его в RenderingServer. К нему можно получить доступ с помощью возвращаемого RID. Этот RID будет использоваться во всех функциях occluder_* RenderingServer.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer.FreeRid RenderingServer.
Примечание: Эквивалентный ресурс — Occluder3D (не путать с узлом OccluderInstance3D).
RidOccluderSetMesh2 перегрузки
public static void OccluderSetMesh(Rid occluder, Vector3[] vertices, int[] indices);Устанавливает данные сетки для заданного RID окклюдера, который управляет формой отбраковки окклюзии, которая будет выполнена.
| Имя | Тип | По умолчанию |
|---|---|---|
occluder | Rid | — |
vertices | Vector3[] | — |
indices | int[] | — |
public static void OccluderSetMesh(Rid occluder, ReadOnlySpan<Vector3> vertices, ReadOnlySpan<int> indices);Устанавливает данные сетки для заданного RID окклюдера, который управляет формой отбраковки окклюзии, которая будет выполнена.
| Имя | Тип | По умолчанию |
|---|---|---|
occluder | Rid | — |
vertices | ReadOnlySpan<Vector3> | — |
indices | ReadOnlySpan<int> | — |
OmniLightCreateRid
public static Rid OmniLightCreate();Создает новый источник света omni и добавляет его в RenderingServer. Доступ к нему можно получить с помощью возвращаемого RID. Этот RID можно использовать в большинстве функций RenderingServer light_*.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer RenderingServer.FreeRid.
Чтобы разместить в сцене, прикрепите этот источник света omni к экземпляру с помощью RenderingServer.InstanceSetBase, используя возвращаемый RID.
Примечание: Эквивалентный узел — OmniLight3D.
RidParticlesCollisionCreateRid
public static Rid ParticlesCollisionCreate();Создает новое столкновение или аттрактор частиц 3D GPU и добавляет его в RenderingServer. Доступ к нему можно получить с помощью возвращаемого RID. Этот RID можно использовать в большинстве функций particles_collision_* RenderingServer.
Примечание: Эквивалентными узлами являются GpuParticlesCollision3D и GpuParticlesAttractor3D.
RidParticlesCollisionHeightFieldUpdatevoid
public static void ParticlesCollisionHeightFieldUpdate(Rid particlesCollision);Запрашивает обновление для 3D GPU частица высота столкновения поля. Это может быть автоматически вызвано 3D GPU частица высота столкновения поля в зависимости от его GpuParticlesCollisionHeightField3D.UpdateMode.
| Имя | Тип | По умолчанию |
|---|---|---|
particlesCollision | Rid | — |
ParticlesCollisionSetAttractorAttenuationvoid
public static void ParticlesCollisionSetAttractorAttenuation(Rid particlesCollision, float curve);Устанавливает смягчение curve для 3D GPU-притягивающего устройства частиц, указанного particles_collision RID. Только для притягивающих, а не коллайдеров. GpuParticlesAttractor3D.Attenuation.
| Имя | Тип | По умолчанию |
|---|---|---|
particlesCollision | Rid | — |
curve | float | — |
ParticlesCollisionSetAttractorDirectionalityvoid
public static void ParticlesCollisionSetAttractorDirectionality(Rid particlesCollision, float amount);Устанавливает направление amount для 3D GPU-притягивающего устройства частиц, указанного particles_collision RID. Только для притягивающих, а не коллайдеров. GpuParticlesAttractor3D.Directionality.
| Имя | Тип | По умолчанию |
|---|---|---|
particlesCollision | Rid | — |
amount | float | — |
ParticlesCollisionSetAttractorStrengthvoid
public static void ParticlesCollisionSetAttractorStrength(Rid particlesCollision, float strength);Устанавливает strength для 3D GPU-притягивающего устройства частиц, указанного particles_collision RID. Только для притягивающих, а не коллайдеров. GpuParticlesAttractor3D.Strength.
| Имя | Тип | По умолчанию |
|---|---|---|
particlesCollision | Rid | — |
strength | float | — |
ParticlesCollisionSetBoxExtentsvoid
public static void ParticlesCollisionSetBoxExtents(Rid particlesCollision, Vector3 extents);Устанавливает extents для 3D столкновения частиц ПГУ с помощью particles_collision RID. Эквивалентность GpuParticlesCollisionBox3D.Size, GpuParticlesCollisionSdf3D.Size, GpuParticlesCollisionHeightField3D.Size, GpuParticlesAttractorBox3D.Size или GpuParticlesAttractorVectorField3D.Size в зависимости от particles_collision тип.
| Имя | Тип | По умолчанию |
|---|---|---|
particlesCollision | Rid | — |
extents | Vector3 | — |
ParticlesCollisionSetCollisionTypevoid
public static void ParticlesCollisionSetCollisionType(Rid particlesCollision, RenderingServer.ParticlesCollisionType type);Устанавливает форму столкновения или притяжения type для 3D столкновения частиц ГПСУ или их притяжения, указанных particles_collision RID.
| Имя | Тип | По умолчанию |
|---|---|---|
particlesCollision | Rid | — |
type | RenderingServer.ParticlesCollisionType | — |
ParticlesCollisionSetCullMaskvoid
public static void ParticlesCollisionSetCullMask(Rid particlesCollision, uint mask);Устанавливает клюв mask для 3D столкновения частиц ГПСУ или их притяжения, указанных particles_collision RID. Эквивалентность GpuParticlesCollision3D.CullMask или GpuParticlesAttractor3D.CullMask в зависимости от particles_collision тип.
| Имя | Тип | По умолчанию |
|---|---|---|
particlesCollision | Rid | — |
mask | uint | — |
ParticlesCollisionSetFieldTexturevoid
public static void ParticlesCollisionSetFieldTexture(Rid particlesCollision, Rid texture);Устанавливает поле подписанного расстояния texture для 3D столкновения частиц ГПСУ, указанных particles_collision RID. Эквивалентность GpuParticlesCollisionSdf3D.Texture или GpuParticlesAttractorVectorField3D.Texture в зависимости от particles_collision тип.
| Имя | Тип | По умолчанию |
|---|---|---|
particlesCollision | Rid | — |
texture | Rid | — |
ParticlesCollisionSetHeightFieldMaskvoid
public static void ParticlesCollisionSetHeightFieldMask(Rid particlesCollision, uint mask);Высотное поле mask для 3D столкновения частиц ГПС, указанных particles_collision RID. Эквивалентность GpuParticlesCollisionHeightField3D.HeightfieldMask.
| Имя | Тип | По умолчанию |
|---|---|---|
particlesCollision | Rid | — |
mask | uint | — |
ParticlesCollisionSetHeightFieldResolutionvoid
public static void ParticlesCollisionSetHeightFieldResolution(Rid particlesCollision, RenderingServer.ParticlesCollisionHeightfieldResolution resolution);Устанавливает карту высоты resolution для 3D столкновения частиц ГПС, указанных particles_collision RID. Эквивалентность GpuParticlesCollisionHeightField3D.Resolution.
| Имя | Тип | По умолчанию |
|---|---|---|
particlesCollision | Rid | — |
resolution | RenderingServer.ParticlesCollisionHeightfieldResolution | — |
ParticlesCollisionSetSphereRadiusvoid
public static void ParticlesCollisionSetSphereRadius(Rid particlesCollision, float radius);Устанавливает radius для трехмерного столкновения или притяжения частиц ГПС, указанных particles_collision RID. Эквивалентность GpuParticlesCollisionSphere3D.Radius или GpuParticlesAttractorSphere3D.Radius в зависимости от particles_collision тип.
| Имя | Тип | По умолчанию |
|---|---|---|
particlesCollision | Rid | — |
radius | float | — |
ParticlesCreateRid
public static Rid ParticlesCreate();Создает систему частиц на основе GPU и добавляет ее в RenderingServer. Доступ к ней можно получить с помощью возвращаемого RID. Этот RID будет использоваться во всех функциях RenderingServer particles_*.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer RenderingServer.FreeRid.
Чтобы разместить в сцене, прикрепите эти частицы к экземпляру с помощью RenderingServer.InstanceSetBase с помощью возвращаемого RID.
Примечание: Эквивалентные узлы — GpuParticles2D и GpuParticles3D.
Примечание: Все методы particles_* применяются только к частицам на основе GPU, а не к частицам на основе CPU. CpuParticles2D и CpuParticles3D не имеют эквивалентных функций RenderingServer, поскольку они используют MultiMeshInstance2D и MultiMeshInstance3D (см. методы multimesh_*).
RidParticlesEmitvoid
public static void ParticlesEmit(Rid particles, Transform3D transform, Vector3 velocity, Color color, Color custom, uint emitFlags);Ручно излучает частицы из particles пример.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
transform | Transform3D | — |
velocity | Vector3 | — |
color | Color | — |
custom | Color | — |
emitFlags | uint | — |
ParticlesGetCurrentAabbAabb
public static Aabb ParticlesGetCurrentAabb(Rid particles);Вычисляет и возвращает выровненный по осям ограничивающий прямоугольник, содержащий все частицы. Эквивалентно GpuParticles3D.CaptureAabb.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
AabbParticlesGetEmittingbool
public static bool ParticlesGetEmitting(Rid particles);Возвращает true, если частицы в данный момент настроены на излучение.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
boolParticlesIsInactivebool
public static bool ParticlesIsInactive(Rid particles);Возвращает true, если частицы не испускаются и частицы установлены в неактивное состояние.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
boolParticlesRequestProcessvoid
public static void ParticlesRequestProcess(Rid particles);Добавить систему частиц в список систем частиц, которые необходимо обновить. Обновление произойдет в следующем кадре или при следующем вызове RenderingServer.InstancesCullAabb, RenderingServer.InstancesCullConvex или RenderingServer.InstancesCullRay.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
ParticlesRequestProcessTime2 перегрузки
public static void ParticlesRequestProcessTime(Rid particles, float processTime);Запрашивает у частиц дополнительное время обработки в течение одного кадра.
process_time определяет время, в течение которого частицы будут обрабатываться при включенной эмиссии. process_time_residual определяет время, в течение которого частицы будут обрабатываться с выключенной эмиссией для симуляции. В сочетании с масштабом скорости частиц, установленным в 0.0, это полезно для возможности перемещения по временной шкале системы частиц.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
processTime | float | — |
public static void ParticlesRequestProcessTime(Rid particles, float processTime, float processTimeResidual = 0f);Запрашивает у частиц дополнительное время обработки в течение одного кадра.
process_time определяет время, в течение которого частицы будут обрабатываться при включенной эмиссии. process_time_residual определяет время, в течение которого частицы будут обрабатываться с выключенной эмиссией для симуляции. В сочетании с масштабом скорости частиц, установленным в 0.0, это полезно для возможности перемещения по временной шкале системы частиц.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
processTime | float | — |
processTimeResidual | float | 0f |
ParticlesRestartvoid
public static void ParticlesRestart(Rid particles);Сбросить частицы при следующем обновлении. Эквивалентно GpuParticles3D.Restart.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
ParticlesSetAmountvoid
public static void ParticlesSetAmount(Rid particles, int amount);Устанавливает количество частиц для рисования и выделяет для них память. Эквивалентно GpuParticles3D.Amount.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
amount | int | — |
ParticlesSetAmountRatiovoid
public static void ParticlesSetAmountRatio(Rid particles, float ratio);Устанавливает соотношение количества испускаемых частиц. Эквивалентно GpuParticles3D.AmountRatio.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
ratio | float | — |
ParticlesSetCollisionBaseSizevoid
public static void ParticlesSetCollisionBaseSize(Rid particles, float size);Устанавливает базовый размер для столкновений частиц. Эквивалентно GpuParticles3D.CollisionBaseSize.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
size | float | — |
ParticlesSetCustomAabbvoid
public static void ParticlesSetCustomAabb(Rid particles, Aabb aabb);Устанавливает пользовательский ограничивающий прямоугольник, выровненный по осям, для системы частиц. Эквивалентно GpuParticles3D.VisibilityAabb.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
aabb | Aabb | — |
ParticlesSetDrawOrdervoid
public static void ParticlesSetDrawOrder(Rid particles, RenderingServer.ParticlesDrawOrder order);Устанавливает порядок отрисовки частиц. Эквивалентно GpuParticles3D.DrawOrder.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
order | RenderingServer.ParticlesDrawOrder | — |
ParticlesSetDrawPassMeshvoid
public static void ParticlesSetDrawPassMesh(Rid particles, int pass, Rid mesh);Устанавливает сетку, которая будет использоваться для указанного прохода отрисовки. Эквивалентно GpuParticles3D.DrawPass1, GpuParticles3D.DrawPass2, GpuParticles3D.DrawPass3 и GpuParticles3D.DrawPass4.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
pass | int | — |
mesh | Rid | — |
ParticlesSetDrawPassesvoid
public static void ParticlesSetDrawPasses(Rid particles, int count);Устанавливает количество используемых проходов отрисовки. Эквивалентно GpuParticles3D.DrawPasses.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
count | int | — |
ParticlesSetEmissionTransformvoid
public static void ParticlesSetEmissionTransform(Rid particles, Transform3D transform);Устанавливает Transform3D, который будет использоваться частицами при первом излучении.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
transform | Transform3D | — |
ParticlesSetEmitterVelocityvoid
public static void ParticlesSetEmitterVelocity(Rid particles, Vector3 velocity);Устанавливает скорость узла частицы, которая будет использоваться ParticleProcessMaterial.InheritVelocityRatio.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
velocity | Vector3 | — |
ParticlesSetEmittingvoid
public static void ParticlesSetEmitting(Rid particles, bool emitting);Если true, частицы будут испускаться с течением времени. Установка false не сбрасывает частицы, а только останавливает их испускание. Эквивалентно GpuParticles3D.Emitting.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
emitting | bool | — |
ParticlesSetExplosivenessRatiovoid
public static void ParticlesSetExplosivenessRatio(Rid particles, float ratio);Устанавливает коэффициент взрывоопасности. Эквивалентно GpuParticles3D.Explosiveness.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
ratio | float | — |
ParticlesSetFixedFpsvoid
public static void ParticlesSetFixedFps(Rid particles, int fps);Устанавливает частоту кадров, на которой будет зафиксирован рендеринг системы частиц. Эквивалентно GpuParticles3D.FixedFps.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
fps | int | — |
ParticlesSetFractionalDeltavoid
public static void ParticlesSetFractionalDelta(Rid particles, bool enable);Если true, используется дробная дельта, которая сглаживает движение частиц. Эквивалентно GpuParticles3D.FractDelta.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
enable | bool | — |
ParticlesSetInterpToEndvoid
public static void ParticlesSetInterpToEnd(Rid particles, float factor);Устанавливает значение, сообщающее ParticleProcessMaterial о необходимости ускорить движение всех частиц к концу их жизненного цикла.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
factor | float | — |
ParticlesSetInterpolatevoid
public static void ParticlesSetInterpolate(Rid particles, bool enable);Устанавливает, должны ли частицы использовать интерполяцию между фиксированными шагами. Эквивалентно GpuParticles3D.Interpolate.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
enable | bool | — |
ParticlesSetLifetimevoid
public static void ParticlesSetLifetime(Rid particles, double lifetime);Устанавливает время жизни каждой частицы в системе. Эквивалентно GpuParticles3D.Lifetime.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
lifetime | double | — |
ParticlesSetModevoid
public static void ParticlesSetMode(Rid particles, RenderingServer.ParticlesMode mode);Устанавливает, являются ли частицы GPU, указанные particles RID должны быть представлены в 2D или 3D согласно mode.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
mode | RenderingServer.ParticlesMode | — |
ParticlesSetOneShotvoid
public static void ParticlesSetOneShot(Rid particles, bool oneShot);Если true, частицы испустят один раз и затем остановятся. Эквивалентно GpuParticles3D.OneShot.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
oneShot | bool | — |
ParticlesSetPreProcessTimevoid
public static void ParticlesSetPreProcessTime(Rid particles, double time);Устанавливает время предварительной обработки для анимации частиц. Это позволяет отложить запуск анимации до тех пор, пока частицы не начнут испускать свет. Эквивалентно GpuParticles3D.Preprocess.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
time | double | — |
ParticlesSetProcessMaterialvoid
public static void ParticlesSetProcessMaterial(Rid particles, Rid material);Устанавливает материал для обработки частиц.
Примечание: Это не материал, используемый для рисования материалов. Эквивалентно GpuParticles3D.ProcessMaterial.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
material | Rid | — |
ParticlesSetRandomnessRatiovoid
public static void ParticlesSetRandomnessRatio(Rid particles, float ratio);Устанавливает коэффициент случайности эмиссии. Это рандомизирует эмиссию частиц в пределах их фазы. Эквивалентно GpuParticles3D.Randomness.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
ratio | float | — |
ParticlesSetSpeedScalevoid
public static void ParticlesSetSpeedScale(Rid particles, double scale);Устанавливает шкалу скорости системы частиц. Эквивалентно GpuParticles3D.SpeedScale.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
scale | double | — |
ParticlesSetSubemittervoid
public static void ParticlesSetSubemitter(Rid particles, Rid subemitterParticles);Задает субэмиттерные частицы для системы частиц. Эквивалентно GpuParticles3D.SubEmitter.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
subemitterParticles | Rid | — |
ParticlesSetTrailBindPosesvoid
public static void ParticlesSetTrailBindPoses(Rid particles, Reckfell.Collections.Array<Transform3D> bindPoses);Задает позы привязки траектории для системы частиц. Это задается в виде массива Transform3D, представляющих позу привязки для каждого прохода отрисовки. См. GpuParticles3D.DrawSkin, Skin.GetBindCount и Skin.GetBindPose. Установите значение для каждого прохода отрисовки равным Transform3D.Identity, чтобы использовать поведение по умолчанию, которое используется во встроенных траекториях (RibbonTrailMesh и TubeTrailMesh).
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
bindPoses | Reckfell.Collections.Array<Transform3D> | — |
ParticlesSetTrailsvoid
public static void ParticlesSetTrails(Rid particles, bool enable, float lengthSec);Если enable это true, позволяет прокладывать следы particles указанными length_sec Эквивалентность в секундах GpuParticles3D.TrailEnabled и GpuParticles3D.TrailLifetime.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
enable | bool | — |
lengthSec | float | — |
ParticlesSetTransformAlignvoid
public static void ParticlesSetTransformAlign(Rid particles, RenderingServer.ParticlesTransformAlign align);Задает выравнивание преобразования для системы частиц. Эквивалентно GpuParticles3D.TransformAlign.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
align | RenderingServer.ParticlesTransformAlign | — |
ParticlesSetTransformAlignAxisvoid
public static void ParticlesSetTransformAlignAxis(Rid particles, RenderingServer.ParticlesTransformAlignAxis rotationAxis);Задает, какую ось использовать для выравнивания преобразования.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
rotationAxis | RenderingServer.ParticlesTransformAlignAxis | — |
ParticlesSetTransformAlignChannelFiltervoid
public static void ParticlesSetTransformAlignChannelFilter(Rid particles, RenderingServer.ParticlesTransformAlignCustomSrc channelFilter);При использовании Z-Billboarding метода, который пользовательский канал используется для чтения.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
channelFilter | RenderingServer.ParticlesTransformAlignCustomSrc | — |
ParticlesSetUseLocalCoordinatesvoid
public static void ParticlesSetUseLocalCoordinates(Rid particles, bool enable);Если true, частицы используют локальные координаты. Если false, они используют глобальные координаты. Эквивалентно GpuParticles3D.LocalCoords.
| Имя | Тип | По умолчанию |
|---|---|---|
particles | Rid | — |
enable | bool | — |
PositionalSoftShadowFilterSetQualityvoid
public static void PositionalSoftShadowFilterSetQuality(RenderingServer.ShadowQuality quality);Устанавливает качество фильтра для теней точечного и всенаправленного света в 3D. См. также ProjectSettings.rendering/lights_and_shadows/positional_shadow/soft_shadow_filter_quality. Этот параметр является глобальным и не может быть установлен для каждого окна просмотра.
| Имя | Тип | По умолчанию |
|---|---|---|
quality | RenderingServer.ShadowQuality | — |
ReflectionProbeCreateRid
public static Rid ReflectionProbeCreate();Создает зонд отражения и добавляет его в RenderingServer. К нему можно получить доступ с помощью возвращаемого RID. Этот RID будет использоваться во всех функциях RenderingServer reflection_probe_*.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer.FreeRid RenderingServer.
Чтобы разместить в сцене, прикрепите этот зонд отражения к экземпляру с помощью RenderingServer.InstanceSetBase с помощью возвращаемого RID.
Примечание: Эквивалентный узел — ReflectionProbe.
RidReflectionProbeSetAmbientColorvoid
public static void ReflectionProbeSetAmbientColor(Rid probe, Color color);Устанавливает пользовательский цвет окружающего света отражательного зонда. Эквивалентно ReflectionProbe.AmbientColor.
| Имя | Тип | По умолчанию |
|---|---|---|
probe | Rid | — |
color | Color | — |
ReflectionProbeSetAmbientEnergyvoid
public static void ReflectionProbeSetAmbientEnergy(Rid probe, float energy);Устанавливает пользовательскую энергию окружающего света отражательного зонда. Эквивалентно ReflectionProbe.AmbientColorEnergy.
| Имя | Тип | По умолчанию |
|---|---|---|
probe | Rid | — |
energy | float | — |
ReflectionProbeSetAmbientModevoid
public static void ReflectionProbeSetAmbientMode(Rid probe, RenderingServer.ReflectionProbeAmbientMode mode);Устанавливает режим окружающего освещения отражательного зонда. Эквивалентно ReflectionProbe.AmbientMode.
| Имя | Тип | По умолчанию |
|---|---|---|
probe | Rid | — |
mode | RenderingServer.ReflectionProbeAmbientMode | — |
ReflectionProbeSetAsInteriorvoid
public static void ReflectionProbeSetAsInterior(Rid probe, bool enable);Если true, отражения будут игнорировать вклад неба. Эквивалентно ReflectionProbe.Interior.
| Имя | Тип | По умолчанию |
|---|---|---|
probe | Rid | — |
enable | bool | — |
ReflectionProbeSetBlendDistancevoid
public static void ReflectionProbeSetBlendDistance(Rid probe, float blendDistance);Устанавливает расстояние в метрах, на котором зонд сливается с сценой.
| Имя | Тип | По умолчанию |
|---|---|---|
probe | Rid | — |
blendDistance | float | — |
ReflectionProbeSetCullMaskvoid
public static void ReflectionProbeSetCullMask(Rid probe, uint layers);Устанавливает маску отбраковки рендера для этого зонда отражения. Только экземпляры с соответствующим слоем будут отражены этим зондом. Эквивалентно ReflectionProbe.CullMask.
| Имя | Тип | По умолчанию |
|---|---|---|
probe | Rid | — |
layers | uint | — |
ReflectionProbeSetEnableBoxProjectionvoid
public static void ReflectionProbeSetEnableBoxProjection(Rid probe, bool enable);Если true, используется проекционный блок. Это может сделать отражения более корректными в определенных ситуациях. Эквивалентно ReflectionProbe.BoxProjection.
| Имя | Тип | По умолчанию |
|---|---|---|
probe | Rid | — |
enable | bool | — |
ReflectionProbeSetEnableShadowsvoid
public static void ReflectionProbeSetEnableShadows(Rid probe, bool enable);Если true, вычисляет тени в зонде отражения. Это делает отражение намного медленнее для вычисления. Эквивалентно ReflectionProbe.EnableShadows.
| Имя | Тип | По умолчанию |
|---|---|---|
probe | Rid | — |
enable | bool | — |
ReflectionProbeSetIntensityvoid
public static void ReflectionProbeSetIntensity(Rid probe, float intensity);Устанавливает интенсивность зонда отражения. Интенсивность модулирует силу отражения. Эквивалентно ReflectionProbe.Intensity.
| Имя | Тип | По умолчанию |
|---|---|---|
probe | Rid | — |
intensity | float | — |
ReflectionProbeSetMaxDistancevoid
public static void ReflectionProbeSetMaxDistance(Rid probe, float distance);Устанавливает максимальное расстояние от зонда, на котором может находиться объект, прежде чем он будет отбракован. Эквивалентно ReflectionProbe.MaxDistance.
| Имя | Тип | По умолчанию |
|---|---|---|
probe | Rid | — |
distance | float | — |
ReflectionProbeSetMeshLodThresholdvoid
public static void ReflectionProbeSetMeshLodThreshold(Rid probe, float pixels);Устанавливает уровень детализации сетки для использования при рендеринге зонда отражения. Более высокие значения будут использовать менее подробные версии сеток, которые имеют сгенерированные вариации LOD, что может улучшить производительность. Эквивалентно ReflectionProbe.MeshLodThreshold.
| Имя | Тип | По умолчанию |
|---|---|---|
probe | Rid | — |
pixels | float | — |
ReflectionProbeSetOriginOffsetvoid
public static void ReflectionProbeSetOriginOffset(Rid probe, Vector3 offset);Устанавливает смещение начала координат, которое будет использоваться, когда этот зонд отражения находится в режиме проекции ящика. Эквивалентно ReflectionProbe.OriginOffset.
| Имя | Тип | По умолчанию |
|---|---|---|
probe | Rid | — |
offset | Vector3 | — |
ReflectionProbeSetReflectionMaskvoid
public static void ReflectionProbeSetReflectionMask(Rid probe, uint layers);Устанавливает маску отражения рендеринга для этого зонда отражения. Только экземпляры с соответствующим слоем будут иметь отражения, примененные от этого зонда. Эквивалентно ReflectionProbe.ReflectionMask.
| Имя | Тип | По умолчанию |
|---|---|---|
probe | Rid | — |
layers | uint | — |
ReflectionProbeSetResolutionvoid · Устарело
public static void ReflectionProbeSetResolution(Rid probe, int resolution);Устарело. Этот метод ничего не делает.
| Имя | Тип | По умолчанию |
|---|---|---|
probe | Rid | — |
resolution | int | — |
ReflectionProbeSetSizevoid
public static void ReflectionProbeSetSize(Rid probe, Vector3 size);Устанавливает размер области, которую будет захватывать отражательный зонд. Эквивалентно ReflectionProbe.Size.
| Имя | Тип | По умолчанию |
|---|---|---|
probe | Rid | — |
size | Vector3 | — |
ReflectionProbeSetUpdateModevoid
public static void ReflectionProbeSetUpdateMode(Rid probe, RenderingServer.ReflectionProbeUpdateMode mode);Устанавливает частоту обновления зонда отражения. Может быть один раз или каждый кадр.
| Имя | Тип | По умолчанию |
|---|---|---|
probe | Rid | — |
mode | RenderingServer.ReflectionProbeUpdateMode | — |
RequestFrameDrawnCallbackvoid
public static void RequestFrameDrawnCallback(Callable callable);Планирует обратный вызов указанного вызываемого объекта после отрисовки кадра.
| Имя | Тип | По умолчанию |
|---|---|---|
callable | Callable | — |
ScenarioCreateRid
public static Rid ScenarioCreate();Создает сценарий и добавляет его в RenderingServer. К нему можно получить доступ с помощью возвращаемого RID. Этот RID будет использоваться во всех функциях scenario_* RenderingServer.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer.FreeRid RenderingServer.
Сценарий — это трехмерный мир, в котором существуют все визуальные экземпляры.
RidScenarioSetCameraAttributesvoid
public static void ScenarioSetCameraAttributes(Rid scenario, Rid effects);Устанавливает атрибуты камеры (effects), которые будут использоваться с этим сценарием. См. также CameraAttributes.
| Имя | Тип | По умолчанию |
|---|---|---|
scenario | Rid | — |
effects | Rid | — |
ScenarioSetCompositorvoid
public static void ScenarioSetCompositor(Rid scenario, Rid compositor);Устанавливает композитор (compositor), который будет использоваться с этим сценарием. См. также Compositor.
| Имя | Тип | По умолчанию |
|---|---|---|
scenario | Rid | — |
compositor | Rid | — |
ScenarioSetEnvironmentvoid
public static void ScenarioSetEnvironment(Rid scenario, Rid environment);Устанавливает среду, которая будет использоваться с этим сценарием. См. также Environment.
| Имя | Тип | По умолчанию |
|---|---|---|
scenario | Rid | — |
environment | Rid | — |
ScenarioSetFallbackEnvironmentvoid
public static void ScenarioSetFallbackEnvironment(Rid scenario, Rid environment);Устанавливает резервную среду для использования этим сценарием. Резервная среда используется, если среда не установлена. Внутри редактора это используется для предоставления среды по умолчанию.
| Имя | Тип | По умолчанию |
|---|---|---|
scenario | Rid | — |
environment | Rid | — |
ScreenSpaceRoughnessLimiterSetActivevoid
public static void ScreenSpaceRoughnessLimiterSetActive(bool enable, float amount, float limit);Устанавливает параметры ограничителя шероховатости экранного пространства, например, следует ли его включать и его пороговые значения. Эквивалентно ProjectSettings.rendering/anti_aliasing/screen_space_roughness_limiter/enabled, ProjectSettings.rendering/anti_aliasing/screen_space_roughness_limiter/amount и ProjectSettings.rendering/anti_aliasing/screen_space_roughness_limiter/limit.
| Имя | Тип | По умолчанию |
|---|---|---|
enable | bool | — |
amount | float | — |
limit | float | — |
SetBootImagevoid · Устарело
public static void SetBootImage(Image image, Color color, bool scale, bool useFilter = true);Задает загрузочное изображение. Параметр color определяет цвет фона. Значение параметра scale указывает, будет ли изображение масштабироваться под размер экрана. Если use_filter равно true, изображение будет масштабироваться с помощью линейной интерполяции. Если use_filter равно false, изображение будет масштабироваться с помощью интерполяции методом ближайшего соседа.
| Имя | Тип | По умолчанию |
|---|---|---|
image | Image | — |
color | Color | — |
scale | bool | — |
useFilter | bool | true |
SetBootImageWithStretchvoid
public static void SetBootImageWithStretch(Image image, Color color, RenderingServer.SplashStretchMode stretchMode, bool useFilter = true);Задает загрузочное изображение. Параметр color определяет цвет фона. Значение параметра stretch_mode указывает, как будет растягиваться изображение (см. RenderingServer.SplashStretchMode для возможных значений). Если use_filter равно true, изображение будет масштабироваться с помощью линейной интерполяции. Если use_filter равно false, изображение будет масштабироваться с помощью интерполяции методом ближайшего соседа.
| Имя | Тип | По умолчанию |
|---|---|---|
image | Image | — |
color | Color | — |
stretchMode | RenderingServer.SplashStretchMode | — |
useFilter | bool | true |
SetDebugGenerateWireframesvoid
public static void SetDebugGenerateWireframes(bool generate);Если generate имеет значение true, генерируются отладочные каркасы для всех мешей, загружаемых при использовании рендерера совместимости. По умолчанию движок не генерирует отладочные каркасы во время выполнения, поскольку они замедляют загрузку ресурсов и занимают видеопамять.
Примечание: Необходимо вызвать этот метод перед загрузкой любых мешей при использовании рендерера совместимости. В противном случае каркасы использоваться не будут.
| Имя | Тип | По умолчанию |
|---|---|---|
generate | bool | — |
SetDefaultClearColorvoid
public static void SetDefaultClearColor(Color color);Устанавливает цвет очистки по умолчанию, который используется, когда не выбран определенный цвет очистки. См. также RenderingServer.GetDefaultClearColor.
| Имя | Тип | По умолчанию |
|---|---|---|
color | Color | — |
SetRenderLoopEnabledvoid
public static void SetRenderLoopEnabled(bool enabled);| Имя | Тип | По умолчанию |
|---|---|---|
enabled | bool | — |
ShaderCreateRid
public static Rid ShaderCreate();Создает пустой шейдер и добавляет его в RenderingServer. К нему можно получить доступ с помощью возвращаемого RID. Этот RID будет использоваться во всех функциях shader_* RenderingServer.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer.FreeRid RenderingServer.
Примечание: Эквивалентный ресурс — Shader.
RidShaderGetCodestring
public static string ShaderGetCode(Rid shader);Возвращает исходный код шейдера в виде строки.
| Имя | Тип | По умолчанию |
|---|---|---|
shader | Rid | — |
stringShaderGetDefaultTextureParameterRid
public static Rid ShaderGetDefaultTextureParameter(Rid shader, StringName name, int index = 0);Возвращает текстуру по умолчанию из шейдера, найденного по имени.
Примечание: Если используется массив сэмплера, используйте index для доступа к указанной текстуре.
| Имя | Тип | По умолчанию |
|---|---|---|
shader | Rid | — |
name | StringName | — |
index | int | 0 |
RidShaderGetParameterDefaultVariant
public static Variant ShaderGetParameterDefault(Rid shader, StringName name);Возвращает значение по умолчанию для указанного шейдера uniform. Обычно это значение, записанное в исходном коде шейдера.
| Имя | Тип | По умолчанию |
|---|---|---|
shader | Rid | — |
name | StringName | — |
VariantShaderSetCodevoid
public static void ShaderSetCode(Rid shader, string code);Устанавливает исходный код шейдера (который запускает перекомпиляцию после изменения).
| Имя | Тип | По умолчанию |
|---|---|---|
shader | Rid | — |
code | string | — |
ShaderSetDefaultTextureParametervoid
public static void ShaderSetDefaultTextureParameter(Rid shader, StringName name, Rid texture, int index = 0);Низкоуровневое назначение default-текстуры Shader по RenderingServer RID. Не является SetShaderParameter конкретного материала. Текстура должна принадлежать RenderingServer, не локальному RenderingDevice. Пустой RID снимает запись индекса. Управляйте временем жизни ресурсов; обычному коду удобнее Shader.SetDefaultTextureParameter с Texture.
| Имя | Тип | По умолчанию |
|---|---|---|
shader | Rid | — |
name | StringName | — |
texture | Rid | — |
index | int | 0 |
shaderRID живого Shader, не ShaderMaterial.
nameИмя sampler uniform.
textureRID подходящей текстуры или пустой RID для снятия.
indexИндекс элемента sampler-массива, обычно 0.
ShaderSetPathHintvoid
public static void ShaderSetPathHint(Rid shader, string path);Устанавливает подсказку пути для указанного шейдера. Это должно, как правило, соответствовать Resource.ResourcePath ресурса Shader.
| Имя | Тип | По умолчанию |
|---|---|---|
shader | Rid | — |
path | string | — |
SkeletonAllocateDatavoid
public static void SkeletonAllocateData(Rid skeleton, int bones, bool is2DSkeleton = false);Выделяет данные для этого скелета, используя количество костей, указанное в bones. Если is_2d_skeleton имеет значение true, скелет будет рассматриваться как 2D, а не 3D. См. также RenderingServer.SkeletonGetBoneCount.
| Имя | Тип | По умолчанию |
|---|---|---|
skeleton | Rid | — |
bones | int | — |
is2DSkeleton | bool | false |
SkeletonBoneGetTransformTransform3D
public static Transform3D SkeletonBoneGetTransform(Rid skeleton, int bone);Возвращает набор Transform3D для определенной кости этого скелета.
| Имя | Тип | По умолчанию |
|---|---|---|
skeleton | Rid | — |
bone | int | — |
Transform3DSkeletonBoneGetTransform2DTransform2D
public static Transform2D SkeletonBoneGetTransform2D(Rid skeleton, int bone);Возвращает набор Transform2D для определенной кости этого скелета.
| Имя | Тип | По умолчанию |
|---|---|---|
skeleton | Rid | — |
bone | int | — |
Transform2DSkeletonBoneSetTransformvoid
public static void SkeletonBoneSetTransform(Rid skeleton, int bone, Transform3D transform);Устанавливает Transform3D для определенной кости этого скелета.
| Имя | Тип | По умолчанию |
|---|---|---|
skeleton | Rid | — |
bone | int | — |
transform | Transform3D | — |
SkeletonBoneSetTransform2Dvoid
public static void SkeletonBoneSetTransform2D(Rid skeleton, int bone, Transform2D transform);Устанавливает Transform2D для определенной кости этого скелета.
| Имя | Тип | По умолчанию |
|---|---|---|
skeleton | Rid | — |
bone | int | — |
transform | Transform2D | — |
SkeletonCreateRid
public static Rid SkeletonCreate();Создает скелет и добавляет его в RenderingServer. К нему можно получить доступ с помощью возвращаемого RID. Этот RID будет использоваться во всех функциях skeleton_* RenderingServer.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer.FreeRid RenderingServer.
RidSkeletonGetBoneCountint
public static int SkeletonGetBoneCount(Rid skeleton);Возвращает количество костей, выделенных для этого скелета. См. также RenderingServer.SkeletonAllocateData.
| Имя | Тип | По умолчанию |
|---|---|---|
skeleton | Rid | — |
intSkeletonSetBaseTransform2Dvoid
public static void SkeletonSetBaseTransform2D(Rid skeleton, Transform2D baseTransform);Задает базовое значение Transform2D, используемое для указанного скелета.
| Имя | Тип | По умолчанию |
|---|---|---|
skeleton | Rid | — |
baseTransform | Transform2D | — |
SkyBakePanoramaImage
public static Image SkyBakePanorama(Rid sky, float energy, bool bakeIrradiance, Vector2I size);Читает подготовленную radiance-карту Sky как панораму Image указанного размера. Перед вызовом дайте активному окружению создать/обновить карту. В текущем RD отсутствие готовой radiance даёт null; вызов не является заменой настройки Sky или рендеринга кадра. Чтение с GPU имеет стоимость; не выполняйте его каждый кадр. Освободите принадлежащий вызывающему Image после использования.
| Имя | Тип | По умолчанию |
|---|---|---|
sky | Rid | — |
energy | float | — |
bakeIrradiance | bool | — |
size | Vector2I | — |
skyRID живого ресурса Sky; не Environment и не Shader.
energyМножитель RGB результата; в проверке 1.
bakeIrradiancetrue — использовать вариант свёртки irradiance, false — radiance. Отдельно проверен вариант false.
sizeПоложительные ширина и высота Image, например 64×32.
ImageНовый Image панорамы либо null, если карта недоступна.
SkyCreateRid
public static Rid SkyCreate();Создает пустое небо и добавляет его в RenderingServer. К нему можно получить доступ с помощью возвращаемого RID. Этот RID будет использоваться во всех функциях sky_* RenderingServer.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer.FreeRid RenderingServer.
RidSkySetMaterialvoid
public static void SkySetMaterial(Rid sky, Rid material);Устанавливает материал, который небо использует для визуализации фона, карт окружения и отражений.
| Имя | Тип | По умолчанию |
|---|---|---|
sky | Rid | — |
material | Rid | — |
SkySetModevoid
public static void SkySetMode(Rid sky, RenderingServer.SkyMode mode);Устанавливает процесс mode неба, указанного RID sky. Эквивалентно Sky.ProcessMode.
| Имя | Тип | По умолчанию |
|---|---|---|
sky | Rid | — |
mode | RenderingServer.SkyMode | — |
SkySetRadianceSizevoid
public static void SkySetRadianceSize(Rid sky, int radianceSize);Устанавливает radiance_size неба, указанного в sky RID (в пикселях). Эквивалентно Sky.RadianceSize.
| Имя | Тип | По умолчанию |
|---|---|---|
sky | Rid | — |
radianceSize | int | — |
SpotLightCreateRid
public static Rid SpotLightCreate();Создает точечный источник света и добавляет его в RenderingServer. К нему можно получить доступ с помощью возвращаемого RID. Этот RID можно использовать в большинстве функций light_* RenderingServer.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer.FreeRid RenderingServer.
Чтобы разместить в сцене, прикрепите этот точечный источник света к экземпляру с помощью RenderingServer.InstanceSetBase, используя возвращаемый RID.
RidSubSurfaceScatteringSetQualityvoid
public static void SubSurfaceScatteringSetQuality(RenderingServer.SubSurfaceScatteringQuality quality);Устанавливает ProjectSettings.rendering/environment/subsurface_scattering/subsurface_scattering_quality для использования при рендеринге материалов, в которых включено подповерхностное рассеивание.
| Имя | Тип | По умолчанию |
|---|---|---|
quality | RenderingServer.SubSurfaceScatteringQuality | — |
SubSurfaceScatteringSetScalevoid
public static void SubSurfaceScatteringSetScale(float scale, float depthScale);Задает ProjectSettings.rendering/environment/subsurface_scattering/subsurface_scattering_scale и ProjectSettings.rendering/environment/subsurface_scattering/subsurface_scattering_depth_scale для использования при рендеринге материалов, в которых включено подповерхностное рассеивание.
| Имя | Тип | По умолчанию |
|---|---|---|
scale | float | — |
depthScale | float | — |
Texture2DCreateRid
public static Rid Texture2DCreate(Image image);Создает 2-мерную текстуру и добавляет ее в RenderingServer. Доступ к ней можно получить с помощью возвращаемого RID. Этот RID будет использоваться во всех функциях RenderingServer texture_2d_*.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer.FreeRid RenderingServer.
Примечание: Эквивалентный ресурс — Texture2D.
Примечание: Не путать с RenderingDevice.TextureCreate, который создает собственный тип текстуры графического API в отличие от специфичного для Reckfell ресурса Texture2D.
| Имя | Тип | По умолчанию |
|---|---|---|
image | Image | — |
RidTexture2DGetImage
public static Image Texture2DGet(Rid texture);Возвращает экземпляр Image из заданного texture Rid.
Пример: Получите тестовую текстуру из RenderingServer.GetTestTexture и примените ее к узлу Sprite2D:
| Имя | Тип | По умолчанию |
|---|---|---|
texture | Rid | — |
ImageTexture2DLayerGetImage
public static Image Texture2DLayerGet(Rid texture, int layer);Возвращает экземпляр Image из заданных texture Rid и layer.
| Имя | Тип | По умолчанию |
|---|---|---|
texture | Rid | — |
layer | int | — |
ImageTexture2DLayeredCreateRid
public static Rid Texture2DLayeredCreate(Reckfell.Collections.Array<Image> layers, RenderingServer.TextureLayeredType layeredType);Создает 2-мерную многослойную текстуру и добавляет ее в RenderingServer. Доступ к ней можно получить с помощью возвращаемого RID. Этот RID будет использоваться во всех функциях RenderingServer texture_2d_layered_*.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer RenderingServer.FreeRid.
Примечание: Эквивалентный ресурс — TextureLayered.
| Имя | Тип | По умолчанию |
|---|---|---|
layers | Reckfell.Collections.Array<Image> | — |
layeredType | RenderingServer.TextureLayeredType | — |
RidTexture2DLayeredPlaceholderCreateRid
public static Rid Texture2DLayeredPlaceholderCreate(RenderingServer.TextureLayeredType layeredType);Создает заполнитель для двухмерной многослойной текстуры и добавляет его в RenderingServer. Доступ к нему можно получить с помощью возвращаемого RID. Этот RID будет использоваться во всех функциях RenderingServer texture_2d_layered_*, хотя при использовании он ничего не делает. См. также RenderingServer.Texture2DPlaceholderCreate.
Примечание: Эквивалентный ресурс — PlaceholderTextureLayered.
| Имя | Тип | По умолчанию |
|---|---|---|
layeredType | RenderingServer.TextureLayeredType | — |
RidTexture2DPlaceholderCreateRid
public static Rid Texture2DPlaceholderCreate();Создает заполнитель для двухмерной многослойной текстуры и добавляет его в RenderingServer. К нему можно получить доступ с помощью возвращаемого RID. Этот RID будет использоваться во всех функциях RenderingServer texture_2d_layered_*, хотя он ничего не делает при использовании. См. также RenderingServer.Texture2DLayeredPlaceholderCreate.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer RenderingServer.FreeRid.
Примечание: Эквивалентный ресурс — PlaceholderTexture2D.
RidTexture2DUpdatevoid
public static void Texture2DUpdate(Rid texture, Image image, int layer);Обновляет текстуру, указанную texture Rid, данными в image. Также необходимо указать layer, который должен быть 0 при обновлении однослойной текстуры (Texture2D).
Примечание: image должен иметь ту же ширину, высоту и формат, что и текущие данные texture. В противном случае будет выведена ошибка, и исходная текстура не будет изменена. Если вам нужно использовать другую ширину, высоту или формат, используйте вместо этого RenderingServer.TextureReplace.
| Имя | Тип | По умолчанию |
|---|---|---|
texture | Rid | — |
image | Image | — |
layer | int | — |
Texture3DCreateRid
public static Rid Texture3DCreate(Image.Format format, int width, int height, int depth, bool mipmaps, Reckfell.Collections.Array<Image> data);Примечание: Эквивалентный ресурс — Texture3D.
| Имя | Тип | По умолчанию |
|---|---|---|
format | Image.Format | — |
width | int | — |
height | int | — |
depth | int | — |
mipmaps | bool | — |
data | Reckfell.Collections.Array<Image> | — |
RidTexture3DGetReckfell.Collections.Array<Image>
public static Reckfell.Collections.Array<Image> Texture3DGet(Rid texture);Возвращает данные 3D-текстуры в виде массива Image для указанной текстуры Rid.
| Имя | Тип | По умолчанию |
|---|---|---|
texture | Rid | — |
Reckfell.Collections.Array<Image>Texture3DPlaceholderCreateRid
public static Rid Texture3DPlaceholderCreate();Создает заполнитель для трехмерной текстуры и добавляет его в RenderingServer. К нему можно получить доступ с помощью возвращаемого RID. Этот RID будет использоваться во всех функциях texture_3d_* RenderingServer, хотя он ничего не делает при использовании.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer.FreeRid RenderingServer.
Примечание: Эквивалентный ресурс — PlaceholderTexture3D.
RidTexture3DUpdatevoid
public static void Texture3DUpdate(Rid texture, Reckfell.Collections.Array<Image> data);Обновляет текстуру, указанную данными texture Rid с данными в data. Все слои текстуры должны быть заменены одновременно.
Примечание: texture должна иметь ту же ширину, высоту, глубину и формат, что и текущие данные текстуры. В противном случае будет выведена ошибка, и исходная текстура не будет изменена. Если вам нужно использовать другую ширину, высоту, глубину или формат, используйте вместо этого RenderingServer.TextureReplace.
| Имя | Тип | По умолчанию |
|---|---|---|
texture | Rid | — |
data | Reckfell.Collections.Array<Image> | — |
TextureCreateFromNativeHandleRid
public static Rid TextureCreateFromNativeHandle(RenderingServer.TextureType type, Image.Format format, ulong nativeHandle, int width, int height, int depth, int layers = 1, RenderingServer.TextureLayeredType layeredType = RenderingServer.TextureLayeredType.Layered2DArray);Создает текстуру на основе собственного дескриптора, созданного вне рендерера Reckfell.
Примечание: Если используется только рендерер устройства рендеринга, рекомендуется использовать RenderingDevice.TextureCreateFromExtension вместе с RenderingServer.TextureRdCreate, а не этот метод. Таким образом, формат и использование текстуры можно контролировать более эффективно.
| Имя | Тип | По умолчанию |
|---|---|---|
type | RenderingServer.TextureType | — |
format | Image.Format | — |
nativeHandle | ulong | — |
width | int | — |
height | int | — |
depth | int | — |
layers | int | 1 |
layeredType | RenderingServer.TextureLayeredType | RenderingServer.TextureLayeredType.Layered2DArray |
RidTextureDrawableBlitRectvoid
public static void TextureDrawableBlitRect(Reckfell.Collections.Array<Rid> textures, Rect2I rect, Rid material, Color modulate, Reckfell.Collections.Array<Rid> sourceTextures, int toMipmap = 0);Низкоуровневая версия операции записи в DrawableTexture2D. Принимает RenderingServer RID, не RID локального RenderingDevice. Нужны 1–4 разные инициализированные цели одного размера и 1–4 источника; источники не должны совпадать с целями. Для обычного кода используйте ресурсные BlitRect/BlitRectMulti и управляйте временем жизни ресурсов.
| Имя | Тип | По умолчанию |
|---|---|---|
textures | Reckfell.Collections.Array<Rid> | — |
rect | Rect2I | — |
material | Rid | — |
modulate | Color | — |
sourceTextures | Reckfell.Collections.Array<Rid> | — |
toMipmap | int | 0 |
texturesRID целей в порядке COLOR0…3; от 1 до 4.
rectОбщий прямоугольник относительно базового размера целей.
materialRID материала texture_blit; не RID Shader.
modulateЦвет MODULATE, применяемый кодом шейдера.
sourceTexturesОт 1 до 4 RenderingServer RID источников по порядку слотов; пустой RID выбирает белую выборку текущего RD.
toMipmapСуществующий уровень назначения во всех целях.
TextureDrawableCreateRid
public static Rid TextureDrawableCreate(int width, int height, RenderingServer.TextureDrawableFormat format, Color? color = default, bool withMipmaps = false);Создаёт двухмерную текстуру и добавляет ее к RenderingServer1. Доступ к нему можно получить через RID Вернули. RID будет использоваться во всех texture_drawable* RenderingServer функции.
Как только закончите с вашим RIDВы захотите освободить RID с использованием RenderingServer's RenderingServer.FreeRid Метод.
Примечание: Эквивалентный ресурс: DrawableTexture2D.
| Имя | Тип | По умолчанию |
|---|---|---|
width | int | — |
height | int | — |
format | RenderingServer.TextureDrawableFormat | — |
color | Color? | default |
withMipmaps | bool | false |
colorЕсли параметр не имеет значения, то значение по умолчанию: new Color(1.0f, 1.0f, 1.0f, 1.0f).
RidTextureDrawableGenerateMipmapsvoid
public static void TextureDrawableGenerateMipmaps(Rid texture);Вычисляет новые мипмапы для заданного объекта Drawable texture.
| Имя | Тип | По умолчанию |
|---|---|---|
texture | Rid | — |
TextureDrawableGetDefaultMaterialRid
public static Rid TextureDrawableGetDefaultMaterial();Возвращается a ShaderMaterial с по умолчанию текстура_блит Shader.
RidTextureGetFormatImage.Format
public static Image.Format TextureGetFormat(Rid texture);Возвращает формат текстуры.
| Имя | Тип | По умолчанию |
|---|---|---|
texture | Rid | — |
Image.FormatTextureGetNativeHandleulong
public static ulong TextureGetNativeHandle(Rid texture, bool srgb = false);Возвращает внутренний графический дескриптор для этого объекта текстуры. Используется при взаимодействии со сторонними API, в основном с помощью ReckfellExtension.
srgb должен быть true, если текстура использует нелинейное кодирование sRGB, и false, если текстура использует линейное кодирование.
Примечание: Эта функция возвращает uint64_t, который внутренне сопоставляется с GLuint (OpenGL) или VkImage (Вулкан).
| Имя | Тип | По умолчанию |
|---|---|---|
texture | Rid | — |
srgb | bool | false |
ulongTextureGetPathstring
public static string TextureGetPath(Rid texture);Возвращает путь к ресурсу (начинающийся с asset:// или uid://) для указанного RID текстуры. Возвращает пустую строку string, если ресурс является встроенным. См. также RenderingServer.TextureSetPath.
| Имя | Тип | По умолчанию |
|---|---|---|
texture | Rid | — |
stringTextureGetRdTextureRid
public static Rid TextureGetRdTexture(Rid texture, bool srgb = false);Возвращает текстуру Rid, которую можно использовать с RenderingDevice.
srgb должно быть true, если текстура использует нелинейное кодирование sRGB, и false, если текстура использует линейное кодирование.
| Имя | Тип | По умолчанию |
|---|---|---|
texture | Rid | — |
srgb | bool | false |
RidTextureProxyCreateRid · Устарело
public static Rid TextureProxyCreate(Rid @base);Этот метод ничего не делает и всегда возвращает недействительный Rid.
| Имя | Тип | По умолчанию |
|---|---|---|
base | Rid | — |
RidTextureProxyUpdatevoid · Устарело
public static void TextureProxyUpdate(Rid texture, Rid proxyTo);Этот метод ничего не даёт.
| Имя | Тип | По умолчанию |
|---|---|---|
texture | Rid | — |
proxyTo | Rid | — |
TextureRdCreateRid
public static Rid TextureRdCreate(Rid rdTexture, RenderingServer.TextureLayeredType layerType = RenderingServer.TextureLayeredType.Layered2DArray);Создает новый объект текстуры на основе текстуры, созданной непосредственно на RenderingDevice. Если текстура содержит слои, для определения типа слоя используется layer_type.
После завершения работы с RID вам потребуется освободить RID, используя метод RenderingServer.FreeRid RenderingServer.
Примечание: Метод RenderingServer.FreeRid RenderingServer не освобождает базовый rd_texture, вам потребуется освободить rd_texture с помощью RenderingDevice.FreeRid.
| Имя | Тип | По умолчанию |
|---|---|---|
rdTexture | Rid | — |
layerType | RenderingServer.TextureLayeredType | RenderingServer.TextureLayeredType.Layered2DArray |
RidTextureReplacevoid
public static void TextureReplace(Rid texture, Rid byTexture);Заменяет данные текстуры texture текстурой, указанной в RID by_texture, не изменяя RID texture.
| Имя | Тип | По умолчанию |
|---|---|---|
texture | Rid | — |
byTexture | Rid | — |
TextureReplaceCompatiblevoid
public static void TextureReplaceCompatible(Rid texture, Rid byTexture);Замена texture" данные текстуры с помощью текстуры, указанной by_texture RIDбез изменений texture's RID.
В отличие RenderingServer.TextureReplace, этот метод автоматически меняет любые единообразные наборы, которые относятся texture Таким образом, они указывают на новый лежащий в основе ресурс. Это делает его пригодным для замены текстуров, которые уже связаны с материалами или тенерами, без недействительности существующего состояния рисования. Новая текстура может иметь различные размеры (например, для изменения уровня потока текста).
Тексты, которые не совместимы, скорее всего, приведут к ошибкам, так что рекомендуется использовать только этот метод на текстах, совместимых друг с другом (например, один и тот же формат и флаги использования).
| Имя | Тип | По умолчанию |
|---|---|---|
texture | Rid | — |
byTexture | Rid | — |
TextureSetForceRedrawIfVisiblevoid
public static void TextureSetForceRedrawIfVisible(Rid texture, bool enable);Определяет, следует ли принудительно перерисовывать RID текстуры, когда она видна на экране, если OS.LowProcessorUsageMode имеет значение true. Это используется AnimatedTexture для принудительной перерисовки.
| Имя | Тип | По умолчанию |
|---|---|---|
texture | Rid | — |
enable | bool | — |
TextureSetPathvoid
public static void TextureSetPath(Rid texture, string path);Задает путь к ресурсу для этого RID текстуры. См. также RenderingServer.TextureGetPath.
Примечание: Это всего лишь подсказка, и она не приводит к автоматическому сохранению текстуры при указании пути asset://.
| Имя | Тип | По умолчанию |
|---|---|---|
texture | Rid | — |
path | string | — |
TextureSetSizeOverridevoid
public static void TextureSetSizeOverride(Rid texture, int width, int height);Задает размер, в котором текстура должна отображаться в 2D, игнорируя ее исходный размер. Это не изменяет масштаб самих данных текстуры, а только то, как они отображаются в 2D. Установите width и height равными 0, чтобы отключить изменение размера.
| Имя | Тип | По умолчанию |
|---|---|---|
texture | Rid | — |
width | int | — |
height | int | — |
ViewportAttachCameravoid
public static void ViewportAttachCamera(Rid viewport, Rid camera);Устанавливает камеру области просмотра.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
camera | Rid | — |
ViewportAttachCanvasvoid
public static void ViewportAttachCanvas(Rid viewport, Rid canvas);Устанавливает холст области просмотра.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
canvas | Rid | — |
ViewportAttachToScreenvoid
public static void ViewportAttachToScreen(Rid viewport, Rect2? rect = default, int screen = 0);Копирует область просмотра в область экрана, указанную rect. Если RenderingServer.ViewportSetRenderDirectToScreen равен true, то область просмотра не использует буфер кадра, и содержимое области просмотра отображается непосредственно на экране. Однако обратите внимание, что корневая область просмотра отображается последней, поэтому она будет отображаться поверх экрана. Соответственно, вы должны установить корневую область просмотра в область, которая не покрывает область, к которой вы прикрепили эту область просмотра.
Например, вы можете настроить корневую область просмотра так, чтобы она вообще не отображалась, с помощью следующего кода:
Использование этого может привести к значительной оптимизации, особенно на устройствах начального уровня. Однако это достигается за счет необходимости вручную управлять вашими окнами просмотра. Для дальнейшей оптимизации см. RenderingServer.ViewportSetRenderDirectToScreen.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
rect | Rect2? | default |
screen | int | 0 |
rectЕсли параметр не имеет значения, то значение по умолчанию: new Rect2(new Vector2(0.0f, 0.0f), new Vector2(0.0f, 0.0f)).
ViewportCreateRid
public static Rid ViewportCreate();Создает пустую область просмотра и добавляет ее в RenderingServer. Доступ к ней можно получить с помощью возвращаемого RID. Этот RID будет использоваться во всех функциях viewport_* RenderingServer.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer.FreeRid RenderingServer.
Примечание: Эквивалентный узел — Viewport.
RidViewportGetMeasuredRenderTimeCpudouble
public static double ViewportGetMeasuredRenderTimeCpu(Rid viewport);Возвращает время ЦП, затраченное на рендеринг последнего кадра в миллисекундах. Это только включает время, затраченное на операции, связанные с рендерингом; функции скриптов _process и другие подсистемы движка не включены в это показание. Чтобы получить полное показание времени ЦП, затраченного на рендеринг сцены, сложите время рендеринга всех областей просмотра, которые отрисовываются в каждом кадре, плюс RenderingServer.GetFrameSetupTimeCpu. В отличие от Engine.GetFramesPerSecond, этот метод будет точно отражать использование ЦП, даже если частота кадров ограничена с помощью V-Sync или Engine.MaxFps. См. также RenderingServer.ViewportGetMeasuredRenderTimeGpu.
Примечание: Требует включения измерений на указанном viewport с помощью RenderingServer.ViewportSetMeasureRenderTime. В противном случае этот метод возвращает 0.0.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
doubleViewportGetMeasuredRenderTimeGpudouble
public static double ViewportGetMeasuredRenderTimeGpu(Rid viewport);Возвращает время GPU, затраченное на рендеринг последнего кадра в миллисекундах. Чтобы получить полное показание времени GPU, затраченного на рендеринг сцены, суммируйте время рендеринга всех областей просмотра, которые отрисовываются в каждом кадре. В отличие от Engine.GetFramesPerSecond, этот метод точно отражает использование GPU, даже если частота кадров ограничена с помощью V-Sync или Engine.MaxFps. См. также RenderingServer.ViewportGetMeasuredRenderTimeCpu.
Примечание: Требует включения измерений на указанном viewport с помощью RenderingServer.ViewportSetMeasureRenderTime. В противном случае этот метод возвращает 0.0.
Примечание: Когда использование GPU достаточно низкое в течение определенного периода времени, GPU снижают свое состояние питания (что, в свою очередь, снижает тактовую частоту ядра и памяти). Это может привести к увеличению сообщаемого времени GPU, если загрузка GPU удерживается на достаточно низком уровне с помощью ограничения частоты кадров (по сравнению с тем, что было бы в состоянии максимальной мощности GPU). Помните об этом при бенчмаркинге с использованием RenderingServer.ViewportGetMeasuredRenderTimeGpu. Это поведение можно переопределить в настройках графического драйвера за счет более высокого энергопотребления.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
doubleViewportGetRenderInfoint
public static int ViewportGetRenderInfo(Rid viewport, RenderingServer.ViewportRenderInfoType type, RenderingServer.ViewportRenderInfo info);Вернет статистические данные о двигателе-ретрансляторе, который может использоваться для профилирования рабочих характеристик. types, у каждого из них одинаковые infos Вы можете задавать вопросы (различные пропуска будут возвращать различные значения).
См. также RenderingServer.GetRenderingInfo, что возвращает глобальную информацию по всем обзорным порталам.
Примечание: Viewport - предоставление информации не допускается до тех пор, пока двигатель не предоставит по меньшей мере 2 кадра. RenderingServer.ViewportGetRenderInfo возврат 0. Печатать информацию, переводящую _ready() для успешного использования:
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
type | RenderingServer.ViewportRenderInfoType | — |
info | RenderingServer.ViewportRenderInfo | — |
intViewportGetRenderTargetRid
public static Rid ViewportGetRenderTarget(Rid viewport);Возвращает цель рендеринга для области просмотра.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
RidViewportGetTextureRid
public static Rid ViewportGetTexture(Rid viewport);Возвращает последний отрисованный кадр области просмотра.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
RidViewportGetUpdateModeRenderingServer.ViewportUpdateMode
public static RenderingServer.ViewportUpdateMode ViewportGetUpdateMode(Rid viewport);Возвращает режим обновления области просмотра. Предупреждение: Вызов этого из любого потока, кроме потока рендеринга, отрицательно скажется на производительности.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
RenderingServer.ViewportUpdateModeViewportRemoveCanvasvoid
public static void ViewportRemoveCanvas(Rid viewport, Rid canvas);Отсоединяет область просмотра от холста.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
canvas | Rid | — |
ViewportSetActivevoid
public static void ViewportSetActive(Rid viewport, bool active);Если true, то область просмотра становится активной, в противном случае она становится неактивной.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
active | bool | — |
ViewportSetAnisotropicFilteringLevelvoid
public static void ViewportSetAnisotropicFilteringLevel(Rid viewport, RenderingServer.ViewportAnisotropicFiltering anisotropicFilteringLevel);Устанавливает максимальное количество выборок при использовании анизотропной фильтрации текстур (как степень двойки). Большее количество выборок приведет к более резким текстурам под косыми углами, но это более затратно для вычисления. Значение 0 принудительно отключает анизотропную фильтрацию, даже для материалов, где она включена.
Уровень анизотропной фильтрации также влияет на декали и проекторы света, если они настроены на использование анизотропной фильтрации. См. ProjectSettings.rendering/textures/decals/filter и ProjectSettings.rendering/textures/light_projectors/filter.
Примечание: В 3D, чтобы эта настройка имела эффект, установите BaseMaterial3D.TextureFilter на BaseMaterial3D.TextureFilterEnum.LinearWithMipmapsAnisotropic или BaseMaterial3D.TextureFilterEnum.NearestWithMipmapsAnisotropic для материалов.
Примечание: В 2D, чтобы эта настройка имела эффект, установите CanvasItem.TextureFilter на CanvasItem.TextureFilterEnum.LinearWithMipmapsAnisotropic или CanvasItem.TextureFilterEnum.NearestWithMipmapsAnisotropic на узле CanvasItem, отображающем текстуру (или в CanvasTexture). Однако анизотропная фильтрация редко бывает полезна в 2D, поэтому включайте ее для текстур в 2D только в том случае, если это создает значимую визуальную разницу.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
anisotropicFilteringLevel | RenderingServer.ViewportAnisotropicFiltering | — |
ViewportSetCanvasCullMaskvoid
public static void ViewportSetCanvasCullMask(Rid viewport, uint canvasCullMask);Устанавливает маску рендеринга, связанную с этим Viewport. Только узлы CanvasItem с соответствующим слоем видимости рендеринга будут рендериться этим Viewport.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
canvasCullMask | uint | — |
ViewportSetCanvasStackingvoid
public static void ViewportSetCanvasStacking(Rid viewport, Rid canvas, int layer, int sublayer);Устанавливает порядок наложения для холста области просмотра.
layer — это фактический слой холста, а sublayer определяет порядок наложения холста среди тех, что находятся в том же слое.
Примечание: layer должен быть между RenderingServer.CanvasLayerMin и RenderingServer.CanvasLayerMax (включительно). Любое другое значение будет переноситься.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
canvas | Rid | — |
layer | int | — |
sublayer | int | — |
ViewportSetCanvasTransformvoid
public static void ViewportSetCanvasTransform(Rid viewport, Rid canvas, Transform2D offset);Устанавливает преобразование холста области просмотра.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
canvas | Rid | — |
offset | Transform2D | — |
ViewportSetClearModevoid
public static void ViewportSetClearMode(Rid viewport, RenderingServer.ViewportClearMode clearMode);Устанавливает режим очистки области просмотра.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
clearMode | RenderingServer.ViewportClearMode | — |
ViewportSetDebugDrawvoid
public static void ViewportSetDebugDraw(Rid viewport, RenderingServer.ViewportDebugDraw draw);Устанавливает режим отладки отрисовки области просмотра.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
draw | RenderingServer.ViewportDebugDraw | — |
ViewportSetDefaultCanvasItemTextureFiltervoid
public static void ViewportSetDefaultCanvasItemTextureFilter(Rid viewport, RenderingServer.CanvasItemTextureFilter filter);Устанавливает режим фильтрации текстур по умолчанию для указанного RID viewport.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
filter | RenderingServer.CanvasItemTextureFilter | — |
ViewportSetDefaultCanvasItemTextureRepeatvoid
public static void ViewportSetDefaultCanvasItemTextureRepeat(Rid viewport, RenderingServer.CanvasItemTextureRepeat repeat);Устанавливает режим повторения текстуры по умолчанию для указанного viewport RID.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
repeat | RenderingServer.CanvasItemTextureRepeat | — |
ViewportSetDisable2Dvoid
public static void ViewportSetDisable2D(Rid viewport, bool disable);Если true, холст области просмотра (т. е. 2D-элементы и элементы графического интерфейса) не отображается.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
disable | bool | — |
ViewportSetDisable3Dvoid
public static void ViewportSetDisable3D(Rid viewport, bool disable);Если true, 3D-элементы области просмотра не отображаются.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
disable | bool | — |
ViewportSetEnvironmentModevoid
public static void ViewportSetEnvironmentMode(Rid viewport, RenderingServer.ViewportEnvironmentMode mode);Устанавливает режим среды вьюпорта, который позволяет включать или отключать рендеринг 3D-среды поверх 2D-холста. Если отключено, 2D не будет зависеть от среды. Если включено, 2D будет зависеть от среды, если режим фона среды равен RenderingServer.EnvironmentBG.Canvas. Поведение по умолчанию — наследование настройки от родителя вьюпорта. Если самый верхний родитель также установлен на RenderingServer.ViewportEnvironmentMode.Inherit, то поведение будет таким же, как если бы он был установлен на RenderingServer.ViewportEnvironmentMode.Enabled.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
mode | RenderingServer.ViewportEnvironmentMode | — |
ViewportSetFsrSharpnessvoid
public static void ViewportSetFsrSharpness(Rid viewport, float sharpness);Определяет, насколько резким будет увеличенное изображение при использовании режима увеличения FSR. Резкость уменьшается вдвое с каждым целым числом. Значения варьируются от 0,0 (максимальная резкость) до 2,0. Значения выше 2,0 не будут иметь видимого значения.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
sharpness | float | — |
ViewportSetGlobalCanvasTransformvoid
public static void ViewportSetGlobalCanvasTransform(Rid viewport, Transform2D transform);Задает глобальную матрицу преобразования области просмотра.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
transform | Transform2D | — |
ViewportSetMeasureRenderTimevoid
public static void ViewportSetMeasureRenderTime(Rid viewport, bool enable);Устанавливает измерение для заданного viewport RID (полученного с помощью Viewport.GetViewportRid). После включения RenderingServer.ViewportGetMeasuredRenderTimeCpu и RenderingServer.ViewportGetMeasuredRenderTimeGpu будут возвращать значения больше 0.0 при запросе с заданным viewport.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
enable | bool | — |
ViewportSetMsaa2Dvoid
public static void ViewportSetMsaa2D(Rid viewport, RenderingServer.ViewportMsaa msaa);Устанавливает режим сглаживания мультисэмпла для 2D/Canvas на указанном viewport RID. Эквивалентно ProjectSettings.rendering/anti_aliasing/quality/msaa_2d или Viewport.Msaa2D.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
msaa | RenderingServer.ViewportMsaa | — |
ViewportSetMsaa3Dvoid
public static void ViewportSetMsaa3D(Rid viewport, RenderingServer.ViewportMsaa msaa);Устанавливает режим сглаживания мультисэмпла для 3D на указанном viewport RID. Эквивалентно ProjectSettings.rendering/anti_aliasing/quality/msaa_3d или Viewport.Msaa3D.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
msaa | RenderingServer.ViewportMsaa | — |
ViewportSetOcclusionCullingBuildQualityvoid
public static void ViewportSetOcclusionCullingBuildQuality(RenderingServer.ViewportOcclusionCullingBuildQuality quality);Устанавливает ProjectSettings.rendering/occlusion_culling/bvh_build_quality для использования при Заклубирование. Этот параметр является глобальным и не может быть установлен для каждого viewport.
| Имя | Тип | По умолчанию |
|---|---|---|
quality | RenderingServer.ViewportOcclusionCullingBuildQuality | — |
ViewportSetOcclusionRaysPerThreadvoid
public static void ViewportSetOcclusionRaysPerThread(int raysPerThread);Устанавливает ProjectSettings.rendering/occlusion_culling/occlusion_rays_per_thread для использования при Заклубирование. Этот параметр является глобальным и не может быть установлен на основе viewport.
| Имя | Тип | По умолчанию |
|---|---|---|
raysPerThread | int | — |
ViewportSetParentViewportvoid
public static void ViewportSetParentViewport(Rid viewport, Rid parentViewport);Устанавливает родительский элемент области просмотра на область просмотра, указанную в RID parent_viewport.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
parentViewport | Rid | — |
ViewportSetPositionalShadowAtlasQuadrantSubdivisionvoid
public static void ViewportSetPositionalShadowAtlasQuadrantSubdivision(Rid viewport, int quadrant, int subdivision);Устанавливает количество подразделений для использования в указанном теневом атласе quadrant для omni и spot теней. См. также Viewport.SetPositionalShadowAtlasQuadrantSubdiv.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
quadrant | int | — |
subdivision | int | — |
ViewportSetPositionalShadowAtlasSizevoid
public static void ViewportSetPositionalShadowAtlasSize(Rid viewport, int size, bool use16Bits = false);Устанавливает size изображений атласа теней (используемых для всенаправленных и точечных источников света) на области просмотра, указанной в viewport RID. Значение округляется до ближайшей степени 2. Если use_16_bits равно true, используйте 16 бит для карты глубины всенаправленных/точечных теней. Включение этого параметра приводит к снижению точности теней и может привести к появлению теневых угрей, но может привести к повышению производительности на некоторых устройствах.
Примечание: Если установлено значение 0, позиционные тени вообще не будут видны. Это может значительно повысить производительность на слабых системах за счет снижения нагрузки как на ЦП, так и на ГП (поскольку для отрисовки сцены без теней требуется меньше вызовов отрисовки).
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
size | int | — |
use16Bits | bool | false |
ViewportSetRenderDirectToScreenvoid
public static void ViewportSetRenderDirectToScreen(Rid viewport, bool enabled);Если true, отрисовывать содержимое области просмотра непосредственно на экране. Это позволяет выполнить низкоуровневую оптимизацию, при которой можно пропустить рисование области просмотра в корневой области просмотра. Хотя эта оптимизация может привести к значительному увеличению скорости (особенно на старых устройствах), она достигается ценой удобства использования. Когда это включено, вы не можете читать из области просмотра или из screen_texture. Вы также теряете преимущество определенных настроек окна, таких как различные режимы растяжения. Еще одно последствие, о котором следует знать, заключается в том, что в 2D рендеринг происходит в координатах окна, поэтому если у вас область просмотра в два раза больше размера окна, и вы устанавливаете это, то будет отрисована только та часть, которая помещается в окне, автоматическое масштабирование невозможно, даже если ваша игровая сцена значительно больше размера окна.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
enabled | bool | — |
ViewportSetScaling3DModevoid
public static void ViewportSetScaling3DMode(Rid viewport, RenderingServer.ViewportScaling3DMode scaling3DMode);Устанавливает режим масштабирования разрешения 3D. Билинейный масштаб рендерит с разным разрешением для либо недостаточной, либо избыточной выборки области просмотра. FieldityFX Суперразрешение 1.0, сокращенно FSR, — это технология масштабирования, которая создает высококачественные изображения с высокой частотой кадров с помощью пространственно-чувствительного алгоритма масштабирования. FSR немного дороже билинейного, но обеспечивает значительно более высокое качество изображения. FSR следует использовать везде, где это возможно.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
scaling3DMode | RenderingServer.ViewportScaling3DMode | — |
ViewportSetScaling3DScalevoid
public static void ViewportSetScaling3DScale(Rid viewport, float scale);Масштаб 3D-образного буфера, основанного на размерах обзорного портала, использует фильтр изображения, указанный в RenderingServer.ViewportScaling3DMode масштабировать выводное изображение до полного размера обзора. Значения ниже 1.0 можно использовать для ускорения трехмерной передачи данных по стоимости качества (неполный выбор). 1.0 , действительны только для двухлинейного режима и могут использоваться для повышения качества 3D при высокой эффективности (сверхвыборка). RenderingServer.ViewportMsaa Для многопробной антиалистики, которая значительно дешевле, но только сглаживает края многоугольников.
При использовании повышения FSR AMD рекомендует предоставить пользователям следующие значения в качестве заранее установленных опций: "Ультра качество: 0,77", "Качество: 0,67", "Бланширован: 0,59"".Performance: 0,5" вместо того, чтобы разоблачать всю шкалу.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
scale | float | — |
ViewportSetScenariovoid
public static void ViewportSetScenario(Rid viewport, Rid scenario);Устанавливает сценарий окна просмотра. Сценарий содержит информацию об окружающей среде, атлас отражений и т. д.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
scenario | Rid | — |
ViewportSetScreenSpaceAAvoid
public static void ViewportSetScreenSpaceAA(Rid viewport, RenderingServer.ViewportScreenSpaceAA mode);Устанавливает режим сглаживания экранного пространства области просмотра. Эквивалентно ProjectSettings.rendering/anti_aliasing/quality/screen_space_aa или Viewport.ScreenSpaceAA.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
mode | RenderingServer.ViewportScreenSpaceAA | — |
ViewportSetSdfOversizeAndScalevoid
public static void ViewportSetSdfOversizeAndScale(Rid viewport, RenderingServer.ViewportSdfOversize oversize, RenderingServer.ViewportSdfScale scale);Устанавливает поле расстояния со знаком 2D окна просмотра ProjectSettings.rendering/2d/sdf/oversize и ProjectSettings.rendering/2d/sdf/scale. Используется при сэмплировании поля расстояния со знаком в шейдерах CanvasItem, а также при столкновении GpuParticles2D. Это не используется SDFGI в 3D-рендеринге.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
oversize | RenderingServer.ViewportSdfOversize | — |
scale | RenderingServer.ViewportSdfScale | — |
ViewportSetSize2 перегрузки
public static void ViewportSetSize(Rid viewport, int width, int height);Задает ширину width и высоту height области просмотра в пикселях. При желании можно установить значение параметра view_count для увеличения количества слоев просмотра при стереорендеринге.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
width | int | — |
height | int | — |
public static void ViewportSetSize(Rid viewport, int width, int height, int viewCount = 1);Задает ширину width и высоту height области просмотра в пикселях. При желании можно установить значение параметра view_count для увеличения количества слоев просмотра при стереорендеринге.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
width | int | — |
height | int | — |
viewCount | int | 1 |
ViewportSetSnap2DTransformsToPixelvoid
public static void ViewportSetSnap2DTransformsToPixel(Rid viewport, bool enabled);Если true, преобразования элементов холста (т. е. исходное положение) привязываются к ближайшему пикселю при рендеринге. Это может привести к более четкому виду за счет менее плавного движения, особенно если включено сглаживание Camera2D. Эквивалентно ProjectSettings.rendering/2d/snap/snap_2d_transforms_to_pixel.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
enabled | bool | — |
ViewportSetSnap2DVerticesToPixelvoid
public static void ViewportSetSnap2DVerticesToPixel(Rid viewport, bool enabled);Если true, вершины элемента холста (т. е. точки полигона) привязываются к ближайшему пикселю при рендеринге. Это может привести к более четкому виду за счет менее плавного движения, особенно если включено сглаживание Camera2D. Эквивалентно ProjectSettings.rendering/2d/snap/snap_2d_vertices_to_pixel.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
enabled | bool | — |
ViewportSetTextureMipmapBiasvoid
public static void ViewportSetTextureMipmapBias(Rid viewport, float mipmapBias);Влияет на резкость конечной текстуры, считывая значение мипмапа с более низким или более высоким уровнем детализации (также называемое "смещением LOD текстуры"). Отрицательные значения делают текстуры с мипмапами более резкими, но более зернистыми при просмотре с расстояния, в то время как положительные значения делают текстуры с мипмапами более размытыми (даже вблизи). Чтобы получить более резкие текстуры на расстоянии без чрезмерного увеличения зернистости, установите это значение в диапазоне от -0.75 до 0.0. Включение временного сглаживания (ProjectSettings.rendering/anti_aliasing/quality/use_taa) может помочь уменьшить зернистость, видимую при использовании отрицательного смещения мипмапа.
Примечание: Когда режим 3D-масштабирования установлен на FSR 1.0, это значение используется для регулировки автоматического смещения мипмапа, которое рассчитывается внутренне на основе коэффициента масштабирования. Формула для этого: -log2(1.0 / scale) + mipmap_bias.
Примечание: Этот метод поддерживается только в рендерерах Forward+ и Mobile, а не в Compatibility. В Compatibility этот метод всегда обрабатывается так, как если бы mipmap_bias был установлен на 0.0.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
mipmapBias | float | — |
ViewportSetTransparentBackgroundvoid
public static void ViewportSetTransparentBackground(Rid viewport, bool enabled);Если true, область просмотра делает свой фон прозрачным.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
enabled | bool | — |
ViewportSetUpdateModevoid
public static void ViewportSetUpdateMode(Rid viewport, RenderingServer.ViewportUpdateMode updateMode);Устанавливает, когда следует обновлять область просмотра.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
updateMode | RenderingServer.ViewportUpdateMode | — |
ViewportSetUseDebandingvoid
public static void ViewportSetUseDebanding(Rid viewport, bool enable);Эквивалентно Viewport.UseDebanding. См. также ProjectSettings.rendering/anti_aliasing/quality/use_debanding.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
enable | bool | — |
ViewportSetUseHdr2Dvoid
public static void ViewportSetUseHdr2D(Rid viewport, bool enabled);Если true, 2D-передача будет осуществляться с использованием высокодинамичных диапазонов (ГДР) RGBA16 Кроме того, 2D-передача будет производиться на линейных значениях и будет преобразовываться с использованием соответствующей функции передачи непосредственно перед нанесением на экран (если Viewport прикрепляется к экрану).
В практическом плане это означает, что конечный результат Viewport не будет зажиматься 0-1 дальность и может использоваться при 3D-переведении без изменения цветового кодирования. Это позволяет 2D-образец использовать эффект, требующий высокого динамического диапазона (например, 2D свечения), а также существенно улучшает внешний вид эффекта, требующего очень подробных градиентов. Эта регулировка имеет тот же эффект, что и Viewport.UseHdr2D.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
enabled | bool | — |
ViewportSetUseOcclusionCullingvoid
public static void ViewportSetUseOcclusionCulling(Rid viewport, bool enable);Если true, включает Заклубирование на указанном окне просмотра. Эквивалентно ProjectSettings.rendering/occlusion_culling/use_occlusion_culling.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
enable | bool | — |
ViewportSetUseTaavoid
public static void ViewportSetUseTaa(Rid viewport, bool enable);Если true, использовать временное сглаживание. Эквивалентно ProjectSettings.rendering/anti_aliasing/quality/use_taa или Viewport.UseTaa.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
enable | bool | — |
ViewportSetUseXRvoid
public static void ViewportSetUseXR(Rid viewport, bool useXR);Если true, область просмотра использует технологии дополненной или виртуальной реальности. См. XRInterface.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
useXR | bool | — |
ViewportSetVrsModevoid
public static void ViewportSetVrsMode(Rid viewport, RenderingServer.ViewportVrsMode mode);Устанавливает режим Изменчивый курс (VRS) для области просмотра. Если графический процессор не поддерживает VRS, это свойство игнорируется. Эквивалентно ProjectSettings.rendering/vrs/mode.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
mode | RenderingServer.ViewportVrsMode | — |
ViewportSetVrsTexturevoid
public static void ViewportSetVrsTexture(Rid viewport, Rid texture);Текстура, используемая, когда режим VRS установлен на RenderingServer.ViewportVrsMode.Texture. Эквивалентно ProjectSettings.rendering/vrs/texture.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
texture | Rid | — |
ViewportSetVrsUpdateModevoid
public static void ViewportSetVrsUpdateMode(Rid viewport, RenderingServer.ViewportVrsUpdateMode mode);Устанавливает режим обновления для Изменчивый курс (VRS) для области просмотра. VRS требует, чтобы входная текстура была преобразована в формат, используемый методом VRS, поддерживаемым оборудованием. Режим обновления определяет, как часто это происходит. Если графический процессор не поддерживает VRS или VRS не включен, это свойство игнорируется.
Если установлено значение RenderingServer.ViewportVrsUpdateMode.Once, входная текстура копируется один раз, а режим изменяется на RenderingServer.ViewportVrsUpdateMode.Disabled.
| Имя | Тип | По умолчанию |
|---|---|---|
viewport | Rid | — |
mode | RenderingServer.ViewportVrsUpdateMode | — |
VisibilityNotifierCreateRid
public static Rid VisibilityNotifierCreate();Создает новый объект уведомителя 3D-видимости и добавляет его в RenderingServer. К нему можно получить доступ с помощью возвращаемого RID. Этот RID будет использоваться во всех функциях RenderingServer visibility_notifier_*.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer RenderingServer.FreeRid.
Чтобы разместить в сцене, прикрепите этот уведомитель к экземпляру с помощью RenderingServer.InstanceSetBase, используя возвращаемый RID.
Примечание: Эквивалентный узел — VisibleOnScreenNotifier3D.
RidVisibilityNotifierSetAabbvoid
public static void VisibilityNotifierSetAabb(Rid notifier, Aabb aabb);Устанавливает AABB указанного уведомителя о видимости (Уведомитель видимости).
| Имя | Тип | По умолчанию |
|---|---|---|
notifier | Rid | — |
aabb | Aabb | — |
VisibilityNotifierSetCallbacksvoid
public static void VisibilityNotifierSetCallbacks(Rid notifier, Callable enterCallable, Callable exitCallable);Задает методы, которые будут вызываться при входе или выходе элемента, отправляющего уведомление или исчезает из поля зрения.
| Имя | Тип | По умолчанию |
|---|---|---|
notifier | Rid | — |
enterCallable | Callable | — |
exitCallable | Callable | — |
VoxelGIAllocateData2 перегрузки
public static void VoxelGIAllocateData(Rid voxelGI, Transform3D toCellXform, Aabb aabb, Vector3I octreeSize, byte[] octreeCells, byte[] dataCells, byte[] distanceField, int[] levelCounts);Выделяет и инициализирует данные воксельного глобального освещения (Воксель Гл) для указанного RID voxel_gi. octree_cells должно быть кратно 32. octree_cells должно быть вдвое больше размера data_cells. Выделенные данные можно будет получить позже, используя различные методы voxel_gi_get_*.
| Имя | Тип | По умолчанию |
|---|---|---|
voxelGI | Rid | — |
toCellXform | Transform3D | — |
aabb | Aabb | — |
octreeSize | Vector3I | — |
octreeCells | byte[] | — |
dataCells | byte[] | — |
distanceField | byte[] | — |
levelCounts | int[] | — |
public static void VoxelGIAllocateData(Rid voxelGI, Transform3D toCellXform, Aabb aabb, Vector3I octreeSize, ReadOnlySpan<byte> octreeCells, ReadOnlySpan<byte> dataCells, ReadOnlySpan<byte> distanceField, ReadOnlySpan<int> levelCounts);Выделяет и инициализирует данные воксельного глобального освещения (Воксель Гл) для указанного RID voxel_gi. octree_cells должно быть кратно 32. octree_cells должно быть вдвое больше размера data_cells. Выделенные данные можно будет получить позже, используя различные методы voxel_gi_get_*.
| Имя | Тип | По умолчанию |
|---|---|---|
voxelGI | Rid | — |
toCellXform | Transform3D | — |
aabb | Aabb | — |
octreeSize | Vector3I | — |
octreeCells | ReadOnlySpan<byte> | — |
dataCells | ReadOnlySpan<byte> | — |
distanceField | ReadOnlySpan<byte> | — |
levelCounts | ReadOnlySpan<int> | — |
VoxelGICreateRid
public static Rid VoxelGICreate();Создает новый объект глобального освещения на основе вокселей и добавляет его в RenderingServer. К нему можно получить доступ с помощью возвращаемого RID. Этот RID будет использоваться во всех функциях RenderingServer voxel_gi_*.
После завершения работы с RID вам нужно будет освободить RID с помощью метода RenderingServer RenderingServer.FreeRid.
Примечание: Эквивалентный узел — VoxelGI.
RidVoxelGIGetDataCellsbyte[]
public static byte[] VoxelGIGetDataCells(Rid voxelGI);Возвращает ячейки данных для указанного экземпляра данных Воксель ГИ. См. также RenderingServer.VoxelGIAllocateData.
| Имя | Тип | По умолчанию |
|---|---|---|
voxelGI | Rid | — |
byte[]VoxelGIGetDistanceFieldbyte[]
public static byte[] VoxelGIGetDistanceField(Rid voxelGI);Возвращает данные поля расстояний для указанного экземпляра данных глобального освещения вокселей. См. также RenderingServer.VoxelGIAllocateData.
| Имя | Тип | По умолчанию |
|---|---|---|
voxelGI | Rid | — |
byte[]VoxelGIGetLevelCountsint[]
public static int[] VoxelGIGetLevelCounts(Rid voxelGI);Возвращает количество уровней для указанного экземпляра данных глобального освещения вокселей. См. также RenderingServer.VoxelGIAllocateData.
| Имя | Тип | По умолчанию |
|---|---|---|
voxelGI | Rid | — |
int[]VoxelGIGetOctreeCellsbyte[]
public static byte[] VoxelGIGetOctreeCells(Rid voxelGI);Возвращает данные ячеек октодерева для указанного экземпляра данных воксельного глобального освещения. См. также RenderingServer.VoxelGIAllocateData.
| Имя | Тип | По умолчанию |
|---|---|---|
voxelGI | Rid | — |
byte[]VoxelGIGetOctreeSizeVector3I
public static Vector3I VoxelGIGetOctreeSize(Rid voxelGI);Возвращает размер октодерева для указанного экземпляра данных воксельного глобального освещения, который соответствует количеству подразделений на ось. Это можно увидеть в редакторе, наведя курсор на кнопку Bake VoxelGI в верхней части окна просмотра 3D-редактора, когда выбран узел VoxelGI, и посмотрев на поле Subdivisions во всплывающей подсказке.
| Имя | Тип | По умолчанию |
|---|---|---|
voxelGI | Rid | — |
Vector3IVoxelGIGetToCellXformTransform3D
public static Transform3D VoxelGIGetToCellXform(Rid voxelGI);Возвращает преобразование в пространство ячеек для указанного экземпляра данных глобального освещения вокселей. См. также RenderingServer.VoxelGIAllocateData.
| Имя | Тип | По умолчанию |
|---|---|---|
voxelGI | Rid | — |
Transform3DVoxelGISetBakedExposureNormalizationvoid
public static void VoxelGISetBakedExposureNormalization(Rid voxelGI, float bakedExposure);Используется для информирования рендерера о том, какое значение нормализации экспозиции использовалось при запекании Воксель джи. Это значение будет использоваться и модулироваться во время выполнения, чтобы гарантировать, что Воксель джи поддерживает постоянный уровень экспозиции, даже если нормализация экспозиции всей сцены изменяется во время выполнения. Для получения дополнительной информации см. RenderingServer.CameraAttributesSetExposure.
| Имя | Тип | По умолчанию |
|---|---|---|
voxelGI | Rid | — |
bakedExposure | float | — |
VoxelGISetBiasvoid
public static void VoxelGISetBias(Rid voxelGI, float bias);Устанавливает значение VoxelGIData.Bias для использования в Rid указанного voxel_gi.
| Имя | Тип | По умолчанию |
|---|---|---|
voxelGI | Rid | — |
bias | float | — |
VoxelGISetDynamicRangevoid
public static void VoxelGISetDynamicRange(Rid voxelGI, float range);Устанавливает значение VoxelGIData.DynamicRange для использования в Rid указанного voxel_gi.
| Имя | Тип | По умолчанию |
|---|---|---|
voxelGI | Rid | — |
range | float | — |
VoxelGISetEnergyvoid
public static void VoxelGISetEnergy(Rid voxelGI, float energy);Устанавливает значение VoxelGIData.Energy для использования в Rid указанного voxel_gi.
| Имя | Тип | По умолчанию |
|---|---|---|
voxelGI | Rid | — |
energy | float | — |
VoxelGISetInteriorvoid
public static void VoxelGISetInterior(Rid voxelGI, bool enable);Устанавливает значение VoxelGIData.Interior для использования в Rid указанного voxel_gi.
| Имя | Тип | По умолчанию |
|---|---|---|
voxelGI | Rid | — |
enable | bool | — |
VoxelGISetNormalBiasvoid
public static void VoxelGISetNormalBias(Rid voxelGI, float bias);Устанавливает значение VoxelGIData.NormalBias для использования в Rid указанного voxel_gi.
| Имя | Тип | По умолчанию |
|---|---|---|
voxelGI | Rid | — |
bias | float | — |
VoxelGISetPropagationvoid
public static void VoxelGISetPropagation(Rid voxelGI, float amount);Устанавливает значение VoxelGIData.Propagation для использования в Rid указанного voxel_gi.
| Имя | Тип | По умолчанию |
|---|---|---|
voxelGI | Rid | — |
amount | float | — |
VoxelGISetQualityvoid
public static void VoxelGISetQuality(RenderingServer.VoxelGIQuality quality);Устанавливает значение ProjectSettings.rendering/global_illumination/voxel_gi/quality для использования при рендеринге. Этот параметр является глобальным и не может быть установлен на основе VoxelGI.
| Имя | Тип | По умолчанию |
|---|---|---|
quality | RenderingServer.VoxelGIQuality | — |
VoxelGISetUseTwoBouncesvoid
public static void VoxelGISetUseTwoBounces(Rid voxelGI, bool enable);Устанавливает значение VoxelGIData.UseTwoBounces для использования в Rid указанного voxel_gi.
| Имя | Тип | По умолчанию |
|---|---|---|
voxelGI | Rid | — |
enable | bool | — |
Сигналы и события2
FramePostDrawСобытие
public static event Action FramePostDraw;Вызывается в конце кадра, после того как RenderingServer завершил обновление всех Viewports.
FramePreDrawСобытие
public static event Action FramePreDraw;Вызывается в начале кадра, до того, как RenderingServer обновит все Viewports (области просмотра).
Поля и константы18
ArrayCustomCountПоле
public const long ArrayCustomCount = 4;Количество доступных пользовательских массивов данных (RenderingServer.ArrayType.Custom0, RenderingServer.ArrayType.Custom1, RenderingServer.ArrayType.Custom2, RenderingServer.ArrayType.Custom3).
ArrayWeightsSizeПоле
public const long ArrayWeightsSize = 4;Количество грузов/костей на вершину.
CanvasItemZMaxПоле
public const long CanvasItemZMax = 4096;Максимальный Z-слой для элементов холста.
CanvasItemZMinПоле
public const long CanvasItemZMin = -4096;Минимальный Z-слой для элементов холста.
CanvasLayerMaxПоле
public const long CanvasLayerMax = 2147483647;Максимальный слой холста.
УРОВНЯ МАКС_ГЛОУМ
CanvasLayerMinПоле
public const long CanvasLayerMin = -2147483648;Минимальный слой холста.
MaterialRenderPriorityMaxПоле
public const long MaterialRenderPriorityMax = 127;Максимальный приоритет рендеринга всех материалов.
MaterialRenderPriorityMinПоле
public const long MaterialRenderPriorityMin = -128;Минимальный приоритет рендеринга всех материалов.
Max2DDirectionalLightsПоле
public const long Max2DDirectionalLights = 8;Максимальное количество направленных источников света, которые можно визуализировать в 2D-режиме в заданное время.
MaxCursorsПоле · Устарело
public const long MaxCursors = 8;MaxGlowLevelsПоле
public const long MaxGlowLevels = 7;Максимальное количество уровней свечения, которые можно использовать с эффектом постобработки свечения.
MaxMeshSurfacesПоле
public const long MaxMeshSurfaces = 256;Максимальное количество поверхностей, которое может иметь сетка.
NoIndexArrayПоле
public const long NoIndexArray = -1;Отмечает ошибку, показывающую, что массив индексов пуст.
ParticlesEmitFlagColorПоле
public const long ParticlesEmitFlagColor = 8;Частица начинается с указанного цвета.
ЧАСТНОСТИ_ЭМИТИ_ФЛАГ_КУСТОМ
ParticlesEmitFlagCustomПоле
public const long ParticlesEmitFlagCustom = 16;Частица начинается с указанных данных CUSTOM.
ParticlesEmitFlagPositionПоле
public const long ParticlesEmitFlagPosition = 1;Частица стартует в указанной позиции.
ЧАСТНОСТИ_ЭМИТИ_ФЛАГ_Ротация_ШКАЛ
ParticlesEmitFlagRotationScaleПоле
public const long ParticlesEmitFlagRotationScale = 2;Частица начинается с указанного поворота и масштаба.
ParticlesEmitFlagVelocityПоле
public const long ParticlesEmitFlagVelocity = 4;Частица стартует с заданным вектором скорости, который определяет направление и скорость излучения.
RenderingServer.ArrayCustomFormat
| Значение | Описание |
|---|---|
Max = 8 | Представляет размер перечисления |
RFloat = 4 | Пользовательский массив данных содержит 32-битные данные красного цвета на канал. Значения являются числами с плавающей точкой одинарной точности. |
RgFloat = 5 | Пользовательский массив данных содержит 32-битные на канал данные красного/зеленого цвета. Значения являются числами с плавающей точкой одинарной точности. |
RgHalf = 2 | Пользовательский массив данных содержит 16-битные данные о красном/зеленом цвете на канал. Значения являются числами с плавающей точкой с половинной точностью. |
RgbFloat = 6 | Пользовательский массив данных содержит 32-битные данные о красном/зеленом/синем цвете на канал. Значения являются числами с плавающей точкой одинарной точности. |
Rgba8Snorm = 1 | Пользовательский массив данных содержит 8-битные на канал данные о цвете красный/зеленый/синий/альфа. Значения нормализованы, знаковые с плавающей точкой в диапазоне |
Rgba8Unorm = 0 | Пользовательский массив данных содержит 8-битные на канал данные о цвете красный/зеленый/синий/альфа. Значения нормализованы, беззнаковые с плавающей точкой в диапазоне |
RgbaFloat = 7 | Пользовательский массив данных содержит 32-битные на канал данные о цвете красный/зеленый/синий/альфа. Значения являются числами с плавающей точкой одинарной точности. |
RgbaHalf = 3 | Пользовательский массив данных содержит 16-битные на канал данные о цвете красный/зеленый/синий/альфа. Значения являются числами с плавающей точкой с половинной точностью. |
RenderingServer.ArrayFormat
| Значение | Описание |
|---|---|
CompressFlagsBase = 25 | Сдвиг первого флага сжатия. Флаги сжатия должны быть переданы в |
FlagCompressAttributes = 536870912 | Флаг, используемый для обозначения того, что сетка использует сжатые атрибуты (вертики, нормальные, касательные, ультрафиолетовые). Когда эта форма сжатия включена, положения позвоночника упаковываются в атрибут RGBA16UNORM и умножаются на вершину. Нормальная и касательная будут упаковываться в RG16unORM, представляющую собой ось, и 16 бит float Ультрафиолетовые системы будут использовать 16-битные нормализованные поплавки вместо полных 32-битных поплавков с подписью. При использовании этого режима сжатия вы должны использовать либо вершины, нормальные и тангенсные, либо только вершины. Вы не можете использовать нормальные поплавки без касательных. Импортеры автоматически позволят это сжатие, если смогут. |
FlagFormatCurrentVersion = 34359738368 | Флаг, используемый для записи текущей версии, которую ожидает движок. В настоящее время это то же самое, что и |
FlagFormatVersion1 = 0 | Флаг, используемый для записи формата, использовавшегося в предыдущих версиях сетки до введения новой версии. |
FlagFormatVersion2 = 34359738368 | Флаг, используемый для записи второй итерации флага версии сетки. Основное различие между этим и |
FlagFormatVersionBase = 35 | Флаг, используемый для обозначения начала битов, используемых для хранения версии сетки. |
FlagFormatVersionMask = 255 | Флаг, используемый для изоляции битов, используемых для версии сетки, после использования |
FlagFormatVersionShift = 35 | Флаг, используемый для сдвига формата сетки int с целью приведения версии к младшим разрядам. |
FlagUse2DVertices = 33554432 | Флаг, используемый для обозначения того, что массив содержит 2D вершины. |
FlagUse8BoneWeights = 134217728 | Флаг, используемый для обозначения того, что массив использует 8 весов костей вместо 4. |
FlagUseDynamicUpdate = 67108864 | Флаг, используемый для обозначения того, что данные сетки будут использовать |
FlagUseStorageBuffer = 1073741824 | Флаг, используемый для обозначения того, что вершины поверхности, атрибуты, кожа и индексные буферы должны создаваться с битом использования хранилищ-буфера, чтобы они могли быть связаны как буферы хранения в вычислениях. Это требуется для записи в них из вычислительного трубопровода через |
FlagUsesEmptyVertexArray = 268435456 | Флаг, используемый для обозначения того, что сетка не имеет массива вершин и вместо этого будет выводить положения вершин в шейдере с использованием индексов и другой информации. |
FormatBlendShapeMask = 7 | Маска каналов сетки разрешена в смешанных формах. |
FormatBones = 1024 | Флаг, используемый для маркировки массива информации о костях. |
FormatColor = 8 | Флаг, используемый для обозначения массива цветов вершин. |
FormatCustom0 = 64 | Флаг, используемый для маркировки массива пользовательских данных по вершинам для первого набора пользовательских данных. |
FormatCustom0Shift = 13 | Величина сдвига |
FormatCustom1 = 128 | Флаг, используемый для маркировки массива пользовательских данных по вершинам для второго набора пользовательских данных. |
FormatCustom1Shift = 16 | Величина сдвига |
FormatCustom2 = 256 | Флаг, используемый для маркировки массива пользовательских данных по вершинам для третьего набора пользовательских данных. |
FormatCustom2Shift = 19 | Величина сдвига |
FormatCustom3 = 512 | Флаг, используемый для маркировки массива пользовательских данных по вершинам для четвертого набора пользовательских данных. |
FormatCustom3Shift = 22 | Величина сдвига |
FormatCustomBase = 13 | Сдвиг первого пользовательского канала. |
FormatCustomBits = 3 | Количество бит формата на пользовательский канал. См. |
FormatCustomMask = 7 | Маска битов пользовательского формата для каждого пользовательского канала. Должна быть сдвинута на одну из констант SHIFT. См. |
FormatIndex = 4096 | Флаг, используемый для обозначения индексного массива. |
FormatNormal = 2 | Флаг, используемый для обозначения обычного массива. |
FormatTangent = 4 | Флаг, используемый для обозначения касательного массива. |
FormatTexUV = 16 | Флаг, используемый для обозначения массива UV-координат. |
FormatTexUV2 = 32 | Флаг, используемый для обозначения массива UV-координат для вторых UV-координат. |
FormatVertex = 1 | Флаг, используемый для обозначения массива позиций вершин. |
FormatWeights = 2048 | Флаг, используемый для обозначения массива весов. |
RenderingServer.ArrayType
| Значение | Описание |
|---|---|
Bones = 10 | Array содержит информацию о костях. |
Color = 3 | Array - это цветный массив вершины. |
Custom0 = 6 | Array является массивом данных для первого набора данных. |
Custom1 = 7 | Array является массивом данных для второго набора данных. |
Custom2 = 8 | Array - набор данных для третьего набора данных. |
Custom3 = 9 | Array является массивом данных для четвертого набора данных. |
Index = 12 | Array это индексный массив. |
Max = 13 | Представляет размер перечисления |
Normal = 1 | Array это нормальный набор. |
Tangent = 2 | Array - тангенсный массив. |
TexUV = 4 | Array - Ультрафиолетовый набор координат. |
TexUV2 = 5 | Array , является массивом координат ультрафиолетового излучения для второго набора координат ультрафиолетового излучения. |
Vertex = 0 | Array - позиционный массив вершины. |
Weights = 11 | Array - информация о весе. |
RenderingServer.BakeChannels
| Значение | Описание |
|---|---|
AlbedoAlpha = 0 | Указатель БЕЙК_ЧАННЕЛ_НОРМАЛЬНЫЙ |
Emission = 3 | Указатель |
Normal = 1 | Указатель |
Orm = 2 | Указатель |
RenderingServer.BlendShapeMode
| Значение | Описание |
|---|---|
Normalized = 0 | Формы смешивания нормализованы. |
Relative = 1 | Формы смешивания определяются относительно базового веса. |
RenderingServer.CanvasGroupMode
| Значение | Описание |
|---|---|
ClipAndDraw = 2 | Родительский элемент используется для обрезки дочернего элемента, но родительский элемент также рисуется под дочерним элементом, как обычно, перед обрезкой дочернего элемента до его видимой области. |
ClipOnly = 1 | Parent используется только для обрезки. Child обрезается до видимой области родителя, родитель не рисуется. |
Disabled = 0 | Дочерний элемент рисуется поверх родительского и не обрезается. |
Transparent = 3 |
RenderingServer.CanvasItemTextureFilter
| Значение | Описание |
|---|---|
Default = 0 | Использует режим фильтра по умолчанию для этого |
Linear = 2 | Фильтр текстуры смешивает ближайшие 4 пикселя. Это делает текстуру гладкой вблизи и зернистой на расстоянии (из-за того, что mip-карты не сэмплируются). |
LinearWithMipmaps = 4 | Фильтр текстуры смешивает ближайшие 4 пикселя и ближайшие 2 mip-карты (или использует ближайшую mip-карту, если |
LinearWithMipmapsAnisotropic = 6 | Фильтр текстуры смешивает ближайшие 4 пикселя и смешивает 2 mip-карты (или использует ближайшую mip-карту, если |
Max = 7 | Максимальное значение для перечисления |
Nearest = 1 | Фильтр текстуры считывает только ближайший пиксель. Это делает текстуру пикселизированной вблизи и зернистой на расстоянии (из-за того, что mip-карты не сэмплируются). |
NearestWithMipmaps = 3 | Фильтр текстуры считывает данные с ближайшего пикселя и смешивает данные между двумя ближайшими mip-картами (или использует ближайшую mip-карту, если |
NearestWithMipmapsAnisotropic = 5 | Текстурный фильтр считывает данные с ближайшего пикселя и смешивает два mip-текстурных отображения (или использует ближайшее mip-текстурное отображение, если |
RenderingServer.CanvasItemTextureRepeat
| Значение | Описание |
|---|---|
Default = 0 | Использует режим повтора по умолчанию для этого |
Disabled = 1 | Отключает повторение текстур. Вместо этого при считывании UV за пределами диапазона 0-1 значение будет прижато к краю текстуры, что приведет к растянутому виду границ текстуры. |
Enabled = 2 | Позволяет текстуре повторяться, когда координаты UV выходят за пределы диапазона 0-1. При использовании одного из режимов линейной фильтрации это может привести к появлению артефактов на краях текстуры, когда сэмплер фильтрует края текстуры. |
Max = 4 | Максимальное значение для перечисления |
Mirror = 3 | При повторении переворачивайте текстуру так, чтобы края совпадали, а не резко менялись. |
RenderingServer.CanvasLightBlendMode
RenderingServer.CanvasLightMode
| Значение | Описание |
|---|---|
Directional = 1 | 2D направленный (солнце/луна) свет (см. |
Point = 0 | 2D точечный источник света (см. |
RenderingServer.CanvasLightShadowFilter
| Значение | Описание |
|---|---|
Max = 3 | Максимальное значение перечисления |
None = 0 | Не применяйте фильтр к светлым теням на холсте. |
Pcf13 = 2 | Используйте фильтрацию PCF13 для фильтрации теней на холсте. |
Pcf5 = 1 | Используйте фильтрацию PCF5 для фильтрации теней от света на холсте. |
RenderingServer.CanvasOccluderPolygonCullMode
| Значение | Описание |
|---|---|
Clockwise = 1 | Отбраковка холста-окклюдера производится по часовой стрелке. |
CounterClockwise = 2 | Отбраковка холста-окклюдера производится против часовой стрелки.
|
Disabled = 0 | Отбраковка окклюдера холста отключена. |
RenderingServer.CanvasTextureChannel
| Значение | Описание |
|---|---|
Diffuse = 0 | Рассеянная текстура холста ( |
Normal = 1 | Текстура холста карты нормалей ( |
Specular = 2 | Текстура холста карты отражений ( |
RenderingServer.CompositorEffectCallbackType
| Значение | Описание |
|---|---|
Any = -1 | |
PostOpaque = 1 | Обратный вызов выполняется после прохода рендеринга непрозрачности, но до рендеринга неба. |
PostSky = 2 | Обратный вызов вызывается после того, как наше небо отрисовано, но до создания наших обратных буферов (и, если они включены, до подповерхностного рассеивания и/или отражений в пространстве экрана). |
PostTransparent = 4 | Обратный вызов выполняется после прохода прозрачного рендеринга, но до любых встроенных эффектов постобработки и вывода на нашу цель рендеринга. |
PreOpaque = 0 | Обратный вызов выполняется перед нашим проходом рендеринга непрозрачности, но после предварительного прохода глубины (если применимо). |
PreTransparent = 3 | Обратный вызов выполняется до прохода прозрачного рендеринга, но после того, как небо отрисовано и мы создали обратные буферы. |
RenderingServer.CompositorEffectFlags
| Значение | Описание |
|---|---|
AccessResolvedColor = 1 | Эффект рендеринга требует разрешения цветового буфера, если включен MSAA. |
AccessResolvedDepth = 2 | Эффект рендеринга требует разрешения буфера глубины, если включен MSAA. |
NeedsMotionVectors = 4 | Эффект рендеринга требует создания векторов движения. |
NeedsRoughness = 8 | Эффект рендеринга требует создания нормалей и g-буфера шероховатости (только Forward+). |
NeedsSeparateSpecular = 16 | Эффект рендеринга требует разделения зеркальных данных (только Forward+). |
RenderingServer.CubeMapLayer
RenderingServer.DecalFilter
| Значение | Описание |
|---|---|
Linear = 1 | Линейный фильтр для декалей (используется для декалей не пиксельной графики). Для рендеринга не используются mipmaps, что означает, что декали на расстоянии будут выглядеть гладкими, но размытыми. Это примерно равно затратам на производительность, как и использование mipmaps. |
LinearMipmaps = 3 | Линейный фильтр для декалей (используется для декалей не пиксельного искусства). Для рендеринга используются изотропные mip-карты, что означает, что декали на расстоянии будут выглядеть гладкими, но размытыми. Это примерно равно затратам на производительность, как и без использования mip-карт. |
LinearMipmapsAnisotropic = 5 | Линейный фильтр для декалей (используется для декалей не пиксельной графики). Анизотропные mip-карты используются для рендеринга, что означает, что декали на расстоянии будут выглядеть гладкими и резкими при просмотре под косыми углами. Это выглядит лучше по сравнению с изотропными mip-картами, но медленнее. Уровень анизотропной фильтрации определяется |
Nearest = 0 | Фильтр ближайшего соседа для декалей (используется для декалей пиксельной графики). Для рендеринга не используются mip-карты, что означает, что декали на расстоянии будут выглядеть резкими, но зернистыми. Это примерно равно затратам на производительность, как и использование mip-карт. |
NearestMipmaps = 2 | Фильтр ближайшего соседа для декалей (используется для декалей пиксельной графики). Для рендеринга используются изотропные MIP-карты, что означает, что декали на расстоянии будут выглядеть гладкими, но размытыми. Это примерно равно затратам на производительность, как и без использования MIP-карты. |
NearestMipmapsAnisotropic = 4 | Фильтр ближайшего соседа для декалей (используется для декалей пиксельной графики). Анизотропные MIP-карты используются для рендеринга, что означает, что декали на расстоянии будут выглядеть гладкими и резкими при просмотре под косыми углами. Это выглядит лучше по сравнению с изотропными MIP-картами, но медленнее. Уровень анизотропной фильтрации определяется |
RenderingServer.DecalTexture
| Значение | Описание |
|---|---|
Albedo = 0 | Слот текстуры альбедо в декали ( |
Emission = 3 | Слот текстуры излучения в декале ( |
Max = 4 | Представляет размер перечисления |
Normal = 1 | Слот текстуры карты нормалей в декале ( |
Orm = 2 | Слот текстуры окклюзии/шероховатости/металла в декали ( |
RenderingServer.DofBlurQuality
| Значение | Описание |
|---|---|
High = 3 | Высочайшее качество размытия глубины резкости. Результат — максимально плавное размытие за счет использования наибольшего количества образцов, но также значительно медленнее. |
Low = 1 | Низкое качество размытия глубины резкости. |
Medium = 2 | Среднее качество размытия глубины резкости. |
VeryLow = 0 | Размытие глубины резкости самого низкого качества. Это самая быстрая настройка, но вы можете увидеть артефакты фильтрации. |
RenderingServer.DofBokehShape
| Значение | Описание |
|---|---|
Box = 0 | Рассчитайте размытие глубины резкости, используя блочный фильтр. Самый быстрый вариант, но приводит к появлению явных линий в шаблоне размытия. |
Circle = 2 | Вычисляет размытие глубины резкости с помощью фильтра в форме круга. Лучшее качество и наиболее реалистичный, но самый медленный. Используйте только для областей, где большая часть производительности может быть выделена на постобработку (например, катсцены). |
Hexagon = 1 | Вычисляет размытие глубины резкости с помощью фильтра в форме шестиугольника. |
RenderingServer.EnvironmentAmbientSource
RenderingServer.EnvironmentBG
| Значение | Описание |
|---|---|
CameraFeed = 5 | Отображает изображение с камеры в фоновом режиме. |
Canvas = 3 | Использовать указанный слой холста в качестве фона. Это может быть полезно для создания 2D-сцены в 3D-мире. |
ClearColor = 0 | Используйте прозрачный цвет в качестве фона. ENV_BG_COLOR |
Color = 1 | Использует указанный цвет в качестве фона. |
Keep = 4 | Не очищает фон, использует в качестве фона то, что было отрендерено в последнем кадре. ENV_BG_CAMERA_FEDE |
Max = 6 | Представляет размер перечисления |
Sky = 2 | Использует в качестве фона изображение неба. ENV_BG_CANVAS |
RenderingServer.EnvironmentFogMode
| Значение | Описание |
|---|---|
Depth = 1 | Используйте простую модель тумана, определяемую начальным и конечным положениями и пользовательской кривой. Хотя эта модель не является физически точной, она может быть полезна, когда вам нужен более художественный контроль. |
Exponential = 0 | Используйте физическую модель тумана, определяемую в первую очередь плотностью тумана. |
RenderingServer.EnvironmentGlowBlendMode
| Значение | Описание |
|---|---|
Additive = 0 | Добавляет эффект свечения в сцену. |
Mix = 4 | Смешивает изображение свечения с изображением сцены. Лучше всего использовать с |
Replace = 3 | Заменяет цвет всех пикселей эффектом свечения. Это можно использовать для имитации эффекта размытия на весь экран, настроив параметры свечения так, чтобы они соответствовали яркости исходного изображения, или для предварительного просмотра конфигурации свечения в редакторе. |
Screen = 1 | Добавляет эффект свечения к сцене после изменения влияния свечения в зависимости от значения сцены; темные значения будут сильно подвержены влиянию свечения, а светлые — нет. Такой подход позволяет избежать чрезмерного усиления ярких значений из-за эффекта свечения. |
Softlight = 2 | Добавляет эффект свечения к тонированному изображению после изменения влияния свечения в зависимости от значения изображения; темные и светлые значения не будут подвержены влиянию свечения, а средние значения будут сильно подвержены его влиянию. Такой подход позволяет избежать чрезмерного увеличения яркости ярких значений из-за эффекта свечения. Свечение будет оказывать наибольшее влияние на значения изображения |
RenderingServer.EnvironmentReflectionSource
| Значение | Описание |
|---|---|
Bg = 0 | Использует фон для отражений. |
Disabled = 1 | Отключить отражение. |
Sky = 2 | Использует |
RenderingServer.EnvironmentSdfgiFramesToConverge
| Значение | Описание |
|---|---|
In10Frames = 1 | Настройте SDFGI для полной конвергенции за 10 кадров. |
In15Frames = 2 | Настройте SDFGI для полной конвергенции за 15 кадров. |
In20Frames = 3 | Настройте SDFGI для полной конвергенции более 20 кадров. |
In25Frames = 4 | Настройте SDFGI для полной конвергенции в течение 25 кадров. |
In30Frames = 5 | Настройте SDFGI для полной сходимости за 30 кадров. Это наименее отзывчивый вариант, но создает наименее шумный результат при заданном количестве лучей. |
In5Frames = 0 | Сведение SDFGI по 5 кадрам. Это наиболее отзывчивый вариант, но создает наиболее шумный результат при заданном количестве лучей. |
Max = 6 | Представляет размер перечисления |
RenderingServer.EnvironmentSdfgiFramesToUpdateLight
| Значение | Описание |
|---|---|
In16Frames = 4 | Обновить непрямой свет из динамического освещения в SDFGI более 16 кадров. Это наименее отзывчивый вариант, но имеет самые низкие требования к GPU. |
In1Frame = 0 | Обновить непрямой свет от динамического освещения в SDFGI за 1 кадр. Это самый отзывчивый вариант, но имеет самые высокие требования к GPU. |
In2Frames = 1 | Обновление непрямого света от динамических источников света в SDFGI на протяжении 2 кадров. |
In4Frames = 2 | Обновление непрямого света от динамических источников света в SDFGI на протяжении 4 кадров. |
In8Frames = 3 | Обновление непрямого света от динамических источников света в SDFGI на протяжении 8 кадров. |
Max = 5 | Представляет размер перечисления |
RenderingServer.EnvironmentSdfgiRayCount
| Значение | Описание |
|---|---|
Count128 = 6 | Выбрасывать 128 лучей на кадр при схождении SDFGI. Это имеет очень высокие требования к GPU, но создает наименее шумный результат. |
Count16 = 2 | При схождении SDFGI отбрасывать 16 лучей на кадр. |
Count32 = 3 | При схождении SDFGI отбрасывать 32 луча на кадр. |
Count4 = 0 | Выбрасывать 4 луча на кадр при схождении SDFGI. Это имеет самые низкие требования к GPU, но создает самый шумный результат. |
Count64 = 4 | При схождении SDFGI отбрасывать 64 луча на кадр. |
Count8 = 1 | При схождении SDFGI отбрасывать 8 лучей на кадр. |
Count96 = 5 | Выбрасывать 96 лучей на кадр при схождении SDFGI. Это предъявляет высокие требования к GPU. |
Max = 7 | Представляет размер перечисления |
RenderingServer.EnvironmentSdfgiyScale
| Значение | Описание |
|---|---|
Scale100Percent = 2 | Используйте масштаб 100% для SDFGI на оси Y (вертикальной). Ячейки SDFGI будут такими же высокими, как и широкими. Обычно это лучший выбор для сцен с высокой вертикальностью. Недостатком является то, что утечка света может стать более заметной при тонких полах и потолках. |
Scale50Percent = 0 | Используйте масштаб 50% для SDFGI по оси Y (вертикальной). Ячейки SDFGI будут в два раза короче своей ширины. Это позволяет повысить детализацию GI и уменьшить утечку света при тонких полах и потолках. Обычно это лучший выбор для сцен, в которых не так много вертикальности. ENV_SDFGI_Y_SCALE_75_PERCENT |
Scale75Percent = 1 | Используйте 75% масштаб для SDFGI на оси Y (вертикальной). Это баланс между 50% и 100% шкалами Y SDFGI. ENV_SDFGI_Y_SCALE_100_PERCENT |
RenderingServer.EnvironmentSsaoQuality
| Значение | Описание |
|---|---|
High = 3 | Высококачественная окклюзия окружающего пространства экрана. |
Low = 1 | Низкое качество окклюзии окружающего пространства экрана. ENV_SASO_QUALITY_MedIY |
Medium = 2 | Окклюзия окружающего пространства на экране среднего качества. |
Ultra = 4 | Окружающая окклюзия экранного пространства высочайшего качества. Использует адаптивную целевую настройку, которую можно динамически настраивать для плавного баланса производительности и визуального качества. |
VeryLow = 0 | Самое низкое качество окклюзии окружающего пространства экрана. |
RenderingServer.EnvironmentSsilQuality
| Значение | Описание |
|---|---|
High = 3 | Высококачественное непрямое освещение экранного пространства. |
Low = 1 | Непрямое освещение экранного пространства низкого качества. ENV_SIL_Quality_MedIY |
Medium = 2 | Высококачественное непрямое освещение экранного пространства. |
Ultra = 4 | Непрямое освещение экранного пространства высочайшего качества. Использует адаптивную целевую настройку, которую можно динамически регулировать для плавного баланса производительности и визуального качества. ENV_SDFGI_Y_SCALE_50_PERCENT |
VeryLow = 0 | Самое низкое качество непрямого освещения экранного пространства. |
RenderingServer.EnvironmentSsrRoughnessQuality
| Значение | Описание |
|---|---|
Disabled = 0 | Самое низкое качество фильтра шероховатости для отражений в пространстве экрана. Грубые материалы не будут иметь более размытых отражений в пространстве экрана по сравнению с гладкими (не шероховатыми) материалами. Это самый быстрый вариант. |
High = 3 | Высокое качество фильтра шероховатости для отражений в пространстве экрана. Это самый медленный вариант. |
Low = 1 | Низкое качество фильтра шероховатости для отражений в экранном пространстве. ENV_SSR_ROUNESC_QUALITY_MЕДИЯ |
Medium = 2 | Среднее качество фильтра шероховатости для отражений в пространстве экрана. |
RenderingServer.EnvironmentToneMapper
| Значение | Описание |
|---|---|
Aces = 3 | Использует высококонтрастную кривую тонального отображения, похожую на пленочную, и уменьшает насыщенность ярких значений для более реалистичного вида. Работает немного медленнее, чем |
Agx = 4 | Использует регулируемую кривую тонального отображения, аналогичную пленочной, и снижает насыщенность ярких значений для более реалистичного вида. Лучше других тональных преобразователей сохраняет оттенок цветов при их увеличении яркости. Самый медленный вариант тонального отображения. |
Filmic = 2 | Использует кривую тонального отображения, аналогичную пленочной, чтобы предотвратить обрезку ярких значений и обеспечить лучший контраст, чем |
Linear = 0 | Не изменяет цветовые данные, что приводит к линейной кривой тональной компрессии, которая неестественно обрезает яркие значения, из-за чего яркое освещение выглядит пересвеченным. Самый простой и быстрый тональный компрессионный фильтр. |
Reinhard = 1 | Простая кривая тональной компрессии, которая сглаживает яркие значения, чтобы предотвратить обрезку. Это приводит к изображению, которое может выглядеть тусклым и малоконтрастным. Медленнее, чем |
RenderingServer.Features
| Значение | Описание |
|---|---|
Multithreaded = 1 | |
Shaders = 0 |
RenderingServer.FogVolumeShape
| Значение | Описание |
|---|---|
Box = 3 |
|
Cone = 1 |
|
Cylinder = 2 |
|
Ellipsoid = 0 |
|
Max = 5 | Представляет размер перечисления |
World = 4 |
|
RenderingServer.GlobalShaderParameterType
| Значение | Описание |
|---|---|
Bool = 0 | Логический глобальный параметр шейдера ( |
Bvec2 = 1 | Глобальный параметр шейдера 2-мерного логического вектора ( |
Bvec3 = 2 | Глобальный параметр шейдера 3-мерного логического вектора ( |
Bvec4 = 3 | Глобальный параметр шейдера 4-мерного логического вектора ( |
Color = 17 | Глобальный параметр шейдера Color ( |
Float = 13 | Глобальный параметр шейдера с плавающей точкой одинарной точности ( |
Int = 4 | Целочисленный глобальный параметр шейдера ( |
Ivec2 = 5 | Глобальный параметр шейдера 2-мерного целочисленного вектора ( |
Ivec3 = 6 | Глобальный параметр шейдера 3-мерного целочисленного вектора ( |
Ivec4 = 7 | Глобальный параметр шейдера 4-мерного целочисленного вектора ( |
Mat2 = 19 | Параметр глобального шейдера матрицы 2×2 ( |
Mat3 = 20 | Параметр глобального шейдера матрицы 3×3 ( |
Mat4 = 21 | Параметр глобального шейдера матрицы 4×4 ( |
Max = 29 | Представляет размер перечисления |
Rect2 = 18 | Глобальный параметр шейдера 2-мерного прямоугольника с плавающей точкой ( |
Rect2I = 8 | Глобальный параметр шейдера 2-мерного целого прямоугольника (
|
Sampler2D = 24 | Параметр глобального шейдера 2D-сэмплера ( |
Sampler2Darray = 25 | Параметр глобального шейдера 2D-массива сэмплера ( |
Sampler3D = 26 | Параметр глобального шейдера 3D-сэмплера ( |
Samplercube = 27 | Параметр глобального шейдера сэмплера Cubemap ( |
Samplerext = 28 | Глобальный параметр шейдера внешнего сэмплера ( |
Transform = 23 | Параметр глобального шейдера 3-мерного преобразования ( |
Transform2D = 22 | Параметр глобального шейдера 2-мерного преобразования ( |
Uint = 9 | Беззнаковый целочисленный глобальный параметр шейдера ( |
Uvec2 = 10 | Глобальный параметр шейдера — двумерный беззнаковый целочисленный вектор ( |
Uvec3 = 11 | Глобальный параметр шейдера — 3-мерный беззнаковый целочисленный вектор ( |
Uvec4 = 12 | Глобальный параметр шейдера — 4-мерный беззнаковый целочисленный вектор ( |
Vec2 = 14 | Глобальный параметр шейдера 2-мерного вектора с плавающей точкой ( |
Vec3 = 15 | Глобальный параметр шейдера 3-мерного вектора с плавающей точкой ( |
Vec4 = 16 | Глобальный параметр шейдера 4-мерного вектора с плавающей точкой (
|
RenderingServer.InstanceFlags
| Значение | Описание |
|---|---|
DrawNextFrameIfVisible = 2 | Если установлено, вручную запрашивает рисование геометрии в следующем кадре. |
IgnoreOcclusionCulling = 3 | Всегда рисует, даже если экземпляр будет отбракован в результате исключения окклюзии. Не влияет на отсечение усеченного изображения. |
Max = 4 | Представляет размер перечисления |
UseBakedLight = 0 | Позволяет использовать экземпляр в запеченном освещении. |
UseDynamicGI = 1 | Позволяет использовать экземпляр с динамическим глобальным освещением. |
RenderingServer.InstanceType
| Значение | Описание |
|---|---|
Decal = 7 | Экземпляр представляет собой декаль. |
FogVolume = 12 | Экземпляр представляет собой туманный объем. |
GeometryMask = 14 | Комбинация флагов экземпляров геометрии (сетка, multimesh, immediate и частицы). |
Light = 5 | Экземпляр представляет собой свет. |
Lightmap = 9 | Экземпляр представляет собой карту освещения. |
Max = 13 | Представляет размер перечисления |
Mesh = 1 | Экземпляр представляет собой сетку. |
Multimesh = 2 | Экземпляр представляет собой многосетку. |
None = 0 | Экземпляр не имеет типа. |
Occluder = 10 | Экземпляр представляет собой окклюдер, исключающий окклюзию. |
Particles = 3 | Данный экземпляр - источник частиц. |
ParticlesCollision = 4 | Экземпляр представляет собой форму столкновения GPUParticles. |
ReflectionProbe = 6 | Данный экземпляр - проба отражения. |
VisiblityNotifier = 11 | Экземпляр представляет собой видимое на экране уведомление. |
VoxelGI = 8 | Экземпляр представляет собой VoxelGI. |
RenderingServer.LightBakeMode
| Значение | Описание |
|---|---|
Disabled = 0 | При запекании свет игнорируется. Это самый быстрый режим, но свет будет учитываться при запекании глобального освещения. Этот режим обычно следует использовать для динамических источников света, которые быстро меняются, так как эффект глобального освещения на таких источниках света менее заметен. |
Dynamic = 2 | Свет учитывается при динамическом запекании (только |
Static = 1 | Свет учитывается при статическом запекании ( |
RenderingServer.LightDirectionalShadowMode
| Значение | Описание |
|---|---|
Orthogonal = 0 | Использует ортогональную теневую проекцию для направленного света. |
Parallel2Splits = 1 | При использовании направленного света использует 2 прожектора для проецирования тени. |
Parallel4Splits = 2 | При использовании направленного света использует 4 прожектора для проекции тени. |
RenderingServer.LightDirectionalSkyMode
| Значение | Описание |
|---|---|
LightAndSky = 0 | Использует DirectionalLight3D как для рендеринга неба, так и для освещения сцены. |
LightOnly = 1 | Используйте DirectionalLight3D только для освещения сцены. |
SkyOnly = 2 | Использует DirectionalLight3D только при рендеринге неба. |
RenderingServer.LightOmniShadowMode
| Значение | Описание |
|---|---|
Cube = 1 | Используйте кубическую карту теней для всенаправленного света. Медленнее, но лучше по качеству, чем двойной параболоид. |
DualParaboloid = 0 | Используйте двойную параболоидную карту теней для всенаправленных источников света. |
RenderingServer.LightParam
| Значение | Описание |
|---|---|
Attenuation = 6 | Затухание света. |
ContactShadowBlur = 22 | Прожечь края контактной тени. |
ContactShadowOpacity = 21 | Изменяет дымность фонарей, экранных и космических контактных теней. |
Energy = 0 | Умножитель энергии света. |
IndirectEnergy = 1 | Множитель косвенной энергии света (окончательная косвенная энергия равна |
Intensity = 20 | Константа, представляющая интенсивность света, измеряемая в люменах при работе с |
Max = 23 | Представляет размер перечисления |
Range = 4 | Радиус охвата света. |
ShadowBias = 15 | Смещение (Bias) для поиска теней с целью устранения артефактов самозатенения. |
ShadowBlur = 18 | Размывает края тени. Может использоваться для скрытия пиксельных артефактов в картах теней с низким разрешением. Высокое значение может сделать тени зернистыми и вызвать другие нежелательные артефакты. Постарайтесь сохранить значение как можно ближе к значению по умолчанию. |
ShadowFadeStart = 13 | Доля максимального расстояния тени, на котором тень начнет исчезать. |
ShadowMaxDistance = 9 | Максимальное расстояние для разделения теней. Увеличение этого значения сделает направленные тени видимыми с большего расстояния, за счет снижения общей детализации теней и производительности (поскольку больше объектов должны быть включены в рендеринг направленных теней). |
ShadowNormalBias = 14 | Нормальное смещение, используемое для смещения поиска тени по нормали объекта. Может использоваться для исправления артефактов самозатенения. |
ShadowOpacity = 17 | Непрозрачность тени света. Значения ниже |
ShadowPancakeSize = 16 | Устанавливает размер направленного блина тени. Блин смещает начало усеченной пирамиды тени, чтобы обеспечить более высокое эффективное разрешение глубины для тени. Однако большой размер блина может привести к появлению артефактов в тенях крупных объектов, которые находятся близко к краю пирамиды. Уменьшение размера блина может помочь. Установка размера на |
ShadowSplit1Offset = 10 | Доля теневого атласа, занимаемая первым разделением. |
ShadowSplit2Offset = 11 | Доля теневого атласа, занимаемая вторым разделением. |
ShadowSplit3Offset = 12 | Часть теневого атласа, занимаемая третьим разрезом. Четвертый разрезом занимает все остальное. |
Size = 5 | Размер света при использовании точечного света или всенаправленного света. Угловой размер света при использовании направленного света. |
Specular = 3 | Влияние света на зеркальность. |
SpotAngle = 7 | Угол освещения. |
SpotAttenuation = 8 | Ослабление точечного света. |
TransmittanceBias = 19 | |
VolumetricFogEnergy = 2 | Множитель энергии объемного тумана источника света (окончательная энергия объемного тумана равна |
RenderingServer.LightProjectorFilter
| Значение | Описание |
|---|---|
Linear = 1 | Линейный фильтр для проекторов света (используется для проекторов света без пиксельной графики). Для рендеринга не используются mip-карты, что означает, что проекторы света на расстоянии будут выглядеть гладкими, но размытыми. Это примерно равно затратам на производительность, как и использование mip-карт. |
LinearMipmaps = 3 | Линейный фильтр для проекторов света (используется для проекторов света, не использующих пиксельную графику). Для рендеринга используются изотропные mip-карты, что означает, что проекторы света на расстоянии будут выглядеть гладкими, но размытыми. Это примерно равно затратам на производительность, как и без использования mip-карт. |
LinearMipmapsAnisotropic = 5 | Линейный фильтр для проекторов света (используется для проекторов света, не использующих пиксельную графику). Анизотропные mip-текстуры используются для рендеринга, что означает, что проекторы света на расстоянии будут выглядеть гладкими и резкими при просмотре под косыми углами. Это выглядит лучше по сравнению с изотропными mip-текстурами, но медленнее. Уровень анизотропной фильтрации определяется |
Nearest = 0 | Фильтр ближайшего соседа для проекторов света (используется для проекторов света пиксельной графики). Для рендеринга не используются mip-карты, что означает, что проекторы света на расстоянии будут выглядеть резкими, но зернистыми. Это примерно равно затратам на производительность, как и использование mip-карт. |
NearestMipmaps = 2 | Фильтр ближайшего соседа для проекторов света (используется для проекторов света пиксельной графики). Для рендеринга используются изотропные mip-карты, что означает, что проекторы света на расстоянии будут выглядеть гладкими, но размытыми. Это примерно равно затратам на производительность, как и без использования mip-карт. |
NearestMipmapsAnisotropic = 4 | Фильтр ближайшего соседа для проекторов света (используется для проекторов света в пиксельной графике). Анизотропные MIP-карты используются для рендеринга, что означает, что проекторы света на расстоянии будут выглядеть гладкими и резкими при просмотре под косыми углами. Это выглядит лучше по сравнению с изотропными MIP-картами, но медленнее. Уровень анизотропной фильтрации определяется |
RenderingServer.LightType
| Значение | Описание |
|---|---|
Area = 3 | Областной источник света (см. |
Directional = 0 | Направленный (солнечный/лунный) свет (см. |
Omni = 1 | Всенаправленный свет (см. |
Spot = 2 | Точечный свет (см. Святой свет |
RenderingServer.MultimeshPhysicsInterpolationQuality
RenderingServer.MultimeshTransformFormat
| Значение | Описание |
|---|---|
Transform2D = 0 | Используйте |
Transform3D = 1 | Используйте |
RenderingServer.NinePatchAxisMode
| Значение | Описание |
|---|---|
Stretch = 0 | Девятый патч растягивается там, где это необходимо. ДЕВЯТЬ |
Tile = 1 | Девятый патч заполняются тайлами там, где это необходимо. |
TileFit = 2 | Девятый патч заполняется тайлами там, где это необходимо, и при необходимости немного их растягивает. |
RenderingServer.ParticlesCollisionHeightfieldResolution
| Значение | Описание |
|---|---|
Max = 6 | Представляет размер перечисления |
Resolution1024 = 2 | Разрешение поля высот 1024×1024 для |
Resolution2048 = 3 | Разрешение карты высот 2048×2048 для |
Resolution256 = 0 | разрешение карты высот 256×256 для |
Resolution4096 = 4 | Разрешение поля высот 4096×4096 для |
Resolution512 = 1 | разрешение карты высот 512×512 для |
Resolution8192 = 5 | Разрешение поля высот 8192×8192 для |
RenderingServer.ParticlesCollisionType
| Значение | Описание |
|---|---|
BoxAttract = 1 | Тип аттрактора Box для |
BoxCollide = 4 | Тип столкновения Box для |
HeightfieldCollide = 6 | Тип столкновения по высотному полю для |
SdfCollide = 5 | Тип столкновения по полю знаковых расстояний для |
SphereAttract = 0 | Тип аттрактора «Сфера» для |
SphereCollide = 3 | Тип столкновения сфер для |
VectorFieldAttract = 2 | Тип аттрактора векторного поля для |
RenderingServer.ParticlesDrawOrder
| Значение | Описание |
|---|---|
Index = 0 | Рисуйте частицы в том порядке, в котором они появляются в массиве частиц. |
Lifetime = 1 | Сортировать частицы по времени их жизни. Другими словами, частица с наибольшим временем жизни вытягивается вперед. |
ReverseLifetime = 2 | Сортировать частицы по обратному времени их жизни. Другими словами, частица с наименьшим временем жизни вытягивается вперед. |
ViewDepth = 3 | Сортировать частицы по их расстоянию до камеры. |
RenderingServer.ParticlesMode
| Значение | Описание |
|---|---|
Mode2D = 0 | 2D частицы. |
Mode3D = 1 | 3D частицы. |
RenderingServer.ParticlesTransformAlign
| Значение | Описание |
|---|---|
Disabled = 0 | Не следует выравнивать преобразования частиц относительно камеры или скорости. |
LocalBillboard = 4 | На рекламном щите (Billboard) каждая частица вращается вокруг локальной оси. |
YToVelocity = 2 | Выровняйте ось Y каждой частицы по вектору скорости. |
ZBillboard = 1 | Расположите ось Z каждой частицы так, чтобы она была направлена в сторону камеры. |
ZBillboardYToVelocity = 3 | Расположите ось Z каждой частицы напротив камеры, а ось Y — относительно вектора скорости. |
RenderingServer.ParticlesTransformAlignAxis
RenderingServer.ParticlesTransformAlignCustomSrc
| Значение | Описание |
|---|---|
Disabled = 0 | При размещении рекламных щитов не используйте пользовательские настройки (CUSTOM). |
W = 4 | При выполнении билбординга считывайте данные из файла |
X = 1 | При выполнении билбординга считывайте данные из |
Y = 2 | При выполнении билбординга считывайте данные из файла |
Z = 3 | При выполнении билбординга считывайте данные из файла |
RenderingServer.PipelineSource
| Значение | Описание |
|---|---|
Canvas = 0 | Конвейерная компиляция, запущенная рендерером 2D-холста. |
Draw = 3 | Компиляция конвейера, запущенная во время отрисовки сцены. |
Max = 5 | Представляет размер перечисления |
Mesh = 1 | Компиляция конвейера, запущенная загрузкой сетки. |
Specialization = 4 | Конвейерная компиляция, запущенная для оптимизации текущей сцены. |
Surface = 2 | Конвейерная компиляция, которая была запущена путем создания кэша поверхности перед рендерингом сцены. |
RenderingServer.PrimitiveType
| Значение | Описание |
|---|---|
LineStrip = 2 | Примитив для рисования состоит из полосы линий от начала до конца. |
Lines = 1 | Примитив для рисования состоящий из линий. |
Max = 5 | Представляет размер перечисления |
Points = 0 | Примитив для рисования состоящий из точек. |
TriangleStrip = 4 | Примитив для рисования состоящий из полосы треугольников (последние 3 вершины всегда объединяются, образуя треугольник). |
Triangles = 3 | Примитивный рисунок состоящий из треугольников. |
RenderingServer.ReflectionProbeAmbientMode
| Значение | Описание |
|---|---|
Color = 2 | Применить специальное освещение окружающей среды в ящике отражательного зонда, определенное по его размеру. ДЕКЛАЛ ТЕКСТУРА |
Disabled = 0 | Не допускайте попадания внешнего освещения внутрь корпуса отражательного зонда, размер которого определяется его размерами. |
Environment = 1 | Примените автоматически источник окружающего освещения внутри корпуса отражательного зонда, определяемого его размером. |
RenderingServer.ReflectionProbeUpdateMode
| Значение | Описание |
|---|---|
Always = 1 | Зонд отражения будет обновлять каждый кадр. Этот режим необходим для захвата движущихся объектов. |
Once = 0 | Зонд отражения обновит отражения один раз, а затем остановится. |
RenderingServer.RenderingInfo
| Значение | Описание |
|---|---|
BufferMemUsed = 4 | Используемая буферная память (в байтах). Сюда входят данные вершин, однородные буферы и множество различных типов буферов, используемых внутри. |
PipelineCompilationsCanvas = 6 | Количество компиляций конвейера, которые были запущены рендерером 2D Canvas. |
PipelineCompilationsDraw = 9 | Количество компиляций конвейера, которые были запущены при отрисовке сцены. Эти компиляции будут отображаться как подтормаживания во время игрового процесса, когда пользователь впервые запускает игру и требуется конвейер. |
PipelineCompilationsMesh = 7 | Количество компиляций конвейера, которые были вызваны загрузкой сеток. Эти компиляции будут отображаться как более длительное время загрузки при первом запуске игры пользователем, и конвейер требуется. |
PipelineCompilationsSpecialization = 10 | Количество компиляций конвейера, которые были запущены для оптимизации текущей сцены. Эти компиляции выполняются в фоновом режиме и не должны вызывать никаких задержек. |
PipelineCompilationsSurface = 8 | Количество компиляций конвейера, запущенных при создании кэша поверхности перед рендерингом сцены. Эти компиляции будут проявляться в виде подтормаживаний при загрузке сцены при первом запуске игры пользователем, когда требуется конвейер. |
TextureMemUsed = 3 | Texture Используется память (в байтах). |
TotalDrawCallsInFrame = 2 | Количество вызовов отрисовки, выполненных для рендеринга в текущей 3D-сцене. Это зависит от положения камеры и поворота. |
TotalObjectsInFrame = 0 | Количество объектов, визуализированных в текущей 3D-сцене. Это зависит от положения камеры и поворота. |
TotalPrimitivesInFrame = 1 | Количество точек, линий или треугольников, визуализированных в текущей 3D-сцене. Это зависит от положения камеры и поворота. |
VideoMemUsed = 5 | Используемая видеопамять (в байтах). При использовании рендереров Forward+ или Mobile это всегда больше суммы |
RenderingServer.ShaderMode
| Значение | Описание |
|---|---|
CanvasItem = 1 | Shader 2D-штор. |
Fog = 4 | Shader 3D туманный теннис. |
Max = 6 | Представляет размер перечисления |
Particles = 2 | Shader — шейдер частиц (может использоваться как в 2D, так и в 3D). |
Sky = 3 | Shader 3D стеклянная. |
Spatial = 0 | Shader это трехмерный тендер. |
TextureBlit = 5 | Shader — это шейдер texture_blit. |
RenderingServer.ShadowCastingSetting
| Значение | Описание |
|---|---|
DoubleSided = 2 | Отключить отбраковку задней поверхности при рендеринге тени объекта. Это немного медленнее, но может привести к более правильным теням. |
Off = 0 | Отключает тени в данном экземпляре. |
On = 1 | Отбрасывает тени от этого экземпляра. |
ShadowsOnly = 3 | Отрисовывать только тени от объекта. Сам объект не будет отрисован. |
RenderingServer.ShadowQuality
| Значение | Описание |
|---|---|
Hard = 0 | Самое низкое качество фильтрации теней (самое быстрое). Мягкие тени недоступны с этой настройкой качества, что означает, что свойство |
Max = 6 | Представляет размер перечисления |
SoftHigh = 4 | Высокое низкое качество фильтрации теней (медленно). При использовании этой настройки качества |
SoftLow = 2 | Низкое качество фильтрации теней (быстро). |
SoftMedium = 3 | Среднее качество фильтрации теней. |
SoftUltra = 5 | Самое высокое низкое качество фильтрации теней (самое медленное). При использовании этой настройки качества |
SoftVeryLow = 1 | Очень низкое качество фильтрации теней (быстрее). При использовании этой настройки качества |
RenderingServer.SkyMode
| Значение | Описание |
|---|---|
Automatic = 0 | Автоматически выбирает подходящий режим обработки на основе вашего шейдера неба. Если ваш шейдер использует |
Incremental = 2 | Использует ту же выборку высокого качества для обработки карты сияния, что и |
Quality = 1 | Использует выборку важности высокого качества для обработки карты сияния. В целом, это приводит к гораздо более высокому качеству, чем |
Realtime = 3 | Использует алгоритм быстрой фильтрации для обработки карты сияния. В целом это приводит к снижению качества, но существенному ускорению времени выполнения. Если вам нужно лучшее качество, но при этом необходимо обновлять небо в каждом кадре, рассмотрите возможность включения |
RenderingServer.SplashStretchMode
| Значение | Описание |
|---|---|
Cover = 4 | Растягивает изображение, чтобы оно покрывало весь экран, сохраняя при этом соотношение сторон. |
Disabled = 0 | Растяжение не применяется. |
Ignore = 5 | Растягивает изображение на весь экран, но не сохраняет соотношение сторон. |
Keep = 1 | Растягивает изображение на весь экран, сохраняя при этом соотношение сторон. |
KeepHeight = 3 | Растягивает ширину изображения в соответствии с высотой экрана. |
KeepWidth = 2 | Растягивает высоту изображения в соответствии с шириной экрана. |
RenderingServer.SubSurfaceScatteringQuality
| Значение | Описание |
|---|---|
Disabled = 0 | Полностью отключает подповерхностное рассеивание, даже для материалов, у которых |
High = 3 | Высокое качество подповерхностного рассеивания. Это имеет самые высокие требования к GPU. |
Low = 1 | Низкое качество подповерхностного рассеяния. |
Medium = 2 | Среднее качество подповерхностного рассеяния. |
RenderingServer.TextureDrawableFormat
| Значение | Описание |
|---|---|
Rgba8 = 0 | Текстурный формат OpenGL RGBA, состоящий из четырех компонентов, каждый с 8-битной глубиной цвета. |
Rgba8Srgb = 1 | Текстурный формат OpenGL RGBA с четырьмя компонентами, каждый с 8-битной глубиной цвета. При отрисовке выполняется преобразование цветового пространства sRGB в линейное. |
Rgbaf = 3 | Текстурный формат OpenGL GL_RGBA32F, состоящий из четырех компонентов, каждый из которых представляет собой 32-битное значение с плавающей запятой. |
Rgbah = 2 | Текстурный формат OpenGL GL_RGBA16F, состоящий из четырех компонентов, каждый из которых представляет собой 16-битное значение с плавающей запятой "половинной точности". |
RenderingServer.TextureLayeredType
| Значение | Описание |
|---|---|
Cubemap = 1 | Cubemap текстура (см. |
CubemapArray = 2 | Array Текстура кубических карт (см. |
Layered2DArray = 0 | Array двухмерные текстуры (см. |
RenderingServer.TextureType
| Значение | Описание |
|---|---|
Layered = 1 | Многослойная текстура. |
Type2D = 0 | 2D текстура. |
Type3D = 2 | 3D текстура. ТЕКСТУРА ВОССТАНОВЛЕННАЯ 2D_АРРЕЙ* |
RenderingServer.ViewportAnisotropicFiltering
| Значение | Описание |
|---|---|
Anisotropy16X = 4 | Используйте 16-кратную анизотропную фильтрацию. |
Anisotropy2X = 1 | Используйте 2-кратную анизотропную фильтрацию. |
Anisotropy4X = 2 | Использовать 4× анизотропную фильтрацию. Это значение по умолчанию. |
Anisotropy8X = 3 | Используйте 8-кратную анизотропную фильтрацию. |
Disabled = 0 | Анизотропная фильтрация отключена. |
Max = 5 | Представляет размер перечисления |
RenderingServer.ViewportClearMode
| Значение | Описание |
|---|---|
Always = 0 | Перед отображением всегда очищает цель рендеринга области просмотра. |
Never = 1 | Никогда не очищайте цель рендеринга области просмотра. |
OnlyNextFrame = 2 | Очистите цель рендеринга области просмотра на следующем кадре, затем переключитесь на |
RenderingServer.ViewportDebugDraw
| Значение | Описание |
|---|---|
ClusterDecals = 22 | Рисует кластер |
ClusterOmniLights = 20 | Рисует кластер |
ClusterReflectionProbes = 23 | Рисует кластер |
ClusterSpotLights = 21 | Рисует кластер |
DecalAtlas = 15 | Рисует атлас декалей, в котором хранятся текстуры декалей из |
DirectionalShadowAtlas = 10 | Рисует атлас теней, в котором хранятся тени от |
DisableLod = 19 | Отключить LOD сетки. Все сетки прорисованы с полной детализацией, что можно использовать для сравнения производительности. |
Disabled = 0 | Отладочная отрисовка отключена. Настройка по умолчанию. |
GIBuffer = 18 | Рисует глобальный буфер освещения из |
InternalBuffer = 26 | Вместо обычной сцены рисуется внутренний буфер, поэтому вы можете видеть попиксельный вывод, который будет использоваться эффектами постобработки. Примечание: Поддерживается только при использовании методов рендеринга Forward+ или Mobile. |
Lighting = 2 | Объекты отображаются только с информацией об освещении. Примечание: В этом режиме отладки пользовательские шейдеры игнорируются, поскольку все материалы в сцене временно используют отладочный материал. Это означает, что результаты пользовательских шейдерных функций (например, смещения вершин) не будут отображаться в данном режиме отладки. |
MotionVectors = 25 | Рисует буфер векторов движения. Используется временным сглаживанием для коррекции движения, которое происходит во время игры. Примечание: Поддерживается только при использовании метода рендеринга Forward+. |
NormalBuffer = 5 | Вместо обычной сцены отрисовывается обычный буфер, чтобы вы могли видеть попиксельные нормали, которые будут использоваться эффектами постобработки. |
Occluders = 24 | Рисует буфер отсечения окклюзии. Этот буфер отсечения окклюзии низкого разрешения растеризуется на CPU и используется для проверки того, перекрыты ли экземпляры другими объектами. Примечание: Поддерживается только при использовании методов рендеринга Forward+ или Mobile. |
Overdraw = 3 | Объекты отображаются полупрозрачными с аддитивным смешиванием, так что вы можете видеть, где они рисуются друг над другом. Более высокая перерисовка (представленная более яркими цветами) означает, что вы тратите производительность на рисование пикселей, которые скрыты за другими. Примечание: При использовании этого режима отладки отрисовки, пользовательские шейдеры игнорируются, поскольку все материалы в сцене временно используют отладочный материал. Это означает, что результат функций пользовательских шейдеров (например, смещение вершин) больше не будет виден при использовании этого режима отладки отрисовки. |
PssmSplits = 14 | Окрашивает каждое разделение PSSM для |
SceneLuminance = 11 | Рисует предполагаемую яркость сцены. Это текстура 1×1, которая генерируется при включении автоэкспозиции для управления экспозицией сцены. Примечание: Поддерживается только при использовании методов рендеринга Forward+ или Mobile. |
Sdfgi = 16 | Рисует каскадные данные SDFGI. Это структура данных, которая используется для отражения света и создания отражений. Примечание: Поддерживается только при использовании метода рендеринга Forward+. |
SdfgiProbes = 17 | Отображает данные зонда SDFGI. Это структура данных, используемая для динамического освещения движущихся объектов в сцене. В редакторе, щелчок левой кнопкой мыши по зонду отобразит дополнительные яркие точки, показывающие информацию о его окклюзии. Белая точка означает, что источник света в точке не перекрыт, а красная точка означает, что источник света полностью перекрыт. Возможны промежуточные значения. Примечание: Поддерживается только при использовании метода рендеринга Forward+. |
ShadowAtlas = 9 | Рисует атлас теней, в котором хранятся тени от |
Ssao = 12 | Рисует текстуру экранного пространства Внешнее перекрытие вместо сцены, чтобы вы могли четко видеть, как она влияет на объекты. Чтобы этот режим отображения работал, необходимо установить |
Ssil = 13 | Рисует текстуру непрямого освещения экранного пространства вместо сцены, чтобы вы могли четко видеть, как она влияет на объекты. Чтобы этот режим отображения работал, необходимо установить |
Unshaded = 1 | Объекты отображаются без световой информации. |
VoxelGIAlbedo = 6 | Объекты отображаются только со значением альбедо из |
VoxelGIEmission = 8 | Объекты отображаются только с цветом излучения (emission) от |
VoxelGILighting = 7 | Объекты отображаются только со значением освещения из |
Wireframe = 4 | Отладочная отрисовка отображает объекты в каркасном режиме.
Примечание: Метод |
RenderingServer.ViewportEnvironmentMode
| Значение | Описание |
|---|---|
Disabled = 0 | Отключить рендеринг 3D-среды на 2D-холсте. |
Enabled = 1 | Включить рендеринг 3D-среды на 2D-холсте. |
Inherit = 2 | Наследовать значение включения/выключения от родителя. Если самый верхний родитель также установлен на |
Max = 3 | Представляет размер перечисления |
RenderingServer.ViewportMsaa
| Значение | Описание |
|---|---|
Disabled = 0 | Мульти-образец сглаживание для 3D отключено. Это значение по умолчанию, а также самая быстрая настройка. |
Max = 4 | Представляет размер перечисления |
Msaa2X = 1 | Мультисэмпл сглаживание использует 2 сэмпла на пиксель для 3D. Это оказывает умеренное влияние на производительность. |
Msaa4X = 2 | Мультисэмпл сглаживание использует 4 сэмпла на пиксель для 3D. Это сильно влияет на производительность. |
Msaa8X = 3 | Мультисэмпл сглаживание использует 8 сэмплов на пиксель для 3D. Это очень сильно влияет на производительность. Вероятно, не поддерживается на низкопроизводительном и старом оборудовании. |
RenderingServer.ViewportOcclusionCullingBuildQuality
| Значение | Описание |
|---|---|
High = 2 | Высокое качество сборки Окультирование BVH (согласно определению Embree). Приводит к наибольшей загрузке ЦП, но наиболее эффективному culling. |
Low = 0 | Низкое качество сборки Окультирование BVH (согласно определению Embree). Приводит к наименьшему использованию ЦП, но наименее эффективному culling. |
Medium = 1 | Среднее качество сборки BVH с отбраковкой окклюзии (согласно определению Embree). |
RenderingServer.ViewportRenderInfo
| Значение | Описание |
|---|---|
DrawCallsInFrame = 2 | Количество вызовов отрисовки в этом кадре. |
Max = 3 | Представляет размер перечисления |
ObjectsInFrame = 0 | Количество объектов, нарисованных в одном кадре. |
PrimitivesInFrame = 1 | Количество точек, линий или треугольников, нарисованных в одном кадре. |
RenderingServer.ViewportRenderInfoType
| Значение | Описание |
|---|---|
Canvas = 2 | Рендеринг элемента Canvas (холст). Сюда входит весь 2D-рендеринг. |
Max = 3 | Представляет размер перечисления |
Shadow = 1 | Проход рендеринга теней. Объекты будут рендериться несколько раз в зависимости от количества источников света с тенями и количества направленных теневых разделений. |
Visible = 0 | Видимый проход рендеринга (без теней). |
RenderingServer.ViewportScaling3DMode
| Значение | Описание |
|---|---|
Bilinear = 0 | Используйте билинейное масштабирование для 3D-буфера области просмотра. Величину масштабирования можно задать с помощью |
Fsr = 1 | Используйте upscaling - AMD FilitityFX Суперразрешение 1.0 для 3D-буфера области просмотра. Величину масштабирования можно задать с помощью |
Fsr2 = 2 | Используйте масштабирование AMD FilitityFX Суперразрешение 2.2 для 3D-буфера области просмотра. Величину масштабирования можно задать с помощью |
Max = 6 | Представляет размер перечисления |
MetalfxSpatial = 3 | Используйте пространственное масштабирование MetalFX для 3D-буфера области просмотра. Величину масштабирования можно задать с помощью |
MetalfxTemporal = 4 | Используйте временное масштабирование MetalFX для 3D-буфера области просмотра. Величину масштабирования можно задать с помощью |
Nearest = 5 | Используйте фильтрацию ближайших соседей для 3D-буфера видового окна. Это обеспечивает более четкое изображение, чем при использовании |
RenderingServer.ViewportScreenSpaceAA
| Значение | Описание |
|---|---|
Disabled = 0 | Не выполняйте сглаживание при полноэкранной постобработке. |
Fxaa = 1 | Использует быстрое приблизительное сглаживание. FXAA — популярный метод сглаживания в экранном пространстве, который быстр, но делает изображение размытым, особенно при низком разрешении. Он может работать относительно хорошо при больших разрешениях, таких как 1440p и 4K. |
Max = 3 | Представляет размер перечисления |
Smaa = 2 | Использовать субпиксельное морфологическое сглаживание (SMAA). SMAA может давать более чёткие результаты, чем FXAA, но требует несколько больших затрат производительности. |
RenderingServer.ViewportSdfOversize
| Значение | Описание |
|---|---|
Max = 4 | Представляет размер перечисления |
Oversize100Percent = 0 | Не превышайте размер поля расстояния со знаком 2D. Окклюдеры могут исчезнуть при касании краев области просмотра, а столкновение |
Oversize120Percent = 1 | Двумерное знаковое поле расстояний охватывает 20% размера области просмотра за пределами области просмотра с каждой стороны (сверху, справа, снизу, слева). |
Oversize150Percent = 2 | Двумерное поле расстояний со знаком покрывает 50% размера области просмотра за пределами области просмотра с каждой стороны (сверху, справа, снизу, слева). |
Oversize200Percent = 3 | 2D подписанное поле расстояний покрывает 100% размера области просмотра за пределами области просмотра с каждой стороны (сверху, справа, снизу, слева). Это имеет самые высокие требования к графическому процессору. |
RenderingServer.ViewportSdfScale
| Значение | Описание |
|---|---|
Max = 3 | Представляет размер перечисления |
Scale100Percent = 0 | Полное разрешение 2D знаковой шкалы расстояний поля. Это имеет самые высокие требования к графическому процессору. |
Scale25Percent = 2 | Разрешение четверти, шкала поля расстояний со знаком 2D на каждой оси (6,25% от количества пикселей окна просмотра). Это имеет самые низкие требования к графическому процессору. |
Scale50Percent = 1 | Двумерная шкала поля расстояний со знаком и половинным разрешением по каждой оси (25% от количества пикселей в области просмотра). |
RenderingServer.ViewportUpdateMode
| Значение | Описание |
|---|---|
Always = 4 | Всегда обновляет цель рендеринга области просмотра. |
Disabled = 0 | Не обновляет цель рендеринга области просмотра. |
Once = 1 | Обновите цель рендеринга области просмотра один раз, затем переключитесь на |
WhenParentVisible = 3 | Обновляйте цель рендеринга области просмотра только тогда, когда ее родительский элемент виден. |
WhenVisible = 2 | Обновлять цель рендеринга окна просмотра только тогда, когда она видна. Это значение по умолчанию. |
RenderingServer.ViewportVrsMode
| Значение | Описание |
|---|---|
Disabled = 0 | Затенение с переменной скоростью отключено. |
Max = 3 | Представляет размер перечисления |
Texture = 1 | Вариативная скорость затенения использует текстуру. Обратите внимание, для стереоскопического используйте текстурный атлас с текстурой для каждого вида. |
XR = 2 | Текстура затенения с переменной скоростью предоставляется первичным |
RenderingServer.ViewportVrsUpdateMode
| Значение | Описание |
|---|---|
Always = 2 | Входная текстура для затенения с переменной скоростью будет обрабатываться в каждом кадре. |
Disabled = 0 | Входная текстура для затенения с переменной скоростью не будет обработана. |
Max = 3 | Представляет размер перечисления |
Once = 1 | Входная текстура для затенения с переменной скоростью будет обработана один раз. |
RenderingServer.VisibilityRangeFadeMode
| Значение | Описание |
|---|---|
Dependencies = 2 | Показывать зависимости данного экземпляра при достижении пределов его диапазона видимости. Бейк Чаннель |
Disabled = 0 | Отключить затухание диапазона видимости для данного экземпляра. ВИЗИТ ВИДИМОСТЬ |
Self = 1 | Скрыть указанный экземпляр, когда он приближается к границам диапазона видимости. |