nDisplay配置文件参考

从虚幻引擎4.27开始，你可以继续将.cfg和.ndisplay配置文件导入到项目的 内容浏览器 中，它们将转换成新的.uasset格式。

你可以导出 .ndisplay 配置文件并使用它启动群集。.ndisplay 文件不会具有跟踪功能以及其它只能在 nDisplay配置资产 中配置的功能。

我们建议使用nDisplay 3D配置编辑器来配置你的nDisplay群集。

你可以在单个配置文件中定义nDisplay系统的大部分方面。该文件的内容包含组成网络的所有计算机、想要虚幻引擎在每台计算机上渲染的窗口和视口的特性、每个视口应渲染的虚拟世界的各个部分、希望接受的输入设备类型等等信息。

本页面介绍nDisplay配置文件中所有可用的设置项。

想要初步了解并创建自己的nDisplay配置文件，最佳方法是查看nDisplay插件所提供的示例配置文件。如果你已使用nDisplay模板创建了自己的项目，可以在项目文件夹的 Content/ExampleConfigs 目录中找到这些文件。如果尚未创建项目，可以在虚幻引擎安装文件夹的 Templates/TP_nDisplayBP/Content/ExampleConfigs 目录中找到这些文件。

nDisplay配置文件的结构直接关联到用于渲染可视化内容的不同组件类型。

• 你配置的每种不同组件类型在该配置文件中都有对应的行，并由你指定的字符串ID识别。当某个配置分段需要引用另一个配置分段时，可以使用这些字符串ID。

• 你在此文件中配置的许多组件在虚拟3D空间中都有既定位置（很多时候还包括旋转）。每个对象的位置和旋转都相对于该对象的 父项。默认情况下，所有对象的父项都是虚拟空间原点：3D世界空间中被视为虚拟空间起点的任意点。还可以在3D空间中配置特定的命名转换，称为scene_nodes（场景节点），它可以作为一个或多个组件的父项。这种方法有助于简化屏幕、摄像机和其他组件的空间布局。 要了解如何使用scene_nodes构建3D转换的层级（这些转换都始于虚拟空间中的同一个点），请参阅下文配置文件场景结构示例一节。

• 除非另有说明，所有引用虚拟3D空间或真实物理空间中测量值的参数，所使用的单位都应为“米”和“度”。包括屏幕、场景节点、摄像机等。

• 所有引用屏幕空间中测量值的参数都应使用“像素”为单位。包括窗口和视口。

群集节点配置

对于将在nDisplay网络中使用的虚幻引擎应用的各个不同实例，都需要定义一个 cluster_node （群集节点）配置。每个cluster_node配置都必须包含一个对 窗口 配置段的引用，窗口配置段定义了主应用程序窗口的属性。

Cluster_node 配置还定义了将运行该应用程序实例的计算机的主机名和IP地址。你可以为每个cluster_node配置设置不同的物理计算机，也可以在同一台主机上运行多个cluster_node配置。

示例配置：

此示例配置一个主节点（每个网络配置一个）：

	[cluster_node] id=node_front addr=192.168.0.1 window=wnd_LT sound=true port_cs=41001 port_ss=41002 master=true
Copy full snippet

[cluster_node] id=node_front addr=192.168.0.1 window=wnd_LT sound=true port_cs=41001 port_ss=41002 master=true

此示例配置一个非主群集节点：

	[cluster_node] id=node_left addr=192.168.0.2 window=wnd_large sound=false
Copy full snippet

[cluster_node] id=node_left addr=192.168.0.2 window=wnd_large sound=false

参数：

窗口配置

每个 窗口（window） 配置为一个虚幻引擎应用程序实例的主窗口定义了一组属性值。当nDisplay启动应用程序时，可以使用这些值来设置窗口的初始大小和位置，以及该窗口是否应该全屏显示等。

还可使用一个或多个 视口 配置，用于指定主应用程序窗口中的特定区域（nDisplay将在其中显示场景的渲染画面）。

示例配置：

