Path: blob/master/platform/windows/doc_classes/EditorExportPlatformWindows.xml
20816 views
<?xml version="1.0" encoding="UTF-8" ?>1<class name="EditorExportPlatformWindows" inherits="EditorExportPlatformPC" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">2<brief_description>3Exporter for Windows.4</brief_description>5<description>6The Windows exporter customizes how a Windows build is handled. In the editor's "Export" window, it is created when adding a new "Windows" preset.7</description>8<tutorials>9<link title="Exporting for Windows">$DOCS_URL/tutorials/export/exporting_for_windows.html</link>10</tutorials>11<members>12<member name="application/company_name" type="String" setter="" getter="">13Company that produced the application. Required. See [url=https://learn.microsoft.com/en-us/windows/win32/menurc/stringfileinfo-block]StringFileInfo[/url].14</member>15<member name="application/console_wrapper_icon" type="String" setter="" getter="">16Console wrapper icon file. If left empty, it will fallback to [member application/icon], then to [member ProjectSettings.application/config/windows_native_icon], and lastly, [member ProjectSettings.application/config/icon].17</member>18<member name="application/copyright" type="String" setter="" getter="">19Copyright notice for the bundle visible to the user. Optional. See [url=https://learn.microsoft.com/en-us/windows/win32/menurc/stringfileinfo-block]StringFileInfo[/url].20</member>21<member name="application/d3d12_agility_sdk_multiarch" type="bool" setter="" getter="">22If [code]true[/code], and [member application/export_d3d12] is set, the Agility SDK DLLs will be stored in arch-specific subdirectories.23</member>24<member name="application/export_angle" type="int" setter="" getter="">25If set to [code]1[/code], ANGLE libraries are exported with the exported application. If set to [code]0[/code], ANGLE libraries are exported only if [member ProjectSettings.rendering/gl_compatibility/driver] is set to [code]"opengl3_angle"[/code].26</member>27<member name="application/export_d3d12" type="int" setter="" getter="">28If set to [code]1[/code], the Direct3D 12 runtime libraries (Agility SDK, PIX) are exported with the exported application. If set to [code]0[/code], Direct3D 12 libraries are exported only if [member ProjectSettings.rendering/rendering_device/driver] is set to [code]"d3d12"[/code].29</member>30<member name="application/file_description" type="String" setter="" getter="">31File description to be presented to users. Required. See [url=https://learn.microsoft.com/en-us/windows/win32/menurc/stringfileinfo-block]StringFileInfo[/url].32</member>33<member name="application/file_version" type="String" setter="" getter="">34Version number of the file. Falls back to [member ProjectSettings.application/config/version] if left empty. See [url=https://learn.microsoft.com/en-us/windows/win32/menurc/stringfileinfo-block]StringFileInfo[/url].35</member>36<member name="application/icon" type="String" setter="" getter="">37Application icon file. If left empty, it will fallback to [member ProjectSettings.application/config/windows_native_icon], and then to [member ProjectSettings.application/config/icon].38</member>39<member name="application/icon_interpolation" type="int" setter="" getter="">40Interpolation method used to resize application icon.41</member>42<member name="application/modify_resources" type="bool" setter="" getter="">43If enabled, icon and metadata of the exported executable is set according to the other [code]application/*[/code] values.44</member>45<member name="application/product_name" type="String" setter="" getter="">46Name of the application. Required. See [url=https://learn.microsoft.com/en-us/windows/win32/menurc/stringfileinfo-block]StringFileInfo[/url].47</member>48<member name="application/product_version" type="String" setter="" getter="">49Application version visible to the user. Falls back to [member ProjectSettings.application/config/version] if left empty. See [url=https://learn.microsoft.com/en-us/windows/win32/menurc/stringfileinfo-block]StringFileInfo[/url].50</member>51<member name="application/trademarks" type="String" setter="" getter="">52Trademarks and registered trademarks that apply to the file. Optional. See [url=https://learn.microsoft.com/en-us/windows/win32/menurc/stringfileinfo-block]StringFileInfo[/url].53</member>54<member name="binary_format/architecture" type="String" setter="" getter="">55Application executable architecture.56Supported architectures: [code]x86_32[/code], [code]x86_64[/code], and [code]arm64[/code].57</member>58<member name="binary_format/embed_pck" type="bool" setter="" getter="">59If [code]true[/code], project resources are embedded into the executable.60</member>61<member name="codesign/custom_options" type="PackedStringArray" setter="" getter="">62Array of the additional command line arguments passed to the code signing tool. See [url=https://learn.microsoft.com/en-us/dotnet/framework/tools/signtool-exe]Sign Tool[/url].63</member>64<member name="codesign/description" type="String" setter="" getter="">65Description of the signed content. See [url=https://learn.microsoft.com/en-us/dotnet/framework/tools/signtool-exe]Sign Tool[/url].66</member>67<member name="codesign/digest_algorithm" type="int" setter="" getter="">68Digest algorithm to use for creating signature. See [url=https://learn.microsoft.com/en-us/dotnet/framework/tools/signtool-exe]Sign Tool[/url].69</member>70<member name="codesign/enable" type="bool" setter="" getter="">71If [code]true[/code], executable signing is enabled.72</member>73<member name="codesign/identity" type="String" setter="" getter="">74PKCS #12 certificate file used to sign executable or certificate SHA-1 hash (if [member codesign/identity_type] is set to "Use certificate store"). See [url=https://learn.microsoft.com/en-us/dotnet/framework/tools/signtool-exe]Sign Tool[/url].75Can be overridden with the environment variable [code]GODOT_WINDOWS_CODESIGN_IDENTITY[/code].76</member>77<member name="codesign/identity_type" type="int" setter="" getter="">78Type of identity to use. See [url=https://learn.microsoft.com/en-us/dotnet/framework/tools/signtool-exe]Sign Tool[/url].79Can be overridden with the environment variable [code]GODOT_WINDOWS_CODESIGN_IDENTITY_TYPE[/code].80</member>81<member name="codesign/password" type="String" setter="" getter="">82Password for the certificate file used to sign executable. See [url=https://learn.microsoft.com/en-us/dotnet/framework/tools/signtool-exe]Sign Tool[/url].83Can be overridden with the environment variable [code]GODOT_WINDOWS_CODESIGN_PASSWORD[/code].84</member>85<member name="codesign/timestamp" type="bool" setter="" getter="">86If [code]true[/code], time-stamp is added to the signature. See [url=https://learn.microsoft.com/en-us/dotnet/framework/tools/signtool-exe]Sign Tool[/url].87</member>88<member name="codesign/timestamp_server_url" type="String" setter="" getter="">89URL of the time stamp server. If left empty, the default server is used. See [url=https://learn.microsoft.com/en-us/dotnet/framework/tools/signtool-exe]Sign Tool[/url].90</member>91<member name="custom_template/debug" type="String" setter="" getter="">92Path to the custom export template. If left empty, default template is used.93</member>94<member name="custom_template/release" type="String" setter="" getter="">95Path to the custom export template. If left empty, default template is used.96</member>97<member name="debug/export_console_wrapper" type="int" setter="" getter="">98If [code]true[/code], a console wrapper executable is exported alongside the main executable, which allows running the project with enabled console output.99</member>100<member name="shader_baker/enabled" type="bool" setter="" getter="">101If [code]true[/code], shaders will be compiled and embedded in the application. This option is only supported when using the Forward+ and Mobile renderers.102[b]Note:[/b] When exporting as a dedicated server, the shader baker is always disabled since no rendering is performed.103</member>104<member name="ssh_remote_deploy/cleanup_script" type="String" setter="" getter="">105Script code to execute on the remote host when app is finished.106The following variables can be used in the script:107- [code]{temp_dir}[/code] - Path of temporary folder on the remote, used to upload app and scripts to.108- [code]{archive_name}[/code] - Name of the ZIP containing uploaded application.109- [code]{exe_name}[/code] - Name of application executable.110- [code]{cmd_args}[/code] - Array of the command line argument for the application.111</member>112<member name="ssh_remote_deploy/enabled" type="bool" setter="" getter="">113Enables remote deploy using SSH/SCP.114</member>115<member name="ssh_remote_deploy/extra_args_scp" type="String" setter="" getter="">116Array of the additional command line arguments passed to the SCP.117</member>118<member name="ssh_remote_deploy/extra_args_ssh" type="String" setter="" getter="">119Array of the additional command line arguments passed to the SSH.120</member>121<member name="ssh_remote_deploy/host" type="String" setter="" getter="">122Remote host SSH user name and address, in [code]user@address[/code] format.123</member>124<member name="ssh_remote_deploy/port" type="String" setter="" getter="">125Remote host SSH port number.126</member>127<member name="ssh_remote_deploy/run_script" type="String" setter="" getter="">128Script code to execute on the remote host when running the app.129The following variables can be used in the script:130- [code]{temp_dir}[/code] - Path of temporary folder on the remote, used to upload app and scripts to.131- [code]{archive_name}[/code] - Name of the ZIP containing uploaded application.132- [code]{exe_name}[/code] - Name of application executable.133- [code]{cmd_args}[/code] - Array of the command line argument for the application.134</member>135<member name="texture_format/etc2_astc" type="bool" setter="" getter="">136If [code]true[/code], project textures are exported in the ETC2/ASTC format.137</member>138<member name="texture_format/s3tc_bptc" type="bool" setter="" getter="">139If [code]true[/code], project textures are exported in the S3TC/BPTC format.140</member>141</members>142</class>143144145