Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

Viewport

继承: Node < Object

派生: SubViewport, Window

视口的抽象基类。对绘图以及与游戏世界的交互进行了封装。

描述

Viewport(视口)会在屏幕中创建不同的视图,或是在其他视口中创建子视图。视口上会显示 2D 子节点,也会渲染 Camera3D 3D 子节点。

视口也可以拥有自己的 2D 或 3D 世界,这样就不会与其他视口共享绘制的内容。

视口也可以选择作为音频监听器,这样就可以根据 2D 或 3D 相机子节点生成位置音频。

另外,在设备有多个屏幕的情况下,可以将视口分配给不同的屏幕。

最后,视口也可以充当渲染目标,在这种情况下,除非使用与其相关联的纹理进行绘制,否则它们将不可见。

教程

属性

bool

audio_listener_enable_2d

false

bool

audio_listener_enable_3d

false

int

canvas_cull_mask

4294967295

DefaultCanvasItemTextureFilter

canvas_item_default_texture_filter

1

DefaultCanvasItemTextureRepeat

canvas_item_default_texture_repeat

0

Transform2D

canvas_transform

DebugDraw

debug_draw

0

bool

disable_3d

false

float

fsr_sharpness

0.2

Transform2D

global_canvas_transform

bool

gui_disable_input

false

bool

gui_embed_subwindows

false

bool

gui_snap_controls_to_pixels

true

bool

handle_input_locally

true

float

mesh_lod_threshold

1.0

MSAA

msaa_2d

0

MSAA

msaa_3d

0

bool

own_world_3d

false

bool

physics_object_picking

false

bool

physics_object_picking_sort

false

bool

positional_shadow_atlas_16_bits

true

PositionalShadowAtlasQuadrantSubdiv

positional_shadow_atlas_quad_0

2

PositionalShadowAtlasQuadrantSubdiv

positional_shadow_atlas_quad_1

2

PositionalShadowAtlasQuadrantSubdiv

positional_shadow_atlas_quad_2

3

PositionalShadowAtlasQuadrantSubdiv

positional_shadow_atlas_quad_3

4

int

positional_shadow_atlas_size

2048

Scaling3DMode

scaling_3d_mode

0

float

scaling_3d_scale

1.0

ScreenSpaceAA

screen_space_aa

0

SDFOversize

sdf_oversize

1

SDFScale

sdf_scale

1

bool

snap_2d_transforms_to_pixel

false

bool

snap_2d_vertices_to_pixel

false

float

texture_mipmap_bias

0.0

bool

transparent_bg

false

bool

use_debanding

false

bool

use_hdr_2d

false

bool

use_occlusion_culling

false

bool

use_taa

false

bool

use_xr

false

VRSMode

vrs_mode

0

Texture2D

vrs_texture

World2D

world_2d

World3D

world_3d

方法

World2D

find_world_2d ( ) const

World3D

find_world_3d ( ) const

Camera2D

get_camera_2d ( ) const

Camera3D

get_camera_3d ( ) const

bool

get_canvas_cull_mask_bit ( int layer ) const

Window[]

get_embedded_subwindows ( ) const

Transform2D

get_final_transform ( ) const

Vector2

get_mouse_position ( ) const

PositionalShadowAtlasQuadrantSubdiv

get_positional_shadow_atlas_quadrant_subdiv ( int quadrant ) const

int

get_render_info ( RenderInfoType type, RenderInfo info )

Transform2D

get_screen_transform ( ) const

ViewportTexture

get_texture ( ) const

RID

get_viewport_rid ( ) const

Rect2

get_visible_rect ( ) const

Variant

gui_get_drag_data ( ) const

Control

gui_get_focus_owner ( ) const

bool

gui_is_drag_successful ( ) const

bool

gui_is_dragging ( ) const

void

gui_release_focus ( )

bool

is_input_handled ( ) const

void

push_input ( InputEvent event, bool in_local_coords=false )

void

push_text_input ( String text )

void

push_unhandled_input ( InputEvent event, bool in_local_coords=false )