此示例配置包含单个视口的应用程序窗口：

	[window] id=wnd_one fullscreen=false WinX=0 WinY=0 ResX=640 ResY=480 viewports=vp_LT
Copy full snippet

[window] id=wnd_one fullscreen=false WinX=0 WinY=0 ResX=640 ResY=480 viewports=vp_LT

此示例配置包含四个分离视口的应用程序窗口：

	[window] id=wnd_four fullscreen=false WinX=0 WinY=0 ResX=640 ResY=480 viewports="vp_LT,vp_RB,vp_LB,vp_RT"
Copy full snippet

[window] id=wnd_four fullscreen=false WinX=0 WinY=0 ResX=640 ResY=480 viewports="vp_LT,vp_RB,vp_LB,vp_RT"

参数：

视口配置

上述各个 窗口（window） 配置都引用了一个或多个 视口（viewport） 配置，每个视口配置都会定义游戏窗口的一个矩形区域，nDisplay会在其中填充已渲染的视图场景。

视口通常从应用程序窗口的左上角开始，设定其宽度和高度以便填充父窗口。但是在某些情况下，你可能需要在视口的父应用程序窗口内对视口进行偏移。例如，如果需要设置两个部分重叠的投影仪，或者需要一个应用程序窗口在不同位置容纳多个分离的视口，则可能想要进行此类偏移。

nDisplay支持 多GPU (mGPU) 视口渲染，因此你可以指定一个GPU设备渲染特定视口，并将帧复制到另一个GPU进行显示。例如，在虚拟制片和摄像机内的VFX场景中，可以在第二个GPU上整体渲染内部视锥，从而改善性能和硬件使用率。在带有NVLink的NVIDIA GPU上，可以绕过CPU并将内存内容直接从GPU传输到GPU。若无NVLink，虽然内存传输仍将是点对点（P2P）方式，但可能会变慢，因为必须在PCIe上通过CPU进行操作。

当你通过nDisplay启动器或交换台启动nDisplay以使用mGPU特性时，将MaxGPUCount=2添加到自定义命令行参数。

示例配置：

	[viewport] id=vp_LT X=0 Y=0 width=300 height=220 projection=proj_simple_LT
Copy full snippet

[viewport] id=vp_LT X=0 Y=0 width=300 height=220 projection=proj_simple_LT

参数：

计算机上第一个安装并启用的GPU通常被编号为 0，其他GPU的编号依次递增为 1、2...、n。可以在电脑设置中找到你的操作系统提供的GPU设备编号。例如，在Windows上，可以在 任务管理器 中找到你的GPU设备编号：

1. 打开 任务管理器（Task Manager）。
2. 切换到 性能（Performance） 选项卡。
3. 窗口左侧显示机器中现有的所有GPU及其设备编号。

在只有一个GPU的计算机上，该GPU在任务管理器中显示为 GPU 0。

投影配置

上述所有 视口 配置中都会引用 投影 配置，投影配置负责定义需要在视口中绘制的渲染图像。

通常使用 simple（简单） 投影类型，利用此nDisplay配置文件中其他地方的 屏幕 配置部分所定义的视锥，从当前摄像机位置渲染虚拟世界。

其他投影类型，如 mpcdi、easyblend、vioso 和 domeprojection，使用其他方法定义视口的渲染内容，并可以在把图像渲染到矩形视口之前，引入其他校正或应用其他渲染技术。比如，投影有可能通过挤压、拉伸或扭曲图像等方式，使其以更自然的方式显示在某个曲面上。

示例配置：

下例为最简单用例，它将屏幕配置定义的视锥 scr_LT 直接路由到视口，而不扭曲或修改渲染图像。

	[projection] id=proj_simple_LT type=simple screen=scr_LT
Copy full snippet

[projection] id=proj_simple_LT type=simple screen=scr_LT

下例展示如何使用 easyblend 投影类型渲染至可扩展显示配置文件中定义的表面。

	[projection] id=proj_easyblend_1 type="easyblend" file="D:\eb_data\ScalableData.pol_1" origin=easyblend_origin_1 scale=0.1
