:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/platform/windows/doc_classes/EditorExportPlatformWindows.xml. .. _class_EditorExportPlatformWindows: EditorExportPlatformWindows =========================== **Inherits:** :ref:`EditorExportPlatformPC` **<** :ref:`EditorExportPlatform` **<** :ref:`RefCounted` **<** :ref:`Object` Exporter for Windows. .. rst-class:: classref-introduction-group Description ----------- The Windows exporter customizes how a Windows build is handled. In the editor's "Export" window, it is created when adding a new "Windows" preset. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`Exporting for Windows <../tutorials/export/exporting_for_windows>` .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`application/company_name` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`application/console_wrapper_icon` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`application/copyright` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`application/d3d12_agility_sdk_multiarch` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`application/export_angle` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`application/export_d3d12` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`application/file_description` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`application/file_version` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`application/icon` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`application/icon_interpolation` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`application/modify_resources` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`application/product_name` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`application/product_version` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`application/trademarks` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`binary_format/architecture` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`binary_format/embed_pck` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`codesign/custom_options` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`codesign/description` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`codesign/digest_algorithm` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`codesign/enable` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`codesign/identity` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`codesign/identity_type` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`codesign/password` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`codesign/timestamp` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`codesign/timestamp_server_url` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`custom_template/debug` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`custom_template/release` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`debug/export_console_wrapper` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`shader_baker/enabled` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`ssh_remote_deploy/cleanup_script` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`ssh_remote_deploy/enabled` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`ssh_remote_deploy/extra_args_scp` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`ssh_remote_deploy/extra_args_ssh` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`ssh_remote_deploy/host` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`ssh_remote_deploy/port` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`ssh_remote_deploy/run_script` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`texture_format/etc2_astc` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`texture_format/s3tc_bptc` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_EditorExportPlatformWindows_property_application/company_name: .. rst-class:: classref-property :ref:`String` **application/company_name** :ref:`🔗` Company that produced the application. Required. See `StringFileInfo `__. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_application/console_wrapper_icon: .. rst-class:: classref-property :ref:`String` **application/console_wrapper_icon** :ref:`🔗` Console wrapper icon file. If left empty, it will fallback to :ref:`application/icon`, then to :ref:`ProjectSettings.application/config/windows_native_icon`, and lastly, :ref:`ProjectSettings.application/config/icon`. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_application/copyright: .. rst-class:: classref-property :ref:`String` **application/copyright** :ref:`🔗` Copyright notice for the bundle visible to the user. Optional. See `StringFileInfo `__. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_application/d3d12_agility_sdk_multiarch: .. rst-class:: classref-property :ref:`bool` **application/d3d12_agility_sdk_multiarch** :ref:`🔗` If ``true``, and :ref:`application/export_d3d12` is set, the Agility SDK DLLs will be stored in arch-specific subdirectories. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_application/export_angle: .. rst-class:: classref-property :ref:`int` **application/export_angle** :ref:`🔗` If set to ``1``, ANGLE libraries are exported with the exported application. If set to ``0``, ANGLE libraries are exported only if :ref:`ProjectSettings.rendering/gl_compatibility/driver` is set to ``"opengl3_angle"``. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_application/export_d3d12: .. rst-class:: classref-property :ref:`int` **application/export_d3d12** :ref:`🔗` If set to ``1``, the Direct3D 12 runtime libraries (Agility SDK, PIX) are exported with the exported application. If set to ``0``, Direct3D 12 libraries are exported only if :ref:`ProjectSettings.rendering/rendering_device/driver` is set to ``"d3d12"``. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_application/file_description: .. rst-class:: classref-property :ref:`String` **application/file_description** :ref:`🔗` File description to be presented to users. Required. See `StringFileInfo `__. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_application/file_version: .. rst-class:: classref-property :ref:`String` **application/file_version** :ref:`🔗` Version number of the file. Falls back to :ref:`ProjectSettings.application/config/version` if left empty. See `StringFileInfo `__. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_application/icon: .. rst-class:: classref-property :ref:`String` **application/icon** :ref:`🔗` Application icon file. If left empty, it will fallback to :ref:`ProjectSettings.application/config/windows_native_icon`, and then to :ref:`ProjectSettings.application/config/icon`. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_application/icon_interpolation: .. rst-class:: classref-property :ref:`int` **application/icon_interpolation** :ref:`🔗` Interpolation method used to resize application icon. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_application/modify_resources: .. rst-class:: classref-property :ref:`bool` **application/modify_resources** :ref:`🔗` If enabled, icon and metadata of the exported executable is set according to the other ``application/*`` values. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_application/product_name: .. rst-class:: classref-property :ref:`String` **application/product_name** :ref:`🔗` Name of the application. Required. See `StringFileInfo `__. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_application/product_version: .. rst-class:: classref-property :ref:`String` **application/product_version** :ref:`🔗` Application version visible to the user. Falls back to :ref:`ProjectSettings.application/config/version` if left empty. See `StringFileInfo `__. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_application/trademarks: .. rst-class:: classref-property :ref:`String` **application/trademarks** :ref:`🔗` Trademarks and registered trademarks that apply to the file. Optional. See `StringFileInfo `__. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_binary_format/architecture: .. rst-class:: classref-property :ref:`String` **binary_format/architecture** :ref:`🔗` Application executable architecture. Supported architectures: ``x86_32``, ``x86_64``, and ``arm64``. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_binary_format/embed_pck: .. rst-class:: classref-property :ref:`bool` **binary_format/embed_pck** :ref:`🔗` If ``true``, project resources are embedded into the executable. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_codesign/custom_options: .. rst-class:: classref-property :ref:`PackedStringArray` **codesign/custom_options** :ref:`🔗` Array of the additional command line arguments passed to the code signing tool. See `Sign Tool `__. **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedStringArray` for more details. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_codesign/description: .. rst-class:: classref-property :ref:`String` **codesign/description** :ref:`🔗` Description of the signed content. See `Sign Tool `__. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_codesign/digest_algorithm: .. rst-class:: classref-property :ref:`int` **codesign/digest_algorithm** :ref:`🔗` Digest algorithm to use for creating signature. See `Sign Tool `__. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_codesign/enable: .. rst-class:: classref-property :ref:`bool` **codesign/enable** :ref:`🔗` If ``true``, executable signing is enabled. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_codesign/identity: .. rst-class:: classref-property :ref:`String` **codesign/identity** :ref:`🔗` PKCS #12 certificate file used to sign executable or certificate SHA-1 hash (if :ref:`codesign/identity_type` is set to "Use certificate store"). See `Sign Tool `__. Can be overridden with the environment variable ``GODOT_WINDOWS_CODESIGN_IDENTITY``. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_codesign/identity_type: .. rst-class:: classref-property :ref:`int` **codesign/identity_type** :ref:`🔗` Type of identity to use. See `Sign Tool `__. Can be overridden with the environment variable ``GODOT_WINDOWS_CODESIGN_IDENTITY_TYPE``. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_codesign/password: .. rst-class:: classref-property :ref:`String` **codesign/password** :ref:`🔗` Password for the certificate file used to sign executable. See `Sign Tool `__. Can be overridden with the environment variable ``GODOT_WINDOWS_CODESIGN_PASSWORD``. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_codesign/timestamp: .. rst-class:: classref-property :ref:`bool` **codesign/timestamp** :ref:`🔗` If ``true``, time-stamp is added to the signature. See `Sign Tool `__. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_codesign/timestamp_server_url: .. rst-class:: classref-property :ref:`String` **codesign/timestamp_server_url** :ref:`🔗` URL of the time stamp server. If left empty, the default server is used. See `Sign Tool `__. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_custom_template/debug: .. rst-class:: classref-property :ref:`String` **custom_template/debug** :ref:`🔗` Path to the custom export template. If left empty, default template is used. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_custom_template/release: .. rst-class:: classref-property :ref:`String` **custom_template/release** :ref:`🔗` Path to the custom export template. If left empty, default template is used. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_debug/export_console_wrapper: .. rst-class:: classref-property :ref:`int` **debug/export_console_wrapper** :ref:`🔗` If ``true``, a console wrapper executable is exported alongside the main executable, which allows running the project with enabled console output. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_shader_baker/enabled: .. rst-class:: classref-property :ref:`bool` **shader_baker/enabled** :ref:`🔗` If ``true``, shaders will be compiled and embedded in the application. This option is only supported when using the Forward+ and Mobile renderers. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_ssh_remote_deploy/cleanup_script: .. rst-class:: classref-property :ref:`String` **ssh_remote_deploy/cleanup_script** :ref:`🔗` Script code to execute on the remote host when app is finished. The following variables can be used in the script: - ``{temp_dir}`` - Path of temporary folder on the remote, used to upload app and scripts to. - ``{archive_name}`` - Name of the ZIP containing uploaded application. - ``{exe_name}`` - Name of application executable. - ``{cmd_args}`` - Array of the command line argument for the application. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_ssh_remote_deploy/enabled: .. rst-class:: classref-property :ref:`bool` **ssh_remote_deploy/enabled** :ref:`🔗` Enables remote deploy using SSH/SCP. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_ssh_remote_deploy/extra_args_scp: .. rst-class:: classref-property :ref:`String` **ssh_remote_deploy/extra_args_scp** :ref:`🔗` Array of the additional command line arguments passed to the SCP. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_ssh_remote_deploy/extra_args_ssh: .. rst-class:: classref-property :ref:`String` **ssh_remote_deploy/extra_args_ssh** :ref:`🔗` Array of the additional command line arguments passed to the SSH. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_ssh_remote_deploy/host: .. rst-class:: classref-property :ref:`String` **ssh_remote_deploy/host** :ref:`🔗` Remote host SSH user name and address, in ``user@address`` format. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_ssh_remote_deploy/port: .. rst-class:: classref-property :ref:`String` **ssh_remote_deploy/port** :ref:`🔗` Remote host SSH port number. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_ssh_remote_deploy/run_script: .. rst-class:: classref-property :ref:`String` **ssh_remote_deploy/run_script** :ref:`🔗` Script code to execute on the remote host when running the app. The following variables can be used in the script: - ``{temp_dir}`` - Path of temporary folder on the remote, used to upload app and scripts to. - ``{archive_name}`` - Name of the ZIP containing uploaded application. - ``{exe_name}`` - Name of application executable. - ``{cmd_args}`` - Array of the command line argument for the application. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_texture_format/etc2_astc: .. rst-class:: classref-property :ref:`bool` **texture_format/etc2_astc** :ref:`🔗` If ``true``, project textures are exported in the ETC2/ASTC format. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformWindows_property_texture_format/s3tc_bptc: .. rst-class:: classref-property :ref:`bool` **texture_format/s3tc_bptc** :ref:`🔗` If ``true``, project textures are exported in the S3TC/BPTC format. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`