void

set_canvas_cull_mask_bit ( int layer, bool enable )

void

set_input_as_handled ( )

void

set_positional_shadow_atlas_quadrant_subdiv ( int quadrant, PositionalShadowAtlasQuadrantSubdiv subdiv )

void

update_mouse_cursor_state ( )

void

warp_mouse ( Vector2 position )


信号

gui_focus_changed ( Control node )

当控件节点获取键盘焦点时触发。


size_changed ( )

当视口的大小被改变时发出,无论是通过调整窗口大小,还是通过其他方式改变的大小。


枚举

enum PositionalShadowAtlasQuadrantSubdiv:

PositionalShadowAtlasQuadrantSubdiv SHADOW_ATLAS_QUADRANT_SUBDIV_DISABLED = 0

不使用该象限。

PositionalShadowAtlasQuadrantSubdiv SHADOW_ATLAS_QUADRANT_SUBDIV_1 = 1

该象限仅由一张阴影贴图使用。

PositionalShadowAtlasQuadrantSubdiv SHADOW_ATLAS_QUADRANT_SUBDIV_4 = 2

该象限将被分为 4 份,最多被 4 张阴影贴图使用。

PositionalShadowAtlasQuadrantSubdiv SHADOW_ATLAS_QUADRANT_SUBDIV_16 = 3

该象限将被分为 16 份,最多被 16 张阴影贴图使用。

PositionalShadowAtlasQuadrantSubdiv SHADOW_ATLAS_QUADRANT_SUBDIV_64 = 4

该象限将被分为 64 份,最多被 64 张阴影贴图使用。

PositionalShadowAtlasQuadrantSubdiv SHADOW_ATLAS_QUADRANT_SUBDIV_256 = 5

该象限将被分为 256 份,最多被 256 张阴影贴图使用。除非 positional_shadow_atlas_size 非常高,否则该象限中的阴影分辨率将非常低。

PositionalShadowAtlasQuadrantSubdiv SHADOW_ATLAS_QUADRANT_SUBDIV_1024 = 6

该象限将被分为 1024 份,最多被 1024 张阴影贴图使用。除非 positional_shadow_atlas_size 非常高,否则该象限中的阴影分辨率将非常低。

PositionalShadowAtlasQuadrantSubdiv SHADOW_ATLAS_QUADRANT_SUBDIV_MAX = 7

代表 PositionalShadowAtlasQuadrantSubdiv 枚举的大小。


enum Scaling3DMode:

Scaling3DMode SCALING_3D_MODE_BILINEAR = 0

对该视口的 3D 缓冲区使用双线性缩放。缩放的程度可以使用 scaling_3d_scale 设置。小于 1.0 的值会产生欠采样的效果,大于 1.0 会产生超采样的效果。值为 1.0 时禁用缩放。

Scaling3DMode SCALING_3D_MODE_FSR = 1

对该视口的 3D 缓冲区使用 AMD FidelityFX 超分辨率 1.0 升采样技术。缩放的程度可以使用 scaling_3d_scale 设置。小于 1.0 的值会使用 FSR 进行放大。不支持大于 1.0 的值,会改用双线性降采样。值为 1.0 时禁用缩放。

Scaling3DMode SCALING_3D_MODE_FSR2 = 2

对视口的 3D 缓冲区使用 AMD FidelityFX 超分辨率 2.2 放大。可以使用 scaling_3d_scale 设置缩放量。小于 1.0 的值将导致使用 FSR2 放大视口。不支持大于 1.0 的值,将改用双线性降采样。1.0 的值将使用原生分辨率下的 FSR2 作为 TAA 解决方案。

Scaling3DMode SCALING_3D_MODE_MAX = 3

代表 Scaling3DMode 枚举的大小。


enum MSAA:

MSAA MSAA_DISABLED = 0

禁用多重采样抗锯齿模式。这是默认值,也是最快的设置。

MSAA MSAA_2X = 1