Copy full snippet

[projection] id=proj_easyblend_1 type="easyblend" file="D:\eb_data\ScalableData.pol_1" origin=easyblend_origin_1 scale=0.1

下例展示如何使用 mpcdi 投影类型渲染至MPCDI配置文件中定义的表面。

	[projection] id=proj_mpcdi_LT type="mpcdi" file="D:\rot90_flat.mpcdi" buffer="Mosaic" region="Monitor_R" origin=mpcdi_origin
Copy full snippet

[projection] id=proj_mpcdi_LT type="mpcdi" file="D:\rot90_flat.mpcdi" buffer="Mosaic" region="Monitor_R" origin=mpcdi_origin

下例展示如何通过指定 .png 文件所定义的alpha混合贴图，使用 mpcdi 投影类型渲染至指定 .pfm 几何体文件定义的曲面。

	[projection] id=proj_mpcdi_LT type="mpcdi" pfm="D:\geom_displayLeft1.pfm" alpha="D:\Left1blend.png" alpha_gamma=2 origin=mpcdi_origin
Copy full snippet

[projection] id=proj_mpcdi_LT type="mpcdi" pfm="D:\geom_displayLeft1.pfm" alpha="D:\Left1blend.png" alpha_gamma=2 origin=mpcdi_origin

下例展示如何使用 vioso 投影类型渲染至使用原生VIOSO文件所定义的表面。

	[projection] id=proj_vioso_1 type="vioso" file="D:\left.vwf" origin=vioso_origin base="[1000 0 0 0] [0 1000 0 0] [0 0 1000 0] [0 0 1000 1]"
Copy full snippet

[projection] id=proj_vioso_1 type="vioso" file="D:\left.vwf" origin=vioso_origin base="[1000 0 0 0] [0 1000 0 0] [0 0 1000 0] [0 0 1000 1]"

下例展示如何使用 domeprojection 类型渲染至 .xml 校准文件中的DomeProjection所定义的表面。

	[projection] id=proj_domeprojection_1 type=domeprojection file="D:\config.xml" origin=domeprojection_origin channel=0
Copy full snippet

[projection] id=proj_domeprojection_1 type=domeprojection file="D:\config.xml" origin=domeprojection_origin channel=0

参数：

type=simple 还接受以下额外参数的投影：

type=easyblend 的投影还接受以下额外参数：

Type=mpcdi 或 type=picp_mpcdi 的投影还接受以下额外参数：

nDisplay当前仅支持MPCDI 1.0 版，以及 2D 和 A3D（或 高级3D）配置文件类型。

type=vioso 的投影还接受以下额外参数：

type=domeprojection 的投影还接受以下额外参数：

type=manual 时的投影还接受以下参数，用以定义nDisplay的视图旋转和应渲染视锥。可使用矩阵或角度来配置视锥。

type=camera 的投影不接受任何其他附加参数。你可以使用蓝图或C++ API在运行时为投影策略设置摄像机。

type=mesh 和 type=picp_mesh 的投影不接受任何其他附加参数。你可以使用蓝图或C++ API在运行时为投影策略设置静态网格体组件。

屏幕配置

每个使用 simple 投影类型的不同输出显示都使用一个在3D虚拟空间中有既定大小和位置的矩形所定义的锥体从当前摄像机位置渲染场景。这些矩型都由 屏幕（screen） 配置定义。通常，这些投影屏幕在虚拟空间中的尺寸通常与你将用于显示渲染结果的物理屏幕相同。

屏幕的枢轴点始终在其中心点。

示例配置：

此定义描述了一个3米乘3米的屏幕，直接在其父项之前。因为屏幕的枢轴点位于由大小参数定义的矩形的中心点，所以我们在Z轴上添加了1.5米的偏移量，以便将屏幕向上移动一半高度。

	[screen] id=screen_front loc="X=1.5.Y=0,Z=1.5" rot="P=0,Y=0,R=0" size="X=3,Y=3" parent=screens
Copy full snippet