使用 2 倍多重采样抗锯齿。性能成本中等。有助于显着减少锯齿,但 4× MSAA 看起来仍然要好得多。

MSAA MSAA_4X = 2

使用 4 倍多重采样抗锯齿。性能成本显著,通常是性能和质量之间的良好折衷。

MSAA MSAA_8X = 3

使用 8 倍多重采样抗锯齿。性能成本极高。在实际游戏条件下,4× 和 8× MSAA 之间的差异可能并不总是可见的。可能在低端和较旧的硬件上不受支持。

MSAA MSAA_MAX = 4

代表 MSAA 枚举的大小。


enum ScreenSpaceAA:

ScreenSpaceAA SCREEN_SPACE_AA_DISABLED = 0

不要在全屏后处理中执行抗锯齿。

ScreenSpaceAA SCREEN_SPACE_AA_FXAA = 1

使用快速近似抗锯齿(Fast Approximate Anti-Aliasing)。FXAA 是一种流行的屏幕空间抗锯齿方法,速度很快,但会让图像变模糊,使用较低分辨率时尤为显著。1440p 和 4K 等较高分辨率下效果仍然不错。

ScreenSpaceAA SCREEN_SPACE_AA_MAX = 2

代表 ScreenSpaceAA 枚举的大小。


enum RenderInfo:

RenderInfo RENDER_INFO_OBJECTS_IN_FRAME = 0

帧中对象的数量。

RenderInfo RENDER_INFO_PRIMITIVES_IN_FRAME = 1

帧中的顶点数量。

RenderInfo RENDER_INFO_DRAW_CALLS_IN_FRAME = 2

帧中的绘制调用量。

RenderInfo RENDER_INFO_MAX = 3

代表 RenderInfo 枚举的大小。


enum RenderInfoType:

RenderInfoType RENDER_INFO_TYPE_VISIBLE = 0

RenderInfoType RENDER_INFO_TYPE_SHADOW = 1

RenderInfoType RENDER_INFO_TYPE_MAX = 2


enum DebugDraw:

DebugDraw DEBUG_DRAW_DISABLED = 0

对象正常显示。

DebugDraw DEBUG_DRAW_UNSHADED = 1

显示的对象没有光照信息。

DebugDraw DEBUG_DRAW_LIGHTING = 2

DebugDraw DEBUG_DRAW_OVERDRAW = 3

对象通过加法混合显示为半透明,因此可以看到它们在彼此之上绘制的位置。更高的过度绘制意味着在绘制隐藏在其他像素后面的像素时浪费了性能。

DebugDraw DEBUG_DRAW_WIREFRAME = 4

对象以线框风格显示。

DebugDraw DEBUG_DRAW_NORMAL_BUFFER = 5

DebugDraw DEBUG_DRAW_VOXEL_GI_ALBEDO = 6

仅使用来自 VoxelGI 的反照率值显示对象。

DebugDraw DEBUG_DRAW_VOXEL_GI_LIGHTING = 7

仅使用来自 VoxelGI 的照明值显示对象。

DebugDraw DEBUG_DRAW_VOXEL_GI_EMISSION = 8

仅使用来自 VoxelGI 的自发光颜色显示对象。

DebugDraw DEBUG_DRAW_SHADOW_ATLAS = 9

Viewport 的左上象限中绘制存储来自 OmniLight3DSpotLight3D 的阴影的阴影图集。

DebugDraw DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS = 10

Viewport 的左上象限中绘制存储来自 DirectionalLight3D 的阴影的阴影图集。

DebugDraw DEBUG_DRAW_SCENE_LUMINANCE = 11

DebugDraw DEBUG_DRAW_SSAO = 12

绘制屏幕空间环境光遮蔽纹理而不是场景,以便可以清楚地看到它是如何影响对象的。为了使该显示模式起作用,必须在 WorldEnvironment 中设置 Environment.ssao_enabled

DebugDraw DEBUG_DRAW_SSIL = 13

绘制屏幕空间间接照明纹理而不是场景,以便可以清楚地看到它是如何影响对象的。为了使该显示模式起作用,必须在 WorldEnvironment 中设置 Environment.ssil_enabled

DebugDraw DEBUG_DRAW_PSSM_SPLITS = 14

为场景中的 DirectionalLight3D 的每个 PSSM 分割着色不同的颜色,以便可以看到分割的位置。按顺序,它们将被着色为红色、绿色、蓝色、和黄色。

DebugDraw DEBUG_DRAW_DECAL_ATLAS = 15

Viewport 的左上象限中绘制 Decal 使用的贴花和光投影仪的纹理。

DebugDraw DEBUG_DRAW_SDFGI = 16

DebugDraw DEBUG_DRAW_SDFGI_PROBES = 17

DebugDraw DEBUG_DRAW_GI_BUFFER = 18

DebugDraw DEBUG_DRAW_DISABLE_LOD = 19

DebugDraw DEBUG_DRAW_CLUSTER_OMNI_LIGHTS = 20

DebugDraw DEBUG_DRAW_CLUSTER_SPOT_LIGHTS = 21

DebugDraw DEBUG_DRAW_CLUSTER_DECALS = 22

DebugDraw DEBUG_DRAW_CLUSTER_REFLECTION_PROBES = 23

DebugDraw DEBUG_DRAW_OCCLUDERS = 24

DebugDraw DEBUG_DRAW_MOTION_VECTORS = 25

DebugDraw DEBUG_DRAW_INTERNAL_BUFFER = 26

在应用后处理之前绘制场景的内部分辨率缓冲区。


enum DefaultCanvasItemTextureFilter:

DefaultCanvasItemTextureFilter DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_NEAREST = 0

纹理过滤仅从最近的像素读取。这使得纹理从近距离看是像素化的,从远处看是颗粒状的(由于多级渐远纹理没有被采样)。

DefaultCanvasItemTextureFilter DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_LINEAR = 1

纹理过滤在最近的 4 个像素之间进行混合。这使得纹理从近处看起来很平滑,从远处看起来却有颗粒感(由于多级渐远纹理没有被采样)。

DefaultCanvasItemTextureFilter DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS = 2

纹理过滤在最近的 4 个像素和最近的 2 个多级渐远纹理之间进行混合(或者如果 ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filtertrue,则使用最近的多级渐远纹理)。这使得纹理从近处看起来平滑,从远处看起来也平滑。

将此用于可能以低缩放查看的非像素艺术纹理(例如,由于 Camera2D 缩放或精灵缩放),因为多级渐远纹理对于平滑小于屏幕像素的像素很重要。

DefaultCanvasItemTextureFilter DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS = 3

纹理过滤从最近的像素读取并在最近的 2 个多级渐远纹理之间进行混合(或者如果 ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filtertrue,则使用最近的多级渐远纹理)。这使得纹理从近处看起来像素化,从远处看起来平滑。

将此用于可能以低缩放查看的非像素艺术纹理(例如,由于 Camera2D 缩放或精灵缩放),因为多级渐远纹理对于平滑小于屏幕像素的像素很重要。

DefaultCanvasItemTextureFilter DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_MAX = 4

DefaultCanvasItemTextureFilter 枚举的最大值。


enum DefaultCanvasItemTextureRepeat:

DefaultCanvasItemTextureRepeat DEFAULT_CANVAS_ITEM_TEXTURE_REPEAT_DISABLED = 0

禁用纹理重复。相反,当读取 0-1 范围之外的 UV 时,该值将被钳制在纹理的边缘,从而导致纹理的边界看起来被拉长。

DefaultCanvasItemTextureRepeat DEFAULT_CANVAS_ITEM_TEXTURE_REPEAT_ENABLED = 1

当 UV 坐标超出 0-1 范围时,使纹理能够重复。如果使用其中一种线性过滤模式,则当采样器过滤纹理边缘时,这可能会导致纹理边缘出现伪影。

DefaultCanvasItemTextureRepeat DEFAULT_CANVAS_ITEM_TEXTURE_REPEAT_MIRROR = 2