[screen] id=screen_front loc="X=1.5.Y=0,Z=1.5" rot="P=0,Y=0,R=0" size="X=3,Y=3" parent=screens

要在查看器的左侧定义一个屏幕，我们将其向左侧移动（Y轴上的负值），并使其围绕其局部Y轴旋转（yaw）。 

	[screen] id=screen_left loc="X=0,y=-1.5,Z=1.5" rot="P=0,Y=-90,R=0" size="X=3,Y=3" parent=screens
Copy full snippet

[screen] id=screen_left loc="X=0,y=-1.5,Z=1.5" rot="P=0,Y=-90,R=0" size="X=3,Y=3" parent=screens

参数：

后期处理配置

后期处理 配置定义虚幻引擎实例为 窗口 生成的图像在渲染前如何进行后期处理。nDisplay目前支持两种后期处理操作：OutputRemap 和 TextureShare.

通过 OutputRemap，你可以控制nDisplay生成的2D图像映射到应用程序窗口2D区域的方式。例如，你可以对部分输出图像进行平移、旋转和缩放，使它们出现在应用程序窗口的不同区域。为此，你需要提供一个.obj文件。该文件需要包含一个设置了UV映射的平面几何体。nDisplay将使用为平面设置的UV映射来确定如何将输出图像映射到应用程序窗口的每个部分。

通过 TextureShare，你可以从另一个应用程序接收纹理，并在指定的视口中显示它。为此，你需要定义一个后处理，其中要用到Texture Share项的名称以及将显示纹理的视口。

示例配置：

下面的示例展示了如何在两个.obj文件中使用OutputRemap后处理类型：

	[window] id=somewindow ... postprocess="pp_1, pp_2"
	[postprocess] id=pp_1 type="OutputRemap" file="remap_1.obj"
	[postprocess] id=pp_2 type="OutputRemap" file="remap_2.obj"
Copy full snippet

[window] id=somewindow ... postprocess="pp_1, pp_2" [postprocess] id=pp_1 type="OutputRemap" file="remap_1.obj" [postprocess] id=pp_2 type="OutputRemap" file="remap_2.obj"

The following example shows how to use TextureShare to share the rendered frame for the vp_1 viewport to an external application, receive a texture from a third party source, and display it in the vp_ext viewport.

	[window] id=somewindow viewports="vp_1" fullscreen="false" … postprocess="pp_sharenode_ext"
	[viewport] id=vp_1 ... projection="proj_screen_1" share=true
	[viewport] id=vp_ext ... projection=""
		[postprocess] id=pp_sharednode_ext type="TextureShare" destination="vp_ext" source="thirdpartyapp_viewport_rendering"
Copy full snippet

[window] id=somewindow viewports="vp_1" fullscreen="false" … postprocess="pp_sharenode_ext" [viewport] id=vp_1 ... projection="proj_screen_1" share=true [viewport] id=vp_ext ... projection="" [postprocess] id=pp_sharednode_ext type="TextureShare" destination="vp_ext" source="thirdpartyapp_viewport_rendering"

参数：

摄像机配置

nDisplay群集中的所有实例从虚拟世界中的相同位置渲染场景。这些可能的视点都由 摄像机（camera） 配置行定义。

你可以在运行时在这些视点之间切换。每个摄像机视点也可以由追踪设备驱动。

示例配置：

	[camera] id=camera_static loc="X=0.Y=0,Z=1.7" tracker_id=VRPNTracking tracker_ch=0
Copy full snippet

[camera] id=camera_static loc="X=0.Y=0,Z=1.7" tracker_id=VRPNTracking tracker_ch=0

参数：

场景节点配置

可以在你的配置文件中定义场景节点的层级，每个节点都代表着3D空间中的一个变换。配置文件中设置的任何在3D空间中有位置和旋转属性的对象，例如摄像机或投影屏幕，都可以将这些 scene_node 配置之一作为其父项。此配置可以帮助定义可视化系统的所有不同组件之间的空间关系。

类似于摄像机，场景节点也可以由虚拟追踪设备驱动。

示例配置：