重复时翻转该纹理,使边缘对齐而不是突然改变。

DefaultCanvasItemTextureRepeat DEFAULT_CANVAS_ITEM_TEXTURE_REPEAT_MAX = 3

DefaultCanvasItemTextureRepeat 枚举的最大值。


enum SDFOversize:

SDFOversize SDF_OVERSIZE_100_PERCENT = 0

SDFOversize SDF_OVERSIZE_120_PERCENT = 1

SDFOversize SDF_OVERSIZE_150_PERCENT = 2

SDFOversize SDF_OVERSIZE_200_PERCENT = 3

SDFOversize SDF_OVERSIZE_MAX = 4


enum SDFScale:

SDFScale SDF_SCALE_100_PERCENT = 0

SDFScale SDF_SCALE_50_PERCENT = 1

SDFScale SDF_SCALE_25_PERCENT = 2

SDFScale SDF_SCALE_MAX = 3


enum VRSMode:

VRSMode VRS_DISABLED = 0

VRS 已禁用。

VRSMode VRS_TEXTURE = 1

VRS 使用一个纹理。请注意,对于立体视觉,请为每个视图使用带有纹理的纹理图集。

VRSMode VRS_XR = 2

VRS 纹理由主 XRInterface 提供。

VRSMode VRS_MAX = 3

代表 VRSMode 枚举的大小。


属性说明

bool audio_listener_enable_2d = false

  • void set_as_audio_listener_2d ( bool value )

  • bool is_audio_listener_2d ( )

如果为 true,该视口将处理 2D 音频流。


bool audio_listener_enable_3d = false

  • void set_as_audio_listener_3d ( bool value )

  • bool is_audio_listener_3d ( )

如果为 true,该视口将处理 3D 音频流。


int canvas_cull_mask = 4294967295

  • void set_canvas_cull_mask ( int value )

  • int get_canvas_cull_mask ( )

渲染层,该 Viewport 会渲染位于这些层中的 CanvasItem 节点。


DefaultCanvasItemTextureFilter canvas_item_default_texture_filter = 1

设置该 Viewport 中 CanvasItem 所使用的默认过滤模式。选项见 DefaultCanvasItemTextureFilter


DefaultCanvasItemTextureRepeat canvas_item_default_texture_repeat = 0

设置该 Viewport 中 CanvasItem 所使用的默认重复模式。选项见 DefaultCanvasItemTextureRepeat


Transform2D canvas_transform

该视口的画布变换,对改变所有子 CanvasItem 的屏幕位置很有用。相对于该视口的全局画布变换。


DebugDraw debug_draw = 0

在调试时,用于测试渲染的几何图形的叠加模式。


bool disable_3d = false

  • void set_disable_3d ( bool value )

  • bool is_3d_disabled ( )

禁用 3D 渲染(但保留 2D 渲染)。


float fsr_sharpness = 0.2

  • void set_fsr_sharpness ( float value )

  • float get_fsr_sharpness ( )

确定使用 FSR 放大模式时,放大后的图像的锐度。每个整数的锐度减半。值从 0.0(最锐利)到 2.0。高于 2.0 的值不会产生明显的差异。

要在根视口上控制此属性,请设置 ProjectSettings.rendering/scaling_3d/fsr_sharpness 项目设置。


Transform2D global_canvas_transform

该视口的全局画布变换。画布变换是相对于这个的。


bool gui_disable_input = false

  • void set_disable_input ( bool value )

  • bool is_input_disabled ( )

如果为 true,该视口将不接收输入事件。


bool gui_embed_subwindows = false

  • void set_embedding_subwindows ( bool value )

  • bool is_embedding_subwindows ( )

如果为 true,子窗口(弹出窗口和对话框)将和控件等节点一样嵌入到应用程序窗口中。如果为 false,它们将显示为操作系统处理的独立窗口。


bool gui_snap_controls_to_pixels = true

  • void set_snap_controls_to_pixels ( bool value )

  • bool is_snap_controls_to_pixels_enabled ( )

如果为 true,该视口上的 GUI 控件将完美地放置像素。


bool handle_input_locally = true

  • void set_handle_input_locally ( bool value )

  • bool is_handling_input_locally ( )

如果为 true,则这个视口会把收到的输入事件标记为已被自身处理。如果为 false,则由第一个设置本地处理输入的父级视口进行这样的操作。

SubViewportContainer 会自动将其包含的 Viewport 的这个属性设置为 false

另见 set_input_as_handledis_input_handled


float mesh_lod_threshold = 1.0

  • void set_mesh_lod_threshold ( float value )

  • float get_mesh_lod_threshold ( )

用于在 Viewport 中渲染的网格的自动 LOD 偏置(类似于 ReflectionProbe.mesh_lod_threshold)。较高的值将使用生成了 LOD 变化的网格的较不详细版本。如果被设置为 0.0,则自动 LOD 将被禁用。增加 mesh_lod_threshold,以牺牲几何细节为代价提高性能。

要在根视口上控制该属性,请设置 ProjectSettings.rendering/mesh_lod/lod_change/threshold_pixels 项目设置。

注意:mesh_lod_threshold 不影响 GeometryInstance3D 可见性范围(也称为“手动”LOD 或分层 LOD)。


MSAA msaa_2d = 0

  • void set_msaa_2d ( MSAA value )

  • MSAA get_msaa_2d ( )

2D/画布渲染的多重采样抗锯齿模式。数字越高,得到的边缘越平滑,代价是性能也会显著降低。设为 2 或 4 为佳,除非目标是非常高端的系统。对由着色器或纹理导致的锯齿无效。


MSAA msaa_3d = 0

  • void set_msaa_3d ( MSAA value )

  • MSAA get_msaa_3d ( )

3D 渲染的多重采样抗锯齿模式。数字越高,得到的边缘越平滑,代价是性能也会显著降低。设为 2 或 4 为佳,除非目标是非常高端的系统。另请参阅 3D 的双线性缩放 scaling_3d_mode 实现超采样,能够提供更高的质量,但消耗也更高。对由着色器或纹理导致的锯齿无效。


bool own_world_3d = false

  • void set_use_own_world_3d ( bool value )

  • bool is_using_own_world_3d ( )

如果为 true,则该视口会使用 world_3d 中定义的 World3D 的唯一副本。


bool physics_object_picking = false

  • void set_physics_object_picking ( bool value )

  • bool get_physics_object_picking ( )

如果为 true,则视口中渲染的对象会成为鼠标拾取过程中的候选。

注意:同时能够被拾取的对象最多只有 64 个,选择的顺序是不确定的,每次拾取可能都不相同。


bool physics_object_picking_sort = false

  • void set_physics_object_picking_sort ( bool value )

  • bool get_physics_object_picking_sort ( )

如果为 true,则对象会按照固定的顺序接收鼠标拾取事件,首先会按各自的 CanvasItem.z_index 排序,然后按它们在场景树中的位置排序。如果为 false,则顺序不确定。

注意:默认情况下禁用此设置,因为它可能会产生昂贵的计算成本。

注意:排序发生在选择可拾取对象之后。因为同时能够被拾取的对象最多只有 64 个,所以无法保证 CanvasItem.z_index 最大的对象能够接收到拾取事件。


bool positional_shadow_atlas_16_bits = true

  • void set_positional_shadow_atlas_16_bits ( bool value )

  • bool get_positional_shadow_atlas_16_bits ( )

使用 16 位的全向灯/聚光灯阴影深度贴图。启用后,阴影的精度会降低,可能造成阴影失真,但能够在部分设备上提升性能。


PositionalShadowAtlasQuadrantSubdiv positional_shadow_atlas_quad_0 = 2

阴影图集上第一象限的细分量。


PositionalShadowAtlasQuadrantSubdiv positional_shadow_atlas_quad_1 = 2

阴影图集上第二象限的细分量。


PositionalShadowAtlasQuadrantSubdiv positional_shadow_atlas_quad_2 = 3