以下数行定义了两个节点的层级，其中子节点位于其父节点之前，有2米的偏移量。

	[scene_node] id=vr_space_root loc="X=0.Y=0,Z=0" rot="P=0,Y=0,R=0"
	[scene_node] id=walls_front_group loc="X=2.Y=0,Z=0" rot="P=0,Y=0,R=0" parent= vr_space_root
Copy full snippet

[scene_node] id=vr_space_root loc="X=0.Y=0,Z=0" rot="P=0,Y=0,R=0" [scene_node] id=walls_front_group loc="X=2.Y=0,Z=0" rot="P=0,Y=0,R=0" parent= vr_space_root

以下数行展示了一个配置为由虚拟追踪设备驱动的场景节点：

	[scene_node] id=cave_wand loc="X=0, Y=0,Z=1" tracker_id=CaveTracking tracker_ch=1
Copy full snippet

[scene_node] id=cave_wand loc="X=0, Y=0,Z=1" tracker_id=CaveTracking tracker_ch=1

参数：

输入配置

可以为每个需要向nDisplay系统提供输入的设备定义一个 输入（input） 段。例如，可以选择让每个 摄像机 和每个 scene_node 都由一个在 输入（input） 段中设置的虚拟追踪设备驱动，并在 摄像机（camera） 或 scene_node 的配置中引用此设备。或者，你可能想要设置追踪器、控制器和键盘来发送通用输入事件到虚幻引擎输入系统，或将其事件和输入值绑定到通用nDisplay蓝图节点，以便在项目的游戏脚本中进行响应。

你还可以使用 input_setup 部分来控制来自这些输入设备的特定通道、按钮或键以何种方式绑定到虚幻引擎中的特定类型的输入事件和值上。

有关nDisplay输入的用法概述，请参阅使用VRPN输入。

示例配置：

此配置将nDisplay设置为从VRPN位置追踪设备获取输入。这种设备通常安装在摄像机或观察者的头部，或由观察者手持。你可以通过在 摄像机 或 scene_node 配置中引用此 输入 配置，从而让追踪器自动驱动摄像机或场景节点的位置。或者可以在项目的蓝图代码中获取此追踪器的值。

	[input] id=CaveTracking type=tracker [email protected] loc="X=-1.5,Y=0,Z=3.4" rot="P-0,Y=0,R=0" front=X right=Y up=-Z
Copy full snippet

[input] id=CaveTracking type=tracker addr=Tracker0@192.168.0.1 loc="X=-1.5,Y=0,Z=3.4" rot="P-0,Y=0,R=0" front=X right=Y up=-Z

此配置将nDisplay设置为从被设为VRPN设备的键盘设备读取键盘输入，并发送至内置的虚幻引擎键盘输入。

	[input] id=ControlKeyboard type=keyboard [email protected] reflect=ue4
Copy full snippet

[input] id=ControlKeyboard type=keyboard addr=Keyboard0@192.168.0.1 reflect=ue4

参数：

type=tracker 的设备还接受以下额外参数：

type=keyboard 的设备还接受以下额外参数：

type=analog 和 type=button 的设备不接受任何其他附加参数。

输入设置配置

每个 input_setup 配置部分为指定的 输入 设备提供额外的配置参数，通常用于将该设备的通道或键绑定到一个通用的nDisplay蓝图输入节点。

示例配置：

此配置设置带ID控制器的输入设备，这样，在按下用于在通道0上生成事件的按钮时，在蓝图中将会从 输入（Input）> N显示事件（N Display Events）> nDisplay按钮0（nDisplay Button 0） 节点生成一个事件。

	[input_setup] id=controller ch=0 bind="nDisplay Button 0"
Copy full snippet

[input_setup] id=controller ch=0 bind="nDisplay Button 0"

此配置与上述配置类似，不同之处是它将一个模拟输入值（通常是控制器的轴）绑定到一个nDisplay模拟值。你可以在蓝图中使用 输入（Input）> N显示事件（N Display Events）> nDisplay模拟0（nDisplay Analog 0） 节点检测该控制器轴何时被使用，或使用 输入（Input）> N显示值（N Display Values）> nDisplay模拟0（nDisplay Analog 0） 来获取当前帧的输入值。

	[input_setup] id=test_axes ch=0 bind="nDisplay Analog 0"
Copy full snippet

[input_setup] id=test_axes ch=0 bind="nDisplay Analog 0"

如果使用键盘设备，你不必专门绑定键盘的每个键。只需使用 输入（input） 部分中的 反映（reflect） 设置来确定按键事件应该路由到内置虚幻引擎键盘事件，还是路由到nDisplay键盘事件。但如果想要更改绑定或添加新绑定，则可以进行专门绑定。例如，下面配置段使空格键触发 输入（Input）> N显示事件（N Display Events）> nDisplay按钮3（nDisplay Button 3） 事件。

	[input_setup] id=keyboard0 key=Space bind="nDisplay Button 3"
Copy full snippet

[input_setup] id=keyboard0 key=Space bind="nDisplay Button 3"

参数：

你还可以使用输入模块API中的节点，在项目的蓝图代码中设置这些通道和按键绑定。详情请参阅将设备通道绑定到UE4输入。

一般配置

一般（general） 配置行包含控制nDisplay群集整体操作的参数。

示例配置：

	[general] swap_sync_policy=1
Copy full snippet

[general] swap_sync_policy=1

参数：

NVIDIA配置

如果在 一般 配置部分中将 swap_sync_policy 的值设为 2，可以使用 NVIDIA 部分中的参数调整一些与帧锁定相关的特定硬件设置。

网络配置

网络（network） 配置分段提供了一些设置，用于控制超时以及与nDisplay群集节点之间的网络通信相关的其他设置。

nDisplay配置文件中只能有零个或一个 网络（network） 分段。

示例配置：

	[network] cln_conn_tries_amount=10 cln_conn_retry_delay=1000 game_start_timeout=30000 barrier_wait_timeout=5000
Copy full snippet

[network] cln_conn_tries_amount=10 cln_conn_retry_delay=1000 game_start_timeout=30000 barrier_wait_timeout=5000

参数：

cln_conn_tries_amount 和 cln_conn_retry_delay 设置共同用于确定群集节点在启动时尝试连接到主节点的最大时长。例如，假设将 cln_conn_tries_amount 设置为10，cln_conn_retry_delay 设置为1000毫秒。启动时，每个节点都将尝试连接到主节点PC。如果连接失败，则等待1000毫秒并重试。如果重新尝试也失败了，再等1000毫秒。连续十次失败后，该群集节点自动退出。一旦集群节点连接到主节点PC，计数就会停止。

信息配置

信息（info） 配置行包含此配置文件的可选信息：具体是指已知与此配置文件兼容的nDisplay和虚幻引擎的最新版本。

示例配置：

	[info] version=22
Copy full snippet

[info] version=22

参数：

自定义配置参数

你可以包含一个 自定义（custom） 配置分段来为你的nDisplay群集节点提供自己的自定义键值对。可以在 [群集] 行中包括所需的任意数量的参数和值。然后在运行时，可以从nDisplay蓝图或C++ API中获取这些配置值。

示例配置：

	[custom] stringParameter=myValue numberParameter=2
Copy full snippet

[custom] stringParameter=myValue numberParameter=2

配置文件场景结构示例

举一个具体的例子，打开 wall_flat_3x2.cfg 示例文件，该文件位于虚幻引擎安装文件夹中的 Templates/TP_nDisplayBP/Content/ExampleConfigs 目录下。该文件定义了六个投影屏幕，每个屏幕都将由独立的物理计算机渲染。

该文件还定义了几个scene_node，这些节点共同构建了以下层级：

节点在此层级中的相对位置和旋转决定了摄像机和六个屏幕在虚拟空间中的布局，本示例中，这六个投影屏幕并排排列，距离摄像机1米远。 

请注意，该配置意味着每一对相邻的投影屏幕之间留有较小空间，以便将显示渲染场景的显示器边框考虑在内。