Repository: elvissteinjr/DesktopPlus Branch: master Commit: 78a63d79b184 Files: 211 Total size: 7.6 MB Directory structure: gitextract_9ffo_z3l/ ├── .github/ │ ├── FUNDING.yml │ └── workflows/ │ └── nightly.yml ├── CONTRIBUTING ├── LICENSE ├── README.md ├── assets/ │ ├── action_manifest.json │ ├── actions_default.ini │ ├── config_default.ini │ ├── input/ │ │ ├── action_bindings_frame_controller.json │ │ ├── action_bindings_gamepad.json │ │ ├── action_bindings_generic.json │ │ ├── action_bindings_holographic.json │ │ ├── action_bindings_hpmotioncontroller.json │ │ ├── action_bindings_knuckles.json │ │ ├── action_bindings_knuckles_ev1.json │ │ ├── action_bindings_playstation_vr2_sense_controller.json │ │ ├── action_bindings_svl_hand_interaction_augmented.json │ │ ├── action_bindings_touch.json │ │ ├── action_bindings_vive_controller.json │ │ ├── action_bindings_vive_cosmos.json │ │ ├── action_manifest_de.json │ │ ├── action_manifest_en.json │ │ ├── action_manifest_ja.json │ │ ├── action_manifest_ko.json │ │ └── action_manifest_zh_CN.json │ ├── keyboards/ │ │ ├── azerty_be.ini │ │ ├── azerty_fr.ini │ │ ├── qwerty_dk.ini │ │ ├── qwerty_es.ini │ │ ├── qwerty_ja.ini │ │ ├── qwerty_ko_2-set.ini │ │ ├── qwerty_latam.ini │ │ ├── qwerty_th_kedmanee.ini │ │ ├── qwerty_uk.ini │ │ ├── qwerty_usa.ini │ │ ├── qwertz_ger.ini │ │ └── qwertz_hu.ini │ ├── lang/ │ │ ├── de.ini │ │ ├── en.ini │ │ ├── ja.ini │ │ ├── ko.ini │ │ └── zh_CN.ini │ ├── license.txt │ ├── manifest.vrmanifest │ ├── misc/ │ │ ├── !About this folder.txt │ │ ├── CreateElevatedTask.bat │ │ ├── CreateElevatedTask.ps1 │ │ ├── EnableUIAccess.bat │ │ ├── EnableUIAccess.ps1 │ │ ├── EnableUIAccessDesktopPlus.manifest │ │ ├── UndoSystemChanges.bat │ │ └── UndoSystemChanges.ps1 │ ├── profiles/ │ │ └── Sample Profile.ini │ ├── readme.txt │ └── third-party_licenses.txt ├── docs/ │ └── user_guide.md └── src/ ├── DesktopPlus/ │ ├── BackgroundOverlay.cpp │ ├── BackgroundOverlay.h │ ├── CommonTypes.h │ ├── DesktopPlus.cpp │ ├── DesktopPlus.manifest │ ├── DesktopPlus.rc │ ├── DesktopPlus.ruleset │ ├── DesktopPlus.vcxproj │ ├── DesktopPlus.vcxproj.filters │ ├── DesktopPlus.vcxproj.user │ ├── DisplayManager.cpp │ ├── DisplayManager.h │ ├── DuplicationManager.cpp │ ├── DuplicationManager.h │ ├── ElevatedMode.cpp │ ├── ElevatedMode.h │ ├── InputSimulator.cpp │ ├── InputSimulator.h │ ├── LaserPointer.cpp │ ├── LaserPointer.h │ ├── OutputManager.cpp │ ├── OutputManager.h │ ├── Overlays.cpp │ ├── Overlays.h │ ├── PixelShader.hlsl │ ├── PixelShaderCursor.hlsl │ ├── RadialFollowSmoothing.cpp │ ├── RadialFollowSmoothing.h │ ├── SoftwareCursorGrabber.cpp │ ├── SoftwareCursorGrabber.h │ ├── ThreadManager.cpp │ ├── ThreadManager.h │ ├── VRInput.cpp │ ├── VRInput.h │ ├── VertexShader.hlsl │ └── resource.h ├── DesktopPlus.sln ├── DesktopPlusUI/ │ ├── AuxUI.cpp │ ├── AuxUI.h │ ├── DesktopPlusUI.cpp │ ├── DesktopPlusUI.rc │ ├── DesktopPlusUI.vcxproj │ ├── DesktopPlusUI.vcxproj.filters │ ├── DesktopPlusUI.vcxproj.user │ ├── FloatingUI.cpp │ ├── FloatingUI.h │ ├── FloatingWindow.cpp │ ├── FloatingWindow.h │ ├── ImGuiExt.cpp │ ├── ImGuiExt.h │ ├── NotificationIcon.cpp │ ├── NotificationIcon.h │ ├── TextureManager.cpp │ ├── TextureManager.h │ ├── TranslationManager.cpp │ ├── TranslationManager.h │ ├── UIManager.cpp │ ├── UIManager.h │ ├── VRKeyboard.cpp │ ├── VRKeyboard.h │ ├── VRKeyboardCommon.h │ ├── Win32PerformanceData.cpp │ ├── Win32PerformanceData.h │ ├── WindowDesktopMode.cpp │ ├── WindowDesktopMode.h │ ├── WindowFloatingUIBar.cpp │ ├── WindowFloatingUIBar.h │ ├── WindowKeyboard.cpp │ ├── WindowKeyboard.h │ ├── WindowKeyboardEditor.cpp │ ├── WindowKeyboardEditor.h │ ├── WindowOverlayBar.cpp │ ├── WindowOverlayBar.h │ ├── WindowOverlayProperties.cpp │ ├── WindowOverlayProperties.h │ ├── WindowPerformance.cpp │ ├── WindowPerformance.h │ ├── WindowSettings.cpp │ ├── WindowSettings.h │ ├── imgui/ │ │ ├── imconfig.h │ │ ├── imgui.cpp │ │ ├── imgui.h │ │ ├── imgui_demo.cpp │ │ ├── imgui_draw.cpp │ │ ├── imgui_internal.h │ │ ├── imgui_tables.cpp │ │ ├── imgui_widgets.cpp │ │ ├── imstb_rectpack.h │ │ ├── imstb_textedit.h │ │ └── imstb_truetype.h │ ├── imgui_win32_dx11_openvr/ │ │ ├── PixelShaderImGui.hlsl │ │ ├── VertexShaderImGui.hlsl │ │ ├── imgui_impl_dx11_openvr.cpp │ │ ├── imgui_impl_dx11_openvr.h │ │ ├── imgui_impl_win32_openvr.cpp │ │ └── imgui_impl_win32_openvr.h │ ├── implot/ │ │ ├── implot.cpp │ │ ├── implot.h │ │ ├── implot_internal.h │ │ └── implot_items.cpp │ └── resource.h ├── DesktopPlusWinRT/ │ ├── CaptureManager.cpp │ ├── CaptureManager.h │ ├── CommonHeaders.h │ ├── DesktopPlusWinRT.cpp │ ├── DesktopPlusWinRT.h │ ├── DesktopPlusWinRT.rc │ ├── DesktopPlusWinRT.vcxproj │ ├── DesktopPlusWinRT.vcxproj.filters │ ├── DesktopPlusWinRT.vcxproj.user │ ├── OverlayCapture.cpp │ ├── OverlayCapture.h │ ├── ThreadData.h │ ├── packages.config │ ├── resource.h │ └── util/ │ ├── DesktopWindow.h │ ├── capture.desktop.interop.h │ ├── direct3d11.interop.h │ ├── dispatcherqueue.desktop.interop.h │ └── hwnd.interop.h └── Shared/ ├── Actions.cpp ├── Actions.h ├── AppProfiles.cpp ├── AppProfiles.h ├── ConfigManager.cpp ├── ConfigManager.h ├── DPBrowserAPI.h ├── DPBrowserAPIClient.cpp ├── DPBrowserAPIClient.h ├── DPRect.h ├── Ini.cpp ├── Ini.h ├── InterprocessMessaging.cpp ├── InterprocessMessaging.h ├── Logging.cpp ├── Logging.h ├── Matrices.cpp ├── Matrices.h ├── OUtoSBSConverter.cpp ├── OUtoSBSConverter.h ├── OpenVRExt.cpp ├── OpenVRExt.h ├── OverlayDragger.cpp ├── OverlayDragger.h ├── OverlayManager.cpp ├── OverlayManager.h ├── Util.cpp ├── Util.h ├── Vectors.h ├── WindowManager.cpp ├── WindowManager.h ├── loguru.cpp ├── loguru.hpp ├── openvr.h └── openvr_api.lib ================================================ FILE CONTENTS ================================================ ================================================ FILE: .github/FUNDING.yml ================================================ ko_fi: elvissteinjr ================================================ FILE: .github/workflows/nightly.yml ================================================ name: Nightly Build on: push: paths-ignore: - 'README.md' - 'CONTRIBUTING' - 'LICENSE' - 'docs/**' env: SOLUTION_FILE_PATH: ./src/DesktopPlus.sln OUTPUT_PATH: ./src/x64/Release BUILD_CONFIGURATION: Release permissions: contents: read jobs: build: runs-on: windows-latest steps: - name: Checkout uses: actions/checkout@v4 - name: Setup MSBuild uses: microsoft/setup-msbuild@v2 - name: Restore NuGet Packages working-directory: ${{env.GITHUB_WORKSPACE}} run: nuget restore ${{env.SOLUTION_FILE_PATH}} - name: Build working-directory: ${{env.GITHUB_WORKSPACE}} run: msbuild /m /p:Configuration=${{env.BUILD_CONFIGURATION}} /p:DPLUS_SHA='"${{github.sha}}"' ${{env.SOLUTION_FILE_PATH}} - name: Rename Output Folder for Archive working-directory: ${{env.GITHUB_WORKSPACE}} run: ren ${{env.OUTPUT_PATH}} DesktopPlus - name: Upload Artifact uses: actions/upload-artifact@v4 with: name: DesktopPlus-${{github.sha}} path: | ./src/x64 !./**/*.h !./**/*.lib !./**/*.exp ================================================ FILE: CONTRIBUTING ================================================ Short version: Any contribution is welcomed with open arms. In the rare case something would be off, it'll be taken care of. If you contribute code, you allow me to use it in a Steam build that may contain additional code not present in this repo. Long version: I want to preface this with stating that the Desktop+ code is no way trying to be professional. Just read the comments. It's provided as-is, in hope somebody finds a use in it. The code grew with time, overall structure may not be up to best practice. If you want to re-organize it to be "better", feel free. In terms of actually adding code, there are no strict style guidelines. Just don't make the code look foreign in the middle of the existing mess. If you plan to add something big, consider opening an issue for it first. I take some needless pride in the low memory footprint, both runtime and size on disk. Try to not add bloat without reason. It's fine for code to be a tiny bit awkward in order to use system libraries instead of pulling megabytes of additional dependencies. Perhaps also avoid stacks of abstraction. The code may run on typically beefy machines, but it's running in the background most of time. Make sane decisions. Just felt like I should mention this stuff somewhere. Not like anyone reads this anyways. If you contribute code to this repository, you are also granting me (GitHub user elvissteinjr) permission to distribute it on other platforms such as Steam in binary form, possibly linking to non-free third-party libraries such as the Steamworks API library. Such a build may also contain additional code not present in this repo to support these libraries. Please do not contribute if you do not agree to this. ================================================ FILE: LICENSE ================================================ GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . ================================================ FILE: README.md ================================================ # Desktop+ VR Overlay Advanced desktop access for OpenVR. ![VR Interface](docs/screenshot.jpg) ## Features - User interface with real-time adjustments accessible in VR or on desktop - Smooth, low-latency mirroring of desktops and windows - Low memory footprint and performance impact - Support for creating as many overlays as SteamVR allows at once - Customizable overlay settings (width, position, curvature, opacity, cropping), with switchable profiles - 3D support (SBS, HSBS, OU, HOU) - Overlay visibility and origin settings: Display a desktop/window during gameplay or attach it to a different origin (play space, dashboard, HMD, controllers, tracker) - Actions: User-definable functions (input simulation, running applications) which can be bound to controller inputs, hotkeys or UI buttons - Custom laser pointer implementation, allowing for non-blocking overlay interaction during gameplay - Configurable PC-style VR keyboard with various layouts and a keyboard layout editor for deeper customization, appearing automatically when detecting text input widget focus - Elevated access toggle, making it possible to deal with UAC prompts and other UIP-restricted UI in VR without using full admin-access at all times - Gaze Fade: Fade-out overlay when not looking at it - Window management: Change window focus depending on overlay/dashboard state or drag overlays when dragging the title bar of a mirrored window - Performance Monitor: View system performance in real time - Application profiles: Automatically switch overlay profiles when a specific VR application is being run - Browser overlays: View web pages independent from your desktop (CEF-based) ## Usage ### Steam Install Desktop+ from its [Steam store page](https://store.steampowered.com/app/1494460) and run it. ### Release Archive Download and extract the latest archive from the [releases page](https://github.com/elvissteinjr/DesktopPlus/releases). Follow instructions in the included [readme file](assets/readme.txt). Make sure to also download the [Desktop+ Browser component](https://github.com/elvissteinjr/DesktopPlusBrowser/releases) if you want browser overlay support. ### Nightly Build An automated build based on the latest code changes can be downloaded from [here](https://nightly.link/elvissteinjr/DesktopPlus/workflows/nightly/master). Keep in mind that nightly builds are unstable and mostly untested. Prefer the latest release if possible. ### Building from Source The Visual Studio 2019 Solution builds out of the box with no further external dependencies. Building with Graphics Capture support requires Windows SDK 10.0.19041 or newer, and will download C++/WinRT packages automatically. Graphics Capture support can be disabled entirely if desired. Windows 8 SDK or newer is sufficient in that case. See DesktopPlusWinRT.h for details. See the [Desktop+ Browser repository](https://github.com/elvissteinjr/DesktopPlusBrowser) for building the browser component. Other compilers likely work as well, but are neither tested nor have a build configuration. Building for 32-bit is not supported. ## Demonstration The [Steam announcements](https://store.steampowered.com/news/app/1494460) for typically feature short video clips showing off new additions. The trailer on the [Steam store page](https://store.steampowered.com/app/1494460) also shows off some functionality. ## Documentation For basic usage, installation and troubleshooting see the included [readme file](assets/readme.txt). For more detailed information on each setting, step-by-step examples for a few common usage scenarios and more check out the [User Guide](docs/user_guide.md). ## Notes Desktop+ only runs on Windows 8.1 or newer, as it uses the DXGI Desktop Duplication API which is not available on older versions of Windows. Window mirroring through Graphics Capture requires at least Windows 10 1803 for basic support, Windows 10 2004 or newer for full support (some additional non-essential features require Windows 11 or Windows 11 24H2). ## License This software is licensed under the GPL 3.0. Desktop+ includes work of third-party projects. For their licenses, see [here](assets/third-party_licenses.txt). ================================================ FILE: assets/action_manifest.json ================================================ { "actions": [ { "name": "/actions/shortcuts/in/EnableGlobalLaserPointer", "requirement": "optional", "type": "boolean" }, { "name": "/actions/shortcuts/in/GlobalShortcut01", "requirement": "optional", "type": "boolean" }, { "name": "/actions/shortcuts/in/GlobalShortcut02", "requirement": "optional", "type": "boolean" }, { "name": "/actions/shortcuts/in/GlobalShortcut03", "requirement": "optional", "type": "boolean" }, { "name": "/actions/shortcuts/in/GlobalShortcut04", "requirement": "optional", "type": "boolean" }, { "name": "/actions/shortcuts/in/GlobalShortcut05", "requirement": "optional", "type": "boolean" }, { "name": "/actions/shortcuts/in/GlobalShortcut06", "requirement": "optional", "type": "boolean" }, { "name": "/actions/shortcuts/in/GlobalShortcut07", "requirement": "optional", "type": "boolean" }, { "name": "/actions/shortcuts/in/GlobalShortcut08", "requirement": "optional", "type": "boolean" }, { "name": "/actions/shortcuts/in/GlobalShortcut09", "requirement": "optional", "type": "boolean" }, { "name": "/actions/shortcuts/in/GlobalShortcut10", "requirement": "optional", "type": "boolean" }, { "name": "/actions/shortcuts/in/GlobalShortcut11", "requirement": "optional", "type": "boolean" }, { "name": "/actions/shortcuts/in/GlobalShortcut12", "requirement": "optional", "type": "boolean" }, { "name": "/actions/shortcuts/in/GlobalShortcut13", "requirement": "optional", "type": "boolean" }, { "name": "/actions/shortcuts/in/GlobalShortcut14", "requirement": "optional", "type": "boolean" }, { "name": "/actions/shortcuts/in/GlobalShortcut15", "requirement": "optional", "type": "boolean" }, { "name": "/actions/shortcuts/in/GlobalShortcut16", "requirement": "optional", "type": "boolean" }, { "name": "/actions/shortcuts/in/GlobalShortcut17", "requirement": "optional", "type": "boolean" }, { "name": "/actions/shortcuts/in/GlobalShortcut18", "requirement": "optional", "type": "boolean" }, { "name": "/actions/shortcuts/in/GlobalShortcut19", "requirement": "optional", "type": "boolean" }, { "name": "/actions/shortcuts/in/GlobalShortcut20", "requirement": "optional", "type": "boolean" }, { "name": "/actions/laserpointer/in/LeftClick", "requirement": "suggested", "type": "boolean" }, { "name": "/actions/laserpointer/in/RightClick", "requirement": "optional", "type": "boolean" }, { "name": "/actions/laserpointer/in/MiddleClick", "requirement": "optional", "type": "boolean" }, { "name": "/actions/laserpointer/in/Aux01Click", "requirement": "optional", "type": "boolean" }, { "name": "/actions/laserpointer/in/Aux02Click", "requirement": "optional", "type": "boolean" }, { "name": "/actions/laserpointer/in/Drag", "requirement": "optional", "type": "boolean" }, { "name": "/actions/scroll_discrete/in/ScrollDiscrete", "requirement": "suggested", "type": "vector2" }, { "name": "/actions/scroll_smooth/in/ScrollSmooth", "requirement": "suggested", "type": "vector2" }, { "name": "/actions/laserpointer/out/Haptic", "requirement": "suggested", "type": "vibration" } ], "action_sets": [ { "name": "/actions/shortcuts", "usage": "leftright" }, { "name": "/actions/laserpointer", "usage": "single" }, { "name": "/actions/scroll_discrete", "display_with": "/actions/laserpointer", "usage": "single" }, { "name": "/actions/scroll_smooth", "display_with": "/actions/laserpointer", "usage": "single" } ], "localization_files": { "en_US" : "input/action_manifest_en.json", "de_DE" : "input/action_manifest_de.json", "ja_JP" : "input/action_manifest_ja.json", "ko_KR" : "input/action_manifest_ko.json", "zh_CN" : "input/action_manifest_zh_CN.json" }, "default_bindings": [ { "controller_type": "frame_controller", "binding_url": "input/action_bindings_frame_controller.json" }, { "controller_type": "knuckles", "binding_url": "input/action_bindings_knuckles.json" }, { "controller_type": "playstation_vr2_sense", "binding_url": "input/action_bindings_playstation_vr2_sense_controller.json" }, { "controller_type": "hpmotioncontroller", "binding_url": "input/action_bindings_hpmotioncontroller.json" }, { "controller_type": "holographic", "binding_url": "input/action_bindings_holographic.json" }, { "controller_type": "oculus_touch", "binding_url": "input/action_bindings_touch.json" }, { "controller_type": "vive_cosmos_controller", "binding_url": "input/action_bindings_vive_cosmos.json" }, { "controller_type": "knuckles_ev1", "binding_url": "input/action_bindings_knuckles_ev1.json" }, { "controller_type": "vive_controller", "binding_url": "input/action_bindings_vive_controller.json" }, { "controller_type": "svl_hand_interaction_augmented", "binding_url": "input/action_bindings_svl_hand_interaction_augmented.json" }, { "controller_type": "gamepad", "binding_url": "input/action_bindings_gamepad.json" }, { "controller_type": "generic", "binding_url": "input/action_bindings_generic.json" } ], "version": 5, "minimum_required_version": 2 } ================================================ FILE: assets/actions_default.ini ================================================ [1] Name=tstr_DefActionShowKeyboard CommandCount=1 Command0Type=ShowKeyboard Command0UIntArg=0 IconFilename=keyboard.png [2] Name=tstr_DefActionActiveWindowCrop Label=tstr_DefActionActiveWindowCropLabel CommandCount=1 Command0Type=CropActiveWindow [3] Name=tstr_DefActionSwitchTask CommandCount=1 Command0Type=SwitchTask IconFilename=task_switch.png [4] Name=tstr_DefActionToggleOverlays Label=tstr_DefActionToggleOverlaysLabel CommandCount=1 Command0Type=ShowOverlay TargetUseTags=true TargetTags=Ovrl_All [5] Name=tstr_DefActionMiddleMouse Label=tstr_DefActionMiddleMouseLabel CommandCount=1 Command0Type=Key Command0UIntID=4 Command0UIntArg=0 [6] Name=tstr_DefActionBackMouse Label=tstr_DefActionBackMouseLabel CommandCount=1 Command0Type=Key Command0UIntID=5 Command0UIntArg=0 [7] Name=tstr_DefActionReadMe Label=tstr_DefActionReadMeLabel CommandCount=1 Command0Type=LaunchApp Command0StrMain=readme.txt [8] Name=tstr_DefActionDashboardToggle Label=tstr_DefActionDashboardToggleLabel CommandCount=1 Command0Type=LaunchApp Command0StrMain=vrmonitor://debugcommands/system_dashboard_toggle ================================================ FILE: assets/config_default.ini ================================================ ;Lines starting with ; are comments ;Boolean settings allow use of "true"/"false" or 1/0 ;Do not include the quotation marks for string values ;Only change the values after the = ; ;It shouldn't be necessary to mess with most of these by hand, but feel free to do so ;Hidden settings are preceded by a comment line ;Save changes to config.ini, not config_default.ini, and make sure Desktop+ is not running when doing so [Overlay0] Name= NameIsCustom=false Enabled=true DesktopID=0 CaptureSource=0 WinRTDesktopID=-2 WinRTLastWindowTitle= WinRTLastWindowClassName= WinRTLastWindowExeName= BrowserURL= BrowserURLUserLast= BrowserTitle= BrowserAllowTransparency=false Width=165 Curvature=17 Opacity=100 Brightness=100 OffsetRight=0 OffsetUp=0 OffsetForward=0 DisplayMode=3 Origin=Dashboard OriginHMDFloorTurning=false OriginSmoothingLevel=0 TransformLocked=true CroppingEnabled=false CroppingX=0 CroppingY=0 CroppingWidth=-1 CroppingHeight=-1 ShowBackside=true 3DEnabled=false 3DMode=0 3DSwapped=false GazeFade=false GazeFadeDistance=0 GazeFadeRate=100 GazeFadeOpacity=0 UpdateLimitModeOverride=0 UpdateLimitMS=0 UpdateLimitFPS=7 InputEnabled=true InputDPlusLPEnabled=true UpdateInvisible=false ShowFloatingUI=true ShowDesktopButtons=true ShowActionBar=true ShowExtraButtons=true ActionBarOrderUseGlobal=true Transform=[2.12766 0 0 0 0 2.12766 0 0 0 0 2.12766 0 0 0 0 1] [Interface] ;Don't want DesktopPlusUI.exe to run automatically? Set this to true NoUIAutoLaunch=false ;Don't want the notification/tray icon? Set this to true NoNotificationIcon=false ;Want to override desktop mode DPI? Set your custom scale here (100 is 100%) DesktopUIScaleOverride=0 ;LanguageFile is not included here to trigger auto-detection ShowAdvancedSettings=false DisplaySizeLarge=false OverlayCurrentID=0 DesktopButtonCyclingMode=1 DesktopButtonIncludeAll=false EnvironmentBackgroundColor=00000080 EnvironmentBackgroundColorDisplayMode=0 DimUI=false BlankSpaceDragEnabled=true LastVRUIScale=100 WarningCompositorResolutionHidden=false WarningCompositorQualityHidden=false WarningProcessElevationHidden=false WarningElevatedModeHidden=false WarningBrowserMissingHidden=false WarningBrowserVersionMismatchHidden=false WarningAppProfileActiveHidden=false ActionOrder=1;2;3;4;5;6;7;8; ActionOrderBarDefault=1;3;7; WindowSettingsRestoreState=false WindowSettingsRoomVisible=false WindowSettingsRoomPinned=false WindowSettingsRoomSize=100 WindowSettingsRoomTransform=[0.965926 0 0.258819 0 0 1 0 0 -0.258819 0 0.965926 0 0.846609 0.7 0.38214 1] WindowSettingsDashboardTabVisible=false WindowSettingsDashboardTabPinned=false WindowSettingsDashboardTabSize=100 WindowSettingsDashboardTabTransform=[0.965926 0 0.258819 0 0 1 0 0 -0.258819 0 0.965926 0 0.846609 0.7 0.38214 1] WindowPropertiesRestoreState=false WindowPropertiesRoomVisible=false WindowPropertiesRoomPinned=false WindowPropertiesRoomSize=100 WindowPropertiesRoomTransform=[0.965926 0 -0.258819 0 0 1 0 0 0.258819 0 0.965926 0 -0.846609 0.7 0.38214 1] WindowPropertiesDashboardTabVisible=false WindowPropertiesDashboardTabPinned=false WindowPropertiesDashboardTabSize=100 WindowPropertiesDashboardTabTransform=[0.965926 0 -0.258819 0 0 1 0 0 0.258819 0 0.965926 0 -0.846609 0.7 0.38214 1] WindowPropertiesLastOverlayID=-1 WindowPropertiesRestoreState=false WindowPropertiesRoomVisible=false WindowPropertiesDashboardTabVisible=false WindowKeyboardRestoreState=true WindowKeyboardRoomVisible=false WindowKeyboardRoomPinned=false WindowKeyboardRoomSize=100 WindowKeyboardRoomTransform=[1 0 0 0 0 0.707107 -0.707107 0 0 0.707107 0.707107 0 0 -0.782608 0.782608 1] WindowKeyboardDashboardTabVisible=false WindowKeyboardDashboardTabPinned=false WindowKeyboardDashboardTabSize=100 WindowKeyboardDashboardTabTransform=[1 0 0 0 0 0.707107 -0.707107 0 0 0.707107 0.707107 0 0 -0.767465 0.767466 1] WindowKeyboardLastAssignedOverlayID=-1 QuickStartGuideHidden=false [Input] GoHomeButtonActionUID=6 GoBackButtonActionUID=5 ;You can change this to allow for more global shortcuts, but the action manifest needs to adjusted as well and the app can not be installed in Steam (its internal manifest has priority) GlobalShortcutsMaxCount=20 GlobalShortcut01ActionUID=0 GlobalHotkey01Modifiers=0 GlobalHotkey01KeyCode=0 GlobalHotkey01ActionUID=0 DetachedInteractionMaxDistance=200 LaserPointerBlockInput=false GlobalHMDPointer=false LaserPointerHMDKeyCodeToggle=0 LaserPointerHMDKeyCodeLeft=0 LaserPointerHMDKeyCodeRight=0 LaserPointerHMDKeyCodeMiddle=0 LaserPointerHMDKeyCodeDrag=0 DragAutoDocking=true DragFixedDistance=false DragFixedDistanceCM=200 DragFixedDistanceShape=0 DragFixedDistanceAutoCurve=true DragFixedDistanceAutoTilt=true DragSnapPosition=false DragSnapPositionSize=10 DragSnapRotation=false DragSnapRotationX=true DragSnapRotationY=true DragSnapRotationZ=true DragSnapRotationAngle=45 [Mouse] RenderCursor=true RenderIntersectionBlob=false ScrollSmooth=false SimulatePenInput=false AllowPointerOverride=true DoubleClickAssistDuration=-1 InputSmoothingLevel=0 [Keyboard] LayoutFile=qwerty_usa.ini LayoutClusterFunction=true LayoutClusterNavigation=true LayoutClusterNumpad=false LayoutClusterExtra=false StickyModifiers=true KeyRepeat=true [Windows] AutoFocusSceneAppDashboard=false WinRTAutoFocus=true WinRTKeepOnScreen=true WinRTAutoSizeOverlay=false WinRTAutoFocusSceneApp=false WinRTWindowMatchingStrict=false WinRTDraggingMode=2 WinRTOnCaptureLost=1 [Browser] ;These arguments are passed to the Desktop+ Browser executable and parsed by CEF. Things may break, use at your own risk. CommandLineArguments= BrowserMaxFPS=60 BrowserContentBlocker=false [Performance] UpdateLimitMode=0 UpdateLimitMS=0 UpdateLimitFPS=7 RapidLaserPointerUpdates=false SingleDesktopMirroring=false AlternativeCursorRendering=false ShowFPS=false ;Experience issues with the UI getting stuck? Set this to false to let it render unconditionally UIAutoThrottle=true ;Want to lower the render rate of the UI? Set this to the amount of VR frame syncs to skip for each rendered UI frame UIFrameSkip=0 PerformanceMonitorStyleMinimal=false PerformanceMonitorStyleLarge=true PerformanceMonitorStyleShowWindow=true PerformanceMonitorStyleShowTextOutline=false PerformanceMonitorStyleMinimalShowMore=false PerformanceMonitorShowGraphs=true PerformanceMonitorShowTime=false PerformanceMonitorShowCPU=true PerformanceMonitorShowGPU=true PerformanceMonitorShowFPS=true PerformanceMonitorShowBattery=true PerformanceMonitorShowTrackers=true PerformanceMonitorShowViveWireless=false ;Disables display of GPU load % and VRAM usage. This prevents GPU hardware monitoring related stutter with certain older NVIDIA drivers PerformanceMonitorDisableGPUCounters=false [Misc] NoSteam=false UIAccessWasEnabled=false ;Need to force a specific GPU to be used? Set the DeviceID here (get the IDs from logs) ForceGPUDeviceID=-1 ;Same as above but for the GPU SteamVR is using if different from the desktops. Normally SteamVR reports it to the application with no need to change anything here ForceGPUVRDeviceID=-1 ================================================ FILE: assets/input/action_bindings_frame_controller.json ================================================ { "action_manifest_version" : 5, "alias_info" : {}, "app_key" : "steam.overlay.1494460", "bindings" : { "/actions/laserpointer" : { "haptics" : [ { "output" : "/actions/laserpointer/out/Haptic", "path" : "/user/hand/left/output/haptic" }, { "output" : "/actions/laserpointer/out/Haptic", "path" : "/user/hand/right/output/haptic" } ], "sources" : [ { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/LeftClick" } }, "mode" : "button", "parameters" : { "click_activate_threshold" : "0.65", "click_deactivate_threshold" : "0.6", "haptic_amplitude" : "0" }, "path" : "/user/hand/right/input/trigger" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/LeftClick" } }, "mode" : "button", "parameters" : { "click_activate_threshold" : "0.65", "click_deactivate_threshold" : "0.6", "haptic_amplitude" : "0" }, "path" : "/user/hand/left/input/trigger" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/RightClick" } }, "mode" : "button", "path" : "/user/hand/left/input/bumper" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/RightClick" } }, "mode" : "button", "path" : "/user/hand/right/input/bumper" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux02Click" } }, "mode" : "button", "path" : "/user/hand/left/input/dpad_down" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux02Click" } }, "mode" : "button", "path" : "/user/hand/right/input/b" } ] }, "/actions/scroll_discrete" : { "sources" : [ { "inputs" : { "scroll" : { "output" : "/actions/scroll_discrete/in/ScrollDiscrete" } }, "mode" : "scroll", "path" : "/user/hand/left/input/thumbstick" }, { "inputs" : { "scroll" : { "output" : "/actions/scroll_discrete/in/ScrollDiscrete" } }, "mode" : "scroll", "path" : "/user/hand/right/input/thumbstick" } ] }, "/actions/scroll_smooth" : { "sources" : [ { "inputs" : { "scroll" : { "output" : "/actions/scroll_smooth/in/ScrollSmooth" } }, "mode" : "scroll", "parameters" : { "scroll_mode" : "smooth" }, "path" : "/user/hand/left/input/thumbstick" }, { "inputs" : { "scroll" : { "output" : "/actions/scroll_smooth/in/ScrollSmooth" } }, "mode" : "scroll", "parameters" : { "scroll_mode" : "smooth" }, "path" : "/user/hand/right/input/thumbstick" } ] } }, "category" : "steamvr_input", "controller_type" : "frame_controller", "description" : "", "name" : "Default Desktop+ bindings for Steam Frame Controllers", "options" : {}, "simulated_actions" : [] } ================================================ FILE: assets/input/action_bindings_gamepad.json ================================================ { "action_manifest_version" : 5, "alias_info" : {}, "app_key" : "steam.overlay.1494460", "bindings" : { "/actions/laserpointer" : { "sources" : [ { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/LeftClick" } }, "mode" : "button", "path" : "/user/gamepad/input/trigger_right" }, { "inputs" : { "east" : { "output" : "/actions/laserpointer/in/RightClick" } }, "mode" : "button", "path" : "/user/gamepad/input/trigger_left" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux01Click" } }, "mode" : "button", "path" : "/user/gamepad/input/b" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux02Click" } }, "mode" : "button", "path" : "/user/gamepad/input/x" } ] }, "/actions/scroll_discrete" : { "sources" : [ { "inputs" : { "scroll" : { "output" : "/actions/scroll_discrete/in/ScrollDiscrete" } }, "mode" : "scroll", "path" : "/user/gamepad/input/joystick_right" } ] }, "/actions/scroll_smooth" : { "sources" : [ { "inputs" : { "scroll" : { "output" : "/actions/scroll_smooth/in/ScrollSmooth" } }, "mode" : "scroll", "parameters" : { "scroll_mode" : "smooth" }, "path" : "/user/gamepad/input/joystick_right" } ] } }, "category" : "steamvr_input", "controller_type" : "gamepad", "description" : "", "name" : "Default Desktop+ bindings for Gamepads", "options" : {}, "simulated_actions" : [] } ================================================ FILE: assets/input/action_bindings_generic.json ================================================ { "action_manifest_version" : 5, "alias_info" : {}, "app_key" : "steam.overlay.1494460", "bindings" : { "/actions/laserpointer" : { "haptics" : [ { "output" : "/actions/laserpointer/out/Haptic", "path" : "/user/hand/left/output/haptic" }, { "output" : "/actions/laserpointer/out/Haptic", "path" : "/user/hand/right/output/haptic" } ], "sources" : [ { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/LeftClick" } }, "mode" : "button", "path" : "/user/hand/right/input/trigger" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/LeftClick" } }, "mode" : "button", "path" : "/user/hand/left/input/trigger" }, { "inputs" : { "east" : { "output" : "/actions/laserpointer/in/RightClick" } }, "mode" : "dpad_click", "path" : "/user/hand/left/input/trackpad" }, { "inputs" : { "east" : { "output" : "/actions/laserpointer/in/RightClick" } }, "mode" : "dpad_click", "path" : "/user/hand/right/input/trackpad" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux01Click" } }, "mode" : "button", "path" : "/user/hand/left/input/grip" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux01Click" } }, "mode" : "button", "path" : "/user/hand/right/input/grip" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux02Click" } }, "mode" : "button", "path" : "/user/hand/left/input/application_menu" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux02Click" } }, "mode" : "button", "path" : "/user/hand/right/input/application_menu" } ] }, "/actions/scroll_discrete" : { "sources" : [ { "inputs" : { "scroll" : { "output" : "/actions/scroll_discrete/in/ScrollDiscrete" } }, "mode" : "scroll", "parameters" : { "discrete_scroll_trackpad_accumthreshold_onmove" : "0.224", "discrete_scroll_trackpad_accumthreshold_onreversal" : "0.672", "discrete_scroll_trackpad_accumthreshold_ontouch" : "0.624", "discrete_scroll_trackpad_noisethreshold_onmove" : "0.008", "discrete_scroll_trackpad_noisethreshold_onreversal" : "0.095", "discrete_scroll_trackpad_noisethreshold_ontouch" : "0.16", "discrete_scroll_trackpad_slideandhold_borderbottom" : "-0.60", "discrete_scroll_trackpad_slideandhold_bordertop" : "0.65", "scroll_mode" : "discrete" }, "path" : "/user/hand/left/input/trackpad" }, { "inputs" : { "scroll" : { "output" : "/actions/scroll_discrete/in/ScrollDiscrete" } }, "mode" : "scroll", "parameters" : { "discrete_scroll_trackpad_accumthreshold_onmove" : "0.224", "discrete_scroll_trackpad_accumthreshold_onreversal" : "0.672", "discrete_scroll_trackpad_accumthreshold_ontouch" : "0.624", "discrete_scroll_trackpad_noisethreshold_onmove" : "0.008", "discrete_scroll_trackpad_noisethreshold_onreversal" : "0.095", "discrete_scroll_trackpad_noisethreshold_ontouch" : "0.16", "discrete_scroll_trackpad_slideandhold_borderbottom" : "-0.60", "discrete_scroll_trackpad_slideandhold_bordertop" : "0.65", "scroll_mode" : "discrete" }, "path" : "/user/hand/right/input/trackpad" } ] }, "/actions/scroll_smooth" : { "sources" : [ { "inputs" : { "scroll" : { "output" : "/actions/scroll_smooth/in/ScrollSmooth" } }, "mode" : "scroll", "parameters" : { "scroll_mode" : "smooth" }, "path" : "/user/hand/left/input/trackpad" }, { "inputs" : { "scroll" : { "output" : "/actions/scroll_smooth/in/ScrollSmooth" } }, "mode" : "scroll", "parameters" : { "scroll_mode" : "smooth" }, "path" : "/user/hand/right/input/trackpad" } ] } }, "category" : "steamvr_input", "controller_type" : "generic", "description" : "", "name" : "Default Desktop+ bindings for Generic Controllers", "options" : {}, "simulated_actions" : [] } ================================================ FILE: assets/input/action_bindings_holographic.json ================================================ { "action_manifest_version" : 5, "alias_info" : {}, "app_key" : "steam.overlay.1494460", "bindings" : { "/actions/laserpointer" : { "haptics" : [ { "output" : "/actions/laserpointer/out/Haptic", "path" : "/user/hand/left/output/haptic" }, { "output" : "/actions/laserpointer/out/Haptic", "path" : "/user/hand/right/output/haptic" } ], "sources" : [ { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/LeftClick" } }, "mode" : "button", "path" : "/user/hand/right/input/trigger" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/LeftClick" } }, "mode" : "button", "path" : "/user/hand/left/input/trigger" }, { "inputs" : { "east" : { "output" : "/actions/laserpointer/in/RightClick" } }, "mode" : "dpad_click", "path" : "/user/hand/left/input/trackpad" }, { "inputs" : { "east" : { "output" : "/actions/laserpointer/in/RightClick" } }, "mode" : "dpad_click", "path" : "/user/hand/right/input/trackpad" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux01Click" } }, "mode" : "button", "path" : "/user/hand/left/input/grip" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux01Click" } }, "mode" : "button", "path" : "/user/hand/right/input/grip" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux02Click" } }, "mode" : "button", "path" : "/user/hand/left/input/application_menu" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux02Click" } }, "mode" : "button", "path" : "/user/hand/right/input/application_menu" } ] }, "/actions/scroll_discrete" : { "sources" : [ { "inputs" : { "scroll" : { "output" : "/actions/scroll_discrete/in/ScrollDiscrete" } }, "mode" : "scroll", "parameters" : { "scroll_mode" : "discrete" }, "path" : "/user/hand/left/input/joystick" }, { "inputs" : { "scroll" : { "output" : "/actions/scroll_discrete/in/ScrollDiscrete" } }, "mode" : "scroll", "parameters" : { "scroll_mode" : "discrete" }, "path" : "/user/hand/right/input/joystick" }, { "inputs" : { "scroll" : { "output" : "/actions/scroll_discrete/in/ScrollDiscrete" } }, "mode" : "scroll", "path" : "/user/hand/left/input/trackpad" }, { "inputs" : { "scroll" : { "output" : "/actions/scroll_discrete/in/ScrollDiscrete" } }, "mode" : "scroll", "path" : "/user/hand/right/input/trackpad" } ] }, "/actions/scroll_smooth" : { "sources" : [ { "inputs" : { "scroll" : { "output" : "/actions/scroll_smooth/in/ScrollSmooth" } }, "mode" : "scroll", "parameters": { "scroll_mode": "smooth", "smooth_scroll_multiplier": "11.8" }, "path" : "/user/hand/left/input/trackpad" }, { "inputs" : { "scroll" : { "output" : "/actions/scroll_smooth/in/ScrollSmooth" } }, "mode" : "scroll", "parameters": { "scroll_mode": "smooth", "smooth_scroll_multiplier": "11.8" }, "path" : "/user/hand/right/input/trackpad" }, { "inputs" : { "scroll" : { "output" : "/actions/scroll_smooth/in/ScrollSmooth" } }, "mode" : "scroll", "parameters": { "scroll_mode": "smooth", "smooth_scroll_joystick_min_input_magnitude": "0.3" }, "path" : "/user/hand/left/input/joystick" }, { "inputs" : { "scroll" : { "output" : "/actions/scroll_smooth/in/ScrollSmooth" } }, "mode" : "scroll", "parameters": { "scroll_mode": "smooth", "smooth_scroll_joystick_min_input_magnitude": "0.3" }, "path" : "/user/hand/right/input/joystick" } ] } }, "category" : "steamvr_input", "controller_type" : "holographic_controller", "description" : "", "name" : "Default Desktop+ bindings for Windows Mixed Reality Controllers", "options" : {}, "simulated_actions" : [] } ================================================ FILE: assets/input/action_bindings_hpmotioncontroller.json ================================================ { "action_manifest_version" : 5, "alias_info" : {}, "app_key" : "steam.overlay.1494460", "bindings" : { "/actions/laserpointer" : { "haptics" : [ { "output" : "/actions/laserpointer/out/Haptic", "path" : "/user/hand/left/output/haptic" }, { "output" : "/actions/laserpointer/out/Haptic", "path" : "/user/hand/right/output/haptic" } ], "sources" : [ { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/LeftClick" } }, "mode" : "button", "path" : "/user/hand/right/input/trigger" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/LeftClick" } }, "mode" : "button", "path" : "/user/hand/left/input/trigger" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/RightClick" } }, "mode" : "button", "path" : "/user/hand/left/input/x" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/RightClick" } }, "mode" : "button", "path" : "/user/hand/right/input/a" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux01Click" } }, "mode" : "button", "path" : "/user/hand/left/input/grip" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux01Click" } }, "mode" : "button", "path" : "/user/hand/right/input/grip" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux02Click" } }, "mode" : "button", "path" : "/user/hand/left/input/y" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux02Click" } }, "mode" : "button", "path" : "/user/hand/right/input/b" } ] }, "/actions/scroll_discrete" : { "sources" : [ { "inputs" : { "scroll" : { "output" : "/actions/scroll_discrete/in/ScrollDiscrete" } }, "mode" : "scroll", "path" : "/user/hand/left/input/joystick" }, { "inputs" : { "scroll" : { "output" : "/actions/scroll_discrete/in/ScrollDiscrete" } }, "mode" : "scroll", "path" : "/user/hand/right/input/joystick" } ] }, "/actions/scroll_smooth" : { "sources" : [ { "inputs" : { "scroll" : { "output" : "/actions/scroll_smooth/in/ScrollSmooth" } }, "mode" : "scroll", "path" : "/user/hand/left/input/joystick" }, { "inputs" : { "scroll" : { "output" : "/actions/scroll_smooth/in/ScrollSmooth" } }, "mode" : "scroll", "path" : "/user/hand/right/input/joystick" } ] } }, "category" : "steamvr_input", "controller_type" : "hpmotioncontroller", "description" : "", "name" : "Default Desktop+ bindings for HP Motion Controllers", "options" : {}, "simulated_actions" : [] } ================================================ FILE: assets/input/action_bindings_knuckles.json ================================================ { "action_manifest_version" : 5, "alias_info" : {}, "app_key" : "steam.overlay.1494460", "bindings" : { "/actions/laserpointer" : { "haptics" : [ { "output" : "/actions/laserpointer/out/Haptic", "path" : "/user/hand/left/output/haptic" }, { "output" : "/actions/laserpointer/out/Haptic", "path" : "/user/hand/right/output/haptic" } ], "sources" : [ { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/LeftClick" } }, "mode" : "button", "parameters" : { "click_activate_threshold" : "0.65", "click_deactivate_threshold" : "0.6" }, "path" : "/user/hand/right/input/trigger" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/LeftClick" } }, "mode" : "button", "parameters" : { "click_activate_threshold" : "0.65", "click_deactivate_threshold" : "0.6" }, "path" : "/user/hand/left/input/trigger" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/RightClick" } }, "mode" : "button", "path" : "/user/hand/left/input/trackpad" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/RightClick" } }, "mode" : "button", "path" : "/user/hand/right/input/trackpad" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/MiddleClick" } }, "mode" : "joystick", "path" : "/user/hand/left/input/thumbstick" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/MiddleClick" } }, "mode" : "joystick", "path" : "/user/hand/right/input/thumbstick" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux01Click" } }, "mode" : "button", "path" : "/user/hand/left/input/b" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux01Click" } }, "mode" : "button", "path" : "/user/hand/right/input/b" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux02Click" } }, "mode" : "button", "path" : "/user/hand/left/input/a" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux02Click" } }, "mode" : "button", "path" : "/user/hand/right/input/a" } ] }, "/actions/scroll_discrete" : { "sources" : [ { "inputs" : { "scroll" : { "output" : "/actions/scroll_discrete/in/ScrollDiscrete" } }, "mode" : "scroll", "parameters" : { "scroll_mode" : "discrete" }, "path" : "/user/hand/left/input/thumbstick" }, { "inputs" : { "scroll" : { "output" : "/actions/scroll_discrete/in/ScrollDiscrete" } }, "mode" : "scroll", "parameters" : { "scroll_mode" : "discrete" }, "path" : "/user/hand/right/input/thumbstick" }, { "inputs" : { "scroll" : { "output" : "/actions/scroll_discrete/in/ScrollDiscrete" } }, "mode" : "scroll", "parameters" : { "discrete_scroll_trackpad_accumthreshold_onmove" : "0.28", "discrete_scroll_trackpad_accumthreshold_onreversal" : "0.84", "discrete_scroll_trackpad_accumthreshold_ontouch" : "0.78", "discrete_scroll_trackpad_noisethreshold_onmove" : "0.01", "discrete_scroll_trackpad_noisethreshold_onreversal" : "0.045", "discrete_scroll_trackpad_noisethreshold_ontouch" : "0.15", "discrete_scroll_trackpad_slideandhold_borderbottom" : "-0.65", "discrete_scroll_trackpad_slideandhold_bordertop" : "0.55", "scroll_mode" : "discrete" }, "path" : "/user/hand/left/input/trackpad" }, { "inputs" : { "scroll" : { "output" : "/actions/scroll_discrete/in/ScrollDiscrete" } }, "mode" : "scroll", "parameters" : { "discrete_scroll_trackpad_accumthreshold_onmove" : "0.28", "discrete_scroll_trackpad_accumthreshold_onreversal" : "0.84", "discrete_scroll_trackpad_accumthreshold_ontouch" : "0.78", "discrete_scroll_trackpad_noisethreshold_onmove" : "0.01", "discrete_scroll_trackpad_noisethreshold_onreversal" : "0.045", "discrete_scroll_trackpad_noisethreshold_ontouch" : "0.15", "discrete_scroll_trackpad_slideandhold_borderbottom" : "-0.65", "discrete_scroll_trackpad_slideandhold_bordertop" : "0.55", "scroll_mode" : "discrete" }, "path" : "/user/hand/right/input/trackpad" } ] }, "/actions/scroll_smooth" : { "sources" : [ { "inputs" : { "scroll" : { "output" : "/actions/scroll_smooth/in/ScrollSmooth" } }, "mode" : "scroll", "parameters" : { "scroll_mode" : "smooth", "smooth_scroll_edge_min_swipe" : "0.75", "smooth_scroll_edge_scroll_threshold" : "0.55", "smooth_scroll_edge_scroll_threshold_vertical_bias" : "0.1", "smooth_scroll_trackpad_aspect_ratio" : "0.5" }, "path" : "/user/hand/left/input/trackpad" }, { "inputs" : { "scroll" : { "output" : "/actions/scroll_smooth/in/ScrollSmooth" } }, "mode" : "scroll", "parameters" : { "scroll_mode" : "smooth", "smooth_scroll_edge_min_swipe" : "0.75", "smooth_scroll_edge_scroll_threshold" : "0.55", "smooth_scroll_edge_scroll_threshold_vertical_bias" : "0.1", "smooth_scroll_trackpad_aspect_ratio" : "0.5" }, "path" : "/user/hand/right/input/trackpad" }, { "inputs" : { "scroll" : { "output" : "/actions/scroll_smooth/in/ScrollSmooth" } }, "mode" : "scroll", "parameters" : { "scroll_mode" : "smooth" }, "path" : "/user/hand/left/input/thumbstick" }, { "inputs" : { "scroll" : { "output" : "/actions/scroll_smooth/in/ScrollSmooth" } }, "mode" : "scroll", "parameters" : { "scroll_mode" : "smooth" }, "path" : "/user/hand/right/input/thumbstick" } ] } }, "category" : "steamvr_input", "controller_type" : "knuckles", "description" : "", "name" : "Default Desktop+ bindings for Index Controllers", "options" : {}, "simulated_actions" : [] } ================================================ FILE: assets/input/action_bindings_knuckles_ev1.json ================================================ { "action_manifest_version" : 5, "alias_info" : {}, "app_key" : "steam.overlay.1494460", "bindings" : { "/actions/laserpointer" : { "haptics" : [ { "output" : "/actions/laserpointer/out/Haptic", "path" : "/user/hand/left/output/haptic" }, { "output" : "/actions/laserpointer/out/Haptic", "path" : "/user/hand/right/output/haptic" } ], "sources" : [ { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/LeftClick" } }, "mode" : "button", "path" : "/user/hand/right/input/trigger" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/LeftClick" } }, "mode" : "button", "path" : "/user/hand/left/input/trigger" }, { "inputs" : { "east" : { "output" : "/actions/laserpointer/in/RightClick" } }, "mode" : "dpad_click", "path" : "/user/hand/left/input/trackpad" }, { "inputs" : { "east" : { "output" : "/actions/laserpointer/in/RightClick" } }, "mode" : "dpad_click", "path" : "/user/hand/right/input/trackpad" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux01Click" } }, "mode" : "button", "path" : "/user/hand/left/input/b" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux01Click" } }, "mode" : "button", "path" : "/user/hand/right/input/a" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux02Click" } }, "mode" : "button", "path" : "/user/hand/left/input/a" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux02Click" } }, "mode" : "button", "path" : "/user/hand/right/input/b" } ] }, "/actions/scroll_discrete" : { "sources" : [ { "inputs" : { "scroll" : { "output" : "/actions/scroll_discrete/in/ScrollDiscrete" } }, "mode" : "scroll", "parameters" : { "discrete_scroll_trackpad_accumthreshold_onmove" : "0.224", "discrete_scroll_trackpad_accumthreshold_onreversal" : "0.672", "discrete_scroll_trackpad_accumthreshold_ontouch" : "0.624", "discrete_scroll_trackpad_noisethreshold_onmove" : "0.008", "discrete_scroll_trackpad_noisethreshold_onreversal" : "0.095", "discrete_scroll_trackpad_noisethreshold_ontouch" : "0.16", "discrete_scroll_trackpad_slideandhold_borderbottom" : "-0.60", "discrete_scroll_trackpad_slideandhold_bordertop" : "0.65", "scroll_mode" : "discrete" }, "path" : "/user/hand/left/input/trackpad" }, { "inputs" : { "scroll" : { "output" : "/actions/scroll_discrete/in/ScrollDiscrete" } }, "mode" : "scroll", "parameters" : { "discrete_scroll_trackpad_accumthreshold_onmove" : "0.224", "discrete_scroll_trackpad_accumthreshold_onreversal" : "0.672", "discrete_scroll_trackpad_accumthreshold_ontouch" : "0.624", "discrete_scroll_trackpad_noisethreshold_onmove" : "0.008", "discrete_scroll_trackpad_noisethreshold_onreversal" : "0.095", "discrete_scroll_trackpad_noisethreshold_ontouch" : "0.16", "discrete_scroll_trackpad_slideandhold_borderbottom" : "-0.60", "discrete_scroll_trackpad_slideandhold_bordertop" : "0.65", "scroll_mode" : "discrete" }, "path" : "/user/hand/right/input/trackpad" } ] }, "/actions/scroll_smooth" : { "sources" : [ { "inputs" : { "scroll" : { "output" : "/actions/scroll_smooth/in/ScrollSmooth" } }, "mode" : "scroll", "parameters" : { "scroll_mode" : "smooth" }, "path" : "/user/hand/left/input/trackpad" }, { "inputs" : { "scroll" : { "output" : "/actions/scroll_smooth/in/ScrollSmooth" } }, "mode" : "scroll", "parameters" : { "scroll_mode" : "smooth" }, "path" : "/user/hand/right/input/trackpad" } ] } }, "category" : "steamvr_input", "controller_type" : "knuckles_ev1", "description" : "", "name" : "Default Desktop+ bindings for Knuckles EV1 Controllers", "options" : {}, "simulated_actions" : [] } ================================================ FILE: assets/input/action_bindings_playstation_vr2_sense_controller.json ================================================ { "action_manifest_version" : 5, "alias_info" : {}, "app_key" : "steam.overlay.1494460", "bindings" : { "/actions/laserpointer" : { "haptics" : [ { "output" : "/actions/laserpointer/out/Haptic", "path" : "/user/hand/left/output/haptic" }, { "output" : "/actions/laserpointer/out/Haptic", "path" : "/user/hand/right/output/haptic" } ], "sources" : [ { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/LeftClick" } }, "mode" : "button", "parameters" : { "click_activate_threshold" : "0.65", "click_deactivate_threshold" : "0.6" }, "path" : "/user/hand/left/input/l2" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/LeftClick" } }, "mode" : "button", "parameters" : { "click_activate_threshold" : "0.65", "click_deactivate_threshold" : "0.6" }, "path" : "/user/hand/right/input/r2" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/RightClick" } }, "mode" : "button", "path" : "/user/hand/left/input/square" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/RightClick" } }, "mode" : "button", "path" : "/user/hand/right/input/cross" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux02Click" } }, "mode" : "button", "path" : "/user/hand/left/input/triangle" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux02Click" } }, "mode" : "button", "path" : "/user/hand/right/input/circle" } ] }, "/actions/scroll_discrete" : { "sources" : [ { "inputs" : { "scroll" : { "output" : "/actions/scroll_discrete/in/ScrollDiscrete" } }, "mode" : "scroll", "path" : "/user/hand/left/input/left_stick" }, { "inputs" : { "scroll" : { "output" : "/actions/scroll_discrete/in/ScrollDiscrete" } }, "mode" : "scroll", "path" : "/user/hand/right/input/right_stick" } ] }, "/actions/scroll_smooth" : { "sources" : [ { "inputs" : { "scroll" : { "output" : "/actions/scroll_smooth/in/ScrollSmooth" } }, "mode" : "scroll", "parameters" : { "scroll_mode" : "smooth" }, "path" : "/user/hand/left/input/left_stick" }, { "inputs" : { "scroll" : { "output" : "/actions/scroll_smooth/in/ScrollSmooth" } }, "mode" : "scroll", "parameters" : { "scroll_mode" : "smooth" }, "path" : "/user/hand/right/input/right_stick" } ] } }, "category" : "steamvr_input", "controller_type" : "playstation_vr2_sense", "description" : "", "name" : "Default Desktop+ bindings for PS VR2 Sense Controllers", "options" : {}, "simulated_actions" : [] } ================================================ FILE: assets/input/action_bindings_svl_hand_interaction_augmented.json ================================================ { "action_manifest_version" : 5, "alias_info" : {}, "app_key" : "steam.overlay.1494460", "bindings" : { "/actions/laserpointer" : { "sources" : [ { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/LeftClick" } }, "mode" : "button", "parameters" : { "click_activate_threshold" : "0.65", "click_deactivate_threshold" : "0.6" }, "path" : "/user/hand/right/input/trigger" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/LeftClick" } }, "mode" : "button", "parameters" : { "click_activate_threshold" : "0.65", "click_deactivate_threshold" : "0.6" }, "path" : "/user/hand/left/input/trigger" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/LeftClick" } }, "mode" : "button", "path" : "/user/hand/right/input/index_pinch" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/LeftClick" } }, "mode" : "button", "path" : "/user/hand/left/input/index_pinch" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/RightClick" } }, "mode" : "button", "path" : "/user/hand/left/input/pinky_pinch" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/RightClick" } }, "mode" : "button", "path" : "/user/hand/right/input/pinky_pinch" } ] } }, "category" : "steamvr_input", "controller_type": "svl_hand_interaction_augmented", "description": "", "name": "Default Desktop+ bindings for Steam Link Hand Tracking", "options" : {}, "simulated_actions" : [] } ================================================ FILE: assets/input/action_bindings_touch.json ================================================ { "action_manifest_version" : 5, "alias_info" : {}, "app_key" : "steam.overlay.1494460", "bindings" : { "/actions/laserpointer" : { "haptics" : [ { "output" : "/actions/laserpointer/out/Haptic", "path" : "/user/hand/left/output/haptic" }, { "output" : "/actions/laserpointer/out/Haptic", "path" : "/user/hand/right/output/haptic" } ], "sources" : [ { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/LeftClick" } }, "mode" : "button", "parameters" : { "click_activate_threshold" : "0.65", "click_deactivate_threshold" : "0.6" }, "path" : "/user/hand/right/input/trigger" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/LeftClick" } }, "mode" : "button", "parameters" : { "click_activate_threshold" : "0.65", "click_deactivate_threshold" : "0.6" }, "path" : "/user/hand/left/input/trigger" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/RightClick" } }, "mode" : "button", "path" : "/user/hand/left/input/x" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/RightClick" } }, "mode" : "button", "path" : "/user/hand/right/input/a" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/MiddleClick" } }, "mode" : "button", "path" : "/user/hand/left/input/grip" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/MiddleClick" } }, "mode" : "button", "path" : "/user/hand/right/input/grip" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux02Click" } }, "mode" : "button", "path" : "/user/hand/left/input/y" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux02Click" } }, "mode" : "button", "path" : "/user/hand/right/input/b" } ] }, "/actions/scroll_discrete" : { "sources" : [ { "inputs" : { "scroll" : { "output" : "/actions/scroll_discrete/in/ScrollDiscrete" } }, "mode" : "scroll", "path" : "/user/hand/left/input/joystick" }, { "inputs" : { "scroll" : { "output" : "/actions/scroll_discrete/in/ScrollDiscrete" } }, "mode" : "scroll", "path" : "/user/hand/right/input/joystick" } ] }, "/actions/scroll_smooth" : { "sources" : [ { "inputs" : { "scroll" : { "output" : "/actions/scroll_smooth/in/ScrollSmooth" } }, "mode" : "scroll", "parameters" : { "scroll_mode" : "smooth" }, "path" : "/user/hand/left/input/joystick" }, { "inputs" : { "scroll" : { "output" : "/actions/scroll_smooth/in/ScrollSmooth" } }, "mode" : "scroll", "parameters" : { "scroll_mode" : "smooth" }, "path" : "/user/hand/right/input/joystick" } ] } }, "category" : "steamvr_input", "controller_type" : "oculus_touch", "description" : "", "name" : "Default Desktop+ bindings for Oculus Touch", "options" : {}, "simulated_actions" : [] } ================================================ FILE: assets/input/action_bindings_vive_controller.json ================================================ { "action_manifest_version" : 5, "alias_info" : {}, "app_key" : "steam.overlay.1494460", "bindings" : { "/actions/laserpointer" : { "haptics" : [ { "output" : "/actions/laserpointer/out/Haptic", "path" : "/user/hand/left/output/haptic" }, { "output" : "/actions/laserpointer/out/Haptic", "path" : "/user/hand/right/output/haptic" } ], "sources" : [ { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/LeftClick" } }, "mode" : "button", "parameters" : { "click_activate_threshold" : "0.65", "click_deactivate_threshold" : "0.6" }, "path" : "/user/hand/right/input/trigger" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/LeftClick" } }, "mode" : "button", "parameters" : { "click_activate_threshold" : "0.65", "click_deactivate_threshold" : "0.6" }, "path" : "/user/hand/left/input/trigger" }, { "inputs" : { "east" : { "output" : "/actions/laserpointer/in/RightClick" } }, "mode" : "dpad_click", "path" : "/user/hand/left/input/trackpad" }, { "inputs" : { "east" : { "output" : "/actions/laserpointer/in/RightClick" } }, "mode" : "dpad_click", "path" : "/user/hand/right/input/trackpad" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux01Click" } }, "mode" : "button", "path" : "/user/hand/left/input/grip" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux01Click" } }, "mode" : "button", "path" : "/user/hand/right/input/grip" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux02Click" } }, "mode" : "button", "path" : "/user/hand/left/input/application_menu" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux02Click" } }, "mode" : "button", "path" : "/user/hand/right/input/application_menu" } ] }, "/actions/scroll_discrete" : { "sources" : [ { "inputs" : { "scroll" : { "output" : "/actions/scroll_discrete/in/ScrollDiscrete" } }, "mode" : "scroll", "parameters" : { "discrete_scroll_trackpad_accumthreshold_onmove" : "0.224", "discrete_scroll_trackpad_accumthreshold_onreversal" : "0.672", "discrete_scroll_trackpad_accumthreshold_ontouch" : "0.624", "discrete_scroll_trackpad_noisethreshold_onmove" : "0.008", "discrete_scroll_trackpad_noisethreshold_onreversal" : "0.095", "discrete_scroll_trackpad_noisethreshold_ontouch" : "0.16", "discrete_scroll_trackpad_slideandhold_borderbottom" : "-0.60", "discrete_scroll_trackpad_slideandhold_bordertop" : "0.65", "scroll_mode" : "discrete" }, "path" : "/user/hand/left/input/trackpad" }, { "inputs" : { "scroll" : { "output" : "/actions/scroll_discrete/in/ScrollDiscrete" } }, "mode" : "scroll", "parameters" : { "discrete_scroll_trackpad_accumthreshold_onmove" : "0.224", "discrete_scroll_trackpad_accumthreshold_onreversal" : "0.672", "discrete_scroll_trackpad_accumthreshold_ontouch" : "0.624", "discrete_scroll_trackpad_noisethreshold_onmove" : "0.008", "discrete_scroll_trackpad_noisethreshold_onreversal" : "0.095", "discrete_scroll_trackpad_noisethreshold_ontouch" : "0.16", "discrete_scroll_trackpad_slideandhold_borderbottom" : "-0.60", "discrete_scroll_trackpad_slideandhold_bordertop" : "0.65", "scroll_mode" : "discrete" }, "path" : "/user/hand/right/input/trackpad" } ] }, "/actions/scroll_smooth" : { "sources" : [ { "inputs" : { "scroll" : { "output" : "/actions/scroll_smooth/in/ScrollSmooth" } }, "mode" : "scroll", "parameters" : { "scroll_mode" : "smooth" }, "path" : "/user/hand/left/input/trackpad" }, { "inputs" : { "scroll" : { "output" : "/actions/scroll_smooth/in/ScrollSmooth" } }, "mode" : "scroll", "parameters" : { "scroll_mode" : "smooth" }, "path" : "/user/hand/right/input/trackpad" } ] } }, "category" : "steamvr_input", "controller_type" : "vive_controller", "description" : "", "name" : "Default Desktop+ bindings for Vive Controllers", "options" : {}, "simulated_actions" : [] } ================================================ FILE: assets/input/action_bindings_vive_cosmos.json ================================================ { "action_manifest_version" : 5, "alias_info" : {}, "app_key" : "steam.overlay.1494460", "bindings" : { "/actions/laserpointer" : { "haptics" : [ { "output" : "/actions/laserpointer/out/Haptic", "path" : "/user/hand/left/output/haptic" }, { "output" : "/actions/laserpointer/out/Haptic", "path" : "/user/hand/right/output/haptic" } ], "sources" : [ { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/LeftClick" } }, "mode" : "button", "parameters" : { "click_activate_threshold" : "0.65", "click_deactivate_threshold" : "0.6" }, "path" : "/user/hand/right/input/trigger" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/LeftClick" } }, "mode" : "button", "parameters" : { "click_activate_threshold" : "0.65", "click_deactivate_threshold" : "0.6" }, "path" : "/user/hand/left/input/trigger" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/RightClick" } }, "mode" : "button", "path" : "/user/hand/left/input/x" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/RightClick" } }, "mode" : "button", "path" : "/user/hand/right/input/a" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux02Click" } }, "mode" : "button", "path" : "/user/hand/left/input/y" }, { "inputs" : { "click" : { "output" : "/actions/laserpointer/in/Aux02Click" } }, "mode" : "button", "path" : "/user/hand/right/input/b" } ] }, "/actions/scroll_discrete" : { "sources" : [ { "inputs" : { "scroll" : { "output" : "/actions/scroll_discrete/in/ScrollDiscrete" } }, "mode" : "scroll", "path" : "/user/hand/left/input/joystick" }, { "inputs" : { "scroll" : { "output" : "/actions/scroll_discrete/in/ScrollDiscrete" } }, "mode" : "scroll", "path" : "/user/hand/right/input/joystick" } ] }, "/actions/scroll_smooth" : { "sources" : [ { "inputs" : { "scroll" : { "output" : "/actions/scroll_smooth/in/ScrollSmooth" } }, "mode" : "scroll", "parameters" : { "scroll_mode" : "smooth" }, "path" : "/user/hand/left/input/joystick" }, { "inputs" : { "scroll" : { "output" : "/actions/scroll_smooth/in/ScrollSmooth" } }, "mode" : "scroll", "parameters" : { "scroll_mode" : "smooth" }, "path" : "/user/hand/right/input/joystick" } ] } }, "category" : "steamvr_input", "controller_type" : "vive_cosmos_controller", "description" : "", "name" : "Default Desktop+ bindings for Vive Cosmos Controllers", "options" : {}, "simulated_actions" : [] } ================================================ FILE: assets/input/action_manifest_de.json ================================================ { "language_tag": "de_DE", "/actions/shortcuts" : "Globale Kürzel", "/actions/shortcuts/in/EnableGlobalLaserPointer" : "Aktiviere globalen Laser-Pointer", "/actions/shortcuts/in/GlobalShortcut01" : "Globales Kürzel #1 ausführen", "/actions/shortcuts/in/GlobalShortcut02" : "Globales Kürzel #2 ausführen", "/actions/shortcuts/in/GlobalShortcut03" : "Globales Kürzel #3 ausführen", "/actions/shortcuts/in/GlobalShortcut04" : "Globales Kürzel #4 ausführen", "/actions/shortcuts/in/GlobalShortcut05" : "Globales Kürzel #5 ausführen", "/actions/shortcuts/in/GlobalShortcut06" : "Globales Kürzel #6 ausführen", "/actions/shortcuts/in/GlobalShortcut07" : "Globales Kürzel #7 ausführen", "/actions/shortcuts/in/GlobalShortcut08" : "Globales Kürzel #8 ausführen", "/actions/shortcuts/in/GlobalShortcut09" : "Globales Kürzel #9 ausführen", "/actions/shortcuts/in/GlobalShortcut10" : "Globales Kürzel #10 ausführen", "/actions/shortcuts/in/GlobalShortcut11" : "Globales Kürzel #11 ausführen", "/actions/shortcuts/in/GlobalShortcut12" : "Globales Kürzel #12 ausführen", "/actions/shortcuts/in/GlobalShortcut13" : "Globales Kürzel #13 ausführen", "/actions/shortcuts/in/GlobalShortcut14" : "Globales Kürzel #14 ausführen", "/actions/shortcuts/in/GlobalShortcut15" : "Globales Kürzel #15 ausführen", "/actions/shortcuts/in/GlobalShortcut16" : "Globales Kürzel #16 ausführen", "/actions/shortcuts/in/GlobalShortcut17" : "Globales Kürzel #17 ausführen", "/actions/shortcuts/in/GlobalShortcut18" : "Globales Kürzel #18 ausführen", "/actions/shortcuts/in/GlobalShortcut19" : "Globales Kürzel #19 ausführen", "/actions/shortcuts/in/GlobalShortcut20" : "Globales Kürzel #20 ausführen", "/actions/laserpointer" : "Laserpointer", "/actions/laserpointer/in/LeftClick" : "Linksklick", "/actions/laserpointer/in/RightClick" : "Rechtsklick", "/actions/laserpointer/in/MiddleClick" : "Mittelklick", "/actions/laserpointer/in/Aux01Click" : "Extra 1-Klick", "/actions/laserpointer/in/Aux02Click" : "Extra 2-Klick", "/actions/laserpointer/in/Drag" : "Overlay ziehen", "/actions/scroll_discrete" : "Mausrad-Bildlauf", "/actions/scroll_discrete/in/ScrollDiscrete" : "Overlay scrollen", "/actions/scroll_smooth" : "Weicher Bildlauf", "/actions/scroll_smooth/in/ScrollSmooth" : "Overlay scrollen" } ================================================ FILE: assets/input/action_manifest_en.json ================================================ { "language_tag": "en_US", "/actions/shortcuts" : "Global Shortcuts", "/actions/shortcuts/in/EnableGlobalLaserPointer" : "Enable Global Laser Pointer", "/actions/shortcuts/in/GlobalShortcut01" : "Do Global Shortcut #1", "/actions/shortcuts/in/GlobalShortcut02" : "Do Global Shortcut #2", "/actions/shortcuts/in/GlobalShortcut03" : "Do Global Shortcut #3", "/actions/shortcuts/in/GlobalShortcut04" : "Do Global Shortcut #4", "/actions/shortcuts/in/GlobalShortcut05" : "Do Global Shortcut #5", "/actions/shortcuts/in/GlobalShortcut06" : "Do Global Shortcut #6", "/actions/shortcuts/in/GlobalShortcut07" : "Do Global Shortcut #7", "/actions/shortcuts/in/GlobalShortcut08" : "Do Global Shortcut #8", "/actions/shortcuts/in/GlobalShortcut09" : "Do Global Shortcut #9", "/actions/shortcuts/in/GlobalShortcut10" : "Do Global Shortcut #10", "/actions/shortcuts/in/GlobalShortcut11" : "Do Global Shortcut #11", "/actions/shortcuts/in/GlobalShortcut12" : "Do Global Shortcut #12", "/actions/shortcuts/in/GlobalShortcut13" : "Do Global Shortcut #13", "/actions/shortcuts/in/GlobalShortcut14" : "Do Global Shortcut #14", "/actions/shortcuts/in/GlobalShortcut15" : "Do Global Shortcut #15", "/actions/shortcuts/in/GlobalShortcut16" : "Do Global Shortcut #16", "/actions/shortcuts/in/GlobalShortcut17" : "Do Global Shortcut #17", "/actions/shortcuts/in/GlobalShortcut18" : "Do Global Shortcut #18", "/actions/shortcuts/in/GlobalShortcut19" : "Do Global Shortcut #19", "/actions/shortcuts/in/GlobalShortcut20" : "Do Global Shortcut #20", "/actions/laserpointer" : "Laser Pointer", "/actions/laserpointer/in/LeftClick" : "Left Click", "/actions/laserpointer/in/RightClick" : "Right Click", "/actions/laserpointer/in/MiddleClick" : "Middle Click", "/actions/laserpointer/in/Aux01Click" : "Auxiliary 1 Click", "/actions/laserpointer/in/Aux02Click" : "Auxiliary 2 Click", "/actions/laserpointer/in/Drag" : "Drag Overlay", "/actions/scroll_discrete" : "Mousewheel Scrolling", "/actions/scroll_discrete/in/ScrollDiscrete" : "Scroll Overlay", "/actions/scroll_smooth" : "Smooth Scrolling", "/actions/scroll_smooth/in/ScrollSmooth" : "Scroll Overlay" } ================================================ FILE: assets/input/action_manifest_ja.json ================================================ { "language_tag": "ja_JP", "/actions/shortcuts" : "グローバルショートカット", "/actions/shortcuts/in/EnableGlobalLaserPointer" : "グローバルレーザーポインターを有効化", "/actions/shortcuts/in/GlobalShortcut01" : "グローバルショートカットを実行 #1", "/actions/shortcuts/in/GlobalShortcut02" : "グローバルショートカットを実行 #2", "/actions/shortcuts/in/GlobalShortcut03" : "グローバルショートカットを実行 #3", "/actions/shortcuts/in/GlobalShortcut04" : "グローバルショートカットを実行 #4", "/actions/shortcuts/in/GlobalShortcut05" : "グローバルショートカットを実行 #5", "/actions/shortcuts/in/GlobalShortcut06" : "グローバルショートカットを実行 #6", "/actions/shortcuts/in/GlobalShortcut07" : "グローバルショートカットを実行 #7", "/actions/shortcuts/in/GlobalShortcut08" : "グローバルショートカットを実行 #8", "/actions/shortcuts/in/GlobalShortcut09" : "グローバルショートカットを実行 #9", "/actions/shortcuts/in/GlobalShortcut10" : "グローバルショートカットを実行 #10", "/actions/shortcuts/in/GlobalShortcut11" : "グローバルショートカットを実行 #11", "/actions/shortcuts/in/GlobalShortcut12" : "グローバルショートカットを実行 #12", "/actions/shortcuts/in/GlobalShortcut13" : "グローバルショートカットを実行 #13", "/actions/shortcuts/in/GlobalShortcut14" : "グローバルショートカットを実行 #14", "/actions/shortcuts/in/GlobalShortcut15" : "グローバルショートカットを実行 #15", "/actions/shortcuts/in/GlobalShortcut16" : "グローバルショートカットを実行 #16", "/actions/shortcuts/in/GlobalShortcut17" : "グローバルショートカットを実行 #17", "/actions/shortcuts/in/GlobalShortcut18" : "グローバルショートカットを実行 #18", "/actions/shortcuts/in/GlobalShortcut19" : "グローバルショートカットを実行 #19", "/actions/shortcuts/in/GlobalShortcut20" : "グローバルショートカットを実行 #20", "/actions/laserpointer" : "レーザーポインター", "/actions/laserpointer/in/LeftClick" : "左クリック", "/actions/laserpointer/in/RightClick" : "右クリック", "/actions/laserpointer/in/MiddleClick" : "ホイールクリック", "/actions/laserpointer/in/Aux01Click" : "補助 1 クリック", "/actions/laserpointer/in/Aux02Click" : "補助 2 クリック", "/actions/scroll_discrete" : "マウスホイール スクロール", "/actions/scroll_discrete/in/ScrollDiscrete" : "スクロールオーバーレイ", "/actions/scroll_smooth" : "スムーズ スクロール", "/actions/scroll_smooth/in/ScrollSmooth" : "スクロールオーバーレイ" } ================================================ FILE: assets/input/action_manifest_ko.json ================================================ { "language_tag": "ko_KR", "/actions/shortcuts" : "전역 단축키", "/actions/shortcuts/in/EnableGlobalLaserPointer" : "전역 레이저 포인터 활성화", "/actions/shortcuts/in/GlobalShortcut01" : "전역 단축키 실행 #1", "/actions/shortcuts/in/GlobalShortcut02" : "전역 단축키 실행 #2", "/actions/shortcuts/in/GlobalShortcut03" : "전역 단축키 실행 #3", "/actions/shortcuts/in/GlobalShortcut04" : "전역 단축키 실행 #4", "/actions/shortcuts/in/GlobalShortcut05" : "전역 단축키 실행 #5", "/actions/shortcuts/in/GlobalShortcut06" : "전역 단축키 실행 #6", "/actions/shortcuts/in/GlobalShortcut07" : "전역 단축키 실행 #7", "/actions/shortcuts/in/GlobalShortcut08" : "전역 단축키 실행 #8", "/actions/shortcuts/in/GlobalShortcut09" : "전역 단축키 실행 #9", "/actions/shortcuts/in/GlobalShortcut10" : "전역 단축키 실행 #10", "/actions/shortcuts/in/GlobalShortcut11" : "전역 단축키 실행 #11", "/actions/shortcuts/in/GlobalShortcut12" : "전역 단축키 실행 #12", "/actions/shortcuts/in/GlobalShortcut13" : "전역 단축키 실행 #13", "/actions/shortcuts/in/GlobalShortcut14" : "전역 단축키 실행 #14", "/actions/shortcuts/in/GlobalShortcut15" : "전역 단축키 실행 #15", "/actions/shortcuts/in/GlobalShortcut16" : "전역 단축키 실행 #16", "/actions/shortcuts/in/GlobalShortcut17" : "전역 단축키 실행 #17", "/actions/shortcuts/in/GlobalShortcut18" : "전역 단축키 실행 #18", "/actions/shortcuts/in/GlobalShortcut19" : "전역 단축키 실행 #19", "/actions/shortcuts/in/GlobalShortcut20" : "전역 단축키 실행 #20", "/actions/laserpointer" : "레이저 포인터", "/actions/laserpointer/in/LeftClick" : "왼쪽 클릭", "/actions/laserpointer/in/RightClick" : "오른쪽 클릭", "/actions/laserpointer/in/MiddleClick" : "휠 클릭", "/actions/laserpointer/in/Aux01Click" : "측면 1 클릭", "/actions/laserpointer/in/Aux02Click" : "측면 2 클릭", "/actions/laserpointer/in/Drag" : "오버레이 드래그", "/actions/scroll_discrete" : "마우스 휠 스크롤", "/actions/scroll_discrete/in/ScrollDiscrete" : "오버레이 스크롤", "/actions/scroll_smooth" : "부드러운 스크롤", "/actions/scroll_smooth/in/ScrollSmooth" : "오버레이 스크롤" } ================================================ FILE: assets/input/action_manifest_zh_CN.json ================================================ { "language_tag": "zh_CN", "/actions/shortcuts" : "全局快捷键", "/actions/shortcuts/in/EnableGlobalLaserPointer" : "启用全局激光指针", "/actions/shortcuts/in/GlobalShortcut01" : "执行全局快捷键 #1", "/actions/shortcuts/in/GlobalShortcut02" : "执行全局快捷键 #2", "/actions/shortcuts/in/GlobalShortcut03" : "执行全局快捷键 #3", "/actions/shortcuts/in/GlobalShortcut04" : "执行全局快捷键 #4", "/actions/shortcuts/in/GlobalShortcut05" : "执行全局快捷键 #5", "/actions/shortcuts/in/GlobalShortcut06" : "执行全局快捷键 #6", "/actions/shortcuts/in/GlobalShortcut07" : "执行全局快捷键 #7", "/actions/shortcuts/in/GlobalShortcut08" : "执行全局快捷键 #8", "/actions/shortcuts/in/GlobalShortcut09" : "执行全局快捷键 #9", "/actions/shortcuts/in/GlobalShortcut10" : "执行全局快捷键 #10", "/actions/shortcuts/in/GlobalShortcut11" : "执行全局快捷键 #11", "/actions/shortcuts/in/GlobalShortcut12" : "执行全局快捷键 #12", "/actions/shortcuts/in/GlobalShortcut13" : "执行全局快捷键 #13", "/actions/shortcuts/in/GlobalShortcut14" : "执行全局快捷键 #14", "/actions/shortcuts/in/GlobalShortcut15" : "执行全局快捷键 #15", "/actions/shortcuts/in/GlobalShortcut16" : "执行全局快捷键 #16", "/actions/shortcuts/in/GlobalShortcut17" : "执行全局快捷键 #17", "/actions/shortcuts/in/GlobalShortcut18" : "执行全局快捷键 #18", "/actions/shortcuts/in/GlobalShortcut19" : "执行全局快捷键 #19", "/actions/shortcuts/in/GlobalShortcut20" : "执行全局快捷键 #20", "/actions/laserpointer" : "激光指针", "/actions/laserpointer/in/LeftClick" : "左键点击", "/actions/laserpointer/in/RightClick" : "右键点击", "/actions/laserpointer/in/MiddleClick" : "中键点击", "/actions/laserpointer/in/Aux01Click" : "辅助1点击", "/actions/laserpointer/in/Aux02Click" : "辅助2点击", "/actions/laserpointer/in/Drag" : "拖动叠加", "/actions/scroll_discrete" : "鼠标滚轮滚动", "/actions/scroll_discrete/in/ScrollDiscrete" : "滚动叠加", "/actions/scroll_smooth" : "平滑滚动", "/actions/scroll_smooth/in/ScrollSmooth" : "滚动叠加" } ================================================ FILE: assets/keyboards/azerty_be.ini ================================================ [LayoutInfo] Name=AZERTY (Belgium) Author= HasAltGr=true HasClusterFunction=true HasClusterNavigation=true HasClusterNumpad=true HasClusterExtra=true [Key_Base_Row_0_ID_0] Type=VirtualKey Label=Esc Cluster=Function KeyCode=27 NoRepeat=true [Key_Base_Row_0_ID_1] Type=Blank Cluster=Function [Key_Base_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_Base_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_Base_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_Base_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_Base_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_Base_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_Base_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_Base_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_Base_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_Base_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_Base_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_Base_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_Base_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_Base_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_Base_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_Base_Row_0_ID_17] Type=VirtualKey Label=Print\nScreen Cluster=Function KeyCode=44 NoRepeat=true [Key_Base_Row_0_ID_18] Type=VirtualKey Label=Scroll\nLock Cluster=Function KeyCode=145 NoRepeat=true [Key_Base_Row_0_ID_19] Type=VirtualKey Label=Pause Cluster=Function KeyCode=19 NoRepeat=true [Key_Base_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_Base_Row_0_ID_21] Type=VirtualKey Label=⏯ Cluster=Extra KeyCode=179 NoRepeat=true [Key_Base_Row_0_ID_22] Type=VirtualKey Label=◼ Cluster=Extra KeyCode=178 NoRepeat=true [Key_Base_Row_0_ID_23] Type=VirtualKey Label=⏮ Cluster=Extra KeyCode=177 NoRepeat=true [Key_Base_Row_0_ID_24] Type=VirtualKey Label=⏭ Cluster=Extra KeyCode=176 NoRepeat=true [Key_Base_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_Base_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra [Key_Base_Row_2_ID_0] Type=String Label=² String=² [Key_Base_Row_2_ID_1] Type=String Label=& String=& [Key_Base_Row_2_ID_2] Type=String Label=é String=é [Key_Base_Row_2_ID_3] Type=String Label=" String=" [Key_Base_Row_2_ID_4] Type=String Label=' String=' [Key_Base_Row_2_ID_5] Type=String Label=( String=( [Key_Base_Row_2_ID_6] Type=String Label=§ String=§ [Key_Base_Row_2_ID_7] Type=String Label=è String=è [Key_Base_Row_2_ID_8] Type=String Label=! String=! [Key_Base_Row_2_ID_9] Type=String Label=ç String=ç [Key_Base_Row_2_ID_10] Type=String Label=à String=à [Key_Base_Row_2_ID_11] Type=String Label=) String=) [Key_Base_Row_2_ID_12] Type=String Label=- String=- [Key_Base_Row_2_ID_13] Type=VirtualKey Width=200 Label=⟵ KeyCode=8 [Key_Base_Row_2_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_2_ID_15] Type=VirtualKey Label=Insert Cluster=Navigation KeyCode=45 [Key_Base_Row_2_ID_16] Type=VirtualKey Label=Home Cluster=Navigation KeyCode=36 [Key_Base_Row_2_ID_17] Type=VirtualKey Label=PgUp Cluster=Navigation KeyCode=33 [Key_Base_Row_2_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_2_ID_19] Type=VirtualKey Label=Num\nLock Cluster=Numpad KeyCode=144 NoRepeat=true [Key_Base_Row_2_ID_20] Type=VirtualKey Label=/ Cluster=Numpad KeyCode=111 [Key_Base_Row_2_ID_21] Type=VirtualKey Label=* Cluster=Numpad KeyCode=106 [Key_Base_Row_2_ID_22] Type=VirtualKey Label=- Cluster=Numpad KeyCode=109 [Key_Base_Row_3_ID_0] Type=VirtualKey Width=150 Label=⭾ KeyCode=9 [Key_Base_Row_3_ID_1] Type=VirtualKey Label=a KeyCode=65 [Key_Base_Row_3_ID_2] Type=VirtualKey Label=z KeyCode=90 [Key_Base_Row_3_ID_3] Type=VirtualKey Label=e KeyCode=69 [Key_Base_Row_3_ID_4] Type=VirtualKey Label=r KeyCode=82 [Key_Base_Row_3_ID_5] Type=VirtualKey Label=t KeyCode=84 [Key_Base_Row_3_ID_6] Type=VirtualKey Label=y KeyCode=89 [Key_Base_Row_3_ID_7] Type=VirtualKey Label=u KeyCode=85 [Key_Base_Row_3_ID_8] Type=VirtualKey Label=i KeyCode=73 [Key_Base_Row_3_ID_9] Type=VirtualKey Label=o KeyCode=79 [Key_Base_Row_3_ID_10] Type=VirtualKey Label=p KeyCode=80 [Key_Base_Row_3_ID_11] Type=String Label=^ String=^ [Key_Base_Row_3_ID_12] Type=String Label=$ String=$ [Key_Base_Row_3_ID_13] Type=VirtualKeyIsoEnter Width=150 Label= KeyCode=13 [Key_Base_Row_3_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_3_ID_15] Type=VirtualKey Label=Delete Cluster=Navigation KeyCode=46 [Key_Base_Row_3_ID_16] Type=VirtualKey Label=End Cluster=Navigation KeyCode=35 [Key_Base_Row_3_ID_17] Type=VirtualKey Label=PgDn Cluster=Navigation KeyCode=34 [Key_Base_Row_3_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_3_ID_19] Type=VirtualKey Label=7 Cluster=Numpad KeyCode=103 [Key_Base_Row_3_ID_20] Type=VirtualKey Label=8 Cluster=Numpad KeyCode=104 [Key_Base_Row_3_ID_21] Type=VirtualKey Label=9 Cluster=Numpad KeyCode=105 [Key_Base_Row_3_ID_22] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 [Key_Base_Row_4_ID_0] Type=VirtualKey Width=175 Label=🡇 KeyCode=20 NoRepeat=true [Key_Base_Row_4_ID_1] Type=VirtualKey Label=q KeyCode=81 [Key_Base_Row_4_ID_2] Type=VirtualKey Label=s KeyCode=83 [Key_Base_Row_4_ID_3] Type=VirtualKey Label=d KeyCode=68 [Key_Base_Row_4_ID_4] Type=VirtualKey Label=f KeyCode=70 [Key_Base_Row_4_ID_5] Type=VirtualKey Label=g KeyCode=71 [Key_Base_Row_4_ID_6] Type=VirtualKey Label=h KeyCode=72 [Key_Base_Row_4_ID_7] Type=VirtualKey Label=j KeyCode=74 [Key_Base_Row_4_ID_8] Type=VirtualKey Label=k KeyCode=75 [Key_Base_Row_4_ID_9] Type=VirtualKey Label=l KeyCode=76 [Key_Base_Row_4_ID_10] Type=VirtualKey Label=m KeyCode=77 [Key_Base_Row_4_ID_11] Type=String Label=ù String=ù [Key_Base_Row_4_ID_12] Type=String Label=µ String=µ [Key_Base_Row_4_ID_13] Type=VirtualKeyIsoEnter Width=125 Label=↵ KeyCode=13 [Key_Base_Row_4_ID_14] Type=Blank Width=325 Cluster=Navigation [Key_Base_Row_4_ID_15] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_4_ID_16] Type=VirtualKey Label=4 Cluster=Numpad KeyCode=100 [Key_Base_Row_4_ID_17] Type=VirtualKey Label=5 Cluster=Numpad KeyCode=101 [Key_Base_Row_4_ID_18] Type=VirtualKey Label=6 Cluster=Numpad KeyCode=102 [Key_Base_Row_5_ID_0] Type=VirtualKeyToggle Width=125 Label=🡅 KeyCode=160 NoRepeat=true [Key_Base_Row_5_ID_1] Type=String Label=< String=< [Key_Base_Row_5_ID_2] Type=VirtualKey Label=w KeyCode=87 [Key_Base_Row_5_ID_3] Type=VirtualKey Label=x KeyCode=88 [Key_Base_Row_5_ID_4] Type=VirtualKey Label=c KeyCode=67 [Key_Base_Row_5_ID_5] Type=VirtualKey Label=v KeyCode=86 [Key_Base_Row_5_ID_6] Type=VirtualKey Label=b KeyCode=66 [Key_Base_Row_5_ID_7] Type=VirtualKey Label=n KeyCode=78 [Key_Base_Row_5_ID_8] Type=String Label=, String=, [Key_Base_Row_5_ID_9] Type=String Label=; String=; [Key_Base_Row_5_ID_10] Type=String Label=: String=: [Key_Base_Row_5_ID_11] Type=String Label== String== [Key_Base_Row_5_ID_12] Type=VirtualKeyToggle Width=275 Label=🡅 KeyCode=161 NoRepeat=true [Key_Base_Row_5_ID_13] Type=Blank Width=125 Cluster=Navigation [Key_Base_Row_5_ID_14] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_Base_Row_5_ID_15] Type=Blank Cluster=Navigation [Key_Base_Row_5_ID_16] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_5_ID_17] Type=VirtualKey Label=1 Cluster=Numpad KeyCode=97 [Key_Base_Row_5_ID_18] Type=VirtualKey Label=2 Cluster=Numpad KeyCode=98 [Key_Base_Row_5_ID_19] Type=VirtualKey Label=3 Cluster=Numpad KeyCode=99 [Key_Base_Row_5_ID_20] Type=VirtualKey Height=200 Label=Enter Cluster=Numpad KeyCode=13 [Key_Base_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=162 NoRepeat=true [Key_Base_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_Base_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_Base_Row_6_ID_3] Type=VirtualKey Width=625 Label= KeyCode=32 [Key_Base_Row_6_ID_4] Type=VirtualKeyToggle Width=125 Label=AltGr KeyCode=165 NoRepeat=true [Key_Base_Row_6_ID_5] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_Base_Row_6_ID_6] Type=VirtualKey Width=125 Label=Menu KeyCode=93 NoRepeat=true [Key_Base_Row_6_ID_7] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=163 NoRepeat=true [Key_Base_Row_6_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_6_ID_9] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_Base_Row_6_ID_10] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_Base_Row_6_ID_11] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_Base_Row_6_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_6_ID_13] Type=VirtualKey Width=200 Label=0 Cluster=Numpad KeyCode=96 [Key_Base_Row_6_ID_14] Type=VirtualKey Label=. Cluster=Numpad KeyCode=110 [Key_Shift_Row_0_ID_0] Type=VirtualKey Label=Esc Cluster=Function KeyCode=27 NoRepeat=true [Key_Shift_Row_0_ID_1] Type=Blank Cluster=Function [Key_Shift_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_Shift_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_Shift_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_Shift_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_Shift_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_Shift_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_Shift_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_Shift_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_Shift_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_Shift_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_Shift_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_Shift_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_Shift_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_Shift_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_Shift_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_Shift_Row_0_ID_17] Type=VirtualKey Label=Print\nScreen Cluster=Function KeyCode=44 NoRepeat=true [Key_Shift_Row_0_ID_18] Type=VirtualKey Label=Scroll\nLock Cluster=Function KeyCode=145 NoRepeat=true [Key_Shift_Row_0_ID_19] Type=VirtualKey Label=Pause Cluster=Function KeyCode=19 NoRepeat=true [Key_Shift_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_Shift_Row_0_ID_21] Type=VirtualKey Label=🡰 Cluster=Extra KeyCode=166 NoRepeat=true [Key_Shift_Row_0_ID_22] Type=VirtualKey Label=🡲 Cluster=Extra KeyCode=167 NoRepeat=true [Key_Shift_Row_0_ID_23] Type=VirtualKey Label=🔇 Cluster=Extra KeyCode=173 NoRepeat=true [Key_Shift_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_Shift_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra [Key_Shift_Row_2_ID_0] Type=String Label=³ String=³ NoRepeat=true [Key_Shift_Row_2_ID_1] Type=VirtualKey Label=1 KeyCode=49 [Key_Shift_Row_2_ID_2] Type=VirtualKey Label=2 KeyCode=50 [Key_Shift_Row_2_ID_3] Type=VirtualKey Label=3 KeyCode=51 [Key_Shift_Row_2_ID_4] Type=VirtualKey Label=4 KeyCode=52 [Key_Shift_Row_2_ID_5] Type=VirtualKey Label=5 KeyCode=53 [Key_Shift_Row_2_ID_6] Type=VirtualKey Label=6 KeyCode=54 [Key_Shift_Row_2_ID_7] Type=VirtualKey Label=7 KeyCode=55 [Key_Shift_Row_2_ID_8] Type=VirtualKey Label=8 KeyCode=56 [Key_Shift_Row_2_ID_9] Type=VirtualKey Label=9 KeyCode=57 [Key_Shift_Row_2_ID_10] Type=VirtualKey Label=0 KeyCode=48 [Key_Shift_Row_2_ID_11] Type=String Label=° String=° [Key_Shift_Row_2_ID_12] Type=String Label=_ String=_ [Key_Shift_Row_2_ID_13] Type=VirtualKey Width=200 Label=⟵ KeyCode=8 [Key_Shift_Row_2_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_2_ID_15] Type=VirtualKey Label=Insert Cluster=Navigation KeyCode=45 [Key_Shift_Row_2_ID_16] Type=VirtualKey Label=Home Cluster=Navigation KeyCode=36 [Key_Shift_Row_2_ID_17] Type=VirtualKey Label=PgUp Cluster=Navigation KeyCode=33 [Key_Shift_Row_2_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_2_ID_19] Type=VirtualKey Label=Num\nLock Cluster=Numpad KeyCode=144 NoRepeat=true [Key_Shift_Row_2_ID_20] Type=VirtualKey Label=/ Cluster=Numpad KeyCode=111 [Key_Shift_Row_2_ID_21] Type=VirtualKey Label=* Cluster=Numpad KeyCode=106 [Key_Shift_Row_2_ID_22] Type=VirtualKey Label=- Cluster=Numpad KeyCode=109 [Key_Shift_Row_3_ID_0] Type=VirtualKey Width=150 Label=⭾ KeyCode=9 [Key_Shift_Row_3_ID_1] Type=VirtualKey Label=A KeyCode=65 [Key_Shift_Row_3_ID_2] Type=VirtualKey Label=Z KeyCode=90 [Key_Shift_Row_3_ID_3] Type=VirtualKey Label=E KeyCode=69 [Key_Shift_Row_3_ID_4] Type=VirtualKey Label=R KeyCode=82 [Key_Shift_Row_3_ID_5] Type=VirtualKey Label=T KeyCode=84 [Key_Shift_Row_3_ID_6] Type=VirtualKey Label=Y KeyCode=89 [Key_Shift_Row_3_ID_7] Type=VirtualKey Label=U KeyCode=85 [Key_Shift_Row_3_ID_8] Type=VirtualKey Label=I KeyCode=73 [Key_Shift_Row_3_ID_9] Type=VirtualKey Label=O KeyCode=79 [Key_Shift_Row_3_ID_10] Type=VirtualKey Label=P KeyCode=80 [Key_Shift_Row_3_ID_11] Type=String Label=¨ String=¨ [Key_Shift_Row_3_ID_12] Type=String Label=* String=* [Key_Shift_Row_3_ID_13] Type=VirtualKeyIsoEnter Width=150 Label= KeyCode=13 [Key_Shift_Row_3_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_3_ID_15] Type=VirtualKey Label=Delete Cluster=Navigation KeyCode=46 [Key_Shift_Row_3_ID_16] Type=VirtualKey Label=End Cluster=Navigation KeyCode=35 [Key_Shift_Row_3_ID_17] Type=VirtualKey Label=PgDn Cluster=Navigation KeyCode=34 [Key_Shift_Row_3_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_3_ID_19] Type=VirtualKey Label=7 Cluster=Numpad KeyCode=103 [Key_Shift_Row_3_ID_20] Type=VirtualKey Label=8 Cluster=Numpad KeyCode=104 [Key_Shift_Row_3_ID_21] Type=VirtualKey Label=9 Cluster=Numpad KeyCode=105 [Key_Shift_Row_3_ID_22] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 [Key_Shift_Row_4_ID_0] Type=VirtualKey Width=175 Label=🡇 KeyCode=20 NoRepeat=true [Key_Shift_Row_4_ID_1] Type=VirtualKey Label=Q KeyCode=81 [Key_Shift_Row_4_ID_2] Type=VirtualKey Label=S KeyCode=83 [Key_Shift_Row_4_ID_3] Type=VirtualKey Label=D KeyCode=68 [Key_Shift_Row_4_ID_4] Type=VirtualKey Label=F KeyCode=70 [Key_Shift_Row_4_ID_5] Type=VirtualKey Label=G KeyCode=71 [Key_Shift_Row_4_ID_6] Type=VirtualKey Label=H KeyCode=72 [Key_Shift_Row_4_ID_7] Type=VirtualKey Label=J KeyCode=74 [Key_Shift_Row_4_ID_8] Type=VirtualKey Label=K KeyCode=75 [Key_Shift_Row_4_ID_9] Type=VirtualKey Label=L KeyCode=76 [Key_Shift_Row_4_ID_10] Type=VirtualKey Label=M KeyCode=77 [Key_Shift_Row_4_ID_11] Type=String Label=% String=% [Key_Shift_Row_4_ID_12] Type=String Label=£ String=£ [Key_Shift_Row_4_ID_13] Type=VirtualKeyIsoEnter Width=125 Label=↵ KeyCode=13 [Key_Shift_Row_4_ID_14] Type=Blank Width=325 Cluster=Navigation [Key_Shift_Row_4_ID_15] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_4_ID_16] Type=VirtualKey Label=4 Cluster=Numpad KeyCode=100 [Key_Shift_Row_4_ID_17] Type=VirtualKey Label=5 Cluster=Numpad KeyCode=101 [Key_Shift_Row_4_ID_18] Type=VirtualKey Label=6 Cluster=Numpad KeyCode=102 [Key_Shift_Row_5_ID_0] Type=VirtualKeyToggle Width=125 Label=🡅 KeyCode=160 NoRepeat=true [Key_Shift_Row_5_ID_1] Type=String Label=> String=> [Key_Shift_Row_5_ID_2] Type=VirtualKey Label=W KeyCode=87 [Key_Shift_Row_5_ID_3] Type=VirtualKey Label=X KeyCode=88 [Key_Shift_Row_5_ID_4] Type=VirtualKey Label=C KeyCode=67 [Key_Shift_Row_5_ID_5] Type=VirtualKey Label=V KeyCode=86 [Key_Shift_Row_5_ID_6] Type=VirtualKey Label=B KeyCode=66 [Key_Shift_Row_5_ID_7] Type=VirtualKey Label=N KeyCode=78 [Key_Shift_Row_5_ID_8] Type=String Label=? String=? [Key_Shift_Row_5_ID_9] Type=String Label=. String=. [Key_Shift_Row_5_ID_10] Type=String Label=/ String=/ [Key_Shift_Row_5_ID_11] Type=String Label=+ String=+ [Key_Shift_Row_5_ID_12] Type=VirtualKeyToggle Width=275 Label=🡅 KeyCode=161 NoRepeat=true [Key_Shift_Row_5_ID_13] Type=Blank Width=125 Cluster=Navigation [Key_Shift_Row_5_ID_14] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_Shift_Row_5_ID_15] Type=Blank Cluster=Navigation [Key_Shift_Row_5_ID_16] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_5_ID_17] Type=VirtualKey Label=1 Cluster=Numpad KeyCode=97 [Key_Shift_Row_5_ID_18] Type=VirtualKey Label=2 Cluster=Numpad KeyCode=98 [Key_Shift_Row_5_ID_19] Type=VirtualKey Label=3 Cluster=Numpad KeyCode=99 [Key_Shift_Row_5_ID_20] Type=VirtualKey Height=200 Label=Enter Cluster=Numpad KeyCode=13 [Key_Shift_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=162 NoRepeat=true [Key_Shift_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_Shift_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_Shift_Row_6_ID_3] Type=VirtualKey Width=625 Label= KeyCode=32 [Key_Shift_Row_6_ID_4] Type=VirtualKeyToggle Width=125 Label=AltGr KeyCode=165 NoRepeat=true [Key_Shift_Row_6_ID_5] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_Shift_Row_6_ID_6] Type=VirtualKey Width=125 Label=Menu KeyCode=93 NoRepeat=true [Key_Shift_Row_6_ID_7] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=163 NoRepeat=true [Key_Shift_Row_6_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_6_ID_9] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_Shift_Row_6_ID_10] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_Shift_Row_6_ID_11] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_Shift_Row_6_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_6_ID_13] Type=VirtualKey Width=200 Label=0 Cluster=Numpad KeyCode=96 [Key_Shift_Row_6_ID_14] Type=VirtualKey Label=. Cluster=Numpad KeyCode=110 [Key_AltGr_Row_0_ID_0] Type=VirtualKey Label=Esc Cluster=Function KeyCode=27 NoRepeat=true [Key_AltGr_Row_0_ID_1] Type=Blank Cluster=Function [Key_AltGr_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_AltGr_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_AltGr_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_AltGr_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_AltGr_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_AltGr_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_AltGr_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_AltGr_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_AltGr_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_AltGr_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_AltGr_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_AltGr_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_AltGr_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_AltGr_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_AltGr_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_AltGr_Row_0_ID_17] Type=VirtualKey Label=Print\nScreen Cluster=Function KeyCode=44 NoRepeat=true [Key_AltGr_Row_0_ID_18] Type=VirtualKey Label=Scroll\nLock Cluster=Function KeyCode=145 NoRepeat=true [Key_AltGr_Row_0_ID_19] Type=VirtualKey Label=Pause Cluster=Function KeyCode=19 NoRepeat=true [Key_AltGr_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_AltGr_Row_0_ID_21] Type=VirtualKey Label=⏯ Cluster=Extra KeyCode=179 NoRepeat=true [Key_AltGr_Row_0_ID_22] Type=VirtualKey Label=◼ Cluster=Extra KeyCode=178 NoRepeat=true [Key_AltGr_Row_0_ID_23] Type=VirtualKey Label=⏮ Cluster=Extra KeyCode=177 NoRepeat=true [Key_AltGr_Row_0_ID_24] Type=VirtualKey Label=⏭ Cluster=Extra KeyCode=176 NoRepeat=true [Key_AltGr_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_AltGr_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra [Key_AltGr_Row_2_ID_0] Type=Blank [Key_AltGr_Row_2_ID_1] Type=String Label=| String=| [Key_AltGr_Row_2_ID_2] Type=String Label=@ String=@ [Key_AltGr_Row_2_ID_3] Type=String Label=# String=# [Key_AltGr_Row_2_ID_4] Type=Blank Width=200 [Key_AltGr_Row_2_ID_5] Type=String Label=^ String=^ [Key_AltGr_Row_2_ID_6] Type=Blank Width=200 [Key_AltGr_Row_2_ID_7] Type=String Label={ String={ [Key_AltGr_Row_2_ID_8] Type=String Label=} String=} [Key_AltGr_Row_2_ID_9] Type=Blank Width=200 [Key_AltGr_Row_2_ID_10] Type=VirtualKey Width=200 Label=⟵ KeyCode=8 [Key_AltGr_Row_2_ID_11] Type=Blank Width=25 Cluster=Navigation [Key_AltGr_Row_2_ID_12] Type=VirtualKey Label=Insert Cluster=Navigation KeyCode=45 [Key_AltGr_Row_2_ID_13] Type=VirtualKey Label=Home Cluster=Navigation KeyCode=36 [Key_AltGr_Row_2_ID_14] Type=VirtualKey Label=PgUp Cluster=Navigation KeyCode=33 [Key_AltGr_Row_2_ID_15] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_2_ID_16] Type=VirtualKey Label=Num\nLock Cluster=Numpad KeyCode=144 NoRepeat=true [Key_AltGr_Row_2_ID_17] Type=VirtualKey Label=/ Cluster=Numpad KeyCode=111 [Key_AltGr_Row_2_ID_18] Type=VirtualKey Label=* Cluster=Numpad KeyCode=106 [Key_AltGr_Row_2_ID_19] Type=VirtualKey Label=- Cluster=Numpad KeyCode=109 [Key_AltGr_Row_3_ID_0] Type=VirtualKey Width=150 Label=⭾ KeyCode=9 [Key_AltGr_Row_3_ID_1] Type=Blank Width=200 [Key_AltGr_Row_3_ID_2] Type=String Label=€ String=€ [Key_AltGr_Row_3_ID_3] Type=Blank Width=700 [Key_AltGr_Row_3_ID_4] Type=String Label=[ String=[ [Key_AltGr_Row_3_ID_5] Type=String Label=] String=] [Key_AltGr_Row_3_ID_6] Type=VirtualKeyIsoEnter Width=150 Label= KeyCode=13 [Key_AltGr_Row_3_ID_7] Type=Blank Width=25 Cluster=Navigation [Key_AltGr_Row_3_ID_8] Type=VirtualKey Label=Delete Cluster=Navigation KeyCode=46 [Key_AltGr_Row_3_ID_9] Type=VirtualKey Label=End Cluster=Navigation KeyCode=35 [Key_AltGr_Row_3_ID_10] Type=VirtualKey Label=PgDn Cluster=Navigation KeyCode=34 [Key_AltGr_Row_3_ID_11] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_3_ID_12] Type=VirtualKey Label=7 Cluster=Numpad KeyCode=103 [Key_AltGr_Row_3_ID_13] Type=VirtualKey Label=8 Cluster=Numpad KeyCode=104 [Key_AltGr_Row_3_ID_14] Type=VirtualKey Label=9 Cluster=Numpad KeyCode=105 [Key_AltGr_Row_3_ID_15] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 [Key_AltGr_Row_4_ID_0] Type=VirtualKey Width=175 Label=🡇 KeyCode=20 NoRepeat=true [Key_AltGr_Row_4_ID_1] Type=Blank Width=1000 [Key_AltGr_Row_4_ID_2] Type=String Label=´ String=´ [Key_AltGr_Row_4_ID_3] Type=String Label=` String=` [Key_AltGr_Row_4_ID_4] Type=VirtualKeyIsoEnter Width=125 Label=↵ KeyCode=13 [Key_AltGr_Row_4_ID_5] Type=Blank Width=325 Cluster=Navigation [Key_AltGr_Row_4_ID_6] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_4_ID_7] Type=VirtualKey Label=4 Cluster=Numpad KeyCode=100 [Key_AltGr_Row_4_ID_8] Type=VirtualKey Label=5 Cluster=Numpad KeyCode=101 [Key_AltGr_Row_4_ID_9] Type=VirtualKey Label=6 Cluster=Numpad KeyCode=102 [Key_AltGr_Row_5_ID_0] Type=VirtualKeyToggle Width=125 Label=🡅 KeyCode=160 NoRepeat=true [Key_AltGr_Row_5_ID_1] Type=String Label=\ String=\ [Key_AltGr_Row_5_ID_2] Type=Blank Width=900 [Key_AltGr_Row_5_ID_3] Type=String Label=~ String=~ [Key_AltGr_Row_5_ID_4] Type=VirtualKeyToggle Width=275 Label=🡅 KeyCode=161 NoRepeat=true [Key_AltGr_Row_5_ID_5] Type=Blank Width=125 Cluster=Navigation [Key_AltGr_Row_5_ID_6] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_AltGr_Row_5_ID_7] Type=Blank Cluster=Navigation [Key_AltGr_Row_5_ID_8] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_5_ID_9] Type=VirtualKey Label=1 Cluster=Numpad KeyCode=97 [Key_AltGr_Row_5_ID_10] Type=VirtualKey Label=2 Cluster=Numpad KeyCode=98 [Key_AltGr_Row_5_ID_11] Type=VirtualKey Label=3 Cluster=Numpad KeyCode=99 [Key_AltGr_Row_5_ID_12] Type=VirtualKey Height=200 Label=Enter Cluster=Numpad KeyCode=13 [Key_AltGr_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=162 NoRepeat=true [Key_AltGr_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_AltGr_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_AltGr_Row_6_ID_3] Type=VirtualKey Width=625 Label= KeyCode=32 [Key_AltGr_Row_6_ID_4] Type=VirtualKeyToggle Width=125 Label=AltGr KeyCode=165 NoRepeat=true [Key_AltGr_Row_6_ID_5] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_AltGr_Row_6_ID_6] Type=VirtualKey Width=125 Label=Menu KeyCode=93 NoRepeat=true [Key_AltGr_Row_6_ID_7] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=163 NoRepeat=true [Key_AltGr_Row_6_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_AltGr_Row_6_ID_9] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_AltGr_Row_6_ID_10] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_AltGr_Row_6_ID_11] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_AltGr_Row_6_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_6_ID_13] Type=VirtualKey Width=200 Label=0 Cluster=Numpad KeyCode=96 [Key_AltGr_Row_6_ID_14] Type=VirtualKey Label=. Cluster=Numpad KeyCode=110 ================================================ FILE: assets/keyboards/azerty_fr.ini ================================================ [LayoutInfo] Name=AZERTY (France) Author= HasAltGr=true HasClusterFunction=true HasClusterNavigation=true HasClusterNumpad=true HasClusterExtra=true [Key_Base_Row_0_ID_0] Type=VirtualKey Label=Échap Cluster=Function KeyCode=27 NoRepeat=true [Key_Base_Row_0_ID_1] Type=Blank Cluster=Function [Key_Base_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_Base_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_Base_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_Base_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_Base_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_Base_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_Base_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_Base_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_Base_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_Base_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_Base_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_Base_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_Base_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_Base_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_Base_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_Base_Row_0_ID_17] Type=VirtualKey Label=Impr Cluster=Function KeyCode=44 NoRepeat=true [Key_Base_Row_0_ID_18] Type=VirtualKey Label=Défil Cluster=Function KeyCode=145 NoRepeat=true [Key_Base_Row_0_ID_19] Type=VirtualKey Label=Pause Cluster=Function KeyCode=19 NoRepeat=true [Key_Base_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_Base_Row_0_ID_21] Type=VirtualKey Label=⏯ Cluster=Extra KeyCode=179 NoRepeat=true [Key_Base_Row_0_ID_22] Type=VirtualKey Label=◼ Cluster=Extra KeyCode=178 NoRepeat=true [Key_Base_Row_0_ID_23] Type=VirtualKey Label=⏮ Cluster=Extra KeyCode=177 NoRepeat=true [Key_Base_Row_0_ID_24] Type=VirtualKey Label=⏭ Cluster=Extra KeyCode=176 NoRepeat=true [Key_Base_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_Base_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra [Key_Base_Row_2_ID_0] Type=String Label=² String=² [Key_Base_Row_2_ID_1] Type=String Label=& String=& [Key_Base_Row_2_ID_2] Type=String Label=é String=é [Key_Base_Row_2_ID_3] Type=String Label=" String=" [Key_Base_Row_2_ID_4] Type=String Label=' String=' [Key_Base_Row_2_ID_5] Type=String Label=( String=( [Key_Base_Row_2_ID_6] Type=String Label=- String=- [Key_Base_Row_2_ID_7] Type=String Label=è String=è [Key_Base_Row_2_ID_8] Type=String Label=_ String=_ [Key_Base_Row_2_ID_9] Type=String Label=ç String=ç [Key_Base_Row_2_ID_10] Type=String Label=à String=à [Key_Base_Row_2_ID_11] Type=String Label=) String=) [Key_Base_Row_2_ID_12] Type=String Label== String== [Key_Base_Row_2_ID_13] Type=VirtualKey Width=200 Label=⟵ KeyCode=8 [Key_Base_Row_2_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_2_ID_15] Type=VirtualKey Label=Inser Cluster=Navigation KeyCode=45 [Key_Base_Row_2_ID_16] Type=VirtualKey Label=Début Cluster=Navigation KeyCode=36 [Key_Base_Row_2_ID_17] Type=VirtualKey Label=Page🠹 Cluster=Navigation KeyCode=33 [Key_Base_Row_2_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_2_ID_19] Type=VirtualKey Label=Verr\nNum Cluster=Numpad KeyCode=144 NoRepeat=true [Key_Base_Row_2_ID_20] Type=VirtualKey Label=/ Cluster=Numpad KeyCode=111 [Key_Base_Row_2_ID_21] Type=VirtualKey Label=* Cluster=Numpad KeyCode=106 [Key_Base_Row_2_ID_22] Type=VirtualKey Label=- Cluster=Numpad KeyCode=109 [Key_Base_Row_3_ID_0] Type=VirtualKey Width=150 Label=⭾ KeyCode=9 [Key_Base_Row_3_ID_1] Type=VirtualKey Label=a KeyCode=65 [Key_Base_Row_3_ID_2] Type=VirtualKey Label=z KeyCode=90 [Key_Base_Row_3_ID_3] Type=VirtualKey Label=e KeyCode=69 [Key_Base_Row_3_ID_4] Type=VirtualKey Label=r KeyCode=82 [Key_Base_Row_3_ID_5] Type=VirtualKey Label=t KeyCode=84 [Key_Base_Row_3_ID_6] Type=VirtualKey Label=y KeyCode=89 [Key_Base_Row_3_ID_7] Type=VirtualKey Label=u KeyCode=85 [Key_Base_Row_3_ID_8] Type=VirtualKey Label=i KeyCode=73 [Key_Base_Row_3_ID_9] Type=VirtualKey Label=o KeyCode=79 [Key_Base_Row_3_ID_10] Type=VirtualKey Label=p KeyCode=80 [Key_Base_Row_3_ID_11] Type=String Label=^ String=^ [Key_Base_Row_3_ID_12] Type=String Label=$ String=$ [Key_Base_Row_3_ID_13] Type=VirtualKeyIsoEnter Width=150 Label= KeyCode=13 [Key_Base_Row_3_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_3_ID_15] Type=VirtualKey Label=Suppr Cluster=Navigation KeyCode=46 [Key_Base_Row_3_ID_16] Type=VirtualKey Label=Fin Cluster=Navigation KeyCode=35 [Key_Base_Row_3_ID_17] Type=VirtualKey Label=Page🠻 Cluster=Navigation KeyCode=34 [Key_Base_Row_3_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_3_ID_19] Type=VirtualKey Label=7 Cluster=Numpad KeyCode=103 [Key_Base_Row_3_ID_20] Type=VirtualKey Label=8 Cluster=Numpad KeyCode=104 [Key_Base_Row_3_ID_21] Type=VirtualKey Label=9 Cluster=Numpad KeyCode=105 [Key_Base_Row_3_ID_22] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 [Key_Base_Row_4_ID_0] Type=VirtualKey Width=175 Label=🡇 KeyCode=20 NoRepeat=true [Key_Base_Row_4_ID_1] Type=VirtualKey Label=q KeyCode=81 [Key_Base_Row_4_ID_2] Type=VirtualKey Label=s KeyCode=83 [Key_Base_Row_4_ID_3] Type=VirtualKey Label=d KeyCode=68 [Key_Base_Row_4_ID_4] Type=VirtualKey Label=f KeyCode=70 [Key_Base_Row_4_ID_5] Type=VirtualKey Label=g KeyCode=71 [Key_Base_Row_4_ID_6] Type=VirtualKey Label=h KeyCode=72 [Key_Base_Row_4_ID_7] Type=VirtualKey Label=j KeyCode=74 [Key_Base_Row_4_ID_8] Type=VirtualKey Label=k KeyCode=75 [Key_Base_Row_4_ID_9] Type=VirtualKey Label=l KeyCode=76 [Key_Base_Row_4_ID_10] Type=VirtualKey Label=m KeyCode=77 [Key_Base_Row_4_ID_11] Type=String Label=ù String=ù [Key_Base_Row_4_ID_12] Type=String Label=* String=* [Key_Base_Row_4_ID_13] Type=VirtualKeyIsoEnter Width=125 Label=↵ KeyCode=13 [Key_Base_Row_4_ID_14] Type=Blank Width=325 Cluster=Navigation [Key_Base_Row_4_ID_15] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_4_ID_16] Type=VirtualKey Label=4 Cluster=Numpad KeyCode=100 [Key_Base_Row_4_ID_17] Type=VirtualKey Label=5 Cluster=Numpad KeyCode=101 [Key_Base_Row_4_ID_18] Type=VirtualKey Label=6 Cluster=Numpad KeyCode=102 [Key_Base_Row_5_ID_0] Type=VirtualKeyToggle Width=125 Label=🡅 KeyCode=160 NoRepeat=true [Key_Base_Row_5_ID_1] Type=String Label=< String=< [Key_Base_Row_5_ID_2] Type=VirtualKey Label=w KeyCode=87 [Key_Base_Row_5_ID_3] Type=VirtualKey Label=x KeyCode=88 [Key_Base_Row_5_ID_4] Type=VirtualKey Label=c KeyCode=67 [Key_Base_Row_5_ID_5] Type=VirtualKey Label=v KeyCode=86 [Key_Base_Row_5_ID_6] Type=VirtualKey Label=b KeyCode=66 [Key_Base_Row_5_ID_7] Type=VirtualKey Label=n KeyCode=78 [Key_Base_Row_5_ID_8] Type=String Label=, String=, [Key_Base_Row_5_ID_9] Type=String Label=; String=; [Key_Base_Row_5_ID_10] Type=String Label=: String=: [Key_Base_Row_5_ID_11] Type=String Label=! String=! [Key_Base_Row_5_ID_12] Type=VirtualKeyToggle Width=275 Label=🡅 KeyCode=161 NoRepeat=true [Key_Base_Row_5_ID_13] Type=Blank Width=125 Cluster=Navigation [Key_Base_Row_5_ID_14] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_Base_Row_5_ID_15] Type=Blank Cluster=Navigation [Key_Base_Row_5_ID_16] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_5_ID_17] Type=VirtualKey Label=1 Cluster=Numpad KeyCode=97 [Key_Base_Row_5_ID_18] Type=VirtualKey Label=2 Cluster=Numpad KeyCode=98 [Key_Base_Row_5_ID_19] Type=VirtualKey Label=3 Cluster=Numpad KeyCode=99 [Key_Base_Row_5_ID_20] Type=VirtualKey Height=200 Label=Entrée Cluster=Numpad KeyCode=13 [Key_Base_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=162 NoRepeat=true [Key_Base_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_Base_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_Base_Row_6_ID_3] Type=VirtualKey Width=625 Label= KeyCode=32 [Key_Base_Row_6_ID_4] Type=VirtualKeyToggle Width=125 Label=AltGr KeyCode=165 NoRepeat=true [Key_Base_Row_6_ID_5] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_Base_Row_6_ID_6] Type=VirtualKey Width=125 Label=Menu KeyCode=93 NoRepeat=true [Key_Base_Row_6_ID_7] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=163 NoRepeat=true [Key_Base_Row_6_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_6_ID_9] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_Base_Row_6_ID_10] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_Base_Row_6_ID_11] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_Base_Row_6_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_6_ID_13] Type=VirtualKey Width=200 Label=0 Cluster=Numpad KeyCode=96 [Key_Base_Row_6_ID_14] Type=VirtualKey Label=. Cluster=Numpad KeyCode=110 [Key_Shift_Row_0_ID_0] Type=VirtualKey Label=Échap Cluster=Function KeyCode=27 NoRepeat=true [Key_Shift_Row_0_ID_1] Type=Blank Cluster=Function [Key_Shift_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_Shift_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_Shift_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_Shift_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_Shift_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_Shift_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_Shift_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_Shift_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_Shift_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_Shift_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_Shift_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_Shift_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_Shift_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_Shift_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_Shift_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_Shift_Row_0_ID_17] Type=VirtualKey Label=Impr Cluster=Function KeyCode=44 NoRepeat=true [Key_Shift_Row_0_ID_18] Type=VirtualKey Label=Défil Cluster=Function KeyCode=145 NoRepeat=true [Key_Shift_Row_0_ID_19] Type=VirtualKey Label=Pause Cluster=Function KeyCode=19 NoRepeat=true [Key_Shift_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_Shift_Row_0_ID_21] Type=VirtualKey Label=🡰 Cluster=Extra KeyCode=166 NoRepeat=true [Key_Shift_Row_0_ID_22] Type=VirtualKey Label=🡲 Cluster=Extra KeyCode=167 NoRepeat=true [Key_Shift_Row_0_ID_23] Type=VirtualKey Label=🔇 Cluster=Extra KeyCode=173 NoRepeat=true [Key_Shift_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_Shift_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra [Key_Shift_Row_2_ID_0] Type=String Label=² String=² [Key_Shift_Row_2_ID_1] Type=VirtualKey Label=1 KeyCode=49 [Key_Shift_Row_2_ID_2] Type=VirtualKey Label=2 KeyCode=50 [Key_Shift_Row_2_ID_3] Type=VirtualKey Label=3 KeyCode=51 [Key_Shift_Row_2_ID_4] Type=VirtualKey Label=4 KeyCode=52 [Key_Shift_Row_2_ID_5] Type=VirtualKey Label=5 KeyCode=53 [Key_Shift_Row_2_ID_6] Type=VirtualKey Label=6 KeyCode=54 [Key_Shift_Row_2_ID_7] Type=VirtualKey Label=7 KeyCode=55 [Key_Shift_Row_2_ID_8] Type=VirtualKey Label=8 KeyCode=56 [Key_Shift_Row_2_ID_9] Type=VirtualKey Label=9 KeyCode=57 [Key_Shift_Row_2_ID_10] Type=VirtualKey Label=0 KeyCode=48 [Key_Shift_Row_2_ID_11] Type=String Label=° String=° [Key_Shift_Row_2_ID_12] Type=String Label=+ String=+ [Key_Shift_Row_2_ID_13] Type=VirtualKey Width=200 Label=⟵ KeyCode=8 [Key_Shift_Row_2_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_2_ID_15] Type=VirtualKey Label=Inser Cluster=Navigation KeyCode=45 [Key_Shift_Row_2_ID_16] Type=VirtualKey Label=Début Cluster=Navigation KeyCode=36 [Key_Shift_Row_2_ID_17] Type=VirtualKey Label=Page🠹 Cluster=Navigation KeyCode=33 [Key_Shift_Row_2_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_2_ID_19] Type=VirtualKey Label=Verr\nNum Cluster=Numpad KeyCode=144 NoRepeat=true [Key_Shift_Row_2_ID_20] Type=VirtualKey Label=/ Cluster=Numpad KeyCode=111 [Key_Shift_Row_2_ID_21] Type=VirtualKey Label=* Cluster=Numpad KeyCode=106 [Key_Shift_Row_2_ID_22] Type=VirtualKey Label=- Cluster=Numpad KeyCode=109 [Key_Shift_Row_3_ID_0] Type=VirtualKey Width=150 Label=⭾ KeyCode=9 [Key_Shift_Row_3_ID_1] Type=VirtualKey Label=A KeyCode=65 [Key_Shift_Row_3_ID_2] Type=VirtualKey Label=Z KeyCode=90 [Key_Shift_Row_3_ID_3] Type=VirtualKey Label=E KeyCode=69 [Key_Shift_Row_3_ID_4] Type=VirtualKey Label=R KeyCode=82 [Key_Shift_Row_3_ID_5] Type=VirtualKey Label=T KeyCode=84 [Key_Shift_Row_3_ID_6] Type=VirtualKey Label=Y KeyCode=89 [Key_Shift_Row_3_ID_7] Type=VirtualKey Label=U KeyCode=85 [Key_Shift_Row_3_ID_8] Type=VirtualKey Label=I KeyCode=73 [Key_Shift_Row_3_ID_9] Type=VirtualKey Label=O KeyCode=79 [Key_Shift_Row_3_ID_10] Type=VirtualKey Label=P KeyCode=80 [Key_Shift_Row_3_ID_11] Type=String Label=¨ String=¨ [Key_Shift_Row_3_ID_12] Type=String Label=£ String=£ [Key_Shift_Row_3_ID_13] Type=VirtualKeyIsoEnter Width=150 Label= KeyCode=13 [Key_Shift_Row_3_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_3_ID_15] Type=VirtualKey Label=Suppr Cluster=Navigation KeyCode=46 [Key_Shift_Row_3_ID_16] Type=VirtualKey Label=Fin Cluster=Navigation KeyCode=35 [Key_Shift_Row_3_ID_17] Type=VirtualKey Label=Page🠻 Cluster=Navigation KeyCode=34 [Key_Shift_Row_3_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_3_ID_19] Type=VirtualKey Label=7 Cluster=Numpad KeyCode=103 [Key_Shift_Row_3_ID_20] Type=VirtualKey Label=8 Cluster=Numpad KeyCode=104 [Key_Shift_Row_3_ID_21] Type=VirtualKey Label=9 Cluster=Numpad KeyCode=105 [Key_Shift_Row_3_ID_22] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 [Key_Shift_Row_4_ID_0] Type=VirtualKey Width=175 Label=🡇 KeyCode=20 NoRepeat=true [Key_Shift_Row_4_ID_1] Type=VirtualKey Label=Q KeyCode=81 [Key_Shift_Row_4_ID_2] Type=VirtualKey Label=S KeyCode=83 [Key_Shift_Row_4_ID_3] Type=VirtualKey Label=D KeyCode=68 [Key_Shift_Row_4_ID_4] Type=VirtualKey Label=F KeyCode=70 [Key_Shift_Row_4_ID_5] Type=VirtualKey Label=G KeyCode=71 [Key_Shift_Row_4_ID_6] Type=VirtualKey Label=H KeyCode=72 [Key_Shift_Row_4_ID_7] Type=VirtualKey Label=J KeyCode=74 [Key_Shift_Row_4_ID_8] Type=VirtualKey Label=K KeyCode=75 [Key_Shift_Row_4_ID_9] Type=VirtualKey Label=L KeyCode=76 [Key_Shift_Row_4_ID_10] Type=VirtualKey Label=M KeyCode=77 [Key_Shift_Row_4_ID_11] Type=String Label=% String=% [Key_Shift_Row_4_ID_12] Type=String Label=µ String=µ [Key_Shift_Row_4_ID_13] Type=VirtualKeyIsoEnter Width=125 Label=↵ KeyCode=13 [Key_Shift_Row_4_ID_14] Type=Blank Width=325 Cluster=Navigation [Key_Shift_Row_4_ID_15] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_4_ID_16] Type=VirtualKey Label=4 Cluster=Numpad KeyCode=100 [Key_Shift_Row_4_ID_17] Type=VirtualKey Label=5 Cluster=Numpad KeyCode=101 [Key_Shift_Row_4_ID_18] Type=VirtualKey Label=6 Cluster=Numpad KeyCode=102 [Key_Shift_Row_5_ID_0] Type=VirtualKeyToggle Width=125 Label=🡅 KeyCode=160 NoRepeat=true [Key_Shift_Row_5_ID_1] Type=String Label=> String=> [Key_Shift_Row_5_ID_2] Type=VirtualKey Label=W KeyCode=87 [Key_Shift_Row_5_ID_3] Type=VirtualKey Label=X KeyCode=88 [Key_Shift_Row_5_ID_4] Type=VirtualKey Label=C KeyCode=67 [Key_Shift_Row_5_ID_5] Type=VirtualKey Label=V KeyCode=86 [Key_Shift_Row_5_ID_6] Type=VirtualKey Label=B KeyCode=66 [Key_Shift_Row_5_ID_7] Type=VirtualKey Label=N KeyCode=78 [Key_Shift_Row_5_ID_8] Type=String Label=? String=? [Key_Shift_Row_5_ID_9] Type=String Label=. String=. [Key_Shift_Row_5_ID_10] Type=String Label=/ String=/ [Key_Shift_Row_5_ID_11] Type=String Label=§ String=§ [Key_Shift_Row_5_ID_12] Type=VirtualKeyToggle Width=275 Label=🡅 KeyCode=161 NoRepeat=true [Key_Shift_Row_5_ID_13] Type=Blank Width=125 Cluster=Navigation [Key_Shift_Row_5_ID_14] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_Shift_Row_5_ID_15] Type=Blank Cluster=Navigation [Key_Shift_Row_5_ID_16] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_5_ID_17] Type=VirtualKey Label=1 Cluster=Numpad KeyCode=97 [Key_Shift_Row_5_ID_18] Type=VirtualKey Label=2 Cluster=Numpad KeyCode=98 [Key_Shift_Row_5_ID_19] Type=VirtualKey Label=3 Cluster=Numpad KeyCode=99 [Key_Shift_Row_5_ID_20] Type=VirtualKey Height=200 Label=Entrée Cluster=Numpad KeyCode=13 [Key_Shift_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=162 NoRepeat=true [Key_Shift_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_Shift_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_Shift_Row_6_ID_3] Type=VirtualKey Width=625 Label= KeyCode=32 [Key_Shift_Row_6_ID_4] Type=VirtualKeyToggle Width=125 Label=AltGr KeyCode=165 NoRepeat=true [Key_Shift_Row_6_ID_5] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_Shift_Row_6_ID_6] Type=VirtualKey Width=125 Label=Menu KeyCode=93 NoRepeat=true [Key_Shift_Row_6_ID_7] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=163 NoRepeat=true [Key_Shift_Row_6_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_6_ID_9] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_Shift_Row_6_ID_10] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_Shift_Row_6_ID_11] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_Shift_Row_6_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_6_ID_13] Type=VirtualKey Width=200 Label=0 Cluster=Numpad KeyCode=96 [Key_Shift_Row_6_ID_14] Type=VirtualKey Label=. Cluster=Numpad KeyCode=110 [Key_AltGr_Row_0_ID_0] Type=VirtualKey Label=Échap Cluster=Function KeyCode=27 NoRepeat=true [Key_AltGr_Row_0_ID_1] Type=Blank Cluster=Function [Key_AltGr_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_AltGr_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_AltGr_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_AltGr_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_AltGr_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_AltGr_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_AltGr_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_AltGr_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_AltGr_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_AltGr_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_AltGr_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_AltGr_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_AltGr_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_AltGr_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_AltGr_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_AltGr_Row_0_ID_17] Type=VirtualKey Label=Impr Cluster=Function KeyCode=44 NoRepeat=true [Key_AltGr_Row_0_ID_18] Type=VirtualKey Label=Défil Cluster=Function KeyCode=145 NoRepeat=true [Key_AltGr_Row_0_ID_19] Type=VirtualKey Label=Pause Cluster=Function KeyCode=19 NoRepeat=true [Key_AltGr_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_AltGr_Row_0_ID_21] Type=VirtualKey Label=⏯ Cluster=Extra KeyCode=179 NoRepeat=true [Key_AltGr_Row_0_ID_22] Type=VirtualKey Label=◼ Cluster=Extra KeyCode=178 NoRepeat=true [Key_AltGr_Row_0_ID_23] Type=VirtualKey Label=⏮ Cluster=Extra KeyCode=177 NoRepeat=true [Key_AltGr_Row_0_ID_24] Type=VirtualKey Label=⏭ Cluster=Extra KeyCode=176 NoRepeat=true [Key_AltGr_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_AltGr_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra [Key_AltGr_Row_2_ID_0] Type=Blank Width=200 [Key_AltGr_Row_2_ID_1] Type=String Label=~ String=~ [Key_AltGr_Row_2_ID_2] Type=String Label=# String=# [Key_AltGr_Row_2_ID_3] Type=String Label={ String={ [Key_AltGr_Row_2_ID_4] Type=String Label=[ String=[ [Key_AltGr_Row_2_ID_5] Type=String Label=| String=| [Key_AltGr_Row_2_ID_6] Type=String Label=` String=` [Key_AltGr_Row_2_ID_7] Type=String Label=\ String=\ [Key_AltGr_Row_2_ID_8] Type=String Label=^ String=^ [Key_AltGr_Row_2_ID_9] Type=String Label=@ String=@ [Key_AltGr_Row_2_ID_10] Type=String Label=] String=] [Key_AltGr_Row_2_ID_11] Type=String Label=} String=} [Key_AltGr_Row_2_ID_12] Type=VirtualKey Width=200 Label=⟵ KeyCode=8 [Key_AltGr_Row_2_ID_13] Type=Blank Width=25 Cluster=Navigation [Key_AltGr_Row_2_ID_14] Type=VirtualKey Label=Inser Cluster=Navigation KeyCode=45 [Key_AltGr_Row_2_ID_15] Type=VirtualKey Label=Début Cluster=Navigation KeyCode=36 [Key_AltGr_Row_2_ID_16] Type=VirtualKey Label=Page🠹 Cluster=Navigation KeyCode=33 [Key_AltGr_Row_2_ID_17] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_2_ID_18] Type=VirtualKey Label=Verr\nNum Cluster=Numpad KeyCode=144 NoRepeat=true [Key_AltGr_Row_2_ID_19] Type=VirtualKey Label=/ Cluster=Numpad KeyCode=111 [Key_AltGr_Row_2_ID_20] Type=VirtualKey Label=* Cluster=Numpad KeyCode=106 [Key_AltGr_Row_2_ID_21] Type=VirtualKey Label=- Cluster=Numpad KeyCode=109 [Key_AltGr_Row_3_ID_0] Type=VirtualKey Width=150 Label=⭾ KeyCode=9 [Key_AltGr_Row_3_ID_1] Type=Blank Width=200 [Key_AltGr_Row_3_ID_2] Type=String Label=€ String=€ [Key_AltGr_Row_3_ID_3] Type=Blank Width=800 [Key_AltGr_Row_3_ID_4] Type=String Label=¤ String=¤ [Key_AltGr_Row_3_ID_5] Type=VirtualKeyIsoEnter Width=150 Label= KeyCode=13 [Key_AltGr_Row_3_ID_6] Type=Blank Width=25 Cluster=Navigation [Key_AltGr_Row_3_ID_7] Type=VirtualKey Label=Suppr Cluster=Navigation KeyCode=46 [Key_AltGr_Row_3_ID_8] Type=VirtualKey Label=Fin Cluster=Navigation KeyCode=35 [Key_AltGr_Row_3_ID_9] Type=VirtualKey Label=Page🠻 Cluster=Navigation KeyCode=34 [Key_AltGr_Row_3_ID_10] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_3_ID_11] Type=VirtualKey Label=7 Cluster=Numpad KeyCode=103 [Key_AltGr_Row_3_ID_12] Type=VirtualKey Label=8 Cluster=Numpad KeyCode=104 [Key_AltGr_Row_3_ID_13] Type=VirtualKey Label=9 Cluster=Numpad KeyCode=105 [Key_AltGr_Row_3_ID_14] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 [Key_AltGr_Row_4_ID_0] Type=VirtualKey Width=175 Label=🡇 KeyCode=20 NoRepeat=true [Key_AltGr_Row_4_ID_1] Type=Blank Width=1200 [Key_AltGr_Row_4_ID_2] Type=VirtualKeyIsoEnter Width=125 Label=↵ KeyCode=13 [Key_AltGr_Row_4_ID_3] Type=Blank Width=325 Cluster=Navigation [Key_AltGr_Row_4_ID_4] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_4_ID_5] Type=VirtualKey Label=4 Cluster=Numpad KeyCode=100 [Key_AltGr_Row_4_ID_6] Type=VirtualKey Label=5 Cluster=Numpad KeyCode=101 [Key_AltGr_Row_4_ID_7] Type=VirtualKey Label=6 Cluster=Numpad KeyCode=102 [Key_AltGr_Row_5_ID_0] Type=VirtualKeyToggle Width=125 Label=🡅 KeyCode=160 NoRepeat=true [Key_AltGr_Row_5_ID_1] Type=Blank Width=1100 [Key_AltGr_Row_5_ID_2] Type=VirtualKeyToggle Width=275 Label=🡅 KeyCode=161 NoRepeat=true [Key_AltGr_Row_5_ID_3] Type=Blank Width=125 Cluster=Navigation [Key_AltGr_Row_5_ID_4] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_AltGr_Row_5_ID_5] Type=Blank Cluster=Navigation [Key_AltGr_Row_5_ID_6] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_5_ID_7] Type=VirtualKey Label=1 Cluster=Numpad KeyCode=97 [Key_AltGr_Row_5_ID_8] Type=VirtualKey Label=2 Cluster=Numpad KeyCode=98 [Key_AltGr_Row_5_ID_9] Type=VirtualKey Label=3 Cluster=Numpad KeyCode=99 [Key_AltGr_Row_5_ID_10] Type=VirtualKey Height=200 Label=Entrée Cluster=Numpad KeyCode=13 [Key_AltGr_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=162 NoRepeat=true [Key_AltGr_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_AltGr_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_AltGr_Row_6_ID_3] Type=VirtualKey Width=625 Label= KeyCode=32 [Key_AltGr_Row_6_ID_4] Type=VirtualKeyToggle Width=125 Label=AltGr KeyCode=165 NoRepeat=true [Key_AltGr_Row_6_ID_5] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_AltGr_Row_6_ID_6] Type=VirtualKey Width=125 Label=Menu KeyCode=93 NoRepeat=true [Key_AltGr_Row_6_ID_7] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=163 NoRepeat=true [Key_AltGr_Row_6_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_AltGr_Row_6_ID_9] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_AltGr_Row_6_ID_10] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_AltGr_Row_6_ID_11] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_AltGr_Row_6_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_6_ID_13] Type=VirtualKey Width=200 Label=0 Cluster=Numpad KeyCode=96 [Key_AltGr_Row_6_ID_14] Type=VirtualKey Label=. Cluster=Numpad KeyCode=110 ================================================ FILE: assets/keyboards/qwerty_dk.ini ================================================ [LayoutInfo] Name=QWERTY (Denmark) Author=BOTAlex HasAltGr=true HasClusterFunction=true HasClusterNavigation=true HasClusterNumpad=true HasClusterExtra=true [Key_Base_Row_0_ID_0] Type=VirtualKey Label=Esc Cluster=Function KeyCode=27 NoRepeat=true [Key_Base_Row_0_ID_1] Type=Blank Cluster=Function [Key_Base_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_Base_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_Base_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_Base_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_Base_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_Base_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_Base_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_Base_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_Base_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_Base_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_Base_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_Base_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_Base_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_Base_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_Base_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_Base_Row_0_ID_17] Type=VirtualKey Label=Print\nScreen Cluster=Function KeyCode=44 NoRepeat=true [Key_Base_Row_0_ID_18] Type=VirtualKey Label=Scroll\nLock Cluster=Function KeyCode=145 NoRepeat=true [Key_Base_Row_0_ID_19] Type=VirtualKey Label=Pause Cluster=Function KeyCode=19 NoRepeat=true [Key_Base_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_Base_Row_0_ID_21] Type=VirtualKey Label=⏯ Cluster=Extra KeyCode=179 NoRepeat=true [Key_Base_Row_0_ID_22] Type=VirtualKey Label=◼ Cluster=Extra KeyCode=178 NoRepeat=true [Key_Base_Row_0_ID_23] Type=VirtualKey Label=⏮ Cluster=Extra KeyCode=177 NoRepeat=true [Key_Base_Row_0_ID_24] Type=VirtualKey Label=⏭ Cluster=Extra KeyCode=176 NoRepeat=true [Key_Base_Row_1_ID_0] Type=Blank Width=1500 Height=25 Cluster=Function [Key_Base_Row_2_ID_0] Type=String Label=½ String=½ [Key_Base_Row_2_ID_1] Type=VirtualKey Label=1 KeyCode=49 [Key_Base_Row_2_ID_2] Type=VirtualKey Label=2 KeyCode=50 [Key_Base_Row_2_ID_3] Type=VirtualKey Label=3 KeyCode=51 [Key_Base_Row_2_ID_4] Type=VirtualKey Label=4 KeyCode=52 [Key_Base_Row_2_ID_5] Type=VirtualKey Label=5 KeyCode=53 [Key_Base_Row_2_ID_6] Type=VirtualKey Label=6 KeyCode=54 [Key_Base_Row_2_ID_7] Type=VirtualKey Label=7 KeyCode=55 [Key_Base_Row_2_ID_8] Type=VirtualKey Label=8 KeyCode=56 [Key_Base_Row_2_ID_9] Type=VirtualKey Label=9 KeyCode=57 [Key_Base_Row_2_ID_10] Type=VirtualKey Label=0 KeyCode=48 [Key_Base_Row_2_ID_11] Type=VirtualKey Label=+ KeyCode=187 [Key_Base_Row_2_ID_12] Type=String Label=´ String=´ [Key_Base_Row_2_ID_13] Type=VirtualKey Width=200 Label=Backspace KeyCode=8 [Key_Base_Row_2_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_2_ID_15] Type=VirtualKey Label=Insert Cluster=Navigation KeyCode=45 [Key_Base_Row_2_ID_16] Type=VirtualKey Label=Home Cluster=Navigation KeyCode=36 [Key_Base_Row_2_ID_17] Type=VirtualKey Label=PgUp Cluster=Navigation KeyCode=33 [Key_Base_Row_2_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_2_ID_19] Type=VirtualKey Label=Num\nLock Cluster=Numpad KeyCode=144 NoRepeat=true [Key_Base_Row_2_ID_20] Type=VirtualKey Label=/ Cluster=Numpad KeyCode=111 [Key_Base_Row_2_ID_21] Type=VirtualKey Label=* Cluster=Numpad KeyCode=106 [Key_Base_Row_2_ID_22] Type=VirtualKey Label=- Cluster=Numpad KeyCode=109 [Key_Base_Row_3_ID_0] Type=VirtualKey Width=150 Label=Tab KeyCode=9 [Key_Base_Row_3_ID_1] Type=VirtualKey Label=q KeyCode=81 [Key_Base_Row_3_ID_2] Type=VirtualKey Label=w KeyCode=87 [Key_Base_Row_3_ID_3] Type=VirtualKey Label=e KeyCode=69 [Key_Base_Row_3_ID_4] Type=VirtualKey Label=r KeyCode=82 [Key_Base_Row_3_ID_5] Type=VirtualKey Label=t KeyCode=84 [Key_Base_Row_3_ID_6] Type=VirtualKey Label=y KeyCode=89 [Key_Base_Row_3_ID_7] Type=VirtualKey Label=u KeyCode=85 [Key_Base_Row_3_ID_8] Type=VirtualKey Label=i KeyCode=73 [Key_Base_Row_3_ID_9] Type=VirtualKey Label=o KeyCode=79 [Key_Base_Row_3_ID_10] Type=VirtualKey Label=p KeyCode=80 [Key_Base_Row_3_ID_11] Type=String Label=å String=å [Key_Base_Row_3_ID_12] Type=String Label=¨ String=¨ [Key_Base_Row_3_ID_13] Type=VirtualKeyIsoEnter Width=150 Label=Enter KeyCode=13 [Key_Base_Row_3_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_3_ID_15] Type=VirtualKey Label=Delete Cluster=Navigation KeyCode=46 [Key_Base_Row_3_ID_16] Type=VirtualKey Label=End Cluster=Navigation KeyCode=35 [Key_Base_Row_3_ID_17] Type=VirtualKey Label=PgDn Cluster=Navigation KeyCode=34 [Key_Base_Row_3_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_3_ID_19] Type=VirtualKey Label=7 Cluster=Numpad KeyCode=103 [Key_Base_Row_3_ID_20] Type=VirtualKey Label=8 Cluster=Numpad KeyCode=104 [Key_Base_Row_3_ID_21] Type=VirtualKey Label=9 Cluster=Numpad KeyCode=105 [Key_Base_Row_3_ID_22] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 [Key_Base_Row_4_ID_0] Type=VirtualKey Width=175 Label=Caps Lock KeyCode=20 NoRepeat=true [Key_Base_Row_4_ID_1] Type=VirtualKey Label=a KeyCode=65 [Key_Base_Row_4_ID_2] Type=VirtualKey Label=s KeyCode=83 [Key_Base_Row_4_ID_3] Type=VirtualKey Label=d KeyCode=68 [Key_Base_Row_4_ID_4] Type=VirtualKey Label=f KeyCode=70 [Key_Base_Row_4_ID_5] Type=VirtualKey Label=g KeyCode=71 [Key_Base_Row_4_ID_6] Type=VirtualKey Label=h KeyCode=72 [Key_Base_Row_4_ID_7] Type=VirtualKey Label=j KeyCode=74 [Key_Base_Row_4_ID_8] Type=VirtualKey Label=k KeyCode=75 [Key_Base_Row_4_ID_9] Type=VirtualKey Label=l KeyCode=76 [Key_Base_Row_4_ID_10] Type=String Label=æ String=æ [Key_Base_Row_4_ID_11] Type=String Label=ø String=ø [Key_Base_Row_4_ID_12] Type=String Label=' String=' [Key_Base_Row_4_ID_13] Type=VirtualKeyIsoEnter Width=125 Label=Enter KeyCode=13 [Key_Base_Row_4_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_4_ID_15] Type=Blank Width=300 Cluster=Navigation [Key_Base_Row_4_ID_16] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_4_ID_17] Type=VirtualKey Label=4 Cluster=Numpad KeyCode=100 [Key_Base_Row_4_ID_18] Type=VirtualKey Label=5 Cluster=Numpad KeyCode=101 [Key_Base_Row_4_ID_19] Type=VirtualKey Label=6 Cluster=Numpad KeyCode=102 [Key_Base_Row_5_ID_0] Type=VirtualKeyToggle Width=125 Label=Shift KeyCode=160 NoRepeat=true [Key_Base_Row_5_ID_1] Type=VirtualKey Label=< KeyCode=226 [Key_Base_Row_5_ID_2] Type=VirtualKey Label=z KeyCode=90 [Key_Base_Row_5_ID_3] Type=VirtualKey Label=x KeyCode=88 [Key_Base_Row_5_ID_4] Type=VirtualKey Label=c KeyCode=67 [Key_Base_Row_5_ID_5] Type=VirtualKey Label=v KeyCode=86 [Key_Base_Row_5_ID_6] Type=VirtualKey Label=b KeyCode=66 [Key_Base_Row_5_ID_7] Type=VirtualKey Label=n KeyCode=78 [Key_Base_Row_5_ID_8] Type=VirtualKey Label=m KeyCode=77 [Key_Base_Row_5_ID_9] Type=String Label=, String=, [Key_Base_Row_5_ID_10] Type=String Label=. String=. [Key_Base_Row_5_ID_11] Type=String Label=- String=- [Key_Base_Row_5_ID_12] Type=VirtualKeyToggle Width=275 Label=Shift KeyCode=161 NoRepeat=true [Key_Base_Row_5_ID_13] Type=Blank Width=125 Cluster=Navigation [Key_Base_Row_5_ID_14] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_Base_Row_5_ID_15] Type=Blank Cluster=Navigation [Key_Base_Row_5_ID_16] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_5_ID_17] Type=VirtualKey Label=1 Cluster=Numpad KeyCode=97 [Key_Base_Row_5_ID_18] Type=VirtualKey Label=2 Cluster=Numpad KeyCode=98 [Key_Base_Row_5_ID_19] Type=VirtualKey Label=3 Cluster=Numpad KeyCode=99 [Key_Base_Row_5_ID_20] Type=VirtualKey Height=200 Label=Enter Cluster=Numpad KeyCode=13 [Key_Base_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=162 NoRepeat=true [Key_Base_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_Base_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_Base_Row_6_ID_3] Type=VirtualKey Width=625 Label= KeyCode=32 [Key_Base_Row_6_ID_4] Type=VirtualKeyToggle Width=125 Label=AltGr KeyCode=165 NoRepeat=true [Key_Base_Row_6_ID_5] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_Base_Row_6_ID_6] Type=VirtualKey Width=125 Label=Menu KeyCode=93 NoRepeat=true [Key_Base_Row_6_ID_7] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=163 NoRepeat=true [Key_Base_Row_6_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_6_ID_9] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_Base_Row_6_ID_10] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_Base_Row_6_ID_11] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_Base_Row_6_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_6_ID_13] Type=VirtualKey Width=200 Label=0 Cluster=Numpad KeyCode=96 [Key_Base_Row_6_ID_14] Type=VirtualKey Label=, Cluster=Numpad KeyCode=110 [Key_Shift_Row_0_ID_0] Type=VirtualKey Label=Esc Cluster=Function KeyCode=27 NoRepeat=true [Key_Shift_Row_0_ID_1] Type=Blank Cluster=Function [Key_Shift_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_Shift_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_Shift_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_Shift_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_Shift_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_Shift_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_Shift_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_Shift_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_Shift_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_Shift_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_Shift_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_Shift_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_Shift_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_Shift_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_Shift_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_Shift_Row_0_ID_17] Type=VirtualKey Label=Print\nScreen Cluster=Function KeyCode=44 NoRepeat=true [Key_Shift_Row_0_ID_18] Type=VirtualKey Label=Scroll\nLock Cluster=Function KeyCode=145 NoRepeat=true [Key_Shift_Row_0_ID_19] Type=VirtualKey Label=Pause Cluster=Function KeyCode=19 NoRepeat=true [Key_Shift_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_Shift_Row_0_ID_21] Type=VirtualKey Label=🡰 Cluster=Extra KeyCode=166 NoRepeat=true [Key_Shift_Row_0_ID_22] Type=VirtualKey Label=🡲 Cluster=Extra KeyCode=167 NoRepeat=true [Key_Shift_Row_0_ID_23] Type=VirtualKey Label=🔇 Cluster=Extra KeyCode=173 NoRepeat=true [Key_Shift_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_Shift_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra [Key_Shift_Row_2_ID_0] Type=String Label=§ String=§ [Key_Shift_Row_2_ID_1] Type=String Label=! String=! [Key_Shift_Row_2_ID_2] Type=String Label=" String=" [Key_Shift_Row_2_ID_3] Type=String Label=# String=# [Key_Shift_Row_2_ID_4] Type=String Label=¤ String=¤ [Key_Shift_Row_2_ID_5] Type=String Label=% String=% [Key_Shift_Row_2_ID_6] Type=String Label=& String=& [Key_Shift_Row_2_ID_7] Type=String Label=/ String=/ [Key_Shift_Row_2_ID_8] Type=String Label=( String=( [Key_Shift_Row_2_ID_9] Type=String Label=) String=) [Key_Shift_Row_2_ID_10] Type=String Label== String== [Key_Shift_Row_2_ID_11] Type=String Label=? String=? [Key_Shift_Row_2_ID_12] Type=String Label=` String=` [Key_Shift_Row_2_ID_13] Type=VirtualKey Width=200 Label=Backspace KeyCode=8 [Key_Shift_Row_2_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_2_ID_15] Type=VirtualKey Label=Insert Cluster=Navigation KeyCode=45 [Key_Shift_Row_2_ID_16] Type=VirtualKey Label=Home Cluster=Navigation KeyCode=36 [Key_Shift_Row_2_ID_17] Type=VirtualKey Label=PgUp Cluster=Navigation KeyCode=33 [Key_Shift_Row_2_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_2_ID_19] Type=VirtualKey Label=Num\nLock Cluster=Numpad KeyCode=144 NoRepeat=true [Key_Shift_Row_2_ID_20] Type=VirtualKey Label=/ Cluster=Numpad KeyCode=111 [Key_Shift_Row_2_ID_21] Type=VirtualKey Label=* Cluster=Numpad KeyCode=106 [Key_Shift_Row_2_ID_22] Type=VirtualKey Label=- Cluster=Numpad KeyCode=109 [Key_Shift_Row_3_ID_0] Type=VirtualKey Width=150 Label=Tab KeyCode=9 [Key_Shift_Row_3_ID_1] Type=VirtualKey Label=Q KeyCode=81 [Key_Shift_Row_3_ID_2] Type=VirtualKey Label=W KeyCode=87 [Key_Shift_Row_3_ID_3] Type=VirtualKey Label=E KeyCode=69 [Key_Shift_Row_3_ID_4] Type=VirtualKey Label=R KeyCode=82 [Key_Shift_Row_3_ID_5] Type=VirtualKey Label=T KeyCode=84 [Key_Shift_Row_3_ID_6] Type=VirtualKey Label=Y KeyCode=89 [Key_Shift_Row_3_ID_7] Type=VirtualKey Label=U KeyCode=85 [Key_Shift_Row_3_ID_8] Type=VirtualKey Label=I KeyCode=73 [Key_Shift_Row_3_ID_9] Type=VirtualKey Label=O KeyCode=79 [Key_Shift_Row_3_ID_10] Type=VirtualKey Label=P KeyCode=80 [Key_Shift_Row_3_ID_11] Type=String Label=Å String=Å [Key_Shift_Row_3_ID_12] Type=String Label=^ String=^ [Key_Shift_Row_3_ID_13] Type=VirtualKeyIsoEnter Width=150 Label=Enter KeyCode=13 [Key_Shift_Row_3_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_3_ID_15] Type=VirtualKey Label=Delete Cluster=Navigation KeyCode=46 [Key_Shift_Row_3_ID_16] Type=VirtualKey Label=End Cluster=Navigation KeyCode=35 [Key_Shift_Row_3_ID_17] Type=VirtualKey Label=PgDn Cluster=Navigation KeyCode=34 [Key_Shift_Row_3_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_3_ID_19] Type=VirtualKey Label=7 Cluster=Numpad KeyCode=103 [Key_Shift_Row_3_ID_20] Type=VirtualKey Label=8 Cluster=Numpad KeyCode=104 [Key_Shift_Row_3_ID_21] Type=VirtualKey Label=9 Cluster=Numpad KeyCode=105 [Key_Shift_Row_3_ID_22] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 [Key_Shift_Row_4_ID_0] Type=VirtualKey Width=175 Label=Caps Lock KeyCode=20 NoRepeat=true [Key_Shift_Row_4_ID_1] Type=VirtualKey Label=A KeyCode=65 [Key_Shift_Row_4_ID_2] Type=VirtualKey Label=S KeyCode=83 [Key_Shift_Row_4_ID_3] Type=VirtualKey Label=D KeyCode=68 [Key_Shift_Row_4_ID_4] Type=VirtualKey Label=F KeyCode=70 [Key_Shift_Row_4_ID_5] Type=VirtualKey Label=G KeyCode=71 [Key_Shift_Row_4_ID_6] Type=VirtualKey Label=H KeyCode=72 [Key_Shift_Row_4_ID_7] Type=VirtualKey Label=J KeyCode=74 [Key_Shift_Row_4_ID_8] Type=VirtualKey Label=K KeyCode=75 [Key_Shift_Row_4_ID_9] Type=VirtualKey Label=L KeyCode=76 [Key_Shift_Row_4_ID_10] Type=String Label=Æ String=Æ [Key_Shift_Row_4_ID_11] Type=String Label=Ø String=Ø [Key_Shift_Row_4_ID_12] Type=String Label=* String=* [Key_Shift_Row_4_ID_13] Type=VirtualKeyIsoEnter Width=125 Label=Enter KeyCode=13 [Key_Shift_Row_4_ID_14] Type=Blank Width=325 Cluster=Navigation [Key_Shift_Row_4_ID_15] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_4_ID_16] Type=VirtualKey Label=4 Cluster=Numpad KeyCode=100 [Key_Shift_Row_4_ID_17] Type=VirtualKey Label=5 Cluster=Numpad KeyCode=101 [Key_Shift_Row_4_ID_18] Type=VirtualKey Label=6 Cluster=Numpad KeyCode=102 [Key_Shift_Row_5_ID_0] Type=VirtualKeyToggle Width=125 Label=Shift KeyCode=160 NoRepeat=true [Key_Shift_Row_5_ID_1] Type=VirtualKey Label=> KeyCode=226 [Key_Shift_Row_5_ID_2] Type=VirtualKey Label=Z KeyCode=90 [Key_Shift_Row_5_ID_3] Type=VirtualKey Label=X KeyCode=88 [Key_Shift_Row_5_ID_4] Type=VirtualKey Label=C KeyCode=67 [Key_Shift_Row_5_ID_5] Type=VirtualKey Label=V KeyCode=86 [Key_Shift_Row_5_ID_6] Type=VirtualKey Label=B KeyCode=66 [Key_Shift_Row_5_ID_7] Type=VirtualKey Label=N KeyCode=78 [Key_Shift_Row_5_ID_8] Type=VirtualKey Label=M KeyCode=77 [Key_Shift_Row_5_ID_9] Type=String Label=; String=; [Key_Shift_Row_5_ID_10] Type=String Label=: String=: [Key_Shift_Row_5_ID_11] Type=String Label=_ String=_ [Key_Shift_Row_5_ID_12] Type=VirtualKeyToggle Width=275 Label=Shift KeyCode=161 NoRepeat=true [Key_Shift_Row_5_ID_13] Type=Blank Width=125 Cluster=Navigation [Key_Shift_Row_5_ID_14] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_Shift_Row_5_ID_15] Type=Blank Cluster=Navigation [Key_Shift_Row_5_ID_16] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_5_ID_17] Type=VirtualKey Label=1 Cluster=Numpad KeyCode=97 [Key_Shift_Row_5_ID_18] Type=VirtualKey Label=2 Cluster=Numpad KeyCode=98 [Key_Shift_Row_5_ID_19] Type=VirtualKey Label=3 Cluster=Numpad KeyCode=99 [Key_Shift_Row_5_ID_20] Type=VirtualKey Height=200 Label=Enter Cluster=Numpad KeyCode=13 [Key_Shift_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=162 NoRepeat=true [Key_Shift_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_Shift_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_Shift_Row_6_ID_3] Type=VirtualKey Width=625 Label= KeyCode=32 [Key_Shift_Row_6_ID_4] Type=VirtualKeyToggle Width=125 Label=AltGr KeyCode=165 NoRepeat=true [Key_Shift_Row_6_ID_5] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_Shift_Row_6_ID_6] Type=VirtualKey Width=125 Label=Menu KeyCode=93 NoRepeat=true [Key_Shift_Row_6_ID_7] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=163 NoRepeat=true [Key_Shift_Row_6_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_6_ID_9] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_Shift_Row_6_ID_10] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_Shift_Row_6_ID_11] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_Shift_Row_6_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_6_ID_13] Type=VirtualKey Width=200 Label=0 Cluster=Numpad KeyCode=96 [Key_Shift_Row_6_ID_14] Type=VirtualKey Label=, Cluster=Numpad KeyCode=110 [Key_AltGr_Row_0_ID_0] Type=VirtualKey Label=Esc Cluster=Function KeyCode=27 NoRepeat=true [Key_AltGr_Row_0_ID_1] Type=Blank Cluster=Function [Key_AltGr_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_AltGr_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_AltGr_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_AltGr_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_AltGr_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_AltGr_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_AltGr_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_AltGr_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_AltGr_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_AltGr_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_AltGr_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_AltGr_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_AltGr_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_AltGr_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_AltGr_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_AltGr_Row_0_ID_17] Type=VirtualKey Label=Print\nScreen Cluster=Function KeyCode=44 NoRepeat=true [Key_AltGr_Row_0_ID_18] Type=VirtualKey Label=Scroll\nLock Cluster=Function KeyCode=145 NoRepeat=true [Key_AltGr_Row_0_ID_19] Type=VirtualKey Label=Pause Cluster=Function KeyCode=19 NoRepeat=true [Key_AltGr_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_AltGr_Row_0_ID_21] Type=VirtualKey Label=⏯ Cluster=Extra KeyCode=179 NoRepeat=true [Key_AltGr_Row_0_ID_22] Type=VirtualKey Label=◼ Cluster=Extra KeyCode=178 NoRepeat=true [Key_AltGr_Row_0_ID_23] Type=VirtualKey Label=⏮ Cluster=Extra KeyCode=177 NoRepeat=true [Key_AltGr_Row_0_ID_24] Type=VirtualKey Label=⏭ Cluster=Extra KeyCode=176 NoRepeat=true [Key_AltGr_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_AltGr_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra [Key_AltGr_Row_2_ID_0] Type=String Label= String= [Key_AltGr_Row_2_ID_1] Type=VirtualKey Label= KeyCode=0 [Key_AltGr_Row_2_ID_2] Type=String Label=@ String=@ [Key_AltGr_Row_2_ID_3] Type=String Label=£ String=£ [Key_AltGr_Row_2_ID_4] Type=String Label=$ String=$ [Key_AltGr_Row_2_ID_5] Type=String Label=€ String=€ [Key_AltGr_Row_2_ID_6] Type=String Label= String= [Key_AltGr_Row_2_ID_7] Type=String Label={ String={ [Key_AltGr_Row_2_ID_8] Type=String Label=[ String=[ [Key_AltGr_Row_2_ID_9] Type=String Label=] String=] [Key_AltGr_Row_2_ID_10] Type=String Label=} String=} [Key_AltGr_Row_2_ID_11] Type=String Label= String= [Key_AltGr_Row_2_ID_12] Type=String Label=| String=| [Key_AltGr_Row_2_ID_13] Type=VirtualKey Width=200 Label=Backspace KeyCode=8 [Key_AltGr_Row_2_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_AltGr_Row_2_ID_15] Type=VirtualKey Label=Insert Cluster=Navigation KeyCode=45 [Key_AltGr_Row_2_ID_16] Type=VirtualKey Label=Home Cluster=Navigation KeyCode=36 [Key_AltGr_Row_2_ID_17] Type=VirtualKey Label=PgUp Cluster=Navigation KeyCode=33 [Key_AltGr_Row_2_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_2_ID_19] Type=VirtualKey Label=Num\nLock Cluster=Numpad KeyCode=144 NoRepeat=true [Key_AltGr_Row_2_ID_20] Type=VirtualKey Label=/ Cluster=Numpad KeyCode=111 [Key_AltGr_Row_2_ID_21] Type=VirtualKey Label=* Cluster=Numpad KeyCode=106 [Key_AltGr_Row_2_ID_22] Type=VirtualKey Label=- Cluster=Numpad KeyCode=109 [Key_AltGr_Row_3_ID_0] Type=VirtualKey Width=150 Label=Tab KeyCode=9 [Key_AltGr_Row_3_ID_1] Type=VirtualKey Label= KeyCode=0 [Key_AltGr_Row_3_ID_2] Type=VirtualKey Label= KeyCode=0 [Key_AltGr_Row_3_ID_3] Type=VirtualKey Label= KeyCode=0 [Key_AltGr_Row_3_ID_4] Type=VirtualKey Label= KeyCode=0 [Key_AltGr_Row_3_ID_5] Type=VirtualKey Label= KeyCode=0 [Key_AltGr_Row_3_ID_6] Type=VirtualKey Label= KeyCode=0 [Key_AltGr_Row_3_ID_7] Type=VirtualKey Label= KeyCode=0 [Key_AltGr_Row_3_ID_8] Type=VirtualKey Label= KeyCode=0 [Key_AltGr_Row_3_ID_9] Type=VirtualKey Label= KeyCode=0 [Key_AltGr_Row_3_ID_10] Type=VirtualKey Label= KeyCode=0 [Key_AltGr_Row_3_ID_11] Type=VirtualKey Label= KeyCode=0 [Key_AltGr_Row_3_ID_12] Type=String Label=~ String=~ [Key_AltGr_Row_3_ID_13] Type=VirtualKeyIsoEnter Width=150 Label=Enter KeyCode=13 [Key_AltGr_Row_3_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_AltGr_Row_3_ID_15] Type=VirtualKey Label=Delete Cluster=Navigation KeyCode=46 [Key_AltGr_Row_3_ID_16] Type=VirtualKey Label=End Cluster=Navigation KeyCode=35 [Key_AltGr_Row_3_ID_17] Type=VirtualKey Label=PgDn Cluster=Navigation KeyCode=34 [Key_AltGr_Row_3_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_3_ID_19] Type=VirtualKey Label=7 Cluster=Numpad KeyCode=103 [Key_AltGr_Row_3_ID_20] Type=VirtualKey Label=8 Cluster=Numpad KeyCode=56 [Key_AltGr_Row_3_ID_21] Type=VirtualKey Label=9 Cluster=Numpad KeyCode=105 [Key_AltGr_Row_3_ID_22] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 [Key_AltGr_Row_4_ID_0] Type=VirtualKey Width=175 Label=Caps Lock KeyCode=20 NoRepeat=true [Key_AltGr_Row_4_ID_1] Type=VirtualKey Label= KeyCode=0 [Key_AltGr_Row_4_ID_2] Type=VirtualKey Label= KeyCode=0 [Key_AltGr_Row_4_ID_3] Type=VirtualKey Label= KeyCode=0 [Key_AltGr_Row_4_ID_4] Type=VirtualKey Label= KeyCode=0 [Key_AltGr_Row_4_ID_5] Type=VirtualKey Label= KeyCode=0 [Key_AltGr_Row_4_ID_6] Type=VirtualKey Label= KeyCode=0 [Key_AltGr_Row_4_ID_7] Type=VirtualKey Label= KeyCode=0 [Key_AltGr_Row_4_ID_8] Type=VirtualKey Label= KeyCode=0 [Key_AltGr_Row_4_ID_9] Type=VirtualKey Label= KeyCode=0 [Key_AltGr_Row_4_ID_10] Type=VirtualKey Label= KeyCode=0 [Key_AltGr_Row_4_ID_11] Type=VirtualKey Label= KeyCode=0 [Key_AltGr_Row_4_ID_12] Type=String Label= String= [Key_AltGr_Row_4_ID_13] Type=VirtualKeyIsoEnter Width=125 Label=Enter KeyCode=13 [Key_AltGr_Row_4_ID_14] Type=Blank Width=325 Cluster=Navigation [Key_AltGr_Row_4_ID_15] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_4_ID_16] Type=VirtualKey Label=4 Cluster=Numpad KeyCode=100 [Key_AltGr_Row_4_ID_17] Type=VirtualKey Label=5 Cluster=Numpad KeyCode=101 [Key_AltGr_Row_4_ID_18] Type=VirtualKey Label=6 Cluster=Numpad KeyCode=102 [Key_AltGr_Row_5_ID_0] Type=VirtualKeyToggle Width=125 Label=Shift KeyCode=160 NoRepeat=true [Key_AltGr_Row_5_ID_1] Type=String Label=\ String=\ [Key_AltGr_Row_5_ID_2] Type=VirtualKey Label= KeyCode=0 [Key_AltGr_Row_5_ID_3] Type=VirtualKey Label= KeyCode=0 [Key_AltGr_Row_5_ID_4] Type=VirtualKey Label= KeyCode=0 [Key_AltGr_Row_5_ID_5] Type=VirtualKey Label= KeyCode=0 [Key_AltGr_Row_5_ID_6] Type=VirtualKey Label= KeyCode=0 [Key_AltGr_Row_5_ID_7] Type=VirtualKey Label= KeyCode=0 [Key_AltGr_Row_5_ID_8] Type=VirtualKey Label= KeyCode=0 [Key_AltGr_Row_5_ID_9] Type=String Label= String= [Key_AltGr_Row_5_ID_10] Type=String Label= String= [Key_AltGr_Row_5_ID_11] Type=String Label= String= [Key_AltGr_Row_5_ID_12] Type=VirtualKeyToggle Width=275 Label=Shift KeyCode=161 NoRepeat=true [Key_AltGr_Row_5_ID_13] Type=Blank Width=125 Cluster=Navigation [Key_AltGr_Row_5_ID_14] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_AltGr_Row_5_ID_15] Type=Blank Cluster=Navigation [Key_AltGr_Row_5_ID_16] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_5_ID_17] Type=VirtualKey Label=1 Cluster=Numpad KeyCode=97 [Key_AltGr_Row_5_ID_18] Type=VirtualKey Label=2 Cluster=Numpad KeyCode=98 [Key_AltGr_Row_5_ID_19] Type=VirtualKey Label=3 Cluster=Numpad KeyCode=99 [Key_AltGr_Row_5_ID_20] Type=VirtualKey Height=200 Label=Enter Cluster=Numpad KeyCode=13 [Key_AltGr_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=162 NoRepeat=true [Key_AltGr_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_AltGr_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_AltGr_Row_6_ID_3] Type=VirtualKey Width=625 Label= KeyCode=32 [Key_AltGr_Row_6_ID_4] Type=VirtualKeyToggle Width=125 Label=AltGr KeyCode=165 NoRepeat=true [Key_AltGr_Row_6_ID_5] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_AltGr_Row_6_ID_6] Type=VirtualKey Width=125 Label=Menu KeyCode=93 NoRepeat=true [Key_AltGr_Row_6_ID_7] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=163 NoRepeat=true [Key_AltGr_Row_6_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_AltGr_Row_6_ID_9] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_AltGr_Row_6_ID_10] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_AltGr_Row_6_ID_11] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_AltGr_Row_6_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_6_ID_13] Type=VirtualKey Width=200 Label=0 Cluster=Numpad KeyCode=96 [Key_AltGr_Row_6_ID_14] Type=VirtualKey Label=. Cluster=Numpad KeyCode=110 ================================================ FILE: assets/keyboards/qwerty_es.ini ================================================ [LayoutInfo] Name=QWERTY (Spain) Author= HasAltGr=true HasClusterFunction=true HasClusterNavigation=true HasClusterNumpad=true HasClusterExtra=true [Key_Base_Row_0_ID_0] Type=VirtualKey Label=Esc Cluster=Function KeyCode=27 NoRepeat=true [Key_Base_Row_0_ID_1] Type=Blank Cluster=Function [Key_Base_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_Base_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_Base_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_Base_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_Base_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_Base_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_Base_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_Base_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_Base_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_Base_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_Base_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_Base_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_Base_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_Base_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_Base_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_Base_Row_0_ID_17] Type=VirtualKey Label=Impr\nPant Cluster=Function KeyCode=44 NoRepeat=true [Key_Base_Row_0_ID_18] Type=VirtualKey Label=Bloq\nDespl Cluster=Function KeyCode=145 NoRepeat=true [Key_Base_Row_0_ID_19] Type=VirtualKey Label=Pausa Cluster=Function KeyCode=19 NoRepeat=true [Key_Base_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_Base_Row_0_ID_21] Type=VirtualKey Label=⏯ Cluster=Extra KeyCode=179 NoRepeat=true [Key_Base_Row_0_ID_22] Type=VirtualKey Label=◼ Cluster=Extra KeyCode=178 NoRepeat=true [Key_Base_Row_0_ID_23] Type=VirtualKey Label=⏮ Cluster=Extra KeyCode=177 NoRepeat=true [Key_Base_Row_0_ID_24] Type=VirtualKey Label=⏭ Cluster=Extra KeyCode=176 NoRepeat=true [Key_Base_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_Base_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra [Key_Base_Row_2_ID_0] Type=String Label=º String=º [Key_Base_Row_2_ID_1] Type=VirtualKey Label=1 KeyCode=49 [Key_Base_Row_2_ID_2] Type=VirtualKey Label=2 KeyCode=50 [Key_Base_Row_2_ID_3] Type=VirtualKey Label=3 KeyCode=51 [Key_Base_Row_2_ID_4] Type=VirtualKey Label=4 KeyCode=52 [Key_Base_Row_2_ID_5] Type=VirtualKey Label=5 KeyCode=53 [Key_Base_Row_2_ID_6] Type=VirtualKey Label=6 KeyCode=54 [Key_Base_Row_2_ID_7] Type=VirtualKey Label=7 KeyCode=55 [Key_Base_Row_2_ID_8] Type=VirtualKey Label=8 KeyCode=56 [Key_Base_Row_2_ID_9] Type=VirtualKey Label=9 KeyCode=57 [Key_Base_Row_2_ID_10] Type=VirtualKey Label=0 KeyCode=48 [Key_Base_Row_2_ID_11] Type=String Label=' String=' [Key_Base_Row_2_ID_12] Type=String Label=¡ String=¡ [Key_Base_Row_2_ID_13] Type=VirtualKey Width=200 Label=⟵ KeyCode=8 [Key_Base_Row_2_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_2_ID_15] Type=VirtualKey Label=Insert Cluster=Navigation KeyCode=45 [Key_Base_Row_2_ID_16] Type=VirtualKey Label=Incio Cluster=Navigation KeyCode=36 [Key_Base_Row_2_ID_17] Type=VirtualKey Label=RePág Cluster=Navigation KeyCode=33 [Key_Base_Row_2_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_2_ID_19] Type=VirtualKey Label=Bloq\nNum Cluster=Numpad KeyCode=144 NoRepeat=true [Key_Base_Row_2_ID_20] Type=VirtualKey Label=/ Cluster=Numpad KeyCode=111 [Key_Base_Row_2_ID_21] Type=VirtualKey Label=* Cluster=Numpad KeyCode=106 [Key_Base_Row_2_ID_22] Type=VirtualKey Label=- Cluster=Numpad KeyCode=109 [Key_Base_Row_3_ID_0] Type=VirtualKey Width=150 Label=⭾ KeyCode=9 [Key_Base_Row_3_ID_1] Type=VirtualKey Label=q KeyCode=81 [Key_Base_Row_3_ID_2] Type=VirtualKey Label=w KeyCode=87 [Key_Base_Row_3_ID_3] Type=VirtualKey Label=e KeyCode=69 [Key_Base_Row_3_ID_4] Type=VirtualKey Label=r KeyCode=82 [Key_Base_Row_3_ID_5] Type=VirtualKey Label=t KeyCode=84 [Key_Base_Row_3_ID_6] Type=VirtualKey Label=y KeyCode=89 [Key_Base_Row_3_ID_7] Type=VirtualKey Label=u KeyCode=85 [Key_Base_Row_3_ID_8] Type=VirtualKey Label=i KeyCode=73 [Key_Base_Row_3_ID_9] Type=VirtualKey Label=o KeyCode=79 [Key_Base_Row_3_ID_10] Type=VirtualKey Label=p KeyCode=80 [Key_Base_Row_3_ID_11] Type=String Label=` String=` [Key_Base_Row_3_ID_12] Type=String Label=+ String=+ [Key_Base_Row_3_ID_13] Type=VirtualKeyIsoEnter Width=150 Label= KeyCode=13 [Key_Base_Row_3_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_3_ID_15] Type=VirtualKey Label=Supr Cluster=Navigation KeyCode=46 [Key_Base_Row_3_ID_16] Type=VirtualKey Label=Fin Cluster=Navigation KeyCode=35 [Key_Base_Row_3_ID_17] Type=VirtualKey Label=AvPág Cluster=Navigation KeyCode=34 [Key_Base_Row_3_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_3_ID_19] Type=VirtualKey Label=7 Cluster=Numpad KeyCode=103 [Key_Base_Row_3_ID_20] Type=VirtualKey Label=8 Cluster=Numpad KeyCode=104 [Key_Base_Row_3_ID_21] Type=VirtualKey Label=9 Cluster=Numpad KeyCode=105 [Key_Base_Row_3_ID_22] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 [Key_Base_Row_4_ID_0] Type=VirtualKey Width=175 Label=Bloq Mayús KeyCode=20 NoRepeat=true [Key_Base_Row_4_ID_1] Type=VirtualKey Label=a KeyCode=65 [Key_Base_Row_4_ID_2] Type=VirtualKey Label=s KeyCode=83 [Key_Base_Row_4_ID_3] Type=VirtualKey Label=d KeyCode=68 [Key_Base_Row_4_ID_4] Type=VirtualKey Label=f KeyCode=70 [Key_Base_Row_4_ID_5] Type=VirtualKey Label=g KeyCode=71 [Key_Base_Row_4_ID_6] Type=VirtualKey Label=h KeyCode=72 [Key_Base_Row_4_ID_7] Type=VirtualKey Label=j KeyCode=74 [Key_Base_Row_4_ID_8] Type=VirtualKey Label=k KeyCode=75 [Key_Base_Row_4_ID_9] Type=VirtualKey Label=l KeyCode=76 [Key_Base_Row_4_ID_10] Type=String Label=ñ String=ñ [Key_Base_Row_4_ID_11] Type=String Label=´ String=´ [Key_Base_Row_4_ID_12] Type=String Label=ç String=ç [Key_Base_Row_4_ID_13] Type=VirtualKeyIsoEnter Width=125 Label=↵ KeyCode=13 [Key_Base_Row_4_ID_14] Type=Blank Width=325 Cluster=Navigation [Key_Base_Row_4_ID_15] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_4_ID_16] Type=VirtualKey Label=4 Cluster=Numpad KeyCode=100 [Key_Base_Row_4_ID_17] Type=VirtualKey Label=5 Cluster=Numpad KeyCode=101 [Key_Base_Row_4_ID_18] Type=VirtualKey Label=6 Cluster=Numpad KeyCode=102 [Key_Base_Row_5_ID_0] Type=VirtualKeyToggle Width=125 Label=🡅 KeyCode=160 NoRepeat=true [Key_Base_Row_5_ID_1] Type=String Label=< String=< [Key_Base_Row_5_ID_2] Type=VirtualKey Label=z KeyCode=90 [Key_Base_Row_5_ID_3] Type=VirtualKey Label=x KeyCode=88 [Key_Base_Row_5_ID_4] Type=VirtualKey Label=c KeyCode=67 [Key_Base_Row_5_ID_5] Type=VirtualKey Label=v KeyCode=86 [Key_Base_Row_5_ID_6] Type=VirtualKey Label=b KeyCode=66 [Key_Base_Row_5_ID_7] Type=VirtualKey Label=n KeyCode=78 [Key_Base_Row_5_ID_8] Type=VirtualKey Label=m KeyCode=77 [Key_Base_Row_5_ID_9] Type=String Label=, String=, [Key_Base_Row_5_ID_10] Type=String Label=. String=. [Key_Base_Row_5_ID_11] Type=String Label=- String=- [Key_Base_Row_5_ID_12] Type=VirtualKeyToggle Width=275 Label=🡅 KeyCode=161 NoRepeat=true [Key_Base_Row_5_ID_13] Type=Blank Width=125 Cluster=Navigation [Key_Base_Row_5_ID_14] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_Base_Row_5_ID_15] Type=Blank Cluster=Navigation [Key_Base_Row_5_ID_16] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_5_ID_17] Type=VirtualKey Label=1 Cluster=Numpad KeyCode=97 [Key_Base_Row_5_ID_18] Type=VirtualKey Label=2 Cluster=Numpad KeyCode=98 [Key_Base_Row_5_ID_19] Type=VirtualKey Label=3 Cluster=Numpad KeyCode=99 [Key_Base_Row_5_ID_20] Type=VirtualKey Height=200 Label=Intro Cluster=Numpad KeyCode=13 [Key_Base_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=162 NoRepeat=true [Key_Base_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_Base_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_Base_Row_6_ID_3] Type=VirtualKey Width=625 Label= KeyCode=32 [Key_Base_Row_6_ID_4] Type=VirtualKeyToggle Width=125 Label=AltGr KeyCode=165 NoRepeat=true [Key_Base_Row_6_ID_5] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_Base_Row_6_ID_6] Type=VirtualKey Width=125 Label=Menu KeyCode=93 NoRepeat=true [Key_Base_Row_6_ID_7] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=163 NoRepeat=true [Key_Base_Row_6_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_6_ID_9] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_Base_Row_6_ID_10] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_Base_Row_6_ID_11] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_Base_Row_6_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_6_ID_13] Type=VirtualKey Width=200 Label=0 Cluster=Numpad KeyCode=96 [Key_Base_Row_6_ID_14] Type=VirtualKey Label=. Cluster=Numpad KeyCode=110 [Key_Shift_Row_0_ID_0] Type=VirtualKey Label=Esc Cluster=Function KeyCode=27 NoRepeat=true [Key_Shift_Row_0_ID_1] Type=Blank Cluster=Function [Key_Shift_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_Shift_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_Shift_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_Shift_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_Shift_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_Shift_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_Shift_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_Shift_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_Shift_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_Shift_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_Shift_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_Shift_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_Shift_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_Shift_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_Shift_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_Shift_Row_0_ID_17] Type=VirtualKey Label=Impr\nPant Cluster=Function KeyCode=44 NoRepeat=true [Key_Shift_Row_0_ID_18] Type=VirtualKey Label=Bloq\nDespl Cluster=Function KeyCode=145 NoRepeat=true [Key_Shift_Row_0_ID_19] Type=VirtualKey Label=Pausa Cluster=Function KeyCode=19 NoRepeat=true [Key_Shift_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_Shift_Row_0_ID_21] Type=VirtualKey Label=🡰 Cluster=Extra KeyCode=166 NoRepeat=true [Key_Shift_Row_0_ID_22] Type=VirtualKey Label=🡲 Cluster=Extra KeyCode=167 NoRepeat=true [Key_Shift_Row_0_ID_23] Type=VirtualKey Label=🔇 Cluster=Extra KeyCode=173 NoRepeat=true [Key_Shift_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_Shift_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra [Key_Shift_Row_2_ID_0] Type=String Label=ª String=ª [Key_Shift_Row_2_ID_1] Type=String Label=! String=! [Key_Shift_Row_2_ID_2] Type=String Label=" String=" [Key_Shift_Row_2_ID_3] Type=String Label=· String=· [Key_Shift_Row_2_ID_4] Type=String Label=$ String=$ [Key_Shift_Row_2_ID_5] Type=String Label=% String=% [Key_Shift_Row_2_ID_6] Type=String Label=& String=& [Key_Shift_Row_2_ID_7] Type=String Label=/ String=/ [Key_Shift_Row_2_ID_8] Type=String Label=( String=( [Key_Shift_Row_2_ID_9] Type=String Label=) String=) [Key_Shift_Row_2_ID_10] Type=String Label== String== [Key_Shift_Row_2_ID_11] Type=String Label=? String=? [Key_Shift_Row_2_ID_12] Type=String Label=¿ String=¿ [Key_Shift_Row_2_ID_13] Type=VirtualKey Width=200 Label=⟵ KeyCode=8 [Key_Shift_Row_2_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_2_ID_15] Type=VirtualKey Label=Insert Cluster=Navigation KeyCode=45 [Key_Shift_Row_2_ID_16] Type=VirtualKey Label=Incio Cluster=Navigation KeyCode=36 [Key_Shift_Row_2_ID_17] Type=VirtualKey Label=RePág Cluster=Navigation KeyCode=33 [Key_Shift_Row_2_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_2_ID_19] Type=VirtualKey Label=Bloq\nNum Cluster=Numpad KeyCode=144 NoRepeat=true [Key_Shift_Row_2_ID_20] Type=VirtualKey Label=/ Cluster=Numpad KeyCode=111 [Key_Shift_Row_2_ID_21] Type=VirtualKey Label=* Cluster=Numpad KeyCode=106 [Key_Shift_Row_2_ID_22] Type=VirtualKey Label=- Cluster=Numpad KeyCode=109 [Key_Shift_Row_3_ID_0] Type=VirtualKey Width=150 Label=⭾ KeyCode=9 [Key_Shift_Row_3_ID_1] Type=VirtualKey Label=Q KeyCode=81 [Key_Shift_Row_3_ID_2] Type=VirtualKey Label=W KeyCode=87 [Key_Shift_Row_3_ID_3] Type=VirtualKey Label=E KeyCode=69 [Key_Shift_Row_3_ID_4] Type=VirtualKey Label=R KeyCode=82 [Key_Shift_Row_3_ID_5] Type=VirtualKey Label=T KeyCode=84 [Key_Shift_Row_3_ID_6] Type=VirtualKey Label=Y KeyCode=89 [Key_Shift_Row_3_ID_7] Type=VirtualKey Label=U KeyCode=85 [Key_Shift_Row_3_ID_8] Type=VirtualKey Label=I KeyCode=73 [Key_Shift_Row_3_ID_9] Type=VirtualKey Label=O KeyCode=79 [Key_Shift_Row_3_ID_10] Type=VirtualKey Label=P KeyCode=80 [Key_Shift_Row_3_ID_11] Type=String Label=^ String=^ [Key_Shift_Row_3_ID_12] Type=String Label=* String=* [Key_Shift_Row_3_ID_13] Type=VirtualKeyIsoEnter Width=150 Label= KeyCode=13 [Key_Shift_Row_3_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_3_ID_15] Type=VirtualKey Label=Supr Cluster=Navigation KeyCode=46 [Key_Shift_Row_3_ID_16] Type=VirtualKey Label=Fin Cluster=Navigation KeyCode=35 [Key_Shift_Row_3_ID_17] Type=VirtualKey Label=AvPág Cluster=Navigation KeyCode=34 [Key_Shift_Row_3_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_3_ID_19] Type=VirtualKey Label=7 Cluster=Numpad KeyCode=103 [Key_Shift_Row_3_ID_20] Type=VirtualKey Label=8 Cluster=Numpad KeyCode=104 [Key_Shift_Row_3_ID_21] Type=VirtualKey Label=9 Cluster=Numpad KeyCode=105 [Key_Shift_Row_3_ID_22] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 [Key_Shift_Row_4_ID_0] Type=VirtualKey Width=175 Label=Bloq Mayús KeyCode=20 NoRepeat=true [Key_Shift_Row_4_ID_1] Type=VirtualKey Label=A KeyCode=65 [Key_Shift_Row_4_ID_2] Type=VirtualKey Label=S KeyCode=83 [Key_Shift_Row_4_ID_3] Type=VirtualKey Label=D KeyCode=68 [Key_Shift_Row_4_ID_4] Type=VirtualKey Label=F KeyCode=70 [Key_Shift_Row_4_ID_5] Type=VirtualKey Label=G KeyCode=71 [Key_Shift_Row_4_ID_6] Type=VirtualKey Label=H KeyCode=72 [Key_Shift_Row_4_ID_7] Type=VirtualKey Label=J KeyCode=74 [Key_Shift_Row_4_ID_8] Type=VirtualKey Label=K KeyCode=75 [Key_Shift_Row_4_ID_9] Type=VirtualKey Label=L KeyCode=76 [Key_Shift_Row_4_ID_10] Type=String Label=Ñ String=Ñ [Key_Shift_Row_4_ID_11] Type=String Label=¨ String=¨ [Key_Shift_Row_4_ID_12] Type=String Label=Ç String=Ç [Key_Shift_Row_4_ID_13] Type=VirtualKeyIsoEnter Width=125 Label=↵ KeyCode=13 [Key_Shift_Row_4_ID_14] Type=Blank Width=325 Cluster=Navigation [Key_Shift_Row_4_ID_15] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_4_ID_16] Type=VirtualKey Label=4 Cluster=Numpad KeyCode=100 [Key_Shift_Row_4_ID_17] Type=VirtualKey Label=5 Cluster=Numpad KeyCode=101 [Key_Shift_Row_4_ID_18] Type=VirtualKey Label=6 Cluster=Numpad KeyCode=102 [Key_Shift_Row_5_ID_0] Type=VirtualKeyToggle Width=125 Label=🡅 KeyCode=160 NoRepeat=true [Key_Shift_Row_5_ID_1] Type=String Label=> String=> [Key_Shift_Row_5_ID_2] Type=VirtualKey Label=Z KeyCode=90 [Key_Shift_Row_5_ID_3] Type=VirtualKey Label=X KeyCode=88 [Key_Shift_Row_5_ID_4] Type=VirtualKey Label=C KeyCode=67 [Key_Shift_Row_5_ID_5] Type=VirtualKey Label=V KeyCode=86 [Key_Shift_Row_5_ID_6] Type=VirtualKey Label=B KeyCode=66 [Key_Shift_Row_5_ID_7] Type=VirtualKey Label=N KeyCode=78 [Key_Shift_Row_5_ID_8] Type=VirtualKey Label=M KeyCode=77 [Key_Shift_Row_5_ID_9] Type=String Label=; String=; [Key_Shift_Row_5_ID_10] Type=String Label=: String=: [Key_Shift_Row_5_ID_11] Type=String Label=_ String=_ [Key_Shift_Row_5_ID_12] Type=VirtualKeyToggle Width=275 Label=🡅 KeyCode=161 NoRepeat=true [Key_Shift_Row_5_ID_13] Type=Blank Width=125 Cluster=Navigation [Key_Shift_Row_5_ID_14] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_Shift_Row_5_ID_15] Type=Blank Cluster=Navigation [Key_Shift_Row_5_ID_16] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_5_ID_17] Type=VirtualKey Label=1 Cluster=Numpad KeyCode=97 [Key_Shift_Row_5_ID_18] Type=VirtualKey Label=2 Cluster=Numpad KeyCode=98 [Key_Shift_Row_5_ID_19] Type=VirtualKey Label=3 Cluster=Numpad KeyCode=99 [Key_Shift_Row_5_ID_20] Type=VirtualKey Height=200 Label=Intro Cluster=Numpad KeyCode=13 [Key_Shift_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=162 NoRepeat=true [Key_Shift_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_Shift_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_Shift_Row_6_ID_3] Type=VirtualKey Width=625 Label= KeyCode=32 [Key_Shift_Row_6_ID_4] Type=VirtualKeyToggle Width=125 Label=AltGr KeyCode=165 NoRepeat=true [Key_Shift_Row_6_ID_5] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_Shift_Row_6_ID_6] Type=VirtualKey Width=125 Label=Menu KeyCode=93 NoRepeat=true [Key_Shift_Row_6_ID_7] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=163 NoRepeat=true [Key_Shift_Row_6_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_6_ID_9] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_Shift_Row_6_ID_10] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_Shift_Row_6_ID_11] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_Shift_Row_6_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_6_ID_13] Type=VirtualKey Width=200 Label=0 Cluster=Numpad KeyCode=96 [Key_Shift_Row_6_ID_14] Type=VirtualKey Label=. Cluster=Numpad KeyCode=110 [Key_AltGr_Row_0_ID_0] Type=VirtualKey Label=Esc Cluster=Function KeyCode=27 NoRepeat=true [Key_AltGr_Row_0_ID_1] Type=Blank Cluster=Function [Key_AltGr_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_AltGr_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_AltGr_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_AltGr_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_AltGr_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_AltGr_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_AltGr_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_AltGr_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_AltGr_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_AltGr_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_AltGr_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_AltGr_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_AltGr_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_AltGr_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_AltGr_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_AltGr_Row_0_ID_17] Type=VirtualKey Label=Impr\nPant Cluster=Function KeyCode=44 NoRepeat=true [Key_AltGr_Row_0_ID_18] Type=VirtualKey Label=Bloq\nDespl Cluster=Function KeyCode=145 NoRepeat=true [Key_AltGr_Row_0_ID_19] Type=VirtualKey Label=Pausa Cluster=Function KeyCode=19 NoRepeat=true [Key_AltGr_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_AltGr_Row_0_ID_21] Type=VirtualKey Label=⏯ Cluster=Extra KeyCode=179 NoRepeat=true [Key_AltGr_Row_0_ID_22] Type=VirtualKey Label=◼ Cluster=Extra KeyCode=178 NoRepeat=true [Key_AltGr_Row_0_ID_23] Type=VirtualKey Label=⏮ Cluster=Extra KeyCode=177 NoRepeat=true [Key_AltGr_Row_0_ID_24] Type=VirtualKey Label=⏭ Cluster=Extra KeyCode=176 NoRepeat=true [Key_AltGr_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_AltGr_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra [Key_AltGr_Row_2_ID_0] Type=String Label=\ String=\ [Key_AltGr_Row_2_ID_1] Type=String Label=| String=| [Key_AltGr_Row_2_ID_2] Type=String Label=@ String=@ [Key_AltGr_Row_2_ID_3] Type=String Label=# String=# [Key_AltGr_Row_2_ID_4] Type=String Label=~ String=~ [Key_AltGr_Row_2_ID_5] Type=Blank [Key_AltGr_Row_2_ID_6] Type=String Label=¬ String=¬ [Key_AltGr_Row_2_ID_7] Type=Blank Width=600 [Key_AltGr_Row_2_ID_8] Type=VirtualKey Width=200 Label=⟵ KeyCode=8 [Key_AltGr_Row_2_ID_9] Type=Blank Width=25 Cluster=Navigation [Key_AltGr_Row_2_ID_10] Type=VirtualKey Label=Insert Cluster=Navigation KeyCode=45 [Key_AltGr_Row_2_ID_11] Type=VirtualKey Label=Incio Cluster=Navigation KeyCode=36 [Key_AltGr_Row_2_ID_12] Type=VirtualKey Label=RePág Cluster=Navigation KeyCode=33 [Key_AltGr_Row_2_ID_13] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_2_ID_14] Type=VirtualKey Label=Bloq\nNum Cluster=Numpad KeyCode=144 NoRepeat=true [Key_AltGr_Row_2_ID_15] Type=VirtualKey Label=/ Cluster=Numpad KeyCode=111 [Key_AltGr_Row_2_ID_16] Type=VirtualKey Label=* Cluster=Numpad KeyCode=106 [Key_AltGr_Row_2_ID_17] Type=VirtualKey Label=- Cluster=Numpad KeyCode=109 [Key_AltGr_Row_3_ID_0] Type=VirtualKey Width=150 Label=⭾ KeyCode=9 [Key_AltGr_Row_3_ID_1] Type=Blank Width=200 [Key_AltGr_Row_3_ID_2] Type=String Label=€ String=€ [Key_AltGr_Row_3_ID_3] Type=Blank Width=700 [Key_AltGr_Row_3_ID_4] Type=String Label=[ String=[ [Key_AltGr_Row_3_ID_5] Type=String Label=] String=] [Key_AltGr_Row_3_ID_6] Type=VirtualKeyIsoEnter Width=150 Label= KeyCode=13 [Key_AltGr_Row_3_ID_7] Type=Blank Width=25 Cluster=Navigation [Key_AltGr_Row_3_ID_8] Type=VirtualKey Label=Supr Cluster=Navigation KeyCode=46 [Key_AltGr_Row_3_ID_9] Type=VirtualKey Label=Fin Cluster=Navigation KeyCode=35 [Key_AltGr_Row_3_ID_10] Type=VirtualKey Label=AvPág Cluster=Navigation KeyCode=34 [Key_AltGr_Row_3_ID_11] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_3_ID_12] Type=VirtualKey Label=7 Cluster=Numpad KeyCode=103 [Key_AltGr_Row_3_ID_13] Type=VirtualKey Label=8 Cluster=Numpad KeyCode=104 [Key_AltGr_Row_3_ID_14] Type=VirtualKey Label=9 Cluster=Numpad KeyCode=105 [Key_AltGr_Row_3_ID_15] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 [Key_AltGr_Row_4_ID_0] Type=VirtualKey Width=175 Label=Bloq Mayús KeyCode=20 NoRepeat=true [Key_AltGr_Row_4_ID_1] Type=Blank Width=1000 [Key_AltGr_Row_4_ID_2] Type=String Label={ String={ [Key_AltGr_Row_4_ID_3] Type=String Label=} String=} [Key_AltGr_Row_4_ID_4] Type=VirtualKeyIsoEnter Width=125 Label=↵ KeyCode=13 [Key_AltGr_Row_4_ID_5] Type=Blank Width=325 Cluster=Navigation [Key_AltGr_Row_4_ID_6] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_4_ID_7] Type=VirtualKey Label=4 Cluster=Numpad KeyCode=100 [Key_AltGr_Row_4_ID_8] Type=VirtualKey Label=5 Cluster=Numpad KeyCode=101 [Key_AltGr_Row_4_ID_9] Type=VirtualKey Label=6 Cluster=Numpad KeyCode=102 [Key_AltGr_Row_5_ID_0] Type=VirtualKeyToggle Width=125 Label=🡅 KeyCode=160 NoRepeat=true [Key_AltGr_Row_5_ID_1] Type=Blank Width=1100 [Key_AltGr_Row_5_ID_2] Type=VirtualKeyToggle Width=275 Label=🡅 KeyCode=161 NoRepeat=true [Key_AltGr_Row_5_ID_3] Type=Blank Width=125 Cluster=Navigation [Key_AltGr_Row_5_ID_4] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_AltGr_Row_5_ID_5] Type=Blank Cluster=Navigation [Key_AltGr_Row_5_ID_6] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_5_ID_7] Type=VirtualKey Label=1 Cluster=Numpad KeyCode=97 [Key_AltGr_Row_5_ID_8] Type=VirtualKey Label=2 Cluster=Numpad KeyCode=98 [Key_AltGr_Row_5_ID_9] Type=VirtualKey Label=3 Cluster=Numpad KeyCode=99 [Key_AltGr_Row_5_ID_10] Type=VirtualKey Height=200 Label=Intro Cluster=Numpad KeyCode=13 [Key_AltGr_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=162 NoRepeat=true [Key_AltGr_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_AltGr_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_AltGr_Row_6_ID_3] Type=VirtualKey Width=625 Label= KeyCode=32 [Key_AltGr_Row_6_ID_4] Type=VirtualKeyToggle Width=125 Label=AltGr KeyCode=165 NoRepeat=true [Key_AltGr_Row_6_ID_5] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_AltGr_Row_6_ID_6] Type=VirtualKey Width=125 Label=Menu KeyCode=93 NoRepeat=true [Key_AltGr_Row_6_ID_7] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=163 NoRepeat=true [Key_AltGr_Row_6_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_AltGr_Row_6_ID_9] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_AltGr_Row_6_ID_10] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_AltGr_Row_6_ID_11] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_AltGr_Row_6_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_6_ID_13] Type=VirtualKey Width=200 Label=0 Cluster=Numpad KeyCode=96 [Key_AltGr_Row_6_ID_14] Type=VirtualKey Label=. Cluster=Numpad KeyCode=110 ================================================ FILE: assets/keyboards/qwerty_ja.ini ================================================ [LayoutInfo] Name=QWERTY (Japanese JIS-set) Author=Shimotuki Rieru HasAltGr=false HasClusterFunction=true HasClusterNavigation=true HasClusterNumpad=true HasClusterExtra=true [Key_Base_Row_0_ID_0] Type=VirtualKey Label=Esc Cluster=Function KeyCode=27 NoRepeat=true [Key_Base_Row_0_ID_1] Type=Blank Cluster=Function [Key_Base_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_Base_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_Base_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_Base_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_Base_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_Base_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_Base_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_Base_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_Base_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_Base_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_Base_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_Base_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_Base_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_Base_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_Base_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_Base_Row_0_ID_17] Type=VirtualKey Label=Print\nScreen Cluster=Function KeyCode=44 NoRepeat=true [Key_Base_Row_0_ID_18] Type=VirtualKey Label=Scroll\nLock Cluster=Function KeyCode=145 NoRepeat=true [Key_Base_Row_0_ID_19] Type=VirtualKey Label=Pause Cluster=Function KeyCode=19 NoRepeat=true [Key_Base_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_Base_Row_0_ID_21] Type=VirtualKey Label=⏯ Cluster=Extra KeyCode=179 NoRepeat=true [Key_Base_Row_0_ID_22] Type=VirtualKey Label=◼ Cluster=Extra KeyCode=178 NoRepeat=true [Key_Base_Row_0_ID_23] Type=VirtualKey Label=⏮ Cluster=Extra KeyCode=177 NoRepeat=true [Key_Base_Row_0_ID_24] Type=VirtualKey Label=⏭ Cluster=Extra KeyCode=176 NoRepeat=true [Key_Base_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_Base_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra [Key_Base_Row_2_ID_0] Type=VirtualKey Label=半角/##L\n全角##L\n漢字##L KeyCode=25 [Key_Base_Row_2_ID_1] Type=VirtualKey Label=1##L\nぬ##R KeyCode=49 [Key_Base_Row_2_ID_2] Type=VirtualKey Label=2##L\nふ##R KeyCode=50 [Key_Base_Row_2_ID_3] Type=VirtualKey Label=3##L\nあ##R KeyCode=51 [Key_Base_Row_2_ID_4] Type=VirtualKey Label=4##L\nう##R KeyCode=52 [Key_Base_Row_2_ID_5] Type=VirtualKey Label=5##L\nえ##R KeyCode=53 [Key_Base_Row_2_ID_6] Type=VirtualKey Label=6##L\nお##R KeyCode=54 [Key_Base_Row_2_ID_7] Type=VirtualKey Label=7##L\nや##R KeyCode=55 [Key_Base_Row_2_ID_8] Type=VirtualKey Label=8##L\nゆ##R KeyCode=56 [Key_Base_Row_2_ID_9] Type=VirtualKey Label=9##L\nよ##R KeyCode=57 [Key_Base_Row_2_ID_10] Type=VirtualKey Label=0##L\nわ##R KeyCode=48 [Key_Base_Row_2_ID_11] Type=String Label=-##L\nほ##R String=- [Key_Base_Row_2_ID_12] Type=String Label=^##L\nへ##R String=^ [Key_Base_Row_2_ID_13] Type=VirtualKey Label=￥##L\n KeyCode=220 [Key_Base_Row_2_ID_14] Type=VirtualKey Label=Back\nspace KeyCode=8 [Key_Base_Row_2_ID_15] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_2_ID_16] Type=VirtualKey Label=Insert Cluster=Navigation KeyCode=45 [Key_Base_Row_2_ID_17] Type=VirtualKey Label=Home Cluster=Navigation KeyCode=36 [Key_Base_Row_2_ID_18] Type=VirtualKey Label=PgUp Cluster=Navigation KeyCode=33 [Key_Base_Row_2_ID_19] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_2_ID_20] Type=VirtualKey Label=Num\nLock Cluster=Numpad KeyCode=144 NoRepeat=true [Key_Base_Row_2_ID_21] Type=VirtualKey Label=/ Cluster=Numpad KeyCode=111 [Key_Base_Row_2_ID_22] Type=VirtualKey Label=* Cluster=Numpad KeyCode=106 [Key_Base_Row_2_ID_23] Type=VirtualKey Label=- Cluster=Numpad KeyCode=109 [Key_Base_Row_3_ID_0] Type=VirtualKey Width=150 Label=Tab KeyCode=9 [Key_Base_Row_3_ID_1] Type=VirtualKey Label=q##L\nた##R KeyCode=81 [Key_Base_Row_3_ID_2] Type=VirtualKey Label=w##L\nて##R KeyCode=87 [Key_Base_Row_3_ID_3] Type=VirtualKey Label=e##L\nい##R KeyCode=69 [Key_Base_Row_3_ID_4] Type=VirtualKey Label=r##L\nす##R KeyCode=82 [Key_Base_Row_3_ID_5] Type=VirtualKey Label=t##L\nか##R KeyCode=84 [Key_Base_Row_3_ID_6] Type=VirtualKey Label=y##L\nん##R KeyCode=89 [Key_Base_Row_3_ID_7] Type=VirtualKey Label=u##L\nな##R KeyCode=85 [Key_Base_Row_3_ID_8] Type=VirtualKey Label=i##L\nに##R KeyCode=73 [Key_Base_Row_3_ID_9] Type=VirtualKey Label=o##L\nら##R KeyCode=79 [Key_Base_Row_3_ID_10] Type=VirtualKey Label=p##L\nせ##R KeyCode=80 [Key_Base_Row_3_ID_11] Type=String Label=@##L\n String=@ [Key_Base_Row_3_ID_12] Type=String Label=[ 「##L\n String=[ [Key_Base_Row_3_ID_13] Type=VirtualKeyIsoEnter Width=150 Label= KeyCode=13 [Key_Base_Row_3_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_3_ID_15] Type=VirtualKey Label=Delete Cluster=Navigation KeyCode=46 [Key_Base_Row_3_ID_16] Type=VirtualKey Label=End Cluster=Navigation KeyCode=35 [Key_Base_Row_3_ID_17] Type=VirtualKey Label=PgDn Cluster=Navigation KeyCode=34 [Key_Base_Row_3_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_3_ID_19] Type=VirtualKey Label=7\nHome Cluster=Numpad KeyCode=103 [Key_Base_Row_3_ID_20] Type=VirtualKey Label=8\n↑ Cluster=Numpad KeyCode=104 [Key_Base_Row_3_ID_21] Type=VirtualKey Label=9\nPgUp Cluster=Numpad KeyCode=105 [Key_Base_Row_3_ID_22] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 [Key_Base_Row_4_ID_0] Type=VirtualKey Width=175 Label=Caps Lock KeyCode=20 NoRepeat=true [Key_Base_Row_4_ID_1] Type=VirtualKey Label=a##L\nち##R KeyCode=65 [Key_Base_Row_4_ID_2] Type=VirtualKey Label=s##L\nと##R KeyCode=83 [Key_Base_Row_4_ID_3] Type=VirtualKey Label=d##L\nし##R KeyCode=68 [Key_Base_Row_4_ID_4] Type=VirtualKey Label=f##L\nは##R KeyCode=70 [Key_Base_Row_4_ID_5] Type=VirtualKey Label=g##L\nき##R KeyCode=71 [Key_Base_Row_4_ID_6] Type=VirtualKey Label=h##L\nく##R KeyCode=72 [Key_Base_Row_4_ID_7] Type=VirtualKey Label=j##L\nま##R KeyCode=74 [Key_Base_Row_4_ID_8] Type=VirtualKey Label=k##L\nの##R KeyCode=75 [Key_Base_Row_4_ID_9] Type=VirtualKey Label=l##L\nり##R KeyCode=76 [Key_Base_Row_4_ID_10] Type=String Label=;##L\nれ##R String=; [Key_Base_Row_4_ID_11] Type=String Label=:##L\nけ##R String=: [Key_Base_Row_4_ID_12] Type=String Label=] 」##L\nむ##R String=] [Key_Base_Row_4_ID_13] Type=VirtualKeyIsoEnter Width=125 Label=Enter KeyCode=13 [Key_Base_Row_4_ID_14] Type=Blank Width=325 Cluster=Navigation [Key_Base_Row_4_ID_15] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_4_ID_16] Type=VirtualKey Label=4\n← Cluster=Numpad KeyCode=100 [Key_Base_Row_4_ID_17] Type=VirtualKey Label=5\n Cluster=Numpad KeyCode=101 [Key_Base_Row_4_ID_18] Type=VirtualKey Label=6\n→ Cluster=Numpad KeyCode=102 [Key_Base_Row_5_ID_0] Type=VirtualKeyToggle Width=225 Label=Shift KeyCode=160 NoRepeat=true [Key_Base_Row_5_ID_1] Type=VirtualKey Label=z##L\nつ##R KeyCode=90 [Key_Base_Row_5_ID_2] Type=VirtualKey Label=x##L\nさ##R KeyCode=88 [Key_Base_Row_5_ID_3] Type=VirtualKey Label=c##L\nそ##R KeyCode=67 [Key_Base_Row_5_ID_4] Type=VirtualKey Label=v##L\nひ##R KeyCode=86 [Key_Base_Row_5_ID_5] Type=VirtualKey Label=b##L\nこ##R KeyCode=66 [Key_Base_Row_5_ID_6] Type=VirtualKey Label=n##L\nみ##R KeyCode=78 [Key_Base_Row_5_ID_7] Type=VirtualKey Label=m##L\nも##R KeyCode=77 [Key_Base_Row_5_ID_8] Type=String Label=, 、##L\nね##R String=, [Key_Base_Row_5_ID_9] Type=String Label=. 。##L\nる##R String=. [Key_Base_Row_5_ID_10] Type=String Label=/ ・##L\nめ##R String=/ [Key_Base_Row_5_ID_11] Type=String Label=\##L\nろ##R String=\ [Key_Base_Row_5_ID_12] Type=VirtualKeyToggle Width=175 Label=Shift KeyCode=161 NoRepeat=true [Key_Base_Row_5_ID_13] Type=Blank Width=125 Cluster=Navigation [Key_Base_Row_5_ID_14] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_Base_Row_5_ID_15] Type=Blank Cluster=Navigation [Key_Base_Row_5_ID_16] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_5_ID_17] Type=VirtualKey Label=1\nEnd Cluster=Numpad KeyCode=97 [Key_Base_Row_5_ID_18] Type=VirtualKey Label=2\n↓ Cluster=Numpad KeyCode=98 [Key_Base_Row_5_ID_19] Type=VirtualKey Label=3\nPgDn Cluster=Numpad KeyCode=99 [Key_Base_Row_5_ID_20] Type=VirtualKey Height=200 Label=Enter Cluster=Numpad KeyCode=13 [Key_Base_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=162 NoRepeat=true [Key_Base_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_Base_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_Base_Row_6_ID_3] Type=VirtualKey Label=無変換 KeyCode=29 [Key_Base_Row_6_ID_4] Type=VirtualKey Width=300 Label= KeyCode=32 [Key_Base_Row_6_ID_5] Type=VirtualKey Label=変換 KeyCode=28 [Key_Base_Row_6_ID_6] Type=VirtualKey Width=125 Label=カタカナ\nひらがな KeyCode=240 [Key_Base_Row_6_ID_7] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=165 NoRepeat=true [Key_Base_Row_6_ID_8] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_Base_Row_6_ID_9] Type=VirtualKey Width=125 Label=Menu KeyCode=93 NoRepeat=true [Key_Base_Row_6_ID_10] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=163 NoRepeat=true [Key_Base_Row_6_ID_11] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_6_ID_12] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_Base_Row_6_ID_13] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_Base_Row_6_ID_14] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_Base_Row_6_ID_15] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_6_ID_16] Type=VirtualKey Width=200 Label=0\nInsert Cluster=Numpad KeyCode=96 [Key_Base_Row_6_ID_17] Type=VirtualKey Label=.\nDel Cluster=Numpad KeyCode=110 [Key_Shift_Row_0_ID_0] Type=VirtualKey Label=Esc Cluster=Function KeyCode=27 NoRepeat=true [Key_Shift_Row_0_ID_1] Type=Blank Cluster=Function [Key_Shift_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_Shift_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_Shift_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_Shift_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_Shift_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_Shift_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_Shift_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_Shift_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_Shift_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_Shift_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_Shift_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_Shift_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_Shift_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_Shift_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_Shift_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_Shift_Row_0_ID_17] Type=VirtualKey Label=Print\nScreen Cluster=Function KeyCode=44 NoRepeat=true [Key_Shift_Row_0_ID_18] Type=VirtualKey Label=Scroll\nLock Cluster=Function KeyCode=145 NoRepeat=true [Key_Shift_Row_0_ID_19] Type=VirtualKey Label=Pause Cluster=Function KeyCode=19 NoRepeat=true [Key_Shift_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_Shift_Row_0_ID_21] Type=VirtualKey Label=🡰 Cluster=Extra KeyCode=166 NoRepeat=true [Key_Shift_Row_0_ID_22] Type=VirtualKey Label=🡲 Cluster=Extra KeyCode=167 NoRepeat=true [Key_Shift_Row_0_ID_23] Type=VirtualKey Label=🔇 Cluster=Extra KeyCode=173 NoRepeat=true [Key_Shift_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_Shift_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra [Key_Shift_Row_2_ID_0] Type=VirtualKey Label=半角/##L\n全角##L\n漢字##L KeyCode=25 [Key_Shift_Row_2_ID_1] Type=String Label=!##L\nぬ##R String=! [Key_Shift_Row_2_ID_2] Type=String Label="##L\nふ##R String=" [Key_Shift_Row_2_ID_3] Type=String Label=# ##L\nあ##R String=# [Key_Shift_Row_2_ID_4] Type=String Label=$##L\nう##R String=$ [Key_Shift_Row_2_ID_5] Type=String Label=%##L\nえ##R String=% [Key_Shift_Row_2_ID_6] Type=String Label=&##L\nお##R String=& [Key_Shift_Row_2_ID_7] Type=String Label='##L\nや##R String=' [Key_Shift_Row_2_ID_8] Type=String Label=(##L\nゆ##R String=( [Key_Shift_Row_2_ID_9] Type=String Label=)##L\nよ##R String=) [Key_Shift_Row_2_ID_10] Type=VirtualKey Label=##L\nわ##R KeyCode=48 [Key_Shift_Row_2_ID_11] Type=String Label==##L\nほ##R String== [Key_Shift_Row_2_ID_12] Type=String Label=~##L\nへ##R String=~ [Key_Shift_Row_2_ID_13] Type=String Label=|##L\n String=| [Key_Shift_Row_2_ID_14] Type=VirtualKey Label=Back\nspace KeyCode=8 [Key_Shift_Row_2_ID_15] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_2_ID_16] Type=VirtualKey Label=Insert Cluster=Navigation KeyCode=45 [Key_Shift_Row_2_ID_17] Type=VirtualKey Label=Home Cluster=Navigation KeyCode=36 [Key_Shift_Row_2_ID_18] Type=VirtualKey Label=PgUp Cluster=Navigation KeyCode=33 [Key_Shift_Row_2_ID_19] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_2_ID_20] Type=VirtualKey Label=Num\nLock Cluster=Numpad KeyCode=144 NoRepeat=true [Key_Shift_Row_2_ID_21] Type=VirtualKey Label=/ Cluster=Numpad KeyCode=111 [Key_Shift_Row_2_ID_22] Type=VirtualKey Label=* Cluster=Numpad KeyCode=106 [Key_Shift_Row_2_ID_23] Type=VirtualKey Label=- Cluster=Numpad KeyCode=109 [Key_Shift_Row_3_ID_0] Type=VirtualKey Width=150 Label=Tab KeyCode=9 [Key_Shift_Row_3_ID_1] Type=VirtualKey Label=Q##L\nた##R KeyCode=81 [Key_Shift_Row_3_ID_2] Type=VirtualKey Label=W##L\nて##R KeyCode=87 [Key_Shift_Row_3_ID_3] Type=VirtualKey Label=E##L\nい##R KeyCode=69 [Key_Shift_Row_3_ID_4] Type=VirtualKey Label=R##L\nす##R KeyCode=82 [Key_Shift_Row_3_ID_5] Type=VirtualKey Label=T##L\nか##R KeyCode=84 [Key_Shift_Row_3_ID_6] Type=VirtualKey Label=Y##L\nん##R KeyCode=89 [Key_Shift_Row_3_ID_7] Type=VirtualKey Label=U##L\nな##R KeyCode=85 [Key_Shift_Row_3_ID_8] Type=VirtualKey Label=I##L\nに##R KeyCode=73 [Key_Shift_Row_3_ID_9] Type=VirtualKey Label=O##L\nら##R KeyCode=79 [Key_Shift_Row_3_ID_10] Type=VirtualKey Label=P##L\nせ##R KeyCode=80 [Key_Shift_Row_3_ID_11] Type=String Label=`##L\n String=` [Key_Shift_Row_3_ID_12] Type=String Label={##L\n String={ [Key_Shift_Row_3_ID_13] Type=VirtualKeyIsoEnter Width=150 Label= KeyCode=13 [Key_Shift_Row_3_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_3_ID_15] Type=VirtualKey Label=Delete Cluster=Navigation KeyCode=46 [Key_Shift_Row_3_ID_16] Type=VirtualKey Label=End Cluster=Navigation KeyCode=35 [Key_Shift_Row_3_ID_17] Type=VirtualKey Label=PgDn Cluster=Navigation KeyCode=34 [Key_Shift_Row_3_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_3_ID_19] Type=VirtualKey Label=7\nHome Cluster=Numpad KeyCode=103 [Key_Shift_Row_3_ID_20] Type=VirtualKey Label=8\n↑ Cluster=Numpad KeyCode=104 [Key_Shift_Row_3_ID_21] Type=VirtualKey Label=9\nPgUp Cluster=Numpad KeyCode=105 [Key_Shift_Row_3_ID_22] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 [Key_Shift_Row_4_ID_0] Type=VirtualKey Width=175 Label=Caps Lock KeyCode=20 NoRepeat=true [Key_Shift_Row_4_ID_1] Type=VirtualKey Label=A##L\nち##R KeyCode=65 [Key_Shift_Row_4_ID_2] Type=VirtualKey Label=S##L\nと##R KeyCode=83 [Key_Shift_Row_4_ID_3] Type=VirtualKey Label=D##L\nし##R KeyCode=68 [Key_Shift_Row_4_ID_4] Type=VirtualKey Label=F##L\nは##R KeyCode=70 [Key_Shift_Row_4_ID_5] Type=VirtualKey Label=G##L\nき##R KeyCode=71 [Key_Shift_Row_4_ID_6] Type=VirtualKey Label=H##L\nく##R KeyCode=72 [Key_Shift_Row_4_ID_7] Type=VirtualKey Label=J##L\nま##R KeyCode=74 [Key_Shift_Row_4_ID_8] Type=VirtualKey Label=K##L\nの##R KeyCode=75 [Key_Shift_Row_4_ID_9] Type=VirtualKey Label=L##L\nり##R KeyCode=76 [Key_Shift_Row_4_ID_10] Type=String Label=+##L\nれ##R String=+ [Key_Shift_Row_4_ID_11] Type=String Label=*##L\nけ##R String=* [Key_Shift_Row_4_ID_12] Type=String Label=}##L\nむ##R String=} [Key_Shift_Row_4_ID_13] Type=VirtualKeyIsoEnter Width=125 Label=Enter KeyCode=13 [Key_Shift_Row_4_ID_14] Type=Blank Width=325 Cluster=Navigation [Key_Shift_Row_4_ID_15] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_4_ID_16] Type=VirtualKey Label=4\n← Cluster=Numpad KeyCode=100 [Key_Shift_Row_4_ID_17] Type=VirtualKey Label=5\n Cluster=Numpad KeyCode=101 [Key_Shift_Row_4_ID_18] Type=VirtualKey Label=6\n→ Cluster=Numpad KeyCode=102 [Key_Shift_Row_5_ID_0] Type=VirtualKeyToggle Width=225 Label=Shift KeyCode=160 NoRepeat=true [Key_Shift_Row_5_ID_1] Type=VirtualKey Label=Z##L\nつ##R KeyCode=90 [Key_Shift_Row_5_ID_2] Type=VirtualKey Label=X##L\nさ##R KeyCode=88 [Key_Shift_Row_5_ID_3] Type=VirtualKey Label=C##L\nそ##R KeyCode=67 [Key_Shift_Row_5_ID_4] Type=VirtualKey Label=V##L\nひ##R KeyCode=86 [Key_Shift_Row_5_ID_5] Type=VirtualKey Label=B##L\nこ##R KeyCode=66 [Key_Shift_Row_5_ID_6] Type=VirtualKey Label=N##L\nみ##R KeyCode=78 [Key_Shift_Row_5_ID_7] Type=VirtualKey Label=M##L\nも##R KeyCode=77 [Key_Shift_Row_5_ID_8] Type=String Label=<##L\nね##R String=< [Key_Shift_Row_5_ID_9] Type=String Label=>##L\nる##R String=> [Key_Shift_Row_5_ID_10] Type=String Label=?##L\nめ##R String=? [Key_Shift_Row_5_ID_11] Type=String Label=_##L\nろ##R String=_ [Key_Shift_Row_5_ID_12] Type=VirtualKeyToggle Width=175 Label=Shift KeyCode=161 NoRepeat=true [Key_Shift_Row_5_ID_13] Type=Blank Width=125 Cluster=Navigation [Key_Shift_Row_5_ID_14] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_Shift_Row_5_ID_15] Type=Blank Cluster=Navigation [Key_Shift_Row_5_ID_16] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_5_ID_17] Type=VirtualKey Label=1\nEnd Cluster=Numpad KeyCode=97 [Key_Shift_Row_5_ID_18] Type=VirtualKey Label=2\n↓ Cluster=Numpad KeyCode=98 [Key_Shift_Row_5_ID_19] Type=VirtualKey Label=3\nPgDn Cluster=Numpad KeyCode=99 [Key_Shift_Row_5_ID_20] Type=VirtualKey Height=200 Label=Enter Cluster=Numpad KeyCode=13 [Key_Shift_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=162 NoRepeat=true [Key_Shift_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_Shift_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_Shift_Row_6_ID_3] Type=VirtualKey Label=無変換 KeyCode=29 [Key_Shift_Row_6_ID_4] Type=VirtualKey Width=300 Label= KeyCode=32 [Key_Shift_Row_6_ID_5] Type=VirtualKey Label=変換 KeyCode=28 [Key_Shift_Row_6_ID_6] Type=VirtualKey Width=125 Label=カタカナ\nひらがな KeyCode=21 [Key_Shift_Row_6_ID_7] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=165 NoRepeat=true [Key_Shift_Row_6_ID_8] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_Shift_Row_6_ID_9] Type=VirtualKey Width=125 Label=Menu KeyCode=93 NoRepeat=true [Key_Shift_Row_6_ID_10] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=163 NoRepeat=true [Key_Shift_Row_6_ID_11] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_6_ID_12] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_Shift_Row_6_ID_13] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_Shift_Row_6_ID_14] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_Shift_Row_6_ID_15] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_6_ID_16] Type=VirtualKey Width=200 Label=0\nInsert Cluster=Numpad KeyCode=96 [Key_Shift_Row_6_ID_17] Type=VirtualKey Label=.\nDel Cluster=Numpad KeyCode=110 ================================================ FILE: assets/keyboards/qwerty_ko_2-set.ini ================================================ [LayoutInfo] Name=QWERTY (Korean 2-set) Author=HisaCat HasAltGr=false HasClusterFunction=true HasClusterNavigation=true HasClusterNumpad=true HasClusterExtra=true [Key_Base_Row_0_ID_0] Type=VirtualKey Label=Esc Cluster=Function KeyCode=27 NoRepeat=true [Key_Base_Row_0_ID_1] Type=Blank Cluster=Function [Key_Base_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_Base_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_Base_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_Base_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_Base_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_Base_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_Base_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_Base_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_Base_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_Base_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_Base_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_Base_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_Base_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_Base_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_Base_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_Base_Row_0_ID_17] Type=VirtualKey Label=Print\nScreen Cluster=Function KeyCode=44 NoRepeat=true [Key_Base_Row_0_ID_18] Type=VirtualKey Label=Scroll\nLock Cluster=Function KeyCode=145 NoRepeat=true [Key_Base_Row_0_ID_19] Type=VirtualKey Label=Pause Cluster=Function KeyCode=19 NoRepeat=true [Key_Base_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_Base_Row_0_ID_21] Type=VirtualKey Label=⏯ Cluster=Extra KeyCode=179 NoRepeat=true [Key_Base_Row_0_ID_22] Type=VirtualKey Label=◼ Cluster=Extra KeyCode=178 NoRepeat=true [Key_Base_Row_0_ID_23] Type=VirtualKey Label=⏮ Cluster=Extra KeyCode=177 NoRepeat=true [Key_Base_Row_0_ID_24] Type=VirtualKey Label=⏭ Cluster=Extra KeyCode=176 NoRepeat=true [Key_Base_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_Base_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra [Key_Base_Row_2_ID_0] Type=VirtualKey Label=`##L\n KeyCode=192 [Key_Base_Row_2_ID_1] Type=VirtualKey Label=1##L\n KeyCode=49 [Key_Base_Row_2_ID_2] Type=VirtualKey Label=2##L\n KeyCode=50 [Key_Base_Row_2_ID_3] Type=VirtualKey Label=3##L\n KeyCode=51 [Key_Base_Row_2_ID_4] Type=VirtualKey Label=4##L\n KeyCode=52 [Key_Base_Row_2_ID_5] Type=VirtualKey Label=5##L\n KeyCode=53 [Key_Base_Row_2_ID_6] Type=VirtualKey Label=6##L\n KeyCode=54 [Key_Base_Row_2_ID_7] Type=VirtualKey Label=7##L\n KeyCode=55 [Key_Base_Row_2_ID_8] Type=VirtualKey Label=8##L\n KeyCode=56 [Key_Base_Row_2_ID_9] Type=VirtualKey Label=9##L\n KeyCode=57 [Key_Base_Row_2_ID_10] Type=VirtualKey Label=0##L\n KeyCode=48 [Key_Base_Row_2_ID_11] Type=VirtualKey Label=-##L\n KeyCode=189 [Key_Base_Row_2_ID_12] Type=VirtualKey Label==##L\n KeyCode=187 [Key_Base_Row_2_ID_13] Type=VirtualKey Width=200 Label=Backspace KeyCode=8 [Key_Base_Row_2_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_2_ID_15] Type=VirtualKey Label=Insert Cluster=Navigation KeyCode=45 [Key_Base_Row_2_ID_16] Type=VirtualKey Label=Home Cluster=Navigation KeyCode=36 [Key_Base_Row_2_ID_17] Type=VirtualKey Label=PgUp Cluster=Navigation KeyCode=33 [Key_Base_Row_2_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_2_ID_19] Type=VirtualKey Label=Num##L\nLock##L Cluster=Numpad KeyCode=144 NoRepeat=true [Key_Base_Row_2_ID_20] Type=VirtualKey Label=/##L\n Cluster=Numpad KeyCode=111 [Key_Base_Row_2_ID_21] Type=VirtualKey Label=*##L\n Cluster=Numpad KeyCode=106 [Key_Base_Row_2_ID_22] Type=VirtualKey Label=-##L\n Cluster=Numpad KeyCode=109 [Key_Base_Row_3_ID_0] Type=VirtualKey Width=150 Label=Tab KeyCode=9 [Key_Base_Row_3_ID_1] Type=VirtualKey Label=q##L\nㅂ##R KeyCode=81 [Key_Base_Row_3_ID_2] Type=VirtualKey Label=w ##L\nㅈ##R KeyCode=87 [Key_Base_Row_3_ID_3] Type=VirtualKey Label=e##L\nㄷ##R KeyCode=69 [Key_Base_Row_3_ID_4] Type=VirtualKey Label=r##L\nㄱ##R KeyCode=82 [Key_Base_Row_3_ID_5] Type=VirtualKey Label=t##L\nㅅ##R KeyCode=84 [Key_Base_Row_3_ID_6] Type=VirtualKey Label=y##L\nㅛ##R KeyCode=89 [Key_Base_Row_3_ID_7] Type=VirtualKey Label=u##L\nㅕ##R KeyCode=85 [Key_Base_Row_3_ID_8] Type=VirtualKey Label=i##L\nㅑ##R KeyCode=73 [Key_Base_Row_3_ID_9] Type=VirtualKey Label=o##L\nㅐ##R KeyCode=79 [Key_Base_Row_3_ID_10] Type=VirtualKey Label=p##L\nㅔ##R KeyCode=80 [Key_Base_Row_3_ID_11] Type=VirtualKey Label=[##L\n KeyCode=219 [Key_Base_Row_3_ID_12] Type=VirtualKey Label=]##L\n KeyCode=221 [Key_Base_Row_3_ID_13] Type=VirtualKey Width=150 Label=₩##L\n KeyCode=220 [Key_Base_Row_3_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_3_ID_15] Type=VirtualKey Label=Delete Cluster=Navigation KeyCode=46 [Key_Base_Row_3_ID_16] Type=VirtualKey Label=End Cluster=Navigation KeyCode=35 [Key_Base_Row_3_ID_17] Type=VirtualKey Label=PgDn Cluster=Navigation KeyCode=34 [Key_Base_Row_3_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_3_ID_19] Type=VirtualKey Label=7##L\nHome##L Cluster=Numpad KeyCode=103 [Key_Base_Row_3_ID_20] Type=VirtualKey Label=8##L\n↑##L Cluster=Numpad KeyCode=104 [Key_Base_Row_3_ID_21] Type=VirtualKey Label=9##L\nPgUp##L Cluster=Numpad KeyCode=105 [Key_Base_Row_3_ID_22] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 [Key_Base_Row_4_ID_0] Type=VirtualKey Width=175 Label=Caps Lock KeyCode=20 NoRepeat=true [Key_Base_Row_4_ID_1] Type=VirtualKey Label=a##L\nㅁ##R KeyCode=65 [Key_Base_Row_4_ID_2] Type=VirtualKey Label=s##L\nㄴ##R KeyCode=83 [Key_Base_Row_4_ID_3] Type=VirtualKey Label=d##L\nㅇ##R KeyCode=68 [Key_Base_Row_4_ID_4] Type=VirtualKey Label=f##L\nㄹ##R KeyCode=70 [Key_Base_Row_4_ID_5] Type=VirtualKey Label=g##L\nㅎ##R KeyCode=71 [Key_Base_Row_4_ID_6] Type=VirtualKey Label=h##L\nㅗ##R KeyCode=72 [Key_Base_Row_4_ID_7] Type=VirtualKey Label=j##L\nㅓ##R KeyCode=74 [Key_Base_Row_4_ID_8] Type=VirtualKey Label=k##L\nㅏ##R KeyCode=75 [Key_Base_Row_4_ID_9] Type=VirtualKey Label=l##L\nㅣ##R KeyCode=76 [Key_Base_Row_4_ID_10] Type=VirtualKey Label=;##L\n KeyCode=186 [Key_Base_Row_4_ID_11] Type=VirtualKey Label='##L\n KeyCode=222 [Key_Base_Row_4_ID_12] Type=VirtualKey Width=225 Label=Enter KeyCode=13 [Key_Base_Row_4_ID_13] Type=Blank Width=325 Cluster=Navigation [Key_Base_Row_4_ID_14] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_4_ID_15] Type=VirtualKey Label=4##L\n←##L Cluster=Numpad KeyCode=100 [Key_Base_Row_4_ID_16] Type=VirtualKey Label=5##L\n Cluster=Numpad KeyCode=101 [Key_Base_Row_4_ID_17] Type=VirtualKey Label=6##L\n→##L Cluster=Numpad KeyCode=102 [Key_Base_Row_5_ID_0] Type=VirtualKeyToggle Width=225 Label=Shift KeyCode=160 NoRepeat=true [Key_Base_Row_5_ID_1] Type=VirtualKey Label=z##L\nㅋ##R KeyCode=90 [Key_Base_Row_5_ID_2] Type=VirtualKey Label=x##L\nㅌ##R KeyCode=88 [Key_Base_Row_5_ID_3] Type=VirtualKey Label=c##L\nㅊ##R KeyCode=67 [Key_Base_Row_5_ID_4] Type=VirtualKey Label=v##L\nㅍ##R KeyCode=86 [Key_Base_Row_5_ID_5] Type=VirtualKey Label=b##L\nㅠ##R KeyCode=66 [Key_Base_Row_5_ID_6] Type=VirtualKey Label=n##L\nㅜ##R KeyCode=78 [Key_Base_Row_5_ID_7] Type=VirtualKey Label=m##L\nㅡ##R KeyCode=77 [Key_Base_Row_5_ID_8] Type=VirtualKey Label=,##L\n KeyCode=188 [Key_Base_Row_5_ID_9] Type=VirtualKey Label=.##L\n KeyCode=190 [Key_Base_Row_5_ID_10] Type=VirtualKey Label=/##L\n KeyCode=191 [Key_Base_Row_5_ID_11] Type=VirtualKeyToggle Width=275 Label=Shift KeyCode=161 NoRepeat=true [Key_Base_Row_5_ID_12] Type=Blank Width=125 Cluster=Navigation [Key_Base_Row_5_ID_13] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_Base_Row_5_ID_14] Type=Blank Cluster=Navigation [Key_Base_Row_5_ID_15] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_5_ID_16] Type=VirtualKey Label=1##L\nEnd##L Cluster=Numpad KeyCode=97 [Key_Base_Row_5_ID_17] Type=VirtualKey Label=2##L\n↓##L Cluster=Numpad KeyCode=98 [Key_Base_Row_5_ID_18] Type=VirtualKey Label=3##L\nPgDn##L Cluster=Numpad KeyCode=99 [Key_Base_Row_5_ID_19] Type=VirtualKey Height=200 Label=Enter Cluster=Numpad KeyCode=13 [Key_Base_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=162 NoRepeat=true [Key_Base_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_Base_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_Base_Row_6_ID_3] Type=VirtualKey Width=625 Label= KeyCode=32 [Key_Base_Row_6_ID_4] Type=VirtualKey Width=125 Label=Alt##L\n한/영##L KeyCode=21 NoRepeat=true [Key_Base_Row_6_ID_5] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_Base_Row_6_ID_6] Type=VirtualKey Width=125 Label=Menu KeyCode=93 NoRepeat=true [Key_Base_Row_6_ID_7] Type=VirtualKey Width=125 Label=Ctrl##L\n한자##L KeyCode=25 NoRepeat=true [Key_Base_Row_6_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_6_ID_9] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_Base_Row_6_ID_10] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_Base_Row_6_ID_11] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_Base_Row_6_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_6_ID_13] Type=VirtualKey Width=200 Label=0##L\nInsert##L Cluster=Numpad KeyCode=96 [Key_Base_Row_6_ID_14] Type=VirtualKey Label=.##L\nDel##L Cluster=Numpad KeyCode=110 [Key_Shift_Row_0_ID_0] Type=VirtualKey Label=Esc Cluster=Function KeyCode=27 NoRepeat=true [Key_Shift_Row_0_ID_1] Type=Blank Cluster=Function [Key_Shift_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_Shift_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_Shift_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_Shift_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_Shift_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_Shift_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_Shift_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_Shift_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_Shift_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_Shift_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_Shift_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_Shift_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_Shift_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_Shift_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_Shift_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_Shift_Row_0_ID_17] Type=VirtualKey Label=Print\nScreen Cluster=Function KeyCode=44 NoRepeat=true [Key_Shift_Row_0_ID_18] Type=VirtualKey Label=Scroll\nLock Cluster=Function KeyCode=145 NoRepeat=true [Key_Shift_Row_0_ID_19] Type=VirtualKey Label=Pause Cluster=Function KeyCode=19 NoRepeat=true [Key_Shift_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_Shift_Row_0_ID_21] Type=VirtualKey Label=⏯ Cluster=Extra KeyCode=179 NoRepeat=true [Key_Shift_Row_0_ID_22] Type=VirtualKey Label=◼ Cluster=Extra KeyCode=178 NoRepeat=true [Key_Shift_Row_0_ID_23] Type=VirtualKey Label=⏮ Cluster=Extra KeyCode=177 NoRepeat=true [Key_Shift_Row_0_ID_24] Type=VirtualKey Label=⏭ Cluster=Extra KeyCode=176 NoRepeat=true [Key_Shift_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_Shift_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra [Key_Shift_Row_2_ID_0] Type=VirtualKey Label=~##L\n KeyCode=192 [Key_Shift_Row_2_ID_1] Type=VirtualKey Label=!##L\n KeyCode=49 [Key_Shift_Row_2_ID_2] Type=VirtualKey Label=@##L\n KeyCode=50 [Key_Shift_Row_2_ID_3] Type=VirtualKey Label=# ##L\n KeyCode=51 [Key_Shift_Row_2_ID_4] Type=VirtualKey Label=$##L\n KeyCode=52 [Key_Shift_Row_2_ID_5] Type=VirtualKey Label=%##L\n KeyCode=53 [Key_Shift_Row_2_ID_6] Type=VirtualKey Label=^##L\n KeyCode=54 [Key_Shift_Row_2_ID_7] Type=VirtualKey Label=&##L\n KeyCode=55 [Key_Shift_Row_2_ID_8] Type=VirtualKey Label=*##L\n KeyCode=56 [Key_Shift_Row_2_ID_9] Type=VirtualKey Label=(##L\n KeyCode=57 [Key_Shift_Row_2_ID_10] Type=VirtualKey Label=)##L\n KeyCode=48 [Key_Shift_Row_2_ID_11] Type=VirtualKey Label=_##L\n KeyCode=189 [Key_Shift_Row_2_ID_12] Type=VirtualKey Label=+##L\n KeyCode=187 [Key_Shift_Row_2_ID_13] Type=VirtualKey Width=200 Label=Backspace KeyCode=8 [Key_Shift_Row_2_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_2_ID_15] Type=VirtualKey Label=Insert Cluster=Navigation KeyCode=45 [Key_Shift_Row_2_ID_16] Type=VirtualKey Label=Home Cluster=Navigation KeyCode=36 [Key_Shift_Row_2_ID_17] Type=VirtualKey Label=PgUp Cluster=Navigation KeyCode=33 [Key_Shift_Row_2_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_2_ID_19] Type=VirtualKey Label=Num##L\nLock##L Cluster=Numpad KeyCode=144 NoRepeat=true [Key_Shift_Row_2_ID_20] Type=VirtualKey Label=/##L\n Cluster=Numpad KeyCode=111 [Key_Shift_Row_2_ID_21] Type=VirtualKey Label=*##L\n Cluster=Numpad KeyCode=106 [Key_Shift_Row_2_ID_22] Type=VirtualKey Label=-##L\n Cluster=Numpad KeyCode=109 [Key_Shift_Row_3_ID_0] Type=VirtualKey Width=150 Label=Tab KeyCode=9 [Key_Shift_Row_3_ID_1] Type=VirtualKey Label=Q##L\nㅃ##R KeyCode=81 [Key_Shift_Row_3_ID_2] Type=VirtualKey Label=W##L\nㅉ##R KeyCode=87 [Key_Shift_Row_3_ID_3] Type=VirtualKey Label=E##L\nㄸ##R KeyCode=69 [Key_Shift_Row_3_ID_4] Type=VirtualKey Label=R##L\nㄲ##R KeyCode=82 [Key_Shift_Row_3_ID_5] Type=VirtualKey Label=T##L\nㅆ##R KeyCode=84 [Key_Shift_Row_3_ID_6] Type=VirtualKey Label=Y##L\nㅛ##R KeyCode=89 [Key_Shift_Row_3_ID_7] Type=VirtualKey Label=U##L\nㅕ##R KeyCode=85 [Key_Shift_Row_3_ID_8] Type=VirtualKey Label=I##L\nㅑ##R KeyCode=73 [Key_Shift_Row_3_ID_9] Type=VirtualKey Label=O##L\nㅒ##R KeyCode=79 [Key_Shift_Row_3_ID_10] Type=VirtualKey Label=P##L\nㅖ##R KeyCode=80 [Key_Shift_Row_3_ID_11] Type=VirtualKey Label={##L\n KeyCode=219 [Key_Shift_Row_3_ID_12] Type=VirtualKey Label=}##L\n KeyCode=221 [Key_Shift_Row_3_ID_13] Type=VirtualKey Width=150 Label=|##L\n KeyCode=220 [Key_Shift_Row_3_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_3_ID_15] Type=VirtualKey Label=Delete Cluster=Navigation KeyCode=46 [Key_Shift_Row_3_ID_16] Type=VirtualKey Label=End Cluster=Navigation KeyCode=35 [Key_Shift_Row_3_ID_17] Type=VirtualKey Label=PgDn Cluster=Navigation KeyCode=34 [Key_Shift_Row_3_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_3_ID_19] Type=VirtualKey Label=7##L\nHome##L Cluster=Numpad KeyCode=103 [Key_Shift_Row_3_ID_20] Type=VirtualKey Label=8##L\n↑##L Cluster=Numpad KeyCode=104 [Key_Shift_Row_3_ID_21] Type=VirtualKey Label=9##L\nPgUp##L Cluster=Numpad KeyCode=105 [Key_Shift_Row_3_ID_22] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 [Key_Shift_Row_4_ID_0] Type=VirtualKey Width=175 Label=Caps Lock KeyCode=20 NoRepeat=true [Key_Shift_Row_4_ID_1] Type=VirtualKey Label=A##L\nㅁ##R KeyCode=65 [Key_Shift_Row_4_ID_2] Type=VirtualKey Label=S##L\nㄴ##R KeyCode=83 [Key_Shift_Row_4_ID_3] Type=VirtualKey Label=D##L\nㅇ##R KeyCode=68 [Key_Shift_Row_4_ID_4] Type=VirtualKey Label=F##L\nㄹ##R KeyCode=70 [Key_Shift_Row_4_ID_5] Type=VirtualKey Label=G##L\nㅎ##R KeyCode=71 [Key_Shift_Row_4_ID_6] Type=VirtualKey Label=H##L\nㅗ##R KeyCode=72 [Key_Shift_Row_4_ID_7] Type=VirtualKey Label=J##L\nㅓ##R KeyCode=74 [Key_Shift_Row_4_ID_8] Type=VirtualKey Label=K##L\nㅏ##R KeyCode=75 [Key_Shift_Row_4_ID_9] Type=VirtualKey Label=L##L\nㅣ##R KeyCode=76 [Key_Shift_Row_4_ID_10] Type=VirtualKey Label=:##L\n KeyCode=186 [Key_Shift_Row_4_ID_11] Type=VirtualKey Label="##L\n KeyCode=222 [Key_Shift_Row_4_ID_12] Type=VirtualKey Width=225 Label=Enter KeyCode=13 [Key_Shift_Row_4_ID_13] Type=Blank Width=325 Cluster=Navigation [Key_Shift_Row_4_ID_14] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_4_ID_15] Type=VirtualKey Label=4##L\n←##L Cluster=Numpad KeyCode=100 [Key_Shift_Row_4_ID_16] Type=VirtualKey Label=5##L\n Cluster=Numpad KeyCode=101 [Key_Shift_Row_4_ID_17] Type=VirtualKey Label=6##L\n→##L Cluster=Numpad KeyCode=102 [Key_Shift_Row_5_ID_0] Type=VirtualKeyToggle Width=225 Label=Shift KeyCode=160 NoRepeat=true [Key_Shift_Row_5_ID_1] Type=VirtualKey Label=Z##L\nㅋ##R KeyCode=90 [Key_Shift_Row_5_ID_2] Type=VirtualKey Label=X##L\nㅌ##R KeyCode=88 [Key_Shift_Row_5_ID_3] Type=VirtualKey Label=C##L\nㅊ##R KeyCode=67 [Key_Shift_Row_5_ID_4] Type=VirtualKey Label=V##L\nㅍ##R KeyCode=86 [Key_Shift_Row_5_ID_5] Type=VirtualKey Label=B##L\nㅠ##R KeyCode=66 [Key_Shift_Row_5_ID_6] Type=VirtualKey Label=N##L\nㅜ##R KeyCode=78 [Key_Shift_Row_5_ID_7] Type=VirtualKey Label=M##L\nㅡ##R KeyCode=77 [Key_Shift_Row_5_ID_8] Type=VirtualKey Label=<##L\n KeyCode=188 [Key_Shift_Row_5_ID_9] Type=VirtualKey Label=>##L\n KeyCode=190 [Key_Shift_Row_5_ID_10] Type=VirtualKey Label=?##L\n KeyCode=191 [Key_Shift_Row_5_ID_11] Type=VirtualKeyToggle Width=275 Label=Shift KeyCode=161 NoRepeat=true [Key_Shift_Row_5_ID_12] Type=Blank Width=125 Cluster=Navigation [Key_Shift_Row_5_ID_13] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_Shift_Row_5_ID_14] Type=Blank Cluster=Navigation [Key_Shift_Row_5_ID_15] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_5_ID_16] Type=VirtualKey Label=1##L\nEnd##L Cluster=Numpad KeyCode=97 [Key_Shift_Row_5_ID_17] Type=VirtualKey Label=2##L\n↓##L Cluster=Numpad KeyCode=98 [Key_Shift_Row_5_ID_18] Type=VirtualKey Label=3##L\nPgDn##L Cluster=Numpad KeyCode=99 [Key_Shift_Row_5_ID_19] Type=VirtualKey Height=200 Label=Enter Cluster=Numpad KeyCode=13 [Key_Shift_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=162 NoRepeat=true [Key_Shift_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_Shift_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_Shift_Row_6_ID_3] Type=VirtualKey Width=625 Label= KeyCode=32 [Key_Shift_Row_6_ID_4] Type=VirtualKey Width=125 Label=Alt##L\n한/영##L KeyCode=21 NoRepeat=true [Key_Shift_Row_6_ID_5] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_Shift_Row_6_ID_6] Type=VirtualKey Width=125 Label=Menu KeyCode=93 NoRepeat=true [Key_Shift_Row_6_ID_7] Type=VirtualKey Width=125 Label=Ctrl##L\n한자##L KeyCode=25 NoRepeat=true [Key_Shift_Row_6_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_6_ID_9] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_Shift_Row_6_ID_10] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_Shift_Row_6_ID_11] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_Shift_Row_6_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_6_ID_13] Type=VirtualKey Width=200 Label=0##L\nInsert##L Cluster=Numpad KeyCode=96 [Key_Shift_Row_6_ID_14] Type=VirtualKey Label=.##L\nDel##L Cluster=Numpad KeyCode=110 ================================================ FILE: assets/keyboards/qwerty_latam.ini ================================================ [LayoutInfo] Name=QWERTY (Latin America) Author= HasAltGr=true HasClusterFunction=true HasClusterNavigation=true HasClusterNumpad=true HasClusterExtra=true [Key_Base_Row_0_ID_0] Type=VirtualKey Label=Esc Cluster=Function KeyCode=27 NoRepeat=true [Key_Base_Row_0_ID_1] Type=Blank Cluster=Function [Key_Base_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_Base_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_Base_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_Base_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_Base_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_Base_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_Base_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_Base_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_Base_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_Base_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_Base_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_Base_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_Base_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_Base_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_Base_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_Base_Row_0_ID_17] Type=VirtualKey Label=Impr\nPant Cluster=Function KeyCode=44 NoRepeat=true [Key_Base_Row_0_ID_18] Type=VirtualKey Label=Bloq\nDespl Cluster=Function KeyCode=145 NoRepeat=true [Key_Base_Row_0_ID_19] Type=VirtualKey Label=Pausa Cluster=Function KeyCode=19 NoRepeat=true [Key_Base_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_Base_Row_0_ID_21] Type=VirtualKey Label=⏯ Cluster=Extra KeyCode=179 NoRepeat=true [Key_Base_Row_0_ID_22] Type=VirtualKey Label=◼ Cluster=Extra KeyCode=178 NoRepeat=true [Key_Base_Row_0_ID_23] Type=VirtualKey Label=⏮ Cluster=Extra KeyCode=177 NoRepeat=true [Key_Base_Row_0_ID_24] Type=VirtualKey Label=⏭ Cluster=Extra KeyCode=176 NoRepeat=true [Key_Base_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_Base_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra [Key_Base_Row_2_ID_0] Type=String Label=| String=| [Key_Base_Row_2_ID_1] Type=VirtualKey Label=1 KeyCode=49 [Key_Base_Row_2_ID_2] Type=VirtualKey Label=2 KeyCode=50 [Key_Base_Row_2_ID_3] Type=VirtualKey Label=3 KeyCode=51 [Key_Base_Row_2_ID_4] Type=VirtualKey Label=4 KeyCode=52 [Key_Base_Row_2_ID_5] Type=VirtualKey Label=5 KeyCode=53 [Key_Base_Row_2_ID_6] Type=VirtualKey Label=6 KeyCode=54 [Key_Base_Row_2_ID_7] Type=VirtualKey Label=7 KeyCode=55 [Key_Base_Row_2_ID_8] Type=VirtualKey Label=8 KeyCode=56 [Key_Base_Row_2_ID_9] Type=VirtualKey Label=9 KeyCode=57 [Key_Base_Row_2_ID_10] Type=VirtualKey Label=0 KeyCode=48 [Key_Base_Row_2_ID_11] Type=String Label=' String=' [Key_Base_Row_2_ID_12] Type=String Label=¿ String=¿ [Key_Base_Row_2_ID_13] Type=VirtualKey Width=200 Label=⟵ KeyCode=8 [Key_Base_Row_2_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_2_ID_15] Type=VirtualKey Label=Insert Cluster=Navigation KeyCode=45 [Key_Base_Row_2_ID_16] Type=VirtualKey Label=Incio Cluster=Navigation KeyCode=36 [Key_Base_Row_2_ID_17] Type=VirtualKey Label=RePág Cluster=Navigation KeyCode=33 [Key_Base_Row_2_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_2_ID_19] Type=VirtualKey Label=Bloq\nNum Cluster=Numpad KeyCode=144 NoRepeat=true [Key_Base_Row_2_ID_20] Type=VirtualKey Label=/ Cluster=Numpad KeyCode=111 [Key_Base_Row_2_ID_21] Type=VirtualKey Label=* Cluster=Numpad KeyCode=106 [Key_Base_Row_2_ID_22] Type=VirtualKey Label=- Cluster=Numpad KeyCode=109 [Key_Base_Row_3_ID_0] Type=VirtualKey Width=150 Label=⭾ KeyCode=9 [Key_Base_Row_3_ID_1] Type=VirtualKey Label=q KeyCode=81 [Key_Base_Row_3_ID_2] Type=VirtualKey Label=w KeyCode=87 [Key_Base_Row_3_ID_3] Type=VirtualKey Label=e KeyCode=69 [Key_Base_Row_3_ID_4] Type=VirtualKey Label=r KeyCode=82 [Key_Base_Row_3_ID_5] Type=VirtualKey Label=t KeyCode=84 [Key_Base_Row_3_ID_6] Type=VirtualKey Label=y KeyCode=89 [Key_Base_Row_3_ID_7] Type=VirtualKey Label=u KeyCode=85 [Key_Base_Row_3_ID_8] Type=VirtualKey Label=i KeyCode=73 [Key_Base_Row_3_ID_9] Type=VirtualKey Label=o KeyCode=79 [Key_Base_Row_3_ID_10] Type=VirtualKey Label=p KeyCode=80 [Key_Base_Row_3_ID_11] Type=String Label=´ String=´ [Key_Base_Row_3_ID_12] Type=String Label=+ String=+ [Key_Base_Row_3_ID_13] Type=VirtualKeyIsoEnter Width=150 Label= KeyCode=13 [Key_Base_Row_3_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_3_ID_15] Type=VirtualKey Label=Supr Cluster=Navigation KeyCode=46 [Key_Base_Row_3_ID_16] Type=VirtualKey Label=Fin Cluster=Navigation KeyCode=35 [Key_Base_Row_3_ID_17] Type=VirtualKey Label=AvPág Cluster=Navigation KeyCode=34 [Key_Base_Row_3_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_3_ID_19] Type=VirtualKey Label=7 Cluster=Numpad KeyCode=103 [Key_Base_Row_3_ID_20] Type=VirtualKey Label=8 Cluster=Numpad KeyCode=104 [Key_Base_Row_3_ID_21] Type=VirtualKey Label=9 Cluster=Numpad KeyCode=105 [Key_Base_Row_3_ID_22] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 [Key_Base_Row_4_ID_0] Type=VirtualKey Width=175 Label=Bloq Mayús KeyCode=20 NoRepeat=true [Key_Base_Row_4_ID_1] Type=VirtualKey Label=a KeyCode=65 [Key_Base_Row_4_ID_2] Type=VirtualKey Label=s KeyCode=83 [Key_Base_Row_4_ID_3] Type=VirtualKey Label=d KeyCode=68 [Key_Base_Row_4_ID_4] Type=VirtualKey Label=f KeyCode=70 [Key_Base_Row_4_ID_5] Type=VirtualKey Label=g KeyCode=71 [Key_Base_Row_4_ID_6] Type=VirtualKey Label=h KeyCode=72 [Key_Base_Row_4_ID_7] Type=VirtualKey Label=j KeyCode=74 [Key_Base_Row_4_ID_8] Type=VirtualKey Label=k KeyCode=75 [Key_Base_Row_4_ID_9] Type=VirtualKey Label=l KeyCode=76 [Key_Base_Row_4_ID_10] Type=String Label=ñ String=ñ [Key_Base_Row_4_ID_11] Type=String Label={ String={ [Key_Base_Row_4_ID_12] Type=String Label=} String=} [Key_Base_Row_4_ID_13] Type=VirtualKeyIsoEnter Width=125 Label=↵ KeyCode=13 [Key_Base_Row_4_ID_14] Type=Blank Width=325 Cluster=Navigation [Key_Base_Row_4_ID_15] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_4_ID_16] Type=VirtualKey Label=4 Cluster=Numpad KeyCode=100 [Key_Base_Row_4_ID_17] Type=VirtualKey Label=5 Cluster=Numpad KeyCode=101 [Key_Base_Row_4_ID_18] Type=VirtualKey Label=6 Cluster=Numpad KeyCode=102 [Key_Base_Row_5_ID_0] Type=VirtualKeyToggle Width=125 Label=🡅 KeyCode=160 NoRepeat=true [Key_Base_Row_5_ID_1] Type=String Label=< String=< [Key_Base_Row_5_ID_2] Type=VirtualKey Label=z KeyCode=90 [Key_Base_Row_5_ID_3] Type=VirtualKey Label=x KeyCode=88 [Key_Base_Row_5_ID_4] Type=VirtualKey Label=c KeyCode=67 [Key_Base_Row_5_ID_5] Type=VirtualKey Label=v KeyCode=86 [Key_Base_Row_5_ID_6] Type=VirtualKey Label=b KeyCode=66 [Key_Base_Row_5_ID_7] Type=VirtualKey Label=n KeyCode=78 [Key_Base_Row_5_ID_8] Type=VirtualKey Label=m KeyCode=77 [Key_Base_Row_5_ID_9] Type=String Label=, String=, [Key_Base_Row_5_ID_10] Type=String Label=. String=. [Key_Base_Row_5_ID_11] Type=String Label=- String=- [Key_Base_Row_5_ID_12] Type=VirtualKeyToggle Width=275 Label=🡅 KeyCode=161 NoRepeat=true [Key_Base_Row_5_ID_13] Type=Blank Width=125 Cluster=Navigation [Key_Base_Row_5_ID_14] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_Base_Row_5_ID_15] Type=Blank Cluster=Navigation [Key_Base_Row_5_ID_16] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_5_ID_17] Type=VirtualKey Label=1 Cluster=Numpad KeyCode=97 [Key_Base_Row_5_ID_18] Type=VirtualKey Label=2 Cluster=Numpad KeyCode=98 [Key_Base_Row_5_ID_19] Type=VirtualKey Label=3 Cluster=Numpad KeyCode=99 [Key_Base_Row_5_ID_20] Type=VirtualKey Height=200 Label=Intro Cluster=Numpad KeyCode=13 [Key_Base_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=162 NoRepeat=true [Key_Base_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_Base_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_Base_Row_6_ID_3] Type=VirtualKey Width=625 Label= KeyCode=32 [Key_Base_Row_6_ID_4] Type=VirtualKeyToggle Width=125 Label=AltGr KeyCode=165 NoRepeat=true [Key_Base_Row_6_ID_5] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_Base_Row_6_ID_6] Type=VirtualKey Width=125 Label=Menu KeyCode=93 NoRepeat=true [Key_Base_Row_6_ID_7] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=163 NoRepeat=true [Key_Base_Row_6_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_6_ID_9] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_Base_Row_6_ID_10] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_Base_Row_6_ID_11] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_Base_Row_6_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_6_ID_13] Type=VirtualKey Width=200 Label=0 Cluster=Numpad KeyCode=96 [Key_Base_Row_6_ID_14] Type=VirtualKey Label=. Cluster=Numpad KeyCode=110 [Key_Shift_Row_0_ID_0] Type=VirtualKey Label=Esc Cluster=Function KeyCode=27 NoRepeat=true [Key_Shift_Row_0_ID_1] Type=Blank Cluster=Function [Key_Shift_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_Shift_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_Shift_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_Shift_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_Shift_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_Shift_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_Shift_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_Shift_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_Shift_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_Shift_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_Shift_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_Shift_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_Shift_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_Shift_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_Shift_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_Shift_Row_0_ID_17] Type=VirtualKey Label=Impr\nPant Cluster=Function KeyCode=44 NoRepeat=true [Key_Shift_Row_0_ID_18] Type=VirtualKey Label=Bloq\nDespl Cluster=Function KeyCode=145 NoRepeat=true [Key_Shift_Row_0_ID_19] Type=VirtualKey Label=Pausa Cluster=Function KeyCode=19 NoRepeat=true [Key_Shift_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_Shift_Row_0_ID_21] Type=VirtualKey Label=🡰 Cluster=Extra KeyCode=166 NoRepeat=true [Key_Shift_Row_0_ID_22] Type=VirtualKey Label=🡲 Cluster=Extra KeyCode=167 NoRepeat=true [Key_Shift_Row_0_ID_23] Type=VirtualKey Label=🔇 Cluster=Extra KeyCode=173 NoRepeat=true [Key_Shift_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_Shift_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra [Key_Shift_Row_2_ID_0] Type=String Label=° String=° [Key_Shift_Row_2_ID_1] Type=String Label=! String=! [Key_Shift_Row_2_ID_2] Type=String Label=" String=" [Key_Shift_Row_2_ID_3] Type=String Label=# String=# [Key_Shift_Row_2_ID_4] Type=String Label=$ String=$ [Key_Shift_Row_2_ID_5] Type=String Label=% String=% [Key_Shift_Row_2_ID_6] Type=String Label=& String=& [Key_Shift_Row_2_ID_7] Type=String Label=/ String=/ [Key_Shift_Row_2_ID_8] Type=String Label=( String=( [Key_Shift_Row_2_ID_9] Type=String Label=) String=) [Key_Shift_Row_2_ID_10] Type=String Label== String== [Key_Shift_Row_2_ID_11] Type=String Label=? String=? [Key_Shift_Row_2_ID_12] Type=String Label=¡ String=¡ [Key_Shift_Row_2_ID_13] Type=VirtualKey Width=200 Label=⟵ KeyCode=8 [Key_Shift_Row_2_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_2_ID_15] Type=VirtualKey Label=Insert Cluster=Navigation KeyCode=45 [Key_Shift_Row_2_ID_16] Type=VirtualKey Label=Incio Cluster=Navigation KeyCode=36 [Key_Shift_Row_2_ID_17] Type=VirtualKey Label=RePág Cluster=Navigation KeyCode=33 [Key_Shift_Row_2_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_2_ID_19] Type=VirtualKey Label=Bloq\nNum Cluster=Numpad KeyCode=144 NoRepeat=true [Key_Shift_Row_2_ID_20] Type=VirtualKey Label=/ Cluster=Numpad KeyCode=111 [Key_Shift_Row_2_ID_21] Type=VirtualKey Label=* Cluster=Numpad KeyCode=106 [Key_Shift_Row_2_ID_22] Type=VirtualKey Label=- Cluster=Numpad KeyCode=109 [Key_Shift_Row_3_ID_0] Type=VirtualKey Width=150 Label=⭾ KeyCode=9 [Key_Shift_Row_3_ID_1] Type=VirtualKey Label=Q KeyCode=81 [Key_Shift_Row_3_ID_2] Type=VirtualKey Label=W KeyCode=87 [Key_Shift_Row_3_ID_3] Type=VirtualKey Label=E KeyCode=69 [Key_Shift_Row_3_ID_4] Type=VirtualKey Label=R KeyCode=82 [Key_Shift_Row_3_ID_5] Type=VirtualKey Label=T KeyCode=84 [Key_Shift_Row_3_ID_6] Type=VirtualKey Label=Y KeyCode=89 [Key_Shift_Row_3_ID_7] Type=VirtualKey Label=U KeyCode=85 [Key_Shift_Row_3_ID_8] Type=VirtualKey Label=I KeyCode=73 [Key_Shift_Row_3_ID_9] Type=VirtualKey Label=O KeyCode=79 [Key_Shift_Row_3_ID_10] Type=VirtualKey Label=P KeyCode=80 [Key_Shift_Row_3_ID_11] Type=String Label=¨ String=¨ [Key_Shift_Row_3_ID_12] Type=String Label=* String=* [Key_Shift_Row_3_ID_13] Type=VirtualKeyIsoEnter Width=150 Label= KeyCode=13 [Key_Shift_Row_3_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_3_ID_15] Type=VirtualKey Label=Supr Cluster=Navigation KeyCode=46 [Key_Shift_Row_3_ID_16] Type=VirtualKey Label=Fin Cluster=Navigation KeyCode=35 [Key_Shift_Row_3_ID_17] Type=VirtualKey Label=AvPág Cluster=Navigation KeyCode=34 [Key_Shift_Row_3_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_3_ID_19] Type=VirtualKey Label=7 Cluster=Numpad KeyCode=103 [Key_Shift_Row_3_ID_20] Type=VirtualKey Label=8 Cluster=Numpad KeyCode=104 [Key_Shift_Row_3_ID_21] Type=VirtualKey Label=9 Cluster=Numpad KeyCode=105 [Key_Shift_Row_3_ID_22] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 [Key_Shift_Row_4_ID_0] Type=VirtualKey Width=175 Label=Bloq Mayús KeyCode=20 NoRepeat=true [Key_Shift_Row_4_ID_1] Type=VirtualKey Label=A KeyCode=65 [Key_Shift_Row_4_ID_2] Type=VirtualKey Label=S KeyCode=83 [Key_Shift_Row_4_ID_3] Type=VirtualKey Label=D KeyCode=68 [Key_Shift_Row_4_ID_4] Type=VirtualKey Label=F KeyCode=70 [Key_Shift_Row_4_ID_5] Type=VirtualKey Label=G KeyCode=71 [Key_Shift_Row_4_ID_6] Type=VirtualKey Label=H KeyCode=72 [Key_Shift_Row_4_ID_7] Type=VirtualKey Label=J KeyCode=74 [Key_Shift_Row_4_ID_8] Type=VirtualKey Label=K KeyCode=75 [Key_Shift_Row_4_ID_9] Type=VirtualKey Label=L KeyCode=76 [Key_Shift_Row_4_ID_10] Type=String Label=Ñ String=Ñ [Key_Shift_Row_4_ID_11] Type=String Label=[ String=[ [Key_Shift_Row_4_ID_12] Type=String Label=] String=] [Key_Shift_Row_4_ID_13] Type=VirtualKeyIsoEnter Width=125 Label=↵ KeyCode=13 [Key_Shift_Row_4_ID_14] Type=Blank Width=325 Cluster=Navigation [Key_Shift_Row_4_ID_15] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_4_ID_16] Type=VirtualKey Label=4 Cluster=Numpad KeyCode=100 [Key_Shift_Row_4_ID_17] Type=VirtualKey Label=5 Cluster=Numpad KeyCode=101 [Key_Shift_Row_4_ID_18] Type=VirtualKey Label=6 Cluster=Numpad KeyCode=102 [Key_Shift_Row_5_ID_0] Type=VirtualKeyToggle Width=125 Label=🡅 KeyCode=160 NoRepeat=true [Key_Shift_Row_5_ID_1] Type=String Label=> String=> [Key_Shift_Row_5_ID_2] Type=VirtualKey Label=Z KeyCode=90 [Key_Shift_Row_5_ID_3] Type=VirtualKey Label=X KeyCode=88 [Key_Shift_Row_5_ID_4] Type=VirtualKey Label=C KeyCode=67 [Key_Shift_Row_5_ID_5] Type=VirtualKey Label=V KeyCode=86 [Key_Shift_Row_5_ID_6] Type=VirtualKey Label=B KeyCode=66 [Key_Shift_Row_5_ID_7] Type=VirtualKey Label=N KeyCode=78 [Key_Shift_Row_5_ID_8] Type=VirtualKey Label=M KeyCode=77 [Key_Shift_Row_5_ID_9] Type=String Label=; String=; [Key_Shift_Row_5_ID_10] Type=String Label=: String=: [Key_Shift_Row_5_ID_11] Type=String Label=_ String=_ [Key_Shift_Row_5_ID_12] Type=VirtualKeyToggle Width=275 Label=🡅 KeyCode=161 NoRepeat=true [Key_Shift_Row_5_ID_13] Type=Blank Width=125 Cluster=Navigation [Key_Shift_Row_5_ID_14] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_Shift_Row_5_ID_15] Type=Blank Cluster=Navigation [Key_Shift_Row_5_ID_16] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_5_ID_17] Type=VirtualKey Label=1 Cluster=Numpad KeyCode=97 [Key_Shift_Row_5_ID_18] Type=VirtualKey Label=2 Cluster=Numpad KeyCode=98 [Key_Shift_Row_5_ID_19] Type=VirtualKey Label=3 Cluster=Numpad KeyCode=99 [Key_Shift_Row_5_ID_20] Type=VirtualKey Height=200 Label=Intro Cluster=Numpad KeyCode=13 [Key_Shift_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=162 NoRepeat=true [Key_Shift_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_Shift_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_Shift_Row_6_ID_3] Type=VirtualKey Width=625 Label= KeyCode=32 [Key_Shift_Row_6_ID_4] Type=VirtualKeyToggle Width=125 Label=AltGr KeyCode=165 NoRepeat=true [Key_Shift_Row_6_ID_5] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_Shift_Row_6_ID_6] Type=VirtualKey Width=125 Label=Menu KeyCode=93 NoRepeat=true [Key_Shift_Row_6_ID_7] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=163 NoRepeat=true [Key_Shift_Row_6_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_6_ID_9] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_Shift_Row_6_ID_10] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_Shift_Row_6_ID_11] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_Shift_Row_6_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_6_ID_13] Type=VirtualKey Width=200 Label=0 Cluster=Numpad KeyCode=96 [Key_Shift_Row_6_ID_14] Type=VirtualKey Label=. Cluster=Numpad KeyCode=110 [Key_AltGr_Row_0_ID_0] Type=VirtualKey Label=Esc Cluster=Function KeyCode=27 NoRepeat=true [Key_AltGr_Row_0_ID_1] Type=Blank Cluster=Function [Key_AltGr_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_AltGr_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_AltGr_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_AltGr_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_AltGr_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_AltGr_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_AltGr_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_AltGr_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_AltGr_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_AltGr_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_AltGr_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_AltGr_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_AltGr_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_AltGr_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_AltGr_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_AltGr_Row_0_ID_17] Type=VirtualKey Label=Impr\nPant Cluster=Function KeyCode=44 NoRepeat=true [Key_AltGr_Row_0_ID_18] Type=VirtualKey Label=Bloq\nDespl Cluster=Function KeyCode=145 NoRepeat=true [Key_AltGr_Row_0_ID_19] Type=VirtualKey Label=Pausa Cluster=Function KeyCode=19 NoRepeat=true [Key_AltGr_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_AltGr_Row_0_ID_21] Type=VirtualKey Label=⏯ Cluster=Extra KeyCode=179 NoRepeat=true [Key_AltGr_Row_0_ID_22] Type=VirtualKey Label=◼ Cluster=Extra KeyCode=178 NoRepeat=true [Key_AltGr_Row_0_ID_23] Type=VirtualKey Label=⏮ Cluster=Extra KeyCode=177 NoRepeat=true [Key_AltGr_Row_0_ID_24] Type=VirtualKey Label=⏭ Cluster=Extra KeyCode=176 NoRepeat=true [Key_AltGr_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_AltGr_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra [Key_AltGr_Row_2_ID_0] Type=String Label=¬ String=¬ [Key_AltGr_Row_2_ID_1] Type=Blank Width=1000 [Key_AltGr_Row_2_ID_2] Type=String Label=\ String=\ [Key_AltGr_Row_2_ID_3] Type=Blank [Key_AltGr_Row_2_ID_4] Type=VirtualKey Width=200 Label=⟵ KeyCode=8 [Key_AltGr_Row_2_ID_5] Type=Blank Width=25 Cluster=Navigation [Key_AltGr_Row_2_ID_6] Type=VirtualKey Label=Insert Cluster=Navigation KeyCode=45 [Key_AltGr_Row_2_ID_7] Type=VirtualKey Label=Incio Cluster=Navigation KeyCode=36 [Key_AltGr_Row_2_ID_8] Type=VirtualKey Label=RePág Cluster=Navigation KeyCode=33 [Key_AltGr_Row_2_ID_9] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_2_ID_10] Type=VirtualKey Label=Bloq\nNum Cluster=Numpad KeyCode=144 NoRepeat=true [Key_AltGr_Row_2_ID_11] Type=VirtualKey Label=/ Cluster=Numpad KeyCode=111 [Key_AltGr_Row_2_ID_12] Type=VirtualKey Label=* Cluster=Numpad KeyCode=106 [Key_AltGr_Row_2_ID_13] Type=VirtualKey Label=- Cluster=Numpad KeyCode=109 [Key_AltGr_Row_3_ID_0] Type=VirtualKey Width=150 Label=⭾ KeyCode=9 [Key_AltGr_Row_3_ID_1] Type=String Label=@ String=@ [Key_AltGr_Row_3_ID_2] Type=Blank Width=1000 [Key_AltGr_Row_3_ID_3] Type=String Label=~ String=~ [Key_AltGr_Row_3_ID_4] Type=VirtualKeyIsoEnter Width=150 Label= KeyCode=13 [Key_AltGr_Row_3_ID_5] Type=Blank Width=25 Cluster=Navigation [Key_AltGr_Row_3_ID_6] Type=VirtualKey Label=Supr Cluster=Navigation KeyCode=46 [Key_AltGr_Row_3_ID_7] Type=VirtualKey Label=Fin Cluster=Navigation KeyCode=35 [Key_AltGr_Row_3_ID_8] Type=VirtualKey Label=AvPág Cluster=Navigation KeyCode=34 [Key_AltGr_Row_3_ID_9] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_3_ID_10] Type=VirtualKey Label=7 Cluster=Numpad KeyCode=103 [Key_AltGr_Row_3_ID_11] Type=VirtualKey Label=8 Cluster=Numpad KeyCode=104 [Key_AltGr_Row_3_ID_12] Type=VirtualKey Label=9 Cluster=Numpad KeyCode=105 [Key_AltGr_Row_3_ID_13] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 [Key_AltGr_Row_4_ID_0] Type=VirtualKey Width=175 Label=Bloq Mayús KeyCode=20 NoRepeat=true [Key_AltGr_Row_4_ID_1] Type=Blank Width=1000 [Key_AltGr_Row_4_ID_2] Type=String Label=^ String=^ [Key_AltGr_Row_4_ID_3] Type=String Label=` String=` [Key_AltGr_Row_4_ID_4] Type=VirtualKeyIsoEnter Width=125 Label=↵ KeyCode=13 [Key_AltGr_Row_4_ID_5] Type=Blank Width=325 Cluster=Navigation [Key_AltGr_Row_4_ID_6] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_4_ID_7] Type=VirtualKey Label=4 Cluster=Numpad KeyCode=100 [Key_AltGr_Row_4_ID_8] Type=VirtualKey Label=5 Cluster=Numpad KeyCode=101 [Key_AltGr_Row_4_ID_9] Type=VirtualKey Label=6 Cluster=Numpad KeyCode=102 [Key_AltGr_Row_5_ID_0] Type=VirtualKeyToggle Width=125 Label=🡅 KeyCode=160 NoRepeat=true [Key_AltGr_Row_5_ID_1] Type=Blank Width=1100 [Key_AltGr_Row_5_ID_2] Type=VirtualKeyToggle Width=275 Label=🡅 KeyCode=161 NoRepeat=true [Key_AltGr_Row_5_ID_3] Type=Blank Width=125 Cluster=Navigation [Key_AltGr_Row_5_ID_4] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_AltGr_Row_5_ID_5] Type=Blank Cluster=Navigation [Key_AltGr_Row_5_ID_6] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_5_ID_7] Type=VirtualKey Label=1 Cluster=Numpad KeyCode=97 [Key_AltGr_Row_5_ID_8] Type=VirtualKey Label=2 Cluster=Numpad KeyCode=98 [Key_AltGr_Row_5_ID_9] Type=VirtualKey Label=3 Cluster=Numpad KeyCode=99 [Key_AltGr_Row_5_ID_10] Type=VirtualKey Height=200 Label=Intro Cluster=Numpad KeyCode=13 [Key_AltGr_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=162 NoRepeat=true [Key_AltGr_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_AltGr_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_AltGr_Row_6_ID_3] Type=VirtualKey Width=625 Label= KeyCode=32 [Key_AltGr_Row_6_ID_4] Type=VirtualKeyToggle Width=125 Label=AltGr KeyCode=165 NoRepeat=true [Key_AltGr_Row_6_ID_5] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_AltGr_Row_6_ID_6] Type=VirtualKey Width=125 Label=Menu KeyCode=93 NoRepeat=true [Key_AltGr_Row_6_ID_7] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=163 NoRepeat=true [Key_AltGr_Row_6_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_AltGr_Row_6_ID_9] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_AltGr_Row_6_ID_10] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_AltGr_Row_6_ID_11] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_AltGr_Row_6_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_6_ID_13] Type=VirtualKey Width=200 Label=0 Cluster=Numpad KeyCode=96 [Key_AltGr_Row_6_ID_14] Type=VirtualKey Label=. Cluster=Numpad KeyCode=110 ================================================ FILE: assets/keyboards/qwerty_th_kedmanee.ini ================================================ [LayoutInfo] Name=QWERTY (Thai Kedmanee) Author=TangMo HasAltGr=false HasClusterFunction=true HasClusterNavigation=true HasClusterNumpad=true HasClusterExtra=true [Key_Base_Row_0_ID_0] Type=VirtualKey Label=Esc Cluster=Function KeyCode=27 NoRepeat=true [Key_Base_Row_0_ID_1] Type=Blank Cluster=Function [Key_Base_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_Base_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_Base_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_Base_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_Base_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_Base_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_Base_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_Base_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_Base_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_Base_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_Base_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_Base_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_Base_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_Base_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_Base_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_Base_Row_0_ID_17] Type=VirtualKey Label=Print\nScreen Cluster=Function KeyCode=44 NoRepeat=true [Key_Base_Row_0_ID_18] Type=VirtualKey Label=Scroll\nLock Cluster=Function KeyCode=145 NoRepeat=true [Key_Base_Row_0_ID_19] Type=VirtualKey Label=Pause Cluster=Function KeyCode=19 NoRepeat=true [Key_Base_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_Base_Row_0_ID_21] Type=VirtualKey Label=⏯ Cluster=Extra KeyCode=179 NoRepeat=true [Key_Base_Row_0_ID_22] Type=VirtualKey Label=◼ Cluster=Extra KeyCode=178 NoRepeat=true [Key_Base_Row_0_ID_23] Type=VirtualKey Label=⏮ Cluster=Extra KeyCode=177 NoRepeat=true [Key_Base_Row_0_ID_24] Type=VirtualKey Label=⏭ Cluster=Extra KeyCode=176 NoRepeat=true [Key_Base_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_Base_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra [Key_Base_Row_2_ID_0] Type=VirtualKey Label=`##L\n_##R KeyCode=192 [Key_Base_Row_2_ID_1] Type=VirtualKey Label=1##L\nๅ##R KeyCode=49 [Key_Base_Row_2_ID_2] Type=VirtualKey Label=2##L\n/##R KeyCode=50 [Key_Base_Row_2_ID_3] Type=VirtualKey Label=3##L\n-##R KeyCode=51 [Key_Base_Row_2_ID_4] Type=VirtualKey Label=4##L\nภ##R KeyCode=52 [Key_Base_Row_2_ID_5] Type=VirtualKey Label=5##L\nถ##R KeyCode=53 [Key_Base_Row_2_ID_6] Type=VirtualKey Label=6##L\nุ##R KeyCode=54 [Key_Base_Row_2_ID_7] Type=VirtualKey Label=7##L\nึ##R KeyCode=55 [Key_Base_Row_2_ID_8] Type=VirtualKey Label=8##L\nค##R KeyCode=56 [Key_Base_Row_2_ID_9] Type=VirtualKey Label=9##L\nต##R KeyCode=57 [Key_Base_Row_2_ID_10] Type=VirtualKey Label=0##L\nจ##R KeyCode=48 [Key_Base_Row_2_ID_11] Type=VirtualKey Label=-##L\nข##R KeyCode=189 [Key_Base_Row_2_ID_12] Type=VirtualKey Label==##L\nช##R KeyCode=187 [Key_Base_Row_2_ID_13] Type=VirtualKey Width=200 Label=Backspace KeyCode=8 [Key_Base_Row_2_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_2_ID_15] Type=VirtualKey Label=Insert Cluster=Navigation KeyCode=45 [Key_Base_Row_2_ID_16] Type=VirtualKey Label=Home Cluster=Navigation KeyCode=36 [Key_Base_Row_2_ID_17] Type=VirtualKey Label=PgUp Cluster=Navigation KeyCode=33 [Key_Base_Row_2_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_2_ID_19] Type=VirtualKey Label=Num##L\nLock##L Cluster=Numpad KeyCode=144 NoRepeat=true [Key_Base_Row_2_ID_20] Type=VirtualKey Label=/##L\n Cluster=Numpad KeyCode=111 [Key_Base_Row_2_ID_21] Type=VirtualKey Label=*##L\n Cluster=Numpad KeyCode=106 [Key_Base_Row_2_ID_22] Type=VirtualKey Label=-##L\n Cluster=Numpad KeyCode=109 [Key_Base_Row_3_ID_0] Type=VirtualKey Width=150 Label=Tab KeyCode=9 [Key_Base_Row_3_ID_1] Type=VirtualKey Label=q##L\nๆ##R KeyCode=81 [Key_Base_Row_3_ID_2] Type=VirtualKey Label=w ##L\nไ##R KeyCode=87 [Key_Base_Row_3_ID_3] Type=VirtualKey Label=e##L\nำ##R KeyCode=69 [Key_Base_Row_3_ID_4] Type=VirtualKey Label=r##L\nพ##R KeyCode=82 [Key_Base_Row_3_ID_5] Type=VirtualKey Label=t##L\nะ##R KeyCode=84 [Key_Base_Row_3_ID_6] Type=VirtualKey Label=y##L\nั##R KeyCode=89 [Key_Base_Row_3_ID_7] Type=VirtualKey Label=u##L\nี##R KeyCode=85 [Key_Base_Row_3_ID_8] Type=VirtualKey Label=i##L\nร##R KeyCode=73 [Key_Base_Row_3_ID_9] Type=VirtualKey Label=o##L\nน##R KeyCode=79 [Key_Base_Row_3_ID_10] Type=VirtualKey Label=p##L\nย##R KeyCode=80 [Key_Base_Row_3_ID_11] Type=VirtualKey Label=[##L\nบ##R KeyCode=219 [Key_Base_Row_3_ID_12] Type=VirtualKey Label=]##L\nล##R KeyCode=221 [Key_Base_Row_3_ID_13] Type=VirtualKey Width=150 Label=\##L\nฃ##R KeyCode=220 [Key_Base_Row_3_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_3_ID_15] Type=VirtualKey Label=Delete Cluster=Navigation KeyCode=46 [Key_Base_Row_3_ID_16] Type=VirtualKey Label=End Cluster=Navigation KeyCode=35 [Key_Base_Row_3_ID_17] Type=VirtualKey Label=PgDn Cluster=Navigation KeyCode=34 [Key_Base_Row_3_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_3_ID_19] Type=VirtualKey Label=7##L\nHome##L Cluster=Numpad KeyCode=103 [Key_Base_Row_3_ID_20] Type=VirtualKey Label=8##L\n↑##L Cluster=Numpad KeyCode=104 [Key_Base_Row_3_ID_21] Type=VirtualKey Label=9##L\nPgUp##L Cluster=Numpad KeyCode=105 [Key_Base_Row_3_ID_22] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 [Key_Base_Row_4_ID_0] Type=VirtualKey Width=175 Label=Caps Lock KeyCode=20 NoRepeat=true [Key_Base_Row_4_ID_1] Type=VirtualKey Label=a##L\nฟ##R KeyCode=65 [Key_Base_Row_4_ID_2] Type=VirtualKey Label=s##L\nห##R KeyCode=83 [Key_Base_Row_4_ID_3] Type=VirtualKey Label=d##L\nก##R KeyCode=68 [Key_Base_Row_4_ID_4] Type=VirtualKey Label=f##L\nด##R KeyCode=70 [Key_Base_Row_4_ID_5] Type=VirtualKey Label=g##L\nเ##R KeyCode=71 [Key_Base_Row_4_ID_6] Type=VirtualKey Label=h##L\n้##R KeyCode=72 [Key_Base_Row_4_ID_7] Type=VirtualKey Label=j##L\n่##R KeyCode=74 [Key_Base_Row_4_ID_8] Type=VirtualKey Label=k##L\nา##R KeyCode=75 [Key_Base_Row_4_ID_9] Type=VirtualKey Label=l##L\nส##R KeyCode=76 [Key_Base_Row_4_ID_10] Type=VirtualKey Label=;##L\nว##R KeyCode=186 [Key_Base_Row_4_ID_11] Type=VirtualKey Label='##L\nง##R KeyCode=222 [Key_Base_Row_4_ID_12] Type=VirtualKey Width=225 Label=Enter KeyCode=13 [Key_Base_Row_4_ID_13] Type=Blank Width=325 Cluster=Navigation [Key_Base_Row_4_ID_14] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_4_ID_15] Type=VirtualKey Label=4##L\n←##L Cluster=Numpad KeyCode=100 [Key_Base_Row_4_ID_16] Type=VirtualKey Label=5##L\n Cluster=Numpad KeyCode=101 [Key_Base_Row_4_ID_17] Type=VirtualKey Label=6##L\n→##L Cluster=Numpad KeyCode=102 [Key_Base_Row_5_ID_0] Type=VirtualKeyToggle Width=225 Label=Shift KeyCode=160 NoRepeat=true [Key_Base_Row_5_ID_1] Type=VirtualKey Label=z##L\nผ##R KeyCode=90 [Key_Base_Row_5_ID_2] Type=VirtualKey Label=x##L\nป##R KeyCode=88 [Key_Base_Row_5_ID_3] Type=VirtualKey Label=c##L\nแ##R KeyCode=67 [Key_Base_Row_5_ID_4] Type=VirtualKey Label=v##L\nอ##R KeyCode=86 [Key_Base_Row_5_ID_5] Type=VirtualKey Label=b##L\nิ##R KeyCode=66 [Key_Base_Row_5_ID_6] Type=VirtualKey Label=n##L\nื##R KeyCode=78 [Key_Base_Row_5_ID_7] Type=VirtualKey Label=m##L\nท##R KeyCode=77 [Key_Base_Row_5_ID_8] Type=VirtualKey Label=,##L\nม##R KeyCode=188 [Key_Base_Row_5_ID_9] Type=VirtualKey Label=.##L\nใ##R KeyCode=190 [Key_Base_Row_5_ID_10] Type=VirtualKey Label=/##L\nฝ##R KeyCode=191 [Key_Base_Row_5_ID_11] Type=VirtualKeyToggle Width=275 Label=Shift KeyCode=161 NoRepeat=true [Key_Base_Row_5_ID_12] Type=Blank Width=125 Cluster=Navigation [Key_Base_Row_5_ID_13] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_Base_Row_5_ID_14] Type=Blank Cluster=Navigation [Key_Base_Row_5_ID_15] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_5_ID_16] Type=VirtualKey Label=1##L\nEnd##L Cluster=Numpad KeyCode=97 [Key_Base_Row_5_ID_17] Type=VirtualKey Label=2##L\n↓##L Cluster=Numpad KeyCode=98 [Key_Base_Row_5_ID_18] Type=VirtualKey Label=3##L\nPgDn##L Cluster=Numpad KeyCode=99 [Key_Base_Row_5_ID_19] Type=VirtualKey Height=200 Label=Enter Cluster=Numpad KeyCode=13 [Key_Base_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=162 NoRepeat=true [Key_Base_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_Base_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_Base_Row_6_ID_3] Type=VirtualKey Width=625 Label= KeyCode=32 [Key_Base_Row_6_ID_4] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=165 NoRepeat=true [Key_Base_Row_6_ID_5] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_Base_Row_6_ID_6] Type=VirtualKey Width=125 Label=Menu KeyCode=93 NoRepeat=true [Key_Base_Row_6_ID_7] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=163 NoRepeat=true [Key_Base_Row_6_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_6_ID_9] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_Base_Row_6_ID_10] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_Base_Row_6_ID_11] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_Base_Row_6_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_6_ID_13] Type=VirtualKey Width=200 Label=0##L\nInsert##L Cluster=Numpad KeyCode=96 [Key_Base_Row_6_ID_14] Type=VirtualKey Label=.##L\nDel##L Cluster=Numpad KeyCode=110 [Key_Shift_Row_0_ID_0] Type=VirtualKey Label=Esc Cluster=Function KeyCode=27 NoRepeat=true [Key_Shift_Row_0_ID_1] Type=Blank Cluster=Function [Key_Shift_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_Shift_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_Shift_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_Shift_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_Shift_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_Shift_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_Shift_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_Shift_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_Shift_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_Shift_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_Shift_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_Shift_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_Shift_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_Shift_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_Shift_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_Shift_Row_0_ID_17] Type=VirtualKey Label=Print\nScreen Cluster=Function KeyCode=44 NoRepeat=true [Key_Shift_Row_0_ID_18] Type=VirtualKey Label=Scroll\nLock Cluster=Function KeyCode=145 NoRepeat=true [Key_Shift_Row_0_ID_19] Type=VirtualKey Label=Pause Cluster=Function KeyCode=19 NoRepeat=true [Key_Shift_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_Shift_Row_0_ID_21] Type=VirtualKey Label=🡰 Cluster=Extra KeyCode=166 NoRepeat=true [Key_Shift_Row_0_ID_22] Type=VirtualKey Label=🡲 Cluster=Extra KeyCode=167 NoRepeat=true [Key_Shift_Row_0_ID_23] Type=VirtualKey Label=🔇 Cluster=Extra KeyCode=173 NoRepeat=true [Key_Shift_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_Shift_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra [Key_Shift_Row_2_ID_0] Type=VirtualKey Label=~##L\n%##R KeyCode=192 [Key_Shift_Row_2_ID_1] Type=VirtualKey Label=!##L\n+##R KeyCode=49 [Key_Shift_Row_2_ID_2] Type=VirtualKey Label=@##L\n๑##R KeyCode=50 [Key_Shift_Row_2_ID_3] Type=VirtualKey Label=# ##L\n๒##R KeyCode=51 [Key_Shift_Row_2_ID_4] Type=VirtualKey Label=$##L\n๓##R KeyCode=52 [Key_Shift_Row_2_ID_5] Type=VirtualKey Label=%##L\n๔##R KeyCode=53 [Key_Shift_Row_2_ID_6] Type=VirtualKey Label=^##L\nู##R KeyCode=54 [Key_Shift_Row_2_ID_7] Type=VirtualKey Label=&##L\n฿##R KeyCode=55 [Key_Shift_Row_2_ID_8] Type=VirtualKey Label=*##L\n๕##R KeyCode=56 [Key_Shift_Row_2_ID_9] Type=VirtualKey Label=(##L\n๖##R KeyCode=57 [Key_Shift_Row_2_ID_10] Type=VirtualKey Label=)##L\n๗##R KeyCode=48 [Key_Shift_Row_2_ID_11] Type=VirtualKey Label=_##L\n๘##R KeyCode=189 [Key_Shift_Row_2_ID_12] Type=VirtualKey Label=+##L\n๙##R KeyCode=187 [Key_Shift_Row_2_ID_13] Type=VirtualKey Width=200 Label=Backspace KeyCode=8 [Key_Shift_Row_2_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_2_ID_15] Type=VirtualKey Label=Insert Cluster=Navigation KeyCode=45 [Key_Shift_Row_2_ID_16] Type=VirtualKey Label=Home Cluster=Navigation KeyCode=36 [Key_Shift_Row_2_ID_17] Type=VirtualKey Label=PgUp Cluster=Navigation KeyCode=33 [Key_Shift_Row_2_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_2_ID_19] Type=VirtualKey Label=Num##L\nLock##L Cluster=Numpad KeyCode=144 NoRepeat=true [Key_Shift_Row_2_ID_20] Type=VirtualKey Label=/##L\n Cluster=Numpad KeyCode=111 [Key_Shift_Row_2_ID_21] Type=VirtualKey Label=*##L\n Cluster=Numpad KeyCode=106 [Key_Shift_Row_2_ID_22] Type=VirtualKey Label=-##L\n Cluster=Numpad KeyCode=109 [Key_Shift_Row_3_ID_0] Type=VirtualKey Width=150 Label=Tab KeyCode=9 [Key_Shift_Row_3_ID_1] Type=VirtualKey Label=Q##L\n๐##R KeyCode=81 [Key_Shift_Row_3_ID_2] Type=VirtualKey Label=W##L\n"##R KeyCode=87 [Key_Shift_Row_3_ID_3] Type=VirtualKey Label=E##L\nฎ##R KeyCode=69 [Key_Shift_Row_3_ID_4] Type=VirtualKey Label=R##L\nฑ##R KeyCode=82 [Key_Shift_Row_3_ID_5] Type=VirtualKey Label=T##L\nธ##R KeyCode=84 [Key_Shift_Row_3_ID_6] Type=VirtualKey Label=Y##L\nํ##R KeyCode=89 [Key_Shift_Row_3_ID_7] Type=VirtualKey Label=U##L\n๊##R KeyCode=85 [Key_Shift_Row_3_ID_8] Type=VirtualKey Label=I##L\nณ##R KeyCode=73 [Key_Shift_Row_3_ID_9] Type=VirtualKey Label=O##L\nฯ##R KeyCode=79 [Key_Shift_Row_3_ID_10] Type=VirtualKey Label=P##L\nญ##R KeyCode=80 [Key_Shift_Row_3_ID_11] Type=VirtualKey Label={##L\nฐ##R KeyCode=219 [Key_Shift_Row_3_ID_12] Type=VirtualKey Label=}##L\n,##R KeyCode=221 [Key_Shift_Row_3_ID_13] Type=VirtualKey Width=150 Label=|##L\nฅ##R KeyCode=220 [Key_Shift_Row_3_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_3_ID_15] Type=VirtualKey Label=Delete Cluster=Navigation KeyCode=46 [Key_Shift_Row_3_ID_16] Type=VirtualKey Label=End Cluster=Navigation KeyCode=35 [Key_Shift_Row_3_ID_17] Type=VirtualKey Label=PgDn Cluster=Navigation KeyCode=34 [Key_Shift_Row_3_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_3_ID_19] Type=VirtualKey Label=7##L\nHome##L Cluster=Numpad KeyCode=103 [Key_Shift_Row_3_ID_20] Type=VirtualKey Label=8##L\n↑##L Cluster=Numpad KeyCode=104 [Key_Shift_Row_3_ID_21] Type=VirtualKey Label=9##L\nPgUp##L Cluster=Numpad KeyCode=105 [Key_Shift_Row_3_ID_22] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 [Key_Shift_Row_4_ID_0] Type=VirtualKey Width=175 Label=Caps Lock KeyCode=20 NoRepeat=true [Key_Shift_Row_4_ID_1] Type=VirtualKey Label=A##L\nฤ##R KeyCode=65 [Key_Shift_Row_4_ID_2] Type=VirtualKey Label=S##L\nฆ##R KeyCode=83 [Key_Shift_Row_4_ID_3] Type=VirtualKey Label=D##L\nฏ##R KeyCode=68 [Key_Shift_Row_4_ID_4] Type=VirtualKey Label=F##L\nโ##R KeyCode=70 [Key_Shift_Row_4_ID_5] Type=VirtualKey Label=G##L\nฌ##R KeyCode=71 [Key_Shift_Row_4_ID_6] Type=VirtualKey Label=H##L\n็##R KeyCode=72 [Key_Shift_Row_4_ID_7] Type=VirtualKey Label=J##L\n๋##R KeyCode=74 [Key_Shift_Row_4_ID_8] Type=VirtualKey Label=K##L\nษ##R KeyCode=75 [Key_Shift_Row_4_ID_9] Type=VirtualKey Label=L##L\nศ##R KeyCode=76 [Key_Shift_Row_4_ID_10] Type=VirtualKey Label=:##L\nซ##R KeyCode=186 [Key_Shift_Row_4_ID_11] Type=VirtualKey Label="##L\n.##R KeyCode=222 [Key_Shift_Row_4_ID_12] Type=VirtualKey Width=225 Label=Enter KeyCode=13 [Key_Shift_Row_4_ID_13] Type=Blank Width=325 Cluster=Navigation [Key_Shift_Row_4_ID_14] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_4_ID_15] Type=VirtualKey Label=4##L\n←##L Cluster=Numpad KeyCode=100 [Key_Shift_Row_4_ID_16] Type=VirtualKey Label=5##L\n Cluster=Numpad KeyCode=101 [Key_Shift_Row_4_ID_17] Type=VirtualKey Label=6##L\n→##L Cluster=Numpad KeyCode=102 [Key_Shift_Row_5_ID_0] Type=VirtualKeyToggle Width=225 Label=Shift KeyCode=160 NoRepeat=true [Key_Shift_Row_5_ID_1] Type=VirtualKey Label=Z##L\n(##R KeyCode=90 [Key_Shift_Row_5_ID_2] Type=VirtualKey Label=X##L\n)##R KeyCode=88 [Key_Shift_Row_5_ID_3] Type=VirtualKey Label=C##L\nฉ##R KeyCode=67 [Key_Shift_Row_5_ID_4] Type=VirtualKey Label=V##L\nฮ##R KeyCode=86 [Key_Shift_Row_5_ID_5] Type=VirtualKey Label=B##L\nฺ##R KeyCode=66 [Key_Shift_Row_5_ID_6] Type=VirtualKey Label=N##L\n์##R KeyCode=78 [Key_Shift_Row_5_ID_7] Type=VirtualKey Label=M##L\n?##R KeyCode=77 [Key_Shift_Row_5_ID_8] Type=VirtualKey Label=<##L\nฒ##R KeyCode=188 [Key_Shift_Row_5_ID_9] Type=VirtualKey Label=>##L\nฬ##R KeyCode=190 [Key_Shift_Row_5_ID_10] Type=VirtualKey Label=?##L\nฦ##R KeyCode=191 [Key_Shift_Row_5_ID_11] Type=VirtualKeyToggle Width=275 Label=Shift KeyCode=161 NoRepeat=true [Key_Shift_Row_5_ID_12] Type=Blank Width=125 Cluster=Navigation [Key_Shift_Row_5_ID_13] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_Shift_Row_5_ID_14] Type=Blank Cluster=Navigation [Key_Shift_Row_5_ID_15] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_5_ID_16] Type=VirtualKey Label=1##L\nEnd##L Cluster=Numpad KeyCode=97 [Key_Shift_Row_5_ID_17] Type=VirtualKey Label=2##L\n↓##L Cluster=Numpad KeyCode=98 [Key_Shift_Row_5_ID_18] Type=VirtualKey Label=3##L\nPgDn##L Cluster=Numpad KeyCode=99 [Key_Shift_Row_5_ID_19] Type=VirtualKey Height=200 Label=Enter Cluster=Numpad KeyCode=13 [Key_Shift_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=162 NoRepeat=true [Key_Shift_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_Shift_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_Shift_Row_6_ID_3] Type=VirtualKey Width=625 Label= KeyCode=32 [Key_Shift_Row_6_ID_4] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=165 NoRepeat=true [Key_Shift_Row_6_ID_5] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_Shift_Row_6_ID_6] Type=VirtualKey Width=125 Label=Menu KeyCode=93 NoRepeat=true [Key_Shift_Row_6_ID_7] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=163 NoRepeat=true [Key_Shift_Row_6_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_6_ID_9] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_Shift_Row_6_ID_10] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_Shift_Row_6_ID_11] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_Shift_Row_6_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_6_ID_13] Type=VirtualKey Width=200 Label=0##L\nInsert##L Cluster=Numpad KeyCode=96 [Key_Shift_Row_6_ID_14] Type=VirtualKey Label=.##L\nDel##L Cluster=Numpad KeyCode=110 ================================================ FILE: assets/keyboards/qwerty_uk.ini ================================================ [LayoutInfo] Name=QWERTY (United Kingdom) Author= HasAltGr=true HasClusterFunction=true HasClusterNavigation=true HasClusterNumpad=true HasClusterExtra=true [Key_Base_Row_0_ID_0] Type=VirtualKey Label=Esc Cluster=Function KeyCode=27 NoRepeat=true [Key_Base_Row_0_ID_1] Type=Blank Cluster=Function [Key_Base_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_Base_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_Base_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_Base_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_Base_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_Base_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_Base_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_Base_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_Base_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_Base_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_Base_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_Base_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_Base_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_Base_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_Base_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_Base_Row_0_ID_17] Type=VirtualKey Label=Print\nScreen Cluster=Function KeyCode=44 NoRepeat=true [Key_Base_Row_0_ID_18] Type=VirtualKey Label=Scroll\nLock Cluster=Function KeyCode=145 NoRepeat=true [Key_Base_Row_0_ID_19] Type=VirtualKey Label=Pause Cluster=Function KeyCode=19 NoRepeat=true [Key_Base_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_Base_Row_0_ID_21] Type=VirtualKey Label=⏯ Cluster=Extra KeyCode=179 NoRepeat=true [Key_Base_Row_0_ID_22] Type=VirtualKey Label=◼ Cluster=Extra KeyCode=178 NoRepeat=true [Key_Base_Row_0_ID_23] Type=VirtualKey Label=⏮ Cluster=Extra KeyCode=177 NoRepeat=true [Key_Base_Row_0_ID_24] Type=VirtualKey Label=⏭ Cluster=Extra KeyCode=176 NoRepeat=true [Key_Base_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_Base_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra [Key_Base_Row_2_ID_0] Type=String Label=` String=` [Key_Base_Row_2_ID_1] Type=VirtualKey Label=1 KeyCode=49 [Key_Base_Row_2_ID_2] Type=VirtualKey Label=2 KeyCode=50 [Key_Base_Row_2_ID_3] Type=VirtualKey Label=3 KeyCode=51 [Key_Base_Row_2_ID_4] Type=VirtualKey Label=4 KeyCode=52 [Key_Base_Row_2_ID_5] Type=VirtualKey Label=5 KeyCode=53 [Key_Base_Row_2_ID_6] Type=VirtualKey Label=6 KeyCode=54 [Key_Base_Row_2_ID_7] Type=VirtualKey Label=7 KeyCode=55 [Key_Base_Row_2_ID_8] Type=VirtualKey Label=8 KeyCode=56 [Key_Base_Row_2_ID_9] Type=VirtualKey Label=9 KeyCode=57 [Key_Base_Row_2_ID_10] Type=VirtualKey Label=0 KeyCode=48 [Key_Base_Row_2_ID_11] Type=String Label=- String=- [Key_Base_Row_2_ID_12] Type=String Label== String== [Key_Base_Row_2_ID_13] Type=VirtualKey Width=200 Label=⟵ KeyCode=8 [Key_Base_Row_2_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_2_ID_15] Type=VirtualKey Label=Insert Cluster=Navigation KeyCode=45 [Key_Base_Row_2_ID_16] Type=VirtualKey Label=Home Cluster=Navigation KeyCode=36 [Key_Base_Row_2_ID_17] Type=VirtualKey Label=PgUp Cluster=Navigation KeyCode=33 [Key_Base_Row_2_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_2_ID_19] Type=VirtualKey Label=Num\nLock Cluster=Numpad KeyCode=144 NoRepeat=true [Key_Base_Row_2_ID_20] Type=VirtualKey Label=/ Cluster=Numpad KeyCode=111 [Key_Base_Row_2_ID_21] Type=VirtualKey Label=* Cluster=Numpad KeyCode=106 [Key_Base_Row_2_ID_22] Type=VirtualKey Label=- Cluster=Numpad KeyCode=109 [Key_Base_Row_3_ID_0] Type=VirtualKey Width=150 Label=⭾ KeyCode=9 [Key_Base_Row_3_ID_1] Type=VirtualKey Label=q KeyCode=81 [Key_Base_Row_3_ID_2] Type=VirtualKey Label=w KeyCode=87 [Key_Base_Row_3_ID_3] Type=VirtualKey Label=e KeyCode=69 [Key_Base_Row_3_ID_4] Type=VirtualKey Label=r KeyCode=82 [Key_Base_Row_3_ID_5] Type=VirtualKey Label=t KeyCode=84 [Key_Base_Row_3_ID_6] Type=VirtualKey Label=y KeyCode=89 [Key_Base_Row_3_ID_7] Type=VirtualKey Label=u KeyCode=85 [Key_Base_Row_3_ID_8] Type=VirtualKey Label=i KeyCode=73 [Key_Base_Row_3_ID_9] Type=VirtualKey Label=o KeyCode=79 [Key_Base_Row_3_ID_10] Type=VirtualKey Label=p KeyCode=80 [Key_Base_Row_3_ID_11] Type=String Label=[ String=[ [Key_Base_Row_3_ID_12] Type=String Label=] String=] [Key_Base_Row_3_ID_13] Type=VirtualKeyIsoEnter Width=150 Label= KeyCode=13 [Key_Base_Row_3_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_3_ID_15] Type=VirtualKey Label=Delete Cluster=Navigation KeyCode=46 [Key_Base_Row_3_ID_16] Type=VirtualKey Label=End Cluster=Navigation KeyCode=35 [Key_Base_Row_3_ID_17] Type=VirtualKey Label=PgDn Cluster=Navigation KeyCode=34 [Key_Base_Row_3_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_3_ID_19] Type=VirtualKey Label=7 Cluster=Numpad KeyCode=103 [Key_Base_Row_3_ID_20] Type=VirtualKey Label=8 Cluster=Numpad KeyCode=104 [Key_Base_Row_3_ID_21] Type=VirtualKey Label=9 Cluster=Numpad KeyCode=105 [Key_Base_Row_3_ID_22] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 [Key_Base_Row_4_ID_0] Type=VirtualKey Width=175 Label=🡇 KeyCode=20 NoRepeat=true [Key_Base_Row_4_ID_1] Type=VirtualKey Label=a KeyCode=65 [Key_Base_Row_4_ID_2] Type=VirtualKey Label=s KeyCode=83 [Key_Base_Row_4_ID_3] Type=VirtualKey Label=d KeyCode=68 [Key_Base_Row_4_ID_4] Type=VirtualKey Label=f KeyCode=70 [Key_Base_Row_4_ID_5] Type=VirtualKey Label=g KeyCode=71 [Key_Base_Row_4_ID_6] Type=VirtualKey Label=h KeyCode=72 [Key_Base_Row_4_ID_7] Type=VirtualKey Label=j KeyCode=74 [Key_Base_Row_4_ID_8] Type=VirtualKey Label=k KeyCode=75 [Key_Base_Row_4_ID_9] Type=VirtualKey Label=l KeyCode=76 [Key_Base_Row_4_ID_10] Type=String Label=; String=; [Key_Base_Row_4_ID_11] Type=String Label=' String=' [Key_Base_Row_4_ID_12] Type=String Label=# String=# [Key_Base_Row_4_ID_13] Type=VirtualKeyIsoEnter Width=125 Label=↵ KeyCode=13 [Key_Base_Row_4_ID_14] Type=Blank Width=325 Cluster=Navigation [Key_Base_Row_4_ID_15] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_4_ID_16] Type=VirtualKey Label=4 Cluster=Numpad KeyCode=100 [Key_Base_Row_4_ID_17] Type=VirtualKey Label=5 Cluster=Numpad KeyCode=101 [Key_Base_Row_4_ID_18] Type=VirtualKey Label=6 Cluster=Numpad KeyCode=102 [Key_Base_Row_5_ID_0] Type=VirtualKeyToggle Width=125 Label=🡅 KeyCode=160 NoRepeat=true [Key_Base_Row_5_ID_1] Type=String Label=\ String=\ [Key_Base_Row_5_ID_2] Type=VirtualKey Label=z KeyCode=90 [Key_Base_Row_5_ID_3] Type=VirtualKey Label=x KeyCode=88 [Key_Base_Row_5_ID_4] Type=VirtualKey Label=c KeyCode=67 [Key_Base_Row_5_ID_5] Type=VirtualKey Label=v KeyCode=86 [Key_Base_Row_5_ID_6] Type=VirtualKey Label=b KeyCode=66 [Key_Base_Row_5_ID_7] Type=VirtualKey Label=n KeyCode=78 [Key_Base_Row_5_ID_8] Type=VirtualKey Label=m KeyCode=77 [Key_Base_Row_5_ID_9] Type=String Label=, String=, [Key_Base_Row_5_ID_10] Type=String Label=. String=. [Key_Base_Row_5_ID_11] Type=String Label=/ String=/ [Key_Base_Row_5_ID_12] Type=VirtualKeyToggle Width=275 Label=🡅 KeyCode=161 NoRepeat=true [Key_Base_Row_5_ID_13] Type=Blank Width=125 Cluster=Navigation [Key_Base_Row_5_ID_14] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_Base_Row_5_ID_15] Type=Blank Cluster=Navigation [Key_Base_Row_5_ID_16] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_5_ID_17] Type=VirtualKey Label=1 Cluster=Numpad KeyCode=97 [Key_Base_Row_5_ID_18] Type=VirtualKey Label=2 Cluster=Numpad KeyCode=98 [Key_Base_Row_5_ID_19] Type=VirtualKey Label=3 Cluster=Numpad KeyCode=99 [Key_Base_Row_5_ID_20] Type=VirtualKey Height=200 Label=Enter Cluster=Numpad KeyCode=13 [Key_Base_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=162 NoRepeat=true [Key_Base_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_Base_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_Base_Row_6_ID_3] Type=VirtualKey Width=625 Label= KeyCode=32 [Key_Base_Row_6_ID_4] Type=VirtualKeyToggle Width=125 Label=AltGr KeyCode=165 NoRepeat=true [Key_Base_Row_6_ID_5] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_Base_Row_6_ID_6] Type=VirtualKey Width=125 Label=Menu KeyCode=93 NoRepeat=true [Key_Base_Row_6_ID_7] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=163 NoRepeat=true [Key_Base_Row_6_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_6_ID_9] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_Base_Row_6_ID_10] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_Base_Row_6_ID_11] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_Base_Row_6_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_6_ID_13] Type=VirtualKey Width=200 Label=0 Cluster=Numpad KeyCode=96 [Key_Base_Row_6_ID_14] Type=VirtualKey Label=. Cluster=Numpad KeyCode=110 [Key_Shift_Row_0_ID_0] Type=VirtualKey Label=Esc Cluster=Function KeyCode=27 NoRepeat=true [Key_Shift_Row_0_ID_1] Type=Blank Cluster=Function [Key_Shift_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_Shift_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_Shift_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_Shift_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_Shift_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_Shift_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_Shift_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_Shift_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_Shift_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_Shift_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_Shift_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_Shift_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_Shift_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_Shift_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_Shift_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_Shift_Row_0_ID_17] Type=VirtualKey Label=Print\nScreen Cluster=Function KeyCode=44 NoRepeat=true [Key_Shift_Row_0_ID_18] Type=VirtualKey Label=Scroll\nLock Cluster=Function KeyCode=145 NoRepeat=true [Key_Shift_Row_0_ID_19] Type=VirtualKey Label=Pause Cluster=Function KeyCode=19 NoRepeat=true [Key_Shift_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_Shift_Row_0_ID_21] Type=VirtualKey Label=🡰 Cluster=Extra KeyCode=166 NoRepeat=true [Key_Shift_Row_0_ID_22] Type=VirtualKey Label=🡲 Cluster=Extra KeyCode=167 NoRepeat=true [Key_Shift_Row_0_ID_23] Type=VirtualKey Label=🔇 Cluster=Extra KeyCode=173 NoRepeat=true [Key_Shift_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_Shift_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra [Key_Shift_Row_2_ID_0] Type=String Label=¬ String=¬ [Key_Shift_Row_2_ID_1] Type=String Label=! String=! [Key_Shift_Row_2_ID_2] Type=String Label=" String=" [Key_Shift_Row_2_ID_3] Type=String Label=£ String=£ [Key_Shift_Row_2_ID_4] Type=String Label=$ String=$ [Key_Shift_Row_2_ID_5] Type=String Label=% String=% [Key_Shift_Row_2_ID_6] Type=String Label=^ String=^ [Key_Shift_Row_2_ID_7] Type=String Label=& String=& [Key_Shift_Row_2_ID_8] Type=String Label=* String=* [Key_Shift_Row_2_ID_9] Type=String Label=( String=( [Key_Shift_Row_2_ID_10] Type=String Label=) String=) [Key_Shift_Row_2_ID_11] Type=String Label=_ String=_ [Key_Shift_Row_2_ID_12] Type=String Label=+ String=+ [Key_Shift_Row_2_ID_13] Type=VirtualKey Width=200 Label=⟵ KeyCode=8 [Key_Shift_Row_2_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_2_ID_15] Type=VirtualKey Label=Insert Cluster=Navigation KeyCode=45 [Key_Shift_Row_2_ID_16] Type=VirtualKey Label=Home Cluster=Navigation KeyCode=36 [Key_Shift_Row_2_ID_17] Type=VirtualKey Label=PgUp Cluster=Navigation KeyCode=33 [Key_Shift_Row_2_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_2_ID_19] Type=VirtualKey Label=Num\nLock Cluster=Numpad KeyCode=144 NoRepeat=true [Key_Shift_Row_2_ID_20] Type=VirtualKey Label=/ Cluster=Numpad KeyCode=111 [Key_Shift_Row_2_ID_21] Type=VirtualKey Label=* Cluster=Numpad KeyCode=106 [Key_Shift_Row_2_ID_22] Type=VirtualKey Label=- Cluster=Numpad KeyCode=109 [Key_Shift_Row_3_ID_0] Type=VirtualKey Width=150 Label=⭾ KeyCode=9 [Key_Shift_Row_3_ID_1] Type=VirtualKey Label=Q KeyCode=81 [Key_Shift_Row_3_ID_2] Type=VirtualKey Label=W KeyCode=87 [Key_Shift_Row_3_ID_3] Type=VirtualKey Label=E KeyCode=69 [Key_Shift_Row_3_ID_4] Type=VirtualKey Label=R KeyCode=82 [Key_Shift_Row_3_ID_5] Type=VirtualKey Label=T KeyCode=84 [Key_Shift_Row_3_ID_6] Type=VirtualKey Label=Y KeyCode=89 [Key_Shift_Row_3_ID_7] Type=VirtualKey Label=U KeyCode=85 [Key_Shift_Row_3_ID_8] Type=VirtualKey Label=I KeyCode=73 [Key_Shift_Row_3_ID_9] Type=VirtualKey Label=O KeyCode=79 [Key_Shift_Row_3_ID_10] Type=VirtualKey Label=P KeyCode=80 [Key_Shift_Row_3_ID_11] Type=String Label={ String={ [Key_Shift_Row_3_ID_12] Type=String Label=} String=} [Key_Shift_Row_3_ID_13] Type=VirtualKeyIsoEnter Width=150 Label= KeyCode=13 [Key_Shift_Row_3_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_3_ID_15] Type=VirtualKey Label=Delete Cluster=Navigation KeyCode=46 [Key_Shift_Row_3_ID_16] Type=VirtualKey Label=End Cluster=Navigation KeyCode=35 [Key_Shift_Row_3_ID_17] Type=VirtualKey Label=PgDn Cluster=Navigation KeyCode=34 [Key_Shift_Row_3_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_3_ID_19] Type=VirtualKey Label=7 Cluster=Numpad KeyCode=103 [Key_Shift_Row_3_ID_20] Type=VirtualKey Label=8 Cluster=Numpad KeyCode=104 [Key_Shift_Row_3_ID_21] Type=VirtualKey Label=9 Cluster=Numpad KeyCode=105 [Key_Shift_Row_3_ID_22] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 [Key_Shift_Row_4_ID_0] Type=VirtualKey Width=175 Label=🡇 KeyCode=20 NoRepeat=true [Key_Shift_Row_4_ID_1] Type=VirtualKey Label=A KeyCode=65 [Key_Shift_Row_4_ID_2] Type=VirtualKey Label=S KeyCode=83 [Key_Shift_Row_4_ID_3] Type=VirtualKey Label=D KeyCode=68 [Key_Shift_Row_4_ID_4] Type=VirtualKey Label=F KeyCode=70 [Key_Shift_Row_4_ID_5] Type=VirtualKey Label=G KeyCode=71 [Key_Shift_Row_4_ID_6] Type=VirtualKey Label=H KeyCode=72 [Key_Shift_Row_4_ID_7] Type=VirtualKey Label=J KeyCode=74 [Key_Shift_Row_4_ID_8] Type=VirtualKey Label=K KeyCode=75 [Key_Shift_Row_4_ID_9] Type=VirtualKey Label=L KeyCode=76 [Key_Shift_Row_4_ID_10] Type=String Label=: String=: [Key_Shift_Row_4_ID_11] Type=String Label=@ String=@ [Key_Shift_Row_4_ID_12] Type=String Label=~ String=~ [Key_Shift_Row_4_ID_13] Type=VirtualKeyIsoEnter Width=125 Label=↵ KeyCode=13 [Key_Shift_Row_4_ID_14] Type=Blank Width=325 Cluster=Navigation [Key_Shift_Row_4_ID_15] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_4_ID_16] Type=VirtualKey Label=4 Cluster=Numpad KeyCode=100 [Key_Shift_Row_4_ID_17] Type=VirtualKey Label=5 Cluster=Numpad KeyCode=101 [Key_Shift_Row_4_ID_18] Type=VirtualKey Label=6 Cluster=Numpad KeyCode=102 [Key_Shift_Row_5_ID_0] Type=VirtualKeyToggle Width=125 Label=🡅 KeyCode=160 NoRepeat=true [Key_Shift_Row_5_ID_1] Type=String Label=| String=| [Key_Shift_Row_5_ID_2] Type=VirtualKey Label=Z KeyCode=90 [Key_Shift_Row_5_ID_3] Type=VirtualKey Label=X KeyCode=88 [Key_Shift_Row_5_ID_4] Type=VirtualKey Label=C KeyCode=67 [Key_Shift_Row_5_ID_5] Type=VirtualKey Label=V KeyCode=86 [Key_Shift_Row_5_ID_6] Type=VirtualKey Label=B KeyCode=66 [Key_Shift_Row_5_ID_7] Type=VirtualKey Label=N KeyCode=78 [Key_Shift_Row_5_ID_8] Type=VirtualKey Label=M KeyCode=77 [Key_Shift_Row_5_ID_9] Type=String Label=< String=< [Key_Shift_Row_5_ID_10] Type=String Label=> String=> [Key_Shift_Row_5_ID_11] Type=String Label=? String=? [Key_Shift_Row_5_ID_12] Type=VirtualKeyToggle Width=275 Label=🡅 KeyCode=161 NoRepeat=true [Key_Shift_Row_5_ID_13] Type=Blank Width=125 Cluster=Navigation [Key_Shift_Row_5_ID_14] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_Shift_Row_5_ID_15] Type=Blank Cluster=Navigation [Key_Shift_Row_5_ID_16] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_5_ID_17] Type=VirtualKey Label=1 Cluster=Numpad KeyCode=97 [Key_Shift_Row_5_ID_18] Type=VirtualKey Label=2 Cluster=Numpad KeyCode=98 [Key_Shift_Row_5_ID_19] Type=VirtualKey Label=3 Cluster=Numpad KeyCode=99 [Key_Shift_Row_5_ID_20] Type=VirtualKey Height=200 Label=Enter Cluster=Numpad KeyCode=13 [Key_Shift_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=162 NoRepeat=true [Key_Shift_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_Shift_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_Shift_Row_6_ID_3] Type=VirtualKey Width=625 Label= KeyCode=32 [Key_Shift_Row_6_ID_4] Type=VirtualKeyToggle Width=125 Label=AltGr KeyCode=165 NoRepeat=true [Key_Shift_Row_6_ID_5] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_Shift_Row_6_ID_6] Type=VirtualKey Width=125 Label=Menu KeyCode=93 NoRepeat=true [Key_Shift_Row_6_ID_7] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=163 NoRepeat=true [Key_Shift_Row_6_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_6_ID_9] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_Shift_Row_6_ID_10] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_Shift_Row_6_ID_11] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_Shift_Row_6_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_6_ID_13] Type=VirtualKey Width=200 Label=0 Cluster=Numpad KeyCode=96 [Key_Shift_Row_6_ID_14] Type=VirtualKey Label=. Cluster=Numpad KeyCode=110 [Key_AltGr_Row_0_ID_0] Type=VirtualKey Label=Esc Cluster=Function KeyCode=27 NoRepeat=true [Key_AltGr_Row_0_ID_1] Type=Blank Cluster=Function [Key_AltGr_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_AltGr_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_AltGr_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_AltGr_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_AltGr_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_AltGr_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_AltGr_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_AltGr_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_AltGr_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_AltGr_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_AltGr_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_AltGr_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_AltGr_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_AltGr_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_AltGr_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_AltGr_Row_0_ID_17] Type=VirtualKey Label=Print\nScreen Cluster=Function KeyCode=44 NoRepeat=true [Key_AltGr_Row_0_ID_18] Type=VirtualKey Label=Scroll\nLock Cluster=Function KeyCode=145 NoRepeat=true [Key_AltGr_Row_0_ID_19] Type=VirtualKey Label=Pause Cluster=Function KeyCode=19 NoRepeat=true [Key_AltGr_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_AltGr_Row_0_ID_21] Type=VirtualKey Label=⏯ Cluster=Extra KeyCode=179 NoRepeat=true [Key_AltGr_Row_0_ID_22] Type=VirtualKey Label=◼ Cluster=Extra KeyCode=178 NoRepeat=true [Key_AltGr_Row_0_ID_23] Type=VirtualKey Label=⏮ Cluster=Extra KeyCode=177 NoRepeat=true [Key_AltGr_Row_0_ID_24] Type=VirtualKey Label=⏭ Cluster=Extra KeyCode=176 NoRepeat=true [Key_AltGr_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_AltGr_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra [Key_AltGr_Row_2_ID_0] Type=String Label=¦ String=¦ [Key_AltGr_Row_2_ID_1] Type=Blank Width=300 [Key_AltGr_Row_2_ID_2] Type=String Label=€ String=€ [Key_AltGr_Row_2_ID_3] Type=Blank Width=800 [Key_AltGr_Row_2_ID_4] Type=VirtualKey Width=200 Label=⟵ KeyCode=8 [Key_AltGr_Row_2_ID_5] Type=Blank Width=25 Cluster=Navigation [Key_AltGr_Row_2_ID_6] Type=VirtualKey Label=Insert Cluster=Navigation KeyCode=45 [Key_AltGr_Row_2_ID_7] Type=VirtualKey Label=Home Cluster=Navigation KeyCode=36 [Key_AltGr_Row_2_ID_8] Type=VirtualKey Label=PgUp Cluster=Navigation KeyCode=33 [Key_AltGr_Row_2_ID_9] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_2_ID_10] Type=VirtualKey Label=Num\nLock Cluster=Numpad KeyCode=144 NoRepeat=true [Key_AltGr_Row_2_ID_11] Type=VirtualKey Label=/ Cluster=Numpad KeyCode=111 [Key_AltGr_Row_2_ID_12] Type=VirtualKey Label=* Cluster=Numpad KeyCode=106 [Key_AltGr_Row_2_ID_13] Type=VirtualKey Label=- Cluster=Numpad KeyCode=109 [Key_AltGr_Row_3_ID_0] Type=VirtualKey Width=150 Label=⭾ KeyCode=9 [Key_AltGr_Row_3_ID_1] Type=Blank Width=1200 [Key_AltGr_Row_3_ID_2] Type=VirtualKeyIsoEnter Width=150 Label= KeyCode=13 [Key_AltGr_Row_3_ID_3] Type=Blank Width=25 Cluster=Navigation [Key_AltGr_Row_3_ID_4] Type=VirtualKey Label=Delete Cluster=Navigation KeyCode=46 [Key_AltGr_Row_3_ID_5] Type=VirtualKey Label=End Cluster=Navigation KeyCode=35 [Key_AltGr_Row_3_ID_6] Type=VirtualKey Label=PgDn Cluster=Navigation KeyCode=34 [Key_AltGr_Row_3_ID_7] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_3_ID_8] Type=VirtualKey Label=7 Cluster=Numpad KeyCode=103 [Key_AltGr_Row_3_ID_9] Type=VirtualKey Label=8 Cluster=Numpad KeyCode=104 [Key_AltGr_Row_3_ID_10] Type=VirtualKey Label=9 Cluster=Numpad KeyCode=105 [Key_AltGr_Row_3_ID_11] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 [Key_AltGr_Row_4_ID_0] Type=VirtualKey Width=175 Label=🡇 KeyCode=20 NoRepeat=true [Key_AltGr_Row_4_ID_1] Type=Blank Width=1200 [Key_AltGr_Row_4_ID_2] Type=VirtualKeyIsoEnter Width=125 Label=↵ KeyCode=13 [Key_AltGr_Row_4_ID_3] Type=Blank Width=325 Cluster=Navigation [Key_AltGr_Row_4_ID_4] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_4_ID_5] Type=VirtualKey Label=4 Cluster=Numpad KeyCode=100 [Key_AltGr_Row_4_ID_6] Type=VirtualKey Label=5 Cluster=Numpad KeyCode=101 [Key_AltGr_Row_4_ID_7] Type=VirtualKey Label=6 Cluster=Numpad KeyCode=102 [Key_AltGr_Row_5_ID_0] Type=VirtualKeyToggle Width=125 Label=🡅 KeyCode=160 NoRepeat=true [Key_AltGr_Row_5_ID_1] Type=Blank Width=1100 [Key_AltGr_Row_5_ID_2] Type=VirtualKeyToggle Width=275 Label=🡅 KeyCode=161 NoRepeat=true [Key_AltGr_Row_5_ID_3] Type=Blank Width=125 Cluster=Navigation [Key_AltGr_Row_5_ID_4] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_AltGr_Row_5_ID_5] Type=Blank Cluster=Navigation [Key_AltGr_Row_5_ID_6] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_5_ID_7] Type=VirtualKey Label=1 Cluster=Numpad KeyCode=97 [Key_AltGr_Row_5_ID_8] Type=VirtualKey Label=2 Cluster=Numpad KeyCode=98 [Key_AltGr_Row_5_ID_9] Type=VirtualKey Label=3 Cluster=Numpad KeyCode=99 [Key_AltGr_Row_5_ID_10] Type=VirtualKey Height=200 Label=Enter Cluster=Numpad KeyCode=13 [Key_AltGr_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=162 NoRepeat=true [Key_AltGr_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_AltGr_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_AltGr_Row_6_ID_3] Type=VirtualKey Width=625 Label= KeyCode=32 [Key_AltGr_Row_6_ID_4] Type=VirtualKeyToggle Width=125 Label=AltGr KeyCode=165 NoRepeat=true [Key_AltGr_Row_6_ID_5] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_AltGr_Row_6_ID_6] Type=VirtualKey Width=125 Label=Menu KeyCode=93 NoRepeat=true [Key_AltGr_Row_6_ID_7] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=163 NoRepeat=true [Key_AltGr_Row_6_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_AltGr_Row_6_ID_9] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_AltGr_Row_6_ID_10] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_AltGr_Row_6_ID_11] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_AltGr_Row_6_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_6_ID_13] Type=VirtualKey Width=200 Label=0 Cluster=Numpad KeyCode=96 [Key_AltGr_Row_6_ID_14] Type=VirtualKey Label=. Cluster=Numpad KeyCode=110 ================================================ FILE: assets/keyboards/qwerty_usa.ini ================================================ [LayoutInfo] Name=QWERTY (USA) HasAltGr=false HasClusterFunction=true HasClusterNavigation=true HasClusterNumpad=true HasClusterExtra=true ;[Key_{SubLayout}_Row_{Row}_ID_{ID}] ;Type=Blank / VirtualKey / VirtualKeyToggle / VirtualKeyIsoEnter / String / SubLayoutToggle / Action ;Width=Value in % | Optional, defaults to 100 ;Height=Value in % | Optional, defaults to 100 ;Label=Key Label | Not used with type Blank, use \n for a second line ;Cluster=Base / Function / Navigation / Numpad / Extra | Optional, defaults to Base ;KeyCode=Virtual key code (decimal) | Use with type VirtualKey / VirtualKeyToggle / VirtualKeyIsoEnter ;BlockModifiers=true/false | Optional, defaults to false. Use with type VirtualKey ;NoRepeat=true/false | Optional, defaults to false ;String=String typed by the key (UTF-8) | Use with type String ;SubLayout=SubLayout Name | Use with type SubLayoutToggle ;ActionID=Global Action ID | Use with type Action ; ;Possible sublayouts: Base / Shift / AltGr / Aux ; ;Use String type for non-basic character keys. This allows Desktop+ to figure out the correct key combination on the real keyboard layout for maximum application compatibility. ;Use two VirtualKeyIsoEnter in adjacent rows to build an ISO-Enter shaped key. One max per sublayout. ;Use BlockModifiers to have all modifier keys be released while the key is pressed. Not recommended in general, but can come handy when having auxiliary keys in modifier sublayouts. ;Use NoRepeat to block key repeat from holding down even when key repeat is enabled. Recommend for keys that typically do not repeat on real keyboards. ; ;Cluster assignment is used to selectively disable loading of keys. Function cluster should also include the keys next to the actual function keys so the whole row can be toggled. ;Surrounding blank space is not removed. Carefully assign blank space type keys to clusters in order to have them toggle correctly... or don't use clusters at all. ; ;Global Action ID's are not really displayed anywhere, but basically anything below ID 1000 is reserved for built-in actions and custom action are their ID + 1000. ;Refer to the source code or values of ActionBarOrderCustom in config.ini for built-in action IDs for now. ;----------------------Row 0 [Key_Base_Row_0_ID_0] Type=VirtualKey Label=Esc Cluster=Function KeyCode=27 NoRepeat=true [Key_Base_Row_0_ID_1] Type=Blank Cluster=Function [Key_Base_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_Base_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_Base_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_Base_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_Base_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_Base_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_Base_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_Base_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_Base_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_Base_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_Base_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_Base_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_Base_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_Base_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_Base_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_Base_Row_0_ID_17] Type=VirtualKey Label=Print\nScreen Cluster=Function KeyCode=44 NoRepeat=true [Key_Base_Row_0_ID_18] Type=VirtualKey Label=Scroll\nLock Cluster=Function KeyCode=145 NoRepeat=true [Key_Base_Row_0_ID_19] Type=VirtualKey Label=Pause Cluster=Function KeyCode=19 NoRepeat=true [Key_Base_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_Base_Row_0_ID_21] Type=VirtualKey Label=⏯ Cluster=Extra KeyCode=179 NoRepeat=true [Key_Base_Row_0_ID_22] Type=VirtualKey Label=◼ Cluster=Extra KeyCode=178 NoRepeat=true [Key_Base_Row_0_ID_23] Type=VirtualKey Label=⏮ Cluster=Extra KeyCode=177 NoRepeat=true [Key_Base_Row_0_ID_24] Type=VirtualKey Label=⏭ Cluster=Extra KeyCode=176 NoRepeat=true ;----------------------Row 1 (25% height blank space) [Key_Base_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_Base_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra ;----------------------Row 2 [Key_Base_Row_2_ID_0] Type=String Label=` String=` [Key_Base_Row_2_ID_1] Type=VirtualKey Label=1 KeyCode=49 [Key_Base_Row_2_ID_2] Type=VirtualKey Label=2 KeyCode=50 [Key_Base_Row_2_ID_3] Type=VirtualKey Label=3 KeyCode=51 [Key_Base_Row_2_ID_4] Type=VirtualKey Label=4 KeyCode=52 [Key_Base_Row_2_ID_5] Type=VirtualKey Label=5 KeyCode=53 [Key_Base_Row_2_ID_6] Type=VirtualKey Label=6 KeyCode=54 [Key_Base_Row_2_ID_7] Type=VirtualKey Label=7 KeyCode=55 [Key_Base_Row_2_ID_8] Type=VirtualKey Label=8 KeyCode=56 [Key_Base_Row_2_ID_9] Type=VirtualKey Label=9 KeyCode=57 [Key_Base_Row_2_ID_10] Type=VirtualKey Label=0 KeyCode=48 [Key_Base_Row_2_ID_11] Type=String Label=- String=- [Key_Base_Row_2_ID_12] Type=String Label== String== [Key_Base_Row_2_ID_13] Type=VirtualKey Width=200 Label=Backspace KeyCode=8 [Key_Base_Row_2_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_2_ID_15] Type=VirtualKey Label=Insert Cluster=Navigation KeyCode=45 [Key_Base_Row_2_ID_16] Type=VirtualKey Label=Home Cluster=Navigation KeyCode=36 [Key_Base_Row_2_ID_17] Type=VirtualKey Label=PgUp Cluster=Navigation KeyCode=33 [Key_Base_Row_2_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_2_ID_19] Type=VirtualKey Label=Num\nLock Cluster=Numpad KeyCode=144 NoRepeat=true [Key_Base_Row_2_ID_20] Type=VirtualKey Label=/ Cluster=Numpad KeyCode=111 [Key_Base_Row_2_ID_21] Type=VirtualKey Label=* Cluster=Numpad KeyCode=106 [Key_Base_Row_2_ID_22] Type=VirtualKey Label=- Cluster=Numpad KeyCode=109 ;----------------------Row 3 [Key_Base_Row_3_ID_0] Type=VirtualKey Width=150 Label=Tab KeyCode=9 [Key_Base_Row_3_ID_1] Type=VirtualKey Label=q KeyCode=81 [Key_Base_Row_3_ID_2] Type=VirtualKey Label=w KeyCode=87 [Key_Base_Row_3_ID_3] Type=VirtualKey Label=e KeyCode=69 [Key_Base_Row_3_ID_4] Type=VirtualKey Label=r KeyCode=82 [Key_Base_Row_3_ID_5] Type=VirtualKey Label=t KeyCode=84 [Key_Base_Row_3_ID_6] Type=VirtualKey Label=y KeyCode=89 [Key_Base_Row_3_ID_7] Type=VirtualKey Label=u KeyCode=85 [Key_Base_Row_3_ID_8] Type=VirtualKey Label=i KeyCode=73 [Key_Base_Row_3_ID_9] Type=VirtualKey Label=o KeyCode=79 [Key_Base_Row_3_ID_10] Type=VirtualKey Label=p KeyCode=80 [Key_Base_Row_3_ID_11] Type=String Label=[ String=[ [Key_Base_Row_3_ID_12] Type=String Label=] String=] [Key_Base_Row_3_ID_13] Type=String Width=150 Label=\ String=\ [Key_Base_Row_3_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_3_ID_15] Type=VirtualKey Label=Delete Cluster=Navigation KeyCode=46 [Key_Base_Row_3_ID_16] Type=VirtualKey Label=End Cluster=Navigation KeyCode=35 [Key_Base_Row_3_ID_17] Type=VirtualKey Label=PgDn Cluster=Navigation KeyCode=34 [Key_Base_Row_3_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_3_ID_19] Type=VirtualKey Label=7 Cluster=Numpad KeyCode=103 [Key_Base_Row_3_ID_20] Type=VirtualKey Label=8 Cluster=Numpad KeyCode=104 [Key_Base_Row_3_ID_21] Type=VirtualKey Label=9 Cluster=Numpad KeyCode=105 [Key_Base_Row_3_ID_22] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 ;----------------------Row 4 [Key_Base_Row_4_ID_0] Type=VirtualKey Width=175 Label=Caps Lock KeyCode=20 NoRepeat=true [Key_Base_Row_4_ID_1] Type=VirtualKey Label=a KeyCode=65 [Key_Base_Row_4_ID_2] Type=VirtualKey Label=s KeyCode=83 [Key_Base_Row_4_ID_3] Type=VirtualKey Label=d KeyCode=68 [Key_Base_Row_4_ID_4] Type=VirtualKey Label=f KeyCode=70 [Key_Base_Row_4_ID_5] Type=VirtualKey Label=g KeyCode=71 [Key_Base_Row_4_ID_6] Type=VirtualKey Label=h KeyCode=72 [Key_Base_Row_4_ID_7] Type=VirtualKey Label=j KeyCode=74 [Key_Base_Row_4_ID_8] Type=VirtualKey Label=k KeyCode=75 [Key_Base_Row_4_ID_9] Type=VirtualKey Label=l KeyCode=76 [Key_Base_Row_4_ID_10] Type=String Label=; String=; [Key_Base_Row_4_ID_11] Type=String Label=' String=' [Key_Base_Row_4_ID_12] Type=VirtualKey Width=225 Label=Enter KeyCode=13 [Key_Base_Row_4_ID_13] Type=Blank Width=325 Cluster=Navigation [Key_Base_Row_4_ID_14] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_4_ID_15] Type=VirtualKey Label=4 Cluster=Numpad KeyCode=100 [Key_Base_Row_4_ID_16] Type=VirtualKey Label=5 Cluster=Numpad KeyCode=101 [Key_Base_Row_4_ID_17] Type=VirtualKey Label=6 Cluster=Numpad KeyCode=102 ;----------------------Row 5 [Key_Base_Row_5_ID_0] Type=VirtualKeyToggle Width=225 Label=Shift KeyCode=160 NoRepeat=true [Key_Base_Row_5_ID_1] Type=VirtualKey Label=z KeyCode=90 [Key_Base_Row_5_ID_2] Type=VirtualKey Label=x KeyCode=88 [Key_Base_Row_5_ID_3] Type=VirtualKey Label=c KeyCode=67 [Key_Base_Row_5_ID_4] Type=VirtualKey Label=v KeyCode=86 [Key_Base_Row_5_ID_5] Type=VirtualKey Label=b KeyCode=66 [Key_Base_Row_5_ID_6] Type=VirtualKey Label=n KeyCode=78 [Key_Base_Row_5_ID_7] Type=VirtualKey Label=m KeyCode=77 [Key_Base_Row_5_ID_8] Type=String Label=, String=, [Key_Base_Row_5_ID_9] Type=String Label=. String=. [Key_Base_Row_5_ID_10] Type=String Label=/ String=/ [Key_Base_Row_5_ID_11] Type=VirtualKeyToggle Width=275 Label=Shift KeyCode=161 NoRepeat=true [Key_Base_Row_5_ID_12] Type=Blank Width=125 Cluster=Navigation [Key_Base_Row_5_ID_13] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_Base_Row_5_ID_14] Type=Blank Width=100 Cluster=Navigation [Key_Base_Row_5_ID_15] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_5_ID_16] Type=VirtualKey Label=1 Cluster=Numpad KeyCode=97 [Key_Base_Row_5_ID_17] Type=VirtualKey Label=2 Cluster=Numpad KeyCode=98 [Key_Base_Row_5_ID_18] Type=VirtualKey Label=3 Cluster=Numpad KeyCode=99 [Key_Base_Row_5_ID_19] Type=VirtualKey Height=200 Label=Enter Cluster=Numpad KeyCode=13 ;----------------------Row 6 [Key_Base_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=162 NoRepeat=true [Key_Base_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_Base_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_Base_Row_6_ID_3] ;Space Bar Type=VirtualKey Width=625 Label= KeyCode=32 [Key_Base_Row_6_ID_4] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=165 NoRepeat=true [Key_Base_Row_6_ID_5] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_Base_Row_6_ID_6] Type=VirtualKey Width=125 Label=Menu KeyCode=93 NoRepeat=true [Key_Base_Row_6_ID_7] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=163 NoRepeat=true [Key_Base_Row_6_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_6_ID_9] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_Base_Row_6_ID_10] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_Base_Row_6_ID_11] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_Base_Row_6_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_6_ID_13] Type=VirtualKey Width=200 Label=0 Cluster=Numpad KeyCode=96 [Key_Base_Row_6_ID_14] Type=VirtualKey Label=, Cluster=Numpad KeyCode=110 ;----------------------Shift SubLayout ; ;----------------------Row 0 [Key_Shift_Row_0_ID_0] Type=VirtualKey Label=Esc Cluster=Function KeyCode=27 NoRepeat=true [Key_Shift_Row_0_ID_1] Type=Blank Cluster=Function [Key_Shift_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_Shift_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_Shift_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_Shift_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_Shift_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_Shift_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_Shift_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_Shift_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_Shift_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_Shift_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_Shift_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_Shift_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_Shift_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_Shift_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_Shift_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_Shift_Row_0_ID_17] Type=VirtualKey Label=Print\nScreen Cluster=Function KeyCode=44 NoRepeat=true [Key_Shift_Row_0_ID_18] Type=VirtualKey Label=Scroll\nLock Cluster=Function KeyCode=145 NoRepeat=true [Key_Shift_Row_0_ID_19] Type=VirtualKey Label=Pause Cluster=Function KeyCode=19 NoRepeat=true [Key_Shift_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_Shift_Row_0_ID_21] Type=VirtualKey Label=🡰 Cluster=Extra KeyCode=166 BlockModifiers=true NoRepeat=true [Key_Shift_Row_0_ID_22] Type=VirtualKey Label=🡲 Cluster=Extra KeyCode=167 BlockModifiers=true NoRepeat=true [Key_Shift_Row_0_ID_23] Type=VirtualKey Label=🔇 Cluster=Extra KeyCode=173 NoRepeat=true ;----------------------Row 1 (25% height blank space) [Key_Shift_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_Shift_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra ;----------------------Row 2 [Key_Shift_Row_2_ID_0] Type=String Label=~ String=~ [Key_Shift_Row_2_ID_1] Type=String Label=! String=! [Key_Shift_Row_2_ID_2] Type=String Label=@ String=@ [Key_Shift_Row_2_ID_3] Type=String Label=# String=# [Key_Shift_Row_2_ID_4] Type=String Label=$ String=$ [Key_Shift_Row_2_ID_5] Type=String Label=% String=% [Key_Shift_Row_2_ID_6] Type=String Label=^ String=^ [Key_Shift_Row_2_ID_7] Type=String Label=& String=& [Key_Shift_Row_2_ID_8] Type=String Label=* String=* [Key_Shift_Row_2_ID_9] Type=String Label=( String=( [Key_Shift_Row_2_ID_10] Type=String Label=) String=) [Key_Shift_Row_2_ID_11] Type=String Label=_ String=_ [Key_Shift_Row_2_ID_12] Type=String Label=+ String=+ [Key_Shift_Row_2_ID_13] Type=VirtualKey Width=200 Label=Backspace KeyCode=8 [Key_Shift_Row_2_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_2_ID_15] Type=VirtualKey Label=Insert Cluster=Navigation KeyCode=45 [Key_Shift_Row_2_ID_16] Type=VirtualKey Label=Home Cluster=Navigation KeyCode=36 [Key_Shift_Row_2_ID_17] Type=VirtualKey Label=PgUp Cluster=Navigation KeyCode=33 [Key_Shift_Row_2_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_2_ID_19] Type=VirtualKey Label=Num\nLock Cluster=Numpad KeyCode=144 NoRepeat=true [Key_Shift_Row_2_ID_20] Type=VirtualKey Label=/ Cluster=Numpad KeyCode=111 [Key_Shift_Row_2_ID_21] Type=VirtualKey Label=* Cluster=Numpad KeyCode=106 [Key_Shift_Row_2_ID_22] Type=VirtualKey Label=- Cluster=Numpad KeyCode=109 ;----------------------Row 3 [Key_Shift_Row_3_ID_0] Type=VirtualKey Width=150 Label=Tab KeyCode=9 [Key_Shift_Row_3_ID_1] Type=VirtualKey Label=Q KeyCode=81 [Key_Shift_Row_3_ID_2] Type=VirtualKey Label=W KeyCode=87 [Key_Shift_Row_3_ID_3] Type=VirtualKey Label=E KeyCode=69 [Key_Shift_Row_3_ID_4] Type=VirtualKey Label=R KeyCode=82 [Key_Shift_Row_3_ID_5] Type=VirtualKey Label=T KeyCode=84 [Key_Shift_Row_3_ID_6] Type=VirtualKey Label=Y KeyCode=89 [Key_Shift_Row_3_ID_7] Type=VirtualKey Label=U KeyCode=85 [Key_Shift_Row_3_ID_8] Type=VirtualKey Label=I KeyCode=73 [Key_Shift_Row_3_ID_9] Type=VirtualKey Label=O KeyCode=79 [Key_Shift_Row_3_ID_10] Type=VirtualKey Label=P KeyCode=80 [Key_Shift_Row_3_ID_11] Type=String Label={ String={ [Key_Shift_Row_3_ID_12] Type=String Label=} String=} [Key_Shift_Row_3_ID_13] Type=String Width=150 Label=| String=| [Key_Shift_Row_3_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_3_ID_15] Type=VirtualKey Label=Delete Cluster=Navigation KeyCode=46 [Key_Shift_Row_3_ID_16] Type=VirtualKey Label=End Cluster=Navigation KeyCode=35 [Key_Shift_Row_3_ID_17] Type=VirtualKey Label=PgDn Cluster=Navigation KeyCode=34 [Key_Shift_Row_3_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_3_ID_19] Type=VirtualKey Label=7 Cluster=Numpad KeyCode=103 [Key_Shift_Row_3_ID_20] Type=VirtualKey Label=8 Cluster=Numpad KeyCode=104 [Key_Shift_Row_3_ID_21] Type=VirtualKey Label=9 Cluster=Numpad KeyCode=105 [Key_Shift_Row_3_ID_22] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 ;----------------------Row 4 [Key_Shift_Row_4_ID_0] Type=VirtualKey Width=175 Label=Caps Lock KeyCode=20 NoRepeat=true [Key_Shift_Row_4_ID_1] Type=VirtualKey Label=A KeyCode=65 [Key_Shift_Row_4_ID_2] Type=VirtualKey Label=S KeyCode=83 [Key_Shift_Row_4_ID_3] Type=VirtualKey Label=D KeyCode=68 [Key_Shift_Row_4_ID_4] Type=VirtualKey Label=F KeyCode=70 [Key_Shift_Row_4_ID_5] Type=VirtualKey Label=G KeyCode=71 [Key_Shift_Row_4_ID_6] Type=VirtualKey Label=H KeyCode=72 [Key_Shift_Row_4_ID_7] Type=VirtualKey Label=J KeyCode=74 [Key_Shift_Row_4_ID_8] Type=VirtualKey Label=K KeyCode=75 [Key_Shift_Row_4_ID_9] Type=VirtualKey Label=L KeyCode=76 [Key_Shift_Row_4_ID_10] Type=String Label=: String=: [Key_Shift_Row_4_ID_11] Type=String Label=" String=" [Key_Shift_Row_4_ID_12] Type=VirtualKey Width=225 Label=Enter KeyCode=13 [Key_Shift_Row_4_ID_13] Type=Blank Width=325 Cluster=Navigation [Key_Shift_Row_4_ID_14] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_4_ID_15] Type=VirtualKey Label=4 Cluster=Numpad KeyCode=100 [Key_Shift_Row_4_ID_16] Type=VirtualKey Label=5 Cluster=Numpad KeyCode=101 [Key_Shift_Row_4_ID_17] Type=VirtualKey Label=6 Cluster=Numpad KeyCode=102 ;----------------------Row 5 [Key_Shift_Row_5_ID_0] Type=VirtualKeyToggle Width=225 Label=Shift KeyCode=160 NoRepeat=true [Key_Shift_Row_5_ID_1] Type=VirtualKey Label=Z KeyCode=90 [Key_Shift_Row_5_ID_2] Type=VirtualKey Label=X KeyCode=88 [Key_Shift_Row_5_ID_3] Type=VirtualKey Label=C KeyCode=67 [Key_Shift_Row_5_ID_4] Type=VirtualKey Label=V KeyCode=86 [Key_Shift_Row_5_ID_5] Type=VirtualKey Label=B KeyCode=66 [Key_Shift_Row_5_ID_6] Type=VirtualKey Label=N KeyCode=78 [Key_Shift_Row_5_ID_7] Type=VirtualKey Label=M KeyCode=77 [Key_Shift_Row_5_ID_8] Type=String Label=< String=< [Key_Shift_Row_5_ID_9] Type=String Label=> String=> [Key_Shift_Row_5_ID_10] Type=String Label=? String=? [Key_Shift_Row_5_ID_11] Type=VirtualKeyToggle Width=275 Label=Shift KeyCode=161 NoRepeat=true [Key_Shift_Row_5_ID_12] Type=Blank Width=125 Cluster=Navigation [Key_Shift_Row_5_ID_13] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_Shift_Row_5_ID_14] Type=Blank Width=100 Cluster=Navigation [Key_Shift_Row_5_ID_15] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_5_ID_16] Type=VirtualKey Label=1 Cluster=Numpad KeyCode=97 [Key_Shift_Row_5_ID_17] Type=VirtualKey Label=2 Cluster=Numpad KeyCode=98 [Key_Shift_Row_5_ID_18] Type=VirtualKey Label=3 Cluster=Numpad KeyCode=99 [Key_Shift_Row_5_ID_19] Type=VirtualKey Height=200 Label=Enter Cluster=Numpad KeyCode=13 ;----------------------Row 6 [Key_Shift_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=162 NoRepeat=true [Key_Shift_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_Shift_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_Shift_Row_6_ID_3] ;Space Bar Type=VirtualKey Width=625 Label= KeyCode=32 [Key_Shift_Row_6_ID_4] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=165 NoRepeat=true [Key_Shift_Row_6_ID_5] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_Shift_Row_6_ID_6] Type=VirtualKey Width=125 Label=Menu KeyCode=93 NoRepeat=true [Key_Shift_Row_6_ID_7] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=163 NoRepeat=true [Key_Shift_Row_6_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_6_ID_9] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_Shift_Row_6_ID_10] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_Shift_Row_6_ID_11] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_Shift_Row_6_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_6_ID_13] Type=VirtualKey Width=200 Label=0 Cluster=Numpad KeyCode=96 [Key_Shift_Row_6_ID_14] Type=VirtualKey Label=, Cluster=Numpad KeyCode=110 ================================================ FILE: assets/keyboards/qwertz_ger.ini ================================================ [LayoutInfo] Name=QWERTZ (Germany) HasAltGr=true HasClusterFunction=true HasClusterNavigation=true HasClusterNumpad=true HasClusterExtra=true ;See qwerty_usa.ini for format documentation ;----------------------Row 0 [Key_Base_Row_0_ID_0] Type=VirtualKey Label=Esc Cluster=Function KeyCode=27 NoRepeat=true [Key_Base_Row_0_ID_1] Type=Blank Cluster=Function [Key_Base_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_Base_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_Base_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_Base_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_Base_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_Base_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_Base_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_Base_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_Base_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_Base_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_Base_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_Base_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_Base_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_Base_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_Base_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_Base_Row_0_ID_17] Type=VirtualKey Label=Druck Cluster=Function KeyCode=44 NoRepeat=true [Key_Base_Row_0_ID_18] Type=VirtualKey Label=Rollen Cluster=Function KeyCode=145 NoRepeat=true [Key_Base_Row_0_ID_19] Type=VirtualKey Label=Pause Cluster=Function KeyCode=19 NoRepeat=true [Key_Base_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_Base_Row_0_ID_21] Type=VirtualKey Label=⏯ Cluster=Extra KeyCode=179 NoRepeat=true [Key_Base_Row_0_ID_22] Type=VirtualKey Label=◼ Cluster=Extra KeyCode=178 NoRepeat=true [Key_Base_Row_0_ID_23] Type=VirtualKey Label=⏮ Cluster=Extra KeyCode=177 NoRepeat=true [Key_Base_Row_0_ID_24] Type=VirtualKey Label=⏭ Cluster=Extra KeyCode=176 NoRepeat=true ;----------------------Row 1 (25% height blank space) [Key_Base_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_Base_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra ;----------------------Row 2 [Key_Base_Row_2_ID_0] Type=String Label=^ String=^ [Key_Base_Row_2_ID_1] Type=VirtualKey Label=1 KeyCode=49 [Key_Base_Row_2_ID_2] Type=VirtualKey Label=2 KeyCode=50 [Key_Base_Row_2_ID_3] Type=VirtualKey Label=3 KeyCode=51 [Key_Base_Row_2_ID_4] Type=VirtualKey Label=4 KeyCode=52 [Key_Base_Row_2_ID_5] Type=VirtualKey Label=5 KeyCode=53 [Key_Base_Row_2_ID_6] Type=VirtualKey Label=6 KeyCode=54 [Key_Base_Row_2_ID_7] Type=VirtualKey Label=7 KeyCode=55 [Key_Base_Row_2_ID_8] Type=VirtualKey Label=8 KeyCode=56 [Key_Base_Row_2_ID_9] Type=VirtualKey Label=9 KeyCode=57 [Key_Base_Row_2_ID_10] Type=VirtualKey Label=0 KeyCode=48 [Key_Base_Row_2_ID_11] Type=String Label=ß String=ß [Key_Base_Row_2_ID_12] Type=String Label=´ String=´ [Key_Base_Row_2_ID_13] Type=VirtualKey Width=200 Label=⟵ KeyCode=8 [Key_Base_Row_2_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_2_ID_15] Type=VirtualKey Label=Einfg Cluster=Navigation KeyCode=45 [Key_Base_Row_2_ID_16] Type=VirtualKey Label=Pos1 Cluster=Navigation KeyCode=36 [Key_Base_Row_2_ID_17] Type=VirtualKey Label=Bild🠹 Cluster=Navigation KeyCode=33 [Key_Base_Row_2_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_2_ID_19] Type=VirtualKey Label=Num Cluster=Numpad KeyCode=144 NoRepeat=true [Key_Base_Row_2_ID_20] Type=VirtualKey Label=/ Cluster=Numpad KeyCode=111 [Key_Base_Row_2_ID_21] Type=VirtualKey Label=* Cluster=Numpad KeyCode=106 [Key_Base_Row_2_ID_22] Type=VirtualKey Label=- Cluster=Numpad KeyCode=109 ;----------------------Row 3 [Key_Base_Row_3_ID_0] Type=VirtualKey Width=150 Label=⭾ KeyCode=9 [Key_Base_Row_3_ID_1] Type=VirtualKey Label=q KeyCode=81 [Key_Base_Row_3_ID_2] Type=VirtualKey Label=w KeyCode=87 [Key_Base_Row_3_ID_3] Type=VirtualKey Label=e KeyCode=69 [Key_Base_Row_3_ID_4] Type=VirtualKey Label=r KeyCode=82 [Key_Base_Row_3_ID_5] Type=VirtualKey Label=t KeyCode=84 [Key_Base_Row_3_ID_6] Type=VirtualKey Label=z KeyCode=90 [Key_Base_Row_3_ID_7] Type=VirtualKey Label=u KeyCode=85 [Key_Base_Row_3_ID_8] Type=VirtualKey Label=i KeyCode=73 [Key_Base_Row_3_ID_9] Type=VirtualKey Label=o KeyCode=79 [Key_Base_Row_3_ID_10] Type=VirtualKey Label=p KeyCode=80 [Key_Base_Row_3_ID_11] Type=String Label=ü String=ü [Key_Base_Row_3_ID_12] Type=String Label=+ String=+ [Key_Base_Row_3_ID_13] Type=VirtualKeyIsoEnter Width=150 Label= KeyCode=13 [Key_Base_Row_3_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_3_ID_15] Type=VirtualKey Label=Entf Cluster=Navigation KeyCode=46 [Key_Base_Row_3_ID_16] Type=VirtualKey Label=Ende Cluster=Navigation KeyCode=35 [Key_Base_Row_3_ID_17] Type=VirtualKey Label=Bild🠻 Cluster=Navigation KeyCode=34 [Key_Base_Row_3_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_3_ID_19] Type=VirtualKey Label=7 Cluster=Numpad KeyCode=103 [Key_Base_Row_3_ID_20] Type=VirtualKey Label=8 Cluster=Numpad KeyCode=104 [Key_Base_Row_3_ID_21] Type=VirtualKey Label=9 Cluster=Numpad KeyCode=105 [Key_Base_Row_3_ID_22] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 ;----------------------Row 4 [Key_Base_Row_4_ID_0] Type=VirtualKey Width=175 Label=🡇 KeyCode=20 NoRepeat=true [Key_Base_Row_4_ID_1] Type=VirtualKey Label=a KeyCode=65 [Key_Base_Row_4_ID_2] Type=VirtualKey Label=s KeyCode=83 [Key_Base_Row_4_ID_3] Type=VirtualKey Label=d KeyCode=68 [Key_Base_Row_4_ID_4] Type=VirtualKey Label=f KeyCode=70 [Key_Base_Row_4_ID_5] Type=VirtualKey Label=g KeyCode=71 [Key_Base_Row_4_ID_6] Type=VirtualKey Label=h KeyCode=72 [Key_Base_Row_4_ID_7] Type=VirtualKey Label=j KeyCode=74 [Key_Base_Row_4_ID_8] Type=VirtualKey Label=k KeyCode=75 [Key_Base_Row_4_ID_9] Type=VirtualKey Label=l KeyCode=76 [Key_Base_Row_4_ID_10] Type=String Label=ö String=ö [Key_Base_Row_4_ID_11] Type=String Label=ä String=ä [Key_Base_Row_4_ID_12] Type=String Label=# String=# [Key_Base_Row_4_ID_13] Type=VirtualKeyIsoEnter Width=125 Label=↵ KeyCode=13 [Key_Base_Row_4_ID_14] Type=Blank Width=325 Cluster=Navigation [Key_Base_Row_4_ID_15] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_4_ID_16] Type=VirtualKey Label=4 Cluster=Numpad KeyCode=100 [Key_Base_Row_4_ID_17] Type=VirtualKey Label=5 Cluster=Numpad KeyCode=101 [Key_Base_Row_4_ID_18] Type=VirtualKey Label=6 Cluster=Numpad KeyCode=102 ;----------------------Row 5 [Key_Base_Row_5_ID_0] Type=VirtualKeyToggle Width=125 Label=🡅 KeyCode=160 NoRepeat=true [Key_Base_Row_5_ID_1] Type=String Label=< String=< [Key_Base_Row_5_ID_2] Type=VirtualKey Label=y KeyCode=89 [Key_Base_Row_5_ID_3] Type=VirtualKey Label=x KeyCode=88 [Key_Base_Row_5_ID_4] Type=VirtualKey Label=c KeyCode=67 [Key_Base_Row_5_ID_5] Type=VirtualKey Label=v KeyCode=86 [Key_Base_Row_5_ID_6] Type=VirtualKey Label=b KeyCode=66 [Key_Base_Row_5_ID_7] Type=VirtualKey Label=n KeyCode=78 [Key_Base_Row_5_ID_8] Type=VirtualKey Label=m KeyCode=77 [Key_Base_Row_5_ID_9] Type=String Label=, String=, [Key_Base_Row_5_ID_10] Type=String Label=. String=. [Key_Base_Row_5_ID_11] Type=String Label=- String=- [Key_Base_Row_5_ID_12] Type=VirtualKeyToggle Width=275 Label=🡅 KeyCode=161 NoRepeat=true [Key_Base_Row_5_ID_13] Type=Blank Width=125 Cluster=Navigation [Key_Base_Row_5_ID_14] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_Base_Row_5_ID_15] Type=Blank Width=100 Cluster=Navigation [Key_Base_Row_5_ID_16] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_5_ID_17] Type=VirtualKey Label=1 Cluster=Numpad KeyCode=97 [Key_Base_Row_5_ID_18] Type=VirtualKey Label=2 Cluster=Numpad KeyCode=98 [Key_Base_Row_5_ID_19] Type=VirtualKey Label=3 Cluster=Numpad KeyCode=99 [Key_Base_Row_5_ID_20] Type=VirtualKey Height=200 Label=Enter Cluster=Numpad KeyCode=13 ;----------------------Row 6 [Key_Base_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Strg KeyCode=162 NoRepeat=true [Key_Base_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_Base_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_Base_Row_6_ID_3] ;Space Bar Type=VirtualKey Width=625 Label= KeyCode=32 [Key_Base_Row_6_ID_4] Type=VirtualKeyToggle Width=125 Label=AltGr KeyCode=165 NoRepeat=true [Key_Base_Row_6_ID_5] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_Base_Row_6_ID_6] Type=VirtualKey Width=125 Label=Menü KeyCode=93 NoRepeat=true [Key_Base_Row_6_ID_7] Type=VirtualKeyToggle Width=125 Label=Strg KeyCode=163 NoRepeat=true [Key_Base_Row_6_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_6_ID_9] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_Base_Row_6_ID_10] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_Base_Row_6_ID_11] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_Base_Row_6_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_6_ID_13] Type=VirtualKey Width=200 Label=0 Cluster=Numpad KeyCode=96 [Key_Base_Row_6_ID_14] Type=VirtualKey Label=, Cluster=Numpad KeyCode=110 ;----------------------Shift SubLayout ; ;----------------------Row 0 [Key_Shift_Row_0_ID_0] Type=VirtualKey Label=Esc Cluster=Function KeyCode=27 NoRepeat=true [Key_Shift_Row_0_ID_1] Type=Blank Cluster=Function [Key_Shift_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_Shift_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_Shift_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_Shift_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_Shift_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_Shift_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_Shift_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_Shift_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_Shift_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_Shift_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_Shift_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_Shift_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_Shift_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_Shift_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_Shift_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_Shift_Row_0_ID_17] Type=VirtualKey Label=Druck Cluster=Function KeyCode=44 NoRepeat=true [Key_Shift_Row_0_ID_18] Type=VirtualKey Label=Rollen Cluster=Function KeyCode=145 NoRepeat=true [Key_Shift_Row_0_ID_19] Type=VirtualKey Label=Pause Cluster=Function KeyCode=19 NoRepeat=true [Key_Shift_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_Shift_Row_0_ID_21] Type=VirtualKey Label=🡰 Cluster=Extra KeyCode=166 NoRepeat=true [Key_Shift_Row_0_ID_22] Type=VirtualKey Label=🡲 Cluster=Extra KeyCode=167 NoRepeat=true [Key_Shift_Row_0_ID_23] Type=VirtualKey Label=🔇 Cluster=Extra KeyCode=173 NoRepeat=true ;----------------------Row 1 (25% height blank space) [Key_Shift_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_Shift_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra ;----------------------Row 2 [Key_Shift_Row_2_ID_0] Type=String Label=° String=° [Key_Shift_Row_2_ID_1] Type=String Label=! String=! [Key_Shift_Row_2_ID_2] Type=String Label=" String=" [Key_Shift_Row_2_ID_3] Type=String Label=§ String=§ [Key_Shift_Row_2_ID_4] Type=String Label=$ String=$ [Key_Shift_Row_2_ID_5] Type=String Label=% String=% [Key_Shift_Row_2_ID_6] Type=String Label=& String=& [Key_Shift_Row_2_ID_7] Type=String Label=/ String=/ [Key_Shift_Row_2_ID_8] Type=String Label=( String=( [Key_Shift_Row_2_ID_9] Type=String Label=) String=) [Key_Shift_Row_2_ID_10] Type=String Label== String== [Key_Shift_Row_2_ID_11] Type=String Label=? String=? [Key_Shift_Row_2_ID_12] Type=String Label=` String=` [Key_Shift_Row_2_ID_13] Type=VirtualKey Width=200 Label=⟵ KeyCode=8 [Key_Shift_Row_2_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_2_ID_15] Type=VirtualKey Label=Einfg Cluster=Navigation KeyCode=45 [Key_Shift_Row_2_ID_16] Type=VirtualKey Label=Pos1 Cluster=Navigation KeyCode=36 [Key_Shift_Row_2_ID_17] Type=VirtualKey Label=Bild🠹 Cluster=Navigation KeyCode=33 [Key_Shift_Row_2_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_2_ID_19] Type=VirtualKey Label=Num Cluster=Numpad KeyCode=144 NoRepeat=true [Key_Shift_Row_2_ID_20] Type=VirtualKey Label=/ Cluster=Numpad KeyCode=111 [Key_Shift_Row_2_ID_21] Type=VirtualKey Label=* Cluster=Numpad KeyCode=106 [Key_Shift_Row_2_ID_22] Type=VirtualKey Label=- Cluster=Numpad KeyCode=109 ;----------------------Row 3 [Key_Shift_Row_3_ID_0] Type=VirtualKey Width=150 Label=⭾ KeyCode=9 [Key_Shift_Row_3_ID_1] Type=VirtualKey Label=Q KeyCode=81 [Key_Shift_Row_3_ID_2] Type=VirtualKey Label=W KeyCode=87 [Key_Shift_Row_3_ID_3] Type=VirtualKey Label=E KeyCode=69 [Key_Shift_Row_3_ID_4] Type=VirtualKey Label=R KeyCode=82 [Key_Shift_Row_3_ID_5] Type=VirtualKey Label=T KeyCode=84 [Key_Shift_Row_3_ID_6] Type=VirtualKey Label=Z KeyCode=90 [Key_Shift_Row_3_ID_7] Type=VirtualKey Label=U KeyCode=85 [Key_Shift_Row_3_ID_8] Type=VirtualKey Label=I KeyCode=73 [Key_Shift_Row_3_ID_9] Type=VirtualKey Label=O KeyCode=79 [Key_Shift_Row_3_ID_10] Type=VirtualKey Label=P KeyCode=80 [Key_Shift_Row_3_ID_11] Type=String Label=Ü String=Ü [Key_Shift_Row_3_ID_12] Type=String Label=* String=* [Key_Shift_Row_3_ID_13] Type=VirtualKeyIsoEnter Width=150 Label= KeyCode=13 [Key_Shift_Row_3_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_3_ID_15] Type=VirtualKey Label=Entf Cluster=Navigation KeyCode=46 [Key_Shift_Row_3_ID_16] Type=VirtualKey Label=Ende Cluster=Navigation KeyCode=35 [Key_Shift_Row_3_ID_17] Type=VirtualKey Label=Bild🠻 Cluster=Navigation KeyCode=34 [Key_Shift_Row_3_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_3_ID_19] Type=VirtualKey Label=7 Cluster=Numpad KeyCode=103 [Key_Shift_Row_3_ID_20] Type=VirtualKey Label=8 Cluster=Numpad KeyCode=104 [Key_Shift_Row_3_ID_21] Type=VirtualKey Label=9 Cluster=Numpad KeyCode=105 [Key_Shift_Row_3_ID_22] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 ;----------------------Row 4 [Key_Shift_Row_4_ID_0] Type=VirtualKey Width=175 Label=🡇 KeyCode=20 NoRepeat=true [Key_Shift_Row_4_ID_1] Type=VirtualKey Label=A KeyCode=65 [Key_Shift_Row_4_ID_2] Type=VirtualKey Label=S KeyCode=83 [Key_Shift_Row_4_ID_3] Type=VirtualKey Label=D KeyCode=68 [Key_Shift_Row_4_ID_4] Type=VirtualKey Label=F KeyCode=70 [Key_Shift_Row_4_ID_5] Type=VirtualKey Label=G KeyCode=71 [Key_Shift_Row_4_ID_6] Type=VirtualKey Label=H KeyCode=72 [Key_Shift_Row_4_ID_7] Type=VirtualKey Label=J KeyCode=74 [Key_Shift_Row_4_ID_8] Type=VirtualKey Label=K KeyCode=75 [Key_Shift_Row_4_ID_9] Type=VirtualKey Label=L KeyCode=76 [Key_Shift_Row_4_ID_10] Type=String Label=Ö String=Ö [Key_Shift_Row_4_ID_11] Type=String Label=Ä String=Ä [Key_Shift_Row_4_ID_12] Type=String Label=' String=' [Key_Shift_Row_4_ID_13] Type=VirtualKeyIsoEnter Width=125 Label=↵ KeyCode=13 [Key_Shift_Row_4_ID_14] Type=Blank Width=325 Cluster=Navigation [Key_Shift_Row_4_ID_15] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_4_ID_16] Type=VirtualKey Label=4 Cluster=Numpad KeyCode=100 [Key_Shift_Row_4_ID_17] Type=VirtualKey Label=5 Cluster=Numpad KeyCode=101 [Key_Shift_Row_4_ID_18] Type=VirtualKey Label=6 Cluster=Numpad KeyCode=102 ;----------------------Row 5 [Key_Shift_Row_5_ID_0] Type=VirtualKeyToggle Width=125 Label=🡅 KeyCode=160 NoRepeat=true [Key_Shift_Row_5_ID_1] Type=String Label=> String=> [Key_Shift_Row_5_ID_2] Type=VirtualKey Label=Y KeyCode=89 [Key_Shift_Row_5_ID_3] Type=VirtualKey Label=X KeyCode=88 [Key_Shift_Row_5_ID_4] Type=VirtualKey Label=C KeyCode=67 [Key_Shift_Row_5_ID_5] Type=VirtualKey Label=V KeyCode=86 [Key_Shift_Row_5_ID_6] Type=VirtualKey Label=B KeyCode=66 [Key_Shift_Row_5_ID_7] Type=VirtualKey Label=N KeyCode=78 [Key_Shift_Row_5_ID_8] Type=VirtualKey Label=M KeyCode=77 [Key_Shift_Row_5_ID_9] Type=String Label=; String=; [Key_Shift_Row_5_ID_10] Type=String Label=: String=: [Key_Shift_Row_5_ID_11] Type=String Label=_ String=_ [Key_Shift_Row_5_ID_12] Type=VirtualKeyToggle Width=275 Label=🡅 KeyCode=161 NoRepeat=true [Key_Shift_Row_5_ID_13] Type=Blank Width=125 Cluster=Navigation [Key_Shift_Row_5_ID_14] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_Shift_Row_5_ID_15] Type=Blank Width=100 Cluster=Navigation [Key_Shift_Row_5_ID_16] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_5_ID_17] Type=VirtualKey Label=1 Cluster=Numpad KeyCode=97 [Key_Shift_Row_5_ID_18] Type=VirtualKey Label=2 Cluster=Numpad KeyCode=98 [Key_Shift_Row_5_ID_19] Type=VirtualKey Label=3 Cluster=Numpad KeyCode=99 [Key_Shift_Row_5_ID_20] Type=VirtualKey Height=200 Label=Enter Cluster=Numpad KeyCode=13 ;----------------------Row 6 [Key_Shift_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Strg KeyCode=162 NoRepeat=true [Key_Shift_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_Shift_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_Shift_Row_6_ID_3] ;Space Bar Type=VirtualKey Width=625 Label= KeyCode=32 [Key_Shift_Row_6_ID_4] Type=VirtualKeyToggle Width=125 Label=AltGr KeyCode=165 NoRepeat=true [Key_Shift_Row_6_ID_5] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_Shift_Row_6_ID_6] Type=VirtualKey Width=125 Label=Menü KeyCode=93 NoRepeat=true [Key_Shift_Row_6_ID_7] Type=VirtualKeyToggle Width=125 Label=Strg KeyCode=163 NoRepeat=true [Key_Shift_Row_6_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_6_ID_9] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_Shift_Row_6_ID_10] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_Shift_Row_6_ID_11] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_Shift_Row_6_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_6_ID_13] Type=VirtualKey Width=200 Label=0 Cluster=Numpad KeyCode=96 [Key_Shift_Row_6_ID_14] Type=VirtualKey Label=, Cluster=Numpad KeyCode=110 ;----------------------AltGr SubLayout ; ;----------------------Row 0 [Key_AltGr_Row_0_ID_0] Type=VirtualKey Label=Esc Cluster=Function KeyCode=27 NoRepeat=true [Key_AltGr_Row_0_ID_1] Type=Blank Cluster=Function [Key_AltGr_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_AltGr_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_AltGr_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_AltGr_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_AltGr_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_AltGr_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_AltGr_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_AltGr_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_AltGr_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_AltGr_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_AltGr_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_AltGr_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_AltGr_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_AltGr_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_AltGr_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_AltGr_Row_0_ID_17] Type=VirtualKey Label=Druck Cluster=Function KeyCode=44 NoRepeat=true [Key_AltGr_Row_0_ID_18] Type=VirtualKey Label=Rollen Cluster=Function KeyCode=145 NoRepeat=true [Key_AltGr_Row_0_ID_19] Type=VirtualKey Label=Pause Cluster=Function KeyCode=19 NoRepeat=true [Key_AltGr_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_AltGr_Row_0_ID_21] Type=VirtualKey Label=⏯ Cluster=Extra KeyCode=179 NoRepeat=true [Key_AltGr_Row_0_ID_22] Type=VirtualKey Label=◼ Cluster=Extra KeyCode=178 NoRepeat=true [Key_AltGr_Row_0_ID_23] Type=VirtualKey Label=⏮ Cluster=Extra KeyCode=177 NoRepeat=true [Key_AltGr_Row_0_ID_24] Type=VirtualKey Label=⏭ Cluster=Extra KeyCode=176 NoRepeat=true ;----------------------Row 1 (25% height blank space) [Key_AltGr_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_AltGr_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra ;----------------------Row 2 [Key_AltGr_Row_2_ID_0] Type=Blank Width=700 [Key_AltGr_Row_2_ID_1] Type=String Label={ String={ [Key_AltGr_Row_2_ID_2] Type=String Label=[ String=[ [Key_AltGr_Row_2_ID_3] Type=String Label=] String=] [Key_AltGr_Row_2_ID_4] Type=String Label=} String=} [Key_AltGr_Row_2_ID_5] Type=String Label=\ String=\ [Key_AltGr_Row_2_ID_6] Type=Blank [Key_AltGr_Row_2_ID_7] Type=VirtualKey Width=200 Label=⟵ KeyCode=8 [Key_AltGr_Row_2_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_AltGr_Row_2_ID_9] Type=VirtualKey Label=Einfg Cluster=Navigation KeyCode=45 [Key_AltGr_Row_2_ID_10] Type=VirtualKey Label=Pos1 Cluster=Navigation KeyCode=36 [Key_AltGr_Row_2_ID_11] Type=VirtualKey Label=Bild🠹 Cluster=Navigation KeyCode=33 [Key_AltGr_Row_2_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_2_ID_13] Type=VirtualKey Label=Num Cluster=Numpad KeyCode=144 NoRepeat=true [Key_AltGr_Row_2_ID_14] Type=VirtualKey Label=/ Cluster=Numpad KeyCode=111 [Key_AltGr_Row_2_ID_15] Type=VirtualKey Label=* Cluster=Numpad KeyCode=106 [Key_AltGr_Row_2_ID_16] Type=VirtualKey Label=- Cluster=Numpad KeyCode=109 ;----------------------Row 3 [Key_AltGr_Row_3_ID_0] Type=VirtualKey Width=150 Label=⭾ KeyCode=9 [Key_AltGr_Row_3_ID_1] Type=String Label=@ String=@ [Key_AltGr_Row_3_ID_2] Type=Blank [Key_AltGr_Row_3_ID_3] Type=String Label=€ String=€ [Key_AltGr_Row_3_ID_4] Type=Blank Width=800 [Key_AltGr_Row_3_ID_5] Type=String Label=~ String=~ [Key_AltGr_Row_3_ID_6] Type=VirtualKeyIsoEnter Width=150 Label= KeyCode=13 [Key_AltGr_Row_3_ID_7] Type=Blank Width=25 Cluster=Navigation [Key_AltGr_Row_3_ID_8] Type=VirtualKey Label=Entf Cluster=Navigation KeyCode=46 [Key_AltGr_Row_3_ID_9] Type=VirtualKey Label=Ende Cluster=Navigation KeyCode=35 [Key_AltGr_Row_3_ID_10] Type=VirtualKey Label=Bild🠻 Cluster=Navigation KeyCode=34 [Key_AltGr_Row_3_ID_11] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_3_ID_12] Type=VirtualKey Label=7 Cluster=Numpad KeyCode=103 [Key_AltGr_Row_3_ID_13] Type=VirtualKey Label=8 Cluster=Numpad KeyCode=104 [Key_AltGr_Row_3_ID_14] Type=VirtualKey Label=9 Cluster=Numpad KeyCode=105 [Key_AltGr_Row_3_ID_15] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 ;----------------------Row 4 [Key_AltGr_Row_4_ID_0] Type=VirtualKey Width=175 Label=🡇 KeyCode=20 NoRepeat=true [Key_AltGr_Row_4_ID_1] Type=Blank Width=1200 [Key_AltGr_Row_4_ID_2] Type=VirtualKeyIsoEnter Width=125 Label=↵ KeyCode=13 [Key_AltGr_Row_4_ID_3] Type=Blank Width=325 Cluster=Navigation [Key_AltGr_Row_4_ID_4] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_4_ID_5] Type=VirtualKey Label=4 Cluster=Numpad KeyCode=100 [Key_AltGr_Row_4_ID_6] Type=VirtualKey Label=5 Cluster=Numpad KeyCode=101 [Key_AltGr_Row_4_ID_7] Type=VirtualKey Label=6 Cluster=Numpad KeyCode=102 ;----------------------Row 5 [Key_AltGr_Row_5_ID_0] Type=VirtualKeyToggle Width=125 Label=🡅 KeyCode=160 NoRepeat=true [Key_AltGr_Row_5_ID_1] Type=String Label=| String=| [Key_AltGr_Row_5_ID_2] Type=Blank Width=600 [Key_AltGr_Row_5_ID_3] Type=String Label=µ String=µ [Key_AltGr_Row_5_ID_4] Type=Blank Width=300 [Key_AltGr_Row_5_ID_5] Type=VirtualKeyToggle Width=275 Label=🡅 KeyCode=161 NoRepeat=true [Key_AltGr_Row_5_ID_6] Type=Blank Width=125 Cluster=Navigation [Key_AltGr_Row_5_ID_7] Type=VirtualKey Label=🠅 KeyCode=38 Cluster=Navigation [Key_AltGr_Row_5_ID_8] Type=Blank Width=100 Cluster=Navigation [Key_AltGr_Row_5_ID_9] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_5_ID_10] Type=VirtualKey Label=1 Cluster=Numpad KeyCode=97 [Key_AltGr_Row_5_ID_11] Type=VirtualKey Label=2 Cluster=Numpad KeyCode=98 [Key_AltGr_Row_5_ID_12] Type=VirtualKey Label=3 Cluster=Numpad KeyCode=99 [Key_AltGr_Row_5_ID_13] Type=VirtualKey Height=200 Label=Enter Cluster=Numpad KeyCode=13 ;----------------------Row 6 [Key_AltGr_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Strg KeyCode=162 NoRepeat=true [Key_AltGr_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_AltGr_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_AltGr_Row_6_ID_3] ;Space Bar Type=VirtualKey Width=625 Label= KeyCode=32 [Key_AltGr_Row_6_ID_4] Type=VirtualKeyToggle Width=125 Label=AltGr KeyCode=165 NoRepeat=true [Key_AltGr_Row_6_ID_5] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_AltGr_Row_6_ID_6] Type=VirtualKey Width=125 Label=Menü KeyCode=93 NoRepeat=true [Key_AltGr_Row_6_ID_7] Type=VirtualKeyToggle Width=125 Label=Strg KeyCode=163 NoRepeat=true [Key_AltGr_Row_6_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_AltGr_Row_6_ID_9] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_AltGr_Row_6_ID_10] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_AltGr_Row_6_ID_11] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_AltGr_Row_6_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_6_ID_13] Type=VirtualKey Width=200 Label=0 Cluster=Numpad KeyCode=96 [Key_AltGr_Row_6_ID_14] Type=VirtualKey Label=, Cluster=Numpad KeyCode=110 ================================================ FILE: assets/keyboards/qwertz_hu.ini ================================================ [LayoutInfo] Name=QWERTZ (Hungary) Author=Lenr HasAltGr=true HasClusterFunction=true HasClusterNavigation=true HasClusterNumpad=true HasClusterExtra=true [Key_Base_Row_0_ID_0] Type=VirtualKey Label=Esc Cluster=Function KeyCode=27 NoRepeat=true [Key_Base_Row_0_ID_1] Type=Blank Cluster=Function [Key_Base_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_Base_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_Base_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_Base_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_Base_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_Base_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_Base_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_Base_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_Base_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_Base_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_Base_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_Base_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_Base_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_Base_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_Base_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_Base_Row_0_ID_17] Type=VirtualKey Label=PrtSc Cluster=Function KeyCode=44 NoRepeat=true [Key_Base_Row_0_ID_18] Type=VirtualKey Label=ScrLk Cluster=Function KeyCode=145 NoRepeat=true [Key_Base_Row_0_ID_19] Type=VirtualKey Label=Pause Cluster=Function KeyCode=19 NoRepeat=true [Key_Base_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_Base_Row_0_ID_21] Type=VirtualKey Label=⏵/⏸ Cluster=Extra KeyCode=179 NoRepeat=true [Key_Base_Row_0_ID_22] Type=VirtualKey Label=◼ Cluster=Extra KeyCode=178 NoRepeat=true [Key_Base_Row_0_ID_23] Type=VirtualKey Label=⏮ Cluster=Extra KeyCode=177 NoRepeat=true [Key_Base_Row_0_ID_24] Type=VirtualKey Label=⏭ Cluster=Extra KeyCode=176 NoRepeat=true [Key_Base_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_Base_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra [Key_Base_Row_2_ID_0] Type=String Label=0 String=0 [Key_Base_Row_2_ID_1] Type=VirtualKey Label=1 KeyCode=49 [Key_Base_Row_2_ID_2] Type=VirtualKey Label=2 KeyCode=50 [Key_Base_Row_2_ID_3] Type=VirtualKey Label=3 KeyCode=51 [Key_Base_Row_2_ID_4] Type=VirtualKey Label=4 KeyCode=52 [Key_Base_Row_2_ID_5] Type=VirtualKey Label=5 KeyCode=53 [Key_Base_Row_2_ID_6] Type=VirtualKey Label=6 KeyCode=54 [Key_Base_Row_2_ID_7] Type=VirtualKey Label=7 KeyCode=55 [Key_Base_Row_2_ID_8] Type=VirtualKey Label=8 KeyCode=56 [Key_Base_Row_2_ID_9] Type=VirtualKey Label=9 KeyCode=57 [Key_Base_Row_2_ID_10] Type=VirtualKey Label=ö KeyCode=192 [Key_Base_Row_2_ID_11] Type=String Label=ü String=ü [Key_Base_Row_2_ID_12] Type=String Label=ó String=ó [Key_Base_Row_2_ID_13] Type=VirtualKey Width=200 Label=⟵ KeyCode=8 [Key_Base_Row_2_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_2_ID_15] Type=VirtualKey Label=Insert Cluster=Navigation KeyCode=45 [Key_Base_Row_2_ID_16] Type=VirtualKey Label=Home Cluster=Navigation KeyCode=36 [Key_Base_Row_2_ID_17] Type=VirtualKey Label=PgUp Cluster=Navigation KeyCode=33 [Key_Base_Row_2_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_2_ID_19] Type=VirtualKey Label=Num\nLock Cluster=Numpad KeyCode=144 NoRepeat=true [Key_Base_Row_2_ID_20] Type=VirtualKey Label=/ Cluster=Numpad KeyCode=111 [Key_Base_Row_2_ID_21] Type=VirtualKey Label=* Cluster=Numpad KeyCode=106 [Key_Base_Row_2_ID_22] Type=VirtualKey Label=- Cluster=Numpad KeyCode=109 [Key_Base_Row_3_ID_0] Type=VirtualKey Width=150 Label=⭾ KeyCode=9 [Key_Base_Row_3_ID_1] Type=VirtualKey Label=q KeyCode=81 [Key_Base_Row_3_ID_2] Type=VirtualKey Label=w KeyCode=87 [Key_Base_Row_3_ID_3] Type=VirtualKey Label=e KeyCode=69 [Key_Base_Row_3_ID_4] Type=VirtualKey Label=r KeyCode=82 [Key_Base_Row_3_ID_5] Type=VirtualKey Label=t KeyCode=84 [Key_Base_Row_3_ID_6] Type=VirtualKey Label=z KeyCode=90 [Key_Base_Row_3_ID_7] Type=VirtualKey Label=u KeyCode=85 [Key_Base_Row_3_ID_8] Type=VirtualKey Label=i KeyCode=73 [Key_Base_Row_3_ID_9] Type=VirtualKey Label=o KeyCode=79 [Key_Base_Row_3_ID_10] Type=VirtualKey Label=p KeyCode=80 [Key_Base_Row_3_ID_11] Type=String Label=ő String=ő [Key_Base_Row_3_ID_12] Type=String Label=ú String=ú [Key_Base_Row_3_ID_13] Type=VirtualKeyIsoEnter Width=150 Label= KeyCode=13 [Key_Base_Row_3_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_3_ID_15] Type=VirtualKey Label=Delete Cluster=Navigation KeyCode=46 [Key_Base_Row_3_ID_16] Type=VirtualKey Label=End Cluster=Navigation KeyCode=35 [Key_Base_Row_3_ID_17] Type=VirtualKey Label=PgDn Cluster=Navigation KeyCode=34 [Key_Base_Row_3_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_3_ID_19] Type=VirtualKey Label=7\nHome Cluster=Numpad KeyCode=103 [Key_Base_Row_3_ID_20] Type=VirtualKey Label=8\n🠅 Cluster=Numpad KeyCode=104 [Key_Base_Row_3_ID_21] Type=VirtualKey Label=9\nPgUp Cluster=Numpad KeyCode=105 [Key_Base_Row_3_ID_22] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 [Key_Base_Row_4_ID_0] Type=VirtualKey Width=175 Label=🡇 KeyCode=20 NoRepeat=true [Key_Base_Row_4_ID_1] Type=VirtualKey Label=a KeyCode=65 [Key_Base_Row_4_ID_2] Type=VirtualKey Label=s KeyCode=83 [Key_Base_Row_4_ID_3] Type=VirtualKey Label=d KeyCode=68 [Key_Base_Row_4_ID_4] Type=VirtualKey Label=f KeyCode=70 [Key_Base_Row_4_ID_5] Type=VirtualKey Label=g KeyCode=71 [Key_Base_Row_4_ID_6] Type=VirtualKey Label=h KeyCode=72 [Key_Base_Row_4_ID_7] Type=VirtualKey Label=j KeyCode=74 [Key_Base_Row_4_ID_8] Type=VirtualKey Label=k KeyCode=75 [Key_Base_Row_4_ID_9] Type=VirtualKey Label=l KeyCode=76 [Key_Base_Row_4_ID_10] Type=String Label=é String=é [Key_Base_Row_4_ID_11] Type=String Label=á String=á [Key_Base_Row_4_ID_12] Type=String Label=ű String=ű [Key_Base_Row_4_ID_13] Type=VirtualKeyIsoEnter Width=125 Label=↵ KeyCode=13 [Key_Base_Row_4_ID_14] Type=Blank Width=325 Cluster=Navigation [Key_Base_Row_4_ID_15] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_4_ID_16] Type=VirtualKey Label=4\n🠄 Cluster=Numpad KeyCode=100 [Key_Base_Row_4_ID_17] Type=VirtualKey Label=5\n Cluster=Numpad KeyCode=101 [Key_Base_Row_4_ID_18] Type=VirtualKey Label=6\n🠆 Cluster=Numpad KeyCode=102 [Key_Base_Row_5_ID_0] Type=VirtualKeyToggle Width=125 Label=🡅 KeyCode=160 NoRepeat=true [Key_Base_Row_5_ID_1] Type=String Label=í String=í [Key_Base_Row_5_ID_2] Type=VirtualKey Label=y KeyCode=89 [Key_Base_Row_5_ID_3] Type=VirtualKey Label=x KeyCode=88 [Key_Base_Row_5_ID_4] Type=VirtualKey Label=c KeyCode=67 [Key_Base_Row_5_ID_5] Type=VirtualKey Label=v KeyCode=86 [Key_Base_Row_5_ID_6] Type=VirtualKey Label=b KeyCode=66 [Key_Base_Row_5_ID_7] Type=VirtualKey Label=n KeyCode=78 [Key_Base_Row_5_ID_8] Type=VirtualKey Label=m KeyCode=77 [Key_Base_Row_5_ID_9] Type=String Label=, String=, [Key_Base_Row_5_ID_10] Type=String Label=. String=. [Key_Base_Row_5_ID_11] Type=String Label=- String=- [Key_Base_Row_5_ID_12] Type=VirtualKeyToggle Width=275 Label=🡅 KeyCode=161 NoRepeat=true [Key_Base_Row_5_ID_13] Type=Blank Width=125 Cluster=Navigation [Key_Base_Row_5_ID_14] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_Base_Row_5_ID_15] Type=Blank Cluster=Navigation [Key_Base_Row_5_ID_16] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_5_ID_17] Type=VirtualKey Label=1\nEnd Cluster=Numpad KeyCode=97 [Key_Base_Row_5_ID_18] Type=VirtualKey Label=2\n🠇 Cluster=Numpad KeyCode=98 [Key_Base_Row_5_ID_19] Type=VirtualKey Label=3\nPgDn Cluster=Numpad KeyCode=99 [Key_Base_Row_5_ID_20] Type=VirtualKey Height=200 Label=Enter Cluster=Numpad KeyCode=13 [Key_Base_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=162 NoRepeat=true [Key_Base_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_Base_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_Base_Row_6_ID_3] Type=VirtualKey Width=625 Label= KeyCode=32 [Key_Base_Row_6_ID_4] Type=VirtualKeyToggle Width=125 Label=AltGr KeyCode=165 NoRepeat=true [Key_Base_Row_6_ID_5] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_Base_Row_6_ID_6] Type=VirtualKey Width=125 Label=Menü KeyCode=93 NoRepeat=true [Key_Base_Row_6_ID_7] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=163 NoRepeat=true [Key_Base_Row_6_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_Base_Row_6_ID_9] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_Base_Row_6_ID_10] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_Base_Row_6_ID_11] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_Base_Row_6_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_Base_Row_6_ID_13] Type=VirtualKey Width=200 Label=0\nInsert Cluster=Numpad KeyCode=96 [Key_Base_Row_6_ID_14] Type=VirtualKey Label=,\nDelete Cluster=Numpad KeyCode=110 [Key_Shift_Row_0_ID_0] Type=VirtualKey Label=Esc Cluster=Function KeyCode=27 NoRepeat=true [Key_Shift_Row_0_ID_1] Type=Blank Cluster=Function [Key_Shift_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_Shift_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_Shift_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_Shift_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_Shift_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_Shift_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_Shift_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_Shift_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_Shift_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_Shift_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_Shift_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_Shift_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_Shift_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_Shift_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_Shift_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_Shift_Row_0_ID_17] Type=VirtualKey Label=PrtSc Cluster=Function KeyCode=44 NoRepeat=true [Key_Shift_Row_0_ID_18] Type=VirtualKey Label=ScrLk Cluster=Function KeyCode=145 NoRepeat=true [Key_Shift_Row_0_ID_19] Type=VirtualKey Label=Pause Cluster=Function KeyCode=19 NoRepeat=true [Key_Shift_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_Shift_Row_0_ID_21] Type=VirtualKey Label=🡰 Cluster=Extra KeyCode=166 NoRepeat=true [Key_Shift_Row_0_ID_22] Type=VirtualKey Label=🡲 Cluster=Extra KeyCode=167 NoRepeat=true [Key_Shift_Row_0_ID_23] Type=VirtualKey Label=🔇 Cluster=Extra KeyCode=173 NoRepeat=true [Key_Shift_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_Shift_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra [Key_Shift_Row_2_ID_0] Type=String Label=§ String=§ [Key_Shift_Row_2_ID_1] Type=String Label=' String=' [Key_Shift_Row_2_ID_2] Type=String Label=" String=" [Key_Shift_Row_2_ID_3] Type=String Label=+ String=+ [Key_Shift_Row_2_ID_4] Type=String Label=! String=! [Key_Shift_Row_2_ID_5] Type=String Label=% String=% [Key_Shift_Row_2_ID_6] Type=String Label=/ String=/ [Key_Shift_Row_2_ID_7] Type=String Label== String== [Key_Shift_Row_2_ID_8] Type=String Label=( String=( [Key_Shift_Row_2_ID_9] Type=String Label=) String=) [Key_Shift_Row_2_ID_10] Type=String Label=Ö String=Ö [Key_Shift_Row_2_ID_11] Type=String Label=Ü String=Ü [Key_Shift_Row_2_ID_12] Type=String Label=Ó String=Ó [Key_Shift_Row_2_ID_13] Type=VirtualKey Width=200 Label=⟵ KeyCode=8 [Key_Shift_Row_2_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_2_ID_15] Type=VirtualKey Label=Insert Cluster=Navigation KeyCode=45 [Key_Shift_Row_2_ID_16] Type=VirtualKey Label=Home Cluster=Navigation KeyCode=36 [Key_Shift_Row_2_ID_17] Type=VirtualKey Label=PgUp Cluster=Navigation KeyCode=33 [Key_Shift_Row_2_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_2_ID_19] Type=VirtualKey Label=Num\nLock Cluster=Numpad KeyCode=144 NoRepeat=true [Key_Shift_Row_2_ID_20] Type=VirtualKey Label=/ Cluster=Numpad KeyCode=111 [Key_Shift_Row_2_ID_21] Type=VirtualKey Label=* Cluster=Numpad KeyCode=106 [Key_Shift_Row_2_ID_22] Type=VirtualKey Label=- Cluster=Numpad KeyCode=109 [Key_Shift_Row_3_ID_0] Type=VirtualKey Width=150 Label=⭾ KeyCode=9 [Key_Shift_Row_3_ID_1] Type=VirtualKey Label=Q KeyCode=81 [Key_Shift_Row_3_ID_2] Type=VirtualKey Label=W KeyCode=87 [Key_Shift_Row_3_ID_3] Type=VirtualKey Label=E KeyCode=69 [Key_Shift_Row_3_ID_4] Type=VirtualKey Label=R KeyCode=82 [Key_Shift_Row_3_ID_5] Type=VirtualKey Label=T KeyCode=84 [Key_Shift_Row_3_ID_6] Type=VirtualKey Label=Z KeyCode=90 [Key_Shift_Row_3_ID_7] Type=VirtualKey Label=U KeyCode=85 [Key_Shift_Row_3_ID_8] Type=VirtualKey Label=I KeyCode=73 [Key_Shift_Row_3_ID_9] Type=VirtualKey Label=O KeyCode=79 [Key_Shift_Row_3_ID_10] Type=VirtualKey Label=P KeyCode=80 [Key_Shift_Row_3_ID_11] Type=String Label=Ő String=Ő [Key_Shift_Row_3_ID_12] Type=String Label=Ú String=Ú [Key_Shift_Row_3_ID_13] Type=VirtualKeyIsoEnter Width=150 Label= KeyCode=13 [Key_Shift_Row_3_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_3_ID_15] Type=VirtualKey Label=Delete Cluster=Navigation KeyCode=46 [Key_Shift_Row_3_ID_16] Type=VirtualKey Label=End Cluster=Navigation KeyCode=35 [Key_Shift_Row_3_ID_17] Type=VirtualKey Label=PgDn Cluster=Navigation KeyCode=34 [Key_Shift_Row_3_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_3_ID_19] Type=VirtualKey Label=Home Cluster=Numpad KeyCode=103 [Key_Shift_Row_3_ID_20] Type=VirtualKey Label=🠅 Cluster=Numpad KeyCode=104 [Key_Shift_Row_3_ID_21] Type=VirtualKey Label=PgUp Cluster=Numpad KeyCode=105 [Key_Shift_Row_3_ID_22] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 [Key_Shift_Row_4_ID_0] Type=VirtualKey Width=175 Label=🡇 KeyCode=20 NoRepeat=true [Key_Shift_Row_4_ID_1] Type=VirtualKey Label=A KeyCode=65 [Key_Shift_Row_4_ID_2] Type=VirtualKey Label=S KeyCode=83 [Key_Shift_Row_4_ID_3] Type=VirtualKey Label=D KeyCode=68 [Key_Shift_Row_4_ID_4] Type=VirtualKey Label=F KeyCode=70 [Key_Shift_Row_4_ID_5] Type=VirtualKey Label=G KeyCode=71 [Key_Shift_Row_4_ID_6] Type=VirtualKey Label=H KeyCode=72 [Key_Shift_Row_4_ID_7] Type=VirtualKey Label=J KeyCode=74 [Key_Shift_Row_4_ID_8] Type=VirtualKey Label=K KeyCode=75 [Key_Shift_Row_4_ID_9] Type=VirtualKey Label=L KeyCode=76 [Key_Shift_Row_4_ID_10] Type=String Label=É String=É [Key_Shift_Row_4_ID_11] Type=String Label=Á String=Á [Key_Shift_Row_4_ID_12] Type=String Label=Ű String=Ű [Key_Shift_Row_4_ID_13] Type=VirtualKeyIsoEnter Width=125 Label=↵ KeyCode=13 [Key_Shift_Row_4_ID_14] Type=Blank Width=325 Cluster=Navigation [Key_Shift_Row_4_ID_15] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_4_ID_16] Type=VirtualKey Label=🠄 Cluster=Numpad KeyCode=100 [Key_Shift_Row_4_ID_17] Type=VirtualKey Label=5 Cluster=Numpad KeyCode=101 [Key_Shift_Row_4_ID_18] Type=VirtualKey Label=🠆 Cluster=Numpad KeyCode=102 [Key_Shift_Row_5_ID_0] Type=VirtualKeyToggle Width=125 Label=🡅 KeyCode=160 NoRepeat=true [Key_Shift_Row_5_ID_1] Type=String Label=Í String=Í [Key_Shift_Row_5_ID_2] Type=VirtualKey Label=Y KeyCode=89 [Key_Shift_Row_5_ID_3] Type=VirtualKey Label=X KeyCode=88 [Key_Shift_Row_5_ID_4] Type=VirtualKey Label=C KeyCode=67 [Key_Shift_Row_5_ID_5] Type=VirtualKey Label=V KeyCode=86 [Key_Shift_Row_5_ID_6] Type=VirtualKey Label=B KeyCode=66 [Key_Shift_Row_5_ID_7] Type=VirtualKey Label=N KeyCode=78 [Key_Shift_Row_5_ID_8] Type=VirtualKey Label=M KeyCode=77 [Key_Shift_Row_5_ID_9] Type=String Label=? String=? [Key_Shift_Row_5_ID_10] Type=String Label=: String=: [Key_Shift_Row_5_ID_11] Type=String Label=_ String=_ [Key_Shift_Row_5_ID_12] Type=VirtualKeyToggle Width=275 Label=🡅 KeyCode=161 NoRepeat=true [Key_Shift_Row_5_ID_13] Type=Blank Width=125 Cluster=Navigation [Key_Shift_Row_5_ID_14] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_Shift_Row_5_ID_15] Type=Blank Cluster=Navigation [Key_Shift_Row_5_ID_16] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_5_ID_17] Type=VirtualKey Label=End Cluster=Numpad KeyCode=97 [Key_Shift_Row_5_ID_18] Type=VirtualKey Label=🠇 Cluster=Numpad KeyCode=98 [Key_Shift_Row_5_ID_19] Type=VirtualKey Label=PgDn Cluster=Numpad KeyCode=99 [Key_Shift_Row_5_ID_20] Type=VirtualKey Height=200 Label=Enter Cluster=Numpad KeyCode=13 [Key_Shift_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=162 NoRepeat=true [Key_Shift_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_Shift_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_Shift_Row_6_ID_3] Type=VirtualKey Width=625 Label= KeyCode=32 [Key_Shift_Row_6_ID_4] Type=VirtualKeyToggle Width=125 Label=AltGr KeyCode=165 NoRepeat=true [Key_Shift_Row_6_ID_5] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_Shift_Row_6_ID_6] Type=VirtualKey Width=125 Label=Menü KeyCode=93 NoRepeat=true [Key_Shift_Row_6_ID_7] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=163 NoRepeat=true [Key_Shift_Row_6_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_Shift_Row_6_ID_9] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_Shift_Row_6_ID_10] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_Shift_Row_6_ID_11] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_Shift_Row_6_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_Shift_Row_6_ID_13] Type=VirtualKey Width=200 Label=Insert Cluster=Numpad KeyCode=96 [Key_Shift_Row_6_ID_14] Type=VirtualKey Label=Delete Cluster=Numpad KeyCode=110 [Key_AltGr_Row_0_ID_0] Type=VirtualKey Label=Esc Cluster=Function KeyCode=27 NoRepeat=true [Key_AltGr_Row_0_ID_1] Type=Blank Cluster=Function [Key_AltGr_Row_0_ID_2] Type=VirtualKey Label=F1 Cluster=Function KeyCode=112 [Key_AltGr_Row_0_ID_3] Type=VirtualKey Label=F2 Cluster=Function KeyCode=113 [Key_AltGr_Row_0_ID_4] Type=VirtualKey Label=F3 Cluster=Function KeyCode=114 [Key_AltGr_Row_0_ID_5] Type=VirtualKey Label=F4 Cluster=Function KeyCode=115 [Key_AltGr_Row_0_ID_6] Type=Blank Width=50 Cluster=Function [Key_AltGr_Row_0_ID_7] Type=VirtualKey Label=F5 Cluster=Function KeyCode=116 [Key_AltGr_Row_0_ID_8] Type=VirtualKey Label=F6 Cluster=Function KeyCode=117 [Key_AltGr_Row_0_ID_9] Type=VirtualKey Label=F7 Cluster=Function KeyCode=118 [Key_AltGr_Row_0_ID_10] Type=VirtualKey Label=F8 Cluster=Function KeyCode=119 [Key_AltGr_Row_0_ID_11] Type=Blank Width=50 Cluster=Function [Key_AltGr_Row_0_ID_12] Type=VirtualKey Label=F9 Cluster=Function KeyCode=120 [Key_AltGr_Row_0_ID_13] Type=VirtualKey Label=F10 Cluster=Function KeyCode=121 [Key_AltGr_Row_0_ID_14] Type=VirtualKey Label=F11 Cluster=Function KeyCode=122 [Key_AltGr_Row_0_ID_15] Type=VirtualKey Label=F12 Cluster=Function KeyCode=123 [Key_AltGr_Row_0_ID_16] Type=Blank Width=25 Cluster=Function [Key_AltGr_Row_0_ID_17] Type=VirtualKey Label=PrtSc Cluster=Function KeyCode=44 NoRepeat=true [Key_AltGr_Row_0_ID_18] Type=VirtualKey Label=ScrLk Cluster=Function KeyCode=145 NoRepeat=true [Key_AltGr_Row_0_ID_19] Type=VirtualKey Label=Pause Cluster=Function KeyCode=19 NoRepeat=true [Key_AltGr_Row_0_ID_20] Type=Blank Width=25 Cluster=Extra [Key_AltGr_Row_0_ID_21] Type=VirtualKey Label=⏵/⏸ Cluster=Extra KeyCode=179 NoRepeat=true [Key_AltGr_Row_0_ID_22] Type=VirtualKey Label=◼ Cluster=Extra KeyCode=178 NoRepeat=true [Key_AltGr_Row_0_ID_23] Type=VirtualKey Label=⏮ Cluster=Extra KeyCode=177 NoRepeat=true [Key_AltGr_Row_0_ID_24] Type=VirtualKey Label=⏭ Cluster=Extra KeyCode=176 NoRepeat=true [Key_AltGr_Row_1_ID_0] Type=Blank Height=25 Cluster=Function [Key_AltGr_Row_1_ID_1] Type=Blank Height=25 Cluster=Extra [Key_AltGr_Row_2_ID_0] Type=Blank [Key_AltGr_Row_2_ID_1] Type=String Label=~ String=~ [Key_AltGr_Row_2_ID_2] Type=String Label=ˇ String=ˇ [Key_AltGr_Row_2_ID_3] Type=String Label=^ String=^ [Key_AltGr_Row_2_ID_4] Type=String Label=˘ String=˘ [Key_AltGr_Row_2_ID_5] Type=String Label=° String=° [Key_AltGr_Row_2_ID_6] Type=String Label=˛ String=˛ [Key_AltGr_Row_2_ID_7] Type=String Label=` String=` [Key_AltGr_Row_2_ID_8] Type=String Label=˙ String=˙ [Key_AltGr_Row_2_ID_9] Type=String Label=´ String=´ [Key_AltGr_Row_2_ID_10] Type=String Label=˝ String=˝ [Key_AltGr_Row_2_ID_11] Type=String Label=¨ String=¨ [Key_AltGr_Row_2_ID_12] Type=String Label=¸ String=¸ [Key_AltGr_Row_2_ID_13] Type=VirtualKey Width=200 Label=⟵ KeyCode=8 [Key_AltGr_Row_2_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_AltGr_Row_2_ID_15] Type=VirtualKey Label=⏵/⏸ Cluster=Navigation KeyCode=179 [Key_AltGr_Row_2_ID_16] Type=VirtualKey Label=⏮ Cluster=Navigation KeyCode=177 [Key_AltGr_Row_2_ID_17] Type=VirtualKey Label=⏭ Cluster=Navigation KeyCode=176 [Key_AltGr_Row_2_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_2_ID_19] Type=VirtualKey Label=Num\nLock Cluster=Numpad KeyCode=144 NoRepeat=true [Key_AltGr_Row_2_ID_20] Type=VirtualKey Label=/ Cluster=Numpad KeyCode=111 [Key_AltGr_Row_2_ID_21] Type=VirtualKey Label=* Cluster=Numpad KeyCode=106 [Key_AltGr_Row_2_ID_22] Type=VirtualKey Label=- Cluster=Numpad KeyCode=109 [Key_AltGr_Row_3_ID_0] Type=VirtualKey Width=150 Label=⭾ KeyCode=9 [Key_AltGr_Row_3_ID_1] Type=String Label=\ String=\ [Key_AltGr_Row_3_ID_2] Type=String Label=| String=| [Key_AltGr_Row_3_ID_3] Type=String Label=Ä String=Ä [Key_AltGr_Row_3_ID_4] Type=Blank [Key_AltGr_Row_3_ID_5] Type=Blank [Key_AltGr_Row_3_ID_6] Type=Blank [Key_AltGr_Row_3_ID_7] Type=String Label=€ String=€ [Key_AltGr_Row_3_ID_8] Type=String Label=Í String=Í [Key_AltGr_Row_3_ID_9] Type=Blank [Key_AltGr_Row_3_ID_10] Type=Blank [Key_AltGr_Row_3_ID_11] Type=String Label=÷ String=÷ [Key_AltGr_Row_3_ID_12] Type=String Label=× String=× [Key_AltGr_Row_3_ID_13] Type=VirtualKeyIsoEnter Width=150 Label= KeyCode=13 [Key_AltGr_Row_3_ID_14] Type=Blank Width=25 Cluster=Navigation [Key_AltGr_Row_3_ID_15] Type=VirtualKey Label=🔇 X Cluster=Navigation KeyCode=173 [Key_AltGr_Row_3_ID_16] Type=VirtualKey Label=🔈-- Cluster=Navigation KeyCode=174 [Key_AltGr_Row_3_ID_17] Type=VirtualKey Label=🔈++ Cluster=Navigation KeyCode=175 [Key_AltGr_Row_3_ID_18] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_3_ID_19] Type=VirtualKey Label=7\nHome Cluster=Numpad KeyCode=103 [Key_AltGr_Row_3_ID_20] Type=VirtualKey Label=8\n🠅 Cluster=Numpad KeyCode=104 [Key_AltGr_Row_3_ID_21] Type=VirtualKey Label=9\nPgUp Cluster=Numpad KeyCode=105 [Key_AltGr_Row_3_ID_22] Type=VirtualKey Height=200 Label=+ Cluster=Numpad KeyCode=107 [Key_AltGr_Row_4_ID_0] Type=VirtualKey Width=175 Label=🡇 KeyCode=20 NoRepeat=true [Key_AltGr_Row_4_ID_1] Type=String Label=ä String=ä [Key_AltGr_Row_4_ID_2] Type=String Label=đ String=đ [Key_AltGr_Row_4_ID_3] Type=String Label=Đ String=Đ [Key_AltGr_Row_4_ID_4] Type=String Label=[ String=[ [Key_AltGr_Row_4_ID_5] Type=String Label=] String=] [Key_AltGr_Row_4_ID_6] Type=Blank [Key_AltGr_Row_4_ID_7] Type=String Label=í String=í [Key_AltGr_Row_4_ID_8] Type=String Label=ł String=ł [Key_AltGr_Row_4_ID_9] Type=String Label=Ł String=Ł [Key_AltGr_Row_4_ID_10] Type=String Label=$ String=$ [Key_AltGr_Row_4_ID_11] Type=String Label=ß String=ß [Key_AltGr_Row_4_ID_12] Type=String Label=¤ String=¤ [Key_AltGr_Row_4_ID_13] Type=VirtualKeyIsoEnter Width=125 Label=↵ KeyCode=13 [Key_AltGr_Row_4_ID_14] Type=Blank Width=325 Cluster=Navigation [Key_AltGr_Row_4_ID_15] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_4_ID_16] Type=VirtualKey Label=4\n🠄 Cluster=Numpad KeyCode=100 [Key_AltGr_Row_4_ID_17] Type=VirtualKey Label=5\n Cluster=Numpad KeyCode=101 [Key_AltGr_Row_4_ID_18] Type=VirtualKey Label=6\n🠆 Cluster=Numpad KeyCode=102 [Key_AltGr_Row_5_ID_0] Type=VirtualKeyToggle Width=125 Label=🡅 KeyCode=160 NoRepeat=true [Key_AltGr_Row_5_ID_1] Type=String Label=< String=< [Key_AltGr_Row_5_ID_2] Type=String Label=> String=> [Key_AltGr_Row_5_ID_3] Type=String Label=# String=# [Key_AltGr_Row_5_ID_4] Type=String Label=& String=& [Key_AltGr_Row_5_ID_5] Type=String Label=@ String=@ [Key_AltGr_Row_5_ID_6] Type=String Label={ String={ [Key_AltGr_Row_5_ID_7] Type=String Label=} String=} [Key_AltGr_Row_5_ID_8] Type=String Label=< String=< [Key_AltGr_Row_5_ID_9] Type=String Label=; String=; [Key_AltGr_Row_5_ID_10] Type=String Label=> String=> [Key_AltGr_Row_5_ID_11] Type=String Label=* String=* [Key_AltGr_Row_5_ID_12] Type=VirtualKeyToggle Width=275 Label=🡅 KeyCode=161 NoRepeat=true [Key_AltGr_Row_5_ID_13] Type=Blank Width=125 Cluster=Navigation [Key_AltGr_Row_5_ID_14] Type=VirtualKey Label=🠅 Cluster=Navigation KeyCode=38 [Key_AltGr_Row_5_ID_15] Type=Blank Cluster=Navigation [Key_AltGr_Row_5_ID_16] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_5_ID_17] Type=VirtualKey Label=1\nEnd Cluster=Numpad KeyCode=97 [Key_AltGr_Row_5_ID_18] Type=VirtualKey Label=2\n🠇 Cluster=Numpad KeyCode=98 [Key_AltGr_Row_5_ID_19] Type=VirtualKey Label=3\nPgDn Cluster=Numpad KeyCode=99 [Key_AltGr_Row_5_ID_20] Type=VirtualKey Height=200 Label=Enter Cluster=Numpad KeyCode=13 [Key_AltGr_Row_6_ID_0] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=162 NoRepeat=true [Key_AltGr_Row_6_ID_1] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=91 NoRepeat=true [Key_AltGr_Row_6_ID_2] Type=VirtualKeyToggle Width=125 Label=Alt KeyCode=164 NoRepeat=true [Key_AltGr_Row_6_ID_3] Type=VirtualKey Width=625 Label= KeyCode=32 [Key_AltGr_Row_6_ID_4] Type=VirtualKeyToggle Width=125 Label=AltGr KeyCode=165 NoRepeat=true [Key_AltGr_Row_6_ID_5] Type=VirtualKeyToggle Width=125 Label=Win KeyCode=92 NoRepeat=true [Key_AltGr_Row_6_ID_6] Type=VirtualKey Width=125 Label=Menü KeyCode=93 NoRepeat=true [Key_AltGr_Row_6_ID_7] Type=VirtualKeyToggle Width=125 Label=Ctrl KeyCode=163 NoRepeat=true [Key_AltGr_Row_6_ID_8] Type=Blank Width=25 Cluster=Navigation [Key_AltGr_Row_6_ID_9] Type=VirtualKey Label=🠄 Cluster=Navigation KeyCode=37 [Key_AltGr_Row_6_ID_10] Type=VirtualKey Label=🠇 Cluster=Navigation KeyCode=40 [Key_AltGr_Row_6_ID_11] Type=VirtualKey Label=🠆 Cluster=Navigation KeyCode=39 [Key_AltGr_Row_6_ID_12] Type=Blank Width=25 Cluster=Numpad [Key_AltGr_Row_6_ID_13] Type=VirtualKey Width=200 Label=0\nInsert Cluster=Numpad KeyCode=96 [Key_AltGr_Row_6_ID_14] Type=VirtualKey Label=,\nDelete Cluster=Numpad KeyCode=110 ================================================ FILE: assets/lang/de.ini ================================================ [TranslationInfo] Name=Deutsch (German) Locale=de-DE [Strings] ;Settings Window tstr_SettingsWindowTitle=Desktop+ Einstellungen tstr_SettingsCatInterface=Oberfläche tstr_SettingsCatEnvironment=Umgebung tstr_SettingsCatProfiles=Profile tstr_SettingsCatActions=Aktionen tstr_SettingsCatKeyboard=Tastatur tstr_SettingsCatMouse=Maus tstr_SettingsCatLaserPointer=Laserpointer tstr_SettingsCatWindowOverlays=Fenster-Overlays tstr_SettingsCatBrowser=Browser tstr_SettingsCatPerformance=Leistung tstr_SettingsCatVersionInfo=Versionsdetails tstr_SettingsCatWarnings=Warnungen tstr_SettingsCatStartup=Startvorgang tstr_SettingsCatTroubleshooting=Problembehandlung tstr_SettingsWarningPrefix=Warnung: tstr_SettingsWarningCompositorResolution=Auflösung des SteamVR-Compositors ist unter 100%! Dies beeinträchtigt Overlay-Renderqualität. tstr_SettingsWarningCompositorQuality=SteamVR Overlay-Renderqualität ist nicht auf hoch eingestellt! tstr_SettingsWarningProcessElevated=Desktop+ wird mit administrativen Rechten ausgeführt! tstr_SettingsWarningElevatedMode=Erhöhter Modus ist aktiv! tstr_SettingsWarningElevatedProcessFocus=Ein Prozess mit erhöhten Rechten hat Fokus!\nDesktop+ ist derzeit nicht in der Lage Eingaben zu simulieren. tstr_SettingsWarningBrowserMissing=Es werden Browser-Overlays verwendet, aber die Desktop+ Browser-Komponente ist derzeit nicht verfügbar. tstr_SettingsWarningBrowserMismatch=Die installierte Desktop+ Browser-Komponente ist nicht mit dieser Version von Desktop+ kompatibel! tstr_SettingsWarningUIAccessLost=Desktop+ wird nicht mehr mit UIAccess Rechten ausgeführt! tstr_SettingsWarningOverlayCreationErrorLimit=Eine Overlayerstellung ist fehlgeschlagen! (Maximales Overlaylimit wurde überschritten) tstr_SettingsWarningOverlayCreationErrorOther=Eine Overlayerstellung ist fehlgeschlagen! (%ERRORNAME%) tstr_SettingsWarningGraphicsCaptureError=Ein unerwarteter Fehler ist in einem Graphics Capture-Thread aufgetreten! (%ERRORCODE%) tstr_SettingsWarningAppProfileActive=Das Anwendungs-Profil für %APPNAME% hat das bestehende Overlaylayout überschrieben.\nÄnderungen an den Overlays werden nicht automatisch gespeichert während es aktiv ist. tstr_SettingsWarningConfigMigrated=Einstellungen und Profile der vorherigen Desktop+ Version wurden in neue Formate migriert.\nDie ursprünglichen Dateien wurden nicht gelöscht und können weiterhin mit einer älteren Version der Anwendung verwendet werden.\nUm stattdessen von Null zu beginnen, siehe [Auf Standardeinstellungen zurücksetzen]. tstr_SettingsWarningMenuDontShowAgain=Nicht mehr zeigen tstr_SettingsWarningMenuDismiss=Ausblenden tstr_SettingsInterfaceLanguage=Sprache tstr_SettingsInterfaceLanguageCommunity=Community-Übersetzung von %AUTHOR% tstr_SettingsInterfaceLanguageIncompleteWarning=Übersetzung ist möglicherweise nicht vollständig tstr_SettingsInterfaceAdvancedSettings=Zeige erweiterte Einstellungen tstr_SettingsInterfaceAdvancedSettingsTip=Zeige erweiterte und seltener verwendete Einstellungen tstr_SettingsInterfaceBlankSpaceDrag=Verschiebe Fenster, wenn auf leeren Bereich geklickt wird tstr_SettingsInterfacePersistentUI=Persistente UI tstr_SettingsInterfacePersistentUIManage=Verwalten tstr_SettingsInterfaceDesktopButtons=Desktop-Schaltflächenstil tstr_SettingsInterfaceDesktopButtonsNone=Keine tstr_SettingsInterfaceDesktopButtonsIndividual=Individuelle Desktops tstr_SettingsInterfaceDesktopButtonsCycle=Zyklische Schaltflächen tstr_SettingsInterfaceDesktopButtonsAddCombined=Gesamten Desktop hinzufügen tstr_SettingsInterfacePersistentUIHelp=Desktop+ merkt sich die Zustände der UI-Fenster getrennt für die allgemeine Nutzung (Global) und der Nutzung innerhalb des Desktop+ SteamVR Dashboard-Tabs (Desktop+ Tab). tstr_SettingsInterfacePersistentUIHelp2=Die folgenden Bedienelemente können zur direkten Manipulation der Fensterzustände verwendet werden.\nBeachte, dass einige Zustände das Zurücksetzen der Position erfordern um das Fenster an eine sichtbare Stelle zu bringen. tstr_SettingsInterfacePersistentUIWindowsHeader=Fenster tstr_SettingsInterfacePersistentUIWindowsSettings=Einstellungen tstr_SettingsInterfacePersistentUIWindowsProperties=Overlay-Eigenschaften tstr_SettingsInterfacePersistentUIWindowsKeyboard=Desktop+ Tastatur tstr_SettingsInterfacePersistentUIWindowsStateGlobal=Global tstr_SettingsInterfacePersistentUIWindowsStateDashboardTab=Desktop+ Tab tstr_SettingsInterfacePersistentUIWindowsStateVisible=Sichtbar tstr_SettingsInterfacePersistentUIWindowsStatePinned=Angepinnt tstr_SettingsInterfacePersistentUIWindowsStatePosition=Position tstr_SettingsInterfacePersistentUIWindowsStatePositionReset=Zurücksetzen tstr_SettingsInterfacePersistentUIWindowsStateSize=Größe tstr_SettingsInterfacePersistentUIWindowsStateLaunchRestore=Zustand bei Desktop+-Start wiederherstellen tstr_SettingsEnvironmentBackgroundColor=Hintergrundfarbe tstr_SettingsEnvironmentBackgroundColorDispModeNever=Nie sichtbar tstr_SettingsEnvironmentBackgroundColorDispModeDPlusTab=Nur im Desktop+ Tab sichtbar tstr_SettingsEnvironmentBackgroundColorDispModeAlways=Immer sichtbar tstr_SettingsEnvironmentDimInterface=Oberfläche dimmen tstr_SettingsEnvironmentDimInterfaceTip=Dimmt das SteamVR Dashboard und die Desktop+ Oberfläche während der Desktop+ Dashboard-Tab offen ist tstr_SettingsProfilesOverlays=Overlay-Profile tstr_SettingsProfilesApps=Anwendungs-Profile tstr_SettingsProfilesManage=Verwalten tstr_SettingsProfilesOverlaysHeader=Overlay-Profile verwalten tstr_SettingsProfilesOverlaysNameDefault=Standardprofil tstr_SettingsProfilesOverlaysNameNew=[Neues Profil] tstr_SettingsProfilesOverlaysNameNewBase=Profil %ID% tstr_SettingsProfilesOverlaysProfileLoad=Profil laden tstr_SettingsProfilesOverlaysProfileAdd=Aus Profil hinzufügen tstr_SettingsProfilesOverlaysProfileSave=Aktuelle Overlays speichern tstr_SettingsProfilesOverlaysProfileDelete=Profil löschen tstr_SettingsProfilesOverlaysProfileDeleteConfirm=Wirklich? tstr_SettingsProfilesOverlaysProfileFailedLoad=Laden des Profils fehlgeschlagen tstr_SettingsProfilesOverlaysProfileFailedDelete=Löschen des Profils fehlgeschlagen tstr_SettingsProfilesOverlaysProfileAddSelectHeader=Profil zum Hinzufügen auswählen tstr_SettingsProfilesOverlaysProfileAddSelectEmpty=Dieses Profil enthält keine Overlays tstr_SettingsProfilesOverlaysProfileAddSelectDo=Ausgewählte Overlays hinzufügen tstr_SettingsProfilesOverlaysProfileAddSelectAll=Alle auswählen tstr_SettingsProfilesOverlaysProfileAddSelectNone=Keine auswählen tstr_SettingsProfilesOverlaysProfileSaveSelectHeader=Aktuelle Overlays speichern tstr_SettingsProfilesOverlaysProfileSaveSelectName=Profilname tstr_SettingsProfilesOverlaysProfileSaveSelectNameErrorBlank=Name darf nicht leer sein tstr_SettingsProfilesOverlaysProfileSaveSelectNameErrorTaken=Name ist bereits in Verwendung tstr_SettingsProfilesOverlaysProfileSaveSelectHeaderList=Overlays zum Speichern im Profil auswählen tstr_SettingsProfilesOverlaysProfileSaveSelectDo=Ausgewählte Overlays speichern tstr_SettingsProfilesOverlaysProfileSaveSelectDoFailed=Speichern des Profils fehlgeschlagen tstr_SettingsProfilesAppsHeader=Anwendungs-Profile verwalten tstr_SettingsProfilesAppsHeaderNoVRTip=Während Desktop+ nicht läuft werden nur existierende Anwendungs-Profile gelistet tstr_SettingsProfilesAppsListEmpty=Keine Anwendungen verfügbar tstr_SettingsProfilesAppsProfileHeaderActive=(derzeit aktiv) tstr_SettingsProfilesAppsProfileEnabled=Aktiviere, wenn Anwendung läuft tstr_SettingsProfilesAppsProfileOverlayProfile=Overlay-Profil tstr_SettingsProfilesAppsProfileActionEnter=Start-Aktion tstr_SettingsProfilesAppsProfileActionLeave=End-Aktion tstr_SettingsActionsManage=Aktionen tstr_SettingsActionsManageButton=Verwalten tstr_SettingsActionsButtonsOrderDefault=Aktions-Schaltflächen (Standard) tstr_SettingsActionsButtonsOrderOverlayBar=Aktions-Schaltflächen (Overlay-Bar) tstr_SettingsActionsShowBindings=Zeige Controllerzuordnungen tstr_SettingsActionsActiveShortcuts=Aktive Controllertasten tstr_SettingsActionsActiveShortcutsTip=Controllerzuordnungen während auf ein Overlay gezeigt wird.\nBearbeite die VR Dashboard Controllerzuordnungen um zu ändern welche Tasten diese sind. tstr_SettingsActionsActiveShortuctsHome="Zur Startseite" tstr_SettingsActionsActiveShortuctsBack="Zurück" tstr_SettingsActionsGlobalShortcuts=Globale Controllertasten tstr_SettingsActionsGlobalShortcutsTip=Controllerzuordnungen während das Dashboard geschlossen ist und auf kein Overlay gezeigt wird.\nBearbeite die Desktop+ Controllerzuordnungnen um zu ändern welche Tasten diese sind. tstr_SettingsActionsGlobalShortcutsEntry=Globales Kürzel #%ID% tstr_SettingsActionsGlobalShortcutsAdd=Kürzel hinzufügen tstr_SettingsActionsGlobalShortcutsRemove=Letztes Kürzel entfernen tstr_SettingsActionsHotkeys=Hotkeys tstr_SettingsActionsHotkeysTip=Systemweite Tastenkürzel.\nHotkey-Eingaben werden von anderen Anwendungen nicht erfasst und funktionieren möglicherweise nicht falls die selbe Tastenkombination schon woanders registriert wurde. tstr_SettingsActionsHotkeysAdd=Hotkey hinzufügen tstr_SettingsActionsHotkeysRemove=Entfernen tstr_SettingsActionsTableHeaderAction=Aktion tstr_SettingsActionsTableHeaderShortcut=Kürzel tstr_SettingsActionsTableHeaderHotkey=Hotkey tstr_SettingsActionsManageHeader=Aktionen verwalten tstr_SettingsActionsManageCopyUID=UID kopieren tstr_SettingsActionsManageNew=Neue Aktion... tstr_SettingsActionsManageEdit=Aktion bearbeiten tstr_SettingsActionsManageDuplicate=Aktion duplizieren tstr_SettingsActionsManageDelete=Aktion löschen tstr_SettingsActionsManageDeleteConfirm=Wirklich? tstr_SettingsActionsManageDuplicatedName=%NAME% (Kopie) tstr_SettingsActionsEditHeader=Aktion bearbeiten tstr_SettingsActionsEditName=Name tstr_SettingsActionsEditNameTranslatedTip=Diese Aktion verwendet momentan eine Übersetzungstext-ID als Name, um sich automatisch der gewählten Sprache anzupassen tstr_SettingsActionsEditTarget=Ziel tstr_SettingsActionsEditTargetDefault=Standard tstr_SettingsActionsEditTargetDefaultTip=Verwendet das Overlay als Ziel, auf dem die Aktion ausgelöst wurde.\nFalls letzteres nicht existiert, wird das fokussierte Overlay verwendet. tstr_SettingsActionsEditTargetUseTags=Verwende Tags tstr_SettingsActionsEditTargetActionTarget=Aktions-Ziel tstr_SettingsActionsEditHeaderAppearance=Schaltflächen-Erscheinungsbild tstr_SettingsActionsEditIcon=Icon tstr_SettingsActionsEditLabel=Beschriftung tstr_SettingsActionsEditLabelTranslatedTip=Diese Aktion verwendet momentan eine Übersetzungstext-ID als Beschriftung, um sich automatisch der gewählten Sprache anzupassen tstr_SettingsActionsEditHeaderCommands=Befehle tstr_SettingsActionsEditNameNew=Neue Aktion tstr_SettingsActionsEditCommandAdd=Befehl hinzufügen tstr_SettingsActionsEditCommandDelete=Befehl löschen tstr_SettingsActionsEditCommandDeleteConfirm=Wirklich? tstr_SettingsActionsEditCommandType=Befehlstyp tstr_SettingsActionsEditCommandTypeNone=Kein tstr_SettingsActionsEditCommandTypeKey=Drücke Taste tstr_SettingsActionsEditCommandTypeMousePos=Setze Mausposition tstr_SettingsActionsEditCommandTypeString=Tippe Text tstr_SettingsActionsEditCommandTypeLaunchApp=Starte Anwendung tstr_SettingsActionsEditCommandTypeShowKeyboard=Zeige Tastatur tstr_SettingsActionsEditCommandTypeCropActiveWindow=Schneide zum aktiven Fenster zu tstr_SettingsActionsEditCommandTypeShowOverlay=Zeige Overlay tstr_SettingsActionsEditCommandTypeSwitchTask=Wechsle Task tstr_SettingsActionsEditCommandTypeLoadOverlayProfile=Lade Overlay-Profil tstr_SettingsActionsEditCommandTypeUnknown=Unbekannt tstr_SettingsActionsEditCommandVisibilityToggle=Umschalten tstr_SettingsActionsEditCommandVisibilityShow=Immer zeigen tstr_SettingsActionsEditCommandVisibilityHide=Immer verstecken tstr_SettingsActionsEditCommandUndo=Bei Loslassen umkehren tstr_SettingsActionsEditCommandKeyCode=Tastencode tstr_SettingsActionsEditCommandKeyToggle=Taste umschalten tstr_SettingsActionsEditCommandMouseX=X tstr_SettingsActionsEditCommandMouseY=Y tstr_SettingsActionsEditCommandMouseUseCurrent=Verwende momentane Mausposition tstr_SettingsActionsEditCommandString=Text tstr_SettingsActionsEditCommandPath=Anwendungspfad tstr_SettingsActionsEditCommandPathTip=Dies kann auch eine normale Datei oder URL sein tstr_SettingsActionsEditCommandArgs=Anwendungsparameter tstr_SettingsActionsEditCommandArgsTip=Diese werden zur Anwendung weitergeleitet.\nFalls unsicher, leer lassen. tstr_SettingsActionsEditCommandVisibility=Sichtbarkeit tstr_SettingsActionsEditCommandSwitchingMethod=Wechselmethode tstr_SettingsActionsEditCommandSwitchingMethodSwitcher=Zeige Task-Wechsler tstr_SettingsActionsEditCommandSwitchingMethodFocus=Fokussiere Fenster tstr_SettingsActionsEditCommandWindow=Fenster tstr_SettingsActionsEditCommandWindowNone=[Kein Fenster] tstr_SettingsActionsEditCommandWindowStrictMatchingTip=Erlaube nur exakte Fenstertitel-Übereinstimmungen, wenn ein Fenster zum fokussieren gesucht wird tstr_SettingsActionsEditCommandCursorWarp=Bewege Mauszeiger in das Fenster tstr_SettingsActionsEditCommandProfile=Profil tstr_SettingsActionsEditCommandProfileClear=Entferne bestehende Overlays tstr_SettingsActionsEditCommandDescNone=Kein Befehl tstr_SettingsActionsEditCommandDescKey=Drücke Taste "%KEYNAME%" tstr_SettingsActionsEditCommandDescKeyToggle=Schalte Taste "%KEYNAME%" um tstr_SettingsActionsEditCommandDescMousePos=Setze Mausposition zu %X%, %Y% tstr_SettingsActionsEditCommandDescString=Tippe Text "%STRING%" tstr_SettingsActionsEditCommandDescLaunchApp=Starte Anwendung "%APP%" %ARGSOPT% tstr_SettingsActionsEditCommandDescLaunchAppArgsOpt="%ARGS%" tstr_SettingsActionsEditCommandDescKeyboardToggle=Schalte Tastatur um tstr_SettingsActionsEditCommandDescKeyboardShow=Zeige Tastatur tstr_SettingsActionsEditCommandDescKeyboardHide=Verstecke Tastatur tstr_SettingsActionsEditCommandDescCropWindow=Schneide zum aktiven Fenster zu tstr_SettingsActionsEditCommandDescOverlayToggle=Schalte Overlay um: %TAGS% tstr_SettingsActionsEditCommandDescOverlayShow=Zeige Overlay: %TAGS% tstr_SettingsActionsEditCommandDescOverlayHide=Verstecke Overlay: %TAGS% tstr_SettingsActionsEditCommandDescOverlayTargetDefault=[Aktions-Ziel] tstr_SettingsActionsEditCommandDescSwitchTask=Wechsle Task tstr_SettingsActionsEditCommandDescSwitchTaskWindow=Wechsle Task zu "%WINDOW%" tstr_SettingsActionsEditCommandDescLoadOverlayProfile=Lade Overlay-Profil "%PROFILE%" tstr_SettingsActionsEditCommandDescLoadOverlayProfileAdd=Füge Overlay-Profil "%PROFILE%" hinzu tstr_SettingsActionsEditCommandDescUnknown=Unbekannter Befehl tstr_SettingsActionsOrderHeader=Ändere Aktions-Anordnung tstr_SettingsActionsOrderButtonLabel=%COUNT% Aktionen ausgewählt tstr_SettingsActionsOrderButtonLabelSingular=%COUNT% Aktion ausgewählt tstr_SettingsActionsOrderNoActions=Keine Aktionen ausgewählt tstr_SettingsActionsOrderAdd=Aktionen hinzufügen... tstr_SettingsActionsOrderRemove=Aktion entfernen tstr_SettingsActionsAddSelectorHeader=Wähle Aktionen zum Hinzufügen tstr_SettingsActionsAddSelectorAdd=Ausgewählte Aktionen hinzufügen tstr_SettingsKeyboardLayout=Tastaturlayout tstr_SettingsKeyboardSize=Größe tstr_SettingsKeyboardBehavior=Verhalten tstr_SettingsKeyboardStickyMod=Umschalttasten einrasten tstr_SettingsKeyboardKeyRepeat=Tastenwiederholung tstr_SettingsKeyboardAutoShow=Automatisch einblenden tstr_SettingsKeyboardAutoShowDesktopOnly=Automatisch einblenden tstr_SettingsKeyboardAutoShowDesktop=Für Desktop- & Fenster-Overlays tstr_SettingsKeyboardAutoShowDesktopTip=Experimentell. Funktioniert nicht mit allen Anwendungen. tstr_SettingsKeyboardAutoShowBrowser=Für Browser-Overlays tstr_SettingsKeyboardLayoutAuthor=Erstellt von %AUTHOR% tstr_SettingsKeyboardKeyClusters=Tastengruppen tstr_SettingsKeyboardKeyClusterBase=Basis tstr_SettingsKeyboardKeyClusterFunction=Funktion tstr_SettingsKeyboardKeyClusterNavigation=Navigation tstr_SettingsKeyboardKeyClusterNumpad=Ziffernblock tstr_SettingsKeyboardKeyClusterExtra=Extra tstr_SettingsKeyboardSwitchToEditor=Zu Tastaturlayout-Editor wechseln tstr_SettingsMouseShowCursor=Zeige Mauszeiger tstr_SettingsMouseShowCursorGCUnsupported=Das Deaktivieren des Mauszeigers für Graphics Capture-Overlays wird von diesem System nicht unterstützt tstr_SettingsMouseShowCursorGCActiveWarning=Aktive Graphics Capture-Bilderfassungen verhindern möglicherweise, dass der Mauszeiger in Desktop Duplication-Overlays ausgeblendet werden kann tstr_SettingsMouseScrollSmooth=Verwende weiches Scrollen tstr_SettingsMouseSimulatePen=Simuliere als Stifteingabe tstr_SettingsMouseSimulatePenUnsupported=Simulation von Stifteingaben wird von diesem System nicht unterstützt tstr_SettingsMouseAllowLaserPointerOverride=Erlaube Laserpointer-Überbrückung tstr_SettingsMouseAllowLaserPointerOverrideTip=Deaktiviert den Laserpointer, wenn die physische Maus ruckartig bewegt wird.\nKlicke auf ein Overlay um den Laserpointer wieder zu aktivieren. tstr_SettingsMouseDoubleClickAssist=Doppelklick-Assistent tstr_SettingsMouseDoubleClickAssistTip=Friert den Mauszeiger für die angegebene Zeit ein, um Eingaben von Doppelklicks zu erleichtern. tstr_SettingsMouseDoubleClickAssistTipValueOff=Aus tstr_SettingsMouseDoubleClickAssistTipValueAuto=Auto tstr_SettingsMouseSmoothing=Eingabeglättung tstr_SettingsMouseSmoothingLevelNone=Keine tstr_SettingsMouseSmoothingLevelVeryLow=Sehr Niedrig tstr_SettingsMouseSmoothingLevelLow=Niedrig tstr_SettingsMouseSmoothingLevelMedium=Mittel tstr_SettingsMouseSmoothingLevelHigh=Hoch tstr_SettingsMouseSmoothingLevelVeryHigh=Sehr Hoch tstr_SettingsLaserPointerTip=Diese Einstellungen gelten für Desktop+'s Laserpointer, welcher verwendet wird, wenn das SteamVR Dashboard geschlossen ist tstr_SettingsLaserPointerBlockInput=Blockiere Spiel-Eingabe, wenn aktiv tstr_SettingsLaserPointerAutoToggleDistance=Maximale Auto-Aktivierungsdistanz tstr_SettingsLaserPointerAutoToggleDistanceValueOff=Aus tstr_SettingsLaserPointerHMDPointer=Blick-basierter HMD-Pointer tstr_SettingsLaserPointerHMDPointerTableHeaderInputAction=Eingabeaktion tstr_SettingsLaserPointerHMDPointerTableHeaderBinding=Tastatureingabe tstr_SettingsLaserPointerHMDPointerTableBindingToggle=Laserpointer umschalten tstr_SettingsLaserPointerHMDPointerTableBindingLeft=Linke Maustaste tstr_SettingsLaserPointerHMDPointerTableBindingRight=Rechte Maustaste tstr_SettingsLaserPointerHMDPointerTableBindingMiddle=Mittlere Maustaste tstr_SettingsLaserPointerHMDPointerTableBindingDrag=Overlay ziehen tstr_SettingsWindowOverlaysAutoFocus=Fokussiere Fenster, wenn auf ein Overlay gezeigt wird tstr_SettingsWindowOverlaysKeepOnScreen=Halte Fenster auf dem Bildschirm tstr_SettingsWindowOverlaysKeepOnScreenTip=Bewegt das Quellfenster in den Arbeitsbereich des Bildschirms, wenn es außerhalb dessen liegt tstr_SettingsWindowOverlaysAutoSizeOverlay=Passe Overlaygröße an, wenn die Fenstergröße sich ändert tstr_SettingsWindowOverlaysFocusSceneApp=Fokussiere Spiel, wenn der Laserpointer das Overlay verlässt tstr_SettingsWindowOverlaysFocusSceneAppDashboard=Fokussiere Spiel, nachdem das Dashboard geschlossen wurde tstr_SettingsWindowOverlaysOnWindowDrag=Bei Fenster-Verschiebung tstr_SettingsWindowOverlaysOnWindowDragDoNothing=Nichts tun tstr_SettingsWindowOverlaysOnWindowDragBlock=Blockiere Verschiebung tstr_SettingsWindowOverlaysOnWindowDragOverlay=Verschiebe Overlay tstr_SettingsWindowOverlaysOnCaptureLoss=Bei Bilderfassungs-Verlust tstr_SettingsWindowOverlaysOnCaptureLossTip=Verhalten, wenn eine Fenster-Bilderfassung endet, in der Regel aufgrund vom Schließen des Zielfensters.\n"Verstecke Overlay" zeigt das Overlay auch wieder, wenn die Erfassung wiederhergestellt wird. tstr_SettingsWindowOverlaysOnCaptureLossDoNothing=Nichts tun tstr_SettingsWindowOverlaysOnCaptureLossHide=Verstecke Overlay tstr_SettingsWindowOverlaysOnCaptureLossRemove=Entferne Overlay tstr_SettingsBrowserMaxFrameRate=Maximale Frame-Rate tstr_SettingsBrowserMaxFrameRateOverrideOff=Globale Einstellung tstr_SettingsBrowserContentBlocker=Inhaltsblockierung tstr_SettingsBrowserContentBlockerTip=Kopiere Blocklisten im Adblock Plus-Syntax in das "DesktopPlusBrowser\content_block" Verzeichnis.\nEs werden alle Listen im Verzeichnis geladen. tstr_SettingsBrowserContentBlockerListCount=(%LISTCOUNT% Listen aktiv) tstr_SettingsBrowserContentBlockerListCountSingular=(%LISTCOUNT% Liste aktiv) tstr_SettingsPerformanceUpdateLimiter=Limitiere Updates tstr_SettingsPerformanceUpdateLimiterMode=Updatelimiter-Modus tstr_SettingsPerformanceUpdateLimiterModeOff=Aus tstr_SettingsPerformanceUpdateLimiterModeMS=Frame-Zeit tstr_SettingsPerformanceUpdateLimiterModeFPS=Frame-Rate tstr_SettingsPerformanceUpdateLimiterModeOffOverride=Verwende globale Einstellung tstr_SettingsPerformanceUpdateLimiterModeMSTip="Frame-Zeit" erzwingt ein Mindestintervall zwischen Overlayupdates tstr_SettingsPerformanceUpdateLimiterFPSValue=%FPS% fps tstr_SettingsPerformanceUpdateLimiterOverride=Überschreibe Updatelimit tstr_SettingsPerformanceUpdateLimiterOverrideTip=Wenn mehrere Überschreibungen aktiv sind, wird diejenige verwendet, die in der höchsten Update-Rate resultiert tstr_SettingsPerformanceUpdateLimiterModeOverride=Überschreibe Updatelimiter tstr_SettingsPerformanceRapidUpdates=Verringere Laserpointer-Latenz tstr_SettingsPerformanceRapidUpdatesTip=Verringere die Latenz von Laserpointer-Eingaben auf Kosten zusätzlicher CPU-Last, solange auf ein Overlay gezeigt wird tstr_SettingsPerformanceSingleDesktopMirror=Einzelne Desktopspiegelung tstr_SettingsPerformanceSingleDesktopMirrorTip=Spiegele individuelle Desktops, wenn zu ihnen gewechselt wird, anstatt vom gesamten Desktop zuzuschneiden.\nSolange diese Einstellung aktiv ist, werden alle Overlays den selben Desktop zeigen. tstr_SettingsPerformanceAlternativeCursorRendering=Alternative Mauszeigerdarstellung tstr_SettingsPerformanceAlternativeCursorRenderingTip=Verwende eine andere Methode zum Erfassen und Darstellen des Mauszeigers.\nKann helfen, wenn mit der Standardmethode Probleme bei der Darstellung des Hardware-Mauszeigers auftreten. tstr_SettingsPerformanceUseHDR=HDR-Spiegelung tstr_SettingsPerformanceUseHDRTip=Verwende beim Spiegeln von Desktops und Fenstern Texturen mit höherer Bittiefe, zur HDR-Unterstützung. Experimentell.\nKann die Leistung beeinträchtigen, falls nicht erforderlich, und erhöht VRAM-Verbrauch. tstr_SettingsPerformanceShowFPS=Zeige FPS in Floating UI tstr_SettingsWarningsHidden=Versteckte Warnungen: tstr_SettingsWarningsReset=Versteckte Warnungen zurücksetzen tstr_SettingsStartupAutoLaunch=Starte automatisch bei SteamVR-Start tstr_SettingsStartupSteamDisable=Deaktiviere Steam-Integration tstr_SettingsStartupSteamDisableTip=Startet Desktop+ ohne Steam neu, wenn es davon gestartet wurde.\nDies deaktiviert den permanenten In-App-Status, Nutzungszeit-Statistik und andere Steam-Funktionen. tstr_SettingsTroubleshootingRestart=Neustarten tstr_SettingsTroubleshootingRestartSteam=Mit Steam neu starten tstr_SettingsTroubleshootingRestartDesktop=Im Desktopmodus neu starten tstr_SettingsTroubleshootingElevatedModeEnter=Starte erhöhten Modus tstr_SettingsTroubleshootingElevatedModeLeave=Stoppe erhöhten Modus tstr_SettingsTroubleshootingSettingsReset=Auf Standardeinstellungen zurücksetzen tstr_SettingsTroubleshootingSettingsResetConfirmDescription=Die ausgewählte Elemente werden auf ihre Standardwerte zurückgesetzt.\nDieser Vorgang kann nicht rückgängig gemacht werden.\n\nSetze folgendes zurück: tstr_SettingsTroubleshootingSettingsResetConfirmButton=Ausgewählte Elemente zurücksetzen tstr_SettingsTroubleshootingSettingsResetConfirmElementOverlays=Aktive Overlaykonfiguration tstr_SettingsTroubleshootingSettingsResetConfirmElementLegacyFiles=Lösche alte unbenutzte Konfigurations- und Profildateien tstr_SettingsTroubleshootingSettingsResetShowQuickStart=Kurzanleitung anzeigen ;Keyboard Window tstr_KeyboardWindowTitle=Desktop+ Tastatur tstr_KeyboardWindowTitleSettings=Desktop+ Tastatur (Einstellungen) tstr_KeyboardWindowTitleOverlay=Desktop+ Tastatur (%OVERLAYNAME%) tstr_KeyboardWindowTitleOverlayUnknown=[Unbekanntes Overlay] ;Keyboard Shortcuts Window tstr_KeyboardShortcutsCut=Ausschneiden tstr_KeyboardShortcutsCopy=Kopieren tstr_KeyboardShortcutsPaste=Einfügen ;Overlay Properties Window tstr_OvrlPropsCatPosition=Position tstr_OvrlPropsCatAppearance=Aussehen tstr_OvrlPropsCatCapture=Bilderfassung tstr_OvrlPropsCatPerformanceMonitor=Leistungsanzeige tstr_OvrlPropsCatBrowser=Browser tstr_OvrlPropsCatAdvanced=Erweitert tstr_OvrlPropsCatPerformance=Leistung tstr_OvrlPropsCatInterface=Oberfläche tstr_OvrlPropsPositionOrigin=Ursprung tstr_OvrlPropsPositionOriginRoom=Spielbereich tstr_OvrlPropsPositionOriginHMDXY=HMD-Bodenposition tstr_OvrlPropsPositionOriginDashboard=Dashboard tstr_OvrlPropsPositionOriginHMD=HMD tstr_OvrlPropsPositionOriginSeatedSpace=Sitzposition tstr_OvrlPropsPositionOriginControllerR=Rechter Controller tstr_OvrlPropsPositionOriginControllerL=Linker Controller tstr_OvrlPropsPositionOriginTheaterScreen=Kinoleinwand tstr_OvrlPropsPositionOriginTracker1=Tracker #1 tstr_OvrlPropsPositionOriginConfigHMDXYTurning=Mit HMD drehen tstr_OvrlPropsPositionOriginConfigTheaterScreenEnter=Starte Kinomodus tstr_OvrlPropsPositionOriginConfigTheaterScreenLeave=Beende Kinomodus tstr_OvrlPropsPositionOriginConfigSmoothing=Ursprungsglättung tstr_OvrlPropsPositionOriginTheaterScreenTip=Einige Eigenschaften werden von der SteamVR Kinoleinwand gesteuert tstr_OvrlPropsPositionDispMode=Anzeigemodus tstr_OvrlPropsPositionDispModeAlways=Immer tstr_OvrlPropsPositionDispModeDashboard=Nur im Dashboard tstr_OvrlPropsPositionDispModeScene=Nur im Spiel tstr_OvrlPropsPositionDispModeDPlus=Nur im Desktop+ Tab tstr_OvrlPropsPositionPos=Position tstr_OvrlPropsPositionPosTip=Die Position kann nur verändert oder zurückgesetzt werden wenn Desktop+ läuft tstr_OvrlPropsPositionChange=Ändern tstr_OvrlPropsPositionReset=Zurücksetzen tstr_OvrlPropsPositionLock=Sperren tstr_OvrlPropsPositionChangeHeader=Overlayposition ändern tstr_OvrlPropsPositionChangeHelp=Verschiebe ein beliebiges Overlay, um dessen Position zu ändern.\nHalte Rechtsklick gedrückt für eine zweihändige Gestenmanipulation. tstr_OvrlPropsPositionChangeHelpDesktop=Halte die Zieh-Schaltflächen ("Z") gedrückt um das Overlay mit der Maus zu verschieben oder drehen. tstr_OvrlPropsPositionChangeManualAdjustment=Manuelle Anpassung tstr_OvrlPropsPositionChangeMove=Bewegen tstr_OvrlPropsPositionChangeRotate=Drehen tstr_OvrlPropsPositionChangeForward=Vorwärts tstr_OvrlPropsPositionChangeBackward=Rückwärts tstr_OvrlPropsPositionChangeRollCW=Rolle ⟳ tstr_OvrlPropsPositionChangeRollCCW=Rolle ⟲ tstr_OvrlPropsPositionChangeLookAt=Zum HMD tstr_OvrlPropsPositionChangeDragButton=Z tstr_OvrlPropsPositionChangeOffset=Zusätzliches Offset tstr_OvrlPropsPositionChangeOffsetUpDown=Hoch/Runter-Offset tstr_OvrlPropsPositionChangeOffsetRightLeft=Rechts/Links-Offset tstr_OvrlPropsPositionChangeOffsetForwardBackward=Vorwärts/Rückwärts-Offset tstr_OvrlPropsPositionChangeDragSettings=Zieh-Einstellungen tstr_OvrlPropsPositionChangeDragSettingsAutoDocking=Docke an Controller, wenn in Nähe tstr_OvrlPropsPositionChangeDragSettingsForceUpright=Erzwinge aufrechte Ausrichtung tstr_OvrlPropsPositionChangeDragSettingsForceDistance=Erzwinge festen Abstand tstr_OvrlPropsPositionChangeDragSettingsForceDistanceShape=Form tstr_OvrlPropsPositionChangeDragSettingsForceDistanceShapeSphere=Kugel tstr_OvrlPropsPositionChangeDragSettingsForceDistanceShapeCylinder=Zylinder tstr_OvrlPropsPositionChangeDragSettingsForceDistanceAutoCurve=Auto-Krümmung tstr_OvrlPropsPositionChangeDragSettingsForceDistanceAutoTilt=Auto-Neigung tstr_OvrlPropsPositionChangeDragSettingsSnapPosition=Position einrasten tstr_OvrlPropsPositionChangeDragSettingsSnapRotation=Drehung einrasten tstr_OvrlPropsPositionChangeDragSettingsSnapRotationPitch=Nickachse tstr_OvrlPropsPositionChangeDragSettingsSnapRotationYaw=Gierachse tstr_OvrlPropsPositionChangeDragSettingsSnapRotationRoll=Rollachse tstr_OvrlPropsAppearanceWidth=Breite tstr_OvrlPropsAppearanceCurve=Krümmung tstr_OvrlPropsAppearanceOpacity=Deckkraft tstr_OvrlPropsAppearanceBrightness=Helligkeit tstr_OvrlPropsAppearanceCrop=Zuschneidung tstr_OvrlPropsAppearanceCropValueMax=Max tstr_OvrlPropsAppearanceShowBackside=Zeige Rückseite tstr_OvrlPropsCrop=Zuschneide-Bereich tstr_OvrlPropsCropHelp=Ziehe das Rechteck um die Zuschneidung zu verändern. Verwende Scroll-Eingaben oder ziehe die Seiten um die Größe des Zuschneidungs-Rechtecks anzupassen. tstr_OvrlPropsCropManualAdjust=Manuelle Anpassung tstr_OvrlPropsCropInvalidTip=Das aktuelle Zuschneide-Rechteck ist ungültig. Das Overlay ist möglicherweise nicht sichtbar. tstr_OvrlPropsCropX=X tstr_OvrlPropsCropY=Y tstr_OvrlPropsCropWidth=Breite tstr_OvrlPropsCropHeight=Höhe tstr_OvrlPropsCropToWindow=Zum aktiven Fenster zuschneiden tstr_OvrlPropsCaptureMethod=Erfassungsmethode tstr_OvrlPropsCaptureMethodDup=Desktop Duplication tstr_OvrlPropsCaptureMethodGC=Graphics Capture tstr_OvrlPropsCaptureMethodGCUnsupportedTip=Graphics Capture wird von diesem System nicht unterstützt tstr_OvrlPropsCaptureMethodGCUnsupportedPartialTip=Einige Graphics Capture-Funktionen werden von diesem System nicht unterstützt tstr_OvrlPropsCaptureSource=Quelle tstr_OvrlPropsCaptureGCSource=Graphics Capture-Quelle tstr_OvrlPropsCaptureSourceUnknownWarning=Dieses Overlay verwendet eine unbekannte Erfassungsmethode und funktioniert möglicherweise nicht korrekt tstr_OvrlPropsCaptureGCStrictMatching=Verwende strikten Fensterabgleich tstr_OvrlPropsCaptureGCStrictMatchingTip=Erlaube nur exakte Fenstertitel-Übereinstimmungen, wenn dieses Overlay wiederhergestellt wird tstr_OvrlPropsPerfMonDesktopModeTip=Leistungsanzeige-Overlays werden im Desktopmodus nicht aktualisiert tstr_OvrlPropsPerfMonGlobalTip=Diese Einstellungen gelten für alle Leistungsanzeige-Overlays tstr_OvrlPropsPerfMonStyle=Stil tstr_OvrlPropsPerfMonItems=Elemente tstr_OvrlPropsPerfMonStyleMinimal=Minimal tstr_OvrlPropsPerfMonStyleCompact=Kompakt tstr_OvrlPropsPerfMonStyleLarge=Groß tstr_OvrlPropsPerfMonStyleShowWindow=Zeige Fenster tstr_OvrlPropsPerfMonStyleShowTextOutline=Zeige Textkontur tstr_OvrlPropsPerfMonStyleMinimalShowMore=Zeige mehr Elemente tstr_OvrlPropsPerfMonItemCPU=CPU Statistiken tstr_OvrlPropsPerfMonItemGPU=GPU Statistiken tstr_OvrlPropsPerfMonItemGraphs=Kurven tstr_OvrlPropsPerfMonItemFrameStats=Frame-Statistiken tstr_OvrlPropsPerfMonItemTime=Zeit tstr_OvrlPropsPerfMonItemBattery=Akku-Statistiken tstr_OvrlPropsPerfMonItemTrackerBattery=Tracker-Akkulevel tstr_OvrlPropsPerfMonItemViveWirelessTemp=Vive Wireless-Temperatur tstr_OvrlPropsPerfMonResetValues=Kumulative Werte zurücksetzen tstr_OvrlPropsBrowserNotAvailableTip=Die Desktop+ Browser-Komponente ist nicht installiert tstr_OvrlPropsBrowserCloned=Geklonte Ausgabe tstr_OvrlPropsBrowserClonedTip=Dieses Overlay ist ein Klon von "%OVERLAYNAME%".\nÄnderungen an den Browser-Eigenschaften werden auf das Original und alle Overlays welche es klonen angewendet. tstr_OvrlPropsBrowserClonedConvert=Konvertiere zu eigenständigen Overlay tstr_OvrlPropsBrowserURL=URL tstr_OvrlPropsBrowserURLHint=Gebe eine Adresse ein tstr_OvrlPropsBrowserGo=Los tstr_OvrlPropsBrowserRestore=Letzte Eingabe wiederherstellen tstr_OvrlPropsBrowserWidth=Breite tstr_OvrlPropsBrowserHeight=Höhe tstr_OvrlPropsBrowserZoom=Zoom tstr_OvrlPropsBrowserAllowTransparency=Erlaube Transparenz tstr_OvrlPropsBrowserAllowTransparencyTip=Erlaubt Webseiten Transparenz zu nutzen.\nSeiten, die keine Hintergrundfarbe definieren, werden möglicherweise nicht korrekt dargestellt. tstr_OvrlPropsBrowserRecreateContext=Erneuere Browser-Kontext tstr_OvrlPropsBrowserRecreateContextTip=Der Browser-Kontext muss neu erstellt werden um die Änderung anzuwenden.\nDadurch wird die Seite neu geladen und der Navigationsverlauf zurückgesetzt. tstr_OvrlPropsAdvanced3D=3D tstr_OvrlPropsAdvancedHSBS=Halbes Nebeneinander (HSBS) tstr_OvrlPropsAdvancedSBS=Nebeneinander (SBS) tstr_OvrlPropsAdvancedHOU=Halbes Übereinander (HOU) tstr_OvrlPropsAdvancedOU=Übereinander (OU) tstr_OvrlPropsAdvanced3DSwap=Tausche Augen tstr_OvrlPropsAdvancedGazeFade=Gaze Fade tstr_OvrlPropsAdvancedGazeFadeAuto=Automatisch einstellen tstr_OvrlPropsAdvancedGazeFadeDistance=Distanz tstr_OvrlPropsAdvancedGazeFadeDistanceValueInf=Unendlich tstr_OvrlPropsAdvancedGazeFadeSensitivity=Empfindlichkeit tstr_OvrlPropsAdvancedGazeFadeOpacity=Ziel-Deckkraft tstr_OvrlPropsAdvancedInput=Laserpointer-Eingabe tstr_OvrlPropsAdvancedInputInGame=Aktiviere im Spiel tstr_OvrlPropsAdvancedInputFloatingUI=Zeige Floating UI tstr_OvrlPropsAdvancedOverlayTags=Overlay-Tags tstr_OvrlPropsAdvancedOverlayTagsTip=Overlay-Tags können verwendet werden um Overlays als Ziel in Aktionen festzulegen tstr_OvrlPropsPerformanceInvisibleUpdate=Aktualisiere wenn unsichtbar tstr_OvrlPropsPerformanceInvisibleUpdateTip=Aktualisiert das Overlay, auch wenn es aufgrund von Deckkrafts- oder Gaze Fade-Einstellung nicht sichtbar ist.\nHilft Anwendungen von Drittanbietern auf den Overlayinhalt zuzugreifen.\nIn anderen Fällen nicht empfohlen.\nWenn das Overlay manuell oder durch den Anzeigemodus versteckt ist, sind Overlayupdates dennoch pausiert. tstr_OvrlPropsInterfaceOverlayName=Overlayname tstr_OvrlPropsInterfaceOverlayNameAuto=[Automatisch benennen] tstr_OvrlPropsInterfaceActionOrderCustom=Eigene Aktions-Schaltflächen tstr_OvrlPropsInterfaceDesktopButtons=Zeige Desktop-Schaltflächen tstr_OvrlPropsInterfaceExtraButtons=Zeige Zusatz-Schaltflächen ;Overlay Bar tstr_OverlayBarOvrlHide=Verstecken tstr_OverlayBarOvrlShow=Zeigen tstr_OverlayBarOvrlClone=Klonen tstr_OverlayBarOvrlRemove=Entfernen tstr_OverlayBarOvrlRemoveConfirm=Wirklich? tstr_OverlayBarOvrlProperties=Eigenschaften... tstr_OverlayBarOvrlAddWindow=Fenster... tstr_OverlayBarTooltipOvrlAdd=Overlay hinzufügen tstr_OverlayBarTooltipSettings=Einstellungen tstr_OverlayBarTooltipResetHold=Halte um Fensterposition zurückzusetzen... ;Floating UI tstr_FloatingUIHideOverlayTip=Verstecke Overlay tstr_FloatingUIHideOverlayHoldTip=Halte um Overlay zu entfernen... tstr_FloatingUIDragModeEnableTip=Aktiviere Verschiebemodus tstr_FloatingUIDragModeDisableTip=Deaktiviere Verschiebemodus tstr_FloatingUIDragModeHoldLockTip=Halte um Overlayposition zu sperren... tstr_FloatingUIDragModeHoldUnlockTip=Halte um Overlayposition zu entsperren... tstr_FloatingUIWindowAddTip=Füge aktives Fenster als Overlay hinzu tstr_FloatingUIActionBarShowTip=Zeige Aktions-Leiste tstr_FloatingUIActionBarHideTip=Verstecke Aktions-Leiste tstr_FloatingUIBrowserGoBackTip=Zurück zur vorherigen Seite tstr_FloatingUIBrowserGoForwardTip=Weiter zur nächsten Seite tstr_FloatingUIBrowserRefreshTip=Seite aktualisieren tstr_FloatingUIBrowserStopTip=Stoppe Seiten-Ladevorgang tstr_FloatingUIActionBarDesktopNext=Nächster Desktop tstr_FloatingUIActionBarDesktopPrev=Vorheriger Desktop tstr_FloatingUIActionBarEmpty=Keine Aktionen ausgewählt ;Special Actions tstr_ActionNone=[Keine Aktion] tstr_ActionKeyboardShow=Zeige Tastatur tstr_ActionKeyboardHide=Verstecke Tastatur ;Default Actions (translation IDs are matched to Action name string) tstr_DefActionShowKeyboard=Zeige Tastatur tstr_DefActionActiveWindowCrop=Zum aktiven Fenster zuschneiden tstr_DefActionActiveWindowCropLabel=Zum aktiven\nFenster\nzuschneiden tstr_DefActionSwitchTask=Wechsle Task tstr_DefActionToggleOverlays=Overlays umschalten tstr_DefActionToggleOverlaysLabel=Overlays\numschalten tstr_DefActionMiddleMouse=Mittlere Maustaste tstr_DefActionMiddleMouseLabel=Mittlere\nMaustaste tstr_DefActionBackMouse=Maus Zurücktaste tstr_DefActionBackMouseLabel=Maus\nZurücktaste tstr_DefActionReadMe=Öffne LiesMich tstr_DefActionReadMeLabel=Öffne\nLiesMich tstr_DefActionDashboardToggle=SteamVR Dashboard umschalten (Debug Befehl) tstr_DefActionDashboardToggleLabel=Dashboard\numschalten ;Performance Monitor (text space is very limited here, so keep it short or untranslated) tstr_PerformanceMonitorCPU=CPU tstr_PerformanceMonitorGPU=GPU tstr_PerformanceMonitorRAM=RAM: tstr_PerformanceMonitorVRAM=VRAM: tstr_PerformanceMonitorFrameTime=Frame-Zeit: tstr_PerformanceMonitorLoad=Auslastung: tstr_PerformanceMonitorFPS=FPS: tstr_PerformanceMonitorFPSAverage=Durchschnittliche FPS: tstr_PerformanceMonitorReprojectionRatio=Reprojektions-Ratio: tstr_PerformanceMonitorDroppedFrames=Verworfene Frames: tstr_PerformanceMonitorBatteryLeft=Linker Controller: tstr_PerformanceMonitorBatteryRight=Rechter Controller: tstr_PerformanceMonitorBatteryHMD=Headset: tstr_PerformanceMonitorBatteryTracker=Tracker %ID%: tstr_PerformanceMonitorBatteryDisconnected=N/V tstr_PerformanceMonitorViveWirelessTempNotAvailable=N/V tstr_PerformanceMonitorCompactCPU=CPU tstr_PerformanceMonitorCompactGPU=GPU tstr_PerformanceMonitorCompactFPS=FPS tstr_PerformanceMonitorCompactFPSAverage=AVG tstr_PerformanceMonitorCompactReprojectionRatio=% RPR tstr_PerformanceMonitorCompactDroppedFrames=VRW tstr_PerformanceMonitorCompactBattery=BAT tstr_PerformanceMonitorCompactBatteryLeft=L tstr_PerformanceMonitorCompactBatteryRight=R tstr_PerformanceMonitorCompactBatteryHMD=H tstr_PerformanceMonitorCompactBatteryTracker=T%ID% tstr_PerformanceMonitorCompactBatteryDisconnected=N/V tstr_PerformanceMonitorCompactViveWirelessTempNotAvailable=N/V tstr_PerformanceMonitorEmpty=Es sind keine Leistungsanzeige-Elemente aktiviert. ;Aux UI tstr_AuxUIDragHintDocking=Loslassen um anzudocken tstr_AuxUIDragHintUndocking=Loslassen um abzudocken tstr_AuxUIDragHintOvrlLocked=Entsperre die Overlayposition um dieses Overlay zu bewegen tstr_AuxUIDragHintOvrlTheaterScreenBlocked=Die Overlayposition wird von der SteamVR-Kinoleinwand gesteuert tstr_AuxUIGazeFadeAutoHint=Schaue in die Mitte des Overlays und warte für %SECONDS% Sekunden... tstr_AuxUIGazeFadeAutoHintSingular=Schaue in die Mitte des Overlays und warte für %SECONDS% Sekunde... tstr_AuxUIQuickStartWelcomeHeader=Willkommen zu Desktop+! tstr_AuxUIQuickStartWelcomeBody=Diese kurze Einführung wird dich mit den grundlegenden Funktionen der Anwendung bekannt machen.\nAusführlichere Informationen kannst du in der LiesMich und im Benutzerhandbuch finden.\n\nFalls du das hier überspringen möchtest, drücke einfach [Schließen]. tstr_AuxUIQuickStartOverlaysHeader=Overlays tstr_AuxUIQuickStartOverlaysBody=Desktop+ ermöglicht es dir sogenannte Overlays zu erstellen, welche deine Desktops, einzelne Fenster, und mehr spiegeln.\nAlle von dir erstellen Overlays werden unten in der Overlay-Leiste gelistet.\n\nOverlay-Eigenschaften können geändert werden, indem du auf eines der Overlay-Icons klickst und [Eigenschaften...] auswählst. tstr_AuxUIQuickStartOverlaysBody2=Neue Overlays können durch Drücken von [+] und Wahl einer Quelle/Overlay-Art aus der Liste erstellt werden.\nEinige Arten, wie zum Beispiel Webbrowser-Overlays, sind nur verfügbar wenn die entsprechende Anwendungskomponente installiert ist.\n\nEinzelne Overlays oder komplette Layouts können in Profilen gespeichert werden.\nDie aktive Overlaykonfiguration wird automatisch aus der letzten Sitzung wiederhergestellt. tstr_AuxUIQuickStartOverlayPropertiesHeader=Overlay-Eigenschaften tstr_AuxUIQuickStartOverlayPropertiesBody=Overlays haben eine Reihe von Anpassungsmöglichkeiten.\nUrsprung und Einzeigemodus bestimmen wo und wann ein Overlay angezeigt wird.\nBehalte diese Eigenschaften im Auge falls du das Gefühl hast dass ein Overlay sichtbar sein sollte, aber du es nicht finden kannst.\nFalls letzteres nicht ausreicht, könnte ein Zurücksetzen der Position helfen.\n\nDu kannst ein Overlay an einen Bewegungscontroller docken, indem du es in die Nähe des Controllers ziehst. tstr_AuxUIQuickStartOverlayPropertiesBody2=Einige Eigenschaften sind standardmäßig ausgeblendet.\nAktiviere "Zeige erweiterte Einstellungen" im Einstellungsfenster um alle Optionen zu sehen.\n\nDie Positionen von UI-Fenstern können durch längeres Gedrückthalten der zugehörigen Schaltflächen zurückgesetzt werden.\nDoppel- und Rechtsklick können auch auf Overlay-Schaltflächen angewendet werden um Kürzel zu aktivieren. tstr_AuxUIQuickStartSettingsHeader=Einstellungen tstr_AuxUIQuickStartSettingsBody=Das Einstellungsfenster enthält alle globalen Einstellungen für Desktop+.\nEs kann durch Drücken der Zahnrad-Schaltfläche am rechten Ende der Overlay-Leiste geöffnet werden.\n\nWie auch bei Overlays werden Änderungen an den Einstellungen automatisch gespeichert. tstr_AuxUIQuickStartProfilesHeader=Profile tstr_AuxUIQuickStartProfilesBody=Es gibt zwei Arten von Profilen in Desktop+.\n\nOverlay-Profile:\nSpeichern ein oder mehrere Overlays mitsamt ihren Eigenschaften.\nSie können manuell oder durch Aktionen und Anwendungs-Profilen geladen werden.\n\nAnwendungs-Profile:\nWeisen ein Overlay-Profil und/oder Aktionen zu einer SteamVR-Anwendung zu, welche automatisch geladen werden wenn sie gestartet wird. tstr_AuxUIQuickStartActionsHeader=Aktionen tstr_AuxUIQuickStartActionsBody=Aktionen in Desktop+ sind eine Aneinanderreihung von Befehlen, die Controllereingaben und Anwendungs-Profile zugewiesen oder zur Aktions-Leiste von Overlays hinzugefügt werden können. tstr_AuxUIQuickStartActionsBody2=Standardmäßig werden Aktionen auf das Overlay angewendet, auf dem sie aktiviert wurden (für das Overlay gezeigter Aktions-Schaltfläche, Controllereingabe auf dem Overlay), oder auf dem fokussierten Overlay, falls letzteres nicht anwendbar ist.\n\nDas fokussierte Overlay ist das zuletzt geklickte Overlay.\nIn vielen Fällen ist das Ziel-Overlay nicht wichtig, beispielsweise für simulierte Desktop-Eingaben.\nIn anderen Fällen kann es nützlich sein ein anderes Overlay oder auch mehrere als Ziel zu verwenden. tstr_AuxUIQuickStartOverlayTagsHeader=Overlay-Tags tstr_AuxUIQuickStartOverlayTagsBody=Hierfür können Overlay-Tags verwendet werden.\nEs gibt automatische Tags (grün hervorgehoben) und benutzerdefinierte Tags.\nAutomatische Tags werden automatisch basierend auf den Eigenschaften welche sie repräsentieren zugewiesen.\nBenutzerdefinierte Tags können manuell Overlays in den Overlay-Eigenschaften zugewiesen werden.\n\nBeachte dass Aktionen nur indirekt Controllertasten zugewiesen werden können. Die nummerierten Kürzel müssen auch mit einer Controllereingabe in den SteamVR-Controllerzuordnungen verbunden werden. tstr_AuxUIQuickStartSettingsEndBody=Es gibt noch viele weitere Einstellungen.\nHabe keine Angst mit ihnen herumzuexperimentieren.\n\nFalls du doch steckenbleiben solltest, kannst du [Auf Standardeinstellungen zurücksetzen] am unteren Ende des Fensters drücken.\nDu hast die Wahl nur bestimmte Elemente zurückzusetzen. tstr_AuxUIQuickStartFloatingUIHeader=Floating UI tstr_AuxUIQuickStartFloatingUIBody=Die als "Floating UI" bezeichnete Oberfläche ist sichtbar wenn auf ein Overlay gezeigt wird.\nIm Dashboard ist sie permanent sichtbar, solange auf kein anderes Overlay gezeigt wird.\n\nDie Floating UI enthält grundlegende Elemente zum Anpassen des Overlays, wie das Umschalten des Zieh-Modus um das Overlay zu bewegen, sowie einen anpassbaren Bereich für Aktions-Schaltflächen. tstr_AuxUIQuickStartDesktopModeHeader=Desktopmodus tstr_AuxUIQuickStartDesktopModeBody=Desktop+ kann auch in einem Fenster auf dem Desktop konfiguriert werden.\nDies kann für Aufgaben welche häufige Tastatureingaben benötigen oder um Änderungen ohne verbundene Bewegungscontroller vorzunehmen nützlich sein.\nWährend fast alle Funktionen in beiden Modi verfügbar sind, ist der Tastaturlayout-Editor, mit dem die Layouts für die Desktop+ VR-Tastatur anpassen werden können, nur im Desktopmodus zugänglich.\n\nDu kannst ihn im Problembehandlungsabschnitt des Einstellungsfensters oder über das Desktop+-Symbol im Systemtray/Benachrichtigungsbereich aufrufen. tstr_AuxUIQuickStartEndHeader=LiesMich & Benutzerhandbuch tstr_AuxUIQuickStartEndBody=Dies sollte schon ausreichen um mit Desktop+ loszulegen.\n\nFalls du auf Probleme stößt oder nicht weiter kommst, schaue dir auch die LiesMich an. Die Schaltfläche in der Aktions-Leiste wird sie für dich öffnen.\nDetaillierte Erklärungen zu jeder Option und Schritt-für-Schritt-Anleitungen für häufige Nutzungsszenarien findest du im Benutzerhandbuch.\n\nUm diese Einführung erneut anzuzeigen, drücke auf [Kurzanleitung anzeigen] unten rechts auf der "Auf Standardeinstellungen zurücksetzen" Seite. tstr_AuxUIQuickStartButtonNext=Nächste Seite tstr_AuxUIQuickStartButtonPrev=Vorherige Seite tstr_AuxUIQuickStartButtonClose=Schließen ;Desktop Mode tstr_DesktopModeCatTools=Werkzeuge tstr_DesktopModeCatOverlays=Overlays tstr_DesktopModeToolSettings=Einstellungen tstr_DesktopModeToolActions=Aktionen tstr_DesktopModeOverlayListAdd=Overlay hinzufügen tstr_DesktopModePageAddWindowOverlayTitle=Fenster-Overlay hinzufügen tstr_DesktopModePageAddWindowOverlayHeader=Wähle ein Fenster ;Keyboard Editor tstr_KeyboardEditorKeyListTitle=Tastenliste tstr_KeyboardEditorKeyListTabContextReplace=Ersetze Inhalt mit... tstr_KeyboardEditorKeyListTabContextClear=Leere Unterlayout tstr_KeyboardEditorKeyListRow=Reihe %ID% tstr_KeyboardEditorKeyListSpacing=[Abstand] tstr_KeyboardEditorKeyListKeyAdd=Neu tstr_KeyboardEditorKeyListKeyDuplicate=Dupl. tstr_KeyboardEditorKeyListKeyRemove=Entf. tstr_KeyboardEditorKeyPropertiesTitle=Tasten-Eigenschaften tstr_KeyboardEditorKeyPropertiesNoSelection=Keine Taste ausgewählt tstr_KeyboardEditorKeyPropertiesType=Typ tstr_KeyboardEditorKeyPropertiesTypeBlank=Leere Fläche tstr_KeyboardEditorKeyPropertiesTypeVirtualKey=Virtuelle Taste tstr_KeyboardEditorKeyPropertiesTypeVirtualKeyToggle=Virtuelle Taste (Umschalten) tstr_KeyboardEditorKeyPropertiesTypeVirtualKeyIsoEnter=Virtuelle Taste (ISO-Enter) tstr_KeyboardEditorKeyPropertiesTypeString=Zeichenkette tstr_KeyboardEditorKeyPropertiesTypeSublayoutToggle=Unterlayout wechseln tstr_KeyboardEditorKeyPropertiesTypeAction=Aktion tstr_KeyboardEditorKeyPropertiesTypeVirtualKeyIsoEnterTip=Platziere zwei "Virtuelle Taste (ISO-Enter)"-Tasten in aufeinanderfolgenden Reihen um eine ISO-Enter geformte Taste zu erstellen.\nNur eine kombinierte Taste pro Unterlayout. tstr_KeyboardEditorKeyPropertiesTypeStringTip=Verwende den Zeichenketten-Tastentyp für Sonderzeichen und nicht-grundlegende Buchstaben.\nDies erlaubt Desktop+ die korrekte Tastenkombination auf dem echten Tastaturlayout herauszufinden und Anwendungskompatibilität zu erhöhen. tstr_KeyboardEditorKeyPropertiesSize=Größe tstr_KeyboardEditorKeyPropertiesLabel=Beschriftung tstr_KeyboardEditorKeyPropertiesKeyCode=Tastencode tstr_KeyboardEditorKeyPropertiesString=Zeichenkette tstr_KeyboardEditorKeyPropertiesSublayout=Unterlayout tstr_KeyboardEditorKeyPropertiesAction=Aktion tstr_KeyboardEditorKeyPropertiesCluster=Tastengruppe tstr_KeyboardEditorKeyPropertiesClusterTip=Tastengruppen-Zuweisung wird verwendet um ausgewählte Tasten vom Laden auszuschließen.\nUmschließende Leerfläche wird nicht entfernt. Weise Leere Flächen-Tasten den passenden Tastengruppen hinzu um sie korrekt auszuschließen. tstr_KeyboardEditorKeyPropertiesBlockModifiers=Blockiere Modifikatoren tstr_KeyboardEditorKeyPropertiesBlockModifiersTip=Lässt alle Modifikatoren-Tasten los, während diese Taste gedrückt wird tstr_KeyboardEditorKeyPropertiesNoRepeat=Nie wiederholen tstr_KeyboardEditorKeyPropertiesNoRepeatTip=Blockiert Wiederholung von Tasteneingabe, selbst wenn Tastenwiederholung eingeschaltet ist tstr_KeyboardEditorMetadataTitle=Layout-Metadaten tstr_KeyboardEditorMetadataName=Name tstr_KeyboardEditorMetadataAuthor=Autor tstr_KeyboardEditorMetadataHasAltGr=Hat AltGr tstr_KeyboardEditorMetadataHasAltGrTip=Gedrückte rechte Alt-Taste wechselt zum AltGr Unterlayout tstr_KeyboardEditorMetadataClusterPreview=Tastengruppen in der Vorschau: tstr_KeyboardEditorMetadataSave=Speichern... tstr_KeyboardEditorMetadataLoad=Laden... tstr_KeyboardEditorMetadataSavePopupTitle=Speichere Tastaturlayout tstr_KeyboardEditorMetadataSavePopupFilename=Dateiname tstr_KeyboardEditorMetadataSavePopupFilenameBlankTip=Dateiname darf nicht leer sein tstr_KeyboardEditorMetadataSavePopupConfirm=Speichere Layout tstr_KeyboardEditorMetadataSavePopupConfirmError=Speichern des Layouts ist fehlgeschlagen tstr_KeyboardEditorMetadataLoadPopupTitle=Lade Tastaturlayout tstr_KeyboardEditorMetadataLoadPopupConfirm=Lade Layout tstr_KeyboardEditorPreviewTitle=Tastaturvorschau tstr_KeyboardEditorSublayoutBase=Basis tstr_KeyboardEditorSublayoutShift=Shift tstr_KeyboardEditorSublayoutAltGr=AltGr tstr_KeyboardEditorSublayoutAux=Zusatz ;General Dialog Strings tstr_DialogOk=Ok tstr_DialogCancel=Abbrechen tstr_DialogDone=Fertig tstr_DialogUndo=Rückgängig tstr_DialogRedo=Wiederholen tstr_DialogColorPickerHeader=Wähle eine Farbe tstr_DialogColorPickerCurrent=Aktuell tstr_DialogColorPickerOriginal=Original tstr_DialogProfilePickerHeader=Wähle ein Profil tstr_DialogProfilePickerNone=[Kein Profil] tstr_DialogActionPickerHeader=Wähle eine Aktion tstr_DialogActionPickerEmpty=Keine Aktionen verfügbar tstr_DialogIconPickerHeader=Wähle ein Icon tstr_DialogIconPickerHeaderTip=Eigene Icons können als PNG-Dateien zum "images\icons\" Ordner hinzugefügt werden tstr_DialogIconPickerNone=[Kein Icon] tstr_DialogKeyCodePickerHeader=Wähle einen Tastencode tstr_DialogKeyCodePickerHeaderHotkey=Wähle einen Hotkey tstr_DialogKeyCodePickerModifiers=Modifikator tstr_DialogKeyCodePickerKeyCode=Tastencode tstr_DialogKeyCodePickerKeyCodeHint=Filtere Liste tstr_DialogKeyCodePickerKeyCodeNone=[Keine] tstr_DialogKeyCodePickerFromInput=Von Eingabe... tstr_DialogKeyCodePickerFromInputPopup=Drücke eine beliebige Taste (auch Maustasten)... tstr_DialogKeyCodePickerFromInputPopupNoMouse=Drücke eine beliebige Taste... tstr_DialogWindowPickerHeader=Wähle ein Fenster tstr_DialogInputTagsHint=Filtere oder füge neuen Tag hinzu ;Source Strings tstr_SourceDesktopAll=Gesamter Desktop tstr_SourceDesktopID=Desktop %ID% tstr_SourceWinRTNone=[Kein Erfassungsziel] tstr_SourceWinRTUnknown=[Unbekanntes Fenster] tstr_SourceWinRTClosed=[Geschlossen]: tstr_SourcePerformanceMonitor=Leistungsanzeige tstr_SourceBrowser=Browser tstr_SourceBrowserNoPage=[Keine Seite geladen] ;Notification Icon tstr_NotificationIconRestoreVR=VR-Oberfläche wiederherstellen tstr_NotificationIconOpenOnDesktop=Einstellungen auf dem Desktop öffnen tstr_NotificationIconQuit=Beenden ;Notifications tstr_NotificationInitialStartupTitleVR=Ersteinrichtung tstr_NotificationInitialStartupTitleDesktop=Desktop+ Ersteinrichtung tstr_NotificationInitialStartupMessage=Desktop+ wurde zu SteamVR hinzugefügt und startet ab jetzt automatisch wenn SteamVR ausgeführt wird. ;Browser tstr_BrowserErrorPageTitle=Seitenladefehler - Desktop+ tstr_BrowserErrorPageHeading=Die Seite konnte nicht geladen werden tstr_BrowserErrorPageMessage=Beim Laden von %URL% ist ein Fehler aufgetreten: %ERROR% ================================================ FILE: assets/lang/en.ini ================================================ [TranslationInfo] Name=English Locale=en-US ;If this language has issues with the default fonts or their loading order, a different font can be defined here which is then loaded first ;This should be the file name with extension, and is loaded either from the OS fonts folder or the "lang" folder if it's missing from the former PreferredFont= ;Set file name to ISO 639-1 language code for auto-detection support, with ISO 3166-1 region code after an underscore if necessary ;To translate the SteamVR input bindings, add a new localization file to the "input" folder and adjust action_manifest.json [Strings] ;Settings Window tstr_SettingsWindowTitle=Desktop+ Settings tstr_SettingsCatInterface=Interface tstr_SettingsCatEnvironment=Environment tstr_SettingsCatProfiles=Profiles tstr_SettingsCatActions=Actions tstr_SettingsCatKeyboard=Keyboard tstr_SettingsCatMouse=Mouse tstr_SettingsCatLaserPointer=Laser Pointer tstr_SettingsCatWindowOverlays=Window Overlays tstr_SettingsCatBrowser=Browser tstr_SettingsCatPerformance=Performance tstr_SettingsCatVersionInfo=Version Info tstr_SettingsCatWarnings=Warnings tstr_SettingsCatStartup=Startup tstr_SettingsCatTroubleshooting=Troubleshooting tstr_SettingsWarningPrefix=Warning: tstr_SettingsWarningCompositorResolution=SteamVR Compositor resolution is below 100%! This affects overlay rendering quality. tstr_SettingsWarningCompositorQuality=SteamVR Overlay render quality is not set to high! tstr_SettingsWarningProcessElevated=Desktop+ is running with administrative privileges! tstr_SettingsWarningElevatedMode=Elevated mode is active! tstr_SettingsWarningBrowserMissing=Browser overlays are being used, but the Desktop+ Browser component is currently not available. tstr_SettingsWarningBrowserMismatch=The installed Desktop+ Browser component is incompatible with this version of Desktop+! tstr_SettingsWarningElevatedProcessFocus=An elevated process has focus!\nDesktop+ is unable to simulate input right now. tstr_SettingsWarningUIAccessLost=Desktop+ is no longer running with UIAccess privileges! tstr_SettingsWarningOverlayCreationErrorLimit=An overlay creation failed! (Maximum Overlay limit exceeded) tstr_SettingsWarningOverlayCreationErrorOther=An overlay creation failed! (%ERRORNAME%) tstr_SettingsWarningGraphicsCaptureError=An unexpected error occurred in a Graphics Capture thread! (%ERRORCODE%) tstr_SettingsWarningAppProfileActive=The application profile for %APPNAME% has overridden the current overlay layout.\nChanges made to overlays are not saved automatically while it is active. tstr_SettingsWarningConfigMigrated=Configuration and profiles from the previous version of Desktop+ have been migrated into new formats.\nThe original files were not deleted and can still be used with an older version of the application.\nSee [Restore Default Settings] if you wish to start fresh instead. tstr_SettingsWarningMenuDontShowAgain=Don't show this again tstr_SettingsWarningMenuDismiss=Dismiss tstr_SettingsInterfaceLanguage=Language tstr_SettingsInterfaceLanguageCommunity=Community Translation by %AUTHOR% tstr_SettingsInterfaceLanguageIncompleteWarning=Translation may be incomplete tstr_SettingsInterfaceAdvancedSettings=Show Advanced Settings tstr_SettingsInterfaceAdvancedSettingsTip=Show advanced and less commonly used settings tstr_SettingsInterfaceBlankSpaceDrag=Drag Windows when Clicking on Blank Space tstr_SettingsInterfacePersistentUI=Persistent UI tstr_SettingsInterfacePersistentUIManage=Manage tstr_SettingsInterfaceDesktopButtons=Desktop Buttons Listing Style tstr_SettingsInterfaceDesktopButtonsNone=None tstr_SettingsInterfaceDesktopButtonsIndividual=Individual Desktops tstr_SettingsInterfaceDesktopButtonsCycle=Cycle Buttons tstr_SettingsInterfaceDesktopButtonsAddCombined=Add Combined Desktop Button tstr_SettingsInterfacePersistentUIHelp=Desktop+ remembers the state of the interface windows separately for general use (Global) and use within the Desktop+ SteamVR dashboard tab (Desktop+ Tab). tstr_SettingsInterfacePersistentUIHelp2=The following controls can be used to directly manipulate the state of those windows.\nKeep in mind some states may require resetting the position in order to bring the window into a visible spot. tstr_SettingsInterfacePersistentUIWindowsHeader=Windows tstr_SettingsInterfacePersistentUIWindowsSettings=Settings tstr_SettingsInterfacePersistentUIWindowsProperties=Overlay Properties tstr_SettingsInterfacePersistentUIWindowsKeyboard=Desktop+ Keyboard tstr_SettingsInterfacePersistentUIWindowsStateGlobal=Global tstr_SettingsInterfacePersistentUIWindowsStateDashboardTab=Desktop+ Tab tstr_SettingsInterfacePersistentUIWindowsStateVisible=Visible tstr_SettingsInterfacePersistentUIWindowsStatePinned=Pinned tstr_SettingsInterfacePersistentUIWindowsStatePosition=Position tstr_SettingsInterfacePersistentUIWindowsStatePositionReset=Reset tstr_SettingsInterfacePersistentUIWindowsStateSize=Size tstr_SettingsInterfacePersistentUIWindowsStateLaunchRestore=Restore State on Desktop+ Launch tstr_SettingsEnvironmentBackgroundColor=Background Color tstr_SettingsEnvironmentBackgroundColorDispModeNever=Never Visible tstr_SettingsEnvironmentBackgroundColorDispModeDPlusTab=Only Visible in Desktop+ Tab tstr_SettingsEnvironmentBackgroundColorDispModeAlways=Always Visible tstr_SettingsEnvironmentDimInterface=Dim Interface tstr_SettingsEnvironmentDimInterfaceTip=Dims the SteamVR dashboard and Desktop+ interface while the Desktop+ dashboard tab is open tstr_SettingsProfilesOverlays=Overlay Profiles tstr_SettingsProfilesApps=Application Profiles tstr_SettingsProfilesManage=Manage tstr_SettingsProfilesOverlaysHeader=Manage Overlay Profiles tstr_SettingsProfilesOverlaysNameDefault=Default tstr_SettingsProfilesOverlaysNameNew=[New Profile] tstr_SettingsProfilesOverlaysNameNewBase=Profile %ID% tstr_SettingsProfilesOverlaysProfileLoad=Load Profile tstr_SettingsProfilesOverlaysProfileAdd=Add Overlays from Profile tstr_SettingsProfilesOverlaysProfileSave=Save Current Overlays tstr_SettingsProfilesOverlaysProfileDelete=Delete Profile tstr_SettingsProfilesOverlaysProfileDeleteConfirm=Really? tstr_SettingsProfilesOverlaysProfileFailedLoad=Failed to Load Profile tstr_SettingsProfilesOverlaysProfileFailedDelete=Failed to Delete Profile tstr_SettingsProfilesOverlaysProfileAddSelectHeader=Choose Overlays to Add from Profile tstr_SettingsProfilesOverlaysProfileAddSelectEmpty=This profile contains no overlays. tstr_SettingsProfilesOverlaysProfileAddSelectDo=Add Selected Overlays tstr_SettingsProfilesOverlaysProfileAddSelectAll=Select All tstr_SettingsProfilesOverlaysProfileAddSelectNone=Select None tstr_SettingsProfilesOverlaysProfileSaveSelectHeader=Save Current Overlays tstr_SettingsProfilesOverlaysProfileSaveSelectName=Profile Name tstr_SettingsProfilesOverlaysProfileSaveSelectNameErrorBlank=Name cannot be blank tstr_SettingsProfilesOverlaysProfileSaveSelectNameErrorTaken=Name is already in use tstr_SettingsProfilesOverlaysProfileSaveSelectHeaderList=Choose Overlays to Save in Profile tstr_SettingsProfilesOverlaysProfileSaveSelectDo=Save Selected Overlays tstr_SettingsProfilesOverlaysProfileSaveSelectDoFailed=Failed to Save Profile tstr_SettingsProfilesAppsHeader=Manage App Profiles tstr_SettingsProfilesAppsHeaderNoVRTip=Only existing application profiles are listed when Desktop+ isn't running tstr_SettingsProfilesAppsListEmpty=No Applications available tstr_SettingsProfilesAppsProfileHeaderActive=(Currently Active) tstr_SettingsProfilesAppsProfileEnabled=Activate when Application is Running tstr_SettingsProfilesAppsProfileOverlayProfile=Overlay Profile tstr_SettingsProfilesAppsProfileActionEnter=Entry Action tstr_SettingsProfilesAppsProfileActionLeave=Exit Action tstr_SettingsActionsManage=Actions tstr_SettingsActionsManageButton=Manage tstr_SettingsActionsButtonsOrderDefault=Action Buttons (Default) tstr_SettingsActionsButtonsOrderOverlayBar=Action Buttons (Overlay Bar) tstr_SettingsActionsShowBindings=Show Controller Bindings tstr_SettingsActionsActiveShortcuts=Active Controller Buttons tstr_SettingsActionsActiveShortcutsTip=Controller bindings when pointing at an overlay.\nConfigure the VR Dashboard controller bindings to change which buttons these are. tstr_SettingsActionsActiveShortuctsHome="Go Home" tstr_SettingsActionsActiveShortuctsBack="Go Back" tstr_SettingsActionsGlobalShortcuts=Global Controller Buttons tstr_SettingsActionsGlobalShortcutsTip=Controller bindings when the dashboard is closed and not pointing at an overlay.\nConfigure the Desktop+ controller bindings to change which buttons these are. tstr_SettingsActionsGlobalShortcutsEntry=Global Shortcut #%ID% tstr_SettingsActionsGlobalShortcutsAdd=Add Shortcut tstr_SettingsActionsGlobalShortcutsRemove=Remove Last Shortcut tstr_SettingsActionsHotkeys=Hotkeys tstr_SettingsActionsHotkeysTip=System-wide keyboard shortcuts.\nHotkeys block other applications from receiving that input and may not work if the same combination has already been registered elsewhere. tstr_SettingsActionsHotkeysAdd=Add Hotkey tstr_SettingsActionsHotkeysRemove=Remove tstr_SettingsActionsTableHeaderAction=Action tstr_SettingsActionsTableHeaderShortcut=Shortcut tstr_SettingsActionsTableHeaderHotkey=Hotkey tstr_SettingsActionsManageHeader=Manage Actions tstr_SettingsActionsManageCopyUID=Copy UID to Clipboard tstr_SettingsActionsManageNew=New Action... tstr_SettingsActionsManageEdit=Edit Action tstr_SettingsActionsManageDuplicate=Duplicate Action tstr_SettingsActionsManageDelete=Delete Action tstr_SettingsActionsManageDeleteConfirm=Really? tstr_SettingsActionsManageDuplicatedName=%NAME% (Copy) tstr_SettingsActionsEditHeader=Edit Action tstr_SettingsActionsEditName=Name tstr_SettingsActionsEditNameTranslatedTip=This action currently uses a translation string ID as a name to automatically match the chosen application language tstr_SettingsActionsEditTarget=Target tstr_SettingsActionsEditTargetDefault=Default tstr_SettingsActionsEditTargetDefaultTip=Targets the overlay the action was activated on or the focused overlay if the former is not applicable tstr_SettingsActionsEditTargetUseTags=Use Tags tstr_SettingsActionsEditTargetActionTarget=Action Target tstr_SettingsActionsEditHeaderAppearance=Button Appearance tstr_SettingsActionsEditIcon=Icon tstr_SettingsActionsEditLabel=Label tstr_SettingsActionsEditLabelTranslatedTip=This action currently uses a translation string ID as a label to automatically match the chosen application language tstr_SettingsActionsEditHeaderCommands=Commands tstr_SettingsActionsEditNameNew=New Action tstr_SettingsActionsEditCommandAdd=Add Command tstr_SettingsActionsEditCommandDelete=Delete Command tstr_SettingsActionsEditCommandDeleteConfirm=Really? tstr_SettingsActionsEditCommandType=Command Type tstr_SettingsActionsEditCommandTypeNone=None tstr_SettingsActionsEditCommandTypeKey=Press Key tstr_SettingsActionsEditCommandTypeMousePos=Set Mouse Position tstr_SettingsActionsEditCommandTypeString=Type String tstr_SettingsActionsEditCommandTypeLaunchApp=Launch Application tstr_SettingsActionsEditCommandTypeShowKeyboard=Show Keyboard tstr_SettingsActionsEditCommandTypeCropActiveWindow=Crop to Active Window tstr_SettingsActionsEditCommandTypeShowOverlay=Show Overlay tstr_SettingsActionsEditCommandTypeSwitchTask=Switch Task tstr_SettingsActionsEditCommandTypeLoadOverlayProfile=Load Overlay Profile tstr_SettingsActionsEditCommandTypeUnknown=Unknown tstr_SettingsActionsEditCommandVisibilityToggle=Toggle tstr_SettingsActionsEditCommandVisibilityShow=Always Show tstr_SettingsActionsEditCommandVisibilityHide=Always Hide tstr_SettingsActionsEditCommandUndo=Undo on Release tstr_SettingsActionsEditCommandKeyCode=Key Code tstr_SettingsActionsEditCommandKeyToggle=Toggle Key tstr_SettingsActionsEditCommandMouseX=X tstr_SettingsActionsEditCommandMouseY=Y tstr_SettingsActionsEditCommandMouseUseCurrent=Use Current Mouse Position tstr_SettingsActionsEditCommandString=String tstr_SettingsActionsEditCommandPath=Executable Path tstr_SettingsActionsEditCommandPathTip=This can also be a normal file or URL tstr_SettingsActionsEditCommandArgs=Application Arguments tstr_SettingsActionsEditCommandArgsTip=These are passed to the application.\nIf unsure, leave this blank. tstr_SettingsActionsEditCommandVisibility=Visibility tstr_SettingsActionsEditCommandSwitchingMethod=Switching Method tstr_SettingsActionsEditCommandSwitchingMethodSwitcher=Show Task Switcher tstr_SettingsActionsEditCommandSwitchingMethodFocus=Focus Window tstr_SettingsActionsEditCommandWindow=Window tstr_SettingsActionsEditCommandWindowNone=[No Window] tstr_SettingsActionsEditCommandWindowStrictMatchingTip=Only allow exact window title matches when looking for a window to switch to tstr_SettingsActionsEditCommandCursorWarp=Warp Cursor into Window tstr_SettingsActionsEditCommandProfile=Profile tstr_SettingsActionsEditCommandProfileClear=Remove Existing Overlays tstr_SettingsActionsEditCommandDescNone=No Command tstr_SettingsActionsEditCommandDescKey=Press Key "%KEYNAME%" tstr_SettingsActionsEditCommandDescKeyToggle=Toggle Key "%KEYNAME%" tstr_SettingsActionsEditCommandDescMousePos=Set Mouse Position to %X%, %Y% tstr_SettingsActionsEditCommandDescString=Type String "%STRING%" tstr_SettingsActionsEditCommandDescLaunchApp=Launch Application "%APP%" %ARGSOPT% tstr_SettingsActionsEditCommandDescLaunchAppArgsOpt="%ARGS%" tstr_SettingsActionsEditCommandDescKeyboardToggle=Toggle Keyboard tstr_SettingsActionsEditCommandDescKeyboardShow=Show Keyboard tstr_SettingsActionsEditCommandDescKeyboardHide=Hide Keyboard tstr_SettingsActionsEditCommandDescCropWindow=Crop to Active Window tstr_SettingsActionsEditCommandDescOverlayToggle=Toggle Overlay: %TAGS% tstr_SettingsActionsEditCommandDescOverlayShow=Show Overlay: %TAGS% tstr_SettingsActionsEditCommandDescOverlayHide=Hide Overlay: %TAGS% tstr_SettingsActionsEditCommandDescOverlayTargetDefault=[Action Target] tstr_SettingsActionsEditCommandDescSwitchTask=Switch Task tstr_SettingsActionsEditCommandDescSwitchTaskWindow=Switch Task to "%WINDOW%" tstr_SettingsActionsEditCommandDescLoadOverlayProfile=Load Overlay Profile "%PROFILE%" tstr_SettingsActionsEditCommandDescLoadOverlayProfileAdd=Add Overlay Profile "%PROFILE%" tstr_SettingsActionsEditCommandDescUnknown=Unknown Command tstr_SettingsActionsOrderHeader=Change Action Order tstr_SettingsActionsOrderButtonLabel=%COUNT% Actions Selected tstr_SettingsActionsOrderButtonLabelSingular=%COUNT% Action Selected tstr_SettingsActionsOrderNoActions=No Actions Selected tstr_SettingsActionsOrderAdd=Add Actions... tstr_SettingsActionsOrderRemove=Remove Action tstr_SettingsActionsAddSelectorHeader=Choose Actions to Add tstr_SettingsActionsAddSelectorAdd=Add Selected Actions tstr_SettingsKeyboardLayout=Keyboard Layout tstr_SettingsKeyboardSize=Size tstr_SettingsKeyboardBehavior=Behavior tstr_SettingsKeyboardStickyMod=Sticky Modifier Keys tstr_SettingsKeyboardKeyRepeat=Key Repeat tstr_SettingsKeyboardAutoShow=Show Automatically tstr_SettingsKeyboardAutoShowDesktopOnly=Show Automatically tstr_SettingsKeyboardAutoShowDesktop=For Desktop & Window Overlays tstr_SettingsKeyboardAutoShowDesktopTip=Experimental. Does not work with all applications. tstr_SettingsKeyboardAutoShowBrowser=For Browser Overlays tstr_SettingsKeyboardLayoutAuthor=Created by %AUTHOR% tstr_SettingsKeyboardKeyClusters=Key Clusters tstr_SettingsKeyboardKeyClusterBase=Base tstr_SettingsKeyboardKeyClusterFunction=Function tstr_SettingsKeyboardKeyClusterNavigation=Navigation tstr_SettingsKeyboardKeyClusterNumpad=Numpad tstr_SettingsKeyboardKeyClusterExtra=Extra tstr_SettingsKeyboardSwitchToEditor=Switch to Keyboard Layout Editor tstr_SettingsMouseShowCursor=Show Cursor tstr_SettingsMouseShowCursorGCUnsupported=Disabling the cursor for Graphics Capture overlays is not supported on this system tstr_SettingsMouseShowCursorGCActiveWarning=Active Graphics Capture mirrors may stop the cursor from being hidden in Desktop Duplication overlays tstr_SettingsMouseScrollSmooth=Use Smooth Scrolling tstr_SettingsMouseSimulatePen=Simulate as Pen Input tstr_SettingsMouseSimulatePenUnsupported=Pen input simulation is not supported on this system tstr_SettingsMouseAllowLaserPointerOverride=Allow Laser Pointer Override tstr_SettingsMouseAllowLaserPointerOverrideTip=Disables the laser pointer when the physical mouse is moved rapidly.\nClick on an overlay to get the laser pointer back. tstr_SettingsMouseDoubleClickAssist=Double-Click Assistant tstr_SettingsMouseDoubleClickAssistTip=Freezes the mouse cursor for the set duration to ease the input of double-clicks tstr_SettingsMouseDoubleClickAssistTipValueOff=Off tstr_SettingsMouseDoubleClickAssistTipValueAuto=Auto tstr_SettingsMouseSmoothing=Input Smoothing tstr_SettingsMouseSmoothingLevelNone=None tstr_SettingsMouseSmoothingLevelVeryLow=Very Low tstr_SettingsMouseSmoothingLevelLow=Low tstr_SettingsMouseSmoothingLevelMedium=Medium tstr_SettingsMouseSmoothingLevelHigh=High tstr_SettingsMouseSmoothingLevelVeryHigh=Very High tstr_SettingsLaserPointerTip=These settings apply to Desktop+'s laser pointer used when the SteamVR dashboard is closed tstr_SettingsLaserPointerBlockInput=Block Game Input while Active tstr_SettingsLaserPointerAutoToggleDistance=Auto-Activation Max Distance tstr_SettingsLaserPointerAutoToggleDistanceValueOff=Off tstr_SettingsLaserPointerHMDPointer=Gaze-based HMD Pointer tstr_SettingsLaserPointerHMDPointerTableHeaderInputAction=Input Action tstr_SettingsLaserPointerHMDPointerTableHeaderBinding=Keyboard Key tstr_SettingsLaserPointerHMDPointerTableBindingToggle=Toggle Laser Pointer tstr_SettingsLaserPointerHMDPointerTableBindingLeft=Left Mouse Button tstr_SettingsLaserPointerHMDPointerTableBindingRight=Right Mouse Button tstr_SettingsLaserPointerHMDPointerTableBindingMiddle=Middle Mouse Button tstr_SettingsLaserPointerHMDPointerTableBindingDrag=Drag Overlay tstr_SettingsWindowOverlaysAutoFocus=Focus Window when Pointing at Overlay tstr_SettingsWindowOverlaysKeepOnScreen=Keep Window on Screen tstr_SettingsWindowOverlaysKeepOnScreenTip=Automatically move source window inside the screen's work area if its bounds lie outside of it tstr_SettingsWindowOverlaysAutoSizeOverlay=Adjust Overlay Size when Window Resizes tstr_SettingsWindowOverlaysFocusSceneApp=Focus Game when Laser Pointer Leaves Overlay tstr_SettingsWindowOverlaysFocusSceneAppDashboard=Focus Game after Closing Dashboard tstr_SettingsWindowOverlaysOnWindowDrag=On Window Drag tstr_SettingsWindowOverlaysOnWindowDragDoNothing=Do Nothing tstr_SettingsWindowOverlaysOnWindowDragBlock=Block Drag tstr_SettingsWindowOverlaysOnWindowDragOverlay=Drag Overlay tstr_SettingsWindowOverlaysOnCaptureLoss=On Capture Loss tstr_SettingsWindowOverlaysOnCaptureLossTip=Behavior when a window capture gets lost, usually from the target window being closed.\n"Hide Overlay" also shows the overlay again when the capture gets restored. tstr_SettingsWindowOverlaysOnCaptureLossDoNothing=Do Nothing tstr_SettingsWindowOverlaysOnCaptureLossHide=Hide Overlay tstr_SettingsWindowOverlaysOnCaptureLossRemove=Remove Overlay tstr_SettingsBrowserMaxFrameRate=Maximum Frame Rate tstr_SettingsBrowserMaxFrameRateOverrideOff=Global Setting tstr_SettingsBrowserContentBlocker=Content Blocker tstr_SettingsBrowserContentBlockerTip=Add block lists in the Adblock Plus syntax to the "DesktopPlusBrowser\content_block" directory.\nAll lists in the directory will be loaded. tstr_SettingsBrowserContentBlockerListCount=(%LISTCOUNT% Lists Active) tstr_SettingsBrowserContentBlockerListCountSingular=(%LISTCOUNT% List Active) tstr_SettingsPerformanceUpdateLimiter=Limit Updates tstr_SettingsPerformanceUpdateLimiterMode=Update Limiter Mode tstr_SettingsPerformanceUpdateLimiterModeOff=Off tstr_SettingsPerformanceUpdateLimiterModeMS=Frame Time tstr_SettingsPerformanceUpdateLimiterModeFPS=Frame Rate tstr_SettingsPerformanceUpdateLimiterModeOffOverride=Use Global Setting tstr_SettingsPerformanceUpdateLimiterModeMSTip="Frame Time" enforces a minimum interval between overlay updates tstr_SettingsPerformanceUpdateLimiterFPSValue=%FPS% fps tstr_SettingsPerformanceUpdateLimiterOverride=Override Update Limit tstr_SettingsPerformanceUpdateLimiterOverrideTip=When multiple overrides are active, the one resulting in the highest update rate is used tstr_SettingsPerformanceUpdateLimiterModeOverride=Override Update Limiter Mode tstr_SettingsPerformanceRapidUpdates=Reduce Laser Pointer Latency tstr_SettingsPerformanceRapidUpdatesTip=Reduce latency of laser pointer input at the cost of additional CPU load while pointing at an overlay tstr_SettingsPerformanceSingleDesktopMirror=Single Desktop Mirroring tstr_SettingsPerformanceSingleDesktopMirrorTip=Mirror individual desktops when switching to them instead of cropping from the combined desktop.\nWhen this is active, all overlays will be showing the same desktop. tstr_SettingsPerformanceAlternativeCursorRendering=Alternative Cursor Rendering tstr_SettingsPerformanceAlternativeCursorRenderingTip=Use a different method to capture and render the cursor.\nThis can help if there are problems with the default method of capturing the hardware cursor. tstr_SettingsPerformanceUseHDR=HDR Mirroring tstr_SettingsPerformanceUseHDRTip=Mirror desktops and windows using higher bit-depth textures, supporting HDR output. Experimental.\nMay negatively impact performance when not required and increases VRAM usage. tstr_SettingsPerformanceShowFPS=Show FPS in Floating UI tstr_SettingsWarningsHidden=Warnings Hidden: tstr_SettingsWarningsReset=Reset Hidden Warnings tstr_SettingsStartupAutoLaunch=Launch Automatically on SteamVR Startup tstr_SettingsStartupSteamDisable=Disable Steam Integration tstr_SettingsStartupSteamDisableTip=Restarts Desktop+ without Steam when it was launched by it.\nThis disables the permanent in-app status, usage time statistics and other Steam features. tstr_SettingsTroubleshootingRestart=Restart tstr_SettingsTroubleshootingRestartSteam=Restart with Steam tstr_SettingsTroubleshootingRestartDesktop=Restart in Desktop Mode tstr_SettingsTroubleshootingElevatedModeEnter=Enter Elevated Mode tstr_SettingsTroubleshootingElevatedModeLeave=Leave Elevated Mode tstr_SettingsTroubleshootingSettingsReset=Restore Default Settings tstr_SettingsTroubleshootingSettingsResetConfirmDescription=Restoring default settings will reset the selected elements to their default values.\nThis cannot be undone.\n\nReset the following: tstr_SettingsTroubleshootingSettingsResetConfirmButton=Reset Selected Elements tstr_SettingsTroubleshootingSettingsResetConfirmElementOverlays=Current Overlay Setup tstr_SettingsTroubleshootingSettingsResetConfirmElementLegacyFiles=Delete Unused Legacy Configuration & Profile Files tstr_SettingsTroubleshootingSettingsResetShowQuickStart=Show Quick-Start Guide ;Keyboard Window tstr_KeyboardWindowTitle=Desktop+ Keyboard tstr_KeyboardWindowTitleSettings=Desktop+ Keyboard (Settings) tstr_KeyboardWindowTitleOverlay=Desktop+ Keyboard (%OVERLAYNAME%) tstr_KeyboardWindowTitleOverlayUnknown=[Unknown Overlay] ;Keyboard Shortcuts Window tstr_KeyboardShortcutsCut=Cut tstr_KeyboardShortcutsCopy=Copy tstr_KeyboardShortcutsPaste=Paste ;Overlay Properties Window tstr_OvrlPropsCatPosition=Position tstr_OvrlPropsCatAppearance=Appearance tstr_OvrlPropsCatCapture=Capture tstr_OvrlPropsCatPerformanceMonitor=Performance Monitor tstr_OvrlPropsCatBrowser=Browser tstr_OvrlPropsCatAdvanced=Advanced tstr_OvrlPropsCatPerformance=Performance tstr_OvrlPropsCatInterface=Interface tstr_OvrlPropsPositionOrigin=Origin tstr_OvrlPropsPositionOriginRoom=Play Area tstr_OvrlPropsPositionOriginHMDXY=HMD Floor Position tstr_OvrlPropsPositionOriginDashboard=Dashboard tstr_OvrlPropsPositionOriginHMD=HMD tstr_OvrlPropsPositionOriginSeatedSpace=Seated Position tstr_OvrlPropsPositionOriginControllerR=Right Controller tstr_OvrlPropsPositionOriginControllerL=Left Controller tstr_OvrlPropsPositionOriginTheaterScreen=Theater Screen tstr_OvrlPropsPositionOriginTracker1=Tracker #1 tstr_OvrlPropsPositionOriginConfigHMDXYTurning=Turn with HMD tstr_OvrlPropsPositionOriginConfigTheaterScreenEnter=Enter Theater Mode tstr_OvrlPropsPositionOriginConfigTheaterScreenLeave=Leave Theater Mode tstr_OvrlPropsPositionOriginConfigSmoothing=Origin Smoothing tstr_OvrlPropsPositionOriginTheaterScreenTip=Some properties are controlled by the SteamVR Theater Screen tstr_OvrlPropsPositionDispMode=Display Mode tstr_OvrlPropsPositionDispModeAlways=Always tstr_OvrlPropsPositionDispModeDashboard=Only in Dashboard tstr_OvrlPropsPositionDispModeScene=Only In-Game tstr_OvrlPropsPositionDispModeDPlus=Only in Desktop+ Tab tstr_OvrlPropsPositionPos=Position tstr_OvrlPropsPositionPosTip=Position can only be changed or reset while Desktop+ is running tstr_OvrlPropsPositionChange=Change tstr_OvrlPropsPositionReset=Reset tstr_OvrlPropsPositionLock=Lock tstr_OvrlPropsPositionChangeHeader=Change Overlay Position tstr_OvrlPropsPositionChangeHelp=Drag any overlay around to change its position.\nHold right-click for two-handed gesture transform. tstr_OvrlPropsPositionChangeHelpDesktop=Hold down the drag buttons ("D") to move or rotate the overlay with the mouse. tstr_OvrlPropsPositionChangeManualAdjustment=Manual Adjustment tstr_OvrlPropsPositionChangeMove=Move tstr_OvrlPropsPositionChangeRotate=Rotate tstr_OvrlPropsPositionChangeForward=Forward tstr_OvrlPropsPositionChangeBackward=Backward tstr_OvrlPropsPositionChangeRollCW=Roll ⟳ tstr_OvrlPropsPositionChangeRollCCW=Roll ⟲ tstr_OvrlPropsPositionChangeLookAt=To HMD tstr_OvrlPropsPositionChangeDragButton=D tstr_OvrlPropsPositionChangeOffset=Additional Offset tstr_OvrlPropsPositionChangeOffsetUpDown=Up/Down Offset tstr_OvrlPropsPositionChangeOffsetRightLeft=Right/Left Offset tstr_OvrlPropsPositionChangeOffsetForwardBackward=Forward/Backward Offset tstr_OvrlPropsPositionChangeDragSettings=Drag Settings tstr_OvrlPropsPositionChangeDragSettingsAutoDocking=Dock to Controller when Near tstr_OvrlPropsPositionChangeDragSettingsForceDistance=Force Fixed Distance tstr_OvrlPropsPositionChangeDragSettingsForceDistanceShape=Shape tstr_OvrlPropsPositionChangeDragSettingsForceDistanceShapeSphere=Sphere tstr_OvrlPropsPositionChangeDragSettingsForceDistanceShapeCylinder=Cylinder tstr_OvrlPropsPositionChangeDragSettingsForceDistanceAutoCurve=Auto-Curve tstr_OvrlPropsPositionChangeDragSettingsForceDistanceAutoTilt=Auto-Tilt tstr_OvrlPropsPositionChangeDragSettingsSnapPosition=Snap Position tstr_OvrlPropsPositionChangeDragSettingsSnapRotation=Snap Rotation tstr_OvrlPropsPositionChangeDragSettingsSnapRotationPitch=Pitch tstr_OvrlPropsPositionChangeDragSettingsSnapRotationYaw=Yaw tstr_OvrlPropsPositionChangeDragSettingsSnapRotationRoll=Roll tstr_OvrlPropsAppearanceWidth=Width tstr_OvrlPropsAppearanceCurve=Curvature tstr_OvrlPropsAppearanceOpacity=Opacity tstr_OvrlPropsAppearanceBrightness=Brightness tstr_OvrlPropsAppearanceCrop=Crop tstr_OvrlPropsAppearanceCropValueMax=Max tstr_OvrlPropsAppearanceShowBackside=Show Backside tstr_OvrlPropsCrop=Cropping Area tstr_OvrlPropsCropHelp=Drag the rectangle to change the crop.\nUse scroll input or drag the edges to adjust the size of the cropping rectangle. tstr_OvrlPropsCropManualAdjust=Manual Adjustment tstr_OvrlPropsCropInvalidTip=The current cropping rectangle is invalid. The overlay may not be visible as a result. tstr_OvrlPropsCropX=X tstr_OvrlPropsCropY=Y tstr_OvrlPropsCropWidth=Width tstr_OvrlPropsCropHeight=Height tstr_OvrlPropsCropToWindow=Crop to Active Window tstr_OvrlPropsCaptureMethod=Capture Method tstr_OvrlPropsCaptureMethodDup=Desktop Duplication tstr_OvrlPropsCaptureMethodGC=Graphics Capture tstr_OvrlPropsCaptureMethodGCUnsupportedTip=Graphics Capture is not supported on this system tstr_OvrlPropsCaptureMethodGCUnsupportedPartialTip=Some Graphics Capture features are not supported on this system tstr_OvrlPropsCaptureSource=Source tstr_OvrlPropsCaptureGCSource=Graphics Capture Source tstr_OvrlPropsCaptureSourceUnknownWarning=This overlay uses an unknown capture source and may not work correctly tstr_OvrlPropsCaptureGCStrictMatching=Use Strict Window Matching tstr_OvrlPropsCaptureGCStrictMatchingTip=Only allow exact window title matches when restoring this overlay's capture tstr_OvrlPropsPerfMonDesktopModeTip=Performance Monitor overlays do not update in desktop mode tstr_OvrlPropsPerfMonGlobalTip=These settings apply to all Performance Monitor overlays tstr_OvrlPropsPerfMonStyle=Style tstr_OvrlPropsPerfMonItems=Items tstr_OvrlPropsPerfMonStyleMinimal=Minimal tstr_OvrlPropsPerfMonStyleCompact=Compact tstr_OvrlPropsPerfMonStyleLarge=Large tstr_OvrlPropsPerfMonStyleShowWindow=Show Window tstr_OvrlPropsPerfMonStyleShowTextOutline=Show Text Outline tstr_OvrlPropsPerfMonStyleMinimalShowMore=Show More Items tstr_OvrlPropsPerfMonItemCPU=CPU Stats tstr_OvrlPropsPerfMonItemGPU=GPU Stats tstr_OvrlPropsPerfMonItemGraphs=Graphs tstr_OvrlPropsPerfMonItemFrameStats=Frame Stats tstr_OvrlPropsPerfMonItemTime=Time tstr_OvrlPropsPerfMonItemBattery=Battery Stats tstr_OvrlPropsPerfMonItemTrackerBattery=Tracker Battery Levels tstr_OvrlPropsPerfMonItemViveWirelessTemp=Vive Wireless Temperature tstr_OvrlPropsPerfMonResetValues=Reset Cumulative Values tstr_OvrlPropsBrowserNotAvailableTip=Desktop+ Browser component is not installed tstr_OvrlPropsBrowserCloned=Cloned Output tstr_OvrlPropsBrowserClonedTip=This overlay is a clone of "%OVERLAYNAME%".\nChanges done to the Browser properties will apply to the original and all overlays cloning from it. tstr_OvrlPropsBrowserClonedConvert=Convert to Standalone tstr_OvrlPropsBrowserURL=URL tstr_OvrlPropsBrowserURLHint=Enter an Address tstr_OvrlPropsBrowserGo=Go tstr_OvrlPropsBrowserRestore=Restore Last Input tstr_OvrlPropsBrowserWidth=Width tstr_OvrlPropsBrowserHeight=Height tstr_OvrlPropsBrowserZoom=Zoom tstr_OvrlPropsBrowserAllowTransparency=Allow Transparency tstr_OvrlPropsBrowserAllowTransparencyTip=Allows web pages to use transparency.\nSites not defining any background color may not display correctly. tstr_OvrlPropsBrowserRecreateContext=Recreate Browser Context tstr_OvrlPropsBrowserRecreateContextTip=The browser context needs to be recreated to apply the change.\nDoing so will reload the page and clear the navigation history. tstr_OvrlPropsAdvanced3D=3D tstr_OvrlPropsAdvancedHSBS=Half Side-by-Side tstr_OvrlPropsAdvancedSBS=Side-by-Side tstr_OvrlPropsAdvancedHOU=Half Over-Under tstr_OvrlPropsAdvancedOU=Over-Under tstr_OvrlPropsAdvanced3DSwap=Swap Eyes tstr_OvrlPropsAdvancedGazeFade=Gaze Fade tstr_OvrlPropsAdvancedGazeFadeAuto=Auto-Configure tstr_OvrlPropsAdvancedGazeFadeDistance=Distance tstr_OvrlPropsAdvancedGazeFadeDistanceValueInf=Infinite tstr_OvrlPropsAdvancedGazeFadeSensitivity=Sensitivity tstr_OvrlPropsAdvancedGazeFadeOpacity=Target Opacity tstr_OvrlPropsAdvancedInput=Laser Pointer Input tstr_OvrlPropsAdvancedInputInGame=Enable In-Game tstr_OvrlPropsAdvancedInputFloatingUI=Show Floating UI tstr_OvrlPropsAdvancedOverlayTags=Overlay Tags tstr_OvrlPropsAdvancedOverlayTagsTip=Overlay tags are used to target overlays in actions tstr_OvrlPropsPerformanceInvisibleUpdate=Update while Invisible tstr_OvrlPropsPerformanceInvisibleUpdateTip=Update overlay even while invisible from opacity setting or Gaze Fade.\nHelps with third-party applications accessing the overlay's contents.\nNot recommended otherwise.\nUpdates are still suspended if the overlay is hidden manually or by display mode setting. tstr_OvrlPropsInterfaceOverlayName=Overlay Name tstr_OvrlPropsInterfaceOverlayNameAuto=[Name Automatically] tstr_OvrlPropsInterfaceActionOrderCustom=Override Action Buttons tstr_OvrlPropsInterfaceDesktopButtons=Show Desktop Buttons tstr_OvrlPropsInterfaceExtraButtons=Show Extra Buttons ;Overlay Bar tstr_OverlayBarOvrlHide=Hide tstr_OverlayBarOvrlShow=Show tstr_OverlayBarOvrlClone=Clone tstr_OverlayBarOvrlRemove=Remove tstr_OverlayBarOvrlRemoveConfirm=Really? tstr_OverlayBarOvrlProperties=Properties... tstr_OverlayBarOvrlAddWindow=Window... tstr_OverlayBarTooltipOvrlAdd=Add Overlay tstr_OverlayBarTooltipSettings=Settings tstr_OverlayBarTooltipResetHold=Hold to reset window position... ;Floating UI tstr_FloatingUIHideOverlayTip=Hide Overlay tstr_FloatingUIHideOverlayHoldTip=Hold to remove overlay... tstr_FloatingUIDragModeEnableTip=Enable Drag-Mode tstr_FloatingUIDragModeDisableTip=Disable Drag-Mode tstr_FloatingUIDragModeHoldLockTip=Hold to lock overlay position... tstr_FloatingUIDragModeHoldUnlockTip=Hold to unlock overlay position... tstr_FloatingUIWindowAddTip=Add Active Window as Overlay tstr_FloatingUIActionBarShowTip=Show Action-Bar tstr_FloatingUIActionBarHideTip=Hide Action-Bar tstr_FloatingUIBrowserGoBackTip=Go to Previous Page tstr_FloatingUIBrowserGoForwardTip=Go to Next Page tstr_FloatingUIBrowserRefreshTip=Refresh Current Page tstr_FloatingUIBrowserStopTip=Stop Page Load tstr_FloatingUIActionBarDesktopPrev=Previous Desktop tstr_FloatingUIActionBarDesktopNext=Next Desktop tstr_FloatingUIActionBarEmpty=No actions enabled ;Special Actions tstr_ActionNone=[None] tstr_ActionKeyboardShow=Show Keyboard tstr_ActionKeyboardHide=Hide Keyboard ;Default Actions (translation IDs are matched to Action name string) tstr_DefActionShowKeyboard=Show Keyboard tstr_DefActionActiveWindowCrop=Crop to Active Window tstr_DefActionActiveWindowCropLabel=Crop to\nActive\nWindow tstr_DefActionSwitchTask=Switch Task tstr_DefActionToggleOverlays=Toggle Overlays tstr_DefActionToggleOverlaysLabel=Toggle\nOverlays tstr_DefActionMiddleMouse=Middle Mouse Button tstr_DefActionMiddleMouseLabel=Middle\nMouse\nButton tstr_DefActionBackMouse=Back Mouse Button tstr_DefActionBackMouseLabel=Back\nMouse\nButton tstr_DefActionReadMe=Open ReadMe tstr_DefActionReadMeLabel=Open\nReadMe tstr_DefActionDashboardToggle=Toggle SteamVR Dashboard (Debug Command) tstr_DefActionDashboardToggleLabel=Toggle\nDashboard ;Performance Monitor (text space is very limited here, so keep it short or untranslated) tstr_PerformanceMonitorCPU=CPU tstr_PerformanceMonitorGPU=GPU tstr_PerformanceMonitorRAM=RAM: tstr_PerformanceMonitorVRAM=VRAM: tstr_PerformanceMonitorFrameTime=Frame Time: tstr_PerformanceMonitorLoad=Load: tstr_PerformanceMonitorFPS=FPS: tstr_PerformanceMonitorFPSAverage=Average FPS: tstr_PerformanceMonitorReprojectionRatio=Reprojection Ratio: tstr_PerformanceMonitorDroppedFrames=Dropped Frames: tstr_PerformanceMonitorBatteryLeft=Left Controller: tstr_PerformanceMonitorBatteryRight=Right Controller: tstr_PerformanceMonitorBatteryHMD=Headset: tstr_PerformanceMonitorBatteryTracker=Tracker %ID%: tstr_PerformanceMonitorBatteryDisconnected=N/A tstr_PerformanceMonitorViveWirelessTempNotAvailable=N/A tstr_PerformanceMonitorCompactCPU=CPU tstr_PerformanceMonitorCompactGPU=GPU tstr_PerformanceMonitorCompactFPS=FPS tstr_PerformanceMonitorCompactFPSAverage=AVG tstr_PerformanceMonitorCompactReprojectionRatio=% RPR tstr_PerformanceMonitorCompactDroppedFrames=DRP tstr_PerformanceMonitorCompactBattery=BAT tstr_PerformanceMonitorCompactBatteryLeft=L tstr_PerformanceMonitorCompactBatteryRight=R tstr_PerformanceMonitorCompactBatteryHMD=H tstr_PerformanceMonitorCompactBatteryTracker=T%ID% tstr_PerformanceMonitorCompactBatteryDisconnected=N/A tstr_PerformanceMonitorCompactViveWirelessTempNotAvailable=N/A tstr_PerformanceMonitorEmpty=No Performance Monitor Items enabled. ;Aux UI tstr_AuxUIDragHintDocking=Release to dock tstr_AuxUIDragHintUndocking=Release to undock tstr_AuxUIDragHintOvrlLocked=Unlock overlay position to drag this overlay tstr_AuxUIDragHintOvrlTheaterScreenBlocked=The overlay's position is controlled by the SteamVR Theater Screen tstr_AuxUIGazeFadeAutoHint=Look at the center of the overlay and wait for %SECONDS% seconds... tstr_AuxUIGazeFadeAutoHintSingular=Look at the center of the overlay and wait for %SECONDS% second... tstr_AuxUIQuickStartWelcomeHeader=Welcome to Desktop+! tstr_AuxUIQuickStartWelcomeBody=This short guide will introduce you to the very basics of the application.\nFor more detailed information see the ReadMe and User Guide.\n\nIf you wish to skip this, simply press [Close]. tstr_AuxUIQuickStartOverlaysHeader=Overlays tstr_AuxUIQuickStartOverlaysBody=Desktop+ allows you to create overlays mirroring your desktops, individual windows and more.\nAll overlays you've created will be listed in the Overlay Bar down below.\n\nOverlay properties can be modified by clicking on one of the overlay icons and choosing [Properties...]. tstr_AuxUIQuickStartOverlaysBody2=New overlays can be created by pressing [+] and choosing a capture source/overlay type from the list.\nSome types, such as web browser overlays, are only available if the respective application component is installed.\n\nIndividual overlays or complete layouts can be saved in profiles.\nThe current overlay setup will automatically be remembered between sessions. tstr_AuxUIQuickStartOverlayPropertiesHeader=Overlay Properties tstr_AuxUIQuickStartOverlayPropertiesBody=Overlays have a variety of customization options.\nOrigin and display mode set where and when an overlay is displayed.\nRemember to review these properties when you feel an overlay should be visible but you can't find it.\nResetting its position may also help if the former doesn't.\n\nYou can also dock an overlay to motion controllers by dragging it close to one. tstr_AuxUIQuickStartOverlayPropertiesBody2=Some properties are hidden by default.\nToggle "Show Advanced Settings" in the Settings window to show all options.\n\nThe position of UI windows can be reset by long-pressing their respective button.\nDouble- and right-click works on overlay buttons as well, as quick shortcut toggles. tstr_AuxUIQuickStartSettingsHeader=Settings tstr_AuxUIQuickStartSettingsBody=The Settings window contains all global settings for Desktop+.\nIt can be opened by pressing the gear button at the right end of the Overlay Bar.\n\nJust like for overlays, changes to settings are applied and saved automatically. tstr_AuxUIQuickStartProfilesHeader=Profiles tstr_AuxUIQuickStartProfilesBody=There two kinds of profiles in Desktop+.\n\nOverlay Profiles:\nStore one or multiple overlays with their properties.\nThey can be loaded manually or as a result of actions and application profiles.\n\nApplication Profiles:\nAssign an overlay profile and/or actions to be loaded automatically when a SteamVR application is launched. tstr_AuxUIQuickStartActionsHeader=Actions tstr_AuxUIQuickStartActionsBody=Actions in Desktop+ are a series of commands that can be assigned to controller inputs and application profiles, or added to the Action Bar of overlays.\nAction commands range from simulating inputs on the desktop to making changes to the overlay layout.\n External applications can also be launched for advanced use-cases.\n\nDesktop+ comes with a few example actions that you can check out. tstr_AuxUIQuickStartActionsBody2=Actions by default target the overlay that it was activated on (action button displayed for the overlay, controller input on the overlay) or the focused overlay if the former isn't applicable.\n\nThe focused overlay is the overlay that was last clicked into.\nIn many cases the target overlay doesn't matter, such as input simulated on the desktop. In others it may be useful to specify a different target overlay or even multiple. tstr_AuxUIQuickStartOverlayTagsHeader=Overlay Tags tstr_AuxUIQuickStartOverlayTagsBody=Overlay tags can be used for this purpose.\nThere are automatic tags (green label) and user-defined tags.\nAutomatic tags are assigned automatically based on the property they represent.\nUser-defined tags can be assigned manually to overlays in the Overlay Properties window.\n\nNote that actions are only indirectly bound to controller buttons for global shortcuts. The numbered global shortcut also has to be assigned to a controller input via the SteamVR's input binding interface. tstr_AuxUIQuickStartSettingsEndBody=There are many more settings available.\nDon't be afraid to play with the toggles to check them out.\n\nIf you do get stuck, you can press [Restore Default Settings] at the bottom of the window.\nYou get the option to only restore specific elements. tstr_AuxUIQuickStartFloatingUIHeader=Floating UI tstr_AuxUIQuickStartFloatingUIBody=The interface referred to as "Floating UI" is displayed whenever you point at an overlay.\nIn the dashboard it is always visible if no other Overlay is being pointed at.\n\nThe Floating UI contains basic controls for modifying the overlay, such as toggling Drag Mode to allow moving it, as well as a customizable section for action buttons.\n\nDepending on the overlay type there may also be other controls.\nDisplay of those can be toggled for each overlay in the respective overlay properties. tstr_AuxUIQuickStartDesktopModeHeader=Desktop Mode tstr_AuxUIQuickStartDesktopModeBody=Desktop+ can also be configured in a window displayed on the desktop.\nThis can be useful for tasks that require frequent keyboard input or to make changes without motion controllers connected.\n\nWhile almost all functionality is the same in both modes, the Keyboard Layout Editor used to customize layouts for the Desktop+ VR keyboard is only accessible in desktop mode.\n\nYou can switch to it in the Troubleshooting section of the Settings window, or from the Desktop+ icon in the system tray/notification area. tstr_AuxUIQuickStartEndHeader=ReadMe & User Guide tstr_AuxUIQuickStartEndBody=This should already be enough to get you started with Desktop+.\n\nIf you run into any trouble or get stuck, make sure to check out the ReadMe as well. The button in the Action Bar will open it for you.\nDetailed explanations of each option and step-by-step guides for common usage scenarios can be found the in the user guide.\n\nTo see this guide again, press [Show Quick-Start Guide] at the bottom right of the "Restore Default Settings" page. tstr_AuxUIQuickStartButtonNext=Next Page tstr_AuxUIQuickStartButtonPrev=Previous Page tstr_AuxUIQuickStartButtonClose=Close ;Desktop Mode tstr_DesktopModeCatTools=Tools tstr_DesktopModeCatOverlays=Overlays tstr_DesktopModeToolSettings=Settings tstr_DesktopModeToolActions=Actions tstr_DesktopModeOverlayListAdd=Add Overlay tstr_DesktopModePageAddWindowOverlayTitle=Add Window Overlay tstr_DesktopModePageAddWindowOverlayHeader=Choose a Window ;Keyboard Editor tstr_KeyboardEditorKeyListTitle=Key List tstr_KeyboardEditorKeyListTabContextReplace=Replace Contents With... tstr_KeyboardEditorKeyListTabContextClear=Clear Sub-Layout tstr_KeyboardEditorKeyListRow=Row %ID% tstr_KeyboardEditorKeyListSpacing=[Spacing] tstr_KeyboardEditorKeyListKeyAdd=Add tstr_KeyboardEditorKeyListKeyDuplicate=Duplicate tstr_KeyboardEditorKeyListKeyRemove=Remove tstr_KeyboardEditorKeyPropertiesTitle=Key Properties tstr_KeyboardEditorKeyPropertiesNoSelection=No Key Selected tstr_KeyboardEditorKeyPropertiesType=Type tstr_KeyboardEditorKeyPropertiesTypeBlank=Blank Space tstr_KeyboardEditorKeyPropertiesTypeVirtualKey=Virtual Key tstr_KeyboardEditorKeyPropertiesTypeVirtualKeyToggle=Virtual Key (Toggle) tstr_KeyboardEditorKeyPropertiesTypeVirtualKeyIsoEnter=Virtual Key (ISO-Enter) tstr_KeyboardEditorKeyPropertiesTypeString=String tstr_KeyboardEditorKeyPropertiesTypeSublayoutToggle=Toggle Sub-Layout tstr_KeyboardEditorKeyPropertiesTypeAction=Action tstr_KeyboardEditorKeyPropertiesTypeVirtualKeyIsoEnterTip=Use two "Virtual Key (ISO-Enter)" keys in adjacent rows to build an ISO-Enter shaped key.\nOnly one combined key in each sublayout. tstr_KeyboardEditorKeyPropertiesTypeStringTip=Use string type for non-basic character keys.\nThis allows Desktop+ to figure out the correct key combination on the real keyboard layout to increase application compatibility. tstr_KeyboardEditorKeyPropertiesSize=Size tstr_KeyboardEditorKeyPropertiesLabel=Label tstr_KeyboardEditorKeyPropertiesKeyCode=Key Code tstr_KeyboardEditorKeyPropertiesString=String tstr_KeyboardEditorKeyPropertiesSublayout=Sub-Layout tstr_KeyboardEditorKeyPropertiesAction=Action tstr_KeyboardEditorKeyPropertiesCluster=Cluster tstr_KeyboardEditorKeyPropertiesClusterTip=Cluster assignment is used to selectively disable loading of keys.\nSurrounding blank space is not removed. Carefully assign blank space type keys to clusters in order to have them toggle correctly. tstr_KeyboardEditorKeyPropertiesBlockModifiers=Block Modifiers tstr_KeyboardEditorKeyPropertiesBlockModifiersTip=Releases all modifier keys while the key is pressed tstr_KeyboardEditorKeyPropertiesNoRepeat=Never Repeat tstr_KeyboardEditorKeyPropertiesNoRepeatTip=Block key input from repeating while holding down, even if key repeat is enabled tstr_KeyboardEditorMetadataTitle=Layout Metadata tstr_KeyboardEditorMetadataName=Name tstr_KeyboardEditorMetadataAuthor=Author tstr_KeyboardEditorMetadataHasAltGr=Has AltGr tstr_KeyboardEditorMetadataHasAltGrTip=Right alt key switches to AltGr sub-layout when down tstr_KeyboardEditorMetadataClusterPreview=Preview Clusters: tstr_KeyboardEditorMetadataSave=Save... tstr_KeyboardEditorMetadataLoad=Load... tstr_KeyboardEditorMetadataSavePopupTitle=Save Keyboard Layout tstr_KeyboardEditorMetadataSavePopupFilename=File Name tstr_KeyboardEditorMetadataSavePopupFilenameBlankTip=File name must not be blank tstr_KeyboardEditorMetadataSavePopupConfirm=Save Layout tstr_KeyboardEditorMetadataSavePopupConfirmError=Failed to save the layout tstr_KeyboardEditorMetadataLoadPopupTitle=Load Keyboard Layout tstr_KeyboardEditorMetadataLoadPopupConfirm=Load Layout tstr_KeyboardEditorPreviewTitle=Keyboard Preview tstr_KeyboardEditorSublayoutBase=Base tstr_KeyboardEditorSublayoutShift=Shift tstr_KeyboardEditorSublayoutAltGr=AltGr tstr_KeyboardEditorSublayoutAux=Aux ;General Dialog Strings tstr_DialogOk=Ok tstr_DialogCancel=Cancel tstr_DialogDone=Done tstr_DialogUndo=Undo tstr_DialogRedo=Redo tstr_DialogColorPickerHeader=Pick a Color tstr_DialogColorPickerCurrent=Current tstr_DialogColorPickerOriginal=Original tstr_DialogProfilePickerHeader=Pick a Profile tstr_DialogProfilePickerNone=[None] tstr_DialogActionPickerHeader=Pick an Action tstr_DialogActionPickerEmpty=No actions available tstr_DialogIconPickerHeader=Pick an Icon tstr_DialogIconPickerHeaderTip=Custom icons can be added as PNG files in the "images\icons\" directory tstr_DialogIconPickerNone=[No Icon] tstr_DialogKeyCodePickerHeader=Pick a Key Code tstr_DialogKeyCodePickerHeaderHotkey=Pick a Hotkey tstr_DialogKeyCodePickerModifiers=Modifiers tstr_DialogKeyCodePickerKeyCode=Key Code tstr_DialogKeyCodePickerKeyCodeHint=Filter List tstr_DialogKeyCodePickerKeyCodeNone=[None] tstr_DialogKeyCodePickerFromInput=From Input... tstr_DialogKeyCodePickerFromInputPopup=Press any key or mouse button... tstr_DialogKeyCodePickerFromInputPopupNoMouse=Press any key... tstr_DialogWindowPickerHeader=Pick a Window tstr_DialogInputTagsHint=Filter or add new tag ;Source Strings tstr_SourceDesktopAll=Combined Desktop tstr_SourceDesktopID=Desktop %ID% tstr_SourceWinRTNone=[No Capture Target] tstr_SourceWinRTUnknown=[Unknown Window] tstr_SourceWinRTClosed=[Closed]: tstr_SourcePerformanceMonitor=Performance Monitor tstr_SourceBrowser=Browser tstr_SourceBrowserNoPage=[No Page Loaded] ;Notification Icon tstr_NotificationIconRestoreVR=Restore VR Interface tstr_NotificationIconOpenOnDesktop=Open Settings on Desktop tstr_NotificationIconQuit=Quit ;Notifications tstr_NotificationInitialStartupTitleVR=Initial Setup tstr_NotificationInitialStartupTitleDesktop=Desktop+ Initial Setup tstr_NotificationInitialStartupMessage=Desktop+ has been successfully added to SteamVR and will now automatically launch when SteamVR is run. ;Browser tstr_BrowserErrorPageTitle=Page Load Error - Desktop+ tstr_BrowserErrorPageHeading=The page could not be loaded tstr_BrowserErrorPageMessage=There was an error trying to load %URL%: %ERROR% ================================================ FILE: assets/lang/ja.ini ================================================ [TranslationInfo] Name=日本語 (Japanese) Author=まるまさ Locale=ja-JP [Strings] ;Settings Window tstr_SettingsWindowTitle=Desktop+ 設定 tstr_SettingsCatInterface=インターフェイス tstr_SettingsCatEnvironment=システム構成 tstr_SettingsCatProfiles=プロファイル tstr_SettingsCatActions=アクション tstr_SettingsCatKeyboard=キーボード tstr_SettingsCatMouse=マウス tstr_SettingsCatLaserPointer=レーザーポインター tstr_SettingsCatWindowOverlays=画面のオーバーレイ tstr_SettingsCatBrowser=ブラウザ tstr_SettingsCatPerformance=パフォーマンス tstr_SettingsCatVersionInfo=バージョン情報 tstr_SettingsCatWarnings=警告 tstr_SettingsCatStartup=スタートアップ tstr_SettingsCatTroubleshooting=トラブルシューティング tstr_SettingsWarningPrefix=警告: tstr_SettingsWarningCompositorResolution=SteamVR の内部解像度が100%を下回っています! これはオーバーレイのレンダリング品質に影響します。 tstr_SettingsWarningCompositorQuality=SteamVR オーバーレイのレンダリング品質が高くありません! tstr_SettingsWarningProcessElevated=Desktop+ は管理者権限で実行されています! tstr_SettingsWarningElevatedMode=管理者モードが有効です! tstr_SettingsWarningBrowserMissing=ブラウザオーバーレイが使用されていますが、Desktop+ ブラウザコンポーネントは現在使用できません。 tstr_SettingsWarningBrowserMismatch=インストールされている Desktop+ ブラウザは、このバージョンの Desktop+ と互換性がありません! tstr_SettingsWarningElevatedProcessFocus=管理者プロセスがフォーカスされています!\nDesktop+ は現在、入力のシミュレーションができません。 tstr_SettingsWarningUIAccessLost=Desktop+ がUIアクセス権限で実行されなくなりました! tstr_SettingsWarningOverlayCreationErrorLimit=オーバーレイの作成に失敗しました! (オーバーレイの上限を超えました) tstr_SettingsWarningOverlayCreationErrorOther=オーバーレイの作成に失敗しました! (%ERRORNAME%) tstr_SettingsWarningGraphicsCaptureError=グラフィックキャプチャースレッドで予期しないエラーが発生しました! (%ERRORCODE%) tstr_SettingsWarningAppProfileActive=%APPNAME% のアプリケーションプロファイルが、現在のオーバーレイのレイアウトを上書きしました。\nオーバーレイに加えられた内容は、それが無効になるまで自動では保存されません。 tstr_SettingsWarningConfigMigrated=以前のバージョンの Desktop+ の設定とプロファイルは新しい形式に移行されました。\n元のファイルは削除されていないため、アプリケーションの古いバージョンでも引き続き使用できます。\n最初からやり直す場合は、[初期設定に戻す] を参照してください。 tstr_SettingsWarningMenuDontShowAgain=次回から表示しない tstr_SettingsWarningMenuDismiss=閉じる tstr_SettingsInterfaceLanguage=言語 tstr_SettingsInterfaceLanguageCommunity=%AUTHOR% によるコミュニティ翻訳 tstr_SettingsInterfaceLanguageIncompleteWarning=翻訳が不正確な場合があります tstr_SettingsInterfaceAdvancedSettings=詳細設定を表示 tstr_SettingsInterfaceAdvancedSettingsTip=高度な設定とあまり使用されない設定 tstr_SettingsInterfaceBlankSpaceDrag=空白スペースをクリックするとウィンドウがドラッグ tstr_SettingsInterfacePersistentUI=永続的なUI tstr_SettingsInterfacePersistentUIManage=管理 tstr_SettingsInterfaceDesktopButtons=デスクトップボタンのスタイル tstr_SettingsInterfaceDesktopButtonsNone=なし tstr_SettingsInterfaceDesktopButtonsIndividual=個別 tstr_SettingsInterfaceDesktopButtonsCycle=サイクルボタン tstr_SettingsInterfaceDesktopButtonsAddCombined=複合デスクトップ追加ボタン tstr_SettingsInterfacePersistentUIHelp=Desktop+ は、一般用 (グローバル) と、Desktop+ SteamVR ダッシュボードタブ (Desktop+ タブ) 内での使用に分けて、インターフェイスのウィンドウの状態を記憶します。 tstr_SettingsInterfacePersistentUIHelp2=コントローラーを使って、ウィンドウの状態を直接操作することができます。\n場合によっては、ウィンドウを表示可能な場所まで移動させるために、位置をリセットする必要があることに注意してください。 tstr_SettingsInterfacePersistentUIWindowsHeader=ウィンドウズ tstr_SettingsInterfacePersistentUIWindowsSettings=設定 tstr_SettingsInterfacePersistentUIWindowsProperties=オーバーレイのプロパティ tstr_SettingsInterfacePersistentUIWindowsKeyboard=Desktop+ キーボード tstr_SettingsInterfacePersistentUIWindowsStateGlobal=グローバル tstr_SettingsInterfacePersistentUIWindowsStateDashboardTab=Desktop+ タブ tstr_SettingsInterfacePersistentUIWindowsStateVisible=表示 tstr_SettingsInterfacePersistentUIWindowsStatePinned=ピン留め tstr_SettingsInterfacePersistentUIWindowsStatePosition=位置 tstr_SettingsInterfacePersistentUIWindowsStatePositionReset=リセット tstr_SettingsInterfacePersistentUIWindowsStateSize=大きさ tstr_SettingsInterfacePersistentUIWindowsStateLaunchRestore=Desktop+ の起動時の状態を復元 tstr_SettingsEnvironmentBackgroundColor=背景の色 tstr_SettingsEnvironmentBackgroundColorDispModeNever=常に非表示 tstr_SettingsEnvironmentBackgroundColorDispModeDPlusTab=Desktop+ タブでのみ表示 tstr_SettingsEnvironmentBackgroundColorDispModeAlways=常に表示 tstr_SettingsEnvironmentDimInterface=インターフェイスを暗くする tstr_SettingsEnvironmentDimInterfaceTip=Desktop+ のダッシュボードタブを開いている間、SteamVR のダッシュボードと Desktop+ のインターフェイスを暗くします。 tstr_SettingsProfilesOverlays=オーバーレイのプロファイル tstr_SettingsProfilesApps=アプリケーションプロファイル tstr_SettingsProfilesManage=管理 tstr_SettingsProfilesOverlaysHeader=オーバーレイのプロファイルの管理 tstr_SettingsProfilesOverlaysNameDefault=初期設定 tstr_SettingsProfilesOverlaysNameNew=[新規プロファイル] tstr_SettingsProfilesOverlaysNameNewBase=プロファイル %ID% tstr_SettingsProfilesOverlaysProfileLoad=プロファイル読み込み tstr_SettingsProfilesOverlaysProfileAdd=プロファイル追加 tstr_SettingsProfilesOverlaysProfileSave=現在のオーバーレイを保存 tstr_SettingsProfilesOverlaysProfileDelete=プロファイル削除 tstr_SettingsProfilesOverlaysProfileDeleteConfirm=本当にいい? tstr_SettingsProfilesOverlaysProfileFailedLoad=プロファイルの読み込みに失敗しました tstr_SettingsProfilesOverlaysProfileFailedDelete=プロファイルの削除に失敗しました tstr_SettingsProfilesOverlaysProfileAddSelectHeader=プロファイル tstr_SettingsProfilesOverlaysProfileAddSelectEmpty=このプロファイルにはオーバーレイが含まれていません。 tstr_SettingsProfilesOverlaysProfileAddSelectDo=選択したオーバーレイを追加する tstr_SettingsProfilesOverlaysProfileAddSelectAll=すべて選択 tstr_SettingsProfilesOverlaysProfileAddSelectNone=選択解除 tstr_SettingsProfilesOverlaysProfileSaveSelectHeader=現在のオーバーレイを保存する tstr_SettingsProfilesOverlaysProfileSaveSelectName=プロファイル名 tstr_SettingsProfilesOverlaysProfileSaveSelectNameErrorBlank=名前を空白にすることはできません tstr_SettingsProfilesOverlaysProfileSaveSelectNameErrorTaken=その名前は既に使用されています tstr_SettingsProfilesOverlaysProfileSaveSelectHeaderList=プロファイルに保存するオーバーレイを選択してください tstr_SettingsProfilesOverlaysProfileSaveSelectDo=選択したオーバーレイを保存 tstr_SettingsProfilesOverlaysProfileSaveSelectDoFailed=プロファイルを保存できませんでした tstr_SettingsProfilesAppsHeader=アプリケーションプロファイルの管理 tstr_SettingsProfilesAppsHeaderNoVRTip=Desktop+ が実行されていない場合は、既存のアプリケーションプロファイルのみがリストされます。 tstr_SettingsProfilesAppsListEmpty=利用可能なアプリケーションはありません tstr_SettingsProfilesAppsProfileHeaderActive=(実行中) tstr_SettingsProfilesAppsProfileEnabled=アプリケーションの実行中にアクティブ化する tstr_SettingsProfilesAppsProfileOverlayProfile=オーバーレイプロファイル tstr_SettingsProfilesAppsProfileActionEnter=アクションを開始 tstr_SettingsProfilesAppsProfileActionLeave=アクションを終了 tstr_SettingsActionsManage=アクション tstr_SettingsActionsManageButton=管理 tstr_SettingsActionsButtonsOrderDefault=アクションボタン (初期設定) tstr_SettingsActionsButtonsOrderOverlayBar=アクションボタン (オーバーレイのバー) tstr_SettingsActionsShowBindings=コントローラーのボタン設定を表示 tstr_SettingsActionsActiveShortcuts=アクティブコントローラーボタン tstr_SettingsActionsActiveShortcutsTip=オーバーレイを選択しているときのコントローラーバインディング。\nコントローラーのバインドを設定して VR ダッシュボードで、どのボタンになるかを変更します。 tstr_SettingsActionsActiveShortuctsHome="ホームに行く" tstr_SettingsActionsActiveShortuctsBack="戻る" tstr_SettingsActionsGlobalShortcuts=グローバル コントローラーボタン tstr_SettingsActionsGlobalShortcutsTip=ダッシュボードが閉じられ、オーバーレイを選択していないときのコントローラーバインディング。\nコントローラーのバインドを設定して Desktop+ が、どのボタンになるかを変更します。 tstr_SettingsActionsGlobalShortcutsEntry=グローバル ショートカット #%ID% tstr_SettingsActionsGlobalShortcutsAdd=ショートカット追加 tstr_SettingsActionsGlobalShortcutsRemove=最後の ショートカット 削除 tstr_SettingsActionsHotkeys=ホットキー tstr_SettingsActionsHotkeysTip=システム全体のキーボード ショートカット。\nホットキーは、他のアプリケーションがその入力をブロックするため、同じ組み合わせがすでに別の場所に登録されている場合は機能しない場合があります。 tstr_SettingsActionsHotkeysAdd=ホットキー追加 tstr_SettingsActionsHotkeysRemove=削除 tstr_SettingsActionsTableHeaderAction=アクション tstr_SettingsActionsTableHeaderShortcut=ショートカット tstr_SettingsActionsTableHeaderHotkey=ホットキー tstr_SettingsActionsManageHeader=アクションの管理 tstr_SettingsActionsManageCopyUID=UIDをコピー tstr_SettingsActionsManageNew=新規アクション... tstr_SettingsActionsManageEdit=アクションを編集 tstr_SettingsActionsManageDuplicate=アクションを複製 tstr_SettingsActionsManageDelete=アクションを削除 tstr_SettingsActionsManageDeleteConfirm=本当にいいですか? tstr_SettingsActionsManageDuplicatedName=%NAME% (コピー) tstr_SettingsActionsEditHeader=アクションを編集 tstr_SettingsActionsEditName=名前 tstr_SettingsActionsEditNameTranslatedTip=このアクションは現在、翻訳文字列IDを名前として使い、選択されたアプリケーション言語に自動的にマッチします。 tstr_SettingsActionsEditTarget=ターゲット tstr_SettingsActionsEditTargetDefault=初期設定 tstr_SettingsActionsEditTargetDefaultTip=アクションが有効化されたオーバレイ、または前者が適用されない場合はフォーカスされたオーバレイを対象とする tstr_SettingsActionsEditTargetUseTags=タグを使用する tstr_SettingsActionsEditTargetActionTarget=アクション ターゲット tstr_SettingsActionsEditHeaderAppearance=ボタンの外観 tstr_SettingsActionsEditIcon=アイコン tstr_SettingsActionsEditLabel=ラベル tstr_SettingsActionsEditLabelTranslatedTip=このアクションは現在、翻訳文字列IDをラベルとして使用し、選択されたアプリケーション言語に自動的にマッチします。 tstr_SettingsActionsEditHeaderCommands=コマンド tstr_SettingsActionsEditNameNew=新規アクション tstr_SettingsActionsEditCommandAdd=コマンド追加 tstr_SettingsActionsEditCommandDelete=コマンド削除 tstr_SettingsActionsEditCommandDeleteConfirm=本当にいいですか? tstr_SettingsActionsEditCommandType=コマンド タイプ tstr_SettingsActionsEditCommandTypeNone=なし tstr_SettingsActionsEditCommandTypeKey=キーを押す tstr_SettingsActionsEditCommandTypeMousePos=マウスの位置を設定 tstr_SettingsActionsEditCommandTypeString=文字を入力 tstr_SettingsActionsEditCommandTypeLaunchApp=アプリを起動 tstr_SettingsActionsEditCommandTypeShowKeyboard=キーボード 表示 tstr_SettingsActionsEditCommandTypeCropActiveWindow=アクティブなウィンドウをクロップ tstr_SettingsActionsEditCommandTypeShowOverlay=オーバーレイ 表示 tstr_SettingsActionsEditCommandTypeSwitchTask=タスク切り替え tstr_SettingsActionsEditCommandTypeLoadOverlayProfile=オーバーレイプロファイルを読み込む tstr_SettingsActionsEditCommandTypeUnknown=不明 tstr_SettingsActionsEditCommandVisibilityToggle=切り替え tstr_SettingsActionsEditCommandVisibilityShow=常に表示 tstr_SettingsActionsEditCommandVisibilityHide=常に非表示 tstr_SettingsActionsEditCommandUndo=元に戻す tstr_SettingsActionsEditCommandKeyCode=コピーボタン tstr_SettingsActionsEditCommandKeyToggle=キー 切り替え tstr_SettingsActionsEditCommandMouseX=X tstr_SettingsActionsEditCommandMouseY=Y tstr_SettingsActionsEditCommandMouseUseCurrent=マウスカーソルの位置を使う tstr_SettingsActionsEditCommandString=文字 tstr_SettingsActionsEditCommandPath=実行可能なパス tstr_SettingsActionsEditCommandPathTip=これは通常のファイルやURLでも可能です。 tstr_SettingsActionsEditCommandArgs=アプリケーションの引数 tstr_SettingsActionsEditCommandArgsTip=これらの引数はアプリケーションに渡されます。\n分からない場合は空欄のままにしてください。 tstr_SettingsActionsEditCommandVisibility=表示する tstr_SettingsActionsEditCommandSwitchingMethod=スイッチング方式 tstr_SettingsActionsEditCommandSwitchingMethodSwitcher=タスクスイッチャーを表示 tstr_SettingsActionsEditCommandSwitchingMethodFocus=フォーカスウィンドウ tstr_SettingsActionsEditCommandWindow=ウィンドウ tstr_SettingsActionsEditCommandWindowNone=[ウィンドウなし] tstr_SettingsActionsEditCommandWindowStrictMatchingTip=切り替え先のウィンドウを探すときに、ウィンドウのタイトルの正確な一致のみを許可する tstr_SettingsActionsEditCommandCursorWarp=カーソルをウィンドウ内にワープ tstr_SettingsActionsEditCommandProfile=プロフィール tstr_SettingsActionsEditCommandProfileClear=既存のオーバーレイを削除する tstr_SettingsActionsEditCommandDescNone=No コマンド tstr_SettingsActionsEditCommandDescKey=キーを押す "%KEYNAME%" tstr_SettingsActionsEditCommandDescKeyToggle=キー 切り替え "%KEYNAME%" tstr_SettingsActionsEditCommandDescMousePos=マウスの位置を %X%, %Y% に設定 tstr_SettingsActionsEditCommandDescString=文字を入力 "%STRING%" tstr_SettingsActionsEditCommandDescLaunchApp=アプリを起動 "%APP%" %ARGSOPT% tstr_SettingsActionsEditCommandDescLaunchAppArgsOpt="%ARGS%" tstr_SettingsActionsEditCommandDescKeyboardToggle=切り替え キーボード tstr_SettingsActionsEditCommandDescKeyboardShow=キーボード表示 tstr_SettingsActionsEditCommandDescKeyboardHide=キーボード非表示 tstr_SettingsActionsEditCommandDescCropWindow=アクティブなウィンドウをクロップ tstr_SettingsActionsEditCommandDescOverlayToggle=オーバーレイ切り替え: %TAGS% tstr_SettingsActionsEditCommandDescOverlayShow=オーバーレイ表示: %TAGS% tstr_SettingsActionsEditCommandDescOverlayHide=オーバーレイ非表示: %TAGS% tstr_SettingsActionsEditCommandDescOverlayTargetDefault=[アクション ターゲット] tstr_SettingsActionsEditCommandDescSwitchTask=タスク切り替え tstr_SettingsActionsEditCommandDescSwitchTaskWindow=タスクを "%WINDOW%" に切り替える tstr_SettingsActionsEditCommandDescLoadOverlayProfile=オーバーレイプロファイル "%PROFILE%" を読み込む tstr_SettingsActionsEditCommandDescLoadOverlayProfileAdd=オーバーレイプロファイル "%PROFILE%" を追加する tstr_SettingsActionsEditCommandDescUnknown=コマンドが不明です tstr_SettingsActionsOrderHeader=アクション変更オーダー tstr_SettingsActionsOrderButtonLabel=%COUNT% アクション選択中 tstr_SettingsActionsOrderButtonLabelSingular=%COUNT% 選択中 tstr_SettingsActionsOrderNoActions=アクションが選択されていません tstr_SettingsActionsOrderAdd=アクション追加... tstr_SettingsActionsOrderRemove=アクション削除 tstr_SettingsActionsAddSelectorHeader=追加するアクションを選んでください tstr_SettingsActionsAddSelectorAdd=選択したアクションを追加 tstr_SettingsKeyboardLayout=キーボード レイアウト tstr_SettingsKeyboardSize=大きさ tstr_SettingsKeyboardBehavior=動作 tstr_SettingsKeyboardStickyMod=スティキー修飾キー tstr_SettingsKeyboardKeyRepeat=キー置き換え tstr_SettingsKeyboardAutoShow=自動で表示 tstr_SettingsKeyboardAutoShowDesktopOnly=デスクトップのみ自動で表示 tstr_SettingsKeyboardAutoShowDesktop=デスクトップ と ウィンドウオーバーレイ tstr_SettingsKeyboardAutoShowDesktopTip=実験的。すべてのアプリケーションで動作するわけではありません。 tstr_SettingsKeyboardAutoShowBrowser=ブラウザオーバーレイ tstr_SettingsKeyboardLayoutAuthor=%AUTHOR% によって作成されました tstr_SettingsKeyboardKeyClusters=キー tstr_SettingsKeyboardKeyClusterBase=Base tstr_SettingsKeyboardKeyClusterFunction=Function tstr_SettingsKeyboardKeyClusterNavigation=Navigation tstr_SettingsKeyboardKeyClusterNumpad=Numpad tstr_SettingsKeyboardKeyClusterExtra=Extra tstr_SettingsKeyboardSwitchToEditor=キーボードレイアウトエディターに切り替える tstr_SettingsMouseShowCursor=マウスカーソル表示 tstr_SettingsMouseShowCursorGCUnsupported=このシステムでは、グラフィックスキャプチャのオーバーレイのカーソルを無効にすることはサポートされていません tstr_SettingsMouseShowCursorGCActiveWarning=アクティブ グラフィックス キャプチャ ミラーにより、デスクトップ複製オーバーレイでカーソルが非表示にならなくなる場合があります tstr_SettingsMouseScrollSmooth=スムーズスクロール有効 tstr_SettingsMouseSimulatePen=ペン入力としてシミュレート tstr_SettingsMouseSimulatePenUnsupported=このシステムではペン入力シミュレーションはサポートされていません tstr_SettingsMouseAllowLaserPointerOverride=レーザーポインター オーバーライドを有効 tstr_SettingsMouseAllowLaserPointerOverrideTip=オーバーレイをクリックするとレーザーポインターが戻ります。 tstr_SettingsMouseDoubleClickAssist=ダブルクリック アシスタント tstr_SettingsMouseDoubleClickAssistTip=ダブルクリックの入力を容易にするために、マウスカーソルを設定した時間だけ停止させる。 tstr_SettingsMouseDoubleClickAssistTipValueOff=オフ tstr_SettingsMouseDoubleClickAssistTipValueAuto=自動 tstr_SettingsMouseSmoothing=スムーズな入力 tstr_SettingsMouseSmoothingLevelNone=なし tstr_SettingsMouseSmoothingLevelVeryLow=最小 tstr_SettingsMouseSmoothingLevelLow=小 tstr_SettingsMouseSmoothingLevelMedium=中 tstr_SettingsMouseSmoothingLevelHigh=高 tstr_SettingsMouseSmoothingLevelVeryHigh=最高 tstr_SettingsLaserPointerTip=これらの設定は、SteamVR ダッシュボードが閉じているときに使用される Desktop+ のレーザー ポインターに適用されます。 tstr_SettingsLaserPointerBlockInput=アクティブ中にゲームの入力をブロックする tstr_SettingsLaserPointerAutoToggleDistance=自動アクティベーション 最大距離 tstr_SettingsLaserPointerAutoToggleDistanceValueOff=オフ tstr_SettingsLaserPointerHMDPointer=視線ベースのHMDのポインター tstr_SettingsLaserPointerHMDPointerTableHeaderInputAction=入力アクション tstr_SettingsLaserPointerHMDPointerTableHeaderBinding=キーボードのキー tstr_SettingsLaserPointerHMDPointerTableBindingToggle=レーザーポインターを切り替える tstr_SettingsLaserPointerHMDPointerTableBindingLeft=左クリック tstr_SettingsLaserPointerHMDPointerTableBindingRight=右クリック tstr_SettingsLaserPointerHMDPointerTableBindingMiddle=ホイールクリック tstr_SettingsWindowOverlaysAutoFocus=オーバーレイをポイントしたときのフォーカスウィンドウ tstr_SettingsWindowOverlaysKeepOnScreen=ウィンドウをスクリーンのままにする tstr_SettingsWindowOverlaysKeepOnScreenTip=ソースウィンドウの境界が画面の描画領域の外にある場合、ソースウィンドウを自動的に移動します。 tstr_SettingsWindowOverlaysAutoSizeOverlay=ウィンドウのサイズ変更時にオーバーレイのサイズを調整する tstr_SettingsWindowOverlaysFocusSceneApp=レーザーポインターがオーバーレイから離れると、ゲームに焦点を合わせる tstr_SettingsWindowOverlaysFocusSceneAppDashboard=ゲームを終了したらダッシュボードを閉じる tstr_SettingsWindowOverlaysOnWindowDrag=ウィンドウドラッグ時 tstr_SettingsWindowOverlaysOnWindowDragDoNothing=何もしない tstr_SettingsWindowOverlaysOnWindowDragBlock=ドラッグをブロック tstr_SettingsWindowOverlaysOnWindowDragOverlay=ドラッグオーバーレイ tstr_SettingsWindowOverlaysOnCaptureLoss=キャプチャーのロスについて tstr_SettingsWindowOverlaysOnCaptureLossTip=ウィンドウキャプチャが失われたときの動作。通常はターゲットウィンドウが閉じられることによって失われる。\nまた、"オーバーレイ非表示" は、キャプチャが見つかったときにオーバーレイを再び表示します。 tstr_SettingsWindowOverlaysOnCaptureLossDoNothing=何もしない tstr_SettingsWindowOverlaysOnCaptureLossHide=オーバーレイ非表示 tstr_SettingsWindowOverlaysOnCaptureLossRemove=オーバーレイ削除 tstr_SettingsBrowserMaxFrameRate=最大フレームレート tstr_SettingsBrowserMaxFrameRateOverrideOff=グローバル設定 tstr_SettingsBrowserContentBlocker=コンテンツブロッカー tstr_SettingsBrowserContentBlockerTip=Adblock Plus構文のブロックリストを "DesktopPlusBrowser\content_block" ディレクトリに追加します。\nディレクトリ内のすべてのリストが読み込まれます。 tstr_SettingsBrowserContentBlockerListCount=(%LISTCOUNT% 実行中リスト) tstr_SettingsBrowserContentBlockerListCountSingular=(%LISTCOUNT% 実行中リスト) tstr_SettingsPerformanceUpdateLimiter=フレームリミッター tstr_SettingsPerformanceUpdateLimiterMode=フレームリミッターモード tstr_SettingsPerformanceUpdateLimiterModeOff=オフ tstr_SettingsPerformanceUpdateLimiterModeMS=フレームタイム tstr_SettingsPerformanceUpdateLimiterModeFPS=フレームレート tstr_SettingsPerformanceUpdateLimiterModeOffOverride=グローバル設定を使う tstr_SettingsPerformanceUpdateLimiterModeMSTip=強制的にオーバーレイの毎フレームの最小間隔を制御します tstr_SettingsPerformanceUpdateLimiterFPSValue=%FPS% fps tstr_SettingsPerformanceUpdateLimiterOverride=オーバーレイフレーム上限 tstr_SettingsPerformanceUpdateLimiterOverrideTip=複数のオーバーライドが有効な場合、更新レートが最も高いものが使用されます。 tstr_SettingsPerformanceUpdateLimiterModeOverride=オーバーレイ更新上限モード tstr_SettingsPerformanceRapidUpdates=レーザー ポインターの遅延を短縮する tstr_SettingsPerformanceRapidUpdatesTip=オーバーレイをポイントするときに CPU 負荷を上げて、レーザー ポインター入力の遅延を短縮します。 tstr_SettingsPerformanceSingleDesktopMirror=単一デスクトップのミラーリング tstr_SettingsPerformanceSingleDesktopMirrorTip=デスクトップ切り替え時に、結合されたデスクトップから切り取るのではなく、別々にデスクトップをミラーリングします。\nこれが有効な場合、すべてのオーバーレイは同じデスクトップを表示します。 tstr_SettingsPerformanceShowFPS=フローティング UI で FPS を表示 tstr_SettingsWarningsHidden=警告非表示: tstr_SettingsWarningsReset=警告非表示リセット tstr_SettingsStartupAutoLaunch=自動で起動する tstr_SettingsStartupSteamDisable=Steamの起動 無効 tstr_SettingsStartupSteamDisableTip=Steamで起動した場合、SteamなしでDesktop+を起動する。\nこれにより、アプリ内のステータス、使用時間の統計、その他のSteamの機能が無効になります。 tstr_SettingsTroubleshootingRestart=再起動 tstr_SettingsTroubleshootingRestartSteam=Steam再起動 tstr_SettingsTroubleshootingRestartDesktop=デスクトップモードで再起動 tstr_SettingsTroubleshootingElevatedModeEnter=管理者モード 有効 tstr_SettingsTroubleshootingElevatedModeLeave=管理者モード 無効 tstr_SettingsTroubleshootingSettingsReset=初期設定に戻す tstr_SettingsTroubleshootingSettingsResetConfirmDescription=デフォルト設定を復元すると、選択した要素がデフォルト値にリセットされます。\nこれは、元に戻すことはできません。\n\nリセットする値: tstr_SettingsTroubleshootingSettingsResetConfirmButton=選択している項目をリセット tstr_SettingsTroubleshootingSettingsResetConfirmElementOverlays=現在のオーバーレイのセットアップ tstr_SettingsTroubleshootingSettingsResetConfirmElementLegacyFiles=使用されていない古い構成とプロファイルファイルを削除する tstr_SettingsTroubleshootingSettingsResetShowQuickStart=クイックスタートガイドを表示 ;Keyboard Window tstr_KeyboardWindowTitle=Desktop+ キーボード tstr_KeyboardWindowTitleSettings=Desktop+ キーボード (設定) tstr_KeyboardWindowTitleOverlay=Desktop+ キーボード (%OVERLAYNAME%) tstr_KeyboardWindowTitleOverlayUnknown=[不明なオーバーレイ] ;Keyboard Shortcuts Window tstr_KeyboardShortcutsCut=切り取り tstr_KeyboardShortcutsCopy=コピー tstr_KeyboardShortcutsPaste=貼り付け ;Overlay Properties Window tstr_OvrlPropsCatPosition=位置 tstr_OvrlPropsCatAppearance=外観 tstr_OvrlPropsCatCapture=キャプチャー tstr_OvrlPropsCatPerformanceMonitor=プリファレンス モニター tstr_OvrlPropsCatBrowser=ブラウザ tstr_OvrlPropsCatAdvanced=実績 tstr_OvrlPropsCatPerformance=パフォーマンス tstr_OvrlPropsCatInterface=インターフェイス tstr_OvrlPropsPositionOrigin=原点 tstr_OvrlPropsPositionOriginRoom=プレイエリア tstr_OvrlPropsPositionOriginHMDXY=HMDの床の位置 tstr_OvrlPropsPositionOriginDashboard=ダッシュボード tstr_OvrlPropsPositionOriginHMD=HMD tstr_OvrlPropsPositionOriginSeatedSpace=座っている位置 tstr_OvrlPropsPositionOriginControllerR=右コントローラー tstr_OvrlPropsPositionOriginControllerL=左コントローラー tstr_OvrlPropsPositionOriginTheaterScreen=シアタースクリーン tstr_OvrlPropsPositionOriginTracker1=トラッカー #1 tstr_OvrlPropsPositionOriginConfigHMDXYTurning=HMDの向きに追従 tstr_OvrlPropsPositionOriginConfigTheaterScreenEnter=シアターモード オン tstr_OvrlPropsPositionOriginConfigTheaterScreenLeave=シアターモード オフ tstr_OvrlPropsPositionOriginTheaterScreenTip=一部のプロパティは SteamVR シアタースクリーン によって制御されます tstr_OvrlPropsPositionDispMode=ディスプレイモード tstr_OvrlPropsPositionDispModeAlways=常に表示 tstr_OvrlPropsPositionDispModeDashboard=ダッシュボード中のみ tstr_OvrlPropsPositionDispModeScene=ゲーム中のみ tstr_OvrlPropsPositionDispModeDPlus=Desktop+ タブ内のみ tstr_OvrlPropsPositionPos=位置 tstr_OvrlPropsPositionPosTip=位置は、Desktop+ の実行中にのみ変更またはリセットできます。 tstr_OvrlPropsPositionChange=変更 tstr_OvrlPropsPositionReset=リセット tstr_OvrlPropsPositionLock=ロック tstr_OvrlPropsPositionChangeHeader=オーバーレイの位置を変更 tstr_OvrlPropsPositionChangeHelp=任意のオーバーレイをドラッグして位置を変更します。\n両手で位置を変更するには、右クリックを押したままにします。 tstr_OvrlPropsPositionChangeHelpDesktop=ドラッグボタン（"D"）を押しながらマウスでオーバーレイを移動または回転させる。 tstr_OvrlPropsPositionChangeManualAdjustment=手動で調整 tstr_OvrlPropsPositionChangeMove=移動 tstr_OvrlPropsPositionChangeRotate=回転 tstr_OvrlPropsPositionChangeForward=手前に移動 tstr_OvrlPropsPositionChangeBackward=奥に移動 tstr_OvrlPropsPositionChangeRollCW=ロール ⟳ tstr_OvrlPropsPositionChangeRollCCW=ロール ⟲ tstr_OvrlPropsPositionChangeLookAt=HMDを向く tstr_OvrlPropsPositionChangeDragButton=D tstr_OvrlPropsPositionChangeOffset=追加のオフセット tstr_OvrlPropsPositionChangeOffsetUpDown=上/下 オフセット tstr_OvrlPropsPositionChangeOffsetRightLeft=右/左 オフセット tstr_OvrlPropsPositionChangeOffsetForwardBackward=前/後 オフセット tstr_OvrlPropsPositionChangeDragSettings=ドラッグ設定 tstr_OvrlPropsPositionChangeDragSettingsAutoDocking=近くのコントローラーにドッキング tstr_OvrlPropsPositionChangeDragSettingsForceDistance=フォースの距離 固定 tstr_OvrlPropsPositionChangeDragSettingsForceDistanceShape=シャープ tstr_OvrlPropsPositionChangeDragSettingsForceDistanceShapeSphere=球体 tstr_OvrlPropsPositionChangeDragSettingsForceDistanceShapeCylinder=シリンダー tstr_OvrlPropsPositionChangeDragSettingsForceDistanceAutoCurve=自動-湾曲 tstr_OvrlPropsPositionChangeDragSettingsForceDistanceAutoTilt=自動-角度 tstr_OvrlPropsPositionChangeDragSettingsSnapPosition=スナップ位置 tstr_OvrlPropsAppearanceWidth=横 tstr_OvrlPropsAppearanceCurve=曲率 tstr_OvrlPropsAppearanceOpacity=不透明度 tstr_OvrlPropsAppearanceBrightness=明るさ tstr_OvrlPropsAppearanceCrop=クロップ tstr_OvrlPropsAppearanceCropValueMax=最大 tstr_OvrlPropsCrop=エリアをクロップ中 tstr_OvrlPropsCropHelp=長方形をドラッグしてクロップを変更します。スクロールするか、端をドラッグして、長方形のサイズを調整します。 tstr_OvrlPropsCropManualAdjust=手動で調整 tstr_OvrlPropsCropInvalidTip=現在の四角形のクロップは無効です。オーバーレイが見えなくなる場合があります。 tstr_OvrlPropsCropX=X tstr_OvrlPropsCropY=Y tstr_OvrlPropsCropWidth=横 tstr_OvrlPropsCropHeight=縦 tstr_OvrlPropsCropToWindow=選択しているウィンドウをクロップ tstr_OvrlPropsCaptureMethod=キャプチャー方法 tstr_OvrlPropsCaptureMethodDup=デスクトップ tstr_OvrlPropsCaptureMethodGC=グラフィック tstr_OvrlPropsCaptureMethodGCUnsupportedTip=このシステムではグラフィックキャプチャーはサポートされていません tstr_OvrlPropsCaptureMethodGCUnsupportedPartialTip=一部のグラフィックキャプチャー機能はこのシステムではサポートされていません tstr_OvrlPropsCaptureSource=ソース tstr_OvrlPropsCaptureGCSource=グラフィックキャプチャーソース tstr_OvrlPropsCaptureSourceUnknownWarning=このオーバーレイは不明なキャプチャ ソースを使用しているため、正しく動作しない可能性があります tstr_OvrlPropsCaptureGCStrictMatching=厳密なウィンドウ マッチングを使用する tstr_OvrlPropsCaptureGCStrictMatchingTip=このオーバーレイのキャプチャを復元するとき、ウィンドウのタイトル名が完全に一致したウィンドウのみキャプチャーします tstr_OvrlPropsPerfMonDesktopModeTip=パフォーマンス モニターのオーバーレイがデスクトップ モードでは更新されません tstr_OvrlPropsPerfMonGlobalTip=これらの設定は、すべてのパフォーマンス モニター オーバーレイに適用されます tstr_OvrlPropsPerfMonStyle=スタイル tstr_OvrlPropsPerfMonStyleCompact=コンパクト tstr_OvrlPropsPerfMonStyleLarge=ラージ tstr_OvrlPropsPerfMonShowCPU=CPUの状態を表示 tstr_OvrlPropsPerfMonShowGPU=GPUの状態を表示 tstr_OvrlPropsPerfMonShowGraphs=グラフィックを表示 tstr_OvrlPropsPerfMonShowFrameStats=FPSを表示 tstr_OvrlPropsPerfMonShowTime=時計を表示 tstr_OvrlPropsPerfMonShowBattery=バッテリーの状態を表示 tstr_OvrlPropsPerfMonShowTrackerBattery=トラッカーのバッテリーを表示 tstr_OvrlPropsPerfMonShowViveWirelessTemp=Vive ワイヤレス温度を表示 tstr_OvrlPropsPerfMonResetValues=累積値 復元 tstr_OvrlPropsBrowserNotAvailableTip=Desktop+ ブラウザコンポーネントがインストールされていません tstr_OvrlPropsBrowserCloned=クローン化された出力 tstr_OvrlPropsBrowserClonedTip=このオーバーレイは "%OVERLAYNAME%" のクローンです。\nブラウザのプロパティの変更内容は、元のブラウザとそこから複製されたすべてのオーバーレイに適用されます。 tstr_OvrlPropsBrowserClonedConvert=スタンドアローンに変換中 tstr_OvrlPropsBrowserURL=URL tstr_OvrlPropsBrowserURLHint=URLを入力してください... tstr_OvrlPropsBrowserGo=決定 tstr_OvrlPropsBrowserRestore=戻る tstr_OvrlPropsBrowserWidth=横 tstr_OvrlPropsBrowserHeight=縦 tstr_OvrlPropsBrowserZoom=ズーム tstr_OvrlPropsBrowserAllowTransparency=透過を有効にする tstr_OvrlPropsBrowserAllowTransparencyTip=Web ページで透明度の変更を許可します。\n背景色が設定されていないサイトでは正しく表示されない可能性があります。 tstr_OvrlPropsBrowserRecreateContext=ブラウザの環境を再生成する tstr_OvrlPropsBrowserRecreateContextTip=変更を適用するには、ブラウザの環境を再生成する必要があります。\nこれを実行すると、ページがリロードされ、履歴がリセットされます。 tstr_OvrlPropsAdvanced3D=3D tstr_OvrlPropsAdvancedHSBS=半分に並べる tstr_OvrlPropsAdvancedSBS=並べる tstr_OvrlPropsAdvancedHOU=半分以下 tstr_OvrlPropsAdvancedOU=以下 tstr_OvrlPropsAdvanced3DSwap=左右を交換 tstr_OvrlPropsAdvancedGazeFade=注視フェード tstr_OvrlPropsAdvancedGazeFadeAuto=自動構成 tstr_OvrlPropsAdvancedGazeFadeDistance=距離 tstr_OvrlPropsAdvancedGazeFadeDistanceValueInf=無制限 tstr_OvrlPropsAdvancedGazeFadeSensitivity=感度 tstr_OvrlPropsAdvancedGazeFadeOpacity=ターゲットの不透明度 tstr_OvrlPropsAdvancedInput=レーザーポインターの入力 tstr_OvrlPropsAdvancedInputInGame=ゲーム中 有効 tstr_OvrlPropsAdvancedInputFloatingUI=フローティング UI を表示中 tstr_OvrlPropsAdvancedOverlayTags=オーバーレイタグ tstr_OvrlPropsAdvancedOverlayTagsTip=オーバーレイタグは、アクション内のオーバーレイをターゲットにするために使用されます tstr_OvrlPropsPerformanceInvisibleUpdate=常に更新 tstr_OvrlPropsPerformanceInvisibleUpdateTip=不透明度設定や視線フェードで非表示になっている場合でも、オーバーレイを更新します。\nサードパーティ製のアプリがオーバーレイの内容を取得するのに役立ちます。\nそれ以外の場合は推奨しません。\nオーバーレイが手動または表示モード設定で非表示の場合でも、更新は一時停止しています。 tstr_OvrlPropsInterfaceOverlayName=オーバーレイの名前 tstr_OvrlPropsInterfaceOverlayNameAuto=[自動] tstr_OvrlPropsInterfaceActionOrderCustom=アクションボタンを上書きする tstr_OvrlPropsInterfaceDesktopButtons=デスクトップボタン表示 tstr_OvrlPropsInterfaceExtraButtons=追加ボタンを表示 ;Overlay Bar tstr_OverlayBarOvrlHide=非表示 tstr_OverlayBarOvrlShow=表示 tstr_OverlayBarOvrlClone=複製 tstr_OverlayBarOvrlRemove=削除 tstr_OverlayBarOvrlRemoveConfirm=本当にいい? tstr_OverlayBarOvrlProperties=プロパティ... tstr_OverlayBarOvrlAddWindow=ウィンドウ... tstr_OverlayBarTooltipOvrlAdd=オーバーレイ追加 tstr_OverlayBarTooltipSettings=設定 tstr_OverlayBarTooltipResetHold=ホールドしたウィンドウの位置をリセット... ;Floating UI tstr_FloatingUIHideOverlayTip=オーバーレイ 非表示 tstr_FloatingUIHideOverlayHoldTip=長押しでオーバーレイを削除... tstr_FloatingUIDragModeEnableTip=ドラッグモード 有効 tstr_FloatingUIDragModeDisableTip=ドラッグモード 無効 tstr_FloatingUIDragModeHoldLockTip=長押しで位置を固定する... tstr_FloatingUIDragModeHoldUnlockTip=長押しで位置の固定を解除する... tstr_FloatingUIWindowAddTip=アクティブウィンドウをオーバーレイに追加 tstr_FloatingUIActionBarShowTip=アクションバー 表示 tstr_FloatingUIActionBarHideTip=アクションバー 非表示 tstr_FloatingUIBrowserGoBackTip=Previous ページに行く tstr_FloatingUIBrowserGoForwardTip=次のページに行く tstr_FloatingUIBrowserRefreshTip=現在のページをリフレッシュ tstr_FloatingUIBrowserStopTip=ページの読み込みを停止 tstr_FloatingUIActionBarDesktopPrev=前のデスクトップ tstr_FloatingUIActionBarDesktopNext=次のデスクトップ tstr_FloatingUIActionBarEmpty=有効なアクションはありません ;Special Actions tstr_ActionNone=[なし] tstr_ActionKeyboardShow=キーボード 表示 tstr_ActionKeyboardHide=キーボード 非表示 ;Default Actions (translation IDs are matched to Action name string) tstr_DefActionShowKeyboard=キーボード 表示 tstr_DefActionActiveWindowCrop=選択しているウィンドウをトリミング tstr_DefActionActiveWindowCropLabel=トリミング\n選択している\nウィンドウ tstr_DefActionSwitchTask=タスク切り替え tstr_DefActionToggleOverlays=オーバーレイ 切り替え tstr_DefActionToggleOverlaysLabel=オーバーレイ\n切り替え tstr_DefActionMiddleMouse=マウスボタン 中心 tstr_DefActionMiddleMouseLabel=中心\nマウス\nボタン tstr_DefActionBackMouse=マウスボタン 戻る tstr_DefActionBackMouseLabel=戻る\nマウス\nボタン tstr_DefActionReadMe=説明書を開く tstr_DefActionReadMeLabel=説明書\n開く tstr_DefActionDashboardToggle=SteamVR ダッシュボードの切り替え (デバッグ コマンド) tstr_DefActionDashboardToggleLabel=ダッシュボード\n切り替え ;Performance Monitor (text space is very limited here, so keep it short or untranslated) tstr_PerformanceMonitorCPU=CPU tstr_PerformanceMonitorGPU=GPU tstr_PerformanceMonitorRAM=RAM: tstr_PerformanceMonitorVRAM=VRAM: tstr_PerformanceMonitorFrameTime=フレームタイム: tstr_PerformanceMonitorLoad=負荷: tstr_PerformanceMonitorFPS=FPS: tstr_PerformanceMonitorFPSAverage=平均 FPS: tstr_PerformanceMonitorReprojectionRatio=再投影率: tstr_PerformanceMonitorDroppedFrames=ドロップされたフレーム: tstr_PerformanceMonitorBatteryLeft=左コントローラー: tstr_PerformanceMonitorBatteryRight=右コントローラー: tstr_PerformanceMonitorBatteryHMD=ヘッドセット: tstr_PerformanceMonitorBatteryTracker=トラッカー %ID%: tstr_PerformanceMonitorBatteryDisconnected=N/A tstr_PerformanceMonitorViveWirelessTempNotAvailable=N/A tstr_PerformanceMonitorCompactCPU=CPU tstr_PerformanceMonitorCompactGPU=GPU tstr_PerformanceMonitorCompactFPS=FPS tstr_PerformanceMonitorCompactFPSAverage=AVG tstr_PerformanceMonitorCompactReprojectionRatio=% RPR tstr_PerformanceMonitorCompactDroppedFrames=DRP tstr_PerformanceMonitorCompactBattery=BAT tstr_PerformanceMonitorCompactBatteryLeft=L tstr_PerformanceMonitorCompactBatteryRight=R tstr_PerformanceMonitorCompactBatteryHMD=H tstr_PerformanceMonitorCompactBatteryTracker=T%ID% tstr_PerformanceMonitorCompactBatteryDisconnected=N/A tstr_PerformanceMonitorCompactViveWirelessTempNotAvailable=N/A tstr_PerformanceMonitorEmpty=パフォーマンスモニターの項目が空です。 ;Aux UI tstr_AuxUIDragHintDocking=追従させる tstr_AuxUIDragHintUndocking=追従を解除 tstr_AuxUIDragHintOvrlLocked=オーバーレイの位置のロックを解除して、このオーバーレイをドラッグします tstr_AuxUIDragHintOvrlTheaterScreenBlocked=オーバーレイの位置は SteamVR シアタースクリーンによって制御されます tstr_AuxUIGazeFadeAutoHint=オーバーレイの中心を見て、%SECONDS% 秒間待ちます... tstr_AuxUIGazeFadeAutoHintSingular=オーバーレイの中心を見て、%SECONDS% 秒間待ちます... tstr_AuxUIQuickStartWelcomeHeader=Desktop+ へようこそ! tstr_AuxUIQuickStartWelcomeBody=この短いガイドでは、アプリケーションの基本について説明します。\n詳細については、説明書及びユーザーガイドを参照してください。\n\nこれをスキップしたい場合は、[閉じる]を押してください。 tstr_AuxUIQuickStartOverlaysHeader=オーバーレイ tstr_AuxUIQuickStartOverlaysBody=Desktop+ を使用すると、デスクトップやウィンドウなどをミラーリングするオーバーレイを作成できます。\n作成したすべてのオーバーレイは、下のオーバーレイバーにリストされます。\n\nオーバーレイのプロパティは、オーバーレイ アイコンの 1つをクリックして [プロパティ...] を選択することで変更できます。 tstr_AuxUIQuickStartOverlaysBody2=[+] を押して、リストからキャプチャ ソース/オーバーレイタイプを選択すると、新しいオーバーレイを作成できます。\nWeb ブラウザ オーバーレイなどの一部のタイプは、それぞれのアプリケーション コンポーネントがインストールされている場合にのみ使用できます。\n\n個々のオーバーレイまたは完全なレイアウトをプロファイルに保存できます。\n現在のオーバーレイ設定は、セッション間で自動的に記憶されます。 tstr_AuxUIQuickStartOverlayPropertiesHeader=オーバーレイプロパティ tstr_AuxUIQuickStartOverlayPropertiesBody=オーバーレイにはさまざまなカスタマイズオプションがあります。\n原点と表示モードは、オーバーレイが表示される場所とタイミングを設定します。\nオーバーレイが表示されるはずなのに見つからない場合は、これらのプロパティを確認してください。\nそれでも見つからない場合は、その位置をリセットすると役立つこともあります。\n\nまた、オーバーレイをモーションコントローラーの近くにドラッグして、モーションコントローラーにドッキングすることもできます。 tstr_AuxUIQuickStartOverlayPropertiesBody2=一部のプロパティはデフォルトで非表示になっています。\nすべてのオプションを表示するには、設定ウィンドウで[詳細設定を表示]を切り替えます。\n\nUIウィンドウの位置は、それぞれのボタンを長押しすることでリセットできます。\nダブルクリックや右クリックは、クイックショートカットトグルと同様にオーバーレイボタンでも機能します。 tstr_AuxUIQuickStartSettingsHeader=設定 tstr_AuxUIQuickStartSettingsBody=設定ウィンドウには、Desktop+ のすべてのグローバル設定が含まれています。\nオーバーレイバーの右端にある歯車のボタンから開けます。\n\nオーバーレイの場合と同様に、設定の変更は自動的に適用され、保存されます。 tstr_AuxUIQuickStartProfilesHeader=プロファイル tstr_AuxUIQuickStartProfilesBody=Desktop+ には、2種類のプロファイルがあります。\n\nオーバーレイプロファイル:\n1つまたは複数のオーバーレイをそのプロパティとともに保存します。\nこれらは手動で読み込んだり、アクションやアプリケーション、プロファイルのイベントとして読み込むこともできます。\n\nアプリケーションのプロファイル:\nSteamVR アプリケーションの起動時に自動的に読み込まれるオーバーレイプロファイルやアクションを割り当てます。 tstr_AuxUIQuickStartActionsHeader=アクション tstr_AuxUIQuickStartActionsBody=Desktop+ のアクションは、コントローラー入力やアプリケーションプロファイルに割り当てたり、オーバーレイのアクションバーに追加したりできる一連のコマンドです。\nアクションコマンドには、デスクトップ上の入力をシミュレートするものから、オーバーレイレイアウトを変更するものまであります。\n使い方次第では、外部アプリケーションを起動することもできます。\n\nDesktop+ には、いくつかのアクション例が用意されています。 tstr_AuxUIQuickStartActionsBody2=初期設定では、アクションは有効化されたオーバレイ(オーバレイに表示されたアクションボタン、オーバレイ上のコントローラ入力)、またはフォーカスされたオーバレイをターゲットにします。\n\nフォーカスされたオーバーレイは、最後にクリックされたオーバーレイです。\n多くの場合、デスクトップ上でシミュレートされた入力のように、対象となるオーバーレイは重要ではありません。他のケースでは、異なる対象のオーバーレイを指定したり、複数のオーバーレイを指定することが有用な場合もあります。 tstr_AuxUIQuickStartOverlayTagsHeader=オーバーレイタグ tstr_AuxUIQuickStartOverlayTagsBody=オーバーレイタグは以下の目的で使用されます。\nオーバーレイタグには自動タグ(緑色のラベル)とユーザー定義タグがあります。\n自動タグは、それが表すプロパティに基づいて自動的に割り当てられます。\nユーザー定義タグは、オーバーレイのプロパティウィンドウでオーバーレイに手動で割り当てることができます。\n\nアクションは、グローバルショートカットのコントローラーボタンに間接的にのみバインドされることに注意してください。番号付けされたグローバルショートカットは、SteamVRの入力バインディングインターフェイスを介してコントローラの入力にも割り当てる必要があります。 tstr_AuxUIQuickStartSettingsEndBody=他にも多くの設定ができます。\nチェックボックスなど操作して試してみてください。\n\n行き詰まった場合は、ウィンドウの下部にある [初期設定に戻す] を押してください。\n特定の要素のみを復元するオプションもあります。 tstr_AuxUIQuickStartFloatingUIHeader=フローティングUI tstr_AuxUIQuickStartFloatingUIBody=[フローティングUI]と呼ばれるインターフェースは、オーバーレイをポイントするたびに表示されます。\nダッシュボードでは、他のオーバーレイがポイントされていない場合に常に表示されます。\n\nフローティングUIには、ドラッグモードを切り替えてオーバーレイを移動できるようにするなど、オーバーレイを変更するための基本的なコントロールと、アクションボタンのカスタマイズ可能なセクションが含まれています。\n\nオーバーレイの種類によっては、他のコントロールも存在する場合があります。\nそれらの表示は、それぞれのオーバーレイプロパティでオーバーレイごとに切り替えることができます。 tstr_AuxUIQuickStartDesktopModeHeader=デスクトップモード tstr_AuxUIQuickStartDesktopModeBody=Desktop+ は、デスクトップに表示されるウィンドウで設定することもできます。\nこれは、頻繁なキーボード入力が必要なタスクや、モーションコントローラーを接続せずにせってを変更したいときに便利です。\n\nほぼすべての機能は両方のモードで同じですが、Desktop+ VRキーボードのレイアウトをカスタマイズするために使用されるキーボードレイアウトエディターは、デスクトップモードでのみアクセスできます。\n\n[設定] ウィンドウの [トラブルシューティング] セクション、またはシステムトレイ/通知領域の Desktop+ アイコンから切り替えることができます。 tstr_AuxUIQuickStartEndHeader=説明書 & ユーザーガイド tstr_AuxUIQuickStartEndBody=これだけで、Desktop+ を使い始めるのに十分なはずです。\n\n何か問題が起こったり、行き詰まったりした場合は、必ず説明書も確認してください。アクションバーのボタンをクリックすると、説明書を開けます。\n各オプションの詳細な説明と一般的な使用シナリオのステップバイステップガイドは、ユーザーガイドに記載されています。\n\nこのガイドを再度表示するには、[初期設定に戻す]ページの右下にある [クイックスタートガイドを表示] を押します。 tstr_AuxUIQuickStartButtonNext=次のページ tstr_AuxUIQuickStartButtonPrev=前のページ tstr_AuxUIQuickStartButtonClose=閉じる ;Desktop Mode tstr_DesktopModeCatTools=ツール tstr_DesktopModeCatOverlays=オーバーレイ tstr_DesktopModeToolSettings=設定 tstr_DesktopModeToolActions=アクション tstr_DesktopModeOverlayListAdd=オーバーレイ追加 tstr_DesktopModePageAddWindowOverlayTitle=ウィンドウオーバーレイ追加 tstr_DesktopModePageAddWindowOverlayHeader=ウィンドウを選択 ;Keyboard Editor tstr_KeyboardEditorKeyListTitle=キーリスト tstr_KeyboardEditorKeyListTabContextReplace=内容を置き換える... tstr_KeyboardEditorKeyListTabContextClear=サブレイアウトをクリア tstr_KeyboardEditorKeyListRow=行 %ID% tstr_KeyboardEditorKeyListSpacing=[間隔] tstr_KeyboardEditorKeyListKeyAdd=追加 tstr_KeyboardEditorKeyListKeyDuplicate=重複 tstr_KeyboardEditorKeyListKeyRemove=削除 tstr_KeyboardEditorKeyPropertiesTitle=キーのプロパティ tstr_KeyboardEditorKeyPropertiesNoSelection=キーが選択されていません tstr_KeyboardEditorKeyPropertiesType=タイプ tstr_KeyboardEditorKeyPropertiesTypeBlank=空白スペース tstr_KeyboardEditorKeyPropertiesTypeVirtualKey=仮想キー tstr_KeyboardEditorKeyPropertiesTypeVirtualKeyToggle=仮想キー(トグル) tstr_KeyboardEditorKeyPropertiesTypeVirtualKeyIsoEnter=仮想キー(ISO 入力) tstr_KeyboardEditorKeyPropertiesTypeString=文字列 tstr_KeyboardEditorKeyPropertiesTypeSublayoutToggle=サブレイアウトを切り替える tstr_KeyboardEditorKeyPropertiesTypeAction=アクション tstr_KeyboardEditorKeyPropertiesTypeVirtualKeyIsoEnterTip=隣接する行にある 2つの[仮想キー(ISO 入力)]キーを使用して、ISO 入力 形状のキーを構築します。\n各サブレイアウトには結合キーが 1つだけあります。 tstr_KeyboardEditorKeyPropertiesTypeStringTip=基本以外の文字キーには文字列型を使用します。\nこれにより、Desktop+ は実際のキーボードレイアウト上の正しいキーの組み合わせを判断し、アプリケーションの互換性を高めることができます。 tstr_KeyboardEditorKeyPropertiesSize=サイズ tstr_KeyboardEditorKeyPropertiesLabel=ラベル tstr_KeyboardEditorKeyPropertiesKeyCode=キーコード tstr_KeyboardEditorKeyPropertiesString=文字列 tstr_KeyboardEditorKeyPropertiesSublayout=サブレイアウト tstr_KeyboardEditorKeyPropertiesAction=アクション tstr_KeyboardEditorKeyPropertiesCluster=クラスター tstr_KeyboardEditorKeyPropertiesClusterTip=クラスター割り当ては、選択したキーの読み込みを無効にするために使用されます。\n周辺のスペースは削除されません。正常に切り替えられるように、空白スペースタイプのキーをクラスターに慎重に割り当ててください。 tstr_KeyboardEditorKeyPropertiesBlockModifiers=修飾キーをブロック tstr_KeyboardEditorKeyPropertiesBlockModifiersTip=キーを押している間、すべての修飾キーを解除します。 tstr_KeyboardEditorKeyPropertiesNoRepeat=繰り返さない tstr_KeyboardEditorKeyPropertiesNoRepeatTip=キーリピートが有効になっている場合でも、押​​し続けている間はキーが繰り返し入力されないようにします。 tstr_KeyboardEditorMetadataTitle=レイアウトメタデータ tstr_KeyboardEditorMetadataName=名前 tstr_KeyboardEditorMetadataAuthor=作成者 tstr_KeyboardEditorMetadataHasAltGr=AltGrキー あり tstr_KeyboardEditorMetadataHasAltGrTip=右Altキーを押すと、AltGrサブレイアウトに切り替わります。 tstr_KeyboardEditorMetadataClusterPreview=プレビュー クラスター: tstr_KeyboardEditorMetadataSave=保存中... tstr_KeyboardEditorMetadataLoad=読み込み中... tstr_KeyboardEditorMetadataSavePopupTitle=キーボードレイアウトを保存 tstr_KeyboardEditorMetadataSavePopupFilename=ファイル名 tstr_KeyboardEditorMetadataSavePopupFilenameBlankTip=ファイル名は空白にできません tstr_KeyboardEditorMetadataSavePopupConfirm=レイアウトを保存 tstr_KeyboardEditorMetadataSavePopupConfirmError=レイアウトを保存できませんでした tstr_KeyboardEditorMetadataLoadPopupTitle=キーボードレイアウトを読み込む tstr_KeyboardEditorMetadataLoadPopupConfirm=レイアウトを読み込む tstr_KeyboardEditorPreviewTitle=キーボードプレビュー tstr_KeyboardEditorSublayoutBase=Base tstr_KeyboardEditorSublayoutShift=Shift tstr_KeyboardEditorSublayoutAltGr=AltGr tstr_KeyboardEditorSublayoutAux=Aux ;General Dialog Strings tstr_DialogOk=適用 tstr_DialogCancel=キャンセル tstr_DialogDone=閉じる tstr_DialogUndo=元に戻す tstr_DialogRedo=やり直し tstr_DialogColorPickerHeader=色を選択 tstr_DialogColorPickerCurrent=現在 tstr_DialogColorPickerOriginal=オリジナル tstr_DialogProfilePickerHeader=プロフィールを選択 tstr_DialogProfilePickerNone=[なし] tstr_DialogActionPickerHeader=アクションを選択 tstr_DialogActionPickerEmpty=利用可能なアクションはありません tstr_DialogIconPickerHeader=アイコンを選択 tstr_DialogIconPickerHeaderTip=カスタムアイコンは "images\icons\" ディレクトリに PNG ファイルとして追加できます。 tstr_DialogIconPickerNone=[アイコンがありません] tstr_DialogKeyCodePickerHeader=キーコードを選択 tstr_DialogKeyCodePickerHeaderHotkey=ホットキーを選択 tstr_DialogKeyCodePickerModifiers=修飾子 tstr_DialogKeyCodePickerKeyCode=キーコード tstr_DialogKeyCodePickerKeyCodeHint=フィルターリスト tstr_DialogKeyCodePickerKeyCodeNone=[なし] tstr_DialogKeyCodePickerFromInput=入力から... tstr_DialogKeyCodePickerFromInputPopup=任意のキーまたはマウスのボタンを押します... tstr_DialogKeyCodePickerFromInputPopupNoMouse=どれかキーを押してください... tstr_DialogWindowPickerHeader=ウィンドウを選択 tstr_DialogInputTagsHint=フィルターまたは新規タグ ;Source Strings tstr_SourceDesktopAll=統合デスクトップ tstr_SourceDesktopID=デスクトップ %ID% tstr_SourceWinRTNone=[キャプチャー対象がありません] tstr_SourceWinRTUnknown=[不明なウィンドウ] tstr_SourceWinRTClosed=[閉じる]: tstr_SourcePerformanceMonitor=パフォーマンスモニター tstr_SourceBrowser=ブラウザ tstr_SourceBrowserNoPage=[ページが読み込めません] ;Notification Icon tstr_NotificationIconRestoreVR=VRインターフェイスを復元 tstr_NotificationIconOpenOnDesktop=デスクトップ設定を開く tstr_NotificationIconQuit=閉じる ;Notifications tstr_NotificationInitialStartupTitleVR=初期設定 tstr_NotificationInitialStartupTitleDesktop=Desktop+ セットアップ tstr_NotificationInitialStartupMessage=Desktop+ が SteamVR に正常に追加され、SteamVR の実行時に自動的に起動するようになりました。 ;Browser tstr_BrowserErrorPageTitle=ページ読み込みエラー - Desktop+ tstr_BrowserErrorPageHeading=ページを読み込めませんでした tstr_BrowserErrorPageMessage=%URL% の読み込み中にエラーが発生しました: %ERROR% ================================================ FILE: assets/lang/ko.ini ================================================ [TranslationInfo] Name=한국어 (Korean) Author=HisaCat Locale=ko-KR [Strings] ;Settings Window tstr_SettingsWindowTitle=Desktop+ 설정 tstr_SettingsCatInterface=인터페이스 tstr_SettingsCatEnvironment=환경 tstr_SettingsCatProfiles=프로필 tstr_SettingsCatActions=액션 tstr_SettingsCatKeyboard=키보드 tstr_SettingsCatMouse=마우스 tstr_SettingsCatLaserPointer=레이저 포인터 tstr_SettingsCatWindowOverlays=창 오버레이 tstr_SettingsCatBrowser=브라우저 tstr_SettingsCatPerformance=성능 tstr_SettingsCatVersionInfo=버전 정보 tstr_SettingsCatWarnings=경고 tstr_SettingsCatStartup=시작 설정 tstr_SettingsCatTroubleshooting=문제 해결 tstr_SettingsWarningPrefix=경고: tstr_SettingsWarningCompositorResolution=SteamVR의 내부 해상도가 100% 미만입니다! 이는 오버레이 렌더링 품질에 영향을 줍니다. tstr_SettingsWarningCompositorQuality=SteamVR 오버레이 렌더링 품질이 높음으로 설정되어 있지 않습니다! tstr_SettingsWarningProcessElevated=Desktop+가 관리자 권한으로 실행되고 있습니다! tstr_SettingsWarningElevatedMode=관리자 모드가 활성화되었습니다! tstr_SettingsWarningBrowserMissing=브라우저 오버레이가 사용 중이지만, Desktop+ 브라우저 구성 요소를 현재 사용할 수 없습니다. tstr_SettingsWarningBrowserMismatch=설치된 Desktop+ 브라우저 구성 요소가 현재 버전의 Desktop+와 호환되지 않습니다! tstr_SettingsWarningElevatedProcessFocus=관리자 권한 프로세스가 포커스를 가지고 있습니다!\n현재 Desktop+는 입력 시뮬레이션을 할 수 없습니다. tstr_SettingsWarningUIAccessLost=Desktop+가 더 이상 UI 접근 권한(UIAccess)으로 실행되고 있지 않습니다! tstr_SettingsWarningOverlayCreationErrorLimit=오버레이 생성에 실패했습니다! (오버레이 최대 개수 초과) tstr_SettingsWarningOverlayCreationErrorOther=오버레이 생성에 실패했습니다! (%ERRORNAME%) tstr_SettingsWarningGraphicsCaptureError=그래픽 캡처 스레드에서 예기치 못한 오류가 발생했습니다! (%ERRORCODE%) tstr_SettingsWarningAppProfileActive=%APPNAME%의 애플리케이션 프로필이 현재 오버레이 레이아웃을 덮어썼습니다.\n활성화된 동안에는 오버레이 변경 사항이 자동 저장되지 않습니다. tstr_SettingsWarningConfigMigrated=이전 버전의 Desktop+ 설정 및 프로필이 새로운 형식으로 이전되었습니다.\n원본 파일은 삭제되지 않아, 이전 버전에서도 사용할 수 있습니다.\n처음부터 다시 시작하려면 [기본 설정 복원]을 참고하세요. tstr_SettingsWarningMenuDontShowAgain=다시 표시하지 않음 tstr_SettingsWarningMenuDismiss=닫기 tstr_SettingsInterfaceLanguage=언어 tstr_SettingsInterfaceLanguageCommunity=%AUTHOR%에 의한 커뮤니티 번역 tstr_SettingsInterfaceLanguageIncompleteWarning=번역이 불완전할 수 있습니다 tstr_SettingsInterfaceAdvancedSettings=고급 설정 표시 tstr_SettingsInterfaceAdvancedSettingsTip=자주 사용되지 않는 고급 설정을 표시합니다 tstr_SettingsInterfaceBlankSpaceDrag=빈 공간 클릭 시 창 드래그 tstr_SettingsInterfacePersistentUI=UI 상태 유지 tstr_SettingsInterfacePersistentUIManage=관리 tstr_SettingsInterfaceDesktopButtons=데스크톱 버튼 표시 방식 tstr_SettingsInterfaceDesktopButtonsNone=없음 tstr_SettingsInterfaceDesktopButtonsIndividual=개별 데스크톱 tstr_SettingsInterfaceDesktopButtonsCycle=순환 버튼 tstr_SettingsInterfaceDesktopButtonsAddCombined=통합 데스크톱 추가 버튼 tstr_SettingsInterfacePersistentUIHelp=Desktop+는 일반 모드(전역)와 SteamVR 대시보드의 Desktop+ 탭 내에서 각각 별도로 창 상태를 기억합니다. tstr_SettingsInterfacePersistentUIHelp2=아래 컨트롤을 사용해 해당 창의 상태를 직접 변경할 수 있습니다.\n일부 상태는 창을 보이게 하려면 위치를 초기화해야 할 수도 있습니다. tstr_SettingsInterfacePersistentUIWindowsHeader=창 목록 tstr_SettingsInterfacePersistentUIWindowsSettings=설정 tstr_SettingsInterfacePersistentUIWindowsProperties=오버레이 속성 tstr_SettingsInterfacePersistentUIWindowsKeyboard=Desktop+ 키보드 tstr_SettingsInterfacePersistentUIWindowsStateGlobal=전역 tstr_SettingsInterfacePersistentUIWindowsStateDashboardTab=Desktop+ 탭 tstr_SettingsInterfacePersistentUIWindowsStateVisible=표시됨 tstr_SettingsInterfacePersistentUIWindowsStatePinned=고정됨 tstr_SettingsInterfacePersistentUIWindowsStatePosition=위치 tstr_SettingsInterfacePersistentUIWindowsStatePositionReset=위치 초기화 tstr_SettingsInterfacePersistentUIWindowsStateSize=크기 tstr_SettingsInterfacePersistentUIWindowsStateLaunchRestore=Desktop+ 실행 시 상태 복원 tstr_SettingsEnvironmentBackgroundColor=배경 색상 tstr_SettingsEnvironmentBackgroundColorDispModeNever=항상 숨김 tstr_SettingsEnvironmentBackgroundColorDispModeDPlusTab=Desktop+ 탭에서만 표시 tstr_SettingsEnvironmentBackgroundColorDispModeAlways=항상 표시 tstr_SettingsEnvironmentDimInterface=어두운 인터페이스 tstr_SettingsEnvironmentDimInterfaceTip=Desktop+ 대시보드 탭이 열려 있는 동안 SteamVR 대시보드와 Desktop+ UI를 어둡게 표시합니다. tstr_SettingsProfilesOverlays=오버레이 프로필 tstr_SettingsProfilesApps=앱 프로필 tstr_SettingsProfilesManage=관리 tstr_SettingsProfilesOverlaysHeader=오버레이 프로필 관리 tstr_SettingsProfilesOverlaysNameDefault=기본값 tstr_SettingsProfilesOverlaysNameNew=[새 프로필] tstr_SettingsProfilesOverlaysNameNewBase=프로필 %ID% tstr_SettingsProfilesOverlaysProfileLoad=프로필 불러오기 tstr_SettingsProfilesOverlaysProfileAdd=프로필에서 오버레이 추가 tstr_SettingsProfilesOverlaysProfileSave=현재 오버레이 저장 tstr_SettingsProfilesOverlaysProfileDelete=프로필 삭제 tstr_SettingsProfilesOverlaysProfileDeleteConfirm=정말 삭제하시겠습니까? tstr_SettingsProfilesOverlaysProfileFailedLoad=프로필 불러오기 실패 tstr_SettingsProfilesOverlaysProfileFailedDelete=프로필 삭제 실패 tstr_SettingsProfilesOverlaysProfileAddSelectHeader=프로필에서 추가할 오버레이 선택 tstr_SettingsProfilesOverlaysProfileAddSelectEmpty=이 프로필에는 오버레이가 없습니다. tstr_SettingsProfilesOverlaysProfileAddSelectDo=선택한 오버레이 추가 tstr_SettingsProfilesOverlaysProfileAddSelectAll=모두 선택 tstr_SettingsProfilesOverlaysProfileAddSelectNone=선택 해제 tstr_SettingsProfilesOverlaysProfileSaveSelectHeader=현재 오버레이 저장 tstr_SettingsProfilesOverlaysProfileSaveSelectName=프로필 이름 tstr_SettingsProfilesOverlaysProfileSaveSelectNameErrorBlank=이름은 비워둘 수 없습니다 tstr_SettingsProfilesOverlaysProfileSaveSelectNameErrorTaken=이미 사용 중인 이름입니다 tstr_SettingsProfilesOverlaysProfileSaveSelectHeaderList=프로필에 저장할 오버레이 선택 tstr_SettingsProfilesOverlaysProfileSaveSelectDo=선택한 오버레이 저장 tstr_SettingsProfilesOverlaysProfileSaveSelectDoFailed=프로필 저장 실패 tstr_SettingsProfilesAppsHeader=앱 프로필 관리 tstr_SettingsProfilesAppsHeaderNoVRTip=Desktop+가 실행 중이 아닐 때는 기존 앱 프로필만 표시됩니다 tstr_SettingsProfilesAppsListEmpty=사용 가능한 앱이 없습니다 tstr_SettingsProfilesAppsProfileHeaderActive=(현재 활성화됨) tstr_SettingsProfilesAppsProfileEnabled=앱 실행 시 활성화 tstr_SettingsProfilesAppsProfileOverlayProfile=오버레이 프로필 tstr_SettingsProfilesAppsProfileActionEnter=진입 시 실행할 액션 tstr_SettingsProfilesAppsProfileActionLeave=종료 시 실행할 액션 tstr_SettingsActionsManage=액션 tstr_SettingsActionsManageButton=관리 tstr_SettingsActionsButtonsOrderDefault=액션 버튼 (기본) tstr_SettingsActionsButtonsOrderOverlayBar=액션 버튼 (오버레이 바) tstr_SettingsActionsShowBindings=컨트롤러 바인딩 표시 tstr_SettingsActionsActiveShortcuts=활성 컨트롤러 버튼 tstr_SettingsActionsActiveShortcutsTip=오버레이를 가리킬 때의 컨트롤러 바인딩입니다.\nVR 대시보드 컨트롤러 바인딩을 변경하여 어떤 버튼을 사용할지 설정할 수 있습니다. tstr_SettingsActionsActiveShortuctsHome="홈으로 이동" tstr_SettingsActionsActiveShortuctsBack="뒤로 가기" tstr_SettingsActionsGlobalShortcuts=전역 컨트롤러 버튼 tstr_SettingsActionsGlobalShortcutsTip=대시보드가 닫혀 있고 오버레이를 가리키지 않을 때의 컨트롤러 바인딩입니다.\nDesktop+ 컨트롤러 바인딩을 변경하여 어떤 버튼을 사용할지 설정할 수 있습니다. tstr_SettingsActionsGlobalShortcutsEntry=전역 단축키 #%ID% tstr_SettingsActionsGlobalShortcutsAdd=단축키 추가 tstr_SettingsActionsGlobalShortcutsRemove=마지막 단축키 제거 tstr_SettingsActionsHotkeys=핫키 tstr_SettingsActionsHotkeysTip=시스템 전역 키보드 단축키입니다.\n단축키를 사용하면 다른 프로그램이 해당 입력을 받지 못하며, 동일한 조합이 이미 다른 곳에 등록되어 있으면 작동하지 않을 수 있습니다. tstr_SettingsActionsHotkeysAdd=핫키 추가 tstr_SettingsActionsHotkeysRemove=삭제 tstr_SettingsActionsTableHeaderAction=액션 tstr_SettingsActionsTableHeaderShortcut=단축키 tstr_SettingsActionsTableHeaderHotkey=핫키 tstr_SettingsActionsManageHeader=액션 관리 tstr_SettingsActionsManageCopyUID=UID 복사 tstr_SettingsActionsManageNew=새 액션... tstr_SettingsActionsManageEdit=액션 편집 tstr_SettingsActionsManageDuplicate=액션 복제 tstr_SettingsActionsManageDelete=액션 삭제 tstr_SettingsActionsManageDeleteConfirm=정말 삭제하시겠습니까? tstr_SettingsActionsManageDuplicatedName=%NAME% (복사본) tstr_SettingsActionsEditHeader=액션 편집 tstr_SettingsActionsEditName=이름 tstr_SettingsActionsEditNameTranslatedTip=이 액션은 현재 번역 문자열 ID를 이름으로 사용하며, 선택된 앱 언어에 자동으로 맞춰집니다 tstr_SettingsActionsEditTarget=대상 tstr_SettingsActionsEditTargetDefault=기본값 tstr_SettingsActionsEditTargetDefaultTip=액션이 실행된 오버레이를 대상으로 하며, 해당 조건이 없으면 현재 포커스된 오버레이를 대상으로 합니다 tstr_SettingsActionsEditTargetUseTags=태그 사용 tstr_SettingsActionsEditTargetActionTarget=액션 대상 tstr_SettingsActionsEditHeaderAppearance=버튼 외형 tstr_SettingsActionsEditIcon=아이콘 tstr_SettingsActionsEditLabel=라벨 tstr_SettingsActionsEditLabelTranslatedTip=이 액션은 현재 번역 문자열 ID를 라벨로 사용하며, 선택된 앱 언어에 자동으로 맞춰집니다 tstr_SettingsActionsEditHeaderCommands=명령 tstr_SettingsActionsEditNameNew=새 액션 tstr_SettingsActionsEditCommandAdd=명령 추가 tstr_SettingsActionsEditCommandDelete=명령 삭제 tstr_SettingsActionsEditCommandDeleteConfirm=정말 삭제하시겠습니까? tstr_SettingsActionsEditCommandType=명령 유형 tstr_SettingsActionsEditCommandTypeNone=없음 tstr_SettingsActionsEditCommandTypeKey=키 누르기 tstr_SettingsActionsEditCommandTypeMousePos=마우스 위치 설정 tstr_SettingsActionsEditCommandTypeString=문자열 입력 tstr_SettingsActionsEditCommandTypeLaunchApp=앱 실행 tstr_SettingsActionsEditCommandTypeShowKeyboard=키보드 표시 tstr_SettingsActionsEditCommandTypeCropActiveWindow=활성 창 표시 영역 지정 tstr_SettingsActionsEditCommandTypeShowOverlay=오버레이 표시 tstr_SettingsActionsEditCommandTypeSwitchTask=작업 전환 tstr_SettingsActionsEditCommandTypeLoadOverlayProfile=오버레이 프로필 불러오기 tstr_SettingsActionsEditCommandTypeUnknown=알 수 없음 tstr_SettingsActionsEditCommandVisibilityToggle=토글 tstr_SettingsActionsEditCommandVisibilityShow=항상 표시 tstr_SettingsActionsEditCommandVisibilityHide=항상 숨김 tstr_SettingsActionsEditCommandUndo=해제 시 실행 취소 tstr_SettingsActionsEditCommandKeyCode=키 코드 tstr_SettingsActionsEditCommandKeyToggle=키 토글 tstr_SettingsActionsEditCommandMouseX=X tstr_SettingsActionsEditCommandMouseY=Y tstr_SettingsActionsEditCommandMouseUseCurrent=현재 마우스 위치 사용 tstr_SettingsActionsEditCommandString=문자열 tstr_SettingsActionsEditCommandPath=실행 파일 경로 tstr_SettingsActionsEditCommandPathTip=일반 파일이나 URL도 가능합니다 tstr_SettingsActionsEditCommandArgs=앱 인자 tstr_SettingsActionsEditCommandArgsTip=앱에 전달할 인자입니다.\n모를 경우 비워두세요. tstr_SettingsActionsEditCommandVisibility=표시 여부 tstr_SettingsActionsEditCommandSwitchingMethod=전환 방식 tstr_SettingsActionsEditCommandSwitchingMethodSwitcher=작업 전환기 표시 tstr_SettingsActionsEditCommandSwitchingMethodFocus=창 포커스 tstr_SettingsActionsEditCommandWindow=창 tstr_SettingsActionsEditCommandWindowNone=[창 없음] tstr_SettingsActionsEditCommandWindowStrictMatchingTip=전환할 창을 찾을 때 제목이 완전히 일치하는 경우만 허용 tstr_SettingsActionsEditCommandCursorWarp=커서를 창 안으로 이동 tstr_SettingsActionsEditCommandProfile=프로필 tstr_SettingsActionsEditCommandProfileClear=기존 오버레이 제거 tstr_SettingsActionsEditCommandDescNone=명령 없음 tstr_SettingsActionsEditCommandDescKey=키 누르기 "%KEYNAME%" tstr_SettingsActionsEditCommandDescKeyToggle=키 토글 "%KEYNAME%" tstr_SettingsActionsEditCommandDescMousePos=마우스 위치를 %X%, %Y%로 설정 tstr_SettingsActionsEditCommandDescString=문자열 입력 "%STRING%" tstr_SettingsActionsEditCommandDescLaunchApp=앱 실행 "%APP%" %ARGSOPT% tstr_SettingsActionsEditCommandDescLaunchAppArgsOpt="%ARGS%" tstr_SettingsActionsEditCommandDescKeyboardToggle=키보드 토글 tstr_SettingsActionsEditCommandDescKeyboardShow=키보드 표시 tstr_SettingsActionsEditCommandDescKeyboardHide=키보드 숨김 tstr_SettingsActionsEditCommandDescCropWindow=활성 창 표시 영역 지정 tstr_SettingsActionsEditCommandDescOverlayToggle=오버레이 토글: %TAGS% tstr_SettingsActionsEditCommandDescOverlayShow=오버레이 표시: %TAGS% tstr_SettingsActionsEditCommandDescOverlayHide=오버레이 숨김: %TAGS% tstr_SettingsActionsEditCommandDescOverlayTargetDefault=[액션 대상] tstr_SettingsActionsEditCommandDescSwitchTask=작업 전환 tstr_SettingsActionsEditCommandDescSwitchTaskWindow=작업을 "%WINDOW%"(으)로 전환 tstr_SettingsActionsEditCommandDescLoadOverlayProfile=오버레이 프로필 "%PROFILE%" 불러오기 tstr_SettingsActionsEditCommandDescLoadOverlayProfileAdd=오버레이 프로필 "%PROFILE%" 추가 tstr_SettingsActionsEditCommandDescUnknown=알 수 없는 명령 tstr_SettingsActionsOrderHeader=액션 순서 변경 tstr_SettingsActionsOrderButtonLabel=%COUNT%개의 액션 선택됨 tstr_SettingsActionsOrderButtonLabelSingular=%COUNT%개의 액션 선택됨 tstr_SettingsActionsOrderNoActions=선택된 액션이 없습니다 tstr_SettingsActionsOrderAdd=액션 추가... tstr_SettingsActionsOrderRemove=액션 제거 tstr_SettingsActionsAddSelectorHeader=추가할 액션 선택 tstr_SettingsActionsAddSelectorAdd=선택한 액션 추가 tstr_SettingsKeyboardLayout=키보드 레이아웃 tstr_SettingsKeyboardSize=크기 tstr_SettingsKeyboardBehavior=동작 tstr_SettingsKeyboardStickyMod=조합키 고정 tstr_SettingsKeyboardKeyRepeat=키 반복 tstr_SettingsKeyboardAutoShow=자동 표시 tstr_SettingsKeyboardAutoShowDesktopOnly=데스크톱에서만 자동 표시 tstr_SettingsKeyboardAutoShowDesktop=데스크톱과 창 오버레이에서 자동 표시 tstr_SettingsKeyboardAutoShowDesktopTip=실험적인 기능. 모든 앱에서 동작하지 않을 수 있습니다. tstr_SettingsKeyboardAutoShowBrowser=브라우저 오버레이에서 자동 표시 tstr_SettingsKeyboardLayoutAuthor=%AUTHOR% 제작 tstr_SettingsKeyboardKeyClusters=키 그룹 tstr_SettingsKeyboardKeyClusterBase=일반 tstr_SettingsKeyboardKeyClusterFunction=기능 tstr_SettingsKeyboardKeyClusterNavigation=네비게이션 tstr_SettingsKeyboardKeyClusterNumpad=숫자 키패드 tstr_SettingsKeyboardKeyClusterExtra=기타 tstr_SettingsKeyboardSwitchToEditor=키보드 레이아웃 편집기로 전환 tstr_SettingsMouseShowCursor=커서 표시 tstr_SettingsMouseShowCursorGCUnsupported=이 시스템에서는 그래픽 캡처 오버레이의 커서 비활성화가 지원되지 않습니다 tstr_SettingsMouseShowCursorGCActiveWarning=활성 그래픽 캡처 미러로 인해 데스크톱 복제 오버레이에서 커서가 숨겨지지 않을 수 있습니다 tstr_SettingsMouseScrollSmooth=부드러운 스크롤 사용 tstr_SettingsMouseSimulatePen=펜 입력으로 시뮬레이션 tstr_SettingsMouseSimulatePenUnsupported=이 시스템에서는 펜 입력 시뮬레이션이 지원되지 않습니다 tstr_SettingsMouseAllowLaserPointerOverride=레이저 포인터 재정의 허용 tstr_SettingsMouseAllowLaserPointerOverrideTip=물리 마우스를 빠르게 움직이면 레이저 포인터를 비활성화합니다.\n오버레이를 클릭하면 레이저 포인터가 다시 활성화됩니다. tstr_SettingsMouseDoubleClickAssist=더블 클릭 보조 tstr_SettingsMouseDoubleClickAssistTip=더블 클릭을 쉽게 하기 위해 마우스 커서를 설정된 시간 동안 고정합니다 tstr_SettingsMouseDoubleClickAssistTipValueOff=끔 tstr_SettingsMouseDoubleClickAssistTipValueAuto=자동 tstr_SettingsMouseSmoothing=부드러운 이동 tstr_SettingsMouseSmoothingLevelNone=없음 tstr_SettingsMouseSmoothingLevelVeryLow=매우 낮음 tstr_SettingsMouseSmoothingLevelLow=낮음 tstr_SettingsMouseSmoothingLevelMedium=중간 tstr_SettingsMouseSmoothingLevelHigh=높음 tstr_SettingsMouseSmoothingLevelVeryHigh=매우 높음 tstr_SettingsLaserPointerTip=이 설정은 SteamVR 대시보드가 닫혀 있을 때 사용되는 Desktop+ 레이저 포인터에 적용됩니다 tstr_SettingsLaserPointerBlockInput=활성 상태에서 게임 입력 차단 tstr_SettingsLaserPointerAutoToggleDistance=자동 활성화 최대 거리 tstr_SettingsLaserPointerAutoToggleDistanceValueOff=끔 tstr_SettingsLaserPointerHMDPointer=시선 기반 HMD 포인터 tstr_SettingsLaserPointerHMDPointerTableHeaderInputAction=입력 동작 tstr_SettingsLaserPointerHMDPointerTableHeaderBinding=키보드 키 tstr_SettingsLaserPointerHMDPointerTableBindingToggle=레이저 포인터 토글 tstr_SettingsLaserPointerHMDPointerTableBindingLeft=마우스 왼쪽 버튼 tstr_SettingsLaserPointerHMDPointerTableBindingRight=마우스 오른쪽 버튼 tstr_SettingsLaserPointerHMDPointerTableBindingMiddle=마우스 휠 클릭 tstr_SettingsLaserPointerHMDPointerTableBindingDrag=오버레이 드래그 tstr_SettingsWindowOverlaysAutoFocus=오버레이를 가리킬 때 해당 창에 포커스 tstr_SettingsWindowOverlaysKeepOnScreen=창을 화면 안에 유지 tstr_SettingsWindowOverlaysKeepOnScreenTip=소스 창의 경계가 화면 작업 영역 밖에 있으면 자동으로 화면 안으로 이동시킵니다 tstr_SettingsWindowOverlaysAutoSizeOverlay=창 크기 변경 시 오버레이 크기 조정 tstr_SettingsWindowOverlaysFocusSceneApp=레이저 포인터가 오버레이를 벗어나면 게임에 포커스 tstr_SettingsWindowOverlaysFocusSceneAppDashboard=대시보드 닫은 후 게임에 포커스 tstr_SettingsWindowOverlaysOnWindowDrag=창 드래그 시 동작 tstr_SettingsWindowOverlaysOnWindowDragDoNothing=아무 것도 하지 않음 tstr_SettingsWindowOverlaysOnWindowDragBlock=드래그 차단 tstr_SettingsWindowOverlaysOnWindowDragOverlay=오버레이 드래그 tstr_SettingsWindowOverlaysOnCaptureLoss=캡처 손실 시 동작 tstr_SettingsWindowOverlaysOnCaptureLossTip=창 캡처가 사라졌을 때의 동작입니다. 보통 대상 창이 닫히면 발생합니다.\n"오버레이 숨김"을 선택하면 캡처가 복원될 때 오버레이가 다시 표시됩니다. tstr_SettingsWindowOverlaysOnCaptureLossDoNothing=아무 것도 하지 않음 tstr_SettingsWindowOverlaysOnCaptureLossHide=오버레이 숨김 tstr_SettingsWindowOverlaysOnCaptureLossRemove=오버레이 제거 tstr_SettingsBrowserMaxFrameRate=최대 프레임 tstr_SettingsBrowserMaxFrameRateOverrideOff=전역 설정 사용 tstr_SettingsBrowserContentBlocker=콘텐츠 차단기 tstr_SettingsBrowserContentBlockerTip=Adblock Plus 구문을 사용한 차단 목록을 "DesktopPlusBrowser\content_block" 디렉토리에 추가하세요.\n디렉토리에 있는 모든 목록이 로드됩니다. tstr_SettingsBrowserContentBlockerListCount=(%LISTCOUNT%개의 목록 활성화됨) tstr_SettingsBrowserContentBlockerListCountSingular=(%LISTCOUNT%개의 목록 활성화됨) tstr_SettingsPerformanceUpdateLimiter=업데이트 제한 tstr_SettingsPerformanceUpdateLimiterMode=업데이트 제한 모드 tstr_SettingsPerformanceUpdateLimiterModeOff=끔 tstr_SettingsPerformanceUpdateLimiterModeMS=프레임 시간 tstr_SettingsPerformanceUpdateLimiterModeFPS=프레임 레이트 tstr_SettingsPerformanceUpdateLimiterModeOffOverride=전역 설정 사용 tstr_SettingsPerformanceUpdateLimiterModeMSTip="프레임 시간"은 오버레이 업데이트 사이의 최소 간격을 강제합니다 tstr_SettingsPerformanceUpdateLimiterFPSValue=%FPS% fps tstr_SettingsPerformanceUpdateLimiterOverride=업데이트 제한 재정의 tstr_SettingsPerformanceUpdateLimiterOverrideTip=여러 재정의가 활성화되어 있을 경우, 가장 높은 업데이트 속도를 제공하는 설정이 사용됩니다 tstr_SettingsPerformanceUpdateLimiterModeOverride=업데이트 제한 모드 재정의 tstr_SettingsPerformanceRapidUpdates=레이저 포인터 지연 시간 단축 tstr_SettingsPerformanceRapidUpdatesTip=오버레이를 가리킬 때 CPU 부하를 늘려 레이저 포인터 입력 지연을 줄입니다 tstr_SettingsPerformanceSingleDesktopMirror=단일 데스크톱 미러링 tstr_SettingsPerformanceSingleDesktopMirrorTip=결합된 데스크톱에서 잘라내는 대신, 전환 시 각 데스크톱을 개별적으로 미러링합니다.\n이 기능이 활성화되면 모든 오버레이가 동일한 데스크톱을 표시합니다. tstr_SettingsPerformanceUseHDR=HDR 미러링 tstr_SettingsPerformanceUseHDRTip=데스크톱과 창을 더 높은 비트 깊이의 텍스처로 미러링하여 HDR 출력을 지원합니다. (실험적인 기능)\n필요하지 않은 경우 성능에 부정적인 영향을 줄 수 있으며 VRAM 사용량이 증가합니다. tstr_SettingsPerformanceShowFPS=플로팅 UI에 FPS 표시 tstr_SettingsWarningsHidden=숨긴 경고: tstr_SettingsWarningsReset=숨긴 경고 초기화 tstr_SettingsStartupAutoLaunch=SteamVR 시작 시 자동 실행 tstr_SettingsStartupSteamDisable=Steam 연동 비활성화 tstr_SettingsStartupSteamDisableTip=Steam을 통해 실행된 경우 Steam 없이 Desktop+를 재시작합니다.\n이 기능을 사용하면 앱 내 상태, 사용 시간 통계, 기타 Steam 기능이 비활성화됩니다. tstr_SettingsTroubleshootingRestart=재시작 tstr_SettingsTroubleshootingRestartSteam=Steam으로 재시작 tstr_SettingsTroubleshootingRestartDesktop=데스크톱 모드로 재시작 tstr_SettingsTroubleshootingElevatedModeEnter=관리자 모드 진입 tstr_SettingsTroubleshootingElevatedModeLeave=관리자 모드 종료 tstr_SettingsTroubleshootingSettingsReset=기본 설정 복원 tstr_SettingsTroubleshootingSettingsResetConfirmDescription=기본 설정을 복원하면 선택된 항목이 기본값으로 초기화됩니다.\n이 작업은 되돌릴 수 없습니다.\n\n다음 항목이 초기화됩니다: tstr_SettingsTroubleshootingSettingsResetConfirmButton=선택 항목 초기화 tstr_SettingsTroubleshootingSettingsResetConfirmElementOverlays=현재 오버레이 구성 tstr_SettingsTroubleshootingSettingsResetConfirmElementLegacyFiles=사용하지 않는 이전 설정 및 프로필 파일 삭제 tstr_SettingsTroubleshootingSettingsResetShowQuickStart=퀵스타트 가이드 표시 ;Keyboard Window ;Keyboard Window tstr_KeyboardWindowTitle=Desktop+ 키보드 tstr_KeyboardWindowTitleSettings=Desktop+ 키보드 (설정) tstr_KeyboardWindowTitleOverlay=Desktop+ 키보드 (%OVERLAYNAME%) tstr_KeyboardWindowTitleOverlayUnknown=[알 수 없는 오버레이] ;Keyboard Shortcuts Window tstr_KeyboardShortcutsCut=잘라내기 tstr_KeyboardShortcutsCopy=복사 tstr_KeyboardShortcutsPaste=붙여넣기 ;Overlay Properties Window tstr_OvrlPropsCatPosition=위치 tstr_OvrlPropsCatAppearance=외형 tstr_OvrlPropsCatCapture=캡처 tstr_OvrlPropsCatPerformanceMonitor=성능 모니터 tstr_OvrlPropsCatBrowser=브라우저 tstr_OvrlPropsCatAdvanced=고급 tstr_OvrlPropsCatPerformance=성능 tstr_OvrlPropsCatInterface=인터페이스 tstr_OvrlPropsPositionOrigin=기준점 tstr_OvrlPropsPositionOriginRoom=플레이 구역 tstr_OvrlPropsPositionOriginHMDXY=HMD 바닥 위치 tstr_OvrlPropsPositionOriginDashboard=대시보드 tstr_OvrlPropsPositionOriginHMD=HMD tstr_OvrlPropsPositionOriginSeatedSpace=앉은 위치 tstr_OvrlPropsPositionOriginControllerR=오른쪽 컨트롤러 tstr_OvrlPropsPositionOriginControllerL=왼쪽 컨트롤러 tstr_OvrlPropsPositionOriginTheaterScreen=시어터 스크린 tstr_OvrlPropsPositionOriginTracker1=트래커 #1 tstr_OvrlPropsPositionOriginConfigHMDXYTurning=HMD 회전에 맞춰 회전 tstr_OvrlPropsPositionOriginConfigTheaterScreenEnter=시어터 모드 진입 tstr_OvrlPropsPositionOriginConfigTheaterScreenLeave=시어터 모드 종료 tstr_OvrlPropsPositionOriginTheaterScreenTip=일부 속성은 SteamVR 시어터 스크린에 의해 제어됩니다 tstr_OvrlPropsPositionDispMode=표시 모드 tstr_OvrlPropsPositionDispModeAlways=항상 표시 tstr_OvrlPropsPositionDispModeDashboard=대시보드에서만 tstr_OvrlPropsPositionDispModeScene=게임 중에만 tstr_OvrlPropsPositionDispModeDPlus=Desktop+ 탭에서만 tstr_OvrlPropsPositionPos=위치 tstr_OvrlPropsPositionPosTip=위치는 Desktop+ 실행 중에만 변경하거나 초기화할 수 있습니다 tstr_OvrlPropsPositionChange=변경 tstr_OvrlPropsPositionReset=초기화 tstr_OvrlPropsPositionLock=잠금 tstr_OvrlPropsPositionChangeHeader=오버레이 위치 변경 tstr_OvrlPropsPositionChangeHelp=오버레이를 드래그하여 위치를 변경합니다.\n두 손 제스처 변환은 마우스 오른쪽 버튼을 길게 누릅니다. tstr_OvrlPropsPositionChangeHelpDesktop="D" 드래그 버튼을 누른 상태에서 마우스로 오버레이를 이동 또는 회전합니다 tstr_OvrlPropsPositionChangeManualAdjustment=수동 조정 tstr_OvrlPropsPositionChangeMove=이동 tstr_OvrlPropsPositionChangeRotate=회전 tstr_OvrlPropsPositionChangeForward=앞으로 이동 tstr_OvrlPropsPositionChangeBackward=뒤로 이동 tstr_OvrlPropsPositionChangeRollCW=Yaw ⟳ tstr_OvrlPropsPositionChangeRollCCW=Yaw ⟲ tstr_OvrlPropsPositionChangeLookAt=HMD 방향으로 tstr_OvrlPropsPositionChangeDragButton=D tstr_OvrlPropsPositionChangeOffset=추가 오프셋 tstr_OvrlPropsPositionChangeOffsetUpDown=상/하 오프셋 tstr_OvrlPropsPositionChangeOffsetRightLeft=좌/우 오프셋 tstr_OvrlPropsPositionChangeOffsetForwardBackward=앞/뒤 오프셋 tstr_OvrlPropsPositionChangeDragSettings=드래그 설정 tstr_OvrlPropsPositionChangeDragSettingsAutoDocking=가까운 컨트롤러에 도킹 tstr_OvrlPropsPositionChangeDragSettingsForceDistance=고정 거리 강제 tstr_OvrlPropsPositionChangeDragSettingsForceDistanceShape=형태 tstr_OvrlPropsPositionChangeDragSettingsForceDistanceShapeSphere=구 tstr_OvrlPropsPositionChangeDragSettingsForceDistanceShapeCylinder=실린더 tstr_OvrlPropsPositionChangeDragSettingsForceDistanceAutoCurve=자동 곡률 tstr_OvrlPropsPositionChangeDragSettingsForceDistanceAutoTilt=자동 기울기 tstr_OvrlPropsPositionChangeDragSettingsSnapPosition=위치 스냅 tstr_OvrlPropsPositionChangeDragSettingsSnapRotation=회전 스냅 tstr_OvrlPropsPositionChangeDragSettingsSnapRotationPitch=Pitch tstr_OvrlPropsPositionChangeDragSettingsSnapRotationYaw=Yaw tstr_OvrlPropsPositionChangeDragSettingsSnapRotationRoll=Roll tstr_OvrlPropsAppearanceWidth=너비 tstr_OvrlPropsAppearanceCurve=곡률 tstr_OvrlPropsAppearanceOpacity=불투명도 tstr_OvrlPropsAppearanceBrightness=밝기 tstr_OvrlPropsAppearanceCrop=표시 영역 지정 tstr_OvrlPropsAppearanceCropValueMax=최대 tstr_OvrlPropsCrop=표시 영역 tstr_OvrlPropsCropHelp=사각형을 드래그하여 표시 영역을 변경합니다.\n스크롤 입력이나 모서리를 드래그해 크기를 조정할 수 있습니다. tstr_OvrlPropsCropManualAdjust=수동 조정 tstr_OvrlPropsCropInvalidTip=현재 표시 영역 사각형이 유효하지 않습니다. 오버레이가 표시되지 않을 수 있습니다. tstr_OvrlPropsCropX=X tstr_OvrlPropsCropY=Y tstr_OvrlPropsCropWidth=너비 tstr_OvrlPropsCropHeight=높이 tstr_OvrlPropsCropToWindow=활성 창 표시 영역 tstr_OvrlPropsCaptureMethod=캡처 방식 tstr_OvrlPropsCaptureMethodDup=데스크톱 복제 tstr_OvrlPropsCaptureMethodGC=그래픽 캡처 tstr_OvrlPropsCaptureMethodGCUnsupportedTip=이 시스템에서는 그래픽 캡처를 지원하지 않습니다 tstr_OvrlPropsCaptureMethodGCUnsupportedPartialTip=이 시스템에서는 일부 그래픽 캡처 기능이 지원되지 않습니다 tstr_OvrlPropsCaptureSource=소스 tstr_OvrlPropsCaptureGCSource=그래픽 캡처 소스 tstr_OvrlPropsCaptureSourceUnknownWarning=이 오버레이는 알 수 없는 캡처 소스를 사용하고 있어 올바르게 동작하지 않을 수 있습니다 tstr_OvrlPropsCaptureGCStrictMatching=엄격한 창 일치 사용 tstr_OvrlPropsCaptureGCStrictMatchingTip=이 오버레이의 캡처를 복원할 때 창 제목이 완전히 일치하는 경우에만 허용합니다 tstr_OvrlPropsPerfMonDesktopModeTip=데스크톱 모드에서는 성능 모니터 오버레이가 업데이트되지 않습니다 tstr_OvrlPropsPerfMonGlobalTip=이 설정은 모든 성능 모니터 오버레이에 적용됩니다 tstr_OvrlPropsPerfMonStyle=스타일 tstr_OvrlPropsPerfMonStyleCompact=컴팩트 tstr_OvrlPropsPerfMonStyleLarge=라지 tstr_OvrlPropsPerfMonShowCPU=CPU 상태 표시 tstr_OvrlPropsPerfMonShowGPU=GPU 상태 표시 tstr_OvrlPropsPerfMonShowGraphs=그래프 표시 tstr_OvrlPropsPerfMonShowFrameStats=프레임 통계 표시 tstr_OvrlPropsPerfMonShowTime=시계 표시 tstr_OvrlPropsPerfMonShowBattery=배터리 상태 표시 tstr_OvrlPropsPerfMonShowTrackerBattery=트래커 배터리 잔량 표시 tstr_OvrlPropsPerfMonShowViveWirelessTemp=Vive 무선 온도 표시 tstr_OvrlPropsPerfMonResetValues=누적값 초기화 tstr_OvrlPropsBrowserNotAvailableTip=Desktop+ 브라우저 구성 요소가 설치되지 않았습니다 tstr_OvrlPropsBrowserCloned=복제 출력 tstr_OvrlPropsBrowserClonedTip=이 오버레이는 "%OVERLAYNAME%"의 복제본입니다.\n브라우저 속성 변경은 원본과 이를 복제한 모든 오버레이에 적용됩니다. tstr_OvrlPropsBrowserClonedConvert=독립형으로 변환 tstr_OvrlPropsBrowserURL=URL tstr_OvrlPropsBrowserURLHint=주소를 입력하세요 tstr_OvrlPropsBrowserGo=이동 tstr_OvrlPropsBrowserRestore=마지막 입력 복원 tstr_OvrlPropsBrowserWidth=너비 tstr_OvrlPropsBrowserHeight=높이 tstr_OvrlPropsBrowserZoom=줌 tstr_OvrlPropsBrowserAllowTransparency=투명도 허용 tstr_OvrlPropsBrowserAllowTransparencyTip=웹 페이지의 투명도 사용을 허용합니다.\n배경색이 지정되지 않은 사이트는 올바르게 표시되지 않을 수 있습니다. tstr_OvrlPropsBrowserRecreateContext=브라우저 컨텍스트 재생성 tstr_OvrlPropsBrowserRecreateContextTip=변경 사항을 적용하려면 브라우저 컨텍스트를 재생성해야 합니다.\n이 작업을 실행하면 페이지가 새로고침되고 방문 기록이 초기화됩니다. tstr_OvrlPropsAdvanced3D=3D tstr_OvrlPropsAdvancedHSBS=Half Side-by-Side (좌우 절반 폭) tstr_OvrlPropsAdvancedSBS=Side-by-Side (좌우) tstr_OvrlPropsAdvancedHOU=Half Over-Under (상하 절반 폭) tstr_OvrlPropsAdvancedOU=Over-Under (상하) tstr_OvrlPropsAdvanced3DSwap=좌우 화면 바꾸기 tstr_OvrlPropsAdvancedGazeFade=시선 페이드 tstr_OvrlPropsAdvancedGazeFadeAuto=자동 구성 tstr_OvrlPropsAdvancedGazeFadeDistance=거리 tstr_OvrlPropsAdvancedGazeFadeDistanceValueInf=무한 tstr_OvrlPropsAdvancedGazeFadeSensitivity=민감도 tstr_OvrlPropsAdvancedGazeFadeOpacity=대상 불투명도 tstr_OvrlPropsAdvancedInput=레이저 포인터 입력 tstr_OvrlPropsAdvancedInputInGame=게임 중 활성화 tstr_OvrlPropsAdvancedInputFloatingUI=플로팅 UI 표시 tstr_OvrlPropsAdvancedOverlayTags=오버레이 태그 tstr_OvrlPropsAdvancedOverlayTagsTip=오버레이 태그는 액션에서 오버레이를 대상으로 지정하는 데 사용됩니다 tstr_OvrlPropsPerformanceInvisibleUpdate=숨겨져 있어도 업데이트 tstr_OvrlPropsPerformanceInvisibleUpdateTip=불투명도 설정이나 시선 페이드로 숨겨져 있어도 오버레이를 업데이트합니다.\n서드파티 애플리케이션이 오버레이 내용을 접근하는 데 유용합니다.\n그 외 경우에는 권장하지 않습니다.\n오버레이가 수동 또는 표시 모드 설정으로 숨겨진 경우에는 여전히 업데이트가 중단됩니다. tstr_OvrlPropsInterfaceOverlayName=오버레이 이름 tstr_OvrlPropsInterfaceOverlayNameAuto=[자동 이름] tstr_OvrlPropsInterfaceActionOrderCustom=액션 버튼 재정의 tstr_OvrlPropsInterfaceDesktopButtons=데스크톱 버튼 표시 tstr_OvrlPropsInterfaceExtraButtons=추가 버튼 표시 ;Overlay Bar tstr_OverlayBarOvrlHide=숨기기 tstr_OverlayBarOvrlShow=표시 tstr_OverlayBarOvrlClone=복제 tstr_OverlayBarOvrlRemove=제거 tstr_OverlayBarOvrlRemoveConfirm=정말 제거하시겠습니까? tstr_OverlayBarOvrlProperties=속성... tstr_OverlayBarOvrlAddWindow=창 추가... tstr_OverlayBarTooltipOvrlAdd=오버레이 추가 tstr_OverlayBarTooltipSettings=설정 tstr_OverlayBarTooltipResetHold=길게 눌러 창 위치 초기화... ;Floating UI tstr_FloatingUIHideOverlayTip=오버레이 숨기기 tstr_FloatingUIHideOverlayHoldTip=길게 눌러 오버레이 제거... tstr_FloatingUIDragModeEnableTip=드래그 모드 활성화 tstr_FloatingUIDragModeDisableTip=드래그 모드 비활성화 tstr_FloatingUIDragModeHoldLockTip=길게 눌러 오버레이 위치 잠금... tstr_FloatingUIDragModeHoldUnlockTip=길게 눌러 오버레이 위치 잠금 해제... tstr_FloatingUIWindowAddTip=활성 창 추가 tstr_FloatingUIActionBarShowTip=액션 바 표시 tstr_FloatingUIActionBarHideTip=액션 바 숨기기 tstr_FloatingUIBrowserGoBackTip=이전 페이지로 이동 tstr_FloatingUIBrowserGoForwardTip=다음 페이지로 이동 tstr_FloatingUIBrowserRefreshTip=현재 페이지 새로고침 tstr_FloatingUIBrowserStopTip=페이지 로드 중지 tstr_FloatingUIActionBarDesktopPrev=이전 데스크톱 tstr_FloatingUIActionBarDesktopNext=다음 데스크톱 tstr_FloatingUIActionBarEmpty=활성화된 액션 없음 ;Special Actions tstr_ActionNone=[없음] tstr_ActionKeyboardShow=키보드 표시 tstr_ActionKeyboardHide=키보드 숨기기 ;Default Actions (translation IDs are matched to Action name string) tstr_DefActionShowKeyboard=키보드 표시 tstr_DefActionActiveWindowCrop=활성 창 크롭 tstr_DefActionActiveWindowCropLabel=활성\n창\n크롭 tstr_DefActionSwitchTask=작업 전환 tstr_DefActionToggleOverlays=오버레이 전환 tstr_DefActionToggleOverlaysLabel=오버레이\n전환 tstr_DefActionMiddleMouse=마우스 휠 클릭 tstr_DefActionMiddleMouseLabel=마우스\n휠\n클릭 tstr_DefActionBackMouse=마우스 뒤로가기 버튼 tstr_DefActionBackMouseLabel=마우스\n뒤로가기\n버튼 tstr_DefActionReadMe=설명서 열기 tstr_DefActionReadMeLabel=설명서\n열기 tstr_DefActionDashboardToggle=SteamVR 대시보드 전환 (디버그 명령) tstr_DefActionDashboardToggleLabel=대시보드\n전환 ;Performance Monitor (text space is very limited here, so keep it short or untranslated) tstr_PerformanceMonitorCPU=CPU tstr_PerformanceMonitorGPU=GPU tstr_PerformanceMonitorRAM=RAM: tstr_PerformanceMonitorVRAM=VRAM: tstr_PerformanceMonitorFrameTime=프레임 시간: tstr_PerformanceMonitorLoad=부하: tstr_PerformanceMonitorFPS=FPS: tstr_PerformanceMonitorFPSAverage=평균 FPS: tstr_PerformanceMonitorReprojectionRatio=리프로젝션 비율: tstr_PerformanceMonitorDroppedFrames=드롭된 프레임: tstr_PerformanceMonitorBatteryLeft=왼쪽 컨트롤러: tstr_PerformanceMonitorBatteryRight=오른쪽 컨트롤러: tstr_PerformanceMonitorBatteryHMD=헤드셋: tstr_PerformanceMonitorBatteryTracker=트래커 %ID%: tstr_PerformanceMonitorBatteryDisconnected=N/A tstr_PerformanceMonitorViveWirelessTempNotAvailable=N/A tstr_PerformanceMonitorCompactCPU=CPU tstr_PerformanceMonitorCompactGPU=GPU tstr_PerformanceMonitorCompactFPS=FPS tstr_PerformanceMonitorCompactFPSAverage=AVG tstr_PerformanceMonitorCompactReprojectionRatio=% RPR tstr_PerformanceMonitorCompactDroppedFrames=DRP tstr_PerformanceMonitorCompactBattery=BAT tstr_PerformanceMonitorCompactBatteryLeft=L tstr_PerformanceMonitorCompactBatteryRight=R tstr_PerformanceMonitorCompactBatteryHMD=H tstr_PerformanceMonitorCompactBatteryTracker=T%ID% tstr_PerformanceMonitorCompactBatteryDisconnected=N/A tstr_PerformanceMonitorCompactViveWirelessTempNotAvailable=N/A tstr_PerformanceMonitorEmpty=활성화된 성능 모니터 항목 없음 ;Aux UI tstr_AuxUIDragHintDocking=놓아서 도킹 tstr_AuxUIDragHintUndocking=놓아서 도킹 해제 tstr_AuxUIDragHintOvrlLocked=이 오버레이를 드래그하려면 오버레이 위치 잠금을 해제하세요 tstr_AuxUIDragHintOvrlTheaterScreenBlocked=오버레이 위치는 SteamVR 시어터 스크린에서 제어합니다 tstr_AuxUIGazeFadeAutoHint=오버레이 중앙을 보고 %SECONDS%초간 기다리세요... tstr_AuxUIGazeFadeAutoHintSingular=오버레이 중앙을 보고 %SECONDS%초간 기다리세요... tstr_AuxUIQuickStartWelcomeHeader=Desktop+에 오신 것을 환영합니다! tstr_AuxUIQuickStartWelcomeBody=이 짧은 가이드는 프로그램의 기본 사항을 소개합니다.\n자세한 내용은 설명서와 사용자 가이드를 참조하세요.\n\n이 단계를 건너뛰려면 [닫기]를 누르세요. tstr_AuxUIQuickStartOverlaysHeader=오버레이 tstr_AuxUIQuickStartOverlaysBody=Desktop+를 사용하면 데스크톱, 개별 창 등을 미러링하는 오버레이를 만들 수 있습니다.\n생성한 모든 오버레이는 아래 오버레이 바에 표시됩니다.\n\n오버레이 속성은 오버레이 아이콘을 클릭하고 [속성...]을 선택해 변경할 수 있습니다. tstr_AuxUIQuickStartOverlaysBody2=[+] 버튼을 눌러 목록에서 캡처 소스/오버레이 유형을 선택하면 새 오버레이를 만들 수 있습니다.\n웹 브라우저 오버레이와 같은 일부 유형은 해당 구성 요소가 설치되어 있어야 사용할 수 있습니다.\n\n개별 오버레이 또는 전체 레이아웃을 프로필로 저장할 수 있으며, 현재 구성은 세션 간 자동으로 기억됩니다. tstr_AuxUIQuickStartOverlayPropertiesHeader=오버레이 속성 tstr_AuxUIQuickStartOverlayPropertiesBody=오버레이에는 다양한 맞춤 설정 옵션이 있습니다.\n기준점과 표시 모드는 오버레이가 표시되는 위치와 시점을 설정합니다.\n표시되어야 할 오버레이가 보이지 않으면 이 설정을 확인하세요.\n위치를 초기화하면 도움이 될 수 있습니다.\n\n또한 오버레이를 컨트롤러 근처로 드래그하면 도킹할 수 있습니다. tstr_AuxUIQuickStartOverlayPropertiesBody2=일부 속성은 기본적으로 숨겨져 있습니다.\n모든 옵션을 보려면 설정 창에서 [고급 설정 표시]를 켜세요.\n\nUI 창 위치는 해당 버튼을 길게 눌러 초기화할 수 있습니다.\n더블 클릭이나 우클릭은 오버레이 버튼에서도 단축 토글로 동작합니다. tstr_AuxUIQuickStartSettingsHeader=설정 tstr_AuxUIQuickStartSettingsBody=설정 창에는 Desktop+의 전역 설정이 모두 포함되어 있습니다.\n오버레이 바 오른쪽 끝의 톱니바퀴 버튼을 눌러 열 수 있습니다.\n\n오버레이와 마찬가지로 설정 변경 사항은 자동으로 적용·저장됩니다. tstr_AuxUIQuickStartProfilesHeader=프로필 tstr_AuxUIQuickStartProfilesBody=Desktop+에는 두 가지 프로필이 있습니다.\n\n오버레이 프로필:\n하나 이상의 오버레이와 해당 속성을 저장합니다.\n수동으로 불러오거나, 액션 및 앱 프로필에 따라 자동 불러올 수 있습니다.\n\n앱 프로필:\nSteamVR 앱 실행 시 자동으로 불러올 오버레이 프로필과 액션을 지정합니다. tstr_AuxUIQuickStartActionsHeader=액션 tstr_AuxUIQuickStartActionsBody=액션은 컨트롤러 입력이나 앱 프로필에 할당하거나, 오버레이의 액션 바에 추가할 수 있는 일련의 명령입니다.\n데스크톱 입력 시뮬레이션부터 오버레이 레이아웃 변경, 외부 프로그램 실행까지 가능합니다.\n\nDesktop+에는 몇 가지 예시 액션이 포함되어 있습니다. tstr_AuxUIQuickStartActionsBody2=기본적으로 액션은 실행된 오버레이(버튼 클릭·컨트롤러 입력) 또는 마지막으로 클릭된 포커스 오버레이를 대상으로 합니다.\n대상 오버레이가 중요하지 않은 경우도 있지만, 경우에 따라 특정 오버레이나 여러 개를 지정하면 유용할 수 있습니다. tstr_AuxUIQuickStartOverlayTagsHeader=오버레이 태그 tstr_AuxUIQuickStartOverlayTagsBody=오버레이 태그에는 자동 태그(녹색)와 사용자 정의 태그가 있습니다.\n자동 태그는 해당 속성에 따라 자동 부여되며, 사용자 태그는 오버레이 속성 창에서 수동 지정할 수 있습니다.\n\n전역 단축키는 컨트롤러 버튼에 직접 바인딩되지 않으므로, SteamVR 입력 바인딩에서 매핑해야 합니다. tstr_AuxUIQuickStartSettingsEndBody=설정은 다양하니 자유롭게 시도해 보세요.\n\n문제가 생기면 [기본 설정 복원]을 눌러 특정 항목만 초기화할 수도 있습니다. tstr_AuxUIQuickStartFloatingUIHeader=플로팅 UI tstr_AuxUIQuickStartFloatingUIBody=플로팅 UI는 오버레이를 가리킬 때 나타납니다.\n대시보드에서는 다른 오버레이를 가리키지 않을 때 항상 표시됩니다.\n\n기본 컨트롤, 액션 버튼 섹션, 기타 오버레이별 컨트롤이 포함되며, 각 오버레이 속성에서 표시 여부를 설정할 수 있습니다. tstr_AuxUIQuickStartDesktopModeHeader=데스크톱 모드 tstr_AuxUIQuickStartDesktopModeBody=Desktop+는 데스크톱 창에서도 설정할 수 있어, 키보드 입력이 잦거나 컨트롤러 없이 변경할 때 유용합니다.\n기능은 동일하지만 VR 키보드 레이아웃 편집기는 데스크톱 모드에서만 사용할 수 있습니다.\n\n설정 창의 [문제 해결] 섹션이나 시스템 트레이 아이콘에서 전환할 수 있습니다. tstr_AuxUIQuickStartEndHeader=설명서 & 사용자 가이드 tstr_AuxUIQuickStartEndBody=이 정도면 Desktop+를 시작하기 충분합니다.\n\n문제가 있으면 설명서를 참고하세요. 액션 바 버튼으로 열 수 있습니다.\n자세한 설명과 가이드는 사용자 가이드에 있습니다.\n\n이 가이드를 다시 보려면 [기본 설정 복원] 페이지 하단의 [퀵 스타트 가이드 표시]를 누르세요. tstr_AuxUIQuickStartButtonNext=다음 페이지 tstr_AuxUIQuickStartButtonPrev=이전 페이지 tstr_AuxUIQuickStartButtonClose=닫기 ;Desktop Mode tstr_DesktopModeCatTools=도구 tstr_DesktopModeCatOverlays=오버레이 tstr_DesktopModeToolSettings=설정 tstr_DesktopModeToolActions=액션 tstr_DesktopModeOverlayListAdd=오버레이 추가 tstr_DesktopModePageAddWindowOverlayTitle=창 오버레이 추가 tstr_DesktopModePageAddWindowOverlayHeader=창 선택 ;Keyboard Editor tstr_KeyboardEditorKeyListTitle=키 목록 tstr_KeyboardEditorKeyListTabContextReplace=내용 교체... tstr_KeyboardEditorKeyListTabContextClear=서브 레이아웃 지우기 tstr_KeyboardEditorKeyListRow=행 %ID% tstr_KeyboardEditorKeyListSpacing=[간격] tstr_KeyboardEditorKeyListKeyAdd=추가 tstr_KeyboardEditorKeyListKeyDuplicate=복제 tstr_KeyboardEditorKeyListKeyRemove=삭제 tstr_KeyboardEditorKeyPropertiesTitle=키 속성 tstr_KeyboardEditorKeyPropertiesNoSelection=선택된 키 없음 tstr_KeyboardEditorKeyPropertiesType=유형 tstr_KeyboardEditorKeyPropertiesTypeBlank=빈 공간 tstr_KeyboardEditorKeyPropertiesTypeVirtualKey=가상 키 tstr_KeyboardEditorKeyPropertiesTypeVirtualKeyToggle=가상 키 (토글) tstr_KeyboardEditorKeyPropertiesTypeVirtualKeyIsoEnter=가상 키 (ISO-Enter) tstr_KeyboardEditorKeyPropertiesTypeString=문자열 tstr_KeyboardEditorKeyPropertiesTypeSublayoutToggle=서브 레이아웃 전환 tstr_KeyboardEditorKeyPropertiesTypeAction=액션 tstr_KeyboardEditorKeyPropertiesTypeVirtualKeyIsoEnterTip=인접한 두 행에 "가상 키 (ISO-Enter)"를 배치해 ISO-Enter 모양 키를 만듭니다.\n각 서브 레이아웃당 하나만 허용됩니다. tstr_KeyboardEditorKeyPropertiesTypeStringTip=기본 문자가 아닌 키에는 문자열 유형을 사용해, 실제 키보드 레이아웃에 맞는 조합을 찾아 호환성을 높입니다. tstr_KeyboardEditorKeyPropertiesSize=크기 tstr_KeyboardEditorKeyPropertiesLabel=레이블 tstr_KeyboardEditorKeyPropertiesKeyCode=키 코드 tstr_KeyboardEditorKeyPropertiesString=문자열 tstr_KeyboardEditorKeyPropertiesSublayout=서브 레이아웃 tstr_KeyboardEditorKeyPropertiesAction=액션 tstr_KeyboardEditorKeyPropertiesCluster=그룹 tstr_KeyboardEditorKeyPropertiesClusterTip=그룹은 특정 키 로드를 비활성화할 때 사용됩니다.\n주변 빈 공간은 제거되지 않으니, 올바른 전환을 위해 빈 공간 키도 그룹에 배정하세요. tstr_KeyboardEditorKeyPropertiesBlockModifiers=조합 키 차단 tstr_KeyboardEditorKeyPropertiesBlockModifiersTip=키를 누르는 동안 모든 조합 키를 해제합니다. tstr_KeyboardEditorKeyPropertiesNoRepeat=반복 안 함 tstr_KeyboardEditorKeyPropertiesNoRepeatTip=키 반복이 켜져 있어도, 누르고 있는 동안 반복 입력을 차단합니다. tstr_KeyboardEditorMetadataTitle=레이아웃 메타데이터 tstr_KeyboardEditorMetadataName=이름 tstr_KeyboardEditorMetadataAuthor=작성자 tstr_KeyboardEditorMetadataHasAltGr=AltGr 키 사용 tstr_KeyboardEditorMetadataHasAltGrTip=오른쪽 Alt 키를 누르면 AltGr 서브 레이아웃으로 전환 tstr_KeyboardEditorMetadataClusterPreview=그룹 미리보기: tstr_KeyboardEditorMetadataSave=저장... tstr_KeyboardEditorMetadataLoad=불러오기... tstr_KeyboardEditorMetadataSavePopupTitle=키보드 레이아웃 저장 tstr_KeyboardEditorMetadataSavePopupFilename=파일 이름 tstr_KeyboardEditorMetadataSavePopupFilenameBlankTip=파일 이름은 비워둘 수 없습니다 tstr_KeyboardEditorMetadataSavePopupConfirm=레이아웃 저장 tstr_KeyboardEditorMetadataSavePopupConfirmError=레이아웃 저장 실패 tstr_KeyboardEditorMetadataLoadPopupTitle=키보드 레이아웃 불러오기 tstr_KeyboardEditorMetadataLoadPopupConfirm=레이아웃 불러오기 tstr_KeyboardEditorPreviewTitle=키보드 미리보기 tstr_KeyboardEditorSublayoutBase=Base tstr_KeyboardEditorSublayoutShift=Shift tstr_KeyboardEditorSublayoutAltGr=AltGr tstr_KeyboardEditorSublayoutAux=Aux ;General Dialog Strings tstr_DialogOk=확인 tstr_DialogCancel=취소 tstr_DialogDone=완료 tstr_DialogUndo=실행 취소 tstr_DialogRedo=다시 실행 tstr_DialogColorPickerHeader=색 선택 tstr_DialogColorPickerCurrent=현재 tstr_DialogColorPickerOriginal=원본 tstr_DialogProfilePickerHeader=프로필 선택 tstr_DialogProfilePickerNone=[없음] tstr_DialogActionPickerHeader=액션 선택 tstr_DialogActionPickerEmpty=사용 가능한 액션 없음 tstr_DialogIconPickerHeader=아이콘 선택 tstr_DialogIconPickerHeaderTip=커스텀 아이콘은 "images\icons\" 디렉토리에 PNG 파일로 추가하세요 tstr_DialogIconPickerNone=[아이콘 없음] tstr_DialogKeyCodePickerHeader=키 코드 선택 tstr_DialogKeyCodePickerHeaderHotkey=단축키 선택 tstr_DialogKeyCodePickerModifiers=조합 키 tstr_DialogKeyCodePickerKeyCode=키 코드 tstr_DialogKeyCodePickerKeyCodeHint=목록 필터 tstr_DialogKeyCodePickerKeyCodeNone=[없음] tstr_DialogKeyCodePickerFromInput=입력에서 가져오기... tstr_DialogKeyCodePickerFromInputPopup=아무 키나 마우스 버튼을 누르세요... tstr_DialogKeyCodePickerFromInputPopupNoMouse=아무 키나 누르세요... tstr_DialogWindowPickerHeader=창 선택 tstr_DialogInputTagsHint=필터 또는 새 태그 추가 ;Source Strings tstr_SourceDesktopAll=통합 데스크톱 tstr_SourceDesktopID=데스크톱 %ID% tstr_SourceWinRTNone=[캡처 대상 없음] tstr_SourceWinRTUnknown=[알 수 없는 창] tstr_SourceWinRTClosed=[닫힘]: tstr_SourcePerformanceMonitor=성능 모니터 tstr_SourceBrowser=브라우저 tstr_SourceBrowserNoPage=[페이지 없음] ;Notification Icon tstr_NotificationIconRestoreVR=VR 인터페이스 복원 tstr_NotificationIconOpenOnDesktop=데스크톱에서 설정 열기 tstr_NotificationIconQuit=종료 ;Notifications tstr_NotificationInitialStartupTitleVR=초기 설정 tstr_NotificationInitialStartupTitleDesktop=Desktop+ 초기 설정 tstr_NotificationInitialStartupMessage=Desktop+가 SteamVR에 정상적으로 추가되어, 이제 SteamVR 실행 시 자동으로 실행됩니다. ;Browser tstr_BrowserErrorPageTitle=페이지 로드 오류 - Desktop+ tstr_BrowserErrorPageHeading=페이지를 불러올 수 없습니다 tstr_BrowserErrorPageMessage=%URL% 로드 중 오류 발생: %ERROR% ================================================ FILE: assets/lang/zh_CN.ini ================================================ [TranslationInfo] Name=简体中文 (Simplified Chinese) Author=Xuan25_瑄 Locale=zh-CN ;如果该语言在默认字体或其加载顺序上存在问题，则可以在此处定义一个不同的字体，该字体将首先加载 ;这应该是带有扩展名的文件名，会从操作系统的字体文件夹中加载，如果找不到，则从 "lang" 文件夹加载 PreferredFont=msyh.ttc ;将文件名设置为 ISO 639-1 语言代码以支持自动检测，如有必要，后面跟上带下划线的 ISO 3166-1 地区代码 ;要翻译 SteamVR 输入绑定，请在“input”文件夹中添加新的本地化文件，并在 action_manifest.json 中进行相应调整 [Strings] ;设置窗口 tstr_SettingsWindowTitle=Desktop+ 设置 tstr_SettingsCatInterface=界面 tstr_SettingsCatEnvironment=环境 tstr_SettingsCatProfiles=配置文件 tstr_SettingsCatActions=操作 tstr_SettingsCatKeyboard=键盘 tstr_SettingsCatMouse=鼠标 tstr_SettingsCatLaserPointer=激光指针 tstr_SettingsCatWindowOverlays=窗口叠加 tstr_SettingsCatBrowser=浏览器 tstr_SettingsCatPerformance=性能 tstr_SettingsCatVersionInfo=版本信息 tstr_SettingsCatWarnings=警告 tstr_SettingsCatStartup=启动 tstr_SettingsCatTroubleshooting=故障排除 tstr_SettingsWarningPrefix=警告： tstr_SettingsWarningCompositorResolution=SteamVR 合成器分辨率低于 100%！这会影响叠加的渲染质量。 tstr_SettingsWarningCompositorQuality=SteamVR 叠加渲染质量未设置为高！ tstr_SettingsWarningProcessElevated=Desktop+ 正在以管理员权限运行！ tstr_SettingsWarningElevatedMode=管理员权限模式已激活！ tstr_SettingsWarningBrowserMissing=正在使用浏览器叠加，但 Desktop+ 浏览器组件当前不可用。 tstr_SettingsWarningBrowserMismatch=已安装的 Desktop+ 浏览器组件与此版本的 Desktop+ 不兼容！ tstr_SettingsWarningElevatedProcessFocus=一个以管理员权限运行的进程当前拥有焦点！\nDesktop+ 无法模拟输入。 tstr_SettingsWarningUIAccessLost=Desktop+ 已不再以 UIAccess 权限运行！ tstr_SettingsWarningOverlayCreationErrorLimit=创建叠加失败！（超过最大叠加数上限） tstr_SettingsWarningOverlayCreationErrorOther=创建叠加失败！（%ERRORNAME%） tstr_SettingsWarningGraphicsCaptureError=图形捕获线程出现意外错误！（%ERRORCODE%） tstr_SettingsWarningAppProfileActive=%APPNAME% 的应用程序配置文件已覆写了当前叠加布局。\n在此激活期间对叠加所做的更改不会自动保存。 tstr_SettingsWarningConfigMigrated=从旧版本 Desktop+ 的配置和配置文件已迁移到新的格式。\n原文件未被删除，仍可与旧版本的应用程序一起使用。\n如需从头开始，可在 [恢复默认设置] 中进行重置。 tstr_SettingsWarningMenuDontShowAgain=不再显示 tstr_SettingsWarningMenuDismiss=忽略 tstr_SettingsInterfaceLanguage=语言 tstr_SettingsInterfaceLanguageCommunity=社区翻译：%AUTHOR% tstr_SettingsInterfaceLanguageIncompleteWarning=翻译可能不完整 tstr_SettingsInterfaceAdvancedSettings=显示高级设置 tstr_SettingsInterfaceAdvancedSettingsTip=显示高级和不常用的设置 tstr_SettingsInterfaceBlankSpaceDrag=单击空白区域时可拖动窗口 tstr_SettingsInterfacePersistentUI=持久化界面 tstr_SettingsInterfacePersistentUIManage=管理 tstr_SettingsInterfaceDesktopButtons=桌面按钮显示样式 tstr_SettingsInterfaceDesktopButtonsNone=无 tstr_SettingsInterfaceDesktopButtonsIndividual=单独桌面 tstr_SettingsInterfaceDesktopButtonsCycle=循环按钮 tstr_SettingsInterfaceDesktopButtonsAddCombined=增加合并桌面按钮 tstr_SettingsInterfacePersistentUIHelp=Desktop+ 会分别记住界面窗口在普通使用（全局）和在 Desktop+ 的 SteamVR 主面板标签页（Desktop+ Tab）中的状态。 tstr_SettingsInterfacePersistentUIHelp2=以下控件可用于直接管理那些窗口的状态。\n请注意，一些状态可能需要重置位置才能让窗口重回可见范围。 tstr_SettingsInterfacePersistentUIWindowsHeader=窗口 tstr_SettingsInterfacePersistentUIWindowsSettings=设置 tstr_SettingsInterfacePersistentUIWindowsProperties=叠加属性 tstr_SettingsInterfacePersistentUIWindowsKeyboard=Desktop+ 键盘 tstr_SettingsInterfacePersistentUIWindowsStateGlobal=全局 tstr_SettingsInterfacePersistentUIWindowsStateDashboardTab=Desktop+ 标签页 tstr_SettingsInterfacePersistentUIWindowsStateVisible=可见 tstr_SettingsInterfacePersistentUIWindowsStatePinned=固定 tstr_SettingsInterfacePersistentUIWindowsStatePosition=位置 tstr_SettingsInterfacePersistentUIWindowsStatePositionReset=重置 tstr_SettingsInterfacePersistentUIWindowsStateSize=大小 tstr_SettingsInterfacePersistentUIWindowsStateLaunchRestore=在 Desktop+ 启动时恢复状态 tstr_SettingsEnvironmentBackgroundColor=背景颜色 tstr_SettingsEnvironmentBackgroundColorDispModeNever=从不显示 tstr_SettingsEnvironmentBackgroundColorDispModeDPlusTab=仅在 Desktop+ 标签页中显示 tstr_SettingsEnvironmentBackgroundColorDispModeAlways=始终显示 tstr_SettingsEnvironmentDimInterface=界面变暗 tstr_SettingsEnvironmentDimInterfaceTip=在 Desktop+ 主面板标签页打开时，使 SteamVR 主面板和 Desktop+ 界面变暗 tstr_SettingsProfilesOverlays=叠加配置文件 tstr_SettingsProfilesApps=应用程序配置文件 tstr_SettingsProfilesManage=管理 tstr_SettingsProfilesOverlaysHeader=管理叠加配置文件 tstr_SettingsProfilesOverlaysNameDefault=默认 tstr_SettingsProfilesOverlaysNameNew=[新配置文件] tstr_SettingsProfilesOverlaysNameNewBase=配置文件 %ID% tstr_SettingsProfilesOverlaysProfileLoad=加载配置文件 tstr_SettingsProfilesOverlaysProfileAdd=从配置文件添加叠加 tstr_SettingsProfilesOverlaysProfileSave=保存当前叠加 tstr_SettingsProfilesOverlaysProfileDelete=删除配置文件 tstr_SettingsProfilesOverlaysProfileDeleteConfirm=确定删除？ tstr_SettingsProfilesOverlaysProfileFailedLoad=加载配置文件失败 tstr_SettingsProfilesOverlaysProfileFailedDelete=删除配置文件失败 tstr_SettingsProfilesOverlaysProfileAddSelectHeader=从配置文件中选择要添加的叠加 tstr_SettingsProfilesOverlaysProfileAddSelectEmpty=此配置文件中不包含任何叠加。 tstr_SettingsProfilesOverlaysProfileAddSelectDo=添加所选叠加 tstr_SettingsProfilesOverlaysProfileAddSelectAll=全选 tstr_SettingsProfilesOverlaysProfileAddSelectNone=全不选 tstr_SettingsProfilesOverlaysProfileSaveSelectHeader=保存当前叠加 tstr_SettingsProfilesOverlaysProfileSaveSelectName=配置文件名称 tstr_SettingsProfilesOverlaysProfileSaveSelectNameErrorBlank=名称不能为空 tstr_SettingsProfilesOverlaysProfileSaveSelectNameErrorTaken=名称已被占用 tstr_SettingsProfilesOverlaysProfileSaveSelectHeaderList=选择要保存到配置文件的叠加 tstr_SettingsProfilesOverlaysProfileSaveSelectDo=保存所选叠加 tstr_SettingsProfilesOverlaysProfileSaveSelectDoFailed=保存配置文件失败 tstr_SettingsProfilesAppsHeader=管理应用程序配置文件 tstr_SettingsProfilesAppsHeaderNoVRTip=Desktop+ 未在运行 VR 时，仅会列出已存在的应用程序配置文件 tstr_SettingsProfilesAppsListEmpty=暂无应用程序 tstr_SettingsProfilesAppsProfileHeaderActive=（当前激活） tstr_SettingsProfilesAppsProfileEnabled=当应用程序运行时激活 tstr_SettingsProfilesAppsProfileOverlayProfile=叠加配置文件 tstr_SettingsProfilesAppsProfileActionEnter=进入时操作 tstr_SettingsProfilesAppsProfileActionLeave=退出时操作 tstr_SettingsActionsManage=操作 tstr_SettingsActionsManageButton=管理 tstr_SettingsActionsButtonsOrderDefault=操作按钮（默认） tstr_SettingsActionsButtonsOrderOverlayBar=操作按钮（叠加栏） tstr_SettingsActionsShowBindings=显示控制器绑定 tstr_SettingsActionsActiveShortcuts=激活的控制器按钮 tstr_SettingsActionsActiveShortcutsTip=指向叠加时的控制器绑定。\n可通过 VR 主面板的控制器绑定界面来更改使用哪些按键。 tstr_SettingsActionsActiveShortuctsHome=“返回首页” tstr_SettingsActionsActiveShortuctsBack=“后退” tstr_SettingsActionsGlobalShortcuts=全局控制器按钮 tstr_SettingsActionsGlobalShortcutsTip=在主面板关闭且未指向叠加时的控制器绑定。\n可通过 Desktop+ 的控制器绑定来配置这些按键。 tstr_SettingsActionsGlobalShortcutsEntry=全局快捷键 #%ID% tstr_SettingsActionsGlobalShortcutsAdd=添加快捷键 tstr_SettingsActionsGlobalShortcutsRemove=移除最后一个快捷键 tstr_SettingsActionsHotkeys=热键 tstr_SettingsActionsHotkeysTip=全系统范围的键盘快捷键。\n热键会拦截其他应用程序对该组合键的接收；如果该组合键已被其他地方注册，可能无法生效。 tstr_SettingsActionsHotkeysAdd=添加热键 tstr_SettingsActionsHotkeysRemove=移除 tstr_SettingsActionsTableHeaderAction=操作 tstr_SettingsActionsTableHeaderShortcut=快捷键 tstr_SettingsActionsTableHeaderHotkey=热键 tstr_SettingsActionsManageHeader=管理操作 tstr_SettingsActionsManageCopyUID=复制操作 UID 到剪贴板 tstr_SettingsActionsManageNew=新建操作... tstr_SettingsActionsManageEdit=编辑操作 tstr_SettingsActionsManageDuplicate=复制操作 tstr_SettingsActionsManageDelete=删除操作 tstr_SettingsActionsManageDeleteConfirm=确定删除？ tstr_SettingsActionsManageDuplicatedName=%NAME%（副本） tstr_SettingsActionsEditHeader=编辑操作 tstr_SettingsActionsEditName=名称 tstr_SettingsActionsEditNameTranslatedTip=此操作当前使用翻译字符串 ID 作为名称，会自动匹配所选应用语言 tstr_SettingsActionsEditTarget=目标 tstr_SettingsActionsEditTargetDefault=默认 tstr_SettingsActionsEditTargetDefaultTip=目标为激活此操作的叠加，如果不适用，则目标为当前拥有焦点的叠加 tstr_SettingsActionsEditTargetUseTags=使用标签 tstr_SettingsActionsEditTargetActionTarget=操作目标 tstr_SettingsActionsEditHeaderAppearance=按钮外观 tstr_SettingsActionsEditIcon=图标 tstr_SettingsActionsEditLabel=标签 tstr_SettingsActionsEditLabelTranslatedTip=此操作当前使用翻译字符串 ID 作为标签，会自动匹配所选应用语言 tstr_SettingsActionsEditHeaderCommands=命令 tstr_SettingsActionsEditNameNew=新操作 tstr_SettingsActionsEditCommandAdd=添加命令 tstr_SettingsActionsEditCommandDelete=删除命令 tstr_SettingsActionsEditCommandDeleteConfirm=确定删除？ tstr_SettingsActionsEditCommandType=命令类型 tstr_SettingsActionsEditCommandTypeNone=无 tstr_SettingsActionsEditCommandTypeKey=按键 tstr_SettingsActionsEditCommandTypeMousePos=设置鼠标位置 tstr_SettingsActionsEditCommandTypeString=输入字符串 tstr_SettingsActionsEditCommandTypeLaunchApp=启动应用程序 tstr_SettingsActionsEditCommandTypeShowKeyboard=显示键盘 tstr_SettingsActionsEditCommandTypeCropActiveWindow=裁剪至当前活动窗口 tstr_SettingsActionsEditCommandTypeShowOverlay=显示叠加 tstr_SettingsActionsEditCommandTypeSwitchTask=切换任务 tstr_SettingsActionsEditCommandTypeLoadOverlayProfile=加载叠加配置文件 tstr_SettingsActionsEditCommandTypeUnknown=未知 tstr_SettingsActionsEditCommandVisibilityToggle=切换 tstr_SettingsActionsEditCommandVisibilityShow=始终显示 tstr_SettingsActionsEditCommandVisibilityHide=始终隐藏 tstr_SettingsActionsEditCommandUndo=在松开时撤销 tstr_SettingsActionsEditCommandKeyCode=按键码 tstr_SettingsActionsEditCommandKeyToggle=按键切换 tstr_SettingsActionsEditCommandMouseX=X tstr_SettingsActionsEditCommandMouseY=Y tstr_SettingsActionsEditCommandMouseUseCurrent=使用当前鼠标位置 tstr_SettingsActionsEditCommandString=字符串 tstr_SettingsActionsEditCommandPath=可执行文件路径 tstr_SettingsActionsEditCommandPathTip=这也可以是一个普通文件或 URL tstr_SettingsActionsEditCommandArgs=应用程序参数 tstr_SettingsActionsEditCommandArgsTip=这些会传递给应用程序。\n如果不确定，可以留空。 tstr_SettingsActionsEditCommandVisibility=可见性 tstr_SettingsActionsEditCommandSwitchingMethod=切换方法 tstr_SettingsActionsEditCommandSwitchingMethodSwitcher=显示任务切换器 tstr_SettingsActionsEditCommandSwitchingMethodFocus=聚焦窗口 tstr_SettingsActionsEditCommandWindow=窗口 tstr_SettingsActionsEditCommandWindowNone=[无窗口] tstr_SettingsActionsEditCommandWindowStrictMatchingTip=在寻找要切换的窗口时，仅允许精确匹配窗口标题 tstr_SettingsActionsEditCommandCursorWarp=将光标移至该窗口 tstr_SettingsActionsEditCommandProfile=配置文件 tstr_SettingsActionsEditCommandProfileClear=移除现有叠加 tstr_SettingsActionsEditCommandDescNone=无命令 tstr_SettingsActionsEditCommandDescKey=按下按键 “%KEYNAME%” tstr_SettingsActionsEditCommandDescKeyToggle=切换按键 “%KEYNAME%” tstr_SettingsActionsEditCommandDescMousePos=设置鼠标位置到 %X%, %Y% tstr_SettingsActionsEditCommandDescString=输入字符串 “%STRING%” tstr_SettingsActionsEditCommandDescLaunchApp=启动应用程序 “%APP%” %ARGSOPT% tstr_SettingsActionsEditCommandDescLaunchAppArgsOpt=“%ARGS%” tstr_SettingsActionsEditCommandDescKeyboardToggle=切换键盘 tstr_SettingsActionsEditCommandDescKeyboardShow=显示键盘 tstr_SettingsActionsEditCommandDescKeyboardHide=隐藏键盘 tstr_SettingsActionsEditCommandDescCropWindow=裁剪至当前活动窗口 tstr_SettingsActionsEditCommandDescOverlayToggle=切换叠加：%TAGS% tstr_SettingsActionsEditCommandDescOverlayShow=显示叠加：%TAGS% tstr_SettingsActionsEditCommandDescOverlayHide=隐藏叠加：%TAGS% tstr_SettingsActionsEditCommandDescOverlayTargetDefault=[操作目标] tstr_SettingsActionsEditCommandDescSwitchTask=切换任务 tstr_SettingsActionsEditCommandDescSwitchTaskWindow=切换到窗口 “%WINDOW%” tstr_SettingsActionsEditCommandDescLoadOverlayProfile=加载叠加配置文件 “%PROFILE%” tstr_SettingsActionsEditCommandDescLoadOverlayProfileAdd=添加叠加配置文件 “%PROFILE%” tstr_SettingsActionsEditCommandDescUnknown=未知命令 tstr_SettingsActionsOrderHeader=更改操作顺序 tstr_SettingsActionsOrderButtonLabel=已选择 %COUNT% 个操作 tstr_SettingsActionsOrderButtonLabelSingular=已选择 %COUNT% 个操作 tstr_SettingsActionsOrderNoActions=未选择任何操作 tstr_SettingsActionsOrderAdd=添加操作... tstr_SettingsActionsOrderRemove=移除操作 tstr_SettingsActionsAddSelectorHeader=选择要添加的操作 tstr_SettingsActionsAddSelectorAdd=添加所选操作 tstr_SettingsKeyboardLayout=键盘布局 tstr_SettingsKeyboardSize=大小 tstr_SettingsKeyboardBehavior=行为 tstr_SettingsKeyboardStickyMod=粘滞修饰键 tstr_SettingsKeyboardKeyRepeat=按键重复 tstr_SettingsKeyboardAutoShow=自动显示 tstr_SettingsKeyboardAutoShowDesktopOnly=自动显示 tstr_SettingsKeyboardAutoShowDesktop=针对桌面与窗口叠加 tstr_SettingsKeyboardAutoShowDesktopTip=实验性功能。并非所有应用都支持。 tstr_SettingsKeyboardAutoShowBrowser=针对浏览器叠加 tstr_SettingsKeyboardLayoutAuthor=作者：%AUTHOR% tstr_SettingsKeyboardKeyClusters=键簇 tstr_SettingsKeyboardKeyClusterBase=基本 tstr_SettingsKeyboardKeyClusterFunction=功能 tstr_SettingsKeyboardKeyClusterNavigation=导航 tstr_SettingsKeyboardKeyClusterNumpad=数字小键盘 tstr_SettingsKeyboardKeyClusterExtra=额外 tstr_SettingsKeyboardSwitchToEditor=切换到键盘布局编辑器 tstr_SettingsMouseShowCursor=显示鼠标指针 tstr_SettingsMouseShowCursorGCUnsupported=此系统不支持在图形捕获（Graphics Capture）叠加中禁用光标 tstr_SettingsMouseShowCursorGCActiveWarning=当前激活的图形捕获镜像可能会阻止桌面复制叠加隐藏光标 tstr_SettingsMouseScrollSmooth=使用平滑滚动 tstr_SettingsMouseSimulatePen=模拟为笔输入 tstr_SettingsMouseSimulatePenUnsupported=此系统不支持笔输入模拟 tstr_SettingsMouseAllowLaserPointerOverride=允许激光指针覆写 tstr_SettingsMouseAllowLaserPointerOverrideTip=当物理鼠标快速移动时，自动禁用激光指针。\n单击叠加可重新启用激光指针。 tstr_SettingsMouseDoubleClickAssist=双击辅助 tstr_SettingsMouseDoubleClickAssistTip=在设定时间内冻结鼠标位置，以便更容易进行双击 tstr_SettingsMouseDoubleClickAssistTipValueOff=关闭 tstr_SettingsMouseDoubleClickAssistTipValueAuto=自动 tstr_SettingsMouseSmoothing=输入平滑 tstr_SettingsMouseSmoothingLevelNone=无 tstr_SettingsMouseSmoothingLevelVeryLow=极低 tstr_SettingsMouseSmoothingLevelLow=低 tstr_SettingsMouseSmoothingLevelMedium=中 tstr_SettingsMouseSmoothingLevelHigh=高 tstr_SettingsMouseSmoothingLevelVeryHigh=极高 tstr_SettingsLaserPointerTip=以下设置适用于在关闭 SteamVR 主面板时 Desktop+ 的激光指针 tstr_SettingsLaserPointerBlockInput=激光指针激活时阻止游戏输入 tstr_SettingsLaserPointerAutoToggleDistance=自动激活的最大距离 tstr_SettingsLaserPointerAutoToggleDistanceValueOff=关闭 tstr_SettingsLaserPointerHMDPointer=基于视线的头显指针 tstr_SettingsLaserPointerHMDPointerTableHeaderInputAction=输入操作 tstr_SettingsLaserPointerHMDPointerTableHeaderBinding=键盘按键 tstr_SettingsLaserPointerHMDPointerTableBindingToggle=切换激光指针 tstr_SettingsLaserPointerHMDPointerTableBindingLeft=鼠标左键 tstr_SettingsLaserPointerHMDPointerTableBindingRight=鼠标右键 tstr_SettingsLaserPointerHMDPointerTableBindingMiddle=鼠标中键 tstr_SettingsLaserPointerHMDPointerTableBindingDrag=拖动叠加 tstr_SettingsWindowOverlaysAutoFocus=指向叠加时自动聚焦窗口 tstr_SettingsWindowOverlaysKeepOnScreen=使窗口保持在屏幕内 tstr_SettingsWindowOverlaysKeepOnScreenTip=若窗口超出屏幕工作区域，则自动移动它至可见范围内 tstr_SettingsWindowOverlaysAutoSizeOverlay=当窗口调整大小时同步调整叠加大小 tstr_SettingsWindowOverlaysFocusSceneApp=从叠加移开激光指针后聚焦游戏 tstr_SettingsWindowOverlaysFocusSceneAppDashboard=关闭主面板后聚焦游戏 tstr_SettingsWindowOverlaysOnWindowDrag=窗口拖动时 tstr_SettingsWindowOverlaysOnWindowDragDoNothing=不执行任何操作 tstr_SettingsWindowOverlaysOnWindowDragBlock=阻止拖动 tstr_SettingsWindowOverlaysOnWindowDragOverlay=拖动叠加 tstr_SettingsWindowOverlaysOnCaptureLoss=捕获丢失时 tstr_SettingsWindowOverlaysOnCaptureLossTip=当窗口捕获丢失（通常是因为目标窗口已关闭）时的行为。\n“隐藏叠加”模式在捕获恢复后会重新显示叠加。 tstr_SettingsWindowOverlaysOnCaptureLossDoNothing=不执行任何操作 tstr_SettingsWindowOverlaysOnCaptureLossHide=隐藏叠加 tstr_SettingsWindowOverlaysOnCaptureLossRemove=移除叠加 tstr_SettingsBrowserMaxFrameRate=最大帧率 tstr_SettingsBrowserMaxFrameRateOverrideOff=使用全局设置 tstr_SettingsBrowserContentBlocker=内容拦截器 tstr_SettingsBrowserContentBlockerTip=在“DesktopPlusBrowser\content_block”目录中添加采用 Adblock Plus 语法的屏蔽列表。\n目录中的所有列表都会被加载。 tstr_SettingsBrowserContentBlockerListCount=(已启用 %LISTCOUNT% 个列表) tstr_SettingsBrowserContentBlockerListCountSingular=(已启用 %LISTCOUNT% 个列表) tstr_SettingsPerformanceUpdateLimiter=限制更新 tstr_SettingsPerformanceUpdateLimiterMode=更新限制模式 tstr_SettingsPerformanceUpdateLimiterModeOff=关闭 tstr_SettingsPerformanceUpdateLimiterModeMS=帧间隔 tstr_SettingsPerformanceUpdateLimiterModeFPS=帧率 tstr_SettingsPerformanceUpdateLimiterModeOffOverride=使用全局设置 tstr_SettingsPerformanceUpdateLimiterModeMSTip=“帧间隔”会强制叠加更新之间保持最小时间间隔 tstr_SettingsPerformanceUpdateLimiterFPSValue=%FPS% 帧/秒 tstr_SettingsPerformanceUpdateLimiterOverride=覆写限制更新 tstr_SettingsPerformanceUpdateLimiterOverrideTip=当多个覆写同时启用时，将使用可以提供最高更新率的覆写 tstr_SettingsPerformanceUpdateLimiterModeOverride=覆写更新限制模式 tstr_SettingsPerformanceRapidUpdates=降低激光指针延迟 tstr_SettingsPerformanceRapidUpdatesTip=在指向叠加时，以增加 CPU 负载为代价减少激光指针输入延迟 tstr_SettingsPerformanceSingleDesktopMirror=单独桌面镜像 tstr_SettingsPerformanceSingleDesktopMirrorTip=切换桌面时只镜像单个桌面，而不是从合并桌面进行裁剪。\n启用后，所有叠加都将显示相同的桌面。 tstr_SettingsPerformanceUseHDR=HDR 镜像 tstr_SettingsPerformanceUseHDRTip=使用更高位深纹理镜像桌面或窗口，以支持 HDR 输出（实验性）。\n在不需要时可能会导致性能下降，并增加显存使用量。 tstr_SettingsPerformanceShowFPS=在浮动 UI 上显示帧率 tstr_SettingsWarningsHidden=已隐藏的警告： tstr_SettingsWarningsReset=重置隐藏的警告 tstr_SettingsStartupAutoLaunch=在 SteamVR 启动时自动启动 tstr_SettingsStartupSteamDisable=禁用 Steam 集成 tstr_SettingsStartupSteamDisableTip=如果 Desktop+ 是由 Steam 启动的，则以不带 Steam 的方式重新启动。\n这样会禁用应用内的永久在线状态、使用时长统计和其他 Steam 功能。 tstr_SettingsTroubleshootingRestart=重启 tstr_SettingsTroubleshootingRestartSteam=随 Steam 重启 tstr_SettingsTroubleshootingRestartDesktop=以桌面模式重启 tstr_SettingsTroubleshootingElevatedModeEnter=进入管理员权限模式 tstr_SettingsTroubleshootingElevatedModeLeave=退出管理员权限模式 tstr_SettingsTroubleshootingSettingsReset=恢复默认设置 tstr_SettingsTroubleshootingSettingsResetConfirmDescription=恢复默认设置将把所选元素重置为默认值。\n此操作无法撤销。\n\n重置以下项目： tstr_SettingsTroubleshootingSettingsResetConfirmButton=重置所选元素 tstr_SettingsTroubleshootingSettingsResetConfirmElementOverlays=当前叠加设置 tstr_SettingsTroubleshootingSettingsResetConfirmElementLegacyFiles=删除未使用的旧版配置和配置文件 tstr_SettingsTroubleshootingSettingsResetShowQuickStart=显示快速入门指南 ;键盘窗口 tstr_KeyboardWindowTitle=Desktop+ 键盘 tstr_KeyboardWindowTitleSettings=Desktop+ 键盘（设置） tstr_KeyboardWindowTitleOverlay=Desktop+ 键盘（%OVERLAYNAME%） tstr_KeyboardWindowTitleOverlayUnknown=[未知叠加] ;键盘快捷键窗口 tstr_KeyboardShortcutsCut=剪切 tstr_KeyboardShortcutsCopy=复制 tstr_KeyboardShortcutsPaste=粘贴 ;叠加属性窗口 tstr_OvrlPropsCatPosition=位置 tstr_OvrlPropsCatAppearance=外观 tstr_OvrlPropsCatCapture=捕获 tstr_OvrlPropsCatPerformanceMonitor=性能监控 tstr_OvrlPropsCatBrowser=浏览器 tstr_OvrlPropsCatAdvanced=高级 tstr_OvrlPropsCatPerformance=性能 tstr_OvrlPropsCatInterface=界面 tstr_OvrlPropsPositionOrigin=原点 tstr_OvrlPropsPositionOriginRoom=游戏空间 tstr_OvrlPropsPositionOriginHMDXY=头显底部位置 tstr_OvrlPropsPositionOriginDashboard=主面板 tstr_OvrlPropsPositionOriginHMD=头显 tstr_OvrlPropsPositionOriginSeatedSpace=座椅位置 tstr_OvrlPropsPositionOriginControllerR=右手柄 tstr_OvrlPropsPositionOriginControllerL=左手柄 tstr_OvrlPropsPositionOriginTheaterScreen=影院屏幕 tstr_OvrlPropsPositionOriginTracker1=追踪器 #1 tstr_OvrlPropsPositionOriginConfigHMDXYTurning=随头显一起转动 tstr_OvrlPropsPositionOriginConfigTheaterScreenEnter=进入影院模式 tstr_OvrlPropsPositionOriginConfigTheaterScreenLeave=退出影院模式 tstr_OvrlPropsPositionOriginTheaterScreenTip=部分属性由 SteamVR 影院屏幕控制 tstr_OvrlPropsPositionDispMode=显示模式 tstr_OvrlPropsPositionDispModeAlways=始终 tstr_OvrlPropsPositionDispModeDashboard=仅在主面板 tstr_OvrlPropsPositionDispModeScene=仅在游戏中 tstr_OvrlPropsPositionDispModeDPlus=仅在 Desktop+ 标签页中 tstr_OvrlPropsPositionPos=位置 tstr_OvrlPropsPositionPosTip=只有在 Desktop+ 正在运行时才能更改或重置位置 tstr_OvrlPropsPositionChange=更改 tstr_OvrlPropsPositionReset=重置 tstr_OvrlPropsPositionLock=锁定 tstr_OvrlPropsPositionChangeHeader=更改叠加位置 tstr_OvrlPropsPositionChangeHelp=拖动任意叠加以更改其位置。\n按住右键可进行双手手势变换。 tstr_OvrlPropsPositionChangeHelpDesktop=按住拖动按钮（“D”）可使用鼠标移动或旋转叠加。 tstr_OvrlPropsPositionChangeManualAdjustment=手动调整 tstr_OvrlPropsPositionChangeMove=移动 tstr_OvrlPropsPositionChangeRotate=旋转 tstr_OvrlPropsPositionChangeForward=前移 tstr_OvrlPropsPositionChangeBackward=后移 tstr_OvrlPropsPositionChangeRollCW=滚动 ⟳ tstr_OvrlPropsPositionChangeRollCCW=滚动 ⟲ tstr_OvrlPropsPositionChangeLookAt=面向头显 tstr_OvrlPropsPositionChangeDragButton=D tstr_OvrlPropsPositionChangeOffset=附加偏移 tstr_OvrlPropsPositionChangeOffsetUpDown=上下偏移 tstr_OvrlPropsPositionChangeOffsetRightLeft=左右偏移 tstr_OvrlPropsPositionChangeOffsetForwardBackward=前后偏移 tstr_OvrlPropsPositionChangeDragSettings=拖动设置 tstr_OvrlPropsPositionChangeDragSettingsAutoDocking=接近手柄时自动停靠 tstr_OvrlPropsPositionChangeDragSettingsForceDistance=强制固定距离 tstr_OvrlPropsPositionChangeDragSettingsForceDistanceShape=形状 tstr_OvrlPropsPositionChangeDragSettingsForceDistanceShapeSphere=球 tstr_OvrlPropsPositionChangeDragSettingsForceDistanceShapeCylinder=圆柱 tstr_OvrlPropsPositionChangeDragSettingsForceDistanceAutoCurve=自动曲面 tstr_OvrlPropsPositionChangeDragSettingsForceDistanceAutoTilt=自动倾斜 tstr_OvrlPropsPositionChangeDragSettingsSnapPosition=位置贴合 tstr_OvrlPropsAppearanceWidth=宽度 tstr_OvrlPropsAppearanceCurve=曲率 tstr_OvrlPropsAppearanceOpacity=透明度 tstr_OvrlPropsAppearanceBrightness=亮度 tstr_OvrlPropsAppearanceCrop=裁剪 tstr_OvrlPropsAppearanceCropValueMax=最大 tstr_OvrlPropsCrop=裁剪区域 tstr_OvrlPropsCropHelp=拖动矩形以调整裁剪范围。\n使用滚轮或拖动边缘来调整裁剪矩形的大小。 tstr_OvrlPropsCropManualAdjust=手动调节 tstr_OvrlPropsCropInvalidTip=当前裁剪矩形无效，可能导致叠加不可见。 tstr_OvrlPropsCropX=X tstr_OvrlPropsCropY=Y tstr_OvrlPropsCropWidth=宽度 tstr_OvrlPropsCropHeight=高度 tstr_OvrlPropsCropToWindow=裁剪到当前活动窗口 tstr_OvrlPropsCaptureMethod=捕获方式 tstr_OvrlPropsCaptureMethodDup=桌面复制 tstr_OvrlPropsCaptureMethodGC=图形捕获 tstr_OvrlPropsCaptureMethodGCUnsupportedTip=此系统不支持图形捕获 tstr_OvrlPropsCaptureMethodGCUnsupportedPartialTip=此系统不支持部分图形捕获功能 tstr_OvrlPropsCaptureSource=来源 tstr_OvrlPropsCaptureGCSource=图形捕获来源 tstr_OvrlPropsCaptureSourceUnknownWarning=此叠加使用了未知的捕获来源，可能无法正常工作 tstr_OvrlPropsCaptureGCStrictMatching=使用严格窗口匹配 tstr_OvrlPropsCaptureGCStrictMatchingTip=在恢复此叠加的捕获时，仅允许精确匹配窗口标题 tstr_OvrlPropsPerfMonDesktopModeTip=性能监控叠加在桌面模式下不会更新 tstr_OvrlPropsPerfMonGlobalTip=以下设置应用于所有性能监控叠加 tstr_OvrlPropsPerfMonStyle=样式 tstr_OvrlPropsPerfMonStyleCompact=紧凑 tstr_OvrlPropsPerfMonStyleLarge=大型 tstr_OvrlPropsPerfMonShowCPU=显示 CPU 状态 tstr_OvrlPropsPerfMonShowGPU=显示 GPU 状态 tstr_OvrlPropsPerfMonShowGraphs=显示图表 tstr_OvrlPropsPerfMonShowFrameStats=显示帧信息 tstr_OvrlPropsPerfMonShowTime=显示时间 tstr_OvrlPropsPerfMonShowBattery=显示电池信息 tstr_OvrlPropsPerfMonShowTrackerBattery=显示追踪器电量 tstr_OvrlPropsPerfMonShowViveWirelessTemp=显示 Vive 无线温度 tstr_OvrlPropsPerfMonResetValues=重置累计数值 tstr_OvrlPropsBrowserNotAvailableTip=未安装 Desktop+ 浏览器组件 tstr_OvrlPropsBrowserCloned=克隆输出 tstr_OvrlPropsBrowserClonedTip=此叠加克隆自 "%OVERLAYNAME%"。\n对浏览器属性所做的更改将同时应用到原叠加及所有从其克隆的叠加。 tstr_OvrlPropsBrowserClonedConvert=转换为独立叠加 tstr_OvrlPropsBrowserURL=URL tstr_OvrlPropsBrowserURLHint=输入地址 tstr_OvrlPropsBrowserGo=前往 tstr_OvrlPropsBrowserRestore=恢复上次输入 tstr_OvrlPropsBrowserWidth=宽度 tstr_OvrlPropsBrowserHeight=高度 tstr_OvrlPropsBrowserZoom=缩放 tstr_OvrlPropsBrowserAllowTransparency=允许透明 tstr_OvrlPropsBrowserAllowTransparencyTip=允许网页使用透明背景。\n如果网站未定义任何背景颜色，页面可能会显示异常。 tstr_OvrlPropsBrowserRecreateContext=重新创建浏览器上下文 tstr_OvrlPropsBrowserRecreateContextTip=需要重新创建浏览器上下文才能应用更改。\n此操作会重新加载页面并清除导航历史记录。 tstr_OvrlPropsAdvanced3D=3D tstr_OvrlPropsAdvancedHSBS=左右半宽 tstr_OvrlPropsAdvancedSBS=左右并列 tstr_OvrlPropsAdvancedHOU=上下半高 tstr_OvrlPropsAdvancedOU=上下并列 tstr_OvrlPropsAdvanced3DSwap=交换左右眼 tstr_OvrlPropsAdvancedGazeFade=视线淡出 tstr_OvrlPropsAdvancedGazeFadeAuto=自动配置 tstr_OvrlPropsAdvancedGazeFadeDistance=距离 tstr_OvrlPropsAdvancedGazeFadeDistanceValueInf=无限 tstr_OvrlPropsAdvancedGazeFadeSensitivity=灵敏度 tstr_OvrlPropsAdvancedGazeFadeOpacity=目标透明度 tstr_OvrlPropsAdvancedInput=激光指针输入 tstr_OvrlPropsAdvancedInputInGame=游戏中启用 tstr_OvrlPropsAdvancedInputFloatingUI=显示浮动 UI tstr_OvrlPropsAdvancedOverlayTags=叠加标签 tstr_OvrlPropsAdvancedOverlayTagsTip=叠加标签用于在操作中定位叠加 tstr_OvrlPropsPerformanceInvisibleUpdate=在不可见时仍更新 tstr_OvrlPropsPerformanceInvisibleUpdateTip=即使叠加因透明度设置或视线淡出而不可见时，也继续更新叠加。\n有助于第三方应用程序访问叠加内容。\n除特殊需求外，不建议启用。\n如果叠加是被手动隐藏或因显示模式而被隐藏，更新仍会暂停。 tstr_OvrlPropsInterfaceOverlayName=叠加名称 tstr_OvrlPropsInterfaceOverlayNameAuto=[自动命名] tstr_OvrlPropsInterfaceActionOrderCustom=覆写操作按钮 tstr_OvrlPropsInterfaceDesktopButtons=显示桌面按钮 tstr_OvrlPropsInterfaceExtraButtons=显示额外按钮 ;叠加栏 tstr_OverlayBarOvrlHide=隐藏 tstr_OverlayBarOvrlShow=显示 tstr_OverlayBarOvrlClone=克隆 tstr_OverlayBarOvrlRemove=移除 tstr_OverlayBarOvrlRemoveConfirm=确定删除？ tstr_OverlayBarOvrlProperties=属性... tstr_OverlayBarOvrlAddWindow=窗口... tstr_OverlayBarTooltipOvrlAdd=添加叠加 tstr_OverlayBarTooltipSettings=设置 tstr_OverlayBarTooltipResetHold=长按以重置窗口位置... ;浮动界面 tstr_FloatingUIHideOverlayTip=隐藏叠加 tstr_FloatingUIHideOverlayHoldTip=长按以移除叠加... tstr_FloatingUIDragModeEnableTip=启用拖动模式 tstr_FloatingUIDragModeDisableTip=禁用拖动模式 tstr_FloatingUIDragModeHoldLockTip=长按以锁定叠加位置... tstr_FloatingUIDragModeHoldUnlockTip=长按以解锁叠加位置... tstr_FloatingUIWindowAddTip=将当前活动窗口添加为叠加 tstr_FloatingUIActionBarShowTip=显示操作栏 tstr_FloatingUIActionBarHideTip=隐藏操作栏 tstr_FloatingUIBrowserGoBackTip=前往上一页 tstr_FloatingUIBrowserGoForwardTip=前往下一页 tstr_FloatingUIBrowserRefreshTip=刷新当前页面 tstr_FloatingUIBrowserStopTip=停止加载页面 tstr_FloatingUIActionBarDesktopPrev=上一个桌面 tstr_FloatingUIActionBarDesktopNext=下一个桌面 tstr_FloatingUIActionBarEmpty=未启用任何操作 ;特殊操作 tstr_ActionNone=[无] tstr_ActionKeyboardShow=显示键盘 tstr_ActionKeyboardHide=隐藏键盘 ;默认操作（翻译 ID 与操作名称匹配） tstr_DefActionShowKeyboard=显示键盘 tstr_DefActionActiveWindowCrop=裁剪至活动窗口 tstr_DefActionActiveWindowCropLabel=裁剪至\n活动\n窗口 tstr_DefActionSwitchTask=切换任务 tstr_DefActionToggleOverlays=切换叠加 tstr_DefActionToggleOverlaysLabel=切换\n叠加 tstr_DefActionMiddleMouse=鼠标中键 tstr_DefActionMiddleMouseLabel=鼠标\n中键 tstr_DefActionBackMouse=鼠标后退键 tstr_DefActionBackMouseLabel=鼠标\n后退\n键 tstr_DefActionReadMe=打开 ReadMe tstr_DefActionReadMeLabel=打开\nReadMe tstr_DefActionDashboardToggle=切换 SteamVR 主面板（调试命令） tstr_DefActionDashboardToggleLabel=切换\n主面板 ;性能监控（界面可用空间很有限，尽量简短或不翻译） tstr_PerformanceMonitorCPU=CPU tstr_PerformanceMonitorGPU=GPU tstr_PerformanceMonitorRAM=内存: tstr_PerformanceMonitorVRAM=显存: tstr_PerformanceMonitorFrameTime=帧时间: tstr_PerformanceMonitorLoad=负载: tstr_PerformanceMonitorFPS=FPS: tstr_PerformanceMonitorFPSAverage=平均 FPS: tstr_PerformanceMonitorReprojectionRatio=重投比例: tstr_PerformanceMonitorDroppedFrames=丢帧: tstr_PerformanceMonitorBatteryLeft=左手柄: tstr_PerformanceMonitorBatteryRight=右手柄: tstr_PerformanceMonitorBatteryHMD=头显: tstr_PerformanceMonitorBatteryTracker=追踪器 %ID%: tstr_PerformanceMonitorBatteryDisconnected=N/A tstr_PerformanceMonitorViveWirelessTempNotAvailable=N/A tstr_PerformanceMonitorCompactCPU=CPU tstr_PerformanceMonitorCompactGPU=GPU tstr_PerformanceMonitorCompactFPS=FPS tstr_PerformanceMonitorCompactFPSAverage=AVG tstr_PerformanceMonitorCompactReprojectionRatio=% RPR tstr_PerformanceMonitorCompactDroppedFrames=DRP tstr_PerformanceMonitorCompactBattery=BAT tstr_PerformanceMonitorCompactBatteryLeft=L tstr_PerformanceMonitorCompactBatteryRight=R tstr_PerformanceMonitorCompactBatteryHMD=H tstr_PerformanceMonitorCompactBatteryTracker=T%ID% tstr_PerformanceMonitorCompactBatteryDisconnected=N/A tstr_PerformanceMonitorCompactViveWirelessTempNotAvailable=N/A tstr_PerformanceMonitorEmpty=未启用任何性能监控项目。 ;辅助 UI tstr_AuxUIDragHintDocking=松开以停靠 tstr_AuxUIDragHintUndocking=松开以取消停靠 tstr_AuxUIDragHintOvrlLocked=解锁叠加位置才能拖动此叠加 tstr_AuxUIDragHintOvrlTheaterScreenBlocked=此叠加的位置由 SteamVR 影院屏幕控制 tstr_AuxUIGazeFadeAutoHint=注视叠加中心并等待 %SECONDS% 秒... tstr_AuxUIGazeFadeAutoHintSingular=注视叠加中心并等待 %SECONDS% 秒... tstr_AuxUIQuickStartWelcomeHeader=欢迎使用 Desktop+！ tstr_AuxUIQuickStartWelcomeBody=本简短指南将向您介绍应用程序的基础知识。\n如需更多详细信息，请查看 ReadMe 和用户指南。\n\n如果您想跳过此指南，可直接点击 [关闭]。 tstr_AuxUIQuickStartOverlaysHeader=叠加 tstr_AuxUIQuickStartOverlaysBody=Desktop+ 允许您创建叠加来镜像您的各个桌面、独立窗口等内容。\n所有创建的叠加都会显示在下方的叠加栏中。\n\n单击一个叠加图标并选择 [属性...] 可以修改叠加属性。 tstr_AuxUIQuickStartOverlaysBody2=点击 [+] 并从列表中选择捕获来源或叠加类型可以创建新的叠加。\n某些类型（例如浏览器叠加）仅在安装了相应组件后才可用。\n\n单个叠加或整个布局可以被保存到配置文件。\n当前叠加设置会在不同会话之间自动记住。 tstr_AuxUIQuickStartOverlayPropertiesHeader=叠加属性 tstr_AuxUIQuickStartOverlayPropertiesBody=叠加具有多种自定义选项。\n原点和显示模式决定了叠加显示的位置和时机。\n如果您觉得叠加应该显示却找不到，请检查这些属性。\n若前述方法无效，重置叠加位置也许能解决问题。\n\n您还可以通过将叠加拖拽至运动控制器附近，将其停靠到控制器上。 tstr_AuxUIQuickStartOverlayPropertiesBody2=部分属性默认处于隐藏状态。\n在设置窗口中切换“显示高级设置”即可显示所有选项。\n\n通过长按各自的按钮可以重置 UI 窗口的位置。\n叠加按钮也支持双击和右键单击，作为快捷切换功能。 tstr_AuxUIQuickStartSettingsHeader=设置 tstr_AuxUIQuickStartSettingsBody=设置窗口包含 Desktop+ 的所有全局设置。\n按下叠加栏右端的齿轮按钮即可打开。\n\n与叠加一样，设置的更改会自动应用并保存。 tstr_AuxUIQuickStartProfilesHeader=配置文件 tstr_AuxUIQuickStartProfilesBody=Desktop+ 中有两种配置文件类型。\n\n叠加配置文件：\n存储一个或多个叠加及其属性。\n它们可以被手动加载，也可以根据操作和应用程序配置文件加载。\n\n应用程序配置文件：\n在启动 SteamVR 应用程序时，自动加载指定的叠加配置文件和/或操作。 tstr_AuxUIQuickStartActionsHeader=操作 tstr_AuxUIQuickStartActionsBody=Desktop+ 中的操作是一系列命令，其可以被分配给控制器输入和应用程序配置文件，或添加到叠加的操作栏中。\n这些操作命令包括从模拟桌面输入到调整叠加布局等功能。\n其还可以被用于启动外部应用程序以满足高级用例需求。\n\nDesktop+ 自带一些示例操作供您参考。 tstr_AuxUIQuickStartActionsBody2=默认情况下，操作的目标是被激活的叠加（为叠加显示的操作按钮、叠加上的控制器输入），如果前者不适用，则目标是被聚焦的叠加层。\n\n当前聚焦的叠加是最后一次被点击的叠加。\n在许多情况下，目标叠加并不重要，例如在桌面上模拟输入；但在其他情况下，指定一个不同的目标叠加甚至多个目标叠加可能会有用。 tstr_AuxUIQuickStartOverlayTagsHeader=叠加标签 tstr_AuxUIQuickStartOverlayTagsBody=叠加标签可用于此目的。\n存在自动标签（绿色标签）和用户自定义标签。\n自动标签是基于其所代表的属性自动分配的。\n用户自定义标签可以在叠加属性窗口中手动分配给叠加。\n\n请注意，对于全局快捷键，操作仅与控制器按钮间接绑定。此外，编号的全局快捷键还必须通过 SteamVR 的输入绑定界面分配给控制器输入。 tstr_AuxUIQuickStartSettingsEndBody=还有更多设置可供使用。\n不要害怕尝试各种切换按钮来探索它们。\n\n如果遇到问题，您可以点击窗口底部的 [恢复默认设置] 按钮。\n您还可以选择仅恢复特定的部分。 tstr_AuxUIQuickStartFloatingUIHeader=浮动 UI tstr_AuxUIQuickStartFloatingUIBody=当您指向某个叠加时，被称为“浮动 UI”的界面会显示出来。\n在主面板中，如果没有指向其他叠加，它将始终显示。\n\n浮动 UI 包含用于修改叠加的基本控件，例如切换拖动模式以允许移动叠加，\n以及一个可自定义的操作按钮的部分。\n\n根据叠加类型，可能还会有其他控件。这些控件的显示可以在各个叠加的属性中进行切换。 tstr_AuxUIQuickStartDesktopModeHeader=桌面模式 tstr_AuxUIQuickStartDesktopModeBody=Desktop+ 也可以在一个桌面窗口上被配置。\n这对于需要频繁使用键盘输入或在未连接运动控制器时进行修改的任务非常有用。\n\n虽然两种模式下几乎所有功能都相同，但用于自定义 Desktop+ VR 键盘布局的键盘布局编辑器仅在桌面模式下可用。\n\n您可以在设置窗口的故障排除部分切换到该模式，或者通过系统托盘/通知区域中的 Desktop+ 图标进入桌面模式。 tstr_AuxUIQuickStartEndHeader=ReadMe 和用户指南 tstr_AuxUIQuickStartEndBody=这应该足以让您开始使用 Desktop+。\n\n如果您遇到任何问题或困惑，请务必查看 ReadMe。\n操作栏中的按钮将为您打开它。\n每个选项的详细说明以及常见使用场景的逐步指南可以在用户指南中找到。\n\n若要再次查看此指南，请点击“恢复默认设置”页面右下角的 [显示快速入门指南] 按钮。 tstr_AuxUIQuickStartButtonNext=下一页 tstr_AuxUIQuickStartButtonPrev=上一页 tstr_AuxUIQuickStartButtonClose=关闭 ;桌面模式 tstr_DesktopModeCatTools=工具 tstr_DesktopModeCatOverlays=叠加 tstr_DesktopModeToolSettings=设置 tstr_DesktopModeToolActions=操作 tstr_DesktopModeOverlayListAdd=添加叠加 tstr_DesktopModePageAddWindowOverlayTitle=添加窗口叠加 tstr_DesktopModePageAddWindowOverlayHeader=选择一个窗口 ;键盘编辑器 tstr_KeyboardEditorKeyListTitle=按键列表 tstr_KeyboardEditorKeyListTabContextReplace=替换布局内容... tstr_KeyboardEditorKeyListTabContextClear=清空子布局 tstr_KeyboardEditorKeyListRow=行 %ID% tstr_KeyboardEditorKeyListSpacing=[空格] tstr_KeyboardEditorKeyListKeyAdd=添加 tstr_KeyboardEditorKeyListKeyDuplicate=复制 tstr_KeyboardEditorKeyListKeyRemove=移除 tstr_KeyboardEditorKeyPropertiesTitle=按键属性 tstr_KeyboardEditorKeyPropertiesNoSelection=未选择按键 tstr_KeyboardEditorKeyPropertiesType=类型 tstr_KeyboardEditorKeyPropertiesTypeBlank=空白区域 tstr_KeyboardEditorKeyPropertiesTypeVirtualKey=虚拟按键 tstr_KeyboardEditorKeyPropertiesTypeVirtualKeyToggle=虚拟按键（切换） tstr_KeyboardEditorKeyPropertiesTypeVirtualKeyIsoEnter=虚拟按键（ISO-Enter） tstr_KeyboardEditorKeyPropertiesTypeString=字符串 tstr_KeyboardEditorKeyPropertiesTypeSublayoutToggle=切换子布局 tstr_KeyboardEditorKeyPropertiesTypeAction=操作 tstr_KeyboardEditorKeyPropertiesTypeVirtualKeyIsoEnterTip=在相邻的两行里各使用一个“虚拟按键（ISO-Enter）”即可组合成一个 ISO-Enter 形状的键。\n每个子布局中只能有一个这样的组合键。 tstr_KeyboardEditorKeyPropertiesTypeStringTip=对于非基本字符键，请使用字符串类型。\n这样 Desktop+ 能够基于实际键盘布局计算出正确的按键组合，从而提高应用兼容性。 tstr_KeyboardEditorKeyPropertiesSize=大小 tstr_KeyboardEditorKeyPropertiesLabel=标签 tstr_KeyboardEditorKeyPropertiesKeyCode=按键码 tstr_KeyboardEditorKeyPropertiesString=字符串 tstr_KeyboardEditorKeyPropertiesSublayout=子布局 tstr_KeyboardEditorKeyPropertiesAction=操作 tstr_KeyboardEditorKeyPropertiesCluster=键簇 tstr_KeyboardEditorKeyPropertiesClusterTip=键簇分配可用于有选择地禁用按键的加载。\n周围的空白区域不会被移除。请仔细为空白区域类型的按键分配键簇，以确保它们能正确切换。 tstr_KeyboardEditorKeyPropertiesBlockModifiers=阻止修饰键 tstr_KeyboardEditorKeyPropertiesBlockModifiersTip=在此键按下时，释放所有修饰键 tstr_KeyboardEditorKeyPropertiesNoRepeat=禁止重复 tstr_KeyboardEditorKeyPropertiesNoRepeatTip=即使开启了按键重复，也阻止此键被按住时重复输入 tstr_KeyboardEditorMetadataTitle=布局元数据 tstr_KeyboardEditorMetadataName=名称 tstr_KeyboardEditorMetadataAuthor=作者 tstr_KeyboardEditorMetadataHasAltGr=是否有 AltGr tstr_KeyboardEditorMetadataHasAltGrTip=当按下右 Alt 键时，会切换到 AltGr 子布局 tstr_KeyboardEditorMetadataClusterPreview=预览键簇： tstr_KeyboardEditorMetadataSave=保存... tstr_KeyboardEditorMetadataLoad=加载... tstr_KeyboardEditorMetadataSavePopupTitle=保存键盘布局 tstr_KeyboardEditorMetadataSavePopupFilename=文件名 tstr_KeyboardEditorMetadataSavePopupFilenameBlankTip=文件名不能为空 tstr_KeyboardEditorMetadataSavePopupConfirm=保存布局 tstr_KeyboardEditorMetadataSavePopupConfirmError=保存布局失败 tstr_KeyboardEditorMetadataLoadPopupTitle=加载键盘布局 tstr_KeyboardEditorMetadataLoadPopupConfirm=加载布局 tstr_KeyboardEditorPreviewTitle=键盘预览 tstr_KeyboardEditorSublayoutBase=基本 tstr_KeyboardEditorSublayoutShift=Shift tstr_KeyboardEditorSublayoutAltGr=AltGr tstr_KeyboardEditorSublayoutAux=辅助 ;通用对话字符串 tstr_DialogOk=确定 tstr_DialogCancel=取消 tstr_DialogDone=完成 tstr_DialogUndo=撤销 tstr_DialogRedo=重做 tstr_DialogColorPickerHeader=选择颜色 tstr_DialogColorPickerCurrent=当前 tstr_DialogColorPickerOriginal=原始 tstr_DialogProfilePickerHeader=选择配置文件 tstr_DialogProfilePickerNone=[无] tstr_DialogActionPickerHeader=选择操作 tstr_DialogActionPickerEmpty=暂无可用操作 tstr_DialogIconPickerHeader=选择图标 tstr_DialogIconPickerHeaderTip=可以在“images\icons\”目录中添加自定义 PNG 图标 tstr_DialogIconPickerNone=[无图标] tstr_DialogKeyCodePickerHeader=选择按键码 tstr_DialogKeyCodePickerHeaderHotkey=选择热键 tstr_DialogKeyCodePickerModifiers=修饰键 tstr_DialogKeyCodePickerKeyCode=按键码 tstr_DialogKeyCodePickerKeyCodeHint=搜索列表 tstr_DialogKeyCodePickerKeyCodeNone=[无] tstr_DialogKeyCodePickerFromInput=从输入获取... tstr_DialogKeyCodePickerFromInputPopup=请按任意键或鼠标按键... tstr_DialogKeyCodePickerFromInputPopupNoMouse=请按任意键... tstr_DialogWindowPickerHeader=选择窗口 tstr_DialogInputTagsHint=搜索或添加新标签 ;来源字符串 tstr_SourceDesktopAll=合并桌面 tstr_SourceDesktopID=桌面 %ID% tstr_SourceWinRTNone=[无捕获目标] tstr_SourceWinRTUnknown=[未知窗口] tstr_SourceWinRTClosed=[已关闭]： tstr_SourcePerformanceMonitor=性能监控 tstr_SourceBrowser=浏览器 tstr_SourceBrowserNoPage=[未加载页面] ;通知图标 tstr_NotificationIconRestoreVR=恢复 VR 界面 tstr_NotificationIconOpenOnDesktop=在桌面打开设置 tstr_NotificationIconQuit=退出 ;通知 tstr_NotificationInitialStartupTitleVR=初始设置 tstr_NotificationInitialStartupTitleDesktop=Desktop+ 初始设置 tstr_NotificationInitialStartupMessage=Desktop+ 已成功加入 SteamVR，并将在每次启动 SteamVR 时自动运行。 ;浏览器 tstr_BrowserErrorPageTitle=页面加载错误 - Desktop+ tstr_BrowserErrorPageHeading=无法加载此页面 tstr_BrowserErrorPageMessage=尝试加载 %URL% 时发生错误：%ERROR% ================================================ FILE: assets/license.txt ================================================ GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . ================================================ FILE: assets/manifest.vrmanifest ================================================ { "source": "builtin", "applications": [ { "app_key": "steam.overlay.1494460", "launch_type": "binary", "binary_path_windows": "DesktopPlus.exe", "is_dashboard_overlay": true, "action_manifest_path" : "action_manifest.json", "image_path" : "images/desktop_plus_capsule.png", "strings": { "en_us": { "name": "Desktop+", "description": "Desktop+ Overlay" } } }, { "app_key": "elvissteinjr.DesktopPlusTheaterScreen", "launch_type": "binary", "binary_path_windows": "DesktopPlus.exe", "starts_theater_mode": true, "is_hidden": true, "is_internal": true, "strings": { "en_us": { "name": "Desktop+ Theater Screen", "description": "Desktop+ Theater Screen" } } }] } ================================================ FILE: assets/misc/!About this folder.txt ================================================ This folder contains scripts enabling Desktop+ to gain higher access rights. The scripts are provided for convenience. Changes made by these scripts are inherently unsafe due to SteamVR running from an user-writable location among other things. ! Use your own judgment before running any of them. Don't use them if you don't know what you're doing. ! The author of Desktop+ shall not be liable for any damage caused by the use of these scripts. The .ps1 PowerShell scripts require to be run as administrator. The .bat files will try do that for you, so it's recommended to use those instead. Make sure Desktop+ is not running before executing them. CreateElevatedTask.ps1: - Creates a scheduled task to enable use of Desktop+'s elevated mode. Elevated mode allows inputs and actions to be executed with administrator privileges, getting around most restrictions of User Interface Privilege Isolation (UIPI), which it is subject to otherwise. After running this script, elevated mode can be accessed via [Misc|Troubleshooting|Desktop+: Enter Elevated Mode]. If you move Desktop+'s files, the scheduled task will break but the button remains. Re-run the script to fix this. Note that actions launching applications will run them with the same privileges as Desktop+, so be careful if you don't intend them to have administrator rights. Leave elevated mode again as soon as possible. EnableUIAccess.ps1: - Enables UIAccess rights for Desktop+ to lift interaction restrictions with higher privileged applications and UAC prompts. This is done by signing the DesktopPlus.exe executable with a self-signed certificate, using a different side-by-side manifest and changing group policies if needed. Compared to elevated mode, this enables Desktop+ to simulate input on any applications, including UAC prompts, at any time while not running with administrator privileges. This script needs to be run again after Desktop+ has been updated or otherwise modified. The following group policy is changed by the script: - "User Account Control: Only elevate UIAccess applications that are installed in secure locations" (set to 0) (only if needed) In order for Desktop+ to be able to mirror and interact with UAC prompts, the UAC level has to be lowered to not display the prompts on the secure desktop ("do not dim my desktop"). The elevated scheduled task has to be recreated after enabling UIAccess for the first time or entering elevated mode will fail. UndoSystemChanges.ps1: - Reverts system-wide changes made by above scripts. The script does not revert changes made to group policies as it may impact other applications. ================================================ FILE: assets/misc/CreateElevatedTask.bat ================================================ @echo off pushd %~dp0 echo Launching script with administrator privileges... powershell -command " Start-Process PowerShell -Verb RunAs \""-ExecutionPolicy Bypass -Command `\""cd '%cd%'; & '.\CreateElevatedTask.ps1';`\""\"" " ================================================ FILE: assets/misc/CreateElevatedTask.ps1 ================================================ #Requires -RunAsAdministrator $msg = "Desktop+ Elevated Scheduled Task Creation Script ------------------------------------------------ This creates an elevated scheduled task for Desktop+ to allow entering elevated mode without UAC prompt to simulate inputs with administrator rights. Desktop+ will only use this task when the button in the UI is used to enter elevated mode. Please keep the security implications of doing this in mind. At the very least consider restricting write access to the Desktop+ executable file. " Write-Host $msg #Ask before continuing $opt_yes = New-Object System.Management.Automation.Host.ChoiceDescription "&Yes", "Create scheduled task and enable elevated mode for Desktop+" $opt_no = New-Object System.Management.Automation.Host.ChoiceDescription "&No", 'Cancel' $options = [System.Management.Automation.Host.ChoiceDescription[]]($opt_yes, $opt_no) $result = $host.ui.PromptForChoice("", "Continue and create the scheduled task?", $options, 1) if ($result -eq 1) { exit } #Apply the changes #Command and arguments for the scheduled task $command = $PSScriptRoot + "\..\DesktopPlus.exe" $arg = "-ElevatedMode" #Check if UIAccess is currently enabled $sel = Select-String -Path "..\DesktopPlus.exe.manifest" -Pattern "uiAccess=`"true`"" #String found means UIAccess is enabled if ($sel -ne $null) { #Change the command and arguments to use cmd as a workaround since the elevated scheduled task can't be run directly when UIAccess is enabled $command = "cmd" $arg = "/c `"start DesktopPlus.exe -ElevatedMode`"" } #We use an XML file with schtasks instead of the Powershell cmdlets as we can create the task from an elevated session without additional password input this way. $xml = ' Desktop+ This scheduled task is run manually by Desktop+ in order to allow it to be run with adminstrator rights without UAC prompt. Desktop+ will only use it when the button in the settings is used to switch into elevated mode. InteractiveToken HighestAvailable Parallel false false false false false false false true true false false false PT0S 7 ' + $command + ' ' + $arg + ' '+ $PSScriptRoot + '\.. ' #Write XML to file $xml | Set-Content .\DesktopPlusElevatedTask.xml #Create task schtasks /Create /TN "DesktopPlus Elevated" /XML "DesktopPlusElevatedTask.xml" /F #Delete the XML file after we're done Remove-Item DesktopPlusElevatedTask.xml Write-Output "`n" cmd /c pause ================================================ FILE: assets/misc/EnableUIAccess.bat ================================================ @echo off pushd %~dp0 echo Launching script with administrator privileges... powershell -command " Start-Process PowerShell -Verb RunAs \""-ExecutionPolicy Bypass -Command `\""cd '%cd%'; & '.\EnableUIAccess.ps1';`\""\"" " ================================================ FILE: assets/misc/EnableUIAccess.ps1 ================================================ #Requires -RunAsAdministrator $msg = "Desktop+ UIAccess Setup Script ------------------------------ This enables UIAccess rights for Desktop+ to lift interaction restrictions with higher privileged applications and UAC prompts. This is done by signing the DesktopPlus.exe executable with a self-signed certificate, using a different side-by-side manifest and changing group policies if needed. The private key of the certificate created in this script is deleted afterwards and does not remain on the system. Nevertheless it's recommended to inspect what this script does and use your own judgement before just running this. The script needs to be run again each time Desktop+ has been updated or otherwise modified. " Write-Host $msg #Ask before continuing $opt_yes = New-Object System.Management.Automation.Host.ChoiceDescription "&Yes", "Apply changes and enable UIAccess for Desktop+" $opt_no = New-Object System.Management.Automation.Host.ChoiceDescription "&No", 'Cancel' $options = [System.Management.Automation.Host.ChoiceDescription[]]($opt_yes, $opt_no) $result = $host.ui.PromptForChoice("", "Continue and apply these changes?", $options, 1) if ($result -eq 1) { exit } #Apply the changes $CertificateSubject = "DesktopPlus UIAccess Script" #Remove old certificates if they exist Get-ChildItem Cert:\LocalMachine\Root | Where-Object { $_.Subject -match $CertificateSubject } | Remove-Item Get-ChildItem Cert:\LocalMachine\CA | Where-Object { $_.Subject -match $CertificateSubject } | Remove-Item #Create the new self-signed certificate $cert = New-SelfSignedCertificate -CertStoreLocation Cert:\LocalMachine\My -Type CodeSigningCert -Subject $CertificateSubject -NotAfter (Get-Date).AddYears(5) #Export the certificate to import it again as a root certificate, but without the private key Export-Certificate -Cert $cert -FilePath ".\DesktopPlusCert.cer" | Out-Null Import-Certificate -FilePath ".\DesktopPlusCert.cer" -CertStoreLocation "Cert:\LocalMachine\Root" | Out-Null #Sign DesktopPlus.exe Set-AuthenticodeSignature -FilePath "..\DesktopPlus.exe" -Certificate $cert | Out-Null #Backup normal side-by-side manifest (doesn't overwrite if already exists) Move-Item "..\DesktopPlus.exe.manifest" -Destination "EnableUIAccessDesktopPlusBackup.manifest" -ErrorAction SilentlyContinue #Replace side-by-side manifest with the UIAccess enabled one Copy-Item "EnableUIAccessDesktopPlus.manifest" -Destination "..\DesktopPlus.exe.manifest" #Disable "User Account Control: Only elevate UIAccess applications that are installed in secure locations" group policy if we are outside of the Program Files directory if (!$pwd.path.StartsWith($env:ProgramFiles)) { Set-ItemProperty -Path "HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\System" -Name "EnableSecureUIAPaths" -Value 0 } #Cleanup Remove-Item ".\DesktopPlusCert.cer" #We do not leave the certificate with the private key on the system. Signing with it was a one-time thing. Set-Location "Cert:" $cert | Remove-Item -DeleteKey Write-Host "Done." Write-Output "`n" cmd /c pause ================================================ FILE: assets/misc/EnableUIAccessDesktopPlus.manifest ================================================  True/PM ================================================ FILE: assets/misc/UndoSystemChanges.bat ================================================ @echo off pushd %~dp0 echo Launching script with administrator privileges... powershell -command " Start-Process PowerShell -Verb RunAs \""-ExecutionPolicy Bypass -Command `\""cd '%cd%'; & '.\UndoSystemChanges.ps1';`\""\"" " ================================================ FILE: assets/misc/UndoSystemChanges.ps1 ================================================ #Requires -RunAsAdministrator $msg = "Desktop+ Cleanup Script ----------------------- This reverts system-wide changes made by the scripts in the `"misc`" folder of Desktop+. It removes the following: - `"DesktopPlus Elevated`" scheduled task - `"DesktopPlus UIAccess Script`" self-signed certificates - Desktop+ UIAccess side-by-side manifest Not reverted are changes which may impact other applications or may not have been different from the start, such as: - `"User Account Control: Only elevate UIAccess applications that are installed in secure locations`" group policy " Write-Host $msg #Ask before continuing $opt_yes = New-Object System.Management.Automation.Host.ChoiceDescription "&Yes", "Undo changes made by Desktop+ scripts" $opt_no = New-Object System.Management.Automation.Host.ChoiceDescription "&No", 'Cancel' $options = [System.Management.Automation.Host.ChoiceDescription[]]($opt_yes, $opt_no) $result = $host.ui.PromptForChoice("", "Continue and undo these changes?", $options, 1) if ($result -eq 1) { exit } #Delete scheduled task if it exists schtasks /Query /TN "DesktopPlus Elevated" *>$null if ($LastExitCode -eq 0) { schtasks /Delete /TN "DesktopPlus Elevated" /F } #Remove certificates Get-ChildItem Cert:\LocalMachine\Root | Where-Object { $_.Subject -match $CertificateSubject } | Remove-Item Get-ChildItem Cert:\LocalMachine\CA | Where-Object { $_.Subject -match $CertificateSubject } | Remove-Item #Restore previously backed-up side-by-side manifest if it exists if (Test-Path -Path "EnableUIAccessDesktopPlusBackup.manifest") { Move-Item "EnableUIAccessDesktopPlusBackup.manifest" -Destination "..\DesktopPlus.exe.manifest" -Force } Write-Host "Done." Write-Output "`n" cmd /c pause ================================================ FILE: assets/profiles/Sample Profile.ini ================================================ [Overlay0] Name=Dashboard NameIsCustom=true Enabled=true DesktopID=0 CaptureSource=0 Width=165 Curvature=17 Opacity=100 OffsetRight=0 OffsetUp=0 OffsetForward=0 DisplayMode=3 Origin=Dashboard CroppingEnabled=false CroppingX=0 CroppingY=0 CroppingWidth=-1 CroppingHeight=-1 3DEnabled=false 3DMode=0 3DSwapped=false GazeFade=false GazeFadeDistance=0 GazeFadeRate=100 GazeFadeOpacity=0 UpdateLimitModeOverride=0 UpdateLimitMS=0 UpdateLimitFPS=7 InputEnabled=true InputDPlusLPEnabled=true GroupID=0 UpdateInvisible=false ShowFloatingUI=true ShowDesktopButtons=true ShowActionBar=true ActionBarOrderUseGlobal=true Transform=[2.12766 0 0 0 0 2.12766 0 0 0 0 2.12766 0 0 0 0 1] WinRTLastWindowTitle= WinRTLastWindowClassName= WinRTLastWindowExeName= WinRTDesktopID=-2 ActionBarOrderCustom=1 1;2 0;1000 1;1001 0;1002 0;1003 1;3 0;4 0;5 0; [Overlay1] Name=Dashboard 🡄 NameIsCustom=true Enabled=true DesktopID=0 CaptureSource=0 Width=100 Curvature=0 Opacity=100 OffsetRight=0 OffsetUp=0 OffsetForward=0 DisplayMode=3 Origin=Dashboard CroppingEnabled=false CroppingX=0 CroppingY=0 CroppingWidth=-1 CroppingHeight=-1 3DEnabled=false 3DMode=0 3DSwapped=false GazeFade=false GazeFadeDistance=0 GazeFadeRate=100 GazeFadeOpacity=0 UpdateLimitModeOverride=0 UpdateLimitMS=0 UpdateLimitFPS=7 InputEnabled=true InputDPlusLPEnabled=true GroupID=0 UpdateInvisible=false ShowFloatingUI=true ShowDesktopButtons=true ShowActionBar=false ActionBarOrderUseGlobal=true Transform=[1.84261 0 -1.06383 0 0 2.12766 0 0 1.06383 0 1.84261 0 -2.66135 0.425532 0.922328 1] WinRTLastWindowTitle= WinRTLastWindowClassName= WinRTLastWindowExeName= WinRTDesktopID=-2 ActionBarOrderCustom=1 1;2 0;1000 1;1001 0;1002 0;1003 1;3 0;4 0;5 0; [Overlay2] Name=Dashboard 🡆 NameIsCustom=true Enabled=true DesktopID=0 CaptureSource=0 Width=100 Curvature=0 Opacity=100 OffsetRight=0 OffsetUp=0 OffsetForward=0 DisplayMode=3 Origin=Dashboard CroppingEnabled=false CroppingX=0 CroppingY=0 CroppingWidth=-1 CroppingHeight=-1 3DEnabled=false 3DMode=0 3DSwapped=false GazeFade=false GazeFadeDistance=0 GazeFadeRate=100 GazeFadeOpacity=0 UpdateLimitModeOverride=0 UpdateLimitMS=0 UpdateLimitFPS=7 InputEnabled=true InputDPlusLPEnabled=true GroupID=0 UpdateInvisible=false ShowFloatingUI=true ShowDesktopButtons=true ShowActionBar=false ActionBarOrderUseGlobal=true Transform=[1.84261 0 1.06383 0 0 2.12766 0 0 -1.06383 0 1.84261 0 2.66135 0.425532 0.922327 1] WinRTLastWindowTitle= WinRTLastWindowClassName= WinRTLastWindowExeName= WinRTDesktopID=-2 ActionBarOrderCustom=1 1;2 0;1000 1;1001 0;1002 0;1003 1;3 0;4 0;5 0; [Overlay3] Name=Performance Monitor NameIsCustom=false Enabled=true DesktopID=0 CaptureSource=2 Width=20 Curvature=0 Opacity=75 OffsetRight=0 OffsetUp=0 OffsetForward=0 DisplayMode=0 Origin=5 CroppingEnabled=false CroppingX=0 CroppingY=0 CroppingWidth=-1 CroppingHeight=-1 3DEnabled=false 3DMode=0 3DSwapped=false GazeFade=true GazeFadeDistance=15 GazeFadeRate=150 GazeFadeOpacity=0 UpdateLimitModeOverride=0 UpdateLimitMS=0 UpdateLimitFPS=7 InputEnabled=false InputDPlusLPEnabled=true GroupID=0 UpdateInvisible=false ShowFloatingUI=true ShowDesktopButtons=false ShowActionBar=false ActionBarOrderUseGlobal=true Transform=[-0.0495577 0.263826 -0.963298 0 -0.423386 -0.879087 -0.218981 0 -0.904595 0.396994 0.155265 0 -0.104406 0.00957629 0.138933 1] WinRTLastWindowTitle= WinRTLastWindowClassName= WinRTLastWindowExeName= WinRTDesktopID=-2 ActionBarOrderCustom=1 1;2 0;1000 1;1001 0;1002 0;1003 0;3 0;4 0;5 0; ================================================ FILE: assets/readme.txt ================================================ Desktop+, an advanced SteamVR Desktop Overlay, by elvissteinjr -------------------------------------------------------------- Installation (GitHub Version) ----------------------------- Extract the complete archive if not done yet. Put the files in a location where they can stay. Run DesktopPlus.exe. This will also launch SteamVR if it's not already running. A VR-HMD must be connected. If everything is fine, a message will come up to indicate successful first-time setup. Desktop+ will continue running in the background as a SteamVR overlay application afterwards. If the message does not come up on the first launch, check the Troubleshooting section. Desktop+ will register itself as an overlay application to SteamVR and run automatically on following SteamVR launches. If you move the files of this application, you'll have to repeat these steps. Installation (Steam Version) ---------------------------- Simply install the application through Steam and launch it. This will also launch SteamVR if it's not already running. A VR-HMD must be connected. If everything is fine, a message will come up to indicate successful first-time setup. Desktop+ will continue running in the background as a SteamVR overlay application afterwards. If the message does not come up on the first launch, check the "Startup / Shutdown" settings in SteamVR and the Troubleshooting section. Updates ------- The latest version of Desktop+ can be found on https://github.com/elvissteinjr/DesktopPlus/ and on Steam. Uninstallation (GitHub Version) ------------------------------- Delete all files that came with the archive. SteamVR will automatically remove the overlay application entry when the executable isn't present anymore. Desktop+ does not write to files outside its own directory. However, if you did set up elevated mode, its scheduled task will remain. Uninstallation (Steam Version) ------------------------------ Uninstall the application through Steam. Steam will not delete your configuration and profiles. They can be found in "[Steam Library Path]\SteamApps\common\DesktopPlus" and be safely deleted if desired. These files are also synced to the Steam Cloud if that feature is enabled. Additionally, if you did set up elevated mode, its scheduled task will remain. User Guide ---------- A detailed user guide can be found on https://github.com/elvissteinjr/DesktopPlus/blob/master/docs/user_guide.md It's recommended to finish reading this document beforehand, however, as the user guide does not cover some topics this readme covers. Configuration ------------- Desktop+ can be fully configured from within VR. If desired, the settings interface can also be used from the desktop, however. Either run DesktopPlusUI.exe while SteamVR is not running, press [Restart in Desktop Mode] in the Troubleshooting section of the Settings window, or run DesktopPlusUI.exe with the "--DesktopMode" command line argument to do so. Some settings are only available while SteamVR is running. Settings are applied instantly and written to disk when the settings window is dismissed or Desktop+ closes. The setting slider values can be edited directly by right-clicking the slider. Overlay Management ------------------ All overlays in Desktop+ are listed in the Overlay Bar that appears in Desktop+'s SteamVR dashboard tab. They can be rearranged by dragging the icons across the bar. Clicking on an overlay's icon opens a menu to toggle visibility, duplicate, remove or open the Overlay Properties window for the selected overlay. The current overlay setup will be remembered automatically between sessions. Overlay profiles can be used to save and restore multiple of such setups. Actions ------- Desktop+ offers so-called actions which can be bound to controller buttons, the Floating UI or just executed from the list. Actions consist of a series of commands that can control the state of your overlays, simulate input and execute programs. Custom icons can be added by putting PNG files in the "images/icons" folder. Recommended size is 96x96 pixels. Global Shortcuts & Input Features --------------------------------- Actions can be bound to up to 20 different global shortcuts which can be activated by the SteamVR Input bindings. SteamVR doesn't list overlay applications in the regular application controller configuration list, but the Settings window in Desktop+ has buttons that lead directly into the input binding screen for Desktop+. Apart from the global shortcuts, bindings for Desktop+ laser pointer interaction can also be found. These mirror SteamVR's default laser pointer bindings for known devices, but can be adjusted as desired. There's also "Enable Global Laser Pointer", which can be used to enable the laser pointer outside of the dashboard. However, laser pointer auto-activation is enabled by default, making this binding not strictly necessary to use. Outside of the dashboard/when SteamVR's system laser pointer is not active, Desktop+ uses its own laser pointer implementation. This is allows for additional features that can be configured in the Laser Pointer section of the Settings window. Elevated Mode / Enabling UIAccess --------------------------------- As Desktop+ is subject to User Interface Privilege Isolation (UIPI), it can't simulate input or move the cursor when a higher privileged application (i.e. running as administrator) is in focus. Desktop+ offers multiple ways to deal with this, such as elevated mode or enabling UIAccess for the application. See "misc\!About this folder.txt" for details. Keyboard -------- Desktop+ comes with a custom VR keyboard. The used keyboard layout and behavior can be configured in the "Keyboard" section of the Settings window. Keys of the Desktop+ keyboard can be right-clicked to toggle their state. The application will not automatically release keys held down this way while it's running, so keep that in mind. Desktop+ tries to map the VR keyboard keys to the keyboard layout chosen in the OS to maximize compatibility, before falling back to string inputs. It's recommended to select a keyboard layout in Desktop+ that matches the one in the OS. Keyboard layouts can be created or modified in the Keyboard Layout Editor. This editor can only be accessed in desktop mode. In desktop mode, the editor can be found in the "Keyboard" section of the Settings window, after clicking on the Keyboard Layout button, [Switch to Keyboard Layout Editor] on the page that follows. Troubleshooting --------------- Desktop+ runs as two processes (DesktopPlus.exe & DesktopPlusUI.exe), both of which write log files in the application's install directory (DesktopPlus.log & DesktopPlusUI.log). While most errors will be displayed in VR, it is helpful to check the contents of these log files when troubleshooting. Make sure to include them when seeking help as well. In general, note that Desktop+ is using APIs which require Windows 8.1 or newer. Using Graphics Capture overlays requires at least Windows 10 1903 for basic support, Windows 10 2004 or newer for full support, and Windows 11 to remove the yellow border around captures (only visible on real display). Additionally, Windows 11 24H2 allows including secondary windows, such as context menus, in the capture. No first-time setup message / Desktop+ not auto-launching (Steam version): - The Steam version detects the need of first time setup by checking if an user configuration existed on launch. If you previously had Desktop+ installed or the configuration was synced from another machine via Steam Cloud, you can enable auto-launch manually in the "SteamVR" section of the Settings window or use [Restore Default Settings] in the "Troubleshooting" section to start fresh. Black screen with question mark display icon instead of desktop mirror: - An error occurred trying to duplicate the desktop. This may happen when displays were disconnected or are unavailable for another reason. You can try restarting Desktop+ or changing the capture method to Graphics Capture in the Overlay Properties window. Shaky/Delayed laser pointer: - By default, the laser pointed cursor may seem to lag behind a little bit, while other screen updates happen instantly. This is in order to reduce the CPU load. Enable "[x] Reduce Laser Pointer Latency" in the "Performance" section of the Settings window to increase the accuracy of the laser pointer. High GPU load when overlay visible and cursor moving: - In order to provide the lowest latency possible, all cursor updates are processed instantly, even if they occur more frequently than the screen's vertical blanks. Using the Frame Time limiter in "Update Limiter Mode" in the "Performance" section of either the Settings or Overlay Properties window with a low limit value can reduce the load from cursor movement while leaving other screen updates unaffected. Using laser pointer after moving real mouse: - By default the laser pointer will be deactivated after the physical mouse was moved. Click on the overlay to activate it again or disable "[x] Allow Laser Pointer Override" in the "Mouse" section of the Settings window to turn this feature off. Input not working in certain applications: - Input simulated by Desktop+ is subject to User Interface Privilege Isolation (UIPI), see the Elevated Mode readme section for a workaround. Overlay is no longer visible: - There are several settings controlling overlay visibility and position. Check if they are not set to unexpected values. Especially of interest are the cropping values. The cropping rectangle is preserved when switching between capture sources, but that also means it could be invalid for the newly selected mirrored window or desktop. If that's the case there will be a "(!)" warning next to the Cropping Rectangle section title. Simply reset it then. Oculus/Meta headsets: If all overlays, including the SteamVR dashboard disappear, this may be due to running a game that uses the headset's native APIs and as such bypasses SteamVR entirely. As Desktop+ relies on SteamVR to function, the only solution to this is to find a way to run the game with SteamVR. Potential global workaround for this is using Steam Link for Meta Quest or enabling the "Force Use SteamVR" option available in OpenVR Advanced Settings. Workarounds for some individual titles also exist, but are beyond the scope of this ReadMe. No overlays visible on laptop: - On laptops with hybrid-GPU solutions, the desktops are typically rendered on the power-saving integrated GPU. Make sure to have DesktopPlus.exe set to be running on integrated graphics so it can mirror them. Not all desktops from multiple GPUs available: - Desktop+ does not support Desktop Duplication with desktops distributed across multiple GPUs. It only supports copying one GPU's set of desktops over to the VR-rendering GPU when necessary. However, the missing desktops are typically still able to be mirrored by using Graphics Capture as the overlay's capture method. Warnings -------- Desktop+ may display several warnings in the Settings window. They are mostly informational and can be safely ignored. Click on warnings to dismiss or not have them show up again. "Compositor resolution is below 100%! This affects overlay rendering quality.": - The resolution of the VR compositor is based on the auto-resolution calculated by SteamVR, regardless of whether this resolution has been chosen as the VR render resolution or not. There's no official way to change this. The auto-resolution can be increased by lowering the HMD's refresh rate or getting a faster GPU. Unofficially, there are tools such as SteamVR-ForceCompositorScale to combat this behavior. "Overlay render quality is not set to high!": - The overlay render quality is a setting in SteamVR. It is recommended to set it to high to improve the visual clarity of the overlays. "Desktop+ is running with administrative privileges!": - This message serves as a reminder about Desktop+ being elevated. Using Desktop+'s elevated mode is recommended over running all of Desktop+ with administrative privileges. "Elevated mode is active!": - This message serves as a reminder about Desktop+ being in elevated mode. Please keep the security implications of that mode in mind and leave it once it's not needed anymore. "The application profile for [application name] has overridden the current overlay layout. Changes made to overlays are not saved automatically while it is active.": - This message serves as a reminder that an application profile is active. Automatic saving of overlays is disabled while this is the case. Update the assigned overlay profile if you wish to make permanent changes that go with the application profile. "An elevated process has focus! Desktop+ is unable to simulate input right now." - User Interface Privilege Isolation (UIPI) prevents Desktop+ from simulating input when an elevated process has focus. This warning persists until the a window with the same or lesser privilege level has gained focus again. Clicking on this warning also offers the option to have Desktop+ try to open the task switcher to change the focus to another window or to enter elevated mode (only if the scheduled task is configured). "An overlay creation failed!": - This message will typically appear with "(Maximum Overlay limit exceeded)" appended. It appears when the total overlay limit in SteamVR has been exceeded. This limit is not set by Desktop+ and other overlay applications can affect how many overlays can be created by Desktop+. While the warning can be safely ignored, the overlays that were attempted to be created will be missing. If this message appears with a different error status appended, it might be because of a bug in Desktop+ or SteamVR. Please report it in that case. "An unexpected error occurred in a Graphics Capture thread!": - This message appears when a Graphics Capture thread crashed. One or more overlays using Graphics Capture will not be updated anymore. While this shouldn't ever happen, this message can be safely ignored if it only appears once. The affected overlays will need to have their source be set again from either changing it or reloading a profile. "Desktop+ is no longer running with UIAccess privileges!": - This message appears when Desktop+ was previously configured to run with UIAccess privileges but no longer is. UIAccess is enabled by patching the DesktopPlus.exe executable and as such is not retained across application updates. Simply redo the process of enabling UIAccess to fix this. "Browser overlays are being used, but the Desktop+ Browser component is currently not available.": - Browser overlays require the optional Desktop+ Browser application component. It can be installed from https://github.com/elvissteinjr/DesktopPlusBrowser or Steam (as DLC for Desktop+). "The installed Desktop+ Browser component is incompatible with this version of Desktop+!": - The installed version of Desktop+ Browser must be compatible with the running version of Desktop+. While not all updates require a new version to be installed, it is generally a recommended to use the latest builds of both. License ------- Desktop+ is licensed under the GPL 3.0. For the third-party licenses, see third-party_licenses.txt. ================================================ FILE: assets/third-party_licenses.txt ================================================ Desktop+ includes work of the following third-party projects: OpenVR, which is covered by the following license: - Copyright (c) 2015, Valve Corporation All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -------------------------------------------------------------------------------- Dear ImGui, which is covered by the following license: - The MIT License (MIT) Copyright (c) 2014-2020 Omar Cornut Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -------------------------------------------------------------------------------- DXGI Desktop Duplication Sample, which is covered by the following license: - The MIT License (MIT) Copyright (c) Microsoft Corporation Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -------------------------------------------------------------------------------- Win32CaptureSample, which is covered by the following license: - MIT License Copyright (c) 2019 Robert Mikhayelyan Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -------------------------------------------------------------------------------- ImPlot, which is covered by the following license: - MIT License Copyright (c) 2020 Evan Pezent Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -------------------------------------------------------------------------------- Radial Follow Smoothing (specifically RadialFollowCore.cs only), which is covered by the following license: - Mozilla Public License, version 2.0 1. Definitions 1.1. “Contributor” means each individual or legal entity that creates, contributes to the creation of, or owns Covered Software. 1.2. “Contributor Version” means the combination of the Contributions of others (if any) used by a Contributor and that particular Contributor’s Contribution. 1.3. “Contribution” means Covered Software of a particular Contributor. 1.4. “Covered Software” means Source Code Form to which the initial Contributor has attached the notice in Exhibit A, the Executable Form of such Source Code Form, and Modifications of such Source Code Form, in each case including portions thereof. 1.5. “Incompatible With Secondary Licenses” means that the initial Contributor has attached the notice described in Exhibit B to the Covered Software; or that the Covered Software was made available under the terms of version 1.1 or earlier of the License, but not also under the terms of a Secondary License. 1.6. “Executable Form” means any form of the work other than Source Code Form. 1.7. “Larger Work” means a work that combines Covered Software with other material, in a separate file or files, that is not Covered Software. 1.8. “License” means this document. 1.9. “Licensable” means having the right to grant, to the maximum extent possible, whether at the time of the initial grant or subsequently, any and all of the rights conveyed by this License. 1.10. “Modifications” means any of the following: any file in Source Code Form that results from an addition to, deletion from, or modification of the contents of Covered Software; or any new file in Source Code Form that contains any Covered Software. 1.11. “Patent Claims” of a Contributor means any patent claim(s), including without limitation, method, process, and apparatus claims, in any patent Licensable by such Contributor that would be infringed, but for the grant of the License, by the making, using, selling, offering for sale, having made, import, or transfer of either its Contributions or its Contributor Version. 1.12. “Secondary License” means either the GNU General Public License, Version 2.0, the GNU Lesser General Public License, Version 2.1, the GNU Affero General Public License, Version 3.0, or any later versions of those licenses. 1.13. “Source Code Form” means the form of the work preferred for making modifications. 1.14. “You” (or “Your”) means an individual or a legal entity exercising rights under this License. For legal entities, “You” includes any entity that controls, is controlled by, or is under common control with You. For purposes of this definition, “control” means (a) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (b) ownership of more than fifty percent (50%) of the outstanding shares or beneficial ownership of such entity. 2. License Grants and Conditions 2.1. Grants Each Contributor hereby grants You a world-wide, royalty-free, non-exclusive license: under intellectual property rights (other than patent or trademark) Licensable by such Contributor to use, reproduce, make available, modify, display, perform, distribute, and otherwise exploit its Contributions, either on an unmodified basis, with Modifications, or as part of a Larger Work; and under Patent Claims of such Contributor to make, use, sell, offer for sale, have made, import, and otherwise transfer either its Contributions or its Contributor Version. 2.2. Effective Date The licenses granted in Section 2.1 with respect to any Contribution become effective for each Contribution on the date the Contributor first distributes such Contribution. 2.3. Limitations on Grant Scope The licenses granted in this Section 2 are the only rights granted under this License. No additional rights or licenses will be implied from the distribution or licensing of Covered Software under this License. Notwithstanding Section 2.1(b) above, no patent license is granted by a Contributor: for any code that a Contributor has removed from Covered Software; or for infringements caused by: (i) Your and any other third party’s modifications of Covered Software, or (ii) the combination of its Contributions with other software (except as part of its Contributor Version); or under Patent Claims infringed by Covered Software in the absence of its Contributions. This License does not grant any rights in the trademarks, service marks, or logos of any Contributor (except as may be necessary to comply with the notice requirements in Section 3.4). 2.4. Subsequent Licenses No Contributor makes additional grants as a result of Your choice to distribute the Covered Software under a subsequent version of this License (see Section 10.2) or under the terms of a Secondary License (if permitted under the terms of Section 3.3). 2.5. Representation Each Contributor represents that the Contributor believes its Contributions are its original creation(s) or it has sufficient rights to grant the rights to its Contributions conveyed by this License. 2.6. Fair Use This License is not intended to limit any rights You have under applicable copyright doctrines of fair use, fair dealing, or other equivalents. 2.7. Conditions Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in Section 2.1. 3. Responsibilities 3.1. Distribution of Source Form All distribution of Covered Software in Source Code Form, including any Modifications that You create or to which You contribute, must be under the terms of this License. You must inform recipients that the Source Code Form of the Covered Software is governed by the terms of this License, and how they can obtain a copy of this License. You may not attempt to alter or restrict the recipients’ rights in the Source Code Form. 3.2. Distribution of Executable Form If You distribute Covered Software in Executable Form then: such Covered Software must also be made available in Source Code Form, as described in Section 3.1, and You must inform recipients of the Executable Form how they can obtain a copy of such Source Code Form by reasonable means in a timely manner, at a charge no more than the cost of distribution to the recipient; and You may distribute such Executable Form under the terms of this License, or sublicense it under different terms, provided that the license for the Executable Form does not attempt to limit or alter the recipients’ rights in the Source Code Form under this License. 3.3. Distribution of a Larger Work You may create and distribute a Larger Work under terms of Your choice, provided that You also comply with the requirements of this License for the Covered Software. If the Larger Work is a combination of Covered Software with a work governed by one or more Secondary Licenses, and the Covered Software is not Incompatible With Secondary Licenses, this License permits You to additionally distribute such Covered Software under the terms of such Secondary License(s), so that the recipient of the Larger Work may, at their option, further distribute the Covered Software under the terms of either this License or such Secondary License(s). 3.4. Notices You may not remove or alter the substance of any license notices (including copyright notices, patent notices, disclaimers of warranty, or limitations of liability) contained within the Source Code Form of the Covered Software, except that You may alter any license notices to the extent required to remedy known factual inaccuracies. 3.5. Application of Additional Terms You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations to one or more recipients of Covered Software. However, You may do so only on Your own behalf, and not on behalf of any Contributor. You must make it absolutely clear that any such warranty, support, indemnity, or liability obligation is offered by You alone, and You hereby agree to indemnify every Contributor for any liability incurred by such Contributor as a result of warranty, support, indemnity or liability terms You offer. You may include additional disclaimers of warranty and limitations of liability specific to any jurisdiction. 4. Inability to Comply Due to Statute or Regulation If it is impossible for You to comply with any of the terms of this License with respect to some or all of the Covered Software due to statute, judicial order, or regulation then You must: (a) comply with the terms of this License to the maximum extent possible; and (b) describe the limitations and the code they affect. Such description must be placed in a text file included with all distributions of the Covered Software under this License. Except to the extent prohibited by statute or regulation, such description must be sufficiently detailed for a recipient of ordinary skill to be able to understand it. 5. Termination 5.1. The rights granted under this License will terminate automatically if You fail to comply with any of its terms. However, if You become compliant, then the rights granted under this License from a particular Contributor are reinstated (a) provisionally, unless and until such Contributor explicitly and finally terminates Your grants, and (b) on an ongoing basis, if such Contributor fails to notify You of the non-compliance by some reasonable means prior to 60 days after You have come back into compliance. Moreover, Your grants from a particular Contributor are reinstated on an ongoing basis if such Contributor notifies You of the non-compliance by some reasonable means, this is the first time You have received notice of non-compliance with this License from such Contributor, and You become compliant prior to 30 days after Your receipt of the notice. 5.2. If You initiate litigation against any entity by asserting a patent infringement claim (excluding declaratory judgment actions, counter-claims, and cross-claims) alleging that a Contributor Version directly or indirectly infringes any patent, then the rights granted to You by any and all Contributors for the Covered Software under Section 2.1 of this License shall terminate. 5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user license agreements (excluding distributors and resellers) which have been validly granted by You or Your distributors under this License prior to termination shall survive termination. 6. Disclaimer of Warranty Covered Software is provided under this License on an “as is” basis, without warranty of any kind, either expressed, implied, or statutory, including, without limitation, warranties that the Covered Software is free of defects, merchantable, fit for a particular purpose or non-infringing. The entire risk as to the quality and performance of the Covered Software is with You. Should any Covered Software prove defective in any respect, You (not any Contributor) assume the cost of any necessary servicing, repair, or correction. This disclaimer of warranty constitutes an essential part of this License. No use of any Covered Software is authorized under this License except under this disclaimer. 7. Limitation of Liability Under no circumstances and under no legal theory, whether tort (including negligence), contract, or otherwise, shall any Contributor, or anyone who distributes Covered Software as permitted above, be liable to You for any direct, indirect, special, incidental, or consequential damages of any character including, without limitation, damages for lost profits, loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses, even if such party shall have been informed of the possibility of such damages. This limitation of liability shall not apply to liability for death or personal injury resulting from such party’s negligence to the extent applicable law prohibits such limitation. Some jurisdictions do not allow the exclusion or limitation of incidental or consequential damages, so this exclusion and limitation may not apply to You. 8. Litigation Any litigation relating to this License may be brought only in the courts of a jurisdiction where the defendant maintains its principal place of business and such litigation shall be governed by laws of that jurisdiction, without reference to its conflict-of-law provisions. Nothing in this Section shall prevent a party’s ability to bring cross-claims or counter-claims. 9. Miscellaneous This License represents the complete agreement concerning the subject matter hereof. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. Any law or regulation which provides that the language of a contract shall be construed against the drafter shall not be used to construe this License against a Contributor. 10. Versions of the License 10.1. New Versions Mozilla Foundation is the license steward. Except as provided in Section 10.3, no one other than the license steward has the right to modify or publish new versions of this License. Each version will be given a distinguishing version number. 10.2. Effect of New Versions You may distribute the Covered Software under the terms of the version of the License under which You originally received the Covered Software, or under the terms of any subsequent version published by the license steward. 10.3. Modified Versions If you create software not governed by this License, and you want to create a new license for such software, you may create and use a modified version of this License if you rename the license and remove any references to the name of the license steward (except to note that such modified license differs from this License). 10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses If You choose to distribute Source Code Form that is Incompatible With Secondary Licenses under the terms of this version of the License, the notice described in Exhibit B of this License must be attached. Exhibit A - Source Code Form License Notice This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. If it is not possible or desirable to put the notice in a particular file, then You may include the notice in a location (such as a LICENSE file in a relevant directory) where a recipient would be likely to look for such a notice. You may add additional accurate notices of copyright ownership. Exhibit B - “Incompatible With Secondary Licenses” Notice This Source Code Form is “Incompatible With Secondary Licenses”, as defined by the Mozilla Public License, v. 2.0. -------------------------------------------------------------------------------- ================================================ FILE: docs/user_guide.md ================================================ # Desktop+ User Guide This document explains the options in Desktop+ and possible usage scenarios in greater detail. It is generally not required to be read in order to get started with Desktop+, but can serve as a reference if one does get stuck. This guide does not touch upon all topics covered by the [readme file](../assets/readme.txt). It's recommended to read it beforehand. # Contents * [Glossary](#glossary) * [Interface](#interface) * [Overlay Bar](#overlay-bar) * [Floating UI](#floating-ui) * [Main Bar](#main-bar) * [Action Bar](#action-bar) * [Settings Window](#settings-window) * [Main Page](#main-page) * [Interface](#interface) * [Environment](#environment) * [Profiles](#profiles) * [Actions](#actions) * [Keyboard](#keyboard) * [Mouse](#mouse) * [Laser Pointer](#laser-pointer) * [Window Overlays](#window-overlays) * [Browser](#browser) * [Performance](#performance) * [Version Info](#version-info) * [Warnings](#warnings) * [Startup](#startup) * [Troubleshooting](#troubleshooting) * [Persistent UI Page](#persistent-ui-page) * [Windows](#windows) * [Manage Overlay Profiles Page](#manage-overlay-profiles-page) * [Manage Application Profiles Page](#manage-application-profiles-page) * [Manage Actions Page](#manage-actions-page) * [Edit Action Page](#manage-actions-page) * [Button Appearance](#button-appearance) * [Commands](#commands) * [Change Action Order Page](#change-action-order-page) * [Keyboard Layout Page](#keyboard-layout-page) * [Key Clusters](#key-clusters) * [Restore Default Settings Page](#restore-default-settings-page) * [Overlay Properties](#overlay-properties) * [Main Page](#main-page-1) * [Position](#position) * [Appearance](#appearance) * [Capture](#capture) * [Performance Monitor](#performance-monitor) * [Browser](#browser-1) * [Advanced](#advanced) * [Performance](#performance-1) * [Interface](#interface-2) * [Change Overlay Position Page](#change-overlay-position-page) * [Manual Adjustment](#manual-adjustment) * [Additional Offset](#additional-offset) * [Drag Settings](#drag-settings) * [Cropping Area Page](#cropping-area-page) * [Manual Adjustment](#manual-adjustment-1) * [Desktop Mode](#desktop-mode) * [Tools](#tools) * [Overlays](#overlays) * [Keyboard Controls](#keyboard-controls) * [Desktop+ Keyboard](#desktop-keyboard) * [Keyboard Layout Editor](#keyboard-layout-editor) * [Key List](#key-list) * [Key Properties](#key-properties) * [Layout Metadata](#layout-metadata) * [Keyboard Preview](#keyboard-preview) * [Performance Considerations](#performance-considerations) * [Desktop Duplication](#desktop-duplication-1) * [Graphics Capture](#graphics-capture-1) * [Desktop Duplication vs. Graphics Capture](#desktop-duplication-vs-graphics-capture) * [Desktop Duplication](#desktop-duplication-2) * [Mirroring at Unconstrained Frame-Rates](#mirroring-at-unconstrained-frame-rates) * [Graphics Capture](#graphics-capture-2) * [Graphics Capture Feature Support](#graphics-capture-feature-support) * [VR Interactions](#vr-interactions) * [Usage Examples](#usage-examples) * [Attach Overlay to a Motion-Controller, Wristwatch-Style](#attach-overlay-to-a-motion-controller-wristwatch-style) * [Show Multiple Desktops or Windows in the Dashboard at Once](#show-multiple-desktops-or-windows-in-the-dashboard-at-once) * [Simulate Keyboard Shortcut from Motion-Controller Input](#simulate-keyboard-shortcut-from-motion-controller-input) * [Advanced Features](#advanced-features) * [Hidden Configuration Settings](#hidden-configuration-settings) * [System-wide Modifications](#system-wide-modifications) * [Command-Line Arguments](#command-line-arguments) * [Desktop+ Browser](#desktop-browser) # Glossary These are some of the terms used across the application and its documentation. ### Overlay An overlay in the context of SteamVR refers to a 2D surface displayed either in the SteamVR dashboard or somewhere in the VR space. In Desktop+, "overlay" usually only refers to overlays that belong to the application, unless it's explicitly spelled out as "SteamVR overlay". ### Dashboard Dashboard in the context of SteamVR refers to the menu that appears when using the system menu button in SteamVR. ### Floating UI An interface fading in when hovering an overlay, consisting of a Main Bar with quick access to disabling the overlay, toggling drag-mode, overlay-specific buttons and showing an additional Action Bar with customizable buttons. ### Action Action in the context of Desktop+ refers to a series of commands that can control the ,state of your overlays simulate input and execute programs. Actions can be user-created and bound to controller buttons, the Floating UI, or just executed from the action list. ### Desktop Duplication One of the capture methods available for capturing desktops for overlay display. Its name comes from the DXGI Desktop Duplication API it is using. ### Graphics Capture One of the capture methods available for capturing desktops and windows for overlay display. Its name comes from the Graphics Capture API it's using. ### Gaze Fade A method to automatically adjust an overlay's opacity based on the user's gaze. The method in Desktop+ is distance-based, as opposed to other angle-based approaches. ### Browser Overlay Overlays using the Desktop+ Browser component, a Chromium Embedded Framework-based internal web browser. This application component is optional and has to be installed separately, either from https://github.com/elvissteinjr/DesktopPlusBrowser or Steam (as DLC for Desktop+). Options related to browser overlays are hidden if the application component is not installed. ### Primary Dashboard Overlay The first visible overlay with the dashboard origin. It is used a reference or fallback in some scenarios, but isn't strictly required to exist. # Interface ## Overlay Bar ![Overlay Bar, Below the SteamVR Dashboard](images/overlay_bar.png) The Overlay Bar appears in the Desktop+ dashboard tab and allows managing all active overlays, as well as accessing the settings window. - **(Overlay Buttons)**: Click on the button to pop up a menu with options to show/hide, duplicate, remove the overlay, or to change the overlay's properties. The Overlay Properties window can only be shown for one overlay at once. Trying to show it for another will make the existing window switch to that overlay. The overlay buttons can also be double-clicked to toggle visibility, right-clicked to quickly access the overlay properties, and long-pressed for a few seconds to reset the Overlay Properties window position. Pointing at the SteamVR dashboard will result in the Overlay Bar to fade out temporarily. This is to allow using the dashboard's drag handle, as well as to make space for elements of the dashboard that may slide out on interaction. - **[+]**: Adds a new overlay. A menu will pop up, listing the available overlay types/capture sources. After choosing one, keep holding the trigger to drag the newly created overlay to the desired spot and then let it go. If the trigger was released immediately, it requires an additional click to let the overlay go. - **[⛭]**: Shows or hides the settings window. ## Floating UI ![Floating UI, Below the Hovered Desktop+ Overlay](images/floating_ui.png) The Floating UI appears when pointing at an overlay and consists of a Main bar allow quick access to overlay functions, as well as an additional Action Bar with customizable buttons. The primary dashboard overlay always displays its Floating UI as long as no other overlay is being hovered. ### Main Bar - **Toggle Action Bar ([...])**: Toggles visibility of the Action Bar. It appears right above the Main Bar. - **Enable/Disable Drag-Mode ([Arrows])**: Toggles the overlay drag-mode. While drag-mode is enabled, all laser pointer input on drag overlays around instead. During drags, use vertical scroll input to change the distance to the overlay and horizontal scroll input to resize it. Right-click on overlays to perform a two-handed gesture drag instead, which allows to rotate and scale the overlay in place. This button can be long-pressed for a few seconds to lock the overlay's position instead. - **Hide Overlay ([X])**: Hides the overlay. This is the same as pressing "Hide" in the Overlay Bar. This button can be long-pressed for a few seconds to remove the overlay instead. - **Add Active Window as Overlay ([Window with Arrow])** (only visible for desktop overlays): Press and hold this button to add a new overlay of the currently focused window. This is similar to adding a new overlay in the Overlay Bar. The new overlay will start as being dragged, allowing you to position it. This button can be hidden via the ["[x] Show Extra Buttons"](#interface-2) overlay property. - **Reset Cumulative Values ([Performance Monitor Refresh Icon])** (only visible for Performance Monitor overlays): Resets most values of the Performance Monitor. This includes everything that represent an average or is counted up over time. This button can be hidden via the ["[x] Show Extra Buttons"](#interface-2) overlay property. - **Go to Previous Page ([🡸])** (only visible for browser overlays): Goes back in the browser's navigation history. This button can be hidden via the ["[x] Show Extra Buttons"](#interface-2) overlay property. - **Go to Next Page ([🡺])** (only visible for browser overlays): Goes forward in the browser's navigation history. This button can be hidden via the ["[x] Show Extra Buttons"](#interface-2) overlay property. - **Refresh Current Page/Stop Page Load ([⟳/🚫])** (only visible for browser overlays): Refreshes/reloads the current page or stops if it's currently loading. This button can be hidden via the ["[x] Show Extra Buttons"](#interface-2) overlay property. ### Action Bar The Action Bar contains a set of customizable action buttons which can be set either globally or for individual overlays. Pressing on action buttons will execute the associated action. Actions pressing keys will hold them as long as the button is held and release them once the button is released. The *Show Keyboard* action button can be long-pressed for a few seconds to reset the [VR Keyboard's](#desktop-keyboard) position. ## Settings Window ### Main Page #### Interface ![Settings Window, Main Page, Interface Section](images/settings_interface.png) - **Language**: Change the application language. On first launch, Desktop+ tries to set this to the operating system's language if a matching translation is available. Some of the languages listed are community translations, which may lag behind after updates and be incomplete. - **[x] Show Advanced Settings**: Sets if settings marked as advanced are being shown. Advanced settings are rarely-used settings and more in-depth options for other, always displayed settings. When unticked, relevant settings are only hidden in the interface, not turned off. Advanced settings are marked with *(Adv.)* in this document. - **[x] Drag Windows When Clicking on Blank Space** (Adv.): Sets if Desktop+ interface windows can be dragged by pressing and holding anywhere on the window as long as there's no widget in the way. When unticked, interface windows can only be dragged from the title bar. - **Persistent UI** (Adv.): Press the button to manage the [Persistent UI settings](#persistent-ui-page). - **Desktop Buttons Listing Style**: Changes the way the desktops are listed on the Action Bar or if at all. - **[x] Add Combined Desktop**: Adds a button for the combined desktop to the Action Bar. #### Environment ![Settings Window, Main Page, Environment Section](images/settings_environment.png) - **Background Color**: Allows to partially or fully cover the VR scene in the specified color, either only while looking at the Desktop+ dashboard tab or at all times. Click on the color button to switch to the color picker page and click on the drop-down list to choose when the background color appears. On the color picker page, click on the "Original" preview box to restore the previous value. Right click the picker to switch between hue bar and hue wheel style pickers. - **Dim Interface**: Dims the SteamVR dashboard and Desktop+ UI while the Desktop+ dashboard tab is open. #### Profiles ![Settings Window, Main Page, Profiles Section](images/settings_profiles.png) - **Overlay Profiles**: Press the button to manage overlay profiles. Overlay profiles allow saving and loading multiple overlay setups. - **Application Profiles**: Press the button to manage application profiles. Application profiles allow to automatically load an overlay profile or execute actions when a SteamVR application is launched. #### Actions ![Settings Window, Main Page, Actions Section](images/settings_actions.png) - **Actions**: Press [Manage] to go to the [Manage Actions page](#manage-actions-page). - **Action Buttons (Default)**: Press [X Actions Selected] to change the default order of action buttons displayed in the Floating UI. - **Action Buttons (Overlay Bar)** (Adv.): Press [X Actions Selected] to change the order of action buttons displayed in the Overlay Bar. - **Active Controller Buttons** Controller bindings when pointing at a Desktop+ overlay. The actual buttons used for these are defined in the VR Dashboard SteamVR input bindings. - **[Show Controller Bindings]** (only visible when SteamVR is running): Open the SteamVR Controller Bindings screen for the VR Dashboard. - **(Table)**: Action triggered when pressing the "Go Home" or "Go Back" button. This is typically one of the face buttons on the controller by default. Click one of the Action column cells to change the action. - **Global Controller Buttons** Controller bindings when the dashboard is closed and not pointing at any overlay. The buttons used for these are defined in the Desktop+ SteamVR input bindings. These bindings will trigger globally as long as no laser pointer is active. - **[Show Controller Bindings]** (only visible when SteamVR is running): Open the SteamVR Controller Bindings screen for Desktop+. - **(Table)**: Action triggered when pressing the respective bound global shortcut input. Click one of the Action column cells to change the action. - **[Add Shortcut]**: Add another shortcut. Up to 20 shortcuts can be added. - **Hotkeys**: System-wide keyboard shortcuts. Hotkeys block other applications from receiving that input and may not work if the same combination has already been registered elsewhere. Desktop+ will not register a hotkey if no action is assigned to it. Most hotkeys without modifiers will not work while elevated applications have window focus. - **(Hotkey Column)**: Keyboard shortcut that triggers the action. Click on the cell to change the hotkey. - **(Action Column)**: Action triggered when pressing the respective hotkey. Click on the cell to change the action. - **[Remove]**: Remove the hotkey in the hovered row. - **[Add Hotkey]**: Add another hotkey. There's no upper limit on hotkeys. #### Keyboard ![Settings Window, Main Page, Keyboard Section](images/settings_keyboard.png) - **Keyboard Layout**: Press the button to change the keyboard layout of the Desktop+ keyboard. In desktop mode, the Keyboard Layout Editor can be accessed from there as well. - **Size**: Size of the Desktop+ keyboard. This slider adjusts the size for both inside and outside of the dashboard. Manage [Persistent UI settings](#persistent-ui-page) or resize the keyboard while dragging to adjust them individually. - **Behavior**: - **[x] Sticky Modifier Keys**: Sets if the modifier keys (ctrl, alt, shift, win) stay pressed until another non-modifier key is pressed. - **[x] Key Repeat**: Sets if the key inputs are repeated when held down. Some keys do not repeat even with this enabled in order to mimic real keyboard behavior. - **Show Automatically**: Sets if the Desktop+ keyboard appears automatically when focusing a text input field and disappears again when unfocusing (unless it was manually brought up before). This behavior is experimental for desktop and window overlays as there's no reliable way to detect all input fields. It works reasonably well for applications using native controls or sending the correct assistive events. The keyboard is always shown automatically for Desktop+ UI elements. - **[x] For Desktop & Window Overlays**: Sets if the keyboard is shown automatically for desktop & window overlays. - **[x] For Browser Overlays** (only available when Desktop+ Browser is installed): Sets if the keyboard is shown automatically for browser overlays. #### Mouse ![Settings Window, Main Page, Mouse Section](images/settings_mouse.png) - **[x] Show Cursor**: Sets if the cursor is rendered on top of the mirrored overlay. Graphics Capture overlays hide the cursor automatically when the source window is not in focus. - **[x] Use Smooth Scrolling**: Sets if smooth scrolling is used instead of discrete mouse wheel-like scrolling. Smooth scrolling also allows for horizontal and minute scrolling in applications that support it. - **[x] Simulate as Pen Input**: Sets if laser pointer input simulate a touch pen input device instead of a mouse. This enables gestures meant for pen inputs, such as click drag scrolling in many applications and holding down left-click to perform a right click. Some of the pen input behaviors are configurable on the OS-end, and may need to be enabled first. - **[x] Allow Laser Pointer Override**: Disables the laser pointer when the physical mouse is moved rapidly. Click the overlay to get the laser pointer back. This option is primarily useful when sitting in front of the desk using the real mouse and keyboard while wearing the headset to view the desktop. - **Double-Click Assistant**: Freezes the mouse cursor for the set duration to ease the input of double-clicks. The "Auto" setting uses the double-click duration configured in Windows. Moving larger distances from the frozen cursor position cancels the Double-Click Assistant. - **Input Smoothing**: Sets the level of smoothing/stabilization applied to mouse inputs. #### Laser Pointer ![Settings Window, Main Page, Laser Pointer Section](images/settings_laser_pointer.png) These settings apply to Desktop+'s laser pointer only. - **[x] Block Game Input while Active**: Sets if the laser pointer being active blocks the game from receiving inputs. Even if this is disabled, inputs bound for the laser pointer still take priority over the game's controller bindings and aren't sent to the game. - **Auto-Activation Max Distance**: Maximum allowed distance between overlay and pointing controller to automatically toggle interaction mode while the dashboard is closed. This can be set to "Off" by dragging the slider into the left-most position. - **[x] Gaze-based HMD-Pointer** (Adv.): Enables using HMD gaze to point at Desktop+ overlays. The Auto-Activation Max Distance value is used here as well, if no keyboard key is set for the toggle input action. - **(Table)**: Input action triggered when pressing the respective keyboard key. Click one of the Keyboard Key column cells to change the keyboard key. The keyboard keys are optional can stay unset for gaze-only input. #### Window Overlays ![Settings Window, Main Page, Window Overlays Section](images/settings_window_overlays.png) - **[x] Focus Game on Dashboard Deactivation** (Adv.): Tries to change the foreground window to the current VR game after the dashboard was closed. Some games may pause or decide to not process inputs when not being in focus on the desktop. Note that some applications such as SteamVR Home do not have a desktop window at all. - **[x] Focus Window when Pointing at Overlay** (Adv.): Tries to change the foreground window to the mirrored window when pointing at the overlay. This generally recommended to be left enabled in order to prevent unintended inputs on other windows. Note that always-on-top windows will still be in front of the mirrored window and could possibly take the mouse input instead unless the mirrored window is always-on-top as well. - **[x] Keep Window on Screen** (Adv.): Prevents the mirrored window from being outside of the nearest desktop's work area (the space a maximized window takes up). The window is not resized if it does not fit into this space. - **[x] Adjust Overlay Size when Window Resizes**: Automatically adjusts the overlay size when the mirrored window's size changes. This directly affects the overlay's width property. - **[x] Focus Game when Laser Pointer leaves Overlay**: Tries to change the foreground window to the current VR game when the laser pointer leaves a Graphics Capture window overlay. - **On Window Drag** (Adv.): Changes what happens when a window is being dragged. The selected option is only triggered on window drags initiated by Desktop+. - **On Capture Loss** (Adv.): Changes what happens when a window capture is being lost. This usually happens after the target window was closed, but will trigger on any kind of capture loss. The "Hide Overlay" option also automatically shows the overlay again when the capture gets restored. #### Browser ![Settings Window, Main Page, Browser Section](images/settings_browser.png) *This is only available if the Desktop+ Browser application component is installed* - **Maximum Frame Rate**: The maximum amount of frames per second browsers overlays will render at. Browser overlays render at variable frame-rates and will not update the overlay if there are no changes. - **[x] Content Blocker**: Sets if the content blocker is enabled. The content blocker built into Desktop+ Browser takes block lists in the AdblockPlus syntax, but doesn't implement cosmetic filters. Desktop+ does not come with any block lists by default. They can be added by placing lists files in "DesktopPlusBrowser\content_block". All lists present in the directory will be loaded and used. #### Performance ![Settings Window, Main Page, Performance Section](images/settings_performance.png) These settings allow tweaking the performance characteristics of Desktop+. However, changing any of them should not be required for good results. - **Update Limiter** - **Limiter Mode** (Adv.): Sets the global limiter mode. May be overridden by overlay-specific update limiter settings. - **(Limit Slider)**: Sets the limit in either ms or frames per second. - **Desktop Duplication** (Adv.) - **[x] Reduce Laser Pointer Latency**: When this is active, the cursor position is updated instantly while pointing at the overlay. This causes high CPU load, but makes the laser pointer more responsive. - **[x] Single Desktop Mirroring**: Mirrors individual desktops instead of cropping from the combined desktop. All Desktop Duplication overlays will be showing the same desktop when this is active. There can be a noticeable performance impact when multiple desktops update constantly. This setting can be used to mitigate it. - **[x] Alternative Cursor Rendering**: Enables use of alternative methods to retrieve the software cursor image, instead of relying on the cursor returned by the Desktop Duplication API. This rendering method is slightly slower than the regular one and doesn't support cursor animation. It is intended for users experiencing issues with the hardware cursor capture using Desktop Duplication. If other means to retrieve the current cursor fail, it may additionally fall back to using the default cursor image or a built-in alternative. - **[x] HDR Mirroring** Enables mirroring of desktops and windows using higher bit-depth textures, supporting HDR output. While the full bit-depth is passed to SteamVR, there are no known HMDs capable of making use of HDR output. The primary use-case for this setting is to fix SDR content not being captured correctly while HDR is enabled in the OS. This setting is still considered experimental. - **[x] Show FPS in Floating UI** When this is active, the number of captured or rendered frames per second, at which the overlay is updated, is displayed in the Floating UI. This number will be the same for all Desktop Duplication overlays, since they share a single backing texture. #### Version Info ![Settings Window, Main Page, Version Info Section](images/settings_version_info.png) Displays version information of the running build of Desktop+. #### Warnings ![Settings Window, Main Page, Warnings Section](images/settings_warnings.png) - **Warnings Hidden**: Shows how many warnings have been hidden by clicking on "Don't show this again". - **[Reset Hidden Warnings]**: Resets all hidden warnings, causing them to show up again when their condition is fulfilled. #### Startup ![Settings Window, Main Page, Startup Section](images/settings_startup.png) - **[x] Launch Automatically on SteamVR Startup**: Sets if Desktop+ is launched automatically alongside SteamVR. This setting controls the SteamVR application configuration value directly and as such is saved and restored by SteamVR itself. - **[x] Disable Steam Integration** (only available if Desktop+ is being run by Steam): Restarts Desktop+ without Steam when it was launched by it. This disables the permanent in-app status, usage time statistics and other Steam features. There will still be a brief in-app status and notification from Desktop+ being launched by Steam even if this is active. Steam Cloud functionality may not work as expected. An alternative to this option is marking Desktop+ as private on the Steam profile. #### Troubleshooting ![Settings Window, Main Page, Troubleshooting Section](images/settings_troubleshooting.png) These buttons let you quickly restart components of Desktop+ in case it starts behaving unexpected in some way. Settings are saved before restarting and overlays are typically restored without loss afterwards. However, active sessions in browser overlays will be lost. - **Desktop+**: These buttons apply to the main Desktop+ process, responsible for non-UI overlays and most interaction with them. - **[Restart]**: Restart Desktop+. - **[Enter Elevated Mode]**: Enters elevated mode by launching a secondary Desktop+ process with administrator privileges using the "DesktopPlus Elevated" scheduled task. This button is only visible if [elevated mode](#system-wide-modifications) has been set up. - **Desktop+ UI**: These buttons apply to the Desktop+ UI process, responsible for displaying UI elements and modifying settings. - **[Restart]**: Restart Desktop+ UI. - **[Restart in Desktop Mode]**: Restart Desktop+ UI in desktop mode. The settings window will display on the desktop and all VR interface elements will be unavailable. - **Restore Default Settings**: Press the button to open the [Restore Default Settings page](#restore-default-settings-page), which allows further choices before making any changes. ### Persistent UI Page ![Settings Window, Persistent UI Page](images/settings_page_persistent_ui.png) The *Persistent UI* page allows directly manipulating the state of Desktop+ interface windows. Settings, Overlay Properties and Desktop+ Keyboard windows can be configured here. #### Windows - **[x] Visible**: Sets if the window is visible. This is the same as manually showing the window in other parts of the application. - **[x] Pinned**: Sets if the window is pinned. Pinning a window sets the absolute position for the global state to the current Desktop+ tab position. The Desktop+ keyboard can also be pinned in the Desktop+ tab. - **Position**: Press [Reset] to restore the default position for the window. This position is relative to the dashboard for Desktop+ tab state and absolute for the global state. - **Size**: Changes the size of the window. Interface windows can also be resized by using stick or touchpad inputs while dragging them. - **[x] Restore State on Desktop+ Launch**: Sets if the window state will persist between launches of Desktop+. Note that pinned windows may end up getting lost if left in a far away corner of the VR space, especially when facing away from the user. However, a position reset can always be done in those cases. ### Manage Overlay Profiles Page ![Settings Window, Manage Overlay Profiles Page](images/settings_page_overlay_profiles.png) The *Manage Overlay Profiles* page allows loading, saving and deleting overlay profiles. The buttons below the list apply to the selected item. If you want to create a new profile, choose "[New Profile]". The default profile can be loaded to quickly reset the overlay configuration. - **[Load Profile]**: Load the selected profile. This will replace all existing overlays. - **[Add Overlay from Profile]**: Adds the overlays from the profile to the overlay list, without overriding any existing ones. - **[Save Current Overlays]**: Saves the selected profile. If you selected "[New Profile]", you it will create a new profile. Desktop+ will switch to the Save Current Overlays page before saving, letting you choose which overlays to save and enter a name in case of a new profile. - **[Delete Profile]**: Deletes the selected profile. The button will change label to prompt for confirmation. Press it another time to really delete the profile. ### Manage Application Profiles Page ![Settings Window, Manage Application Profiles Page](images/settings_page_application_profiles.png) The *Manage Application Profiles* page allows configuration of application profiles. - **(Application List)**: This is a list of all applications registered in SteamVR + applications a profile exists for. Most non-Steam VR applications do not register a permanent manifest with SteamVR and as such will only be listed here while they're running, unless an application profile was already created for them. While Desktop+ isn't running, only applications a profile exist for are listed. Inactive profiles are listed with a translucent text color. If an application profile is currently active, it is highlighted in the list with a green text color. #### [Application Name] The application profile configuration for the application selected in the list above. - **[x] Activate when Application is Running**: Toggles whether the application profile is applied or not. - **Overlay Profile**: Click the button to pick an overlay profile that is loaded when the application is launched. The existing overlay configuration is restored when the application is no longer running. Changes to the overlay configuration made while an overlay profile is loaded by an application profile are not saved automatically. - **Entry Action**: Click the button to pick an action that is executed when the application is launched. - **Exit Action**: Click the button to pick an action that is executed after the application has stopped running. - **Delete Profile**: Deletes the selected profile. The button will change label to prompt for confirmation. Press it another time to really delete the profile. As the application list contains all registered applications regardless of a profile existing, this will not visibly remove any entry from the list, unless the profile is for an unregistered application. ### Manage Actions Page ![Settings Window, Manage Actions Page](images/settings_page_manage_actions.png) The *Manage Actions* page allows creating, editing and deleting actions. - **(Action List)**: This is a list of all actions configured. The entries can be dragged up and down to change the order of them. The buttons below the list apply to the selected item. - **[Copy UID to Clipboard]** (Adv.): Copies the action's unique identifier to the clipboard. This ID can be used in conjunction with the [command-line argument](#command-line-arguments) "--DoAction [UID]" to execute actions from external applications. Action UIDs are 64-bit numbers derived from creation timestamp and a random component with a reasonably low chance of collisions. Default actions use special single digit UIDs. - **[New Action...]**: Switches to the [Edit Action page](#edit-action-page) to create a new action. - **[Edit Action]**: Switches to the [Edit Action page](#edit-action-page) to edit the selected action. - **[Duplicate Action]**: Creates a copy of the selected action. - **[Delete Action]**: Deletes the selected action. The button will change label to prompt for confirmation. Press it another time to really delete the action. Anything referencing the action like controller buttons, hotkeys or application profiles will show their action be set to "[None]" afterwards. ### Edit Action Page ![Settings Window, Edit Action Page](images/settings_page_edit_action.png) The *Edit Action* page allows creating and editing actions. - **Name**: Sets the name of the action. The default actions use special translation string ID names to automatically match the chosen application language. - **Target**: Sets the target of the action. Default targeting applies the commands to the overlay the action was activated on, or the focused overlay if the former isn't applicable. The focused overlay is the overlay that was clicked on with the laser pointer. Clicking on the Floating UI also changes the focused overlay. Tag targeting uses a list of overlay tags to target one or multiple overlays. This list is inclusive, meaning adding multiple tags for targeting checks each tag individually for matching targets (i.e. does not require multiple tags on a target). The green tags are implicit auto-tags that match based on overlay properties. #### Button Appearance - **(Preview Button)**: Button showing a preview of the action button with the current settings. It can also be pressed to test the action. - **Icon**: Click the button to pick an icon for the action. Icons are optional and rendered behind the label. Custom icons can be added by placing PNG files in the "images/icons" folder. Recommended size is 96x96 pixels. - **Label**: The label of the button with up to 3 lines of text. The lines are always centered and squeezed to fit if they're too long. The default actions use special translation string ID labels to automatically match the chosen application language. #### Commands List of the commands the action runs when executed. Commands are run sequentially but with no delay between them. Consider using the "Launch Application" command to run external scripts if you need more complex capabilities. Click the command headers to reveal their properties. - **[Delete Command]**: Deletes the command. The button will change label to prompt for confirmation. Press it another time to really delete the command. - **[Add Command]**: Adds another command to the command list. ##### None No-op command. Occupies an entry but does nothing. ##### Press Key Presses or toggles a key. - **Key Code**: Click the button to pick the virtual key code pressed by the command. Mouse buttons also have key codes that can be selected. - **[x] Toggle Key**: Toggles the state of the key instead of pressing and holding it until the action is stopped/released. Note that key toggling is based on the global key state of the OS and held keys will remain in that state if not released otherwise. However, Desktop+ will release all held-down keys on exit. ##### Set Mouse Position Moves the mouse cursor to the set position. - **X/Y**: Screen coordinates the mouse cursor is moved to. Coordinates are relative to the top left corner of the primary desktop. - **[Use Current Mouse Position]**: Sets the X and Y values to the current mouse cursor position. ##### Type String Types the set string. This is done via text input simulation and does not send key down and up events for individual keys. As such, not every application will read this kind of input. - **String**: The string typed by the command. ##### Launch Application Launches external applications. - **Executable Path**: Path of the application launched. As this goes through the Windows shell, file paths and URLs for registered protocols can also be used. - **Application Arguments**: Arguments passed to the executable. This can usually be left blank. ##### Show Keyboard Changes visibility of the [Desktop+ VR keyboard](#desktop-keyboard). - **Visibility**: Sets if the commands toggles, always shows, or always hides the keyboard. ##### Crop to Active Window Crops the targeted overlays to the currently focused desktop window. This command acts as a toggle, turning overlay cropping off if the crop is already equal to the active window. ##### Show Overlay Changes visibility of overlays. - **Visibility**: Sets if the commands toggles, always shows, or always hides the overlays. - **Target**: Sets if the command applies to the action's target overlays or overlays matching a specific set of tags. - **[x] Undo on Release**: Reverts the change made by the command when the action is stopped/released. Note that some ways of executing actions start and stop the action immediately. ##### Switch Task Shows the Windows task switcher or changes the focus to a specific window. Showing the task switcher usually works even when an elevated application has focus. - **Switching Method**: Set if the command shows the task switcher or focuses a specific window. - **Window** (Focus Window method only): Press the button to pick a window to focus. - **[x] Use Strict Window Matching**: Only allow exact window title matches when searching the window to focus. By default Desktop+ uses a weak window title matching algorithm to account for document-style changing window titles. Use this option if you experience false positives with specific applications. - **[x] Warp Cursor into Window** (Focus Window method only): Sets the mouse cursor position to the center of the window that is being focused. ##### Load Overlay Profile Loads an overlay profile. - **Profile**: Click on the drop-down list to select the profile the command will load. - **[x] Remove Existing Overlays**: Sets if all existing overlays are removed when loading the profile. This is equivalent to loading a profile instead of adding overlay from a profile in the [Manage Overlay Profiles page](#manage-overlay-profiles-page). ### Change Action Order Page ![Settings Window, Change Action Order Page](images/settings_page_change_action_order.png) The *Change Action Order* page allows adding, removing and re-ordering actions to action order lists. - **(Action List)**: List of actions in the action order list. The entries can be dragged up and down to change the order of them. - **[Add Actions...]**: Click on the button to pick one or more actions to add to the list. - **[Remove Action]**: Removes the selected action from the action order list. ### Keyboard Layout Page ![Settings Window, Keyboard Layout Page](images/settings_page_keyboard_layout.png) The *Keyboard Layout* page allows changing the layout of the Desktop+ VR keyboard. - **(Keyboard Layout List)**: List of available keyboard layouts for the Desktop+ VR keyboard. - **[Switch to Keyboard Layout Editor]** (only available in desktop mode): Open the keyboard layout editor on the desktop to customize or create custom layouts for the VR keyboard. #### Key Clusters - **[x] Function/Navigation/Numpad/Extra**: Toggles specific sections of the keyboard layout. Some keyboard layouts may not include all clusters. ### Restore Default Settings Page ![Settings Window, Restore Default Settings Page](images/settings_page_restore_defaults.png) The *Restore Default Settings* page allows choosing specific elements to reset to their default values. Tick the desired elements to reset and press [Reset Selected Elements]. Desktop+ will restart after making the changes. Note that active sessions in browser overlays will be lost when restarting. It is recommended to use these controls over deleting the configuration files manually. For the Steam version, Steam Cloud would automatically restore the missing files on launch if enabled, undoing the deletion. ## Overlay Properties ### Main Page ![Overlay Properties Window, Main Page, Position Section](images/overlay_properties_position.png) - **(Overlay Icon)**: The overlay icon can be double-clicked as an alternative way of toggling overlay visibility. #### Position - **Origin**: Click on the drop-down list to select the position origin of the overlay. This can be used to attach an overlay to controllers or the HMD. - **Play Area**: Attach overlay to the play area. This is absolute positioning relative to the standing play area. Overlays will not move unless the SteamVR room setup changes. - **HMD Floor Position**: Attach overlay to the position of the HMD, without rotation. Choosing this origin will reveal the option "[x] Turn with HMD", which will spin the origin along without it tilting in any way. - **Seated Position**: Attach overlay to the SteamVR seated position. This origin may have an unexpected position if the active VR game isn't using the seated space. Update the origin position by resetting the seated position in SteamVR. Games may also trigger updates to this position. - **Dashboard**: Attach overlay to the SteamVR dashboard. If visibility isn't restricted to dashboard, the origin position updates when the dashboard is brought up. - **HMD**: Attach overlay to the HMD. This origin is matches head movement 1:1 and essentially looks static in the headset view. - **Left Controller**: Attach overlay to the left motion controller. - **Right Controller**: Attach overlay to the right motion controller. - **Theater Screen**: Attach overlay to the SteamVR Theater Screen. Choosing to this origin will hide the overlay and reveal the button [Enter Theater Mode] to display the SteamVR Theater Screen. This button does the same as showing the overlay. There can only be one Theater Screen origin overlay active at once. If another overlay of that origin is set to be visible, it'll hide every other one automatically. Theater Screen origin overlays will also be hidden if the SteamVR Theater Screen is taken over by an overlay of another application or when using the "Close Overlay" button below the screen. - **Tracker #1** (only visible if a tracker is connected): Attach overlay to the first connected SteamVR tracker device. Using other trackers as the origin is not supported at this time. - **Origin Smoothing** (only visible for HMD Floor Position and HMD origins): Sets the level of smoothing/stabilization applied to the overlay origin. - **Display Mode**: Click on the drop-down list to select a display mode. Display modes restricts under which condition the overlay is visible. For example, "Only In-Game" only shows the overlay while a game/scene application is active and hides it while the dashboard is visible. - **Position**: - **[Change]**: Opens the Position Change page and activates overlay drag-mode. You can use the buttons to do manual position adjustments or simply drag the overlay in the VR space to reposition them. Using right-click to drag triggers a gesture drag, allowing you to rotate and scale overlays based on the motions of both hand-controllers. - **[Reset]**: Reset the position of the overlay. Depending on the origin the new position will be near the zero point of it or next to the dashboard overlay. - **[x] Lock**: Lock the position of the overlay. This option only prevents dragging the overlay. Position-locked overlays will still move along with their set origin. The lock state is temporarily toggled off for the respective overlay when using the Position Change page in the Overlay Properties window, but is restored when leaving the page again. #### Appearance ![Overlay Properties Window, Main Page, Appearance Section](images/overlay_properties_appearance.png) - **Width**: Width of the overlay. The height is automatically determined by the aspect ratio of the mirrored content. - **Curvature**: Sets how much the overlay curves inwards. - **Opacity**: Sets how translucent the overlay appears. 100% is fully visible. - **Brightness**: Sets how bright the overlay appears. 100% is full brightness. - **[x] Crop**: Sets if the cropping area is applied. - **[X, Y | Width x Height]** (Cropping Area button): Press this button to open the [Cropping Area page](#cropping-area-page) to change how the overlay is cropped. #### Capture ![Overlay Properties Window, Main Page, Capture Section](images/overlay_properties_capture.png) *This is only shown for desktop and window overlays and if advanced settings are enabled* - **Capture Method**: Changes the capture API used for this overlay. Graphics Capture additionally allows capturing windows directly. See [Desktop Duplication vs. Graphics Capture](#desktop-duplication-vs-graphics-capture) for a detailed comparison of both APIs. - **Source** (Desktop Duplication): Click on the drop-down list to select a desktop to crop the combined desktop mirror to. This selection is also used when resetting the cropping rectangle. - **Source** (Graphics Capture): Click on the button to select the capture source for the overlay. The list on the opening page contains available capturable desktops and windows. - **[x] Use Strict Window Matching**: Only allow exact window title matches when restoring the overlay's capture. By default Desktop+ uses a weak window title matching algorithm to account for document-style changing window titles. Use this option if you experience false positives with specific applications. #### Performance Monitor ![Overlay Properties Window, Main Page, Performance Monitor Section](images/overlay_properties_performance_monitor.png) *This is only shown for Performance Monitor overlays* The Performance Monitor lets you quickly check the current state of your system from within VR in real time. While it's possible to create as many overlays of it as desired, they will all be showing the same content. Performance Monitor properties are global. - **Style**: Switches between a large and compact style of the Performance Monitor. The compact style does not allow displaying the current time. - **[x] Show (Item)**: Allows to customize which performance characteristics and states are displayed on the Performance Monitor. - **[x] Disable GPU Performance Counters** (Adv.): Disables display of GPU load % and VRAM usage. This prevents GPU hardware monitoring related stutter with certain NVIDIA drivers. - **[Reset Cumulative Values]**: Resets statistics that build up over time, such as average FPS, dropped frames, and reprojection ratio. These values are also reset automatically when the game/scene application changes or SteamVR goes into standby mode. Note that Performance Monitor overlays do not update or may be invisible while the Desktop+ UI is open in desktop mode. #### Browser ![Overlay Properties Window, Main Page, Browser Section](images/overlay_properties_browser.png) *This is only shown for browser overlays* - **URL**: Address the browser overlay is displaying. This changes as browsing is done in the overlay. Local addresses can be used as well. - **[Go]**: Start navigation. Pressing enter on the text input field works as well. - **[Restore Last Input]**: Reset the text input field to the last manually entered URL. This is useful to go back to the initial location after navigating away from it. - **Width/Height**: Render resolution of the browser overlay. Changing this is akin to resizing a web browser window. - **Zoom**: Zoom level used in the browser overlay. - **[x] Allow Transparency**: Allows web pages to use transparency in the page background. This allows for RGBA web rendering if the page is set up for it. However, this results in the default background color being transparent. This means pages which don't define anything themselves and expect it to be opaque white will not look correct. Changing this property requires a reset of the browser context. Such a reset will clear the browsing history and reload the page. Click [Recreate Browser Context] to proceed after changing the property. #### Advanced ![Overlay Properties Window, Main Page, Advanced Section](images/overlay_properties_advanced.png) - **[x] 3D**: Sets if the 3D properties are applied. - **3D Mode**: Use the drop-down list to change the way the overlay's image is split up between both eyes to create a 3D image. - **[x] Swap Eyes**: Swaps which eye gets each split up part of the overlay image. - **[x] Gaze Fade** Sets if the Gaze Fade properties are applied. Gaze Fade gradually fades the overlay to 0% opacity when not looking at it. When the overlay is at 0% opacity, it is considered inactive and will not react to laser pointer input. - **[Auto-Configure]**: Configure distance and sensitivity values automatically from the current gaze and overlay settings. After clicking, a pop-up will appear asking to look at the overlay for 3 seconds. - **Distance** (Adv.): Distance of the gaze point from the HMD. Put the slider to the leftmost value to set it to "Infinite". - **Sensitivity** (Adv.): Rate at which the fading occurs. As Gaze Fade only takes the center point of the overlay in account, adjusting this value depending on the overlay size is recommended. - **Target Opacity** (Adv.): Minimum opacity Gaze Fade will set when not looking at the overlay. If this value is higher than the overlay's opacity property, Gaze Fade will be reversed and fade the overlay in when not looking at it. - **[x] Laser Pointer Input** Sets if laser pointer input is enabled for this overlay. The laser pointer will pass through the overlay if this is disabled. - **[x] Enabled In-Game**: If this is disabled, the laser pointer will pass through the overlay outside of the dashboard. - **[x] Show Floating UI**: Sets if the Floating UI is displayed when pointing at this overlay. - **Overlay Tags** The tags assigned to this overlay. Overlay tags are used by actions to target specific overlays. See [Overlay Tags](#overlay-tags) for more details. #### Performance ![Overlay Properties Window, Main Page, Performance Section](images/overlay_properties_performance.png) - **Override Update Limiter Mode** (only visible for desktop and window overlays): Sets the limiter mode for this overlay only. Overrides the global setting. Due to the shared textures between overlays, the limit resulting in the most updates among all active overlays of the same capture source is used. - **Maximum Frame Rate** (only visible for browser overlays): The maximum amount of frames per second this browser overlay will render at. Overrides the global setting. - **[x] Update when Invisible** (Adv.): Updates the overlay even when invisible from Opacity setting or Gaze Fade. This helps with third-party applications accessing the overlay's contents but is not recommended otherwise. Updates are still suspended if the overlay is disabled or hidden by Display Mode setting. Allowing overlays to update when not needed can have a significant performance impact. #### Interface ![Overlay Properties Window, Main Page, Interface Section](images/overlay_properties_interface.png) - **Overlay Name**: Set a custom name for the overlay. Leave this blank to let Desktop+ choose a name automatically. - **[x] Override Action Buttons**: Set if overlay-specific order and visibility of action buttons is used. - **[x Actions Selected]**: Press this button to open the [Change Action Order page](#change-action-order-page). Actions can be re-ordered by dragging the entries up and down. - **[x] Show Desktop Buttons**: Adds buttons for quickly switching desktops to the Action Bar of the Floating UI. - **[x] Show Extra Buttons**: Adds overlay-type-specific buttons to the Main Bar of the Floating UI. Examples for such buttons are "Add Active Window as Overlay" (desktop overlays only), "Reset Cumulative Values" (Performance Monitor only), and browser overlay controls. ### Change Overlay Position Page ![Overlay Properties Window, Change Overlay Position Page](images/overlay_properties_page_change_position.png) The *Change Overlay Position* page allows making adjustments to the overlay's position and change laser pointer drag behavior. #### Manual Adjustment Press the buttons to make manual adjustments to the overlay's position and orientation. The changes are applied relative to the overlay's current position. - **[D]** (only available in desktop mode): Click and hold the drag buttons to move or rotate the overlay with the mouse. Scroll wheel input applies forward/backward movement and roll adjustments. #### Additional Offset These offsets are applied on top of the overlay's position. - **Up/Down/Left/Right/Forward/Backward Offset** (Adv.): Additional offset in the specific direction in meters. The directions are relative to the overlay's orientation. #### Drag Settings Change these settings to adjust the laser pointer drag behavior. Drag settings are global and affect every overlay drag, except Desktop+ interface windows. - **[x] Dock to Controller when Near**: Sets if auto-docking is enabled. Auto-docking automatically changes the dragged overlay's origin to the left or right hand controller when the drag is released near them. - **[x] Force Fixed Distance**: Force a fixed distance between the overlays and the user. The reference position for this is always based on the headset position, but is only updated when the dashboard is brought up or drag-mode is toggled on while the dashboard is not active. Small changes in position are ignored to allow for a more fixed reference position between adjustments. Using stick or touchpad to change the distance of an overlay during a drag will adjust the Fixed Distance value while this drag setting is enabled. - **Shape**: Sets the shape the fixed distance is computed as. This can be set to sphere or a cylinder. - **[x] Auto-Curve**: Automatically change the dragged overlay's curvature property to match the chosen shape. - **[x] Auto-Tilt**: Automatically tilt the dragged overlay alongside the chosen shape. - **[x] Snap Position**: Snaps the position to a 3D grid of the given size. Note that the overlay origin itself may still be moving and make it difficult to line up multiple overlays together. - **[x] Snap Rotation**: Snaps the rotation to the gvien angle. Note that the overlay origin itself may still be spinning and make it difficult to line up multiple overlays together. - **[x] Yaw/Pitch/Roll** Toggles which axes the snapping is applied to. ### Cropping Area Page ![Overlay Properties Window, Cropping Area Page](images/overlay_properties_page_cropping_area.png) The *Cropping Area* page allows changing the overlay's cropping area. The cropping area is a rectangle the overlay content is cropped to. If the rectangle is larger than the overlay content, it's clamped to the maximum possible area. Cropping areas are preserved when switching between capture sources. This can lead to an invalid rectangle being set for the new capture source, making the overlay essentially invisible as a result. In that case, a "(!)" warning is displayed next to this crop setting on the main page and it's recommended to simply use the *[Reset]* button to fix it. - **(Draggable Cropping Rectangle**): Represents the overlay's cropping area in relation to its total content size. Drag the rectangle to move it within the content bounds. Use scroll input or the edges to adjust the size of the cropping area. - **[Reset]**: Reset the cropping area to default values. If a desktop to crop to is set, it will restore the values for that. Otherwise, it resets to maximum possible area. #### Manual Adjustment - **X/Y/Width/Height**: Position and size of the cropping area. Width and height can be set to "Max" by dragging the slider into the right-most position. The cropping area will always assume the maximum possible size in that case. - **[Crop to Active Window]** (Desktop Duplication): Change the cropping area to match the foreground window. ## Desktop Mode ![Desktop Mode Window](images/desktop_mode.png) Desktop mode displays the same interface for settings and overlay properties as in VR, but condensed into a single window on the desktop with its own main page to allow quick access and overlay management. To access desktop mode, either run DesktopPlusUI.exe while SteamVR is not running, press [Restart in Desktop Mode] in the Troubleshooting section of the Settings window, or run DesktopPlusUI.exe with the "--DesktopMode" [command-line argument](#command-line-arguments). Note that some settings are not available when running in desktop mode while SteamVR is not running, and the main application process will not be running either. The UI refers to this as "Desktop+ isn't running", even if the UI process might be seen as part of the application. - **[🡸]**: Navigate back to the previous page. On pages that can have changes reverted by [Cancel], this button is equivalent to pressing it. ### Tools Quickly access the settings and several key setting pages. The items listed are the same pages as accessible through the main settings page. ### Overlays List of overlays, similar to the Overlay Bar. Overlays can be re-ordered by dragging the entries up and down. Right-click the entries to access the context menu, which allows to show/hide, clone or remove the overlay. - **[Add Overlay]**: Add a new overlay. Performance Monitor overlays cannot be create while in desktop mode as their appearance relies on Desktop+ UI rendering in VR. ### Keyboard Controls Desktop mode can be fully operated by keyboard alone and also has some mouse shortcuts. These are the controls: | **Mouse** | | | :-------------------------- | :---------------------------------------------------- | | Left Mouse Button | Interact with Widgets | | Right Mouse Button | Context Menu on Overlay List/Edit Slider Value | | Mouse Back Button/Backspace | Return to Previous Page | | Mouse Wheel | Scroll/Move or Rotate during Overlay Drag | | **Keyboard** | *(activate keyboard controls for these to work)* | | :-------------------------- | :---------------------------------------------------- | | Arrow Keys | Navigate/Activate Keyboard Controls | | Spacebar | Interact with Widgets | | Esc | Cancel Widget Selection | | Enter | Confirm Text Input | | Menu Key | Context Menu on Overlay List | | Ctrl | Hold on List Entries while Navigating to Change Order | ## Desktop+ Keyboard ![Desktop+ VR Keyboard](images/vr_keyboard.png) Desktop+ features its own implementation of a customizable VR keyboard. Its behavior, layout, and visible clusters can be changed in the [Keyboard Layout Settings Page](#keyboard). The keyboard window can be operated with multiple laser pointers simultaneously. Due to API limitations, there are no haptics on the non-primary laser pointers while the dashboard is visible, however. Its input behavior is mostly straight forward and mimics a normal PC keyboard. Keys held on the VR keyboard are simulated to be held down until they are released on it, with key repeat for most keys if configured. Modifier keys can be sticky, meaning they will remain simulated as held down until they're pressed again. Every key on the VR keyboard can be made sticky by right-clicking them. Keys remain pressed when hiding the keyboard, but all still held down keys are released on Desktop+ shutdown. While shown, the keyboard follows the overlay it was shown for, if any. Or the SteamVR dashboard, while it is visible. Changes to the keyboard position are relative to this, unless the keyboard window is pinned. Note that input done on the keyboard always gets sent to the focused overlay (the overlay that was last clicked on with the laser pointer). For desktop/window overlays this does not make any difference, however. ### Keyboard Layout Editor ![Keyboard Layout Editor](images/keyboard_layout_editor.png) The Keyboard Layout Editor allows to customize or create custom keyboard layouts for the Desktop+ VR Keyboard. It is only available in desktop mode. #### Key List List of all keys in the layout. Use the tabs to switch between sub-layouts. ##### Sub-Layouts - **Base**: Normal layout displayed by default. - **Shift**: Shifted layout displayed when any of the shift keys are held, or caps lock is active. Usually features capital letters and special characters. - **AltGr** (only available if "[x] Has AltGR" is ticked): AltGr layout displayed when AltGr is being held. Not present on US-style layouts. Usually features third-level letters and special characters. - **Aux**: Auxiliary layout. Only displayed if explicitly switched to via a "Toggle Sub-Layout" key. This can be anything or just remain unused. ##### Sub-Layout Key List List of all keys in the sub-layout. Click an entry to select the key or row and displays its properties in the Key Properties window. Entries can be dragged up or down to re-arrange their order. ##### Bottom Row - **[Undo]**: Undo the last change. The changes history includes modifications made in any part of the Keyboard Layout Editor. Ctrl+Z can also be pressed to trigger this button. - **[Redo]**: Redo the reverted last change. Ctrl+Y can also be pressed to trigger this button. - **[Add]**: Add a new key. The key is created next to the current selection. To add a new row, select an existing row before adding a key. Adding too many keys in a row will cause them to be cut off. While there is no limit of rows enforced, a scroll bar will appear in the editor preview and VR if the window space is exhausted. - **[Duplicate]**: Creates a copy of the currently selected key or row. This copy is created next to the original. - **[Remove]**: Removes the selected key or row. There is no confirmation step for this action, but it can always be undone. #### Key Properties - **Type**: Sets the type of the key. Some key types have their own specific properties, listed below. - **Size**: Sets the width and height of the key. 100% is the size of a standard key and compatible with common key size definitions. - **Label** (not available for "Blank Space"-type keys): The label displayed on the key. The text is horizontally centered per-line, and vertically centered on the key as a whole. 100% height keys typically fit two lines of text (three fit barely, but not recommended). Per-line centering can be changed to left or right alignment by appending "##L" or "##R" to the end of a line. - **Cluster**: Assign clusters to keys to allow selectively disabling them in the settings later. As "Blank Space"-type keys are also part of clusters, the assignments has to be chosen carefully to not break the layout when toggling them. ##### Virtual Key / Virtual Key (Toggle) / Virtual Key (ISO-Enter) Simulates a key press or toggle of a virtual key code. The ISO-enter variant allows combining two keys in adjacent rows to build an ISO-enter shaped key. - **Key Code**: Click the button to pick the virtual key code pressed by the key. Mouse buttons also have key codes that can be selected. - **[x] Block Modifiers** (not available for "Virtual Key (Toggle)"): Releases all modifiers when this key is pressed. This is useful when the key's sub-layout differs from the required modifier state of the simulated input. - **[x] Never Repeat**: Disable key repeat for this key, regardless of the global key repeat setting. This is useful for keys that don't repeat when held on a real keyboard. ##### String If the string is a single character, Desktop+ will try to figure out which keys to press on the real keyboard layout to simulate the input. If the string is multiple characters, input is done via text input simulation and not sending key down/up events for individual keys. Not every application will read this kind of input. It is recommended to use this key type for non-basic character keys to increase application compatibility. - **String**: The string input simulated when pressing the key. ##### Toggle Sub-Layout Explicitly switch to a different sub-layout. This is always a toggle. Place an identical key in the target sub-layout to allow switching back. Shift and AltGr sub-layouts are switched to automatically depending on the related modifier's state, making this only necessary to reach the Aux sub-layout. - **Sub-Layout**: Sets the sub-layout to toggle. ##### Action Execute an action when pressing the key. This works the same as action buttons in the [Floating UI Action Bar](#action-bar). - **Action**: Click the button to pick the action that is executed when the key is pressed. #### Layout Metadata - **Name**: Name of the keyboard layout. This is what it is listed as in the [Keyboard Layout Settings Page](#keyboard). - **Author**: Name of the keyboard layout's author. This is displayed in the [Keyboard Layout Settings Page](#keyboard). Official layouts leave this field blank. - **[x] Has AltGr**: Sets if the AltGr sub-layout should be present. This is typically left unticked for US-style layouts. - **Preview Clusters**: Untick clusters to check how the layout will look with different [key clusters settings](#key-clusters) set. The state of this does not affect the saved layout. - **[Save...]**: Click this button to save the layout. A pop-up will open allowing you to choose the file name or to overwrite an existing layout. Keyboard layouts are stored in the "keyboards" directory found in the application's install directory. - **[Load...]**: Click this button to load a different layout. A pop-up will open allowing you to choose the next layout. Note that there is no additional confirmation step and unsaved changes will be lost when loading a different layout. #### Keyboard Preview A preview of how the keyboard will look in VR. Left-click individual keys to select them in the key list or right-click a key to select the row it belongs to. # Performance Considerations Desktop+ was written to be lean in both computational load and memory footprint. However, functionality does not come without a price, so knowing the performance characteristics of the application can be helpful. In general, configured, but inactive overlays are without noticeable performance penalty. Mirroring of the desktops or windows is paused completely while no overlays using the source are active. An overlay is considered inactive when it's not enabled or visible. This means display modes hiding an overlay and Gaze Fade setting its opacity to 0% are ways to set an overlay inactive. Overlays merely outside the view are *not* considered inactive, but may still have a lower GPU load from being culled from rendering by the VR Compositor. If possible, avoid using Over-Under 3D, as it involves an extra conversion step and textures for each individual overlay. Textures are not shared for such overlays. Prefer Side-by-Side 3D instead. On certain multi-GPU setups, such as laptops with a hybrid GPU solution, textures have to be copied between GPUs since the desktops are typically rendered on the integrated GPU while the HMD is connected to the dedicated GPU. This comes with a significant performance penalty. If possible, consider deactivating the integrated GPU altogether. ## Desktop Duplication All Desktop Duplication overlays share a single texture, meaning additional overlays are fairly cheap. Mirroring is stopped when no Desktop Duplication overlays are active. Cursor movement is decoupled from the screen's refresh-rate and can cause GPU load spikes, especially when a mouse with a high polling rate is used. If this is undesirable, use the Update Limiter with a low frame time limit to mitigate this. ## Graphics Capture All Graphics Capture overlays using the same source are sharing a single texture, meaning additional overlays of the same source are fairly cheap. Graphics Capture is generally a more efficient capture method than Desktop Duplication. However, keep in mind that many individual window overlays can easily end up performing worse than carefully cropped desktop overlays. ## Desktop Duplication vs. Graphics Capture Desktop+ features two capture methods for overlays. Both have different strengths and weaknesses. Using Graphics Capture for desktop mirroring is usually only recommended on the latest Windows version. ### Desktop Duplication - Supported on systems with Windows 8.1 and newer - Mirrors desktops - Decoupled cursor movement - Only updates on screen changes - Supports mirroring applications in exclusive fullscreen mode - Supports mirroring exclusive fullscreen applications at unconstrained frame-rates #### Mirroring at Unconstrained Frame-Rates Desktop Duplication supports mirroring exclusive fullscreen applications at unconstrained frame-rates. Actual support depends on how the application does its rendering, but it works for most. For this to work, the following conditions have to be met: - Application has to run in exclusive fullscreen mode - VSync has to be disabled - Fullscreen optimizations have to be disabled* * May not be required for certain games using OpenGL or Vulkan to render. Fullscreen optimizations can be disabled on a per-application basis in the Compatibility tab of the executable's properties window on Windows 10 version 1803 or newer. ### Graphics Capture - Supported on systems with Windows 10 version 1903 and newer* - Mirrors desktops or windows - Cursor movement at source monitor refresh rate - Always updates at monitor refresh rate (does not apply to Windows 11 24H2 and newer) - Supports direct mirroring of occluded windows - Additional Desktop+ features for window overlays - Draws yellow rectangle over mirrored sources (not visible in the capture, does not apply to Windows 11 and newer) - More efficient than Desktop Duplication (but the fixed refresh rate may nullify this with high refresh rate displays) * Windows 10 version 1903 is required for limited support, version 2004 for full support. #### Graphics Capture Feature Support Windows 10 version 1903 is the minimum supported version for Graphics Capture/window overlays. Version 2004 additionally enables selecting the combined desktop, as well as supporting disabling the cursor. With Windows 11 the yellow border around captures, which is only visible on real display, is removed. 24H2 additionally enables capturing secondary windows (e.g. pop-up menus), native update limiting, and only updates on content changes. # VR Interactions The following interactions done with VR motion controllers trigger specific behavior in Desktop+: - Holding down left-click on a window's title bar in a desktop overlay and scrolling down: Create window overlay of this window and start dragging it. - Dragging a window in a window overlay: Trigger configured [window overlay drag behavior](#window-overlays) - Dragging an overlay near a motion controller: Trigger [overlay auto-docking](#drag-settings) if enabled # Usage Examples Provided are a few typical usage scenarios and how to configure Desktop+ for them. If unsure, load the "Default" overlay profile as a clean starting point before trying them out. ## Attach Overlay to a Motion-Controller, Wristwatch-Style 1. Click *[+]* in the [Overlay Bar](#overlay-bar) to bring up the overlay capture source pop-up menu. 1. Use the opposite controller to press and hold left click/trigger on the desired capture source from the list. 1. While still holding down, move and rotate the controller to move the newly added overlay towards the target controller until a pop-up saying "Release to dock" appears. ([Overlay auto-docking](#drag-settings) may be disabled if this doesn't work) 1. Release left click/trigger to dock the controller. 1. Optionally enable and adjust *Gaze Fade* in the *Overlay Properties* settings page's [Advanced](#advanced) section. See [Performance Considerations](#performance-considerations) for details on why this is recommended. The size of the new overlay can be adjusted while dragging by moving the stick or sliding the touchpad left and right. ## Show Multiple Desktops or Windows in the Dashboard at Once 1. Click *[+]* in the [Overlay Bar](#overlay-bar) to bring up the overlay capture source pop-up menu. 1. Use the opposite controller to press and hold left click/trigger on the desired capture source from the list. 1. While still holding down, move and rotate the controller to move the newly added overlay to the desired spot. 1. Release left click/trigger. 1. Click on the icon of the newly added overlay in the [Overlay Bar](#overlay-bar) to bring up its pop-up menu. 1. Click on "Properties..." to bring up the [Overlay Properties window](#overlay-properties) for the overlay. 1. At the top of the window, click on the drop-down list next to *Origin* and choose "Dashboard". 1. Optionally click on the drop-down list next to *Display Mode* and choose "Only in Desktop+ Tab" to limit visibility similar to the default Desktop+ dashboard overlay. 1. Repeat these steps for any other overlays you wish to add. You may also choose to duplicate existing overlays from the overlay icon pop-up menu as a starting point instead. ## Simulate Keyboard Shortcut from Motion-Controller Input 1. Click on *[New Action...]* below the *action list* on the [Manage Actions Page](#manage-actions-page). 1. Optionally give the action a fitting name and label. 1. Click on *Add Command*. 1. Click on the drop-down list next to *Command Type* and choose the "Press Key". 1. Click on *[None]* next to *Key Code* and choose the desired keyboard key or mouse button to be simulated. 1. Repeat step 3 to 5 to add more keys. All of them will be simulated as pressed simultaneously. 1. Click on *[Ok]* at the bottom of the to save the new Action. 1. Return to the settings window's main page. 1. Click on *[None]* next to *Global Shortcut #1* in the *Global Controller Buttons* list found in the *Actions* section. 1. Select the newly created action from the bottom of the list. 1. Open the SteamVR controller bindings for Desktop+ by pressing *[Show Controller Bindings]* 1. Configure the input bindings as desired. Desktop+ shortcut bindings are all boolean actions, meaning you'll find them when configuring digital input types such as *"Button"* or *"Toggle Button"*. 1. To bind the action created in this example, select a controller input, use it as *"Button"* and select *"Do Global Shortcut #1"*. 1. Click the check mark to save the changes. 1. The keyboard shortcut should now be pressed whenever the configured input binding is triggered. The dashboard has to be closed, however. If you wish to configure a keyboard shortcut to simulated when pressing a button while pointing at a Desktop+ overlay, simply select the action for one of the *Active Controller Buttons*. If you need further help on how to use the SteamVR binding interface, [OpenVR Advanced Settings' SteamVR Input Guide](https://github.com/OpenVR-Advanced-Settings/OpenVR-AdvancedSettings/blob/master/docs/SteamVRInputGuide.md) is a good place to start. The SteamVR controller bindings can also be accessed by either going into the SteamVR settings' *Controller* page and clicking *Show old Binding UI*, or loading http://localhost:27062/dashboard/controllerbinding.html with a web browser while SteamVR is running. SteamVR will *not* list Desktop+ in the pop-up that appears by pressing the *Manage Controller Bindings* button, so make sure to not accidentally click that button instead. SteamVR may not list Desktop+ right after its first launch. Try restarting SteamVR in that case. # Advanced Features ## Hidden Configuration Settings There are a handful of advanced configuration settings which aren't exposed in the settings interface. These config keys can be found in *config_default.ini* alongside comments about their functionality. ## System-wide Modifications The "misc" directory found in the application's install directory contains a collection of scripts that make system-wide changes to enable additional access privileges for Desktop+. Please make sure to read "!About this folder.txt" in the same directory before running any of them to understand the consequences of doing so. ## Command-Line Arguments The following arguments can be passed to Desktop+ to change its behavior. Most of these are accessible in other ways via the UI and don't need to be used manually. | Executable | Argument | Description | | :---------------- | :--------------- | :---------- | | DesktopPlus.exe | --ElevatedMode | Launch in elevated mode. This is what the elevated task uses.
Elevated mode runs as a secondary process taking input from an existing DesktopPlus.exe process and will not work if one isn't already running. | | DesktopPlus.exe | --DoAction [UID] | Execute the action with the specified UID. An action UID can be obtained by pressing [Copy UID to Clipboard] in the [Manage Actions page](#manage-actions-page).
This runs as a secondary process that passes the command on and then exits and will not work if the DesktopPlus.exe process isn't already running. | | DesktopPlusUI.exe | --DesktopMode | Force launching in desktop mode. | | DesktopPlusUI.exe | --KeyboardEditor | Launch as Keyboard Editor. This argument also forces desktop mode. | | Both | -v [verbosity] | Set the verbosity level used for logging. Available levels are 0 (default), 1 (enables additional verbose logging), INFO, WARNING, ERROR and OFF. | ### Desktop+ Browser Command-line arguments for Chromium Embedded Framework can be set in config.ini via the *CommandLineArguments* key in the *[Browser]* section. ================================================ FILE: src/DesktopPlus/BackgroundOverlay.cpp ================================================ #include "BackgroundOverlay.h" #include "ConfigManager.h" #include "OutputManager.h" BackgroundOverlay::BackgroundOverlay() : m_OvrlHandle(vr::k_ulOverlayHandleInvalid) { //Not calling Update() here since the OutputManager typically needs to load the config and OpenVR first } BackgroundOverlay::~BackgroundOverlay() { if ((m_OvrlHandle != vr::k_ulOverlayHandleInvalid) && (vr::VROverlay() != nullptr)) { vr::VROverlay()->DestroyOverlay(m_OvrlHandle); } } void BackgroundOverlay::Update() { InterfaceBGColorDisplayMode display_mode = (InterfaceBGColorDisplayMode)ConfigManager::GetValue(configid_int_interface_background_color_display_mode); if (display_mode == ui_bgcolor_dispmode_never) { //Don't keep the overlay around if it's absolutely not needed (which is the case most of the time) if (m_OvrlHandle != vr::k_ulOverlayHandleInvalid) { vr::VROverlay()->DestroyOverlay(m_OvrlHandle); m_OvrlHandle = vr::k_ulOverlayHandleInvalid; } } else { //Create overlay if it doesn't exist yet if (m_OvrlHandle == vr::k_ulOverlayHandleInvalid) { vr::EVROverlayError ovrl_error = vr::VROverlay()->CreateOverlay("elvissteinjr.DesktopPlusBackground", "Desktop+ Background", &m_OvrlHandle); if (ovrl_error != vr::VROverlayError_None) return; //Fill overlay with some pixels unsigned char bytes[2 * 2 * 4]; std::fill(std::begin(bytes), std::end(bytes), 255); //Full white RGBA vr::VROverlay()->SetOverlayRaw(m_OvrlHandle, bytes, 2, 2, 4); //The trick to this overlay is to set it as a panorama attached to the HMD //Panorama overlays are weird in that they essentially poke a hole into the rendering in the area they'd cover normally //By doing this we ensure to always cover the field of view. The actual panorama is rendered in front of scene content, but positioned behind all overlays //IVRCompositor::FadeToColor() can achieve a similar effect, but the colors are washed out. Impossible to achieve full black with it. vr::VROverlay()->SetOverlayFlag(m_OvrlHandle, vr::VROverlayFlags_Panorama, true); vr::VROverlay()->SetOverlayWidthInMeters(m_OvrlHandle, 100.0f); Matrix4 transform; transform.setTranslation({0.0f, 0.0f, -10.0f}); vr::HmdMatrix34_t transform_openvr = transform.toOpenVR34(); vr::VROverlay()->SetOverlayTransformTrackedDeviceRelative(m_OvrlHandle, vr::k_unTrackedDeviceIndex_Hmd, &transform_openvr); } bool display_overlay = true; //ui_bgcolor_dispmode_always if (display_mode == ui_bgcolor_dispmode_dplustab) { display_overlay = ((OutputManager::Get()) && (OutputManager::Get()->IsDashboardTabActive())); } if (display_overlay) { //Unpack color value unsigned int rgba = pun_cast(ConfigManager::GetValue(configid_int_interface_background_color)); float r = (rgba & 0x000000FF) / 255.0f; float g = ((rgba & 0x0000FF00) >> 8) / 255.0f; float b = ((rgba & 0x00FF0000) >> 16) / 255.0f; float a = ((rgba & 0xFF000000) >> 24) / 255.0f; vr::VROverlay()->SetOverlayColor(m_OvrlHandle, r, g, b); vr::VROverlay()->SetOverlayAlpha(m_OvrlHandle, a); if (!vr::VROverlay()->IsOverlayVisible(m_OvrlHandle)) { vr::VROverlay()->ShowOverlay(m_OvrlHandle); } } else if (vr::VROverlay()->IsOverlayVisible(m_OvrlHandle)) { vr::VROverlay()->HideOverlay(m_OvrlHandle); } } } ================================================ FILE: src/DesktopPlus/BackgroundOverlay.h ================================================ #pragma once #include "openvr.h" class BackgroundOverlay { private: vr::VROverlayHandle_t m_OvrlHandle; public: BackgroundOverlay(); ~BackgroundOverlay(); void Update(); }; ================================================ FILE: src/DesktopPlus/CommonTypes.h ================================================ #ifndef _COMMONTYPES_H_ #define _COMMONTYPES_H_ //If NTDDI_WIN11_GA is available, use it (optional requirement by OutputManager) //This *could* blow up if one of the few files that include windows.h itself comes first somehow but it's fine for now #include #ifdef NTDDI_WIN11_GA #undef NTDDI_VERSION #define NTDDI_VERSION NTDDI_WIN11_GA #else #pragma message("Using older Windows SDK! Not all Desktop+ features will be available in this build.") #endif #define NOMINMAX #include #include #include #include #include #include #include #include #include #include "DPRect.h" #include "PixelShader.h" #include "PixelShaderCursor.h" #include "VertexShader.h" #define NUMVERTICES 6 #define BPP 4 #define OCCLUSION_STATUS_MSG WM_USER extern HRESULT SystemTransitionsExpectedErrors[]; extern HRESULT CreateDuplicationExpectedErrors[]; extern HRESULT FrameInfoExpectedErrors[]; extern HRESULT AcquireFrameExpectedError[]; extern HRESULT EnumOutputsExpectedErrors[]; typedef _Return_type_success_(return == DUPL_RETURN_SUCCESS) enum { DUPL_RETURN_SUCCESS = 0, DUPL_RETURN_ERROR_EXPECTED = 1, DUPL_RETURN_ERROR_UNEXPECTED = 2 }DUPL_RETURN; // // Used by OutputManager::Update(), maps to DUPL_RETURN values where applicable // typedef _Return_type_success_(return == DUPL_RETURN_UPD_SUCCESS) enum { DUPL_RETURN_UPD_SUCCESS = 0, DUPL_RETURN_UPD_ERROR_EXPECTED = 1, DUPL_RETURN_UPD_ERROR_UNEXPECTED = 2, DUPL_RETURN_UPD_QUIT = 3, DUPL_RETURN_UPD_RETRY = 4, DUPL_RETURN_UPD_SUCCESS_REFRESHED_OVERLAY = 5 }DUPL_RETURN_UPD; _Post_satisfies_(return != DUPL_RETURN_SUCCESS) DUPL_RETURN ProcessFailure(_In_opt_ ID3D11Device* device, _In_ LPCWSTR str, _In_ LPCWSTR title, HRESULT hr, _In_opt_z_ HRESULT* expected_errors = nullptr); void DisplayMsg(_In_ LPCWSTR str, _In_ LPCWSTR title, HRESULT hr); // // Holds info about the pointer/cursor // typedef struct _PTR_INFO { std::vector ShapeBuffer; DXGI_OUTDUPL_POINTER_SHAPE_INFO ShapeInfo = {0}; POINT Position = {0, 0}; bool Visible = false; UINT WhoUpdatedPositionLast = 0; LARGE_INTEGER LastTimeStamp = {0}; bool CursorShapeChanged = false; } PTR_INFO; // // Structure that holds D3D resources not directly tied to any one thread // typedef struct _DX_RESOURCES { ID3D11Device* Device; ID3D11DeviceContext* Context; ID3D11VertexShader* VertexShader; ID3D11PixelShader* PixelShader; ID3D11InputLayout* InputLayout; ID3D11SamplerState* Sampler; } DX_RESOURCES; // // Structure to pass to a new thread // typedef struct _THREAD_DATA { // Used to indicate abnormal error condition HANDLE UnexpectedErrorEvent; // Used to indicate a transition event occurred e.g. PnpStop, PnpStart, mode change, TDR, desktop switch and the application needs to recreate the duplication interface HANDLE ExpectedErrorEvent; HANDLE NewFrameProcessedEvent; HANDLE PauseDuplicationEvent; HANDLE ResumeDuplicationEvent; // Used by WinProc to signal to threads to exit HANDLE TerminateThreadsEvent; HANDLE TexSharedHandle; UINT Output; INT OffsetX; INT OffsetY; PTR_INFO* PtrInfo; DX_RESOURCES DxRes; DPRect* DirtyRegionTotal; bool WMRIgnoreVScreens; } THREAD_DATA; // // FRAME_DATA holds information about an acquired frame // typedef struct _FRAME_DATA { ID3D11Texture2D* Frame; DXGI_OUTDUPL_FRAME_INFO FrameInfo; _Field_size_bytes_((MoveCount * sizeof(DXGI_OUTDUPL_MOVE_RECT)) + (DirtyCount * sizeof(RECT))) BYTE* MetaData; UINT DirtyCount; UINT MoveCount; } FRAME_DATA; // // A vertex with a position and texture coordinate // typedef struct _VERTEX { DirectX::XMFLOAT3 Pos; DirectX::XMFLOAT2 TexCoord; } VERTEX; #endif ================================================ FILE: src/DesktopPlus/DesktopPlus.cpp ================================================ //This code belongs to the Desktop+ OpenVR overlay application, licensed under GPL 3.0 // //Desktop+ is heavily based on the DXGI Desktop Duplication sample code by Microsoft: https://github.com/microsoft/Windows-classic-samples/tree/master/Samples/DXGIDesktopDuplication //Much of the code is simply modified or expanded upon it, so structure and many comments are leftovers from that #include #include #include #include #include #include "DesktopPlusWinRT.h" #include "DPBrowserAPIClient.h" #include "Util.h" #include "DisplayManager.h" #include "DuplicationManager.h" #include "OutputManager.h" #include "WindowManager.h" #include "ThreadManager.h" #include "InterprocessMessaging.h" #include "ElevatedMode.h" #include "Logging.h" // Below are lists of errors expect from Dxgi API calls when a transition event like mode change, PnpStop, PnpStart // desktop switch, TDR or session disconnect/reconnect. In all these cases we want the application to clean up the threads that process // the desktop updates and attempt to recreate them. // If we get an error that is not on the appropriate list then we exit the application // These are the errors we expect from general Dxgi API due to a transition HRESULT SystemTransitionsExpectedErrors[] = { DXGI_ERROR_DEVICE_REMOVED, DXGI_ERROR_ACCESS_LOST, static_cast(WAIT_ABANDONED), S_OK // Terminate list with zero valued HRESULT }; // These are the errors we expect from IDXGIOutput1::DuplicateOutput due to a transition HRESULT CreateDuplicationExpectedErrors[] = { DXGI_ERROR_DEVICE_REMOVED, static_cast(E_ACCESSDENIED), DXGI_ERROR_UNSUPPORTED, DXGI_ERROR_SESSION_DISCONNECTED, S_OK // Terminate list with zero valued HRESULT }; // These are the errors we expect from IDXGIOutputDuplication methods due to a transition HRESULT FrameInfoExpectedErrors[] = { DXGI_ERROR_DEVICE_REMOVED, DXGI_ERROR_ACCESS_LOST, S_OK // Terminate list with zero valued HRESULT }; // These are the errors we expect from IDXGIAdapter::EnumOutputs methods due to outputs becoming stale during a transition HRESULT EnumOutputsExpectedErrors[] = { DXGI_ERROR_NOT_FOUND, S_OK // Terminate list with zero valued HRESULT }; // // Forward Declarations // DWORD WINAPI CaptureThreadEntry(_In_ void* Param); LRESULT CALLBACK WndProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam); bool SpawnProcessWithDefaultEnv(LPCWSTR application_name, LPWSTR commandline = nullptr); void ProcessCmdline(bool& use_elevated_mode, bool& cancel_startup); bool DisplayInitError(vr::EVRInitError vr_init_error, vr::EVROverlayError vr_overlay_error, bool vr_input_success); // // Class for progressive waits // typedef struct { UINT WaitTime; UINT WaitCount; }WAIT_BAND; #define WAIT_BAND_COUNT 5 #define WAIT_BAND_STOP 0 class DYNAMIC_WAIT { public : DYNAMIC_WAIT(); ~DYNAMIC_WAIT(); void Wait(); private : static const WAIT_BAND m_WaitBands[WAIT_BAND_COUNT]; // Period in seconds that a new wait call is considered part of the same wait sequence static const UINT m_WaitSequenceTimeInSeconds = 2; UINT m_CurrentWaitBandIdx; UINT m_WaitCountInCurrentBand; LARGE_INTEGER m_QPCFrequency; LARGE_INTEGER m_LastWakeUpTime; BOOL m_QPCValid; }; const WAIT_BAND DYNAMIC_WAIT::m_WaitBands[WAIT_BAND_COUNT] = { {10, 40}, {50, 20}, {250, 20}, {2000, 60}, {5000, WAIT_BAND_STOP} // Never move past this band }; DYNAMIC_WAIT::DYNAMIC_WAIT() : m_CurrentWaitBandIdx(0), m_WaitCountInCurrentBand(0) { m_QPCValid = QueryPerformanceFrequency(&m_QPCFrequency); m_LastWakeUpTime.QuadPart = 0L; } DYNAMIC_WAIT::~DYNAMIC_WAIT() { } void DYNAMIC_WAIT::Wait() { LARGE_INTEGER CurrentQPC = {0}; // Is this wait being called with the period that we consider it to be part of the same wait sequence QueryPerformanceCounter(&CurrentQPC); if (m_QPCValid && (CurrentQPC.QuadPart <= (m_LastWakeUpTime.QuadPart + (m_QPCFrequency.QuadPart * m_WaitSequenceTimeInSeconds)))) { // We are still in the same wait sequence, lets check if we should move to the next band if ((m_WaitBands[m_CurrentWaitBandIdx].WaitCount != WAIT_BAND_STOP) && (m_WaitCountInCurrentBand > m_WaitBands[m_CurrentWaitBandIdx].WaitCount)) { m_CurrentWaitBandIdx++; m_WaitCountInCurrentBand = 0; } } else { // Either we could not get the current time or we are starting a new wait sequence m_WaitCountInCurrentBand = 0; m_CurrentWaitBandIdx = 0; } // Sleep for the required period of time Sleep(m_WaitBands[m_CurrentWaitBandIdx].WaitTime); // Record the time we woke up so we can detect wait sequences QueryPerformanceCounter(&m_LastWakeUpTime); m_WaitCountInCurrentBand++; } // // Program entry point // int WINAPI WinMain(_In_ HINSTANCE hInstance, _In_opt_ HINSTANCE hPrevInstance, _In_ LPSTR lpCmdLine, _In_ INT nCmdShow) { UNREFERENCED_PARAMETER(hPrevInstance); UNREFERENCED_PARAMETER(lpCmdLine); bool use_elevated_mode = false; bool cancel_startup = false; ProcessCmdline(use_elevated_mode, cancel_startup); if (use_elevated_mode) { //Pass all control to eleveated mode and exit when we're done there return ElevatedModeEnter(hInstance); } else if (cancel_startup) { //Command line contained a one-off command sent to existing instances, exit return 0; } DPLog_Init("DesktopPlus"); INT SingleOutput = 0; // Synchronization HANDLE UnexpectedErrorEvent = nullptr; HANDLE ExpectedErrorEvent = nullptr; HANDLE NewFrameProcessedEvent = nullptr; HANDLE PauseDuplicationEvent = nullptr; HANDLE ResumeDuplicationEvent = nullptr; HANDLE TerminateThreadsEvent = nullptr; // Window HWND WindowHandle = nullptr; //Make sure only one instance is running StopProcessByWindowClass(g_WindowClassNameDashboardApp); // Event used by the threads to signal an unexpected error and we want to quit the app UnexpectedErrorEvent = ::CreateEvent(nullptr, TRUE, FALSE, nullptr); if (!UnexpectedErrorEvent) { ProcessFailure(nullptr, L"UnexpectedErrorEvent creation failed", L"Desktop+ Error", E_UNEXPECTED); return 0; } // Event for when a thread encounters an expected error ExpectedErrorEvent = ::CreateEvent(nullptr, TRUE, FALSE, nullptr); if (!ExpectedErrorEvent) { ProcessFailure(nullptr, L"ExpectedErrorEvent creation failed", L"Desktop+ Error", E_UNEXPECTED); return 0; } // Event for when a thread succeeded in processing a frame NewFrameProcessedEvent = ::CreateEvent(nullptr, TRUE, FALSE, nullptr); if (!NewFrameProcessedEvent) { ProcessFailure(nullptr, L"NewFrameProcessedEvent creation failed", L"Desktop+ Error", E_UNEXPECTED); return 0; } //Event to tell threads to pause duplication (signaled by default) PauseDuplicationEvent = ::CreateEvent(nullptr, TRUE, TRUE, nullptr); if (!PauseDuplicationEvent) { ProcessFailure(nullptr, L"PauseDuplicationEvent creation failed", L"Desktop+ Error", E_UNEXPECTED); return 0; } //Event to tell threads to resume duplication ResumeDuplicationEvent = ::CreateEvent(nullptr, TRUE, FALSE, nullptr); if (!ResumeDuplicationEvent) { ProcessFailure(nullptr, L"ResumeDuplicationEvent creation failed", L"Desktop+ Error", E_UNEXPECTED); return 0; } // Event to tell spawned threads to quit TerminateThreadsEvent = ::CreateEvent(nullptr, TRUE, FALSE, nullptr); if (!TerminateThreadsEvent) { ProcessFailure(nullptr, L"TerminateThreadsEvent creation failed", L"Desktop+ Error", E_UNEXPECTED); return 0; } // Register class WNDCLASSEXW Wc; Wc.cbSize = sizeof(WNDCLASSEXW); Wc.style = 0; Wc.lpfnWndProc = WndProc; Wc.cbClsExtra = 0; Wc.cbWndExtra = 0; Wc.hInstance = hInstance; Wc.hIcon = nullptr; Wc.hCursor = nullptr; Wc.hbrBackground = nullptr; Wc.lpszMenuName = nullptr; Wc.lpszClassName = g_WindowClassNameDashboardApp; Wc.hIconSm = nullptr; if (!RegisterClassExW(&Wc)) { ProcessFailure(nullptr, L"Window class registration failed", L"Desktop+ Error", E_UNEXPECTED); return 0; } // Create window WindowHandle = ::CreateWindowW(g_WindowClassNameDashboardApp, L"Desktop+ Overlay", 0, 0, 0, 1, 1, HWND_DESKTOP, nullptr, hInstance, nullptr); if (!WindowHandle) { ProcessFailure(nullptr, L"Window creation failed", L"Desktop+ Error", E_FAIL); return 0; } //Init WinRT DLL DPWinRT_Init(); DPLog_DPWinRT_SupportInfo(); LOG_F(INFO, "Loaded WinRT library"); //Init BrowserClientAPI (this doesn't start the browser process, only checks for presence) DPBrowserAPIClient::Get().Init(); //Allow IPC messages even when elevated IPCManager::Get().DisableUIPForRegisteredMessages(WindowHandle); THREADMANAGER ThreadMgr; OutputManager OutMgr(PauseDuplicationEvent, ResumeDuplicationEvent); RECT DeskBounds; UINT OutputCount; //Start up UI process unless disabled or already running if ( (!ConfigManager::GetValue(configid_bool_interface_no_ui)) && (!IPCManager::IsUIAppRunning()) ) { std::wstring path = WStringConvertFromUTF8(ConfigManager::Get().GetApplicationPath().c_str()) + L"DesktopPlusUI.exe"; SpawnProcessWithDefaultEnv(path.c_str()); LOG_F(INFO, "Launched Desktop+ UI process"); } //Message loop MSG msg = {0}; DUPL_RETURN Ret = DUPL_RETURN_SUCCESS; DUPL_RETURN_UPD RetUpdate = DUPL_RETURN_UPD_SUCCESS; bool FirstTime = true; DYNAMIC_WAIT DynamicWait; LARGE_INTEGER UpdateLimiterStartingTime, UpdateLimiterEndingTime, UpdateLimiterElapsedMicroseconds; LARGE_INTEGER UpdateLimiterFrequency; bool IsNewFrame = false; bool SkipFrame = false; ::QueryPerformanceFrequency(&UpdateLimiterFrequency); ::QueryPerformanceCounter(&UpdateLimiterStartingTime); while (WM_QUIT != msg.message) { if ((!FirstTime) && (PeekMessage(&msg, nullptr, 0, 0, PM_REMOVE))) //Wait for init before processing messages { // Process window messages if (msg.message >= 0xC000) //Custom message from UI process, handle in output manager (WM_COPYDATA is handled in WndProc()) { if (OutMgr.HandleIPCMessage(msg)) { SetEvent(ExpectedErrorEvent); } } else if (msg.message >= WM_DPLUSWINRT) //WinRT library messages { OutMgr.HandleWinRTMessage(msg); } else if (msg.message == WM_HOTKEY) { OutMgr.HandleHotkeyMessage(msg); } else { TranslateMessage(&msg); DispatchMessage(&msg); } } else if (WaitForSingleObjectEx(UnexpectedErrorEvent, 0, FALSE) == WAIT_OBJECT_0) { // Unexpected error occurred so exit the application break; } else if ((FirstTime) || (WaitForSingleObjectEx(ExpectedErrorEvent, 0, FALSE) == WAIT_OBJECT_0)) { if (!FirstTime) { LOG_F(INFO, "System transition occured, reinitializing..."); // Terminate other threads ResetEvent(PauseDuplicationEvent); SetEvent(ResumeDuplicationEvent); SetEvent(TerminateThreadsEvent); ThreadMgr.WaitForThreadTermination(); ResetEvent(TerminateThreadsEvent); ResetEvent(ExpectedErrorEvent); ResetEvent(NewFrameProcessedEvent); ResetEvent(ResumeDuplicationEvent); // Clean up ThreadMgr.Clean(); OutMgr.CleanRefs(); // As we have encountered an error due to a system transition we wait before trying again, using this dynamic wait // the wait periods will get progressively long to avoid wasting too much system resource if this state lasts a long time DynamicWait.Wait(); } // Re-initialize vr::EVRInitError vr_init_error = vr::VRInitError_None; if (FirstTime) //InitOutput() needs OpenVR to be initialized already { auto init_error = OutMgr.InitOverlay(); //Display error message if init error states indicates one if (DisplayInitError(std::get(init_error), std::get(init_error), std::get(init_error))) { //An error message was displayed, abort Ret = DUPL_RETURN_ERROR_UNEXPECTED; break; } if ( (ConfigManager::GetValue(configid_bool_misc_no_steam)) && (ConfigManager::GetValue(configid_bool_state_misc_process_started_by_steam)) ) { //Was started by Steam but running through it was turned off, so restart without std::wstring path = WStringConvertFromUTF8(ConfigManager::Get().GetApplicationPath().c_str()) + L"DesktopPlus.exe"; SpawnProcessWithDefaultEnv(path.c_str()); break; } } Ret = OutMgr.InitOutput(WindowHandle, SingleOutput, &OutputCount, &DeskBounds); if (Ret == DUPL_RETURN_SUCCESS) { HANDLE SharedHandle = OutMgr.GetSharedHandle(); if (SharedHandle) { Ret = ThreadMgr.Initialize(SingleOutput, OutputCount, UnexpectedErrorEvent, ExpectedErrorEvent, NewFrameProcessedEvent, PauseDuplicationEvent, ResumeDuplicationEvent, TerminateThreadsEvent, SharedHandle, &DeskBounds, OutMgr.GetDXGIAdapter(), (ConfigManager::GetValue(configid_int_interface_wmr_ignore_vscreens) == 1)); } else { DisplayMsg(L"Failed to get handle of shared surface", L"Desktop+ Error", E_FAIL); Ret = DUPL_RETURN_ERROR_UNEXPECTED; } if (FirstTime) { // First time through the loop FirstTime = false; } else { ForceScreenRefresh(); } } else if (Ret == DUPL_RETURN_ERROR_EXPECTED) { if (OutputCount == 0) //No outputs right now, oops { OutMgr.SetOutputInvalid(); Ret = DUPL_RETURN_SUCCESS; //Entered "valid" state now, prevent auto-retry to needlessly kick in } FirstTime = false; } } else //Present frame or handle events as fast as needed { if (WaitForSingleObjectEx(NewFrameProcessedEvent, OutMgr.GetMaxRefreshDelay(), FALSE) == WAIT_OBJECT_0) //New frame { ResetEvent(NewFrameProcessedEvent); IsNewFrame = true; } else { IsNewFrame = (RetUpdate == DUPL_RETURN_UPD_RETRY); //Retry is treated as if it's new frame, otherwise false } //Update limiter/skipper const LARGE_INTEGER& limiter_delay = OutMgr.GetUpdateLimiterDelay(); bool update_limiter_active = (limiter_delay.QuadPart != 0); if (update_limiter_active) { QueryPerformanceCounter(&UpdateLimiterEndingTime); UpdateLimiterElapsedMicroseconds.QuadPart = UpdateLimiterEndingTime.QuadPart - UpdateLimiterStartingTime.QuadPart; UpdateLimiterElapsedMicroseconds.QuadPart *= 1000000; UpdateLimiterElapsedMicroseconds.QuadPart /= UpdateLimiterFrequency.QuadPart; SkipFrame = (UpdateLimiterElapsedMicroseconds.QuadPart < limiter_delay.QuadPart); } else { SkipFrame = false; } RetUpdate = OutMgr.Update(ThreadMgr.GetPointerInfo(), ThreadMgr.GetDirtyRegionTotal(), IsNewFrame, SkipFrame); //Map return value to DUPL_RETRUN Ret switch (RetUpdate) { case DUPL_RETURN_UPD_QUIT: Ret = DUPL_RETURN_ERROR_UNEXPECTED; break; case DUPL_RETURN_UPD_RETRY: Ret = DUPL_RETURN_SUCCESS; break; case DUPL_RETURN_UPD_SUCCESS_REFRESHED_OVERLAY: Ret = DUPL_RETURN_SUCCESS; break; default: Ret = (DUPL_RETURN)RetUpdate; } if ( (RetUpdate == DUPL_RETURN_UPD_SUCCESS_REFRESHED_OVERLAY) && (update_limiter_active) ) { QueryPerformanceCounter(&UpdateLimiterStartingTime); } OutMgr.UpdatePerformanceStates(); } // Check if for errors if (Ret != DUPL_RETURN_SUCCESS) { if (Ret == DUPL_RETURN_ERROR_EXPECTED) { // Some type of system transition is occurring so retry SetEvent(ExpectedErrorEvent); } else { // Unexpected error or exit event, so exit break; } } } LOG_F(INFO, "Shutting down..."); //Remove all overlays since they may access things on destruction after we're shut down otherwise OverlayManager::Get().RemoveAllOverlays(); //Quit Browser processes if they're running (we do this early since the browser doesn't poll for VREvent_Quit itself) DPBrowserAPIClient::Get().Quit(); // Make sure all other threads have exited if (SetEvent(TerminateThreadsEvent)) { //Wake them up first if needed ResetEvent(PauseDuplicationEvent); SetEvent(ResumeDuplicationEvent); ThreadMgr.WaitForThreadTermination(); } // Clean up CloseHandle(UnexpectedErrorEvent); CloseHandle(ExpectedErrorEvent); CloseHandle(NewFrameProcessedEvent); CloseHandle(PauseDuplicationEvent); CloseHandle(ResumeDuplicationEvent); CloseHandle(TerminateThreadsEvent); //Tell WindowManager to exit if it's still active WindowManager::Get().ClearTempTopMostWindow(); WindowManager::Get().SetActive(false); //Do other shutdown steps, like undimming the dashboard if needed OutMgr.OnExit(); //Kindly ask elevated mode process to quit if it exists if (HWND window = ::FindWindow(g_WindowClassNameElevatedMode, nullptr)) { ::PostMessage(window, WM_QUIT, 0, 0); } if (msg.message == WM_QUIT) { // For a WM_QUIT message we should return the wParam value return static_cast(msg.wParam); } return 0; } // // Window message processor // LRESULT CALLBACK WndProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam) { switch (message) { case WM_COPYDATA: { //Forward to output manager if (OutputManager::Get()) { bool mirror_reset_required = false; MSG msg; // Process all custom window messages posted before this while (PeekMessage(&msg, nullptr, 0xC000, 0xFFFF, PM_REMOVE)) { //Skip mirror reset messages here to prevent an endless loop if ((IPCManager::Get().GetIPCMessageID(msg.message) == ipcmsg_action) && (msg.wParam == ipcact_mirror_reset)) { continue; } if (OutputManager::Get()->HandleIPCMessage(msg)) { mirror_reset_required = true; } } msg.hwnd = hWnd; msg.message = message; msg.wParam = wParam; msg.lParam = lParam; if (OutputManager::Get()->HandleIPCMessage(msg)) { mirror_reset_required = true; } if (mirror_reset_required) { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_mirror_reset); } } break; } case WM_DISPLAYCHANGE: { //Update desktop count and rects if (OutputManager::Get()) { LOG_F(INFO, "WM_DISPLAYCHANGE recieved, re-enumerating outputs..."); OutputManager::Get()->EnumerateOutputs(); } break; } case WM_DESTROY: { PostQuitMessage(0); break; } default: return DefWindowProc(hWnd, message, wParam, lParam); } return 0; } bool SpawnProcessWithDefaultEnv(LPCWSTR application_name, LPWSTR commandline) { LPVOID env = nullptr; STARTUPINFO si = {0}; PROCESS_INFORMATION pi = {0}; si.cb = sizeof(si); //Use a new environment block since we don't want to copy the Steam environment variables if there are any if (::CreateEnvironmentBlock(&env, ::GetCurrentProcessToken(), FALSE)) { bool ret = ::CreateProcess(application_name, commandline, nullptr, nullptr, FALSE, CREATE_UNICODE_ENVIRONMENT, env, nullptr, &si, &pi); //We don't care about these, so close right away ::CloseHandle(pi.hProcess); ::CloseHandle(pi.hThread); ::DestroyEnvironmentBlock(env); return ret; } return false; } void ProcessCmdline(bool& use_elevated_mode, bool& cancel_startup) { //__argv and __argc are global vars set by system for (UINT i = 0; i < static_cast(__argc); ++i) { if ((strcmp(__argv[i], "-ElevatedMode") == 0) || (strcmp(__argv[i], "--ElevatedMode") == 0) || (strcmp(__argv[i], "/ElevatedMode") == 0)) { use_elevated_mode = true; } else if ((strcmp(__argv[i], "-DoAction") == 0) || (strcmp(__argv[i], "--DoAction") == 0) || (strcmp(__argv[i], "/DoAction") == 0)) { //Take the following argument and parse it as ActionUID to send it to the running dashboard app instance if (__argc > i + 1) { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_action_do, std::strtoull(__argv[i+1], nullptr, 10)); } cancel_startup = true; } } } bool DisplayInitError(vr::EVRInitError vr_init_error, vr::EVROverlayError vr_overlay_error, bool vr_input_success) { if (vr_init_error != vr::VRInitError_None) { if ( (vr_init_error == vr::VRInitError_Init_HmdNotFound) || (vr_init_error == vr::VRInitError_Init_HmdNotFoundPresenceFailed) ) { DisplayMsg(L"Failed to init OpenVR: HMD not found.\nRe-launch application with a HMD connected.", L"Desktop+ Error", E_FAIL); } else if (vr_init_error == vr::VRInitError_Init_InvalidInterface) { DisplayMsg(L"Failed to init OpenVR: Invalid Interface.\nMake sure to have the latest version of SteamVR installed.", L"Desktop+ Error", E_FAIL); } else if (vr_init_error != vr::VRInitError_Init_InitCanceledByUser) //Exclude canceled, supposed to be always silent exit { std::wstring error_str = L"Failed to init OpenVR: "; error_str += WStringConvertFromUTF8(vr::VR_GetVRInitErrorAsEnglishDescription(vr_init_error)); error_str += L"."; DisplayMsg(error_str.c_str(), L"Desktop+ Error", E_FAIL); } return true; } if (vr_overlay_error != vr::VROverlayError_None) { std::wstring error_str = L"Failed to init overlay: "; error_str += WStringConvertFromUTF8(vr::VROverlay()->GetOverlayErrorNameFromEnum(vr_overlay_error)); error_str += L"."; DisplayMsg(error_str.c_str(), L"Desktop+ Error", E_FAIL); return true; } if (!vr_input_success) { //VRInput not working is bad, but doesn't stop us from running, so just log it LOG_F(WARNING, "Failed to load VRInput action manifest. Some input-related functionality will not be available"); } return false; } // // Entry point for new duplication threads // DWORD WINAPI CaptureThreadEntry(_In_ void* Param) { // Classes DISPLAYMANAGER DispMgr; DUPLICATIONMANAGER DuplMgr; // D3D objects ID3D11Texture2D* SharedSurf = nullptr; IDXGIKeyedMutex* KeyMutex = nullptr; // Data passed in from thread creation THREAD_DATA* TData = reinterpret_cast(Param); // Get desktop DUPL_RETURN Ret; HDESK CurrentDesktop = nullptr; CurrentDesktop = OpenInputDesktop(0, FALSE, GENERIC_ALL); if (!CurrentDesktop) { // We do not have access to the desktop so request a retry SetEvent(TData->ExpectedErrorEvent); Ret = DUPL_RETURN_ERROR_EXPECTED; goto Exit; } // Attach desktop to this thread bool DesktopAttached = SetThreadDesktop(CurrentDesktop) != 0; CloseDesktop(CurrentDesktop); CurrentDesktop = nullptr; if (!DesktopAttached) { // We do not have access to the desktop so request a retry Ret = DUPL_RETURN_ERROR_EXPECTED; goto Exit; } // New display manager DispMgr.InitD3D(&TData->DxRes); // Obtain handle to sync shared Surface HRESULT hr = TData->DxRes.Device->OpenSharedResource(TData->TexSharedHandle, __uuidof(ID3D11Texture2D), reinterpret_cast(&SharedSurf)); if (FAILED (hr)) { Ret = ProcessFailure(TData->DxRes.Device, L"Opening shared texture failed", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); goto Exit; } hr = SharedSurf->QueryInterface(__uuidof(IDXGIKeyedMutex), reinterpret_cast(&KeyMutex)); if (FAILED(hr)) { Ret = ProcessFailure(nullptr, L"Failed to get keyed mutex interface in spawned thread", L"Desktop+ Error", hr); goto Exit; } D3D11_TEXTURE2D_DESC SharedSurfDesc; SharedSurf->GetDesc(&SharedSurfDesc); // Make duplication manager Ret = DuplMgr.InitDupl(TData->DxRes.Device, TData->Output, TData->WMRIgnoreVScreens, SharedSurfDesc.Format != DXGI_FORMAT_B8G8R8A8_UNORM); if (Ret != DUPL_RETURN_SUCCESS) { goto Exit; } // Get output description DXGI_OUTPUT_DESC DesktopDesc; RtlZeroMemory(&DesktopDesc, sizeof(DXGI_OUTPUT_DESC)); DuplMgr.GetOutputDesc(&DesktopDesc); // Main duplication loop bool WaitToProcessCurrentFrame = false; FRAME_DATA CurrentData; while ((WaitForSingleObjectEx(TData->TerminateThreadsEvent, 0, FALSE) == WAIT_TIMEOUT)) { //Wait if pause event was signaled if ((WaitForSingleObjectEx(TData->PauseDuplicationEvent, 0, FALSE) == WAIT_OBJECT_0)) { WaitForSingleObjectEx(TData->ResumeDuplicationEvent, INFINITE, FALSE); //Wait forever. Thread shutdown will also signal resume } if (!WaitToProcessCurrentFrame) { // Get new frame from desktop duplication bool TimeOut; Ret = DuplMgr.GetFrame(&CurrentData, &TimeOut); if (Ret != DUPL_RETURN_SUCCESS) { // An error occurred getting the next frame drop out of loop which // will check if it was expected or not break; } // Check for timeout if (TimeOut) { // No new frame at the moment continue; } } // We have a new frame so try and process it // Try to acquire keyed mutex in order to access shared surface hr = KeyMutex->AcquireSync(0, 1000); if (hr == static_cast(WAIT_TIMEOUT)) { // Can't use shared surface right now, try again later WaitToProcessCurrentFrame = true; continue; } else if (FAILED(hr)) { // Generic unknown failure Ret = ProcessFailure(TData->DxRes.Device, L"Unexpected error acquiring keyed mutex", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); DuplMgr.DoneWithFrame(); break; } // We can now process the current frame WaitToProcessCurrentFrame = false; // Get mouse info Ret = DuplMgr.GetMouse(TData->PtrInfo, &(CurrentData.FrameInfo), TData->OffsetX, TData->OffsetY); if (Ret != DUPL_RETURN_SUCCESS) { DuplMgr.DoneWithFrame(); KeyMutex->ReleaseSync(1); break; } // Process new frame Ret = DispMgr.ProcessFrame(&CurrentData, SharedSurf, TData->OffsetX, TData->OffsetY, &DesktopDesc, *TData->DirtyRegionTotal); if (Ret != DUPL_RETURN_SUCCESS) { DuplMgr.DoneWithFrame(); KeyMutex->ReleaseSync(1); SetEvent(TData->NewFrameProcessedEvent); break; } // Release acquired keyed mutex hr = KeyMutex->ReleaseSync(1); if (FAILED(hr)) { Ret = ProcessFailure(TData->DxRes.Device, L"Unexpected error releasing the keyed mutex", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); DuplMgr.DoneWithFrame(); break; } // Release frame back to desktop duplication Ret = DuplMgr.DoneWithFrame(); if (Ret != DUPL_RETURN_SUCCESS) { break; } SetEvent(TData->NewFrameProcessedEvent); } Exit: if (Ret != DUPL_RETURN_SUCCESS) { if (Ret == DUPL_RETURN_ERROR_EXPECTED) { // The system is in a transition state so request the duplication be restarted SetEvent(TData->ExpectedErrorEvent); } else { // Unexpected error so exit the application SetEvent(TData->UnexpectedErrorEvent); } } if (SharedSurf) { SharedSurf->Release(); SharedSurf = nullptr; } if (KeyMutex) { KeyMutex->Release(); KeyMutex = nullptr; } return 0; } _Post_satisfies_(return != DUPL_RETURN_SUCCESS) DUPL_RETURN ProcessFailure(_In_opt_ ID3D11Device* device, _In_ LPCWSTR str, _In_ LPCWSTR title, HRESULT hr, _In_opt_z_ HRESULT* expected_errors) { HRESULT translated_hr; // On an error check if the DX device is lost if (device) { HRESULT device_removed_reason = device->GetDeviceRemovedReason(); switch (device_removed_reason) { case DXGI_ERROR_DEVICE_REMOVED: case DXGI_ERROR_DEVICE_RESET: case static_cast(E_OUTOFMEMORY): { // Our device has been stopped due to an external event on the GPU so map them all to // device removed and continue processing the condition translated_hr = DXGI_ERROR_DEVICE_REMOVED; break; } case S_OK: { // Device is not removed so use original error translated_hr = hr; break; } default: { // Device is removed but not a error we want to remap translated_hr = device_removed_reason; } } } else { translated_hr = hr; } // Check if this error was expected or not if (expected_errors) { HRESULT* current_result = expected_errors; while (*current_result != S_OK) { if (*(current_result++) == translated_hr) { return DUPL_RETURN_ERROR_EXPECTED; } } } // Error was not expected so display the message box DisplayMsg(str, title, translated_hr); return DUPL_RETURN_ERROR_UNEXPECTED; } // // Displays a message // void DisplayMsg(_In_ LPCWSTR str, _In_ LPCWSTR title, HRESULT hr) { //Generate a proper error message with description from the OS, unless it's E_FAIL which is unspecified anyways and we use it for our own errors passed to this function std::wstringstream ss; if (hr != E_FAIL) { std::error_code ec(hr, std::system_category()); ss << str << L":\n" << WStringConvertFromLocalEncoding(ec.message().c_str()) << L" (0x" << std::hex << std::setfill(L'0') << std::setw(8) << hr << L")"; } else { ss << str; } std::string str_u8 = StringConvertFromUTF16(ss.str().c_str()); //Try having the UI app display it if it's an error if (!SUCCEEDED(hr)) { HWND window = (OutputManager::Get() != nullptr) ? OutputManager::Get()->GetWindowHandle() : nullptr; IPCManager::Get().SendStringToUIApp(configid_str_state_dashboard_error_string, str_u8.c_str(), window); } //Get rid of newlines before logging (system error strings comes with CRLF while \n is treated as LF-only before writing to file...) StringReplaceAll(str_u8, "\r\n", " "); StringReplaceAll(str_u8, "\n", " "); VLOG_F((SUCCEEDED(hr)) ? loguru::Verbosity_INFO : loguru::Verbosity_ERROR, str_u8.c_str()); //While we always try to send error messages to the UI app to have it display in VR, show the message on the desktop if UI is not running or VR isn't loaded if ((!IPCManager::IsUIAppRunning()) || (vr::VROverlay() == nullptr)) { ::MessageBoxW(nullptr, str, title, MB_OK); } } ================================================ FILE: src/DesktopPlus/DesktopPlus.manifest ================================================ ================================================ FILE: src/DesktopPlus/DesktopPlus.ruleset ================================================  ================================================ FILE: src/DesktopPlus/DesktopPlus.vcxproj ================================================  Debug x64 Release x64 {05050918-71E9-AF87-0B3C-6F34D471A55A} DesktopPlus DesktopPlus Application true Unicode v142 Application false Unicode v142 true true DesktopPlus.ruleset false false DesktopPlus.ruleset false LOGURU_FILENAME_WIDTH=30;LOGURU_VERBOSE_SCOPE_ENDINGS=0;DPLUS_SHA=$(DPLUS_SHA);WIN32;_DEBUG;_WINDOWS;_WIN32_WINNT=_WIN32_WINNT_WIN8;%(PreprocessorDefinitions) MultiThreadedDebug EditAndContinue Disabled $(OutDir);..\Shared;..\DesktopPlus;..\DesktopPlusWinRT true %(DisableSpecificWarnings) true Windows d3d11.lib;dxgi.lib;openvr_api.lib;winmm.lib;dwmapi.lib;userenv.lib;DesktopPlusWinRT.lib;%(AdditionalDependencies) $(SolutionDir)Shared;$(OutputPath) PerMonitorHighDPIAware "DesktopPlus_$([System.DateTime]::Now.ToFileTime()), version=1" LOGURU_FILENAME_WIDTH=30;LOGURU_VERBOSE_SCOPE_ENDINGS=0;DPLUS_SHA=$(DPLUS_SHA);WIN32;NDEBUG;_WINDOWS;_WIN32_WINNT=_WIN32_WINNT_WIN8;%(PreprocessorDefinitions) MultiThreaded None Full $(OutDir);..\Shared;..\DesktopPlus;..\DesktopPlusWinRT true %(DisableSpecificWarnings) AnySuitable true Speed true true true false Windows true true d3d11.lib;dxgi.lib;openvr_api.lib;winmm.lib;dwmapi.lib;userenv.lib;DesktopPlusWinRT.lib;%(AdditionalDependencies) $(SolutionDir)Shared;$(OutputPath) PerMonitorHighDPIAware "DesktopPlus_$([System.DateTime]::Now.ToFileTime()), version=1" $(OutDir);%(AdditionalIncludeDirectories) $(OutDir);%(AdditionalIncludeDirectories) PS Pixel 4.0_level_9_1 PS 4.0_level_9_1 Pixel $(OutDir)%(Filename).h $(OutDir)%(Filename).h PSCURSOR Pixel $(OutDir)%(Filename).h PSCURSOR $(OutDir)%(Filename).h Pixel VS 4.0_level_9_1 VS 4.0_level_9_1 Vertex $(OutDir)%(Filename).h $(OutDir)%(Filename).h Vertex PreserveNewest true %(RecursiveDir)\%(Filename)%(Extension) ================================================ FILE: src/DesktopPlus/DesktopPlus.vcxproj.filters ================================================  Shared Shared Shared Shared Shared Shared Shared Shared Shared Shared Shared Shared Shared Shared Shared Shared Shared Shared Shared Shared Shared Shared Shared Shared Shared Shared Shared Shared Shared Shared Shared Shared Shared Shared {0572e516-12c3-49ec-a3ae-3696d6eb2490} ================================================ FILE: src/DesktopPlus/DesktopPlus.vcxproj.user ================================================  $(OutputPath) WindowsLocalDebugger $(OutputPath) WindowsLocalDebugger ================================================ FILE: src/DesktopPlus/DisplayManager.cpp ================================================ #include "DisplayManager.h" using namespace DirectX; #include "DPRect.h" // // Constructor NULLs out vars // DISPLAYMANAGER::DISPLAYMANAGER() : m_Device(nullptr), m_DeviceContext(nullptr), m_MoveSurf(nullptr), m_VertexShader(nullptr), m_PixelShader(nullptr), m_InputLayout(nullptr), m_RTV(nullptr), m_SamplerLinear(nullptr), m_DirtyVertexBufferAlloc(nullptr), m_DirtyVertexBufferAllocSize(0) { } // // Destructor calls CleanRefs to destroy everything // DISPLAYMANAGER::~DISPLAYMANAGER() { CleanRefs(); if (m_DirtyVertexBufferAlloc) { delete [] m_DirtyVertexBufferAlloc; m_DirtyVertexBufferAlloc = nullptr; } } // // Initialize D3D variables // void DISPLAYMANAGER::InitD3D(DX_RESOURCES* Data) { m_Device = Data->Device; m_DeviceContext = Data->Context; m_VertexShader = Data->VertexShader; m_PixelShader = Data->PixelShader; m_InputLayout = Data->InputLayout; m_SamplerLinear = Data->Sampler; m_Device->AddRef(); m_DeviceContext->AddRef(); m_VertexShader->AddRef(); m_PixelShader->AddRef(); m_InputLayout->AddRef(); m_SamplerLinear->AddRef(); } // // Process a given frame and its metadata // DUPL_RETURN DISPLAYMANAGER::ProcessFrame(_In_ FRAME_DATA* Data, _Inout_ ID3D11Texture2D* SharedSurf, INT OffsetX, INT OffsetY, _In_ DXGI_OUTPUT_DESC* DeskDesc, _Inout_ DPRect& DirtyRectTotal) { DUPL_RETURN Ret = DUPL_RETURN_SUCCESS; // Process dirties and moves if (Data->FrameInfo.TotalMetadataBufferSize) { D3D11_TEXTURE2D_DESC Desc; Data->Frame->GetDesc(&Desc); if (Data->MoveCount) { Ret = CopyMove(SharedSurf, reinterpret_cast(Data->MetaData), Data->MoveCount, OffsetX, OffsetY, DeskDesc, Desc.Width, Desc.Height, DirtyRectTotal); if (Ret != DUPL_RETURN_SUCCESS) { return Ret; } } if (Data->DirtyCount) { Ret = CopyDirty(Data->Frame, SharedSurf, reinterpret_cast(Data->MetaData + (Data->MoveCount * sizeof(DXGI_OUTDUPL_MOVE_RECT))), Data->DirtyCount, OffsetX, OffsetY, DeskDesc, DirtyRectTotal); } } return Ret; } // // Returns D3D device being used // ID3D11Device* DISPLAYMANAGER::GetDevice() { return m_Device; } // // Set appropriate source and destination rects for move rects // void DISPLAYMANAGER::SetMoveRect(_Out_ RECT* SrcRect, _Out_ RECT* DestRect, _In_ DXGI_OUTPUT_DESC* DeskDesc, _In_ DXGI_OUTDUPL_MOVE_RECT* MoveRect, INT TexWidth, INT TexHeight) { switch (DeskDesc->Rotation) { case DXGI_MODE_ROTATION_UNSPECIFIED: case DXGI_MODE_ROTATION_IDENTITY: { SrcRect->left = MoveRect->SourcePoint.x; SrcRect->top = MoveRect->SourcePoint.y; SrcRect->right = MoveRect->SourcePoint.x + MoveRect->DestinationRect.right - MoveRect->DestinationRect.left; SrcRect->bottom = MoveRect->SourcePoint.y + MoveRect->DestinationRect.bottom - MoveRect->DestinationRect.top; *DestRect = MoveRect->DestinationRect; break; } case DXGI_MODE_ROTATION_ROTATE90: { SrcRect->left = TexHeight - (MoveRect->SourcePoint.y + MoveRect->DestinationRect.bottom - MoveRect->DestinationRect.top); SrcRect->top = MoveRect->SourcePoint.x; SrcRect->right = TexHeight - MoveRect->SourcePoint.y; SrcRect->bottom = MoveRect->SourcePoint.x + MoveRect->DestinationRect.right - MoveRect->DestinationRect.left; DestRect->left = TexHeight - MoveRect->DestinationRect.bottom; DestRect->top = MoveRect->DestinationRect.left; DestRect->right = TexHeight - MoveRect->DestinationRect.top; DestRect->bottom = MoveRect->DestinationRect.right; break; } case DXGI_MODE_ROTATION_ROTATE180: { SrcRect->left = TexWidth - (MoveRect->SourcePoint.x + MoveRect->DestinationRect.right - MoveRect->DestinationRect.left); SrcRect->top = TexHeight - (MoveRect->SourcePoint.y + MoveRect->DestinationRect.bottom - MoveRect->DestinationRect.top); SrcRect->right = TexWidth - MoveRect->SourcePoint.x; SrcRect->bottom = TexHeight - MoveRect->SourcePoint.y; DestRect->left = TexWidth - MoveRect->DestinationRect.right; DestRect->top = TexHeight - MoveRect->DestinationRect.bottom; DestRect->right = TexWidth - MoveRect->DestinationRect.left; DestRect->bottom = TexHeight - MoveRect->DestinationRect.top; break; } case DXGI_MODE_ROTATION_ROTATE270: { SrcRect->left = MoveRect->SourcePoint.x; SrcRect->top = TexWidth - (MoveRect->SourcePoint.x + MoveRect->DestinationRect.right - MoveRect->DestinationRect.left); SrcRect->right = MoveRect->SourcePoint.y + MoveRect->DestinationRect.bottom - MoveRect->DestinationRect.top; SrcRect->bottom = TexWidth - MoveRect->SourcePoint.x; DestRect->left = MoveRect->DestinationRect.top; DestRect->top = TexWidth - MoveRect->DestinationRect.right; DestRect->right = MoveRect->DestinationRect.bottom; DestRect->bottom = TexWidth - MoveRect->DestinationRect.left; break; } default: { RtlZeroMemory(DestRect, sizeof(RECT)); RtlZeroMemory(SrcRect, sizeof(RECT)); break; } } } // // Copy move rectangles // DUPL_RETURN DISPLAYMANAGER::CopyMove(_Inout_ ID3D11Texture2D* SharedSurf, _In_reads_(MoveCount) DXGI_OUTDUPL_MOVE_RECT* MoveBuffer, UINT MoveCount, INT OffsetX, INT OffsetY, _In_ DXGI_OUTPUT_DESC* DeskDesc, INT TexWidth, INT TexHeight, _Inout_ DPRect& DirtyRectTotal) { D3D11_TEXTURE2D_DESC FullDesc; SharedSurf->GetDesc(&FullDesc); // Make new intermediate surface to copy into for moving if (!m_MoveSurf) { D3D11_TEXTURE2D_DESC MoveDesc; MoveDesc = FullDesc; MoveDesc.Width = DeskDesc->DesktopCoordinates.right - DeskDesc->DesktopCoordinates.left; MoveDesc.Height = DeskDesc->DesktopCoordinates.bottom - DeskDesc->DesktopCoordinates.top; MoveDesc.BindFlags = D3D11_BIND_RENDER_TARGET; MoveDesc.MiscFlags = 0; HRESULT hr = m_Device->CreateTexture2D(&MoveDesc, nullptr, &m_MoveSurf); if (FAILED(hr)) { return ProcessFailure(m_Device, L"Failed to create staging texture for move rects", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } } for (UINT i = 0; i < MoveCount; ++i) { RECT SrcRect; RECT DestRect; SetMoveRect(&SrcRect, &DestRect, DeskDesc, &(MoveBuffer[i]), TexWidth, TexHeight); // Copy rect out of shared surface D3D11_BOX Box; Box.left = SrcRect.left + DeskDesc->DesktopCoordinates.left - OffsetX; Box.top = SrcRect.top + DeskDesc->DesktopCoordinates.top - OffsetY; Box.front = 0; Box.right = SrcRect.right + DeskDesc->DesktopCoordinates.left - OffsetX; Box.bottom = SrcRect.bottom + DeskDesc->DesktopCoordinates.top - OffsetY; Box.back = 1; m_DeviceContext->CopySubresourceRegion(m_MoveSurf, 0, SrcRect.left, SrcRect.top, 0, SharedSurf, 0, &Box); // Copy back to shared surface Box.left = SrcRect.left; Box.top = SrcRect.top; Box.front = 0; Box.right = SrcRect.right; Box.bottom = SrcRect.bottom; Box.back = 1; //Adjust by desktop and destination offsets DestRect.left += DeskDesc->DesktopCoordinates.left - OffsetX; DestRect.top += DeskDesc->DesktopCoordinates.top - OffsetY; m_DeviceContext->CopySubresourceRegion(SharedSurf, 0, DestRect.left, DestRect.top, 0, m_MoveSurf, 0, &Box); //Add rect to total dirty region rect DPRect drect(DestRect.left, DestRect.top, (int)Box.right, (int)Box.bottom); (DirtyRectTotal.GetTL().x == -1) ? DirtyRectTotal = drect : DirtyRectTotal.Add(drect); } return DUPL_RETURN_SUCCESS; } // // Sets up vertices for dirty rects for rotated desktops // #pragma warning(push) #pragma warning(disable:__WARNING_USING_UNINIT_VAR) // false positives in SetDirtyVert due to tool bug void DISPLAYMANAGER::SetDirtyVert(_Out_writes_(NUMVERTICES) VERTEX* Vertices, _In_ RECT* Dirty, INT OffsetX, INT OffsetY, _In_ DXGI_OUTPUT_DESC* DeskDesc, _In_ D3D11_TEXTURE2D_DESC* FullDesc, _In_ D3D11_TEXTURE2D_DESC* ThisDesc, _Inout_ DPRect& DirtyRectTotal) { FLOAT CenterX = FullDesc->Width / 2.0f; FLOAT CenterY = FullDesc->Height / 2.0f; INT Width = DeskDesc->DesktopCoordinates.right - DeskDesc->DesktopCoordinates.left; INT Height = DeskDesc->DesktopCoordinates.bottom - DeskDesc->DesktopCoordinates.top; // Rotation compensated destination rect RECT DestDirty = *Dirty; // Set appropriate coordinates compensated for rotation switch (DeskDesc->Rotation) { case DXGI_MODE_ROTATION_ROTATE90: { DestDirty.left = Width - Dirty->bottom; DestDirty.top = Dirty->left; DestDirty.right = Width - Dirty->top; DestDirty.bottom = Dirty->right; Vertices[0].TexCoord = XMFLOAT2(Dirty->right / static_cast(ThisDesc->Width), Dirty->bottom / static_cast(ThisDesc->Height)); Vertices[1].TexCoord = XMFLOAT2(Dirty->left / static_cast(ThisDesc->Width), Dirty->bottom / static_cast(ThisDesc->Height)); Vertices[2].TexCoord = XMFLOAT2(Dirty->right / static_cast(ThisDesc->Width), Dirty->top / static_cast(ThisDesc->Height)); Vertices[5].TexCoord = XMFLOAT2(Dirty->left / static_cast(ThisDesc->Width), Dirty->top / static_cast(ThisDesc->Height)); break; } case DXGI_MODE_ROTATION_ROTATE180: { DestDirty.left = Width - Dirty->right; DestDirty.top = Height - Dirty->bottom; DestDirty.right = Width - Dirty->left; DestDirty.bottom = Height - Dirty->top; Vertices[0].TexCoord = XMFLOAT2(Dirty->right / static_cast(ThisDesc->Width), Dirty->top / static_cast(ThisDesc->Height)); Vertices[1].TexCoord = XMFLOAT2(Dirty->right / static_cast(ThisDesc->Width), Dirty->bottom / static_cast(ThisDesc->Height)); Vertices[2].TexCoord = XMFLOAT2(Dirty->left / static_cast(ThisDesc->Width), Dirty->top / static_cast(ThisDesc->Height)); Vertices[5].TexCoord = XMFLOAT2(Dirty->left / static_cast(ThisDesc->Width), Dirty->bottom / static_cast(ThisDesc->Height)); break; } case DXGI_MODE_ROTATION_ROTATE270: { DestDirty.left = Dirty->top; DestDirty.top = Height - Dirty->right; DestDirty.right = Dirty->bottom; DestDirty.bottom = Height - Dirty->left; Vertices[0].TexCoord = XMFLOAT2(Dirty->left / static_cast(ThisDesc->Width), Dirty->top / static_cast(ThisDesc->Height)); Vertices[1].TexCoord = XMFLOAT2(Dirty->right / static_cast(ThisDesc->Width), Dirty->top / static_cast(ThisDesc->Height)); Vertices[2].TexCoord = XMFLOAT2(Dirty->left / static_cast(ThisDesc->Width), Dirty->bottom / static_cast(ThisDesc->Height)); Vertices[5].TexCoord = XMFLOAT2(Dirty->right / static_cast(ThisDesc->Width), Dirty->bottom / static_cast(ThisDesc->Height)); break; } default: assert(false); // drop through case DXGI_MODE_ROTATION_UNSPECIFIED: case DXGI_MODE_ROTATION_IDENTITY: { Vertices[0].TexCoord = XMFLOAT2(Dirty->left / static_cast(ThisDesc->Width), Dirty->bottom / static_cast(ThisDesc->Height)); Vertices[1].TexCoord = XMFLOAT2(Dirty->left / static_cast(ThisDesc->Width), Dirty->top / static_cast(ThisDesc->Height)); Vertices[2].TexCoord = XMFLOAT2(Dirty->right / static_cast(ThisDesc->Width), Dirty->bottom / static_cast(ThisDesc->Height)); Vertices[5].TexCoord = XMFLOAT2(Dirty->right / static_cast(ThisDesc->Width), Dirty->top / static_cast(ThisDesc->Height)); break; } } // Set positions Vertices[0].Pos = XMFLOAT3((DestDirty.left + DeskDesc->DesktopCoordinates.left - OffsetX - CenterX) / CenterX, -1 * (DestDirty.bottom + DeskDesc->DesktopCoordinates.top - OffsetY - CenterY) / CenterY, 0.0f); Vertices[1].Pos = XMFLOAT3((DestDirty.left + DeskDesc->DesktopCoordinates.left - OffsetX - CenterX) / CenterX, -1 * (DestDirty.top + DeskDesc->DesktopCoordinates.top - OffsetY - CenterY) / CenterY, 0.0f); Vertices[2].Pos = XMFLOAT3((DestDirty.right + DeskDesc->DesktopCoordinates.left - OffsetX - CenterX) / CenterX, -1 * (DestDirty.bottom + DeskDesc->DesktopCoordinates.top - OffsetY - CenterY) / CenterY, 0.0f); Vertices[3].Pos = Vertices[2].Pos; Vertices[4].Pos = Vertices[1].Pos; Vertices[5].Pos = XMFLOAT3((DestDirty.right + DeskDesc->DesktopCoordinates.left - OffsetX - CenterX) / CenterX, -1 * (DestDirty.top + DeskDesc->DesktopCoordinates.top - OffsetY - CenterY) / CenterY, 0.0f); Vertices[3].TexCoord = Vertices[2].TexCoord; Vertices[4].TexCoord = Vertices[1].TexCoord; //Add rect to total dirty region rect DPRect drect(DestDirty.left, DestDirty.top, DestDirty.right, DestDirty.bottom); drect.Translate({DeskDesc->DesktopCoordinates.left - OffsetX, DeskDesc->DesktopCoordinates.top - OffsetY}); (DirtyRectTotal.GetTL().x == -1) ? DirtyRectTotal = drect : DirtyRectTotal.Add(drect); } #pragma warning(pop) // re-enable __WARNING_USING_UNINIT_VAR // // Copies dirty rectangles // DUPL_RETURN DISPLAYMANAGER::CopyDirty(_In_ ID3D11Texture2D* SrcSurface, _Inout_ ID3D11Texture2D* SharedSurf, _In_reads_(DirtyCount) RECT* DirtyBuffer, UINT DirtyCount, INT OffsetX, INT OffsetY, _In_ DXGI_OUTPUT_DESC* DeskDesc, _Inout_ DPRect& DirtyRectTotal) { HRESULT hr; D3D11_TEXTURE2D_DESC FullDesc; SharedSurf->GetDesc(&FullDesc); D3D11_TEXTURE2D_DESC ThisDesc; SrcSurface->GetDesc(&ThisDesc); if (!m_RTV) { hr = m_Device->CreateRenderTargetView(SharedSurf, nullptr, &m_RTV); if (FAILED(hr)) { return ProcessFailure(m_Device, L"Failed to create render target view for dirty rects", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } } D3D11_SHADER_RESOURCE_VIEW_DESC ShaderDesc; ShaderDesc.Format = ThisDesc.Format; ShaderDesc.ViewDimension = D3D11_SRV_DIMENSION_TEXTURE2D; ShaderDesc.Texture2D.MostDetailedMip = ThisDesc.MipLevels - 1; ShaderDesc.Texture2D.MipLevels = ThisDesc.MipLevels; // Create new shader resource view ID3D11ShaderResourceView* ShaderResource = nullptr; hr = m_Device->CreateShaderResourceView(SrcSurface, &ShaderDesc, &ShaderResource); if (FAILED(hr)) { return ProcessFailure(m_Device, L"Failed to create shader resource view for dirty rects", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } FLOAT BlendFactor[4] = {0.f, 0.f, 0.f, 0.f}; m_DeviceContext->OMSetBlendState(nullptr, BlendFactor, 0xFFFFFFFF); m_DeviceContext->OMSetRenderTargets(1, &m_RTV, nullptr); m_DeviceContext->VSSetShader(m_VertexShader, nullptr, 0); m_DeviceContext->PSSetShader(m_PixelShader, nullptr, 0); m_DeviceContext->PSSetShaderResources(0, 1, &ShaderResource); m_DeviceContext->PSSetSamplers(0, 1, &m_SamplerLinear); m_DeviceContext->IASetPrimitiveTopology(D3D11_PRIMITIVE_TOPOLOGY_TRIANGLELIST); // Create space for vertices for the dirty rects if the current space isn't large enough UINT BytesNeeded = sizeof(VERTEX) * NUMVERTICES * DirtyCount; if (BytesNeeded > m_DirtyVertexBufferAllocSize) { if (m_DirtyVertexBufferAlloc) { delete [] m_DirtyVertexBufferAlloc; } m_DirtyVertexBufferAlloc = new (std::nothrow) BYTE[BytesNeeded]; if (!m_DirtyVertexBufferAlloc) { m_DirtyVertexBufferAllocSize = 0; return ProcessFailure(nullptr, L"Failed to allocate memory for dirty vertex buffer", L"Desktop+ Error", E_OUTOFMEMORY); } m_DirtyVertexBufferAllocSize = BytesNeeded; } // Fill them in VERTEX* DirtyVertex = reinterpret_cast(m_DirtyVertexBufferAlloc); for (UINT i = 0; i < DirtyCount; ++i, DirtyVertex += NUMVERTICES) { SetDirtyVert(DirtyVertex, &(DirtyBuffer[i]), OffsetX, OffsetY, DeskDesc, &FullDesc, &ThisDesc, DirtyRectTotal); } // Create vertex buffer D3D11_BUFFER_DESC BufferDesc; RtlZeroMemory(&BufferDesc, sizeof(BufferDesc)); BufferDesc.Usage = D3D11_USAGE_DEFAULT; BufferDesc.ByteWidth = BytesNeeded; BufferDesc.BindFlags = D3D11_BIND_VERTEX_BUFFER; BufferDesc.CPUAccessFlags = 0; D3D11_SUBRESOURCE_DATA InitData; RtlZeroMemory(&InitData, sizeof(InitData)); InitData.pSysMem = m_DirtyVertexBufferAlloc; ID3D11Buffer* VertBuf = nullptr; hr = m_Device->CreateBuffer(&BufferDesc, &InitData, &VertBuf); if (FAILED(hr)) { return ProcessFailure(m_Device, L"Failed to create vertex buffer in dirty rect processing", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } UINT Stride = sizeof(VERTEX); UINT Offset = 0; m_DeviceContext->IASetVertexBuffers(0, 1, &VertBuf, &Stride, &Offset); D3D11_VIEWPORT VP; VP.Width = static_cast(FullDesc.Width); VP.Height = static_cast(FullDesc.Height); VP.MinDepth = 0.0f; VP.MaxDepth = 1.0f; VP.TopLeftX = 0.0f; VP.TopLeftY = 0.0f; m_DeviceContext->RSSetViewports(1, &VP); m_DeviceContext->Draw(NUMVERTICES * DirtyCount, 0); VertBuf->Release(); VertBuf = nullptr; ShaderResource->Release(); ShaderResource = nullptr; return DUPL_RETURN_SUCCESS; } // // Clean all references // void DISPLAYMANAGER::CleanRefs() { if (m_DeviceContext) { m_DeviceContext->Release(); m_DeviceContext = nullptr; } if (m_Device) { m_Device->Release(); m_Device = nullptr; } if (m_MoveSurf) { m_MoveSurf->Release(); m_MoveSurf = nullptr; } if (m_VertexShader) { m_VertexShader->Release(); m_VertexShader = nullptr; } if (m_PixelShader) { m_PixelShader->Release(); m_PixelShader = nullptr; } if (m_InputLayout) { m_InputLayout->Release(); m_InputLayout = nullptr; } if (m_SamplerLinear) { m_SamplerLinear->Release(); m_SamplerLinear = nullptr; } if (m_RTV) { m_RTV->Release(); m_RTV = nullptr; } } ================================================ FILE: src/DesktopPlus/DisplayManager.h ================================================ #ifndef _DISPLAYMANAGER_H_ #define _DISPLAYMANAGER_H_ #include "CommonTypes.h" // // Handles the task of processing frames // class DISPLAYMANAGER { public: DISPLAYMANAGER(); ~DISPLAYMANAGER(); void InitD3D(DX_RESOURCES* Data); ID3D11Device* GetDevice(); DUPL_RETURN ProcessFrame(_In_ FRAME_DATA* Data, _Inout_ ID3D11Texture2D* SharedSurf, INT OffsetX, INT OffsetY, _In_ DXGI_OUTPUT_DESC* DeskDesc, _Inout_ DPRect& DirtyRectTotal); void CleanRefs(); private: // methods DUPL_RETURN CopyDirty(_In_ ID3D11Texture2D* SrcSurface, _Inout_ ID3D11Texture2D* SharedSurf, _In_reads_(DirtyCount) RECT* DirtyBuffer, UINT DirtyCount, INT OffsetX, INT OffsetY, _In_ DXGI_OUTPUT_DESC* DeskDesc, _Inout_ DPRect& DirtyRectTotal); DUPL_RETURN CopyMove(_Inout_ ID3D11Texture2D* SharedSurf, _In_reads_(MoveCount) DXGI_OUTDUPL_MOVE_RECT* MoveBuffer, UINT MoveCount, INT OffsetX, INT OffsetY, _In_ DXGI_OUTPUT_DESC* DeskDesc, INT TexWidth, INT TexHeight, _Inout_ DPRect& DirtyRectTotal); void SetDirtyVert(_Out_writes_(NUMVERTICES) VERTEX* Vertices, _In_ RECT* Dirty, INT OffsetX, INT OffsetY, _In_ DXGI_OUTPUT_DESC* DeskDesc, _In_ D3D11_TEXTURE2D_DESC* FullDesc, _In_ D3D11_TEXTURE2D_DESC* ThisDesc, _Inout_ DPRect& DirtyRectTotal); void SetMoveRect(_Out_ RECT* SrcRect, _Out_ RECT* DestRect, _In_ DXGI_OUTPUT_DESC* DeskDesc, _In_ DXGI_OUTDUPL_MOVE_RECT* MoveRect, INT TexWidth, INT TexHeight); // variables ID3D11Device* m_Device; ID3D11DeviceContext* m_DeviceContext; ID3D11Texture2D* m_MoveSurf; ID3D11VertexShader* m_VertexShader; ID3D11PixelShader* m_PixelShader; ID3D11InputLayout* m_InputLayout; ID3D11RenderTargetView* m_RTV; ID3D11SamplerState* m_SamplerLinear; BYTE* m_DirtyVertexBufferAlloc; UINT m_DirtyVertexBufferAllocSize; }; #endif ================================================ FILE: src/DesktopPlus/DuplicationManager.cpp ================================================ #include "DuplicationManager.h" #include #include //Keep building with 10.0.17763.0 / 1809 SDK optional #ifdef NTDDI_WIN10_RS5 #include #else #define DPLUS_DUP_NO_HDR #endif // // Constructor sets up references / variables // DUPLICATIONMANAGER::DUPLICATIONMANAGER() : m_DeskDupl(nullptr), m_AcquiredDesktopImage(nullptr), m_MetaDataBuffer(nullptr), m_MetaDataSize(0), m_OutputNumber(0), m_Device(nullptr) { RtlZeroMemory(&m_OutputDesc, sizeof(m_OutputDesc)); } // // Destructor simply calls CleanRefs to destroy everything // DUPLICATIONMANAGER::~DUPLICATIONMANAGER() { if (m_DeskDupl) { m_DeskDupl->Release(); m_DeskDupl = nullptr; } if (m_AcquiredDesktopImage) { m_AcquiredDesktopImage->Release(); m_AcquiredDesktopImage = nullptr; } if (m_MetaDataBuffer) { delete [] m_MetaDataBuffer; m_MetaDataBuffer = nullptr; } if (m_Device) { m_Device->Release(); m_Device = nullptr; } } // // Initialize duplication interfaces // DUPL_RETURN DUPLICATIONMANAGER::InitDupl(_In_ ID3D11Device* Device, UINT Output, bool WMRIgnoreVScreens, bool UseHDR) { m_OutputNumber = Output; #ifdef DPLUS_DUP_NO_HDR UseHDR = false; #endif // Take a reference on the device m_Device = Device; m_Device->AddRef(); //Enumerate adapters the same way the main thread does so IDs match in multi-GPU situations //Desktop Duplication of desktops spanned across multiple GPUs is not supported right now, however //DuplicateOutput() will fail if the adapter for the output doesn't match Device Microsoft::WRL::ComPtr factory_ptr; Microsoft::WRL::ComPtr adapter_ptr_output; int output_id_adapter = Output; //Output ID on the adapter actually used. Only different from initial Output if there's desktops across multiple GPUs HRESULT hr = CreateDXGIFactory1(__uuidof(IDXGIFactory1), (void**)&factory_ptr); if (!FAILED(hr)) { Microsoft::WRL::ComPtr adapter_ptr; UINT i = 0; int output_count = 0; while (factory_ptr->EnumAdapters(i, &adapter_ptr) != DXGI_ERROR_NOT_FOUND) { //Check if this a WMR virtual display adapter and skip it when the option is enabled if (WMRIgnoreVScreens) { DXGI_ADAPTER_DESC adapter_desc; adapter_ptr->GetDesc(&adapter_desc); if (wcscmp(adapter_desc.Description, L"Virtual Display Adapter") == 0) { ++i; continue; } } //Count the available outputs Microsoft::WRL::ComPtr output_ptr; UINT output_index = 0; while (adapter_ptr->EnumOutputs(output_index, &output_ptr) != DXGI_ERROR_NOT_FOUND) { //Check if this happens to be the output we're looking for if ( (adapter_ptr_output == nullptr) && (Output == output_count) ) { adapter_ptr_output = adapter_ptr; output_id_adapter = output_index; } ++output_count; ++output_index; } ++i; } } if (adapter_ptr_output == nullptr) { return ProcessFailure(m_Device, L"Failed to get the output's DXGI adapter", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } //Get output Microsoft::WRL::ComPtr DxgiOutput; hr = adapter_ptr_output->EnumOutputs(output_id_adapter, &DxgiOutput); if (FAILED(hr)) { return ProcessFailure(m_Device, L"Failed to get specified DXGI output", L"Desktop+ Error", hr, EnumOutputsExpectedErrors); } DxgiOutput->GetDesc(&m_OutputDesc); //Create desktop duplication if (!UseHDR) { Microsoft::WRL::ComPtr DxgiOutput1; hr = DxgiOutput.As(&DxgiOutput1); if (FAILED(hr)) { return ProcessFailure(nullptr, L"Failed to get output as DxgiOutput1", L"Desktop+ Error", hr); } hr = DxgiOutput1->DuplicateOutput(m_Device, &m_DeskDupl); if (FAILED(hr)) { if (hr == DXGI_ERROR_NOT_CURRENTLY_AVAILABLE) { ProcessFailure(m_Device, L"There is already the maximum number of applications using the Desktop Duplication API running, please close one of those applications and then try again", L"Desktop+ Error", hr); return DUPL_RETURN_ERROR_UNEXPECTED; } return ProcessFailure(m_Device, L"Failed to get duplicate output", L"Desktop+ Error", hr, CreateDuplicationExpectedErrors); } } else { #ifndef DPLUS_DUP_NO_HDR Microsoft::WRL::ComPtr DxgiOutput5; hr = DxgiOutput.As(&DxgiOutput5); if (FAILED(hr)) { return ProcessFailure(nullptr, L"Failed to get output as DxgiOutput5", L"Desktop+ Error", hr); } const DXGI_FORMAT supported_formats[] = {DXGI_FORMAT_R16G16B16A16_FLOAT}; hr = DxgiOutput5->DuplicateOutput1(m_Device, 0, 1, supported_formats, &m_DeskDupl); if (FAILED(hr)) { if (hr == DXGI_ERROR_NOT_CURRENTLY_AVAILABLE) { ProcessFailure(m_Device, L"There is already the maximum number of applications using the Desktop Duplication API running, please close one of those applications and then try again", L"Desktop+ Error", hr); return DUPL_RETURN_ERROR_UNEXPECTED; } return ProcessFailure(m_Device, L"Failed to get duplicate output", L"Desktop+ Error", hr, CreateDuplicationExpectedErrors); } #endif } return DUPL_RETURN_SUCCESS; } // // Retrieves mouse info and write it into PtrInfo // DUPL_RETURN DUPLICATIONMANAGER::GetMouse(_Inout_ PTR_INFO* PtrInfo, _In_ DXGI_OUTDUPL_FRAME_INFO* FrameInfo, INT OffsetX, INT OffsetY) { // A non-zero mouse update timestamp indicates that there is a mouse position update and optionally a shape change if (FrameInfo->LastMouseUpdateTime.QuadPart == 0) { return DUPL_RETURN_SUCCESS; } bool UpdatePosition = true; // Make sure we don't update pointer position wrongly // If pointer is invisible, make sure we did not get an update from another output that the last time that said pointer // was visible, if so, don't set it to invisible or update. if (!FrameInfo->PointerPosition.Visible && (PtrInfo->WhoUpdatedPositionLast != m_OutputNumber)) { UpdatePosition = false; } // If two outputs both say they have a visible, only update if new update has newer timestamp if (FrameInfo->PointerPosition.Visible && PtrInfo->Visible && (PtrInfo->WhoUpdatedPositionLast != m_OutputNumber) && (PtrInfo->LastTimeStamp.QuadPart > FrameInfo->LastMouseUpdateTime.QuadPart)) { UpdatePosition = false; } // Update position if (UpdatePosition) { PtrInfo->Position.x = FrameInfo->PointerPosition.Position.x + m_OutputDesc.DesktopCoordinates.left - OffsetX; PtrInfo->Position.y = FrameInfo->PointerPosition.Position.y + m_OutputDesc.DesktopCoordinates.top - OffsetY; PtrInfo->WhoUpdatedPositionLast = m_OutputNumber; PtrInfo->LastTimeStamp = FrameInfo->LastMouseUpdateTime; PtrInfo->Visible = FrameInfo->PointerPosition.Visible != 0; //If pointer is not visible, set the hotspot to 0,0 if (!PtrInfo->Visible) { PtrInfo->ShapeInfo.HotSpot.x = 0; PtrInfo->ShapeInfo.HotSpot.y = 0; } } // No new shape if (FrameInfo->PointerShapeBufferSize == 0) { PtrInfo->CursorShapeChanged = false; return DUPL_RETURN_SUCCESS; } PtrInfo->CursorShapeChanged = true; // Get shape PtrInfo->ShapeBuffer.resize(FrameInfo->PointerShapeBufferSize, 0); UINT BufferSizeRequired; HRESULT hr = m_DeskDupl->GetFramePointerShape(FrameInfo->PointerShapeBufferSize, PtrInfo->ShapeBuffer.data(), &BufferSizeRequired, &(PtrInfo->ShapeInfo)); if (FAILED(hr)) { PtrInfo->ShapeBuffer.clear(); return ProcessFailure(m_Device, L"Failed to get frame pointer shape", L"Desktop+ Error", hr, FrameInfoExpectedErrors); } return DUPL_RETURN_SUCCESS; } // // Get next frame and write it into Data // _Success_(*Timeout == false && return == DUPL_RETURN_SUCCESS) DUPL_RETURN DUPLICATIONMANAGER::GetFrame(_Out_ FRAME_DATA* Data, _Out_ bool* Timeout) { IDXGIResource* DesktopResource = nullptr; DXGI_OUTDUPL_FRAME_INFO FrameInfo; // Get new frame HRESULT hr = m_DeskDupl->AcquireNextFrame(100, &FrameInfo, &DesktopResource); if (hr == DXGI_ERROR_WAIT_TIMEOUT) { *Timeout = true; return DUPL_RETURN_SUCCESS; } *Timeout = false; if (FAILED(hr)) { return ProcessFailure(m_Device, L"Failed to acquire next frame", L"Desktop+ Error", hr, FrameInfoExpectedErrors); } // If still holding old frame, destroy it if (m_AcquiredDesktopImage) { m_AcquiredDesktopImage->Release(); m_AcquiredDesktopImage = nullptr; } // QI for IDXGIResource hr = DesktopResource->QueryInterface(__uuidof(ID3D11Texture2D), reinterpret_cast(&m_AcquiredDesktopImage)); DesktopResource->Release(); DesktopResource = nullptr; if (FAILED(hr)) { return ProcessFailure(nullptr, L"Failed to QI for ID3D11Texture2D from acquired IDXGIResource", L"Desktop+ Error", hr); } // Get metadata if (FrameInfo.TotalMetadataBufferSize) { // Old buffer too small if (FrameInfo.TotalMetadataBufferSize > m_MetaDataSize) { if (m_MetaDataBuffer) { delete [] m_MetaDataBuffer; m_MetaDataBuffer = nullptr; } m_MetaDataBuffer = new (std::nothrow) BYTE[FrameInfo.TotalMetadataBufferSize]; if (!m_MetaDataBuffer) { m_MetaDataSize = 0; Data->MoveCount = 0; Data->DirtyCount = 0; return ProcessFailure(nullptr, L"Failed to allocate memory for metadata", L"Desktop+ Error", E_OUTOFMEMORY); } m_MetaDataSize = FrameInfo.TotalMetadataBufferSize; } UINT BufSize = FrameInfo.TotalMetadataBufferSize; // Get move rectangles hr = m_DeskDupl->GetFrameMoveRects(BufSize, reinterpret_cast(m_MetaDataBuffer), &BufSize); if (FAILED(hr)) { Data->MoveCount = 0; Data->DirtyCount = 0; return ProcessFailure(nullptr, L"Failed to get frame move rects", L"Desktop+ Error", hr, FrameInfoExpectedErrors); } Data->MoveCount = BufSize / sizeof(DXGI_OUTDUPL_MOVE_RECT); BYTE* DirtyRects = m_MetaDataBuffer + BufSize; BufSize = FrameInfo.TotalMetadataBufferSize - BufSize; // Get dirty rectangles hr = m_DeskDupl->GetFrameDirtyRects(BufSize, reinterpret_cast(DirtyRects), &BufSize); if (FAILED(hr)) { Data->MoveCount = 0; Data->DirtyCount = 0; return ProcessFailure(nullptr, L"Failed to get frame dirty rects", L"Desktop+ Error", hr, FrameInfoExpectedErrors); } Data->DirtyCount = BufSize / sizeof(RECT); Data->MetaData = m_MetaDataBuffer; } Data->Frame = m_AcquiredDesktopImage; Data->FrameInfo = FrameInfo; return DUPL_RETURN_SUCCESS; } // // Release frame // DUPL_RETURN DUPLICATIONMANAGER::DoneWithFrame() { HRESULT hr = m_DeskDupl->ReleaseFrame(); if (FAILED(hr)) { return ProcessFailure(m_Device, L"Failed to release frame", L"Desktop+ Error", hr, FrameInfoExpectedErrors); } if (m_AcquiredDesktopImage) { m_AcquiredDesktopImage->Release(); m_AcquiredDesktopImage = nullptr; } return DUPL_RETURN_SUCCESS; } // // Gets output desc into DescPtr // void DUPLICATIONMANAGER::GetOutputDesc(_Out_ DXGI_OUTPUT_DESC* DescPtr) { *DescPtr = m_OutputDesc; } ================================================ FILE: src/DesktopPlus/DuplicationManager.h ================================================ #ifndef _DUPLICATIONMANAGER_H_ #define _DUPLICATIONMANAGER_H_ #include "CommonTypes.h" // // Handles the task of duplicating an output. // class DUPLICATIONMANAGER { public: DUPLICATIONMANAGER(); ~DUPLICATIONMANAGER(); _Success_(*Timeout == false && return == DUPL_RETURN_SUCCESS) DUPL_RETURN GetFrame(_Out_ FRAME_DATA* Data, _Out_ bool* Timeout); DUPL_RETURN DoneWithFrame(); DUPL_RETURN InitDupl(_In_ ID3D11Device* Device, UINT Output, bool WMRIgnoreVScreens, bool UseHDR); DUPL_RETURN GetMouse(_Inout_ PTR_INFO* PtrInfo, _In_ DXGI_OUTDUPL_FRAME_INFO* FrameInfo, INT OffsetX, INT OffsetY); void GetOutputDesc(_Out_ DXGI_OUTPUT_DESC* DescPtr); private: // vars IDXGIOutputDuplication* m_DeskDupl; ID3D11Texture2D* m_AcquiredDesktopImage; _Field_size_bytes_(m_MetaDataSize) BYTE* m_MetaDataBuffer; UINT m_MetaDataSize; UINT m_OutputNumber; DXGI_OUTPUT_DESC m_OutputDesc; ID3D11Device* m_Device; }; #endif ================================================ FILE: src/DesktopPlus/ElevatedMode.cpp ================================================ #include "ElevatedMode.h" #include #include "InterprocessMessaging.h" #include "InputSimulator.h" #include "WindowManager.h" #include "Util.h" #include "Logging.h" static bool g_ElevatedMode_ComInitDone = false; LRESULT CALLBACK WndProcElevated(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam); bool HandleIPCMessage(MSG msg); int ElevatedModeEnter(HINSTANCE hinstance) { DPLog_Init("DesktopPlusElevatedMode"); //Don't run if the dashboard app is not running or process isn't even elevated if (!IPCManager::Get().IsDashboardAppRunning()) { LOG_F(INFO, "Started in elevated mode, but dashboard process is not running. Exiting..."); return E_NOT_VALID_STATE; } else if (!IsProcessElevated()) { LOG_F(INFO, "Started in elevated mode, but process was not launched elevated. Exiting..."); return E_NOT_VALID_STATE; } LOG_F(INFO, "Desktop+ running in elevated mode"); //Register class WNDCLASSEXW wc; wc.cbSize = sizeof(WNDCLASSEXW); wc.style = 0; wc.lpfnWndProc = WndProcElevated; wc.cbClsExtra = 0; wc.cbWndExtra = 0; wc.hInstance = hinstance; wc.hIcon = nullptr; wc.hCursor = nullptr; wc.hbrBackground = nullptr; wc.lpszMenuName = nullptr; wc.lpszClassName = g_WindowClassNameElevatedMode; wc.hIconSm = nullptr; if (!::RegisterClassExW(&wc)) { return E_FAIL; } //Create window HWND window_handle = ::CreateWindowW(g_WindowClassNameElevatedMode, L"Desktop+ Elevated", 0, 0, 0, 1, 1, HWND_MESSAGE, nullptr, hinstance, nullptr); if (!window_handle) { return E_FAIL; } //Allow IPC messages even when elevated IPCManager::Get().DisableUIPForRegisteredMessages(window_handle); //Send config update to dashboard and UI process to set elevated mode active IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_state_misc_elevated_mode_active, true); IPCManager::Get().PostConfigMessageToUIApp(configid_bool_state_misc_elevated_mode_active, true); LOG_F(INFO, "Finished startup"); //Wait for callbacks, update or quit message MSG msg; while (::GetMessage(&msg, 0, 0, 0)) { //Custom IPC messages if (msg.message >= 0xC000) { HandleIPCMessage(msg); } } LOG_F(INFO, "Shutting down..."); //Send config update to dashboard and UI process to disable it again IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_state_misc_elevated_mode_active, false); IPCManager::Get().PostConfigMessageToUIApp(configid_bool_state_misc_elevated_mode_active, false); //Uninitialize COM if it was used if (!g_ElevatedMode_ComInitDone) { ::CoUninitialize(); g_ElevatedMode_ComInitDone = false; } WindowManager::Get().ClearTempTopMostWindow(); return 0; } LRESULT CALLBACK WndProcElevated(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam) { switch (message) { case WM_COPYDATA: { MSG msg; // Process all custom window messages posted before this while (::PeekMessage(&msg, nullptr, 0xC000, 0xFFFF, PM_REMOVE)) { HandleIPCMessage(msg); } msg.hwnd = hWnd; msg.message = message; msg.wParam = wParam; msg.lParam = lParam; HandleIPCMessage(msg); break; } case WM_DESTROY: { ::PostQuitMessage(0); break; } default: return ::DefWindowProc(hWnd, message, wParam, lParam); } return 0; } bool HandleIPCMessage(MSG msg) { static InputSimulator input_sim; static std::string action_exe_path; static std::string action_exe_arg; //Input strings come as WM_COPYDATA if (msg.message == WM_COPYDATA) { //At least check if the dashboard app is running and the wParam is its window HWND dashboard_app = ::FindWindow(g_WindowClassNameDashboardApp, nullptr); if ((dashboard_app == nullptr) || ((HWND)msg.wParam != dashboard_app)) { return false; } COPYDATASTRUCT* pcds = (COPYDATASTRUCT*)msg.lParam; //Arbitrary size limit to prevent some malicous applications from sending bad data if (pcds->cbData <= 4096) { std::string copystr((char*)pcds->lpData, pcds->cbData); //We rely on the data length. The data is sent without the NUL byte switch (pcds->dwData) { case ipcestrid_keyboard_text: case ipcestrid_keyboard_text_force_unicode: { //Pass string to InputSimulator input_sim.KeyboardText(copystr.c_str(), (pcds->dwData == ipcestrid_keyboard_text_force_unicode) ); break; } case ipcestrid_launch_application_path: { action_exe_path = copystr; action_exe_arg = ""; //Also reset arg str since it's often not needed break; } case ipcestrid_launch_application_arg: { action_exe_arg = copystr; break; } } } } else { IPCMsgID msgid = IPCManager::Get().GetIPCMessageID(msg.message); if (msgid == ipcmsg_elevated_action) { switch (msg.wParam) { case ipceact_refresh: { input_sim.RefreshScreenOffsets(); break; } case ipceact_mouse_move: { input_sim.MouseMove(GET_X_LPARAM(msg.lParam), GET_Y_LPARAM(msg.lParam)); break; }; case ipceact_mouse_hwheel: { input_sim.MouseWheelHorizontal(pun_cast(msg.lParam)); break; }; case ipceact_mouse_vwheel: { input_sim.MouseWheelVertical(pun_cast(msg.lParam)); break; }; case ipceact_pen_move: { input_sim.PenMove(GET_X_LPARAM(msg.lParam), GET_Y_LPARAM(msg.lParam)); break; }; case ipceact_pen_button_down: { (msg.lParam == 0) ? input_sim.PenSetPrimaryDown(true) : input_sim.PenSetSecondaryDown(true); break; }; case ipceact_pen_button_up: { (msg.lParam == 0) ? input_sim.PenSetPrimaryDown(false) : input_sim.PenSetSecondaryDown(false); break; }; case ipceact_pen_leave: { input_sim.PenLeave(); break; }; case ipceact_key_down: { //Copy 3 keycodes from lparam unsigned char keycodes[3]; memcpy(keycodes, &msg.lParam, 3); input_sim.KeyboardSetDown(keycodes); break; }; case ipceact_key_up: { //Copy 3 keycodes from lparam unsigned char keycodes[3]; memcpy(keycodes, &msg.lParam, 3); input_sim.KeyboardSetUp(keycodes); break; }; case ipceact_key_toggle: { //Copy 3 keycodes from lparam unsigned char keycodes[3]; memcpy(keycodes, &msg.lParam, 3); input_sim.KeyboardToggleState(keycodes); break; }; case ipceact_key_press_and_release: { input_sim.KeyboardPressAndRelease(msg.lParam); break; }; case ipceact_key_togglekey_set: { input_sim.KeyboardSetToggleKey(LOWORD(msg.lParam), HIWORD(msg.lParam)); break; } case ipceact_keystate_w32_set: { input_sim.KeyboardSetFromWin32KeyState(LOWORD(msg.lParam), HIWORD(msg.lParam)); break; } case ipceact_keystate_set: { input_sim.KeyboardSetKeyState((IPCKeyboardKeystateFlags)LOWORD(msg.lParam), HIWORD(msg.lParam)); break; } case ipceact_keyboard_text_finish: { input_sim.KeyboardTextFinish(); break; } case ipceact_launch_application: { //Init COM if necessary if (!g_ElevatedMode_ComInitDone) { if (::CoInitializeEx(nullptr, COINIT_APARTMENTTHREADED | COINIT_DISABLE_OLE1DDE) != RPC_E_CHANGED_MODE) { g_ElevatedMode_ComInitDone = true; } } //Convert path and arg to utf16 std::wstring path_wstr = WStringConvertFromUTF8(action_exe_path.c_str()); std::wstring arg_wstr = WStringConvertFromUTF8(action_exe_arg.c_str()); if (!path_wstr.empty()) { ::ShellExecute(nullptr, nullptr, path_wstr.c_str(), arg_wstr.c_str(), nullptr, SW_SHOWNORMAL); } break; } case ipceact_window_topmost_set: { HWND window = (HWND)msg.lParam; (window != nullptr) ? WindowManager::Get().SetTempTopMostWindow(window) : WindowManager::Get().ClearTempTopMostWindow(); break; } } } } return true; } ================================================ FILE: src/DesktopPlus/ElevatedMode.h ================================================ #pragma once #define NOMINMAX #include //This runs the process in elevated input command mode, in which it only takes select window messages and passes them to InputSimulator. // //This isn't secure at all, I'm well aware. //There are certainly other more complex ways of implementation to make this seem more secure than the current one, but as far as I'm concerned we're fighting a battle that cannot be won. //As long as we're open source, not enforcing signed binaries and access rights to the application directory, there will always be an attack vector. //There's no way to actually trust the unelevated process requesting the inputs. Even if we isolated DesktopPlus.exe, we still couldn't trust SteamVR to not be compromised. //Both of these live in an environment where they are expected to be updated automatically by an unelevated process as well. // //The attack vector is at least smaller than when running Steam and everything related elevated as well. //Targeted attacks would be fairly easy if such code found the way of an user's machine, though. int ElevatedModeEnter(HINSTANCE hinstance); ================================================ FILE: src/DesktopPlus/InputSimulator.cpp ================================================ #include "InputSimulator.h" #include "InterprocessMessaging.h" #include "OutputManager.h" #include "Util.h" enum KeyboardWin32KeystateFlags { kbd_w32keystate_flag_shift_down = 1 << 0, kbd_w32keystate_flag_ctrl_down = 1 << 1, kbd_w32keystate_flag_alt_down = 1 << 2 }; fn_CreateSyntheticPointerDevice InputSimulator::s_p_CreateSyntheticPointerDevice = nullptr; fn_InjectSyntheticPointerInput InputSimulator::s_p_InjectSyntheticPointerInput = nullptr; fn_DestroySyntheticPointerDevice InputSimulator::s_p_DestroySyntheticPointerDevice = nullptr; InputSimulator::InputSimulator() { RefreshScreenOffsets(); //Try to init pen functions if they're not loaded yet if (!IsPenSimulationSupported()) { LoadPenFunctions(); } //Init pen state (rest can stay at default 0) m_PenState.type = PT_PEN; m_PenState.penInfo.pointerInfo.pointerType = PT_PEN; m_PenState.penInfo.pressure = 1024; //Full pressure m_PenState.penInfo.penMask = PEN_MASK_PRESSURE; //Marked as optional, but without, applications expecting it may read 0 pressure still } InputSimulator::~InputSimulator() { if (m_PenDevice != nullptr) { s_p_DestroySyntheticPointerDevice(m_PenDevice); } } void InputSimulator::SetEventForMouseKeyCode(INPUT& input_event, unsigned char keycode, bool down) { input_event.type = INPUT_MOUSE; if (down) { switch (keycode) { case VK_LBUTTON: input_event.mi.dwFlags = MOUSEEVENTF_LEFTDOWN; break; case VK_RBUTTON: input_event.mi.dwFlags = MOUSEEVENTF_RIGHTDOWN; break; case VK_MBUTTON: input_event.mi.dwFlags = MOUSEEVENTF_MIDDLEDOWN; break; case VK_XBUTTON1: input_event.mi.dwFlags = MOUSEEVENTF_XDOWN; input_event.mi.mouseData = XBUTTON1; break; case VK_XBUTTON2: input_event.mi.dwFlags = MOUSEEVENTF_XDOWN; input_event.mi.mouseData = XBUTTON2; break; default: break; } } else { switch (keycode) { case VK_LBUTTON: input_event.mi.dwFlags = MOUSEEVENTF_LEFTUP; break; case VK_RBUTTON: input_event.mi.dwFlags = MOUSEEVENTF_RIGHTUP; break; case VK_MBUTTON: input_event.mi.dwFlags = MOUSEEVENTF_MIDDLEUP; break; case VK_XBUTTON1: input_event.mi.dwFlags = MOUSEEVENTF_XUP; input_event.mi.mouseData = XBUTTON1; break; case VK_XBUTTON2: input_event.mi.dwFlags = MOUSEEVENTF_XUP; input_event.mi.mouseData = XBUTTON2; break; default: break; } } } bool InputSimulator::SetEventForKeyCode(INPUT& input_event, unsigned char keycode, bool down, bool skip_check) { //Check if the mouse buttons are swapped as this also affects SendInput if ( ((keycode == VK_LBUTTON) || (keycode == VK_RBUTTON)) && (::GetSystemMetrics(SM_SWAPBUTTON) != 0) ) { keycode = (keycode == VK_LBUTTON) ? VK_RBUTTON : VK_LBUTTON; } bool key_down = (::GetAsyncKeyState(keycode) < 0); if ( (keycode == 0) || ((key_down == down) && (!skip_check)) ) return false; if ((keycode <= 6) && (keycode != VK_CANCEL)) //Mouse buttons need to be handled differently { SetEventForMouseKeyCode(input_event, keycode, down); } else { input_event.type = INPUT_KEYBOARD; //Use scancodes if possible to increase compatibility (e.g. DirectInput games need scancodes) UINT scancode = ::MapVirtualKey(keycode, MAPVK_VK_TO_VSC_EX); //Pause/PrintScreen have a scancode too long for SendInput. May be possible to get to work with multiple input calls, but let's not bother for now if ( (scancode != 0) || (keycode == VK_PAUSE) || (keycode == VK_SNAPSHOT) ) { BYTE highbyte = HIBYTE(scancode); bool is_extended = ((highbyte == 0xe0) || (highbyte == 0xe1)); //Not extended but needs to be for proper input simulation if (!is_extended) { switch (keycode) { case VK_INSERT: case VK_DELETE: case VK_PRIOR: case VK_NEXT: case VK_END: case VK_HOME: case VK_LEFT: case VK_UP: case VK_RIGHT: case VK_DOWN: { is_extended = true; } default: break; } } input_event.ki.dwFlags = (is_extended) ? KEYEVENTF_SCANCODE | KEYEVENTF_EXTENDEDKEY : KEYEVENTF_SCANCODE; input_event.ki.wScan = scancode; } else //No scancode, use keycode { input_event.ki.dwFlags = 0; input_event.ki.wVk = keycode; } if (!down) { input_event.ki.dwFlags |= KEYEVENTF_KEYUP; } } return true; } void InputSimulator::LoadPenFunctions() { HMODULE h_user32 = ::LoadLibraryW(L"user32.dll"); if (h_user32 != nullptr) { s_p_CreateSyntheticPointerDevice = (fn_CreateSyntheticPointerDevice) GetProcAddress(h_user32, "CreateSyntheticPointerDevice"); s_p_InjectSyntheticPointerInput = (fn_InjectSyntheticPointerInput) GetProcAddress(h_user32, "InjectSyntheticPointerInput"); s_p_DestroySyntheticPointerDevice = (fn_DestroySyntheticPointerDevice)GetProcAddress(h_user32, "DestroySyntheticPointerDevice"); } } void InputSimulator::CreatePenDeviceIfNeeded() { if (m_PenDevice == nullptr) { m_PenDevice = s_p_CreateSyntheticPointerDevice(PT_PEN, 1, POINTER_FEEDBACK_INDIRECT); } } void InputSimulator::RefreshScreenOffsets() { if (m_ForwardToElevatedModeProcess) { IPCManager::Get().PostMessageToElevatedModeProcess(ipcmsg_elevated_action, ipceact_refresh); } m_SpaceMaxX = GetSystemMetrics(SM_CXVIRTUALSCREEN); m_SpaceMaxY = GetSystemMetrics(SM_CYVIRTUALSCREEN); m_SpaceMultiplierX = 65536.0f / m_SpaceMaxX; m_SpaceMultiplierY = 65536.0f / m_SpaceMaxY; m_SpaceOffsetX = GetSystemMetrics(SM_XVIRTUALSCREEN) * -1; m_SpaceOffsetY = GetSystemMetrics(SM_YVIRTUALSCREEN) * -1; } void InputSimulator::MouseMove(int x, int y) { if (m_ForwardToElevatedModeProcess) { IPCManager::Get().PostMessageToElevatedModeProcess(ipcmsg_elevated_action, ipceact_mouse_move, MAKELPARAM(x, y)); return; } INPUT input_event = { 0 }; input_event.type = INPUT_MOUSE; input_event.mi.dx = LONG((x + m_SpaceOffsetX) * m_SpaceMultiplierX); input_event.mi.dy = LONG((y + m_SpaceOffsetY) * m_SpaceMultiplierY); input_event.mi.dwFlags = MOUSEEVENTF_MOVE | MOUSEEVENTF_VIRTUALDESK | MOUSEEVENTF_ABSOLUTE; ::SendInput(1, &input_event, sizeof(INPUT)); } void InputSimulator::MouseSetLeftDown(bool down) { (down) ? KeyboardSetDown(VK_LBUTTON) : KeyboardSetUp(VK_LBUTTON); } void InputSimulator::MouseSetRightDown(bool down) { (down) ? KeyboardSetDown(VK_RBUTTON) : KeyboardSetUp(VK_RBUTTON); } void InputSimulator::MouseSetMiddleDown(bool down) { (down) ? KeyboardSetDown(VK_MBUTTON) : KeyboardSetUp(VK_MBUTTON); } void InputSimulator::MouseWheelHorizontal(float delta) { if (m_ForwardToElevatedModeProcess) { IPCManager::Get().PostMessageToElevatedModeProcess(ipcmsg_elevated_action, ipceact_mouse_hwheel, pun_cast(delta)); return; } INPUT input_event = {0}; input_event.type = INPUT_MOUSE; input_event.mi.dwFlags = MOUSEEVENTF_HWHEEL; input_event.mi.mouseData = DWORD(WHEEL_DELTA * delta); ::SendInput(1, &input_event, sizeof(INPUT)); } void InputSimulator::MouseWheelVertical(float delta) { if (m_ForwardToElevatedModeProcess) { IPCManager::Get().PostMessageToElevatedModeProcess(ipcmsg_elevated_action, ipceact_mouse_vwheel, pun_cast(delta)); return; } INPUT input_event = {0}; input_event.type = INPUT_MOUSE; input_event.mi.dwFlags = MOUSEEVENTF_WHEEL; input_event.mi.mouseData = DWORD(WHEEL_DELTA * delta); ::SendInput(1, &input_event, sizeof(INPUT)); } void InputSimulator::PenMove(int x, int y) { if (!IsPenSimulationSupported()) return; if (m_ForwardToElevatedModeProcess) { IPCManager::Get().PostMessageToElevatedModeProcess(ipcmsg_elevated_action, ipceact_pen_move, MAKELPARAM(x, y)); return; } CreatePenDeviceIfNeeded(); m_PenState.penInfo.pointerInfo.pointerFlags |= POINTER_FLAG_INRANGE | POINTER_FLAG_UPDATE; //Pen input position doesn't appear to be clamped by OS like mouse input and can do weird things if it goes out of range m_PenState.penInfo.pointerInfo.ptPixelLocation.x = clamp(x + m_SpaceOffsetX, 0, m_SpaceMaxX); m_PenState.penInfo.pointerInfo.ptPixelLocation.y = clamp(y + m_SpaceOffsetY, 0, m_SpaceMaxY); s_p_InjectSyntheticPointerInput(m_PenDevice, &m_PenState, 1); } void InputSimulator::PenSetPrimaryDown(bool down) { if (!IsPenSimulationSupported()) return; if (m_ForwardToElevatedModeProcess) { IPCManager::Get().PostMessageToElevatedModeProcess(ipcmsg_elevated_action, (down) ? ipceact_pen_button_down : ipceact_pen_button_up, 0); return; } CreatePenDeviceIfNeeded(); if (down) { m_PenState.penInfo.pointerInfo.pointerFlags |= POINTER_FLAG_INCONTACT | POINTER_FLAG_DOWN | POINTER_FLAG_FIRSTBUTTON; m_PenState.penInfo.pointerInfo.ButtonChangeType = POINTER_CHANGE_FIRSTBUTTON_DOWN; } else { m_PenState.penInfo.pointerInfo.pointerFlags &= ~(POINTER_FLAG_INCONTACT | POINTER_FLAG_DOWN | POINTER_FLAG_FIRSTBUTTON); m_PenState.penInfo.pointerInfo.pointerFlags |= POINTER_FLAG_UP; m_PenState.penInfo.pointerInfo.ButtonChangeType = POINTER_CHANGE_FIRSTBUTTON_UP; } m_PenState.penInfo.pointerInfo.pointerFlags &= ~POINTER_FLAG_UPDATE; s_p_InjectSyntheticPointerInput(m_PenDevice, &m_PenState, 1); m_PenState.penInfo.pointerInfo.pointerFlags &= ~(POINTER_FLAG_DOWN | POINTER_FLAG_UP); m_PenState.penInfo.pointerInfo.ButtonChangeType = POINTER_CHANGE_NONE; } void InputSimulator::PenSetSecondaryDown(bool down) { if (!IsPenSimulationSupported()) return; if (m_ForwardToElevatedModeProcess) { IPCManager::Get().PostMessageToElevatedModeProcess(ipcmsg_elevated_action, (down) ? ipceact_pen_button_down : ipceact_pen_button_up, 1); return; } CreatePenDeviceIfNeeded(); if (down) { m_PenState.penInfo.pointerInfo.pointerFlags |= POINTER_FLAG_INCONTACT | POINTER_FLAG_DOWN | POINTER_FLAG_SECONDBUTTON; m_PenState.penInfo.pointerInfo.ButtonChangeType = POINTER_CHANGE_SECONDBUTTON_DOWN; m_PenState.penInfo.penFlags = PEN_FLAG_BARREL; } else { m_PenState.penInfo.pointerInfo.pointerFlags &= ~(POINTER_FLAG_INCONTACT | POINTER_FLAG_DOWN | POINTER_FLAG_SECONDBUTTON); m_PenState.penInfo.pointerInfo.pointerFlags |= POINTER_FLAG_UP; m_PenState.penInfo.pointerInfo.ButtonChangeType = POINTER_CHANGE_SECONDBUTTON_UP; m_PenState.penInfo.penFlags = 0; } m_PenState.penInfo.pointerInfo.pointerFlags &= ~POINTER_FLAG_UPDATE; s_p_InjectSyntheticPointerInput(m_PenDevice, &m_PenState, 1); m_PenState.penInfo.pointerInfo.pointerFlags &= ~(POINTER_FLAG_DOWN | POINTER_FLAG_UP); m_PenState.penInfo.pointerInfo.ButtonChangeType = POINTER_CHANGE_NONE; } void InputSimulator::PenLeave() { if (!IsPenSimulationSupported()) return; if (m_ForwardToElevatedModeProcess) { IPCManager::Get().PostMessageToElevatedModeProcess(ipcmsg_elevated_action, ipceact_pen_leave); return; } CreatePenDeviceIfNeeded(); if (m_PenState.penInfo.pointerInfo.pointerFlags & POINTER_FLAG_INRANGE) { m_PenState.penInfo.pointerInfo.pointerFlags = POINTER_FLAG_UPDATE; m_PenState.penInfo.pointerInfo.ButtonChangeType = POINTER_CHANGE_NONE; m_PenState.penInfo.penFlags = 0; s_p_InjectSyntheticPointerInput(m_PenDevice, &m_PenState, 1); } } void InputSimulator::KeyboardSetDown(unsigned char keycode) { if (keycode == 0) return; if (m_ForwardToElevatedModeProcess) { LPARAM elevated_keycodes = 0; memcpy(&elevated_keycodes, &keycode, 1); IPCManager::Get().PostMessageToElevatedModeProcess(ipcmsg_elevated_action, ipceact_key_down, elevated_keycodes); return; } INPUT input_event = {0}; if (SetEventForKeyCode(input_event, keycode, true)) { ::SendInput(1, &input_event, sizeof(INPUT)); } } void InputSimulator::KeyboardSetDown(unsigned char keycode, bool down) { (down) ? KeyboardSetDown(keycode) : KeyboardSetUp(keycode); } void InputSimulator::KeyboardSetUp(unsigned char keycode) { if (keycode == 0) return; if (m_ForwardToElevatedModeProcess) { LPARAM elevated_keycodes = 0; memcpy(&elevated_keycodes, &keycode, 1); IPCManager::Get().PostMessageToElevatedModeProcess(ipcmsg_elevated_action, ipceact_key_up, elevated_keycodes); return; } INPUT input_event = {0}; if (SetEventForKeyCode(input_event, keycode, false)) { ::SendInput(1, &input_event, sizeof(INPUT)); } } //Why so awfully specific, seems wasteful? Spamming the key events separately can confuse applications sometimes and we want to make sure the keys are really pressed at once void InputSimulator::KeyboardSetDown(unsigned char keycodes[3]) { if (m_ForwardToElevatedModeProcess) { LPARAM elevated_keycodes = 0; memcpy(&elevated_keycodes, keycodes, 3); IPCManager::Get().PostMessageToElevatedModeProcess(ipcmsg_elevated_action, ipceact_key_down, elevated_keycodes); return; } INPUT input_event[3] = { 0 }; int used_event_count = 0; for (int i = 0; i < 3; ++i) { used_event_count += SetEventForKeyCode(input_event[used_event_count], keycodes[i], true); } if (used_event_count != 0) { ::SendInput(used_event_count, input_event, sizeof(INPUT)); } } void InputSimulator::KeyboardSetUp(unsigned char keycodes[3]) { if (m_ForwardToElevatedModeProcess) { LPARAM elevated_keycodes = 0; memcpy(&elevated_keycodes, keycodes, 3); IPCManager::Get().PostMessageToElevatedModeProcess(ipcmsg_elevated_action, ipceact_key_up, elevated_keycodes); return; } INPUT input_event[3] = { 0 }; int used_event_count = 0; for (int i = 0; i < 3; ++i) { used_event_count += SetEventForKeyCode(input_event[used_event_count], keycodes[i], false); } if (used_event_count != 0) { ::SendInput(used_event_count, input_event, sizeof(INPUT)); } } void InputSimulator::KeyboardToggleState(unsigned char keycode) { if (keycode == 0) return; //GetAsyncKeyState is subject to UIPI, so always forward it if (m_ForwardToElevatedModeProcess) { LPARAM elevated_keycodes = 0; memcpy(&elevated_keycodes, &keycode, 1); IPCManager::Get().PostMessageToElevatedModeProcess(ipcmsg_elevated_action, ipceact_key_toggle, elevated_keycodes); return; } if (IsKeyDown(keycode)) //If already pressed, release key { KeyboardSetUp(keycode); } else { KeyboardSetDown(keycode); } } void InputSimulator::KeyboardToggleState(unsigned char keycodes[3]) { if (m_ForwardToElevatedModeProcess) { LPARAM elevated_keycodes = 0; memcpy(&elevated_keycodes, keycodes, 3); IPCManager::Get().PostMessageToElevatedModeProcess(ipcmsg_elevated_action, ipceact_key_toggle, elevated_keycodes); return; } INPUT input_event[3] = {0}; int used_event_count = 0; for (int i = 0; i < 3; ++i) { used_event_count += SetEventForKeyCode(input_event[used_event_count], keycodes[i], !IsKeyDown(keycodes[i])); } if (used_event_count != 0) { ::SendInput(used_event_count, input_event, sizeof(INPUT)); } } void InputSimulator::KeyboardPressAndRelease(unsigned char keycode) { if (keycode == 0) return; if (m_ForwardToElevatedModeProcess) { IPCManager::Get().PostMessageToElevatedModeProcess(ipcmsg_elevated_action, ipceact_key_press_and_release, keycode); return; } INPUT input_event[2] = {0}; int used_event_count = 0; used_event_count += SetEventForKeyCode(input_event[used_event_count], keycode, true); used_event_count += SetEventForKeyCode(input_event[used_event_count], keycode, false); ::SendInput(used_event_count, input_event, sizeof(INPUT)); } void InputSimulator::KeyboardSetToggleKey(unsigned char keycode, bool toggled) { if (keycode == 0) return; if (m_ForwardToElevatedModeProcess) { IPCManager::Get().PostMessageToElevatedModeProcess(ipcmsg_elevated_action, ipceact_key_togglekey_set, MAKELPARAM(keycode, toggled)); return; } bool is_toggled = ((::GetKeyState(keycode) & 0x0001) != 0); if (toggled == is_toggled) return; INPUT input_event[3] = {0}; int used_event_count = 0; used_event_count += SetEventForKeyCode(input_event[used_event_count], keycode, false); //Release if it happens to be down used_event_count += SetEventForKeyCode(input_event[used_event_count], keycode, true, true); //Press... used_event_count += SetEventForKeyCode(input_event[used_event_count], keycode, false, true); //...and release, even if the state wouldn't change (last arg) ::SendInput(used_event_count, input_event, sizeof(INPUT)); } void InputSimulator::KeyboardSetFromWin32KeyState(unsigned short keystate, bool down) { unsigned char keycode = LOBYTE(keystate); bool key_down = IsKeyDown(keycode); if (key_down == down) return; //Nothing to be done if (m_ForwardToElevatedModeProcess) { IPCManager::Get().PostMessageToElevatedModeProcess(ipcmsg_elevated_action, ipceact_keystate_w32_set, MAKELPARAM(keystate, down)); return; } unsigned char flags = HIBYTE(keystate); bool flag_shift = (flags & kbd_w32keystate_flag_shift_down); bool flag_ctrl = (flags & kbd_w32keystate_flag_ctrl_down); bool flag_alt = (flags & kbd_w32keystate_flag_alt_down); bool caps_toggled = ((::GetKeyState(VK_CAPITAL) & 0x0001) != 0); INPUT input_event[16] = { 0 }; int used_event_count = 0; //Add events for modifier keys if needed if (!flag_shift) { //Try releasing both if any is down if (IsKeyDown(VK_SHIFT)) { used_event_count += SetEventForKeyCode(input_event[used_event_count], VK_LSHIFT, false); used_event_count += SetEventForKeyCode(input_event[used_event_count], VK_RSHIFT, false); } } else if (!IsKeyDown(VK_SHIFT)) //Only set the left key if none are down { used_event_count += SetEventForKeyCode(input_event[used_event_count], VK_LSHIFT, true); } if (!flag_ctrl) { if (IsKeyDown(VK_CONTROL)) { used_event_count += SetEventForKeyCode(input_event[used_event_count], VK_LCONTROL, false); used_event_count += SetEventForKeyCode(input_event[used_event_count], VK_RCONTROL, false); } } else if (!IsKeyDown(VK_CONTROL)) { used_event_count += SetEventForKeyCode(input_event[used_event_count], VK_LCONTROL, true); } if (!flag_alt) { if (IsKeyDown(VK_MENU)) { used_event_count += SetEventForKeyCode(input_event[used_event_count], VK_LMENU, false); used_event_count += SetEventForKeyCode(input_event[used_event_count], VK_RMENU, false); } } else if (!IsKeyDown(VK_MENU)) { used_event_count += SetEventForKeyCode(input_event[used_event_count], VK_LMENU, true); } //Add events to handle caps lock state if (caps_toggled) { used_event_count += SetEventForKeyCode(input_event[used_event_count], VK_CAPITAL, false); //Release if it happens to be down used_event_count += SetEventForKeyCode(input_event[used_event_count], VK_CAPITAL, true, true); //Press... used_event_count += SetEventForKeyCode(input_event[used_event_count], VK_CAPITAL, false, true); //...and release, even if the state wouldn't change (last arg) } //Add event for actual keycode used_event_count += SetEventForKeyCode(input_event[used_event_count], keycode, down); if (used_event_count != 0) { ::SendInput(used_event_count, input_event, sizeof(INPUT)); } } void InputSimulator::KeyboardSetKeyState(IPCKeyboardKeystateFlags flags, unsigned char keycode) { if (m_ForwardToElevatedModeProcess) { IPCManager::Get().PostMessageToElevatedModeProcess(ipcmsg_elevated_action, ipceact_keystate_set, MAKELPARAM(flags, keycode)); return; } //Numpad input simulation is a bit weird //It seems like numpad (especially shift+numpad) is something that is taken care of in a lower layer and as such confuses Windows if we just send our straight inputs //Basically it either doesn't produce an input with numlock off or shift can get stuck in a way that requires both shift keys to be released //So we just end up handling this manually below if (((keycode >= VK_NUMPAD0) && (keycode <= VK_NUMPAD9)) || (keycode == VK_DECIMAL)) { const bool is_numlock_on = ((::GetKeyState(VK_NUMLOCK) & 0x0001) != 0); const bool is_shift_down = ((flags & kbd_keystate_flag_lshift_down) || (flags & kbd_keystate_flag_rshift_down)); const bool is_double_shift_down = ((flags & kbd_keystate_flag_lshift_down) && (flags & kbd_keystate_flag_rshift_down)); if ((!is_numlock_on) || (is_shift_down)) { //Swap numpad keycodes with regular ones //One might think these should be sent as unextended scancodes down the line, but doing so makes them be treated as numpad inputs again with all the issues we're trying to avoid here switch (keycode) { case VK_NUMPAD0: keycode = VK_INSERT; break; case VK_NUMPAD1: keycode = VK_END; break; case VK_NUMPAD2: keycode = VK_DOWN; break; case VK_NUMPAD3: keycode = VK_NEXT; break; case VK_NUMPAD4: keycode = VK_LEFT; break; case VK_NUMPAD5: keycode = VK_CLEAR; break; case VK_NUMPAD6: keycode = VK_RIGHT; break; case VK_NUMPAD7: keycode = VK_HOME; break; case VK_NUMPAD8: keycode = VK_UP; break; case VK_NUMPAD9: keycode = VK_PRIOR; break; case VK_DECIMAL: keycode = VK_DELETE; break; } //Shift needs to be up to get normal cursor movement (unless both shifts are down) if ((is_numlock_on) && (is_shift_down) && (!is_double_shift_down)) { flags = IPCKeyboardKeystateFlags(flags & ~(kbd_keystate_flag_lshift_down | kbd_keystate_flag_rshift_down)); } } } INPUT input_event[10] = {0}; int used_event_count = 0; //Add events for modifier keys if needed used_event_count += SetEventForKeyCode(input_event[used_event_count], VK_LSHIFT, (flags & kbd_keystate_flag_lshift_down)); used_event_count += SetEventForKeyCode(input_event[used_event_count], VK_RSHIFT, (flags & kbd_keystate_flag_rshift_down)); used_event_count += SetEventForKeyCode(input_event[used_event_count], VK_LCONTROL, (flags & kbd_keystate_flag_lctrl_down)); used_event_count += SetEventForKeyCode(input_event[used_event_count], VK_RCONTROL, (flags & kbd_keystate_flag_rctrl_down)); used_event_count += SetEventForKeyCode(input_event[used_event_count], VK_LMENU, (flags & kbd_keystate_flag_lalt_down)); used_event_count += SetEventForKeyCode(input_event[used_event_count], VK_RMENU, (flags & kbd_keystate_flag_ralt_down)); //Add events to handle caps lock state bool caps_toggled = ((::GetKeyState(VK_CAPITAL) & 0x0001) != 0); if (caps_toggled != bool(flags & kbd_keystate_flag_capslock_toggled)) { used_event_count += SetEventForKeyCode(input_event[used_event_count], VK_CAPITAL, false); //Release if it happens to be down used_event_count += SetEventForKeyCode(input_event[used_event_count], VK_CAPITAL, true, true); //Press... used_event_count += SetEventForKeyCode(input_event[used_event_count], VK_CAPITAL, false, true); //...and release, even if the state wouldn't change (last arg) } //Add event for actual keycode, but skip keys handled by the keystate flags switch (keycode) { case VK_SHIFT: case VK_LSHIFT: case VK_RSHIFT: case VK_CONTROL: case VK_LCONTROL: case VK_RCONTROL: case VK_MENU: case VK_LMENU: case VK_RMENU: case VK_CAPITAL: { break; } default: { used_event_count += SetEventForKeyCode(input_event[used_event_count], keycode, (flags & kbd_keystate_flag_key_down)); } } if (used_event_count != 0) { ::SendInput(used_event_count, input_event, sizeof(INPUT)); } } void InputSimulator::KeyboardText(const char* str_utf8, bool always_use_unicode_event) { if (m_ForwardToElevatedModeProcess) { OutputManager* outmgr = OutputManager::Get(); if (outmgr != nullptr) { IPCElevatedStringID str_id = (always_use_unicode_event) ? ipcestrid_keyboard_text_force_unicode : ipcestrid_keyboard_text; IPCManager::Get().SendStringToElevatedModeProcess(str_id, str_utf8, outmgr->GetWindowHandle()); m_ElevatedModeHasTextQueued = true; } return; } //Convert to UTF16 std::wstring wstr = WStringConvertFromUTF8(str_utf8); INPUT input_event = { 0 }; input_event.type = INPUT_KEYBOARD; if (!always_use_unicode_event) { //This function could just use KEYEVENTF_UNICODE on all printable characters to get working text input (we still do that for type string actions though) //However, in order to trigger shortcuts and non-text events in applications, at least 0-9 & A-Z are simulated as proper key events //For consistent handling, capslock and shift are reset at the start, but that shouldn't be an issue in practice if ((::GetKeyState(VK_CAPITAL) & 0x0001) != 0) //Turn off capslock if it's on { input_event.ki.dwFlags = 0; input_event.ki.wVk = VK_CAPITAL; m_KeyboardTextQueue.push_back(input_event); input_event.ki.dwFlags = KEYEVENTF_KEYUP; m_KeyboardTextQueue.push_back(input_event); } if (::GetAsyncKeyState(VK_SHIFT) < 0) //Release shift if it's down { input_event.ki.dwFlags = KEYEVENTF_KEYUP; input_event.ki.wVk = VK_SHIFT; m_KeyboardTextQueue.push_back(input_event); } for (wchar_t current_char: wstr) { if (current_char == '\b') //Backspace, needs special handling { input_event.ki.dwFlags = 0; input_event.ki.wVk = VK_BACK; m_KeyboardTextQueue.push_back(input_event); input_event.ki.dwFlags = KEYEVENTF_KEYUP; m_KeyboardTextQueue.push_back(input_event); } else if (current_char == '\n') //Enter, needs special handling { input_event.ki.dwFlags = 0; input_event.ki.wVk = VK_RETURN; m_KeyboardTextQueue.push_back(input_event); input_event.ki.dwFlags = KEYEVENTF_KEYUP; m_KeyboardTextQueue.push_back(input_event); } else if ( ((current_char >= '0') && (current_char <= '9')) || (current_char == ' ') ) //0 - 9 and space, simulate keydown/up { input_event.ki.dwFlags = 0; input_event.ki.wVk = current_char; m_KeyboardTextQueue.push_back(input_event); input_event.ki.dwFlags = KEYEVENTF_KEYUP; m_KeyboardTextQueue.push_back(input_event); } else if ((current_char >= 'a') && (current_char <= 'z')) //a - z, simulate keydown/up { input_event.ki.dwFlags = 0; input_event.ki.wVk = current_char - ('a' - 'A'); m_KeyboardTextQueue.push_back(input_event); input_event.ki.dwFlags = KEYEVENTF_KEYUP; m_KeyboardTextQueue.push_back(input_event); } else if ((current_char >= 'A') && (current_char <= 'Z')) //A - Z, simulate keydown/up { input_event.ki.dwFlags = 0; input_event.ki.wVk = VK_SHIFT; m_KeyboardTextQueue.push_back(input_event); input_event.ki.dwFlags = 0; input_event.ki.wVk = current_char; m_KeyboardTextQueue.push_back(input_event); input_event.ki.dwFlags = KEYEVENTF_KEYUP; m_KeyboardTextQueue.push_back(input_event); input_event.ki.wVk = VK_SHIFT; m_KeyboardTextQueue.push_back(input_event); } else { input_event.ki.dwFlags = KEYEVENTF_UNICODE; input_event.ki.wVk = 0; input_event.ki.wScan = current_char; m_KeyboardTextQueue.push_back(input_event); input_event.ki.dwFlags = KEYEVENTF_UNICODE | KEYEVENTF_KEYUP; m_KeyboardTextQueue.push_back(input_event); } } } else { for (wchar_t current_char: wstr) { input_event.ki.dwFlags = KEYEVENTF_UNICODE; input_event.ki.wScan = current_char; m_KeyboardTextQueue.push_back(input_event); input_event.ki.dwFlags = KEYEVENTF_UNICODE | KEYEVENTF_KEYUP; m_KeyboardTextQueue.push_back(input_event); } } } void InputSimulator::KeyboardTextFinish() { if (m_ForwardToElevatedModeProcess) { //Only send if we know there is queued text in that process if (m_ElevatedModeHasTextQueued) { IPCManager::Get().PostMessageToElevatedModeProcess(ipcmsg_elevated_action, ipceact_keyboard_text_finish); m_ElevatedModeHasTextQueued = false; } return; } if (!m_KeyboardTextQueue.empty()) { ::SendInput((UINT)m_KeyboardTextQueue.size(), m_KeyboardTextQueue.data(), sizeof(INPUT)); m_KeyboardTextQueue.clear(); } } void InputSimulator::SetElevatedModeForwardingActive(bool do_forward) { m_ForwardToElevatedModeProcess = do_forward; } bool InputSimulator::IsKeyDown(unsigned char keycode) { //Check if the mouse buttons are swapped if ( ((keycode == VK_LBUTTON) || (keycode == VK_RBUTTON)) && (::GetSystemMetrics(SM_SWAPBUTTON) != 0) ) { keycode = (keycode == VK_LBUTTON) ? VK_RBUTTON : VK_LBUTTON; } return (::GetAsyncKeyState(keycode) < 0); } bool InputSimulator::IsPenSimulationSupported() { return (s_p_CreateSyntheticPointerDevice != nullptr); } ================================================ FILE: src/DesktopPlus/InputSimulator.h ================================================ #ifndef _INPUTSIMULATOR_H_ #define _INPUTSIMULATOR_H_ #define NOMINMAX #include #include //Dashboard_Back exists, but not doesn't map to "Go Back" ...okay! #define Button_Dashboard_GoHome vr::k_EButton_IndexController_A #define Button_Dashboard_GoBack vr::k_EButton_IndexController_B enum IPCKeyboardKeystateFlags : unsigned char; //SyntheticPointer functions are loaded manually to not require OS support to run the application (Windows 10 1809+ should have them though) typedef HANDLE HSYNTHETICPOINTERDEVICE_DPLUS; #ifndef NTDDI_WIN10_RS5 typedef enum { POINTER_FEEDBACK_DEFAULT = 1, POINTER_FEEDBACK_INDIRECT = 2, POINTER_FEEDBACK_NONE = 3 } POINTER_FEEDBACK_MODE; #endif typedef HSYNTHETICPOINTERDEVICE_DPLUS (WINAPI* fn_CreateSyntheticPointerDevice) (_In_ POINTER_INPUT_TYPE pointerType, _In_ ULONG maxCount, _In_ POINTER_FEEDBACK_MODE mode); typedef BOOL (WINAPI* fn_InjectSyntheticPointerInput) (_In_ HSYNTHETICPOINTERDEVICE_DPLUS device, _In_reads_(count) CONST POINTER_TYPE_INFO* pointerInfo, _In_ UINT32 count); typedef void (WINAPI* fn_DestroySyntheticPointerDevice)(_In_ HSYNTHETICPOINTERDEVICE_DPLUS device); class InputSimulator { private: int m_SpaceMaxX = 0; int m_SpaceMaxY = 0; float m_SpaceMultiplierX = 1.0f; float m_SpaceMultiplierY = 1.0f; int m_SpaceOffsetX = 0; int m_SpaceOffsetY = 0; static fn_CreateSyntheticPointerDevice s_p_CreateSyntheticPointerDevice; static fn_InjectSyntheticPointerInput s_p_InjectSyntheticPointerInput; static fn_DestroySyntheticPointerDevice s_p_DestroySyntheticPointerDevice; HSYNTHETICPOINTERDEVICE_DPLUS m_PenDevice = nullptr; POINTER_TYPE_INFO m_PenState = {0}; std::vector m_KeyboardTextQueue; bool m_ForwardToElevatedModeProcess = false; bool m_ElevatedModeHasTextQueued = false; void CreatePenDeviceIfNeeded(); static void LoadPenFunctions(); static void SetEventForMouseKeyCode(INPUT& input_event, unsigned char keycode, bool down); //Set the event if it would change key state. Returns if anything was written to input_event static bool SetEventForKeyCode(INPUT& input_event, unsigned char keycode, bool down, bool skip_check = false); public: InputSimulator(); ~InputSimulator(); void RefreshScreenOffsets(); void MouseMove(int x, int y); void MouseSetLeftDown(bool down); void MouseSetRightDown(bool down); void MouseSetMiddleDown(bool down); void MouseWheelHorizontal(float delta); void MouseWheelVertical(float delta); void PenMove(int x, int y); void PenSetPrimaryDown(bool down); void PenSetSecondaryDown(bool down); void PenLeave(); void KeyboardSetDown(unsigned char keycode); void KeyboardSetDown(unsigned char keycode, bool down); void KeyboardSetUp(unsigned char keycode); void KeyboardSetDown(unsigned char keycodes[3]); void KeyboardSetUp(unsigned char keycodes[3]); void KeyboardToggleState(unsigned char keycode); void KeyboardToggleState(unsigned char keycodes[3]); void KeyboardPressAndRelease(unsigned char keycode); void KeyboardSetToggleKey(unsigned char keycode, bool toggled); void KeyboardSetFromWin32KeyState(unsigned short keystate, bool down); //Keystate as returned by VkKeyScan() void KeyboardSetKeyState(IPCKeyboardKeystateFlags flags, unsigned char keycode); void KeyboardText(const char* str_utf8, bool always_use_unicode_event = false); void KeyboardTextFinish(); void SetElevatedModeForwardingActive(bool do_forward); static bool IsPenSimulationSupported(); static bool IsKeyDown(unsigned char keycode); }; #endif ================================================ FILE: src/DesktopPlus/LaserPointer.cpp ================================================ #include "LaserPointer.h" #include "ConfigManager.h" #include "OverlayManager.h" #include "OutputManager.h" #include "Util.h" #include "OpenVRExt.h" #define LASER_POINTER_OVERLAY_WIDTH 0.0025f #define LASER_POINTER_DEFAULT_LENGTH 5.0f LaserPointer::LaserPointer() : m_ActivationOrigin(dplp_activation_origin_none), m_HadPrimaryPointerDevice(false), m_DeviceMaxActiveID(0), m_LastPrimaryDeviceSwitchTick(0), m_LastScrollTick(0), m_DeviceHapticPending(vr::k_unTrackedDeviceIndexInvalid), m_IsForceTargetOverlayActive(false), m_ForceTargetOverlayHandle(vr::k_ulOverlayHandleInvalid) { //Not calling Update() here since the OutputManager typically needs to load the config and OpenVR first } LaserPointer::~LaserPointer() { if (vr::VROverlay() != nullptr) { for (auto& lp_device : m_Devices) { if (lp_device.OvrlHandle != vr::k_ulOverlayHandleInvalid) { vr::VROverlay()->DestroyOverlay(lp_device.OvrlHandle); } } } } void LaserPointer::CreateDeviceOverlay(vr::TrackedDeviceIndex_t device_index) { if (device_index >= vr::k_unMaxTrackedDeviceCount) return; LaserPointerDevice& lp_device = m_Devices[device_index]; std::string key = "elvissteinjr.DesktopPlusPointer" + std::to_string(device_index); vr::EVROverlayError ovrl_error = vr::VROverlay()->CreateOverlay(key.c_str(), "Desktop+ Laser Pointer", &lp_device.OvrlHandle); if (ovrl_error != vr::VROverlayError_None) return; //Set overlay as 2x2 half transparent blue-ish image uint32_t pixels[2 * 2]; std::fill(std::begin(pixels), std::end(pixels), 0xFFBFA75F); //Fairly close to SteamVR's pointer color (ABGR / little-endian order) vr::VROverlay()->SetOverlayRaw(lp_device.OvrlHandle, pixels, 2, 2, 4); vr::VROverlay()->SetOverlayWidthInMeters(lp_device.OvrlHandle, LASER_POINTER_OVERLAY_WIDTH); vr::VROverlay()->SetOverlaySortOrder(lp_device.OvrlHandle, 2); } void LaserPointer::UpdateDeviceOverlay(vr::TrackedDeviceIndex_t device_index) { if (device_index >= vr::k_unMaxTrackedDeviceCount) return; LaserPointerDevice& lp_device = m_Devices[device_index]; //Don't show any overlay when using HMD as origin if (lp_device.UseHMDAsOrigin) return; //Create overlay if it doesn't exist yet if (lp_device.OvrlHandle == vr::k_ulOverlayHandleInvalid) { CreateDeviceOverlay(device_index); } //Adjust visibility bool do_show_later = false; bool is_active = IsActive(); if ( (!lp_device.IsVisible) && (is_active) ) { lp_device.IsVisible = true; do_show_later = true; //Postpone actually showing the overlay until after we set position and visuals } else if ( (lp_device.IsVisible) && (!is_active) ) { vr::VROverlay()->HideOverlay(lp_device.OvrlHandle); lp_device.IsVisible = false; } //Skip rest if not visible if (!lp_device.IsVisible) return; //Position laser Matrix4 transform_tip, transform_offset; //Perform rotation locally and offset laser forward so it starts at the tip transform_offset.rotateX(-90.0f); transform_offset.translate_relative(0.0f, lp_device.LaserLength / 2.0f, 0.0f); //Use tip if there is one transform_tip = vr::IVRSystemEx::GetControllerTipMatrix( vr::VRSystem()->GetControllerRoleForTrackedDeviceIndex(device_index) ); transform_tip = transform_tip * transform_offset; //A smart person could probably figure out how to also have the overlay spin towards the HMD so it doesn't appear flat vr::HmdMatrix34_t transform_openvr = transform_tip.toOpenVR34(); vr::VROverlay()->SetOverlayTransformTrackedDeviceRelative(lp_device.OvrlHandle, (lp_device.UseHMDAsOrigin) ? vr::k_unTrackedDeviceIndex_Hmd : device_index, &transform_openvr); //Adjust pointer alpha/brightness bool is_primary_device = (device_index == (vr::TrackedDeviceIndex_t)ConfigManager::GetValue(configid_int_state_dplus_laser_pointer_device)); if (is_primary_device) { vr::VROverlay()->SetOverlayAlpha(lp_device.OvrlHandle, 1.0f); if (lp_device.OvrlHandleTargetLast != vr::k_ulOverlayHandleInvalid) { vr::VROverlay()->SetOverlayColor(lp_device.OvrlHandle, 1.0f, 1.0f, 1.0f); } else { vr::VROverlay()->SetOverlayColor(lp_device.OvrlHandle, 0.25f, 0.25f, 0.25f); } } else if (lp_device.IsActiveForMultiLaserInput) { vr::VROverlay()->SetOverlayAlpha(lp_device.OvrlHandle, 0.75f); vr::VROverlay()->SetOverlayColor(lp_device.OvrlHandle, 0.50f, 0.50f, 0.50f); } else { vr::VROverlay()->SetOverlayAlpha(lp_device.OvrlHandle, 0.125f); vr::VROverlay()->SetOverlayColor(lp_device.OvrlHandle, 0.25f, 0.25f, 0.25f); } if (do_show_later) { vr::VROverlay()->ShowOverlay(lp_device.OvrlHandle); } } void LaserPointer::UpdateIntersection(vr::TrackedDeviceIndex_t device_index) { if (device_index >= vr::k_unMaxTrackedDeviceCount) return; LaserPointerDevice& lp_device = m_Devices[device_index]; bool is_primary_device = (device_index == (vr::TrackedDeviceIndex_t)ConfigManager::GetValue(configid_int_state_dplus_laser_pointer_device)); bool was_active_for_multilaser_input = lp_device.IsActiveForMultiLaserInput; bool skip_intersection_test = vr::IVROverlayEx::IsSystemLaserPointerActive(); bool skip_input = skip_intersection_test; //Set up intersection test bool hit_multilaser = false; vr::VROverlayIntersectionParams_t params = {0}; vr::VROverlayIntersectionResults_t results = {0}; if (!vr::IVROverlayEx::GetOverlayIntersectionParamsForDevice(params, (lp_device.UseHMDAsOrigin) ? vr::k_unTrackedDeviceIndex_Hmd : device_index, vr::TrackingUniverseStanding)) { skip_intersection_test = true; //Skip if pose isn't valid } //Find the nearest intersecting overlay vr::VROverlayHandle_t nearest_target_overlay = vr::k_ulOverlayHandleInvalid; OverlayTextureSource nearest_texture_source = ovrl_texsource_none; vr::VROverlayIntersectionResults_t nearest_results = {0}; nearest_results.fDistance = FLT_MAX; //If requested via ForceTargetOverlay(), force a different target overlay if (m_IsForceTargetOverlayActive) { skip_intersection_test = true; nearest_target_overlay = m_ForceTargetOverlayHandle; //Check if forced target overlay is UI overlay const bool is_forced_ui = ( (std::find(m_OverlayHandlesUI.begin(), m_OverlayHandlesUI.end(), nearest_target_overlay) != m_OverlayHandlesUI.end()) || (std::find(m_OverlayHandlesMultiLaser.begin(), m_OverlayHandlesMultiLaser.end(), nearest_target_overlay) != m_OverlayHandlesMultiLaser.end()) ); if (is_forced_ui) { nearest_texture_source = ovrl_texsource_ui; } else { unsigned int overlay_id = OverlayManager::Get().FindOverlayID(m_ForceTargetOverlayHandle); nearest_texture_source = OverlayManager::Get().GetOverlay(overlay_id).GetTextureSource(); } } //If input is held down, do not switch overlays and act as if overlay space is extending past the surface when not hitting it if (!skip_intersection_test) { if (lp_device.InputDownCount != 0) { //Check if input is still enabled vr::VROverlayInputMethod input_method = vr::VROverlayInputMethod_None; vr::VROverlay()->GetOverlayInputMethod(lp_device.OvrlHandleTargetLast, &input_method); if (input_method == vr::VROverlayInputMethod_Mouse) { if (vr::VROverlay()->ComputeOverlayIntersection(lp_device.OvrlHandleTargetLast, ¶ms, &results)) { if ( (vr::IVROverlayEx::IsOverlayIntersectionHitFrontFacing(params, results)) && (IntersectionMaskHitTest(lp_device.OvrlHandleTargetLastTextureSource, results.vUVs)) ) { nearest_target_overlay = lp_device.OvrlHandleTargetLast; } } //These results are still valid even when not actually hitting nearest_results = results; } } else { //Desktop+ overlays for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { const Overlay& overlay = OverlayManager::Get().GetOverlay(i); const OverlayConfigData& data = OverlayManager::Get().GetConfigData(i); if ( (overlay.IsVisible()) && (data.ConfigBool[configid_bool_overlay_input_dplus_lp_enabled]) ) { //Check if input is enabled right now (could differ from config setting) vr::VROverlayInputMethod input_method = vr::VROverlayInputMethod_None; vr::VROverlay()->GetOverlayInputMethod(overlay.GetHandle(), &input_method); if ( (input_method == vr::VROverlayInputMethod_Mouse) && (vr::VROverlay()->ComputeOverlayIntersection(overlay.GetHandle(), ¶ms, &results)) && (results.fDistance < nearest_results.fDistance) ) { //If Desktop Duplication/Performance Montior, this also performs an extra hit-test as described below if ( (vr::IVROverlayEx::IsOverlayIntersectionHitFrontFacing(params, results)) && (IntersectionMaskHitTest(overlay.GetTextureSource(), results.vUVs)) ) { nearest_target_overlay = overlay.GetHandle(); nearest_texture_source = overlay.GetTextureSource(); nearest_results = results; } } } } //Desktop+ UI overlays // //ComputeOverlayIntersection() does not take intersection masks into account. This has been reported under issue #1601 in the OpenVR repo. //As masks can change any frame, sending them over all the time seems tedious and inefficient... we're doing this for now though to work around that. for (vr::VROverlayHandle_t overlay_handle : m_OverlayHandlesUI) { if (vr::VROverlay()->IsOverlayVisible(overlay_handle)) { //Check if input is enabled vr::VROverlayInputMethod input_method = vr::VROverlayInputMethod_None; vr::VROverlay()->GetOverlayInputMethod(overlay_handle, &input_method); if ( (input_method == vr::VROverlayInputMethod_Mouse) && (vr::VROverlay()->ComputeOverlayIntersection(overlay_handle, ¶ms, &results)) && (results.fDistance < nearest_results.fDistance) ) { if ( (vr::IVROverlayEx::IsOverlayIntersectionHitFrontFacing(params, results)) && (IntersectionMaskHitTest(ovrl_texsource_ui, results.vUVs)) ) { nearest_target_overlay = overlay_handle; nearest_texture_source = ovrl_texsource_ui; nearest_results = results; } } } } //MultiLaser overlays (just keyboard right now) for (vr::VROverlayHandle_t overlay_handle : m_OverlayHandlesMultiLaser) { if (vr::VROverlay()->IsOverlayVisible(overlay_handle)) { //Check if input is enabled vr::VROverlayInputMethod input_method = vr::VROverlayInputMethod_None; vr::VROverlay()->GetOverlayInputMethod(overlay_handle, &input_method); if ( (input_method == vr::VROverlayInputMethod_Mouse) && (vr::VROverlay()->ComputeOverlayIntersection(overlay_handle, ¶ms, &results)) && (results.fDistance < nearest_results.fDistance) ) { if ( (vr::IVROverlayEx::IsOverlayIntersectionHitFrontFacing(params, results)) && (IntersectionMaskHitTest(ovrl_texsource_ui, results.vUVs)) ) { hit_multilaser = true; nearest_target_overlay = overlay_handle; nearest_texture_source = ovrl_texsource_ui; nearest_results = results; } } } } //Non-MultiLaser hits are discared when not using the primary device if ( (!hit_multilaser) && (!is_primary_device) ) { nearest_target_overlay = vr::k_ulOverlayHandleInvalid; nearest_texture_source = ovrl_texsource_none; } lp_device.IsActiveForMultiLaserInput = hit_multilaser; } } //If we hit a different overlay (or lack thereof)... if ( ( (lp_device.InputDownCount == 0) && (nearest_target_overlay != lp_device.OvrlHandleTargetLast) ) || (m_IsForceTargetOverlayActive) ) { //...send focus leave event to last entered overlay if (lp_device.OvrlHandleTargetLast != vr::k_ulOverlayHandleInvalid) { vr::VREvent_t vr_event = {0}; vr_event.trackedDeviceIndex = device_index; vr_event.eventType = vr::VREvent_FocusLeave; vr::VROverlayView()->PostOverlayEvent(lp_device.OvrlHandleTargetLast, &vr_event); //Clear overlay cursor if we were probably the last one to set it if ( (!was_active_for_multilaser_input) || (is_primary_device) ) { vr::VROverlay()->ClearOverlayCursorPositionOverride(lp_device.OvrlHandleTargetLast); } } //...and enter to the new one, if any if (nearest_target_overlay != vr::k_ulOverlayHandleInvalid) { vr::VREvent_t vr_event = {0}; vr_event.trackedDeviceIndex = device_index; vr_event.eventType = vr::VREvent_FocusEnter; vr::VROverlayView()->PostOverlayEvent(nearest_target_overlay, &vr_event); } } //Send mouse move event if we hit an overlay if ( (nearest_target_overlay != vr::k_ulOverlayHandleInvalid) && (IsActive()) ) //Check for IsActive() so we don't send mouse move events for 1 frame after deactivation { vr::HmdVector2_t mouse_scale; vr::VROverlay()->GetOverlayMouseScale(nearest_target_overlay, &mouse_scale); vr::VREvent_t vr_event = {0}; vr_event.trackedDeviceIndex = device_index; vr_event.eventType = vr::VREvent_MouseMove; vr_event.data.mouse.x = nearest_results.vUVs.v[0] * mouse_scale.v[0]; vr_event.data.mouse.y = nearest_results.vUVs.v[1] * mouse_scale.v[1]; vr::VROverlayView()->PostOverlayEvent(nearest_target_overlay, &vr_event); //Set blob if (is_primary_device) { bool hide_intersection = false; vr::VROverlay()->GetOverlayFlag(nearest_target_overlay, vr::VROverlayFlags_HideLaserIntersection, &hide_intersection); if (!hide_intersection) { vr::VRTextureBounds_t tex_bounds; vr::VROverlay()->GetOverlayTextureBounds(nearest_target_overlay, &tex_bounds); int mapped_x = (mouse_scale.v[0] * tex_bounds.uMin); int mapped_y = (mouse_scale.v[1] * tex_bounds.vMin); int mapped_width = (mouse_scale.v[0] * tex_bounds.uMax) - mapped_x; int mapped_height = (mouse_scale.v[1] * tex_bounds.vMax) - mapped_y; //Flip to normal 2D space float pointer_y = -round(vr_event.data.mouse.y) + mouse_scale.v[1]; float new_u = (vr_event.data.mouse.x - mapped_x) / (mapped_width); float new_v = (pointer_y - mapped_y) / (mapped_height); //Flip it back new_v = -new_v + 1.0f; vr::HmdVector2_t pos = {new_u * mouse_scale.v[0], new_v * mouse_scale.v[1]}; vr::VROverlay()->SetOverlayCursorPositionOverride(nearest_target_overlay, &pos); } else { vr::VROverlay()->ClearOverlayCursorPositionOverride(nearest_target_overlay); } } //Set pointer length to overlay distance lp_device.LaserLength = nearest_results.fDistance; } else if ( (!skip_input) && (lp_device.InputDownCount != 0) ) //Nothing hit, but input is down, extend { vr::HmdVector2_t mouse_scale; vr::VROverlay()->GetOverlayMouseScale(lp_device.OvrlHandleTargetLast, &mouse_scale); vr::VREvent_t vr_event = {0}; vr_event.trackedDeviceIndex = device_index; vr_event.eventType = vr::VREvent_MouseMove; vr_event.data.mouse.x = nearest_results.vUVs.v[0] * mouse_scale.v[0]; vr_event.data.mouse.y = (-nearest_results.vUVs.v[1] + 1.0f) * mouse_scale.v[1]; //For some reason the V position is upside-down when the intersection did not happen vr::VROverlayView()->PostOverlayEvent(lp_device.OvrlHandleTargetLast, &vr_event); //Clear cursor override when we're off the overlay since the override won't go past it like the real cursor would if (is_primary_device) { vr::VROverlay()->ClearOverlayCursorPositionOverride(lp_device.OvrlHandleTargetLast); } //Act as if the overlay was hit for the rest of this function nearest_target_overlay = lp_device.OvrlHandleTargetLast; nearest_texture_source = lp_device.OvrlHandleTargetLastTextureSource; } else { //Set pointer length to default lp_device.LaserLength = LASER_POINTER_DEFAULT_LENGTH; } //Input events if (nearest_target_overlay != vr::k_ulOverlayHandleInvalid) { VRInput& vr_input = OutputManager::Get()->GetVRInput(); //Clicking auto click_state_array = vr_input.GetLaserPointerClickState(lp_device.InputValueHandle); uint32_t mouse_button_id = vr::VRMouseButton_Left; lp_device.InputDownCount = 0; for (const auto& input_data : click_state_array) { if (input_data.bActive) { if (input_data.bChanged) { vr::VREvent_t vr_event = {0}; vr_event.trackedDeviceIndex = device_index; vr_event.eventType = (input_data.bState) ? vr::VREvent_MouseButtonDown : vr::VREvent_MouseButtonUp; vr_event.data.mouse.button = mouse_button_id; vr::VROverlayView()->PostOverlayEvent(nearest_target_overlay, &vr_event); //As VRInput::GetActionOrigins() isn't reliable for some reason, we may not have the input value handle yet... we grab it from here instead as a workaround if (lp_device.InputValueHandle == vr::k_ulInvalidInputValueHandle) { vr::InputOriginInfo_t origin_info = {0}; if (vr::VRInput()->GetOriginTrackedDeviceInfo(input_data.activeOrigin, &origin_info, sizeof(vr::InputOriginInfo_t)) == vr::VRInputError_None) { if ( (origin_info.trackedDeviceIndex < vr::k_unMaxTrackedDeviceCount) ) { m_Devices[origin_info.trackedDeviceIndex].InputValueHandle = origin_info.devicePath; } } } } if (input_data.bState) { lp_device.InputDownCount++; } } mouse_button_id *= 2; //with click_state_array containing 5 elements, this goes over the OpenVR defined buttons to include our custom VRMouseButton_DP_Aux01/02 } //Scrolling //Get scroll mode from overlay and set it for VRInput bool send_scroll_discrete = false, send_scroll_smooth = false; vr::VROverlay()->GetOverlayFlag(nearest_target_overlay, vr::VROverlayFlags_SendVRDiscreteScrollEvents, &send_scroll_discrete); vr::VROverlay()->GetOverlayFlag(nearest_target_overlay, vr::VROverlayFlags_SendVRSmoothScrollEvents, &send_scroll_smooth); VRInputScrollMode scroll_mode = (send_scroll_smooth) ? vrinput_scroll_smooth : (send_scroll_discrete) ? vrinput_scroll_discrete : vrinput_scroll_none; vr_input.SetLaserPointerScrollMode(scroll_mode); switch (scroll_mode) { case vrinput_scroll_discrete: { vr::InputAnalogActionData_t input_data = vr_input.GetLaserPointerScrollDiscreteState(); //If active and changed or not 0 on any axis if ( (input_data.bActive) && ( (input_data.x != 0.0f) || (input_data.y != 0.0f) || (input_data.deltaX != 0.0f) || (input_data.deltaY != 0.0f) ) ) { vr::VREvent_t vr_event = {0}; vr_event.trackedDeviceIndex = device_index; vr_event.eventType = vr::VREvent_ScrollDiscrete; vr_event.data.scroll.xdelta = input_data.x; vr_event.data.scroll.ydelta = input_data.y; vr::VROverlayView()->PostOverlayEvent(nearest_target_overlay, &vr_event); m_LastScrollTick = ::GetTickCount64(); } break; } case vrinput_scroll_smooth: { vr::InputAnalogActionData_t input_data = vr_input.GetLaserPointerScrollSmoothState(); //If active and changed or not 0 on any axis if ( (input_data.bActive) && ( (input_data.x != 0.0f) || (input_data.y != 0.0f) || (input_data.deltaX != 0.0f) || (input_data.deltaY != 0.0f) ) ) { vr::VREvent_t vr_event = {0}; vr_event.trackedDeviceIndex = device_index; vr_event.eventType = vr::VREvent_ScrollSmooth; vr_event.data.scroll.xdelta = input_data.x; vr_event.data.scroll.ydelta = input_data.y; vr::VROverlayView()->PostOverlayEvent(nearest_target_overlay, &vr_event); m_LastScrollTick = ::GetTickCount64(); } break; } default: break; } //Direct Drag { vr::InputDigitalActionData_t input_data = vr_input.GetLaserPointerDragState(lp_device.InputValueHandle); if (input_data.bActive) { if (input_data.bChanged) { SendDirectDragCommand(nearest_target_overlay, input_data.bState); lp_device.IsDragDown = input_data.bState; } if (input_data.bState) { lp_device.InputDownCount++; } } } } else { lp_device.InputDownCount = 0; } if (nearest_target_overlay != lp_device.OvrlHandleTargetLast) { lp_device.OvrlHandleTargetLast = nearest_target_overlay; lp_device.OvrlHandleTargetLastTextureSource = nearest_texture_source; if (is_primary_device) { ConfigManager::SetValue(configid_handle_state_dplus_laser_pointer_target_overlay, lp_device.OvrlHandleTargetLast); IPCManager::Get().PostConfigMessageToUIApp(configid_handle_state_dplus_laser_pointer_target_overlay, pun_cast(lp_device.OvrlHandleTargetLast)); } } m_IsForceTargetOverlayActive = false; //Update overlay length vr::VRTextureBounds_t tex_bounds = {0}; tex_bounds.uMax = 1.0f; tex_bounds.vMax = lp_device.LaserLength / LASER_POINTER_OVERLAY_WIDTH; vr::VROverlay()->SetOverlayTextureBounds(lp_device.OvrlHandle, &tex_bounds); } void LaserPointer::SendDirectDragCommand(vr::VROverlayHandle_t overlay_handle_target, bool do_start_drag) { unsigned int overlay_id = OverlayManager::Get().FindOverlayID(overlay_handle_target); if (overlay_id == k_ulOverlayID_None) { //Check if target overlay is UI overlay const bool is_ui = ( (std::find(m_OverlayHandlesUI.begin(), m_OverlayHandlesUI.end(), overlay_handle_target) != m_OverlayHandlesUI.end()) || (std::find(m_OverlayHandlesMultiLaser.begin(), m_OverlayHandlesMultiLaser.end(), overlay_handle_target) != m_OverlayHandlesMultiLaser.end()) ); //Tell UI to start a drag on it if it is if (is_ui) { IPCManager::Get().PostMessageToUIApp(ipcmsg_action, ipcact_lpointer_ui_drag, (do_start_drag) ? 1 : 0); } } else { (do_start_drag) ? OutputManager::Get()->OverlayDirectDragStart(overlay_id) : OutputManager::Get()->OverlayDirectDragFinish(overlay_id); } } void LaserPointer::Update() { //Refresh/Init handles in any case if they're empty if (m_OverlayHandlesUI.empty()) { RefreshCachedOverlayHandles(); } vr::TrackedDeviceIndex_t primary_pointer_device = (vr::TrackedDeviceIndex_t)ConfigManager::GetValue(configid_int_state_dplus_laser_pointer_device); if ( (primary_pointer_device == vr::k_unTrackedDeviceIndexInvalid) && (!m_HadPrimaryPointerDevice) ) return; VRInput& vr_input = OutputManager::Get()->GetVRInput(); //Trigger pending vibrations if we know the action set is now active if ( (m_HadPrimaryPointerDevice) && (m_DeviceHapticPending != vr::k_unTrackedDeviceIndexInvalid) ) { TriggerLaserPointerHaptics(m_DeviceHapticPending); m_DeviceHapticPending = vr::k_unTrackedDeviceIndexInvalid; } //Primary device switching if (!vr::IVROverlayEx::IsSystemLaserPointerActive()) { vr::InputDigitalActionData_t left_click_state = vr_input.GetLaserPointerLeftClickState(); if ( (left_click_state.bChanged) && (left_click_state.bState) ) { vr::InputOriginInfo_t origin_info = vr_input.GetOriginTrackedDeviceInfoEx(left_click_state.activeOrigin); if ( (origin_info.trackedDeviceIndex < vr::k_unMaxTrackedDeviceCount) && (origin_info.trackedDeviceIndex != primary_pointer_device) && (!m_Devices[origin_info.trackedDeviceIndex].IsActiveForMultiLaserInput)) { //Set device path here since we have it ready anyways m_Devices[origin_info.trackedDeviceIndex].InputValueHandle = origin_info.devicePath; //Store current tick to allow a grace period when switching devices while auto toggling is active and not actually hovering anything with the new pointer m_LastPrimaryDeviceSwitchTick = ::GetTickCount64(); SetActiveDevice(origin_info.trackedDeviceIndex, m_ActivationOrigin); } } } //Don't do anything if a dashboard pointer is active or we have no primary pointer ourselves bool should_pointer_be_active = IsActive(); //Also clear active device when we shouldn't be active if (!should_pointer_be_active) { ClearActiveDevice(); } if ( (m_HadPrimaryPointerDevice) || (should_pointer_be_active) ) { for (vr::TrackedDeviceIndex_t i = 0; i <= m_DeviceMaxActiveID; ++i) { if ( (m_Devices[i].OvrlHandle != vr::k_ulOverlayHandleInvalid) || (m_Devices[i].UseHMDAsOrigin) ) { UpdateIntersection(i); } } //Store if we were active the previous frame so we can sent overlay leave events in this iteration and clean up state before not doing this when not needed afterwards m_HadPrimaryPointerDevice = should_pointer_be_active; } for (vr::TrackedDeviceIndex_t i = 0; i <= m_DeviceMaxActiveID; ++i) { if (m_Devices[i].OvrlHandle != vr::k_ulOverlayHandleInvalid) { UpdateDeviceOverlay(i); } } vr_input.SetLaserPointerActive(should_pointer_be_active); } void LaserPointer::SetActiveDevice(vr::TrackedDeviceIndex_t device_index, LaserPointerActivationOrigin activation_origin) { if (device_index >= vr::k_unMaxTrackedDeviceCount) return; vr::TrackedDeviceIndex_t previous_active_device = (vr::TrackedDeviceIndex_t)ConfigManager::GetValue(configid_int_state_dplus_laser_pointer_device); if (previous_active_device == device_index) return; //Clear last overlay cursor override if (previous_active_device < vr::k_unMaxTrackedDeviceCount) { LaserPointerDevice& lp_device_prev = m_Devices[previous_active_device]; if (lp_device_prev.OvrlHandleTargetLast != vr::k_ulOverlayHandleInvalid) { vr::VROverlay()->ClearOverlayCursorPositionOverride(lp_device_prev.OvrlHandleTargetLast); } } LaserPointerDevice& lp_device = m_Devices[device_index]; //Set UseHMDAsOrigin, which forces using the HMD as an origin and not actually display any laser lp_device.UseHMDAsOrigin = ((device_index == vr::k_unTrackedDeviceIndex_Hmd) || (vr::VRSystem()->GetBoolTrackedDeviceProperty(device_index, vr::Prop_NeverTracked_Bool))); //Create overlay if it doesn't exist yet (and HMD isn't used as origin) if ( (!lp_device.UseHMDAsOrigin) && (lp_device.OvrlHandle == vr::k_ulOverlayHandleInvalid) ) { CreateDeviceOverlay(device_index); } //Try finding the input value handle for this device if it's not set yet if (lp_device.InputValueHandle == vr::k_ulInvalidInputValueHandle) { std::vector devices_info = OutputManager::Get()->GetVRInput().GetLaserPointerDevicesInfo(); const auto it = std::find_if(devices_info.begin(), devices_info.end(), [&](const auto& input_origin_info){ return (input_origin_info.trackedDeviceIndex == device_index); }); if (it != devices_info.end()) { lp_device.InputValueHandle = it->devicePath; } } //Adjust max active ID if it's smaller if (m_DeviceMaxActiveID < device_index) { m_DeviceMaxActiveID = device_index; } //Vibrate if this activates the Desktop+ pointer (not just switching) if (previous_active_device == vr::k_unTrackedDeviceIndexInvalid) { m_DeviceHapticPending = device_index; //Postpone the actual call until later since the relevant action set is not active yet } m_ActivationOrigin = activation_origin; ConfigManager::SetValue(configid_int_state_dplus_laser_pointer_device, device_index); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_dplus_laser_pointer_device, device_index); ConfigManager::SetValue(configid_handle_state_dplus_laser_pointer_target_overlay, lp_device.OvrlHandleTargetLast); IPCManager::Get().PostConfigMessageToUIApp(configid_handle_state_dplus_laser_pointer_target_overlay, pun_cast(lp_device.OvrlHandleTargetLast)); } void LaserPointer::ClearActiveDevice() { //Clear last overlay cursor override vr::TrackedDeviceIndex_t previous_active_device = (vr::TrackedDeviceIndex_t)ConfigManager::GetValue(configid_int_state_dplus_laser_pointer_device); if (previous_active_device < vr::k_unMaxTrackedDeviceCount) { LaserPointerDevice& lp_device_prev = m_Devices[previous_active_device]; //Finish active direct drag if (lp_device_prev.IsDragDown) { SendDirectDragCommand(lp_device_prev.OvrlHandleTargetLast, false); lp_device_prev.IsDragDown = false; } //Send focus leave event to last entered overlay if there is any if (lp_device_prev.OvrlHandleTargetLast != vr::k_ulOverlayHandleInvalid) { vr::VREvent_t vr_event = {0}; vr_event.trackedDeviceIndex = previous_active_device; vr_event.eventType = vr::VREvent_FocusLeave; vr::VROverlayView()->PostOverlayEvent(lp_device_prev.OvrlHandleTargetLast, &vr_event); //Also clear cursor override vr::VROverlay()->ClearOverlayCursorPositionOverride(lp_device_prev.OvrlHandleTargetLast); } } m_ActivationOrigin = dplp_activation_origin_none; ConfigManager::SetValue(configid_int_state_dplus_laser_pointer_device, vr::k_unTrackedDeviceIndexInvalid); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_dplus_laser_pointer_device, vr::k_unTrackedDeviceIndexInvalid); ConfigManager::SetValue(configid_handle_state_dplus_laser_pointer_target_overlay, vr::k_ulOverlayHandleInvalid); IPCManager::Get().PostConfigMessageToUIApp(configid_handle_state_dplus_laser_pointer_target_overlay, vr::k_ulOverlayHandleInvalid); } void LaserPointer::RemoveDevice(vr::TrackedDeviceIndex_t device_index) { if (device_index >= vr::k_unMaxTrackedDeviceCount) return; LaserPointerDevice& lp_device = m_Devices[device_index]; if (lp_device.OvrlHandle != vr::k_ulOverlayHandleInvalid) { vr::VROverlay()->DestroyOverlay(lp_device.OvrlHandle); } //Send focus leave event to last entered overlay if there is any if (lp_device.OvrlHandleTargetLast != vr::k_ulOverlayHandleInvalid) { vr::VREvent_t vr_event = {0}; vr_event.trackedDeviceIndex = device_index; vr_event.eventType = vr::VREvent_FocusLeave; vr::VROverlayView()->PostOverlayEvent(lp_device.OvrlHandleTargetLast, &vr_event); //Also remove pointer override in case there is any bool is_primary_device = (device_index == (vr::TrackedDeviceIndex_t)ConfigManager::GetValue(configid_int_state_dplus_laser_pointer_device)); if ( (!lp_device.IsActiveForMultiLaserInput) || (is_primary_device) ) { vr::VROverlay()->ClearOverlayCursorPositionOverride(lp_device.OvrlHandleTargetLast); } } lp_device = LaserPointerDevice(); } void LaserPointer::RefreshCachedOverlayHandles() { m_OverlayHandlesUI.clear(); m_OverlayHandlesMultiLaser.clear(); vr::VROverlayHandle_t overlay_handle; //Find UI overlays (except keyboard) const char* ui_overlay_keys[] = { "elvissteinjr.DesktopPlusUI", "elvissteinjr.DesktopPlusUIFloating", "elvissteinjr.DesktopPlusUISettings", "elvissteinjr.DesktopPlusUIOverlayProperties", "elvissteinjr.DesktopPlusUIAux" }; for (const char* key : ui_overlay_keys) { vr::VROverlay()->FindOverlay(key, &overlay_handle); if (overlay_handle != vr::k_ulOverlayHandleInvalid) { m_OverlayHandlesUI.push_back(overlay_handle); } } //Find MultiLaser overlays (which is just keyboard right now) vr::VROverlay()->FindOverlay("elvissteinjr.DesktopPlusUIKeyboard", &overlay_handle); if (overlay_handle != vr::k_ulOverlayHandleInvalid) { m_OverlayHandlesMultiLaser.push_back(overlay_handle); } //Cache UI mouse scale, since it's not going to change if (!m_OverlayHandlesUI.empty()) { vr::HmdVector2_t mouse_scale; vr::VROverlay()->GetOverlayMouseScale(m_OverlayHandlesUI[0], &mouse_scale); m_UIMouseScale.set((int)mouse_scale.v[0], (int)mouse_scale.v[1]); } } void LaserPointer::TriggerLaserPointerHaptics(vr::TrackedDeviceIndex_t device_index) const { OutputManager::Get()->GetVRInput().TriggerLaserPointerHaptics((device_index < vr::k_unMaxTrackedDeviceCount) ? m_Devices[device_index].InputValueHandle : vr::k_ulInvalidInputValueHandle); } void LaserPointer::ForceTargetOverlay(vr::VROverlayHandle_t overlay_handle) { vr::TrackedDeviceIndex_t primary_pointer_device = (vr::TrackedDeviceIndex_t)ConfigManager::GetValue(configid_int_state_dplus_laser_pointer_device); if (primary_pointer_device >= vr::k_unMaxTrackedDeviceCount) return; LaserPointerDevice& lp_device = m_Devices[primary_pointer_device]; //Don't do anything if there is no target overlay to switch from or if it would be a no-op if ( (lp_device.OvrlHandleTargetLast == vr::k_ulOverlayHandleInvalid) || (lp_device.OvrlHandleTargetLast == overlay_handle) ) return; //Run UpdateIntersection() with last target removed so overlay leave events are sent m_IsForceTargetOverlayActive = true; m_ForceTargetOverlayHandle = vr::k_ulOverlayHandleInvalid; UpdateIntersection(primary_pointer_device); //Set force variables again so they apply next time UpdateIntersection() us called m_IsForceTargetOverlayActive = true; m_ForceTargetOverlayHandle = overlay_handle; } LaserPointerActivationOrigin LaserPointer::GetActivationOrigin() const { return m_ActivationOrigin; } bool LaserPointer::IsActive() const { vr::TrackedDeviceIndex_t primary_pointer_device = (vr::TrackedDeviceIndex_t)ConfigManager::GetValue(configid_int_state_dplus_laser_pointer_device); return ( (!vr::IVROverlayEx::IsSystemLaserPointerActive()) && (primary_pointer_device != vr::k_unTrackedDeviceIndexInvalid) ); } vr::TrackedDeviceIndex_t LaserPointer::IsAnyOverlayHovered(float max_distance) const { //If active, just check if the primary pointer has a last target overlay if (IsActive()) { vr::TrackedDeviceIndex_t primary_pointer_device = (vr::TrackedDeviceIndex_t)ConfigManager::GetValue(configid_int_state_dplus_laser_pointer_device); if (primary_pointer_device >= vr::k_unMaxTrackedDeviceCount) return vr::k_unTrackedDeviceIndexInvalid; const LaserPointerDevice& lp_device = m_Devices[primary_pointer_device]; //Allow a 1500ms grace period after device switching even when not actually hovering anything & ignore distance if input is down if ( (m_LastPrimaryDeviceSwitchTick + 1500 > ::GetTickCount64() ) || ( (lp_device.OvrlHandleTargetLast != vr::k_ulOverlayHandleInvalid) && (lp_device.LaserLength <= max_distance) ) || (lp_device.InputDownCount != 0) ) { return primary_pointer_device; } } else //...otherwise check all possible overlays { //Check left and right hand controller and HMD if setting is enabled const bool lp_hmd_enabled_and_toggle_unbound = ((ConfigManager::GetValue(configid_bool_input_laser_pointer_hmd_device)) && (ConfigManager::GetValue(configid_int_input_laser_pointer_hmd_device_keycode_toggle) == 0)); const vr::TrackedDeviceIndex_t devices[] = { (lp_hmd_enabled_and_toggle_unbound) ? vr::k_unTrackedDeviceIndex_Hmd : vr::k_unTrackedDeviceIndexInvalid, vr::VRSystem()->GetTrackedDeviceIndexForControllerRole(vr::TrackedControllerRole_LeftHand), vr::VRSystem()->GetTrackedDeviceIndexForControllerRole(vr::TrackedControllerRole_RightHand), }; for (int i = 0; i < sizeof(devices)/sizeof(*devices); ++i) { const vr::TrackedDeviceIndex_t device_index = devices[i]; OverlayOrigin origin_avoid = (OverlayOrigin)(ovrl_origin_hmd+i); //Set up intersection test vr::VROverlayIntersectionParams_t params = {0}; vr::VROverlayIntersectionResults_t results = {0}; if (!vr::IVROverlayEx::GetOverlayIntersectionParamsForDevice(params, device_index, vr::TrackingUniverseStanding)) { continue; //Skip if pose isn't valid } //Desktop+ overlays for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { const Overlay& overlay = OverlayManager::Get().GetOverlay(i); const OverlayConfigData& data = OverlayManager::Get().GetConfigData(i); if ( (data.ConfigInt[configid_int_overlay_origin] != origin_avoid) && (overlay.IsVisible()) && (data.ConfigBool[configid_bool_overlay_input_dplus_lp_enabled]) ) { //Check if input is enabled right now (could differ from config setting) vr::VROverlayInputMethod input_method = vr::VROverlayInputMethod_None; vr::VROverlay()->GetOverlayInputMethod(overlay.GetHandle(), &input_method); if ( (input_method == vr::VROverlayInputMethod_Mouse) && (vr::VROverlay()->ComputeOverlayIntersection(overlay.GetHandle(), ¶ms, &results)) && (results.fDistance <= max_distance) ) { if ( (vr::IVROverlayEx::IsOverlayIntersectionHitFrontFacing(params, results)) && (IntersectionMaskHitTest(overlay.GetTextureSource(), results.vUVs)) ) { return device_index; } } } } //Desktop+ UI overlays // //See UpdateIntersection() for current issues for (vr::VROverlayHandle_t overlay_handle : m_OverlayHandlesUI) { if (vr::VROverlay()->IsOverlayVisible(overlay_handle)) { if ( (vr::VROverlay()->ComputeOverlayIntersection(overlay_handle, ¶ms, &results)) && (results.fDistance <= max_distance) ) { if ( (vr::IVROverlayEx::IsOverlayIntersectionHitFrontFacing(params, results)) && (IntersectionMaskHitTest(ovrl_texsource_ui, results.vUVs)) ) { return device_index; } } } } //MultiLaser overlays (just keyboard right now) for (vr::VROverlayHandle_t overlay_handle : m_OverlayHandlesMultiLaser) { if (vr::VROverlay()->IsOverlayVisible(overlay_handle)) { if ( (vr::VROverlay()->ComputeOverlayIntersection(overlay_handle, ¶ms, &results)) && (results.fDistance <= max_distance) ) { if ( (vr::IVROverlayEx::IsOverlayIntersectionHitFrontFacing(params, results)) && (IntersectionMaskHitTest(ovrl_texsource_ui, results.vUVs)) ) { return device_index; } } } } } } return vr::k_unTrackedDeviceIndexInvalid; } bool LaserPointer::IsScrolling() const { //Treat a 500ms window after the last scroll event as active scrolling (discrete scroll events aren't a constant stream when active) return (m_LastScrollTick + 500 > ::GetTickCount64()); } bool LaserPointer::IntersectionMaskHitTest(OverlayTextureSource texsource, vr::HmdVector2_t& uv) const { if (texsource == ovrl_texsource_desktop_duplication) { Vector2Int point(int(uv.v[0] * OutputManager::Get()->GetDesktopWidth()), int((-uv.v[1] + 1.0f) * OutputManager::Get()->GetDesktopHeight())); for (const auto& rect : OutputManager::Get()->GetDesktopRects()) { if (rect.Contains(point)) { return true; } } return false; } else if (texsource == ovrl_texsource_ui) { Vector2Int point(int(uv.v[0] * m_UIMouseScale.x), int((-uv.v[1] + 1.0f) * m_UIMouseScale.y)); for (const auto& rect : m_UIIntersectionMaskRects) { if (rect.Contains(point)) { return true; } } return false; } //Other texture sources don't have masks, so they always pass return true; } void LaserPointer::UIIntersectionMaskAddRect(DPRect& rect) { m_UIIntersectionMaskRectsPending.push_back(rect); } void LaserPointer::UIIntersectionMaskFinish() { m_UIIntersectionMaskRects = m_UIIntersectionMaskRectsPending; m_UIIntersectionMaskRectsPending.clear(); } ================================================ FILE: src/DesktopPlus/LaserPointer.h ================================================ #pragma once #include "DPRect.h" #include "Overlays.h" #include "openvr.h" #include struct LaserPointerDevice { vr::VROverlayHandle_t OvrlHandle = vr::k_ulOverlayHandleInvalid; vr::VRInputValueHandle_t InputValueHandle = vr::k_ulInvalidInputValueHandle; bool UseHMDAsOrigin = false; bool IsVisible = false; float LaserLength = 0.0f; vr::VROverlayHandle_t OvrlHandleTargetLast = vr::k_ulOverlayHandleInvalid; OverlayTextureSource OvrlHandleTargetLastTextureSource = ovrl_texsource_none; bool IsActiveForMultiLaserInput = false; int InputDownCount = 0; bool IsDragDown = false; }; //Optional origin that can be passed to SetActiveDevice() in order to keep track what activated the laser pointer (and thus should be responsible for deactivating) enum LaserPointerActivationOrigin { dplp_activation_origin_none, dplp_activation_origin_auto_toggle, dplp_activation_origin_input_binding }; //Custom laser pointer implementation for use outside of the dashboard //Operates on Desktop+ and Desktop+ UI overlays, sending overlay events matching SteamVR laser input behavior as closely as possible //Actually sends middle mouse events when bound //Supports use of any tracked device that has the corrects inputs bound, though IsAnyOverlayHovered() only checks handed controllers for auto interaction toggle //Paralell/Multi-Laser input is supported for certain overlays that can handle it (currently only the VR keyboard) class LaserPointer { private: LaserPointerDevice m_Devices[vr::k_unMaxTrackedDeviceCount]; std::vector m_OverlayHandlesUI; std::vector m_OverlayHandlesMultiLaser; LaserPointerActivationOrigin m_ActivationOrigin; bool m_HadPrimaryPointerDevice; vr::TrackedDeviceIndex_t m_DeviceMaxActiveID; ULONGLONG m_LastPrimaryDeviceSwitchTick; ULONGLONG m_LastScrollTick; vr::TrackedDeviceIndex_t m_DeviceHapticPending; //State set by ForceTargetOverlay() bool m_IsForceTargetOverlayActive; vr::VROverlayHandle_t m_ForceTargetOverlayHandle; Vector2Int m_UIMouseScale; std::vector m_UIIntersectionMaskRects; std::vector m_UIIntersectionMaskRectsPending; void CreateDeviceOverlay(vr::TrackedDeviceIndex_t device_index); void UpdateDeviceOverlay(vr::TrackedDeviceIndex_t device_index); void UpdateIntersection(vr::TrackedDeviceIndex_t device_index); void SendDirectDragCommand(vr::VROverlayHandle_t overlay_handle_target, bool do_start_drag); public: LaserPointer(); ~LaserPointer(); void Update(); void SetActiveDevice(vr::TrackedDeviceIndex_t device_index, LaserPointerActivationOrigin activation_origin = dplp_activation_origin_none); void ClearActiveDevice(); void RemoveDevice(vr::TrackedDeviceIndex_t device_index); //Clears device entry, called on device disconnect void RefreshCachedOverlayHandles(); void TriggerLaserPointerHaptics(vr::TrackedDeviceIndex_t device_index) const; void ForceTargetOverlay(vr::VROverlayHandle_t overlay_handle); //Forces a different overlay to be current pointer target (only if there's currently one) //ComputeOverlayIntersection() does not take intersection masks into account. It's a bit cumbersome, but we track the DDP/UI ones ourselves to get around that. bool IntersectionMaskHitTest(OverlayTextureSource texsource, vr::HmdVector2_t& uv) const; void UIIntersectionMaskAddRect(DPRect& rect); void UIIntersectionMaskFinish(); LaserPointerActivationOrigin GetActivationOrigin() const; bool IsActive() const; vr::TrackedDeviceIndex_t IsAnyOverlayHovered(float max_distance) const; //Returns hovering device_index (or invalid if none). Only checks for LaserPointer supported overlays bool IsScrolling() const; }; ================================================ FILE: src/DesktopPlus/OutputManager.cpp ================================================ #include "OutputManager.h" //Keep building with 10.0.17763.0 / 1809 SDK optional #ifdef NTDDI_WIN10_RS5 #include #else #define DPLUS_DUP_NO_HDR #endif #include #include #include #include using namespace DirectX; #include #include #include #include "WindowManager.h" #include "Util.h" #include "OpenVRExt.h" #include "Logging.h" #include "DesktopPlusWinRT.h" #include "DPBrowserAPIClient.h" static OutputManager* g_OutputManager; //May not always exist, but there also should never be two, so this is fine OutputManager* OutputManager::Get() { return g_OutputManager; } // //Quick note about OutputManager (and Desktop+ in general) handles multi-overlay access: //Most functions use the "current" overlay as set by the OverlayManager or by having ConfigManager forward config values from the *_overlay_* configids //When needed, the current overlay is temporarily changed to the one to act on. //To have the UI act in such a scenario, the configid_int_state_overlay_current_id_override is typically used, as there may be visible changes to the user for one frame otherwise //To change the current overlay while nested in a temporary override, post a configid_int_interface_overlay_current_id message to both applications instead of just the counterpart // //This may all seem a bit messy, but helped retrofit the single overlay code a lot. Feel like cleaning this up with a way better scheme? Go ahead. // OutputManager::OutputManager(HANDLE PauseDuplicationEvent, HANDLE ResumeDuplicationEvent) : m_Device(nullptr), m_DeviceContext(nullptr), m_Sampler(nullptr), m_BlendState(nullptr), m_RasterizerState(nullptr), m_VertexShader(nullptr), m_PixelShader(nullptr), m_PixelShaderCursor(nullptr), m_InputLayout(nullptr), m_SharedSurf(nullptr), m_VertexBuffer(nullptr), m_ShaderResource(nullptr), m_KeyMutex(nullptr), m_WindowHandle(nullptr), m_PauseDuplicationEvent(PauseDuplicationEvent), m_ResumeDuplicationEvent(ResumeDuplicationEvent), m_DesktopX(0), m_DesktopY(0), m_DesktopWidth(-1), m_DesktopHeight(-1), m_MaxActiveRefreshDelay(16), m_OutputPendingSkippedFrame(false), m_OutputPendingFullRefresh(false), m_OutputHDRAvailable(false), m_OutputInvalid(false), m_OutputPendingDirtyRect{-1, -1, -1, -1}, m_OutputAlphaCheckFailed(false), m_OutputAlphaChecksPending(0), m_OvrlHandleIcon(vr::k_ulOverlayHandleInvalid), m_OvrlHandleDashboardDummy(vr::k_ulOverlayHandleInvalid), m_OvrlHandleDesktopTexture(vr::k_ulOverlayHandleInvalid), m_OvrlTex(nullptr), m_OvrlRTV(nullptr), m_OvrlActiveCount(0), m_OvrlDesktopDuplActiveCount(0), m_OvrlDashboardActive(false), m_OvrlInputActive(false), m_OvrlDirectDragActive(false), m_OvrlTempDragStartTick(0), m_PendingDashboardDummyHeight(0.0f), m_LastApplyTransformTick(0), m_LastFrameTransformUpdateTick(0), m_MouseLastClickTick(0), m_MouseIgnoreMoveEvent(false), m_MouseCursorNeedsUpdate(false), m_MouseLaserPointerUsedLastUpdate(false), m_MouseLastLaserPointerMoveBlocked(false), m_MouseLastLaserPointerX(-1), m_MouseLastLaserPointerY(-1), m_MouseIgnoreMoveEventMissCount(0), m_MouseLeftDownOverlayID(k_ulOverlayID_None), m_MouseLaserPointerScrollDeltaStart{0}, m_MouseLaserPointerScrollDeltaFrequency{0}, m_IsFirstLaunch(false), m_ComInitDone(false), m_DashboardActivatedOnce(false), m_MultiGPUTargetDevice(nullptr), m_MultiGPUTargetDeviceContext(nullptr), m_MultiGPUTexStaging(nullptr), m_MultiGPUTexTarget(nullptr), m_PerformanceFrameCount(0), m_PerformanceFrameCountStartTick(0), m_PerformanceUpdateLimiterDelay{0}, m_IsAnyHotkeyActive(false), m_RegisteredHotkeyCount(0) { m_MouseLastInfo.ShapeInfo.Type = DXGI_OUTDUPL_POINTER_SHAPE_TYPE_COLOR; ::QueryPerformanceFrequency(&m_MouseLaserPointerScrollDeltaFrequency); //Initialize ConfigManager and set first launch state based on existence of config file (used to detect first launch in Steam version) m_IsFirstLaunch = !ConfigManager::Get().LoadConfigFromFile(); g_OutputManager = this; } // // Destructor which calls CleanRefs to release all references and memory. // OutputManager::~OutputManager() { CleanRefs(); g_OutputManager = nullptr; } // // Releases all references // void OutputManager::CleanRefs() { //Release the shared desktop overlay texture since we're destroying the D3D11 device it's attached to (don't need this after shutting down OpenVR though) if (vr::VROverlay() != nullptr) { vr::VROverlayEx()->ReleaseSharedOverlayTexture(m_OvrlHandleDesktopTexture); } if (m_VertexShader) { m_VertexShader->Release(); m_VertexShader = nullptr; } if (m_PixelShader) { m_PixelShader->Release(); m_PixelShader = nullptr; } if (m_PixelShaderCursor) { m_PixelShaderCursor->Release(); m_PixelShaderCursor = nullptr; } if (m_InputLayout) { m_InputLayout->Release(); m_InputLayout = nullptr; } if (m_Sampler) { m_Sampler->Release(); m_Sampler = nullptr; } if (m_BlendState) { m_BlendState->Release(); m_BlendState = nullptr; } if (m_RasterizerState) { m_RasterizerState->Release(); m_RasterizerState = nullptr; } if (m_DeviceContext) { m_DeviceContext->Release(); m_DeviceContext = nullptr; } if (m_Device) { m_Device->Release(); m_Device = nullptr; } if (m_SharedSurf) { m_SharedSurf->Release(); m_SharedSurf = nullptr; } if (m_VertexBuffer) { m_VertexBuffer->Release(); m_VertexBuffer = nullptr; } if (m_ShaderResource) { m_ShaderResource->Release(); m_ShaderResource = nullptr; } if (m_OvrlTex) { m_OvrlTex->Release(); m_OvrlTex = nullptr; } if (m_OvrlRTV) { m_OvrlRTV->Release(); m_OvrlRTV = nullptr; } m_MouseTex.Reset(); m_MouseShaderRes.Reset(); //Reset mouse state variables too m_MouseLastClickTick = 0; m_MouseIgnoreMoveEvent = false; m_MouseLastInfo = PTR_INFO(); m_MouseLastInfo.ShapeInfo.Type = DXGI_OUTDUPL_POINTER_SHAPE_TYPE_COLOR; m_MouseLastLaserPointerX = -1; m_MouseLastLaserPointerY = -1; if (m_KeyMutex) { m_KeyMutex->Release(); m_KeyMutex = nullptr; } if (m_ComInitDone) { ::CoUninitialize(); } if (m_MultiGPUTargetDevice) { m_MultiGPUTargetDevice->Release(); m_MultiGPUTargetDevice = nullptr; } if (m_MultiGPUTargetDeviceContext) { m_MultiGPUTargetDeviceContext->Release(); m_MultiGPUTargetDeviceContext = nullptr; } if (m_MultiGPUTexStaging) { m_MultiGPUTexStaging->Release(); m_MultiGPUTexStaging = nullptr; } if (m_MultiGPUTexTarget) { m_MultiGPUTexTarget->Release(); m_MultiGPUTexTarget = nullptr; } } // // Initialize all state // DUPL_RETURN OutputManager::InitOutput(HWND Window, _Out_ INT& SingleOutput, _Out_ UINT* OutCount, _Out_ RECT* DeskBounds) { LOG_F(INFO, "Initializing Desktop Duplication..."); HRESULT hr = S_OK; m_OutputInvalid = false; if (ConfigManager::GetValue(configid_bool_performance_single_desktop_mirroring)) { SingleOutput = clamp(ConfigManager::GetValue(configid_int_overlay_desktop_id), -1, ::GetSystemMetrics(SM_CMONITORS) - 1); } else { SingleOutput = -1; } // Store window handle m_WindowHandle = Window; //Get preferred adapter if there is any, this detects which GPU the target desktop is on Microsoft::WRL::ComPtr adapter_ptr_preferred; Microsoft::WRL::ComPtr adapter_ptr_vr; std::vector desktop_rects_prev = m_DesktopRects; int desktop_x_prev = m_DesktopX; int desktop_y_prev = m_DesktopY; EnumerateOutputs(SingleOutput, &adapter_ptr_preferred, &adapter_ptr_vr); //If there's no preferred adapter it should default to the one the HMD is connected to if (adapter_ptr_preferred == nullptr) { //If both are nullptr it'll still try to find a working adapter to init, though it'll probably not work at the end in that scenario adapter_ptr_preferred = adapter_ptr_vr; } //If they're the same, we don't need to do any multi-gpu handling if (adapter_ptr_vr == adapter_ptr_preferred) { adapter_ptr_vr = nullptr; } // Driver types supported D3D_DRIVER_TYPE DriverTypes[] = { D3D_DRIVER_TYPE_HARDWARE, D3D_DRIVER_TYPE_WARP, //WARP shouldn't work, but this was like this in the duplication sample, so eh D3D_DRIVER_TYPE_REFERENCE, }; UINT NumDriverTypes = ARRAYSIZE(DriverTypes); // Feature levels supported D3D_FEATURE_LEVEL FeatureLevels[] = { D3D_FEATURE_LEVEL_11_0, D3D_FEATURE_LEVEL_10_1, D3D_FEATURE_LEVEL_10_0, D3D_FEATURE_LEVEL_9_1 }; UINT NumFeatureLevels = ARRAYSIZE(FeatureLevels); D3D_FEATURE_LEVEL FeatureLevel; // Create device if (adapter_ptr_preferred != nullptr) //Try preferred adapter first if we have one { hr = D3D11CreateDevice(adapter_ptr_preferred.Get(), D3D_DRIVER_TYPE_UNKNOWN, nullptr, 0, FeatureLevels, NumFeatureLevels, D3D11_SDK_VERSION, &m_Device, &FeatureLevel, &m_DeviceContext); if (FAILED(hr)) { adapter_ptr_preferred = nullptr; } } if (adapter_ptr_preferred == nullptr) { LOG_F(WARNING, "Output enumeration did not return a preferred GPU. Trying first available device..."); for (UINT DriverTypeIndex = 0; DriverTypeIndex < NumDriverTypes; ++DriverTypeIndex) { hr = D3D11CreateDevice(nullptr, DriverTypes[DriverTypeIndex], nullptr, 0, FeatureLevels, NumFeatureLevels, D3D11_SDK_VERSION, &m_Device, &FeatureLevel, &m_DeviceContext); if (SUCCEEDED(hr)) { //Device creation succeeded. Take adapter from the device so it can be used further down adapter_ptr_preferred.Attach(GetDXGIAdapter()); break; } } } if (FAILED(hr)) { return ProcessFailure(m_Device, L"Device creation failed", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } //Create multi-gpu target device if needed if (adapter_ptr_vr != nullptr) { hr = D3D11CreateDevice(adapter_ptr_vr.Get(), D3D_DRIVER_TYPE_UNKNOWN, nullptr, 0, FeatureLevels, NumFeatureLevels, D3D11_SDK_VERSION, &m_MultiGPUTargetDevice, &FeatureLevel, &m_MultiGPUTargetDeviceContext); if (FAILED(hr)) { return ProcessFailure(m_Device, L"Secondary device creation failed", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } adapter_ptr_vr = nullptr; LOG_F(INFO, "Using cross-GPU copy"); } //Check Desktop Duplication HDR support m_OutputHDRAvailable = false; #ifndef DPLUS_DUP_NO_HDR if (adapter_ptr_preferred != nullptr) { Microsoft::WRL::ComPtr DxgiOutput; hr = adapter_ptr_preferred->EnumOutputs(0, &DxgiOutput); if (SUCCEEDED(hr)) { Microsoft::WRL::ComPtr DxgiOutput5; hr = DxgiOutput.As(&DxgiOutput5); m_OutputHDRAvailable = SUCCEEDED(hr); } } if (m_OutputHDRAvailable) { LOG_F(INFO, "Desktop Duplication HDR mirroring is supported"); } else { LOG_F(INFO, "Desktop Duplication HDR mirroring is not supported"); } #else LOG_F(INFO, "Desktop+ was not built with Desktop Duplication HDR support"); #endif // Create shared texture DUPL_RETURN Return = CreateTextures(SingleOutput, OutCount, DeskBounds); if (Return != DUPL_RETURN_SUCCESS) { return Return; } // Make new render target view Return = MakeRTV(); if (Return != DUPL_RETURN_SUCCESS) { return Return; } // Set view port D3D11_VIEWPORT VP; VP.Width = static_cast(m_DesktopWidth); VP.Height = static_cast(m_DesktopHeight); VP.MinDepth = 0.0f; VP.MaxDepth = 1.0f; VP.TopLeftX = 0; VP.TopLeftY = 0; m_DeviceContext->RSSetViewports(1, &VP); // Create the sample state D3D11_SAMPLER_DESC SampDesc; RtlZeroMemory(&SampDesc, sizeof(SampDesc)); SampDesc.Filter = D3D11_FILTER_MIN_MAG_MIP_POINT; SampDesc.AddressU = D3D11_TEXTURE_ADDRESS_CLAMP; SampDesc.AddressV = D3D11_TEXTURE_ADDRESS_CLAMP; SampDesc.AddressW = D3D11_TEXTURE_ADDRESS_CLAMP; SampDesc.ComparisonFunc = D3D11_COMPARISON_NEVER; SampDesc.MinLOD = 0; SampDesc.MaxLOD = D3D11_FLOAT32_MAX; hr = m_Device->CreateSamplerState(&SampDesc, &m_Sampler); if (FAILED(hr)) { return ProcessFailure(m_Device, L"Failed to create sampler state", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } // Create the blend state D3D11_BLEND_DESC BlendStateDesc; BlendStateDesc.AlphaToCoverageEnable = FALSE; BlendStateDesc.IndependentBlendEnable = FALSE; BlendStateDesc.RenderTarget[0].BlendEnable = TRUE; BlendStateDesc.RenderTarget[0].SrcBlend = D3D11_BLEND_SRC_ALPHA; BlendStateDesc.RenderTarget[0].DestBlend = D3D11_BLEND_INV_SRC_ALPHA; BlendStateDesc.RenderTarget[0].BlendOp = D3D11_BLEND_OP_ADD; BlendStateDesc.RenderTarget[0].SrcBlendAlpha = D3D11_BLEND_ONE; BlendStateDesc.RenderTarget[0].DestBlendAlpha = D3D11_BLEND_ZERO; BlendStateDesc.RenderTarget[0].BlendOpAlpha = D3D11_BLEND_OP_ADD; BlendStateDesc.RenderTarget[0].RenderTargetWriteMask = D3D11_COLOR_WRITE_ENABLE_RED | D3D11_COLOR_WRITE_ENABLE_GREEN | D3D11_COLOR_WRITE_ENABLE_BLUE; hr = m_Device->CreateBlendState(&BlendStateDesc, &m_BlendState); if (FAILED(hr)) { return ProcessFailure(m_Device, L"Failed to create blend state", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } //Create the rasterizer state D3D11_RASTERIZER_DESC RasterizerDesc; RtlZeroMemory(&RasterizerDesc, sizeof(RasterizerDesc)); RasterizerDesc.FillMode = D3D11_FILL_SOLID; RasterizerDesc.CullMode = D3D11_CULL_BACK; RasterizerDesc.ScissorEnable = true; hr = m_Device->CreateRasterizerState(&RasterizerDesc, &m_RasterizerState); if (FAILED(hr)) { return ProcessFailure(m_Device, L"Failed to create rasterizer state", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } m_DeviceContext->RSSetState(m_RasterizerState); //Create vertex buffer for drawing whole texture VERTEX Vertices[NUMVERTICES] = { { XMFLOAT3(-1.0f, -1.0f, 0.0f), XMFLOAT2(0.0f, 1.0f) }, { XMFLOAT3(-1.0f, 1.0f, 0.0f), XMFLOAT2(0.0f, 0.0f) }, { XMFLOAT3( 1.0f, -1.0f, 0.0f), XMFLOAT2(1.0f, 1.0f) }, { XMFLOAT3( 1.0f, -1.0f, 0.0f), XMFLOAT2(1.0f, 1.0f) }, { XMFLOAT3(-1.0f, 1.0f, 0.0f), XMFLOAT2(0.0f, 0.0f) }, { XMFLOAT3( 1.0f, 1.0f, 0.0f), XMFLOAT2(1.0f, 0.0f) }, }; D3D11_BUFFER_DESC BufferDesc; RtlZeroMemory(&BufferDesc, sizeof(BufferDesc)); BufferDesc.Usage = D3D11_USAGE_DEFAULT; BufferDesc.ByteWidth = sizeof(VERTEX) * NUMVERTICES; BufferDesc.BindFlags = D3D11_BIND_VERTEX_BUFFER; BufferDesc.CPUAccessFlags = 0; D3D11_SUBRESOURCE_DATA InitData; RtlZeroMemory(&InitData, sizeof(InitData)); InitData.pSysMem = Vertices; // Create vertex buffer hr = m_Device->CreateBuffer(&BufferDesc, &InitData, &m_VertexBuffer); if (FAILED(hr)) { return ProcessFailure(m_Device, L"Failed to create vertex buffer", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } //Set scissor rect to full const D3D11_RECT rect_scissor_full = { 0, 0, m_DesktopWidth, m_DesktopHeight }; m_DeviceContext->RSSetScissorRects(1, &rect_scissor_full); // Initialize shaders Return = InitShaders(); if (Return != DUPL_RETURN_SUCCESS) { return Return; } //In case this was called due to a resolution change, check if the crop was just exactly the set desktop in each overlay and adapt then if (!ConfigManager::GetValue(configid_bool_performance_single_desktop_mirroring)) { unsigned int current_overlay_old = OverlayManager::Get().GetCurrentOverlayID(); for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { OverlayConfigData& data = OverlayManager::Get().GetConfigData(i); if (data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_desktop_duplication) { int desktop_id = data.ConfigInt[configid_int_overlay_desktop_id]; if ((desktop_id >= 0) && (desktop_id < desktop_rects_prev.size()) && (desktop_id < m_DesktopRects.size())) { int crop_x = data.ConfigInt[configid_int_overlay_crop_x]; int crop_y = data.ConfigInt[configid_int_overlay_crop_y]; int crop_width = data.ConfigInt[configid_int_overlay_crop_width]; int crop_height = data.ConfigInt[configid_int_overlay_crop_height]; DPRect crop_rect(crop_x, crop_y, crop_x + crop_width, crop_y + crop_height); DPRect desktop_rect = desktop_rects_prev[desktop_id]; desktop_rect.Translate({-desktop_x_prev, -desktop_y_prev}); if (crop_rect == desktop_rect) { OverlayManager::Get().SetCurrentOverlayID(i); CropToDisplay(desktop_id, true); } } } } OverlayManager::Get().SetCurrentOverlayID(current_overlay_old); } ResetOverlays(); //On some systems, the Desktop Duplication output is translucent for some reason //We check the texture's pixels for the first few frame updates to make sure we can use the straight copy path, which should be the case on most machines //If it fails we use a pixel shader to fix the alpha channel during frame updates m_OutputAlphaCheckFailed = false; m_OutputAlphaChecksPending = 10; return Return; } std::tuple OutputManager::InitOverlay() { vr::EVRInitError init_error = vr::VRInitError_None; vr::VROverlayError ovrl_error = vr::VROverlayError_None; vr::VR_Init(&init_error, vr::VRApplication_Overlay); if (init_error != vr::VRInitError_None) return {init_error, ovrl_error, false}; if (!vr::VROverlay()) return {vr::VRInitError_Init_InvalidInterface, ovrl_error, false}; DPLog_SteamVR_SystemInfo(); m_OvrlHandleDashboardDummy = vr::k_ulOverlayHandleInvalid; m_OvrlHandleIcon = vr::k_ulOverlayHandleInvalid; m_OvrlHandleDesktopTexture = vr::k_ulOverlayHandleInvalid; //We already got rid of another instance of this app if there was any, but this loop takes care of it too if the detection failed or something uses our overlay key for (int tries = 0; tries < 10; ++tries) { //Create dashboard dummy overlay. It's only used to get a button, transform origin and position the top bar in the dashboard ovrl_error = vr::VROverlay()->CreateDashboardOverlay("elvissteinjr.DesktopPlusDashboard", "Desktop+", &m_OvrlHandleDashboardDummy, &m_OvrlHandleIcon); if (ovrl_error == vr::VROverlayError_KeyInUse) //If the key is already in use, kill the owning process (hopefully another instance of this app) { ovrl_error = vr::VROverlay()->FindOverlay("elvissteinjr.DesktopPlusDashboard", &m_OvrlHandleDashboardDummy); if ((ovrl_error == vr::VROverlayError_None) && (m_OvrlHandleDashboardDummy != vr::k_ulOverlayHandleInvalid)) { LOG_F(INFO, "Overlay key already in use, killing owning process..."); uint32_t pid = vr::VROverlay()->GetOverlayRenderingPid(m_OvrlHandleDashboardDummy); HANDLE phandle = ::OpenProcess(SYNCHRONIZE | PROCESS_TERMINATE, TRUE, pid); if (phandle != nullptr) { ::TerminateProcess(phandle, 0); ::CloseHandle(phandle); } else { ovrl_error = vr::VROverlayError_KeyInUse; } } else { ovrl_error = vr::VROverlayError_KeyInUse; } } else { break; } //Try again in a bit to check if it's just a race with some external cleanup ::Sleep(200); } if (m_OvrlHandleDashboardDummy != vr::k_ulOverlayHandleInvalid) { //Create desktop texture overlay. This overlay holds the desktop texture shared between Desktop Duplication Overlays ovrl_error = vr::VROverlay()->CreateOverlay("elvissteinjr.DesktopPlusDesktopTexture", "Desktop+", &m_OvrlHandleDesktopTexture); //Load config again to properly initialize overlays that were loaded before OpenVR was available const bool loaded_overlay_profile = ConfigManager::Get().GetAppProfileManager().ActivateProfileForCurrentSceneApp(); //Check if overlays from app profile need to be loaded first if (!loaded_overlay_profile) { ConfigManager::Get().LoadConfigFromFile(); } if (m_OvrlHandleDashboardDummy != vr::k_ulOverlayHandleInvalid) { unsigned char bytes[2 * 2 * 4] = {0}; //2x2 transparent RGBA //Set dashboard dummy content instead of leaving it totally blank, which is undefined vr::VROverlay()->SetOverlayRaw(m_OvrlHandleDashboardDummy, bytes, 2, 2, 4); vr::VROverlay()->SetOverlayInputMethod(m_OvrlHandleDashboardDummy, vr::VROverlayInputMethod_None); vr::VROverlay()->SetOverlayWidthInMeters(m_OvrlHandleDashboardDummy, 1.5f); vr::VROverlay()->SetOverlayFlag(m_OvrlHandleDashboardDummy, vr::VROverlayFlags_MinimalControlBar, true); //ResetOverlays() is called later //Use different icon if GamepadUI (SteamVR 2 dashboard) exists vr::VROverlayHandle_t handle_gamepad_ui = vr::k_ulOverlayHandleInvalid; vr::VROverlay()->FindOverlay("valve.steam.gamepadui.bar", &handle_gamepad_ui); const char* icon_file = (handle_gamepad_ui != vr::k_ulOverlayHandleInvalid) ? "images/icon_dashboard_gamepadui.png" : "images/icon_dashboard.png"; vr::VROverlay()->SetOverlayFromFile(m_OvrlHandleIcon, (ConfigManager::Get().GetApplicationPath() + icon_file).c_str()); } } m_MaxActiveRefreshDelay = 1000.0f / GetHMDFrameRate(); //Check if this process was launched by Steam by checking if the "SteamClientLaunch" environment variable exists bool is_steam_app = (::GetEnvironmentVariable(L"SteamClientLaunch", nullptr, 0) != 0); ConfigManager::SetValue(configid_bool_state_misc_process_started_by_steam, is_steam_app); IPCManager::Get().PostConfigMessageToUIApp(configid_bool_state_misc_process_started_by_steam, is_steam_app); //Add application manifest and set app key to Steam one if needed (setting the app key will make it load Steam input bindings even when not launched by it) if (!is_steam_app) { LOG_F(INFO, "Process was not launched by Steam, setting SteamVR application identity"); vr::VRApplications()->IdentifyApplication(::GetCurrentProcessId(), g_AppKeyDashboardApp); m_IsFirstLaunch = (!vr::VRApplications()->IsApplicationInstalled(g_AppKeyDashboardApp)); } //Even if not first launch, make sure the Theater Screen dummy app is installed //The Theater Screen needs a separate app entry as on Steam we don't control the contents of the app manifest for our appid, yet need to have "starts_theater_mode" in it somewhere if ((m_IsFirstLaunch) || (!vr::VRApplications()->IsApplicationInstalled(g_AppKeyTheaterScreen))) { vr::VRApplications()->AddApplicationManifest((ConfigManager::Get().GetApplicationPath() + "manifest.vrmanifest").c_str()); } //Set application auto-launch to true if it's the first launch if (m_IsFirstLaunch) { LOG_F(INFO, "First launch detected. Setting application to auto-launch with SteamVR"); vr::EVRApplicationError app_error = vr::VRApplications()->SetApplicationAutoLaunch(g_AppKeyDashboardApp, true); if (app_error == vr::VRApplicationError_None) { //Have the UI app display the initial setup notification IPCManager::Get().PostMessageToUIApp(ipcmsg_action, ipcact_notification_show); //Show the dashboard overlay as well to make it easier to find when first using the app vr::VROverlay()->ShowDashboard("elvissteinjr.DesktopPlusDashboard"); } } const bool vrinput_init_success = m_VRInput.Init(); //Check if it's a WMR system and set up for that if needed ConfigManager::Get().InitConfigForWMR(); DPWinRT_SetDesktopEnumerationFlags( (ConfigManager::GetValue(configid_int_interface_wmr_ignore_vscreens) == 1) ); LOG_IF_F(INFO, (ConfigManager::GetValue(configid_int_interface_wmr_ignore_vscreens) == 1), "WMR headset detected, ignoring additional virtual displays"); //Set pen simulation support state so the UI can act on it ConfigManager::SetValue(configid_bool_state_pen_simulation_supported, m_InputSim.IsPenSimulationSupported()); LOG_F(INFO, "Pen input simulation is %s", (m_InputSim.IsPenSimulationSupported()) ? "supported" : "not supported"); //Init background overlay if needed m_BackgroundOverlay.Update(); //Hotkeys can trigger actions requiring OpenVR, so only register after OpenVR init RegisterHotkeys(); //Try to get dashboard in proper state if needed FixInvalidDashboardLaunchState(); //Return error state to allow for accurate display if needed return {vr::VRInitError_None, ovrl_error, vrinput_init_success}; } // // Update Overlay and handle events // DUPL_RETURN_UPD OutputManager::Update(_In_ PTR_INFO* PointerInfo, _In_ DPRect& DirtyRectTotal, bool NewFrame, bool SkipFrame) { if (HandleOpenVREvents()) //If quit event received, quit. { return DUPL_RETURN_UPD_QUIT; } UINT64 sync_key = 1; //Key used by duplication threads to lock for this function (duplication threads lock with 1, Update() with 0 and unlock vice versa) //If we previously skipped a frame, we want to actually process a new one at the next valid opportunity if ( (m_OutputPendingSkippedFrame) && (!SkipFrame) ) { //If there isn't new frame yet, we have to unlock the keyed mutex with the one we locked it with ourselves before //However, if the laser pointer was used since the last update, we simply use the key for new frame data to wait for the new mouse position or frame //Not waiting for it reduces latency usually, but laser pointer mouse movements are weirdly not picked up without doing this or enabling the rapid laser pointer update setting if ( (!NewFrame) && (!m_MouseLaserPointerUsedLastUpdate) ) { sync_key = 0; } NewFrame = true; //Treat this as a new frame now m_MouseLaserPointerUsedLastUpdate = false; } //If frame skipped and no new frame, do nothing (if there's a new frame, we have to at least re-lock the keyed mutex so the duplication threads can access it again) if ( (SkipFrame) && (!NewFrame) ) { m_OutputPendingSkippedFrame = true; //Process the frame next time we can return DUPL_RETURN_UPD_SUCCESS; } //When invalid output is set, key mutex can be null, so just do nothing if (m_KeyMutex == nullptr) { return DUPL_RETURN_UPD_SUCCESS; } // Try and acquire sync on common display buffer (needed to safely access the PointerInfo) HRESULT hr = m_KeyMutex->AcquireSync(sync_key, GetMaxRefreshDelay()); if (hr == static_cast(WAIT_TIMEOUT)) { // Another thread has the keyed mutex so try again later return DUPL_RETURN_UPD_RETRY; } else if (FAILED(hr)) { return (DUPL_RETURN_UPD)ProcessFailure(m_Device, L"Failed to acquire keyed mutex", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } DUPL_RETURN_UPD ret = DUPL_RETURN_UPD_SUCCESS; //If alternative cursor rendering is enabled, try to get software cursor data and use that as PointerInfo instead if (ConfigManager::GetValue(configid_bool_performance_alternative_cursor_rendering)) { m_MouseAlternativeCursor.SynthesizeDDPCursorInfo(); PointerInfo = &m_MouseAlternativeCursor.GetDDPCursorInfo(); } //Got mutex, so we can access pointer info and shared surface DPRect mouse_rect = {PointerInfo->Position.x, PointerInfo->Position.y, int(PointerInfo->Position.x + PointerInfo->ShapeInfo.Width), int(PointerInfo->Position.y + PointerInfo->ShapeInfo.Height)}; //If mouse state got updated, expand dirty rect to include old and new cursor regions if ( (ConfigManager::GetValue(configid_bool_input_mouse_render_cursor)) && (m_MouseLastInfo.LastTimeStamp.QuadPart < PointerInfo->LastTimeStamp.QuadPart) ) { //Only invalidate if position or shape changed, otherwise it would be a visually identical result if ( (m_MouseLastInfo.Position.x != PointerInfo->Position.x) || (m_MouseLastInfo.Position.y != PointerInfo->Position.y) || (PointerInfo->CursorShapeChanged) || (m_MouseCursorNeedsUpdate) || (m_MouseLastInfo.Visible != PointerInfo->Visible) ) { if ( (PointerInfo->Visible) ) { (DirtyRectTotal.GetTL().x == -1) ? DirtyRectTotal = mouse_rect : DirtyRectTotal.Add(mouse_rect); } if (m_MouseLastInfo.Visible) { DPRect mouse_rect_last(m_MouseLastInfo.Position.x, m_MouseLastInfo.Position.y, int(m_MouseLastInfo.Position.x + m_MouseLastInfo.ShapeInfo.Width), int(m_MouseLastInfo.Position.y + m_MouseLastInfo.ShapeInfo.Height)); (DirtyRectTotal.GetTL().x == -1) ? DirtyRectTotal = mouse_rect_last : DirtyRectTotal.Add(mouse_rect_last); } } } //If frame is skipped, skip all GPU work if (SkipFrame) { //Collect dirty rects for the next time we render (m_OutputPendingDirtyRect.GetTL().x == -1) ? m_OutputPendingDirtyRect = DirtyRectTotal : m_OutputPendingDirtyRect.Add(DirtyRectTotal); //Remember if the cursor changed so it's updated the next time we actually render it if (PointerInfo->CursorShapeChanged) { m_MouseCursorNeedsUpdate = true; } m_OutputPendingSkippedFrame = true; hr = m_KeyMutex->ReleaseSync(0); return DUPL_RETURN_UPD_SUCCESS; } else if (m_OutputPendingDirtyRect.GetTL().x != -1) //Add previously collected dirty rects if there are any { (DirtyRectTotal.GetTL().x == -1) ? DirtyRectTotal = m_OutputPendingDirtyRect : DirtyRectTotal.Add(m_OutputPendingDirtyRect); } bool has_updated_overlay = false; //Check all overlays for overlap and collect clipping region from matches DPRect clipping_region(-1, -1, -1, -1); if (!m_OutputPendingFullRefresh) { for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { const Overlay& overlay = OverlayManager::Get().GetOverlay(i); if ( (overlay.IsVisible()) && ( (overlay.GetTextureSource() == ovrl_texsource_desktop_duplication) || (overlay.GetTextureSource() == ovrl_texsource_desktop_duplication_3dou_converted) ) ) { const DPRect& cropping_region = overlay.GetValidatedCropRect(); if (DirtyRectTotal.Overlaps(cropping_region)) { if (clipping_region.GetTL().x != -1) { clipping_region.Add(cropping_region); } else { clipping_region = cropping_region; } } } } DirtyRectTotal.ClipWithFull(clipping_region); } else //Set dirty & clipping rect to total surface for full refresh { DirtyRectTotal = {0, 0, m_DesktopWidth, m_DesktopHeight}; clipping_region = DirtyRectTotal; m_OutputPendingFullRefresh = false; } m_OutputLastClippingRect = clipping_region; if (clipping_region.GetTL().x != -1) //Overlapped with at least one overlay { //Set scissor rect for overlay drawing function const D3D11_RECT rect_scissor = { DirtyRectTotal.GetTL().x, DirtyRectTotal.GetTL().y, DirtyRectTotal.GetBR().x, DirtyRectTotal.GetBR().y }; m_DeviceContext->RSSetScissorRects(1, &rect_scissor); //Draw shared surface to overlay texture to avoid trouble with transparency on some systems bool is_full_texture = DirtyRectTotal.Contains({0, 0, m_DesktopWidth, m_DesktopHeight}); DrawFrameToOverlayTex(is_full_texture); //Only handle cursor if it's in cropping region if (mouse_rect.Overlaps(DirtyRectTotal)) { DrawMouseToOverlayTex(PointerInfo); } else if (PointerInfo->CursorShapeChanged) //But remember if the cursor changed for next time { m_MouseCursorNeedsUpdate = true; } //Set Overlay texture ret = RefreshOpenVROverlayTexture(DirtyRectTotal); //Reset scissor rect const D3D11_RECT rect_scissor_full = { 0, 0, m_DesktopWidth, m_DesktopHeight }; m_DeviceContext->RSSetScissorRects(1, &rect_scissor_full); has_updated_overlay = (ret == DUPL_RETURN_UPD_SUCCESS_REFRESHED_OVERLAY); } else if (PointerInfo->CursorShapeChanged) //But remember if the cursor changed for next time { m_MouseCursorNeedsUpdate = true; } //Set cached mouse values (we don't want to copy the shape buffer, so no straight assignment) m_MouseLastInfo.ShapeInfo = PointerInfo->ShapeInfo; m_MouseLastInfo.Position = PointerInfo->Position; m_MouseLastInfo.Visible = PointerInfo->Visible; m_MouseLastInfo.WhoUpdatedPositionLast = PointerInfo->WhoUpdatedPositionLast; m_MouseLastInfo.LastTimeStamp = PointerInfo->LastTimeStamp; m_MouseLastInfo.CursorShapeChanged = PointerInfo->CursorShapeChanged; //Reset dirty rect DirtyRectTotal = DPRect(-1, -1, -1, -1); // Release keyed mutex hr = m_KeyMutex->ReleaseSync(0); if (FAILED(hr)) { return (DUPL_RETURN_UPD)ProcessFailure(m_Device, L"Failed to Release keyed mutex", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } //Count frames if (has_updated_overlay) { m_PerformanceFrameCount++; } m_OutputPendingSkippedFrame = false; m_OutputPendingDirtyRect = {-1, -1, -1, -1}; return ret; } void OutputManager::BusyUpdate() { //Improve responsiveness of temp drag during overlay creation when applying capture source can take a bit longer (i.e. browser overlays) if ( (m_OverlayDragger.IsDragActive()) && (ConfigManager::GetValue(configid_bool_state_overlay_dragmode_temp)) ) { m_OverlayDragger.DragUpdate(); } } bool OutputManager::HandleIPCMessage(const MSG& msg) { //Handle messages sent by browser process in the APIClient if (msg.message == DPBrowserAPIClient::Get().GetRegisteredMessageID()) { DPBrowserAPIClient::Get().HandleIPCMessage(msg); return false; } //Apply overlay id override if needed unsigned int current_overlay_old = OverlayManager::Get().GetCurrentOverlayID(); int overlay_override_id = ConfigManager::GetValue(configid_int_state_overlay_current_id_override); if (overlay_override_id != -1) { OverlayManager::Get().SetCurrentOverlayID(overlay_override_id); } //Config strings come as WM_COPYDATA if (msg.message == WM_COPYDATA) { COPYDATASTRUCT* pcds = (COPYDATASTRUCT*)msg.lParam; //Arbitrary size limit to prevent some malicous applications from sending bad data, especially when this is running elevated if ( (pcds->dwData < configid_str_MAX) && (pcds->cbData <= 4096) ) { std::string copystr((char*)pcds->lpData, pcds->cbData); //We rely on the data length. The data is sent without the NUL byte ConfigID_String str_id = (ConfigID_String)pcds->dwData; ConfigManager::SetValue(str_id, copystr); switch (str_id) { case configid_str_state_keyboard_string: { m_InputSim.KeyboardText(copystr.c_str()); break; } case configid_str_state_app_profile_data: { const std::string& app_key = ConfigManager::GetValue(configid_str_state_app_profile_key); if (!app_key.empty()) { AppProfile new_profile; new_profile.Deserialize(copystr); const bool loaded_overlay_profile = ConfigManager::Get().GetAppProfileManager().StoreProfile(app_key, new_profile); if (loaded_overlay_profile) ResetOverlays(); } break; } case configid_str_state_action_data: { Action new_action; new_action.Deserialize(copystr); ConfigManager::Get().GetActionManager().StoreAction(new_action); break; } default: break; } } //Restore overlay id override if (overlay_override_id != -1) { OverlayManager::Get().SetCurrentOverlayID(current_overlay_old); } return false; } bool reset_mirroring = false; IPCMsgID msgid = IPCManager::Get().GetIPCMessageID(msg.message); switch (msgid) { case ipcmsg_action: { switch (msg.wParam) { case ipcact_mirror_reset: { reset_mirroring = true; break; } case ipcact_overlay_position_reset: { DetachedTransformReset(); break; } case ipcact_overlay_position_adjust: { DetachedTransformAdjust(msg.lParam); break; } case ipcact_action_delete: { ConfigManager::Get().GetActionManager().RemoveAction(msg.lParam); break; } case ipcact_action_do: { ConfigManager::Get().GetActionManager().DoAction(msg.lParam, (overlay_override_id != -1) ? (unsigned int)overlay_override_id : k_ulOverlayID_None); break; } case ipcact_action_start: { ConfigManager::Get().GetActionManager().StartAction(msg.lParam, (overlay_override_id != -1) ? (unsigned int)overlay_override_id : k_ulOverlayID_None); break; } case ipcact_action_stop: { ConfigManager::Get().GetActionManager().StopAction(msg.lParam, (overlay_override_id != -1) ? (unsigned int)overlay_override_id : k_ulOverlayID_None); break; } case ipcact_keyboard_vkey: case ipcact_keyboard_wchar: { HandleKeyboardMessage((IPCActionID)msg.wParam, msg.lParam); break; } case ipcact_overlay_profile_load: { reset_mirroring = HandleOverlayProfileLoadMessage(msg.lParam); break; } case ipcact_crop_to_active_window: { CropToActiveWindow(); break; } case ipcact_switch_task: { ShowWindowSwitcher(); break; } case ipcact_overlay_duplicate: { DuplicateOverlay((unsigned int)msg.lParam); break; } case ipcact_overlay_new: { int desktop_id = msg.lParam; OverlayCaptureSource capsource; switch (desktop_id) { case -2: capsource = ovrl_capsource_winrt_capture; break; case -3: capsource = ovrl_capsource_ui; break; case -4: capsource = ovrl_capsource_browser; break; default: capsource = ovrl_capsource_desktop_duplication; } AddOverlay(capsource, desktop_id, (HWND)ConfigManager::GetValue(configid_handle_state_arg_hwnd)); break; } case ipcact_overlay_new_drag: { int desktop_id = GET_X_LPARAM(msg.lParam); float pointer_distance = GET_Y_LPARAM(msg.lParam) / 100.0f; OverlayCaptureSource capsource; switch (desktop_id) { case -2: capsource = ovrl_capsource_winrt_capture; break; case -3: capsource = ovrl_capsource_ui; break; case -4: capsource = ovrl_capsource_browser; break; default: capsource = ovrl_capsource_desktop_duplication; } AddOverlayDrag(pointer_distance, capsource, desktop_id, (HWND)ConfigManager::GetValue(configid_handle_state_arg_hwnd)); break; } case ipcact_overlay_remove: { OverlayManager::Get().RemoveOverlay((unsigned int)msg.lParam); //RemoveOverlay() may have changed active ID, keep in sync ConfigManager::SetValue(configid_int_interface_overlay_current_id, OverlayManager::Get().GetCurrentOverlayID()); break; } case ipcact_overlay_transform_sync: { DetachedTransformSyncAll(); break; } case ipcact_overlay_swap: { OverlayManager::Get().SwapOverlays(OverlayManager::Get().GetCurrentOverlayID(), (unsigned int)msg.lParam); break; } case ipcact_overlay_gaze_fade_auto: { DetachedOverlayGazeFadeAutoConfigure(); break; } case ipcact_overlay_make_standalone: { OverlayManager::Get().ConvertDuplicatedOverlayToStandalone((unsigned int)msg.lParam); break; } case ipcact_browser_navigate_to_url: { unsigned int overlay_id = (unsigned int)msg.lParam; DPBrowserAPIClient::Get().DPBrowser_SetURL(OverlayManager::Get().GetOverlay(overlay_id).GetHandle(), OverlayManager::Get().GetConfigData(overlay_id).ConfigStr[configid_str_overlay_browser_url]); break; } case ipcact_browser_recreate_context: { unsigned int overlay_id = (unsigned int)msg.lParam; DPBrowserAPIClient::Get().DPBrowser_RecreateBrowser(OverlayManager::Get().GetOverlay(overlay_id).GetHandle(), OverlayManager::Get().GetConfigData(overlay_id).ConfigBool[configid_bool_overlay_browser_allow_transparency]); break; } case ipcact_winmanager_drag_start: { unsigned int overlay_id = (unsigned int)msg.lParam; const bool use_pen = ConfigManager::GetValue(configid_bool_input_mouse_simulate_pen_input); if (m_OverlayDragger.GetDragDeviceID() == -1) { unsigned int current_overlay_old = OverlayManager::Get().GetCurrentOverlayID(); OverlayManager::Get().SetCurrentOverlayID(overlay_id); //Check if it's still being hovered since it could be off before the message is processed if (ConfigManager::Get().IsLaserPointerTargetOverlay(OverlayManager::Get().GetCurrentOverlay().GetHandle(), true)) { //Reset input and WindowManager state manually since the overlay mouse up even will be consumed to finish the drag later (use_pen) ? m_InputSim.PenSetPrimaryDown(false) : m_InputSim.MouseSetLeftDown(false); WindowManager::Get().SetTargetWindow(nullptr); if (ConfigManager::GetValue(configid_int_overlay_origin) != ovrl_origin_theater_screen) { if (!ConfigManager::GetValue(configid_bool_overlay_transform_locked)) { m_OverlayDragger.DragStart(overlay_id); } else { IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_drag_hint_device, ConfigManager::Get().GetPrimaryLaserPointerDevice()); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_drag_hint_type, 1); } } else { IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_drag_hint_device, ConfigManager::Get().GetPrimaryLaserPointerDevice()); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_drag_hint_type, 2); } } OverlayManager::Get().SetCurrentOverlayID(current_overlay_old); } else if (overlay_id == k_ulOverlayID_None) //Means it came from a blocked drag, reset input and WindowManager state { (use_pen) ? m_InputSim.PenSetPrimaryDown(false) : m_InputSim.MouseSetLeftDown(false); WindowManager::Get().SetTargetWindow(nullptr); } break; } case ipcact_winmanager_winlist_add: case ipcact_winmanager_winlist_update: { const WindowInfo* window_info = nullptr; bool has_title_changed = true; if (msg.wParam == ipcact_winmanager_winlist_add) window_info = &WindowManager::Get().WindowListAdd((HWND)msg.lParam); else window_info = WindowManager::Get().WindowListUpdateTitle((HWND)msg.lParam, &has_title_changed); //Find inactive overlays using the window and start capture for them if ( (window_info != nullptr) && (has_title_changed) ) //Only do this when the title changed { for (auto& i : OverlayManager::Get().FindInactiveOverlaysForWindow(*window_info)) { OverlayConfigData& data = OverlayManager::Get().GetConfigData(i); data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd] = msg.lParam; if (ConfigManager::GetValue(configid_int_windows_winrt_capture_lost_behavior) == window_caplost_hide_overlay) data.ConfigBool[configid_bool_overlay_enabled] = true; OnSetOverlayWinRTCaptureWindow(i); //Send to UI IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_current_id_override, (int)i); IPCManager::Get().PostConfigMessageToUIApp(configid_handle_overlay_state_winrt_hwnd, msg.lParam); if (ConfigManager::GetValue(configid_int_windows_winrt_capture_lost_behavior) == window_caplost_hide_overlay) IPCManager::Get().PostConfigMessageToUIApp(configid_bool_overlay_enabled, true); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_current_id_override, -1); } } break; } case ipcact_winmanager_winlist_remove: { std::wstring last_title_w = WindowManager::Get().WindowListRemove((HWND)msg.lParam); std::string last_title = StringConvertFromUTF16(last_title_w.c_str()); //Some windows clear their title entirely before ceasing to exist, skip those if (last_title.empty()) break; //Set last known title for overlays that captured this window for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { OverlayConfigData& data = OverlayManager::Get().GetConfigData(i); if (data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd] == msg.lParam) { data.ConfigStr[configid_str_overlay_winrt_last_window_title] = last_title; } } break; } case ipcact_winmanager_text_input_focus: { WindowManager::Get().UpdateTextInputFocusedState(msg.lParam); break; } case ipcact_sync_config_state: { //Overlay state for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { const Overlay& overlay = OverlayManager::Get().GetOverlay(i); const OverlayConfigData& data = OverlayManager::Get().GetConfigData(i); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_current_id_override, (int)i); IPCManager::Get().PostConfigMessageToUIApp(configid_handle_overlay_state_overlay_handle, data.ConfigHandle[configid_handle_overlay_state_overlay_handle]); IPCManager::Get().PostConfigMessageToUIApp(configid_int_overlay_state_content_width, data.ConfigInt[configid_int_overlay_state_content_width]); IPCManager::Get().PostConfigMessageToUIApp(configid_int_overlay_state_content_height, data.ConfigInt[configid_int_overlay_state_content_height]); //Send over current HWND if there's an active capture if ( (overlay.GetTextureSource() == ovrl_texsource_winrt_capture) && (data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd] != 0)) { IPCManager::Get().PostConfigMessageToUIApp(configid_handle_overlay_state_winrt_hwnd, data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd]); } else if (overlay.GetTextureSource() == ovrl_texsource_browser) //Send browser nav state if it's an active browser overlay { IPCManager::Get().PostConfigMessageToUIApp(configid_bool_overlay_state_browser_nav_can_go_back, data.ConfigBool[configid_bool_overlay_state_browser_nav_can_go_back]); IPCManager::Get().PostConfigMessageToUIApp(configid_bool_overlay_state_browser_nav_can_go_forward, data.ConfigBool[configid_bool_overlay_state_browser_nav_can_go_forward]); IPCManager::Get().PostConfigMessageToUIApp(configid_bool_overlay_state_browser_nav_is_loading, data.ConfigBool[configid_bool_overlay_state_browser_nav_is_loading]); } IPCManager::Get().PostConfigMessageToUIApp(configid_float_overlay_state_brightness_extra_multiplier, data.ConfigFloat[configid_float_overlay_state_brightness_extra_multiplier]); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_current_id_override, -1); } //Global config state IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_interface_desktop_count, ConfigManager::GetValue(configid_int_state_interface_desktop_count)); IPCManager::Get().PostConfigMessageToUIApp(configid_bool_state_overlay_dragmode, ConfigManager::GetValue(configid_bool_state_overlay_dragmode)); IPCManager::Get().PostConfigMessageToUIApp(configid_bool_state_overlay_selectmode, ConfigManager::GetValue(configid_bool_state_overlay_selectmode)); IPCManager::Get().PostConfigMessageToUIApp(configid_bool_state_overlay_dragselectmode_show_hidden, ConfigManager::GetValue(configid_bool_state_overlay_dragselectmode_show_hidden)); IPCManager::Get().PostConfigMessageToUIApp(configid_bool_state_overlay_dragmode_temp, ConfigManager::GetValue(configid_bool_state_overlay_dragmode_temp)); IPCManager::Get().PostConfigMessageToUIApp(configid_bool_state_pen_simulation_supported, ConfigManager::GetValue(configid_bool_state_pen_simulation_supported)); IPCManager::Get().PostConfigMessageToUIApp(configid_bool_state_window_focused_process_elevated, ConfigManager::GetValue(configid_bool_state_window_focused_process_elevated)); IPCManager::Get().PostConfigMessageToUIApp(configid_bool_state_misc_process_elevated, ConfigManager::GetValue(configid_bool_state_misc_process_elevated)); IPCManager::Get().PostConfigMessageToUIApp(configid_bool_state_misc_process_started_by_steam, ConfigManager::GetValue(configid_bool_state_misc_process_started_by_steam)); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_dplus_laser_pointer_device, ConfigManager::GetValue(configid_int_state_dplus_laser_pointer_device)); IPCManager::Get().PostConfigMessageToUIApp(configid_handle_state_dplus_laser_pointer_target_overlay, ConfigManager::GetValue(configid_handle_state_dplus_laser_pointer_target_overlay)); IPCManager::Get().PostConfigMessageToUIApp(configid_handle_state_theater_orig_overlay_handle, ConfigManager::GetValue(configid_handle_state_theater_orig_overlay_handle)); //Sync usually means new UI process, so get new handles m_LaserPointer.RefreshCachedOverlayHandles(); break; } case ipcact_focus_window: { WindowManager::Get().RaiseAndFocusWindow((HWND)msg.lParam, &m_InputSim); break; } case ipcact_keyboard_ovrl_focus_enter: { //If a WinRT window capture is the focused overlay, check for window auto-focus so it's possible to type things if (ConfigManager::GetValue(configid_bool_windows_winrt_auto_focus)) { const bool drag_or_select_mode_enabled = ( (ConfigManager::GetValue(configid_bool_state_overlay_dragmode)) || (ConfigManager::GetValue(configid_bool_state_overlay_selectmode)) ); if (!drag_or_select_mode_enabled) { int focused_overlay_id = ConfigManager::Get().GetValue(configid_int_state_overlay_focused_id); if (focused_overlay_id != -1) { const Overlay& overlay = OverlayManager::Get().GetOverlay((unsigned int)focused_overlay_id); const OverlayConfigData& data = OverlayManager::Get().GetConfigData((unsigned int)focused_overlay_id); if ((overlay.GetTextureSource() == ovrl_texsource_winrt_capture) && (data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd] != 0)) { WindowManager::Get().RaiseAndFocusWindow((HWND)data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd], &m_InputSim); } } } } break; } case ipcact_keyboard_ovrl_focus_leave: { //If leaving the keyboard while a WinRT window capture is the focused overlay and the option is enabled, focus the active scene app if (ConfigManager::GetValue(configid_bool_windows_winrt_auto_focus_scene_app)) { int focused_overlay_id = ConfigManager::Get().GetValue(configid_int_state_overlay_focused_id); if (focused_overlay_id != -1) { const Overlay& overlay = OverlayManager::Get().GetOverlay((unsigned int)focused_overlay_id); const OverlayConfigData& data = OverlayManager::Get().GetConfigData((unsigned int)focused_overlay_id); if ((overlay.GetTextureSource() == ovrl_texsource_winrt_capture) && (data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd] != 0)) { WindowManager::Get().FocusActiveVRSceneApp(&m_InputSim); } } } break; } case ipcact_lpointer_trigger_haptics: { m_LaserPointer.TriggerLaserPointerHaptics((vr::TrackedDeviceIndex_t)msg.lParam); break; } case ipcact_lpointer_ui_mask_rect: { if (msg.lParam == -1) { m_LaserPointer.UIIntersectionMaskFinish(); } else { DPRect rect; rect.Unpack16(msg.lParam); m_LaserPointer.UIIntersectionMaskAddRect(rect); } break; } case ipcact_app_profile_remove: { const bool loaded_overlay_profile = ConfigManager::Get().GetAppProfileManager().RemoveProfile(ConfigManager::GetValue(configid_str_state_app_profile_key)); if (loaded_overlay_profile) ResetOverlays(); break; } case ipcact_global_shortcut_set: { ActionManager::ActionList& global_shortcut_list = ConfigManager::Get().GetGlobalShortcuts(); int shortcut_id = msg.lParam; if ((shortcut_id >= 0) && (shortcut_id < (int)global_shortcut_list.size())) { global_shortcut_list[shortcut_id] = ConfigManager::GetValue(configid_handle_state_action_uid); } break; } case ipcact_hotkey_set: { ConfigHotkeyList& hotkey_list = ConfigManager::Get().GetHotkeys(); const std::string& hotkey_data = ConfigManager::GetValue(configid_str_state_hotkey_data); int hotkey_id = msg.lParam; if ((hotkey_id >= 0) && (hotkey_id < (int)hotkey_list.size())) { if (!hotkey_data.empty()) { hotkey_list[hotkey_id].Deserialize(hotkey_data); } else { hotkey_list.erase(hotkey_list.begin() + msg.lParam); } } else if (!hotkey_data.empty()) { ConfigHotkey hotkey_new; hotkey_new.Deserialize(hotkey_data); hotkey_list.push_back(hotkey_new); } RegisterHotkeys(); break; } } break; } case ipcmsg_set_config: { if (msg.wParam < configid_bool_MAX) { ConfigID_Bool bool_id = (ConfigID_Bool)msg.wParam; bool previous_value = ConfigManager::GetValue(bool_id); ConfigManager::SetValue(bool_id, msg.lParam); switch (bool_id) { case configid_bool_overlay_3D_enabled: { ApplySettingTransform(); ApplySetting3DMode(); break; } case configid_bool_overlay_3D_swapped: { ApplySetting3DMode(); break; } case configid_bool_overlay_origin_hmd_floor_use_turning: { const OverlayConfigData& data = OverlayManager::Get().GetCurrentConfigData(); OverlayOriginConfig origin_config = OverlayManager::Get().GetOriginConfigFromData(data); OverlayOriginConfig origin_config_prev = origin_config; origin_config_prev.HMDFloorUseTurning = previous_value; OverlayOrigin origin = (OverlayOrigin)data.ConfigInt[configid_int_overlay_origin]; DetachedTransformConvertOrigin(OverlayManager::Get().GetCurrentOverlayID(), origin, origin, origin_config_prev, origin_config); ApplySettingTransform(); break; } case configid_bool_overlay_enabled: case configid_bool_overlay_show_backside: case configid_bool_overlay_gazefade_enabled: case configid_bool_overlay_update_invisible: { ApplySettingTransform(); break; } case configid_bool_overlay_crop_enabled: { ApplySettingCrop(); ApplySettingTransform(); ApplySettingMouseScale(); break; } case configid_bool_overlay_winrt_window_matching_strict: { OverlayConfigData& data = OverlayManager::Get().GetCurrentConfigData(); //Check if new matching setting finds an existing window if ((OverlayManager::Get().GetCurrentOverlay().GetTextureSource() == ovrl_texsource_winrt_capture) && (data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd] != 0)) break; HWND window = WindowInfo::FindClosestWindowForTitle(data.ConfigStr[configid_str_overlay_winrt_last_window_title], data.ConfigStr[configid_str_overlay_winrt_last_window_class_name], data.ConfigStr[configid_str_overlay_winrt_last_window_exe_name], WindowManager::Get().WindowListGet(), data.ConfigBool[configid_bool_overlay_winrt_window_matching_strict]); if (window != nullptr) { data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd] = (uint64_t)window; if (ConfigManager::GetValue(configid_int_windows_winrt_capture_lost_behavior) == window_caplost_hide_overlay) { data.ConfigBool[configid_bool_overlay_enabled] = true; } OnSetOverlayWinRTCaptureWindow(OverlayManager::Get().GetCurrentOverlayID()); //Send to UI IPCManager::Get().PostConfigMessageToUIApp(configid_handle_overlay_state_winrt_hwnd, (LPARAM)window); if (ConfigManager::GetValue(configid_int_windows_winrt_capture_lost_behavior) == window_caplost_hide_overlay) { IPCManager::Get().PostConfigMessageToUIApp(configid_bool_overlay_enabled, true); } } break; } case configid_bool_overlay_input_enabled: case configid_bool_input_mouse_render_intersection_blob: { ApplySettingMouseInput(); break; } case configid_bool_input_mouse_allow_pointer_override: { //Reset Pointer override if (m_MouseIgnoreMoveEvent) { m_MouseIgnoreMoveEvent = false; ResetMouseLastLaserPointerPos(); ApplySettingMouseInput(); } break; } case configid_bool_interface_dim_ui: { DimDashboard( ((m_OvrlDashboardActive) && (msg.lParam)) ); break; } case configid_bool_performance_single_desktop_mirroring: { if (msg.lParam) //Unify the desktop IDs when turning the setting on { CropToDisplay(OverlayManager::Get().GetConfigData(0).ConfigInt[configid_int_overlay_desktop_id], true); } reset_mirroring = true; break; } case configid_bool_performance_hdr_mirroring: { reset_mirroring = true; DPWinRT_SetHDREnabled(msg.lParam); break; } case configid_bool_performance_alternative_cursor_rendering: { m_MouseCursorNeedsUpdate = true; break; } case configid_bool_input_mouse_render_cursor: { m_OutputPendingFullRefresh = true; if (DPWinRT_IsCaptureCursorEnabledPropertySupported()) DPWinRT_SetCaptureCursorEnabled(msg.lParam); break; } case configid_bool_input_mouse_scroll_smooth: { ApplySettingMouseInput(); break; } case configid_bool_input_laser_pointer_block_input: { //Set SteamVR setting to allow global overlay input as we need it for this to work. Messing with user settings is not ideal, but we're not the first to do so if ( (msg.lParam) && (!vr::VRSettings()->GetBool(vr::k_pch_SteamVR_Section, vr::k_pch_SteamVR_AllowGlobalActionSetPriority)) ) { vr::VRSettings()->SetBool(vr::k_pch_SteamVR_Section, vr::k_pch_SteamVR_AllowGlobalActionSetPriority, true); } break; } case configid_bool_input_laser_pointer_hmd_device: { //Laser pointer keyboard input hotkeys should be disabled if this setting is off RegisterHotkeys(); break; } case configid_bool_windows_winrt_keep_on_screen: { WindowManager::Get().UpdateConfigState(); break; } case configid_bool_browser_content_blocker: { DPBrowserAPIClient::Get().DPBrowser_ContentBlockSetEnabled(msg.lParam); break; } case configid_bool_state_overlay_dragmode: { //Update temporary standing position if dragmode has been activated and dashboard tab isn't active if ((msg.lParam) && (!m_OvrlDashboardActive)) { m_OverlayDragger.UpdateTempStandingPosition(); } ApplySettingInputMode(); break; } case configid_bool_state_overlay_selectmode: { ApplySettingInputMode(); break; } case configid_bool_state_misc_elevated_mode_active: { m_InputSim.SetElevatedModeForwardingActive(msg.lParam); break; } default: break; } } else if (msg.wParam < configid_bool_MAX + configid_int_MAX) { ConfigID_Int int_id = (ConfigID_Int)(msg.wParam - configid_bool_MAX); int previous_value = ConfigManager::GetValue(int_id); ConfigManager::SetValue(int_id, msg.lParam); switch (int_id) { case configid_int_interface_overlay_current_id: { OverlayManager::Get().SetCurrentOverlayID(msg.lParam); current_overlay_old = (unsigned int)msg.lParam; break; } case configid_int_interface_background_color: case configid_int_interface_background_color_display_mode: { m_BackgroundOverlay.Update(); break; } case configid_int_overlay_desktop_id: { if (ConfigManager::GetValue(configid_bool_overlay_crop_enabled)) { CropToDisplay(msg.lParam); } else //Don't touch cropping setting values if it's disabled and just update the validated crop rect instead { OverlayManager::Get().GetCurrentOverlay().UpdateValidatedCropRect(); ApplySettingCrop(); ApplySettingTransform(); ApplySettingMouseScale(); ApplySettingExtraBrightness(); } reset_mirroring = (ConfigManager::GetValue(configid_bool_performance_single_desktop_mirroring) && (msg.lParam != previous_value)); break; } case configid_int_overlay_capture_source: { ResetOverlayActiveCount(); ResetCurrentOverlay(); break; } case configid_int_overlay_winrt_desktop_id: { if (previous_value != msg.lParam) { OverlayManager::Get().GetCurrentOverlay().SetTextureSource(ovrl_texsource_none); ResetCurrentOverlay(); } break; } case configid_int_overlay_user_width: case configid_int_overlay_user_height: { if (OverlayManager::Get().GetCurrentOverlay().GetTextureSource() == ovrl_texsource_browser) { const int user_width = ConfigManager::GetValue(configid_int_overlay_user_width); const int user_height = ConfigManager::GetValue(configid_int_overlay_user_height); DPBrowserAPIClient::Get().DPBrowser_SetResolution(OverlayManager::Get().GetCurrentOverlay().GetHandle(), user_width, user_height); //Also set as content width ConfigManager::SetValue(configid_int_overlay_state_content_width, user_width); ConfigManager::SetValue(configid_int_overlay_state_content_height, user_height); //Update crop as it depends on user size if ((ConfigManager::GetValue(configid_bool_overlay_crop_enabled)) || (ConfigManager::GetValue(configid_bool_overlay_3D_enabled))) { ApplySettingCrop(); } //Send to UI IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_current_id_override, (int)OverlayManager::Get().GetCurrentOverlayID()); IPCManager::Get().PostConfigMessageToUIApp(configid_int_overlay_state_content_width, user_width); IPCManager::Get().PostConfigMessageToUIApp(configid_int_overlay_state_content_height, user_height); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_current_id_override, -1); //Also do it for everything using this as duplication source unsigned int current_overlay_old = OverlayManager::Get().GetCurrentOverlayID(); for (unsigned int overlay_id : OverlayManager::Get().FindDuplicatedOverlaysForOverlay(OverlayManager::Get().GetCurrentOverlayID())) { OverlayManager::Get().SetCurrentOverlayID(overlay_id); //Set config values for duplicated overlays as well so code only reading from it doesn't have to care about them being duplicated ConfigManager::SetValue(configid_int_overlay_user_width, user_width); ConfigManager::SetValue(configid_int_overlay_user_height, user_height); ConfigManager::SetValue(configid_int_overlay_state_content_width, user_width); ConfigManager::SetValue(configid_int_overlay_state_content_height, user_height); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_current_id_override, (int)overlay_id); IPCManager::Get().PostConfigMessageToUIApp(configid_int_overlay_state_content_width, user_width); IPCManager::Get().PostConfigMessageToUIApp(configid_int_overlay_state_content_height, user_height); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_current_id_override, -1); if (ConfigManager::GetValue(configid_bool_overlay_crop_enabled)) { ApplySettingCrop(); } } OverlayManager::Get().SetCurrentOverlayID(current_overlay_old); ApplySettingMouseInput(); } break; } case configid_int_overlay_crop_x: case configid_int_overlay_crop_y: case configid_int_overlay_crop_width: case configid_int_overlay_crop_height: { ApplySettingCrop(); ApplySettingTransform(); ApplySettingMouseScale(); break; } case configid_int_overlay_3D_mode: { ApplySettingTransform(); ApplySetting3DMode(); break; } case configid_int_overlay_display_mode: { ApplySettingTransform(); break; } case configid_int_overlay_origin: { DetachedTransformConvertOrigin(OverlayManager::Get().GetCurrentOverlayID(), (OverlayOrigin)previous_value, (OverlayOrigin)msg.lParam); ApplySettingTransform(); break; } case configid_int_overlay_origin_smoothing_level: { //Reset smoothers if there was previously no smoothing enabled if (previous_value == 0) { Overlay& overlay = OverlayManager::Get().GetCurrentOverlay(); overlay.GetSmootherPos().ResetLastPos(); overlay.GetSmootherRot().ResetLastPos(); } ApplySettingTransform(); break; } case configid_int_overlay_browser_max_fps_override: { if (OverlayManager::Get().GetCurrentOverlay().GetTextureSource() == ovrl_texsource_browser) { DPBrowserAPIClient::Get().DPBrowser_SetFPS(OverlayManager::Get().GetCurrentOverlay().GetHandle(), msg.lParam); } break; } case configid_int_interface_wmr_ignore_vscreens: { DPWinRT_SetDesktopEnumerationFlags((msg.lParam == 1)); //May affect desktop enumeration, reset mirroring reset_mirroring = true; break; } case configid_int_input_mouse_dbl_click_assist_duration_ms: { ApplySettingMouseInput(); break; } case configid_int_input_laser_pointer_hmd_device_keycode_toggle: case configid_int_input_laser_pointer_hmd_device_keycode_left: case configid_int_input_laser_pointer_hmd_device_keycode_right: case configid_int_input_laser_pointer_hmd_device_keycode_middle: { RegisterHotkeys(); break; } case configid_int_windows_winrt_dragging_mode: { WindowManager::Get().UpdateConfigState(); break; } case configid_int_performance_update_limit_mode: case configid_int_performance_update_limit_fps: case configid_int_overlay_update_limit_override_mode: case configid_int_overlay_update_limit_override_fps: { ApplySettingUpdateLimiter(); break; } case configid_int_browser_max_fps: { DPBrowserAPIClient::Get().DPBrowser_GlobalSetFPS(msg.lParam); break; } default: break; } } else if (msg.wParam < configid_bool_MAX + configid_int_MAX + configid_float_MAX) { ConfigID_Float float_id = (ConfigID_Float)(msg.wParam - configid_bool_MAX - configid_int_MAX); float value = pun_cast(msg.lParam); float previous_value = ConfigManager::GetValue(float_id); ConfigManager::SetValue(float_id, value); switch (float_id) { case configid_float_overlay_width: case configid_float_overlay_curvature: case configid_float_overlay_opacity: case configid_float_overlay_brightness: case configid_float_overlay_offset_right: case configid_float_overlay_offset_up: case configid_float_overlay_offset_forward: { ApplySettingTransform(); break; } case configid_float_overlay_browser_zoom: { if (OverlayManager::Get().GetCurrentOverlay().GetTextureSource() == ovrl_texsource_browser) { DPBrowserAPIClient::Get().DPBrowser_SetZoomLevel(OverlayManager::Get().GetCurrentOverlay().GetHandle(), value); } break; } case configid_float_performance_update_limit_ms: case configid_float_overlay_update_limit_override_ms: { ApplySettingUpdateLimiter(); break; } default: break; } } else if (msg.wParam < configid_bool_MAX + configid_int_MAX + configid_float_MAX + configid_handle_MAX) { ConfigID_Handle handle_id = (ConfigID_Handle)(msg.wParam - configid_bool_MAX - configid_int_MAX - configid_float_MAX); uint64_t value = pun_cast(msg.lParam); uint64_t previous_value = ConfigManager::GetValue(handle_id); ConfigManager::SetValue(handle_id, value); switch (handle_id) { case configid_handle_overlay_state_winrt_hwnd: { if (value != previous_value) { OnSetOverlayWinRTCaptureWindow(OverlayManager::Get().GetCurrentOverlayID()); } break; } } } break; } } //Restore overlay id override if (overlay_override_id != -1) { OverlayManager::Get().SetCurrentOverlayID(current_overlay_old); } return reset_mirroring; } void OutputManager::HandleWinRTMessage(const MSG& msg) { switch (msg.message) { case WM_DPLUSWINRT_SIZE: { const unsigned int overlay_id = OverlayManager::Get().FindOverlayID(msg.wParam); if (overlay_id == k_ulOverlayID_None) { break; } const int content_width = GET_X_LPARAM(msg.lParam); const int content_height = GET_Y_LPARAM(msg.lParam); const Overlay& overlay = OverlayManager::Get().GetOverlay(overlay_id); OverlayConfigData& data = OverlayManager::Get().GetConfigData(overlay_id); //Skip if no real change if ((data.ConfigInt[configid_int_overlay_state_content_width] == content_width) && (data.ConfigInt[configid_int_overlay_state_content_height] == content_height)) { break; } //Adaptive Size bool adaptive_size_apply = ( (ConfigManager::GetValue(configid_bool_windows_winrt_auto_size_overlay)) && (overlay.GetTextureSource() == ovrl_texsource_winrt_capture) && (data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd] != 0) && (data.ConfigInt[configid_int_overlay_state_content_width] != -1) && (content_width != -1) ); if (adaptive_size_apply) { data.ConfigFloat[configid_float_overlay_width] *= (float)content_width / data.ConfigInt[configid_int_overlay_state_content_width]; } data.ConfigInt[configid_int_overlay_state_content_width] = content_width; data.ConfigInt[configid_int_overlay_state_content_height] = content_height; //Send update to UI IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_current_id_override, (int)overlay_id); IPCManager::Get().PostConfigMessageToUIApp(configid_int_overlay_state_content_width, content_width); IPCManager::Get().PostConfigMessageToUIApp(configid_int_overlay_state_content_height, content_height); if (adaptive_size_apply) { IPCManager::Get().PostConfigMessageToUIApp(configid_float_overlay_width, data.ConfigFloat[configid_float_overlay_width]); } IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_current_id_override, -1); //Apply change to overlay unsigned int current_overlay_old = OverlayManager::Get().GetCurrentOverlayID(); OverlayManager::Get().SetCurrentOverlayID(overlay_id); ApplySettingCrop(); ApplySettingTransform(); ApplySettingMouseScale(); OverlayManager::Get().SetCurrentOverlayID(current_overlay_old); break; } case WM_DPLUSWINRT_CAPTURE_LOST: { const unsigned int overlay_id = OverlayManager::Get().FindOverlayID(msg.wParam); if (overlay_id == k_ulOverlayID_None) { break; } Overlay& overlay = OverlayManager::Get().GetOverlay(overlay_id); OverlayConfigData& data = OverlayManager::Get().GetConfigData(overlay_id); //Hide affected overlay if setting enabled if ( (data.ConfigBool[configid_bool_overlay_enabled]) && (ConfigManager::GetValue(configid_int_windows_winrt_capture_lost_behavior) == window_caplost_hide_overlay) ) { unsigned int current_overlay_old = OverlayManager::Get().GetCurrentOverlayID(); OverlayManager::Get().SetCurrentOverlayID(overlay_id); data.ConfigBool[configid_bool_overlay_enabled] = false; ApplySettingTransform(); OverlayManager::Get().SetCurrentOverlayID(current_overlay_old); //Send to UI IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_current_id_override, (int)overlay_id); IPCManager::Get().PostConfigMessageToUIApp(configid_bool_overlay_enabled, false); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_current_id_override, -1); } else if (ConfigManager::GetValue(configid_int_windows_winrt_capture_lost_behavior) == window_caplost_remove_overlay) //Or remove it { //Queue up removal instead of doing it right away in case there are multiple overlays with the same target lost at once (which breaks otherwise) m_RemoveOverlayQueue.push_back(overlay_id); break; } //Only change texture source if the overlay is still a winrt capture (this can be false when a picker gets canceled late) if ( (data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_winrt_capture) || (overlay.GetTextureSource() == ovrl_texsource_winrt_capture) ) { overlay.SetTextureSource(ovrl_texsource_none); } break; } case WM_DPLUSWINRT_THREAD_ERROR: { //We get capture lost messages for each affected overlay, so just forward the error to the UI so a warning can be displayed for now IPCManager::Get().PostMessageToUIApp(ipcmsg_action, ipcact_winrt_thread_error, msg.lParam); LOG_F(ERROR, "Unexpected error occurred in a Graphics Capture thread! (%#x)", (unsigned int)msg.lParam); break; } case WM_DPLUSWINRT_FPS: { const unsigned int overlay_id = OverlayManager::Get().FindOverlayID(msg.wParam); if (overlay_id == k_ulOverlayID_None) { break; } OverlayConfigData& data = OverlayManager::Get().GetConfigData(overlay_id); data.ConfigInt[configid_int_overlay_state_fps] = msg.lParam; //Send update to UI IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_current_id_override, (int)overlay_id); IPCManager::Get().PostConfigMessageToUIApp(configid_int_overlay_state_fps, msg.lParam); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_current_id_override, -1); break; } } } void OutputManager::HandleHotkeyMessage(const MSG& msg) { ConfigHotkeyList& hotkey_list = ConfigManager::Get().GetHotkeys(); int hotkey_id = msg.wParam; if ((hotkey_id >= 0) && (hotkey_id < (int)hotkey_list.size())) { ConfigHotkey& hotkey = hotkey_list[hotkey_id]; //StateIsDown blocks HandleHotkeys() and the hotkey messages from triggering hotkey actions twice. It's reset in HandleHotkeys() when the key is no longer pressed if (!hotkey.StateIsDown) { ConfigManager::Get().GetActionManager().DoAction(hotkey.ActionUID); hotkey.StateIsDown = true; } } } void OutputManager::OnExit() { //Release all held keyboard keys. Might be going overboard but better than keeping keys down unexpectedly for (int i = 0; i < 256; ++i) { m_InputSim.KeyboardSetKeyState((IPCKeyboardKeystateFlags)0, i); } //Undo dimmed dashboard DimDashboard(false); //Shutdown VR for good vr::VR_Shutdown(); } HWND OutputManager::GetWindowHandle() { return m_WindowHandle; } // // Returns shared handle // HANDLE OutputManager::GetSharedHandle() { HANDLE Hnd = nullptr; // QI IDXGIResource interface to synchronized shared surface. IDXGIResource* DXGIResource = nullptr; HRESULT hr = m_SharedSurf->QueryInterface(__uuidof(IDXGIResource), reinterpret_cast(&DXGIResource)); if (SUCCEEDED(hr)) { // Obtain handle to IDXGIResource object. DXGIResource->GetSharedHandle(&Hnd); DXGIResource->Release(); DXGIResource = nullptr; } return Hnd; } IDXGIAdapter* OutputManager::GetDXGIAdapter() { HRESULT hr; // Get DXGI factory IDXGIDevice* DxgiDevice = nullptr; hr = m_Device->QueryInterface(__uuidof(IDXGIDevice), reinterpret_cast(&DxgiDevice)); if (FAILED(hr)) { return nullptr; } IDXGIAdapter* DxgiAdapter = nullptr; hr = DxgiDevice->GetParent(__uuidof(IDXGIAdapter), reinterpret_cast(&DxgiAdapter)); DxgiDevice->Release(); DxgiDevice = nullptr; if (FAILED(hr)) { return nullptr; } return DxgiAdapter; } void OutputManager::ResetOverlays() { //Check if process is elevated and send that info to the UI too (DPBrowser needs this info so do this first) bool elevated = IsProcessElevated(); ConfigManager::SetValue(configid_bool_state_misc_process_elevated, elevated); IPCManager::Get().PostConfigMessageToUIApp(configid_bool_state_misc_process_elevated, elevated); //Reset all overlays unsigned int current_overlay_old = OverlayManager::Get().GetCurrentOverlayID(); for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { OverlayManager::Get().SetCurrentOverlayID(i); ApplySettingCrop(); ApplySettingTransform(); ApplySettingCaptureSource(); ApplySetting3DMode(); } //Second pass for browser overlays using a duplication ID that is higher than the overlay's for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { OverlayManager::Get().SetCurrentOverlayID(i); const OverlayConfigData& data = OverlayManager::Get().GetCurrentConfigData(); if ( (data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_browser) && (data.ConfigInt[configid_int_overlay_duplication_id] != -1) ) { ApplySettingCrop(); ApplySettingCaptureSource(); ApplySetting3DMode(); } } OverlayManager::Get().SetCurrentOverlayID(current_overlay_old); //These apply to all overlays within the function itself ApplySettingInputMode(); ApplySettingUpdateLimiter(); ResetOverlayActiveCount(); //Post overlays reset message to UI app IPCManager::Get().PostMessageToUIApp(ipcmsg_action, ipcact_overlays_reset); //Make sure that the entire overlay texture gets at least one full update for regions that will never be dirty (i.e. blank space not occupied by any desktop) m_OutputPendingFullRefresh = true; } void OutputManager::ResetCurrentOverlay() { if ((OverlayManager::Get().GetCurrentOverlayID() == k_ulOverlayID_None) || (OverlayManager::Get().GetCurrentOverlay().GetID() == k_ulOverlayID_None)) return; ApplySettingCrop(); ApplySettingTransform(); ApplySettingCaptureSource(); ApplySettingInputMode(); ApplySetting3DMode(); ApplySettingUpdateLimiter(); //Make sure that the entire overlay texture gets at least one full update for regions that will never be dirty (i.e. blank space not occupied by any desktop) if (ConfigManager::GetValue(configid_int_overlay_capture_source) == ovrl_capsource_desktop_duplication) { m_OutputPendingFullRefresh = true; } } ID3D11Texture2D* OutputManager::GetOverlayTexture() const { return m_OvrlTex; } ID3D11Texture2D* OutputManager::GetMultiGPUTargetTexture() const { return m_MultiGPUTexTarget; } vr::VROverlayHandle_t OutputManager::GetDesktopTextureOverlay() const { return m_OvrlHandleDesktopTexture; } bool OutputManager::GetOverlayActive() const { return (m_OvrlActiveCount != 0); } bool OutputManager::GetOverlayInputActive() const { return m_OvrlInputActive; } DWORD OutputManager::GetMaxRefreshDelay() const { if ( (m_OvrlActiveCount != 0) || (m_OvrlDashboardActive) || (m_LaserPointer.IsActive()) ) { //Actually causes extreme load while not really being necessary (looks nice tho) if ( (m_OvrlInputActive) && (ConfigManager::GetValue(configid_bool_performance_rapid_laser_pointer_updates)) ) { return 0; } else if (m_LaserPointer.IsScrolling()) { //While scrolling with the Desktop+ Laser Pointer, we actually need to update frequently to keep scroll speeds and generated haptic feedback at the usual pace return 3; } else if (m_OvrlInputActive) { //While input is active, especially with the HMD pointer, we need to update more frequently to allow for smooth cursor movements return m_MaxActiveRefreshDelay / 2; } else { return m_MaxActiveRefreshDelay; } } else if ( (m_VRInput.IsAnyGlobalActionBound()) || (IsAnyOverlayUsingGazeFade()) || (m_IsAnyHotkeyActive) ) { return m_MaxActiveRefreshDelay * 2; } else { return 300; } } float OutputManager::GetHMDFrameRate() const { return vr::VRSystem()->GetFloatTrackedDeviceProperty(vr::k_unTrackedDeviceIndex_Hmd, vr::Prop_DisplayFrequency_Float); } int OutputManager::GetDesktopWidth() const { return m_DesktopWidth; } int OutputManager::GetDesktopHeight() const { return m_DesktopHeight; } const std::vector& OutputManager::GetDesktopRects() const { return m_DesktopRects; } float OutputManager::GetDesktopHDRWhiteLevelAdjustment(int desktop_id, bool is_for_graphics_capture, bool wmr_ignore_vscreens) const { #ifdef DPLUS_DUP_NO_HDR return 1.0f; #else if (desktop_id == -1) desktop_id = 0; if ((!m_OutputHDRAvailable) && (!is_for_graphics_capture)) return 1.0f; DXGI_OUTPUT_DESC output_desc = {}; Microsoft::WRL::ComPtr factory_ptr; //This needs to go through DXGI as QueryDisplayConfig()'s order can be different HRESULT hr = CreateDXGIFactory1(__uuidof(IDXGIFactory1), (void**)&factory_ptr); if (!FAILED(hr)) { Microsoft::WRL::ComPtr adapter_ptr; UINT i = 0; int output_count = 0; while (factory_ptr->EnumAdapters(i, &adapter_ptr) != DXGI_ERROR_NOT_FOUND) { //Check if this a WMR virtual display adapter and skip it when the option is enabled if (wmr_ignore_vscreens) { DXGI_ADAPTER_DESC adapter_desc; adapter_ptr->GetDesc(&adapter_desc); if (wcscmp(adapter_desc.Description, L"Virtual Display Adapter") == 0) { ++i; continue; } } //Enum the available outputs Microsoft::WRL::ComPtr output_ptr; UINT output_index = 0; while (adapter_ptr->EnumOutputs(output_index, &output_ptr) != DXGI_ERROR_NOT_FOUND) { //Check if this happens to be the output we're looking for if (desktop_id == output_count) { //Get output desc output_ptr->GetDesc(&output_desc); } ++output_index; ++output_count; } ++i; } } //Find display config with the same device path std::vector paths; std::vector modes; const UINT32 flags = QDC_ONLY_ACTIVE_PATHS | QDC_VIRTUAL_MODE_AWARE; LONG result = ERROR_SUCCESS; //Loop until buffer allocation for paths match the requirements do { UINT32 path_count, mode_count; result = ::GetDisplayConfigBufferSizes(flags, &path_count, &mode_count); if (result != ERROR_SUCCESS) { LOG_F(ERROR, "GetDisplayConfigBufferSizes() failed with %ld", result); return 1.0f; } paths.resize(path_count); modes.resize(mode_count); result = ::QueryDisplayConfig(flags, &path_count, paths.data(), &mode_count, modes.data(), nullptr); paths.resize(path_count); modes.resize(mode_count); } while (result == ERROR_INSUFFICIENT_BUFFER); if (result != ERROR_SUCCESS) { LOG_F(ERROR, "QueryDisplayConfig() failed with %ld", result); return 1.0f; } //Check each active path for (auto& path : paths) { DISPLAYCONFIG_SOURCE_DEVICE_NAME source_name = {}; source_name.header.adapterId = path.sourceInfo.adapterId; source_name.header.id = path.sourceInfo.id; source_name.header.type = DISPLAYCONFIG_DEVICE_INFO_GET_SOURCE_NAME; source_name.header.size = sizeof(source_name); result = ::DisplayConfigGetDeviceInfo(&source_name.header); if (result == ERROR_SUCCESS) { if (wcscmp(source_name.viewGdiDeviceName, output_desc.DeviceName) == 0) { //Found the right display config path, time to grab the data bool is_hdr_enabled = false; bool is_8bit = true; ULONG sdr_white_level = 1000; #if (NTDDI_VERSION >= 0x0A00000F/*NTDDI_WIN11_GA*/) DISPLAYCONFIG_GET_ADVANCED_COLOR_INFO_2 adv_color_info_2 = {}; adv_color_info_2.header.adapterId = path.targetInfo.adapterId; adv_color_info_2.header.id = path.targetInfo.id; adv_color_info_2.header.type = DISPLAYCONFIG_DEVICE_INFO_GET_ADVANCED_COLOR_INFO_2; adv_color_info_2.header.size = sizeof(adv_color_info_2); result = ::DisplayConfigGetDeviceInfo(&adv_color_info_2.header); if (result == ERROR_SUCCESS) { is_8bit = (adv_color_info_2.bitsPerColorChannel == 8); //DISPLAYCONFIG_ADVANCED_COLOR_MODE_WCG is still higher bit-depth but seems like it needs to be handled differently is_hdr_enabled = (adv_color_info_2.activeColorMode == DISPLAYCONFIG_ADVANCED_COLOR_MODE_HDR); } if (is_hdr_enabled) { DISPLAYCONFIG_SDR_WHITE_LEVEL config_sdr_white_level = {}; config_sdr_white_level.header.adapterId = path.targetInfo.adapterId; config_sdr_white_level.header.id = path.targetInfo.id; config_sdr_white_level.header.type = DISPLAYCONFIG_DEVICE_INFO_GET_SDR_WHITE_LEVEL; config_sdr_white_level.header.size = sizeof(sdr_white_level); result = ::DisplayConfigGetDeviceInfo(&config_sdr_white_level.header); if (result == ERROR_SUCCESS) { sdr_white_level = config_sdr_white_level.SDRWhiteLevel; } } #endif DISPLAYCONFIG_GET_ADVANCED_COLOR_INFO adv_color_info = {}; adv_color_info.header.adapterId = path.targetInfo.adapterId; adv_color_info.header.id = path.targetInfo.id; adv_color_info.header.type = DISPLAYCONFIG_DEVICE_INFO_GET_ADVANCED_COLOR_INFO; adv_color_info.header.size = sizeof(adv_color_info); result = ::DisplayConfigGetDeviceInfo(&adv_color_info.header); if (result == ERROR_SUCCESS) { is_8bit = (adv_color_info.bitsPerColorChannel == 8); } //The following is based on potentially incomplete observations and doesn't appear to be documented anywhere otherwise //Checking different OS versions without access to a HDR display in a VM makes things a little bit messy... so this likely needs to be fixed up later if (is_8bit) { //This the easiest to check and has been observed across several Windows 10 and 11 versions, why it's like this I don't know return (is_for_graphics_capture) ? 0.5f : 1.0f; } else if (is_hdr_enabled) { //Observed on Windows 11 24H2, but not on Windows 10 (DISPLAYCONFIG_GET_ADVANCED_COLOR_INFO_2 doesn't exist there so it won't hit this path) return 1000.0f / sdr_white_level; } else { //Observed on Windows 10 20H2, but potentially always applies to DISPLAYCONFIG_ADVANCED_COLOR_MODE_WCG in general and DISPLAYCONFIG_ADVANCED_COLOR_MODE_HDR doesn't exist there? //However, also observed displays set to HDR get non-linear pixel data written by Desktop Duplication on there (Graphics Capture and Desktop Duplication non-HDR display pixels are correct) //Might have some unknown factor causing it, even if fixable with extra steps in theory... so it is what it is for now. return (is_for_graphics_capture) ? 0.5f : 1.0f; } } } } LOG_F(WARNING, "Could not find display config for desktop %d, defaulting to 100%% brightness adjustment", desktop_id); return 1.0f; #endif //DPLUS_DUP_NO_HDR } void OutputManager::ShowOverlay(unsigned int id) { Overlay& overlay = OverlayManager::Get().GetOverlay(id); if (overlay.IsVisible()) //Already visible? Abort. { return; } unsigned int current_overlay_old = OverlayManager::Get().GetCurrentOverlayID(); OverlayManager::Get().SetCurrentOverlayID(id); vr::VROverlayHandle_t ovrl_handle = overlay.GetHandle(); const OverlayConfigData& data = OverlayManager::Get().GetConfigData(id); if (m_OvrlActiveCount == 0) //First overlay to become active { ::timeBeginPeriod(1); //This is somewhat frowned upon, but we want to hit the polling rate, it's only when active and we're in a high performance situation anyways //Set last pointer values to current to not trip the movement detection up ResetMouseLastLaserPointerPos(); m_MouseIgnoreMoveEvent = false; WindowManager::Get().SetOverlayActive(true); } m_OvrlActiveCount++; if (data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_desktop_duplication) { if (m_OvrlDesktopDuplActiveCount == 0) //First Desktop Duplication overlay to become active { //Signal duplication threads to resume in case they're paused ::ResetEvent(m_PauseDuplicationEvent); ::SetEvent(m_ResumeDuplicationEvent); ForceScreenRefresh(); } m_OvrlDesktopDuplActiveCount++; } else if (data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_winrt_capture) { //Unpause capture DPWinRT_PauseCapture(ovrl_handle, false); } else if (data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_browser) { //Don't call this before texture source is set (browser process may not be running), ApplySettingCaptureSource() will call it in that case if (overlay.GetTextureSource() == ovrl_texsource_browser) { //Unpause browser DPBrowserAPIClient::Get().DPBrowser_PauseBrowser(overlay.GetHandle(), false); } } overlay.SetVisible(true); ApplySettingTransform(); //Overlay could affect update limiter, so apply setting if (data.ConfigInt[configid_int_overlay_update_limit_override_mode] != update_limit_mode_off) { ApplySettingUpdateLimiter(); } //If the last clipping rect doesn't fully contain the overlay's crop rect, the desktop texture overlay is probably outdated there, so force a full refresh if ( (data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_desktop_duplication) && (!m_OutputLastClippingRect.Contains(overlay.GetValidatedCropRect())) ) { RefreshOpenVROverlayTexture(DPRect(-1, -1, -1, -1), true); } OverlayManager::Get().SetCurrentOverlayID(current_overlay_old); } void OutputManager::ShowTheaterOverlay(unsigned int id) { if (OverlayManager::Get().GetTheaterOverlayID() == id) return; //Don't set theater overlay before texture source is initialized if (OverlayManager::Get().GetOverlay(id).GetTextureSource() == ovrl_texsource_invalid) return; OverlayManager::Get().SetTheaterOverlayID(id); //Check every other existing overlay for theater origin and disable them (only one theater overlay can be active) for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { Overlay& overlay = OverlayManager::Get().GetOverlay(i); OverlayConfigData& data = OverlayManager::Get().GetConfigData(i); if ((data.ConfigInt[configid_int_overlay_origin] == ovrl_origin_theater_screen) && (i != id)) { SetOverlayEnabled(i, false); } } //Reset overlay so the theater overlay has every property applied unsigned int current_overlay_old = OverlayManager::Get().GetCurrentOverlayID(); OverlayManager::Get().SetCurrentOverlayID(id); ResetCurrentOverlay(); OverlayManager::Get().GetCurrentOverlay().AssignDesktopDuplicationTexture(); //Desktop Duplication texture isn't reset and only assigned on change, so do it manually OverlayManager::Get().SetCurrentOverlayID(current_overlay_old); } void OutputManager::HideOverlay(unsigned int id) { Overlay& overlay = OverlayManager::Get().GetOverlay(id); if (!overlay.IsVisible()) //Already hidden? Abort. { return; } unsigned int current_overlay_old = OverlayManager::Get().GetCurrentOverlayID(); OverlayManager::Get().SetCurrentOverlayID(id); vr::VROverlayHandle_t ovrl_handle = overlay.GetHandle(); const OverlayConfigData& data = OverlayManager::Get().GetConfigData(id); overlay.SetVisible(false); //Overlay could've affected update limiter, so apply setting if (data.ConfigInt[configid_int_overlay_update_limit_override_mode] != update_limit_mode_off) { ApplySettingUpdateLimiter(); } m_OvrlActiveCount--; if (m_OvrlActiveCount == 0) //Last overlay to become inactive { ::timeEndPeriod(1); WindowManager::Get().SetOverlayActive(false); } if (data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_desktop_duplication) { m_OvrlDesktopDuplActiveCount--; if (m_OvrlDesktopDuplActiveCount == 0) //Last Desktop Duplication overlay to become inactive { //Signal duplication threads to pause since we don't need them to do needless work ::ResetEvent(m_ResumeDuplicationEvent); ::SetEvent(m_PauseDuplicationEvent); } } else if (data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_winrt_capture) { //Pause capture DPWinRT_PauseCapture(ovrl_handle, true); } else if (data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_browser) { //Don't call this before texture source is set (browser process may not be running), ApplySettingCaptureSource() will call it in that case if (overlay.GetTextureSource() == ovrl_texsource_browser) { //Pause browser DPBrowserAPIClient::Get().DPBrowser_PauseBrowser(overlay.GetHandle(), true); } } OverlayManager::Get().SetCurrentOverlayID(current_overlay_old); } void OutputManager::ResetOverlayActiveCount() { bool desktop_duplication_was_paused = (m_OvrlDesktopDuplActiveCount == 0); m_OvrlActiveCount = 0; m_OvrlDesktopDuplActiveCount = 0; //Check every existing overlay for visibility and count them as active for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { Overlay& overlay = OverlayManager::Get().GetOverlay(i); OverlayConfigData& data = OverlayManager::Get().GetConfigData(i); if (overlay.IsVisible()) { m_OvrlActiveCount++; if (data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_desktop_duplication) { m_OvrlDesktopDuplActiveCount++; } } } //Fixup desktop duplication state if ( (desktop_duplication_was_paused) && (m_OvrlDesktopDuplActiveCount > 0) ) { //Signal duplication threads to resume ::ResetEvent(m_PauseDuplicationEvent); ::SetEvent(m_ResumeDuplicationEvent); ForceScreenRefresh(); } else if ( (!desktop_duplication_was_paused) && (m_OvrlDesktopDuplActiveCount == 0) ) { //Signal duplication threads to pause ::ResetEvent(m_ResumeDuplicationEvent); ::SetEvent(m_PauseDuplicationEvent); } //Fixup WindowManager state WindowManager::Get().SetOverlayActive( (m_OvrlActiveCount > 0) ); } bool OutputManager::HasDashboardBeenActivatedOnce() const { return m_DashboardActivatedOnce; } bool OutputManager::IsDashboardTabActive() const { return m_OvrlDashboardActive; } float OutputManager::GetDashboardScale() const { vr::HmdMatrix34_t matrix = {0}; vr::VROverlay()->GetTransformForOverlayCoordinates(m_OvrlHandleDashboardDummy, vr::TrackingUniverseStanding, {0.5f, 0.5f}, &matrix); Vector3 row_1(matrix.m[0][0], matrix.m[1][0], matrix.m[2][0]); return row_1.length(); //Scaling is always uniform so we just check the x-axis } float OutputManager::GetOverlayHeight(unsigned int overlay_id) const { const Overlay& overlay = OverlayManager::Get().GetOverlay(overlay_id); const OverlayConfigData& data = OverlayManager::Get().GetConfigData(overlay_id); const DPRect& crop_rect = overlay.GetValidatedCropRect(); int crop_width = crop_rect.GetWidth(), crop_height = crop_rect.GetHeight(); bool is_3d_enabled = data.ConfigBool[configid_bool_overlay_3D_enabled]; int mode_3d = data.ConfigInt[configid_int_overlay_3D_mode]; if ( (data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_desktop_duplication) && (m_OutputInvalid) ) //No cropping on invalid output image { crop_width = k_lOverlayOutputErrorTextureWidth; crop_height = k_lOverlayOutputErrorTextureHeight; is_3d_enabled = false; } else if ( (overlay.GetTextureSource() == ovrl_texsource_none) || (crop_width <= 0) || (crop_height <= 0) ) { //Get dimensions from mouse scale if possible vr::HmdVector2_t mouse_scale; if (vr::VROverlay()->GetOverlayMouseScale(overlay.GetHandle(), &mouse_scale) == vr::VROverlayError_None) { crop_width = mouse_scale.v[0]; crop_height = mouse_scale.v[1]; } else { crop_width = k_lOverlayOutputErrorTextureWidth; crop_height = k_lOverlayOutputErrorTextureHeight; } is_3d_enabled = false; } else if ( (is_3d_enabled) && (mode_3d == ovrl_3Dmode_ou) ) //Converted Over-Under changes texture dimensions, so adapt { crop_width *= 2; crop_height /= 2; } //Overlay is twice as tall when SBS3D/OU3D is active if ( (is_3d_enabled) && ( (mode_3d == ovrl_3Dmode_sbs) || (mode_3d == ovrl_3Dmode_ou) ) ) crop_height *= 2; return data.ConfigFloat[configid_float_overlay_width] * ((float)crop_height / crop_width); } Matrix4 OutputManager::GetFallbackOverlayTransform() const { Matrix4 transform; //Get HMD pose vr::TrackedDevicePose_t poses[vr::k_unTrackedDeviceIndex_Hmd + 1]; vr::VRSystem()->GetDeviceToAbsoluteTrackingPose(vr::TrackingUniverseStanding, vr::IVRSystemEx::GetTimeNowToPhotons(), poses, vr::k_unTrackedDeviceIndex_Hmd + 1); if (poses[vr::k_unTrackedDeviceIndex_Hmd].bPoseIsValid) { //Set to HMD position and offset 2m away Matrix4 mat_hmd(poses[vr::k_unTrackedDeviceIndex_Hmd].mDeviceToAbsoluteTracking); transform = mat_hmd; transform.translate_relative(0.0f, 0.0f, -2.0f); //Rotate towards HMD position vr::IVRSystemEx::TransformLookAt(transform, mat_hmd.getTranslation()); } return transform; } void OutputManager::SetOutputErrorTexture(vr::VROverlayHandle_t overlay_handle) { vr::EVROverlayError vr_error = vr::VROverlayEx()->SetOverlayFromFileEx(overlay_handle, (ConfigManager::Get().GetApplicationPath() + "images/output_error.png").c_str()); vr::VRTextureBounds_t tex_bounds = {0.0f}; tex_bounds.uMax = 1.0f; tex_bounds.vMax = 1.0f; vr::VROverlay()->SetOverlayTextureBounds(overlay_handle, &tex_bounds); //Make sure to remove 3D on the overlay too vr::VROverlay()->SetOverlayFlag(overlay_handle, vr::VROverlayFlags_SideBySide_Parallel, false); vr::VROverlay()->SetOverlayFlag(overlay_handle, vr::VROverlayFlags_SideBySide_Crossed, false); vr::VROverlay()->SetOverlayTexelAspect(overlay_handle, 1.0f); //Mouse scale needs to be updated as well ApplySettingMouseInput(); } void OutputManager::SetOutputInvalid() { LOG_F(WARNING, "No outputs available!"); m_OutputInvalid = true; SetOutputErrorTexture(m_OvrlHandleDesktopTexture); m_DesktopWidth = k_lOverlayOutputErrorTextureWidth; m_DesktopHeight = k_lOverlayOutputErrorTextureHeight; ResetOverlays(); } bool OutputManager::IsOutputInvalid() const { return m_OutputInvalid; } void OutputManager::SetOverlayEnabled(unsigned int overlay_id, bool is_enabled) { OverlayConfigData& data = OverlayManager::Get().GetConfigData(overlay_id); if (data.ConfigBool[configid_bool_overlay_enabled] == is_enabled) return; data.ConfigBool[configid_bool_overlay_enabled] = is_enabled; unsigned int current_overlay_old = OverlayManager::Get().GetCurrentOverlayID(); OverlayManager::Get().SetCurrentOverlayID(overlay_id); ApplySettingTransform(); OverlayManager::Get().SetCurrentOverlayID(current_overlay_old); //Sync change IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_current_id_override, overlay_id); IPCManager::Get().PostConfigMessageToUIApp(configid_bool_overlay_enabled, data.ConfigBool[configid_bool_overlay_enabled]); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_current_id_override, -1); } void OutputManager::CropToActiveWindowToggle(unsigned int overlay_id) { //If the action is used with one of the controller buttons, the events will fire another time if the new cropping values happen to have the laser pointer leave and //re-enter the overlay for a split second while the button is still down during the dimension change. //This would immediately undo the action, which we want to prevent, so a 100 ms pause between toggles is enforced //-Currently not actually enforcing this with the new action commands to see where this goes- static ULONGLONG last_toggle_tick = 0; if ((overlay_id == k_ulOverlayID_None) /*|| (::GetTickCount64() <= last_toggle_tick + 100)*/) return; last_toggle_tick = ::GetTickCount64(); unsigned int current_overlay_old = OverlayManager::Get().GetCurrentOverlayID(); OverlayManager::Get().SetCurrentOverlayID(overlay_id); bool& crop_enabled = ConfigManager::GetRef(configid_bool_overlay_crop_enabled); int& crop_x = ConfigManager::GetRef(configid_int_overlay_crop_x); int& crop_y = ConfigManager::GetRef(configid_int_overlay_crop_y); int& crop_width = ConfigManager::GetRef(configid_int_overlay_crop_width); int& crop_height = ConfigManager::GetRef(configid_int_overlay_crop_height); //Check if crop is just exactly the current desktop bool crop_equals_current_desktop = false; const int desktop_id = ConfigManager::GetValue(configid_int_overlay_desktop_id); if ( (desktop_id >= 0) && (desktop_id < m_DesktopRects.size()) ) { DPRect crop_rect(crop_x, crop_y, crop_x + crop_width, crop_y + crop_height); crop_equals_current_desktop = (crop_rect == m_DesktopRects[desktop_id]); } //Check if crop already matches the active window bool crop_equals_new_window_crop = false; int crop_x_new = crop_x; int crop_y_new = crop_y; int crop_width_new = crop_width; int crop_height_new = crop_height; if (CropToActiveWindow(crop_x_new, crop_y_new, crop_width_new, crop_height_new)) { crop_equals_new_window_crop = ((crop_x == crop_x_new) && (crop_y == crop_y_new) && (crop_width == crop_width_new) && (crop_height == crop_height_new)); } //If uncropped or different, crop to active window if ( (!crop_enabled) || (!crop_equals_new_window_crop) ) { CropToActiveWindow(); } else //Otherwise, disable cropping (leaving the existing cropping values around) { crop_enabled = false; IPCManager::Get().PostConfigMessageToUIApp(configid_bool_overlay_crop_enabled, crop_enabled); ApplySettingCrop(); ApplySettingTransform(); ApplySettingMouseScale(); } OverlayManager::Get().SetCurrentOverlayID(current_overlay_old); } void OutputManager::ShowWindowSwitcher() { InitComIfNeeded(); Microsoft::WRL::ComPtr shell_dispatch; HRESULT sc = ::CoCreateInstance(CLSID_Shell, nullptr, CLSCTX_SERVER, IID_PPV_ARGS(&shell_dispatch)); if (SUCCEEDED(sc)) { shell_dispatch->WindowSwitcher(); } } void OutputManager::SwitchToWindow(HWND window, bool warp_cursor) { WindowManager::Get().RaiseAndFocusWindow(window, &m_InputSim); if (warp_cursor) { //Figure out center point of the window and put the cursor there RECT window_rect = {0}; //Just using GetWindowRect() can include shadows and such, which we don't want if (::DwmGetWindowAttribute(window, DWMWA_EXTENDED_FRAME_BOUNDS, &window_rect, sizeof(window_rect)) == S_OK) { DPRect window_dprect(window_rect.left, window_rect.top, window_rect.right, window_rect.bottom); Vector2Int pt_center = window_dprect.GetCenter(); m_InputSim.MouseMove(pt_center.x, pt_center.y); } } } void OutputManager::OverlayDirectDragStart(unsigned int overlay_id) { if (overlay_id == k_ulOverlayID_None) return; const OverlayConfigData& data = OverlayManager::Get().GetConfigData(overlay_id); if (m_OverlayDragger.GetDragDeviceID() == -1) { if (data.ConfigInt[configid_int_overlay_origin] != ovrl_origin_theater_screen) { if (!data.ConfigBool[configid_bool_overlay_transform_locked]) { m_OverlayDragger.DragStart(overlay_id); if (m_OverlayDragger.IsDragActive()) { m_OvrlDirectDragActive = true; ApplySettingInputMode(); if (m_LaserPointer.IsActive()) { m_LaserPointer.ForceTargetOverlay(OverlayManager::Get().GetOverlay(overlay_id).GetHandle()); } } } else { IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_drag_hint_device, ConfigManager::Get().GetPrimaryLaserPointerDevice()); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_drag_hint_type, 1); } } else { IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_drag_hint_device, ConfigManager::Get().GetPrimaryLaserPointerDevice()); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_drag_hint_type, 2); } } } void OutputManager::OverlayDirectDragFinish(unsigned int overlay_id) { if (overlay_id == k_ulOverlayID_None) return; const OverlayConfigData& data = OverlayManager::Get().GetConfigData(overlay_id); if ((m_OverlayDragger.GetDragOverlayID() == overlay_id) && (m_OverlayDragger.IsDragActive())) { OnDragFinish(); m_OverlayDragger.DragFinish(); ApplySettingTransform(); } IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_drag_hint_type, 0); } VRInput& OutputManager::GetVRInput() { return m_VRInput; } InputSimulator& OutputManager::GetInputSimulator() { return m_InputSim; } void OutputManager::UpdatePerformanceStates() { //Frame counter, the frames themselves are counted in Update() if (::GetTickCount64() >= m_PerformanceFrameCountStartTick + 1000) { //A second has passed, reset the value ConfigManager::SetValue(configid_int_state_performance_duplication_fps, m_PerformanceFrameCount); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_performance_duplication_fps, m_PerformanceFrameCount); m_PerformanceFrameCountStartTick = ::GetTickCount64(); m_PerformanceFrameCount = 0; } } const LARGE_INTEGER& OutputManager::GetUpdateLimiterDelay() { return m_PerformanceUpdateLimiterDelay; } int OutputManager::EnumerateOutputs(int target_desktop_id, Microsoft::WRL::ComPtr* out_adapter_preferred, Microsoft::WRL::ComPtr* out_adapter_vr) { Microsoft::WRL::ComPtr factory_ptr; Microsoft::WRL::ComPtr adapter_ptr_preferred; Microsoft::WRL::ComPtr adapter_ptr_vr; int output_id_adapter = target_desktop_id; //Output ID on the adapter actually used. Only different from initial SingleOutput if there's desktops across multiple GPUs m_DesktopRects.clear(); m_DesktopRectTotal = DPRect(); //Figure out right dimensions for full size desktop rect (this is also done in CreateTextures() but for Desktop Duplication only) m_DesktopHDRWhiteLevelAdjustments.clear(); const bool is_hdr_in_use = ((m_OutputHDRAvailable) && (ConfigManager::GetValue(configid_bool_performance_hdr_mirroring))); const UINT target_adapter_deviceid = (ConfigManager::GetValue(configid_int_misc_force_gpu_deviceid) == -1) ? 0 : (UINT)ConfigManager::GetValue(configid_int_misc_force_gpu_deviceid); const UINT target_adapter_deviceid_vr = (ConfigManager::GetValue(configid_int_misc_force_gpu_vr_deviceid) == -1) ? 0 : (UINT)ConfigManager::GetValue(configid_int_misc_force_gpu_vr_deviceid); //Also look for the device the HMD is connected to int32_t vr_gpu_id; vr::VRSystem()->GetDXGIOutputInfo(&vr_gpu_id); HRESULT hr = CreateDXGIFactory1(__uuidof(IDXGIFactory1), (void**)&factory_ptr); if (!FAILED(hr)) { LOG_SCOPE_F(INFO, "Detected Outputs"); Microsoft::WRL::ComPtr adapter_ptr; UINT i = 0; int output_count = 0; bool wmr_ignore_vscreens = (ConfigManager::GetValue(configid_int_interface_wmr_ignore_vscreens) == 1); while (factory_ptr->EnumAdapters(i, &adapter_ptr) != DXGI_ERROR_NOT_FOUND) { DXGI_ADAPTER_DESC adapter_desc; adapter_ptr->GetDesc(&adapter_desc); //Check if this is the adapter SteamVR wants if ( ((target_adapter_deviceid_vr == 0) && (i == vr_gpu_id)) || ((adapter_ptr_vr == nullptr) && (adapter_desc.DeviceId == target_adapter_deviceid_vr)) ) { adapter_ptr_vr = adapter_ptr; } //Check if this a WMR virtual display adapter and skip it when the option is enabled //This still only works correctly when they have the last desktops in the system, but that should pretty much be always the case if (wmr_ignore_vscreens) { if (wcscmp(adapter_desc.Description, L"Virtual Display Adapter") == 0) { LOG_F(INFO, "Skipping \"Virtual Display Adapter\""); ++i; continue; } } //Count the available outputs Microsoft::WRL::ComPtr output_ptr; //Check if there are gonna be any outputs before logging the GPU to avoid confusion (there may be multiple adapters per GPU with no outputs attached) if (adapter_ptr->EnumOutputs(0, &output_ptr) == DXGI_ERROR_NOT_FOUND) { //Still log them with higher verbosity level just in case LOG_F(1, "GPU %u: %s (Device ID %u) (No Outputs)", i + 1, StringConvertFromUTF16(adapter_desc.Description).c_str(), adapter_desc.DeviceId); ++i; continue; } LOG_SCOPE_F(INFO, "GPU %u: %s (Device ID %u)", i + 1, StringConvertFromUTF16(adapter_desc.Description).c_str(), adapter_desc.DeviceId); UINT output_index = 0; while (adapter_ptr->EnumOutputs(output_index, &output_ptr) != DXGI_ERROR_NOT_FOUND) { //Check if this happens to be the output we're looking for (or for combined desktop, set the first adapter with available output unless forced otherwise) if ( (adapter_ptr_preferred == nullptr) && ( (target_desktop_id == output_count) || ((target_desktop_id == -1) && ((target_adapter_deviceid == 0) || (adapter_desc.DeviceId == target_adapter_deviceid))) ) ) { adapter_ptr_preferred = adapter_ptr; if (target_desktop_id != -1) { output_id_adapter = output_index; } } //Cache rect of the output DXGI_OUTPUT_DESC output_desc; output_ptr->GetDesc(&output_desc); m_DesktopRects.emplace_back(output_desc.DesktopCoordinates.left, output_desc.DesktopCoordinates.top, output_desc.DesktopCoordinates.right, output_desc.DesktopCoordinates.bottom); (m_DesktopRectTotal.GetWidth() == 0) ? m_DesktopRectTotal = m_DesktopRects.back() : m_DesktopRectTotal.Add(m_DesktopRects.back()); //Cache HDR white level adjustment const float white_level_adjust = GetDesktopHDRWhiteLevelAdjustment(output_count, false, wmr_ignore_vscreens); m_DesktopHDRWhiteLevelAdjustments.push_back(white_level_adjust); //Log display info, with white level adjustment if HDR is actually on LOG_IF_F(INFO, !is_hdr_in_use, "Desktop %u: %4d,%4d | %4dx%4d (%s)", output_count + 1, output_desc.DesktopCoordinates.left, output_desc.DesktopCoordinates.top, output_desc.DesktopCoordinates.right - output_desc.DesktopCoordinates.left, output_desc.DesktopCoordinates.bottom - output_desc.DesktopCoordinates.top, StringConvertFromUTF16(output_desc.DeviceName).c_str()); LOG_IF_F(INFO, is_hdr_in_use, "Desktop %u: %4d,%4d | %4dx%4d (%s) | %.2fx SDR Brightness", output_count + 1, output_desc.DesktopCoordinates.left, output_desc.DesktopCoordinates.top, output_desc.DesktopCoordinates.right - output_desc.DesktopCoordinates.left, output_desc.DesktopCoordinates.bottom - output_desc.DesktopCoordinates.top, StringConvertFromUTF16(output_desc.DeviceName).c_str(), 1.0f / white_level_adjust); ++output_count; ++output_index; } ++i; } //Store output/desktop count and send it over to UI ConfigManager::SetValue(configid_int_state_interface_desktop_count, output_count); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_interface_desktop_count, output_count); } LOG_IF_F(WARNING, (adapter_ptr_preferred == nullptr) && (target_adapter_deviceid == 0) && (target_desktop_id == -1), "No GPU with desktop outputs was found!"); LOG_IF_F(WARNING, (adapter_ptr_preferred == nullptr) && (target_adapter_deviceid != 0) && (target_desktop_id == -1), "GPU forced by config (DeviceID %u) was not found or has no outputs!", target_adapter_deviceid); LOG_IF_F(WARNING, (adapter_ptr_preferred == nullptr) && (target_desktop_id != -1), "GPU for target Desktop %i was not found!", target_desktop_id); LOG_IF_F(WARNING, (adapter_ptr_vr == nullptr) && (target_adapter_deviceid_vr == 0), "GPU requested by SteamVR (%u) was not found!", vr_gpu_id + 1); LOG_IF_F(WARNING, (adapter_ptr_vr == nullptr) && (target_adapter_deviceid_vr != 0), "VR GPU forced by config (DeviceID %u) was not found!", target_adapter_deviceid_vr); if (out_adapter_preferred != nullptr) { *out_adapter_preferred = adapter_ptr_preferred; } if (out_adapter_vr != nullptr) { *out_adapter_vr = adapter_ptr_vr; } m_InputSim.RefreshScreenOffsets(); ResetMouseLastLaserPointerPos(); return output_id_adapter; } void OutputManager::CropToDisplay(int display_id, int& crop_x, int& crop_y, int& crop_width, int& crop_height) { if ( (!ConfigManager::GetValue(configid_bool_performance_single_desktop_mirroring)) && (display_id >= 0) && (display_id < m_DesktopRects.size()) ) { //Individual desktop on full desktop texture const DPRect& rect = m_DesktopRects[display_id]; crop_x = rect.GetTL().x; crop_y = rect.GetTL().y; crop_width = rect.GetWidth(); crop_height = rect.GetHeight(); //Offset by desktop coordinates crop_x -= m_DesktopX; crop_y -= m_DesktopY; } else //Full desktop { crop_x = 0; crop_y = 0; crop_width = -1; crop_height = -1; } } bool OutputManager::CropToActiveWindow(int& crop_x, int& crop_y, int& crop_width, int& crop_height) { HWND window_handle = ::GetForegroundWindow(); if (window_handle != nullptr) { RECT window_rect = {0}; //Just using GetWindowRect() can include shadows and such, which we don't want if (::DwmGetWindowAttribute(window_handle, DWMWA_EXTENDED_FRAME_BOUNDS, &window_rect, sizeof(window_rect)) == S_OK) { DPRect crop_rect(window_rect.left, window_rect.top, window_rect.right, window_rect.bottom); crop_rect.Translate({-m_DesktopX, -m_DesktopY}); //Translate crop rect by desktop offset to get desktop-local coordinates crop_rect.ClipWithFull({0, 0, m_DesktopWidth, m_DesktopHeight}); //Clip to available desktop space if ((crop_rect.GetWidth() > 0) && (crop_rect.GetHeight() > 0)) { //Set new crop values crop_x = crop_rect.GetTL().x; crop_y = crop_rect.GetTL().y; crop_width = crop_rect.GetWidth(); crop_height = crop_rect.GetHeight(); return true; } } } return false; } void OutputManager::InitComIfNeeded() { if (!m_ComInitDone) { if (::CoInitializeEx(nullptr, COINIT_APARTMENTTHREADED | COINIT_DISABLE_OLE1DDE) != RPC_E_CHANGED_MODE) { m_ComInitDone = true; } } } void OutputManager::ConvertOUtoSBS(Overlay& overlay, OUtoSBSConverter& converter) { //Convert()'s arguments are almost all stuff from OutputManager, so we take this roundabout way of calling it const DPRect& crop_rect = overlay.GetValidatedCropRect(); HRESULT hr = converter.Convert(m_Device, m_DeviceContext, m_MultiGPUTargetDevice, m_MultiGPUTargetDeviceContext, m_OvrlTex, m_DesktopWidth, m_DesktopHeight, crop_rect.GetTL().x, crop_rect.GetTL().y, crop_rect.GetWidth(), crop_rect.GetHeight()); if (hr == S_OK) { vr::Texture_t vrtex; vrtex.eType = vr::TextureType_DirectX; vrtex.eColorSpace = vr::ColorSpace_Gamma; vrtex.handle = converter.GetTexture(); //OUtoSBSConverter takes care of multi-gpu support automatically, so no further processing needed vr::VROverlay()->SetOverlayTexture(overlay.GetHandle(), &vrtex); } else { ProcessFailure(m_Device, L"Failed to convert OU texture to SBS", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } } // // Process both masked and monochrome pointers // DUPL_RETURN OutputManager::ProcessMonoMask(bool is_mono, PTR_INFO& ptr_info, int& ptr_width, int& ptr_height, int& ptr_left, int& ptr_top, Microsoft::WRL::ComPtr& out_tex, DXGI_FORMAT& out_tex_format, D3D11_BOX& box) { out_tex_format = DXGI_FORMAT_UNKNOWN; //ShapeBuffer can sometimes be empty when the secure desktop is active, skip if (ptr_info.ShapeBuffer.empty()) return DUPL_RETURN_SUCCESS; //Desktop dimensions D3D11_TEXTURE2D_DESC FullDesc; m_SharedSurf->GetDesc(&FullDesc); int desktop_width = FullDesc.Width; int desktop_height = FullDesc.Height; //Pointer position int ptr_info_pos_left = ptr_info.Position.x; int ptr_info_pos_top = ptr_info.Position.y; //Figure out if any adjustment is needed for out of bound positions if (ptr_info_pos_left < 0) { ptr_width = ptr_info_pos_left + (int)ptr_info.ShapeInfo.Width; } else if ((ptr_info_pos_left + (int)ptr_info.ShapeInfo.Width) > desktop_width) { ptr_width = desktop_height - ptr_info_pos_left; } else { ptr_width = (int)ptr_info.ShapeInfo.Width; } if (is_mono) { ptr_info.ShapeInfo.Height = ptr_info.ShapeInfo.Height / 2; } if (ptr_info_pos_top < 0) { ptr_height = ptr_info_pos_top + (int)ptr_info.ShapeInfo.Height; } else if ((ptr_info_pos_top + (int)ptr_info.ShapeInfo.Height) > desktop_height) { ptr_height = desktop_height - ptr_info_pos_top; } else { ptr_height = (int)ptr_info.ShapeInfo.Height; } if (is_mono) { ptr_info.ShapeInfo.Height = ptr_info.ShapeInfo.Height * 2; } ptr_left = (ptr_info_pos_left < 0) ? 0 : ptr_info_pos_left; ptr_top = (ptr_info_pos_top < 0) ? 0 : ptr_info_pos_top; // Staging buffer/texture D3D11_TEXTURE2D_DESC copy_buffer_desc = {}; copy_buffer_desc.Width = ptr_width; copy_buffer_desc.Height = ptr_height; copy_buffer_desc.MipLevels = 1; copy_buffer_desc.ArraySize = 1; copy_buffer_desc.Format = DXGI_FORMAT_B8G8R8A8_UNORM; copy_buffer_desc.SampleDesc.Count = 1; copy_buffer_desc.SampleDesc.Quality = 0; copy_buffer_desc.Usage = D3D11_USAGE_STAGING; copy_buffer_desc.BindFlags = 0; copy_buffer_desc.CPUAccessFlags = D3D11_CPU_ACCESS_READ; copy_buffer_desc.MiscFlags = 0; Microsoft::WRL::ComPtr copy_buffer; HRESULT hr = m_Device->CreateTexture2D(©_buffer_desc, nullptr, ©_buffer); if (FAILED(hr)) { return ProcessFailure(m_Device, L"Failed creating staging texture for pointer", L"Desktop+ Error", S_OK, SystemTransitionsExpectedErrors); //Shouldn't be critical } //Copy needed part of desktop image box.left = ptr_left; box.top = ptr_top; box.right = ptr_left + ptr_width; box.bottom = ptr_top + ptr_height; m_DeviceContext->CopySubresourceRegion(copy_buffer.Get(), 0, 0, 0, 0, m_SharedSurf, 0, &box); //QI for IDXGISurface Microsoft::WRL::ComPtr copy_surface; hr = copy_buffer.As(©_surface); if (FAILED(hr)) { return ProcessFailure(nullptr, L"Failed to QI staging texture into IDXGISurface for pointer", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } // Map pixels DXGI_MAPPED_RECT mapped_surface; hr = copy_surface->Map(&mapped_surface, DXGI_MAP_READ); if (FAILED(hr)) { return ProcessFailure(m_Device, L"Failed to map surface for pointer", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } //New mouseshape buffer auto init_buffer = std::unique_ptr{new (std::nothrow)BYTE[ptr_width * ptr_height * 4]}; if (init_buffer == nullptr) { return ProcessFailure(nullptr, L"Failed to allocate memory for new mouse shape buffer.", L"Desktop+ Error", E_OUTOFMEMORY); } uint32_t* init_buffer_u32 = (uint32_t*)init_buffer.get(); uint32_t* desktop_buffer_u32 = (uint32_t*)mapped_surface.pBits; int desktop_buffer_pitch = mapped_surface.Pitch / sizeof(uint32_t); // What to skip (pixel offset) unsigned int ptr_skip_x = (ptr_info_pos_left < 0) ? (-1 * ptr_info_pos_left) : (0); unsigned int ptr_skip_y = (ptr_info_pos_top < 0) ? (-1 * ptr_info_pos_top) : (0); int ptr_height_half = ptr_info.ShapeInfo.Height / 2; if (is_mono) { //Iterate through pointer shape pixels for (size_t ptr_pixel_row = 0; ptr_pixel_row < ptr_height; ++ptr_pixel_row) { //Set mask uint8_t mask_base = 0x80; mask_base = mask_base >> (ptr_skip_x % 8); for (int ptr_pixel_col = 0; ptr_pixel_col < ptr_width; ++ptr_pixel_col) { //Get masks using appropriate offsets size_t mask_offset_base = ((ptr_pixel_col + ptr_skip_x) / 8); BYTE mask_and = ptr_info.ShapeBuffer[mask_offset_base + ((ptr_pixel_row + ptr_skip_y) * ptr_info.ShapeInfo.Pitch) ] & mask_base; BYTE mask_xor = ptr_info.ShapeBuffer[mask_offset_base + ((ptr_pixel_row + ptr_skip_y + ptr_height_half) * ptr_info.ShapeInfo.Pitch)] & mask_base; uint32_t mask_and_u32 = (mask_and) ? 0xFFFFFFFF : 0xFF000000; uint32_t mask_xor_u32 = (mask_xor) ? 0x00FFFFFF : 0x00000000; //Set new pixel init_buffer_u32[(ptr_pixel_row * ptr_width) + ptr_pixel_col] = (desktop_buffer_u32[(ptr_pixel_row * desktop_buffer_pitch) + ptr_pixel_col] & mask_and_u32) ^ mask_xor_u32; //Adjust mask mask_base = (mask_base == 0x01) ? 0x80 : mask_base >> 1; } } } else { uint32_t* shape_buffer_u32 = (uint32_t*)ptr_info.ShapeBuffer.data(); //Iterate through pointer shape pixels for (size_t ptr_pixel_row = 0; ptr_pixel_row < ptr_height; ++ptr_pixel_row) { for (size_t ptr_pixel_col = 0; ptr_pixel_col < ptr_width; ++ptr_pixel_col) { // Set up mask uint32_t MaskVal = 0xFF000000 & shape_buffer_u32[(ptr_pixel_col + ptr_skip_x) + ((ptr_pixel_row + ptr_skip_y) * uint32_t(ptr_info.ShapeInfo.Pitch / sizeof(uint32_t)))]; if (MaskVal) { //mask_value was 0xFF init_buffer_u32[(ptr_pixel_row * ptr_width) + ptr_pixel_col] = (desktop_buffer_u32[(ptr_pixel_row * desktop_buffer_pitch) + ptr_pixel_col] ^ shape_buffer_u32[(ptr_pixel_col + ptr_skip_x) + ((ptr_pixel_row + ptr_skip_y) * uint32_t(ptr_info.ShapeInfo.Pitch / sizeof(uint32_t)))]) | 0xFF000000; } else { //mask_value was 0x00 init_buffer_u32[(ptr_pixel_row * ptr_width) + ptr_pixel_col] = shape_buffer_u32[(ptr_pixel_col + ptr_skip_x) + ((ptr_pixel_row + ptr_skip_y) * uint32_t(ptr_info.ShapeInfo.Pitch / sizeof(uint32_t)))] | 0xFF000000; } } } } //Unmap surface hr = copy_surface->Unmap(); if (FAILED(hr)) { return ProcessFailure(m_Device, L"Failed to unmap surface for pointer", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } //Create texture D3D11_TEXTURE2D_DESC tex_desc = {}; tex_desc.Width = ptr_width; tex_desc.Height = ptr_height; tex_desc.MipLevels = 1; tex_desc.ArraySize = 1; tex_desc.Format = DXGI_FORMAT_B8G8R8A8_UNORM; tex_desc.SampleDesc.Count = 1; tex_desc.SampleDesc.Quality = 0; tex_desc.Usage = D3D11_USAGE_DEFAULT; tex_desc.BindFlags = D3D11_BIND_SHADER_RESOURCE; tex_desc.CPUAccessFlags = 0; tex_desc.MiscFlags = 0; //Set shader resource properties D3D11_SHADER_RESOURCE_VIEW_DESC srv_desc = {}; srv_desc.Format = tex_desc.Format; srv_desc.ViewDimension = D3D11_SRV_DIMENSION_TEXTURE2D; srv_desc.Texture2D.MostDetailedMip = tex_desc.MipLevels - 1; srv_desc.Texture2D.MipLevels = tex_desc.MipLevels; //Set up init data D3D11_SUBRESOURCE_DATA init_data = {}; init_data.pSysMem = init_buffer.get(); init_data.SysMemPitch = ptr_width * 4; //Create mouse pointer texture hr = m_Device->CreateTexture2D(&tex_desc, &init_data, &out_tex); if (FAILED(hr)) { return ProcessFailure(m_Device, L"Failed to create mouse pointer texture", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } out_tex_format = tex_desc.Format; return DUPL_RETURN_SUCCESS; } DUPL_RETURN OutputManager::ProcessMonoMaskFloat16(bool is_mono, PTR_INFO& ptr_info, int& ptr_width, int& ptr_height, int& ptr_left, int& ptr_top, Microsoft::WRL::ComPtr& out_tex, DXGI_FORMAT& out_tex_format, D3D11_BOX& box) { out_tex_format = DXGI_FORMAT_UNKNOWN; //ShapeBuffer can sometimes be empty when the secure desktop is active, skip if (ptr_info.ShapeBuffer.empty()) return DUPL_RETURN_SUCCESS; //Desktop dimensions D3D11_TEXTURE2D_DESC FullDesc; m_SharedSurf->GetDesc(&FullDesc); int DesktopWidth = FullDesc.Width; int DesktopHeight = FullDesc.Height; //Pointer position int ptr_info_pos_left = ptr_info.Position.x; int ptr_info_pos_top = ptr_info.Position.y; //Figure out if any adjustment is needed for out of bound positions if (ptr_info_pos_left < 0) { ptr_width = ptr_info_pos_left + (int)ptr_info.ShapeInfo.Width; } else if ((ptr_info_pos_left + (int)ptr_info.ShapeInfo.Width) > DesktopWidth) { ptr_width = DesktopWidth - ptr_info_pos_left; } else { ptr_width = (int)ptr_info.ShapeInfo.Width; } if (is_mono) { ptr_info.ShapeInfo.Height = ptr_info.ShapeInfo.Height / 2; } if (ptr_info_pos_top < 0) { ptr_height = ptr_info_pos_top + (int)ptr_info.ShapeInfo.Height; } else if ((ptr_info_pos_top + (int)ptr_info.ShapeInfo.Height) > DesktopHeight) { ptr_height = DesktopHeight - ptr_info_pos_top; } else { ptr_height = (int)ptr_info.ShapeInfo.Height; } if (is_mono) { ptr_info.ShapeInfo.Height = ptr_info.ShapeInfo.Height * 2; } ptr_left = (ptr_info_pos_left < 0) ? 0 : ptr_info_pos_left; ptr_top = (ptr_info_pos_top < 0) ? 0 : ptr_info_pos_top; //Staging buffer/texture D3D11_TEXTURE2D_DESC copy_buffer_desc = {}; copy_buffer_desc.Width = ptr_width; copy_buffer_desc.Height = ptr_height; copy_buffer_desc.MipLevels = 1; copy_buffer_desc.ArraySize = 1; copy_buffer_desc.Format = DXGI_FORMAT_R16G16B16A16_FLOAT; copy_buffer_desc.SampleDesc.Count = 1; copy_buffer_desc.SampleDesc.Quality = 0; copy_buffer_desc.Usage = D3D11_USAGE_STAGING; copy_buffer_desc.BindFlags = 0; copy_buffer_desc.CPUAccessFlags = D3D11_CPU_ACCESS_READ; copy_buffer_desc.MiscFlags = 0; Microsoft::WRL::ComPtr copy_buffer; HRESULT hr = m_Device->CreateTexture2D(©_buffer_desc, nullptr, ©_buffer); if (FAILED(hr)) { return ProcessFailure(m_Device, L"Failed creating staging texture for pointer", L"Desktop+ Error", S_OK, SystemTransitionsExpectedErrors); //Shouldn't be critical } //Copy needed part of desktop image box.left = ptr_left; box.top = ptr_top; box.right = ptr_left + ptr_width; box.bottom = ptr_top + ptr_height; m_DeviceContext->CopySubresourceRegion(copy_buffer.Get(), 0, 0, 0, 0, m_SharedSurf, 0, &box); //QI for IDXGISurface Microsoft::WRL::ComPtr copy_surface; hr = copy_buffer.As(©_surface); if (FAILED(hr)) { return ProcessFailure(nullptr, L"Failed to QI staging texture into IDXGISurface for pointer", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } //Map pixels DXGI_MAPPED_RECT mapped_surface; hr = copy_surface->Map(&mapped_surface, DXGI_MAP_READ); if (FAILED(hr)) { return ProcessFailure(m_Device, L"Failed to map surface for pointer", L"Error", hr, SystemTransitionsExpectedErrors); } //New mouseshape buffer auto init_buffer = std::unique_ptr{new (std::nothrow)BYTE[ptr_width * ptr_height * 4 * sizeof(PackedVector::HALF)]}; if (init_buffer == nullptr) { return ProcessFailure(nullptr, L"Failed to allocate memory for new mouse shape buffer.", L"Desktop+ Error", E_OUTOFMEMORY); } PackedVector::HALF* init_buffer_f16 = (PackedVector::HALF*)init_buffer.get(); PackedVector::HALF* desktop_buffer_f16 = (PackedVector::HALF*)mapped_surface.pBits; int desktop_buffer_pitch = mapped_surface.Pitch / sizeof(PackedVector::HALF); //What to skip (pixel offset) unsigned int ptr_skip_x = (ptr_info_pos_left < 0) ? (-1 * ptr_info_pos_left) : (0); unsigned int ptr_skip_y = (ptr_info_pos_top < 0) ? (-1 * ptr_info_pos_top) : (0); int ptr_height_half = ptr_info.ShapeInfo.Height / 2; //While the float value of SDR white may not be 1.0 depending on OS and system settings, the cursor texture is always 8-bit per channel //This might not be 100% accurate, but masked color cursors are also very rare, so we mostly care about XOR negative color effects working const float sdr_white_level_adjustment = (m_DesktopHDRWhiteLevelAdjustments.empty()) ? 1.0f : m_DesktopHDRWhiteLevelAdjustments[clamp((size_t)ptr_info.WhoUpdatedPositionLast, (size_t)0, m_DesktopHDRWhiteLevelAdjustments.size()-1)]; if (is_mono) { //Iterate through pointer shape pixels for (size_t ptr_pixel_row = 0; ptr_pixel_row < ptr_height; ++ptr_pixel_row) { //Set mask uint8_t mask_base = 0x80; mask_base = mask_base >> (ptr_skip_x % 8); for (size_t ptr_pixel_col = 0; ptr_pixel_col < ptr_width; ++ptr_pixel_col) { const int offset_in = (ptr_pixel_row * desktop_buffer_pitch) + (ptr_pixel_col * 4); const int offset_out = ((ptr_pixel_row * ptr_width) + (ptr_pixel_col)) * 4; //Get masks using appropriate offsets size_t mask_offset_base = ((ptr_pixel_col + ptr_skip_x) / 8); BYTE mask_and = ptr_info.ShapeBuffer[mask_offset_base + ((ptr_pixel_row + ptr_skip_y) * ptr_info.ShapeInfo.Pitch) ] & mask_base; BYTE mask_xor = ptr_info.ShapeBuffer[mask_offset_base + ((ptr_pixel_row + ptr_skip_y + ptr_height_half) * ptr_info.ShapeInfo.Pitch)] & mask_base; //Set new pixel float f32_value_r = (mask_and) ? PackedVector::XMConvertHalfToFloat(desktop_buffer_f16[offset_in]) : 0.0f; float f32_value_g = (mask_and) ? PackedVector::XMConvertHalfToFloat(desktop_buffer_f16[offset_in + 1]) : 0.0f; float f32_value_b = (mask_and) ? PackedVector::XMConvertHalfToFloat(desktop_buffer_f16[offset_in + 2]) : 0.0f; float f32_value_a = (mask_and) ? PackedVector::XMConvertHalfToFloat(desktop_buffer_f16[offset_in + 3]) : 0.0f; if (mask_xor) { //Approximation for XOR negative color effect in non-linear space const float xor_neg = 0.77f / sdr_white_level_adjustment; init_buffer_f16[offset_out] = PackedVector::XMConvertFloatToHalf( std::max(xor_neg - f32_value_r, 0.0f) ); init_buffer_f16[offset_out + 1] = PackedVector::XMConvertFloatToHalf( std::max(xor_neg - f32_value_g, 0.0f) ); init_buffer_f16[offset_out + 2] = PackedVector::XMConvertFloatToHalf( std::max(xor_neg - f32_value_b, 0.0f) ); } else { init_buffer_f16[offset_out] = PackedVector::XMConvertFloatToHalf(f32_value_r); init_buffer_f16[offset_out + 1] = PackedVector::XMConvertFloatToHalf(f32_value_g); init_buffer_f16[offset_out + 2] = PackedVector::XMConvertFloatToHalf(f32_value_b); } init_buffer_f16[offset_out + 3] = desktop_buffer_f16[offset_in + 3]; //Adjust mask mask_base = (mask_base == 0x01) ? 0x80 : mask_base >> 1; } } } else { uint32_t* shape_buffer_u32 = (uint32_t*)ptr_info.ShapeBuffer.data(); //Iterate through pointer shape pixels for (size_t ptr_pixel_row = 0; ptr_pixel_row < ptr_height; ++ptr_pixel_row) { for (size_t ptr_pixel_col = 0; ptr_pixel_col < ptr_width; ++ptr_pixel_col) { // Set up mask const int offset_in = (ptr_pixel_row * desktop_buffer_pitch) + (ptr_pixel_col * 4); const int offset_out = ((ptr_pixel_row * ptr_width) + (ptr_pixel_col)) * 4; uint32_t mask_value = 0xFF000000 & shape_buffer_u32[(ptr_pixel_col + ptr_skip_x) + ((ptr_pixel_row + ptr_skip_y) * uint32_t(ptr_info.ShapeInfo.Pitch / sizeof(uint32_t)))]; if (mask_value) { //mask_value was 0xFF //Cast float values to regular RGB ones and XOR them as intended (though this is still in linear color space) float f32_value_r = PackedVector::XMConvertHalfToFloat(desktop_buffer_f16[offset_in]); float f32_value_g = PackedVector::XMConvertHalfToFloat(desktop_buffer_f16[offset_in + 1]); float f32_value_b = PackedVector::XMConvertHalfToFloat(desktop_buffer_f16[offset_in + 2]); float f32_value_a = PackedVector::XMConvertHalfToFloat(desktop_buffer_f16[offset_in + 3]); uint32_t u32_value_r = f32_value_r * 255.0f * sdr_white_level_adjustment; uint32_t u32_value_g = f32_value_g * 255.0f * sdr_white_level_adjustment; uint32_t u32_value_b = f32_value_b * 255.0f * sdr_white_level_adjustment; uint32_t ptr_rgba = shape_buffer_u32[(ptr_pixel_col + ptr_skip_x) + ((ptr_pixel_row + ptr_skip_y) * uint32_t(ptr_info.ShapeInfo.Pitch / sizeof(uint32_t)))]; uint32_t u32_buff_r = (ptr_rgba >> 16) & 0xFF; uint32_t u32_buff_g = (ptr_rgba >> 8) & 0xFF; uint32_t u32_buff_b = ptr_rgba & 0xFF; u32_value_r ^= u32_buff_r; u32_value_g ^= u32_buff_g; u32_value_b ^= u32_buff_b; //Cast them back again f32_value_r = u32_value_r / 255.0f / sdr_white_level_adjustment; f32_value_g = u32_value_g / 255.0f / sdr_white_level_adjustment; f32_value_b = u32_value_b / 255.0f / sdr_white_level_adjustment; init_buffer_f16[offset_out] = PackedVector::XMConvertFloatToHalf(f32_value_r); init_buffer_f16[offset_out + 1] = PackedVector::XMConvertFloatToHalf(f32_value_g); init_buffer_f16[offset_out + 2] = PackedVector::XMConvertFloatToHalf(f32_value_b); init_buffer_f16[offset_out + 3] = desktop_buffer_f16[offset_in + 3]; } else { //mask_value was 0x00 uint32_t ptr_rgb = shape_buffer_u32[(ptr_pixel_col + ptr_skip_x) + ((ptr_pixel_row + ptr_skip_y) * uint32_t(ptr_info.ShapeInfo.Pitch / sizeof(UINT)))]; float f32_value_r = ((ptr_rgb >> 16) & 0xFF) / 255.0f / sdr_white_level_adjustment; float f32_value_g = ((ptr_rgb >> 8) & 0xFF) / 255.0f / sdr_white_level_adjustment; float f32_value_b = (ptr_rgb & 0xFF) / 255.0f / sdr_white_level_adjustment; init_buffer_f16[offset_out] = PackedVector::XMConvertFloatToHalf( f32_value_r ); init_buffer_f16[offset_out + 1] = PackedVector::XMConvertFloatToHalf( f32_value_g ); init_buffer_f16[offset_out + 2] = PackedVector::XMConvertFloatToHalf( f32_value_b ); init_buffer_f16[offset_out + 3] = desktop_buffer_f16[offset_in + 3]; } } } } //Unmap surface hr = copy_surface->Unmap(); if (FAILED(hr)) { return ProcessFailure(m_Device, L"Failed to unmap surface for pointer", L"Error", hr, SystemTransitionsExpectedErrors); } //Create texture D3D11_TEXTURE2D_DESC tex_desc = {}; tex_desc.Width = ptr_width; tex_desc.Height = ptr_height; tex_desc.MipLevels = 1; tex_desc.ArraySize = 1; tex_desc.Format = DXGI_FORMAT_R16G16B16A16_FLOAT; tex_desc.SampleDesc.Count = 1; tex_desc.SampleDesc.Quality = 0; tex_desc.Usage = D3D11_USAGE_DEFAULT; tex_desc.BindFlags = D3D11_BIND_SHADER_RESOURCE; tex_desc.CPUAccessFlags = 0; tex_desc.MiscFlags = 0; //Set shader resource properties D3D11_SHADER_RESOURCE_VIEW_DESC srv_desc = {}; srv_desc.Format = tex_desc.Format; srv_desc.ViewDimension = D3D11_SRV_DIMENSION_TEXTURE2D; srv_desc.Texture2D.MostDetailedMip = tex_desc.MipLevels - 1; srv_desc.Texture2D.MipLevels = tex_desc.MipLevels; //Set up init data D3D11_SUBRESOURCE_DATA init_data = {}; init_data.pSysMem = init_buffer.get(); init_data.SysMemPitch = ptr_width * 4 * (int)sizeof(PackedVector::HALF); //Create mouse pointer texture hr = m_Device->CreateTexture2D(&tex_desc, &init_data, &out_tex); if (FAILED(hr)) { return ProcessFailure(m_Device, L"Failed to create mouse pointer texture", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } out_tex_format = tex_desc.Format; return DUPL_RETURN_SUCCESS; } // // Reset render target view // DUPL_RETURN OutputManager::MakeRTV() { D3D11_TEXTURE2D_DESC desc_ovrl_tex; m_OvrlTex->GetDesc(&desc_ovrl_tex); //Create render target view for overlay texture D3D11_RENDER_TARGET_VIEW_DESC ovrl_tex_rtv_desc = {}; ovrl_tex_rtv_desc.Format = desc_ovrl_tex.Format; ovrl_tex_rtv_desc.ViewDimension = D3D11_RTV_DIMENSION_TEXTURE2D; ovrl_tex_rtv_desc.Texture2D.MipSlice = 0; m_Device->CreateRenderTargetView(m_OvrlTex, &ovrl_tex_rtv_desc, &m_OvrlRTV); return DUPL_RETURN_SUCCESS; } // // Initialize shaders for drawing // DUPL_RETURN OutputManager::InitShaders() { HRESULT hr; UINT Size = ARRAYSIZE(g_VS); hr = m_Device->CreateVertexShader(g_VS, Size, nullptr, &m_VertexShader); if (FAILED(hr)) { return ProcessFailure(m_Device, L"Failed to create vertex shader", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } D3D11_INPUT_ELEMENT_DESC Layout[] = { { "POSITION", 0, DXGI_FORMAT_R32G32B32_FLOAT, 0, 0, D3D11_INPUT_PER_VERTEX_DATA, 0 }, { "TEXCOORD", 0, DXGI_FORMAT_R32G32_FLOAT, 0, 12, D3D11_INPUT_PER_VERTEX_DATA, 0 } }; UINT NumElements = ARRAYSIZE(Layout); hr = m_Device->CreateInputLayout(Layout, NumElements, g_VS, Size, &m_InputLayout); if (FAILED(hr)) { return ProcessFailure(m_Device, L"Failed to create input layout", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } m_DeviceContext->IASetInputLayout(m_InputLayout); Size = ARRAYSIZE(g_PS); hr = m_Device->CreatePixelShader(g_PS, Size, nullptr, &m_PixelShader); if (FAILED(hr)) { return ProcessFailure(m_Device, L"Failed to create pixel shader", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } Size = ARRAYSIZE(g_PSCURSOR); hr = m_Device->CreatePixelShader(g_PSCURSOR, Size, nullptr, &m_PixelShaderCursor); if (FAILED(hr)) { return ProcessFailure(m_Device, L"Failed to create cursor pixel shader", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } return DUPL_RETURN_SUCCESS; } // // Recreate textures // DUPL_RETURN OutputManager::CreateTextures(INT SingleOutput, _Out_ UINT* OutCount, _Out_ RECT* DeskBounds) { HRESULT hr; *OutCount = 0; const int desktop_count = m_DesktopRects.size(); //Output doesn't exist. This will result in a soft-error invalid output state (system may be in an transition state, in which case we'll automatically recover) if (SingleOutput >= desktop_count) { m_DesktopX = 0; m_DesktopY = 0; m_DesktopWidth = -1; m_DesktopHeight = -1; return DUPL_RETURN_ERROR_EXPECTED; } //Figure out right dimensions for full size desktop texture DPRect output_rect_total; if (SingleOutput < 0) { //Combined desktop, also count desktops on the used adapter Microsoft::WRL::ComPtr adapter_ptr; adapter_ptr.Attach(GetDXGIAdapter()); UINT output_index_adapter = 0; hr = S_OK; while (SUCCEEDED(hr)) { //Break early if used desktop count is lower than actual output count if (output_index_adapter >= desktop_count) { ++output_index_adapter; break; } Microsoft::WRL::ComPtr output_ptr; hr = adapter_ptr->EnumOutputs(output_index_adapter, &output_ptr); if ((output_ptr != nullptr) && (hr != DXGI_ERROR_NOT_FOUND)) { DXGI_OUTPUT_DESC output_desc; output_ptr->GetDesc(&output_desc); DPRect output_rect(output_desc.DesktopCoordinates.left, output_desc.DesktopCoordinates.top, output_desc.DesktopCoordinates.right, output_desc.DesktopCoordinates.bottom); (output_rect_total.GetWidth() == 0) ? output_rect_total = output_rect : output_rect_total.Add(output_rect); } ++output_index_adapter; } *OutCount = output_index_adapter - 1; } else { //Single desktop, grab cached desktop rect if (SingleOutput < desktop_count) { output_rect_total = m_DesktopRects[SingleOutput]; *OutCount = 1; } } //Store size and position m_DesktopX = output_rect_total.GetTL().x; m_DesktopY = output_rect_total.GetTL().y; m_DesktopWidth = output_rect_total.GetWidth(); m_DesktopHeight = output_rect_total.GetHeight(); DeskBounds->left = output_rect_total.GetTL().x; DeskBounds->top = output_rect_total.GetTL().y; DeskBounds->right = output_rect_total.GetBR().x; DeskBounds->bottom = output_rect_total.GetBR().y; //Set it as mouse scale on the desktop texture overlay for the UI to read the resolution from there vr::HmdVector2_t mouse_scale = {0}; mouse_scale.v[0] = m_DesktopWidth; mouse_scale.v[1] = m_DesktopHeight; vr::VROverlay()->SetOverlayMouseScale(m_OvrlHandleDesktopTexture, &mouse_scale); //Create shared texture for all duplication threads to draw into D3D11_TEXTURE2D_DESC TexD; RtlZeroMemory(&TexD, sizeof(D3D11_TEXTURE2D_DESC)); TexD.Width = m_DesktopWidth; TexD.Height = m_DesktopHeight; TexD.MipLevels = 1; TexD.ArraySize = 1; TexD.Format = ((m_OutputHDRAvailable) && (ConfigManager::GetValue(configid_bool_performance_hdr_mirroring))) ? DXGI_FORMAT_R16G16B16A16_FLOAT : DXGI_FORMAT_B8G8R8A8_UNORM; TexD.SampleDesc.Count = 1; TexD.Usage = D3D11_USAGE_DEFAULT; TexD.BindFlags = D3D11_BIND_RENDER_TARGET | D3D11_BIND_SHADER_RESOURCE; TexD.CPUAccessFlags = 0; TexD.MiscFlags = D3D11_RESOURCE_MISC_SHARED_KEYEDMUTEX; hr = m_Device->CreateTexture2D(&TexD, nullptr, &m_SharedSurf); if (!FAILED(hr)) { TexD.MiscFlags = 0; hr = m_Device->CreateTexture2D(&TexD, nullptr, &m_OvrlTex); } if (FAILED(hr)) { if (output_rect_total.GetWidth() != 0) { // If we are duplicating the complete desktop we try to create a single texture to hold the // complete desktop image and blit updates from the per output DDA interface. The GPU can // always support a texture size of the maximum resolution of any single output but there is no // guarantee that it can support a texture size of the desktop. return ProcessFailure(m_Device, L"Failed to create shared texture. Combined desktop texture size may be larger than the maximum supported supported size of the GPU", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } else { return ProcessFailure(m_Device, L"Failed to create shared texture", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } } // Get keyed mutex hr = m_SharedSurf->QueryInterface(__uuidof(IDXGIKeyedMutex), reinterpret_cast(&m_KeyMutex)); if (FAILED(hr)) { return ProcessFailure(m_Device, L"Failed to query for keyed mutex", L"Desktop+ Error", hr); } //Create shader resource for shared texture D3D11_TEXTURE2D_DESC FrameDesc; m_SharedSurf->GetDesc(&FrameDesc); D3D11_SHADER_RESOURCE_VIEW_DESC ShaderDesc; ShaderDesc.Format = FrameDesc.Format; ShaderDesc.ViewDimension = D3D11_SRV_DIMENSION_TEXTURE2D; ShaderDesc.Texture2D.MostDetailedMip = FrameDesc.MipLevels - 1; ShaderDesc.Texture2D.MipLevels = FrameDesc.MipLevels; // Create new shader resource view hr = m_Device->CreateShaderResourceView(m_SharedSurf, &ShaderDesc, &m_ShaderResource); if (FAILED(hr)) { return ProcessFailure(m_Device, L"Failed to create shader resource", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } //Create textures for multi GPU handling if needed if (m_MultiGPUTargetDevice != nullptr) { //Staging texture TexD.Usage = D3D11_USAGE_STAGING; TexD.BindFlags = 0; TexD.CPUAccessFlags = D3D11_CPU_ACCESS_READ; TexD.MiscFlags = 0; hr = m_Device->CreateTexture2D(&TexD, nullptr, &m_MultiGPUTexStaging); if (FAILED(hr)) { return ProcessFailure(m_Device, L"Failed to create staging texture", L"Desktop+ Error", hr); } //Copy-target texture TexD.Usage = D3D11_USAGE_DYNAMIC; TexD.BindFlags = D3D11_BIND_SHADER_RESOURCE; TexD.CPUAccessFlags = D3D11_CPU_ACCESS_WRITE; TexD.MiscFlags = 0; hr = m_MultiGPUTargetDevice->CreateTexture2D(&TexD, nullptr, &m_MultiGPUTexTarget); if (FAILED(hr)) { return ProcessFailure(m_MultiGPUTargetDevice, L"Failed to create copy-target texture", L"Desktop+ Error", hr); } } return DUPL_RETURN_SUCCESS; } void OutputManager::DrawFrameToOverlayTex(bool clear_rtv) { //Do a straight copy if there are no issues with that or do the alpha check if it's still pending if ((!m_OutputAlphaCheckFailed) || (m_OutputAlphaChecksPending > 0)) { m_DeviceContext->CopyResource(m_OvrlTex, m_SharedSurf); if (m_OutputAlphaChecksPending > 0) { //Check for translucent pixels (not fast) m_OutputAlphaCheckFailed = DesktopTextureAlphaCheck(); m_OutputAlphaChecksPending--; LOG_IF_F(WARNING, (m_OutputAlphaCheckFailed) && (m_OutputAlphaChecksPending == 0), "Failed Desktop Duplication alpha check, using extra render pass"); } } //Draw the frame to the texture with the alpha channel fixing pixel shader if we have to if (m_OutputAlphaCheckFailed) { // Set resources UINT Stride = sizeof(VERTEX); UINT Offset = 0; const FLOAT blendFactor[4] = { 0.0f, 0.0f, 0.0f, 0.0f }; m_DeviceContext->OMSetBlendState(nullptr, blendFactor, 0xffffffff); m_DeviceContext->OMSetRenderTargets(1, &m_OvrlRTV, nullptr); m_DeviceContext->VSSetShader(m_VertexShader, nullptr, 0); m_DeviceContext->PSSetShader(m_PixelShader, nullptr, 0); m_DeviceContext->PSSetShaderResources(0, 1, &m_ShaderResource); m_DeviceContext->PSSetSamplers(0, 1, &m_Sampler); m_DeviceContext->IASetPrimitiveTopology(D3D11_PRIMITIVE_TOPOLOGY_TRIANGLELIST); m_DeviceContext->IASetVertexBuffers(0, 1, &m_VertexBuffer, &Stride, &Offset); // Draw textured quad onto render target if (clear_rtv) { const float bgColor[4] = { 0.0f, 0.0f, 0.0f, 1.0f }; m_DeviceContext->ClearRenderTargetView(m_OvrlRTV, bgColor); } m_DeviceContext->Draw(NUMVERTICES, 0); } } // // Draw mouse provided in buffer to overlay texture // DUPL_RETURN OutputManager::DrawMouseToOverlayTex(_In_ PTR_INFO* PtrInfo) { //Just return if we don't need to render it if ((!ConfigManager::GetValue(configid_bool_input_mouse_render_cursor)) || (!PtrInfo->Visible)) { return DUPL_RETURN_SUCCESS; } ID3D11Buffer* VertexBuffer = nullptr; // Vars to be used D3D11_SUBRESOURCE_DATA InitData = {}; D3D11_TEXTURE2D_DESC Desc = {}; D3D11_SHADER_RESOURCE_VIEW_DESC SDesc = {}; // Position will be changed based on mouse position VERTEX Vertices[NUMVERTICES] = { { XMFLOAT3(-1.0f, -1.0f, 0), XMFLOAT2(0.0f, 1.0f) }, { XMFLOAT3(-1.0f, 1.0f, 0), XMFLOAT2(0.0f, 0.0f) }, { XMFLOAT3(1.0f, -1.0f, 0), XMFLOAT2(1.0f, 1.0f) }, { XMFLOAT3(1.0f, -1.0f, 0), XMFLOAT2(1.0f, 1.0f) }, { XMFLOAT3(-1.0f, 1.0f, 0), XMFLOAT2(0.0f, 0.0f) }, { XMFLOAT3(1.0f, 1.0f, 0), XMFLOAT2(1.0f, 0.0f) }, }; // Center of desktop dimensions FLOAT CenterX = (m_DesktopWidth / 2.0f); FLOAT CenterY = (m_DesktopHeight / 2.0f); // Clipping adjusted coordinates / dimensions INT PtrWidth = 0; INT PtrHeight = 0; INT PtrLeft = 0; INT PtrTop = 0; // Buffer used if necessary (in case of monochrome or masked pointer) Microsoft::WRL::ComPtr CursorTexNew; DXGI_FORMAT CursorTexNewFormat = DXGI_FORMAT_UNKNOWN; // Used for copying pixels if necessary D3D11_BOX Box = {}; Box.front = 0; Box.back = 1; //Process shape (or just get position when not new cursor) switch (PtrInfo->ShapeInfo.Type) { case DXGI_OUTDUPL_POINTER_SHAPE_TYPE_COLOR: { PtrLeft = PtrInfo->Position.x; PtrTop = PtrInfo->Position.y; PtrWidth = static_cast(PtrInfo->ShapeInfo.Width); PtrHeight = static_cast(PtrInfo->ShapeInfo.Height); break; } case DXGI_OUTDUPL_POINTER_SHAPE_TYPE_MONOCHROME: case DXGI_OUTDUPL_POINTER_SHAPE_TYPE_MASKED_COLOR: { PtrInfo->CursorShapeChanged = true; //Texture content is screen dependent const bool is_mono_cursor = (PtrInfo->ShapeInfo.Type == DXGI_OUTDUPL_POINTER_SHAPE_TYPE_MONOCHROME); //Process for HDR is needed if ((m_OutputHDRAvailable) && (ConfigManager::GetValue(configid_bool_performance_hdr_mirroring))) { ProcessMonoMaskFloat16(is_mono_cursor, *PtrInfo, PtrWidth, PtrHeight, PtrLeft, PtrTop, CursorTexNew, CursorTexNewFormat, Box); } else { ProcessMonoMask(is_mono_cursor, *PtrInfo, PtrWidth, PtrHeight, PtrLeft, PtrTop, CursorTexNew, CursorTexNewFormat, Box); } break; } default: break; } if (m_MouseCursorNeedsUpdate) { PtrInfo->CursorShapeChanged = true; } // VERTEX creation Vertices[0].Pos.x = (PtrLeft - CenterX) / CenterX; Vertices[0].Pos.y = -1 * ((PtrTop + PtrHeight) - CenterY) / CenterY; Vertices[1].Pos.x = (PtrLeft - CenterX) / CenterX; Vertices[1].Pos.y = -1 * (PtrTop - CenterY) / CenterY; Vertices[2].Pos.x = ((PtrLeft + PtrWidth) - CenterX) / CenterX; Vertices[2].Pos.y = -1 * ((PtrTop + PtrHeight) - CenterY) / CenterY; Vertices[3].Pos.x = Vertices[2].Pos.x; Vertices[3].Pos.y = Vertices[2].Pos.y; Vertices[4].Pos.x = Vertices[1].Pos.x; Vertices[4].Pos.y = Vertices[1].Pos.y; Vertices[5].Pos.x = ((PtrLeft + PtrWidth) - CenterX) / CenterX; Vertices[5].Pos.y = -1 * (PtrTop - CenterY) / CenterY; //Vertex buffer description D3D11_BUFFER_DESC BDesc; ZeroMemory(&BDesc, sizeof(D3D11_BUFFER_DESC)); BDesc.Usage = D3D11_USAGE_DEFAULT; BDesc.ByteWidth = sizeof(VERTEX) * NUMVERTICES; BDesc.BindFlags = D3D11_BIND_VERTEX_BUFFER; BDesc.CPUAccessFlags = 0; ZeroMemory(&InitData, sizeof(D3D11_SUBRESOURCE_DATA)); InitData.pSysMem = Vertices; // Create vertex buffer HRESULT hr = m_Device->CreateBuffer(&BDesc, &InitData, &VertexBuffer); if (FAILED(hr)) { m_MouseShaderRes.Reset(); m_MouseTex.Reset(); return ProcessFailure(m_Device, L"Failed to create mouse pointer vertex buffer in OutputManager", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } //It can occasionally happen that no cursor shape update is detected after resetting duplication, so the m_MouseTex check is more of a workaround, but unproblematic if ( (PtrInfo->CursorShapeChanged) || (m_MouseTex == nullptr) ) { //Only create a texture here for regular color cursors (mask/mono were already created) if (PtrInfo->ShapeInfo.Type == DXGI_OUTDUPL_POINTER_SHAPE_TYPE_COLOR) { Desc.Width = PtrWidth; Desc.Height = PtrHeight; Desc.MipLevels = 1; Desc.ArraySize = 1; Desc.Format = DXGI_FORMAT_B8G8R8A8_UNORM; Desc.SampleDesc.Count = 1; Desc.SampleDesc.Quality = 0; Desc.Usage = D3D11_USAGE_DEFAULT; Desc.BindFlags = D3D11_BIND_SHADER_RESOURCE; Desc.CPUAccessFlags = 0; Desc.MiscFlags = 0; //Set up init data InitData.pSysMem = PtrInfo->ShapeBuffer.data(); InitData.SysMemPitch = PtrInfo->ShapeInfo.Pitch; InitData.SysMemSlicePitch = 0; // Create mouseshape as texture hr = m_Device->CreateTexture2D(&Desc, &InitData, &m_MouseTex); if (FAILED(hr)) { return ProcessFailure(m_Device, L"Failed to create mouse pointer texture", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } } else { m_MouseTex = CursorTexNew; } if (m_MouseTex != nullptr) { //Set shader resource properties SDesc.Format = (PtrInfo->ShapeInfo.Type == DXGI_OUTDUPL_POINTER_SHAPE_TYPE_COLOR) ? DXGI_FORMAT_B8G8R8A8_UNORM : CursorTexNewFormat; SDesc.ViewDimension = D3D11_SRV_DIMENSION_TEXTURE2D; SDesc.Texture2D.MostDetailedMip = 0; SDesc.Texture2D.MipLevels = 1; // Create shader resource from texture hr = m_Device->CreateShaderResourceView(m_MouseTex.Get(), &SDesc, &m_MouseShaderRes); if (FAILED(hr)) { m_MouseTex.Reset(); return ProcessFailure(m_Device, L"Failed to create shader resource from mouse pointer texture", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } } } // Set resources FLOAT BlendFactor[4] = { 0.f, 0.f, 0.f, 0.f }; UINT Stride = sizeof(VERTEX); UINT Offset = 0; m_DeviceContext->IASetVertexBuffers(0, 1, &VertexBuffer, &Stride, &Offset); m_DeviceContext->OMSetBlendState(m_BlendState, BlendFactor, 0xFFFFFFFF); m_DeviceContext->OMSetRenderTargets(1, &m_OvrlRTV, nullptr); m_DeviceContext->VSSetShader(m_VertexShader, nullptr, 0); m_DeviceContext->PSSetShader(m_PixelShaderCursor, nullptr, 0); m_DeviceContext->PSSetShaderResources(0, 1, m_MouseShaderRes.GetAddressOf()); m_DeviceContext->PSSetSamplers(0, 1, &m_Sampler); // Draw m_DeviceContext->Draw(NUMVERTICES, 0); // Clean if (VertexBuffer) { VertexBuffer->Release(); VertexBuffer = nullptr; } m_MouseCursorNeedsUpdate = false; return DUPL_RETURN_SUCCESS; } DUPL_RETURN_UPD OutputManager::RefreshOpenVROverlayTexture(DPRect& DirtyRectTotal, bool force_full_copy) { if ((m_OvrlHandleDesktopTexture != vr::k_ulOverlayHandleInvalid) && (m_OvrlTex)) { vr::Texture_t vrtex; vrtex.eType = vr::TextureType_DirectX; vrtex.eColorSpace = ((m_OutputHDRAvailable) && (ConfigManager::GetValue(configid_bool_performance_hdr_mirroring))) ? vr::ColorSpace_Linear : vr::ColorSpace_Gamma; vrtex.handle = m_OvrlTex; //The intermediate texture can be assumed to be not complete when a full copy is forced, so redraw that if (force_full_copy) { //Try to acquire sync for shared surface needed by DrawFrameToOverlayTex() HRESULT hr = m_KeyMutex->AcquireSync(0, m_MaxActiveRefreshDelay); if (hr == static_cast(WAIT_TIMEOUT)) { //Another thread has the keyed mutex so there will be a new frame ready after this. //Bail out and just set the pending dirty region to full so everything gets drawn over on the next update m_OutputPendingDirtyRect = {0, 0, m_DesktopWidth, m_DesktopHeight}; return DUPL_RETURN_UPD_RETRY; } else if (FAILED(hr)) { return (DUPL_RETURN_UPD)ProcessFailure(m_Device, L"Failed to acquire keyed mutex", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } DrawFrameToOverlayTex(true); //Release keyed mutex hr = m_KeyMutex->ReleaseSync(0); if (FAILED(hr)) { return (DUPL_RETURN_UPD)ProcessFailure(m_Device, L"Failed to Release keyed mutex", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } //We don't draw the cursor here as this can lead to tons of issues for little gain. We might not even know what the cursor looks like if it was cropped out previously, etc. //We do mark where the cursor has last been seen as pending dirty region, however, so it gets updated at the next best moment even if it didn't move if (m_MouseLastInfo.Visible) { m_OutputPendingDirtyRect = { m_MouseLastInfo.Position.x, m_MouseLastInfo.Position.y, int(m_MouseLastInfo.Position.x + m_MouseLastInfo.ShapeInfo.Width), int(m_MouseLastInfo.Position.y + m_MouseLastInfo.ShapeInfo.Height) }; } } //Copy texture over to GPU connected to VR HMD if needed if (m_MultiGPUTargetDevice != nullptr) { //This isn't very fast but the only way to my knowledge. Happy to receive improvements on this though m_DeviceContext->CopyResource(m_MultiGPUTexStaging, m_OvrlTex); D3D11_MAPPED_SUBRESOURCE mapped_resource_staging; RtlZeroMemory(&mapped_resource_staging, sizeof(D3D11_MAPPED_SUBRESOURCE)); HRESULT hr = m_DeviceContext->Map(m_MultiGPUTexStaging, 0, D3D11_MAP_READ, 0, &mapped_resource_staging); if (FAILED(hr)) { return (DUPL_RETURN_UPD)ProcessFailure(m_Device, L"Failed to map staging texture", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } D3D11_MAPPED_SUBRESOURCE mapped_resource_target; RtlZeroMemory(&mapped_resource_target, sizeof(D3D11_MAPPED_SUBRESOURCE)); hr = m_MultiGPUTargetDeviceContext->Map(m_MultiGPUTexTarget, 0, D3D11_MAP_WRITE_DISCARD, 0, &mapped_resource_target); if (FAILED(hr)) { return (DUPL_RETURN_UPD)ProcessFailure(m_MultiGPUTargetDevice, L"Failed to map copy-target texture", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } memcpy(mapped_resource_target.pData, mapped_resource_staging.pData, m_DesktopHeight * mapped_resource_staging.RowPitch); m_DeviceContext->Unmap(m_MultiGPUTexStaging, 0); m_MultiGPUTargetDeviceContext->Unmap(m_MultiGPUTexTarget, 0); vrtex.handle = m_MultiGPUTexTarget; } //Do a simple full copy (done below) if the rect covers the whole texture (this isn't slower than a full rect copy and works with size changes) force_full_copy = ( (force_full_copy) || (DirtyRectTotal.Contains({0, 0, m_DesktopWidth, m_DesktopHeight})) ); if (!force_full_copy) //Otherwise do a partial copy { //Get overlay texture from OpenVR and copy dirty rect directly into it ID3D11Texture2D* reference_texture = (ID3D11Texture2D*)vrtex.handle; ID3D11ShaderResourceView* ovrl_shader_rsv; ovrl_shader_rsv = vr::VROverlayEx()->GetOverlayTextureEx(m_OvrlHandleDesktopTexture, reference_texture); if (ovrl_shader_rsv != nullptr) { ID3D11DeviceContext* device_context = (m_MultiGPUTargetDevice != nullptr) ? m_MultiGPUTargetDeviceContext : m_DeviceContext; Microsoft::WRL::ComPtr ovrl_tex; ovrl_shader_rsv->GetResource(&ovrl_tex); D3D11_BOX box = {0}; box.left = DirtyRectTotal.GetTL().x; box.top = DirtyRectTotal.GetTL().y; box.front = 0; box.right = DirtyRectTotal.GetBR().x; box.bottom = DirtyRectTotal.GetBR().y; box.back = 1; device_context->CopySubresourceRegion(ovrl_tex.Get(), 0, box.left, box.top, 0, reference_texture, 0, &box); //RSV is kept around by IVROverlayEx and not released here } else //Usually shouldn't fail, but fall back to full copy then { force_full_copy = true; } } if (force_full_copy) //This is down here so a failed partial copy is picked up as well { bool refresh_shared_texture = false; vr::VROverlayEx()->SetOverlayTextureEx(m_OvrlHandleDesktopTexture, &vrtex, {m_DesktopWidth, m_DesktopHeight}, &refresh_shared_texture); //Apply potential texture change to all overlays and notify them of duplication update for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { Overlay& overlay = OverlayManager::Get().GetOverlay(i); if (refresh_shared_texture) { overlay.AssignDesktopDuplicationTexture(); } overlay.OnDesktopDuplicationUpdate(); } } else { //Notifiy all overlays of duplication update for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { OverlayManager::Get().GetOverlay(i).OnDesktopDuplicationUpdate(); } } } return DUPL_RETURN_UPD_SUCCESS_REFRESHED_OVERLAY; } bool OutputManager::DesktopTextureAlphaCheck() { if (m_DesktopRects.empty()) return false; //Sanity check texture dimensions D3D11_TEXTURE2D_DESC desc_ovrl_tex; m_OvrlTex->GetDesc(&desc_ovrl_tex); if ( ((UINT)m_DesktopWidth != desc_ovrl_tex.Width) || ((UINT)m_DesktopHeight != desc_ovrl_tex.Height) ) return false; //Read one pixel for each desktop const int pixel_count = m_DesktopRects.size(); //Create a staging texture D3D11_TEXTURE2D_DESC desc = {0}; desc.Width = pixel_count; desc.Height = 1; desc.MipLevels = 1; desc.ArraySize = 1; desc.Format = desc_ovrl_tex.Format; desc.SampleDesc.Count = 1; desc.SampleDesc.Quality = 0; desc.Usage = D3D11_USAGE_STAGING; desc.CPUAccessFlags = D3D11_CPU_ACCESS_READ; desc.BindFlags = 0; desc.MiscFlags = 0; Microsoft::WRL::ComPtr tex_staging; HRESULT hr = m_Device->CreateTexture2D(&desc, nullptr, &tex_staging); if (FAILED(hr)) { return false; } //Copy a single pixel to staging texture for each desktop D3D11_BOX box = {0}; box.front = 0; box.back = 1; UINT dst_x = 0; for (const DPRect& rect : m_DesktopRects) { box.left = clamp(rect.GetTL().x - m_DesktopX, 0, m_DesktopWidth - 1); box.right = clamp(box.left + 1, 1u, (UINT)m_DesktopWidth); box.top = clamp(rect.GetTL().y - m_DesktopY, 0, m_DesktopHeight - 1); box.bottom = clamp(box.top + 1, 1u, (UINT)m_DesktopHeight); m_DeviceContext->CopySubresourceRegion(tex_staging.Get(), 0, dst_x, 0, 0, m_OvrlTex, 0, &box); dst_x++; } //Map texture and get the pixels we just copied D3D11_MAPPED_SUBRESOURCE mapped_resource; hr = m_DeviceContext->Map(tex_staging.Get(), 0, D3D11_MAP_READ, 0, &mapped_resource); if (FAILED(hr)) { return false; } //Check alpha value for anything between 0% and 100% transparency, which should not happen but apparently does bool ret = false; if (desc.Format == DXGI_FORMAT_B8G8R8A8_UNORM) { for (int i = 0; i < pixel_count * 4; i += 4) { unsigned char a = ((unsigned char*)mapped_resource.pData)[i + 3]; if ((a > 0) && (a < 255)) { ret = true; break; } } } else if (desc.Format == DXGI_FORMAT_R16G16B16A16_FLOAT) { for (int i = 0; i < pixel_count * 4; i += 4) { PackedVector::HALF a_half = ((PackedVector::HALF*)mapped_resource.pData)[i + 3]; float a = PackedVector::XMConvertHalfToFloat(a_half); if ((a > 0.0f) && (a < 1.0f)) { ret = true; break; } } } //Cleanup m_DeviceContext->Unmap(tex_staging.Get(), 0); return ret; } bool OutputManager::HandleOpenVREvents() { vr::VREvent_t vr_event; //Handle Dashboard dummy ones first while (vr::VROverlay()->PollNextOverlayEvent(m_OvrlHandleDashboardDummy, &vr_event, sizeof(vr_event))) { switch (vr_event.eventType) { case vr::VREvent_OverlayShown: { if (!m_OvrlDashboardActive) { m_OvrlDashboardActive = true; m_DashboardActivatedOnce = true; //Bringing up the Desktop+ also fixes what we work around with by keeping track of this for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { const OverlayConfigData& data = OverlayManager::Get().GetConfigData(i); if (data.ConfigInt[configid_int_overlay_display_mode] != ovrl_dispmode_scene) { ShowOverlay(i); } } m_BackgroundOverlay.Update(); m_OverlayDragger.UpdateTempStandingPosition(); if (ConfigManager::GetValue(configid_bool_interface_dim_ui)) { DimDashboard(true); } } break; } case vr::VREvent_OverlayHidden: { if (m_OvrlDashboardActive) { m_OvrlDashboardActive = false; for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { const OverlayConfigData& data = OverlayManager::Get().GetConfigData(i); if (data.ConfigInt[configid_int_overlay_display_mode] == ovrl_dispmode_dplustab) { HideOverlay(i); } } m_BackgroundOverlay.Update(); if (ConfigManager::GetValue(configid_bool_interface_dim_ui)) { DimDashboard(false); } } break; } case vr::VREvent_DashboardActivated: { //The dashboard transform we're using basically cannot be trusted to be correct unless the dashboard has been manually brought up once. //On launch, SteamVR activates the dashboard automatically. Sometimes with and sometimes without this event firing. //In that case, the primary dashboard device is the HMD (or sometimes just invalid). That means we can be sure other dashboard device's activations are user-initiated. //We simply don't show dashboard-origin overlays until the dashboard has been properly activated once. //For HMD-only usage, switching to the Desktop+ dashboard tab also works if ( (!m_DashboardActivatedOnce) && (vr::VROverlay()->GetPrimaryDashboardDevice() != vr::k_unTrackedDeviceIndex_Hmd) && (vr::VROverlay()->GetPrimaryDashboardDevice() != vr::k_unTrackedDeviceIndexInvalid) ) { m_DashboardActivatedOnce = true; } //Get current HMD y-position, used for getting the overlay position UpdateDashboardHMD_Y(); //Hacky workaround, need to wait for the dashboard to finish appearing when not in Desktop+ tab if (!m_OvrlDashboardActive) { ::Sleep(300); } for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { const OverlayConfigData& data = OverlayManager::Get().GetConfigData(i); if ((m_DashboardActivatedOnce) && (data.ConfigInt[configid_int_overlay_display_mode] == ovrl_dispmode_dashboard)) { ShowOverlay(i); } else if (data.ConfigInt[configid_int_overlay_display_mode] == ovrl_dispmode_scene) { HideOverlay(i); } else if (data.ConfigInt[configid_int_overlay_origin] == ovrl_origin_dashboard) //Dashboard origin with Always display mode, update pos { unsigned int current_overlay_old = OverlayManager::Get().GetCurrentOverlayID(); OverlayManager::Get().SetCurrentOverlayID(i); ApplySettingTransform(); OverlayManager::Get().SetCurrentOverlayID(current_overlay_old); } } //Finish a direct drag if one's going as the Desktop+ laser pointer will not be told inputs are released when the dashboard is up if (m_OvrlDirectDragActive) { OverlayDirectDragFinish(m_OverlayDragger.GetDragOverlayID()); } IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_drag_hint_type, 0); break; } case vr::VREvent_DashboardDeactivated: { for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { OverlayConfigData& data = OverlayManager::Get().GetConfigData(i); if (data.ConfigInt[configid_int_overlay_display_mode] == ovrl_dispmode_scene) { ShowOverlay(i); } else if (data.ConfigInt[configid_int_overlay_display_mode] == ovrl_dispmode_dashboard) { HideOverlay(i); } } if (ConfigManager::GetValue(configid_bool_windows_auto_focus_scene_app_dashboard)) { WindowManager::Get().FocusActiveVRSceneApp(&m_InputSim); } //In unfortunate situations we can have a target window set and close the dashboard without getting a mouse up event ever, //so we reset the target and mouse on dashboard close if (WindowManager::Get().GetTargetWindow() != nullptr) { m_InputSim.MouseSetLeftDown(false); WindowManager::Get().SetTargetWindow(nullptr); } //Finish a temp drag if one's going DetachedTempDragFinish(); //If there is a drag going with a dashboard origin overlay (or related display mode), cancel or finish it to avoid the overlay ending up in a random spot if ( (m_OverlayDragger.IsDragActive()) || (m_OverlayDragger.IsDragGestureActive()) ) { const OverlayConfigData& data = OverlayManager::Get().GetConfigData(m_OverlayDragger.GetDragOverlayID()); if ( (data.ConfigInt[configid_int_overlay_origin] == ovrl_origin_dashboard) || (data.ConfigInt[configid_int_overlay_display_mode] == ovrl_dispmode_dashboard) || (data.ConfigInt[configid_int_overlay_display_mode] == ovrl_dispmode_dplustab) ) { if (m_OverlayDragger.IsDragActive()) { unsigned int current_overlay_old = OverlayManager::Get().GetCurrentOverlayID(); OverlayManager::Get().SetCurrentOverlayID(m_OverlayDragger.GetDragOverlayID()); OnDragFinish(); m_OverlayDragger.DragCancel(); //Overlay can still disappear, so we just cancel the drag instead ApplySettingTransform(); OverlayManager::Get().SetCurrentOverlayID(current_overlay_old); } else if (m_OverlayDragger.IsDragGestureActive()) { m_OverlayDragger.DragGestureFinish(); } } } IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_drag_hint_type, 0); break; } case vr::VREvent_SeatedZeroPoseReset: case vr::VREvent_ChaperoneUniverseHasChanged: { DetachedTransformUpdateSeatedPosition(); break; } case vr::VREvent_SceneApplicationChanged: { DetachedTransformUpdateSeatedPosition(); const bool loaded_overlay_profile = ConfigManager::Get().GetAppProfileManager().ActivateProfileForProcess(vr_event.data.process.pid); if (loaded_overlay_profile) ResetOverlays(); break; } case vr::VREvent_Input_ActionManifestReloaded: case vr::VREvent_Input_BindingsUpdated: case vr::VREvent_Input_BindingLoadSuccessful: { m_VRInput.RefreshAnyGlobalActionBound(); break; } case vr::VREvent_TrackedDeviceActivated: { m_VRInput.RefreshAnyGlobalActionBound(); //Apply transforms of all device origin overlays in case a previously unavailable device was used by one of them unsigned int current_overlay_old = OverlayManager::Get().GetCurrentOverlayID(); for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { const OverlayConfigData& data = OverlayManager::Get().GetConfigData(i); if ((data.ConfigInt[configid_int_overlay_origin] >= ovrl_origin_left_hand) && (data.ConfigInt[configid_int_overlay_origin] <= ovrl_origin_aux)) { OverlayManager::Get().SetCurrentOverlayID(i); ApplySettingTransform(); } } OverlayManager::Get().SetCurrentOverlayID(current_overlay_old); break; } case vr::VREvent_TrackedDeviceDeactivated: { m_VRInput.RefreshAnyGlobalActionBound(); m_LaserPointer.RemoveDevice(vr_event.trackedDeviceIndex); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_drag_hint_type, 0); break; } case vr::VREvent_Quit: { return true; } } } //Now handle events for the actual overlays int overlay_focus_count = (m_OvrlInputActive) ? 1 : 0; //Keep track of multiple overlay focus enter/leave happening within the same frame to set m_OvrlInputActive correctly afterwards unsigned int current_overlay_old = OverlayManager::Get().GetCurrentOverlayID(); for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { OverlayManager::Get().SetCurrentOverlayID(i); Overlay& overlay = OverlayManager::Get().GetCurrentOverlay(); vr::VROverlayHandle_t ovrl_handle = overlay.GetHandle(); const OverlayConfigData& data = OverlayManager::Get().GetCurrentConfigData(); while (vr::VROverlay()->PollNextOverlayEvent(ovrl_handle, &vr_event, sizeof(vr_event))) { switch (vr_event.eventType) { case vr::VREvent_MouseMove: case vr::VREvent_MouseButtonDown: case vr::VREvent_MouseButtonUp: case vr::VREvent_ScrollDiscrete: case vr::VREvent_ScrollSmooth: { OnOpenVRMouseEvent(vr_event, current_overlay_old); break; } case vr::VREvent_ButtonPress: { if (vr_event.data.controller.button == Button_Dashboard_GoHome) { ConfigManager::Get().GetActionManager().StartAction(ConfigManager::GetValue(configid_handle_input_go_home_action_uid), i); } else if (vr_event.data.controller.button == Button_Dashboard_GoBack) { ConfigManager::Get().GetActionManager().StartAction(ConfigManager::GetValue(configid_handle_input_go_back_action_uid), i); } break; } case vr::VREvent_ButtonUnpress: { if (vr_event.data.controller.button == Button_Dashboard_GoHome) { ConfigManager::Get().GetActionManager().StopAction(ConfigManager::GetValue(configid_handle_input_go_home_action_uid), i); } else if (vr_event.data.controller.button == Button_Dashboard_GoBack) { ConfigManager::Get().GetActionManager().StopAction(ConfigManager::GetValue(configid_handle_input_go_back_action_uid), i); } break; } case vr::VREvent_FocusEnter: { overlay_focus_count++; const bool drag_or_select_mode_enabled = ( (ConfigManager::GetValue(configid_bool_state_overlay_dragmode)) || (ConfigManager::GetValue(configid_bool_state_overlay_selectmode)) ); if (!drag_or_select_mode_enabled) { if (ConfigManager::Get().GetPrimaryLaserPointerDevice() == vr::k_unTrackedDeviceIndex_Hmd) { ResetMouseLastLaserPointerPos(); } //If it's a WinRT window capture, check for window management stuff if ( (overlay.GetTextureSource() == ovrl_texsource_winrt_capture) && (data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd] != 0) ) { if ( (!m_MouseIgnoreMoveEvent) && (ConfigManager::GetValue(configid_bool_windows_winrt_auto_focus)) ) { WindowManager::Get().RaiseAndFocusWindow((HWND)data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd], &m_InputSim); } if (ConfigManager::GetValue(configid_bool_windows_winrt_keep_on_screen)) { WindowManager::MoveWindowIntoWorkArea((HWND)data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd]); } } } break; } case vr::VREvent_FocusLeave: { overlay_focus_count--; const bool drag_or_select_mode_enabled = ( (ConfigManager::GetValue(configid_bool_state_overlay_dragmode)) || (ConfigManager::GetValue(configid_bool_state_overlay_selectmode)) ); if (!drag_or_select_mode_enabled) { //If leaving a WinRT window capture and the option is enabled, focus the active scene app if ( (!m_MouseIgnoreMoveEvent) && (ConfigManager::GetValue(configid_bool_windows_winrt_auto_focus_scene_app)) && (overlay.GetTextureSource() == ovrl_texsource_winrt_capture) && (data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd] != 0) ) { WindowManager::Get().FocusActiveVRSceneApp(&m_InputSim); } //A resize while drag can make the pointer lose focus, which is pretty janky. Remove target and do mouse up at least. if (WindowManager::Get().GetTargetWindow() != nullptr) { const bool use_pen = ConfigManager::GetValue(configid_bool_input_mouse_simulate_pen_input); (use_pen) ? m_InputSim.PenSetPrimaryDown(false) : m_InputSim.MouseSetLeftDown(false); WindowManager::Get().SetTargetWindow(nullptr); } WindowManager::Get().ClearTempTopMostWindow(); } //Finish drag if there's somehow still one going (and not temp drag mode, where this is expected) if ( (m_OverlayDragger.IsDragActive()) && (!ConfigManager::GetValue(configid_bool_state_overlay_dragmode_temp)) ) { OnDragFinish(); m_OverlayDragger.DragFinish(); ApplySettingTransform(); } //For browser overlays, forward leave event to browser process if (overlay.GetTextureSource() == ovrl_texsource_browser) { DPBrowserAPIClient::Get().DPBrowser_MouseLeave(overlay.GetHandle()); break; } m_InputSim.PenLeave(); break; } case vr::VREvent_OverlayClosed: case vr::VREvent_OverlayHidden: { //Theater overlay was hidden by something (close button, other overlay taking over, etc.), disable it //There may be cases where the overlay doesn't send the hidden event for this (varies between SteamVR builds), for that we also have a hack further below, //though it's mostly harmless if this doesn't work (phantom dashboard tab) if (OverlayManager::Get().GetTheaterOverlayID() == i) { SetOverlayEnabled(i, false); } break; } case vr::VREvent_ChaperoneUniverseHasChanged: { //We also get this when tracking is lost, which ends up updating the dashboard position if (m_OvrlActiveCount != 0) { ApplySettingTransform(); } break; } default: { //Output unhandled events when looking for something useful /*std::wstringstream ss; ss << L"Event: " << (int)vr_event.eventType << L"\n"; OutputDebugString(ss.str().c_str());*/ break; } } } } OverlayManager::Get().SetCurrentOverlayID(current_overlay_old); m_OvrlInputActive = (overlay_focus_count > 0); //Handle stuff coming from SteamVR Input m_VRInput.Update(); //Handle Enable Global Laser Pointer binding vr::InputDigitalActionData_t enable_laser_pointer_state = m_VRInput.GetEnableGlobalLaserPointerState(); if (enable_laser_pointer_state.bChanged) { if (enable_laser_pointer_state.bState) { if (!m_LaserPointer.IsActive()) //Don't switch devices if the pointer is already active { //Get tracked device index from origin vr::InputOriginInfo_t origin_info = m_VRInput.GetOriginTrackedDeviceInfoEx(enable_laser_pointer_state.activeOrigin); if (origin_info.trackedDeviceIndex != vr::k_unTrackedDeviceIndexInvalid) { m_LaserPointer.SetActiveDevice(origin_info.trackedDeviceIndex, dplp_activation_origin_input_binding); //Disable active laser pointer override so the device's pointer can be used right away m_MouseIgnoreMoveEvent = false; ResetMouseLastLaserPointerPos(); } } } else if (m_LaserPointer.GetActivationOrigin() == dplp_activation_origin_input_binding) { m_LaserPointer.ClearActiveDevice(); } } m_VRInput.HandleGlobalActionShortcuts(*this); //Finish up pending keyboard input collected into the queue m_InputSim.KeyboardTextFinish(); HandleHotkeys(); HandleKeyboardAutoVisibility(); //Update position if necessary bool dashboard_origin_was_updated = false; if (HasDashboardMoved()) //The dashboard can move from events we can't detect, like putting the HMD back on, so we check manually as a workaround { UpdateDashboardHMD_Y(); dashboard_origin_was_updated = true; } bool transform_frame_update_was_done = false; //Frame transform updates need to track the last time they were done, but only once for all overlays for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { OverlayManager::Get().SetCurrentOverlayID(i); Overlay& overlay = OverlayManager::Get().GetCurrentOverlay(); const OverlayConfigData& data = OverlayManager::Get().GetCurrentConfigData(); if (data.ConfigBool[configid_bool_overlay_enabled]) { if (overlay.IsVisible()) { if (m_OverlayDragger.GetDragOverlayID() == overlay.GetID()) { if (m_OverlayDragger.IsDragActive()) { m_OverlayDragger.DragUpdate(); } else if (m_OverlayDragger.IsDragGestureActive()) { m_OverlayDragger.DragGestureUpdate(); } } else if ((data.ConfigInt[configid_int_overlay_origin] == ovrl_origin_hmd_floor) || (data.ConfigInt[configid_int_overlay_origin] == ovrl_origin_hmd)) { if (DetachedTransformFrameUpdate()) { transform_frame_update_was_done = true; } } else if ( (dashboard_origin_was_updated) && (m_OverlayDragger.GetDragDeviceID() == -1) && (!m_OverlayDragger.IsDragGestureActive()) && (data.ConfigInt[configid_int_overlay_origin] == ovrl_origin_dashboard) ) { ApplySettingTransform(); } } DetachedOverlayGazeFade(); } } if (transform_frame_update_was_done) { m_LastFrameTransformUpdateTick = ::GetTickCount64(); } OverlayManager::Get().SetCurrentOverlayID(current_overlay_old); DetachedInteractionAutoToggleAll(); DetachedOverlayAutoDockingAll(); m_LaserPointer.Update(); //Hack: //We don't get an event when the Theater Screen close button is being used, which puts it in the dashboard (we don't want this), //but IsActiveDashboardOverlay() is true if it's visible on the screen so it doesn't help either to detected this. //So we instead check if its middle transform gets too close to the dashboard (transform is based on Theater Screen if it's on there, otherwise the dashboard tab). //The case of this happening in normal use is fairly low, so it'll have to do for now if (OverlayManager::Get().GetTheaterOverlayID() != k_ulOverlayID_None) { if (vr::VROverlay()->IsDashboardVisible()) { vr::VROverlayHandle_t system_dashboard; vr::VROverlay()->FindOverlay("system.systemui", &system_dashboard); const Matrix4 mat_dashboard = m_OverlayDragger.GetBaseOffsetMatrix(ovrl_origin_dashboard); const Matrix4 mat_theater = OverlayManager::Get().GetOverlayMiddleTransform(OverlayManager::Get().GetTheaterOverlayID()); Vector3 pos_dashboard = mat_dashboard.getTranslation(); Vector3 pos_theater = mat_theater.getTranslation(); pos_dashboard.y = pos_theater.y; float distance = pos_dashboard.distance(pos_theater); //Distance should be between 0.009f and 0.019f (SteamVR 2 dashboard) in practice so this hopefully has a big enough tolerance if (distance < 0.05f) { vr::VROverlay()->ShowDashboard("elvissteinjr.DesktopPlusDashboard"); //Defaults to Steam tab so try to get it to display ours instead SetOverlayEnabled(OverlayManager::Get().GetTheaterOverlayID(), false); } } } //Handle delayed dashboard dummy updates if ( (m_PendingDashboardDummyHeight != 0.0f) && (m_LastApplyTransformTick + 100 < ::GetTickCount64()) ) { UpdatePendingDashboardDummyHeight(); } FinishQueuedOverlayRemovals(); return false; } void OutputManager::OnOpenVRMouseEvent(const vr::VREvent_t& vr_event, unsigned int& current_overlay_old) { const Overlay& overlay_current = OverlayManager::Get().GetCurrentOverlay(); const OverlayConfigData& data = OverlayManager::Get().GetCurrentConfigData(); const bool use_pen = ConfigManager::GetValue(configid_bool_input_mouse_simulate_pen_input); switch (vr_event.eventType) { case vr::VREvent_MouseMove: { if ( (!data.ConfigBool[configid_bool_overlay_input_enabled]) || ( (m_MouseIgnoreMoveEvent) && (overlay_current.GetTextureSource() != ovrl_texsource_browser) ) || (ConfigManager::GetValue(configid_bool_state_overlay_dragmode)) || (ConfigManager::GetValue(configid_bool_state_overlay_selectmode)) || (m_OverlayDragger.IsDragActive()) || (overlay_current.GetTextureSource() == ovrl_texsource_none) || (overlay_current.GetTextureSource() == ovrl_texsource_ui) ) { break; } Vector2 event_mouse_pos(vr_event.data.mouse.x, vr_event.data.mouse.y); //Smooth input if (ConfigManager::GetValue(configid_int_input_mouse_input_smoothing_level) != 0) { m_MouseLaserPointerSmoother.ApplyPresetSettings(ConfigManager::GetValue(configid_int_input_mouse_input_smoothing_level)); event_mouse_pos = m_MouseLaserPointerSmoother.Filter(event_mouse_pos); } //Offset depending on capture source int content_height = data.ConfigInt[configid_int_overlay_state_content_height]; int offset_x = 0; int offset_y = 0; if (data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_winrt_capture) { int desktop_id = data.ConfigInt[configid_int_overlay_winrt_desktop_id]; if (desktop_id != -2) //Desktop capture through WinRT { if ( (desktop_id >= 0) && (desktop_id < m_DesktopRects.size()) ) { offset_x = m_DesktopRects[desktop_id].GetTL().x; offset_y = m_DesktopRects[desktop_id].GetTL().y; } else if (desktop_id == -1) //Combined desktop { content_height = m_DesktopRectTotal.GetHeight(); offset_x = m_DesktopRectTotal.GetTL().x; offset_y = m_DesktopRectTotal.GetTL().y; } } else //Window capture { HWND window_handle = (HWND)data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd]; //Get position of the window RECT window_rect = {0}; if (::DwmGetWindowAttribute(window_handle, DWMWA_EXTENDED_FRAME_BOUNDS, &window_rect, sizeof(window_rect)) == S_OK) { offset_x = window_rect.left; offset_y = window_rect.top; } } } else if (data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_desktop_duplication) { content_height = m_DesktopHeight; offset_x = m_DesktopX; offset_y = m_DesktopY; } //SteamVR ignores 3D properties when adjusting coordinates for custom UV values, so we need to add offsets manually if (data.ConfigBool[configid_bool_overlay_3D_enabled]) { Overlay3DMode mode_3D = (Overlay3DMode)data.ConfigInt[configid_int_overlay_3D_mode]; if (mode_3D >= ovrl_3Dmode_hou) { offset_x += overlay_current.GetValidatedCropRect().GetTL().x; } else { offset_x += overlay_current.GetValidatedCropRect().GetTL().x / 2; } } //GL space (0,0 is bottom left), so we need to flip that around (not correct for browser overlays, but also not relevant for how the values are used with them right now) int pointer_x = round(event_mouse_pos.x) + offset_x; int pointer_y = (-round(event_mouse_pos.y) + content_height) + offset_y; //If double click assist is current active, check if there was an obviously deliberate movement and cancel it then if ( (ConfigManager::GetValue(configid_int_state_mouse_dbl_click_assist_duration_ms) != 0) && (::GetTickCount64() < m_MouseLastClickTick + ConfigManager::GetValue(configid_int_state_mouse_dbl_click_assist_duration_ms)) ) { if ((abs(pointer_x - m_MouseLastLaserPointerX) > 64) || (abs(pointer_y - m_MouseLastLaserPointerY) > 64)) { m_MouseLastClickTick = 0; } else //But if not, still block the movement { m_MouseLastLaserPointerMoveBlocked = true; break; } } //If browser overlay, pass event along and skip the rest if (overlay_current.GetTextureSource() == ovrl_texsource_browser) { DPBrowserAPIClient::Get().DPBrowser_MouseMove(overlay_current.GetHandle(), pointer_x, pointer_y); m_MouseLastLaserPointerX = pointer_x; m_MouseLastLaserPointerY = pointer_y; break; } //Check if this mouse move would start a drag of a maximized window's title bar if ( (ConfigManager::GetValue(configid_int_windows_winrt_dragging_mode) != window_dragging_none) && (overlay_current.GetTextureSource() == ovrl_texsource_winrt_capture) && (data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd] != 0) ) { if (WindowManager::Get().WouldDragMaximizedTitleBar((HWND)data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd], m_MouseLastLaserPointerX, m_MouseLastLaserPointerY, pointer_x, pointer_y)) { //Reset input and WindowManager state manually to block the drag but still move the cursor on the next mouse move event (use_pen) ? m_InputSim.PenSetPrimaryDown(false) : m_InputSim.MouseSetLeftDown(false); WindowManager::Get().SetTargetWindow(nullptr); //Start overlay drag if setting enabled if (ConfigManager::GetValue(configid_int_windows_winrt_dragging_mode) == window_dragging_overlay) { if (data.ConfigInt[configid_int_overlay_origin] != ovrl_origin_theater_screen) { if (!data.ConfigBool[configid_bool_overlay_transform_locked]) { m_OverlayDragger.DragStart(OverlayManager::Get().GetCurrentOverlayID()); } else { IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_drag_hint_device, ConfigManager::Get().GetPrimaryLaserPointerDevice()); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_drag_hint_type, 1); } } else { IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_drag_hint_device, ConfigManager::Get().GetPrimaryLaserPointerDevice()); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_drag_hint_type, 2); } } break; //We're not moving the cursor this time, get out } } //Check coordinates if laser pointer override is enabled, unless left mouse is held down by the laser pointer if ( (m_MouseLeftDownOverlayID == k_ulOverlayID_None) && (ConfigManager::GetValue(configid_bool_input_mouse_allow_pointer_override)) ) { POINT pt; ::GetCursorPos(&pt); //Only check for override if the last laser pointer position was inside a desktop (outside coordinates are possible via extended laser drag and combined desktop edge cases) bool do_check_for_override = false; const Vector2Int laser_pos(m_MouseLastLaserPointerX, m_MouseLastLaserPointerY); for (const DPRect& rect : m_DesktopRects) { if (rect.Contains(laser_pos)) { do_check_for_override = true; break; } } //Simulated pen input does not move the mouse cursor when an application supports pen input directly, which makes the normal check result in false positives //In this case we only check for override when the mouse cursor position changed compared to last time //While it might seem to make sense to always do this, it actually makes it harder to trigger the override during mouse simulation if (ConfigManager::GetValue(configid_bool_input_mouse_simulate_pen_input)) { static POINT pt_last = {0}; if ((pt.x == pt_last.x) && (pt.y == pt_last.y)) { do_check_for_override = false; } pt_last = pt; } //Check if the cursor is near the corner of one of the desktops and opt out of the pointer override to avoid sticky mouse corners triggering it //It can still happen sometimes, but this catches most cases if (do_check_for_override) { //Only do for combined desktops though if ( ((data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_desktop_duplication) && (data.ConfigInt[configid_int_overlay_desktop_id] == -1)) || ((data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_winrt_capture) && (data.ConfigInt[configid_int_overlay_winrt_desktop_id] == -1)) ) { const Vector2Int cursor_pos(pt.x, pt.y); for (const DPRect& rect : m_DesktopRects) { if ((fabs(cursor_pos.distance(rect.GetTL())) < 64.0f) || (fabs(cursor_pos.distance(rect.GetTR())) < 64.0f) || (fabs(cursor_pos.distance(rect.GetBL())) < 64.0f) || (fabs(cursor_pos.distance(rect.GetBR())) < 64.0f)) { do_check_for_override = false; break; } } } } //If mouse coordinates are not what the last laser pointer was (with tolerance), meaning some other source moved it if ((do_check_for_override) && ((abs(pt.x - m_MouseLastLaserPointerX) > 32) || (abs(pt.y - m_MouseLastLaserPointerY) > 32))) { m_MouseIgnoreMoveEventMissCount++; //GetCursorPos() may lag behind or other jumps may occasionally happen. We count up a few misses first before acting on them int max_miss_count = 10; //Arbitrary number, but appears to work reliably //Reduce max miss count to 1 for simulated pen input if (ConfigManager::GetValue(configid_bool_input_mouse_simulate_pen_input)) { max_miss_count = 1; } else { //When updates are limited, try adapting for the lower update rate if (m_PerformanceUpdateLimiterDelay.QuadPart != 0) { max_miss_count = std::max(1, max_miss_count - int((m_PerformanceUpdateLimiterDelay.QuadPart / 1000) / 20)); } } if (m_MouseIgnoreMoveEventMissCount > max_miss_count) { m_MouseIgnoreMoveEvent = true; //Set flag for all overlays for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { const Overlay& overlay = OverlayManager::Get().GetOverlay(i); if ( (overlay.GetTextureSource() != ovrl_texsource_none) && (overlay.GetTextureSource() != ovrl_texsource_ui) && (overlay.GetTextureSource() != ovrl_texsource_browser) ) { vr::VROverlay()->SetOverlayFlag(overlay.GetHandle(), vr::VROverlayFlags_HideLaserIntersection, true); } } } break; } else { m_MouseIgnoreMoveEventMissCount = 0; } } //To improve compatibility with dragging certain windows around, simulate a small movement first before fully unlocking the cursor from double-click assist if (m_MouseLastLaserPointerMoveBlocked) { //Move a single pixel in the direction of the new pointer position pointer_x = m_MouseLastLaserPointerX + sgn(pointer_x - m_MouseLastLaserPointerX); pointer_y = m_MouseLastLaserPointerY + sgn(pointer_y - m_MouseLastLaserPointerY); (use_pen) ? m_InputSim.PenMove(pointer_x, pointer_y) : m_InputSim.MouseMove(pointer_x, pointer_y); m_MouseLastLaserPointerMoveBlocked = false; //Real movement continues on the next mouse move event } else { //Finally do the actual cursor movement if we're still here (use_pen) ? m_InputSim.PenMove(pointer_x, pointer_y) : m_InputSim.MouseMove(pointer_x, pointer_y); m_MouseLastLaserPointerX = pointer_x; m_MouseLastLaserPointerY = pointer_y; } //This is only relevant when limiting updates. See Update() for details. m_MouseLaserPointerUsedLastUpdate = true; break; } case vr::VREvent_MouseButtonDown: { ActionManager& action_manager = ConfigManager::Get().GetActionManager(); if (ConfigManager::GetValue(configid_bool_state_overlay_selectmode)) { if (vr_event.data.mouse.button == vr::VRMouseButton_Left) { //Select this as current overlay IPCManager::Get().PostConfigMessageToUIApp(configid_int_interface_overlay_current_id, overlay_current.GetID()); current_overlay_old = overlay_current.GetID(); //Set a new reset value since we're in the middle of a temporary current overlay loop } break; } else if (ConfigManager::GetValue(configid_bool_state_overlay_dragmode)) { if (vr_event.data.mouse.button == vr::VRMouseButton_Left) { if (m_OverlayDragger.GetDragDeviceID() == -1) { if (data.ConfigInt[configid_int_overlay_origin] != ovrl_origin_theater_screen) { if (!data.ConfigBool[configid_bool_overlay_transform_locked]) { m_OverlayDragger.DragStart(OverlayManager::Get().GetCurrentOverlayID()); } else { IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_drag_hint_device, ConfigManager::Get().GetPrimaryLaserPointerDevice()); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_drag_hint_type, 1); } } else { IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_drag_hint_device, ConfigManager::Get().GetPrimaryLaserPointerDevice()); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_drag_hint_type, 2); } } } else if (vr_event.data.mouse.button == vr::VRMouseButton_Right) { if (!m_OverlayDragger.IsDragGestureActive()) { if (data.ConfigInt[configid_int_overlay_origin] != ovrl_origin_theater_screen) { if (!data.ConfigBool[configid_bool_overlay_transform_locked]) { m_OverlayDragger.DragGestureStart(OverlayManager::Get().GetCurrentOverlayID()); } else { IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_drag_hint_device, ConfigManager::Get().GetPrimaryLaserPointerDevice()); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_drag_hint_type, 1); } } else { IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_drag_hint_device, ConfigManager::Get().GetPrimaryLaserPointerDevice()); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_drag_hint_type, 2); } } } break; } //Set focused ID when clicking on an overlay ConfigManager::Get().SetValue(configid_int_state_overlay_focused_id, (int)overlay_current.GetID()); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_focused_id, (int)overlay_current.GetID()); if (overlay_current.GetTextureSource() == ovrl_texsource_browser) { if (vr_event.data.mouse.button <= vr::VRMouseButton_Middle) { m_MouseLastClickTick = ::GetTickCount64(); DPBrowserAPIClient::Get().DPBrowser_MouseDown(overlay_current.GetHandle(), (vr::EVRMouseButton)vr_event.data.mouse.button); } else { switch (vr_event.data.mouse.button) { case VRMouseButton_DP_Aux01: action_manager.StartAction(ConfigManager::GetValue(configid_handle_input_go_back_action_uid), overlay_current.GetID()); break; case VRMouseButton_DP_Aux02: action_manager.StartAction(ConfigManager::GetValue(configid_handle_input_go_home_action_uid), overlay_current.GetID()); break; } } break; } else if ((overlay_current.GetTextureSource() == ovrl_texsource_none) || (overlay_current.GetTextureSource() == ovrl_texsource_ui)) { break; } if (m_MouseIgnoreMoveEvent) //This can only be true if AllowPointerOverride enabled { m_MouseIgnoreMoveEvent = false; ResetMouseLastLaserPointerPos(); ApplySettingMouseInput(); //If it's a WinRT window capture, also check for window management stuff that would've happened on overlay focus enter otherwise if ( (overlay_current.GetTextureSource() == ovrl_texsource_winrt_capture) && (data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd] != 0) ) { if (ConfigManager::GetValue(configid_bool_windows_winrt_auto_focus)) { WindowManager::Get().RaiseAndFocusWindow((HWND)data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd], &m_InputSim); } } break; //Click to restore shouldn't generate a mouse click } //If a WindowManager drag event could occur, set the current window for it if ( (vr_event.data.mouse.button == vr::VRMouseButton_Left) && (overlay_current.GetTextureSource() == ovrl_texsource_winrt_capture) && (data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd] != 0) ) { WindowManager::Get().SetTargetWindow((HWND)data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd], overlay_current.GetID()); } if (vr_event.data.mouse.button <= vr::VRMouseButton_Middle) { m_MouseLastClickTick = ::GetTickCount64(); if (vr_event.data.mouse.button == vr::VRMouseButton_Left) { m_MouseLeftDownOverlayID = overlay_current.GetID(); if (ConfigManager::GetValue(configid_bool_input_keyboard_auto_show_desktop)) { WindowManager::Get().OnTextInputLeftMouseClick(); } } } switch (vr_event.data.mouse.button) { case vr::VRMouseButton_Left: (use_pen) ? m_InputSim.PenSetPrimaryDown(true) : m_InputSim.MouseSetLeftDown(true); break; case vr::VRMouseButton_Right: (use_pen) ? m_InputSim.PenSetSecondaryDown(true) : m_InputSim.MouseSetRightDown(true); break; case vr::VRMouseButton_Middle: m_InputSim.MouseSetMiddleDown(true); break; case VRMouseButton_DP_Aux01: action_manager.StartAction(ConfigManager::GetValue(configid_handle_input_go_back_action_uid), overlay_current.GetID()); break; case VRMouseButton_DP_Aux02: action_manager.StartAction(ConfigManager::GetValue(configid_handle_input_go_home_action_uid), overlay_current.GetID()); break; } break; } case vr::VREvent_MouseButtonUp: { ActionManager& action_manager = ConfigManager::Get().GetActionManager(); if (ConfigManager::GetValue(configid_bool_state_overlay_selectmode)) { break; } else if (ConfigManager::GetValue(configid_bool_state_overlay_dragmode_temp)) { //Temp drag doesn't have proper overlay focus so can be called on any overlay if it's in front. Finish drag in any case. if (vr_event.data.mouse.button == vr::VRMouseButton_Left) { //Don't actually react to this unless it's been a few milliseconds //That way releasing the trigger after the UI selection instead of holding it doesn't just drop the overlay on the spot if (::GetTickCount64() >= m_OvrlTempDragStartTick + 250) { OnDragFinish(); DetachedTempDragFinish(); break; } } } else if ( (m_OverlayDragger.GetDragOverlayID() == overlay_current.GetID()) && ( (m_OverlayDragger.IsDragActive()) || (m_OverlayDragger.IsDragGestureActive()) ) ) { if ((vr_event.data.mouse.button == vr::VRMouseButton_Left) && (m_OverlayDragger.IsDragActive())) { OnDragFinish(); m_OverlayDragger.DragFinish(); ApplySettingTransform(); } else if ((vr_event.data.mouse.button == vr::VRMouseButton_Right) && (m_OverlayDragger.IsDragGestureActive())) { m_OverlayDragger.DragGestureFinish(); ApplySettingTransform(); } break; } else if (overlay_current.GetTextureSource() == ovrl_texsource_browser) { if (vr_event.data.mouse.button <= vr::VRMouseButton_Middle) { DPBrowserAPIClient::Get().DPBrowser_MouseUp(overlay_current.GetHandle(), (vr::EVRMouseButton)vr_event.data.mouse.button); } else { switch (vr_event.data.mouse.button) { case VRMouseButton_DP_Aux01: action_manager.StopAction(ConfigManager::GetValue(configid_handle_input_go_back_action_uid), overlay_current.GetID()); break; case VRMouseButton_DP_Aux02: action_manager.StopAction(ConfigManager::GetValue(configid_handle_input_go_home_action_uid), overlay_current.GetID()); break; } } IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_drag_hint_type, 0); break; } else if ((overlay_current.GetTextureSource() == ovrl_texsource_none) || (overlay_current.GetTextureSource() == ovrl_texsource_ui)) { IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_drag_hint_type, 0); break; } switch (vr_event.data.mouse.button) { case vr::VRMouseButton_Left: (use_pen) ? m_InputSim.PenSetPrimaryDown(false) : m_InputSim.MouseSetLeftDown(false); break; case vr::VRMouseButton_Right: (use_pen) ? m_InputSim.PenSetSecondaryDown(false) : m_InputSim.MouseSetRightDown(false); break; case vr::VRMouseButton_Middle: m_InputSim.MouseSetMiddleDown(false); break; case VRMouseButton_DP_Aux01: action_manager.StopAction(ConfigManager::GetValue(configid_handle_input_go_back_action_uid), overlay_current.GetID()); break; case VRMouseButton_DP_Aux02: action_manager.StopAction(ConfigManager::GetValue(configid_handle_input_go_home_action_uid), overlay_current.GetID()); break; } //If there was a possible WindowManager drag event prepared for, reset the target window if ( (vr_event.data.mouse.button == vr::VRMouseButton_Left) && (overlay_current.GetTextureSource() == ovrl_texsource_winrt_capture) && (data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd] != 0) ) { WindowManager::Get().SetTargetWindow(nullptr); } if (vr_event.data.mouse.button == vr::VRMouseButton_Left) { m_MouseLeftDownOverlayID = k_ulOverlayID_None; } IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_drag_hint_type, 0); break; } case vr::VREvent_ScrollDiscrete: case vr::VREvent_ScrollSmooth: { //Discrete scroll events are sent at a fixed frame interval for the system laser pointer and at a fixed interval relative to SteamVR Input action set update calls for Desktop+ pointer //This can result in vastly different scroll rates at different frame or update rates //We counteract this by scaling the sent scroll values by the delta between the events to achieve a constant scroll rate float scroll_step_multiplier = 1.0f; if (vr_event.eventType == vr::VREvent_ScrollDiscrete) { LARGE_INTEGER scroll_delta = {0}; const float scroll_step_ms = 58.31f; //7 frame tick of a 120 Hz HMD... hardly universal, but going with that for now. ::QueryPerformanceCounter(&scroll_delta); scroll_delta.QuadPart -= m_MouseLaserPointerScrollDeltaStart.QuadPart; scroll_delta.QuadPart *= 1000000; scroll_delta.QuadPart /= m_MouseLaserPointerScrollDeltaFrequency.QuadPart; scroll_step_multiplier = scroll_delta.QuadPart / (1000.0f * scroll_step_ms); //We typically don't need more than 2x, so treat everything higher as interrupted scrolling and use 1x for them if (scroll_step_multiplier > 2.0f) { scroll_step_multiplier = 1.0f; } ::QueryPerformanceCounter(&m_MouseLaserPointerScrollDeltaStart); } const float xdelta = vr_event.data.scroll.xdelta * scroll_step_multiplier; //Discrete scrolling will never have X as non-0, but just in case this ever changes const float ydelta = vr_event.data.scroll.ydelta * scroll_step_multiplier; //Check deadzone const float xdelta_abs = fabs(xdelta); const float ydelta_abs = fabs(ydelta); const bool do_scroll_h = (xdelta_abs > 0.025f); const bool do_scroll_v = (ydelta_abs > 0.025f); //Drag-mode scroll if (m_OverlayDragger.IsDragActive()) { //Block drag scroll actions when a temp drag just started to avoid mis-inputs if (::GetTickCount64() <= m_OvrlTempDragStartTick + 250) break; //Additional deadzone if ((xdelta_abs > 0.05f) || (ydelta_abs > 0.05f)) { //Add distance as long as y-delta input is bigger if (xdelta_abs < ydelta_abs) { m_OverlayDragger.DragAddDistance(ydelta); } else { m_OverlayDragger.DragAddWidth(xdelta * -0.25f); } } break; } //Overlay scrolls if ( (ConfigManager::GetValue(configid_bool_state_overlay_dragmode)) || (ConfigManager::GetValue(configid_bool_state_overlay_selectmode)) || (overlay_current.GetTextureSource() == ovrl_texsource_none) || (overlay_current.GetTextureSource() == ovrl_texsource_ui) ) { break; } else if (overlay_current.GetTextureSource() == ovrl_texsource_browser) { if ((do_scroll_h) || (do_scroll_v)) { DPBrowserAPIClient::Get().DPBrowser_Scroll(overlay_current.GetHandle(), (do_scroll_h) ? xdelta : 0.0f, (do_scroll_v) ? ydelta : 0.0f); } break; } //Overlay drag-scroll window-title-pull creation... thingy if (do_scroll_v) { bool is_desktop_overlay = ( (data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_desktop_duplication) || ((data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_winrt_capture) && (data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd] == 0)) ); const float delta_trigger_min = (ConfigManager::GetValue(configid_bool_input_mouse_scroll_smooth)) ? -0.16f : 0.9f; if ( (is_desktop_overlay) && (m_MouseLeftDownOverlayID == overlay_current.GetID()) && (ydelta <= delta_trigger_min) ) { HWND current_window = ::GetForegroundWindow(); if ( (WindowManager::Get().IsHoveringCapturableTitleBar(current_window, m_MouseLastLaserPointerX, m_MouseLastLaserPointerY)) ) { vr::TrackedDeviceIndex_t device_index = ConfigManager::Get().GetPrimaryLaserPointerDevice(); //If no dashboard device, try finding one if (device_index == vr::k_unTrackedDeviceIndexInvalid) { device_index = vr::IVROverlayEx::FindPointerDeviceForOverlay(overlay_current.GetHandle()); } float source_distance = 1.0f; float target_width = 0.3f; vr::VROverlayIntersectionResults_t results; if (vr::IVROverlayEx::ComputeOverlayIntersectionForDevice(overlay_current.GetHandle(), device_index, vr::TrackingUniverseStanding, &results)) { source_distance = results.fDistance; //Get window width in meters relative to the source overlay width RECT window_rect = {0}; if (::DwmGetWindowAttribute(current_window, DWMWA_EXTENDED_FRAME_BOUNDS, &window_rect, sizeof(window_rect)) == S_OK) { target_width = (float(window_rect.right - window_rect.left) / overlay_current.GetValidatedCropRect().GetWidth()) * data.ConfigFloat[configid_float_overlay_width]; target_width = std::max(target_width, 0.2f); //Don't let it become too tiny } } //Set device as hint, just in case ConfigManager::SetValue(configid_int_state_laser_pointer_device_hint, (int)device_index); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_laser_pointer_device_hint, (int)device_index); //Send to UI IPCManager::Get().PostConfigMessageToUIApp(configid_handle_state_arg_hwnd, (LPARAM)current_window); IPCManager::Get().PostMessageToUIApp(ipcmsg_action, ipcact_overlay_new_drag, MAKELPARAM(-2, 0 /*UI doesn't need distance*/)); //Reset input and WindowManager state manually since the overlay mouse up even will be consumed to finish the drag later m_InputSim.MouseSetLeftDown(false); WindowManager::Get().SetTargetWindow(nullptr); //Start drag AddOverlayDrag(source_distance, ovrl_capsource_winrt_capture, -2, current_window, target_width); break; } } } //Normal scrolling if (do_scroll_v) { m_InputSim.MouseWheelVertical(ydelta); } if (do_scroll_h) { m_InputSim.MouseWheelHorizontal(-xdelta); } break; } } } void OutputManager::HandleKeyboardMessage(IPCActionID ipc_action_id, LPARAM lparam) { switch (ipc_action_id) { case ipcact_keyboard_vkey: { m_InputSim.KeyboardSetKeyState((IPCKeyboardKeystateFlags)LOWORD(lparam), HIWORD(lparam)); break; } case ipcact_keyboard_wchar: { wchar_t wchar = LOWORD(lparam); bool down = (HIWORD(lparam) == 1); //Check if it can be pressed on the current windows keyboard layout SHORT w32_keystate = ::VkKeyScanW(wchar); unsigned char keycode = LOBYTE(w32_keystate); unsigned char flags = HIBYTE(w32_keystate); bool is_valid = ((keycode != 255) || (flags != 255)); if (is_valid) { m_InputSim.KeyboardSetFromWin32KeyState(w32_keystate, down); } else if (down) //Otherwise use it as a text input { wchar_t wstr[2] = {0}; wstr[0] = wchar; m_InputSim.KeyboardText(StringConvertFromUTF16(wstr).c_str(), true); } break; } default: return; } } bool OutputManager::HandleOverlayProfileLoadMessage(LPARAM lparam) { IPCActionOverlayProfileLoadArg profile_load_arg = (IPCActionOverlayProfileLoadArg)LOWORD(lparam); int profile_overlay_id = GET_Y_LPARAM(lparam); int desktop_id_prev = ConfigManager::GetValue(configid_int_overlay_desktop_id); const std::string& profile_name = ConfigManager::GetValue(configid_str_state_profile_name_load); if (profile_overlay_id == -2) { ConfigManager::Get().LoadOverlayProfileDefault(true); } else if (profile_load_arg == ipcactv_ovrl_profile_multi) { ConfigManager::Get().LoadMultiOverlayProfileFromFile(profile_name + ".ini", true); } else if (profile_load_arg == ipcactv_ovrl_profile_multi_add) { if (profile_overlay_id == -1) //Load queued up overlays { //Usually, elements should have been sent in order, but lets make sure they really are std::sort(m_ProfileAddOverlayIDQueue.begin(), m_ProfileAddOverlayIDQueue.end()); std::vector ovrl_inclusion_list; ovrl_inclusion_list.reserve(m_ProfileAddOverlayIDQueue.back()); //Build overlay inclusion list for (int ovrl_id : m_ProfileAddOverlayIDQueue) { if ((int)ovrl_inclusion_list.size() > ovrl_id) //Skip if already in list (double entry) { continue; } while ((int)ovrl_inclusion_list.size() < ovrl_id) //Exclude overlays not queued { ovrl_inclusion_list.push_back(0); } ovrl_inclusion_list.push_back(1); //Include ovrl_id } ConfigManager::Get().LoadMultiOverlayProfileFromFile(profile_name + ".ini", false, &ovrl_inclusion_list); m_ProfileAddOverlayIDQueue.clear(); } else if ( (profile_overlay_id >= 0) && (profile_overlay_id < 1000) ) //Queue up overlays { m_ProfileAddOverlayIDQueue.push_back(profile_overlay_id); return false; } } //Reset mirroing entirely if desktop was changed (only in single desktop mode) if ( (ConfigManager::GetValue(configid_bool_performance_single_desktop_mirroring)) && (ConfigManager::GetValue(configid_int_overlay_desktop_id) != desktop_id_prev) ) return true; //Reset mirroring ResetOverlays(); //This does everything relevant return false; } void OutputManager::ResetMouseLastLaserPointerPos() { //Set last pointer values to current to not trip the movement detection up POINT pt; ::GetCursorPos(&pt); m_MouseLastLaserPointerX = pt.x; m_MouseLastLaserPointerY = pt.y; //Also reset this state which may be left unclean when window drags get triggered m_MouseLeftDownOverlayID = k_ulOverlayID_None; } void OutputManager::CropToActiveWindow() { bool& crop_enabled = ConfigManager::GetRef(configid_bool_overlay_crop_enabled); int& crop_x = ConfigManager::GetRef(configid_int_overlay_crop_x); int& crop_y = ConfigManager::GetRef(configid_int_overlay_crop_y); int& crop_width = ConfigManager::GetRef(configid_int_overlay_crop_width); int& crop_height = ConfigManager::GetRef(configid_int_overlay_crop_height); if (CropToActiveWindow(crop_x, crop_y, crop_width, crop_height)) { crop_enabled = true; //Send them over to UI IPCManager::Get().PostConfigMessageToUIApp(configid_bool_overlay_crop_enabled, crop_enabled); IPCManager::Get().PostConfigMessageToUIApp(configid_int_overlay_crop_x, crop_x); IPCManager::Get().PostConfigMessageToUIApp(configid_int_overlay_crop_y, crop_y); IPCManager::Get().PostConfigMessageToUIApp(configid_int_overlay_crop_width, crop_width); IPCManager::Get().PostConfigMessageToUIApp(configid_int_overlay_crop_height, crop_height); ApplySettingCrop(); ApplySettingTransform(); ApplySettingMouseScale(); } } void OutputManager::CropToDisplay(int display_id, bool do_not_apply_setting) { int& crop_x = ConfigManager::GetRef(configid_int_overlay_crop_x); int& crop_y = ConfigManager::GetRef(configid_int_overlay_crop_y); int& crop_width = ConfigManager::GetRef(configid_int_overlay_crop_width); int& crop_height = ConfigManager::GetRef(configid_int_overlay_crop_height); CropToDisplay(display_id, crop_x, crop_y, crop_width, crop_height); //Send change to UI as well (also set override since this may be called during one) IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_current_id_override, OverlayManager::Get().GetCurrentOverlayID()); IPCManager::Get().PostConfigMessageToUIApp(configid_int_overlay_crop_x, crop_x); IPCManager::Get().PostConfigMessageToUIApp(configid_int_overlay_crop_y, crop_y); IPCManager::Get().PostConfigMessageToUIApp(configid_int_overlay_crop_width, crop_width); IPCManager::Get().PostConfigMessageToUIApp(configid_int_overlay_crop_height, crop_height); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_current_id_override, -1); //In single desktop mode, set desktop ID for all overlays if (ConfigManager::GetValue(configid_bool_performance_single_desktop_mirroring)) { for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { OverlayManager::Get().GetConfigData(i).ConfigInt[configid_int_overlay_desktop_id] = display_id; IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_current_id_override, (int)i); IPCManager::Get().PostConfigMessageToUIApp(configid_int_overlay_desktop_id, display_id); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_current_id_override, -1); } } //Applying the setting when a duplication resets happens right after has the chance of screwing up the transform (too many transform updates?), so give the option to not do it if (!do_not_apply_setting) { ApplySettingCrop(); ApplySettingTransform(); ApplySettingMouseScale(); ApplySettingExtraBrightness(); } } void OutputManager::DuplicateOverlay(unsigned int base_id, bool is_ui_overlay) { //Add overlay based on data of base_id overlay and reset it unsigned int new_id = k_ulOverlayID_None; if (!is_ui_overlay) { new_id = OverlayManager::Get().DuplicateOverlay(OverlayManager::Get().GetConfigData(base_id), base_id); } else { new_id = OverlayManager::Get().AddUIOverlay(); } unsigned int current_overlay_old = OverlayManager::Get().GetCurrentOverlayID(); OverlayManager::Get().SetCurrentOverlayID(new_id); if (!is_ui_overlay) { const Overlay& overlay_base = OverlayManager::Get().GetOverlay(base_id); Overlay& overlay_current = OverlayManager::Get().GetCurrentOverlay(); //If base overlay is an active WinRT Capture, duplicate capture before resetting the overlay if (overlay_base.GetTextureSource() == ovrl_texsource_winrt_capture) { if (DPWinRT_StartCaptureFromOverlay(overlay_current.GetHandle(), overlay_base.GetHandle())) { overlay_current.SetTextureSource(ovrl_texsource_winrt_capture); } } //Automatically reset the matrix to a saner default by putting it next to the base overlay in most cases DetachedTransformReset(overlay_base.GetID()); } else { DetachedTransformReset(); } ResetCurrentOverlay(); OverlayManager::Get().SetCurrentOverlayID(current_overlay_old); } unsigned int OutputManager::AddOverlay(OverlayCaptureSource capture_source, int desktop_id, HWND window_handle) { unsigned int new_id = OverlayManager::Get().AddOverlay(capture_source, desktop_id, window_handle); unsigned int current_overlay_old = OverlayManager::Get().GetCurrentOverlayID(); OverlayManager::Get().SetCurrentOverlayID(new_id); if (capture_source == ovrl_capsource_desktop_duplication) { CropToDisplay(desktop_id, true); } //Adjust width to a more suited default (UI does the same so no need to send over) ConfigManager::SetValue(configid_float_overlay_width, 1.0f); //Reset transform to default next to the primary dashboard overlay in most cases DetachedTransformReset(); ResetCurrentOverlay(); OverlayManager::Get().SetCurrentOverlayID(current_overlay_old); return new_id; } unsigned int OutputManager::AddOverlayDrag(float source_distance, OverlayCaptureSource capture_source, int desktop_id, HWND window_handle, float overlay_width) { unsigned int new_id = OverlayManager::Get().AddOverlay(capture_source, desktop_id, window_handle); unsigned int current_overlay_old = OverlayManager::Get().GetCurrentOverlayID(); OverlayManager::Get().SetCurrentOverlayID(new_id); if (capture_source == ovrl_capsource_desktop_duplication) { CropToDisplay(desktop_id, true); } //Adjust width and send it over to UI app ConfigManager::SetValue(configid_float_overlay_width, overlay_width); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_current_id_override, (int)new_id); IPCManager::Get().PostConfigMessageToUIApp(configid_float_overlay_width, overlay_width); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_current_id_override, -1); //Start drag and apply overlay config DetachedTempDragStart(new_id, std::max(source_distance - 0.25f, 0.01f)); ResetCurrentOverlay(); OverlayManager::Get().SetCurrentOverlayID(current_overlay_old); return new_id; } void OutputManager::ApplySettingCaptureSource() { Overlay& overlay = OverlayManager::Get().GetCurrentOverlay(); switch (ConfigManager::GetValue(configid_int_overlay_capture_source)) { case ovrl_capsource_desktop_duplication: { if (!m_OutputInvalid) { OverlayTextureSource tex_source = overlay.GetTextureSource(); if ((tex_source != ovrl_texsource_desktop_duplication) || (tex_source != ovrl_texsource_desktop_duplication_3dou_converted)) { ApplySetting3DMode(); //Sets texture source for us when capture source is desktop duplication } } else { overlay.SetTextureSource(ovrl_texsource_none); } break; } case ovrl_capsource_winrt_capture: { if (overlay.GetTextureSource() != ovrl_texsource_winrt_capture) { if (DPWinRT_IsCaptureFromHandleSupported()) { OverlayConfigData& data = OverlayManager::Get().GetCurrentConfigData(); if (data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd] != 0) { //Set configid_str_overlay_winrt_last_* strings from window info so returning windows can be restored later const WindowInfo* window_info = WindowManager::Get().WindowListFindWindow((HWND)data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd]); if (window_info != nullptr) { data.ConfigStr[configid_str_overlay_winrt_last_window_title] = StringConvertFromUTF16(window_info->GetTitle().c_str()); data.ConfigStr[configid_str_overlay_winrt_last_window_class_name] = StringConvertFromUTF16(window_info->GetWindowClassName().c_str()); data.ConfigStr[configid_str_overlay_winrt_last_window_exe_name] = window_info->GetExeName(); } if (DPWinRT_StartCaptureFromHWND(overlay.GetHandle(), (HWND)data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd])) { overlay.SetTextureSource(ovrl_texsource_winrt_capture); ApplySetting3DMode(); //Syncs 3D state if needed ApplySettingUpdateLimiter(); //Pause if not visible if (!overlay.IsVisible()) { DPWinRT_PauseCapture(overlay.GetHandle(), true); } if (ConfigManager::GetValue(configid_bool_windows_winrt_auto_focus)) { WindowManager::Get().RaiseAndFocusWindow((HWND)data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd], &m_InputSim); } } break; } else if (data.ConfigInt[configid_int_overlay_winrt_desktop_id] != -2) { if (DPWinRT_StartCaptureFromDesktop(overlay.GetHandle(), data.ConfigInt[configid_int_overlay_winrt_desktop_id])) { overlay.SetTextureSource(ovrl_texsource_winrt_capture); ApplySetting3DMode(); ApplySettingUpdateLimiter(); //Pause if not visible if (!overlay.IsVisible()) { DPWinRT_PauseCapture(overlay.GetHandle(), true); } } break; } } //Couldn't set up capture, set source to none overlay.SetTextureSource(ovrl_texsource_none); } break; } case ovrl_capsource_ui: { //Set texture source to UI if possible, which sets the rendering PID to the UI process overlay.SetTextureSource(IPCManager::IsUIAppRunning() ? ovrl_texsource_ui : ovrl_texsource_none); break; } case ovrl_capsource_browser: { if (overlay.GetTextureSource() != ovrl_texsource_browser) { bool has_started_browser = false; if (DPBrowserAPIClient::Get().IsBrowserAvailable()) { OverlayConfigData& data = OverlayManager::Get().GetCurrentConfigData(); //Load placeholder texture and apply input mode now since browser startup can take a few seconds vr::VROverlay()->SetOverlayFromFile(overlay.GetHandle(), (ConfigManager::Get().GetApplicationPath() + "images/browser_load.png").c_str()); ApplySettingInputMode(); if (data.ConfigInt[configid_int_overlay_duplication_id] == -1) { DPBrowserAPIClient::Get().DPBrowser_StartBrowser(overlay.GetHandle(), data.ConfigStr[configid_str_overlay_browser_url], data.ConfigBool[configid_bool_overlay_browser_allow_transparency]); DPBrowserAPIClient::Get().DPBrowser_SetResolution(overlay.GetHandle(), data.ConfigInt[configid_int_overlay_user_width], data.ConfigInt[configid_int_overlay_user_height]); DPBrowserAPIClient::Get().DPBrowser_SetFPS(overlay.GetHandle(), data.ConfigInt[configid_int_overlay_browser_max_fps_override]); DPBrowserAPIClient::Get().DPBrowser_SetZoomLevel(overlay.GetHandle(), data.ConfigFloat[configid_float_overlay_browser_zoom]); has_started_browser = true; } else { const Overlay& overlay_src = OverlayManager::Get().GetOverlay((unsigned int)data.ConfigInt[configid_int_overlay_duplication_id]); //Source overlay may be invalid on launch or not have texture source set up if duplication ID is higher than this overlay's ID if ( (overlay_src.GetHandle() != vr::k_ulOverlayHandleInvalid) && (overlay_src.GetTextureSource() == ovrl_texsource_browser) ) { DPBrowserAPIClient::Get().DPBrowser_DuplicateBrowserOutput(overlay_src.GetHandle(), overlay.GetHandle()); DPBrowserAPIClient::Get().DPBrowser_SetFPS(overlay.GetHandle(), data.ConfigInt[configid_int_overlay_browser_max_fps_override]); has_started_browser = true; } } data.ConfigInt[configid_int_overlay_state_content_width] = data.ConfigInt[configid_int_overlay_user_width]; data.ConfigInt[configid_int_overlay_state_content_height] = data.ConfigInt[configid_int_overlay_user_height]; ApplySetting3DMode(); ApplySettingUpdateLimiter(); //Set pause state in case overlay is hidden or differs from duplication source DPBrowserAPIClient::Get().DPBrowser_PauseBrowser(overlay.GetHandle(), !overlay.IsVisible()); } //Set texture source to browser if possible, which sets the rendering PID to the browser server process overlay.SetTextureSource((has_started_browser) ? ovrl_texsource_browser : ovrl_texsource_none); } break; } default: { //Unknown capture source, perhaps from the future. Set to texture source none. overlay.SetTextureSource(ovrl_texsource_none); } } ApplySettingExtraBrightness(); } void OutputManager::ApplySetting3DMode() { const Overlay& overlay_current = OverlayManager::Get().GetCurrentOverlay(); const OverlayConfigData& data = OverlayManager::Get().GetCurrentConfigData(); vr::VROverlayHandle_t ovrl_handle = overlay_current.GetHandle(); bool is_enabled = ConfigManager::GetValue(configid_bool_overlay_3D_enabled); int mode = ConfigManager::GetValue(configid_int_overlay_3D_mode); //Override mode to none if texsource is none or the desktop duplication output is invalid if ( (overlay_current.GetTextureSource() == ovrl_texsource_none) || ( (data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_desktop_duplication) && (m_OutputInvalid) ) ) { is_enabled = false; } if (is_enabled) { if (data.ConfigBool[configid_bool_overlay_3D_swapped]) { vr::VROverlay()->SetOverlayFlag(ovrl_handle, vr::VROverlayFlags_SideBySide_Parallel, false); vr::VROverlay()->SetOverlayFlag(ovrl_handle, vr::VROverlayFlags_SideBySide_Crossed, true); } else { vr::VROverlay()->SetOverlayFlag(ovrl_handle, vr::VROverlayFlags_SideBySide_Parallel, true); vr::VROverlay()->SetOverlayFlag(ovrl_handle, vr::VROverlayFlags_SideBySide_Crossed, false); } switch (mode) { case ovrl_3Dmode_hsbs: { vr::VROverlay()->SetOverlayTexelAspect(ovrl_handle, 2.0f); break; } case ovrl_3Dmode_sbs: case ovrl_3Dmode_ou: //Over-Under is converted to SBS { vr::VROverlay()->SetOverlayTexelAspect(ovrl_handle, 1.0f); break; } case ovrl_3Dmode_hou: //Half-Over-Under is converted to SBS with half height { vr::VROverlay()->SetOverlayTexelAspect(ovrl_handle, 0.5f); break; } default: break; } } else { vr::VROverlay()->SetOverlayFlag(ovrl_handle, vr::VROverlayFlags_SideBySide_Parallel, false); vr::VROverlay()->SetOverlayFlag(ovrl_handle, vr::VROverlayFlags_SideBySide_Crossed, false); vr::VROverlay()->SetOverlayTexelAspect(ovrl_handle, 1.0f); } if (data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_desktop_duplication) { if ( (is_enabled) && ((mode == ovrl_3Dmode_ou) || (mode == ovrl_3Dmode_hou)) ) { OverlayManager::Get().GetCurrentOverlay().SetTextureSource(ovrl_texsource_desktop_duplication_3dou_converted); } else { OverlayManager::Get().GetCurrentOverlay().SetTextureSource(ovrl_texsource_desktop_duplication); } RefreshOpenVROverlayTexture(DPRect(-1, -1, -1, -1), true); } //WinRT OU3D state is set in ApplySettingCrop since it needs cropping values ApplySettingCrop(); ApplySettingMouseScale(); } void OutputManager::ApplySettingTransform() { Overlay& overlay = OverlayManager::Get().GetCurrentOverlay(); const OverlayConfigData& data = OverlayManager::Get().GetCurrentConfigData(); vr::VROverlayHandle_t ovrl_handle = overlay.GetHandle(); //Fixup overlay visibility if needed //This has to be done first since there seem to be issues with moving invisible overlays bool should_be_visible = overlay.ShouldBeVisible(); if ( (!should_be_visible) && (m_OvrlDashboardActive) && (m_OvrlDashboardActive) && (ConfigManager::GetValue(configid_bool_overlay_enabled)) && (ConfigManager::GetValue(configid_bool_state_overlay_dragselectmode_show_hidden)) ) { should_be_visible = true; overlay.SetOpacity(0.25f); } else if ( (!ConfigManager::GetValue(configid_bool_overlay_gazefade_enabled)) && (overlay.GetOpacity() != ConfigManager::GetValue(configid_float_overlay_opacity)) ) { overlay.SetOpacity(ConfigManager::GetValue(configid_float_overlay_opacity)); should_be_visible = overlay.ShouldBeVisible(); //Re-evaluate this in case the overlay was left hidden after deactivating gaze fade } if ( (should_be_visible) && (!overlay.IsVisible()) ) { ShowOverlay(overlay.GetID()); return; //ShowOverlay() calls this function so we back out here } else if ( (!should_be_visible) && (overlay.IsVisible()) ) { HideOverlay(overlay.GetID()); } unsigned int primary_dashboard_overlay_id = OverlayManager::Get().GetPrimaryDashboardOverlay().GetID(); bool is_primary_dashboard_overlay = (primary_dashboard_overlay_id == overlay.GetID()); float width = ConfigManager::GetValue(configid_float_overlay_width); float height = 0.0f; float dummy_height = 0.0f; OverlayOrigin overlay_origin = (OverlayOrigin)ConfigManager::GetValue(configid_int_overlay_origin); if (is_primary_dashboard_overlay) { height = GetOverlayHeight(overlay.GetID()); //Dashboard uses differently scaled transform depending on the current setting. We counteract that scaling to ensure the config value actually matches world scale dummy_height = height / GetDashboardScale(); } else { //Clear theater mode if this overlay is used as source and being disabled or no longer set to theater origin if ((OverlayManager::Get().GetTheaterOverlayID() == overlay.GetID()) && ((!ConfigManager::GetValue(configid_bool_overlay_enabled)) || (overlay_origin != ovrl_origin_theater_screen)) ) { OverlayManager::Get().ClearTheaterOverlay(); ResetCurrentOverlay(); //Reset overlay so all changes made to the theater one get reflected on the normal one overlay.AssignDesktopDuplicationTexture(); //Re-assign Desktop Duplication Texture in case it has changed during theater mode return; } else if ((ConfigManager::GetValue(configid_bool_overlay_enabled) && (overlay_origin == ovrl_origin_theater_screen))) //Enable theater mode if needed { ShowTheaterOverlay(overlay.GetID()); } } //Dashboard dummy still needs correct width/height set for the top dashboard bar above it to be visible if ( (is_primary_dashboard_overlay) || (primary_dashboard_overlay_id == k_ulOverlayID_None) ) //When no dashboard overlay exists we set this on every overlay, not ideal. { float old_dummy_height = 0.0f; vr::VROverlay()->GetOverlayWidthInMeters(m_OvrlHandleDashboardDummy, &old_dummy_height); dummy_height = std::max(dummy_height + 0.30f, 1.5f); //Enforce minimum height to fit default height offset (which makes space for Floating UI) //Sanity check. Things like inf can make the entire interface disappear if (dummy_height > 20.0f) { dummy_height = 1.525f; } if (dummy_height != old_dummy_height) { //Delay setting the dummy height to after we made sure ApplySettingTransform() is not called right again //Avoiding flicker properly unfortunately needs a sleep, so we can't call this right away or else we're just gonna stutter around m_PendingDashboardDummyHeight = dummy_height; } } //Update transform vr::HmdMatrix34_t matrix = {0}; vr::TrackingUniverseOrigin universe_origin = vr::TrackingUniverseStanding; switch (overlay_origin) { case ovrl_origin_room: { matrix = ConfigManager::Get().GetOverlayDetachedTransform().toOpenVR34(); //Offset transform by additional offset values vr::IVRSystemEx::TransformOpenVR34TranslateRelative(matrix, ConfigManager::GetValue(configid_float_overlay_offset_right), ConfigManager::GetValue(configid_float_overlay_offset_up), ConfigManager::GetValue(configid_float_overlay_offset_forward)); vr::VROverlay()->SetOverlayTransformAbsolute(ovrl_handle, universe_origin, &matrix); break; } case ovrl_origin_hmd_floor: { DetachedTransformFrameUpdate(); break; } case ovrl_origin_seated_universe: { Matrix4 matrix_base = m_OverlayDragger.GetBaseOffsetMatrix() * ConfigManager::Get().GetOverlayDetachedTransform(); //Offset transform by additional offset values matrix_base.translate_relative(ConfigManager::GetValue(configid_float_overlay_offset_right), ConfigManager::GetValue(configid_float_overlay_offset_up), ConfigManager::GetValue(configid_float_overlay_offset_forward)); matrix = matrix_base.toOpenVR34(); vr::VROverlay()->SetOverlayTransformAbsolute(ovrl_handle, vr::TrackingUniverseStanding, &matrix); break; } case ovrl_origin_dashboard: { Matrix4 matrix_base = m_OverlayDragger.GetBaseOffsetMatrix() * ConfigManager::Get().GetOverlayDetachedTransform(); //SteamVR 2.15.1 made changes that affected legacy dashboard positioning in... odd ways //This more of a band-aid solution for the rarely used legacy dashboard, short of just not supporting it anymore bool has_applied_bandaid_fix = false; const bool is_v2_15 = (strstr(vr::VRSystem()->GetRuntimeVersion(), "2.15") != nullptr); if (is_v2_15) { vr::VROverlayHandle_t handle_gamepad_ui = vr::k_ulOverlayHandleInvalid; vr::VROverlay()->FindOverlay("valve.steam.gamepadui.bar", &handle_gamepad_ui); if (handle_gamepad_ui == vr::k_ulOverlayHandleInvalid) { if (is_primary_dashboard_overlay) { vr::HmdMatrix34_t matrix_dplus_tab; vr::TrackingUniverseOrigin origin = vr::TrackingUniverseStanding; vr::VROverlay()->GetTransformForOverlayCoordinates(m_OvrlHandleDashboardDummy, origin, {0.5f, 0.5f}, &matrix_dplus_tab); matrix_base = matrix_dplus_tab; Vector3 translation = matrix_base.getTranslation(); matrix_base.setTranslation({0.0f, 0.0f, 0.0f}); matrix_base.scale(1.0f / GetDashboardScale()); matrix_base.setTranslation(translation); has_applied_bandaid_fix = true; //Yes, this does not apply the overlay's transform at all } } } //Offset transform by additional offset values matrix_base.translate_relative(ConfigManager::GetValue(configid_float_overlay_offset_right), ConfigManager::GetValue(configid_float_overlay_offset_up), ConfigManager::GetValue(configid_float_overlay_offset_forward)); if (!has_applied_bandaid_fix) { //Apply origin offset, which basically adjusts transform to be aligned bottom-center instead of centered on both axes if (height == 0.0f) //Get overlay height if it's not set yet { height = GetOverlayHeight(overlay.GetID()); } matrix_base.translate_relative(0.0f, height / 2.0f, 0.0f); } matrix = matrix_base.toOpenVR34(); vr::VROverlay()->SetOverlayTransformAbsolute(ovrl_handle, universe_origin, &matrix); break; } case ovrl_origin_hmd: { //Unsmoothed uses device-relative transform, but smoothed ones are absolute updated each frame, like HMD Floor origin if (ConfigManager::GetValue(configid_int_overlay_origin_smoothing_level) == 0) { matrix = ConfigManager::Get().GetOverlayDetachedTransform().toOpenVR34(); //Offset transform by additional offset values vr::IVRSystemEx::TransformOpenVR34TranslateRelative(matrix, ConfigManager::GetValue(configid_float_overlay_offset_right), ConfigManager::GetValue(configid_float_overlay_offset_up), ConfigManager::GetValue(configid_float_overlay_offset_forward)); vr::VROverlay()->SetOverlayTransformTrackedDeviceRelative(ovrl_handle, vr::k_unTrackedDeviceIndex_Hmd, &matrix); } else { DetachedTransformFrameUpdate(); } break; } case ovrl_origin_right_hand: { vr::TrackedDeviceIndex_t device_index = vr::VRSystem()->GetTrackedDeviceIndexForControllerRole(vr::TrackedControllerRole_RightHand); if (device_index != vr::k_unTrackedDeviceIndexInvalid) { matrix = ConfigManager::Get().GetOverlayDetachedTransform().toOpenVR34(); //Offset transform by additional offset values vr::IVRSystemEx::TransformOpenVR34TranslateRelative(matrix, ConfigManager::GetValue(configid_float_overlay_offset_right), ConfigManager::GetValue(configid_float_overlay_offset_up), ConfigManager::GetValue(configid_float_overlay_offset_forward)); vr::VROverlay()->SetOverlayTransformTrackedDeviceRelative(ovrl_handle, device_index, &matrix); } else //No controller connected, uh put it to 0? { vr::VROverlay()->SetOverlayTransformAbsolute(ovrl_handle, universe_origin, &matrix); } break; } case ovrl_origin_left_hand: { vr::TrackedDeviceIndex_t device_index = vr::VRSystem()->GetTrackedDeviceIndexForControllerRole(vr::TrackedControllerRole_LeftHand); if (device_index != vr::k_unTrackedDeviceIndexInvalid) { matrix = ConfigManager::Get().GetOverlayDetachedTransform().toOpenVR34(); //Offset transform by additional offset values vr::IVRSystemEx::TransformOpenVR34TranslateRelative(matrix, ConfigManager::GetValue(configid_float_overlay_offset_right), ConfigManager::GetValue(configid_float_overlay_offset_up), ConfigManager::GetValue(configid_float_overlay_offset_forward)); vr::VROverlay()->SetOverlayTransformTrackedDeviceRelative(ovrl_handle, device_index, &matrix); } else //No controller connected, uh put it to 0? { vr::VROverlay()->SetOverlayTransformAbsolute(ovrl_handle, universe_origin, &matrix); } break; } case ovrl_origin_aux: { vr::TrackedDeviceIndex_t index_tracker = vr::IVRSystemEx::GetFirstVRTracker(); if (index_tracker != vr::k_unTrackedDeviceIndexInvalid) { matrix = ConfigManager::Get().GetOverlayDetachedTransform().toOpenVR34(); //Offset transform by additional offset values vr::IVRSystemEx::TransformOpenVR34TranslateRelative(matrix, ConfigManager::GetValue(configid_float_overlay_offset_right), ConfigManager::GetValue(configid_float_overlay_offset_up), ConfigManager::GetValue(configid_float_overlay_offset_forward)); vr::VROverlay()->SetOverlayTransformTrackedDeviceRelative(ovrl_handle, index_tracker, &matrix); } else //Not connected, uh put it to 0? { vr::VROverlay()->SetOverlayTransformAbsolute(ovrl_handle, universe_origin, &matrix); } break; } } //Update Width vr::VROverlay()->SetOverlayWidthInMeters(ovrl_handle, width); //Update Curvature vr::VROverlay()->SetOverlayCurvature(ovrl_handle, ConfigManager::GetValue(configid_float_overlay_curvature)); //Update Brightness //We use the logarithmic counterpart since the changes in higher steps are barely visible while the lower range can really use those additional steps float brightness = lin2log(ConfigManager::GetValue(configid_float_overlay_brightness)) * ConfigManager::GetValue(configid_float_overlay_state_brightness_extra_multiplier); vr::VROverlay()->SetOverlayColor(ovrl_handle, brightness, brightness, brightness); //Set backside visibility vr::VROverlay()->SetOverlayFlag(ovrl_handle, vr::VROverlayFlags_NoBackside, !data.ConfigBool[configid_bool_overlay_show_backside]); //Set last tick for dashboard dummy delayed update m_LastApplyTransformTick = ::GetTickCount64(); } void OutputManager::ApplySettingCrop() { Overlay& overlay = OverlayManager::Get().GetCurrentOverlay(); OverlayConfigData& data = OverlayManager::Get().GetCurrentConfigData(); vr::VROverlayHandle_t ovrl_handle = overlay.GetHandle(); //UI overlays don't do any cropping and handle the texture bounds themselves if (overlay.GetTextureSource() == ovrl_texsource_ui) return; //Set up overlay cropping vr::VRTextureBounds_t tex_bounds; vr::VRTextureBounds_t tex_bounds_prev; const int content_width = data.ConfigInt[configid_int_overlay_state_content_width]; const int content_height = data.ConfigInt[configid_int_overlay_state_content_height]; if ( (overlay.GetTextureSource() == ovrl_texsource_none) || ((content_width == -1) && (content_height == -1)) ) { tex_bounds.uMin = 0.0f; tex_bounds.vMin = 0.0f; tex_bounds.uMax = 1.0f; tex_bounds.vMax = 1.0f; vr::VROverlay()->SetOverlayTextureBounds(ovrl_handle, &tex_bounds); return; } overlay.UpdateValidatedCropRect(); const DPRect& crop_rect = overlay.GetValidatedCropRect(); const bool is_3d_enabled = ConfigManager::GetValue(configid_bool_overlay_3D_enabled); const int mode_3d = ConfigManager::GetValue(configid_int_overlay_3D_mode); const bool is_ou3d = ( (is_3d_enabled) && ((mode_3d == ovrl_3Dmode_ou) || (mode_3d == ovrl_3Dmode_hou)) ); //Use full texture if everything checks out or 3D mode is Over-Under (converted to a 1:1 fitting texture) if ( (is_ou3d) || ( (crop_rect.GetTL().x == 0) && (crop_rect.GetTL().y == 0) && (crop_rect.GetWidth() == content_width) && (crop_rect.GetHeight() == content_height) ) ) { tex_bounds.uMin = 0.0f; tex_bounds.vMin = 0.0f; tex_bounds.uMax = 1.0f; tex_bounds.vMax = 1.0f; } else { //Otherwise offset the calculated texel coordinates a bit. This is to reduce having colors from outside the cropping area bleeding in from the texture filtering //This means the border pixels of the overlay are smaller, but that's something we need to accept it seems //This doesn't 100% solve texel bleed, especially not on high overlay rendering quality where it can require pretty big offsets depending on overlay size/distance float offset_x = (crop_rect.GetWidth() <= 2) ? 0.0f : 1.5f, offset_y = (crop_rect.GetHeight() <= 2) ? 0.0f : 1.5f; //Yes, we do handle the case of <3 pixel crops tex_bounds.uMin = (crop_rect.GetTL().x + offset_x) / content_width; tex_bounds.vMin = (crop_rect.GetTL().y + offset_y) / content_height; tex_bounds.uMax = (crop_rect.GetBR().x - offset_x) / content_width; tex_bounds.vMax = (crop_rect.GetBR().y - offset_y) / content_height; } //If capture source is WinRT, set 3D mode with cropping values if (ConfigManager::GetValue(configid_int_overlay_capture_source) == ovrl_capsource_winrt_capture) { DPWinRT_SetOverlayOverUnder3D(ovrl_handle, is_ou3d, crop_rect.GetTL().x, crop_rect.GetTL().y, crop_rect.GetWidth(), crop_rect.GetHeight()); } else if (ConfigManager::GetValue(configid_int_overlay_capture_source) == ovrl_capsource_browser) //Same with browser { DPBrowserAPIClient::Get().DPBrowser_SetOverUnder3D(ovrl_handle, is_ou3d, crop_rect.GetTL().x, crop_rect.GetTL().y, crop_rect.GetWidth(), crop_rect.GetHeight()); } else { //For Desktop Duplication, compare old to new bounds to see if a full refresh is required //However, for Over-Under 3D this won't work and we just always do the full refresh bool needs_full_refresh = is_ou3d; if (!needs_full_refresh) { vr::VROverlay()->GetOverlayTextureBounds(ovrl_handle, &tex_bounds_prev); needs_full_refresh = ((tex_bounds.uMin < tex_bounds_prev.uMin) || (tex_bounds.vMin < tex_bounds_prev.vMin) || (tex_bounds.uMax > tex_bounds_prev.uMax) || (tex_bounds.vMax > tex_bounds_prev.vMax)); } if (needs_full_refresh) { RefreshOpenVROverlayTexture(DPRect(-1, -1, -1, -1), true); } } vr::VROverlay()->SetOverlayTextureBounds(ovrl_handle, &tex_bounds); } void OutputManager::ApplySettingInputMode() { //Apply/Restore mouse settings first ApplySettingMouseInput(); const bool drag_or_select_mode_enabled = ( (ConfigManager::GetValue(configid_bool_state_overlay_dragmode)) || (ConfigManager::GetValue(configid_bool_state_overlay_selectmode)) ); //Always applies to all overlays unsigned int current_overlay_old = OverlayManager::Get().GetCurrentOverlayID(); for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { OverlayManager::Get().SetCurrentOverlayID(i); const Overlay& overlay_current = OverlayManager::Get().GetCurrentOverlay(); vr::VROverlayHandle_t ovrl_handle = overlay_current.GetHandle(); if ((ConfigManager::GetValue(configid_bool_overlay_input_enabled)) || (drag_or_select_mode_enabled) ) { //Don't activate drag mode for HMD origin when the pointer is also the HMD (or it's the dashboard overlay) if ( ((ConfigManager::Get().GetPrimaryLaserPointerDevice() == vr::k_unTrackedDeviceIndex_Hmd) && (ConfigManager::GetValue(configid_int_overlay_origin) == ovrl_origin_hmd)) ) { vr::VROverlay()->SetOverlayInputMethod(ovrl_handle, vr::VROverlayInputMethod_None); } else { vr::VROverlay()->SetOverlayInputMethod(ovrl_handle, vr::VROverlayInputMethod_Mouse); } } else { vr::VROverlay()->SetOverlayInputMethod(ovrl_handle, vr::VROverlayInputMethod_None); } //Sync matrix if it's been turned off if ( (!drag_or_select_mode_enabled) && (!ConfigManager::GetValue(configid_bool_state_overlay_dragmode)) ) { DetachedTransformSync(i); } ApplySettingTransform(); } OverlayManager::Get().SetCurrentOverlayID(current_overlay_old); } void OutputManager::ApplySettingMouseInput() { //Set double-click assist duration from user config value if (ConfigManager::GetValue(configid_int_input_mouse_dbl_click_assist_duration_ms) == -1) { ConfigManager::SetValue(configid_int_state_mouse_dbl_click_assist_duration_ms, ::GetDoubleClickTime()); } else { ConfigManager::SetValue(configid_int_state_mouse_dbl_click_assist_duration_ms, ConfigManager::GetValue(configid_int_input_mouse_dbl_click_assist_duration_ms)); } const bool drag_mode_enabled = ((ConfigManager::GetValue(configid_bool_state_overlay_dragmode)) || (m_OvrlDirectDragActive)); const bool select_mode_enabled = ConfigManager::GetValue(configid_bool_state_overlay_selectmode); const bool drag_or_select_mode_enabled = ((drag_mode_enabled) || (select_mode_enabled)); //Always applies to all overlays unsigned int current_overlay_old = OverlayManager::Get().GetCurrentOverlayID(); for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { OverlayManager::Get().SetCurrentOverlayID(i); Overlay& overlay = OverlayManager::Get().GetCurrentOverlay(); vr::VROverlayHandle_t ovrl_handle = overlay.GetHandle(); //Set input method (possibly overridden by ApplyInputMethod() right afterwards) if ((ConfigManager::GetValue(configid_bool_overlay_input_enabled) || (drag_or_select_mode_enabled))) { //Temp drag needs every input-enabled overlay to have smooth scroll if ( (ConfigManager::GetValue(configid_bool_input_mouse_scroll_smooth)) || (ConfigManager::GetValue(configid_bool_state_overlay_dragmode_temp)) || (drag_mode_enabled) ) { vr::VROverlay()->SetOverlayFlag(ovrl_handle, vr::VROverlayFlags_SendVRDiscreteScrollEvents, false); vr::VROverlay()->SetOverlayFlag(ovrl_handle, vr::VROverlayFlags_SendVRSmoothScrollEvents, true); } else { vr::VROverlay()->SetOverlayFlag(ovrl_handle, vr::VROverlayFlags_SendVRDiscreteScrollEvents, true); vr::VROverlay()->SetOverlayFlag(ovrl_handle, vr::VROverlayFlags_SendVRSmoothScrollEvents, false); } vr::VROverlay()->SetOverlayInputMethod(ovrl_handle, vr::VROverlayInputMethod_Mouse); } else { vr::VROverlay()->SetOverlayInputMethod(ovrl_handle, vr::VROverlayInputMethod_None); } //Set intersection blob state bool hide_intersection = false; if (OverlayManager::Get().GetTheaterOverlayID() == i) //Always hide if theater overlay { hide_intersection = true; } else if ( (overlay.GetTextureSource() != ovrl_texsource_none) && (overlay.GetTextureSource() != ovrl_texsource_ui) && (overlay.GetTextureSource() != ovrl_texsource_browser) && (!drag_mode_enabled) && (!select_mode_enabled) ) { hide_intersection = !ConfigManager::GetValue(configid_bool_input_mouse_render_intersection_blob); } vr::VROverlay()->SetOverlayFlag(ovrl_handle, vr::VROverlayFlags_HideLaserIntersection, hide_intersection); ApplySettingMouseScale(); //Set intersection mask for desktop duplication overlays if (overlay.GetTextureSource() == ovrl_texsource_desktop_duplication) { std::vector primitives; primitives.reserve(m_DesktopRects.size()); for (const DPRect& rect : m_DesktopRects) { vr::VROverlayIntersectionMaskPrimitive_t primitive; primitive.m_nPrimitiveType = vr::OverlayIntersectionPrimitiveType_Rectangle; primitive.m_Primitive.m_Rectangle.m_flTopLeftX = rect.GetTL().x - m_DesktopX; primitive.m_Primitive.m_Rectangle.m_flTopLeftY = rect.GetTL().y - m_DesktopY; primitive.m_Primitive.m_Rectangle.m_flWidth = rect.GetWidth(); primitive.m_Primitive.m_Rectangle.m_flHeight = rect.GetHeight(); primitives.push_back(primitive); } vr::EVROverlayError err = vr::VROverlay()->SetOverlayIntersectionMask(ovrl_handle, primitives.data(), (uint32_t)primitives.size()); } else if (overlay.GetTextureSource() != ovrl_texsource_ui) //Or reset intersection mask if not UI overlay { vr::VROverlay()->SetOverlayIntersectionMask(ovrl_handle, nullptr, 0); } } OverlayManager::Get().SetCurrentOverlayID(current_overlay_old); } void OutputManager::ApplySettingMouseScale() { Overlay& overlay = OverlayManager::Get().GetCurrentOverlay(); OverlayConfigData& data = OverlayManager::Get().GetCurrentConfigData(); vr::VROverlayHandle_t ovrl_handle = overlay.GetHandle(); //UI overlays handle the mouse scale themselves if (overlay.GetTextureSource() == ovrl_texsource_ui) return; //Set mouse scale based on capture source vr::HmdVector2_t mouse_scale = {0}; if (overlay.GetTextureSource() == ovrl_texsource_none) { //The mouse scale defines the surface aspect ratio for the intersection test... yeah. If it's off there will be hits over empty space, so try to match it even here //uint32_t ovrl_tex_width = 1, ovrl_tex_height = 1; //Content size might not be what the current texture size is in case of ovrl_texsource_none /*if (vr::VROverlay()->GetOverlayTextureSize(ovrl_handle, &ovrl_tex_width, &ovrl_tex_height) == vr::VROverlayError_None) //GetOverlayTextureSize() currently leaks, so don't use it { mouse_scale.v[0] = ovrl_tex_width; mouse_scale.v[1] = ovrl_tex_height; } else*/ //ovrl_texsource_none pretty much means overlay output error texture, so fall back to that if we can't get the real size { mouse_scale.v[0] = k_lOverlayOutputErrorTextureWidth; mouse_scale.v[1] = k_lOverlayOutputErrorTextureHeight; } } else { switch (data.ConfigInt[configid_int_overlay_capture_source]) { case ovrl_capsource_desktop_duplication: { mouse_scale.v[0] = m_DesktopWidth; mouse_scale.v[1] = m_DesktopHeight; break; } case ovrl_capsource_winrt_capture: case ovrl_capsource_browser: { //Use duplication IDs' data if any is set int duplication_id = ConfigManager::GetValue(configid_int_overlay_duplication_id); const OverlayConfigData& overlay_data = (duplication_id != -1) ? OverlayManager::Get().GetConfigData((unsigned int)duplication_id) : data; mouse_scale.v[0] = overlay_data.ConfigInt[configid_int_overlay_state_content_width]; mouse_scale.v[1] = overlay_data.ConfigInt[configid_int_overlay_state_content_height]; break; } } //Adjust for 3D so surface aspect ratio for laser pointing matches what is seen. //This blocks half or more pixels, but it's not clear what the real target coordinates are with content being different in each eye if (data.ConfigBool[configid_bool_overlay_3D_enabled]) { switch (data.ConfigInt[configid_int_overlay_3D_mode]) { case ovrl_3Dmode_hsbs: case ovrl_3Dmode_sbs: { mouse_scale.v[0] /= 2.0f; break; } case ovrl_3Dmode_hou: case ovrl_3Dmode_ou: { //OU converted to SBS will have texture size based on crop rect const DPRect& crop_rect = overlay.GetValidatedCropRect(); mouse_scale.v[0] = crop_rect.GetWidth(); mouse_scale.v[1] = crop_rect.GetHeight() / 2.0f; } } } } vr::VROverlay()->SetOverlayMouseScale(ovrl_handle, &mouse_scale); } void OutputManager::ApplySettingUpdateLimiter() { //Here's the deal with the fps-based limiter: It just barely works //A simple fps cut-off doesn't work since mouse updates add up to them //Using the right frame time value seems to work in most cases //A full-range, user-chosen fps value doesn't really work though, as the frame time values required don't seem to predictably change ("1000/fps" is close, but the needed adjustment varies) //The frame time method also doesn't work reliably above 50 fps. It limits, but the resulting fps isn't constant. //This is why the fps limiter is somewhat restricted in what settings it offers. It does cover the most common cases, however. //The frame time limiter is still there to offer more fine-tuning after all //Map tested frame time values to the fps enum IDs //FPS: 1 2 5 10 15 20 25 30 40 50 const float fps_enum_values_ms[] = { 985.0f, 485.0f, 195.0f, 96.50f, 63.77f, 47.76f, 33.77f, 31.73f, 23.72f, 15.81f }; float limit_ms = 0.0f; //Set limiter value from global setting if (ConfigManager::GetValue(configid_int_performance_update_limit_mode) == update_limit_mode_ms) { limit_ms = ConfigManager::GetValue(configid_float_performance_update_limit_ms); } else if (ConfigManager::GetValue(configid_int_performance_update_limit_mode) == update_limit_mode_fps) { int enum_id = ConfigManager::GetValue(configid_int_performance_update_limit_fps); if (enum_id <= update_limit_fps_50) { limit_ms = fps_enum_values_ms[enum_id]; } } LARGE_INTEGER limit_delay_global = {0}; limit_delay_global.QuadPart = 1000.0f * limit_ms; //See if there are any overrides from visible overlays //This is the straight forward and least error-prone way, not quite the most efficient one //Calls to this are minimized and there typically aren't many overlays so it's not really that bad (and we do iterate over all of them in many other places too) bool is_first_override = true; for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { const Overlay& overlay = OverlayManager::Get().GetOverlay(i); const OverlayConfigData& data = OverlayManager::Get().GetConfigData(i); if ( (overlay.IsVisible()) && (data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_desktop_duplication) && (data.ConfigInt[configid_int_overlay_update_limit_override_mode] != update_limit_mode_off) ) { float override_ms = 0.0f; if (data.ConfigInt[configid_int_overlay_update_limit_override_mode] == update_limit_mode_ms) { override_ms = data.ConfigFloat[configid_float_overlay_update_limit_override_ms]; } else { int enum_id = data.ConfigInt[configid_int_overlay_update_limit_override_fps]; if (enum_id <= update_limit_fps_50) { override_ms = fps_enum_values_ms[enum_id]; } } //Use override if it results in more updates (except first override, which always has priority over global setting) if ( (is_first_override) || (override_ms < limit_ms) ) { limit_ms = override_ms; is_first_override = false; } } else if (data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_winrt_capture) //Set limit values for WinRT overlays as well { LARGE_INTEGER limit_delay = limit_delay_global; if (data.ConfigInt[configid_int_overlay_update_limit_override_mode] == update_limit_mode_ms) { limit_delay.QuadPart = 1000.0f * data.ConfigFloat[configid_float_overlay_update_limit_override_ms]; } else if (data.ConfigInt[configid_int_overlay_update_limit_override_mode] == update_limit_mode_fps) { int enum_id = data.ConfigInt[configid_int_overlay_update_limit_override_fps]; if (enum_id <= update_limit_fps_50) { limit_delay.QuadPart = 1000.0f * fps_enum_values_ms[enum_id]; } } //Calling this regardless of change might be overkill, but doesn't seem too bad for now DPWinRT_SetOverlayUpdateLimitDelay(overlay.GetHandle(), limit_delay.QuadPart); } } m_PerformanceUpdateLimiterDelay.QuadPart = 1000.0f * limit_ms; } void OutputManager::ApplySettingExtraBrightness() { Overlay& overlay = OverlayManager::Get().GetCurrentOverlay(); OverlayConfigData& data = OverlayManager::Get().GetCurrentConfigData(); float extra_brightness_mulitplier = 1.0f; if (ConfigManager::GetValue(configid_bool_performance_hdr_mirroring)) { const bool ignore_wmr_vscreens = (ConfigManager::GetValue(configid_int_interface_wmr_ignore_vscreens) == 1); switch (overlay.GetTextureSource()) { case ovrl_texsource_desktop_duplication: case ovrl_texsource_desktop_duplication_3dou_converted: { extra_brightness_mulitplier = GetDesktopHDRWhiteLevelAdjustment(data.ConfigInt[configid_int_overlay_desktop_id], false, ignore_wmr_vscreens); break; } case ovrl_texsource_winrt_capture: { int desktop_id = data.ConfigInt[configid_int_overlay_winrt_desktop_id]; //Window capture, need to find the desktop ID it's on if (desktop_id == -2) { HMONITOR monitor_handle = ::MonitorFromWindow((HWND)data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd], MONITOR_DEFAULTTONEAREST); desktop_id = GetDisplayIDFromHMonitor(monitor_handle, ignore_wmr_vscreens); } extra_brightness_mulitplier = GetDesktopHDRWhiteLevelAdjustment(desktop_id, true, ignore_wmr_vscreens); } default: break; } } if (data.ConfigFloat[configid_float_overlay_state_brightness_extra_multiplier] != extra_brightness_mulitplier) { data.ConfigFloat[configid_float_overlay_state_brightness_extra_multiplier] = extra_brightness_mulitplier; //Send change over to UI IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_current_id_override, (int)overlay.GetID()); IPCManager::Get().PostConfigMessageToUIApp(configid_float_overlay_state_brightness_extra_multiplier, extra_brightness_mulitplier); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_current_id_override, -1); } } void OutputManager::DetachedTransformSync(unsigned int overlay_id) { IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_transform_sync_target_id, (int)overlay_id); const float* values = OverlayManager::Get().GetConfigData(overlay_id).ConfigTransform.get(); for (size_t i = 0; i < 16; ++i) { IPCManager::Get().PostConfigMessageToUIApp(configid_float_state_overlay_transform_sync_value, values[i]); } IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_transform_sync_target_id, -1); } void OutputManager::DetachedTransformSyncAll() { for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { DetachedTransformSync(i); } } void OutputManager::DetachedTransformReset(unsigned int overlay_id_ref) { vr::TrackingUniverseOrigin universe_origin = vr::TrackingUniverseStanding; Matrix4& transform = ConfigManager::Get().GetOverlayDetachedTransform(); transform.identity(); //Reset to identity OverlayOrigin overlay_origin = (OverlayOrigin)ConfigManager::GetValue(configid_int_overlay_origin); const Overlay& overlay_ref = OverlayManager::Get().GetOverlay(overlay_id_ref); vr::VROverlayHandle_t ovrl_handle_ref = overlay_ref.GetHandle(); //Results in vr::k_ulOverlayHandleInvalid for k_ulOverlayID_None const bool dont_use_reference = (overlay_origin >= ovrl_origin_hmd) || ( (overlay_origin == ovrl_origin_hmd_floor) && (ConfigManager::GetValue(configid_bool_overlay_origin_hmd_floor_use_turning)) ); if ( (ovrl_handle_ref == vr::k_ulOverlayHandleInvalid) && (!dont_use_reference) ) { const Overlay& overlay_dashboard = OverlayManager::Get().GetPrimaryDashboardOverlay(); if (overlay_dashboard.GetID() != OverlayManager::Get().GetCurrentOverlayID()) { overlay_id_ref = overlay_dashboard.GetID(); ovrl_handle_ref = overlay_dashboard.GetHandle(); } } //Position next to reference if available if (ovrl_handle_ref != vr::k_ulOverlayHandleInvalid) { OverlayConfigData& data = OverlayManager::Get().GetCurrentConfigData(); const OverlayConfigData& data_ref = OverlayManager::Get().GetConfigData(overlay_id_ref); vr::HmdMatrix34_t overlay_transform; vr::HmdVector2_t mouse_scale; bool ref_overlay_changed = false; float ref_overlay_alpha_orig = 0.0f; //GetTransformForOverlayCoordinates() won't work if the reference overlay is not visible, so make it "visible" by showing it with 0% alpha if (!vr::VROverlay()->IsOverlayVisible(ovrl_handle_ref)) { vr::VROverlay()->GetOverlayAlpha(ovrl_handle_ref, &ref_overlay_alpha_orig); vr::VROverlay()->SetOverlayAlpha(ovrl_handle_ref, 0.0f); vr::VROverlay()->ShowOverlay(ovrl_handle_ref); //Showing overlays and getting coordinates from them has a race condition if it's the first time the overlay is shown //Doesn't seem like it can be truly detected when it's ready, so as cheap as it is, this Sleep() seems to get around the issue ::Sleep(50); ref_overlay_changed = true; } //Get mouse scale for overlay coordinate offset vr::VROverlay()->GetOverlayMouseScale(ovrl_handle_ref, &mouse_scale); //Get x-offset multiplier, taking width differences into account float ref_overlay_width; vr::VROverlay()->GetOverlayWidthInMeters(ovrl_handle_ref, &ref_overlay_width); float dashboard_scale = GetDashboardScale(); float x_offset_mul = ( (data.ConfigFloat[configid_float_overlay_width] / ref_overlay_width) / 2.0f) + 1.0f; //Put it next to the reference overlay so it can actually be seen vr::HmdVector2_t coordinate_offset = {mouse_scale.v[0] * x_offset_mul, mouse_scale.v[1] / 2.0f}; vr::VROverlay()->GetTransformForOverlayCoordinates(ovrl_handle_ref, universe_origin, coordinate_offset, &overlay_transform); transform = overlay_transform; //Counteract additonal offset that might've been present on the transform transform.translate_relative(-data_ref.ConfigFloat[configid_float_overlay_offset_right], -data_ref.ConfigFloat[configid_float_overlay_offset_up], -data_ref.ConfigFloat[configid_float_overlay_offset_forward]); //Counteract origin offset for dashboard origin overlays if (overlay_origin == ovrl_origin_dashboard) { float height = GetOverlayHeight(overlay_id_ref); transform.translate_relative(0.0f, height / -2.0f, 0.0f); } //Restore reference overlay state if it was changed if (ref_overlay_changed) { vr::VROverlay()->HideOverlay(ovrl_handle_ref); vr::VROverlay()->SetOverlayAlpha(ovrl_handle_ref, ref_overlay_alpha_orig); } //If the reference overlay appears to be below ground we assume it has an invalid origin (i.e. dashboard tab never opened for dashboard overlay) and use the fallback transform if (transform.getTranslation().y < 0.0f) { transform = GetFallbackOverlayTransform(); } //Adapt to base offset for non-room origins if (overlay_origin != ovrl_origin_room) { Matrix4 transform_base = m_OverlayDragger.GetBaseOffsetMatrix(); transform_base.invert(); transform = transform_base * transform; } } else //Otherwise add some default offset to the previously reset to identity value { switch (overlay_origin) { case ovrl_origin_room: case ovrl_origin_hmd_floor: { //Put it in front of the user's face instead when turning is enabled if ( (overlay_origin == ovrl_origin_hmd_floor) && (ConfigManager::GetValue(configid_bool_overlay_origin_hmd_floor_use_turning)) ) { transform.translate_relative(0.0f, 1.0f, -2.5f); break; } vr::HmdMatrix34_t overlay_transform = {0}; vr::VROverlay()->GetTransformForOverlayCoordinates(m_OvrlHandleDashboardDummy, vr::TrackingUniverseStanding, {0.5f, 0.5f}, &overlay_transform); transform = overlay_transform; //Use fallback transform if dashboard dummy is still set to identity (never opened Desktop+ dashboard tab) if (transform == Matrix4()) { transform = GetFallbackOverlayTransform(); } //Adapt to base offset for non-room origin if (overlay_origin != ovrl_origin_room) { Matrix4 transform_base = m_OverlayDragger.GetBaseOffsetMatrix(); transform_base.invert(); transform = transform_base * transform; } //Remove dashboard scale from transform Vector3 translation = transform.getTranslation(); transform.setTranslation({0.0f, 0.0f, 0.0f}); transform.scale(1.0f / GetDashboardScale()); transform.setTranslation(translation); break; } case ovrl_origin_seated_universe: { transform.translate_relative(0.0f, 0.0f, -1.0f); break; } case ovrl_origin_dashboard: { //Counteract dashboard scale applied by origin transform.scale(1.0f / GetDashboardScale()); break; } case ovrl_origin_hmd: { transform.translate_relative(0.0f, 0.0f, -2.5f); break; } case ovrl_origin_right_hand: { //Set it to a controller component so it doesn't appear right where the laser pointer comes out //There's some doubt about this code, but it seems to work in the end (is there really no better way?) char buffer[vr::k_unMaxPropertyStringSize]; vr::VRSystem()->GetStringTrackedDeviceProperty(vr::VRSystem()->GetTrackedDeviceIndexForControllerRole(vr::TrackedControllerRole_RightHand), vr::Prop_RenderModelName_String, buffer, vr::k_unMaxPropertyStringSize); vr::VRInputValueHandle_t input_value = vr::k_ulInvalidInputValueHandle; vr::VRInput()->GetInputSourceHandle("/user/hand/right", &input_value); vr::RenderModel_ControllerMode_State_t controller_state = {0}; vr::RenderModel_ComponentState_t component_state = {0}; if (vr::VRRenderModels()->GetComponentStateForDevicePath(buffer, vr::k_pch_Controller_Component_HandGrip, input_value, &controller_state, &component_state)) { transform = component_state.mTrackingToComponentLocal; transform.rotateX(-90.0f); transform.translate_relative(0.0f, -0.1f, 0.0f); //This seems like a good default, at least for Index controllers } break; } case ovrl_origin_left_hand: { char buffer[vr::k_unMaxPropertyStringSize]; vr::VRSystem()->GetStringTrackedDeviceProperty(vr::VRSystem()->GetTrackedDeviceIndexForControllerRole(vr::TrackedControllerRole_LeftHand), vr::Prop_RenderModelName_String, buffer, vr::k_unMaxPropertyStringSize); vr::VRInputValueHandle_t input_value = vr::k_ulInvalidInputValueHandle; vr::VRInput()->GetInputSourceHandle("/user/hand/left", &input_value); vr::RenderModel_ControllerMode_State_t controller_state = {0}; vr::RenderModel_ComponentState_t component_state = {0}; if (vr::VRRenderModels()->GetComponentStateForDevicePath(buffer, vr::k_pch_Controller_Component_HandGrip, input_value, &controller_state, &component_state)) { transform = component_state.mTrackingToComponentLocal; transform.rotateX(-90.0f); transform.translate_relative(0.0f, -0.1f, 0.0f); } break; } case ovrl_origin_aux: { transform.translate_relative(0.0f, 0.0f, -0.05f); break; } default: break; } } //Sync reset with UI app DetachedTransformSync(OverlayManager::Get().GetCurrentOverlayID()); ApplySettingTransform(); } void OutputManager::DetachedTransformAdjust(unsigned int packed_value) { Matrix4& transform = ConfigManager::Get().GetOverlayDetachedTransform(); //Unpack IPCActionOverlayPosAdjustTarget target = (IPCActionOverlayPosAdjustTarget)(packed_value & 0xF); bool increase = (packed_value >> 4); //"To HMD" / LookAt button, seperate code path entirely if (target == ipcactv_ovrl_pos_adjust_lookat) { //Get HMD pose vr::TrackedDevicePose_t poses[vr::k_unTrackedDeviceIndex_Hmd + 1]; vr::TrackingUniverseOrigin universe_origin = vr::TrackingUniverseStanding; vr::VRSystem()->GetDeviceToAbsoluteTrackingPose(universe_origin, vr::IVRSystemEx::GetTimeNowToPhotons(), poses, vr::k_unTrackedDeviceIndex_Hmd + 1); if (poses[vr::k_unTrackedDeviceIndex_Hmd].bPoseIsValid) { Matrix4 mat_base_offset = m_OverlayDragger.GetBaseOffsetMatrix(); //Preserve scaling from transform, which can be present in matrices originating from the dashboard Vector3 row_1(transform[0], transform[1], transform[2]); float scale_x = row_1.length(); //Scaling is always uniform so we just check the x-axis //Dashboard origin itself also contains scale, so take the base scale in account as well Vector3 row_1_base(mat_base_offset[0], mat_base_offset[1], mat_base_offset[2]); float scale_x_base = row_1_base.length(); scale_x *= scale_x_base; //Rotate towards HMD position Matrix4 mat_hmd(poses[vr::k_unTrackedDeviceIndex_Hmd].mDeviceToAbsoluteTracking); Matrix4 mat_lookat = mat_base_offset * transform; //Apply base offset for LookAt //Apply dashboard origin offset if needed float overlay_height = 0.0f; if (ConfigManager::GetValue(configid_int_overlay_origin) == ovrl_origin_dashboard) { overlay_height = GetOverlayHeight(OverlayManager::Get().GetCurrentOverlayID()); mat_lookat.translate_relative(0.0f, overlay_height / 2.0f, 0.0f); } vr::IVRSystemEx::TransformLookAt(mat_lookat, mat_hmd.getTranslation()); //Remove dashboard origin offset again if (ConfigManager::GetValue(configid_int_overlay_origin) == ovrl_origin_dashboard) { mat_lookat.translate_relative(0.0f, overlay_height / -2.0f, 0.0f); } //Remove base offset again mat_base_offset.invert(); mat_lookat = mat_base_offset * mat_lookat; //Restore scale factor mat_lookat.setTranslation({0.0f, 0.0f, 0.0f}); mat_lookat.scale(scale_x); mat_lookat.setTranslation(transform.getTranslation()); transform = mat_lookat; ApplySettingTransform(); } return; } Matrix4 mat_back; if (target >= ipcactv_ovrl_pos_adjust_rotx) { //Perform rotation locally mat_back = transform; transform.identity(); } float distance = 0.05f; float angle = 1.0f; //Use snap size as distance if drag snapping is enabled if (ConfigManager::GetValue(configid_bool_input_drag_snap_position)) { distance = ConfigManager::GetValue(configid_float_input_drag_snap_position_size); } if (!increase) { distance *= -1.0f; angle *= -1.0f; } switch (target) { case ipcactv_ovrl_pos_adjust_updown: transform.translate_relative(0.0f, distance, 0.0f); break; case ipcactv_ovrl_pos_adjust_rightleft: transform.translate_relative(distance, 0.0f, 0.0f); break; case ipcactv_ovrl_pos_adjust_forwback: transform.translate_relative(0.0f, 0.0f, distance); break; case ipcactv_ovrl_pos_adjust_rotx: transform.rotateX(angle); break; case ipcactv_ovrl_pos_adjust_roty: transform.rotateY(angle); break; case ipcactv_ovrl_pos_adjust_rotz: transform.rotateZ(angle); break; } if (target >= ipcactv_ovrl_pos_adjust_rotx) { transform = mat_back * transform; } ApplySettingTransform(); } void OutputManager::DetachedTransformConvertOrigin(unsigned int overlay_id, OverlayOrigin origin_from, OverlayOrigin origin_to) { if (origin_from == origin_to) return; const OverlayConfigData& data = OverlayManager::Get().GetConfigData(overlay_id); const OverlayOriginConfig origin_config = OverlayManager::Get().GetOriginConfigFromData(data); DetachedTransformConvertOrigin(overlay_id, origin_from, origin_to, origin_config, origin_config); } void OutputManager::DetachedTransformConvertOrigin(unsigned int overlay_id, OverlayOrigin origin_from, OverlayOrigin origin_to, const OverlayOriginConfig& origin_config_from, const OverlayOriginConfig& origin_config_to) { Overlay& overlay = OverlayManager::Get().GetOverlay(overlay_id); OverlayConfigData& data = OverlayManager::Get().GetConfigData(overlay_id); Matrix4& transform = data.ConfigTransform; //With origin smoothing, just take the current in-between overlay transform even if it's technically less correct bool has_direct_transform = false; if ( (origin_from == ovrl_origin_hmd_floor) && ((origin_from == ovrl_origin_hmd) && (data.ConfigInt[configid_int_overlay_origin_smoothing_level] != 0)) ) { //Only trust that transform if the overlay is visible, however if (vr::VROverlay()->IsOverlayVisible(overlay.GetHandle())) { vr::HmdMatrix34_t transform_ovr; vr::TrackingUniverseOrigin origin; vr::VROverlay()->GetOverlayTransformAbsolute(overlay.GetHandle(), &origin, &transform_ovr); transform = transform_ovr; //Undo additional offset present in transform transform.translate_relative(-ConfigManager::GetValue(configid_float_overlay_offset_right), -ConfigManager::GetValue(configid_float_overlay_offset_up), -ConfigManager::GetValue(configid_float_overlay_offset_forward)); has_direct_transform = true; } } //Usual case, not HMD Floor or origin smoothing applied if (!has_direct_transform) { OverlayOriginConfig origin_config = OverlayManager::Get().GetOriginConfigFromData(data); Matrix4 mat_origin_from = m_OverlayDragger.GetBaseOffsetMatrix(origin_from, origin_config_from); //Apply origin-from matrix to get absolute transform transform = mat_origin_from * transform; if ( (origin_from == ovrl_origin_dashboard) || (origin_to == ovrl_origin_dashboard) ) { //Apply or counteract origin offset used in ApplySettingTransform for dashboard origin float height = GetOverlayHeight(overlay_id); transform.translate_relative(0.0f, (origin_from == ovrl_origin_dashboard) ? height / 2.0f : height / -2.0f, 0.0f); } } //Apply inverse of origin-to matrix to get transform relative to new origin Matrix4 mat_origin_to_inverse = m_OverlayDragger.GetBaseOffsetMatrix(origin_to, origin_config_to); mat_origin_to_inverse.invert(); transform = mat_origin_to_inverse * transform; //Sync transform so the UI doesn't have the wrong idea if no drag occurs after this DetachedTransformSync(overlay_id); //Reset smoothers to avoid potential hitching from previous uses overlay.GetSmootherPos().ResetLastPos(); overlay.GetSmootherRot().ResetLastPos(); } bool OutputManager::DetachedTransformFrameUpdate() { const OverlayConfigData& data = OverlayManager::Get().GetCurrentConfigData(); //Skip if no frame level adjustments are needed if ( (data.ConfigInt[configid_int_overlay_origin] != ovrl_origin_hmd_floor) && ((data.ConfigInt[configid_int_overlay_origin] != ovrl_origin_hmd) || (data.ConfigInt[configid_int_overlay_origin_smoothing_level] == 0)) ) { return false; } //We need to update the overlay pos at a somewhat constant rate for smoothing to be actually smooth //The way RadialFollowCore works doesn't take time into account however //Ideally this would be offloaded into a separate thread doing this at a truly fixed rate, but for now we just skip if we're going too fast (active overlays already force minimum update rate) if (::GetTickCount64() < m_LastFrameTransformUpdateTick + m_MaxActiveRefreshDelay - 3) { return false; } Overlay& overlay = OverlayManager::Get().GetCurrentOverlay(); Matrix4 matrix = m_OverlayDragger.GetBaseOffsetMatrix(); matrix *= ConfigManager::Get().GetOverlayDetachedTransform(); //Offset transform by additional offset values matrix.translate_relative(data.ConfigFloat[configid_float_overlay_offset_right], data.ConfigFloat[configid_float_overlay_offset_up], data.ConfigFloat[configid_float_overlay_offset_forward]); //Use overlay's smoothers to filter the new matrix' position and rotation if (data.ConfigInt[configid_int_overlay_origin_smoothing_level] != 0) { DetachedTransformFrameUpdateApplySmoothingParameters(overlay, data.ConfigInt[configid_int_overlay_origin_smoothing_level]); matrix.setTranslation( overlay.GetSmootherPos().Filter(matrix.getTranslation()) ); matrix.setRotation( overlay.GetSmootherRot().FilterWrapped(matrix.getRotation(), 0.0f, 360.0f) ); } vr::HmdMatrix34_t matrix_ovr = matrix.toOpenVR34(); vr::VROverlay()->SetOverlayTransformAbsolute(OverlayManager::Get().GetCurrentOverlay().GetHandle(), vr::TrackingUniverseStanding, &matrix_ovr); return true; } void OutputManager::DetachedTransformFrameUpdateApplySmoothingParameters(Overlay& overlay, int preset_id) { preset_id = clamp(preset_id, 0, 5); RadialFollowCore& smoother_pos = overlay.GetSmootherPos(); RadialFollowCore& smoother_rot = overlay.GetSmootherRot(); switch (preset_id) { case 0: //Not really used, calling Filter() is skipped entirely instead { smoother_pos.SetOuterRadius(0.0); smoother_pos.SetInnerRadius(0.0); smoother_pos.SetSmoothingCoefficient(0.0); smoother_pos.SetSoftKneeScale(0.0); smoother_pos.SetSmoothingLeakCoefficient(0.0); smoother_rot.SetOuterRadius(0.0); smoother_rot.SetInnerRadius(0.0); smoother_rot.SetSmoothingCoefficient(0.0); smoother_rot.SetSoftKneeScale(0.0); smoother_rot.SetSmoothingLeakCoefficient(0.0); break; } case 1: { smoother_pos.SetOuterRadius(0.0); smoother_pos.SetInnerRadius(0.0); smoother_pos.SetSmoothingCoefficient(0.85); smoother_pos.SetSoftKneeScale(1.0); smoother_pos.SetSmoothingLeakCoefficient(1.0); smoother_rot.SetOuterRadius(0.0); smoother_rot.SetInnerRadius(0.0); smoother_rot.SetSmoothingCoefficient(0.8); smoother_rot.SetSoftKneeScale(1.0); smoother_rot.SetSmoothingLeakCoefficient(1.0); break; } case 2: { smoother_pos.SetOuterRadius(0.0); smoother_pos.SetInnerRadius(0.0); smoother_pos.SetSmoothingCoefficient(0.90); smoother_pos.SetSoftKneeScale(1.0); smoother_pos.SetSmoothingLeakCoefficient(0.95); smoother_rot.SetOuterRadius(0.5); smoother_rot.SetInnerRadius(0.0); smoother_rot.SetSmoothingCoefficient(0.85); smoother_rot.SetSoftKneeScale(1.0); smoother_rot.SetSmoothingLeakCoefficient(1.0); break; } case 3: { smoother_pos.SetOuterRadius(0.02); smoother_pos.SetInnerRadius(0.01); smoother_pos.SetSmoothingCoefficient(0.95); smoother_pos.SetSoftKneeScale(1.0); smoother_pos.SetSmoothingLeakCoefficient(0.90); smoother_rot.SetOuterRadius(1.0); smoother_rot.SetInnerRadius(0.5); smoother_rot.SetSmoothingCoefficient(0.75); smoother_rot.SetSoftKneeScale(1.0); smoother_rot.SetSmoothingLeakCoefficient(1.00); break; } case 4: { smoother_pos.SetOuterRadius(0.10); smoother_pos.SetInnerRadius(0.10); smoother_pos.SetSmoothingCoefficient(0.93); smoother_pos.SetSoftKneeScale(1.0); smoother_pos.SetSmoothingLeakCoefficient(0.97); smoother_rot.SetOuterRadius(7.5); smoother_rot.SetInnerRadius(7.5); smoother_rot.SetSmoothingCoefficient(0.75); smoother_rot.SetSoftKneeScale(0.8); smoother_rot.SetSmoothingLeakCoefficient(1.0); break; } case 5: { smoother_pos.SetOuterRadius(0.25); smoother_pos.SetInnerRadius(0.20); smoother_pos.SetSmoothingCoefficient(0.95); smoother_pos.SetSoftKneeScale(1.0); smoother_pos.SetSmoothingLeakCoefficient(0.97); smoother_rot.SetOuterRadius(30.0); smoother_rot.SetInnerRadius(10.0); smoother_rot.SetSmoothingCoefficient(0.96); smoother_rot.SetSoftKneeScale(0.80); smoother_rot.SetSmoothingLeakCoefficient(0.85); break; } } } void OutputManager::DetachedTransformUpdateSeatedPosition() { Matrix4 mat_seated_zero = vr::VRSystem()->GetSeatedZeroPoseToStandingAbsoluteTrackingPose(); //Sounds stupid, but we can be too fast to react to position updates and get the old seated zero pose as a result... so let's wait once if that happens if (mat_seated_zero == m_SeatedTransformLast) { ::Sleep(100); mat_seated_zero = vr::VRSystem()->GetSeatedZeroPoseToStandingAbsoluteTrackingPose(); } //Update transforms of relevant overlays unsigned int current_overlay_old = OverlayManager::Get().GetCurrentOverlayID(); for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { OverlayManager::Get().SetCurrentOverlayID(i); if (ConfigManager::GetValue(configid_int_overlay_origin) == ovrl_origin_seated_universe) { ApplySettingTransform(); } } OverlayManager::Get().SetCurrentOverlayID(current_overlay_old); m_SeatedTransformLast = mat_seated_zero; } void OutputManager::DetachedInteractionAutoToggleAll() { //Don't change flags while any drag is currently active if ( (m_OverlayDragger.IsDragActive()) || (m_OverlayDragger.IsDragGestureActive()) ) return; float max_distance = ConfigManager::GetValue(configid_float_input_detached_interaction_max_distance); if ( (max_distance != 0.0f) && (!vr::VROverlay()->IsDashboardVisible()) ) { bool do_set_interactive = false; //Add some additional distance for disabling interaction again if (m_LaserPointer.IsActive()) { //...but abort if pointer wasn't activated by this function (not our job to deactivate it) if (m_LaserPointer.GetActivationOrigin() != dplp_activation_origin_auto_toggle) return; max_distance += 0.01f; } vr::TrackedDeviceIndex_t device_index_hovering = m_LaserPointer.IsAnyOverlayHovered(max_distance); //Set pointer device if interaction not active yet and a device is hovering if ( (!m_LaserPointer.IsActive()) && (device_index_hovering != vr::k_unTrackedDeviceIndexInvalid) ) { m_LaserPointer.SetActiveDevice(device_index_hovering, dplp_activation_origin_auto_toggle); } else if ( (m_LaserPointer.IsActive()) && (device_index_hovering == vr::k_unTrackedDeviceIndexInvalid) ) //Clear pointer device if interaction active and no device is hovering { m_LaserPointer.ClearActiveDevice(); } } } void OutputManager::DetachedOverlayGazeFade() { if (ConfigManager::GetValue(configid_bool_overlay_gazefade_enabled)) { Overlay& current_overlay = OverlayManager::Get().GetCurrentOverlay(); //When drag/select mode are active or HMD pose not available, default to most visible alpha setting const float max_alpha = ConfigManager::GetValue(configid_float_overlay_opacity); const float min_alpha = ConfigManager::GetValue(configid_float_overlay_gazefade_opacity); float alpha = std::max(min_alpha, max_alpha); if ((!ConfigManager::GetValue(configid_bool_state_overlay_dragmode)) && (!ConfigManager::GetValue(configid_bool_state_overlay_selectmode))) { vr::TrackingUniverseOrigin universe_origin = vr::TrackingUniverseStanding; vr::TrackedDevicePose_t poses[vr::k_unTrackedDeviceIndex_Hmd + 1]; vr::VRSystem()->GetDeviceToAbsoluteTrackingPose(universe_origin, vr::IVRSystemEx::GetTimeNowToPhotons(), poses, vr::k_unTrackedDeviceIndex_Hmd + 1); if (poses[vr::k_unTrackedDeviceIndex_Hmd].bPoseIsValid) { //Distance the gaze point is offset from HMD (useful range 0.25 - 1.0) float gaze_distance = ConfigManager::GetValue(configid_float_overlay_gazefade_distance); //Rate the fading gets applied when looking off the gaze point (useful range 4.0 - 30, depends on overlay size) float fade_rate = ConfigManager::GetValue(configid_float_overlay_gazefade_rate) * 10.0f; Matrix4 mat_pose = poses[vr::k_unTrackedDeviceIndex_Hmd].mDeviceToAbsoluteTracking; Matrix4 mat_overlay = m_OverlayDragger.GetBaseOffsetMatrix(); mat_overlay *= ConfigManager::Get().GetOverlayDetachedTransform(); //Infinite/Auto distance mode if (gaze_distance == 0.0f) { gaze_distance = mat_overlay.getTranslation().distance(mat_pose.getTranslation()); //Match gaze distance to distance between HMD and overlay } else { gaze_distance += 0.20f; //Useful range starts at ~0.20 - 0.25 (lower is in HMD or culled away), so offset the settings value } mat_pose.translate_relative(0.0f, 0.0f, -gaze_distance); Vector3 pos_gaze = mat_pose.getTranslation(); float distance = mat_overlay.getTranslation().distance(pos_gaze); gaze_distance = std::min(gaze_distance, 1.0f); //To get useful fading past 1m distance we'll have to limit the value to 1m here for the math below alpha = clamp((distance * -fade_rate) + ((gaze_distance - 0.1f) * 10.0f), 0.0f, 1.0f); //There's nothing smart behind this, just trial and error //Use max alpha when the overlay or the Floating UI targeting the overlay is being pointed at if ((ConfigManager::Get().IsLaserPointerTargetOverlay(current_overlay.GetHandle())) || ((unsigned int)ConfigManager::GetValue(configid_int_state_interface_floating_ui_hovered_id) == current_overlay.GetID())) { alpha = std::max(min_alpha, max_alpha); //Take whatever's more visible as the user probably wants to be able to see the overlay } else //Adapt alpha result from a 0.0 - 1.0 range to gazefade_opacity - overlay_opacity and invert if necessary { const float range_length = max_alpha - min_alpha; if (range_length >= 0.0f) { alpha = (alpha * range_length) + min_alpha; } else //Gaze Fade target opacity higher than overlay opcacity, invert behavior { alpha = ((alpha - 1.0f) * range_length) + max_alpha; } } } } //Limit alpha change per frame to smooth out things when abrupt changes happen (i.e. overlay capture took a bit to re-enable or laser pointer forces full alpha) const float prev_alpha = current_overlay.GetOpacity(); const float diff = alpha - prev_alpha; current_overlay.SetOpacity(prev_alpha + clamp(diff, -0.1f, 0.1f)); } } void OutputManager::DetachedOverlayGazeFadeAutoConfigure() { vr::TrackedDevicePose_t poses[vr::k_unTrackedDeviceIndex_Hmd + 1]; vr::VRSystem()->GetDeviceToAbsoluteTrackingPose(vr::TrackingUniverseStanding, vr::IVRSystemEx::GetTimeNowToPhotons(), poses, vr::k_unTrackedDeviceIndex_Hmd + 1); if (poses[vr::k_unTrackedDeviceIndex_Hmd].bPoseIsValid) { OverlayConfigData& data = OverlayManager::Get().GetCurrentConfigData(); Matrix4 mat_pose = poses[vr::k_unTrackedDeviceIndex_Hmd].mDeviceToAbsoluteTracking; Matrix4 mat_overlay = m_OverlayDragger.GetBaseOffsetMatrix(); mat_overlay *= ConfigManager::Get().GetOverlayDetachedTransform(); //Match gaze distance to distance between HMD and overlay float gaze_distance = mat_overlay.getTranslation().distance(mat_pose.getTranslation()); gaze_distance -= 0.20f; //Set fade rate to roughly decrease when the overlay is bigger and further away float fade_rate = 2.5f / data.ConfigFloat[configid_float_overlay_width] * gaze_distance; //Don't let the math go overboard gaze_distance = std::max(gaze_distance, 0.01f); fade_rate = clamp(fade_rate, 0.3f, 1.75f); data.ConfigFloat[configid_float_overlay_gazefade_distance] = gaze_distance; data.ConfigFloat[configid_float_overlay_gazefade_rate] = fade_rate; IPCManager::Get().PostConfigMessageToUIApp(configid_float_overlay_gazefade_distance, gaze_distance); IPCManager::Get().PostConfigMessageToUIApp(configid_float_overlay_gazefade_rate, fade_rate); } } void OutputManager::DetachedOverlayAutoDockingAll() { if ( (!m_OverlayDragger.IsDragActive()) || (!ConfigManager::Get().GetValue(configid_bool_input_drag_auto_docking)) ) { //Set config value to 0 if the drag ended while it wasn't yet if (ConfigManager::GetValue(configid_int_state_auto_docking_state) != 0) { ConfigManager::SetValue(configid_int_state_auto_docking_state, 0); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_auto_docking_state, 0); } return; } const OverlayConfigData& data = OverlayManager::Get().GetConfigData(m_OverlayDragger.GetDragOverlayID()); int config_value = 0; vr::TrackedDevicePose_t poses[vr::k_unMaxTrackedDeviceCount]; vr::VRSystem()->GetDeviceToAbsoluteTrackingPose(vr::TrackingUniverseStanding, vr::IVRSystemEx::GetTimeNowToPhotons(), poses, vr::k_unMaxTrackedDeviceCount); //Check left and right hand controller vr::ETrackedControllerRole controller_role = vr::TrackedControllerRole_LeftHand; for (int controller_role = vr::TrackedControllerRole_LeftHand; controller_role <= vr::TrackedControllerRole_RightHand; ++controller_role) { vr::TrackedDeviceIndex_t device_index = vr::VRSystem()->GetTrackedDeviceIndexForControllerRole((vr::ETrackedControllerRole)controller_role); if ( ((int)device_index != m_OverlayDragger.GetDragDeviceID()) && (device_index < vr::k_unMaxTrackedDeviceCount) && (poses[device_index].bPoseIsValid) ) { //Get distance between dragged overlay and controller Matrix4 controller_pose = poses[device_index].mDeviceToAbsoluteTracking; float distance = m_OverlayDragger.GetDragOverlayMatrix().getTranslation().distance( controller_pose.getTranslation() ); bool is_docked = false; //Check if overlay is already docked if ( ((controller_role == vr::TrackedControllerRole_LeftHand) && (data.ConfigInt[configid_int_overlay_origin] == ovrl_origin_left_hand)) || ((controller_role == vr::TrackedControllerRole_RightHand) && (data.ConfigInt[configid_int_overlay_origin] == ovrl_origin_right_hand)) ) { is_docked = true; } //Set config value if distance is low enough if ( (!is_docked) && (distance < 0.21f) ) { config_value = controller_role; } else if ( (is_docked) && (distance > 0.23f) ) //...or high enough if already docked { config_value = controller_role + 2; } } } //Adjust config value if it changed if (config_value != ConfigManager::GetValue(configid_int_state_auto_docking_state)) { ConfigManager::SetValue(configid_int_state_auto_docking_state, config_value); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_auto_docking_state, config_value); } } void OutputManager::DetachedTempDragStart(unsigned int overlay_id, float offset_forward) { m_OverlayDragger.DragStart(overlay_id); //Drag may fail when dashboard device goes missing //Should not happen as the relevant functions try their best to get an alternative before calling this, but avoid being stuck in temp drag mode if (m_OverlayDragger.IsDragActive()) { m_OverlayDragger.AbsoluteModeSet(true, offset_forward); m_OvrlTempDragStartTick = ::GetTickCount64(); if (m_LaserPointer.IsActive()) { m_LaserPointer.ForceTargetOverlay(OverlayManager::Get().GetOverlay(overlay_id).GetHandle()); } ConfigManager::SetValue(configid_bool_state_overlay_dragmode_temp, true); IPCManager::Get().PostConfigMessageToUIApp(configid_bool_state_overlay_dragmode_temp, true); } } void OutputManager::DetachedTempDragFinish() { if ( (m_OverlayDragger.IsDragActive()) && (ConfigManager::GetValue(configid_bool_state_overlay_dragmode_temp)) ) { OnDragFinish(); //Adjust current overlay for ApplySettingTransform() unsigned int current_overlay_old = OverlayManager::Get().GetCurrentOverlayID(); OverlayManager::Get().SetCurrentOverlayID(m_OverlayDragger.GetDragOverlayID()); m_OverlayDragger.DragFinish(); IPCManager::Get().PostConfigMessageToUIApp(configid_bool_state_overlay_dragmode_temp, false); ConfigManager::SetValue(configid_bool_state_overlay_dragmode_temp, false); ApplySettingTransform(); DetachedTransformSync(OverlayManager::Get().GetCurrentOverlayID()); OverlayManager::Get().SetCurrentOverlayID(current_overlay_old); ApplySettingMouseInput(); } } void OutputManager::OnDragFinish() { if (!m_OverlayDragger.IsDragActive()) return; if (m_OvrlDirectDragActive) { m_OvrlDirectDragActive = false; ApplySettingMouseInput(); } ResetMouseLastLaserPointerPos(); //Handle auto-docking int auto_dock_value = ConfigManager::GetValue(configid_int_state_auto_docking_state); if (auto_dock_value != 0) { //Unpack settings value vr::ETrackedControllerRole role = (auto_dock_value % 2 == 0) ? vr::TrackedControllerRole_RightHand : vr::TrackedControllerRole_LeftHand; bool is_docking = (auto_dock_value <= 2); OverlayConfigData& data = OverlayManager::Get().GetConfigData(m_OverlayDragger.GetDragOverlayID()); if (is_docking) { data.ConfigInt[configid_int_overlay_origin] = (role == vr::TrackedControllerRole_RightHand) ? ovrl_origin_right_hand : ovrl_origin_left_hand; } else { data.ConfigInt[configid_int_overlay_origin] = ovrl_origin_room; } //Send change over to UI IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_current_id_override, (int)m_OverlayDragger.GetDragOverlayID()); IPCManager::Get().PostConfigMessageToUIApp(configid_int_overlay_origin, data.ConfigInt[configid_int_overlay_origin]); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_current_id_override, -1); } Overlay& overlay = OverlayManager::Get().GetOverlay(m_OverlayDragger.GetDragOverlayID()); overlay.GetSmootherPos().ResetLastPos(); overlay.GetSmootherRot().ResetLastPos(); } void OutputManager::OnSetOverlayWinRTCaptureWindow(unsigned int overlay_id) { unsigned int current_overlay_old = OverlayManager::Get().GetCurrentOverlayID(); OverlayManager::Get().SetCurrentOverlayID(overlay_id); Overlay& overlay = OverlayManager::Get().GetCurrentOverlay(); OverlayConfigData& data = OverlayManager::Get().GetCurrentConfigData(); overlay.SetTextureSource(ovrl_texsource_none); ResetCurrentOverlay(); //Reset config_str_overlay_winrt_last_* strings when HWND was explicitly set to null if (data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd] == 0) { data.ConfigStr[configid_str_overlay_winrt_last_window_title] = ""; data.ConfigStr[configid_str_overlay_winrt_last_window_class_name] = ""; data.ConfigStr[configid_str_overlay_winrt_last_window_exe_name] = ""; } OverlayManager::Get().SetCurrentOverlayID(current_overlay_old); } void OutputManager::FinishQueuedOverlayRemovals() { if (m_RemoveOverlayQueue.empty()) return; //Sort in descending order since removals from end will end up with less re-ordering (or even none if the top removed overlay is also the last one) std::sort(m_RemoveOverlayQueue.rbegin(), m_RemoveOverlayQueue.rend()); for (unsigned int overlay_id : m_RemoveOverlayQueue) { OverlayManager::Get().RemoveOverlay(overlay_id); IPCManager::Get().PostMessageToUIApp(ipcmsg_action, ipcact_overlay_remove, overlay_id); } m_RemoveOverlayQueue.clear(); //RemoveOverlay() may have changed active ID, keep in sync ConfigManager::SetValue(configid_int_interface_overlay_current_id, OverlayManager::Get().GetCurrentOverlayID()); } void OutputManager::FixInvalidDashboardLaunchState() { //Workaround for glitchy behavior in SteamVR //When launching SteamVR while wearing the HMD, the dashboard appears automatically. In this state, IsDashboardVisible() returns false and the HMD button is unable to close the dashboard. //There are other things that aren't quite right and Desktop+ relies on the info to be correct in many cases. //This somewhat works around the issue by opening the dashboard for our dashboard overlay. //While a little bit intrusive and not 100% reliable when Desktop+ is auto-launched alongside, it's better than nothing. vr::VROverlayHandle_t system_dashboard; vr::VROverlay()->FindOverlay("system.systemui", &system_dashboard); if ( (vr::VROverlay()->IsOverlayVisible(system_dashboard)) && (!vr::VROverlay()->IsDashboardVisible()) ) { vr::VROverlay()->ShowDashboard("elvissteinjr.DesktopPlusDashboard"); } } void OutputManager::UpdateDashboardHMD_Y() { m_OverlayDragger.UpdateDashboardHMD_Y(); } bool OutputManager::HasDashboardMoved() { //Don't trust anything if it's not visible if (!vr::VROverlay()->IsDashboardVisible()) return false; vr::HmdMatrix34_t hmd_matrix = {0}; vr::TrackingUniverseOrigin universe_origin = vr::TrackingUniverseStanding; if (vr::VROverlay()->IsOverlayVisible(m_OvrlHandleDashboardDummy)) { vr::VROverlay()->GetTransformForOverlayCoordinates(m_OvrlHandleDashboardDummy, universe_origin, {0.0f, 0.0f}, &hmd_matrix); } else { vr::VROverlayHandle_t handle_gamepad_ui = vr::k_ulOverlayHandleInvalid; vr::VROverlay()->FindOverlay("valve.steam.gamepadui.bar", &handle_gamepad_ui); //Use GamepadUI as a reference if available since it's more stable due to the systemui overlay changing size depending on the active dashboard overlay's flags vr::VROverlayHandle_t handle_dashboard = handle_gamepad_ui; if (handle_dashboard == vr::k_ulOverlayHandleInvalid) { vr::VROverlay()->FindOverlay("system.systemui", &handle_dashboard); } vr::HmdVector2_t overlay_dashboard_size; vr::VROverlay()->GetOverlayMouseScale(handle_dashboard, &overlay_dashboard_size); //Coordinate size should be mouse scale vr::VROverlay()->GetTransformForOverlayCoordinates(handle_dashboard, universe_origin, { overlay_dashboard_size.v[0]/2.0f, 0.0f }, &hmd_matrix); } Matrix4 matrix_new = hmd_matrix; if (m_DashboardTransformLast != matrix_new) { m_DashboardTransformLast = hmd_matrix; return true; } return false; } void OutputManager::DimDashboard(bool do_dim) { if (vr::VROverlay() == nullptr) return; //This *could* terribly conflict with other apps messing with these settings, but I'm unaware of any that are right now, so let's just say we're the first vr::VROverlayHandle_t system_dashboard; vr::VROverlay()->FindOverlay("system.systemui", &system_dashboard); if (system_dashboard != vr::k_ulOverlayHandleInvalid) { if (do_dim) { vr::VROverlay()->SetOverlayColor(system_dashboard, 0.05f, 0.05f, 0.05f); } else { vr::VROverlay()->SetOverlayColor(system_dashboard, 1.0f, 1.0f, 1.0f); } } vr::VROverlayHandle_t gamepadui; vr::VROverlay()->FindOverlay("valve.steam.gamepadui.bar", &gamepadui); if (gamepadui != vr::k_ulOverlayHandleInvalid) { if (do_dim) { vr::VROverlay()->SetOverlayColor(gamepadui, 0.05f, 0.05f, 0.05f); } else { vr::VROverlay()->SetOverlayColor(gamepadui, 1.0f, 1.0f, 1.0f); } } } void OutputManager::UpdatePendingDashboardDummyHeight() { float old_dummy_height = 0.0f; vr::VROverlay()->GetOverlayWidthInMeters(m_OvrlHandleDashboardDummy, &old_dummy_height); //Check for dummy height changes but enforce a minimum difference as the underlying size seems to flicker under certain conditions in current SteamVR versions for some reason if (fabs(m_PendingDashboardDummyHeight - old_dummy_height) > 0.01f) { vr::VROverlay()->SetOverlayWidthInMeters(m_OvrlHandleDashboardDummy, m_PendingDashboardDummyHeight); //Perform tactical sleep to avoid flickering caused by dummy adjustments not being done in time when dashboard overlay positioning depends on it if (vr::VROverlay()->IsOverlayVisible(m_OvrlHandleDashboardDummy)) { ::Sleep(100); } m_PendingDashboardDummyHeight = 0.0f; } } bool OutputManager::IsAnyOverlayUsingGazeFade() const { //This is the straight forward, simple version. The smart one, efficiently keeping track properly, could come some other time* //*we know it probably won't happen any time soon for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { const OverlayConfigData& data = OverlayManager::Get().GetConfigData(i); if ( (data.ConfigBool[configid_bool_overlay_enabled]) && (data.ConfigBool[configid_bool_overlay_gazefade_enabled]) ) { return true; } } return false; } void OutputManager::RegisterHotkeys() { //Just unregister all we have when updating any for (int i = 0; i < m_RegisteredHotkeyCount; ++i) { ::UnregisterHotKey(nullptr, i); } m_IsAnyHotkeyActive = false; //...and register them again if there's an action assigned int id = 0; for (ConfigHotkey& hotkey : ConfigManager::Get().GetHotkeys()) { if (hotkey.ActionUID != k_ActionUID_Invalid) { ::RegisterHotKey(nullptr, id, hotkey.Modifiers | MOD_NOREPEAT, hotkey.KeyCode); m_IsAnyHotkeyActive = true; } ++id; } m_RegisteredHotkeyCount = id; //Laser Pointer HMD Device uses hotkeys just as means to block key input to other applications //Actual inputs are checked via VRInput::UpdateKeyboardDeviceState(), so they do not need any handling in HandleHotkeys() or HandleHotkeyMessage() const int hmd_device_hotkey_count = configid_int_input_laser_pointer_hmd_device_keycode_drag - configid_int_input_laser_pointer_hmd_device_keycode_toggle; for (int i = 0; i < hmd_device_hotkey_count + 1; ++i) { ConfigID_Int config_id = (ConfigID_Int)(configid_int_input_laser_pointer_hmd_device_keycode_toggle + i); ::UnregisterHotKey(nullptr, 0xBFFF - i); //0xBFFF is max allowed id, we count down from that to avoid conflicts } if (ConfigManager::GetValue(configid_bool_input_laser_pointer_hmd_device)) //No need to block these keys when the feature is disabled { for (int i = 0; i < hmd_device_hotkey_count + 1; ++i) { ConfigID_Int config_id = (ConfigID_Int)(configid_int_input_laser_pointer_hmd_device_keycode_toggle + i); ::RegisterHotKey(nullptr, 0xBFFF - i, MOD_NOREPEAT, ConfigManager::GetValue(config_id)); } } } void OutputManager::HandleHotkeys() { //This function handles hotkeys manually via GetAsyncKeyState() for some very special games that think consuming all keyboard input is a nice thing to do //Win32 hotkeys are still used simultaneously. Their input blocking might be considered an advantage and the hotkey configurability is designed around them already //Win32 hotkeys also still work while an elevated application has focus, GetAsyncKeyState() doesn't if (!m_IsAnyHotkeyActive) return; for (ConfigHotkey& hotkey : ConfigManager::Get().GetHotkeys()) { if (hotkey.ActionUID != k_ActionUID_Invalid) { if ( (::GetAsyncKeyState(hotkey.KeyCode) < 0) && ( ((hotkey.Modifiers & MOD_SHIFT) == 0) || (::GetAsyncKeyState(VK_SHIFT) < 0) ) && ( ((hotkey.Modifiers & MOD_CONTROL) == 0) || (::GetAsyncKeyState(VK_CONTROL) < 0) ) && ( ((hotkey.Modifiers & MOD_ALT) == 0) || (::GetAsyncKeyState(VK_MENU) < 0) ) && ( ((hotkey.Modifiers & MOD_WIN) == 0) || ((::GetAsyncKeyState(VK_LWIN) < 0) || (::GetAsyncKeyState(VK_RWIN) < 0)) ) ) { if (!hotkey.StateIsDown) { hotkey.StateIsDown = true; ConfigManager::Get().GetActionManager().DoAction(hotkey.ActionUID); } } else if (hotkey.StateIsDown) { hotkey.StateIsDown = false; } } } } void OutputManager::HandleKeyboardAutoVisibility() { //This only handles auto-visibility for desktop/window overlays //Check if state changed static bool is_text_input_focused_prev = false; bool is_text_input_focused = ( (!ConfigManager::GetValue(configid_bool_input_keyboard_auto_show_desktop)) || (m_MouseIgnoreMoveEvent) ) ? false : WindowManager::Get().IsTextInputFocused(); //Overlay input has to be active during a state change for it to count as focused if ((is_text_input_focused != is_text_input_focused_prev) && (!m_OvrlInputActive)) { is_text_input_focused = false; } if (is_text_input_focused != is_text_input_focused_prev) { //Send update to UI process IPCManager::Get().PostMessageToUIApp(ipcmsg_action, ipcact_keyboard_show_auto, (is_text_input_focused) ? ConfigManager::GetValue(configid_int_state_overlay_focused_id) : -1); is_text_input_focused_prev = is_text_input_focused; } } ================================================ FILE: src/DesktopPlus/OutputManager.h ================================================ #ifndef _OUTPUTMANAGER_H_ #define _OUTPUTMANAGER_H_ #include #include "CommonTypes.h" #include "warning.h" #include "openvr.h" #include "Matrices.h" #include "RadialFollowSmoothing.h" #include "OverlayManager.h" #include "ConfigManager.h" #include "SoftwareCursorGrabber.h" #include "InputSimulator.h" #include "VRInput.h" #include "BackgroundOverlay.h" #include "OUtoSBSConverter.h" #include "InterprocessMessaging.h" #include "OverlayDragger.h" #include "LaserPointer.h" class Overlay; // // This class evolved into handling almost everything // Updates the output texture, sends it to OpenVR, handles OpenVR events, IPC messages... // Most of the tasks are related, but splitting stuff up might be an idea in the future // class OutputManager { public: static OutputManager* Get(); OutputManager(HANDLE PauseDuplicationEvent, HANDLE ResumeDuplicationEvent); ~OutputManager(); void CleanRefs(); DUPL_RETURN InitOutput(HWND Window, _Out_ INT& SingleOutput, _Out_ UINT* OutCount, _Out_ RECT* DeskBounds); std::tuple InitOverlay(); //Returns error state DUPL_RETURN_UPD Update(_In_ PTR_INFO* PointerInfo, _In_ DPRect& DirtyRegionTotal, bool NewFrame, bool SkipFrame); void BusyUpdate(); //Updates minimal state (i.e. OverlayDragger) during busy waits (i.e. waiting for browser startup) to appear more responsive bool HandleIPCMessage(const MSG& msg); //Returns true if message caused a duplication reset (i.e. desktop switch) void HandleWinRTMessage(const MSG& msg); //Messages sent by the Desktop+ WinRT library void HandleHotkeyMessage(const MSG& msg); void OnExit(); HWND GetWindowHandle(); HANDLE GetSharedHandle(); IDXGIAdapter* GetDXGIAdapter(); //Don't forget to call Release() on the returned pointer when done with it void ResetOverlays(); void ResetCurrentOverlay(); ID3D11Texture2D* GetOverlayTexture() const; //This returns m_OvrlTex, the backing texture used by the desktop texture overlay (and all overlays stealing its texture) ID3D11Texture2D* GetMultiGPUTargetTexture() const; vr::VROverlayHandle_t GetDesktopTextureOverlay() const; bool GetOverlayActive() const; bool GetOverlayInputActive() const; DWORD GetMaxRefreshDelay() const; float GetHMDFrameRate() const; int GetDesktopWidth() const; int GetDesktopHeight() const; const std::vector& GetDesktopRects() const; float GetDesktopHDRWhiteLevelAdjustment(int desktop_id, bool is_for_graphics_capture, bool wmr_ignore_vscreens) const; void ShowOverlay(unsigned int id); void ShowTheaterOverlay(unsigned int id); void HideOverlay(unsigned int id); void ResetOverlayActiveCount(); //Called by OverlayManager after removing all overlays, makes sure the active counts are correct bool HasDashboardBeenActivatedOnce() const; bool IsDashboardTabActive() const; float GetDashboardScale() const; float GetOverlayHeight(unsigned int overlay_id) const; Matrix4 GetFallbackOverlayTransform() const; //Returns a matrix resulting in the overlay facing the HMD at 2m distance, used when other referenced aren't available void SetOutputErrorTexture(vr::VROverlayHandle_t overlay_handle); void SetOutputInvalid(); //Handles state when there's no valid output bool IsOutputInvalid() const; void SetOverlayEnabled(unsigned int overlay_id, bool is_enabled); void CropToActiveWindowToggle(unsigned int overlay_id); void ShowWindowSwitcher(); void SwitchToWindow(HWND window, bool warp_cursor); void OverlayDirectDragStart(unsigned int overlay_id); void OverlayDirectDragFinish(unsigned int overlay_id); VRInput& GetVRInput(); InputSimulator& GetInputSimulator(); void UpdatePerformanceStates(); const LARGE_INTEGER& GetUpdateLimiterDelay(); //This updates the cached desktop rects and count and optionally chooses the adapters/desktop for desktop duplication (previously part of InitOutput()) int EnumerateOutputs(int target_desktop_id = -1, Microsoft::WRL::ComPtr* out_adapter_preferred = nullptr, Microsoft::WRL::ComPtr* out_adapter_vr = nullptr); void CropToDisplay(int display_id, int& crop_x, int& crop_y, int& crop_width, int& crop_height); bool CropToActiveWindow(int& crop_x, int& crop_y, int& crop_width, int& crop_height); //Returns true if values have changed void InitComIfNeeded(); void ConvertOUtoSBS(Overlay& overlay, OUtoSBSConverter& converter); private: DUPL_RETURN ProcessMonoMask(bool is_mono, PTR_INFO& ptr_info, int& ptr_width, int& ptr_height, int& ptr_left, int& ptr_top, Microsoft::WRL::ComPtr& out_tex, DXGI_FORMAT& out_tex_format, D3D11_BOX& box); DUPL_RETURN ProcessMonoMaskFloat16(bool is_mono, PTR_INFO& ptr_info, int& ptr_width, int& ptr_height, int& ptr_left, int& ptr_top, Microsoft::WRL::ComPtr& out_tex, DXGI_FORMAT& out_tex_format, D3D11_BOX& box); DUPL_RETURN MakeRTV(); DUPL_RETURN InitShaders(); DUPL_RETURN CreateTextures(INT SingleOutput, _Out_ UINT* OutCount, _Out_ RECT* DeskBounds); void DrawFrameToOverlayTex(bool clear_rtv = true); DUPL_RETURN DrawMouseToOverlayTex(_In_ PTR_INFO* PtrInfo); DUPL_RETURN_UPD RefreshOpenVROverlayTexture(DPRect& DirtyRectTotal, bool force_full_copy = false); //Refreshes the overlay texture of the VR runtime with content of the m_OvrlTex backing texture bool DesktopTextureAlphaCheck(); bool HandleOpenVREvents(); //Returns true if quit event happened void OnOpenVRMouseEvent(const vr::VREvent_t& vr_event, unsigned int& current_overlay_old); void HandleKeyboardMessage(IPCActionID ipc_action_id, LPARAM lparam); bool HandleOverlayProfileLoadMessage(LPARAM lparam); void ResetMouseLastLaserPointerPos(); void CropToActiveWindow(); void CropToDisplay(int display_id, bool do_not_apply_setting = false); void DuplicateOverlay(unsigned int base_id, bool is_ui_overlay = false); unsigned int AddOverlay(OverlayCaptureSource capture_source, int desktop_id = -2, HWND window_handle = nullptr); unsigned int AddOverlayDrag(float source_distance, OverlayCaptureSource capture_source, int desktop_id = -2, HWND window_handle = nullptr, float overlay_width = 0.5f); void ApplySettingCaptureSource(); void ApplySetting3DMode(); void ApplySettingTransform(); void ApplySettingCrop(); void ApplySettingInputMode(); void ApplySettingMouseInput(); void ApplySettingMouseScale(); void ApplySettingUpdateLimiter(); void ApplySettingExtraBrightness(); void DetachedTransformSync(unsigned int overlay_id); void DetachedTransformSyncAll(); void DetachedTransformReset(unsigned int overlay_id_ref = k_ulOverlayID_None); void DetachedTransformAdjust(unsigned int packed_value); void DetachedTransformConvertOrigin(unsigned int overlay_id, OverlayOrigin origin_from, OverlayOrigin origin_to); void DetachedTransformConvertOrigin(unsigned int overlay_id, OverlayOrigin origin_from, OverlayOrigin origin_to, const OverlayOriginConfig& origin_config_from, const OverlayOriginConfig& origin_config_to); bool DetachedTransformFrameUpdate(); //Returns if update was applied (not skipped) void DetachedTransformFrameUpdateApplySmoothingParameters(Overlay& overlay, int preset_id); void DetachedTransformUpdateSeatedPosition(); void DetachedInteractionAutoToggleAll(); void DetachedOverlayGazeFade(); void DetachedOverlayGazeFadeAutoConfigure(); void DetachedOverlayAutoDockingAll(); void DetachedTempDragStart(unsigned int overlay_id, float offset_forward = 0.5f); void DetachedTempDragFinish(); //Calls OnDragFinish() void OnDragFinish(); //Called before calling m_OverlayDragger.DragFinish() to handle OutputManager post drag state adjustments (like auto docking) void OnSetOverlayWinRTCaptureWindow(unsigned int overlay_id); //Called when configid_intptr_overlay_state_winrt_hwnd changed void FinishQueuedOverlayRemovals(); //Overlay removals are currently only queued up when requested during HandleWinRTMessage() void FixInvalidDashboardLaunchState(); void UpdateDashboardHMD_Y(); bool HasDashboardMoved(); void DimDashboard(bool do_dim); void UpdatePendingDashboardDummyHeight(); bool IsAnyOverlayUsingGazeFade() const; void RegisterHotkeys(); void HandleHotkeys(); void HandleKeyboardAutoVisibility(); InputSimulator m_InputSim; VRInput m_VRInput; IPCManager m_IPCMan; BackgroundOverlay m_BackgroundOverlay; OverlayDragger m_OverlayDragger; LaserPointer m_LaserPointer; ID3D11Device* m_Device; ID3D11DeviceContext* m_DeviceContext; ID3D11SamplerState* m_Sampler; ID3D11BlendState* m_BlendState; ID3D11RasterizerState* m_RasterizerState; ID3D11VertexShader* m_VertexShader; ID3D11PixelShader* m_PixelShader; ID3D11PixelShader* m_PixelShaderCursor; ID3D11InputLayout* m_InputLayout; ID3D11Texture2D* m_SharedSurf; ID3D11Buffer* m_VertexBuffer; ID3D11ShaderResourceView* m_ShaderResource; IDXGIKeyedMutex* m_KeyMutex; HWND m_WindowHandle; //These handles are not created or closed by this class, they're valid for the entire runtime though HANDLE m_PauseDuplicationEvent; HANDLE m_ResumeDuplicationEvent; int m_DesktopX; //These are the desktop coordinates/size valid for Desktop Duplication and may be different from the m_DesktopRectTotal int m_DesktopY; int m_DesktopWidth; int m_DesktopHeight; std::vector m_DesktopRects; //Cached position and size of available desktops DPRect m_DesktopRectTotal; //Total rect of all available desktops (may not be the same as above Desktop Duplication rect if that's not using the combined desktop) std::vector m_DesktopHDRWhiteLevelAdjustments; //Cached GetDesktopHDRWhiteLevelAdjustment() results used during cursor updates DWORD m_MaxActiveRefreshDelay; bool m_OutputHDRAvailable; //False if OS doesn't support the required interface, regardless of hardware connected bool m_OutputInvalid; bool m_OutputPendingSkippedFrame; bool m_OutputPendingFullRefresh; DPRect m_OutputPendingDirtyRect; DPRect m_OutputLastClippingRect; int m_OutputAlphaChecksPending; bool m_OutputAlphaCheckFailed; //Output appears to be translucent and needs its alpha channel stripped during texture copy vr::VROverlayHandle_t m_OvrlHandleDashboardDummy; vr::VROverlayHandle_t m_OvrlHandleIcon; vr::VROverlayHandle_t m_OvrlHandleDesktopTexture; ID3D11Texture2D* m_OvrlTex; ID3D11RenderTargetView* m_OvrlRTV; int m_OvrlActiveCount; int m_OvrlDesktopDuplActiveCount; bool m_OvrlDashboardActive; bool m_OvrlInputActive; bool m_OvrlDirectDragActive; ULONGLONG m_OvrlTempDragStartTick; float m_PendingDashboardDummyHeight; ULONGLONG m_LastApplyTransformTick; ULONGLONG m_LastFrameTransformUpdateTick; Microsoft::WRL::ComPtr m_MouseTex; Microsoft::WRL::ComPtr m_MouseShaderRes; SoftwareCursorGrabber m_MouseAlternativeCursor; ULONGLONG m_MouseLastClickTick; bool m_MouseIgnoreMoveEvent; bool m_MouseCursorNeedsUpdate; PTR_INFO m_MouseLastInfo; Vector2Int m_MouseLastCursorSize; bool m_MouseLaserPointerUsedLastUpdate; bool m_MouseLastLaserPointerMoveBlocked; int m_MouseLastLaserPointerX; int m_MouseLastLaserPointerY; int m_MouseIgnoreMoveEventMissCount; unsigned int m_MouseLeftDownOverlayID; RadialFollowCore m_MouseLaserPointerSmoother; LARGE_INTEGER m_MouseLaserPointerScrollDeltaStart; LARGE_INTEGER m_MouseLaserPointerScrollDeltaFrequency; bool m_IsFirstLaunch; bool m_ComInitDone; bool m_DashboardActivatedOnce; Matrix4 m_DashboardTransformLast; //This is only used to check if the dashboard has moved from events we can't detect otherwise Matrix4 m_SeatedTransformLast; //These are only used when duplicating outputs from a different GPU ID3D11Device* m_MultiGPUTargetDevice; //Target D3D11 device, meaning the one the HMD is connected to ID3D11DeviceContext* m_MultiGPUTargetDeviceContext; ID3D11Texture2D* m_MultiGPUTexStaging; //Staging texture, owned by m_Device ID3D11Texture2D* m_MultiGPUTexTarget; //Target texture to copy to, owned by m_MultiGPUTargetDevice int m_PerformanceFrameCount; ULONGLONG m_PerformanceFrameCountStartTick; LARGE_INTEGER m_PerformanceUpdateLimiterDelay; std::vector m_ProfileAddOverlayIDQueue; std::vector m_RemoveOverlayQueue; bool m_IsAnyHotkeyActive; int m_RegisteredHotkeyCount; }; #endif ================================================ FILE: src/DesktopPlus/Overlays.cpp ================================================ #include "Overlays.h" #include #include "CommonTypes.h" #include "OpenVRExt.h" #include "OverlayManager.h" #include "OutputManager.h" #include "DesktopPlusWinRT.h" #include "DPBrowserAPIClient.h" Overlay::Overlay(unsigned int id) : m_ID(id), m_OvrlHandle(vr::k_ulOverlayHandleInvalid), m_Visible(false), m_Opacity(1.0f), m_TextureSource(ovrl_texsource_invalid) { //Don't call InitOverlay when OpenVR isn't loaded yet. This happens during startup when loading the config and will be fixed up by OutputManager::InitOverlay() afterwards if (vr::VROverlay() != nullptr) { InitOverlay(); } m_SmootherPos.SetDetectInterruptions(false); m_SmootherRot.SetDetectInterruptions(false); } Overlay::Overlay(Overlay&& b) { m_OvrlHandle = vr::k_ulOverlayHandleInvalid; //This needs a valid value first *this = std::move(b); } Overlay& Overlay::operator=(Overlay&& b) { if (this != &b) { if (m_OvrlHandle != vr::k_ulOverlayHandleInvalid) { if (m_TextureSource == ovrl_texsource_winrt_capture) { DPWinRT_StopCapture(m_OvrlHandle); } else if (m_TextureSource == ovrl_texsource_browser) { DPBrowserAPIClient::Get().DPBrowser_StopBrowser(m_OvrlHandle); } vr::VROverlayEx()->DestroyOverlayEx(m_OvrlHandle); } m_ID = b.m_ID; m_OvrlHandle = b.m_OvrlHandle; m_Visible = b.m_Visible; m_Opacity = b.m_Opacity; m_ValidatedCropRect = b.m_ValidatedCropRect; m_TextureSource = b.m_TextureSource; //m_OUtoSBSConverter should just be left alone, it only holds cached state anyways b.m_OvrlHandle = vr::k_ulOverlayHandleInvalid; } return *this; } Overlay::~Overlay() { if (m_OvrlHandle != vr::k_ulOverlayHandleInvalid) { if (m_TextureSource == ovrl_texsource_winrt_capture) { DPWinRT_StopCapture(m_OvrlHandle); } else if (m_TextureSource == ovrl_texsource_browser) { DPBrowserAPIClient::Get().DPBrowser_StopBrowser(m_OvrlHandle); } vr::VROverlayEx()->DestroyOverlayEx(m_OvrlHandle); } } void Overlay::InitOverlay() { unsigned int id_offset = 0; std::string key; vr::VROverlayHandle_t overlay_handle_find; //Generate overlay key from ID and check if it's not used yet, add to it if it's not //Overlay keys & handles are fixed and don't change when overlays are re-ordered or deleted do { key = "elvissteinjr.DesktopPlus" + std::to_string(m_ID + id_offset); overlay_handle_find = vr::k_ulOverlayHandleInvalid; id_offset++; vr::VROverlay()->FindOverlay(key.c_str(), &overlay_handle_find); } while (overlay_handle_find != vr::k_ulOverlayHandleInvalid); vr::VROverlayError ovrl_error = vr::VROverlayError_None; ovrl_error = vr::VROverlay()->CreateOverlay(key.c_str(), "Desktop+", &m_OvrlHandle); if (ovrl_error == vr::VROverlayError_None) { vr::VROverlay()->SetOverlayAlpha(m_OvrlHandle, m_Opacity); } else //Creation failed, send error to UI so the user at least knows (typically this only happens when the overlay limit is exceeded) { IPCManager::Get().PostMessageToUIApp(ipcmsg_action, ipcact_overlay_creation_error, ovrl_error); } } void Overlay::AssignDesktopDuplicationTexture() { if (m_OvrlHandle != vr::k_ulOverlayHandleInvalid) { OverlayConfigData& data = OverlayManager::Get().GetConfigData(m_ID); if (data.ConfigInt[configid_int_overlay_capture_source] != ovrl_capsource_desktop_duplication) return; OutputManager* outmgr = OutputManager::Get(); if (outmgr == nullptr) return; //Set content size to desktop duplication values int dwidth = outmgr->GetDesktopWidth(); int dheight = outmgr->GetDesktopHeight(); //Avoid sending it over to UI if we can help it if ( (data.ConfigInt[configid_int_overlay_state_content_width] != dwidth) || (data.ConfigInt[configid_int_overlay_state_content_height] != dheight) ) { data.ConfigInt[configid_int_overlay_state_content_width] = dwidth; data.ConfigInt[configid_int_overlay_state_content_height] = dheight; UpdateValidatedCropRect(); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_current_id_override, m_ID); IPCManager::Get().PostConfigMessageToUIApp(configid_int_overlay_state_content_width, dwidth); IPCManager::Get().PostConfigMessageToUIApp(configid_int_overlay_state_content_height, dheight); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_current_id_override, -1); } //Exclude indirect desktop duplication sources, like converted Over-Under 3D if (m_TextureSource != ovrl_texsource_desktop_duplication) return; //Use desktop texture overlay as source for a shared overlay texture ID3D11Resource* device_texture_ref = (OutputManager::Get()->GetMultiGPUTargetTexture() != nullptr) ? OutputManager::Get()->GetMultiGPUTargetTexture() : OutputManager::Get()->GetOverlayTexture(); vr::VROverlayEx()->SetSharedOverlayTexture(outmgr->GetDesktopTextureOverlay(), m_OvrlHandle, device_texture_ref); } } unsigned int Overlay::GetID() const { return m_ID; } void Overlay::SetID(unsigned int id) { m_ID = id; } vr::VROverlayHandle_t Overlay::GetHandle() const { return m_OvrlHandle; } void Overlay::SetHandle(vr::VROverlayHandle_t handle) { m_OvrlHandle = handle; } void Overlay::SetOpacity(float opacity) { if (opacity == m_Opacity) return; OutputManager* outmgr = OutputManager::Get(); if (outmgr == nullptr) return; vr::VROverlay()->SetOverlayAlpha(m_OvrlHandle, opacity); if (m_Opacity == 0.0f) //If it was previously 0%, show if needed { m_Opacity = opacity; //ShouldBeVisible() depends on this being correct, so set it here if ( (!m_Visible) && (ShouldBeVisible()) ) { outmgr->ShowOverlay(m_ID); } } else if (opacity == 0.0f) //If it's 0% now, hide if it shouldn't be visible (Update when Invisble setting can make ShouldBeVisible() return true still) { m_Opacity = opacity; if (!ShouldBeVisible()) { outmgr->HideOverlay(m_ID); } } m_Opacity = opacity; } float Overlay::GetOpacity() const { return m_Opacity; } void Overlay::SetVisible(bool visible) { m_Visible = visible; (visible) ? vr::VROverlay()->ShowOverlay(m_OvrlHandle) : vr::VROverlay()->HideOverlay(m_OvrlHandle); m_SmootherPos.ResetLastPos(); m_SmootherRot.ResetLastPos(); } bool Overlay::IsVisible() const { return m_Visible; } bool Overlay::ShouldBeVisible() const { const OverlayConfigData& data = OverlayManager::Get().GetConfigData(m_ID); if ( (m_Opacity == 0.0f) && (!data.ConfigBool[configid_bool_overlay_update_invisible]) ) return false; bool should_be_visible = false; if (!data.ConfigBool[configid_bool_overlay_enabled]) return false; //Enabled theater mode is always visible if (data.ConfigInt[configid_int_overlay_origin] == ovrl_origin_theater_screen) return true; OutputManager* outmgr = OutputManager::Get(); if (outmgr == nullptr) return false; switch (data.ConfigInt[configid_int_overlay_display_mode]) { case ovrl_dispmode_always: { should_be_visible = true; break; } case ovrl_dispmode_dashboard: { //Our method for getting the dashboard transform only works after it has been manually been brought up once OR the Desktop+ tab has been shown //In practice this means we won't be showing dashboard display mode overlays on the initial SteamVR dashboard that is active when booting up should_be_visible = ( (outmgr->HasDashboardBeenActivatedOnce()) && (vr::VROverlay()->IsDashboardVisible()) ); break; } case ovrl_dispmode_scene: { should_be_visible = !vr::VROverlay()->IsDashboardVisible(); break; } case ovrl_dispmode_dplustab: { should_be_visible = (outmgr->IsDashboardTabActive()); break; } } //Also apply above when origin is dashboard if ( (should_be_visible) && (data.ConfigInt[configid_int_overlay_origin] == ovrl_origin_dashboard) ) { should_be_visible = outmgr->HasDashboardBeenActivatedOnce(); } return should_be_visible; } void Overlay::UpdateValidatedCropRect() { OutputManager* outmgr = OutputManager::Get(); if (outmgr == nullptr) return; const OverlayConfigData& data = OverlayManager::Get().GetConfigData(m_ID); int x, y, width, height; if (data.ConfigBool[configid_bool_overlay_crop_enabled]) { x = std::min( std::max(0, data.ConfigInt[configid_int_overlay_crop_x]), data.ConfigInt[configid_int_overlay_state_content_width]); y = std::min( std::max(0, data.ConfigInt[configid_int_overlay_crop_y]), data.ConfigInt[configid_int_overlay_state_content_height]); width = data.ConfigInt[configid_int_overlay_crop_width]; height = data.ConfigInt[configid_int_overlay_crop_height]; } else //Fall back to default crop when cropping is disabled { //Current desktop cropping values for desktop duplication if ((m_TextureSource == ovrl_texsource_desktop_duplication) || (m_TextureSource == ovrl_texsource_desktop_duplication_3dou_converted)) { outmgr->CropToDisplay(data.ConfigInt[configid_int_overlay_desktop_id], x, y, width, height); } else //Content size for everything else { x = 0; y = 0; width = data.ConfigInt[configid_int_overlay_state_content_width]; height = data.ConfigInt[configid_int_overlay_state_content_height]; } } int width_max = std::max(data.ConfigInt[configid_int_overlay_state_content_width] - x, 1); int height_max = std::max(data.ConfigInt[configid_int_overlay_state_content_height] - y, 1); if (width == -1) width = width_max; else width = std::min(width, width_max); if (height == -1) height = height_max; else height = std::min(height, height_max); m_ValidatedCropRect = DPRect(x, y, x + width, y + height); } const DPRect& Overlay::GetValidatedCropRect() const { return m_ValidatedCropRect; } void Overlay::SetTextureSource(OverlayTextureSource tex_source) { //Skip if nothing changed (except texsource_ui/browser which are always re-applied) if ( (m_TextureSource == tex_source) && (tex_source != ovrl_texsource_ui) && (tex_source != ovrl_texsource_browser) ) return; //Cleanup old sources if needed switch (m_TextureSource) { case ovrl_texsource_desktop_duplication_3dou_converted: m_OUtoSBSConverter.CleanRefs(); break; case ovrl_texsource_winrt_capture: DPWinRT_StopCapture(m_OvrlHandle); break; case ovrl_texsource_ui: { if (tex_source != ovrl_texsource_ui) { vr::VROverlay()->SetOverlayRenderingPid(m_OvrlHandle, ::GetCurrentProcessId()); vr::VROverlay()->SetOverlayIntersectionMask(m_OvrlHandle, nullptr, 0); } break; } case ovrl_texsource_browser: { if (tex_source != ovrl_texsource_browser) { DPBrowserAPIClient::Get().DPBrowser_StopBrowser(m_OvrlHandle); vr::VROverlay()->SetOverlayRenderingPid(m_OvrlHandle, ::GetCurrentProcessId()); } break; } default: break; } //If this overlay is the theater overlay, mark for refresh down below if the source changed bool theater_refresh_needed = ( (m_TextureSource != tex_source) && (OverlayManager::Get().GetTheaterOverlayID() == m_ID) ); m_TextureSource = tex_source; switch (m_TextureSource) { case ovrl_texsource_none: { if (OutputManager* outmgr = OutputManager::Get()) { outmgr->SetOutputErrorTexture(m_OvrlHandle); } break; } case ovrl_texsource_desktop_duplication: /*fallthrough*/ case ovrl_texsource_desktop_duplication_3dou_converted: AssignDesktopDuplicationTexture(); break; case ovrl_texsource_ui: vr::VROverlay()->SetOverlayRenderingPid(m_OvrlHandle, IPCManager::GetUIAppProcessID()); break; case ovrl_texsource_browser: vr::VROverlay()->SetOverlayRenderingPid(m_OvrlHandle, DPBrowserAPIClient::Get().GetServerAppProcessID()); break; default: break; } //Set output error config state { const bool has_no_output = (m_TextureSource == ovrl_texsource_none); OverlayConfigData& data = OverlayManager::Get().GetConfigData(m_ID); if (data.ConfigBool[configid_bool_overlay_state_no_output] != has_no_output) { data.ConfigBool[configid_bool_overlay_state_no_output] = has_no_output; IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_current_id_override, m_ID); IPCManager::Get().PostConfigMessageToUIApp(configid_bool_overlay_state_no_output, has_no_output); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_current_id_override, -1); } } if (theater_refresh_needed) { if (OutputManager* outmgr = OutputManager::Get()) { unsigned int current_overlay_old = OverlayManager::Get().GetCurrentOverlayID(); OverlayManager::Get().SetCurrentOverlayID(m_ID); outmgr->ResetCurrentOverlay(); OverlayManager::Get().SetCurrentOverlayID(current_overlay_old); } } } OverlayTextureSource Overlay::GetTextureSource() const { return m_TextureSource; } void Overlay::OnDesktopDuplicationUpdate() { if ( (m_Visible) && (m_TextureSource == ovrl_texsource_desktop_duplication_3dou_converted) ) { OutputManager::Get()->ConvertOUtoSBS(*this, m_OUtoSBSConverter); } } RadialFollowCore& Overlay::GetSmootherPos() { return m_SmootherPos; } RadialFollowCore& Overlay::GetSmootherRot() { return m_SmootherRot; } ================================================ FILE: src/DesktopPlus/Overlays.h ================================================ #pragma once #include "openvr.h" #include "DPRect.h" #include "OUtoSBSConverter.h" #include "RadialFollowSmoothing.h" //About the Overlay class: //OutputManager's m_OvrlHandleDesktopTexture holds the actual texture handle for every other desktop duplication overlay created by SteamVR //This is *not* documented functionality in SteamVR, but it is the one with the best results. //Additional overlays are also almost free except for the compositor rendering them. //The alternative approach for this would be the documented way of using one texture handle for every overlay created by the overlay application, but this //prevents SteamVR from using the advanced overlay texture filter, so we'd get blurry overlays. Not good. //Given that variant exists, doing it this way is probably somewhat safe. It wouldn't be super hard to fix this up if it broke eventually, though. //Using a separate texture for every overlay would be slower and take up more memory, so there's honestly no upside of that. enum OverlayTextureSource { ovrl_texsource_invalid = -1, //Initial state, shouldn't be set to unless immediately calling SetTextureSource() to explicitly re-apply certain sources ovrl_texsource_none, //Used with capture sources other than desktop duplication while capture is not active ovrl_texsource_desktop_duplication, ovrl_texsource_desktop_duplication_3dou_converted, ovrl_texsource_winrt_capture, ovrl_texsource_ui, ovrl_texsource_browser }; class Overlay { private: unsigned int m_ID; vr::VROverlayHandle_t m_OvrlHandle; bool m_Visible; //IVROverlay::IsOverlayVisible() is unreliable if the state changed during the same frame so we keep track ourselves float m_Opacity; //This is the opacity the overlay is currently set at, which may differ from what the config value is DPRect m_ValidatedCropRect; //Validated cropping rectangle used in OutputManager::Update() to check against dirty update regions OverlayTextureSource m_TextureSource; OUtoSBSConverter m_OUtoSBSConverter; RadialFollowCore m_SmootherPos; RadialFollowCore m_SmootherRot; public: Overlay(unsigned int id); Overlay(Overlay&& b); Overlay& operator=(Overlay&& b); ~Overlay(); void InitOverlay(); void AssignDesktopDuplicationTexture(); unsigned int GetID() const; void SetID(unsigned int id); vr::VROverlayHandle_t GetHandle() const; void SetHandle(vr::VROverlayHandle_t handle); //Sets the handle of the overlay without calling DestroyOverlay() on the previous one, used by OverlayManager void SetOpacity(float opacity); float GetOpacity() const; void SetVisible(bool visible); //Call OutputManager::Show/HideOverlay() instead of this to properly manage duplication state based on active overlays bool IsVisible() const; bool ShouldBeVisible() const; void UpdateValidatedCropRect(); const DPRect& GetValidatedCropRect() const; void SetTextureSource(OverlayTextureSource tex_source); OverlayTextureSource GetTextureSource() const; void OnDesktopDuplicationUpdate(); //Called by OutputManager::RefreshOpenVROverlayTexture() for every overlay, but only if the texture has actually changed RadialFollowCore& GetSmootherPos(); RadialFollowCore& GetSmootherRot(); }; ================================================ FILE: src/DesktopPlus/PixelShader.hlsl ================================================ Texture2D tx : register( t0 ); SamplerState samLinear : register( s0 ); struct PS_INPUT { float4 Pos : SV_POSITION; float2 Tex : TEXCOORD; }; //-------------------------------------------------------------------------------------- // Pixel Shader //-------------------------------------------------------------------------------------- float4 PS(PS_INPUT input) : SV_Target { float4 color; color = tx.Sample(samLinear, input.Tex); color.a = (color.a > 0.0) ? 1.0 : 0.0; //Enforce 1-bit alpha as on some systems the duplication output isn't opaque for some reason return color; } ================================================ FILE: src/DesktopPlus/PixelShaderCursor.hlsl ================================================ Texture2D tx : register( t0 ); SamplerState samLinear : register( s0 ); struct PS_INPUT { float4 Pos : SV_POSITION; float2 Tex : TEXCOORD; }; //-------------------------------------------------------------------------------------- // Pixel Shader //-------------------------------------------------------------------------------------- float4 PSCURSOR(PS_INPUT input) : SV_Target { return tx.Sample(samLinear, input.Tex); } ================================================ FILE: src/DesktopPlus/RadialFollowSmoothing.cpp ================================================ /* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at https://mozilla.org/MPL/2.0/. */ //This source file and accompanying header is based on //AbstractQbit's Radial Follow Smoothing OpenTabletDriver Plugin (https://github.com/AbstractQbit/AbstractOTDPlugins) (RadialFollowCore.cs only) #include "RadialFollowSmoothing.h" #include double RadialFollowCore::GetOuterRadius() { return m_RadiusOuter; } void RadialFollowCore::SetOuterRadius(double value) { m_RadiusOuter = clamp(m_RadiusOuter, 0.0, 1000000.0); } double RadialFollowCore::GetInnerRadius() { return m_RadiusInner; } void RadialFollowCore::SetInnerRadius(double value) { m_RadiusInner = clamp(value, 0.0, 1000000.0); } double RadialFollowCore::GetSmoothingCoefficient() { return m_SmoothingCoef; } void RadialFollowCore::SetSmoothingCoefficient(double value) { m_SmoothingCoef = clamp(value, 0.0001, 1.0); } double RadialFollowCore::GetSoftKneeScale() { return m_SoftKneeScale; } void RadialFollowCore::SetSoftKneeScale(double value) { m_SoftKneeScale = clamp(value, 0.0, 100.0); UpdateDerivedParams(); } double RadialFollowCore::GetSmoothingLeakCoefficient() { return m_SmoothingLeakCoef; } void RadialFollowCore::SetSmoothingLeakCoefficient(double value) { m_SmoothingLeakCoef = clamp(value, 0.0, 1.0); } bool RadialFollowCore::GetDetectInterruptions() { return m_DetectInterruptions; } void RadialFollowCore::SetDetectInterruptions(bool value) { m_DetectInterruptions = value; } void RadialFollowCore::ApplyPresetSettings(int preset_id) { preset_id = clamp(preset_id, 0, 5); //These are just presets used by Desktop+, in hopes that they make sense for laser pointing and are easier to use than adjusting values directly switch (preset_id) { case 0: //Not really used, skip calling Filter() entirely instead { SetOuterRadius(0.0); SetInnerRadius(0.0); SetSmoothingCoefficient(0.0); SetSoftKneeScale(0.0); SetSmoothingLeakCoefficient(0.0); break; } case 1: { SetOuterRadius(5.0); SetInnerRadius(0.5); SetSmoothingCoefficient(0.95); SetSoftKneeScale(1.0); SetSmoothingLeakCoefficient(0.0); break; } case 2: { SetOuterRadius(5.0); SetInnerRadius(3.0); SetSmoothingCoefficient(0.95); SetSoftKneeScale(1.0); SetSmoothingLeakCoefficient(0.0); break; } case 3: { SetOuterRadius(7.5); SetInnerRadius(4.5); SetSmoothingCoefficient(1.0); SetSoftKneeScale(5.0); SetSmoothingLeakCoefficient(0.25); break; } case 4: { SetOuterRadius(12.5); SetInnerRadius(7.5); SetSmoothingCoefficient(1.0); SetSoftKneeScale(10.0); SetSmoothingLeakCoefficient(0.5); break; } case 5: { SetOuterRadius(32.0); SetInnerRadius(12.0); SetSmoothingCoefficient(1.0); SetSoftKneeScale(50.0); SetSmoothingLeakCoefficient(0.75); break; } } } float RadialFollowCore::SampleRadialCurve(float dist) { return (float)DeltaFn(dist, m_XOffset, m_ScaleComp); } Vector2 RadialFollowCore::Filter(const Vector2& target) { Vector2 direction = target - m_LastPos; float distToMove = SampleRadialCurve(direction.length()); direction.normalize(); m_LastPos = m_LastPos + (direction * distToMove); //Catch NaNs and interrupted input if ( !((std::isfinite(m_LastPos.x)) && (std::isfinite(m_LastPos.y))) || ((m_DetectInterruptions) && (::GetTickCount64() > m_LastTick + 50)) ) m_LastPos = target; m_LastTick = ::GetTickCount64(); return m_LastPos; } Vector3 RadialFollowCore::Filter(const Vector3& target) { Vector3 direction = target - m_LastPos3; float distToMove = SampleRadialCurve(direction.length()); direction.normalize(); m_LastPos3 = m_LastPos3 + (direction * distToMove); //Catch NaNs and interrupted input if ( !((std::isfinite(m_LastPos3.x)) && (std::isfinite(m_LastPos3.y)) && (std::isfinite(m_LastPos3.z))) || ((m_DetectInterruptions) && (::GetTickCount64() > m_LastTick + 50)) ) m_LastPos3 = target; m_LastTick = ::GetTickCount64(); return m_LastPos3; } Vector3 RadialFollowCore::FilterWrapped(const Vector3& target, float value_min, float value_max) { auto unwrap_to_nearest = [&](const float value_wrapped, const float value_prev) { //Unwrap value in a way that ensures close to the previous one const float range_width = value_max - value_min; const float value_in_range = value_wrapped - std::floor((value_wrapped - value_min) / range_width) * range_width; //Shift by multiples of range_width so the value is +/- half range_width to the previous value const float delta = value_prev - value_in_range; return value_in_range + std::round(delta / range_width) * range_width; }; Vector3 target_unwrapped = target; target_unwrapped.x = unwrap_to_nearest(target.x, m_LastPos3.x); target_unwrapped.y = unwrap_to_nearest(target.y, m_LastPos3.y); target_unwrapped.z = unwrap_to_nearest(target.z, m_LastPos3.z); Vector3 direction = target_unwrapped - m_LastPos3; float distToMove = SampleRadialCurve(direction.length()); direction.normalize(); m_LastPos3 = m_LastPos3 + (direction * distToMove); //Catch NaNs and interrupted input if ( !((std::isfinite(m_LastPos3.x)) && (std::isfinite(m_LastPos3.y)) && (std::isfinite(m_LastPos3.z))) || ((m_DetectInterruptions) && (::GetTickCount64() > m_LastTick + 50)) ) m_LastPos3 = target; m_LastTick = ::GetTickCount64(); return m_LastPos3; } void RadialFollowCore::ResetLastPos() { //Filter() functions will already fall back to the target pos if any results aren't finite so this does the trick m_LastPos.x = INFINITY; m_LastPos3.x = INFINITY; } void RadialFollowCore::UpdateDerivedParams() { if (m_SoftKneeScale > 0.0001f) { m_XOffset = GetXOffset(); m_ScaleComp = GetScaleComp(); } else //Calculating them with functions would use / by 0 { m_XOffset = -1.0; m_ScaleComp = 1.0; } } double RadialFollowCore::KneeFunc(double x) { if (x < -3.0) return x; else if (x < 3.0) return log(tanh(exp(x))); else return 0.0; } double RadialFollowCore::KneeScaled(double x) { if (m_SoftKneeScale > 0.0001) return m_SoftKneeScale * KneeFunc(x / m_SoftKneeScale) + 1.0; else return (x > 0.0) ? 1.0 : 1.0 + x; } double RadialFollowCore::InverseTanh(double x) { return log((1.0 + x) / (1.0 - x)) / 2.0; } double RadialFollowCore::InverseKneeScaled(double x) { return m_SoftKneeScale * log(InverseTanh(exp((x - 1.0) / m_SoftKneeScale))); } double RadialFollowCore::DeriveKneeScaled(double x) { const double x_e = exp(x / m_SoftKneeScale); const double x_e_tanh = tanh(x_e); return (x_e - x_e * (x_e_tanh * x_e_tanh)) / x_e_tanh; } double RadialFollowCore::GetXOffset() { return InverseKneeScaled(0.0); } double RadialFollowCore::GetScaleComp() { return DeriveKneeScaled(GetXOffset()); } double RadialFollowCore::GetRadiusOuterAdjusted() { return m_GridScale * std::max(m_RadiusOuter, m_RadiusInner + 0.0001); } double RadialFollowCore::GetRadiusInnerAdjusted() { return m_GridScale * m_RadiusInner; } double RadialFollowCore::LeakedFn(double x, double offset, double scaleComp) { return KneeScaled(x + offset) * (1 - m_SmoothingLeakCoef) + x * m_SmoothingLeakCoef * scaleComp; } double RadialFollowCore::SmoothedFn(double x, double offset, double scaleComp) { return LeakedFn(x * m_SmoothingCoef / scaleComp, offset, scaleComp); } double RadialFollowCore::ScaleToOuter(double x, double offset, double scaleComp) { return (GetRadiusOuterAdjusted() - GetRadiusInnerAdjusted()) * SmoothedFn(x / (GetRadiusOuterAdjusted() - GetRadiusInnerAdjusted()), offset, scaleComp); } double RadialFollowCore::DeltaFn(double x, double offset, double scaleComp) { return (x > GetRadiusInnerAdjusted()) ? x - ScaleToOuter(x - GetRadiusInnerAdjusted(), offset, scaleComp) - GetRadiusInnerAdjusted() : 0.0; } ================================================ FILE: src/DesktopPlus/RadialFollowSmoothing.h ================================================ /* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at https://mozilla.org/MPL/2.0/. */ //This header and accompanying source file is based on //AbstractQbit's Radial Follow Smoothing OpenTabletDriver Plugin (https://github.com/AbstractQbit/AbstractOTDPlugins) (RadialFollowCore.cs only) #pragma once #include "Util.h" class RadialFollowCore { public: double GetOuterRadius(); void SetOuterRadius(double value); double GetInnerRadius(); void SetInnerRadius(double value); double GetSmoothingCoefficient(); void SetSmoothingCoefficient(double value); double GetSoftKneeScale(); void SetSoftKneeScale(double value); double GetSmoothingLeakCoefficient(); void SetSmoothingLeakCoefficient(double value); bool GetDetectInterruptions(); void SetDetectInterruptions(bool value); void ApplyPresetSettings(int preset_id); float SampleRadialCurve(float dist); Vector2 Filter(const Vector2& target); Vector3 Filter(const Vector3& target); Vector3 FilterWrapped(const Vector3& target, float value_min, float value_max); //Treats changes like max to min as small steps, but doesn't wrap the return value void ResetLastPos(); private: double m_RadiusOuter = 5.0; double m_RadiusInner = 0.0; double m_SmoothingCoef = 0.95; double m_SoftKneeScale = 1.0; double m_SmoothingLeakCoef = 0.0; double m_GridScale = 1.0; Vector2 m_LastPos; Vector3 m_LastPos3; ULONGLONG m_LastTick = 0; bool m_DetectInterruptions = true; double m_XOffset = -1.0; double m_ScaleComp = 1.0; void UpdateDerivedParams(); //Math functions double KneeFunc(double x); double KneeScaled(double x); double InverseTanh(double x); double InverseKneeScaled(double x); double DeriveKneeScaled(double x); double GetXOffset(); double GetScaleComp(); double GetRadiusOuterAdjusted(); double GetRadiusInnerAdjusted(); double LeakedFn(double x, double offset, double scaleComp); double SmoothedFn(double x, double offset, double scaleComp); double ScaleToOuter(double x, double offset, double scaleComp); double DeltaFn(double x, double offset, double scaleComp); }; ================================================ FILE: src/DesktopPlus/SoftwareCursorGrabber.cpp ================================================ #include "SoftwareCursorGrabber.h" #include "Logging.h" bool SoftwareCursorGrabber::CopyMonoMask(const ICONINFO& icon_info) { bool ret = false; HDC hdc = ::GetDC(nullptr); if (!hdc) return ret; //Get bitmap info from cursor bitmap BITMAPINFO bmp_info = {0}; bmp_info.bmiHeader.biSize = sizeof(bmp_info.bmiHeader); if (::GetDIBits(hdc, icon_info.hbmMask, 0, 0, nullptr, &bmp_info, DIB_RGB_COLORS) != 0) { int cursor_width = bmp_info.bmiHeader.biWidth; int cursor_height = abs(bmp_info.bmiHeader.biHeight); bmp_info.bmiHeader.biSize = sizeof(bmp_info.bmiHeader); bmp_info.bmiHeader.biBitCount = 1; bmp_info.bmiHeader.biCompression = BI_RGB; bmp_info.bmiHeader.biHeight = -cursor_height; //Always use top-down order (negative height) //Add monochrome palette (and deal with the dynamic struct size) RGBQUAD palette[2] = {{0, 0, 0, 0}, {255, 255, 255, 255}}; auto bmp_info_extended_data = std::unique_ptr{new BYTE[sizeof(bmp_info.bmiHeader) + sizeof(palette)]}; BITMAPINFO* bmp_info_extended_ptr = (BITMAPINFO*)bmp_info_extended_data.get(); memcpy(&bmp_info_extended_ptr->bmiHeader, &bmp_info.bmiHeader, sizeof(bmp_info.bmiHeader)); memcpy(bmp_info_extended_ptr->bmiColors, palette, sizeof(palette)); //Read the actual bitmap buffer into a temporary pixel data array (4-byte aligned) const int padded_stride = ((cursor_width + 31) / 32) * 4; auto temp_buffer = std::unique_ptr{new BYTE[padded_stride * cursor_height]}; if (::GetDIBits(hdc, icon_info.hbmMask, 0, cursor_height, temp_buffer.get(), bmp_info_extended_ptr, DIB_RGB_COLORS) != 0) { //Remove padding returned by GetDIBits so we end up with something that matches what Desktop Duplication returns size_t used_bytes_per_scanline = ((size_t)cursor_width + 7) / 8; m_DDPPointerInfo.ShapeBuffer.assign(used_bytes_per_scanline * cursor_height, 0); for (int y = 0; y < cursor_height; ++y) { BYTE* src_line = temp_buffer.get() + y * padded_stride; BYTE* dst_line = m_DDPPointerInfo.ShapeBuffer.data() + y * used_bytes_per_scanline; memcpy(dst_line, src_line, used_bytes_per_scanline); } m_DDPPointerInfo.ShapeInfo.Width = cursor_width; m_DDPPointerInfo.ShapeInfo.Height = cursor_height; m_DDPPointerInfo.ShapeInfo.Pitch = 4; ret = true; } } ::ReleaseDC(nullptr, hdc); return ret; } bool SoftwareCursorGrabber::CopyColor(const ICONINFO& icon_info) { bool ret = false; HDC hdc = ::GetDC(nullptr); if (!hdc) return ret; BITMAPINFO bmp_info = {0}; bmp_info.bmiHeader.biSize = sizeof(bmp_info.bmiHeader); if (::GetDIBits(hdc, icon_info.hbmColor, 0, 0, nullptr, &bmp_info, DIB_RGB_COLORS) != 0) { int cursor_width = bmp_info.bmiHeader.biWidth; int cursor_height = abs(bmp_info.bmiHeader.biHeight); bmp_info.bmiHeader.biSize = sizeof(bmp_info.bmiHeader); bmp_info.bmiHeader.biBitCount = 32; bmp_info.bmiHeader.biCompression = BI_RGB; bmp_info.bmiHeader.biHeight = -cursor_height; //Always use top-down order (negative height) m_DDPPointerInfo.ShapeBuffer.resize((size_t)cursor_width * cursor_height * 4); if (::GetDIBits(hdc, icon_info.hbmColor, 0, cursor_height, m_DDPPointerInfo.ShapeBuffer.data(), &bmp_info, DIB_RGB_COLORS) != 0) { //Even if we don't override biBitCount to 32, it's still returned as that for 24-bit and lower bit-depth cursors (probably just the screen DC format) //It seems the only way to check if the cursor needs its mask applied is to see if the alpha channel is fully blank //32-bit cursors still come with masks, but applying them means to override the alpha channel with a 1-bit one (and doing so is also wasteful) const bool needs_mask = IsShapeBufferBlank(m_DDPPointerInfo.ShapeBuffer.data(), m_DDPPointerInfo.ShapeBuffer.size(), DXGI_OUTDUPL_POINTER_SHAPE_TYPE_COLOR); if (needs_mask) { auto pixel_data_mask = std::unique_ptr{new BYTE[m_DDPPointerInfo.ShapeBuffer.size()]}; //Read the mask bitmap buffer if (::GetDIBits(hdc, icon_info.hbmMask, 0, cursor_height, (LPVOID)pixel_data_mask.get(), &bmp_info, DIB_RGB_COLORS) != 0) { //Apply mask to color pixel data BYTE* psrc = m_DDPPointerInfo.ShapeBuffer.data() + 3; //BGRA alpha pixel BYTE* pmsk = pixel_data_mask.get(); //BGRA blue pixel (alpha channel is blank for the mask) const BYTE* const psrc_end = m_DDPPointerInfo.ShapeBuffer.data() + m_DDPPointerInfo.ShapeBuffer.size(); for (; psrc < psrc_end; psrc += 4, pmsk += 4) { *psrc = ~(*pmsk); } } } m_DDPPointerInfo.ShapeInfo.Width = cursor_width; m_DDPPointerInfo.ShapeInfo.Height = cursor_height; m_DDPPointerInfo.ShapeInfo.Pitch = cursor_width * 4; ret = true; } } ::ReleaseDC(nullptr, hdc); return ret; } bool SoftwareCursorGrabber::IsShapeBufferBlank(BYTE* psrc, size_t size, UINT type) { if (type == DXGI_OUTDUPL_POINTER_SHAPE_TYPE_COLOR) { const BYTE* const psrc_end = psrc + size; psrc = psrc + 3; //first BGRA alpha pixel for (; psrc < psrc_end; psrc += 4) { if (*psrc != 0) { return false; } } } else if (type == DXGI_OUTDUPL_POINTER_SHAPE_TYPE_MONOCHROME) { const BYTE* const psrc_end = psrc + size; psrc = psrc + (size / 2); //first mask pixel for (; psrc < psrc_end; ++psrc) { if (*psrc != 0) { return false; } } } return true; } bool SoftwareCursorGrabber::SynthesizeDDPCursorInfo() { LOG_IF_F(INFO, !m_LoggedOnceUsed, "Using Alternative Cursor Rendering"); m_LoggedOnceUsed = true; CURSORINFO cursor_info = {0}; cursor_info.cbSize = sizeof(CURSORINFO); bool ret = false; if (::GetCursorInfo(&cursor_info)) { const bool shape_changed = (cursor_info.hCursor != m_CursorInfoLast.hCursor); if (shape_changed) { if (cursor_info.hCursor != nullptr) { ICONINFO icon_info = {}; if (::GetIconInfo(cursor_info.hCursor, &icon_info)) { ret = (icon_info.hbmColor != nullptr) ? CopyColor(icon_info) : CopyMonoMask(icon_info); m_DDPPointerInfo.ShapeInfo.Type = (icon_info.hbmColor != nullptr) ? DXGI_OUTDUPL_POINTER_SHAPE_TYPE_COLOR : DXGI_OUTDUPL_POINTER_SHAPE_TYPE_MONOCHROME; ::DeleteObject(icon_info.hbmColor); ::DeleteObject(icon_info.hbmMask); } //Fallback: If getting the icon info failed or "succeeded" with blank data, try copying the default arrow pointer instead if ((!ret) || (IsShapeBufferBlank(m_DDPPointerInfo.ShapeBuffer.data(), m_DDPPointerInfo.ShapeBuffer.size(), m_DDPPointerInfo.ShapeInfo.Type))) { LOG_IF_F(WARNING, !m_LoggedOnceFallbackDefault, "Alternative Cursor Rendering: Getting current cursor failed. Falling back to default cursor."); m_LoggedOnceFallbackDefault = true; ret = false; if (::GetIconInfo(::LoadCursor(nullptr, IDC_ARROW), &icon_info)) { ret = (icon_info.hbmColor != nullptr) ? CopyColor(icon_info) : CopyMonoMask(icon_info); m_DDPPointerInfo.ShapeInfo.Type = (icon_info.hbmColor != nullptr) ? DXGI_OUTDUPL_POINTER_SHAPE_TYPE_COLOR : DXGI_OUTDUPL_POINTER_SHAPE_TYPE_MONOCHROME; //Check if somehow still blank if (ret) { ret = !IsShapeBufferBlank(m_DDPPointerInfo.ShapeBuffer.data(), m_DDPPointerInfo.ShapeBuffer.size(), m_DDPPointerInfo.ShapeInfo.Type); } ::DeleteObject(icon_info.hbmColor); ::DeleteObject(icon_info.hbmMask); } } //Set other data if cursor copy was successful if (ret) { m_DDPPointerInfo.CursorShapeChanged = true; m_DDPPointerInfo.ShapeInfo.HotSpot.x = icon_info.xHotspot; m_DDPPointerInfo.ShapeInfo.HotSpot.y = icon_info.yHotspot; } else { LOG_IF_F(WARNING, !m_LoggedOnceFallbackBlob, "Alternative Cursor Rendering: Getting default cursor failed. Falling back to simple blob."); m_LoggedOnceFallbackBlob = true; //Everything else failed, put a blob there m_DDPPointerInfo.ShapeInfo.Width = 12; m_DDPPointerInfo.ShapeInfo.Height = 19 * 2; //Double height for mask m_DDPPointerInfo.ShapeBuffer.assign((size_t)m_DDPPointerInfo.ShapeInfo.Width * m_DDPPointerInfo.ShapeInfo.Height, 255); m_DDPPointerInfo.CursorShapeChanged = true; m_DDPPointerInfo.ShapeInfo.Type = DXGI_OUTDUPL_POINTER_SHAPE_TYPE_MONOCHROME; m_DDPPointerInfo.ShapeInfo.Pitch = 4; m_DDPPointerInfo.ShapeInfo.HotSpot.x = 0; m_DDPPointerInfo.ShapeInfo.HotSpot.y = 0; ret = true; } } else { //Create blank 1x1 pixel data for null cursor handle m_DDPPointerInfo.ShapeBuffer.assign(4, 0); m_DDPPointerInfo.ShapeInfo.Width = 1; m_DDPPointerInfo.ShapeInfo.Height = 1; ret = true; } } else { ret = true; } if (ret) { m_DDPPointerInfo.Visible = (cursor_info.flags == CURSOR_SHOWING); m_DDPPointerInfo.Position = cursor_info.ptScreenPos; m_DDPPointerInfo.Position.x -= m_DDPPointerInfo.ShapeInfo.HotSpot.x; m_DDPPointerInfo.Position.y -= m_DDPPointerInfo.ShapeInfo.HotSpot.y; QueryPerformanceCounter(&m_DDPPointerInfo.LastTimeStamp); } m_CursorInfoLast = cursor_info; } return ret; } PTR_INFO& SoftwareCursorGrabber::GetDDPCursorInfo() { return m_DDPPointerInfo; } ================================================ FILE: src/DesktopPlus/SoftwareCursorGrabber.h ================================================ #pragma once #include #include "CommonTypes.h" //Alternative method to grab the cursor image data //Stores the data in the same way the DuplicationManager class does for Desktop Duplication cursor output to act as a drop-in alternative class SoftwareCursorGrabber { private: CURSORINFO m_CursorInfoLast = {}; PTR_INFO m_DDPPointerInfo = {}; std::unordered_map m_CursorUseMaskCache; //Log things only once per session as it would be quite spammy otherwise bool m_LoggedOnceUsed = false; bool m_LoggedOnceFallbackDefault = false; bool m_LoggedOnceFallbackBlob = false; bool CopyMonoMask(const ICONINFO& icon_info); bool CopyColor(const ICONINFO& icon_info); static bool IsShapeBufferBlank(BYTE* psrc, size_t size, UINT type); public: bool SynthesizeDDPCursorInfo(); PTR_INFO& GetDDPCursorInfo(); }; ================================================ FILE: src/DesktopPlus/ThreadManager.cpp ================================================ #include "ThreadManager.h" DWORD WINAPI CaptureThreadEntry(_In_ void* Param); THREADMANAGER::THREADMANAGER() : m_ThreadCount(0), m_ThreadHandles(nullptr), m_ThreadData(nullptr) { } THREADMANAGER::~THREADMANAGER() { Clean(); } // // Clean up resources // void THREADMANAGER::Clean() { m_PtrInfo = PTR_INFO(); if (m_ThreadHandles) { for (UINT i = 0; i < m_ThreadCount; ++i) { if (m_ThreadHandles[i]) { CloseHandle(m_ThreadHandles[i]); } } delete [] m_ThreadHandles; m_ThreadHandles = nullptr; } if (m_ThreadData) { for (UINT i = 0; i < m_ThreadCount; ++i) { CleanDx(&m_ThreadData[i].DxRes); } delete [] m_ThreadData; m_ThreadData = nullptr; } m_ThreadCount = 0; } // // Clean up DX_RESOURCES // void THREADMANAGER::CleanDx(_Inout_ DX_RESOURCES* Data) { if (Data->Device) { Data->Device->Release(); Data->Device = nullptr; } if (Data->Context) { Data->Context->Release(); Data->Context = nullptr; } if (Data->VertexShader) { Data->VertexShader->Release(); Data->VertexShader = nullptr; } if (Data->PixelShader) { Data->PixelShader->Release(); Data->PixelShader = nullptr; } if (Data->InputLayout) { Data->InputLayout->Release(); Data->InputLayout = nullptr; } if (Data->Sampler) { Data->Sampler->Release(); Data->Sampler = nullptr; } } // // Start up threads for DDA // DUPL_RETURN THREADMANAGER::Initialize(INT SingleOutput, UINT OutputCount, HANDLE UnexpectedErrorEvent, HANDLE ExpectedErrorEvent, HANDLE NewFrameProcessedEvent, HANDLE PauseDuplicationEvent, HANDLE ResumeDuplicationEvent, HANDLE TerminateThreadsEvent, HANDLE SharedHandle, _In_ RECT* DesktopDim, IDXGIAdapter* DXGIAdapter, bool WMRIgnoreVScreens) { m_ThreadCount = OutputCount; m_ThreadHandles = new (std::nothrow) HANDLE[m_ThreadCount]; m_ThreadData = new (std::nothrow) THREAD_DATA[m_ThreadCount]; if (!m_ThreadHandles || !m_ThreadData) { return ProcessFailure(nullptr, L"Failed to allocate array for threads", L"Desktop+ Error", E_OUTOFMEMORY); } // Create appropriate # of threads for duplication DUPL_RETURN Ret = DUPL_RETURN_SUCCESS; for (UINT i = 0; i < m_ThreadCount; ++i) { m_ThreadData[i].UnexpectedErrorEvent = UnexpectedErrorEvent; m_ThreadData[i].ExpectedErrorEvent = ExpectedErrorEvent; m_ThreadData[i].NewFrameProcessedEvent = NewFrameProcessedEvent; m_ThreadData[i].PauseDuplicationEvent = PauseDuplicationEvent; m_ThreadData[i].ResumeDuplicationEvent = ResumeDuplicationEvent; m_ThreadData[i].TerminateThreadsEvent = TerminateThreadsEvent; m_ThreadData[i].Output = (SingleOutput < 0) ? i : SingleOutput; m_ThreadData[i].TexSharedHandle = SharedHandle; m_ThreadData[i].OffsetX = DesktopDim->left; m_ThreadData[i].OffsetY = DesktopDim->top; m_ThreadData[i].PtrInfo = &m_PtrInfo; m_ThreadData[i].DirtyRegionTotal = &m_DirtyRegionTotal; m_ThreadData[i].WMRIgnoreVScreens = WMRIgnoreVScreens; RtlZeroMemory(&m_ThreadData[i].DxRes, sizeof(DX_RESOURCES)); Ret = InitializeDx(&m_ThreadData[i].DxRes, DXGIAdapter); if (Ret != DUPL_RETURN_SUCCESS) { if (DXGIAdapter != nullptr) DXGIAdapter->Release(); return Ret; } DWORD ThreadId; m_ThreadHandles[i] = CreateThread(nullptr, 0, CaptureThreadEntry, &m_ThreadData[i], 0, &ThreadId); if (m_ThreadHandles[i] == nullptr) { if (DXGIAdapter != nullptr) DXGIAdapter->Release(); return ProcessFailure(nullptr, L"Failed to create thread", L"Desktop+ Error", E_FAIL); } } if (DXGIAdapter != nullptr) DXGIAdapter->Release(); return Ret; } // // Get DX_RESOURCES // DUPL_RETURN THREADMANAGER::InitializeDx(_Out_ DX_RESOURCES* Data, IDXGIAdapter* DXGIAdapter) { HRESULT hr = S_OK; // Driver types supported D3D_DRIVER_TYPE DriverTypes[] = { D3D_DRIVER_TYPE_HARDWARE, D3D_DRIVER_TYPE_WARP, D3D_DRIVER_TYPE_REFERENCE, }; UINT NumDriverTypes = ARRAYSIZE(DriverTypes); // Feature levels supported D3D_FEATURE_LEVEL FeatureLevels[] = { D3D_FEATURE_LEVEL_11_0, D3D_FEATURE_LEVEL_10_1, D3D_FEATURE_LEVEL_10_0, D3D_FEATURE_LEVEL_9_1 }; UINT NumFeatureLevels = ARRAYSIZE(FeatureLevels); D3D_FEATURE_LEVEL FeatureLevel; // Create device hr = D3D11CreateDevice(DXGIAdapter, D3D_DRIVER_TYPE_UNKNOWN, nullptr, 0, FeatureLevels, NumFeatureLevels, D3D11_SDK_VERSION, &Data->Device, &FeatureLevel, &Data->Context); if (FAILED(hr)) { return ProcessFailure(nullptr, L"Failed to create device for thread", L"Desktop+ Error", hr); } // VERTEX shader UINT Size = ARRAYSIZE(g_VS); hr = Data->Device->CreateVertexShader(g_VS, Size, nullptr, &Data->VertexShader); if (FAILED(hr)) { return ProcessFailure(Data->Device, L"Failed to create vertex shader for thread", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } // Input layout D3D11_INPUT_ELEMENT_DESC Layout[] = { {"POSITION", 0, DXGI_FORMAT_R32G32B32_FLOAT, 0, 0, D3D11_INPUT_PER_VERTEX_DATA, 0}, {"TEXCOORD", 0, DXGI_FORMAT_R32G32_FLOAT, 0, 12, D3D11_INPUT_PER_VERTEX_DATA, 0} }; UINT NumElements = ARRAYSIZE(Layout); hr = Data->Device->CreateInputLayout(Layout, NumElements, g_VS, Size, &Data->InputLayout); if (FAILED(hr)) { return ProcessFailure(Data->Device, L"Failed to create input layout for thread", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } Data->Context->IASetInputLayout(Data->InputLayout); // Pixel shader Size = ARRAYSIZE(g_PS); hr = Data->Device->CreatePixelShader(g_PS, Size, nullptr, &Data->PixelShader); if (FAILED(hr)) { return ProcessFailure(Data->Device, L"Failed to create pixel shader for thread", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } // Set up sampler D3D11_SAMPLER_DESC SampDesc; RtlZeroMemory(&SampDesc, sizeof(SampDesc)); SampDesc.Filter = D3D11_FILTER_MIN_MAG_MIP_POINT; SampDesc.AddressU = D3D11_TEXTURE_ADDRESS_CLAMP; SampDesc.AddressV = D3D11_TEXTURE_ADDRESS_CLAMP; SampDesc.AddressW = D3D11_TEXTURE_ADDRESS_CLAMP; SampDesc.ComparisonFunc = D3D11_COMPARISON_NEVER; SampDesc.MinLOD = 0; SampDesc.MaxLOD = D3D11_FLOAT32_MAX; hr = Data->Device->CreateSamplerState(&SampDesc, &Data->Sampler); if (FAILED(hr)) { return ProcessFailure(Data->Device, L"Failed to create sampler state for thread", L"Desktop+ Error", hr, SystemTransitionsExpectedErrors); } return DUPL_RETURN_SUCCESS; } // // Getter for the PTR_INFO structure // PTR_INFO* THREADMANAGER::GetPointerInfo() { return &m_PtrInfo; } DPRect& THREADMANAGER::GetDirtyRegionTotal() { return m_DirtyRegionTotal; } // // Waits infinitely for all spawned threads to terminate // void THREADMANAGER::WaitForThreadTermination() { if (m_ThreadCount != 0) { WaitForMultipleObjectsEx(m_ThreadCount, m_ThreadHandles, TRUE, INFINITE, FALSE); } } ================================================ FILE: src/DesktopPlus/ThreadManager.h ================================================ #ifndef _THREADMANAGER_H_ #define _THREADMANAGER_H_ #include "CommonTypes.h" class THREADMANAGER { public: THREADMANAGER(); ~THREADMANAGER(); void Clean(); DUPL_RETURN Initialize(INT SingleOutput, UINT OutputCount, HANDLE UnexpectedErrorEvent, HANDLE ExpectedErrorEvent, HANDLE NewFrameProcessedEvent, HANDLE PauseDuplicationEvent, HANDLE ResumeDuplicationEvent, HANDLE TerminateThreadsEvent, HANDLE SharedHandle, _In_ RECT* DesktopDim, IDXGIAdapter* DXGIAdapter, bool WMRIgnoreVScreens); PTR_INFO* GetPointerInfo(); //Should only be called when shared surface mutex has be aquired DPRect& GetDirtyRegionTotal(); //Should only be called when shared surface mutex has be aquired void WaitForThreadTermination(); private: DUPL_RETURN InitializeDx(_Out_ DX_RESOURCES* Data, IDXGIAdapter* DXGIAdapter); //Doesn't Release() the DXGIAdapter void CleanDx(_Inout_ DX_RESOURCES* Data); PTR_INFO m_PtrInfo; DPRect m_DirtyRegionTotal; UINT m_ThreadCount; _Field_size_(m_ThreadCount) HANDLE* m_ThreadHandles; _Field_size_(m_ThreadCount) THREAD_DATA* m_ThreadData; }; #endif ================================================ FILE: src/DesktopPlus/VRInput.cpp ================================================ #include "VRInput.h" #include "VRInput.h" #define NOMINMAX #include #include #include #include "ConfigManager.h" #include "OutputManager.h" #include "OpenVRExt.h" VRInput::VRInput() : m_HandleActionsetShortcuts(vr::k_ulInvalidActionSetHandle), m_HandleActionsetLaserPointer(vr::k_ulInvalidActionSetHandle), m_HandleActionsetScrollDiscrete(vr::k_ulInvalidActionSetHandle), m_HandleActionsetScrollSmooth(vr::k_ulInvalidActionSetHandle), m_HandleActionEnableGlobalLaserPointer(vr::k_ulInvalidActionHandle), m_HandleActionLaserPointerLeftClick(vr::k_ulInvalidActionHandle), m_HandleActionLaserPointerRightClick(vr::k_ulInvalidActionHandle), m_HandleActionLaserPointerMiddleClick(vr::k_ulInvalidActionHandle), m_HandleActionLaserPointerAux01Click(vr::k_ulInvalidActionHandle), m_HandleActionLaserPointerAux02Click(vr::k_ulInvalidActionHandle), m_HandleActionLaserPointerScrollDiscrete(vr::k_ulInvalidActionHandle), m_HandleActionLaserPointerScrollSmooth(vr::k_ulInvalidActionHandle), m_HandleActionLaserPointerHaptic(vr::k_ulInvalidActionHandle), m_IsAnyGlobalActionBound(false), m_IsAnyGlobalActionBoundStateValid(false), m_IsLaserPointerInputActive(false), m_LaserPointerScrollMode(vrinput_scroll_none), m_KeyboardDeviceInputValueHandle(vr::k_ulInvalidInputValueHandle), m_GamepadDeviceInputValueHandle(vr::k_ulInvalidInputValueHandle), m_KeyboardDeviceToggleState{0}, m_KeyboardDeviceIsToggleKeyDown(false), m_KeyboardDeviceClickState{0}, m_KeyboardDeviceDragState{0} { } void VRInput::UpdateKeyboardDeviceState() { auto update_input_data = [](vr::InputDigitalActionData_t& input_data, int keycode) { if (keycode != 0) { if ((ConfigManager::GetValue(configid_bool_input_laser_pointer_hmd_device)) && (!vr::IVROverlayEx::IsSystemLaserPointerActive())) { input_data.bActive = true; input_data.bChanged = false; if (::GetAsyncKeyState(keycode) < 0) { if (!input_data.bState) { input_data.bChanged = true; input_data.bState = true; } } else if (input_data.bState) { input_data.bChanged = true; input_data.bState = false; } } else { //Drop inputs if settings disabled or system laser pointer is active input_data.bActive = input_data.bState; //true for one frame before we set it inactive input_data.bChanged = input_data.bState; input_data.bState = false; } } else { input_data.bActive = false; input_data.bChanged = false; input_data.bState = false; } }; auto update_input_data_toggle = [](vr::InputDigitalActionData_t& input_data, int keycode, bool& is_key_down) { if (keycode != 0) { if ((ConfigManager::GetValue(configid_bool_input_laser_pointer_hmd_device)) && (!vr::IVROverlayEx::IsSystemLaserPointerActive())) { input_data.bActive = true; input_data.bChanged = false; if (::GetAsyncKeyState(keycode) < 0) { if (!is_key_down) { input_data.bChanged = true; input_data.bState = !input_data.bState; } is_key_down = true; } else { is_key_down = false; } } else { //Drop inputs if settings disabled or system laser pointer is active (Desktop+ pointer won't be doing anything either way, but the toggle key should reset at least) input_data.bActive = input_data.bState; //true for one frame before we set it inactive input_data.bChanged = input_data.bState; input_data.bState = false; } } else { input_data.bActive = false; input_data.bChanged = false; input_data.bState = false; } }; //Toggle action state is always set up as a toggle binding update_input_data_toggle(m_KeyboardDeviceToggleState, ConfigManager::GetValue(configid_int_input_laser_pointer_hmd_device_keycode_toggle), m_KeyboardDeviceIsToggleKeyDown); update_input_data(m_KeyboardDeviceClickState[0], ConfigManager::GetValue(configid_int_input_laser_pointer_hmd_device_keycode_left)); update_input_data(m_KeyboardDeviceClickState[1], ConfigManager::GetValue(configid_int_input_laser_pointer_hmd_device_keycode_right)); update_input_data(m_KeyboardDeviceClickState[2], ConfigManager::GetValue(configid_int_input_laser_pointer_hmd_device_keycode_middle)); //Aux01/02 are not configurable but fields exist for parity with the regular action data array (they can still be pressed via actions if really needed) update_input_data(m_KeyboardDeviceDragState, ConfigManager::GetValue(configid_int_input_laser_pointer_hmd_device_keycode_drag)); } vr::InputDigitalActionData_t VRInput::CombineDigitalActionData(vr::InputDigitalActionData_t data_a, vr::InputDigitalActionData_t data_b) { //Trying to make sense of having multiple action data sources at once, with some bias towards data_a vr::InputDigitalActionData_t data_out = {0}; data_out.bActive = data_a.bActive || data_b.bActive; data_out.bChanged = data_a.bChanged || data_b.bChanged; data_out.bState = data_a.bState || data_b.bState; data_out.activeOrigin = (data_a.bState == data_out.bState) ? data_a.activeOrigin : ((data_b.bState == data_out.bState) ? data_b.activeOrigin : data_a.activeOrigin); return data_out; } bool VRInput::Init() { //Load manifest, this will fail with VRInputError_MismatchedActionManifest when a Steam configured manifest is already associated with the app key, but we can just ignore that vr::EVRInputError input_error = vr::VRInput()->SetActionManifestPath( (ConfigManager::Get().GetApplicationPath() + "action_manifest.json").c_str() ); if ( (input_error == vr::VRInputError_None) || (input_error == vr::VRInputError_MismatchedActionManifest) ) { input_error = vr::VRInput()->GetActionSetHandle("/actions/shortcuts", &m_HandleActionsetShortcuts); if (input_error != vr::VRInputError_None) return false; //Load actions (we assume that the files are not messed with and skip some error checking) vr::VRInput()->GetActionHandle("/actions/shortcuts/in/EnableGlobalLaserPointer", &m_HandleActionEnableGlobalLaserPointer); //Load as many global shortcut input actions as we can find. Up to configid_int_input_global_shortcuts_max_count at least. //This allows for extended amounts via end-user modification, though the Steam manifest takes priority if present m_HandleActionDoGlobalShortcuts.clear(); const int shortcut_max = ConfigManager::GetValue(configid_int_input_global_shortcuts_max_count); for (int i = 0; i < shortcut_max; ++i) { vr::VRActionHandle_t handle_global_shortcut = vr::k_ulInvalidActionHandle; std::stringstream ss; ss << "/actions/shortcuts/in/GlobalShortcut" << std::setfill('0') << std::setw(2) << i + 1; vr::VRInput()->GetActionHandle(ss.str().c_str(), &handle_global_shortcut); //We do check if we got a handle here, but as of writing this, GetActionHandle() will always return a valid handle, regardless of presence in the manifest. if (handle_global_shortcut != vr::k_ulInvalidActionHandle) { m_HandleActionDoGlobalShortcuts.push_back(handle_global_shortcut); } else { break; } } vr::VRInput()->GetActionSetHandle("/actions/laserpointer", &m_HandleActionsetLaserPointer); vr::VRInput()->GetActionHandle("/actions/laserpointer/in/LeftClick", &m_HandleActionLaserPointerLeftClick); vr::VRInput()->GetActionHandle("/actions/laserpointer/in/RightClick" , &m_HandleActionLaserPointerRightClick); vr::VRInput()->GetActionHandle("/actions/laserpointer/in/MiddleClick", &m_HandleActionLaserPointerMiddleClick); vr::VRInput()->GetActionHandle("/actions/laserpointer/in/Aux01Click", &m_HandleActionLaserPointerAux01Click); vr::VRInput()->GetActionHandle("/actions/laserpointer/in/Aux02Click", &m_HandleActionLaserPointerAux02Click); vr::VRInput()->GetActionHandle("/actions/laserpointer/in/Drag", &m_HandleActionLaserPointerDrag); vr::VRInput()->GetActionHandle("/actions/laserpointer/out/Haptic", &m_HandleActionLaserPointerHaptic); vr::VRInput()->GetActionSetHandle("/actions/scroll_discrete", &m_HandleActionsetScrollDiscrete); vr::VRInput()->GetActionHandle("/actions/scroll_discrete/in/ScrollDiscrete", &m_HandleActionLaserPointerScrollDiscrete); vr::VRInput()->GetActionSetHandle("/actions/scroll_smooth", &m_HandleActionsetScrollSmooth); vr::VRInput()->GetActionHandle("/actions/scroll_smooth/in/ScrollSmooth", &m_HandleActionLaserPointerScrollSmooth); //This mimics OpenXR device path pattern but isn't actually formally defined (and this is OpenVR anyhow) vr::VRInput()->GetInputSourceHandle("/user/keyboard", &m_KeyboardDeviceInputValueHandle); //Frequently used gamepad device path vr::VRInput()->GetInputSourceHandle("/user/gamepad", &m_GamepadDeviceInputValueHandle); m_KeyboardDeviceToggleState.activeOrigin = m_KeyboardDeviceInputValueHandle; for (auto& input_data : m_KeyboardDeviceClickState) { input_data.activeOrigin = m_KeyboardDeviceInputValueHandle; } m_KeyboardDeviceDragState.activeOrigin = m_KeyboardDeviceInputValueHandle; return true; } return false; } void VRInput::Update() { if (m_HandleActionsetShortcuts == vr::k_ulInvalidActionSetHandle) return; vr::VRActiveActionSet_t actionset_desc[3] = { 0 }; int actionset_active_count = 1; actionset_desc[0].ulActionSet = m_HandleActionsetShortcuts; actionset_desc[0].nPriority = 100; //Arbitrary number, but probably higher than the scene application's... if that even matters if (m_IsLaserPointerInputActive) { actionset_active_count = 2; actionset_desc[1].ulActionSet = m_HandleActionsetLaserPointer; //+2 when blocking since OVRAS uses vr::k_nActionSetOverlayGlobalPriorityMin + 1 as priority for global input //When not blocking laser pointer inputs should have priority over global shortcuts actionset_desc[1].nPriority = ConfigManager::GetValue(configid_bool_input_laser_pointer_block_input) ? vr::k_nActionSetOverlayGlobalPriorityMin + 2 : 101; if (m_LaserPointerScrollMode != vrinput_scroll_none) { actionset_active_count = 3; actionset_desc[2].ulActionSet = (m_LaserPointerScrollMode == vrinput_scroll_discrete) ? m_HandleActionsetScrollDiscrete : m_HandleActionsetScrollSmooth; actionset_desc[2].nPriority = actionset_desc[1].nPriority; } } vr::VRInput()->UpdateActionState(actionset_desc, sizeof(vr::VRActiveActionSet_t), actionset_active_count); UpdateKeyboardDeviceState(); //SteamVR Input is incredibly weird with the initial action state. The first couple attempts at getting any action state will fail. Probably some async loading stuff //However, SteamVR also does not send any events once the initial state goes valid (it does for binding state changes after this) //As we don't want to needlessly refresh the any-action-bound state on every update, we poll it until it succeeds once and then rely on events afterwards if (!m_IsAnyGlobalActionBoundStateValid) { RefreshAnyGlobalActionBound(); } } void VRInput::RefreshAnyGlobalActionBound() { auto is_action_bound = [&](vr::VRActionHandle_t action_handle) { vr::VRInputValueHandle_t action_origin = vr::k_ulInvalidInputValueHandle; vr::EVRInputError error = vr::VRInput()->GetActionOrigins(m_HandleActionsetShortcuts, action_handle, &action_origin, 1); if (action_origin != vr::k_ulInvalidInputValueHandle) { m_IsAnyGlobalActionBoundStateValid = true; vr::InputOriginInfo_t action_origin_info = {0}; vr::EVRInputError error = vr::VRInput()->GetOriginTrackedDeviceInfo(action_origin, &action_origin_info, sizeof(vr::InputOriginInfo_t)); if ( (error == vr::VRInputError_None) && (vr::VRSystem()->IsTrackedDeviceConnected(action_origin_info.trackedDeviceIndex)) ) { return true; } } return false; }; //Doesn't trigger on app start since its actions are not valid yet m_IsAnyGlobalActionBound = false; if (is_action_bound(m_HandleActionEnableGlobalLaserPointer)) { m_IsAnyGlobalActionBound = true; return; } for (auto handle : m_HandleActionDoGlobalShortcuts) { if (is_action_bound(handle)) { m_IsAnyGlobalActionBound = true; return; } } } void VRInput::HandleGlobalActionShortcuts(OutputManager& outmgr) { const ActionManager::ActionList& shortcut_actions = ConfigManager::Get().GetGlobalShortcuts(); vr::InputDigitalActionData_t data; size_t shortcut_id = 0; for (const auto shortcut_handle : m_HandleActionDoGlobalShortcuts) { vr::EVRInputError input_error = vr::VRInput()->GetDigitalActionData(shortcut_handle, &data, sizeof(data), vr::k_ulInvalidInputValueHandle); if ((shortcut_id < shortcut_actions.size()) && (input_error == vr::VRInputError_None) && (data.bChanged)) { if (data.bState) { ConfigManager::Get().GetActionManager().StartAction(shortcut_actions[shortcut_id]); } else { ConfigManager::Get().GetActionManager().StopAction(shortcut_actions[shortcut_id]); } } ++shortcut_id; } } void VRInput::TriggerLaserPointerHaptics(vr::VRInputValueHandle_t restrict_to_device) const { if (restrict_to_device == m_KeyboardDeviceInputValueHandle) return; //There have been problems with rumble getting stuck indefinitely when calling TriggerHapticVibrationAction() on a gamepad device (even though haptics aren't even bound) //Unsure if this an isolated issue, we're just avoid calling this function on gamepads altogether... this could be a one-liner otherwise if (restrict_to_device == vr::k_ulInvalidInputValueHandle) { //All devices, but we're going to exclude the gamepad one and trigger manually for the rest //Asking for haptic action origin doesn't seem to work, but GetLaserPointerDevicesInfo() gets every device with left click bound, which is good enough //This function is usually not called with this value either way std::vector lp_devices_info = GetLaserPointerDevicesInfo(); for (vr::InputOriginInfo_t device_info : lp_devices_info) { if (device_info.devicePath != m_GamepadDeviceInputValueHandle) { vr::VRInput()->TriggerHapticVibrationAction(m_HandleActionLaserPointerHaptic, 0.0f, 0.0f, 1.0f, 0.16f, device_info.devicePath); } } } else { //Don't trigger the vibration if this was called for the gamepad vr::InputOriginInfo_t device_info = GetOriginTrackedDeviceInfoEx(restrict_to_device); if (device_info.devicePath != m_GamepadDeviceInputValueHandle) { vr::VRInput()->TriggerHapticVibrationAction(m_HandleActionLaserPointerHaptic, 0.0f, 0.0f, 1.0f, 0.16f, restrict_to_device); } } } vr::InputOriginInfo_t VRInput::GetOriginTrackedDeviceInfoEx(vr::VRInputValueHandle_t origin) const { vr::InputOriginInfo_t origin_info = {0}; origin_info.trackedDeviceIndex = vr::k_unTrackedDeviceIndexInvalid; if (origin == m_KeyboardDeviceInputValueHandle) { origin_info.trackedDeviceIndex = vr::k_unTrackedDeviceIndex_Hmd; origin_info.devicePath = origin; } else { vr::VRInput()->GetOriginTrackedDeviceInfo(origin, &origin_info, sizeof(vr::InputOriginInfo_t)); } return origin_info; } vr::InputDigitalActionData_t VRInput::GetEnableGlobalLaserPointerState() const { vr::InputDigitalActionData_t data; vr::VRInput()->GetDigitalActionData(m_HandleActionEnableGlobalLaserPointer, &data, sizeof(data), vr::k_ulInvalidInputValueHandle); if (ConfigManager::GetValue(configid_bool_input_laser_pointer_hmd_device)) { data = CombineDigitalActionData(data, m_KeyboardDeviceToggleState); } return data; } std::vector VRInput::GetLaserPointerDevicesInfo() const { std::vector devices_info; vr::VRInputValueHandle_t input_value_handles[vr::k_unMaxTrackedDeviceCount]; vr::EVRInputError err = vr::VRInput()->GetActionOrigins(m_HandleActionsetLaserPointer, m_HandleActionLaserPointerLeftClick, input_value_handles, vr::k_unMaxTrackedDeviceCount); vr::InputOriginInfo_t origin_info = {0}; for (auto input_value_handle : input_value_handles) { if ( (input_value_handle != vr::k_ulInvalidInputValueHandle) && (vr::VRInput()->GetOriginTrackedDeviceInfo(input_value_handle, &origin_info, sizeof(vr::InputOriginInfo_t)) == vr::VRInputError_None) ) { devices_info.push_back(origin_info); } } //If GetActionOrigins() did not return anything useful, try at least getting origins for left and right hand controllers if (devices_info.empty()) { for (int controller_role = vr::TrackedControllerRole_LeftHand; controller_role <= vr::TrackedControllerRole_RightHand; ++controller_role) { origin_info = {0}; origin_info.trackedDeviceIndex = vr::VRSystem()->GetTrackedDeviceIndexForControllerRole((vr::ETrackedControllerRole)controller_role); if (origin_info.trackedDeviceIndex != vr::k_unTrackedDeviceIndexInvalid) { vr::VRInputValueHandle_t input_value = vr::k_ulInvalidInputValueHandle; vr::VRInput()->GetInputSourceHandle((controller_role == vr::TrackedControllerRole_LeftHand) ? "/user/hand/left" : "/user/hand/right", &origin_info.devicePath); devices_info.push_back(origin_info); } } } if (ConfigManager::GetValue(configid_bool_input_laser_pointer_hmd_device)) { vr::InputOriginInfo_t origin_info = {0}; origin_info.trackedDeviceIndex = vr::k_unTrackedDeviceIndex_Hmd; //Simulated Keyboard device is used for HMD interaction only so we use that origin_info.devicePath = m_KeyboardDeviceInputValueHandle; devices_info.push_back(origin_info); } return devices_info; } vr::InputDigitalActionData_t VRInput::GetLaserPointerLeftClickState(vr::VRInputValueHandle_t restrict_to_device) const { vr::InputDigitalActionData_t data = {0}; vr::VRInput()->GetDigitalActionData(m_HandleActionLaserPointerLeftClick, &data, sizeof(data), restrict_to_device); if (ConfigManager::GetValue(configid_bool_input_laser_pointer_hmd_device)) { if ((restrict_to_device == vr::k_ulInvalidInputValueHandle) || (restrict_to_device == m_KeyboardDeviceInputValueHandle)) { data = CombineDigitalActionData(data, m_KeyboardDeviceClickState[0]); } } return data; } std::array VRInput::GetLaserPointerClickState(vr::VRInputValueHandle_t restrict_to_device) const { std::array data = {0}; vr::VRInput()->GetDigitalActionData(m_HandleActionLaserPointerLeftClick, &data[0], sizeof(vr::InputDigitalActionData_t), restrict_to_device); vr::VRInput()->GetDigitalActionData(m_HandleActionLaserPointerRightClick, &data[1], sizeof(vr::InputDigitalActionData_t), restrict_to_device); vr::VRInput()->GetDigitalActionData(m_HandleActionLaserPointerMiddleClick, &data[2], sizeof(vr::InputDigitalActionData_t), restrict_to_device); vr::VRInput()->GetDigitalActionData(m_HandleActionLaserPointerAux01Click, &data[3], sizeof(vr::InputDigitalActionData_t), restrict_to_device); vr::VRInput()->GetDigitalActionData(m_HandleActionLaserPointerAux02Click, &data[4], sizeof(vr::InputDigitalActionData_t), restrict_to_device); if (ConfigManager::GetValue(configid_bool_input_laser_pointer_hmd_device)) { if ((restrict_to_device == vr::k_ulInvalidInputValueHandle) || (restrict_to_device == m_KeyboardDeviceInputValueHandle)) { for (int i = 0; i < data.size(); ++i) { data[i] = CombineDigitalActionData(data[i], m_KeyboardDeviceClickState[i]); } } } return data; } vr::InputAnalogActionData_t VRInput::GetLaserPointerScrollDiscreteState() const { vr::InputAnalogActionData_t data = {0}; vr::VRInput()->GetAnalogActionData(m_HandleActionLaserPointerScrollDiscrete, &data, sizeof(vr::InputAnalogActionData_t), vr::k_ulInvalidInputValueHandle); return data; } vr::InputAnalogActionData_t VRInput::GetLaserPointerScrollSmoothState() const { vr::InputAnalogActionData_t data = {0}; vr::VRInput()->GetAnalogActionData(m_HandleActionLaserPointerScrollSmooth, &data, sizeof(vr::InputAnalogActionData_t), vr::k_ulInvalidInputValueHandle); return data; } vr::InputDigitalActionData_t VRInput::GetLaserPointerDragState(vr::VRInputValueHandle_t restrict_to_device) const { vr::InputDigitalActionData_t data = {0}; vr::VRInput()->GetDigitalActionData(m_HandleActionLaserPointerDrag, &data, sizeof(data), restrict_to_device); if (ConfigManager::GetValue(configid_bool_input_laser_pointer_hmd_device)) { if ((restrict_to_device == vr::k_ulInvalidInputValueHandle) || (restrict_to_device == m_KeyboardDeviceInputValueHandle)) { data = CombineDigitalActionData(data, m_KeyboardDeviceDragState); } } return data; } void VRInput::SetLaserPointerActive(bool is_active) { m_IsLaserPointerInputActive = is_active; } void VRInput::SetLaserPointerScrollMode(VRInputScrollMode scroll_mode) { m_LaserPointerScrollMode = scroll_mode; } VRInputScrollMode VRInput::GetLaserPointerScrollMode() const { return m_LaserPointerScrollMode; } bool VRInput::IsAnyGlobalActionBound() const { return m_IsAnyGlobalActionBound; } vr::VRInputValueHandle_t VRInput::GetKeyboardDeviceInputValueHandle() const { return m_KeyboardDeviceInputValueHandle; } ================================================ FILE: src/DesktopPlus/VRInput.h ================================================ #ifndef _VRINPUT_H_ #define _VRINPUT_H_ #include "openvr.h" #include #include class OutputManager; //Additional VRMouseButton values to get full state auxiliary click events //Normal implementations shouldn't have issues with these, but they're only sent to Desktop+ overlays anyways #define VRMouseButton_DP_Aux01 0x0008 #define VRMouseButton_DP_Aux02 0x0010 enum VRInputScrollMode { vrinput_scroll_none, vrinput_scroll_discrete, vrinput_scroll_smooth, }; //Can't be used with open dashboard, but handles global shortcuts and Desktop+ laser pointer input instead. class VRInput { private: vr::VRActionSetHandle_t m_HandleActionsetShortcuts; vr::VRActionSetHandle_t m_HandleActionsetLaserPointer; vr::VRActionSetHandle_t m_HandleActionsetScrollDiscrete; vr::VRActionSetHandle_t m_HandleActionsetScrollSmooth; vr::VRActionHandle_t m_HandleActionEnableGlobalLaserPointer; std::vector m_HandleActionDoGlobalShortcuts; vr::VRActionHandle_t m_HandleActionLaserPointerLeftClick; vr::VRActionHandle_t m_HandleActionLaserPointerRightClick; vr::VRActionHandle_t m_HandleActionLaserPointerMiddleClick; vr::VRActionHandle_t m_HandleActionLaserPointerAux01Click; vr::VRActionHandle_t m_HandleActionLaserPointerAux02Click; vr::VRActionHandle_t m_HandleActionLaserPointerDrag; vr::VRActionHandle_t m_HandleActionLaserPointerScrollDiscrete; vr::VRActionHandle_t m_HandleActionLaserPointerScrollSmooth; vr::VRActionHandle_t m_HandleActionLaserPointerHaptic; bool m_IsAnyGlobalActionBound; //"Bound" meaning assigned and the device is actually active bool m_IsAnyGlobalActionBoundStateValid; bool m_IsLaserPointerInputActive; VRInputScrollMode m_LaserPointerScrollMode; vr::VRInputValueHandle_t m_KeyboardDeviceInputValueHandle; vr::VRInputValueHandle_t m_GamepadDeviceInputValueHandle; vr::InputDigitalActionData_t m_KeyboardDeviceToggleState; bool m_KeyboardDeviceIsToggleKeyDown; std::array m_KeyboardDeviceClickState; vr::InputDigitalActionData_t m_KeyboardDeviceDragState; void UpdateKeyboardDeviceState(); static vr::InputDigitalActionData_t CombineDigitalActionData(vr::InputDigitalActionData_t data_a, vr::InputDigitalActionData_t data_b); public: VRInput(); bool Init(); void Update(); void RefreshAnyGlobalActionBound(); void HandleGlobalActionShortcuts(OutputManager& outmgr); void TriggerLaserPointerHaptics(vr::VRInputValueHandle_t restrict_to_device = vr::k_ulInvalidInputValueHandle) const; vr::InputOriginInfo_t GetOriginTrackedDeviceInfoEx(vr::VRInputValueHandle_t origin) const; //Wraps GetOriginTrackedDeviceInfo() with keyboard device support vr::InputDigitalActionData_t GetEnableGlobalLaserPointerState() const; std::vector GetLaserPointerDevicesInfo() const; vr::InputDigitalActionData_t GetLaserPointerLeftClickState(vr::VRInputValueHandle_t restrict_to_device = vr::k_ulInvalidInputValueHandle) const; std::array GetLaserPointerClickState(vr::VRInputValueHandle_t restrict_to_device = vr::k_ulInvalidInputValueHandle) const; vr::InputAnalogActionData_t GetLaserPointerScrollDiscreteState() const; vr::InputAnalogActionData_t GetLaserPointerScrollSmoothState() const; vr::InputDigitalActionData_t GetLaserPointerDragState(vr::VRInputValueHandle_t restrict_to_device = vr::k_ulInvalidInputValueHandle) const; void SetLaserPointerActive(bool is_active); void SetLaserPointerScrollMode(VRInputScrollMode scroll_mode); VRInputScrollMode GetLaserPointerScrollMode() const; bool IsAnyGlobalActionBound() const; vr::VRInputValueHandle_t GetKeyboardDeviceInputValueHandle() const; }; #endif ================================================ FILE: src/DesktopPlus/VertexShader.hlsl ================================================ struct VS_INPUT { float4 Pos : POSITION; float2 Tex : TEXCOORD; }; struct VS_OUTPUT { float4 Pos : SV_POSITION; float2 Tex : TEXCOORD; }; //-------------------------------------------------------------------------------------- // Vertex Shader //-------------------------------------------------------------------------------------- VS_OUTPUT VS(VS_INPUT input) { return input; } ================================================ FILE: src/DesktopPlus/resource.h ================================================ //{{NO_DEPENDENCIES}} // Microsoft Visual C++ generated include file. // Used by DesktopPlus.rc // #define IDI_ICON1 101 #define IDI_DPLUS 101 // Next default values for new objects // #ifdef APSTUDIO_INVOKED #ifndef APSTUDIO_READONLY_SYMBOLS #define _APS_NEXT_RESOURCE_VALUE 102 #define _APS_NEXT_COMMAND_VALUE 40001 #define _APS_NEXT_CONTROL_VALUE 1001 #define _APS_NEXT_SYMED_VALUE 101 #endif #endif ================================================ FILE: src/DesktopPlus.sln ================================================  Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio Version 16 VisualStudioVersion = 16.0.29519.87 MinimumVisualStudioVersion = 10.0.40219.1 Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "DesktopPlus", "DesktopPlus\DesktopPlus.vcxproj", "{05050918-71E9-AF87-0B3C-6F34D471A55A}" ProjectSection(ProjectDependencies) = postProject {045FFB0E-D0D4-404D-8C33-13C7074B3236} = {045FFB0E-D0D4-404D-8C33-13C7074B3236} EndProjectSection EndProject Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "DesktopPlusUI", "DesktopPlusUI\DesktopPlusUI.vcxproj", "{14405CEC-DF3D-435E-8F11-B79BAC56D7D8}" ProjectSection(ProjectDependencies) = postProject {045FFB0E-D0D4-404D-8C33-13C7074B3236} = {045FFB0E-D0D4-404D-8C33-13C7074B3236} EndProjectSection EndProject Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "DesktopPlusWinRT", "DesktopPlusWinRT\DesktopPlusWinRT.vcxproj", "{045FFB0E-D0D4-404D-8C33-13C7074B3236}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|x64 = Debug|x64 Release|x64 = Release|x64 EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution {05050918-71E9-AF87-0B3C-6F34D471A55A}.Debug|x64.ActiveCfg = Debug|x64 {05050918-71E9-AF87-0B3C-6F34D471A55A}.Debug|x64.Build.0 = Debug|x64 {05050918-71E9-AF87-0B3C-6F34D471A55A}.Release|x64.ActiveCfg = Release|x64 {05050918-71E9-AF87-0B3C-6F34D471A55A}.Release|x64.Build.0 = Release|x64 {14405CEC-DF3D-435E-8F11-B79BAC56D7D8}.Debug|x64.ActiveCfg = Debug|x64 {14405CEC-DF3D-435E-8F11-B79BAC56D7D8}.Debug|x64.Build.0 = Debug|x64 {14405CEC-DF3D-435E-8F11-B79BAC56D7D8}.Release|x64.ActiveCfg = Release|x64 {14405CEC-DF3D-435E-8F11-B79BAC56D7D8}.Release|x64.Build.0 = Release|x64 {045FFB0E-D0D4-404D-8C33-13C7074B3236}.Debug|x64.ActiveCfg = Debug|x64 {045FFB0E-D0D4-404D-8C33-13C7074B3236}.Debug|x64.Build.0 = Debug|x64 {045FFB0E-D0D4-404D-8C33-13C7074B3236}.Release|x64.ActiveCfg = Release|x64 {045FFB0E-D0D4-404D-8C33-13C7074B3236}.Release|x64.Build.0 = Release|x64 EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE EndGlobalSection GlobalSection(ExtensibilityGlobals) = postSolution SolutionGuid = {6AC6EA93-8452-42F0-A7BF-B88BDB800DB6} EndGlobalSection EndGlobal ================================================ FILE: src/DesktopPlusUI/AuxUI.cpp ================================================ #include "AuxUI.h" #include "UIManager.h" #include "InterprocessMessaging.h" #include "WindowManager.h" #include "OpenVRExt.h" AuxUIWindow::AuxUIWindow(AuxUIID ui_id) : m_AuxUIID(ui_id), m_Visible(false), m_Alpha(0.0f), m_IsTransitionFading(false), m_AutoSizeFrames(-1) { //Nothing } bool AuxUIWindow::WindowUpdateBase() { AuxUI& aux_ui = UIManager::Get()->GetAuxUI(); if (m_Visible) { if (aux_ui.GetActiveUI() != m_AuxUIID) { Hide(); return true; } //Wait for previous fade out to be done before continuing if (aux_ui.IsUIFadingOut()) return false; if ( (m_Alpha == 0.0f) && (m_AutoSizeFrames == -1) ) { m_AutoSizeFrames = 2; ApplyPendingValues(); } float alpha_prev = m_Alpha; //Alpha fade animation if (m_AutoSizeFrames <= 0) { m_AutoSizeFrames = -1; m_Alpha += ImGui::GetIO().DeltaTime * 7.5f; if (m_Alpha > 1.0f) m_Alpha = 1.0f; } //Set overlay alpha when not in desktop mode if ( (!UIManager::Get()->IsInDesktopMode()) && (alpha_prev != m_Alpha) ) { vr::VROverlay()->SetOverlayAlpha(UIManager::Get()->GetOverlayHandleAuxUI(), m_Alpha); } } else if (m_Alpha != 0.0f) { float alpha_prev = m_Alpha; //Alpha fade animation m_Alpha -= ImGui::GetIO().DeltaTime * 7.5f; if (m_Alpha < 0.0f) m_Alpha = 0.0f; //Set overlay alpha when not in desktop mode if ( (!UIManager::Get()->IsInDesktopMode()) && (alpha_prev != m_Alpha) ) { vr::VROverlay()->SetOverlayAlpha(UIManager::Get()->GetOverlayHandleAuxUI(), m_Alpha); } if (m_Alpha == 0.0f) { if (m_IsTransitionFading) { m_IsTransitionFading = false; Show(); } else { aux_ui.SetFadeOutFinished(); aux_ui.ClearActiveUI(m_AuxUIID); } if (!UIManager::Get()->IsInDesktopMode()) vr::VROverlay()->HideOverlay(UIManager::Get()->GetOverlayHandleAuxUI()); } } else { return false; } return true; } void AuxUIWindow::DrawFullDimmedRectBehindWindow() { //Based on ImGui::RenderDimmedBackgrounds() ImDrawList* draw_list = ImGui::GetWindowDrawList(); if (draw_list->CmdBuffer.Size == 0) draw_list->AddDrawCmd(); draw_list->PushClipRect({0.0f, 0.0f}, ImGui::GetIO().DisplaySize, false); //ImGui FIXME: Need to stricty ensure ImDrawCmd are not merged (ElemCount==6 checks below will verify that) draw_list->AddRectFilled({0.0f, 0.0f}, ImGui::GetIO().DisplaySize, ImGui::ColorConvertFloat4ToU32({0.0f, 0.0f, 0.0f, m_Alpha * 0.5f})); ImDrawCmd cmd = draw_list->CmdBuffer.back(); //IM_ASSERT(cmd.ElemCount == 6); //This seems to block in the way we use this function, but also appears fine without for now? draw_list->CmdBuffer.pop_back(); draw_list->CmdBuffer.push_front(cmd); draw_list->AddDrawCmd(); //ImGui: We need to create a command as CmdBuffer.back().IdxOffset won't be correct if we append to same command. draw_list->PopClipRect(); } void AuxUIWindow::SetUpTextureBounds() { //Set overlay texture bounds based on m_Pos and m_Size (with padding), clamped to available texture space vr::VRTextureBounds_t bounds = {}; const DPRect& rect_total = UITextureSpaces::Get().GetRect(ui_texspace_total); float tex_width = (float)rect_total.GetWidth(); float tex_height = (float)rect_total.GetHeight(); const DPRect& rect_aux_ui = UITextureSpaces::Get().GetRect(ui_texspace_aux_ui); ImVec2 pos_ovrl = {m_Pos.x - rect_aux_ui.GetTL().x, m_Pos.y - rect_aux_ui.GetTL().y}; bounds.uMin = clamp(int(m_Pos.x - 2), rect_aux_ui.GetTL().x, rect_aux_ui.GetBR().x) / tex_width; bounds.vMin = clamp(int(m_Pos.y - 2), rect_aux_ui.GetTL().y, rect_aux_ui.GetBR().y) / tex_height; bounds.uMax = clamp(int(m_Pos.x + m_Size.x + 2), rect_aux_ui.GetTL().x, rect_aux_ui.GetBR().x) / tex_width; bounds.vMax = clamp(int(m_Pos.y + m_Size.y + 2), rect_aux_ui.GetTL().y, rect_aux_ui.GetBR().y) / tex_height; vr::VROverlay()->SetOverlayTextureBounds(UIManager::Get()->GetOverlayHandleAuxUI(), &bounds); } void AuxUIWindow::StartTransitionFade() { if (m_Alpha != 0.0f) { m_Visible = false; m_IsTransitionFading = true; } else //Just skip transition if the window is already invisible { m_Visible = true; } } void AuxUIWindow::ApplyPendingValues() { //Does nothing by default } bool AuxUIWindow::Show() { if (m_IsTransitionFading) return true; m_Visible = UIManager::Get()->GetAuxUI().SetActiveUI(m_AuxUIID); UIManager::Get()->GetIdleState().AddActiveTime(); return m_Visible; } void AuxUIWindow::Hide() { m_Visible = false; m_IsTransitionFading = false; //Clear right away if this window never had the chance to fade in if (m_Alpha == 0.0f) { AuxUI& aux_ui = UIManager::Get()->GetAuxUI(); aux_ui.ClearActiveUI(m_AuxUIID); aux_ui.SetFadeOutFinished(); } UIManager::Get()->GetIdleState().AddActiveTime(); } bool AuxUIWindow::IsVisible() { return m_Visible; } //--WindowDragHint WindowDragHint::WindowDragHint() : AuxUIWindow(auxui_drag_hint), m_TargetDevice(vr::k_unTrackedDeviceIndexInvalid), m_HintType(hint_docking), m_HintTypePending(hint_docking) { //Leave 2 pixel padding around so interpolation doesn't cut off the pixel border const DPRect& rect = UITextureSpaces::Get().GetRect(ui_texspace_aux_ui); m_Pos = {float(rect.GetTL().x + 2), float(rect.GetTL().y + 2)}; m_Size = {-1.0f, -1.0f}; } void WindowDragHint::SetUpOverlay() { vr::VROverlayHandle_t overlay_handle = UIManager::Get()->GetOverlayHandleAuxUI(); const float overlay_width = OVERLAY_WIDTH_METERS_AUXUI_DRAG_HINT * (m_Size.x / 200.0f); //Scale width based on window width for consistent sizing vr::VROverlay()->SetOverlayWidthInMeters(overlay_handle, overlay_width); vr::VROverlay()->SetOverlaySortOrder(overlay_handle, 100); vr::VROverlay()->SetOverlayAlpha(overlay_handle, 0.0f); vr::VROverlay()->SetOverlayInputMethod(overlay_handle, vr::VROverlayInputMethod_None); SetUpTextureBounds(); vr::VROverlay()->ShowOverlay(overlay_handle); } void WindowDragHint::UpdateOverlayPos() { //Check for never tracked device and show for HMD instead then const bool is_device_never_tracked = vr::VRSystem()->GetBoolTrackedDeviceProperty(m_TargetDevice, vr::Prop_NeverTracked_Bool); vr::TrackedDeviceIndex_t device_index = (is_device_never_tracked) ? vr::k_unTrackedDeviceIndex_Hmd : m_TargetDevice; Matrix4 mat; if (device_index == vr::k_unTrackedDeviceIndex_Hmd) //Show in front of HMD { mat.scale(2.0f); //Scale on the transform itself for simplicity mat.translate_relative(0.0f, 0.0f, -0.5f); //Means this is -1m though } else //Show on controller { //Initial offset (somewhat centered inside controller model, for Index at least) mat.translate_relative(0.0f, 0.0f, 0.10f); Vector3 pos = mat.getTranslation(); //Get poses vr::TrackedDevicePose_t poses[vr::k_unMaxTrackedDeviceCount]; vr::VRSystem()->GetDeviceToAbsoluteTrackingPose(vr::TrackingUniverseStanding, vr::IVRSystemEx::GetTimeNowToPhotons(), poses, vr::k_unMaxTrackedDeviceCount); if ( (poses[vr::k_unTrackedDeviceIndex_Hmd].bPoseIsValid) && (device_index < vr::k_unMaxTrackedDeviceCount) && (poses[device_index].bPoseIsValid) ) { //Rotate towards HMD position Matrix4 mat_hmd(poses[vr::k_unTrackedDeviceIndex_Hmd].mDeviceToAbsoluteTracking); Matrix4 mat_controller(poses[device_index].mDeviceToAbsoluteTracking); mat = mat_controller; vr::IVRSystemEx::TransformLookAt(mat, mat_hmd.getTranslation()); //Apply rotation difference between controller used as origin and lookat angle mat.setTranslation({0.0f, 0.0f, 0.0f}); mat_controller.setTranslation({0.0f, 0.0f, 0.0f}); mat_controller.invert(); mat = mat_controller * mat; //Restore position mat.setTranslation(pos); } //Additional offset (move away from controller to avoid clipping, again value fits mostly for Index) mat.translate_relative(0.0f, 0.0f, 0.10f); //At least on the controller we need to keep active time to keep rotation updated UIManager::Get()->GetIdleState().AddActiveTime(); } //Set transform vr::HmdMatrix34_t mat_ovr = mat.toOpenVR34(); vr::VROverlay()->SetOverlayTransformTrackedDeviceRelative(UIManager::Get()->GetOverlayHandleAuxUI(), device_index, &mat_ovr); } void WindowDragHint::ApplyPendingValues() { m_HintType = m_HintTypePending; } void WindowDragHint::Update() { bool render_window = WindowUpdateBase() || m_Size.x == -1.0f; if (!render_window) return; const bool desktop_mode = UIManager::Get()->IsInDesktopMode(); ImGuiWindowFlags flags = ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoCollapse | ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_AlwaysAutoResize; if (!m_Visible) flags |= ImGuiWindowFlags_NoInputs; //Center on screen in desktop mode if (desktop_mode) { ImGui::PushStyleVar(ImGuiStyleVar_Alpha, m_Alpha); ImGui::SetNextWindowPos({ImGui::GetIO().DisplaySize.x / 2.0f, ImGui::GetIO().DisplaySize.y / 2.0f}, ImGuiCond_Always, {0.5f, 0.5f}); } else { ImGui::SetNextWindowPos(m_Pos, ImGuiCond_Always); } ImGui::Begin("WindowDragHint", nullptr, flags); switch (m_HintType) { case WindowDragHint::hint_docking: ImGui::TextUnformatted(TranslationManager::GetString(tstr_AuxUIDragHintDocking)); break; case WindowDragHint::hint_undocking: ImGui::TextUnformatted(TranslationManager::GetString(tstr_AuxUIDragHintUndocking)); break; case WindowDragHint::hint_ovrl_locked: ImGui::TextUnformatted(TranslationManager::GetString(tstr_AuxUIDragHintOvrlLocked)); break; case WindowDragHint::hint_ovrl_theater_screen_blocked: ImGui::TextUnformatted(TranslationManager::GetString(tstr_AuxUIDragHintOvrlTheaterScreenBlocked)); break; } if (desktop_mode) DrawFullDimmedRectBehindWindow(); m_Size = ImGui::GetWindowSize(); ImGui::End(); if (desktop_mode) ImGui::PopStyleVar(); if ((!desktop_mode) && (!m_IsTransitionFading)) { UpdateOverlayPos(); } if (m_AutoSizeFrames > 0) { m_AutoSizeFrames--; if ((m_AutoSizeFrames == 0) && (!desktop_mode)) { SetUpOverlay(); } } } void WindowDragHint::SetHintType(vr::TrackedDeviceIndex_t device_index, WindowDragHint::HintType hint_type) { if ((m_TargetDevice == device_index) && (m_HintType == hint_type)) return; m_TargetDevice = device_index; m_HintTypePending = hint_type; //Actual value set after transition if (m_Visible) StartTransitionFade(); } //--WindowGazeFadeAutoHint WindowGazeFadeAutoHint::WindowGazeFadeAutoHint() : AuxUIWindow(auxui_gazefade_auto_hint), m_TargetOverlay(k_ulOverlayID_None), m_Countdown(3), m_TickTime(0.0) { //Leave 2 pixel padding around so interpolation doesn't cut off the pixel border const DPRect& rect = UITextureSpaces::Get().GetRect(ui_texspace_aux_ui); m_Pos = {float(rect.GetTL().x + 2), float(rect.GetTL().y + 2)}; m_Size = {-1.0f, -1.0f}; } void WindowGazeFadeAutoHint::SetUpOverlay() { vr::VROverlayHandle_t overlay_handle = UIManager::Get()->GetOverlayHandleAuxUI(); vr::VROverlay()->SetOverlayWidthInMeters(overlay_handle, OVERLAY_WIDTH_METERS_AUXUI_GAZEFADE_AUTO_HINT); vr::VROverlay()->SetOverlaySortOrder(overlay_handle, 100); vr::VROverlay()->SetOverlayAlpha(overlay_handle, 0.0f); vr::VROverlay()->SetOverlayInputMethod(overlay_handle, vr::VROverlayInputMethod_None); SetUpTextureBounds(); vr::VROverlay()->ShowOverlay(overlay_handle); } void WindowGazeFadeAutoHint::UpdateOverlayPos() { //Initial offset Matrix4 mat; mat.translate_relative(0.0f, 0.0f, -1.00f); //Set transform vr::HmdMatrix34_t mat_ovr = mat.toOpenVR34(); vr::VROverlay()->SetOverlayTransformTrackedDeviceRelative(UIManager::Get()->GetOverlayHandleAuxUI(), vr::k_unTrackedDeviceIndex_Hmd, &mat_ovr); } bool WindowGazeFadeAutoHint::Show() { m_Countdown = 3; m_TickTime = 0.0; //Triggers label update right away on Update() UIManager::Get()->GetIdleState().AddActiveTime(5000); //Deactivate GazeFade during the countdown so the overlay is visible to the user IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, (int)m_TargetOverlay); IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_overlay_gazefade_enabled, false); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, -1); return AuxUIWindow::Show(); } void WindowGazeFadeAutoHint::Hide() { //Trigger GazeFade auto-configure IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, (int)m_TargetOverlay); IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_gaze_fade_auto); IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_overlay_gazefade_enabled, true); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, -1); //Enable gaze fade if it isn't yet OverlayManager::Get().GetConfigData(m_TargetOverlay).ConfigBool[configid_bool_overlay_gazefade_enabled] = true; AuxUIWindow::Hide(); } void WindowGazeFadeAutoHint::Update() { bool render_window = WindowUpdateBase() || m_Size.x == -1.0f; if (!render_window) return; if (m_TickTime + 1.0 < ImGui::GetTime()) { if (m_Countdown == 0) { //Hide and keep the old label during fade-out Hide(); } else //Update label { m_Label = TranslationManager::GetString((m_Countdown != 1) ? tstr_AuxUIGazeFadeAutoHint : tstr_AuxUIGazeFadeAutoHintSingular); StringReplaceAll(m_Label, "%SECONDS%", std::to_string(m_Countdown)); m_Countdown--; m_TickTime = ImGui::GetTime(); } } const bool desktop_mode = UIManager::Get()->IsInDesktopMode(); ImGuiWindowFlags flags = ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoCollapse | ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_AlwaysAutoResize; if (!m_Visible) flags |= ImGuiWindowFlags_NoInputs; //Center on screen in desktop mode if (desktop_mode) { ImGui::PushStyleVar(ImGuiStyleVar_Alpha, m_Alpha); ImGui::SetNextWindowPos({ImGui::GetIO().DisplaySize.x / 2.0f, ImGui::GetIO().DisplaySize.y / 2.0f}, ImGuiCond_Always, {0.5f, 0.5f}); } else { ImGui::SetNextWindowPos(m_Pos, ImGuiCond_Always); } ImGui::Begin("WindowGazeFadeAutoHint", nullptr, flags); ImGui::TextUnformatted(m_Label.c_str()); if (desktop_mode) DrawFullDimmedRectBehindWindow(); m_Size = ImGui::GetWindowSize(); ImGui::End(); if (desktop_mode) ImGui::PopStyleVar(); if ((!desktop_mode) && (!m_IsTransitionFading)) { UpdateOverlayPos(); } if (m_AutoSizeFrames > 0) { m_AutoSizeFrames--; if ((m_AutoSizeFrames == 0) && (!desktop_mode)) { SetUpOverlay(); } } } void WindowGazeFadeAutoHint::SetTargetOverlay(unsigned int overlay_id) { m_TargetOverlay = overlay_id; } //--WindowQuickStart WindowQuickStart::WindowQuickStart() : AuxUIWindow(auxui_window_quickstart), m_CurrentPage(0) { //Leave 2 pixel padding around so interpolation doesn't cut off the pixel border const DPRect& rect = UITextureSpaces::Get().GetRect(ui_texspace_aux_ui); m_Pos = {float(rect.GetTL().x + 2), float(rect.GetTL().y + 2)}; m_Size = {-1.0f, -1.0f}; m_Transform.zero(); } void WindowQuickStart::SetUpOverlay() { vr::VROverlayHandle_t overlay_handle = UIManager::Get()->GetOverlayHandleAuxUI(); vr::VROverlay()->SetOverlayWidthInMeters(overlay_handle, OVERLAY_WIDTH_METERS_AUXUI_WINDOW_QUICKSTART); vr::VROverlay()->SetOverlaySortOrder(overlay_handle, 2); vr::VROverlay()->SetOverlayAlpha(overlay_handle, 0.0f); vr::VROverlay()->SetOverlayInputMethod(overlay_handle, vr::VROverlayInputMethod_Mouse); SetUpTextureBounds(); UpdateOverlayPos(); vr::VROverlay()->ShowOverlay(overlay_handle); } void WindowQuickStart::UpdateOverlayPos() { const float auxui_ovrl_width = OVERLAY_WIDTH_METERS_AUXUI_WINDOW_QUICKSTART; const float auxui_ovrl_height = OVERLAY_WIDTH_METERS_AUXUI_WINDOW_QUICKSTART * (m_Size.y / m_Size.x); //Set initial transform to zoom in from the first time this is called while visible if ((m_Visible) && (m_Transform.isZero())) { m_Transform = vr::IVRSystemEx::ComputeHMDFacingTransform(1.0); Vector3 pos = m_Transform.getTranslation(); m_Transform.setTranslation({0.0f, 0.0f, 0.0f}); m_Transform.scale(0.0f); m_Transform.setTranslation(pos); return; } //Set target transform based on page (may update while animating) switch (m_CurrentPage) { case pageid_Welcome: { m_TransformAnimationEnd = vr::IVRSystemEx::ComputeHMDFacingTransform(1.0f); break; } case pageid_Overlays: { //Aim for top right side of overlay bar (doesn't obscure the overlay menu mentioned on the page) const auto& window = UIManager::Get()->GetOverlayBarWindow(); const DPRect& rect_tex = UITextureSpaces::Get().GetRect(ui_texspace_overlay_bar); //Default to top left of window relative to texspace (note that AuxUI overlay is centered on that spot) Vector2 point_2d(window.GetPos().x - rect_tex.GetTL().x, window.GetPos().y - rect_tex.GetTL().y); point_2d.x += window.GetSize().x; m_TransformAnimationEnd = UIManager::Get()->GetOverlay2DPointTransform(point_2d, UIManager::Get()->GetOverlayHandleOverlayBar()); m_TransformAnimationEnd.translate_relative(0.0f, auxui_ovrl_height / 2.0f, 0.0f); Vector3 pos = m_TransformAnimationEnd.getTranslation(); m_TransformAnimationEnd.setTranslation({0.0f, 0.0f, 0.0f}); m_TransformAnimationEnd.rotateY(-10.0f); m_TransformAnimationEnd.setTranslation(pos); m_TransformAnimationEnd.translate_relative(0.0f, 0.0f, 0.05f); break; } case pageid_Overlays_2: { //Aim for top left side of overlay bar (doesn't obscure the add overlay menu mentioned on the page) const auto& window = UIManager::Get()->GetOverlayBarWindow(); const DPRect& rect_tex = UITextureSpaces::Get().GetRect(ui_texspace_overlay_bar); //Default to top left of window relative to texspace (note that AuxUI overlay is centered on that spot) Vector2 point_2d(window.GetPos().x - rect_tex.GetTL().x, window.GetPos().y - rect_tex.GetTL().y); m_TransformAnimationEnd = UIManager::Get()->GetOverlay2DPointTransform(point_2d, UIManager::Get()->GetOverlayHandleOverlayBar()); m_TransformAnimationEnd.translate_relative(0.0f, auxui_ovrl_height / 2.0f, 0.0f); Vector3 pos = m_TransformAnimationEnd.getTranslation(); m_TransformAnimationEnd.setTranslation({0.0f, 0.0f, 0.0f}); m_TransformAnimationEnd.rotateY(12.5f); m_TransformAnimationEnd.setTranslation(pos); m_TransformAnimationEnd.translate_relative(0.0f, 0.0f, 0.05f); break; } case pageid_OverlayProperties: case pageid_OverlayProperties_2: { const auto& window = UIManager::Get()->GetOverlayPropertiesWindow(); const DPRect& rect_tex = UITextureSpaces::Get().GetRect(ui_texspace_overlay_properties); //Top left of window relative to texspace Vector2 point_2d(window.GetPos().x - rect_tex.GetTL().x, window.GetPos().y - rect_tex.GetTL().y); point_2d.y += window.GetSize().y; m_TransformAnimationEnd = UIManager::Get()->GetOverlay2DPointTransform(point_2d, window.GetOverlayHandle()); m_TransformAnimationEnd.translate_relative(auxui_ovrl_width * 1.52f, auxui_ovrl_height / 4.0f, 0.05f); Vector3 pos = m_TransformAnimationEnd.getTranslation(); m_TransformAnimationEnd.setTranslation({0.0f, 0.0f, 0.0f}); m_TransformAnimationEnd.rotateY(-25.0f); m_TransformAnimationEnd.setTranslation(pos); m_TransformAnimationEnd.translate_relative(0.0f, 0.0f, 0.125f); break; } case pageid_Settings: case pageid_Profiles: case pageid_Actions: case pageid_Actions_2: case pageid_OverlayTags: case pageid_Settings_End: { const auto& window = UIManager::Get()->GetSettingsWindow(); const DPRect& rect_tex = UITextureSpaces::Get().GetRect(ui_texspace_settings); //Top left of window relative to texspace Vector2 point_2d(window.GetPos().x - rect_tex.GetTL().x, window.GetPos().y - rect_tex.GetTL().y); point_2d.y += window.GetSize().y; m_TransformAnimationEnd = UIManager::Get()->GetOverlay2DPointTransform(point_2d, UIManager::Get()->GetOverlayHandleSettings()); m_TransformAnimationEnd.translate_relative(auxui_ovrl_width * -1.02f, auxui_ovrl_height / 4.0f, 0.05f); Vector3 pos = m_TransformAnimationEnd.getTranslation(); m_TransformAnimationEnd.setTranslation({0.0f, 0.0f, 0.0f}); m_TransformAnimationEnd.rotateY(25.0f); m_TransformAnimationEnd.setTranslation(pos); m_TransformAnimationEnd.translate_relative(0.0f, 0.0f, 0.125f); break; } case pageid_FloatingUI: { const auto& window = UIManager::Get()->GetFloatingUI().GetActionBarWindow(); const DPRect& rect_tex = UITextureSpaces::Get().GetRect(ui_texspace_floating_ui); //Top left of window relative to texspace Vector2 point_2d(window.GetPos().x - rect_tex.GetTL().x, window.GetPos().y - rect_tex.GetTL().y); point_2d.x += window.GetSize().x / 2.0f; m_TransformAnimationEnd = UIManager::Get()->GetOverlay2DPointTransform(point_2d, UIManager::Get()->GetOverlayHandleFloatingUI()); m_TransformAnimationEnd.translate_relative(0.0f, (auxui_ovrl_height / 2.0f) + 0.05f, 0.0f); m_TransformAnimationEnd.translate_relative(0.0f, 0.0f, 0.05f); break; } case pageid_DesktopMode: case pageid_ReadMe: { m_TransformAnimationEnd = vr::IVRSystemEx::ComputeHMDFacingTransform(1.0f); break; } } //Set start point if this animation is just starting if (m_TransformAnimationProgress == 0.0f) { m_TransformAnimationStart = m_Transform; } //Smoothstep over each matrix component and set the result float mat_array[16] = {}; for (int i = 0; i < 16; ++i) { mat_array[i] = smoothstep(m_TransformAnimationProgress, m_TransformAnimationStart.get()[i], m_TransformAnimationEnd.get()[i]); } m_Transform.set(mat_array); //Progress animation step const float time_step = ImGui::GetIO().DeltaTime * 3.0f; m_TransformAnimationProgress += time_step; if (m_TransformAnimationProgress > 1.0f) { m_TransformAnimationProgress = 1.0f; } //Set transform vr::HmdMatrix34_t mat_ovr = m_Transform.toOpenVR34(); vr::VROverlay()->SetOverlayTransformAbsolute(UIManager::Get()->GetOverlayHandleAuxUI(), vr::TrackingUniverseStanding, &mat_ovr); } void WindowQuickStart::OnPageChange(int page_id) { //Set window visibility and scrolls as they should be for the page WindowSettings& window_settings = UIManager::Get()->GetSettingsWindow(); WindowOverlayProperties& window_overlay_properties = UIManager::Get()->GetOverlayPropertiesWindow(); switch (page_id) { case pageid_Welcome: case pageid_Overlays: case pageid_Overlays_2: { window_settings.Hide(); window_overlay_properties.Hide(); break; } case pageid_OverlayProperties: case pageid_OverlayProperties_2: { window_settings.Hide(); window_overlay_properties.SetActiveOverlayID(0); window_overlay_properties.Show(); break; } case pageid_Settings: case pageid_Profiles: { window_settings.Show(); window_settings.QuickStartGuideGoToPage(wndsettings_page_main); window_overlay_properties.Hide(); break; } case pageid_Actions: { window_settings.Show(); window_settings.QuickStartGuideGoToPage(wndsettings_page_actions); window_overlay_properties.Hide(); break; } case pageid_Actions_2: case pageid_OverlayTags: { window_settings.Show(); window_settings.QuickStartGuideGoToPage(wndsettings_page_actions_edit); window_overlay_properties.Hide(); break; } case pageid_Settings_End: { window_settings.Show(); window_settings.QuickStartGuideGoToPage(wndsettings_page_main); window_overlay_properties.Hide(); break; } case pageid_FloatingUI: case pageid_DesktopMode: case pageid_ReadMe: { window_settings.Hide(); window_overlay_properties.Hide(); break; } } m_TransformAnimationProgress = 0.0f; m_TimeoutTickStart = 0; } bool WindowQuickStart::Show() { return AuxUIWindow::Show(); } void WindowQuickStart::Hide() { m_TimeoutTickStart = 0; AuxUIWindow::Hide(); } void WindowQuickStart::Update() { if (!ConfigManager::GetValue(configid_bool_interface_quick_start_hidden)) { //Temporarily hide when leaving dashboard tab if (UIManager::Get()->IsOverlayBarOverlayVisible()) { if (!m_Visible) { //We need to wait a bit or else we might get old overlay transform data when calling UpdateOverlayPos() after this //Waiting two frames seems to be sufficient and isn't much of an issue vr::VROverlay()->WaitFrameSync(100); vr::VROverlay()->WaitFrameSync(100); Show(); m_TransformAnimationProgress = 0.0f; } } else if (m_Visible) { Hide(); } //Hide automatically after a timeout if there doesn't seem to be any input device (using the dashboard without one is weird, but still) if ((m_CurrentPage == 0) && (UIManager::Get()->IsOpenVRLoaded())) { const vr::TrackedDeviceIndex_t device_index = ConfigManager::Get().GetPrimaryLaserPointerDevice(); if ((device_index == vr::k_unTrackedDeviceIndexInvalid) || ((device_index == vr::k_unTrackedDeviceIndex_Hmd))) //HMD may or may not being able to click { //Don't do it if the overlay is being pointed at, however (potentially still no input possible, but user can point somewhere else then) if (!ConfigManager::Get().IsLaserPointerTargetOverlay(UIManager::Get()->GetOverlayHandleAuxUI())) { const unsigned int timeout_ms = (device_index == vr::k_unTrackedDeviceIndex_Hmd) ? 20000 : 10000; if (m_TimeoutTickStart == 0) { m_TimeoutTickStart = ::GetTickCount64(); } else if (m_TimeoutTickStart + timeout_ms < ::GetTickCount64()) { ConfigManager::SetValue(configid_bool_interface_quick_start_hidden, true); Hide(); } } } } } bool render_window = WindowUpdateBase() || m_Size.x == -1.0f; if (!render_window) return; ImGuiWindowFlags flags = ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoCollapse | ImGuiWindowFlags_NoTitleBar; if (!m_Visible) flags |= ImGuiWindowFlags_NoInputs; ImGuiStyle& style = ImGui::GetStyle(); const DPRect& rect = UITextureSpaces::Get().GetRect(ui_texspace_aux_ui); ImGui::SetNextWindowPos(m_Pos, ImGuiCond_Always); ImGui::SetNextWindowSize({(float)rect.GetWidth() - 4.0f, (float)rect.GetHeight() * 0.85f}); ImGui::Begin("WindowQuickStart", nullptr, flags); const float page_width = m_Size.x - style.WindowBorderSize - style.WindowPadding.x - style.WindowPadding.x; //Page animation if (m_PageAnimationDir != 0) { //Use the averaged framerate value instead of delta time for the first animation step //This is to smooth over increased frame deltas that can happen when a new page needs to do initial larger computations or save/load files const float progress_step = (m_PageAnimationProgress == 0.0f) ? (1.0f / ImGui::GetIO().Framerate) * 3.0f : ImGui::GetIO().DeltaTime * 3.0f; m_PageAnimationProgress += progress_step; if (m_PageAnimationProgress >= 1.0f) { m_PageAnimationProgress = 1.0f; m_PageAnimationDir = 0; m_CurrentPageAnimationMax = m_CurrentPageAnimation; } } else if (m_CurrentPageAnimation != m_CurrentPage) //Only start new animation if none is running { m_PageAnimationDir = (m_CurrentPageAnimation < m_CurrentPage) ? -1 : 1; m_CurrentPageAnimation = m_CurrentPage; m_PageAnimationStartPos = m_PageAnimationOffset; m_PageAnimationProgress = 0.0f; m_CurrentPageAnimationMax = std::max(m_CurrentPage, m_CurrentPageAnimationMax); } const float target_x = (page_width + style.ItemSpacing.x) * -m_CurrentPageAnimation; m_PageAnimationOffset = smoothstep(m_PageAnimationProgress, m_PageAnimationStartPos, target_x); //Set up page offset and clipping ImGui::SetCursorPosX( (ImGui::GetCursorPosX() + m_PageAnimationOffset) ); const ImVec2 child_size = {page_width, ImGui::GetContentRegionAvail().y - ImGui::GetFrameHeightWithSpacing() - style.ItemSpacing.y}; const int active_page_count = m_CurrentPageAnimationMax + 1; for (int i = 0; i < active_page_count; ++i) { //Disable items when the page isn't active const bool is_inactive_page = (i != m_CurrentPage); if (is_inactive_page) { ImGui::PushItemDisabledNoVisual(); } ImGui::PushStyleColor(ImGuiCol_ChildBg, ImVec4(0.00f, 0.00f, 0.00f, 0.00f)); if ( (ImGui::BeginChild(ImGui::GetID((void*)(intptr_t)i), child_size, ImGuiChildFlags_NavFlattened)) ) { ImGui::PopStyleColor(); //ImGuiCol_ChildBg ImGui::PushTextWrapPos(ImGui::GetContentRegionAvail().x); switch (i) { case pageid_Welcome: { ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_AuxUIQuickStartWelcomeHeader)); ImGui::Indent(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_AuxUIQuickStartWelcomeBody)); break; } case pageid_Overlays: { ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_AuxUIQuickStartOverlaysHeader)); ImGui::Indent(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_AuxUIQuickStartOverlaysBody)); break; } case pageid_Overlays_2: { ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_AuxUIQuickStartOverlaysHeader)); ImGui::Indent(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_AuxUIQuickStartOverlaysBody2)); break; } case pageid_OverlayProperties: { ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_AuxUIQuickStartOverlayPropertiesHeader)); ImGui::Indent(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_AuxUIQuickStartOverlayPropertiesBody)); break; } case pageid_OverlayProperties_2: { ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_AuxUIQuickStartOverlayPropertiesHeader)); ImGui::Indent(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_AuxUIQuickStartOverlayPropertiesBody2)); break; } case pageid_Settings: { ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_AuxUIQuickStartSettingsHeader)); ImGui::Indent(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_AuxUIQuickStartSettingsBody)); break; } case pageid_Profiles: { ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_AuxUIQuickStartProfilesHeader)); ImGui::Indent(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_AuxUIQuickStartProfilesBody)); break; } case pageid_Actions: { ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_AuxUIQuickStartActionsHeader)); ImGui::Indent(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_AuxUIQuickStartActionsBody)); break; } case pageid_Actions_2: { ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_AuxUIQuickStartActionsHeader)); ImGui::Indent(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_AuxUIQuickStartActionsBody2)); break; } case pageid_OverlayTags: { ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_AuxUIQuickStartOverlayTagsHeader)); ImGui::Indent(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_AuxUIQuickStartOverlayTagsBody)); break; } case pageid_Settings_End: { ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_AuxUIQuickStartSettingsHeader)); ImGui::Indent(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_AuxUIQuickStartSettingsEndBody)); break; } case pageid_FloatingUI: { ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_AuxUIQuickStartFloatingUIHeader)); ImGui::Indent(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_AuxUIQuickStartFloatingUIBody)); break; } case pageid_DesktopMode: { ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_AuxUIQuickStartDesktopModeHeader)); ImGui::Indent(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_AuxUIQuickStartDesktopModeBody)); break; } case pageid_ReadMe: { ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_AuxUIQuickStartEndHeader)); ImGui::Indent(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_AuxUIQuickStartEndBody)); break; } } ImGui::Unindent(); ImGui::PopTextWrapPos(); } else { ImGui::PopStyleColor(); //ImGuiCol_ChildBg } if (is_inactive_page) { ImGui::PopItemDisabledNoVisual(); } ImGui::EndChild(); if (i + 1 < active_page_count) { ImGui::SameLine(); } } //Bottom buttons ImGui::Separator(); int current_page_prev = m_CurrentPage; if (current_page_prev == 0) ImGui::PushItemDisabled(); if (ImGui::Button(TranslationManager::GetString(tstr_AuxUIQuickStartButtonPrev))) { m_CurrentPage--; OnPageChange(m_CurrentPage); UIManager::Get()->RepeatFrame(); } if (current_page_prev == 0) ImGui::PopItemDisabled(); ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); if (current_page_prev == pageid_MAX) ImGui::PushItemDisabled(); if (ImGui::Button(TranslationManager::GetString(tstr_AuxUIQuickStartButtonNext))) { m_CurrentPage++; OnPageChange(m_CurrentPage); UIManager::Get()->RepeatFrame(); } if (current_page_prev == pageid_MAX) ImGui::PopItemDisabled(); ImGui::SameLine(); if (ImGui::Button(TranslationManager::GetString(tstr_AuxUIQuickStartButtonClose))) { ConfigManager::SetValue(configid_bool_interface_quick_start_hidden, true); Hide(); } m_Size = ImGui::GetWindowSize(); ImGui::End(); if ( (!UIManager::Get()->IsInDesktopMode()) && (m_Visible) && (!m_IsTransitionFading) && (m_TransformAnimationProgress != 1.0f) ) { UpdateOverlayPos(); } if (m_AutoSizeFrames > 0) { m_AutoSizeFrames--; if ((m_AutoSizeFrames == 0) && (!UIManager::Get()->IsInDesktopMode())) { SetUpOverlay(); } } } void WindowQuickStart::Reset() { Hide(); ConfigManager::SetValue(configid_bool_interface_quick_start_hidden, false); UIManager::Get()->GetSettingsWindow().QuickStartGuideGoToPage(wndsettings_page_main); m_Transform.zero(); m_CurrentPage = 0; OnPageChange(m_CurrentPage); if (m_Alpha == 0.0f) { m_PageAnimationProgress = 1.0f; } UIManager::Get()->RepeatFrame(); } //--WindowCaptureWindowSelect WindowCaptureWindowSelect::WindowCaptureWindowSelect() : AuxUIWindow(auxui_window_select), m_WindowLastClicked(nullptr), m_HoveredTickLast(0) { //Leave 2 pixel padding around so interpolation doesn't cut off the pixel border const DPRect& rect = UITextureSpaces::Get().GetRect(ui_texspace_aux_ui); m_Size = {float(rect.GetWidth() - 4), float(rect.GetHeight() - 4)}; m_Pos = {float(rect.GetTL().x + 2), float(rect.GetTL().y + 2)}; m_PosCenter = {(float)rect.GetCenter().x, (float)rect.GetCenter().y}; } void WindowCaptureWindowSelect::SetUpOverlay() { vr::VROverlayHandle_t overlay_handle = UIManager::Get()->GetOverlayHandleAuxUI(); vr::VROverlay()->SetOverlayWidthInMeters(overlay_handle, OVERLAY_WIDTH_METERS_AUXUI_WINDOW_SELECT); vr::VROverlay()->SetOverlaySortOrder(overlay_handle, 2); vr::VROverlay()->SetOverlayAlpha(overlay_handle, 0.0f); vr::VROverlay()->SetOverlayInputMethod(overlay_handle, vr::VROverlayInputMethod_Mouse); //Take transform set by Overlay Bar and offset it a bit forward Matrix4 mat = m_Transform; mat.translate_relative(0.0f, 0.0f, 0.1f); vr::HmdMatrix34_t mat_ovr = mat.toOpenVR34(); vr::VROverlay()->SetOverlayTransformAbsolute(overlay_handle, vr::TrackingUniverseStanding, &mat_ovr); SetUpTextureBounds(); vr::VROverlay()->ShowOverlay(overlay_handle); } void WindowCaptureWindowSelect::ApplyPendingValues() { m_WindowLastClicked = nullptr; } bool WindowCaptureWindowSelect::Show() { //Limit window height to perfectly fit 14 list entries (not done in constructor since we need ImGui context) m_Size.y = std::min( ((ImGui::GetTextLineHeight() + ImGui::GetStyle().ItemSpacing.y) * 14.0f) + (ImGui::GetStyle().WindowPadding.y * 2.0f), m_Size.y); m_HoveredTickLast = ::GetTickCount64(); return AuxUIWindow::Show(); } void WindowCaptureWindowSelect::Update() { bool render_window = WindowUpdateBase() || m_Size.x == -1.0f; if (!render_window) return; ImGuiWindowFlags flags = ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoCollapse | ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_AlwaysAutoResize; if (!m_Visible) flags |= ImGuiWindowFlags_NoInputs; ImGui::SetNextWindowSizeConstraints({4.0f, 4.0f}, m_Size); ImGui::SetNextWindowPos(m_PosCenter, ImGuiCond_Always, {0.5f, 0.5f}); ImGui::SetNextWindowScroll({0.0f, -1.0f}); //Prevent horizontal scrolling from happening on overflow ImGui::Begin("WindowCaptureWindowSelect", nullptr, flags); //Hide if clicked outside or not hovered for 3 seconds if (!ImGui::IsWindowHovered(ImGuiHoveredFlags_AllowWhenBlockedByActiveItem)) { if ((ImGui::IsAnyMouseClicked()) || (m_HoveredTickLast + 3000 < ::GetTickCount64())) { Hide(); } } else { m_HoveredTickLast = ::GetTickCount64(); } //Adjust selectable colors to avoid flicker when fading the window out after activating ImGui::PushStyleColor(ImGuiCol_Header, ImGui::GetStyleColorVec4(ImGuiCol_HeaderHovered)); ImGui::PushStyleColor(ImGuiCol_HeaderActive, ImGui::GetStyleColorVec4(ImGuiCol_HeaderHovered)); //List windows ImVec2 img_size_line_height = {ImGui::GetTextLineHeight(), ImGui::GetTextLineHeight()}; ImVec2 img_size, img_uv_min, img_uv_max; for (const auto& window_info : WindowManager::Get().WindowListGet()) { ImGui::PushID(window_info.GetWindowHandle()); ImGui::Selectable("", (window_info.GetWindowHandle() == m_WindowLastClicked)); if (ImGui::IsItemActivated()) { if (UIManager::Get()->IsOpenVRLoaded()) { vr::TrackedDeviceIndex_t device_index = ConfigManager::Get().GetPrimaryLaserPointerDevice(); //If no dashboard device, try finding one if (device_index == vr::k_unTrackedDeviceIndexInvalid) { device_index = vr::IVROverlayEx::FindPointerDeviceForOverlay(UIManager::Get()->GetOverlayHandleAuxUI()); } //Try to get the pointer distance float source_distance = 1.0f; vr::VROverlayIntersectionResults_t results; if (vr::IVROverlayEx::ComputeOverlayIntersectionForDevice(UIManager::Get()->GetOverlayHandleAuxUI(), device_index, vr::TrackingUniverseStanding, &results)) { source_distance = results.fDistance; } //Set pointer hint in case dashboard app needs it ConfigManager::SetValue(configid_int_state_laser_pointer_device_hint, (int)device_index); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_laser_pointer_device_hint, (int)device_index); //Add overlay HWND window_handle = window_info.GetWindowHandle(); OverlayManager::Get().AddOverlay(ovrl_capsource_winrt_capture, -2, window_handle); //Send to dashboard app IPCManager::Get().PostConfigMessageToDashboardApp(configid_handle_state_arg_hwnd, (LPARAM)window_handle); IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_new_drag, MAKELPARAM(-2, (source_distance * 100.0f))); } //Store last clicked window to avoid Selectable flicker on fade out m_WindowLastClicked = window_info.GetWindowHandle(); //We're done here, hide this window Hide(); } ImGui::SameLine(0.0f, 0.0f); //Window icon and title int icon_id = TextureManager::Get().GetWindowIconCacheID(window_info.GetIcon()); if (icon_id != -1) { TextureManager::Get().GetWindowIconTextureInfo(icon_id, img_size, img_uv_min, img_uv_max); ImGui::Image(ImGui::GetIO().Fonts->TexID, img_size_line_height, img_uv_min, img_uv_max); ImGui::SameLine(0.0f, ImGui::GetStyle().ItemInnerSpacing.x); } ImGui::TextUnformatted(window_info.GetListTitle().c_str()); ImGui::PopID(); } ImGui::PopStyleColor(); ImGui::PopStyleColor(); ImGui::End(); //Handle auto-size frames if (m_AutoSizeFrames > 0) { m_AutoSizeFrames--; if ((m_AutoSizeFrames == 0) && (!UIManager::Get()->IsInDesktopMode())) { SetUpOverlay(); } } } void WindowCaptureWindowSelect::SetTransform(Matrix4 transform) { m_Transform = transform; if (m_Visible) { StartTransitionFade(); } } //--AuxUI AuxUI::AuxUI() : m_ActiveUIID(auxui_none), m_IsUIFadingOut(false) { //Nothing } void AuxUI::Update() { //All Aux UI windows are updated even when not active m_WindowDragHint.Update(); m_WindowGazeFadeAutoHint.Update(); m_WindowCaptureWindowSelect.Update(); m_WindowQuickStart.Update(); } bool AuxUI::IsActive() const { return (m_ActiveUIID != auxui_none); } void AuxUI::HideTemporaryWindows() { switch (m_ActiveUIID) { case auxui_window_select: { ClearActiveUI(m_ActiveUIID); break; } default: break; } } bool AuxUI::SetActiveUI(AuxUIID new_ui_id) { if (new_ui_id >= m_ActiveUIID) { if ( (m_ActiveUIID != auxui_none) && (new_ui_id != m_ActiveUIID) ) { m_IsUIFadingOut = true; } m_ActiveUIID = new_ui_id; return true; } return false; } AuxUIID AuxUI::GetActiveUI() const { return m_ActiveUIID; } void AuxUI::ClearActiveUI(AuxUIID current_ui_id) { if (m_ActiveUIID == current_ui_id) { m_ActiveUIID = auxui_none; } } bool AuxUI::IsUIFadingOut() const { return m_IsUIFadingOut; } void AuxUI::SetFadeOutFinished() { m_IsUIFadingOut = false; } WindowDragHint& AuxUI::GetDragHintWindow() { return m_WindowDragHint; } WindowGazeFadeAutoHint& AuxUI::GetGazeFadeAutoHintWindow() { return m_WindowGazeFadeAutoHint; } WindowCaptureWindowSelect& AuxUI::GetCaptureWindowSelectWindow() { return m_WindowCaptureWindowSelect; } WindowQuickStart& AuxUI::GetQuickStartWindow() { return m_WindowQuickStart; } ================================================ FILE: src/DesktopPlusUI/AuxUI.h ================================================ #pragma once #define NOMINMAX #include #include "imgui.h" #include "openvr.h" #include "Matrices.h" //Hosts and manages UI that is displayed on the DesktopPlusUIAux overlay //Generally rarely and not parallel displayed things go here //Order of UI ID also determines priority. A higher priority UI can force an active lower one to stop displaying enum AuxUIID { auxui_none, auxui_window_quickstart, auxui_drag_hint, auxui_gazefade_auto_hint, auxui_window_select }; class AuxUIWindow { protected: const AuxUIID m_AuxUIID; ImVec2 m_Pos; //Used for overlay texture bounds, always top-left pivot, should already be offset for 2x2 pixel padding ImVec2 m_Size; //Used for overlay texture bounds, read as max size for ImGui window when using auto-sizing bool m_Visible; float m_Alpha; bool m_IsTransitionFading; //If true, AuxUIWindow does not clear the active UI but instead shows the window again to transition to a different position with a fade int m_AutoSizeFrames; //Overlay setup may need to be delayed when the window uses auto-sizing. In that case m_Alpha stays 0.0f while m_AutoSizeFrames is not 0 bool WindowUpdateBase(); //Handles alpha fading according to AuxUI state, but doesn't Begin() a window like FloatingWindow would. Returns true if window should be rendered void DrawFullDimmedRectBehindWindow(); //Call before End() to draw a dimmed rect behind the window in desktop mode. Uses m_Alpha for fading. Messes with draw list, may break virtual void SetUpTextureBounds(); virtual void StartTransitionFade(); virtual void ApplyPendingValues(); //Pending values when switching between states from a transition fade should be applied here, if any public: AuxUIWindow(AuxUIID ui_id); virtual bool Show(); virtual void Hide(); bool IsVisible(); }; class WindowDragHint : public AuxUIWindow { public: enum HintType { hint_none, hint_docking, hint_undocking, hint_ovrl_locked, hint_ovrl_theater_screen_blocked }; private: vr::TrackedDeviceIndex_t m_TargetDevice; WindowDragHint::HintType m_HintType; WindowDragHint::HintType m_HintTypePending; void SetUpOverlay(); void UpdateOverlayPos(); virtual void ApplyPendingValues(); public: WindowDragHint(); void Update(); void SetHintType(vr::TrackedDeviceIndex_t device_index, WindowDragHint::HintType hint_type); }; class WindowGazeFadeAutoHint : public AuxUIWindow { private: unsigned int m_TargetOverlay; int m_Countdown; double m_TickTime; std::string m_Label; void SetUpOverlay(); void UpdateOverlayPos(); public: WindowGazeFadeAutoHint(); virtual bool Show(); virtual void Hide(); void Update(); void SetTargetOverlay(unsigned int overlay_id); }; class WindowQuickStart : public AuxUIWindow { private: enum PageID : int { pageid_Welcome, pageid_Overlays, pageid_Overlays_2, pageid_OverlayProperties, pageid_OverlayProperties_2, pageid_Settings, pageid_Profiles, pageid_Actions, pageid_Actions_2, pageid_OverlayTags, pageid_Settings_End, pageid_FloatingUI, pageid_DesktopMode, pageid_ReadMe, pageid_MAX = pageid_ReadMe, }; int m_CurrentPage = 0; int m_CurrentPageAnimation = 0; int m_CurrentPageAnimationMax = 0; int m_PageAnimationDir = 0; float m_PageAnimationProgress = 0.0f; float m_PageAnimationStartPos = 0.0f; float m_PageAnimationOffset = 0.0f; Matrix4 m_Transform; Matrix4 m_TransformAnimationStart; Matrix4 m_TransformAnimationEnd; float m_TransformAnimationProgress = 0.0f; ULONGLONG m_TimeoutTickStart = 0; void SetUpOverlay(); void UpdateOverlayPos(); void OnPageChange(int page_id); public: WindowQuickStart(); virtual bool Show(); virtual void Hide(); void Update(); void Reset(); }; class WindowCaptureWindowSelect : public AuxUIWindow { private: ImVec2 m_PosCenter; Matrix4 m_Transform; HWND m_WindowLastClicked; ULONGLONG m_HoveredTickLast; void SetUpOverlay(); virtual void ApplyPendingValues(); public: WindowCaptureWindowSelect(); virtual bool Show(); void Update(); void SetTransform(Matrix4 transform); }; class AuxUI { friend class AuxUIWindow; private: AuxUIID m_ActiveUIID; bool m_IsUIFadingOut; WindowDragHint m_WindowDragHint; WindowGazeFadeAutoHint m_WindowGazeFadeAutoHint; WindowCaptureWindowSelect m_WindowCaptureWindowSelect; WindowQuickStart m_WindowQuickStart; bool SetActiveUI(AuxUIID new_ui_id); //May return false if higher priority UI is active AuxUIID GetActiveUI() const; void ClearActiveUI(AuxUIID current_ui_id); //Sets active UI to auxui_none, but current ID has to match active one bool IsUIFadingOut() const; void SetFadeOutFinished(); public: AuxUI(); void Update(); bool IsActive() const; void HideTemporaryWindows(); //Called on certain OpenVR events to hide temporary windows when user interaction ended so they don't hang around needlessly WindowDragHint& GetDragHintWindow(); WindowGazeFadeAutoHint& GetGazeFadeAutoHintWindow(); WindowCaptureWindowSelect& GetCaptureWindowSelectWindow(); WindowQuickStart& GetQuickStartWindow(); }; ================================================ FILE: src/DesktopPlusUI/DesktopPlusUI.cpp ================================================ //This code belongs to the Desktop+ OpenVR overlay application, licensed under GPL 3.0 // //Much of the code here is based on the Dear ImGui Win32 DirectX 11 sample #define NOMINMAX #include "imgui.h" #include "imgui_impl_win32_openvr.h" #include "imgui_impl_dx11_openvr.h" #include "implot.h" #include #include #define DIRECTINPUT_VERSION 0x0800 #include #include #include #include #include "resource.h" #include "UIManager.h" #include "TextureManager.h" #include "InterprocessMessaging.h" #include "WindowSettings.h" #include "Util.h" #include "OpenVRExt.h" #include "ImGuiExt.h" #include "DesktopPlusWinRT.h" #include "DPBrowserAPIClient.h" #include "WindowDesktopMode.h" // Data static Microsoft::WRL::ComPtr g_pd3dDevice; static Microsoft::WRL::ComPtr g_pd3dDeviceContext; static Microsoft::WRL::ComPtr g_pSwapChain; static Microsoft::WRL::ComPtr g_desktopRenderTargetView; static Microsoft::WRL::ComPtr g_vrTex; static Microsoft::WRL::ComPtr g_vrRenderTargetView; // Forward declarations of helper functions bool CreateDeviceD3D(HWND hWnd, bool desktop_mode); void CleanupDeviceD3D(); void CreateRenderTarget(bool desktop_mode); void CleanupRenderTarget(); void RefreshOverlayTextureSharing(); LRESULT WINAPI WndProc(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam); void InitImGui(HWND hwnd, bool desktop_mode); void ProcessCmdline(bool& force_desktop_mode, bool& open_keyboard_editor); // Main code int WINAPI WinMain(_In_ HINSTANCE hInstance, _In_opt_ HINSTANCE hPrevInstance, _In_ LPSTR lpCmdLine, _In_ INT nCmdShow) { DPLog_Init("DesktopPlusUI"); bool force_desktop_mode = false; bool open_keyboard_editor = false; ProcessCmdline(force_desktop_mode, open_keyboard_editor); //Automatically use desktop mode if dashboard app isn't running bool desktop_mode = ( (force_desktop_mode) || (!IPCManager::IsDashboardAppRunning()) ); LOG_F(INFO, "Desktop+ UI running in %s", (desktop_mode) ? ((open_keyboard_editor) ? "desktop mode (keyboard editor)" : "desktop mode") : "VR mode"); //Make sure only one instance is running StopProcessByWindowClass(g_WindowClassNameUIApp); //Enable DPI support for desktop mode ImGui_ImplWin32_EnableDpiAwareness(); //Register application class WNDCLASSEX wc = { sizeof(WNDCLASSEX), CS_CLASSDC, WndProc, 0L, 0L, hInstance, nullptr, nullptr, nullptr, nullptr, g_WindowClassNameUIApp, nullptr }; wc.hIcon = (HICON)::LoadImage(hInstance, MAKEINTRESOURCE(IDI_DPLUS), IMAGE_ICON, GetSystemMetrics(SM_CXICON), GetSystemMetrics(SM_CYICON), LR_DEFAULTCOLOR); wc.hIconSm = (HICON)::LoadImage(hInstance, MAKEINTRESOURCE(IDI_DPLUS), IMAGE_ICON, GetSystemMetrics(SM_CXSMICON), GetSystemMetrics(SM_CYSMICON), LR_DEFAULTCOLOR); ::RegisterClassEx(&wc); //Create window HWND hwnd; if (desktop_mode) hwnd = ::CreateWindow(wc.lpszClassName, L"Desktop+", WS_OVERLAPPED | WS_CAPTION | WS_SYSMENU | WS_MINIMIZEBOX, -1, -1, 100, 100, nullptr, nullptr, wc.hInstance, nullptr); else hwnd = ::CreateWindow(wc.lpszClassName, L"Desktop+ UI", 0, 0, 0, 1, 1, HWND_MESSAGE, nullptr, wc.hInstance, nullptr); //Init UITextureSpaces UITextureSpaces::Get().Init(desktop_mode, open_keyboard_editor); //Init WinRT DLL DPWinRT_Init(); LOG_F(INFO, "Loaded WinRT library"); //Init BrowserClientAPI (this doesn't start the browser process, only checks for presence) DPBrowserAPIClient::Get().Init(); //Allow IPC messages even when elevated (though in normal operation, this process should not be elevated) IPCManager::Get().DisableUIPForRegisteredMessages(hwnd); //Init UIManager and load config UIManager ui_manager(desktop_mode, open_keyboard_editor); UIManager::IdleState& idle_state = ui_manager.GetIdleState(); ConfigManager::Get().LoadConfigFromFile(); IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_sync_config_state); ui_manager.SetWindowHandle(hwnd); //Init OpenVR //Don't try to init OpenVR without the dashboard app running since checking for active VR means launching SteamVR if ( (!desktop_mode) || (IPCManager::IsDashboardAppRunning()) ) { if (ui_manager.InitOverlay() != vr::VRInitError_None) { ::UnregisterClass(wc.lpszClassName, wc.hInstance); LOG_F(ERROR, "OpenVR init failed!"); //Try starting in desktop mode instead if (!desktop_mode) { LOG_F(INFO, "Attempting to start in desktop mode instead..."); ui_manager.Restart(true); } return 2; } } DPLog_SteamVR_SystemInfo(); // Initialize Direct3D if (!CreateDeviceD3D(hwnd, desktop_mode)) { CleanupDeviceD3D(); ::UnregisterClass(wc.lpszClassName, wc.hInstance); LOG_F(ERROR, "Direct3D init failed!"); return 1; } LOG_F(INFO, "Loaded Direct3D"); //Center window to the right monitor before setting real size for DPI detection to be correct if (desktop_mode) { CenterWindowToMonitor(hwnd, true); } InitImGui(hwnd, desktop_mode); ImGuiIO& io = ImGui::GetIO(); LOG_F(INFO, "Loaded Dear ImGui"); if (desktop_mode) { const DPRect& rect_total = UITextureSpaces::Get().GetRect(ui_texspace_total); //Set real window size RECT r; r.left = 0; r.top = 0; r.right = int(rect_total.GetWidth() * ui_manager.GetUIScale()); r.bottom = int(rect_total.GetHeight() * ui_manager.GetUIScale()); ::AdjustWindowRect(&r, WS_OVERLAPPED | WS_CAPTION | WS_SYSMENU | WS_MINIMIZEBOX, FALSE); ::SetWindowPos(hwnd, NULL, 0, 0, r.right - r.left, r.bottom - r.top, SWP_NOMOVE | SWP_NOZORDER | SWP_NOACTIVATE); //Center window on screen CenterWindowToMonitor(hwnd, true); ::ShowWindow(hwnd, SW_SHOWDEFAULT); ::UpdateWindow(hwnd); } float clear_color[4] = {0.0f, 0.0f, 0.0f, 0.0f}; //Init notification icon if OpenVR is running (no need for it in pure desktop mode without switching back) if ( (!ConfigManager::GetValue(configid_bool_interface_no_notification_icon)) && (ui_manager.IsOpenVRLoaded()) ) { ui_manager.GetNotificationIcon().Init(hInstance); } ui_manager.OnInitDone(); LOG_F(INFO, "Finished startup"); //Main loop MSG msg; ZeroMemory(&msg, sizeof(msg)); while (msg.message != WM_QUIT) { //Poll and handle messages (inputs, window resize, etc.) if (::PeekMessage(&msg, NULL, 0U, 0U, PM_REMOVE)) { idle_state.OnWindowMessage(msg.message); if (msg.message >= 0xC000) //Custom message from overlay process, handle in UI manager { ui_manager.HandleIPCMessage(msg); } else { ::TranslateMessage(&msg); ::DispatchMessage(&msg); } continue; } if (!desktop_mode) { vr::VREvent_t vr_event; bool do_quit = false; //Handle OpenVR events for the dashboard UI ImVec4 rect_v4 = UITextureSpaces::Get().GetRectAsVec4(ui_texspace_overlay_bar); while (vr::VROverlay()->PollNextOverlayEvent(ui_manager.GetOverlayHandleOverlayBar(), &vr_event, sizeof(vr_event))) { idle_state.OnOpenVREvent(vr_event.eventType); ImGui_ImplOpenVR_InputEventHandler(vr_event, &rect_v4); switch (vr_event.eventType) { case vr::VREvent_FocusEnter: { //Adjust sort order so mainbar tooltips are displayed right vr::VROverlay()->SetOverlaySortOrder(ui_manager.GetOverlayHandleOverlayBar(), 1); break; } case vr::VREvent_FocusLeave: case vr::VREvent_OverlayHidden: { //Reset adjustment so other overlays are not always behind the UI unless really needed if (!ui_manager.GetOverlayBarWindow().IsAnyMenuVisible()) { vr::VROverlay()->SetOverlaySortOrder(ui_manager.GetOverlayHandleOverlayBar(), 0); } break; } case vr::VREvent_TrackedDeviceActivated: case vr::VREvent_TrackedDeviceDeactivated: { ui_manager.GetPerformanceWindow().RefreshTrackerBatteryList(); break; } case vr::VREvent_LeaveStandbyMode: { //Reset performance stats when leaving standby since it adds to the dropped frame count during that ui_manager.GetPerformanceWindow().ResetCumulativeValues(); break; } case vr::VREvent_OverlaySharedTextureChanged: { //This should only happen during startup since the texture size never changes, but it has happened seemingly randomly before, so handle it RefreshOverlayTextureSharing(); break; } case vr::VREvent_SceneApplicationChanged: { const bool loaded_overlay_profile = ConfigManager::Get().GetAppProfileManager().ActivateProfileForProcess(vr_event.data.process.pid); if (loaded_overlay_profile) { ui_manager.OnProfileLoaded(); } break; } case vr::VREvent_Quit: { do_quit = true; break; } } } //Handle OpenVR events for the floating UI rect_v4 = UITextureSpaces::Get().GetRectAsVec4(ui_texspace_floating_ui); while (vr::VROverlay()->PollNextOverlayEvent(ui_manager.GetOverlayHandleFloatingUI(), &vr_event, sizeof(vr_event))) { idle_state.OnOpenVREvent(vr_event.eventType); ImGui_ImplOpenVR_InputEventHandler(vr_event, &rect_v4); switch (vr_event.eventType) { case vr::VREvent_FocusEnter: { //Adjust sort order so tooltips are displayed right vr::VROverlay()->SetOverlaySortOrder(ui_manager.GetOverlayHandleFloatingUI(), 1); break; } case vr::VREvent_FocusLeave: { //Reset adjustment so other overlays are not always behind the UI unless really needed vr::VROverlay()->SetOverlaySortOrder(ui_manager.GetOverlayHandleFloatingUI(), 0); break; } } } //Handle OpenVR events for the floating settings rect_v4 = UITextureSpaces::Get().GetRectAsVec4(ui_texspace_settings); while (vr::VROverlay()->PollNextOverlayEvent(ui_manager.GetOverlayHandleSettings(), &vr_event, sizeof(vr_event))) { idle_state.OnOpenVREvent(vr_event.eventType); ImGui_ImplOpenVR_InputEventHandler(vr_event, &rect_v4); } //Handle OpenVR events for the overlay properties rect_v4 = UITextureSpaces::Get().GetRectAsVec4(ui_texspace_overlay_properties); while (vr::VROverlay()->PollNextOverlayEvent(ui_manager.GetOverlayHandleOverlayProperties(), &vr_event, sizeof(vr_event))) { idle_state.OnOpenVREvent(vr_event.eventType); ImGui_ImplOpenVR_InputEventHandler(vr_event); } //Handle OpenVR events for the VR keyboard rect_v4 = UITextureSpaces::Get().GetRectAsVec4(ui_texspace_keyboard); while (vr::VROverlay()->PollNextOverlayEvent(ui_manager.GetOverlayHandleKeyboard(), &vr_event, sizeof(vr_event))) { idle_state.OnOpenVREvent(vr_event.eventType); //Let the keyboard window handle events first for multi-laser support if (!ui_manager.GetVRKeyboard().GetWindow().HandleOverlayEvent(vr_event)) { ImGui_ImplOpenVR_InputEventHandler(vr_event, &rect_v4); } } //Handle OpenVR events for the Aux UI rect_v4 = UITextureSpaces::Get().GetRectAsVec4(ui_texspace_aux_ui); while (vr::VROverlay()->PollNextOverlayEvent(ui_manager.GetOverlayHandleAuxUI(), &vr_event, sizeof(vr_event))) { idle_state.OnOpenVREvent(vr_event.eventType); ImGui_ImplOpenVR_InputEventHandler(vr_event, &rect_v4); switch (vr_event.eventType) { case vr::VREvent_DashboardActivated: case vr::VREvent_DashboardDeactivated: { ui_manager.GetAuxUI().HideTemporaryWindows(); break; } } } ui_manager.PositionOverlay(); ui_manager.GetFloatingUI().UpdateUITargetState(); ui_manager.GetSettingsWindow().UpdateVisibility(); ui_manager.GetOverlayPropertiesWindow().UpdateVisibility(); ui_manager.GetVRKeyboard().GetWindow().UpdateVisibility(); if (do_quit) { break; //Breaks the message loop, causing clean shutdown } } ui_manager.GetPerformanceWindow().UpdateVisibleState(); //Do texture reload now if it had been scheduled //However, do not reload texture while an item is active as the ID changes on ImageButtons... but allow it if InputText is active to not have placeholder characters on user input if ( (TextureManager::Get().GetReloadLaterFlag()) && ( (!ImGui::IsAnyItemActiveOrDeactivated()) || (ImGui::IsAnyInputTextActive()) ) ) { TextureManager::Get().LoadAllTexturesAndBuildFonts(); } //While we still need to poll, greatly reduce the rate and don't do any ImGui stuff to not waste resources (hopefully this does not mess up ImGui input state) if ((idle_state.ShouldIdle()) && (!ui_manager.HasDelayedIPCMessages())) { ::Sleep(64); //Could wait longer, but it doesn't really make much of a difference in load and we stay more responsive like this) idle_state.DoIdleTimestep(); //Delta time won't be updated by ImGui while idle, but some parts of the app still rely on it so we do it ourselves continue; } // Start the Dear ImGui frame ImGui_ImplDX11_NewFrame(); if (desktop_mode) ImGui_ImplWin32_NewFrame(); else ImGui_ImplOpenVR_NewFrame(); idle_state.OnImGuiNewFrame(); ui_manager.GetVRKeyboard().OnImGuiNewFrame(); ImGui::NewFrame(); //Handle delayed ICP messages that need to be handled within an ImGui frame now ui_manager.HandleDelayedIPCMessages(); if (!desktop_mode) { //Overlay dragging needs to happen within an ImGui frame for a valid scroll input state (ImGui::EndFrame() clears it by the time we'd loop again) ui_manager.UpdateOverlayDrag(); //Make ImGui think the surface is smaller than it is (a poor man's multi-viewport hack) //Overlay Bar (this and floating UI need no X adjustments) io.DisplaySize.y = (float)UITextureSpaces::Get().GetRect(ui_texspace_overlay_bar).GetBR().y; ImGui::GetMainViewport()->Size.y = io.DisplaySize.y; ui_manager.GetOverlayBarWindow().Update(); //Floating UI io.DisplaySize.y = (float)UITextureSpaces::Get().GetRect(ui_texspace_floating_ui).GetBR().y; ImGui::GetMainViewport()->Size.y = io.DisplaySize.y; ui_manager.GetFloatingUI().Update(); //Overlay Properties io.DisplaySize.x = (float)UITextureSpaces::Get().GetRect(ui_texspace_overlay_properties).GetBR().x; ImGui::GetMainViewport()->Size.x = io.DisplaySize.x; io.DisplaySize.y = (float)UITextureSpaces::Get().GetRect(ui_texspace_overlay_properties).GetBR().y; ImGui::GetMainViewport()->Size.y = io.DisplaySize.y; ui_manager.GetOverlayPropertiesWindow().Update(); //Settings io.DisplaySize.x = (float)UITextureSpaces::Get().GetRect(ui_texspace_settings).GetBR().x; ImGui::GetMainViewport()->Size.x = io.DisplaySize.x; io.DisplaySize.y = (float)UITextureSpaces::Get().GetRect(ui_texspace_settings).GetBR().y; ImGui::GetMainViewport()->Size.y = io.DisplaySize.y; ui_manager.GetSettingsWindow().Update(); //Keyboard io.DisplaySize.x = (float)UITextureSpaces::Get().GetRect(ui_texspace_keyboard).GetBR().x; ImGui::GetMainViewport()->Size.x = io.DisplaySize.x; io.DisplaySize.y = (float)UITextureSpaces::Get().GetRect(ui_texspace_keyboard).GetBR().y; ImGui::GetMainViewport()->Size.y = io.DisplaySize.y; ui_manager.GetVRKeyboard().GetWindow().Update(); //Performance Monitor io.DisplaySize.x = (float)UITextureSpaces::Get().GetRect(ui_texspace_performance_monitor).GetBR().x; ImGui::GetMainViewport()->Size.x = io.DisplaySize.x; io.DisplaySize.y = (float)UITextureSpaces::Get().GetRect(ui_texspace_performance_monitor).GetBR().y; ImGui::GetMainViewport()->Size.y = io.DisplaySize.y; ui_manager.GetPerformanceWindow().Update(); //Aux UI io.DisplaySize.x = (float)UITextureSpaces::Get().GetRect(ui_texspace_aux_ui).GetBR().x; ImGui::GetMainViewport()->Size.x = io.DisplaySize.x; io.DisplaySize.y = (float)UITextureSpaces::Get().GetRect(ui_texspace_aux_ui).GetBR().y; ImGui::GetMainViewport()->Size.y = io.DisplaySize.y; ui_manager.GetAuxUI().Update(); } else { if (open_keyboard_editor) { ui_manager.GetVRKeyboard().GetEditor().Update(); } else { ui_manager.GetDesktopModeWindow().Update(); } } //Haptic feedback for hovered items, like the rest of the SteamVR UI if ( (!desktop_mode) && (ImGui::HasHoveredNewItem()) ) { for (const auto& overlay_handle : ui_manager.GetUIOverlayHandles()) { if (ConfigManager::Get().IsLaserPointerTargetOverlay(overlay_handle)) { ui_manager.TriggerLaserPointerHaptics(overlay_handle); } } } // Rendering if (ui_manager.GetRepeatFrame()) //If frame repeat is enabled, don't actually render and skip vsync { ImGui::EndFrame(); ui_manager.DecreaseRepeatFrameCount(); } else { ImGui::Render(); if (desktop_mode) { g_pd3dDeviceContext->OMSetRenderTargets(1, g_desktopRenderTargetView.GetAddressOf(), nullptr); g_pd3dDeviceContext->ClearRenderTargetView(g_desktopRenderTargetView.Get(), clear_color); ImGui_ImplDX11_RenderDrawData(ImGui::GetDrawData()); const int sync_count = idle_state.GetFrameSkipValue() + 1; HRESULT res = g_pSwapChain->Present(std::min(sync_count, 4), 0); //Present with vsync (and optionally wait longer with frameskip) if (res == DXGI_STATUS_OCCLUDED) //When occluded, Present() will not wait for us { for (int i = 0; i < sync_count; ++i) { ::DwmFlush(); //We could wait longer, but let's stay responsive } } } else { g_pd3dDeviceContext->OMSetRenderTargets(1, g_vrRenderTargetView.GetAddressOf(), nullptr); g_pd3dDeviceContext->ClearRenderTargetView(g_vrRenderTargetView.Get(), clear_color); ImGui_ImplDX11_RenderDrawData(ImGui::GetDrawData()); //Set Overlay texture ID3D11ShaderResourceView* ovrl_shader_rsv = vr::VROverlayEx()->GetOverlayTextureEx(ui_manager.GetOverlayHandleOverlayBar(), g_vrTex.Get()); if (ovrl_shader_rsv != nullptr) { //Do a partial update, only copying the active texture space into the overlay texture Microsoft::WRL::ComPtr ovrl_tex; ovrl_shader_rsv->GetResource(&ovrl_tex); const DPRect active_rect = ui_manager.CalcRectForActiveTexspace(); if (active_rect.GetWidth() != 0) { D3D11_BOX box = {0}; box.left = active_rect.GetTL().x; box.top = active_rect.GetTL().y; box.front = 0; box.right = active_rect.GetBR().x; box.bottom = active_rect.GetBR().y; box.back = 1; g_pd3dDeviceContext->CopySubresourceRegion(ovrl_tex.Get(), 0, box.left, box.top, 0, g_vrTex.Get(), 0, &box); } //RSV is kept around by IVROverlayEx and not released here } else if ((ui_manager.GetOverlayHandleOverlayBar() != vr::k_ulOverlayHandleInvalid) && (g_vrTex)) { vr::Texture_t vrtex = {}; vrtex.handle = g_vrTex.Get(); vrtex.eType = vr::TextureType_DirectX; vrtex.eColorSpace = vr::ColorSpace_Gamma; vr::VROverlayEx()->SetOverlayTextureEx(ui_manager.GetOverlayHandleOverlayBar(), &vrtex, {(int)io.DisplaySize.x, (int)io.DisplaySize.y}); } //Set overlay intersection mask... there doesn't seem to be much overhead from doing this every frame, even though we only need to update this sometimes auto overlay_handles = ui_manager.GetUIOverlayHandles(); std::vector mask_primitives; ImGui_ImplOpenVR_SetIntersectionMaskFromWindows(overlay_handles.data(), overlay_handles.size(), &mask_primitives); ui_manager.SendUIIntersectionMaskToDashboardApp(mask_primitives); //Wait for VR frame sync, optionally repeatedly to achieve lower synched frame rates g_pd3dDeviceContext->Flush(); const int sync_count = idle_state.GetFrameSkipValue() + 1; for (int i = 0; i < sync_count; ++i) { vr::VROverlay()->WaitFrameSync(34); //(34 ms timeout so we don't go much below 30 fps worst case) } } } } LOG_F(INFO, "Shutting down..."); // Cleanup ui_manager.OnExit(); ImGui_ImplDX11_Shutdown(); ImGui_ImplWin32_Shutdown(); ImPlot::DestroyContext(); ImGui::DestroyContext(); CleanupDeviceD3D(); ::DestroyWindow(hwnd); ::UnregisterClass(wc.lpszClassName, wc.hInstance); return 0; } // Helper functions bool CreateDeviceD3D(HWND hWnd, bool desktop_mode) { const UINT target_adapter_deviceid = (ConfigManager::GetValue(configid_int_misc_force_gpu_deviceid) == -1) ? 0 : (UINT)ConfigManager::GetValue(configid_int_misc_force_gpu_deviceid); const UINT target_adapter_deviceid_vr = (ConfigManager::GetValue(configid_int_misc_force_gpu_vr_deviceid) == -1) ? 0 : (UINT)ConfigManager::GetValue(configid_int_misc_force_gpu_vr_deviceid); //Get forced adapter if any and get the adapter recommended by OpenVR if it's loaded (needed for Performance Monitor even in desktop mode) Microsoft::WRL::ComPtr adapter_ptr_vr; Microsoft::WRL::ComPtr adapter_ptr_desktop; //stays nullptr unless forced { Microsoft::WRL::ComPtr factory_ptr; int32_t vr_gpu_id = -1; if (UIManager::Get()->IsOpenVRLoaded()) { vr::VRSystem()->GetDXGIOutputInfo(&vr_gpu_id); } HRESULT hr = CreateDXGIFactory1(__uuidof(IDXGIFactory1), (void**)&factory_ptr); if (!FAILED(hr)) { Microsoft::WRL::ComPtr adapter_ptr; UINT i = 0; while (factory_ptr->EnumAdapters(i, &adapter_ptr) != DXGI_ERROR_NOT_FOUND) { DXGI_ADAPTER_DESC adapter_desc; adapter_ptr->GetDesc(&adapter_desc); if ( ((target_adapter_deviceid_vr == 0) && (i == vr_gpu_id)) || (adapter_desc.DeviceId == target_adapter_deviceid_vr) ) { adapter_ptr_vr = adapter_ptr; } if (adapter_desc.DeviceId == target_adapter_deviceid) { adapter_ptr_desktop = adapter_ptr; } ++i; } } if (adapter_ptr_vr != nullptr) { //Set target GPU and total VRAM for Performance Monitor DXGI_ADAPTER_DESC adapter_desc; if (adapter_ptr_vr->GetDesc(&adapter_desc) == S_OK) { UIManager::Get()->GetPerformanceWindow().GetPerformanceData().SetTargetGPU(adapter_desc.AdapterLuid, adapter_desc.DedicatedVideoMemory); } } LOG_IF_F(WARNING, (adapter_ptr_desktop == nullptr) && (target_adapter_deviceid != 0), "GPU forced by config (DeviceID %u) was not found!", target_adapter_deviceid); LOG_IF_F(WARNING, (adapter_ptr_vr == nullptr) && (target_adapter_deviceid_vr == 0) && UIManager::Get()->IsOpenVRLoaded(), "GPU requested by SteamVR (%u) was not found!", vr_gpu_id + 1); LOG_IF_F(WARNING, (adapter_ptr_vr == nullptr) && (target_adapter_deviceid_vr != 0), "VR GPU forced by config (DeviceID %u) was not found!", target_adapter_deviceid_vr); } D3D_FEATURE_LEVEL featureLevel; const D3D_FEATURE_LEVEL featureLevelArray[2] = { D3D_FEATURE_LEVEL_11_0, D3D_FEATURE_LEVEL_10_0, }; if (desktop_mode) { //Setup swap chain DXGI_SWAP_CHAIN_DESC sd; ZeroMemory(&sd, sizeof(sd)); sd.BufferCount = 2; sd.BufferDesc.Width = 0; sd.BufferDesc.Height = 0; sd.BufferDesc.Format = DXGI_FORMAT_R8G8B8A8_UNORM; sd.BufferDesc.RefreshRate.Numerator = 60; sd.BufferDesc.RefreshRate.Denominator = 1; sd.Flags = DXGI_SWAP_CHAIN_FLAG_ALLOW_MODE_SWITCH; sd.BufferUsage = DXGI_USAGE_RENDER_TARGET_OUTPUT; sd.OutputWindow = hWnd; sd.SampleDesc.Count = 1; sd.SampleDesc.Quality = 0; sd.Windowed = TRUE; sd.SwapEffect = DXGI_SWAP_EFFECT_FLIP_SEQUENTIAL; //DXGI_SWAP_EFFECT_FLIP_DISCARD also would work, but we still support Windows 8 if (D3D11CreateDeviceAndSwapChain(adapter_ptr_desktop.Get(), (adapter_ptr_desktop != nullptr) ? D3D_DRIVER_TYPE_UNKNOWN : D3D_DRIVER_TYPE_HARDWARE, nullptr, 0, featureLevelArray, 2, D3D11_SDK_VERSION, &sd, &g_pSwapChain, &g_pd3dDevice, &featureLevel, &g_pd3dDeviceContext) != S_OK) { return false; } } else { //No swap chain needed for VR if (adapter_ptr_vr != nullptr) { if (D3D11CreateDevice(adapter_ptr_vr.Get(), D3D_DRIVER_TYPE_UNKNOWN, nullptr, 0, featureLevelArray, 2, D3D11_SDK_VERSION, &g_pd3dDevice, &featureLevel, &g_pd3dDeviceContext) != S_OK) { return false; } } else //Still try /something/, but it probably won't work { if (D3D11CreateDevice(nullptr, D3D_DRIVER_TYPE_HARDWARE, nullptr, 0, featureLevelArray, 2, D3D11_SDK_VERSION, &g_pd3dDevice, &featureLevel, &g_pd3dDeviceContext) != S_OK) { return false; } } } CreateRenderTarget(desktop_mode); return true; } void CleanupDeviceD3D() { CleanupRenderTarget(); g_pSwapChain.Reset(); g_pd3dDeviceContext.Reset(); g_pd3dDevice.Reset(); } void CreateRenderTarget(bool desktop_mode) { HRESULT hr; const DPRect& texrect_total = UITextureSpaces::Get().GetRect(ui_texspace_total); // Create overlay texture D3D11_TEXTURE2D_DESC TexD; RtlZeroMemory(&TexD, sizeof(D3D11_TEXTURE2D_DESC)); TexD.Width = texrect_total.GetWidth(); TexD.Height = texrect_total.GetHeight(); TexD.MipLevels = 1; TexD.ArraySize = 1; TexD.Format = DXGI_FORMAT_B8G8R8A8_UNORM; TexD.SampleDesc.Count = 1; TexD.Usage = D3D11_USAGE_DEFAULT; TexD.BindFlags = D3D11_BIND_RENDER_TARGET | D3D11_BIND_SHADER_RESOURCE; TexD.CPUAccessFlags = 0; TexD.MiscFlags = D3D11_RESOURCE_MISC_SHARED; hr = g_pd3dDevice->CreateTexture2D(&TexD, nullptr, &g_vrTex); if (FAILED(hr)) { //Cry return; } UIManager::Get()->SetSharedTextureRef(g_vrTex.Get()); // Create render target view for overlay texture D3D11_RENDER_TARGET_VIEW_DESC tex_rtv_desc = {}; tex_rtv_desc.Format = DXGI_FORMAT_B8G8R8A8_UNORM; tex_rtv_desc.ViewDimension = D3D11_RTV_DIMENSION_TEXTURE2D; tex_rtv_desc.Texture2D.MipSlice = 0; g_pd3dDevice->CreateRenderTargetView(g_vrTex.Get(), &tex_rtv_desc, &g_vrRenderTargetView); if (desktop_mode) { Microsoft::WRL::ComPtr pBackBuffer; g_pSwapChain->GetBuffer(0, IID_PPV_ARGS(&pBackBuffer)); if (pBackBuffer != nullptr) { g_pd3dDevice->CreateRenderTargetView(pBackBuffer.Get(), nullptr, &g_desktopRenderTargetView); } } } void CleanupRenderTarget() { g_desktopRenderTargetView.Reset(); g_vrRenderTargetView.Reset(); g_vrTex.Reset(); } void RefreshOverlayTextureSharing() { //Set up advanced texture sharing between the overlays vr::VROverlayEx()->SetSharedOverlayTexture(UIManager::Get()->GetOverlayHandleOverlayBar(), UIManager::Get()->GetOverlayHandleFloatingUI(), g_vrTex.Get()); vr::VROverlayEx()->SetSharedOverlayTexture(UIManager::Get()->GetOverlayHandleOverlayBar(), UIManager::Get()->GetOverlayHandleSettings(), g_vrTex.Get()); vr::VROverlayEx()->SetSharedOverlayTexture(UIManager::Get()->GetOverlayHandleOverlayBar(), UIManager::Get()->GetOverlayHandleOverlayProperties(), g_vrTex.Get()); vr::VROverlayEx()->SetSharedOverlayTexture(UIManager::Get()->GetOverlayHandleOverlayBar(), UIManager::Get()->GetOverlayHandleKeyboard(), g_vrTex.Get()); vr::VROverlayEx()->SetSharedOverlayTexture(UIManager::Get()->GetOverlayHandleOverlayBar(), UIManager::Get()->GetOverlayHandleAuxUI(), g_vrTex.Get()); //Also schedule for performance overlays, in case there are any UIManager::Get()->GetPerformanceWindow().ScheduleOverlaySharedTextureUpdate(); } // Win32 message handler extern LRESULT ImGui_ImplWin32_WndProcHandler(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam); LRESULT WINAPI WndProc(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam) { if ((UIManager::Get()) && (UIManager::Get()->IsInDesktopMode())) { ImGui_ImplWin32_WndProcHandler(hWnd, msg, wParam, lParam); } switch (msg) { case WM_SIZE: { if (g_pd3dDevice != nullptr && wParam != SIZE_MINIMIZED) { CleanupRenderTarget(); g_pSwapChain->ResizeBuffers(0, (UINT)LOWORD(lParam), (UINT)HIWORD(lParam), DXGI_FORMAT_UNKNOWN, 0); CreateRenderTarget(UIManager::Get()->IsInDesktopMode()); } return 0; } case WM_DPICHANGED: { UIManager::Get()->OnDPIChanged(HIWORD(wParam), *(RECT*)lParam); return 0; } case WM_COPYDATA: { if (UIManager::Get()) { MSG pmsg; //Process all custom window messages posted before this while (PeekMessage(&pmsg, nullptr, 0xC000, 0xFFFF, PM_REMOVE)) { UIManager::Get()->HandleIPCMessage(pmsg); } MSG wmsg; wmsg.hwnd = hWnd; wmsg.message = msg; wmsg.wParam = wParam; wmsg.lParam = lParam; UIManager::Get()->HandleIPCMessage(wmsg); } return 0; } case WM_SYSCOMMAND: { if ((wParam & 0xfff0) == SC_KEYMENU) // Disable ALT application menu { return 0; } break; } case WM_DESTROY: { ::PostQuitMessage(0); return 0; } } return ::DefWindowProc(hWnd, msg, wParam, lParam); } void InitImGui(HWND hwnd, bool desktop_mode) { //Setup Dear ImGui context IMGUI_CHECKVERSION(); ImGui::CreateContext(); ImPlot::CreateContext(); ImGuiIO& io = ImGui::GetIO(); //Enable keyboard controls when in desktop mode if (desktop_mode) io.ConfigFlags |= ImGuiConfigFlags_NavEnableKeyboard; io.IniFilename = nullptr; //We don't need any imgui.ini support io.ConfigInputTrickleEventQueue = false; //Opt out of input trickling since it doesn't play well with VR scrolling (and lowers responsiveness on certain inputs) ImGui::ConfigDisableCtrlTab(); //Use system double-click time in desktop mode, but set it to something VR-trigger-friendly otherwise io.MouseDoubleClickTime = (desktop_mode) ? ::GetDoubleClickTime() / 1000.0f : 0.50f; io.MouseDoubleClickMaxDist = 16.0f; //Setup Platform/Renderer bindings ImGui_ImplWin32_Init(hwnd); ImGui_ImplDX11_Init(g_pd3dDevice.Get(), g_pd3dDeviceContext.Get()); UIManager::Get()->UpdateStyle(); } void ProcessCmdline(bool& force_desktop_mode, bool& open_keyboard_editor) { //__argv and __argc are global vars set by system for (UINT i = 0; i < static_cast(__argc); ++i) { if ((strcmp(__argv[i], "-DesktopMode") == 0) || (strcmp(__argv[i], "--DesktopMode") == 0) || (strcmp(__argv[i], "/DesktopMode") == 0)) { force_desktop_mode = true; } else if ((strcmp(__argv[i], "-KeyboardEditor") == 0) || (strcmp(__argv[i], "--KeyboardEditor") == 0) || (strcmp(__argv[i], "/KeyboardEditor") == 0)) { open_keyboard_editor = true; force_desktop_mode = true; } } } ================================================ FILE: src/DesktopPlusUI/DesktopPlusUI.vcxproj ================================================  Debug x64 Release x64 {14405CEC-DF3D-435E-8F11-B79BAC56D7D8} DesktopPlusUI DesktopPlusUI Application true v142 Unicode Application false v142 true Unicode true ..\DesktopPlus\DesktopPlus.ruleset false ..\DesktopPlus\DesktopPlus.ruleset Level3 Disabled LOGURU_FILENAME_WIDTH=30;LOGURU_VERBOSE_SCOPE_ENDINGS=0;DPLUS_UI;DPLUS_SHA=$(DPLUS_SHA);_DEBUG;_WINDOWS;%(PreprocessorDefinitions) .\imgui_win32_dx11_openvr;.\imgui;.\implot;$(OutDir);..\Shared;..\DesktopPlusUI;..\DesktopPlusWinRT;%(AdditionalIncludeDirectories) MultiThreadedDebug 26812;%(DisableSpecificWarnings) true Windows true d3d11.lib;dxgi.lib;dwmapi.lib;openvr_api.lib;gdiplus.lib;shcore.lib;shlwapi.lib;pdh.lib;DesktopPlusWinRT.lib;%(AdditionalDependencies) $(SolutionDir)Shared;$(OutputPath) Level3 Full true true LOGURU_FILENAME_WIDTH=30;LOGURU_VERBOSE_SCOPE_ENDINGS=0;DPLUS_UI;DPLUS_SHA=$(DPLUS_SHA);NDEBUG;_WINDOWS;%(PreprocessorDefinitions) .\imgui_win32_dx11_openvr;.\imgui;.\implot;$(OutDir);..\Shared;..\DesktopPlusUI;..\DesktopPlusWinRT;%(AdditionalIncludeDirectories) true MultiThreaded 26812;%(DisableSpecificWarnings) None true Speed AnySuitable Windows true true false d3d11.lib;dxgi.lib;dwmapi.lib;openvr_api.lib;gdiplus.lib;shcore.lib;shlwapi.lib;pdh.lib;DesktopPlusWinRT.lib;%(AdditionalDependencies) $(SolutionDir)Shared;$(OutputPath) Pixel 4.0_level_9_1 Pixel $(OutDir)%(Filename).h $(OutDir)%(Filename).h PS PS Vertex Vertex 4.0_level_9_1 $(OutDir)%(Filename).h $(OutDir)%(Filename).h VS VS ================================================ FILE: src/DesktopPlusUI/DesktopPlusUI.vcxproj.filters ================================================  {cf9e2ac6-b93d-4ce4-be2b-2dceec48ea9c} {02f38889-5b36-40a8-a60d-60d4016baec4} {2fac41b3-89b4-4cdf-9924-e4d9ae01e9e3} {accae70c-9225-413f-823d-dd068cbb1b5f} ImGui ImGui ImGui ImGui ImGui Win32/DX11/OpenVR ImGui Win32/DX11/OpenVR Shared Shared Shared Shared Shared Shared Shared ImPlot ImPlot ImGui Shared Shared Shared Shared Shared Shared Shared ImGui ImGui ImGui ImGui ImGui ImGui ImGui Win32/DX11/OpenVR ImGui Win32/DX11/OpenVR Shared Shared Shared Shared Shared Shared Shared Shared Shared Shared ImPlot ImPlot Shared Shared Shared Shared Shared Shared Shared Shared ImGui Win32/DX11/OpenVR ImGui Win32/DX11/OpenVR ================================================ FILE: src/DesktopPlusUI/DesktopPlusUI.vcxproj.user ================================================  false $(OutputPath) WindowsLocalDebugger -DesktopMode $(OutputPath) WindowsLocalDebugger ================================================ FILE: src/DesktopPlusUI/FloatingUI.cpp ================================================ #include "FloatingUI.h" #include "UIManager.h" #include "OverlayManager.h" #include "InterprocessMessaging.h" #include "Util.h" #include "OpenVRExt.h" FloatingUI::FloatingUI() : m_OvrlHandleCurrentUITarget(vr::k_ulOverlayHandleInvalid), m_OvrlIDCurrentUITarget(0), m_Width(1.0f), m_Alpha(0.0f), m_Visible(false), m_IsSwitchingTarget(false), m_FadeOutDelayCount(0.0f), m_AutoFitFrames(0), m_TheaterOffsetAnimationProgress(0.0f) { } void FloatingUI::Update() { if ( (m_Alpha != 0.0f) || (m_Visible) ) { vr::VROverlayHandle_t ovrl_handle_floating_ui = UIManager::Get()->GetOverlayHandleFloatingUI(); if ( (m_Alpha == 0.0f) && (m_AutoFitFrames == 0) ) //Overlay was hidden before { vr::VROverlay()->ShowOverlay(ovrl_handle_floating_ui); OverlayConfigData& overlay_data = OverlayManager::Get().GetConfigData(m_OvrlIDCurrentUITarget); //Instantly adjust action bar visibility to overlay state before fading in if (overlay_data.ConfigBool[configid_bool_overlay_actionbar_enabled]) { m_WindowActionBar.Show(true); } else { m_WindowActionBar.Hide(true); } //Give ImGui its two auto-fit frames it typically needs to rearrange widgets properly should they have changed from the last time FloatingUI was visible m_AutoFitFrames = 2; } //Alpha fade animation if ( (!UIManager::Get()->GetRepeatFrame()) && (m_AutoFitFrames == 0) ) { const float alpha_step = ImGui::GetIO().DeltaTime * 6.0f; m_Alpha += (m_Visible) ? alpha_step : -alpha_step; } if (m_Alpha > 1.0f) m_Alpha = 1.0f; else if (m_Alpha < 0.0f) m_Alpha = 0.0f; vr::VROverlay()->SetOverlayAlpha(ovrl_handle_floating_ui, m_Alpha); if ( (m_Alpha == 0.0f) && (m_AutoFitFrames == 0) ) //Overlay was visible before { vr::VROverlay()->HideOverlay(ovrl_handle_floating_ui); m_WindowActionBar.Hide(true); //In case we were switching targets, reset switching state and target overlay m_IsSwitchingTarget = false; m_OvrlHandleCurrentUITarget = vr::k_ulOverlayHandleInvalid; m_OvrlIDCurrentUITarget = 0; //Request sync if drag-mode is still active while the UI is disappearing if (ConfigManager::GetValue(configid_bool_state_overlay_dragmode)) { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_transform_sync, -1); } } else if (m_Visible) //Make sure the input method is always set when visible, even after partial fade-out { if (!ConfigManager::GetValue(configid_bool_state_overlay_dragmode_temp)) { vr::VROverlay()->SetOverlayInputMethod(ovrl_handle_floating_ui, vr::VROverlayInputMethod_Mouse); } } } if ( (m_Alpha != 0.0f) || (m_AutoFitFrames != 0) ) { OverlayConfigData& overlay_data = OverlayManager::Get().GetConfigData(m_OvrlIDCurrentUITarget); //If action bar state was changed if (overlay_data.ConfigBool[configid_bool_overlay_actionbar_enabled]) { m_WindowActionBar.Show(); } else { m_WindowActionBar.Hide(); } m_WindowActionBar.Update(m_OvrlIDCurrentUITarget); m_WindowMainBar.Update(m_WindowActionBar.GetSize().y, m_OvrlIDCurrentUITarget); m_WindowOverlayStats.Update(m_WindowMainBar, m_WindowActionBar, m_OvrlIDCurrentUITarget); if (m_AutoFitFrames > 0) { m_AutoFitFrames--; UIManager::Get()->RepeatFrame(); if (m_AutoFitFrames == 0) { m_Alpha += ImGui::GetIO().DeltaTime * 6.0f; } } } } void FloatingUI::UpdateUITargetState() { UIManager& ui_manager = *UIManager::Get(); vr::VROverlayHandle_t ovrl_handle_floating_ui = ui_manager.GetOverlayHandleFloatingUI(); //Find which overlay is being hovered vr::VROverlayHandle_t ovrl_handle_hover_target = vr::k_ulOverlayHandleInvalid; unsigned int ovrl_id_hover_target = k_ulOverlayID_None; //Also find primary dashboard overlay as fallback to always display when available vr::VROverlayHandle_t ovrl_handle_primary_dashboard = vr::k_ulOverlayHandleInvalid; unsigned int ovrl_id_primary_dashboard = k_ulOverlayID_None; const bool has_pointer_device = (ConfigManager::Get().GetPrimaryLaserPointerDevice() != vr::k_unTrackedDeviceIndexInvalid); //If previous target overlay is no longer visible if ( (m_OvrlHandleCurrentUITarget != vr::k_ulOverlayHandleInvalid) && (!vr::VROverlay()->IsOverlayVisible(m_OvrlHandleCurrentUITarget)) ) { m_FadeOutDelayCount = 100.0f; //Disable input so the pointer will no longer hit the UI window vr::VROverlay()->SetOverlayInputMethod(ovrl_handle_floating_ui, vr::VROverlayInputMethod_None); } else if ( (has_pointer_device) && (ConfigManager::Get().IsLaserPointerTargetOverlay(ovrl_handle_floating_ui)) ) //Use as target Floating UI if it's hovered { ovrl_handle_hover_target = ovrl_handle_floating_ui; } //Don't show while reordering overlays since config changes may cause the UI to jump around while doing that if ( (ovrl_handle_hover_target == vr::k_ulOverlayHandleInvalid) && (!ConfigManager::GetValue(configid_bool_state_overlay_dragmode_temp)) && (!UIManager::Get()->GetOverlayBarWindow().IsDraggingOverlayButtons()) ) { if (has_pointer_device) { for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { const OverlayConfigData& data = OverlayManager::Get().GetConfigData(i); vr::VROverlayHandle_t ovrl_handle = data.ConfigHandle[configid_handle_overlay_state_overlay_handle]; if (ovrl_handle != vr::k_ulOverlayHandleInvalid) { //Check if this is the primary dashboard overlay if ( (ovrl_id_primary_dashboard == k_ulOverlayID_None) && (data.ConfigInt[configid_int_overlay_origin] == ovrl_origin_dashboard) && (data.ConfigInt[configid_int_overlay_display_mode] != ovrl_dispmode_scene) ) { //First dashboard origin with non-scene display mode is considered to be the primary dashboard overlay, but only really use it if enabled with FloatingUI on and in dashboard if ( (data.ConfigBool[configid_bool_overlay_enabled]) && (data.ConfigBool[configid_bool_overlay_floatingui_enabled]) && (UIManager::Get()->IsOverlayBarOverlayVisible()) && (vr::VROverlay()->IsOverlayVisible(ovrl_handle)) ) { ovrl_handle_primary_dashboard = ovrl_handle; ovrl_id_primary_dashboard = i; } } //Check if this the hover target overlay if ( (data.ConfigBool[configid_bool_overlay_floatingui_enabled]) && (ConfigManager::Get().IsLaserPointerTargetOverlay(ovrl_handle)) ) { ovrl_handle_hover_target = ovrl_handle; ovrl_id_hover_target = i; //Break here unless we still need to find the primary dashboard overlay if (ovrl_id_primary_dashboard != k_ulOverlayID_None) { break; } } } } //Use fallback primary dashboard overlay if no hover target was found if ( (ovrl_handle_hover_target == vr::k_ulOverlayHandleInvalid) && (m_FadeOutDelayCount == 0) && ((m_OvrlHandleCurrentUITarget == vr::k_ulOverlayHandleInvalid) || (m_OvrlHandleCurrentUITarget == ovrl_handle_primary_dashboard)) ) { ovrl_handle_hover_target = ovrl_handle_primary_dashboard; ovrl_id_hover_target = ovrl_id_primary_dashboard; } } } bool is_newly_visible = false; //Check if we're switching from another active overlay hover target, in which case we want to fade out completely first if ( (m_OvrlHandleCurrentUITarget != vr::k_ulOverlayHandleInvalid) && (ovrl_handle_hover_target != vr::k_ulOverlayHandleInvalid) && (ovrl_handle_hover_target != ovrl_handle_floating_ui) && (ovrl_handle_hover_target != m_OvrlHandleCurrentUITarget) ) { m_IsSwitchingTarget = true; m_Visible = false; UIManager::Get()->GetIdleState().AddActiveTime(); return; } else if ( (ovrl_handle_hover_target != ovrl_handle_floating_ui) && (ovrl_handle_hover_target != vr::k_ulOverlayHandleInvalid) ) { if ( (!m_Visible) && (m_Alpha == 0.0f) ) { is_newly_visible = true; UIManager::Get()->GetIdleState().AddActiveTime(); } m_OvrlHandleCurrentUITarget = ovrl_handle_hover_target; m_OvrlIDCurrentUITarget = ovrl_id_hover_target; m_Visible = true; } //If there is an active hover target overlay, position the floating UI if (m_OvrlHandleCurrentUITarget != vr::k_ulOverlayHandleInvalid) { OverlayConfigData& overlay_data = OverlayManager::Get().GetConfigData(m_OvrlIDCurrentUITarget); Matrix4 matrix = OverlayManager::Get().GetOverlayCenterBottomTransform(m_OvrlIDCurrentUITarget, m_OvrlHandleCurrentUITarget); //If the Floating UI is just appearing, adjust overlay size based on the distance between HMD and overlay if (is_newly_visible) { bool use_fixed_size = false; //Use fixed size when using primary dashboard overlay fallback and distance to dashboard is lower than 0.25m if (ovrl_handle_primary_dashboard == m_OvrlHandleCurrentUITarget) { //Use relative transform data here as dashboard transform can be unreliable during launch const float distance = overlay_data.ConfigTransform.getTranslation().distance({0.0f, 0.0f, 0.0f}); use_fixed_size = (distance < 0.25f); m_Width = 1.2f; vr::VROverlay()->SetOverlayWidthInMeters(ovrl_handle_floating_ui, m_Width); } else if (overlay_data.ConfigInt[configid_int_overlay_origin] == ovrl_origin_theater_screen) //Fixed size for theater screen too { m_Width = 3.0f; vr::VROverlay()->SetOverlayWidthInMeters(ovrl_handle_floating_ui, m_Width); } else { vr::TrackedDevicePose_t poses[vr::k_unTrackedDeviceIndex_Hmd + 1]; vr::VRSystem()->GetDeviceToAbsoluteTrackingPose(vr::TrackingUniverseStanding, vr::IVRSystemEx::GetTimeNowToPhotons(), poses, vr::k_unTrackedDeviceIndex_Hmd + 1); if (poses[vr::k_unTrackedDeviceIndex_Hmd].bPoseIsValid) { Matrix4 mat_hmd = poses[vr::k_unTrackedDeviceIndex_Hmd].mDeviceToAbsoluteTracking; float distance = matrix.getTranslation().distance(mat_hmd.getTranslation()); m_Width = 0.66f + (0.5f * distance); vr::VROverlay()->SetOverlayWidthInMeters(ovrl_handle_floating_ui, m_Width); } } } //Move down by Floating UI height const DPRect& rect_floating_ui = UITextureSpaces::Get().GetRect(ui_texspace_floating_ui); const float floating_ui_height_m = m_Width * ((float)rect_floating_ui.GetHeight() / (float)rect_floating_ui.GetWidth()); matrix.translate_relative(0.0f, -floating_ui_height_m / 3.0f, 0.0f); //Additional offset for theater screen if (overlay_data.ConfigInt[configid_int_overlay_origin] == ovrl_origin_theater_screen) { //SteamVR's control bar is only shown while system laser pointer is active, so only add offset if that's the case const bool add_offset = vr::IVROverlayEx::IsSystemLaserPointerActive(); if (is_newly_visible) { m_TheaterOffsetAnimationProgress = (add_offset) ? 1.0f : 0.0f; } else //Also animate this { const float time_step = ImGui::GetIO().DeltaTime * 6.0f; m_TheaterOffsetAnimationProgress += (add_offset) ? time_step : -time_step; if (m_TheaterOffsetAnimationProgress > 1.0f) m_TheaterOffsetAnimationProgress = 1.0f; else if (m_TheaterOffsetAnimationProgress < 0.0f) m_TheaterOffsetAnimationProgress = 0.0f; } matrix.translate_relative(0.0f, smoothstep(m_TheaterOffsetAnimationProgress, 0.0f, -0.29f), 0.0f); } //Don't update position if dummy transform is unstable unless it's target is not primary dashboard overlay or we're newly appearing if ( (is_newly_visible) || (!UIManager::Get()->IsDummyOverlayTransformUnstable()) || (ovrl_id_hover_target != ovrl_id_primary_dashboard) ) { //Only set transform and add active time if we actually need to move the overlay if (matrix != m_TransformLast) { vr::HmdMatrix34_t hmd_matrix = matrix.toOpenVR34(); vr::VROverlay()->SetOverlayTransformAbsolute(ovrl_handle_floating_ui, vr::TrackingUniverseStanding, &hmd_matrix); UIManager::Get()->GetIdleState().AddActiveTime(100); m_TransformLast = matrix; } } //Set floating UI curvature based on target overlay curvature if (overlay_data.ConfigInt[configid_int_overlay_origin] == ovrl_origin_theater_screen) { //Set curvature to 0 in this case, as theater screen curve is controlled by SteamVR and not query-able) vr::VROverlay()->SetOverlayCurvature(ovrl_handle_floating_ui, 0.0f); } else { float curvature = 0.0f; vr::VROverlay()->GetOverlayCurvature(m_OvrlHandleCurrentUITarget, &curvature); float overlay_width = overlay_data.ConfigFloat[configid_float_overlay_width]; vr::VROverlay()->SetOverlayCurvature(ovrl_handle_floating_ui, curvature * (m_Width / overlay_width) ); } } if ( (ovrl_handle_hover_target == vr::k_ulOverlayHandleInvalid) || (m_OvrlHandleCurrentUITarget == vr::k_ulOverlayHandleInvalid) ) //If not even the UI itself is being hovered, fade out { if (m_Visible) { //Don't fade out if this is the theater screen overlay and the systemui is hovered //This does have false positives when really trying (systemui is used for many things), but it's better not to fade out when SteamVR's overlay controls are hovered bool blocked_by_systemui = false; if (m_OvrlHandleCurrentUITarget != vr::k_ulOverlayHandleInvalid) { vr::VROverlayHandle_t ovrl_handle_systemui; vr::VROverlay()->FindOverlay("system.systemui", &ovrl_handle_systemui); if (ovrl_handle_systemui != vr::k_ulOverlayHandleInvalid) { const OverlayConfigData& overlay_data = OverlayManager::Get().GetConfigData(m_OvrlIDCurrentUITarget); if (overlay_data.ConfigInt[configid_int_overlay_origin] == ovrl_origin_theater_screen) { blocked_by_systemui = ConfigManager::Get().IsLaserPointerTargetOverlay(ovrl_handle_systemui); } } } if (!blocked_by_systemui) { m_FadeOutDelayCount += ImGui::GetIO().DeltaTime; //Delay normal fade in order to not flicker when switching hover target between mirror overlay and floating UI (or don't while reordering overlays) if ((m_FadeOutDelayCount > 0.8f) || (UIManager::Get()->GetOverlayBarWindow().IsDraggingOverlayButtons())) { //Hide m_Visible = false; m_FadeOutDelayCount = 0.0f; } } UIManager::Get()->GetIdleState().AddActiveTime(); } else if (m_Alpha == 0.0f) { m_FadeOutDelayCount = 0.0f; } } else { m_Visible = true; } //Update config state if it changed. This state is only set if the Floating UI itself is the hover target const int target_overlay_id_new = ((m_OvrlIDCurrentUITarget != k_ulOverlayID_None) && (ovrl_handle_hover_target == ovrl_handle_floating_ui)) ? (int)m_OvrlIDCurrentUITarget : -1; int& target_overlay_id_config = ConfigManager::GetRef(configid_int_state_interface_floating_ui_hovered_id); if (target_overlay_id_config != target_overlay_id_new) { target_overlay_id_config = target_overlay_id_new; IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_interface_floating_ui_hovered_id, target_overlay_id_config); } } bool FloatingUI::IsVisible() const { return ((m_Visible) || (m_Alpha != 0.0f)); } float FloatingUI::GetAlpha() const { return m_Alpha; } WindowFloatingUIMainBar& FloatingUI::GetMainBarWindow() { return m_WindowMainBar; } WindowFloatingUIActionBar& FloatingUI::GetActionBarWindow() { return m_WindowActionBar; } ================================================ FILE: src/DesktopPlusUI/FloatingUI.h ================================================ #pragma once #include "WindowFloatingUIBar.h" #include "openvr.h" #include "Matrices.h" class FloatingUI { private: WindowFloatingUIMainBar m_WindowMainBar; WindowFloatingUIActionBar m_WindowActionBar; WindowFloatingUIOverlayStats m_WindowOverlayStats; vr::VROverlayHandle_t m_OvrlHandleCurrentUITarget; unsigned int m_OvrlIDCurrentUITarget; float m_Width; float m_Alpha; bool m_Visible; bool m_IsSwitchingTarget; float m_FadeOutDelayCount; int m_AutoFitFrames; Matrix4 m_TransformLast; float m_TheaterOffsetAnimationProgress; public: FloatingUI(); void Update(); void UpdateUITargetState(); bool IsVisible() const; float GetAlpha() const; WindowFloatingUIMainBar& GetMainBarWindow(); WindowFloatingUIActionBar& GetActionBarWindow(); }; ================================================ FILE: src/DesktopPlusUI/FloatingWindow.cpp ================================================ #include "FloatingWindow.h" #include "UIManager.h" #include "OverlayManager.h" #include "InterprocessMessaging.h" #include "Util.h" #include "OpenVRExt.h" #include "ImGuiExt.h" #include "imgui_internal.h" FloatingWindow::FloatingWindow() : m_OvrlWidth(1.0f), m_OvrlWidthMax(FLT_MAX), m_Alpha(0.0f), m_OvrlVisible(false), m_IsTransitionFading(false), m_OverlayStateCurrentID(floating_window_ovrl_state_dashboard_tab), m_OverlayStateCurrent(&m_OverlayStateDashboardTab), m_OverlayStatePending(&m_OverlayStateFading), m_WindowTitleStrID(tstr_NONE), m_WindowIcon(tmtex_icon_xsmall_desktop_none), m_WindowIconWin32IconCacheID(-1), m_AllowRoomUnpinning(false), m_DragOrigin(ovrl_origin_dplus_tab), m_TitleBarMinWidth(64.0f), m_TitleBarTitleMaxWidth(-1.0f), m_TitleBarTitleIconAlpha(1.0f), m_IsTitleBarHovered(false), m_IsTitleIconClicked(false), m_HasAppearedOnce(false), m_IsWindowAppearing(false), m_CompactTableHeaderHeight(0.0f) { m_Pos.x = FLT_MIN; m_WindowFlags = ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoCollapse | ImGuiWindowFlags_NoBringToFrontOnFocus; m_WindowID = "###" + std::to_string((unsigned long long)this); m_OverlayStateDashboardTab.TransformAbs.zero(); m_OverlayStateRoom.TransformAbs.zero(); } void FloatingWindow::WindowUpdateBase() { if ( ((!UIManager::Get()->GetRepeatFrame()) || (m_Alpha == 0.0f)) && ((m_Alpha != 0.0f) || (m_OverlayStateCurrent->IsVisible) || (m_IsTransitionFading)) ) { const float alpha_prev = m_Alpha; const float alpha_step = ImGui::GetIO().DeltaTime * 6.0f; //Alpha fade animation m_Alpha += ((m_OverlayStateCurrent->IsVisible) && (!m_IsTransitionFading)) ? alpha_step : -alpha_step; if (m_Alpha > 1.0f) m_Alpha = 1.0f; else if (m_Alpha < 0.0f) m_Alpha = 0.0f; //Use overlay alpha when not in desktop mode for better blending if ( (!UIManager::Get()->IsInDesktopMode()) && (alpha_prev != m_Alpha) ) vr::VROverlay()->SetOverlayAlpha(GetOverlayHandle(), m_Alpha); if (m_Alpha == 0.0f) { //Not the best spot, but it can be difficult to cancel an active overlay hightlight when disappearing since the window code isn't running anymore //So instead we always cancel the current highlight here, which shouldn't be problematic UIManager::Get()->HighlightOverlay(k_ulOverlayID_None); //Finish transition fade if one's active if (m_IsTransitionFading) { OverlayStateSwitchFinish(); } } } if (m_Alpha == 0.0f) return; if (UIManager::Get()->IsInDesktopMode()) ImGui::PushStyleVar(ImGuiStyleVar_Alpha, m_Alpha); ImGuiIO& io = ImGui::GetIO(); ImGuiStyle& style = ImGui::GetStyle(); if (m_Pos.x == FLT_MIN) { //Expects m_Size to be padded 2 pixels around actual texture space, so -4 on each axis m_Pos = {2.0f, (io.DisplaySize.y - m_Size.y) - 2.0f}; } ImGui::SetNextWindowPos(m_Pos, ImGuiCond_Always, m_PosPivot); ImGui::SetNextWindowSizeConstraints({m_TitleBarMinWidth, 4.0f}, m_Size); ImGui::SetNextWindowScroll({0.0f, -1.0f}); //Prevent real horizontal scrolling from happening ImGuiWindowFlags flags = m_WindowFlags; if (!m_OverlayStateCurrent->IsVisible) flags |= ImGuiWindowFlags_NoInputs; ImGui::Begin(m_WindowID.c_str(), nullptr, flags); m_IsTitleBarHovered = ((ImGui::IsItemHovered()) && (m_OverlayStateCurrent->IsVisible)); //Current item is the title bar (needs to be checked before BeginTitleBar()) m_IsWindowAppearing = ImGui::IsWindowAppearing(); //Title bar ImVec4 title_rect = ImGui::BeginTitleBar(); //Icon and title text ImVec2 img_size_line_height = {ImGui::GetTextLineHeight(), ImGui::GetTextLineHeight()}; ImVec2 img_size, img_uv_min, img_uv_max; if (m_WindowIconWin32IconCacheID == -1) { TextureManager::Get().GetTextureInfo(m_WindowIcon, img_size, img_uv_min, img_uv_max); } else { TextureManager::Get().GetWindowIconTextureInfo(m_WindowIconWin32IconCacheID, img_size, img_uv_min, img_uv_max); } ImGui::PushStyleVar(ImGuiStyleVar_Alpha, m_TitleBarTitleIconAlpha); ImGui::Image(io.Fonts->TexID, img_size_line_height, img_uv_min, img_uv_max); m_IsTitleIconClicked = ImGui::IsItemClicked(); ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); ImVec2 clip_end = ImGui::GetCursorScreenPos(); clip_end.x += m_TitleBarTitleMaxWidth; clip_end.y += ImGui::GetFrameHeight(); ImGui::PushClipRect(ImGui::GetCursorScreenPos(), clip_end, true); ImGui::TextUnformatted( (m_WindowTitleStrID == tstr_NONE) ? m_WindowTitle.c_str() : TranslationManager::GetString(m_WindowTitleStrID) ); ImGui::PopClipRect(); ImGui::PopStyleVar(); float title_text_width = ImGui::GetItemRectSize().x; //Right end of title bar ImGui::PushStyleColor(ImGuiCol_Button, 0); static float b_width = 0.0f; ImGui::SetCursorScreenPos({title_rect.z - b_width - style.ItemInnerSpacing.x, title_rect.y + style.FramePadding.y}); //Buttons TextureManager::Get().GetTextureInfo((m_OverlayStateCurrent->IsPinned) ? tmtex_icon_xxsmall_unpin : tmtex_icon_xxsmall_pin, img_size, img_uv_min, img_uv_max); ImGui::BeginGroup(); const bool disable_pinning = ( (!m_AllowRoomUnpinning) && (m_OverlayStateCurrentID == floating_window_ovrl_state_room) ); if (disable_pinning) ImGui::PushItemDisabled(); if (ImGui::ImageButton("PinButton", io.Fonts->TexID, img_size, img_uv_min, img_uv_max, ImVec4(0.0f, 0.0f, 0.0f, 0.0f))) { SetPinned(!IsPinned()); OnWindowPinButtonPressed(); } ImGui::SameLine(0.0f, 0.0f); if (disable_pinning) ImGui::PopItemDisabled(); TextureManager::Get().GetTextureInfo(tmtex_icon_xxsmall_close, img_size, img_uv_min, img_uv_max); if (ImGui::ImageButton("CloseButton", io.Fonts->TexID, img_size, img_uv_min, img_uv_max, ImVec4(0.0f, 0.0f, 0.0f, 0.0f))) { Hide(); OnWindowCloseButtonPressed(); } ImGui::EndGroup(); m_IsTitleBarHovered = ( (m_IsTitleBarHovered) && (!ImGui::IsItemHovered()) ); //Title was hovered and no title bar element is hovered b_width = ImGui::GetItemRectSize().x; ImGui::PopStyleColor(); //Calculate title bar constraints m_TitleBarMinWidth = img_size_line_height.x + b_width + (style.ItemSpacing.x * 2.0f); m_TitleBarTitleMaxWidth = ImGui::GetWindowSize().x - m_TitleBarMinWidth; m_TitleBarMinWidth += style.ItemSpacing.x * 2.0f; //Shorten title bar string if it doesn't fit (this is destructive, but doesn't matter for the windows using this) if ((m_WindowTitleStrID == tstr_NONE) && (title_text_width > std::max(ImGui::GetFontSize(), m_TitleBarTitleMaxWidth) )) { //Don't attempt to shorten the string during repeat frames as the size can still be adjusting in corner cases and throw us into a loop if (!UIManager::Get()->GetRepeatFrame()) { m_WindowTitle = ImGui::StringEllipsis(m_WindowTitle.c_str(), m_TitleBarTitleMaxWidth); //Repeat frame to not make title shortening visible UIManager::Get()->RepeatFrame(); } } //Title bar dragging if ( (m_OverlayStateCurrent->IsVisible) && (m_IsTitleBarHovered) && (UIManager::Get()->IsOpenVRLoaded()) ) { if ( (ImGui::IsMouseClicked(ImGuiMouseButton_Left)) && (!UIManager::Get()->GetOverlayDragger().IsDragActive()) && (!UIManager::Get()->GetOverlayDragger().IsDragGestureActive()) ) { UIManager::Get()->GetOverlayDragger().DragStart(GetOverlayHandle(), m_DragOrigin); UIManager::Get()->GetOverlayDragger().DragSetMaxWidth(m_OvrlWidthMax); } else if ( (ImGui::IsMouseClicked(ImGuiMouseButton_Right)) && (!UIManager::Get()->GetOverlayDragger().IsDragActive()) && (!UIManager::Get()->GetOverlayDragger().IsDragGestureActive()) ) { UIManager::Get()->GetOverlayDragger().DragGestureStart(GetOverlayHandle(), m_DragOrigin); UIManager::Get()->GetOverlayDragger().DragSetMaxWidth(m_OvrlWidthMax); } } ImGui::EndTitleBar(); //To appease boundary extension error check ImGui::Dummy({0.0f, 0.0f}); ImGui::SameLine(0.0f, 0.0f); //Window content WindowUpdate(); //Hack to work around ImGui's auto-sizing quirks. Just checking for ImGui::IsWindowAppearing() and using alpha 0 then doesn't help on its own so this is the next best thing if (!m_HasAppearedOnce) { if (ImGui::IsWindowAppearing()) { UIManager::Get()->RepeatFrame(); } else { m_HasAppearedOnce = true; } } //Blank space drag if ( (ConfigManager::GetValue(configid_bool_interface_blank_space_drag_enabled)) && (m_OverlayStateCurrent->IsVisible) && (UIManager::Get()->IsOpenVRLoaded()) && (!ImGui::IsAnyItemHovered()) && (!IsVirtualWindowItemHovered()) && (ImGui::IsWindowHovered(ImGuiHoveredFlags_ChildWindows)) ) { if ( (ImGui::IsMouseClicked(ImGuiMouseButton_Left)) && (!UIManager::Get()->GetOverlayDragger().IsDragActive()) && (!UIManager::Get()->GetOverlayDragger().IsDragGestureActive()) ) { UIManager::Get()->GetOverlayDragger().DragStart(GetOverlayHandle(), m_DragOrigin); UIManager::Get()->GetOverlayDragger().DragSetMaxWidth(m_OvrlWidthMax); } else if ( (ImGui::IsMouseClicked(ImGuiMouseButton_Right)) && (!UIManager::Get()->GetOverlayDragger().IsDragActive()) && (!UIManager::Get()->GetOverlayDragger().IsDragGestureActive()) ) { UIManager::Get()->GetOverlayDragger().DragGestureStart(GetOverlayHandle(), m_DragOrigin); UIManager::Get()->GetOverlayDragger().DragSetMaxWidth(m_OvrlWidthMax); } } ImGui::End(); if (UIManager::Get()->IsInDesktopMode()) ImGui::PopStyleVar(); //ImGuiStyleVar_Alpha } void FloatingWindow::OverlayStateSwitchCurrent(bool use_dashboard_tab) { if (m_OverlayStateCurrent == &m_OverlayStateFading) return; //Use transition fade if the overlay position will change m_OverlayStatePending = (use_dashboard_tab) ? &m_OverlayStateDashboardTab : &m_OverlayStateRoom; if ( (m_OverlayStateCurrent->TransformAbs != m_OverlayStatePending->TransformAbs) || (!m_OverlayStatePending->IsVisible) ) { m_IsTransitionFading = true; m_OverlayStateFading = *m_OverlayStateCurrent; m_OverlayStateCurrent = &m_OverlayStateFading; } else { OverlayStateSwitchFinish(); } } void FloatingWindow::OverlayStateSwitchFinish() { m_IsTransitionFading = false; m_OverlayStateCurrent = m_OverlayStatePending; m_OverlayStateCurrentID = (m_OverlayStateCurrent == &m_OverlayStateDashboardTab) ? floating_window_ovrl_state_dashboard_tab : floating_window_ovrl_state_room; ApplyCurrentOverlayState(); if (m_OverlayStateCurrent->IsVisible) { Show(); } } void FloatingWindow::OnWindowPinButtonPressed() { //If pin button pressed from dashboard tab, also make it visible for the room state so it can be used there if ( (m_OverlayStateCurrentID == floating_window_ovrl_state_dashboard_tab) && (m_OverlayStateDashboardTab.IsPinned) ) { m_OverlayStateRoom.IsVisible = true; } } void FloatingWindow::OnWindowCloseButtonPressed() { //Do nothing by default } bool FloatingWindow::IsVirtualWindowItemHovered() const { return false; } void FloatingWindow::HelpMarker(const char* desc, const char* marker_str) const { ImGui::TextDisabled(marker_str); if (ImGui::IsItemHovered()) { static float last_y_offset = FLT_MIN; //Try to avoid getting having the tooltip cover the marker... the way it's done here is a bit messy to be fair const ImGuiStyle& style = ImGui::GetStyle(); float pos_y = ImGui::GetItemRectMax().y + style.ItemSpacing.y; bool is_invisible = false; if (last_y_offset == FLT_MIN) //Same as IsWindowAppearing except the former doesn't work before beginning the window which is too late for the position... { //We need to create the tooltip window for size calculations to happen but also don't want to see it... so alpha 0, even if wasteful ImGui::PushStyleVar(ImGuiStyleVar_Alpha, 0.0f); is_invisible = true; } else { ImGui::SetNextWindowPos(ImVec2(m_Pos.x, m_Pos.y + m_Size.y + last_y_offset), 0, {0.0f, 1.0f}); ImGui::SetNextWindowSize(ImVec2(m_Size.x, -1.0f)); } ImGui::BeginTooltip(); ImGui::PushTextWrapPos(m_Size.x - style.WindowPadding.x); ImGui::TextUnformatted(desc); ImGui::PopTextWrapPos(); if (ImGui::IsWindowAppearing()) //New tooltip, reset offset { //The window size isn't available in this frame yet, so we'll have to skip the having it visible for one more frame and then act on it last_y_offset = FLT_MIN; } else { if (pos_y + ImGui::GetWindowSize().y > m_Pos.y + m_Size.y) //If it would cover the marker { if (UIManager::Get()->IsInDesktopMode()) { last_y_offset = -m_Size.y + ImGui::GetWindowSize().y + UIManager::Get()->GetDesktopModeWindow().GetTitleBarRect().w; } else { last_y_offset = -m_Size.y + ImGui::GetWindowSize().y + ImGui::GetFontSize() + style.FramePadding.y * 2.0f; } } else //Use normal pos { last_y_offset = 0.0f; } } ImGui::EndTooltip(); if (is_invisible) ImGui::PopStyleVar(); //ImGuiStyleVar_Alpha } } void FloatingWindow::UpdateLimiterSetting(bool is_override) const { const ImGuiStyle& style = ImGui::GetStyle(); const ConfigID_Int configid_mode = (is_override) ? configid_int_overlay_update_limit_override_mode : configid_int_performance_update_limit_mode; const ConfigID_Int configid_fps = (is_override) ? configid_int_overlay_update_limit_override_fps : configid_int_performance_update_limit_fps; const ConfigID_Float configid_ms = (is_override) ? configid_float_overlay_update_limit_override_ms : configid_float_performance_update_limit_ms; int& update_limit_mode = ConfigManager::GetRef(configid_mode); bool limit_updates = (update_limit_mode != update_limit_mode_off); if (ConfigManager::GetValue(configid_bool_interface_show_advanced_settings)) //Advanced view, choose limiter mode { ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString((is_override) ? tstr_SettingsPerformanceUpdateLimiterModeOverride : tstr_SettingsPerformanceUpdateLimiterMode)); if (update_limit_mode == update_limit_mode_ms) { ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsPerformanceUpdateLimiterModeMSTip)); } else if (is_override) { ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsPerformanceUpdateLimiterOverrideTip)); } ImGui::NextColumn(); //Manually set up combo items here to support different first string for override setting const TRMGRStrID combo_strings[] = { (is_override) ? tstr_SettingsPerformanceUpdateLimiterModeOffOverride : tstr_SettingsPerformanceUpdateLimiterModeOff, tstr_SettingsPerformanceUpdateLimiterModeMS, tstr_SettingsPerformanceUpdateLimiterModeFPS }; update_limit_mode = clamp(update_limit_mode, 0, IM_ARRAYSIZE(combo_strings) - 1); //Avoid accessing past limits with invalid values ImGui::SetNextItemWidth(-1.0f); if (ImGui::BeginComboAnimated("##ComboUpdateLimitMode", TranslationManager::GetString(combo_strings[update_limit_mode]) )) { int i = 0; for (const auto& item : combo_strings) { if (ImGui::Selectable(TranslationManager::GetString(item), (update_limit_mode == i))) { update_limit_mode = i; IPCManager::Get().PostConfigMessageToDashboardApp(configid_mode, update_limit_mode); } ++i; } ImGui::EndCombo(); } ImGui::NextColumn(); ImGui::NextColumn(); } else //Simple view, only switch between off and fps mode (still shows ms below if previously set active) { if (ImGui::Checkbox(TranslationManager::GetString((is_override) ? tstr_SettingsPerformanceUpdateLimiterOverride : tstr_SettingsPerformanceUpdateLimiter), &limit_updates)) { update_limit_mode = (limit_updates) ? update_limit_mode_fps : update_limit_mode_off; IPCManager::Get().PostConfigMessageToDashboardApp(configid_mode, update_limit_mode); } if (is_override) { ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsPerformanceUpdateLimiterOverrideTip)); } ImGui::NextColumn(); } if (update_limit_mode == update_limit_mode_ms) { VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); float& update_limit_ms = ConfigManager::Get().GetRef(configid_ms); vr_keyboard.VRKeyboardInputBegin( ImGui::SliderWithButtonsGetSliderID("UpdateLimitMS") ); if (ImGui::SliderWithButtonsFloat("UpdateLimitMS", update_limit_ms, 0.5f, 0.05f, 0.0f, 100.0f, "%.2f ms", ImGuiSliderFlags_Logarithmic)) { if (update_limit_ms < 0.0f) update_limit_ms = 0.0f; IPCManager::Get().PostConfigMessageToDashboardApp(configid_ms, update_limit_ms); } vr_keyboard.VRKeyboardInputEnd(); } else { if (!limit_updates) ImGui::PushItemDisabled(); int& update_limit_fps = ConfigManager::Get().GetRef(configid_fps); const int update_limit_fps_max = 9; if (ImGui::SliderWithButtonsInt("UpdateLimitFPS", update_limit_fps, 1, 1, 0, update_limit_fps_max, "##%d", ImGuiSliderFlags_NoInput, nullptr, TranslationManager::Get().GetFPSLimitString(update_limit_fps))) { update_limit_fps = clamp(update_limit_fps, 0, update_limit_fps_max); IPCManager::Get().PostConfigMessageToDashboardApp(configid_fps, update_limit_fps); } if (!limit_updates) ImGui::PopItemDisabled(); } ImGui::NextColumn(); } bool FloatingWindow::InputOverlayTags(const char* str_id, char* buffer_tags, size_t buffer_tags_size, FloatingWindowInputOverlayTagsState& state, int clip_parent_depth, bool show_auto_tags) { static const int single_tag_buffer_size = IM_ARRAYSIZE(state.TagEditBuffer); ImGuiStyle& style = ImGui::GetStyle(); float widget_width = 0.0f; bool is_widget_hovered = false; float child_height = ImGui::GetTextLineHeight() + style.FramePadding.y * 2.0f; child_height += ImGui::GetTextLineHeightWithSpacing() * (state.ChildHeightLines - 1.0f); ImGui::PushID(str_id); ImGui::PushStyleVar(ImGuiStyleVar_WindowPadding, style.FramePadding); if (ImGui::BeginChild("InputOverlayTags", {-style.ChildBorderSize, child_height}, ImGuiChildFlags_Borders | ImGuiChildFlags_NavFlattened)) { ImGui::PopStyleVar(); state.ChildHeightLines = 1.0f; widget_width = ImGui::GetWindowWidth(); is_widget_hovered = ImGui::IsWindowHovered(ImGuiHoveredFlags_AllowWhenBlockedByActiveItem); //Split input string into individual tags and show a small button for each const char* str = buffer_tags; const char* str_end = str + strlen(str); const char* tag_start = str; const char* tag_end = nullptr; char buffer_single_tag[single_tag_buffer_size] = ""; int tag_id = 0; while (tag_start < str_end) { tag_end = (const char*)memchr(tag_start, ' ', str_end - tag_start); if (tag_end == nullptr) tag_end = str_end; size_t length = tag_end - tag_start; //Break if tag doesn't fit (would be comically long though) if (length >= single_tag_buffer_size) break; if (length > 0) { memcpy(buffer_single_tag, tag_start, length); buffer_single_tag[length] = '\0'; if (tag_id != 0) { ImVec2 text_size = ImGui::CalcTextSize(buffer_single_tag); text_size.x += style.ItemSpacing.x; if (text_size.x > ImGui::GetContentRegionAvail().x) { ImGui::NewLine(); state.ChildHeightLines += 1.0f; } } ImGui::PushID(tag_id); if (ImGui::SmallButton(buffer_single_tag)) { //Copy tag into edit buffer memcpy(state.TagEditBuffer, buffer_single_tag, single_tag_buffer_size); //Also keep a copy to put back when canceling state.TagEditOrigStr = state.TagEditBuffer; //Remove tag from full string std::string str_tags = buffer_tags; str_tags.erase(tag_start - str, length); StringReplaceAll(str_tags, " ", " "); //Clean up double whitespace separators, no matter where they came from //Cleanup stray space at the beginning too if ((!str_tags.empty()) && (str_tags[0] == ' ')) { str_tags.erase(0, 1); } //Copy back to buffer size_t copied_length = str_tags.copy(buffer_tags, buffer_tags_size - 1); buffer_tags[copied_length] = '\0'; //Open popup to allow editing state.PopupShow = true; state.FocusTextInput = true; //We modified the buffer we're looping over, get out of here UIManager::Get()->RepeatFrame(5); //Prevent hover flicker from the button that take this one's place ImGui::PopID(); ImGui::EndChild(); ImGui::PopID(); return true; } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); ImGui::PopID(); tag_id++; } tag_start = tag_end + 1; } if (tag_id != 0) { ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); ImVec2 text_size = ImGui::CalcTextSize("+"); text_size.x += style.ItemSpacing.x; if (text_size.x > ImGui::GetContentRegionAvail().x) { ImGui::NewLine(); state.ChildHeightLines += 1.0f; } } //There are two plus-shaped buttons on the screen when the popup is up. //This one will just clear the text input then and might be accidentally pressed instead of the bigger one. Disable it to prevent accidents //Similar thing applies to the tag buttons themselves, but that behavior is at least useful for editing there const bool disable_add = state.PopupShow; if (disable_add) { ImGui::PushItemDisabledNoVisual(); ImGui::PushStyleColor(ImGuiCol_Button, ImGui::GetStyleColorVec4(ImGuiCol_ButtonActive)); } //Add some frame padding in VR mode only to have a more square-ish button that is also easier to hit //Due to how we do style-scaling this isn't necessary in desktop mode if (!UIManager::Get()->IsInDesktopMode()) ImGui::PushStyleVar(ImGuiStyleVar_FramePadding, {style.FramePadding.x * 1.5f, 0.0f}); if (ImGui::SmallButton("+##AddTag")) { state.TagEditBuffer[0] = '\0'; state.TagEditOrigStr = state.TagEditBuffer; state.PopupShow = true; state.FocusTextInput = true; } if (!UIManager::Get()->IsInDesktopMode()) ImGui::PopStyleVar(); if (disable_add) { ImGui::PopStyleColor(); ImGui::PopItemDisabledNoVisual(); } } else { ImGui::PopStyleVar(); //ImGuiStyleVar_WindowPadding } //Avoid scrollbar flicker while figuring out child window size if ((ImGui::IsAnyScrollBarVisible()) && (state.ChildHeightLines <= 3.0f)) { UIManager::Get()->RepeatFrame(); } //Show up to 3 lines before adding a scrollbar state.ChildHeightLines = std::min(state.ChildHeightLines, 3.0f); ImGui::EndChild(); //--Popup Window if (!state.PopupShow) { ImGui::PopID(); return false; } ImGuiIO& io = ImGui::GetIO(); VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); const float pos_y = ImGui::GetItemRectMin().y - style.ItemSpacing.y; const float pos_y_down = ImGui::GetItemRectMax().y + style.ItemInnerSpacing.y; const float pos_y_up = ImGui::GetItemRectMin().y - style.ItemSpacing.y - state.PopupHeight; bool update_filter = false; bool ret = false; //Wait for window height to be known and stable before setting pos or animating fade/pos if ((state.PopupHeight != FLT_MIN) && (state.PopupHeight == state.PopupHeightPrev)) { ImGui::SetNextWindowPos(ImVec2(ImGui::GetItemRectMin().x, smoothstep(state.PosAnimationProgress, pos_y_down, pos_y_up) )); const float time_step = ImGui::GetIO().DeltaTime * 6.0f; state.PopupAlpha += (!state.IsFadingOut) ? time_step : -time_step; if (state.PopupAlpha > 1.0f) state.PopupAlpha = 1.0f; else if (state.PopupAlpha < 0.0f) state.PopupAlpha = 0.0f; state.PosAnimationProgress += (state.PosDir == ImGuiDir_Up) ? time_step : -time_step; if (state.PosAnimationProgress > 1.0f) state.PosAnimationProgress = 1.0f; else if (state.PosAnimationProgress < 0.0f) state.PosAnimationProgress = 0.0f; } else if (state.PopupHeight == FLT_MIN) //Popup is appearing { state.KnownTagsList = OverlayManager::Get().GetKnownOverlayTagList(); update_filter = true; } ImGui::PushStyleVar(ImGuiStyleVar_Alpha, state.PopupAlpha); //Look up parent window (optionally digging deeper to avoid child windows) and get its clipping rect ImGuiWindow* window_parent = ImGui::GetCurrentWindow(); ImGuiWindow* window_parent_lookup = window_parent; while (clip_parent_depth > 0) { window_parent_lookup = window_parent_lookup->ParentWindow; clip_parent_depth--; if (window_parent_lookup != nullptr) { window_parent = window_parent_lookup; } else { break; } } ImRect clip_rect = window_parent->ClipRect; clip_rect.Max.y = window_parent->Size.y + clip_rect.Min.y; //Set Max.y from window content size as FLT_MAX values break drawlist commands for some reason const ImGuiWindowFlags flags = ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoSavedSettings | ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_NoBackground; ImGui::SetNextWindowSize(ImVec2(widget_width, ImGui::GetTextLineHeightWithSpacing() * 11.5f)); ImGui::Begin("##WindowAddTags", nullptr, flags); //Transfer scroll input to parent window (which isn't a real parent window but just the one in the stack), so this window doesn't block scrolling ImGui::ScrollBeginStackParentWindow(); //Use clipping rect of parent window ImGui::PushClipRect(clip_rect.Min, clip_rect.Max, false); //Draw background + border manually so it can be clipped properly ImGuiWindow* window = ImGui::GetCurrentWindow(); ImRect window_rect = window->Rect(); window->DrawList->AddRectFilled(window_rect.Min, window_rect.Max, ImGui::GetColorU32(ImGuiCol_PopupBg), window->WindowRounding); window->DrawList->AddRect(window_rect.Min, window_rect.Max, ImGui::GetColorU32(ImGuiCol_Border), window->WindowRounding, 0, window->WindowBorderSize); //Disable inputs when fading out const bool disable_items = state.IsFadingOut; if (disable_items) ImGui::PushItemDisabledNoVisual(); //-Window contents static float buttons_width = 0.0f; const bool is_input_text_active = ImGui::IsAnyInputTextActive(); //Need to get this before InputText is canceled in the same frame bool add_current_input = false; if (state.FocusTextInput) { ImGui::SetKeyboardFocusHere(); } ImGui::SetNextItemWidth(ImGui::GetContentRegionAvail().x - buttons_width - style.ItemInnerSpacing.x); //Set up shortcut window so it does not block the tag listing itself either. It's a little bit awkward looking like this, but better than blocking the buttons vr_keyboard.SetShortcutWindowDirectionHint(ImGuiDir_Up, (state.PosDir == ImGuiDir_Down) ? -child_height - style.ItemSpacing.y - style.ItemSpacing.y : -style.ItemInnerSpacing.y); vr_keyboard.VRKeyboardInputBegin("##InputTagEdit"); if (ImGui::InputTextWithHint("##InputTagEdit", TranslationManager::GetString(tstr_DialogInputTagsHint), state.TagEditBuffer, single_tag_buffer_size, ImGuiInputTextFlags_CharsNoBlank | ImGuiInputTextFlags_EnterReturnsTrue)) { add_current_input = !state.IsTagAlreadyInBuffer; } vr_keyboard.VRKeyboardInputEnd(); //Wait until the actually have focus before turning the flag off if (ImGui::IsItemActive()) { state.FocusTextInput = false; } //Check if tag would be a duplicate and disable adding in that case if (ImGui::IsItemEdited()) { state.IsTagAlreadyInBuffer = OverlayManager::MatchOverlayTagSingle(buffer_tags, state.TagEditBuffer); update_filter = true; UIManager::Get()->AddFontBuilderStringIfAnyUnmappedCharacters(state.TagEditBuffer); } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); ImGui::BeginGroup(); ImVec2 b_size, b_uv_min, b_uv_max; ImVec2 b_size_real = ImVec2(ImGui::GetTextLineHeight(), ImGui::GetTextLineHeight()); TextureManager::Get().GetTextureInfo(tmtex_icon_add, b_size, b_uv_min, b_uv_max); if (state.IsTagAlreadyInBuffer) ImGui::PushItemDisabled(); if (ImGui::ImageButton("AddButton", io.Fonts->TexID, b_size_real, b_uv_min, b_uv_max, ImVec4(0.0f, 0.0f, 0.0f, 0.0f))) { add_current_input = true; } if (state.IsTagAlreadyInBuffer) ImGui::PopItemDisabled(); ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); TextureManager::Get().GetTextureInfo(tmtex_icon_small_close, b_size, b_uv_min, b_uv_max); if (ImGui::ImageButton("DeleteButton", io.Fonts->TexID, b_size_real, b_uv_min, b_uv_max, ImVec4(0.0f, 0.0f, 0.0f, 0.0f))) { state.TagEditBuffer[0] = '\0'; state.TagEditOrigStr = ""; state.IsTagAlreadyInBuffer = true; update_filter = true; } ImGui::EndGroup(); buttons_width = ImGui::GetItemRectSize().x; ImGui::BeginChild("ChildKnownTags", ImVec2(0.0f, 0.0f), ImGuiChildFlags_NavFlattened, ImGuiWindowFlags_NoBackground); for (const auto& list_entry : state.KnownTagsList) { if (state.KnownTagsFilter.PassFilter(list_entry.Tag.c_str())) { if ((list_entry.IsAutoTag) && (!show_auto_tags)) continue; if (list_entry.IsAutoTag) ImGui::PushStyleColor(ImGuiCol_Text, Style_ImGuiCol_TextNotification); if (ImGui::Selectable(list_entry.Tag.c_str())) { size_t copied_length = list_entry.Tag.copy(state.TagEditBuffer, buffer_tags_size - 1); state.TagEditBuffer[copied_length] = '\0'; add_current_input = true; state.TagEditOrigStr = ""; } if (list_entry.IsAutoTag) ImGui::PopStyleColor(); } } ImGui::EndChild(); if (disable_items) ImGui::PopItemDisabledNoVisual(); //Abandoned popup while editing existing tag, put it back if ((state.IsFadingOut) && (!state.TagEditOrigStr.empty())) { size_t copied_length = state.TagEditOrigStr.copy(state.TagEditBuffer, buffer_tags_size - 1); state.TagEditBuffer[copied_length] = '\0'; state.TagEditOrigStr = ""; add_current_input = true; update_filter = true; } if (add_current_input) { //Check if tag is already in the string first and just don't add it then if (!OverlayManager::MatchOverlayTagSingle(buffer_tags, state.TagEditBuffer)) { std::string str_tags = buffer_tags; if (!str_tags.empty()) { str_tags += " "; } str_tags += state.TagEditBuffer; size_t copied_length = str_tags.copy(buffer_tags, buffer_tags_size - 1); buffer_tags[copied_length] = '\0'; } state.TagEditOrigStr = ""; ret = true; state.IsFadingOut = true; UIManager::Get()->RepeatFrame(); } if (update_filter) { //Update filter manually (we don't use its buffer directly as its size is fixed to 256) size_t length = strlen(state.TagEditBuffer); if (length < (size_t)IM_ARRAYSIZE(state.KnownTagsFilter.InputBuf)) { memcpy(state.KnownTagsFilter.InputBuf, state.TagEditBuffer, length); state.KnownTagsFilter.InputBuf[length] = '\0'; state.KnownTagsFilter.Build(); } } //Switch directions if there's no space in the default direction if (state.PosDirDefault == ImGuiDir_Down) { state.PosDir = (pos_y_down + ImGui::GetWindowSize().y > clip_rect.Max.y) ? ImGuiDir_Up : ImGuiDir_Down; } else { //Not using pos_y_up here as it's not valid yet (state.PopupHeight not set) state.PosDir = (pos_y - ImGui::GetWindowSize().y < clip_rect.Min.y) ? ImGuiDir_Down : ImGuiDir_Up; } if (state.PopupAlpha == 0.0f) { state.PosAnimationProgress = (state.PosDir == ImGuiDir_Down) ? 0.0f : 1.0f; } //Fade out on focus loss/cancel input if ( ((!ImGui::IsWindowFocused(ImGuiFocusedFlags_ChildWindows)) && (!ImGui::IsAnyItemActive())) || ((!is_input_text_active) && (ImGui::IsNavInputPressed(ImGuiNavInput_Cancel))) ) { state.IsFadingOut = true; } //Cache window height so it's available on the next frame before beginning the window state.PopupHeightPrev = state.PopupHeight; state.PopupHeight = ImGui::GetWindowSize().y; ImGui::End(); ImGui::PopStyleVar(); //ImGuiStyleVar_Alpha //Reset when fade-out is done if ( (state.IsFadingOut) && (state.PopupAlpha == 0.0f) ) { state.IsFadingOut = false; state.PopupHeight = FLT_MIN; state.PosDir = state.PosDirDefault; state.PosAnimationProgress = (state.PosDirDefault == ImGuiDir_Down) ? 0.0f : 1.0f; state.PopupShow = false; } ImGui::PopID(); return ret; } bool FloatingWindow::ActionOrderList(ActionManager::ActionList& list_actions_target, bool is_appearing, bool is_returning, FloatingWindowActionOrderListState& state, bool& go_add_actions, float height_offset) { static float list_buttons_width = 0.0f; static ImVec2 no_actions_text_size; const ImGuiStyle& style = ImGui::GetStyle(); ImGuiIO& io = ImGui::GetIO(); ActionManager& action_manager = ConfigManager::Get().GetActionManager(); if ((is_appearing) || (is_returning)) { state.HasSavedChanges = false; state.SelectedIndex = -1; state.ActionsList.clear(); for (ActionUID uid : list_actions_target) { state.ActionsList.push_back({uid, action_manager.GetTranslatedName(uid)}); } } if (is_appearing) { state.ActionListOrig = list_actions_target; } ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_SettingsActionsOrderHeader)); ImGui::Indent(); ImGui::SetNextItemWidth(-1.0f); const float item_height = ImGui::GetFrameHeight() + style.ItemSpacing.y; const float inner_padding = style.FramePadding.y + style.ItemInnerSpacing.y; const float item_count = (UIManager::Get()->IsInDesktopMode()) ? 16.0f : 14.0f; ImGui::BeginChild("ActionList", ImVec2(0.0f, (item_height * item_count) + inner_padding + height_offset), true); if ((is_appearing) || (is_returning)) { ImGui::SetScrollY(0.0f); } //Display error if there are no actions if (state.ActionsList.size() == 0) { ImGui::SetCursorPosX(ImGui::GetCursorPosX() + ImGui::GetContentRegionAvail().x / 2.0f - (no_actions_text_size.x / 2.0f)); ImGui::SetCursorPosY(ImGui::GetCursorPosY() + ImGui::GetContentRegionAvail().y / 2.0f - (no_actions_text_size.y / 2.0f)); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsActionsOrderNoActions)); no_actions_text_size = ImGui::GetItemRectSize(); } else { ActionUID hovered_action_prev = state.HoveredAction; //List actions int index = 0; for (const auto& entry : state.ActionsList) { ImGui::PushID((void*)entry.UID); //Set focus for nav if we previously re-ordered overlays via keyboard if (state.KeyboardSwappedIndex == index) { ImGui::SetKeyboardFocusHere(); //Nav works against us here, so keep setting focus until ctrl isn't down anymore if ((!io.KeyCtrl) || (!io.NavVisible)) { state.KeyboardSwappedIndex = -1; } } ImGui::SetNextItemAllowOverlap(); if (ImGui::Selectable(entry.Name.c_str(), (index == state.SelectedIndex), ImGuiSelectableFlags_AllowOverlap)) { state.SelectedIndex = index; } if ( (ImGui::IsItemHovered(ImGuiHoveredFlags_AllowWhenBlockedByActiveItem | ImGuiHoveredFlags_AllowWhenOverlappedByItem)) || ((io.NavVisible) && (ImGui::IsItemFocused())) ) { state.HoveredAction = entry.UID; } if (ImGui::IsItemVisible()) { //Drag reordering if ((ImGui::IsItemActive()) && (!ImGui::IsItemHovered())) { int index_swap = index + ((ImGui::GetMouseDragDelta(ImGuiMouseButton_Left).y < 0.0f) ? -1 : 1); if ((state.HoveredAction != entry.UID) && (index_swap >= 0) && (index_swap < state.ActionsList.size())) { std::iter_swap(state.ActionsList.begin() + index, state.ActionsList.begin() + index_swap); std::iter_swap(list_actions_target.begin() + index, list_actions_target.begin() + index_swap); state.SelectedIndex = index_swap; ImGui::ResetMouseDragDelta(ImGuiMouseButton_Left); } } //Keyboard reordering if ((io.NavVisible) && (io.KeyCtrl) && (state.HoveredAction == entry.UID)) { int index_swap = index + ((ImGui::IsNavInputPressed(ImGuiNavInput_DpadDown, true)) ? 1 : (ImGui::IsNavInputPressed(ImGuiNavInput_DpadUp, true)) ? -1 : 0); if ((index != index_swap) && (index_swap >= 0) && (index_swap < state.ActionsList.size())) { std::iter_swap(state.ActionsList.begin() + index, state.ActionsList.begin() + index_swap); std::iter_swap(list_actions_target.begin() + index, list_actions_target.begin() + index_swap); //Skip the rest of this frame to avoid double-swaps state.KeyboardSwappedIndex = index_swap; ImGui::PopID(); UIManager::Get()->RepeatFrame(); break; } } } ImGui::PopID(); index++; } //Reduce flicker from dragging and hovering if (state.HoveredAction != hovered_action_prev) { UIManager::Get()->RepeatFrame(); } } ImGui::EndChild(); ImGui::Unindent(); const bool is_none = (state.SelectedIndex == -1); ImGui::SetCursorPosX(ImGui::GetCursorPosX() + ImGui::GetContentRegionAvail().x - list_buttons_width); ImGui::BeginGroup(); go_add_actions = ImGui::Button(TranslationManager::GetString(tstr_SettingsActionsOrderAdd)); ImGui::SameLine(); if (is_none) ImGui::PushItemDisabled(); if ((ImGui::Button(TranslationManager::GetString(tstr_SettingsActionsOrderRemove))) || (ImGui::IsKeyPressed(ImGuiKey_Delete))) { if ((state.SelectedIndex >= 0) && (state.SelectedIndex < state.ActionsList.size())) { state.ActionsList.erase(state.ActionsList.begin() + state.SelectedIndex); list_actions_target.erase(list_actions_target.begin() + state.SelectedIndex); if (state.SelectedIndex >= (int)list_actions_target.size()) { state.SelectedIndex--; } } } if (is_none) ImGui::PopItemDisabled(); ImGui::EndGroup(); list_buttons_width = ImGui::GetItemRectSize().x + style.IndentSpacing; ImGui::SetCursorPosY( ImGui::GetCursorPosY() + (ImGui::GetContentRegionAvail().y - ImGui::GetFrameHeightWithSpacing()) ); //Confirmation buttons ImGui::Separator(); bool ret = false; if (ImGui::Button(TranslationManager::GetString(tstr_DialogOk))) { ret = true; state.HasSavedChanges = true; } ImGui::SameLine(); if (ImGui::Button(TranslationManager::GetString(tstr_DialogCancel))) { ret = true; list_actions_target = state.ActionListOrig; } return ret; } bool FloatingWindow::ActionAddSelector(ActionManager::ActionList& list_actions_target, bool is_appearing, FloatingWindowActionAddSelectorState& state, float height_offset) { static float list_buttons_width = 0.0f; static ImVec2 no_actions_text_size; const ImGuiStyle& style = ImGui::GetStyle(); ActionManager& action_manager = ConfigManager::Get().GetActionManager(); if (is_appearing) { state.ActionsList = action_manager.GetActionNameList(); //Remove actions already in the existing list auto it = std::remove_if(state.ActionsList.begin(), state.ActionsList.end(), [&](const auto& entry) { return (std::find(list_actions_target.begin(), list_actions_target.end(), entry.UID) != list_actions_target.end()); } ); state.ActionsList.erase(it, state.ActionsList.end()); state.ActionsTickedList.resize(state.ActionsList.size(), 0); std::fill(state.ActionsTickedList.begin(), state.ActionsTickedList.end(), 0); } ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_SettingsActionsAddSelectorHeader)); ImGui::Indent(); ImGui::SetNextItemWidth(-1.0f); const float item_height = ImGui::GetFrameHeight() + style.ItemSpacing.y; const float inner_padding = style.FramePadding.y + style.ItemInnerSpacing.y; const float item_count = (UIManager::Get()->IsInDesktopMode()) ? 16.0f : 14.0f; ImGui::BeginChild("ActionSelector", ImVec2(0.0f, (item_height * item_count) + inner_padding + height_offset), true); //Reset scroll when appearing if (is_appearing) { ImGui::SetScrollY(0.0f); } //Display error if there are no actions if (state.ActionsList.size() == 0) { ImGui::SetCursorPosX(ImGui::GetCursorPosX() + ImGui::GetContentRegionAvail().x / 2.0f - (no_actions_text_size.x / 2.0f)); ImGui::SetCursorPosY(ImGui::GetCursorPosY() + ImGui::GetContentRegionAvail().y / 2.0f - (no_actions_text_size.y / 2.0f)); ImGui::TextUnformatted(TranslationManager::GetString(tstr_DialogActionPickerEmpty)); no_actions_text_size = ImGui::GetItemRectSize(); } else { //List actions const float cursor_x_past_checkbox = ImGui::GetCursorPosX() + ImGui::GetFrameHeightWithSpacing(); int index = 0; for (const auto& entry : state.ActionsList) { ImGui::PushID(index); //We're using a trick here to extend the checkbox interaction space to the end of the child window //Checkbox() uses the item inner spacing if the label is not blank, so we increase that and use a space label //Below we render a custom label after adjusting the cursor position to where it normally would be ImGui::PushStyleVar(ImGuiStyleVar_ItemInnerSpacing, {ImGui::GetContentRegionAvail().x, style.ItemInnerSpacing.y}); if (ImGui::Checkbox(" ", (bool*)&state.ActionsTickedList[index])) { //Update any ticked status state.IsAnyActionTicked = false; for (auto is_ticked : state.ActionsTickedList) { if (is_ticked != 0) { state.IsAnyActionTicked = true; break; } } } ImGui::PopStyleVar(); if (ImGui::IsItemVisible()) { //Adjust cursor position to be after the checkbox ImGui::SameLine(); float text_y = ImGui::GetCursorPosY(); ImGui::SetCursorPos({cursor_x_past_checkbox, text_y}); ImGui::TextUnformatted(entry.Name.c_str()); } ImGui::PopID(); index++; } } ImGui::EndChild(); ImGui::Unindent(); ImGui::SetCursorPosX(ImGui::GetCursorPosX() + ImGui::GetContentRegionAvail().x - list_buttons_width); ImGui::BeginGroup(); if (ImGui::Button(TranslationManager::GetString(tstr_SettingsProfilesOverlaysProfileAddSelectAll))) { std::fill(state.ActionsTickedList.begin(), state.ActionsTickedList.end(), 1); state.IsAnyActionTicked = true; } ImGui::SameLine(); if (ImGui::Button(TranslationManager::GetString(tstr_SettingsProfilesOverlaysProfileAddSelectNone))) { std::fill(state.ActionsTickedList.begin(), state.ActionsTickedList.end(), 0); state.IsAnyActionTicked = false; } ImGui::EndGroup(); list_buttons_width = ImGui::GetItemRectSize().x + style.IndentSpacing; ImGui::SetCursorPosY( ImGui::GetCursorPosY() + (ImGui::GetContentRegionAvail().y - ImGui::GetFrameHeightWithSpacing()) ); //Confirmation buttons ImGui::Separator(); bool ret = false; if (ImGui::Button(TranslationManager::GetString(tstr_SettingsActionsAddSelectorAdd))) { //Add ticked actions to the existing list int index = 0; for (const auto& entry : state.ActionsList) { if (state.ActionsTickedList[index]) { list_actions_target.push_back(entry.UID); } index++; } ret = true; } ImGui::SameLine(); if (ImGui::Button(TranslationManager::GetString(tstr_DialogCancel))) { ret = true; } return ret; } bool FloatingWindow::BeginCompactTable(const char* str_id, int column, ImGuiTableFlags flags, const ImVec2& outer_size, float inner_width) { const ImGuiStyle style = ImGui::GetStyle(); //There's minor breakage at certain fractional scales, but the ones we care about (100%, 160% (VR), 200%) work fine with this ImGui::PushStyleVar(ImGuiStyleVar_CellPadding, {style.CellPadding.x, -1.0f}); ImGui::PushStyleVar(ImGuiStyleVar_ItemInnerSpacing, {style.ItemInnerSpacing.x, 0.0f}); flags = flags & (~ImGuiTableFlags_BordersOuter); //Remove border flag, we draw our own later flags |= ImGuiTableFlags_BordersInnerV | ImGuiTableFlags_PadOuterX; bool ret = ImGui::BeginTable(str_id, column, flags, outer_size, inner_width); if (ret) { m_CompactTableHeaderHeight = ImGui::GetCursorPosY(); } else { ImGui::PopStyleVar(2); } return ret; } void FloatingWindow::CompactTableHeadersRow() { ImGui::PushItemDisabledNoVisual(); ImGui::TableHeadersRow(); ImGui::SetCursorPosY(ImGui::GetCursorPosY() - 1.0f); ImGui::Dummy({0.0f, 0.0f}); //To appease parent boundary extension error check ImGui::PopItemDisabledNoVisual(); m_CompactTableHeaderHeight = ImGui::GetCursorPosY() - m_CompactTableHeaderHeight - ImGui::GetStyle().ItemSpacing.y; } void FloatingWindow::EndCompactTable() { const ImGuiStyle style = ImGui::GetStyle(); ImGui::EndTable(); ImGui::PopStyleVar(2); //Selectables cover parts of the default table border and the bottom border would be one pixel inside the last row, so we draw our own header and table border on top instead ImVec2 rect_min = ImGui::GetItemRectMin(), rect_max = ImGui::GetItemRectMax(); ImGui::GetWindowDrawList()->AddRect(rect_min, {rect_max.x, rect_min.y + ceilf(m_CompactTableHeaderHeight - 1.0f)}, ImGui::GetColorU32(ImGuiCol_Border), 0.0f, 0, style.WindowBorderSize); ImGui::GetWindowDrawList()->AddRect(rect_min, {rect_max.x, rect_max.y + 1.0f}, ImGui::GetColorU32(ImGuiCol_Border), 0.0f, 0, style.WindowBorderSize); } void FloatingWindow::Update() { WindowUpdateBase(); } void FloatingWindow::UpdateVisibility() { //Set state depending on dashboard tab visibility if ( (!UIManager::Get()->IsInDesktopMode()) && (!m_IsTransitionFading) ) { const bool is_using_dashboard_state = (m_OverlayStateCurrentID == floating_window_ovrl_state_dashboard_tab); if (is_using_dashboard_state != vr::VROverlay()->IsOverlayVisible(UIManager::Get()->GetOverlayHandleDPlusDashboard())) { OverlayStateSwitchCurrent(!is_using_dashboard_state); } } //Overlay position and visibility if (UIManager::Get()->IsOpenVRLoaded()) { vr::VROverlayHandle_t overlay_handle = GetOverlayHandle(); if ( (m_OverlayStateCurrent->IsVisible) && (!m_OverlayStateCurrent->IsPinned) && (!UIManager::Get()->GetOverlayDragger().IsDragActive()) && (!UIManager::Get()->GetOverlayDragger().IsDragGestureActive()) ) { //We don't update position when the dummy transform is unstable to avoid flicker, but we absolutely need to update it when the overlay is about to appear if ( (!m_OvrlVisible) || (!UIManager::Get()->IsDummyOverlayTransformUnstable()) ) { vr::TrackingUniverseOrigin origin = vr::TrackingUniverseStanding; Matrix4 matrix_m4 = UIManager::Get()->GetOverlayDragger().GetBaseOffsetMatrix(ovrl_origin_dplus_tab) * m_OverlayStateCurrent->Transform; vr::HmdMatrix34_t matrix_ovr = matrix_m4.toOpenVR34(); vr::VROverlay()->SetOverlayTransformAbsolute(overlay_handle, origin, &matrix_ovr); m_OverlayStateCurrent->TransformAbs = matrix_m4; } } if ((!m_OvrlVisible) && (m_OverlayStateCurrent->IsVisible)) { vr::VROverlay()->ShowOverlay(overlay_handle); m_OvrlVisible = true; } else if ((m_OvrlVisible) && (!m_OverlayStateCurrent->IsVisible) && (m_Alpha == 0.0f)) { vr::VROverlay()->HideOverlay(overlay_handle); m_OvrlVisible = false; } } } void FloatingWindow::Show(bool skip_fade) { m_OverlayStateCurrent->IsVisible = true; if (skip_fade) { m_Alpha = 1.0f; } UIManager::Get()->GetIdleState().AddActiveTime(); } void FloatingWindow::Hide(bool skip_fade) { m_OverlayStateCurrent->IsVisible = false; if (skip_fade) { m_Alpha = 0.0f; } UIManager::Get()->GetIdleState().AddActiveTime(); } void FloatingWindow::HideAll(bool skip_fade) { Hide(skip_fade); m_OverlayStateRoom.IsVisible = false; m_OverlayStateDashboardTab.IsVisible = false; } bool FloatingWindow::IsVisible() const { return m_OverlayStateCurrent->IsVisible; } bool FloatingWindow::IsVisibleOrFading() const { return ( (m_OverlayStateCurrent->IsVisible) || (m_Alpha != 0.0f) || (m_IsTransitionFading) ); } float FloatingWindow::GetAlpha() const { return m_Alpha; } void FloatingWindow::ApplyUIScale() { m_Size.x = m_SizeUnscaled.x * UIManager::Get()->GetUIScale(); m_Size.y = m_SizeUnscaled.y * UIManager::Get()->GetUIScale(); } bool FloatingWindow::CanUnpinRoom() const { return m_AllowRoomUnpinning; } bool FloatingWindow::IsPinned() const { return m_OverlayStateCurrent->IsPinned; } void FloatingWindow::SetPinned(bool is_pinned, bool no_state_copy) { m_OverlayStateCurrent->IsPinned = is_pinned; if (!UIManager::Get()->IsOpenVRLoaded()) return; if (!is_pinned) { RebaseTransform(); } else if (!no_state_copy) { if (m_OverlayStateCurrentID == floating_window_ovrl_state_dashboard_tab) { m_OverlayStateRoom.IsPinned = m_OverlayStateDashboardTab.IsPinned; m_OverlayStateRoom.Transform = m_OverlayStateDashboardTab.Transform; m_OverlayStateRoom.TransformAbs = m_OverlayStateDashboardTab.TransformAbs; } //Reset transform if TransformAbs doesn't have anything of value yet if (m_OverlayStateRoom.TransformAbs.isZero()) { ResetTransform(floating_window_ovrl_state_room); } } } FloatingWindowOverlayState& FloatingWindow::GetOverlayState(FloatingWindowOverlayStateID id) { switch (id) { case floating_window_ovrl_state_room: return m_OverlayStateRoom; case floating_window_ovrl_state_dashboard_tab: return m_OverlayStateDashboardTab; } return m_OverlayStateRoom; } FloatingWindowOverlayStateID FloatingWindow::GetOverlayStateCurrentID() { return m_OverlayStateCurrentID; } Matrix4& FloatingWindow::GetTransform() { return m_OverlayStateCurrent->Transform; } void FloatingWindow::SetTransform(const Matrix4& transform) { m_OverlayStateCurrent->Transform = transform; //Store last absolute transform vr::HmdMatrix34_t hmd_mat; vr::TrackingUniverseOrigin universe_origin = vr::TrackingUniverseStanding; vr::VROverlay()->GetOverlayTransformAbsolute(GetOverlayHandle(), &universe_origin, &hmd_mat); m_OverlayStateCurrent->TransformAbs = hmd_mat; //Store size multiplier float current_width = m_OvrlWidth; if (vr::VROverlay()->GetOverlayWidthInMeters(GetOverlayHandle(), ¤t_width) == vr::VROverlayError_None) { m_OverlayStateCurrent->Size = current_width / m_OvrlWidth; } } void FloatingWindow::ApplyCurrentOverlayState() { if (!UIManager::Get()->IsOpenVRLoaded()) return; if (m_OverlayStateCurrent->IsPinned) { vr::HmdMatrix34_t matrix_ovr = m_OverlayStateCurrent->TransformAbs.toOpenVR34(); vr::VROverlay()->SetOverlayTransformAbsolute(GetOverlayHandle(), vr::TrackingUniverseStanding, &matrix_ovr); } vr::VROverlay()->SetOverlayWidthInMeters(GetOverlayHandle(), m_OvrlWidth * m_OverlayStateCurrent->Size); } void FloatingWindow::RebaseTransform() { vr::HmdMatrix34_t hmd_mat; vr::TrackingUniverseOrigin universe_origin = vr::TrackingUniverseStanding; vr::VROverlay()->GetOverlayTransformAbsolute(GetOverlayHandle(), &universe_origin, &hmd_mat); Matrix4 mat_abs = hmd_mat; Matrix4 mat_origin_inverse = UIManager::Get()->GetOverlayDragger().GetBaseOffsetMatrix(ovrl_origin_dplus_tab); mat_origin_inverse.invert(); m_OverlayStateCurrent->Transform = mat_origin_inverse * mat_abs; } void FloatingWindow::ResetTransformAll() { ResetTransform(floating_window_ovrl_state_dashboard_tab); ResetTransform(floating_window_ovrl_state_room); m_OverlayStateRoom.IsVisible = false; m_OverlayStateRoom.IsPinned = false; } void FloatingWindow::ResetTransform(FloatingWindowOverlayStateID state_id) { GetOverlayState(state_id).Transform.identity(); //Set absolute transform to the dashboard tab one (as if pinning) if (state_id == floating_window_ovrl_state_room) { if (!m_OverlayStateDashboardTab.TransformAbs.isZero()) { m_OverlayStateRoom.TransformAbs = m_OverlayStateDashboardTab.TransformAbs; } else if ((UIManager::Get() != nullptr) && (UIManager::Get()->IsOpenVRLoaded())) //If the dashboard tab transform is still zero, generate a HMD facing transform instead (needs startup to be done though) { m_OverlayStateRoom.TransformAbs = vr::IVRSystemEx::ComputeHMDFacingTransform(1.25f); UIManager::Get()->GetOverlayDragger().ApplyDashboardScale(m_OverlayStateRoom.TransformAbs); } } } void FloatingWindow::StartDrag() { if (UIManager::Get()->IsOpenVRLoaded()) { OverlayDragger& overlay_dragger = UIManager::Get()->GetOverlayDragger(); if ( (!overlay_dragger.IsDragActive()) && (!overlay_dragger.IsDragGestureActive()) ) { overlay_dragger.DragStart(GetOverlayHandle(), m_DragOrigin); overlay_dragger.DragSetMaxWidth(m_OvrlWidthMax); } } } const ImVec2& FloatingWindow::GetPos() const { return m_Pos; } const ImVec2& FloatingWindow::GetSize() const { return m_Size; } bool FloatingWindow::TranslatedComboAnimated(const char* label, int& value, TRMGRStrID trstr_min, TRMGRStrID trstr_max) { bool ret = false; const char* preview_value = ((trstr_min + value >= trstr_min) && (trstr_min + value <= trstr_max)) ? TranslationManager::GetString( (TRMGRStrID)(trstr_min + value) ) : "???"; if (ImGui::BeginComboAnimated(label, preview_value)) { //Make use of the fact values and translation string IDs are laid out sequentially and shorten this to a nice loop const int value_max = (trstr_max - trstr_min) + 1; for (int i = 0; i < value_max; ++i) { ImGui::PushID(i); if (ImGui::Selectable(TranslationManager::GetString( (TRMGRStrID)(trstr_min + i) ), (value == i))) { value = i; ret = true; } ImGui::PopID(); } ImGui::EndCombo(); } return ret; } ================================================ FILE: src/DesktopPlusUI/FloatingWindow.h ================================================ #pragma once #include "OverlayDragger.h" #include "TextureManager.h" #include "TranslationManager.h" #include "OverlayManager.h" #include enum FloatingWindowOverlayStateID { floating_window_ovrl_state_room, floating_window_ovrl_state_dashboard_tab }; struct FloatingWindowOverlayState { bool IsVisible = false; bool IsPinned = false; float Size = 1.0f; Matrix4 Transform; Matrix4 TransformAbs; }; struct FloatingWindowInputOverlayTagsState { std::string TagEditOrigStr; char TagEditBuffer[1024] = ""; float ChildHeightLines = 1.0f; std::vector KnownTagsList; ImGuiTextFilter KnownTagsFilter; bool IsTagAlreadyInBuffer = false; bool FocusTextInput = false; bool PopupShow = false; float PopupAlpha = 0.0f; float PopupHeight = FLT_MIN; float PopupHeightPrev = FLT_MIN; ImGuiDir PosDir = ImGuiDir_Down; ImGuiDir PosDirDefault = ImGuiDir_Down; float PosAnimationProgress = 0.0f; bool IsFadingOut = false; }; struct FloatingWindowActionOrderListState { std::vector ActionsList; ActionManager::ActionList ActionListOrig; bool HasSavedChanges = false; int KeyboardSwappedIndex = -1; int SelectedIndex = -1; ActionUID HoveredAction = k_ActionUID_Invalid; }; struct FloatingWindowActionAddSelectorState { std::vector ActionsList; std::vector ActionsTickedList; bool IsAnyActionTicked = false; }; //Base class for drag-able floating overlay windows, such as the Settings, Overlay Properties and Keyboard windows class FloatingWindow { protected: float m_OvrlWidth; float m_OvrlWidthMax; //Maximum width passed to OverlayDragger float m_Alpha; bool m_OvrlVisible; bool m_IsTransitionFading; FloatingWindowOverlayStateID m_OverlayStateCurrentID; FloatingWindowOverlayState m_OverlayStateRoom; FloatingWindowOverlayState m_OverlayStateDashboardTab; FloatingWindowOverlayState m_OverlayStateFading; FloatingWindowOverlayState* m_OverlayStateCurrent; FloatingWindowOverlayState* m_OverlayStatePending; std::string m_WindowTitle; std::string m_WindowID; TRMGRStrID m_WindowTitleStrID; TMNGRTexID m_WindowIcon; int m_WindowIconWin32IconCacheID; //TextureManager Icon cache ID when using a Win32 window icon as the ImGui window icon ImVec2 m_Pos; ImVec2 m_PosPivot; ImVec2 m_Size; //Set in derived constructor, 2 pixel-wide padding around actual texture space expected ImVec2 m_SizeUnscaled; //Set in derived constructor, size before applying UI scale factor, so equal to m_Size initally ImGuiWindowFlags m_WindowFlags; bool m_AllowRoomUnpinning; //Set to enable pin button while room overlay state is active OverlayOrigin m_DragOrigin; //Origin passed to OverlayDragger for window drags, doesn't affect overlay positioning (override relevant functions instead) float m_TitleBarMinWidth; float m_TitleBarTitleMaxWidth; //Width available for the title string without icon and buttons float m_TitleBarTitleIconAlpha; //Alpha value applied to both window title text & icon bool m_IsTitleBarHovered; bool m_IsTitleIconClicked; bool m_HasAppearedOnce; bool m_IsWindowAppearing; float m_CompactTableHeaderHeight; void WindowUpdateBase(); //Sets up ImGui window with custom title bar, pinning and overlay-based dragging virtual void WindowUpdate() = 0; //Window content, called within an ImGui Begin()'d window void OverlayStateSwitchCurrent(bool use_dashboard_tab); void OverlayStateSwitchFinish(); virtual void OnWindowPinButtonPressed(); //Called when the pin button is pressed, after updating overlay state virtual void OnWindowCloseButtonPressed(); //Called when the close button is pressed, after updating overlay state virtual bool IsVirtualWindowItemHovered() const; //Returns false by default, can be overridden to signal hover state of widgets that don't touch global ImGui state (used for blank space drag) void HelpMarker(const char* desc, const char* marker_str = "(?)") const; //Help marker, but tooltip is fixed to top or bottom of the window void UpdateLimiterSetting(bool is_override) const; //Input widget for a collection of overlay tags. clip_parent_depth is the depth of parent window look up for popup's clipping rect, change when used in nested child windows static bool InputOverlayTags(const char* str_id, char* buffer_tags, size_t buffer_tags_size, FloatingWindowInputOverlayTagsState& state, int clip_parent_depth = 0, bool show_auto_tags = true); //Almost entire pages but implemented here to be shared between multiple windows bool ActionOrderList(ActionManager::ActionList& list_actions_target, bool is_appearing, bool is_returning, FloatingWindowActionOrderListState& state, bool& go_add_actions, float height_offset = 0.0f); bool ActionAddSelector(ActionManager::ActionList& list_actions_target, bool is_appearing, FloatingWindowActionAddSelectorState& state, float height_offset = 0.0f); //BeginTable(), but with some hacks to allow for compact, gap-less selectable + border around header (always set). Fairly specific, so not a generic ImGui extension //Text has to be aligned to frame padding with this bool BeginCompactTable(const char* str_id, int column, ImGuiTableFlags flags = 0, const ImVec2& outer_size = ImVec2(0.0f, 0.0f), float inner_width = 0.0f); void CompactTableHeadersRow(); void EndCompactTable(); public: FloatingWindow(); virtual ~FloatingWindow() = default; void Update(); //Not called when idling (no windows visible) virtual void UpdateVisibility(); //Only called in VR mode virtual void Show(bool skip_fade = false); virtual void Hide(bool skip_fade = false); void HideAll(bool skip_fade = false); //Hide(), but applies to all overlay visibility states bool IsVisible() const; bool IsVisibleOrFading() const; //Returns true if m_Visible is true *or* m_Alpha isn't 0 yet float GetAlpha() const; virtual void ApplyUIScale(); bool CanUnpinRoom() const; bool IsPinned() const; void SetPinned(bool is_pinned, bool no_state_copy = false); //no_state_copy = don't copy dashboard state to room (default behavior for pin button) FloatingWindowOverlayState& GetOverlayState(FloatingWindowOverlayStateID id); FloatingWindowOverlayStateID GetOverlayStateCurrentID(); Matrix4& GetTransform(); void SetTransform(const Matrix4& transform); virtual void ApplyCurrentOverlayState(); //Applies current absolute transform to the overlay if pinned and sets the width virtual void RebaseTransform(); virtual void ResetTransformAll(); virtual void ResetTransform(FloatingWindowOverlayStateID state_id); virtual void StartDrag(); //Starts a regular laser pointer drag of the window with the necessary parameters const ImVec2& GetPos() const; const ImVec2& GetSize() const; virtual vr::VROverlayHandle_t GetOverlayHandle() const = 0; static bool TranslatedComboAnimated(const char* label, int& value, TRMGRStrID trstr_min, TRMGRStrID trstr_max); }; ================================================ FILE: src/DesktopPlusUI/ImGuiExt.cpp ================================================ #include "ImGuiExt.h" #include #ifndef IMGUI_DEFINE_MATH_OPERATORS #define IMGUI_DEFINE_MATH_OPERATORS #endif #include "imgui_internal.h" #include "UIManager.h" #include "Util.h" ImVec4 Style_ImGuiCol_TextNotification; ImVec4 Style_ImGuiCol_TextWarning; ImVec4 Style_ImGuiCol_TextError; ImVec4 Style_ImGuiCol_TextOutline; ImVec4 Style_ImGuiCol_ButtonPassiveToggled; ImVec4 Style_ImGuiCol_SteamVRCursor; ImVec4 Style_ImGuiCol_SteamVRCursorBorder; namespace ImGui { //Like InputFloat()'s buttons but with a slider instead. Not quite as flexible, though. Always takes as much space as available. bool SliderWithButtonsFloat(const char* str_id, float& value, float step, float step_small, float min, float max, const char* format, ImGuiSliderFlags flags, bool* used_button, const char* text_alt) { //Hacky solution to make right mouse enable text input on the slider while not touching ImGui code or generalizing it as ctrl press ImGuiIO& io = ImGui::GetIO(); const bool mouse_left_clicked_old = io.MouseClicked[ImGuiMouseButton_Left]; const bool mouse_left_down_old = io.MouseDown[ImGuiMouseButton_Left]; const float mouse_left_down_duration_old = io.MouseDownDuration[ImGuiMouseButton_Left]; const bool key_ctrl_old = io.KeyCtrl; if (io.MouseClicked[ImGuiMouseButton_Right]) { io.MouseClicked[ImGuiMouseButton_Left] = true; io.MouseDown[ImGuiMouseButton_Left] = true; io.MouseDownDuration[ImGuiMouseButton_Left] = 0.0f; io.KeyCtrl = true; io.KeyMods |= ImGuiMod_Ctrl; //KeyMods needs to stay consistent with KeyCtrl } //Use small step value when shift is down if (io.KeyShift) { step = step_small; } ImGuiStyle& style = ImGui::GetStyle(); const float value_old = value; const ImVec2 button_size(ImGui::GetFrameHeight(), ImGui::GetFrameHeight()); ImGui::BeginGroup(); ImGui::PushID(str_id); ImGui::PushItemFlag(ImGuiItemFlags_ButtonRepeat, true); //Calulate slider width (GetContentRegionAvail() returns 1 more than when using -1 width to fill) ImGui::SetNextItemWidth((ImGui::GetContentRegionAvail().x - (ImGui::GetFrameHeight() + ImGui::GetStyle().ItemInnerSpacing.x) * 2) - 1.0f); ImGui::SliderFloat("##Slider", &value, min, max, format, flags); if ( (text_alt != nullptr) && (ImGui::GetCurrentContext()->TempInputId != ImGui::GetID("##Slider")) ) { ImGui::RenderTextClipped(ImGui::GetItemRectMin(), ImGui::GetItemRectMax(), text_alt, nullptr, nullptr, ImVec2(0.5f, 0.5f)); } bool has_slider_deactivated = false; if (ImGui::IsItemDeactivated()) { has_slider_deactivated = true; } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); if (ImGui::Button("-", button_size)) { //Round to the step value while we're at it. This may not be the most expected thing at first, but it helps a lot to get the usually preferred even values int step_count = (int)ceilf(value / step); value = step_count * step; value -= step; if ( int( ceilf(value / step) ) >= step_count ) //Welcome to floating point math, this can happen value -= step / 10000.f; //This works for what we need, but not quite elegant indeed if (used_button) *used_button = true; } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); if (ImGui::Button("+", button_size)) { int step_count = int(value / step); value = step_count * step; value += step; if ( int(value / step) <= step_count ) //See above value += step / 10000.f; if (used_button) *used_button = true; } ImGui::PopItemFlag(); //ImGuiItemFlag_ButtonRepeat ImGui::PopID(); ImGui::EndGroup(); //Deactivated flag for the slider gets swallowed up somewhere, but we really need it for the VR keyboard, so we tape it back on here if (has_slider_deactivated) { ImGui::GetCurrentContext()->LastItemData.StatusFlags |= ImGuiItemStatusFlags_HasDeactivated | ImGuiItemStatusFlags_Deactivated; } //We generally don't want -0.0 to be a thing, so prevent it if (value == -0.0f) value = 0.0f; //Restore hack io.MouseClicked[ImGuiMouseButton_Left] = mouse_left_clicked_old; io.MouseDown[ImGuiMouseButton_Left] = mouse_left_down_old; io.MouseDownDuration[ImGuiMouseButton_Left] = mouse_left_down_duration_old; io.KeyCtrl = key_ctrl_old; if (!io.KeyCtrl) { io.KeyMods &= ~ImGuiMod_Ctrl; } return (value != value_old); } bool SliderWithButtonsInt(const char* str_id, int& value, int step, int step_small, int min, int max, const char* format, ImGuiSliderFlags flags, bool* used_button, const char* text_alt) { //Hacky solution to make right mouse enable text input on the slider while not touching ImGui code or generalizing it as ctrl press ImGuiIO& io = ImGui::GetIO(); const bool mouse_left_clicked_old = io.MouseClicked[ImGuiMouseButton_Left]; const bool mouse_left_down_old = io.MouseDown[ImGuiMouseButton_Left]; const float mouse_left_down_duration_old = io.MouseDownDuration[ImGuiMouseButton_Left]; const bool key_ctrl_old = io.KeyCtrl; if (io.MouseClicked[ImGuiMouseButton_Right]) { io.MouseClicked[ImGuiMouseButton_Left] = true; io.MouseDown[ImGuiMouseButton_Left] = true; io.MouseDownDuration[ImGuiMouseButton_Left] = 0.0f; io.KeyCtrl = true; io.KeyMods |= ImGuiMod_Ctrl; //KeyMods needs to stay consistent with KeyCtrl } //Use small step value when shift is down if (io.KeyShift) { step = step_small; } ImGuiStyle& style = ImGui::GetStyle(); const int value_old = value; const ImVec2 button_size(ImGui::GetFrameHeight(), ImGui::GetFrameHeight()); ImGui::BeginGroup(); ImGui::PushID(str_id); ImGui::PushItemFlag(ImGuiItemFlags_ButtonRepeat, true); //Calulate slider width (GetContentRegionAvail() returns 1 more than when using -1 width to fill) ImGui::SetNextItemWidth((ImGui::GetContentRegionAvail().x - (ImGui::GetFrameHeight() + ImGui::GetStyle().ItemInnerSpacing.x) * 2) - 1.0f); ImGui::SliderInt("##Slider", &value, min, max, format, flags); if ( (text_alt != nullptr) && (ImGui::GetCurrentContext()->TempInputId != ImGui::GetID("##Slider")) ) { ImGui::RenderTextClipped(ImGui::GetItemRectMin(), ImGui::GetItemRectMax(), text_alt, nullptr, nullptr, ImVec2(0.5f, 0.5f)); } bool has_slider_deactivated = false; if (ImGui::IsItemDeactivated()) { has_slider_deactivated = true; } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); if (ImGui::Button("-", button_size)) { //Also rounding to steps here value = (int)ceilf((float)value / step) * step; value -= step; if (used_button) *used_button = true; } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); if (ImGui::Button("+", button_size)) { value = (value / step) * step; value += step; if (used_button) *used_button = true; } ImGui::PopItemFlag(); //ImGuiItemFlag_ButtonRepeat ImGui::PopID(); ImGui::EndGroup(); //Deactivated flag for the slider gets swallowed up somewhere, but we really need it for the VR keyboard, so we tape it back on here if (has_slider_deactivated) { ImGui::GetCurrentContext()->LastItemData.StatusFlags |= ImGuiItemStatusFlags_HasDeactivated | ImGuiItemStatusFlags_Deactivated; } //Restore hack io.MouseClicked[ImGuiMouseButton_Left] = mouse_left_clicked_old; io.MouseDown[ImGuiMouseButton_Left] = mouse_left_down_old; io.MouseDownDuration[ImGuiMouseButton_Left] = mouse_left_down_duration_old; io.KeyCtrl = key_ctrl_old; if (!io.KeyCtrl) { io.KeyMods &= ~ImGuiMod_Ctrl; } return (value != value_old); } bool SliderWithButtonsFloatPercentage(const char* str_id, float& value, int step, int step_small, int min, int max, const char* format, ImGuiSliderFlags flags, bool* used_button, const char* text_alt) { int value_ui = int(value * 100.0f); if (ImGui::SliderWithButtonsInt(str_id, value_ui, step, step_small, min, max, format, flags, used_button, text_alt)) { value = value_ui / 100.0f; //Floating point hell hacky fix (slider can get stuck when using + button otherwise) int intvalue = int(value * 100.0f), intvalue_prev = intvalue; while (intvalue < value_ui) { value += step / 10000.f; intvalue_prev = intvalue; intvalue = int(value * 100.0f); if (intvalue == intvalue_prev) //Sanity check to avoid endless loop at big value + small step combinations { break; } } return true; } return false; } ImGuiID SliderWithButtonsGetSliderID(const char* str_id) { ImGui::PushID(str_id); ImGuiID id = ImGui::GetID("##Slider"); ImGui::PopID(); return id; } //Like imgui_demo's HelpMarker, but with a fixed position tooltip void FixedHelpMarker(const char* desc, const char* marker_str) { ImGui::TextDisabled(marker_str); if (ImGui::IsItemHovered()) { static float last_y_offset = FLT_MIN; //Try to avoid getting the tooltip off-screen... the way it's done here is a bit messy to be fair float pos_y = ImGui::GetItemRectMin().y; bool is_invisible = false; if (last_y_offset == FLT_MIN) //Same as IsWindowAppearing except the former doesn't work before beginning the window which is too late for the position... { //We need to create the tooltip window for size calculations to happen but also don't want to see it... so alpha 0, even if wasteful ImGui::PushStyleVar(ImGuiStyleVar_Alpha, 0.0f); is_invisible = true; } else { ImGui::SetNextWindowPos(ImVec2(ImGui::GetItemRectMax().x + ImGui::GetStyle().ItemInnerSpacing.x, ImGui::GetItemRectMin().y + last_y_offset)); } ImGui::BeginTooltip(); ImGui::PushTextWrapPos(ImGui::GetFontSize() * 35.0f); ImGui::PushTextWrapPos(ImGui::GetIO().DisplaySize.x - ImGui::GetCursorScreenPos().x); ImGui::TextUnformatted(desc); ImGui::PopTextWrapPos(); ImGui::PopTextWrapPos(); if (ImGui::IsWindowAppearing()) //New tooltip, reset offset { //The window size isn't available in this frame yet, so we'll have to skip the having it visible for one more frame and then act on it last_y_offset = FLT_MIN; } else { if (pos_y + ImGui::GetWindowSize().y > ImGui::GetIO().DisplaySize.y) //If it would be partially off-screen { last_y_offset = ImGui::GetIO().DisplaySize.y - (pos_y + ImGui::GetWindowSize().y); } else //Use normal pos { last_y_offset = 0.0f; } } ImGui::EndTooltip(); if (is_invisible) ImGui::PopStyleVar(); //ImGuiStyleVar_Alpha } } bool ButtonWithWrappedLabel(const char* label, const ImVec2& size) { //This could probably be solved in a cleaner way, but it's not /that/ dirty ImGui::PushID(label); ImGui::BeginGroup(); ImGuiWindow* window = GetCurrentWindow(); const ImGuiStyle& style = ImGui::GetStyle(); bool ret = ImGui::Button("", ImVec2(size.x + (style.FramePadding.x * 2.0f), size.y + (style.FramePadding.y * 2.0f)) ); ImGui::SameLine(0.0f, 0.0f); ImGui::SetCursorPosX(ImGui::GetCursorPosX() - size.x - style.FramePadding.x); ImGui::SetCursorPosY(ImGui::GetCursorPosY() + style.FramePadding.y); //Prevent child window moving line pos float cursor_max_pos_prev_y = window->DC.CursorMaxPos.y; ImGui::BeginChild("ButtonLabel", ImVec2(size.x + style.FramePadding.x, size.y), false, ImGuiWindowFlags_NoScrollbar | ImGuiWindowFlags_NoInputs); ImVec2 text_size = ImGui::CalcTextSize(label, nullptr, false, size.x); ImGui::SetCursorPosX( (size.x / 2.0f) - int(text_size.x / 2.0f) ); ImGui::SetCursorPosY( (size.x / 2.0f) - int(text_size.y / 2.0f) ); ImGui::PushTextWrapPos(size.x); ImGui::TextUnformatted(label); ImGui::PopTextWrapPos(); ImGui::EndChild(); window->DC.CursorMaxPos.y = cursor_max_pos_prev_y; ImGui::EndGroup(); ImGui::PopID(); return ret; } void RenderButtonMultilineLabel(const char* label, float line_height_scale) { const ImGuiContext& g = *GImGui; RenderButtonMultilineLabel(label, g.LastItemData.Rect, line_height_scale); } void RenderButtonMultilineLabel(const char* label, const ImRect& bb, float line_height_scale) { struct label_line_data { const char* text_start; const char* text_end; ImVec2 text_alignment; }; const ImGuiStyle& style = ImGui::GetStyle(); const float line_height = ImGui::GetFontSize() * line_height_scale; //Provided bounding box is intended to be for the button or whatever frame it's rendered on (also used for clipping), so apply inner padding here (vertical one not required) ImRect bb_inner = bb; bb_inner.Min.x += style.FramePadding.x; bb_inner.Max.x -= style.FramePadding.x; //Split label string into line segments (via offsets, no copying) std::vector label_lines; float total_height = ImGui::GetFontSize(); //First line is always set and needs to be equal with font size, while other lines add line_height { const char* line_start = label; const char* s = label; float h_align = 0.5f; for (;;) { if (*s == '\0') { label_lines.push_back({line_start, s, {h_align, 0.0f}}); break; } else if (*s == '\n') { label_lines.push_back({line_start, s, {h_align, 0.0f}}); //total_height starts with first line height so only add on newline characters, not string end total_height += line_height; line_start = s + 1; //Horizontal alignment defaults to center on line start h_align = 0.5f; } else if ((*s == '#') && (s[1] == '#')) //Double # is already being eaten by ImGui but not used for IDs in this context. Let's use it as control mechanism for horizontal alignment { //Reminder this kind of advance access is fine because the string is always NUL-terminated and we didn't encounter any NULs if (s[2] == 'L') { h_align = 0.0f; } else if (s[2] == 'R') { h_align = 1.0f; } } ++s; } } //Render the lines one-by-one to get correct horizontally centered alignment for each ImVec2 pos_line; const float base_offset_y = ((bb.Max.y - bb.Min.y) / 2.0f) - (total_height / 2.0f); for (int i = 0; i < label_lines.size(); ++i) { const label_line_data& label_line = label_lines[i]; pos_line.x = bb_inner.Min.x; pos_line.y = bb_inner.Min.y + base_offset_y + (line_height * i); RenderTextClippedUnclamped(pos_line, bb_inner.Max, label_line.text_start, label_line.text_end, nullptr, label_line.text_alignment, &bb); } } bool BeginComboWithInputText(const char* str_id, char* str_buffer, size_t buffer_size, bool& out_buffer_changed, bool& persist_input_visible, bool& persist_input_activated, bool& persist_mouse_released_once, bool no_preview_text) { ImGuiContext& g = *GImGui; out_buffer_changed = false; if (persist_input_visible) { ImGui::PushID("InputText"); g.NextItemData.Width = ImGui::CalcItemWidth(); g.NextItemData.Width -= ImGui::GetFrameHeight(); if ((ImGui::InputText(str_id, str_buffer, buffer_size))) { out_buffer_changed = true; } ImGuiID input_text_id = ImGui::GetItemID(); if ( (persist_input_activated) && (persist_mouse_released_once) && (ImGui::PopupContextMenuInputText(str_id, str_buffer, buffer_size)) ) { out_buffer_changed = true; } if (!persist_input_activated) { ImGui::ActivateItemByID(ImGui::GetItemID()); persist_input_activated = true; } else if ( (!ImGui::IsPopupOpen(str_id)) && ( (ImGui::IsItemDeactivated()) || (g.ActiveId != input_text_id) ) ) { persist_input_visible = false; persist_input_activated = false; persist_mouse_released_once = false; UIManager::Get()->RepeatFrame(); } if (ImGui::IsMouseReleased(ImGuiMouseButton_Right)) { persist_mouse_released_once = true; } ImGui::SameLine(0.0f, 0.0f); ImGui::PopID(); } return (ImGui::BeginCombo(str_id, (no_preview_text) ? "" : str_buffer, (persist_input_visible) ? (ImGuiComboFlags_NoPreview | ImGuiComboFlags_PopupAlignLeft) : ImGuiComboFlags_None)); } void ComboWithInputTextActivationCheck(bool& persist_input_visible) { ImGuiContext& g = *GImGui; //Right-click or Ctrl+Left-click to edit if ( (ImGui::IsItemClicked(ImGuiMouseButton_Right)) || ((ImGui::IsItemClicked(ImGuiMouseButton_Left)) && g.IO.KeyCtrl) ) { persist_input_visible = true; } } static float CalcMaxPopupHeightFromItemCount(int items_count) { ImGuiContext& g = *GImGui; if (items_count <= 0) return FLT_MAX; return (g.FontSize + g.Style.ItemSpacing.y) * items_count - g.Style.ItemSpacing.y + (g.Style.WindowPadding.y * 2); } bool BeginComboAnimated(const char* label, const char* preview_value, ImGuiComboFlags flags) { //- //Custom code sections marked with //- //Otherwise exactly the same as ImGui::BeginCombo() of ImGui v1.82 (with compat patches) static float animation_progress = 0.0f; static float scrollbar_alpha = 0.0f; float popup_expected_width = FLT_MAX; float popup_height = 0.0f; //- // Always consume the SetNextWindowSizeConstraint() call in our early return paths ImGuiContext& g = *GImGui; ImGuiWindow* window = GetCurrentWindow(); ImGuiNextWindowDataFlags backup_next_window_data_flags = g.NextWindowData.HasFlags; g.NextWindowData.ClearFlags(); // We behave like Begin() and need to consume those values if (window->SkipItems) return false; IM_ASSERT((flags & (ImGuiComboFlags_NoArrowButton | ImGuiComboFlags_NoPreview)) != (ImGuiComboFlags_NoArrowButton | ImGuiComboFlags_NoPreview)); // Can't use both flags together const ImGuiStyle& style = g.Style; const ImGuiID id = window->GetID(label); const float arrow_size = (flags & ImGuiComboFlags_NoArrowButton) ? 0.0f : GetFrameHeight(); const ImVec2 label_size = CalcTextSize(label, NULL, true); const float expected_w = CalcItemWidth(); const float w = (flags & ImGuiComboFlags_NoPreview) ? arrow_size : expected_w; const ImRect frame_bb(window->DC.CursorPos, window->DC.CursorPos + ImVec2(w, label_size.y + style.FramePadding.y * 2.0f)); const ImRect total_bb(frame_bb.Min, frame_bb.Max + ImVec2(label_size.x > 0.0f ? style.ItemInnerSpacing.x + label_size.x : 0.0f, 0.0f)); ItemSize(total_bb, style.FramePadding.y); if (!ItemAdd(total_bb, id, &frame_bb)) return false; bool hovered, held; bool pressed = ButtonBehavior(frame_bb, id, &hovered, &held); bool popup_open = IsPopupOpen(id, ImGuiPopupFlags_None); const ImU32 frame_col = GetColorU32(hovered ? ImGuiCol_FrameBgHovered : ImGuiCol_FrameBg); const float value_x2 = ImMax(frame_bb.Min.x, frame_bb.Max.x - arrow_size); RenderNavCursor(frame_bb, id); if (!(flags & ImGuiComboFlags_NoPreview)) window->DrawList->AddRectFilled(frame_bb.Min, ImVec2(value_x2, frame_bb.Max.y), frame_col, style.FrameRounding, (flags & ImGuiComboFlags_NoArrowButton) ? ImDrawFlags_RoundCornersAll : ImDrawFlags_RoundCornersLeft); if (!(flags & ImGuiComboFlags_NoArrowButton)) { ImU32 bg_col = GetColorU32((popup_open || hovered) ? ImGuiCol_ButtonHovered : ImGuiCol_Button); ImU32 text_col = GetColorU32(ImGuiCol_Text); window->DrawList->AddRectFilled(ImVec2(value_x2, frame_bb.Min.y), frame_bb.Max, bg_col, style.FrameRounding, (w <= arrow_size) ? ImDrawFlags_RoundCornersAll : ImDrawFlags_RoundCornersRight); if (value_x2 + arrow_size - style.FramePadding.x <= frame_bb.Max.x) RenderArrow(window->DrawList, ImVec2(value_x2 + style.FramePadding.y, frame_bb.Min.y + style.FramePadding.y), text_col, ImGuiDir_Down, 1.0f); } RenderFrameBorder(frame_bb.Min, frame_bb.Max, style.FrameRounding); if (preview_value != NULL && !(flags & ImGuiComboFlags_NoPreview)) { ImVec2 preview_pos = frame_bb.Min + style.FramePadding; if (g.LogEnabled) LogSetNextTextDecoration("{", "}"); RenderTextClipped(preview_pos, ImVec2(value_x2, frame_bb.Max.y), preview_value, NULL, NULL, ImVec2(0.0f, 0.0f)); } if (label_size.x > 0) RenderText(ImVec2(frame_bb.Max.x + style.ItemInnerSpacing.x, frame_bb.Min.y + style.FramePadding.y), label); if ((pressed || g.NavActivateId == id) && !popup_open) { if (window->DC.NavLayerCurrent == 0) window->NavLastIds[0] = id; OpenPopupEx(id, ImGuiPopupFlags_None); popup_open = true; //- //Reset animation animation_progress = 0.0f; scrollbar_alpha = 0.0f; //- } if (!popup_open) return false; //- ImVec2 clip_min = ImGui::GetCursorScreenPos(); clip_min.y -= style.FramePadding.y + style.PopupBorderSize; //- g.NextWindowData.HasFlags = backup_next_window_data_flags; // Set popup size if (g.NextWindowData.HasFlags & ImGuiNextWindowDataFlags_HasSizeConstraint) { g.NextWindowData.SizeConstraintRect.Min.x = ImMax(g.NextWindowData.SizeConstraintRect.Min.x, w); } else { if ((flags & ImGuiComboFlags_HeightMask_) == 0) flags |= ImGuiComboFlags_HeightRegular; IM_ASSERT(ImIsPowerOfTwo(flags & ImGuiComboFlags_HeightMask_)); // Only one int popup_max_height_in_items = -1; if (flags & ImGuiComboFlags_HeightRegular) popup_max_height_in_items = 8; else if (flags & ImGuiComboFlags_HeightSmall) popup_max_height_in_items = 4; else if (flags & ImGuiComboFlags_HeightLarge) popup_max_height_in_items = 20; ImVec2 constraint_min(0.0f, 0.0f), constraint_max(FLT_MAX, FLT_MAX); if ((g.NextWindowData.HasFlags & ImGuiNextWindowDataFlags_HasSize) == 0 || g.NextWindowData.SizeVal.x <= 0.0f) // Don't apply constraints if user specified a size constraint_min.x = w; if ((g.NextWindowData.HasFlags & ImGuiNextWindowDataFlags_HasSize) == 0 || g.NextWindowData.SizeVal.y <= 0.0f) constraint_max.y = CalcMaxPopupHeightFromItemCount(popup_max_height_in_items); SetNextWindowSizeConstraints(constraint_min, constraint_max); } char name[16]; ImFormatString(name, IM_ARRAYSIZE(name), "##Combo_%02d", g.BeginPopupStack.Size); // Recycle windows based on depth // Position the window given a custom constraint (peak into expected window size so we can position it) // This might be easier to express with an hypothetical SetNextWindowPosConstraints() function. if (ImGuiWindow* popup_window = FindWindowByName(name)) if (popup_window->WasActive) { // Always override 'AutoPosLastDirection' to not leave a chance for a past value to affect us. ImVec2 size_expected = CalcWindowNextAutoFitSize(popup_window); if (flags & ImGuiComboFlags_PopupAlignLeft) popup_window->AutoPosLastDirection = ImGuiDir_Left; // "Below, Toward Left" else popup_window->AutoPosLastDirection = ImGuiDir_Down; // "Below, Toward Right (default)" ImRect r_outer = GetPopupAllowedExtentRect(popup_window); ImVec2 pos = FindBestWindowPosForPopupEx(frame_bb.GetBL(), size_expected, &popup_window->AutoPosLastDirection, r_outer, frame_bb, ImGuiPopupPositionPolicy_ComboBox); //- //Animated popup scrolling out of the widget if (animation_progress < 1.0f) { animation_progress += ImGui::GetIO().DeltaTime * 5.0f; } else { animation_progress = 1.0f; scrollbar_alpha = std::min(scrollbar_alpha + (ImGui::GetIO().DeltaTime * 5.0f), 1.0f); } popup_height = IM_ROUND(smoothstep(animation_progress, 0.0f, size_expected.y)); //popup_height grows to full size in animation //Offset position by animation progress const bool pos_goes_down = (popup_window->AutoPosLastDirection == ImGuiDir_Down) || (popup_window->AutoPosLastDirection == ImGuiDir_Left); pos.y += (pos_goes_down) ? -size_expected.y + popup_height : size_expected.y - popup_height; popup_expected_width = size_expected.x; //- SetNextWindowPos(pos); } //- else { //Expected width is not calculated in the first frame, having it default to larger than w is avoids flicker if it is the next frame. Kinda hacky to be fair popup_expected_width = FLT_MAX; } //- //- //Hide background and border while animating since they don't get clipped (they're drawn manually below) if (animation_progress != 1.0f) { ImGui::PushStyleColor(ImGuiCol_Border, 0); ImGui::PushStyleColor(ImGuiCol_PopupBg, 0); } //Fade-in scrollbar colors ImVec4 col; for (int i = ImGuiCol_ScrollbarBg; i <= ImGuiCol_ScrollbarGrabActive; ++i) { col = style.Colors[i]; col.w *= scrollbar_alpha; ImGui::PushStyleColor(i, col); } //- // We don't use BeginPopupEx() solely because we have a custom name string, which we could make an argument to BeginPopupEx() ImGuiWindowFlags window_flags = ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_Popup | ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoSavedSettings | ImGuiWindowFlags_NoMove; //- if (scrollbar_alpha == 0.0f) { if (popup_expected_width <= w) //With popups wider than the widget, we run into resize issues when toggling the scrollbar. So we skip it there as it's the lesser evil { window_flags |= ImGuiWindowFlags_NoScrollbar; //Disable scrollbar when not visible so it can't be clicked accidentally } } //- // Horizontally align ourselves with the framed text PushStyleVar(ImGuiStyleVar_WindowPadding, ImVec2(style.FramePadding.x, style.WindowPadding.y)); bool ret = Begin(name, NULL, window_flags); PopStyleVar(); if (!ret) { EndPopup(); IM_ASSERT(0); // This should never happen as we tested for IsPopupOpen() above return false; } //- ImGui::PopStyleColor(4); //Scrollbar colors if (animation_progress != 1.0f) { ImGui::PopStyleColor(2); //Border and PopupBg ImGuiWindow* popup_window = GetCurrentWindow(); clip_min.x = popup_window->Pos.x; ImVec2 clip_max = clip_min; clip_max.x += popup_window->Size.x; //Popup open direction if ((popup_window->AutoPosLastDirection == ImGuiDir_Down) || (popup_window->AutoPosLastDirection == ImGuiDir_Left)) //ImGuiDir_Left is left aligned but still down { clip_max.y += popup_height + style.PopupBorderSize; ImGui::PushClipRect(clip_min, clip_max, false); clip_max.y -= style.PopupBorderSize; popup_window->DrawList->AddRectFilled(clip_min, clip_max, GetColorU32(ImGuiCol_PopupBg)); popup_window->DrawList->AddRect(clip_min, clip_max, GetColorU32(ImGuiCol_Border)); clip_min.y += 1; } else //ImGuiDir_Up { clip_min.y -= frame_bb.GetHeight() + popup_height + style.PopupBorderSize; clip_max.y -= frame_bb.GetHeight(); ImGui::PushClipRect(clip_min, clip_max, false); clip_min.y += style.PopupBorderSize; popup_window->DrawList->AddRectFilled(clip_min, clip_max, GetColorU32(ImGuiCol_PopupBg)); popup_window->DrawList->AddRect(clip_min, clip_max, GetColorU32(ImGuiCol_Border)); } ImGui::PopClipRect(); //Push the clip rect for the window content... this doesn't get popped anywhere, but that seems to be harmless ImGui::PushClipRect(GetCurrentWindow()->InnerClipRect.Min, GetCurrentWindow()->InnerClipRect.Max, false); ImGui::PushClipRect(clip_min, clip_max, true); } //- return true; } void TextRight(float offset_x, float fixed_w, const char* fmt, ...) { va_list args; va_start(args, fmt); TextRightV(offset_x, fixed_w, fmt, args); va_end(args); } void TextRightV(float offset_x, float fixed_w, const char* fmt, va_list args) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return; ImGuiContext& g = *GImGui; const char* text, *text_end; ImFormatStringToTempBufferV(&text, &text_end, fmt, args); TextRightUnformatted(offset_x, fixed_w, text, text_end); } void TextRightUnformatted(float offset_x, float fixed_w, const char* text, const char* text_end) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return; ImVec2 size = ImGui::CalcTextSize(text, text_end); const float available_width = (fixed_w == 0.0f) ? ImGui::GetContentRegionAvail().x : fixed_w; ImGui::SetCursorPosX(ImGui::GetCursorPosX() + (available_width - size.x - offset_x)); TextEx(text, text_end, ImGuiTextFlags_NoWidthForLargeClippedText); } void TextColoredUnformatted(const ImVec4& col, const char* text, const char* text_end) { ImGui::PushStyleColor(ImGuiCol_Text, col); ImGui::TextUnformatted(text, text_end); ImGui::PopStyleColor(); } void TextOutlined(const char* fmt, ...) { va_list args; va_start(args, fmt); TextOutlinedV(fmt, args); va_end(args); } void TextOutlinedV(const char* fmt, va_list args) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return; const char* text, *text_end; ImFormatStringToTempBufferV(&text, &text_end, fmt, args); TextUnformattedOutlined(text, text_end); } void TextUnformattedOutlined(const char* text, const char* text_end) { //This is mostly ImGui::TextUnformatted() ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return; ImGuiContext& g = *GImGui; // Accept null ranges if (text == text_end) text = text_end = ""; // Calculate length const char* text_begin = text; if (text_end == NULL) text_end = text + ImStrlen(text); // FIXME-OPT const ImVec2 pos(window->DC.CursorPos.x, window->DC.CursorPos.y + window->DC.CurrLineTextBaseOffset); // Common case const ImVec2 text_size = CalcTextSize(text_begin, text_end); ImRect bb(pos, pos + text_size); ItemSize(text_size, 0.0f); if (!ItemAdd(bb, 0)) return; // Render const bool hide_text_after_hash = true; // Hide anything after a '##' string const char* text_display_end; if (hide_text_after_hash) { text_display_end = FindRenderedTextEnd(text, text_end); } else { if (!text_end) text_end = text + ImStrlen(text); // FIXME-OPT text_display_end = text_end; } if (text != text_display_end) { const ImU32 col = GetColorU32(ImGuiCol_Text); const ImU32 col_outline = GetColorU32(Style_ImGuiCol_TextOutline); //This does indeed do 9x the AddText() calls of normal text, which is a bit wasteful but not too bad with the short strings this gets used with ImVec2 pos_outline = pos; pos_outline.y -= 1; window->DrawList->AddText(g.Font, g.FontSize, pos_outline, col_outline, text, text_display_end); pos_outline.x += 1; window->DrawList->AddText(g.Font, g.FontSize, pos_outline, col_outline, text, text_display_end); pos_outline.y += 1; window->DrawList->AddText(g.Font, g.FontSize, pos_outline, col_outline, text, text_display_end); pos_outline.y += 1; window->DrawList->AddText(g.Font, g.FontSize, pos_outline, col_outline, text, text_display_end); pos_outline.x -= 1; window->DrawList->AddText(g.Font, g.FontSize, pos_outline, col_outline, text, text_display_end); pos_outline.x -= 1; window->DrawList->AddText(g.Font, g.FontSize, pos_outline, col_outline, text, text_display_end); pos_outline.y -= 1; window->DrawList->AddText(g.Font, g.FontSize, pos_outline, col_outline, text, text_display_end); pos_outline.y -= 1; window->DrawList->AddText(g.Font, g.FontSize, pos_outline, col_outline, text, text_display_end); window->DrawList->AddText(g.Font, g.FontSize, pos, col, text, text_display_end); if (g.LogEnabled) LogRenderedText(&pos, text, text_display_end); } } void TextRightOutlined(float offset_x, float fixed_w, const char* fmt, ...) { va_list args; va_start(args, fmt); TextRightOutlinedV(offset_x, fixed_w, fmt, args); va_end(args); } void TextRightOutlinedV(float offset_x, float fixed_w, const char* fmt, va_list args) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return; const char* text, *text_end; ImFormatStringToTempBufferV(&text, &text_end, fmt, args); TextRightUnformattedOutlined(offset_x, fixed_w, text, text_end); } void TextRightUnformattedOutlined(float offset_x, float fixed_w, const char* text, const char* text_end) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return; const ImVec2 size = ImGui::CalcTextSize(text, text_end); const float available_width = (fixed_w == 0.0f) ? ImGui::GetContentRegionAvail().x : fixed_w; ImGui::SetCursorPosX(ImGui::GetCursorPosX() + (available_width - size.x - offset_x)); TextUnformattedOutlined(text, text_end); } void RenderTextClippedUnclamped(const ImVec2& pos_min, const ImVec2& pos_max, const char* text, const char* text_end, const ImVec2* text_size_if_known, const ImVec2& align, const ImRect* clip_rect) { // Hide anything after a '##' string const char* text_display_end = FindRenderedTextEnd(text, text_end); const int text_len = (int)(text_display_end - text); if (text_len == 0) return; ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; //Aside from this line, this function is identical to ImGui::RenderTextClipped() RenderTextClippedUnclampedEx(window->DrawList, pos_min, pos_max, text, text_display_end, text_size_if_known, align, clip_rect); if (g.LogEnabled) LogRenderedText(&pos_min, text, text_display_end); } void RenderTextClippedUnclampedEx(ImDrawList* draw_list, const ImVec2& pos_min, const ImVec2& pos_max, const char* text, const char* text_display_end, const ImVec2* text_size_if_known, const ImVec2& align, const ImRect* clip_rect) { // Perform CPU side clipping for single clipped element to avoid using scissor state ImVec2 pos = pos_min; const ImVec2 text_size = text_size_if_known ? *text_size_if_known : CalcTextSize(text, text_display_end, false, 0.0f); const ImVec2* clip_min = clip_rect ? &clip_rect->Min : &pos_min; const ImVec2* clip_max = clip_rect ? &clip_rect->Max : &pos_max; bool need_clipping = (pos.x + text_size.x >= clip_max->x) || (pos.y + text_size.y >= clip_max->y); if (clip_rect) // If we had no explicit clipping rectangle then pos==clip_min need_clipping |= (pos.x < clip_min->x) || (pos.y < clip_min->y); // Align whole block. We should defer that to the better rendering function when we'll have support for individual line alignment. //Aside from these two lines, this function is identical to ImGui::RenderTextClippedEx() if (align.x > 0.0f) pos.x = pos.x + (pos_max.x - pos.x - text_size.x) * align.x; if (align.y > 0.0f) pos.y = pos.y + (pos_max.y - pos.y - text_size.y) * align.y; // Render if (need_clipping) { ImVec4 fine_clip_rect(clip_min->x, clip_min->y, clip_max->x, clip_max->y); draw_list->AddText(nullptr, 0.0f, pos, GetColorU32(ImGuiCol_Text), text, text_display_end, 0.0f, &fine_clip_rect); } else { draw_list->AddText(nullptr, 0.0f, pos, GetColorU32(ImGuiCol_Text), text, text_display_end, 0.0f, nullptr); } } int g_Stretched_BeginIndex = 0; void BeginStretched() { g_Stretched_BeginIndex = ImGui::GetWindowDrawList()->VtxBuffer.Size; } void EndStretched(float scale_x) { auto& buffer = ImGui::GetWindowDrawList()->VtxBuffer; const float base_x = (buffer.size() > g_Stretched_BeginIndex) ? buffer[g_Stretched_BeginIndex].pos.x : 0.0f; for (int i = g_Stretched_BeginIndex; i < buffer.Size; ++i) { buffer[i].pos.x = ((buffer[i].pos.x - base_x) * scale_x) + base_x; } } //Takes a nicely adjustable function and bolts it down to the options we need after making a few modifications bool ColorPicker4Simple(const char* str_id, float col[4], float ref_col[4], const char* label_color_current, const char* label_color_original, float scale) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; //Hacky solution to make right mouse enable text input on the slider while not touching ImGui code or generalizing it as ctrl press ImGuiIO& io = ImGui::GetIO(); const bool mouse_left_clicked_old = io.MouseClicked[ImGuiMouseButton_Left]; const float mouse_left_down_duration_old = io.MouseDownDuration[ImGuiMouseButton_Left]; const bool key_ctrl_old = io.KeyCtrl; if (io.MouseClicked[ImGuiMouseButton_Right]) { io.MouseDown[ImGuiMouseButton_Left] = true; io.MouseClicked[ImGuiMouseButton_Left] = true; io.MouseDownDuration[ImGuiMouseButton_Left] = 0.0f; io.KeyCtrl = true; io.KeyMods |= ImGuiMod_Ctrl; //Mods needs to stay consistent with KeyCtrl } ImGuiContext& g = *GImGui; const ImGuiStyle& style = g.Style; //Fixed flags, but we still kept some checks below in case we need to adjust later const ImGuiColorEditFlags flags = ImGuiColorEditFlags_DisplayRGB | ImGuiColorEditFlags_Float | ImGuiColorEditFlags_AlphaBar | ImGuiColorEditFlags_NoSidePreview | ImGuiColorEditFlags_NoLabel | ImGuiColorEditFlags_NoTooltip | ImGuiColorEditFlags_NoDragDrop; const float start_y = ImGui::GetCursorScreenPos().y; const float square_sz = ImGui::GetFrameHeight() * scale; const float picker_width = square_sz * 15.5f; const float picker_bar_height = picker_width - (2.0f * (square_sz + style.ItemInnerSpacing.x)); g.NextItemData.ClearFlags(); ImGui::BeginGroup(); ImGui::PushID(str_id); bool value_changed = false; ImGuiColorEditFlags picker_flags_to_forward = ImGuiColorEditFlags_DataTypeMask_ | ImGuiColorEditFlags_PickerMask_ | ImGuiColorEditFlags_InputMask_ | ImGuiColorEditFlags_HDR | ImGuiColorEditFlags_NoAlpha | ImGuiColorEditFlags_AlphaBar | ImGuiColorEditFlags_NoTooltip | ImGuiColorEditFlags_NoDragDrop; ImGuiColorEditFlags picker_flags = (flags & picker_flags_to_forward) | ImGuiColorEditFlags_DisplayMask_ | ImGuiColorEditFlags_NoLabel | ImGuiColorEditFlags_NoSidePreview | ImGuiColorEditFlags_NoSmallPreview | ImGuiColorEditFlags_NoOptions; ImGui::SetNextItemWidth(picker_width); value_changed |= ImGui::ColorPicker4("##picker", col, picker_flags, &g.ColorPickerRef.x); //Restore hack io.MouseDown[ImGuiMouseButton_Left] = mouse_left_clicked_old; io.MouseClicked[ImGuiMouseButton_Left] = mouse_left_clicked_old; io.MouseDownDuration[ImGuiMouseButton_Left] = mouse_left_down_duration_old; io.KeyCtrl = key_ctrl_old; if (!io.KeyCtrl) { io.KeyMods &= ~ImGuiMod_Ctrl; } //Picker style switching without popup if ( (ImGui::IsItemClicked(ImGuiMouseButton_Right)) && (ImGui::GetMousePos().y <= start_y + picker_bar_height) ) //(don't react to text input clicks) { ImGuiColorEditFlags picker_flags = (g.ColorEditOptions & ImGuiColorEditFlags_PickerHueBar) ? ImGuiColorEditFlags_PickerHueWheel : ImGuiColorEditFlags_PickerHueBar; g.ColorEditOptions = (g.ColorEditOptions & ~ImGuiColorEditFlags_PickerMask_) | (picker_flags & ImGuiColorEditFlags_PickerMask_); } //Side previews, but translatable ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); window->DC.CursorPos.y -= style.ItemSpacing.y; ImGui::BeginGroup(); ImGui::PushItemFlag(ImGuiItemFlags_NoNavDefaultFocus, true); ImVec4 col_v4(col[0], col[1], col[2], (flags & ImGuiColorEditFlags_NoAlpha) ? 1.0f : col[3]); if ((flags & ImGuiColorEditFlags_NoLabel)) ImGui::TextUnformatted(label_color_current); ImGuiColorEditFlags sub_flags_to_forward = ImGuiColorEditFlags_InputMask_ | ImGuiColorEditFlags_HDR | ImGuiColorEditFlags_AlphaPreviewHalf | ImGuiColorEditFlags_NoTooltip | ImGuiColorEditFlags_NoDragDrop; ImGui::ColorButton("##current", col_v4, (flags & sub_flags_to_forward), ImVec2(square_sz * 3, square_sz * 2)); if (ref_col != nullptr) { ImGui::TextUnformatted(label_color_original); ImVec4 ref_col_v4(ref_col[0], ref_col[1], ref_col[2], (flags & ImGuiColorEditFlags_NoAlpha) ? 1.0f : ref_col[3]); if (ImGui::ColorButton("##original", ref_col_v4, (flags & sub_flags_to_forward), ImVec2(square_sz * 3, square_sz * 2))) { memcpy(col, ref_col, ((flags & ImGuiColorEditFlags_NoAlpha) ? 3 : 4) * sizeof(float)); value_changed = true; } } ImGui::PopItemFlag(); //ImGuiItemFlags_NoNavDefaultFocus ImGui::EndGroup(); ImGui::PopID(); ImGui::EndGroup(); if (value_changed) ImGui::MarkItemEdited(g.LastItemData.ID); return value_changed; } bool CollapsingHeaderPadded(const char* label, ImGuiTreeNodeFlags flags) { ImGuiWindow* window = GetCurrentWindow(); //Move back a pixel to fix CollapsingHeader()'s position being off by one for some reason window->DC.CursorPos.x -= 1.0f; //Temporarily modify window padding to fool CollapsingHeader to size differently const float padding_x = ImGui::GetStyle().ItemInnerSpacing.x / 2.0f; window->WindowPadding.x -= padding_x; bool ret = ImGui::CollapsingHeader(label, flags); window->WindowPadding.x += padding_x; return ret; } struct CollapsingAreaState { ImGuiID WidgetID = 0; float WidgetBeginY = 0.0f; bool PushedClipRect = false; bool PushedItemDisabled = false; }; ImVector g_CollapsingArea_Stack; void BeginCollapsingArea(const char* str_id, bool show_content, float& persist_animation_progress) { g_CollapsingArea_Stack.push_back(CollapsingAreaState()); CollapsingAreaState& state = g_CollapsingArea_Stack.back(); //Animate when changing between show_content state const float animation_step = ImGui::GetIO().DeltaTime * 3.0f; persist_animation_progress = clamp(persist_animation_progress + ((show_content) ? animation_step : -animation_step), 0.0f, 1.0f); //Set clipping state.WidgetID = ImGui::GetID(str_id); //Don't push clip rect on full progress to allow for popups and such if (persist_animation_progress != 1.0f) { const float content_height = ImGui::GetStateStorage()->GetFloat(state.WidgetID, 0.0f); const float clip_height = smoothstep(persist_animation_progress, 0.0f, content_height); ImVec2 clip_begin = ImGui::GetCursorScreenPos(); ImVec2 clip_end(clip_begin.x + ImGui::GetContentRegionAvail().x + ImGui::GetStyle().ItemSpacing.x, clip_begin.y + clip_height); ImGui::PushClipRect(clip_begin, clip_end, true); state.PushedClipRect = true; //Pull cursor position further up to make widgets scroll down as they animate, keep start Y-pos in global to use in the next EndCollapsingArea() call state.WidgetBeginY = (ImGui::GetCursorPosY() - content_height) + clip_height; ImGui::SetCursorPosY(state.WidgetBeginY); if (persist_animation_progress == 0.0f) { PushItemDisabledNoVisual(); state.PushedItemDisabled = true; } } } void EndCollapsingArea() { IM_ASSERT(!g_CollapsingArea_Stack.empty() && "Called EndCollapsingArea() before BeginCollapsingArea()"); CollapsingAreaState& state = g_CollapsingArea_Stack.back(); float& content_height = *ImGui::GetStateStorage()->GetFloatRef(state.WidgetID); content_height = ImGui::GetCursorPosY() - state.WidgetBeginY; if (state.PushedClipRect) { ImGui::PopClipRect(); } if (state.PushedItemDisabled) { PopItemDisabledNoVisual(); } g_CollapsingArea_Stack.pop_back(); } void PushItemDisabled() { const ImGuiStyle& style = ImGui::GetStyle(); ImGui::PushItemFlag(ImGuiItemFlags_Disabled, true); ImGui::PushStyleVar(ImGuiStyleVar_Alpha, style.Alpha * style.DisabledAlpha); } void PopItemDisabled() { ImGui::PopItemFlag(); ImGui::PopStyleVar(); } void PushItemDisabledNoVisual() { ImGui::PushItemFlag(ImGuiItemFlags_Disabled, true); } void PopItemDisabledNoVisual() { ImGui::PopItemFlag(); } void ConfigDisableCtrlTab() { GImGui->ConfigNavWindowingKeyNext = ImGuiKey_None; GImGui->ConfigNavWindowingKeyPrev = ImGuiKey_None; } bool PopupContextMenuInputText(const char* str_id, char* str_buffer, size_t buffer_size, bool paste_remove_newlines) { bool ret = false; if (ImGui::BeginPopupContextItem(str_id)) { if (ImGui::MenuItem("Copy all")) { ImGui::SetClipboardText(str_buffer); } if (ImGui::MenuItem("Replace with Clipboard", nullptr, false, (ImGui::GetClipboardText() != nullptr) )) { std::string str(ImGui::GetClipboardText()); if (paste_remove_newlines) { //Remove newlines (all kinds, since you never know what might be in a clipboard) std::string newlines[] = {"\r\n", "\n", "\r"}; for (auto& nline : newlines) { size_t start_pos = 0; while ((start_pos = str.find(nline, start_pos)) != std::string::npos) { str.replace(start_pos, nline.length(), " "); } } } //Copy to buffer size_t copied_length = str.copy(str_buffer, buffer_size - 1); str_buffer[copied_length] = '\0'; ret = true; } ImGui::EndPopup(); } return ret; } //ImGui got rid of direct nav input access, but we keep it around as an abstraction layer ImGuiKey MapNavToKey(ImGuiNavInput nav_input, ImGuiInputSource input_source) { ImGuiKey imgui_key = ImGuiKey_None; if (input_source == ImGuiInputSource_Keyboard) { switch (nav_input) { case ImGuiNavInput_Activate: imgui_key = ImGuiKey_Space; break; case ImGuiNavInput_Cancel: imgui_key = ImGuiKey_Escape; break; case ImGuiNavInput_Input: imgui_key = ImGuiKey_Enter; break; case ImGuiNavInput_Menu: imgui_key = ImGuiMod_Alt; break; case ImGuiNavInput_DpadLeft: imgui_key = ImGuiKey_LeftArrow; break; case ImGuiNavInput_DpadRight: imgui_key = ImGuiKey_RightArrow; break; case ImGuiNavInput_DpadUp: imgui_key = ImGuiKey_UpArrow; break; case ImGuiNavInput_DpadDown: imgui_key = ImGuiKey_DownArrow; break; case ImGuiNavInput_TweakSlow: imgui_key = ImGuiMod_Ctrl; break; case ImGuiNavInput_TweakFast: imgui_key = ImGuiMod_Shift; break; } } else if (input_source == ImGuiInputSource_Gamepad) { switch (nav_input) { case ImGuiNavInput_Activate: imgui_key = ImGuiKey_GamepadFaceDown; break; case ImGuiNavInput_Cancel: imgui_key = ImGuiKey_GamepadFaceRight; break; case ImGuiNavInput_Input: imgui_key = ImGuiKey_GamepadFaceLeft; break; case ImGuiNavInput_Menu: imgui_key = ImGuiKey_GamepadFaceUp; break; case ImGuiNavInput_DpadLeft: imgui_key = ImGuiKey_GamepadDpadLeft; break; case ImGuiNavInput_DpadRight: imgui_key = ImGuiKey_GamepadDpadRight; break; case ImGuiNavInput_DpadUp: imgui_key = ImGuiKey_GamepadDpadUp; break; case ImGuiNavInput_DpadDown: imgui_key = ImGuiKey_GamepadDpadDown; break; case ImGuiNavInput_TweakSlow: imgui_key = ImGuiKey_GamepadL1; break; case ImGuiNavInput_TweakFast: imgui_key = ImGuiKey_GamepadR1; break; } } return imgui_key; } bool IsNavInputDown(ImGuiNavInput nav_input) { return ImGui::IsKeyDown(MapNavToKey(nav_input, GImGui->NavInputSource)); } bool ImGui::IsNavInputPressed(ImGuiNavInput nav_input, bool repeat) { return ImGui::IsKeyPressed(MapNavToKey(nav_input, GImGui->NavInputSource), repeat); } bool ImGui::IsNavInputReleased(ImGuiNavInput nav_input) { return ImGui::IsKeyReleased(MapNavToKey(nav_input, GImGui->NavInputSource)); } float ImGui::GetPreviousLineHeight() { return GImGui->CurrentWindow->DC.PrevLineSize.y; } void SetPreviousLineHeight(float height) { GImGui->CurrentWindow->DC.PrevLineSize.y = height; } bool HasHoveredNewItem() { const ImGuiContext& g = *GImGui; bool blocked_by_active_item = (g.ActiveId != 0 && !g.ActiveIdAllowOverlap); return ( (g.HoveredId != g.HoveredIdPreviousFrame) && (g.HoveredId != 0) && (!g.HoveredIdIsDisabled) && (!blocked_by_active_item) ); } bool IsAnyItemActiveOrDeactivated() { const ImGuiContext& g = *GImGui; return ( (g.ActiveId != 0) || (g.ActiveIdPreviousFrame != 0) ); } bool IsAnyItemDeactivated() { const ImGuiContext& g = *GImGui; return ( (g.ActiveIdPreviousFrame != 0) && (g.ActiveId != g.ActiveIdPreviousFrame) ); } bool IsAnyInputTextActive() { const ImGuiContext& g = *GImGui; return ( (g.ActiveId != 0) && (g.ActiveId == g.InputTextState.ID) ); } bool IsAnyTempInputTextActive() { const ImGuiContext& g = *GImGui; return ( (g.ActiveId != 0) && (g.ActiveId == g.InputTextState.ID) && (g.TempInputId == g.InputTextState.ID) ); } bool IsAnyMouseClicked() { const ImGuiContext& g = *GImGui; for (int n = 0; n < IM_ARRAYSIZE(g.IO.MouseDown); n++) if (g.IO.MouseClicked[n]) return true; return false; } void BlockWidgetInput() { ImGuiContext& g = *GImGui; ImGui::SetActiveID(ImGui::GetID("ImGuiExtInputBlock"), nullptr); ImGui::SetKeyOwner(ImGuiKey_MouseWheelX, g.ActiveId); ImGui::SetKeyOwner(ImGuiKey_MouseWheelY, g.ActiveId); g.WheelingWindow = nullptr; g.WheelingWindowReleaseTimer = 0.0f; } void HScrollWindowFromMouseWheelV() { ImGuiContext& g = *GImGui; //Don't do anything is real hscroll is active if ( (g.IO.MouseWheelH != 0.0f && !g.IO.KeyShift) || (g.IO.MouseWheel != 0.0f && g.IO.KeyShift) ) return; ImGuiWindow* window = ImGui::GetCurrentWindow(); if (g.WheelingWindow != window) return; const float wheel_x = g.IO.MouseWheel; float max_step = window->InnerRect.GetWidth() * 0.67f; float scroll_step = ImTrunc(ImMin(2.0f * window->CalcFontSize(), max_step)); ImGui::SetScrollX(window, window->Scroll.x - wheel_x * scroll_step); } void ScrollBeginStackParentWindow() { ImGuiContext& g = *GImGui; ImGuiWindow* window = ImGui::GetCurrentWindowRead(); if (g.WheelingWindow != window) return; ImGuiWindow* window_target = window->ParentWindowInBeginStack; if (window_target == nullptr) return; const float wheel_x = g.IO.MouseWheelH; const float wheel_y = g.IO.MouseWheel; //HScroll float max_step = window_target->InnerRect.GetWidth() * 0.67f; float scroll_step = ImTrunc(ImMin(2.0f * window_target->CalcFontSize(), max_step)); ImGui::SetScrollX(window_target, window_target->Scroll.x - wheel_x * scroll_step); //VScroll max_step = window_target->InnerRect.GetHeight() * 0.67f; scroll_step = ImTrunc(ImMin(5.0f * window_target->CalcFontSize(), max_step)); ImGui::SetScrollY(window_target, window_target->Scroll.y - wheel_y * scroll_step); } bool IsAnyScrollBarVisible() { ImGuiWindow* window = ImGui::GetCurrentWindowRead(); return ((window->ScrollbarX) || (window->ScrollbarY)); } ImVec4 BeginTitleBar() { ImGuiStyle& style = ImGui::GetStyle(); ImRect rect = ImGui::GetCurrentWindowRead()->TitleBarRect(); ImGui::SetCursorScreenPos({rect.Min.x + style.WindowBorderSize + style.FramePadding.x, rect.Min.y + style.FramePadding.y}); ImGui::PushClipRect(rect.Min, rect.Max, false); return ImVec4(rect.Min.x, rect.Min.y, rect.Max.x, rect.Max.y); } void EndTitleBar() { ImGui::PopClipRect(); ImGuiWindow* window = ImGui::GetCurrentWindow(); ImGui::SetCursorScreenPos(window->ContentRegionRect.Min); window->DC.CursorMaxPos.x = 0; //Title bar does *not* affect overall window width as it messes with auto-resize } bool StringContainsUnmappedCharacter(const char* str) { if (GImGui == nullptr) return true; //Use current style font if possible, otherwise fall back to default font ImFont* font = (GImGui->FontStack.empty()) ? ImGui::GetDefaultFont() : GImGui->FontStack.back(); if (font == nullptr) return true; const char* str_end = str + strlen(str); ImWchar32 c; int decoded_length; while (str < str_end) { decoded_length = ImTextCharFromUtf8(&c, str, str_end); if ( (c >= ' ') && (font->FindGlyphNoFallback((ImWchar)c) == nullptr) ) //Don't return true on unprintable characters being unmapped { return true; } str += decoded_length; } return false; } std::string StringEllipsis(const char* str, float width_max) { //Naive approach, but we're not supposed to use RenderTextEllipsis(), so this will do const char* str_begin = str; const char* str_end = str + strlen(str); //Handle corner case of text fitting without ellipsis, but not with if (ImGui::CalcTextSize(str, str_end).x <= width_max) { return str; } float ellipsis_width = ImGui::CalcTextSize("...").x; bool is_full_string = true; ImWchar32 c; int decoded_length = 0; while (str < str_end) { if (ImGui::CalcTextSize(str_begin, str).x + ellipsis_width >= width_max) { str -= decoded_length; is_full_string = false; break; } decoded_length = ImTextCharFromUtf8(&c, str, str_end); str += decoded_length; } std::string str_out(str_begin, str - str_begin); if (!is_full_string) { str_out.append("..."); } return str_out; } bool DraggableRectArea(const char* str_id, const ImVec2& area_size, ImGuiDraggableRectAreaState& state) { ImGuiIO& io = ImGui::GetIO(); ImVec2& offset = state.RectPos; ImVec2& size = state.RectSize; ImVec2& offset_start = state.RectPosDragStart; ImVec2& size_start = state.RectSizeDragStart; ImVec2 offset_prev = offset; ImVec2 size_prev = size; ImGuiMouseButton& drag_mouse_button = state.DragMouseButton; ImGuiDir& edge_drag_h_dir = state.EdgeDragHDir; ImGuiDir& edge_drag_v_dir = state.EdgeDragVDir; bool& is_edge_drag_active = state.EdgeDragActive; bool& highlight_edge = state.EdgeDragHighlightVisible; bool is_drag_active = false; //This widget is mouse-only and interacts weirdly with the ImGui navigation. //I've been unable to get ImGui to skip over it or bend it to work in sane manner, so I've resorted to disabling the items when nav is visible const bool was_disabled_initially = (GImGui->CurrentItemFlags & ImGuiItemFlags_Disabled); const bool disable_for_nav = (io.NavVisible && !ImGui::IsMouseClicked(ImGuiMouseButton_Left)); if (disable_for_nav) ImGui::PushItemDisabledNoVisual(); ImGui::PushStyleVar(ImGuiStyleVar_WindowPadding, {0.0f, 0.0f}); if (ImGui::BeginChild(str_id, area_size, ImGuiChildFlags_Borders | ImGuiChildFlags_NavFlattened, ImGuiWindowFlags_NoScrollbar | ImGuiWindowFlags_NoScrollWithMouse)) { const float drag_threshold_prev = io.MouseDragThreshold; io.MouseDragThreshold = 0.0f; ImVec2 pos_area = ImGui::GetCursorScreenPos(); ImVec2 pos_button = pos_area; pos_button.x += roundf(offset.x); pos_button.y += roundf(offset.y); const float drag_margin = ImGui::GetFontSize() / 2.0f; //Draw rectangle manually ImVec4 col_button = ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered); ImVec4 col_fill = col_button; col_fill.w = 0.25f; ImGui::GetWindowDrawList()->AddRectFilled(pos_button, {roundf(pos_button.x + size.x), roundf(pos_button.y + size.y)}, ImGui::GetColorU32(col_fill)); ImGui::GetWindowDrawList()->AddRect(pos_button, {roundf(pos_button.x + size.x), roundf(pos_button.y + size.y)}, ImGui::GetColorU32(col_button)); if (highlight_edge) { if ((size.x > drag_margin * 2.0f) && (size.y > drag_margin * 2.0f)) { col_fill.w = 0.10f; //This highlights the inner part actually, but still does the trick ImGui::GetWindowDrawList()->AddRectFilled({pos_button.x + drag_margin, pos_button.y + drag_margin}, {roundf(pos_button.x + size.x - drag_margin), roundf(pos_button.y + size.y - drag_margin)}, ImGui::GetColorU32(col_fill)); } } highlight_edge = false; //Invisible button spanning the entire area to catch right clicks anywhere for relative drag ImGui::SetNextItemAllowOverlap(); if (ImGui::InvisibleButton("DraggableRectArea", area_size, ImGuiButtonFlags_MouseButtonRight | ImGuiButtonFlags_PressedOnClick)) { offset_start = offset; size_start = size; drag_mouse_button = ImGuiMouseButton_Right; edge_drag_h_dir = ImGuiDir_None; edge_drag_v_dir = ImGuiDir_None; is_edge_drag_active = false; } else if (ImGui::IsItemActive()) { is_drag_active = true; } //Pad the button size/pos to allow for off-edge grabs ImVec2 pos_button_padded = pos_button; pos_button_padded.x -= drag_margin / 2.0f; pos_button_padded.y -= drag_margin / 2.0f; ImVec2 size_button_padded = size; size_button_padded.x += drag_margin; size_button_padded.y += drag_margin; ImGui::SetCursorScreenPos(pos_button_padded); if (ImGui::InvisibleButton("DraggableRect", size_button_padded, ImGuiButtonFlags_MouseButtonLeft | ImGuiButtonFlags_PressedOnClick | ImGuiButtonFlags_AllowOverlap)) { offset_start = offset; size_start = size; drag_mouse_button = ImGuiMouseButton_Left; const ImVec2 pos(io.MouseClickedPos[drag_mouse_button].x - pos_area.x, io.MouseClickedPos[drag_mouse_button].y - pos_area.y); edge_drag_h_dir = ImGuiDir_None; edge_drag_v_dir = ImGuiDir_None; if (pos.x < offset.x + drag_margin) edge_drag_h_dir = ImGuiDir_Left; else if (pos.x > offset.x + size.x - drag_margin) edge_drag_h_dir = ImGuiDir_Right; if (pos.y < offset.y + drag_margin) edge_drag_v_dir = ImGuiDir_Up; else if (pos.y > offset.y + size.y - drag_margin) edge_drag_v_dir = ImGuiDir_Down; is_edge_drag_active = ((edge_drag_h_dir != ImGuiDir_None) || (edge_drag_v_dir != ImGuiDir_None)); } else if (ImGui::IsItemActive()) { is_drag_active = true; } if (is_drag_active) { if (is_edge_drag_active) { if (edge_drag_h_dir == ImGuiDir_Left) { size.x = size_start.x - ImGui::GetMouseDragDelta(drag_mouse_button).x; offset.x = offset_start.x - (size.x - size_start.x); if (offset.x < 0.0f) { size.x += offset.x; offset.x = 0.0f; } else if (offset.x > area_size.x) //When dragged to opposite edge (width is negative) { size.x -= area_size.x - offset.x; offset.x = area_size.x; } } else if (edge_drag_h_dir == ImGuiDir_Right) { size.x = size_start.x + ImGui::GetMouseDragDelta(drag_mouse_button).x; size.x = std::min(size.x, area_size.x - offset.x); offset.x = offset_start.x; if (size.x + offset.x < 0.0f) //When dragged to opposite edge (width is negative) { size.x -= size.x + offset.x; } } if (edge_drag_v_dir == ImGuiDir_Up) { size.y = size_start.y - ImGui::GetMouseDragDelta(drag_mouse_button).y; offset.y = offset_start.y - (size.y - size_start.y); if (offset.y < 0.0f) { size.y += offset.y; offset.y = 0.0f; } else if (offset.y > area_size.y) //When dragged to opposite edge (height is negative) { size.y -= area_size.y - offset.y; offset.y = area_size.y; } } else if (edge_drag_v_dir == ImGuiDir_Down) { size.y = size_start.y + ImGui::GetMouseDragDelta(drag_mouse_button).y; size.y = std::min(size.y, area_size.y - offset.y); offset.y = offset_start.y; if (size.y + offset.y < 0.0f) //When dragged to opposite edge (height is negative) { size.y -= size.y + offset.y; } } } else //Normal drag { //Alt key scroll swapping is usually already done by ImGui but seems to be blocked by something down the line so we do it ourselves, whatever if (io.KeyAlt) { io.MouseWheelH = -io.MouseWheel; io.MouseWheel = 0.0f; } //Adjust size from wheel input (with deadzone for smooth scrolling input) if (fabs(io.MouseWheelH) > 0.05f) { float size_diff = size.x; size.x *= 1.0f + (io.MouseWheelH / -10.0f); size_diff = size.x - size_diff; offset_start.x -= size_diff / 2.0f; } if (fabs(io.MouseWheel) > 0.05f) { float size_diff = size.y; size.y *= 1.0f + (io.MouseWheel / 10.0f); size_diff = size.y - size_diff; offset_start.y -= size_diff / 2.0f; } offset.x = offset_start.x + ImGui::GetMouseDragDelta(drag_mouse_button).x; offset.y = offset_start.y + ImGui::GetMouseDragDelta(drag_mouse_button).y; } //Correct inverted rectangle if (size.x < 0.0f) { offset.x += size.x; size.x *= -1.0f; } if (size.y < 0.0f) { offset.y += size.y; size.y *= -1.0f; } //Clamp to area offset.x = clamp(offset.x, 0.0f, area_size.x - size.x); offset.y = clamp(offset.y, 0.0f, area_size.y - size.y); size.x = clamp(size.x, 1.0f, area_size.x); size.y = clamp(size.y, 1.0f, area_size.y); } else { highlight_edge = ImGui::IsItemHovered( (was_disabled_initially) ? 0 : ImGuiHoveredFlags_AllowWhenDisabled ); } io.MouseDragThreshold = drag_threshold_prev; } ImGui::EndChild(); ImGui::PopStyleVar(); if (disable_for_nav) ImGui::PopItemDisabledNoVisual(); return ( (is_drag_active) && ((offset.x != offset_prev.x) || (offset.y != offset_prev.y) || (size.x != size_prev.x) || (size.y != size_prev.y)) ); } ImGuiMouseState::ImGuiMouseState() { //Set everything to zero memset(this, 0, sizeof(*this)); MousePos = MousePosPrev = ImVec2(-FLT_MAX,-FLT_MAX); } void ImGuiMouseState::SetFromGlobalState() { const ImGuiIO& io = ImGui::GetIO(); MousePos = io.MousePos; std::copy(std::begin(io.MouseDown), std::end(io.MouseDown), MouseDown); MouseWheel = io.MouseWheel; MouseWheelH = io.MouseWheelH; MouseDelta = io.MouseDelta; MousePosPrev = io.MousePosPrev; std::copy(std::begin(io.MouseClickedPos), std::end(io.MouseClickedPos), MouseClickedPos); std::copy(std::begin(io.MouseClickedTime), std::end(io.MouseClickedTime), MouseClickedTime); std::copy(std::begin(io.MouseClicked), std::end(io.MouseClicked), MouseClicked); std::copy(std::begin(io.MouseDoubleClicked), std::end(io.MouseDoubleClicked), MouseDoubleClicked); std::copy(std::begin(io.MouseClickedCount), std::end(io.MouseClickedCount), MouseClickedCount); std::copy(std::begin(io.MouseClickedLastCount), std::end(io.MouseClickedLastCount), MouseClickedLastCount); std::copy(std::begin(io.MouseReleased), std::end(io.MouseReleased), MouseReleased); std::copy(std::begin(io.MouseDownOwned), std::end(io.MouseDownOwned), MouseDownOwned); std::copy(std::begin(io.MouseDownOwnedUnlessPopupClose), std::end(io.MouseDownOwnedUnlessPopupClose), MouseDownOwnedUnlessPopupClose); std::copy(std::begin(io.MouseDownDuration), std::end(io.MouseDownDuration), MouseDownDuration); std::copy(std::begin(io.MouseDownDurationPrev), std::end(io.MouseDownDurationPrev), MouseDownDurationPrev); std::copy(std::begin(io.MouseDragMaxDistanceSqr), std::end(io.MouseDragMaxDistanceSqr), MouseDragMaxDistanceSqr); } void ImGuiMouseState::ApplyToGlobalState() { ImGuiIO& io = ImGui::GetIO(); io.MousePos = MousePos; std::copy(std::begin(MouseDown), std::end(MouseDown), io.MouseDown); io.MouseWheel = MouseWheel; io.MouseWheelH = MouseWheelH; io.MouseDelta = MouseDelta; io.MousePosPrev = MousePosPrev; std::copy(std::begin(MouseClickedPos), std::end(MouseClickedPos), io.MouseClickedPos); std::copy(std::begin(MouseClickedTime), std::end(MouseClickedTime), io.MouseClickedTime); std::copy(std::begin(MouseClicked), std::end(MouseClicked), io.MouseClicked); std::copy(std::begin(MouseDoubleClicked), std::end(MouseDoubleClicked), io.MouseDoubleClicked); std::copy(std::begin(MouseClickedCount), std::end(MouseClickedCount), io.MouseClickedCount); std::copy(std::begin(MouseClickedLastCount), std::end(MouseClickedLastCount), io.MouseClickedLastCount); std::copy(std::begin(MouseReleased), std::end(MouseReleased), io.MouseReleased); std::copy(std::begin(MouseDownOwned), std::end(MouseDownOwned), io.MouseDownOwned); std::copy(std::begin(MouseDownOwnedUnlessPopupClose), std::end(MouseDownOwnedUnlessPopupClose), io.MouseDownOwnedUnlessPopupClose); std::copy(std::begin(MouseDownDuration), std::end(MouseDownDuration), io.MouseDownDuration); std::copy(std::begin(MouseDownDurationPrev), std::end(MouseDownDurationPrev), io.MouseDownDurationPrev); std::copy(std::begin(MouseDragMaxDistanceSqr), std::end(MouseDragMaxDistanceSqr), io.MouseDragMaxDistanceSqr); } void ImGuiMouseState::Advance() { //This is almost just ImGui::UpdateMouseInputs(), but we don't touch any global state here const ImGuiContext& g = *ImGui::GetCurrentContext(); // Round mouse position to avoid spreading non-rounded position (e.g. UpdateManualResize doesn't support them well) if (IsMousePosValid(&MousePos)) MousePos = ImFloor(MousePos); // If mouse just appeared or disappeared (usually denoted by -FLT_MAX components) we cancel out movement in MouseDelta if (IsMousePosValid(&MousePos) && IsMousePosValid(&MousePosPrev)) MouseDelta = MousePos - MousePosPrev; else MouseDelta = ImVec2(0.0f, 0.0f); MousePosPrev = MousePos; for (int i = 0; i < IM_ARRAYSIZE(MouseDown); i++) { MouseClicked[i] = MouseDown[i] && MouseDownDuration[i] < 0.0f; MouseClickedCount[i] = 0; // Will be filled below MouseReleased[i] = !MouseDown[i] && MouseDownDuration[i] >= 0.0f; MouseDownDurationPrev[i] = MouseDownDuration[i]; MouseDownDuration[i] = MouseDown[i] ? (MouseDownDuration[i] < 0.0f ? 0.0f : MouseDownDuration[i] + g.IO.DeltaTime) : -1.0f; if (MouseClicked[i]) { bool is_repeated_click = false; if ((float)(g.Time - MouseClickedTime[i]) < g.IO.MouseDoubleClickTime) { ImVec2 delta_from_click_pos = IsMousePosValid(&MousePos) ? (MousePos - MouseClickedPos[i]) : ImVec2(0.0f, 0.0f); if (ImLengthSqr(delta_from_click_pos) < g.IO.MouseDoubleClickMaxDist * g.IO.MouseDoubleClickMaxDist) is_repeated_click = true; } if (is_repeated_click) MouseClickedLastCount[i]++; else MouseClickedLastCount[i] = 1; MouseClickedTime[i] = g.Time; MouseClickedPos[i] = MousePos; MouseClickedCount[i] = MouseClickedLastCount[i]; MouseDragMaxDistanceSqr[i] = 0.0f; } else if (MouseDown[i]) { // Maintain the maximum distance we reaching from the initial click position, which is used with dragging threshold float delta_sqr_click_pos = IsMousePosValid(&MousePos) ? ImLengthSqr(MousePos - MouseClickedPos[i]) : 0.0f; MouseDragMaxDistanceSqr[i] = ImMax(MouseDragMaxDistanceSqr[i], delta_sqr_click_pos); } // We provide io.MouseDoubleClicked[] as a legacy service MouseDoubleClicked[i] = (MouseClickedCount[i] == 2); } } ActiveWidgetStateStorage::ActiveWidgetStateStorage() { //These need to be the same or things will explode IM_ASSERT(sizeof(ImGuiDeactivatedItemDataInternal) == sizeof(DeactivatedItemData)); IM_ASSERT(sizeof(ActiveIdValueOnActivation) == sizeof(ActiveIdValueOnActivation)); IsInitialized = false; HoveredId = 0; HoveredIdPreviousFrame = 0; HoveredIdPreviousFrameItemCount = 0; HoveredIdTimer = 0.0f; HoveredIdNotActiveTimer = 0.0f; HoveredIdAllowOverlap = false; HoveredIdIsDisabled = false; ItemUnclipByLog = false; ActiveId = 0; ActiveIdIsAlive = 0; ActiveIdTimer = 0.0f; ActiveIdIsJustActivated = false; ActiveIdAllowOverlap = false; ActiveIdNoClearOnFocusLoss = false; ActiveIdHasBeenPressedBefore = false; ActiveIdHasBeenEditedBefore = false; ActiveIdHasBeenEditedThisFrame = false; ActiveIdFromShortcut = false; ActiveIdUsingNavDirMask = 0x00; ActiveIdClickOffset = ImVec2(-1, -1); ActiveIdWindow = nullptr; ActiveIdSource = ImGuiInputSource_None; ActiveIdMouseButton = -1; ActiveIdPreviousFrame = 0; memset(&DeactivatedItemData, 0, sizeof(DeactivatedItemData)); memset(&ActiveIdValueOnActivation, 0, sizeof(ActiveIdValueOnActivation)); LastActiveId = 0; LastActiveIdTimer = 0.0f; ActiveIdUsingNavDirMask = 0; ActiveIdUsingAllKeyboardKeys = false; } void ActiveWidgetStateStorage::StoreCurrentState() { IsInitialized = true; ImGuiContext& g = *ImGui::GetCurrentContext(); HoveredId = g.HoveredId; HoveredIdPreviousFrame = g.HoveredIdPreviousFrame; HoveredIdPreviousFrameItemCount = g.HoveredIdPreviousFrameItemCount; HoveredIdTimer = g.HoveredIdTimer; HoveredIdNotActiveTimer = g.HoveredIdNotActiveTimer; HoveredIdAllowOverlap = g.HoveredIdAllowOverlap; HoveredIdIsDisabled = g.HoveredIdIsDisabled; ItemUnclipByLog = g.ItemUnclipByLog; ActiveId = g.ActiveId; ActiveIdIsAlive = g.ActiveIdIsAlive; ActiveIdTimer = g.ActiveIdTimer; ActiveIdIsJustActivated = g.ActiveIdIsJustActivated; ActiveIdAllowOverlap = g.ActiveIdAllowOverlap; ActiveIdNoClearOnFocusLoss = g.ActiveIdNoClearOnFocusLoss; ActiveIdHasBeenPressedBefore = g.ActiveIdHasBeenPressedBefore; ActiveIdHasBeenEditedBefore = g.ActiveIdHasBeenEditedBefore; ActiveIdHasBeenEditedThisFrame = g.ActiveIdHasBeenEditedThisFrame; ActiveIdFromShortcut = g.ActiveIdFromShortcut; ActiveIdMouseButton = g.ActiveIdMouseButton; ActiveIdClickOffset = g.ActiveIdClickOffset; ActiveIdWindow = g.ActiveIdWindow; ActiveIdSource = g.ActiveIdSource; ActiveIdPreviousFrame = g.ActiveIdPreviousFrame; DeactivatedItemData = *(ImGuiDeactivatedItemDataInternal*)&g.DeactivatedItemData; ActiveIdValueOnActivation = *(ImGuiDataTypeStorageInternal*)&g.ActiveIdValueOnActivation; LastActiveId = g.LastActiveId; LastActiveIdTimer = g.LastActiveIdTimer; ActiveIdUsingNavDirMask = g.ActiveIdUsingNavDirMask; ActiveIdUsingAllKeyboardKeys = g.ActiveIdUsingAllKeyboardKeys; } void ActiveWidgetStateStorage::ApplyState() { //Do nothing if not initialized. Calls to this are typically followed by storing the state afterwards, initializing it correctly then if (!IsInitialized) return; ImGuiContext& g = *ImGui::GetCurrentContext(); g.HoveredId = HoveredId; g.HoveredIdPreviousFrame = HoveredIdPreviousFrame; g.HoveredIdPreviousFrameItemCount = HoveredIdPreviousFrameItemCount; g.HoveredIdTimer = HoveredIdTimer; g.HoveredIdNotActiveTimer = HoveredIdNotActiveTimer; g.HoveredIdAllowOverlap = HoveredIdAllowOverlap; g.HoveredIdIsDisabled = HoveredIdIsDisabled; g.ItemUnclipByLog = ItemUnclipByLog; g.ActiveId = ActiveId; g.ActiveIdIsAlive = ActiveIdIsAlive; g.ActiveIdTimer = ActiveIdTimer; g.ActiveIdIsJustActivated = ActiveIdIsJustActivated; g.ActiveIdAllowOverlap = ActiveIdAllowOverlap; g.ActiveIdNoClearOnFocusLoss = ActiveIdNoClearOnFocusLoss; g.ActiveIdHasBeenPressedBefore = ActiveIdHasBeenPressedBefore; g.ActiveIdHasBeenEditedBefore = ActiveIdHasBeenEditedBefore; g.ActiveIdHasBeenEditedThisFrame = ActiveIdHasBeenEditedThisFrame; g.ActiveIdFromShortcut = ActiveIdFromShortcut; g.ActiveIdMouseButton = ActiveIdMouseButton; g.ActiveIdClickOffset = ActiveIdClickOffset; g.ActiveIdWindow = (ImGuiWindow*)ActiveIdWindow; g.ActiveIdSource = (ImGuiInputSource)ActiveIdSource; g.ActiveIdPreviousFrame = ActiveIdPreviousFrame; g.DeactivatedItemData = *(ImGuiDeactivatedItemData*)&DeactivatedItemData; g.ActiveIdValueOnActivation = *(ImGuiDataTypeStorage*)&ActiveIdValueOnActivation; g.LastActiveId = LastActiveId; g.LastActiveIdTimer = LastActiveIdTimer; g.ActiveIdUsingNavDirMask = ActiveIdUsingNavDirMask; g.ActiveIdUsingAllKeyboardKeys = ActiveIdUsingAllKeyboardKeys; } void ActiveWidgetStateStorage::AdvanceState() { if (!IsInitialized) return; const ImGuiIO& io = ImGui::GetIO(); ImGuiContext& g = *ImGui::GetCurrentContext(); // Update HoveredId data if (!HoveredIdPreviousFrame) HoveredIdTimer = 0.0f; if (!HoveredIdPreviousFrame || (HoveredId && ActiveId == HoveredId)) HoveredIdNotActiveTimer = 0.0f; if (HoveredId) HoveredIdTimer += io.DeltaTime; if (HoveredId && ActiveId != HoveredId) HoveredIdNotActiveTimer += io.DeltaTime; HoveredIdPreviousFrame = HoveredId; HoveredId = 0; HoveredIdAllowOverlap = false; HoveredIdIsDisabled = false; // Clear ActiveID if the item is not alive anymore. // In 1.87, the common most call to KeepAliveID() was moved from GetID() to ItemAdd(). // As a result, custom widget using ButtonBehavior() _without_ ItemAdd() need to call KeepAliveID() themselves. if (ActiveId != 0 && ActiveIdIsAlive != ActiveId && ActiveIdPreviousFrame == ActiveId) { //ClearActiveID ImGuiDeactivatedItemDataInternal* deactivated_data = &DeactivatedItemData; deactivated_data->ID = ActiveId; deactivated_data->ElapseFrame = (g.LastItemData.ID == ActiveId) ? g.FrameCount : g.FrameCount + 1; deactivated_data->HasBeenEditedBefore = ActiveIdHasBeenEditedBefore; deactivated_data->IsAlive = (ActiveIdIsAlive == ActiveId); ActiveIdIsJustActivated = true; ActiveIdTimer = 0.0f; ActiveIdHasBeenPressedBefore = false; ActiveIdHasBeenEditedBefore = false; ActiveIdHasBeenEditedThisFrame = false; ActiveIdFromShortcut = false; ActiveIdMouseButton = -1; ActiveId = 0; ActiveIdAllowOverlap = false; ActiveIdNoClearOnFocusLoss = false; ActiveIdWindow = nullptr; ActiveIdHasBeenEditedThisFrame = false; } // Update ActiveId data (clear reference to active widget if the widget isn't alive anymore) if (ActiveIdIsAlive != ActiveId && ActiveIdPreviousFrame == ActiveId && ActiveId != 0) { ActiveIdIsJustActivated = true; if (ActiveIdIsJustActivated) { ActiveIdTimer = 0.0f; ActiveIdHasBeenPressedBefore = false; ActiveIdHasBeenEditedBefore = false; ActiveIdMouseButton = -1; } ActiveId = 0; ActiveIdAllowOverlap = false; ActiveIdNoClearOnFocusLoss = false; ActiveIdWindow = nullptr; ActiveIdHasBeenEditedThisFrame = false; } if (ActiveId) ActiveIdTimer += io.DeltaTime; LastActiveIdTimer += io.DeltaTime; ActiveIdPreviousFrame = ActiveId; ActiveIdIsAlive = 0; ActiveIdHasBeenEditedThisFrame = false; ActiveIdIsJustActivated = false; if (ActiveId == 0) { ActiveIdUsingNavDirMask = 0x00; ActiveIdUsingAllKeyboardKeys = false; } if (DeactivatedItemData.ElapseFrame < g.FrameCount) DeactivatedItemData.ID = 0; DeactivatedItemData.IsAlive = false; } } ================================================ FILE: src/DesktopPlusUI/ImGuiExt.h ================================================ //Some extra functions extending ImGui //Hopefully nothing here breaks when updating ImGui #pragma once #include "imgui.h" #include //More colors extern ImVec4 Style_ImGuiCol_TextNotification; extern ImVec4 Style_ImGuiCol_TextWarning; extern ImVec4 Style_ImGuiCol_TextError; extern ImVec4 Style_ImGuiCol_TextOutline; extern ImVec4 Style_ImGuiCol_ButtonPassiveToggled; //Toggled state for a button indicating a passive state, rather a full-on eye-catching active state extern ImVec4 Style_ImGuiCol_SteamVRCursor; //Inner color used to mimic a SteamVR overlay cursor extern ImVec4 Style_ImGuiCol_SteamVRCursorBorder; //Border color used to mimic a SteamVR overlay cursor //Legacy ImGui enum, now provided by us instead enum ImGuiNavInput { // Gamepad Mapping ImGuiNavInput_Activate, // Activate / Open / Toggle / Tweak value // e.g. Cross (PS4), A (Xbox), A (Switch), Space (Keyboard) ImGuiNavInput_Cancel, // Cancel / Close / Exit // e.g. Circle (PS4), B (Xbox), B (Switch), Escape (Keyboard) ImGuiNavInput_Input, // Text input / On-Screen keyboard // e.g. Triang.(PS4), Y (Xbox), X (Switch), Return (Keyboard) ImGuiNavInput_Menu, // Tap: Toggle menu / Hold: Focus, Move, Resize // e.g. Square (PS4), X (Xbox), Y (Switch), Alt (Keyboard) ImGuiNavInput_DpadLeft, // Move / Tweak / Resize window (w/ PadMenu) // e.g. D-pad Left/Right/Up/Down (Gamepads), Arrow keys (Keyboard) ImGuiNavInput_DpadRight, // ImGuiNavInput_DpadUp, // ImGuiNavInput_DpadDown, // ImGuiNavInput_LStickLeft, // Scroll / Move window (w/ PadMenu) // e.g. Left Analog Stick Left/Right/Up/Down ImGuiNavInput_LStickRight, // ImGuiNavInput_LStickUp, // ImGuiNavInput_LStickDown, // ImGuiNavInput_FocusPrev, // Focus Next window (w/ PadMenu) // e.g. L1 or L2 (PS4), LB or LT (Xbox), L or ZL (Switch) ImGuiNavInput_FocusNext, // Focus Prev window (w/ PadMenu) // e.g. R1 or R2 (PS4), RB or RT (Xbox), R or ZL (Switch) ImGuiNavInput_TweakSlow, // Slower tweaks // e.g. L1 or L2 (PS4), LB or LT (Xbox), L or ZL (Switch) ImGuiNavInput_TweakFast, // Faster tweaks // e.g. R1 or R2 (PS4), RB or RT (Xbox), R or ZL (Switch) // [Internal] Don't use directly! This is used internally to differentiate keyboard from gamepad inputs for behaviors that require to differentiate them. // Keyboard behavior that have no corresponding gamepad mapping (e.g. CTRL+TAB) will be directly reading from keyboard keys instead of io.NavInputs[]. ImGuiNavInput_KeyLeft_, // Move left // = Arrow keys ImGuiNavInput_KeyRight_, // Move right ImGuiNavInput_KeyUp_, // Move up ImGuiNavInput_KeyDown_, // Move down ImGuiNavInput_COUNT }; //Forward declase ImRect as we have functions with overloads that take it, but it's not part of the public ImGui API struct IMGUI_API ImRect; namespace ImGui { //Like InputFloat()'s buttons but with a slider instead. Not quite as flexible, though. Always takes as much space as available. //alt_text is unformatted text rendered on top if set (for unsanitized translation strings). format shouldn't render anything then (use ##) bool SliderWithButtonsFloat(const char* str_id, float& value, float step, float step_small, float min, float max, const char* format, ImGuiSliderFlags flags = 0, bool* used_button = nullptr, const char* text_alt = nullptr); bool SliderWithButtonsInt(const char* str_id, int& value, int step, int step_small, int min, int max, const char* format, ImGuiSliderFlags flags = 0, bool* used_button = nullptr, const char* text_alt = nullptr); // format is for int bool SliderWithButtonsFloatPercentage(const char* str_id, float& value, int step, int step_small, int min, int max, const char* format, ImGuiSliderFlags flags = 0, bool* used_button = nullptr, const char* text_alt = nullptr); ImGuiID SliderWithButtonsGetSliderID(const char* str_id); //Like imgui_demo's HelpMarker, but with a fixed position tooltip void FixedHelpMarker(const char* desc, const char* marker_str = "(?)"); //Button, but with wrapped, cropped and center aligned label bool ButtonWithWrappedLabel(const char* label, const ImVec2& size); //Per-line centered multiline label render function. Renders on top of the last button/item or inside explicit bounding box void RenderButtonMultilineLabel(const char* label, float line_height_scale = 1.0f); void RenderButtonMultilineLabel(const char* label, const ImRect& bb, float line_height_scale = 1.0f); //BeginCombo() but with the option of turning the Combo into an Input text like the sliders. Little bit awkward with the state variables but works otherwise //Uses PopupContextMenuInputText() with the InputText //Use normal EndCombo() to finish bool BeginComboWithInputText(const char* str_id, char* str_buffer, size_t buffer_size, bool& out_buffer_changed, bool& persist_input_visible, bool& persist_input_activated, bool& persist_mouse_released_once, bool no_preview_text = false); void ComboWithInputTextActivationCheck(bool& persist_input_visible); //Always call after BeginComboWithInputText(), outside the if statement //BeginCombo(), but opening it is animated bool BeginComboAnimated(const char* label, const char* preview_value, ImGuiComboFlags flags = 0); //Right-alinged Text(). Use offset_x if it's not supposed to take all of the available space, non-zero fixed_w to explicitly set total width instead of using window available space //Note that text may not always be pixel-perfectly aligned with this void TextRight(float offset_x, float fixed_w, const char* fmt, ...) IM_FMTARGS(4); void TextRightV(float offset_x, float fixed_w, const char* fmt, va_list args) IM_FMTLIST(4); void TextRightUnformatted(float offset_x, float fixed_w, const char* text, const char* text_end = nullptr); //Shortcut for unformatted colored text void TextColoredUnformatted(const ImVec4& col, const char* text, const char* text_end = nullptr); //Outlined Text(). Uses Style_ImGuiCol_TextOutline void TextOutlined(const char* fmt, ...) IM_FMTARGS(2); void TextOutlinedV(const char* fmt, va_list args) IM_FMTLIST(2); void TextUnformattedOutlined(const char* text, const char* text_end = nullptr); void TextRightOutlined(float offset_x, float fixed_w, const char* fmt, ...) IM_FMTARGS(4); void TextRightOutlinedV(float offset_x, float fixed_w, const char* fmt, va_list args) IM_FMTLIST(4); void TextRightUnformattedOutlined(float offset_x, float fixed_w, const char* text, const char* text_end = nullptr); //RenderTextClipped, but does not limit rendered minimal position to alignment pos_min (so centered text will stay centered with left side being cut off instead) void RenderTextClippedUnclamped(const ImVec2& pos_min, const ImVec2& pos_max, const char* text, const char* text_end, const ImVec2* text_size_if_known, const ImVec2& align = ImVec2(0, 0), const ImRect* clip_rect = nullptr); void RenderTextClippedUnclampedEx(ImDrawList* draw_list, const ImVec2& pos_min, const ImVec2& pos_max, const char* text, const char* text_end, const ImVec2* text_size_if_known, const ImVec2& align = ImVec2(0, 0), const ImRect* clip_rect = nullptr); //Stretches content added to drawlist between calls to BeginStretched() & EndStretched. Mostly for text. void BeginStretched(); void EndStretched(float scale_x); //ColorPicker simplified for embedded widget use instead having of popups + translation support bool ColorPicker4Simple(const char* str_id, float col[4], float ref_col[4], const char* label_color_current = nullptr, const char* label_color_original = nullptr, float scale = 1.0f); //CollapsingHeader() with padding hack applied for adjusted appearance within child windows bool CollapsingHeaderPadded(const char* label, ImGuiTreeNodeFlags flags = 0); //Collapsing area which animates the content sliding downwards. Always call content widget functions (for content height calculations) //Uses external animation progress variable to allow overriding when needed void BeginCollapsingArea(const char* str_id, bool show_content, float& persist_animation_progress); void EndCollapsingArea(); //ImGuiItemFlags_Disabled is not exposed public API yet and has no styling, so here's something that does the job //BeginDisabled()/EndDisabled() exists now, but behaves slightly differently and styling may change, so let's keep this for the time being void PushItemDisabled(); void PopItemDisabled(); void PushItemDisabledNoVisual(); void PopItemDisabledNoVisual(); //Disables window switcher by setting internal config values void ConfigDisableCtrlTab(); //Just straight up brought into the public API, use -1.0f on one axis to leave as-is void SetNextWindowScroll(const ImVec2& scroll); //Brought into the public API since we need only that one sometimes void ClearActiveID(); //Allow checking for mapped nav inputs for implementing nav-related behavior bool IsNavInputDown(ImGuiNavInput nav_input); bool IsNavInputPressed(ImGuiNavInput nav_input, bool repeat = false); bool IsNavInputReleased(ImGuiNavInput nav_input); //Get and set previous line height. Useful on complex layouts where a widget may take more height while not being supposed to push the next line further down float GetPreviousLineHeight(); void SetPreviousLineHeight(float height); //Something loosely resembling an InputText context menu, except it doesn't operate on the current cursor position or selection at all. Returns if buffer was modified bool PopupContextMenuInputText(const char* str_id, char* str_buffer, size_t buffer_size, bool paste_remove_newlines = true); //Returns true if the hovered item has changed to a different one bool HasHoveredNewItem(); //Returns true if any item is or was active in the previous frame bool IsAnyItemActiveOrDeactivated(); bool IsAnyItemDeactivated(); //Returns true if any InputText is active //Use IsAnyTempInputTextActive() to handle widgets creating temp InputTexts instead as the text state ID doesn't get cleared and it can't tell normal use and text input apart bool IsAnyInputTextActive(); //Returns true if any temp InputText (created for sliders and such) is active bool IsAnyTempInputTextActive(); //Returns true if any mouse button is clicked bool IsAnyMouseClicked(); //Takes active input focus and prevents scrolling on any ImGui widget while leaving input state untouched otherwise void BlockWidgetInput(); //Scroll window horizontally from vertical mouse wheel input void HScrollWindowFromMouseWheelV(); //Scroll the parent window in begin stack from current mouse wheel input (real child windows can scroll their parents by default already) void ScrollBeginStackParentWindow(); //Returns true if either scroll bar is visible bool IsAnyScrollBarVisible(); //Adjusts cursor pos and clipping rect to enable custom title bar content (assumes default left-aligned title). Returns title bar screen rect as X, Y, X2, Y2 coordinates ImVec4 BeginTitleBar(); void EndTitleBar(); //Returns true if a character in the string is mapped in the active font bool StringContainsUnmappedCharacter(const char* str); //Returns string shortened to fit width_max in the active font std::string StringEllipsis(const char* str, float width_max); //Fairly specific, yet general enough custom widget that contains an draggable & resizable rectangle in a fixed size area struct ImGuiDraggableRectAreaState { ImVec2 RectPos; ImVec2 RectSize; ImVec2 RectPosDragStart; ImVec2 RectSizeDragStart; ImGuiMouseButton DragMouseButton = ImGuiMouseButton_Left; ImGuiDir EdgeDragHDir = ImGuiDir_None; ImGuiDir EdgeDragVDir = ImGuiDir_None; bool EdgeDragActive = false; bool EdgeDragHighlightVisible = false; }; //Returns true if the rectangle was modified bool DraggableRectArea(const char* str_id, const ImVec2& area_size, ImGuiDraggableRectAreaState& state); //Stores an ImGui mouse state or something that would like to be one and can set from or apply to global state if needed. //Somewhat hacky, but pretty unproblematic when used correctly. class ImGuiMouseState { public: ImVec2 MousePos; bool MouseDown[5]; float MouseWheel; float MouseWheelH; ImVec2 MouseDelta; ImVec2 MousePosPrev; ImVec2 MouseClickedPos[5]; double MouseClickedTime[5]; bool MouseClicked[5]; bool MouseDoubleClicked[5]; ImU16 MouseClickedCount[5]; ImU16 MouseClickedLastCount[5]; bool MouseReleased[5]; bool MouseDownOwned[5]; bool MouseDownOwnedUnlessPopupClose[5]; float MouseDownDuration[5]; float MouseDownDurationPrev[5]; float MouseDragMaxDistanceSqr[5]; ImGuiMouseState(); void SetFromGlobalState(); void ApplyToGlobalState(); void Advance(); //Advance state similar to what happens in ImGui::NewFrame(); }; //Very dirty hack. Allows storing and restoring the active widget state. Works fine for a bunch of buttons not interrupting an InputText(), but likely breaks for anything complex. //A separate ImGuiContext would be the sane option, but that comes with its own complications. class ActiveWidgetStateStorage { private: //Copies of structs declared in imgui_internal.h, since we don't want to pull that header in for everything that uses this one //These need to be kept in sync struct ImGuiDeactivatedItemDataInternal { ImGuiID ID; int ElapseFrame; bool HasBeenEditedBefore; bool IsAlive; }; struct ImGuiDataTypeStorageInternal { ImU8 Data[8]; }; bool IsInitialized; ImGuiID HoveredId; ImGuiID HoveredIdPreviousFrame; int HoveredIdPreviousFrameItemCount; float HoveredIdTimer; float HoveredIdNotActiveTimer; bool HoveredIdAllowOverlap; bool HoveredIdIsDisabled; bool ItemUnclipByLog; ImGuiID ActiveId; ImGuiID ActiveIdIsAlive; float ActiveIdTimer; bool ActiveIdIsJustActivated; bool ActiveIdAllowOverlap; bool ActiveIdNoClearOnFocusLoss; bool ActiveIdHasBeenPressedBefore; bool ActiveIdHasBeenEditedBefore; bool ActiveIdHasBeenEditedThisFrame; bool ActiveIdFromShortcut; int ActiveIdMouseButton; ImVec2 ActiveIdClickOffset; void* ActiveIdWindow; int ActiveIdSource; ImGuiID ActiveIdPreviousFrame; ImGuiDeactivatedItemDataInternal DeactivatedItemData; ImGuiDataTypeStorageInternal ActiveIdValueOnActivation; ImGuiID LastActiveId; float LastActiveIdTimer; //ImGuiKeyOwnerData is not part of this. Probably doesn't need to be ImU32 ActiveIdUsingNavDirMask; bool ActiveIdUsingAllKeyboardKeys; public: ActiveWidgetStateStorage(); void StoreCurrentState(); void ApplyState(); void AdvanceState(); //Advance state similar to what happens in ImGui::NewFrame(); }; } ================================================ FILE: src/DesktopPlusUI/NotificationIcon.cpp ================================================ #include "NotificationIcon.h" #include #include #include #include "UIManager.h" #include "InterprocessMessaging.h" #include "resource.h" #undef _CRT_SECURE_NO_WARNINGS #define _CRT_SECURE_NO_WARNINGS #pragma warning(disable : 4996) #define WM_DPLUSUI_NOTIFICATIONICON WM_USER static LPCWSTR const g_WindowClassNameNotificationIcon = L"elvdesktopUINotifIcon"; LRESULT __stdcall NotificationIcon::WndProc(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam) { if (msg == WM_DPLUSUI_NOTIFICATIONICON) { if (UIManager::Get()) { UIManager::Get()->GetNotificationIcon().OnCallbackMessage(wParam, lParam); } return 0; } return ::DefWindowProc(hWnd, msg, wParam, lParam); } NotificationIcon::NotificationIcon() : m_Instance(nullptr), m_PopupMenu(nullptr) { m_IconData = { sizeof(NOTIFYICONDATA) }; } NotificationIcon::~NotificationIcon() { if (m_PopupMenu != nullptr) { DestroyMenu(m_PopupMenu); } ::Shell_NotifyIcon(NIM_DELETE, &m_IconData); if (m_IconData.hWnd != nullptr) { ::DestroyWindow(m_IconData.hWnd); ::UnregisterClass(g_WindowClassNameNotificationIcon, m_Instance); } } bool NotificationIcon::Init(HINSTANCE hinstance) { m_Instance = hinstance; //Register window class //Using an extra window allows us to have the popup menu not focus the main window and also prevent Windows from treating desktop and non-desktop mode as separate icons WNDCLASSEX wc = { sizeof(WNDCLASSEX), CS_CLASSDC, NotificationIcon::WndProc, 0L, 0L, m_Instance, nullptr, nullptr, nullptr, nullptr, g_WindowClassNameNotificationIcon, nullptr }; ::RegisterClassEx(&wc); //Create notification icon m_IconData.hWnd = ::CreateWindow(wc.lpszClassName, L"Desktop+ UI Notification Icon", 0, 0, 0, 1, 1, HWND_MESSAGE, nullptr, wc.hInstance, nullptr); m_IconData.uID = 0; m_IconData.uFlags = NIF_ICON | NIF_TIP | NIF_MESSAGE | NIF_SHOWTIP; m_IconData.uCallbackMessage = WM_DPLUSUI_NOTIFICATIONICON; m_IconData.hIcon = (HICON)::LoadImage(m_Instance, MAKEINTRESOURCE(IDI_DPLUS), IMAGE_ICON, ::GetSystemMetrics(SM_CXSMICON), ::GetSystemMetrics(SM_CYSMICON), LR_DEFAULTCOLOR); wcscpy(m_IconData.szTip, L"Desktop+"); m_IconData.uVersion = NOTIFYICON_VERSION_4; bool ret = ::Shell_NotifyIcon(NIM_ADD, &m_IconData); ::Shell_NotifyIcon(NIM_SETVERSION, &m_IconData); RefreshPopupMenu(); return ret; } void NotificationIcon::RefreshPopupMenu() { //Destroy old menu if it exists if (m_PopupMenu != nullptr) { DestroyMenu(m_PopupMenu); } //Create popup menu m_PopupMenu = ::CreatePopupMenu(); if (m_PopupMenu != nullptr) { if (UIManager::Get()->IsInDesktopMode()) { ::InsertMenu(m_PopupMenu, 0, MF_BYPOSITION | MF_STRING, 1, WStringConvertFromUTF8(TranslationManager::GetString(tstr_NotificationIconRestoreVR)).c_str()); } else { ::InsertMenu(m_PopupMenu, 0, MF_BYPOSITION | MF_STRING, 1, WStringConvertFromUTF8(TranslationManager::GetString(tstr_NotificationIconOpenOnDesktop)).c_str()); } ::InsertMenu(m_PopupMenu, 1, MF_BYPOSITION | MF_STRING, 2, WStringConvertFromUTF8(TranslationManager::GetString(tstr_NotificationIconQuit)).c_str()); } } void NotificationIcon::OnCallbackMessage(WPARAM wparam, LPARAM lparam) { switch (LOWORD(lparam)) { case NIN_SELECT: case NIN_KEYSELECT: case WM_CONTEXTMENU: { POINT const pt = { GET_X_LPARAM(wparam), GET_Y_LPARAM(wparam) }; //Respect menu drop alignment UINT flags = TPM_BOTTOMALIGN | TPM_RIGHTBUTTON | TPM_RETURNCMD; if (::GetSystemMetrics(SM_MENUDROPALIGNMENT) != 0) { flags |= TPM_RIGHTALIGN; } else { flags |= TPM_LEFTALIGN; } ::SetForegroundWindow(m_IconData.hWnd); BOOL sel = ::TrackPopupMenu(m_PopupMenu, flags, pt.x, pt.y, 0, m_IconData.hWnd, nullptr); switch (sel) { case 1 /*Open Settings on Desktop / Restore VR Interface*/: { UIManager::Get()->Restart(!UIManager::Get()->IsInDesktopMode()); break; } case 2 /*Quit*/: { //Kindly ask dashboard process to quit if (HWND window = ::FindWindow(g_WindowClassNameDashboardApp, nullptr)) { ::PostMessage(window, WM_QUIT, 0, 0); } UIManager::Get()->DisableRestartOnExit(); ::PostMessage(UIManager::Get()->GetWindowHandle(), WM_QUIT, 0, 0); break; } } break; } break; } } ================================================ FILE: src/DesktopPlusUI/NotificationIcon.h ================================================ //Provides a notification area/tray icon //Technically a singleton, but is designed to have its one instance live in UIManager for proper lifetime management //Once intialized, it's fully self-contained #pragma once #define NOMINMAX #include class NotificationIcon { private: HINSTANCE m_Instance; NOTIFYICONDATA m_IconData; HMENU m_PopupMenu; static LRESULT WINAPI WndProc(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam); public: NotificationIcon(); ~NotificationIcon(); bool Init(HINSTANCE hinstance); void RefreshPopupMenu(); //Destroys the popup menu if it exists and recreates it. Called after Init() to update translation strings void OnCallbackMessage(WPARAM wparam, LPARAM lparam); }; ================================================ FILE: src/DesktopPlusUI/TextureManager.cpp ================================================ #include "TextureManager.h" #define NOMINMAX #include #include #include //Make GDI+ header work with NOMINMAX namespace Gdiplus { using std::min; using std::max; } #include #include #include "ConfigManager.h" #include "Util.h" #include "UIManager.h" #include "OverlayManager.h" #include "WindowManager.h" #include "imgui_impl_dx11_openvr.h" const wchar_t* TextureManager::s_TextureFilenames[tmtex_MAX] = { L"images/icons/desktop.png", L"images/icons/desktop_all.png", L"images/icons/desktop_1.png", L"images/icons/desktop_2.png", L"images/icons/desktop_3.png", L"images/icons/desktop_4.png", L"images/icons/desktop_5.png", L"images/icons/desktop_6.png", L"images/icons/desktop_next.png", L"images/icons/desktop_previous.png", L"images/icons/desktop_none.png", L"images/icons/performance_monitor.png", L"images/icons/browser.png", L"images/icons/settings.png", L"images/icons/keyboard.png", L"images/icons/task_switch.png", L"images/icons/add.png", L"images/icons/window_overlay.png", L"images/icons_small/small_app_icon.png", L"images/icons_small/small_close.png", L"images/icons_small/small_move.png", L"images/icons_small/small_move_locked.png", L"images/icons_small/small_add_window.png", L"images/icons_small/small_actionbar.png", L"images/icons_small/small_performance_monitor_reset.png", L"images/icons_small/small_browser_back.png", L"images/icons_small/small_browser_forward.png", L"images/icons_small/small_browser_refresh.png", L"images/icons_small/small_browser_stop.png", L"images/icons_small/xsmall_desktop.png", L"images/icons_small/xsmall_desktop_all.png", L"images/icons_small/xsmall_desktop_1.png", L"images/icons_small/xsmall_desktop_2.png", L"images/icons_small/xsmall_desktop_3.png", L"images/icons_small/xsmall_desktop_4.png", L"images/icons_small/xsmall_desktop_5.png", L"images/icons_small/xsmall_desktop_6.png", L"images/icons_small/xsmall_desktop_none.png", L"images/icons_small/xsmall_performance_monitor.png", L"images/icons_small/xsmall_browser.png", L"images/icons_small/xsmall_settings.png", L"images/icons_small/xsmall_keyboard.png", L"images/icons_small/xsmall_origin_playspace.png", L"images/icons_small/xsmall_origin_hmd_pos.png", L"images/icons_small/xsmall_origin_seated.png", L"images/icons_small/xsmall_origin_dashboard.png", L"images/icons_small/xsmall_origin_hmd.png", L"images/icons_small/xsmall_origin_controller_left.png", L"images/icons_small/xsmall_origin_controller_right.png", L"images/icons_small/xsmall_origin_aux.png", L"images/icons_small/xsmall_origin_theater_screen.png", L"images/icons_small/xxsmall_close.png", L"images/icons_small/xxsmall_pin.png", L"images/icons_small/xxsmall_unpin.png", L"images/icons_small/xxsmall_browser_back.png", L"", //tmtex_icon_temp, blank }; static TextureManager g_TextureManager; TextureManager::TextureManager() : m_ReloadLater(false) { std::fill(std::begin(m_ImGuiRectIDs), std::end(m_ImGuiRectIDs), -1); std::fill(std::begin(m_AtlasSizes), std::end(m_AtlasSizes), ImVec2(-1, -1)); std::fill(std::begin(m_AtlasUVs), std::end(m_AtlasUVs), ImVec4(0, 0, 0, 0)); } TextureManager& TextureManager::Get() { return g_TextureManager; } bool TextureManager::LoadAllTexturesAndBuildFonts() { bool all_ok = true; //We don't need to abort when something fails, but let's not ignore it completely ImGuiIO& io = ImGui::GetIO(); io.Fonts->Clear(); ImGui_ImplDX11_InvalidateDeviceObjects(); //I really feel like I shouldn't have to call a renderer-specific function to make reloading fonts work, but it seems necessary //Clear arrays std::fill(std::begin(m_ImGuiRectIDs), std::end(m_ImGuiRectIDs), -1); std::fill(std::begin(m_AtlasSizes), std::end(m_AtlasSizes), ImVec2(-1, -1)); std::fill(std::begin(m_AtlasUVs), std::end(m_AtlasUVs), ImVec4(0, 0, 0, 0)); //Prepare font range to add more characters from action names/properties when needed ImVector ranges; ImFontGlyphRangesBuilder builder; ActionManager& action_manager = ConfigManager::Get().GetActionManager(); for (ActionUID uid : action_manager.GetActionOrderListUI()) { const Action action = action_manager.GetAction(uid); builder.AddText(action.Name.c_str()); builder.AddText(action.Label.c_str()); for (const auto& command : action.Commands) { builder.AddText(command.StrMain.c_str()); builder.AddText(command.StrArg.c_str()); } } for (const std::string& str : ConfigManager::Get().GetOverlayProfileList()) //Also from overlay profiles { builder.AddText(str.c_str()); } for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) //And overlay names { builder.AddText(OverlayManager::Get().GetConfigData(i).ConfigNameStr.c_str()); } for (const WindowInfo& window_info : WindowManager::Get().WindowListGet()) //And window list { builder.AddText(window_info.GetListTitle().c_str()); } for (const std::string& str : m_FontBuilderExtraStrings) //And extra strings... yeah. This might not be the best way to tackle this issue { builder.AddText(str.c_str()); } //Characters from current translation TranslationManager::Get().AddStringsToFontBuilder(builder); //Characters used by the VR Keyboard builder.AddText(UIManager::Get()->GetVRKeyboard().GetKeyLabelsString().c_str()); //Extra characters used by the UI directly builder.AddText(k_pch_bold_exclamation_mark); builder.AddText(k_pch_degree_symbol); builder.AddRanges(io.Fonts->GetGlyphRangesDefault()); builder.BuildRanges(&ranges); ImFontConfig config_compact; ImFontConfig config_large; config_compact.GlyphOffset.y = -1; //Set offset to make it not look so bad config_large.GlyphOffset.y = -1; ImFontConfig* config = &config_compact; //Try to load fonts ImFont* font = nullptr; ImFont* font_compact = nullptr; ImFont* font_large = nullptr; float font_base_size = 32.0f; bool load_large_font = ( (ConfigManager::GetValue(configid_bool_interface_large_style)) && (!UIManager::Get()->IsInDesktopMode()) ); //Loop to do the same for the large font if needed for (;;) { //Load preferred font first, if the translation has set one const std::string& preferred_font_name = TranslationManager::Get().GetCurrentTranslationFontName(); const std::wstring preferred_font_name_wstr = WStringConvertFromUTF8(TranslationManager::Get().GetCurrentTranslationFontName().c_str()); if (!preferred_font_name.empty()) { //AddFontFromFileTTF asserts when failing to load, so check for existence, though it's not really an issue in release mode if (FileExists( (L"C:\\Windows\\Fonts\\" + preferred_font_name_wstr).c_str() )) { font = io.Fonts->AddFontFromFileTTF( ("C:\\Windows\\Fonts\\" + preferred_font_name).c_str(), font_base_size * UIManager::Get()->GetUIScale(), config, ranges.Data); //Other fonts are still used as fallback config->MergeMode = true; } else if (FileExists( (WStringConvertFromUTF8(ConfigManager::Get().GetApplicationPath().c_str()) + L"/lang/" + preferred_font_name_wstr).c_str() )) { //Also allow for a custom font from the application directory font = io.Fonts->AddFontFromFileTTF( (ConfigManager::Get().GetApplicationPath() + "/lang/" + preferred_font_name).c_str(), font_base_size * UIManager::Get()->GetUIScale(), config, ranges.Data); config->MergeMode = true; } } //Continue with the standard font selection if (FileExists(L"C:\\Windows\\Fonts\\segoeui.ttf")) { font = io.Fonts->AddFontFromFileTTF("C:\\Windows\\Fonts\\segoeui.ttf", font_base_size * UIManager::Get()->GetUIScale(), config, ranges.Data); } if (font != nullptr) { //Segoe UI doesn't have any CJK, use some fallbacks (loading this is actually pretty fast) config->MergeMode = true; //Prefer Meiryo over MS Gothic. The former isn't installed on non-japanese systems by default though if (FileExists(L"C:\\Windows\\Fonts\\meiryo.ttc")) io.Fonts->AddFontFromFileTTF("C:\\Windows\\Fonts\\meiryo.ttc", font_base_size * UIManager::Get()->GetUIScale(), config, ranges.Data); else if (FileExists(L"C:\\Windows\\Fonts\\msgothic.ttc")) io.Fonts->AddFontFromFileTTF("C:\\Windows\\Fonts\\msgothic.ttc", font_base_size * UIManager::Get()->GetUIScale(), config, ranges.Data); if (FileExists(L"C:\\Windows\\Fonts\\malgun.ttf")) io.Fonts->AddFontFromFileTTF("C:\\Windows\\Fonts\\malgun.ttf", font_base_size * UIManager::Get()->GetUIScale(), config, ranges.Data); if (FileExists(L"C:\\Windows\\Fonts\\msyh.ttc")) io.Fonts->AddFontFromFileTTF("C:\\Windows\\Fonts\\msyh.ttc", font_base_size * UIManager::Get()->GetUIScale(), config, ranges.Data); //Thai font if (FileExists(L"C:\\Windows\\Fonts\\LeelawUI.ttf")) io.Fonts->AddFontFromFileTTF("C:\\Windows\\Fonts\\LeelawUI.ttf", font_base_size * UIManager::Get()->GetUIScale(), config, ranges.Data); //Also add some symbol support at least... yeah this is far from comprehensive all in all but should cover most uses if (FileExists(L"C:\\Windows\\Fonts\\seguisym.ttf")) io.Fonts->AddFontFromFileTTF("C:\\Windows\\Fonts\\seguisym.ttf", font_base_size * UIManager::Get()->GetUIScale(), config, ranges.Data); } else { //Though we have the default as fallback if it isn't somehow font = io.Fonts->AddFontDefault(); } if (font_compact == nullptr) { font_compact = font; } else { font_large = font; } if ( (load_large_font) && (font_large == nullptr) ) { font_base_size *= 1.5f; config = &config_large; } else { break; } } //Initialize GDI+. Gdiplus::GdiplusStartupInput gdiplusStartupInput; ULONG_PTR gdiplusToken; if (GdiplusStartup(&gdiplusToken, &gdiplusStartupInput, nullptr) != Gdiplus::Ok) { LOG_F(ERROR, "Initializing GDI+ failed! Icons will not be loaded"); //Still build the font so we can have text at least const bool font_build_success = io.Fonts->Build(); //If building the font atlas failed, fall back to the internal default font and try again if (!font_build_success) { LOG_F(ERROR, "Building font atlas failed (invalid font file?)! Falling back to internal font"); io.Fonts->Clear(); font = io.Fonts->AddFontDefault(); font_compact = font; font_large = font; io.Fonts->Build(); } io.Fonts->ClearInputData(); //We don't need to keep this around, reduces RAM use a lot UIManager::Get()->SetFonts(font_compact, font_large); m_ReloadLater = false; return false; //Everything below will fail as well if this did } //Load images and add custom rects for them //Since we have to build the font before actually copying the image data, we have to keep the bitmaps loaded, which is a bit messy, especially with custom action icons std::vector< std::unique_ptr > bitmaps; //Load application icons int icon_id = 0; for (; icon_id < tmtex_MAX; ++icon_id) { std::unique_ptr bmp; if (icon_id == tmtex_icon_temp) { bmp = std::unique_ptr( new Gdiplus::Bitmap(m_TextureFilenameIconTemp.c_str()) ); } else { bmp = std::unique_ptr( new Gdiplus::Bitmap(s_TextureFilenames[icon_id]) ); } if (bmp->GetLastStatus() == Gdiplus::Ok) { m_ImGuiRectIDs[icon_id] = io.Fonts->AddCustomRectRegular(bmp->GetWidth(), bmp->GetHeight()); if (io.Fonts->TexDesiredWidth <= (int)bmp->GetWidth()) { //We could go smarter here, but let's be honest, we actually shouldn't load large images into the atlas in the first place! //But well, I tried out of curiosity once and the result was a disaster without these checks. //And yes, we need more space than the texture's width, unfortunately. Probably for that one white pixel in the atlas or something io.Fonts->TexDesiredWidth = (bmp->GetWidth() >= 2048) ? 4096 : (bmp->GetWidth() >= 1024) ? 2048 : (bmp->GetWidth() >= 512) ? 1024 : 512; } } bitmaps.push_back(std::move(bmp)); } //Load custom action icons struct ActionIconTextureData { int IconImGuiRectID = -1; ImVec2 IconAtlasSize; ImVec4 IconAtlasUV; }; std::vector action_icon_tex_data; action_icon_tex_data.reserve(action_manager.GetActionOrderListUI().size()); action_manager.ClearIconData(); for (ActionUID uid : action_manager.GetActionOrderListUI()) { const Action& action = action_manager.GetAction(uid); ActionIconTextureData tex_data; if (!action.IconFilename.empty()) { std::string icon_path = "images/icons/" + action.IconFilename; std::unique_ptr bmp( new Gdiplus::Bitmap(WStringConvertFromUTF8(icon_path.c_str()).c_str()) ); if (bmp->GetLastStatus() == Gdiplus::Ok) { tex_data.IconImGuiRectID = io.Fonts->AddCustomRectRegular(bmp->GetWidth(), bmp->GetHeight()); if (io.Fonts->TexDesiredWidth <= (int)bmp->GetWidth()) { //See above io.Fonts->TexDesiredWidth = (bmp->GetWidth() >= 2048) ? 4096 : (bmp->GetWidth() >= 1024) ? 2048 : (bmp->GetWidth() >= 512) ? 1024 : 512; } } bitmaps.push_back(std::move(bmp)); } action_icon_tex_data.push_back(tex_data); } //Set up already loaded window icons for (auto& window_icon : m_WindowIcons) { window_icon.ImGuiRectID = io.Fonts->AddCustomRectRegular((int)window_icon.Size.x, (int)window_icon.Size.y); if (io.Fonts->TexDesiredWidth <= (int)window_icon.Size.x) { //See above io.Fonts->TexDesiredWidth = (window_icon.Size.x >= 2048) ? 4096 : (window_icon.Size.x >= 1024) ? 2048 : (window_icon.Size.x >= 512) ? 1024 : 512; } } //Build atlas const bool font_build_success = io.Fonts->Build(); //If building the font atlas failed, fall back to the internal default font and try again if (!font_build_success) { LOG_F(ERROR, "Building font atlas failed (invalid font file?)! Falling back to internal font"); ImVector custom_rects_back = io.Fonts->CustomRects; int desired_width_back = io.Fonts->TexDesiredWidth; io.Fonts->Clear(); font = io.Fonts->AddFontDefault(); font_compact = font; font_large = font; io.Fonts->CustomRects = custom_rects_back; io.Fonts->TexDesiredWidth = desired_width_back; io.Fonts->Build(); } //Retrieve atlas texture in RGBA format unsigned char* tex_pixels = nullptr; int tex_width, tex_height; io.Fonts->GetTexDataAsRGBA32(&tex_pixels, &tex_width, &tex_height); //Actually do the copying now icon_id = 0; auto action_tex_data_it = action_icon_tex_data.begin(); for (auto& bmp : bitmaps) { if (bmp->GetLastStatus() == Gdiplus::Ok) { int* rect_id = nullptr; ImVec2* atlas_size = nullptr; ImVec4* atlas_uvs = nullptr; if (icon_id < tmtex_MAX) { rect_id = &m_ImGuiRectIDs[icon_id]; atlas_size = &m_AtlasSizes[icon_id]; atlas_uvs = &m_AtlasUVs[icon_id]; } else { //Get the next action, skipping the ones with no icon do { if (action_tex_data_it == action_icon_tex_data.end()) { break; } ActionIconTextureData& tex_data = *action_tex_data_it; rect_id = &tex_data.IconImGuiRectID; atlas_size = &tex_data.IconAtlasSize; atlas_uvs = &tex_data.IconAtlasUV; action_tex_data_it++; } while (*rect_id == -1); } if ( (rect_id != nullptr) && (*rect_id != -1) ) { if (const ImFontAtlasCustomRect* rect = io.Fonts->GetCustomRectByIndex(*rect_id)) { Gdiplus::BitmapData bitmapData; Gdiplus::Rect gdirect(0, 0, rect->Width, rect->Height); if (bmp->LockBits(&gdirect, Gdiplus::ImageLockModeRead, PixelFormat32bppARGB, &bitmapData) == Gdiplus::Ok) //Access bitmap data from GDI+ { for (int y = 0; y < rect->Height; ++y) { ImU32* p = (ImU32*)tex_pixels + (rect->Y + y) * tex_width + (rect->X); UINT8* pgdi = (UINT8*)bitmapData.Scan0 + (y * bitmapData.Stride); for (int x = 0; x < rect->Width; ++x) { //GDI+ order is BGRA, convert *p++ = IM_COL32(*(pgdi + 2), *(pgdi + 1), *pgdi, *(pgdi + 3)); pgdi += 4; } } bmp->UnlockBits(&bitmapData); //Store UVs and size since we succeeded with copying atlas_size->x = rect->Width; atlas_size->y = rect->Height; atlas_uvs->x = (float)rect->X * io.Fonts->TexUvScale.x; //Min U atlas_uvs->y = (float)rect->Y * io.Fonts->TexUvScale.y; //Min V atlas_uvs->z = (float)(rect->X + rect->Width) * io.Fonts->TexUvScale.x; //Max U atlas_uvs->w = (float)(rect->Y + rect->Height) * io.Fonts->TexUvScale.y; //Max V } else { *rect_id = -1; all_ok = false; } } else { *rect_id = -1; all_ok = false; } } else { all_ok = false; } } icon_id++; } //Copy cached window icons into atlas for (auto& window_icon : m_WindowIcons) { if (const ImFontAtlasCustomRect* rect = io.Fonts->GetCustomRectByIndex(window_icon.ImGuiRectID)) { UINT8* psrc = (UINT8*)window_icon.PixelData.get(); size_t stride = rect->Width * 4; //Copy RGBA pixels line-by-line for (int y = 0; y < rect->Height; ++y, psrc += stride) { ImU32* p = (ImU32*)tex_pixels + (rect->Y + y) * tex_width + (rect->X); memcpy(p, psrc, stride); } //Store UVs window_icon.AtlasUV.x = (float)rect->X * io.Fonts->TexUvScale.x; //Min U window_icon.AtlasUV.y = (float)rect->Y * io.Fonts->TexUvScale.y; //Min V window_icon.AtlasUV.z = (float)(rect->X + rect->Width) * io.Fonts->TexUvScale.x; //Max U window_icon.AtlasUV.w = (float)(rect->Y + rect->Height) * io.Fonts->TexUvScale.y; //Max V } else { window_icon.ImGuiRectID = -1; all_ok = false; } } //Store action texture data in actual actions IM_ASSERT(action_icon_tex_data.size() == action_manager.GetActionOrderListUI().size()); for (size_t i = 0; i < action_icon_tex_data.size(); ++i) { const ActionIconTextureData& tex_data = action_icon_tex_data[i]; //We can just skip this when the rect ID is still -1 since we cleared all texture data at beginning if (tex_data.IconImGuiRectID != -1) { Action action = action_manager.GetAction( action_manager.GetActionOrderListUI()[i] ); action.IconImGuiRectID = tex_data.IconImGuiRectID; action.IconAtlasSize = tex_data.IconAtlasSize; action.IconAtlasUV = tex_data.IconAtlasUV; action_manager.StoreAction(action); } } //Delete Bitmaps before shutting down GDI+ bitmaps.clear(); //Shutdown GDI+, we won't need it again Gdiplus::GdiplusShutdown(gdiplusToken); m_ReloadLater = false; //We don't need to keep this around, reduces RAM use a lot io.Fonts->ClearInputData(); UIManager::Get()->SetFonts(font_compact, font_large); return all_ok; } void TextureManager::ReloadAllTexturesLater() { m_ReloadLater = true; } bool TextureManager::GetReloadLaterFlag() { return m_ReloadLater; } const wchar_t* TextureManager::GetTextureFilename(TMNGRTexID texid) const { return (texid != tmtex_icon_temp) ? s_TextureFilenames[texid] : m_TextureFilenameIconTemp.c_str(); } void TextureManager::SetTextureFilenameIconTemp(const wchar_t* filename) { m_TextureFilenameIconTemp = filename; } bool TextureManager::GetTextureInfo(TMNGRTexID texid, ImVec2& size, ImVec2& uv_min, ImVec2& uv_max) const { int rect_id = m_ImGuiRectIDs[texid]; if (rect_id != -1) { size = m_AtlasSizes[texid]; //Also set cached UV coordinates uv_min.x = m_AtlasUVs[texid].x; uv_min.y = m_AtlasUVs[texid].y; uv_max.x = m_AtlasUVs[texid].z; uv_max.y = m_AtlasUVs[texid].w; return true; } return false; } bool TextureManager::GetTextureInfo(const Action& action, ImVec2& size, ImVec2& uv_min, ImVec2& uv_max) const { if (action.IconImGuiRectID != -1) { size = action.IconAtlasSize; //Also set cached UV coordinates uv_min.x = action.IconAtlasUV.x; uv_min.y = action.IconAtlasUV.y; uv_max.x = action.IconAtlasUV.z; uv_max.y = action.IconAtlasUV.w; return true; } return false; } int TextureManager::GetWindowIconCacheID(HWND window_handle) { WindowInfo const* info_ptr = WindowManager::Get().WindowListFindWindow(window_handle); return (info_ptr != nullptr) ? GetWindowIconCacheID(info_ptr->GetIcon()) : -1; } int TextureManager::GetWindowIconCacheID(HWND window_handle, uint64_t& icon_handle_config) { WindowInfo const* info_ptr = WindowManager::Get().WindowListFindWindow(window_handle); HICON icon_handle = (info_ptr != nullptr) ? info_ptr->GetIcon() : nullptr; if (icon_handle != nullptr) { icon_handle_config = (uint64_t)icon_handle; return GetWindowIconCacheID(icon_handle); } else if (icon_handle_config != 0) { return GetWindowIconCacheID((HICON)icon_handle_config); } return -1; } int TextureManager::GetWindowIconCacheID(HICON icon_handle) { //Look if the icon is already loaded for (int i = 0; i < m_WindowIcons.size(); ++i) { if (m_WindowIcons[i].IconHandle == icon_handle) { return i; } } //Icon not loaded yet, try to do that int ret = -1; ICONINFO icon_info = {0}; if (::GetIconInfo(icon_handle, &icon_info) != 0) { HDC hdc = ::GetDC(nullptr); //Get bitmap info from icon bitmap BITMAPINFO bmp_info = {0}; bmp_info.bmiHeader.biSize = sizeof(bmp_info.bmiHeader); if (::GetDIBits(hdc, icon_info.hbmColor, 0, 0, nullptr, &bmp_info, DIB_RGB_COLORS) != 0) { TMNGRWindowIcon window_icon; int icon_width = bmp_info.bmiHeader.biWidth; int icon_height = abs(bmp_info.bmiHeader.biHeight); const size_t icon_pixel_count = icon_width * icon_height; auto PixelData = std::unique_ptr{new BYTE[icon_pixel_count * 4]}; bmp_info.bmiHeader.biSize = sizeof(bmp_info.bmiHeader); bmp_info.bmiHeader.biBitCount = 32; bmp_info.bmiHeader.biCompression = BI_RGB; bmp_info.bmiHeader.biHeight = -icon_height; //Always use top-down order (negative height) //Read the actual bitmap buffer into the pixel data array if (::GetDIBits(hdc, icon_info.hbmColor, 0, bmp_info.bmiHeader.biHeight, (LPVOID)PixelData.get(), &bmp_info, DIB_RGB_COLORS) != 0) { //Even if we don't override biBitCount to 32, it's still returned as that for 24-bit and lower bit-depth icons (probably just the screen DC format) //It seems the only way to check if the icon needs its mask applied is to see if the alpha channel is fully blank //32-bit icons still come with masks, but applying them means to override the alpha channel with a 1-bit one (and doing so is also wasteful) bool needs_mask = true; BYTE* psrc = PixelData.get() + 3; //BGRA alpha pixel const BYTE* const psrc_end = PixelData.get() + (icon_pixel_count * 4); for (; psrc < psrc_end; psrc += 4) { if (*psrc != 0) { needs_mask = false; break; } } //Apply mask if we need to if (needs_mask) { //Get bitmap info for the mask this time BITMAPINFO bmp_info = {0}; bmp_info.bmiHeader.biSize = sizeof(bmp_info.bmiHeader); if (::GetDIBits(hdc, icon_info.hbmMask, 0, 0, nullptr, &bmp_info, DIB_RGB_COLORS) != 0) { int mask_width = bmp_info.bmiHeader.biWidth; int mask_height = abs(bmp_info.bmiHeader.biHeight); //Only continue if icon and mask are really the same size (can be different for monochrome bitmap formats, which are not supported here) if ( (icon_width == mask_width) && (icon_height == mask_height) ) { auto PixelDataMask = std::unique_ptr{new BYTE[icon_pixel_count * 4]}; bmp_info.bmiHeader.biSize = sizeof(bmp_info.bmiHeader); bmp_info.bmiHeader.biBitCount = 32; bmp_info.bmiHeader.biCompression = BI_RGB; bmp_info.bmiHeader.biHeight = -abs(bmp_info.bmiHeader.biHeight); //Always use top-down order (negative height) //Read the mask bitmap buffer if (::GetDIBits(hdc, icon_info.hbmMask, 0, bmp_info.bmiHeader.biHeight, (LPVOID)PixelDataMask.get(), &bmp_info, DIB_RGB_COLORS) != 0) { //Apply mask to color pixel data psrc = PixelData.get() + 3; //BGRA alpha pixel BYTE* pmsk = PixelDataMask.get(); //BGRA blue pixel (alpha channel is blank for the mask) for (; psrc < psrc_end; psrc += 4, pmsk += 4) { *psrc = ~(*pmsk); } } } } } //Convert BGRA to RGBA for ImGui's texture atlas window_icon.PixelData = std::unique_ptr{new BYTE[icon_pixel_count * 4]}; psrc = PixelData.get(); UINT32* pdst = (UINT32*)window_icon.PixelData.get(); for (; psrc < psrc_end; psrc += 4, ++pdst) { *pdst = IM_COL32(*(psrc + 2), *(psrc + 1), *psrc, *(psrc + 3)); } //Fill out other data and move the icon to the cache window_icon.IconHandle = icon_handle; window_icon.Size = {(float)icon_width, (float)icon_height}; m_WindowIcons.push_back(std::move(window_icon)); //We succeeded, but the icon won't be ready until next frame, so schedule reload and skip rendering this frame ReloadAllTexturesLater(); UIManager::Get()->RepeatFrame(); ret = (int)m_WindowIcons.size() - 1; } } ::DeleteObject(icon_info.hbmColor); ::DeleteObject(icon_info.hbmMask); ::ReleaseDC(nullptr, hdc); } return ret; } bool TextureManager::GetWindowIconTextureInfo(int icon_cache_id, ImVec2& size, ImVec2& uv_min, ImVec2& uv_max) const { if ( (icon_cache_id >= 0) && (icon_cache_id < m_WindowIcons.size()) ) { const TMNGRWindowIcon& window_icon = m_WindowIcons[icon_cache_id]; size = window_icon.Size; uv_min.x = window_icon.AtlasUV.x; uv_min.y = window_icon.AtlasUV.y; uv_max.x = window_icon.AtlasUV.z; uv_max.y = window_icon.AtlasUV.w; return true; } return false; } bool TextureManager::GetOverlayIconTextureInfo(OverlayConfigData& data, ImVec2& size, ImVec2& uv_min, ImVec2& uv_max, bool is_xsmall, bool* has_window_icon) { if ( (is_xsmall) && (data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_winrt_capture) && (data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd] != 0) ) { //XSmall returns the window icon itself int cache_id = GetWindowIconCacheID((HWND)data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd], data.ConfigHandle[configid_handle_overlay_state_winrt_last_hicon]); if (cache_id != -1) { if (has_window_icon != nullptr) *has_window_icon = true; return GetWindowIconTextureInfo(cache_id, size, uv_min, uv_max); } } return GetTextureInfo(GetOverlayIconTextureID(data, is_xsmall, has_window_icon), size, uv_min, uv_max); } bool TextureManager::AddFontBuilderString(const std::string& str) { //Add only if it's not already in the extra string list. Avoids duplicates and unnecessary texture rebuilds if the requested character can't be found in the loaded fonts if (std::find(m_FontBuilderExtraStrings.begin(), m_FontBuilderExtraStrings.end(), str) == m_FontBuilderExtraStrings.end()) { m_FontBuilderExtraStrings.push_back(str); return true; } return false; } TMNGRTexID TextureManager::GetOverlayIconTextureID(const OverlayConfigData& data, bool is_xsmall, bool* has_window_icon) { TMNGRTexID texture_id = (is_xsmall) ? tmtex_icon_xsmall_desktop_none : tmtex_icon_desktop_none; int desktop_id = -2; if (has_window_icon != nullptr) *has_window_icon = false; switch (data.ConfigInt[configid_int_overlay_capture_source]) { case ovrl_capsource_desktop_duplication: { desktop_id = data.ConfigInt[configid_int_overlay_desktop_id]; break; } case ovrl_capsource_winrt_capture: { if (data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd] != 0) { if (has_window_icon != nullptr) *has_window_icon = true; texture_id = (is_xsmall) ? tmtex_icon_xsmall_desktop_none : tmtex_icon_window_overlay; } else if (data.ConfigInt[configid_int_overlay_winrt_desktop_id] != -2) { desktop_id = data.ConfigInt[configid_int_overlay_winrt_desktop_id]; } else { texture_id = (is_xsmall) ? tmtex_icon_xsmall_desktop_none : tmtex_icon_desktop_none; } break; } case ovrl_capsource_ui: { texture_id = (is_xsmall) ? tmtex_icon_xsmall_performance_monitor : tmtex_icon_performance_monitor; break; } case ovrl_capsource_browser: { texture_id = (is_xsmall) ? tmtex_icon_xsmall_browser : tmtex_icon_browser; break; } } if (desktop_id != -2) { if (is_xsmall) { texture_id = (tmtex_icon_xsmall_desktop_1 + desktop_id <= tmtex_icon_xsmall_desktop_6) ? (TMNGRTexID)(tmtex_icon_xsmall_desktop_1 + desktop_id) : tmtex_icon_xsmall_desktop; } else { texture_id = (tmtex_icon_desktop_1 + desktop_id <= tmtex_icon_desktop_6) ? (TMNGRTexID)(tmtex_icon_desktop_1 + desktop_id) : tmtex_icon_desktop; } } return texture_id; } ================================================ FILE: src/DesktopPlusUI/TextureManager.h ================================================ //Desktop+UI loads all textures into Dear ImGui's font texture atlas //Bigger texture sizes are well supported on VR-running GPUs and less texture switching is more efficient //It's also more convenient in general //This is using GDI+ to load PNGs. Seemed like the next best option without too much overhead and doesn't need any extra library to ship #pragma once #define NOMINMAX #include #include #include #include #include "imgui.h" struct Action; enum TMNGRTexID { tmtex_icon_desktop, tmtex_icon_desktop_all, tmtex_icon_desktop_1, tmtex_icon_desktop_2, tmtex_icon_desktop_3, tmtex_icon_desktop_4, tmtex_icon_desktop_5, tmtex_icon_desktop_6, tmtex_icon_desktop_next, tmtex_icon_desktop_prev, tmtex_icon_desktop_none, tmtex_icon_performance_monitor, tmtex_icon_browser, tmtex_icon_settings, tmtex_icon_keyboard, tmtex_icon_switch_task, tmtex_icon_add, tmtex_icon_window_overlay, tmtex_icon_small_app_icon, tmtex_icon_small_close, tmtex_icon_small_move, tmtex_icon_small_move_locked, tmtex_icon_small_add_window, tmtex_icon_small_actionbar, tmtex_icon_small_performance_monitor_reset, tmtex_icon_small_browser_back, tmtex_icon_small_browser_forward, tmtex_icon_small_browser_refresh, tmtex_icon_small_browser_stop, tmtex_icon_xsmall_desktop, tmtex_icon_xsmall_desktop_all, tmtex_icon_xsmall_desktop_1, tmtex_icon_xsmall_desktop_2, tmtex_icon_xsmall_desktop_3, tmtex_icon_xsmall_desktop_4, tmtex_icon_xsmall_desktop_5, tmtex_icon_xsmall_desktop_6, tmtex_icon_xsmall_desktop_none, tmtex_icon_xsmall_performance_monitor, tmtex_icon_xsmall_browser, tmtex_icon_xsmall_settings, tmtex_icon_xsmall_keyboard, tmtex_icon_xsmall_origin_room, tmtex_icon_xsmall_origin_hmd_floor, tmtex_icon_xsmall_origin_seated_space, tmtex_icon_xsmall_origin_dashboard, tmtex_icon_xsmall_origin_hmd, tmtex_icon_xsmall_origin_left_hand, tmtex_icon_xsmall_origin_right_hand, tmtex_icon_xsmall_origin_aux, tmtex_icon_xsmall_origin_theater_screen, tmtex_icon_xxsmall_close, tmtex_icon_xxsmall_pin, tmtex_icon_xxsmall_unpin, tmtex_icon_xxsmall_browser_back, tmtex_icon_temp, //This is an odd one to hack-ishly load one icon without associating it with anything. The file for this can be set freely by TextureManager tmtex_MAX }; struct TMNGRWindowIcon { HICON IconHandle = nullptr; std::unique_ptr PixelData; //RGBA ImVec2 Size = {0.0f, 0.0f}; int ImGuiRectID = -1; //-1 when no icon loaded (ID on ImGui end is not valid after building the font) ImVec4 AtlasUV = {0.0f, 0.0f, 0.0f, 0.0f}; }; class OverlayConfigData; class TextureManager { private: static const wchar_t* s_TextureFilenames[tmtex_MAX]; int m_ImGuiRectIDs[tmtex_MAX]; //-1 when not loaded (ID on ImGui end is not valid after building the font as data is cleared to save memory) ImVec2 m_AtlasSizes[tmtex_MAX]; ImVec4 m_AtlasUVs[tmtex_MAX]; std::wstring m_TextureFilenameIconTemp; std::vector m_FontBuilderExtraStrings; //Extra strings containing characters to be included when building the fonts. Might fill up over time but better than nothing std::vector m_WindowIcons; bool m_ReloadLater; public: TextureManager(); static TextureManager& Get(); bool LoadAllTexturesAndBuildFonts(); void ReloadAllTexturesLater(); //Schedule reload for the beginning of the next frame since we can't do it in the middle of one bool GetReloadLaterFlag(); const wchar_t* GetTextureFilename(TMNGRTexID texid) const; void SetTextureFilenameIconTemp(const wchar_t* filename); bool GetTextureInfo(TMNGRTexID texid, ImVec2& size, ImVec2& uv_min, ImVec2& uv_max) const; bool GetTextureInfo(const Action& action, ImVec2& size, ImVec2& uv_min, ImVec2& uv_max) const; int GetWindowIconCacheID(HWND window_handle); //Returns -1 on error int GetWindowIconCacheID(HWND window_handle, uint64_t& icon_handle_config); //Updates icon_handle_config when lookup with window_handle succeeds or falls back to icon_handle_config int GetWindowIconCacheID(HICON icon_handle); //Returns -1 on error bool GetWindowIconTextureInfo(int icon_cache_id, ImVec2& size, ImVec2& uv_min, ImVec2& uv_max) const; bool GetOverlayIconTextureInfo(OverlayConfigData& data, ImVec2& size, ImVec2& uv_min, ImVec2& uv_max, bool is_xsmall = false, bool* has_window_icon = nullptr); bool AddFontBuilderString(const std::string& str); //Returns true if string has been added (not already in extra string list) static TMNGRTexID GetOverlayIconTextureID(const OverlayConfigData& data, bool is_xsmall, bool* has_window_icon = nullptr); }; ================================================ FILE: src/DesktopPlusUI/TranslationManager.cpp ================================================ #include "TranslationManager.h" #include "ConfigManager.h" #include "Ini.h" #include "Util.h" #include "Logging.h" #include const char* TranslationManager::s_StringIDNames[tstr_MAX] = { "tstr_SettingsWindowTitle", "tstr_SettingsCatInterface", "tstr_SettingsCatEnvironment", "tstr_SettingsCatProfiles", "tstr_SettingsCatActions", "tstr_SettingsCatKeyboard", "tstr_SettingsCatMouse", "tstr_SettingsCatLaserPointer", "tstr_SettingsCatWindowOverlays", "tstr_SettingsCatBrowser", "tstr_SettingsCatPerformance", "tstr_SettingsCatVersionInfo", "tstr_SettingsCatWarnings", "tstr_SettingsCatStartup", "tstr_SettingsCatTroubleshooting", "tstr_SettingsWarningPrefix", "tstr_SettingsWarningCompositorResolution", "tstr_SettingsWarningCompositorQuality", "tstr_SettingsWarningProcessElevated", "tstr_SettingsWarningElevatedMode", "tstr_SettingsWarningElevatedProcessFocus", "tstr_SettingsWarningBrowserMissing", "tstr_SettingsWarningBrowserMismatch", "tstr_SettingsWarningUIAccessLost", "tstr_SettingsWarningOverlayCreationErrorLimit", "tstr_SettingsWarningOverlayCreationErrorOther", "tstr_SettingsWarningGraphicsCaptureError", "tstr_SettingsWarningAppProfileActive", "tstr_SettingsWarningConfigMigrated", "tstr_SettingsWarningMenuDontShowAgain", "tstr_SettingsWarningMenuDismiss", "tstr_SettingsInterfaceLanguage", "tstr_SettingsInterfaceLanguageCommunity", "tstr_SettingsInterfaceLanguageIncompleteWarning", "tstr_SettingsInterfaceAdvancedSettings", "tstr_SettingsInterfaceAdvancedSettingsTip", "tstr_SettingsInterfaceBlankSpaceDrag", "tstr_SettingsInterfacePersistentUI", "tstr_SettingsInterfacePersistentUIManage", "tstr_SettingsInterfaceDesktopButtons", "tstr_SettingsInterfaceDesktopButtonsNone", "tstr_SettingsInterfaceDesktopButtonsIndividual", "tstr_SettingsInterfaceDesktopButtonsCycle", "tstr_SettingsInterfaceDesktopButtonsAddCombined", "tstr_SettingsInterfacePersistentUIHelp", "tstr_SettingsInterfacePersistentUIHelp2", "tstr_SettingsInterfacePersistentUIWindowsHeader", "tstr_SettingsInterfacePersistentUIWindowsSettings", "tstr_SettingsInterfacePersistentUIWindowsProperties", "tstr_SettingsInterfacePersistentUIWindowsKeyboard", "tstr_SettingsInterfacePersistentUIWindowsStateGlobal", "tstr_SettingsInterfacePersistentUIWindowsStateDashboardTab", "tstr_SettingsInterfacePersistentUIWindowsStateVisible", "tstr_SettingsInterfacePersistentUIWindowsStatePinned", "tstr_SettingsInterfacePersistentUIWindowsStatePosition", "tstr_SettingsInterfacePersistentUIWindowsStatePositionReset", "tstr_SettingsInterfacePersistentUIWindowsStateSize", "tstr_SettingsInterfacePersistentUIWindowsStateLaunchRestore", "tstr_SettingsEnvironmentBackgroundColor", "tstr_SettingsEnvironmentBackgroundColorDispModeNever", "tstr_SettingsEnvironmentBackgroundColorDispModeDPlusTab", "tstr_SettingsEnvironmentBackgroundColorDispModeAlways", "tstr_SettingsEnvironmentDimInterface", "tstr_SettingsEnvironmentDimInterfaceTip", "tstr_SettingsProfilesOverlays", "tstr_SettingsProfilesApps", "tstr_SettingsProfilesManage", "tstr_SettingsProfilesOverlaysHeader", "tstr_SettingsProfilesOverlaysNameDefault", "tstr_SettingsProfilesOverlaysNameNew", "tstr_SettingsProfilesOverlaysNameNewBase", "tstr_SettingsProfilesOverlaysProfileLoad", "tstr_SettingsProfilesOverlaysProfileAdd", "tstr_SettingsProfilesOverlaysProfileSave", "tstr_SettingsProfilesOverlaysProfileDelete", "tstr_SettingsProfilesOverlaysProfileDeleteConfirm", "tstr_SettingsProfilesOverlaysProfileFailedLoad", "tstr_SettingsProfilesOverlaysProfileFailedDelete", "tstr_SettingsProfilesOverlaysProfileAddSelectHeader", "tstr_SettingsProfilesOverlaysProfileAddSelectEmpty", "tstr_SettingsProfilesOverlaysProfileAddSelectDo", "tstr_SettingsProfilesOverlaysProfileAddSelectAll", "tstr_SettingsProfilesOverlaysProfileAddSelectNone", "tstr_SettingsProfilesOverlaysProfileSaveSelectHeader", "tstr_SettingsProfilesOverlaysProfileSaveSelectName", "tstr_SettingsProfilesOverlaysProfileSaveSelectNameErrorBlank", "tstr_SettingsProfilesOverlaysProfileSaveSelectNameErrorTaken", "tstr_SettingsProfilesOverlaysProfileSaveSelectHeaderList", "tstr_SettingsProfilesOverlaysProfileSaveSelectDo", "tstr_SettingsProfilesOverlaysProfileSaveSelectDoFailed", "tstr_SettingsProfilesAppsHeader", "tstr_SettingsProfilesAppsHeaderNoVRTip", "tstr_SettingsProfilesAppsListEmpty", "tstr_SettingsProfilesAppsProfileHeaderActive", "tstr_SettingsProfilesAppsProfileEnabled", "tstr_SettingsProfilesAppsProfileOverlayProfile", "tstr_SettingsProfilesAppsProfileActionEnter", "tstr_SettingsProfilesAppsProfileActionLeave", "tstr_SettingsActionsManage", "tstr_SettingsActionsManageButton", "tstr_SettingsActionsButtonsOrderDefault", "tstr_SettingsActionsButtonsOrderOverlayBar", "tstr_SettingsActionsShowBindings", "tstr_SettingsActionsActiveShortcuts", "tstr_SettingsActionsActiveShortcutsTip", "tstr_SettingsActionsActiveShortuctsHome", "tstr_SettingsActionsActiveShortuctsBack", "tstr_SettingsActionsGlobalShortcuts", "tstr_SettingsActionsGlobalShortcutsTip", "tstr_SettingsActionsGlobalShortcutsEntry", "tstr_SettingsActionsGlobalShortcutsAdd", "tstr_SettingsActionsGlobalShortcutsRemove", "tstr_SettingsActionsHotkeys", "tstr_SettingsActionsHotkeysTip", "tstr_SettingsActionsHotkeysAdd", "tstr_SettingsActionsHotkeysRemove", "tstr_SettingsActionsTableHeaderAction", "tstr_SettingsActionsTableHeaderShortcut", "tstr_SettingsActionsTableHeaderHotkey", "tstr_SettingsActionsManageHeader", "tstr_SettingsActionsManageCopyUID", "tstr_SettingsActionsManageNew", "tstr_SettingsActionsManageEdit", "tstr_SettingsActionsManageDuplicate", "tstr_SettingsActionsManageDelete", "tstr_SettingsActionsManageDeleteConfirm", "tstr_SettingsActionsManageDuplicatedName", "tstr_SettingsActionsEditHeader", "tstr_SettingsActionsEditName", "tstr_SettingsActionsEditNameTranslatedTip", "tstr_SettingsActionsEditTarget", "tstr_SettingsActionsEditTargetDefault", "tstr_SettingsActionsEditTargetDefaultTip", "tstr_SettingsActionsEditTargetUseTags", "tstr_SettingsActionsEditTargetActionTarget", "tstr_SettingsActionsEditHeaderAppearance", "tstr_SettingsActionsEditIcon", "tstr_SettingsActionsEditLabel", "tstr_SettingsActionsEditLabelTranslatedTip", "tstr_SettingsActionsEditHeaderCommands", "tstr_SettingsActionsEditNameNew", "tstr_SettingsActionsEditCommandAdd", "tstr_SettingsActionsEditCommandDelete", "tstr_SettingsActionsEditCommandDeleteConfirm", "tstr_SettingsActionsEditCommandType", "tstr_SettingsActionsEditCommandTypeNone", "tstr_SettingsActionsEditCommandTypeKey", "tstr_SettingsActionsEditCommandTypeMousePos", "tstr_SettingsActionsEditCommandTypeString", "tstr_SettingsActionsEditCommandTypeLaunchApp", "tstr_SettingsActionsEditCommandTypeShowKeyboard", "tstr_SettingsActionsEditCommandTypeCropActiveWindow", "tstr_SettingsActionsEditCommandTypeShowOverlay", "tstr_SettingsActionsEditCommandTypeSwitchTask", "tstr_SettingsActionsEditCommandTypeLoadOverlayProfile", "tstr_SettingsActionsEditCommandTypeUnknown", "tstr_SettingsActionsEditCommandVisibilityToggle", "tstr_SettingsActionsEditCommandVisibilityShow", "tstr_SettingsActionsEditCommandVisibilityHide", "tstr_SettingsActionsEditCommandUndo", "tstr_SettingsActionsEditCommandKeyCode", "tstr_SettingsActionsEditCommandKeyToggle", "tstr_SettingsActionsEditCommandMouseX", "tstr_SettingsActionsEditCommandMouseY", "tstr_SettingsActionsEditCommandMouseUseCurrent", "tstr_SettingsActionsEditCommandString", "tstr_SettingsActionsEditCommandPath", "tstr_SettingsActionsEditCommandPathTip", "tstr_SettingsActionsEditCommandArgs", "tstr_SettingsActionsEditCommandArgsTip", "tstr_SettingsActionsEditCommandVisibility", "tstr_SettingsActionsEditCommandSwitchingMethod", "tstr_SettingsActionsEditCommandSwitchingMethodSwitcher", "tstr_SettingsActionsEditCommandSwitchingMethodFocus", "tstr_SettingsActionsEditCommandWindow", "tstr_SettingsActionsEditCommandWindowNone", "tstr_SettingsActionsEditCommandWindowStrictMatchingTip", "tstr_SettingsActionsEditCommandCursorWarp", "tstr_SettingsActionsEditCommandProfile", "tstr_SettingsActionsEditCommandProfileClear", "tstr_SettingsActionsEditCommandDescNone", "tstr_SettingsActionsEditCommandDescKey", "tstr_SettingsActionsEditCommandDescKeyToggle", "tstr_SettingsActionsEditCommandDescMousePos", "tstr_SettingsActionsEditCommandDescString", "tstr_SettingsActionsEditCommandDescLaunchApp", "tstr_SettingsActionsEditCommandDescLaunchAppArgsOpt", "tstr_SettingsActionsEditCommandDescKeyboardToggle", "tstr_SettingsActionsEditCommandDescKeyboardShow", "tstr_SettingsActionsEditCommandDescKeyboardHide", "tstr_SettingsActionsEditCommandDescCropWindow", "tstr_SettingsActionsEditCommandDescOverlayToggle", "tstr_SettingsActionsEditCommandDescOverlayShow", "tstr_SettingsActionsEditCommandDescOverlayHide", "tstr_SettingsActionsEditCommandDescOverlayTargetDefault", "tstr_SettingsActionsEditCommandDescSwitchTask", "tstr_SettingsActionsEditCommandDescSwitchTaskWindow", "tstr_SettingsActionsEditCommandDescLoadOverlayProfile", "tstr_SettingsActionsEditCommandDescLoadOverlayProfileAdd", "tstr_SettingsActionsEditCommandDescUnknown", "tstr_SettingsActionsOrderHeader", "tstr_SettingsActionsOrderButtonLabel", "tstr_SettingsActionsOrderButtonLabelSingular", "tstr_SettingsActionsOrderNoActions", "tstr_SettingsActionsOrderAdd", "tstr_SettingsActionsOrderRemove", "tstr_SettingsActionsAddSelectorHeader", "tstr_SettingsActionsAddSelectorAdd", "tstr_SettingsKeyboardLayout", "tstr_SettingsKeyboardSize", "tstr_SettingsKeyboardBehavior", "tstr_SettingsKeyboardStickyMod", "tstr_SettingsKeyboardKeyRepeat", "tstr_SettingsKeyboardAutoShow", "tstr_SettingsKeyboardAutoShowDesktopOnly", "tstr_SettingsKeyboardAutoShowDesktop", "tstr_SettingsKeyboardAutoShowDesktopTip", "tstr_SettingsKeyboardAutoShowBrowser", "tstr_SettingsKeyboardLayoutAuthor", "tstr_SettingsKeyboardKeyClusters", "tstr_SettingsKeyboardKeyClusterBase", "tstr_SettingsKeyboardKeyClusterFunction", "tstr_SettingsKeyboardKeyClusterNavigation", "tstr_SettingsKeyboardKeyClusterNumpad", "tstr_SettingsKeyboardKeyClusterExtra", "tstr_SettingsKeyboardSwitchToEditor", "tstr_SettingsMouseShowCursor", "tstr_SettingsMouseShowCursorGCUnsupported", "tstr_SettingsMouseShowCursorGCActiveWarning", "tstr_SettingsMouseScrollSmooth", "tstr_SettingsMouseSimulatePen", "tstr_SettingsMouseSimulatePenUnsupported", "tstr_SettingsMouseAllowLaserPointerOverride", "tstr_SettingsMouseAllowLaserPointerOverrideTip", "tstr_SettingsMouseDoubleClickAssist", "tstr_SettingsMouseDoubleClickAssistTip", "tstr_SettingsMouseDoubleClickAssistTipValueOff", "tstr_SettingsMouseDoubleClickAssistTipValueAuto", "tstr_SettingsMouseSmoothing", "tstr_SettingsMouseSmoothingLevelNone", "tstr_SettingsMouseSmoothingLevelVeryLow", "tstr_SettingsMouseSmoothingLevelLow", "tstr_SettingsMouseSmoothingLevelMedium", "tstr_SettingsMouseSmoothingLevelHigh", "tstr_SettingsMouseSmoothingLevelVeryHigh", "tstr_SettingsLaserPointerTip", "tstr_SettingsLaserPointerBlockInput", "tstr_SettingsLaserPointerAutoToggleDistance", "tstr_SettingsLaserPointerAutoToggleDistanceValueOff", "tstr_SettingsLaserPointerHMDPointer", "tstr_SettingsLaserPointerHMDPointerTableHeaderInputAction", "tstr_SettingsLaserPointerHMDPointerTableHeaderBinding", "tstr_SettingsLaserPointerHMDPointerTableBindingToggle", "tstr_SettingsLaserPointerHMDPointerTableBindingLeft", "tstr_SettingsLaserPointerHMDPointerTableBindingRight", "tstr_SettingsLaserPointerHMDPointerTableBindingMiddle", "tstr_SettingsLaserPointerHMDPointerTableBindingDrag", "tstr_SettingsWindowOverlaysAutoFocus", "tstr_SettingsWindowOverlaysKeepOnScreen", "tstr_SettingsWindowOverlaysKeepOnScreenTip", "tstr_SettingsWindowOverlaysAutoSizeOverlay", "tstr_SettingsWindowOverlaysFocusSceneApp", "tstr_SettingsWindowOverlaysFocusSceneAppDashboard", "tstr_SettingsWindowOverlaysOnWindowDrag", "tstr_SettingsWindowOverlaysOnWindowDragDoNothing", "tstr_SettingsWindowOverlaysOnWindowDragBlock", "tstr_SettingsWindowOverlaysOnWindowDragOverlay", "tstr_SettingsWindowOverlaysOnCaptureLoss", "tstr_SettingsWindowOverlaysOnCaptureLossTip", "tstr_SettingsWindowOverlaysOnCaptureLossDoNothing", "tstr_SettingsWindowOverlaysOnCaptureLossHide", "tstr_SettingsWindowOverlaysOnCaptureLossRemove", "tstr_SettingsBrowserMaxFrameRate", "tstr_SettingsBrowserMaxFrameRateOverrideOff", "tstr_SettingsBrowserContentBlocker", "tstr_SettingsBrowserContentBlockerTip", "tstr_SettingsBrowserContentBlockerListCount", "tstr_SettingsBrowserContentBlockerListCountSingular", "tstr_SettingsPerformanceUpdateLimiter", "tstr_SettingsPerformanceUpdateLimiterMode", "tstr_SettingsPerformanceUpdateLimiterModeOff", "tstr_SettingsPerformanceUpdateLimiterModeMS", "tstr_SettingsPerformanceUpdateLimiterModeFPS", "tstr_SettingsPerformanceUpdateLimiterModeOffOverride", "tstr_SettingsPerformanceUpdateLimiterModeMSTip", "tstr_SettingsPerformanceUpdateLimiterFPSValue", "tstr_SettingsPerformanceUpdateLimiterOverride", "tstr_SettingsPerformanceUpdateLimiterOverrideTip", "tstr_SettingsPerformanceUpdateLimiterModeOverride", "tstr_SettingsPerformanceRapidUpdates", "tstr_SettingsPerformanceRapidUpdatesTip", "tstr_SettingsPerformanceSingleDesktopMirror", "tstr_SettingsPerformanceSingleDesktopMirrorTip", "tstr_SettingsPerformanceAlternativeCursorRendering", "tstr_SettingsPerformanceAlternativeCursorRenderingTip", "tstr_SettingsPerformanceUseHDR", "tstr_SettingsPerformanceUseHDRTip", "tstr_SettingsPerformanceShowFPS", "tstr_SettingsWarningsHidden", "tstr_SettingsWarningsReset", "tstr_SettingsStartupAutoLaunch", "tstr_SettingsStartupSteamDisable", "tstr_SettingsStartupSteamDisableTip", "tstr_SettingsTroubleshootingRestart", "tstr_SettingsTroubleshootingRestartSteam", "tstr_SettingsTroubleshootingRestartDesktop", "tstr_SettingsTroubleshootingElevatedModeEnter", "tstr_SettingsTroubleshootingElevatedModeLeave", "tstr_SettingsTroubleshootingSettingsReset", "tstr_SettingsTroubleshootingSettingsResetConfirmDescription", "tstr_SettingsTroubleshootingSettingsResetConfirmButton", "tstr_SettingsTroubleshootingSettingsResetConfirmElementOverlays", "tstr_SettingsTroubleshootingSettingsResetConfirmElementLegacyFiles", "tstr_SettingsTroubleshootingSettingsResetShowQuickStart", "tstr_KeyboardWindowTitle", "tstr_KeyboardWindowTitleSettings", "tstr_KeyboardWindowTitleOverlay", "tstr_KeyboardWindowTitleOverlayUnknown", "tstr_KeyboardShortcutsCut", "tstr_KeyboardShortcutsCopy", "tstr_KeyboardShortcutsPaste", "tstr_OvrlPropsCatPosition", "tstr_OvrlPropsCatAppearance", "tstr_OvrlPropsCatCapture", "tstr_OvrlPropsCatPerformanceMonitor", "tstr_OvrlPropsCatBrowser", "tstr_OvrlPropsCatAdvanced", "tstr_OvrlPropsCatPerformance", "tstr_OvrlPropsCatInterface", "tstr_OvrlPropsPositionOrigin", "tstr_OvrlPropsPositionOriginRoom", "tstr_OvrlPropsPositionOriginHMDXY", "tstr_OvrlPropsPositionOriginSeatedSpace", "tstr_OvrlPropsPositionOriginDashboard", "tstr_OvrlPropsPositionOriginHMD", "tstr_OvrlPropsPositionOriginControllerL", "tstr_OvrlPropsPositionOriginControllerR", "tstr_OvrlPropsPositionOriginTracker1", "tstr_OvrlPropsPositionOriginTheaterScreen", "tstr_OvrlPropsPositionOriginConfigHMDXYTurning", "tstr_OvrlPropsPositionOriginConfigTheaterScreenEnter", "tstr_OvrlPropsPositionOriginConfigTheaterScreenLeave", "tstr_OvrlPropsPositionOriginConfigSmoothing", "tstr_OvrlPropsPositionOriginTheaterScreenTip", "tstr_OvrlPropsPositionDispMode", "tstr_OvrlPropsPositionDispModeAlways", "tstr_OvrlPropsPositionDispModeDashboard", "tstr_OvrlPropsPositionDispModeScene", "tstr_OvrlPropsPositionDispModeDPlus", "tstr_OvrlPropsPositionPos", "tstr_OvrlPropsPositionPosTip", "tstr_OvrlPropsPositionChange", "tstr_OvrlPropsPositionReset", "tstr_OvrlPropsPositionLock", "tstr_OvrlPropsPositionChangeHeader", "tstr_OvrlPropsPositionChangeHelp", "tstr_OvrlPropsPositionChangeHelpDesktop", "tstr_OvrlPropsPositionChangeManualAdjustment", "tstr_OvrlPropsPositionChangeMove", "tstr_OvrlPropsPositionChangeRotate", "tstr_OvrlPropsPositionChangeForward", "tstr_OvrlPropsPositionChangeBackward", "tstr_OvrlPropsPositionChangeRollCW", "tstr_OvrlPropsPositionChangeRollCCW", "tstr_OvrlPropsPositionChangeLookAt", "tstr_OvrlPropsPositionChangeDragButton", "tstr_OvrlPropsPositionChangeOffset", "tstr_OvrlPropsPositionChangeOffsetUpDown", "tstr_OvrlPropsPositionChangeOffsetRightLeft", "tstr_OvrlPropsPositionChangeOffsetForwardBackward", "tstr_OvrlPropsPositionChangeDragSettings", "tstr_OvrlPropsPositionChangeDragSettingsAutoDocking", "tstr_OvrlPropsPositionChangeDragSettingsForceDistance", "tstr_OvrlPropsPositionChangeDragSettingsForceDistanceShape", "tstr_OvrlPropsPositionChangeDragSettingsForceDistanceShapeSphere", "tstr_OvrlPropsPositionChangeDragSettingsForceDistanceShapeCylinder", "tstr_OvrlPropsPositionChangeDragSettingsForceDistanceAutoCurve", "tstr_OvrlPropsPositionChangeDragSettingsForceDistanceAutoTilt", "tstr_OvrlPropsPositionChangeDragSettingsSnapPosition", "tstr_OvrlPropsPositionChangeDragSettingsSnapRotation", "tstr_OvrlPropsPositionChangeDragSettingsSnapRotationPitch", "tstr_OvrlPropsPositionChangeDragSettingsSnapRotationYaw", "tstr_OvrlPropsPositionChangeDragSettingsSnapRotationRoll", "tstr_OvrlPropsAppearanceWidth", "tstr_OvrlPropsAppearanceCurve", "tstr_OvrlPropsAppearanceOpacity", "tstr_OvrlPropsAppearanceBrightness", "tstr_OvrlPropsAppearanceCrop", "tstr_OvrlPropsAppearanceCropValueMax", "tstr_OvrlPropsAppearanceShowBackside", "tstr_OvrlPropsCrop", "tstr_OvrlPropsCropHelp", "tstr_OvrlPropsCropManualAdjust", "tstr_OvrlPropsCropInvalidTip", "tstr_OvrlPropsCropX", "tstr_OvrlPropsCropY", "tstr_OvrlPropsCropWidth", "tstr_OvrlPropsCropHeight", "tstr_OvrlPropsCropToWindow", "tstr_OvrlPropsCaptureMethod", "tstr_OvrlPropsCaptureMethodDup", "tstr_OvrlPropsCaptureMethodGC", "tstr_OvrlPropsCaptureMethodGCUnsupportedTip", "tstr_OvrlPropsCaptureMethodGCUnsupportedPartialTip", "tstr_OvrlPropsCaptureSource", "tstr_OvrlPropsCaptureGCSource", "tstr_OvrlPropsCaptureSourceUnknownWarning", "tstr_OvrlPropsCaptureGCStrictMatching", "tstr_OvrlPropsCaptureGCStrictMatchingTip", "tstr_OvrlPropsPerfMonDesktopModeTip", "tstr_OvrlPropsPerfMonGlobalTip", "tstr_OvrlPropsPerfMonStyle", "tstr_OvrlPropsPerfMonItems", "tstr_OvrlPropsPerfMonStyleMinimal", "tstr_OvrlPropsPerfMonStyleCompact", "tstr_OvrlPropsPerfMonStyleLarge", "tstr_OvrlPropsPerfMonStyleShowWindow", "tstr_OvrlPropsPerfMonStyleShowTextOutline", "tstr_OvrlPropsPerfMonStyleMinimalShowMore", "tstr_OvrlPropsPerfMonItemCPU", "tstr_OvrlPropsPerfMonItemGPU", "tstr_OvrlPropsPerfMonItemGraphs", "tstr_OvrlPropsPerfMonItemFrameStats", "tstr_OvrlPropsPerfMonItemTime", "tstr_OvrlPropsPerfMonItemBattery", "tstr_OvrlPropsPerfMonItemTrackerBattery", "tstr_OvrlPropsPerfMonItemViveWirelessTemp", "tstr_OvrlPropsPerfMonResetValues", "tstr_OvrlPropsBrowserNotAvailableTip", "tstr_OvrlPropsBrowserCloned", "tstr_OvrlPropsBrowserClonedTip", "tstr_OvrlPropsBrowserClonedConvert", "tstr_OvrlPropsBrowserURL", "tstr_OvrlPropsBrowserURLHint", "tstr_OvrlPropsBrowserGo", "tstr_OvrlPropsBrowserRestore", "tstr_OvrlPropsBrowserWidth", "tstr_OvrlPropsBrowserHeight", "tstr_OvrlPropsBrowserZoom", "tstr_OvrlPropsBrowserAllowTransparency", "tstr_OvrlPropsBrowserAllowTransparencyTip", "tstr_OvrlPropsBrowserRecreateContext", "tstr_OvrlPropsBrowserRecreateContextTip", "tstr_OvrlPropsAdvanced3D", "tstr_OvrlPropsAdvancedHSBS", "tstr_OvrlPropsAdvancedSBS", "tstr_OvrlPropsAdvancedHOU", "tstr_OvrlPropsAdvancedOU", "tstr_OvrlPropsAdvanced3DSwap", "tstr_OvrlPropsAdvancedGazeFade", "tstr_OvrlPropsAdvancedGazeFadeAuto", "tstr_OvrlPropsAdvancedGazeFadeDistance", "tstr_OvrlPropsAdvancedGazeFadeDistanceValueInf", "tstr_OvrlPropsAdvancedGazeFadeSensitivity", "tstr_OvrlPropsAdvancedGazeFadeOpacity", "tstr_OvrlPropsAdvancedInput", "tstr_OvrlPropsAdvancedInputInGame", "tstr_OvrlPropsAdvancedInputFloatingUI", "tstr_OvrlPropsAdvancedOverlayTags", "tstr_OvrlPropsAdvancedOverlayTagsTip", "tstr_OvrlPropsPerformanceInvisibleUpdate", "tstr_OvrlPropsPerformanceInvisibleUpdateTip", "tstr_OvrlPropsInterfaceOverlayName", "tstr_OvrlPropsInterfaceOverlayNameAuto", "tstr_OvrlPropsInterfaceActionOrderCustom", "tstr_OvrlPropsInterfaceDesktopButtons", "tstr_OvrlPropsInterfaceExtraButtons", "tstr_OverlayBarOvrlHide", "tstr_OverlayBarOvrlShow", "tstr_OverlayBarOvrlClone", "tstr_OverlayBarOvrlRemove", "tstr_OverlayBarOvrlRemoveConfirm", "tstr_OverlayBarOvrlProperties", "tstr_OverlayBarOvrlAddWindow", "tstr_OverlayBarTooltipOvrlAdd", "tstr_OverlayBarTooltipSettings", "tstr_OverlayBarTooltipResetHold", "tstr_FloatingUIHideOverlayTip", "tstr_FloatingUIHideOverlayHoldTip", "tstr_FloatingUIDragModeEnableTip", "tstr_FloatingUIDragModeDisableTip", "tstr_FloatingUIDragModeHoldLockTip", "tstr_FloatingUIDragModeHoldUnlockTip", "tstr_FloatingUIWindowAddTip", "tstr_FloatingUIActionBarShowTip", "tstr_FloatingUIActionBarHideTip", "tstr_FloatingUIBrowserGoBackTip", "tstr_FloatingUIBrowserGoForwardTip", "tstr_FloatingUIBrowserRefreshTip", "tstr_FloatingUIBrowserStopTip", "tstr_FloatingUIActionBarDesktopPrev", "tstr_FloatingUIActionBarDesktopNext", "tstr_FloatingUIActionBarEmpty", "tstr_ActionNone", "tstr_ActionKeyboardShow", "tstr_ActionKeyboardHide", "tstr_DefActionShowKeyboard", "tstr_DefActionActiveWindowCrop", "tstr_DefActionActiveWindowCropLabel", "tstr_DefActionSwitchTask", "tstr_DefActionToggleOverlays", "tstr_DefActionToggleOverlaysLabel", "tstr_DefActionMiddleMouse", "tstr_DefActionMiddleMouseLabel", "tstr_DefActionBackMouse", "tstr_DefActionBackMouseLabel", "tstr_DefActionReadMe", "tstr_DefActionReadMeLabel", "tstr_DefActionDashboardToggle", "tstr_DefActionDashboardToggleLabel", "tstr_PerformanceMonitorCPU", "tstr_PerformanceMonitorGPU", "tstr_PerformanceMonitorRAM", "tstr_PerformanceMonitorVRAM", "tstr_PerformanceMonitorFrameTime", "tstr_PerformanceMonitorLoad", "tstr_PerformanceMonitorFPS", "tstr_PerformanceMonitorFPSAverage", "tstr_PerformanceMonitorReprojectionRatio", "tstr_PerformanceMonitorDroppedFrames", "tstr_PerformanceMonitorBatteryLeft", "tstr_PerformanceMonitorBatteryRight", "tstr_PerformanceMonitorBatteryHMD", "tstr_PerformanceMonitorBatteryTracker", "tstr_PerformanceMonitorBatteryDisconnected", "tstr_PerformanceMonitorViveWirelessTempNotAvailable", "tstr_PerformanceMonitorCompactCPU", "tstr_PerformanceMonitorCompactGPU", "tstr_PerformanceMonitorCompactFPS", "tstr_PerformanceMonitorCompactFPSAverage", "tstr_PerformanceMonitorCompactReprojectionRatio", "tstr_PerformanceMonitorCompactDroppedFrames", "tstr_PerformanceMonitorCompactBattery", "tstr_PerformanceMonitorCompactBatteryLeft", "tstr_PerformanceMonitorCompactBatteryRight", "tstr_PerformanceMonitorCompactBatteryHMD", "tstr_PerformanceMonitorCompactBatteryTracker", "tstr_PerformanceMonitorCompactBatteryDisconnected", "tstr_PerformanceMonitorCompactViveWirelessTempNotAvailable", "tstr_PerformanceMonitorEmpty", "tstr_AuxUIDragHintDocking", "tstr_AuxUIDragHintUndocking", "tstr_AuxUIDragHintOvrlLocked", "tstr_AuxUIDragHintOvrlTheaterScreenBlocked", "tstr_AuxUIGazeFadeAutoHint", "tstr_AuxUIGazeFadeAutoHintSingular", "tstr_AuxUIQuickStartWelcomeHeader", "tstr_AuxUIQuickStartWelcomeBody", "tstr_AuxUIQuickStartOverlaysHeader", "tstr_AuxUIQuickStartOverlaysBody", "tstr_AuxUIQuickStartOverlaysBody2", "tstr_AuxUIQuickStartOverlayPropertiesHeader", "tstr_AuxUIQuickStartOverlayPropertiesBody", "tstr_AuxUIQuickStartOverlayPropertiesBody2", "tstr_AuxUIQuickStartSettingsHeader", "tstr_AuxUIQuickStartSettingsBody", "tstr_AuxUIQuickStartProfilesHeader", "tstr_AuxUIQuickStartProfilesBody", "tstr_AuxUIQuickStartActionsHeader", "tstr_AuxUIQuickStartActionsBody", "tstr_AuxUIQuickStartActionsBody2", "tstr_AuxUIQuickStartOverlayTagsHeader", "tstr_AuxUIQuickStartOverlayTagsBody", "tstr_AuxUIQuickStartSettingsEndBody", "tstr_AuxUIQuickStartFloatingUIHeader", "tstr_AuxUIQuickStartFloatingUIBody", "tstr_AuxUIQuickStartDesktopModeHeader", "tstr_AuxUIQuickStartDesktopModeBody", "tstr_AuxUIQuickStartEndHeader", "tstr_AuxUIQuickStartEndBody", "tstr_AuxUIQuickStartButtonNext", "tstr_AuxUIQuickStartButtonPrev", "tstr_AuxUIQuickStartButtonClose", "tstr_DesktopModeCatTools", "tstr_DesktopModeCatOverlays", "tstr_DesktopModeToolSettings", "tstr_DesktopModeToolActions", "tstr_DesktopModeOverlayListAdd", "tstr_DesktopModePageAddWindowOverlayTitle", "tstr_DesktopModePageAddWindowOverlayHeader", "tstr_KeyboardEditorKeyListTitle", "tstr_KeyboardEditorKeyListTabContextReplace", "tstr_KeyboardEditorKeyListTabContextClear", "tstr_KeyboardEditorKeyListRow", "tstr_KeyboardEditorKeyListSpacing", "tstr_KeyboardEditorKeyListKeyAdd", "tstr_KeyboardEditorKeyListKeyDuplicate", "tstr_KeyboardEditorKeyListKeyRemove", "tstr_KeyboardEditorKeyPropertiesTitle", "tstr_KeyboardEditorKeyPropertiesNoSelection", "tstr_KeyboardEditorKeyPropertiesType", "tstr_KeyboardEditorKeyPropertiesTypeBlank", "tstr_KeyboardEditorKeyPropertiesTypeVirtualKey", "tstr_KeyboardEditorKeyPropertiesTypeVirtualKeyToggle", "tstr_KeyboardEditorKeyPropertiesTypeVirtualKeyIsoEnter", "tstr_KeyboardEditorKeyPropertiesTypeString", "tstr_KeyboardEditorKeyPropertiesTypeSublayoutToggle", "tstr_KeyboardEditorKeyPropertiesTypeAction", "tstr_KeyboardEditorKeyPropertiesTypeVirtualKeyIsoEnterTip", "tstr_KeyboardEditorKeyPropertiesTypeStringTip", "tstr_KeyboardEditorKeyPropertiesSize", "tstr_KeyboardEditorKeyPropertiesLabel", "tstr_KeyboardEditorKeyPropertiesKeyCode", "tstr_KeyboardEditorKeyPropertiesString", "tstr_KeyboardEditorKeyPropertiesSublayout", "tstr_KeyboardEditorKeyPropertiesAction", "tstr_KeyboardEditorKeyPropertiesCluster", "tstr_KeyboardEditorKeyPropertiesClusterTip", "tstr_KeyboardEditorKeyPropertiesBlockModifiers", "tstr_KeyboardEditorKeyPropertiesBlockModifiersTip", "tstr_KeyboardEditorKeyPropertiesNoRepeat", "tstr_KeyboardEditorKeyPropertiesNoRepeatTip", "tstr_KeyboardEditorMetadataTitle", "tstr_KeyboardEditorMetadataName", "tstr_KeyboardEditorMetadataAuthor", "tstr_KeyboardEditorMetadataHasAltGr", "tstr_KeyboardEditorMetadataHasAltGrTip", "tstr_KeyboardEditorMetadataClusterPreview", "tstr_KeyboardEditorMetadataSave", "tstr_KeyboardEditorMetadataLoad", "tstr_KeyboardEditorMetadataSavePopupTitle", "tstr_KeyboardEditorMetadataSavePopupFilename", "tstr_KeyboardEditorMetadataSavePopupFilenameBlankTip", "tstr_KeyboardEditorMetadataSavePopupConfirm", "tstr_KeyboardEditorMetadataSavePopupConfirmError", "tstr_KeyboardEditorMetadataLoadPopupTitle", "tstr_KeyboardEditorMetadataLoadPopupConfirm", "tstr_KeyboardEditorPreviewTitle", "tstr_KeyboardEditorSublayoutBase", "tstr_KeyboardEditorSublayoutShift", "tstr_KeyboardEditorSublayoutAltGr", "tstr_KeyboardEditorSublayoutAux", "tstr_DialogOk", "tstr_DialogCancel", "tstr_DialogDone", "tstr_DialogUndo", "tstr_DialogRedo", "tstr_DialogColorPickerHeader", "tstr_DialogColorPickerCurrent", "tstr_DialogColorPickerOriginal", "tstr_DialogProfilePickerHeader", "tstr_DialogProfilePickerNone", "tstr_DialogActionPickerHeader", "tstr_DialogActionPickerEmpty", "tstr_DialogIconPickerHeader", "tstr_DialogIconPickerHeaderTip", "tstr_DialogIconPickerNone", "tstr_DialogKeyCodePickerHeader", "tstr_DialogKeyCodePickerHeaderHotkey", "tstr_DialogKeyCodePickerModifiers", "tstr_DialogKeyCodePickerKeyCode", "tstr_DialogKeyCodePickerKeyCodeHint", "tstr_DialogKeyCodePickerKeyCodeNone", "tstr_DialogKeyCodePickerFromInput", "tstr_DialogKeyCodePickerFromInputPopup", "tstr_DialogKeyCodePickerFromInputPopupNoMouse", "tstr_DialogWindowPickerHeader", "tstr_DialogInputTagsHint", "tstr_SourceDesktopAll", "tstr_SourceDesktopID", "tstr_SourceWinRTNone", "tstr_SourceWinRTUnknown", "tstr_SourceWinRTClosed", "tstr_SourcePerformanceMonitor", "tstr_SourceBrowser", "tstr_SourceBrowserNoPage", "tstr_NotificationIconRestoreVR", "tstr_NotificationIconOpenOnDesktop", "tstr_NotificationIconQuit", "tstr_NotificationInitialStartupTitleVR", "tstr_NotificationInitialStartupTitleDesktop", "tstr_NotificationInitialStartupMessage", "tstr_BrowserErrorPageTitle", "tstr_BrowserErrorPageHeading", "tstr_BrowserErrorPageMessage", }; static TranslationManager g_TranslationManager; TranslationManager::TranslationManager() { //Init strings with ID names in case even fallback English doesn't have them for (size_t i = 0; i < tstr_MAX; ++i) { m_Strings[i] = s_StringIDNames[i]; } } TranslationManager& TranslationManager::Get() { return g_TranslationManager; } const char* TranslationManager::GetString(TRMGRStrID str_id) { return Get().m_Strings[str_id].c_str(); } TRMGRStrID TranslationManager::GetStringID(const char* str) { const auto it_begin = std::begin(s_StringIDNames), it_end = std::end(s_StringIDNames); const auto it = std::find_if(it_begin, it_end, [&](const char* str_id_name){ return (strcmp(str_id_name, str) == 0); }); if (it != it_end) return (TRMGRStrID)std::distance(it_begin, it); return tstr_NONE; } std::string TranslationManager::GetTranslationNameFromFile(const std::string& filename) { std::string name; std::string fullpath = ConfigManager::Get().GetApplicationPath() + "lang/" + filename; Ini lang_file( WStringConvertFromUTF8(fullpath.c_str()).c_str() ); //Check if it's probably a translation/language file if (lang_file.SectionExists("TranslationInfo")) { name = lang_file.ReadString("TranslationInfo", "Name"); } return name; } std::vector TranslationManager::GetTranslationList() { std::vector lang_list; const std::wstring wpath = WStringConvertFromUTF8( std::string(ConfigManager::Get().GetApplicationPath() + "lang/*.ini").c_str() ); WIN32_FIND_DATA find_data; HANDLE handle_find = ::FindFirstFileW(wpath.c_str(), &find_data); if (handle_find != INVALID_HANDLE_VALUE) { do { const std::string filename_utf8 = StringConvertFromUTF16(find_data.cFileName); const std::string name = GetTranslationNameFromFile(filename_utf8); //If name could be read, add to list if (!name.empty()) { lang_list.push_back({filename_utf8, name}); } } while (::FindNextFileW(handle_find, &find_data) != 0); ::FindClose(handle_find); } return lang_list; } void TranslationManager::LoadTranslationFromFile(const std::string& filename) { //When filename empty (called from empty config value), figure out the user's language to default to that if (filename.empty()) { wchar_t buffer[16] = {0}; ::GetLocaleInfoEx(LOCALE_NAME_USER_DEFAULT, LOCALE_SISO639LANGNAME, buffer, sizeof(buffer) / sizeof(wchar_t)); std::string lang = StringConvertFromUTF16(buffer); ::GetLocaleInfoEx(LOCALE_NAME_USER_DEFAULT, LOCALE_SISO3166CTRYNAME, buffer, sizeof(buffer) / sizeof(wchar_t)); std::string ctry = StringConvertFromUTF16(buffer); // ISO 639 code ideally matches the file names used, so this works as auto-detection // try to detect the language file with the country code first (e.g. en_US.ini) std::string lang_filename = lang + "_" + ctry + ".ini"; if (!FileExists(WStringConvertFromUTF8((ConfigManager::Get().GetApplicationPath() + "lang/" + lang_filename).c_str()).c_str())) { // if the country code file does not exist, try to load the language file without the country code (e.g. en.ini) lang_filename = lang + ".ini"; } ConfigManager::SetValue(configid_str_interface_language_file, lang_filename); LoadTranslationFromFile(lang_filename); return; } //Load English first as a fallback if (filename != "en.ini") { LoadTranslationFromFile("en.ini"); } std::string fullpath = ConfigManager::Get().GetApplicationPath() + "lang/" + filename; Ini lang_file( WStringConvertFromUTF8(fullpath.c_str()).c_str() ); //Check if it's probably a translation/language file if (lang_file.SectionExists("TranslationInfo")) { m_CurrentTranslationName = lang_file.ReadString("TranslationInfo", "Name", "Unknown"); m_CurrentTranslationAuthor = lang_file.ReadString("TranslationInfo", "Author"); m_CurrentTranslationFontName = lang_file.ReadString("TranslationInfo", "PreferredFont"); m_IsCurrentTranslationComplete = true; LOG_IF_F(INFO, (filename != "en.ini"), "Loading translation \"%s\", from \"%s\"...", m_CurrentTranslationName.c_str(), filename.c_str()); //Clear precomputed strings to regenerate them with new translation later m_StringsDesktopID.clear(); m_StringsFPSLimit.clear(); //Try loading all possible strings for (size_t i = 0; i < tstr_MAX; ++i) { if (lang_file.KeyExists("Strings", s_StringIDNames[i])) { m_Strings[i] = lang_file.ReadString("Strings", s_StringIDNames[i]); StringReplaceAll(m_Strings[i], "\\n", "\n"); //Replace new line placeholder } else { m_IsCurrentTranslationComplete = false; VLOG_F(1, "Missing translation string %s", s_StringIDNames[i]); } } LOG_IF_F(WARNING, ((!m_IsCurrentTranslationComplete) && (loguru::current_verbosity_cutoff() < 1)), "Translation has missing strings. Set logging verbosity to 1 or higher for more details"); //Append fixed IDs to strings that need it m_Strings[tstr_OverlayBarOvrlRemove] += "###OverlayRemove"; m_Strings[tstr_OverlayBarOvrlRemoveConfirm] += "###OverlayRemove"; m_Strings[tstr_SettingsProfilesOverlaysProfileDelete] += "###ProfileDelete"; m_Strings[tstr_SettingsProfilesOverlaysProfileDeleteConfirm] += "###ProfileDelete"; m_Strings[tstr_SettingsActionsManageDelete] += "###ActionDelete"; m_Strings[tstr_SettingsActionsManageDeleteConfirm] += "###ActionDelete"; m_Strings[tstr_SettingsActionsEditCommandDelete] += "###CommandDelete"; m_Strings[tstr_SettingsActionsEditCommandDeleteConfirm] += "###CommandDelete"; //Set locale or reset it if it's not in the file //It's debatable if we should set the locale based on the language as they're separate things... but I personally like seeing separators and formats matching the typical language pattern. //It's always possible to edit the locale key to blank to get the user one here char* new_locale = setlocale(LC_ALL, lang_file.ReadString("TranslationInfo", "Locale", "C").c_str()); if (new_locale == nullptr) //Reset to "C" if it failed { setlocale(LC_ALL, "C"); } } else { LOG_F(WARNING, "Tried to load translation, but \"%s\" is not a valid translation file", filename.c_str()); } } bool TranslationManager::IsCurrentTranslationComplete() const { return m_IsCurrentTranslationComplete; } const std::string& TranslationManager::GetCurrentTranslationName() const { return m_CurrentTranslationName; } const std::string& TranslationManager::GetCurrentTranslationAuthor() const { return m_CurrentTranslationAuthor; } const std::string& TranslationManager::GetCurrentTranslationFontName() const { return m_CurrentTranslationFontName; } void TranslationManager::AddStringsToFontBuilder(ImFontGlyphRangesBuilder& builder) const { builder.AddText(m_CurrentTranslationName.c_str()); builder.AddText(m_CurrentTranslationAuthor.c_str()); for (const auto& str : m_Strings) { builder.AddText(str.c_str()); } } const char* TranslationManager::GetDesktopIDString(int desktop_id) { if (desktop_id < 0) { return GetString(tstr_SourceDesktopAll); } int desktop_count = ConfigManager::GetValue(configid_int_state_interface_desktop_count); desktop_id = clamp(desktop_id, 0, desktop_count - 1); //Generate desktop ID strings based on current translation while ((int)m_StringsDesktopID.size() < desktop_count) { std::string str = GetString(tstr_SourceDesktopID); StringReplaceAll(str, "%ID%", std::to_string(m_StringsDesktopID.size() + 1)); m_StringsDesktopID.push_back(str); } return m_StringsDesktopID[desktop_id].c_str(); } const char* TranslationManager::GetFPSLimitString(int fps_limit_id) { const int fps_limits[10] = { 1, 2, 5, 10, 15, 20, 25, 30, 40, 50 }; //Set out of range value to ID 10 if ( (fps_limit_id < 0) || (fps_limit_id > 9) ) { fps_limit_id = 10; } //Generate fps limit strings based on current translation if needed if (m_StringsFPSLimit.empty()) { for (int limit : fps_limits) { std::string str = GetString(tstr_SettingsPerformanceUpdateLimiterFPSValue); StringReplaceAll(str, "%FPS%", std::to_string(limit)); m_StringsFPSLimit.push_back(str); } //Out of range string std::string str = GetString(tstr_SettingsPerformanceUpdateLimiterFPSValue); StringReplaceAll(str, "%FPS%", "?"); m_StringsFPSLimit.push_back(str); } return m_StringsFPSLimit[fps_limit_id].c_str(); } ================================================ FILE: src/DesktopPlusUI/TranslationManager.h ================================================ #pragma once #include #include #include "imgui.h" enum TRMGRStrID { tstr_SettingsWindowTitle, tstr_SettingsCatInterface, tstr_SettingsCatEnvironment, tstr_SettingsCatProfiles, tstr_SettingsCatActions, tstr_SettingsCatKeyboard, tstr_SettingsCatMouse, tstr_SettingsCatLaserPointer, tstr_SettingsCatWindowOverlays, tstr_SettingsCatBrowser, tstr_SettingsCatPerformance, tstr_SettingsCatVersionInfo, tstr_SettingsCatWarnings, tstr_SettingsCatStartup, tstr_SettingsCatTroubleshooting, tstr_SettingsWarningPrefix, tstr_SettingsWarningCompositorResolution, tstr_SettingsWarningCompositorQuality, tstr_SettingsWarningProcessElevated, tstr_SettingsWarningElevatedMode, tstr_SettingsWarningElevatedProcessFocus, tstr_SettingsWarningBrowserMissing, tstr_SettingsWarningBrowserMismatch, tstr_SettingsWarningUIAccessLost, tstr_SettingsWarningOverlayCreationErrorLimit, tstr_SettingsWarningOverlayCreationErrorOther, //%ERRORNAME% == VROverlay::GetOverlayErrorNameFromEnum() tstr_SettingsWarningGraphicsCaptureError, //%ERRORCODE% == WinRT HRESULT in hex notation tstr_SettingsWarningAppProfileActive, //%APPNAME% == name of active application tstr_SettingsWarningConfigMigrated, tstr_SettingsWarningMenuDontShowAgain, tstr_SettingsWarningMenuDismiss, tstr_SettingsInterfaceLanguage, tstr_SettingsInterfaceLanguageCommunity, //%AUTHOR% == Language Author string tstr_SettingsInterfaceLanguageIncompleteWarning, tstr_SettingsInterfaceAdvancedSettings, tstr_SettingsInterfaceAdvancedSettingsTip, tstr_SettingsInterfaceBlankSpaceDrag, tstr_SettingsInterfacePersistentUI, tstr_SettingsInterfacePersistentUIManage, tstr_SettingsInterfaceDesktopButtons, tstr_SettingsInterfaceDesktopButtonsNone, tstr_SettingsInterfaceDesktopButtonsIndividual, tstr_SettingsInterfaceDesktopButtonsCycle, tstr_SettingsInterfaceDesktopButtonsAddCombined, tstr_SettingsInterfacePersistentUIHelp, tstr_SettingsInterfacePersistentUIHelp2, tstr_SettingsInterfacePersistentUIWindowsHeader, tstr_SettingsInterfacePersistentUIWindowsSettings, tstr_SettingsInterfacePersistentUIWindowsProperties, tstr_SettingsInterfacePersistentUIWindowsKeyboard, tstr_SettingsInterfacePersistentUIWindowsStateGlobal, tstr_SettingsInterfacePersistentUIWindowsStateDashboardTab, tstr_SettingsInterfacePersistentUIWindowsStateVisible, tstr_SettingsInterfacePersistentUIWindowsStatePinned, tstr_SettingsInterfacePersistentUIWindowsStatePosition, tstr_SettingsInterfacePersistentUIWindowsStatePositionReset, tstr_SettingsInterfacePersistentUIWindowsStateSize, tstr_SettingsInterfacePersistentUIWindowsStateLaunchRestore, tstr_SettingsEnvironmentBackgroundColor, tstr_SettingsEnvironmentBackgroundColorDispModeNever, tstr_SettingsEnvironmentBackgroundColorDispModeDPlusTab, tstr_SettingsEnvironmentBackgroundColorDispModeAlways, tstr_SettingsEnvironmentDimInterface, tstr_SettingsEnvironmentDimInterfaceTip, tstr_SettingsProfilesOverlays, tstr_SettingsProfilesApps, tstr_SettingsProfilesManage, tstr_SettingsProfilesOverlaysHeader, tstr_SettingsProfilesOverlaysNameDefault, tstr_SettingsProfilesOverlaysNameNew, tstr_SettingsProfilesOverlaysNameNewBase, //%ID% == ID of profile, increased if previous number is already taken tstr_SettingsProfilesOverlaysProfileLoad, tstr_SettingsProfilesOverlaysProfileAdd, tstr_SettingsProfilesOverlaysProfileSave, tstr_SettingsProfilesOverlaysProfileDelete, tstr_SettingsProfilesOverlaysProfileDeleteConfirm, tstr_SettingsProfilesOverlaysProfileFailedLoad, tstr_SettingsProfilesOverlaysProfileFailedDelete, tstr_SettingsProfilesOverlaysProfileAddSelectHeader, tstr_SettingsProfilesOverlaysProfileAddSelectEmpty, tstr_SettingsProfilesOverlaysProfileAddSelectDo, tstr_SettingsProfilesOverlaysProfileAddSelectAll, tstr_SettingsProfilesOverlaysProfileAddSelectNone, tstr_SettingsProfilesOverlaysProfileSaveSelectHeader, tstr_SettingsProfilesOverlaysProfileSaveSelectName, tstr_SettingsProfilesOverlaysProfileSaveSelectNameErrorBlank, tstr_SettingsProfilesOverlaysProfileSaveSelectNameErrorTaken, tstr_SettingsProfilesOverlaysProfileSaveSelectHeaderList, tstr_SettingsProfilesOverlaysProfileSaveSelectDo, tstr_SettingsProfilesOverlaysProfileSaveSelectDoFailed, tstr_SettingsProfilesAppsHeader, tstr_SettingsProfilesAppsHeaderNoVRTip, tstr_SettingsProfilesAppsListEmpty, tstr_SettingsProfilesAppsProfileHeaderActive, tstr_SettingsProfilesAppsProfileEnabled, tstr_SettingsProfilesAppsProfileOverlayProfile, tstr_SettingsProfilesAppsProfileActionEnter, tstr_SettingsProfilesAppsProfileActionLeave, tstr_SettingsActionsManage, tstr_SettingsActionsManageButton, tstr_SettingsActionsButtonsOrderDefault, tstr_SettingsActionsButtonsOrderOverlayBar, tstr_SettingsActionsShowBindings, tstr_SettingsActionsActiveShortcuts, tstr_SettingsActionsActiveShortcutsTip, tstr_SettingsActionsActiveShortuctsHome, tstr_SettingsActionsActiveShortuctsBack, tstr_SettingsActionsGlobalShortcuts, tstr_SettingsActionsGlobalShortcutsTip, tstr_SettingsActionsGlobalShortcutsEntry, //%ID% == ID of shortcut, starts with 1 tstr_SettingsActionsGlobalShortcutsAdd, tstr_SettingsActionsGlobalShortcutsRemove, tstr_SettingsActionsHotkeys, tstr_SettingsActionsHotkeysTip, tstr_SettingsActionsHotkeysAdd, tstr_SettingsActionsHotkeysRemove, tstr_SettingsActionsTableHeaderAction, tstr_SettingsActionsTableHeaderShortcut, tstr_SettingsActionsTableHeaderHotkey, tstr_SettingsActionsManageHeader, tstr_SettingsActionsManageCopyUID, tstr_SettingsActionsManageNew, tstr_SettingsActionsManageEdit, tstr_SettingsActionsManageDuplicate, tstr_SettingsActionsManageDelete, tstr_SettingsActionsManageDeleteConfirm, tstr_SettingsActionsManageDuplicatedName, //%NAME% == Action name tstr_SettingsActionsEditHeader, tstr_SettingsActionsEditName, tstr_SettingsActionsEditNameTranslatedTip, tstr_SettingsActionsEditTarget, tstr_SettingsActionsEditTargetDefault, tstr_SettingsActionsEditTargetDefaultTip, tstr_SettingsActionsEditTargetUseTags, tstr_SettingsActionsEditTargetActionTarget, tstr_SettingsActionsEditHeaderAppearance, tstr_SettingsActionsEditIcon, tstr_SettingsActionsEditLabel, tstr_SettingsActionsEditLabelTranslatedTip, tstr_SettingsActionsEditHeaderCommands, tstr_SettingsActionsEditNameNew, tstr_SettingsActionsEditCommandAdd, tstr_SettingsActionsEditCommandDelete, tstr_SettingsActionsEditCommandDeleteConfirm, tstr_SettingsActionsEditCommandType, tstr_SettingsActionsEditCommandTypeNone, tstr_SettingsActionsEditCommandTypeKey, tstr_SettingsActionsEditCommandTypeMousePos, tstr_SettingsActionsEditCommandTypeString, tstr_SettingsActionsEditCommandTypeLaunchApp, tstr_SettingsActionsEditCommandTypeShowKeyboard, tstr_SettingsActionsEditCommandTypeCropActiveWindow, tstr_SettingsActionsEditCommandTypeShowOverlay, tstr_SettingsActionsEditCommandTypeSwitchTask, tstr_SettingsActionsEditCommandTypeLoadOverlayProfile, tstr_SettingsActionsEditCommandTypeUnknown, tstr_SettingsActionsEditCommandVisibilityToggle, tstr_SettingsActionsEditCommandVisibilityShow, tstr_SettingsActionsEditCommandVisibilityHide, tstr_SettingsActionsEditCommandUndo, tstr_SettingsActionsEditCommandKeyCode, tstr_SettingsActionsEditCommandKeyToggle, tstr_SettingsActionsEditCommandMouseX, tstr_SettingsActionsEditCommandMouseY, tstr_SettingsActionsEditCommandMouseUseCurrent, tstr_SettingsActionsEditCommandString, tstr_SettingsActionsEditCommandPath, tstr_SettingsActionsEditCommandPathTip, tstr_SettingsActionsEditCommandArgs, tstr_SettingsActionsEditCommandArgsTip, tstr_SettingsActionsEditCommandVisibility, tstr_SettingsActionsEditCommandSwitchingMethod, tstr_SettingsActionsEditCommandSwitchingMethodSwitcher, tstr_SettingsActionsEditCommandSwitchingMethodFocus, tstr_SettingsActionsEditCommandWindow, tstr_SettingsActionsEditCommandWindowNone, tstr_SettingsActionsEditCommandWindowStrictMatchingTip, tstr_SettingsActionsEditCommandCursorWarp, tstr_SettingsActionsEditCommandProfile, tstr_SettingsActionsEditCommandProfileClear, tstr_SettingsActionsEditCommandDescNone, tstr_SettingsActionsEditCommandDescKey, //%KEYNAME% == key name tstr_SettingsActionsEditCommandDescKeyToggle, //^ tstr_SettingsActionsEditCommandDescMousePos, //%X% & %Y% == position coordinates tstr_SettingsActionsEditCommandDescString, //%STRING% == command string tstr_SettingsActionsEditCommandDescLaunchApp, //%APP% == app path, %ARGSOPT% == tstr_SettingsActionsEditCommandDescLaunchAppArgsOpt or blank if app args are empty tstr_SettingsActionsEditCommandDescLaunchAppArgsOpt, //%ARGS% == app arguments tstr_SettingsActionsEditCommandDescKeyboardToggle, tstr_SettingsActionsEditCommandDescKeyboardShow, tstr_SettingsActionsEditCommandDescKeyboardHide, tstr_SettingsActionsEditCommandDescCropWindow, tstr_SettingsActionsEditCommandDescOverlayToggle, //%TAGS% == target tags tstr_SettingsActionsEditCommandDescOverlayShow, //^ tstr_SettingsActionsEditCommandDescOverlayHide, //^ tstr_SettingsActionsEditCommandDescOverlayTargetDefault, tstr_SettingsActionsEditCommandDescSwitchTask, tstr_SettingsActionsEditCommandDescSwitchTaskWindow, //%WINDOW% == window title string tstr_SettingsActionsEditCommandDescLoadOverlayProfile, //%PROFILE% == profile name string tstr_SettingsActionsEditCommandDescLoadOverlayProfileAdd, //^ tstr_SettingsActionsEditCommandDescUnknown, tstr_SettingsActionsOrderHeader, tstr_SettingsActionsOrderButtonLabel, //%COUNT% == Action count tstr_SettingsActionsOrderButtonLabelSingular, //^ tstr_SettingsActionsOrderNoActions, tstr_SettingsActionsOrderAdd, tstr_SettingsActionsOrderRemove, tstr_SettingsActionsAddSelectorHeader, tstr_SettingsActionsAddSelectorAdd, tstr_SettingsKeyboardLayout, tstr_SettingsKeyboardSize, tstr_SettingsKeyboardBehavior, tstr_SettingsKeyboardStickyMod, tstr_SettingsKeyboardKeyRepeat, tstr_SettingsKeyboardAutoShow, tstr_SettingsKeyboardAutoShowDesktopOnly, tstr_SettingsKeyboardAutoShowDesktop, tstr_SettingsKeyboardAutoShowDesktopTip, tstr_SettingsKeyboardAutoShowBrowser, tstr_SettingsKeyboardLayoutAuthor, //%AUTHOR% == Layout Author string tstr_SettingsKeyboardKeyClusters, tstr_SettingsKeyboardKeyClusterBase, tstr_SettingsKeyboardKeyClusterFunction, tstr_SettingsKeyboardKeyClusterNavigation, tstr_SettingsKeyboardKeyClusterNumpad, tstr_SettingsKeyboardKeyClusterExtra, tstr_SettingsKeyboardSwitchToEditor, tstr_SettingsMouseShowCursor, tstr_SettingsMouseShowCursorGCUnsupported, tstr_SettingsMouseShowCursorGCActiveWarning, tstr_SettingsMouseScrollSmooth, tstr_SettingsMouseSimulatePen, tstr_SettingsMouseSimulatePenUnsupported, tstr_SettingsMouseAllowLaserPointerOverride, tstr_SettingsMouseAllowLaserPointerOverrideTip, tstr_SettingsMouseDoubleClickAssist, tstr_SettingsMouseDoubleClickAssistTip, tstr_SettingsMouseDoubleClickAssistTipValueOff, tstr_SettingsMouseDoubleClickAssistTipValueAuto, tstr_SettingsMouseSmoothing, tstr_SettingsMouseSmoothingLevelNone, tstr_SettingsMouseSmoothingLevelVeryLow, tstr_SettingsMouseSmoothingLevelLow, tstr_SettingsMouseSmoothingLevelMedium, tstr_SettingsMouseSmoothingLevelHigh, tstr_SettingsMouseSmoothingLevelVeryHigh, tstr_SettingsLaserPointerTip, tstr_SettingsLaserPointerBlockInput, tstr_SettingsLaserPointerAutoToggleDistance, tstr_SettingsLaserPointerAutoToggleDistanceValueOff, tstr_SettingsLaserPointerHMDPointer, tstr_SettingsLaserPointerHMDPointerTableHeaderInputAction, tstr_SettingsLaserPointerHMDPointerTableHeaderBinding, tstr_SettingsLaserPointerHMDPointerTableBindingToggle, tstr_SettingsLaserPointerHMDPointerTableBindingLeft, tstr_SettingsLaserPointerHMDPointerTableBindingRight, tstr_SettingsLaserPointerHMDPointerTableBindingMiddle, tstr_SettingsLaserPointerHMDPointerTableBindingDrag, tstr_SettingsWindowOverlaysAutoFocus, tstr_SettingsWindowOverlaysKeepOnScreen, tstr_SettingsWindowOverlaysKeepOnScreenTip, tstr_SettingsWindowOverlaysAutoSizeOverlay, tstr_SettingsWindowOverlaysFocusSceneApp, tstr_SettingsWindowOverlaysFocusSceneAppDashboard, tstr_SettingsWindowOverlaysOnWindowDrag, tstr_SettingsWindowOverlaysOnWindowDragDoNothing, tstr_SettingsWindowOverlaysOnWindowDragBlock, tstr_SettingsWindowOverlaysOnWindowDragOverlay, tstr_SettingsWindowOverlaysOnCaptureLoss, tstr_SettingsWindowOverlaysOnCaptureLossTip, tstr_SettingsWindowOverlaysOnCaptureLossDoNothing, tstr_SettingsWindowOverlaysOnCaptureLossHide, tstr_SettingsWindowOverlaysOnCaptureLossRemove, tstr_SettingsBrowserMaxFrameRate, tstr_SettingsBrowserMaxFrameRateOverrideOff, tstr_SettingsBrowserContentBlocker, tstr_SettingsBrowserContentBlockerTip, tstr_SettingsBrowserContentBlockerListCount, //%LISTCOUNT% == List count tstr_SettingsBrowserContentBlockerListCountSingular, //^ tstr_SettingsPerformanceUpdateLimiter, tstr_SettingsPerformanceUpdateLimiterMode, tstr_SettingsPerformanceUpdateLimiterModeOff, tstr_SettingsPerformanceUpdateLimiterModeMS, tstr_SettingsPerformanceUpdateLimiterModeFPS, tstr_SettingsPerformanceUpdateLimiterModeOffOverride, tstr_SettingsPerformanceUpdateLimiterModeMSTip, tstr_SettingsPerformanceUpdateLimiterFPSValue, //%FPS% == FPS value tstr_SettingsPerformanceUpdateLimiterOverride, tstr_SettingsPerformanceUpdateLimiterOverrideTip, tstr_SettingsPerformanceUpdateLimiterModeOverride, tstr_SettingsPerformanceRapidUpdates, tstr_SettingsPerformanceRapidUpdatesTip, tstr_SettingsPerformanceSingleDesktopMirror, tstr_SettingsPerformanceSingleDesktopMirrorTip, tstr_SettingsPerformanceAlternativeCursorRendering, tstr_SettingsPerformanceAlternativeCursorRenderingTip, tstr_SettingsPerformanceUseHDR, tstr_SettingsPerformanceUseHDRTip, tstr_SettingsPerformanceShowFPS, tstr_SettingsWarningsHidden, tstr_SettingsWarningsReset, tstr_SettingsStartupAutoLaunch, tstr_SettingsStartupSteamDisable, tstr_SettingsStartupSteamDisableTip, tstr_SettingsTroubleshootingRestart, tstr_SettingsTroubleshootingRestartSteam, tstr_SettingsTroubleshootingRestartDesktop, tstr_SettingsTroubleshootingElevatedModeEnter, tstr_SettingsTroubleshootingElevatedModeLeave, tstr_SettingsTroubleshootingSettingsReset, tstr_SettingsTroubleshootingSettingsResetConfirmDescription, tstr_SettingsTroubleshootingSettingsResetConfirmButton, tstr_SettingsTroubleshootingSettingsResetConfirmElementOverlays, tstr_SettingsTroubleshootingSettingsResetConfirmElementLegacyFiles, tstr_SettingsTroubleshootingSettingsResetShowQuickStart, tstr_KeyboardWindowTitle, tstr_KeyboardWindowTitleSettings, tstr_KeyboardWindowTitleOverlay, //%OVERLAYNAME% == input target overlay name tstr_KeyboardWindowTitleOverlayUnknown, tstr_KeyboardShortcutsCut, tstr_KeyboardShortcutsCopy, tstr_KeyboardShortcutsPaste, tstr_OvrlPropsCatPosition, tstr_OvrlPropsCatAppearance, tstr_OvrlPropsCatCapture, tstr_OvrlPropsCatPerformanceMonitor, tstr_OvrlPropsCatBrowser, tstr_OvrlPropsCatAdvanced, tstr_OvrlPropsCatPerformance, tstr_OvrlPropsCatInterface, tstr_OvrlPropsPositionOrigin, tstr_OvrlPropsPositionOriginRoom, tstr_OvrlPropsPositionOriginHMDXY, tstr_OvrlPropsPositionOriginSeatedSpace, tstr_OvrlPropsPositionOriginDashboard, tstr_OvrlPropsPositionOriginHMD, tstr_OvrlPropsPositionOriginControllerL, tstr_OvrlPropsPositionOriginControllerR, tstr_OvrlPropsPositionOriginTracker1, tstr_OvrlPropsPositionOriginTheaterScreen, tstr_OvrlPropsPositionOriginConfigHMDXYTurning, tstr_OvrlPropsPositionOriginConfigTheaterScreenEnter, tstr_OvrlPropsPositionOriginConfigTheaterScreenLeave, tstr_OvrlPropsPositionOriginConfigSmoothing, tstr_OvrlPropsPositionOriginTheaterScreenTip, tstr_OvrlPropsPositionDispMode, tstr_OvrlPropsPositionDispModeAlways, tstr_OvrlPropsPositionDispModeDashboard, tstr_OvrlPropsPositionDispModeScene, tstr_OvrlPropsPositionDispModeDPlus, tstr_OvrlPropsPositionPos, tstr_OvrlPropsPositionPosTip, tstr_OvrlPropsPositionChange, tstr_OvrlPropsPositionReset, tstr_OvrlPropsPositionLock, tstr_OvrlPropsPositionChangeHeader, tstr_OvrlPropsPositionChangeHelp, tstr_OvrlPropsPositionChangeHelpDesktop, tstr_OvrlPropsPositionChangeManualAdjustment, tstr_OvrlPropsPositionChangeMove, tstr_OvrlPropsPositionChangeRotate, tstr_OvrlPropsPositionChangeForward, tstr_OvrlPropsPositionChangeBackward, tstr_OvrlPropsPositionChangeRollCW, tstr_OvrlPropsPositionChangeRollCCW, tstr_OvrlPropsPositionChangeLookAt, tstr_OvrlPropsPositionChangeDragButton, tstr_OvrlPropsPositionChangeOffset, tstr_OvrlPropsPositionChangeOffsetUpDown, tstr_OvrlPropsPositionChangeOffsetRightLeft, tstr_OvrlPropsPositionChangeOffsetForwardBackward, tstr_OvrlPropsPositionChangeDragSettings, tstr_OvrlPropsPositionChangeDragSettingsAutoDocking, tstr_OvrlPropsPositionChangeDragSettingsForceDistance, tstr_OvrlPropsPositionChangeDragSettingsForceDistanceShape, tstr_OvrlPropsPositionChangeDragSettingsForceDistanceShapeSphere, tstr_OvrlPropsPositionChangeDragSettingsForceDistanceShapeCylinder, tstr_OvrlPropsPositionChangeDragSettingsForceDistanceAutoCurve, tstr_OvrlPropsPositionChangeDragSettingsForceDistanceAutoTilt, tstr_OvrlPropsPositionChangeDragSettingsSnapPosition, tstr_OvrlPropsPositionChangeDragSettingsSnapRotation, tstr_OvrlPropsPositionChangeDragSettingsSnapRotationPitch, tstr_OvrlPropsPositionChangeDragSettingsSnapRotationYaw, tstr_OvrlPropsPositionChangeDragSettingsSnapRotationRoll, tstr_OvrlPropsAppearanceWidth, tstr_OvrlPropsAppearanceCurve, tstr_OvrlPropsAppearanceOpacity, tstr_OvrlPropsAppearanceBrightness, tstr_OvrlPropsAppearanceCrop, tstr_OvrlPropsAppearanceCropValueMax, tstr_OvrlPropsAppearanceShowBackside, tstr_OvrlPropsCrop, tstr_OvrlPropsCropHelp, tstr_OvrlPropsCropManualAdjust, tstr_OvrlPropsCropInvalidTip, tstr_OvrlPropsCropX, tstr_OvrlPropsCropY, tstr_OvrlPropsCropWidth, tstr_OvrlPropsCropHeight, tstr_OvrlPropsCropToWindow, tstr_OvrlPropsCaptureMethod, tstr_OvrlPropsCaptureMethodDup, tstr_OvrlPropsCaptureMethodGC, tstr_OvrlPropsCaptureMethodGCUnsupportedTip, tstr_OvrlPropsCaptureMethodGCUnsupportedPartialTip, tstr_OvrlPropsCaptureSource, tstr_OvrlPropsCaptureGCSource, tstr_OvrlPropsCaptureSourceUnknownWarning, tstr_OvrlPropsCaptureGCStrictMatching, tstr_OvrlPropsCaptureGCStrictMatchingTip, tstr_OvrlPropsPerfMonDesktopModeTip, tstr_OvrlPropsPerfMonGlobalTip, tstr_OvrlPropsPerfMonStyle, tstr_OvrlPropsPerfMonItems, tstr_OvrlPropsPerfMonStyleMinimal, tstr_OvrlPropsPerfMonStyleCompact, tstr_OvrlPropsPerfMonStyleLarge, tstr_OvrlPropsPerfMonStyleShowWindow, tstr_OvrlPropsPerfMonStyleShowTextOutline, tstr_OvrlPropsPerfMonStyleMinimalShowMore, tstr_OvrlPropsPerfMonItemCPU, tstr_OvrlPropsPerfMonItemGPU, tstr_OvrlPropsPerfMonItemGraphs, tstr_OvrlPropsPerfMonItemFrameStats, tstr_OvrlPropsPerfMonItemTime, tstr_OvrlPropsPerfMonItemBattery, tstr_OvrlPropsPerfMonItemTrackerBattery, tstr_OvrlPropsPerfMonItemViveWirelessTemp, tstr_OvrlPropsPerfMonResetValues, tstr_OvrlPropsBrowserNotAvailableTip, tstr_OvrlPropsBrowserCloned, tstr_OvrlPropsBrowserClonedTip, //%OVERLAYNAME% == duplication source overlay name tstr_OvrlPropsBrowserClonedConvert, tstr_OvrlPropsBrowserURL, tstr_OvrlPropsBrowserURLHint, tstr_OvrlPropsBrowserGo, tstr_OvrlPropsBrowserRestore, tstr_OvrlPropsBrowserWidth, tstr_OvrlPropsBrowserHeight, tstr_OvrlPropsBrowserZoom, tstr_OvrlPropsBrowserAllowTransparency, tstr_OvrlPropsBrowserAllowTransparencyTip, tstr_OvrlPropsBrowserRecreateContext, tstr_OvrlPropsBrowserRecreateContextTip, tstr_OvrlPropsAdvanced3D, tstr_OvrlPropsAdvancedHSBS, tstr_OvrlPropsAdvancedSBS, tstr_OvrlPropsAdvancedHOU, tstr_OvrlPropsAdvancedOU, tstr_OvrlPropsAdvanced3DSwap, tstr_OvrlPropsAdvancedGazeFade, tstr_OvrlPropsAdvancedGazeFadeAuto, tstr_OvrlPropsAdvancedGazeFadeDistance, tstr_OvrlPropsAdvancedGazeFadeDistanceValueInf, tstr_OvrlPropsAdvancedGazeFadeSensitivity, tstr_OvrlPropsAdvancedGazeFadeOpacity, tstr_OvrlPropsAdvancedInput, tstr_OvrlPropsAdvancedInputInGame, tstr_OvrlPropsAdvancedInputFloatingUI, tstr_OvrlPropsAdvancedOverlayTags, tstr_OvrlPropsAdvancedOverlayTagsTip, tstr_OvrlPropsPerformanceInvisibleUpdate, tstr_OvrlPropsPerformanceInvisibleUpdateTip, tstr_OvrlPropsInterfaceOverlayName, tstr_OvrlPropsInterfaceOverlayNameAuto, tstr_OvrlPropsInterfaceActionOrderCustom, tstr_OvrlPropsInterfaceDesktopButtons, tstr_OvrlPropsInterfaceExtraButtons, tstr_OverlayBarOvrlHide, tstr_OverlayBarOvrlShow, tstr_OverlayBarOvrlClone, tstr_OverlayBarOvrlRemove, tstr_OverlayBarOvrlRemoveConfirm, tstr_OverlayBarOvrlProperties, tstr_OverlayBarOvrlAddWindow, tstr_OverlayBarTooltipOvrlAdd, tstr_OverlayBarTooltipSettings, tstr_OverlayBarTooltipResetHold, tstr_FloatingUIHideOverlayTip, tstr_FloatingUIHideOverlayHoldTip, tstr_FloatingUIDragModeEnableTip, tstr_FloatingUIDragModeDisableTip, tstr_FloatingUIDragModeHoldLockTip, tstr_FloatingUIDragModeHoldUnlockTip, tstr_FloatingUIWindowAddTip, tstr_FloatingUIActionBarShowTip, tstr_FloatingUIActionBarHideTip, tstr_FloatingUIBrowserGoBackTip, tstr_FloatingUIBrowserGoForwardTip, tstr_FloatingUIBrowserRefreshTip, tstr_FloatingUIBrowserStopTip, tstr_FloatingUIActionBarDesktopPrev, tstr_FloatingUIActionBarDesktopNext, tstr_FloatingUIActionBarEmpty, tstr_ActionNone, tstr_ActionKeyboardShow, tstr_ActionKeyboardHide, tstr_DefActionShowKeyboard, tstr_DefActionActiveWindowCrop, tstr_DefActionActiveWindowCropLabel, tstr_DefActionSwitchTask, tstr_DefActionToggleOverlays, tstr_DefActionToggleOverlaysLabel, tstr_DefActionMiddleMouse, tstr_DefActionMiddleMouseLabel, tstr_DefActionBackMouse, tstr_DefActionBackMouseLabel, tstr_DefActionReadMe, tstr_DefActionReadMeLabel, tstr_DefActionDashboardToggle, tstr_DefActionDashboardToggleLabel, tstr_PerformanceMonitorCPU, tstr_PerformanceMonitorGPU, tstr_PerformanceMonitorRAM, tstr_PerformanceMonitorVRAM, tstr_PerformanceMonitorFrameTime, tstr_PerformanceMonitorLoad, tstr_PerformanceMonitorFPS, tstr_PerformanceMonitorFPSAverage, tstr_PerformanceMonitorReprojectionRatio, tstr_PerformanceMonitorDroppedFrames, tstr_PerformanceMonitorBatteryLeft, tstr_PerformanceMonitorBatteryRight, tstr_PerformanceMonitorBatteryHMD, tstr_PerformanceMonitorBatteryTracker, tstr_PerformanceMonitorBatteryDisconnected, tstr_PerformanceMonitorViveWirelessTempNotAvailable, tstr_PerformanceMonitorCompactCPU, tstr_PerformanceMonitorCompactGPU, tstr_PerformanceMonitorCompactFPS, tstr_PerformanceMonitorCompactFPSAverage, tstr_PerformanceMonitorCompactReprojectionRatio, tstr_PerformanceMonitorCompactDroppedFrames, tstr_PerformanceMonitorCompactBattery, tstr_PerformanceMonitorCompactBatteryLeft, tstr_PerformanceMonitorCompactBatteryRight, tstr_PerformanceMonitorCompactBatteryHMD, tstr_PerformanceMonitorCompactBatteryTracker, tstr_PerformanceMonitorCompactBatteryDisconnected, tstr_PerformanceMonitorCompactViveWirelessTempNotAvailable, tstr_PerformanceMonitorEmpty, tstr_AuxUIDragHintDocking, tstr_AuxUIDragHintUndocking, tstr_AuxUIDragHintOvrlLocked, tstr_AuxUIDragHintOvrlTheaterScreenBlocked, tstr_AuxUIGazeFadeAutoHint, //%SECONDS% == Countdown seconds tstr_AuxUIGazeFadeAutoHintSingular, //^ tstr_AuxUIQuickStartWelcomeHeader, tstr_AuxUIQuickStartWelcomeBody, tstr_AuxUIQuickStartOverlaysHeader, tstr_AuxUIQuickStartOverlaysBody, tstr_AuxUIQuickStartOverlaysBody2, tstr_AuxUIQuickStartOverlayPropertiesHeader, tstr_AuxUIQuickStartOverlayPropertiesBody, tstr_AuxUIQuickStartOverlayPropertiesBody2, tstr_AuxUIQuickStartSettingsHeader, tstr_AuxUIQuickStartSettingsBody, tstr_AuxUIQuickStartProfilesHeader, tstr_AuxUIQuickStartProfilesBody, tstr_AuxUIQuickStartActionsHeader, tstr_AuxUIQuickStartActionsBody, tstr_AuxUIQuickStartActionsBody2, tstr_AuxUIQuickStartOverlayTagsHeader, tstr_AuxUIQuickStartOverlayTagsBody, tstr_AuxUIQuickStartSettingsEndBody, tstr_AuxUIQuickStartFloatingUIHeader, tstr_AuxUIQuickStartFloatingUIBody, tstr_AuxUIQuickStartDesktopModeHeader, tstr_AuxUIQuickStartDesktopModeBody, tstr_AuxUIQuickStartEndHeader, tstr_AuxUIQuickStartEndBody, tstr_AuxUIQuickStartButtonNext, tstr_AuxUIQuickStartButtonPrev, tstr_AuxUIQuickStartButtonClose, tstr_DesktopModeCatTools, tstr_DesktopModeCatOverlays, tstr_DesktopModeToolSettings, tstr_DesktopModeToolActions, tstr_DesktopModeOverlayListAdd, tstr_DesktopModePageAddWindowOverlayTitle, tstr_DesktopModePageAddWindowOverlayHeader, tstr_KeyboardEditorKeyListTitle, tstr_KeyboardEditorKeyListTabContextReplace, tstr_KeyboardEditorKeyListTabContextClear, tstr_KeyboardEditorKeyListRow, //%ID% == Row ID tstr_KeyboardEditorKeyListSpacing, tstr_KeyboardEditorKeyListKeyAdd, tstr_KeyboardEditorKeyListKeyDuplicate, tstr_KeyboardEditorKeyListKeyRemove, tstr_KeyboardEditorKeyPropertiesTitle, tstr_KeyboardEditorKeyPropertiesNoSelection, tstr_KeyboardEditorKeyPropertiesType, tstr_KeyboardEditorKeyPropertiesTypeBlank, tstr_KeyboardEditorKeyPropertiesTypeVirtualKey, tstr_KeyboardEditorKeyPropertiesTypeVirtualKeyToggle, tstr_KeyboardEditorKeyPropertiesTypeVirtualKeyIsoEnter, tstr_KeyboardEditorKeyPropertiesTypeString, tstr_KeyboardEditorKeyPropertiesTypeSublayoutToggle, tstr_KeyboardEditorKeyPropertiesTypeAction, tstr_KeyboardEditorKeyPropertiesTypeVirtualKeyIsoEnterTip, tstr_KeyboardEditorKeyPropertiesTypeStringTip, tstr_KeyboardEditorKeyPropertiesSize, tstr_KeyboardEditorKeyPropertiesLabel, tstr_KeyboardEditorKeyPropertiesKeyCode, tstr_KeyboardEditorKeyPropertiesString, tstr_KeyboardEditorKeyPropertiesSublayout, tstr_KeyboardEditorKeyPropertiesAction, tstr_KeyboardEditorKeyPropertiesCluster, tstr_KeyboardEditorKeyPropertiesClusterTip, tstr_KeyboardEditorKeyPropertiesBlockModifiers, tstr_KeyboardEditorKeyPropertiesBlockModifiersTip, tstr_KeyboardEditorKeyPropertiesNoRepeat, tstr_KeyboardEditorKeyPropertiesNoRepeatTip, tstr_KeyboardEditorMetadataTitle, tstr_KeyboardEditorMetadataName, tstr_KeyboardEditorMetadataAuthor, tstr_KeyboardEditorMetadataHasAltGr, tstr_KeyboardEditorMetadataHasAltGrTip, tstr_KeyboardEditorMetadataClusterPreview, tstr_KeyboardEditorMetadataSave, tstr_KeyboardEditorMetadataLoad, tstr_KeyboardEditorMetadataSavePopupTitle, tstr_KeyboardEditorMetadataSavePopupFilename, tstr_KeyboardEditorMetadataSavePopupFilenameBlankTip, tstr_KeyboardEditorMetadataSavePopupConfirm, tstr_KeyboardEditorMetadataSavePopupConfirmError, tstr_KeyboardEditorMetadataLoadPopupTitle, tstr_KeyboardEditorMetadataLoadPopupConfirm, tstr_KeyboardEditorPreviewTitle, tstr_KeyboardEditorSublayoutBase, tstr_KeyboardEditorSublayoutShift, tstr_KeyboardEditorSublayoutAltGr, tstr_KeyboardEditorSublayoutAux, tstr_DialogOk, tstr_DialogCancel, tstr_DialogDone, tstr_DialogUndo, tstr_DialogRedo, tstr_DialogColorPickerHeader, tstr_DialogColorPickerCurrent, tstr_DialogColorPickerOriginal, tstr_DialogProfilePickerHeader, tstr_DialogProfilePickerNone, tstr_DialogActionPickerHeader, tstr_DialogActionPickerEmpty, tstr_DialogIconPickerHeader, tstr_DialogIconPickerHeaderTip, tstr_DialogIconPickerNone, tstr_DialogKeyCodePickerHeader, tstr_DialogKeyCodePickerHeaderHotkey, tstr_DialogKeyCodePickerModifiers, tstr_DialogKeyCodePickerKeyCode, tstr_DialogKeyCodePickerKeyCodeHint, tstr_DialogKeyCodePickerKeyCodeNone, tstr_DialogKeyCodePickerFromInput, tstr_DialogKeyCodePickerFromInputPopup, tstr_DialogKeyCodePickerFromInputPopupNoMouse, tstr_DialogWindowPickerHeader, tstr_DialogInputTagsHint, tstr_SourceDesktopAll, tstr_SourceDesktopID, //%ID% == Desktop ID tstr_SourceWinRTNone, tstr_SourceWinRTUnknown, tstr_SourceWinRTClosed, tstr_SourcePerformanceMonitor, tstr_SourceBrowser, tstr_SourceBrowserNoPage, tstr_NotificationIconRestoreVR, tstr_NotificationIconOpenOnDesktop, tstr_NotificationIconQuit, tstr_NotificationInitialStartupTitleVR, tstr_NotificationInitialStartupTitleDesktop, tstr_NotificationInitialStartupMessage, tstr_BrowserErrorPageTitle, tstr_BrowserErrorPageHeading, tstr_BrowserErrorPageMessage, tstr_MAX, tstr_NONE = tstr_MAX //Don't pass this into GetString() }; class TranslationManager { public: struct ListEntry { std::string FileName; std::string ListName; }; private: static const char* s_StringIDNames[tstr_MAX]; std::string m_Strings[tstr_MAX]; //Precomputed strings, updated after loading different translations std::vector m_StringsDesktopID; std::vector m_StringsFPSLimit; std::string m_CurrentTranslationName; std::string m_CurrentTranslationAuthor; std::string m_CurrentTranslationFontName; bool m_IsCurrentTranslationComplete; public: TranslationManager(); static TranslationManager& Get(); static const char* GetString(TRMGRStrID str_id); //Strings are not sanitized in any way, so probably a bad idea to feed straight into ImGui functions calling printf static TRMGRStrID GetStringID(const char* str); //May return tstr_NONE static std::string GetTranslationNameFromFile(const std::string& filename); static std::vector GetTranslationList(); void LoadTranslationFromFile(const std::string& filename); const std::string& GetCurrentTranslationName() const; const std::string& GetCurrentTranslationAuthor() const; const std::string& GetCurrentTranslationFontName() const; bool IsCurrentTranslationComplete() const; void AddStringsToFontBuilder(ImFontGlyphRangesBuilder& builder) const; const char* GetDesktopIDString(int desktop_id); const char* GetFPSLimitString(int fps_limit_id); }; ================================================ FILE: src/DesktopPlusUI/UIManager.cpp ================================================ #include "UIManager.h" #include #include "imgui.h" #include "imgui_impl_win32_openvr.h" #include "implot.h" #include "resource.h" #include "InterprocessMessaging.h" #include "ConfigManager.h" #include "OverlayManager.h" #include "Util.h" #include "OpenVRExt.h" #include "WindowManager.h" #include "DesktopPlusWinRT.h" #include "DPBrowserAPIClient.h" //This one holds mostly constant data, but depends on how the application was launched static UITextureSpaces g_UITextureSpaces; UITextureSpaces& UITextureSpaces::Get() { return g_UITextureSpaces; } void UITextureSpaces::Init(bool desktop_mode, bool keyboard_editor_mode) { if (!desktop_mode) { const int vertical_spacing = 2; m_TexspaceRects[ui_texspace_total] = {0, 0, 1920, -1}; m_TexspaceRects[ui_texspace_overlay_bar] = {0, 0, m_TexspaceRects[ui_texspace_total].GetWidth(), 420}; m_TexspaceRects[ui_texspace_floating_ui] = {0, m_TexspaceRects[ui_texspace_overlay_bar].GetBR().y + vertical_spacing, m_TexspaceRects[ui_texspace_total].GetWidth(), m_TexspaceRects[ui_texspace_overlay_bar].GetBR().y + vertical_spacing + 320}; m_TexspaceRects[ui_texspace_overlay_properties] = {0, m_TexspaceRects[ui_texspace_floating_ui].GetBR().y + vertical_spacing, 959, m_TexspaceRects[ui_texspace_floating_ui].GetBR().y + vertical_spacing + 800}; m_TexspaceRects[ui_texspace_settings] = {m_TexspaceRects[ui_texspace_total].GetWidth() - m_TexspaceRects[ui_texspace_overlay_properties].GetWidth(), m_TexspaceRects[ui_texspace_overlay_properties].GetTL().y, m_TexspaceRects[ui_texspace_total].GetWidth(), m_TexspaceRects[ui_texspace_overlay_properties].GetBR().y}; m_TexspaceRects[ui_texspace_keyboard] = {0, m_TexspaceRects[ui_texspace_overlay_properties].GetBR().y + vertical_spacing, m_TexspaceRects[ui_texspace_total].GetWidth(), m_TexspaceRects[ui_texspace_overlay_properties].GetBR().y + vertical_spacing + 750}; m_TexspaceRects[ui_texspace_performance_monitor] = {0, m_TexspaceRects[ui_texspace_keyboard].GetBR().y + vertical_spacing, 850, m_TexspaceRects[ui_texspace_keyboard].GetBR().y + vertical_spacing + 550}; m_TexspaceRects[ui_texspace_aux_ui] = {m_TexspaceRects[ui_texspace_performance_monitor].GetWidth() + vertical_spacing, m_TexspaceRects[ui_texspace_keyboard].GetBR().y + vertical_spacing, m_TexspaceRects[ui_texspace_total].GetWidth(), m_TexspaceRects[ui_texspace_keyboard].GetBR().y + vertical_spacing + 550}; //Set total height last m_TexspaceRects[ui_texspace_total].Max.y = m_TexspaceRects[ui_texspace_performance_monitor].GetBR().y; } else { //Desktop mode only initializes total texture space (as the unscaled window size) and windows used in it if (keyboard_editor_mode) { m_TexspaceRects[ui_texspace_total] = {0, 0, 2100, 1152}; //Results in 1312x720px at 100% DPI scaling } else { m_TexspaceRects[ui_texspace_total] = {0, 0, 1153, 1042}; //Results in 720x651px at 100% DPI scaling } m_TexspaceRects[ui_texspace_overlay_properties] = m_TexspaceRects[ui_texspace_total]; m_TexspaceRects[ui_texspace_settings] = m_TexspaceRects[ui_texspace_total]; m_TexspaceRects[ui_texspace_performance_monitor] = m_TexspaceRects[ui_texspace_total]; m_TexspaceRects[ui_texspace_keyboard] = {0, 0, m_TexspaceRects[ui_texspace_total].GetWidth(), 750}; } } const DPRect& UITextureSpaces::GetRect(UITexspaceID texspace_id) const { return m_TexspaceRects[texspace_id]; } ImVec4 UITextureSpaces::GetRectAsVec4(UITexspaceID texspace_id) const { const DPRect& rect = UITextureSpaces::Get().GetRect(texspace_id); return ImVec4((float)rect.Min.x, (float)rect.Min.y, (float)rect.Max.x, (float)rect.Max.y); } //While this is a singleton like many other classes, we want to be careful about initializing it at global scope, so we leave that until a bit later in main() UIManager* g_UIManagerPtr = nullptr; UIManager::IdleState::IdleState() { ::QueryPerformanceFrequency(&m_TimestepTicks); ::QueryPerformanceCounter(&m_TimestepTime); } void UIManager::IdleState::SetLastActiveTick(ULONGLONG value) { //Some functions set this into the future, so prevent it being overwritten in those cases if (value > m_LastActiveTick) { m_LastActiveTick = value; } } bool UIManager::IdleState::ShouldIdle() { if (::IsIconic(UIManager::Get()->GetWindowHandle())) { m_WasIdleLastFrame = true; return true; } UIManager& ui_manager = *UIManager::Get(); //Temporary setting to disable throttling in case it causes issues somewhere, matches old basic idle logic if (!ConfigManager::GetValue(configid_bool_performance_ui_auto_throttle)) { SetLastActiveTick(::GetTickCount64()); if (!ui_manager.IsInDesktopMode()) { const bool do_idle = ( (!ui_manager.IsOverlayBarOverlayVisible()) && (!ui_manager.GetFloatingUI().IsVisible()) && (!ui_manager.GetSettingsWindow().IsVisibleOrFading()) && (!ui_manager.GetOverlayPropertiesWindow().IsVisibleOrFading()) && (!ui_manager.GetPerformanceWindow().IsVisible()) && (!ui_manager.GetVRKeyboard().GetWindow().IsVisibleOrFading()) && (!ui_manager.GetAuxUI().IsActive()) ); return do_idle; } return false; } //Performance Monitor needs constant updates, but it'll be throttled in GetFrameSkipValue() if possible if (ui_manager.GetPerformanceWindow().IsVisible()) { return false; } //Quick-Start Guide needs updates for its automatic timeout to work if (ui_manager.GetAuxUI().GetQuickStartWindow().IsVisible()) { return false; } //If any text input is active, we need to deal with the blinking caret so we wake up occasionally for it to animate if (ImGui::IsAnyInputTextActive()) { if (m_LastCaretTick + 100 < ::GetTickCount64()) { m_LastCaretTick = ::GetTickCount64(); m_WasIdleLastFrame = false; //Explicitly avoid doing the idle timestep when only waking up for a single frame as the caret blinking relies on it advancing in real time return false; } } if (ImGui::IsAnyMouseDown()) { return false; } if (m_LastActiveTick + s_MsBeforeIdle < ::GetTickCount64()) { m_WasIdleLastFrame = true; return true; } return false; } int UIManager::IdleState::GetFrameSkipValue() { //If outside of active time, throttle to 1 frameskip or just use user frameskip value if it's higher //This mainly causes Performance Monitor to animated at half rate. Other animating things are supposed to add active time return std::max((m_LastActiveTick + s_MsBeforeIdle < ::GetTickCount64()) ? 1 : 0, ConfigManager::GetValue(configid_int_performance_ui_frameskip)); } void UIManager::IdleState::OnImGuiNewFrame() { //After idling we'll have a large delta time set by ImGui, so we run our own timestep once more to correct it for that one frame if (m_WasIdleLastFrame) { DoIdleTimestep(); } m_WasIdleLastFrame = false; } void UIManager::IdleState::OnWindowMessage(UINT message_id) { if ( ((message_id >= WM_MOUSEFIRST) && (message_id <= WM_MOUSELAST)) || ((message_id >= WM_KEYFIRST) && (message_id <= WM_KEYLAST)) || (message_id == WM_SYSCOMMAND) ) { //We may get periodic mouse move messages with no cursor moving, ignore those if (message_id == WM_MOUSEMOVE) { POINT pt; GetCursorPos(&pt); if ((pt.x == m_LastCursorPos.x) && (pt.y == m_LastCursorPos.y)) { return; } m_LastCursorPos = pt; } SetLastActiveTick(::GetTickCount64()); } } void UIManager::IdleState::OnOpenVREvent(uint32_t event_type) { if ( ((event_type >= vr::VREvent_MouseMove) && (event_type <= vr::VREvent_UnlockMousePosition)) || ((event_type >= vr::VREvent_OverlayShown) && (event_type <= vr::VREvent_SwitchGamepadFocus)) ) { SetLastActiveTick(::GetTickCount64()); } } void UIManager::IdleState::AddActiveTime(unsigned int ms) { SetLastActiveTick(::GetTickCount64() + ms - s_MsBeforeIdle); } void UIManager::IdleState::DoIdleTimestep() { LARGE_INTEGER current_time{0}; ::QueryPerformanceCounter(¤t_time); ImGui::GetIO().DeltaTime = (float)(current_time.QuadPart - m_TimestepTime.QuadPart) / m_TimestepTicks.QuadPart; m_TimestepTime = current_time; } UIManager::UIManager(bool desktop_mode, bool keyboard_editor_mode) : m_WindowHandle(nullptr), m_SharedTextureRef(nullptr), m_RepeatFrame(false), m_DesktopMode(desktop_mode), m_KeyboardEditorMode(keyboard_editor_mode), m_OpenVRLoaded(false), m_NoRestartOnExit(false), m_UIScale(1.0f), m_FontCompact(nullptr), m_FontLarge(nullptr), m_LowCompositorRes(false), m_LowCompositorQuality(false), m_HasAnyWarning(false), m_OverlayErrorLast(vr::VROverlayError_None), m_WinRTErrorLast(S_OK), m_ElevatedTaskSetUp(false), m_ComInitDone(false), m_OvrlHandleOverlayBar(vr::k_ulOverlayHandleInvalid), m_OvrlHandleFloatingUI(vr::k_ulOverlayHandleInvalid), m_OvrlHandleSettings(vr::k_ulOverlayHandleInvalid), m_OvrlHandleOverlayProperties(vr::k_ulOverlayHandleInvalid), m_OvrlHandleKeyboard(vr::k_ulOverlayHandleInvalid), m_OvrlHandleAuxUI(vr::k_ulOverlayHandleInvalid), m_OvrlHandleDPlusDashboard(vr::k_ulOverlayHandleInvalid), m_OvrlHandleSystemUI(vr::k_ulOverlayHandleInvalid), m_IsSystemUIHoveredFromSwitch(false), m_IsDummyOverlayTransformUnstable(false), m_OvrlVisible(false), m_OvrlOverlayBarAlpha(0.0f), m_SystemUIActiveTick(0), m_OverlayBarFadeInTick(0), m_OvrlPixelWidth(1), m_OvrlPixelHeight(1), m_TransformSyncValueCount(0), m_TransformSyncValues{0} { g_UIManagerPtr = this; //Activate WindowManager WindowManager::Get().SetActive(true); //Check if the scheduled task is set up STARTUPINFO si = {0}; PROCESS_INFORMATION pi = {0}; si.cb = sizeof(si); WCHAR cmd[] = L"\"schtasks\" /Query /TN \"DesktopPlus Elevated\""; if (::CreateProcess(nullptr, cmd, nullptr, nullptr, FALSE, CREATE_NO_WINDOW, nullptr, nullptr, &si, &pi)) { //Wait for it to exit, which should be pretty much instant ::WaitForSingleObject(pi.hProcess, INFINITE); //Get the exit code. It should be 0 on success DWORD exit_code; ::GetExitCodeProcess(pi.hProcess, &exit_code); m_ElevatedTaskSetUp = (exit_code == 0); } ::CloseHandle(pi.hProcess); ::CloseHandle(pi.hThread); } UIManager::~UIManager() { g_UIManagerPtr = nullptr; } void UIManager::DisplayDashboardAppError(const std::string& str) //Ideally this is never called { //Hide UI overlay vr::VROverlay()->HideOverlay(m_OvrlHandleOverlayBar); m_OvrlVisible = false; //Hide all dashboard app overlays as well. Usually the dashboard app closes, but it may sometimes get stuck which could put its overlays in the way of the message overlay. for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { vr::VROverlayHandle_t ovrl_handle = OverlayManager::Get().GetConfigData(i).ConfigHandle[configid_handle_overlay_state_overlay_handle];; if (ovrl_handle != vr::k_ulOverlayHandleInvalid) { vr::VROverlay()->HideOverlay(ovrl_handle); } } vr::VRMessageOverlayResponse res = vr::VROverlay()->ShowMessageOverlay(str.c_str(), "Desktop+ Error", "Ok", "Restart Desktop+"); if (res == vr::VRMessageOverlayResponse_ButtonPress_1) { RestartDashboardApp(); } //Dashboard will be closed after dismissing the message overlay, so open it back up with Desktop+ vr::VROverlay()->ShowDashboard("elvissteinjr.DesktopPlusDashboard"); } void UIManager::DisplayInitialSetupNotification() { //Check if the user is currently using the HMD and display the initial setup message as a VR notification instead then bool use_vr_notification = false; vr::EDeviceActivityLevel activity_level = vr::VRSystem()->GetTrackedDeviceActivityLevel(vr::k_unTrackedDeviceIndex_Hmd); if ((activity_level == vr::k_EDeviceActivityLevel_UserInteraction) || (activity_level == vr::k_EDeviceActivityLevel_UserInteraction_Timeout)) { //Also check if the HMD is tracking properly right now so the notification can actually be seen (fresh SteamVR start is active but not tracking for example) vr::TrackedDevicePose_t poses[vr::k_unTrackedDeviceIndex_Hmd + 1]; vr::VRSystem()->GetDeviceToAbsoluteTrackingPose(vr::TrackingUniverseStanding, vr::IVRSystemEx::GetTimeNowToPhotons(), poses, vr::k_unTrackedDeviceIndex_Hmd + 1); use_vr_notification = (poses[vr::k_unTrackedDeviceIndex_Hmd].eTrackingResult == vr::TrackingResult_Running_OK); } if (use_vr_notification) { vr::VRNotificationId notification_id = 0; //Unused, but documentation doesn't say if passing nullptr is allowed, so we pass this std::string message = TranslationManager::GetString(tstr_NotificationInitialStartupTitleVR); message += "\n"; message += TranslationManager::GetString(tstr_NotificationInitialStartupMessage); //Despite being sent after overlay creation, it may not be returned right away, so keep trying a bit for (int tries = 0; tries < 20; ++tries) { vr::VROverlay()->FindOverlay("elvissteinjr.DesktopPlusDashboard", &m_OvrlHandleDPlusDashboard); if (m_OvrlHandleDPlusDashboard != vr::k_ulOverlayHandleInvalid) { break; } ::Sleep(50); } vr::VRNotifications()->CreateNotification(m_OvrlHandleDPlusDashboard, 0, vr::EVRNotificationType_Transient, message.c_str(), vr::EVRNotificationStyle_Application, nullptr, ¬ification_id); } else { ::MessageBoxW(nullptr, WStringConvertFromUTF8(TranslationManager::GetString(tstr_NotificationInitialStartupMessage)).c_str(), WStringConvertFromUTF8(TranslationManager::GetString(tstr_NotificationInitialStartupTitleDesktop)).c_str(), MB_OK); } } void UIManager::SetOverlayInputEnabled(bool is_enabled) { vr::VROverlayInputMethod input_method = (is_enabled) ? vr::VROverlayInputMethod_Mouse : vr::VROverlayInputMethod_None; vr::VROverlay()->SetOverlayInputMethod(m_OvrlHandleOverlayBar, input_method); vr::VROverlay()->SetOverlayInputMethod(m_OvrlHandleFloatingUI, input_method); vr::VROverlay()->SetOverlayInputMethod(m_OvrlHandleSettings, input_method); vr::VROverlay()->SetOverlayInputMethod(m_OvrlHandleOverlayProperties, input_method); vr::VROverlay()->SetOverlayInputMethod(m_OvrlHandleKeyboard, input_method); vr::VROverlay()->SetOverlayInputMethod(m_OvrlHandleAuxUI, input_method); } UITexspaceID UIManager::GetTexspaceIDForOverlayHandle(vr::VROverlayHandle_t overlay_handle) const { UITexspaceID overlay_texspace = ui_texspace_total; if (overlay_handle == m_OvrlHandleOverlayBar) overlay_texspace = ui_texspace_overlay_bar; else if (overlay_handle == m_OvrlHandleFloatingUI) overlay_texspace = ui_texspace_floating_ui; else if (overlay_handle == m_OvrlHandleSettings) overlay_texspace = ui_texspace_settings; else if (overlay_handle == m_OvrlHandleOverlayProperties) overlay_texspace = ui_texspace_overlay_properties; else if (overlay_handle == m_OvrlHandleKeyboard) overlay_texspace = ui_texspace_keyboard; else if (overlay_handle == m_OvrlHandleAuxUI) overlay_texspace = ui_texspace_aux_ui; return overlay_texspace; } void UIManager::HandleOverlayProfileLoadMessage(LPARAM lparam) { IPCActionOverlayProfileLoadArg profile_load_arg = (IPCActionOverlayProfileLoadArg)LOWORD(lparam); int profile_overlay_id = GET_Y_LPARAM(lparam); const std::string& profile_name = ConfigManager::GetValue(configid_str_state_profile_name_load); if (profile_overlay_id == -2) { ConfigManager::Get().LoadOverlayProfileDefault(true); } else if (profile_load_arg == ipcactv_ovrl_profile_multi) { ConfigManager::Get().LoadMultiOverlayProfileFromFile(profile_name + ".ini", true); } else if (profile_load_arg == ipcactv_ovrl_profile_multi_add) { IM_ASSERT(profile_overlay_id != -1); //Exclusion is unhandled for now. Shouldn't be sent anyways ConfigManager::Get().LoadMultiOverlayProfileFromFile(profile_name + ".ini", false); } OnProfileLoaded(); } UIManager* UIManager::Get() { return g_UIManagerPtr; } vr::EVRInitError UIManager::InitOverlay() { vr::EVRInitError init_error; vr::IVRSystem* vr_ptr = vr::VR_Init(&init_error, vr::VRApplication_Overlay); if (init_error != vr::VRInitError_None) return init_error; if (!vr::VROverlay()) return vr::VRInitError_Init_InvalidInterface; vr::VRApplications()->IdentifyApplication(::GetCurrentProcessId(), g_AppKeyUIApp); vr::VROverlayError ovrl_error = vr::VROverlayError_None; if (!m_DesktopMode) //For desktop mode we only init OpenVR, but don't set up any overlays { //This loop gets rid of any other process hogging our overlay key. Though in normal situations another Desktop+UI process would've already be killed before this for (int tries = 0; tries < 10; ++tries) { ovrl_error = vr::VROverlay()->CreateOverlay("elvissteinjr.DesktopPlusUI", "Desktop+UI", &m_OvrlHandleOverlayBar); if (ovrl_error == vr::VROverlayError_KeyInUse) //If the key is already in use, kill the owning process (hopefully another instance of this app) { ovrl_error = vr::VROverlay()->FindOverlay("elvissteinjr.DesktopPlusUI", &m_OvrlHandleOverlayBar); if ((ovrl_error == vr::VROverlayError_None) && (m_OvrlHandleOverlayBar != vr::k_ulOverlayHandleInvalid)) { LOG_F(INFO, "Overlay key already in use, killing owning process..."); uint32_t pid = vr::VROverlay()->GetOverlayRenderingPid(m_OvrlHandleOverlayBar); HANDLE phandle; phandle = ::OpenProcess(SYNCHRONIZE | PROCESS_TERMINATE, TRUE, pid); if (phandle != nullptr) { ::TerminateProcess(phandle, 0); ::CloseHandle(phandle); } else { ovrl_error = vr::VROverlayError_KeyInUse; } } else { ovrl_error = vr::VROverlayError_KeyInUse; } } else { break; } //Try again in a bit to check if it's just a race with some external cleanup ::Sleep(200); } if (m_OvrlHandleOverlayBar != vr::k_ulOverlayHandleInvalid) { vr::VROverlay()->SetOverlayWidthInMeters(m_OvrlHandleOverlayBar, OVERLAY_WIDTH_METERS_DASHBOARD_UI); //Init additional overlays vr::VROverlay()->CreateOverlay("elvissteinjr.DesktopPlusUIFloating", "Desktop+ Floating UI", &m_OvrlHandleFloatingUI); vr::VROverlay()->CreateOverlay("elvissteinjr.DesktopPlusUISettings", "Desktop+ Settings UI", &m_OvrlHandleSettings); vr::VROverlay()->CreateOverlay("elvissteinjr.DesktopPlusUIOverlayProperties", "Desktop+ Settings UI", &m_OvrlHandleOverlayProperties); vr::VROverlay()->CreateOverlay("elvissteinjr.DesktopPlusUIKeyboard", "Desktop+ Keyboard", &m_OvrlHandleKeyboard); vr::VROverlay()->CreateOverlay("elvissteinjr.DesktopPlusUIAux", "Desktop+ Aux UI", &m_OvrlHandleAuxUI); vr::VROverlay()->SetOverlayWidthInMeters(m_OvrlHandleFloatingUI, OVERLAY_WIDTH_METERS_DASHBOARD_UI); vr::VROverlay()->SetOverlayWidthInMeters(m_OvrlHandleSettings, OVERLAY_WIDTH_METERS_SETTINGS); vr::VROverlay()->SetOverlayWidthInMeters(m_OvrlHandleOverlayProperties, OVERLAY_WIDTH_METERS_SETTINGS); vr::VROverlay()->SetOverlayWidthInMeters(m_OvrlHandleKeyboard, OVERLAY_WIDTH_METERS_KEYBOARD); vr::VROverlay()->SetOverlayAlpha(m_OvrlHandleFloatingUI, 0.0f); //Set input parameters vr::VROverlay()->SetOverlayFlag(m_OvrlHandleOverlayBar, vr::VROverlayFlags_SendVRSmoothScrollEvents, true); vr::VROverlay()->SetOverlayFlag(m_OvrlHandleSettings, vr::VROverlayFlags_SendVRSmoothScrollEvents, true); vr::VROverlay()->SetOverlayFlag(m_OvrlHandleOverlayProperties, vr::VROverlayFlags_SendVRSmoothScrollEvents, true); vr::VROverlay()->SetOverlayFlag(m_OvrlHandleKeyboard, vr::VROverlayFlags_SendVRSmoothScrollEvents, true); vr::VROverlay()->SetOverlayFlag(m_OvrlHandleKeyboard, vr::VROverlayFlags_MultiCursor, true); vr::VROverlay()->SetOverlayFlag(m_OvrlHandleAuxUI, vr::VROverlayFlags_SendVRSmoothScrollEvents, true); vr::HmdVector2_t mouse_scale; mouse_scale.v[0] = (float)UITextureSpaces::Get().GetRect(ui_texspace_total).GetWidth(); mouse_scale.v[1] = (float)UITextureSpaces::Get().GetRect(ui_texspace_total).GetHeight(); vr::VROverlay()->SetOverlayMouseScale(m_OvrlHandleOverlayBar, &mouse_scale); vr::VROverlay()->SetOverlayMouseScale(m_OvrlHandleFloatingUI, &mouse_scale); vr::VROverlay()->SetOverlayMouseScale(m_OvrlHandleSettings, &mouse_scale); vr::VROverlay()->SetOverlayMouseScale(m_OvrlHandleOverlayProperties, &mouse_scale); vr::VROverlay()->SetOverlayMouseScale(m_OvrlHandleKeyboard, &mouse_scale); vr::VROverlay()->SetOverlayMouseScale(m_OvrlHandleAuxUI, &mouse_scale); SetOverlayInputEnabled(true); //Setup texture bounds for all overlays //The UI windows are rendered on the same texture as a form of discount multi-viewport rendering vr::VRTextureBounds_t bounds = {}; const DPRect& rect_total = UITextureSpaces::Get().GetRect(ui_texspace_total); float tex_width = (float)rect_total.GetWidth(); float tex_height = (float)rect_total.GetHeight(); const DPRect& rect_overlay_bar = UITextureSpaces::Get().GetRect(ui_texspace_overlay_bar); bounds.uMin = rect_overlay_bar.GetTL().x / tex_width; bounds.vMin = rect_overlay_bar.GetTL().y / tex_height; bounds.uMax = rect_overlay_bar.GetBR().x / tex_width; bounds.vMax = rect_overlay_bar.GetBR().y / tex_height; vr::VROverlay()->SetOverlayTextureBounds(m_OvrlHandleOverlayBar, &bounds); const DPRect& rect_floating_ui = UITextureSpaces::Get().GetRect(ui_texspace_floating_ui); bounds.uMin = rect_floating_ui.GetTL().x / tex_width; bounds.vMin = rect_floating_ui.GetTL().y / tex_height; bounds.uMax = rect_floating_ui.GetBR().x / tex_width; bounds.vMax = rect_floating_ui.GetBR().y / tex_height; vr::VROverlay()->SetOverlayTextureBounds(m_OvrlHandleFloatingUI, &bounds); const DPRect& rect_settings = UITextureSpaces::Get().GetRect(ui_texspace_settings); bounds.uMin = rect_settings.GetTL().x / tex_width; bounds.vMin = rect_settings.GetTL().y / tex_height; bounds.uMax = rect_settings.GetBR().x / tex_width; bounds.vMax = rect_settings.GetBR().y / tex_height; vr::VROverlay()->SetOverlayTextureBounds(m_OvrlHandleSettings, &bounds); const DPRect& rect_ovrlprops = UITextureSpaces::Get().GetRect(ui_texspace_overlay_properties); bounds.uMin = rect_ovrlprops.GetTL().x / tex_width; bounds.vMin = rect_ovrlprops.GetTL().y / tex_height; bounds.uMax = rect_ovrlprops.GetBR().x / tex_width; bounds.vMax = rect_ovrlprops.GetBR().y / tex_height; vr::VROverlay()->SetOverlayTextureBounds(m_OvrlHandleOverlayProperties, &bounds); const DPRect& rect_keyboard = UITextureSpaces::Get().GetRect(ui_texspace_keyboard); bounds.uMin = rect_keyboard.GetTL().x / tex_width; bounds.vMin = rect_keyboard.GetTL().y / tex_height; bounds.uMax = rect_keyboard.GetBR().x / tex_width; bounds.vMax = rect_keyboard.GetBR().y / tex_height; vr::VROverlay()->SetOverlayTextureBounds(m_OvrlHandleKeyboard, &bounds); //Set curve pitch for overlay bar. This adjusts the pitch to match the SteamVR dashboard vr::VROverlay()->SetOverlayPreCurvePitch(m_OvrlHandleOverlayBar, 0.25f); } } //Cache SystemUI handle as it won't change during the session anyways //We do not cache the GamepadUI handle as it may disappear during the session when Steam closes and make SteamVR switch to the previous dashboard vr::VROverlay()->FindOverlay("system.systemui", &m_OvrlHandleSystemUI); m_OpenVRLoaded = true; m_LowCompositorRes = (vr::VRSettings()->GetFloat("GpuSpeed", "gpuSpeedRenderTargetScale") < 1.0f); UpdateDesktopOverlayPixelSize(); UpdateCompositorRenderQualityLow(); m_WindowSettings.ApplyCurrentOverlayState(); m_WindowOverlayProperties.ApplyCurrentOverlayState(); m_VRKeyboard.GetWindow().ApplyCurrentOverlayState(); m_WindowPerformance.ResetCumulativeValues(); m_WindowPerformance.RefreshTrackerBatteryList(); ConfigManager::Get().InitConfigForWMR(); if ((ovrl_error == vr::VROverlayError_None)) return vr::VRInitError_None; else return vr::VRInitError_Compositor_OverlayInitFailed; } void UIManager::HandleIPCMessage(const MSG& msg, bool handle_delayed) { //Handle messages sent by browser process in the APIClient if (msg.message == DPBrowserAPIClient::Get().GetRegisteredMessageID()) { DPBrowserAPIClient::Get().HandleIPCMessage(msg); return; } //Apply overlay id override if needed unsigned int current_overlay_old = OverlayManager::Get().GetCurrentOverlayID(); int overlay_override_id = ConfigManager::GetValue(configid_int_state_overlay_current_id_override); if (overlay_override_id != -1) { OverlayManager::Get().SetCurrentOverlayID(overlay_override_id); } //Config strings come as WM_COPYDATA if (msg.message == WM_COPYDATA) { COPYDATASTRUCT* pcds = (COPYDATASTRUCT*)msg.lParam; //Arbitrary size limit to prevent some malicous applications from sending bad data if ( (pcds->dwData < configid_str_MAX) && (pcds->cbData <= 4096) ) { std::string copystr((char*)pcds->lpData, pcds->cbData); //We rely on the data length. The data is sent without the NUL byte ConfigID_String str_id = (ConfigID_String)pcds->dwData; ConfigManager::SetValue(str_id, copystr); switch (str_id) { case configid_str_state_ui_keyboard_string: { ImGui_ImplOpenVR_AddInputFromOSK(copystr.c_str()); break; } case configid_str_state_dashboard_error_string: { DisplayDashboardAppError(copystr); break; } } } else if ( (pcds->dwData >= dpbrowser_ipcstr_MIN) && (pcds->dwData < dpbrowser_ipcstr_MAX) ) //Probably a string for DPBrowserAPIClient { DPBrowserAPIClient::Get().HandleIPCMessage(msg); } //Restore overlay id override if (overlay_override_id != -1) { OverlayManager::Get().SetCurrentOverlayID(current_overlay_old); } return; } IPCMsgID msgid = IPCManager::Get().GetIPCMessageID(msg.message); switch (msgid) { case ipcmsg_action: { switch (msg.wParam) { case ipcact_overlays_reset: { UpdateDesktopOverlayPixelSize(); m_WindowPerformance.ScheduleOverlaySharedTextureUpdate(); break; } case ipcact_overlays_ui_reset: { m_WindowPerformance.ScheduleOverlaySharedTextureUpdate(); break; } case ipcact_overlay_profile_load: { HandleOverlayProfileLoadMessage(msg.lParam); break; } case ipcact_overlay_new_drag: { int desktop_id = GET_X_LPARAM(msg.lParam); //(No need to extract pointer distance) OverlayCaptureSource capsource; switch (desktop_id) { case -2: capsource = ovrl_capsource_winrt_capture; break; case -3: capsource = ovrl_capsource_ui; break; default: capsource = ovrl_capsource_desktop_duplication; } OverlayManager::Get().AddOverlay(capsource, desktop_id, (HWND)ConfigManager::GetValue(configid_handle_state_arg_hwnd)); break; } case ipcact_overlay_remove: { unsigned int overlay_id = (unsigned int)msg.lParam; OverlayManager::Get().RemoveOverlay(overlay_id); //Hide properties window if it's open for this overlay if (m_WindowOverlayProperties.GetActiveOverlayID() == overlay_id) { m_WindowOverlayProperties.SetActiveOverlayID(k_ulOverlayID_None, true); m_WindowOverlayProperties.Hide(); } else if (m_WindowOverlayProperties.GetActiveOverlayID() > overlay_id) //Adjust properties window active overlay ID if it's open for an overlay that had its shifted { m_WindowOverlayProperties.SetActiveOverlayID(m_WindowOverlayProperties.GetActiveOverlayID() - 1, true); } m_WindowOverlayBar.HideMenus(); break; } case ipcact_overlay_creation_error: { m_OverlayErrorLast = (vr::VROverlayError)msg.lParam; UpdateAnyWarningDisplayedState(); break; } case ipcact_winrt_thread_error: { m_WinRTErrorLast = (HRESULT)msg.lParam; UpdateAnyWarningDisplayedState(); break; } case ipcact_notification_show: { DisplayInitialSetupNotification(); break; } case ipcact_winmanager_winlist_add: case ipcact_winmanager_winlist_update: { if (handle_delayed) { const WindowInfo* window_info = nullptr; bool has_title_changed = true; if (msg.wParam == ipcact_winmanager_winlist_add) window_info = &WindowManager::Get().WindowListAdd((HWND)msg.lParam); else window_info = WindowManager::Get().WindowListUpdateTitle((HWND)msg.lParam, &has_title_changed); if ( (window_info != nullptr) && (has_title_changed) ) //Only do this when the title changed { if (ImGui::StringContainsUnmappedCharacter(window_info->GetListTitle().c_str())) { TextureManager::Get().ReloadAllTexturesLater(); UIManager::Get()->RepeatFrame(); } //Update last window info strings for overlays using this window for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { OverlayConfigData& data = OverlayManager::Get().GetConfigData(i); if ( (data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd] == msg.lParam) && (data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_winrt_capture) ) { data.ConfigStr[configid_str_overlay_winrt_last_window_title] = StringConvertFromUTF16(window_info->GetTitle().c_str()); data.ConfigStr[configid_str_overlay_winrt_last_window_class_name] = StringConvertFromUTF16(window_info->GetWindowClassName().c_str()); data.ConfigStr[configid_str_overlay_winrt_last_window_exe_name] = window_info->GetExeName(); OverlayManager::Get().SetOverlayNameAuto(i, window_info); OnOverlayNameChanged(); } } } } else { m_DelayedICPMessages.push_back(msg); } break; } case ipcact_winmanager_winlist_remove: { std::wstring last_title_w = WindowManager::Get().WindowListRemove((HWND)msg.lParam); std::string last_title = StringConvertFromUTF16(last_title_w.c_str()); //Some windows clear their title entirely before ceasing to exist, skip those if (last_title.empty()) break; //Set last known title for overlays that captured this window for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { OverlayConfigData& data = OverlayManager::Get().GetConfigData(i); if (data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd] == msg.lParam) { data.ConfigStr[configid_str_overlay_winrt_last_window_title] = last_title; } } break; } case ipcact_winmanager_focus_changed: { m_FloatingUI.GetMainBarWindow().MarkCurrentWindowCapturableStateOutdated(); break; } case ipcact_keyboard_show: { m_VRKeyboard.GetWindow().SetAssignedOverlayID((int)msg.lParam); (msg.lParam != -1) ? m_VRKeyboard.GetWindow().Show() : m_VRKeyboard.GetWindow().Hide(); break; } case ipcact_keyboard_show_auto: { int overlay_id = (msg.lParam != -1) ? (int)msg.lParam : m_VRKeyboard.GetWindow().GetAssignedOverlayID(); //Only set auto-visibility if source overlay is desktop/window capture (avoid overriding browser auto-visible keyboards) if ( (overlay_id >= 0) && (OverlayManager::Get().GetConfigData((unsigned int)overlay_id).ConfigInt[configid_int_overlay_capture_source] <= ovrl_capsource_winrt_capture) ) { m_VRKeyboard.GetWindow().SetAutoVisibility(overlay_id, (msg.lParam != -1)); } break; } case ipcact_lpointer_ui_drag: { (msg.lParam == 1) ? StartOverlayDrag(ConfigManager::GetValue(configid_handle_state_dplus_laser_pointer_target_overlay)) : FinishOverlayDrag(); break; } } break; } case ipcmsg_set_config: { if (msg.wParam < configid_bool_MAX) { ConfigID_Bool bool_id = (ConfigID_Bool)msg.wParam; bool previous_value = ConfigManager::GetValue(bool_id); ConfigManager::SetValue(bool_id, (msg.lParam != 0) ); switch (bool_id) { case configid_bool_overlay_enabled: { if (m_WindowOverlayBar.IsVisibleOrFading()) { m_IdleState.AddActiveTime(50); } break; } case configid_bool_state_window_focused_process_elevated: case configid_bool_state_misc_process_elevated: case configid_bool_state_misc_elevated_mode_active: case configid_bool_state_misc_uiaccess_enabled: case configid_bool_state_misc_browser_version_mismatch: case configid_bool_state_misc_browser_used_but_missing: { if ((msg.lParam != 0) != previous_value) { UpdateAnyWarningDisplayedState(); } break; } case configid_bool_state_overlay_dragmode_temp: { SetOverlayInputEnabled((msg.lParam == 0)); break; } } } else if (msg.wParam < configid_bool_MAX + configid_int_MAX) { ConfigID_Int int_id = (ConfigID_Int)(msg.wParam - configid_bool_MAX); int previous_value = ConfigManager::GetValue(int_id); ConfigManager::SetValue(int_id, (int)msg.lParam); switch (int_id) { case configid_int_overlay_winrt_desktop_id: { OverlayManager::Get().SetCurrentOverlayNameAuto(); break; } case configid_int_overlay_crop_x: case configid_int_overlay_crop_y: case configid_int_overlay_crop_width: case configid_int_overlay_crop_height: { //Crop changed while properties window is visible for the current overlay, force refresh of cached crop button label if ( (m_WindowOverlayProperties.IsVisibleOrFading()) && (m_WindowOverlayProperties.GetActiveOverlayID() == OverlayManager::Get().GetCurrentOverlayID()) ) { m_WindowOverlayProperties.SetActiveOverlayID(m_WindowOverlayProperties.GetActiveOverlayID(), true); } break; } case configid_int_overlay_state_fps: case configid_int_state_performance_duplication_fps: { if (ConfigManager::GetValue(configid_bool_performance_show_fps)) { m_IdleState.AddActiveTime(50); } break; } case configid_int_interface_overlay_current_id: { OverlayManager::Get().SetCurrentOverlayID((unsigned int)msg.lParam); current_overlay_old = (unsigned int)msg.lParam; break; } case configid_int_state_overlay_transform_sync_target_id: { m_TransformSyncValueCount = 0; std::fill(m_TransformSyncValues, std::end(m_TransformSyncValues), 0.0f); break; } case configid_int_state_interface_desktop_count: { m_IdleState.AddActiveTime(50); RepeatFrame(); break; } case configid_int_state_auto_docking_state: { if (msg.lParam == 0) { m_AuxUI.GetDragHintWindow().Hide(); } else { //Even config values above 0 are right hand, odd ones are left hand const vr::ETrackedControllerRole role = (msg.lParam % 2 == 0) ? vr::TrackedControllerRole_RightHand : vr::TrackedControllerRole_LeftHand; const bool is_docking = (msg.lParam <= 2); m_AuxUI.GetDragHintWindow().SetHintType(vr::VRSystem()->GetTrackedDeviceIndexForControllerRole(role), (is_docking) ? WindowDragHint::hint_docking : WindowDragHint::hint_undocking); m_AuxUI.GetDragHintWindow().Show(); } break; } case configid_int_state_drag_hint_type: { if (msg.lParam != 0) { //We don't use this config value for auto-docking hints since their display is handled alongside the docking state const WindowDragHint::HintType hint_type = (msg.lParam == 1) ? WindowDragHint::hint_ovrl_locked : WindowDragHint::hint_ovrl_theater_screen_blocked; m_AuxUI.GetDragHintWindow().SetHintType(ConfigManager::GetValue(configid_int_state_drag_hint_device), hint_type); m_AuxUI.GetDragHintWindow().Show(); } else { m_AuxUI.GetDragHintWindow().Hide(); } break; } case configid_int_state_overlay_focused_id: { //Hide auto-visible keyboard if there was one for the previously focused overlay if ( (previous_value != -1) && (previous_value != msg.lParam) ) { m_VRKeyboard.GetWindow().SetAutoVisibility((unsigned int)previous_value, false); } break; } default: break; } } else if (msg.wParam < configid_bool_MAX + configid_int_MAX + configid_float_MAX) { ConfigID_Float float_id = (ConfigID_Float)(msg.wParam - configid_bool_MAX - configid_int_MAX); float value = pun_cast(msg.lParam); ConfigManager::SetValue(float_id, value); switch (float_id) { case configid_float_state_overlay_transform_sync_value: { if (m_TransformSyncValueCount < IM_ARRAYSIZE(m_TransformSyncValues)) { m_TransformSyncValues[m_TransformSyncValueCount] = value; m_TransformSyncValueCount++; } if (m_TransformSyncValueCount >= IM_ARRAYSIZE(m_TransformSyncValues)) { OverlayConfigData& data = OverlayManager::Get().GetConfigData((unsigned int)ConfigManager::GetValue(configid_int_state_overlay_transform_sync_target_id)); data.ConfigTransform.set(m_TransformSyncValues); m_TransformSyncValueCount = 0; std::fill(m_TransformSyncValues, std::end(m_TransformSyncValues), 0.0f); } break; } default: break; } } else if (msg.wParam < configid_bool_MAX + configid_int_MAX + configid_float_MAX + configid_handle_MAX) { ConfigID_Handle handle_id = (ConfigID_Handle)(msg.wParam - configid_bool_MAX - configid_int_MAX - configid_float_MAX); uint64_t value = pun_cast(msg.lParam); ConfigManager::SetValue(handle_id, value); switch (handle_id) { case configid_handle_overlay_state_winrt_hwnd: { const WindowInfo* window_info = nullptr; if (value != 0) window_info = WindowManager::Get().WindowListFindWindow((HWND)value); //Set last known title and exe name from new handle if (window_info != nullptr) { ConfigManager::SetValue(configid_str_overlay_winrt_last_window_title, StringConvertFromUTF16(window_info->GetTitle().c_str())); ConfigManager::SetValue(configid_str_overlay_winrt_last_window_class_name, StringConvertFromUTF16(window_info->GetWindowClassName().c_str())); ConfigManager::SetValue(configid_str_overlay_winrt_last_window_exe_name, window_info->GetExeName()); } else if (value == 0) //Only clear if HWND is really null { ConfigManager::SetValue(configid_str_overlay_winrt_last_window_title, ""); ConfigManager::SetValue(configid_str_overlay_winrt_last_window_class_name, ""); ConfigManager::SetValue(configid_str_overlay_winrt_last_window_exe_name, ""); ConfigManager::SetValue(configid_handle_overlay_state_winrt_last_hicon, 0); } OverlayManager::Get().SetCurrentOverlayNameAuto(); //Refresh Overlay Properties window if it's currently active for this overlay unsigned int overlay_props_active_id = m_WindowOverlayProperties.GetActiveOverlayID(); if (OverlayManager::Get().GetCurrentOverlayID() == overlay_props_active_id) { m_WindowOverlayProperties.SetActiveOverlayID(overlay_props_active_id, true); } } default: break; } } break; } } //Restore overlay id override if (overlay_override_id != -1) { OverlayManager::Get().SetCurrentOverlayID(current_overlay_old); } } void UIManager::HandleDelayedIPCMessages() { while (!m_DelayedICPMessages.empty()) { HandleIPCMessage(m_DelayedICPMessages.back(), true); m_DelayedICPMessages.pop_back(); } } bool UIManager::HasDelayedIPCMessages() const { return !m_DelayedICPMessages.empty(); } void UIManager::OnInitDone() { //Re-apply active overlay ID since the first time config load couldn't apply it properly with the overlay not yet existing unsigned int overlay_props_active_id = m_WindowOverlayProperties.GetActiveOverlayID(); m_WindowOverlayProperties.SetActiveOverlayID(overlay_props_active_id, true); //Hide properties window if the overlay doesn't exist anymore for some reason if ((overlay_props_active_id == k_ulOverlayID_None) || (OverlayManager::Get().GetOverlayCount() <= overlay_props_active_id)) { m_WindowOverlayProperties.Hide(true); m_WindowOverlayProperties.GetOverlayState(floating_window_ovrl_state_room).IsVisible = false; m_WindowOverlayProperties.GetOverlayState(floating_window_ovrl_state_dashboard_tab).IsVisible = false; } UpdateDesktopOverlayPixelSize(); ConfigManager::Get().GetAppProfileManager().ActivateProfileForCurrentSceneApp(); } void UIManager::OnExit() { //Re-launch in VR when we were in desktop mode and probably got switched from VR mode before //This is likely more intuitive than just removing the UI entirely when clicking X if ( (m_DesktopMode) && (IPCManager::Get().IsDashboardAppRunning()) && (!ConfigManager::GetValue(configid_bool_interface_no_ui)) && (!m_NoRestartOnExit) ) { Restart(false); } else { //Save config, just in case (we don't need to do this when calling Restart()) ConfigManager::Get().SaveConfigToFile(); } //Release any held down keys m_VRKeyboard.ResetState(); if (m_ComInitDone) { ::CoUninitialize(); } m_SharedTextureRef.Reset(); WindowManager::Get().SetActive(false); vr::VR_Shutdown(); } void UIManager::OnProfileLoaded() { //Adjust current overlay ID for UI since this may have made the old selection invalid int& current_overlay = ConfigManager::Get().GetRef(configid_int_interface_overlay_current_id); current_overlay = clamp(current_overlay, 0, (int)OverlayManager::Get().GetOverlayCount() - 1); //Adjust overlay properties window //Hide window if overlay ID no longer in range if (m_WindowOverlayProperties.GetActiveOverlayID() >= OverlayManager::Get().GetOverlayCount()) { if (m_WindowOverlayProperties.GetActiveOverlayID() != k_ulOverlayID_None) { m_WindowOverlayProperties.SetActiveOverlayID(k_ulOverlayID_None, true); m_WindowOverlayProperties.Hide(); } } else //Just adjust switch if it is still is { m_WindowOverlayProperties.SetActiveOverlayID(m_WindowOverlayProperties.GetActiveOverlayID(), true); } //Check if new overlays have any unmapped characters for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { AddFontBuilderStringIfAnyUnmappedCharacters(OverlayManager::Get().GetConfigData(i).ConfigNameStr.c_str()); } m_IdleState.AddActiveTime(50); RepeatFrame(); } FloatingUI& UIManager::GetFloatingUI() { return m_FloatingUI; } VRKeyboard& UIManager::GetVRKeyboard() { return m_VRKeyboard; } AuxUI& UIManager::GetAuxUI() { return m_AuxUI; } WindowOverlayBar& UIManager::GetOverlayBarWindow() { return m_WindowOverlayBar; } WindowSettings& UIManager::GetSettingsWindow() { return m_WindowSettings; } WindowOverlayProperties& UIManager::GetOverlayPropertiesWindow() { return m_WindowOverlayProperties; } WindowPerformance& UIManager::GetPerformanceWindow() { return m_WindowPerformance; } WindowDesktopMode& UIManager::GetDesktopModeWindow() { return m_WindowDesktopMode; } void UIManager::SetWindowHandle(HWND handle) { m_WindowHandle = handle; //WindowManager will be initialized before our window is ready, but won't be ready to receive window updates before our window is fully created, so we add it manually here if (m_DesktopMode) WindowManager::Get().WindowListAdd(handle); } HWND UIManager::GetWindowHandle() const { return m_WindowHandle; } NotificationIcon& UIManager::GetNotificationIcon() { return m_NotificationIcon; } void UIManager::SetSharedTextureRef(ID3D11Resource* ref) { m_SharedTextureRef = ref; } ID3D11Resource* UIManager::GetSharedTextureRef() const { return m_SharedTextureRef.Get(); } OverlayDragger& UIManager::GetOverlayDragger() { return m_OverlayDragger; } vr::VROverlayHandle_t UIManager::GetOverlayHandleOverlayBar() const { return m_OvrlHandleOverlayBar; } vr::VROverlayHandle_t UIManager::GetOverlayHandleFloatingUI() const { return m_OvrlHandleFloatingUI; } vr::VROverlayHandle_t UIManager::GetOverlayHandleSettings() const { return m_OvrlHandleSettings; } vr::VROverlayHandle_t UIManager::GetOverlayHandleOverlayProperties() const { return m_OvrlHandleOverlayProperties; } vr::VROverlayHandle_t UIManager::GetOverlayHandleKeyboard() const { return m_OvrlHandleKeyboard; } vr::VROverlayHandle_t UIManager::GetOverlayHandleAuxUI() const { return m_OvrlHandleAuxUI; } vr::VROverlayHandle_t UIManager::GetOverlayHandleDPlusDashboard() const { return m_OvrlHandleDPlusDashboard; } vr::VROverlayHandle_t UIManager::GetOverlayHandleSystemUI() const { return m_OvrlHandleSystemUI; } std::array UIManager::GetUIOverlayHandles() const { return {m_OvrlHandleOverlayBar, m_OvrlHandleFloatingUI, m_OvrlHandleSettings, m_OvrlHandleOverlayProperties, m_OvrlHandleKeyboard, m_OvrlHandleAuxUI}; } bool UIManager::IsDummyOverlayTransformUnstable() const { return m_IsDummyOverlayTransformUnstable; } void UIManager::SendUIIntersectionMaskToDashboardApp(std::vector& primitives) const { static ULONGLONG last_tick = 0; //Mask can change at any time, any frame. We don't really want to send too many messages either though, so we limit the rate and don't update at all if the pointer isn't active if ( (ConfigManager::GetValue(configid_int_state_dplus_laser_pointer_device) != vr::k_unTrackedDeviceIndexInvalid) && (last_tick + 100 > ::GetTickCount64()) ) return; for (const auto& rect : primitives) { DPRect dp_rect((int)rect.m_Primitive.m_Rectangle.m_flTopLeftX, (int)rect.m_Primitive.m_Rectangle.m_flTopLeftY, (int)rect.m_Primitive.m_Rectangle.m_flTopLeftX + (int)rect.m_Primitive.m_Rectangle.m_flWidth, (int)rect.m_Primitive.m_Rectangle.m_flTopLeftY + (int)rect.m_Primitive.m_Rectangle.m_flHeight); IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_lpointer_ui_mask_rect, (LPARAM)dp_rect.Pack16()); } IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_lpointer_ui_mask_rect, -1); //Mark end of mask last_tick = ::GetTickCount64(); } UIManager::IdleState& UIManager::GetIdleState() { return m_IdleState; } DPRect UIManager::CalcRectForActiveTexspace() { DPRect rect; if (m_WindowOverlayBar.IsVisibleOrFading()) (rect.GetWidth() == 0) ? rect = UITextureSpaces::Get().GetRect(ui_texspace_overlay_bar) : rect.Add(UITextureSpaces::Get().GetRect(ui_texspace_overlay_bar)); if (m_FloatingUI.IsVisible()) (rect.GetWidth() == 0) ? rect = UITextureSpaces::Get().GetRect(ui_texspace_floating_ui) : rect.Add(UITextureSpaces::Get().GetRect(ui_texspace_floating_ui)); if (m_WindowSettings.IsVisibleOrFading()) (rect.GetWidth() == 0) ? rect = UITextureSpaces::Get().GetRect(ui_texspace_settings) : rect.Add(UITextureSpaces::Get().GetRect(ui_texspace_settings)); if (m_WindowOverlayProperties.IsVisibleOrFading()) (rect.GetWidth() == 0) ? rect = UITextureSpaces::Get().GetRect(ui_texspace_overlay_properties) : rect.Add(UITextureSpaces::Get().GetRect(ui_texspace_overlay_properties)); if (m_VRKeyboard.GetWindow().IsVisibleOrFading()) (rect.GetWidth() == 0) ? rect = UITextureSpaces::Get().GetRect(ui_texspace_keyboard) : rect.Add(UITextureSpaces::Get().GetRect(ui_texspace_keyboard)); if (m_WindowPerformance.IsVisible()) (rect.GetWidth() == 0) ? rect = UITextureSpaces::Get().GetRect(ui_texspace_performance_monitor) : rect.Add(UITextureSpaces::Get().GetRect(ui_texspace_performance_monitor)); if (m_AuxUI.IsActive()) (rect.GetWidth() == 0) ? rect = UITextureSpaces::Get().GetRect(ui_texspace_aux_ui) : rect.Add(UITextureSpaces::Get().GetRect(ui_texspace_aux_ui)); return rect; } void UIManager::RepeatFrame(int extra_frame_count) { if (m_RepeatFrame < extra_frame_count) m_RepeatFrame = extra_frame_count; } bool UIManager::GetRepeatFrame() const { return (m_RepeatFrame != 0); } void UIManager::DecreaseRepeatFrameCount() { if (m_RepeatFrame != 0) m_RepeatFrame--; } bool UIManager::IsInDesktopMode() const { return m_DesktopMode; } bool UIManager::IsInKeyboardEditorMode() const { return m_KeyboardEditorMode; } bool UIManager::IsOpenVRLoaded() const { return m_OpenVRLoaded; } void UIManager::DisableRestartOnExit() { m_NoRestartOnExit = true; } void UIManager::Restart(bool desktop_mode) { LOG_IF_F(INFO, !desktop_mode, "Restarting..."); LOG_IF_F(INFO, desktop_mode, "Restarting into desktop mode..."); ConfigManager::Get().SaveConfigToFile(); UIManager::Get()->DisableRestartOnExit(); STARTUPINFO si = {0}; PROCESS_INFORMATION pi = {0}; si.cb = sizeof(si); std::wstring path = WStringConvertFromUTF8(ConfigManager::Get().GetApplicationPath().c_str()) + L"DesktopPlusUI.exe"; WCHAR cmd[] = L"--DesktopMode"; ::CreateProcess(path.c_str(), (desktop_mode) ? cmd : nullptr, nullptr, nullptr, FALSE, 0, nullptr, nullptr, &si, &pi); //We don't care about these, so close right away ::CloseHandle(pi.hProcess); ::CloseHandle(pi.hThread); } void UIManager::RestartIntoKeyboardEditor() { LOG_F(INFO, "Restarting into Keyboard Editor..."); ConfigManager::Get().SaveConfigToFile(); UIManager::Get()->DisableRestartOnExit(); STARTUPINFO si = {0}; PROCESS_INFORMATION pi = {0}; si.cb = sizeof(si); std::wstring path = WStringConvertFromUTF8(ConfigManager::Get().GetApplicationPath().c_str()) + L"DesktopPlusUI.exe"; WCHAR cmd[] = L"--KeyboardEditor"; ::CreateProcess(path.c_str(), cmd, nullptr, nullptr, FALSE, 0, nullptr, nullptr, &si, &pi); //We don't care about these, so close right away ::CloseHandle(pi.hProcess); ::CloseHandle(pi.hThread); } void UIManager::RestartDashboardApp(bool force_steam) { LOG_F(INFO, "Restarting dashboard app...%s", (force_steam) ? " (using Steam)" : ""); ConfigManager::Get().ResetConfigStateValues(); ConfigManager::Get().SaveConfigToFile(); bool use_steam = ( (force_steam) || (ConfigManager::GetValue(configid_bool_state_misc_process_started_by_steam)) ); //LaunchDashboardOverlay() technically also launches the non-Steam version if it's registered, but there's no reason to use it in that case if (use_steam) { //We need OpenVR loaded for this if (!m_OpenVRLoaded) { InitOverlay(); } //Steam will not launch the overlay if it's already running, so in this case we need to get rid of the running instance now StopProcessByWindowClass(g_WindowClassNameDashboardApp); ULONGLONG start_tick = ::GetTickCount64(); vr::EVRApplicationError app_error = vr::VRApplications()->LaunchDashboardOverlay(g_AppKeyDashboardApp); while ( (app_error == vr::VRApplicationError_ApplicationAlreadyRunning) && (::GetTickCount64() - start_tick < 5000) ) //Try 5 seconds max { ::Sleep(250); app_error = vr::VRApplications()->LaunchDashboardOverlay(g_AppKeyDashboardApp); } //Try without Steam below if launching failed somehow if (app_error != vr::VRApplicationError_None) { use_steam = false; } } if (!use_steam) { std::wstring path = WStringConvertFromUTF8(ConfigManager::Get().GetApplicationPath().c_str()) + L"DesktopPlus.exe"; if (ConfigManager::GetValue(configid_bool_state_misc_uiaccess_enabled)) //UIAccess enabled executable doesn't run straight from CreateProcess() { if (!m_ComInitDone) //Let's only do this if really needed { m_ComInitDone = (::CoInitializeEx(nullptr, COINIT_APARTMENTTHREADED | COINIT_DISABLE_OLE1DDE) != RPC_E_CHANGED_MODE); } ::ShellExecute(nullptr, nullptr, path.c_str(), nullptr, nullptr, SW_SHOWNORMAL); } else { STARTUPINFO si = {0}; PROCESS_INFORMATION pi = {0}; si.cb = sizeof(si); ::CreateProcess(path.c_str(), nullptr, nullptr, nullptr, FALSE, 0, nullptr, nullptr, &si, &pi); //We don't care about these, so close right away ::CloseHandle(pi.hProcess); ::CloseHandle(pi.hThread); } } m_WindowPerformance.ScheduleOverlaySharedTextureUpdate(); m_WindowOverlayProperties.Hide(); //Current overlay won't be set on dashboard app, so close this now } void UIManager::ElevatedModeEnter() { LOG_F(INFO, "Entered elevated mode"); STARTUPINFO si = {0}; PROCESS_INFORMATION pi = {0}; si.cb = sizeof(si); WCHAR cmd[] = L"\"schtasks\" /Run /TN \"DesktopPlus Elevated\""; //"CreateProcessW, can modify the contents of this string", so don't go optimize this away ::CreateProcess(nullptr, cmd, nullptr, nullptr, FALSE, CREATE_NO_WINDOW, nullptr, nullptr, &si, &pi); //We don't care about these, so close right away ::CloseHandle(pi.hProcess); ::CloseHandle(pi.hThread); } void UIManager::ElevatedModeLeave() { LOG_F(INFO, "Left elevated mode"); //Kindly ask elevated mode process to quit if (HWND window = ::FindWindow(g_WindowClassNameElevatedMode, nullptr)) { ::PostMessage(window, WM_QUIT, 0, 0); } } void UIManager::UpdateStyle() { if (ImGui::GetCurrentContext() == nullptr) return; ImGuiIO& io = ImGui::GetIO(); //Setup Dear ImGui style ImGuiStyle& style = ImGui::GetStyle(); style = ImGuiStyle(); ImGui::StyleColorsDark(); //Do a bit of custom styling style.DisabledAlpha = 0.5f; style.WindowRounding = 7.0f; style.FrameRounding = 4.0f; style.GrabRounding = 3.0f; style.IndentSpacing = style.ItemSpacing.x; if (m_DesktopMode) { style.WindowPadding.x /= 2.0f; style.WindowPadding.y /= 2.0f; } ImVec4* colors = style.Colors; colors[ImGuiCol_Text] = ImVec4(1.00f, 1.00f, 1.00f, 1.00f); colors[ImGuiCol_TextDisabled] = ImVec4(0.36f, 0.42f, 0.47f, 1.00f); colors[ImGuiCol_TextDisabled] = ImVec4(0.50f, 0.50f, 0.50f, 1.00f); colors[ImGuiCol_WindowBg] = ImVec4(0.085f, 0.135f, 0.155f, 0.96f); colors[ImGuiCol_ChildBg] = ImVec4(0.00f, 0.00f, 0.00f, 0.10f); colors[ImGuiCol_PopupBg] = ImVec4(0.088f, 0.138f, 0.158f, 0.96f); colors[ImGuiCol_Border] = ImVec4(0.20f, 0.25f, 0.29f, 1.00f); colors[ImGuiCol_BorderShadow] = ImVec4(0.00f, 0.00f, 0.00f, 0.00f); colors[ImGuiCol_FrameBg] = ImVec4(0.185f, 0.245f, 0.285f, 1.00f); colors[ImGuiCol_FrameBgHovered] = ImVec4(0.12f, 0.20f, 0.28f, 1.00f); colors[ImGuiCol_FrameBgActive] = ImVec4(0.109f, 0.175f, 0.224f, 1.000f); colors[ImGuiCol_TitleBg] = ImVec4(0.08f, 0.10f, 0.12f, 1.00f); colors[ImGuiCol_TitleBgActive] = ImVec4(0.08f, 0.10f, 0.12f, 1.00f); colors[ImGuiCol_TitleBgCollapsed] = ImVec4(0.00f, 0.00f, 0.00f, 0.51f); colors[ImGuiCol_MenuBarBg] = ImVec4(0.15f, 0.18f, 0.22f, 1.00f); colors[ImGuiCol_ScrollbarBg] = ImVec4(0.02f, 0.02f, 0.02f, 0.08f); colors[ImGuiCol_ScrollbarGrab] = ImVec4(0.20f, 0.25f, 0.29f, 1.00f); colors[ImGuiCol_ScrollbarGrabHovered] = ImVec4(0.18f, 0.22f, 0.25f, 1.00f); colors[ImGuiCol_ScrollbarGrabActive] = ImVec4(0.09f, 0.21f, 0.31f, 1.00f); colors[ImGuiCol_CheckMark] = ImVec4(1.00f, 1.00f, 1.00f, 1.00f); colors[ImGuiCol_SliderGrab] = ImVec4(0.298f, 0.596f, 0.859f, 1.000f); colors[ImGuiCol_SliderGrabActive] = ImVec4(0.333f, 0.616f, 1.000f, 1.000f); colors[ImGuiCol_Button] = ImVec4(0.20f, 0.25f, 0.29f, 1.00f); colors[ImGuiCol_ButtonHovered] = ImVec4(0.28f, 0.56f, 1.00f, 1.00f); colors[ImGuiCol_ButtonActive] = ImVec4(0.063f, 0.548f, 1.000f, 1.000f); colors[ImGuiCol_Header] = ImVec4(0.20f, 0.25f, 0.29f, 0.55f); colors[ImGuiCol_HeaderHovered] = ImVec4(0.26f, 0.59f, 0.98f, 0.80f); colors[ImGuiCol_HeaderActive] = ImVec4(0.26f, 0.59f, 0.98f, 1.00f); colors[ImGuiCol_Separator] = ImVec4(0.20f, 0.25f, 0.29f, 1.00f); colors[ImGuiCol_SeparatorHovered] = ImVec4(0.10f, 0.40f, 0.75f, 0.78f); colors[ImGuiCol_SeparatorActive] = ImVec4(0.10f, 0.40f, 0.75f, 1.00f); colors[ImGuiCol_ResizeGrip] = ImVec4(0.26f, 0.59f, 0.98f, 0.25f); colors[ImGuiCol_ResizeGripHovered] = ImVec4(0.26f, 0.59f, 0.98f, 0.67f); colors[ImGuiCol_ResizeGripActive] = ImVec4(0.26f, 0.59f, 0.98f, 0.95f); colors[ImGuiCol_Tab] = ImVec4(0.28f, 0.305f, 0.3f, 0.25f); colors[ImGuiCol_TabHovered] = ImVec4(0.26f, 0.59f, 0.98f, 0.80f); colors[ImGuiCol_TabSelected] = ImVec4(0.20f, 0.25f, 0.29f, 1.00f); colors[ImGuiCol_TabDimmed] = ImVec4(0.11f, 0.15f, 0.17f, 1.00f); colors[ImGuiCol_TabDimmedSelected] = ImVec4(0.11f, 0.15f, 0.17f, 1.00f); colors[ImGuiCol_PlotLines] = ImVec4(0.61f, 0.61f, 0.61f, 1.00f); colors[ImGuiCol_PlotLinesHovered] = ImVec4(1.00f, 0.43f, 0.35f, 1.00f); colors[ImGuiCol_PlotHistogram] = ImVec4(0.90f, 0.70f, 0.00f, 1.00f); colors[ImGuiCol_PlotHistogramHovered] = ImVec4(1.00f, 0.60f, 0.00f, 1.00f); colors[ImGuiCol_TableHeaderBg] = ImVec4(0.20f, 0.25f, 0.29f, 0.55f); colors[ImGuiCol_TableBorderStrong] = ImVec4(0.20f, 0.25f, 0.29f, 1.00f); colors[ImGuiCol_TableBorderLight] = ImVec4(0.20f, 0.25f, 0.29f, 1.00f); colors[ImGuiCol_TableRowBg] = ImVec4(0.00f, 0.00f, 0.00f, 0.10f); colors[ImGuiCol_TableRowBgAlt] = ImVec4(0.00f, 0.00f, 0.00f, 0.20f); colors[ImGuiCol_TextSelectedBg] = ImVec4(0.26f, 0.59f, 0.98f, 0.35f); colors[ImGuiCol_DragDropTarget] = ImVec4(1.00f, 1.00f, 0.00f, 0.90f); colors[ImGuiCol_NavCursor] = ImVec4(0.26f, 0.59f, 0.98f, 1.00f); colors[ImGuiCol_NavWindowingHighlight] = ImVec4(1.00f, 1.00f, 1.00f, 0.70f); colors[ImGuiCol_NavWindowingDimBg] = ImVec4(0.80f, 0.80f, 0.80f, 0.20f); colors[ImGuiCol_ModalWindowDimBg] = ImVec4(0.00f, 0.00f, 0.00f, 0.00f); Style_ImGuiCol_TextNotification = ImVec4(0.64f, 0.97f, 0.26f, 1.00f); Style_ImGuiCol_TextWarning = ImVec4(0.98f, 0.81f, 0.26f, 1.00f); Style_ImGuiCol_TextError = ImVec4(0.97f, 0.33f, 0.33f, 1.00f); Style_ImGuiCol_TextOutline = ImVec4(0.00f, 0.00f, 0.00f, 1.00f); Style_ImGuiCol_ButtonPassiveToggled = ImVec4(0.122f, 0.220f, 0.322f, 1.000f); Style_ImGuiCol_SteamVRCursor = ImVec4(0.463f, 0.765f, 0.882f, 1.000f); Style_ImGuiCol_SteamVRCursorBorder = ImVec4(0.161f, 0.176f, 0.196f, 0.929f); //Setup ImPlot style ImPlotStyle& plot_style = ImPlot::GetStyle(); plot_style.PlotPadding = {0.0f, 0.0f}; plot_style.FillAlpha = 0.25f; plot_style.Colors[ImPlotCol_FrameBg] = ImVec4(0.03f, 0.05f, 0.06f, 0.10f); plot_style.Colors[ImPlotCol_PlotBg] = ImVec4(0.00f, 0.00f, 0.00f, 0.00f); //Adapt to DPI float ui_scale = 1.0f; if (UIManager::Get()->IsInDesktopMode()) { float dpi_scale = ImGui_ImplWin32_GetDpiScaleForHwnd(m_WindowHandle); //Allow overriding the UI scale float scale_override = ConfigManager::GetValue(configid_float_interface_desktop_ui_scale_override); if (scale_override != 0.0f) { dpi_scale = clamp(scale_override, 0.10f, 5.0f); } ui_scale = dpi_scale * 0.625f; //Scaling based on 100% being the VR font at 32pt and desktop 100% DPI font being at 20pt style.ScaleAllSizes(dpi_scale); //Scale based on DPI scale, not UI scale (basically only go larger) } UIManager::Get()->SetUIScale(ui_scale); //Set DPI-dependent style style.LogSliderDeadzone = (float)int(58.0f * ui_scale); //Force whole pixel size if (UIManager::Get()->IsInDesktopMode()) { io.DisplaySize.x = (float)UITextureSpaces::Get().GetRect(ui_texspace_total).GetWidth() * ui_scale; io.DisplaySize.y = (float)UITextureSpaces::Get().GetRect(ui_texspace_total).GetHeight() * ui_scale; style.ScrollbarSize = (float)int(23.0f * ui_scale); } else { io.DisplaySize.x = (float)UITextureSpaces::Get().GetRect(ui_texspace_total).GetWidth(); io.DisplaySize.y = (float)UITextureSpaces::Get().GetRect(ui_texspace_total).GetHeight(); style.ScrollbarSize = (float)int(32.0f * ui_scale); //UpdateOverlayDimming() relies on loaded ImGui/style, so do the initial call to that here UIManager::Get()->UpdateOverlayDimming(); } TextureManager::Get().LoadAllTexturesAndBuildFonts(); RepeatFrame(); } void UIManager::SetUIScale(float scale) { m_UIScale = scale; if (!m_DesktopMode) { ConfigManager::SetValue(configid_float_interface_last_vr_ui_scale, scale); } m_WindowOverlayProperties.ApplyUIScale(); m_WindowSettings.ApplyUIScale(); m_VRKeyboard.GetWindow().ApplyUIScale(); } float UIManager::GetUIScale() const { return m_UIScale; } void UIManager::SetFonts(ImFont* font_compact, ImFont* font_large) { m_FontCompact = font_compact; m_FontLarge = font_large; } ImFont* UIManager::GetFontCompact() const { return m_FontCompact; } ImFont* UIManager::GetFontLarge() const { return m_FontLarge; } void UIManager::AddFontBuilderStringIfAnyUnmappedCharacters(const char* str) { if (ImGui::StringContainsUnmappedCharacter(str)) { if (TextureManager::Get().AddFontBuilderString(str)) { TextureManager::Get().ReloadAllTexturesLater(); RepeatFrame(); } } } void UIManager::OnDPIChanged(int new_dpi, const RECT& new_window_rect) { if (!m_DesktopMode) return; UpdateStyle(); //Set new window position from the provided rect ::SetWindowPos(m_WindowHandle, nullptr, new_window_rect.left, new_window_rect.top, new_window_rect.right - new_window_rect.left, new_window_rect.bottom - new_window_rect.top, SWP_NOZORDER | SWP_NOACTIVATE); //Reload window icon in DPI-appropriate size. We don't really want to reload the big icon, but it gets reset to the small one if that one's changed, so we do both HINSTANCE instance = (HINSTANCE)::GetWindowLongPtr(m_WindowHandle, GWLP_HINSTANCE); const float new_scale = (float)new_dpi / USER_DEFAULT_SCREEN_DPI; HICON icon_small = (HICON)LoadImage(instance, MAKEINTRESOURCE(IDI_DPLUS), IMAGE_ICON, int(GetSystemMetrics(SM_CXSMICON) * new_scale), int(GetSystemMetrics(SM_CYSMICON) * new_scale), LR_DEFAULTCOLOR); HICON icon = (HICON)LoadImage(instance, MAKEINTRESOURCE(IDI_DPLUS), IMAGE_ICON, GetSystemMetrics(SM_CXICON), GetSystemMetrics(SM_CYICON), LR_DEFAULTCOLOR); HICON icon_prev_small = (HICON)::SendMessage(m_WindowHandle, WM_SETICON, ICON_SMALL, (LPARAM)icon_small); HICON icon_prev = (HICON)::SendMessage(m_WindowHandle, WM_SETICON, ICON_BIG, (LPARAM)icon); //Destroy the previous icons ::DestroyIcon(icon_prev_small); ::DestroyIcon(icon_prev); } void UIManager::OnTranslationChanged() { TextureManager::Get().ReloadAllTexturesLater(); m_NotificationIcon.RefreshPopupMenu(); m_WindowSettings.ClearCachedTranslationStrings(); m_WindowOverlayProperties.SetActiveOverlayID(m_WindowOverlayProperties.GetActiveOverlayID(), true); DPBrowserAPIClient::Get().DPBrowser_ErrorPageSetStrings(TranslationManager::GetString(tstr_BrowserErrorPageTitle), TranslationManager::GetString(tstr_BrowserErrorPageHeading), TranslationManager::GetString(tstr_BrowserErrorPageMessage)); RepeatFrame(); } void UIManager::OnOverlayNameChanged() { m_WindowOverlayProperties.SetActiveOverlayID(m_WindowOverlayProperties.GetActiveOverlayID(), true); if ( (m_VRKeyboard.GetInputTarget() == kbdtarget_overlay) && (m_VRKeyboard.GetWindow().IsVisible()) ) { m_VRKeyboard.GetWindow().Show(); } RepeatFrame(); } void UIManager::UpdateOverlayDimming() { if ( (ConfigManager::GetValue(configid_bool_interface_dim_ui)) && (vr::VROverlay()->IsOverlayVisible(m_OvrlHandleDPlusDashboard)) ) { for (const auto& overlay_handle : GetUIOverlayHandles()) { vr::VROverlay()->SetOverlayColor(overlay_handle, 0.05f, 0.05f, 0.05f); } vr::VROverlay()->SetOverlayColor(m_OvrlHandleOverlayBar, 0.05f, 0.05f, 0.05f); ImGui::GetStyle().Colors[ImGuiCol_WindowBg].w = 1.0f; //Set window bg alpha to 100% to not have the contrast be even worse on light backgrounds } else { for (const auto& overlay_handle : GetUIOverlayHandles()) { vr::VROverlay()->SetOverlayColor(overlay_handle, 1.0f, 1.0f, 1.0f); } ImGui::GetStyle().Colors[ImGuiCol_WindowBg].w = 0.96f; } } bool UIManager::IsCompositorResolutionLow() const { return m_LowCompositorRes; } bool UIManager::IsCompositorRenderQualityLow() const { return m_LowCompositorQuality; } void UIManager::UpdateCompositorRenderQualityLow() { if (!m_OpenVRLoaded) return; int compositor_quality = vr::VRSettings()->GetInt32("steamvr", "overlayRenderQuality_2"); m_LowCompositorQuality = ((compositor_quality > 0) && (compositor_quality < 3)); //0 is Auto (not sure if the result of that is accessible), 3 is High UpdateAnyWarningDisplayedState(); } bool UIManager::IsAnyWarningDisplayed() const { return m_HasAnyWarning; } void UIManager::UpdateAnyWarningDisplayedState() { m_HasAnyWarning = false; m_IdleState.AddActiveTime(); //Make sure any changes are reflected even while idling //Check all possible warnings. This has to be in sync with what WindowSettings::UpdateWarnings() does to be correct. //Compositor resolution warning if ( (!ConfigManager::GetValue(configid_bool_interface_warning_compositor_res_hidden)) && (m_LowCompositorRes) ) { m_HasAnyWarning = true; return; } //Compositor quality warning if ( (!ConfigManager::GetValue(configid_bool_interface_warning_compositor_quality_hidden)) && (m_LowCompositorQuality) ) { m_HasAnyWarning = true; return; } //Dashboard app process elevation warning if ( (!ConfigManager::GetValue(configid_bool_interface_warning_process_elevation_hidden)) && (ConfigManager::GetValue(configid_bool_state_misc_process_elevated)) ) { m_HasAnyWarning = true; return; } //Elevated mode warning (this is different from elevated dashboard process) if ( (!ConfigManager::GetValue(configid_bool_interface_warning_elevated_mode_hidden)) && (ConfigManager::GetValue(configid_bool_state_misc_elevated_mode_active)) ) { m_HasAnyWarning = true; return; } //Browser missing warning if ( (!ConfigManager::GetValue(configid_bool_interface_warning_browser_missing_hidden)) && (ConfigManager::GetValue(configid_bool_state_misc_browser_used_but_missing)) ) { m_HasAnyWarning = true; return; } //Browser version mismatch warning if ( (!ConfigManager::GetValue(configid_bool_interface_warning_browser_version_mismatch_hidden)) && (ConfigManager::GetValue(configid_bool_state_misc_browser_version_mismatch)) ) { m_HasAnyWarning = true; return; } //Focused process elevation warning if ( (ConfigManager::GetValue(configid_bool_state_window_focused_process_elevated)) && (!ConfigManager::GetValue(configid_bool_state_misc_process_elevated)) && (!ConfigManager::GetValue(configid_bool_state_misc_elevated_mode_active)) && (!ConfigManager::GetValue(configid_bool_state_misc_uiaccess_enabled)) ) { m_HasAnyWarning = true; return; } //UIAccess lost warning if ( (ConfigManager::GetValue(configid_bool_misc_uiaccess_was_enabled)) && (!ConfigManager::GetValue(configid_bool_state_misc_uiaccess_enabled)) ) { m_HasAnyWarning = true; return; } //Overlay error warning if ( (m_OverlayErrorLast != vr::VROverlayError_None) && (m_OpenVRLoaded) ) { m_HasAnyWarning = true; return; } //WinRT Capture error warning if ( (m_WinRTErrorLast != S_OK) && (m_OpenVRLoaded) ) { m_HasAnyWarning = true; return; } //App profile with overlay profile active warning if ( (!ConfigManager::GetRef(configid_bool_interface_warning_app_profile_active_hidden)) && (ConfigManager::Get().GetAppProfileManager().IsActiveProfileWithOverlayProfile()) ) { m_HasAnyWarning = true; return; } //App profile with overlay profile active warning if (ConfigManager::GetValue(configid_bool_state_misc_config_migrated)) { m_HasAnyWarning = true; return; } } vr::EVROverlayError UIManager::GetOverlayErrorLast() const { return m_OverlayErrorLast; } HRESULT UIManager::GetWinRTErrorLast() const { return m_WinRTErrorLast; } void UIManager::ResetOverlayErrorLast() { m_OverlayErrorLast = vr::VROverlayError_None; } void UIManager::ResetWinRTErrorLast() { m_WinRTErrorLast = S_OK; } bool UIManager::IsElevatedTaskSetUp() const { return m_ElevatedTaskSetUp; } void UIManager::TryChangingWindowFocus() const { //This is a non-exhaustive attempt to get a different window to set focus on, but it works in most cases HWND window_top = ::GetForegroundWindow(); HWND window_switch = nullptr; //Try current VR app window first if (m_OpenVRLoaded) { uint32_t pid = vr::VRApplications()->GetCurrentSceneProcessId(); if ( (pid != 0) && (!IsProcessElevated(pid)) ) { window_switch = FindMainWindow(pid); } } //Try getting the next window if (window_switch == nullptr) { //Just use the capturable window list as a base, it's about what we want here anyways auto& window_list = WindowManager::Get().WindowListGet(); auto it = std::find_if(window_list.begin(), window_list.end(), [&](const auto& info){ return (info.GetWindowHandle() == window_top); }); //Find the next window in that is not elevated if (it != window_list.end()) { for (++it; it != window_list.end(); ++it) { //Check if the window is also of an elevated process DWORD process_id = 0; ::GetWindowThreadProcessId(it->GetWindowHandle(), &process_id); if (!IsProcessElevated(process_id)) { window_switch = it->GetWindowHandle(); break; } } } } //If no window was found fall back if (window_switch == nullptr) { //Focusing the desktop as last resort works but can be awkward since the focus is not obvious and keyboard input could do unintended stuff window_switch = ::GetShellWindow(); } //Dashboard app is more successful at changing focus for some reason, so let it try instead IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_focus_window, (LPARAM)window_switch); } bool UIManager::IsOverlayBarOverlayVisible() const { return m_OvrlVisible; } void UIManager::GetDesktopOverlayPixelSize(int& width, int& height) const { width = m_OvrlPixelWidth; height = m_OvrlPixelHeight; } void UIManager::UpdateDesktopOverlayPixelSize() { //If OpenVR was loaded, get it from the overlay if (m_OpenVRLoaded) { vr::VROverlayHandle_t ovrl_handle_dplus = vr::k_ulOverlayHandleInvalid; vr::VROverlay()->FindOverlay("elvissteinjr.DesktopPlusDesktopTexture", &ovrl_handle_dplus); if (ovrl_handle_dplus != vr::k_ulOverlayHandleInvalid) { vr::HmdVector2_t mouse_scale; vr::VROverlay()->GetOverlayMouseScale(ovrl_handle_dplus, &mouse_scale); //Mouse scale is pretty much the underlying pixel count m_OvrlPixelWidth = (int)mouse_scale.v[0]; m_OvrlPixelHeight = (int)mouse_scale.v[1]; } } else //What we get here may not reflect the real values, but let's do some good guesswork { int& desktop_id = ConfigManager::GetRef(configid_int_overlay_desktop_id); if (desktop_id >= ConfigManager::GetValue(configid_int_state_interface_desktop_count)) desktop_id = -1; else if (desktop_id == -2) //-2 tell the dashboard application to crop it to desktop 0 and the value changes afterwards, though that doesn't happen when it's not running desktop_id = 0; if ( (desktop_id == -1) || (!ConfigManager::GetValue(configid_bool_performance_single_desktop_mirroring)) ) //All desktops, get virtual screen dimensions { m_OvrlPixelWidth = GetSystemMetrics(SM_CXVIRTUALSCREEN); m_OvrlPixelHeight = GetSystemMetrics(SM_CYVIRTUALSCREEN); } else //Single desktop, try to get the screen resolution for it { DEVMODE mode = GetDevmodeForDisplayID(desktop_id, (ConfigManager::GetValue(configid_int_interface_wmr_ignore_vscreens) == 1)); if (mode.dmSize != 0) { m_OvrlPixelWidth = mode.dmPelsWidth; m_OvrlPixelHeight = mode.dmPelsHeight; } } } } void UIManager::PositionOverlay() { vr::VROverlay()->FindOverlay("elvissteinjr.DesktopPlusDashboard", &m_OvrlHandleDPlusDashboard); if (m_OvrlHandleDPlusDashboard != vr::k_ulOverlayHandleInvalid) { //Adjust behavior if gamepad ui (SteamVR 2 dashboard) exists vr::VROverlayHandle_t handle_gamepad_ui = vr::k_ulOverlayHandleInvalid; vr::VROverlay()->FindOverlay("valve.steam.gamepadui.bar", &handle_gamepad_ui); //Imagine if SetOverlayTransformOverlayRelative() actually worked vr::HmdMatrix34_t matrix_ovr; vr::TrackingUniverseOrigin origin = vr::TrackingUniverseStanding; vr::VROverlay()->GetTransformForOverlayCoordinates(m_OvrlHandleDPlusDashboard, origin, { 0.5f, 0.0f }, &matrix_ovr); //Adjust curve for dashboard position float curve = 0.145f; if (handle_gamepad_ui != vr::k_ulOverlayHandleInvalid) { curve = 0.19f; //SteamVR 2 removed dashboard distance setting } else { int32_t dashboard_pos = vr::VRSettings()->GetInt32(vr::k_pch_Dashboard_Section, "position_2"); switch (dashboard_pos) { case 0: curve = 0.17f; break; //Near case 1: curve = 0.16f; break; //Middle case 2: curve = 0.15f; break; //Far } } //Offset the overlay //It's offset in so it's as close to the dashboard as possible while not messing up pointer input. //Most problematic dashboard element is the current application button (SystemUI) and dashboard reposition bar (GamepadUI). if (m_WindowOverlayBar.IsScrollBarVisible()) { if (handle_gamepad_ui != vr::k_ulOverlayHandleInvalid) { vr::IVRSystemEx::TransformOpenVR34TranslateRelative(matrix_ovr, 0.0f, -0.247f, 0.400f); } else { vr::IVRSystemEx::TransformOpenVR34TranslateRelative(matrix_ovr, 0.0f, -0.272f, 0.195f); } } else { if (handle_gamepad_ui != vr::k_ulOverlayHandleInvalid) { vr::IVRSystemEx::TransformOpenVR34TranslateRelative(matrix_ovr, 0.0f, -0.200f, 0.390f); } else { vr::IVRSystemEx::TransformOpenVR34TranslateRelative(matrix_ovr, 0.0f, -0.225f, 0.185f); } } //SteamVR 2.15.1 made changes that affected offsets needed for Overlay Bar positioning and curvature //While this change is only in the beta branch, we conditionally adjust properties on 2.15 runtimes to get back to the old position const bool use_additional_offset = (strstr(vr::VRSystem()->GetRuntimeVersion(), "2.15") != nullptr); if (use_additional_offset) { vr::IVRSystemEx::TransformOpenVR34TranslateRelative(matrix_ovr, 0.0f, -0.126f, 0.070f); vr::VROverlay()->SetOverlayPreCurvePitch(m_OvrlHandleOverlayBar, 0.20f); curve = 0.1725f; } //Rotate slightly forward (local rotation) Matrix4 mat_m4; //is identity mat_m4.rotateX(-14.0f); mat_m4 = Matrix4(matrix_ovr) * mat_m4; matrix_ovr = mat_m4.toOpenVR34(); //Try to reduce flicker by blocking abrupt Y movements (unless X has changed as well, which we assume to happen on real movement) //The flicker itself comes from a race condition of the UI possibly getting the overlay transform while it's changing width and position, hard to predict bool anti_flicker_can_move = false; float anti_flicker_x = matrix_ovr.m[0][3]; float anti_flicker_y = matrix_ovr.m[1][3]; static float anti_flicker_x_last = anti_flicker_x; static float anti_flicker_y_last = anti_flicker_y; static int anti_flicker_block_count = 0; const bool anti_flicker_moved_any = ((anti_flicker_x != anti_flicker_x_last) || (anti_flicker_y != anti_flicker_y_last)); if ( (anti_flicker_x != anti_flicker_x_last) || (fabs(anti_flicker_y - anti_flicker_y_last) < 0.001f) || (anti_flicker_block_count >= 2) ) { anti_flicker_can_move = true; anti_flicker_x_last = anti_flicker_x; anti_flicker_y_last = anti_flicker_y; anti_flicker_block_count = 0; } else { anti_flicker_block_count++; } //Block transform updates on abrupt movements, repeated frames, mouse down and shortly after switching desktops m_IsDummyOverlayTransformUnstable = ( (!anti_flicker_can_move) || (GetRepeatFrame()) || (ImGui::IsMouseDown(ImGuiMouseButton_Left)) || (ImGui::GetIO().MouseClickedTime[ImGuiMouseButton_Left] + 0.3 >= ImGui::GetTime()) || (m_FloatingUI.GetActionBarWindow().GetLastDesktopSwitchTime() + 0.3 >= ImGui::GetTime()) ); if (!m_IsDummyOverlayTransformUnstable) { vr::VROverlay()->SetOverlayTransformAbsolute(m_OvrlHandleOverlayBar, origin, &matrix_ovr); vr::VROverlay()->SetOverlayCurvature(m_OvrlHandleOverlayBar, curve); } //Set visibility if (vr::VROverlay()->IsOverlayVisible(m_OvrlHandleDPlusDashboard)) { bool is_systemui_hovered = ConfigManager::Get().IsLaserPointerTargetOverlay(m_OvrlHandleSystemUI); //Check for GamepadUI as well if it exists if (handle_gamepad_ui != vr::k_ulOverlayHandleInvalid) { is_systemui_hovered = (is_systemui_hovered || ConfigManager::Get().IsLaserPointerTargetOverlay(handle_gamepad_ui)); } if (!m_OvrlVisible) { vr::VROverlay()->ShowOverlay(m_OvrlHandleOverlayBar); m_WindowOverlayBar.Show(); m_OvrlVisible = true; UpdateOverlayDimming(); m_OverlayDragger.UpdateTempStandingPosition(); //We prevent the fade-out when Overlay Bar is newly visible while the dashboard SystemUI is being hovered until the pointer leaves that overlay at least once if (is_systemui_hovered) { m_IsSystemUIHoveredFromSwitch = true; } } else { //Fade out Overlay Bar when the dashboard SystemUI is being used as overlay z-order isn't fine-grained enough for it to just work if ( (!m_IsSystemUIHoveredFromSwitch) && (is_systemui_hovered) ) { m_OverlayBarFadeInTick = 0; if (m_SystemUIActiveTick == 0) { m_SystemUIActiveTick = ::GetTickCount64(); } else { unsigned int delay = (m_WindowOverlayBar.IsAnyMenuVisible()) ? 800 : 300; if (m_SystemUIActiveTick + delay < ::GetTickCount64()) { if (m_OvrlOverlayBarAlpha != 0.0f) { m_OvrlOverlayBarAlpha -= ImGui::GetIO().DeltaTime * 12.0f; if (m_OvrlOverlayBarAlpha < 0.0f) m_OvrlOverlayBarAlpha = 0.0f; vr::VROverlay()->SetOverlayAlpha(m_OvrlHandleOverlayBar, m_OvrlOverlayBarAlpha); } else if (vr::VROverlay()->IsOverlayVisible(m_OvrlHandleOverlayBar)) { m_WindowOverlayBar.HideMenus(); vr::VROverlay()->HideOverlay(m_OvrlHandleOverlayBar); //Hide to avoid input flicker } } } } else if (!anti_flicker_moved_any) //Only fade-in again if the dashboard isn't moving around to avoid repeated fades while the dashboard is being dragged { m_SystemUIActiveTick = 0; //Add a small delay before fading in again so the grab handle can potentially be hovered before this happens if ((m_OverlayBarFadeInTick == 0) && (!m_IsSystemUIHoveredFromSwitch)) { m_OverlayBarFadeInTick = ::GetTickCount64(); m_IdleState.AddActiveTime(); } if (m_OverlayBarFadeInTick + 300 < ::GetTickCount64()) { if (m_OvrlOverlayBarAlpha != 1.0f) { m_OvrlOverlayBarAlpha += ImGui::GetIO().DeltaTime * 12.0f; if (m_OvrlOverlayBarAlpha > 1.0f) m_OvrlOverlayBarAlpha = 1.0f; vr::VROverlay()->SetOverlayAlpha(m_OvrlHandleOverlayBar, m_OvrlOverlayBarAlpha); vr::VROverlay()->ShowOverlay(m_OvrlHandleOverlayBar); } else if (!is_systemui_hovered) { m_IsSystemUIHoveredFromSwitch = false; } } } } } else { if (m_OvrlVisible) { if (m_WindowOverlayBar.IsVisible()) { m_WindowOverlayBar.HideMenus(); m_WindowOverlayBar.Hide(); m_IdleState.AddActiveTime(); } else if (!m_WindowOverlayBar.IsVisibleOrFading()) //Wait for window fade-out to finish before hiding the overlay { vr::VROverlay()->HideOverlay(m_OvrlHandleOverlayBar); m_OvrlVisible = false; UpdateOverlayDimming(); } } } } else if (m_OvrlVisible) //Dashboard overlay has gone missing, hide { vr::VROverlay()->HideOverlay(m_OvrlHandleOverlayBar); m_WindowOverlayBar.Hide(); m_OvrlVisible = false; } } void UIManager::UpdateOverlayDrag() { if (m_OverlayDragger.IsDragActive()) { m_OverlayDragger.DragUpdate(); vr::VROverlayHandle_t drag_overlay_handle = m_OverlayDragger.GetDragOverlayHandle(); if (ImGui::IsMouseReleased(ImGuiMouseButton_Left)) { FinishOverlayDrag(); return; } ImGuiIO& io = ImGui::GetIO(); //Wheel input (add distance & add width) float hwheel_abs = fabs(io.MouseWheelH); float ywheel_abs = fabs(io.MouseWheel); //Deadzone if ((hwheel_abs > 0.05f) || (ywheel_abs > 0.05f)) { //Add distance as long as y-delta input is bigger if (hwheel_abs < ywheel_abs) { m_OverlayDragger.DragAddDistance(io.MouseWheel * 0.5f); } else { m_OverlayDragger.DragAddWidth(io.MouseWheelH * -0.15f); } } //Prevent widget input during active drag, except for the keyboard where this doesn't matter and would unfocus active InputTexts if (drag_overlay_handle != m_OvrlHandleKeyboard) { ImGui::BlockWidgetInput(); } } else if (m_OverlayDragger.IsDragGestureActive()) { m_OverlayDragger.DragGestureUpdate(); if (!ImGui::IsMouseDown(ImGuiMouseButton_Right)) { vr::VROverlayHandle_t drag_overlay_handle = m_OverlayDragger.GetDragOverlayHandle(); Matrix4 matrix_relative_offset = m_OverlayDragger.DragGestureFinish(); float new_width = 1.0f; vr::VROverlay()->GetOverlayWidthInMeters(drag_overlay_handle, &new_width); //Store changed transform to the previously dragged overlay handle and update width/size config value if (drag_overlay_handle == m_OvrlHandleSettings) { m_WindowSettings.SetTransform(matrix_relative_offset); } else if (drag_overlay_handle == m_OvrlHandleOverlayProperties) { m_WindowOverlayProperties.SetTransform(matrix_relative_offset); } else if (drag_overlay_handle == m_OvrlHandleKeyboard) { m_VRKeyboard.GetWindow().SetTransform(matrix_relative_offset); m_VRKeyboard.GetWindow().RebaseTransform(); } } else { //Prevent widget input during active drag ImGui::BlockWidgetInput(); } } } void UIManager::StartOverlayDrag(vr::VROverlayHandle_t overlay_handle) { if (overlay_handle == m_OvrlHandleSettings) { m_WindowSettings.StartDrag(); } else if (overlay_handle == m_OvrlHandleOverlayProperties) { m_WindowOverlayProperties.StartDrag(); } else if (overlay_handle == m_OvrlHandleKeyboard) { m_VRKeyboard.GetWindow().StartDrag(); } } void UIManager::FinishOverlayDrag() { vr::VROverlayHandle_t drag_overlay_handle = m_OverlayDragger.GetDragOverlayHandle(); Matrix4 matrix_relative_offset = m_OverlayDragger.DragFinish(); //Store changed transform to the previously dragged overlay handle if (drag_overlay_handle == m_OvrlHandleSettings) { m_WindowSettings.SetTransform(matrix_relative_offset); } else if (drag_overlay_handle == m_OvrlHandleOverlayProperties) { m_WindowOverlayProperties.SetTransform(matrix_relative_offset); } else if (drag_overlay_handle == m_OvrlHandleKeyboard) { m_VRKeyboard.GetWindow().SetTransform(matrix_relative_offset); m_VRKeyboard.GetWindow().RebaseTransform(); } } void UIManager::HighlightOverlay(unsigned int overlay_id) { //Indicate the current overlay by tinting it when hovering the overlay selector if (m_OpenVRLoaded) { static vr::VROverlayHandle_t colored_handle = vr::k_ulOverlayHandleInvalid; vr::VROverlayHandle_t ovrl_handle = OverlayManager::Get().GetConfigData(overlay_id).ConfigHandle[configid_handle_overlay_state_overlay_handle];; //Tint overlay if no other overlay is currently tinted (adds one frame delay on switching but it doesn't really matter) if ( (ovrl_handle != vr::k_ulOverlayHandleInvalid) && (colored_handle == vr::k_ulOverlayHandleInvalid) ) { const OverlayConfigData& data = OverlayManager::Get().GetConfigData((unsigned int)overlay_id); float brightness = lin2log(data.ConfigFloat[configid_float_overlay_brightness]) * data.ConfigFloat[configid_float_overlay_state_brightness_extra_multiplier]; ImVec4 col = ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered); vr::VROverlay()->SetOverlayColor(ovrl_handle, col.x * brightness, col.y * brightness, col.z * brightness); colored_handle = ovrl_handle; } else if ( (colored_handle != vr::k_ulOverlayHandleInvalid) && (colored_handle != ovrl_handle) ) //Remove tint if overlay handle is different or vr::k_ulOverlayHandleInvalid { const OverlayConfigData& data = OverlayManager::Get().GetConfigData(OverlayManager::Get().FindOverlayID(colored_handle)); float brightness = lin2log(data.ConfigFloat[configid_float_overlay_brightness]) * data.ConfigFloat[configid_float_overlay_state_brightness_extra_multiplier]; vr::VROverlay()->SetOverlayColor(colored_handle, brightness, brightness, brightness); colored_handle = vr::k_ulOverlayHandleInvalid; } } } float UIManager::GetOverlayHeight(vr::VROverlayHandle_t overlay_handle) const { //This only checks for overlays that are draggable by the UI float overlay_width = 1.0f; vr::VROverlay()->GetOverlayWidthInMeters(overlay_handle, &overlay_width); const UITexspaceID overlay_texspace = GetTexspaceIDForOverlayHandle(overlay_handle); if (overlay_texspace == ui_texspace_total) { return -1.0f; } const DPRect& rect_tex = UITextureSpaces::Get().GetRect(overlay_texspace); return ((float)rect_tex.GetHeight() / (float)rect_tex.GetWidth()) * overlay_width; } Matrix4 UIManager::GetOverlay2DPointTransform(Vector2 point_2d, vr::VROverlayHandle_t overlay_handle) const { //GetTransformForOverlayCoordinates() appears to be pretty much just offset from the center point of the overlay (well, that is the 0-point for the transform position anyways) //It doesn't account for UV coordinates though, so it can be a bit messy to set up. That's why it's wrapped up for UI overlay usage //The 2D coordinates it expects are also in GL-space (y+ is up) const DPRect& rect_tex = UITextureSpaces::Get().GetRect( GetTexspaceIDForOverlayHandle(overlay_handle) ); float tex_y = UITextureSpaces::Get().GetRect(ui_texspace_total).GetHeight() / 2.0f; //Middle of overlay (UV is unaccounted for, so half of total texture height) tex_y += rect_tex.GetHeight() / 2.0f; //Offset from the middle however, so adding half of the texspace height gets us to the zero top point tex_y -= point_2d.y; //Then we can substract the passed coordinate (not adding as y+ is up) //Now we can get the coordinates as intended vr::HmdMatrix34_t hmd_mat = {}; vr::VROverlay()->GetTransformForOverlayCoordinates(overlay_handle, vr::TrackingUniverseStanding, {rect_tex.GetTL().x + point_2d.x, tex_y}, &hmd_mat); //Returned matrix usually contains dashboard scale, so undo it Vector3 row_1(hmd_mat.m[0][0], hmd_mat.m[1][0], hmd_mat.m[2][0]); Matrix4 mat(hmd_mat); Vector3 pos = mat.getTranslation(); mat.setTranslation({0.0f, 0.0f, 0.0f}); mat.scale(1.0f / row_1.length()); mat.setTranslation(pos); return mat; } void UIManager::TriggerLaserPointerHaptics(vr::VROverlayHandle_t overlay_handle, vr::TrackedDeviceIndex_t device_index) const { if (!m_OpenVRLoaded) return; //Trigger directly when dashboard pointer is active as it's going to be the right device anyways if ( (device_index == vr::k_unTrackedDeviceIndexInvalid) && (vr::IVROverlayEx::IsSystemLaserPointerActive()) ) { vr::VROverlay()->TriggerLaserMouseHapticVibration(overlay_handle, 0.0f, 1.0f, 0.16f); } else //Let dashboard app handle it as we'll need VR Input access { //If no device specified, get the primary laser pointer one if (device_index == vr::k_unTrackedDeviceIndexInvalid) { device_index = ConfigManager::Get().GetPrimaryLaserPointerDevice(); } IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_lpointer_trigger_haptics, device_index); } } ================================================ FILE: src/DesktopPlusUI/UIManager.h ================================================ //Manages the UI state and stuffs //Since this whole thing is the UI, it's the default place for things //Basic ImGui and rendering backend implementation is left out of it, though #pragma once #define NOMINMAX #include #include #include #include #include "openvr.h" #include "Matrices.h" #include "DPRect.h" #include "Logging.h" #include "NotificationIcon.h" #include "OverlayDragger.h" #include "FloatingUI.h" #include "AuxUI.h" #include "VRKeyboard.h" #include "WindowOverlayBar.h" #include "WindowSettings.h" #include "WindowOverlayProperties.h" #include "WindowPerformance.h" //Overlay width definitions #define OVERLAY_WIDTH_METERS_DASHBOARD_UI 2.75f #define OVERLAY_WIDTH_METERS_SETTINGS 1.5f #define OVERLAY_WIDTH_METERS_KEYBOARD 2.75f #define OVERLAY_WIDTH_METERS_AUXUI_DRAG_HINT 0.12f #define OVERLAY_WIDTH_METERS_AUXUI_GAZEFADE_AUTO_HINT 0.75f #define OVERLAY_WIDTH_METERS_AUXUI_WINDOW_SELECT 0.75f #define OVERLAY_WIDTH_METERS_AUXUI_WINDOW_QUICKSTART 0.75f enum UITexspaceID { ui_texspace_total, ui_texspace_overlay_bar, ui_texspace_floating_ui, ui_texspace_settings, ui_texspace_overlay_properties, ui_texspace_keyboard, ui_texspace_performance_monitor, ui_texspace_aux_ui, ui_texspace_MAX }; class UITextureSpaces { private: DPRect m_TexspaceRects[ui_texspace_MAX]; public: static UITextureSpaces& Get(); void Init(bool desktop_mode, bool keyboard_editor_mode); const DPRect& GetRect(UITexspaceID texspace_id) const; ImVec4 GetRectAsVec4(UITexspaceID texspace_id) const; }; static const char* const k_pch_bold_exclamation_mark = "\xE2\x9D\x97"; static const char* const k_pch_degree_symbol = "\xc2\xb0"; class UIManager { public: class IdleState { private: static const unsigned int s_MsBeforeIdle = 1000; //A general 1 second buffer before idling saves us from adding active time for every short animation ULONGLONG m_LastActiveTick = 0; ULONGLONG m_LastCaretTick = 0; POINT m_LastCursorPos{0}; bool m_WasIdleLastFrame = false; LARGE_INTEGER m_TimestepTime{0}; LARGE_INTEGER m_TimestepTicks{0}; void SetLastActiveTick(ULONGLONG value); public: IdleState(); bool ShouldIdle(); int GetFrameSkipValue(); void OnImGuiNewFrame(); void OnWindowMessage(UINT message_id); void OnOpenVREvent(uint32_t event_type); void AddActiveTime(unsigned int ms = s_MsBeforeIdle); void DoIdleTimestep(); }; private: FloatingUI m_FloatingUI; VRKeyboard m_VRKeyboard; AuxUI m_AuxUI; WindowOverlayBar m_WindowOverlayBar; WindowSettings m_WindowSettings; WindowOverlayProperties m_WindowOverlayProperties; WindowPerformance m_WindowPerformance; WindowDesktopMode m_WindowDesktopMode; HWND m_WindowHandle; NotificationIcon m_NotificationIcon; OverlayDragger m_OverlayDragger; Microsoft::WRL::ComPtr m_SharedTextureRef; //Pointer to render target texture, should only be used for calls to SetSharedOverlayTexture() IdleState m_IdleState; int m_RepeatFrame; bool m_DesktopMode; bool m_KeyboardEditorMode; bool m_OpenVRLoaded; //Desktop mode can run with or without OpenVR and we want to avoid needlessly starting up SteamVR bool m_NoRestartOnExit; //Prevent auto-restart when closing from desktop mode while dashboard app is running (i.e. when using troubleshooting buttons) float m_UIScale; ImFont* m_FontCompact; ImFont* m_FontLarge; //Only loaded when the UI scale is set to large bool m_LowCompositorRes; //Set when compositor's resolution is set below 100% during init. The user is warned about this as it affects overlay rendering bool m_LowCompositorQuality; //Set when the compositor's quality setting to set to something other than High or Auto bool m_HasAnyWarning; //Set when there's any warning (by calling UpdateWarningState) vr::EVROverlayError m_OverlayErrorLast; //Last encountered error when adding an overlay (usually just overlay limit exceeded) HRESULT m_WinRTErrorLast; //Last encountered error when a Graphics Capture thread crashed (ideally never happens) bool m_ElevatedTaskSetUp; bool m_ComInitDone; vr::VROverlayHandle_t m_OvrlHandleOverlayBar; vr::VROverlayHandle_t m_OvrlHandleFloatingUI; vr::VROverlayHandle_t m_OvrlHandleSettings; vr::VROverlayHandle_t m_OvrlHandleOverlayProperties; vr::VROverlayHandle_t m_OvrlHandleKeyboard; vr::VROverlayHandle_t m_OvrlHandleAuxUI; vr::VROverlayHandle_t m_OvrlHandleDPlusDashboard; //Cached to minimize FindOverlay() calls vr::VROverlayHandle_t m_OvrlHandleSystemUI; //Cached to minimize FindOverlay() calls bool m_OvrlVisible; float m_OvrlOverlayBarAlpha; ULONGLONG m_SystemUIActiveTick; ULONGLONG m_OverlayBarFadeInTick; bool m_IsSystemUIHoveredFromSwitch; //Set when the dashboard was hovered when dashboard tab was switched to prevent the UI overlay fading out right away bool m_IsDummyOverlayTransformUnstable; //Dimensions of the mirror texture, updated from OpenVR when opening up settings or receiving a resolution update message from the overlay application int m_OvrlPixelWidth; int m_OvrlPixelHeight; unsigned int m_TransformSyncValueCount; float m_TransformSyncValues[16]; //Stores transform sync values until all are set for a full Matrix4 std::vector m_DelayedICPMessages; //Stores ICP messages that need to be delayed for processing within an ImGui frame void DisplayDashboardAppError(const std::string& str); void DisplayInitialSetupNotification(); void SetOverlayInputEnabled(bool is_enabled); UITexspaceID GetTexspaceIDForOverlayHandle(vr::VROverlayHandle_t overlay_handle) const; void HandleOverlayProfileLoadMessage(LPARAM lparam); public: static UIManager* Get(); UIManager(bool desktop_mode, bool keyboard_editor_mode); ~UIManager(); vr::EVRInitError InitOverlay(); void HandleIPCMessage(const MSG& msg, bool handle_delayed = false); //Messages that need processing within an ImGui frame are stored in m_DelayedICPMessages when handle_delayed is false void HandleDelayedIPCMessages(); //Calls HandleIPCMessage() for messages in m_DelayedICPMessages and clears it bool HasDelayedIPCMessages() const; void OnInitDone(); //Finishes up applying things that can only be applied after everything has finished loading void OnExit(); void OnProfileLoaded(); FloatingUI& GetFloatingUI(); VRKeyboard& GetVRKeyboard(); AuxUI& GetAuxUI(); WindowOverlayBar& GetOverlayBarWindow(); WindowSettings& GetSettingsWindow(); WindowOverlayProperties& GetOverlayPropertiesWindow(); WindowPerformance& GetPerformanceWindow(); WindowDesktopMode& GetDesktopModeWindow(); void SetWindowHandle(HWND handle); HWND GetWindowHandle() const; NotificationIcon& GetNotificationIcon(); void SetSharedTextureRef(ID3D11Resource* ref); ID3D11Resource* GetSharedTextureRef() const; OverlayDragger& GetOverlayDragger(); vr::VROverlayHandle_t GetOverlayHandleOverlayBar() const; vr::VROverlayHandle_t GetOverlayHandleFloatingUI() const; vr::VROverlayHandle_t GetOverlayHandleSettings() const; vr::VROverlayHandle_t GetOverlayHandleOverlayProperties() const; vr::VROverlayHandle_t GetOverlayHandleKeyboard() const; vr::VROverlayHandle_t GetOverlayHandleAuxUI() const; vr::VROverlayHandle_t GetOverlayHandleDPlusDashboard() const; vr::VROverlayHandle_t GetOverlayHandleSystemUI() const; std::array GetUIOverlayHandles() const; bool IsDummyOverlayTransformUnstable() const; void SendUIIntersectionMaskToDashboardApp(std::vector& primitives) const; IdleState& GetIdleState(); DPRect CalcRectForActiveTexspace(); //This can be called by functions knowingly making changes which will cause visible layout re-alignment due to ImGui's nature of intermediate UI //This will cause 2 extra frames to be calculated but thrown away instantly to be more pleasing to the eye. In rare cases more are needed and can be specified instead void RepeatFrame(int extra_frame_count = 2); bool GetRepeatFrame() const; void DecreaseRepeatFrameCount(); bool IsInDesktopMode() const; bool IsInKeyboardEditorMode() const; bool IsOpenVRLoaded() const; void DisableRestartOnExit(); void Restart(bool desktop_mode); void RestartIntoKeyboardEditor(); void RestartDashboardApp(bool force_steam = false); void ElevatedModeEnter(); void ElevatedModeLeave(); void UpdateStyle(); void SetUIScale(float scale); float GetUIScale() const; void SetFonts(ImFont* font_compact, ImFont* font_large); ImFont* GetFontCompact() const; ImFont* GetFontLarge() const; //May return nullptr void AddFontBuilderStringIfAnyUnmappedCharacters(const char* str); //Checks if string has unmapped characters and schedules a texture refresh to load them on the next frame void OnDPIChanged(int new_dpi, const RECT& new_window_rect); void OnTranslationChanged(); //Calls functions in several classes to reset translation-dependent cached strings. Called when translation is changed void OnOverlayNameChanged(); //Calls functions in several classes to reset overlay-name-dependent cached strings. Called when overlay names changed void UpdateOverlayDimming(); bool IsCompositorResolutionLow() const; bool IsCompositorRenderQualityLow() const; void UpdateCompositorRenderQualityLow(); bool IsAnyWarningDisplayed() const; void UpdateAnyWarningDisplayedState(); vr::EVROverlayError GetOverlayErrorLast() const; HRESULT GetWinRTErrorLast() const; void ResetOverlayErrorLast(); void ResetWinRTErrorLast(); bool IsElevatedTaskSetUp() const; void TryChangingWindowFocus() const; bool IsOverlayBarOverlayVisible() const; void GetDesktopOverlayPixelSize(int& width, int& height) const; void UpdateDesktopOverlayPixelSize(); void PositionOverlay(); void UpdateOverlayDrag(); void StartOverlayDrag(vr::VROverlayHandle_t overlay_handle); void FinishOverlayDrag(); void HighlightOverlay(unsigned int overlay_id); float GetOverlayHeight(vr::VROverlayHandle_t overlay_handle) const; Matrix4 GetOverlay2DPointTransform(Vector2 point_2d, vr::VROverlayHandle_t overlay_handle) const; //GetTransformForOverlayCoordinates() but works with cropped UVs (UI overlays only) //Invalid device index triggers on current primary device void TriggerLaserPointerHaptics(vr::VROverlayHandle_t overlay_handle, vr::TrackedDeviceIndex_t device_index = vr::k_unTrackedDeviceIndexInvalid) const; }; ================================================ FILE: src/DesktopPlusUI/VRKeyboard.cpp ================================================ #include "VRKeyboard.h" #include #include "UIManager.h" #include "InterprocessMessaging.h" #include "Util.h" #include "Ini.h" #include "DPBrowserAPIClient.h" #include "imgui_internal.h" #include "imgui_impl_win32_openvr.h" static const char* const g_KeyboardSublayoutNames[kbdlayout_sub_MAX] = {"Base", "Shift", "AltGr", "Aux"}; static const char* const g_KeyboardClusterNames[kbdlayout_cluster_MAX] = {"Base", "Function", "Navigation", "Numpad", "Extra"}; static const char* const g_KeyboardKeyTypeNames[kbdlayout_key_MAX] = {"Blank", "VirtualKey", "VirtualKeyToggle", "VirtualKeyIsoEnter", "String", "SubLayoutToggle", "Action"}; VRKeyboard::VRKeyboard() : m_InputTarget(kbdtarget_desktop), m_InputTargetOverlayID(k_ulOverlayID_None), m_CapsLockToggled(false), m_ActiveInputText(0), m_InputBeginWidgetID(0), m_ShortcutWindowDirHint(ImGuiDir_Down), m_ShortcutWindowYOffset(0.0f), m_ActiveInputTextIsMultiline(false), m_MouseLeftDownPrevCached(false), m_MouseLeftClickedPrevCached(false), m_KeyboardHiddenLastFrame(false) { std::fill_n(m_KeyDown, IM_ARRAYSIZE(m_KeyDown), 0); } unsigned char VRKeyboard::GetModifierFlags() const { unsigned char flags = 0; if (m_KeyDown[VK_LSHIFT]) { flags |= kbd_keystate_flag_lshift_down; } if (m_KeyDown[VK_RSHIFT]) { flags |= kbd_keystate_flag_rshift_down; } if (m_KeyDown[VK_LCONTROL]) { flags |= kbd_keystate_flag_lctrl_down; } if (m_KeyDown[VK_RCONTROL]) { flags |= kbd_keystate_flag_rctrl_down; } if (m_KeyDown[VK_LMENU]) { flags |= kbd_keystate_flag_lalt_down; } if (m_KeyDown[VK_RMENU]) { flags |= (m_LayoutMetadata.HasAltGr) ? (kbd_keystate_flag_ralt_down | kbd_keystate_flag_lctrl_down) : kbd_keystate_flag_ralt_down; } if (m_CapsLockToggled) { flags |= kbd_keystate_flag_capslock_toggled; } return flags; } vr::VROverlayHandle_t VRKeyboard::GetTargetOverlayHandle() const { if (m_InputTargetOverlayID != k_ulOverlayID_None) { return OverlayManager::Get().GetConfigData(m_InputTargetOverlayID).ConfigHandle[configid_handle_overlay_state_overlay_handle]; } return vr::k_ulOverlayHandleInvalid; } WindowKeyboard& VRKeyboard::GetWindow() { return m_WindowKeyboard; } KeyboardEditor& VRKeyboard::GetEditor() { return m_KeyboardEditor; } void VRKeyboard::LoadLayoutFromFile(const std::string& filename) { std::string fullpath = ConfigManager::Get().GetApplicationPath() + "keyboards/" + filename; Ini layout_file( WStringConvertFromUTF8(fullpath.c_str()).c_str() ); //Check if it's probably a keyboard layout file if (layout_file.SectionExists("LayoutInfo")) { //Clear old layout data ResetState(); for (auto& sublayout : m_KeyboardKeys) { sublayout.clear(); } m_KeyLabels = ""; //Load new layout m_LayoutMetadata = LoadLayoutMetadataFromFile(filename); const bool keyboard_editor_mode = UIManager::Get()->IsInKeyboardEditorMode(); //Always load all clusters when in Keyboard Editor mode const bool cluster_enabled[kbdlayout_cluster_MAX] = { true, (ConfigManager::GetValue(configid_bool_input_keyboard_cluster_function_enabled) || keyboard_editor_mode), (ConfigManager::GetValue(configid_bool_input_keyboard_cluster_navigation_enabled) || keyboard_editor_mode), (ConfigManager::GetValue(configid_bool_input_keyboard_cluster_numpad_enabled) || keyboard_editor_mode), (ConfigManager::GetValue(configid_bool_input_keyboard_cluster_extra_enabled) || keyboard_editor_mode) }; unsigned int sublayout_id = kbdlayout_sub_base; unsigned int row_id = 0; unsigned int key_id = 0; std::string key_type_str; std::string key_cluster_str; std::string key_sublayout_toggle_str; m_KeyLabels = ""; while (true) { std::stringstream key_section; key_section << "Key_" << g_KeyboardSublayoutNames[sublayout_id] << "_Row_" << row_id << "_ID_" << key_id; if (layout_file.SectionExists(key_section.str().c_str())) { //Key cluster key_cluster_str = layout_file.ReadString(key_section.str().c_str(), "Cluster", "Base"); //Match cluster string and skip if the cluster has been disabled bool skip_key = false; size_t key_cluster_i = 0; for (key_cluster_i = 0; key_cluster_i < kbdlayout_cluster_MAX; ++key_cluster_i) { if (key_cluster_str == g_KeyboardClusterNames[key_cluster_i]) { if (!cluster_enabled[key_cluster_i]) { skip_key = true; } break; } } if (skip_key) { key_id++; continue; } KeyboardLayoutKey key; //Key cluster key.KeyCluster = (KeyboardLayoutCluster)key_cluster_i; //Key type key_type_str = layout_file.ReadString(key_section.str().c_str(), "Type", "Blank"); if (key_type_str == "Blank") { key.KeyType = kbdlayout_key_blank_space; } else if (key_type_str == "VirtualKey") { key.KeyType = kbdlayout_key_virtual_key; key.KeyCode = layout_file.ReadInt(key_section.str().c_str(), "KeyCode", 0); key.BlockModifiers = layout_file.ReadBool(key_section.str().c_str(), "BlockModifiers", false); } else if (key_type_str == "VirtualKeyToggle") { key.KeyType = kbdlayout_key_virtual_key_toggle; key.KeyCode = layout_file.ReadInt(key_section.str().c_str(), "KeyCode", 0); } else if (key_type_str == "VirtualKeyIsoEnter") { key.KeyType = kbdlayout_key_virtual_key_iso_enter; key.KeyCode = layout_file.ReadInt(key_section.str().c_str(), "KeyCode", 0); } else if (key_type_str == "String") { key.KeyType = kbdlayout_key_string; key.KeyString = layout_file.ReadString(key_section.str().c_str(), "String"); } else if (key_type_str == "SubLayoutToggle") { key.KeyType = kbdlayout_key_sublayout_toggle; key_sublayout_toggle_str = layout_file.ReadString(key_section.str().c_str(), "SubLayout", "Base"); //Match sublayout string for (size_t i = 0; i < kbdlayout_sub_MAX; ++i) { if (key_sublayout_toggle_str == g_KeyboardSublayoutNames[i]) { key.KeySubLayoutToggle = (KeyboardLayoutSubLayout)i; break; } } } else if (key_type_str == "Action") { key.KeyType = kbdlayout_key_action; key.KeyActionUID = std::strtoull(layout_file.ReadString(key_section.str().c_str(), "ActionUID", "0").c_str(), nullptr, 10); } //General key.Width = layout_file.ReadInt(key_section.str().c_str(), "Width", 100) / 100.0f; key.Height = layout_file.ReadInt(key_section.str().c_str(), "Height", 100) / 100.0f; key.Label = layout_file.ReadString(key_section.str().c_str(), "Label"); key.NoRepeat = layout_file.ReadBool(key_section.str().c_str(), "NoRepeat", false); StringReplaceAll(key.Label, "\\n", "\n"); m_KeyLabels += key.Label; //We cache whether the label is multi-line to avoid calling the more complex label functions every frame for 100+ keys that won't need it key.IsLabelMultiline = (key.Label.find('\n') != std::string::npos); //For non-multi-line labels pre-parse possible alignment commands in the label string if (!key.IsLabelMultiline) { size_t pos = key.Label.find("##"); key.LabelHAlignment = (key.Label.find('L', pos) != std::string::npos) ? 0.0f : ((key.Label.find('R', pos) != std::string::npos) ? 1.0f : 0.5f); } m_KeyboardKeys[sublayout_id].push_back(key); key_id++; } else if (key_id == 0) //No more keys in sublayout { sublayout_id++; //Try next sublayout row_id = 0; if (sublayout_id == kbdlayout_sub_MAX) { break; //No more possible sublayouts, we're done here } } else //Try next row { //Mark last key as end of row if (!m_KeyboardKeys[sublayout_id].empty()) { m_KeyboardKeys[sublayout_id].back().IsRowEnd = true; } row_id++; key_id = 0; } } //Reload texture to update font atlas with keyboard chars if (ImGui::StringContainsUnmappedCharacter(m_KeyLabels.c_str())) { TextureManager::Get().ReloadAllTexturesLater(); UIManager::Get()->RepeatFrame(); } //Show keyboard again if it's visible to refresh title that may have been cut off before if (m_WindowKeyboard.IsVisible()) { m_WindowKeyboard.Show(); } UIManager::Get()->RepeatFrame(); } } bool VRKeyboard::SaveCurrentLayoutToFile(const std::string& filename) { m_LayoutMetadata.FileName = filename; std::string fullpath = ConfigManager::Get().GetApplicationPath() + "keyboards/" + filename; std::wstring wpath = WStringConvertFromUTF8(fullpath.c_str()); //Update cluster availability metadata for (int i_sublayout = kbdlayout_sub_base; i_sublayout < kbdlayout_sub_MAX; ++i_sublayout) { KeyboardLayoutSubLayout sublayout = (KeyboardLayoutSubLayout)i_sublayout; for (const KeyboardLayoutKey& key : m_KeyboardKeys[sublayout]) { m_LayoutMetadata.HasCluster[key.KeyCluster] = true; } } Ini layout_file(wpath.c_str(), true); //Write metadata layout_file.WriteString("LayoutInfo", "Name", m_LayoutMetadata.Name.c_str()); layout_file.WriteString("LayoutInfo", "Author", m_LayoutMetadata.Author.c_str()); layout_file.WriteBool( "LayoutInfo", "HasAltGr", m_LayoutMetadata.HasAltGr); layout_file.WriteBool( "LayoutInfo", "HasClusterFunction", m_LayoutMetadata.HasCluster[kbdlayout_cluster_function]); layout_file.WriteBool( "LayoutInfo", "HasClusterNavigation", m_LayoutMetadata.HasCluster[kbdlayout_cluster_navigation]); layout_file.WriteBool( "LayoutInfo", "HasClusterNumpad", m_LayoutMetadata.HasCluster[kbdlayout_cluster_numpad]); layout_file.WriteBool( "LayoutInfo", "HasClusterExtra", m_LayoutMetadata.HasCluster[kbdlayout_cluster_extra]); for (int i_sublayout = kbdlayout_sub_base; i_sublayout < kbdlayout_sub_MAX; ++i_sublayout) { KeyboardLayoutSubLayout sublayout = (KeyboardLayoutSubLayout)i_sublayout; unsigned int row_id = 0; unsigned int key_id = 0; for (const KeyboardLayoutKey& key : m_KeyboardKeys[sublayout]) { std::stringstream key_section; key_section << "Key_" << g_KeyboardSublayoutNames[sublayout] << "_Row_" << row_id << "_ID_" << key_id; //Key type layout_file.WriteString(key_section.str().c_str(), "Type", g_KeyboardKeyTypeNames[key.KeyType]); //General if (key.Width != 1.0f) { layout_file.WriteInt(key_section.str().c_str(), "Width", int(key.Width * 100.0f)); } if (key.Height != 1.0f) { layout_file.WriteInt(key_section.str().c_str(), "Height", int(key.Height * 100.0f)); } if (key.KeyType != kbdlayout_key_blank_space) { std::string label_escaped = key.Label; StringReplaceAll(label_escaped, "\n", "\\n"); layout_file.WriteString(key_section.str().c_str(), "Label", label_escaped.c_str()); } if (key.KeyCluster != kbdlayout_cluster_base) { layout_file.WriteString(key_section.str().c_str(), "Cluster", g_KeyboardClusterNames[key.KeyCluster]); } //Key type specific values switch (key.KeyType) { case kbdlayout_key_virtual_key: case kbdlayout_key_virtual_key_toggle: case kbdlayout_key_virtual_key_iso_enter: { layout_file.WriteInt( key_section.str().c_str(), "KeyCode", key.KeyCode); if ((key.KeyType == kbdlayout_key_virtual_key) && (key.BlockModifiers)) { layout_file.ReadBool(key_section.str().c_str(), "BlockModifiers", true); } break; } case kbdlayout_key_string: { layout_file.WriteString(key_section.str().c_str(), "String", key.KeyString.c_str()); break; } case kbdlayout_key_sublayout_toggle: { layout_file.WriteString(key_section.str().c_str(), "SubLayout", g_KeyboardSublayoutNames[key.KeySubLayoutToggle]); break; } case kbdlayout_key_action: { layout_file.WriteString(key_section.str().c_str(), "ActionUID", std::to_string(key.KeyActionUID).c_str()); break; } } if (key.NoRepeat) { layout_file.WriteBool(key_section.str().c_str(), "NoRepeat", true); } if (key.IsRowEnd) { row_id++; key_id = 0; } else { key_id++; } } } return layout_file.Save(); } void VRKeyboard::LoadCurrentLayout() { LoadLayoutFromFile(ConfigManager::GetValue(configid_str_input_keyboard_layout_file)); } std::vector VRKeyboard::GetKeyboardLayoutList() { std::vector layout_list; const std::wstring wpath = WStringConvertFromUTF8( std::string(ConfigManager::Get().GetApplicationPath() + "keyboards/*.ini").c_str() ); WIN32_FIND_DATA find_data; HANDLE handle_find = ::FindFirstFileW(wpath.c_str(), &find_data); if (handle_find != INVALID_HANDLE_VALUE) { do { KeyboardLayoutMetadata metadata = LoadLayoutMetadataFromFile( StringConvertFromUTF16(find_data.cFileName) ); //If base cluster exists, layout is probably valid, add to list if (metadata.HasCluster[kbdlayout_cluster_base]) { layout_list.push_back(metadata); } } while (::FindNextFileW(handle_find, &find_data) != 0); ::FindClose(handle_find); } return layout_list; } const KeyboardLayoutMetadata& VRKeyboard::GetLayoutMetadata() const { return m_LayoutMetadata; } void VRKeyboard::SetLayoutMetadata(const KeyboardLayoutMetadata& metadata) { m_LayoutMetadata = metadata; } std::vector& VRKeyboard::GetLayout(KeyboardLayoutSubLayout sublayout) { return m_KeyboardKeys[sublayout]; } void VRKeyboard::SetLayout(KeyboardLayoutSubLayout sublayout, std::vector& keys) { m_KeyboardKeys[sublayout] = keys; } const std::string& VRKeyboard::GetKeyLabelsString() const { return m_KeyLabels; } KeyboardInputTarget VRKeyboard::GetInputTarget() const { return m_InputTarget; } unsigned int VRKeyboard::GetInputTargetOverlayID() const { return m_InputTargetOverlayID; } bool VRKeyboard::GetKeyDown(unsigned char keycode) const { return m_KeyDown[keycode]; } void VRKeyboard::SetKeyDown(unsigned char keycode, bool down, bool block_modifiers) { //Don't do anything if the key state didn't change if (m_KeyDown[keycode] == down) return; m_KeyDown[keycode] = down; //Update combined modifier key state if relevant if ((keycode == VK_LSHIFT) || (keycode == VK_RSHIFT)) { m_KeyDown[VK_SHIFT] = (m_KeyDown[VK_LSHIFT] || m_KeyDown[VK_RSHIFT]); if (m_InputTarget == kbdtarget_ui) { ImGui::GetIO().AddKeyEvent(ImGuiMod_Shift, m_KeyDown[VK_SHIFT]); } } else if ((keycode == VK_LCONTROL) || (keycode == VK_RCONTROL)) { m_KeyDown[VK_CONTROL] = (m_KeyDown[VK_LCONTROL] || m_KeyDown[VK_RCONTROL]); if (m_InputTarget == kbdtarget_ui) { ImGui::GetIO().AddKeyEvent(ImGuiMod_Ctrl, m_KeyDown[VK_CONTROL]); } } else if ((keycode == VK_LMENU) || (keycode == VK_RMENU)) { m_KeyDown[VK_MENU] = (m_KeyDown[VK_LMENU] || m_KeyDown[VK_RMENU]); if (m_InputTarget == kbdtarget_ui) { ImGui::GetIO().AddKeyEvent(ImGuiMod_Alt, m_KeyDown[VK_MENU]); } } else if ( (down) && (keycode == VK_CAPITAL) ) //For caps lock, update toggled state { m_CapsLockToggled = !m_CapsLockToggled; } if (m_InputTarget == kbdtarget_overlay) { //Send keystate message (additional wchar message is sent below) unsigned char flags = (down) ? GetModifierFlags() | kbd_keystate_flag_key_down : GetModifierFlags(); DPBrowserAPIClient::Get().DPBrowser_KeyboardSetKeyState(GetTargetOverlayHandle(), (DPBrowserIPCKeyboardKeystateFlags)flags, keycode); } if (m_InputTarget != kbdtarget_desktop) { ImGui::GetIO().AddKeyEvent(ImGui_ImplWin32_KeyEventToImGuiKey(keycode, 0), down); //Get text output for current state and key if ((down) && (keycode != VK_BACK) && (keycode != VK_TAB)) { //Win32 keyboard state for ToUnicode() BYTE keyboard_state[256] = {0}; keyboard_state[VK_SHIFT] = (m_KeyDown[VK_SHIFT]) ? -1 : 0; keyboard_state[VK_CONTROL] = (m_KeyDown[VK_CONTROL]) ? -1 : 0; keyboard_state[VK_MENU] = (m_KeyDown[VK_MENU]) ? -1 : 0; keyboard_state[VK_CAPITAL] = (m_CapsLockToggled) ? 1 : 0; //Key toggle state is high-order bit keyboard_state[keycode] = -1; WCHAR key_wchars[16] = {0}; int wchars_written = ::ToUnicode(keycode, ::MapVirtualKey(keycode, MAPVK_VK_TO_VSC), keyboard_state, key_wchars, 15, 0); if (wchars_written > 0) { //Documentation of ToUnicode() suggests there may be invalid characters in the buffer past the written ones if the return value is higher than 1 //One would like to believe the function NUL-terminates at that point, but there's no guarantee for that if (wchars_written > 1) { key_wchars[std::min(wchars_written, 15)] = '\0'; } if (m_InputTarget == kbdtarget_ui) { AddTextToStringQueue(StringConvertFromUTF16(key_wchars)); } else if (m_InputTarget == kbdtarget_overlay) { DPBrowserAPIClient::Get().DPBrowser_KeyboardTypeString(GetTargetOverlayHandle(), StringConvertFromUTF16(key_wchars)); } } } } else { if (block_modifiers) { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_keyboard_vkey, MAKELPARAM((down) ? kbd_keystate_flag_key_down : 0, 0)); //Press key without modifiers IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_keyboard_vkey, MAKELPARAM(GetModifierFlags(), 0)); //Restore old modifier state } else { unsigned char flags = (down) ? GetModifierFlags() | kbd_keystate_flag_key_down : GetModifierFlags(); IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_keyboard_vkey, MAKELPARAM(flags, keycode)); } } } void VRKeyboard::SetStringDown(const std::string text, bool down) { if (m_InputTarget == kbdtarget_ui) { if (down) { AddTextToStringQueue(text); } return; } std::wstring wstr = WStringConvertFromUTF8(text.c_str()); if (m_InputTarget == kbdtarget_desktop) { //If it's a single character, send as wchar so it checks if it can be pressed on the current windows keyboard layout if (wstr.length() == 1) { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_keyboard_wchar, MAKELPARAM(wstr[0], down)); if (!down) { RestoreDesktopModifierState(); } } else if (!down) //Otherwise, send as string input { IPCManager::Get().SendStringToDashboardApp(configid_str_state_keyboard_string, text, UIManager::Get()->GetWindowHandle()); } } else if (m_InputTarget == kbdtarget_overlay) { //If it's a single character, send as wchar so it checks if it can be pressed on the current windows keyboard layout if (wstr.length() == 1) { DPBrowserAPIClient::Get().DPBrowser_KeyboardTypeWChar(GetTargetOverlayHandle(), wstr[0], down); } else if (!down) //Otherwise, send as string input { DPBrowserAPIClient::Get().DPBrowser_KeyboardTypeString(GetTargetOverlayHandle(), StringConvertFromUTF16(wstr.c_str())); } } } void VRKeyboard::SetActionDown(ActionUID action_uid, bool down) { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, (down) ? ipcact_action_start : ipcact_action_stop, action_uid); } bool VRKeyboard::IsCapsLockToggled() const { return m_CapsLockToggled; } void VRKeyboard::ResetState() { //Release any held down keys for (int i = 0; i < 256; ++i) { if (m_KeyDown[i]) { SetKeyDown(i, false); } } if (m_CapsLockToggled) { SetKeyDown(VK_CAPITAL, true); SetKeyDown(VK_CAPITAL, false); } m_StringQueue = {}; //Clear m_WindowKeyboard.ResetButtonState(); } void VRKeyboard::VRKeyboardInputBegin(const char* str_id, bool is_multiline) { VRKeyboardInputBegin(ImGui::GetID(str_id), is_multiline); } void VRKeyboard::VRKeyboardInputBegin(ImGuiID widget_id, bool is_multiline) { ImGuiContext& g = *GImGui; ImGuiIO& io = ImGui::GetIO(); if (m_ActiveInputText == widget_id) { if ((io.InputQueueCharacters.empty()) && (!m_StringQueue.empty())) { io.AddInputCharactersUTF8(m_StringQueue.front().c_str()); m_StringQueue.pop(); } m_ActiveInputTextIsMultiline = is_multiline; } m_MouseLeftDownPrevCached = io.MouseDown[ImGuiMouseButton_Left]; m_MouseLeftClickedPrevCached = io.MouseClicked[ImGuiMouseButton_Left]; if ( (m_WindowKeyboard.IsHovered()) || (m_WindowKeyboardShortcuts.IsHovered()) ) { io.MouseDown[ImGuiMouseButton_Left] = false; io.MouseClicked[ImGuiMouseButton_Left] = false; } //Set mouse delta to 0 when keyboard shortcut window buttons are down in order to prevent the InputText's selection to change from cursor movement if (m_WindowKeyboardShortcuts.IsAnyButtonDown()) { io.MouseDelta.x = 0.0f; io.MouseDelta.y = 0.0f; } m_InputBeginWidgetID = widget_id; } void VRKeyboard::VRKeyboardInputEnd() { ImGuiIO& io = ImGui::GetIO(); ImGuiID widget_id = m_InputBeginWidgetID; if (ImGui::IsItemActivated()) { m_ActiveInputText = widget_id; } else if ((m_ActiveInputText == widget_id) && (ImGui::IsItemDeactivated())) { m_ActiveInputText = 0; } if ( (m_ActiveInputText == widget_id) && ( (ImGui::IsKeyPressed(ImGuiKey_Tab)) || (ImGui::IsKeyPressed(ImGuiKey_Escape)) || ((!m_ActiveInputTextIsMultiline) && (ImGui::IsKeyPressed(ImGuiKey_Enter))) ) ) { ImGui::ClearActiveID(); m_ActiveInputText = 0; UIManager::Get()->RepeatFrame(); } if ( (m_ActiveInputText == widget_id) && (!ImGui::IsItemHovered()) && (ImGui::IsItemActive()) && (ImGui::IsMouseClicked(ImGuiMouseButton_Left)) && (!m_WindowKeyboard.IsHovered()) && (!m_WindowKeyboardShortcuts.IsHovered()) ) { ImGui::ClearActiveID(); m_ActiveInputText = 0; io.MouseDownDuration[ImGuiMouseButton_Left] = -1.0f; //Reset mouse down duration so the click counts as newly pressed again in the next frame UIManager::Get()->RepeatFrame(); } //Restore mouse down in case modified in VRKeyboardInputBegin() io.MouseDown[ImGuiMouseButton_Left] = m_MouseLeftDownPrevCached; io.MouseClicked[ImGuiMouseButton_Left] = m_MouseLeftClickedPrevCached; if (!UIManager::Get()->IsInDesktopMode()) { //Set active widget for keyboard shortcuts window if there's actually active text input (m_ActiveInputText may be a slider for example) if ((m_ActiveInputText == widget_id) && (io.WantTextInput)) { m_WindowKeyboardShortcuts.SetActiveWidget(m_ActiveInputText); m_WindowKeyboardShortcuts.SetDefaultPositionDirection(m_ShortcutWindowDirHint, m_ShortcutWindowYOffset); } else if (m_ActiveInputText == 0) { m_WindowKeyboardShortcuts.SetActiveWidget(0); } m_WindowKeyboardShortcuts.Update(widget_id); //This is called regardless of the widget being active in case a fade-out is still happening } m_InputBeginWidgetID = 0; m_ShortcutWindowDirHint = ImGuiDir_Down; m_ShortcutWindowYOffset = 0.0f; } void VRKeyboard::OnImGuiNewFrame() { if (UIManager::Get()->IsInDesktopMode()) return; ImGuiIO& io = ImGui::GetIO(); //Show keyboard for UI if needed if (io.WantTextInput) { if ( (!m_KeyboardHiddenLastFrame) && ( (m_InputTarget != kbdtarget_ui) || (!m_WindowKeyboard.IsVisible()) ) ) { m_InputTarget = kbdtarget_ui; bool do_assign_to_ui = false; int assigned_id = m_WindowKeyboard.GetAssignedOverlayID(); //Assign keyboard to UI if it's not assigned to any overlay yet if (assigned_id == -1) { do_assign_to_ui = true; } else if (assigned_id >= 0) //else do it if the assigned overlay is invisible { vr::VROverlayHandle_t ovrl_handle_assigned = OverlayManager::Get().GetConfigData((unsigned int)assigned_id).ConfigHandle[configid_handle_overlay_state_overlay_handle]; do_assign_to_ui = !vr::VROverlay()->IsOverlayVisible(ovrl_handle_assigned); } if (do_assign_to_ui) { m_WindowKeyboard.SetAutoVisibility(-2, true); } m_WindowKeyboard.Show(); } } else if (m_WindowKeyboard.IsVisible()) { int assigned_id = m_WindowKeyboard.GetAssignedOverlayID(); //Disable UI target if it's active if (m_InputTarget == kbdtarget_ui) { ResetState(); m_InputTarget = kbdtarget_desktop; m_InputTargetOverlayID = k_ulOverlayID_None; m_WindowKeyboard.Show(); //Show() updates window title } //If keyboard is visible for the UI, turn off auto-visibility if (assigned_id == -2) { m_WindowKeyboard.SetAutoVisibility(-2, false); } //Check if overlay target should be used int focused_overlay_id = ConfigManager::Get().GetValue(configid_int_state_overlay_focused_id); OverlayCaptureSource capsource = ovrl_capsource_desktop_duplication; if (focused_overlay_id >= 0) { capsource = (OverlayCaptureSource)OverlayManager::Get().GetConfigData((unsigned int)focused_overlay_id).ConfigInt[configid_int_overlay_capture_source]; } if ( (m_InputTarget == kbdtarget_overlay) && (capsource != ovrl_capsource_browser) ) { ResetState(); m_InputTarget = kbdtarget_desktop; m_InputTargetOverlayID = k_ulOverlayID_None; m_WindowKeyboard.Show(); //Show() updates window title } else if ( (m_InputTargetOverlayID != (unsigned int)focused_overlay_id) && (capsource == ovrl_capsource_browser) ) //Also resets state when overlay ID changes { ResetState(); m_InputTarget = kbdtarget_overlay; m_InputTargetOverlayID = (unsigned int)focused_overlay_id; m_WindowKeyboard.Show(); //Show() updates window title } } m_KeyboardHiddenLastFrame = false; if (m_InputTarget == kbdtarget_ui) { UpdateImGuiModifierState(); } } void VRKeyboard::OnWindowHidden() { ImGuiIO& io = ImGui::GetIO(); if (io.WantTextInput) { ImGui::ClearActiveID(); m_ActiveInputText = 0; io.WantTextInput = false; } m_KeyboardHiddenLastFrame = true; //Widgets will request the keyboard for the next frame anyways, so we prevent showing it again right away with this flag } void VRKeyboard::AddTextToStringQueue(const std::string text) { //Only queue up if an InputText is focused if (m_ActiveInputText != 0) { m_StringQueue.push(text); } } void VRKeyboard::UpdateImGuiModifierState() const { ImGuiIO& io = ImGui::GetIO(); io.KeyCtrl = m_KeyDown[VK_CONTROL]; io.KeyShift = m_KeyDown[VK_SHIFT]; io.KeyAlt = m_KeyDown[VK_MENU]; io.KeySuper = (m_KeyDown[VK_LWIN] || m_KeyDown[VK_RWIN]); } void VRKeyboard::RestoreDesktopModifierState() const { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_keyboard_vkey, MAKELPARAM(GetModifierFlags(), 0)); } void VRKeyboard::SetShortcutWindowDirectionHint(ImGuiDir dir_hint, float y_offset) { m_ShortcutWindowDirHint = dir_hint; m_ShortcutWindowYOffset = y_offset; } KeyboardLayoutMetadata VRKeyboard::LoadLayoutMetadataFromFile(const std::string& filename) { KeyboardLayoutMetadata metadata; std::string fullpath = ConfigManager::Get().GetApplicationPath() + "keyboards/" + filename; Ini layout_file( WStringConvertFromUTF8(fullpath.c_str()).c_str() ); if (layout_file.SectionExists("LayoutInfo")) { metadata.Name = layout_file.ReadString("LayoutInfo", "Name"); metadata.Author = layout_file.ReadString("LayoutInfo", "Author"); metadata.FileName = filename; metadata.HasCluster[kbdlayout_cluster_base] = true; //Always true for valid layouts metadata.HasCluster[kbdlayout_cluster_function] = layout_file.ReadBool("LayoutInfo", "HasClusterFunction"); metadata.HasCluster[kbdlayout_cluster_navigation] = layout_file.ReadBool("LayoutInfo", "HasClusterNavigation"); metadata.HasCluster[kbdlayout_cluster_numpad] = layout_file.ReadBool("LayoutInfo", "HasClusterNumpad"); metadata.HasCluster[kbdlayout_cluster_extra] = layout_file.ReadBool("LayoutInfo", "HasClusterExtra"); metadata.HasAltGr = layout_file.ReadBool("LayoutInfo", "HasAltGr"); } return metadata; } ================================================ FILE: src/DesktopPlusUI/VRKeyboard.h ================================================ #pragma once #include "VRKeyboardCommon.h" #include "WindowKeyboard.h" #include "WindowKeyboardEditor.h" #include #include #include class VRKeyboard { private: WindowKeyboard m_WindowKeyboard; WindowKeyboardShortcuts m_WindowKeyboardShortcuts; KeyboardEditor m_KeyboardEditor; KeyboardLayoutMetadata m_LayoutMetadata; std::vector m_KeyboardKeys[kbdlayout_sub_MAX]; std::string m_KeyLabels; //String containing all labels, so their characters are always loaded from the font KeyboardInputTarget m_InputTarget; unsigned int m_InputTargetOverlayID; bool m_KeyDown[256]; bool m_CapsLockToggled; std::queue m_StringQueue; ImGuiID m_ActiveInputText; ImGuiID m_InputBeginWidgetID; ImGuiDir m_ShortcutWindowDirHint; float m_ShortcutWindowYOffset; bool m_ActiveInputTextIsMultiline; bool m_MouseLeftDownPrevCached; bool m_MouseLeftClickedPrevCached; bool m_KeyboardHiddenLastFrame; unsigned char GetModifierFlags() const; vr::VROverlayHandle_t GetTargetOverlayHandle() const; public: VRKeyboard(); WindowKeyboard& GetWindow(); KeyboardEditor& GetEditor(); void LoadLayoutFromFile(const std::string& filename); bool SaveCurrentLayoutToFile(const std::string& filename); void LoadCurrentLayout(); static std::vector GetKeyboardLayoutList(); const KeyboardLayoutMetadata& GetLayoutMetadata() const; void SetLayoutMetadata(const KeyboardLayoutMetadata& metadata); std::vector& GetLayout(KeyboardLayoutSubLayout sublayout); void SetLayout(KeyboardLayoutSubLayout sublayout, std::vector& keys); const std::string& GetKeyLabelsString() const; KeyboardInputTarget GetInputTarget() const; unsigned int GetInputTargetOverlayID() const; bool GetKeyDown(unsigned char keycode) const; void SetKeyDown(unsigned char keycode, bool down, bool block_modifiers = false); void SetStringDown(const std::string text, bool down); void SetActionDown(ActionUID action_uid, bool down); bool IsCapsLockToggled() const; void ResetState(); void VRKeyboardInputBegin(const char* str_id, bool is_multiline = false); void VRKeyboardInputBegin(ImGuiID widget_id, bool is_multiline = false); void VRKeyboardInputEnd(); void OnImGuiNewFrame(); void OnWindowHidden(); void AddTextToStringQueue(const std::string text); void UpdateImGuiModifierState() const; void RestoreDesktopModifierState() const; //Positioning hint used by the shortcut window. Set when the default down direction would cover related widgets. Offset only used with hint dir. Resets automatically void SetShortcutWindowDirectionHint(ImGuiDir dir_hint, float y_offset = 0.0f); static KeyboardLayoutMetadata LoadLayoutMetadataFromFile(const std::string& filename); }; ================================================ FILE: src/DesktopPlusUI/VRKeyboardCommon.h ================================================ #pragma once #include "Actions.h" #include enum KeyboardLayoutSubLayout : unsigned char { kbdlayout_sub_base, kbdlayout_sub_shift, kbdlayout_sub_altgr, kbdlayout_sub_aux, kbdlayout_sub_MAX }; enum KeyboardLayoutKeyType { kbdlayout_key_blank_space, kbdlayout_key_virtual_key, kbdlayout_key_virtual_key_toggle, kbdlayout_key_virtual_key_iso_enter, kbdlayout_key_string, kbdlayout_key_sublayout_toggle, kbdlayout_key_action, kbdlayout_key_MAX }; enum KeyboardLayoutCluster { kbdlayout_cluster_base, kbdlayout_cluster_function, kbdlayout_cluster_navigation, kbdlayout_cluster_numpad, kbdlayout_cluster_extra, kbdlayout_cluster_MAX }; struct KeyboardLayoutMetadata { std::string Name = "Unknown"; std::string Author = ""; std::string FileName; bool HasAltGr = false; //Right Alt switches to AltGr sublayout when down bool HasCluster[kbdlayout_cluster_MAX] = {false}; }; struct KeyboardLayoutKey { KeyboardLayoutCluster KeyCluster = kbdlayout_cluster_base; KeyboardLayoutKeyType KeyType = kbdlayout_key_blank_space; bool IsRowEnd = false; float Width = 1.0f; float Height = 1.0f; std::string Label; float LabelHAlignment = 0.5f; //Computed at load-time bool IsLabelMultiline = false; //Computed at load-time bool BlockModifiers = false; bool NoRepeat = false; unsigned char KeyCode = 0; std::string KeyString; KeyboardLayoutSubLayout KeySubLayoutToggle = kbdlayout_sub_base; ActionUID KeyActionUID = k_ActionUID_Invalid; }; enum KeyboardInputTarget { kbdtarget_desktop, kbdtarget_ui, kbdtarget_overlay }; ================================================ FILE: src/DesktopPlusUI/Win32PerformanceData.cpp ================================================ #include "Win32PerformanceData.h" #include #include LUID Win32PerformanceData::GetLUIDFromFormattedCounterNameString(const std::wstring& str) { LUID parsed_luid = {0, 0}; //Find and extract LUID parts size_t pos = str.find(L"_0x"); if (pos != std::string::npos) { std::wstring str_high_part = str.substr(pos + 1, 10); pos = str.find(L"_0x", pos + 1); if (pos != std::string::npos) { std::wstring str_low_part = str.substr(pos + 1, 10); //Convert from string parsed_luid.HighPart = stol(str_high_part, 0, 16); parsed_luid.LowPart = stoul(str_low_part, 0, 16); } } return parsed_luid; } Win32PerformanceData::Win32PerformanceData() : m_QueryCPU(nullptr), m_QueryGPU(nullptr), m_QueryVRAM(nullptr), m_CounterCPU(nullptr), m_CounterGPU(nullptr), m_CounterVRAM(nullptr), m_GPUTargetLUID{0, 0}, m_CPULoad(0.0f), m_GPULoad(0.0f), m_VRAMTotalGB(0.0f), m_VRAMUsedGB(0.0f), m_LastUpdateTick(0) { //RAM Total MEMORYSTATUSEX mem_info; mem_info.dwLength = sizeof(MEMORYSTATUSEX); ::GlobalMemoryStatusEx(&mem_info); m_RAMTotalGB = float(mem_info.ullTotalPhys / (1024.0 * 1024.0 * 1024.0)); Update(); //Fills m_RamUsedGB } Win32PerformanceData::~Win32PerformanceData() { DisableCounters(); } void Win32PerformanceData::EnableCounters(bool enable_gpu) { PDH_STATUS pdh_status; bool new_counter_added = false; //CPU Load if (m_QueryCPU == nullptr) { pdh_status = ::PdhOpenQuery(nullptr, 0, &m_QueryCPU); if (pdh_status == ERROR_SUCCESS) { pdh_status = ::PdhAddEnglishCounter(m_QueryCPU, L"\\Processor(_Total)\\% Processor Time", 0, &m_CounterCPU); if (pdh_status != ERROR_SUCCESS) { ::PdhCloseQuery(&m_QueryCPU); m_QueryCPU = nullptr; } else { new_counter_added = true; } } } if (enable_gpu) { //GPU Load if (m_QueryGPU == nullptr) { pdh_status = ::PdhOpenQuery(nullptr, 0, &m_QueryGPU); if (pdh_status == ERROR_SUCCESS) { pdh_status = ::PdhAddEnglishCounter(m_QueryGPU, L"\\GPU Engine(*)\\Utilization Percentage", 0, &m_CounterGPU); if (pdh_status != ERROR_SUCCESS) { ::PdhCloseQuery(&m_QueryGPU); m_QueryGPU = nullptr; } else { new_counter_added = true; } } } //GPU VRAM if (m_QueryVRAM == nullptr) { pdh_status = ::PdhOpenQuery(nullptr, 0, &m_QueryVRAM); if (pdh_status == ERROR_SUCCESS) { pdh_status = ::PdhAddEnglishCounter(m_QueryVRAM, L"\\GPU Adapter Memory(*)\\Dedicated Usage", 0, &m_CounterVRAM); if (pdh_status != ERROR_SUCCESS) { ::PdhCloseQuery(&m_QueryVRAM); m_QueryVRAM = nullptr; } else { new_counter_added = true; } } } } if (new_counter_added) { m_LastUpdateTick = ::GetTickCount64(); //Not an update, but we need to start waiting from when a counter was first added } } void Win32PerformanceData::DisableGPUCounters() { if (m_QueryGPU != nullptr) { PdhCloseQuery(&m_QueryGPU); m_QueryGPU = nullptr; } if (m_QueryVRAM != nullptr) { PdhCloseQuery(&m_QueryVRAM); m_QueryVRAM = nullptr; } } void Win32PerformanceData::DisableCounters() { if (m_QueryCPU != nullptr) { PdhCloseQuery(&m_QueryCPU); m_QueryCPU = nullptr; } if (m_QueryGPU != nullptr) { PdhCloseQuery(&m_QueryGPU); m_QueryGPU = nullptr; } if (m_QueryVRAM != nullptr) { PdhCloseQuery(&m_QueryVRAM); m_QueryVRAM = nullptr; } } bool Win32PerformanceData::Update() { //Do not update more often than once a second to get reliable CPU load readings (and reduce said load) if (::GetTickCount64() < m_LastUpdateTick + 1000) return false; m_LastUpdateTick = ::GetTickCount64(); PDH_STATUS pdh_status; //CPU Load if (m_QueryCPU != nullptr) { pdh_status = PdhCollectQueryData(m_QueryCPU); if (pdh_status == ERROR_SUCCESS) { PDH_FMT_COUNTERVALUE counter_value = {0}; pdh_status = PdhGetFormattedCounterValue(m_CounterCPU, PDH_FMT_DOUBLE, nullptr, &counter_value); if (pdh_status == ERROR_SUCCESS) { m_CPULoad = std::min((float)counter_value.doubleValue, 100.0f); } } } //GPU Load if (m_QueryGPU != nullptr) { pdh_status = PdhCollectQueryData(m_QueryGPU); if (pdh_status == ERROR_SUCCESS) { PDH_FMT_COUNTERVALUE counter_value = {0}; DWORD buffer_size = 0; DWORD item_count = 0; pdh_status = PdhGetFormattedCounterArray(m_CounterGPU, PDH_FMT_DOUBLE, &buffer_size, &item_count, nullptr); if (pdh_status == PDH_MORE_DATA) { std::unique_ptr item_buffer = std::unique_ptr{new uint8_t[buffer_size]}; PDH_FMT_COUNTERVALUE_ITEM* items = (PDH_FMT_COUNTERVALUE_ITEM*)item_buffer.get(); pdh_status = PdhGetFormattedCounterArray(m_CounterGPU, PDH_FMT_DOUBLE, &buffer_size, &item_count, items); if (pdh_status == ERROR_SUCCESS) { double total_load = 0.0; for (DWORD i = 0; i < item_count; i++) { std::wstring item_name(items[i].szName); //Only count engine type "3D" if (item_name.find(L"_engtype_3D") != std::string::npos) { //Make sure it's from the right GPU LUID item_luid = GetLUIDFromFormattedCounterNameString(item_name); if ( (item_luid.LowPart == m_GPUTargetLUID.LowPart) && (item_luid.HighPart == m_GPUTargetLUID.HighPart) ) { total_load += items[i].FmtValue.doubleValue; } } } m_GPULoad = std::min((float)total_load, 100.0f); } } } } //GPU VRAM Used if (m_QueryVRAM != nullptr) { pdh_status = PdhCollectQueryData(m_QueryVRAM); if (pdh_status == ERROR_SUCCESS) { PDH_FMT_COUNTERVALUE counter_value = {0}; DWORD buffer_size = 0; DWORD item_count = 0; pdh_status = PdhGetFormattedCounterArray(m_CounterVRAM, PDH_FMT_DOUBLE, &buffer_size, &item_count, nullptr); if (pdh_status == PDH_MORE_DATA) { std::unique_ptr item_buffer = std::unique_ptr{new uint8_t[buffer_size]}; PDH_FMT_COUNTERVALUE_ITEM* items = (PDH_FMT_COUNTERVALUE_ITEM*)item_buffer.get(); pdh_status = PdhGetFormattedCounterArray(m_CounterVRAM, PDH_FMT_DOUBLE, &buffer_size, &item_count, items); if (pdh_status == ERROR_SUCCESS) { for (DWORD i = 0; i < item_count; i++) { std::wstring item_name(items[i].szName); //Make sure it's from the right GPU LUID item_luid = GetLUIDFromFormattedCounterNameString(item_name); if ( (item_luid.LowPart == m_GPUTargetLUID.LowPart) && (item_luid.HighPart == m_GPUTargetLUID.HighPart) ) { m_VRAMUsedGB = float(items[i].FmtValue.doubleValue / (1024.0 * 1024.0 * 1024.0)); m_VRAMUsedGB = std::min(m_VRAMUsedGB, m_VRAMTotalGB); break; } } } } } } //RAM Used MEMORYSTATUSEX mem_info = {}; mem_info.dwLength = sizeof(MEMORYSTATUSEX); ::GlobalMemoryStatusEx(&mem_info); m_RAMUsedGB = float((mem_info.ullTotalPhys - mem_info.ullAvailPhys) / (1024.0 * 1024.0 * 1024.0)); m_RAMUsedGB = std::min(m_RAMUsedGB, m_RAMTotalGB); return true; } void Win32PerformanceData::SetTargetGPU(LUID gpu_luid, DWORDLONG vram_total_bytes) { m_GPUTargetLUID = gpu_luid; m_VRAMTotalGB = float(vram_total_bytes / (1024.0 * 1024.0 * 1024.0)); } float Win32PerformanceData::GetCPULoadPrecentage() const { return m_CPULoad; } float Win32PerformanceData::GetGPULoadPrecentage() const { return m_GPULoad; } float Win32PerformanceData::GetRAMTotalGB() const { return m_RAMTotalGB; } float Win32PerformanceData::GetRAMUsedGB() const { return m_RAMUsedGB; } float Win32PerformanceData::GetVRAMTotalGB() const { return m_VRAMTotalGB; } float Win32PerformanceData::GetVRAMUsedGB() const { return m_VRAMUsedGB; } ================================================ FILE: src/DesktopPlusUI/Win32PerformanceData.h ================================================ #pragma once #include #define NOMINMAX #include class Win32PerformanceData { private: PDH_HQUERY m_QueryCPU; PDH_HQUERY m_QueryGPU; PDH_HQUERY m_QueryVRAM; PDH_HCOUNTER m_CounterCPU; PDH_HCOUNTER m_CounterGPU; PDH_HCOUNTER m_CounterVRAM; LUID m_GPUTargetLUID; float m_CPULoad; float m_GPULoad; float m_RAMTotalGB; float m_RAMUsedGB; float m_VRAMTotalGB; float m_VRAMUsedGB; ULONGLONG m_LastUpdateTick; static LUID GetLUIDFromFormattedCounterNameString(const std::wstring& str); public: Win32PerformanceData(); ~Win32PerformanceData(); void EnableCounters(bool enable_gpu); void DisableGPUCounters(); void DisableCounters(); bool Update(); void SetTargetGPU(LUID gpu_luid, DWORDLONG vram_total_bytes); float GetCPULoadPrecentage() const; float GetGPULoadPrecentage() const; float GetRAMTotalGB() const; float GetRAMUsedGB() const; float GetVRAMTotalGB() const; float GetVRAMUsedGB() const; }; ================================================ FILE: src/DesktopPlusUI/WindowDesktopMode.cpp ================================================ #include "WindowDesktopMode.h" #include "imgui.h" #include "UIManager.h" #include "InterprocessMessaging.h" #include "WindowManager.h" #include "DesktopPlusWinRT.h" #include "DPBrowserAPIClient.h" WindowDesktopMode::WindowDesktopMode() { m_PageStack.push_back(wnddesktopmode_page_main); } void WindowDesktopMode::UpdateTitleBar() { ImGuiStyle& style = ImGui::GetStyle(); ImGuiIO& io = ImGui::GetIO(); ImVec2 img_size_line_height = {ImGui::GetTextLineHeight() * 1.6f, ImGui::GetTextLineHeight() * 1.6f}; ImVec2 img_size, img_uv_min, img_uv_max; m_TitleBarRect = {0.0f, 0.0f, ImGui::GetWindowSize().x, img_size_line_height.y + (style.WindowPadding.y * 2.0f)}; const ImVec2 title_bar_rect_min(m_TitleBarRect.x, m_TitleBarRect.y), title_bar_rect_max(m_TitleBarRect.z, m_TitleBarRect.w); ImGui::PushClipRect(title_bar_rect_min, title_bar_rect_max, false); //Background color ImGui::GetWindowDrawList()->AddRectFilled({0.0f, 0.0f}, {m_TitleBarRect.z, m_TitleBarRect.w}, ImGui::GetColorU32(ImGuiCol_TitleBg)); //Icon and title text static ImVec2 back_button_size; const float back_button_x = m_TitleBarRect.z - back_button_size.x - style.FramePadding.x; const char* title_str = nullptr; float title_icon_alpha = 1.0f; switch (m_PageStack[m_PageStackPos]) { case wnddesktopmode_page_main: { title_str = "Desktop+"; TextureManager::Get().GetTextureInfo(tmtex_icon_small_app_icon, img_size, img_uv_min, img_uv_max); break; } case wnddesktopmode_page_settings: case wnddesktopmode_page_profiles: case wnddesktopmode_page_app_profiles: case wnddesktopmode_page_actions: { const WindowSettings& window_settings = UIManager::Get()->GetSettingsWindow(); title_str = window_settings.DesktopModeGetTitle(); window_settings.DesktopModeGetIconTextureInfo(img_size, img_uv_min, img_uv_max); break; } case wnddesktopmode_page_properties: { const WindowOverlayProperties& window_properties = UIManager::Get()->GetOverlayPropertiesWindow(); title_str = window_properties.DesktopModeGetTitle(); title_icon_alpha = window_properties.DesktopModeGetTitleIconAlpha(); window_properties.DesktopModeGetIconTextureInfo(img_size, img_uv_min, img_uv_max); break; } case wnddesktopmode_page_add_window_overlay: { title_str = TranslationManager::GetString(tstr_DesktopModePageAddWindowOverlayTitle); TextureManager::Get().GetTextureInfo(tmtex_icon_add, img_size, img_uv_min, img_uv_max); break; } } ImGui::SetCursorPos(style.WindowPadding); ImGui::PushStyleVar(ImGuiStyleVar_Alpha, title_icon_alpha); ImGui::Image(ImGui::GetIO().Fonts->TexID, img_size_line_height, img_uv_min, img_uv_max); if ((ImGui::IsItemClicked()) && (m_PageStack[m_PageStackPos] == wnddesktopmode_page_properties)) { UIManager::Get()->GetOverlayPropertiesWindow().DesktopModeOnTitleIconClick(); } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); ImGui::SetCursorPosY( (m_TitleBarRect.w / 2.0f) - (ImGui::GetTextLineHeight() / 1.90f) ); //1.90f to adjust alignment a bit ImVec2 clip_end = ImGui::GetCursorScreenPos(); clip_end.x = back_button_x - style.FramePadding.x; clip_end.y += ImGui::GetFrameHeight(); ImGui::PushClipRect(ImGui::GetCursorScreenPos(), clip_end, true); ImGui::TextUnformatted(title_str); ImGui::PopClipRect(); ImGui::PopStyleVar(); float title_text_width = ImGui::GetItemRectSize().x; //Right end of title bar ImGui::PushStyleColor(ImGuiCol_Button, 0); const bool can_go_back = (m_PageStackPos != 0); if (!can_go_back) ImGui::PushItemDisabled(); TextureManager::Get().GetTextureInfo(tmtex_icon_xxsmall_browser_back, img_size, img_uv_min, img_uv_max); ImVec2 img_size_line_height_back(img_size_line_height.x * 0.75f, img_size_line_height.y * 0.75f); ImGui::SetCursorScreenPos({back_button_x, m_TitleBarRect.y + (m_TitleBarRect.w / 2.0f) - (back_button_size.y / 2.0f) }); ImGui::PushStyleVar(ImGuiStyleVar_FramePadding, ImVec2(1.0f, 1.0f)); if ( (ImGui::ImageButton("BackButton", io.Fonts->TexID, img_size_line_height_back, img_uv_min, img_uv_max)) || (ImGui::IsMouseClicked(3 /* MouseX1 / Back */)) || ( (ImGui::IsKeyPressed(ImGuiKey_Backspace)) && (!ImGui::IsAnyInputTextActive()) ) ) { if (!ImGui::IsPopupOpen(nullptr, ImGuiPopupFlags_AnyPopup)) { bool did_go_back = false; switch (m_PageStack[m_PageStackPos]) { case wnddesktopmode_page_settings: /*fallthrough*/ case wnddesktopmode_page_profiles: /*fallthrough*/ case wnddesktopmode_page_app_profiles: /*fallthrough*/ case wnddesktopmode_page_actions: did_go_back = UIManager::Get()->GetSettingsWindow().DesktopModeGoBack(); break; case wnddesktopmode_page_properties: did_go_back = UIManager::Get()->GetOverlayPropertiesWindow().DesktopModeGoBack(); break; default: break; } //If embedded page didn't go back, go back on our own pagination if (!did_go_back) { PageGoBack(); } } } ImGui::PopStyleVar(); if (!can_go_back) ImGui::PopItemDisabled(); back_button_size = ImGui::GetItemRectSize(); //Check if title bar is hovered (except the back button) and notify embedded page windows that need this info if (m_PageStack[m_PageStackPos] == wnddesktopmode_page_properties) { const bool is_title_bar_hovered = ( (!ImGui::IsItemHovered()) && (ImGui::IsMouseHoveringRect(title_bar_rect_min, title_bar_rect_max)) ); UIManager::Get()->GetOverlayPropertiesWindow().DesktopModeOnTitleBarHover(is_title_bar_hovered); } ImGui::PopStyleColor(); ImGui::PopClipRect(); ImGui::SetCursorPosY(m_TitleBarRect.w + style.WindowPadding.y); } void WindowDesktopMode::UpdatePageMain() { ImGuiStyle& style = ImGui::GetStyle(); ImGuiIO& io = ImGui::GetIO(); ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_DesktopModeCatTools)); ImGui::Indent(); const float item_height = ImGui::GetTextLineHeight() + style.ItemInnerSpacing.y; ImGui::BeginChild("SettingsList", ImVec2(0.0f, (item_height * 4.0f) + style.ItemInnerSpacing.y), true); //Focus nav if we came back from settings if ( (io.NavVisible) && (m_PageReturned == wnddesktopmode_page_settings) ) { ImGui::SetKeyboardFocusHere(); m_PageReturned = wnddesktopmode_page_none; } if (ImGui::Selectable(TranslationManager::GetString(tstr_DesktopModeToolSettings))) { UIManager::Get()->GetSettingsWindow().DesktopModeSetRootPage(wndsettings_page_main); PageGoForward(wnddesktopmode_page_settings); } //Focus nav if we came back from profiles if ( (io.NavVisible) && (m_PageReturned == wnddesktopmode_page_profiles) ) { ImGui::SetKeyboardFocusHere(); m_PageReturned = wnddesktopmode_page_none; } if (ImGui::Selectable(TranslationManager::GetString(tstr_SettingsProfilesOverlays))) { UIManager::Get()->GetSettingsWindow().DesktopModeSetRootPage(wndsettings_page_profiles); PageGoForward(wnddesktopmode_page_profiles); } //Focus nav if we came back from app profiles if ( (io.NavVisible) && (m_PageReturned == wnddesktopmode_page_app_profiles) ) { ImGui::SetKeyboardFocusHere(); m_PageReturned = wnddesktopmode_page_none; } if (ImGui::Selectable(TranslationManager::GetString(tstr_SettingsProfilesApps))) { UIManager::Get()->GetSettingsWindow().DesktopModeSetRootPage(wndsettings_page_app_profiles); PageGoForward(wnddesktopmode_page_app_profiles); } //Focus nav if we came back from actions if ( (io.NavVisible) && (m_PageReturned == wnddesktopmode_page_actions) ) { ImGui::SetKeyboardFocusHere(); m_PageReturned = wnddesktopmode_page_none; } if (ImGui::Selectable(TranslationManager::GetString(tstr_DesktopModeToolActions))) { UIManager::Get()->GetSettingsWindow().DesktopModeSetRootPage(wndsettings_page_actions); PageGoForward(wnddesktopmode_page_actions); } ImGui::EndChild(); ImGui::Unindent(); ImGui::Spacing(); UpdatePageMainOverlayList(); } void WindowDesktopMode::UpdatePageMainOverlayList() { ImGuiStyle& style = ImGui::GetStyle(); ImGuiIO& io = ImGui::GetIO(); ImVec2 img_size_line_height = {ImGui::GetTextLineHeight(), ImGui::GetTextLineHeight()}; ImVec2 img_size, img_uv_min, img_uv_max; //List of unique IDs for overlays so ImGui can identify the same list entries after reordering or list expansion (needed for drag reordering) static std::vector list_unique_ids; static unsigned int drag_last_hovered_selectable = k_ulOverlayID_None; const int overlay_count = (int)OverlayManager::Get().GetOverlayCount(); const unsigned int u_overlay_count = OverlayManager::Get().GetOverlayCount(); //Reset unique IDs when page is appearing if (m_PageAppearing == wnddesktopmode_page_main) { list_unique_ids.clear(); } //Expand unique id lists if overlays were added (also does initialization since it's empty then) while (list_unique_ids.size() < u_overlay_count) { list_unique_ids.push_back((int)list_unique_ids.size()); } //List overlays in a scrollable child container ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_DesktopModeCatOverlays)); ImGui::Indent(); ImGui::BeginChild("OverlayList", ImVec2(0.0f, 0.0f), true); static unsigned int hovered_overlay_id_last = k_ulOverlayID_None; static unsigned int right_down_overlay_id = k_ulOverlayID_None; static unsigned int keyboard_swapped_overlay_id = k_ulOverlayID_None; static bool add_overlay_right_down = false; unsigned int hovered_overlay_id = k_ulOverlayID_None; bool has_swapped = false; ImVec4 color_text_hidden = ImGui::GetStyleColorVec4(ImGuiCol_Text); color_text_hidden.w = 0.5f; for (unsigned int i = 0; i < u_overlay_count; ++i) { ImGui::PushID(list_unique_ids[i]); //Force active header color when a menu is active or right mouse button is held down const bool is_active = ( (m_OverlayListActiveMenuID == i) || (right_down_overlay_id == i) ); if (is_active) { ImGui::PushStyleColor(ImGuiCol_Header, ImGui::GetStyleColorVec4(ImGuiCol_HeaderActive)); ImGui::PushStyleColor(ImGuiCol_HeaderHovered, ImGui::GetStyleColorVec4(ImGuiCol_HeaderActive)); } //Set focus for nav if we just came back from the properties page and this is the active overlay if ( (io.NavVisible) && (m_PageReturned == wnddesktopmode_page_properties) && (UIManager::Get()->GetOverlayPropertiesWindow().GetActiveOverlayID() == i) ) { ImGui::SetKeyboardFocusHere(); m_PageReturned = wnddesktopmode_page_none; } //Set focus for nav if we previously re-ordered overlays via keyboard if (keyboard_swapped_overlay_id == i) { ImGui::SetKeyboardFocusHere(); //Nav works against us here, so keep setting focus until ctrl isn't down anymore if ((!io.KeyCtrl) || (!io.NavVisible)) { keyboard_swapped_overlay_id = k_ulOverlayID_None; } } //Use empty label here. Icon and actual label are manually created further down if (ImGui::Selectable("", is_active)) { if (!m_IsDraggingOverlaySelectables) { UIManager::Get()->GetOverlayPropertiesWindow().SetActiveOverlayID(i, true); PageGoForward(wnddesktopmode_page_properties); HideMenus(); } } if (is_active) { ImGui::PopStyleColor(); ImGui::PopStyleColor(); } if (ImGui::IsItemVisible()) { if (ImGui::IsItemHovered()) { hovered_overlay_id = i; } //Additional selectable behavior bool selectable_active = ImGui::IsItemActive(); if ( (ImGui::IsItemHovered(ImGuiHoveredFlags_AllowWhenBlockedByActiveItem)) || ((io.NavVisible) && (ImGui::IsItemFocused())) ) { drag_last_hovered_selectable = i; hovered_overlay_id = i; if ( (ImGui::IsMouseReleased(ImGuiMouseButton_Right)) || (ImGui::IsKeyReleased(ImGuiKey_Menu)) ) { if ((m_OverlayListActiveMenuID != i) && (!m_IsDraggingOverlaySelectables)) { HideMenus(); m_OverlayListActiveMenuID = i; ImGui::OpenPopup("OverlayListMenu"); } selectable_active = true; } else if ( (ImGui::IsMouseDown(ImGuiMouseButton_Right)) || (ImGui::IsKeyDown(ImGuiKey_Menu)) ) { right_down_overlay_id = i; //For correct right-click visual } } //Drag reordering if ((ImGui::IsItemActive()) && (!ImGui::IsItemHovered())) { int index_swap = i + ((ImGui::GetMouseDragDelta(ImGuiMouseButton_Left).y < 0.0f) ? -1 : 1); if ((drag_last_hovered_selectable != i) && (index_swap >= 0) && (index_swap < overlay_count)) { OverlayManager::Get().SwapOverlays(i, index_swap); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, i); IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_swap, index_swap); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, -1); std::iter_swap(list_unique_ids.begin() + i, list_unique_ids.begin() + index_swap); ImGui::ResetMouseDragDelta(ImGuiMouseButton_Left); m_IsDraggingOverlaySelectables = true; m_OverlayListActiveMenuID = k_ulOverlayID_None; } } //Keyboard reordering if ((io.NavVisible) && (io.KeyCtrl) && (hovered_overlay_id == i)) { int index_swap = i + ((ImGui::IsNavInputPressed(ImGuiNavInput_DpadDown, true)) ? 1 : (ImGui::IsNavInputPressed(ImGuiNavInput_DpadUp, true)) ? -1 : 0); if ((i != index_swap) && (index_swap >= 0) && (index_swap < overlay_count)) { OverlayManager::Get().SwapOverlays(i, index_swap); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, i); IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_swap, index_swap); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, -1); std::iter_swap(list_unique_ids.begin() + i, list_unique_ids.begin() + index_swap); m_OverlayListActiveMenuID = k_ulOverlayID_None; //Skip the rest of this frame to avoid double-swaps keyboard_swapped_overlay_id = index_swap; ImGui::PopID(); UIManager::Get()->RepeatFrame(); break; } } if (m_OverlayListActiveMenuID == i) { MenuOverlayList(i); //Check if menu modified overlay count and bail then if (OverlayManager::Get().GetOverlayCount() != u_overlay_count) { ImGui::PopID(); UIManager::Get()->RepeatFrame(); break; } hovered_overlay_id = i; } //Custom render the selectable label with icons OverlayConfigData& data = OverlayManager::Get().GetConfigData(i); const ImVec4 tint_color = ImVec4(1.0f, 1.0f, 1.0f, data.ConfigBool[configid_bool_overlay_enabled] ? 1.0f : 0.5f); //Transparent when hidden //Overlay icon ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); TextureManager::Get().GetOverlayIconTextureInfo(data, img_size, img_uv_min, img_uv_max, true); ImGui::ImageWithBg(ImGui::GetIO().Fonts->TexID, img_size_line_height, img_uv_min, img_uv_max, {0, 0, 0, 0}, tint_color); //Origin icon ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); TextureManager::Get().GetTextureInfo((TMNGRTexID)(tmtex_icon_xsmall_origin_room + data.ConfigInt[configid_int_overlay_origin]), img_size, img_uv_min, img_uv_max); ImGui::ImageWithBg(ImGui::GetIO().Fonts->TexID, img_size_line_height, img_uv_min, img_uv_max, {0, 0, 0, 0}, tint_color); //Label ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); ImGui::TextColoredUnformatted(data.ConfigBool[configid_bool_overlay_enabled] ? ImGui::GetStyleColorVec4(ImGuiCol_Text) : color_text_hidden, data.ConfigNameStr.c_str()); } ImGui::PopID(); } //Static Add Overlay entry { if (u_overlay_count != 0) { ImGui::Separator(); } //Force active header color when a menu is active or right mouse button is held down const bool is_active = ( (m_IsOverlayAddMenuVisible) || (add_overlay_right_down) ); if (is_active) { ImGui::PushStyleColor(ImGuiCol_Header, ImGui::GetStyleColorVec4(ImGuiCol_HeaderActive)); ImGui::PushStyleColor(ImGuiCol_HeaderHovered, ImGui::GetStyleColorVec4(ImGuiCol_HeaderActive)); } //Use empty label here. Icon and actual label are manually created further down if (ImGui::Selectable("##AddOverlay", is_active)) { if (!m_IsDraggingOverlaySelectables) { HideMenus(); m_IsOverlayAddMenuVisible = true; ImGui::OpenPopup("AddOverlayMenu"); } } if (is_active) { ImGui::PopStyleColor(); ImGui::PopStyleColor(); } if (ImGui::IsItemVisible()) { //Also allow right-click/menu key as the result looks like a context menu if ((ImGui::IsItemHovered(ImGuiHoveredFlags_AllowWhenBlockedByActiveItem)) || ((io.NavVisible) && (ImGui::IsItemFocused()))) { if ((ImGui::IsMouseReleased(ImGuiMouseButton_Right)) || (ImGui::IsKeyReleased(ImGuiKey_Menu))) { if ((!m_IsOverlayAddMenuVisible) && (!m_IsDraggingOverlaySelectables)) { HideMenus(); m_IsOverlayAddMenuVisible = true; ImGui::OpenPopup("AddOverlayMenu"); } } else if ((ImGui::IsMouseDown(ImGuiMouseButton_Right)) || (ImGui::IsKeyDown(ImGuiKey_Menu))) { add_overlay_right_down = true; //For correct right-click visual } } //Custom render the selectable label with icon ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); TextureManager::Get().GetTextureInfo(tmtex_icon_add, img_size, img_uv_min, img_uv_max); ImGui::Image(ImGui::GetIO().Fonts->TexID, img_size_line_height, img_uv_min, img_uv_max); //Label ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); ImGui::TextUnformatted(TranslationManager::GetString(tstr_DesktopModeOverlayListAdd)); } if (m_IsOverlayAddMenuVisible) { MenuAddOverlay(); } } //Don't change overlay highlight while mouse down as it won't be correct while dragging and flicker just before it if ( (!ImGui::IsMouseDown(ImGuiMouseButton_Left)) && ((hovered_overlay_id_last != k_ulOverlayID_None) || (hovered_overlay_id != k_ulOverlayID_None)) ) { UIManager::Get()->HighlightOverlay(hovered_overlay_id); hovered_overlay_id_last = hovered_overlay_id; } if (ImGui::IsMouseReleased(ImGuiMouseButton_Left)) { m_IsDraggingOverlaySelectables = false; } if ( (ImGui::IsMouseReleased(ImGuiMouseButton_Right)) || (ImGui::IsKeyReleased(ImGuiKey_Menu)) ) { right_down_overlay_id = k_ulOverlayID_None; add_overlay_right_down = false; } ImGui::EndChild(); ImGui::Unindent(); } void WindowDesktopMode::UpdatePageAddWindowOverlay() { ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_DesktopModePageAddWindowOverlayHeader)); ImGui::Indent(); ImGui::SetNextItemWidth(-1.0f); ImGui::BeginChild("WindowList", ImVec2(0.0f, ImGui::GetContentRegionAvail().y - ImGui::GetFrameHeightWithSpacing() - ImGui::GetStyle().ItemSpacing.y), true); ImVec2 img_size_line_height = {ImGui::GetTextLineHeight(), ImGui::GetTextLineHeight()}; ImVec2 img_size, img_uv_min, img_uv_max; //List windows for (const auto& window_info : WindowManager::Get().WindowListGet()) { ImGui::PushID(window_info.GetWindowHandle()); if (ImGui::Selectable("")) { //Add overlay HWND window_handle = window_info.GetWindowHandle(); unsigned int overlay_id_new = OverlayManager::Get().AddOverlay(ovrl_capsource_winrt_capture, -2, window_handle); //Send to dashboard app IPCManager::Get().PostConfigMessageToDashboardApp(configid_handle_state_arg_hwnd, (LPARAM)window_handle); IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_new, -2); //Adjust width to a more suited default (done here as well so it's set even without dashboard app running) OverlayManager::Get().GetConfigData(overlay_id_new).ConfigFloat[configid_float_overlay_width] = 1.0f; PageGoBack(); } ImGui::SameLine(0.0f, 0.0f); int icon_id = TextureManager::Get().GetWindowIconCacheID(window_info.GetIcon()); if (icon_id != -1) { TextureManager::Get().GetWindowIconTextureInfo(icon_id, img_size, img_uv_min, img_uv_max); ImGui::Image(ImGui::GetIO().Fonts->TexID, img_size_line_height, img_uv_min, img_uv_max); ImGui::SameLine(0.0f, ImGui::GetStyle().ItemInnerSpacing.x); } ImGui::TextUnformatted(window_info.GetListTitle().c_str()); ImGui::PopID(); } ImGui::EndChild(); ImGui::Unindent(); ImGui::SetCursorPosY(ImGui::GetCursorPosY() + (ImGui::GetContentRegionAvail().y - ImGui::GetFrameHeight())); //--Cancel button //No separator since this is right after a boxed child window if (ImGui::Button(TranslationManager::GetString(tstr_DialogCancel))) { PageGoBack(); } } void WindowDesktopMode::MenuOverlayList(unsigned int overlay_id) { m_MenuAlpha += ImGui::GetIO().DeltaTime * 12.0f; if (m_MenuAlpha > 1.0f) m_MenuAlpha = 1.0f; ImGui::PushStyleVar(ImGuiStyleVar_Alpha, m_MenuAlpha); ImGui::PushStyleVar(ImGuiStyleVar_WindowRounding, 0.0f); if (ImGui::BeginPopup("OverlayListMenu", ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoSavedSettings | ImGuiWindowFlags_AlwaysAutoResize)) { if ( (!ImGui::IsWindowHovered(ImGuiHoveredFlags_AllowWhenBlockedByActiveItem)) && (ImGui::IsAnyMouseClicked()) ) { HideMenus(); } bool& is_enabled = OverlayManager::Get().GetConfigData(overlay_id).ConfigBool[configid_bool_overlay_enabled]; WindowOverlayProperties& properties_window = UIManager::Get()->GetOverlayPropertiesWindow(); if (ImGui::Selectable(TranslationManager::GetString((is_enabled) ? tstr_OverlayBarOvrlHide : tstr_OverlayBarOvrlShow), false)) { is_enabled = !is_enabled; IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, (int)overlay_id); IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_overlay_enabled, is_enabled); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, -1); HideMenus(); } if (ImGui::Selectable(TranslationManager::GetString(tstr_OverlayBarOvrlClone), false)) { //Copy data of overlay and add a new one based on it OverlayManager::Get().DuplicateOverlay(OverlayManager::Get().GetConfigData(overlay_id), overlay_id); IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_duplicate, (int)overlay_id); HideMenus(); } if (m_IsMenuRemoveConfirmationVisible) { if (ImGui::Selectable(TranslationManager::GetString(tstr_OverlayBarOvrlRemoveConfirm), false)) { OverlayManager::Get().RemoveOverlay(overlay_id); IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_remove, overlay_id); HideMenus(); } if (ImGui::IsNavInputReleased(ImGuiNavInput_Activate)) { ImGui::SetKeyboardFocusHere(-1); } } else { if (ImGui::Selectable(TranslationManager::GetString(tstr_OverlayBarOvrlRemove), false, ImGuiSelectableFlags_NoAutoClosePopups)) { m_IsMenuRemoveConfirmationVisible = true; UIManager::Get()->RepeatFrame(); } } if (ImGui::IsNavInputPressed(ImGuiNavInput_Cancel)) { HideMenus(); } ImGui::EndPopup(); } ImGui::PopStyleVar(); ImGui::PopStyleVar(); //Handle popup being closed from nav if (!ImGui::IsPopupOpen("OverlayListMenu")) { HideMenus(); } } void WindowDesktopMode::MenuAddOverlay() { m_MenuAlpha += ImGui::GetIO().DeltaTime * 12.0f; if (m_MenuAlpha > 1.0f) m_MenuAlpha = 1.0f; ImGui::PushStyleVar(ImGuiStyleVar_Alpha, m_MenuAlpha); ImGui::PushStyleVar(ImGuiStyleVar_WindowRounding, 0.0f); if (ImGui::BeginPopup("AddOverlayMenu", ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoSavedSettings | ImGuiWindowFlags_AlwaysAutoResize)) { if ( (!ImGui::IsWindowHovered(ImGuiHoveredFlags_AllowWhenBlockedByActiveItem)) && (ImGui::IsAnyMouseClicked()) ) { HideMenus(); } int desktop_count = ConfigManager::GetValue(configid_int_state_interface_desktop_count); int new_overlay_desktop_id = -255; for (int i = 0; i < desktop_count; ++i) { ImGui::PushID(i); if (ImGui::Selectable(TranslationManager::Get().GetDesktopIDString(i))) { new_overlay_desktop_id = i; } ImGui::PopID(); } if ( (DPWinRT_IsCaptureSupported()) && (ImGui::Selectable(TranslationManager::GetString(tstr_OverlayBarOvrlAddWindow), false)) ) { HideMenus(); PageGoForward(wnddesktopmode_page_add_window_overlay); } //Don't offer Performance Monitor in desktop mode as this kind of overlay won't be visible after creation since its window isn't rendered in desktop mode /*if (ImGui::Selectable(TranslationManager::GetString(tstr_SourcePerformanceMonitor))) { new_overlay_desktop_id = -3; }*/ if (DPBrowserAPIClient::Get().IsBrowserAvailable()) { if (ImGui::Selectable(TranslationManager::GetString(tstr_SourceBrowser))) { new_overlay_desktop_id = -4; } } //Create new overlay if desktop or UI/Browser selectables were triggered if (new_overlay_desktop_id != -255) { //Choose capture source OverlayCaptureSource capsource; switch (new_overlay_desktop_id) { case -3: capsource = ovrl_capsource_ui; break; case -4: capsource = ovrl_capsource_browser; break; default: capsource = ovrl_capsource_desktop_duplication; } //Add overlay and sent to dashboard app unsigned int overlay_id_new = OverlayManager::Get().AddOverlay(capsource, new_overlay_desktop_id); IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_new, new_overlay_desktop_id); //Adjust width to a more suited default (done here as well so it's set even without dashboard app running) OverlayManager::Get().GetConfigData(overlay_id_new).ConfigFloat[configid_float_overlay_width] = 1.0f; HideMenus(); } ImGui::EndPopup(); } ImGui::PopStyleVar(); ImGui::PopStyleVar(); //Handle popup being closed from nav if (!ImGui::IsPopupOpen("AddOverlayMenu")) { HideMenus(); } } void WindowDesktopMode::HideMenus() { m_MenuAlpha = 0.0f; m_OverlayListActiveMenuID = k_ulOverlayID_None; m_IsOverlayAddMenuVisible = false; m_IsMenuRemoveConfirmationVisible = false; UIManager::Get()->RepeatFrame(); } void WindowDesktopMode::PageGoForward(WindowDesktopModePage new_page) { m_PageStack.push_back(new_page); m_PageStackPos++; } void WindowDesktopMode::PageGoBack() { if (m_PageStackPos != 0) { m_PageStackPos--; m_PageReturned = m_PageStack.back(); } } void WindowDesktopMode::Update() { ImGuiStyle& style = ImGui::GetStyle(); ImGui::PushStyleVar(ImGuiStyleVar_WindowRounding, 0.0f); ImGui::PushStyleVar(ImGuiStyleVar_WindowBorderSize, 0.0f); ImGui::SetNextWindowPos({0.0f,0.0f}); ImGui::SetNextWindowSize(ImGui::GetIO().DisplaySize); ImGui::Begin("##WindowDesktopMode", nullptr, ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoDecoration | ImGuiWindowFlags_NoBringToFrontOnFocus); ImGui::PopStyleVar(2); UpdateTitleBar(); UIManager::Get()->GetSettingsWindow().UpdateDesktopModeWarnings(); const float page_width = ImGui::GetIO().DisplaySize.x - style.WindowPadding.x - style.WindowPadding.x; //Page animation if (m_PageAnimationDir != 0) { //Use the averaged framerate value instead of delta time for the first animation step //This is to smooth over increased frame deltas that can happen when a new page needs to do initial larger computations or save/load files const float progress_step = (m_PageAnimationProgress == 0.0f) ? (1.0f / ImGui::GetIO().Framerate) * 3.0f : ImGui::GetIO().DeltaTime * 3.0f; m_PageAnimationProgress += progress_step; if (m_PageAnimationProgress >= 1.0f) { //Remove pages in the stack after finishing going back if (m_PageAnimationDir == 1) { while ((int)m_PageStack.size() > m_PageStackPosAnimation + 1) { m_PageStack.pop_back(); } } m_PageAnimationProgress = 1.0f; m_PageAnimationDir = 0; } } else if (m_PageStackPosAnimation != m_PageStackPos) //Only start new animation if none is running { m_PageAnimationDir = (m_PageStackPosAnimation < m_PageStackPos) ? -1 : 1; m_PageStackPosAnimation = m_PageStackPos; m_PageAnimationStartPos = m_PageAnimationOffset; m_PageAnimationProgress = 0.0f; //Set appearing value to top of stack when starting animation to it if (m_PageAnimationDir == -1) { m_PageAppearing = m_PageStack.back(); } } const float target_x = (page_width + style.ItemSpacing.x) * -m_PageStackPosAnimation; m_PageAnimationOffset = smoothstep(m_PageAnimationProgress, m_PageAnimationStartPos, target_x); //Set up page offset and clipping ImGui::SetCursorPosX( (ImGui::GetCursorPosX() + m_PageAnimationOffset) ); ImGui::PushClipRect({0.0f, 0.0f}, {FLT_MAX, FLT_MAX}, false); const char* const child_str_id[] {"DesktopModePageMain", "DesktopModePage1", "DesktopModePage2", "DesktopModePage3"}; //No point in generating these on the fly const ImVec2 child_size = {page_width, ImGui::GetContentRegionAvail().y}; int child_id = 0; int stack_size = (int)m_PageStack.size(); for (WindowDesktopModePage page_id : m_PageStack) { if (child_id >= IM_ARRAYSIZE(child_str_id)) break; //Disable items when the page isn't active const bool is_inactive_page = (child_id != m_PageStackPos); if (is_inactive_page) { ImGui::PushItemDisabledNoVisual(); } ImGui::PushStyleColor(ImGuiCol_ChildBg, ImVec4(0.00f, 0.00f, 0.00f, 0.00f)); //This prevents child bg color being visible if there's a widget before this (e.g. warnings) if ( (ImGui::BeginChild(child_str_id[child_id], child_size, ImGuiChildFlags_NavFlattened)) || (m_PageAppearing == page_id) ) //Process page if currently appearing { ImGui::PopStyleColor(); //ImGuiCol_ChildBg switch (page_id) { case wnddesktopmode_page_main: UpdatePageMain(); break; case wnddesktopmode_page_settings: /*fallthrough*/ case wnddesktopmode_page_profiles: /*fallthrough*/ case wnddesktopmode_page_app_profiles: /*fallthrough*/ case wnddesktopmode_page_actions: UIManager::Get()->GetSettingsWindow().UpdateDesktopMode(); break; case wnddesktopmode_page_properties: UIManager::Get()->GetOverlayPropertiesWindow().UpdateDesktopMode(); break; case wnddesktopmode_page_add_window_overlay: UpdatePageAddWindowOverlay(); break; default: break; } } else { ImGui::PopStyleColor(); //ImGuiCol_ChildBg } if (is_inactive_page) { ImGui::PopItemDisabledNoVisual(); } ImGui::EndChild(); if (child_id + 1 < stack_size) { ImGui::SameLine(); } child_id++; } m_PageAppearing = wnddesktopmode_page_none; ImGui::PopClipRect(); ImGui::End(); //Display any potential Aux UI on top of this window UIManager::Get()->GetAuxUI().Update(); } ImVec4 WindowDesktopMode::GetTitleBarRect() const { return m_TitleBarRect; } ================================================ FILE: src/DesktopPlusUI/WindowDesktopMode.h ================================================ #pragma once #include #include "imgui.h" #include "OverlayManager.h" enum WindowDesktopModePage { wnddesktopmode_page_none, wnddesktopmode_page_main, wnddesktopmode_page_settings, wnddesktopmode_page_profiles, wnddesktopmode_page_app_profiles, wnddesktopmode_page_actions, wnddesktopmode_page_properties, wnddesktopmode_page_add_window_overlay }; //Interop functions for windows that have their content hosted as a sub-page in desktop mode class FloatingWindowDesktopModeInterop { public: virtual const char* DesktopModeGetTitle() const = 0; virtual bool DesktopModeGetIconTextureInfo(ImVec2& size, ImVec2& uv_min, ImVec2& uv_max) const = 0; //Returns false on no icon virtual float DesktopModeGetTitleIconAlpha() const { return 1.0f; } virtual void DesktopModeOnTitleIconClick() {}; virtual void DesktopModeOnTitleBarHover(bool is_hovered) {}; virtual bool DesktopModeGoBack() = 0; //Returns false if already on main page }; class WindowDesktopMode { private: std::vector m_PageStack; int m_PageStackPos = 0; int m_PageStackPosAnimation = 0; WindowDesktopModePage m_PageAppearing = wnddesktopmode_page_none; //Similar to ImGui::IsWindowAppearing(), equals the current page ID for a single frame if it or the window is newly appearing WindowDesktopModePage m_PageReturned = wnddesktopmode_page_none; //Equals the previous page ID after PageGoBack() was called, ideally cleared after making use of its value ImVec4 m_TitleBarRect; int m_PageAnimationDir = 0; float m_PageAnimationProgress = 0.0f; float m_PageAnimationStartPos = 0.0f; float m_PageAnimationOffset = 0.0f; unsigned int m_OverlayListActiveMenuID = k_ulOverlayID_None; float m_MenuAlpha = 0.0f; bool m_IsOverlayAddMenuVisible = false; bool m_IsMenuRemoveConfirmationVisible = false; bool m_IsDraggingOverlaySelectables = false; void UpdateTitleBar(); void UpdatePageMain(); void UpdatePageMainOverlayList(); void UpdatePageAddWindowOverlay(); void MenuOverlayList(unsigned int overlay_id); void MenuAddOverlay(); void HideMenus(); void PageGoForward(WindowDesktopModePage new_page); void PageGoBack(); public: WindowDesktopMode(); void Update(); ImVec4 GetTitleBarRect() const; }; ================================================ FILE: src/DesktopPlusUI/WindowFloatingUIBar.cpp ================================================ #include "WindowFloatingUIBar.h" #include "ImGuiExt.h" #include "TextureManager.h" #include "InterprocessMessaging.h" #include "Util.h" #include "OpenVRExt.h" #include "UIManager.h" #include "OverlayManager.h" #include "WindowManager.h" #include "DesktopPlusWinRT.h" #include "DPBrowserAPIClient.h" //-WindowFloatingUIMainBar WindowFloatingUIMainBar::WindowFloatingUIMainBar() : m_IsCurrentWindowCapturable(-1), m_AnimationProgress(0.0f) { } void WindowFloatingUIMainBar::DisplayTooltipIfHovered(const char* text) { if ( ((m_AnimationProgress == 0.0f) || (m_AnimationProgress == 1.0f)) && (ImGui::IsItemHovered()) ) //Also hide while animating { const ImGuiStyle& style = ImGui::GetStyle(); static ImVec2 button_pos_last; //Remember last position and use it when posible. This avoids flicker when the same tooltip string is used in different places ImVec2 pos = ImGui::GetItemRectMin(); float button_width = ImGui::GetItemRectSize().x; //Default tooltips are not suited for this as there's too much trouble with resize flickering and stuff ImGui::Begin(text, nullptr, ImGuiWindowFlags_NoInputs | ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoSavedSettings | ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_NoFocusOnAppearing); ImGui::TextUnformatted(text); //Not using GetWindowSize() here since it's delayed and plays odd when switching between buttons with the same label ImVec2 window_size = ImGui::GetItemRectSize(); window_size.x += style.WindowPadding.x * 2.0f; window_size.y += style.WindowPadding.y * 2.0f; //Repeat frame when the window is appearing as it will not have the right position (either from being first time or still having old pos) if ( (ImGui::IsWindowAppearing()) || (pos.x != button_pos_last.x) ) { UIManager::Get()->RepeatFrame(); } button_pos_last = pos; pos.x += (button_width / 2.0f) - (window_size.x / 2.0f); pos.y += button_width + style.WindowPadding.y; //Clamp x so the tooltip does not get cut off pos.x = clamp(pos.x, 0.0f, ImGui::GetIO().DisplaySize.x - window_size.x); //Clamp right side to texture end ImGui::SetWindowPos(pos); ImGui::End(); } } void WindowFloatingUIMainBar::Update(float actionbar_height, unsigned int overlay_id) { OverlayConfigData& overlay_data = OverlayManager::Get().GetConfigData(overlay_id); ImGuiIO& io = ImGui::GetIO(); ImVec2 b_size, b_uv_min, b_uv_max; TextureManager::Get().GetTextureInfo(tmtex_icon_small_close, b_size, b_uv_min, b_uv_max); const ImGuiStyle& style = ImGui::GetStyle(); //Put window near the bottom of the overlay with space for the tooltips + padding (touching action-bar when visible) const float offset_base = ImGui::GetFontSize() + style.FramePadding.y + (style.WindowPadding.y * 2.0f) + 3.0f; const float offset_y = smoothstep(m_AnimationProgress, offset_base + actionbar_height /* Action-Bar not visible */, offset_base /* Action-Bar visible */); ImGui::SetNextWindowPos(ImVec2(io.DisplaySize.x / 2.0f, io.DisplaySize.y - offset_y), 0, ImVec2(0.5f, 1.0f)); ImGui::Begin("WindowFloatingUIMainBar", nullptr, ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoFocusOnAppearing | ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_HorizontalScrollbar); ImGui::PushStyleVar(ImGuiStyleVar_FrameRounding, 4.0f); ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, {style.ItemSpacing.y, style.ItemSpacing.y}); ImGui::PushStyleColor(ImGuiCol_Button, ImVec4(0, 0, 0, 0)); //Show Action-Bar Button (this is a per-overlay state) bool& is_actionbar_enabled = overlay_data.ConfigBool[configid_bool_overlay_actionbar_enabled]; bool actionbar_was_enabled = is_actionbar_enabled; if (actionbar_was_enabled) ImGui::PushStyleColor(ImGuiCol_Button, Style_ImGuiCol_ButtonPassiveToggled); TextureManager::Get().GetTextureInfo(tmtex_icon_small_actionbar, b_size, b_uv_min, b_uv_max); if (ImGui::ImageButton("ToggleActionBar", io.Fonts->TexID, b_size, b_uv_min, b_uv_max)) { is_actionbar_enabled = !is_actionbar_enabled; //This is an UI state so no need to sync } if (actionbar_was_enabled) ImGui::PopStyleColor(); DisplayTooltipIfHovered(TranslationManager::GetString( (actionbar_was_enabled) ? tstr_FloatingUIActionBarHideTip : tstr_FloatingUIActionBarShowTip )); // ImGui::SameLine(); //Extra buttons if (overlay_data.ConfigBool[configid_bool_overlay_floatingui_extras_enabled]) { //Add current window as overlay (only show if desktop duplication or non-window WinRT capture) if ( (overlay_data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_desktop_duplication) || ((overlay_data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_winrt_capture) && (overlay_data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd] == 0)) ) { //If marked to need update, refresh actual state if (m_IsCurrentWindowCapturable == -1) { m_IsCurrentWindowCapturable = (WindowManager::Get().WindowListFindWindow(::GetForegroundWindow()) != nullptr); } if (m_IsCurrentWindowCapturable != 1) ImGui::PushItemDisabled(); TextureManager::Get().GetTextureInfo(tmtex_icon_small_add_window, b_size, b_uv_min, b_uv_max); ImGui::ImageButton("AddWindow", io.Fonts->TexID, b_size, b_uv_min, b_uv_max); //This one's activated on mouse down if (ImGui::IsItemActivated()) { vr::TrackedDeviceIndex_t device_index = ConfigManager::Get().GetPrimaryLaserPointerDevice(); //If no dashboard device, try finding one if (device_index == vr::k_unTrackedDeviceIndexInvalid) { device_index = vr::IVROverlayEx::FindPointerDeviceForOverlay(UIManager::Get()->GetOverlayHandleFloatingUI()); } //Try to get the pointer distance float source_distance = 1.0f; vr::VROverlayIntersectionResults_t results; if (vr::IVROverlayEx::ComputeOverlayIntersectionForDevice(UIManager::Get()->GetOverlayHandleFloatingUI(), device_index, vr::TrackingUniverseStanding, &results)) { source_distance = results.fDistance; } //Set pointer hint in case dashboard app needs it ConfigManager::SetValue(configid_int_state_laser_pointer_device_hint, (int)device_index); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_laser_pointer_device_hint, (int)device_index); //Add overlay HWND current_window = ::GetForegroundWindow(); OverlayManager::Get().AddOverlay(ovrl_capsource_winrt_capture, -2, current_window); //Send to dashboard app IPCManager::Get().PostConfigMessageToDashboardApp(configid_handle_state_arg_hwnd, (LPARAM)current_window); IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_new_drag, MAKELPARAM(-2, (source_distance * 100.0f))); } if (m_IsCurrentWindowCapturable != 1) ImGui::PopItemDisabled(); DisplayTooltipIfHovered(TranslationManager::GetString(tstr_FloatingUIWindowAddTip)); ImGui::SameLine(); } // if (overlay_data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_ui) //Performance Monitor reset button (only show if UI overlay) { UpdatePerformanceMonitorButtons(); } else if (overlay_data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_browser) //Browser navigation/reload buttons (only show if browser overlay) { UpdateBrowserButtons(overlay_id); } } // //Drag-Mode Toggle Button (this is a global state) bool& is_dragmode_enabled = ConfigManager::GetRef(configid_bool_state_overlay_dragmode); bool dragmode_was_enabled = is_dragmode_enabled; bool& is_overlay_transform_locked = overlay_data.ConfigBool[configid_bool_overlay_transform_locked]; if (dragmode_was_enabled) ImGui::PushStyleColor(ImGuiCol_Button, ImGui::GetStyleColorVec4(ImGuiCol_ButtonActive)); TextureManager::Get().GetTextureInfo((is_overlay_transform_locked) ? tmtex_icon_small_move_locked : tmtex_icon_small_move, b_size, b_uv_min, b_uv_max); if (ImGui::ImageButton("DragMode", io.Fonts->TexID, b_size, b_uv_min, b_uv_max)) { if (io.MouseDownDurationPrev[ImGuiMouseButton_Left] < 1.5f) //Don't do normal button behavior after lock toggle was triggered { is_dragmode_enabled = !is_dragmode_enabled; IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_state_overlay_dragselectmode_show_hidden, false); IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_state_overlay_dragmode, is_dragmode_enabled); //Update temporary standing position if dragmode has been activated and dashboard tab isn't active if ((is_dragmode_enabled) && (!UIManager::Get()->IsOverlayBarOverlayVisible())) { UIManager::Get()->GetOverlayDragger().UpdateTempStandingPosition(); } } } //Toggle transform lock when holding for 1.5 seconds bool show_hold_message_lock = false; if (ImGui::IsItemActive()) { if (io.MouseDownDuration[ImGuiMouseButton_Left] > 1.5f) { is_overlay_transform_locked = !is_overlay_transform_locked; IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, (int)overlay_id); IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_overlay_transform_locked, is_overlay_transform_locked); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, -1); io.MouseDown[ImGuiMouseButton_Left] = false; //Release mouse button so actual button won't get toggled } else if (io.MouseDownDuration[ImGuiMouseButton_Left] > 0.5f) { show_hold_message_lock = true; } } if (dragmode_was_enabled) ImGui::PopStyleColor(); if (show_hold_message_lock) { DisplayTooltipIfHovered(TranslationManager::GetString((is_overlay_transform_locked) ? tstr_FloatingUIDragModeHoldUnlockTip: tstr_FloatingUIDragModeHoldLockTip)); } else { DisplayTooltipIfHovered(TranslationManager::GetString((dragmode_was_enabled) ? tstr_FloatingUIDragModeDisableTip : tstr_FloatingUIDragModeEnableTip)); } // ImGui::SameLine(); //Close/Disable Button TextureManager::Get().GetTextureInfo(tmtex_icon_small_close, b_size, b_uv_min, b_uv_max); if (ImGui::ImageButton("Close", io.Fonts->TexID, b_size, b_uv_min, b_uv_max)) { if (io.MouseDownDurationPrev[ImGuiMouseButton_Left] < 2.5f) //Don't do normal button behavior after lock toggle was triggered { overlay_data.ConfigBool[configid_bool_overlay_enabled] = false; IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, (int)overlay_id); IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_overlay_enabled, false); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, -1); } } //Toggle transform lock when holding for 2.5 seconds bool show_hold_message_remove = false; if (ImGui::IsItemActive()) { if (io.MouseDownDuration[ImGuiMouseButton_Left] > 2.5f) //Longer delay compared to other holds because this is pretty destructive (but still less than rare transform resets) { OverlayManager::Get().RemoveOverlay(overlay_id); IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_remove, overlay_id); //Hide properties window if it's open for this overlay WindowOverlayProperties& properties_window = UIManager::Get()->GetOverlayPropertiesWindow(); if (properties_window.GetActiveOverlayID() == overlay_id) { properties_window.SetActiveOverlayID(k_ulOverlayID_None, true); properties_window.HideAll(); } else if (properties_window.GetActiveOverlayID() > overlay_id) //Adjust properties window active overlay ID if it's open for an overlay that had its ID shifted { properties_window.SetActiveOverlayID(properties_window.GetActiveOverlayID() - 1, true); } io.MouseDown[ImGuiMouseButton_Left] = false; //Release mouse button so actual button won't get toggled } else if (io.MouseDownDuration[ImGuiMouseButton_Left] > 0.5f) { show_hold_message_remove = true; } } if (show_hold_message_remove) { DisplayTooltipIfHovered(TranslationManager::GetString(tstr_FloatingUIHideOverlayHoldTip)); } else { DisplayTooltipIfHovered(TranslationManager::GetString(tstr_FloatingUIHideOverlayTip)); } // ImGui::PopStyleColor(); //ImGuiCol_Button ImGui::PopStyleVar(); //ImGuiStyleVar_ItemSpacing ImGui::PopStyleVar(); //ImGuiStyleVar_FrameRounding m_Pos = ImGui::GetWindowPos(); m_Size = ImGui::GetWindowSize(); ImGui::End(); //Sliding animation when action-bar state changes if (UIManager::Get()->GetFloatingUI().GetAlpha() != 0.0f) { m_AnimationProgress += (is_actionbar_enabled) ? ImGui::GetIO().DeltaTime * 3.0f : ImGui::GetIO().DeltaTime * -3.0f; m_AnimationProgress = clamp(m_AnimationProgress, 0.0f, 1.0f); } else //Skip animation when Floating UI is just fading in { m_AnimationProgress = (is_actionbar_enabled) ? 1.0f : 0.0f; } } void WindowFloatingUIMainBar::UpdatePerformanceMonitorButtons() { ImGuiIO& io = ImGui::GetIO(); ImVec2 b_size, b_uv_min, b_uv_max; TextureManager::Get().GetTextureInfo(tmtex_icon_small_close, b_size, b_uv_min, b_uv_max); const ImGuiStyle& style = ImGui::GetStyle(); //Reset Cumulative Values Button TextureManager::Get().GetTextureInfo(tmtex_icon_small_performance_monitor_reset, b_size, b_uv_min, b_uv_max); if (ImGui::ImageButton("Perfmon Reset", io.Fonts->TexID, b_size, b_uv_min, b_uv_max)) { UIManager::Get()->GetPerformanceWindow().ResetCumulativeValues(); } DisplayTooltipIfHovered(TranslationManager::GetString(tstr_OvrlPropsPerfMonResetValues)); ImGui::SameLine(); } void WindowFloatingUIMainBar::UpdateBrowserButtons(unsigned int overlay_id) { //Use overlay data of duplication ID if one is set int duplication_id = OverlayManager::Get().GetConfigData(overlay_id).ConfigInt[configid_int_overlay_duplication_id]; OverlayConfigData& overlay_data = OverlayManager::Get().GetConfigData((duplication_id == -1) ? overlay_id : (unsigned int)duplication_id); ImGuiIO& io = ImGui::GetIO(); ImVec2 b_size, b_uv_min, b_uv_max; TextureManager::Get().GetTextureInfo(tmtex_icon_small_close, b_size, b_uv_min, b_uv_max); const ImGuiStyle& style = ImGui::GetStyle(); //Go Back Button if (!overlay_data.ConfigBool[configid_bool_overlay_state_browser_nav_can_go_back]) ImGui::PushItemDisabled(); TextureManager::Get().GetTextureInfo(tmtex_icon_small_browser_back, b_size, b_uv_min, b_uv_max); if (ImGui::ImageButton("GoBack", io.Fonts->TexID, b_size, b_uv_min, b_uv_max)) { DPBrowserAPIClient::Get().DPBrowser_GoBack(overlay_data.ConfigHandle[configid_handle_overlay_state_overlay_handle]); } if (!overlay_data.ConfigBool[configid_bool_overlay_state_browser_nav_can_go_back]) ImGui::PopItemDisabled(); DisplayTooltipIfHovered(TranslationManager::GetString(tstr_FloatingUIBrowserGoBackTip)); // ImGui::SameLine(); //Go Forward Button if (!overlay_data.ConfigBool[configid_bool_overlay_state_browser_nav_can_go_forward]) ImGui::PushItemDisabled(); TextureManager::Get().GetTextureInfo(tmtex_icon_small_browser_forward, b_size, b_uv_min, b_uv_max); if (ImGui::ImageButton("GoForward", io.Fonts->TexID, b_size, b_uv_min, b_uv_max)) { DPBrowserAPIClient::Get().DPBrowser_GoForward(overlay_data.ConfigHandle[configid_handle_overlay_state_overlay_handle]); } if (!overlay_data.ConfigBool[configid_bool_overlay_state_browser_nav_can_go_forward]) ImGui::PopItemDisabled(); DisplayTooltipIfHovered(TranslationManager::GetString(tstr_FloatingUIBrowserGoForwardTip)); // ImGui::SameLine(); //Refresh Button const bool is_loading = overlay_data.ConfigBool[configid_bool_overlay_state_browser_nav_is_loading]; TextureManager::Get().GetTextureInfo((is_loading) ? tmtex_icon_small_browser_stop : tmtex_icon_small_browser_refresh, b_size, b_uv_min, b_uv_max); if (ImGui::ImageButton("Refresh", io.Fonts->TexID, b_size, b_uv_min, b_uv_max)) { DPBrowserAPIClient::Get().DPBrowser_Refresh(overlay_data.ConfigHandle[configid_handle_overlay_state_overlay_handle]); } DisplayTooltipIfHovered(TranslationManager::GetString((is_loading) ? tstr_FloatingUIBrowserStopTip : tstr_FloatingUIBrowserRefreshTip)); // ImGui::SameLine(); } const ImVec2& WindowFloatingUIMainBar::GetPos() const { return m_Pos; } const ImVec2& WindowFloatingUIMainBar::GetSize() const { return m_Size; } float WindowFloatingUIMainBar::GetAnimationProgress() const { return m_AnimationProgress; } void WindowFloatingUIMainBar::MarkCurrentWindowCapturableStateOutdated() { //Mark state as outdated. We don't do the update here as the current window can change a lot while the UI isn't even displaying... no need to bother then. m_IsCurrentWindowCapturable = -1; if (UIManager::Get()->GetFloatingUI().IsVisible()) { UIManager::Get()->GetIdleState().AddActiveTime(50); } } //-WindowFloatingUIActionBar WindowFloatingUIActionBar::WindowFloatingUIActionBar() : m_Visible(false), m_Alpha(0.0f), m_LastDesktopSwitchTime(0.0), m_TooltipPositionForOverlayBar(false) { m_Size.x = 32.0f; } void WindowFloatingUIActionBar::DisplayTooltipIfHovered(const char* text) { if (ImGui::IsItemHovered()) { const ImGuiStyle& style = ImGui::GetStyle(); static ImVec2 button_pos_last; //Remember last position and use it when posible. This avoids flicker when the same tooltip string is used in different places ImVec2 pos = ImGui::GetItemRectMin(); float button_width = ImGui::GetItemRectSize().x; //Default tooltips are not suited for this as there's too much trouble with resize flickering and stuff ImGui::Begin(text, nullptr, ImGuiWindowFlags_NoInputs | ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoSavedSettings | ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_NoFocusOnAppearing); ImGui::TextUnformatted(text); //Not using GetWindowSize() here since it's delayed and plays odd when switching between buttons with the same label ImVec2 window_size = ImGui::GetItemRectSize(); window_size.x += style.WindowPadding.x * 2.0f; window_size.y += style.WindowPadding.y * 2.0f; //Repeat frame when the window is appearing as it will not have the right position (either from being first time or still having old pos) if ( (ImGui::IsWindowAppearing()) || (pos.x != button_pos_last.x) ) { UIManager::Get()->RepeatFrame(); } button_pos_last = pos; pos.x += (button_width / 2.0f) - (window_size.x / 2.0f); if (m_TooltipPositionForOverlayBar) { pos.y = ImGui::GetIO().DisplaySize.y; pos.y -= window_size.y; } else { pos.y -= window_size.y + style.WindowPadding.y + 2.0f; } //Clamp x so the tooltip does not get cut off pos.x = clamp(pos.x, 0.0f, ImGui::GetIO().DisplaySize.x - window_size.x); //Clamp right side to texture end ImGui::SetWindowPos(pos); ImGui::End(); } } void WindowFloatingUIActionBar::UpdateDesktopButtons(unsigned int overlay_id) { ImGui::PushID("DesktopButtons"); ImGuiIO& io = ImGui::GetIO(); ImVec2 b_size, b_uv_min, b_uv_max; OverlayConfigData& overlay_config = OverlayManager::Get().GetConfigData(overlay_id); ConfigID_Int current_configid = configid_int_overlay_desktop_id; bool disable_normal = false; bool disable_combined = false; if (overlay_config.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_winrt_capture) { current_configid = configid_int_overlay_winrt_desktop_id; //Check if buttons would be usable for WinRT capture disable_normal = !DPWinRT_IsCaptureFromHandleSupported(); disable_combined = !DPWinRT_IsCaptureFromCombinedDesktopSupported(); } int& current_desktop = overlay_config.ConfigInt[current_configid]; int current_desktop_new = current_desktop; if (ConfigManager::GetValue(configid_bool_interface_desktop_buttons_include_combined)) { if (disable_combined) ImGui::PushItemDisabled(); if (current_desktop == -1) ImGui::PushStyleColor(ImGuiCol_Button, Style_ImGuiCol_ButtonPassiveToggled); TextureManager::Get().GetTextureInfo(tmtex_icon_desktop_all, b_size, b_uv_min, b_uv_max); if (ImGui::ImageButton("Combined Desktop", io.Fonts->TexID, b_size, b_uv_min, b_uv_max, ImVec4(0.0f, 0.0f, 0.0f, 0.0f))) { //Don't change to same value to avoid flicker from mirror reset if ( (current_desktop != -1) || (!ConfigManager::GetValue(configid_bool_performance_single_desktop_mirroring)) ) { current_desktop_new = -1; } } DisplayTooltipIfHovered(TranslationManager::GetString(tstr_SourceDesktopAll)); ImGui::SameLine(); if (current_desktop == -1) ImGui::PopStyleColor(); if (disable_combined) ImGui::PopItemDisabled(); } int desktop_count = ConfigManager::GetValue(configid_int_state_interface_desktop_count); if (disable_normal) ImGui::PushItemDisabled(); switch (ConfigManager::GetValue(configid_int_interface_desktop_listing_style)) { case desktop_listing_style_individual: { for (int i = 0; i < desktop_count; ++i) { ImGui::PushID(tmtex_icon_desktop_1 + i); //We have icons for up to 6 desktops, the rest (if it even exists) gets blank ones) //Numbering on the icons starts with 1. //While there is no guarantee this corresponds to the same display as in the Windows settings, it is more familiar than the 0-based ID used internally //Why icon bitmaps? No need to create/load an icon font, cleaner rendered number and easily customizable icon per desktop for the end-user. if (tmtex_icon_desktop_1 + i <= tmtex_icon_desktop_6) TextureManager::Get().GetTextureInfo((TMNGRTexID)(tmtex_icon_desktop_1 + i), b_size, b_uv_min, b_uv_max); else TextureManager::Get().GetTextureInfo(tmtex_icon_desktop, b_size, b_uv_min, b_uv_max); if (i == current_desktop) ImGui::PushStyleColor(ImGuiCol_Button, Style_ImGuiCol_ButtonPassiveToggled); if (ImGui::ImageButton("", io.Fonts->TexID, b_size, b_uv_min, b_uv_max, ImVec4(0.0f, 0.0f, 0.0f, 0.0f))) { //Don't change to same value to avoid flicker from mirror reset if ( (i != current_desktop) || (!ConfigManager::GetValue(configid_bool_performance_single_desktop_mirroring)) ) { current_desktop_new = i; } } if (i == current_desktop) ImGui::PopStyleColor(); DisplayTooltipIfHovered(TranslationManager::Get().GetDesktopIDString(i)); ImGui::PopID(); ImGui::SameLine(); } break; } case desktop_listing_style_cycle: { TextureManager::Get().GetTextureInfo(tmtex_icon_desktop_prev, b_size, b_uv_min, b_uv_max); if (ImGui::ImageButton("Previous Desktop", io.Fonts->TexID, b_size, b_uv_min, b_uv_max, ImVec4(0.0f, 0.0f, 0.0f, 0.0f))) { current_desktop_new--; if (current_desktop_new <= -1) current_desktop_new = desktop_count - 1; } DisplayTooltipIfHovered(TranslationManager::GetString(tstr_FloatingUIActionBarDesktopPrev)); ImGui::SameLine(); TextureManager::Get().GetTextureInfo(tmtex_icon_desktop_next, b_size, b_uv_min, b_uv_max); if (ImGui::ImageButton("Next Destkop", io.Fonts->TexID, b_size, b_uv_min, b_uv_max, ImVec4(0.0f, 0.0f, 0.0f, 0.0f))) { current_desktop_new++; if (current_desktop_new == desktop_count) current_desktop_new = 0; } DisplayTooltipIfHovered(TranslationManager::GetString(tstr_FloatingUIActionBarDesktopNext)); ImGui::SameLine(); break; } } if (disable_normal) ImGui::PopItemDisabled(); if (current_desktop_new != current_desktop) { current_desktop = current_desktop_new; IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, (int)overlay_id); //Reset window selection when switching to a desktop if (current_configid == configid_int_overlay_winrt_desktop_id) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_handle_overlay_state_winrt_hwnd, 0); overlay_config.ConfigHandle[configid_handle_overlay_state_winrt_hwnd] = 0; } IPCManager::Get().PostConfigMessageToDashboardApp(current_configid, current_desktop); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, -1); //Update overlay name OverlayManager::Get().SetOverlayNameAuto(overlay_id); UIManager::Get()->OnOverlayNameChanged(); //Store last switch time for the anti-flicker code (only needed for dashboard origin) if (overlay_config.ConfigInt[configid_int_overlay_origin] == ovrl_origin_dashboard) { m_LastDesktopSwitchTime = ImGui::GetTime(); } } ImGui::PopID(); } void WindowFloatingUIActionBar::ButtonActionKeyboard(const Action& action, const ImVec2& size, unsigned int overlay_id) { FloatingWindow& keyboard_window = UIManager::Get()->GetVRKeyboard().GetWindow(); const ActionManager& action_manager = ConfigManager::Get().GetActionManager(); ImGuiIO& io = ImGui::GetIO(); const bool is_keyboard_visible = keyboard_window.IsVisible(); if (is_keyboard_visible) ImGui::PushStyleColor(ImGuiCol_Button, ImGui::GetStyleColorVec4(ImGuiCol_ButtonActive)); if (ButtonAction(action, size)) { if (io.MouseDownDurationPrev[ImGuiMouseButton_Left] < 3.0f) //Don't do normal button behavior after reset was just triggered { action_manager.DoAction(action.UID); //We only support DoAction here since we want holding down the button to not trigger the action already } } if (is_keyboard_visible) ImGui::PopStyleColor(); //Reset tranform when holding the button for 3 or more seconds TRMGRStrID tooltip_strid = (is_keyboard_visible) ? tstr_ActionKeyboardHide : tstr_ActionKeyboardShow; if (ImGui::IsItemActive()) { if (io.MouseDownDuration[ImGuiMouseButton_Left] > 3.0f) { //Unpin if dashboard overlay is available if ( (UIManager::Get()->IsOpenVRLoaded()) && (vr::VROverlay()->IsOverlayVisible(UIManager::Get()->GetOverlayHandleDPlusDashboard())) ) { keyboard_window.SetPinned(false); } keyboard_window.ResetTransformAll(); io.MouseDown[ImGuiMouseButton_Left] = false; //Release mouse button so transform changes don't get blocked } else if (io.MouseDownDuration[ImGuiMouseButton_Left] > 0.5f) { tooltip_strid = tstr_OverlayBarTooltipResetHold; } } //Show tooltip depending on current keyboard state DisplayTooltipIfHovered( TranslationManager::GetString(tooltip_strid) ); } void WindowFloatingUIActionBar::Show(bool skip_fade) { m_Visible = true; if (skip_fade) { m_Alpha = 1.0f; } } void WindowFloatingUIActionBar::Hide(bool skip_fade) { m_Visible = false; if (skip_fade) { m_Alpha = 0.0f; } } void WindowFloatingUIActionBar::Update(unsigned int overlay_id) { if ( (m_Alpha != 0.0f) || (m_Visible) ) { const float alpha_step = ImGui::GetIO().DeltaTime * 6.0f; //Alpha fade animation m_Alpha += (m_Visible) ? alpha_step : -alpha_step; if (m_Alpha > 1.0f) m_Alpha = 1.0f; else if (m_Alpha < 0.0f) m_Alpha = 0.0f; } //We need to not skip on alpha 0.0 at least twice to get the real height of the bar. 32.0f (and sometimes 16.0f) is the placeholder width ImGui seems to use until then if ( (m_Alpha == 0.0f) && (m_Size.x > 32.0f) ) return; ImGui::PushStyleVar(ImGuiStyleVar_Alpha, m_Alpha); ImGuiIO& io = ImGui::GetIO(); const ImGuiStyle& style = ImGui::GetStyle(); ImVec2 b_size, b_uv_min, b_uv_max; //Put window near the top of the overlay with space for the tooltips + padding const DPRect& rect_floating_ui = UITextureSpaces::Get().GetRect(ui_texspace_floating_ui); const float tooltip_height = ImGui::GetFontSize() + (style.WindowPadding.y * 2.0f); const float offset_y = rect_floating_ui.GetTL().y + tooltip_height + (style.FramePadding.y * 2.0f) + style.WindowPadding.y; ImGui::SetNextWindowPos(ImVec2(io.DisplaySize.x / 2.0f, offset_y), 0, ImVec2(0.5f, 0.0f)); ImGui::Begin("WindowFloatingUIActionBar", nullptr, ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoFocusOnAppearing | ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_HorizontalScrollbar | ImGuiWindowFlags_NoBringToFrontOnFocus); //Set focused ID when clicking anywhere on the window if ((ImGui::IsWindowHovered(ImGuiHoveredFlags_AllowWhenBlockedByActiveItem)) && (ImGui::IsMouseClicked(ImGuiMouseButton_Left))) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_focused_id, (int)overlay_id); IPCManager::Get().PostConfigMessageToUIApp(configid_int_state_overlay_focused_id, (int)overlay_id); //Sending to self to trigger change behavior } ImGui::PushStyleVar(ImGuiStyleVar_FrameRounding, 4.0f); ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, {style.ItemSpacing.y, style.ItemSpacing.y}); ImGui::PushStyleColor(ImGuiCol_Button, ImVec4(0, 0, 0, 0)); const ImVec2 cursor_pos = ImGui::GetCursorPos(); if (OverlayManager::Get().GetConfigData(overlay_id).ConfigBool[configid_bool_overlay_floatingui_desktops_enabled]) { UpdateDesktopButtons(overlay_id); } UpdateActionButtons(overlay_id); //Check if there any buttons added by above functions and if not, display placeholder text so the window doesn't look weird const ImVec2 cursor_pos_orig = ImGui::GetCursorPos(); if (cursor_pos_orig.x == cursor_pos.x) { //Match height of what a normal button would take up and middle-align the text ImVec2 b_size, b_uv_min, b_uv_max; TextureManager::Get().GetTextureInfo(tmtex_icon_settings, b_size, b_uv_min, b_uv_max); b_size.x += style.FramePadding.x * 2.0f; b_size.y += style.FramePadding.y * 2.0f; ImGui::Dummy({0.0f, b_size.y}); ImGui::SetCursorPosY(cursor_pos.y + (b_size.y / 2.0f) - (ImGui::GetFontSize() / 2.0f)); ImGui::TextUnformatted(TranslationManager::GetString(tstr_FloatingUIActionBarEmpty)); } ImGui::PopStyleColor(); //ImGuiCol_Button ImGui::PopStyleVar(); //ImGuiStyleVar_ItemSpacing ImGui::PopStyleVar(); //ImGuiStyleVar_FrameRounding m_Pos = ImGui::GetWindowPos(); m_Size = ImGui::GetWindowSize(); ImGui::End(); ImGui::PopStyleVar(); //ImGuiStyleVar_Alpha } const ImVec2& WindowFloatingUIActionBar::GetPos() const { return m_Pos; } const ImVec2& WindowFloatingUIActionBar::GetSize() const { return m_Size; } bool WindowFloatingUIActionBar::IsVisible() const { return m_Visible; } float WindowFloatingUIActionBar::GetAlpha() const { return m_Alpha; } double WindowFloatingUIActionBar::GetLastDesktopSwitchTime() const { return m_LastDesktopSwitchTime; } void WindowFloatingUIActionBar::UpdateActionButtons(unsigned int overlay_id) { //This function can be called by WindowOverlayBar to optionally put some action buttons in there too //It's a little bit hacky, but the only real difference is where to pull the action order from and how to display the tooltip bool is_overlay_bar = (overlay_id == k_ulOverlayID_None); m_TooltipPositionForOverlayBar = is_overlay_bar; ImGui::PushID("ActionButtons"); ImGui::PushStyleColor(ImGuiCol_ChildBg, ImVec4(0.00f, 0.00f, 0.00f, 0.00f)); ImGuiIO& io = ImGui::GetIO(); ImVec2 b_size, b_uv_min, b_uv_max; TextureManager::Get().GetTextureInfo(tmtex_icon_settings, b_size, b_uv_min, b_uv_max); //Default button size for custom actions to be the same as the settings icon so the user is able to provide oversized images without messing up the layout //as well as still providing a way to change the size of text buttons by editing the settings icon's dimensions ImVec2 b_size_default = b_size; const ActionManager& action_manager = ConfigManager::Get().GetActionManager(); OverlayConfigData& data = OverlayManager::Get().GetConfigData(overlay_id); const auto& action_order = (is_overlay_bar) ? action_manager.GetActionOrderListOverlayBar() : (data.ConfigBool[configid_bool_overlay_actionbar_order_use_global]) ? action_manager.GetActionOrderListBarDefault() : data.ConfigActionBarOrder; int list_id = 0; for (ActionUID uid : action_order) { const Action action = action_manager.GetAction(uid); //Detect normal Show Keyboard action by translation ID and provide special behavior if (action.NameTranslationID == tstr_DefActionShowKeyboard) { ButtonActionKeyboard(action, b_size, overlay_id); } else //Every other action { ButtonAction(action, b_size); if (ImGui::IsItemActivated()) { action_manager.StartAction(uid); } else if (ImGui::IsItemDeactivated()) { action_manager.StopAction(uid); } //Only display tooltip if the label isn't already on the button (is here since we need ImGui::IsItem*() to work on the button) if (action.Label.empty()) { DisplayTooltipIfHovered(action_manager.GetTranslatedName(uid)); } } ImGui::SameLine(); } ImGui::PopStyleColor(); //ImGuiCol_ChildBg ImGui::PopID(); m_TooltipPositionForOverlayBar = false; } bool WindowFloatingUIActionBar::ButtonAction(const Action& action, const ImVec2& size, bool use_temp_icon) { bool ret = false; ImGui::PushID((void*)action.UID); ImGui::BeginGroup(); const ImGuiStyle& style = ImGui::GetStyle(); if ((action.IconImGuiRectID != -1) || ((use_temp_icon) && (!action.IconFilename.empty()))) { ImGuiIO& io = ImGui::GetIO(); ImVec2 b_size, b_uv_min, b_uv_max; if (use_temp_icon) { TextureManager::Get().GetTextureInfo(tmtex_icon_temp, b_size, b_uv_min, b_uv_max); } else { TextureManager::Get().GetTextureInfo(action, b_size, b_uv_min, b_uv_max); } ret = ImGui::ImageButton("##ActionButtonImg", io.Fonts->TexID, size, b_uv_min, b_uv_max, ImVec4(0.0f, 0.0f, 0.0f, 0.0f)); } else { ret = ImGui::Button("##ActionButton", ImVec2(size.x + (style.FramePadding.x * 2.0f), size.y + (style.FramePadding.y * 2.0f)) ); } if (!action.Label.empty()) { ImGui::SameLine(0.0f, 0.0f); const char* label = (action.LabelTranslationID == tstr_NONE) ? action.Label.c_str() : TranslationManager::GetString(action.LabelTranslationID); const char* label_end = label + strlen(label); const char* line_start = label; const char* line_end = nullptr; const ImVec2 label_size = ImGui::CalcTextSize(label, label_end); const ImU32 col = ImGui::GetColorU32(ImGui::GetStyleColorVec4(ImGuiCol_Text)); const float pos_x = ImGui::GetCursorScreenPos().x - size.x - style.FramePadding.x; float pos_y = ImGui::GetCursorScreenPos().y + int( (size.y / 2.0f) - (label_size.y / 2.0f) ); while (line_start < label_end) { line_end = (const char*)memchr(line_start, '\n', label_end - line_start); if (line_end == nullptr) line_end = label_end; ImVec2 line_size = ImGui::CalcTextSize(line_start, line_end); float line_xscale = (size.x + style.FramePadding.x / 2.0f) / line_size.x; if (line_xscale > 1.0f) line_xscale = 1.0f; ImGui::BeginStretched(); ImGui::GetWindowDrawList()->AddText({pos_x + int( ((size.x / 2.0f) - (line_size.x * line_xscale) / 2.0f) ), pos_y}, col, line_start, line_end); ImGui::EndStretched(line_xscale); line_start = line_end + 1; pos_y += ImGui::GetTextLineHeight(); } } ImGui::EndGroup(); ImGui::PopID(); return ret; } //-WindowFloatingUIOverlayStats ImVec2 WindowFloatingUIOverlayStats::CalcPos(const WindowFloatingUIMainBar& mainbar, const WindowFloatingUIActionBar& actionbar, float& window_width) const { const ImGuiStyle& style = ImGui::GetStyle(); //Limit width to what we have left in the texture space const float max_width = (mainbar.GetPos().x - UITextureSpaces::Get().GetRect(ui_texspace_floating_ui).GetBL().x) - style.ItemSpacing.x; window_width = std::min(window_width, max_width); //Position the window left to either action- or main-bar, depending on visibility of action-bar (switching is animated alongside mainbar) //Additionally moves the window down if the action-bar occupies the horizontal space needed const ImVec2& actionbar_pos = actionbar.GetPos(); const ImVec2& actionbar_size = actionbar.GetSize(); const ImVec2& mainbar_pos = mainbar.GetPos(); const bool is_actionbar_blocking = (actionbar_pos.x < window_width + style.ItemSpacing.x); float max_x = actionbar_pos.x; if (is_actionbar_blocking) { const float space_width = mainbar.GetPos().x - actionbar_pos.x + style.ItemSpacing.x; //Space between left side of action-bar and left side of main-bar if (window_width > space_width) { max_x = mainbar_pos.x; } else { max_x = actionbar_pos.x + window_width + style.ItemSpacing.x; } } ImVec2 pos; pos.x = smoothstep(mainbar.GetAnimationProgress(), mainbar.GetPos().x, max_x); pos.x -= style.ItemSpacing.x; pos.y = smoothstep(mainbar.GetAnimationProgress(), actionbar_pos.y, (is_actionbar_blocking) ? actionbar_pos.y + actionbar_size.y + style.ItemSpacing.y : actionbar_pos.y); return pos; } void WindowFloatingUIOverlayStats::Update(const WindowFloatingUIMainBar& mainbar, const WindowFloatingUIActionBar& actionbar, unsigned int overlay_id) { const ImGuiStyle& style = ImGui::GetStyle(); const ImGuiWindowFlags window_flags = ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoFocusOnAppearing; const OverlayConfigData& overlay_data = OverlayManager::Get().GetConfigData(overlay_id); const bool show_fps = !overlay_data.ConfigBool[configid_bool_overlay_state_no_output]; if (show_fps) { //Don't display if disabled if (!ConfigManager::Get().GetValue(configid_bool_performance_show_fps)) return; //Use overlay data of duplication ID if one is set int duplication_id = OverlayManager::Get().GetConfigData(overlay_id).ConfigInt[configid_int_overlay_duplication_id]; const OverlayConfigData& overlay_data = OverlayManager::Get().GetConfigData((duplication_id == -1) ? overlay_id : (unsigned int)duplication_id); int fps = -1; if (overlay_data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_desktop_duplication) { fps = ConfigManager::GetValue(configid_int_state_performance_duplication_fps); } else if (overlay_data.ConfigInt[configid_int_overlay_capture_source] != ovrl_capsource_ui) { fps = overlay_data.ConfigInt[configid_int_overlay_state_fps]; } //Don't display window if no fps value available if (fps == -1) return; //This is a fixed size window, which seems like a bad idea for localization, but since it uses performance monitor strings it already uses size constrained text //(and "FPS" will be untranslated in practice) float window_width = ImGui::GetFontSize() * 3.5f; ImVec2 pos = CalcPos(mainbar, actionbar, window_width); //Actual window ImGui::SetNextWindowPos(pos, 0, ImVec2(1.0f, 0.0f)); ImGui::SetNextWindowSize(ImVec2(window_width, -1.0f)); ImGui::Begin("WindowFloatingUIStats", nullptr, window_flags); ImGui::TextUnformatted(TranslationManager::GetString(tstr_PerformanceMonitorFPS)); ImGui::SameLine(); ImGui::TextRight(0.0f, 0.0f, "%d", fps); ImGui::End(); } else //Show name { float window_width = ImGui::CalcTextSize(overlay_data.ConfigNameStr.c_str()).x + style.ItemSpacing.x + style.ItemSpacing.x; ImVec2 pos = CalcPos(mainbar, actionbar, window_width); //Actual window ImGui::SetNextWindowPos(pos, 0, ImVec2(1.0f, 0.0f)); ImGui::SetNextWindowSize(ImVec2(window_width, -1.0f)); ImGui::Begin("WindowFloatingUIStats", nullptr, window_flags); ImGui::TextUnformatted(overlay_data.ConfigNameStr.c_str()); ImGui::End(); } } ================================================ FILE: src/DesktopPlusUI/WindowFloatingUIBar.h ================================================ #pragma once #include "imgui.h" struct Action; //The main bar visible in the floating UI, containing buttons to hide the overlay, toggle drag-mode and show the Action-Bar class WindowFloatingUIMainBar { private: ImVec2 m_Pos; ImVec2 m_Size; int m_IsCurrentWindowCapturable; //-1 = needs update, otherwise bool float m_AnimationProgress; void DisplayTooltipIfHovered(const char* text); public: WindowFloatingUIMainBar(); void Update(float mainbar_height, unsigned int overlay_id); void UpdatePerformanceMonitorButtons(); void UpdateBrowserButtons(unsigned int overlay_id); const ImVec2& GetPos() const; const ImVec2& GetSize() const; float GetAnimationProgress() const; void MarkCurrentWindowCapturableStateOutdated(); }; //Action-Bar visible in the floating UI, containing desktop buttons and user-defined action buttons class WindowFloatingUIActionBar { private: ImVec2 m_Pos; ImVec2 m_Size; bool m_Visible; float m_Alpha; double m_LastDesktopSwitchTime; bool m_TooltipPositionForOverlayBar; //This is used instead of an extra argument to no have every custom button code need to be aware of this corner case void DisplayTooltipIfHovered(const char* text); void UpdateDesktopButtons(unsigned int overlay_id); void ButtonActionKeyboard(const Action& action, const ImVec2& size, unsigned int overlay_id); public: WindowFloatingUIActionBar(); void Show(bool skip_fade = false); void Hide(bool skip_fade = false); void Update(unsigned int overlay_id); const ImVec2& GetPos() const; const ImVec2& GetSize() const; bool IsVisible() const; float GetAlpha() const; double GetLastDesktopSwitchTime() const; void UpdateActionButtons(unsigned int overlay_id); //WindowOverlayBar can piggyback this function with k_ulOverlayID_None to get action buttons in its window static bool ButtonAction(const Action& action, const ImVec2& size, bool use_temp_icon = false); //use_temp_icon still needs icon filename set in action }; //Extra window currently only showing capture fps of the overlay if enabled class WindowFloatingUIOverlayStats { private: ImVec2 CalcPos(const WindowFloatingUIMainBar& mainbar, const WindowFloatingUIActionBar& actionbar, float& window_width) const; public: void Update(const WindowFloatingUIMainBar& mainbar, const WindowFloatingUIActionBar& actionbar, unsigned int overlay_id); }; ================================================ FILE: src/DesktopPlusUI/WindowKeyboard.cpp ================================================ #include "WindowKeyboard.h" #include "ImGuiExt.h" #include "TextureManager.h" #include "TranslationManager.h" #include "InterprocessMessaging.h" #include "Util.h" #include "OpenVRExt.h" #include "UIManager.h" #include "OverlayManager.h" #include #include "imgui_internal.h" //-WindowKeyboard WindowKeyboard::WindowKeyboard() : m_WindowWidth(-1.0f), m_IsAutoVisible(false), m_IsHovered(false), m_IsAnyButtonHovered(false), m_AssignedOverlayIDRoom(-1), m_AssignedOverlayIDDashboardTab(-1), m_IsIsoEnterDown(false), m_IsDashboardPointerActiveLast(false), m_UnstickModifiersLater(false), m_SubLayoutOverride(kbdlayout_sub_base), m_LastSubLayout(kbdlayout_sub_base) { m_WindowIcon = tmtex_icon_xsmall_keyboard; m_OvrlWidth = OVERLAY_WIDTH_METERS_KEYBOARD; m_OvrlWidthMax = OVERLAY_WIDTH_METERS_KEYBOARD * 5.0f; //Leave 2 pixel padding around so interpolation doesn't cut off the pixel border const DPRect& rect = UITextureSpaces::Get().GetRect(ui_texspace_keyboard); m_Size = {float(rect.GetWidth() - 4), float(rect.GetHeight() - 4)}; m_SizeUnscaled = m_Size; m_Pos = {(float)rect.GetCenter().x, (float)rect.GetCenter().y}; m_PosPivot = {0.5f, 0.5f}; m_WindowFlags |= ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_NoFocusOnAppearing; m_AllowRoomUnpinning = true; std::fill(std::begin(m_ManuallyStickingModifiers), std::end(m_ManuallyStickingModifiers), false); FloatingWindow::ResetTransformAll(); } void WindowKeyboard::UpdateVisibility() { //Set state depending on dashboard tab visibility if ( (!UIManager::Get()->IsInDesktopMode()) && (!m_IsTransitionFading) ) { const bool is_using_dashboard_state = (m_OverlayStateCurrentID == floating_window_ovrl_state_dashboard_tab); if (is_using_dashboard_state != vr::VROverlay()->IsOverlayVisible(UIManager::Get()->GetOverlayHandleDPlusDashboard())) { //Auto-visible keyboards don't persist between overlay state switches if (m_IsAutoVisible) { SetAssignedOverlayID(-1); Hide(); } OverlayStateSwitchCurrent(!is_using_dashboard_state); } } //Overlay position and visibility if (UIManager::Get()->IsOpenVRLoaded()) { vr::VROverlayHandle_t ovrl_handle_assigned = vr::k_ulOverlayHandleInvalid; vr::VROverlayHandle_t overlay_handle = GetOverlayHandle(); int assigned_overlay_id = GetAssignedOverlayID(); bool assigned_overlay_use_fallback_origin = false; if ( (m_OverlayStateCurrentID == floating_window_ovrl_state_room) && (assigned_overlay_id >= 0) ) { const OverlayConfigData& data = OverlayManager::Get().GetConfigData((unsigned int)assigned_overlay_id); ovrl_handle_assigned = data.ConfigHandle[configid_handle_overlay_state_overlay_handle]; assigned_overlay_use_fallback_origin = (data.ConfigInt[configid_int_overlay_origin] == ovrl_origin_theater_screen); //Theater Screen uses fallback origin if not pinned if (ovrl_handle_assigned != vr::k_ulOverlayHandleInvalid) { if (m_OverlayStateCurrent->IsVisible != vr::VROverlay()->IsOverlayVisible(ovrl_handle_assigned)) { (m_OverlayStateCurrent->IsVisible) ? Hide() : Show(); } } else //Overlay doesn't exist anymore, remove assignment { SetAssignedOverlayID(-1); } } if ((!m_OvrlVisible) && (m_OverlayStateCurrent->IsVisible)) { vr::VROverlay()->ShowOverlay(overlay_handle); m_OvrlVisible = true; ConfigManager::SetValue(configid_bool_state_keyboard_visible, true); IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_state_keyboard_visible, true); } if ((m_OvrlVisible) && (!m_OverlayStateCurrent->IsVisible) && (m_Alpha == 0.0f)) { vr::VROverlay()->HideOverlay(overlay_handle); m_OvrlVisible = false; ConfigManager::SetValue(configid_bool_state_keyboard_visible, false); IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_state_keyboard_visible, false); } //Set position if ( (m_OverlayStateCurrent->IsVisible) && (!m_IsTransitionFading) && (!UIManager::Get()->GetOverlayDragger().IsDragActive()) && (!UIManager::Get()->GetOverlayDragger().IsDragGestureActive()) ) { if ( (ovrl_handle_assigned != vr::k_ulOverlayHandleInvalid) && (!assigned_overlay_use_fallback_origin) ) //Based on assigned overlay { if (!m_OverlayStateCurrent->IsPinned) { Matrix4 matrix_m4 = OverlayManager::Get().GetOverlayCenterBottomTransform((unsigned int)assigned_overlay_id, ovrl_handle_assigned); UIManager::Get()->GetOverlayDragger().ApplyDashboardScale(matrix_m4); matrix_m4 *= m_OverlayStateCurrent->Transform; vr::HmdMatrix34_t matrix_ovr = matrix_m4.toOpenVR34(); vr::VROverlay()->SetOverlayTransformAbsolute(GetOverlayHandle(), vr::TrackingUniverseStanding, &matrix_ovr); m_OverlayStateCurrent->TransformAbs = matrix_m4; } } else if (m_OverlayStateCurrentID == floating_window_ovrl_state_dashboard_tab) //Based on dashboard tab { if ((!m_OverlayStateCurrent->IsPinned) && ( (!UIManager::Get()->IsDummyOverlayTransformUnstable()) || (m_Alpha != 1.0f) ) ) { vr::TrackingUniverseOrigin origin = vr::TrackingUniverseStanding; Matrix4 matrix_m4 = UIManager::Get()->GetOverlayDragger().GetBaseOffsetMatrix(ovrl_origin_dplus_tab) * m_OverlayStateCurrent->Transform; vr::HmdMatrix34_t matrix_ovr = matrix_m4.toOpenVR34(); vr::VROverlay()->SetOverlayTransformAbsolute(overlay_handle, origin, &matrix_ovr); m_OverlayStateCurrent->TransformAbs = matrix_m4; } } else if (!m_OverlayStateCurrent->IsPinned) //Based on m_TransformUIOrigin (fallback when above not available and unpinned) { if (!vr::VROverlay()->IsOverlayVisible(UIManager::Get()->GetOverlayHandleDPlusDashboard())) { Matrix4 matrix_m4 = m_TransformUIOrigin; matrix_m4 *= m_OverlayStateCurrent->Transform; vr::HmdMatrix34_t matrix_ovr = matrix_m4.toOpenVR34(); vr::VROverlay()->SetOverlayTransformAbsolute(GetOverlayHandle(), vr::TrackingUniverseStanding, &matrix_ovr); m_OverlayStateCurrent->TransformAbs = matrix_m4; } } } } } void WindowKeyboard::Show(bool skip_fade) { switch (UIManager::Get()->GetVRKeyboard().GetInputTarget()) { case kbdtarget_desktop: m_WindowTitleStrID = tstr_KeyboardWindowTitle; break; case kbdtarget_ui: m_WindowTitleStrID = tstr_KeyboardWindowTitleSettings; break; case kbdtarget_overlay: { m_WindowTitleStrID = tstr_NONE; m_WindowTitle = TranslationManager::Get().GetString(tstr_KeyboardWindowTitleOverlay); const unsigned int target_id = UIManager::Get()->GetVRKeyboard().GetInputTargetOverlayID(); if (target_id < OverlayManager::Get().GetOverlayCount()) { StringReplaceAll(m_WindowTitle, "%OVERLAYNAME%", OverlayManager::Get().GetConfigData(target_id).ConfigNameStr); } else { StringReplaceAll(m_WindowTitle, "%OVERLAYNAME%", TranslationManager::Get().GetString(tstr_KeyboardWindowTitleOverlayUnknown)); } } } //Update UI origin transform when newly visible, used when there's no overlay assignment to base the position off of if ( (m_Alpha == 0.0f) && (UIManager::Get()->IsOpenVRLoaded()) ) { //Get dashboard-similar transform and adjust it down a bit Matrix4 matrix_facing = vr::IVRSystemEx::ComputeHMDFacingTransform(1.15f); matrix_facing.translate_relative(0.0f, -0.50f, 0.0f); //dplus_tab origin contains dashboard scale, so apply it to this transform to stay consistent in size UIManager::Get()->GetOverlayDragger().ApplyDashboardScale(matrix_facing); m_TransformUIOrigin = matrix_facing; } ApplyCurrentOverlayState(); FloatingWindow::Show(skip_fade); } void WindowKeyboard::Hide(bool skip_fade) { m_IsAutoVisible = false; //Refuse to hide if window is currently being dragged and remove assignment if ( (UIManager::Get()->GetOverlayDragger().IsDragActive()) && (UIManager::Get()->GetOverlayDragger().GetDragOverlayHandle() == GetOverlayHandle()) ) { SetAssignedOverlayID(-1); return; } FloatingWindow::Hide(skip_fade); UIManager::Get()->GetVRKeyboard().OnWindowHidden(); } bool WindowKeyboard::SetAutoVisibility(int assigned_overlay_id, bool show) { if (show) { if (!IsVisible()) { SetAssignedOverlayID(assigned_overlay_id); m_IsAutoVisible = true; //This will not have a smooth transition if there was another auto-visible keyboard right before this, but let's skip the effort for that for now Show(); return true; } } else if ( (m_IsAutoVisible) && (GetAssignedOverlayID() == assigned_overlay_id) ) { //Don't auto-hide while any buttons are being hovered, mostly relevant for the title bar buttons if ((assigned_overlay_id == -2) && (m_IsAnyButtonHovered)) { return false; } SetAssignedOverlayID(-1); Hide(); return true; } return false; } void WindowKeyboard::WindowUpdate() { ImGuiIO& io = ImGui::GetIO(); ImGuiStyle& style = ImGui::GetStyle(); VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); //Set input state from the real mouse for ButtonLaser LaserInputState& state_real = GetLaserInputState(vr::k_unTrackedDeviceIndexOther); state_real.MouseState.SetFromGlobalState(); /* //--LaserInputState desktop mode debug testing code LaserInputState& state = GetLaserInputState(1); if (!ImGui::IsMousePosValid(&state.MouseState.MousePos)) { state.MouseState.MousePos = m_Pos; } if (ImGui::IsKeyDown(VK_NUMPAD4)) { state.MouseState.MousePos.x -= 5; } if (ImGui::IsKeyDown(VK_NUMPAD6)) { state.MouseState.MousePos.x += 5; } if (ImGui::IsKeyDown(VK_NUMPAD8)) { state.MouseState.MousePos.y -= 5; } if (ImGui::IsKeyDown(VK_NUMPAD2)) { state.MouseState.MousePos.y += 5; } state.MouseState.MouseDown[0] = ImGui::IsKeyDown(VK_NUMPAD7); state.MouseState.MouseDown[1] = ImGui::IsKeyDown(VK_NUMPAD9); //-- */ if (!UIManager::Get()->IsInDesktopMode()) { vr::TrackedDeviceIndex_t primary_device = ConfigManager::Get().GetPrimaryLaserPointerDevice(); bool dashboard_device_exists = vr::IVROverlayEx::IsSystemLaserPointerActive(); //Overlay leave events are not processed when a dashboard pointer exists changes active state, so make sure to get the pointers out of the way anyways if (dashboard_device_exists != m_IsDashboardPointerActiveLast) { for (auto& state : m_LaserInputStates) { //Pointer left the overlay state.MouseState.MousePos = ImVec2(-FLT_MAX, -FLT_MAX); //Release mouse buttons if they're held down std::fill(std::begin(state.MouseState.MouseDown), std::end(state.MouseState.MouseDown), false); } state_real.MouseState.ApplyToGlobalState(); m_IsDashboardPointerActiveLast = dashboard_device_exists; } //Render pointer blobs for any input that isn't already controlled by the mouse //Use pos/size from ImGui since our stored members describe center pivoted max window space const ImVec2 cur_pos = ImGui::GetWindowPos(); const ImVec2 cur_size = ImGui::GetWindowSize(); const ImRect window_bb(cur_pos.x, cur_pos.y, cur_pos.x + cur_size.x, cur_pos.y + cur_size.y); for (auto& state : m_LaserInputStates) { if ( (state.DeviceIndex != vr::k_unTrackedDeviceIndexOther) && (state.DeviceIndex != primary_device) ) { //Only render if inside window if ((!dashboard_device_exists) && (window_bb.Contains(state.MouseState.MousePos))) { ImGui::GetForegroundDrawList()->AddCircleFilled(state.MouseState.MousePos, 7.0f, ImGui::GetColorU32(Style_ImGuiCol_SteamVRCursorBorder)); ImGui::GetForegroundDrawList()->AddCircleFilled(state.MouseState.MousePos, 5.0f, ImGui::GetColorU32(Style_ImGuiCol_SteamVRCursor)); } //Also advance the mouse state as if it was managed by ImGui state.MouseState.Advance(); } } } //Increased key repeat delay and rate for the VR keyboard buttons const float key_repeat_delay_old = io.KeyRepeatDelay; const float key_repeat_delay_rate = io.KeyRepeatRate; io.KeyRepeatDelay = 0.5f; io.KeyRepeatRate = 0.025f; //Exclude title bar buttons from hovered state to get regular widget focus behavior on them const bool is_hovering_titlebar_buttons = ((ImGui::IsWindowHovered(ImGuiHoveredFlags_AllowWhenBlockedByActiveItem | ImGuiHoveredFlags_AllowWhenBlockedByPopup)) && (io.MousePos.y < ImGui::GetCursorScreenPos().y - style.WindowPadding.y) && (!m_IsTitleBarHovered)); m_IsHovered = ((ImGui::IsWindowHovered(ImGuiHoveredFlags_AllowWhenBlockedByActiveItem | ImGuiHoveredFlags_AllowWhenBlockedByPopup)) && (!is_hovering_titlebar_buttons)); //Keyboard buttons use their own window-local active widget state in order to not interrupt active InputText() widgets. This is a dirty hack, but works for now ImGui::ActiveWidgetStateStorage widget_state_back; widget_state_back.StoreCurrentState(); m_KeyboardWidgetState.AdvanceState(); m_KeyboardWidgetState.ApplyState(); //Enable button repeat if setting is enabled const bool use_key_repeat_global = ConfigManager::GetValue(configid_bool_input_keyboard_key_repeat); if (use_key_repeat_global) ImGui::PushItemFlag(ImGuiItemFlags_ButtonRepeat, true); const float base_width = (float)int(ImGui::GetTextLineHeightWithSpacing() * 2.225f); //Used for kbdlayout_key_virtual_key_iso_enter key ImVec2 iso_enter_top_pos(-1.0f, -1.0f); float iso_enter_top_width = -1.0f; int iso_enter_top_index = -1; int iso_enter_button_state = 0; int iso_enter_click_state = 0; bool iso_enter_hovered = false; KeyboardLayoutSubLayout current_sublayout = kbdlayout_sub_base; //Select sublayout based on current state if (m_SubLayoutOverride != kbdlayout_sub_base) { current_sublayout = m_SubLayoutOverride; } else if ((vr_keyboard.GetLayoutMetadata().HasAltGr) && (vr_keyboard.GetKeyDown(VK_RMENU)) && (!vr_keyboard.GetLayout(kbdlayout_sub_altgr).empty())) { current_sublayout = kbdlayout_sub_altgr; } else if ((vr_keyboard.GetKeyDown(VK_SHIFT) != vr_keyboard.IsCapsLockToggled())) { current_sublayout = kbdlayout_sub_shift; } //Resize button state storage if necessary if (vr_keyboard.GetLayout(current_sublayout).size() > m_ButtonStates.size()) { m_ButtonStates.resize(vr_keyboard.GetLayout(current_sublayout).size()); } //Release keys that may have been held down when the sublayout switched (buttons won't fire release when they just disappear from that) if (current_sublayout != m_LastSubLayout) { //Reset button state, but try to keep the same keys pressed if they exist in the new layout std::vector button_states_prev = m_ButtonStates; std::fill(m_ButtonStates.begin(), m_ButtonStates.end(), ButtonLaserState()); const bool sticky_modifiers_enabled = ConfigManager::GetValue(configid_bool_input_keyboard_sticky_modifiers); int key_index = 0; for (const auto& key : vr_keyboard.GetLayout(m_LastSubLayout)) { ButtonLaserState& button_state = button_states_prev[key_index]; //If down, try to find same keys in both layouts if (button_state.IsDown) { int key_index_new = FindSameKeyInNewSubLayout(key_index, m_LastSubLayout, current_sublayout); if (key_index_new != -1) { m_ButtonStates[key_index_new] = button_state; } else { switch (key.KeyType) { case kbdlayout_key_virtual_key: { OnVirtualKeyUp(key.KeyCode); break; } case kbdlayout_key_virtual_key_iso_enter: { OnVirtualKeyUp(key.KeyCode); m_IsIsoEnterDown = false; break; } case kbdlayout_key_string: { OnStringKeyUp(key.KeyString); break; } case kbdlayout_key_action: { vr_keyboard.SetActionDown(key.KeyActionUID, false); break; } default: break; } } } key_index++; } ImGui::ClearActiveID(); } //Handle scheduled modifier releases if (m_UnstickModifiersLater) { const unsigned char keycodes[] = {VK_LSHIFT, VK_RSHIFT, VK_LCONTROL, VK_RCONTROL, VK_LMENU, VK_RMENU, VK_LWIN, VK_RWIN}; //Release modifier keys unless they were manually sticky-ed by right-clicking them for (auto keycode : keycodes) { if (!m_ManuallyStickingModifiers[GetModifierID(keycode)]) { vr_keyboard.SetKeyDown(keycode, false); //Look up correct button state to remove IsDown state int key_index = 0; for (const auto& key : vr_keyboard.GetLayout(current_sublayout)) { if (key.KeyCode == keycode) { m_ButtonStates[key_index].IsDown = false; break; } key_index++; } } } m_UnstickModifiersLater = false; } //Default to title bar button hover state as m_IsAnyButtonHovered is checked for blocking auto-hiding m_IsAnyButtonHovered = is_hovering_titlebar_buttons; int key_index = 0; ImVec2 cursor_pos = ImGui::GetCursorPos(); for (const auto& key : vr_keyboard.GetLayout(current_sublayout)) { ButtonLaserState& button_state = m_ButtonStates[key_index]; ImGui::PushID(key_index); //Keep cursor pos on integer values cursor_pos = ImGui::GetCursorPos(); ImGui::SetCursorPos({ceilf(cursor_pos.x), ceilf(cursor_pos.y)}); //This accounts for the spacing that is missing with wider keys so rows still line up and also forces integer values const float key_width_f = base_width * key.Width + (style.ItemInnerSpacing.x * (key.Width - 1.0f)); const float key_height = (float)(int)( base_width * key.Height + (style.ItemInnerSpacing.y * (key.Height - 1.0f)) ); float key_width = (float)(int)( key_width_f ); //Add an extra pixel of width if the untruncated values would push it further //There might be a smarter way to do this (simple rounding doesn't seem to be it), but this helps the keys align while rendering on full pixels only if (cursor_pos.x + key_width_f > ImGui::GetCursorPosX() + key_width) { key_width += 1.0f; } //Disable button repeat if the individual key has its key repeat disabled (avoid doing it when it's already off though) const bool use_key_repeat = ((use_key_repeat_global) && (!key.NoRepeat)); if ((use_key_repeat_global) && (!use_key_repeat)) ImGui::PushItemFlag(ImGuiItemFlags_ButtonRepeat, false); //Set horizontal label alignment if needed if (key.LabelHAlignment != 0.5f) ImGui::PushStyleVarX(ImGuiStyleVar_ButtonTextAlign, key.LabelHAlignment); switch (key.KeyType) { case kbdlayout_key_blank_space: { ImGui::Dummy({key_width, key_height}); break; } case kbdlayout_key_virtual_key: { const bool is_down = vr_keyboard.GetKeyDown(key.KeyCode); const bool push_color = ((is_down) && (button_state.IsDown)); //Prevent flickering when repeat is active and there are multiple keys with the same key code if (push_color) ImGui::PushStyleColor(ImGuiCol_Button, ImGui::GetStyleColorVec4(ImGuiCol_ButtonActive)); //We don't want key repeat on backspace for ImGui since it does that itself const bool repeat_on_backspace = ((vr_keyboard.GetInputTarget() != kbdtarget_ui) || (key.KeyCode != VK_BACK)); if ( (ButtonLaser(key.Label.c_str(), {key_width, key_height}, button_state, key.IsLabelMultiline)) && (use_key_repeat) && (repeat_on_backspace) ) { (is_down) ? OnVirtualKeyUp(key.KeyCode, key.BlockModifiers) : OnVirtualKeyDown(key.KeyCode, key.BlockModifiers); button_state.IsDown = !button_state.IsDown; } if (button_state.IsActivated) { OnVirtualKeyDown(key.KeyCode, key.BlockModifiers); button_state.IsDown = true; } else if (button_state.IsDeactivated) { OnVirtualKeyUp(key.KeyCode, key.BlockModifiers); button_state.IsDown = false; } //Right click to toggle key if (button_state.IsRightClicked) { (is_down) ? OnVirtualKeyUp(key.KeyCode, key.BlockModifiers) : OnVirtualKeyDown(key.KeyCode, key.BlockModifiers); button_state.IsDown = !button_state.IsDown; SetManualStickyModifierState(key.KeyCode, !is_down); } if (push_color) ImGui::PopStyleColor(); break; } case kbdlayout_key_virtual_key_toggle: { if (use_key_repeat) ImGui::PushItemFlag(ImGuiItemFlags_ButtonRepeat, false); const bool is_down = vr_keyboard.GetKeyDown(key.KeyCode); const bool push_color = ((is_down) && (button_state.IsDown)); if (push_color) ImGui::PushStyleColor(ImGuiCol_Button, ImGui::GetStyleColorVec4(ImGuiCol_ButtonActive)); //Allow right click too to be consistent with toggling normal virtual keys if ( (ButtonLaser(key.Label.c_str(), {key_width, key_height}, button_state, key.IsLabelMultiline)) || (button_state.IsRightClicked) ) { (is_down) ? OnVirtualKeyUp(key.KeyCode) : OnVirtualKeyDown(key.KeyCode); button_state.IsDown = !button_state.IsDown; if (button_state.IsRightClicked) { SetManualStickyModifierState(key.KeyCode, !is_down); } } if (push_color) ImGui::PopStyleColor(); if (use_key_repeat) ImGui::PopItemFlag(); break; } case kbdlayout_key_virtual_key_iso_enter: { //This one's a bit of a mess, but builds an ISO-Enter shaped button out of two key entries //First step is the top "key". Its label is unused, but the width is. //Second step is the bottom "key". It stretches itself over the row above it and hosts the label. //First and second step used invisible buttons first to check item state and have it synced up, //then in the second step there are two visual-only buttons used with style color adjusted to the state of the invisible buttons // //...now that a custom button implementation is used anyways this could be solved more cleanly... but it still works, so eh. const bool is_bottom_key = (iso_enter_top_index != -1); const ImVec2 cursor_pos = ImGui::GetCursorPos(); float offset_y = 0.0f; //If second ISO-enter key, offset cursor to the previous row and stretch the button down to the end of the current row if (is_bottom_key) { offset_y = style.ItemSpacing.y + base_width; ImGui::SetCursorPosY(ImGui::GetCursorPosY() - offset_y); } else //else remember the width of the top part for later { iso_enter_top_pos = cursor_pos; iso_enter_top_width = key_width; iso_enter_top_index = key_index; } //Use an invisible button to collect active state from either (ImGui::InivisbleButton() does not pass button repeat flag, so can't be used here) ImGui::PushStyleColor(ImGuiCol_Button, {0.0f, 0.0f, 0.0f, 0.0f}); ImGui::PushStyleColor(ImGuiCol_ButtonHovered, {0.0f, 0.0f, 0.0f, 0.0f}); ImGui::PushStyleColor(ImGuiCol_ButtonActive, {0.0f, 0.0f, 0.0f, 0.0f}); if ( (ButtonLaser("##IsoEnterDummy", {key_width, base_width + offset_y}, button_state)) && (use_key_repeat) ) { iso_enter_click_state = 3; } ImGui::PopStyleColor(3); if (button_state.IsHeld) { iso_enter_button_state = 2; } if (button_state.IsHovered) { if (button_state.IsRightClicked) { iso_enter_click_state = 4; } iso_enter_button_state = std::max(1, iso_enter_button_state); iso_enter_hovered = true; } if (button_state.IsActivated) { iso_enter_click_state = 1; } else if (button_state.IsDeactivated) { iso_enter_click_state = 2; } //If second ISO-enter key, create two visible buttons that match the active state collected from the invisible buttons (but otherwise don't do anything) if (is_bottom_key) { ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); bool push_color = ((vr_keyboard.GetKeyDown(key.KeyCode)) && (m_IsIsoEnterDown)); //Adjust button state depending on whether any invisible button was hovered to match ImGui behavior if ( (iso_enter_button_state == 0) && (iso_enter_hovered) ) iso_enter_button_state = 1; else if (!iso_enter_hovered) iso_enter_button_state = 0; if (iso_enter_button_state == 1) ImGui::PushStyleColor(ImGuiCol_Button, ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered)); else if ( (iso_enter_button_state >= 2) || (push_color) ) ImGui::PushStyleColor(ImGuiCol_Button, ImGui::GetStyleColorVec4(ImGuiCol_ButtonActive)); //Upper part without label ImGui::SetCursorPos(iso_enter_top_pos); //Shorten width by rounding so it doesn't stack corner AA ButtonVisual("##IsoEnterTop", {iso_enter_top_width - style.FrameRounding, base_width}); //Lower part with label ImGui::SetCursorPos({cursor_pos.x, cursor_pos.y - offset_y}); ButtonVisual(key.Label.c_str(), {key_width, base_width + offset_y}, key.IsLabelMultiline); //React to button click state if ( ( (iso_enter_click_state == 3) /*button clicked*/ && (use_key_repeat) ) || (iso_enter_click_state == 4) /*button right-clicked*/) { bool is_down = vr_keyboard.GetKeyDown(key.KeyCode); (is_down) ? OnVirtualKeyUp(key.KeyCode) : OnVirtualKeyDown(key.KeyCode); if (iso_enter_click_state == 4) //button right-clicked { SetManualStickyModifierState(key.KeyCode, !is_down); m_IsIsoEnterDown = !m_IsIsoEnterDown; } } if (iso_enter_click_state == 1) //button pressed { OnVirtualKeyDown(key.KeyCode); m_IsIsoEnterDown = true; } else if (iso_enter_click_state == 2) //button released { OnVirtualKeyUp(key.KeyCode); m_IsIsoEnterDown = false; } if ( (iso_enter_button_state != 0) || (push_color) ) ImGui::PopStyleColor(); //Sync up button hover state for haptics m_ButtonStates[iso_enter_top_index].IsHovered = iso_enter_hovered; button_state.IsHovered = iso_enter_hovered; //Restore cursor to normal row position ImGui::SameLine(0.0f, 0.0f); ImGui::SetCursorPosY( (key.IsRowEnd) ? ImGui::GetCursorPosY() : ImGui::GetCursorPosY() + offset_y); ImGui::Dummy({0.0f, base_width}); ImGui::SetPreviousLineHeight(ImGui::GetPreviousLineHeight() - offset_y); } break; } case kbdlayout_key_string: { const bool is_down = button_state.IsDown; if (is_down) ImGui::PushStyleColor(ImGuiCol_Button, ImGui::GetStyleColorVec4(ImGuiCol_ButtonActive)); if ( (ButtonLaser(key.Label.c_str(), {key_width, key_height}, button_state, key.IsLabelMultiline)) && (use_key_repeat) ) { (button_state.IsDown) ? OnStringKeyUp(key.KeyString) : OnStringKeyDown(key.KeyString); button_state.IsDown = !button_state.IsDown; } if (button_state.IsActivated) { OnStringKeyDown(key.KeyString); button_state.IsDown = true; } else if (button_state.IsDeactivated) { OnStringKeyUp(key.KeyString); button_state.IsDown = false; } //Right click to toggle key, only works properly when string maps to virtual key if (button_state.IsRightClicked) { (button_state.IsDown) ? OnStringKeyUp(key.KeyString) : OnStringKeyDown(key.KeyString); button_state.IsDown = !button_state.IsDown; } if (is_down) ImGui::PopStyleColor(); break; } case kbdlayout_key_sublayout_toggle: { if (use_key_repeat) ImGui::PushItemFlag(ImGuiItemFlags_ButtonRepeat, false); const bool is_down = (m_SubLayoutOverride == key.KeySubLayoutToggle); if (is_down) ImGui::PushStyleColor(ImGuiCol_Button, ImGui::GetStyleColorVec4(ImGuiCol_ButtonActive)); //Allow right click too to be consistent with toggling normal virtual keys if ( (ButtonLaser(key.Label.c_str(), {key_width, key_height}, button_state, key.IsLabelMultiline)) || (button_state.IsRightClicked) ) { m_SubLayoutOverride = (is_down) ? kbdlayout_sub_base : key.KeySubLayoutToggle; } if (is_down) ImGui::PopStyleColor(); if (use_key_repeat) ImGui::PopItemFlag(); break; } case kbdlayout_key_action: { const bool is_down = button_state.IsDown; if (is_down) ImGui::PushStyleColor(ImGuiCol_Button, ImGui::GetStyleColorVec4(ImGuiCol_ButtonActive)); if ( (ButtonLaser(key.Label.c_str(), {key_width, key_height}, button_state, key.IsLabelMultiline)) && (use_key_repeat) ) { vr_keyboard.SetActionDown(key.KeyActionUID, !button_state.IsDown); button_state.IsDown = !button_state.IsDown; } if (button_state.IsActivated) { vr_keyboard.SetActionDown(key.KeyActionUID, true); button_state.IsDown = true; } else if (button_state.IsDeactivated) { vr_keyboard.SetActionDown(key.KeyActionUID, false); button_state.IsDown = false; } //Right click to toggle key if (button_state.IsRightClicked) { vr_keyboard.SetActionDown(key.KeyActionUID, !button_state.IsDown); button_state.IsDown = !button_state.IsDown; } if (is_down) ImGui::PopStyleColor(); break; } default: break; } //Return to normal row position if the key was taller than 100% if (key.Height > 1.0f) { ImGui::SetCursorPosY(ImGui::GetCursorPosY() - key_height + base_width); ImGui::SetPreviousLineHeight(ImGui::GetPreviousLineHeight() - key_height + base_width); } if (!key.IsRowEnd) { ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); cursor_pos.x += key_width_f; } //Undo label alignment if necessary if (key.LabelHAlignment != 0.5f) ImGui::PopStyleVar(); //Undo disabled button repeat if necessary if ((use_key_repeat_global) && (!use_key_repeat)) ImGui::PopItemFlag(); ImGui::PopID(); key_index++; } m_LastSubLayout = current_sublayout; if (use_key_repeat_global) ImGui::PopItemFlag(); m_KeyboardWidgetState.StoreCurrentState(); widget_state_back.ApplyState(); io.KeyRepeatDelay = key_repeat_delay_old; io.KeyRepeatRate = key_repeat_delay_rate; } void WindowKeyboard::OnWindowPinButtonPressed() { FloatingWindow::OnWindowPinButtonPressed(); //Disable auto-hiding that may happen when the keyboard is no longer hovered after pressing this m_IsAutoVisible = false; } void WindowKeyboard::OnWindowCloseButtonPressed() { //Remove assignment on close button press to not just have to pop up again from overlay visbility tracking (but only when in room state) if (m_OverlayStateCurrentID == floating_window_ovrl_state_room) { SetAssignedOverlayID(-1); } } bool WindowKeyboard::IsVirtualWindowItemHovered() const { return m_IsAnyButtonHovered; } void WindowKeyboard::OnVirtualKeyDown(unsigned char keycode, bool block_modifiers) { VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); vr_keyboard.SetKeyDown(keycode, true, block_modifiers); if ((keycode != VK_BACK) && (keycode != VK_TAB)) { HandleUnstickyModifiers(keycode); } } void WindowKeyboard::OnVirtualKeyUp(unsigned char keycode, bool block_modifiers) { VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); vr_keyboard.SetKeyDown(keycode, false, block_modifiers); } void WindowKeyboard::OnStringKeyDown(const std::string& keystring) { VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); HandleUnstickyModifiers(); vr_keyboard.SetStringDown(keystring, true); } void WindowKeyboard::OnStringKeyUp(const std::string& keystring) { VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); vr_keyboard.SetStringDown(keystring, false); } void WindowKeyboard::HandleUnstickyModifiers(unsigned char source_keycode) { //Skip if modifiers are set to be sticky if (ConfigManager::GetValue(configid_bool_input_keyboard_sticky_modifiers)) return; //Schedule releasing modifier keys next frame if this wasn't called for any of them switch (source_keycode) { case VK_SHIFT: case VK_LSHIFT: case VK_RSHIFT: case VK_CONTROL: case VK_LCONTROL: case VK_RCONTROL: case VK_MENU: case VK_LMENU: case VK_RMENU: case VK_LWIN: case VK_RWIN: { break; } default: { m_UnstickModifiersLater = true; } } } void WindowKeyboard::SetManualStickyModifierState(unsigned char keycode, bool is_down) { const int modifier_id = GetModifierID(keycode); if (modifier_id != -1) { m_ManuallyStickingModifiers[modifier_id] = is_down; } } int WindowKeyboard::GetModifierID(unsigned char keycode) { switch (keycode) { case VK_SHIFT: { return 0; break; } case VK_CONTROL: { return VK_LCONTROL - VK_LSHIFT; break; } case VK_MENU: { return VK_LMENU - VK_LSHIFT; break; } case VK_LSHIFT: case VK_RSHIFT: case VK_LCONTROL: case VK_RCONTROL: case VK_LMENU: case VK_RMENU: { return keycode - VK_LSHIFT; } case VK_LWIN: case VK_RWIN: { return (keycode - VK_LWIN) + 7; break; } default: { break; } } return -1; } int WindowKeyboard::FindSameKeyInNewSubLayout(int key_index, KeyboardLayoutSubLayout sublayout_id_current, KeyboardLayoutSubLayout sublayout_id_new) { //Return index of key at the position as sublayout_current's key_index key exists and has the same function (i.e. the same key, but possibly with different label and index) VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); const auto& sublayout_current = vr_keyboard.GetLayout(sublayout_id_current); const auto& sublayout_new = vr_keyboard.GetLayout(sublayout_id_new); //Skip if index doesn't exist in layout for some reason if (sublayout_current.size() <= key_index) return -1; //Get key position in current layout int i = 0; ImVec2 key_current_pos; const KeyboardLayoutKey* key_ptr_current = nullptr; for (const auto& key : sublayout_current) { if (i == key_index) { key_ptr_current = &key; break; } key_current_pos.x += key.Width; if (key.IsRowEnd) { key_current_pos.x = 0.0f; key_current_pos.y += 1.0f; //Key height doesn't matter, advance a row } i++; } if (key_ptr_current == nullptr) return -1; //Find key at position in new layout i = 0; ImVec2 key_new_pos; for (const auto& key : sublayout_new) { if ( (key_new_pos.y == key_current_pos.y) && (key_new_pos.x == key_current_pos.x) ) { //Key exists at the same position, check if it's same function if (key_ptr_current->KeyType == key.KeyType) { switch (key.KeyType) { case kbdlayout_key_virtual_key: case kbdlayout_key_virtual_key_toggle: case kbdlayout_key_virtual_key_iso_enter: { if (key.KeyCode == key_ptr_current->KeyCode) { return i; } break; } case kbdlayout_key_string: { if (key.KeyString == key_ptr_current->KeyString) { return i; } break; } case kbdlayout_key_sublayout_toggle: { if (key.KeySubLayoutToggle == key_ptr_current->KeySubLayoutToggle) //This one seems a bit useless { return i; } break; } case kbdlayout_key_action: { if (key.KeyActionUID == key_ptr_current->KeyActionUID) { return i; } break; } } } return -1; } else if (key_new_pos.y > key_current_pos.y) //We went past, break { break; } key_new_pos.x += key.Width; if (key.IsRowEnd) { key_new_pos.x = 0.0f; key_new_pos.y += 1.0f; } i++; } return -1; } LaserInputState& WindowKeyboard::GetLaserInputState(vr::TrackedDeviceIndex_t device_index) { auto it = std::find_if(m_LaserInputStates.begin(), m_LaserInputStates.end(), [&](const auto& state){ return (state.DeviceIndex == device_index); }); //Add if device isn't in the list yet if (it == m_LaserInputStates.end()) { m_LaserInputStates.push_back(LaserInputState()); it = m_LaserInputStates.end() - 1; it->DeviceIndex = device_index; } return *it; } bool WindowKeyboard::ButtonLaser(const char* label, const ImVec2& size_arg, ButtonLaserState& button_state, bool is_label_multiline) { ImGuiWindow* window = ImGui::GetCurrentWindow(); if (window->SkipItems) return false; ImGuiContext& g = *GImGui; const ImGuiStyle& style = g.Style; const ImGuiID id = window->GetID(label); const ImVec2 label_size = ImGui::CalcTextSize(label, nullptr, true); const ImVec2 half_spacing(style.ItemSpacing.x / 2.0f, style.ItemSpacing.y / 2.0f); ImVec2 pos = window->DC.CursorPos; ImVec2 size = ImGui::CalcItemSize(size_arg, label_size.x + style.FramePadding.x * 2.0f, label_size.y + style.FramePadding.y * 2.0f); const ImRect bb(pos.x, pos.y, pos.x + size.x, pos.y + size.y); const ImRect bb_with_spacing(bb.Min.x - half_spacing.x, bb.Min.y - half_spacing.y, bb.Max.x + half_spacing.x, bb.Max.y + half_spacing.y); ImGui::ItemSize(size, style.FramePadding.y); if (!ImGui::ItemAdd(bb, id)) return false; bool do_repeat = (g.LastItemData.ItemFlags & ImGuiItemFlags_ButtonRepeat); //Check all laser input states for potential input on the button LaserInputState orig_state; orig_state.MouseState.SetFromGlobalState(); const ImGuiMouseButton mouse_button = ImGuiMouseButton_Left; const ImGuiMouseButton mouse_button_right = ImGuiMouseButton_Right; bool is_global_mouse_state_modified = false; bool is_any_hovering = false, is_pressed = false, is_held = button_state.IsHeld, is_released = false; button_state.IsRightClicked = false; if ( (!UIManager::Get()->GetOverlayDragger().IsDragActive()) && (!UIManager::Get()->GetOverlayDragger().IsDragGestureActive()) ) //Skip if an overlay drag is active { for (auto& state : m_LaserInputStates) { bool hovered_spacing = bb_with_spacing.Contains(state.MouseState.MousePos); bool hovered = (hovered_spacing) ? bb.Contains(state.MouseState.MousePos) : false; if (hovered) { if (!button_state.IsHeld) { if (state.MouseState.MouseClicked[mouse_button]) { is_held = true; is_pressed = !do_repeat; //Only set pressed when not repeating (IsActivated/IsDeactivated is used instead then) button_state.DeviceIndexHeld = state.DeviceIndex; } else if (state.MouseState.MouseClicked[mouse_button_right]) //Right-click is only a simple click state { button_state.IsRightClicked = true; } } //Newly hovered, trigger haptics if (!button_state.IsHovered) { if (state.DeviceIndex == vr::k_unTrackedDeviceIndexOther) //other == mouse == current primary pointer device, don't use index { UIManager::Get()->TriggerLaserPointerHaptics(GetOverlayHandle()); } else { UIManager::Get()->TriggerLaserPointerHaptics(GetOverlayHandle(), state.DeviceIndex); } } } if ( (button_state.IsHeld) && (button_state.DeviceIndexHeld == state.DeviceIndex) ) { if (state.MouseState.MouseReleased[mouse_button]) { button_state.DeviceIndexHeld = vr::k_unTrackedDeviceIndexInvalid; is_released = true; } else if ((do_repeat) && (state.MouseState.MouseDownDuration[mouse_button] > 0.0f)) { //In order to access the button repeat behavior, we have to apply this mouse state to the global input state //As it is avoidable in all other cases we only do it here, which is a rarely hit code path state.MouseState.ApplyToGlobalState(); is_global_mouse_state_modified = true; if (ImGui::IsMouseClicked(mouse_button, true)) { is_pressed = true; } } } if ( (state.DeviceIndex == vr::k_unTrackedDeviceIndexOther) && ( (hovered_spacing) || (button_state.IsHeld) ) ) { m_IsAnyButtonHovered = true; //This state is only used for blank space dragging. We include the spacing area in order to not activate drags from clicking in-between key spacing } if (hovered) is_any_hovering = hovered; } } //Adjust button state button_state.IsActivated = ((!button_state.IsHeld) && (is_held)); button_state.IsDeactivated = ((button_state.IsHeld) && (is_released)); button_state.IsHovered = ((is_any_hovering) || (is_held)); button_state.IsHeld = (button_state.DeviceIndexHeld != vr::k_unTrackedDeviceIndexInvalid); //button_state.IsDown is not set by this function if (is_global_mouse_state_modified) { orig_state.MouseState.ApplyToGlobalState(); } //Render button const ImU32 col = ImGui::GetColorU32((button_state.IsHeld) ? ImGuiCol_ButtonActive : (is_any_hovering) ? ImGuiCol_ButtonHovered : ImGuiCol_Button); ImGui::RenderNavCursor(bb, id); ImGui::RenderFrame(bb.Min, bb.Max, col, true, style.FrameRounding); if (is_label_multiline) { ImGui::RenderButtonMultilineLabel(label, bb, 0.82f); } else { const ImVec2 pos_min(bb.Min.x + style.FramePadding.x, bb.Min.y + style.FramePadding.y); const ImVec2 pos_max(bb.Max.x - style.FramePadding.x, bb.Max.y - style.FramePadding.y); ImGui::RenderTextClipped(pos_min, pos_max, label, nullptr, &label_size, style.ButtonTextAlign, &bb); } return is_pressed; } void WindowKeyboard::ButtonVisual(const char* label, const ImVec2& size_arg, bool is_label_multiline) { ImGuiWindow* window = ImGui::GetCurrentWindow(); if (window->SkipItems) return; const ImGuiStyle& style = ImGui::GetStyle(); const ImVec2 label_size = ImGui::CalcTextSize(label, nullptr, true); ImVec2 pos = window->DC.CursorPos; ImVec2 size = ImGui::CalcItemSize(size_arg, label_size.x + style.FramePadding.x * 2.0f, label_size.y + style.FramePadding.y * 2.0f); const ImRect bb(pos.x, pos.y, pos.x + size.x, pos.y + size.y); //Render button const ImU32 col = ImGui::GetColorU32(ImGuiCol_Button); ImGui::RenderFrame(bb.Min, bb.Max, col, true, style.FrameRounding); if (is_label_multiline) { ImGui::RenderButtonMultilineLabel(label, bb, 0.82f); } else { const ImVec2 pos_min(bb.Min.x + style.FramePadding.x, bb.Min.y + style.FramePadding.y); const ImVec2 pos_max(bb.Max.x - style.FramePadding.x, bb.Max.y - style.FramePadding.y); ImGui::RenderTextClipped(pos_min, pos_max, label, nullptr, &label_size, style.ButtonTextAlign, &bb); } } vr::VROverlayHandle_t WindowKeyboard::GetOverlayHandle() const { return UIManager::Get()->GetOverlayHandleKeyboard(); } void WindowKeyboard::RebaseTransform() { if ( (m_OverlayStateCurrentID == floating_window_ovrl_state_room) && (!m_OverlayStateCurrent->IsPinned) ) { vr::HmdMatrix34_t hmd_mat = {0}; vr::TrackingUniverseOrigin universe_origin = vr::TrackingUniverseStanding; vr::VROverlay()->GetOverlayTransformAbsolute(GetOverlayHandle(), &universe_origin, &hmd_mat); Matrix4 mat_abs = hmd_mat; Matrix4 mat_origin_inverse; int assigned_id = GetAssignedOverlayID(); bool assigned_overlay_use_fallback_origin = false; if (assigned_id >= 0) { const OverlayConfigData& data = OverlayManager::Get().GetConfigData((unsigned int)assigned_id); assigned_overlay_use_fallback_origin = (data.ConfigInt[configid_int_overlay_origin] == ovrl_origin_theater_screen); //Theater Screen uses fallback origin if not pinned } if ((!assigned_overlay_use_fallback_origin) && (assigned_id >= 0)) { mat_origin_inverse = OverlayManager::Get().GetOverlayCenterBottomTransform((unsigned int)assigned_id); UIManager::Get()->GetOverlayDragger().ApplyDashboardScale(mat_origin_inverse); } else { mat_origin_inverse = m_TransformUIOrigin; } mat_origin_inverse.invert(); m_OverlayStateCurrent->Transform = mat_origin_inverse * mat_abs; } else { FloatingWindow::RebaseTransform(); } } void WindowKeyboard::ResetTransform(FloatingWindowOverlayStateID state_id) { FloatingWindow::ResetTransform(state_id); FloatingWindowOverlayState& overlay_state = GetOverlayState(state_id); //Offset keyboard position depending on the scaled size const float overlay_height_m = (m_Size.y / m_Size.x) * OVERLAY_WIDTH_METERS_KEYBOARD; const float offset_up = -0.55f - ((overlay_height_m * overlay_state.Size) / 2.0f); overlay_state.Transform.rotateX(-45); overlay_state.Transform.translate_relative(0.0f, offset_up, 0.00f); //If visible, pinned and dplus dashboard overlay not available, reset to transform useful outside of the dashboard if ( (state_id == m_OverlayStateCurrentID) && (overlay_state.IsVisible) && (overlay_state.IsPinned) && (UIManager::Get()->IsOpenVRLoaded()) && (!vr::VROverlay()->IsOverlayVisible(UIManager::Get()->GetOverlayHandleDPlusDashboard())) ) { //Get dashboard-similar transform and adjust it down a bit Matrix4 matrix_facing = vr::IVRSystemEx::ComputeHMDFacingTransform(1.15f); matrix_facing.translate_relative(0.0f, -0.50f, 0.0f); //dplus_tab origin contains dashboard scale, so get that scale and apply it to this transform to stay consistent in size Matrix4 mat_origin = UIManager::Get()->GetOverlayDragger().GetBaseOffsetMatrix(ovrl_origin_dplus_tab); Vector3 row_1(mat_origin[0], mat_origin[1], mat_origin[2]); Vector3 translation = matrix_facing.getTranslation(); matrix_facing.setTranslation({0.0f, 0.0f, 0.0f}); matrix_facing.scale(row_1.length()); matrix_facing.setTranslation(translation); //Apply facing transform to normal keyboard position overlay_state.Transform = matrix_facing * overlay_state.Transform; //Set transform directly as it may not be updated automatically vr::HmdMatrix34_t matrix_ovr = overlay_state.Transform.toOpenVR34(); vr::VROverlay()->SetOverlayTransformAbsolute(GetOverlayHandle(), vr::TrackingUniverseStanding, &matrix_ovr); } } void WindowKeyboard::SetAssignedOverlayID(int assigned_id) { (m_OverlayStateCurrentID == floating_window_ovrl_state_dashboard_tab) ? m_AssignedOverlayIDDashboardTab = assigned_id : m_AssignedOverlayIDRoom = assigned_id; } void WindowKeyboard::SetAssignedOverlayID(int assigned_id, FloatingWindowOverlayStateID state_id) { (state_id == floating_window_ovrl_state_dashboard_tab) ? m_AssignedOverlayIDDashboardTab = assigned_id : m_AssignedOverlayIDRoom = assigned_id; } int WindowKeyboard::GetAssignedOverlayID() const { return (m_OverlayStateCurrentID == floating_window_ovrl_state_dashboard_tab) ? m_AssignedOverlayIDDashboardTab : m_AssignedOverlayIDRoom; } int WindowKeyboard::GetAssignedOverlayID(FloatingWindowOverlayStateID state_id) const { return (state_id == floating_window_ovrl_state_dashboard_tab) ? m_AssignedOverlayIDDashboardTab : m_AssignedOverlayIDRoom; } bool WindowKeyboard::IsHovered() const { return m_IsHovered; } void WindowKeyboard::ResetButtonState() { m_ButtonStates.clear(); m_IsIsoEnterDown = false; } bool WindowKeyboard::HandleOverlayEvent(const vr::VREvent_t& vr_event) { //Notify dashboard app for focus enter/leave in case there's a reason to react to it switch (vr_event.eventType) { case vr::VREvent_FocusEnter: { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_keyboard_ovrl_focus_enter); break; } case vr::VREvent_FocusLeave: { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_keyboard_ovrl_focus_leave); break; } } if (ImGui::GetCurrentContext() == nullptr) return false; vr::TrackedDeviceIndex_t device_index = vr_event.trackedDeviceIndex; //System laser pointer expresses a secondary pointer device as a cursor index instead of providing the device index as our custom laser pointer does uint32_t cursor_index = 0; switch (vr_event.eventType) { case vr::VREvent_MouseMove: case vr::VREvent_MouseButtonDown: case vr::VREvent_MouseButtonUp: { cursor_index = vr_event.data.mouse.cursorIndex; break; } case vr::VREvent_FocusEnter: case vr::VREvent_FocusLeave: { cursor_index = vr_event.data.overlay.cursorIndex; break; } case vr::VREvent_ScrollDiscrete: case vr::VREvent_ScrollSmooth: { cursor_index = vr_event.data.scroll.cursorIndex; break; } default: break; } //See if we already identified the device index for this cursor index if it's not the primary laser pointer if (cursor_index != 0) { auto it = std::find_if(m_LaserInputStates.begin(), m_LaserInputStates.end(), [&](const auto& state){ return (state.CursorIndexLast == cursor_index); }); if (it != m_LaserInputStates.end()) { device_index = it->DeviceIndex; } } //Patch up mouse and button state when device is primary device and there's still a separate input state if ((device_index == ConfigManager::Get().GetPrimaryLaserPointerDevice()) && (device_index != vr::k_unTrackedDeviceIndexInvalid)) { auto it = std::find_if(m_LaserInputStates.begin(), m_LaserInputStates.end(), [&](const auto& state){ return (state.DeviceIndex == device_index); }); if (it != m_LaserInputStates.end()) { for (ButtonLaserState& button_state : m_ButtonStates) { if (button_state.DeviceIndexHeld == device_index) { button_state.DeviceIndexHeld = vr::k_unTrackedDeviceIndexOther; //Other == global mouse } } it->MouseState.ApplyToGlobalState(); m_LaserInputStates.erase(it); } return false; } //Skip if no valid device index or it's the system pointer (sends as device 0 (HMD) or invalid) //For mouse move events with cursor indices above 0 we allow invalid devices as they're used to guess the correct one if ( ( (device_index >= vr::k_unMaxTrackedDeviceCount) || (device_index == vr::k_unTrackedDeviceIndex_Hmd) || ((cursor_index == 0) && (vr::IVROverlayEx::IsSystemLaserPointerActive())) ) && ((cursor_index == 0) || (vr_event.eventType != vr::VREvent_MouseMove)) ) { return (cursor_index != 0); //Still return true for non-0 index as we don't want it to be treated as ImGui mouse input } switch (vr_event.eventType) { case vr::VREvent_MouseMove: { //If we haven't seen this device on this cursor index before (or device index is invalid), guess which one it likely is based on the cursor position if (GetLaserInputState(device_index).CursorIndexLast != cursor_index) { Vector2 uv_pos(vr_event.data.mouse.x / ImGui::GetIO().DisplaySize.x, vr_event.data.mouse.y / ImGui::GetIO().DisplaySize.y); device_index = vr::IVROverlayEx::FindPointerDeviceForOverlay(UIManager::Get()->GetOverlayHandleKeyboard(), uv_pos); } if (device_index != vr::k_unTrackedDeviceIndexInvalid) { LaserInputState& state = GetLaserInputState(device_index); state.MouseState.MousePos = ImVec2(vr_event.data.mouse.x, -vr_event.data.mouse.y + ImGui::GetIO().DisplaySize.y); state.CursorIndexLast = cursor_index; } return true; } case vr::VREvent_FocusEnter: { return true; } case vr::VREvent_FocusLeave: { LaserInputState& state = GetLaserInputState(device_index); //Pointer left the overlay state.MouseState.MousePos = ImVec2(-FLT_MAX, -FLT_MAX); state.CursorIndexLast = 0; //Release mouse buttons if they're still down (not the case in most situations) std::fill(std::begin(state.MouseState.MouseDown), std::end(state.MouseState.MouseDown), false); return true; } case vr::VREvent_MouseButtonDown: case vr::VREvent_MouseButtonUp: { LaserInputState& state = GetLaserInputState(device_index); ImGuiMouseButton button = ImGuiMouseButton_Left; switch (vr_event.data.mouse.button) { case vr::VRMouseButton_Left: button = ImGuiMouseButton_Left; break; case vr::VRMouseButton_Right: button = ImGuiMouseButton_Right; break; case vr::VRMouseButton_Middle: button = ImGuiMouseButton_Middle; break; } state.MouseState.MouseDown[button] = (vr_event.eventType == vr::VREvent_MouseButtonDown); return true; } case vr::VREvent_ScrollDiscrete: case vr::VREvent_ScrollSmooth: { //Unhandled, but still consume them return true; } } return (cursor_index != 0); } void WindowKeyboard::LaserSetMousePos(vr::TrackedDeviceIndex_t device_index, ImVec2 pos) { LaserInputState& state = GetLaserInputState(device_index); state.MouseState.MousePos = pos; } void WindowKeyboard::LaserSetMouseButton(vr::TrackedDeviceIndex_t device_index, ImGuiMouseButton button_index, bool is_down) { LaserInputState& state = GetLaserInputState(device_index); state.MouseState.MouseDown[button_index] = is_down; } //-WindowKeyboardShortcuts void WindowKeyboardShortcuts::SetActiveWidget(ImGuiID widget_id) { //Set active widget ID if none is set, otherwise fade the previous one out first if (m_ActiveWidget == 0) { m_ActiveWidget = widget_id; m_ActiveWidgetPending = 0; } else if (m_ActiveWidget != widget_id) { m_ActiveWidgetPending = widget_id; m_IsFadingOut = true; } } void WindowKeyboardShortcuts::SetDefaultPositionDirection(ImGuiDir pos_dir, float y_offset) { if (!m_IsFadingOut) { m_PosDirDefault = pos_dir; m_YOffsetDefault = y_offset; } } void WindowKeyboardShortcuts::Update(ImGuiID widget_id) { if (widget_id != m_ActiveWidget) return; ImGuiIO& io = ImGui::GetIO(); //Release previously held keys by button actions switch (m_ActiveButtonAction) { case btn_act_cut: { io.AddKeyEvent(ImGuiMod_Ctrl, false); io.AddKeyEvent(ImGuiKey_X, false); m_ActiveButtonAction = btn_act_none; break; } case btn_act_copy: { io.AddKeyEvent(ImGuiMod_Ctrl, false); io.AddKeyEvent(ImGuiKey_C, false); m_ActiveButtonAction = btn_act_none; break; } case btn_act_paste: { io.AddKeyEvent(ImGuiMod_Ctrl, false); io.AddKeyEvent(ImGuiKey_V, false); m_ActiveButtonAction = btn_act_none; break; } default: break; } const float offset_down = (m_PosDirDefault == ImGuiDir_Down) ? m_YOffsetDefault : 0.0f; const float offset_up = (m_PosDirDefault == ImGuiDir_Up) ? m_YOffsetDefault : 0.0f; const float pos_y = ImGui::GetItemRectMin().y - ImGui::GetStyle().ItemSpacing.y + m_YOffsetDefault; const float pos_y_down = ImGui::GetItemRectMax().y + ImGui::GetStyle().ItemInnerSpacing.y + offset_down; const float pos_y_up = ImGui::GetItemRectMin().y - ImGui::GetStyle().ItemSpacing.y - m_WindowHeight + offset_up; //Wait for window height to be known and stable before setting pos or animating fade/pos if ((m_WindowHeight != FLT_MIN) && (m_WindowHeight == m_WindowHeightPrev)) { ImGui::SetNextWindowPos(ImVec2(ImGui::GetItemRectMin().x, smoothstep(m_PosAnimationProgress, pos_y_down, pos_y_up) )); const float time_step = ImGui::GetIO().DeltaTime * 6.0f; m_Alpha += (!m_IsFadingOut) ? time_step : -time_step; if (m_Alpha > 1.0f) m_Alpha = 1.0f; else if (m_Alpha < 0.0f) m_Alpha = 0.0f; m_PosAnimationProgress += (m_PosDir == ImGuiDir_Up) ? time_step : -time_step; if (m_PosAnimationProgress > 1.0f) m_PosAnimationProgress = 1.0f; else if (m_PosAnimationProgress < 0.0f) m_PosAnimationProgress = 0.0f; } ImGui::PushStyleVar(ImGuiStyleVar_Alpha, m_Alpha); //Get clipping rect of parent window ImGuiWindow* window_parent = ImGui::GetCurrentWindow(); ImRect clip_rect = window_parent->ClipRect; const ImGuiWindowFlags flags = ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoSavedSettings | ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_NoFocusOnAppearing | ImGuiWindowFlags_NoBringToFrontOnFocus | ImGuiWindowFlags_NoBackground; ImGui::Begin("##VRKeyboardShortcuts", nullptr, flags); //Force this window to be in front. For this to be not a flicker-fest, the parent should have ImGuiWindowFlags_NoBringToFrontOnFocus set (default for FloatingWindow) ImGuiWindow* window = ImGui::GetCurrentWindow(); if (!ImGui::IsWindowAbove(window, window_parent)) { ImGui::BringWindowToDisplayFront(window); } //Transfer scroll input to parent window (which isn't a real parent window but just the one in the stack), so this window doesn't block scrolling ImGui::ScrollBeginStackParentWindow(); //Use clipping rect of parent window ImGui::PushClipRect(clip_rect.Min, clip_rect.Max, false); //Draw background + border manually so it can be clipped properly ImRect window_rect = window->Rect(); window->DrawList->AddRectFilled(window_rect.Min, window_rect.Max, ImGui::GetColorU32(ImGuiCol_PopupBg), window->WindowRounding); window->DrawList->AddRect(window_rect.Min, window_rect.Max, ImGui::GetColorU32(ImGuiCol_Border), window->WindowRounding, 0, window->WindowBorderSize); //Disable inputs when fading out if (m_IsFadingOut) ImGui::PushItemDisabledNoVisual(); //Since we don't want to lose input focus, we use a separate widget state for this window ImGui::ActiveWidgetStateStorage prev_widget_state; prev_widget_state.StoreCurrentState(); m_WindowWidgetState.AdvanceState(); m_WindowWidgetState.ApplyState(); //-Window buttons m_IsAnyButtonDown = false; if (ImGui::Button(TranslationManager::GetString(tstr_KeyboardShortcutsCut))) { io.AddKeyEvent(ImGuiMod_Ctrl, true); io.AddKeyEvent(ImGuiKey_X, true); m_ActiveButtonAction = btn_act_cut; } if (ImGui::IsItemActive()) { m_IsAnyButtonDown = true; } ImGui::SameLine(); if (ImGui::Button(TranslationManager::GetString(tstr_KeyboardShortcutsCopy))) { io.AddKeyEvent(ImGuiMod_Ctrl, true); io.AddKeyEvent(ImGuiKey_C, true); m_ActiveButtonAction = btn_act_copy; } if (ImGui::IsItemActive()) { m_IsAnyButtonDown = true; } ImGui::SameLine(); //Check if we have clipboard text to disable pasting if we don't const char* clipboard_text = ImGui::GetClipboardText(); const bool has_clipboard_text = ((clipboard_text != nullptr) && (clipboard_text[0] != '\0')); if (!has_clipboard_text) ImGui::PushItemDisabled(); if (ImGui::Button(TranslationManager::GetString(tstr_KeyboardShortcutsPaste))) { io.AddKeyEvent(ImGuiMod_Ctrl, true); io.AddKeyEvent(ImGuiKey_V, true); m_ActiveButtonAction = btn_act_paste; } if (ImGui::IsItemActive()) { m_IsAnyButtonDown = true; } if (!has_clipboard_text) ImGui::PopItemDisabled(); m_IsHovered = ImGui::IsWindowHovered(); //Restore global widget state m_WindowWidgetState.StoreCurrentState(); prev_widget_state.ApplyState(); if (m_IsFadingOut) ImGui::PopItemDisabledNoVisual(); //Switch directions if there's no space in the default direction if (m_PosDirDefault == ImGuiDir_Down) { m_PosDir = (pos_y_down + ImGui::GetWindowSize().y > clip_rect.Max.y) ? ImGuiDir_Up : ImGuiDir_Down; } else { //Not using pos_y_up here as it's not valid yet (m_WindowHeight not set) m_PosDir = (pos_y - ImGui::GetWindowSize().y < clip_rect.Min.y) ? ImGuiDir_Down : ImGuiDir_Up; } if (m_Alpha == 0.0f) { m_PosAnimationProgress = (m_PosDir == ImGuiDir_Down) ? 0.0f : 1.0f; } //Cache window height so it's available on the next frame before beginning the window m_WindowHeightPrev = m_WindowHeight; m_WindowHeight = ImGui::GetWindowSize().y; ImGui::End(); ImGui::PopStyleVar(); //ImGuiStyleVar_Alpha //Reset when fade-out is done if ( (m_IsFadingOut) && (m_Alpha == 0.0f) ) { m_ActiveWidget = m_ActiveWidgetPending; m_ActiveWidgetPending = 0; m_IsFadingOut = false; m_WindowHeight = FLT_MIN; m_PosDir = m_PosDirDefault; m_PosAnimationProgress = (m_PosDirDefault == ImGuiDir_Down) ? 0.0f : 1.0f; } } bool WindowKeyboardShortcuts::IsHovered() const { return m_IsHovered; } bool WindowKeyboardShortcuts::IsAnyButtonDown() const { return m_IsAnyButtonDown; } ================================================ FILE: src/DesktopPlusUI/WindowKeyboard.h ================================================ #pragma once #include "FloatingWindow.h" #include "ImGuiExt.h" #include "openvr.h" struct LaserInputState { vr::TrackedDeviceIndex_t DeviceIndex = vr::k_unTrackedDeviceIndexInvalid; uint32_t CursorIndexLast = 0; ImGui::ImGuiMouseState MouseState; }; struct ButtonLaserState { vr::TrackedDeviceIndex_t DeviceIndexHeld = vr::k_unTrackedDeviceIndexInvalid; bool IsDown = false; bool IsHeld = false; bool IsHovered = false; bool IsActivated = false; bool IsDeactivated = false; bool IsRightClicked = false; }; enum KeyboardLayoutSubLayout : unsigned char; class WindowKeyboard : public FloatingWindow { private: float m_WindowWidth; bool m_IsAutoVisible; bool m_IsHovered; bool m_IsAnyButtonHovered; Matrix4 m_TransformUIOrigin; int m_AssignedOverlayIDRoom; //-1 = None/Global, -2 = UI (only if newly shown for it) int m_AssignedOverlayIDDashboardTab; //^ bool m_IsIsoEnterDown; bool m_IsDashboardPointerActiveLast; bool m_UnstickModifiersLater; KeyboardLayoutSubLayout m_SubLayoutOverride; KeyboardLayoutSubLayout m_LastSubLayout; bool m_ManuallyStickingModifiers[8]; ImGui::ActiveWidgetStateStorage m_KeyboardWidgetState; std::vector m_ButtonStates; std::vector m_LaserInputStates; virtual void WindowUpdate(); virtual void OnWindowPinButtonPressed(); virtual void OnWindowCloseButtonPressed(); virtual bool IsVirtualWindowItemHovered() const; void OnVirtualKeyDown(unsigned char keycode, bool block_modifiers = false); void OnVirtualKeyUp(unsigned char keycode, bool block_modifiers = false); void OnStringKeyDown(const std::string& keystring); void OnStringKeyUp(const std::string& keystring); void HandleUnstickyModifiers(unsigned char source_keycode = 0); void SetManualStickyModifierState(unsigned char keycode, bool is_down); static int GetModifierID(unsigned char keycode); int FindSameKeyInNewSubLayout(int key_index, KeyboardLayoutSubLayout sublayout_id_current, KeyboardLayoutSubLayout sublayout_id_new); LaserInputState& GetLaserInputState(vr::TrackedDeviceIndex_t device_index); bool ButtonLaser(const char* label, const ImVec2& size_arg, ButtonLaserState& button_state, bool is_label_multiline = false); void ButtonVisual(const char* label, const ImVec2& size_arg, bool is_label_multiline = false); public: WindowKeyboard(); virtual void UpdateVisibility(); virtual void Show(bool skip_fade = false); virtual void Hide(bool skip_fade = false); bool SetAutoVisibility(int assigned_overlay_id, bool show); //Returns true on success virtual vr::VROverlayHandle_t GetOverlayHandle() const; virtual void RebaseTransform(); virtual void ResetTransform(FloatingWindowOverlayStateID state_id); void SetAssignedOverlayID(int assigned_id); //Sets for current state void SetAssignedOverlayID(int assigned_id, FloatingWindowOverlayStateID state_id); int GetAssignedOverlayID() const; //Gets from current state int GetAssignedOverlayID(FloatingWindowOverlayStateID state_id) const; bool IsHovered() const; void ResetButtonState(); //Called by VRKeyboard when resetting the keyboard state bool HandleOverlayEvent(const vr::VREvent_t& vr_event); void LaserSetMousePos(vr::TrackedDeviceIndex_t device_index, ImVec2 pos); void LaserSetMouseButton(vr::TrackedDeviceIndex_t device_index, ImGuiMouseButton button_index, bool is_down); }; class WindowKeyboardShortcuts { private: enum ButtonAction {btn_act_none = -1, btn_act_cut, btn_act_copy, btn_act_paste}; bool m_IsHovered = false; bool m_IsFadingOut = false; float m_Alpha = 0.0f; ImGuiID m_ActiveWidget = 0; ImGuiID m_ActiveWidgetPending = 0; ImGui::ActiveWidgetStateStorage m_WindowWidgetState; float m_WindowHeight = FLT_MIN; float m_WindowHeightPrev = FLT_MIN; ImGuiDir m_PosDir = ImGuiDir_Down; ImGuiDir m_PosDirDefault = ImGuiDir_Down; float m_YOffsetDefault = 0.0f; float m_PosAnimationProgress = 0.0f; ButtonAction m_ActiveButtonAction = btn_act_none; bool m_IsAnyButtonDown = false; public: void SetActiveWidget(ImGuiID widget_id); void SetDefaultPositionDirection(ImGuiDir pos_dir, float y_offset = 0.0f); void Update(ImGuiID window_id); bool IsHovered() const; bool IsAnyButtonDown() const; }; ================================================ FILE: src/DesktopPlusUI/WindowKeyboardEditor.cpp ================================================ #include "WindowKeyboardEditor.h" #include "UIManager.h" void KeyboardEditor::UpdateWindowKeyList() { ImGuiIO& io = ImGui::GetIO(); ImGuiStyle& style = ImGui::GetStyle(); VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); ImGui::SetNextWindowSize({io.DisplaySize.x / 4.0f, m_TopWindowHeight}); ImGui::SetNextWindowPos({0.0f, 0.0f}); ImGui::Begin(TranslationManager::GetString(tstr_KeyboardEditorKeyListTitle), nullptr, ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoCollapse); ImGui::SetCursorPosY(ImGui::GetCursorPosY() - (float)(int)(style.WindowPadding.y / 2.0f)); //Bring tab bar closer to window title if (ImGui::BeginTabBar("TabBarSublayouts")) { for (int i_sublayout = kbdlayout_sub_base; i_sublayout < kbdlayout_sub_MAX; ++i_sublayout) { KeyboardLayoutSubLayout current_sublayout = (KeyboardLayoutSubLayout)i_sublayout; if ((current_sublayout == kbdlayout_sub_altgr) && (!vr_keyboard.GetLayoutMetadata().HasAltGr)) continue; if (ImGui::BeginTabItem( TranslationManager::GetString((TRMGRStrID)(tstr_KeyboardEditorSublayoutBase + i_sublayout) ), nullptr)) { auto& sublayout_keys = vr_keyboard.GetLayout(current_sublayout); //Tab context menu if (ImGui::BeginPopupContextItem()) { if (ImGui::BeginMenu(TranslationManager::GetString(tstr_KeyboardEditorKeyListTabContextReplace))) { for (int i_sublayout_menu = kbdlayout_sub_base; i_sublayout_menu < kbdlayout_sub_MAX; ++i_sublayout_menu) { if ((i_sublayout_menu == kbdlayout_sub_altgr) && (!vr_keyboard.GetLayoutMetadata().HasAltGr)) continue; if ((i_sublayout_menu != i_sublayout) && (ImGui::MenuItem( TranslationManager::GetString((TRMGRStrID)(tstr_KeyboardEditorSublayoutBase + i_sublayout_menu)) ))) { HistoryPush(); sublayout_keys = vr_keyboard.GetLayout((KeyboardLayoutSubLayout)i_sublayout_menu); UIManager::Get()->RepeatFrame(); } } ImGui::EndMenu(); } if (ImGui::MenuItem(TranslationManager::GetString(tstr_KeyboardEditorKeyListTabContextClear))) { HistoryPush(); sublayout_keys.clear(); UIManager::Get()->RepeatFrame(); } ImGui::EndPopup(); } //Make the child expand past window padding ImGui::SetCursorPos({ImGui::GetCursorPosX() - style.WindowPadding.x, ImGui::GetCursorPosY() - style.WindowPadding.y - style.TabBarBorderSize}); ImGui::BeginChild("TabContents", {ImGui::GetContentRegionAvail().x + style.WindowPadding.x, -ImGui::GetFrameHeightWithSpacing()}, ImGuiChildFlags_Borders); if (current_sublayout != m_SelectedSublayout) { m_SelectedKeyID = FindKeyWithClosestPosInNewSubLayout(m_SelectedKeyID, m_SelectedSublayout, current_sublayout); m_SelectedSublayout = current_sublayout; m_HasChangedSelectedKey = true; } int row_id = -1; int row_id_show = -1; int i = 0; //Drag-reordering needs stable IDs to work static std::vector list_unique_ids; static std::vector list_unique_row_ids; while (list_unique_ids.size() < sublayout_keys.size()) { list_unique_ids.push_back((int)list_unique_ids.size()); } static std::vector str_row_id; //Find which row to open in order to focus the newly selected key if (m_HasChangedSelectedKey) { if (m_SelectedRowID != -1) { row_id_show = m_SelectedRowID; } else { row_id_show = 0; for (const auto& key : vr_keyboard.GetLayout(current_sublayout)) { if (i == m_SelectedKeyID) { break; } else if (key.IsRowEnd) { ++row_id_show; } ++i; } } i = 0; } bool pushed_row = false; bool is_row_node_open = false; ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, {style.ItemSpacing.x, 0.0f}); for (auto& key : vr_keyboard.GetLayout(current_sublayout)) { //Row entry if (!pushed_row) { row_id++; //Expand unique row IDs here since we don't know how many there are beforehand while (list_unique_row_ids.size() <= row_id) { list_unique_row_ids.push_back((int)list_unique_row_ids.size()); } //Expand row ID translated strings if we need to while (str_row_id.size() <= row_id) { std::string row_str = TranslationManager::GetString(tstr_KeyboardEditorKeyListRow); StringReplaceAll(row_str, "%ID%", std::to_string(str_row_id.size() + 1)); str_row_id.push_back(row_str); } //Set focus if row itself was just selected if ((m_HasChangedSelectedKey) && (row_id == m_SelectedRowID)) { ImGui::SetKeyboardFocusHere(); UIManager::Get()->RepeatFrame(); } else if (row_id == row_id_show) //Open row when this is the row that has the key we want to focus { ImGui::SetNextItemOpen(true); } ImGui::PushID(list_unique_row_ids[row_id]); ImGuiTreeNodeFlags flags = ImGuiTreeNodeFlags_SpanAvailWidth | ImGuiTreeNodeFlags_OpenOnDoubleClick | ImGuiTreeNodeFlags_OpenOnArrow; flags |= (row_id == m_SelectedRowID) ? ImGuiTreeNodeFlags_Selected : 0; is_row_node_open = ImGui::TreeNodeEx("##Row", flags, str_row_id[row_id].c_str()); if ((ImGui::IsItemClicked()) && (!ImGui::IsItemToggledOpen())) { m_SelectedRowID = row_id; m_SelectedKeyID = -1; m_HasChangedSelectedKey = true; } //Drag reordering static int hovered_row_id = -1; if (ImGui::IsItemHovered(ImGuiHoveredFlags_AllowWhenBlockedByActiveItem)) { hovered_row_id = row_id; } if ((ImGui::IsItemActive()) && (!ImGui::IsItemHovered())) { int row_id_swap = row_id + ((ImGui::GetMouseDragDelta(ImGuiMouseButton_Left).y < 0.0f) ? -1 : 1); if ((hovered_row_id != row_id) && (row_id_swap >= 0) && (row_id_swap < sublayout_keys.size())) { HistoryPush(); m_HistoryHasPendingEdit = true; auto pair_row = GetKeyRowRange(current_sublayout, row_id); auto pair_row_swap = GetKeyRowRange(current_sublayout, row_id_swap); //Swap the row ranges if needed so the second row is always after the first if (pair_row.first > pair_row_swap.first) { pair_row.swap(pair_row_swap); } //Swap row contents by copying the first row to a temporary, erasing the first row and pasting the first row past where the second row now is std::vector row_keys(sublayout_keys.begin() + pair_row.first, sublayout_keys.begin() + pair_row.second); sublayout_keys.erase(sublayout_keys.begin() + pair_row.first, sublayout_keys.begin() + pair_row.second); sublayout_keys.insert(sublayout_keys.begin() + pair_row.first + (pair_row_swap.second - pair_row_swap.first), row_keys.begin(), row_keys.end()); std::iter_swap(list_unique_row_ids.begin() + row_id, list_unique_row_ids.begin() + row_id_swap); m_SelectedRowID = row_id_swap; ImGui::ResetMouseDragDelta(ImGuiMouseButton_Left); UIManager::Get()->RepeatFrame(); } } pushed_row = true; } //Key entry if (is_row_node_open) { ImGui::PushID(list_unique_ids[i]); ImGuiTreeNodeFlags flags = ImGuiTreeNodeFlags_Leaf | ImGuiTreeNodeFlags_NoTreePushOnOpen | ImGuiTreeNodeFlags_SpanAvailWidth; flags |= (i == m_SelectedKeyID) ? ImGuiTreeNodeFlags_Selected : 0; if ((m_HasChangedSelectedKey) && (i == m_SelectedKeyID)) { ImGui::SetKeyboardFocusHere(); UIManager::Get()->RepeatFrame(); } if (!m_PreviewCluster[key.KeyCluster]) ImGui::PushStyleVar(ImGuiStyleVar_Alpha, 0.5f); if (key.KeyType == kbdlayout_key_blank_space) { ImGui::TreeNodeEx(TranslationManager::GetString(tstr_KeyboardEditorKeyListSpacing), flags); } else { ImGui::TreeNodeEx(key.Label.c_str(), flags); } if (!m_PreviewCluster[key.KeyCluster]) ImGui::PopStyleVar(); if ((ImGui::IsItemClicked()) && (!ImGui::IsItemToggledOpen())) { m_SelectedRowID = -1; m_SelectedKeyID = i; m_HasChangedSelectedKey = true; } //Drag reordering static int hovered_id = -1; if (ImGui::IsItemHovered(ImGuiHoveredFlags_AllowWhenBlockedByActiveItem)) { hovered_id = i; } if ((ImGui::IsItemActive()) && (!ImGui::IsItemHovered())) { int index_swap = i + ((ImGui::GetMouseDragDelta(ImGuiMouseButton_Left).y < 0.0f) ? -1 : 1); if ((hovered_id != i) && (index_swap >= 0) && (index_swap < sublayout_keys.size())) { HistoryPush(); m_HistoryHasPendingEdit = true; KeyboardLayoutKey& key_swap = sublayout_keys[index_swap]; std::swap(key.IsRowEnd, key_swap.IsRowEnd); std::iter_swap(sublayout_keys.begin() + i, sublayout_keys.begin() + index_swap); std::iter_swap(list_unique_ids.begin() + i, list_unique_ids.begin() + index_swap); m_SelectedKeyID = index_swap; ImGui::ResetMouseDragDelta(ImGuiMouseButton_Left); } } ImGui::PopID(); } if (key.IsRowEnd) { ImGui::PopID(); if (is_row_node_open) { ImGui::TreePop(); } pushed_row = false; } ++i; } if (pushed_row) { ImGui::TreePop(); ImGui::PopID(); } //Clamp selected row ID to available range (with invalid 0 being corrected to -1) m_SelectedRowID = clamp(m_SelectedRowID, -1, row_id); ImGui::PopStyleVar(); ImGui::EndChild(); ImGui::EndTabItem(); } } ImGui::EndTabBar(); } const bool has_no_undo = m_HistoryUndo.empty(); const bool has_no_redo = m_HistoryRedo.empty(); //ImGui::IsKeyChordPressed() seems neat here but doesn't appear to support key repeat... const bool undo_shortcut_pressed = ((io.KeyMods == ImGuiMod_Ctrl) && (ImGui::IsKeyPressed(ImGuiKey_Z))); const bool redo_shortcut_pressed = ((io.KeyMods == ImGuiMod_Ctrl) && (ImGui::IsKeyPressed(ImGuiKey_Y))); if (has_no_undo) ImGui::PushItemDisabled(); if ( (ImGui::Button(TranslationManager::GetString(tstr_DialogUndo))) || ((!has_no_undo) && (!ImGui::IsAnyInputTextActive()) && (undo_shortcut_pressed)) ) { HistoryUndo(); UIManager::Get()->RepeatFrame(); } if (has_no_undo) ImGui::PopItemDisabled(); ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); if (has_no_redo) ImGui::PushItemDisabled(); if ( (ImGui::Button(TranslationManager::GetString(tstr_DialogRedo))) || ((!has_no_redo) && (!ImGui::IsAnyInputTextActive()) && (redo_shortcut_pressed)) ) { HistoryRedo(); UIManager::Get()->RepeatFrame(); } if (has_no_redo) ImGui::PopItemDisabled(); ImGui::SameLine(); static float bottom_buttons_width = 0.0f; ImGui::SetCursorPosX(ImGui::GetCursorPosX() + ImGui::GetContentRegionAvail().x - bottom_buttons_width); ImGui::BeginGroup(); if (ImGui::Button(TranslationManager::GetString(tstr_KeyboardEditorKeyListKeyAdd))) { HistoryPush(); auto& sublayout_keys = vr_keyboard.GetLayout(m_SelectedSublayout); KeyboardLayoutKey new_key; new_key.KeyType = kbdlayout_key_virtual_key; auto it_insert = sublayout_keys.end(); if (m_SelectedRowID != -1) { int row_id = 0; for (auto it = sublayout_keys.begin(); it != sublayout_keys.end(); ++it) { if (row_id == m_SelectedRowID + 1) { it_insert = it; break; } else if (it->IsRowEnd) { ++row_id; } } //Set row end for previous key to make a new row if (it_insert != sublayout_keys.begin()) { (it_insert - 1)->IsRowEnd = true; } new_key.IsRowEnd = true; } else if (m_SelectedKeyID != -1) { it_insert = sublayout_keys.begin() + m_SelectedKeyID; //Take over row end if selected key is if (it_insert->IsRowEnd) { it_insert->IsRowEnd = false; new_key.IsRowEnd = true; } ++it_insert; //Insert after selected key } else { new_key.IsRowEnd = true; } new_key.Label = "#" + std::to_string(sublayout_keys.size()); sublayout_keys.insert(it_insert, new_key); UIManager::Get()->RepeatFrame(); } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); const bool has_invalid_selection = ((m_SelectedKeyID == -1) && (m_SelectedRowID == -1)); if (has_invalid_selection) ImGui::PushItemDisabled(); if (ImGui::Button(TranslationManager::GetString(tstr_KeyboardEditorKeyListKeyDuplicate))) { auto& sublayout_keys = vr_keyboard.GetLayout(m_SelectedSublayout); if (m_SelectedRowID != -1) { HistoryPush(); auto pair_row_key_id = GetKeyRowRange(m_SelectedSublayout, m_SelectedRowID); sublayout_keys.insert(sublayout_keys.begin() + pair_row_key_id.second, sublayout_keys.begin() + pair_row_key_id.first, sublayout_keys.begin() + pair_row_key_id.second); } else if (m_SelectedKeyID != -1) { HistoryPush(); auto it_duplicate = sublayout_keys.begin() + m_SelectedKeyID; KeyboardLayoutKey new_key = *it_duplicate; //Take over row end if selected key is if (it_duplicate->IsRowEnd) { it_duplicate->IsRowEnd = false; new_key.IsRowEnd = true; } sublayout_keys.insert(it_duplicate + 1, new_key); } UIManager::Get()->RepeatFrame(); } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); if (ImGui::Button(TranslationManager::GetString(tstr_KeyboardEditorKeyListKeyRemove))) { auto& sublayout_keys = vr_keyboard.GetLayout(m_SelectedSublayout); if (m_SelectedRowID != -1) { HistoryPush(); auto pair_row_key_id = GetKeyRowRange(m_SelectedSublayout, m_SelectedRowID); sublayout_keys.erase(sublayout_keys.begin() + pair_row_key_id.first, sublayout_keys.begin() + pair_row_key_id.second); } else if (m_SelectedKeyID != -1) { HistoryPush(); auto it_erase = sublayout_keys.begin() + m_SelectedKeyID; //Set row end for previous key if selected key has it if ((it_erase->IsRowEnd) && (it_erase != sublayout_keys.begin())) { (it_erase - 1)->IsRowEnd = true; } sublayout_keys.erase(it_erase); } m_HasChangedSelectedKey = true; } if (has_invalid_selection) ImGui::PopItemDisabled(); ImGui::EndGroup(); bottom_buttons_width = ImGui::GetItemRectSize().x; ImGui::End(); } void KeyboardEditor::UpdateWindowKeyProperties() { ImGuiIO& io = ImGui::GetIO(); ImGuiStyle& style = ImGui::GetStyle(); VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); //This adds border size to overlap with neighboring window borders instead of making it thicker ImGui::SetNextWindowSize({io.DisplaySize.x / 2.0f + (style.WindowBorderSize + style.WindowBorderSize), m_TopWindowHeight}); ImGui::SetNextWindowPos({io.DisplaySize.x / 2.0f, 0.0f}, ImGuiCond_Always, {0.5f, 0.0f}); ImGui::Begin(TranslationManager::GetString(tstr_KeyboardEditorKeyPropertiesTitle), nullptr, ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoCollapse); auto& sublayout_keys = vr_keyboard.GetLayout(m_SelectedSublayout); m_SelectedKeyID = clamp(m_SelectedKeyID, -1, (int)sublayout_keys.size() - 1); if (m_SelectedKeyID == -1) { static ImVec2 no_selection_text_size; ImGui::SetCursorPosX(ImGui::GetCursorPosX() + ImGui::GetContentRegionAvail().x / 2.0f - (no_selection_text_size.x / 2.0f)); ImGui::SetCursorPosY(ImGui::GetCursorPosY() + ImGui::GetContentRegionAvail().y / 2.0f - (no_selection_text_size.y / 2.0f)); ImGui::TextUnformatted(TranslationManager::GetString(tstr_KeyboardEditorKeyPropertiesNoSelection)); no_selection_text_size = ImGui::GetItemRectSize(); ImGui::End(); return; } KeyboardLayoutKey& key = sublayout_keys[m_SelectedKeyID]; static char buffer_key_label[128] = ""; static char buffer_key_string[1024] = ""; if (m_HasChangedSelectedKey) { size_t copied_length = key.Label.copy(buffer_key_label, IM_ARRAYSIZE(buffer_key_label) - 1); buffer_key_label[copied_length] = '\0'; copied_length = key.KeyString.copy(buffer_key_string, IM_ARRAYSIZE(buffer_key_string) - 1); buffer_key_string[copied_length] = '\0'; } ImGui::PushStyleVar(ImGuiStyleVar_WindowRounding, m_WindowRounding); const float item_spacing_x = style.ItemSpacing.x; ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, {0.0f, style.ItemSpacing.y}); //Avoid horizontal padding from the column ImGui::Columns(2, "ColumnKeyProps", false); ImGui::SetColumnWidth(0, (float)(int)(io.DisplaySize.x / 6.0f)); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_KeyboardEditorKeyPropertiesType)); if (key.KeyType == kbdlayout_key_virtual_key_iso_enter) { ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); ImGui::FixedHelpMarker(TranslationManager::GetString(tstr_KeyboardEditorKeyPropertiesTypeVirtualKeyIsoEnterTip)); } else if (key.KeyType == kbdlayout_key_string) { ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); ImGui::FixedHelpMarker(TranslationManager::GetString(tstr_KeyboardEditorKeyPropertiesTypeStringTip)); } ImGui::NextColumn(); key.KeyType = (KeyboardLayoutKeyType)clamp((int)key.KeyType, 0, (tstr_KeyboardEditorKeyPropertiesTypeAction - tstr_KeyboardEditorKeyPropertiesTypeBlank)); int key_type_temp = key.KeyType; ImGui::SetNextItemWidth(-1.0f); if (FloatingWindow::TranslatedComboAnimated("##ComboType", key_type_temp, tstr_KeyboardEditorKeyPropertiesTypeBlank, tstr_KeyboardEditorKeyPropertiesTypeAction)) { if (key_type_temp != key.KeyType) { HistoryPush(); key.KeyType = (KeyboardLayoutKeyType)key_type_temp; } } ImGui::NextColumn(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_KeyboardEditorKeyPropertiesSize)); ImGui::NextColumn(); const float input_width = ImGui::GetFontSize() * 5.5f; float input_size_w = key.Width * 100.0f; float input_size_h = key.Height * 100.0f; ImGui::SetNextItemWidth(input_width); if (ImGui::InputFloat("##InputSizeW", &input_size_w, 5.0f, 10.0f, "%.0f%%")) { HistoryPush(); m_HistoryHasPendingEdit = true; key.Width = std::max(0.10f, roundf(input_size_w) / 100.0f); } ImGui::SameLine(0.0f, item_spacing_x); ImGui::TextUnformatted("x"); ImGui::SameLine(0.0f, item_spacing_x); if (key.KeyType == kbdlayout_key_virtual_key_iso_enter) ImGui::PushItemDisabled(); ImGui::SetNextItemWidth(input_width); if (ImGui::InputFloat("##InputSizeH", &input_size_h, 5.0f, 10.0f, "%.0f%%")) { HistoryPush(); m_HistoryHasPendingEdit = true; key.Height = std::max(0.10f, roundf(input_size_h) / 100.0f); } if (key.KeyType == kbdlayout_key_virtual_key_iso_enter) ImGui::PopItemDisabled(); ImGui::NextColumn(); if (key.KeyType != kbdlayout_key_blank_space) { ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_KeyboardEditorKeyPropertiesLabel)); ImGui::NextColumn(); ImVec2 multiline_input_size(-1, (ImGui::GetTextLineHeight() * 2.0f) + (style.FramePadding.y * 2.0f)); if (ImGui::InputTextMultiline("##InputLabel", buffer_key_label, IM_ARRAYSIZE(buffer_key_label), multiline_input_size)) { HistoryPush(); m_HistoryHasPendingEdit = true; UIManager::Get()->AddFontBuilderStringIfAnyUnmappedCharacters(buffer_key_label); key.Label = buffer_key_label; } ImGui::NextColumn(); ImGui::AlignTextToFramePadding(); switch (key.KeyType) { case kbdlayout_key_virtual_key: case kbdlayout_key_virtual_key_toggle: case kbdlayout_key_virtual_key_iso_enter: { ImGui::TextUnformatted(TranslationManager::GetString(tstr_KeyboardEditorKeyPropertiesKeyCode)); ImGui::NextColumn(); if (ImGui::Button((key.KeyCode == 0) ? TranslationManager::GetString(tstr_DialogKeyCodePickerKeyCodeNone) : GetStringForKeyCode(key.KeyCode))) { ImGui::OpenPopup(TranslationManager::GetString(tstr_DialogKeyCodePickerHeader)); } break; } case kbdlayout_key_string: { ImGui::TextUnformatted(TranslationManager::GetString(tstr_KeyboardEditorKeyPropertiesString)); ImGui::NextColumn(); ImVec2 multiline_input_size(-1, (ImGui::GetTextLineHeight() * 3.0f) + (style.FramePadding.y * 2.0f)); if (ImGui::InputTextMultiline("##InputKeyString", buffer_key_string, IM_ARRAYSIZE(buffer_key_string), multiline_input_size)) { UIManager::Get()->AddFontBuilderStringIfAnyUnmappedCharacters(buffer_key_string); key.KeyString = buffer_key_string; } break; } case kbdlayout_key_sublayout_toggle: { ImGui::TextUnformatted(TranslationManager::GetString(tstr_KeyboardEditorKeyPropertiesSublayout)); ImGui::NextColumn(); key.KeySubLayoutToggle = (KeyboardLayoutSubLayout)clamp((int)key.KeySubLayoutToggle, 0, (tstr_KeyboardEditorSublayoutAux - tstr_KeyboardEditorSublayoutBase)); int key_sublayout_toggle_temp = key.KeySubLayoutToggle; ImGui::SetNextItemWidth(-1.0f); if (FloatingWindow::TranslatedComboAnimated("##ComboSublayout", key_sublayout_toggle_temp, tstr_KeyboardEditorSublayoutBase, tstr_KeyboardEditorSublayoutAux)) { if (key_sublayout_toggle_temp != key.KeySubLayoutToggle) { HistoryPush(); key.KeySubLayoutToggle = (KeyboardLayoutSubLayout)key_sublayout_toggle_temp; } } break; } case kbdlayout_key_action: { ImGui::TextUnformatted(TranslationManager::GetString(tstr_KeyboardEditorKeyPropertiesAction)); ImGui::NextColumn(); if (ImGui::Button(ConfigManager::Get().GetActionManager().GetTranslatedName(key.KeyActionUID))) { ImGui::OpenPopup(TranslationManager::GetString(tstr_DialogActionPickerHeader)); } break; } default: break; } ImGui::NextColumn(); } ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_KeyboardEditorKeyPropertiesCluster)); ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); ImGui::FixedHelpMarker(TranslationManager::GetString(tstr_KeyboardEditorKeyPropertiesClusterTip)); ImGui::NextColumn(); key.KeyCluster = (KeyboardLayoutCluster)clamp((int)key.KeyCluster, 0, (tstr_SettingsKeyboardKeyClusterExtra - tstr_SettingsKeyboardKeyClusterBase)); int key_cluster_temp = key.KeyCluster; ImGui::SetNextItemWidth(-1.0f); if (FloatingWindow::TranslatedComboAnimated("##ComboCluster", key_cluster_temp, tstr_SettingsKeyboardKeyClusterBase, tstr_SettingsKeyboardKeyClusterExtra)) { if (key_cluster_temp != key.KeyCluster) { HistoryPush(); key.KeyCluster = (KeyboardLayoutCluster)key_cluster_temp; } } ImGui::NextColumn(); ImGui::Columns(1); ImGui::PopStyleVar(); //ImGuiStyleVar_ItemSpacing if (key.KeyType == kbdlayout_key_virtual_key) { if (ImGui::Checkbox(TranslationManager::GetString(tstr_KeyboardEditorKeyPropertiesBlockModifiers), &key.BlockModifiers)) { //Switch around the values temporarily to allow the current state to be pushed just in time key.BlockModifiers = !key.BlockModifiers; HistoryPush(); key.BlockModifiers = !key.BlockModifiers; } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); ImGui::FixedHelpMarker(TranslationManager::GetString(tstr_KeyboardEditorKeyPropertiesBlockModifiersTip)); ImGui::SameLine(); } if (key.KeyType != kbdlayout_key_blank_space) { if (ImGui::Checkbox(TranslationManager::GetString(tstr_KeyboardEditorKeyPropertiesNoRepeat), &key.NoRepeat)) { key.NoRepeat = !key.NoRepeat; HistoryPush(); key.NoRepeat = !key.NoRepeat; } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); ImGui::FixedHelpMarker(TranslationManager::GetString(tstr_KeyboardEditorKeyPropertiesNoRepeatTip)); } //-Key Code Picker popup ImGui::SetNextWindowSize({io.DisplaySize.x / 3.0f, io.DisplaySize.y * 0.8f}); ImGui::SetNextWindowPos( {io.DisplaySize.x / 2.0f, io.DisplaySize.y / 2.0f}, ImGuiCond_Always, {0.5f, 0.5f}); if (ImGui::BeginPopupModal(TranslationManager::GetString(tstr_DialogKeyCodePickerHeader), nullptr, ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoResize)) { static ImGuiTextFilter filter; static int list_id = 0; static bool scroll_to_selection = false; if (ImGui::IsWindowAppearing()) { scroll_to_selection = true; for (int i = 0; i < 256; i++) { //Not the smartest, but most straight forward way if (GetKeyCodeForListID(i) == key.KeyCode) { list_id = i; //Clear filter if it wouldn't show the current selection if (!filter.PassFilter( (key.KeyCode == 0) ? TranslationManager::GetString(tstr_DialogKeyCodePickerKeyCodeNone) : GetStringForKeyCode(key.KeyCode) )) { filter.Clear(); } break; } } } CloseCurrentModalPopupFromInput(); ImGui::SetNextItemWidth(-1.0f); if (ImGui::InputTextWithHint("##FilterList", TranslationManager::GetString(tstr_DialogKeyCodePickerKeyCodeHint), filter.InputBuf, IM_ARRAYSIZE(filter.InputBuf))) { UIManager::Get()->AddFontBuilderStringIfAnyUnmappedCharacters(filter.InputBuf); filter.Build(); } ImGui::BeginChild("KeyCodePickerList", ImVec2(0.0f, -ImGui::GetFrameHeightWithSpacing()), ImGuiChildFlags_Borders); unsigned char list_keycode; const char* list_keycode_str = nullptr; for (int i = 0; i < 256; i++) { list_keycode = GetKeyCodeForListID(i); list_keycode_str = (list_keycode == 0) ? TranslationManager::GetString(tstr_DialogKeyCodePickerKeyCodeNone) : GetStringForKeyCode(list_keycode); if (filter.PassFilter(list_keycode_str)) { if (ImGui::Selectable(list_keycode_str, (i == list_id))) { list_id = i; if (key.KeyCode != list_keycode) { HistoryPush(); key.KeyCode = list_keycode; } ImGui::CloseCurrentPopup(); UIManager::Get()->RepeatFrame(); } if ( (scroll_to_selection) && (i == list_id) ) { ImGui::SetScrollHereY(); if (ImGui::IsItemVisible()) { scroll_to_selection = false; } } } } ImGui::EndChild(); static float list_buttons_width = 0.0f; ImGui::SetCursorPosX(ImGui::GetCursorPosX() + ImGui::GetContentRegionAvail().x - list_buttons_width); if (ImGui::Button(TranslationManager::GetString(tstr_DialogKeyCodePickerFromInput))) { ImGui::OpenPopup("PopupBindKey"); } list_buttons_width = ImGui::GetItemRectSize().x; ImGui::SetNextWindowPos({ImGui::GetIO().DisplaySize.x * 0.5f, ImGui::GetIO().DisplaySize.y * 0.5f}, ImGuiCond_Always, ImVec2(0.5f, 0.5f)); if (ImGui::BeginPopupModal("PopupBindKey", nullptr, ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoNavInputs)) { bool close_picker = false; ImGui::Text(TranslationManager::GetString(tstr_DialogKeyCodePickerFromInputPopup)); ImGuiIO& io = ImGui::GetIO(); //We can no longer use ImGui's keyboard state to query all possible keyboard keys, so we do it manually via GetAsyncKeyState() //To avoid issues with keys that are already down to begin with, we store the state in the moment of the popup appearing and only act on changes to that static bool keyboard_state_initial[255] = {0}; static bool wait_for_key_release = false; if (ImGui::IsWindowAppearing()) { for (int i = 0; i < IM_ARRAYSIZE(keyboard_state_initial); ++i) { keyboard_state_initial[i] = (::GetAsyncKeyState(i) < 0); } wait_for_key_release = false; } for (int i = 0; i < IM_ARRAYSIZE(keyboard_state_initial); ++i) { if ((::GetAsyncKeyState(i) < 0) != keyboard_state_initial[i]) { //Key was up before, so it's a key press if (!keyboard_state_initial[i]) { if (key.KeyCode != i) { HistoryPush(); key.KeyCode = i; } for (int i = 0; i < 256; i++) { if (GetKeyCodeForListID(i) == key.KeyCode) { list_id = i; break; } } scroll_to_selection = true; //Wait for the key to be released to avoid inputs triggering other things wait_for_key_release = true; keyboard_state_initial[i] = true; break; } else //Key was down before, so it's a key release. Update the initial state so it can be pressed again and registered as such { keyboard_state_initial[i] = false; //Close popup here if we are waiting for this key to be released if ((wait_for_key_release) && (i == key.KeyCode)) { close_picker = true; ImGui::CloseCurrentPopup(); io.ClearInputKeys(); } } } } ImGui::EndPopup(); if (close_picker) { ImGui::CloseCurrentPopup(); UIManager::Get()->RepeatFrame(); } } ImGui::EndPopup(); } //-Action Picker popup ImGui::SetNextWindowSize({io.DisplaySize.x / 3.0f, io.DisplaySize.y * 0.8f}); ImGui::SetNextWindowPos( {io.DisplaySize.x / 2.0f, io.DisplaySize.y / 2.0f}, ImGuiCond_Always, {0.5f, 0.5f}); if (ImGui::BeginPopupModal(TranslationManager::GetString(tstr_DialogActionPickerHeader), nullptr, ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoResize)) { static std::vector action_list; static ActionUID list_uid = k_ActionUID_Invalid; static bool scroll_to_selection = false; static ImVec2 no_actions_text_size; if (ImGui::IsWindowAppearing()) { action_list = ConfigManager::Get().GetActionManager().GetActionNameList(); list_uid = key.KeyActionUID; scroll_to_selection = true; //Set to invalid if selection doesn't exist if (!ConfigManager::Get().GetActionManager().ActionExists(list_uid)) { list_uid = k_ActionUID_Invalid; } } CloseCurrentModalPopupFromInput(); //No Action entry { ImGui::PushID(0); if (ImGui::Selectable(TranslationManager::GetString(tstr_ActionNone), (list_uid == k_ActionUID_Invalid) )) { list_uid = k_ActionUID_Invalid; if (key.KeyActionUID != k_ActionUID_Invalid) { HistoryPush(); key.KeyActionUID = k_ActionUID_Invalid; } ImGui::CloseCurrentPopup(); } if ( (scroll_to_selection) && (list_uid == k_ActionUID_Invalid) ) { ImGui::SetScrollHereY(); if (ImGui::IsItemVisible()) { scroll_to_selection = false; } } ImGui::PopID(); } //List actions for (const auto& entry : action_list) { ImGui::PushID((void*)entry.UID); if (ImGui::Selectable(entry.Name.c_str(), (entry.UID == list_uid) )) { list_uid = entry.UID; if (key.KeyActionUID != entry.UID) { HistoryPush(); key.KeyActionUID = entry.UID; } ImGui::CloseCurrentPopup(); } if ( (scroll_to_selection) && (entry.UID == list_uid) ) { ImGui::SetScrollHereY(); if (ImGui::IsItemVisible()) { scroll_to_selection = false; } } ImGui::PopID(); } ImGui::EndPopup(); } ImGui::PopStyleVar(); //ImGuiStyleVar_WindowRounding ImGui::End(); } void KeyboardEditor::UpdateWindowMetadata() { ImGuiIO& io = ImGui::GetIO(); ImGuiStyle& style = ImGui::GetStyle(); VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); const KeyboardLayoutMetadata& metadata = vr_keyboard.GetLayoutMetadata(); ImGui::SetNextWindowSize({io.DisplaySize.x / 4.0f, m_TopWindowHeight}); ImGui::SetNextWindowPos({io.DisplaySize.x, 0.0f}, ImGuiCond_Always, {1.0f, 0.0f}); ImGui::Begin(TranslationManager::GetString(tstr_KeyboardEditorMetadataTitle), nullptr, ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoCollapse); static char buffer_name[128] = ""; static char buffer_author[256] = ""; if (m_RefreshLayout) { size_t copied_length = vr_keyboard.GetLayoutMetadata().Name.copy(buffer_name, IM_ARRAYSIZE(buffer_name) - 1); buffer_name[copied_length] = '\0'; copied_length = vr_keyboard.GetLayoutMetadata().Author.copy(buffer_author, IM_ARRAYSIZE(buffer_author) - 1); buffer_author[copied_length] = '\0'; } ImGui::PushStyleVar(ImGuiStyleVar_WindowRounding, m_WindowRounding); //We don't need scrolling yet but the child window with border offers consistency with the key list window for now //Make the child expand past window padding ImGui::SetCursorPos({ImGui::GetCursorPosX() - style.WindowPadding.x, ImGui::GetCursorPosY() - style.WindowPadding.y - style.TabBarBorderSize}); ImGui::SetNextWindowBgAlpha(0.0f); ImGui::BeginChild("MetadataContents", {ImGui::GetContentRegionAvail().x + style.WindowPadding.x, -ImGui::GetFrameHeightWithSpacing()}, ImGuiChildFlags_Borders); ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, {0.0f, style.ItemSpacing.y}); //Avoid horizontal padding from the column ImGui::Columns(2, "ColumnMetadata", false); ImGui::SetColumnWidth(0, io.DisplaySize.x / 12.0f); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_KeyboardEditorMetadataName)); ImGui::NextColumn(); ImGui::SetNextItemWidth(-1); if (ImGui::InputText("##InputName", buffer_name, IM_ARRAYSIZE(buffer_name))) { HistoryPush(); m_HistoryHasPendingEdit = true; UIManager::Get()->AddFontBuilderStringIfAnyUnmappedCharacters(buffer_name); KeyboardLayoutMetadata metadata_new = metadata; metadata_new.Name = buffer_name; vr_keyboard.SetLayoutMetadata(metadata_new); } ImGui::NextColumn(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_KeyboardEditorMetadataAuthor)); ImGui::NextColumn(); ImGui::SetNextItemWidth(-1); if (ImGui::InputText("##InputAuthor", buffer_author, IM_ARRAYSIZE(buffer_author))) { HistoryPush(); m_HistoryHasPendingEdit = true; UIManager::Get()->AddFontBuilderStringIfAnyUnmappedCharacters(buffer_author); KeyboardLayoutMetadata metadata_new = metadata; metadata_new.Author = buffer_author; vr_keyboard.SetLayoutMetadata(metadata_new); } ImGui::Columns(1); ImGui::PopStyleVar(); //ImGuiStyleVar_ItemSpacing ImGui::Spacing(); bool has_altgr_temp = metadata.HasAltGr; if (ImGui::Checkbox(TranslationManager::GetString(tstr_KeyboardEditorMetadataHasAltGr), &has_altgr_temp)) { HistoryPush(); KeyboardLayoutMetadata metadata_new = metadata; metadata_new.HasAltGr = has_altgr_temp; vr_keyboard.SetLayoutMetadata(metadata_new); UIManager::Get()->RepeatFrame(); } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); ImGui::FixedHelpMarker(TranslationManager::GetString(tstr_KeyboardEditorMetadataHasAltGrTip)); ImGui::Spacing(); const float column_start_x = (float)(int)((ImGui::GetContentRegionAvail().x / 2.0f) + style.IndentSpacing); ImGui::TextUnformatted(TranslationManager::GetString(tstr_KeyboardEditorMetadataClusterPreview)); ImGui::Indent(); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsKeyboardKeyClusterFunction), &m_PreviewCluster[kbdlayout_cluster_function])) { UIManager::Get()->RepeatFrame(); } ImGui::SameLine(column_start_x); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsKeyboardKeyClusterNavigation), &m_PreviewCluster[kbdlayout_cluster_navigation])) { UIManager::Get()->RepeatFrame(); } if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsKeyboardKeyClusterNumpad), &m_PreviewCluster[kbdlayout_cluster_numpad])) { UIManager::Get()->RepeatFrame(); } ImGui::SameLine(column_start_x); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsKeyboardKeyClusterExtra), &m_PreviewCluster[kbdlayout_cluster_extra])) { UIManager::Get()->RepeatFrame(); } ImGui::EndChild(); static float bottom_buttons_width = 0.0f; ImGui::SetCursorPosX(ImGui::GetCursorPosX() + ImGui::GetContentRegionAvail().x - bottom_buttons_width); ImGui::BeginGroup(); if (ImGui::Button(TranslationManager::GetString(tstr_KeyboardEditorMetadataSave))) { ImGui::OpenPopup(TranslationManager::GetString(tstr_KeyboardEditorMetadataSavePopupTitle)); } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); if (ImGui::Button(TranslationManager::GetString(tstr_KeyboardEditorMetadataLoad))) { ImGui::OpenPopup(TranslationManager::GetString(tstr_KeyboardEditorMetadataLoadPopupTitle)); } ImGui::EndGroup(); bottom_buttons_width = ImGui::GetItemRectSize().x; //-Save Layout popup ImGui::SetNextWindowSize({io.DisplaySize.x / 3.0f, io.DisplaySize.y * 0.8f}); ImGui::SetNextWindowPos( {io.DisplaySize.x / 2.0f, io.DisplaySize.y / 2.0f}, ImGuiCond_Always, {0.5f, 0.5f}); if (ImGui::BeginPopupModal(TranslationManager::GetString(tstr_KeyboardEditorMetadataSavePopupTitle), nullptr, ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoResize)) { static std::vector list_layouts; static int list_id = 0; static char buffer_filename[256] = ""; static bool is_name_blank = false; static bool is_name_taken = false; static bool has_saving_failed = false; bool update_entry_match = false; bool is_entry_double_clicked = false; if (ImGui::IsWindowAppearing()) { list_id = -1; list_layouts = VRKeyboard::GetKeyboardLayoutList(); has_saving_failed = false; size_t copied_length = vr_keyboard.GetLayoutMetadata().FileName.copy(buffer_filename, IM_ARRAYSIZE(buffer_filename) - 1); buffer_filename[copied_length] = '\0'; update_entry_match = true; } CloseCurrentModalPopupFromInput(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_KeyboardEditorMetadataSavePopupFilename)); const float input_spacing_offset = (float)int(ImGui::GetContentRegionAvail().x * 0.10f); const float input_spacing = ImGui::GetItemRectMax().x - ImGui::GetWindowPos().x; if (is_name_blank) { ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); ImGui::FixedHelpMarker(TranslationManager::GetString(tstr_KeyboardEditorMetadataSavePopupFilenameBlankTip), "(!)"); } ImGui::SameLine(input_spacing_offset, input_spacing); ImGui::SetNextItemWidth(-1); if (ImGui::InputText("##InputFilename", buffer_filename, IM_ARRAYSIZE(buffer_filename), ImGuiInputTextFlags_CallbackCharFilter, [](ImGuiInputTextCallbackData* data) { return (int)IsWCharInvalidForFileName(data->EventChar); } )) { UIManager::Get()->AddFontBuilderStringIfAnyUnmappedCharacters(buffer_filename); update_entry_match = true; } //Select matching entry if (update_entry_match) { const std::string& current_filename = buffer_filename; auto it = std::find_if(list_layouts.begin(), list_layouts.end(), [¤t_filename](const auto& list_entry){ return (current_filename == list_entry.FileName); }); if (it != list_layouts.end()) { list_id = (int)std::distance(list_layouts.begin(), it); } else { list_id = -1; } is_name_blank = current_filename.empty(); } ImGui::BeginChild("LayoutList", ImVec2(0.0f, -ImGui::GetFrameHeightWithSpacing()), ImGuiChildFlags_Borders); int index = 0; for (const auto& metadata : list_layouts) { ImGui::PushID(index); if (ImGui::Selectable(metadata.Name.c_str(), (index == list_id))) { list_id = index; size_t copied_length = metadata.FileName.copy(buffer_filename, IM_ARRAYSIZE(buffer_filename) - 1); buffer_filename[copied_length] = '\0'; is_name_blank = false; } if ((ImGui::IsItemActive()) && (ImGui::IsMouseDoubleClicked(ImGuiMouseButton_Left))) { is_entry_double_clicked = true; } ImGui::SameLine(); ImGui::PushStyleColor(ImGuiCol_Text, style.Colors[ImGuiCol_TextDisabled]); ImGui::TextRightUnformatted(0.0f, 0.0f, metadata.FileName.c_str()); ImGui::PopStyleColor(); ImGui::PopID(); index++; } ImGui::EndChild(); if (is_name_blank) ImGui::PushItemDisabled(); if ((ImGui::Button(TranslationManager::GetString(tstr_KeyboardEditorMetadataSavePopupConfirm))) || (is_entry_double_clicked)) { //Append extension if needed std::string filename(buffer_filename); if (filename.rfind(".ini") != filename.length() - 4) { filename += ".ini"; } has_saving_failed = !vr_keyboard.SaveCurrentLayoutToFile(filename); if (!has_saving_failed) { ImGui::CloseCurrentPopup(); } } if (is_name_blank) ImGui::PopItemDisabled(); ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); if (ImGui::Button(TranslationManager::GetString(tstr_DialogCancel))) { ImGui::CloseCurrentPopup(); } if (has_saving_failed) { ImGui::SameLine(); ImGui::AlignTextToFramePadding(); ImGui::PushStyleColor(ImGuiCol_Text, Style_ImGuiCol_TextError); ImGui::TextRightUnformatted(style.ItemInnerSpacing.x, 0.0f, TranslationManager::GetString(tstr_KeyboardEditorMetadataSavePopupConfirmError)); ImGui::PopStyleColor(); } ImGui::EndPopup(); } //-Load Layout popup ImGui::SetNextWindowSize({io.DisplaySize.x / 3.0f, io.DisplaySize.y * 0.8f}); ImGui::SetNextWindowPos( {io.DisplaySize.x / 2.0f, io.DisplaySize.y / 2.0f}, ImGuiCond_Always, {0.5f, 0.5f}); if (ImGui::BeginPopupModal(TranslationManager::GetString(tstr_KeyboardEditorMetadataLoadPopupTitle), nullptr, ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoResize)) { static std::vector list_layouts; static int list_id = 0; bool is_entry_double_clicked = false; if (ImGui::IsWindowAppearing()) { list_id = -1; list_layouts = VRKeyboard::GetKeyboardLayoutList(); //Select matching entry const std::string& current_filename = vr_keyboard.GetLayoutMetadata().FileName; auto it = std::find_if(list_layouts.begin(), list_layouts.end(), [¤t_filename](const auto& list_entry){ return (current_filename == list_entry.FileName); }); if (it != list_layouts.end()) { list_id = (int)std::distance(list_layouts.begin(), it); } } CloseCurrentModalPopupFromInput(); ImGui::BeginChild("LayoutList", ImVec2(0.0f, -ImGui::GetFrameHeightWithSpacing()), ImGuiChildFlags_Borders); int index = 0; for (const auto& metadata : list_layouts) { ImGui::PushID(index); if (ImGui::Selectable(metadata.Name.c_str(), (index == list_id))) { list_id = index; } if ((ImGui::IsItemActive()) && (ImGui::IsMouseDoubleClicked(ImGuiMouseButton_Left))) { is_entry_double_clicked = true; } ImGui::SameLine(); ImGui::PushStyleColor(ImGuiCol_Text, style.Colors[ImGuiCol_TextDisabled]); ImGui::TextRightUnformatted(0.0f, 0.0f, metadata.FileName.c_str()); ImGui::PopStyleColor(); ImGui::PopID(); index++; } ImGui::EndChild(); if ((ImGui::Button(TranslationManager::GetString(tstr_KeyboardEditorMetadataLoadPopupConfirm))) || (is_entry_double_clicked)) { vr_keyboard.LoadLayoutFromFile(list_layouts[list_id].FileName); ImGui::CloseCurrentPopup(); m_RefreshLayout = true; m_HasChangedSelectedKey = true; HistoryClear(); } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); if (ImGui::Button(TranslationManager::GetString(tstr_DialogCancel))) { ImGui::CloseCurrentPopup(); } ImGui::EndPopup(); } ImGui::PopStyleVar(); //ImGuiStyleVar_WindowRounding ImGui::End(); } void KeyboardEditor::UpdateWindowPreview() { //This needs to be kept in sync with WindowKeyboard::WindowUpdate(), but is also sufficiently different to not try to make a mess in that function from trying to shove it there ImGuiIO& io = ImGui::GetIO(); ImGuiStyle& style = ImGui::GetStyle(); VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); //We only scale style sizes up in desktop mode (using DPI instead of UI scale value), but for accurate keyboard preview we need spacing to scale with UI scale const float ui_scale = UIManager::Get()->GetUIScale(); ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, {8.0f * ui_scale, 4.0f * ui_scale}); ImGui::PushStyleVar(ImGuiStyleVar_ItemInnerSpacing, {4.0f * ui_scale, 4.0f * ui_scale}); const DPRect& rect = UITextureSpaces::Get().GetRect(ui_texspace_keyboard); ImGui::SetNextWindowSizeConstraints({ImGui::GetFrameHeight() * 6.0f, ImGui::GetFrameHeight() * 2.0f}, {(rect.GetWidth() - 4) * ui_scale, (rect.GetHeight() - 4) * ui_scale}); ImGui::SetNextWindowPos({io.DisplaySize.x / 2.0f, io.DisplaySize.y}, ImGuiCond_Always, {0.5f, 1.0f}); ImGui::Begin(TranslationManager::GetString(tstr_KeyboardEditorPreviewTitle), nullptr, ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoCollapse | ImGuiWindowFlags_AlwaysAutoResize); const float base_width = (float)int(ImGui::GetTextLineHeightWithSpacing() * 2.225f); //Used for kbdlayout_key_virtual_key_iso_enter key ImVec2 iso_enter_top_pos(-1.0f, -1.0f); float iso_enter_top_width = -1.0f; int iso_enter_top_index = -1; int row_index = 0; int key_index = 0; ImVec2 cursor_pos = ImGui::GetCursorPos(); ImVec2 cursor_pos_line_start = cursor_pos; for (const auto& key : vr_keyboard.GetLayout(m_SelectedSublayout)) { //Skip key as if it was never loaded if preview is disabled for it if (!m_PreviewCluster[key.KeyCluster]) { key_index++; if (key.IsRowEnd) { ++row_index; //Only force a new line if the cursor moved (meaning we didn't skip all keys in this row) if ((cursor_pos_line_start.x != ImGui::GetCursorPos().x) || (cursor_pos_line_start.x != ImGui::GetCursorPos().x)) { ImGui::NewLine(); cursor_pos_line_start = ImGui::GetCursorPos(); } } continue; } else if ((cursor_pos_line_start.x != ImGui::GetCursorPos().x) || (cursor_pos_line_start.x != ImGui::GetCursorPos().x)) { //To make above work correctly, spacing is applied here, with cursor_pos still holding values from the previous key cursor_pos.x += style.ItemInnerSpacing.x; ImGui::SetCursorPos(cursor_pos); } ImGui::PushID(key_index); //Keep cursor pos on integer values cursor_pos = ImGui::GetCursorPos(); ImGui::SetCursorPos({ceilf(cursor_pos.x), ceilf(cursor_pos.y)}); //This accounts for the spacing that is missing with wider keys so rows still line up and also forces integer values const float key_width_f = base_width * key.Width + (style.ItemInnerSpacing.x * (key.Width - 1.0f)); const float key_height = (float)(int)( base_width * key.Height + (style.ItemInnerSpacing.y * (key.Height - 1.0f)) ); float key_width = (float)(int)( key_width_f ); //Add an extra pixel of width if the untruncated values would push it further //There might be a smarter way to do this (simple rounding doesn't seem to be it), but this helps the keys align while rendering on full pixels only if (cursor_pos.x + key_width_f > ImGui::GetCursorPosX() + key_width) { key_width += 1.0f; } const bool highlight_key = ((key_index == m_SelectedKeyID) || (m_SelectedRowID == row_index)); if (highlight_key) ImGui::PushStyleColor(ImGuiCol_Button, Style_ImGuiCol_ButtonPassiveToggled); switch (key.KeyType) { case kbdlayout_key_blank_space: { ImGui::PushStyleColor(ImGuiCol_Button, 0); if (ImGui::Button("", {key_width, key_height})) { m_SelectedRowID = -1; m_SelectedKeyID = key_index; m_HasChangedSelectedKey = true; } ImGui::PopStyleColor(); if (highlight_key) { ImGui::GetWindowDrawList()->AddRect(ImGui::GetItemRectMin(), ImGui::GetItemRectMax(), ImGui::GetColorU32(ImGuiCol_Button), style.FrameRounding, 0, style.WindowBorderSize * 2.0f); } break; } case kbdlayout_key_virtual_key: case kbdlayout_key_virtual_key_toggle: case kbdlayout_key_string: case kbdlayout_key_sublayout_toggle: case kbdlayout_key_action: { if (ImGui::Button("", {key_width, key_height})) { m_SelectedRowID = -1; m_SelectedKeyID = key_index; m_HasChangedSelectedKey = true; } ImGui::RenderButtonMultilineLabel(key.Label.c_str(), 0.82f); break; } case kbdlayout_key_virtual_key_iso_enter: { //This one's a bit of a mess, but builds an ISO-Enter shaped button out of two key entries //First step is the top "key". Its label is unused, but the width is. //Second step is the bottom "key". It stretches itself over the row above it and hosts the label. //First and second step used invisible buttons first to check item state and have it synced up, //then in the second step there are two visual-only buttons used with style color adjusted to the state of the invisible buttons // //...now that a custom button implementation is used anyways this could be solved more cleanly... but it still works, so eh. const bool is_bottom_key = (iso_enter_top_index != -1); const ImVec2 cursor_pos = ImGui::GetCursorPos(); float offset_y = 0.0f; //If second ISO-enter key, offset cursor to the previous row and stretch the button down to the end of the current row if (is_bottom_key) { offset_y = style.ItemSpacing.y + base_width; ImGui::SetCursorPosY(ImGui::GetCursorPosY() - offset_y); } else //else remember the width of the top part for later { iso_enter_top_pos = cursor_pos; iso_enter_top_width = key_width; iso_enter_top_index = key_index; } if (ImGui::Button("", {key_width, base_width + offset_y})) { m_SelectedRowID = -1; m_SelectedKeyID = key_index; m_HasChangedSelectedKey = true; } ImGui::RenderButtonMultilineLabel((is_bottom_key) ? key.Label.c_str() : "##IsoEnterDummy", 0.82f); break; } default: break; } if (highlight_key) ImGui::PopStyleColor(); //Select row by right clicking if (ImGui::IsItemClicked(ImGuiMouseButton_Right)) { m_SelectedRowID = row_index; m_SelectedKeyID = -1; m_HasChangedSelectedKey = true; } //Return to normal row position if the key was taller than 100% if (key.Height > 1.0f) { ImGui::SetCursorPosY(ImGui::GetCursorPosY() - key_height + base_width); ImGui::SetPreviousLineHeight(ImGui::GetPreviousLineHeight() - key_height + base_width); } if (!key.IsRowEnd) { ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); cursor_pos.x += key_width_f; } else { ++row_index; cursor_pos_line_start = ImGui::GetCursorPos(); } ImGui::PopID(); ++key_index; } ImGui::End(); ImGui::PopStyleVar(2); //ImGuiStyleVar_ItemSpacing, ImGuiStyleVar_ItemInnerSpacing } std::pair KeyboardEditor::GetKeyRowRange(KeyboardLayoutSubLayout sublayout, int row_id) { auto& sublayout_keys = UIManager::Get()->GetVRKeyboard().GetLayout(sublayout); int key_id_begin = 0; int key_id_end = (int)sublayout_keys.size(); //Set to size() so begin() + key_id_end results in end() if nothing is found for (int i = 0, loop_row_id = 0; i < sublayout_keys.size(); ++i) { if (sublayout_keys[i].IsRowEnd) { ++loop_row_id; if (loop_row_id == row_id) { key_id_begin = i + 1; } else if (loop_row_id == row_id + 1) { key_id_end = i + 1; break; } } } return std::make_pair(key_id_begin, key_id_end); } int KeyboardEditor::FindKeyWithClosestPosInNewSubLayout(int key_index, KeyboardLayoutSubLayout sublayout_id_current, KeyboardLayoutSubLayout sublayout_id_new) { //Not to be confused with WindowKeyboard::FindSameKeyInNewSubLayout() which only finds exact matches with same function at same pos instead if (key_index < 0) return -1; //Return index of key with position closest to sublayout_current's key_index key position VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); const auto& sublayout_current = vr_keyboard.GetLayout(sublayout_id_current); const auto& sublayout_new = vr_keyboard.GetLayout(sublayout_id_new); //Skip if index doesn't exist in layout for some reason if (sublayout_current.size() <= key_index) return -1; //Get key position in current layout int i = 0; Vector2 key_current_pos; for (const auto& key : sublayout_current) { if (i == key_index) { break; } key_current_pos.x += key.Width; if (key.IsRowEnd) { key_current_pos.x = 0.0f; key_current_pos.y += 1.0f; //Key height doesn't matter, advance a row } i++; } //Find key closest to the old position in new layout i = 0; Vector2 key_new_pos; int key_lowest_dist_id = -1; float key_lowest_dist = FLT_MAX; for (const auto& key : sublayout_new) { if ( (key_new_pos.y == key_current_pos.y) && (key_new_pos.x == key_current_pos.x) ) { //Key exists at the same position return that return i; } else { //Alternatively get the closest key and return that at the end if we don't find anything better float distance = key_new_pos.distance(key_current_pos); if (distance < key_lowest_dist) { key_lowest_dist_id = i; key_lowest_dist = distance; } } key_new_pos.x += key.Width; if (key.IsRowEnd) { key_new_pos.x = 0.0f; key_new_pos.y += 1.0f; } i++; } return key_lowest_dist_id; } void KeyboardEditor::HistoryPush() { if (!m_HistoryHasPendingEdit) { HistoryPushInternal(m_HistoryUndo); m_HistoryRedo.clear(); } } void KeyboardEditor::HistoryPushInternal(std::vector& target_history) { //This copies the entire keyboard data for every history item VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); HistoryItem item; item.Metadata = vr_keyboard.GetLayoutMetadata(); for (int i_sublayout = kbdlayout_sub_base; i_sublayout < kbdlayout_sub_MAX; ++i_sublayout) { KeyboardLayoutSubLayout sublayout = (KeyboardLayoutSubLayout)i_sublayout; item.KeyboardKeys[sublayout] = vr_keyboard.GetLayout(sublayout); } target_history.push_back(item); } void KeyboardEditor::HistoryUndo() { if (m_HistoryUndo.empty()) return; VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); HistoryItem item = m_HistoryUndo.back(); m_HistoryUndo.pop_back(); HistoryPushInternal(m_HistoryRedo); vr_keyboard.SetLayoutMetadata(item.Metadata); for (int i_sublayout = kbdlayout_sub_base; i_sublayout < kbdlayout_sub_MAX; ++i_sublayout) { KeyboardLayoutSubLayout sublayout = (KeyboardLayoutSubLayout)i_sublayout; vr_keyboard.SetLayout(sublayout, item.KeyboardKeys[sublayout]); } m_HasChangedSelectedKey = true; m_RefreshLayout = true; } void KeyboardEditor::HistoryRedo() { if (m_HistoryRedo.empty()) return; VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); HistoryItem item = m_HistoryRedo.back(); m_HistoryRedo.pop_back(); HistoryPushInternal(m_HistoryUndo); vr_keyboard.SetLayoutMetadata(item.Metadata); for (int i_sublayout = kbdlayout_sub_base; i_sublayout < kbdlayout_sub_MAX; ++i_sublayout) { KeyboardLayoutSubLayout sublayout = (KeyboardLayoutSubLayout)i_sublayout; vr_keyboard.SetLayout(sublayout, item.KeyboardKeys[sublayout]); } m_HasChangedSelectedKey = true; m_RefreshLayout = true; } void KeyboardEditor::HistoryClear() { m_HistoryUndo.clear(); m_HistoryRedo.clear(); } void KeyboardEditor::CloseCurrentModalPopupFromInput() { //Imitate non-modal non-window click closing behavior (we go modal to get the title bar) if ( ( (!ImGui::IsWindowHovered(ImGuiHoveredFlags_ChildWindows)) && ( (ImGui::IsMouseClicked(ImGuiMouseButton_Left)) || (ImGui::IsMouseClicked(ImGuiMouseButton_Right)) )) || (ImGui::IsKeyPressed(ImGuiKey_Escape)) ) { ImGui::CloseCurrentPopup(); } } void KeyboardEditor::Update() { const bool has_changed_key_prev = m_HasChangedSelectedKey; const bool refresh_layout_prev = m_RefreshLayout; m_TopWindowHeight = ImGui::GetIO().DisplaySize.y - (UITextureSpaces::Get().GetRect(ui_texspace_keyboard).GetHeight() * UIManager::Get()->GetUIScale()); m_WindowRounding = ImGui::GetStyle().WindowRounding; //Store window rounding before pushing it to 0 so we have the scaled value for popups later ImGui::PushStyleVar(ImGuiStyleVar_WindowRounding, 0.0f); UpdateWindowKeyList(); UpdateWindowKeyProperties(); UpdateWindowMetadata(); ImGui::PopStyleVar(); UpdateWindowPreview(); if (ImGui::IsAnyItemDeactivated()) { m_HistoryHasPendingEdit = false; } if (has_changed_key_prev == m_HasChangedSelectedKey) { m_HasChangedSelectedKey = false; } else { UIManager::Get()->RepeatFrame(); } if (refresh_layout_prev == m_RefreshLayout) { m_RefreshLayout = false; } else { UIManager::Get()->RepeatFrame(); } } ================================================ FILE: src/DesktopPlusUI/WindowKeyboardEditor.h ================================================ #pragma once #include "VRKeyboardCommon.h" #include class KeyboardEditor { //Not exactly space efficient, but simple and works struct HistoryItem { KeyboardLayoutMetadata Metadata; std::vector KeyboardKeys[kbdlayout_sub_MAX]; }; private: float m_TopWindowHeight = 0.0f; float m_WindowRounding = 0.0f; KeyboardLayoutSubLayout m_SelectedSublayout = kbdlayout_sub_base; int m_SelectedRowID = -1; int m_SelectedKeyID = -1; bool m_HasChangedSelectedKey = false; bool m_RefreshLayout = true; std::vector m_HistoryUndo; std::vector m_HistoryRedo; bool m_HistoryHasPendingEdit = false; //Set by widgets that make continuous changes but should only push history once until deactivated bool m_PreviewCluster[kbdlayout_cluster_MAX] = {true, true, true, true, true}; void UpdateWindowKeyList(); void UpdateWindowKeyProperties(); void UpdateWindowMetadata(); void UpdateWindowPreview(); std::pair GetKeyRowRange(KeyboardLayoutSubLayout sublayout, int row_id); //Returns beginning & end key IDs int FindKeyWithClosestPosInNewSubLayout(int key_index, KeyboardLayoutSubLayout sublayout_id_current, KeyboardLayoutSubLayout sublayout_id_new); void HistoryPush(); void HistoryPushInternal(std::vector& target_history); void HistoryUndo(); void HistoryRedo(); void HistoryClear(); void CloseCurrentModalPopupFromInput(); //Imitates non-modal popup closing behavior public: void Update(); }; ================================================ FILE: src/DesktopPlusUI/WindowOverlayBar.cpp ================================================ #include "WindowOverlayBar.h" #include "ImGuiExt.h" #include "TextureManager.h" #include "InterprocessMessaging.h" #include "Util.h" #include "OpenVRExt.h" #include "UIManager.h" #include "OverlayManager.h" #include "DesktopPlusWinRT.h" #include "DPBrowserAPIClient.h" WindowOverlayBar::WindowOverlayBar() : m_Visible(true), m_Alpha(1.0f), m_IsScrollBarVisible(false), m_OverlayButtonActiveMenuID(k_ulOverlayID_None), m_IsAddOverlayButtonActive(false), m_MenuAlpha(0.0f), m_IsMenuRemoveConfirmationVisible(false), m_IsDraggingOverlayButtons(false) { m_Size.x = 32.0f; } void WindowOverlayBar::DisplayTooltipIfHovered(const char* text, unsigned int overlay_id) { //Blank name is not allowed by ImGui and doesn't much sense to display anyways if ((text == nullptr) || (text[0] == '\0')) return; if (ImGui::IsItemHovered()) { const ImGuiStyle& style = ImGui::GetStyle(); static ImVec2 button_pos_last; //Remember last position and use it when posible. This avoids flicker when the same tooltip string is used in different places ImVec2 pos = ImGui::GetItemRectMin(); pos.y = ImGui::GetIO().DisplaySize.y; float button_width = ImGui::GetItemRectSize().x; //Default tooltips are not suited for this as there's too much trouble with resize flickering and stuff ImGui::Begin(text, nullptr, ImGuiWindowFlags_NoInputs | ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoSavedSettings | ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_NoFocusOnAppearing); ImGui::BeginGroup(); //Display icon for overlay origin if the tooltip is for a overlay if (overlay_id != k_ulOverlayID_None) { const OverlayConfigData& data = OverlayManager::Get().GetConfigData(overlay_id); ImVec2 img_size_line_height = {ImGui::GetTextLineHeight(), ImGui::GetTextLineHeight()}; ImVec2 img_size, img_uv_min, img_uv_max; TextureManager::Get().GetTextureInfo((TMNGRTexID)(tmtex_icon_xsmall_origin_room + data.ConfigInt[configid_int_overlay_origin]), img_size, img_uv_min, img_uv_max); ImGui::Image(ImGui::GetIO().Fonts->TexID, img_size_line_height, img_uv_min, img_uv_max); ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); } ImGui::TextUnformatted(text); ImGui::EndGroup(); //Not using GetWindowSize() here since it's delayed and plays odd when switching between buttons with the same label ImVec2 window_size = ImGui::GetItemRectSize(); window_size.x += style.WindowPadding.x * 2.0f; window_size.y += style.WindowPadding.y * 2.0f; //Repeat frame when the window is appearing as it will not have the right position (either from being first time or still having old pos) if ( (ImGui::IsWindowAppearing()) || (pos.x != button_pos_last.x) ) { UIManager::Get()->RepeatFrame(); } button_pos_last = pos; pos.x += (button_width / 2.0f) - (window_size.x / 2.0f); pos.y -= window_size.y; pos.x = clamp(pos.x, 0.0f, ImGui::GetIO().DisplaySize.x - window_size.x); //Clamp right side to texture end ImGui::SetWindowPos(pos); ImGui::End(); } } void WindowOverlayBar::UpdateOverlayButtons() { ImGuiIO& io = ImGui::GetIO(); ImGuiStyle& style = ImGui::GetStyle(); struct OverlayButtonState { float starting_x = -1.0f; float animation_progress = 0.0f; }; //List of unique IDs for overlays so ImGui can identify the same list entries after reordering or list expansion (needed for drag reordering) static std::vector list_unique_ids; static std::vector list_unique_data; static unsigned int drag_button_id = k_ulOverlayID_None; static unsigned int drag_overlay_id = k_ulOverlayID_None; static float drag_mouse_offset = 0.0f; const int overlay_count = (int)OverlayManager::Get().GetOverlayCount(); const unsigned int properties_active_overlay = (UIManager::Get()->GetOverlayPropertiesWindow().IsVisible()) ? (UIManager::Get()->GetOverlayPropertiesWindow().GetActiveOverlayID()) : k_ulOverlayID_None; //Reset unique IDs & widget data when appearing if (ImGui::IsWindowAppearing()) { list_unique_ids.clear(); list_unique_data.clear(); } //Expand unique id lists if overlays were added (also does initialization since it's empty then) while (list_unique_ids.size() < OverlayManager::Get().GetOverlayCount()) { list_unique_ids.push_back((int)list_unique_ids.size()); } while (list_unique_data.size() < OverlayManager::Get().GetOverlayCount()) { list_unique_data.emplace_back(); } //Get settings icons dimensions for uniform button size ImVec2 b_size, b_uv_min, b_uv_max; TextureManager::Get().GetTextureInfo(tmtex_icon_settings, b_size, b_uv_min, b_uv_max); ImVec2 b_size_default = b_size; static unsigned int left_down_overlay_id = k_ulOverlayID_None; static unsigned int right_down_overlay_id = k_ulOverlayID_None; static unsigned int hovered_overlay_id_last = k_ulOverlayID_None; unsigned int hovered_overlay_id = k_ulOverlayID_None; //Lambda for an overlay button widget. Interactions are implemented separately where needed auto overlay_button = [&](unsigned int overlay_id) { bool is_active = ( (m_OverlayButtonActiveMenuID == overlay_id) || (drag_overlay_id == overlay_id) || (properties_active_overlay == overlay_id) || (left_down_overlay_id == overlay_id) || (right_down_overlay_id == overlay_id) ); if (is_active) { ImGui::PushStyleColor(ImGuiCol_Button, ImGui::GetStyleColorVec4(ImGuiCol_ButtonActive)); ImGui::PushStyleColor(ImGuiCol_ButtonHovered, ImGui::GetStyleColorVec4(ImGuiCol_ButtonActive)); } //Get icon texture ID OverlayConfigData& data = OverlayManager::Get().GetConfigData(overlay_id); bool b_window_icon_available; TextureManager::Get().GetOverlayIconTextureInfo(data, b_size, b_uv_min, b_uv_max, false, &b_window_icon_available); const ImVec4 tint_color = ImVec4(1.0f, 1.0f, 1.0f, data.ConfigBool[configid_bool_overlay_enabled] ? 1.0f : 0.5f); //Half-transparent when hidden bool ret = ImGui::ImageButton("OverlayButton", io.Fonts->TexID, b_size_default, b_uv_min, b_uv_max, ImVec4(0.0f, 0.0f, 0.0f, 0.0f), tint_color); if (is_active) { ImGui::PopStyleColor(2); } //Additional button behavior const ImVec2 pos = ImGui::GetItemRectMin(); const float width = ImGui::GetItemRectSize().x; //Draw window icon on top if (b_window_icon_available) { TextureManager::Get().GetOverlayIconTextureInfo(data, b_size, b_uv_min, b_uv_max, true); //Downscale oversized icons float icon_scale = (b_size_default.x * 0.5f) / std::max(b_size.x, b_size.y); if (icon_scale < 1.0f) { b_size *= icon_scale; } ImVec2 p_min = {pos.x + (width / 2.0f) - (b_size.x / 2.0f), pos.y + (width / 2.0f) - (b_size.y / 2.0f)}; ImVec2 p_max = p_min; p_max.x += b_size.x; p_max.y += b_size.y; ImGui::GetWindowDrawList()->AddImage(io.Fonts->TexID, p_min, p_max, b_uv_min, b_uv_max, ImGui::ColorConvertFloat4ToU32(tint_color)); } return ret; }; //List overlays const float button_width_base = b_size_default.x + (style.ItemSpacing.x * 3.0f); const ImVec2 cursor_pos_first = ImGui::GetCursorPos(); const ImVec2 cursor_screen_pos_first = ImGui::GetCursorScreenPos(); ImGui::PushID("OverlayButtons"); const unsigned int u_overlay_count = OverlayManager::Get().GetOverlayCount(); for (unsigned int i = 0; i < u_overlay_count; ++i) { const unsigned int button_id = list_unique_ids[i]; if (drag_button_id != button_id) { ImGui::PushID(button_id); //Button positioning OverlayButtonState& button_state = list_unique_data[button_id]; const float target_x = cursor_pos_first.x + (button_width_base * i); if (button_state.starting_x != -1.0f) { ImGui::SetCursorPosX(smoothstep(button_state.animation_progress, button_state.starting_x, target_x)); const float animation_step = ImGui::GetIO().DeltaTime * 6.0f; button_state.animation_progress = clamp(button_state.animation_progress + animation_step, 0.0f, 1.0f); if (button_state.animation_progress == 1.0f) { button_state.starting_x = -1.0f; button_state.animation_progress = 0.0f; } } else { ImGui::SetCursorPosX(target_x); } //Overlay button widget if (overlay_button(i)) { if (io.MouseDownDurationPrev[ImGuiMouseButton_Left] < 3.0f) //Don't do normal button behavior after reset was just triggered { if ((m_OverlayButtonActiveMenuID != i) && (!m_IsDraggingOverlayButtons)) { HideMenus(); m_OverlayButtonActiveMenuID = i; } else { HideMenus(); } } } //-Additional button behavior bool button_active = ImGui::IsItemActive(); ImVec2 pos = ImGui::GetItemRectMin(); float width = ImGui::GetItemRectSize().x; //Reset transform when holding the button for 3 or more seconds bool show_hold_message = false; if ( (button_active) && (!m_IsDraggingOverlayButtons) ) { if (io.MouseDownDuration[ImGuiMouseButton_Left] > 3.0f) { FloatingWindow& overlay_properties = UIManager::Get()->GetOverlayPropertiesWindow(); overlay_properties.SetPinned(false); overlay_properties.ResetTransformAll(); io.MouseDown[ImGuiMouseButton_Left] = false; //Release mouse button so transform changes don't get blocked } else if (io.MouseDownDuration[ImGuiMouseButton_Left] > 0.5f) { show_hold_message = true; } } if (ImGui::IsItemHovered()) { //Quick toggle visibility via double-click const int click_count = ImGui::GetMouseClickedCount(ImGuiMouseButton_Left); if ((click_count > 1) && (click_count % 2 == 0)) //ImGui keeps counting up, so fast double-clicks in a row don't get detected as such with ImGui::IsMouseDoubleClicked() { OverlayConfigData& data = OverlayManager::Get().GetConfigData(i); bool& is_enabled = data.ConfigBool[configid_bool_overlay_enabled]; is_enabled = !is_enabled; IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, i); IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_overlay_enabled, is_enabled); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, -1); } //Quick switch properties via right-click if (ImGui::IsMouseClicked(ImGuiMouseButton_Right)) { right_down_overlay_id = i; } if ((ImGui::IsMouseReleased(ImGuiMouseButton_Right)) && (right_down_overlay_id == i)) { WindowOverlayProperties& properties_window = UIManager::Get()->GetOverlayPropertiesWindow(); //Hide window instead if it's already open for this overlay if ((properties_window.IsVisible()) && (properties_window.GetActiveOverlayID() == i)) { properties_window.Hide(); } else { properties_window.SetActiveOverlayID(i); properties_window.Show(); } HideMenus(); } } //Remember hovered overlay for highlighting if (ImGui::IsItemHovered(ImGuiHoveredFlags_AllowWhenBlockedByActiveItem)) { hovered_overlay_id = i; } //Tooltip, but don't show while dragging or animating position if ((!m_IsDraggingOverlayButtons) && (button_state.starting_x == -1.0f)) { (show_hold_message) ? DisplayTooltipIfHovered(TranslationManager::GetString(tstr_OverlayBarTooltipResetHold)) : DisplayTooltipIfHovered(OverlayManager::Get().GetConfigData(i).ConfigNameStr.c_str(), i); } //Button menu if (m_OverlayButtonActiveMenuID == i) { float dist = width / 2.0f; float menu_y = m_Pos.y + ImGui::GetStyle().WindowBorderSize + dist - (dist * m_MenuAlpha); MenuOverlayButton(i, {pos.x + width / 2.0f, menu_y}, button_active); //Check if menu modified overlay count and bail then if (OverlayManager::Get().GetOverlayCount() != u_overlay_count) { ImGui::PopID(); UIManager::Get()->RepeatFrame(); break; } } //Dragging start if (button_active) { if (!m_IsDraggingOverlayButtons) { //Record cursor offset at the time of clicking as we require a large drag delta to avoid mis-inputs when trying to just press the button with a shaky pointer //The button will be animated to snap to this offset if (ImGui::IsMouseClicked(ImGuiMouseButton_Left)) { drag_mouse_offset = -(ImGui::GetMousePos().x - ImGui::GetItemRectMin().x); } //Not using ImGui::IsMouseDragging() here to only check for horizontal dragging if (fabs(ImGui::GetMouseDragDelta().x) > width / 2.0f) { drag_button_id = button_id; drag_overlay_id = i; m_IsDraggingOverlayButtons = true; //Set starting drag state for animating the button snapping to the mouse offset posiiton OverlayButtonState& drag_button_state = list_unique_data[list_unique_ids[drag_overlay_id]]; const float target_x = ImGui::GetMousePos().x + drag_mouse_offset - ImGui::GetMouseDragDelta().x; if (drag_button_state.starting_x != -1.0f) //account for ongoing animation even if it's really quick { drag_button_state.starting_x = smoothstep(drag_button_state.animation_progress, drag_button_state.starting_x, target_x); } else { drag_button_state.starting_x = target_x; } //This state is only used to avoid flickering when dragging right at the button edge since in Dear ImGui a held-down button doesn't stay visually down if the cursor leaves it //It's going to highlight the wrong buttons if it stays set during the drag however, so we already clear it here left_down_overlay_id = k_ulOverlayID_None; UIManager::Get()->RepeatFrame(); } else { left_down_overlay_id = i; } } } ImGui::SameLine(); ImGui::PopID(); } } if (m_IsDraggingOverlayButtons) { ImGui::PushID(drag_button_id); //Add active dragged button separately so it's always on top of the other ones OverlayButtonState& drag_button_state = list_unique_data[list_unique_ids[drag_overlay_id]]; const float target_x_drag = ImGui::GetMousePos().x + drag_mouse_offset; //Animate the button snapping from its initial positon into the mouse position with drag offset float drag_button_x = -1.0f; if (drag_button_state.starting_x != -1.0f) { drag_button_x = smoothstep(drag_button_state.animation_progress, drag_button_state.starting_x, target_x_drag); const float animation_step = ImGui::GetIO().DeltaTime * 8.0f; drag_button_state.animation_progress = clamp(drag_button_state.animation_progress + animation_step, 0.0f, 1.0f); if (drag_button_state.animation_progress == 1.0f) { drag_button_state.starting_x = -1.0f; drag_button_state.animation_progress = 0.0f; } } else { drag_button_x = target_x_drag; } drag_button_x = clamp(drag_button_x, cursor_screen_pos_first.x, cursor_screen_pos_first.x + (button_width_base * (u_overlay_count - 1) )); //Overlay button widget ImGui::SetCursorScreenPos({drag_button_x, ImGui::GetCursorScreenPos().y}); ImGui::SetNextItemAllowOverlap(); overlay_button(drag_overlay_id); ImGui::SameLine(); //Button & overlay swapping unsigned int index_swap = (unsigned int)( ((drag_button_x - cursor_screen_pos_first.x) + (button_width_base / 2.0f)) / button_width_base ); if (drag_overlay_id != index_swap) { //Animate swap OverlayButtonState& button_state_swap = list_unique_data[list_unique_ids[index_swap]]; const float target_x = cursor_pos_first.x + (button_width_base * index_swap); if (button_state_swap.starting_x != -1.0f) //account for ongoing animation even if it's really quick { button_state_swap.starting_x = smoothstep(button_state_swap.animation_progress, button_state_swap.starting_x, target_x); } else { button_state_swap.starting_x = target_x; } button_state_swap.animation_progress = 0.0f; //Actually swap the overlay OverlayManager::Get().SwapOverlays(drag_overlay_id, index_swap); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, drag_overlay_id); IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_swap, index_swap); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, -1); std::iter_swap(list_unique_ids.begin() + drag_overlay_id, list_unique_ids.begin() + index_swap); //Also adjust the active properties window if we just swapped that if (properties_active_overlay == drag_overlay_id) { UIManager::Get()->GetOverlayPropertiesWindow().SetActiveOverlayID(index_swap, true); } else if (properties_active_overlay == index_swap) { UIManager::Get()->GetOverlayPropertiesWindow().SetActiveOverlayID(drag_overlay_id, true); } drag_overlay_id = index_swap; m_OverlayButtonActiveMenuID = k_ulOverlayID_None; UIManager::Get()->RepeatFrame(); } //Dragging release if (ImGui::IsMouseReleased(ImGuiMouseButton_Left)) { drag_button_state.starting_x = drag_button_x - ImGui::GetWindowPos().x + ImGui::GetScrollX(); drag_button_state.animation_progress = 0.0f; drag_button_id = k_ulOverlayID_None; drag_overlay_id = k_ulOverlayID_None; m_IsDraggingOverlayButtons = false; } ImGui::PopID(); } if (ImGui::IsMouseReleased(ImGuiMouseButton_Left)) { left_down_overlay_id = k_ulOverlayID_None; } if (ImGui::IsMouseReleased(ImGuiMouseButton_Right)) { right_down_overlay_id = k_ulOverlayID_None; } //Don't change overlay highlight while mouse down as it won't be correct while dragging and flicker just before it if ( (!ImGui::IsMouseDown(ImGuiMouseButton_Left)) && ((hovered_overlay_id_last != k_ulOverlayID_None) || (hovered_overlay_id != k_ulOverlayID_None)) ) { UIManager::Get()->HighlightOverlay(hovered_overlay_id); hovered_overlay_id_last = hovered_overlay_id; } //Always leave cursor where the last unmoved button would've left it (leaves blank space during during drags if necessary) ImGui::SetCursorPosX(cursor_pos_first.x + (button_width_base * u_overlay_count)); ImGui::PopID(); } void WindowOverlayBar::MenuOverlayButton(unsigned int overlay_id, ImVec2 pos, bool is_item_active) { m_MenuAlpha += ImGui::GetIO().DeltaTime * 12.0f; if (m_MenuAlpha > 1.0f) m_MenuAlpha = 1.0f; ImGui::PushStyleVar(ImGuiStyleVar_Alpha, m_MenuAlpha); ImGui::PushStyleVar(ImGuiStyleVar_WindowRounding, 0.0f); if (ImGui::Begin("OverlayButtonMenu", nullptr, ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoSavedSettings | ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_NoFocusOnAppearing | ImGuiWindowFlags_NoBringToFrontOnFocus)) { if ( (!ImGui::IsWindowHovered(ImGuiHoveredFlags_AllowWhenBlockedByActiveItem)) && (ImGui::IsAnyMouseClicked()) && (!is_item_active) ) { HideMenus(); } bool& is_enabled = OverlayManager::Get().GetConfigData(overlay_id).ConfigBool[configid_bool_overlay_enabled]; WindowOverlayProperties& properties_window = UIManager::Get()->GetOverlayPropertiesWindow(); if (ImGui::Selectable(TranslationManager::GetString((is_enabled) ? tstr_OverlayBarOvrlHide : tstr_OverlayBarOvrlShow), false)) { is_enabled = !is_enabled; IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, (int)overlay_id); IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_overlay_enabled, is_enabled); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, -1); HideMenus(); } if (ImGui::Selectable(TranslationManager::GetString(tstr_OverlayBarOvrlClone), false)) { //Copy data of overlay and add a new one based on it OverlayManager::Get().DuplicateOverlay(OverlayManager::Get().GetConfigData(overlay_id), overlay_id); IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_duplicate, (int)overlay_id); HideMenus(); } if (m_IsMenuRemoveConfirmationVisible) { if (ImGui::Selectable(TranslationManager::GetString(tstr_OverlayBarOvrlRemoveConfirm), false)) { OverlayManager::Get().RemoveOverlay(overlay_id); IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_remove, overlay_id); //Hide properties window if it's open for this overlay if (properties_window.GetActiveOverlayID() == overlay_id) { properties_window.SetActiveOverlayID(k_ulOverlayID_None, true); properties_window.HideAll(); } else if (properties_window.GetActiveOverlayID() > overlay_id) //Adjust properties window active overlay ID if it's open for an overlay that had its ID shifted { properties_window.SetActiveOverlayID(properties_window.GetActiveOverlayID() - 1, true); } HideMenus(); } } else { if (ImGui::Selectable(TranslationManager::GetString(tstr_OverlayBarOvrlRemove), false)) { m_IsMenuRemoveConfirmationVisible = true; } } if (ImGui::Selectable(TranslationManager::GetString(tstr_OverlayBarOvrlProperties), false)) { //Hide window instead if it's already open for this overlay if ((properties_window.IsVisible()) && (properties_window.GetActiveOverlayID() == overlay_id)) { properties_window.Hide(); } else { properties_window.SetActiveOverlayID(overlay_id); properties_window.Show(); } HideMenus(); } //Position window while clamping to overlay bar size ImVec2 window_size = ImGui::GetWindowSize(); pos.x = clamp(pos.x - (window_size.x / 2.0f), m_Pos.x, m_Pos.x + m_Size.x - window_size.x); pos.y -= window_size.y; ImGui::SetWindowPos(pos); if (ImGui::IsWindowAppearing()) { //We need valid window size for positioning (can't use ImGui::SetNextWindowPos() because of clamping), so reset things and repeat frame if don't have it yet UIManager::Get()->RepeatFrame(); m_MenuAlpha = 0.0f; } } ImGui::PopStyleVar(); ImGui::PopStyleVar(); ImGui::End(); } void WindowOverlayBar::MenuAddOverlayButton(ImVec2 pos, bool is_item_active) { m_MenuAlpha += ImGui::GetIO().DeltaTime * 12.0f; if (m_MenuAlpha > 1.0f) m_MenuAlpha = 1.0f; ImGui::PushStyleVar(ImGuiStyleVar_Alpha, m_MenuAlpha); ImGui::PushStyleVar(ImGuiStyleVar_WindowRounding, 0.0f); ImGui::SetNextWindowSizeConstraints({-1.0f, 0.0f}, {-1.0f, (ImGui::GetTextLineHeightWithSpacing() * 6.0f) + (ImGui::GetStyle().WindowPadding.y * 2.0f) }); if (ImGui::Begin("AddOverlayButtonMenu", nullptr, ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoSavedSettings | ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_NoFocusOnAppearing | ImGuiWindowFlags_NoBringToFrontOnFocus)) { if ( (!ImGui::IsWindowHovered(ImGuiHoveredFlags_AllowWhenBlockedByActiveItem)) && (ImGui::IsAnyMouseClicked()) && (!is_item_active) ) { HideMenus(); } int desktop_count = ConfigManager::GetValue(configid_int_state_interface_desktop_count); int new_overlay_desktop_id = -255; for (int i = 0; i < desktop_count; ++i) { ImGui::PushID(i); ImGui::Selectable(TranslationManager::Get().GetDesktopIDString(i)); if (ImGui::IsItemActivated()) { new_overlay_desktop_id = i; } ImGui::PopID(); } if ( (DPWinRT_IsCaptureSupported()) && (ImGui::Selectable(TranslationManager::GetString(tstr_OverlayBarOvrlAddWindow))) ) { //Get current pointer transform and set window transform from it if (UIManager::Get()->IsOpenVRLoaded()) { vr::TrackedDeviceIndex_t device_index = ConfigManager::Get().GetPrimaryLaserPointerDevice(); //If no dashboard device, try finding one if (device_index == vr::k_unTrackedDeviceIndexInvalid) { device_index = vr::IVROverlayEx::FindPointerDeviceForOverlay(UIManager::Get()->GetOverlayHandleOverlayBar()); } Matrix4 overlay_transform; vr::TrackingUniverseOrigin universe_origin = vr::TrackingUniverseStanding; vr::VROverlayIntersectionResults_t results; if (vr::IVROverlayEx::ComputeOverlayIntersectionForDevice(UIManager::Get()->GetOverlayHandleOverlayBar(), device_index, vr::TrackingUniverseStanding, &results)) { overlay_transform.setTranslation(results.vPoint); } else //Shouldn't happen, but have some fallback { vr::HmdMatrix34_t transform; vr::VROverlay()->GetOverlayTransformAbsolute(UIManager::Get()->GetOverlayHandleOverlayBar(), &universe_origin, &transform); overlay_transform = transform; } //Get devices poses vr::TrackedDevicePose_t poses[vr::k_unMaxTrackedDeviceCount]; vr::VRSystem()->GetDeviceToAbsoluteTrackingPose(universe_origin, vr::IVRSystemEx::GetTimeNowToPhotons(), poses, vr::k_unMaxTrackedDeviceCount); if (poses[vr::k_unTrackedDeviceIndex_Hmd].bPoseIsValid) { //Take the average between HMD and controller position (at controller's height) and rotate towards that Matrix4 mat_hmd(poses[vr::k_unTrackedDeviceIndex_Hmd].mDeviceToAbsoluteTracking); Vector3 pos = mat_hmd.getTranslation(); if ( (device_index < vr::k_unMaxTrackedDeviceCount) && (poses[device_index].bPoseIsValid) ) //If pointer doesn't have a pose, it falls back to rotating to HMD { Matrix4 mat_controller(poses[device_index].mDeviceToAbsoluteTracking); pos = mat_controller.getTranslation(); pos.x += mat_hmd.getTranslation().x; pos.x /= 2.0f; pos.z += mat_hmd.getTranslation().z; pos.z /= 2.0f; } vr::IVRSystemEx::TransformLookAt(overlay_transform, pos); } UIManager::Get()->GetAuxUI().GetCaptureWindowSelectWindow().SetTransform(overlay_transform); } UIManager::Get()->GetAuxUI().GetCaptureWindowSelectWindow().Show(); HideMenus(); } ImGui::Selectable(TranslationManager::GetString(tstr_SourcePerformanceMonitor)); if (ImGui::IsItemActivated()) { new_overlay_desktop_id = -3; } if (DPBrowserAPIClient::Get().IsBrowserAvailable()) { ImGui::Selectable(TranslationManager::GetString(tstr_SourceBrowser)); if (ImGui::IsItemActivated()) { new_overlay_desktop_id = -4; } } //Create new overlay if desktop or UI/Browser selectables were triggered if (new_overlay_desktop_id != -255) { vr::TrackedDeviceIndex_t device_index = ConfigManager::Get().GetPrimaryLaserPointerDevice(); //If no dashboard device, try finding one if (device_index == vr::k_unTrackedDeviceIndexInvalid) { device_index = vr::IVROverlayEx::FindPointerDeviceForOverlay(UIManager::Get()->GetOverlayHandleOverlayBar()); } float pointer_distance = 0.5f; if (UIManager::Get()->IsOpenVRLoaded()) { vr::VROverlayIntersectionResults_t results; if (vr::IVROverlayEx::ComputeOverlayIntersectionForDevice(UIManager::Get()->GetOverlayHandleOverlayBar(), device_index, vr::TrackingUniverseStanding, &results)) { pointer_distance = results.fDistance; } } //Set pointer hint in case dashboard app needs it ConfigManager::SetValue(configid_int_state_laser_pointer_device_hint, (int)device_index); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_laser_pointer_device_hint, (int)device_index); //Choose capture source OverlayCaptureSource capsource; switch (new_overlay_desktop_id) { case -3: capsource = ovrl_capsource_ui; break; case -4: capsource = ovrl_capsource_browser; break; default: capsource = ovrl_capsource_desktop_duplication; } //Add overlay and sent to dashboard app OverlayManager::Get().AddOverlay(capsource, new_overlay_desktop_id); IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_new_drag, MAKELPARAM(new_overlay_desktop_id, int(pointer_distance * 100.0f) )); HideMenus(); } //Position window while clamping to overlay bar size ImVec2 window_size = ImGui::GetWindowSize(); pos.x = clamp(pos.x - (window_size.x / 2.0f), m_Pos.x, m_Pos.x + m_Size.x - window_size.x); pos.y -= window_size.y; ImGui::SetWindowPos(pos); if (ImGui::IsWindowAppearing()) { //We need valid window size for positioning (can't use ImGui::SetNextWindowPos() because of clamping), so reset things and repeat frame if don't have it yet UIManager::Get()->RepeatFrame(); m_MenuAlpha = 0.0f; } } ImGui::PopStyleVar(); ImGui::PopStyleVar(); ImGui::End(); } void WindowOverlayBar::Show(bool skip_fade) { m_Visible = true; if (skip_fade) { m_Alpha = 1.0f; } } void WindowOverlayBar::Hide(bool skip_fade) { m_Visible = false; if (skip_fade) { m_Alpha = 0.0f; } } void WindowOverlayBar::HideMenus() { m_MenuAlpha = 0.0f; m_OverlayButtonActiveMenuID = k_ulOverlayID_None; m_IsAddOverlayButtonActive = false; m_IsMenuRemoveConfirmationVisible = false; UIManager::Get()->RepeatFrame(); //Reset sort order if the overlay already isn't hovered anymore if ( (UIManager::Get()->IsOpenVRLoaded()) && (!ConfigManager::Get().IsLaserPointerTargetOverlay(UIManager::Get()->GetOverlayHandleOverlayBar())) ) { vr::VROverlay()->SetOverlaySortOrder(UIManager::Get()->GetOverlayHandleOverlayBar(), 0); } } void WindowOverlayBar::Update() { if ( (m_Alpha != 0.0f) || (m_Visible) ) { const float alpha_step = ImGui::GetIO().DeltaTime * 6.0f; //Alpha fade animation m_Alpha += (m_Visible) ? alpha_step : -alpha_step; if (m_Alpha > 1.0f) m_Alpha = 1.0f; else if (m_Alpha < 0.0f) m_Alpha = 0.0f; } //We need to not skip on alpha 0.0 at least twice to get the real height of the bar. 32.0f is the placeholder width ImGui seems to use until then if ( (m_Alpha == 0.0f) && (m_Size.x != 32.0f) ) return; ImGui::PushStyleVar(ImGuiStyleVar_Alpha, m_Alpha); ImGuiIO& io = ImGui::GetIO(); const ImGuiStyle& style = ImGui::GetStyle(); ImVec2 b_size, b_uv_min, b_uv_max; TextureManager::Get().GetTextureInfo(tmtex_icon_settings, b_size, b_uv_min, b_uv_max); //Default button size for custom actions to be the same as the settings icon so the user is able to provide oversized images without messing up the layout //as well as still providing a way to change the size of text buttons by editing the settings icon's dimensions ImVec2 b_size_default = b_size; float tooltip_padding = ImGui::GetTextLineHeightWithSpacing() + (style.WindowPadding.y * 2.0f); float min_width = io.DisplaySize.x * 0.50f; ImGui::SetNextWindowSizeConstraints({min_width, -1.0f}, {io.DisplaySize.x * 0.95f, -1.0f}); ImGui::SetNextWindowPos(ImVec2(io.DisplaySize.x / 2.0f, io.DisplaySize.y - tooltip_padding), 0, ImVec2(0.5f, 1.0f)); //Center window at bottom of the overlay with space for tooltips ImGui::Begin("WindowOverlayBar", nullptr, ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoFocusOnAppearing | ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_HorizontalScrollbar); ImGui::HScrollWindowFromMouseWheelV(); //Scrollbar visible state can flicker for one frame when an overlay is added or removed while the bar is actually visible... no idea why, but work around it by repeating a frame bool scrollbar_visible = ImGui::IsAnyScrollBarVisible(); if (scrollbar_visible != m_IsScrollBarVisible) { UIManager::Get()->RepeatFrame(); m_IsScrollBarVisible = ImGui::IsAnyScrollBarVisible(); } ImGui::PushStyleVar(ImGuiStyleVar_FrameRounding, 4.0f); ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, {style.ItemSpacing.y, style.ItemSpacing.y}); ImGui::PushStyleColor(ImGuiCol_Button, ImVec4(0.0f, 0.0f, 0.0f, 0.0f)); UpdateOverlayButtons(); static float right_buttons_width = 0.0f; float free_width = min_width - ImGui::GetCursorPosX() - right_buttons_width; if (free_width > 0) { ImGui::Dummy({free_width, 0.0f}); ImGui::SameLine(0.0f, 0.0f); } //Add Overlay Button { if (!UIManager::Get()->IsOpenVRLoaded()) //Add Overlay stuff doesn't work without OpenVR loaded, so disable it ImGui::PushItemDisabled(); bool is_add_overlay_active = m_IsAddOverlayButtonActive; if (is_add_overlay_active) ImGui::PushStyleColor(ImGuiCol_Button, ImGui::GetStyleColorVec4(ImGuiCol_ButtonActive)); TextureManager::Get().GetTextureInfo(tmtex_icon_add, b_size, b_uv_min, b_uv_max); if (ImGui::ImageButton("Add Overlay", io.Fonts->TexID, b_size_default, b_uv_min, b_uv_max, ImVec4(0.0f, 0.0f, 0.0f, 0.0f))) { if (!m_IsAddOverlayButtonActive) { HideMenus(); m_IsAddOverlayButtonActive = true; } else { HideMenus(); } } if (is_add_overlay_active) ImGui::PopStyleColor(); //ImGuiCol_Button bool button_active = ImGui::IsItemActive(); ImVec2 pos = ImGui::GetItemRectMin(); float width = ImGui::GetItemRectSize().x; DisplayTooltipIfHovered(TranslationManager::GetString(tstr_OverlayBarTooltipOvrlAdd)); if (m_IsAddOverlayButtonActive) { float dist = width / 2.0f; float menu_y = m_Pos.y + style.WindowBorderSize + dist - (dist * m_MenuAlpha); MenuAddOverlayButton({pos.x + width / 2.0f, menu_y}, button_active); } if (!UIManager::Get()->IsOpenVRLoaded()) ImGui::PopItemDisabled(); } ImGui::SameLine(); //Action Buttons, if any if (!ConfigManager::Get().GetActionManager().GetActionOrderListOverlayBar().empty()) { UIManager::Get()->GetFloatingUI().GetActionBarWindow().UpdateActionButtons(k_ulOverlayID_None); } //Settings Button bool settings_shown = UIManager::Get()->GetSettingsWindow().IsVisible(); if (settings_shown) ImGui::PushStyleColor(ImGuiCol_Button, ImGui::GetStyleColorVec4(ImGuiCol_ButtonActive)); TextureManager::Get().GetTextureInfo(tmtex_icon_settings, b_size, b_uv_min, b_uv_max); if (ImGui::ImageButton("Settings", io.Fonts->TexID, b_size, b_uv_min, b_uv_max, ImVec4(0.0f, 0.0f, 0.0f, 0.0f))) { if (io.MouseDownDurationPrev[ImGuiMouseButton_Left] < 3.0f) //Don't do normal button behavior after reset was just triggered { FloatingWindow& floating_settings = UIManager::Get()->GetSettingsWindow(); (floating_settings.IsVisible()) ? floating_settings.Hide() : floating_settings.Show(); } } //Reset tranform when holding the button for 3 or more seconds bool show_hold_message = false; if (ImGui::IsItemActive()) { if (io.MouseDownDuration[ImGuiMouseButton_Left] > 3.0f) { FloatingWindow& floating_settings = UIManager::Get()->GetSettingsWindow(); floating_settings.SetPinned(false); floating_settings.ResetTransformAll(); io.MouseDown[ImGuiMouseButton_Left] = false; //Release mouse button so transform changes don't get blocked } else if (io.MouseDownDuration[ImGuiMouseButton_Left] > 0.5f) { show_hold_message = true; } } if (settings_shown) ImGui::PopStyleColor(); //ImGuiCol_Button //Warning/Error marker if (UIManager::Get()->IsAnyWarningDisplayed()) { ImVec2 p_max = {ImGui::GetItemRectMax().x - style.ItemInnerSpacing.x, ImGui::GetItemRectMin().y + style.ItemInnerSpacing.y}; ImVec2 p_min = p_max; p_min.x -= ImGui::CalcTextSize(k_pch_bold_exclamation_mark).x; p_max.y += ImGui::GetTextLineHeight(); ImGui::GetWindowDrawList()->AddRectFilled(p_min, p_max, ImGui::GetColorU32(Style_ImGuiCol_TextError), style.WindowRounding); ImGui::GetWindowDrawList()->AddText(p_min, ImGui::GetColorU32(ImGui::GetStyleColorVec4(ImGuiCol_Text)), k_pch_bold_exclamation_mark); } right_buttons_width = (ImGui::GetItemRectSize().x * 2.0f) + style.ItemSpacing.x; DisplayTooltipIfHovered( TranslationManager::GetString((show_hold_message) ? tstr_OverlayBarTooltipResetHold : tstr_OverlayBarTooltipSettings) ); ImGui::PopStyleColor(); //ImGuiCol_Button ImGui::PopStyleVar(); //ImGuiStyleVar_ItemSpacing ImGui::PopStyleVar(); //ImGuiStyleVar_FrameRounding m_Pos = ImGui::GetWindowPos(); m_Size = ImGui::GetWindowSize(); ImGui::End(); ImGui::PopStyleVar(); //ImGuiStyleVar_Alpha } const ImVec2 & WindowOverlayBar::GetPos() const { return m_Pos; } const ImVec2 & WindowOverlayBar::GetSize() const { return m_Size; } bool WindowOverlayBar::IsVisible() const { return m_Visible; } bool WindowOverlayBar::IsVisibleOrFading() const { return ( (m_Visible) || (m_Alpha != 0.0f) ); } bool WindowOverlayBar::IsAnyMenuVisible() const { return (m_MenuAlpha != 0.0f); } bool WindowOverlayBar::IsScrollBarVisible() const { return m_IsScrollBarVisible; } bool WindowOverlayBar::IsDraggingOverlayButtons() const { return m_IsDraggingOverlayButtons; } float WindowOverlayBar::GetAlpha() const { return m_Alpha; } ================================================ FILE: src/DesktopPlusUI/WindowOverlayBar.h ================================================ #pragma once #include "imgui.h" #include "OverlayManager.h" class WindowSettings; //The bar visible below the dashboard, containing overlay buttons and access to the settings window class WindowOverlayBar { private: ImVec2 m_Pos; ImVec2 m_Size; bool m_Visible; //This and m_Alpha default to visible state, meaning the dashboard UI, where it's always visible doesn't need to call Show() float m_Alpha; bool m_IsScrollBarVisible; unsigned int m_OverlayButtonActiveMenuID; bool m_IsAddOverlayButtonActive; float m_MenuAlpha; bool m_IsMenuRemoveConfirmationVisible; bool m_IsDraggingOverlayButtons; void DisplayTooltipIfHovered(const char* text, unsigned int overlay_id = k_ulOverlayID_None); void UpdateOverlayButtons(); void MenuOverlayButton(unsigned int overlay_id, ImVec2 pos, bool is_item_active); void MenuAddOverlayButton(ImVec2 pos, bool is_item_active); public: WindowOverlayBar(); void Show(bool skip_fade = false); void Hide(bool skip_fade = false); void HideMenus(); void Update(); const ImVec2& GetPos() const; const ImVec2& GetSize() const; bool IsVisible() const; bool IsVisibleOrFading() const; bool IsAnyMenuVisible() const; bool IsScrollBarVisible() const; bool IsDraggingOverlayButtons() const; float GetAlpha() const; }; ================================================ FILE: src/DesktopPlusUI/WindowOverlayProperties.cpp ================================================ #include "WindowOverlayProperties.h" #include "ImGuiExt.h" #include "UIManager.h" #include "TranslationManager.h" #include "InterprocessMessaging.h" #include "WindowManager.h" #include "Util.h" #include "OpenVRExt.h" #include "DesktopPlusWinRT.h" #include "DPBrowserAPIClient.h" #include WindowOverlayProperties::WindowOverlayProperties() : m_PageStackPos(0), m_PageStackPosAnimation(0), m_PageAnimationDir(0), m_PageAnimationProgress(0.0f), m_PageAnimationStartPos(0.0f), m_PageAnimationOffset(0.0f), m_PageFadeDir(0), m_PageFadeAlpha(1.0f), m_PageAppearing(wndovrlprop_page_none), m_PageReturned(wndovrlprop_page_none), m_ActiveOverlayID(k_ulOverlayID_None), m_Column0Width(0.0f), m_IsConfigDataModified(false), m_OriginHMDFloorSettingsAnimationProgress(0.0f), m_OriginHMDSettingsAnimationProgress(0.0f), m_OriginTheaterScreenSettingsAnimationProgress(0.0f), m_PerfMonStyleCheckboxAnimationProgress(0.0f), m_BufferOverlayName{0}, m_IsBrowserURLChanged(false) { m_WindowIcon = tmtex_icon_xsmall_settings; m_OvrlWidth = OVERLAY_WIDTH_METERS_SETTINGS; m_OvrlWidthMax = OVERLAY_WIDTH_METERS_SETTINGS * 3.0f; //Leave 2 pixel padding around so interpolation doesn't cut off the pixel border const DPRect& rect = UITextureSpaces::Get().GetRect(ui_texspace_overlay_properties); m_Size = {float(rect.GetWidth() - 4), float(rect.GetHeight() - 4)}; m_SizeUnscaled = m_Size; m_Pos = {float(rect.GetTL().x + 2), float(rect.GetTL().y + 2)}; m_PageStack.push_back(wndovrlprop_page_main); FloatingWindow::ResetTransformAll(); } void WindowOverlayProperties::Show(bool skip_fade) { UIManager::Get()->UpdateDesktopOverlayPixelSize(); SetActiveOverlayID(m_ActiveOverlayID, true); //ensure that current overlay ID is still in sync with dashboard app (can desync if dashboard app was restarted) FloatingWindow::Show(skip_fade); } void WindowOverlayProperties::Hide(bool skip_fade) { FloatingWindow::Hide(skip_fade); //When hiding while the position change page is open, sync transform if (m_PageStack.back() == wndovrlprop_page_position_change) { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_transform_sync, (int)m_ActiveOverlayID); } } void WindowOverlayProperties::ResetTransform(FloatingWindowOverlayStateID state_id) { FloatingWindow::ResetTransform(state_id); FloatingWindowOverlayState& overlay_state = GetOverlayState(state_id); overlay_state.Transform.rotateY(15.0f); overlay_state.Transform.translate_relative(-OVERLAY_WIDTH_METERS_DASHBOARD_UI / 3.0f, 0.70f, 0.15f); } vr::VROverlayHandle_t WindowOverlayProperties::GetOverlayHandle() const { return UIManager::Get()->GetOverlayHandleOverlayProperties(); } void WindowOverlayProperties::ApplyUIScale() { FloatingWindow::ApplyUIScale(); m_CachedSizes = {}; } unsigned int WindowOverlayProperties::GetActiveOverlayID() const { return m_ActiveOverlayID; } void WindowOverlayProperties::SetActiveOverlayID(unsigned int overlay_id, bool skip_fade) { //This needs to cancel any active page state for the previous overlay if it's not the same if ( (!skip_fade) && (m_ActiveOverlayID != overlay_id) && (m_ActiveOverlayID != k_ulOverlayID_None) ) { //Animate overlay switching by fading out first if the window is visible if (m_PageFadeDir == 0) { PageFadeStart(overlay_id); return; } PageGoHome(true); } //These need to always reset in case of underlying changes or even just language switching m_CropButtonLabel = ""; m_WinRTSourceButtonLabel = ""; m_ActionButtonsLabel = ""; m_BrowserMaxFPSValueText = ""; MarkBrowserURLChanged(); m_CachedSizes = {}; m_ActiveOverlayID = overlay_id; OverlayManager::Get().SetCurrentOverlayID(overlay_id); //k_ulOverlayID_None is used when fading out an overlay that got deleted, so keep old info around while fading out if (overlay_id != k_ulOverlayID_None) { OverlayConfigData& data = OverlayManager::Get().GetCurrentConfigData(); m_WindowTitle = data.ConfigNameStr; //Update overlay name buffer if (data.ConfigBool[configid_bool_overlay_name_custom]) { size_t copied_length = m_WindowTitle.copy(m_BufferOverlayName, IM_ARRAYSIZE(m_BufferOverlayName) - 1); m_BufferOverlayName[copied_length] = '\0'; } else { m_BufferOverlayName[0] = '\0'; } //Update tags buffer size_t copied_length = data.ConfigStr[configid_str_overlay_tags].copy(m_BufferOverlayTags, IM_ARRAYSIZE(m_BufferOverlayTags) - 1); m_BufferOverlayTags[copied_length] = '\0'; bool has_win32_window_icon = false; m_WindowIcon = TextureManager::Get().GetOverlayIconTextureID(data, true, &has_win32_window_icon); if (has_win32_window_icon) { m_WindowIconWin32IconCacheID = TextureManager::Get().GetWindowIconCacheID((HWND)data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd], data.ConfigHandle[configid_handle_overlay_state_winrt_last_hicon]); } else { m_WindowIconWin32IconCacheID = -1; } m_OriginHMDFloorSettingsAnimationProgress = (data.ConfigInt[configid_int_overlay_origin] == ovrl_origin_hmd_floor) ? 1.0f : 0.0f; m_OriginHMDSettingsAnimationProgress = (data.ConfigInt[configid_int_overlay_origin] == ovrl_origin_hmd) ? 1.0f : 0.0f; m_OriginTheaterScreenSettingsAnimationProgress = (data.ConfigInt[configid_int_overlay_origin] == ovrl_origin_theater_screen) ? 1.0f : 0.0f; m_PerfMonStyleCheckboxAnimationProgress = (ConfigManager::GetValue(configid_bool_performance_monitor_minimal_style)) ? 1.0f : 0.0f; } IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_interface_overlay_current_id, (int)overlay_id); if (IsVisibleOrFading()) { UIManager::Get()->GetIdleState().AddActiveTime(); } } void WindowOverlayProperties::UpdateDesktopMode() { WindowUpdate(); } const char* WindowOverlayProperties::DesktopModeGetTitle() const { return m_WindowTitle.c_str(); } bool WindowOverlayProperties::DesktopModeGetIconTextureInfo(ImVec2& size, ImVec2& uv_min, ImVec2& uv_max) const { if (m_WindowIconWin32IconCacheID == -1) { return TextureManager::Get().GetTextureInfo(m_WindowIcon, size, uv_min, uv_max); } else { return TextureManager::Get().GetWindowIconTextureInfo(m_WindowIconWin32IconCacheID, size, uv_min, uv_max); } } float WindowOverlayProperties::DesktopModeGetTitleIconAlpha() const { return m_TitleBarTitleIconAlpha; } void WindowOverlayProperties::DesktopModeOnTitleIconClick() { //Toggle visibility on title icon double-click const int click_count = ImGui::GetMouseClickedCount(ImGuiMouseButton_Left); if ((click_count > 1) && (click_count % 2 == 0)) //ImGui keeps counting up so fast double-clicks in a row don't get detected as such with ImGui::IsMouseDoubleClicked() { bool& is_enabled = ConfigManager::GetRef(configid_bool_overlay_enabled); is_enabled = !is_enabled; IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_overlay_enabled, is_enabled); } } void WindowOverlayProperties::DesktopModeOnTitleBarHover(bool is_hovered) { m_IsTitleBarHovered = is_hovered; } bool WindowOverlayProperties::DesktopModeGoBack() { if (m_PageStackPos != 0) { PageGoBack(); return true; } return false; } void WindowOverlayProperties::MarkBrowserURLChanged() { m_IsBrowserURLChanged = true; } void WindowOverlayProperties::WindowUpdate() { ImGui::SetWindowSize(m_Size); //Keep window blank if no overlay is set (like when fading out from removing an overlay) if (m_ActiveOverlayID == k_ulOverlayID_None) return; //Highlight overlay if title bar is hovered static bool has_highlighted_overlay = false; if (m_IsTitleBarHovered) { UIManager::Get()->HighlightOverlay(m_ActiveOverlayID); has_highlighted_overlay = true; } //Don't remove highlight during drag (hover state is false) or mouse released state (causes one frame flicker after drag) else if ( (has_highlighted_overlay) && (!UIManager::Get()->GetOverlayDragger().IsDragActive()) && (!ImGui::IsMouseReleased(ImGuiMouseButton_Left)) ) { UIManager::Get()->HighlightOverlay(k_ulOverlayID_None); has_highlighted_overlay = false; } //Set title icon/text alpha based on overlay visibility m_TitleBarTitleIconAlpha = (ConfigManager::GetValue(configid_bool_overlay_enabled)) ? 1.0f : 0.5f; //Check for double clicks if the icon is being clicked if (m_IsTitleIconClicked) { DesktopModeOnTitleIconClick(); //Desktop mode function, but no reason to do anything differently in VR so we always use it } ImGuiStyle& style = ImGui::GetStyle(); m_Column0Width = ImGui::GetFontSize() * 12.75f; float page_width = m_Size.x - style.WindowBorderSize - style.WindowPadding.x - style.WindowPadding.x; //Compensate for the padding added in constructor and ignore border in desktop mode if (UIManager::Get()->IsInDesktopMode()) { page_width += 2 + style.WindowBorderSize; } //Page animation if (m_PageAnimationDir != 0) { //Use the averaged framerate value instead of delta time for the first animation step //This is to smooth over increased frame deltas that can happen when a new page needs to do initial larger computations or save/load files const float progress_step = (m_PageAnimationProgress == 0.0f) ? (1.0f / ImGui::GetIO().Framerate) * 3.0f : ImGui::GetIO().DeltaTime * 3.0f; m_PageAnimationProgress += progress_step; if (m_PageAnimationProgress >= 1.0f) { //Remove pages in the stack after finishing going back if (m_PageAnimationDir == 1) { while ((int)m_PageStack.size() > m_PageStackPosAnimation + 1) { m_PageStack.pop_back(); } m_PageAnimationDir = 0; //Add pending pages now that we don't have an active animation while (!m_PageStackPending.empty()) { PageGoForward(m_PageStackPending[0]); m_PageStackPending.erase(m_PageStackPending.begin()); } } m_PageAnimationProgress = 1.0f; m_PageAnimationDir = 0; } } else if (m_PageStackPosAnimation != m_PageStackPos) //Only start new animation if none is running { m_PageAnimationDir = (m_PageStackPosAnimation < m_PageStackPos) ? -1 : 1; m_PageStackPosAnimation = m_PageStackPos; m_PageAnimationStartPos = m_PageAnimationOffset; m_PageAnimationProgress = 0.0f; //Set appearing value to top of stack when starting animation to it if (m_PageAnimationDir == -1) { m_PageAppearing = m_PageStack.back(); } } else if ((m_PageStackPosAnimation == m_PageStackPos) && ((int)m_PageStack.size() > m_PageStackPos + 1)) { //Remove pages that were added and left again while there was no chance to animate anything while ((int)m_PageStack.size() > m_PageStackPos + 1) { m_PageStack.pop_back(); } } //Set appearing value when the whole window appeared again if ((m_PageAnimationDir == 0) && (ImGui::IsWindowAppearing())) { m_PageAppearing = m_PageStack.back(); } const float target_x = (page_width + style.ItemSpacing.x) * -m_PageStackPosAnimation; m_PageAnimationOffset = smoothstep(m_PageAnimationProgress, m_PageAnimationStartPos, target_x); //Page Fade ImGui::PushStyleVar(ImGuiStyleVar_Alpha, (UIManager::Get()->IsInDesktopMode()) ? m_PageFadeAlpha : m_Alpha * m_PageFadeAlpha); if (m_PageFadeDir == -1) { m_PageFadeAlpha -= ImGui::GetIO().DeltaTime * 6.0f; if (m_PageFadeAlpha <= 0.0f) //Completed fade-out { //Switch active overlay and fade back in m_PageFadeAlpha = 0.0f; m_PageFadeDir = 1; SetActiveOverlayID(m_PageFadeTargetOverlayID); //Calls PageGoHome() among other things } } else if (m_PageFadeDir == 1) { m_PageFadeAlpha += ImGui::GetIO().DeltaTime * 6.0f; if (m_PageFadeAlpha >= 1.0f) //Completed fading back in { m_PageFadeAlpha = 1.0f; m_PageFadeDir = 0; } } //Set up page offset and clipping ImGui::SetCursorPosX(ImGui::GetCursorPosX() + m_PageAnimationOffset); ImGui::PushClipRect({m_Pos.x + style.WindowBorderSize, 0.0f}, {m_Pos.x + m_Size.x - style.WindowBorderSize, FLT_MAX}, false); const char* const child_str_id[]{"OvrlPropsPageMain", "OvrlPropsPage1", "OvrlPropsPage2", "OvrlPropsPage3"}; //No point in generating these on the fly const ImVec2 child_size = {page_width, ImGui::GetContentRegionAvail().y}; int child_id = 0; int stack_size = (int)m_PageStack.size(); for (WindowOverlayPropertiesPage page_id : m_PageStack) { if (child_id >= IM_ARRAYSIZE(child_str_id)) break; //Disable items when the page isn't active const bool is_inactive_page = (child_id != m_PageStackPos); if (is_inactive_page) { ImGui::PushItemDisabledNoVisual(); } ImGui::PushStyleColor(ImGuiCol_ChildBg, ImVec4(0.00f, 0.00f, 0.00f, 0.00f)); //This prevents child bg color being visible if there's a widget before this if ((ImGui::BeginChild(child_str_id[child_id], child_size, ImGuiChildFlags_NavFlattened)) || (m_PageAppearing == page_id)) //Process page if currently appearing { ImGui::PopStyleColor(); //ImGuiCol_ChildBg switch (page_id) { case wndovrlprop_page_main: UpdatePageMain(); break; case wndovrlprop_page_position_change: UpdatePagePositionChange(); break; case wndovrlprop_page_crop_change: UpdatePageCropChange(); break; case wndovrlprop_page_graphics_capture_source: UpdatePageGraphicsCaptureSource(); break; case wndovrlprop_page_actions_order: UpdatePageActionsOrder(); break; case wndovrlprop_page_actions_order_add: UpdatePageActionsOrderAdd(); break; default: break; } } else { ImGui::PopStyleColor(); //ImGuiCol_ChildBg } if (is_inactive_page) { ImGui::PopItemDisabledNoVisual(); } ImGui::EndChild(); if (child_id + 1 < stack_size) { ImGui::SameLine(); } child_id++; } m_PageAppearing = wndovrlprop_page_none; ImGui::PopClipRect(); ImGui::PopStyleVar(); //ImGuiStyleVar_Alpha } void WindowOverlayProperties::OverlayPositionReset() { float& up = ConfigManager::GetRef(configid_float_overlay_offset_up); float& right = ConfigManager::GetRef(configid_float_overlay_offset_right); float& forward = ConfigManager::GetRef(configid_float_overlay_offset_forward); up = right = forward = 0.0f; IPCManager::Get().PostConfigMessageToDashboardApp(configid_float_overlay_offset_up, up); IPCManager::Get().PostConfigMessageToDashboardApp(configid_float_overlay_offset_right, right); IPCManager::Get().PostConfigMessageToDashboardApp(configid_float_overlay_offset_forward, forward); IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_position_reset); } void WindowOverlayProperties::UpdatePageMain() { ImGui::PushStyleColor(ImGuiCol_ChildBg, ImVec4(0.00f, 0.00f, 0.00f, 0.00f)); ImGui::BeginChild("OvrlPropsMainContent", ImVec2(0.00f, 0.00f), ImGuiChildFlags_NavFlattened); ImGui::PopStyleColor(); UpdatePageMainCatPosition(); UpdatePageMainCatAppearance(); UpdatePageMainCatCapture(); UpdatePageMainCatPerformanceMonitor(); UpdatePageMainCatBrowser(); UpdatePageMainCatAdvanced(); UpdatePageMainCatPerformance(); UpdatePageMainCatInterface(); ImGui::EndChild(); } void WindowOverlayProperties::UpdatePageMainCatPosition() { ImGuiStyle& style = ImGui::GetStyle(); ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_OvrlPropsCatPosition)); ImGui::Columns(2, "ColumnPosition", false); ImGui::SetColumnWidth(0, m_Column0Width); //Origin int& mode_origin = ConfigManager::GetRef(configid_int_overlay_origin); bool& is_enabled = ConfigManager::GetRef(configid_bool_overlay_enabled); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsPositionOrigin)); if (mode_origin == ovrl_origin_theater_screen) { ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_OvrlPropsPositionOriginTheaterScreenTip)); } ImGui::NextColumn(); const ImVec2 img_size_line_height = {ImGui::GetTextLineHeight(), ImGui::GetTextLineHeight()}; ImVec2 img_size, img_uv_min, img_uv_max; const ImVec2 combo_pos = ImGui::GetCursorScreenPos(); ImGui::PushItemWidth(-1.0f); if (ImGui::BeginComboAnimated("##ComboPositionOrigin", "")) { static bool is_generic_tracker_connected = false; if ((ImGui::IsWindowAppearing()) && (UIManager::Get()->IsOpenVRLoaded())) { is_generic_tracker_connected = (vr::IVRSystemEx::GetFirstVRTracker() != vr::k_unTrackedDeviceIndexInvalid); } //Make use of the fact origin, icon and translation string IDs are laid out sequentially and shorten this to a nice loop for (int i = ovrl_origin_room; i < ovrl_origin_dplus_tab; ++i) { //Skip over some entries if they're not available if ((i == ovrl_origin_aux) && (!is_generic_tracker_connected)) continue; ImGui::PushID(i); if ((ImGui::Selectable("", (mode_origin == i))) && (mode_origin != i)) { mode_origin = i; //If overlay is switched to theater screen origin, disable the overlay so it doesn't enter theater mode right away and has the properties window disappear if (mode_origin == ovrl_origin_theater_screen) { if (is_enabled) { is_enabled = false; IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_overlay_enabled, false); } //Also disable Gaze Fade if it's on ConfigManager::SetValue(configid_bool_overlay_gazefade_enabled, false); IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_overlay_gazefade_enabled, false); //...and reset display mode to Always. It technically works in that the overlay stops updating but that's not helpful if the theater screen is showing ConfigManager::SetValue(configid_int_overlay_display_mode, ovrl_dispmode_always); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_display_mode, ovrl_dispmode_always); } IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_origin, mode_origin); } ImGui::SameLine(0.0f, 0.0f); TextureManager::Get().GetTextureInfo((TMNGRTexID)(tmtex_icon_xsmall_origin_room + i), img_size, img_uv_min, img_uv_max); ImGui::Image(ImGui::GetIO().Fonts->TexID, img_size_line_height, img_uv_min, img_uv_max); ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); ImGui::TextUnformatted(TranslationManager::GetString( (TRMGRStrID)(tstr_OvrlPropsPositionOriginRoom + i) )); ImGui::PopID(); } ImGui::EndCombo(); } //Custom combo preview content (icon with text) const ImVec2 backup_pos = ImGui::GetCursorScreenPos(); ImVec2 clip_end = ImGui::GetItemRectMax(); clip_end.x -= ImGui::GetFrameHeight(); ImGui::SetCursorScreenPos(ImVec2(combo_pos.x + style.FramePadding.x, combo_pos.y + style.FramePadding.y)); TextureManager::Get().GetTextureInfo((TMNGRTexID)(tmtex_icon_xsmall_origin_room + mode_origin), img_size, img_uv_min, img_uv_max); ImGui::Image(ImGui::GetIO().Fonts->TexID, img_size_line_height, img_uv_min, img_uv_max); ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); ImGui::SetCursorPosY(ImGui::GetCursorPosY()); ImGui::PushClipRect(ImGui::GetCursorScreenPos(), clip_end, true); ImGui::TextUnformatted(TranslationManager::GetString( (TRMGRStrID)(tstr_OvrlPropsPositionOriginRoom + mode_origin) )); ImGui::PopClipRect(); ImGui::SetCursorScreenPos(backup_pos); ImGui::Columns(1); //Origin-specific settings //-Origin HMD Floor ImGui::BeginCollapsingArea("OriginHMDFloorSettings", (mode_origin == ovrl_origin_hmd_floor), m_OriginHMDFloorSettingsAnimationProgress); ImGui::Columns(2, "ColumnOriginHMDFloorSettings", false); ImGui::SetColumnWidth(0, m_Column0Width); ImGui::NextColumn(); bool& use_turning = ConfigManager::GetRef(configid_bool_overlay_origin_hmd_floor_use_turning); ImGui::AlignTextToFramePadding(); if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsPositionOriginConfigHMDXYTurning), &use_turning)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_overlay_origin_hmd_floor_use_turning, use_turning); } ImGui::NextColumn(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsPositionOriginConfigSmoothing)); ImGui::NextColumn(); int& origin_smoothing_level = ConfigManager::Get().GetRef(configid_int_overlay_origin_smoothing_level); const int origin_smoothing_level_max = tstr_SettingsMouseSmoothingLevelVeryHigh - tstr_SettingsMouseSmoothingLevelNone; origin_smoothing_level = clamp(origin_smoothing_level, 0, origin_smoothing_level_max); if (ImGui::SliderWithButtonsInt("SmoothingLevelHMDFloor", origin_smoothing_level, 1, 1, 0, origin_smoothing_level_max, "##%d", ImGuiSliderFlags_NoInput, nullptr, TranslationManager::GetString( (TRMGRStrID)(tstr_SettingsMouseSmoothingLevelNone + origin_smoothing_level) ))) { origin_smoothing_level = clamp(origin_smoothing_level, 0, origin_smoothing_level_max); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_origin_smoothing_level, origin_smoothing_level); } ImGui::Columns(1); ImGui::Spacing(); ImGui::EndCollapsingArea(); //-Origin HMD ImGui::BeginCollapsingArea("OriginHMDSettings", (mode_origin == ovrl_origin_hmd), m_OriginHMDSettingsAnimationProgress); ImGui::Columns(2, "ColumnOriginHMDSettings", false); ImGui::SetColumnWidth(0, m_Column0Width); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsPositionOriginConfigSmoothing)); ImGui::NextColumn(); if (ImGui::SliderWithButtonsInt("SmoothingLevelHMD", origin_smoothing_level, 1, 1, 0, origin_smoothing_level_max, "##%d", ImGuiSliderFlags_NoInput, nullptr, TranslationManager::GetString( (TRMGRStrID)(tstr_SettingsMouseSmoothingLevelNone + origin_smoothing_level) ))) { origin_smoothing_level = clamp(origin_smoothing_level, 0, origin_smoothing_level_max); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_origin_smoothing_level, origin_smoothing_level); } ImGui::Columns(1); ImGui::Spacing(); ImGui::EndCollapsingArea(); //-Origin Theater Screen ImGui::Columns(2, "ColumnPosition2", false); ImGui::SetColumnWidth(0, m_Column0Width); ImGui::NextColumn(); if (UIManager::Get()->IsOpenVRLoaded()) { ImGui::BeginCollapsingArea("OriginTheaterScreenSettings", (mode_origin == ovrl_origin_theater_screen), m_OriginTheaterScreenSettingsAnimationProgress); if (ImGui::Button(TranslationManager::GetString( (is_enabled) ? tstr_OvrlPropsPositionOriginConfigTheaterScreenLeave : tstr_OvrlPropsPositionOriginConfigTheaterScreenEnter ))) { //Entering and leaving theater mode is nothing special but rather just a side effect of enabling the overlay. This is only for better UX is_enabled = !is_enabled; IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_overlay_enabled, is_enabled); } ImGui::Spacing(); ImGui::EndCollapsingArea(); } ImGui::NextColumn(); if (mode_origin == ovrl_origin_theater_screen) { ImGui::PushItemDisabled(); } //Display Mode ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsPositionDispMode)); ImGui::NextColumn(); int& mode_display = ConfigManager::GetRef(configid_int_overlay_display_mode); ImGui::PushItemWidth(-1.0f); if (TranslatedComboAnimated("##ComboPositionDisplayMode", mode_display, tstr_OvrlPropsPositionDispModeAlways, tstr_OvrlPropsPositionDispModeDPlus)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_display_mode, mode_display); } ImGui::NextColumn(); //Position Change ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsPositionPos)); if (!UIManager::Get()->IsOpenVRLoaded()) //Show tip if position can't be changed due to desktop mode { ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_OvrlPropsPositionPosTip)); } ImGui::NextColumn(); if (!UIManager::Get()->IsOpenVRLoaded()) ImGui::PushItemDisabled(); if (ImGui::Button(TranslationManager::GetString(tstr_OvrlPropsPositionChange))) { PageGoForward(wndovrlprop_page_position_change); } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); if (ImGui::Button(TranslationManager::GetString(tstr_OvrlPropsPositionReset))) { OverlayPositionReset(); } if (!UIManager::Get()->IsOpenVRLoaded()) ImGui::PopItemDisabled(); ImGui::SameLine(); bool& transform_locked = ConfigManager::GetRef(configid_bool_overlay_transform_locked); if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsPositionLock), &transform_locked)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_overlay_transform_locked, transform_locked); } if (mode_origin == ovrl_origin_theater_screen) ImGui::PopItemDisabled(); ImGui::Columns(1); } void WindowOverlayProperties::UpdatePageMainCatAppearance() { ImGuiStyle& style = ImGui::GetStyle(); VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); const int& mode_origin = ConfigManager::GetRef(configid_int_overlay_origin); ImGui::Spacing(); ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_OvrlPropsCatAppearance)); ImGui::Columns(2, "ColumnAppearance", false); ImGui::SetColumnWidth(0, m_Column0Width); //Width if (mode_origin == ovrl_origin_theater_screen) ImGui::PushItemDisabled(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsAppearanceWidth)); ImGui::NextColumn(); float& width = ConfigManager::GetRef(configid_float_overlay_width); const float width_slider_max = (mode_origin >= ovrl_origin_right_hand) ? 1.5f : 5.0f; vr_keyboard.VRKeyboardInputBegin( ImGui::SliderWithButtonsGetSliderID("OverlayWidth") ); if (ImGui::SliderWithButtonsFloat("OverlayWidth", width, 0.1f, 0.01f, 0.05f, width_slider_max, "%.2f m", ImGuiSliderFlags_Logarithmic)) { if (width < 0.05f) width = 0.05f; IPCManager::Get().PostConfigMessageToDashboardApp(configid_float_overlay_width, width); } vr_keyboard.VRKeyboardInputEnd(); ImGui::NextColumn(); //Curvature ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsAppearanceCurve)); ImGui::NextColumn(); float& curve = ConfigManager::GetRef(configid_float_overlay_curvature); vr_keyboard.VRKeyboardInputBegin( ImGui::SliderWithButtonsGetSliderID("OverlayCurvature") ); if (ImGui::SliderWithButtonsFloatPercentage("OverlayCurvature", curve, 5, 1, 0, 35, "%d%%")) { curve = clamp(curve, 0.0f, 1.0f); IPCManager::Get().PostConfigMessageToDashboardApp(configid_float_overlay_curvature, curve); } vr_keyboard.VRKeyboardInputEnd(); ImGui::NextColumn(); if (mode_origin == ovrl_origin_theater_screen) ImGui::PopItemDisabled(); //Opacity ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsAppearanceOpacity)); ImGui::NextColumn(); float& opacity = ConfigManager::GetRef(configid_float_overlay_opacity); vr_keyboard.VRKeyboardInputBegin( ImGui::SliderWithButtonsGetSliderID("OverlayOpacity") ); if (ImGui::SliderWithButtonsFloatPercentage("OverlayOpacity", opacity, 5, 1, 0, 100, "%d%%")) { opacity = clamp(opacity, 0.0f, 1.0f); IPCManager::Get().PostConfigMessageToDashboardApp(configid_float_overlay_opacity, opacity); } vr_keyboard.VRKeyboardInputEnd(); ImGui::NextColumn(); //Brightness ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsAppearanceBrightness)); ImGui::NextColumn(); float& brightness = ConfigManager::GetRef(configid_float_overlay_brightness); vr_keyboard.VRKeyboardInputBegin( ImGui::SliderWithButtonsGetSliderID("OverlayBrightness") ); if (ImGui::SliderWithButtonsFloatPercentage("OverlayBrightness", brightness, 5, 1, 0, 100, "%d%%")) { brightness = clamp(brightness, 0.0f, (ConfigManager::GetValue(configid_bool_performance_hdr_mirroring)) ? 10.0f : 1.0f); IPCManager::Get().PostConfigMessageToDashboardApp(configid_float_overlay_brightness, brightness); } vr_keyboard.VRKeyboardInputEnd(); ImGui::NextColumn(); //Crop if (ConfigManager::GetValue(configid_int_overlay_capture_source) != ovrl_capsource_ui) //Don't show crop settings for UI source overlays { bool& crop_enabled = ConfigManager::GetRef(configid_bool_overlay_crop_enabled); ImGui::Spacing(); if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsAppearanceCrop), &crop_enabled)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_overlay_crop_enabled, crop_enabled); } ImGui::NextColumn(); ImGui::Spacing(); //Build button string if empty if (m_CropButtonLabel.empty()) { int crop_width = ConfigManager::GetValue(configid_int_overlay_crop_width); int crop_height = ConfigManager::GetValue(configid_int_overlay_crop_height); std::stringstream ss; ss << ConfigManager::GetValue(configid_int_overlay_crop_x) << ", " << ConfigManager::GetValue(configid_int_overlay_crop_y) << " | "; (crop_width == -1) ? ss << TranslationManager::GetString(tstr_OvrlPropsAppearanceCropValueMax) << " " : ss << crop_width; ss << "x"; (crop_height == -1) ? ss << " " << TranslationManager::GetString(tstr_OvrlPropsAppearanceCropValueMax) : ss << crop_height; m_CropButtonLabel = ss.str(); } if (ImGui::Button(m_CropButtonLabel.c_str())) { PageGoForward(wndovrlprop_page_crop_change); } ImGui::NextColumn(); } else { ImGui::Spacing(); } //Show Backside bool& show_backside = ConfigManager::GetRef(configid_bool_overlay_show_backside); if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsAppearanceShowBackside), &show_backside)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_overlay_show_backside, show_backside); } ImGui::NextColumn(); ImGui::Columns(1); } void WindowOverlayProperties::UpdatePageMainCatCapture() { //All capture settings are considered advanced if (!ConfigManager::GetValue(configid_bool_interface_show_advanced_settings)) return; ImGuiStyle& style = ImGui::GetStyle(); VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); int& capture_method = ConfigManager::GetRef(configid_int_overlay_capture_source); //Don't show capture settings for UI or Browser source overlays if ( (capture_method == ovrl_capsource_ui) || (capture_method == ovrl_capsource_browser) ) return; int& winrt_selected_desktop = ConfigManager::GetRef(configid_int_overlay_winrt_desktop_id); HWND winrt_selected_window = (HWND)ConfigManager::GetValue(configid_handle_overlay_state_winrt_hwnd); ImGui::Spacing(); ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_OvrlPropsCatCapture)); //Show some warning when an unknown capture source is used and don't go further if (capture_method > ovrl_capsource_browser) { ImGui::Indent(); ImGui::PushTextWrapPos(); ImGui::TextColoredUnformatted(Style_ImGuiCol_TextWarning, TranslationManager::GetString(tstr_OvrlPropsCaptureSourceUnknownWarning)); ImGui::PopTextWrapPos(); ImGui::Unindent(); return; } ImGui::Columns(2, "ColumnCapture", false); ImGui::SetColumnWidth(0, m_Column0Width); //Capture Method ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsCaptureMethod)); if (!DPWinRT_IsCaptureSupported()) { ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_OvrlPropsCaptureMethodGCUnsupportedTip), "(!)"); } else if (!DPWinRT_IsCaptureFromCombinedDesktopSupported()) { ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_OvrlPropsCaptureMethodGCUnsupportedPartialTip), "(!)"); } ImGui::NextColumn(); if (ImGui::RadioButton(TranslationManager::GetString(tstr_OvrlPropsCaptureMethodDup), (capture_method == ovrl_capsource_desktop_duplication))) { capture_method = ovrl_capsource_desktop_duplication; IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_capture_source, capture_method); OverlayManager::Get().SetCurrentOverlayNameAuto(); SetActiveOverlayID(m_ActiveOverlayID); UIManager::Get()->RepeatFrame(); } ImGui::SameLine(0.0f, style.ItemSpacing.x / 2.0f); //Getting tight there, use less spacing if (!DPWinRT_IsCaptureSupported()) ImGui::PushItemDisabled(); if (ImGui::RadioButton(TranslationManager::GetString(tstr_OvrlPropsCaptureMethodGC), (capture_method == ovrl_capsource_winrt_capture))) { capture_method = ovrl_capsource_winrt_capture; IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_capture_source, capture_method); OverlayManager::Get().SetCurrentOverlayNameAuto(); SetActiveOverlayID(m_ActiveOverlayID); UIManager::Get()->RepeatFrame(); } if (!DPWinRT_IsCaptureSupported()) ImGui::PopItemDisabled(); ImGui::NextColumn(); //Source ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsCaptureSource)); ImGui::NextColumn(); if (capture_method == ovrl_capsource_desktop_duplication) { int desktop_count = ConfigManager::GetValue(configid_int_state_interface_desktop_count); int& selected_desktop = ConfigManager::GetRef(configid_int_overlay_desktop_id); ImGui::PushItemWidth(-1.0f); if (ImGui::BeginComboAnimated("##ComboDesktopSource", TranslationManager::Get().GetDesktopIDString(selected_desktop) )) { for (int i = -1; i < desktop_count; ++i) { ImGui::PushID(i); if (ImGui::Selectable(TranslationManager::Get().GetDesktopIDString(i), (selected_desktop == i))) { selected_desktop = i; IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_desktop_id, selected_desktop); OverlayManager::Get().SetCurrentOverlayNameAuto(); SetActiveOverlayID(m_ActiveOverlayID); } ImGui::PopID(); } ImGui::EndCombo(); } ImGui::NextColumn(); } else if (capture_method == ovrl_capsource_winrt_capture) { if ( (m_WinRTSourceButtonLabel.empty()) || (m_CachedSizes.MainCatCapture_WinRTSourceLabelWidth == 0.0f) ) { m_WinRTSourceButtonLabel = GetStringForWinRTSource(winrt_selected_window, winrt_selected_desktop); m_CachedSizes.MainCatCapture_WinRTSourceLabelWidth = ImGui::CalcTextSize(m_WinRTSourceButtonLabel.c_str()).x; } ImVec2 button_size(0.0f, 0.0f); if (m_CachedSizes.MainCatCapture_WinRTSourceLabelWidth > ImGui::GetContentRegionAvail().x - style.FramePadding.x * 2.0f) { button_size.x = ImGui::GetContentRegionAvail().x; } if (ImGui::Button(m_WinRTSourceButtonLabel.c_str(), button_size)) { PageGoForward(wndovrlprop_page_graphics_capture_source); } bool& strict_matching = ConfigManager::GetRef(configid_bool_overlay_winrt_window_matching_strict); if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsCaptureGCStrictMatching), &strict_matching)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_overlay_winrt_window_matching_strict, strict_matching); } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_OvrlPropsCaptureGCStrictMatchingTip)); } ImGui::Columns(1); } void WindowOverlayProperties::UpdatePageMainCatPerformanceMonitor() { //Don't show performance monitor settings for non-UI source overlays if (ConfigManager::GetValue(configid_int_overlay_capture_source) != ovrl_capsource_ui) return; ImGui::Spacing(); ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_OvrlPropsCatPerformanceMonitor)); ImGui::SameLine(0.0f, ImGui::GetStyle().ItemInnerSpacing.x); if ( (UIManager::Get()->IsOpenVRLoaded()) && (UIManager::Get()->IsInDesktopMode()) ) { HelpMarker(TranslationManager::GetString(tstr_OvrlPropsPerfMonDesktopModeTip)); } else { HelpMarker(TranslationManager::GetString(tstr_OvrlPropsPerfMonGlobalTip)); } const float column_1_width = (ImGui::GetContentRegionAvail().x - m_Column0Width) * 0.5f; //Monitor style radio buttons ImGui::Columns(2, "ColumnPerformanceMonitor", false); ImGui::SetColumnWidth(0, m_Column0Width); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsPerfMonStyle)); ImGui::NextColumn(); bool& use_minimal_style = ConfigManager::GetRef(configid_bool_performance_monitor_minimal_style); bool& use_large_style = ConfigManager::GetRef(configid_bool_performance_monitor_large_style); const bool use_compact_style = (!use_minimal_style && !use_large_style); bool& show_window = ConfigManager::GetRef(configid_bool_performance_monitor_style_show_window); bool& show_text_outline = ConfigManager::GetRef(configid_bool_performance_monitor_style_show_text_outline); bool& minimal_show_more = ConfigManager::GetRef(configid_bool_performance_monitor_style_minimal_show_more); if (ImGui::RadioButton(TranslationManager::GetString(tstr_OvrlPropsPerfMonStyleMinimal), use_minimal_style)) { use_minimal_style = true; use_large_style = false; UIManager::Get()->RepeatFrame(); } ImGui::SameLine(); if (ImGui::RadioButton(TranslationManager::GetString(tstr_OvrlPropsPerfMonStyleCompact), use_compact_style)) { use_minimal_style = false; use_large_style = false; UIManager::Get()->RepeatFrame(); } ImGui::SameLine(); if (ImGui::RadioButton(TranslationManager::GetString(tstr_OvrlPropsPerfMonStyleLarge), use_large_style)) { use_minimal_style = false; use_large_style = true; UIManager::Get()->RepeatFrame(); } ImGui::Columns(1); //Monitor style checkboxes ImGui::Columns(3, "ColumnPerformanceMonitorStyleCheckboxes", false); ImGui::SetColumnWidth(0, m_Column0Width); ImGui::SetColumnWidth(1, column_1_width); ImGui::SetColumnWidth(2, column_1_width); ImGui::NextColumn(); if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsPerfMonStyleShowWindow), &show_window)) { UIManager::Get()->RepeatFrame(); } ImGui::NextColumn(); if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsPerfMonStyleShowTextOutline), &show_text_outline)) { UIManager::Get()->RepeatFrame(); } ImGui::Columns(1); //This needs more space in some languages, so we give it the full width as it's the only checkbox for now ImGui::Columns(2, "ColumnPerformanceMonitorStyleMinimalSettings", false); ImGui::SetColumnWidth(0, m_Column0Width); ImGui::NextColumn(); ImGui::BeginCollapsingArea("PerformanceMonitorStyleMinimalSettings", use_minimal_style, m_PerfMonStyleCheckboxAnimationProgress); if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsPerfMonStyleMinimalShowMore), &minimal_show_more)) { UIManager::Get()->RepeatFrame(); } ImGui::EndCollapsingArea(); ImGui::Columns(1); //Monitor items ImGui::Spacing(); ImGui::Columns(3, "ColumnPerformanceMonitorItems", false); ImGui::SetColumnWidth(0, m_Column0Width); ImGui::SetColumnWidth(1, column_1_width); ImGui::SetColumnWidth(2, column_1_width); bool& show_cpu = ConfigManager::GetRef(configid_bool_performance_monitor_show_cpu); bool& show_gpu = ConfigManager::GetRef(configid_bool_performance_monitor_show_gpu); bool& show_graphs = ConfigManager::GetRef(configid_bool_performance_monitor_show_graphs); bool& show_fps = ConfigManager::GetRef(configid_bool_performance_monitor_show_fps); bool& show_battery = ConfigManager::GetRef(configid_bool_performance_monitor_show_battery); bool& show_time = ConfigManager::GetRef(configid_bool_performance_monitor_show_time); bool& show_trackers = ConfigManager::GetRef(configid_bool_performance_monitor_show_trackers); bool& show_vive_wireless = ConfigManager::GetRef(configid_bool_performance_monitor_show_vive_wireless); bool& disable_gpu_counters = ConfigManager::GetRef(configid_bool_performance_monitor_disable_gpu_counters); const bool can_show_graphs = ((use_large_style) && ((show_cpu) || (show_gpu))) || (!use_large_style); const bool can_show_time = ((use_large_style) && (show_fps) && (show_battery)) || (use_minimal_style); //Keep unavailable options as enabled but show the check boxes as unticked to avoid confusion bool show_graphs_visual = (can_show_graphs) ? show_graphs : false; bool show_time_visual = (can_show_time) ? show_time : false; bool show_trackers_visual = (!show_battery) ? false : show_trackers; bool show_vive_wireless_visual = (!show_battery) ? false : show_vive_wireless; ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsPerfMonItems)); ImGui::NextColumn(); if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsPerfMonItemCPU), &show_cpu)) { UIManager::Get()->RepeatFrame(); } ImGui::NextColumn(); if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsPerfMonItemGPU), &show_gpu)) { UIManager::Get()->RepeatFrame(); } ImGui::NextColumn(); ImGui::NextColumn(); if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsPerfMonItemFrameStats), &show_fps)) { UIManager::Get()->RepeatFrame(); } ImGui::NextColumn(); if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsPerfMonItemBattery), &show_battery)) { UIManager::Get()->RepeatFrame(); } ImGui::NextColumn(); ImGui::NextColumn(); if (!can_show_graphs) ImGui::PushItemDisabled(); if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsPerfMonItemGraphs), &show_graphs_visual)) { show_graphs = show_graphs_visual; UIManager::Get()->RepeatFrame(); } if (!can_show_graphs) ImGui::PopItemDisabled(); ImGui::NextColumn(); if (!can_show_time) ImGui::PushItemDisabled(); if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsPerfMonItemTime), &show_time_visual)) { show_time = show_time_visual; UIManager::Get()->RepeatFrame(); } if (!can_show_time) ImGui::PopItemDisabled(); ImGui::Columns(1); //These need more space than the other entries, so one per line here. Doesn't look as nice, but will have to do for now ImGui::Columns(2, "ColumnPerformanceMonitorItemsLong", false); ImGui::SetColumnWidth(0, m_Column0Width); ImGui::NextColumn(); if (!show_battery) ImGui::PushItemDisabled(); if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsPerfMonItemTrackerBattery), &show_trackers_visual)) { show_trackers = show_trackers_visual; UIManager::Get()->RepeatFrame(); } ImGui::NextColumn(); ImGui::NextColumn(); ImGui::NextColumn(); if (UIManager::Get()->GetPerformanceWindow().IsViveWirelessInstalled()) { if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsPerfMonItemViveWirelessTemp), &show_vive_wireless_visual)) { show_vive_wireless = show_vive_wireless_visual; UIManager::Get()->RepeatFrame(); } } if (!show_battery) ImGui::PopItemDisabled(); ImGui::Columns(1); ImGui::Indent(); ImGui::Spacing(); if (ImGui::Button(TranslationManager::GetString(tstr_OvrlPropsPerfMonResetValues))) { UIManager::Get()->GetPerformanceWindow().ResetCumulativeValues(); } ImGui::Unindent(); } void WindowOverlayProperties::UpdatePageMainCatBrowser() { //Don't show these settings if not browser overlay if (ConfigManager::GetValue(configid_int_overlay_capture_source) != ovrl_capsource_browser) return; //Use duplication IDs' data if any is set const int duplication_id = ConfigManager::GetValue(configid_int_overlay_duplication_id); OverlayConfigData& data = (duplication_id == -1) ? OverlayManager::Get().GetCurrentConfigData() : OverlayManager::Get().GetConfigData((unsigned int)duplication_id); //We also need to set overrides for most changes done here if the duplication is used const int config_overlay_id = (duplication_id == -1) ? (int)OverlayManager::Get().GetCurrentOverlayID() : duplication_id; ImGuiStyle& style = ImGui::GetStyle(); VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); ImGui::Spacing(); ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_OvrlPropsCatBrowser)); if (!DPBrowserAPIClient::Get().IsBrowserAvailable()) { ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_OvrlPropsBrowserNotAvailableTip), "(!)"); } ImGui::Columns(2, "ColumnBrowser", false); ImGui::SetColumnWidth(0, m_Column0Width); //Cloned Output if (duplication_id != -1) { static std::string clone_tip_text; static unsigned int highlighted_overlay_id_last = k_ulOverlayID_None; unsigned int highlighted_overlay_id = k_ulOverlayID_None; ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsBrowserCloned)); ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(clone_tip_text.c_str()); if (ImGui::IsItemHovered()) { //Highlight clone source overlay to give the user a better idea which one is the source (names are usually the same and the ID is not a good indicator) highlighted_overlay_id = (unsigned int)duplication_id; //If newly hovered, generate tooltip text if (clone_tip_text.empty()) { clone_tip_text = TranslationManager::GetString(tstr_OvrlPropsBrowserClonedTip); StringReplaceAll(clone_tip_text, "%OVERLAYNAME%", data.ConfigNameStr); UIManager::Get()->RepeatFrame(3); //Tooltip needs more frames to adjust to changing text since we changed it after it already rendered here } } else if (!clone_tip_text.empty()) { //Clear when not hovering so it'll be updated next time clone_tip_text = ""; } if (highlighted_overlay_id_last != highlighted_overlay_id) { UIManager::Get()->HighlightOverlay(highlighted_overlay_id); highlighted_overlay_id_last = highlighted_overlay_id; } ImGui::NextColumn(); if (ImGui::Button(TranslationManager::GetString(tstr_OvrlPropsBrowserClonedConvert))) { //Send string over to dashboard app so it uses the right URLs during conversion (it doesn't get or need updated URLs during runtime in most other cases) IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, config_overlay_id); IPCManager::Get().SendStringToDashboardApp(configid_str_overlay_browser_url, data.ConfigStr[configid_str_overlay_browser_url], UIManager::Get()->GetWindowHandle()); IPCManager::Get().SendStringToDashboardApp(configid_str_overlay_browser_url_user_last, data.ConfigStr[configid_str_overlay_browser_url_user_last], UIManager::Get()->GetWindowHandle()); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, -1); OverlayManager::Get().ConvertDuplicatedOverlayToStandalone(m_ActiveOverlayID); IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_make_standalone, (int)m_ActiveOverlayID); } ImGui::Spacing(); ImGui::NextColumn(); } //URL { static char buffer_url[1024] = ""; static bool can_restore_last_user_input = false; bool has_pressed_enter_on_url = false; ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsBrowserURL)); ImGui::NextColumn(); ImGui::PushItemWidth(-1.0f); vr_keyboard.VRKeyboardInputBegin("##InputURL"); vr_keyboard.SetShortcutWindowDirectionHint(ImGuiDir_Up); if (ImGui::InputTextWithHint("##InputURL", TranslationManager::GetString(tstr_OvrlPropsBrowserURLHint), buffer_url, IM_ARRAYSIZE(buffer_url), ImGuiInputTextFlags_EnterReturnsTrue | ImGuiInputTextFlags_AutoSelectAll)) { has_pressed_enter_on_url = true; } vr_keyboard.VRKeyboardInputEnd(); if (ImGui::IsItemEdited()) { //Add unmapped characters if they appear while typing UIManager::Get()->AddFontBuilderStringIfAnyUnmappedCharacters(buffer_url); can_restore_last_user_input = true; } else if ( ((m_IsBrowserURLChanged) || (m_PageAppearing == wndovrlprop_page_main)) && (!ImGui::IsItemActive()) ) { //Update buffer if URL changed externally or window/page is appearing while text input isn't active size_t copied_length = data.ConfigStr[configid_str_overlay_browser_url].copy(buffer_url, IM_ARRAYSIZE(buffer_url) - 1); buffer_url[copied_length] = '\0'; //Enable "Restore Last Input" only when they're actually different can_restore_last_user_input = (data.ConfigStr[configid_str_overlay_browser_url] != data.ConfigStr[configid_str_overlay_browser_url_user_last]); m_IsBrowserURLChanged = false; } ImGui::NextColumn(); ImGui::NextColumn(); if ( (ImGui::Button(TranslationManager::GetString(tstr_OvrlPropsBrowserGo))) || (has_pressed_enter_on_url) ) { //If buffer is not empty, set URL from user input, otherwise fall back to current URL if (buffer_url[0] != '\0') { data.ConfigStr[configid_str_overlay_browser_url] = buffer_url; data.ConfigStr[configid_str_overlay_browser_url_user_last] = data.ConfigStr[configid_str_overlay_browser_url]; //Send string over to dashboard app so it can call SetURL() IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, config_overlay_id); IPCManager::Get().SendStringToDashboardApp(configid_str_overlay_browser_url, data.ConfigStr[configid_str_overlay_browser_url], UIManager::Get()->GetWindowHandle()); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, -1); IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_browser_navigate_to_url, config_overlay_id); can_restore_last_user_input = false; } else { //This doesn't update the last user entered URL m_IsBrowserURLChanged = true; } } ImGui::SameLine(); const bool disable_restore_button = !can_restore_last_user_input; if (disable_restore_button) ImGui::PushItemDisabled(); if (ImGui::Button(TranslationManager::GetString(tstr_OvrlPropsBrowserRestore))) { //This button only changes the input buffer. It doesn't set the url or navigates anywhere. size_t copied_length = data.ConfigStr[configid_str_overlay_browser_url_user_last].copy(buffer_url, IM_ARRAYSIZE(buffer_url) - 1); buffer_url[copied_length] = '\0'; can_restore_last_user_input = false; } if (disable_restore_button) ImGui::PopItemDisabled(); ImGui::Spacing(); ImGui::NextColumn(); } //Resolution { ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsBrowserWidth)); ImGui::NextColumn(); bool changed_width = false, changed_height = false; int& user_width = data.ConfigInt[configid_int_overlay_user_width]; vr_keyboard.VRKeyboardInputBegin( ImGui::SliderWithButtonsGetSliderID("UserWidth") ); if (ImGui::SliderWithButtonsInt("UserWidth", user_width, 5, 1, 1, 3840, "%d px")) { user_width = clamp(user_width, 1, 7680); //Don't do live updates from text input (can lead to undesirable visuals, especially when removing all text) if (!ImGui::IsAnyTempInputTextActive()) { changed_width = true; } } vr_keyboard.VRKeyboardInputEnd(); if (ImGui::IsItemDeactivatedAfterEdit()) { changed_width = true; } ImGui::NextColumn(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsBrowserHeight)); ImGui::NextColumn(); int& user_height = data.ConfigInt[configid_int_overlay_user_height]; vr_keyboard.VRKeyboardInputBegin( ImGui::SliderWithButtonsGetSliderID("UserHeight") ); if (ImGui::SliderWithButtonsInt("UserHeight", user_height, 5, 1, 1, 2160, "%d px")) { user_height = clamp(user_height, 1, 4320); if (!ImGui::IsAnyTempInputTextActive()) { changed_height = true; } } vr_keyboard.VRKeyboardInputEnd(); if (ImGui::IsItemDeactivatedAfterEdit()) { changed_height = true; } if (changed_width) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, config_overlay_id); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_user_width, user_width); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, -1); //Also set for all overlays using this as duplication source (so reading code doesn't need to care about it being duplicated) for (unsigned int overlay_id : OverlayManager::Get().FindDuplicatedOverlaysForOverlay(config_overlay_id)) { OverlayConfigData& data_dup = OverlayManager::Get().GetConfigData(overlay_id); data_dup.ConfigInt[configid_int_overlay_user_width] = user_width; //Dashboard app does the same, so no need to send these changes over } } else if (changed_height) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, config_overlay_id); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_user_height, user_height); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, -1); for (unsigned int overlay_id : OverlayManager::Get().FindDuplicatedOverlaysForOverlay(config_overlay_id)) { OverlayConfigData& data_dup = OverlayManager::Get().GetConfigData(overlay_id); data_dup.ConfigInt[configid_int_overlay_user_height] = user_height; } } ImGui::NextColumn(); } //Zoom { ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsBrowserZoom)); ImGui::NextColumn(); float& zoom_level = data.ConfigFloat[configid_float_overlay_browser_zoom]; vr_keyboard.VRKeyboardInputBegin(ImGui::SliderWithButtonsGetSliderID("ZoomLevel")); if (ImGui::SliderWithButtonsFloatPercentage("ZoomLevel", zoom_level, 5, 1, 50, 400, "%d%%")) { zoom_level = clamp(zoom_level, 0.01f, 8.0f); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, config_overlay_id); IPCManager::Get().PostConfigMessageToDashboardApp(configid_float_overlay_browser_zoom, zoom_level); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, -1); } vr_keyboard.VRKeyboardInputEnd(); ImGui::Spacing(); ImGui::NextColumn(); } //Transparent Background { bool& allow_transparency = data.ConfigBool[configid_bool_overlay_browser_allow_transparency]; bool& is_allow_transparency_pending = data.ConfigBool[configid_bool_overlay_state_browser_allow_transparency_is_pending]; if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsBrowserAllowTransparency), &allow_transparency)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, config_overlay_id); IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_overlay_browser_allow_transparency, allow_transparency); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_state_overlay_current_id_override, -1); is_allow_transparency_pending = !is_allow_transparency_pending; //If it was already pending, then the value is back to what's already applied } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_OvrlPropsBrowserAllowTransparencyTip)); ImGui::NextColumn(); if ( (is_allow_transparency_pending) && (UIManager::Get()->IsOpenVRLoaded()) ) { if (ImGui::Button(TranslationManager::GetString(tstr_OvrlPropsBrowserRecreateContext))) { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_browser_recreate_context, config_overlay_id); is_allow_transparency_pending = false; } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_OvrlPropsBrowserRecreateContextTip)); } } ImGui::Columns(1); } void WindowOverlayProperties::UpdatePageMainCatAdvanced() { ImGuiStyle& style = ImGui::GetStyle(); VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); const int& mode_origin = ConfigManager::GetRef(configid_int_overlay_origin); ImGui::Spacing(); ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_OvrlPropsCatAdvanced)); ImGui::Columns(2, "ColumnAdvanced", false); ImGui::SetColumnWidth(0, m_Column0Width); //3D if (ConfigManager::GetValue(configid_int_overlay_capture_source) != ovrl_capsource_ui) //Don't show 3D settings for UI source overlays { bool& is_3D_enabled = ConfigManager::GetRef(configid_bool_overlay_3D_enabled); bool& is_3D_swapped = ConfigManager::GetRef(configid_bool_overlay_3D_swapped); int& mode_3d = ConfigManager::GetRef(configid_int_overlay_3D_mode); if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsAdvanced3D), &is_3D_enabled)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_overlay_3D_enabled, is_3D_enabled); } ImGui::NextColumn(); if (!is_3D_enabled) ImGui::PushItemDisabled(); ImGui::PushItemWidth(-1.0f); if (ImGui::BeginComboAnimated("##Combo3DMode", TranslationManager::GetString( (TRMGRStrID)(tstr_OvrlPropsAdvancedHSBS + mode_3d) ) )) { for (int i = ovrl_3Dmode_hsbs; i < ovrl_3Dmode_MAX; ++i) { if (ImGui::Selectable(TranslationManager::GetString( (TRMGRStrID)(tstr_OvrlPropsAdvancedHSBS + i) ), (mode_3d == i))) { mode_3d = i; IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_3D_mode, mode_3d); } } ImGui::EndCombo(); } ImGui::NextColumn(); ImGui::NextColumn(); if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsAdvanced3DSwap), &is_3D_swapped)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_overlay_3D_swapped, is_3D_swapped); } if (!is_3D_enabled) ImGui::PopItemDisabled(); ImGui::Spacing(); ImGui::NextColumn(); } //Gaze Fade { if (mode_origin == ovrl_origin_theater_screen) ImGui::PushItemDisabled(); bool& gazefade_enabled = ConfigManager::GetRef(configid_bool_overlay_gazefade_enabled); if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsAdvancedGazeFade), &gazefade_enabled)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_overlay_gazefade_enabled, gazefade_enabled); } ImGui::NextColumn(); if (!UIManager::Get()->IsOpenVRLoaded()) ImGui::PushItemDisabled(); if (ImGui::Button(TranslationManager::GetString(tstr_OvrlPropsAdvancedGazeFadeAuto))) { if (!UIManager::Get()->GetAuxUI().IsActive()) { //Show GazeFade Auto Hint window which will do the countdown and trigger auto-configuration in the dashboard app when done UIManager::Get()->GetAuxUI().GetGazeFadeAutoHintWindow().SetTargetOverlay(m_ActiveOverlayID); UIManager::Get()->GetAuxUI().GetGazeFadeAutoHintWindow().Show(); } } ImGui::NextColumn(); if (!UIManager::Get()->IsOpenVRLoaded()) ImGui::PopItemDisabled(); //Only show auto-configure when advanced settings are hidden if (ConfigManager::GetValue(configid_bool_interface_show_advanced_settings)) { if (!gazefade_enabled) ImGui::PushItemDisabled(); ImGui::Indent(ImGui::GetFrameHeightWithSpacing()); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsAdvancedGazeFadeDistance)); ImGui::NextColumn(); float& distance = ConfigManager::GetRef(configid_float_overlay_gazefade_distance); const char* alt_text = (distance < 0.01f) ? TranslationManager::GetString(tstr_OvrlPropsAdvancedGazeFadeDistanceValueInf) : nullptr; vr_keyboard.VRKeyboardInputBegin( ImGui::SliderWithButtonsGetSliderID("GazeFadeDistance") ); if (ImGui::SliderWithButtonsFloat("GazeFadeDistance", distance, 0.05f, 0.01f, 0.0f, 1.5f, (distance < 0.01f) ? "##%.2f" : "%.2f m", 0, nullptr, alt_text)) { if (distance < 0.01f) distance = 0.0f; IPCManager::Get().PostConfigMessageToDashboardApp(configid_float_overlay_gazefade_distance, distance); } vr_keyboard.VRKeyboardInputEnd(); ImGui::NextColumn(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsAdvancedGazeFadeSensitivity)); ImGui::NextColumn(); float& rate = ConfigManager::GetRef(configid_float_overlay_gazefade_rate); vr_keyboard.VRKeyboardInputBegin( ImGui::SliderWithButtonsGetSliderID("GazeFadeRate") ); if (ImGui::SliderWithButtonsFloat("GazeFadeRate", rate, 0.1f, 0.025f, 0.4f, 3.0f, "%.2fx", ImGuiSliderFlags_Logarithmic)) { if (rate < 0.0f) rate = 0.0f; IPCManager::Get().PostConfigMessageToDashboardApp(configid_float_overlay_gazefade_rate, rate); } vr_keyboard.VRKeyboardInputEnd(); ImGui::NextColumn(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsAdvancedGazeFadeOpacity)); ImGui::NextColumn(); float& target_opacity = ConfigManager::GetRef(configid_float_overlay_gazefade_opacity); vr_keyboard.VRKeyboardInputBegin( ImGui::SliderWithButtonsGetSliderID("GazeFadeOpacity") ); if (ImGui::SliderWithButtonsFloatPercentage("GazeFadeOpacity", target_opacity, 5, 1, 0, 100, "%d%%")) { target_opacity = clamp(target_opacity, 0.0f, 1.0f); IPCManager::Get().PostConfigMessageToDashboardApp(configid_float_overlay_gazefade_opacity, target_opacity); } vr_keyboard.VRKeyboardInputEnd(); if (!gazefade_enabled) ImGui::PopItemDisabled(); ImGui::Spacing(); ImGui::NextColumn(); ImGui::Unindent(ImGui::GetFrameHeightWithSpacing()); } if (mode_origin == ovrl_origin_theater_screen) ImGui::PopItemDisabled(); } //Laser Pointer Input { bool& input_enabled = ConfigManager::GetRef(configid_bool_overlay_input_enabled); if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsAdvancedInput), &input_enabled)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_overlay_input_enabled, input_enabled); } ImGui::NextColumn(); if (!input_enabled) ImGui::PushItemDisabled(); bool& input_dplus_lp_enabled = ConfigManager::GetRef(configid_bool_overlay_input_dplus_lp_enabled); bool& floating_ui_enabled = ConfigManager::GetRef(configid_bool_overlay_floatingui_enabled); //Show disabled as unticked to avoid confusion bool input_dplus_lp_enabled_visual = (!input_enabled) ? false : input_dplus_lp_enabled; bool floating_ui_enabled_visual = (!input_enabled) ? false : floating_ui_enabled; if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsAdvancedInputInGame), &input_dplus_lp_enabled_visual)) { input_dplus_lp_enabled = input_dplus_lp_enabled_visual; IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_overlay_input_dplus_lp_enabled, input_dplus_lp_enabled); } ImGui::NextColumn(); ImGui::NextColumn(); if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsAdvancedInputFloatingUI), &floating_ui_enabled_visual)) { floating_ui_enabled = floating_ui_enabled_visual; IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_overlay_floatingui_enabled, floating_ui_enabled); } if (!input_enabled) ImGui::PopItemDisabled(); ImGui::Spacing(); ImGui::NextColumn(); } //Overlay Tags { static FloatingWindowInputOverlayTagsState input_tags_state; ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsAdvancedOverlayTags)); ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_OvrlPropsAdvancedOverlayTagsTip)); ImGui::NextColumn(); if (InputOverlayTags("OverlayTags", m_BufferOverlayTags, IM_ARRAYSIZE(m_BufferOverlayTags), input_tags_state, 0, false)) { OverlayConfigData& data = OverlayManager::Get().GetCurrentConfigData(); data.ConfigStr[configid_str_overlay_tags] = m_BufferOverlayTags; IPCManager::Get().SendStringToDashboardApp(configid_str_overlay_tags, data.ConfigStr[configid_str_overlay_tags], UIManager::Get()->GetWindowHandle()); } } ImGui::Columns(1); } void WindowOverlayProperties::UpdatePageMainCatPerformance() { //Don't show performance settings for UI source overlays if (ConfigManager::GetValue(configid_int_overlay_capture_source) == ovrl_capsource_ui) return; ImGui::Spacing(); ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_OvrlPropsCatPerformance)); ImGui::Columns(2, "ColumnPerformance", false); ImGui::SetColumnWidth(0, m_Column0Width); //Max FPS setting for browser overlays if (ConfigManager::GetValue(configid_int_overlay_capture_source) == ovrl_capsource_browser) { OverlayConfigData& data = OverlayManager::Get().GetCurrentConfigData(); VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsBrowserMaxFrameRate)); ImGui::NextColumn(); int& max_fps = data.ConfigInt[configid_int_overlay_browser_max_fps_override]; if (m_BrowserMaxFPSValueText.empty()) { m_BrowserMaxFPSValueText = TranslationManager::GetString(tstr_SettingsPerformanceUpdateLimiterFPSValue); StringReplaceAll(m_BrowserMaxFPSValueText, "%FPS%", std::to_string(max_fps)); } const char* alt_text = (max_fps < 1) ? TranslationManager::GetString(tstr_SettingsBrowserMaxFrameRateOverrideOff) : m_BrowserMaxFPSValueText.c_str(); vr_keyboard.VRKeyboardInputBegin(ImGui::SliderWithButtonsGetSliderID("MaxFPS")); if (ImGui::SliderWithButtonsInt("MaxFPS", max_fps, 5, 1, 0, 144, "##%d", 0, nullptr, alt_text)) { if (max_fps < 1) max_fps = -1; IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_browser_max_fps_override, max_fps); m_BrowserMaxFPSValueText = ""; } vr_keyboard.VRKeyboardInputEnd(); ImGui::NextColumn(); } else //Update limiter for everything else { UpdateLimiterSetting(true); } if (ConfigManager::GetValue(configid_bool_interface_show_advanced_settings)) { ImGui::Spacing(); bool& update_invisible = ConfigManager::GetRef(configid_bool_overlay_update_invisible); if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsPerformanceInvisibleUpdate), &update_invisible)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_overlay_update_invisible, update_invisible); } ImGui::SameLine(0.0f, ImGui::GetStyle().ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_OvrlPropsPerformanceInvisibleUpdateTip)); ImGui::NextColumn(); ImGui::NextColumn(); } ImGui::Columns(1); } void WindowOverlayProperties::UpdatePageMainCatInterface() { OverlayConfigData& data = OverlayManager::Get().GetCurrentConfigData(); VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); if (m_PageReturned == wndovrlprop_page_actions_order) { m_ActionButtonsLabel.clear(); } if (m_ActionButtonsLabel.empty()) { m_ActionButtonsLabel = TranslationManager::GetString( (data.ConfigActionBarOrder.size() == 1) ? tstr_SettingsActionsOrderButtonLabelSingular : tstr_SettingsActionsOrderButtonLabel ); StringReplaceAll(m_ActionButtonsLabel, "%COUNT%", std::to_string(data.ConfigActionBarOrder.size())); } ImGui::Spacing(); ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_OvrlPropsCatInterface)); ImGui::Columns(2, "ColumnInterface", false); ImGui::SetColumnWidth(0, m_Column0Width); //Overlay Name { ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsInterfaceOverlayName)); ImGui::NextColumn(); ImGui::PushItemWidth(-1.0f); vr_keyboard.VRKeyboardInputBegin("##InputOverlayName"); if (ImGui::InputTextWithHint("##InputOverlayName", TranslationManager::GetString(tstr_OvrlPropsInterfaceOverlayNameAuto), m_BufferOverlayName, 1024)) { //If name buffer is not empty, set name from user input, otherwise fall back to auto naming if (m_BufferOverlayName[0] != '\0') { data.ConfigBool[configid_bool_overlay_name_custom] = true; data.ConfigNameStr = m_BufferOverlayName; if (ImGui::StringContainsUnmappedCharacter(m_BufferOverlayName)) { TextureManager::Get().ReloadAllTexturesLater(); } } else { data.ConfigBool[configid_bool_overlay_name_custom] = false; OverlayManager::Get().SetCurrentOverlayNameAuto(); } m_WindowTitle = data.ConfigNameStr; } vr_keyboard.VRKeyboardInputEnd(); ImGui::Spacing(); ImGui::NextColumn(); } bool custom_order = !ConfigManager::GetValue(configid_bool_overlay_actionbar_order_use_global); //Meaning is reversed in config, but just handle it here if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsInterfaceActionOrderCustom), &custom_order)) { ConfigManager::SetValue(configid_bool_overlay_actionbar_order_use_global, !custom_order); } ImGui::NextColumn(); if (!custom_order) ImGui::PushItemDisabled(); if (ImGui::Button(m_ActionButtonsLabel.c_str())) { PageGoForward(wndovrlprop_page_actions_order); } ImGui::NextColumn(); if (!custom_order) ImGui::PopItemDisabled(); //Don't show for UI source overlays if (data.ConfigInt[configid_int_overlay_capture_source] != ovrl_capsource_ui) { if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsInterfaceDesktopButtons), &data.ConfigBool[configid_bool_overlay_floatingui_desktops_enabled])) { UIManager::Get()->RepeatFrame(); } } if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsInterfaceExtraButtons), &data.ConfigBool[configid_bool_overlay_floatingui_extras_enabled])) { UIManager::Get()->RepeatFrame(); } ImGui::Columns(1); } void WindowOverlayProperties::UpdatePagePositionChange(bool only_restore_settings) { ImGuiStyle& style = ImGui::GetStyle(); ImGuiIO& io = ImGui::GetIO(); VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); float& column_width_0 = m_CachedSizes.PositionChange_Column0Width; static int active_capture_type = 0; //0 = off, 1 = Move, 2 = Rotate static ImVec2 active_capture_pos; static bool is_overlay_transform_temp_unlocked = false; if (only_restore_settings) { //Undo temporary transform unlocking if (is_overlay_transform_temp_unlocked) { ConfigManager::SetValue(configid_bool_overlay_transform_locked, true); IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_overlay_transform_locked, true); is_overlay_transform_temp_unlocked = false; } return; } if ((m_PageAppearing == wndovrlprop_page_position_change) || (m_CachedSizes.PositionChange_Column0Width == 0.0f)) { //Find longer label and use that as minimum column width float column_label_width = std::max(ImGui::CalcTextSize(TranslationManager::GetString(tstr_OvrlPropsPositionChangeMove)).x, ImGui::CalcTextSize(TranslationManager::GetString(tstr_OvrlPropsPositionChangeRotate)).x); column_width_0 = std::max(ImGui::GetFontSize() * 3.75f, column_label_width + style.ItemSpacing.x + style.ItemSpacing.x); //Find longest button label float button_label_width = 0.0f; float label_width = 0.0f; for (int i = tstr_OvrlPropsPositionChangeForward; i <= tstr_OvrlPropsPositionChangeLookAt; ++i) { label_width = ImGui::CalcTextSize(TranslationManager::GetString((TRMGRStrID)i)).x; if (label_width > button_label_width) { button_label_width = label_width; } } m_CachedSizes.PositionChange_ButtonWidth = button_label_width + (style.FramePadding.x * 2.0f); } if (m_PageAppearing == wndovrlprop_page_position_change) { //Set dragmode state //Dragging the overlay when the UI is open on desktop is pretty inconvenient to get out of when not sitting in front of a real mouse, so let's prevent this if (!UIManager::Get()->IsInDesktopMode()) { //Automatically reset the matrix to a saner default if it still has the zero value if (ConfigManager::Get().GetOverlayDetachedTransform().isZero()) { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_position_reset); } bool& is_changing_position = ConfigManager::GetRef(configid_bool_state_overlay_dragmode); is_changing_position = true; IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_state_overlay_dragselectmode_show_hidden, is_changing_position); IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_state_overlay_dragmode, is_changing_position); } //Temporarily unlock overlay transform if it's locked bool& is_overlay_transform_locked = ConfigManager::GetRef(configid_bool_overlay_transform_locked); if (is_overlay_transform_locked) { is_overlay_transform_locked = false; IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_overlay_transform_locked, false); is_overlay_transform_temp_unlocked = true; } } ImGui::PushStyleColor(ImGuiCol_ChildBg, ImVec4(0.00f, 0.00f, 0.00f, 0.00f)); ImGui::BeginChild("PositionChangeChild", ImVec2(0.0f, ImGui::GetContentRegionAvail().y - ImGui::GetFrameHeightWithSpacing() - style.ItemSpacing.y), ImGuiChildFlags_NavFlattened); ImGui::PopStyleColor(); const float column_width_1 = ImGui::GetFrameHeightWithSpacing() * 3.0f + style.ItemInnerSpacing.x; const float column_width_2 = m_CachedSizes.PositionChange_ButtonWidth + (style.ItemInnerSpacing.x * 2.0f); const float column_width_3 = style.ItemSpacing.x * 3.0f; ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_OvrlPropsPositionChangeHeader)); ImGui::Indent(); if (!UIManager::Get()->IsInDesktopMode()) { ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsPositionChangeHelp)); } else { ImGui::TextWrapped("%s", TranslationManager::GetString(tstr_OvrlPropsPositionChangeHelpDesktop)); } ImGui::Unindent(); //--Manual Adjustment ImGui::Spacing(); ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_OvrlPropsPositionChangeManualAdjustment)); ImGui::Indent(); ImGui::Columns(7, "ColumnManualAdjust", false); const ImVec2 arrow_button_size(ImGui::GetFrameHeight(), ImGui::GetFrameHeight()); const ImVec2 button_size(m_CachedSizes.PositionChange_ButtonWidth, 0.0f); ImGui::SetColumnWidth(0, column_width_0); ImGui::SetColumnWidth(1, column_width_1); ImGui::SetColumnWidth(2, column_width_2); ImGui::SetColumnWidth(3, column_width_3); ImGui::SetColumnWidth(4, column_width_0); ImGui::SetColumnWidth(5, column_width_1); ImGui::SetColumnWidth(6, column_width_2); ImGui::PushItemFlag(ImGuiItemFlags_ButtonRepeat, true); //Row 1 ImGui::NextColumn(); ImGui::SetCursorPosX(ImGui::GetCursorPosX() + ImGui::GetFrameHeightWithSpacing()); if (ImGui::ArrowButton("MoveUp", ImGuiDir_Up)) { //Do some packing unsigned int packed_value = ipcactv_ovrl_pos_adjust_increase; //Increase bit packed_value |= ipcactv_ovrl_pos_adjust_updown; IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_position_adjust, packed_value); } ImGui::NextColumn(); if (ImGui::Button(TranslationManager::GetString(tstr_OvrlPropsPositionChangeForward), button_size)) { unsigned int packed_value = ipcactv_ovrl_pos_adjust_increase; packed_value |= ipcactv_ovrl_pos_adjust_forwback; IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_position_adjust, packed_value); } ImGui::NextColumn(); ImGui::NextColumn(); ImGui::NextColumn(); ImGui::SetCursorPosX(ImGui::GetCursorPosX() + ImGui::GetFrameHeightWithSpacing()); if (ImGui::ArrowButton("RotUp", ImGuiDir_Up)) { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_position_adjust, ipcactv_ovrl_pos_adjust_rotx); } ImGui::NextColumn(); if (ImGui::Button(TranslationManager::GetString(tstr_OvrlPropsPositionChangeRollCW), button_size)) { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_position_adjust, ipcactv_ovrl_pos_adjust_rotz); } ImGui::NextColumn(); //Row 2 ImGui::SetCursorPosX(ImGui::GetCursorPosX() + style.ItemSpacing.x); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsPositionChangeMove)); ImGui::NextColumn(); if (ImGui::ArrowButton("MoveLeft", ImGuiDir_Left)) { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_position_adjust, ipcactv_ovrl_pos_adjust_rightleft); } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); if (UIManager::Get()->IsInDesktopMode()) { if (io.NavVisible) ImGui::PushItemDisabled(); bool is_active = (active_capture_type == 1); if (is_active) ImGui::PushStyleColor(ImGuiCol_Button, style.Colors[ImGuiCol_ButtonActive]); ImGui::Button(TranslationManager::GetString(tstr_OvrlPropsPositionChangeDragButton), arrow_button_size); //Activate on mouse down instead of normal button behavior, which is on mouse up if ((active_capture_type == 0) && (ImGui::IsItemHovered()) && ImGui::IsMouseDown(ImGuiMouseButton_Left)) { active_capture_type = 1; active_capture_pos = io.MousePos; } if (is_active) ImGui::PopStyleColor(); if (io.NavVisible) ImGui::PopItemDisabled(); } else { ImGui::Dummy(arrow_button_size); } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); if (ImGui::ArrowButton("MoveRight", ImGuiDir_Right)) { unsigned int packed_value = ipcactv_ovrl_pos_adjust_increase; packed_value |= ipcactv_ovrl_pos_adjust_rightleft; IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_position_adjust, packed_value); } ImGui::NextColumn(); if (ImGui::Button(TranslationManager::GetString(tstr_OvrlPropsPositionChangeBackward), button_size)) { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_position_adjust, ipcactv_ovrl_pos_adjust_forwback); } ImGui::NextColumn(); ImGui::NextColumn(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsPositionChangeRotate)); ImGui::NextColumn(); if (ImGui::ArrowButton("RotLeft", ImGuiDir_Left)) { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_position_adjust, ipcactv_ovrl_pos_adjust_roty); } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); if (UIManager::Get()->IsInDesktopMode()) { if (io.NavVisible) ImGui::PushItemDisabled(); ImGui::PushID("##Rot"); bool is_active = (active_capture_type == 2); if (is_active) ImGui::PushStyleColor(ImGuiCol_Button, style.Colors[ImGuiCol_ButtonActive]); ImGui::Button(TranslationManager::GetString(tstr_OvrlPropsPositionChangeDragButton), arrow_button_size); //Activate on mouse down instead of normal button behavior, which is on mouse up if ((active_capture_type == 0) && (ImGui::IsItemHovered()) && ImGui::IsMouseDown(ImGuiMouseButton_Left)) { active_capture_type = 2; active_capture_pos = io.MousePos; } if (is_active) ImGui::PopStyleColor(); ImGui::PopID(); if (io.NavVisible) ImGui::PopItemDisabled(); } else { ImGui::Dummy(arrow_button_size); } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); if (ImGui::ArrowButton("RotRight", ImGuiDir_Right)) { unsigned int packed_value = ipcactv_ovrl_pos_adjust_increase; packed_value |= ipcactv_ovrl_pos_adjust_roty; IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_position_adjust, packed_value); } ImGui::NextColumn(); if (ImGui::Button(TranslationManager::GetString(tstr_OvrlPropsPositionChangeRollCCW), button_size)) { unsigned int packed_value = ipcactv_ovrl_pos_adjust_increase; packed_value |= ipcactv_ovrl_pos_adjust_rotz; IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_position_adjust, packed_value); } ImGui::NextColumn(); //Row 3 ImGui::NextColumn(); ImGui::SetCursorPosX(ImGui::GetCursorPosX() + ImGui::GetFrameHeightWithSpacing()); if (ImGui::ArrowButton("MoveDown", ImGuiDir_Down)) { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_position_adjust, ipcactv_ovrl_pos_adjust_updown); } ImGui::NextColumn(); ImGui::NextColumn(); ImGui::NextColumn(); ImGui::NextColumn(); ImGui::SetCursorPosX(ImGui::GetCursorPosX() + ImGui::GetFrameHeightWithSpacing()); if (ImGui::ArrowButton("RotDown", ImGuiDir_Down)) { unsigned int packed_value = ipcactv_ovrl_pos_adjust_increase; packed_value |= ipcactv_ovrl_pos_adjust_rotx; IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_position_adjust, packed_value); } ImGui::PopItemFlag(); //ImGuiItemFlags_ButtonRepeat ImGui::NextColumn(); if (ImGui::Button(TranslationManager::GetString(tstr_OvrlPropsPositionChangeLookAt), button_size)) { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_position_adjust, ipcactv_ovrl_pos_adjust_lookat); } ImGui::Columns(1); ImGui::Unindent(); //--Additional Offset if (ConfigManager::GetValue(configid_bool_interface_show_advanced_settings)) { ImGui::Spacing(); ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_OvrlPropsPositionChangeOffset)); ImGui::Columns(2, "ColumnOffset", false); ImGui::SetColumnWidth(0, m_Column0Width); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsPositionChangeOffsetUpDown)); ImGui::NextColumn(); float& up = ConfigManager::GetRef(configid_float_overlay_offset_up); vr_keyboard.VRKeyboardInputBegin( ImGui::SliderWithButtonsGetSliderID("OverlayOffsetUp") ); if (ImGui::SliderWithButtonsFloat("OverlayOffsetUp", up, 0.1f, 0.01f, -5.0f, 5.0f, "%.2f m", ImGuiSliderFlags_Logarithmic)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_float_overlay_offset_up, up); } vr_keyboard.VRKeyboardInputEnd(); ImGui::NextColumn(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsPositionChangeOffsetRightLeft)); ImGui::NextColumn(); float& right = ConfigManager::GetRef(configid_float_overlay_offset_right); vr_keyboard.VRKeyboardInputBegin( ImGui::SliderWithButtonsGetSliderID("OverlayOffsetRight") ); if (ImGui::SliderWithButtonsFloat("OverlayOffsetRight", right, 0.1f, 0.01f, -5.0f, 5.0f, "%.2f m", ImGuiSliderFlags_Logarithmic)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_float_overlay_offset_right, right); } vr_keyboard.VRKeyboardInputEnd(); ImGui::NextColumn(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsPositionChangeOffsetForwardBackward)); ImGui::NextColumn(); float& forward = ConfigManager::GetRef(configid_float_overlay_offset_forward); vr_keyboard.VRKeyboardInputBegin( ImGui::SliderWithButtonsGetSliderID("OverlayOffsetForward") ); if (ImGui::SliderWithButtonsFloat("OverlayOffsetForward", forward, 0.1f, 0.01f, -5.0f, 5.0f, "%.2f m", ImGuiSliderFlags_Logarithmic)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_float_overlay_offset_forward, forward); } vr_keyboard.VRKeyboardInputEnd(); ImGui::Columns(1); } //--Drag Settings ImGui::Spacing(); ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_OvrlPropsPositionChangeDragSettings)); ImGui::Indent(); bool& auto_docking = ConfigManager::GetRef(configid_bool_input_drag_auto_docking); if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsPositionChangeDragSettingsAutoDocking), &auto_docking)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_input_drag_auto_docking, auto_docking); } ImGui::Unindent(); //Fixed Size ImGui::Spacing(); ImGui::Columns(2, "ColumnFixedDistance", false); ImGui::SetColumnWidth(0, m_Column0Width); bool& force_fixed_distance = ConfigManager::GetRef(configid_bool_input_drag_fixed_distance); float& force_fixed_distance_value = ConfigManager::GetRef(configid_float_input_drag_fixed_distance_m); int& force_fixed_distance_shape = ConfigManager::GetRef(configid_int_input_drag_fixed_distance_shape); bool& force_fixed_distance_auto_curve = ConfigManager::GetRef(configid_bool_input_drag_fixed_distance_auto_curve); bool& force_fixed_distance_auto_tilt = ConfigManager::GetRef(configid_bool_input_drag_fixed_distance_auto_tilt); if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsPositionChangeDragSettingsForceDistance), &force_fixed_distance)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_input_drag_fixed_distance, force_fixed_distance); } ImGui::NextColumn(); if (!force_fixed_distance) ImGui::PushItemDisabled(); vr_keyboard.VRKeyboardInputBegin( ImGui::SliderWithButtonsGetSliderID("FixedDistance") ); if (ImGui::SliderWithButtonsFloat("FixedDistanceValue", force_fixed_distance_value, 0.1f, 0.01f, 0.5f, 10.0f, "%.2f m", ImGuiSliderFlags_Logarithmic)) { if (force_fixed_distance_value < 0.5f) force_fixed_distance_value = 0.5f; IPCManager::Get().PostConfigMessageToDashboardApp(configid_float_input_drag_fixed_distance_m, force_fixed_distance_value); } vr_keyboard.VRKeyboardInputEnd(); ImGui::NextColumn(); ImGui::Indent(ImGui::GetFrameHeightWithSpacing()); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsPositionChangeDragSettingsForceDistanceShape)); ImGui::NextColumn(); ImGui::SetNextItemWidth(-1); if (TranslatedComboAnimated("##ComboFixedDistanceShape", force_fixed_distance_shape, tstr_OvrlPropsPositionChangeDragSettingsForceDistanceShapeSphere, tstr_OvrlPropsPositionChangeDragSettingsForceDistanceShapeCylinder)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_input_drag_fixed_distance_shape, force_fixed_distance_shape); } ImGui::NextColumn(); ImGui::NextColumn(); if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsPositionChangeDragSettingsForceDistanceAutoCurve), &force_fixed_distance_auto_curve)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_input_drag_fixed_distance_auto_curve, force_fixed_distance_auto_curve); } ImGui::NextColumn(); ImGui::NextColumn(); if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsPositionChangeDragSettingsForceDistanceAutoTilt), &force_fixed_distance_auto_tilt)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_input_drag_fixed_distance_auto_tilt, force_fixed_distance_auto_tilt); } if (!force_fixed_distance) ImGui::PopItemDisabled(); ImGui::Unindent(ImGui::GetFrameHeightWithSpacing()); ImGui::Spacing(); ImGui::NextColumn(); //Position Snapping bool& snap_position = ConfigManager::GetRef(configid_bool_input_drag_snap_position); float& snap_position_size = ConfigManager::GetRef(configid_float_input_drag_snap_position_size); if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsPositionChangeDragSettingsSnapPosition), &snap_position)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_input_drag_snap_position, snap_position); } ImGui::NextColumn(); if (!snap_position) ImGui::PushItemDisabled(); vr_keyboard.VRKeyboardInputBegin( ImGui::SliderWithButtonsGetSliderID("SnapPosition") ); if (ImGui::SliderWithButtonsFloat("SnapPositionSize", snap_position_size, 0.1f, 0.01f, 0.01f, 1.0f, "%.2f m", ImGuiSliderFlags_Logarithmic)) { if (snap_position_size < 0.01f) snap_position_size = 0.01f; IPCManager::Get().PostConfigMessageToDashboardApp(configid_float_input_drag_snap_position_size, snap_position_size); } vr_keyboard.VRKeyboardInputEnd(); if (!snap_position) ImGui::PopItemDisabled(); ImGui::NextColumn(); //Rotation Snapping bool& snap_rotation = ConfigManager::GetRef(configid_bool_input_drag_snap_rotation); bool& snap_rotation_x = ConfigManager::GetRef(configid_bool_input_drag_snap_rotation_x); bool& snap_rotation_y = ConfigManager::GetRef(configid_bool_input_drag_snap_rotation_y); bool& snap_rotation_z = ConfigManager::GetRef(configid_bool_input_drag_snap_rotation_z); int& snap_rotation_angle = ConfigManager::GetRef(configid_int_input_drag_snap_rotation_angle); //This checkbox is somewhat redundant and is mostly there for aesthetical reasons if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsPositionChangeDragSettingsSnapRotation), &snap_rotation)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_input_drag_snap_rotation, snap_rotation); } ImGui::NextColumn(); if (!snap_rotation) ImGui::PushItemDisabled(); vr_keyboard.VRKeyboardInputBegin( ImGui::SliderWithButtonsGetSliderID("SnapRotationAngle") ); if (ImGui::SliderWithButtonsInt("SnapRotationAngle", snap_rotation_angle, 5, 1, 1, 180, "%i\xc2\xb0")) //using k_pch_degree_symbol here { snap_rotation_angle = clamp(snap_rotation_angle, 1, 359); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_input_drag_snap_rotation_angle, snap_rotation_angle); } vr_keyboard.VRKeyboardInputEnd(); ImGui::NextColumn(); ImGui::NextColumn(); //Arranged in Y-X-Z order to result in hopefully more intuitive Yaw-Pitch-Roll checkboxes if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsPositionChangeDragSettingsSnapRotationYaw), &snap_rotation_y)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_input_drag_snap_rotation_y, snap_rotation_y); } ImGui::SameLine(); if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsPositionChangeDragSettingsSnapRotationPitch), &snap_rotation_x)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_input_drag_snap_rotation_x, snap_rotation_x); } ImGui::SameLine(); if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsPositionChangeDragSettingsSnapRotationRoll), &snap_rotation_z)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_input_drag_snap_rotation_z, snap_rotation_z); } ImGui::SameLine(); if (!snap_rotation) ImGui::PopItemDisabled(); ImGui::Columns(1); ImGui::EndChild(); ImGui::SetCursorPosY( ImGui::GetCursorPosY() + (ImGui::GetContentRegionAvail().y - ImGui::GetFrameHeightWithSpacing()) ); //--Confirmation buttons ImGui::Separator(); if (ImGui::Button(TranslationManager::GetString(tstr_DialogDone))) { PageGoBack(); } ImGui::SameLine(); static float button_reset_width = 0.0f; ImGui::SetCursorPosX(ImGui::GetCursorPosX() + ImGui::GetContentRegionAvail().x - button_reset_width); if (ImGui::Button(TranslationManager::GetString(tstr_OvrlPropsPositionReset))) { OverlayPositionReset(); } button_reset_width = ImGui::GetItemRectSize().x; //--Mouse Dragging if (active_capture_type != 0) { if (ImGui::IsMouseReleased(ImGuiMouseButton_Left)) { active_capture_type = 0; ImGui::SetMouseCursor(ImGuiMouseCursor_Arrow); } else { ImGui::SetMouseCursor(ImGuiMouseCursor_None); const float delta_step = 5.0f; ImVec2 mouse_delta = ImGui::GetMouseDragDelta(ImGuiMouseButton_Left); if (active_capture_type == 1) { //X -> Right/Left if (fabs(mouse_delta.x) > delta_step) { unsigned int packed_value = (mouse_delta.x > 0.0f) ? ipcactv_ovrl_pos_adjust_increase : 0; packed_value |= ipcactv_ovrl_pos_adjust_rightleft; //Using the existing position adjust message a few times might be cheap, but it also results in actually useful grid-snapped adjustments int steps = (int)(fabs(mouse_delta.x) / delta_step); for (int i = 0; i < steps; ++i) { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_position_adjust, packed_value); } } //Y -> Up/Down if (fabs(mouse_delta.y) > delta_step) { unsigned int packed_value = (mouse_delta.y < 0.0f) ? ipcactv_ovrl_pos_adjust_increase : 0; packed_value |= ipcactv_ovrl_pos_adjust_updown; int steps = (int)(fabs(mouse_delta.y) / delta_step); for (int i = 0; i < steps; ++i) { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_position_adjust, packed_value); } } //Wheel -> Forward/Backward or Change Width (when shift is down) if (fabs(io.MouseWheel) > 0.0f) { if (io.KeyShift) { const float size_step = (snap_position) ? snap_position_size : 0.20f; float& overlay_width = ConfigManager::GetRef(configid_float_overlay_width); overlay_width = std::max(0.05f, overlay_width + (io.MouseWheel * size_step) ); //Send adjusted width to dashboard app IPCManager::Get().PostConfigMessageToDashboardApp(configid_float_overlay_width, overlay_width); } else { unsigned int packed_value = (io.MouseWheel < 0.0f) ? ipcactv_ovrl_pos_adjust_increase : 0; packed_value |= ipcactv_ovrl_pos_adjust_forwback; int steps = (int)(fabs(io.MouseWheel) * delta_step); for (int i = 0; i < steps; ++i) { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_position_adjust, packed_value); } } } } else //active_capture_type == 2 { //X -> Rotate Y+- if (fabs(mouse_delta.x) > delta_step) { unsigned int packed_value = (mouse_delta.x > 0.0f) ? ipcactv_ovrl_pos_adjust_increase : 0; packed_value |= ipcactv_ovrl_pos_adjust_roty; int steps = (int)(fabs(mouse_delta.x) / delta_step); for (int i = 0; i < steps; ++i) { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_position_adjust, packed_value); } } //Y -> Rotate X+- if (fabs(mouse_delta.y) > delta_step) { unsigned int packed_value = (mouse_delta.y > 0.0f) ? ipcactv_ovrl_pos_adjust_increase : 0; packed_value |= ipcactv_ovrl_pos_adjust_rotx; int steps = (int)(fabs(mouse_delta.y) / delta_step); for (int i = 0; i < steps; ++i) { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_position_adjust, packed_value); } } //Wheel -> Rotate Z+- if (fabs(io.MouseWheel) > 0.0f) { unsigned int packed_value = (io.MouseWheel > 0.0f) ? ipcactv_ovrl_pos_adjust_increase : 0; packed_value |= ipcactv_ovrl_pos_adjust_rotz; int steps = (int)(fabs(io.MouseWheel) * delta_step); for (int i = 0; i < steps; ++i) { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_position_adjust, packed_value); } } } //Reset mouse cursor if needed if (fabs(mouse_delta.x) > delta_step) { io.WantSetMousePos = true; io.MousePos.x = active_capture_pos.x; io.MouseClickedPos[0].x = io.MousePos.x; //for drag delta } if (fabs(mouse_delta.y) > delta_step) { io.WantSetMousePos = true; io.MousePos.y = active_capture_pos.y; io.MouseClickedPos[0].y = io.MousePos.y; } //Prevent scrolling on the parent window ImGui::BlockWidgetInput(); } } } void WindowOverlayProperties::UpdatePageCropChange(bool only_restore_settings) { VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); ImGuiStyle& style = ImGui::GetStyle(); static ImGui::ImGuiDraggableRectAreaState draggable_rect_state; static ImVec2 draggable_rect_area; static ImVec2 draggable_rect_area_base_size; static ImVec4 draggable_rect_base_rect; static float draggable_rect_scale = 1.0f; bool& crop_enabled = ConfigManager::GetRef(configid_bool_overlay_crop_enabled); int& crop_x = ConfigManager::GetRef(configid_int_overlay_crop_x); int& crop_y = ConfigManager::GetRef(configid_int_overlay_crop_y); int& crop_width = ConfigManager::GetRef(configid_int_overlay_crop_width); int& crop_height = ConfigManager::GetRef(configid_int_overlay_crop_height); if ( (only_restore_settings) && (m_IsConfigDataModified) ) { //Restore previous settings OverlayConfigData& data = OverlayManager::Get().GetCurrentConfigData(); crop_enabled = m_ConfigDataTemp.ConfigBool[configid_bool_overlay_crop_enabled]; crop_x = m_ConfigDataTemp.ConfigInt[configid_int_overlay_crop_x]; crop_y = m_ConfigDataTemp.ConfigInt[configid_int_overlay_crop_y]; crop_width = m_ConfigDataTemp.ConfigInt[configid_int_overlay_crop_width]; crop_height = m_ConfigDataTemp.ConfigInt[configid_int_overlay_crop_height]; data.ConfigNameStr = m_ConfigDataTemp.ConfigNameStr; SetActiveOverlayID(m_ActiveOverlayID); IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_overlay_crop_enabled, crop_enabled); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_crop_width, crop_width); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_crop_height, crop_height); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_crop_x, crop_x); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_crop_y, crop_y); m_IsConfigDataModified = false; return; } if ( (m_PageAppearing == wndovrlprop_page_crop_change) && (!m_IsWindowAppearing) ) { m_IsConfigDataModified = true; m_ConfigDataTemp = OverlayManager::Get().GetCurrentConfigData(); //Enable cropping so modifications are always visible crop_enabled = true; IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_overlay_crop_enabled, true); } int ovrl_width, ovrl_height; if (ConfigManager::GetValue(configid_int_overlay_capture_source) == ovrl_capsource_desktop_duplication) { UIManager::Get()->GetDesktopOverlayPixelSize(ovrl_width, ovrl_height); } else //This would also work for desktop duplication except the above works without the dashboard app running while this doesn't { ovrl_width = ConfigManager::GetValue(configid_int_overlay_state_content_width); ovrl_height = ConfigManager::GetValue(configid_int_overlay_state_content_height); //If overlay width and height are uninitialized, set them to the crop values at least if ((ovrl_width == -1) && (ovrl_height == -1)) { //Use user width and height if it's a browser overlay, however if (ConfigManager::GetValue(configid_int_overlay_capture_source) == ovrl_capsource_browser) { ovrl_width = ConfigManager::GetValue(configid_int_overlay_user_width); ovrl_height = ConfigManager::GetValue(configid_int_overlay_user_height); } else { ovrl_width = crop_width + crop_x; ovrl_height = crop_height + crop_y; ConfigManager::SetValue(configid_int_overlay_state_content_width, ovrl_width); ConfigManager::SetValue(configid_int_overlay_state_content_height, ovrl_height); } } } int crop_width_max = ovrl_width - crop_x; int crop_height_max = ovrl_height - crop_y; int crop_width_ui = (crop_width == -1) ? crop_width_max + 1 : crop_width; int crop_height_ui = (crop_height == -1) ? crop_height_max + 1 : crop_height; const bool disable_crop_edit = ((ovrl_width == -1) && (ovrl_height == -1)); const bool is_crop_invalid = ((crop_x > ovrl_width - 1) || (crop_y > ovrl_height - 1) || (crop_width_max < 1) || (crop_height_max < 1)); //--Cropping Area (Draggable Crop Rect) const bool ovrl_size_changed = ((draggable_rect_area_base_size.x != ovrl_width) || (draggable_rect_area_base_size.y != ovrl_height)); const bool base_rect_changed = ((draggable_rect_base_rect.x != crop_x) || (draggable_rect_base_rect.y != crop_y) || (draggable_rect_base_rect.z != crop_width) || (draggable_rect_base_rect.w != crop_height)); if (ovrl_size_changed) { //Figure out sizing for the draggable rect area const float region_width = ImGui::GetContentRegionAvail().x - style.IndentSpacing - 2.0f; //The -2 comes from ceiling the area floats for slight oversizing const float region_height = (UIManager::Get()->IsInDesktopMode()) ? ImGui::GetFontSize() * 16.0f : ImGui::GetFontSize() * 10.5f; if (!disable_crop_edit) { draggable_rect_scale = std::min(region_width / ovrl_width, region_height / ovrl_height); draggable_rect_area = {std::max(8.0f, ceilf(ovrl_width * draggable_rect_scale)), std::max(8.0f, ceilf(ovrl_height * draggable_rect_scale))}; } else //Don't break UI when we can't calculate a rect area { draggable_rect_scale = 1.0f; draggable_rect_area = {region_width, region_height}; } draggable_rect_area_base_size = {(float)ovrl_width, (float)ovrl_height}; } //Detect external changes to the rect and apply to draggable rect (we try to avoid constantly converting back and forth to not fall into float inaccuracy troubles) if (base_rect_changed) { draggable_rect_state.RectPos.x = crop_x * draggable_rect_scale; draggable_rect_state.RectPos.y = crop_y * draggable_rect_scale; draggable_rect_state.RectSize.x = ((crop_width == -1) ? crop_width_max : crop_width) * draggable_rect_scale; draggable_rect_state.RectSize.y = ((crop_height == -1) ? crop_height_max : crop_height) * draggable_rect_scale; draggable_rect_base_rect = {(float)crop_x, (float)crop_y, (float)crop_width, (float)crop_height}; } ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_OvrlPropsCrop)); ImGui::Indent(); ImGui::PushTextWrapPos(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsCropHelp)); ImGui::PopTextWrapPos(); ImGui::SetCursorPosX(ImGui::GetCursorPosX() + (ImGui::GetContentRegionAvail().x / 2.0f) - (draggable_rect_area.x / 2.0f)); if (disable_crop_edit) ImGui::PushItemDisabled(); if (ImGui::DraggableRectArea("DragArea", draggable_rect_area, draggable_rect_state)) { crop_x = clamp((int)floorf(draggable_rect_state.RectPos.x / draggable_rect_scale), 0, ovrl_width - 1); crop_y = clamp((int)floorf(draggable_rect_state.RectPos.y / draggable_rect_scale), 0, ovrl_height - 1); crop_width_max = ovrl_width - crop_x; crop_height_max = ovrl_height - crop_y; crop_width = clamp((int)ceilf(draggable_rect_state.RectSize.x / draggable_rect_scale), 1, crop_width_max); crop_height = clamp((int)ceilf(draggable_rect_state.RectSize.y / draggable_rect_scale), 1, crop_height_max); //Set to max if width/height matches total width (we don't do it partial crops which could still use max values tho) if (crop_width >= ovrl_width) { crop_width = -1; } if (crop_height >= ovrl_height) { crop_height = -1; } IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_crop_width, crop_width); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_crop_height, crop_height); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_crop_x, crop_x); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_crop_y, crop_y); draggable_rect_base_rect = {(float)crop_x, (float)crop_y, (float)crop_width, (float)crop_height}; } if (disable_crop_edit) ImGui::PopItemDisabled(); ImGui::Unindent(); //--Manual Adjustment static int crop_width_before_edit = -1; static int crop_height_before_edit = -1; ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_OvrlPropsCropManualAdjust)); if ( (!disable_crop_edit) && (is_crop_invalid) ) { ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_OvrlPropsCropInvalidTip), "(!)"); } ImGui::Columns(2, "ColumnCrop", false); ImGui::SetColumnWidth(0, m_Column0Width); if (disable_crop_edit) ImGui::PushItemDisabled(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsCropX)); ImGui::NextColumn(); //We need to delay handling the change after checking if it was newly activated in order to have the crop width adjust back automatically when possible vr_keyboard.VRKeyboardInputBegin( ImGui::SliderWithButtonsGetSliderID("CropX") ); const bool crop_x_changed = ImGui::SliderWithButtonsInt("CropX", crop_x, 1, 1, 0, ovrl_width - 1, "%d px"); vr_keyboard.VRKeyboardInputEnd(); if (ImGui::IsItemActivated()) { crop_width_before_edit = crop_width; } if (crop_x_changed) { //Note that we need to clamp the new value as neither the buttons nor the slider on direct input do so (they could, but this is in line with the rest of ImGui) crop_x = clamp(crop_x, 0, ovrl_width - 1); if (crop_x + crop_width_before_edit > ovrl_width) { crop_width = ovrl_width - crop_x; IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_crop_width, crop_width); } else if (crop_width != crop_width_before_edit) { crop_width = crop_width_before_edit; IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_crop_width, crop_width); } IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_crop_x, crop_x); } ImGui::NextColumn(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsCropY)); ImGui::NextColumn(); vr_keyboard.VRKeyboardInputBegin( ImGui::SliderWithButtonsGetSliderID("CropY") ); const bool crop_y_changed = ImGui::SliderWithButtonsInt("CropY", crop_y, 1, 1, 0, ovrl_height - 1, "%d px"); vr_keyboard.VRKeyboardInputEnd(); if (ImGui::IsItemActivated()) { crop_height_before_edit = crop_height; } if (crop_y_changed) { crop_y = clamp(crop_y, 0, ovrl_height - 1); if (crop_y + crop_height_before_edit > ovrl_height) { crop_height = ovrl_height - crop_y; IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_crop_height, crop_height); } else if (crop_height != crop_height_before_edit) { crop_height = crop_height_before_edit; IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_crop_height, crop_height); } IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_crop_y, crop_y); } ImGui::NextColumn(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsCropWidth)); ImGui::NextColumn(); ImGui::SetNextItemWidth(-1); //The way mapping max + 1 == -1 value into the slider is done is a bit convoluted, but it works const char* text_alt_w = (crop_width == -1) ? TranslationManager::GetString(tstr_OvrlPropsAppearanceCropValueMax) : nullptr; vr_keyboard.VRKeyboardInputBegin( ImGui::SliderWithButtonsGetSliderID("CropWidth") ); if (ImGui::SliderWithButtonsInt("CropWidth", crop_width_ui, 1, 1, 1, crop_width_max + 1, (crop_width == -1) ? "" : "%d px", 0, nullptr, text_alt_w)) { crop_width = clamp(crop_width_ui, 1, crop_width_max + 1); if (crop_width_ui > crop_width_max) crop_width = -1; IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_crop_width, crop_width); } vr_keyboard.VRKeyboardInputEnd(); ImGui::NextColumn(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsCropHeight)); ImGui::NextColumn(); ImGui::SetNextItemWidth(-1); const char* text_alt_h = (crop_height == -1) ? TranslationManager::GetString(tstr_OvrlPropsAppearanceCropValueMax) : nullptr; vr_keyboard.VRKeyboardInputBegin( ImGui::SliderWithButtonsGetSliderID("CropHeight") ); if (ImGui::SliderWithButtonsInt("CropHeight", crop_height_ui, 1, 1, 1, crop_height_max + 1, (crop_height == -1) ? "" : "%d px", 0, nullptr, text_alt_h)) { crop_height = clamp(crop_height_ui, 1, crop_height_max + 1); if (crop_height_ui > crop_height_max) crop_height = -1; IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_crop_height, crop_height); } vr_keyboard.VRKeyboardInputEnd(); ImGui::NextColumn(); ImGui::NextColumn(); //Needs dashboard app to be running if ( (ConfigManager::GetValue(configid_int_overlay_capture_source) == ovrl_capsource_desktop_duplication) && (UIManager::Get()->IsOpenVRLoaded()) ) { if (ImGui::Button(TranslationManager::GetString(tstr_OvrlPropsCropToWindow))) { //Have the dashboard app figure out how to do this as the UI doesn't have all data needed at hand IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_crop_to_active_window); WindowInfo window_info(::GetForegroundWindow()); OverlayManager::Get().SetCurrentOverlayNameAuto(&window_info); SetActiveOverlayID(m_ActiveOverlayID); } } if (disable_crop_edit) ImGui::PopItemDisabled(); ImGui::Columns(1); ImGui::SetCursorPosY( ImGui::GetCursorPosY() + (ImGui::GetContentRegionAvail().y - ImGui::GetFrameHeightWithSpacing()) ); //--Confirmation buttons ImGui::Separator(); if (ImGui::Button(TranslationManager::GetString(tstr_DialogOk))) { m_IsConfigDataModified = false; PageGoBack(); //DraggableRectArea() runs into positional flicker from ImGui::GetCursorScreenPos() for one frame when going back from here. //Haven't been able to track down the reason for it (only happens on this button), but the RepeatFrame() bandaid works UIManager::Get()->RepeatFrame(); } ImGui::SameLine(); if (ImGui::Button(TranslationManager::GetString(tstr_DialogCancel))) { PageGoBack(); } ImGui::SameLine(); static float button_reset_width = 0.0f; ImGui::SetCursorPosX(ImGui::GetCursorPosX() + ImGui::GetContentRegionAvail().x - button_reset_width); if (ImGui::Button(TranslationManager::GetString(tstr_OvrlPropsPositionReset))) { if ( (ConfigManager::GetValue(configid_int_overlay_capture_source) != ovrl_capsource_desktop_duplication) || (ConfigManager::GetValue(configid_bool_performance_single_desktop_mirroring)) || (!UIManager::Get()->IsOpenVRLoaded()) ) { crop_x = 0; crop_y = 0; crop_width = -1; crop_height = -1; IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_crop_x, crop_x); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_crop_y, crop_y); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_crop_width, crop_width); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_crop_height, crop_height); } else { //Have the dashboard figure out the right crop by changing the desktop ID to the current value again IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_desktop_id, ConfigManager::GetValue(configid_int_overlay_desktop_id)); } OverlayManager::Get().SetCurrentOverlayNameAuto(); SetActiveOverlayID(m_ActiveOverlayID); } button_reset_width = ImGui::GetItemRectSize().x; } void WindowOverlayProperties::UpdatePageGraphicsCaptureSource(bool only_restore_settings) { int desktop_count = ConfigManager::GetValue(configid_int_state_interface_desktop_count); int& winrt_selected_desktop = ConfigManager::GetRef(configid_int_overlay_winrt_desktop_id); HWND winrt_selected_window = (HWND)ConfigManager::GetValue(configid_handle_overlay_state_winrt_hwnd); bool has_selection_changed = false; bool is_entry_double_clicked = false; if (only_restore_settings) { if (m_IsConfigDataModified) { //Restore previous settings OverlayConfigData& data = OverlayManager::Get().GetCurrentConfigData(); data.ConfigInt[configid_int_overlay_winrt_desktop_id] = m_ConfigDataTemp.ConfigInt[configid_int_overlay_winrt_desktop_id]; data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd] = m_ConfigDataTemp.ConfigHandle[configid_handle_overlay_state_winrt_hwnd]; data.ConfigStr[configid_str_overlay_winrt_last_window_title] = m_ConfigDataTemp.ConfigStr[configid_str_overlay_winrt_last_window_title]; data.ConfigStr[configid_str_overlay_winrt_last_window_class_name] = m_ConfigDataTemp.ConfigStr[configid_str_overlay_winrt_last_window_class_name]; data.ConfigStr[configid_str_overlay_winrt_last_window_exe_name] = m_ConfigDataTemp.ConfigStr[configid_str_overlay_winrt_last_window_exe_name]; data.ConfigNameStr = m_ConfigDataTemp.ConfigNameStr; SetActiveOverlayID(m_ActiveOverlayID); IPCManager::Get().PostConfigMessageToDashboardApp(configid_handle_overlay_state_winrt_hwnd, (LPARAM)data.ConfigHandle[configid_handle_overlay_state_winrt_hwnd]); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_winrt_desktop_id, data.ConfigInt[configid_int_overlay_winrt_desktop_id]); m_IsConfigDataModified = false; } return; } if ( (m_PageAppearing == wndovrlprop_page_graphics_capture_source) && (!m_IsWindowAppearing) ) { m_IsConfigDataModified = true; m_ConfigDataTemp = OverlayManager::Get().GetCurrentConfigData(); } const ImGuiStyle& style = ImGui::GetStyle(); ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_OvrlPropsCaptureGCSource)); ImGui::Indent(); ImGui::SetNextItemWidth(-1.0f); ImGui::BeginChild("SourceList", ImVec2(0.0f, ImGui::GetContentRegionAvail().y - ImGui::GetFrameHeightWithSpacing() - style.ItemSpacing.y), true); ImVec2 img_size_line_height = {ImGui::GetTextLineHeight(), ImGui::GetTextLineHeight()}; ImVec2 img_size, img_uv_min, img_uv_max; //List None ImGui::PushID(-2); if (ImGui::Selectable("", ((winrt_selected_desktop == -2) && (winrt_selected_window == nullptr)))) { has_selection_changed = ((winrt_selected_desktop != -2) || (winrt_selected_window != nullptr)); winrt_selected_desktop = -2; winrt_selected_window = nullptr; ConfigManager::SetValue(configid_handle_overlay_state_winrt_hwnd, 0); ConfigManager::SetValue(configid_str_overlay_winrt_last_window_title, ""); ConfigManager::SetValue(configid_str_overlay_winrt_last_window_class_name, ""); ConfigManager::SetValue(configid_str_overlay_winrt_last_window_exe_name, ""); ConfigManager::SetValue(configid_handle_overlay_state_winrt_last_hicon, 0); OverlayManager::Get().SetCurrentOverlayNameAuto(); SetActiveOverlayID(m_ActiveOverlayID); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_winrt_desktop_id, winrt_selected_desktop); IPCManager::Get().PostConfigMessageToDashboardApp(configid_handle_overlay_state_winrt_hwnd, 0); UIManager::Get()->RepeatFrame(); } if ((!has_selection_changed) && (ImGui::IsItemClicked()) && (ImGui::IsMouseDoubleClicked(ImGuiMouseButton_Left))) { is_entry_double_clicked = true; } ImGui::SameLine(0.0f, 0.0f); TextureManager::Get().GetTextureInfo(tmtex_icon_xsmall_desktop_none, img_size, img_uv_min, img_uv_max); ImGui::Image(ImGui::GetIO().Fonts->TexID, img_size_line_height, img_uv_min, img_uv_max); ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SourceWinRTNone)); ImGui::PopID(); ImGui::Separator(); //List Combined desktop, if supported if (DPWinRT_IsCaptureFromCombinedDesktopSupported()) { ImGui::PushID(-1); if (ImGui::Selectable("", (winrt_selected_desktop == -1))) { has_selection_changed = (winrt_selected_desktop != -1); winrt_selected_desktop = -1; winrt_selected_window = nullptr; ConfigManager::SetValue(configid_handle_overlay_state_winrt_hwnd, 0); ConfigManager::SetValue(configid_str_overlay_winrt_last_window_title, ""); ConfigManager::SetValue(configid_str_overlay_winrt_last_window_class_name, ""); ConfigManager::SetValue(configid_str_overlay_winrt_last_window_exe_name, ""); ConfigManager::SetValue(configid_handle_overlay_state_winrt_last_hicon, 0); OverlayManager::Get().SetCurrentOverlayNameAuto(); SetActiveOverlayID(m_ActiveOverlayID); IPCManager::Get().PostConfigMessageToDashboardApp(configid_handle_overlay_state_winrt_hwnd, 0); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_winrt_desktop_id, winrt_selected_desktop); UIManager::Get()->RepeatFrame(); } if ((!has_selection_changed) && (ImGui::IsItemClicked()) && (ImGui::IsMouseDoubleClicked(ImGuiMouseButton_Left))) { is_entry_double_clicked = true; } ImGui::SameLine(0.0f, 0.0f); TextureManager::Get().GetTextureInfo(tmtex_icon_xsmall_desktop_all, img_size, img_uv_min, img_uv_max); ImGui::Image(ImGui::GetIO().Fonts->TexID, img_size_line_height, img_uv_min, img_uv_max); ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SourceDesktopAll)); ImGui::PopID(); } //List desktops for (int i = 0; i < desktop_count; ++i) { ImGui::PushID(i); if (ImGui::Selectable("", (winrt_selected_desktop == i))) { has_selection_changed = (winrt_selected_desktop == i); winrt_selected_desktop = i; winrt_selected_window = nullptr; ConfigManager::SetValue(configid_handle_overlay_state_winrt_hwnd, 0); ConfigManager::SetValue(configid_str_overlay_winrt_last_window_title, ""); ConfigManager::SetValue(configid_str_overlay_winrt_last_window_class_name, ""); ConfigManager::SetValue(configid_str_overlay_winrt_last_window_exe_name, ""); ConfigManager::SetValue(configid_handle_overlay_state_winrt_last_hicon, 0); OverlayManager::Get().SetCurrentOverlayNameAuto(); SetActiveOverlayID(m_ActiveOverlayID); IPCManager::Get().PostConfigMessageToDashboardApp(configid_handle_overlay_state_winrt_hwnd, 0); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_winrt_desktop_id, winrt_selected_desktop); UIManager::Get()->RepeatFrame(); } if ((!has_selection_changed) && (ImGui::IsItemClicked()) && (ImGui::IsMouseDoubleClicked(ImGuiMouseButton_Left))) { is_entry_double_clicked = true; } ImGui::SameLine(0.0f, 0.0f); const TMNGRTexID texid = (tmtex_icon_desktop_1 + i <= tmtex_icon_desktop_6) ? (TMNGRTexID)(tmtex_icon_xsmall_desktop_1 + i) : tmtex_icon_xsmall_desktop; TextureManager::Get().GetTextureInfo(texid, img_size, img_uv_min, img_uv_max); ImGui::Image(ImGui::GetIO().Fonts->TexID, img_size_line_height, img_uv_min, img_uv_max); ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); ImGui::TextUnformatted(TranslationManager::Get().GetDesktopIDString(i)); ImGui::PopID(); } ImGui::Separator(); //List windows for (const auto& window_info : WindowManager::Get().WindowListGet()) { ImGui::PushID(window_info.GetWindowHandle()); if (ImGui::Selectable("", (winrt_selected_window == window_info.GetWindowHandle()))) { has_selection_changed = (winrt_selected_window != window_info.GetWindowHandle()); winrt_selected_desktop = -2; winrt_selected_window = window_info.GetWindowHandle(); ConfigManager::SetValue(configid_handle_overlay_state_winrt_hwnd, (uint64_t)winrt_selected_window); ConfigManager::SetValue(configid_str_overlay_winrt_last_window_title, StringConvertFromUTF16(window_info.GetTitle().c_str())); //No need to sync these ConfigManager::SetValue(configid_str_overlay_winrt_last_window_class_name, StringConvertFromUTF16(window_info.GetWindowClassName().c_str())); ConfigManager::SetValue(configid_str_overlay_winrt_last_window_exe_name, window_info.GetExeName()); OverlayManager::Get().SetCurrentOverlayNameAuto(); SetActiveOverlayID(m_ActiveOverlayID); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_overlay_winrt_desktop_id, -2); IPCManager::Get().PostConfigMessageToDashboardApp(configid_handle_overlay_state_winrt_hwnd, (LPARAM)winrt_selected_window); UIManager::Get()->RepeatFrame(); } if ((!has_selection_changed) && (ImGui::IsItemClicked()) && (ImGui::IsMouseDoubleClicked(ImGuiMouseButton_Left))) { is_entry_double_clicked = true; } ImGui::SameLine(0.0f, 0.0f); int icon_id = TextureManager::Get().GetWindowIconCacheID(window_info.GetIcon()); if (icon_id != -1) { TextureManager::Get().GetWindowIconTextureInfo(icon_id, img_size, img_uv_min, img_uv_max); ImGui::Image(ImGui::GetIO().Fonts->TexID, img_size_line_height, img_uv_min, img_uv_max); ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); } ImGui::TextUnformatted(window_info.GetListTitle().c_str()); ImGui::PopID(); } ImGui::EndChild(); ImGui::Unindent(); ImGui::SetCursorPosY(ImGui::GetCursorPosY() + (ImGui::GetContentRegionAvail().y - ImGui::GetFrameHeight())); //--Confirmation buttons //No separator since this is right after a boxed child window if ((ImGui::Button(TranslationManager::GetString(tstr_DialogOk))) || (is_entry_double_clicked)) { m_IsConfigDataModified = false; //Stops reset from being triggered on page leave PageGoBack(); } ImGui::SameLine(); if (ImGui::Button(TranslationManager::GetString(tstr_DialogCancel))) { PageGoBack(); } } void WindowOverlayProperties::UpdatePageActionsOrder(bool only_restore_settings) { static FloatingWindowActionOrderListState page_state; OverlayConfigData& data = OverlayManager::Get().GetCurrentConfigData(); if (only_restore_settings) { if (!page_state.HasSavedChanges) { data.ConfigActionBarOrder = page_state.ActionListOrig; } return; } const float height_offset = (UIManager::Get()->IsInDesktopMode()) ? -UIManager::Get()->GetSettingsWindow().DesktopModeGetWarningHeight() : 0.0f; bool go_add_actions = false; bool go_back = ActionOrderList(data.ConfigActionBarOrder, (m_PageAppearing == wndovrlprop_page_actions_order), (m_PageReturned == wndovrlprop_page_actions_order_add), page_state, go_add_actions, height_offset); if (m_PageReturned == wndovrlprop_page_actions_order_add) { m_PageReturned = wndovrlprop_page_none; } if (go_add_actions) { PageGoForward(wndovrlprop_page_actions_order_add); } else if (go_back) { PageGoBack(); } } void WindowOverlayProperties::UpdatePageActionsOrderAdd() { static FloatingWindowActionAddSelectorState page_state; OverlayConfigData& data = OverlayManager::Get().GetCurrentConfigData(); bool go_back = ActionAddSelector(data.ConfigActionBarOrder, (m_PageAppearing == wndovrlprop_page_actions_order_add), page_state); if (go_back) { PageGoBack(); } } std::string WindowOverlayProperties::GetStringForWinRTSource(HWND source_window, int source_desktop) { std::string source_str; if (source_window == nullptr) { switch (source_desktop) { case -2: source_str = TranslationManager::GetString(tstr_SourceWinRTNone); break; default: source_str = TranslationManager::Get().GetDesktopIDString(source_desktop); } } else { const auto& window_list = WindowManager::Get().WindowListGet(); const auto it = std::find_if(window_list.begin(), window_list.end(), [&](const auto& window) { return (window.GetWindowHandle() == source_window); }); if ( (it != window_list.end()) && (::IsWindow(source_window)) ) { source_str = it->GetListTitle(); } else { const std::string& last_title = ConfigManager::GetValue(configid_str_overlay_winrt_last_window_title); source_str = (last_title.empty()) ? TranslationManager::GetString(tstr_SourceWinRTUnknown) : TranslationManager::GetString(tstr_SourceWinRTClosed) + std::string(" " + last_title); } } return source_str; } void WindowOverlayProperties::PageGoForward(WindowOverlayPropertiesPage new_page) { //We can't just mess with the stack while a backwards animation is going, so we save this for later if (m_PageAnimationDir == 1) { m_PageStackPending.push_back(new_page); return; } m_PageStack.push_back(new_page); m_PageStackPos++; } void WindowOverlayProperties::PageGoBack() { if (m_PageStackPos != 0) { OnPageLeaving(m_PageStack[m_PageStackPos]); m_PageStackPos--; m_PageReturned = m_PageStack.back(); } } void WindowOverlayProperties::PageGoHome(bool skip_animation) { while (m_PageStackPos != 0) { OnPageLeaving(m_PageStack[m_PageStackPos]); m_PageStackPos--; } if (skip_animation) { m_PageStackPosAnimation = m_PageStackPos; m_PageAnimationOffset = 0.0f; while (m_PageStack.size() > 1) { m_PageStack.pop_back(); } } } void WindowOverlayProperties::PageFadeStart(unsigned int overlay_id) { m_PageFadeDir = -1; //Needed in any case for SetActiveOverlayID() if (m_OverlayStateCurrent->IsVisible) { m_PageFadeTargetOverlayID = overlay_id; } else //Not visible, skip fade { SetActiveOverlayID(overlay_id); //Calls PageGoHome() for us m_PageFadeAlpha = 1.0f; m_PageFadeDir = 0; } } void WindowOverlayProperties::OnPageLeaving(WindowOverlayPropertiesPage previous_page) { switch (previous_page) { case wndovrlprop_page_position_change: { //Disable dragmode when leaving page ConfigManager::SetValue(configid_bool_state_overlay_dragmode, false); IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_state_overlay_dragselectmode_show_hidden, false); IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_state_overlay_dragmode, false); UpdatePagePositionChange(true); //Call to reset settings break; } case wndovrlprop_page_crop_change: { m_CropButtonLabel = ""; UpdatePageCropChange(true); //Call to reset settings break; } case wndovrlprop_page_graphics_capture_source: { m_WinRTSourceButtonLabel = ""; UpdatePageGraphicsCaptureSource(true); //Call to reset settings break; } default: break; } } ================================================ FILE: src/DesktopPlusUI/WindowOverlayProperties.h ================================================ #pragma once #include "FloatingWindow.h" #include "WindowDesktopMode.h" enum WindowOverlayPropertiesPage { wndovrlprop_page_none, wndovrlprop_page_main, wndovrlprop_page_position_change, wndovrlprop_page_crop_change, wndovrlprop_page_graphics_capture_source, wndovrlprop_page_actions_order, wndovrlprop_page_actions_order_add, }; class WindowOverlayProperties : public FloatingWindow, public FloatingWindowDesktopModeInterop { private: std::vector m_PageStack; std::vector m_PageStackPending; //Stores pending page forward calls that they were requested during an active backwards animation int m_PageStackPos; int m_PageStackPosAnimation; WindowOverlayPropertiesPage m_PageAppearing; //Similar to ImGui::IsWindowAppearing(), equals the current page ID for a single frame if it or the window is newly appearing WindowOverlayPropertiesPage m_PageReturned; //Equals the previous page ID after PageGoBack() was called, ideally cleared after making use of its value int m_PageAnimationDir; float m_PageAnimationProgress; float m_PageAnimationStartPos; float m_PageAnimationOffset; int m_PageFadeDir; float m_PageFadeAlpha; unsigned int m_PageFadeTargetOverlayID; unsigned int m_ActiveOverlayID; float m_Column0Width; OverlayConfigData m_ConfigDataTemp; //Stores config data used for restoring when a page is canceled bool m_IsConfigDataModified; //Set to true on page enter and cleared when a page is saving data float m_OriginHMDFloorSettingsAnimationProgress; float m_OriginHMDSettingsAnimationProgress; float m_OriginTheaterScreenSettingsAnimationProgress; float m_PerfMonStyleCheckboxAnimationProgress; std::string m_CropButtonLabel; std::string m_WinRTSourceButtonLabel; std::string m_ActionButtonsLabel; std::string m_BrowserMaxFPSValueText; char m_BufferOverlayName[1024]; char m_BufferOverlayTags[1024]; bool m_IsBrowserURLChanged; //Struct of cached sizes which may change at any time on translation or DPI switching (only the ones that aren't updated unconditionally) struct { float MainCatCapture_WinRTSourceLabelWidth = 0.0f; float PositionChange_Column0Width = 0.0f; float PositionChange_ButtonWidth = 0.0f; } m_CachedSizes; virtual void WindowUpdate(); void OverlayPositionReset(); void UpdatePageMain(); void UpdatePageMainCatPosition(); void UpdatePageMainCatAppearance(); void UpdatePageMainCatCapture(); void UpdatePageMainCatPerformanceMonitor(); void UpdatePageMainCatBrowser(); void UpdatePageMainCatAdvanced(); void UpdatePageMainCatPerformance(); void UpdatePageMainCatInterface(); void UpdatePagePositionChange(bool only_restore_settings = false); void UpdatePageCropChange(bool only_restore_settings = false); void UpdatePageGraphicsCaptureSource(bool only_restore_settings = false); void UpdatePageActionsOrder(bool only_restore_settings = false); void UpdatePageActionsOrderAdd(); std::string GetStringForWinRTSource(HWND source_window, int source_desktop); void PageGoForward(WindowOverlayPropertiesPage new_page); void PageGoBack(); void PageGoHome(bool skip_animation = false); void PageFadeStart(unsigned int overlay_id); void OnPageLeaving(WindowOverlayPropertiesPage previous_page); //Called from PageGoBack() and PageGoHome() to allow for page-specific cleanup if necessary public: WindowOverlayProperties(); virtual void Show(bool skip_fade = false); virtual void Hide(bool skip_fade = false); virtual void ResetTransform(FloatingWindowOverlayStateID state_id); virtual vr::VROverlayHandle_t GetOverlayHandle() const; virtual void ApplyUIScale(); unsigned int GetActiveOverlayID() const; void SetActiveOverlayID(unsigned int overlay_id, bool skip_fade = false); //Call with same as active ID to refresh window title and icon void UpdateDesktopMode(); virtual const char* DesktopModeGetTitle() const; virtual bool DesktopModeGetIconTextureInfo(ImVec2& size, ImVec2& uv_min, ImVec2& uv_max) const; virtual float DesktopModeGetTitleIconAlpha() const; virtual void DesktopModeOnTitleIconClick(); virtual void DesktopModeOnTitleBarHover(bool is_hovered); virtual bool DesktopModeGoBack(); void MarkBrowserURLChanged(); }; ================================================ FILE: src/DesktopPlusUI/WindowPerformance.cpp ================================================ #include "WindowPerformance.h" #include #include #include "implot.h" #include "ImGuiExt.h" #include "TextureManager.h" #include "InterprocessMessaging.h" #include "Util.h" #include "OpenVRExt.h" #include "UIManager.h" #include "OverlayManager.h" static LPCWSTR const g_ViveWirelessLogPathBase = L"%ProgramData%\\VIVE Wireless\\ConnectionUtility\\Log\\"; WindowPerformance::WindowPerformance() : m_Visible(false), m_VisibleTickLast(0), m_IsPopupOpen(false), m_MinimalItemLineWrapMaxLength(FLT_MAX), m_MinimalItemLineWrapPrevX(0.0f), m_PIDLast(0), m_OffsetFrameIndex(0), m_OffsetFramesPresents(0), m_OffsetReprojectedFrames(0), m_OffsetDroppedFrames(0), m_FrameTimeCPU(0.0f), m_FrameTimeGPU(0.0f), m_ReprojectionRatio(0.0f), m_DroppedFrames(0), m_BatteryHMD(-1.0f), m_BatteryLeft(-1.0f), m_BatteryRight(-1.0f), m_FrameTimeLastIndex(0), m_ViveWirelessTemp(-1), m_ViveWirelessLogFileLastLine(0), m_IsOverlaySharedTextureUpdateNeeded(false) { ResetCumulativeValues(); //Set m_TimeLast to something invalid so the first time always counts as different m_TimeLast = {0}; m_TimeLast.wHour = 99; m_TimeLast.wMinute = 99; //Expand path for Vive Wireless log files wchar_t wpath[MAX_PATH] = L"\0"; ::ExpandEnvironmentStrings(g_ViveWirelessLogPathBase, wpath, MAX_PATH); m_ViveWirelessLogPath = wpath; m_ViveWirelessLogPathExists = DirectoryExists(wpath); } void WindowPerformance::Update(bool show_as_popup) { ImGuiIO& io = ImGui::GetIO(); const ImGuiStyle& style = ImGui::GetStyle(); const DPRect& tex_rect = UITextureSpaces::Get().GetRect(ui_texspace_performance_monitor); ImGui::SetNextWindowSizeConstraints({0.0f, 0.0f}, {(float)tex_rect.GetWidth() - 1, (float)tex_rect.GetHeight() - 1}); const ImGuiWindowFlags flags_extra = (!ConfigManager::GetValue(configid_bool_performance_monitor_style_show_window)) ? ImGuiWindowFlags_NoBackground | ImGuiWindowFlags_NoDecoration : 0; if (show_as_popup) { //Don't update values when repeating the frame if (!UIManager::Get()->GetRepeatFrame()) { UpdateStatValues(); } //Set popup rounding to the same as a normal window ImGui::PushStyleVar(ImGuiStyleVar_PopupRounding, style.WindowRounding); bool is_popup_rounding_pushed = true; const bool ui_large_style = ((ConfigManager::GetValue(configid_bool_interface_large_style)) && (!UIManager::Get()->IsInDesktopMode())); if (ui_large_style) { ImGui::PushFont(UIManager::Get()->GetFontCompact()); } ImGui::SetNextWindowPos({io.DisplaySize.x * 0.5f, io.DisplaySize.y * 0.5f}, ImGuiCond_Always, ImVec2(0.5f, 0.5f)); if (ImGui::BeginPopup("PopupPerformanceMonitor", ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_NoScrollbar | flags_extra)) { ImGui::PopStyleVar(); //ImGuiStyleVar_PopupRounding is_popup_rounding_pushed = false; if (ImGui::IsWindowAppearing()) { UIManager::Get()->RepeatFrame(); } if (ConfigManager::GetValue(configid_bool_performance_monitor_large_style)) { DisplayStatsLarge(); } else if (ConfigManager::GetValue(configid_bool_performance_monitor_minimal_style)) { DisplayStatsMinimal(); } else { DisplayStatsCompact(); } ImGui::EndPopup(); } if (ui_large_style) { ImGui::PopFont(); } if (is_popup_rounding_pushed) { ImGui::PopStyleVar(); //ImGuiStyleVar_PopupRounding } } else { if (!m_Visible) return; //Don't update values when repeating the frame if (!UIManager::Get()->GetRepeatFrame()) { UpdateStatValues(); CheckScheduledOverlaySharedTextureUpdate(); } //Center in overlay space const DPRect& rect = UITextureSpaces::Get().GetRect(ui_texspace_performance_monitor); ImGui::SetNextWindowPos(ImVec2((float)rect.GetCenter().x, (float)rect.GetCenter().y), 0, ImVec2(0.5f, 0.5f)); ImGui::Begin("WindowPerformance", nullptr, ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoFocusOnAppearing | ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_NoScrollbar | flags_extra); if (ConfigManager::GetValue(configid_bool_performance_monitor_large_style)) { DisplayStatsLarge(); } else if (ConfigManager::GetValue(configid_bool_performance_monitor_minimal_style)) { DisplayStatsMinimal(); } else { DisplayStatsCompact(); } //Store window bounds and update affected overlays if they changed ImVec2 pos_new = ImGui::GetWindowPos(); ImVec2 size_new = ImGui::GetWindowSize(); if ((pos_new.x != m_Pos.x) || (pos_new.y != m_Pos.y) || (size_new.x != m_Size.x) || (size_new.y != m_Size.y)) { m_Pos = pos_new; m_Size = size_new; OnWindowBoundsChanged(); } ImGui::End(); } } void WindowPerformance::UpdateVisibleState() { bool was_visible = m_Visible; m_Visible = ( (m_IsPopupOpen) || (IsAnyOverlayUsingPerformanceMonitor()) ); if (m_Visible) { if (!was_visible) { m_PerfData.EnableCounters(!ConfigManager::GetValue(configid_bool_performance_monitor_disable_gpu_counters)); } } else { if (was_visible) { m_VisibleTickLast = ::GetTickCount64(); } else if (m_VisibleTickLast + 3000 <= ::GetTickCount64()) //Only actually disable counters after at least 3 seconds of being hidden { m_PerfData.DisableCounters(); } } } void WindowPerformance::PerfMonText(const char* fmt, ...) { va_list args; va_start(args, fmt); ConfigManager::GetValue(configid_bool_performance_monitor_style_show_text_outline) ? ImGui::TextOutlinedV(fmt, args) : ImGui::TextV(fmt, args); va_end(args); } void WindowPerformance::PerfMonTextUnformatted(const char* text, const char* text_end) { ConfigManager::GetValue(configid_bool_performance_monitor_style_show_text_outline) ? ImGui::TextUnformattedOutlined(text, text_end) : ImGui::TextUnformatted(text, text_end); } void WindowPerformance::PerfMonTextRight(float offset_x, float fixed_w, const char* fmt, ...) { va_list args; va_start(args, fmt); ConfigManager::GetValue(configid_bool_performance_monitor_style_show_text_outline) ? ImGui::TextRightOutlinedV(offset_x, fixed_w, fmt, args) : ImGui::TextRightV(offset_x, fixed_w, fmt, args); va_end(args); } void WindowPerformance::PerfMonTextRightUnformatted(float offset_x, float fixed_w, const char* text, const char* text_end) { ConfigManager::GetValue(configid_bool_performance_monitor_style_show_text_outline) ? ImGui::TextRightUnformattedOutlined(offset_x, fixed_w, text, text_end) : ImGui::TextRightUnformatted(offset_x, fixed_w, text, text_end); } void WindowPerformance::StatsMinimalItemLineWrap() { //Poor man's widget line-wrap //We take advantage of being able to just toss a frame away if we're not happy and avoid calculating the size of each stat item //Instead we just check if the last widget got clipped, and in that case store the starting position and use that as the max allowed starting pos before a line break //Far from perfect, especially since there's no mechanism to reset the max length, but it does the job to provide a way to still display what is too many items anyways const ImGuiStyle style = ImGui::GetStyle(); const DPRect& tex_rect = UITextureSpaces::Get().GetRect(ui_texspace_performance_monitor); const float max_window_content_x = (float)tex_rect.GetWidth() - 1.0f - style.WindowPadding.x + ImGui::GetWindowPos().x; if (ImGui::GetItemRectMax().x > max_window_content_x) { m_MinimalItemLineWrapMaxLength = m_MinimalItemLineWrapPrevX; UIManager::Get()->RepeatFrame(); return; } else if (ImGui::GetCursorPosX() >= m_MinimalItemLineWrapMaxLength) { ImGui::SetCursorPosX(ImGui::GetCursorPosX() - ImGui::GetStyle().ItemSpacing.x); ImGui::NewLine(); } //Could use item groups but this way works to leave the way the window is laid out mostly untouched m_MinimalItemLineWrapPrevX = ImGui::GetCursorPosX() - ImGui::GetStyle().ItemSpacing.x; } void WindowPerformance::DisplayStatsLarge() { const ImGuiStyle& style = ImGui::GetStyle(); const float column_width_0 = ImGui::GetFontSize() * 7.5f; const float column_width_1 = ImGui::GetFontSize() * 4.0f; const float column_width_3 = ImGui::GetFontSize() * 6.0f; const ImVec2 graph_size = {column_width_0 + column_width_3 - style.WindowPadding.x, ImGui::GetFontSize() * 2.0f}; static float row_gpu_y = 0.0f; //Both graphs are being created outside of the normal widget flow, due to how they span multiple rows and columns, which isn't exactly supported by ImGui's columns //Shared offsets ImVec2 cursor_pos_prev = ImGui::GetCursorPos(); float graph_pos_x = cursor_pos_prev.x + column_width_0 + column_width_1 - style.FramePadding.x; double plot_xmin = (m_FrameTimeLastIndex > (uint32_t)m_FrameTimeCPUHistory.MaxSize) ? m_FrameTimeLastIndex - m_FrameTimeCPUHistory.MaxSize + 0.5f : 0.5f; double plot_xmax = m_FrameTimeLastIndex - 0.5f; double plot_ymax = ceilf(m_FrameTimeVsyncLimit * 1.4f); //Set fixed window width from graph cursor pos even if all graphs are disabled since columns don't increase the window size ImGui::SetCursorPos({graph_pos_x, cursor_pos_prev.y + style.FramePadding.y}); ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, {0.0f, 0.0f}); ImGui::Dummy({graph_size.x, 0.0f}); ImGui::PopStyleVar(); ImGui::SetCursorPos({graph_pos_x, cursor_pos_prev.y + style.FramePadding.y}); if (ConfigManager::GetValue(configid_bool_performance_monitor_show_graphs)) { //-CPU Frame Time Graph if (ConfigManager::GetValue(configid_bool_performance_monitor_show_cpu)) { DrawFrameTimeGraphCPU(graph_size, plot_xmin, plot_xmax, plot_ymax); } //-GPU Frame Time Graph if (ConfigManager::GetValue(configid_bool_performance_monitor_show_gpu)) { ImGui::SetCursorPos({graph_pos_x, row_gpu_y + style.FramePadding.y}); DrawFrameTimeGraphGPU(graph_size, plot_xmin, plot_xmax, plot_ymax); } } ImGui::SetCursorPos(cursor_pos_prev); //Store text width of units for right alignment //This is required since the text width can be off by one pixel on certain values if the units are rendered as part of the formatted string... odd but whatever static const float text_ms_width = ImGui::CalcTextSize(" ms").x; static const float text_percent_width = ImGui::CalcTextSize("%").x; static const float text_temp_width = ImGui::CalcTextSize("\xC2\xB0""C").x; float item_spacing_half = style.ItemSpacing.x / 2.0f; float frame_time_warning_limit = m_FrameTimeVsyncLimit * 0.95f; ImGui::Columns(4, "ColumnStatsLarge", false); ImGui::SetColumnWidth(0, column_width_0); ImGui::SetColumnWidth(1, column_width_1); ImGui::SetColumnWidth(2, column_width_0); ImGui::SetColumnWidth(3, column_width_3); float right_border_offset = -style.FramePadding.x; //--Table CPU if (ConfigManager::GetValue(configid_bool_performance_monitor_show_cpu)) { ImGui::PushStyleColor(ImGuiCol_Text, ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered)); PerfMonTextUnformatted(TranslationManager::GetString(tstr_PerformanceMonitorCPU)); ImGui::PopStyleColor(); ImGui::NextColumn(); ImGui::NextColumn(); ImGui::NextColumn(); ImGui::NextColumn(); //-CPU Frame Time PerfMonTextUnformatted(TranslationManager::GetString(tstr_PerformanceMonitorFrameTime)); ImGui::NextColumn(); //Warning color when frame time above 95% vsync time if (m_FrameTimeCPU > frame_time_warning_limit) ImGui::PushStyleColor(ImGuiCol_Text, Style_ImGuiCol_TextWarning); PerfMonTextRight(text_ms_width, 0.0f, "%.2f", m_FrameTimeCPU); ImGui::SameLine(0.0f, 0.0f); PerfMonTextUnformatted(" ms"); if (m_FrameTimeCPU > frame_time_warning_limit) ImGui::PopStyleColor(); ImGui::NextColumn(); ImGui::NextColumn(); ImGui::NextColumn(); //-CPU Load PerfMonTextUnformatted(TranslationManager::GetString(tstr_PerformanceMonitorLoad)); ImGui::NextColumn(); PerfMonTextRight(text_percent_width, 0.0f, "%.2f", m_PerfData.GetCPULoadPrecentage()); ImGui::SameLine(0.0f, 0.0f); PerfMonTextUnformatted("%"); ImGui::NextColumn(); //-RAM ImGui::SetCursorPosX(ImGui::GetCursorPosX() - item_spacing_half); //Reduce horizontal spacing PerfMonTextUnformatted(TranslationManager::GetString(tstr_PerformanceMonitorRAM)); ImGui::NextColumn(); //Right align PerfMonTextRight(right_border_offset - 1.0f, 0.0f, "%.2f/%.2f GB", m_PerfData.GetRAMUsedGB(), m_PerfData.GetRAMTotalGB()); ImGui::NextColumn(); } //--Table GPU if (ConfigManager::GetValue(configid_bool_performance_monitor_show_gpu)) { row_gpu_y = ImGui::GetCursorPosY(); ImGui::PushStyleColor(ImGuiCol_Text, ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered)); PerfMonTextUnformatted(TranslationManager::GetString(tstr_PerformanceMonitorGPU)); ImGui::PopStyleColor(); ImGui::NextColumn(); ImGui::NextColumn(); ImGui::NextColumn(); ImGui::NextColumn(); //-GPU Frame Time PerfMonTextUnformatted(TranslationManager::GetString(tstr_PerformanceMonitorFrameTime)); ImGui::NextColumn(); if (m_FrameTimeGPU > frame_time_warning_limit) ImGui::PushStyleColor(ImGuiCol_Text, Style_ImGuiCol_TextWarning); PerfMonTextRight(text_ms_width, 0.0f, "%.2f", m_FrameTimeGPU); ImGui::SameLine(0.0f, 0.0f); PerfMonTextUnformatted(" ms"); ImGui::NextColumn(); if (m_FrameTimeGPU > frame_time_warning_limit) ImGui::PopStyleColor(); ImGui::NextColumn(); ImGui::NextColumn(); if (!ConfigManager::GetValue(configid_bool_performance_monitor_disable_gpu_counters)) //No point in showing it all if it's not updating { //-GPU Load PerfMonTextUnformatted(TranslationManager::GetString(tstr_PerformanceMonitorLoad)); ImGui::NextColumn(); PerfMonTextRight(text_percent_width, 0.0f, "%.2f", m_PerfData.GetGPULoadPrecentage()); ImGui::SameLine(0.0f, 0.0f); PerfMonTextUnformatted("%"); ImGui::NextColumn(); //-VRAM ImGui::SetCursorPosX(ImGui::GetCursorPosX() - item_spacing_half); //Reduce horizontal spacing PerfMonTextUnformatted(TranslationManager::GetString(tstr_PerformanceMonitorVRAM)); ImGui::NextColumn(); PerfMonTextRight(right_border_offset - 1.0f, 0.0f, "%.2f/%.2f GB", m_PerfData.GetVRAMUsedGB(), m_PerfData.GetVRAMTotalGB()); ImGui::NextColumn(); } } //-Table SteamVR if ( (ConfigManager::GetValue(configid_bool_performance_monitor_show_fps)) || (ConfigManager::GetValue(configid_bool_performance_monitor_show_battery)) ) { ImGui::PushStyleColor(ImGuiCol_Text, ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered)); PerfMonTextUnformatted("SteamVR"); ImGui::PopStyleColor(); ImGui::NextColumn(); ImGui::NextColumn(); ImGui::NextColumn(); //-Time if (ConfigManager::GetValue(configid_bool_performance_monitor_show_time)) { PerfMonTextRightUnformatted(right_border_offset, 0.0f, m_TimeStr.c_str()); } ImGui::NextColumn(); if (ConfigManager::GetValue(configid_bool_performance_monitor_show_fps)) { //-FPS PerfMonTextUnformatted(TranslationManager::GetString(tstr_PerformanceMonitorFPS)); ImGui::NextColumn(); PerfMonTextRight(0.0f, 0.0f, "%d", m_FPS); ImGui::NextColumn(); //-Average FPS ImGui::SetCursorPosX(ImGui::GetCursorPosX() - item_spacing_half); //Reduce horizontal spacing PerfMonTextUnformatted(TranslationManager::GetString(tstr_PerformanceMonitorFPSAverage)); ImGui::NextColumn(); PerfMonTextRight(right_border_offset, 0.0f, "%.2f", m_FPS_Average); ImGui::NextColumn(); //No VR app means no frame statistics (FPS still gets counted, though) if (m_PIDLast == 0) ImGui::PushItemDisabled(); //-Reprojection Ratio PerfMonTextUnformatted(TranslationManager::GetString(tstr_PerformanceMonitorReprojectionRatio)); ImGui::NextColumn(); PerfMonTextRight(text_percent_width, 0.0f, "%.2f", m_ReprojectionRatio); ImGui::SameLine(0.0f, 0.0f); PerfMonTextUnformatted("%"); ImGui::NextColumn(); //-Dropped Frames ImGui::SetCursorPosX(ImGui::GetCursorPosX() - item_spacing_half); //Reduce horizontal spacing PerfMonTextUnformatted(TranslationManager::GetString(tstr_PerformanceMonitorDroppedFrames)); ImGui::NextColumn(); PerfMonTextRight(right_border_offset, 0.0f, "%u", m_DroppedFrames); ImGui::NextColumn(); if (m_PIDLast == 0) ImGui::PopItemDisabled(); } if (ConfigManager::GetValue(configid_bool_performance_monitor_show_battery)) { //-Battery Left PerfMonTextUnformatted(TranslationManager::GetString(tstr_PerformanceMonitorBatteryLeft)); ImGui::NextColumn(); if (m_BatteryLeft != -1.0f) { //15% warning color (Same percentage the SteamVR dashboard battery icon goes red at) if (m_BatteryLeft < 15.0f) ImGui::PushStyleColor(ImGuiCol_Text, Style_ImGuiCol_TextWarning); PerfMonTextRight(text_percent_width, 0.0f, "%.0f", m_BatteryLeft); ImGui::SameLine(0.0f, 0.0f); PerfMonTextUnformatted("%"); ImGui::NextColumn(); if (m_BatteryLeft < 15.0f) ImGui::PopStyleColor(); } else { ImGui::PushItemDisabled(); PerfMonTextRightUnformatted(0.0f, 0.0f, TranslationManager::GetString(tstr_PerformanceMonitorBatteryDisconnected)); ImGui::NextColumn(); ImGui::PopItemDisabled(); } //-Battery Right ImGui::SetCursorPosX(ImGui::GetCursorPosX() - item_spacing_half); //Reduce horizontal spacing PerfMonTextUnformatted(TranslationManager::GetString(tstr_PerformanceMonitorBatteryRight)); ImGui::NextColumn(); if (m_BatteryRight != -1.0f) { //15% warning color if (m_BatteryRight < 15.0f) ImGui::PushStyleColor(ImGuiCol_Text, Style_ImGuiCol_TextWarning); PerfMonTextRight(text_percent_width + right_border_offset, 0.0f, "%.0f", m_BatteryRight); ImGui::SameLine(0.0f, 0.0f); PerfMonTextUnformatted("%"); ImGui::NextColumn(); if (m_BatteryRight < 15.0f) ImGui::PopStyleColor(); } else { ImGui::PushItemDisabled(); PerfMonTextRightUnformatted(right_border_offset, 0.0f, TranslationManager::GetString(tstr_PerformanceMonitorBatteryDisconnected)); ImGui::NextColumn(); ImGui::PopItemDisabled(); } //-Battery HMD (only shown if available) if (m_BatteryHMD != -1.0f) { PerfMonTextUnformatted(TranslationManager::GetString(tstr_PerformanceMonitorBatteryHMD)); ImGui::NextColumn(); //15% warning color if (m_BatteryHMD < 15.0f) ImGui::PushStyleColor(ImGuiCol_Text, Style_ImGuiCol_TextWarning); PerfMonTextRight(text_percent_width, 0.0f, "%.0f", m_BatteryHMD); ImGui::SameLine(0.0f, 0.0f); PerfMonTextUnformatted("%"); ImGui::NextColumn(); if (m_BatteryHMD < 15.0f) ImGui::PopStyleColor(); } float right_offset; //-Battery Trackers if (ConfigManager::GetValue(configid_bool_performance_monitor_show_trackers)) { unsigned int tracker_number = 1; for (const auto& tracker_info : m_BatteryTrackers) { //Reduce horizontal spacing on the right column if (ImGui::GetColumnIndex() == 2) { ImGui::SetCursorPosX(ImGui::GetCursorPosX() - item_spacing_half); right_offset = text_percent_width + right_border_offset; } else { right_offset = text_percent_width; } PerfMonTextUnformatted(tracker_info.Name.c_str()); ImGui::NextColumn(); //15% warning color if (tracker_info.BatteryLevel < 15.0f) ImGui::PushStyleColor(ImGuiCol_Text, Style_ImGuiCol_TextWarning); PerfMonTextRight(right_offset, 0.0f, "%.0f", tracker_info.BatteryLevel); ImGui::SameLine(0.0f, 0.0f); PerfMonTextUnformatted("%"); ImGui::NextColumn(); if (tracker_info.BatteryLevel < 15.0f) ImGui::PopStyleColor(); tracker_number++; } } //-Vive Wireless if ( (m_ViveWirelessLogPathExists) && (ConfigManager::GetValue(configid_bool_performance_monitor_show_vive_wireless)) ) { //Reduce horizontal spacing on the right column if (ImGui::GetColumnIndex() == 2) { ImGui::SetCursorPosX(ImGui::GetCursorPosX() - item_spacing_half); right_offset = right_border_offset; } else { right_offset = 0.0f; } PerfMonText("Vive Wireless:"); ImGui::NextColumn(); if (m_ViveWirelessTemp != -1) { //90 degrees celsius warning color (arbitrarily chosen, but that's not a temp it should be at constantly) if (m_ViveWirelessTemp > 90) ImGui::PushStyleColor(ImGuiCol_Text, Style_ImGuiCol_TextWarning); PerfMonTextRight(right_offset, 0.0f, "%d\xC2\xB0""C", m_ViveWirelessTemp); if (m_ViveWirelessTemp > 90) ImGui::PopStyleColor(); } else { ImGui::PushItemDisabled(); PerfMonTextRightUnformatted(right_offset, 0.0f, TranslationManager::GetString(tstr_PerformanceMonitorCompactViveWirelessTempNotAvailable)); ImGui::PopItemDisabled(); } } } } //Last item rect height is the padding dummy == empty window if (ImGui::GetItemRectSize().y == 0.0f) { ImGui::Columns(1); PerfMonTextUnformatted(TranslationManager::GetString(tstr_PerformanceMonitorEmpty)); } } void WindowPerformance::DisplayStatsCompact() { const ImGuiStyle& style = ImGui::GetStyle(); const float item_spacing_prev = style.ItemSpacing.x; ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, {0.0f, style.ItemSpacing.y}); //These width caluclations are not using the translated strings, but there really is no space for those to be longer either, so whatever static const float column_width_0 = ImGui::GetFontSize() * 1.5f; float column_width_cpu_1 = ImGui::CalcTextSize(" 000.00 ms ").x; float column_width_cpu_2 = ImGui::CalcTextSize(" 000.00% ").x; float column_width_cpu_3 = ImGui::CalcTextSize(" 000.00/000.00 GB ").x; static const float column_width_fps_1 = ImGui::CalcTextSize(" 000 ").x; static const float column_width_fps_2 = ImGui::CalcTextSize(" 000.00 AVG ").x; static const float column_width_fps_3 = ImGui::CalcTextSize(" 00.00% RPR ").x; static const float column_width_fps_4 = ImGui::CalcTextSize(" 0000 DRP ").x; float column_width_bat = ImGui::CalcTextSize(" T1 100% ").x; static const float text_percentage_cwidth = ImGui::CalcTextSize(" 100%").x; static const float text_avg_cwidth = ImGui::CalcTextSize(" AVG").x; static const float text_rpr_cwidth = ImGui::CalcTextSize("% RPR").x; static const float text_drp_cwidth = ImGui::CalcTextSize(" DRP").x; static const float text_ms_width = ImGui::CalcTextSize(" ms").x; static const float text_percent_width = ImGui::CalcTextSize("%").x; static const float text_gb_part_width = ImGui::CalcTextSize("00.00 GB").x; const float width_total_cpu = column_width_0 + column_width_cpu_1 + column_width_cpu_2 + column_width_cpu_3; const float width_total_fps = column_width_0 + column_width_fps_1 + column_width_fps_2 + column_width_fps_3 + column_width_fps_4; const float width_total_bat = column_width_0 + (column_width_bat * 4.0f); const float frame_time_warning_limit = m_FrameTimeVsyncLimit * 0.95f; //Pad shorter columns to match total length with the FPS row float padding = (width_total_fps - width_total_cpu) / 2.0f; //Only pad the second and last column so the first one lines up column_width_cpu_2 += padding; column_width_cpu_3 += padding; padding = (width_total_fps - width_total_bat) / 4.0f; column_width_bat += padding; //Pad window content to fps row width since columns don't increase the window size ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, {0.0f, 0.0f}); ImGui::Dummy({width_total_fps, 0.0f}); ImGui::PopStyleVar(); //Workaround for an invalid clipping assert raised when switching columns in the compact layout //Came with ImGui 1.80/1.90 (required workaround changed with 1.90), but has quite a few variables involved, so I'm not even sure who's at fault here. This works, though. if (ImGui::IsWindowAppearing()) { ImGui::PopStyleVar(); return; } //Align RAM and VRAM values even if they have different lengths static float text_ram_total_width = 0.0f; static float text_vram_total_width = 0.0f; float text_ram_padding = std::max(text_ram_total_width, text_vram_total_width); //--CPU/GPU Frame Time Graphs //Shared offsets //Show both graphs if showing CPU and GPU stats or none of them (if graphs themselves are still active) bool show_both_graphs = (ConfigManager::GetValue(configid_bool_performance_monitor_show_cpu) == ConfigManager::GetValue(configid_bool_performance_monitor_show_gpu)); const ImVec2 graph_size = {(show_both_graphs) ? floorf( (width_total_fps - item_spacing_prev) / 2.0f) : width_total_fps, ImGui::GetFontSize() * 2.0f}; double plot_xmin = (m_FrameTimeLastIndex > (uint32_t)m_FrameTimeCPUHistory.MaxSize) ? m_FrameTimeLastIndex - m_FrameTimeCPUHistory.MaxSize + 0.5f : 0.5f; double plot_xmax = m_FrameTimeLastIndex - 0.75f; double plot_ymax = ceilf(m_FrameTimeVsyncLimit * 1.4f); if (ConfigManager::GetValue(configid_bool_performance_monitor_show_graphs)) { //-CPU Frame Time Graph if ( (show_both_graphs) || (ConfigManager::GetValue(configid_bool_performance_monitor_show_cpu)) ) { DrawFrameTimeGraphCPU(graph_size, plot_xmin, plot_xmax, plot_ymax); if (show_both_graphs) { ImGui::SameLine(0.0f, item_spacing_prev); } } //-GPU Frame Time Graph if ( (show_both_graphs) || (ConfigManager::GetValue(configid_bool_performance_monitor_show_gpu)) ) { DrawFrameTimeGraphGPU(graph_size, plot_xmin, plot_xmax, plot_ymax); } } //CPU/GPU columns if ( (ConfigManager::GetValue(configid_bool_performance_monitor_show_cpu)) || (ConfigManager::GetValue(configid_bool_performance_monitor_show_gpu)) ) { ImGui::Columns(4, "ColumnStatsCompact", false); ImGui::SetColumnWidth(0, column_width_0); ImGui::SetColumnWidth(1, column_width_cpu_1); ImGui::SetColumnWidth(2, column_width_cpu_2); ImGui::SetColumnWidth(3, column_width_cpu_3); } //--Row CPU if (ConfigManager::GetValue(configid_bool_performance_monitor_show_cpu)) { ImGui::PushStyleColor(ImGuiCol_Text, ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered)); PerfMonTextUnformatted(TranslationManager::GetString(tstr_PerformanceMonitorCompactCPU)); ImGui::PopStyleColor(); ImGui::NextColumn(); //-CPU Frame Time //Warning color when frame time above 95% vsync time if (m_FrameTimeCPU > frame_time_warning_limit) ImGui::PushStyleColor(ImGuiCol_Text, Style_ImGuiCol_TextWarning); PerfMonTextRight(text_ms_width, 0.0f, "%.2f", m_FrameTimeCPU); ImGui::SameLine(0.0f, 0.0f); PerfMonTextUnformatted(" ms"); ImGui::NextColumn(); if (m_FrameTimeCPU > frame_time_warning_limit) ImGui::PopStyleColor(); //-CPU Load PerfMonTextRight(text_percent_width, 0.0f, "%.2f", m_PerfData.GetCPULoadPrecentage()); ImGui::SameLine(0.0f, 0.0f); PerfMonTextUnformatted("%"); ImGui::NextColumn(); //-RAM PerfMonTextRight(text_ram_padding, 0.0f, "%.2f GB/", m_PerfData.GetRAMUsedGB()); ImGui::SameLine(0.0f, 0.0f); PerfMonTextRight(0.0f, 0.0f, "%.2f GB", m_PerfData.GetRAMTotalGB()); text_ram_total_width = ImGui::GetItemRectSize().x; ImGui::NextColumn(); } //--Row GPU if (ConfigManager::GetValue(configid_bool_performance_monitor_show_gpu)) { ImGui::PushStyleColor(ImGuiCol_Text, ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered)); PerfMonTextUnformatted(TranslationManager::GetString(tstr_PerformanceMonitorCompactGPU)); ImGui::PopStyleColor(); ImGui::NextColumn(); //-GPU Frame Time if (m_FrameTimeGPU > frame_time_warning_limit) ImGui::PushStyleColor(ImGuiCol_Text, Style_ImGuiCol_TextWarning); PerfMonTextRight(text_ms_width, 0.0f, "%.2f", m_FrameTimeGPU); ImGui::SameLine(0.0f, 0.0f); PerfMonTextUnformatted(" ms"); ImGui::NextColumn(); if (m_FrameTimeGPU > frame_time_warning_limit) ImGui::PopStyleColor(); if (!ConfigManager::GetValue(configid_bool_performance_monitor_disable_gpu_counters)) //No point in showing it all if it's not updating { //-GPU Load PerfMonTextRight(text_percent_width, 0.0f, "%.2f", m_PerfData.GetGPULoadPrecentage()); ImGui::SameLine(0.0f, 0.0f); PerfMonTextUnformatted("%"); ImGui::NextColumn(); //-VRAM PerfMonTextRight(text_ram_padding, 0.0f, "%.2f GB/", m_PerfData.GetVRAMUsedGB()); ImGui::SameLine(0.0f, 0.0f); PerfMonTextRight(0.0f, 0.0f, "%.2f GB", m_PerfData.GetVRAMTotalGB()); text_vram_total_width = ImGui::GetItemRectSize().x; ImGui::NextColumn(); } } //--Row FPS if (ConfigManager::GetValue(configid_bool_performance_monitor_show_fps)) { ImGui::Columns(5, "ColumnStatsCompactFPS", false); ImGui::SetColumnWidth(0, column_width_0); ImGui::SetColumnWidth(1, column_width_fps_1); ImGui::SetColumnWidth(2, column_width_fps_2); ImGui::SetColumnWidth(3, column_width_fps_3); ImGui::SetColumnWidth(4, column_width_fps_4); ImGui::PushStyleColor(ImGuiCol_Text, ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered)); PerfMonTextUnformatted(TranslationManager::GetString(tstr_PerformanceMonitorCompactFPS)); ImGui::PopStyleColor(); //-FPS ImGui::NextColumn(); PerfMonTextRight(0.0f, 0.0f, "%d", m_FPS); ImGui::NextColumn(); //-Average FPS PerfMonTextRight(text_avg_cwidth, 0.0f, "%.2f", m_FPS_Average); ImGui::SameLine(0.0f, 0.0f); PerfMonTextRightUnformatted(0.0f, 0.0f, TranslationManager::GetString(tstr_PerformanceMonitorCompactFPSAverage)); ImGui::NextColumn(); //No VR app means no frame statistics (FPS still gets counted, though) if (m_PIDLast == 0) ImGui::PushItemDisabled(); //-Reprojection Ratio PerfMonTextRight(text_rpr_cwidth, 0.0f, "%.2f", m_ReprojectionRatio); ImGui::SameLine(0.0f, 0.0f); PerfMonTextRightUnformatted(0.0f, 0.0f, TranslationManager::GetString(tstr_PerformanceMonitorCompactReprojectionRatio)); ImGui::NextColumn(); //-Dropped Frames PerfMonTextRight(text_drp_cwidth, 0.0f, "%u", m_DroppedFrames); ImGui::SameLine(0.0f, 0.0f); PerfMonTextRightUnformatted(0.0f, 0.0f, TranslationManager::GetString(tstr_PerformanceMonitorCompactDroppedFrames)); ImGui::NextColumn(); if (m_PIDLast == 0) ImGui::PopItemDisabled(); } //--Row BAT if (ConfigManager::GetValue(configid_bool_performance_monitor_show_battery)) { ImGui::Columns(1); //Reset columns or else it won't treat it as a sepearate layout ImGui::Columns(5, "ColumnStatsCompactBAT", false); ImGui::SetColumnWidth(0, column_width_0); ImGui::SetColumnWidth(1, column_width_bat); ImGui::SetColumnWidth(2, column_width_bat); ImGui::SetColumnWidth(3, column_width_bat); ImGui::SetColumnWidth(4, column_width_bat); ImGui::PushStyleColor(ImGuiCol_Text, ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered)); PerfMonTextUnformatted(TranslationManager::GetString(tstr_PerformanceMonitorCompactBattery)); ImGui::PopStyleColor(); ImGui::NextColumn(); //-Battery Left PerfMonTextRightUnformatted(text_percentage_cwidth, 0.0f, TranslationManager::GetString(tstr_PerformanceMonitorCompactBatteryLeft)); ImGui::SameLine(0.0f, 0.0f); if (m_BatteryLeft != -1.0f) { //15% warning color if (m_BatteryLeft < 15.0f) ImGui::PushStyleColor(ImGuiCol_Text, Style_ImGuiCol_TextWarning); PerfMonTextRight(0.0f, 0.0f, "%.0f%%", m_BatteryLeft); if (m_BatteryLeft < 15.0f) ImGui::PopStyleColor(); } else { ImGui::PushItemDisabled(); PerfMonTextRightUnformatted(0.0f, 0.0f, TranslationManager::GetString(tstr_PerformanceMonitorCompactBatteryDisconnected)); ImGui::PopItemDisabled(); } ImGui::NextColumn(); //-Battery Right PerfMonTextRightUnformatted(text_percentage_cwidth, 0.0f, TranslationManager::GetString(tstr_PerformanceMonitorCompactBatteryRight)); ImGui::SameLine(0.0f, 0.0f); if (m_BatteryRight != -1.0f) { //15% warning color if (m_BatteryRight < 15.0f) ImGui::PushStyleColor(ImGuiCol_Text, Style_ImGuiCol_TextWarning); PerfMonTextRight(0.0f, 0.0f, "%.0f%%", m_BatteryRight); if (m_BatteryRight < 15.0f) ImGui::PopStyleColor(); } else { ImGui::PushItemDisabled(); PerfMonTextRightUnformatted(0.0f, 0.0f, TranslationManager::GetString(tstr_PerformanceMonitorCompactBatteryDisconnected)); ImGui::PopItemDisabled(); } ImGui::NextColumn(); //-Battery HMD (only shown if available) if (m_BatteryHMD != -1.0f) { PerfMonTextRightUnformatted(text_percentage_cwidth, 0.0f, TranslationManager::GetString(tstr_PerformanceMonitorCompactBatteryHMD)); ImGui::SameLine(0.0f, 0.0f); //15% warning color if (m_BatteryHMD < 15.0f) ImGui::PushStyleColor(ImGuiCol_Text, Style_ImGuiCol_TextWarning); PerfMonTextRight(0.0f, 0.0f, "%.0f%%", m_BatteryHMD); if (m_BatteryHMD < 15.0f) ImGui::PopStyleColor(); } ImGui::NextColumn(); //-Battery Trackers if (ConfigManager::GetValue(configid_bool_performance_monitor_show_trackers)) { unsigned int tracker_number = 1; for (const auto& tracker_info : m_BatteryTrackers) { //Skip first column if (ImGui::GetColumnIndex() == 0) { ImGui::NextColumn(); } PerfMonTextRightUnformatted(text_percentage_cwidth, 0.0f, tracker_info.NameCompact.c_str()); ImGui::SameLine(0.0f, 0.0f); //15% warning color if (tracker_info.BatteryLevel < 15.0f) ImGui::PushStyleColor(ImGuiCol_Text, Style_ImGuiCol_TextWarning); PerfMonTextRight(0.0f, 0.0f, "%.0f%%", tracker_info.BatteryLevel); if (tracker_info.BatteryLevel < 15.0f) ImGui::PopStyleColor(); ImGui::NextColumn(); tracker_number++; } } //-Vive Wireless if ( (m_ViveWirelessLogPathExists) && (ConfigManager::GetValue(configid_bool_performance_monitor_show_vive_wireless)) ) { //Skip first column if (ImGui::GetColumnIndex() == 0) { ImGui::NextColumn(); } PerfMonTextRightUnformatted(text_percentage_cwidth, 0.0f, "VW"); ImGui::SameLine(0.0f, 0.0f); if (m_ViveWirelessTemp != -1) { //90 degrees celsius warning color if (m_ViveWirelessTemp > 90) ImGui::PushStyleColor(ImGuiCol_Text, Style_ImGuiCol_TextWarning); PerfMonTextRight(0.0f, 0.0f, "%d\xC2\xB0""C", m_ViveWirelessTemp); if (m_ViveWirelessTemp > 90) ImGui::PopStyleColor(); } else { ImGui::PushItemDisabled(); PerfMonTextRightUnformatted(0.0f, 0.0f, TranslationManager::GetString(tstr_PerformanceMonitorCompactViveWirelessTempNotAvailable)); ImGui::PopItemDisabled(); } } } ImGui::PopStyleVar(); //Last item rect height is the padding dummy == empty window if (ImGui::GetItemRectSize().y == 0.0f) { ImGui::Columns(1); PerfMonTextUnformatted(TranslationManager::GetString(tstr_PerformanceMonitorEmpty)); } } void WindowPerformance::DisplayStatsMinimal() { const ImGuiStyle& style = ImGui::GetStyle(); const float item_spacing_half = style.ItemSpacing.x / 2.0f; //Items are using right-aligned text within a fixed expected width to avoid text jumping around as values change static const float text_fps_width = ImGui::CalcTextSize("100").x; static const float text_percentage_width = ImGui::CalcTextSize("00.00%").x; static const float text_percentage_int_width = ImGui::CalcTextSize("100%").x; static const float text_rpr_width = ImGui::CalcTextSize("00.00").x; static const float text_ms_width = ImGui::CalcTextSize("00.00 ms").x; static const float text_gb_width = ImGui::CalcTextSize("00.00 GB").x; static const float text_temperature_width = ImGui::CalcTextSize("00\xC2\xB0""C").x; static const float text_time_width = ImGui::CalcTextSize("00:00").x; const float frame_time_warning_limit = m_FrameTimeVsyncLimit * 0.95f; //StatsMinimalItemLineWrap() expects a previous item to exist, so we have a dummy fill that role ImGui::Dummy({0.0f, 0.0f}); ImGui::SameLine(0.0f, 0.0f); //--CPU/GPU Frame Time Graphs //Show both graphs if showing CPU and GPU stats or none of them (if graphs themselves are still active) bool show_both_graphs = (ConfigManager::GetValue(configid_bool_performance_monitor_show_cpu) == ConfigManager::GetValue(configid_bool_performance_monitor_show_gpu)); const ImVec2 graph_size = {ImGui::GetFontSize() * 2.0f, ImGui::GetFontSize()}; double plot_xmin = (m_FrameTimeLastIndex > (uint32_t)m_FrameTimeCPUHistory.MaxSize) ? m_FrameTimeLastIndex - m_FrameTimeCPUHistory.MaxSize + 0.5f : 0.5f; double plot_xmax = m_FrameTimeLastIndex - 0.75f; double plot_ymax = ceilf(m_FrameTimeVsyncLimit * 1.4f); //--FPS if (ConfigManager::GetValue(configid_bool_performance_monitor_show_fps)) { StatsMinimalItemLineWrap(); //First item won't ever wrap, but this sets the last item position for wrapping //-FPS PerfMonTextRight(0.0f, text_fps_width, "%d", m_FPS); ImGui::SameLine(); if (ConfigManager::GetValue(configid_bool_performance_monitor_style_minimal_show_more)) { //No VR app means no frame statistics (FPS still gets counted, though) if (m_PIDLast == 0) ImGui::PushItemDisabled(); //-Reprojection Ratio PerfMonTextRight(0.0f, text_rpr_width, "%.2f", m_ReprojectionRatio); ImGui::SameLine(0.0f, 0.0f); PerfMonTextUnformatted(TranslationManager::GetString(tstr_PerformanceMonitorCompactReprojectionRatio)); ImGui::SameLine(); if (m_PIDLast == 0) ImGui::PopItemDisabled(); } } //--CPU if (ConfigManager::GetValue(configid_bool_performance_monitor_show_cpu)) { StatsMinimalItemLineWrap(); //-CPU Frame Time //Warning color when frame time above 95% vsync time if (m_FrameTimeCPU > frame_time_warning_limit) ImGui::PushStyleColor(ImGuiCol_Text, Style_ImGuiCol_TextWarning); PerfMonTextRight(0.0f, text_ms_width, "%.2f ms", m_FrameTimeCPU); ImGui::SameLine(); if (m_FrameTimeCPU > frame_time_warning_limit) ImGui::PopStyleColor(); if (ConfigManager::GetValue(configid_bool_performance_monitor_style_minimal_show_more)) { //-CPU Load PerfMonTextRight(0.0f, text_percentage_width, "%.2f%%", m_PerfData.GetCPULoadPrecentage()); ImGui::SameLine(); //-RAM PerfMonTextRight(0.0f, text_gb_width, "%.2f GB", m_PerfData.GetRAMUsedGB()); ImGui::SameLine(); } } //--CPU Frame Time Graph if (ConfigManager::GetValue(configid_bool_performance_monitor_show_graphs)) { if ( (show_both_graphs) || (ConfigManager::GetValue(configid_bool_performance_monitor_show_cpu)) ) { StatsMinimalItemLineWrap(); DrawFrameTimeGraphCPU(graph_size, plot_xmin, plot_xmax, plot_ymax); ImGui::SameLine(); } } //--GPU if (ConfigManager::GetValue(configid_bool_performance_monitor_show_gpu)) { StatsMinimalItemLineWrap(); //-GPU Frame Time if (m_FrameTimeGPU > frame_time_warning_limit) ImGui::PushStyleColor(ImGuiCol_Text, Style_ImGuiCol_TextWarning); PerfMonTextRight(0.0f, text_ms_width, "%.2f ms", m_FrameTimeGPU); ImGui::SameLine(); if (m_FrameTimeGPU > frame_time_warning_limit) ImGui::PopStyleColor(); if (ConfigManager::GetValue(configid_bool_performance_monitor_style_minimal_show_more)) { if (!ConfigManager::GetValue(configid_bool_performance_monitor_disable_gpu_counters)) //No point in showing it all if it's not updating { //-GPU Load PerfMonTextRight(0.0f, text_percentage_width, "%.2f%%", m_PerfData.GetGPULoadPrecentage()); ImGui::SameLine(); //-VRAM PerfMonTextRight(0.0f, text_gb_width, "%.2f GB", m_PerfData.GetVRAMUsedGB()); ImGui::SameLine(); } } } //--GPU Frame Time Graph if (ConfigManager::GetValue(configid_bool_performance_monitor_show_graphs)) { if ( (show_both_graphs) || (ConfigManager::GetValue(configid_bool_performance_monitor_show_gpu)) ) { StatsMinimalItemLineWrap(); DrawFrameTimeGraphGPU(graph_size, plot_xmin, plot_xmax, plot_ymax); ImGui::SameLine(); } } //--Battery Levels if (ConfigManager::GetValue(configid_bool_performance_monitor_show_battery)) { //-Battery Left if (m_BatteryLeft != -1.0f) { StatsMinimalItemLineWrap(); PerfMonTextUnformatted(TranslationManager::GetString(tstr_PerformanceMonitorCompactBatteryLeft)); ImGui::SameLine(0.0f, item_spacing_half); //15% warning color if (m_BatteryLeft < 15.0f) ImGui::PushStyleColor(ImGuiCol_Text, Style_ImGuiCol_TextWarning); PerfMonTextRight(0.0f, text_percentage_int_width, "%.0f%%", m_BatteryLeft); if (m_BatteryLeft < 15.0f) ImGui::PopStyleColor(); ImGui::SameLine(); } //-Battery Right if (m_BatteryRight != -1.0f) { StatsMinimalItemLineWrap(); PerfMonTextUnformatted(TranslationManager::GetString(tstr_PerformanceMonitorCompactBatteryRight)); ImGui::SameLine(0.0f, item_spacing_half); //15% warning color if (m_BatteryRight < 15.0f) ImGui::PushStyleColor(ImGuiCol_Text, Style_ImGuiCol_TextWarning); PerfMonTextRight(0.0f, text_percentage_int_width, "%.0f%%", m_BatteryRight); if (m_BatteryRight < 15.0f) ImGui::PopStyleColor(); ImGui::SameLine(); } //-Battery HMD if (m_BatteryHMD != -1.0f) { StatsMinimalItemLineWrap(); PerfMonTextUnformatted(TranslationManager::GetString(tstr_PerformanceMonitorCompactBatteryHMD)); ImGui::SameLine(0.0f, item_spacing_half); //15% warning color if (m_BatteryHMD < 15.0f) ImGui::PushStyleColor(ImGuiCol_Text, Style_ImGuiCol_TextWarning); PerfMonTextRight(0.0f, text_percentage_int_width, "%.0f%%", m_BatteryHMD); if (m_BatteryHMD < 15.0f) ImGui::PopStyleColor(); ImGui::SameLine(); } //-Battery Trackers if (ConfigManager::GetValue(configid_bool_performance_monitor_show_trackers)) { unsigned int tracker_number = 1; for (const auto& tracker_info : m_BatteryTrackers) { StatsMinimalItemLineWrap(); PerfMonTextUnformatted(tracker_info.NameCompact.c_str()); ImGui::SameLine(0.0f, item_spacing_half); //15% warning color if (tracker_info.BatteryLevel < 15.0f) ImGui::PushStyleColor(ImGuiCol_Text, Style_ImGuiCol_TextWarning); PerfMonTextRight(0.0f, text_percentage_int_width, "%.0f%%", tracker_info.BatteryLevel); if (tracker_info.BatteryLevel < 15.0f) ImGui::PopStyleColor(); ImGui::SameLine(); tracker_number++; } } //-Vive Wireless if ( (m_ViveWirelessLogPathExists) && (ConfigManager::GetValue(configid_bool_performance_monitor_show_vive_wireless)) ) { StatsMinimalItemLineWrap(); PerfMonTextUnformatted("VW"); ImGui::SameLine(0.0f, item_spacing_half); if (m_ViveWirelessTemp != -1) { //90 degrees celsius warning color if (m_ViveWirelessTemp > 90) ImGui::PushStyleColor(ImGuiCol_Text, Style_ImGuiCol_TextWarning); PerfMonTextRight(0.0f, text_temperature_width, "%d\xC2\xB0""C", m_ViveWirelessTemp); if (m_ViveWirelessTemp > 90) ImGui::PopStyleColor(); } else { ImGui::PushItemDisabled(); PerfMonTextUnformatted(TranslationManager::GetString(tstr_PerformanceMonitorCompactViveWirelessTempNotAvailable)); ImGui::PopItemDisabled(); } ImGui::SameLine(); } } //--Time if (ConfigManager::GetValue(configid_bool_performance_monitor_show_time)) { StatsMinimalItemLineWrap(); PerfMonTextRightUnformatted(0.0f, text_time_width, m_TimeStr.c_str()); ImGui::SameLine(); } //Last item needs to have the wrapping function called too in case it went over StatsMinimalItemLineWrap(); //Last item rect height is the padding dummy == empty window if (ImGui::GetItemRectSize().y == 0.0f) { PerfMonTextUnformatted(TranslationManager::GetString(tstr_PerformanceMonitorEmpty)); } } void WindowPerformance::UpdateStatValues() { m_PerfData.Update(); //Localized time string SYSTEMTIME system_time; ::GetSystemTime(&system_time); if ( (system_time.wHour != m_TimeLast.wHour) || (system_time.wMinute != m_TimeLast.wMinute) ) //Only grab a new string when the hour or minute changed { wchar_t time_wstr[64]; if (::GetTimeFormatEx(LOCALE_NAME_USER_DEFAULT, TIME_NOSECONDS, nullptr, nullptr, time_wstr, 63) != 0) { m_TimeStr = StringConvertFromUTF16(time_wstr); } m_TimeLast = system_time; } UpdateStatValuesSteamVR(); UpdateStatValuesViveWireless(); } void WindowPerformance::UpdateStatValuesSteamVR() { //No OpenVR, no frame data if (!UIManager::Get()->IsOpenVRLoaded()) return; //Get compositor timing from OpenVR vr::Compositor_FrameTiming frame_timing_current; frame_timing_current.m_nSize = sizeof(vr::Compositor_FrameTiming); bool frame_timing_current_valid = vr::VRCompositor()->GetFrameTiming(&frame_timing_current, 0); if (frame_timing_current_valid) { //Set current timings m_FrameTimeCPU = frame_timing_current.m_flClientFrameIntervalMs + frame_timing_current.m_flCompositorRenderCpuMs; m_FrameTimeGPU = frame_timing_current.m_flTotalRenderGpuMs; //Update frame time history vr::Compositor_FrameTiming frame_timing_prev; frame_timing_prev.m_nSize = sizeof(vr::Compositor_FrameTiming); bool frame_timing_prev_valid = false; //Sanity check if (frame_timing_current.m_nFrameIndex < m_FrameTimeLastIndex) { m_FrameTimeLastIndex = 0; } //Get all frame timings since the last time we updated (but not more than max history size) for (uint32_t frames_ago = std::min(frame_timing_current.m_nFrameIndex - m_FrameTimeLastIndex, (uint32_t)m_FrameTimeCPUHistory.MaxSize); frames_ago != 0; --frames_ago) { frame_timing_prev_valid = vr::VRCompositor()->GetFrameTiming(&frame_timing_prev, frames_ago); //Calculate our own frame index as we get duplicates if SteamVR runs out of history float frame_index = float(frame_timing_current.m_nFrameIndex - frames_ago); if (frame_timing_prev_valid) { float frame_time_cpu = frame_timing_prev.m_flClientFrameIntervalMs + frame_timing_prev.m_flCompositorRenderCpuMs; m_FrameTimeCPUHistory.AddFrame(frame_index, frame_time_cpu); m_FrameTimeCPUHistoryWarning.AddFrame(frame_index, (frame_time_cpu > m_FrameTimeVsyncLimit) ? frame_time_cpu : 0.0f); m_FrameTimeGPUHistory.AddFrame(frame_index, frame_timing_prev.m_flTotalRenderGpuMs); m_FrameTimeGPUHistoryWarning.AddFrame(frame_index, (frame_timing_prev.m_flTotalRenderGpuMs > m_FrameTimeVsyncLimit) ? frame_timing_prev.m_flTotalRenderGpuMs : 0.0f); } else //No valid data, leave gap in history { m_FrameTimeCPUHistory.AddFrame(frame_index, 0.0f); m_FrameTimeCPUHistoryWarning.AddFrame(frame_index, 0.0f); m_FrameTimeGPUHistory.AddFrame(frame_index, 0.0f); m_FrameTimeGPUHistoryWarning.AddFrame(frame_index, 0.0f); } } m_FrameTimeLastIndex = frame_timing_current.m_nFrameIndex; } else { m_FrameTimeCPU = 0.0f; m_FrameTimeGPU = 0.0f; } //Update cumulative stats vr::Compositor_CumulativeStats frame_stats = {0}; vr::VRCompositor()->GetCumulativeStats(&frame_stats, sizeof(vr::Compositor_CumulativeStats)); //Reset when process changed if (frame_stats.m_nPid != m_PIDLast) { //Additionally check if it's actually the running application and not just some past app's stats if (frame_stats.m_nPid == vr::VRApplications()->GetCurrentSceneProcessId()) { m_PIDLast = frame_stats.m_nPid; ResetCumulativeValues(); } } else if ( (frame_stats.m_nPid != vr::VRApplications()->GetCurrentSceneProcessId()) && (m_PIDLast != 0) ) //Not actually the running application, set last pid to 0 instead if it isn't yet { m_PIDLast = 0; ResetCumulativeValues(); } //Apply offsets to stat values uint32_t frame_presents = frame_stats.m_nNumFramePresents - m_OffsetFramesPresents; uint32_t reprojected_frames = frame_stats.m_nNumReprojectedFrames - m_OffsetReprojectedFrames; //Update frame count if at least a second passed since the last time if (m_FPS_TickLast + 1000 <= ::GetTickCount64()) { uint32_t frame_count = frame_timing_current.m_nFrameIndex - m_OffsetFrameIndex; if (vr::VRSystem()->GetTrackedDeviceActivityLevel(vr::k_unTrackedDeviceIndex_Hmd) != vr::k_EDeviceActivityLevel_Standby) //Don't count frames when entering standby { if (m_FrameCountLast != 0) { m_FPS = frame_count - m_FrameCountLast; //Total unreprojected frames rendered since last time m_FPS = int(m_FPS / ((::GetTickCount64() - m_FPS_TickLast) / 1000.0f)); //Divided by seconds passed in case it has been more than just 1 m_FrameCountTotal += m_FPS; //This means m_FrameCountTotal may not be the total frames rendered but the sum of whatever we displayed as FPS before m_FrameCountTotalCount++; if (m_FrameCountTotalCount != 0) { m_FPS_Average = m_FrameCountTotal / (float)m_FrameCountTotalCount; //Ignore very small decimals as they occur often and are more confusing than helpful when the fps are actually totally fine (as they don't really go away) if (fabs(m_FPS_Average - roundf(m_FPS_Average)) < 0.05f) { m_FPS_Average = roundf(m_FPS_Average); } } } } m_FPS_TickLast = ::GetTickCount64(); m_FrameCountLast = frame_count; } //Reprojection ratio and dropped frames m_ReprojectionRatio = (frame_presents != 0) ? ((float)reprojected_frames / frame_presents) * 100.f : 0.0f; m_DroppedFrames = frame_stats.m_nNumDroppedFrames - m_OffsetDroppedFrames; //Battery Left vr::TrackedDeviceIndex_t device_index = vr::VRSystem()->GetTrackedDeviceIndexForControllerRole(vr::TrackedControllerRole_LeftHand); if (device_index != vr::k_unTrackedDeviceIndexInvalid) { m_BatteryLeft = vr::VRSystem()->GetFloatTrackedDeviceProperty(device_index, vr::Prop_DeviceBatteryPercentage_Float) * 100.0f; } else { m_BatteryLeft = -1.0f; } //Battery Right device_index = vr::VRSystem()->GetTrackedDeviceIndexForControllerRole(vr::TrackedControllerRole_RightHand); if (device_index != vr::k_unTrackedDeviceIndexInvalid) { m_BatteryRight = vr::VRSystem()->GetFloatTrackedDeviceProperty(device_index, vr::Prop_DeviceBatteryPercentage_Float) * 100.0f; } else { m_BatteryRight = -1.0f; } //Battery HMD if (vr::VRSystem()->GetBoolTrackedDeviceProperty(vr::k_unTrackedDeviceIndex_Hmd, vr::Prop_DeviceProvidesBatteryStatus_Bool)) { m_BatteryHMD = vr::VRSystem()->GetFloatTrackedDeviceProperty(vr::k_unTrackedDeviceIndex_Hmd, vr::Prop_DeviceBatteryPercentage_Float) * 100.0f; } else { m_BatteryHMD = -1.0f; } //Battery Trackers for (auto& tracker_info : m_BatteryTrackers) { tracker_info.BatteryLevel = vr::VRSystem()->GetFloatTrackedDeviceProperty(tracker_info.DeviceIndex, vr::Prop_DeviceBatteryPercentage_Float) * 100.0f; } } void WindowPerformance::UpdateStatValuesViveWireless() { //Vive Wireless Temperatures can seemingly only be read from the log file it's constantly writing too //This doesn't seem terribly efficient, but it's better than nothing //Reading is done every 5 seconds //Don't update if the path doesn't exist or it's not even enabled if ( (!m_ViveWirelessLogPathExists) || (!ConfigManager::GetValue(configid_bool_performance_monitor_show_vive_wireless)) ) return; if (m_ViveWirelessTickLast + 5000 <= ::GetTickCount64()) { m_ViveWirelessTickLast = ::GetTickCount64(); m_ViveWirelessTemp = -1; //Find the newest log file std::wstring path_str = m_ViveWirelessLogPath; path_str += L"*.txt"; std::vector< std::pair > file_list; //std::pair WIN32_FIND_DATA find_data; HANDLE handle_find = ::FindFirstFileW(path_str.c_str(), &find_data); if (handle_find != INVALID_HANDLE_VALUE) { do { //Add filename and last modified time in list file_list.emplace_back(find_data.cFileName, ULARGE_INTEGER{find_data.ftLastWriteTime.dwLowDateTime, find_data.ftLastWriteTime.dwHighDateTime}); } while (::FindNextFileW(handle_find, &find_data) != 0); ::FindClose(handle_find); } auto it = std::max_element(file_list.begin(), file_list.end(), [](const auto& data_a, const auto& data_b){ return (data_a.second.QuadPart < data_b.second.QuadPart); }); if (it == file_list.end()) return; //Check if the newest file is older than 2 minutes, in which case we don't use it to read a temperature at all FILETIME ftime_current; ::GetSystemTimeAsFileTime(&ftime_current); ULARGE_INTEGER time_current{ftime_current.dwLowDateTime, ftime_current.dwHighDateTime}; if (it->second.QuadPart + 1200000000 <= time_current.QuadPart) //+ 2 minutes in 100 ns intervals { return; } //If the newest file is not the same as last time, reset the last used line number if (it->first != m_ViveWirelessLogFileLast) { m_ViveWirelessLogFileLast = it->first; m_ViveWirelessLogFileLastLine = 0; } //Read log file { path_str = m_ViveWirelessLogPath + m_ViveWirelessLogFileLast; std::wifstream log_file(path_str); if (log_file.good()) { //Imbue with utf16-le locale, as are the files Vive Wireless writes (codecvt_utf16 is deprecated starting C++17, but this is the most straight forward way to deal with this) log_file.imbue(std::locale(log_file.getloc(), new std::codecvt_utf16())); //Read lines and see if the M_Temperature can be found (R_Temperature isn't interesting in our case) int line_count = 0; std::wstring line_str; std::string temp_str; size_t mtemp_pos; while (log_file.good()) { std::getline(log_file, line_str); line_count++; //Only check for the temperature value if this line is the same or greater than last time (0 if it's a new file) if (line_count >= m_ViveWirelessLogFileLastLine) { mtemp_pos = line_str.find(L"M_Temperature="); if (mtemp_pos != std::wstring::npos) { temp_str = StringConvertFromUTF16(line_str.substr(mtemp_pos + 14).c_str()); m_ViveWirelessTemp = atoi(temp_str.c_str()); m_ViveWirelessLogFileLastLine = line_count; } } } } } } } void WindowPerformance::DrawFrameTimeGraphCPU(const ImVec2& graph_size, double plot_xmin, double plot_xmax, double plot_ymax) { float frame_offset = 1.0f + ImGui::GetStyle().FrameBorderSize; ImVec2 cursor_screen_pos_graph = ImGui::GetCursorScreenPos(); ImPlot::SetNextAxesLimits(plot_xmin, plot_xmax, 0.0, plot_ymax, ImGuiCond_Always); if (ImPlot::BeginPlot("##PlotCPU", graph_size, ImPlotFlags_CanvasOnly)) { const ImVector& plot_data = m_FrameTimeCPUHistory.Data; const ImVector& plot_data_warn = m_FrameTimeCPUHistoryWarning.Data; ImPlot::SetupAxes(nullptr, nullptr, ImPlotAxisFlags_NoDecorations, ImPlotAxisFlags_NoDecorations | ImPlotAxisFlags_LockMin); if (!plot_data.empty()) { ImGui::PushClipRect({cursor_screen_pos_graph.x + frame_offset, cursor_screen_pos_graph.y + frame_offset}, {(cursor_screen_pos_graph.x + graph_size.x) - frame_offset, cursor_screen_pos_graph.y + graph_size.y - frame_offset}, false); ImPlot::SetNextFillStyle(ImVec4(0.5f, 1.0f, 0.0f, 1.0f)); ImPlot::PlotShaded("##DataShaded", &plot_data[0].x, &plot_data[0].y, plot_data.size(), 0.0, ImPlotShadedFlags_None, m_FrameTimeCPUHistory.Offset, 2 * sizeof(float)); ImPlot::SetNextLineStyle(ImVec4(0.5f, 1.0f, 0.0f, 1.0f)); ImPlot::PlotLine("##DataLine", &plot_data[0].x, &plot_data[0].y, plot_data.size(), ImPlotLineFlags_None, m_FrameTimeCPUHistory.Offset, 2 * sizeof(float)); ImPlot::SetNextFillStyle(ImVec4(1.0f, 0.0f, 0.0f, 1.0f)); ImPlot::SetNextLineStyle(ImVec4(0.0f, 0.0f, 0.0f, 0.0f)); ImPlot::PlotBars("##DataWarn", &plot_data_warn[0].x, &plot_data_warn[0].y, plot_data_warn.size(), 1.0, m_FrameTimeCPUHistoryWarning.Offset, 2 * sizeof(float)); ImVec2 rmin = ImPlot::PlotToPixels(ImPlotPoint(plot_xmin, m_FrameTimeVsyncLimit)); ImVec2 rmax = ImPlot::PlotToPixels(ImPlotPoint(plot_xmax, m_FrameTimeVsyncLimit)); ImPlot::PushPlotClipRect(); ImPlot::GetPlotDrawList()->AddLine(rmin, rmax, ImGui::ColorConvertFloat4ToU32(ImGui::GetStyleColorVec4(ImGuiCol_Border)) ); ImPlot::PopPlotClipRect(); ImGui::PopClipRect(); } ImPlot::EndPlot(); } } void WindowPerformance::DrawFrameTimeGraphGPU(const ImVec2& graph_size, double plot_xmin, double plot_xmax, double plot_ymax) { float frame_offset = 1.0f + ImGui::GetStyle().FrameBorderSize; ImVec2 cursor_screen_pos_graph = ImGui::GetCursorScreenPos(); ImPlot::SetNextAxesLimits(plot_xmin, plot_xmax, 0.0, plot_ymax, ImGuiCond_Always); if (ImPlot::BeginPlot("##PlotGPU", graph_size, ImPlotFlags_CanvasOnly)) { const ImVector& plot_data = m_FrameTimeGPUHistory.Data; const ImVector& plot_data_warn = m_FrameTimeGPUHistoryWarning.Data; ImPlot::SetupAxes(nullptr, nullptr, ImPlotAxisFlags_NoDecorations, ImPlotAxisFlags_NoDecorations | ImPlotAxisFlags_LockMin); if (!plot_data.empty()) { ImGui::PushClipRect({cursor_screen_pos_graph.x + frame_offset, cursor_screen_pos_graph.y + frame_offset}, {(cursor_screen_pos_graph.x + graph_size.x) - frame_offset, cursor_screen_pos_graph.y + graph_size.y - frame_offset}, false); ImPlot::SetNextFillStyle(ImVec4(0.5f, 1.0f, 0.0f, 1.0f)); ImPlot::PlotShaded("##DataShaded", &plot_data[0].x, &plot_data[0].y, plot_data.size(), 0.0, ImPlotShadedFlags_None, m_FrameTimeGPUHistory.Offset, 2 * sizeof(float)); ImPlot::SetNextLineStyle(ImVec4(0.5f, 1.0f, 0.0f, 1.0f)); ImPlot::PlotLine("##DataLine", &plot_data[0].x, &plot_data[0].y, plot_data.size(), ImPlotLineFlags_None, m_FrameTimeGPUHistory.Offset, 2 * sizeof(float)); ImPlot::SetNextFillStyle(ImVec4(1.0f, 0.0f, 0.0f, 1.0f)); ImPlot::SetNextLineStyle(ImVec4(0.0f, 0.0f, 0.0f, 0.0f)); ImPlot::PlotBars("##DataWarn", &plot_data_warn[0].x, &plot_data_warn[0].y, plot_data_warn.size(), 1.0, m_FrameTimeGPUHistoryWarning.Offset, 2 * sizeof(float)); ImVec2 rmin = ImPlot::PlotToPixels(ImPlotPoint(plot_xmin, m_FrameTimeVsyncLimit)); ImVec2 rmax = ImPlot::PlotToPixels(ImPlotPoint(plot_xmax, m_FrameTimeVsyncLimit)); ImPlot::PushPlotClipRect(); ImPlot::GetPlotDrawList()->AddLine(rmin, rmax, ImGui::ColorConvertFloat4ToU32(ImGui::GetStyleColorVec4(ImGuiCol_Border)) ); ImPlot::PopPlotClipRect(); ImGui::PopClipRect(); } ImPlot::EndPlot(); } } void WindowPerformance::CheckScheduledOverlaySharedTextureUpdate() { if (!UIManager::Get()->IsOpenVRLoaded()) return; if (m_IsOverlaySharedTextureUpdateNeeded) { const DPRect& rect_total = UITextureSpaces::Get().GetRect(ui_texspace_total); vr::HmdVector2_t mouse_scale = {(float)rect_total.GetWidth(), (float)rect_total.GetHeight()}; bool all_ok = true; for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { const OverlayConfigData& data = OverlayManager::Get().GetConfigData(i); if (data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_ui) { vr::VROverlayHandle_t ovrl_handle = data.ConfigHandle[configid_handle_overlay_state_overlay_handle]; if (ovrl_handle != vr::k_ulOverlayHandleInvalid) { //Check if we're allowed to render to it from this process yet, otherwise try again next frame if (vr::VROverlay()->GetOverlayRenderingPid(ovrl_handle) == ::GetCurrentProcessId()) { vr::VROverlayEx()->SetSharedOverlayTexture(UIManager::Get()->GetOverlayHandleOverlayBar(), ovrl_handle, UIManager::Get()->GetSharedTextureRef()); vr::VROverlay()->SetOverlayMouseScale(ovrl_handle, &mouse_scale); } else { all_ok = false; } } else { all_ok = false; } } } if (all_ok) { OnWindowBoundsChanged(); m_IsOverlaySharedTextureUpdateNeeded = false; } } } void WindowPerformance::OnWindowBoundsChanged() { if (!UIManager::Get()->IsOpenVRLoaded()) return; //Texture bounds vr::VRTextureBounds_t bounds; //Avoid resize flicker before a real size is known (ImGui defaults to 32) and just set bounds to 0 in that case if (m_Size.x > 32.0f) { const DPRect& rect = UITextureSpaces::Get().GetRect(ui_texspace_performance_monitor); const DPRect& rect_total = UITextureSpaces::Get().GetRect(ui_texspace_total); float tex_width = (float)rect_total.GetWidth(); float tex_height = (float)rect_total.GetHeight(); bounds.uMin = rect.GetTL().x / tex_width; bounds.vMin = rect.GetTL().y / tex_height; bounds.uMax = rect.GetBR().x / tex_width; bounds.vMax = rect.GetBR().y / tex_height; } else { bounds.uMin = 0.0f; bounds.uMax = 0.0f; bounds.vMin = 0.0f; bounds.vMax = 0.0f; } //Interesection mask vr::VROverlayIntersectionMaskPrimitive_t intersection_mask; intersection_mask.m_nPrimitiveType = vr::OverlayIntersectionPrimitiveType_Rectangle; intersection_mask.m_Primitive.m_Rectangle.m_flTopLeftX = m_Pos.x; intersection_mask.m_Primitive.m_Rectangle.m_flTopLeftY = m_Pos.y; intersection_mask.m_Primitive.m_Rectangle.m_flWidth = m_Size.x; intersection_mask.m_Primitive.m_Rectangle.m_flHeight = m_Size.y; for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { const OverlayConfigData& data = OverlayManager::Get().GetConfigData(i); if (data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_ui) { vr::VROverlayHandle_t ovrl_handle = data.ConfigHandle[configid_handle_overlay_state_overlay_handle]; if (ovrl_handle != vr::k_ulOverlayHandleInvalid) { vr::VROverlay()->SetOverlayIntersectionMask(ovrl_handle, &intersection_mask, 1); vr::VROverlay()->SetOverlayTextureBounds(ovrl_handle, &bounds); } } } } void WindowPerformance::RefreshTrackerBatteryList() { m_BatteryTrackers.clear(); for (vr::TrackedDeviceIndex_t i = 0; i < vr::k_unMaxTrackedDeviceCount; ++i) { if ( (vr::VRSystem()->GetTrackedDeviceClass(i) == vr::TrackedDeviceClass_GenericTracker) && (vr::VRSystem()->IsTrackedDeviceConnected(i)) ) { TrackerInfo info; info.DeviceIndex = i; info.BatteryLevel = vr::VRSystem()->GetFloatTrackedDeviceProperty(i, vr::Prop_DeviceBatteryPercentage_Float) * 100.0f; info.Name = TranslationManager::GetString(tstr_PerformanceMonitorBatteryTracker); StringReplaceAll(info.Name, "%ID%", std::to_string(m_BatteryTrackers.size() + 1)); info.NameCompact = TranslationManager::GetString(tstr_PerformanceMonitorCompactBatteryTracker); StringReplaceAll(info.NameCompact, "%ID%", std::to_string(m_BatteryTrackers.size() + 1)); m_BatteryTrackers.push_back(info); } } } void WindowPerformance::ResetCumulativeValues() { m_FPS = 0; m_FPS_Average = 0.0f; m_FrameCountLast = 0; m_FrameCountTotal = 0; m_FrameCountTotalCount = 0; m_FPS_TickLast = 0; m_ViveWirelessTickLast = 0; //This is also called from the constructor when UIManager does not exist yet if ((UIManager::Get() != nullptr) && (UIManager::Get()->IsOpenVRLoaded())) { m_FrameTimeVsyncLimit = 1000.f / vr::VRSystem()->GetFloatTrackedDeviceProperty(vr::k_unTrackedDeviceIndex_Hmd, vr::Prop_DisplayFrequency_Float); //Update cumulative offset values vr::Compositor_CumulativeStats frame_stats = {0}; vr::VRCompositor()->GetCumulativeStats(&frame_stats, sizeof(vr::Compositor_CumulativeStats)); m_OffsetFramesPresents = frame_stats.m_nNumFramePresents; m_OffsetReprojectedFrames = frame_stats.m_nNumReprojectedFrames; m_OffsetDroppedFrames = frame_stats.m_nNumDroppedFrames; //Update frame index offset vr::Compositor_FrameTiming frame_timing_current; frame_timing_current.m_nSize = sizeof(vr::Compositor_FrameTiming); m_OffsetFrameIndex = 0; if (vr::VRCompositor()->GetFrameTiming(&frame_timing_current, 0)) { m_OffsetFrameIndex = frame_timing_current.m_nFrameIndex; } } } void WindowPerformance::ScheduleOverlaySharedTextureUpdate() { //We only want to set the shared texture once when needed, but also have to wait for the render PID to change (which is async) and stay responsive //so setting it is done by the performance window when possible m_IsOverlaySharedTextureUpdateNeeded = true; } Win32PerformanceData& WindowPerformance::GetPerformanceData() { return m_PerfData; } bool WindowPerformance::IsViveWirelessInstalled() { return m_ViveWirelessLogPathExists; } const ImVec2 & WindowPerformance::GetPos() const { return m_Pos; } const ImVec2 & WindowPerformance::GetSize() const { return m_Size; } bool WindowPerformance::IsVisible() const { return m_Visible; } void WindowPerformance::SetPopupOpen(bool is_open) { m_IsPopupOpen = is_open; } bool WindowPerformance::IsAnyOverlayUsingPerformanceMonitor() { if (!UIManager::Get()->IsOpenVRLoaded()) return false; //This isn't the most efficient check thanks to the split responsibilities of each process, but it's still better than always rendering the window for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { const OverlayConfigData& data = OverlayManager::Get().GetConfigData(i); if ( (data.ConfigBool[configid_bool_overlay_enabled]) && (data.ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_ui) ) { vr::VROverlayHandle_t ovrl_handle = data.ConfigHandle[configid_handle_overlay_state_overlay_handle]; if ( (ovrl_handle != vr::k_ulOverlayHandleInvalid) && (vr::VROverlay()->IsOverlayVisible(ovrl_handle)) ) { return true; } } } return false; } ================================================ FILE: src/DesktopPlusUI/WindowPerformance.h ================================================ #pragma once #include #include "imgui.h" #include "openvr.h" #include "Win32PerformanceData.h" //Taken from ImPlot struct ScrollingBufferFrameTime { int MaxSize; int Offset; ImVector Data; ScrollingBufferFrameTime() { MaxSize = 150; Offset = 0; Data.reserve(MaxSize); } void AddFrame(float frame_number, float ms) { if (Data.size() < MaxSize) { Data.push_back(ImVec2(frame_number, ms)); } else { Data[Offset] = ImVec2(frame_number, ms); Offset = (Offset + 1) % MaxSize; } } void Erase() { if (Data.size() > 0) { Data.shrink(0); Offset = 0; } } }; struct TrackerInfo { vr::TrackedDeviceIndex_t DeviceIndex = vr::k_unTrackedDeviceIndexInvalid; std::string Name; std::string NameCompact; float BatteryLevel; }; class WindowPerformance { private: ImVec2 m_Pos; ImVec2 m_Size; bool m_Visible; ULONGLONG m_VisibleTickLast; //Valid when m_Visible is false bool m_IsPopupOpen; float m_MinimalItemLineWrapMaxLength; float m_MinimalItemLineWrapPrevX; Win32PerformanceData m_PerfData; uint32_t m_PIDLast; //Frame-Rate stats, updated once a second int m_FPS; float m_FPS_Average; uint32_t m_FrameCountLast; uint32_t m_FrameCountTotal; uint32_t m_FrameCountTotalCount; ULONGLONG m_FPS_TickLast; //Offset values for cumulative counters uint32_t m_OffsetFrameIndex; uint32_t m_OffsetFramesPresents; uint32_t m_OffsetReprojectedFrames; uint32_t m_OffsetDroppedFrames; //Updated every frame float m_FrameTimeCPU; ScrollingBufferFrameTime m_FrameTimeCPUHistory; ScrollingBufferFrameTime m_FrameTimeCPUHistoryWarning; float m_FrameTimeGPU; ScrollingBufferFrameTime m_FrameTimeGPUHistory; ScrollingBufferFrameTime m_FrameTimeGPUHistoryWarning; float m_ReprojectionRatio; uint32_t m_DroppedFrames; float m_BatteryHMD; float m_BatteryLeft; float m_BatteryRight; std::vector m_BatteryTrackers; //List updated in RefreshTrackerBatteryList(), called on devices connect/disconnect uint32_t m_FrameTimeLastIndex; float m_FrameTimeVsyncLimit; //Localized time string, updated once a minute SYSTEMTIME m_TimeLast; std::string m_TimeStr; //Vive Wireless int m_ViveWirelessTemp; ULONGLONG m_ViveWirelessTickLast; std::wstring m_ViveWirelessLogPath; bool m_ViveWirelessLogPathExists; std::wstring m_ViveWirelessLogFileLast; int m_ViveWirelessLogFileLastLine; //Overlay state bool m_IsOverlaySharedTextureUpdateNeeded; //Wrapped text functions to choose whether outline variant should be used or not static void PerfMonText(const char* fmt, ...) IM_FMTARGS(2); static void PerfMonTextUnformatted(const char* text, const char* text_end = nullptr); static void PerfMonTextRight(float offset_x, float fixed_w, const char* fmt, ...) IM_FMTARGS(4); static void PerfMonTextRightUnformatted(float offset_x, float fixed_w, const char* text, const char* text_end = nullptr); //Called in Minimal style to do line wrapper on a per-item basis void StatsMinimalItemLineWrap(); void DisplayStatsLarge(); void DisplayStatsCompact(); void DisplayStatsMinimal(); void UpdateStatValues(); void UpdateStatValuesSteamVR(); void UpdateStatValuesViveWireless(); void DrawFrameTimeGraphCPU(const ImVec2& graph_size, double plot_xmin, double plot_xmax, double plot_ymax); void DrawFrameTimeGraphGPU(const ImVec2& graph_size, double plot_xmin, double plot_xmax, double plot_ymax); void CheckScheduledOverlaySharedTextureUpdate(); void OnWindowBoundsChanged(); public: WindowPerformance(); void Update(bool show_as_popup = false); void UpdateVisibleState(); void RefreshTrackerBatteryList(); void ResetCumulativeValues(); void ScheduleOverlaySharedTextureUpdate(); Win32PerformanceData& GetPerformanceData(); bool IsViveWirelessInstalled(); const ImVec2& GetPos() const; const ImVec2& GetSize() const; bool IsVisible() const; void SetPopupOpen(bool is_open); static bool IsAnyOverlayUsingPerformanceMonitor(); }; ================================================ FILE: src/DesktopPlusUI/WindowSettings.cpp ================================================ #include "WindowSettings.h" #include #include #include #include "ImGuiExt.h" #include "UIManager.h" #include "TranslationManager.h" #include "WindowManager.h" #include "InterprocessMessaging.h" #include "Util.h" #include "DesktopPlusWinRT.h" #include "DPBrowserAPIClient.h" WindowSettings::WindowSettings() : m_PageStackPos(0), m_PageStackPosAnimation(0), m_PageAnimationDir(0), m_PageAnimationProgress(0.0f), m_PageAnimationStartPos(0.0f), m_PageAnimationOffset(0.0f), m_PageAppearing(wndsettings_page_none), m_PageReturned(wndsettings_page_none), m_PageCurrent(wndsettings_page_none), m_Column0Width(0.0f), m_WarningHeight(0.0f), m_ProfileOverlaySelectIsSaving(false), m_ActionSelectionUID(0), m_ActionOrderListEditForOverlayBar(false), m_ActionPickerUID(k_ActionUID_Invalid), m_KeyCodePickerID(0), m_KeyCodePickerHotkeyFlags(0), m_KeyCodePickerNoMouse(false), m_KeyCodePickerHotkeyMode(false), m_WindowPickerHWND(nullptr) { m_WindowTitleStrID = tstr_SettingsWindowTitle; m_WindowIcon = tmtex_icon_xsmall_settings; m_OvrlWidth = OVERLAY_WIDTH_METERS_SETTINGS; m_OvrlWidthMax = OVERLAY_WIDTH_METERS_SETTINGS * 3.0f; //Leave 2 pixel padding around so interpolation doesn't cut off the pixel border const DPRect rect = UITextureSpaces::Get().GetRect(ui_texspace_settings); m_Size = {float(rect.GetWidth() - 4), float(rect.GetHeight() - 4)}; m_SizeUnscaled = m_Size; m_Pos = {float(rect.GetTL().x + 2), float(rect.GetTL().y + 2)}; m_PageStack.push_back(wndsettings_page_main); FloatingWindow::ResetTransformAll(); } void WindowSettings::Hide(bool skip_fade) { FloatingWindow::Hide(); ConfigManager::Get().SaveConfigToFile(); } void WindowSettings::ResetTransform(FloatingWindowOverlayStateID state_id) { FloatingWindow::ResetTransform(state_id); FloatingWindowOverlayState& overlay_state = GetOverlayState(state_id); overlay_state.Transform.rotateY(-15.0f); overlay_state.Transform.translate_relative(OVERLAY_WIDTH_METERS_DASHBOARD_UI / 3.0f, 0.70f, 0.15f); } vr::VROverlayHandle_t WindowSettings::GetOverlayHandle() const { return UIManager::Get()->GetOverlayHandleSettings(); } void WindowSettings::ApplyUIScale() { FloatingWindow::ApplyUIScale(); m_CachedSizes = {}; } void WindowSettings::UpdateDesktopMode() { WindowUpdate(); } void WindowSettings::UpdateDesktopModeWarnings() { UpdateWarnings(); } void WindowSettings::DesktopModeSetRootPage(WindowSettingsPage root_page) { m_PageStack[0] = root_page; m_PageAppearing = root_page; } const char* WindowSettings::DesktopModeGetTitle() const { if (m_PageStack[0] == wndsettings_page_profiles) return TranslationManager::GetString(tstr_SettingsProfilesOverlays); else if (m_PageStack[0] == wndsettings_page_app_profiles) return TranslationManager::GetString(tstr_SettingsProfilesApps); else if (m_PageStack[0] == wndsettings_page_actions) return TranslationManager::GetString(tstr_DesktopModeToolActions); else return TranslationManager::GetString(m_WindowTitleStrID); } bool WindowSettings::DesktopModeGetIconTextureInfo(ImVec2& size, ImVec2& uv_min, ImVec2& uv_max) const { return TextureManager::Get().GetTextureInfo(m_WindowIcon, size, uv_min, uv_max); } bool WindowSettings::DesktopModeGoBack() { if (m_PageStackPos != 0) { PageGoBack(); return true; } return false; } float WindowSettings::DesktopModeGetWarningHeight() const { return m_WarningHeight; } void WindowSettings::QuickStartGuideGoToPage(WindowSettingsPage new_page) { //This is only meant to be used by the Quick Start Guide window so it's not very flexible const WindowSettingsPage current_top_page = m_PageStack[m_PageStackPos]; if (current_top_page == new_page) return; switch (new_page) { case wndsettings_page_main: { PageGoHome(); break; } case wndsettings_page_actions: { if (current_top_page == wndsettings_page_actions_edit) { PageGoBack(); } else { PageGoForward(wndsettings_page_actions); } break; } case wndsettings_page_actions_edit: { if (current_top_page != wndsettings_page_actions) { PageGoForward(wndsettings_page_actions); } m_ActionSelectionUID = 0; PageGoForward(wndsettings_page_actions_edit); break; } } } void WindowSettings::ClearCachedTranslationStrings() { m_WarningTextOverlayError.clear(); m_WarningTextWinRTError.clear(); m_WarningTextAppProfile.clear(); m_TranslationAuthorLabel.clear(); m_BrowserMaxFPSValueText.clear(); m_BrowserBlockListCountText.clear(); m_ActionButtonsDefaultLabel.clear(); m_ActionButtonsOverlayBarLabel.clear(); m_ActionGlobalShortcutLabels.clear(); for (ConfigHotkey& hotkey : ConfigManager::Get().GetHotkeys()) { hotkey.StateUIName.clear(); } } void WindowSettings::WindowUpdate() { ImGui::SetWindowSize(m_Size); ImGuiStyle& style = ImGui::GetStyle(); m_Column0Width = ImGui::GetFontSize() * 12.75f; float page_width = m_Size.x - style.WindowBorderSize - style.WindowPadding.x - style.WindowPadding.x; //Compensate for the padding added in constructor and ignore border in desktop mode if (UIManager::Get()->IsInDesktopMode()) { page_width += 2 + style.WindowBorderSize; } //Page animation if (m_PageAnimationDir != 0) { //Use the averaged framerate value instead of delta time for the first animation step //This is to smooth over increased frame deltas that can happen when a new page needs to do initial larger computations or save/load files const float progress_step = (m_PageAnimationProgress == 0.0f) ? (1.0f / ImGui::GetIO().Framerate) * 3.0f : ImGui::GetIO().DeltaTime * 3.0f; m_PageAnimationProgress += progress_step; if (m_PageAnimationProgress >= 1.0f) { //Remove pages in the stack after finishing going back if (m_PageAnimationDir == 1) { while ((int)m_PageStack.size() > m_PageStackPosAnimation + 1) { m_PageStack.pop_back(); } m_PageAnimationDir = 0; //Add pending pages now that we don't have an active animation while (!m_PageStackPending.empty()) { PageGoForward(m_PageStackPending[0]); m_PageStackPending.erase(m_PageStackPending.begin()); } } m_PageAnimationProgress = 1.0f; m_PageAnimationDir = 0; } } else if (m_PageStackPosAnimation != m_PageStackPos) //Only start new animation if none is running { m_PageAnimationDir = (m_PageStackPosAnimation < m_PageStackPos) ? -1 : 1; m_PageStackPosAnimation = m_PageStackPos; m_PageAnimationStartPos = m_PageAnimationOffset; m_PageAnimationProgress = 0.0f; //Set appearing value to top of stack when starting animation to it if (m_PageAnimationDir == -1) { m_PageAppearing = m_PageStack.back(); } } else if ((m_PageStackPosAnimation == m_PageStackPos) && ((int)m_PageStack.size() > m_PageStackPos + 1)) { //Remove pages that were added and left again while there was no chance to animate anything while ((int)m_PageStack.size() > m_PageStackPos + 1) { m_PageStack.pop_back(); } } //Set appearing value when the whole window appeared again if ((m_PageAnimationDir == 0) && (m_IsWindowAppearing)) { m_PageAppearing = m_PageStack.back(); } const float target_x = (page_width + style.ItemSpacing.x) * -m_PageStackPosAnimation; m_PageAnimationOffset = smoothstep(m_PageAnimationProgress, m_PageAnimationStartPos, target_x); if (!UIManager::Get()->IsInDesktopMode()) { UpdateWarnings(); } //Set up page offset and clipping ImGui::SetCursorPosX( ImGui::GetCursorPosX() + m_PageAnimationOffset); ImGui::PushClipRect({m_Pos.x + style.WindowBorderSize, 0.0f}, {m_Pos.x + m_Size.x - style.WindowBorderSize, FLT_MAX}, false); const char* const child_str_id[] {"SettingsPageMain", "SettingsPage1", "SettingsPage2", "SettingsPage3"}; //No point in generating these on the fly const ImVec2 child_size = {page_width, ImGui::GetContentRegionAvail().y}; int child_id = 0; int stack_size = (int)m_PageStack.size(); for (WindowSettingsPage page_id : m_PageStack) { if (child_id >= IM_ARRAYSIZE(child_str_id)) break; m_PageCurrent = page_id; //Disable items when the page isn't active const bool is_inactive_page = (child_id != m_PageStackPos); if (is_inactive_page) { ImGui::PushItemDisabledNoVisual(); } ImGui::PushStyleColor(ImGuiCol_ChildBg, ImVec4(0.00f, 0.00f, 0.00f, 0.00f)); //This prevents child bg color being visible if there's a widget before this (e.g. warnings) if ( (ImGui::BeginChild(child_str_id[child_id], child_size, ImGuiChildFlags_NavFlattened)) || (m_PageAppearing == page_id) ) //Process page if currently appearing { ImGui::PopStyleColor(); //ImGuiCol_ChildBg switch (page_id) { case wndsettings_page_main: UpdatePageMain(); break; case wndsettings_page_persistent_ui: UpdatePagePersistentUI(); break; case wndsettings_page_keyboard: UpdatePageKeyboardLayout(); break; case wndsettings_page_profiles: UpdatePageProfiles(); break; case wndsettings_page_profiles_overlay_select: UpdatePageProfilesOverlaySelect(); break; case wndsettings_page_app_profiles: UpdatePageAppProfiles(); break; case wndsettings_page_actions: UpdatePageActions(); break; case wndsettings_page_actions_edit: UpdatePageActionsEdit(); break; case wndsettings_page_color_picker: UpdatePageColorPicker(); break; case wndsettings_page_profile_picker: UpdatePageProfilePicker(); break; case wndsettings_page_action_picker: UpdatePageActionPicker(); break; case wndsettings_page_actions_order_add: UpdatePageActionsOrderAdd(); break; case wndsettings_page_actions_order: UpdatePageActionsOrder(); break; case wndsettings_page_keycode_picker: UpdatePageKeyCodePicker(); break; case wndsettings_page_icon_picker: UpdatePageIconPicker(); break; case wndsettings_page_window_picker: UpdatePageWindowPicker(); break; case wndsettings_page_reset_confirm: UpdatePageResetConfirm(); break; default: break; } } else { ImGui::PopStyleColor(); //ImGuiCol_ChildBg } if (is_inactive_page) { ImGui::PopItemDisabledNoVisual(); } ImGui::EndChild(); if (child_id + 1 < stack_size) { ImGui::SameLine(); } child_id++; } m_PageAppearing = wndsettings_page_none; m_PageCurrent = wndsettings_page_none; ImGui::PopClipRect(); } void WindowSettings::UpdateWarnings() { if (!UIManager::Get()->IsAnyWarningDisplayed()) { m_WarningHeight = 0.0f; return; } bool warning_displayed = false; bool popup_visible = false; static float popup_alpha = 0.0f; const float warning_height_start = ImGui::GetCursorPosY(); //Compositor resolution warning { bool& hide_compositor_res_warning = ConfigManager::GetRef(configid_bool_interface_warning_compositor_res_hidden); if ( (!hide_compositor_res_warning) && (UIManager::Get()->IsCompositorResolutionLow()) ) { SelectableWarning("##WarningCompRes", "DontShowAgain", TranslationManager::GetString(tstr_SettingsWarningCompositorResolution)); ImGui::PushStyleVar(ImGuiStyleVar_Alpha, popup_alpha); if (ImGui::BeginPopup("DontShowAgain", ImGuiWindowFlags_NoMove)) { if (ImGui::Selectable(TranslationManager::GetString(tstr_SettingsWarningMenuDontShowAgain))) { hide_compositor_res_warning = true; } ImGui::EndPopup(); popup_visible = true; } ImGui::PopStyleVar(); warning_displayed = true; } } //Compositor quality warning { bool& hide_compositor_quality_warning = ConfigManager::GetRef(configid_bool_interface_warning_compositor_quality_hidden); if ( (!hide_compositor_quality_warning) && (UIManager::Get()->IsCompositorRenderQualityLow()) ) { SelectableWarning("##WarningCompQuality", "DontShowAgain2", TranslationManager::GetString(tstr_SettingsWarningCompositorQuality)); ImGui::PushStyleVar(ImGuiStyleVar_Alpha, popup_alpha); if (ImGui::BeginPopup("DontShowAgain2", ImGuiWindowFlags_NoMove)) { if (ImGui::Selectable(TranslationManager::GetString(tstr_SettingsWarningMenuDontShowAgain))) { hide_compositor_quality_warning = true; } ImGui::EndPopup(); popup_visible = true; } ImGui::PopStyleVar(); warning_displayed = true; } } //Dashboard app process elevation warning { bool& hide_process_elevation_warning = ConfigManager::GetRef(configid_bool_interface_warning_process_elevation_hidden); if ( (!hide_process_elevation_warning) && (ConfigManager::GetValue(configid_bool_state_misc_process_elevated)) ) { SelectableWarning("##WarningElevation", "DontShowAgain3", TranslationManager::GetString(tstr_SettingsWarningProcessElevated)); ImGui::PushStyleVar(ImGuiStyleVar_Alpha, popup_alpha); if (ImGui::BeginPopup("DontShowAgain3", ImGuiWindowFlags_NoMove)) { if (ImGui::Selectable(TranslationManager::GetString(tstr_SettingsWarningMenuDontShowAgain))) { hide_process_elevation_warning = true; } ImGui::EndPopup(); popup_visible = true; } ImGui::PopStyleVar(); warning_displayed = true; } } //Elevated mode warning (this is different from elevated dashboard process) { bool& hide_elevated_mode_warning = ConfigManager::GetRef(configid_bool_interface_warning_elevated_mode_hidden); if ( (!hide_elevated_mode_warning) && (ConfigManager::GetValue(configid_bool_state_misc_elevated_mode_active)) ) { SelectableWarning("##WarningElevatedMode", "DontShowAgain4", TranslationManager::GetString(tstr_SettingsWarningElevatedMode)); ImGui::PushStyleVar(ImGuiStyleVar_Alpha, popup_alpha); if (ImGui::BeginPopup("DontShowAgain4", ImGuiWindowFlags_NoMove)) { if (ImGui::Selectable(TranslationManager::GetString(tstr_SettingsWarningMenuDontShowAgain))) { hide_elevated_mode_warning = true; } else if (ImGui::Selectable(TranslationManager::GetString(tstr_SettingsTroubleshootingElevatedModeLeave))) { UIManager::Get()->ElevatedModeLeave(); } ImGui::EndPopup(); popup_visible = true; } ImGui::PopStyleVar(); warning_displayed = true; } } //Browser missing warning { bool& hide_browser_missing_warning = ConfigManager::GetRef(configid_bool_interface_warning_browser_missing_hidden); if ( (!hide_browser_missing_warning) && (ConfigManager::GetValue(configid_bool_state_misc_browser_used_but_missing)) ) { SelectableWarning("##WarningBrowserMissing", "DontShowAgain5", TranslationManager::GetString(tstr_SettingsWarningBrowserMissing)); ImGui::PushStyleVar(ImGuiStyleVar_Alpha, popup_alpha); if (ImGui::BeginPopup("DontShowAgain5", ImGuiWindowFlags_NoMove)) { if (ImGui::Selectable(TranslationManager::GetString(tstr_SettingsWarningMenuDontShowAgain))) { hide_browser_missing_warning = true; } ImGui::EndPopup(); popup_visible = true; } ImGui::PopStyleVar(); warning_displayed = true; } } //Browser mismatch warning { bool& hide_browser_version_mismatch_warning = ConfigManager::GetRef(configid_bool_interface_warning_browser_version_mismatch_hidden); if ( (!hide_browser_version_mismatch_warning) && (ConfigManager::GetValue(configid_bool_state_misc_browser_version_mismatch)) ) { SelectableWarning("##WarningBrowserMismatch", "DontShowAgain6", TranslationManager::GetString(tstr_SettingsWarningBrowserMismatch)); ImGui::PushStyleVar(ImGuiStyleVar_Alpha, popup_alpha); if (ImGui::BeginPopup("DontShowAgain6", ImGuiWindowFlags_NoMove)) { if (ImGui::Selectable(TranslationManager::GetString(tstr_SettingsWarningMenuDontShowAgain))) { hide_browser_version_mismatch_warning = true; } ImGui::EndPopup(); popup_visible = true; } ImGui::PopStyleVar(); warning_displayed = true; } } //Focused process elevation warning { if ( (ConfigManager::GetValue(configid_bool_state_window_focused_process_elevated)) && (!ConfigManager::GetValue(configid_bool_state_misc_process_elevated)) && (!ConfigManager::GetValue(configid_bool_state_misc_elevated_mode_active)) && (!ConfigManager::GetValue(configid_bool_state_misc_uiaccess_enabled)) ) { SelectableWarning("##WarningElevation2", "FocusedElevatedContext", TranslationManager::GetString(tstr_SettingsWarningElevatedProcessFocus)); ImGui::PushStyleVar(ImGuiStyleVar_Alpha, popup_alpha); if (ImGui::BeginPopup("FocusedElevatedContext", ImGuiWindowFlags_NoMove)) { if (ImGui::Selectable(TranslationManager::GetString(tstr_DefActionSwitchTask))) { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_switch_task); UIManager::Get()->RepeatFrame(); } else if ((UIManager::Get()->IsElevatedTaskSetUp()) && ImGui::Selectable(TranslationManager::GetString(tstr_SettingsTroubleshootingElevatedModeEnter))) { UIManager::Get()->ElevatedModeEnter(); UIManager::Get()->RepeatFrame(); } ImGui::EndPopup(); popup_visible = true; } ImGui::PopStyleVar(); warning_displayed = true; } } //UIAccess lost warning { if ( (ConfigManager::GetValue(configid_bool_misc_uiaccess_was_enabled)) && (!ConfigManager::GetValue(configid_bool_state_misc_uiaccess_enabled)) ) { SelectableWarning("##WarningUIAccess", "DontShowAgain6", TranslationManager::GetString(tstr_SettingsWarningUIAccessLost)); ImGui::PushStyleVar(ImGuiStyleVar_Alpha, popup_alpha); if (ImGui::BeginPopup("DontShowAgain6", ImGuiWindowFlags_NoMove)) { if (ImGui::Selectable(TranslationManager::GetString(tstr_SettingsWarningMenuDontShowAgain))) { ConfigManager::SetValue(configid_bool_misc_uiaccess_was_enabled, false); } ImGui::EndPopup(); popup_visible = true; } ImGui::PopStyleVar(); warning_displayed = true; } } //Overlay error warning { vr::EVROverlayError overlay_error = UIManager::Get()->GetOverlayErrorLast(); if ( (overlay_error != vr::VROverlayError_None) && (UIManager::Get()->IsOpenVRLoaded()) ) { if (overlay_error == vr::VROverlayError_OverlayLimitExceeded) { SelectableWarning("##WarningOverlayError", "DismissWarning", TranslationManager::GetString(tstr_SettingsWarningOverlayCreationErrorLimit)); } else { static vr::EVROverlayError overlay_error_last = overlay_error; //Format error string into cached translated string if ( (m_WarningTextOverlayError.empty()) || (overlay_error != overlay_error_last) ) { m_WarningTextWinRTError = TranslationManager::GetString(tstr_SettingsWarningGraphicsCaptureError); StringReplaceAll(m_WarningTextOverlayError, "%ERRORNAME%", vr::VROverlay()->GetOverlayErrorNameFromEnum(overlay_error)); overlay_error_last = overlay_error; } SelectableWarning("##WarningOverlayError", "DismissWarning", m_WarningTextOverlayError.c_str()); } ImGui::PushStyleVar(ImGuiStyleVar_Alpha, popup_alpha); if (ImGui::BeginPopup("DismissWarning", ImGuiWindowFlags_NoMove)) { if (ImGui::Selectable(TranslationManager::GetString(tstr_SettingsWarningMenuDismiss))) { UIManager::Get()->ResetOverlayErrorLast(); } ImGui::EndPopup(); popup_visible = true; } ImGui::PopStyleVar(); warning_displayed = true; } } //WinRT Capture error warning { HRESULT hr_error = UIManager::Get()->GetWinRTErrorLast(); if ( (hr_error != S_OK) && (UIManager::Get()->IsOpenVRLoaded()) ) { static HRESULT hr_error_last = hr_error; //Format error code into cached translated string if ( (m_WarningTextWinRTError.empty()) || (hr_error != hr_error_last) ) { std::stringstream ss; ss << "0x" << std::hex << hr_error; m_WarningTextWinRTError = TranslationManager::GetString(tstr_SettingsWarningGraphicsCaptureError); StringReplaceAll(m_WarningTextWinRTError, "%ERRORCODE%", ss.str()); hr_error_last = hr_error; } SelectableWarning("##WarningWinRTError", "DismissWarning2", m_WarningTextWinRTError.c_str()); ImGui::PushStyleVar(ImGuiStyleVar_Alpha, popup_alpha); if (ImGui::BeginPopup("DismissWarning2", ImGuiWindowFlags_NoMove)) { if (ImGui::Selectable(TranslationManager::GetString(tstr_SettingsWarningMenuDismiss))) { UIManager::Get()->ResetWinRTErrorLast(); } ImGui::EndPopup(); popup_visible = true; } ImGui::PopStyleVar(); warning_displayed = true; } } //App profile with overlay profile active warning { bool& hide_app_profile_active_warning = ConfigManager::GetRef(configid_bool_interface_warning_app_profile_active_hidden); if ( (!hide_app_profile_active_warning) && (ConfigManager::Get().GetAppProfileManager().IsActiveProfileWithOverlayProfile()) ) { static std::string active_app_key_last; //Format app name into cached translated string if ( (m_WarningTextAppProfile.empty()) || (ConfigManager::Get().GetAppProfileManager().GetActiveProfileAppKey() != active_app_key_last) ) { m_WarningTextAppProfile = TranslationManager::GetString(tstr_SettingsWarningAppProfileActive); StringReplaceAll(m_WarningTextAppProfile, "%APPNAME%", ConfigManager::Get().GetAppProfileManager().GetActiveProfileAppName()); active_app_key_last = ConfigManager::Get().GetAppProfileManager().GetActiveProfileAppKey(); } SelectableWarning("##WarningAppProfile", "DontShowAgain7", m_WarningTextAppProfile.c_str()); ImGui::PushStyleVar(ImGuiStyleVar_Alpha, popup_alpha); if (ImGui::BeginPopup("DontShowAgain7", ImGuiWindowFlags_NoMove)) { if (ImGui::Selectable(TranslationManager::GetString(tstr_SettingsWarningMenuDontShowAgain))) { hide_app_profile_active_warning = true; } ImGui::EndPopup(); popup_visible = true; } ImGui::PopStyleVar(); warning_displayed = true; } } //Config migrated in current session "warning" { if (ConfigManager::GetValue(configid_bool_state_misc_config_migrated)) { SelectableWarning("##WarningConfigMigrated", "DismissWarning3", TranslationManager::GetString(tstr_SettingsWarningConfigMigrated), false, &Style_ImGuiCol_TextNotification); ImGui::PushStyleVar(ImGuiStyleVar_Alpha, popup_alpha); if (ImGui::BeginPopup("DismissWarning3", ImGuiWindowFlags_NoMove)) { if (ImGui::Selectable(TranslationManager::GetString(tstr_SettingsWarningMenuDismiss))) { ConfigManager::SetValue(configid_bool_state_misc_config_migrated, false); } ImGui::EndPopup(); popup_visible = true; } ImGui::PopStyleVar(); warning_displayed = true; } } //Separate from the main content if a warning was actually displayed if (warning_displayed) { ImGui::Separator(); } else //...no warning displayed but UIManager still thinks there is one, so update that state { UIManager::Get()->UpdateAnyWarningDisplayedState(); } m_WarningHeight = ImGui::GetCursorPosY() - warning_height_start; //Animate fade-in if any of the popups is visible if (popup_visible) { popup_alpha += ImGui::GetIO().DeltaTime * 10.0f; if (popup_alpha > 1.0f) popup_alpha = 1.0f; } else { popup_alpha = 0.0f; } } #include "implot.h" void WindowSettings::UpdatePageMain() { ImGui::PushStyleColor(ImGuiCol_ChildBg, ImVec4(0.00f, 0.00f, 0.00f, 0.00f)); ImGui::BeginChild("SettingsMainContent", ImVec2(0.00f, 0.00f), ImGuiChildFlags_NavFlattened); ImGui::PopStyleColor(); //Page Content UpdatePageMainCatInterface(); UpdatePageMainCatProfiles(); UpdatePageMainCatActions(); UpdatePageMainCatInput(); UpdatePageMainCatWindows(); UpdatePageMainCatBrowser(); UpdatePageMainCatPerformance(); UpdatePageMainCatMisc(); ImGui::EndChild(); } void WindowSettings::UpdatePageMainCatInterface() { const ImGuiStyle& style = ImGui::GetStyle(); //Interface { ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_SettingsCatInterface)); ImGui::Columns(2, "ColumnInterface", false); ImGui::SetColumnWidth(0, m_Column0Width); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted( TranslationManager::GetString(tstr_SettingsInterfaceLanguage) ); if (!TranslationManager::Get().IsCurrentTranslationComplete()) { ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsInterfaceLanguageIncompleteWarning), "(!)"); } ImGui::NextColumn(); ImGui::PushItemWidth(-1); if (ImGui::BeginComboAnimated("##ComboLang", TranslationManager::Get().GetCurrentTranslationName().c_str() )) { static std::vector list_langs; static int list_id = 0; //Load language list when dropdown is used for the first time if (ImGui::IsWindowAppearing()) { if (list_langs.empty()) { list_id = 0; list_langs = TranslationManager::GetTranslationList(); } //Select matching entry and add unmapped characters if needed const std::string& current_filename = ConfigManager::GetValue(configid_str_interface_language_file); for (auto it = list_langs.cbegin(); it != list_langs.cend(); ++it) { if (current_filename == it->FileName) { list_id = (int)std::distance(list_langs.cbegin(), it); } UIManager::Get()->AddFontBuilderStringIfAnyUnmappedCharacters(it->ListName.c_str()); } } int i = 0; for (const auto& item : list_langs) { if (ImGui::Selectable(item.ListName.c_str(), (list_id == i))) { ConfigManager::SetValue(configid_str_interface_language_file, item.FileName); TranslationManager::Get().LoadTranslationFromFile(item.FileName); UIManager::Get()->OnTranslationChanged(); list_id = i; } i++; } ImGui::EndCombo(); } ImGui::NextColumn(); ImGui::NextColumn(); if (!TranslationManager::Get().GetCurrentTranslationAuthor().empty()) { if (m_TranslationAuthorLabel.empty()) { m_TranslationAuthorLabel = TranslationManager::GetString(tstr_SettingsInterfaceLanguageCommunity); StringReplaceAll(m_TranslationAuthorLabel, "%AUTHOR%", TranslationManager::Get().GetCurrentTranslationAuthor()); } ImGui::Indent(style.ItemInnerSpacing.x); //Indent a bit since text lined up with the combo widget instead of the widget's text looks a bit odd ImGui::PushTextWrapPos(); ImGui::TextUnformatted(m_TranslationAuthorLabel.c_str()); ImGui::PopTextWrapPos(); ImGui::Unindent(style.ItemInnerSpacing.x); } ImGui::Columns(1); ImGui::Spacing(); ImGui::Indent(); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsInterfaceAdvancedSettings), &ConfigManager::GetRef(configid_bool_interface_show_advanced_settings))) { UIManager::Get()->RepeatFrame(); } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsInterfaceAdvancedSettingsTip)); if (ConfigManager::GetValue(configid_bool_interface_show_advanced_settings)) { ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsInterfaceBlankSpaceDrag), &ConfigManager::GetRef(configid_bool_interface_blank_space_drag_enabled)); } ImGui::Unindent(); if (ConfigManager::GetValue(configid_bool_interface_show_advanced_settings)) { ImGui::Spacing(); ImGui::Columns(2, "ColumnInterface2", false); ImGui::SetColumnWidth(0, m_Column0Width); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsInterfacePersistentUI)); ImGui::NextColumn(); ImGui::PushID(tstr_SettingsInterfacePersistentUI); //Avoid ID conflict from common "Manage" label if (ImGui::Button(TranslationManager::GetString(tstr_SettingsInterfacePersistentUIManage))) { PageGoForward(wndsettings_page_persistent_ui); } ImGui::PopID(); ImGui::Columns(1); } ImGui::Spacing(); ImGui::Columns(2, "ColumnInterface3", false); ImGui::SetColumnWidth(0, m_Column0Width); ImGui::AlignTextToFramePadding(); ImGui::Text(TranslationManager::GetString(tstr_SettingsInterfaceDesktopButtons)); ImGui::NextColumn(); ImGui::SetNextItemWidth(-1); int button_style = clamp(ConfigManager::GetRef(configid_int_interface_desktop_listing_style), 0, (tstr_SettingsInterfaceDesktopButtonsCycle - tstr_SettingsInterfaceDesktopButtonsNone) - 1); if (TranslatedComboAnimated("##ComboButtonStyle", button_style, tstr_SettingsInterfaceDesktopButtonsNone, tstr_SettingsInterfaceDesktopButtonsCycle)) { ConfigManager::SetValue(configid_int_interface_desktop_listing_style, button_style); UIManager::Get()->RepeatFrame(); } ImGui::NextColumn(); ImGui::NextColumn(); bool& include_all = ConfigManager::GetRef(configid_bool_interface_desktop_buttons_include_combined); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsInterfaceDesktopButtonsAddCombined), &include_all)) { UIManager::Get()->RepeatFrame(); } ImGui::Columns(1); } //Environment (still Interface, but not really) { static ImVec4 background_color_vec4; if ( (m_PageAppearing == wndsettings_page_main) || (m_PageReturned == wndsettings_page_color_picker) ) { background_color_vec4 = ImGui::ColorConvertU32ToFloat4(*(ImU32*)&ConfigManager::Get().GetRef(configid_int_interface_background_color)); m_PageReturned = wndsettings_page_none; } ImGui::Spacing(); ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_SettingsCatEnvironment)); ImGui::Columns(2, "ColumnEnvironment", false); ImGui::SetColumnWidth(0, m_Column0Width); ImGui::AlignTextToFramePadding(); ImGui::Text(TranslationManager::GetString(tstr_SettingsEnvironmentBackgroundColor)); ImGui::NextColumn(); if (ImGui::ColorButton("##BackgroundColor", background_color_vec4, ImGuiColorEditFlags_NoTooltip | ImGuiColorEditFlags_NoDragDrop)) { PageGoForward(wndsettings_page_color_picker); } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); int& mode_display = ConfigManager::GetRef(configid_int_interface_background_color_display_mode); ImGui::SetNextItemWidth(-1); if (TranslatedComboAnimated("##ComboBackgroundDisplay", mode_display, tstr_SettingsEnvironmentBackgroundColorDispModeNever, tstr_SettingsEnvironmentBackgroundColorDispModeAlways)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_interface_background_color_display_mode, mode_display); } ImGui::NextColumn(); bool& dim_ui = ConfigManager::Get().GetRef(configid_bool_interface_dim_ui); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsEnvironmentDimInterface), &dim_ui)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_interface_dim_ui, dim_ui); if (UIManager::Get()->IsOpenVRLoaded()) { UIManager::Get()->UpdateOverlayDimming(); } } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsEnvironmentDimInterfaceTip)); ImGui::Columns(1); } } void WindowSettings::UpdatePageMainCatProfiles() { //Profiles { ImGui::Spacing(); ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_SettingsCatProfiles)); ImGui::Columns(2, "ColumnInterface", false); ImGui::SetColumnWidth(0, m_Column0Width); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsProfilesOverlays)); ImGui::NextColumn(); ImGui::PushID(tstr_SettingsProfilesManage); //Avoid ID conflict from common "Manage" label if (ImGui::Button(TranslationManager::GetString(tstr_SettingsProfilesManage))) { PageGoForward(wndsettings_page_profiles); } ImGui::PopID(); ImGui::NextColumn(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsProfilesApps)); ImGui::NextColumn(); ImGui::PushID(tstr_SettingsProfilesApps); //Avoid ID conflict from common "Manage" label if (ImGui::Button(TranslationManager::GetString(tstr_SettingsProfilesManage))) { PageGoForward(wndsettings_page_app_profiles); } ImGui::PopID(); ImGui::Columns(1); } } void WindowSettings::UpdatePageMainCatActions() { //Actions { const ActionManager& action_manager = ConfigManager::Get().GetActionManager(); ActionManager::ActionList& global_shortcut_list = ConfigManager::Get().GetGlobalShortcuts(); ConfigHotkeyList& hotkey_list = ConfigManager::Get().GetHotkeys(); const ImGuiStyle& style = ImGui::GetStyle(); static ConfigID_Handle action_picker_config_id = configid_handle_MAX; static int action_picker_global_shortcut_id = -1; static int action_picker_hotkey_id = -1; static float button_binding_width = 0.0f; if (m_PageReturned == wndsettings_page_actions_order) { m_ActionButtonsDefaultLabel.clear(); m_ActionButtonsOverlayBarLabel.clear(); m_PageReturned = wndsettings_page_none; } else if (m_PageReturned == wndsettings_page_action_picker) { if (action_picker_config_id != configid_handle_MAX) { ConfigManager::SetValue(action_picker_config_id, m_ActionPickerUID); IPCManager::Get().PostConfigMessageToDashboardApp(action_picker_config_id, m_ActionPickerUID); action_picker_config_id = configid_handle_MAX; m_PageReturned = wndsettings_page_none; } else if (action_picker_global_shortcut_id != -1) { if ((action_picker_global_shortcut_id >= 0) && (action_picker_global_shortcut_id < (int)global_shortcut_list.size())) { global_shortcut_list[action_picker_global_shortcut_id] = m_ActionPickerUID; IPCManager::Get().PostConfigMessageToDashboardApp(configid_handle_state_action_uid, m_ActionPickerUID); IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_global_shortcut_set, action_picker_global_shortcut_id); } action_picker_global_shortcut_id = -1; m_PageReturned = wndsettings_page_none; } else if (action_picker_hotkey_id != -1) { if ((action_picker_hotkey_id >= 0) && (action_picker_hotkey_id < (int)hotkey_list.size())) { ConfigHotkey& hotkey = hotkey_list[action_picker_hotkey_id]; hotkey.ActionUID = m_ActionPickerUID; IPCManager::Get().SendStringToDashboardApp(configid_str_state_hotkey_data, hotkey.Serialize(), UIManager::Get()->GetWindowHandle()); IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_hotkey_set, action_picker_hotkey_id); } action_picker_hotkey_id = -1; m_PageReturned = wndsettings_page_none; } } if (m_ActionButtonsDefaultLabel.empty()) { const size_t action_count = ConfigManager::Get().GetActionManager().GetActionOrderListBarDefault().size(); m_ActionButtonsDefaultLabel = TranslationManager::GetString( (action_count == 1) ? tstr_SettingsActionsOrderButtonLabelSingular : tstr_SettingsActionsOrderButtonLabel ); StringReplaceAll(m_ActionButtonsDefaultLabel, "%COUNT%", std::to_string(action_count)); } if (m_ActionButtonsOverlayBarLabel.empty()) { const size_t action_count = ConfigManager::Get().GetActionManager().GetActionOrderListOverlayBar().size(); m_ActionButtonsOverlayBarLabel = TranslationManager::GetString( (action_count == 1) ? tstr_SettingsActionsOrderButtonLabelSingular : tstr_SettingsActionsOrderButtonLabel ); StringReplaceAll(m_ActionButtonsOverlayBarLabel, "%COUNT%", std::to_string(action_count)); } if ((m_ActionGlobalShortcutLabels.empty()) || (m_ActionGlobalShortcutLabels.size() != global_shortcut_list.size())) { m_ActionGlobalShortcutLabels.clear(); for (int i = 0; i < global_shortcut_list.size(); ++i) { std::string label = TranslationManager::GetString(tstr_SettingsActionsGlobalShortcutsEntry); StringReplaceAll(label, "%ID%", std::to_string(i + 1)); m_ActionGlobalShortcutLabels.push_back(label); } } ImGui::Spacing(); ImGui::TextColored(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_SettingsCatActions)); ImGui::Columns(2, "ColumnActions", false); ImGui::SetColumnWidth(0, m_Column0Width); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsActionsManage)); ImGui::NextColumn(); ImGui::PushID(tstr_SettingsActionsManage); //Avoid ID conflict from common "Manage" label if (ImGui::Button(TranslationManager::GetString(tstr_SettingsActionsManageButton))) { PageGoForward(wndsettings_page_actions); } ImGui::PopID(); ImGui::NextColumn(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsActionsButtonsOrderDefault)); ImGui::NextColumn(); ImGui::PushID(tstr_SettingsActionsButtonsOrderDefault); if (ImGui::Button(m_ActionButtonsDefaultLabel.c_str())) { m_ActionOrderListEditForOverlayBar = false; PageGoForward(wndsettings_page_actions_order); } ImGui::PopID(); ImGui::NextColumn(); if (ConfigManager::GetValue(configid_bool_interface_show_advanced_settings)) { ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsActionsButtonsOrderOverlayBar)); ImGui::NextColumn(); ImGui::PushID(tstr_SettingsActionsButtonsOrderOverlayBar); if (ImGui::Button(m_ActionButtonsOverlayBarLabel.c_str())) { m_ActionOrderListEditForOverlayBar = true; PageGoForward(wndsettings_page_actions_order); } ImGui::PopID(); ImGui::NextColumn(); } ImGui::Spacing(); ImGui::Columns(1); //Active Shortcuts if (UIManager::Get()->IsOpenVRLoaded()) ImGui::Spacing(); ImGui::Indent(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsActionsActiveShortcuts)); ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsActionsActiveShortcutsTip)); ImGui::PushID("ActiveButtons"); if (UIManager::Get()->IsOpenVRLoaded()) { ImGui::SameLine(ImGui::GetContentRegionAvail().x - button_binding_width - 1.0f); if (ImGui::SmallButton(TranslationManager::GetString(tstr_SettingsActionsShowBindings))) { //OpenBindingUI does not use that app key argument it takes, it always opens the bindings of the calling application //To work around this, we pretend to be the app we want to open the bindings for during the call //Works and seems to not break anything vr::VRApplications()->IdentifyApplication(::GetCurrentProcessId(), "openvr.component.vrcompositor"); vr::VRInput()->OpenBindingUI("openvr.component.vrcompositor", vr::k_ulInvalidActionSetHandle, vr::k_ulInvalidInputValueHandle, UIManager::Get()->IsInDesktopMode()); vr::VRApplications()->IdentifyApplication(::GetCurrentProcessId(), g_AppKeyUIApp); } button_binding_width = ImGui::GetItemRectSize().x; //For reasons unknown, if there's no item added in this spot and the Show Bindings button exist, ImGuiContext::HoveredIdDisabled will be true for the table rows (needs to be false for haptics) //This is despite item disabled last being set in CompactTableHeadersRow(), so I'm not sure how this transfers over, but this works, eh ImGui::SameLine(); ImGui::Dummy({0.0f, 0.0f}); } ImGui::Indent(); const ImVec2 table_size(-style.IndentSpacing - 1.0f, 0.0f); //Replicate padding from columns const float table_column_width = m_Column0Width - style.IndentSpacing - style.IndentSpacing; //Align with width of other columns const float table_cell_height = ImGui::GetFontSize() + style.ItemInnerSpacing.y; if (BeginCompactTable("TableActiveButtons", 2, ImGuiTableFlags_RowBg | ImGuiTableFlags_SizingFixedFit, table_size)) { ImGui::TableSetupColumn(TranslationManager::GetString(tstr_SettingsActionsTableHeaderShortcut), 0, table_column_width); ImGui::TableSetupColumn(TranslationManager::GetString(tstr_SettingsActionsTableHeaderAction), ImGuiTableColumnFlags_WidthStretch); CompactTableHeadersRow(); for (int i = 0; i < 2; ++i) { ConfigID_Handle config_id = (i == 0) ? configid_handle_input_go_home_action_uid : configid_handle_input_go_back_action_uid; ActionUID uid = ConfigManager::GetValue(config_id); ImGui::PushID(i); ImGui::TableNextColumn(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString((i == 0) ? tstr_SettingsActionsActiveShortuctsHome : tstr_SettingsActionsActiveShortuctsBack)); ImGui::SameLine(); ImGui::TableNextColumn(); if (ImGui::Selectable(action_manager.GetTranslatedName(uid))) { m_ActionPickerUID = uid; action_picker_config_id = config_id; PageGoForward(wndsettings_page_action_picker); } ImGui::PopID(); } EndCompactTable(); } ImGui::PopID(); ImGui::Unindent(); //Global Shortcuts ImGui::Spacing(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsActionsGlobalShortcuts)); ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsActionsGlobalShortcutsTip)); ImGui::PushID("GlobalShortcuts"); if (UIManager::Get()->IsOpenVRLoaded()) { ImGui::SameLine(ImGui::GetContentRegionAvail().x - button_binding_width - 1.0f); if (ImGui::SmallButton(TranslationManager::GetString(tstr_SettingsActionsShowBindings))) { //See comment on the active shortcuts vr::VRApplications()->IdentifyApplication(::GetCurrentProcessId(), g_AppKeyDashboardApp); vr::VRInput()->OpenBindingUI(g_AppKeyDashboardApp, vr::k_ulInvalidActionSetHandle, vr::k_ulInvalidInputValueHandle, UIManager::Get()->IsInDesktopMode()); vr::VRApplications()->IdentifyApplication(::GetCurrentProcessId(), g_AppKeyUIApp); } //See Active Shortcuts comment ImGui::SameLine(); ImGui::Dummy({0.0f, 0.0f}); } ImGui::Indent(); static float table_global_shortcuts_buttons_width = 0.0f; const int shortcuts_visible = (int)global_shortcut_list.size(); const int shortcuts_max = ConfigManager::GetValue(configid_int_input_global_shortcuts_max_count); if (BeginCompactTable("TableGlobalShortcuts", 2, ImGuiTableFlags_RowBg | ImGuiTableFlags_SizingFixedFit, table_size)) { ImGui::TableSetupColumn(TranslationManager::GetString(tstr_SettingsActionsTableHeaderShortcut), 0, table_column_width); ImGui::TableSetupColumn(TranslationManager::GetString(tstr_SettingsActionsTableHeaderAction), ImGuiTableColumnFlags_WidthStretch); CompactTableHeadersRow(); IM_ASSERT(m_ActionGlobalShortcutLabels.size() == global_shortcut_list.size()); int shortcut_id = 0; for (ActionUID uid : global_shortcut_list) { ImGui::PushID(shortcut_id); ImGui::TableNextColumn(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(m_ActionGlobalShortcutLabels[shortcut_id].c_str()); ImGui::SameLine(); ImGui::TableNextColumn(); if (ImGui::Selectable(action_manager.GetTranslatedName(uid))) { m_ActionPickerUID = uid; action_picker_global_shortcut_id = shortcut_id; PageGoForward(wndsettings_page_action_picker); } ImGui::PopID(); ++shortcut_id; } EndCompactTable(); } ImGui::SetCursorPosX(ImGui::GetCursorPosX() + ImGui::GetContentRegionAvail().x - table_global_shortcuts_buttons_width - 1.0f); ImGui::BeginGroup(); if (shortcuts_visible >= shortcuts_max) ImGui::PushItemDisabled(); if (ImGui::Button(TranslationManager::GetString(tstr_SettingsActionsGlobalShortcutsAdd))) { global_shortcut_list.push_back(k_ActionUID_Invalid); ImGui::SetScrollY(ImGui::GetScrollY() + table_cell_height); } if (shortcuts_visible >= shortcuts_max) ImGui::PopItemDisabled(); ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); if (shortcuts_visible <= 1) ImGui::PushItemDisabled(); if (ImGui::Button(TranslationManager::GetString(tstr_SettingsActionsGlobalShortcutsRemove))) { global_shortcut_list.pop_back(); ImGui::SetScrollY(ImGui::GetScrollY() - table_cell_height); } if (shortcuts_visible <= 1) ImGui::PopItemDisabled(); ImGui::EndGroup(); table_global_shortcuts_buttons_width = ImGui::GetItemRectSize().x + style.IndentSpacing; ImGui::PopID(); ImGui::Unindent(); //Hotkeys static float table_hotkeys_max_column_width = 0.0f; static float table_hotkeys_remove_button_width = 0.0f; static float table_hotkeys_buttons_width = 0.0f; static int table_hotkeys_hovered_row = -1; ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsActionsHotkeys)); ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsActionsHotkeysTip)); ImGui::Indent(); ImGui::PushID("Hotkeys"); if (BeginCompactTable("TableHotkeys", 2, ImGuiTableFlags_RowBg | ImGuiTableFlags_SizingFixedFit, table_size)) { ImGui::TableSetupColumn(TranslationManager::GetString(tstr_SettingsActionsTableHeaderHotkey), 0, std::max(table_column_width, table_hotkeys_max_column_width)); ImGui::TableSetupColumn(TranslationManager::GetString(tstr_SettingsActionsTableHeaderAction), ImGuiTableColumnFlags_WidthStretch); CompactTableHeadersRow(); ImGui::TableNextColumn(); float line_start_x = ImGui::GetCursorPosX(); table_hotkeys_max_column_width = 0.0f; int hovered_row_new = -1; int hotkey_id = 0; for (ConfigHotkey& hotkey : hotkey_list) { ImGui::PushID(hotkey_id); ImGui::AlignTextToFramePadding(); SelectableHotkey(hotkey, hotkey_id); ImGui::SameLine(0.0f, 0.0f); table_hotkeys_max_column_width = std::max(table_hotkeys_max_column_width, ImGui::GetCursorPosX() - line_start_x); ImGui::TableNextColumn(); if (table_hotkeys_hovered_row == hotkey_id) { //Use lower-alpha version of hovered header color while the remove button is hovered to increase the contrast with the button hover color (we don't really want to change it, however) ImVec4 col = ImGui::GetStyleColorVec4(ImGuiCol_HeaderHovered); col.w *= 0.75f; ImGui::PushStyleColor(ImGuiCol_Header, col); } if (ImGui::Selectable(action_manager.GetTranslatedName(hotkey.ActionUID), (table_hotkeys_hovered_row == hotkey_id), ImGuiSelectableFlags_AllowOverlap)) { m_ActionPickerUID = hotkey.ActionUID; action_picker_hotkey_id = hotkey_id; PageGoForward(wndsettings_page_action_picker); } if (ImGui::IsItemHovered(ImGuiHoveredFlags_AllowWhenOverlapped | ImGuiHoveredFlags_AllowWhenBlockedByActiveItem)) { hovered_row_new = hotkey_id; } if (table_hotkeys_hovered_row == hotkey_id) { ImGui::PopStyleColor(); //Show remove button only if there's more than one hotkey or the single existing hotkey has properties set (basically no button that doesn't do anything) if ((hotkey_list.size() > 1) || (hotkey.KeyCode != 0) || (hotkey.ActionUID != k_ActionUID_Invalid)) { ImGui::SetNextItemAllowOverlap(); ImGui::SameLine(); ImGui::SetCursorPosX(ImGui::GetCursorPosX() + ImGui::GetContentRegionAvail().x - table_hotkeys_remove_button_width); if (ImGui::SmallButton(TranslationManager::GetString(tstr_SettingsActionsHotkeysRemove))) { if (hotkey_list.size() > 1) { hotkey_list.erase(hotkey_list.begin() + hotkey_id); IPCManager::Get().SendStringToDashboardApp(configid_str_state_hotkey_data, "", UIManager::Get()->GetWindowHandle()); } else //If there's only one entry, clear it instead to not have a weird looking table { hotkey = ConfigHotkey(); IPCManager::Get().SendStringToDashboardApp(configid_str_state_hotkey_data, hotkey.Serialize(), UIManager::Get()->GetWindowHandle()); } IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_hotkey_set, hotkey_id); //Keep scroll position constant ImGui::SetScrollY(ImGui::GetScrollY() - table_cell_height); //Erased something straight out of the list, get out of the loop and discard frame UIManager::Get()->RepeatFrame(); ImGui::PopID(); break; } if (ImGui::IsItemHovered()) { hovered_row_new = hotkey_id; } table_hotkeys_remove_button_width = ImGui::GetItemRectSize().x; } } ImGui::TableNextColumn(); ImGui::PopID(); ++hotkey_id; } table_hotkeys_hovered_row = hovered_row_new; EndCompactTable(); } ImGui::SetCursorPosX(ImGui::GetCursorPosX() + ImGui::GetContentRegionAvail().x - table_hotkeys_buttons_width - 1.0f); if (ImGui::Button(TranslationManager::GetString(tstr_SettingsActionsHotkeysAdd))) { ConfigHotkey hotkey_new; hotkey_list.push_back(hotkey_new); IPCManager::Get().SendStringToDashboardApp(configid_str_state_hotkey_data, hotkey_new.Serialize(), UIManager::Get()->GetWindowHandle()); IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_hotkey_set, hotkey_list.size() - 1); ImGui::SetScrollY(ImGui::GetScrollY() + table_cell_height); UIManager::Get()->RepeatFrame(3); //Avoid some flicker from potentially hovering selectable + remove button appearing in the next few frames } table_hotkeys_buttons_width = ImGui::GetItemRectSize().x + style.IndentSpacing; ImGui::PopID(); ImGui::Unindent(); ImGui::Unindent(); ImGui::Columns(1); } } void WindowSettings::UpdatePageMainCatInput() { static bool is_any_gc_overlay_active = false; if (m_PageAppearing == wndsettings_page_main) { //Check if any Graphics Capture overlays are active is_any_gc_overlay_active = false; for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { if (OverlayManager::Get().GetConfigData(i).ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_winrt_capture) { is_any_gc_overlay_active = true; break; } } } VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); const ImGuiStyle& style = ImGui::GetStyle(); //Keyboard { ImGui::Spacing(); ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_SettingsCatKeyboard)); ImGui::Columns(2, "ColumnKeyboard", false); ImGui::SetColumnWidth(0, m_Column0Width); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsKeyboardLayout)); ImGui::NextColumn(); if (ImGui::Button( UIManager::Get()->GetVRKeyboard().GetLayoutMetadata().Name.c_str() )) { PageGoForward(wndsettings_page_keyboard); } ImGui::NextColumn(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsKeyboardSize)); ImGui::NextColumn(); //Keyboard size setting shows size of currently visible overlay state (usually dashboard tab) and applies it to all WindowKeyboard& window_keyboard = UIManager::Get()->GetVRKeyboard().GetWindow(); float& size = window_keyboard.GetOverlayState(window_keyboard.GetOverlayStateCurrentID()).Size; vr_keyboard.VRKeyboardInputBegin( ImGui::SliderWithButtonsGetSliderID("KeyboardSize") ); if (ImGui::SliderWithButtonsFloatPercentage("KeyboardSize", size, 5, 1, 50, 200, "%d%%")) { if (size < 0.10f) size = 0.10f; window_keyboard.GetOverlayState(floating_window_ovrl_state_room).Size = size; window_keyboard.GetOverlayState(floating_window_ovrl_state_dashboard_tab).Size = size; UIManager::Get()->GetVRKeyboard().GetWindow().ApplyCurrentOverlayState(); } vr_keyboard.VRKeyboardInputEnd(); ImGui::NextColumn(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsKeyboardBehavior)); ImGui::NextColumn(); ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsKeyboardStickyMod), &ConfigManager::GetRef(configid_bool_input_keyboard_sticky_modifiers)); ImGui::NextColumn(); ImGui::NextColumn(); ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsKeyboardKeyRepeat), &ConfigManager::GetRef(configid_bool_input_keyboard_key_repeat)); bool& auto_show_desktop = ConfigManager::Get().GetRef(configid_bool_input_keyboard_auto_show_desktop); bool& auto_show_browser = ConfigManager::Get().GetRef(configid_bool_input_keyboard_auto_show_browser); //Arrange the checkboxes in their own group if browser is available, otherwise just add a single one for desktop/window under the behavior group if (DPBrowserAPIClient::Get().IsBrowserAvailable()) { ImGui::Spacing(); ImGui::NextColumn(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsKeyboardAutoShow)); ImGui::NextColumn(); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsKeyboardAutoShowDesktop), &auto_show_desktop)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_input_keyboard_auto_show_desktop, auto_show_desktop); } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsKeyboardAutoShowDesktopTip)); ImGui::NextColumn(); ImGui::NextColumn(); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsKeyboardAutoShowBrowser), &auto_show_browser)) { if (!auto_show_browser) { //Hide currently auto-visible keyboard if it's shown for a browser overlay int overlay_id = vr_keyboard.GetWindow().GetAssignedOverlayID(); if ( (overlay_id >= 0) && (OverlayManager::Get().GetConfigData((unsigned int)overlay_id).ConfigInt[configid_int_overlay_capture_source] == ovrl_capsource_browser) ) { vr_keyboard.GetWindow().SetAutoVisibility(overlay_id, false); } } } } else { if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsKeyboardAutoShowDesktopOnly), &auto_show_desktop)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_input_keyboard_auto_show_desktop, auto_show_desktop); } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsKeyboardAutoShowDesktopTip)); } ImGui::Columns(1); } //Mouse { ImGui::Spacing(); ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_SettingsCatMouse)); ImGui::Indent(); bool& render_cursor = ConfigManager::Get().GetRef(configid_bool_input_mouse_render_cursor); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsMouseShowCursor), &render_cursor)) { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_set_config, ConfigManager::GetWParamForConfigID(configid_bool_input_mouse_render_cursor), render_cursor); } if ( (!render_cursor) && (is_any_gc_overlay_active) ) { ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsMouseShowCursorGCActiveWarning), "(!)"); } else if (!DPWinRT_IsCaptureCursorEnabledPropertySupported()) { ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsMouseShowCursorGCUnsupported), "(!)"); } bool& scroll_smooth = ConfigManager::GetRef(configid_bool_input_mouse_scroll_smooth); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsMouseScrollSmooth), &scroll_smooth)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_input_mouse_scroll_smooth, scroll_smooth); } bool& simulate_pen = ConfigManager::GetRef(configid_bool_input_mouse_simulate_pen_input); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsMouseSimulatePen), &simulate_pen)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_input_mouse_simulate_pen_input, simulate_pen); } if (!ConfigManager::GetValue(configid_bool_state_pen_simulation_supported)) { ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsMouseSimulatePenUnsupported), "(!)"); } bool& pointer_override = ConfigManager::Get().GetRef(configid_bool_input_mouse_allow_pointer_override); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsMouseAllowLaserPointerOverride), &pointer_override)) { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_set_config, ConfigManager::GetWParamForConfigID(configid_bool_input_mouse_allow_pointer_override), pointer_override); } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsMouseAllowLaserPointerOverrideTip)); ImGui::Unindent(); //Double-Click Assistant ImGui::Columns(2, "ColumnMouse", false); ImGui::SetColumnWidth(0, m_Column0Width); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsMouseDoubleClickAssist)); ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsMouseDoubleClickAssistTip)); ImGui::NextColumn(); //The way mapping max + 1 == -1 value into the slider is done is a bit convoluted, but still works int& assist_duration = ConfigManager::Get().GetRef(configid_int_input_mouse_dbl_click_assist_duration_ms); const int assist_duration_max = 3000; //The "Auto" wrapping makes this the absolute maximum value even with manual input, but longer than 3 seconds is questionable either way int assist_duration_ui = (assist_duration == -1) ? assist_duration_max + 1 : assist_duration; const char* text_alt_assist = nullptr; if (assist_duration <= 0) { text_alt_assist = TranslationManager::GetString((assist_duration == -1) ? tstr_SettingsMouseDoubleClickAssistTipValueAuto : tstr_SettingsMouseDoubleClickAssistTipValueOff); } vr_keyboard.VRKeyboardInputBegin( ImGui::SliderWithButtonsGetSliderID("DBLClickAssist") ); if (ImGui::SliderWithButtonsInt("DBLClickAssist", assist_duration_ui, 25, 5, 0, assist_duration_max + 1, (text_alt_assist != nullptr) ? "" : "%d ms", 0, nullptr, text_alt_assist)) { assist_duration = clamp(assist_duration_ui, 0, assist_duration_max + 1); if (assist_duration_ui > assist_duration_max) assist_duration = -1; IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_input_mouse_dbl_click_assist_duration_ms, assist_duration); } vr_keyboard.VRKeyboardInputEnd(); ImGui::NextColumn(); //Input Smoothing ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsMouseSmoothing)); ImGui::NextColumn(); int& input_smoothing_level = ConfigManager::Get().GetRef(configid_int_input_mouse_input_smoothing_level); const int input_smoothing_level_max = tstr_SettingsMouseSmoothingLevelVeryHigh - tstr_SettingsMouseSmoothingLevelNone; input_smoothing_level = clamp(input_smoothing_level, 0, input_smoothing_level_max); if (ImGui::SliderWithButtonsInt("SmoothingLevel", input_smoothing_level, 1, 1, 0, input_smoothing_level_max, "##%d", ImGuiSliderFlags_NoInput, nullptr, TranslationManager::GetString( (TRMGRStrID)(tstr_SettingsMouseSmoothingLevelNone + input_smoothing_level) ))) { input_smoothing_level = clamp(input_smoothing_level, 0, input_smoothing_level_max); IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_input_mouse_input_smoothing_level, input_smoothing_level); } ImGui::Columns(1); } //Laser Pointer { static ConfigID_Int edited_hmd_pointer_input_id = configid_int_MAX; //Write changes if we're returning from a picker if ((m_PageReturned == wndsettings_page_keycode_picker) && (edited_hmd_pointer_input_id != configid_int_MAX)) { ConfigManager::SetValue(edited_hmd_pointer_input_id, m_KeyCodePickerID); IPCManager::Get().PostConfigMessageToDashboardApp(edited_hmd_pointer_input_id, m_KeyCodePickerID); m_PageReturned = wndsettings_page_none; edited_hmd_pointer_input_id = configid_int_MAX; } ImGui::Spacing(); ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_SettingsCatLaserPointer)); ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsLaserPointerTip)); ImGui::Indent(); bool& block_input = ConfigManager::GetRef(configid_bool_input_laser_pointer_block_input); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsLaserPointerBlockInput), &block_input)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_input_laser_pointer_block_input, block_input); } ImGui::Unindent(); ImGui::Columns(2, "ColumnLaserPointer", false); ImGui::SetColumnWidth(0, m_Column0Width); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsLaserPointerAutoToggleDistance)); ImGui::NextColumn(); float& distance = ConfigManager::GetRef(configid_float_input_detached_interaction_max_distance); const char* alt_text = (distance < 0.01f) ? TranslationManager::GetString(tstr_SettingsLaserPointerAutoToggleDistanceValueOff) : nullptr; vr_keyboard.VRKeyboardInputBegin( ImGui::SliderWithButtonsGetSliderID("LaserPointerMaxDistance") ); if (ImGui::SliderWithButtonsFloat("LaserPointerMaxDistance", distance, 0.05f, 0.01f, 0.0f, 3.0f, (distance < 0.01f) ? "##%.2f" : "%.2f m", ImGuiSliderFlags_Logarithmic, nullptr, alt_text)) { if (distance < 0.01f) distance = 0.0f; IPCManager::Get().PostConfigMessageToDashboardApp(configid_float_input_detached_interaction_max_distance, distance); } vr_keyboard.VRKeyboardInputEnd(); ImGui::Columns(1); ImGui::Spacing(); if (ConfigManager::GetValue(configid_bool_interface_show_advanced_settings)) { ImGui::Indent(); bool& hmd_pointer_enabled = ConfigManager::GetRef(configid_bool_input_laser_pointer_hmd_device); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsLaserPointerHMDPointer), &hmd_pointer_enabled)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_input_laser_pointer_hmd_device, hmd_pointer_enabled); } ImGui::Indent(ImGui::GetFrameHeightWithSpacing()); if (!hmd_pointer_enabled) ImGui::PushItemDisabled(); ImGui::PushID("HMDPointer"); const ImVec2 table_size(-style.IndentSpacing - 1.0f, 0.0f); //Replicate padding from columns const float table_column_width = m_Column0Width - style.IndentSpacing - ImGui::GetFrameHeightWithSpacing(); //Align with width of other columns if (BeginCompactTable("TableHMDPointerInput", 2, ImGuiTableFlags_RowBg | ImGuiTableFlags_SizingFixedFit, table_size)) { ImGui::TableSetupColumn(TranslationManager::GetString(tstr_SettingsLaserPointerHMDPointerTableHeaderInputAction), 0, table_column_width); ImGui::TableSetupColumn(TranslationManager::GetString(tstr_SettingsLaserPointerHMDPointerTableHeaderBinding), ImGuiTableColumnFlags_WidthStretch); CompactTableHeadersRow(); const int key_count = configid_int_input_laser_pointer_hmd_device_keycode_drag - configid_int_input_laser_pointer_hmd_device_keycode_toggle; IM_ASSERT(configid_int_input_laser_pointer_hmd_device_keycode_toggle < configid_int_input_laser_pointer_hmd_device_keycode_drag); IM_ASSERT(tstr_SettingsLaserPointerHMDPointerTableBindingToggle + key_count < tstr_MAX); for (int i = 0; i < key_count + 1; ++i) { ConfigID_Int config_id = (ConfigID_Int)(configid_int_input_laser_pointer_hmd_device_keycode_toggle + i); ImGui::PushID(i); ImGui::TableNextColumn(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString( (TRMGRStrID)(tstr_SettingsLaserPointerHMDPointerTableBindingToggle + i) )); ImGui::SameLine(); ImGui::TableNextColumn(); if (ImGui::Selectable( GetStringForKeyCode(ConfigManager::GetValue(config_id)) )) { m_KeyCodePickerNoMouse = true; m_KeyCodePickerHotkeyMode = false; m_KeyCodePickerID = ConfigManager::GetValue(config_id); edited_hmd_pointer_input_id = config_id; PageGoForward(wndsettings_page_keycode_picker); m_PageReturned = wndsettings_page_none; } ImGui::PopID(); } EndCompactTable(); } ImGui::PopID(); if (!hmd_pointer_enabled) ImGui::PopItemDisabled(); ImGui::Unindent(ImGui::GetFrameHeightWithSpacing()); ImGui::Unindent(); } } } void WindowSettings::UpdatePageMainCatWindows() { //Window Overlays { ImGui::Spacing(); ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_SettingsCatWindowOverlays)); ImGui::Indent(); if (ConfigManager::GetValue(configid_bool_interface_show_advanced_settings)) { bool& auto_focus = ConfigManager::GetRef(configid_bool_windows_winrt_auto_focus); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsWindowOverlaysAutoFocus), &auto_focus)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_windows_winrt_auto_focus, auto_focus); } bool& keep_on_screen = ConfigManager::GetRef(configid_bool_windows_winrt_keep_on_screen); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsWindowOverlaysKeepOnScreen), &keep_on_screen)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_windows_winrt_keep_on_screen, keep_on_screen); } ImGui::SameLine(0.0f, ImGui::GetStyle().ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsWindowOverlaysKeepOnScreenTip)); } bool& auto_size_overlay = ConfigManager::GetRef(configid_bool_windows_winrt_auto_size_overlay); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsWindowOverlaysAutoSizeOverlay), &auto_size_overlay)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_windows_winrt_auto_size_overlay, auto_size_overlay); } bool& focus_scene_app = ConfigManager::GetRef(configid_bool_windows_winrt_auto_focus_scene_app); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsWindowOverlaysFocusSceneApp), &focus_scene_app)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_windows_winrt_auto_focus_scene_app, focus_scene_app); } if (ConfigManager::GetValue(configid_bool_interface_show_advanced_settings)) { bool& auto_focus_scene_app_dashboard = ConfigManager::GetRef(configid_bool_windows_auto_focus_scene_app_dashboard); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsWindowOverlaysFocusSceneAppDashboard), &auto_focus_scene_app_dashboard)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_windows_auto_focus_scene_app_dashboard, auto_focus_scene_app_dashboard); } } ImGui::Unindent(); if (ConfigManager::GetValue(configid_bool_interface_show_advanced_settings)) { ImGui::Spacing(); ImGui::Columns(2, "ColumnWindows", false); ImGui::SetColumnWidth(0, m_Column0Width); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsWindowOverlaysOnWindowDrag)); ImGui::NextColumn(); int& mode_dragging = ConfigManager::GetRef(configid_int_windows_winrt_dragging_mode); ImGui::SetNextItemWidth(-1); if (TranslatedComboAnimated("##ComboWindowDrag", mode_dragging, tstr_SettingsWindowOverlaysOnWindowDragDoNothing, tstr_SettingsWindowOverlaysOnWindowDragOverlay)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_windows_winrt_dragging_mode, mode_dragging); } ImGui::NextColumn(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsWindowOverlaysOnCaptureLoss)); ImGui::SameLine(0.0f, ImGui::GetStyle().ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsWindowOverlaysOnCaptureLossTip)); ImGui::NextColumn(); int& behavior_capture_loss = ConfigManager::GetRef(configid_int_windows_winrt_capture_lost_behavior); ImGui::SetNextItemWidth(-1); if (TranslatedComboAnimated("##ComboCaptureLost", behavior_capture_loss, tstr_SettingsWindowOverlaysOnCaptureLossDoNothing, tstr_SettingsWindowOverlaysOnCaptureLossRemove)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_windows_winrt_capture_lost_behavior, behavior_capture_loss); } } ImGui::Columns(1); } } void WindowSettings::UpdatePageMainCatBrowser() { //Browser if (DPBrowserAPIClient::Get().IsBrowserAvailable()) { VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); ImGui::Spacing(); ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_SettingsCatBrowser)); ImGui::Columns(2, "ColumnBrowser", false); ImGui::SetColumnWidth(0, m_Column0Width); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsBrowserMaxFrameRate)); ImGui::NextColumn(); int& max_fps = ConfigManager::Get().GetRef(configid_int_browser_max_fps); if (m_BrowserMaxFPSValueText.empty()) { m_BrowserMaxFPSValueText = TranslationManager::GetString(tstr_SettingsPerformanceUpdateLimiterFPSValue); StringReplaceAll(m_BrowserMaxFPSValueText, "%FPS%", std::to_string(max_fps)); } vr_keyboard.VRKeyboardInputBegin(ImGui::SliderWithButtonsGetSliderID("MaxFPS")); if (ImGui::SliderWithButtonsInt("MaxFPS", max_fps, 5, 1, 1, 144, "##%d", 0, nullptr, m_BrowserMaxFPSValueText.c_str())) { if (max_fps < 1) max_fps = 1; IPCManager::Get().PostConfigMessageToDashboardApp(configid_int_browser_max_fps, max_fps); m_BrowserMaxFPSValueText = ""; } vr_keyboard.VRKeyboardInputEnd(); ImGui::NextColumn(); bool& content_blocker = ConfigManager::GetRef(configid_bool_browser_content_blocker); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsBrowserContentBlocker), &content_blocker)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_browser_content_blocker, content_blocker); } ImGui::SameLine(0.0f, ImGui::GetStyle().ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsBrowserContentBlockerTip)); ImGui::NextColumn(); static int block_list_count_last = -1; if ( (m_BrowserBlockListCountText.empty()) || (ConfigManager::GetValue(configid_int_state_browser_content_blocker_list_count) != block_list_count_last) ) { block_list_count_last = ConfigManager::GetValue(configid_int_state_browser_content_blocker_list_count); m_BrowserBlockListCountText = TranslationManager::GetString((block_list_count_last != 1) ? tstr_SettingsBrowserContentBlockerListCount : tstr_SettingsBrowserContentBlockerListCountSingular); StringReplaceAll(m_BrowserBlockListCountText, "%LISTCOUNT%", std::to_string(block_list_count_last) ); } if ( (content_blocker) && (block_list_count_last != -1) ) { ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(m_BrowserBlockListCountText.c_str()); } ImGui::Columns(1); } } void WindowSettings::UpdatePageMainCatPerformance() { const ImGuiStyle& style = ImGui::GetStyle(); //Performance { ImGui::Spacing(); ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_SettingsCatPerformance)); ImGui::Columns(2, "ColumnPerformance", false); ImGui::SetColumnWidth(0, m_Column0Width); UpdateLimiterSetting(false); if (ConfigManager::GetValue(configid_bool_interface_show_advanced_settings)) { ImGui::Spacing(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_OvrlPropsCaptureMethodDup)); ImGui::NextColumn(); ImGui::Spacing(); bool& rapid_updates = ConfigManager::Get().GetRef(configid_bool_performance_rapid_laser_pointer_updates); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsPerformanceRapidUpdates), &rapid_updates)) { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_set_config, ConfigManager::GetWParamForConfigID(configid_bool_performance_rapid_laser_pointer_updates), rapid_updates); } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsPerformanceRapidUpdatesTip)); ImGui::NextColumn(); ImGui::NextColumn(); bool& single_desktop = ConfigManager::Get().GetRef(configid_bool_performance_single_desktop_mirroring); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsPerformanceSingleDesktopMirror), &single_desktop)) { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_set_config, ConfigManager::GetWParamForConfigID(configid_bool_performance_single_desktop_mirroring), single_desktop); } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsPerformanceSingleDesktopMirrorTip)); bool& alt_cursor_render = ConfigManager::Get().GetRef(configid_bool_performance_alternative_cursor_rendering); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsPerformanceAlternativeCursorRendering), &alt_cursor_render)) { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_set_config, ConfigManager::GetWParamForConfigID(configid_bool_performance_alternative_cursor_rendering), alt_cursor_render); } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsPerformanceAlternativeCursorRenderingTip)); ImGui::NextColumn(); ImGui::Spacing(); bool& use_hdr = ConfigManager::Get().GetRef(configid_bool_performance_hdr_mirroring); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsPerformanceUseHDR), &use_hdr)) { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_set_config, ConfigManager::GetWParamForConfigID(configid_bool_performance_hdr_mirroring), use_hdr); } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsPerformanceUseHDRTip)); ImGui::NextColumn(); ImGui::NextColumn(); } bool& show_fps = ConfigManager::Get().GetRef(configid_bool_performance_show_fps); ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsPerformanceShowFPS), &show_fps); ImGui::Columns(1); } } void WindowSettings::UpdatePageMainCatMisc() { const ImGuiStyle& style = ImGui::GetStyle(); static bool is_autolaunch_enabled = false; if ( (UIManager::Get()->IsOpenVRLoaded()) && (m_PageAppearing == wndsettings_page_main) ) { is_autolaunch_enabled = vr::VRApplications()->GetApplicationAutoLaunch(g_AppKeyDashboardApp); } //Version Info { ImGui::Spacing(); ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_SettingsCatVersionInfo)); ImGui::Indent(); ImGui::TextUnformatted(k_pch_DesktopPlusVersion); ImGui::Unindent(); } //Warnings { ImGui::Spacing(); ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_SettingsCatWarnings)); ImGui::Columns(2, "ColumnResetWarnings", false); ImGui::SetColumnWidth(0, m_Column0Width); int warning_hidden_count = 0; if (ConfigManager::GetValue(configid_bool_interface_warning_compositor_quality_hidden)) warning_hidden_count++; if (ConfigManager::GetValue(configid_bool_interface_warning_compositor_res_hidden)) warning_hidden_count++; if (ConfigManager::GetValue(configid_bool_interface_warning_process_elevation_hidden)) warning_hidden_count++; if (ConfigManager::GetValue(configid_bool_interface_warning_elevated_mode_hidden)) warning_hidden_count++; if (ConfigManager::GetValue(configid_bool_interface_warning_browser_missing_hidden)) warning_hidden_count++; if (ConfigManager::GetValue(configid_bool_interface_warning_browser_version_mismatch_hidden)) warning_hidden_count++; ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsWarningsHidden)); ImGui::SameLine(); ImGui::Text("%i", warning_hidden_count); ImGui::NextColumn(); if (ImGui::Button(TranslationManager::GetString(tstr_SettingsWarningsReset))) { ConfigManager::SetValue(configid_bool_interface_warning_compositor_quality_hidden, false); ConfigManager::SetValue(configid_bool_interface_warning_compositor_res_hidden, false); ConfigManager::SetValue(configid_bool_interface_warning_process_elevation_hidden, false); ConfigManager::SetValue(configid_bool_interface_warning_elevated_mode_hidden, false); ConfigManager::SetValue(configid_bool_interface_warning_browser_missing_hidden, false); ConfigManager::SetValue(configid_bool_interface_warning_browser_version_mismatch_hidden, false); UIManager::Get()->UpdateAnyWarningDisplayedState(); } ImGui::Columns(1); } //Startup bool& no_steam = ConfigManager::GetRef(configid_bool_misc_no_steam); if ( (ConfigManager::Get().IsSteamInstall()) || (UIManager::Get()->IsOpenVRLoaded()) ) //Only show if Steam install or we can access OpenVR settings { ImGui::Spacing(); ImGui::TextColored(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_SettingsCatStartup)); ImGui::Indent(); if (UIManager::Get()->IsOpenVRLoaded()) { if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsStartupAutoLaunch), &is_autolaunch_enabled)) { vr::VRApplications()->SetApplicationAutoLaunch(g_AppKeyDashboardApp, is_autolaunch_enabled); } } if (ConfigManager::Get().IsSteamInstall()) { if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsStartupSteamDisable), &no_steam)) { IPCManager::Get().PostConfigMessageToDashboardApp(configid_bool_misc_no_steam, no_steam); } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsStartupSteamDisableTip)); } ImGui::Unindent(); } //Troubleshooting { ImGui::Spacing(); ImGui::TextColored(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_SettingsCatTroubleshooting)); ImGui::Columns(2, "ColumnTroubleshooting", false); ImGui::SetColumnWidth(0, m_Column0Width); //All the restart buttons only start up new processes, but both UI and dashboard app get rid of the older instance when starting ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted("Desktop+"); ImGui::NextColumn(); if (ImGui::Button(TranslationManager::GetString(tstr_SettingsTroubleshootingRestart))) { UIManager::Get()->RestartDashboardApp(); } bool has_restart_steam_button = ( (ConfigManager::Get().IsSteamInstall()) && (!ConfigManager::GetValue(configid_bool_state_misc_process_started_by_steam)) ); if (has_restart_steam_button) { ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); if (no_steam) ImGui::PushItemDisabled(); if (ImGui::Button(TranslationManager::GetString(tstr_SettingsTroubleshootingRestartSteam))) { UIManager::Get()->RestartDashboardApp(true); } if (no_steam) ImGui::PopItemDisabled(); } if (UIManager::Get()->IsElevatedTaskSetUp()) { static float elevated_task_button_width = 0.0f; //Put this button on a new line if it doesn't fit (typically happens with [Restart with Steam] button present in VR mode) if (ImGui::GetItemRectMax().x + style.ItemSpacing.x + elevated_task_button_width < ImGui::GetCursorScreenPos().x + ImGui::GetContentRegionAvail().x) ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); const bool dashboard_app_running = IPCManager::IsDashboardAppRunning(); if (!dashboard_app_running) ImGui::PushItemDisabled(); if (!ConfigManager::GetValue(configid_bool_state_misc_elevated_mode_active)) { if (ImGui::Button(TranslationManager::GetString(tstr_SettingsTroubleshootingElevatedModeEnter))) { UIManager::Get()->ElevatedModeEnter(); } } else { if (ImGui::Button(TranslationManager::GetString(tstr_SettingsTroubleshootingElevatedModeLeave))) { UIManager::Get()->ElevatedModeLeave(); } } elevated_task_button_width = ImGui::GetItemRectSize().x; if (!dashboard_app_running) ImGui::PopItemDisabled(); } ImGui::NextColumn(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted("Desktop+ UI"); ImGui::NextColumn(); ImGui::PushID("##UI"); if (ImGui::Button(TranslationManager::GetString(tstr_SettingsTroubleshootingRestart))) { UIManager::Get()->Restart(false); } ImGui::PopID(); ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); if (ImGui::Button(TranslationManager::GetString(tstr_SettingsTroubleshootingRestartDesktop))) { UIManager::Get()->Restart(true); } ImGui::Columns(1); ImGui::Spacing(); ImGui::Indent(); if (ImGui::Button(TranslationManager::GetString(tstr_SettingsTroubleshootingSettingsReset))) { PageGoForward(wndsettings_page_reset_confirm); } ImGui::Unindent(); } } void WindowSettings::UpdatePagePersistentUI() { static float tab_item_height = 0.0f; //We only use half the size for column 0 on this page since we can really use the space for other things const float column_0_width = m_Column0Width / 2.0f; const float column_1_width = (ImGui::GetContentRegionAvail().x - column_0_width) / 2.0f; auto window_state_tab_item = [&](const char* label, FloatingWindow& window, bool& config_var_state_restore) { if (ImGui::BeginTabItem(label, 0, ImGuiTabItemFlags_NoPushId)) //NoPushId avoids flickering from size calculations and is not problematic two controls are never active at the same time { if (ImGui::IsWindowAppearing()) { UIManager::Get()->RepeatFrame(); } ImGuiStyle& style = ImGui::GetStyle(); FloatingWindowOverlayState& state_room = window.GetOverlayState(floating_window_ovrl_state_room); FloatingWindowOverlayState& state_dplus_tab = window.GetOverlayState(floating_window_ovrl_state_dashboard_tab); const bool use_lazy_resize = (&window == &UIManager::Get()->GetSettingsWindow()); //Lazily resize for settings window since the input is done through it //Draw background and border manually to merge with the tab-bar ImVec2 border_min = ImGui::GetCursorScreenPos(); ImVec2 border_max = border_min; border_min.y -= style.ItemSpacing.y + 1; border_max.x += ImGui::GetContentRegionAvail().x; border_max.y += tab_item_height; ImGui::GetWindowDrawList()->AddRectFilled(border_min, border_max, ImGui::GetColorU32(ImGuiCol_ChildBg)); ImGui::GetWindowDrawList()->AddRect( border_min, border_max, ImGui::GetColorU32(ImGuiCol_Border )); //Window state table ImGui::Columns(3, "ColumnPersistWindowState", false); ImGui::SetColumnWidth(0, column_0_width); ImGui::SetColumnWidth(1, column_1_width); ImGui::SetColumnWidth(2, column_1_width); //Headers ImGui::NextColumn(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsInterfacePersistentUIWindowsStateGlobal)); ImGui::NextColumn(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsInterfacePersistentUIWindowsStateDashboardTab)); ImGui::NextColumn(); //Visible ImGui::Spacing(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsInterfacePersistentUIWindowsStateVisible)); ImGui::NextColumn(); ImGui::Spacing(); if (ImGui::Checkbox("##CheckVisibleRoom", &state_room.IsVisible)) { //Pin automatically if in room state and unpinned is not allowed if ( (!window.CanUnpinRoom()) && (!state_room.IsPinned) ) { //Pin and unpin (if needed) current state to have it apply to the room state. This is only needed when there's no pinned transform yet const bool current_pinned = window.IsPinned(); window.SetPinned(true); if (window.GetOverlayStateCurrentID() == floating_window_ovrl_state_dashboard_tab) { window.SetPinned(current_pinned, true); } } if (window.GetOverlayStateCurrentID() == floating_window_ovrl_state_room) { window.ApplyCurrentOverlayState(); } //When hiding keyboard, the assigned overlay also needs to be cleared so it doesn't automatically reappear if ( (!state_room.IsVisible) && (&window == &UIManager::Get()->GetVRKeyboard().GetWindow()) ) { UIManager::Get()->GetVRKeyboard().GetWindow().SetAssignedOverlayID(-1, floating_window_ovrl_state_room); } } ImGui::NextColumn(); ImGui::Spacing(); if (ImGui::Checkbox("##CheckVisibleDPlusTab", &state_dplus_tab.IsVisible)) { if (window.GetOverlayStateCurrentID() == floating_window_ovrl_state_dashboard_tab) { window.ApplyCurrentOverlayState(); } } ImGui::NextColumn(); //Pinned ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsInterfacePersistentUIWindowsStatePinned)); ImGui::NextColumn(); if (!window.CanUnpinRoom()) ImGui::PushItemDisabled(); if (ImGui::Checkbox("##CheckPinnedRoom", &state_room.IsPinned)) { if (window.GetOverlayStateCurrentID() == floating_window_ovrl_state_room) { window.SetPinned(state_room.IsPinned, true); } else { //Pin and unpin current state to have it apply to the room state const bool current_pinned = window.IsPinned(); window.SetPinned(state_room.IsPinned); window.SetPinned(current_pinned, true); } } if (!window.CanUnpinRoom()) ImGui::PopItemDisabled(); ImGui::NextColumn(); if (ImGui::Checkbox("##CheckPinnedDPlusTab", &state_dplus_tab.IsPinned)) { if (window.GetOverlayStateCurrentID() == floating_window_ovrl_state_dashboard_tab) { window.SetPinned(state_dplus_tab.IsPinned, true); } } ImGui::NextColumn(); //Position ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsInterfacePersistentUIWindowsStatePosition)); ImGui::NextColumn(); ImGui::PushID(floating_window_ovrl_state_room); if (ImGui::Button(TranslationManager::GetString(tstr_SettingsInterfacePersistentUIWindowsStatePositionReset))) { window.ResetTransform(floating_window_ovrl_state_room); if (window.GetOverlayStateCurrentID() == floating_window_ovrl_state_room) { window.ApplyCurrentOverlayState(); } } ImGui::PopID(); ImGui::NextColumn(); ImGui::PushID(floating_window_ovrl_state_dashboard_tab); if (ImGui::Button(TranslationManager::GetString(tstr_SettingsInterfacePersistentUIWindowsStatePositionReset))) { if (state_dplus_tab.IsPinned) { if (window.GetOverlayStateCurrentID() == floating_window_ovrl_state_dashboard_tab) { window.SetPinned(false, true); } } window.ResetTransform(floating_window_ovrl_state_dashboard_tab); } ImGui::PopID(); ImGui::NextColumn(); //Size ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsInterfacePersistentUIWindowsStateSize)); ImGui::NextColumn(); if (ImGui::SliderWithButtonsFloatPercentage("SizeRoom", state_room.Size, 5, 1, 50, 200, "%d%%")) { if (state_dplus_tab.Size < 0.10f) { state_dplus_tab.Size = 0.10f; } if ( (window.GetOverlayStateCurrentID() == floating_window_ovrl_state_room) && (!use_lazy_resize) ) { window.ApplyCurrentOverlayState(); } } if ( (ImGui::IsItemDeactivated()) && (use_lazy_resize) && (window.GetOverlayStateCurrentID() == floating_window_ovrl_state_room) ) { window.ApplyCurrentOverlayState(); } ImGui::NextColumn(); if (ImGui::SliderWithButtonsFloatPercentage("SizeDPlusTab", state_dplus_tab.Size, 5, 1, 50, 200, "%d%%")) { if (state_dplus_tab.Size < 0.10f) { state_dplus_tab.Size = 0.10f; } if ( (window.GetOverlayStateCurrentID() == floating_window_ovrl_state_dashboard_tab) && (!use_lazy_resize) ) { window.ApplyCurrentOverlayState(); } } if ( (ImGui::IsItemDeactivated()) && (use_lazy_resize) && (window.GetOverlayStateCurrentID() == floating_window_ovrl_state_dashboard_tab) ) { window.ApplyCurrentOverlayState(); } ImGui::Columns(1); ImGui::Indent(); ImGui::Spacing(); ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsInterfacePersistentUIWindowsStateLaunchRestore), &config_var_state_restore); ImGui::Unindent(); ImGui::EndTabItem(); tab_item_height = ImGui::GetCursorScreenPos().y - border_min.y; } }; ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_SettingsInterfacePersistentUI)); ImGui::Indent(); ImGui::PushTextWrapPos(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsInterfacePersistentUIHelp)); ImGui::Spacing(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsInterfacePersistentUIHelp2)); ImGui::PopTextWrapPos(); ImGui::Unindent(); ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_SettingsInterfacePersistentUIWindowsHeader)); ImGui::Indent(); if (ImGui::BeginTabBar("TabBarPersist")) { window_state_tab_item(TranslationManager::GetString(tstr_SettingsInterfacePersistentUIWindowsSettings), *this, ConfigManager::GetRef(configid_bool_interface_window_settings_restore_state)); window_state_tab_item(TranslationManager::GetString(tstr_SettingsInterfacePersistentUIWindowsProperties), UIManager::Get()->GetOverlayPropertiesWindow(), ConfigManager::GetRef(configid_bool_interface_window_properties_restore_state)); window_state_tab_item(TranslationManager::GetString(tstr_SettingsInterfacePersistentUIWindowsKeyboard), UIManager::Get()->GetVRKeyboard().GetWindow(), ConfigManager::GetRef(configid_bool_interface_window_keyboard_restore_state)); ImGui::EndTabBar(); } ImGui::Unindent(); ImGui::SetCursorPosY( ImGui::GetCursorPosY() + (ImGui::GetContentRegionAvail().y - ImGui::GetFrameHeightWithSpacing()) ); ImGui::Separator(); if (ImGui::Button(TranslationManager::GetString(tstr_DialogDone))) { PageGoBack(); } } void WindowSettings::UpdatePageKeyboardLayout(bool only_restore_settings) { ImGuiStyle& style = ImGui::GetStyle(); VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); static int list_id = -1; static std::vector list_layouts; static std::vector str_list_authors; static bool cluster_enabled_prev[kbdlayout_cluster_MAX] = {false}; if (only_restore_settings) { //Restore previous cluster settings ConfigManager::SetValue(configid_bool_input_keyboard_cluster_function_enabled, cluster_enabled_prev[kbdlayout_cluster_function]); ConfigManager::SetValue(configid_bool_input_keyboard_cluster_navigation_enabled, cluster_enabled_prev[kbdlayout_cluster_navigation]); ConfigManager::SetValue(configid_bool_input_keyboard_cluster_numpad_enabled, cluster_enabled_prev[kbdlayout_cluster_numpad]); ConfigManager::SetValue(configid_bool_input_keyboard_cluster_extra_enabled, cluster_enabled_prev[kbdlayout_cluster_extra]); vr_keyboard.LoadCurrentLayout(); return; } if (m_PageAppearing == wndsettings_page_keyboard) { //Show the keyboard since that's probably useful vr_keyboard.GetWindow().Show(); //Load layout list list_id = -1; list_layouts = VRKeyboard::GetKeyboardLayoutList(); //Generate cached author list strings str_list_authors.clear(); for (const auto& metadata: list_layouts) { if (!metadata.Author.empty()) { std::string author_str = TranslationManager::GetString(tstr_SettingsKeyboardLayoutAuthor); StringReplaceAll(author_str, "%AUTHOR%", metadata.Author); str_list_authors.push_back(author_str); } else { str_list_authors.emplace_back(); } } //Select matching entry const std::string& current_filename = ConfigManager::GetValue(configid_str_input_keyboard_layout_file); auto it = std::find_if(list_layouts.begin(), list_layouts.end(), [¤t_filename](const auto& list_entry){ return (current_filename == list_entry.FileName); }); if (it != list_layouts.end()) { list_id = (int)std::distance(list_layouts.begin(), it); } //Clusters cluster_enabled_prev[kbdlayout_cluster_function] = ConfigManager::GetValue(configid_bool_input_keyboard_cluster_function_enabled); cluster_enabled_prev[kbdlayout_cluster_navigation] = ConfigManager::GetValue(configid_bool_input_keyboard_cluster_navigation_enabled); cluster_enabled_prev[kbdlayout_cluster_numpad] = ConfigManager::GetValue(configid_bool_input_keyboard_cluster_numpad_enabled); cluster_enabled_prev[kbdlayout_cluster_extra] = ConfigManager::GetValue(configid_bool_input_keyboard_cluster_extra_enabled); //Reload current layout in case there's a previous pending selection still loaded vr_keyboard.LoadCurrentLayout(); UIManager::Get()->RepeatFrame(); } ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_SettingsKeyboardLayout) ); ImGui::Indent(); ImGui::SetNextItemWidth(-1.0f); const float item_height = ImGui::GetFontSize() + style.ItemSpacing.y; const float inner_padding = style.FramePadding.y + style.FramePadding.y + style.ItemInnerSpacing.y; const float item_count = (UIManager::Get()->IsInDesktopMode()) ? 19.0f : 15.0f; ImGui::BeginChild("LayoutList", ImVec2(0.0f, (item_height * item_count) + inner_padding - m_WarningHeight), true); //List layouts int index = 0; for (const auto& metadata: list_layouts) { ImGui::PushID(index); if (ImGui::Selectable(metadata.Name.c_str(), (index == list_id))) { list_id = index; vr_keyboard.LoadLayoutFromFile(metadata.FileName); } if (!metadata.Author.empty()) { ImGui::SameLine(); ImGui::PushStyleColor(ImGuiCol_Text, style.Colors[ImGuiCol_TextDisabled]); ImGui::TextRightUnformatted(0.0f, 0.0f, str_list_authors[index].c_str()); ImGui::PopStyleColor(); } ImGui::PopID(); index++; } ImGui::EndChild(); ImGui::Unindent(); //Key Clusters ImGui::Spacing(); ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_SettingsKeyboardKeyClusters) ); ImGui::Indent(); bool reload_layout = false; bool& function_enabled = ConfigManager::GetRef(configid_bool_input_keyboard_cluster_function_enabled); bool& navigation_enabled = ConfigManager::GetRef(configid_bool_input_keyboard_cluster_navigation_enabled); bool& numpad_enabled = ConfigManager::GetRef(configid_bool_input_keyboard_cluster_numpad_enabled); bool& extra_enabled = ConfigManager::GetRef(configid_bool_input_keyboard_cluster_extra_enabled); //Keep unavailable options as enabled but show the check boxes as unticked to avoid confusion bool cluster_available[kbdlayout_cluster_MAX] = {false}; if (list_id != -1) { const KeyboardLayoutMetadata& current_metadata = list_layouts[list_id]; std::copy_n(current_metadata.HasCluster, kbdlayout_cluster_MAX, cluster_available); } bool function_enabled_visual = (cluster_available[kbdlayout_cluster_function]) ? function_enabled : false; bool navigation_enabled_visual = (cluster_available[kbdlayout_cluster_navigation]) ? navigation_enabled : false; bool numpad_enabled_visual = (cluster_available[kbdlayout_cluster_numpad]) ? numpad_enabled : false; bool extra_enabled_visual = (cluster_available[kbdlayout_cluster_extra]) ? extra_enabled : false; //Use bigger spacing for the checkbox listing ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, {style.ItemSpacing.x * 2.0f, style.ItemSpacing.y}); if (!cluster_available[kbdlayout_cluster_function]) ImGui::PushItemDisabled(); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsKeyboardKeyClusterFunction), &function_enabled_visual)) { function_enabled = function_enabled_visual; reload_layout = true; } if (!cluster_available[kbdlayout_cluster_function]) ImGui::PopItemDisabled(); ImGui::SameLine(); if (!cluster_available[kbdlayout_cluster_navigation]) ImGui::PushItemDisabled(); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsKeyboardKeyClusterNavigation), &navigation_enabled_visual)) { navigation_enabled = navigation_enabled_visual; reload_layout = true; } if (!cluster_available[kbdlayout_cluster_navigation]) ImGui::PopItemDisabled(); ImGui::SameLine(); if (!cluster_available[kbdlayout_cluster_numpad]) ImGui::PushItemDisabled(); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsKeyboardKeyClusterNumpad), &numpad_enabled_visual)) { numpad_enabled = numpad_enabled_visual; reload_layout = true; } if (!cluster_available[kbdlayout_cluster_numpad]) ImGui::PopItemDisabled(); ImGui::SameLine(); if (!cluster_available[kbdlayout_cluster_extra]) ImGui::PushItemDisabled(); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsKeyboardKeyClusterExtra), &extra_enabled_visual)) { extra_enabled = extra_enabled_visual; reload_layout = true; } if (!cluster_available[kbdlayout_cluster_extra]) ImGui::PopItemDisabled(); ImGui::PopStyleVar(); //ImGuiStyleVar_ItemSpacing if ( (reload_layout) && (list_id != -1) ) { vr_keyboard.LoadLayoutFromFile(list_layouts[list_id].FileName); } ImGui::Unindent(); ImGui::SetCursorPosY( ImGui::GetCursorPosY() + (ImGui::GetContentRegionAvail().y - ImGui::GetFrameHeightWithSpacing()) ); //Confirmation buttons ImGui::Separator(); if (ImGui::Button(TranslationManager::GetString(tstr_DialogOk))) { //Prevent them from being reset cluster_enabled_prev[kbdlayout_cluster_function] = function_enabled; cluster_enabled_prev[kbdlayout_cluster_navigation] = navigation_enabled; cluster_enabled_prev[kbdlayout_cluster_numpad] = numpad_enabled; cluster_enabled_prev[kbdlayout_cluster_extra] = extra_enabled; if (list_id != -1) { ConfigManager::SetValue(configid_str_input_keyboard_layout_file, list_layouts[list_id].FileName); } PageGoBack(); } ImGui::SameLine(); if (ImGui::Button(TranslationManager::GetString(tstr_DialogCancel))) { PageGoBack(); } if (UIManager::Get()->IsInDesktopMode()) { ImGui::SameLine(); static float keyboard_editor_button_width = 0.0f; ImGui::SetCursorPosX(ImGui::GetCursorPosX() + ImGui::GetContentRegionAvail().x - keyboard_editor_button_width); if (ImGui::Button(TranslationManager::GetString(tstr_SettingsKeyboardSwitchToEditor))) { UIManager::Get()->RestartIntoKeyboardEditor(); } keyboard_editor_button_width = ImGui::GetItemRectSize().x; } } void WindowSettings::UpdatePageProfiles() { ImGuiStyle& style = ImGui::GetStyle(); static int list_id = -1; static bool scroll_to_selection = false; static bool used_profile_save_new_page = false; static bool delete_confirm_state = false; static bool has_loading_failed = false; static bool has_deletion_failed = false; static float list_buttons_width = 0.0f; const bool is_root_page = (m_PageStack[0] == wndsettings_page_profiles); if (m_PageAppearing == wndsettings_page_profiles) { //Load profile list m_ProfileList = ConfigManager::Get().GetOverlayProfileList(); list_id = -1; m_ProfileSelectionName = ""; delete_confirm_state = false; has_deletion_failed = false; UIManager::Get()->RepeatFrame(); } else if ( (used_profile_save_new_page) && (m_PageStack[m_PageStackPos] == wndsettings_page_profiles) ) //Find m_ProfileSelectionName profile after returning from saving profile { const auto it = std::find(m_ProfileList.begin(), m_ProfileList.end(), m_ProfileSelectionName); if (it != m_ProfileList.end()) { list_id = (int)std::distance(m_ProfileList.begin(), it); } else { list_id = (int)m_ProfileList.size() - 1; m_ProfileSelectionName = ""; } scroll_to_selection = true; used_profile_save_new_page = false; } if ((m_PageAppearing == wndsettings_page_profiles) || (m_CachedSizes.Profiles_ButtonDeleteSize.x == 0.0f)) { //Figure out size for delete button. We need it to stay the same but also consider the case of the confirm text being longer in some languages ImVec2 text_size_delete = ImGui::CalcTextSize(TranslationManager::GetString(tstr_SettingsProfilesOverlaysProfileDelete), nullptr, true); ImVec2 text_size_confirm = ImGui::CalcTextSize(TranslationManager::GetString(tstr_SettingsProfilesOverlaysProfileDeleteConfirm), nullptr, true); m_CachedSizes.Profiles_ButtonDeleteSize = (text_size_delete.x > text_size_confirm.x) ? text_size_delete : text_size_confirm; m_CachedSizes.Profiles_ButtonDeleteSize.x += style.FramePadding.x * 2.0f; m_CachedSizes.Profiles_ButtonDeleteSize.y += style.FramePadding.y * 2.0f; UIManager::Get()->RepeatFrame(); } bool focus_add_button = false; ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_SettingsProfilesOverlaysHeader) ); //Show errors up here when used as root page since there's no space elsewhere if ( (is_root_page) && ( (has_loading_failed) || (has_deletion_failed) ) ) { ImGui::SameLine(); ImGui::PushStyleColor(ImGuiCol_Text, Style_ImGuiCol_TextError); ImGui::TextRightUnformatted(0.0f, 0.0f, TranslationManager::GetString((has_loading_failed) ? tstr_SettingsProfilesOverlaysProfileFailedLoad : tstr_SettingsProfilesOverlaysProfileFailedDelete)); ImGui::PopStyleColor(); } ImGui::Indent(); ImGui::SetNextItemWidth(-1.0f); const float item_height = ImGui::GetFontSize() + style.ItemSpacing.y; const float inner_padding = style.FramePadding.y + style.FramePadding.y + style.ItemInnerSpacing.y; const float item_count = (UIManager::Get()->IsInDesktopMode()) ? ( (is_root_page) ? 22.0f : 20.0f ) : 16.0f; ImGui::BeginChild("ProfileList", ImVec2(0.0f, (item_height * item_count) + inner_padding - m_WarningHeight), true); //List profiles int index = 0; for (const auto& name : m_ProfileList) { ImGui::PushID(index); if (ImGui::Selectable(name.c_str(), (index == list_id))) { list_id = index; m_ProfileSelectionName = (list_id == m_ProfileList.size() - 1) ? "" : m_ProfileList[list_id]; delete_confirm_state = false; focus_add_button = ImGui::GetIO().NavVisible; } ImGui::PopID(); if ( (scroll_to_selection) && (index == list_id) ) { ImGui::SetScrollHereY(); if (ImGui::IsItemVisible()) { scroll_to_selection = false; } } index++; } ImGui::EndChild(); const bool is_none = (list_id == -1); const bool is_first = (list_id == 0); const bool is_last = (list_id == m_ProfileList.size() - 1); ImGui::SetCursorPosX(ImGui::GetCursorPosX() + ImGui::GetContentRegionAvail().x - list_buttons_width); ImGui::BeginGroup(); if ( (is_last) || (is_none) ) ImGui::PushItemDisabled(); if ( (is_first) && (focus_add_button) ) ImGui::SetKeyboardFocusHere(); if (ImGui::Button(TranslationManager::GetString(tstr_SettingsProfilesOverlaysProfileLoad))) { has_loading_failed = false; if (list_id == 0) { ConfigManager::Get().LoadOverlayProfileDefault(true); //Tell dashboard app to load the profile as well IPCManager::Get().SendStringToDashboardApp(configid_str_state_profile_name_load, m_ProfileSelectionName, UIManager::Get()->GetWindowHandle()); IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_profile_load, MAKELPARAM(ipcactv_ovrl_profile_multi, -2)); } else { has_loading_failed = !ConfigManager::Get().LoadMultiOverlayProfileFromFile(m_ProfileSelectionName + ".ini"); if (!has_loading_failed) { //Tell dashboard app to load the profile as well IPCManager::Get().SendStringToDashboardApp(configid_str_state_profile_name_load, m_ProfileSelectionName, UIManager::Get()->GetWindowHandle()); IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_profile_load, ipcactv_ovrl_profile_multi); } } if (!has_loading_failed) { UIManager::Get()->OnProfileLoaded(); } delete_confirm_state = false; has_deletion_failed = false; } ImGui::SameLine(); if ( (is_last) || (is_none) ) ImGui::PopItemDisabled(); if ( (is_first) || (is_last) || (is_none) ) ImGui::PushItemDisabled(); if ( (!is_first) && (focus_add_button) ) ImGui::SetKeyboardFocusHere(); if (ImGui::Button(TranslationManager::GetString(tstr_SettingsProfilesOverlaysProfileAdd))) { m_ProfileOverlaySelectIsSaving = false; PageGoForward(wndsettings_page_profiles_overlay_select); delete_confirm_state = false; has_loading_failed = false; has_deletion_failed = false; } ImGui::SameLine(); if ( (is_first) || (is_last) || (is_none) ) ImGui::PopItemDisabled(); if ( (is_first) || (OverlayManager::Get().GetOverlayCount() == 0) ) ImGui::PushItemDisabled(); if (ImGui::Button(TranslationManager::GetString(tstr_SettingsProfilesOverlaysProfileSave))) { m_ProfileOverlaySelectIsSaving = true; PageGoForward(wndsettings_page_profiles_overlay_select); if (is_last) { used_profile_save_new_page = true; //Refresh list ID when returning to this page later } delete_confirm_state = false; has_loading_failed = false; has_deletion_failed = false; } if ( (is_first) || (OverlayManager::Get().GetOverlayCount() == 0) ) ImGui::PopItemDisabled(); ImGui::SameLine(); if ( (is_first) || (is_last) || (is_none) ) ImGui::PushItemDisabled(); if (delete_confirm_state) { if (ImGui::Button(TranslationManager::GetString(tstr_SettingsProfilesOverlaysProfileDeleteConfirm), m_CachedSizes.Profiles_ButtonDeleteSize)) { has_deletion_failed = !ConfigManager::Get().DeleteOverlayProfile(m_ProfileSelectionName + ".ini"); if (!has_deletion_failed) { m_ProfileList = ConfigManager::Get().GetOverlayProfileList(); list_id--; m_ProfileSelectionName = m_ProfileList[list_id]; UIManager::Get()->RepeatFrame(); } has_loading_failed = false; delete_confirm_state = false; } } else { if (ImGui::Button(TranslationManager::GetString(tstr_SettingsProfilesOverlaysProfileDelete), m_CachedSizes.Profiles_ButtonDeleteSize)) { delete_confirm_state = true; } } if ( (is_first) || (is_last) || (is_none) ) ImGui::PopItemDisabled(); ImGui::EndGroup(); list_buttons_width = ImGui::GetItemRectSize().x + style.IndentSpacing; ImGui::Unindent(); ImGui::SetCursorPosY( ImGui::GetCursorPosY() + (ImGui::GetContentRegionAvail().y - ImGui::GetFrameHeightWithSpacing()) ); //Confirmation buttons (don't show when used as root page) if (!is_root_page) { ImGui::Separator(); if (ImGui::Button(TranslationManager::GetString(tstr_DialogDone))) { PageGoBack(); } if ( (has_loading_failed) || (has_deletion_failed) ) { ImGui::SameLine(); ImGui::AlignTextToFramePadding(); ImGui::PushStyleColor(ImGuiCol_Text, Style_ImGuiCol_TextError); ImGui::TextRightUnformatted(0.0f, 0.0f, TranslationManager::GetString((has_loading_failed) ? tstr_SettingsProfilesOverlaysProfileFailedLoad : tstr_SettingsProfilesOverlaysProfileFailedDelete)); ImGui::PopStyleColor(); } } } void WindowSettings::UpdatePageProfilesOverlaySelect() { ImGuiStyle& style = ImGui::GetStyle(); bool skip_selection = false; static std::vector list_profiles_w; static std::vector< std::pair > list_overlays; static std::vector list_overlays_ticked; static char buffer_profile_name[256] = ""; static bool pending_input_focus = false; static int appearing_framecount = 0; static bool is_any_ticked = true; static bool is_name_readonly = true; static bool is_name_taken = false; static bool is_name_blank = false; static bool has_saving_failed = false; static float list_buttons_width = 0.0f; auto check_profile_name_taken = [](const wchar_t* profile_name) { auto it = std::find_if(list_profiles_w.begin(), list_profiles_w.end(), [&profile_name](const auto& list_entry){ return (::StrCmpIW(profile_name, list_entry.c_str()) == 0); }); return (it != list_profiles_w.end()); }; if (m_PageAppearing == wndsettings_page_profiles_overlay_select) { appearing_framecount = ImGui::GetFrameCount(); //Load overlay list if (m_ProfileOverlaySelectIsSaving) { //We also keep a list of profile names as wide strings to allow for case-insensitive comparisions through the WinAPI list_profiles_w.clear(); for (const auto& name : m_ProfileList) { list_profiles_w.push_back(WStringConvertFromUTF8(name.c_str())); } list_overlays.clear(); for (unsigned int i = 0; i < OverlayManager::Get().GetOverlayCount(); ++i) { const OverlayConfigData& data = OverlayManager::Get().GetConfigData(i); list_overlays.push_back( std::make_pair(data.ConfigNameStr, (OverlayOrigin)data.ConfigInt[configid_int_overlay_origin]) ); } //Only do this part if the page is appearing from a page change, not window appearing again if (!m_IsWindowAppearing) { is_name_readonly = !m_ProfileSelectionName.empty(); //Generate name if empty if (m_ProfileSelectionName.empty()) { std::wstring new_profile_name_w_base = WStringConvertFromUTF8(TranslationManager::GetString(tstr_SettingsProfilesOverlaysNameNewBase)); std::wstring new_profile_name_w; int i = 0; //Sanity check translation string for ID placeholder to avoid infinite loop if (new_profile_name_w_base.find(L"%ID%") == std::wstring::npos) { new_profile_name_w_base = L"Profile %ID%"; } //Default to higher profile number if normal is already taken auto it = list_profiles_w.end(); do { ++i; new_profile_name_w = new_profile_name_w_base; WStringReplaceAll(new_profile_name_w, L"%ID%", std::to_wstring(i)); } while ( check_profile_name_taken(new_profile_name_w.c_str()) ); m_ProfileSelectionName = StringConvertFromUTF16(new_profile_name_w.c_str()); } //Set profile name buffer size_t copied_length = m_ProfileSelectionName.copy(buffer_profile_name, IM_ARRAYSIZE(buffer_profile_name) - 1); buffer_profile_name[copied_length] = '\0'; //Focus InputText once as soon as we can (needs to be not clipped) pending_input_focus = !is_name_readonly; } } else { list_overlays = ConfigManager::Get().GetOverlayProfileOverlayNameList(m_ProfileSelectionName + ".ini"); //Skip selection if there's only one overlay to choose from anyways if (list_overlays.size() == 1) { skip_selection = true; } else { //Check overlay list for names with unmapped characters for (const auto& pair : list_overlays) { UIManager::Get()->AddFontBuilderStringIfAnyUnmappedCharacters(pair.first.c_str()); } } } //Only clear if page changed if (!m_IsWindowAppearing) { list_overlays_ticked.clear(); } list_overlays_ticked.resize(list_overlays.size(), 1); //If we're preserving the selections we need to check ticked state if (m_IsWindowAppearing) { is_any_ticked = false; for (auto is_ticked : list_overlays_ticked) { if (is_ticked != 0) { is_any_ticked = true; break; } } } else { is_any_ticked = !list_overlays.empty(); } is_name_taken = false; is_name_blank = false; has_saving_failed = false; UIManager::Get()->RepeatFrame(); } if (m_ProfileOverlaySelectIsSaving) { ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_SettingsProfilesOverlaysProfileSaveSelectHeader)); ImGui::Columns(2, "ColumnProfileName", false); ImGui::SetColumnWidth(0, m_Column0Width); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsProfilesOverlaysProfileSaveSelectName)); if (is_name_taken) { ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsProfilesOverlaysProfileSaveSelectNameErrorTaken), "(!)"); } else if (is_name_blank) { ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsProfilesOverlaysProfileSaveSelectNameErrorBlank), "(!)"); } ImGui::NextColumn(); VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); if (is_name_readonly) ImGui::PushItemDisabled(); ImGui::PushItemWidth(-1.0f); ImGui::PushID(appearing_framecount); //The idea is to have ImGui treat this as a new widget every time the page is opened, so the cursor position isn't remembered between page switches vr_keyboard.VRKeyboardInputBegin("##InputProfileName"); if (ImGui::InputText("##InputProfileName", buffer_profile_name, IM_ARRAYSIZE(buffer_profile_name), ImGuiInputTextFlags_CallbackCharFilter, [](ImGuiInputTextCallbackData* data) { return (int)IsWCharInvalidForFileName(data->EventChar); } )) { std::wstring wstr = WStringConvertFromUTF8(buffer_profile_name); is_name_taken = check_profile_name_taken(wstr.c_str()); is_name_blank = wstr.empty(); //Check input for unmapped character //This isn't ideal as it'll collect builder strings over time, but assuming there won't be too many of those in a session it's alright UIManager::Get()->AddFontBuilderStringIfAnyUnmappedCharacters(buffer_profile_name); } vr_keyboard.VRKeyboardInputEnd(); ImGui::PopID(); if ( (pending_input_focus) && (ImGui::IsItemVisible()) && (m_PageAnimationDir == 0) ) { ImGui::SetKeyboardFocusHere(-1); pending_input_focus = false; } if (is_name_readonly) ImGui::PopItemDisabled(); ImGui::Columns(1); } ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString((m_ProfileOverlaySelectIsSaving) ? tstr_SettingsProfilesOverlaysProfileSaveSelectHeaderList : tstr_SettingsProfilesOverlaysProfileAddSelectHeader ) ); ImGui::Indent(); //Shouldn't really happen, but display error if there are no overlays if (list_overlays.size() == 0) { ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsProfilesOverlaysProfileAddSelectEmpty)); } else { ImGui::SetNextItemWidth(-1.0f); const float item_height = ImGui::GetFrameHeight() + style.ItemSpacing.y; const float inner_padding = style.FramePadding.y + style.ItemInnerSpacing.y; float item_count = (m_ProfileOverlaySelectIsSaving) ? 12.0f : 14.0f; if (UIManager::Get()->IsInDesktopMode()) { item_count += 2.0f; } ImGui::BeginChild("OverlayList", ImVec2(0.0f, (item_height * item_count) + inner_padding - m_WarningHeight), true); //Reset scroll when appearing if (m_PageAppearing == wndsettings_page_profiles_overlay_select) { ImGui::SetScrollY(0.0f); } //List overlays const float cursor_x_past_checkbox = ImGui::GetCursorPosX() + ImGui::GetFrameHeightWithSpacing(); ImVec2 img_size_line_height = {ImGui::GetTextLineHeight(), ImGui::GetTextLineHeight()}; ImVec2 img_size, img_uv_min, img_uv_max; static unsigned int hovered_overlay_id_last = k_ulOverlayID_None; unsigned int hovered_overlay_id = k_ulOverlayID_None; int index = 0; for (const auto& pair : list_overlays) { ImGui::PushID(index); //We're using a trick here to extend the checkbox interaction space to the end of the child window //Checkbox() uses the item inner spacing if the label is not blank, so we increase that and use a space label //Below we render a custom label with icon in front of it after adjusting the cursor position to where it normally would be ImGui::PushStyleVar(ImGuiStyleVar_ItemInnerSpacing, {ImGui::GetContentRegionAvail().x, style.ItemInnerSpacing.y}); if (ImGui::Checkbox(" ", (bool*)&list_overlays_ticked[index])) { //Update any ticked status is_any_ticked = false; for (auto is_ticked : list_overlays_ticked) { if (is_ticked != 0) { is_any_ticked = true; break; } } } ImGui::PopStyleVar(); if (ImGui::IsItemVisible()) { if ( (m_ProfileOverlaySelectIsSaving) && (ImGui::IsItemHovered()) ) { hovered_overlay_id = (unsigned int)index; } //Adjust cursor position to be after the checkbox + offset for icon ImGui::SameLine(); float text_y = ImGui::GetCursorPosY(); ImGui::SetCursorPos({cursor_x_past_checkbox, text_y + style.FramePadding.y}); //Origin icon TextureManager::Get().GetTextureInfo((TMNGRTexID)(tmtex_icon_xsmall_origin_room + pair.second), img_size, img_uv_min, img_uv_max); ImGui::Image(ImGui::GetIO().Fonts->TexID, img_size_line_height, img_uv_min, img_uv_max); //Checkbox label ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); ImGui::SetCursorPosY(text_y); ImGui::TextUnformatted(pair.first.c_str()); } ImGui::PopID(); index++; } ImGui::EndChild(); ImGui::SetCursorPosX(ImGui::GetCursorPosX() + ImGui::GetContentRegionAvail().x - list_buttons_width); ImGui::BeginGroup(); if (ImGui::Button(TranslationManager::GetString(tstr_SettingsProfilesOverlaysProfileAddSelectAll))) { std::fill(list_overlays_ticked.begin(), list_overlays_ticked.end(), 1); is_any_ticked = true; } ImGui::SameLine(); if (ImGui::Button(TranslationManager::GetString(tstr_SettingsProfilesOverlaysProfileAddSelectNone))) { std::fill(list_overlays_ticked.begin(), list_overlays_ticked.end(), 0); is_any_ticked = false; } ImGui::EndGroup(); list_buttons_width = ImGui::GetItemRectSize().x + style.IndentSpacing; //Set overlay highlight if saving if ( (m_ProfileOverlaySelectIsSaving) && (hovered_overlay_id_last != hovered_overlay_id) ) { UIManager::Get()->HighlightOverlay(hovered_overlay_id); hovered_overlay_id_last = hovered_overlay_id; } } ImGui::Unindent(); ImGui::SetCursorPosY( ImGui::GetCursorPosY() + (ImGui::GetContentRegionAvail().y - ImGui::GetFrameHeightWithSpacing()) ); //Confirmation buttons ImGui::Separator(); const bool disable_confirm_button = ((!is_any_ticked) || (is_name_taken) || (is_name_blank)); if (disable_confirm_button) ImGui::PushItemDisabled(); if (m_ProfileOverlaySelectIsSaving) { if (ImGui::Button(TranslationManager::GetString(tstr_SettingsProfilesOverlaysProfileSaveSelectDo))) //Save profile { m_ProfileSelectionName = buffer_profile_name; has_saving_failed = !ConfigManager::Get().SaveMultiOverlayProfileToFile(m_ProfileSelectionName + ".ini", &list_overlays_ticked); if (!has_saving_failed) { m_ProfileList = ConfigManager::Get().GetOverlayProfileList(); PageGoBack(); } } } else { if ( (ImGui::Button(TranslationManager::GetString(tstr_SettingsProfilesOverlaysProfileAddSelectDo))) || (skip_selection) ) //Add selected overlays from profile { ConfigManager::Get().LoadMultiOverlayProfileFromFile(m_ProfileSelectionName + ".ini", false, &list_overlays_ticked); //Tell dashboard app to load the profile as well IPCManager::Get().SendStringToDashboardApp(configid_str_state_profile_name_load, m_ProfileSelectionName, UIManager::Get()->GetWindowHandle()); for (int i = 0; i < list_overlays_ticked.size(); ++i) //Send each ticked overlay's ID to queue it up { if (list_overlays_ticked[i] == 1) { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_profile_load, MAKELPARAM(ipcactv_ovrl_profile_multi_add, i) ); } } IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_overlay_profile_load, MAKELPARAM(ipcactv_ovrl_profile_multi_add, -1) ); //Add queued overlays (skip_selection) ? PageGoBackInstantly() : PageGoBack(); UIManager::Get()->RepeatFrame(); } } if (disable_confirm_button) ImGui::PopItemDisabled(); ImGui::SameLine(); if (ImGui::Button(TranslationManager::GetString(tstr_DialogCancel))) { PageGoBack(); } if (has_saving_failed) { ImGui::SameLine(); ImGui::AlignTextToFramePadding(); ImGui::PushStyleColor(ImGuiCol_Text, Style_ImGuiCol_TextError); ImGui::TextRightUnformatted(0.0f, 0.0f, TranslationManager::GetString(tstr_SettingsProfilesOverlaysProfileSaveSelectDoFailed)); ImGui::PopStyleColor(); } } void WindowSettings::UpdatePageAppProfiles() { ImGuiStyle& style = ImGui::GetStyle(); AppProfileManager& app_profiles = ConfigManager::Get().GetAppProfileManager(); static int list_id = 0; static AppProfile app_profile_selected_edit; //Temporary copy of the selected profile for editing static bool is_action_picker_for_leave = false; static bool delete_confirm_state = false; static bool delete_disabled = false; //No actually reason to do this but to avoid user confusion from allowing to delete the same profile over and over static float delete_button_width = 0.0f; static float active_header_text_width = 0.0f; static ImVec2 no_apps_text_size; const bool is_root_page = (m_PageStack[0] == wndsettings_page_app_profiles); if (m_PageAppearing == wndsettings_page_app_profiles) { RefreshAppList(); list_id = 0; app_profile_selected_edit = app_profiles.GetProfile((m_AppList.empty()) ? "" : m_AppList[0].first); delete_confirm_state = false; delete_disabled = false; UIManager::Get()->RepeatFrame(); } if (list_id >= m_AppList.size()) { list_id = (m_AppList.empty()) ? -1 : 0; app_profile_selected_edit = {}; } if ((m_PageAppearing == wndsettings_page_app_profiles) || (m_CachedSizes.Profiles_ButtonDeleteSize.x == 0.0f)) { //Figure out size for delete button. We need it to stay the same but also consider the case of the confirm text being longer in some languages ImVec2 text_size_delete = ImGui::CalcTextSize(TranslationManager::GetString(tstr_SettingsProfilesOverlaysProfileDelete), nullptr, true); ImVec2 text_size_confirm = ImGui::CalcTextSize(TranslationManager::GetString(tstr_SettingsProfilesOverlaysProfileDeleteConfirm), nullptr, true); m_CachedSizes.Profiles_ButtonDeleteSize = (text_size_delete.x > text_size_confirm.x) ? text_size_delete : text_size_confirm; m_CachedSizes.Profiles_ButtonDeleteSize.x += style.FramePadding.x * 2.0f; m_CachedSizes.Profiles_ButtonDeleteSize.y += style.FramePadding.y * 2.0f; UIManager::Get()->RepeatFrame(); } ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_SettingsProfilesAppsHeader) ); if (!UIManager::Get()->IsOpenVRLoaded()) { ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsProfilesAppsHeaderNoVRTip)); } ImGui::Indent(); ImGui::SetNextItemWidth(-1.0f); const float item_height = ImGui::GetFontSize() + style.ItemSpacing.y; const float inner_padding = style.FramePadding.y + style.FramePadding.y + style.ItemInnerSpacing.y; const float item_count = (UIManager::Get()->IsInDesktopMode()) ? ( (is_root_page) ? 16.0f : 15.0f ) : 11.0f; ImGui::BeginChild("AppList", ImVec2(0.0f, (item_height * item_count) + inner_padding - m_WarningHeight), true); //Reset scroll when appearing if (m_PageAppearing == wndsettings_page_app_profiles) { ImGui::SetScrollY(0.0f); } bool focus_app_section = false; //List applications const bool is_any_app_profile_active = !app_profiles.GetActiveProfileAppKey().empty(); const AppProfile& app_profile_active = app_profiles.GetProfile(app_profiles.GetActiveProfileAppKey()); //Use list clipper to minimize GetProfile() lookups ImGuiListClipper list_clipper; list_clipper.Begin((int)m_AppList.size()); while (list_clipper.Step()) { for (int i = list_clipper.DisplayStart; i < list_clipper.DisplayEnd; ++i) { const AppProfile& app_profile = app_profiles.GetProfile(m_AppList[i].first); const bool is_active_profile = ((is_any_app_profile_active) && (&app_profile == &app_profile_active)); if (!app_profile.IsEnabled) ImGui::PushStyleVar(ImGuiStyleVar_Alpha, 0.5f); if (is_active_profile) ImGui::PushStyleColor(ImGuiCol_Text, Style_ImGuiCol_TextNotification); ImGui::PushID(i); if (ImGui::Selectable(m_AppList[i].second.c_str(), (i == list_id))) { list_id = i; app_profile_selected_edit = app_profile; delete_confirm_state = false; delete_disabled = !app_profiles.ProfileExists(m_AppList[i].first); focus_app_section = ImGui::GetIO().NavVisible; } ImGui::PopID(); if (is_active_profile) ImGui::PopStyleColor(); if (!app_profile.IsEnabled) ImGui::PopStyleVar(); } } if (m_AppList.empty()) { ImGui::SetCursorPosX(ImGui::GetCursorPosX() + ImGui::GetContentRegionAvail().x / 2.0f - (no_apps_text_size.x / 2.0f)); ImGui::SetCursorPosY(ImGui::GetCursorPosY() + ImGui::GetContentRegionAvail().y / 2.0f - (no_apps_text_size.y / 2.0f)); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsProfilesAppsListEmpty)); no_apps_text_size = ImGui::GetItemRectSize(); } ImGui::EndChild(); ImGui::Unindent(); const bool is_none = (list_id == -1); //Would be rare, as we don't allow no selection unless the app list is really empty, but still handle that const bool is_first = (list_id == 0); const bool is_last = (list_id == m_AppList.size() - 1); if (!is_none) { const std::string& app_key_selected = m_AppList[list_id].first; const std::string& app_name_selected = m_AppList[list_id].second; const bool is_active_profile = ((is_any_app_profile_active) && (app_key_selected == app_profiles.GetActiveProfileAppKey())); static bool store_profile_changes = false; if (m_PageReturned == wndsettings_page_profile_picker) { store_profile_changes = (app_profile_selected_edit.OverlayProfileFileName != m_ProfilePickerName); app_profile_selected_edit.OverlayProfileFileName = m_ProfilePickerName; m_PageReturned = wndsettings_page_none; } else if (m_PageReturned == wndsettings_page_action_picker) { if (is_action_picker_for_leave) { store_profile_changes = (app_profile_selected_edit.ActionUIDLeave != m_ActionPickerUID); app_profile_selected_edit.ActionUIDLeave = m_ActionPickerUID; } else { store_profile_changes = (app_profile_selected_edit.ActionUIDEnter != m_ActionPickerUID); app_profile_selected_edit.ActionUIDEnter = m_ActionPickerUID; } m_PageReturned = wndsettings_page_none; } ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), app_name_selected.c_str()); if (is_active_profile) { ImGui::SameLine(); ImGui::TextColoredUnformatted(Style_ImGuiCol_TextNotification, TranslationManager::GetString(tstr_SettingsProfilesAppsProfileHeaderActive)); active_header_text_width = ImGui::GetItemRectSize().x; } if (focus_app_section) { ImGui::SetKeyboardFocusHere(); } ImGui::Indent(); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsProfilesAppsProfileEnabled), &app_profile_selected_edit.IsEnabled)) { store_profile_changes = true; } ImGui::Unindent(); ImGui::Columns(2, "ColumnAppProfile", false); ImGui::SetColumnWidth(0, m_Column0Width); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsProfilesAppsProfileOverlayProfile)); ImGui::NextColumn(); const char* overlay_profile_button_label = (app_profile_selected_edit.OverlayProfileFileName.empty()) ? TranslationManager::GetString(tstr_DialogProfilePickerNone) : app_profile_selected_edit.OverlayProfileFileName.c_str(); ImGui::PushID("ButtonOverlayProfile"); if (ImGui::Button(overlay_profile_button_label)) { m_ProfilePickerName = app_profile_selected_edit.OverlayProfileFileName; PageGoForward(wndsettings_page_profile_picker); } ImGui::PopID(); ImGui::NextColumn(); const ActionManager& action_manager = ConfigManager::Get().GetActionManager(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsProfilesAppsProfileActionEnter)); ImGui::NextColumn(); ImGui::PushID("ButtonActionEnter"); if (ImGui::Button(action_manager.GetTranslatedName(app_profile_selected_edit.ActionUIDEnter))) { m_ActionPickerUID = app_profile_selected_edit.ActionUIDEnter; is_action_picker_for_leave = false; PageGoForward(wndsettings_page_action_picker); } ImGui::PopID(); ImGui::NextColumn(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsProfilesAppsProfileActionLeave)); ImGui::NextColumn(); ImGui::PushID("ButtonActionLeave"); if (ImGui::Button(action_manager.GetTranslatedName(app_profile_selected_edit.ActionUIDLeave))) { m_ActionPickerUID = app_profile_selected_edit.ActionUIDLeave; is_action_picker_for_leave = true; PageGoForward(wndsettings_page_action_picker); } ImGui::PopID(); ImGui::Columns(1); ImGui::SetCursorPosX(ImGui::GetCursorPosX() + ImGui::GetContentRegionAvail().x - delete_button_width); const bool delete_disabled_prev = delete_disabled; if (delete_disabled_prev) ImGui::PushItemDisabled(); if (delete_confirm_state) { if (ImGui::Button(TranslationManager::GetString(tstr_SettingsProfilesOverlaysProfileDeleteConfirm), m_CachedSizes.Profiles_ButtonDeleteSize)) { IPCManager::Get().SendStringToDashboardApp(configid_str_state_app_profile_key, app_key_selected, UIManager::Get()->GetWindowHandle()); IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_app_profile_remove); app_profiles.RemoveProfile(app_key_selected); app_profile_selected_edit = {}; delete_confirm_state = false; delete_disabled = true; } } else { if (ImGui::Button(TranslationManager::GetString(tstr_SettingsProfilesOverlaysProfileDelete), m_CachedSizes.Profiles_ButtonDeleteSize)) { delete_confirm_state = true; } } if (delete_disabled_prev) ImGui::PopItemDisabled(); delete_button_width = ImGui::GetItemRectSize().x + style.IndentSpacing; //Store and sync the profile if flag was set if (store_profile_changes) { IPCManager::Get().SendStringToDashboardApp(configid_str_state_app_profile_key, app_key_selected, UIManager::Get()->GetWindowHandle()); IPCManager::Get().SendStringToDashboardApp(configid_str_state_app_profile_data, app_profile_selected_edit.Serialize(), UIManager::Get()->GetWindowHandle()); const bool loaded_overlay_profile = app_profiles.StoreProfile(app_key_selected, app_profile_selected_edit); if (loaded_overlay_profile) { UIManager::Get()->OnProfileLoaded(); } store_profile_changes = false; delete_disabled = false; } } //Confirmation buttons (don't show when used as root page) if (!is_root_page) { ImGui::SetCursorPosY( ImGui::GetCursorPosY() + (ImGui::GetContentRegionAvail().y - ImGui::GetFrameHeightWithSpacing()) ); ImGui::Separator(); if (ImGui::Button(TranslationManager::GetString(tstr_DialogDone))) { PageGoBack(); } } } void WindowSettings::UpdatePageActions() { ImGuiStyle& style = ImGui::GetStyle(); ImGuiIO& io = ImGui::GetIO(); ActionManager& action_manager = ConfigManager::Get().GetActionManager(); static int list_id = -1; static bool delete_confirm_state = false; static bool scroll_to_selection = false; static int keyboard_swapped_index = -1; static ActionUID hovered_action = k_ActionUID_Invalid; static float list_buttons_width = 0.0f; static ImVec2 no_actions_text_size; const bool is_root_page = (m_PageStack[0] == wndsettings_page_actions); if (m_PageAppearing == wndsettings_page_actions) { //Load action list m_ActionList = ConfigManager::Get().GetActionManager().GetActionNameList(); list_id = -1; delete_confirm_state = false; UIManager::Get()->RepeatFrame(); } else if (m_PageReturned == wndsettings_page_actions_edit) { m_ActionList = ConfigManager::Get().GetActionManager().GetActionNameList(); //Find potentially new action in the list and select it auto it = std::find_if(m_ActionList.begin(), m_ActionList.end(), [&](const auto& list_entry) { return (list_entry.UID == m_ActionSelectionUID); } ); list_id = (it != m_ActionList.end()) ? (int)std::distance(m_ActionList.begin(), it) : -1; m_PageReturned = wndsettings_page_none; } if ((m_PageAppearing == wndsettings_page_actions) || (m_CachedSizes.Actions_ButtonDeleteSize.x == 0.0f)) { //Figure out size for delete button. We need it to stay the same but also consider the case of the confirm text being longer in some languages ImVec2 text_size_delete = ImGui::CalcTextSize(TranslationManager::GetString(tstr_SettingsActionsManageDelete), nullptr, true); ImVec2 text_size_confirm = ImGui::CalcTextSize(TranslationManager::GetString(tstr_SettingsActionsManageDeleteConfirm), nullptr, true); m_CachedSizes.Actions_ButtonDeleteSize = (text_size_delete.x > text_size_confirm.x) ? text_size_delete : text_size_confirm; m_CachedSizes.Actions_ButtonDeleteSize.x += style.FramePadding.x * 2.0f; m_CachedSizes.Actions_ButtonDeleteSize.y += style.FramePadding.y * 2.0f; UIManager::Get()->RepeatFrame(); } bool focus_edit_button = false; ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_SettingsActionsManageHeader)); ImGui::Indent(); const float item_height = ImGui::GetFontSize() + style.ItemSpacing.y; const float inner_padding = style.FramePadding.y + style.FramePadding.y + style.ItemInnerSpacing.y; const float item_count = (UIManager::Get()->IsInDesktopMode()) ? ( (is_root_page) ? 22.0f : 20.0f ) : 16.0f; ImGui::BeginChild("ActionList", ImVec2(0.0f, (item_height * item_count) + inner_padding - m_WarningHeight), true); //Display error if there are no actions if (m_ActionList.empty()) { ImGui::SetCursorPosX(ImGui::GetCursorPosX() + ImGui::GetContentRegionAvail().x / 2.0f - (no_actions_text_size.x / 2.0f)); ImGui::SetCursorPosY(ImGui::GetCursorPosY() + ImGui::GetContentRegionAvail().y / 2.0f - (no_actions_text_size.y / 2.0f)); ImGui::TextUnformatted(TranslationManager::GetString(tstr_DialogActionPickerEmpty)); no_actions_text_size = ImGui::GetItemRectSize(); } else { //List actions int index = 0; for (const auto& entry : m_ActionList) { ImGui::PushID((void*)entry.UID); //Set focus for nav if we previously re-ordered overlays via keyboard if (keyboard_swapped_index == index) { ImGui::SetKeyboardFocusHere(); //Nav works against us here, so keep setting focus until ctrl isn't down anymore if ((!io.KeyCtrl) || (!io.NavVisible)) { keyboard_swapped_index = -1; } } if (ImGui::Selectable(entry.Name.c_str(), (index == list_id))) { list_id = index; m_ActionSelectionUID = entry.UID; delete_confirm_state = false; focus_edit_button = io.NavVisible; } if ( (scroll_to_selection) && (index == list_id) ) { ImGui::SetScrollHereY(); if (ImGui::IsItemVisible()) { scroll_to_selection = false; } } if (ImGui::IsItemHovered()) { hovered_action = entry.UID; } if (ImGui::IsItemVisible()) { //Additional selectable behavior bool selectable_active = ImGui::IsItemActive(); if ( (ImGui::IsItemHovered(ImGuiHoveredFlags_AllowWhenBlockedByActiveItem)) || ((io.NavVisible) && (ImGui::IsItemFocused())) ) { hovered_action = entry.UID; } if ((ImGui::IsItemClicked()) && (ImGui::IsMouseDoubleClicked(ImGuiMouseButton_Left))) { PageGoForward(wndsettings_page_actions_edit); delete_confirm_state = false; } //Drag reordering if ((ImGui::IsItemActive()) && (!ImGui::IsItemHovered())) { int index_swap = index + ((ImGui::GetMouseDragDelta(ImGuiMouseButton_Left).y < 0.0f) ? -1 : 1); if ((hovered_action != entry.UID) && (index_swap >= 0) && (index_swap < m_ActionList.size())) { std::iter_swap(m_ActionList.begin() + index, m_ActionList.begin() + index_swap); ActionManager::ActionList ui_order = action_manager.GetActionOrderListUI(); std::iter_swap(ui_order.begin() + index, ui_order.begin() + index_swap); action_manager.SetActionOrderListUI(ui_order); ImGui::ResetMouseDragDelta(ImGuiMouseButton_Left); } } //Keyboard reordering if ((io.NavVisible) && (io.KeyCtrl) && (hovered_action == entry.UID)) { int index_swap = index + ((ImGui::IsNavInputPressed(ImGuiNavInput_DpadDown, true)) ? 1 : (ImGui::IsNavInputPressed(ImGuiNavInput_DpadUp, true)) ? -1 : 0); if ((index != index_swap) && (index_swap >= 0) && (index_swap < m_ActionList.size())) { std::iter_swap(m_ActionList.begin() + index, m_ActionList.begin() + index_swap); ActionManager::ActionList ui_order = action_manager.GetActionOrderListUI(); std::iter_swap(ui_order.begin() + index, ui_order.begin() + index_swap); action_manager.SetActionOrderListUI(ui_order); //Skip the rest of this frame to avoid double-swaps keyboard_swapped_index = index_swap; ImGui::PopID(); UIManager::Get()->RepeatFrame(); break; } } } ImGui::PopID(); index++; } } ImGui::EndChild(); const bool is_none = (list_id == -1); const bool is_first = (list_id == 0); const bool is_last = (list_id == m_ProfileList.size() - 1); ImGui::Indent(); if (ConfigManager::GetValue(configid_bool_interface_show_advanced_settings)) { if (is_none) ImGui::PushItemDisabled(); if (ImGui::Button(TranslationManager::GetString(tstr_SettingsActionsManageCopyUID))) { ImGui::SetClipboardText(std::to_string(m_ActionList[list_id].UID).c_str()); delete_confirm_state = false; } if (is_none) ImGui::PopItemDisabled(); ImGui::SameLine(); } ImGui::SetCursorPosX(ImGui::GetCursorPosX() + ImGui::GetContentRegionAvail().x - list_buttons_width); ImGui::BeginGroup(); if (ImGui::Button(TranslationManager::GetString(tstr_SettingsActionsManageNew))) { m_ActionSelectionUID = 0; PageGoForward(wndsettings_page_actions_edit); delete_confirm_state = false; } ImGui::SameLine(); if (is_none) ImGui::PushItemDisabled(); if (focus_edit_button) ImGui::SetKeyboardFocusHere(); if (ImGui::Button(TranslationManager::GetString(tstr_SettingsActionsManageEdit))) { PageGoForward(wndsettings_page_actions_edit); delete_confirm_state = false; } ImGui::SameLine(); if (ImGui::Button(TranslationManager::GetString(tstr_SettingsActionsManageDuplicate))) { ActionUID dup_uid = action_manager.DuplicateAction(action_manager.GetAction(m_ActionSelectionUID)); //Sync with dashboard app IPCManager::Get().SendStringToDashboardApp(configid_str_state_action_data, action_manager.GetAction(dup_uid).Serialize(), UIManager::Get()->GetWindowHandle()); //Refresh list m_ActionList = action_manager.GetActionNameList(); list_id++; m_ActionSelectionUID = m_ActionList[list_id].UID; UIManager::Get()->RepeatFrame(); delete_confirm_state = false; } ImGui::SameLine(); if (delete_confirm_state) { if (ImGui::Button(TranslationManager::GetString(tstr_SettingsActionsManageDeleteConfirm), m_CachedSizes.Actions_ButtonDeleteSize)) { action_manager.RemoveAction(m_ActionSelectionUID); IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_action_delete, m_ActionSelectionUID); m_ActionList = action_manager.GetActionNameList(); list_id--; m_ActionSelectionUID = (list_id != -1) ? m_ActionList[list_id].UID : k_ActionUID_Invalid; UIManager::Get()->RepeatFrame(); delete_confirm_state = false; } } else { if (ImGui::Button(TranslationManager::GetString(tstr_SettingsActionsManageDelete), m_CachedSizes.Actions_ButtonDeleteSize)) { delete_confirm_state = true; } } if (is_none) ImGui::PopItemDisabled(); ImGui::EndGroup(); list_buttons_width = ImGui::GetItemRectSize().x + style.IndentSpacing; ImGui::Unindent(); ImGui::Unindent(); ImGui::SetCursorPosY( ImGui::GetCursorPosY() + (ImGui::GetContentRegionAvail().y - ImGui::GetFrameHeightWithSpacing()) ); //Confirmation buttons (don't show when used as root page) if (!is_root_page) { ImGui::Separator(); if (ImGui::Button(TranslationManager::GetString(tstr_DialogDone))) { PageGoBack(); } } } void WindowSettings::UpdatePageActionsEdit(bool only_restore_settings) { struct CommandUIState { float header_animation_progress = 0.0f; float header_2_animation_progress = 0.0f; std::string header_label; char buffer_str_main[1024] = ""; char buffer_str_arg[1024] = ""; int temp_int_1 = 0; int temp_int_2 = 0; std::string temp_window_button_title; FloatingWindowInputOverlayTagsState input_tags_state; }; auto filter_newline_limit = [](ImGuiInputTextCallbackData* data) { static int newline_count = 0; const int newline_max = 2; if (data->EventFlag == ImGuiInputTextFlags_CallbackEdit) { //Iterate over buffer and count newlines newline_count = 0; for (char* ibuf = data->Buf, *ibuf_end = data->Buf + data->BufTextLen; ibuf != ibuf_end; ++ibuf) { if (*ibuf == '\n') { //Replace newlines that occur after counting to max with space character if (newline_count >= newline_max) { *ibuf = ' '; data->BufDirty = true; } else { ++newline_count; } } } } else if (data->EventFlag == ImGuiInputTextFlags_CallbackCharFilter) //Filter newlines during input if over limit { return (int)((data->EventChar == '\n') && (newline_count >= newline_max)); } return 0; }; ImGuiStyle& style = ImGui::GetStyle(); ImGuiIO& io = ImGui::GetIO(); ActionManager& action_manager = ConfigManager::Get().GetActionManager(); VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); static Action action_edit; //Temporary copy of the selected action for editing static FloatingWindowInputOverlayTagsState input_tags_state; static std::vector command_ui_states; static char buffer_action_name[256] = ""; static char buffer_action_label[1024] = ""; static char buffer_action_target_tags[1024] = ""; static bool label_matches_name = true; static int appearing_framecount = 0; static float area_tags_animation_progress = 0.0f; static float tags_widget_height = 0.0f; static bool action_test_was_used = false; static bool delete_confirm_state = false; static float delete_button_width = 0.0f; if (only_restore_settings) { //Restore action to old state for dashboard app if it was sent over for testing if (action_test_was_used) { if (action_manager.ActionExists(action_edit.UID)) { IPCManager::Get().SendStringToDashboardApp(configid_str_state_action_data, action_edit.Serialize(), UIManager::Get()->GetWindowHandle()); } else //It shouldn't exist, so delete it on the other end { IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_action_delete, action_edit.UID); } } return; } bool reload_icon = false; if (m_PageAppearing == wndsettings_page_actions_edit) { appearing_framecount = ImGui::GetFrameCount(); command_ui_states.clear(); action_test_was_used = false; delete_confirm_state = false; reload_icon = true; input_tags_state.PopupShow = false; //Make sure profile list is ready m_ProfileList = ConfigManager::Get().GetOverlayProfileList(); //Create from scratch if selected UID is 0 if (m_ActionSelectionUID == k_ActionUID_Invalid) { action_edit = Action(); action_edit.UID = action_manager.GenerateUID(); action_edit.Name = TranslationManager::GetString(tstr_SettingsActionsEditNameNew); action_edit.Label = action_edit.Name; m_ActionSelectionUID = action_edit.UID; } else { action_edit = action_manager.GetAction(m_ActionSelectionUID); } //Fill buffers from action data size_t copied_length = action_edit.Name.copy(buffer_action_name, IM_ARRAYSIZE(buffer_action_name) - 1); buffer_action_name[copied_length] = '\0'; copied_length = action_edit.Label.copy(buffer_action_label, IM_ARRAYSIZE(buffer_action_label) - 1); buffer_action_label[copied_length] = '\0'; copied_length = action_edit.TargetTags.copy(buffer_action_target_tags, IM_ARRAYSIZE(buffer_action_target_tags) - 1); buffer_action_target_tags[copied_length] = '\0'; label_matches_name = (action_edit.Label == action_edit.Name); area_tags_animation_progress = (action_edit.TargetUseTags) ? 1.0f : 0.0f; UIManager::Get()->RepeatFrame(); } if ((m_PageAppearing == wndsettings_page_actions_edit) || (m_CachedSizes.ActionEdit_ButtonDeleteSize.x == 0.0f)) { //Figure out size for delete button. We need it to stay the same but also consider the case of the confirm text being longer in some languages ImVec2 text_size_delete = ImGui::CalcTextSize(TranslationManager::GetString(tstr_SettingsActionsEditCommandDelete), nullptr, true); ImVec2 text_size_confirm = ImGui::CalcTextSize(TranslationManager::GetString(tstr_SettingsActionsEditCommandDeleteConfirm), nullptr, true); m_CachedSizes.ActionEdit_ButtonDeleteSize = (text_size_delete.x > text_size_confirm.x) ? text_size_delete : text_size_confirm; m_CachedSizes.ActionEdit_ButtonDeleteSize.x += style.FramePadding.x * 2.0f; m_CachedSizes.ActionEdit_ButtonDeleteSize.y += style.FramePadding.y * 2.0f; UIManager::Get()->RepeatFrame(); } if (m_PageReturned == wndsettings_page_icon_picker) { action_edit.IconFilename = m_IconPickerFile; reload_icon = true; m_PageReturned = wndsettings_page_none; } if ((reload_icon) && (!action_edit.IconFilename.empty())) { std::string icon_path = "images/icons/" + action_edit.IconFilename; std::wstring icon_path_wstr = WStringConvertFromUTF8(icon_path.c_str()); //Avoid reloading if the path is already the same if (wcscmp(icon_path_wstr.c_str(), TextureManager::Get().GetTextureFilename(tmtex_icon_temp)) != 0) { TextureManager::Get().SetTextureFilenameIconTemp(icon_path_wstr.c_str()); TextureManager::Get().ReloadAllTexturesLater(); } UIManager::Get()->RepeatFrame(); } ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_SettingsActionsEditHeader)); ImGui::Columns(2, "ColumnActionEditBase", false); ImGui::SetColumnWidth(0, m_Column0Width); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsActionsEditName)); //Add a tooltip when translation ID is used to minimize confusion about the name not matching what's displayed outside this page if (action_edit.NameTranslationID != tstr_NONE) { ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsActionsEditNameTranslatedTip)); } ImGui::NextColumn(); ImGui::PushItemWidth(-1.0f); ImGui::PushID(appearing_framecount); //The idea is to have ImGui treat this as a new widget every time the page is opened, so the cursor position isn't remembered between page switches vr_keyboard.VRKeyboardInputBegin("##InputActionName"); if (ImGui::InputText("##InputActionName", buffer_action_name, IM_ARRAYSIZE(buffer_action_name))) { UIManager::Get()->AddFontBuilderStringIfAnyUnmappedCharacters(buffer_action_name); action_edit.Name = buffer_action_name; //As long as label matches name, adjust label alongside it if (label_matches_name) { action_edit.Label = action_edit.Name; size_t copied_length = action_edit.Label.copy(buffer_action_label, IM_ARRAYSIZE(buffer_action_label) - 1); buffer_action_label[copied_length] = '\0'; action_edit.LabelTranslationID = action_manager.GetTranslationIDForName(action_edit.Label); } //Check for potential translation string action_edit.NameTranslationID = action_manager.GetTranslationIDForName(action_edit.Name); } vr_keyboard.VRKeyboardInputEnd(); ImGui::PopID(); ImGui::NextColumn(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsActionsEditTarget)); ImGui::NextColumn(); if (ImGui::RadioButton(TranslationManager::GetString(tstr_SettingsActionsEditTargetDefault), !action_edit.TargetUseTags)) { action_edit.TargetUseTags = false; } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsActionsEditTargetDefaultTip)); ImGui::SameLine(); if (ImGui::RadioButton(TranslationManager::GetString(tstr_SettingsActionsEditTargetUseTags), action_edit.TargetUseTags)) { action_edit.TargetUseTags = true; } tags_widget_height = ImGui::GetCursorPosY(); ImGui::BeginCollapsingArea("AreaTags", action_edit.TargetUseTags, area_tags_animation_progress); if (InputOverlayTags("TargetTags", buffer_action_target_tags, IM_ARRAYSIZE(buffer_action_target_tags), input_tags_state)) { action_edit.TargetTags = buffer_action_target_tags; } ImGui::EndCollapsingArea(); ImGui::Columns(1); tags_widget_height = ImGui::GetCursorPosY() - tags_widget_height; ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_SettingsActionsEditHeaderAppearance)); //Use settings icon as default button size reference ImVec2 b_size_default, b_uv_min, b_uv_max; TextureManager::Get().GetTextureInfo(tmtex_icon_settings, b_size_default, b_uv_min, b_uv_max); //Adapt to the last known scale used in VR so the text alignment matches what's seen in the headset later if (UIManager::Get()->IsInDesktopMode()) { b_size_default.x *= UIManager::Get()->GetUIScale(); b_size_default.y *= UIManager::Get()->GetUIScale(); b_size_default.x *= ConfigManager::GetValue(configid_float_interface_last_vr_ui_scale); b_size_default.y *= ConfigManager::GetValue(configid_float_interface_last_vr_ui_scale); } //It's a bit hacky, but we add the preview button last to avoid it changing line heights and shift the position of widgets around to leave space for it instead ImVec2 button_pos = ImGui::GetCursorPos(); const float line_x = ImGui::GetCursorPosX() + b_size_default.x + style.IndentSpacing + style.IndentSpacing + style.ItemSpacing.x + style.ItemSpacing.x; ImGui::Columns(2, "ColumnActionEditAppearance", false); ImGui::SetColumnWidth(0, m_Column0Width); ImGui::SetCursorPosX(line_x); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsActionsEditIcon)); ImGui::NextColumn(); ImGui::PushID("##FileName"); if (ImGui::Button((!action_edit.IconFilename.empty()) ? action_edit.IconFilename.c_str() : TranslationManager::GetString(tstr_DialogIconPickerNone))) { PageGoForward(wndsettings_page_icon_picker); } ImGui::PopID(); ImGui::NextColumn(); ImGui::SetCursorPosX(line_x); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsActionsEditLabel)); if (action_edit.LabelTranslationID != tstr_NONE) { ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsActionsEditLabelTranslatedTip)); } ImGui::NextColumn(); ImGui::PushItemWidth(-1.0f); ImGui::PushID(appearing_framecount); vr_keyboard.VRKeyboardInputBegin("##InputActionLabel", true); ImVec2 multiline_input_size(-1, (ImGui::GetTextLineHeight() * 3.0f) + (style.FramePadding.y * 2.0f)); if (ImGui::InputTextMultiline("##InputActionLabel", buffer_action_label, IM_ARRAYSIZE(buffer_action_label), multiline_input_size, ImGuiInputTextFlags_CallbackCharFilter | ImGuiInputTextFlags_CallbackEdit, filter_newline_limit)) { UIManager::Get()->AddFontBuilderStringIfAnyUnmappedCharacters(buffer_action_label); action_edit.Label = buffer_action_label; label_matches_name = (action_edit.Label == action_edit.Name); //Check for potential translation string action_edit.LabelTranslationID = action_manager.GetTranslationIDForName(action_edit.Label); } vr_keyboard.VRKeyboardInputEnd(); ImGui::PopID(); ImGui::Columns(1); const ImVec2 command_header_pos = ImGui::GetCursorPos(); //Vertically center button button_pos.x += style.IndentSpacing; button_pos.y += (command_header_pos.y - button_pos.y) / 2.0f - (b_size_default.y / 2.0f); ImGui::SetCursorPos(button_pos); if (!UIManager::Get()->IsOpenVRLoaded()) //Disable when dashboard app isn't available ImGui::PushItemDisabledNoVisual(); WindowFloatingUIActionBar::ButtonAction(action_edit, b_size_default, true); if (ImGui::IsItemActivated()) { //Send action over so it can be used for testing IPCManager::Get().SendStringToDashboardApp(configid_str_state_action_data, action_edit.Serialize(), UIManager::Get()->GetWindowHandle()); action_manager.StartAction(action_edit.UID); //Make sure to either revert or get rid of the action if canceling the edit later action_test_was_used = true; } else if (ImGui::IsItemDeactivated()) { action_manager.StopAction(action_edit.UID); } if (!UIManager::Get()->IsOpenVRLoaded()) ImGui::PopItemDisabledNoVisual(); ImGui::SetCursorPos(command_header_pos); ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_SettingsActionsEditHeaderCommands)); ImGui::Indent(); ImGui::SetNextItemWidth(-1.0f); const float item_height = ImGui::GetFontSize() + style.ItemSpacing.y; const float inner_padding = style.FramePadding.y + style.FramePadding.y + style.ItemInnerSpacing.y; const float item_count = (UIManager::Get()->IsInDesktopMode()) ? 13.5f : 9.5f; ImGui::BeginChild("CommandList", ImVec2(0.0f, (item_height * item_count) + inner_padding - m_WarningHeight - tags_widget_height), true, ImGuiWindowFlags_AlwaysVerticalScrollbar); static int header_open = -1; static float header_new_appearance_progress = 1.0f; //We animate newly created command headers appearing as pop-in is a bit grating and it's simple, but do nothing for removal static std::vector list_unique_ids; static unsigned int drag_last_hovered_header = 0; static int keyboard_swapped_index = -1; static bool is_dragging_header = false; command_ui_states.resize(action_edit.Commands.size()); const float header_text_max_width = ImGui::GetContentRegionAvail().x - ImGui::GetFrameHeightWithSpacing() - style.FramePadding.x; //Reset unique IDs when appearing if (m_PageAppearing == wndsettings_page_actions_edit) { list_unique_ids.clear(); } //Expand unique id lists if commands were added (also does initialization since it's empty then) while (list_unique_ids.size() < action_edit.Commands.size()) { list_unique_ids.push_back((int)list_unique_ids.size()); } int command_id = 0; for (auto& command : action_edit.Commands) { CommandUIState& ui_state = command_ui_states[command_id]; const bool animate_appearing = (header_new_appearance_progress < 1.0f) && (command_id == action_edit.Commands.size() - 1); if (ui_state.header_label.empty()) { ui_state.header_label = ActionManager::GetCommandDescription(command, header_text_max_width) + "###CommandHeader"; size_t copied_length = command.StrMain.copy(ui_state.buffer_str_main, IM_ARRAYSIZE(ui_state.buffer_str_main) - 1); ui_state.buffer_str_main[copied_length] = '\0'; copied_length = command.StrArg.copy(ui_state.buffer_str_arg, IM_ARRAYSIZE(ui_state.buffer_str_arg) - 1); ui_state.buffer_str_arg[copied_length] = '\0'; //Skip header animation if command has the value set already ui_state.header_2_animation_progress = ((command.Type == ActionCommand::command_show_overlay) && (LOWORD(command.UIntID) == 1)) ? 1.0f : 0.0f; } ImGui::PushID(list_unique_ids[command_id]); //Set focus for nav if we previously re-ordered overlays via keyboard if (keyboard_swapped_index == command_id) { ImGui::SetKeyboardFocusHere(); //Nav works against us here, so keep setting focus until ctrl isn't down anymore if ((!io.KeyCtrl) || (!io.NavVisible)) { keyboard_swapped_index = -1; } } if (animate_appearing) ImGui::BeginCollapsingArea("CollapsingAreaNewAppear", true, header_new_appearance_progress); ImGui::SetNextItemOpen((header_open == command_id)); if (ImGui::CollapsingHeaderPadded(ui_state.header_label.c_str())) { if (!is_dragging_header) { header_open = command_id; } else if (header_open != command_id) { UIManager::Get()->RepeatFrame(); //Collapsing header's arrow flickers if we deny the change, so skip that frame } } else if (header_open == command_id) { if (!is_dragging_header) { header_open = -1; delete_confirm_state = false; } else { UIManager::Get()->RepeatFrame(); } } if (animate_appearing) { ImGui::EndCollapsingArea(); ui_state.header_animation_progress = header_new_appearance_progress * 0.50f; //The collapsing areas are appearing independently, but slow the lower one down a bit to make it less jarring } if (ImGui::IsItemHovered(ImGuiHoveredFlags_AllowWhenBlockedByActiveItem)) { drag_last_hovered_header = command_id; } //Drag reordering if ((ImGui::IsItemActive()) && (!ImGui::IsItemHovered())) { int index_swap = command_id + ((ImGui::GetMouseDragDelta(ImGuiMouseButton_Left).y < 0.0f) ? -1 : 1); if ((drag_last_hovered_header != command_id) && (index_swap >= 0) && (index_swap < action_edit.Commands.size())) { std::iter_swap(action_edit.Commands.begin() + command_id, action_edit.Commands.begin() + index_swap); std::iter_swap(command_ui_states.begin() + command_id, command_ui_states.begin() + index_swap); std::iter_swap(list_unique_ids.begin() + command_id, list_unique_ids.begin() + index_swap); if (header_open == command_id) { header_open = index_swap; } else if (header_open == index_swap) { header_open = command_id; } ImGui::ResetMouseDragDelta(ImGuiMouseButton_Left); is_dragging_header = true; UIManager::Get()->RepeatFrame(); } } //Keyboard reordering if ((io.NavVisible) && (io.KeyCtrl) && (drag_last_hovered_header == command_id)) { int index_swap = command_id + ((ImGui::IsNavInputPressed(ImGuiNavInput_DpadDown, true)) ? 1 : (ImGui::IsNavInputPressed(ImGuiNavInput_DpadUp, true)) ? -1 : 0); if ((command_id != index_swap) && (index_swap >= 0) && (index_swap < action_edit.Commands.size())) { std::iter_swap(action_edit.Commands.begin() + command_id, action_edit.Commands.begin() + index_swap); std::iter_swap(command_ui_states.begin() + command_id, command_ui_states.begin() + index_swap); std::iter_swap(list_unique_ids.begin() + command_id, list_unique_ids.begin() + index_swap); if (header_open == command_id) { header_open = index_swap; } else if (header_open == index_swap) { header_open = command_id; } //Skip the rest of this frame to avoid double-swaps keyboard_swapped_index = index_swap; ImGui::PopID(); UIManager::Get()->RepeatFrame(); break; } } ImGui::BeginCollapsingArea("CollapsingArea", (header_open == command_id), ui_state.header_animation_progress); ImGui::Indent(); ImGui::Spacing(); ImGui::Columns(2, "ColumnCommand", false); ImGui::SetColumnWidth(0, m_Column0Width); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsActionsEditCommandType)); ImGui::NextColumn(); bool has_value_changed = false; int command_type_temp = command.Type; ImGui::SetNextItemWidth(-1); if (TranslatedComboAnimated("##ComboCommandType", command_type_temp, tstr_SettingsActionsEditCommandTypeNone, tstr_SettingsActionsEditCommandTypeLoadOverlayProfile)) { //Reset command values, then set type command = ActionCommand(); command.Type = (ActionCommand::CommandType)command_type_temp; ui_state.buffer_str_main[0] = '\0'; ui_state.buffer_str_arg[0] = '\0'; ui_state.temp_int_1 = 0; ui_state.temp_int_2 = 0; //Set command specific default values if (command.Type == ActionCommand::command_load_overlay_profile) { command.UIntID = 1; //Clear existing overlays: true } has_value_changed = true; } ImGui::Spacing(); ImGui::NextColumn(); const float cursor_y_prev = ImGui::GetCursorPosY(); switch (command.Type) { case ActionCommand::command_none: break; case ActionCommand::command_key: { if ((m_PageReturned == wndsettings_page_keycode_picker) && (header_open == command_id)) { command.UIntID = m_KeyCodePickerID; has_value_changed = true; m_PageReturned = wndsettings_page_none; } ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsActionsEditCommandKeyCode)); ImGui::NextColumn(); if (ImGui::Button( (command.UIntID == 0) ? TranslationManager::GetString(tstr_DialogKeyCodePickerKeyCodeNone) : GetStringForKeyCode(command.UIntID) )) { m_KeyCodePickerNoMouse = false; m_KeyCodePickerHotkeyMode = false; m_KeyCodePickerID = (unsigned int)command.UIntID; PageGoForward(wndsettings_page_keycode_picker); } ImGui::NextColumn(); bool temp_bool = (command.UIntArg == 1); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsActionsEditCommandKeyToggle), &temp_bool)) { command.UIntArg = temp_bool; has_value_changed = true; } break; } case ActionCommand::command_mouse_pos: { const float input_width = ImGui::GetFontSize() * 6.0f; ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsActionsEditCommandMouseX)); ImGui::NextColumn(); ImGui::SetNextItemWidth(input_width); vr_keyboard.VRKeyboardInputBegin("##X"); if (ImGui::InputInt("##X", &ui_state.temp_int_1, 1, 25)) { has_value_changed = true; } vr_keyboard.VRKeyboardInputEnd(); ImGui::NextColumn(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsActionsEditCommandMouseY)); ImGui::NextColumn(); ImGui::SetNextItemWidth(input_width); vr_keyboard.VRKeyboardInputBegin("##Y"); if (ImGui::InputInt("##Y", &ui_state.temp_int_2, 1, 25)) { has_value_changed = true; } vr_keyboard.VRKeyboardInputEnd(); ImGui::NextColumn(); ImGui::NextColumn(); if (ImGui::Button(TranslationManager::GetString(tstr_SettingsActionsEditCommandMouseUseCurrent))) { POINT mouse_pos = {0}; ::GetCursorPos(&mouse_pos); ui_state.temp_int_1 = mouse_pos.x; ui_state.temp_int_2 = mouse_pos.y; has_value_changed = true; } if (has_value_changed) { command.UIntID = MAKELPARAM(ui_state.temp_int_1, ui_state.temp_int_2); } break; } case ActionCommand::command_string: { ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsActionsEditCommandString)); ImGui::NextColumn(); vr_keyboard.VRKeyboardInputBegin("##InputCommandString"); if (ImGui::InputTextMultiline("##InputCommandString", ui_state.buffer_str_main, IM_ARRAYSIZE(ui_state.buffer_str_main), multiline_input_size)) { //Check input for unmapped characters if (ImGui::StringContainsUnmappedCharacter(ui_state.buffer_str_main)) { if (TextureManager::Get().AddFontBuilderString(ui_state.buffer_str_main)) { TextureManager::Get().ReloadAllTexturesLater(); UIManager::Get()->RepeatFrame(); } } command.StrMain = ui_state.buffer_str_main; has_value_changed = true; } vr_keyboard.VRKeyboardInputEnd(); break; } case ActionCommand::command_launch_app: { ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsActionsEditCommandPath)); ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsActionsEditCommandPathTip)); ImGui::NextColumn(); ImGui::SetNextItemWidth(-1.0f); vr_keyboard.VRKeyboardInputBegin("##InputCommandPath"); if (ImGui::InputText("##InputCommandPath", ui_state.buffer_str_main, IM_ARRAYSIZE(ui_state.buffer_str_main))) { UIManager::Get()->AddFontBuilderStringIfAnyUnmappedCharacters(ui_state.buffer_str_main); command.StrMain = ui_state.buffer_str_main; has_value_changed = true; } vr_keyboard.VRKeyboardInputEnd(); ImGui::NextColumn(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsActionsEditCommandArgs)); ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsActionsEditCommandArgsTip)); ImGui::NextColumn(); ImGui::SetNextItemWidth(-1.0f); vr_keyboard.VRKeyboardInputBegin("##InputCommandArg"); if (ImGui::InputText("##InputCommandArg", ui_state.buffer_str_arg, IM_ARRAYSIZE(ui_state.buffer_str_arg))) { UIManager::Get()->AddFontBuilderStringIfAnyUnmappedCharacters(ui_state.buffer_str_arg); command.StrArg = ui_state.buffer_str_arg; has_value_changed = true; } vr_keyboard.VRKeyboardInputEnd(); break; } case ActionCommand::command_show_keyboard: { ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsActionsEditCommandVisibility)); ImGui::NextColumn(); int command_arg_temp = command.UIntArg; ImGui::SetNextItemWidth(-1); if (TranslatedComboAnimated("##ComboCommandToggleArg", command_arg_temp, tstr_SettingsActionsEditCommandVisibilityToggle, tstr_SettingsActionsEditCommandVisibilityHide)) { command.UIntArg = command_arg_temp; has_value_changed = true; } break; } case ActionCommand::command_crop_active_window: break; case ActionCommand::command_show_overlay: { bool use_command_tags = (LOWORD(command.UIntID) == 1); bool do_undo_command = (HIWORD(command.UIntID) == 1); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsActionsEditCommandVisibility)); ImGui::NextColumn(); int command_arg_temp = command.UIntArg; ImGui::SetNextItemWidth(-1); if (TranslatedComboAnimated("##ComboCommandToggleArg", command_arg_temp, tstr_SettingsActionsEditCommandVisibilityToggle, tstr_SettingsActionsEditCommandVisibilityHide)) { command.UIntArg = command_arg_temp; has_value_changed = true; } ImGui::NextColumn(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsActionsEditTarget)); ImGui::NextColumn(); if (ImGui::RadioButton(TranslationManager::GetString(tstr_SettingsActionsEditTargetActionTarget), !use_command_tags)) { command.UIntID = MAKELPARAM(false, do_undo_command); has_value_changed = true; } ImGui::SameLine(); if (ImGui::RadioButton(TranslationManager::GetString(tstr_SettingsActionsEditTargetUseTags), use_command_tags)) { command.UIntID = MAKELPARAM(true, do_undo_command); has_value_changed = true; } ImGui::BeginCollapsingArea("CommandAreaTags", use_command_tags, ui_state.header_2_animation_progress); if (InputOverlayTags("CommandTargetTags", ui_state.buffer_str_main, IM_ARRAYSIZE(ui_state.buffer_str_main), ui_state.input_tags_state, 1)) { command.StrMain = ui_state.buffer_str_main; has_value_changed = true; } ImGui::EndCollapsingArea(); ImGui::NextColumn(); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsActionsEditCommandUndo), &do_undo_command)) { command.UIntID = MAKELPARAM(use_command_tags, do_undo_command); has_value_changed = true; } break; } case ActionCommand::command_switch_task: { bool use_strict_matching = (LOWORD(command.UIntArg) == 1); bool warp_cursor = (HIWORD(command.UIntArg) == 1); //If window title needs to be refreshed or returned from widnow picker if ((ui_state.temp_window_button_title.empty()) || ((m_PageReturned == wndsettings_page_window_picker) && (header_open == command_id))) { const auto& window_list = WindowManager::Get().WindowListGet(); const bool returned_from_picker = (m_WindowPickerHWND != nullptr); //If not returned from window picker, find HWND for the target window title if possible if (!returned_from_picker) { //exe & class names are packed into StrArg, seperated by |, which isn't allowed to appear in file names so it makes a decent separator here std::string exe_name; std::string class_name; size_t search_pos = command.StrArg.find("|"); if (search_pos != std::string::npos) { exe_name = command.StrArg.substr(0, search_pos); class_name = command.StrArg.substr(search_pos + 1); } m_WindowPickerHWND = WindowInfo::FindClosestWindowForTitle(command.StrMain, class_name, exe_name, window_list, use_strict_matching); } const auto it = std::find_if(window_list.begin(), window_list.end(), [&](const auto& window) { return (window.GetWindowHandle() == m_WindowPickerHWND); }); if (it != window_list.end()) { command.StrMain = StringConvertFromUTF16(it->GetTitle().c_str()); command.StrArg = it->GetExeName() + "|" + StringConvertFromUTF16(it->GetWindowClassName().c_str()); ui_state.temp_window_button_title = it->GetListTitle(); } else if (!command.StrMain.empty()) //Referenced window doesn't exist right now { ui_state.temp_window_button_title = TranslationManager::GetString(tstr_SourceWinRTClosed) + std::string(" " + command.StrMain); } else //Couldn't find any open window { command.StrArg.clear(); ui_state.temp_window_button_title = TranslationManager::GetString(tstr_SettingsActionsEditCommandWindowNone); } has_value_changed = true; m_PageReturned = wndsettings_page_none; m_WindowPickerHWND = nullptr; } ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsActionsEditCommandSwitchingMethod)); ImGui::NextColumn(); if (ImGui::RadioButton(TranslationManager::GetString(tstr_SettingsActionsEditCommandSwitchingMethodSwitcher), (command.UIntID == 0))) { command.UIntID = 0; has_value_changed = true; } ImGui::SameLine(); if (ImGui::RadioButton(TranslationManager::GetString(tstr_SettingsActionsEditCommandSwitchingMethodFocus), (command.UIntID == 1))) { command.UIntID = 1; has_value_changed = true; } ImGui::NextColumn(); if (command.UIntID == 0) ImGui::PushItemDisabled(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsActionsEditCommandWindow)); ImGui::NextColumn(); //Window picker button ImVec2 button_size(0.0f, 0.0f); if (ImGui::CalcTextSize(ui_state.temp_window_button_title.c_str()).x > ImGui::GetContentRegionAvail().x - style.FramePadding.x * 2.0f) { button_size.x = ImGui::GetContentRegionAvail().x - 1.0f; } if (ImGui::Button(ui_state.temp_window_button_title.c_str(), button_size)) { std::string exe_name; std::string class_name; size_t search_pos = command.StrArg.find("|"); if (search_pos != std::string::npos) { exe_name = command.StrArg.substr(0, search_pos); class_name = command.StrArg.substr(search_pos + 1); } HWND hwnd_current = WindowInfo::FindClosestWindowForTitle(command.StrMain, class_name, exe_name, WindowManager::Get().WindowListGet(), use_strict_matching); m_WindowPickerHWND = hwnd_current; PageGoForward(wndsettings_page_window_picker); } ImGui::NextColumn(); ImGui::NextColumn(); if (ImGui::Checkbox(TranslationManager::GetString(tstr_OvrlPropsCaptureGCStrictMatching), &use_strict_matching)) { command.UIntArg = MAKELPARAM(use_strict_matching, warp_cursor); has_value_changed = true; } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_SettingsActionsEditCommandWindowStrictMatchingTip)); ImGui::NextColumn(); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsActionsEditCommandCursorWarp), &warp_cursor)) { command.UIntArg = MAKELPARAM(use_strict_matching, warp_cursor); has_value_changed = true; } if (command.UIntID == 0) ImGui::PopItemDisabled(); break; } case ActionCommand::command_load_overlay_profile: { bool clear_existing = (command.UIntID == 1); int& list_id = ui_state.temp_int_1; //Find current selection index if needed if ((list_id == 0) && (!command.StrMain.empty())) { const auto it = std::find(m_ProfileList.begin(), m_ProfileList.end(), command.StrMain); list_id = (it != m_ProfileList.end()) ? (int)std::distance(m_ProfileList.begin(), it) : -1; } ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsActionsEditCommandProfile)); ImGui::NextColumn(); ImGui::PushItemWidth(-1); ImGui::SetNextItemWidth(-1); if (ImGui::BeginComboAnimated("##ComboLang", (!command.StrMain.empty()) ? command.StrMain.c_str() : TranslationManager::GetString(tstr_SettingsProfilesOverlaysNameDefault) )) { int index = 0; for (const auto& name : m_ProfileList) { //Skip [New Profile] which is always at the end of the list if (index == m_ProfileList.size() - 1) { break; } ImGui::PushID(index); if (ImGui::Selectable(name.c_str(), (index == list_id))) { list_id = index; if (list_id == 0) { command.StrMain = ""; command.UIntID = 1; } else { command.StrMain = m_ProfileList[list_id]; } has_value_changed = true; } ImGui::PopID(); index++; } ImGui::EndCombo(); } ImGui::NextColumn(); //"Default Profile" is always clearing overlays if (list_id == 0) ImGui::PushItemDisabled(); if (ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsActionsEditCommandProfileClear), &clear_existing)) { command.UIntID = clear_existing; has_value_changed = true; } if (list_id == 0) ImGui::PopItemDisabled(); break; } default: break; } if (has_value_changed) { ui_state.header_label = ActionManager::GetCommandDescription(command, header_text_max_width); } ImGui::Columns(1); //Delete button bool command_was_deleted = false; if (cursor_y_prev != ImGui::GetCursorPosY()) //Only add spacing if the command had any settings ImGui::Spacing(); ImGui::SetCursorPosX(ImGui::GetCursorPosX() + ImGui::GetContentRegionAvail().x - delete_button_width); if (delete_confirm_state) { if (ImGui::Button(TranslationManager::GetString(tstr_SettingsActionsEditCommandDeleteConfirm), m_CachedSizes.ActionEdit_ButtonDeleteSize)) { delete_confirm_state = false; action_edit.Commands.erase(action_edit.Commands.begin() + command_id); command_ui_states.erase(command_ui_states.begin() + command_id); header_open = -1; command_was_deleted = true; } } else { if (ImGui::Button(TranslationManager::GetString(tstr_SettingsActionsEditCommandDelete), m_CachedSizes.ActionEdit_ButtonDeleteSize)) { delete_confirm_state = true; } } delete_button_width = ImGui::GetItemRectSize().x + style.IndentSpacing; ImGui::Spacing(); ImGui::Unindent(); ImGui::EndCollapsingArea(); ImGui::PopID(); if (command_was_deleted) { UIManager::Get()->RepeatFrame(); break; } ++command_id; } if (!action_edit.Commands.empty()) { ImGui::Separator(); } //Use empty label here. Icon and actual label are manually created further down if (ImGui::Selectable("##AddCommand", false)) { ActionCommand command; action_edit.Commands.push_back(command); //Animate appearance of new command and open its header header_new_appearance_progress = 0.0f; header_open = (int)action_edit.Commands.size() - 1; UIManager::Get()->RepeatFrame(3); //3 frames to avoid scrollbar flickering from sizing calculations } if (ImGui::IsItemVisible()) { //Custom render the selectable label with icon ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); ImVec2 img_size_line_height = {ImGui::GetTextLineHeight(), ImGui::GetTextLineHeight()}; ImVec2 img_size, img_uv_min, img_uv_max; TextureManager::Get().GetTextureInfo(tmtex_icon_add, img_size, img_uv_min, img_uv_max); ImGui::Image(ImGui::GetIO().Fonts->TexID, img_size_line_height, img_uv_min, img_uv_max); //Label ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsActionsEditCommandAdd)); } ImGui::EndChild(); ImGui::Unindent(); if (ImGui::IsMouseReleased(ImGuiMouseButton_Left)) { is_dragging_header = false; } ImGui::SetCursorPosY( ImGui::GetCursorPosY() + (ImGui::GetContentRegionAvail().y - ImGui::GetFrameHeight()) ); //Confirmation buttons if (ImGui::Button(TranslationManager::GetString(tstr_DialogOk))) { action_manager.StoreAction(action_edit); //Reload texture to apply icon if there is any if (!action_edit.IconFilename.empty()) { TextureManager::Get().ReloadAllTexturesLater(); } //Send action over IPCManager::Get().SendStringToDashboardApp(configid_str_state_action_data, action_edit.Serialize(), UIManager::Get()->GetWindowHandle()); PageGoBack(); } ImGui::SameLine(); if (ImGui::Button(TranslationManager::GetString(tstr_DialogCancel))) { PageGoBack(); } } void WindowSettings::UpdatePageActionsOrder(bool only_restore_settings) { static FloatingWindowActionOrderListState page_state; ActionManager& action_manager = ConfigManager::Get().GetActionManager(); ActionManager::ActionList& action_list = (m_ActionOrderListEditForOverlayBar) ? action_manager.GetActionOrderListOverlayBar() : action_manager.GetActionOrderListBarDefault(); if (only_restore_settings) { if (!page_state.HasSavedChanges) { action_list = page_state.ActionListOrig; } return; } bool go_add_actions = false; bool go_back = ActionOrderList(action_list, (m_PageAppearing == wndsettings_page_actions_order), (m_PageReturned == wndsettings_page_actions_order_add), page_state, go_add_actions, -m_WarningHeight); if (m_PageReturned == wndsettings_page_actions_order_add) { m_PageReturned = wndsettings_page_none; } if (go_add_actions) { PageGoForward(wndsettings_page_actions_order_add); } else if (go_back) { PageGoBack(); } } void WindowSettings::UpdatePageActionsOrderAdd() { static FloatingWindowActionAddSelectorState page_state; ActionManager& action_manager = ConfigManager::Get().GetActionManager(); ActionManager::ActionList& action_list = (m_ActionOrderListEditForOverlayBar) ? action_manager.GetActionOrderListOverlayBar() : action_manager.GetActionOrderListBarDefault(); bool go_back = ActionAddSelector(action_list, (m_PageAppearing == wndsettings_page_actions_order_add), page_state, -m_WarningHeight); if (go_back) { PageGoBack(); } } void WindowSettings::UpdatePageColorPicker(bool only_restore_settings) { static ImVec4 color_current; static ImVec4 color_original; static bool do_restore_color = true; const ConfigID_Int config_id = configid_int_interface_background_color; //Currently only need this one, so we keep it simple if (only_restore_settings) { if (do_restore_color) { ImU32 rgba = ImGui::ColorConvertFloat4ToU32(color_original); ConfigManager::Get().SetValue(config_id, *(int*)&rgba); IPCManager::Get().PostMessageToDashboardApp(ipcmsg_set_config, ConfigManager::GetWParamForConfigID(config_id), *(int*)&rgba); } return; } if (m_PageAppearing == wndsettings_page_color_picker) { color_current = ImGui::ColorConvertU32ToFloat4( pun_cast(ConfigManager::Get().GetValue(config_id)) ); color_original = color_current; do_restore_color = true; } ImGuiStyle& style = ImGui::GetStyle(); VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); //Make page scrollable since we can't easily adjust the picker to space taken by warnings ImGui::PushStyleColor(ImGuiCol_ChildBg, ImVec4(0.00f, 0.00f, 0.00f, 0.00f)); ImGui::BeginChild("SettingsColorPicker", ImVec2(0.00f, -ImGui::GetFrameHeightWithSpacing() - style.ItemSpacing.y), ImGuiChildFlags_NavFlattened); ImGui::PopStyleColor(); ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_DialogColorPickerHeader)); ImGui::Indent(); vr_keyboard.VRKeyboardInputBegin("#ColorPicker"); if (ImGui::ColorPicker4Simple("#ColorPicker", &color_current.x, &color_original.x, TranslationManager::GetString(tstr_DialogColorPickerCurrent), TranslationManager::GetString(tstr_DialogColorPickerOriginal), UIManager::Get()->IsInDesktopMode() ? 1.25f : 1.00f)) { int rgba = pun_cast( ImGui::ColorConvertFloat4ToU32(color_current) ); ConfigManager::Get().SetValue(config_id, rgba); IPCManager::Get().PostConfigMessageToDashboardApp(config_id, rgba); } vr_keyboard.VRKeyboardInputEnd(); ImGui::Unindent(); ImGui::EndChild(); ImGui::SetCursorPosY( ImGui::GetCursorPosY() + (ImGui::GetContentRegionAvail().y - ImGui::GetFrameHeightWithSpacing()) ); //Confirmation buttons ImGui::Separator(); if (ImGui::Button(TranslationManager::GetString(tstr_DialogOk))) { //Prevent restore settings code from overwriting it later do_restore_color = false; PageGoBack(); } ImGui::SameLine(); if (ImGui::Button(TranslationManager::GetString(tstr_DialogCancel))) { PageGoBack(); } } void WindowSettings::UpdatePageProfilePicker() { ImGuiStyle& style = ImGui::GetStyle(); static bool is_nav_focus_entry_pending = false; //Focus has to be delayed until after the page animation is done static bool scroll_to_selection = false; static int list_id = -1; if (m_PageAppearing == wndsettings_page_profile_picker) { //Load profile list m_ProfileList = ConfigManager::Get().GetOverlayProfileList(); list_id = -1; //Adjust entries from profile list for picker use m_ProfileList[0] = TranslationManager::GetString(tstr_DialogProfilePickerNone); m_ProfileList.erase(m_ProfileList.end() - 1); //Pre-select previous selection if it can be found if (m_ProfilePickerName.empty()) { list_id = 0; scroll_to_selection = true; is_nav_focus_entry_pending = ImGui::GetIO().NavVisible; } else { const auto it = std::find(m_ProfileList.begin(), m_ProfileList.end(), m_ProfilePickerName); if (it != m_ProfileList.end()) { list_id = (int)std::distance(m_ProfileList.begin(), it); scroll_to_selection = true; is_nav_focus_entry_pending = ImGui::GetIO().NavVisible; } } } ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_DialogProfilePickerHeader)); ImGui::Indent(); ImGui::SetNextItemWidth(-1.0f); const float item_height = ImGui::GetFontSize() + style.ItemSpacing.y; const float inner_padding = style.FramePadding.y + style.FramePadding.y + style.ItemInnerSpacing.y; const float item_count = (UIManager::Get()->IsInDesktopMode()) ? 22.0f : 15.0f; ImGui::BeginChild("ProfilePickerList", ImVec2(0.0f, (item_height * item_count) + inner_padding - m_WarningHeight), true); //List profiles int index = 0; for (const auto& name : m_ProfileList) { if ( (is_nav_focus_entry_pending) && (m_PageAnimationDir == 0) && (index == list_id) ) { ImGui::SetKeyboardFocusHere(); is_nav_focus_entry_pending = false; } ImGui::PushID(index); if (ImGui::Selectable(name.c_str(), (index == list_id))) { list_id = index; m_ProfilePickerName = (list_id == 0) ? "" : m_ProfileList[list_id]; PageGoBack(); } ImGui::PopID(); if ( (scroll_to_selection) && (index == list_id) ) { ImGui::SetScrollHereY(); if (ImGui::IsItemVisible()) { scroll_to_selection = false; } } index++; } ImGui::EndChild(); ImGui::Unindent(); ImGui::SetCursorPosY( ImGui::GetCursorPosY() + (ImGui::GetContentRegionAvail().y - ImGui::GetFrameHeight()) ); //Cancel button if (ImGui::Button(TranslationManager::GetString(tstr_DialogCancel))) { PageGoBack(); } } void WindowSettings::UpdatePageActionPicker() { ImGuiStyle& style = ImGui::GetStyle(); static ActionUID list_uid = k_ActionUID_Invalid; static bool is_nav_focus_entry_pending = false; //Focus has to be delayed until after the page animation is done static bool scroll_to_selection = false; if (m_PageAppearing == wndsettings_page_action_picker) { //Load action list m_ActionList = ConfigManager::Get().GetActionManager().GetActionNameList(); list_uid = m_ActionPickerUID; scroll_to_selection = true; is_nav_focus_entry_pending = ImGui::GetIO().NavVisible; //Set to invalid if selection doesn't exist if (!ConfigManager::Get().GetActionManager().ActionExists(list_uid)) { list_uid = k_ActionUID_Invalid; } } ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_DialogActionPickerHeader)); ImGui::Indent(); ImGui::SetNextItemWidth(-1.0f); const float item_height = ImGui::GetFontSize() + style.ItemSpacing.y; const float inner_padding = style.FramePadding.y + style.FramePadding.y + style.ItemInnerSpacing.y; const float item_count = (UIManager::Get()->IsInDesktopMode()) ? 22.0f : 15.0f; ImGui::BeginChild("ActionPickerList", ImVec2(0.0f, (item_height * item_count) + inner_padding - m_WarningHeight), true); //No Action entry { ImGui::PushID(0); if ( (is_nav_focus_entry_pending) && (m_PageAnimationDir == 0) && (list_uid == k_ActionUID_Invalid) ) { ImGui::SetKeyboardFocusHere(); is_nav_focus_entry_pending = false; } if (ImGui::Selectable(TranslationManager::GetString(tstr_ActionNone), (list_uid == k_ActionUID_Invalid) )) { list_uid = k_ActionUID_Invalid; m_ActionPickerUID = k_ActionUID_Invalid; PageGoBack(); } if ( (scroll_to_selection) && (list_uid == k_ActionUID_Invalid) ) { ImGui::SetScrollHereY(); if (ImGui::IsItemVisible()) { scroll_to_selection = false; } } ImGui::PopID(); } //List actions for (const auto& entry : m_ActionList) { ImGui::PushID((void*)entry.UID); if ( (is_nav_focus_entry_pending) && (m_PageAnimationDir == 0) && (entry.UID == list_uid) ) { ImGui::SetKeyboardFocusHere(); is_nav_focus_entry_pending = false; } if (ImGui::Selectable(entry.Name.c_str(), (entry.UID == list_uid) )) { list_uid = entry.UID; m_ActionPickerUID = entry.UID; PageGoBack(); } if ( (scroll_to_selection) && (entry.UID == list_uid) ) { ImGui::SetScrollHereY(); if (ImGui::IsItemVisible()) { scroll_to_selection = false; } } ImGui::PopID(); } ImGui::EndChild(); ImGui::Unindent(); ImGui::SetCursorPosY( ImGui::GetCursorPosY() + (ImGui::GetContentRegionAvail().y - ImGui::GetFrameHeight()) ); //Cancel button if (ImGui::Button(TranslationManager::GetString(tstr_DialogCancel))) { PageGoBack(); } } void WindowSettings::UpdatePageKeyCodePicker(bool only_restore_settings) { ImGuiStyle& style = ImGui::GetStyle(); VRKeyboard& vr_keyboard = UIManager::Get()->GetVRKeyboard(); static ImGuiTextFilter filter; static int list_id = 0; static bool is_nav_focus_entry_pending = false; //Focus has to be delayed until after the page animation is done static bool scroll_to_selection = false; static unsigned char key_code_prev = 0; static bool mod_ctrl = false; static bool mod_alt = false; static bool mod_shift = false; static bool mod_win = false; if (only_restore_settings) { //Only really need to reset this in hotkey mode m_KeyCodePickerID = key_code_prev; return; } if (m_PageAppearing == wndsettings_page_keycode_picker) { list_id = m_KeyCodePickerID; key_code_prev = m_KeyCodePickerID; scroll_to_selection = true; is_nav_focus_entry_pending = ImGui::GetIO().NavVisible; for (int i = 0; i < 256; i++) { //Not the smartest, but most straight forward way if (GetKeyCodeForListID(i) == m_KeyCodePickerID) { list_id = i; //Clear filter if it wouldn't show the current selection if (!filter.PassFilter( (m_KeyCodePickerID == 0) ? TranslationManager::GetString(tstr_DialogKeyCodePickerKeyCodeNone) : GetStringForKeyCode(m_KeyCodePickerID) )) { filter.Clear(); } break; } } if (m_KeyCodePickerHotkeyMode) { mod_ctrl = (m_KeyCodePickerHotkeyFlags & MOD_CONTROL); mod_alt = (m_KeyCodePickerHotkeyFlags & MOD_ALT); mod_shift = (m_KeyCodePickerHotkeyFlags & MOD_SHIFT); mod_win = (m_KeyCodePickerHotkeyFlags & MOD_WIN); } } //Modifier flags if this displayed to set a hotkey if (m_KeyCodePickerHotkeyMode) { ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_DialogKeyCodePickerHeaderHotkey)); ImGui::Indent(); static float checkbox_width = 0.0f; ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_DialogKeyCodePickerModifiers)); ImGui::SameLine(); ImGui::SetCursorPosX(ImGui::GetCursorPosX() + ImGui::GetContentRegionAvail().x - checkbox_width); ImGui::BeginGroup(); ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, {style.ItemSpacing.x * 2.0f, style.ItemSpacing.y}); ImGui::Checkbox("Ctrl", &mod_ctrl); //These could be translated, but the whole key list isn't, so no point right now ImGui::SameLine(); ImGui::Checkbox("Alt", &mod_alt); ImGui::SameLine(); ImGui::Checkbox("Shift", &mod_shift); ImGui::SameLine(); ImGui::Checkbox("Win", &mod_win); ImGui::PopStyleVar(); ImGui::EndGroup(); checkbox_width = ImGui::GetItemRectSize().x + style.ItemSpacing.x; ImGui::TextUnformatted(TranslationManager::GetString(tstr_DialogKeyCodePickerKeyCode)); ImGui::Spacing(); } else //Normal header { ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_DialogKeyCodePickerHeader)); } ImGui::Indent(); ImGui::SetNextItemWidth(-1.0f); vr_keyboard.SetShortcutWindowDirectionHint(ImGuiDir_Up); vr_keyboard.VRKeyboardInputBegin("##FilterList"); if (ImGui::InputTextWithHint("##FilterList", TranslationManager::GetString(tstr_DialogKeyCodePickerKeyCodeHint), filter.InputBuf, IM_ARRAYSIZE(filter.InputBuf))) { UIManager::Get()->AddFontBuilderStringIfAnyUnmappedCharacters(filter.InputBuf); filter.Build(); } vr_keyboard.VRKeyboardInputEnd(); const float item_height = ImGui::GetFontSize() + style.ItemSpacing.y; const float inner_padding = style.FramePadding.y + style.FramePadding.y + style.ItemInnerSpacing.y; const float item_count_offset = (m_KeyCodePickerHotkeyMode) ? ((UIManager::Get()->IsInDesktopMode()) ? -2.5f : -2.0f) : 0.0f; const float item_count = ((UIManager::Get()->IsInDesktopMode()) ? 21.0f : 16.0f) + item_count_offset; ImGui::BeginChild("KeyCodePickerList", ImVec2(-1.0f, (item_height * item_count) + inner_padding - m_WarningHeight), true); unsigned char list_keycode; const char* list_keycode_str = nullptr; for (int i = 0; i < 256; i++) { list_keycode = GetKeyCodeForListID(i); list_keycode_str = (list_keycode == 0) ? TranslationManager::GetString(tstr_DialogKeyCodePickerKeyCodeNone) : GetStringForKeyCode(list_keycode); if (filter.PassFilter(list_keycode_str)) { if ( (m_KeyCodePickerNoMouse) && (list_keycode >= VK_LBUTTON) && (list_keycode <= VK_XBUTTON2) && (list_keycode != VK_CANCEL) ) //Skip mouse buttons if turned off continue; if ( (is_nav_focus_entry_pending) && (m_PageAnimationDir == 0) && (i == list_id) ) { ImGui::SetKeyboardFocusHere(); is_nav_focus_entry_pending = false; } if (ImGui::Selectable(list_keycode_str, (i == list_id))) { list_id = i; m_KeyCodePickerID = list_keycode; if (!m_KeyCodePickerHotkeyMode) { key_code_prev = m_KeyCodePickerID; //Prevent it from being reset PageGoBack(); } } if ((ImGui::IsItemClicked()) && (ImGui::IsMouseDoubleClicked(ImGuiMouseButton_Left))) { key_code_prev = m_KeyCodePickerID; //Prevent it from being reset PageGoBack(); } if ( (scroll_to_selection) && (i == list_id) ) { ImGui::SetScrollHereY(); if (ImGui::IsItemVisible()) { scroll_to_selection = false; } } } } ImGui::EndChild(); ImGui::Unindent(); if (m_KeyCodePickerHotkeyMode) { ImGui::Unindent(); } ImGui::SetCursorPosY( ImGui::GetCursorPosY() + (ImGui::GetContentRegionAvail().y - ImGui::GetFrameHeight()) ); //Confirmation buttons if (m_KeyCodePickerHotkeyMode) { if (ImGui::Button(TranslationManager::GetString(tstr_DialogOk))) { m_KeyCodePickerHotkeyFlags = 0; if (mod_ctrl) m_KeyCodePickerHotkeyFlags |= MOD_CONTROL; if (mod_alt) m_KeyCodePickerHotkeyFlags |= MOD_ALT; if (mod_shift) m_KeyCodePickerHotkeyFlags |= MOD_SHIFT; if (mod_win) m_KeyCodePickerHotkeyFlags |= MOD_WIN; //Prevent restore settings code from overwriting it later key_code_prev = m_KeyCodePickerID; PageGoBack(); } ImGui::SameLine(); } if (ImGui::Button(TranslationManager::GetString(tstr_DialogCancel))) { PageGoBack(); } //"From Input..." button if (UIManager::Get()->IsInDesktopMode()) { ImGui::SameLine(); static float list_buttons_width = 0.0f; ImGui::SetCursorPosX(ImGui::GetCursorPosX() + ImGui::GetContentRegionAvail().x - list_buttons_width); if (ImGui::Button(TranslationManager::GetString(tstr_DialogKeyCodePickerFromInput))) { ImGui::OpenPopup("Bind Key"); } list_buttons_width = ImGui::GetItemRectSize().x; ImGui::SetNextWindowPos({ImGui::GetIO().DisplaySize.x * 0.5f, ImGui::GetIO().DisplaySize.y * 0.5f}, ImGuiCond_Always, ImVec2(0.5f, 0.5f)); if (ImGui::BeginPopupModal("Bind Key", nullptr, ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoNavInputs)) { ImGui::Text(TranslationManager::GetString( (m_KeyCodePickerNoMouse) ? tstr_DialogKeyCodePickerFromInputPopupNoMouse : tstr_DialogKeyCodePickerFromInputPopup )); ImGuiIO& io = ImGui::GetIO(); //We can no longer use ImGui's keyboard state to query all possible keyboard keys, so we do it manually via GetAsyncKeyState() //To avoid issues with keys that are already down to begin with, we store the state in the moment of the popup appearing and only act on changes to that static bool keyboard_state_initial[255] = {0}; static bool wait_for_key_release = false; if (ImGui::IsWindowAppearing()) { for (int i = 0; i < IM_ARRAYSIZE(keyboard_state_initial); ++i) { keyboard_state_initial[i] = (::GetAsyncKeyState(i) < 0); } wait_for_key_release = false; } for (int i = 0; i < IM_ARRAYSIZE(keyboard_state_initial); ++i) { if ((::GetAsyncKeyState(i) < 0) != keyboard_state_initial[i]) { //Key was up before, so it's a key press if (!keyboard_state_initial[i]) { //Ignore mouse buttons if they're disabled bool skip_key = false; if (m_KeyCodePickerNoMouse) { switch (i) { case VK_LBUTTON: case VK_RBUTTON: case VK_MBUTTON: case VK_XBUTTON1: case VK_XBUTTON2: skip_key = true; } } if (!skip_key) { m_KeyCodePickerID = i; if (!m_KeyCodePickerHotkeyMode) { key_code_prev = m_KeyCodePickerID; //Prevent it from being reset } for (int i = 0; i < 256; i++) { if (GetKeyCodeForListID(i) == m_KeyCodePickerID) { list_id = i; break; } } scroll_to_selection = true; //Wait for the key to be released to avoid inputs triggering other things wait_for_key_release = true; keyboard_state_initial[i] = true; } break; } else //Key was down before, so it's a key release. Update the initial state so it can be pressed again and registered as such { keyboard_state_initial[i] = false; //Close popup here if we are waiting for this key to be released if ((wait_for_key_release) && (i == m_KeyCodePickerID)) { ImGui::CloseCurrentPopup(); io.ClearInputKeys(); if (!m_KeyCodePickerHotkeyMode) { PageGoBack(); } } } } } ImGui::EndPopup(); } } } void WindowSettings::UpdatePageIconPicker() { ImGuiStyle& style = ImGui::GetStyle(); static std::vector icon_file_list; static int list_id = 0; static bool is_nav_focus_entry_pending = false; //Focus has to be delayed until after the page animation is done static bool scroll_to_selection = false; if (m_PageAppearing == wndsettings_page_icon_picker) { list_id = 0; scroll_to_selection = true; is_nav_focus_entry_pending = ImGui::GetIO().NavVisible; icon_file_list = ActionManager::GetIconFileList(); icon_file_list.insert(icon_file_list.begin(), TranslationManager::GetString(tstr_DialogIconPickerNone)); //Select matching entry auto it = std::find_if(icon_file_list.begin(), icon_file_list.end(), [&](const auto& list_entry){ return (m_IconPickerFile == list_entry); }); if (it != icon_file_list.end()) { list_id = (int)std::distance(icon_file_list.begin(), it); } } ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_DialogIconPickerHeader)); ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); HelpMarker(TranslationManager::GetString(tstr_DialogIconPickerHeaderTip)); ImGui::Indent(); ImGui::SetNextItemWidth(-1.0f); const float item_height = ImGui::GetFontSize() + style.ItemSpacing.y; const float inner_padding = style.FramePadding.y + style.FramePadding.y + style.ItemInnerSpacing.y; const float item_count = (UIManager::Get()->IsInDesktopMode()) ? 22.0f : 18.0f; ImGui::BeginChild("IconPickerList", ImVec2(0.0f, (item_height * item_count) + inner_padding - m_WarningHeight), true); int i = 0; for (const auto& file_entry : icon_file_list) { if ( (is_nav_focus_entry_pending) && (m_PageAnimationDir == 0) && (i == list_id) ) { ImGui::SetKeyboardFocusHere(); is_nav_focus_entry_pending = false; } if (ImGui::Selectable( file_entry.c_str(), (i == list_id) )) { list_id = i; std::string icon_path = "images/icons/" + file_entry; TextureManager::Get().SetTextureFilenameIconTemp(WStringConvertFromUTF8(icon_path.c_str()).c_str()); TextureManager::Get().ReloadAllTexturesLater(); //Reloading everything on changing one icon path? Seems excessive, but works fine for now. UIManager::Get()->RepeatFrame(); } if ((ImGui::IsItemClicked()) && (ImGui::IsMouseDoubleClicked(ImGuiMouseButton_Left))) { m_IconPickerFile = (list_id != 0) ? icon_file_list[list_id] : ""; PageGoBack(); } if ( (scroll_to_selection) && (i == list_id) ) { ImGui::SetScrollHereY(); if (ImGui::IsItemVisible()) { scroll_to_selection = false; } } ++i; } const bool has_scrollbar = ImGui::IsAnyScrollBarVisible(); ImGui::EndChild(); ImGui::Unindent(); //Icon Preview if (list_id != 0) { ImVec2 i_size, i_uv_min, i_uv_max; TextureManager::Get().GetTextureInfo(tmtex_icon_settings, i_size, i_uv_min, i_uv_max); //Default image size for custom actions ImVec2 i_size_default = i_size; //Draw at bottom right corner of the child window, but don't cover scroll bar if there is any ImVec2 preview_max = ImGui::GetItemRectMax(); if (has_scrollbar) preview_max.x -= style.ScrollbarSize; preview_max.x -= style.ItemInnerSpacing.x; preview_max.y -= style.ItemInnerSpacing.y; ImVec2 preview_pos = preview_max; preview_pos.x -= i_size_default.x; preview_pos.y -= i_size_default.y; TextureManager::Get().GetTextureInfo(tmtex_icon_temp, i_size, i_uv_min, i_uv_max); ImGui::GetForegroundDrawList()->AddImage(ImGui::GetIO().Fonts->TexID, preview_pos, preview_max, i_uv_min, i_uv_max); } ImGui::SetCursorPosY( ImGui::GetCursorPosY() + (ImGui::GetContentRegionAvail().y - ImGui::GetFrameHeight()) ); //Confirmation buttons if (ImGui::Button(TranslationManager::GetString(tstr_DialogOk))) { m_IconPickerFile = (list_id != 0) ? icon_file_list[list_id] : ""; PageGoBack(); } ImGui::SameLine(); if (ImGui::Button(TranslationManager::GetString(tstr_DialogCancel))) { PageGoBack(); } } void WindowSettings::UpdatePageWindowPicker() { ImGuiStyle& style = ImGui::GetStyle(); static HWND list_hwnd = nullptr; static bool is_nav_focus_entry_pending = false; //Focus has to be delayed until after the page animation is done static bool scroll_to_selection = false; static ImVec2 no_actions_text_size; if (m_PageAppearing == wndsettings_page_action_picker) { is_nav_focus_entry_pending = m_WindowPickerHWND; scroll_to_selection = true; is_nav_focus_entry_pending = ImGui::GetIO().NavVisible; } ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_DialogWindowPickerHeader)); ImGui::Indent(); ImGui::SetNextItemWidth(-1.0f); const float item_height = ImGui::GetFontSize() + style.ItemSpacing.y; const float inner_padding = style.FramePadding.y + style.FramePadding.y + style.ItemInnerSpacing.y; const float item_count = (UIManager::Get()->IsInDesktopMode()) ? 22.0f : 15.0f; ImGui::BeginChild("WindowPickerList", ImVec2(0.0f, (item_height * item_count) + inner_padding - m_WarningHeight), true); //List windows ImVec2 img_size_line_height = {ImGui::GetTextLineHeight(), ImGui::GetTextLineHeight()}; ImVec2 img_size, img_uv_min, img_uv_max; const ImVec2 combo_pos = ImGui::GetCursorScreenPos(); for (const auto& window_info : WindowManager::Get().WindowListGet()) { ImGui::PushID(window_info.GetWindowHandle()); if (ImGui::Selectable("", (list_hwnd == window_info.GetWindowHandle()) )) { list_hwnd = window_info.GetWindowHandle(); m_WindowPickerHWND = list_hwnd; PageGoBack(); } if ( (scroll_to_selection) && (list_hwnd == window_info.GetWindowHandle()) ) { ImGui::SetScrollHereY(); if (ImGui::IsItemVisible()) { scroll_to_selection = false; } } ImGui::SameLine(0.0f, 0.0f); int icon_id = TextureManager::Get().GetWindowIconCacheID(window_info.GetIcon()); if (icon_id != -1) { TextureManager::Get().GetWindowIconTextureInfo(icon_id, img_size, img_uv_min, img_uv_max); ImGui::Image(ImGui::GetIO().Fonts->TexID, img_size_line_height, img_uv_min, img_uv_max); ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); } ImGui::TextUnformatted(window_info.GetListTitle().c_str()); ImGui::PopID(); } ImGui::EndChild(); ImGui::Unindent(); ImGui::SetCursorPosY( ImGui::GetCursorPosY() + (ImGui::GetContentRegionAvail().y - ImGui::GetFrameHeight()) ); //Cancel button if (ImGui::Button(TranslationManager::GetString(tstr_DialogCancel))) { PageGoBack(); } } void WindowSettings::UpdatePageResetConfirm() { //Check if it makes sense to show the checkbox for deleting legacy files static bool show_delete_legacy_check = false; if (m_PageAppearing == m_PageCurrent) { const std::wstring wpath_config = WStringConvertFromUTF8( std::string(ConfigManager::Get().GetApplicationPath() + "config_legacy.ini" ).c_str() ); const std::wstring wpath_profiles_single = WStringConvertFromUTF8( std::string(ConfigManager::Get().GetApplicationPath() + "profiles/overlays/" ).c_str() ); const std::wstring wpath_profiles_multi = WStringConvertFromUTF8( std::string(ConfigManager::Get().GetApplicationPath() + "profiles/multi-overlays/").c_str() ); show_delete_legacy_check = ( (FileExists(wpath_config.c_str())) || (DirectoryExists(wpath_profiles_single.c_str())) || (DirectoryExists(wpath_profiles_multi.c_str())) ); } ImGui::TextColoredUnformatted(ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered), TranslationManager::GetString(tstr_SettingsTroubleshootingSettingsReset) ); ImGui::Indent(); ImGui::PushTextWrapPos(); ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsTroubleshootingSettingsResetConfirmDescription)); ImGui::PopTextWrapPos(); static bool reset_settings = true, reset_current_profile = true, reset_profile_overlays = false, reset_profile_apps = false, reset_actions = false, delete_legacy = false; //This uses existing translation strings to avoid duplication of strings that should reasonably stay the same for this context //Might come back to bite for some language but we'll see about that ImGui::Indent(); ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsInterfacePersistentUIWindowsSettings), &reset_settings); ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsTroubleshootingSettingsResetConfirmElementOverlays), &reset_current_profile); ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsProfilesOverlays), &reset_profile_overlays); ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsProfilesApps), &reset_profile_apps); ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsCatActions), &reset_actions); if (show_delete_legacy_check) { ImGui::Checkbox(TranslationManager::GetString(tstr_SettingsTroubleshootingSettingsResetConfirmElementLegacyFiles), &delete_legacy); } ImGui::Unindent(); ImGui::Unindent(); ImGui::SetCursorPosY( ImGui::GetCursorPosY() + (ImGui::GetContentRegionAvail().y - ImGui::GetFrameHeightWithSpacing()) ); //Confirmation buttons ImGui::Separator(); if (ImGui::Button(TranslationManager::GetString(tstr_SettingsTroubleshootingSettingsResetConfirmButton))) { //Do the reset if (reset_settings) { //If resetting current profile isn't on, store it separately for a moment so we can get it back after resetting the whole config file if (!reset_current_profile) { ConfigManager::Get().SaveMultiOverlayProfileToFile("../overlays_temp.ini"); } ConfigManager::Get().RestoreConfigFromDefault(); if (!reset_current_profile) { ConfigManager::Get().LoadMultiOverlayProfileFromFile("../overlays_temp.ini"); ConfigManager::Get().DeleteOverlayProfile("../overlays_temp.ini"); } } else if (reset_current_profile) { ConfigManager::Get().LoadOverlayProfileDefault(true); } if (reset_profile_overlays) { ConfigManager::Get().DeleteAllOverlayProfiles(); } if (reset_profile_apps) { ConfigManager::Get().GetAppProfileManager().RemoveAllProfiles(); } if (reset_actions) { ConfigManager::Get().GetActionManager().RestoreActionsFromDefault(); } if (delete_legacy) { const std::wstring wpath_config = WStringConvertFromUTF8( std::string(ConfigManager::Get().GetApplicationPath() + "config_legacy.ini").c_str() ); //The folder paths are double-NUL terminated for SHFileOperationW() const std::wstring wpath_profiles_single = WStringConvertFromUTF8( std::string(ConfigManager::Get().GetApplicationPath() + "profiles/overlays/" ).c_str() ) + L'\0'; const std::wstring wpath_profiles_multi = WStringConvertFromUTF8( std::string(ConfigManager::Get().GetApplicationPath() + "profiles/multi-overlays/").c_str() ) + L'\0'; //Delete config_legacy.ini ::DeleteFileW(wpath_config.c_str()); //Delete folders recursively with contained files SHFILEOPSTRUCTW fileop = {0}; fileop.wFunc = FO_DELETE; fileop.fFlags = FOF_NO_UI; fileop.pFrom = wpath_profiles_single.c_str(); ::SHFileOperationW(&fileop); fileop.pFrom = wpath_profiles_multi.c_str(); ::SHFileOperationW(&fileop); } UIManager::Get()->Restart(UIManager::Get()->IsInDesktopMode()); //We restart this after the UI since the new UI process needs to detect the dashboard app running first so it doesn't launch in desktop mode if (IPCManager::IsDashboardAppRunning()) { UIManager::Get()->RestartDashboardApp(); } } ImGui::SameLine(); if (ImGui::Button(TranslationManager::GetString(tstr_DialogCancel))) { PageGoBack(); } //Show Quick-Start Guide if (!UIManager::Get()->IsInDesktopMode()) { static float button_quick_start_width = -1.0f; const bool button_quick_start_enabled = ConfigManager::GetValue(configid_bool_interface_quick_start_hidden); ImGui::SameLine(ImGui::GetContentRegionAvail().x - button_quick_start_width); if (!button_quick_start_enabled) ImGui::PushItemDisabled(); if (ImGui::Button(TranslationManager::GetString(tstr_SettingsTroubleshootingSettingsResetShowQuickStart))) { UIManager::Get()->GetAuxUI().GetQuickStartWindow().Reset(); } button_quick_start_width = ImGui::GetItemRectSize().x; if (!button_quick_start_enabled) ImGui::PopItemDisabled(); } } void WindowSettings::PageGoForward(WindowSettingsPage new_page) { //We can't just mess with the stack while a backwards animation is going, so we save this for later if (m_PageAnimationDir == 1) { m_PageStackPending.push_back(new_page); return; } m_PageStack.push_back(new_page); m_PageStackPos++; } void WindowSettings::PageGoBack() { if (m_PageStackPos != 0) { OnPageLeaving(m_PageStack[m_PageStackPos]); m_PageStackPos--; m_PageReturned = m_PageStack.back(); } } void WindowSettings::PageGoBackInstantly() { //Go back while skipping any active animations PageGoBack(); while ((int)m_PageStack.size() > m_PageStackPosAnimation) { m_PageStack.pop_back(); } m_PageAnimationDir = 0; m_PageStackPosAnimation = m_PageStackPos; m_PageAnimationOffset = m_PageAnimationStartPos; m_PageAnimationProgress = 0.0f; } void WindowSettings::PageGoHome() { while (m_PageStackPos != 0) { OnPageLeaving(m_PageStack[m_PageStackPos]); m_PageStackPos--; } } void WindowSettings::OnPageLeaving(WindowSettingsPage previous_page) { switch (previous_page) { case wndsettings_page_keyboard: { UpdatePageKeyboardLayout(true); //Call to reset settings break; } case wndsettings_page_actions_edit: { UpdatePageActionsEdit(true); //Call to reset settings break; } case wndsettings_page_actions_order: { UpdatePageActionsOrder(true); //Call to reset settings break; } case wndsettings_page_color_picker: { UpdatePageColorPicker(true); //Call to reset settings break; } case wndsettings_page_keycode_picker: { UpdatePageKeyCodePicker(true); //Call to reset settings break; } default: break; } } void WindowSettings::SelectableWarning(const char* selectable_id, const char* popup_id, const char* text, bool show_warning_prefix, const ImVec4* text_color) { float* selectable_height = ImGui::GetStateStorage()->GetFloatRef(ImGui::GetID(selectable_id), 1.0f); const bool is_active = ImGui::IsPopupOpen(popup_id); //Force active header color when a menu is active for consistency with other context menus in the app if (is_active) { ImGui::PushStyleColor(ImGuiCol_Header, ImGui::GetStyleColorVec4(ImGuiCol_HeaderActive)); ImGui::PushStyleColor(ImGuiCol_HeaderHovered, ImGui::GetStyleColorVec4(ImGuiCol_HeaderActive)); } //Use selectable stretching over the text area to make it clickable if (ImGui::Selectable(selectable_id, ImGui::IsPopupOpen(popup_id), 0, {0.0f, *selectable_height})) { ImGui::OpenPopup(popup_id); UIManager::Get()->RepeatFrame(); //Avoid flicker from IsPopupOpen() not being true right away } ImGui::SameLine(0.0f, 0.0f); const bool is_selectable_focused = ImGui::IsItemFocused(); //Render text (with wrapping for the actual warning text) ImGui::PushStyleColor(ImGuiCol_Text, (text_color != nullptr) ? *text_color : Style_ImGuiCol_TextWarning); if (show_warning_prefix) { ImGui::TextUnformatted(TranslationManager::GetString(tstr_SettingsWarningPrefix)); ImGui::SameLine(); } ImGui::PushTextWrapPos(); ImGui::TextUnformatted(text); ImGui::PopTextWrapPos(); ImGui::PopStyleColor(); if (is_active) { ImGui::PopStyleColor(); ImGui::PopStyleColor(); } //Store height for the selectable for next time if window is being hovered or selectable focused (could get bogus value otherwise) if ( (ImGui::IsWindowHovered()) || (is_selectable_focused) ) { *selectable_height = ImGui::GetItemRectSize().y; } } void WindowSettings::SelectableHotkey(ConfigHotkey& hotkey, int id) { static int edited_id = -1; //Write changes if we're returning from a picker if ((m_PageReturned == wndsettings_page_keycode_picker) && (edited_id == id)) { hotkey.KeyCode = m_KeyCodePickerID; hotkey.Modifiers = m_KeyCodePickerHotkeyFlags; IPCManager::Get().SendStringToDashboardApp(configid_str_state_hotkey_data, hotkey.Serialize(), UIManager::Get()->GetWindowHandle()); IPCManager::Get().PostMessageToDashboardApp(ipcmsg_action, ipcact_hotkey_set, id); m_PageReturned = wndsettings_page_none; hotkey.StateUIName = ""; edited_id = -1; } //Update cached hotkey name if window is just appearing or the name is empty if ( (m_PageAppearing == m_PageCurrent) || (hotkey.StateUIName.empty()) ) { hotkey.StateUIName = ""; if (hotkey.KeyCode != 0) { if (hotkey.Modifiers & MOD_CONTROL) hotkey.StateUIName += "Ctrl+"; if (hotkey.Modifiers & MOD_ALT) hotkey.StateUIName += "Alt+"; if (hotkey.Modifiers & MOD_SHIFT) hotkey.StateUIName += "Shift+"; if (hotkey.Modifiers & MOD_WIN) hotkey.StateUIName += "Win+"; } hotkey.StateUIName += (hotkey.KeyCode == 0) ? TranslationManager::GetString(tstr_DialogKeyCodePickerKeyCodeNone) : GetStringForKeyCode(hotkey.KeyCode); } ImGui::PushID("HotkeySelectable"); if (ImGui::Selectable(hotkey.StateUIName.c_str())) { m_KeyCodePickerNoMouse = false; m_KeyCodePickerHotkeyMode = true; m_KeyCodePickerHotkeyFlags = hotkey.Modifiers; m_KeyCodePickerID = hotkey.KeyCode; edited_id = id; PageGoForward(wndsettings_page_keycode_picker); m_PageReturned = wndsettings_page_none; } ImGui::PopID(); } void WindowSettings::RefreshAppList() { m_AppList.clear(); //Each section is sorted alphabetically before being appended to the app list (via Win32, so UTF-16 needed) struct app_sublist_entry { std::string app_key; std::string app_name_utf8; std::wstring app_name_utf16; }; std::vector app_sublist; auto app_sublist_compare = [](app_sublist_entry& a, app_sublist_entry& b) { return WStringCompareNatural(a.app_name_utf16, b.app_name_utf16); }; std::unordered_set unique_app_keys; char app_key_buffer[vr::k_unMaxApplicationKeyLength] = ""; char app_prop_buffer[vr::k_unMaxPropertyStringSize] = ""; vr::EVRApplicationError app_error = vr::VRApplicationError_None; //Have some keys in the unique app key set by default as a way to never show them in the actual list unique_app_keys.insert("steam.app.250820"); //"SteamVR" unique_app_keys.insert("openvr.tool.steamvr_tutorial"); unique_app_keys.insert("openvr.tool.steamvr_room_setup"); unique_app_keys.insert("openvr.tool.steamvr_environments_tools"); //Add active app first if (UIManager::Get()->IsOpenVRLoaded()) { app_error = vr::VRApplications()->GetApplicationKeyByProcessId(vr::VRApplications()->GetCurrentSceneProcessId(), app_key_buffer, vr::k_unMaxApplicationKeyLength); if (app_error == vr::VRApplicationError_None) { std::string app_key = app_key_buffer; std::string app_name = app_key; vr::VRApplications()->GetApplicationPropertyString(app_key_buffer, vr::VRApplicationProperty_Name_String, app_prop_buffer, vr::k_unMaxPropertyStringSize, &app_error); if (app_error == vr::VRApplicationError_None) { app_name = app_prop_buffer; } unique_app_keys.insert(app_key); m_AppList.emplace_back(app_key, app_name); } } //Add apps with profiles before listing all eligble apps for (const auto& app_key : ConfigManager::Get().GetAppProfileManager().GetProfileAppKeyList()) { std::string app_name; //Only add if not already in list if (unique_app_keys.find(app_key) == unique_app_keys.end()) { if (UIManager::Get()->IsOpenVRLoaded()) { vr::VRApplications()->GetApplicationPropertyString(app_key.c_str(), vr::VRApplicationProperty_Name_String, app_prop_buffer, vr::k_unMaxPropertyStringSize, &app_error); if (app_error == vr::VRApplicationError_None) { app_name = app_prop_buffer; } } //Fall back to last known application name if we can't get it from SteamVR if (app_name.empty()) { app_name = ConfigManager::Get().GetAppProfileManager().GetProfile(app_key).LastApplicationName; //If that's still empty for some reason (shouldn't happen), fall back to app key if (app_name.empty()) { app_name = app_key; } } unique_app_keys.insert(app_key); app_sublist.push_back( {app_key, app_name, WStringConvertFromUTF8(app_name.c_str())} ); } } //Sort this list before adding it to the rest std::sort(app_sublist.begin(), app_sublist.end(), app_sublist_compare); for (const auto& app : app_sublist) { m_AppList.emplace_back(app.app_key, app.app_name_utf8); } app_sublist.clear(); //List registered apps if (UIManager::Get()->IsOpenVRLoaded()) { uint32_t app_count = vr::VRApplications()->GetApplicationCount(); for (uint32_t i = 0; i < app_count; ++i) { app_error = vr::VRApplications()->GetApplicationKeyByIndex(i, app_key_buffer, vr::k_unMaxApplicationKeyLength); if (app_error == vr::VRApplicationError_None) { const bool is_installed = vr::VRApplications()->IsApplicationInstalled(app_key_buffer); const bool is_overlay = vr::VRApplications()->GetApplicationPropertyBool(app_key_buffer, vr::VRApplicationProperty_IsDashboardOverlay_Bool); const bool is_internal = vr::VRApplications()->GetApplicationPropertyBool(app_key_buffer, vr::VRApplicationProperty_IsInternal_Bool); //Application manifests and their properties aren't really documented but these two properties don't seem to matter for us //const bool is_template = vr::VRApplications()->GetApplicationPropertyBool(app_key_buffer, vr::VRApplicationProperty_IsTemplate_Bool); //const bool is_instanced = vr::VRApplications()->GetApplicationPropertyBool(app_key_buffer, vr::VRApplicationProperty_IsInstanced_Bool); if ( (is_installed) && (!is_overlay) && (!is_internal) ) { std::string app_key = app_key_buffer; std::string app_name = app_key; //Only add if not already in list if (unique_app_keys.find(app_key) == unique_app_keys.end()) { vr::VRApplications()->GetApplicationPropertyString(app_key_buffer, vr::VRApplicationProperty_Name_String, app_prop_buffer, vr::k_unMaxPropertyStringSize, &app_error); if (app_error == vr::VRApplicationError_None) { app_name = app_prop_buffer; } unique_app_keys.insert(app_key); app_sublist.push_back( {app_key, app_name, WStringConvertFromUTF8(app_name.c_str())} ); } } } } //Sort this list before adding it to the rest std::sort(app_sublist.begin(), app_sublist.end(), app_sublist_compare); for (const auto& app : app_sublist) { m_AppList.emplace_back(app.app_key, app.app_name_utf8); } } } ================================================ FILE: src/DesktopPlusUI/WindowSettings.h ================================================ #pragma once #include "FloatingWindow.h" #include "WindowDesktopMode.h" enum WindowSettingsPage { wndsettings_page_none, wndsettings_page_main, wndsettings_page_persistent_ui, wndsettings_page_keyboard, wndsettings_page_profiles, wndsettings_page_profiles_overlay_select, wndsettings_page_app_profiles, wndsettings_page_actions, wndsettings_page_actions_edit, wndsettings_page_actions_order, wndsettings_page_actions_order_add, wndsettings_page_color_picker, wndsettings_page_profile_picker, wndsettings_page_action_picker, wndsettings_page_keycode_picker, wndsettings_page_icon_picker, wndsettings_page_window_picker, wndsettings_page_reset_confirm }; class WindowSettings : public FloatingWindow, public FloatingWindowDesktopModeInterop { private: std::vector m_PageStack; std::vector m_PageStackPending; //Stores pending page forward calls that they were requested during an active backwards animation int m_PageStackPos; int m_PageStackPosAnimation; WindowSettingsPage m_PageAppearing; //Similar to ImGui::IsWindowAppearing(), equals the current page ID for a single frame if it or the window is newly appearing WindowSettingsPage m_PageReturned; //Equals the previous page ID after PageGoBack() was called, ideally cleared after making use of its value WindowSettingsPage m_PageCurrent; //Equals the current page ID during the function call int m_PageAnimationDir; float m_PageAnimationProgress; float m_PageAnimationStartPos; float m_PageAnimationOffset; float m_Column0Width; float m_WarningHeight; std::string m_WarningTextOverlayError; std::string m_WarningTextWinRTError; std::string m_WarningTextAppProfile; std::string m_TranslationAuthorLabel; std::string m_ActionButtonsDefaultLabel; std::string m_ActionButtonsOverlayBarLabel; std::vector m_ActionGlobalShortcutLabels; std::string m_BrowserMaxFPSValueText; std::string m_BrowserBlockListCountText; std::string m_ProfileSelectionName; bool m_ProfileOverlaySelectIsSaving; std::vector m_ProfileList; ActionUID m_ActionSelectionUID; std::vector m_ActionList; bool m_ActionOrderListEditForOverlayBar; std::string m_ProfilePickerName; ActionUID m_ActionPickerUID; unsigned char m_KeyCodePickerID; unsigned int m_KeyCodePickerHotkeyFlags; bool m_KeyCodePickerNoMouse; bool m_KeyCodePickerHotkeyMode; std::string m_IconPickerFile; HWND m_WindowPickerHWND; std::vector< std::pair > m_AppList; //app key, app name //Struct of cached sizes which may change at any time on translation or DPI switching (only the ones that aren't updated unconditionally) struct { ImVec2 Profiles_ButtonDeleteSize; ImVec2 Actions_ButtonDeleteSize; ImVec2 ActionEdit_ButtonDeleteSize; } m_CachedSizes; virtual void WindowUpdate(); void UpdateWarnings(); void UpdatePageMain(); void UpdatePageMainCatInterface(); void UpdatePageMainCatProfiles(); void UpdatePageMainCatActions(); void UpdatePageMainCatInput(); void UpdatePageMainCatWindows(); void UpdatePageMainCatBrowser(); void UpdatePageMainCatPerformance(); void UpdatePageMainCatMisc(); void UpdatePagePersistentUI(); void UpdatePageKeyboardLayout(bool only_restore_settings = false); void UpdatePageProfiles(); void UpdatePageProfilesOverlaySelect(); void UpdatePageAppProfiles(); void UpdatePageActions(); void UpdatePageActionsEdit(bool only_restore_settings = false); void UpdatePageActionsOrder(bool only_restore_settings = false); void UpdatePageActionsOrderAdd(); void UpdatePageColorPicker(bool only_restore_settings = false); void UpdatePageProfilePicker(); void UpdatePageActionPicker(); void UpdatePageKeyCodePicker(bool only_restore_settings = false); void UpdatePageIconPicker(); void UpdatePageWindowPicker(); void UpdatePageResetConfirm(); void PageGoForward(WindowSettingsPage new_page); void PageGoBack(); void PageGoBackInstantly(); void PageGoHome(); void OnPageLeaving(WindowSettingsPage previous_page); //Called from PageGoBack() and PageGoHome() to allow for page-specific cleanup if necessary void SelectableWarning(const char* selectable_id, const char* popup_id, const char* text, bool show_warning_prefix = true, const ImVec4* text_color = nullptr); void SelectableHotkey(ConfigHotkey& hotkey, int id); void RefreshAppList(); public: WindowSettings(); virtual void Hide(bool skip_fade = false); virtual void ResetTransform(FloatingWindowOverlayStateID state_id); virtual vr::VROverlayHandle_t GetOverlayHandle() const; virtual void ApplyUIScale(); void UpdateDesktopMode(); void UpdateDesktopModeWarnings(); void DesktopModeSetRootPage(WindowSettingsPage root_page); virtual const char* DesktopModeGetTitle() const; virtual bool DesktopModeGetIconTextureInfo(ImVec2& size, ImVec2& uv_min, ImVec2& uv_max) const; virtual bool DesktopModeGoBack(); float DesktopModeGetWarningHeight() const; void QuickStartGuideGoToPage(WindowSettingsPage new_page); void ClearCachedTranslationStrings(); }; ================================================ FILE: src/DesktopPlusUI/imgui/imconfig.h ================================================ //----------------------------------------------------------------------------- // DEAR IMGUI COMPILE-TIME OPTIONS // Runtime options (clipboard callbacks, enabling various features, etc.) can generally be set via the ImGuiIO structure. // You can use ImGui::SetAllocatorFunctions() before calling ImGui::CreateContext() to rewire memory allocation functions. //----------------------------------------------------------------------------- // A) You may edit imconfig.h (and not overwrite it when updating Dear ImGui, or maintain a patch/rebased branch with your modifications to it) // B) or '#define IMGUI_USER_CONFIG "my_imgui_config.h"' in your project and then add directives in your own file without touching this template. //----------------------------------------------------------------------------- // You need to make sure that configuration settings are defined consistently _everywhere_ Dear ImGui is used, which include the imgui*.cpp // files but also _any_ of your code that uses Dear ImGui. This is because some compile-time options have an affect on data structures. // Defining those options in imconfig.h will ensure every compilation unit gets to see the same data structure layouts. // Call IMGUI_CHECKVERSION() from your .cpp file to verify that the data structures your files are using are matching the ones imgui.cpp is using. //----------------------------------------------------------------------------- #pragma once //---- Define assertion handler. Defaults to calling assert(). // If your macro uses multiple statements, make sure is enclosed in a 'do { .. } while (0)' block so it can be used as a single statement. //#define IM_ASSERT(_EXPR) MyAssert(_EXPR) //#define IM_ASSERT(_EXPR) ((void)(_EXPR)) // Disable asserts //---- Define attributes of all API symbols declarations, e.g. for DLL under Windows // Using Dear ImGui via a shared library is not recommended, because of function call overhead and because we don't guarantee backward nor forward ABI compatibility. // - Windows DLL users: heaps and globals are not shared across DLL boundaries! You will need to call SetCurrentContext() + SetAllocatorFunctions() // for each static/DLL boundary you are calling from. Read "Context and Memory Allocators" section of imgui.cpp for more details. //#define IMGUI_API __declspec(dllexport) // MSVC Windows: DLL export //#define IMGUI_API __declspec(dllimport) // MSVC Windows: DLL import //#define IMGUI_API __attribute__((visibility("default"))) // GCC/Clang: override visibility when set is hidden //---- Don't define obsolete functions/enums/behaviors. Consider enabling from time to time after updating to clean your code of obsolete function/names. #define IMGUI_DISABLE_OBSOLETE_FUNCTIONS //---- Disable all of Dear ImGui or don't implement standard windows/tools. // It is very strongly recommended to NOT disable the demo windows and debug tool during development. They are extremely useful in day to day work. Please read comments in imgui_demo.cpp. //#define IMGUI_DISABLE // Disable everything: all headers and source files will be empty. #ifndef _DEBUG #define IMGUI_DISABLE_DEMO_WINDOWS // Disable demo windows: ShowDemoWindow()/ShowStyleEditor() will be empty. #define IMGUI_DISABLE_DEBUG_TOOLS // Disable metrics/debugger and other debug tools: ShowMetricsWindow(), ShowDebugLogWindow() and ShowIDStackToolWindow() will be empty. #endif //---- Don't implement some functions to reduce linkage requirements. //#define IMGUI_DISABLE_WIN32_DEFAULT_CLIPBOARD_FUNCTIONS // [Win32] Don't implement default clipboard handler. Won't use and link with OpenClipboard/GetClipboardData/CloseClipboard etc. (user32.lib/.a, kernel32.lib/.a) //#define IMGUI_ENABLE_WIN32_DEFAULT_IME_FUNCTIONS // [Win32] [Default with Visual Studio] Implement default IME handler (require imm32.lib/.a, auto-link for Visual Studio, -limm32 on command-line for MinGW) //#define IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCTIONS // [Win32] [Default with non-Visual Studio compilers] Don't implement default IME handler (won't require imm32.lib/.a) //#define IMGUI_DISABLE_WIN32_FUNCTIONS // [Win32] Won't use and link with any Win32 function (clipboard, IME). //#define IMGUI_ENABLE_OSX_DEFAULT_CLIPBOARD_FUNCTIONS // [OSX] Implement default OSX clipboard handler (need to link with '-framework ApplicationServices', this is why this is not the default). //#define IMGUI_DISABLE_DEFAULT_SHELL_FUNCTIONS // Don't implement default platform_io.Platform_OpenInShellFn() handler (Win32: ShellExecute(), require shell32.lib/.a, Mac/Linux: use system("")). //#define IMGUI_DISABLE_DEFAULT_FORMAT_FUNCTIONS // Don't implement ImFormatString/ImFormatStringV so you can implement them yourself (e.g. if you don't want to link with vsnprintf) //#define IMGUI_DISABLE_DEFAULT_MATH_FUNCTIONS // Don't implement ImFabs/ImSqrt/ImPow/ImFmod/ImCos/ImSin/ImAcos/ImAtan2 so you can implement them yourself. //#define IMGUI_DISABLE_FILE_FUNCTIONS // Don't implement ImFileOpen/ImFileClose/ImFileRead/ImFileWrite and ImFileHandle at all (replace them with dummies) //#define IMGUI_DISABLE_DEFAULT_FILE_FUNCTIONS // Don't implement ImFileOpen/ImFileClose/ImFileRead/ImFileWrite and ImFileHandle so you can implement them yourself if you don't want to link with fopen/fclose/fread/fwrite. This will also disable the LogToTTY() function. //#define IMGUI_DISABLE_DEFAULT_ALLOCATORS // Don't implement default allocators calling malloc()/free() to avoid linking with them. You will need to call ImGui::SetAllocatorFunctions(). //#define IMGUI_DISABLE_DEFAULT_FONT // Disable default embedded font (ProggyClean.ttf), remove ~9.5 KB from output binary. AddFontDefault() will assert. //#define IMGUI_DISABLE_SSE // Disable use of SSE intrinsics even if available //---- Enable Test Engine / Automation features. //#define IMGUI_ENABLE_TEST_ENGINE // Enable imgui_test_engine hooks. Generally set automatically by include "imgui_te_config.h", see Test Engine for details. //---- Include imgui_user.h at the end of imgui.h as a convenience // May be convenient for some users to only explicitly include vanilla imgui.h and have extra stuff included. //#define IMGUI_INCLUDE_IMGUI_USER_H //#define IMGUI_USER_H_FILENAME "my_folder/my_imgui_user.h" //---- Pack vertex colors as BGRA8 instead of RGBA8 (to avoid converting from one to another). Need dedicated backend support. //#define IMGUI_USE_BGRA_PACKED_COLOR //---- Use legacy CRC32-adler tables (used before 1.91.6), in order to preserve old .ini data that you cannot afford to invalidate. //#define IMGUI_USE_LEGACY_CRC32_ADLER //---- Use 32-bit for ImWchar (default is 16-bit) to support Unicode planes 1-16. (e.g. point beyond 0xFFFF like emoticons, dingbats, symbols, shapes, ancient languages, etc...) #define IMGUI_USE_WCHAR32 //---- Avoid multiple STB libraries implementations, or redefine path/filenames to prioritize another version // By default the embedded implementations are declared static and not available outside of Dear ImGui sources files. //#define IMGUI_STB_TRUETYPE_FILENAME "my_folder/stb_truetype.h" //#define IMGUI_STB_RECT_PACK_FILENAME "my_folder/stb_rect_pack.h" //#define IMGUI_STB_SPRINTF_FILENAME "my_folder/stb_sprintf.h" // only used if IMGUI_USE_STB_SPRINTF is defined. //#define IMGUI_DISABLE_STB_TRUETYPE_IMPLEMENTATION //#define IMGUI_DISABLE_STB_RECT_PACK_IMPLEMENTATION //#define IMGUI_DISABLE_STB_SPRINTF_IMPLEMENTATION // only disabled if IMGUI_USE_STB_SPRINTF is defined. //---- Use stb_sprintf.h for a faster implementation of vsnprintf instead of the one from libc (unless IMGUI_DISABLE_DEFAULT_FORMAT_FUNCTIONS is defined) // Compatibility checks of arguments and formats done by clang and GCC will be disabled in order to support the extra formats provided by stb_sprintf.h. //#define IMGUI_USE_STB_SPRINTF //---- Use FreeType to build and rasterize the font atlas (instead of stb_truetype which is embedded by default in Dear ImGui) // Requires FreeType headers to be available in the include path. Requires program to be compiled with 'misc/freetype/imgui_freetype.cpp' (in this repository) + the FreeType library (not provided). // On Windows you may use vcpkg with 'vcpkg install freetype --triplet=x64-windows' + 'vcpkg integrate install'. //#define IMGUI_ENABLE_FREETYPE //---- Use FreeType + plutosvg or lunasvg to render OpenType SVG fonts (SVGinOT) // Only works in combination with IMGUI_ENABLE_FREETYPE. // - plutosvg is currently easier to install, as e.g. it is part of vcpkg. It will support more fonts and may load them faster. See misc/freetype/README for instructions. // - Both require headers to be available in the include path + program to be linked with the library code (not provided). // - (note: lunasvg implementation is based on Freetype's rsvg-port.c which is licensed under CeCILL-C Free Software License Agreement) //#define IMGUI_ENABLE_FREETYPE_PLUTOSVG //#define IMGUI_ENABLE_FREETYPE_LUNASVG //---- Use stb_truetype to build and rasterize the font atlas (default) // The only purpose of this define is if you want force compilation of the stb_truetype backend ALONG with the FreeType backend. //#define IMGUI_ENABLE_STB_TRUETYPE //---- Define constructor and implicit cast operators to convert back<>forth between your math types and ImVec2/ImVec4. // This will be inlined as part of ImVec2 and ImVec4 class declarations. /* #define IM_VEC2_CLASS_EXTRA \ constexpr ImVec2(const MyVec2& f) : x(f.x), y(f.y) {} \ operator MyVec2() const { return MyVec2(x,y); } #define IM_VEC4_CLASS_EXTRA \ constexpr ImVec4(const MyVec4& f) : x(f.x), y(f.y), z(f.z), w(f.w) {} \ operator MyVec4() const { return MyVec4(x,y,z,w); } */ //---- ...Or use Dear ImGui's own very basic math operators. #define IMGUI_DEFINE_MATH_OPERATORS //---- Use 32-bit vertex indices (default is 16-bit) is one way to allow large meshes with more than 64K vertices. // Your renderer backend will need to support it (most example renderer backends support both 16/32-bit indices). // Another way to allow large meshes while keeping 16-bit indices is to handle ImDrawCmd::VtxOffset in your renderer. // Read about ImGuiBackendFlags_RendererHasVtxOffset for details. //#define ImDrawIdx unsigned int //---- Override ImDrawCallback signature (will need to modify renderer backends accordingly) //struct ImDrawList; //struct ImDrawCmd; //typedef void (*MyImDrawCallback)(const ImDrawList* draw_list, const ImDrawCmd* cmd, void* my_renderer_user_data); //#define ImDrawCallback MyImDrawCallback //---- Debug Tools: Macro to break in Debugger (we provide a default implementation of this in the codebase) // (use 'Metrics->Tools->Item Picker' to pick widgets with the mouse and break into them for easy debugging.) //#define IM_DEBUG_BREAK IM_ASSERT(0) //#define IM_DEBUG_BREAK __debugbreak() //---- Debug Tools: Enable slower asserts //#define IMGUI_DEBUG_PARANOID //---- Disable gamepad support. This was meaningful before <1.81 but we now load XInput dynamically so the option is now less relevant. #define IMGUI_IMPL_WIN32_DISABLE_GAMEPAD //---- Tip: You can add extra functions within the ImGui:: namespace from anywhere (e.g. your own sources/header files) /* namespace ImGui { void MyFunction(const char* name, MyMatrix44* mtx); } */ ================================================ FILE: src/DesktopPlusUI/imgui/imgui.cpp ================================================ // dear imgui, v1.91.9b // (main code and documentation) // Help: // - See links below. // - Call and read ImGui::ShowDemoWindow() in imgui_demo.cpp. All applications in examples/ are doing that. // - Read top of imgui.cpp for more details, links and comments. // Resources: // - FAQ ........................ https://dearimgui.com/faq (in repository as docs/FAQ.md) // - Homepage ................... https://github.com/ocornut/imgui // - Releases & changelog ....... https://github.com/ocornut/imgui/releases // - Gallery .................... https://github.com/ocornut/imgui/issues?q=label%3Agallery (please post your screenshots/video there!) // - Wiki ....................... https://github.com/ocornut/imgui/wiki (lots of good stuff there) // - Getting Started https://github.com/ocornut/imgui/wiki/Getting-Started (how to integrate in an existing app by adding ~25 lines of code) // - Third-party Extensions https://github.com/ocornut/imgui/wiki/Useful-Extensions (ImPlot & many more) // - Bindings/Backends https://github.com/ocornut/imgui/wiki/Bindings (language bindings, backends for various tech/engines) // - Glossary https://github.com/ocornut/imgui/wiki/Glossary // - Debug Tools https://github.com/ocornut/imgui/wiki/Debug-Tools // - Software using Dear ImGui https://github.com/ocornut/imgui/wiki/Software-using-dear-imgui // - Issues & support ........... https://github.com/ocornut/imgui/issues // - Test Engine & Automation ... https://github.com/ocornut/imgui_test_engine (test suite, test engine to automate your apps) // For first-time users having issues compiling/linking/running/loading fonts: // please post in https://github.com/ocornut/imgui/discussions if you cannot find a solution in resources above. // Everything else should be asked in 'Issues'! We are building a database of cross-linked knowledge there. // Copyright (c) 2014-2025 Omar Cornut // Developed by Omar Cornut and every direct or indirect contributors to the GitHub. // See LICENSE.txt for copyright and licensing details (standard MIT License). // This library is free but needs your support to sustain development and maintenance. // Businesses: you can support continued development via B2B invoiced technical support, maintenance and sponsoring contracts. // PLEASE reach out at omar AT dearimgui DOT com. See https://github.com/ocornut/imgui/wiki/Funding // Businesses: you can also purchase licenses for the Dear ImGui Automation/Test Engine. // It is recommended that you don't modify imgui.cpp! It will become difficult for you to update the library. // Note that 'ImGui::' being a namespace, you can add functions into the namespace from your own source files, without // modifying imgui.h or imgui.cpp. You may include imgui_internal.h to access internal data structures, but it doesn't // come with any guarantee of forward compatibility. Discussing your changes on the GitHub Issue Tracker may lead you // to a better solution or official support for them. /* Index of this file: DOCUMENTATION - MISSION STATEMENT - CONTROLS GUIDE - PROGRAMMER GUIDE - READ FIRST - HOW TO UPDATE TO A NEWER VERSION OF DEAR IMGUI - GETTING STARTED WITH INTEGRATING DEAR IMGUI IN YOUR CODE/ENGINE - HOW A SIMPLE APPLICATION MAY LOOK LIKE - HOW A SIMPLE RENDERING FUNCTION MAY LOOK LIKE - API BREAKING CHANGES (read me when you update!) - FREQUENTLY ASKED QUESTIONS (FAQ) - Read all answers online: https://www.dearimgui.com/faq, or in docs/FAQ.md (with a Markdown viewer) CODE (search for "[SECTION]" in the code to find them) // [SECTION] INCLUDES // [SECTION] FORWARD DECLARATIONS // [SECTION] CONTEXT AND MEMORY ALLOCATORS // [SECTION] USER FACING STRUCTURES (ImGuiStyle, ImGuiIO, ImGuiPlatformIO) // [SECTION] MISC HELPERS/UTILITIES (Geometry functions) // [SECTION] MISC HELPERS/UTILITIES (String, Format, Hash functions) // [SECTION] MISC HELPERS/UTILITIES (File functions) // [SECTION] MISC HELPERS/UTILITIES (ImText* functions) // [SECTION] MISC HELPERS/UTILITIES (Color functions) // [SECTION] ImGuiStorage // [SECTION] ImGuiTextFilter // [SECTION] ImGuiTextBuffer, ImGuiTextIndex // [SECTION] ImGuiListClipper // [SECTION] STYLING // [SECTION] RENDER HELPERS // [SECTION] INITIALIZATION, SHUTDOWN // [SECTION] MAIN CODE (most of the code! lots of stuff, needs tidying up!) // [SECTION] ID STACK // [SECTION] INPUTS // [SECTION] ERROR CHECKING, STATE RECOVERY // [SECTION] ITEM SUBMISSION // [SECTION] LAYOUT // [SECTION] SCROLLING // [SECTION] TOOLTIPS // [SECTION] POPUPS // [SECTION] WINDOW FOCUS // [SECTION] KEYBOARD/GAMEPAD NAVIGATION // [SECTION] DRAG AND DROP // [SECTION] LOGGING/CAPTURING // [SECTION] SETTINGS // [SECTION] LOCALIZATION // [SECTION] VIEWPORTS, PLATFORM WINDOWS // [SECTION] PLATFORM DEPENDENT HELPERS // [SECTION] METRICS/DEBUGGER WINDOW // [SECTION] DEBUG LOG WINDOW // [SECTION] OTHER DEBUG TOOLS (ITEM PICKER, ID STACK TOOL) */ //----------------------------------------------------------------------------- // DOCUMENTATION //----------------------------------------------------------------------------- /* MISSION STATEMENT ================= - Easy to use to create code-driven and data-driven tools. - Easy to use to create ad hoc short-lived tools and long-lived, more elaborate tools. - Easy to hack and improve. - Minimize setup and maintenance. - Minimize state storage on user side. - Minimize state synchronization. - Portable, minimize dependencies, run on target (consoles, phones, etc.). - Efficient runtime and memory consumption. Designed primarily for developers and content-creators, not the typical end-user! Some of the current weaknesses (which we aim to address in the future) includes: - Doesn't look fancy. - Limited layout features, intricate layouts are typically crafted in code. CONTROLS GUIDE ============== - MOUSE CONTROLS - Mouse wheel: Scroll vertically. - SHIFT+Mouse wheel: Scroll horizontally. - Click [X]: Close a window, available when 'bool* p_open' is passed to ImGui::Begin(). - Click ^, Double-Click title: Collapse window. - Drag on corner/border: Resize window (double-click to auto fit window to its contents). - Drag on any empty space: Move window (unless io.ConfigWindowsMoveFromTitleBarOnly = true). - Left-click outside popup: Close popup stack (right-click over underlying popup: Partially close popup stack). - TEXT EDITOR - Hold SHIFT or Drag Mouse: Select text. - CTRL+Left/Right: Word jump. - CTRL+Shift+Left/Right: Select words. - CTRL+A or Double-Click: Select All. - CTRL+X, CTRL+C, CTRL+V: Use OS clipboard. - CTRL+Z Undo. - CTRL+Y or CTRL+Shift+Z: Redo. - ESCAPE: Revert text to its original value. - On OSX, controls are automatically adjusted to match standard OSX text editing 2ts and behaviors. - KEYBOARD CONTROLS - Basic: - Tab, SHIFT+Tab Cycle through text editable fields. - CTRL+Tab, CTRL+Shift+Tab Cycle through windows. - CTRL+Click Input text into a Slider or Drag widget. - Extended features with `io.ConfigFlags |= ImGuiConfigFlags_NavEnableKeyboard`: - Tab, SHIFT+Tab: Cycle through every items. - Arrow keys Move through items using directional navigation. Tweak value. - Arrow keys + Alt, Shift Tweak slower, tweak faster (when using arrow keys). - Enter Activate item (prefer text input when possible). - Space Activate item (prefer tweaking with arrows when possible). - Escape Deactivate item, leave child window, close popup. - Page Up, Page Down Previous page, next page. - Home, End Scroll to top, scroll to bottom. - Alt Toggle between scrolling layer and menu layer. - CTRL+Tab then Ctrl+Arrows Move window. Hold SHIFT to resize instead of moving. - Output when ImGuiConfigFlags_NavEnableKeyboard set, - io.WantCaptureKeyboard flag is set when keyboard is claimed. - io.NavActive: true when a window is focused and it doesn't have the ImGuiWindowFlags_NoNavInputs flag set. - io.NavVisible: true when the navigation cursor is visible (usually goes to back false when mouse is used). - GAMEPAD CONTROLS - Enable with 'io.ConfigFlags |= ImGuiConfigFlags_NavEnableGamepad'. - Particularly useful to use Dear ImGui on a console system (e.g. PlayStation, Switch, Xbox) without a mouse! - Download controller mapping PNG/PSD at http://dearimgui.com/controls_sheets - Backend support: backend needs to: - Set 'io.BackendFlags |= ImGuiBackendFlags_HasGamepad' + call io.AddKeyEvent/AddKeyAnalogEvent() with ImGuiKey_Gamepad_XXX keys. - For analog values (0.0f to 1.0f), backend is responsible to handling a dead-zone and rescaling inputs accordingly. Backend code will probably need to transform your raw inputs (such as e.g. remapping your 0.2..0.9 raw input range to 0.0..1.0 imgui range, etc.). - If you need to share inputs between your game and the Dear ImGui interface, the easiest approach is to go all-or-nothing, with a buttons combo to toggle the target. Please reach out if you think the game vs navigation input sharing could be improved. - REMOTE INPUTS SHARING & MOUSE EMULATION - PS4/PS5 users: Consider emulating a mouse cursor with DualShock touch pad or a spare analog stick as a mouse-emulation fallback. - Consoles/Tablet/Phone users: Consider using a Synergy 1.x server (on your PC) + run examples/libs/synergy/uSynergy.c (on your console/tablet/phone app) in order to share your PC mouse/keyboard. - See https://github.com/ocornut/imgui/wiki/Useful-Extensions#remoting for other remoting solutions. - On a TV/console system where readability may be lower or mouse inputs may be awkward, you may want to set the io.ConfigNavMoveSetMousePos flag. Enabling io.ConfigNavMoveSetMousePos + ImGuiBackendFlags_HasSetMousePos instructs Dear ImGui to move your mouse cursor along with navigation movements. When enabled, the NewFrame() function may alter 'io.MousePos' and set 'io.WantSetMousePos' to notify you that it wants the mouse cursor to be moved. When that happens your backend NEEDS to move the OS or underlying mouse cursor on the next frame. Some of the backends in examples/ do that. (If you set the NavEnableSetMousePos flag but don't honor 'io.WantSetMousePos' properly, Dear ImGui will misbehave as it will see your mouse moving back & forth!) (In a setup when you may not have easy control over the mouse cursor, e.g. uSynergy.c doesn't expose moving remote mouse cursor, you may want to set a boolean to ignore your other external mouse positions until the external source is moved again.) PROGRAMMER GUIDE ================ READ FIRST ---------- - Remember to check the wonderful Wiki (https://github.com/ocornut/imgui/wiki) - Your code creates the UI every frame of your application loop, if your code doesn't run the UI is gone! The UI can be highly dynamic, there are no construction or destruction steps, less superfluous data retention on your side, less state duplication, less state synchronization, fewer bugs. - Call and read ImGui::ShowDemoWindow() for demo code demonstrating most features. Or browse https://pthom.github.io/imgui_manual_online/manual/imgui_manual.html for interactive web version. - The library is designed to be built from sources. Avoid pre-compiled binaries and packaged versions. See imconfig.h to configure your build. - Dear ImGui is an implementation of the IMGUI paradigm (immediate-mode graphical user interface, a term coined by Casey Muratori). You can learn about IMGUI principles at http://www.johno.se/book/imgui.html, http://mollyrocket.com/861 & more links in Wiki. - Dear ImGui is a "single pass" rasterizing implementation of the IMGUI paradigm, aimed at ease of use and high-performances. For every application frame, your UI code will be called only once. This is in contrast to e.g. Unity's implementation of an IMGUI, where the UI code is called multiple times ("multiple passes") from a single entry point. There are pros and cons to both approaches. - Our origin is on the top-left. In axis aligned bounding boxes, Min = top-left, Max = bottom-right. - Please make sure you have asserts enabled (IM_ASSERT redirects to assert() by default, but can be redirected). If you get an assert, read the messages and comments around the assert. - This codebase aims to be highly optimized: - A typical idle frame should never call malloc/free. - We rely on a maximum of constant-time or O(N) algorithms. Limiting searches/scans as much as possible. - We put particular energy in making sure performances are decent with typical "Debug" build settings as well. Which mean we tend to avoid over-relying on "zero-cost abstraction" as they aren't zero-cost at all. - This codebase aims to be both highly opinionated and highly flexible: - This code works because of the things it choose to solve or not solve. - C++: this is a pragmatic C-ish codebase: we don't use fancy C++ features, we don't include C++ headers, and ImGui:: is a namespace. We rarely use member functions (and when we did, I am mostly regretting it now). This is to increase compatibility, increase maintainability and facilitate use from other languages. - C++: ImVec2/ImVec4 do not expose math operators by default, because it is expected that you use your own math types. See FAQ "How can I use my own math types instead of ImVec2/ImVec4?" for details about setting up imconfig.h for that. We can can optionally export math operators for ImVec2/ImVec4 using IMGUI_DEFINE_MATH_OPERATORS, which we use internally. - C++: pay attention that ImVector<> manipulates plain-old-data and does not honor construction/destruction (so don't use ImVector in your code or at our own risk!). - Building: We don't use nor mandate a build system for the main library. This is in an effort to ensure that it works in the real world aka with any esoteric build setup. This is also because providing a build system for the main library would be of little-value. The build problems are almost never coming from the main library but from specific backends. HOW TO UPDATE TO A NEWER VERSION OF DEAR IMGUI ---------------------------------------------- - Update submodule or copy/overwrite every file. - About imconfig.h: - You may modify your copy of imconfig.h, in this case don't overwrite it. - or you may locally branch to modify imconfig.h and merge/rebase latest. - or you may '#define IMGUI_USER_CONFIG "my_config_file.h"' globally from your build system to specify a custom path for your imconfig.h file and instead not have to modify the default one. - Overwrite all the sources files except for imconfig.h (if you have modified your copy of imconfig.h) - Or maintain your own branch where you have imconfig.h modified as a top-most commit which you can regularly rebase over "master". - You can also use '#define IMGUI_USER_CONFIG "my_config_file.h" to redirect configuration to your own file. - Read the "API BREAKING CHANGES" section (below). This is where we list occasional API breaking changes. If a function/type has been renamed / or marked obsolete, try to fix the name in your code before it is permanently removed from the public API. If you have a problem with a missing function/symbols, search for its name in the code, there will likely be a comment about it. Please report any issue to the GitHub page! - To find out usage of old API, you can add '#define IMGUI_DISABLE_OBSOLETE_FUNCTIONS' in your configuration file. - Try to keep your copy of Dear ImGui reasonably up to date! GETTING STARTED WITH INTEGRATING DEAR IMGUI IN YOUR CODE/ENGINE --------------------------------------------------------------- - See https://github.com/ocornut/imgui/wiki/Getting-Started. - Run and study the examples and demo in imgui_demo.cpp to get acquainted with the library. - In the majority of cases you should be able to use unmodified backends files available in the backends/ folder. - Add the Dear ImGui source files + selected backend source files to your projects or using your preferred build system. It is recommended you build and statically link the .cpp files as part of your project and NOT as a shared library (DLL). - You can later customize the imconfig.h file to tweak some compile-time behavior, such as integrating Dear ImGui types with your own maths types. - When using Dear ImGui, your programming IDE is your friend: follow the declaration of variables, functions and types to find comments about them. - Dear ImGui never touches or knows about your GPU state. The only function that knows about GPU is the draw function that you provide. Effectively it means you can create widgets at any time in your code, regardless of considerations of being in "update" vs "render" phases of your own application. All rendering information is stored into command-lists that you will retrieve after calling ImGui::Render(). - Refer to the backends and demo applications in the examples/ folder for instruction on how to setup your code. - If you are running over a standard OS with a common graphics API, you should be able to use unmodified imgui_impl_*** files from the examples/ folder. HOW A SIMPLE APPLICATION MAY LOOK LIKE -------------------------------------- EXHIBIT 1: USING THE EXAMPLE BACKENDS (= imgui_impl_XXX.cpp files from the backends/ folder). The sub-folders in examples/ contain examples applications following this structure. // Application init: create a dear imgui context, setup some options, load fonts ImGui::CreateContext(); ImGuiIO& io = ImGui::GetIO(); // TODO: Set optional io.ConfigFlags values, e.g. 'io.ConfigFlags |= ImGuiConfigFlags_NavEnableKeyboard' to enable keyboard controls. // TODO: Fill optional fields of the io structure later. // TODO: Load TTF/OTF fonts if you don't want to use the default font. // Initialize helper Platform and Renderer backends (here we are using imgui_impl_win32.cpp and imgui_impl_dx11.cpp) ImGui_ImplWin32_Init(hwnd); ImGui_ImplDX11_Init(g_pd3dDevice, g_pd3dDeviceContext); // Application main loop while (true) { // Feed inputs to dear imgui, start new frame ImGui_ImplDX11_NewFrame(); ImGui_ImplWin32_NewFrame(); ImGui::NewFrame(); // Any application code here ImGui::Text("Hello, world!"); // Render dear imgui into screen ImGui::Render(); ImGui_ImplDX11_RenderDrawData(ImGui::GetDrawData()); g_pSwapChain->Present(1, 0); } // Shutdown ImGui_ImplDX11_Shutdown(); ImGui_ImplWin32_Shutdown(); ImGui::DestroyContext(); EXHIBIT 2: IMPLEMENTING CUSTOM BACKEND / CUSTOM ENGINE // Application init: create a dear imgui context, setup some options, load fonts ImGui::CreateContext(); ImGuiIO& io = ImGui::GetIO(); // TODO: Set optional io.ConfigFlags values, e.g. 'io.ConfigFlags |= ImGuiConfigFlags_NavEnableKeyboard' to enable keyboard controls. // TODO: Fill optional fields of the io structure later. // TODO: Load TTF/OTF fonts if you don't want to use the default font. // Build and load the texture atlas into a texture // (In the examples/ app this is usually done within the ImGui_ImplXXX_Init() function from one of the demo Renderer) int width, height; unsigned char* pixels = nullptr; io.Fonts->GetTexDataAsRGBA32(&pixels, &width, &height); // At this point you've got the texture data and you need to upload that to your graphic system: // After we have created the texture, store its pointer/identifier (_in whichever format your engine uses_) in 'io.Fonts->TexID'. // This will be passed back to your via the renderer. Basically ImTextureID == void*. Read FAQ for details about ImTextureID. MyTexture* texture = MyEngine::CreateTextureFromMemoryPixels(pixels, width, height, TEXTURE_TYPE_RGBA32) io.Fonts->SetTexID((void*)texture); // Application main loop while (true) { // Setup low-level inputs, e.g. on Win32: calling GetKeyboardState(), or write to those fields from your Windows message handlers, etc. // (In the examples/ app this is usually done within the ImGui_ImplXXX_NewFrame() function from one of the demo Platform Backends) io.DeltaTime = 1.0f/60.0f; // set the time elapsed since the previous frame (in seconds) io.DisplaySize.x = 1920.0f; // set the current display width io.DisplaySize.y = 1280.0f; // set the current display height here io.AddMousePosEvent(mouse_x, mouse_y); // update mouse position io.AddMouseButtonEvent(0, mouse_b[0]); // update mouse button states io.AddMouseButtonEvent(1, mouse_b[1]); // update mouse button states // Call NewFrame(), after this point you can use ImGui::* functions anytime // (So you want to try calling NewFrame() as early as you can in your main loop to be able to use Dear ImGui everywhere) ImGui::NewFrame(); // Most of your application code here ImGui::Text("Hello, world!"); MyGameUpdate(); // may use any Dear ImGui functions, e.g. ImGui::Begin("My window"); ImGui::Text("Hello, world!"); ImGui::End(); MyGameRender(); // may use any Dear ImGui functions as well! // Render dear imgui, swap buffers // (You want to try calling EndFrame/Render as late as you can, to be able to use Dear ImGui in your own game rendering code) ImGui::EndFrame(); ImGui::Render(); ImDrawData* draw_data = ImGui::GetDrawData(); MyImGuiRenderFunction(draw_data); SwapBuffers(); } // Shutdown ImGui::DestroyContext(); To decide whether to dispatch mouse/keyboard inputs to Dear ImGui to the rest of your application, you should read the 'io.WantCaptureMouse', 'io.WantCaptureKeyboard' and 'io.WantTextInput' flags! Please read the FAQ entry "How can I tell whether to dispatch mouse/keyboard to Dear ImGui or my application?" about this. HOW A SIMPLE RENDERING FUNCTION MAY LOOK LIKE --------------------------------------------- The backends in impl_impl_XXX.cpp files contain many working implementations of a rendering function. void MyImGuiRenderFunction(ImDrawData* draw_data) { // TODO: Setup render state: alpha-blending enabled, no face culling, no depth testing, scissor enabled // TODO: Setup texture sampling state: sample with bilinear filtering (NOT point/nearest filtering). Use 'io.Fonts->Flags |= ImFontAtlasFlags_NoBakedLines;' to allow point/nearest filtering. // TODO: Setup viewport covering draw_data->DisplayPos to draw_data->DisplayPos + draw_data->DisplaySize // TODO: Setup orthographic projection matrix cover draw_data->DisplayPos to draw_data->DisplayPos + draw_data->DisplaySize // TODO: Setup shader: vertex { float2 pos, float2 uv, u32 color }, fragment shader sample color from 1 texture, multiply by vertex color. ImVec2 clip_off = draw_data->DisplayPos; for (int n = 0; n < draw_data->CmdListsCount; n++) { const ImDrawList* cmd_list = draw_data->CmdLists[n]; const ImDrawVert* vtx_buffer = cmd_list->VtxBuffer.Data; // vertex buffer generated by Dear ImGui const ImDrawIdx* idx_buffer = cmd_list->IdxBuffer.Data; // index buffer generated by Dear ImGui for (int cmd_i = 0; cmd_i < cmd_list->CmdBuffer.Size; cmd_i++) { const ImDrawCmd* pcmd = &cmd_list->CmdBuffer[cmd_i]; if (pcmd->UserCallback) { pcmd->UserCallback(cmd_list, pcmd); } else { // Project scissor/clipping rectangles into framebuffer space ImVec2 clip_min(pcmd->ClipRect.x - clip_off.x, pcmd->ClipRect.y - clip_off.y); ImVec2 clip_max(pcmd->ClipRect.z - clip_off.x, pcmd->ClipRect.w - clip_off.y); if (clip_max.x <= clip_min.x || clip_max.y <= clip_min.y) continue; // We are using scissoring to clip some objects. All low-level graphics API should support it. // - If your engine doesn't support scissoring yet, you may ignore this at first. You will get some small glitches // (some elements visible outside their bounds) but you can fix that once everything else works! // - Clipping coordinates are provided in imgui coordinates space: // - For a given viewport, draw_data->DisplayPos == viewport->Pos and draw_data->DisplaySize == viewport->Size // - In a single viewport application, draw_data->DisplayPos == (0,0) and draw_data->DisplaySize == io.DisplaySize, but always use GetMainViewport()->Pos/Size instead of hardcoding those values. // - In the interest of supporting multi-viewport applications (see 'docking' branch on github), // always subtract draw_data->DisplayPos from clipping bounds to convert them to your viewport space. // - Note that pcmd->ClipRect contains Min+Max bounds. Some graphics API may use Min+Max, other may use Min+Size (size being Max-Min) MyEngineSetScissor(clip_min.x, clip_min.y, clip_max.x, clip_max.y); // The texture for the draw call is specified by pcmd->GetTexID(). // The vast majority of draw calls will use the Dear ImGui texture atlas, which value you have set yourself during initialization. MyEngineBindTexture((MyTexture*)pcmd->GetTexID()); // Render 'pcmd->ElemCount/3' indexed triangles. // By default the indices ImDrawIdx are 16-bit, you can change them to 32-bit in imconfig.h if your engine doesn't support 16-bit indices. MyEngineDrawIndexedTriangles(pcmd->ElemCount, sizeof(ImDrawIdx) == 2 ? GL_UNSIGNED_SHORT : GL_UNSIGNED_INT, idx_buffer + pcmd->IdxOffset, vtx_buffer, pcmd->VtxOffset); } } } } API BREAKING CHANGES ==================== Occasionally introducing changes that are breaking the API. We try to make the breakage minor and easy to fix. Below is a change-log of API breaking changes only. If you are using one of the functions listed, expect to have to fix some code. When you are not sure about an old symbol or function name, try using the Search/Find function of your IDE to look for comments or references in all imgui files. You can read releases logs https://github.com/ocornut/imgui/releases for more details. - 2025/03/05 (1.91.9) - BeginMenu(): Internals: reworked mangling of menu windows to use "###Menu_00" etc. instead of "##Menu_00", allowing them to also store the menu name before it. This shouldn't affect code unless directly accessing menu window from their mangled name. - 2025/02/27 (1.91.9) - Image(): removed 'tint_col' and 'border_col' parameter from Image() function. Added ImageWithBg() replacement. (#8131, #8238) - old: void Image (ImTextureID tex_id, ImVec2 image_size, ImVec2 uv0 = (0,0), ImVec2 uv1 = (1,1), ImVec4 tint_col = (1,1,1,1), ImVec4 border_col = (0,0,0,0)); - new: void Image (ImTextureID tex_id, ImVec2 image_size, ImVec2 uv0 = (0,0), ImVec2 uv1 = (1,1)); - new: void ImageWithBg(ImTextureID tex_id, ImVec2 image_size, ImVec2 uv0 = (0,0), ImVec2 uv1 = (1,1), ImVec4 bg_col = (0,0,0,0), ImVec4 tint_col = (1,1,1,1)); - TL;DR: 'border_col' had misleading side-effect on layout, 'bg_col' was missing, parameter order couldn't be consistent with ImageButton(). - new behavior always use ImGuiCol_Border color + style.ImageBorderSize / ImGuiStyleVar_ImageBorderSize. - old behavior altered border size (and therefore layout) based on border color's alpha, which caused variety of problems + old behavior a fixed 1.0f for border size which was not tweakable. - kept legacy signature (will obsolete), which mimics the old behavior, but uses Max(1.0f, style.ImageBorderSize) when border_col is specified. - added ImageWithBg() function which has both 'bg_col' (which was missing) and 'tint_col'. It was impossible to add 'bg_col' to Image() with a parameter order consistent with other functions, so we decided to remove 'tint_col' and introduce ImageWithBg(). - 2025/02/25 (1.91.9) - internals: fonts: ImFontAtlas::ConfigData[] has been renamed to ImFontAtlas::Sources[]. ImFont::ConfigData[], ConfigDataCount has been renamed to Sources[], SourcesCount. - 2025/02/06 (1.91.9) - renamed ImFontConfig::GlyphExtraSpacing.x to ImFontConfig::GlyphExtraAdvanceX. - 2025/01/22 (1.91.8) - removed ImGuiColorEditFlags_AlphaPreview (made value 0): it is now the default behavior. prior to 1.91.8: alpha was made opaque in the preview by default _unless_ using ImGuiColorEditFlags_AlphaPreview. We now display the preview as transparent by default. You can use ImGuiColorEditFlags_AlphaOpaque to use old behavior. the new flags (ImGuiColorEditFlags_AlphaOpaque, ImGuiColorEditFlags_AlphaNoBg + existing ImGuiColorEditFlags_AlphaPreviewHalf) may be combined better and allow finer controls: - 2025/01/14 (1.91.7) - renamed ImGuiTreeNodeFlags_SpanTextWidth to ImGuiTreeNodeFlags_SpanLabelWidth for consistency with other names. Kept redirection enum (will obsolete). (#6937) - 2024/11/27 (1.91.6) - changed CRC32 table from CRC32-adler to CRC32c polynomial in order to be compatible with the result of SSE 4.2 instructions. As a result, old .ini data may be partially lost (docking and tables information particularly). Because some users have crafted and storing .ini data as a way to workaround limitations of the docking API, we are providing a '#define IMGUI_USE_LEGACY_CRC32_ADLER' compile-time option to keep using old CRC32 tables if you cannot afford invalidating old .ini data. - 2024/11/06 (1.91.5) - commented/obsoleted out pre-1.87 IO system (equivalent to using IMGUI_DISABLE_OBSOLETE_KEYIO or IMGUI_DISABLE_OBSOLETE_FUNCTIONS before) - io.KeyMap[] and io.KeysDown[] are removed (obsoleted February 2022). - io.NavInputs[] and ImGuiNavInput are removed (obsoleted July 2022). - pre-1.87 backends are not supported: - backends need to call io.AddKeyEvent(), io.AddMouseEvent() instead of writing to io.KeysDown[], io.MouseDown[] fields. - backends need to call io.AddKeyAnalogEvent() for gamepad values instead of writing to io.NavInputs[] fields. - for more reference: - read 1.87 and 1.88 part of this section or read Changelog for 1.87 and 1.88. - read https://github.com/ocornut/imgui/issues/4921 - if you have trouble updating a very old codebase using legacy backend-specific key codes: consider updating to 1.91.4 first, then #define IMGUI_DISABLE_OBSOLETE_KEYIO, then update to latest. - obsoleted ImGuiKey_COUNT (it is unusually error-prone/misleading since valid keys don't start at 0). probably use ImGuiKey_NamedKey_BEGIN/ImGuiKey_NamedKey_END? - fonts: removed const qualifiers from most font functions in prevision for upcoming font improvements. - 2024/10/18 (1.91.4) - renamed ImGuiCol_NavHighlight to ImGuiCol_NavCursor (for consistency with newly exposed and reworked features). Kept inline redirection enum (will obsolete). - 2024/10/14 (1.91.4) - moved ImGuiConfigFlags_NavEnableSetMousePos to standalone io.ConfigNavMoveSetMousePos bool. moved ImGuiConfigFlags_NavNoCaptureKeyboard to standalone io.ConfigNavCaptureKeyboard bool (note the inverted value!). kept legacy names (will obsolete) + code that copies settings once the first time. Dynamically changing the old value won't work. Switch to using the new value! - 2024/10/10 (1.91.4) - the typedef for ImTextureID now defaults to ImU64 instead of void*. (#1641) this removes the requirement to redefine it for backends which are e.g. storing descriptor sets or other 64-bits structures when building on 32-bits archs. It therefore simplify various building scripts/helpers. you may have compile-time issues if you were casting to 'void*' instead of 'ImTextureID' when passing your types to functions taking ImTextureID values, e.g. ImGui::Image(). in doubt it is almost always better to do an intermediate intptr_t cast, since it allows casting any pointer/integer type without warning: - May warn: ImGui::Image((void*)MyTextureData, ...); - May warn: ImGui::Image((void*)(intptr_t)MyTextureData, ...); - Won't warn: ImGui::Image((ImTextureID)(intptr_t)MyTextureData), ...); - note that you can always define ImTextureID to be your own high-level structures (with dedicated constructors) if you like. - 2024/10/03 (1.91.3) - drags: treat v_min==v_max as a valid clamping range when != 0.0f. Zero is a still special value due to legacy reasons, unless using ImGuiSliderFlags_ClampZeroRange. (#7968, #3361, #76) - drags: extended behavior of ImGuiSliderFlags_AlwaysClamp to include _ClampZeroRange. It considers v_min==v_max==0.0f as a valid clamping range (aka edits not allowed). although unlikely, it you wish to only clamp on text input but want v_min==v_max==0.0f to mean unclamped drags, you can use _ClampOnInput instead of _AlwaysClamp. (#7968, #3361, #76) - 2024/09/10 (1.91.2) - internals: using multiple overlayed ButtonBehavior() with same ID will now have io.ConfigDebugHighlightIdConflicts=true feature emit a warning. (#8030) it was one of the rare case where using same ID is legal. workarounds: (1) use single ButtonBehavior() call with multiple _MouseButton flags, or (2) surround the calls with PushItemFlag(ImGuiItemFlags_AllowDuplicateId, true); ... PopItemFlag() - 2024/08/23 (1.91.1) - renamed ImGuiChildFlags_Border to ImGuiChildFlags_Borders for consistency. kept inline redirection flag. - 2024/08/22 (1.91.1) - moved some functions from ImGuiIO to ImGuiPlatformIO structure: - io.GetClipboardTextFn -> platform_io.Platform_GetClipboardTextFn + changed 'void* user_data' to 'ImGuiContext* ctx'. Pull your user data from platform_io.ClipboardUserData. - io.SetClipboardTextFn -> platform_io.Platform_SetClipboardTextFn + same as above line. - io.PlatformOpenInShellFn -> platform_io.Platform_OpenInShellFn (#7660) - io.PlatformSetImeDataFn -> platform_io.Platform_SetImeDataFn - io.PlatformLocaleDecimalPoint -> platform_io.Platform_LocaleDecimalPoint (#7389, #6719, #2278) - access those via GetPlatformIO() instead of GetIO(). some were introduced very recently and often automatically setup by core library and backends, so for those we are exceptionally not maintaining a legacy redirection symbol. - commented the old ImageButton() signature obsoleted in 1.89 (~August 2022). As a reminder: - old ImageButton() before 1.89 used ImTextureId as item id (created issue with e.g. multiple buttons in same scope, transient texture id values, opaque computation of ID) - new ImageButton() since 1.89 requires an explicit 'const char* str_id' - old ImageButton() before 1.89 had frame_padding' override argument. - new ImageButton() since 1.89 always use style.FramePadding, which you can freely override with PushStyleVar()/PopStyleVar(). - 2024/07/25 (1.91.0) - obsoleted GetContentRegionMax(), GetWindowContentRegionMin() and GetWindowContentRegionMax(). (see #7838 on GitHub for more info) you should never need those functions. you can do everything with GetCursorScreenPos() and GetContentRegionAvail() in a more simple way. - instead of: GetWindowContentRegionMax().x - GetCursorPos().x - you can use: GetContentRegionAvail().x - instead of: GetWindowContentRegionMax().x + GetWindowPos().x - you can use: GetCursorScreenPos().x + GetContentRegionAvail().x // when called from left edge of window - instead of: GetContentRegionMax() - you can use: GetContentRegionAvail() + GetCursorScreenPos() - GetWindowPos() // right edge in local coordinates - instead of: GetWindowContentRegionMax().x - GetWindowContentRegionMin().x - you can use: GetContentRegionAvail() // when called from left edge of window - 2024/07/15 (1.91.0) - renamed ImGuiSelectableFlags_DontClosePopups to ImGuiSelectableFlags_NoAutoClosePopups. (#1379, #1468, #2200, #4936, #5216, #7302, #7573) (internals: also renamed ImGuiItemFlags_SelectableDontClosePopup into ImGuiItemFlags_AutoClosePopups with inverted behaviors) - 2024/07/15 (1.91.0) - obsoleted PushButtonRepeat()/PopButtonRepeat() in favor of using new PushItemFlag(ImGuiItemFlags_ButtonRepeat, ...)/PopItemFlag(). - 2024/07/02 (1.91.0) - commented out obsolete ImGuiModFlags (renamed to ImGuiKeyChord in 1.89). (#4921, #456) - commented out obsolete ImGuiModFlags_XXX values (renamed to ImGuiMod_XXX in 1.89). (#4921, #456) - ImGuiModFlags_Ctrl -> ImGuiMod_Ctrl, ImGuiModFlags_Shift -> ImGuiMod_Shift etc. - 2024/07/02 (1.91.0) - IO, IME: renamed platform IME hook and added explicit context for consistency and future-proofness. - old: io.SetPlatformImeDataFn(ImGuiViewport* viewport, ImGuiPlatformImeData* data); - new: io.PlatformSetImeDataFn(ImGuiContext* ctx, ImGuiViewport* viewport, ImGuiPlatformImeData* data); - 2024/06/21 (1.90.9) - BeginChild: added ImGuiChildFlags_NavFlattened as a replacement for the window flag ImGuiWindowFlags_NavFlattened: the feature only ever made sense for BeginChild() anyhow. - old: BeginChild("Name", size, 0, ImGuiWindowFlags_NavFlattened); - new: BeginChild("Name", size, ImGuiChildFlags_NavFlattened, 0); - 2024/06/21 (1.90.9) - io: ClearInputKeys() (first exposed in 1.89.8) doesn't clear mouse data, newly added ClearInputMouse() does. - 2024/06/20 (1.90.9) - renamed ImGuiDragDropFlags_SourceAutoExpirePayload to ImGuiDragDropFlags_PayloadAutoExpire. - 2024/06/18 (1.90.9) - style: renamed ImGuiCol_TabActive -> ImGuiCol_TabSelected, ImGuiCol_TabUnfocused -> ImGuiCol_TabDimmed, ImGuiCol_TabUnfocusedActive -> ImGuiCol_TabDimmedSelected. - 2024/06/10 (1.90.9) - removed old nested structure: renaming ImGuiStorage::ImGuiStoragePair type to ImGuiStoragePair (simpler for many languages). - 2024/06/06 (1.90.8) - reordered ImGuiInputTextFlags values. This should not be breaking unless you are using generated headers that have values not matching the main library. - 2024/06/06 (1.90.8) - removed 'ImGuiButtonFlags_MouseButtonDefault_ = ImGuiButtonFlags_MouseButtonLeft', was mostly unused and misleading. - 2024/05/27 (1.90.7) - commented out obsolete symbols marked obsolete in 1.88 (May 2022): - old: CaptureKeyboardFromApp(bool) - new: SetNextFrameWantCaptureKeyboard(bool) - old: CaptureMouseFromApp(bool) - new: SetNextFrameWantCaptureMouse(bool) - 2024/05/22 (1.90.7) - inputs (internals): renamed ImGuiKeyOwner_None to ImGuiKeyOwner_NoOwner, to make use more explicit and reduce confusion with the default it is a non-zero value and cannot be the default value (never made public, but disclosing as I expect a few users caught on owner-aware inputs). - inputs (internals): renamed ImGuiInputFlags_RouteGlobalLow -> ImGuiInputFlags_RouteGlobal, ImGuiInputFlags_RouteGlobal -> ImGuiInputFlags_RouteGlobalOverFocused, ImGuiInputFlags_RouteGlobalHigh -> ImGuiInputFlags_RouteGlobalHighest. - inputs (internals): Shortcut(), SetShortcutRouting(): swapped last two parameters order in function signatures: - old: Shortcut(ImGuiKeyChord key_chord, ImGuiID owner_id = 0, ImGuiInputFlags flags = 0); - new: Shortcut(ImGuiKeyChord key_chord, ImGuiInputFlags flags = 0, ImGuiID owner_id = 0); - inputs (internals): owner-aware versions of IsKeyPressed(), IsKeyChordPressed(), IsMouseClicked(): swapped last two parameters order in function signatures. - old: IsKeyPressed(ImGuiKey key, ImGuiID owner_id, ImGuiInputFlags flags = 0); - new: IsKeyPressed(ImGuiKey key, ImGuiInputFlags flags, ImGuiID owner_id = 0); - old: IsMouseClicked(ImGuiMouseButton button, ImGuiID owner_id, ImGuiInputFlags flags = 0); - new: IsMouseClicked(ImGuiMouseButton button, ImGuiInputFlags flags, ImGuiID owner_id = 0); for various reasons those changes makes sense. They are being made because making some of those API public. only past users of imgui_internal.h with the extra parameters will be affected. Added asserts for valid flags in various functions to detect _some_ misuses, BUT NOT ALL. - 2024/05/16 (1.90.7) - inputs: on macOS X, Cmd and Ctrl keys are now automatically swapped by io.AddKeyEvent() as this naturally align with how macOS X uses those keys. - it shouldn't really affect you unless you had custom shortcut swapping in place for macOS X apps. - removed ImGuiMod_Shortcut which was previously dynamically remapping to Ctrl or Cmd/Super. It is now unnecessary to specific cross-platform idiomatic shortcuts. (#2343, #4084, #5923, #456) - 2024/05/14 (1.90.7) - backends: SDL_Renderer2 and SDL_Renderer3 backend now take a SDL_Renderer* in their RenderDrawData() functions. - 2024/04/18 (1.90.6) - TreeNode: Fixed a layout inconsistency when using an empty/hidden label followed by a SameLine() call. (#7505, #282) - old: TreeNode("##Hidden"); SameLine(); Text("Hello"); // <-- This was actually incorrect! BUT appeared to look ok with the default style where ItemSpacing.x == FramePadding.x * 2 (it didn't look aligned otherwise). - new: TreeNode("##Hidden"); SameLine(0, 0); Text("Hello"); // <-- This is correct for all styles values. with the fix, IF you were successfully using TreeNode("")+SameLine(); you will now have extra spacing between your TreeNode and the following item. You'll need to change the SameLine() call to SameLine(0,0) to remove this extraneous spacing. This seemed like the more sensible fix that's not making things less consistent. (Note: when using this idiom you are likely to also use ImGuiTreeNodeFlags_SpanAvailWidth). - 2024/03/18 (1.90.5) - merged the radius_x/radius_y parameters in ImDrawList::AddEllipse(), AddEllipseFilled() and PathEllipticalArcTo() into a single ImVec2 parameter. Exceptionally, because those functions were added in 1.90, we are not adding inline redirection functions. The transition is easy and should affect few users. (#2743, #7417) - 2024/03/08 (1.90.5) - inputs: more formally obsoleted GetKeyIndex() when IMGUI_DISABLE_OBSOLETE_FUNCTIONS is set. It has been unnecessary and a no-op since 1.87 (it returns the same value as passed when used with a 1.87+ backend using io.AddKeyEvent() function). (#4921) - IsKeyPressed(GetKeyIndex(ImGuiKey_XXX)) -> use IsKeyPressed(ImGuiKey_XXX) - 2024/01/15 (1.90.2) - commented out obsolete ImGuiIO::ImeWindowHandle marked obsolete in 1.87, favor of writing to 'void* ImGuiViewport::PlatformHandleRaw'. - 2023/12/19 (1.90.1) - commented out obsolete ImGuiKey_KeyPadEnter redirection to ImGuiKey_KeypadEnter. - 2023/11/06 (1.90.1) - removed CalcListClipping() marked obsolete in 1.86. Prefer using ImGuiListClipper which can return non-contiguous ranges. - 2023/11/05 (1.90.1) - imgui_freetype: commented out ImGuiFreeType::BuildFontAtlas() obsoleted in 1.81. prefer using #define IMGUI_ENABLE_FREETYPE or see commented code for manual calls. - 2023/11/05 (1.90.1) - internals,columns: commented out legacy ImGuiColumnsFlags_XXX symbols redirecting to ImGuiOldColumnsFlags_XXX, obsoleted from imgui_internal.h in 1.80. - 2023/11/09 (1.90.0) - removed IM_OFFSETOF() macro in favor of using offsetof() available in C++11. Kept redirection define (will obsolete). - 2023/11/07 (1.90.0) - removed BeginChildFrame()/EndChildFrame() in favor of using BeginChild() with the ImGuiChildFlags_FrameStyle flag. kept inline redirection function (will obsolete). those functions were merely PushStyle/PopStyle helpers, the removal isn't so much motivated by needing to add the feature in BeginChild(), but by the necessity to avoid BeginChildFrame() signature mismatching BeginChild() signature and features. - 2023/11/02 (1.90.0) - BeginChild: upgraded 'bool border = true' parameter to 'ImGuiChildFlags flags' type, added ImGuiChildFlags_Border equivalent. As with our prior "bool-to-flags" API updates, the ImGuiChildFlags_Border value is guaranteed to be == true forever to ensure a smoother transition, meaning all existing calls will still work. - old: BeginChild("Name", size, true) - new: BeginChild("Name", size, ImGuiChildFlags_Border) - old: BeginChild("Name", size, false) - new: BeginChild("Name", size) or BeginChild("Name", 0) or BeginChild("Name", size, ImGuiChildFlags_None) **AMEND FROM THE FUTURE: from 1.91.1, 'ImGuiChildFlags_Border' is called 'ImGuiChildFlags_Borders'** - 2023/11/02 (1.90.0) - BeginChild: added child-flag ImGuiChildFlags_AlwaysUseWindowPadding as a replacement for the window-flag ImGuiWindowFlags_AlwaysUseWindowPadding: the feature only ever made sense for BeginChild() anyhow. - old: BeginChild("Name", size, 0, ImGuiWindowFlags_AlwaysUseWindowPadding); - new: BeginChild("Name", size, ImGuiChildFlags_AlwaysUseWindowPadding, 0); - 2023/09/27 (1.90.0) - io: removed io.MetricsActiveAllocations introduced in 1.63. Same as 'g.DebugMemAllocCount - g.DebugMemFreeCount' (still displayed in Metrics, unlikely to be accessed by end-user). - 2023/09/26 (1.90.0) - debug tools: Renamed ShowStackToolWindow() ("Stack Tool") to ShowIDStackToolWindow() ("ID Stack Tool"), as earlier name was misleading. Kept inline redirection function. (#4631) - 2023/09/15 (1.90.0) - ListBox, Combo: changed signature of "name getter" callback in old one-liner ListBox()/Combo() apis. kept inline redirection function (will obsolete). - old: bool Combo(const char* label, int* current_item, bool (*getter)(void* user_data, int idx, const char** out_text), ...) - new: bool Combo(const char* label, int* current_item, const char* (*getter)(void* user_data, int idx), ...); - old: bool ListBox(const char* label, int* current_item, bool (*getting)(void* user_data, int idx, const char** out_text), ...); - new: bool ListBox(const char* label, int* current_item, const char* (*getter)(void* user_data, int idx), ...); - 2023/09/08 (1.90.0) - commented out obsolete redirecting functions: - GetWindowContentRegionWidth() -> use GetWindowContentRegionMax().x - GetWindowContentRegionMin().x. Consider that generally 'GetContentRegionAvail().x' is more useful. - ImDrawCornerFlags_XXX -> use ImDrawFlags_RoundCornersXXX flags. Read 1.82 Changelog for details + grep commented names in sources. - commented out runtime support for hardcoded ~0 or 0x01..0x0F rounding flags values for AddRect()/AddRectFilled()/PathRect()/AddImageRounded() -> use ImDrawFlags_RoundCornersXXX flags. Read 1.82 Changelog for details - 2023/08/25 (1.89.9) - clipper: Renamed IncludeRangeByIndices() (also called ForceDisplayRangeByIndices() before 1.89.6) to IncludeItemsByIndex(). Kept inline redirection function. Sorry! - 2023/07/12 (1.89.8) - ImDrawData: CmdLists now owned, changed from ImDrawList** to ImVector. Majority of users shouldn't be affected, but you cannot compare to NULL nor reassign manually anymore. Instead use AddDrawList(). (#6406, #4879, #1878) - 2023/06/28 (1.89.7) - overlapping items: obsoleted 'SetItemAllowOverlap()' (called after item) in favor of calling 'SetNextItemAllowOverlap()' (called before item). 'SetItemAllowOverlap()' didn't and couldn't work reliably since 1.89 (2022-11-15). - 2023/06/28 (1.89.7) - overlapping items: renamed 'ImGuiTreeNodeFlags_AllowItemOverlap' to 'ImGuiTreeNodeFlags_AllowOverlap', 'ImGuiSelectableFlags_AllowItemOverlap' to 'ImGuiSelectableFlags_AllowOverlap'. Kept redirecting enums (will obsolete). - 2023/06/28 (1.89.7) - overlapping items: IsItemHovered() now by default return false when querying an item using AllowOverlap mode which is being overlapped. Use ImGuiHoveredFlags_AllowWhenOverlappedByItem to revert to old behavior. - 2023/06/28 (1.89.7) - overlapping items: Selectable and TreeNode don't allow overlap when active so overlapping widgets won't appear as hovered. While this fixes a common small visual issue, it also means that calling IsItemHovered() after a non-reactive elements - e.g. Text() - overlapping an active one may fail if you don't use IsItemHovered(ImGuiHoveredFlags_AllowWhenBlockedByActiveItem). (#6610) - 2023/06/20 (1.89.7) - moved io.HoverDelayShort/io.HoverDelayNormal to style.HoverDelayShort/style.HoverDelayNormal. As the fields were added in 1.89 and expected to be left unchanged by most users, or only tweaked once during app initialization, we are exceptionally accepting the breakage. - 2023/05/30 (1.89.6) - backends: renamed "imgui_impl_sdlrenderer.cpp" to "imgui_impl_sdlrenderer2.cpp" and "imgui_impl_sdlrenderer.h" to "imgui_impl_sdlrenderer2.h". This is in prevision for the future release of SDL3. - 2023/05/22 (1.89.6) - listbox: commented out obsolete/redirecting functions that were marked obsolete more than two years ago: - ListBoxHeader() -> use BeginListBox() (note how two variants of ListBoxHeader() existed. Check commented versions in imgui.h for reference) - ListBoxFooter() -> use EndListBox() - 2023/05/15 (1.89.6) - clipper: commented out obsolete redirection constructor 'ImGuiListClipper(int items_count, float items_height = -1.0f)' that was marked obsolete in 1.79. Use default constructor + clipper.Begin(). - 2023/05/15 (1.89.6) - clipper: renamed ImGuiListClipper::ForceDisplayRangeByIndices() to ImGuiListClipper::IncludeRangeByIndices(). - 2023/03/14 (1.89.4) - commented out redirecting enums/functions names that were marked obsolete two years ago: - ImGuiSliderFlags_ClampOnInput -> use ImGuiSliderFlags_AlwaysClamp - ImGuiInputTextFlags_AlwaysInsertMode -> use ImGuiInputTextFlags_AlwaysOverwrite - ImDrawList::AddBezierCurve() -> use ImDrawList::AddBezierCubic() - ImDrawList::PathBezierCurveTo() -> use ImDrawList::PathBezierCubicCurveTo() - 2023/03/09 (1.89.4) - renamed PushAllowKeyboardFocus()/PopAllowKeyboardFocus() to PushTabStop()/PopTabStop(). Kept inline redirection functions (will obsolete). - 2023/03/09 (1.89.4) - tooltips: Added 'bool' return value to BeginTooltip() for API consistency. Please only submit contents and call EndTooltip() if BeginTooltip() returns true. In reality the function will _currently_ always return true, but further changes down the line may change this, best to clarify API sooner. - 2023/02/15 (1.89.4) - moved the optional "courtesy maths operators" implementation from imgui_internal.h in imgui.h. Even though we encourage using your own maths types and operators by setting up IM_VEC2_CLASS_EXTRA, it has been frequently requested by people to use our own. We had an opt-in define which was previously fulfilled in imgui_internal.h. It is now fulfilled in imgui.h. (#6164) - OK: #define IMGUI_DEFINE_MATH_OPERATORS / #include "imgui.h" / #include "imgui_internal.h" - Error: #include "imgui.h" / #define IMGUI_DEFINE_MATH_OPERATORS / #include "imgui_internal.h" - 2023/02/07 (1.89.3) - backends: renamed "imgui_impl_sdl.cpp" to "imgui_impl_sdl2.cpp" and "imgui_impl_sdl.h" to "imgui_impl_sdl2.h". (#6146) This is in prevision for the future release of SDL3. - 2022/10/26 (1.89) - commented out redirecting OpenPopupContextItem() which was briefly the name of OpenPopupOnItemClick() from 1.77 to 1.79. - 2022/10/12 (1.89) - removed runtime patching of invalid "%f"/"%0.f" format strings for DragInt()/SliderInt(). This was obsoleted in 1.61 (May 2018). See 1.61 changelog for details. - 2022/09/26 (1.89) - renamed and merged keyboard modifiers key enums and flags into a same set. Kept inline redirection enums (will obsolete). - ImGuiKey_ModCtrl and ImGuiModFlags_Ctrl -> ImGuiMod_Ctrl - ImGuiKey_ModShift and ImGuiModFlags_Shift -> ImGuiMod_Shift - ImGuiKey_ModAlt and ImGuiModFlags_Alt -> ImGuiMod_Alt - ImGuiKey_ModSuper and ImGuiModFlags_Super -> ImGuiMod_Super the ImGuiKey_ModXXX were introduced in 1.87 and mostly used by backends. the ImGuiModFlags_XXX have been exposed in imgui.h but not really used by any public api only by third-party extensions. exceptionally commenting out the older ImGuiKeyModFlags_XXX names ahead of obsolescence schedule to reduce confusion and because they were not meant to be used anyway. - 2022/09/20 (1.89) - ImGuiKey is now a typed enum, allowing ImGuiKey_XXX symbols to be named in debuggers. this will require uses of legacy backend-dependent indices to be casted, e.g. - with imgui_impl_glfw: IsKeyPressed(GLFW_KEY_A) -> IsKeyPressed((ImGuiKey)GLFW_KEY_A); - with imgui_impl_win32: IsKeyPressed('A') -> IsKeyPressed((ImGuiKey)'A') - etc. However if you are upgrading code you might well use the better, backend-agnostic IsKeyPressed(ImGuiKey_A) now! - 2022/09/12 (1.89) - removed the bizarre legacy default argument for 'TreePush(const void* ptr = NULL)', always pass a pointer value explicitly. NULL/nullptr is ok but require cast, e.g. TreePush((void*)nullptr); - 2022/09/05 (1.89) - commented out redirecting functions/enums names that were marked obsolete in 1.77 and 1.78 (June 2020): - DragScalar(), DragScalarN(), DragFloat(), DragFloat2(), DragFloat3(), DragFloat4(): For old signatures ending with (..., const char* format, float power = 1.0f) -> use (..., format ImGuiSliderFlags_Logarithmic) if power != 1.0f. - SliderScalar(), SliderScalarN(), SliderFloat(), SliderFloat2(), SliderFloat3(), SliderFloat4(): For old signatures ending with (..., const char* format, float power = 1.0f) -> use (..., format ImGuiSliderFlags_Logarithmic) if power != 1.0f. - BeginPopupContextWindow(const char*, ImGuiMouseButton, bool) -> use BeginPopupContextWindow(const char*, ImGuiPopupFlags) - 2022/09/02 (1.89) - obsoleted using SetCursorPos()/SetCursorScreenPos() to extend parent window/cell boundaries. this relates to when moving the cursor position beyond current boundaries WITHOUT submitting an item. - previously this would make the window content size ~200x200: Begin(...) + SetCursorScreenPos(GetCursorScreenPos() + ImVec2(200,200)) + End(); - instead, please submit an item: Begin(...) + SetCursorScreenPos(GetCursorScreenPos() + ImVec2(200,200)) + Dummy(ImVec2(0,0)) + End(); - alternative: Begin(...) + Dummy(ImVec2(200,200)) + End(); - content size is now only extended when submitting an item! - with '#define IMGUI_DISABLE_OBSOLETE_FUNCTIONS' this will now be detected and assert. - without '#define IMGUI_DISABLE_OBSOLETE_FUNCTIONS' this will silently be fixed until we obsolete it. - 2022/08/03 (1.89) - changed signature of ImageButton() function. Kept redirection function (will obsolete). - added 'const char* str_id' parameter + removed 'int frame_padding = -1' parameter. - old signature: bool ImageButton(ImTextureID tex_id, ImVec2 size, ImVec2 uv0 = ImVec2(0,0), ImVec2 uv1 = ImVec2(1,1), int frame_padding = -1, ImVec4 bg_col = ImVec4(0,0,0,0), ImVec4 tint_col = ImVec4(1,1,1,1)); - used the ImTextureID value to create an ID. This was inconsistent with other functions, led to ID conflicts, and caused problems with engines using transient ImTextureID values. - had a FramePadding override which was inconsistent with other functions and made the already-long signature even longer. - new signature: bool ImageButton(const char* str_id, ImTextureID tex_id, ImVec2 size, ImVec2 uv0 = ImVec2(0,0), ImVec2 uv1 = ImVec2(1,1), ImVec4 bg_col = ImVec4(0,0,0,0), ImVec4 tint_col = ImVec4(1,1,1,1)); - requires an explicit identifier. You may still use e.g. PushID() calls and then pass an empty identifier. - always uses style.FramePadding for padding, to be consistent with other buttons. You may use PushStyleVar() to alter this. - 2022/07/08 (1.89) - inputs: removed io.NavInputs[] and ImGuiNavInput enum (following 1.87 changes). - Official backends from 1.87+ -> no issue. - Official backends from 1.60 to 1.86 -> will build and convert gamepad inputs, unless IMGUI_DISABLE_OBSOLETE_KEYIO is defined. Need updating! - Custom backends not writing to io.NavInputs[] -> no issue. - Custom backends writing to io.NavInputs[] -> will build and convert gamepad inputs, unless IMGUI_DISABLE_OBSOLETE_KEYIO is defined. Need fixing! - TL;DR: Backends should call io.AddKeyEvent()/io.AddKeyAnalogEvent() with ImGuiKey_GamepadXXX values instead of filling io.NavInput[]. - 2022/06/15 (1.88) - renamed IMGUI_DISABLE_METRICS_WINDOW to IMGUI_DISABLE_DEBUG_TOOLS for correctness. kept support for old define (will obsolete). - 2022/05/03 (1.88) - backends: osx: removed ImGui_ImplOSX_HandleEvent() from backend API in favor of backend automatically handling event capture. All ImGui_ImplOSX_HandleEvent() calls should be removed as they are now unnecessary. - 2022/04/05 (1.88) - inputs: renamed ImGuiKeyModFlags to ImGuiModFlags. Kept inline redirection enums (will obsolete). This was never used in public API functions but technically present in imgui.h and ImGuiIO. - 2022/01/20 (1.87) - inputs: reworded gamepad IO. - Backend writing to io.NavInputs[] -> backend should call io.AddKeyEvent()/io.AddKeyAnalogEvent() with ImGuiKey_GamepadXXX values. - 2022/01/19 (1.87) - sliders, drags: removed support for legacy arithmetic operators (+,+-,*,/) when inputting text. This doesn't break any api/code but a feature that used to be accessible by end-users (which seemingly no one used). - 2022/01/17 (1.87) - inputs: reworked mouse IO. - Backend writing to io.MousePos -> backend should call io.AddMousePosEvent() - Backend writing to io.MouseDown[] -> backend should call io.AddMouseButtonEvent() - Backend writing to io.MouseWheel -> backend should call io.AddMouseWheelEvent() - Backend writing to io.MouseHoveredViewport -> backend should call io.AddMouseViewportEvent() [Docking branch w/ multi-viewports only] note: for all calls to IO new functions, the Dear ImGui context should be bound/current. read https://github.com/ocornut/imgui/issues/4921 for details. - 2022/01/10 (1.87) - inputs: reworked keyboard IO. Removed io.KeyMap[], io.KeysDown[] in favor of calling io.AddKeyEvent(), ImGui::IsKeyDown(). Removed GetKeyIndex(), now unnecessary. All IsKeyXXX() functions now take ImGuiKey values. All features are still functional until IMGUI_DISABLE_OBSOLETE_KEYIO is defined. Read Changelog and Release Notes for details. - IsKeyPressed(MY_NATIVE_KEY_XXX) -> use IsKeyPressed(ImGuiKey_XXX) - IsKeyPressed(GetKeyIndex(ImGuiKey_XXX)) -> use IsKeyPressed(ImGuiKey_XXX) - Backend writing to io.KeyMap[],io.KeysDown[] -> backend should call io.AddKeyEvent() (+ call io.SetKeyEventNativeData() if you want legacy user code to stil function with legacy key codes). - Backend writing to io.KeyCtrl, io.KeyShift.. -> backend should call io.AddKeyEvent() with ImGuiMod_XXX values. *IF YOU PULLED CODE BETWEEN 2021/01/10 and 2021/01/27: We used to have a io.AddKeyModsEvent() function which was now replaced by io.AddKeyEvent() with ImGuiMod_XXX values.* - one case won't work with backward compatibility: if your custom backend used ImGuiKey as mock native indices (e.g. "io.KeyMap[ImGuiKey_A] = ImGuiKey_A") because those values are now larger than the legacy KeyDown[] array. Will assert. - inputs: added ImGuiKey_ModCtrl/ImGuiKey_ModShift/ImGuiKey_ModAlt/ImGuiKey_ModSuper values to submit keyboard modifiers using io.AddKeyEvent(), instead of writing directly to io.KeyCtrl, io.KeyShift, io.KeyAlt, io.KeySuper. - 2022/01/05 (1.87) - inputs: renamed ImGuiKey_KeyPadEnter to ImGuiKey_KeypadEnter to align with new symbols. Kept redirection enum. - 2022/01/05 (1.87) - removed io.ImeSetInputScreenPosFn() in favor of more flexible io.SetPlatformImeDataFn(). Removed 'void* io.ImeWindowHandle' in favor of writing to 'void* ImGuiViewport::PlatformHandleRaw'. - 2022/01/01 (1.87) - commented out redirecting functions/enums names that were marked obsolete in 1.69, 1.70, 1.71, 1.72 (March-July 2019) - ImGui::SetNextTreeNodeOpen() -> use ImGui::SetNextItemOpen() - ImGui::GetContentRegionAvailWidth() -> use ImGui::GetContentRegionAvail().x - ImGui::TreeAdvanceToLabelPos() -> use ImGui::SetCursorPosX(ImGui::GetCursorPosX() + ImGui::GetTreeNodeToLabelSpacing()); - ImFontAtlas::CustomRect -> use ImFontAtlasCustomRect - ImGuiColorEditFlags_RGB/HSV/HEX -> use ImGuiColorEditFlags_DisplayRGB/HSV/Hex - 2021/12/20 (1.86) - backends: removed obsolete Marmalade backend (imgui_impl_marmalade.cpp) + example. Find last supported version at https://github.com/ocornut/imgui/wiki/Bindings - 2021/11/04 (1.86) - removed CalcListClipping() function. Prefer using ImGuiListClipper which can return non-contiguous ranges. Please open an issue if you think you really need this function. - 2021/08/23 (1.85) - removed GetWindowContentRegionWidth() function. keep inline redirection helper. can use 'GetWindowContentRegionMax().x - GetWindowContentRegionMin().x' instead for generally 'GetContentRegionAvail().x' is more useful. - 2021/07/26 (1.84) - commented out redirecting functions/enums names that were marked obsolete in 1.67 and 1.69 (March 2019): - ImGui::GetOverlayDrawList() -> use ImGui::GetForegroundDrawList() - ImFont::GlyphRangesBuilder -> use ImFontGlyphRangesBuilder - 2021/05/19 (1.83) - backends: obsoleted direct access to ImDrawCmd::TextureId in favor of calling ImDrawCmd::GetTexID(). - if you are using official backends from the source tree: you have nothing to do. - if you have copied old backend code or using your own: change access to draw_cmd->TextureId to draw_cmd->GetTexID(). - 2021/03/12 (1.82) - upgraded ImDrawList::AddRect(), AddRectFilled(), PathRect() to use ImDrawFlags instead of ImDrawCornersFlags. - ImDrawCornerFlags_TopLeft -> use ImDrawFlags_RoundCornersTopLeft - ImDrawCornerFlags_BotRight -> use ImDrawFlags_RoundCornersBottomRight - ImDrawCornerFlags_None -> use ImDrawFlags_RoundCornersNone etc. flags now sanely defaults to 0 instead of 0x0F, consistent with all other flags in the API. breaking: the default with rounding > 0.0f is now "round all corners" vs old implicit "round no corners": - rounding == 0.0f + flags == 0 --> meant no rounding --> unchanged (common use) - rounding > 0.0f + flags != 0 --> meant rounding --> unchanged (common use) - rounding == 0.0f + flags != 0 --> meant no rounding --> unchanged (unlikely use) - rounding > 0.0f + flags == 0 --> meant no rounding --> BREAKING (unlikely use): will now round all corners --> use ImDrawFlags_RoundCornersNone or rounding == 0.0f. this ONLY matters for hard coded use of 0 + rounding > 0.0f. Use of named ImDrawFlags_RoundCornersNone (new) or ImDrawCornerFlags_None (old) are ok. the old ImDrawCornersFlags used awkward default values of ~0 or 0xF (4 lower bits set) to signify "round all corners" and we sometimes encouraged using them as shortcuts. legacy path still support use of hard coded ~0 or any value from 0x1 or 0xF. They will behave the same with legacy paths enabled (will assert otherwise). - 2021/03/11 (1.82) - removed redirecting functions/enums names that were marked obsolete in 1.66 (September 2018): - ImGui::SetScrollHere() -> use ImGui::SetScrollHereY() - 2021/03/11 (1.82) - clarified that ImDrawList::PathArcTo(), ImDrawList::PathArcToFast() won't render with radius < 0.0f. Previously it sorts of accidentally worked but would generally lead to counter-clockwise paths and have an effect on anti-aliasing. - 2021/03/10 (1.82) - upgraded ImDrawList::AddPolyline() and PathStroke() "bool closed" parameter to "ImDrawFlags flags". The matching ImDrawFlags_Closed value is guaranteed to always stay == 1 in the future. - 2021/02/22 (1.82) - (*undone in 1.84*) win32+mingw: Re-enabled IME functions by default even under MinGW. In July 2016, issue #738 had me incorrectly disable those default functions for MinGW. MinGW users should: either link with -limm32, either set their imconfig file with '#define IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCTIONS'. - 2021/02/17 (1.82) - renamed rarely used style.CircleSegmentMaxError (old default = 1.60f) to style.CircleTessellationMaxError (new default = 0.30f) as the meaning of the value changed. - 2021/02/03 (1.81) - renamed ListBoxHeader(const char* label, ImVec2 size) to BeginListBox(). Kept inline redirection function (will obsolete). - removed ListBoxHeader(const char* label, int items_count, int height_in_items = -1) in favor of specifying size. Kept inline redirection function (will obsolete). - renamed ListBoxFooter() to EndListBox(). Kept inline redirection function (will obsolete). - 2021/01/26 (1.81) - removed ImGuiFreeType::BuildFontAtlas(). Kept inline redirection function. Prefer using '#define IMGUI_ENABLE_FREETYPE', but there's a runtime selection path available too. The shared extra flags parameters (very rarely used) are now stored in ImFontAtlas::FontBuilderFlags. - renamed ImFontConfig::RasterizerFlags (used by FreeType) to ImFontConfig::FontBuilderFlags. - renamed ImGuiFreeType::XXX flags to ImGuiFreeTypeBuilderFlags_XXX for consistency with other API. - 2020/10/12 (1.80) - removed redirecting functions/enums that were marked obsolete in 1.63 (August 2018): - ImGui::IsItemDeactivatedAfterChange() -> use ImGui::IsItemDeactivatedAfterEdit(). - ImGuiCol_ModalWindowDarkening -> use ImGuiCol_ModalWindowDimBg - ImGuiInputTextCallback -> use ImGuiTextEditCallback - ImGuiInputTextCallbackData -> use ImGuiTextEditCallbackData - 2020/12/21 (1.80) - renamed ImDrawList::AddBezierCurve() to AddBezierCubic(), and PathBezierCurveTo() to PathBezierCubicCurveTo(). Kept inline redirection function (will obsolete). - 2020/12/04 (1.80) - added imgui_tables.cpp file! Manually constructed project files will need the new file added! - 2020/11/18 (1.80) - renamed undocumented/internals ImGuiColumnsFlags_* to ImGuiOldColumnFlags_* in prevision of incoming Tables API. - 2020/11/03 (1.80) - renamed io.ConfigWindowsMemoryCompactTimer to io.ConfigMemoryCompactTimer as the feature will apply to other data structures - 2020/10/14 (1.80) - backends: moved all backends files (imgui_impl_XXXX.cpp, imgui_impl_XXXX.h) from examples/ to backends/. - 2020/10/12 (1.80) - removed redirecting functions/enums that were marked obsolete in 1.60 (April 2018): - io.RenderDrawListsFn pointer -> use ImGui::GetDrawData() value and call the render function of your backend - ImGui::IsAnyWindowFocused() -> use ImGui::IsWindowFocused(ImGuiFocusedFlags_AnyWindow) - ImGui::IsAnyWindowHovered() -> use ImGui::IsWindowHovered(ImGuiHoveredFlags_AnyWindow) - ImGuiStyleVar_Count_ -> use ImGuiStyleVar_COUNT - ImGuiMouseCursor_Count_ -> use ImGuiMouseCursor_COUNT - removed redirecting functions names that were marked obsolete in 1.61 (May 2018): - InputFloat (... int decimal_precision ...) -> use InputFloat (... const char* format ...) with format = "%.Xf" where X is your value for decimal_precision. - same for InputFloat2()/InputFloat3()/InputFloat4() variants taking a `int decimal_precision` parameter. - 2020/10/05 (1.79) - removed ImGuiListClipper: Renamed constructor parameters which created an ambiguous alternative to using the ImGuiListClipper::Begin() function, with misleading edge cases (note: imgui_memory_editor <0.40 from imgui_club/ used this old clipper API. Update your copy if needed). - 2020/09/25 (1.79) - renamed ImGuiSliderFlags_ClampOnInput to ImGuiSliderFlags_AlwaysClamp. Kept redirection enum (will obsolete sooner because previous name was added recently). - 2020/09/25 (1.79) - renamed style.TabMinWidthForUnselectedCloseButton to style.TabMinWidthForCloseButton. - 2020/09/21 (1.79) - renamed OpenPopupContextItem() back to OpenPopupOnItemClick(), reverting the change from 1.77. For varieties of reason this is more self-explanatory. - 2020/09/21 (1.79) - removed return value from OpenPopupOnItemClick() - returned true on mouse release on an item - because it is inconsistent with other popup APIs and makes others misleading. It's also and unnecessary: you can use IsWindowAppearing() after BeginPopup() for a similar result. - 2020/09/17 (1.79) - removed ImFont::DisplayOffset in favor of ImFontConfig::GlyphOffset. DisplayOffset was applied after scaling and not very meaningful/useful outside of being needed by the default ProggyClean font. If you scaled this value after calling AddFontDefault(), this is now done automatically. It was also getting in the way of better font scaling, so let's get rid of it now! - 2020/08/17 (1.78) - obsoleted use of the trailing 'float power=1.0f' parameter for DragFloat(), DragFloat2(), DragFloat3(), DragFloat4(), DragFloatRange2(), DragScalar(), DragScalarN(), SliderFloat(), SliderFloat2(), SliderFloat3(), SliderFloat4(), SliderScalar(), SliderScalarN(), VSliderFloat() and VSliderScalar(). replaced the 'float power=1.0f' argument with integer-based flags defaulting to 0 (as with all our flags). worked out a backward-compatibility scheme so hopefully most C++ codebase should not be affected. in short, when calling those functions: - if you omitted the 'power' parameter (likely!), you are not affected. - if you set the 'power' parameter to 1.0f (same as previous default value): 1/ your compiler may warn on float>int conversion, 2/ everything else will work. 3/ you can replace the 1.0f value with 0 to fix the warning, and be technically correct. - if you set the 'power' parameter to >1.0f (to enable non-linear editing): 1/ your compiler may warn on float>int conversion, 2/ code will assert at runtime, 3/ in case asserts are disabled, the code will not crash and enable the _Logarithmic flag. 4/ you can replace the >1.0f value with ImGuiSliderFlags_Logarithmic to fix the warning/assert and get a _similar_ effect as previous uses of power >1.0f. see https://github.com/ocornut/imgui/issues/3361 for all details. kept inline redirection functions (will obsolete) apart for: DragFloatRange2(), VSliderFloat(), VSliderScalar(). For those three the 'float power=1.0f' version was removed directly as they were most unlikely ever used. for shared code, you can version check at compile-time with `#if IMGUI_VERSION_NUM >= 17704`. - obsoleted use of v_min > v_max in DragInt, DragFloat, DragScalar to lock edits (introduced in 1.73, was not demoed nor documented very), will be replaced by a more generic ReadOnly feature. You may use the ImGuiSliderFlags_ReadOnly internal flag in the meantime. - 2020/06/23 (1.77) - removed BeginPopupContextWindow(const char*, int mouse_button, bool also_over_items) in favor of BeginPopupContextWindow(const char*, ImGuiPopupFlags flags) with ImGuiPopupFlags_NoOverItems. - 2020/06/15 (1.77) - renamed OpenPopupOnItemClick() to OpenPopupContextItem(). Kept inline redirection function (will obsolete). [NOTE: THIS WAS REVERTED IN 1.79] - 2020/06/15 (1.77) - removed CalcItemRectClosestPoint() entry point which was made obsolete and asserting in December 2017. - 2020/04/23 (1.77) - removed unnecessary ID (first arg) of ImFontAtlas::AddCustomRectRegular(). - 2020/01/22 (1.75) - ImDrawList::AddCircle()/AddCircleFilled() functions don't accept negative radius any more. - 2019/12/17 (1.75) - [undid this change in 1.76] made Columns() limited to 64 columns by asserting above that limit. While the current code technically supports it, future code may not so we're putting the restriction ahead. - 2019/12/13 (1.75) - [imgui_internal.h] changed ImRect() default constructor initializes all fields to 0.0f instead of (FLT_MAX,FLT_MAX,-FLT_MAX,-FLT_MAX). If you used ImRect::Add() to create bounding boxes by adding multiple points into it, you may need to fix your initial value. - 2019/12/08 (1.75) - removed redirecting functions/enums that were marked obsolete in 1.53 (December 2017): - ShowTestWindow() -> use ShowDemoWindow() - IsRootWindowFocused() -> use IsWindowFocused(ImGuiFocusedFlags_RootWindow) - IsRootWindowOrAnyChildFocused() -> use IsWindowFocused(ImGuiFocusedFlags_RootAndChildWindows) - SetNextWindowContentWidth(w) -> use SetNextWindowContentSize(ImVec2(w, 0.0f) - GetItemsLineHeightWithSpacing() -> use GetFrameHeightWithSpacing() - ImGuiCol_ChildWindowBg -> use ImGuiCol_ChildBg - ImGuiStyleVar_ChildWindowRounding -> use ImGuiStyleVar_ChildRounding - ImGuiTreeNodeFlags_AllowOverlapMode -> use ImGuiTreeNodeFlags_AllowItemOverlap - IMGUI_DISABLE_TEST_WINDOWS -> use IMGUI_DISABLE_DEMO_WINDOWS - 2019/12/08 (1.75) - obsoleted calling ImDrawList::PrimReserve() with a negative count (which was vaguely documented and rarely if ever used). Instead, we added an explicit PrimUnreserve() API. - 2019/12/06 (1.75) - removed implicit default parameter to IsMouseDragging(int button = 0) to be consistent with other mouse functions (none of the other functions have it). - 2019/11/21 (1.74) - ImFontAtlas::AddCustomRectRegular() now requires an ID larger than 0x110000 (instead of 0x10000) to conform with supporting Unicode planes 1-16 in a future update. ID below 0x110000 will now assert. - 2019/11/19 (1.74) - renamed IMGUI_DISABLE_FORMAT_STRING_FUNCTIONS to IMGUI_DISABLE_DEFAULT_FORMAT_FUNCTIONS for consistency. - 2019/11/19 (1.74) - renamed IMGUI_DISABLE_MATH_FUNCTIONS to IMGUI_DISABLE_DEFAULT_MATH_FUNCTIONS for consistency. - 2019/10/22 (1.74) - removed redirecting functions/enums that were marked obsolete in 1.52 (October 2017): - Begin() [old 5 args version] -> use Begin() [3 args], use SetNextWindowSize() SetNextWindowBgAlpha() if needed - IsRootWindowOrAnyChildHovered() -> use IsWindowHovered(ImGuiHoveredFlags_RootAndChildWindows) - AlignFirstTextHeightToWidgets() -> use AlignTextToFramePadding() - SetNextWindowPosCenter() -> use SetNextWindowPos() with a pivot of (0.5f, 0.5f) - ImFont::Glyph -> use ImFontGlyph - 2019/10/14 (1.74) - inputs: Fixed a miscalculation in the keyboard/mouse "typematic" repeat delay/rate calculation, used by keys and e.g. repeating mouse buttons as well as the GetKeyPressedAmount() function. if you were using a non-default value for io.KeyRepeatRate (previous default was 0.250), you can add +io.KeyRepeatDelay to it to compensate for the fix. The function was triggering on: 0.0 and (delay+rate*N) where (N>=1). Fixed formula responds to (N>=0). Effectively it made io.KeyRepeatRate behave like it was set to (io.KeyRepeatRate + io.KeyRepeatDelay). If you never altered io.KeyRepeatRate nor used GetKeyPressedAmount() this won't affect you. - 2019/07/15 (1.72) - removed TreeAdvanceToLabelPos() which is rarely used and only does SetCursorPosX(GetCursorPosX() + GetTreeNodeToLabelSpacing()). Kept redirection function (will obsolete). - 2019/07/12 (1.72) - renamed ImFontAtlas::CustomRect to ImFontAtlasCustomRect. Kept redirection typedef (will obsolete). - 2019/06/14 (1.72) - removed redirecting functions/enums names that were marked obsolete in 1.51 (June 2017): ImGuiCol_Column*, ImGuiSetCond_*, IsItemHoveredRect(), IsPosHoveringAnyWindow(), IsMouseHoveringAnyWindow(), IsMouseHoveringWindow(), IMGUI_ONCE_UPON_A_FRAME. Grep this log for details and new names, or see how they were implemented until 1.71. - 2019/06/07 (1.71) - rendering of child window outer decorations (bg color, border, scrollbars) is now performed as part of the parent window. If you have overlapping child windows in a same parent, and relied on their relative z-order to be mapped to their submission order, this will affect your rendering. This optimization is disabled if the parent window has no visual output, because it appears to be the most common situation leading to the creation of overlapping child windows. Please reach out if you are affected. - 2019/05/13 (1.71) - renamed SetNextTreeNodeOpen() to SetNextItemOpen(). Kept inline redirection function (will obsolete). - 2019/05/11 (1.71) - changed io.AddInputCharacter(unsigned short c) signature to io.AddInputCharacter(unsigned int c). - 2019/04/29 (1.70) - improved ImDrawList thick strokes (>1.0f) preserving correct thickness up to 90 degrees angles (e.g. rectangles). If you have custom rendering using thick lines, they will appear thicker now. - 2019/04/29 (1.70) - removed GetContentRegionAvailWidth(), use GetContentRegionAvail().x instead. Kept inline redirection function (will obsolete). - 2019/03/04 (1.69) - renamed GetOverlayDrawList() to GetForegroundDrawList(). Kept redirection function (will obsolete). - 2019/02/26 (1.69) - renamed ImGuiColorEditFlags_RGB/ImGuiColorEditFlags_HSV/ImGuiColorEditFlags_HEX to ImGuiColorEditFlags_DisplayRGB/ImGuiColorEditFlags_DisplayHSV/ImGuiColorEditFlags_DisplayHex. Kept redirection enums (will obsolete). - 2019/02/14 (1.68) - made it illegal/assert when io.DisplayTime == 0.0f (with an exception for the first frame). If for some reason your time step calculation gives you a zero value, replace it with an arbitrarily small value! - 2019/02/01 (1.68) - removed io.DisplayVisibleMin/DisplayVisibleMax (which were marked obsolete and removed from viewport/docking branch already). - 2019/01/06 (1.67) - renamed io.InputCharacters[], marked internal as was always intended. Please don't access directly, and use AddInputCharacter() instead! - 2019/01/06 (1.67) - renamed ImFontAtlas::GlyphRangesBuilder to ImFontGlyphRangesBuilder. Kept redirection typedef (will obsolete). - 2018/12/20 (1.67) - made it illegal to call Begin("") with an empty string. This somehow half-worked before but had various undesirable side-effects. - 2018/12/10 (1.67) - renamed io.ConfigResizeWindowsFromEdges to io.ConfigWindowsResizeFromEdges as we are doing a large pass on configuration flags. - 2018/10/12 (1.66) - renamed misc/stl/imgui_stl.* to misc/cpp/imgui_stdlib.* in prevision for other C++ helper files. - 2018/09/28 (1.66) - renamed SetScrollHere() to SetScrollHereY(). Kept redirection function (will obsolete). - 2018/09/06 (1.65) - renamed stb_truetype.h to imstb_truetype.h, stb_textedit.h to imstb_textedit.h, and stb_rect_pack.h to imstb_rectpack.h. If you were conveniently using the imgui copy of those STB headers in your project you will have to update your include paths. - 2018/09/05 (1.65) - renamed io.OptCursorBlink/io.ConfigCursorBlink to io.ConfigInputTextCursorBlink. (#1427) - 2018/08/31 (1.64) - added imgui_widgets.cpp file, extracted and moved widgets code out of imgui.cpp into imgui_widgets.cpp. Re-ordered some of the code remaining in imgui.cpp. NONE OF THE FUNCTIONS HAVE CHANGED. THE CODE IS SEMANTICALLY 100% IDENTICAL, BUT _EVERY_ FUNCTION HAS BEEN MOVED. Because of this, any local modifications to imgui.cpp will likely conflict when you update. Read docs/CHANGELOG.txt for suggestions. - 2018/08/22 (1.63) - renamed IsItemDeactivatedAfterChange() to IsItemDeactivatedAfterEdit() for consistency with new IsItemEdited() API. Kept redirection function (will obsolete soonish as IsItemDeactivatedAfterChange() is very recent). - 2018/08/21 (1.63) - renamed ImGuiTextEditCallback to ImGuiInputTextCallback, ImGuiTextEditCallbackData to ImGuiInputTextCallbackData for consistency. Kept redirection types (will obsolete). - 2018/08/21 (1.63) - removed ImGuiInputTextCallbackData::ReadOnly since it is a duplication of (ImGuiInputTextCallbackData::Flags & ImGuiInputTextFlags_ReadOnly). - 2018/08/01 (1.63) - removed per-window ImGuiWindowFlags_ResizeFromAnySide beta flag in favor of a global io.ConfigResizeWindowsFromEdges [update 1.67 renamed to ConfigWindowsResizeFromEdges] to enable the feature. - 2018/08/01 (1.63) - renamed io.OptCursorBlink to io.ConfigCursorBlink [-> io.ConfigInputTextCursorBlink in 1.65], io.OptMacOSXBehaviors to ConfigMacOSXBehaviors for consistency. - 2018/07/22 (1.63) - changed ImGui::GetTime() return value from float to double to avoid accumulating floating point imprecisions over time. - 2018/07/08 (1.63) - style: renamed ImGuiCol_ModalWindowDarkening to ImGuiCol_ModalWindowDimBg for consistency with other features. Kept redirection enum (will obsolete). - 2018/06/08 (1.62) - examples: the imgui_impl_XXX files have been split to separate platform (Win32, GLFW, SDL2, etc.) from renderer (DX11, OpenGL, Vulkan, etc.). old backends will still work as is, however prefer using the separated backends as they will be updated to support multi-viewports. when adopting new backends follow the main.cpp code of your preferred examples/ folder to know which functions to call. in particular, note that old backends called ImGui::NewFrame() at the end of their ImGui_ImplXXXX_NewFrame() function. - 2018/06/06 (1.62) - renamed GetGlyphRangesChinese() to GetGlyphRangesChineseFull() to distinguish other variants and discourage using the full set. - 2018/06/06 (1.62) - TreeNodeEx()/TreeNodeBehavior(): the ImGuiTreeNodeFlags_CollapsingHeader helper now include the ImGuiTreeNodeFlags_NoTreePushOnOpen flag. See Changelog for details. - 2018/05/03 (1.61) - DragInt(): the default compile-time format string has been changed from "%.0f" to "%d", as we are not using integers internally any more. If you used DragInt() with custom format strings, make sure you change them to use %d or an integer-compatible format. To honor backward-compatibility, the DragInt() code will currently parse and modify format strings to replace %*f with %d, giving time to users to upgrade their code. If you have IMGUI_DISABLE_OBSOLETE_FUNCTIONS enabled, the code will instead assert! You may run a reg-exp search on your codebase for e.g. "DragInt.*%f" to help you find them. - 2018/04/28 (1.61) - obsoleted InputFloat() functions taking an optional "int decimal_precision" in favor of an equivalent and more flexible "const char* format", consistent with other functions. Kept redirection functions (will obsolete). - 2018/04/09 (1.61) - IM_DELETE() helper function added in 1.60 doesn't clear the input _pointer_ reference, more consistent with expectation and allows passing r-value. - 2018/03/20 (1.60) - renamed io.WantMoveMouse to io.WantSetMousePos for consistency and ease of understanding (was added in 1.52, _not_ used by core and only honored by some backend ahead of merging the Nav branch). - 2018/03/12 (1.60) - removed ImGuiCol_CloseButton, ImGuiCol_CloseButtonActive, ImGuiCol_CloseButtonHovered as the closing cross uses regular button colors now. - 2018/03/08 (1.60) - changed ImFont::DisplayOffset.y to default to 0 instead of +1. Fixed rounding of Ascent/Descent to match TrueType renderer. If you were adding or subtracting to ImFont::DisplayOffset check if your fonts are correctly aligned vertically. - 2018/03/03 (1.60) - renamed ImGuiStyleVar_Count_ to ImGuiStyleVar_COUNT and ImGuiMouseCursor_Count_ to ImGuiMouseCursor_COUNT for consistency with other public enums. - 2018/02/18 (1.60) - BeginDragDropSource(): temporarily removed the optional mouse_button=0 parameter because it is not really usable in many situations at the moment. - 2018/02/16 (1.60) - obsoleted the io.RenderDrawListsFn callback, you can call your graphics engine render function after ImGui::Render(). Use ImGui::GetDrawData() to retrieve the ImDrawData* to display. - 2018/02/07 (1.60) - reorganized context handling to be more explicit, - YOU NOW NEED TO CALL ImGui::CreateContext() AT THE BEGINNING OF YOUR APP, AND CALL ImGui::DestroyContext() AT THE END. - removed Shutdown() function, as DestroyContext() serve this purpose. - you may pass a ImFontAtlas* pointer to CreateContext() to share a font atlas between contexts. Otherwise CreateContext() will create its own font atlas instance. - removed allocator parameters from CreateContext(), they are now setup with SetAllocatorFunctions(), and shared by all contexts. - removed the default global context and font atlas instance, which were confusing for users of DLL reloading and users of multiple contexts. - 2018/01/31 (1.60) - moved sample TTF files from extra_fonts/ to misc/fonts/. If you loaded files directly from the imgui repo you may need to update your paths. - 2018/01/11 (1.60) - obsoleted IsAnyWindowHovered() in favor of IsWindowHovered(ImGuiHoveredFlags_AnyWindow). Kept redirection function (will obsolete). - 2018/01/11 (1.60) - obsoleted IsAnyWindowFocused() in favor of IsWindowFocused(ImGuiFocusedFlags_AnyWindow). Kept redirection function (will obsolete). - 2018/01/03 (1.60) - renamed ImGuiSizeConstraintCallback to ImGuiSizeCallback, ImGuiSizeConstraintCallbackData to ImGuiSizeCallbackData. - 2017/12/29 (1.60) - removed CalcItemRectClosestPoint() which was weird and not really used by anyone except demo code. If you need it it's easy to replicate on your side. - 2017/12/24 (1.53) - renamed the emblematic ShowTestWindow() function to ShowDemoWindow(). Kept redirection function (will obsolete). - 2017/12/21 (1.53) - ImDrawList: renamed style.AntiAliasedShapes to style.AntiAliasedFill for consistency and as a way to explicitly break code that manipulate those flag at runtime. You can now manipulate ImDrawList::Flags - 2017/12/21 (1.53) - ImDrawList: removed 'bool anti_aliased = true' final parameter of ImDrawList::AddPolyline() and ImDrawList::AddConvexPolyFilled(). Prefer manipulating ImDrawList::Flags if you need to toggle them during the frame. - 2017/12/14 (1.53) - using the ImGuiWindowFlags_NoScrollWithMouse flag on a child window forwards the mouse wheel event to the parent window, unless either ImGuiWindowFlags_NoInputs or ImGuiWindowFlags_NoScrollbar are also set. - 2017/12/13 (1.53) - renamed GetItemsLineHeightWithSpacing() to GetFrameHeightWithSpacing(). Kept redirection function (will obsolete). - 2017/12/13 (1.53) - obsoleted IsRootWindowFocused() in favor of using IsWindowFocused(ImGuiFocusedFlags_RootWindow). Kept redirection function (will obsolete). - obsoleted IsRootWindowOrAnyChildFocused() in favor of using IsWindowFocused(ImGuiFocusedFlags_RootAndChildWindows). Kept redirection function (will obsolete). - 2017/12/12 (1.53) - renamed ImGuiTreeNodeFlags_AllowOverlapMode to ImGuiTreeNodeFlags_AllowItemOverlap. Kept redirection enum (will obsolete). - 2017/12/10 (1.53) - removed SetNextWindowContentWidth(), prefer using SetNextWindowContentSize(). Kept redirection function (will obsolete). - 2017/11/27 (1.53) - renamed ImGuiTextBuffer::append() helper to appendf(), appendv() to appendfv(). If you copied the 'Log' demo in your code, it uses appendv() so that needs to be renamed. - 2017/11/18 (1.53) - Style, Begin: removed ImGuiWindowFlags_ShowBorders window flag. Borders are now fully set up in the ImGuiStyle structure (see e.g. style.FrameBorderSize, style.WindowBorderSize). Use ImGui::ShowStyleEditor() to look them up. Please note that the style system will keep evolving (hopefully stabilizing in Q1 2018), and so custom styles will probably subtly break over time. It is recommended you use the StyleColorsClassic(), StyleColorsDark(), StyleColorsLight() functions. - 2017/11/18 (1.53) - Style: removed ImGuiCol_ComboBg in favor of combo boxes using ImGuiCol_PopupBg for consistency. - 2017/11/18 (1.53) - Style: renamed ImGuiCol_ChildWindowBg to ImGuiCol_ChildBg. - 2017/11/18 (1.53) - Style: renamed style.ChildWindowRounding to style.ChildRounding, ImGuiStyleVar_ChildWindowRounding to ImGuiStyleVar_ChildRounding. - 2017/11/02 (1.53) - obsoleted IsRootWindowOrAnyChildHovered() in favor of using IsWindowHovered(ImGuiHoveredFlags_RootAndChildWindows); - 2017/10/24 (1.52) - renamed IMGUI_DISABLE_WIN32_DEFAULT_CLIPBOARD_FUNCS/IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCS to IMGUI_DISABLE_WIN32_DEFAULT_CLIPBOARD_FUNCTIONS/IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCTIONS for consistency. - 2017/10/20 (1.52) - changed IsWindowHovered() default parameters behavior to return false if an item is active in another window (e.g. click-dragging item from another window to this window). You can use the newly introduced IsWindowHovered() flags to requests this specific behavior if you need it. - 2017/10/20 (1.52) - marked IsItemHoveredRect()/IsMouseHoveringWindow() as obsolete, in favor of using the newly introduced flags for IsItemHovered() and IsWindowHovered(). See https://github.com/ocornut/imgui/issues/1382 for details. removed the IsItemRectHovered()/IsWindowRectHovered() names introduced in 1.51 since they were merely more consistent names for the two functions we are now obsoleting. IsItemHoveredRect() --> IsItemHovered(ImGuiHoveredFlags_RectOnly) IsMouseHoveringAnyWindow() --> IsWindowHovered(ImGuiHoveredFlags_AnyWindow) IsMouseHoveringWindow() --> IsWindowHovered(ImGuiHoveredFlags_AllowWhenBlockedByPopup | ImGuiHoveredFlags_AllowWhenBlockedByActiveItem) [weird, old behavior] - 2017/10/17 (1.52) - marked the old 5-parameters version of Begin() as obsolete (still available). Use SetNextWindowSize()+Begin() instead! - 2017/10/11 (1.52) - renamed AlignFirstTextHeightToWidgets() to AlignTextToFramePadding(). Kept inline redirection function (will obsolete). - 2017/09/26 (1.52) - renamed ImFont::Glyph to ImFontGlyph. Kept redirection typedef (will obsolete). - 2017/09/25 (1.52) - removed SetNextWindowPosCenter() because SetNextWindowPos() now has the optional pivot information to do the same and more. Kept redirection function (will obsolete). - 2017/08/25 (1.52) - io.MousePos needs to be set to ImVec2(-FLT_MAX,-FLT_MAX) when mouse is unavailable/missing. Previously ImVec2(-1,-1) was enough but we now accept negative mouse coordinates. In your backend if you need to support unavailable mouse, make sure to replace "io.MousePos = ImVec2(-1,-1)" with "io.MousePos = ImVec2(-FLT_MAX,-FLT_MAX)". - 2017/08/22 (1.51) - renamed IsItemHoveredRect() to IsItemRectHovered(). Kept inline redirection function (will obsolete). -> (1.52) use IsItemHovered(ImGuiHoveredFlags_RectOnly)! - renamed IsMouseHoveringAnyWindow() to IsAnyWindowHovered() for consistency. Kept inline redirection function (will obsolete). - renamed IsMouseHoveringWindow() to IsWindowRectHovered() for consistency. Kept inline redirection function (will obsolete). - 2017/08/20 (1.51) - renamed GetStyleColName() to GetStyleColorName() for consistency. - 2017/08/20 (1.51) - added PushStyleColor(ImGuiCol idx, ImU32 col) overload, which _might_ cause an "ambiguous call" compilation error if you are using ImColor() with implicit cast. Cast to ImU32 or ImVec4 explicily to fix. - 2017/08/15 (1.51) - marked the weird IMGUI_ONCE_UPON_A_FRAME helper macro as obsolete. prefer using the more explicit ImGuiOnceUponAFrame type. - 2017/08/15 (1.51) - changed parameter order for BeginPopupContextWindow() from (const char*,int buttons,bool also_over_items) to (const char*,int buttons,bool also_over_items). Note that most calls relied on default parameters completely. - 2017/08/13 (1.51) - renamed ImGuiCol_Column to ImGuiCol_Separator, ImGuiCol_ColumnHovered to ImGuiCol_SeparatorHovered, ImGuiCol_ColumnActive to ImGuiCol_SeparatorActive. Kept redirection enums (will obsolete). - 2017/08/11 (1.51) - renamed ImGuiSetCond_Always to ImGuiCond_Always, ImGuiSetCond_Once to ImGuiCond_Once, ImGuiSetCond_FirstUseEver to ImGuiCond_FirstUseEver, ImGuiSetCond_Appearing to ImGuiCond_Appearing. Kept redirection enums (will obsolete). - 2017/08/09 (1.51) - removed ValueColor() helpers, they are equivalent to calling Text(label) + SameLine() + ColorButton(). - 2017/08/08 (1.51) - removed ColorEditMode() and ImGuiColorEditMode in favor of ImGuiColorEditFlags and parameters to the various Color*() functions. The SetColorEditOptions() allows to initialize default but the user can still change them with right-click context menu. - changed prototype of 'ColorEdit4(const char* label, float col[4], bool show_alpha = true)' to 'ColorEdit4(const char* label, float col[4], ImGuiColorEditFlags flags = 0)', where passing flags = 0x01 is a safe no-op (hello dodgy backward compatibility!). - check and run the demo window, under "Color/Picker Widgets", to understand the various new options. - changed prototype of rarely used 'ColorButton(ImVec4 col, bool small_height = false, bool outline_border = true)' to 'ColorButton(const char* desc_id, ImVec4 col, ImGuiColorEditFlags flags = 0, ImVec2 size = ImVec2(0, 0))' - 2017/07/20 (1.51) - removed IsPosHoveringAnyWindow(ImVec2), which was partly broken and misleading. ASSERT + redirect user to io.WantCaptureMouse - 2017/05/26 (1.50) - removed ImFontConfig::MergeGlyphCenterV in favor of a more multipurpose ImFontConfig::GlyphOffset. - 2017/05/01 (1.50) - renamed ImDrawList::PathFill() (rarely used directly) to ImDrawList::PathFillConvex() for clarity. - 2016/11/06 (1.50) - BeginChild(const char*) now applies the stack id to the provided label, consistently with other functions as it should always have been. It shouldn't affect you unless (extremely unlikely) you were appending multiple times to a same child from different locations of the stack id. If that's the case, generate an id with GetID() and use it instead of passing string to BeginChild(). - 2016/10/15 (1.50) - avoid 'void* user_data' parameter to io.SetClipboardTextFn/io.GetClipboardTextFn pointers. We pass io.ClipboardUserData to it. - 2016/09/25 (1.50) - style.WindowTitleAlign is now a ImVec2 (ImGuiAlign enum was removed). set to (0.5f,0.5f) for horizontal+vertical centering, (0.0f,0.0f) for upper-left, etc. - 2016/07/30 (1.50) - SameLine(x) with x>0.0f is now relative to left of column/group if any, and not always to left of window. This was sort of always the intent and hopefully, breakage should be minimal. - 2016/05/12 (1.49) - title bar (using ImGuiCol_TitleBg/ImGuiCol_TitleBgActive colors) isn't rendered over a window background (ImGuiCol_WindowBg color) anymore. If your TitleBg/TitleBgActive alpha was 1.0f or you are using the default theme it will not affect you, otherwise if <1.0f you need to tweak your custom theme to readjust for the fact that we don't draw a WindowBg background behind the title bar. This helper function will convert an old TitleBg/TitleBgActive color into a new one with the same visual output, given the OLD color and the OLD WindowBg color: ImVec4 ConvertTitleBgCol(const ImVec4& win_bg_col, const ImVec4& title_bg_col) { float new_a = 1.0f - ((1.0f - win_bg_col.w) * (1.0f - title_bg_col.w)), k = title_bg_col.w / new_a; return ImVec4((win_bg_col.x * win_bg_col.w + title_bg_col.x) * k, (win_bg_col.y * win_bg_col.w + title_bg_col.y) * k, (win_bg_col.z * win_bg_col.w + title_bg_col.z) * k, new_a); } If this is confusing, pick the RGB value from title bar from an old screenshot and apply this as TitleBg/TitleBgActive. Or you may just create TitleBgActive from a tweaked TitleBg color. - 2016/05/07 (1.49) - removed confusing set of GetInternalState(), GetInternalStateSize(), SetInternalState() functions. Now using CreateContext(), DestroyContext(), GetCurrentContext(), SetCurrentContext(). - 2016/05/02 (1.49) - renamed SetNextTreeNodeOpened() to SetNextTreeNodeOpen(), no redirection. - 2016/05/01 (1.49) - obsoleted old signature of CollapsingHeader(const char* label, const char* str_id = NULL, bool display_frame = true, bool default_open = false) as extra parameters were badly designed and rarely used. You can replace the "default_open = true" flag in new API with CollapsingHeader(label, ImGuiTreeNodeFlags_DefaultOpen). - 2016/04/26 (1.49) - changed ImDrawList::PushClipRect(ImVec4 rect) to ImDrawList::PushClipRect(Imvec2 min,ImVec2 max,bool intersect_with_current_clip_rect=false). Note that higher-level ImGui::PushClipRect() is preferable because it will clip at logic/widget level, whereas ImDrawList::PushClipRect() only affect your renderer. - 2016/04/03 (1.48) - removed style.WindowFillAlphaDefault setting which was redundant. Bake default BG alpha inside style.Colors[ImGuiCol_WindowBg] and all other Bg color values. (ref GitHub issue #337). - 2016/04/03 (1.48) - renamed ImGuiCol_TooltipBg to ImGuiCol_PopupBg, used by popups/menus and tooltips. popups/menus were previously using ImGuiCol_WindowBg. (ref github issue #337) - 2016/03/21 (1.48) - renamed GetWindowFont() to GetFont(), GetWindowFontSize() to GetFontSize(). Kept inline redirection function (will obsolete). - 2016/03/02 (1.48) - InputText() completion/history/always callbacks: if you modify the text buffer manually (without using DeleteChars()/InsertChars() helper) you need to maintain the BufTextLen field. added an assert. - 2016/01/23 (1.48) - fixed not honoring exact width passed to PushItemWidth(), previously it would add extra FramePadding.x*2 over that width. if you had manual pixel-perfect alignment in place it might affect you. - 2015/12/27 (1.48) - fixed ImDrawList::AddRect() which used to render a rectangle 1 px too large on each axis. - 2015/12/04 (1.47) - renamed Color() helpers to ValueColor() - dangerously named, rarely used and probably to be made obsolete. - 2015/08/29 (1.45) - with the addition of horizontal scrollbar we made various fixes to inconsistencies with dealing with cursor position. GetCursorPos()/SetCursorPos() functions now include the scrolled amount. It shouldn't affect the majority of users, but take note that SetCursorPosX(100.0f) puts you at +100 from the starting x position which may include scrolling, not at +100 from the window left side. GetContentRegionMax()/GetWindowContentRegionMin()/GetWindowContentRegionMax() functions allow include the scrolled amount. Typically those were used in cases where no scrolling would happen so it may not be a problem, but watch out! - 2015/08/29 (1.45) - renamed style.ScrollbarWidth to style.ScrollbarSize - 2015/08/05 (1.44) - split imgui.cpp into extra files: imgui_demo.cpp imgui_draw.cpp imgui_internal.h that you need to add to your project. - 2015/07/18 (1.44) - fixed angles in ImDrawList::PathArcTo(), PathArcToFast() (introduced in 1.43) being off by an extra PI for no justifiable reason - 2015/07/14 (1.43) - add new ImFontAtlas::AddFont() API. For the old AddFont***, moved the 'font_no' parameter of ImFontAtlas::AddFont** functions to the ImFontConfig structure. you need to render your textured triangles with bilinear filtering to benefit from sub-pixel positioning of text. - 2015/07/08 (1.43) - switched rendering data to use indexed rendering. this is saving a fair amount of CPU/GPU and enables us to get anti-aliasing for a marginal cost. this necessary change will break your rendering function! the fix should be very easy. sorry for that :( - if you are using a vanilla copy of one of the imgui_impl_XXX.cpp provided in the example, you just need to update your copy and you can ignore the rest. - the signature of the io.RenderDrawListsFn handler has changed! old: ImGui_XXXX_RenderDrawLists(ImDrawList** const cmd_lists, int cmd_lists_count) new: ImGui_XXXX_RenderDrawLists(ImDrawData* draw_data). parameters: 'cmd_lists' becomes 'draw_data->CmdLists', 'cmd_lists_count' becomes 'draw_data->CmdListsCount' ImDrawList: 'commands' becomes 'CmdBuffer', 'vtx_buffer' becomes 'VtxBuffer', 'IdxBuffer' is new. ImDrawCmd: 'vtx_count' becomes 'ElemCount', 'clip_rect' becomes 'ClipRect', 'user_callback' becomes 'UserCallback', 'texture_id' becomes 'TextureId'. - each ImDrawList now contains both a vertex buffer and an index buffer. For each command, render ElemCount/3 triangles using indices from the index buffer. - if you REALLY cannot render indexed primitives, you can call the draw_data->DeIndexAllBuffers() method to de-index the buffers. This is slow and a waste of CPU/GPU. Prefer using indexed rendering! - refer to code in the examples/ folder or ask on the GitHub if you are unsure of how to upgrade. please upgrade! - 2015/07/10 (1.43) - changed SameLine() parameters from int to float. - 2015/07/02 (1.42) - renamed SetScrollPosHere() to SetScrollFromCursorPos(). Kept inline redirection function (will obsolete). - 2015/07/02 (1.42) - renamed GetScrollPosY() to GetScrollY(). Necessary to reduce confusion along with other scrolling functions, because positions (e.g. cursor position) are not equivalent to scrolling amount. - 2015/06/14 (1.41) - changed ImageButton() default bg_col parameter from (0,0,0,1) (black) to (0,0,0,0) (transparent) - makes a difference when texture have transparence - 2015/06/14 (1.41) - changed Selectable() API from (label, selected, size) to (label, selected, flags, size). Size override should have been rarely used. Sorry! - 2015/05/31 (1.40) - renamed GetWindowCollapsed() to IsWindowCollapsed() for consistency. Kept inline redirection function (will obsolete). - 2015/05/31 (1.40) - renamed IsRectClipped() to IsRectVisible() for consistency. Note that return value is opposite! Kept inline redirection function (will obsolete). - 2015/05/27 (1.40) - removed the third 'repeat_if_held' parameter from Button() - sorry! it was rarely used and inconsistent. Use PushButtonRepeat(true) / PopButtonRepeat() to enable repeat on desired buttons. - 2015/05/11 (1.40) - changed BeginPopup() API, takes a string identifier instead of a bool. ImGui needs to manage the open/closed state of popups. Call OpenPopup() to actually set the "open" state of a popup. BeginPopup() returns true if the popup is opened. - 2015/05/03 (1.40) - removed style.AutoFitPadding, using style.WindowPadding makes more sense (the default values were already the same). - 2015/04/13 (1.38) - renamed IsClipped() to IsRectClipped(). Kept inline redirection function until 1.50. - 2015/04/09 (1.38) - renamed ImDrawList::AddArc() to ImDrawList::AddArcFast() for compatibility with future API - 2015/04/03 (1.38) - removed ImGuiCol_CheckHovered, ImGuiCol_CheckActive, replaced with the more general ImGuiCol_FrameBgHovered, ImGuiCol_FrameBgActive. - 2014/04/03 (1.38) - removed support for passing -FLT_MAX..+FLT_MAX as the range for a SliderFloat(). Use DragFloat() or Inputfloat() instead. - 2015/03/17 (1.36) - renamed GetItemBoxMin()/GetItemBoxMax()/IsMouseHoveringBox() to GetItemRectMin()/GetItemRectMax()/IsMouseHoveringRect(). Kept inline redirection function until 1.50. - 2015/03/15 (1.36) - renamed style.TreeNodeSpacing to style.IndentSpacing, ImGuiStyleVar_TreeNodeSpacing to ImGuiStyleVar_IndentSpacing - 2015/03/13 (1.36) - renamed GetWindowIsFocused() to IsWindowFocused(). Kept inline redirection function until 1.50. - 2015/03/08 (1.35) - renamed style.ScrollBarWidth to style.ScrollbarWidth (casing) - 2015/02/27 (1.34) - renamed OpenNextNode(bool) to SetNextTreeNodeOpened(bool, ImGuiSetCond). Kept inline redirection function until 1.50. - 2015/02/27 (1.34) - renamed ImGuiSetCondition_*** to ImGuiSetCond_***, and _FirstUseThisSession becomes _Once. - 2015/02/11 (1.32) - changed text input callback ImGuiTextEditCallback return type from void-->int. reserved for future use, return 0 for now. - 2015/02/10 (1.32) - renamed GetItemWidth() to CalcItemWidth() to clarify its evolving behavior - 2015/02/08 (1.31) - renamed GetTextLineSpacing() to GetTextLineHeightWithSpacing() - 2015/02/01 (1.31) - removed IO.MemReallocFn (unused) - 2015/01/19 (1.30) - renamed ImGuiStorage::GetIntPtr()/GetFloatPtr() to GetIntRef()/GetIntRef() because Ptr was conflicting with actual pointer storage functions. - 2015/01/11 (1.30) - big font/image API change! now loads TTF file. allow for multiple fonts. no need for a PNG loader. - 2015/01/11 (1.30) - removed GetDefaultFontData(). uses io.Fonts->GetTextureData*() API to retrieve uncompressed pixels. - old: const void* png_data; unsigned int png_size; ImGui::GetDefaultFontData(NULL, NULL, &png_data, &png_size); [..Upload texture to GPU..]; - new: unsigned char* pixels; int width, height; io.Fonts->GetTexDataAsRGBA32(&pixels, &width, &height); [..Upload texture to GPU..]; io.Fonts->SetTexID(YourTexIdentifier); you now have more flexibility to load multiple TTF fonts and manage the texture buffer for internal needs. It is now recommended that you sample the font texture with bilinear interpolation. - 2015/01/11 (1.30) - added texture identifier in ImDrawCmd passed to your render function (we can now render images). make sure to call io.Fonts->SetTexID() - 2015/01/11 (1.30) - removed IO.PixelCenterOffset (unnecessary, can be handled in user projection matrix) - 2015/01/11 (1.30) - removed ImGui::IsItemFocused() in favor of ImGui::IsItemActive() which handles all widgets - 2014/12/10 (1.18) - removed SetNewWindowDefaultPos() in favor of new generic API SetNextWindowPos(pos, ImGuiSetCondition_FirstUseEver) - 2014/11/28 (1.17) - moved IO.Font*** options to inside the IO.Font-> structure (FontYOffset, FontTexUvForWhite, FontBaseScale, FontFallbackGlyph) - 2014/11/26 (1.17) - reworked syntax of IMGUI_ONCE_UPON_A_FRAME helper macro to increase compiler compatibility - 2014/11/07 (1.15) - renamed IsHovered() to IsItemHovered() - 2014/10/02 (1.14) - renamed IMGUI_INCLUDE_IMGUI_USER_CPP to IMGUI_INCLUDE_IMGUI_USER_INL and imgui_user.cpp to imgui_user.inl (more IDE friendly) - 2014/09/25 (1.13) - removed 'text_end' parameter from IO.SetClipboardTextFn (the string is now always zero-terminated for simplicity) - 2014/09/24 (1.12) - renamed SetFontScale() to SetWindowFontScale() - 2014/09/24 (1.12) - moved IM_MALLOC/IM_REALLOC/IM_FREE preprocessor defines to IO.MemAllocFn/IO.MemReallocFn/IO.MemFreeFn - 2014/08/30 (1.09) - removed IO.FontHeight (now computed automatically) - 2014/08/30 (1.09) - moved IMGUI_FONT_TEX_UV_FOR_WHITE preprocessor define to IO.FontTexUvForWhite - 2014/08/28 (1.09) - changed the behavior of IO.PixelCenterOffset following various rendering fixes FREQUENTLY ASKED QUESTIONS (FAQ) ================================ Read all answers online: https://www.dearimgui.com/faq or https://github.com/ocornut/imgui/blob/master/docs/FAQ.md (same url) Read all answers locally (with a text editor or ideally a Markdown viewer): docs/FAQ.md Some answers are copied down here to facilitate searching in code. Q&A: Basics =========== Q: Where is the documentation? A: This library is poorly documented at the moment and expects the user to be acquainted with C/C++. - Run the examples/ applications and explore them. - Read Getting Started (https://github.com/ocornut/imgui/wiki/Getting-Started) guide. - See demo code in imgui_demo.cpp and particularly the ImGui::ShowDemoWindow() function. - The demo covers most features of Dear ImGui, so you can read the code and see its output. - See documentation and comments at the top of imgui.cpp + effectively imgui.h. - 20+ standalone example applications using e.g. OpenGL/DirectX are provided in the examples/ folder to explain how to integrate Dear ImGui with your own engine/application. - The Wiki (https://github.com/ocornut/imgui/wiki) has many resources and links. - The Glossary (https://github.com/ocornut/imgui/wiki/Glossary) page also may be useful. - Your programming IDE is your friend, find the type or function declaration to find comments associated with it. Q: What is this library called? Q: Which version should I get? >> This library is called "Dear ImGui", please don't call it "ImGui" :) >> See https://www.dearimgui.com/faq for details. Q&A: Integration ================ Q: How to get started? A: Read https://github.com/ocornut/imgui/wiki/Getting-Started. Read 'PROGRAMMER GUIDE' above. Read examples/README.txt. Q: How can I tell whether to dispatch mouse/keyboard to Dear ImGui or my application? A: You should read the 'io.WantCaptureMouse', 'io.WantCaptureKeyboard' and 'io.WantTextInput' flags! >> See https://www.dearimgui.com/faq for a fully detailed answer. You really want to read this. Q. How can I enable keyboard or gamepad controls? Q: How can I use this on a machine without mouse, keyboard or screen? (input share, remote display) Q: I integrated Dear ImGui in my engine and little squares are showing instead of text... Q: I integrated Dear ImGui in my engine and some elements are clipping or disappearing when I move windows around... Q: I integrated Dear ImGui in my engine and some elements are displaying outside their expected windows boundaries... >> See https://www.dearimgui.com/faq Q&A: Usage ---------- Q: About the ID Stack system.. - Why is my widget not reacting when I click on it? - How can I have widgets with an empty label? - How can I have multiple widgets with the same label? - How can I have multiple windows with the same label? Q: How can I display an image? What is ImTextureID, how does it work? Q: How can I use my own math types instead of ImVec2? Q: How can I interact with standard C++ types (such as std::string and std::vector)? Q: How can I display custom shapes? (using low-level ImDrawList API) >> See https://www.dearimgui.com/faq Q&A: Fonts, Text ================ Q: How should I handle DPI in my application? Q: How can I load a different font than the default? Q: How can I easily use icons in my application? Q: How can I load multiple fonts? Q: How can I display and input non-Latin characters such as Chinese, Japanese, Korean, Cyrillic? >> See https://www.dearimgui.com/faq and https://github.com/ocornut/imgui/blob/master/docs/FONTS.md Q&A: Concerns ============= Q: Who uses Dear ImGui? Q: Can you create elaborate/serious tools with Dear ImGui? Q: Can you reskin the look of Dear ImGui? Q: Why using C++ (as opposed to C)? >> See https://www.dearimgui.com/faq Q&A: Community ============== Q: How can I help? A: - Businesses: please reach out to "omar AT dearimgui DOT com" if you work in a place using Dear ImGui! We can discuss ways for your company to fund development via invoiced technical support, maintenance or sponsoring contacts. This is among the most useful thing you can do for Dear ImGui. With increased funding, we sustain and grow work on this project. >>> See https://github.com/ocornut/imgui/wiki/Funding - Businesses: you can also purchase licenses for the Dear ImGui Automation/Test Engine. - If you are experienced with Dear ImGui and C++, look at the GitHub issues, look at the Wiki, and see how you want to help and can help! - Disclose your usage of Dear ImGui via a dev blog post, a tweet, a screenshot, a mention somewhere etc. You may post screenshot or links in the gallery threads. Visuals are ideal as they inspire other programmers. But even without visuals, disclosing your use of dear imgui helps the library grow credibility, and help other teams and programmers with taking decisions. - If you have issues or if you need to hack into the library, even if you don't expect any support it is useful that you share your issues (on GitHub or privately). */ //------------------------------------------------------------------------- // [SECTION] INCLUDES //------------------------------------------------------------------------- #if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_WARNINGS) #define _CRT_SECURE_NO_WARNINGS #endif #ifndef IMGUI_DEFINE_MATH_OPERATORS #define IMGUI_DEFINE_MATH_OPERATORS #endif #include "imgui.h" #ifndef IMGUI_DISABLE #include "imgui_internal.h" // System includes #include // vsnprintf, sscanf, printf #include // intptr_t // [Windows] On non-Visual Studio compilers, we default to IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCTIONS unless explicitly enabled #if defined(_WIN32) && !defined(_MSC_VER) && !defined(IMGUI_ENABLE_WIN32_DEFAULT_IME_FUNCTIONS) && !defined(IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCTIONS) #define IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCTIONS #endif // [Windows] OS specific includes (optional) #if defined(_WIN32) && defined(IMGUI_DISABLE_DEFAULT_FILE_FUNCTIONS) && defined(IMGUI_DISABLE_WIN32_DEFAULT_CLIPBOARD_FUNCTIONS) && defined(IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCTIONS) && defined(IMGUI_DISABLE_DEFAULT_SHELL_FUNCTIONS) && !defined(IMGUI_DISABLE_WIN32_FUNCTIONS) #define IMGUI_DISABLE_WIN32_FUNCTIONS #endif #if defined(_WIN32) && !defined(IMGUI_DISABLE_WIN32_FUNCTIONS) #ifndef WIN32_LEAN_AND_MEAN #define WIN32_LEAN_AND_MEAN #endif #ifndef NOMINMAX #define NOMINMAX #endif #ifndef __MINGW32__ #include // _wfopen, OpenClipboard #else #include #endif #if defined(WINAPI_FAMILY) && ((defined(WINAPI_FAMILY_APP) && WINAPI_FAMILY == WINAPI_FAMILY_APP) || (defined(WINAPI_FAMILY_GAMES) && WINAPI_FAMILY == WINAPI_FAMILY_GAMES)) // The UWP and GDK Win32 API subsets don't support clipboard nor IME functions #define IMGUI_DISABLE_WIN32_DEFAULT_CLIPBOARD_FUNCTIONS #define IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCTIONS #define IMGUI_DISABLE_DEFAULT_SHELL_FUNCTIONS #endif #endif // [Apple] OS specific includes #if defined(__APPLE__) #include #endif // Visual Studio warnings #ifdef _MSC_VER #pragma warning (disable: 4127) // condition expression is constant #pragma warning (disable: 4996) // 'This function or variable may be unsafe': strcpy, strdup, sprintf, vsnprintf, sscanf, fopen #if defined(_MSC_VER) && _MSC_VER >= 1922 // MSVC 2019 16.2 or later #pragma warning (disable: 5054) // operator '|': deprecated between enumerations of different types #endif #pragma warning (disable: 26451) // [Static Analyzer] Arithmetic overflow : Using operator 'xxx' on a 4 byte value and then casting the result to an 8 byte value. Cast the value to the wider type before calling operator 'xxx' to avoid overflow(io.2). #pragma warning (disable: 26495) // [Static Analyzer] Variable 'XXX' is uninitialized. Always initialize a member variable (type.6). #pragma warning (disable: 26812) // [Static Analyzer] The enum type 'xxx' is unscoped. Prefer 'enum class' over 'enum' (Enum.3). #endif // Clang/GCC warnings with -Weverything #if defined(__clang__) #if __has_warning("-Wunknown-warning-option") #pragma clang diagnostic ignored "-Wunknown-warning-option" // warning: unknown warning group 'xxx' // not all warnings are known by all Clang versions and they tend to be rename-happy.. so ignoring warnings triggers new warnings on some configuration. Great! #endif #pragma clang diagnostic ignored "-Wunknown-pragmas" // warning: unknown warning group 'xxx' #pragma clang diagnostic ignored "-Wold-style-cast" // warning: use of old-style cast // yes, they are more terse. #pragma clang diagnostic ignored "-Wfloat-equal" // warning: comparing floating point with == or != is unsafe // storing and comparing against same constants (typically 0.0f) is ok. #pragma clang diagnostic ignored "-Wformat" // warning: format specifies type 'int' but the argument has type 'unsigned int' #pragma clang diagnostic ignored "-Wformat-nonliteral" // warning: format string is not a string literal // passing non-literal to vsnformat(). yes, user passing incorrect format strings can crash the code. #pragma clang diagnostic ignored "-Wformat-pedantic" // warning: format specifies type 'void *' but the argument has type 'xxxx *' // unreasonable, would lead to casting every %p arg to void*. probably enabled by -pedantic. #pragma clang diagnostic ignored "-Wexit-time-destructors" // warning: declaration requires an exit-time destructor // exit-time destruction order is undefined. if MemFree() leads to users code that has been disabled before exit it might cause problems. ImGui coding style welcomes static/globals. #pragma clang diagnostic ignored "-Wglobal-constructors" // warning: declaration requires a global destructor // similar to above, not sure what the exact difference is. #pragma clang diagnostic ignored "-Wsign-conversion" // warning: implicit conversion changes signedness #pragma clang diagnostic ignored "-Wint-to-void-pointer-cast" // warning: cast to 'void *' from smaller integer type 'int' #pragma clang diagnostic ignored "-Wzero-as-null-pointer-constant" // warning: zero as null pointer constant // some standard header variations use #define NULL 0 #pragma clang diagnostic ignored "-Wdouble-promotion" // warning: implicit conversion from 'float' to 'double' when passing argument to function // using printf() is a misery with this as C++ va_arg ellipsis changes float to double. #pragma clang diagnostic ignored "-Wimplicit-int-float-conversion" // warning: implicit conversion from 'xxx' to 'float' may lose precision #pragma clang diagnostic ignored "-Wunsafe-buffer-usage" // warning: 'xxx' is an unsafe pointer used for buffer access #pragma clang diagnostic ignored "-Wnontrivial-memaccess" // warning: first argument in call to 'memset' is a pointer to non-trivially copyable type #pragma clang diagnostic ignored "-Wswitch-default" // warning: 'switch' missing 'default' label #elif defined(__GNUC__) // We disable -Wpragmas because GCC doesn't provide a has_warning equivalent and some forks/patches may not follow the warning/version association. #pragma GCC diagnostic ignored "-Wpragmas" // warning: unknown option after '#pragma GCC diagnostic' kind #pragma GCC diagnostic ignored "-Wunused-function" // warning: 'xxxx' defined but not used #pragma GCC diagnostic ignored "-Wint-to-pointer-cast" // warning: cast to pointer from integer of different size #pragma GCC diagnostic ignored "-Wfloat-equal" // warning: comparing floating-point with '==' or '!=' is unsafe #pragma GCC diagnostic ignored "-Wformat" // warning: format '%p' expects argument of type 'int'/'void*', but argument X has type 'unsigned int'/'ImGuiWindow*' #pragma GCC diagnostic ignored "-Wdouble-promotion" // warning: implicit conversion from 'float' to 'double' when passing argument to function #pragma GCC diagnostic ignored "-Wconversion" // warning: conversion to 'xxxx' from 'xxxx' may alter its value #pragma GCC diagnostic ignored "-Wformat-nonliteral" // warning: format not a string literal, format string not checked #pragma GCC diagnostic ignored "-Wstrict-overflow" // warning: assuming signed overflow does not occur when assuming that (X - c) > X is always false #pragma GCC diagnostic ignored "-Wclass-memaccess" // [__GNUC__ >= 8] warning: 'memset/memcpy' clearing/writing an object of type 'xxxx' with no trivial copy-assignment; use assignment or value-initialization instead #pragma GCC diagnostic ignored "-Wcast-qual" // warning: cast from type 'const xxxx *' to type 'xxxx *' casts away qualifiers #endif // Debug options #define IMGUI_DEBUG_NAV_SCORING 0 // Display navigation scoring preview when hovering items. Hold CTRL to display for all candidates. CTRL+Arrow to change last direction. #define IMGUI_DEBUG_NAV_RECTS 0 // Display the reference navigation rectangle for each window // When using CTRL+TAB (or Gamepad Square+L/R) we delay the visual a little in order to reduce visual noise doing a fast switch. static const float NAV_WINDOWING_HIGHLIGHT_DELAY = 0.20f; // Time before the highlight and screen dimming starts fading in static const float NAV_WINDOWING_LIST_APPEAR_DELAY = 0.15f; // Time before the window list starts to appear static const float NAV_ACTIVATE_HIGHLIGHT_TIMER = 0.10f; // Time to highlight an item activated by a shortcut. static const float WINDOWS_RESIZE_FROM_EDGES_FEEDBACK_TIMER = 0.04f; // Reduce visual noise by only highlighting the border after a certain time. static const float WINDOWS_MOUSE_WHEEL_SCROLL_LOCK_TIMER = 0.70f; // Lock scrolled window (so it doesn't pick child windows that are scrolling through) for a certain time, unless mouse moved. // Tooltip offset static const ImVec2 TOOLTIP_DEFAULT_OFFSET_MOUSE = ImVec2(16, 10); // Multiplied by g.Style.MouseCursorScale static const ImVec2 TOOLTIP_DEFAULT_OFFSET_TOUCH = ImVec2(0, -20); // Multiplied by g.Style.MouseCursorScale static const ImVec2 TOOLTIP_DEFAULT_PIVOT_TOUCH = ImVec2(0.5f, 1.0f); // Multiplied by g.Style.MouseCursorScale //------------------------------------------------------------------------- // [SECTION] FORWARD DECLARATIONS //------------------------------------------------------------------------- static void SetCurrentWindow(ImGuiWindow* window); static ImGuiWindow* CreateNewWindow(const char* name, ImGuiWindowFlags flags); static ImVec2 CalcNextScrollFromScrollTargetAndClamp(ImGuiWindow* window); static void AddWindowToSortBuffer(ImVector* out_sorted_windows, ImGuiWindow* window); // Settings static void WindowSettingsHandler_ClearAll(ImGuiContext*, ImGuiSettingsHandler*); static void* WindowSettingsHandler_ReadOpen(ImGuiContext*, ImGuiSettingsHandler*, const char* name); static void WindowSettingsHandler_ReadLine(ImGuiContext*, ImGuiSettingsHandler*, void* entry, const char* line); static void WindowSettingsHandler_ApplyAll(ImGuiContext*, ImGuiSettingsHandler*); static void WindowSettingsHandler_WriteAll(ImGuiContext*, ImGuiSettingsHandler*, ImGuiTextBuffer* buf); // Platform Dependents default implementation for ImGuiPlatformIO functions static const char* Platform_GetClipboardTextFn_DefaultImpl(ImGuiContext* ctx); static void Platform_SetClipboardTextFn_DefaultImpl(ImGuiContext* ctx, const char* text); static void Platform_SetImeDataFn_DefaultImpl(ImGuiContext* ctx, ImGuiViewport* viewport, ImGuiPlatformImeData* data); static bool Platform_OpenInShellFn_DefaultImpl(ImGuiContext* ctx, const char* path); namespace ImGui { // Item static void ItemHandleShortcut(ImGuiID id); // Window Focus static int FindWindowFocusIndex(ImGuiWindow* window); static void UpdateWindowInFocusOrderList(ImGuiWindow* window, bool just_created, ImGuiWindowFlags new_flags); // Navigation static void NavUpdate(); static void NavUpdateWindowing(); static void NavUpdateWindowingApplyFocus(ImGuiWindow* window); static void NavUpdateWindowingOverlay(); static void NavUpdateCancelRequest(); static void NavUpdateCreateMoveRequest(); static void NavUpdateCreateTabbingRequest(); static float NavUpdatePageUpPageDown(); static inline void NavUpdateAnyRequestFlag(); static void NavUpdateCreateWrappingRequest(); static void NavEndFrame(); static bool NavScoreItem(ImGuiNavItemData* result); static void NavApplyItemToResult(ImGuiNavItemData* result); static void NavProcessItem(); static void NavProcessItemForTabbingRequest(ImGuiID id, ImGuiItemFlags item_flags, ImGuiNavMoveFlags move_flags); static ImGuiInputSource NavCalcPreferredRefPosSource(); static ImVec2 NavCalcPreferredRefPos(); static void NavSaveLastChildNavWindowIntoParent(ImGuiWindow* nav_window); static ImGuiWindow* NavRestoreLastChildNavWindow(ImGuiWindow* window); static void NavRestoreLayer(ImGuiNavLayer layer); // Error Checking and Debug Tools static void ErrorCheckNewFrameSanityChecks(); static void ErrorCheckEndFrameSanityChecks(); #ifndef IMGUI_DISABLE_DEBUG_TOOLS static void UpdateDebugToolItemPicker(); static void UpdateDebugToolStackQueries(); static void UpdateDebugToolFlashStyleColor(); #endif // Inputs static void UpdateKeyboardInputs(); static void UpdateMouseInputs(); static void UpdateMouseWheel(); static void UpdateKeyRoutingTable(ImGuiKeyRoutingTable* rt); // Misc static void UpdateSettings(); static int UpdateWindowManualResize(ImGuiWindow* window, const ImVec2& size_auto_fit, int* border_hovered, int* border_held, int resize_grip_count, ImU32 resize_grip_col[4], const ImRect& visibility_rect); static void RenderWindowOuterBorders(ImGuiWindow* window); static void RenderWindowDecorations(ImGuiWindow* window, const ImRect& title_bar_rect, bool title_bar_is_highlight, bool handle_borders_and_resize_grips, int resize_grip_count, const ImU32 resize_grip_col[4], float resize_grip_draw_size); static void RenderWindowTitleBarContents(ImGuiWindow* window, const ImRect& title_bar_rect, const char* name, bool* p_open); static void RenderDimmedBackgroundBehindWindow(ImGuiWindow* window, ImU32 col); static void RenderDimmedBackgrounds(); static void SetLastItemDataForWindow(ImGuiWindow* window, const ImRect& rect); static void SetLastItemDataForChildWindowItem(ImGuiWindow* window, const ImRect& rect); // Viewports const ImGuiID IMGUI_VIEWPORT_DEFAULT_ID = 0x11111111; // Using an arbitrary constant instead of e.g. ImHashStr("ViewportDefault", 0); so it's easier to spot in the debugger. The exact value doesn't matter. static void UpdateViewportsNewFrame(); } //----------------------------------------------------------------------------- // [SECTION] CONTEXT AND MEMORY ALLOCATORS //----------------------------------------------------------------------------- // DLL users: // - Heaps and globals are not shared across DLL boundaries! // - You will need to call SetCurrentContext() + SetAllocatorFunctions() for each static/DLL boundary you are calling from. // - Same applies for hot-reloading mechanisms that are reliant on reloading DLL (note that many hot-reloading mechanisms work without DLL). // - Using Dear ImGui via a shared library is not recommended, because of function call overhead and because we don't guarantee backward nor forward ABI compatibility. // - Confused? In a debugger: add GImGui to your watch window and notice how its value changes depending on your current location (which DLL boundary you are in). // Current context pointer. Implicitly used by all Dear ImGui functions. Always assumed to be != NULL. // - ImGui::CreateContext() will automatically set this pointer if it is NULL. // Change to a different context by calling ImGui::SetCurrentContext(). // - Important: Dear ImGui functions are not thread-safe because of this pointer. // If you want thread-safety to allow N threads to access N different contexts: // - Change this variable to use thread local storage so each thread can refer to a different context, in your imconfig.h: // struct ImGuiContext; // extern thread_local ImGuiContext* MyImGuiTLS; // #define GImGui MyImGuiTLS // And then define MyImGuiTLS in one of your cpp files. Note that thread_local is a C++11 keyword, earlier C++ uses compiler-specific keyword. // - Future development aims to make this context pointer explicit to all calls. Also read https://github.com/ocornut/imgui/issues/586 // - If you need a finite number of contexts, you may compile and use multiple instances of the ImGui code from a different namespace. // - DLL users: read comments above. #ifndef GImGui ImGuiContext* GImGui = NULL; #endif // Memory Allocator functions. Use SetAllocatorFunctions() to change them. // - You probably don't want to modify that mid-program, and if you use global/static e.g. ImVector<> instances you may need to keep them accessible during program destruction. // - DLL users: read comments above. #ifndef IMGUI_DISABLE_DEFAULT_ALLOCATORS static void* MallocWrapper(size_t size, void* user_data) { IM_UNUSED(user_data); return malloc(size); } static void FreeWrapper(void* ptr, void* user_data) { IM_UNUSED(user_data); free(ptr); } #else static void* MallocWrapper(size_t size, void* user_data) { IM_UNUSED(user_data); IM_UNUSED(size); IM_ASSERT(0); return NULL; } static void FreeWrapper(void* ptr, void* user_data) { IM_UNUSED(user_data); IM_UNUSED(ptr); IM_ASSERT(0); } #endif static ImGuiMemAllocFunc GImAllocatorAllocFunc = MallocWrapper; static ImGuiMemFreeFunc GImAllocatorFreeFunc = FreeWrapper; static void* GImAllocatorUserData = NULL; //----------------------------------------------------------------------------- // [SECTION] USER FACING STRUCTURES (ImGuiStyle, ImGuiIO, ImGuiPlatformIO) //----------------------------------------------------------------------------- ImGuiStyle::ImGuiStyle() { Alpha = 1.0f; // Global alpha applies to everything in Dear ImGui. DisabledAlpha = 0.60f; // Additional alpha multiplier applied by BeginDisabled(). Multiply over current value of Alpha. WindowPadding = ImVec2(8,8); // Padding within a window WindowRounding = 0.0f; // Radius of window corners rounding. Set to 0.0f to have rectangular windows. Large values tend to lead to variety of artifacts and are not recommended. WindowBorderSize = 1.0f; // Thickness of border around windows. Generally set to 0.0f or 1.0f. Other values not well tested. WindowBorderHoverPadding = 4.0f; // Hit-testing extent outside/inside resizing border. Also extend determination of hovered window. Generally meaningfully larger than WindowBorderSize to make it easy to reach borders. WindowMinSize = ImVec2(32,32); // Minimum window size WindowTitleAlign = ImVec2(0.0f,0.5f);// Alignment for title bar text WindowMenuButtonPosition = ImGuiDir_Left; // Position of the collapsing/docking button in the title bar (left/right). Defaults to ImGuiDir_Left. ChildRounding = 0.0f; // Radius of child window corners rounding. Set to 0.0f to have rectangular child windows ChildBorderSize = 1.0f; // Thickness of border around child windows. Generally set to 0.0f or 1.0f. Other values not well tested. PopupRounding = 0.0f; // Radius of popup window corners rounding. Set to 0.0f to have rectangular child windows PopupBorderSize = 1.0f; // Thickness of border around popup or tooltip windows. Generally set to 0.0f or 1.0f. Other values not well tested. FramePadding = ImVec2(4,3); // Padding within a framed rectangle (used by most widgets) FrameRounding = 0.0f; // Radius of frame corners rounding. Set to 0.0f to have rectangular frames (used by most widgets). FrameBorderSize = 0.0f; // Thickness of border around frames. Generally set to 0.0f or 1.0f. Other values not well tested. ItemSpacing = ImVec2(8,4); // Horizontal and vertical spacing between widgets/lines ItemInnerSpacing = ImVec2(4,4); // Horizontal and vertical spacing between within elements of a composed widget (e.g. a slider and its label) CellPadding = ImVec2(4,2); // Padding within a table cell. Cellpadding.x is locked for entire table. CellPadding.y may be altered between different rows. TouchExtraPadding = ImVec2(0,0); // Expand reactive bounding box for touch-based system where touch position is not accurate enough. Unfortunately we don't sort widgets so priority on overlap will always be given to the first widget. So don't grow this too much! IndentSpacing = 21.0f; // Horizontal spacing when e.g. entering a tree node. Generally == (FontSize + FramePadding.x*2). ColumnsMinSpacing = 6.0f; // Minimum horizontal spacing between two columns. Preferably > (FramePadding.x + 1). ScrollbarSize = 14.0f; // Width of the vertical scrollbar, Height of the horizontal scrollbar ScrollbarRounding = 9.0f; // Radius of grab corners rounding for scrollbar GrabMinSize = 12.0f; // Minimum width/height of a grab box for slider/scrollbar GrabRounding = 0.0f; // Radius of grabs corners rounding. Set to 0.0f to have rectangular slider grabs. LogSliderDeadzone = 4.0f; // The size in pixels of the dead-zone around zero on logarithmic sliders that cross zero. ImageBorderSize = 0.0f; // Thickness of border around tabs. TabRounding = 5.0f; // Radius of upper corners of a tab. Set to 0.0f to have rectangular tabs. TabBorderSize = 0.0f; // Thickness of border around tabs. TabCloseButtonMinWidthSelected = -1.0f; // -1: always visible. 0.0f: visible when hovered. >0.0f: visible when hovered if minimum width. TabCloseButtonMinWidthUnselected = 0.0f; // -1: always visible. 0.0f: visible when hovered. >0.0f: visible when hovered if minimum width. FLT_MAX: never show close button when unselected. TabBarBorderSize = 1.0f; // Thickness of tab-bar separator, which takes on the tab active color to denote focus. TabBarOverlineSize = 1.0f; // Thickness of tab-bar overline, which highlights the selected tab-bar. TableAngledHeadersAngle = 35.0f * (IM_PI / 180.0f); // Angle of angled headers (supported values range from -50 degrees to +50 degrees). TableAngledHeadersTextAlign = ImVec2(0.5f,0.0f);// Alignment of angled headers within the cell ColorButtonPosition = ImGuiDir_Right; // Side of the color button in the ColorEdit4 widget (left/right). Defaults to ImGuiDir_Right. ButtonTextAlign = ImVec2(0.5f,0.5f);// Alignment of button text when button is larger than text. SelectableTextAlign = ImVec2(0.0f,0.0f);// Alignment of selectable text. Defaults to (0.0f, 0.0f) (top-left aligned). It's generally important to keep this left-aligned if you want to lay multiple items on a same line. SeparatorTextBorderSize = 3.0f; // Thickness of border in SeparatorText() SeparatorTextAlign = ImVec2(0.0f,0.5f);// Alignment of text within the separator. Defaults to (0.0f, 0.5f) (left aligned, center). SeparatorTextPadding = ImVec2(20.0f,3.f);// Horizontal offset of text from each edge of the separator + spacing on other axis. Generally small values. .y is recommended to be == FramePadding.y. DisplayWindowPadding = ImVec2(19,19); // Window position are clamped to be visible within the display area or monitors by at least this amount. Only applies to regular windows. DisplaySafeAreaPadding = ImVec2(3,3); // If you cannot see the edge of your screen (e.g. on a TV) increase the safe area padding. Covers popups/tooltips as well regular windows. MouseCursorScale = 1.0f; // Scale software rendered mouse cursor (when io.MouseDrawCursor is enabled). May be removed later. AntiAliasedLines = true; // Enable anti-aliased lines/borders. Disable if you are really tight on CPU/GPU. AntiAliasedLinesUseTex = true; // Enable anti-aliased lines/borders using textures where possible. Require backend to render with bilinear filtering (NOT point/nearest filtering). AntiAliasedFill = true; // Enable anti-aliased filled shapes (rounded rectangles, circles, etc.). CurveTessellationTol = 1.25f; // Tessellation tolerance when using PathBezierCurveTo() without a specific number of segments. Decrease for highly tessellated curves (higher quality, more polygons), increase to reduce quality. CircleTessellationMaxError = 0.30f; // Maximum error (in pixels) allowed when using AddCircle()/AddCircleFilled() or drawing rounded corner rectangles with no explicit segment count specified. Decrease for higher quality but more geometry. // Behaviors HoverStationaryDelay = 0.15f; // Delay for IsItemHovered(ImGuiHoveredFlags_Stationary). Time required to consider mouse stationary. HoverDelayShort = 0.15f; // Delay for IsItemHovered(ImGuiHoveredFlags_DelayShort). Usually used along with HoverStationaryDelay. HoverDelayNormal = 0.40f; // Delay for IsItemHovered(ImGuiHoveredFlags_DelayNormal). " HoverFlagsForTooltipMouse = ImGuiHoveredFlags_Stationary | ImGuiHoveredFlags_DelayShort | ImGuiHoveredFlags_AllowWhenDisabled; // Default flags when using IsItemHovered(ImGuiHoveredFlags_ForTooltip) or BeginItemTooltip()/SetItemTooltip() while using mouse. HoverFlagsForTooltipNav = ImGuiHoveredFlags_NoSharedDelay | ImGuiHoveredFlags_DelayNormal | ImGuiHoveredFlags_AllowWhenDisabled; // Default flags when using IsItemHovered(ImGuiHoveredFlags_ForTooltip) or BeginItemTooltip()/SetItemTooltip() while using keyboard/gamepad. // Default theme ImGui::StyleColorsDark(this); } // To scale your entire UI (e.g. if you want your app to use High DPI or generally be DPI aware) you may use this helper function. Scaling the fonts is done separately and is up to you. // Important: This operation is lossy because we round all sizes to integer. If you need to change your scale multiples, call this over a freshly initialized ImGuiStyle structure rather than scaling multiple times. void ImGuiStyle::ScaleAllSizes(float scale_factor) { WindowPadding = ImTrunc(WindowPadding * scale_factor); WindowRounding = ImTrunc(WindowRounding * scale_factor); WindowMinSize = ImTrunc(WindowMinSize * scale_factor); WindowBorderHoverPadding = ImTrunc(WindowBorderHoverPadding * scale_factor); ChildRounding = ImTrunc(ChildRounding * scale_factor); PopupRounding = ImTrunc(PopupRounding * scale_factor); FramePadding = ImTrunc(FramePadding * scale_factor); FrameRounding = ImTrunc(FrameRounding * scale_factor); ItemSpacing = ImTrunc(ItemSpacing * scale_factor); ItemInnerSpacing = ImTrunc(ItemInnerSpacing * scale_factor); CellPadding = ImTrunc(CellPadding * scale_factor); TouchExtraPadding = ImTrunc(TouchExtraPadding * scale_factor); IndentSpacing = ImTrunc(IndentSpacing * scale_factor); ColumnsMinSpacing = ImTrunc(ColumnsMinSpacing * scale_factor); ScrollbarSize = ImTrunc(ScrollbarSize * scale_factor); ScrollbarRounding = ImTrunc(ScrollbarRounding * scale_factor); GrabMinSize = ImTrunc(GrabMinSize * scale_factor); GrabRounding = ImTrunc(GrabRounding * scale_factor); LogSliderDeadzone = ImTrunc(LogSliderDeadzone * scale_factor); ImageBorderSize = ImTrunc(ImageBorderSize * scale_factor); TabRounding = ImTrunc(TabRounding * scale_factor); TabCloseButtonMinWidthSelected = (TabCloseButtonMinWidthSelected > 0.0f && TabCloseButtonMinWidthSelected != FLT_MAX) ? ImTrunc(TabCloseButtonMinWidthSelected * scale_factor) : TabCloseButtonMinWidthSelected; TabCloseButtonMinWidthUnselected = (TabCloseButtonMinWidthUnselected > 0.0f && TabCloseButtonMinWidthUnselected != FLT_MAX) ? ImTrunc(TabCloseButtonMinWidthUnselected * scale_factor) : TabCloseButtonMinWidthUnselected; TabBarOverlineSize = ImTrunc(TabBarOverlineSize * scale_factor); SeparatorTextPadding = ImTrunc(SeparatorTextPadding * scale_factor); DisplayWindowPadding = ImTrunc(DisplayWindowPadding * scale_factor); DisplaySafeAreaPadding = ImTrunc(DisplaySafeAreaPadding * scale_factor); MouseCursorScale = ImTrunc(MouseCursorScale * scale_factor); } ImGuiIO::ImGuiIO() { // Most fields are initialized with zero memset(this, 0, sizeof(*this)); IM_STATIC_ASSERT(IM_ARRAYSIZE(ImGuiIO::MouseDown) == ImGuiMouseButton_COUNT && IM_ARRAYSIZE(ImGuiIO::MouseClicked) == ImGuiMouseButton_COUNT); // Settings ConfigFlags = ImGuiConfigFlags_None; BackendFlags = ImGuiBackendFlags_None; DisplaySize = ImVec2(-1.0f, -1.0f); DeltaTime = 1.0f / 60.0f; IniSavingRate = 5.0f; IniFilename = "imgui.ini"; // Important: "imgui.ini" is relative to current working dir, most apps will want to lock this to an absolute path (e.g. same path as executables). LogFilename = "imgui_log.txt"; UserData = NULL; Fonts = NULL; FontGlobalScale = 1.0f; FontDefault = NULL; FontAllowUserScaling = false; DisplayFramebufferScale = ImVec2(1.0f, 1.0f); // Keyboard/Gamepad Navigation options ConfigNavSwapGamepadButtons = false; ConfigNavMoveSetMousePos = false; ConfigNavCaptureKeyboard = true; ConfigNavEscapeClearFocusItem = true; ConfigNavEscapeClearFocusWindow = false; ConfigNavCursorVisibleAuto = true; ConfigNavCursorVisibleAlways = false; // Miscellaneous options MouseDrawCursor = false; #ifdef __APPLE__ ConfigMacOSXBehaviors = true; // Set Mac OS X style defaults based on __APPLE__ compile time flag #else ConfigMacOSXBehaviors = false; #endif ConfigInputTrickleEventQueue = true; ConfigInputTextCursorBlink = true; ConfigInputTextEnterKeepActive = false; ConfigDragClickToInputText = false; ConfigWindowsResizeFromEdges = true; ConfigWindowsMoveFromTitleBarOnly = false; ConfigWindowsCopyContentsWithCtrlC = false; ConfigScrollbarScrollByPage = true; ConfigMemoryCompactTimer = 60.0f; ConfigDebugIsDebuggerPresent = false; ConfigDebugHighlightIdConflicts = true; ConfigDebugHighlightIdConflictsShowItemPicker = true; ConfigDebugBeginReturnValueOnce = false; ConfigDebugBeginReturnValueLoop = false; ConfigErrorRecovery = true; ConfigErrorRecoveryEnableAssert = true; ConfigErrorRecoveryEnableDebugLog = true; ConfigErrorRecoveryEnableTooltip = true; // Inputs Behaviors MouseDoubleClickTime = 0.30f; MouseDoubleClickMaxDist = 6.0f; MouseDragThreshold = 6.0f; KeyRepeatDelay = 0.275f; KeyRepeatRate = 0.050f; // Platform Functions // Note: Initialize() will setup default clipboard/ime handlers. BackendPlatformName = BackendRendererName = NULL; BackendPlatformUserData = BackendRendererUserData = BackendLanguageUserData = NULL; // Input (NB: we already have memset zero the entire structure!) MousePos = ImVec2(-FLT_MAX, -FLT_MAX); MousePosPrev = ImVec2(-FLT_MAX, -FLT_MAX); MouseSource = ImGuiMouseSource_Mouse; for (int i = 0; i < IM_ARRAYSIZE(MouseDownDuration); i++) MouseDownDuration[i] = MouseDownDurationPrev[i] = -1.0f; for (int i = 0; i < IM_ARRAYSIZE(KeysData); i++) { KeysData[i].DownDuration = KeysData[i].DownDurationPrev = -1.0f; } AppAcceptingEvents = true; } // Pass in translated ASCII characters for text input. // - with glfw you can get those from the callback set in glfwSetCharCallback() // - on Windows you can get those using ToAscii+keyboard state, or via the WM_CHAR message // FIXME: Should in theory be called "AddCharacterEvent()" to be consistent with new API void ImGuiIO::AddInputCharacter(unsigned int c) { IM_ASSERT(Ctx != NULL); ImGuiContext& g = *Ctx; if (c == 0 || !AppAcceptingEvents) return; ImGuiInputEvent e; e.Type = ImGuiInputEventType_Text; e.Source = ImGuiInputSource_Keyboard; e.EventId = g.InputEventsNextEventId++; e.Text.Char = c; g.InputEventsQueue.push_back(e); } // UTF16 strings use surrogate pairs to encode codepoints >= 0x10000, so // we should save the high surrogate. void ImGuiIO::AddInputCharacterUTF16(ImWchar16 c) { if ((c == 0 && InputQueueSurrogate == 0) || !AppAcceptingEvents) return; if ((c & 0xFC00) == 0xD800) // High surrogate, must save { if (InputQueueSurrogate != 0) AddInputCharacter(IM_UNICODE_CODEPOINT_INVALID); InputQueueSurrogate = c; return; } ImWchar cp = c; if (InputQueueSurrogate != 0) { if ((c & 0xFC00) != 0xDC00) // Invalid low surrogate { AddInputCharacter(IM_UNICODE_CODEPOINT_INVALID); } else { #if IM_UNICODE_CODEPOINT_MAX == 0xFFFF cp = IM_UNICODE_CODEPOINT_INVALID; // Codepoint will not fit in ImWchar #else cp = (ImWchar)(((InputQueueSurrogate - 0xD800) << 10) + (c - 0xDC00) + 0x10000); #endif } InputQueueSurrogate = 0; } AddInputCharacter((unsigned)cp); } void ImGuiIO::AddInputCharactersUTF8(const char* utf8_chars) { if (!AppAcceptingEvents) return; while (*utf8_chars != 0) { unsigned int c = 0; utf8_chars += ImTextCharFromUtf8(&c, utf8_chars, NULL); AddInputCharacter(c); } } // Clear all incoming events. void ImGuiIO::ClearEventsQueue() { IM_ASSERT(Ctx != NULL); ImGuiContext& g = *Ctx; g.InputEventsQueue.clear(); } // Clear current keyboard/gamepad state + current frame text input buffer. Equivalent to releasing all keys/buttons. void ImGuiIO::ClearInputKeys() { ImGuiContext& g = *Ctx; for (int key = ImGuiKey_NamedKey_BEGIN; key < ImGuiKey_NamedKey_END; key++) { if (ImGui::IsMouseKey((ImGuiKey)key)) continue; ImGuiKeyData* key_data = &g.IO.KeysData[key - ImGuiKey_NamedKey_BEGIN]; key_data->Down = false; key_data->DownDuration = -1.0f; key_data->DownDurationPrev = -1.0f; } KeyCtrl = KeyShift = KeyAlt = KeySuper = false; KeyMods = ImGuiMod_None; InputQueueCharacters.resize(0); // Behavior of old ClearInputCharacters(). } void ImGuiIO::ClearInputMouse() { for (ImGuiKey key = ImGuiKey_Mouse_BEGIN; key < ImGuiKey_Mouse_END; key = (ImGuiKey)(key + 1)) { ImGuiKeyData* key_data = &KeysData[key - ImGuiKey_NamedKey_BEGIN]; key_data->Down = false; key_data->DownDuration = -1.0f; key_data->DownDurationPrev = -1.0f; } MousePos = ImVec2(-FLT_MAX, -FLT_MAX); for (int n = 0; n < IM_ARRAYSIZE(MouseDown); n++) { MouseDown[n] = false; MouseDownDuration[n] = MouseDownDurationPrev[n] = -1.0f; } MouseWheel = MouseWheelH = 0.0f; } // Removed this as it is ambiguous/misleading and generally incorrect to use with the existence of a higher-level input queue. // Current frame character buffer is now also cleared by ClearInputKeys(). #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS void ImGuiIO::ClearInputCharacters() { InputQueueCharacters.resize(0); } #endif static ImGuiInputEvent* FindLatestInputEvent(ImGuiContext* ctx, ImGuiInputEventType type, int arg = -1) { ImGuiContext& g = *ctx; for (int n = g.InputEventsQueue.Size - 1; n >= 0; n--) { ImGuiInputEvent* e = &g.InputEventsQueue[n]; if (e->Type != type) continue; if (type == ImGuiInputEventType_Key && e->Key.Key != arg) continue; if (type == ImGuiInputEventType_MouseButton && e->MouseButton.Button != arg) continue; return e; } return NULL; } // Queue a new key down/up event. // - ImGuiKey key: Translated key (as in, generally ImGuiKey_A matches the key end-user would use to emit an 'A' character) // - bool down: Is the key down? use false to signify a key release. // - float analog_value: 0.0f..1.0f // IMPORTANT: THIS FUNCTION AND OTHER "ADD" GRABS THE CONTEXT FROM OUR INSTANCE. // WE NEED TO ENSURE THAT ALL FUNCTION CALLS ARE FULFILLING THIS, WHICH IS WHY GetKeyData() HAS AN EXPLICIT CONTEXT. void ImGuiIO::AddKeyAnalogEvent(ImGuiKey key, bool down, float analog_value) { //if (e->Down) { IMGUI_DEBUG_LOG_IO("AddKeyEvent() Key='%s' %d, NativeKeycode = %d, NativeScancode = %d\n", ImGui::GetKeyName(e->Key), e->Down, e->NativeKeycode, e->NativeScancode); } IM_ASSERT(Ctx != NULL); if (key == ImGuiKey_None || !AppAcceptingEvents) return; ImGuiContext& g = *Ctx; IM_ASSERT(ImGui::IsNamedKeyOrMod(key)); // Backend needs to pass a valid ImGuiKey_ constant. 0..511 values are legacy native key codes which are not accepted by this API. IM_ASSERT(ImGui::IsAliasKey(key) == false); // Backend cannot submit ImGuiKey_MouseXXX values they are automatically inferred from AddMouseXXX() events. // MacOS: swap Cmd(Super) and Ctrl if (g.IO.ConfigMacOSXBehaviors) { if (key == ImGuiMod_Super) { key = ImGuiMod_Ctrl; } else if (key == ImGuiMod_Ctrl) { key = ImGuiMod_Super; } else if (key == ImGuiKey_LeftSuper) { key = ImGuiKey_LeftCtrl; } else if (key == ImGuiKey_RightSuper){ key = ImGuiKey_RightCtrl; } else if (key == ImGuiKey_LeftCtrl) { key = ImGuiKey_LeftSuper; } else if (key == ImGuiKey_RightCtrl) { key = ImGuiKey_RightSuper; } } // Filter duplicate (in particular: key mods and gamepad analog values are commonly spammed) const ImGuiInputEvent* latest_event = FindLatestInputEvent(&g, ImGuiInputEventType_Key, (int)key); const ImGuiKeyData* key_data = ImGui::GetKeyData(&g, key); const bool latest_key_down = latest_event ? latest_event->Key.Down : key_data->Down; const float latest_key_analog = latest_event ? latest_event->Key.AnalogValue : key_data->AnalogValue; if (latest_key_down == down && latest_key_analog == analog_value) return; // Add event ImGuiInputEvent e; e.Type = ImGuiInputEventType_Key; e.Source = ImGui::IsGamepadKey(key) ? ImGuiInputSource_Gamepad : ImGuiInputSource_Keyboard; e.EventId = g.InputEventsNextEventId++; e.Key.Key = key; e.Key.Down = down; e.Key.AnalogValue = analog_value; g.InputEventsQueue.push_back(e); } void ImGuiIO::AddKeyEvent(ImGuiKey key, bool down) { if (!AppAcceptingEvents) return; AddKeyAnalogEvent(key, down, down ? 1.0f : 0.0f); } // [Optional] Call after AddKeyEvent(). // Specify native keycode, scancode + Specify index for legacy <1.87 IsKeyXXX() functions with native indices. // If you are writing a backend in 2022 or don't use IsKeyXXX() with native values that are not ImGuiKey values, you can avoid calling this. void ImGuiIO::SetKeyEventNativeData(ImGuiKey key, int native_keycode, int native_scancode, int native_legacy_index) { if (key == ImGuiKey_None) return; IM_ASSERT(ImGui::IsNamedKey(key)); // >= 512 IM_ASSERT(native_legacy_index == -1 || ImGui::IsLegacyKey((ImGuiKey)native_legacy_index)); // >= 0 && <= 511 IM_UNUSED(key); // Yet unused IM_UNUSED(native_keycode); // Yet unused IM_UNUSED(native_scancode); // Yet unused IM_UNUSED(native_legacy_index); // Yet unused } // Set master flag for accepting key/mouse/text events (default to true). Useful if you have native dialog boxes that are interrupting your application loop/refresh, and you want to disable events being queued while your app is frozen. void ImGuiIO::SetAppAcceptingEvents(bool accepting_events) { AppAcceptingEvents = accepting_events; } // Queue a mouse move event void ImGuiIO::AddMousePosEvent(float x, float y) { IM_ASSERT(Ctx != NULL); ImGuiContext& g = *Ctx; if (!AppAcceptingEvents) return; // Apply same flooring as UpdateMouseInputs() ImVec2 pos((x > -FLT_MAX) ? ImFloor(x) : x, (y > -FLT_MAX) ? ImFloor(y) : y); // Filter duplicate const ImGuiInputEvent* latest_event = FindLatestInputEvent(&g, ImGuiInputEventType_MousePos); const ImVec2 latest_pos = latest_event ? ImVec2(latest_event->MousePos.PosX, latest_event->MousePos.PosY) : g.IO.MousePos; if (latest_pos.x == pos.x && latest_pos.y == pos.y) return; ImGuiInputEvent e; e.Type = ImGuiInputEventType_MousePos; e.Source = ImGuiInputSource_Mouse; e.EventId = g.InputEventsNextEventId++; e.MousePos.PosX = pos.x; e.MousePos.PosY = pos.y; e.MousePos.MouseSource = g.InputEventsNextMouseSource; g.InputEventsQueue.push_back(e); } void ImGuiIO::AddMouseButtonEvent(int mouse_button, bool down) { IM_ASSERT(Ctx != NULL); ImGuiContext& g = *Ctx; IM_ASSERT(mouse_button >= 0 && mouse_button < ImGuiMouseButton_COUNT); if (!AppAcceptingEvents) return; // On MacOS X: Convert Ctrl(Super)+Left click into Right-click: handle held button. if (ConfigMacOSXBehaviors && mouse_button == 0 && MouseCtrlLeftAsRightClick) { // Order of both statements matterns: this event will still release mouse button 1 mouse_button = 1; if (!down) MouseCtrlLeftAsRightClick = false; } // Filter duplicate const ImGuiInputEvent* latest_event = FindLatestInputEvent(&g, ImGuiInputEventType_MouseButton, (int)mouse_button); const bool latest_button_down = latest_event ? latest_event->MouseButton.Down : g.IO.MouseDown[mouse_button]; if (latest_button_down == down) return; // On MacOS X: Convert Ctrl(Super)+Left click into Right-click. // - Note that this is actual physical Ctrl which is ImGuiMod_Super for us. // - At this point we want from !down to down, so this is handling the initial press. if (ConfigMacOSXBehaviors && mouse_button == 0 && down) { const ImGuiInputEvent* latest_super_event = FindLatestInputEvent(&g, ImGuiInputEventType_Key, (int)ImGuiMod_Super); if (latest_super_event ? latest_super_event->Key.Down : g.IO.KeySuper) { IMGUI_DEBUG_LOG_IO("[io] Super+Left Click aliased into Right Click\n"); MouseCtrlLeftAsRightClick = true; AddMouseButtonEvent(1, true); // This is just quicker to write that passing through, as we need to filter duplicate again. return; } } ImGuiInputEvent e; e.Type = ImGuiInputEventType_MouseButton; e.Source = ImGuiInputSource_Mouse; e.EventId = g.InputEventsNextEventId++; e.MouseButton.Button = mouse_button; e.MouseButton.Down = down; e.MouseButton.MouseSource = g.InputEventsNextMouseSource; g.InputEventsQueue.push_back(e); } // Queue a mouse wheel event (some mouse/API may only have a Y component) void ImGuiIO::AddMouseWheelEvent(float wheel_x, float wheel_y) { IM_ASSERT(Ctx != NULL); ImGuiContext& g = *Ctx; // Filter duplicate (unlike most events, wheel values are relative and easy to filter) if (!AppAcceptingEvents || (wheel_x == 0.0f && wheel_y == 0.0f)) return; ImGuiInputEvent e; e.Type = ImGuiInputEventType_MouseWheel; e.Source = ImGuiInputSource_Mouse; e.EventId = g.InputEventsNextEventId++; e.MouseWheel.WheelX = wheel_x; e.MouseWheel.WheelY = wheel_y; e.MouseWheel.MouseSource = g.InputEventsNextMouseSource; g.InputEventsQueue.push_back(e); } // This is not a real event, the data is latched in order to be stored in actual Mouse events. // This is so that duplicate events (e.g. Windows sending extraneous WM_MOUSEMOVE) gets filtered and are not leading to actual source changes. void ImGuiIO::AddMouseSourceEvent(ImGuiMouseSource source) { IM_ASSERT(Ctx != NULL); ImGuiContext& g = *Ctx; g.InputEventsNextMouseSource = source; } void ImGuiIO::AddFocusEvent(bool focused) { IM_ASSERT(Ctx != NULL); ImGuiContext& g = *Ctx; // Filter duplicate const ImGuiInputEvent* latest_event = FindLatestInputEvent(&g, ImGuiInputEventType_Focus); const bool latest_focused = latest_event ? latest_event->AppFocused.Focused : !g.IO.AppFocusLost; if (latest_focused == focused || (ConfigDebugIgnoreFocusLoss && !focused)) return; ImGuiInputEvent e; e.Type = ImGuiInputEventType_Focus; e.EventId = g.InputEventsNextEventId++; e.AppFocused.Focused = focused; g.InputEventsQueue.push_back(e); } ImGuiPlatformIO::ImGuiPlatformIO() { // Most fields are initialized with zero memset(this, 0, sizeof(*this)); Platform_LocaleDecimalPoint = '.'; } //----------------------------------------------------------------------------- // [SECTION] MISC HELPERS/UTILITIES (Geometry functions) //----------------------------------------------------------------------------- ImVec2 ImBezierCubicClosestPoint(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, const ImVec2& p, int num_segments) { IM_ASSERT(num_segments > 0); // Use ImBezierCubicClosestPointCasteljau() ImVec2 p_last = p1; ImVec2 p_closest; float p_closest_dist2 = FLT_MAX; float t_step = 1.0f / (float)num_segments; for (int i_step = 1; i_step <= num_segments; i_step++) { ImVec2 p_current = ImBezierCubicCalc(p1, p2, p3, p4, t_step * i_step); ImVec2 p_line = ImLineClosestPoint(p_last, p_current, p); float dist2 = ImLengthSqr(p - p_line); if (dist2 < p_closest_dist2) { p_closest = p_line; p_closest_dist2 = dist2; } p_last = p_current; } return p_closest; } // Closely mimics PathBezierToCasteljau() in imgui_draw.cpp static void ImBezierCubicClosestPointCasteljauStep(const ImVec2& p, ImVec2& p_closest, ImVec2& p_last, float& p_closest_dist2, float x1, float y1, float x2, float y2, float x3, float y3, float x4, float y4, float tess_tol, int level) { float dx = x4 - x1; float dy = y4 - y1; float d2 = ((x2 - x4) * dy - (y2 - y4) * dx); float d3 = ((x3 - x4) * dy - (y3 - y4) * dx); d2 = (d2 >= 0) ? d2 : -d2; d3 = (d3 >= 0) ? d3 : -d3; if ((d2 + d3) * (d2 + d3) < tess_tol * (dx * dx + dy * dy)) { ImVec2 p_current(x4, y4); ImVec2 p_line = ImLineClosestPoint(p_last, p_current, p); float dist2 = ImLengthSqr(p - p_line); if (dist2 < p_closest_dist2) { p_closest = p_line; p_closest_dist2 = dist2; } p_last = p_current; } else if (level < 10) { float x12 = (x1 + x2)*0.5f, y12 = (y1 + y2)*0.5f; float x23 = (x2 + x3)*0.5f, y23 = (y2 + y3)*0.5f; float x34 = (x3 + x4)*0.5f, y34 = (y3 + y4)*0.5f; float x123 = (x12 + x23)*0.5f, y123 = (y12 + y23)*0.5f; float x234 = (x23 + x34)*0.5f, y234 = (y23 + y34)*0.5f; float x1234 = (x123 + x234)*0.5f, y1234 = (y123 + y234)*0.5f; ImBezierCubicClosestPointCasteljauStep(p, p_closest, p_last, p_closest_dist2, x1, y1, x12, y12, x123, y123, x1234, y1234, tess_tol, level + 1); ImBezierCubicClosestPointCasteljauStep(p, p_closest, p_last, p_closest_dist2, x1234, y1234, x234, y234, x34, y34, x4, y4, tess_tol, level + 1); } } // tess_tol is generally the same value you would find in ImGui::GetStyle().CurveTessellationTol // Because those ImXXX functions are lower-level than ImGui:: we cannot access this value automatically. ImVec2 ImBezierCubicClosestPointCasteljau(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, const ImVec2& p, float tess_tol) { IM_ASSERT(tess_tol > 0.0f); ImVec2 p_last = p1; ImVec2 p_closest; float p_closest_dist2 = FLT_MAX; ImBezierCubicClosestPointCasteljauStep(p, p_closest, p_last, p_closest_dist2, p1.x, p1.y, p2.x, p2.y, p3.x, p3.y, p4.x, p4.y, tess_tol, 0); return p_closest; } ImVec2 ImLineClosestPoint(const ImVec2& a, const ImVec2& b, const ImVec2& p) { ImVec2 ap = p - a; ImVec2 ab_dir = b - a; float dot = ap.x * ab_dir.x + ap.y * ab_dir.y; if (dot < 0.0f) return a; float ab_len_sqr = ab_dir.x * ab_dir.x + ab_dir.y * ab_dir.y; if (dot > ab_len_sqr) return b; return a + ab_dir * dot / ab_len_sqr; } bool ImTriangleContainsPoint(const ImVec2& a, const ImVec2& b, const ImVec2& c, const ImVec2& p) { bool b1 = ((p.x - b.x) * (a.y - b.y) - (p.y - b.y) * (a.x - b.x)) < 0.0f; bool b2 = ((p.x - c.x) * (b.y - c.y) - (p.y - c.y) * (b.x - c.x)) < 0.0f; bool b3 = ((p.x - a.x) * (c.y - a.y) - (p.y - a.y) * (c.x - a.x)) < 0.0f; return ((b1 == b2) && (b2 == b3)); } void ImTriangleBarycentricCoords(const ImVec2& a, const ImVec2& b, const ImVec2& c, const ImVec2& p, float& out_u, float& out_v, float& out_w) { ImVec2 v0 = b - a; ImVec2 v1 = c - a; ImVec2 v2 = p - a; const float denom = v0.x * v1.y - v1.x * v0.y; out_v = (v2.x * v1.y - v1.x * v2.y) / denom; out_w = (v0.x * v2.y - v2.x * v0.y) / denom; out_u = 1.0f - out_v - out_w; } ImVec2 ImTriangleClosestPoint(const ImVec2& a, const ImVec2& b, const ImVec2& c, const ImVec2& p) { ImVec2 proj_ab = ImLineClosestPoint(a, b, p); ImVec2 proj_bc = ImLineClosestPoint(b, c, p); ImVec2 proj_ca = ImLineClosestPoint(c, a, p); float dist2_ab = ImLengthSqr(p - proj_ab); float dist2_bc = ImLengthSqr(p - proj_bc); float dist2_ca = ImLengthSqr(p - proj_ca); float m = ImMin(dist2_ab, ImMin(dist2_bc, dist2_ca)); if (m == dist2_ab) return proj_ab; if (m == dist2_bc) return proj_bc; return proj_ca; } //----------------------------------------------------------------------------- // [SECTION] MISC HELPERS/UTILITIES (String, Format, Hash functions) //----------------------------------------------------------------------------- // Consider using _stricmp/_strnicmp under Windows or strcasecmp/strncasecmp. We don't actually use either ImStricmp/ImStrnicmp in the codebase any more. int ImStricmp(const char* str1, const char* str2) { int d; while ((d = ImToUpper(*str2) - ImToUpper(*str1)) == 0 && *str1) { str1++; str2++; } return d; } int ImStrnicmp(const char* str1, const char* str2, size_t count) { int d = 0; while (count > 0 && (d = ImToUpper(*str2) - ImToUpper(*str1)) == 0 && *str1) { str1++; str2++; count--; } return d; } void ImStrncpy(char* dst, const char* src, size_t count) { if (count < 1) return; if (count > 1) strncpy(dst, src, count - 1); dst[count - 1] = 0; } char* ImStrdup(const char* str) { size_t len = ImStrlen(str); void* buf = IM_ALLOC(len + 1); return (char*)memcpy(buf, (const void*)str, len + 1); } char* ImStrdupcpy(char* dst, size_t* p_dst_size, const char* src) { size_t dst_buf_size = p_dst_size ? *p_dst_size : ImStrlen(dst) + 1; size_t src_size = ImStrlen(src) + 1; if (dst_buf_size < src_size) { IM_FREE(dst); dst = (char*)IM_ALLOC(src_size); if (p_dst_size) *p_dst_size = src_size; } return (char*)memcpy(dst, (const void*)src, src_size); } const char* ImStrchrRange(const char* str, const char* str_end, char c) { const char* p = (const char*)ImMemchr(str, (int)c, str_end - str); return p; } int ImStrlenW(const ImWchar* str) { //return (int)wcslen((const wchar_t*)str); // FIXME-OPT: Could use this when wchar_t are 16-bit int n = 0; while (*str++) n++; return n; } // Find end-of-line. Return pointer will point to either first \n, either str_end. const char* ImStreolRange(const char* str, const char* str_end) { const char* p = (const char*)ImMemchr(str, '\n', str_end - str); return p ? p : str_end; } const char* ImStrbol(const char* buf_mid_line, const char* buf_begin) // find beginning-of-line { IM_ASSERT_PARANOID(buf_mid_line >= buf_begin && buf_mid_line <= buf_begin + ImStrlen(buf_begin)); while (buf_mid_line > buf_begin && buf_mid_line[-1] != '\n') buf_mid_line--; return buf_mid_line; } const char* ImStristr(const char* haystack, const char* haystack_end, const char* needle, const char* needle_end) { if (!needle_end) needle_end = needle + ImStrlen(needle); const char un0 = (char)ImToUpper(*needle); while ((!haystack_end && *haystack) || (haystack_end && haystack < haystack_end)) { if (ImToUpper(*haystack) == un0) { const char* b = needle + 1; for (const char* a = haystack + 1; b < needle_end; a++, b++) if (ImToUpper(*a) != ImToUpper(*b)) break; if (b == needle_end) return haystack; } haystack++; } return NULL; } // Trim str by offsetting contents when there's leading data + writing a \0 at the trailing position. We use this in situation where the cost is negligible. void ImStrTrimBlanks(char* buf) { char* p = buf; while (p[0] == ' ' || p[0] == '\t') // Leading blanks p++; char* p_start = p; while (*p != 0) // Find end of string p++; while (p > p_start && (p[-1] == ' ' || p[-1] == '\t')) // Trailing blanks p--; if (p_start != buf) // Copy memory if we had leading blanks memmove(buf, p_start, p - p_start); buf[p - p_start] = 0; // Zero terminate } const char* ImStrSkipBlank(const char* str) { while (str[0] == ' ' || str[0] == '\t') str++; return str; } // A) MSVC version appears to return -1 on overflow, whereas glibc appears to return total count (which may be >= buf_size). // Ideally we would test for only one of those limits at runtime depending on the behavior the vsnprintf(), but trying to deduct it at compile time sounds like a pandora can of worm. // B) When buf==NULL vsnprintf() will return the output size. #ifndef IMGUI_DISABLE_DEFAULT_FORMAT_FUNCTIONS // We support stb_sprintf which is much faster (see: https://github.com/nothings/stb/blob/master/stb_sprintf.h) // You may set IMGUI_USE_STB_SPRINTF to use our default wrapper, or set IMGUI_DISABLE_DEFAULT_FORMAT_FUNCTIONS // and setup the wrapper yourself. (FIXME-OPT: Some of our high-level operations such as ImGuiTextBuffer::appendfv() are // designed using two-passes worst case, which probably could be improved using the stbsp_vsprintfcb() function.) #ifdef IMGUI_USE_STB_SPRINTF #ifndef IMGUI_DISABLE_STB_SPRINTF_IMPLEMENTATION #define STB_SPRINTF_IMPLEMENTATION #endif #ifdef IMGUI_STB_SPRINTF_FILENAME #include IMGUI_STB_SPRINTF_FILENAME #else #include "stb_sprintf.h" #endif #endif // #ifdef IMGUI_USE_STB_SPRINTF #if defined(_MSC_VER) && !defined(vsnprintf) #define vsnprintf _vsnprintf #endif int ImFormatString(char* buf, size_t buf_size, const char* fmt, ...) { va_list args; va_start(args, fmt); #ifdef IMGUI_USE_STB_SPRINTF int w = stbsp_vsnprintf(buf, (int)buf_size, fmt, args); #else int w = vsnprintf(buf, buf_size, fmt, args); #endif va_end(args); if (buf == NULL) return w; if (w == -1 || w >= (int)buf_size) w = (int)buf_size - 1; buf[w] = 0; return w; } int ImFormatStringV(char* buf, size_t buf_size, const char* fmt, va_list args) { #ifdef IMGUI_USE_STB_SPRINTF int w = stbsp_vsnprintf(buf, (int)buf_size, fmt, args); #else int w = vsnprintf(buf, buf_size, fmt, args); #endif if (buf == NULL) return w; if (w == -1 || w >= (int)buf_size) w = (int)buf_size - 1; buf[w] = 0; return w; } #endif // #ifdef IMGUI_DISABLE_DEFAULT_FORMAT_FUNCTIONS void ImFormatStringToTempBuffer(const char** out_buf, const char** out_buf_end, const char* fmt, ...) { va_list args; va_start(args, fmt); ImFormatStringToTempBufferV(out_buf, out_buf_end, fmt, args); va_end(args); } // FIXME: Should rework API toward allowing multiple in-flight temp buffers (easier and safer for caller) // by making the caller acquire a temp buffer token, with either explicit or destructor release, e.g. // ImGuiTempBufferToken token; // ImFormatStringToTempBuffer(token, ...); void ImFormatStringToTempBufferV(const char** out_buf, const char** out_buf_end, const char* fmt, va_list args) { ImGuiContext& g = *GImGui; if (fmt[0] == '%' && fmt[1] == 's' && fmt[2] == 0) { const char* buf = va_arg(args, const char*); // Skip formatting when using "%s" if (buf == NULL) buf = "(null)"; *out_buf = buf; if (out_buf_end) { *out_buf_end = buf + ImStrlen(buf); } } else if (fmt[0] == '%' && fmt[1] == '.' && fmt[2] == '*' && fmt[3] == 's' && fmt[4] == 0) { int buf_len = va_arg(args, int); // Skip formatting when using "%.*s" const char* buf = va_arg(args, const char*); if (buf == NULL) { buf = "(null)"; buf_len = ImMin(buf_len, 6); } *out_buf = buf; *out_buf_end = buf + buf_len; // Disallow not passing 'out_buf_end' here. User is expected to use it. } else { int buf_len = ImFormatStringV(g.TempBuffer.Data, g.TempBuffer.Size, fmt, args); *out_buf = g.TempBuffer.Data; if (out_buf_end) { *out_buf_end = g.TempBuffer.Data + buf_len; } } } #ifndef IMGUI_ENABLE_SSE4_2_CRC // CRC32 needs a 1KB lookup table (not cache friendly) // Although the code to generate the table is simple and shorter than the table itself, using a const table allows us to easily: // - avoid an unnecessary branch/memory tap, - keep the ImHashXXX functions usable by static constructors, - make it thread-safe. static const ImU32 GCrc32LookupTable[256] = { #ifdef IMGUI_USE_LEGACY_CRC32_ADLER // Legacy CRC32-adler table used pre 1.91.6 (before 2024/11/27). Only use if you cannot afford invalidating old .ini data. 0x00000000,0x77073096,0xEE0E612C,0x990951BA,0x076DC419,0x706AF48F,0xE963A535,0x9E6495A3,0x0EDB8832,0x79DCB8A4,0xE0D5E91E,0x97D2D988,0x09B64C2B,0x7EB17CBD,0xE7B82D07,0x90BF1D91, 0x1DB71064,0x6AB020F2,0xF3B97148,0x84BE41DE,0x1ADAD47D,0x6DDDE4EB,0xF4D4B551,0x83D385C7,0x136C9856,0x646BA8C0,0xFD62F97A,0x8A65C9EC,0x14015C4F,0x63066CD9,0xFA0F3D63,0x8D080DF5, 0x3B6E20C8,0x4C69105E,0xD56041E4,0xA2677172,0x3C03E4D1,0x4B04D447,0xD20D85FD,0xA50AB56B,0x35B5A8FA,0x42B2986C,0xDBBBC9D6,0xACBCF940,0x32D86CE3,0x45DF5C75,0xDCD60DCF,0xABD13D59, 0x26D930AC,0x51DE003A,0xC8D75180,0xBFD06116,0x21B4F4B5,0x56B3C423,0xCFBA9599,0xB8BDA50F,0x2802B89E,0x5F058808,0xC60CD9B2,0xB10BE924,0x2F6F7C87,0x58684C11,0xC1611DAB,0xB6662D3D, 0x76DC4190,0x01DB7106,0x98D220BC,0xEFD5102A,0x71B18589,0x06B6B51F,0x9FBFE4A5,0xE8B8D433,0x7807C9A2,0x0F00F934,0x9609A88E,0xE10E9818,0x7F6A0DBB,0x086D3D2D,0x91646C97,0xE6635C01, 0x6B6B51F4,0x1C6C6162,0x856530D8,0xF262004E,0x6C0695ED,0x1B01A57B,0x8208F4C1,0xF50FC457,0x65B0D9C6,0x12B7E950,0x8BBEB8EA,0xFCB9887C,0x62DD1DDF,0x15DA2D49,0x8CD37CF3,0xFBD44C65, 0x4DB26158,0x3AB551CE,0xA3BC0074,0xD4BB30E2,0x4ADFA541,0x3DD895D7,0xA4D1C46D,0xD3D6F4FB,0x4369E96A,0x346ED9FC,0xAD678846,0xDA60B8D0,0x44042D73,0x33031DE5,0xAA0A4C5F,0xDD0D7CC9, 0x5005713C,0x270241AA,0xBE0B1010,0xC90C2086,0x5768B525,0x206F85B3,0xB966D409,0xCE61E49F,0x5EDEF90E,0x29D9C998,0xB0D09822,0xC7D7A8B4,0x59B33D17,0x2EB40D81,0xB7BD5C3B,0xC0BA6CAD, 0xEDB88320,0x9ABFB3B6,0x03B6E20C,0x74B1D29A,0xEAD54739,0x9DD277AF,0x04DB2615,0x73DC1683,0xE3630B12,0x94643B84,0x0D6D6A3E,0x7A6A5AA8,0xE40ECF0B,0x9309FF9D,0x0A00AE27,0x7D079EB1, 0xF00F9344,0x8708A3D2,0x1E01F268,0x6906C2FE,0xF762575D,0x806567CB,0x196C3671,0x6E6B06E7,0xFED41B76,0x89D32BE0,0x10DA7A5A,0x67DD4ACC,0xF9B9DF6F,0x8EBEEFF9,0x17B7BE43,0x60B08ED5, 0xD6D6A3E8,0xA1D1937E,0x38D8C2C4,0x4FDFF252,0xD1BB67F1,0xA6BC5767,0x3FB506DD,0x48B2364B,0xD80D2BDA,0xAF0A1B4C,0x36034AF6,0x41047A60,0xDF60EFC3,0xA867DF55,0x316E8EEF,0x4669BE79, 0xCB61B38C,0xBC66831A,0x256FD2A0,0x5268E236,0xCC0C7795,0xBB0B4703,0x220216B9,0x5505262F,0xC5BA3BBE,0xB2BD0B28,0x2BB45A92,0x5CB36A04,0xC2D7FFA7,0xB5D0CF31,0x2CD99E8B,0x5BDEAE1D, 0x9B64C2B0,0xEC63F226,0x756AA39C,0x026D930A,0x9C0906A9,0xEB0E363F,0x72076785,0x05005713,0x95BF4A82,0xE2B87A14,0x7BB12BAE,0x0CB61B38,0x92D28E9B,0xE5D5BE0D,0x7CDCEFB7,0x0BDBDF21, 0x86D3D2D4,0xF1D4E242,0x68DDB3F8,0x1FDA836E,0x81BE16CD,0xF6B9265B,0x6FB077E1,0x18B74777,0x88085AE6,0xFF0F6A70,0x66063BCA,0x11010B5C,0x8F659EFF,0xF862AE69,0x616BFFD3,0x166CCF45, 0xA00AE278,0xD70DD2EE,0x4E048354,0x3903B3C2,0xA7672661,0xD06016F7,0x4969474D,0x3E6E77DB,0xAED16A4A,0xD9D65ADC,0x40DF0B66,0x37D83BF0,0xA9BCAE53,0xDEBB9EC5,0x47B2CF7F,0x30B5FFE9, 0xBDBDF21C,0xCABAC28A,0x53B39330,0x24B4A3A6,0xBAD03605,0xCDD70693,0x54DE5729,0x23D967BF,0xB3667A2E,0xC4614AB8,0x5D681B02,0x2A6F2B94,0xB40BBE37,0xC30C8EA1,0x5A05DF1B,0x2D02EF8D, #else // CRC32c table compatible with SSE 4.2 instructions 0x00000000,0xF26B8303,0xE13B70F7,0x1350F3F4,0xC79A971F,0x35F1141C,0x26A1E7E8,0xD4CA64EB,0x8AD958CF,0x78B2DBCC,0x6BE22838,0x9989AB3B,0x4D43CFD0,0xBF284CD3,0xAC78BF27,0x5E133C24, 0x105EC76F,0xE235446C,0xF165B798,0x030E349B,0xD7C45070,0x25AFD373,0x36FF2087,0xC494A384,0x9A879FA0,0x68EC1CA3,0x7BBCEF57,0x89D76C54,0x5D1D08BF,0xAF768BBC,0xBC267848,0x4E4DFB4B, 0x20BD8EDE,0xD2D60DDD,0xC186FE29,0x33ED7D2A,0xE72719C1,0x154C9AC2,0x061C6936,0xF477EA35,0xAA64D611,0x580F5512,0x4B5FA6E6,0xB93425E5,0x6DFE410E,0x9F95C20D,0x8CC531F9,0x7EAEB2FA, 0x30E349B1,0xC288CAB2,0xD1D83946,0x23B3BA45,0xF779DEAE,0x05125DAD,0x1642AE59,0xE4292D5A,0xBA3A117E,0x4851927D,0x5B016189,0xA96AE28A,0x7DA08661,0x8FCB0562,0x9C9BF696,0x6EF07595, 0x417B1DBC,0xB3109EBF,0xA0406D4B,0x522BEE48,0x86E18AA3,0x748A09A0,0x67DAFA54,0x95B17957,0xCBA24573,0x39C9C670,0x2A993584,0xD8F2B687,0x0C38D26C,0xFE53516F,0xED03A29B,0x1F682198, 0x5125DAD3,0xA34E59D0,0xB01EAA24,0x42752927,0x96BF4DCC,0x64D4CECF,0x77843D3B,0x85EFBE38,0xDBFC821C,0x2997011F,0x3AC7F2EB,0xC8AC71E8,0x1C661503,0xEE0D9600,0xFD5D65F4,0x0F36E6F7, 0x61C69362,0x93AD1061,0x80FDE395,0x72966096,0xA65C047D,0x5437877E,0x4767748A,0xB50CF789,0xEB1FCBAD,0x197448AE,0x0A24BB5A,0xF84F3859,0x2C855CB2,0xDEEEDFB1,0xCDBE2C45,0x3FD5AF46, 0x7198540D,0x83F3D70E,0x90A324FA,0x62C8A7F9,0xB602C312,0x44694011,0x5739B3E5,0xA55230E6,0xFB410CC2,0x092A8FC1,0x1A7A7C35,0xE811FF36,0x3CDB9BDD,0xCEB018DE,0xDDE0EB2A,0x2F8B6829, 0x82F63B78,0x709DB87B,0x63CD4B8F,0x91A6C88C,0x456CAC67,0xB7072F64,0xA457DC90,0x563C5F93,0x082F63B7,0xFA44E0B4,0xE9141340,0x1B7F9043,0xCFB5F4A8,0x3DDE77AB,0x2E8E845F,0xDCE5075C, 0x92A8FC17,0x60C37F14,0x73938CE0,0x81F80FE3,0x55326B08,0xA759E80B,0xB4091BFF,0x466298FC,0x1871A4D8,0xEA1A27DB,0xF94AD42F,0x0B21572C,0xDFEB33C7,0x2D80B0C4,0x3ED04330,0xCCBBC033, 0xA24BB5A6,0x502036A5,0x4370C551,0xB11B4652,0x65D122B9,0x97BAA1BA,0x84EA524E,0x7681D14D,0x2892ED69,0xDAF96E6A,0xC9A99D9E,0x3BC21E9D,0xEF087A76,0x1D63F975,0x0E330A81,0xFC588982, 0xB21572C9,0x407EF1CA,0x532E023E,0xA145813D,0x758FE5D6,0x87E466D5,0x94B49521,0x66DF1622,0x38CC2A06,0xCAA7A905,0xD9F75AF1,0x2B9CD9F2,0xFF56BD19,0x0D3D3E1A,0x1E6DCDEE,0xEC064EED, 0xC38D26C4,0x31E6A5C7,0x22B65633,0xD0DDD530,0x0417B1DB,0xF67C32D8,0xE52CC12C,0x1747422F,0x49547E0B,0xBB3FFD08,0xA86F0EFC,0x5A048DFF,0x8ECEE914,0x7CA56A17,0x6FF599E3,0x9D9E1AE0, 0xD3D3E1AB,0x21B862A8,0x32E8915C,0xC083125F,0x144976B4,0xE622F5B7,0xF5720643,0x07198540,0x590AB964,0xAB613A67,0xB831C993,0x4A5A4A90,0x9E902E7B,0x6CFBAD78,0x7FAB5E8C,0x8DC0DD8F, 0xE330A81A,0x115B2B19,0x020BD8ED,0xF0605BEE,0x24AA3F05,0xD6C1BC06,0xC5914FF2,0x37FACCF1,0x69E9F0D5,0x9B8273D6,0x88D28022,0x7AB90321,0xAE7367CA,0x5C18E4C9,0x4F48173D,0xBD23943E, 0xF36E6F75,0x0105EC76,0x12551F82,0xE03E9C81,0x34F4F86A,0xC69F7B69,0xD5CF889D,0x27A40B9E,0x79B737BA,0x8BDCB4B9,0x988C474D,0x6AE7C44E,0xBE2DA0A5,0x4C4623A6,0x5F16D052,0xAD7D5351 #endif }; #endif // Known size hash // It is ok to call ImHashData on a string with known length but the ### operator won't be supported. // FIXME-OPT: Replace with e.g. FNV1a hash? CRC32 pretty much randomly access 1KB. Need to do proper measurements. ImGuiID ImHashData(const void* data_p, size_t data_size, ImGuiID seed) { ImU32 crc = ~seed; const unsigned char* data = (const unsigned char*)data_p; const unsigned char *data_end = (const unsigned char*)data_p + data_size; #ifndef IMGUI_ENABLE_SSE4_2_CRC const ImU32* crc32_lut = GCrc32LookupTable; while (data < data_end) crc = (crc >> 8) ^ crc32_lut[(crc & 0xFF) ^ *data++]; return ~crc; #else while (data + 4 <= data_end) { crc = _mm_crc32_u32(crc, *(ImU32*)data); data += 4; } while (data < data_end) crc = _mm_crc32_u8(crc, *data++); return ~crc; #endif } // Zero-terminated string hash, with support for ### to reset back to seed value // We support a syntax of "label###id" where only "###id" is included in the hash, and only "label" gets displayed. // Because this syntax is rarely used we are optimizing for the common case. // - If we reach ### in the string we discard the hash so far and reset to the seed. // - We don't do 'current += 2; continue;' after handling ### to keep the code smaller/faster (measured ~10% diff in Debug build) // FIXME-OPT: Replace with e.g. FNV1a hash? CRC32 pretty much randomly access 1KB. Need to do proper measurements. ImGuiID ImHashStr(const char* data_p, size_t data_size, ImGuiID seed) { seed = ~seed; ImU32 crc = seed; const unsigned char* data = (const unsigned char*)data_p; #ifndef IMGUI_ENABLE_SSE4_2_CRC const ImU32* crc32_lut = GCrc32LookupTable; #endif if (data_size != 0) { while (data_size-- != 0) { unsigned char c = *data++; if (c == '#' && data_size >= 2 && data[0] == '#' && data[1] == '#') crc = seed; #ifndef IMGUI_ENABLE_SSE4_2_CRC crc = (crc >> 8) ^ crc32_lut[(crc & 0xFF) ^ c]; #else crc = _mm_crc32_u8(crc, c); #endif } } else { while (unsigned char c = *data++) { if (c == '#' && data[0] == '#' && data[1] == '#') crc = seed; #ifndef IMGUI_ENABLE_SSE4_2_CRC crc = (crc >> 8) ^ crc32_lut[(crc & 0xFF) ^ c]; #else crc = _mm_crc32_u8(crc, c); #endif } } return ~crc; } //----------------------------------------------------------------------------- // [SECTION] MISC HELPERS/UTILITIES (File functions) //----------------------------------------------------------------------------- // Default file functions #ifndef IMGUI_DISABLE_DEFAULT_FILE_FUNCTIONS ImFileHandle ImFileOpen(const char* filename, const char* mode) { #if defined(_WIN32) && !defined(IMGUI_DISABLE_WIN32_FUNCTIONS) && (defined(__MINGW32__) || (!defined(__CYGWIN__) && !defined(__GNUC__))) // We need a fopen() wrapper because MSVC/Windows fopen doesn't handle UTF-8 filenames. // Previously we used ImTextCountCharsFromUtf8/ImTextStrFromUtf8 here but we now need to support ImWchar16 and ImWchar32! const int filename_wsize = ::MultiByteToWideChar(CP_UTF8, 0, filename, -1, NULL, 0); const int mode_wsize = ::MultiByteToWideChar(CP_UTF8, 0, mode, -1, NULL, 0); // Use stack buffer if possible, otherwise heap buffer. Sizes include zero terminator. // We don't rely on current ImGuiContext as this is implied to be a helper function which doesn't depend on it (see #7314). wchar_t local_temp_stack[FILENAME_MAX]; ImVector local_temp_heap; if (filename_wsize + mode_wsize > IM_ARRAYSIZE(local_temp_stack)) local_temp_heap.resize(filename_wsize + mode_wsize); wchar_t* filename_wbuf = local_temp_heap.Data ? local_temp_heap.Data : local_temp_stack; wchar_t* mode_wbuf = filename_wbuf + filename_wsize; ::MultiByteToWideChar(CP_UTF8, 0, filename, -1, filename_wbuf, filename_wsize); ::MultiByteToWideChar(CP_UTF8, 0, mode, -1, mode_wbuf, mode_wsize); return ::_wfopen(filename_wbuf, mode_wbuf); #else return fopen(filename, mode); #endif } // We should in theory be using fseeko()/ftello() with off_t and _fseeki64()/_ftelli64() with __int64, waiting for the PR that does that in a very portable pre-C++11 zero-warnings way. bool ImFileClose(ImFileHandle f) { return fclose(f) == 0; } ImU64 ImFileGetSize(ImFileHandle f) { long off = 0, sz = 0; return ((off = ftell(f)) != -1 && !fseek(f, 0, SEEK_END) && (sz = ftell(f)) != -1 && !fseek(f, off, SEEK_SET)) ? (ImU64)sz : (ImU64)-1; } ImU64 ImFileRead(void* data, ImU64 sz, ImU64 count, ImFileHandle f) { return fread(data, (size_t)sz, (size_t)count, f); } ImU64 ImFileWrite(const void* data, ImU64 sz, ImU64 count, ImFileHandle f) { return fwrite(data, (size_t)sz, (size_t)count, f); } #endif // #ifndef IMGUI_DISABLE_DEFAULT_FILE_FUNCTIONS // Helper: Load file content into memory // Memory allocated with IM_ALLOC(), must be freed by user using IM_FREE() == ImGui::MemFree() // This can't really be used with "rt" because fseek size won't match read size. void* ImFileLoadToMemory(const char* filename, const char* mode, size_t* out_file_size, int padding_bytes) { IM_ASSERT(filename && mode); if (out_file_size) *out_file_size = 0; ImFileHandle f; if ((f = ImFileOpen(filename, mode)) == NULL) return NULL; size_t file_size = (size_t)ImFileGetSize(f); if (file_size == (size_t)-1) { ImFileClose(f); return NULL; } void* file_data = IM_ALLOC(file_size + padding_bytes); if (file_data == NULL) { ImFileClose(f); return NULL; } if (ImFileRead(file_data, 1, file_size, f) != file_size) { ImFileClose(f); IM_FREE(file_data); return NULL; } if (padding_bytes > 0) memset((void*)(((char*)file_data) + file_size), 0, (size_t)padding_bytes); ImFileClose(f); if (out_file_size) *out_file_size = file_size; return file_data; } //----------------------------------------------------------------------------- // [SECTION] MISC HELPERS/UTILITIES (ImText* functions) //----------------------------------------------------------------------------- IM_MSVC_RUNTIME_CHECKS_OFF // Convert UTF-8 to 32-bit character, process single character input. // A nearly-branchless UTF-8 decoder, based on work of Christopher Wellons (https://github.com/skeeto/branchless-utf8). // We handle UTF-8 decoding error by skipping forward. int ImTextCharFromUtf8(unsigned int* out_char, const char* in_text, const char* in_text_end) { static const char lengths[32] = { 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 2, 2, 2, 2, 3, 3, 4, 0 }; static const int masks[] = { 0x00, 0x7f, 0x1f, 0x0f, 0x07 }; static const uint32_t mins[] = { 0x400000, 0, 0x80, 0x800, 0x10000 }; static const int shiftc[] = { 0, 18, 12, 6, 0 }; static const int shifte[] = { 0, 6, 4, 2, 0 }; int len = lengths[*(const unsigned char*)in_text >> 3]; int wanted = len + (len ? 0 : 1); if (in_text_end == NULL) in_text_end = in_text + wanted; // Max length, nulls will be taken into account. // Copy at most 'len' bytes, stop copying at 0 or past in_text_end. Branch predictor does a good job here, // so it is fast even with excessive branching. unsigned char s[4]; s[0] = in_text + 0 < in_text_end ? in_text[0] : 0; s[1] = in_text + 1 < in_text_end ? in_text[1] : 0; s[2] = in_text + 2 < in_text_end ? in_text[2] : 0; s[3] = in_text + 3 < in_text_end ? in_text[3] : 0; // Assume a four-byte character and load four bytes. Unused bits are shifted out. *out_char = (uint32_t)(s[0] & masks[len]) << 18; *out_char |= (uint32_t)(s[1] & 0x3f) << 12; *out_char |= (uint32_t)(s[2] & 0x3f) << 6; *out_char |= (uint32_t)(s[3] & 0x3f) << 0; *out_char >>= shiftc[len]; // Accumulate the various error conditions. int e = 0; e = (*out_char < mins[len]) << 6; // non-canonical encoding e |= ((*out_char >> 11) == 0x1b) << 7; // surrogate half? e |= (*out_char > IM_UNICODE_CODEPOINT_MAX) << 8; // out of range we can store in ImWchar (FIXME: May evolve) e |= (s[1] & 0xc0) >> 2; e |= (s[2] & 0xc0) >> 4; e |= (s[3] ) >> 6; e ^= 0x2a; // top two bits of each tail byte correct? e >>= shifte[len]; if (e) { // No bytes are consumed when *in_text == 0 || in_text == in_text_end. // One byte is consumed in case of invalid first byte of in_text. // All available bytes (at most `len` bytes) are consumed on incomplete/invalid second to last bytes. // Invalid or incomplete input may consume less bytes than wanted, therefore every byte has to be inspected in s. wanted = ImMin(wanted, !!s[0] + !!s[1] + !!s[2] + !!s[3]); *out_char = IM_UNICODE_CODEPOINT_INVALID; } return wanted; } int ImTextStrFromUtf8(ImWchar* buf, int buf_size, const char* in_text, const char* in_text_end, const char** in_text_remaining) { ImWchar* buf_out = buf; ImWchar* buf_end = buf + buf_size; while (buf_out < buf_end - 1 && (!in_text_end || in_text < in_text_end) && *in_text) { unsigned int c; in_text += ImTextCharFromUtf8(&c, in_text, in_text_end); *buf_out++ = (ImWchar)c; } *buf_out = 0; if (in_text_remaining) *in_text_remaining = in_text; return (int)(buf_out - buf); } int ImTextCountCharsFromUtf8(const char* in_text, const char* in_text_end) { int char_count = 0; while ((!in_text_end || in_text < in_text_end) && *in_text) { unsigned int c; in_text += ImTextCharFromUtf8(&c, in_text, in_text_end); char_count++; } return char_count; } // Based on stb_to_utf8() from github.com/nothings/stb/ static inline int ImTextCharToUtf8_inline(char* buf, int buf_size, unsigned int c) { if (c < 0x80) { buf[0] = (char)c; return 1; } if (c < 0x800) { if (buf_size < 2) return 0; buf[0] = (char)(0xc0 + (c >> 6)); buf[1] = (char)(0x80 + (c & 0x3f)); return 2; } if (c < 0x10000) { if (buf_size < 3) return 0; buf[0] = (char)(0xe0 + (c >> 12)); buf[1] = (char)(0x80 + ((c >> 6) & 0x3f)); buf[2] = (char)(0x80 + ((c ) & 0x3f)); return 3; } if (c <= 0x10FFFF) { if (buf_size < 4) return 0; buf[0] = (char)(0xf0 + (c >> 18)); buf[1] = (char)(0x80 + ((c >> 12) & 0x3f)); buf[2] = (char)(0x80 + ((c >> 6) & 0x3f)); buf[3] = (char)(0x80 + ((c ) & 0x3f)); return 4; } // Invalid code point, the max unicode is 0x10FFFF return 0; } const char* ImTextCharToUtf8(char out_buf[5], unsigned int c) { int count = ImTextCharToUtf8_inline(out_buf, 5, c); out_buf[count] = 0; return out_buf; } // Not optimal but we very rarely use this function. int ImTextCountUtf8BytesFromChar(const char* in_text, const char* in_text_end) { unsigned int unused = 0; return ImTextCharFromUtf8(&unused, in_text, in_text_end); } static inline int ImTextCountUtf8BytesFromChar(unsigned int c) { if (c < 0x80) return 1; if (c < 0x800) return 2; if (c < 0x10000) return 3; if (c <= 0x10FFFF) return 4; return 3; } int ImTextStrToUtf8(char* out_buf, int out_buf_size, const ImWchar* in_text, const ImWchar* in_text_end) { char* buf_p = out_buf; const char* buf_end = out_buf + out_buf_size; while (buf_p < buf_end - 1 && (!in_text_end || in_text < in_text_end) && *in_text) { unsigned int c = (unsigned int)(*in_text++); if (c < 0x80) *buf_p++ = (char)c; else buf_p += ImTextCharToUtf8_inline(buf_p, (int)(buf_end - buf_p - 1), c); } *buf_p = 0; return (int)(buf_p - out_buf); } int ImTextCountUtf8BytesFromStr(const ImWchar* in_text, const ImWchar* in_text_end) { int bytes_count = 0; while ((!in_text_end || in_text < in_text_end) && *in_text) { unsigned int c = (unsigned int)(*in_text++); if (c < 0x80) bytes_count++; else bytes_count += ImTextCountUtf8BytesFromChar(c); } return bytes_count; } const char* ImTextFindPreviousUtf8Codepoint(const char* in_text_start, const char* in_text_curr) { while (in_text_curr > in_text_start) { in_text_curr--; if ((*in_text_curr & 0xC0) != 0x80) return in_text_curr; } return in_text_start; } int ImTextCountLines(const char* in_text, const char* in_text_end) { if (in_text_end == NULL) in_text_end = in_text + ImStrlen(in_text); // FIXME-OPT: Not optimal approach, discourage use for now. int count = 0; while (in_text < in_text_end) { const char* line_end = (const char*)ImMemchr(in_text, '\n', in_text_end - in_text); in_text = line_end ? line_end + 1 : in_text_end; count++; } return count; } IM_MSVC_RUNTIME_CHECKS_RESTORE //----------------------------------------------------------------------------- // [SECTION] MISC HELPERS/UTILITIES (Color functions) // Note: The Convert functions are early design which are not consistent with other API. //----------------------------------------------------------------------------- IMGUI_API ImU32 ImAlphaBlendColors(ImU32 col_a, ImU32 col_b) { float t = ((col_b >> IM_COL32_A_SHIFT) & 0xFF) / 255.f; int r = ImLerp((int)(col_a >> IM_COL32_R_SHIFT) & 0xFF, (int)(col_b >> IM_COL32_R_SHIFT) & 0xFF, t); int g = ImLerp((int)(col_a >> IM_COL32_G_SHIFT) & 0xFF, (int)(col_b >> IM_COL32_G_SHIFT) & 0xFF, t); int b = ImLerp((int)(col_a >> IM_COL32_B_SHIFT) & 0xFF, (int)(col_b >> IM_COL32_B_SHIFT) & 0xFF, t); return IM_COL32(r, g, b, 0xFF); } ImVec4 ImGui::ColorConvertU32ToFloat4(ImU32 in) { float s = 1.0f / 255.0f; return ImVec4( ((in >> IM_COL32_R_SHIFT) & 0xFF) * s, ((in >> IM_COL32_G_SHIFT) & 0xFF) * s, ((in >> IM_COL32_B_SHIFT) & 0xFF) * s, ((in >> IM_COL32_A_SHIFT) & 0xFF) * s); } ImU32 ImGui::ColorConvertFloat4ToU32(const ImVec4& in) { ImU32 out; out = ((ImU32)IM_F32_TO_INT8_SAT(in.x)) << IM_COL32_R_SHIFT; out |= ((ImU32)IM_F32_TO_INT8_SAT(in.y)) << IM_COL32_G_SHIFT; out |= ((ImU32)IM_F32_TO_INT8_SAT(in.z)) << IM_COL32_B_SHIFT; out |= ((ImU32)IM_F32_TO_INT8_SAT(in.w)) << IM_COL32_A_SHIFT; return out; } // Convert rgb floats ([0-1],[0-1],[0-1]) to hsv floats ([0-1],[0-1],[0-1]), from Foley & van Dam p592 // Optimized http://lolengine.net/blog/2013/01/13/fast-rgb-to-hsv void ImGui::ColorConvertRGBtoHSV(float r, float g, float b, float& out_h, float& out_s, float& out_v) { float K = 0.f; if (g < b) { ImSwap(g, b); K = -1.f; } if (r < g) { ImSwap(r, g); K = -2.f / 6.f - K; } const float chroma = r - (g < b ? g : b); out_h = ImFabs(K + (g - b) / (6.f * chroma + 1e-20f)); out_s = chroma / (r + 1e-20f); out_v = r; } // Convert hsv floats ([0-1],[0-1],[0-1]) to rgb floats ([0-1],[0-1],[0-1]), from Foley & van Dam p593 // also http://en.wikipedia.org/wiki/HSL_and_HSV void ImGui::ColorConvertHSVtoRGB(float h, float s, float v, float& out_r, float& out_g, float& out_b) { if (s == 0.0f) { // gray out_r = out_g = out_b = v; return; } h = ImFmod(h, 1.0f) / (60.0f / 360.0f); int i = (int)h; float f = h - (float)i; float p = v * (1.0f - s); float q = v * (1.0f - s * f); float t = v * (1.0f - s * (1.0f - f)); switch (i) { case 0: out_r = v; out_g = t; out_b = p; break; case 1: out_r = q; out_g = v; out_b = p; break; case 2: out_r = p; out_g = v; out_b = t; break; case 3: out_r = p; out_g = q; out_b = v; break; case 4: out_r = t; out_g = p; out_b = v; break; case 5: default: out_r = v; out_g = p; out_b = q; break; } } //----------------------------------------------------------------------------- // [SECTION] ImGuiStorage // Helper: Key->value storage //----------------------------------------------------------------------------- // std::lower_bound but without the bullshit ImGuiStoragePair* ImLowerBound(ImGuiStoragePair* in_begin, ImGuiStoragePair* in_end, ImGuiID key) { ImGuiStoragePair* in_p = in_begin; for (size_t count = (size_t)(in_end - in_p); count > 0; ) { size_t count2 = count >> 1; ImGuiStoragePair* mid = in_p + count2; if (mid->key < key) { in_p = ++mid; count -= count2 + 1; } else { count = count2; } } return in_p; } IM_MSVC_RUNTIME_CHECKS_OFF static int IMGUI_CDECL PairComparerByID(const void* lhs, const void* rhs) { // We can't just do a subtraction because qsort uses signed integers and subtracting our ID doesn't play well with that. ImGuiID lhs_v = ((const ImGuiStoragePair*)lhs)->key; ImGuiID rhs_v = ((const ImGuiStoragePair*)rhs)->key; return (lhs_v > rhs_v ? +1 : lhs_v < rhs_v ? -1 : 0); } // For quicker full rebuild of a storage (instead of an incremental one), you may add all your contents and then sort once. void ImGuiStorage::BuildSortByKey() { ImQsort(Data.Data, (size_t)Data.Size, sizeof(ImGuiStoragePair), PairComparerByID); } int ImGuiStorage::GetInt(ImGuiID key, int default_val) const { ImGuiStoragePair* it = ImLowerBound(const_cast(Data.Data), const_cast(Data.Data + Data.Size), key); if (it == Data.Data + Data.Size || it->key != key) return default_val; return it->val_i; } bool ImGuiStorage::GetBool(ImGuiID key, bool default_val) const { return GetInt(key, default_val ? 1 : 0) != 0; } float ImGuiStorage::GetFloat(ImGuiID key, float default_val) const { ImGuiStoragePair* it = ImLowerBound(const_cast(Data.Data), const_cast(Data.Data + Data.Size), key); if (it == Data.Data + Data.Size || it->key != key) return default_val; return it->val_f; } void* ImGuiStorage::GetVoidPtr(ImGuiID key) const { ImGuiStoragePair* it = ImLowerBound(const_cast(Data.Data), const_cast(Data.Data + Data.Size), key); if (it == Data.Data + Data.Size || it->key != key) return NULL; return it->val_p; } // References are only valid until a new value is added to the storage. Calling a Set***() function or a Get***Ref() function invalidates the pointer. int* ImGuiStorage::GetIntRef(ImGuiID key, int default_val) { ImGuiStoragePair* it = ImLowerBound(Data.Data, Data.Data + Data.Size, key); if (it == Data.Data + Data.Size || it->key != key) it = Data.insert(it, ImGuiStoragePair(key, default_val)); return &it->val_i; } bool* ImGuiStorage::GetBoolRef(ImGuiID key, bool default_val) { return (bool*)GetIntRef(key, default_val ? 1 : 0); } float* ImGuiStorage::GetFloatRef(ImGuiID key, float default_val) { ImGuiStoragePair* it = ImLowerBound(Data.Data, Data.Data + Data.Size, key); if (it == Data.Data + Data.Size || it->key != key) it = Data.insert(it, ImGuiStoragePair(key, default_val)); return &it->val_f; } void** ImGuiStorage::GetVoidPtrRef(ImGuiID key, void* default_val) { ImGuiStoragePair* it = ImLowerBound(Data.Data, Data.Data + Data.Size, key); if (it == Data.Data + Data.Size || it->key != key) it = Data.insert(it, ImGuiStoragePair(key, default_val)); return &it->val_p; } // FIXME-OPT: Need a way to reuse the result of lower_bound when doing GetInt()/SetInt() - not too bad because it only happens on explicit interaction (maximum one a frame) void ImGuiStorage::SetInt(ImGuiID key, int val) { ImGuiStoragePair* it = ImLowerBound(Data.Data, Data.Data + Data.Size, key); if (it == Data.Data + Data.Size || it->key != key) Data.insert(it, ImGuiStoragePair(key, val)); else it->val_i = val; } void ImGuiStorage::SetBool(ImGuiID key, bool val) { SetInt(key, val ? 1 : 0); } void ImGuiStorage::SetFloat(ImGuiID key, float val) { ImGuiStoragePair* it = ImLowerBound(Data.Data, Data.Data + Data.Size, key); if (it == Data.Data + Data.Size || it->key != key) Data.insert(it, ImGuiStoragePair(key, val)); else it->val_f = val; } void ImGuiStorage::SetVoidPtr(ImGuiID key, void* val) { ImGuiStoragePair* it = ImLowerBound(Data.Data, Data.Data + Data.Size, key); if (it == Data.Data + Data.Size || it->key != key) Data.insert(it, ImGuiStoragePair(key, val)); else it->val_p = val; } void ImGuiStorage::SetAllInt(int v) { for (int i = 0; i < Data.Size; i++) Data[i].val_i = v; } IM_MSVC_RUNTIME_CHECKS_RESTORE //----------------------------------------------------------------------------- // [SECTION] ImGuiTextFilter //----------------------------------------------------------------------------- // Helper: Parse and apply text filters. In format "aaaaa[,bbbb][,ccccc]" ImGuiTextFilter::ImGuiTextFilter(const char* default_filter) //-V1077 { InputBuf[0] = 0; CountGrep = 0; if (default_filter) { ImStrncpy(InputBuf, default_filter, IM_ARRAYSIZE(InputBuf)); Build(); } } bool ImGuiTextFilter::Draw(const char* label, float width) { if (width != 0.0f) ImGui::SetNextItemWidth(width); bool value_changed = ImGui::InputText(label, InputBuf, IM_ARRAYSIZE(InputBuf)); if (value_changed) Build(); return value_changed; } void ImGuiTextFilter::ImGuiTextRange::split(char separator, ImVector* out) const { out->resize(0); const char* wb = b; const char* we = wb; while (we < e) { if (*we == separator) { out->push_back(ImGuiTextRange(wb, we)); wb = we + 1; } we++; } if (wb != we) out->push_back(ImGuiTextRange(wb, we)); } void ImGuiTextFilter::Build() { Filters.resize(0); ImGuiTextRange input_range(InputBuf, InputBuf + ImStrlen(InputBuf)); input_range.split(',', &Filters); CountGrep = 0; for (ImGuiTextRange& f : Filters) { while (f.b < f.e && ImCharIsBlankA(f.b[0])) f.b++; while (f.e > f.b && ImCharIsBlankA(f.e[-1])) f.e--; if (f.empty()) continue; if (f.b[0] != '-') CountGrep += 1; } } bool ImGuiTextFilter::PassFilter(const char* text, const char* text_end) const { if (Filters.Size == 0) return true; if (text == NULL) text = text_end = ""; for (const ImGuiTextRange& f : Filters) { if (f.b == f.e) continue; if (f.b[0] == '-') { // Subtract if (ImStristr(text, text_end, f.b + 1, f.e) != NULL) return false; } else { // Grep if (ImStristr(text, text_end, f.b, f.e) != NULL) return true; } } // Implicit * grep if (CountGrep == 0) return true; return false; } //----------------------------------------------------------------------------- // [SECTION] ImGuiTextBuffer, ImGuiTextIndex //----------------------------------------------------------------------------- // On some platform vsnprintf() takes va_list by reference and modifies it. // va_copy is the 'correct' way to copy a va_list but Visual Studio prior to 2013 doesn't have it. #ifndef va_copy #if defined(__GNUC__) || defined(__clang__) #define va_copy(dest, src) __builtin_va_copy(dest, src) #else #define va_copy(dest, src) (dest = src) #endif #endif char ImGuiTextBuffer::EmptyString[1] = { 0 }; void ImGuiTextBuffer::append(const char* str, const char* str_end) { int len = str_end ? (int)(str_end - str) : (int)ImStrlen(str); // Add zero-terminator the first time const int write_off = (Buf.Size != 0) ? Buf.Size : 1; const int needed_sz = write_off + len; if (write_off + len >= Buf.Capacity) { int new_capacity = Buf.Capacity * 2; Buf.reserve(needed_sz > new_capacity ? needed_sz : new_capacity); } Buf.resize(needed_sz); memcpy(&Buf[write_off - 1], str, (size_t)len); Buf[write_off - 1 + len] = 0; } void ImGuiTextBuffer::appendf(const char* fmt, ...) { va_list args; va_start(args, fmt); appendfv(fmt, args); va_end(args); } // Helper: Text buffer for logging/accumulating text void ImGuiTextBuffer::appendfv(const char* fmt, va_list args) { va_list args_copy; va_copy(args_copy, args); int len = ImFormatStringV(NULL, 0, fmt, args); // FIXME-OPT: could do a first pass write attempt, likely successful on first pass. if (len <= 0) { va_end(args_copy); return; } // Add zero-terminator the first time const int write_off = (Buf.Size != 0) ? Buf.Size : 1; const int needed_sz = write_off + len; if (write_off + len >= Buf.Capacity) { int new_capacity = Buf.Capacity * 2; Buf.reserve(needed_sz > new_capacity ? needed_sz : new_capacity); } Buf.resize(needed_sz); ImFormatStringV(&Buf[write_off - 1], (size_t)len + 1, fmt, args_copy); va_end(args_copy); } void ImGuiTextIndex::append(const char* base, int old_size, int new_size) { IM_ASSERT(old_size >= 0 && new_size >= old_size && new_size >= EndOffset); if (old_size == new_size) return; if (EndOffset == 0 || base[EndOffset - 1] == '\n') LineOffsets.push_back(EndOffset); const char* base_end = base + new_size; for (const char* p = base + old_size; (p = (const char*)ImMemchr(p, '\n', base_end - p)) != 0; ) if (++p < base_end) // Don't push a trailing offset on last \n LineOffsets.push_back((int)(intptr_t)(p - base)); EndOffset = ImMax(EndOffset, new_size); } //----------------------------------------------------------------------------- // [SECTION] ImGuiListClipper //----------------------------------------------------------------------------- // FIXME-TABLE: This prevents us from using ImGuiListClipper _inside_ a table cell. // The problem we have is that without a Begin/End scheme for rows using the clipper is ambiguous. static bool GetSkipItemForListClipping() { ImGuiContext& g = *GImGui; return (g.CurrentTable ? g.CurrentTable->HostSkipItems : g.CurrentWindow->SkipItems); } static void ImGuiListClipper_SortAndFuseRanges(ImVector& ranges, int offset = 0) { if (ranges.Size - offset <= 1) return; // Helper to order ranges and fuse them together if possible (bubble sort is fine as we are only sorting 2-3 entries) for (int sort_end = ranges.Size - offset - 1; sort_end > 0; --sort_end) for (int i = offset; i < sort_end + offset; ++i) if (ranges[i].Min > ranges[i + 1].Min) ImSwap(ranges[i], ranges[i + 1]); // Now fuse ranges together as much as possible. for (int i = 1 + offset; i < ranges.Size; i++) { IM_ASSERT(!ranges[i].PosToIndexConvert && !ranges[i - 1].PosToIndexConvert); if (ranges[i - 1].Max < ranges[i].Min) continue; ranges[i - 1].Min = ImMin(ranges[i - 1].Min, ranges[i].Min); ranges[i - 1].Max = ImMax(ranges[i - 1].Max, ranges[i].Max); ranges.erase(ranges.Data + i); i--; } } static void ImGuiListClipper_SeekCursorAndSetupPrevLine(float pos_y, float line_height) { // Set cursor position and a few other things so that SetScrollHereY() and Columns() can work when seeking cursor. // FIXME: It is problematic that we have to do that here, because custom/equivalent end-user code would stumble on the same issue. // The clipper should probably have a final step to display the last item in a regular manner, maybe with an opt-out flag for data sets which may have costly seek? ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; float off_y = pos_y - window->DC.CursorPos.y; window->DC.CursorPos.y = pos_y; window->DC.CursorMaxPos.y = ImMax(window->DC.CursorMaxPos.y, pos_y - g.Style.ItemSpacing.y); window->DC.CursorPosPrevLine.y = window->DC.CursorPos.y - line_height; // Setting those fields so that SetScrollHereY() can properly function after the end of our clipper usage. window->DC.PrevLineSize.y = (line_height - g.Style.ItemSpacing.y); // If we end up needing more accurate data (to e.g. use SameLine) we may as well make the clipper have a fourth step to let user process and display the last item in their list. if (ImGuiOldColumns* columns = window->DC.CurrentColumns) columns->LineMinY = window->DC.CursorPos.y; // Setting this so that cell Y position are set properly if (ImGuiTable* table = g.CurrentTable) { if (table->IsInsideRow) ImGui::TableEndRow(table); table->RowPosY2 = window->DC.CursorPos.y; const int row_increase = (int)((off_y / line_height) + 0.5f); //table->CurrentRow += row_increase; // Can't do without fixing TableEndRow() table->RowBgColorCounter += row_increase; } } ImGuiListClipper::ImGuiListClipper() { memset(this, 0, sizeof(*this)); } ImGuiListClipper::~ImGuiListClipper() { End(); } void ImGuiListClipper::Begin(int items_count, float items_height) { if (Ctx == NULL) Ctx = ImGui::GetCurrentContext(); ImGuiContext& g = *Ctx; ImGuiWindow* window = g.CurrentWindow; IMGUI_DEBUG_LOG_CLIPPER("Clipper: Begin(%d,%.2f) in '%s'\n", items_count, items_height, window->Name); if (ImGuiTable* table = g.CurrentTable) if (table->IsInsideRow) ImGui::TableEndRow(table); StartPosY = window->DC.CursorPos.y; ItemsHeight = items_height; ItemsCount = items_count; DisplayStart = -1; DisplayEnd = 0; // Acquire temporary buffer if (++g.ClipperTempDataStacked > g.ClipperTempData.Size) g.ClipperTempData.resize(g.ClipperTempDataStacked, ImGuiListClipperData()); ImGuiListClipperData* data = &g.ClipperTempData[g.ClipperTempDataStacked - 1]; data->Reset(this); data->LossynessOffset = window->DC.CursorStartPosLossyness.y; TempData = data; StartSeekOffsetY = data->LossynessOffset; } void ImGuiListClipper::End() { if (ImGuiListClipperData* data = (ImGuiListClipperData*)TempData) { // In theory here we should assert that we are already at the right position, but it seems saner to just seek at the end and not assert/crash the user. ImGuiContext& g = *Ctx; IMGUI_DEBUG_LOG_CLIPPER("Clipper: End() in '%s'\n", g.CurrentWindow->Name); if (ItemsCount >= 0 && ItemsCount < INT_MAX && DisplayStart >= 0) SeekCursorForItem(ItemsCount); // Restore temporary buffer and fix back pointers which may be invalidated when nesting IM_ASSERT(data->ListClipper == this); data->StepNo = data->Ranges.Size; if (--g.ClipperTempDataStacked > 0) { data = &g.ClipperTempData[g.ClipperTempDataStacked - 1]; data->ListClipper->TempData = data; } TempData = NULL; } ItemsCount = -1; } void ImGuiListClipper::IncludeItemsByIndex(int item_begin, int item_end) { ImGuiListClipperData* data = (ImGuiListClipperData*)TempData; IM_ASSERT(DisplayStart < 0); // Only allowed after Begin() and if there has not been a specified range yet. IM_ASSERT(item_begin <= item_end); if (item_begin < item_end) data->Ranges.push_back(ImGuiListClipperRange::FromIndices(item_begin, item_end)); } // This is already called while stepping. // The ONLY reason you may want to call this is if you passed INT_MAX to ImGuiListClipper::Begin() because you couldn't step item count beforehand. void ImGuiListClipper::SeekCursorForItem(int item_n) { // - Perform the add and multiply with double to allow seeking through larger ranges. // - StartPosY starts from ItemsFrozen, by adding SeekOffsetY we generally cancel that out (SeekOffsetY == LossynessOffset - ItemsFrozen * ItemsHeight). // - The reason we store SeekOffsetY instead of inferring it, is because we want to allow user to perform Seek after the last step, where ImGuiListClipperData is already done. float pos_y = (float)((double)StartPosY + StartSeekOffsetY + (double)item_n * ItemsHeight); ImGuiListClipper_SeekCursorAndSetupPrevLine(pos_y, ItemsHeight); } static bool ImGuiListClipper_StepInternal(ImGuiListClipper* clipper) { ImGuiContext& g = *clipper->Ctx; ImGuiWindow* window = g.CurrentWindow; ImGuiListClipperData* data = (ImGuiListClipperData*)clipper->TempData; IM_ASSERT(data != NULL && "Called ImGuiListClipper::Step() too many times, or before ImGuiListClipper::Begin() ?"); ImGuiTable* table = g.CurrentTable; if (table && table->IsInsideRow) ImGui::TableEndRow(table); // No items if (clipper->ItemsCount == 0 || GetSkipItemForListClipping()) return false; // While we are in frozen row state, keep displaying items one by one, unclipped // FIXME: Could be stored as a table-agnostic state. if (data->StepNo == 0 && table != NULL && !table->IsUnfrozenRows) { clipper->DisplayStart = data->ItemsFrozen; clipper->DisplayEnd = ImMin(data->ItemsFrozen + 1, clipper->ItemsCount); if (clipper->DisplayStart < clipper->DisplayEnd) data->ItemsFrozen++; return true; } // Step 0: Let you process the first element (regardless of it being visible or not, so we can measure the element height) bool calc_clipping = false; if (data->StepNo == 0) { clipper->StartPosY = window->DC.CursorPos.y; if (clipper->ItemsHeight <= 0.0f) { // Submit the first item (or range) so we can measure its height (generally the first range is 0..1) data->Ranges.push_front(ImGuiListClipperRange::FromIndices(data->ItemsFrozen, data->ItemsFrozen + 1)); clipper->DisplayStart = ImMax(data->Ranges[0].Min, data->ItemsFrozen); clipper->DisplayEnd = ImMin(data->Ranges[0].Max, clipper->ItemsCount); data->StepNo = 1; return true; } calc_clipping = true; // If on the first step with known item height, calculate clipping. } // Step 1: Let the clipper infer height from first range if (clipper->ItemsHeight <= 0.0f) { IM_ASSERT(data->StepNo == 1); if (table) IM_ASSERT(table->RowPosY1 == clipper->StartPosY && table->RowPosY2 == window->DC.CursorPos.y); clipper->ItemsHeight = (window->DC.CursorPos.y - clipper->StartPosY) / (float)(clipper->DisplayEnd - clipper->DisplayStart); bool affected_by_floating_point_precision = ImIsFloatAboveGuaranteedIntegerPrecision(clipper->StartPosY) || ImIsFloatAboveGuaranteedIntegerPrecision(window->DC.CursorPos.y); if (affected_by_floating_point_precision) clipper->ItemsHeight = window->DC.PrevLineSize.y + g.Style.ItemSpacing.y; // FIXME: Technically wouldn't allow multi-line entries. if (clipper->ItemsHeight == 0.0f && clipper->ItemsCount == INT_MAX) // Accept that no item have been submitted if in indeterminate mode. return false; IM_ASSERT(clipper->ItemsHeight > 0.0f && "Unable to calculate item height! First item hasn't moved the cursor vertically!"); calc_clipping = true; // If item height had to be calculated, calculate clipping afterwards. } // Step 0 or 1: Calculate the actual ranges of visible elements. const int already_submitted = clipper->DisplayEnd; if (calc_clipping) { // Record seek offset, this is so ImGuiListClipper::Seek() can be called after ImGuiListClipperData is done clipper->StartSeekOffsetY = (double)data->LossynessOffset - data->ItemsFrozen * (double)clipper->ItemsHeight; if (g.LogEnabled) { // If logging is active, do not perform any clipping data->Ranges.push_back(ImGuiListClipperRange::FromIndices(0, clipper->ItemsCount)); } else { // Add range selected to be included for navigation const bool is_nav_request = (g.NavMoveScoringItems && g.NavWindow && g.NavWindow->RootWindowForNav == window->RootWindowForNav); if (is_nav_request) data->Ranges.push_back(ImGuiListClipperRange::FromPositions(g.NavScoringNoClipRect.Min.y, g.NavScoringNoClipRect.Max.y, 0, 0)); if (is_nav_request && (g.NavMoveFlags & ImGuiNavMoveFlags_IsTabbing) && g.NavTabbingDir == -1) data->Ranges.push_back(ImGuiListClipperRange::FromIndices(clipper->ItemsCount - 1, clipper->ItemsCount)); // Add focused/active item ImRect nav_rect_abs = ImGui::WindowRectRelToAbs(window, window->NavRectRel[0]); if (g.NavId != 0 && window->NavLastIds[0] == g.NavId) data->Ranges.push_back(ImGuiListClipperRange::FromPositions(nav_rect_abs.Min.y, nav_rect_abs.Max.y, 0, 0)); // Add visible range float min_y = window->ClipRect.Min.y; float max_y = window->ClipRect.Max.y; // Add box selection range ImGuiBoxSelectState* bs = &g.BoxSelectState; if (bs->IsActive && bs->Window == window) { // FIXME: Selectable() use of half-ItemSpacing isn't consistent in matter of layout, as ItemAdd(bb) stray above ItemSize()'s CursorPos. // RangeSelect's BoxSelect relies on comparing overlap of previous and current rectangle and is sensitive to that. // As a workaround we currently half ItemSpacing worth on each side. min_y -= g.Style.ItemSpacing.y; max_y += g.Style.ItemSpacing.y; // Box-select on 2D area requires different clipping. if (bs->UnclipMode) data->Ranges.push_back(ImGuiListClipperRange::FromPositions(bs->UnclipRect.Min.y, bs->UnclipRect.Max.y, 0, 0)); } const int off_min = (is_nav_request && g.NavMoveClipDir == ImGuiDir_Up) ? -1 : 0; const int off_max = (is_nav_request && g.NavMoveClipDir == ImGuiDir_Down) ? 1 : 0; data->Ranges.push_back(ImGuiListClipperRange::FromPositions(min_y, max_y, off_min, off_max)); } // Convert position ranges to item index ranges // - Very important: when a starting position is after our maximum item, we set Min to (ItemsCount - 1). This allows us to handle most forms of wrapping. // - Due to how Selectable extra padding they tend to be "unaligned" with exact unit in the item list, // which with the flooring/ceiling tend to lead to 2 items instead of one being submitted. for (ImGuiListClipperRange& range : data->Ranges) if (range.PosToIndexConvert) { int m1 = (int)(((double)range.Min - window->DC.CursorPos.y - data->LossynessOffset) / clipper->ItemsHeight); int m2 = (int)((((double)range.Max - window->DC.CursorPos.y - data->LossynessOffset) / clipper->ItemsHeight) + 0.999999f); range.Min = ImClamp(already_submitted + m1 + range.PosToIndexOffsetMin, already_submitted, clipper->ItemsCount - 1); range.Max = ImClamp(already_submitted + m2 + range.PosToIndexOffsetMax, range.Min + 1, clipper->ItemsCount); range.PosToIndexConvert = false; } ImGuiListClipper_SortAndFuseRanges(data->Ranges, data->StepNo); } // Step 0+ (if item height is given in advance) or 1+: Display the next range in line. while (data->StepNo < data->Ranges.Size) { clipper->DisplayStart = ImMax(data->Ranges[data->StepNo].Min, already_submitted); clipper->DisplayEnd = ImMin(data->Ranges[data->StepNo].Max, clipper->ItemsCount); data->StepNo++; if (clipper->DisplayStart >= clipper->DisplayEnd) continue; if (clipper->DisplayStart > already_submitted) clipper->SeekCursorForItem(clipper->DisplayStart); return true; } // After the last step: Let the clipper validate that we have reached the expected Y position (corresponding to element DisplayEnd), // Advance the cursor to the end of the list and then returns 'false' to end the loop. if (clipper->ItemsCount < INT_MAX) clipper->SeekCursorForItem(clipper->ItemsCount); return false; } bool ImGuiListClipper::Step() { ImGuiContext& g = *Ctx; bool need_items_height = (ItemsHeight <= 0.0f); bool ret = ImGuiListClipper_StepInternal(this); if (ret && (DisplayStart >= DisplayEnd)) ret = false; if (g.CurrentTable && g.CurrentTable->IsUnfrozenRows == false) IMGUI_DEBUG_LOG_CLIPPER("Clipper: Step(): inside frozen table row.\n"); if (need_items_height && ItemsHeight > 0.0f) IMGUI_DEBUG_LOG_CLIPPER("Clipper: Step(): computed ItemsHeight: %.2f.\n", ItemsHeight); if (ret) { IMGUI_DEBUG_LOG_CLIPPER("Clipper: Step(): display %d to %d.\n", DisplayStart, DisplayEnd); } else { IMGUI_DEBUG_LOG_CLIPPER("Clipper: Step(): End.\n"); End(); } return ret; } //----------------------------------------------------------------------------- // [SECTION] STYLING //----------------------------------------------------------------------------- ImGuiStyle& ImGui::GetStyle() { IM_ASSERT(GImGui != NULL && "No current context. Did you call ImGui::CreateContext() and ImGui::SetCurrentContext() ?"); return GImGui->Style; } ImU32 ImGui::GetColorU32(ImGuiCol idx, float alpha_mul) { ImGuiStyle& style = GImGui->Style; ImVec4 c = style.Colors[idx]; c.w *= style.Alpha * alpha_mul; return ColorConvertFloat4ToU32(c); } ImU32 ImGui::GetColorU32(const ImVec4& col) { ImGuiStyle& style = GImGui->Style; ImVec4 c = col; c.w *= style.Alpha; return ColorConvertFloat4ToU32(c); } const ImVec4& ImGui::GetStyleColorVec4(ImGuiCol idx) { ImGuiStyle& style = GImGui->Style; return style.Colors[idx]; } ImU32 ImGui::GetColorU32(ImU32 col, float alpha_mul) { ImGuiStyle& style = GImGui->Style; alpha_mul *= style.Alpha; if (alpha_mul >= 1.0f) return col; ImU32 a = (col & IM_COL32_A_MASK) >> IM_COL32_A_SHIFT; a = (ImU32)(a * alpha_mul); // We don't need to clamp 0..255 because alpha is in 0..1 range. return (col & ~IM_COL32_A_MASK) | (a << IM_COL32_A_SHIFT); } // FIXME: This may incur a round-trip (if the end user got their data from a float4) but eventually we aim to store the in-flight colors as ImU32 void ImGui::PushStyleColor(ImGuiCol idx, ImU32 col) { ImGuiContext& g = *GImGui; ImGuiColorMod backup; backup.Col = idx; backup.BackupValue = g.Style.Colors[idx]; g.ColorStack.push_back(backup); if (g.DebugFlashStyleColorIdx != idx) g.Style.Colors[idx] = ColorConvertU32ToFloat4(col); } void ImGui::PushStyleColor(ImGuiCol idx, const ImVec4& col) { ImGuiContext& g = *GImGui; ImGuiColorMod backup; backup.Col = idx; backup.BackupValue = g.Style.Colors[idx]; g.ColorStack.push_back(backup); if (g.DebugFlashStyleColorIdx != idx) g.Style.Colors[idx] = col; } void ImGui::PopStyleColor(int count) { ImGuiContext& g = *GImGui; if (g.ColorStack.Size < count) { IM_ASSERT_USER_ERROR(0, "Calling PopStyleColor() too many times!"); count = g.ColorStack.Size; } while (count > 0) { ImGuiColorMod& backup = g.ColorStack.back(); g.Style.Colors[backup.Col] = backup.BackupValue; g.ColorStack.pop_back(); count--; } } static const ImGuiStyleVarInfo GStyleVarsInfo[] = { { 1, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, Alpha) }, // ImGuiStyleVar_Alpha { 1, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, DisabledAlpha) }, // ImGuiStyleVar_DisabledAlpha { 2, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, WindowPadding) }, // ImGuiStyleVar_WindowPadding { 1, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, WindowRounding) }, // ImGuiStyleVar_WindowRounding { 1, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, WindowBorderSize) }, // ImGuiStyleVar_WindowBorderSize { 2, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, WindowMinSize) }, // ImGuiStyleVar_WindowMinSize { 2, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, WindowTitleAlign) }, // ImGuiStyleVar_WindowTitleAlign { 1, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, ChildRounding) }, // ImGuiStyleVar_ChildRounding { 1, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, ChildBorderSize) }, // ImGuiStyleVar_ChildBorderSize { 1, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, PopupRounding) }, // ImGuiStyleVar_PopupRounding { 1, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, PopupBorderSize) }, // ImGuiStyleVar_PopupBorderSize { 2, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, FramePadding) }, // ImGuiStyleVar_FramePadding { 1, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, FrameRounding) }, // ImGuiStyleVar_FrameRounding { 1, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, FrameBorderSize) }, // ImGuiStyleVar_FrameBorderSize { 2, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, ItemSpacing) }, // ImGuiStyleVar_ItemSpacing { 2, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, ItemInnerSpacing) }, // ImGuiStyleVar_ItemInnerSpacing { 1, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, IndentSpacing) }, // ImGuiStyleVar_IndentSpacing { 2, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, CellPadding) }, // ImGuiStyleVar_CellPadding { 1, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, ScrollbarSize) }, // ImGuiStyleVar_ScrollbarSize { 1, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, ScrollbarRounding) }, // ImGuiStyleVar_ScrollbarRounding { 1, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, GrabMinSize) }, // ImGuiStyleVar_GrabMinSize { 1, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, GrabRounding) }, // ImGuiStyleVar_GrabRounding { 1, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, ImageBorderSize) }, // ImGuiStyleVar_ImageBorderSize { 1, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, TabRounding) }, // ImGuiStyleVar_TabRounding { 1, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, TabBorderSize) }, // ImGuiStyleVar_TabBorderSize { 1, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, TabBarBorderSize) }, // ImGuiStyleVar_TabBarBorderSize { 1, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, TabBarOverlineSize) }, // ImGuiStyleVar_TabBarOverlineSize { 1, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, TableAngledHeadersAngle)}, // ImGuiStyleVar_TableAngledHeadersAngle { 2, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, TableAngledHeadersTextAlign)},// ImGuiStyleVar_TableAngledHeadersTextAlign { 2, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, ButtonTextAlign) }, // ImGuiStyleVar_ButtonTextAlign { 2, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, SelectableTextAlign) }, // ImGuiStyleVar_SelectableTextAlign { 1, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, SeparatorTextBorderSize)}, // ImGuiStyleVar_SeparatorTextBorderSize { 2, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, SeparatorTextAlign) }, // ImGuiStyleVar_SeparatorTextAlign { 2, ImGuiDataType_Float, (ImU32)offsetof(ImGuiStyle, SeparatorTextPadding) }, // ImGuiStyleVar_SeparatorTextPadding }; const ImGuiStyleVarInfo* ImGui::GetStyleVarInfo(ImGuiStyleVar idx) { IM_ASSERT(idx >= 0 && idx < ImGuiStyleVar_COUNT); IM_STATIC_ASSERT(IM_ARRAYSIZE(GStyleVarsInfo) == ImGuiStyleVar_COUNT); return &GStyleVarsInfo[idx]; } void ImGui::PushStyleVar(ImGuiStyleVar idx, float val) { ImGuiContext& g = *GImGui; const ImGuiStyleVarInfo* var_info = GetStyleVarInfo(idx); if (var_info->DataType != ImGuiDataType_Float || var_info->Count != 1) { IM_ASSERT_USER_ERROR(0, "Calling PushStyleVar() variant with wrong type!"); return; } float* pvar = (float*)var_info->GetVarPtr(&g.Style); g.StyleVarStack.push_back(ImGuiStyleMod(idx, *pvar)); *pvar = val; } void ImGui::PushStyleVarX(ImGuiStyleVar idx, float val_x) { ImGuiContext& g = *GImGui; const ImGuiStyleVarInfo* var_info = GetStyleVarInfo(idx); if (var_info->DataType != ImGuiDataType_Float || var_info->Count != 2) { IM_ASSERT_USER_ERROR(0, "Calling PushStyleVar() variant with wrong type!"); return; } ImVec2* pvar = (ImVec2*)var_info->GetVarPtr(&g.Style); g.StyleVarStack.push_back(ImGuiStyleMod(idx, *pvar)); pvar->x = val_x; } void ImGui::PushStyleVarY(ImGuiStyleVar idx, float val_y) { ImGuiContext& g = *GImGui; const ImGuiStyleVarInfo* var_info = GetStyleVarInfo(idx); if (var_info->DataType != ImGuiDataType_Float || var_info->Count != 2) { IM_ASSERT_USER_ERROR(0, "Calling PushStyleVar() variant with wrong type!"); return; } ImVec2* pvar = (ImVec2*)var_info->GetVarPtr(&g.Style); g.StyleVarStack.push_back(ImGuiStyleMod(idx, *pvar)); pvar->y = val_y; } void ImGui::PushStyleVar(ImGuiStyleVar idx, const ImVec2& val) { ImGuiContext& g = *GImGui; const ImGuiStyleVarInfo* var_info = GetStyleVarInfo(idx); if (var_info->DataType != ImGuiDataType_Float || var_info->Count != 2) { IM_ASSERT_USER_ERROR(0, "Calling PushStyleVar() variant with wrong type!"); return; } ImVec2* pvar = (ImVec2*)var_info->GetVarPtr(&g.Style); g.StyleVarStack.push_back(ImGuiStyleMod(idx, *pvar)); *pvar = val; } void ImGui::PopStyleVar(int count) { ImGuiContext& g = *GImGui; if (g.StyleVarStack.Size < count) { IM_ASSERT_USER_ERROR(0, "Calling PopStyleVar() too many times!"); count = g.StyleVarStack.Size; } while (count > 0) { // We avoid a generic memcpy(data, &backup.Backup.., GDataTypeSize[info->Type] * info->Count), the overhead in Debug is not worth it. ImGuiStyleMod& backup = g.StyleVarStack.back(); const ImGuiStyleVarInfo* var_info = GetStyleVarInfo(backup.VarIdx); void* data = var_info->GetVarPtr(&g.Style); if (var_info->DataType == ImGuiDataType_Float && var_info->Count == 1) { ((float*)data)[0] = backup.BackupFloat[0]; } else if (var_info->DataType == ImGuiDataType_Float && var_info->Count == 2) { ((float*)data)[0] = backup.BackupFloat[0]; ((float*)data)[1] = backup.BackupFloat[1]; } g.StyleVarStack.pop_back(); count--; } } const char* ImGui::GetStyleColorName(ImGuiCol idx) { // Create switch-case from enum with regexp: ImGuiCol_{.*}, --> case ImGuiCol_\1: return "\1"; switch (idx) { case ImGuiCol_Text: return "Text"; case ImGuiCol_TextDisabled: return "TextDisabled"; case ImGuiCol_WindowBg: return "WindowBg"; case ImGuiCol_ChildBg: return "ChildBg"; case ImGuiCol_PopupBg: return "PopupBg"; case ImGuiCol_Border: return "Border"; case ImGuiCol_BorderShadow: return "BorderShadow"; case ImGuiCol_FrameBg: return "FrameBg"; case ImGuiCol_FrameBgHovered: return "FrameBgHovered"; case ImGuiCol_FrameBgActive: return "FrameBgActive"; case ImGuiCol_TitleBg: return "TitleBg"; case ImGuiCol_TitleBgActive: return "TitleBgActive"; case ImGuiCol_TitleBgCollapsed: return "TitleBgCollapsed"; case ImGuiCol_MenuBarBg: return "MenuBarBg"; case ImGuiCol_ScrollbarBg: return "ScrollbarBg"; case ImGuiCol_ScrollbarGrab: return "ScrollbarGrab"; case ImGuiCol_ScrollbarGrabHovered: return "ScrollbarGrabHovered"; case ImGuiCol_ScrollbarGrabActive: return "ScrollbarGrabActive"; case ImGuiCol_CheckMark: return "CheckMark"; case ImGuiCol_SliderGrab: return "SliderGrab"; case ImGuiCol_SliderGrabActive: return "SliderGrabActive"; case ImGuiCol_Button: return "Button"; case ImGuiCol_ButtonHovered: return "ButtonHovered"; case ImGuiCol_ButtonActive: return "ButtonActive"; case ImGuiCol_Header: return "Header"; case ImGuiCol_HeaderHovered: return "HeaderHovered"; case ImGuiCol_HeaderActive: return "HeaderActive"; case ImGuiCol_Separator: return "Separator"; case ImGuiCol_SeparatorHovered: return "SeparatorHovered"; case ImGuiCol_SeparatorActive: return "SeparatorActive"; case ImGuiCol_ResizeGrip: return "ResizeGrip"; case ImGuiCol_ResizeGripHovered: return "ResizeGripHovered"; case ImGuiCol_ResizeGripActive: return "ResizeGripActive"; case ImGuiCol_TabHovered: return "TabHovered"; case ImGuiCol_Tab: return "Tab"; case ImGuiCol_TabSelected: return "TabSelected"; case ImGuiCol_TabSelectedOverline: return "TabSelectedOverline"; case ImGuiCol_TabDimmed: return "TabDimmed"; case ImGuiCol_TabDimmedSelected: return "TabDimmedSelected"; case ImGuiCol_TabDimmedSelectedOverline: return "TabDimmedSelectedOverline"; case ImGuiCol_PlotLines: return "PlotLines"; case ImGuiCol_PlotLinesHovered: return "PlotLinesHovered"; case ImGuiCol_PlotHistogram: return "PlotHistogram"; case ImGuiCol_PlotHistogramHovered: return "PlotHistogramHovered"; case ImGuiCol_TableHeaderBg: return "TableHeaderBg"; case ImGuiCol_TableBorderStrong: return "TableBorderStrong"; case ImGuiCol_TableBorderLight: return "TableBorderLight"; case ImGuiCol_TableRowBg: return "TableRowBg"; case ImGuiCol_TableRowBgAlt: return "TableRowBgAlt"; case ImGuiCol_TextLink: return "TextLink"; case ImGuiCol_TextSelectedBg: return "TextSelectedBg"; case ImGuiCol_DragDropTarget: return "DragDropTarget"; case ImGuiCol_NavCursor: return "NavCursor"; case ImGuiCol_NavWindowingHighlight: return "NavWindowingHighlight"; case ImGuiCol_NavWindowingDimBg: return "NavWindowingDimBg"; case ImGuiCol_ModalWindowDimBg: return "ModalWindowDimBg"; } IM_ASSERT(0); return "Unknown"; } //----------------------------------------------------------------------------- // [SECTION] RENDER HELPERS // Some of those (internal) functions are currently quite a legacy mess - their signature and behavior will change, // we need a nicer separation between low-level functions and high-level functions relying on the ImGui context. // Also see imgui_draw.cpp for some more which have been reworked to not rely on ImGui:: context. //----------------------------------------------------------------------------- const char* ImGui::FindRenderedTextEnd(const char* text, const char* text_end) { const char* text_display_end = text; if (!text_end) text_end = (const char*)-1; while (text_display_end < text_end && *text_display_end != '\0' && (text_display_end[0] != '#' || text_display_end[1] != '#')) text_display_end++; return text_display_end; } // Internal ImGui functions to render text // RenderText***() functions calls ImDrawList::AddText() calls ImBitmapFont::RenderText() void ImGui::RenderText(ImVec2 pos, const char* text, const char* text_end, bool hide_text_after_hash) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; // Hide anything after a '##' string const char* text_display_end; if (hide_text_after_hash) { text_display_end = FindRenderedTextEnd(text, text_end); } else { if (!text_end) text_end = text + ImStrlen(text); // FIXME-OPT text_display_end = text_end; } if (text != text_display_end) { window->DrawList->AddText(g.Font, g.FontSize, pos, GetColorU32(ImGuiCol_Text), text, text_display_end); if (g.LogEnabled) LogRenderedText(&pos, text, text_display_end); } } void ImGui::RenderTextWrapped(ImVec2 pos, const char* text, const char* text_end, float wrap_width) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; if (!text_end) text_end = text + ImStrlen(text); // FIXME-OPT if (text != text_end) { window->DrawList->AddText(g.Font, g.FontSize, pos, GetColorU32(ImGuiCol_Text), text, text_end, wrap_width); if (g.LogEnabled) LogRenderedText(&pos, text, text_end); } } // Default clip_rect uses (pos_min,pos_max) // Handle clipping on CPU immediately (vs typically let the GPU clip the triangles that are overlapping the clipping rectangle edges) // FIXME-OPT: Since we have or calculate text_size we could coarse clip whole block immediately, especally for text above draw_list->DrawList. // Effectively as this is called from widget doing their own coarse clipping it's not very valuable presently. Next time function will take // better advantage of the render function taking size into account for coarse clipping. void ImGui::RenderTextClippedEx(ImDrawList* draw_list, const ImVec2& pos_min, const ImVec2& pos_max, const char* text, const char* text_display_end, const ImVec2* text_size_if_known, const ImVec2& align, const ImRect* clip_rect) { // Perform CPU side clipping for single clipped element to avoid using scissor state ImVec2 pos = pos_min; const ImVec2 text_size = text_size_if_known ? *text_size_if_known : CalcTextSize(text, text_display_end, false, 0.0f); const ImVec2* clip_min = clip_rect ? &clip_rect->Min : &pos_min; const ImVec2* clip_max = clip_rect ? &clip_rect->Max : &pos_max; bool need_clipping = (pos.x + text_size.x >= clip_max->x) || (pos.y + text_size.y >= clip_max->y); if (clip_rect) // If we had no explicit clipping rectangle then pos==clip_min need_clipping |= (pos.x < clip_min->x) || (pos.y < clip_min->y); // Align whole block. We should defer that to the better rendering function when we'll have support for individual line alignment. if (align.x > 0.0f) pos.x = ImMax(pos.x, pos.x + (pos_max.x - pos.x - text_size.x) * align.x); if (align.y > 0.0f) pos.y = ImMax(pos.y, pos.y + (pos_max.y - pos.y - text_size.y) * align.y); // Render if (need_clipping) { ImVec4 fine_clip_rect(clip_min->x, clip_min->y, clip_max->x, clip_max->y); draw_list->AddText(NULL, 0.0f, pos, GetColorU32(ImGuiCol_Text), text, text_display_end, 0.0f, &fine_clip_rect); } else { draw_list->AddText(NULL, 0.0f, pos, GetColorU32(ImGuiCol_Text), text, text_display_end, 0.0f, NULL); } } void ImGui::RenderTextClipped(const ImVec2& pos_min, const ImVec2& pos_max, const char* text, const char* text_end, const ImVec2* text_size_if_known, const ImVec2& align, const ImRect* clip_rect) { // Hide anything after a '##' string const char* text_display_end = FindRenderedTextEnd(text, text_end); const int text_len = (int)(text_display_end - text); if (text_len == 0) return; ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; RenderTextClippedEx(window->DrawList, pos_min, pos_max, text, text_display_end, text_size_if_known, align, clip_rect); if (g.LogEnabled) LogRenderedText(&pos_min, text, text_display_end); } // Another overly complex function until we reorganize everything into a nice all-in-one helper. // This is made more complex because we have dissociated the layout rectangle (pos_min..pos_max) which define _where_ the ellipsis is, from actual clipping of text and limit of the ellipsis display. // This is because in the context of tabs we selectively hide part of the text when the Close Button appears, but we don't want the ellipsis to move. void ImGui::RenderTextEllipsis(ImDrawList* draw_list, const ImVec2& pos_min, const ImVec2& pos_max, float clip_max_x, float ellipsis_max_x, const char* text, const char* text_end_full, const ImVec2* text_size_if_known) { ImGuiContext& g = *GImGui; if (text_end_full == NULL) text_end_full = FindRenderedTextEnd(text); const ImVec2 text_size = text_size_if_known ? *text_size_if_known : CalcTextSize(text, text_end_full, false, 0.0f); //draw_list->AddLine(ImVec2(pos_max.x, pos_min.y - 4), ImVec2(pos_max.x, pos_max.y + 4), IM_COL32(0, 0, 255, 255)); //draw_list->AddLine(ImVec2(ellipsis_max_x, pos_min.y-2), ImVec2(ellipsis_max_x, pos_max.y+2), IM_COL32(0, 255, 0, 255)); //draw_list->AddLine(ImVec2(clip_max_x, pos_min.y), ImVec2(clip_max_x, pos_max.y), IM_COL32(255, 0, 0, 255)); // FIXME: We could technically remove (last_glyph->AdvanceX - last_glyph->X1) from text_size.x here and save a few pixels. if (text_size.x > pos_max.x - pos_min.x) { // Hello wo... // | | | // min max ellipsis_max // <-> this is generally some padding value ImFont* font = draw_list->_Data->Font; const float font_size = draw_list->_Data->FontSize; const float font_scale = draw_list->_Data->FontScale; const char* text_end_ellipsis = NULL; const float ellipsis_width = font->EllipsisWidth * font_scale; // We can now claim the space between pos_max.x and ellipsis_max.x const float text_avail_width = ImMax((ImMax(pos_max.x, ellipsis_max_x) - ellipsis_width) - pos_min.x, 1.0f); float text_size_clipped_x = font->CalcTextSizeA(font_size, text_avail_width, 0.0f, text, text_end_full, &text_end_ellipsis).x; if (text == text_end_ellipsis && text_end_ellipsis < text_end_full) { // Always display at least 1 character if there's no room for character + ellipsis text_end_ellipsis = text + ImTextCountUtf8BytesFromChar(text, text_end_full); text_size_clipped_x = font->CalcTextSizeA(font_size, FLT_MAX, 0.0f, text, text_end_ellipsis).x; } while (text_end_ellipsis > text && ImCharIsBlankA(text_end_ellipsis[-1])) { // Trim trailing space before ellipsis (FIXME: Supporting non-ascii blanks would be nice, for this we need a function to backtrack in UTF-8 text) text_end_ellipsis--; text_size_clipped_x -= font->CalcTextSizeA(font_size, FLT_MAX, 0.0f, text_end_ellipsis, text_end_ellipsis + 1).x; // Ascii blanks are always 1 byte } // Render text, render ellipsis RenderTextClippedEx(draw_list, pos_min, ImVec2(clip_max_x, pos_max.y), text, text_end_ellipsis, &text_size, ImVec2(0.0f, 0.0f)); ImVec2 ellipsis_pos = ImTrunc(ImVec2(pos_min.x + text_size_clipped_x, pos_min.y)); if (ellipsis_pos.x + ellipsis_width <= ellipsis_max_x) for (int i = 0; i < font->EllipsisCharCount; i++, ellipsis_pos.x += font->EllipsisCharStep * font_scale) font->RenderChar(draw_list, font_size, ellipsis_pos, GetColorU32(ImGuiCol_Text), font->EllipsisChar); } else { RenderTextClippedEx(draw_list, pos_min, ImVec2(clip_max_x, pos_max.y), text, text_end_full, &text_size, ImVec2(0.0f, 0.0f)); } if (g.LogEnabled) LogRenderedText(&pos_min, text, text_end_full); } // Render a rectangle shaped with optional rounding and borders void ImGui::RenderFrame(ImVec2 p_min, ImVec2 p_max, ImU32 fill_col, bool borders, float rounding) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; window->DrawList->AddRectFilled(p_min, p_max, fill_col, rounding); const float border_size = g.Style.FrameBorderSize; if (borders && border_size > 0.0f) { window->DrawList->AddRect(p_min + ImVec2(1, 1), p_max + ImVec2(1, 1), GetColorU32(ImGuiCol_BorderShadow), rounding, 0, border_size); window->DrawList->AddRect(p_min, p_max, GetColorU32(ImGuiCol_Border), rounding, 0, border_size); } } void ImGui::RenderFrameBorder(ImVec2 p_min, ImVec2 p_max, float rounding) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; const float border_size = g.Style.FrameBorderSize; if (border_size > 0.0f) { window->DrawList->AddRect(p_min + ImVec2(1, 1), p_max + ImVec2(1, 1), GetColorU32(ImGuiCol_BorderShadow), rounding, 0, border_size); window->DrawList->AddRect(p_min, p_max, GetColorU32(ImGuiCol_Border), rounding, 0, border_size); } } void ImGui::RenderNavCursor(const ImRect& bb, ImGuiID id, ImGuiNavRenderCursorFlags flags) { ImGuiContext& g = *GImGui; if (id != g.NavId) return; if (!g.NavCursorVisible && !(flags & ImGuiNavRenderCursorFlags_AlwaysDraw)) return; if (id == g.LastItemData.ID && (g.LastItemData.ItemFlags & ImGuiItemFlags_NoNav)) return; ImGuiWindow* window = g.CurrentWindow; if (window->DC.NavHideHighlightOneFrame) return; float rounding = (flags & ImGuiNavRenderCursorFlags_NoRounding) ? 0.0f : g.Style.FrameRounding; ImRect display_rect = bb; display_rect.ClipWith(window->ClipRect); const float thickness = 2.0f; if (flags & ImGuiNavRenderCursorFlags_Compact) { window->DrawList->AddRect(display_rect.Min, display_rect.Max, GetColorU32(ImGuiCol_NavCursor), rounding, 0, thickness); } else { const float distance = 3.0f + thickness * 0.5f; display_rect.Expand(ImVec2(distance, distance)); bool fully_visible = window->ClipRect.Contains(display_rect); if (!fully_visible) window->DrawList->PushClipRect(display_rect.Min, display_rect.Max); window->DrawList->AddRect(display_rect.Min, display_rect.Max, GetColorU32(ImGuiCol_NavCursor), rounding, 0, thickness); if (!fully_visible) window->DrawList->PopClipRect(); } } void ImGui::RenderMouseCursor(ImVec2 base_pos, float base_scale, ImGuiMouseCursor mouse_cursor, ImU32 col_fill, ImU32 col_border, ImU32 col_shadow) { ImGuiContext& g = *GImGui; if (mouse_cursor <= ImGuiMouseCursor_None || mouse_cursor >= ImGuiMouseCursor_COUNT) // We intentionally accept out of bound values. mouse_cursor = ImGuiMouseCursor_Arrow; ImFontAtlas* font_atlas = g.DrawListSharedData.Font->ContainerAtlas; for (ImGuiViewportP* viewport : g.Viewports) { // We scale cursor with current viewport/monitor, however Windows 10 for its own hardware cursor seems to be using a different scale factor. ImVec2 offset, size, uv[4]; if (!ImFontAtlasGetMouseCursorTexData(font_atlas, mouse_cursor, &offset, &size, &uv[0], &uv[2])) continue; const ImVec2 pos = base_pos - offset; const float scale = base_scale; if (!viewport->GetMainRect().Overlaps(ImRect(pos, pos + ImVec2(size.x + 2, size.y + 2) * scale))) continue; ImDrawList* draw_list = GetForegroundDrawList(viewport); ImTextureID tex_id = font_atlas->TexID; draw_list->PushTextureID(tex_id); draw_list->AddImage(tex_id, pos + ImVec2(1, 0) * scale, pos + (ImVec2(1, 0) + size) * scale, uv[2], uv[3], col_shadow); draw_list->AddImage(tex_id, pos + ImVec2(2, 0) * scale, pos + (ImVec2(2, 0) + size) * scale, uv[2], uv[3], col_shadow); draw_list->AddImage(tex_id, pos, pos + size * scale, uv[2], uv[3], col_border); draw_list->AddImage(tex_id, pos, pos + size * scale, uv[0], uv[1], col_fill); if (mouse_cursor == ImGuiMouseCursor_Wait || mouse_cursor == ImGuiMouseCursor_Progress) { float a_min = ImFmod((float)g.Time * 5.0f, 2.0f * IM_PI); float a_max = a_min + IM_PI * 1.65f; draw_list->PathArcTo(pos + ImVec2(14, -1) * scale, 6.0f * scale, a_min, a_max); draw_list->PathStroke(col_fill, ImDrawFlags_None, 3.0f * scale); } draw_list->PopTextureID(); } } //----------------------------------------------------------------------------- // [SECTION] INITIALIZATION, SHUTDOWN //----------------------------------------------------------------------------- // Internal state access - if you want to share Dear ImGui state between modules (e.g. DLL) or allocate it yourself // Note that we still point to some static data and members (such as GFontAtlas), so the state instance you end up using will point to the static data within its module ImGuiContext* ImGui::GetCurrentContext() { return GImGui; } void ImGui::SetCurrentContext(ImGuiContext* ctx) { #ifdef IMGUI_SET_CURRENT_CONTEXT_FUNC IMGUI_SET_CURRENT_CONTEXT_FUNC(ctx); // For custom thread-based hackery you may want to have control over this. #else GImGui = ctx; #endif } void ImGui::SetAllocatorFunctions(ImGuiMemAllocFunc alloc_func, ImGuiMemFreeFunc free_func, void* user_data) { GImAllocatorAllocFunc = alloc_func; GImAllocatorFreeFunc = free_func; GImAllocatorUserData = user_data; } // This is provided to facilitate copying allocators from one static/DLL boundary to another (e.g. retrieve default allocator of your executable address space) void ImGui::GetAllocatorFunctions(ImGuiMemAllocFunc* p_alloc_func, ImGuiMemFreeFunc* p_free_func, void** p_user_data) { *p_alloc_func = GImAllocatorAllocFunc; *p_free_func = GImAllocatorFreeFunc; *p_user_data = GImAllocatorUserData; } ImGuiContext* ImGui::CreateContext(ImFontAtlas* shared_font_atlas) { ImGuiContext* prev_ctx = GetCurrentContext(); ImGuiContext* ctx = IM_NEW(ImGuiContext)(shared_font_atlas); SetCurrentContext(ctx); Initialize(); if (prev_ctx != NULL) SetCurrentContext(prev_ctx); // Restore previous context if any, else keep new one. return ctx; } void ImGui::DestroyContext(ImGuiContext* ctx) { ImGuiContext* prev_ctx = GetCurrentContext(); if (ctx == NULL) //-V1051 ctx = prev_ctx; SetCurrentContext(ctx); Shutdown(); SetCurrentContext((prev_ctx != ctx) ? prev_ctx : NULL); IM_DELETE(ctx); } // IMPORTANT: interactive elements requires a fixed ###xxx suffix, it must be same in ALL languages to allow for automation. static const ImGuiLocEntry GLocalizationEntriesEnUS[] = { { ImGuiLocKey_VersionStr, "Dear ImGui " IMGUI_VERSION " (" IM_STRINGIFY(IMGUI_VERSION_NUM) ")" }, { ImGuiLocKey_TableSizeOne, "Size column to fit###SizeOne" }, { ImGuiLocKey_TableSizeAllFit, "Size all columns to fit###SizeAll" }, { ImGuiLocKey_TableSizeAllDefault, "Size all columns to default###SizeAll" }, { ImGuiLocKey_TableResetOrder, "Reset order###ResetOrder" }, { ImGuiLocKey_WindowingMainMenuBar, "(Main menu bar)" }, { ImGuiLocKey_WindowingPopup, "(Popup)" }, { ImGuiLocKey_WindowingUntitled, "(Untitled)" }, { ImGuiLocKey_OpenLink_s, "Open '%s'" }, { ImGuiLocKey_CopyLink, "Copy Link###CopyLink" }, }; ImGuiContext::ImGuiContext(ImFontAtlas* shared_font_atlas) { IO.Ctx = this; InputTextState.Ctx = this; Initialized = false; FontAtlasOwnedByContext = shared_font_atlas ? false : true; Font = NULL; FontSize = FontBaseSize = FontScale = CurrentDpiScale = 0.0f; IO.Fonts = shared_font_atlas ? shared_font_atlas : IM_NEW(ImFontAtlas)(); Time = 0.0f; FrameCount = 0; FrameCountEnded = FrameCountRendered = -1; WithinEndChildID = 0; WithinFrameScope = WithinFrameScopeWithImplicitWindow = false; GcCompactAll = false; TestEngineHookItems = false; TestEngine = NULL; memset(ContextName, 0, sizeof(ContextName)); InputEventsNextMouseSource = ImGuiMouseSource_Mouse; InputEventsNextEventId = 1; WindowsActiveCount = 0; WindowsBorderHoverPadding = 0.0f; CurrentWindow = NULL; HoveredWindow = NULL; HoveredWindowUnderMovingWindow = NULL; HoveredWindowBeforeClear = NULL; MovingWindow = NULL; WheelingWindow = NULL; WheelingWindowStartFrame = WheelingWindowScrolledFrame = -1; WheelingWindowReleaseTimer = 0.0f; DebugDrawIdConflicts = 0; DebugHookIdInfo = 0; HoveredId = HoveredIdPreviousFrame = 0; HoveredIdPreviousFrameItemCount = 0; HoveredIdAllowOverlap = false; HoveredIdIsDisabled = false; HoveredIdTimer = HoveredIdNotActiveTimer = 0.0f; ItemUnclipByLog = false; ActiveId = 0; ActiveIdIsAlive = 0; ActiveIdTimer = 0.0f; ActiveIdIsJustActivated = false; ActiveIdAllowOverlap = false; ActiveIdNoClearOnFocusLoss = false; ActiveIdHasBeenPressedBefore = false; ActiveIdHasBeenEditedBefore = false; ActiveIdHasBeenEditedThisFrame = false; ActiveIdFromShortcut = false; ActiveIdClickOffset = ImVec2(-1, -1); ActiveIdWindow = NULL; ActiveIdSource = ImGuiInputSource_None; ActiveIdMouseButton = -1; ActiveIdPreviousFrame = 0; memset(&DeactivatedItemData, 0, sizeof(DeactivatedItemData)); memset(&ActiveIdValueOnActivation, 0, sizeof(ActiveIdValueOnActivation)); LastActiveId = 0; LastActiveIdTimer = 0.0f; LastKeyboardKeyPressTime = LastKeyModsChangeTime = LastKeyModsChangeFromNoneTime = -1.0; ActiveIdUsingNavDirMask = 0x00; ActiveIdUsingAllKeyboardKeys = false; CurrentFocusScopeId = 0; CurrentItemFlags = ImGuiItemFlags_None; DebugShowGroupRects = false; NavCursorVisible = false; NavHighlightItemUnderNav = false; NavMousePosDirty = false; NavIdIsAlive = false; NavId = 0; NavWindow = NULL; NavFocusScopeId = NavActivateId = NavActivateDownId = NavActivatePressedId = 0; NavLayer = ImGuiNavLayer_Main; NavNextActivateId = 0; NavActivateFlags = NavNextActivateFlags = ImGuiActivateFlags_None; NavHighlightActivatedId = 0; NavHighlightActivatedTimer = 0.0f; NavInputSource = ImGuiInputSource_Keyboard; NavLastValidSelectionUserData = ImGuiSelectionUserData_Invalid; NavCursorHideFrames = 0; NavAnyRequest = false; NavInitRequest = false; NavInitRequestFromMove = false; NavMoveSubmitted = false; NavMoveScoringItems = false; NavMoveForwardToNextFrame = false; NavMoveFlags = ImGuiNavMoveFlags_None; NavMoveScrollFlags = ImGuiScrollFlags_None; NavMoveKeyMods = ImGuiMod_None; NavMoveDir = NavMoveDirForDebug = NavMoveClipDir = ImGuiDir_None; NavScoringDebugCount = 0; NavTabbingDir = 0; NavTabbingCounter = 0; NavJustMovedFromFocusScopeId = NavJustMovedToId = NavJustMovedToFocusScopeId = 0; NavJustMovedToKeyMods = ImGuiMod_None; NavJustMovedToIsTabbing = false; NavJustMovedToHasSelectionData = false; // All platforms use Ctrl+Tab but Ctrl<>Super are swapped on Mac... // FIXME: Because this value is stored, it annoyingly interfere with toggling io.ConfigMacOSXBehaviors updating this.. ConfigNavWindowingKeyNext = IO.ConfigMacOSXBehaviors ? (ImGuiMod_Super | ImGuiKey_Tab) : (ImGuiMod_Ctrl | ImGuiKey_Tab); ConfigNavWindowingKeyPrev = IO.ConfigMacOSXBehaviors ? (ImGuiMod_Super | ImGuiMod_Shift | ImGuiKey_Tab) : (ImGuiMod_Ctrl | ImGuiMod_Shift | ImGuiKey_Tab); NavWindowingTarget = NavWindowingTargetAnim = NavWindowingListWindow = NULL; NavWindowingTimer = NavWindowingHighlightAlpha = 0.0f; NavWindowingToggleLayer = false; NavWindowingToggleKey = ImGuiKey_None; DimBgRatio = 0.0f; DragDropActive = DragDropWithinSource = DragDropWithinTarget = false; DragDropSourceFlags = ImGuiDragDropFlags_None; DragDropSourceFrameCount = -1; DragDropMouseButton = -1; DragDropTargetId = 0; DragDropAcceptFlags = ImGuiDragDropFlags_None; DragDropAcceptIdCurrRectSurface = 0.0f; DragDropAcceptIdPrev = DragDropAcceptIdCurr = 0; DragDropAcceptFrameCount = -1; DragDropHoldJustPressedId = 0; memset(DragDropPayloadBufLocal, 0, sizeof(DragDropPayloadBufLocal)); ClipperTempDataStacked = 0; CurrentTable = NULL; TablesTempDataStacked = 0; CurrentTabBar = NULL; CurrentMultiSelect = NULL; MultiSelectTempDataStacked = 0; HoverItemDelayId = HoverItemDelayIdPreviousFrame = HoverItemUnlockedStationaryId = HoverWindowUnlockedStationaryId = 0; HoverItemDelayTimer = HoverItemDelayClearTimer = 0.0f; MouseCursor = ImGuiMouseCursor_Arrow; MouseStationaryTimer = 0.0f; TempInputId = 0; memset(&DataTypeZeroValue, 0, sizeof(DataTypeZeroValue)); BeginMenuDepth = BeginComboDepth = 0; ColorEditOptions = ImGuiColorEditFlags_DefaultOptions_; ColorEditCurrentID = ColorEditSavedID = 0; ColorEditSavedHue = ColorEditSavedSat = 0.0f; ColorEditSavedColor = 0; WindowResizeRelativeMode = false; ScrollbarSeekMode = 0; ScrollbarClickDeltaToGrabCenter = 0.0f; SliderGrabClickOffset = 0.0f; SliderCurrentAccum = 0.0f; SliderCurrentAccumDirty = false; DragCurrentAccumDirty = false; DragCurrentAccum = 0.0f; DragSpeedDefaultRatio = 1.0f / 100.0f; DisabledAlphaBackup = 0.0f; DisabledStackSize = 0; TooltipOverrideCount = 0; TooltipPreviousWindow = NULL; PlatformImeData.InputPos = ImVec2(0.0f, 0.0f); PlatformImeDataPrev.InputPos = ImVec2(-1.0f, -1.0f); // Different to ensure initial submission SettingsLoaded = false; SettingsDirtyTimer = 0.0f; HookIdNext = 0; memset(LocalizationTable, 0, sizeof(LocalizationTable)); LogEnabled = false; LogFlags = ImGuiLogFlags_None; LogWindow = NULL; LogNextPrefix = LogNextSuffix = NULL; LogFile = NULL; LogLinePosY = FLT_MAX; LogLineFirstItem = false; LogDepthRef = 0; LogDepthToExpand = LogDepthToExpandDefault = 2; ErrorCallback = NULL; ErrorCallbackUserData = NULL; ErrorFirst = true; ErrorCountCurrentFrame = 0; StackSizesInBeginForCurrentWindow = NULL; DebugDrawIdConflictsCount = 0; DebugLogFlags = ImGuiDebugLogFlags_EventError | ImGuiDebugLogFlags_OutputToTTY; DebugLocateId = 0; DebugLogSkippedErrors = 0; DebugLogAutoDisableFlags = ImGuiDebugLogFlags_None; DebugLogAutoDisableFrames = 0; DebugLocateFrames = 0; DebugBeginReturnValueCullDepth = -1; DebugItemPickerActive = false; DebugItemPickerMouseButton = ImGuiMouseButton_Left; DebugItemPickerBreakId = 0; DebugFlashStyleColorTime = 0.0f; DebugFlashStyleColorIdx = ImGuiCol_COUNT; // Same as DebugBreakClearData(). Those fields are scattered in their respective subsystem to stay in hot-data locations DebugBreakInWindow = 0; DebugBreakInTable = 0; DebugBreakInLocateId = false; DebugBreakKeyChord = ImGuiKey_Pause; DebugBreakInShortcutRouting = ImGuiKey_None; memset(FramerateSecPerFrame, 0, sizeof(FramerateSecPerFrame)); FramerateSecPerFrameIdx = FramerateSecPerFrameCount = 0; FramerateSecPerFrameAccum = 0.0f; WantCaptureMouseNextFrame = WantCaptureKeyboardNextFrame = WantTextInputNextFrame = -1; memset(TempKeychordName, 0, sizeof(TempKeychordName)); } void ImGui::Initialize() { ImGuiContext& g = *GImGui; IM_ASSERT(!g.Initialized && !g.SettingsLoaded); // Add .ini handle for ImGuiWindow and ImGuiTable types { ImGuiSettingsHandler ini_handler; ini_handler.TypeName = "Window"; ini_handler.TypeHash = ImHashStr("Window"); ini_handler.ClearAllFn = WindowSettingsHandler_ClearAll; ini_handler.ReadOpenFn = WindowSettingsHandler_ReadOpen; ini_handler.ReadLineFn = WindowSettingsHandler_ReadLine; ini_handler.ApplyAllFn = WindowSettingsHandler_ApplyAll; ini_handler.WriteAllFn = WindowSettingsHandler_WriteAll; AddSettingsHandler(&ini_handler); } TableSettingsAddSettingsHandler(); // Setup default localization table LocalizeRegisterEntries(GLocalizationEntriesEnUS, IM_ARRAYSIZE(GLocalizationEntriesEnUS)); // Setup default ImGuiPlatformIO clipboard/IME handlers. g.PlatformIO.Platform_GetClipboardTextFn = Platform_GetClipboardTextFn_DefaultImpl; // Platform dependent default implementations g.PlatformIO.Platform_SetClipboardTextFn = Platform_SetClipboardTextFn_DefaultImpl; g.PlatformIO.Platform_OpenInShellFn = Platform_OpenInShellFn_DefaultImpl; g.PlatformIO.Platform_SetImeDataFn = Platform_SetImeDataFn_DefaultImpl; // Create default viewport ImGuiViewportP* viewport = IM_NEW(ImGuiViewportP)(); viewport->ID = IMGUI_VIEWPORT_DEFAULT_ID; g.Viewports.push_back(viewport); g.TempBuffer.resize(1024 * 3 + 1, 0); // Build KeysMayBeCharInput[] lookup table (1 bool per named key) for (ImGuiKey key = ImGuiKey_NamedKey_BEGIN; key < ImGuiKey_NamedKey_END; key = (ImGuiKey)(key + 1)) if ((key >= ImGuiKey_0 && key <= ImGuiKey_9) || (key >= ImGuiKey_A && key <= ImGuiKey_Z) || (key >= ImGuiKey_Keypad0 && key <= ImGuiKey_Keypad9) || key == ImGuiKey_Tab || key == ImGuiKey_Space || key == ImGuiKey_Apostrophe || key == ImGuiKey_Comma || key == ImGuiKey_Minus || key == ImGuiKey_Period || key == ImGuiKey_Slash || key == ImGuiKey_Semicolon || key == ImGuiKey_Equal || key == ImGuiKey_LeftBracket || key == ImGuiKey_RightBracket || key == ImGuiKey_GraveAccent || key == ImGuiKey_KeypadDecimal || key == ImGuiKey_KeypadDivide || key == ImGuiKey_KeypadMultiply || key == ImGuiKey_KeypadSubtract || key == ImGuiKey_KeypadAdd || key == ImGuiKey_KeypadEqual) g.KeysMayBeCharInput.SetBit(key); #ifdef IMGUI_HAS_DOCK #endif g.Initialized = true; } // This function is merely here to free heap allocations. void ImGui::Shutdown() { ImGuiContext& g = *GImGui; IM_ASSERT_USER_ERROR(g.IO.BackendPlatformUserData == NULL, "Forgot to shutdown Platform backend?"); IM_ASSERT_USER_ERROR(g.IO.BackendRendererUserData == NULL, "Forgot to shutdown Renderer backend?"); // The fonts atlas can be used prior to calling NewFrame(), so we clear it even if g.Initialized is FALSE (which would happen if we never called NewFrame) if (g.IO.Fonts && g.FontAtlasOwnedByContext) { g.IO.Fonts->Locked = false; IM_DELETE(g.IO.Fonts); } g.IO.Fonts = NULL; g.DrawListSharedData.TempBuffer.clear(); // Cleanup of other data are conditional on actually having initialized Dear ImGui. if (!g.Initialized) return; // Save settings (unless we haven't attempted to load them: CreateContext/DestroyContext without a call to NewFrame shouldn't save an empty file) if (g.SettingsLoaded && g.IO.IniFilename != NULL) SaveIniSettingsToDisk(g.IO.IniFilename); CallContextHooks(&g, ImGuiContextHookType_Shutdown); // Clear everything else g.Windows.clear_delete(); g.WindowsFocusOrder.clear(); g.WindowsTempSortBuffer.clear(); g.CurrentWindow = NULL; g.CurrentWindowStack.clear(); g.WindowsById.Clear(); g.NavWindow = NULL; g.HoveredWindow = g.HoveredWindowUnderMovingWindow = NULL; g.ActiveIdWindow = NULL; g.MovingWindow = NULL; g.KeysRoutingTable.Clear(); g.ColorStack.clear(); g.StyleVarStack.clear(); g.FontStack.clear(); g.OpenPopupStack.clear(); g.BeginPopupStack.clear(); g.TreeNodeStack.clear(); g.Viewports.clear_delete(); g.TabBars.Clear(); g.CurrentTabBarStack.clear(); g.ShrinkWidthBuffer.clear(); g.ClipperTempData.clear_destruct(); g.Tables.Clear(); g.TablesTempData.clear_destruct(); g.DrawChannelsTempMergeBuffer.clear(); g.MultiSelectStorage.Clear(); g.MultiSelectTempData.clear_destruct(); g.ClipboardHandlerData.clear(); g.MenusIdSubmittedThisFrame.clear(); g.InputTextState.ClearFreeMemory(); g.InputTextDeactivatedState.ClearFreeMemory(); g.SettingsWindows.clear(); g.SettingsHandlers.clear(); if (g.LogFile) { #ifndef IMGUI_DISABLE_TTY_FUNCTIONS if (g.LogFile != stdout) #endif ImFileClose(g.LogFile); g.LogFile = NULL; } g.LogBuffer.clear(); g.DebugLogBuf.clear(); g.DebugLogIndex.clear(); g.Initialized = false; } // No specific ordering/dependency support, will see as needed ImGuiID ImGui::AddContextHook(ImGuiContext* ctx, const ImGuiContextHook* hook) { ImGuiContext& g = *ctx; IM_ASSERT(hook->Callback != NULL && hook->HookId == 0 && hook->Type != ImGuiContextHookType_PendingRemoval_); g.Hooks.push_back(*hook); g.Hooks.back().HookId = ++g.HookIdNext; return g.HookIdNext; } // Deferred removal, avoiding issue with changing vector while iterating it void ImGui::RemoveContextHook(ImGuiContext* ctx, ImGuiID hook_id) { ImGuiContext& g = *ctx; IM_ASSERT(hook_id != 0); for (ImGuiContextHook& hook : g.Hooks) if (hook.HookId == hook_id) hook.Type = ImGuiContextHookType_PendingRemoval_; } // Call context hooks (used by e.g. test engine) // We assume a small number of hooks so all stored in same array void ImGui::CallContextHooks(ImGuiContext* ctx, ImGuiContextHookType hook_type) { ImGuiContext& g = *ctx; for (ImGuiContextHook& hook : g.Hooks) if (hook.Type == hook_type) hook.Callback(&g, &hook); } //----------------------------------------------------------------------------- // [SECTION] MAIN CODE (most of the code! lots of stuff, needs tidying up!) //----------------------------------------------------------------------------- // ImGuiWindow is mostly a dumb struct. It merely has a constructor and a few helper methods ImGuiWindow::ImGuiWindow(ImGuiContext* ctx, const char* name) : DrawListInst(NULL) { memset(this, 0, sizeof(*this)); Ctx = ctx; Name = ImStrdup(name); NameBufLen = (int)ImStrlen(name) + 1; ID = ImHashStr(name); IDStack.push_back(ID); MoveId = GetID("#MOVE"); ScrollTarget = ImVec2(FLT_MAX, FLT_MAX); ScrollTargetCenterRatio = ImVec2(0.5f, 0.5f); AutoFitFramesX = AutoFitFramesY = -1; AutoPosLastDirection = ImGuiDir_None; SetWindowPosAllowFlags = SetWindowSizeAllowFlags = SetWindowCollapsedAllowFlags = 0; SetWindowPosVal = SetWindowPosPivot = ImVec2(FLT_MAX, FLT_MAX); LastFrameActive = -1; LastTimeActive = -1.0f; FontRefSize = 0.0f; FontWindowScale = FontWindowScaleParents = 1.0f; SettingsOffset = -1; DrawList = &DrawListInst; DrawList->_OwnerName = Name; DrawList->_Data = &Ctx->DrawListSharedData; NavPreferredScoringPosRel[0] = NavPreferredScoringPosRel[1] = ImVec2(FLT_MAX, FLT_MAX); } ImGuiWindow::~ImGuiWindow() { IM_ASSERT(DrawList == &DrawListInst); IM_DELETE(Name); ColumnsStorage.clear_destruct(); } static void SetCurrentWindow(ImGuiWindow* window) { ImGuiContext& g = *GImGui; g.CurrentWindow = window; g.StackSizesInBeginForCurrentWindow = g.CurrentWindow ? &g.CurrentWindowStack.back().StackSizesInBegin : NULL; g.CurrentTable = window && window->DC.CurrentTableIdx != -1 ? g.Tables.GetByIndex(window->DC.CurrentTableIdx) : NULL; g.CurrentDpiScale = 1.0f; // FIXME-DPI: WIP this is modified in docking if (window) { g.FontSize = g.DrawListSharedData.FontSize = window->CalcFontSize(); g.FontScale = g.DrawListSharedData.FontScale = g.FontSize / g.Font->FontSize; ImGui::NavUpdateCurrentWindowIsScrollPushableX(); } } void ImGui::GcCompactTransientMiscBuffers() { ImGuiContext& g = *GImGui; g.ItemFlagsStack.clear(); g.GroupStack.clear(); g.MultiSelectTempDataStacked = 0; g.MultiSelectTempData.clear_destruct(); TableGcCompactSettings(); } // Free up/compact internal window buffers, we can use this when a window becomes unused. // Not freed: // - ImGuiWindow, ImGuiWindowSettings, Name, StateStorage, ColumnsStorage (may hold useful data) // This should have no noticeable visual effect. When the window reappear however, expect new allocation/buffer growth/copy cost. void ImGui::GcCompactTransientWindowBuffers(ImGuiWindow* window) { window->MemoryCompacted = true; window->MemoryDrawListIdxCapacity = window->DrawList->IdxBuffer.Capacity; window->MemoryDrawListVtxCapacity = window->DrawList->VtxBuffer.Capacity; window->IDStack.clear(); window->DrawList->_ClearFreeMemory(); window->DC.ChildWindows.clear(); window->DC.ItemWidthStack.clear(); window->DC.TextWrapPosStack.clear(); } void ImGui::GcAwakeTransientWindowBuffers(ImGuiWindow* window) { // We stored capacity of the ImDrawList buffer to reduce growth-caused allocation/copy when awakening. // The other buffers tends to amortize much faster. window->MemoryCompacted = false; window->DrawList->IdxBuffer.reserve(window->MemoryDrawListIdxCapacity); window->DrawList->VtxBuffer.reserve(window->MemoryDrawListVtxCapacity); window->MemoryDrawListIdxCapacity = window->MemoryDrawListVtxCapacity = 0; } void ImGui::SetActiveID(ImGuiID id, ImGuiWindow* window) { ImGuiContext& g = *GImGui; // Clear previous active id if (g.ActiveId != 0) { // While most behaved code would make an effort to not steal active id during window move/drag operations, // we at least need to be resilient to it. Canceling the move is rather aggressive and users of 'master' branch // may prefer the weird ill-defined half working situation ('docking' did assert), so may need to rework that. if (g.MovingWindow != NULL && g.ActiveId == g.MovingWindow->MoveId) { IMGUI_DEBUG_LOG_ACTIVEID("SetActiveID() cancel MovingWindow\n"); g.MovingWindow = NULL; } // Store deactivate data ImGuiDeactivatedItemData* deactivated_data = &g.DeactivatedItemData; deactivated_data->ID = g.ActiveId; deactivated_data->ElapseFrame = (g.LastItemData.ID == g.ActiveId) ? g.FrameCount : g.FrameCount + 1; // FIXME: OK to use LastItemData? deactivated_data->HasBeenEditedBefore = g.ActiveIdHasBeenEditedBefore; deactivated_data->IsAlive = (g.ActiveIdIsAlive == g.ActiveId); // This could be written in a more general way (e.g associate a hook to ActiveId), // but since this is currently quite an exception we'll leave it as is. // One common scenario leading to this is: pressing Key ->NavMoveRequestApplyResult() -> ClearActiveID() if (g.InputTextState.ID == g.ActiveId) InputTextDeactivateHook(g.ActiveId); } // Set active id g.ActiveIdIsJustActivated = (g.ActiveId != id); if (g.ActiveIdIsJustActivated) { IMGUI_DEBUG_LOG_ACTIVEID("SetActiveID() old:0x%08X (window \"%s\") -> new:0x%08X (window \"%s\")\n", g.ActiveId, g.ActiveIdWindow ? g.ActiveIdWindow->Name : "", id, window ? window->Name : ""); g.ActiveIdTimer = 0.0f; g.ActiveIdHasBeenPressedBefore = false; g.ActiveIdHasBeenEditedBefore = false; g.ActiveIdMouseButton = -1; if (id != 0) { g.LastActiveId = id; g.LastActiveIdTimer = 0.0f; } } g.ActiveId = id; g.ActiveIdAllowOverlap = false; g.ActiveIdNoClearOnFocusLoss = false; g.ActiveIdWindow = window; g.ActiveIdHasBeenEditedThisFrame = false; g.ActiveIdFromShortcut = false; if (id) { g.ActiveIdIsAlive = id; g.ActiveIdSource = (g.NavActivateId == id || g.NavJustMovedToId == id) ? g.NavInputSource : ImGuiInputSource_Mouse; IM_ASSERT(g.ActiveIdSource != ImGuiInputSource_None); } // Clear declaration of inputs claimed by the widget // (Please note that this is WIP and not all keys/inputs are thoroughly declared by all widgets yet) g.ActiveIdUsingNavDirMask = 0x00; g.ActiveIdUsingAllKeyboardKeys = false; } void ImGui::ClearActiveID() { SetActiveID(0, NULL); // g.ActiveId = 0; } void ImGui::SetHoveredID(ImGuiID id) { ImGuiContext& g = *GImGui; g.HoveredId = id; g.HoveredIdAllowOverlap = false; if (id != 0 && g.HoveredIdPreviousFrame != id) g.HoveredIdTimer = g.HoveredIdNotActiveTimer = 0.0f; } ImGuiID ImGui::GetHoveredID() { ImGuiContext& g = *GImGui; return g.HoveredId ? g.HoveredId : g.HoveredIdPreviousFrame; } void ImGui::MarkItemEdited(ImGuiID id) { // This marking is to be able to provide info for IsItemDeactivatedAfterEdit(). // ActiveId might have been released by the time we call this (as in the typical press/release button behavior) but still need to fill the data. ImGuiContext& g = *GImGui; if (g.LastItemData.ItemFlags & ImGuiItemFlags_NoMarkEdited) return; if (g.ActiveId == id || g.ActiveId == 0) { // FIXME: Can't we fully rely on LastItemData yet? g.ActiveIdHasBeenEditedThisFrame = true; g.ActiveIdHasBeenEditedBefore = true; if (g.DeactivatedItemData.ID == id) g.DeactivatedItemData.HasBeenEditedBefore = true; } // We accept a MarkItemEdited() on drag and drop targets (see https://github.com/ocornut/imgui/issues/1875#issuecomment-978243343) // We accept 'ActiveIdPreviousFrame == id' for InputText() returning an edit after it has been taken ActiveId away (#4714) IM_ASSERT(g.DragDropActive || g.ActiveId == id || g.ActiveId == 0 || g.ActiveIdPreviousFrame == id || (g.CurrentMultiSelect != NULL && g.BoxSelectState.IsActive)); //IM_ASSERT(g.CurrentWindow->DC.LastItemId == id); g.LastItemData.StatusFlags |= ImGuiItemStatusFlags_Edited; } bool ImGui::IsWindowContentHoverable(ImGuiWindow* window, ImGuiHoveredFlags flags) { // An active popup disable hovering on other windows (apart from its own children) // FIXME-OPT: This could be cached/stored within the window. ImGuiContext& g = *GImGui; if (g.NavWindow) if (ImGuiWindow* focused_root_window = g.NavWindow->RootWindow) if (focused_root_window->WasActive && focused_root_window != window->RootWindow) { // For the purpose of those flags we differentiate "standard popup" from "modal popup" // NB: The 'else' is important because Modal windows are also Popups. bool want_inhibit = false; if (focused_root_window->Flags & ImGuiWindowFlags_Modal) want_inhibit = true; else if ((focused_root_window->Flags & ImGuiWindowFlags_Popup) && !(flags & ImGuiHoveredFlags_AllowWhenBlockedByPopup)) want_inhibit = true; // Inhibit hover unless the window is within the stack of our modal/popup if (want_inhibit) if (!IsWindowWithinBeginStackOf(window->RootWindow, focused_root_window)) return false; } return true; } static inline float CalcDelayFromHoveredFlags(ImGuiHoveredFlags flags) { ImGuiContext& g = *GImGui; if (flags & ImGuiHoveredFlags_DelayNormal) return g.Style.HoverDelayNormal; if (flags & ImGuiHoveredFlags_DelayShort) return g.Style.HoverDelayShort; return 0.0f; } static ImGuiHoveredFlags ApplyHoverFlagsForTooltip(ImGuiHoveredFlags user_flags, ImGuiHoveredFlags shared_flags) { // Allow instance flags to override shared flags if (user_flags & (ImGuiHoveredFlags_DelayNone | ImGuiHoveredFlags_DelayShort | ImGuiHoveredFlags_DelayNormal)) shared_flags &= ~(ImGuiHoveredFlags_DelayNone | ImGuiHoveredFlags_DelayShort | ImGuiHoveredFlags_DelayNormal); return user_flags | shared_flags; } // This is roughly matching the behavior of internal-facing ItemHoverable() // - we allow hovering to be true when ActiveId==window->MoveID, so that clicking on non-interactive items such as a Text() item still returns true with IsItemHovered() // - this should work even for non-interactive items that have no ID, so we cannot use LastItemId bool ImGui::IsItemHovered(ImGuiHoveredFlags flags) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; IM_ASSERT_USER_ERROR((flags & ~ImGuiHoveredFlags_AllowedMaskForIsItemHovered) == 0, "Invalid flags for IsItemHovered()!"); if (g.NavHighlightItemUnderNav && g.NavCursorVisible && !(flags & ImGuiHoveredFlags_NoNavOverride)) { if (!IsItemFocused()) return false; if ((g.LastItemData.ItemFlags & ImGuiItemFlags_Disabled) && !(flags & ImGuiHoveredFlags_AllowWhenDisabled)) return false; if (flags & ImGuiHoveredFlags_ForTooltip) flags = ApplyHoverFlagsForTooltip(flags, g.Style.HoverFlagsForTooltipNav); } else { // Test for bounding box overlap, as updated as ItemAdd() ImGuiItemStatusFlags status_flags = g.LastItemData.StatusFlags; if (!(status_flags & ImGuiItemStatusFlags_HoveredRect)) return false; if (flags & ImGuiHoveredFlags_ForTooltip) flags = ApplyHoverFlagsForTooltip(flags, g.Style.HoverFlagsForTooltipMouse); // Done with rectangle culling so we can perform heavier checks now // Test if we are hovering the right window (our window could be behind another window) // [2021/03/02] Reworked / reverted the revert, finally. Note we want e.g. BeginGroup/ItemAdd/EndGroup to work as well. (#3851) // [2017/10/16] Reverted commit 344d48be3 and testing RootWindow instead. I believe it is correct to NOT test for RootWindow but this leaves us unable // to use IsItemHovered() after EndChild() itself. Until a solution is found I believe reverting to the test from 2017/09/27 is safe since this was // the test that has been running for a long while. if (g.HoveredWindow != window && (status_flags & ImGuiItemStatusFlags_HoveredWindow) == 0) if ((flags & ImGuiHoveredFlags_AllowWhenOverlappedByWindow) == 0) return false; // Test if another item is active (e.g. being dragged) const ImGuiID id = g.LastItemData.ID; if ((flags & ImGuiHoveredFlags_AllowWhenBlockedByActiveItem) == 0) if (g.ActiveId != 0 && g.ActiveId != id && !g.ActiveIdAllowOverlap) if (g.ActiveId != window->MoveId) return false; // Test if interactions on this window are blocked by an active popup or modal. // The ImGuiHoveredFlags_AllowWhenBlockedByPopup flag will be tested here. if (!IsWindowContentHoverable(window, flags) && !(g.LastItemData.ItemFlags & ImGuiItemFlags_NoWindowHoverableCheck)) return false; // Test if the item is disabled if ((g.LastItemData.ItemFlags & ImGuiItemFlags_Disabled) && !(flags & ImGuiHoveredFlags_AllowWhenDisabled)) return false; // Special handling for calling after Begin() which represent the title bar or tab. // When the window is skipped/collapsed (SkipItems==true) that last item (always ->MoveId submitted by Begin) // will never be overwritten so we need to detect the case. if (id == window->MoveId && window->WriteAccessed) return false; // Test if using AllowOverlap and overlapped if ((g.LastItemData.ItemFlags & ImGuiItemFlags_AllowOverlap) && id != 0) if ((flags & ImGuiHoveredFlags_AllowWhenOverlappedByItem) == 0) if (g.HoveredIdPreviousFrame != g.LastItemData.ID) return false; } // Handle hover delay // (some ideas: https://www.nngroup.com/articles/timing-exposing-content) const float delay = CalcDelayFromHoveredFlags(flags); if (delay > 0.0f || (flags & ImGuiHoveredFlags_Stationary)) { ImGuiID hover_delay_id = (g.LastItemData.ID != 0) ? g.LastItemData.ID : window->GetIDFromPos(g.LastItemData.Rect.Min); if ((flags & ImGuiHoveredFlags_NoSharedDelay) && (g.HoverItemDelayIdPreviousFrame != hover_delay_id)) g.HoverItemDelayTimer = 0.0f; g.HoverItemDelayId = hover_delay_id; // When changing hovered item we requires a bit of stationary delay before activating hover timer, // but once unlocked on a given item we also moving. //if (g.HoverDelayTimer >= delay && (g.HoverDelayTimer - g.IO.DeltaTime < delay || g.MouseStationaryTimer - g.IO.DeltaTime < g.Style.HoverStationaryDelay)) { IMGUI_DEBUG_LOG("HoverDelayTimer = %f/%f, MouseStationaryTimer = %f\n", g.HoverDelayTimer, delay, g.MouseStationaryTimer); } if ((flags & ImGuiHoveredFlags_Stationary) != 0 && g.HoverItemUnlockedStationaryId != hover_delay_id) return false; if (g.HoverItemDelayTimer < delay) return false; } return true; } // Internal facing ItemHoverable() used when submitting widgets. Differs slightly from IsItemHovered(). // (this does not rely on LastItemData it can be called from a ButtonBehavior() call not following an ItemAdd() call) // FIXME-LEGACY: the 'ImGuiItemFlags item_flags' parameter was added on 2023-06-28. // If you used this in your legacy/custom widgets code: // - Commonly: if your ItemHoverable() call comes after an ItemAdd() call: pass 'item_flags = g.LastItemData.ItemFlags'. // - Rare: otherwise you may pass 'item_flags = 0' (ImGuiItemFlags_None) unless you want to benefit from special behavior handled by ItemHoverable. bool ImGui::ItemHoverable(const ImRect& bb, ImGuiID id, ImGuiItemFlags item_flags) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; // Detect ID conflicts #ifndef IMGUI_DISABLE_DEBUG_TOOLS if (id != 0 && g.HoveredIdPreviousFrame == id && (item_flags & ImGuiItemFlags_AllowDuplicateId) == 0) { g.HoveredIdPreviousFrameItemCount++; if (g.DebugDrawIdConflicts == id) window->DrawList->AddRect(bb.Min - ImVec2(1,1), bb.Max + ImVec2(1,1), IM_COL32(255, 0, 0, 255), 0.0f, ImDrawFlags_None, 2.0f); } #endif if (g.HoveredWindow != window) return false; if (!IsMouseHoveringRect(bb.Min, bb.Max)) return false; if (g.HoveredId != 0 && g.HoveredId != id && !g.HoveredIdAllowOverlap) return false; if (g.ActiveId != 0 && g.ActiveId != id && !g.ActiveIdAllowOverlap) if (!g.ActiveIdFromShortcut) return false; // Done with rectangle culling so we can perform heavier checks now. if (!(item_flags & ImGuiItemFlags_NoWindowHoverableCheck) && !IsWindowContentHoverable(window, ImGuiHoveredFlags_None)) { g.HoveredIdIsDisabled = true; return false; } // We exceptionally allow this function to be called with id==0 to allow using it for easy high-level // hover test in widgets code. We could also decide to split this function is two. if (id != 0) { // Drag source doesn't report as hovered if (g.DragDropActive && g.DragDropPayload.SourceId == id && !(g.DragDropSourceFlags & ImGuiDragDropFlags_SourceNoDisableHover)) return false; SetHoveredID(id); // AllowOverlap mode (rarely used) requires previous frame HoveredId to be null or to match. // This allows using patterns where a later submitted widget overlaps a previous one. Generally perceived as a front-to-back hit-test. if (item_flags & ImGuiItemFlags_AllowOverlap) { g.HoveredIdAllowOverlap = true; if (g.HoveredIdPreviousFrame != id) return false; } // Display shortcut (only works with mouse) // (ImGuiItemStatusFlags_HasShortcut in LastItemData denotes we want a tooltip) if (id == g.LastItemData.ID && (g.LastItemData.StatusFlags & ImGuiItemStatusFlags_HasShortcut) && g.ActiveId != id) if (IsItemHovered(ImGuiHoveredFlags_ForTooltip | ImGuiHoveredFlags_DelayNormal)) SetTooltip("%s", GetKeyChordName(g.LastItemData.Shortcut)); } // When disabled we'll return false but still set HoveredId if (item_flags & ImGuiItemFlags_Disabled) { // Release active id if turning disabled if (g.ActiveId == id && id != 0) ClearActiveID(); g.HoveredIdIsDisabled = true; return false; } #ifndef IMGUI_DISABLE_DEBUG_TOOLS if (id != 0) { // [DEBUG] Item Picker tool! // We perform the check here because reaching is path is rare (1~ time a frame), // making the cost of this tool near-zero! We could get better call-stack and support picking non-hovered // items if we performed the test in ItemAdd(), but that would incur a bigger runtime cost. if (g.DebugItemPickerActive && g.HoveredIdPreviousFrame == id) GetForegroundDrawList()->AddRect(bb.Min, bb.Max, IM_COL32(255, 255, 0, 255)); if (g.DebugItemPickerBreakId == id) IM_DEBUG_BREAK(); } #endif if (g.NavHighlightItemUnderNav && (item_flags & ImGuiItemFlags_NoNavDisableMouseHover) == 0) return false; return true; } // FIXME: This is inlined/duplicated in ItemAdd() // FIXME: The id != 0 path is not used by our codebase, may get rid of it? bool ImGui::IsClippedEx(const ImRect& bb, ImGuiID id) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; if (!bb.Overlaps(window->ClipRect)) if (id == 0 || (id != g.ActiveId && id != g.ActiveIdPreviousFrame && id != g.NavId && id != g.NavActivateId)) if (!g.ItemUnclipByLog) return true; return false; } // This is also inlined in ItemAdd() // Note: if ImGuiItemStatusFlags_HasDisplayRect is set, user needs to set g.LastItemData.DisplayRect. void ImGui::SetLastItemData(ImGuiID item_id, ImGuiItemFlags item_flags, ImGuiItemStatusFlags status_flags, const ImRect& item_rect) { ImGuiContext& g = *GImGui; g.LastItemData.ID = item_id; g.LastItemData.ItemFlags = item_flags; g.LastItemData.StatusFlags = status_flags; g.LastItemData.Rect = g.LastItemData.NavRect = item_rect; } static void ImGui::SetLastItemDataForWindow(ImGuiWindow* window, const ImRect& rect) { ImGuiContext& g = *GImGui; SetLastItemData(window->MoveId, g.CurrentItemFlags, window->DC.WindowItemStatusFlags, rect); } static void ImGui::SetLastItemDataForChildWindowItem(ImGuiWindow* window, const ImRect& rect) { ImGuiContext& g = *GImGui; SetLastItemData(window->ChildId, g.CurrentItemFlags, window->DC.ChildItemStatusFlags, rect); } float ImGui::CalcWrapWidthForPos(const ImVec2& pos, float wrap_pos_x) { if (wrap_pos_x < 0.0f) return 0.0f; ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; if (wrap_pos_x == 0.0f) { // We could decide to setup a default wrapping max point for auto-resizing windows, // or have auto-wrap (with unspecified wrapping pos) behave as a ContentSize extending function? //if (window->Hidden && (window->Flags & ImGuiWindowFlags_AlwaysAutoResize)) // wrap_pos_x = ImMax(window->WorkRect.Min.x + g.FontSize * 10.0f, window->WorkRect.Max.x); //else wrap_pos_x = window->WorkRect.Max.x; } else if (wrap_pos_x > 0.0f) { wrap_pos_x += window->Pos.x - window->Scroll.x; // wrap_pos_x is provided is window local space } return ImMax(wrap_pos_x - pos.x, 1.0f); } // IM_ALLOC() == ImGui::MemAlloc() void* ImGui::MemAlloc(size_t size) { void* ptr = (*GImAllocatorAllocFunc)(size, GImAllocatorUserData); #ifndef IMGUI_DISABLE_DEBUG_TOOLS if (ImGuiContext* ctx = GImGui) DebugAllocHook(&ctx->DebugAllocInfo, ctx->FrameCount, ptr, size); #endif return ptr; } // IM_FREE() == ImGui::MemFree() void ImGui::MemFree(void* ptr) { #ifndef IMGUI_DISABLE_DEBUG_TOOLS if (ptr != NULL) if (ImGuiContext* ctx = GImGui) DebugAllocHook(&ctx->DebugAllocInfo, ctx->FrameCount, ptr, (size_t)-1); #endif return (*GImAllocatorFreeFunc)(ptr, GImAllocatorUserData); } // We record the number of allocation in recent frames, as a way to audit/sanitize our guiding principles of "no allocations on idle/repeating frames" void ImGui::DebugAllocHook(ImGuiDebugAllocInfo* info, int frame_count, void* ptr, size_t size) { ImGuiDebugAllocEntry* entry = &info->LastEntriesBuf[info->LastEntriesIdx]; IM_UNUSED(ptr); if (entry->FrameCount != frame_count) { info->LastEntriesIdx = (info->LastEntriesIdx + 1) % IM_ARRAYSIZE(info->LastEntriesBuf); entry = &info->LastEntriesBuf[info->LastEntriesIdx]; entry->FrameCount = frame_count; entry->AllocCount = entry->FreeCount = 0; } if (size != (size_t)-1) { //printf("[%05d] MemAlloc(%d) -> 0x%p\n", frame_count, (int)size, ptr); entry->AllocCount++; info->TotalAllocCount++; } else { //printf("[%05d] MemFree(0x%p)\n", frame_count, ptr); entry->FreeCount++; info->TotalFreeCount++; } } const char* ImGui::GetClipboardText() { ImGuiContext& g = *GImGui; return g.PlatformIO.Platform_GetClipboardTextFn ? g.PlatformIO.Platform_GetClipboardTextFn(&g) : ""; } void ImGui::SetClipboardText(const char* text) { ImGuiContext& g = *GImGui; if (g.PlatformIO.Platform_SetClipboardTextFn != NULL) g.PlatformIO.Platform_SetClipboardTextFn(&g, text); } const char* ImGui::GetVersion() { return IMGUI_VERSION; } ImGuiIO& ImGui::GetIO() { IM_ASSERT(GImGui != NULL && "No current context. Did you call ImGui::CreateContext() and ImGui::SetCurrentContext() ?"); return GImGui->IO; } // This variant exists to facilitate backends experimenting with multi-threaded parallel context. (#8069, #6293, #5856) ImGuiIO& ImGui::GetIO(ImGuiContext* ctx) { IM_ASSERT(ctx != NULL); return ctx->IO; } ImGuiPlatformIO& ImGui::GetPlatformIO() { IM_ASSERT(GImGui != NULL && "No current context. Did you call ImGui::CreateContext() and ImGui::SetCurrentContext()?"); return GImGui->PlatformIO; } // This variant exists to facilitate backends experimenting with multi-threaded parallel context. (#8069, #6293, #5856) ImGuiPlatformIO& ImGui::GetPlatformIO(ImGuiContext* ctx) { IM_ASSERT(ctx != NULL); return ctx->PlatformIO; } // Pass this to your backend rendering function! Valid after Render() and until the next call to NewFrame() ImDrawData* ImGui::GetDrawData() { ImGuiContext& g = *GImGui; ImGuiViewportP* viewport = g.Viewports[0]; return viewport->DrawDataP.Valid ? &viewport->DrawDataP : NULL; } double ImGui::GetTime() { return GImGui->Time; } int ImGui::GetFrameCount() { return GImGui->FrameCount; } static ImDrawList* GetViewportBgFgDrawList(ImGuiViewportP* viewport, size_t drawlist_no, const char* drawlist_name) { // Create the draw list on demand, because they are not frequently used for all viewports ImGuiContext& g = *GImGui; IM_ASSERT(drawlist_no < IM_ARRAYSIZE(viewport->BgFgDrawLists)); ImDrawList* draw_list = viewport->BgFgDrawLists[drawlist_no]; if (draw_list == NULL) { draw_list = IM_NEW(ImDrawList)(&g.DrawListSharedData); draw_list->_OwnerName = drawlist_name; viewport->BgFgDrawLists[drawlist_no] = draw_list; } // Our ImDrawList system requires that there is always a command if (viewport->BgFgDrawListsLastFrame[drawlist_no] != g.FrameCount) { draw_list->_ResetForNewFrame(); draw_list->PushTextureID(g.IO.Fonts->TexID); draw_list->PushClipRect(viewport->Pos, viewport->Pos + viewport->Size, false); viewport->BgFgDrawListsLastFrame[drawlist_no] = g.FrameCount; } return draw_list; } ImDrawList* ImGui::GetBackgroundDrawList(ImGuiViewport* viewport) { return GetViewportBgFgDrawList((ImGuiViewportP*)viewport, 0, "##Background"); } ImDrawList* ImGui::GetBackgroundDrawList() { ImGuiContext& g = *GImGui; return GetBackgroundDrawList(g.Viewports[0]); } ImDrawList* ImGui::GetForegroundDrawList(ImGuiViewport* viewport) { return GetViewportBgFgDrawList((ImGuiViewportP*)viewport, 1, "##Foreground"); } ImDrawList* ImGui::GetForegroundDrawList() { ImGuiContext& g = *GImGui; return GetForegroundDrawList(g.Viewports[0]); } ImDrawListSharedData* ImGui::GetDrawListSharedData() { return &GImGui->DrawListSharedData; } void ImGui::StartMouseMovingWindow(ImGuiWindow* window) { // Set ActiveId even if the _NoMove flag is set. Without it, dragging away from a window with _NoMove would activate hover on other windows. // We _also_ call this when clicking in a window empty space when io.ConfigWindowsMoveFromTitleBarOnly is set, but clear g.MovingWindow afterward. // This is because we want ActiveId to be set even when the window is not permitted to move. ImGuiContext& g = *GImGui; FocusWindow(window); SetActiveID(window->MoveId, window); if (g.IO.ConfigNavCursorVisibleAuto) g.NavCursorVisible = false; g.ActiveIdClickOffset = g.IO.MouseClickedPos[0] - window->RootWindow->Pos; g.ActiveIdNoClearOnFocusLoss = true; SetActiveIdUsingAllKeyboardKeys(); bool can_move_window = true; if ((window->Flags & ImGuiWindowFlags_NoMove) || (window->RootWindow->Flags & ImGuiWindowFlags_NoMove)) can_move_window = false; if (can_move_window) g.MovingWindow = window; } // Handle mouse moving window // Note: moving window with the navigation keys (Square + d-pad / CTRL+TAB + Arrows) are processed in NavUpdateWindowing() // FIXME: We don't have strong guarantee that g.MovingWindow stay synced with g.ActiveId == g.MovingWindow->MoveId. // This is currently enforced by the fact that BeginDragDropSource() is setting all g.ActiveIdUsingXXXX flags to inhibit navigation inputs, // but if we should more thoroughly test cases where g.ActiveId or g.MovingWindow gets changed and not the other. void ImGui::UpdateMouseMovingWindowNewFrame() { ImGuiContext& g = *GImGui; if (g.MovingWindow != NULL) { // We actually want to move the root window. g.MovingWindow == window we clicked on (could be a child window). // We track it to preserve Focus and so that generally ActiveIdWindow == MovingWindow and ActiveId == MovingWindow->MoveId for consistency. KeepAliveID(g.ActiveId); IM_ASSERT(g.MovingWindow && g.MovingWindow->RootWindow); ImGuiWindow* moving_window = g.MovingWindow->RootWindow; if (g.IO.MouseDown[0] && IsMousePosValid(&g.IO.MousePos)) { ImVec2 pos = g.IO.MousePos - g.ActiveIdClickOffset; SetWindowPos(moving_window, pos, ImGuiCond_Always); FocusWindow(g.MovingWindow); } else { g.MovingWindow = NULL; ClearActiveID(); } } else { // When clicking/dragging from a window that has the _NoMove flag, we still set the ActiveId in order to prevent hovering others. if (g.ActiveIdWindow && g.ActiveIdWindow->MoveId == g.ActiveId) { KeepAliveID(g.ActiveId); if (!g.IO.MouseDown[0]) ClearActiveID(); } } } // Initiate focusing and moving window when clicking on empty space or title bar. // Initiate focusing window when clicking on a disabled item. // Handle left-click and right-click focus. void ImGui::UpdateMouseMovingWindowEndFrame() { ImGuiContext& g = *GImGui; if (g.ActiveId != 0 || (g.HoveredId != 0 && !g.HoveredIdIsDisabled)) return; // Unless we just made a window/popup appear if (g.NavWindow && g.NavWindow->Appearing) return; // Click on empty space to focus window and start moving // (after we're done with all our widgets) if (g.IO.MouseClicked[0]) { // Handle the edge case of a popup being closed while clicking in its empty space. // If we try to focus it, FocusWindow() > ClosePopupsOverWindow() will accidentally close any parent popups because they are not linked together any more. ImGuiWindow* root_window = g.HoveredWindow ? g.HoveredWindow->RootWindow : NULL; const bool is_closed_popup = root_window && (root_window->Flags & ImGuiWindowFlags_Popup) && !IsPopupOpen(root_window->PopupId, ImGuiPopupFlags_AnyPopupLevel); if (root_window != NULL && !is_closed_popup) { StartMouseMovingWindow(g.HoveredWindow); //-V595 // Cancel moving if clicked outside of title bar if (g.IO.ConfigWindowsMoveFromTitleBarOnly) if (!(root_window->Flags & ImGuiWindowFlags_NoTitleBar)) if (!root_window->TitleBarRect().Contains(g.IO.MouseClickedPos[0])) g.MovingWindow = NULL; // Cancel moving if clicked over an item which was disabled or inhibited by popups // (when g.HoveredIdIsDisabled == true && g.HoveredId == 0 we are inhibited by popups, when g.HoveredIdIsDisabled == true && g.HoveredId != 0 we are over a disabled item)0 already) if (g.HoveredIdIsDisabled) g.MovingWindow = NULL; } else if (root_window == NULL && g.NavWindow != NULL) { // Clicking on void disable focus FocusWindow(NULL, ImGuiFocusRequestFlags_UnlessBelowModal); } } // With right mouse button we close popups without changing focus based on where the mouse is aimed // Instead, focus will be restored to the window under the bottom-most closed popup. // (The left mouse button path calls FocusWindow on the hovered window, which will lead NewFrame->ClosePopupsOverWindow to trigger) if (g.IO.MouseClicked[1] && g.HoveredId == 0) { // Find the top-most window between HoveredWindow and the top-most Modal Window. // This is where we can trim the popup stack. ImGuiWindow* modal = GetTopMostPopupModal(); bool hovered_window_above_modal = g.HoveredWindow && (modal == NULL || IsWindowAbove(g.HoveredWindow, modal)); ClosePopupsOverWindow(hovered_window_above_modal ? g.HoveredWindow : modal, true); } } static bool IsWindowActiveAndVisible(ImGuiWindow* window) { return (window->Active) && (!window->Hidden); } // The reason this is exposed in imgui_internal.h is: on touch-based system that don't have hovering, we want to dispatch inputs to the right target (imgui vs imgui+app) void ImGui::UpdateHoveredWindowAndCaptureFlags() { ImGuiContext& g = *GImGui; ImGuiIO& io = g.IO; // FIXME-DPI: This storage was added on 2021/03/31 for test engine, but if we want to multiply WINDOWS_HOVER_PADDING // by DpiScale, we need to make this window-agnostic anyhow, maybe need storing inside ImGuiWindow. g.WindowsBorderHoverPadding = ImMax(ImMax(g.Style.TouchExtraPadding.x, g.Style.TouchExtraPadding.y), g.Style.WindowBorderHoverPadding); // Find the window hovered by mouse: // - Child windows can extend beyond the limit of their parent so we need to derive HoveredRootWindow from HoveredWindow. // - When moving a window we can skip the search, which also conveniently bypasses the fact that window->WindowRectClipped is lagging as this point of the frame. // - We also support the moved window toggling the NoInputs flag after moving has started in order to be able to detect windows below it, which is useful for e.g. docking mechanisms. bool clear_hovered_windows = false; FindHoveredWindowEx(g.IO.MousePos, false, &g.HoveredWindow, &g.HoveredWindowUnderMovingWindow); g.HoveredWindowBeforeClear = g.HoveredWindow; // Modal windows prevents mouse from hovering behind them. ImGuiWindow* modal_window = GetTopMostPopupModal(); if (modal_window && g.HoveredWindow && !IsWindowWithinBeginStackOf(g.HoveredWindow->RootWindow, modal_window)) clear_hovered_windows = true; // Disabled mouse hovering (we don't currently clear MousePos, we could) if (io.ConfigFlags & ImGuiConfigFlags_NoMouse) clear_hovered_windows = true; // We track click ownership. When clicked outside of a window the click is owned by the application and // won't report hovering nor request capture even while dragging over our windows afterward. const bool has_open_popup = (g.OpenPopupStack.Size > 0); const bool has_open_modal = (modal_window != NULL); int mouse_earliest_down = -1; bool mouse_any_down = false; for (int i = 0; i < IM_ARRAYSIZE(io.MouseDown); i++) { if (io.MouseClicked[i]) { io.MouseDownOwned[i] = (g.HoveredWindow != NULL) || has_open_popup; io.MouseDownOwnedUnlessPopupClose[i] = (g.HoveredWindow != NULL) || has_open_modal; } mouse_any_down |= io.MouseDown[i]; if (io.MouseDown[i] || io.MouseReleased[i]) // Increase release frame for our evaluation of earliest button (#1392) if (mouse_earliest_down == -1 || io.MouseClickedTime[i] < io.MouseClickedTime[mouse_earliest_down]) mouse_earliest_down = i; } const bool mouse_avail = (mouse_earliest_down == -1) || io.MouseDownOwned[mouse_earliest_down]; const bool mouse_avail_unless_popup_close = (mouse_earliest_down == -1) || io.MouseDownOwnedUnlessPopupClose[mouse_earliest_down]; // If mouse was first clicked outside of ImGui bounds we also cancel out hovering. // FIXME: For patterns of drag and drop across OS windows, we may need to rework/remove this test (first committed 311c0ca9 on 2015/02) const bool mouse_dragging_extern_payload = g.DragDropActive && (g.DragDropSourceFlags & ImGuiDragDropFlags_SourceExtern) != 0; if (!mouse_avail && !mouse_dragging_extern_payload) clear_hovered_windows = true; if (clear_hovered_windows) g.HoveredWindow = g.HoveredWindowUnderMovingWindow = NULL; // Update io.WantCaptureMouse for the user application (true = dispatch mouse info to Dear ImGui only, false = dispatch mouse to Dear ImGui + underlying app) // Update io.WantCaptureMouseAllowPopupClose (experimental) to give a chance for app to react to popup closure with a drag if (g.WantCaptureMouseNextFrame != -1) { io.WantCaptureMouse = io.WantCaptureMouseUnlessPopupClose = (g.WantCaptureMouseNextFrame != 0); } else { io.WantCaptureMouse = (mouse_avail && (g.HoveredWindow != NULL || mouse_any_down)) || has_open_popup; io.WantCaptureMouseUnlessPopupClose = (mouse_avail_unless_popup_close && (g.HoveredWindow != NULL || mouse_any_down)) || has_open_modal; } // Update io.WantCaptureKeyboard for the user application (true = dispatch keyboard info to Dear ImGui only, false = dispatch keyboard info to Dear ImGui + underlying app) io.WantCaptureKeyboard = false; if ((io.ConfigFlags & ImGuiConfigFlags_NoKeyboard) == 0) { if ((g.ActiveId != 0) || (modal_window != NULL)) io.WantCaptureKeyboard = true; else if (io.NavActive && (io.ConfigFlags & ImGuiConfigFlags_NavEnableKeyboard) && io.ConfigNavCaptureKeyboard) io.WantCaptureKeyboard = true; } if (g.WantCaptureKeyboardNextFrame != -1) // Manual override io.WantCaptureKeyboard = (g.WantCaptureKeyboardNextFrame != 0); // Update io.WantTextInput flag, this is to allow systems without a keyboard (e.g. mobile, hand-held) to show a software keyboard if possible io.WantTextInput = (g.WantTextInputNextFrame != -1) ? (g.WantTextInputNextFrame != 0) : false; } // Called once a frame. Followed by SetCurrentFont() which sets up the remaining data. // FIXME-VIEWPORT: the concept of a single ClipRectFullscreen is not ideal! static void SetupDrawListSharedData() { ImGuiContext& g = *GImGui; ImRect virtual_space(FLT_MAX, FLT_MAX, -FLT_MAX, -FLT_MAX); for (ImGuiViewportP* viewport : g.Viewports) virtual_space.Add(viewport->GetMainRect()); g.DrawListSharedData.ClipRectFullscreen = virtual_space.ToVec4(); g.DrawListSharedData.CurveTessellationTol = g.Style.CurveTessellationTol; g.DrawListSharedData.SetCircleTessellationMaxError(g.Style.CircleTessellationMaxError); g.DrawListSharedData.InitialFlags = ImDrawListFlags_None; if (g.Style.AntiAliasedLines) g.DrawListSharedData.InitialFlags |= ImDrawListFlags_AntiAliasedLines; if (g.Style.AntiAliasedLinesUseTex && !(g.IO.Fonts->Flags & ImFontAtlasFlags_NoBakedLines)) g.DrawListSharedData.InitialFlags |= ImDrawListFlags_AntiAliasedLinesUseTex; if (g.Style.AntiAliasedFill) g.DrawListSharedData.InitialFlags |= ImDrawListFlags_AntiAliasedFill; if (g.IO.BackendFlags & ImGuiBackendFlags_RendererHasVtxOffset) g.DrawListSharedData.InitialFlags |= ImDrawListFlags_AllowVtxOffset; g.DrawListSharedData.InitialFringeScale = 1.0f; // FIXME-DPI: Change this for some DPI scaling experiments. } void ImGui::NewFrame() { IM_ASSERT(GImGui != NULL && "No current context. Did you call ImGui::CreateContext() and ImGui::SetCurrentContext() ?"); ImGuiContext& g = *GImGui; // Remove pending delete hooks before frame start. // This deferred removal avoid issues of removal while iterating the hook vector for (int n = g.Hooks.Size - 1; n >= 0; n--) if (g.Hooks[n].Type == ImGuiContextHookType_PendingRemoval_) g.Hooks.erase(&g.Hooks[n]); CallContextHooks(&g, ImGuiContextHookType_NewFramePre); // Check and assert for various common IO and Configuration mistakes ErrorCheckNewFrameSanityChecks(); // Load settings on first frame, save settings when modified (after a delay) UpdateSettings(); g.Time += g.IO.DeltaTime; g.WithinFrameScope = true; g.FrameCount += 1; g.TooltipOverrideCount = 0; g.WindowsActiveCount = 0; g.MenusIdSubmittedThisFrame.resize(0); // Calculate frame-rate for the user, as a purely luxurious feature g.FramerateSecPerFrameAccum += g.IO.DeltaTime - g.FramerateSecPerFrame[g.FramerateSecPerFrameIdx]; g.FramerateSecPerFrame[g.FramerateSecPerFrameIdx] = g.IO.DeltaTime; g.FramerateSecPerFrameIdx = (g.FramerateSecPerFrameIdx + 1) % IM_ARRAYSIZE(g.FramerateSecPerFrame); g.FramerateSecPerFrameCount = ImMin(g.FramerateSecPerFrameCount + 1, IM_ARRAYSIZE(g.FramerateSecPerFrame)); g.IO.Framerate = (g.FramerateSecPerFrameAccum > 0.0f) ? (1.0f / (g.FramerateSecPerFrameAccum / (float)g.FramerateSecPerFrameCount)) : FLT_MAX; // Process input queue (trickle as many events as possible), turn events into writes to IO structure g.InputEventsTrail.resize(0); UpdateInputEvents(g.IO.ConfigInputTrickleEventQueue); // Update viewports (after processing input queue, so io.MouseHoveredViewport is set) UpdateViewportsNewFrame(); // Setup current font and draw list shared data g.IO.Fonts->Locked = true; SetupDrawListSharedData(); SetCurrentFont(GetDefaultFont()); IM_ASSERT(g.Font->IsLoaded()); // Mark rendering data as invalid to prevent user who may have a handle on it to use it. for (ImGuiViewportP* viewport : g.Viewports) viewport->DrawDataP.Valid = false; // Drag and drop keep the source ID alive so even if the source disappear our state is consistent if (g.DragDropActive && g.DragDropPayload.SourceId == g.ActiveId) KeepAliveID(g.DragDropPayload.SourceId); // [DEBUG] if (!g.IO.ConfigDebugHighlightIdConflicts || !g.IO.KeyCtrl) // Count is locked while holding CTRL g.DebugDrawIdConflicts = 0; if (g.IO.ConfigDebugHighlightIdConflicts && g.HoveredIdPreviousFrameItemCount > 1) g.DebugDrawIdConflicts = g.HoveredIdPreviousFrame; // Update HoveredId data if (!g.HoveredIdPreviousFrame) g.HoveredIdTimer = 0.0f; if (!g.HoveredIdPreviousFrame || (g.HoveredId && g.ActiveId == g.HoveredId)) g.HoveredIdNotActiveTimer = 0.0f; if (g.HoveredId) g.HoveredIdTimer += g.IO.DeltaTime; if (g.HoveredId && g.ActiveId != g.HoveredId) g.HoveredIdNotActiveTimer += g.IO.DeltaTime; g.HoveredIdPreviousFrame = g.HoveredId; g.HoveredIdPreviousFrameItemCount = 0; g.HoveredId = 0; g.HoveredIdAllowOverlap = false; g.HoveredIdIsDisabled = false; // Clear ActiveID if the item is not alive anymore. // In 1.87, the common most call to KeepAliveID() was moved from GetID() to ItemAdd(). // As a result, custom widget using ButtonBehavior() _without_ ItemAdd() need to call KeepAliveID() themselves. if (g.ActiveId != 0 && g.ActiveIdIsAlive != g.ActiveId && g.ActiveIdPreviousFrame == g.ActiveId) { IMGUI_DEBUG_LOG_ACTIVEID("NewFrame(): ClearActiveID() because it isn't marked alive anymore!\n"); ClearActiveID(); } // Update ActiveId data (clear reference to active widget if the widget isn't alive anymore) if (g.ActiveId) g.ActiveIdTimer += g.IO.DeltaTime; g.LastActiveIdTimer += g.IO.DeltaTime; g.ActiveIdPreviousFrame = g.ActiveId; g.ActiveIdIsAlive = 0; g.ActiveIdHasBeenEditedThisFrame = false; g.ActiveIdIsJustActivated = false; if (g.TempInputId != 0 && g.ActiveId != g.TempInputId) g.TempInputId = 0; if (g.ActiveId == 0) { g.ActiveIdUsingNavDirMask = 0x00; g.ActiveIdUsingAllKeyboardKeys = false; } if (g.DeactivatedItemData.ElapseFrame < g.FrameCount) g.DeactivatedItemData.ID = 0; g.DeactivatedItemData.IsAlive = false; // Record when we have been stationary as this state is preserved while over same item. // FIXME: The way this is expressed means user cannot alter HoverStationaryDelay during the frame to use varying values. // To allow this we should store HoverItemMaxStationaryTime+ID and perform the >= check in IsItemHovered() function. if (g.HoverItemDelayId != 0 && g.MouseStationaryTimer >= g.Style.HoverStationaryDelay) g.HoverItemUnlockedStationaryId = g.HoverItemDelayId; else if (g.HoverItemDelayId == 0) g.HoverItemUnlockedStationaryId = 0; if (g.HoveredWindow != NULL && g.MouseStationaryTimer >= g.Style.HoverStationaryDelay) g.HoverWindowUnlockedStationaryId = g.HoveredWindow->ID; else if (g.HoveredWindow == NULL) g.HoverWindowUnlockedStationaryId = 0; // Update hover delay for IsItemHovered() with delays and tooltips g.HoverItemDelayIdPreviousFrame = g.HoverItemDelayId; if (g.HoverItemDelayId != 0) { g.HoverItemDelayTimer += g.IO.DeltaTime; g.HoverItemDelayClearTimer = 0.0f; g.HoverItemDelayId = 0; } else if (g.HoverItemDelayTimer > 0.0f) { // This gives a little bit of leeway before clearing the hover timer, allowing mouse to cross gaps // We could expose 0.25f as style.HoverClearDelay but I am not sure of the logic yet, this is particularly subtle. g.HoverItemDelayClearTimer += g.IO.DeltaTime; if (g.HoverItemDelayClearTimer >= ImMax(0.25f, g.IO.DeltaTime * 2.0f)) // ~7 frames at 30 Hz + allow for low framerate g.HoverItemDelayTimer = g.HoverItemDelayClearTimer = 0.0f; // May want a decaying timer, in which case need to clamp at max first, based on max of caller last requested timer. } // Drag and drop g.DragDropAcceptIdPrev = g.DragDropAcceptIdCurr; g.DragDropAcceptIdCurr = 0; g.DragDropAcceptIdCurrRectSurface = FLT_MAX; g.DragDropWithinSource = false; g.DragDropWithinTarget = false; g.DragDropHoldJustPressedId = 0; g.TooltipPreviousWindow = NULL; // Close popups on focus lost (currently wip/opt-in) //if (g.IO.AppFocusLost) // ClosePopupsExceptModals(); // Update keyboard input state UpdateKeyboardInputs(); //IM_ASSERT(g.IO.KeyCtrl == IsKeyDown(ImGuiKey_LeftCtrl) || IsKeyDown(ImGuiKey_RightCtrl)); //IM_ASSERT(g.IO.KeyShift == IsKeyDown(ImGuiKey_LeftShift) || IsKeyDown(ImGuiKey_RightShift)); //IM_ASSERT(g.IO.KeyAlt == IsKeyDown(ImGuiKey_LeftAlt) || IsKeyDown(ImGuiKey_RightAlt)); //IM_ASSERT(g.IO.KeySuper == IsKeyDown(ImGuiKey_LeftSuper) || IsKeyDown(ImGuiKey_RightSuper)); // Update keyboard/gamepad navigation NavUpdate(); // Update mouse input state UpdateMouseInputs(); // Mark all windows as not visible and compact unused memory. IM_ASSERT(g.WindowsFocusOrder.Size <= g.Windows.Size); const float memory_compact_start_time = (g.GcCompactAll || g.IO.ConfigMemoryCompactTimer < 0.0f) ? FLT_MAX : (float)g.Time - g.IO.ConfigMemoryCompactTimer; for (ImGuiWindow* window : g.Windows) { window->WasActive = window->Active; window->Active = false; window->WriteAccessed = false; window->BeginCountPreviousFrame = window->BeginCount; window->BeginCount = 0; // Garbage collect transient buffers of recently unused windows if (!window->WasActive && !window->MemoryCompacted && window->LastTimeActive < memory_compact_start_time) GcCompactTransientWindowBuffers(window); } // Find hovered window // (needs to be before UpdateMouseMovingWindowNewFrame so we fill g.HoveredWindowUnderMovingWindow on the mouse release frame) // (currently needs to be done after the WasActive=Active loop and FindHoveredWindowEx uses ->Active) UpdateHoveredWindowAndCaptureFlags(); // Handle user moving window with mouse (at the beginning of the frame to avoid input lag or sheering) UpdateMouseMovingWindowNewFrame(); // Background darkening/whitening if (GetTopMostPopupModal() != NULL || (g.NavWindowingTarget != NULL && g.NavWindowingHighlightAlpha > 0.0f)) g.DimBgRatio = ImMin(g.DimBgRatio + g.IO.DeltaTime * 6.0f, 1.0f); else g.DimBgRatio = ImMax(g.DimBgRatio - g.IO.DeltaTime * 10.0f, 0.0f); g.MouseCursor = ImGuiMouseCursor_Arrow; g.WantCaptureMouseNextFrame = g.WantCaptureKeyboardNextFrame = g.WantTextInputNextFrame = -1; // Platform IME data: reset for the frame g.PlatformImeDataPrev = g.PlatformImeData; g.PlatformImeData.WantVisible = false; // Mouse wheel scrolling, scale UpdateMouseWheel(); // Garbage collect transient buffers of recently unused tables for (int i = 0; i < g.TablesLastTimeActive.Size; i++) if (g.TablesLastTimeActive[i] >= 0.0f && g.TablesLastTimeActive[i] < memory_compact_start_time) TableGcCompactTransientBuffers(g.Tables.GetByIndex(i)); for (ImGuiTableTempData& table_temp_data : g.TablesTempData) if (table_temp_data.LastTimeActive >= 0.0f && table_temp_data.LastTimeActive < memory_compact_start_time) TableGcCompactTransientBuffers(&table_temp_data); if (g.GcCompactAll) GcCompactTransientMiscBuffers(); g.GcCompactAll = false; // Closing the focused window restore focus to the first active root window in descending z-order if (g.NavWindow && !g.NavWindow->WasActive) FocusTopMostWindowUnderOne(NULL, NULL, NULL, ImGuiFocusRequestFlags_RestoreFocusedChild); // No window should be open at the beginning of the frame. // But in order to allow the user to call NewFrame() multiple times without calling Render(), we are doing an explicit clear. g.CurrentWindowStack.resize(0); g.BeginPopupStack.resize(0); g.ItemFlagsStack.resize(0); g.ItemFlagsStack.push_back(ImGuiItemFlags_AutoClosePopups); // Default flags g.CurrentItemFlags = g.ItemFlagsStack.back(); g.GroupStack.resize(0); // [DEBUG] Update debug features #ifndef IMGUI_DISABLE_DEBUG_TOOLS UpdateDebugToolItemPicker(); UpdateDebugToolStackQueries(); UpdateDebugToolFlashStyleColor(); if (g.DebugLocateFrames > 0 && --g.DebugLocateFrames == 0) { g.DebugLocateId = 0; g.DebugBreakInLocateId = false; } if (g.DebugLogAutoDisableFrames > 0 && --g.DebugLogAutoDisableFrames == 0) { DebugLog("(Debug Log: Auto-disabled some ImGuiDebugLogFlags after 2 frames)\n"); g.DebugLogFlags &= ~g.DebugLogAutoDisableFlags; g.DebugLogAutoDisableFlags = ImGuiDebugLogFlags_None; } #endif // Create implicit/fallback window - which we will only render it if the user has added something to it. // We don't use "Debug" to avoid colliding with user trying to create a "Debug" window with custom flags. // This fallback is particularly important as it prevents ImGui:: calls from crashing. g.WithinFrameScopeWithImplicitWindow = true; SetNextWindowSize(ImVec2(400, 400), ImGuiCond_FirstUseEver); Begin("Debug##Default"); IM_ASSERT(g.CurrentWindow->IsFallbackWindow == true); // Store stack sizes g.ErrorCountCurrentFrame = 0; ErrorRecoveryStoreState(&g.StackSizesInNewFrame); // [DEBUG] When io.ConfigDebugBeginReturnValue is set, we make Begin()/BeginChild() return false at different level of the window-stack, // allowing to validate correct Begin/End behavior in user code. #ifndef IMGUI_DISABLE_DEBUG_TOOLS if (g.IO.ConfigDebugBeginReturnValueLoop) g.DebugBeginReturnValueCullDepth = (g.DebugBeginReturnValueCullDepth == -1) ? 0 : ((g.DebugBeginReturnValueCullDepth + ((g.FrameCount % 4) == 0 ? 1 : 0)) % 10); else g.DebugBeginReturnValueCullDepth = -1; #endif CallContextHooks(&g, ImGuiContextHookType_NewFramePost); } // FIXME: Add a more explicit sort order in the window structure. static int IMGUI_CDECL ChildWindowComparer(const void* lhs, const void* rhs) { const ImGuiWindow* const a = *(const ImGuiWindow* const *)lhs; const ImGuiWindow* const b = *(const ImGuiWindow* const *)rhs; if (int d = (a->Flags & ImGuiWindowFlags_Popup) - (b->Flags & ImGuiWindowFlags_Popup)) return d; if (int d = (a->Flags & ImGuiWindowFlags_Tooltip) - (b->Flags & ImGuiWindowFlags_Tooltip)) return d; return (a->BeginOrderWithinParent - b->BeginOrderWithinParent); } static void AddWindowToSortBuffer(ImVector* out_sorted_windows, ImGuiWindow* window) { out_sorted_windows->push_back(window); if (window->Active) { int count = window->DC.ChildWindows.Size; ImQsort(window->DC.ChildWindows.Data, (size_t)count, sizeof(ImGuiWindow*), ChildWindowComparer); for (int i = 0; i < count; i++) { ImGuiWindow* child = window->DC.ChildWindows[i]; if (child->Active) AddWindowToSortBuffer(out_sorted_windows, child); } } } static void AddWindowToDrawData(ImGuiWindow* window, int layer) { ImGuiContext& g = *GImGui; ImGuiViewportP* viewport = g.Viewports[0]; g.IO.MetricsRenderWindows++; if (window->DrawList->_Splitter._Count > 1) window->DrawList->ChannelsMerge(); // Merge if user forgot to merge back. Also required in Docking branch for ImGuiWindowFlags_DockNodeHost windows. ImGui::AddDrawListToDrawDataEx(&viewport->DrawDataP, viewport->DrawDataBuilder.Layers[layer], window->DrawList); for (ImGuiWindow* child : window->DC.ChildWindows) if (IsWindowActiveAndVisible(child)) // Clipped children may have been marked not active AddWindowToDrawData(child, layer); } static inline int GetWindowDisplayLayer(ImGuiWindow* window) { return (window->Flags & ImGuiWindowFlags_Tooltip) ? 1 : 0; } // Layer is locked for the root window, however child windows may use a different viewport (e.g. extruding menu) static inline void AddRootWindowToDrawData(ImGuiWindow* window) { AddWindowToDrawData(window, GetWindowDisplayLayer(window)); } static void FlattenDrawDataIntoSingleLayer(ImDrawDataBuilder* builder) { int n = builder->Layers[0]->Size; int full_size = n; for (int i = 1; i < IM_ARRAYSIZE(builder->Layers); i++) full_size += builder->Layers[i]->Size; builder->Layers[0]->resize(full_size); for (int layer_n = 1; layer_n < IM_ARRAYSIZE(builder->Layers); layer_n++) { ImVector* layer = builder->Layers[layer_n]; if (layer->empty()) continue; memcpy(builder->Layers[0]->Data + n, layer->Data, layer->Size * sizeof(ImDrawList*)); n += layer->Size; layer->resize(0); } } static void InitViewportDrawData(ImGuiViewportP* viewport) { ImGuiIO& io = ImGui::GetIO(); ImDrawData* draw_data = &viewport->DrawDataP; viewport->DrawDataBuilder.Layers[0] = &draw_data->CmdLists; viewport->DrawDataBuilder.Layers[1] = &viewport->DrawDataBuilder.LayerData1; viewport->DrawDataBuilder.Layers[0]->resize(0); viewport->DrawDataBuilder.Layers[1]->resize(0); draw_data->Valid = true; draw_data->CmdListsCount = 0; draw_data->TotalVtxCount = draw_data->TotalIdxCount = 0; draw_data->DisplayPos = viewport->Pos; draw_data->DisplaySize = viewport->Size; draw_data->FramebufferScale = io.DisplayFramebufferScale; draw_data->OwnerViewport = viewport; } // Push a clipping rectangle for both ImGui logic (hit-testing etc.) and low-level ImDrawList rendering. // - When using this function it is sane to ensure that float are perfectly rounded to integer values, // so that e.g. (int)(max.x-min.x) in user's render produce correct result. // - If the code here changes, may need to update code of functions like NextColumn() and PushColumnClipRect(): // some frequently called functions which to modify both channels and clipping simultaneously tend to use the // more specialized SetWindowClipRectBeforeSetChannel() to avoid extraneous updates of underlying ImDrawCmds. // - This is analoguous to PushFont()/PopFont() in the sense that are a mixing a global stack and a window stack, // which in the case of ClipRect is not so problematic but tends to be more restrictive for fonts. void ImGui::PushClipRect(const ImVec2& clip_rect_min, const ImVec2& clip_rect_max, bool intersect_with_current_clip_rect) { ImGuiWindow* window = GetCurrentWindow(); window->DrawList->PushClipRect(clip_rect_min, clip_rect_max, intersect_with_current_clip_rect); window->ClipRect = window->DrawList->_ClipRectStack.back(); } void ImGui::PopClipRect() { ImGuiWindow* window = GetCurrentWindow(); window->DrawList->PopClipRect(); window->ClipRect = window->DrawList->_ClipRectStack.back(); } static void ImGui::RenderDimmedBackgroundBehindWindow(ImGuiWindow* window, ImU32 col) { if ((col & IM_COL32_A_MASK) == 0) return; ImGuiViewportP* viewport = (ImGuiViewportP*)GetMainViewport(); ImRect viewport_rect = viewport->GetMainRect(); // Draw behind window by moving the draw command at the FRONT of the draw list { // We've already called AddWindowToDrawData() which called DrawList->ChannelsMerge() on DockNodeHost windows, // and draw list have been trimmed already, hence the explicit recreation of a draw command if missing. // FIXME: This is creating complication, might be simpler if we could inject a drawlist in drawdata at a given position and not attempt to manipulate ImDrawCmd order. ImDrawList* draw_list = window->RootWindow->DrawList; if (draw_list->CmdBuffer.Size == 0) draw_list->AddDrawCmd(); draw_list->PushClipRect(viewport_rect.Min - ImVec2(1, 1), viewport_rect.Max + ImVec2(1, 1), false); // FIXME: Need to stricty ensure ImDrawCmd are not merged (ElemCount==6 checks below will verify that) draw_list->AddRectFilled(viewport_rect.Min, viewport_rect.Max, col); ImDrawCmd cmd = draw_list->CmdBuffer.back(); IM_ASSERT(cmd.ElemCount == 6); draw_list->CmdBuffer.pop_back(); draw_list->CmdBuffer.push_front(cmd); draw_list->AddDrawCmd(); // We need to create a command as CmdBuffer.back().IdxOffset won't be correct if we append to same command. draw_list->PopClipRect(); } } ImGuiWindow* ImGui::FindBottomMostVisibleWindowWithinBeginStack(ImGuiWindow* parent_window) { ImGuiContext& g = *GImGui; ImGuiWindow* bottom_most_visible_window = parent_window; for (int i = FindWindowDisplayIndex(parent_window); i >= 0; i--) { ImGuiWindow* window = g.Windows[i]; if (window->Flags & ImGuiWindowFlags_ChildWindow) continue; if (!IsWindowWithinBeginStackOf(window, parent_window)) break; if (IsWindowActiveAndVisible(window) && GetWindowDisplayLayer(window) <= GetWindowDisplayLayer(parent_window)) bottom_most_visible_window = window; } return bottom_most_visible_window; } static void ImGui::RenderDimmedBackgrounds() { ImGuiContext& g = *GImGui; ImGuiWindow* modal_window = GetTopMostAndVisiblePopupModal(); if (g.DimBgRatio <= 0.0f && g.NavWindowingHighlightAlpha <= 0.0f) return; const bool dim_bg_for_modal = (modal_window != NULL); const bool dim_bg_for_window_list = (g.NavWindowingTargetAnim != NULL && g.NavWindowingTargetAnim->Active); if (!dim_bg_for_modal && !dim_bg_for_window_list) return; if (dim_bg_for_modal) { // Draw dimming behind modal or a begin stack child, whichever comes first in draw order. ImGuiWindow* dim_behind_window = FindBottomMostVisibleWindowWithinBeginStack(modal_window); RenderDimmedBackgroundBehindWindow(dim_behind_window, GetColorU32(modal_window->DC.ModalDimBgColor, g.DimBgRatio)); } else if (dim_bg_for_window_list) { // Draw dimming behind CTRL+Tab target window and behind CTRL+Tab UI window RenderDimmedBackgroundBehindWindow(g.NavWindowingTargetAnim, GetColorU32(ImGuiCol_NavWindowingDimBg, g.DimBgRatio)); // Draw border around CTRL+Tab target window ImGuiWindow* window = g.NavWindowingTargetAnim; ImGuiViewport* viewport = GetMainViewport(); float distance = g.FontSize; ImRect bb = window->Rect(); bb.Expand(distance); if (bb.GetWidth() >= viewport->Size.x && bb.GetHeight() >= viewport->Size.y) bb.Expand(-distance - 1.0f); // If a window fits the entire viewport, adjust its highlight inward if (window->DrawList->CmdBuffer.Size == 0) window->DrawList->AddDrawCmd(); window->DrawList->PushClipRect(viewport->Pos, viewport->Pos + viewport->Size); window->DrawList->AddRect(bb.Min, bb.Max, GetColorU32(ImGuiCol_NavWindowingHighlight, g.NavWindowingHighlightAlpha), window->WindowRounding, 0, 3.0f); window->DrawList->PopClipRect(); } } // This is normally called by Render(). You may want to call it directly if you want to avoid calling Render() but the gain will be very minimal. void ImGui::EndFrame() { ImGuiContext& g = *GImGui; IM_ASSERT(g.Initialized); // Don't process EndFrame() multiple times. if (g.FrameCountEnded == g.FrameCount) return; IM_ASSERT(g.WithinFrameScope && "Forgot to call ImGui::NewFrame()?"); CallContextHooks(&g, ImGuiContextHookType_EndFramePre); // [EXPERIMENTAL] Recover from errors if (g.IO.ConfigErrorRecovery) ErrorRecoveryTryToRecoverState(&g.StackSizesInNewFrame); ErrorCheckEndFrameSanityChecks(); ErrorCheckEndFrameFinalizeErrorTooltip(); // Notify Platform/OS when our Input Method Editor cursor has moved (e.g. CJK inputs using Microsoft IME) ImGuiPlatformImeData* ime_data = &g.PlatformImeData; if (g.PlatformIO.Platform_SetImeDataFn != NULL && memcmp(ime_data, &g.PlatformImeDataPrev, sizeof(ImGuiPlatformImeData)) != 0) { IMGUI_DEBUG_LOG_IO("[io] Calling Platform_SetImeDataFn(): WantVisible: %d, InputPos (%.2f,%.2f)\n", ime_data->WantVisible, ime_data->InputPos.x, ime_data->InputPos.y); ImGuiViewport* viewport = GetMainViewport(); g.PlatformIO.Platform_SetImeDataFn(&g, viewport, ime_data); } // Hide implicit/fallback "Debug" window if it hasn't been used g.WithinFrameScopeWithImplicitWindow = false; if (g.CurrentWindow && !g.CurrentWindow->WriteAccessed) g.CurrentWindow->Active = false; End(); // Update navigation: CTRL+Tab, wrap-around requests NavEndFrame(); // Drag and Drop: Elapse payload (if delivered, or if source stops being submitted) if (g.DragDropActive) { bool is_delivered = g.DragDropPayload.Delivery; bool is_elapsed = (g.DragDropSourceFrameCount + 1 < g.FrameCount) && ((g.DragDropSourceFlags & ImGuiDragDropFlags_PayloadAutoExpire) || g.DragDropMouseButton == -1 || !IsMouseDown(g.DragDropMouseButton)); if (is_delivered || is_elapsed) ClearDragDrop(); } // Drag and Drop: Fallback for missing source tooltip. This is not ideal but better than nothing. // If you want to handle source item disappearing: instead of submitting your description tooltip // in the BeginDragDropSource() block of the dragged item, you can submit them from a safe single spot // (e.g. end of your item loop, or before EndFrame) by reading payload data. // In the typical case, the contents of drag tooltip should be possible to infer solely from payload data. if (g.DragDropActive && g.DragDropSourceFrameCount + 1 < g.FrameCount && !(g.DragDropSourceFlags & ImGuiDragDropFlags_SourceNoPreviewTooltip)) { g.DragDropWithinSource = true; SetTooltip("..."); g.DragDropWithinSource = false; } // End frame g.WithinFrameScope = false; g.FrameCountEnded = g.FrameCount; // Initiate moving window + handle left-click and right-click focus UpdateMouseMovingWindowEndFrame(); // Sort the window list so that all child windows are after their parent // We cannot do that on FocusWindow() because children may not exist yet g.WindowsTempSortBuffer.resize(0); g.WindowsTempSortBuffer.reserve(g.Windows.Size); for (ImGuiWindow* window : g.Windows) { if (window->Active && (window->Flags & ImGuiWindowFlags_ChildWindow)) // if a child is active its parent will add it continue; AddWindowToSortBuffer(&g.WindowsTempSortBuffer, window); } // This usually assert if there is a mismatch between the ImGuiWindowFlags_ChildWindow / ParentWindow values and DC.ChildWindows[] in parents, aka we've done something wrong. IM_ASSERT(g.Windows.Size == g.WindowsTempSortBuffer.Size); g.Windows.swap(g.WindowsTempSortBuffer); g.IO.MetricsActiveWindows = g.WindowsActiveCount; // Unlock font atlas g.IO.Fonts->Locked = false; // Clear Input data for next frame g.IO.MousePosPrev = g.IO.MousePos; g.IO.AppFocusLost = false; g.IO.MouseWheel = g.IO.MouseWheelH = 0.0f; g.IO.InputQueueCharacters.resize(0); CallContextHooks(&g, ImGuiContextHookType_EndFramePost); } // Prepare the data for rendering so you can call GetDrawData() // (As with anything within the ImGui:: namspace this doesn't touch your GPU or graphics API at all: // it is the role of the ImGui_ImplXXXX_RenderDrawData() function provided by the renderer backend) void ImGui::Render() { ImGuiContext& g = *GImGui; IM_ASSERT(g.Initialized); if (g.FrameCountEnded != g.FrameCount) EndFrame(); if (g.FrameCountRendered == g.FrameCount) return; g.FrameCountRendered = g.FrameCount; g.IO.MetricsRenderWindows = 0; CallContextHooks(&g, ImGuiContextHookType_RenderPre); // Add background ImDrawList (for each active viewport) for (ImGuiViewportP* viewport : g.Viewports) { InitViewportDrawData(viewport); if (viewport->BgFgDrawLists[0] != NULL) AddDrawListToDrawDataEx(&viewport->DrawDataP, viewport->DrawDataBuilder.Layers[0], GetBackgroundDrawList(viewport)); } // Draw modal/window whitening backgrounds RenderDimmedBackgrounds(); // Add ImDrawList to render ImGuiWindow* windows_to_render_top_most[2]; windows_to_render_top_most[0] = (g.NavWindowingTarget && !(g.NavWindowingTarget->Flags & ImGuiWindowFlags_NoBringToFrontOnFocus)) ? g.NavWindowingTarget->RootWindow : NULL; windows_to_render_top_most[1] = (g.NavWindowingTarget ? g.NavWindowingListWindow : NULL); for (ImGuiWindow* window : g.Windows) { IM_MSVC_WARNING_SUPPRESS(6011); // Static Analysis false positive "warning C6011: Dereferencing NULL pointer 'window'" if (IsWindowActiveAndVisible(window) && (window->Flags & ImGuiWindowFlags_ChildWindow) == 0 && window != windows_to_render_top_most[0] && window != windows_to_render_top_most[1]) AddRootWindowToDrawData(window); } for (int n = 0; n < IM_ARRAYSIZE(windows_to_render_top_most); n++) if (windows_to_render_top_most[n] && IsWindowActiveAndVisible(windows_to_render_top_most[n])) // NavWindowingTarget is always temporarily displayed as the top-most window AddRootWindowToDrawData(windows_to_render_top_most[n]); // Draw software mouse cursor if requested by io.MouseDrawCursor flag if (g.IO.MouseDrawCursor && g.MouseCursor != ImGuiMouseCursor_None) RenderMouseCursor(g.IO.MousePos, g.Style.MouseCursorScale, g.MouseCursor, IM_COL32_WHITE, IM_COL32_BLACK, IM_COL32(0, 0, 0, 48)); // Setup ImDrawData structures for end-user g.IO.MetricsRenderVertices = g.IO.MetricsRenderIndices = 0; for (ImGuiViewportP* viewport : g.Viewports) { FlattenDrawDataIntoSingleLayer(&viewport->DrawDataBuilder); // Add foreground ImDrawList (for each active viewport) if (viewport->BgFgDrawLists[1] != NULL) AddDrawListToDrawDataEx(&viewport->DrawDataP, viewport->DrawDataBuilder.Layers[0], GetForegroundDrawList(viewport)); // We call _PopUnusedDrawCmd() last thing, as RenderDimmedBackgrounds() rely on a valid command being there (especially in docking branch). ImDrawData* draw_data = &viewport->DrawDataP; IM_ASSERT(draw_data->CmdLists.Size == draw_data->CmdListsCount); for (ImDrawList* draw_list : draw_data->CmdLists) draw_list->_PopUnusedDrawCmd(); g.IO.MetricsRenderVertices += draw_data->TotalVtxCount; g.IO.MetricsRenderIndices += draw_data->TotalIdxCount; } CallContextHooks(&g, ImGuiContextHookType_RenderPost); } // Calculate text size. Text can be multi-line. Optionally ignore text after a ## marker. // CalcTextSize("") should return ImVec2(0.0f, g.FontSize) ImVec2 ImGui::CalcTextSize(const char* text, const char* text_end, bool hide_text_after_double_hash, float wrap_width) { ImGuiContext& g = *GImGui; const char* text_display_end; if (hide_text_after_double_hash) text_display_end = FindRenderedTextEnd(text, text_end); // Hide anything after a '##' string else text_display_end = text_end; ImFont* font = g.Font; const float font_size = g.FontSize; if (text == text_display_end) return ImVec2(0.0f, font_size); ImVec2 text_size = font->CalcTextSizeA(font_size, FLT_MAX, wrap_width, text, text_display_end, NULL); // Round // FIXME: This has been here since Dec 2015 (7b0bf230) but down the line we want this out. // FIXME: Investigate using ceilf or e.g. // - https://git.musl-libc.org/cgit/musl/tree/src/math/ceilf.c // - https://embarkstudios.github.io/rust-gpu/api/src/libm/math/ceilf.rs.html text_size.x = IM_TRUNC(text_size.x + 0.99999f); return text_size; } // Find window given position, search front-to-back // - Typically write output back to g.HoveredWindow and g.HoveredWindowUnderMovingWindow. // - FIXME: Note that we have an inconsequential lag here: OuterRectClipped is updated in Begin(), so windows moved programmatically // with SetWindowPos() and not SetNextWindowPos() will have that rectangle lagging by a frame at the time FindHoveredWindow() is // called, aka before the next Begin(). Moving window isn't affected. // - The 'find_first_and_in_any_viewport = true' mode is only used by TestEngine. It is simpler to maintain here. void ImGui::FindHoveredWindowEx(const ImVec2& pos, bool find_first_and_in_any_viewport, ImGuiWindow** out_hovered_window, ImGuiWindow** out_hovered_window_under_moving_window) { ImGuiContext& g = *GImGui; ImGuiWindow* hovered_window = NULL; ImGuiWindow* hovered_window_under_moving_window = NULL; if (find_first_and_in_any_viewport == false && g.MovingWindow && !(g.MovingWindow->Flags & ImGuiWindowFlags_NoMouseInputs)) hovered_window = g.MovingWindow; ImVec2 padding_regular = g.Style.TouchExtraPadding; ImVec2 padding_for_resize = ImMax(g.Style.TouchExtraPadding, ImVec2(g.Style.WindowBorderHoverPadding, g.Style.WindowBorderHoverPadding)); for (int i = g.Windows.Size - 1; i >= 0; i--) { ImGuiWindow* window = g.Windows[i]; IM_MSVC_WARNING_SUPPRESS(28182); // [Static Analyzer] Dereferencing NULL pointer. if (!window->WasActive || window->Hidden) continue; if (window->Flags & ImGuiWindowFlags_NoMouseInputs) continue; // Using the clipped AABB, a child window will typically be clipped by its parent (not always) ImVec2 hit_padding = (window->Flags & (ImGuiWindowFlags_NoResize | ImGuiWindowFlags_AlwaysAutoResize)) ? padding_regular : padding_for_resize; if (!window->OuterRectClipped.ContainsWithPad(pos, hit_padding)) continue; // Support for one rectangular hole in any given window // FIXME: Consider generalizing hit-testing override (with more generic data, callback, etc.) (#1512) if (window->HitTestHoleSize.x != 0) { ImVec2 hole_pos(window->Pos.x + (float)window->HitTestHoleOffset.x, window->Pos.y + (float)window->HitTestHoleOffset.y); ImVec2 hole_size((float)window->HitTestHoleSize.x, (float)window->HitTestHoleSize.y); if (ImRect(hole_pos, hole_pos + hole_size).Contains(pos)) continue; } if (find_first_and_in_any_viewport) { hovered_window = window; break; } else { if (hovered_window == NULL) hovered_window = window; IM_MSVC_WARNING_SUPPRESS(28182); // [Static Analyzer] Dereferencing NULL pointer. if (hovered_window_under_moving_window == NULL && (!g.MovingWindow || window->RootWindow != g.MovingWindow->RootWindow)) hovered_window_under_moving_window = window; if (hovered_window && hovered_window_under_moving_window) break; } } *out_hovered_window = hovered_window; if (out_hovered_window_under_moving_window != NULL) *out_hovered_window_under_moving_window = hovered_window_under_moving_window; } bool ImGui::IsItemActive() { ImGuiContext& g = *GImGui; if (g.ActiveId) return g.ActiveId == g.LastItemData.ID; return false; } bool ImGui::IsItemActivated() { ImGuiContext& g = *GImGui; if (g.ActiveId) if (g.ActiveId == g.LastItemData.ID && g.ActiveIdPreviousFrame != g.LastItemData.ID) return true; return false; } bool ImGui::IsItemDeactivated() { ImGuiContext& g = *GImGui; if (g.LastItemData.StatusFlags & ImGuiItemStatusFlags_HasDeactivated) return (g.LastItemData.StatusFlags & ImGuiItemStatusFlags_Deactivated) != 0; return (g.DeactivatedItemData.ID == g.LastItemData.ID && g.LastItemData.ID != 0 && g.DeactivatedItemData.ElapseFrame >= g.FrameCount); } bool ImGui::IsItemDeactivatedAfterEdit() { ImGuiContext& g = *GImGui; return IsItemDeactivated() && g.DeactivatedItemData.HasBeenEditedBefore; } // == (GetItemID() == GetFocusID() && GetFocusID() != 0) bool ImGui::IsItemFocused() { ImGuiContext& g = *GImGui; return g.NavId == g.LastItemData.ID && g.NavId != 0; } // Important: this can be useful but it is NOT equivalent to the behavior of e.g.Button()! // Most widgets have specific reactions based on mouse-up/down state, mouse position etc. bool ImGui::IsItemClicked(ImGuiMouseButton mouse_button) { return IsMouseClicked(mouse_button) && IsItemHovered(ImGuiHoveredFlags_None); } bool ImGui::IsItemToggledOpen() { ImGuiContext& g = *GImGui; return (g.LastItemData.StatusFlags & ImGuiItemStatusFlags_ToggledOpen) ? true : false; } // Call after a Selectable() or TreeNode() involved in multi-selection. // Useful if you need the per-item information before reaching EndMultiSelect(), e.g. for rendering purpose. // This is only meant to be called inside a BeginMultiSelect()/EndMultiSelect() block. // (Outside of multi-select, it would be misleading/ambiguous to report this signal, as widgets // return e.g. a pressed event and user code is in charge of altering selection in ways we cannot predict.) bool ImGui::IsItemToggledSelection() { ImGuiContext& g = *GImGui; IM_ASSERT(g.CurrentMultiSelect != NULL); // Can only be used inside a BeginMultiSelect()/EndMultiSelect() return (g.LastItemData.StatusFlags & ImGuiItemStatusFlags_ToggledSelection) ? true : false; } // IMPORTANT: If you are trying to check whether your mouse should be dispatched to Dear ImGui or to your underlying app, // you should not use this function! Use the 'io.WantCaptureMouse' boolean for that! // Refer to FAQ entry "How can I tell whether to dispatch mouse/keyboard to Dear ImGui or my application?" for details. bool ImGui::IsAnyItemHovered() { ImGuiContext& g = *GImGui; return g.HoveredId != 0 || g.HoveredIdPreviousFrame != 0; } bool ImGui::IsAnyItemActive() { ImGuiContext& g = *GImGui; return g.ActiveId != 0; } bool ImGui::IsAnyItemFocused() { ImGuiContext& g = *GImGui; return g.NavId != 0 && g.NavCursorVisible; } bool ImGui::IsItemVisible() { ImGuiContext& g = *GImGui; return (g.LastItemData.StatusFlags & ImGuiItemStatusFlags_Visible) != 0; } bool ImGui::IsItemEdited() { ImGuiContext& g = *GImGui; return (g.LastItemData.StatusFlags & ImGuiItemStatusFlags_Edited) != 0; } // Allow next item to be overlapped by subsequent items. // This works by requiring HoveredId to match for two subsequent frames, // so if a following items overwrite it our interactions will naturally be disabled. void ImGui::SetNextItemAllowOverlap() { ImGuiContext& g = *GImGui; g.NextItemData.ItemFlags |= ImGuiItemFlags_AllowOverlap; } #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS // Allow last item to be overlapped by a subsequent item. Both may be activated during the same frame before the later one takes priority. // FIXME-LEGACY: Use SetNextItemAllowOverlap() *before* your item instead. void ImGui::SetItemAllowOverlap() { ImGuiContext& g = *GImGui; ImGuiID id = g.LastItemData.ID; if (g.HoveredId == id) g.HoveredIdAllowOverlap = true; if (g.ActiveId == id) // Before we made this obsolete, most calls to SetItemAllowOverlap() used to avoid this path by testing g.ActiveId != id. g.ActiveIdAllowOverlap = true; } #endif // This is a shortcut for not taking ownership of 100+ keys, frequently used by drag operations. // FIXME: It might be undesirable that this will likely disable KeyOwner-aware shortcuts systems. Consider a more fine-tuned version if needed? void ImGui::SetActiveIdUsingAllKeyboardKeys() { ImGuiContext& g = *GImGui; IM_ASSERT(g.ActiveId != 0); g.ActiveIdUsingNavDirMask = (1 << ImGuiDir_COUNT) - 1; g.ActiveIdUsingAllKeyboardKeys = true; NavMoveRequestCancel(); } ImGuiID ImGui::GetItemID() { ImGuiContext& g = *GImGui; return g.LastItemData.ID; } ImVec2 ImGui::GetItemRectMin() { ImGuiContext& g = *GImGui; return g.LastItemData.Rect.Min; } ImVec2 ImGui::GetItemRectMax() { ImGuiContext& g = *GImGui; return g.LastItemData.Rect.Max; } ImVec2 ImGui::GetItemRectSize() { ImGuiContext& g = *GImGui; return g.LastItemData.Rect.GetSize(); } // Prior to v1.90 2023/10/16, the BeginChild() function took a 'bool border = false' parameter instead of 'ImGuiChildFlags child_flags = 0'. // ImGuiChildFlags_Borders is defined as always == 1 in order to allow old code passing 'true'. Read comments in imgui.h for details! bool ImGui::BeginChild(const char* str_id, const ImVec2& size_arg, ImGuiChildFlags child_flags, ImGuiWindowFlags window_flags) { ImGuiID id = GetCurrentWindow()->GetID(str_id); return BeginChildEx(str_id, id, size_arg, child_flags, window_flags); } bool ImGui::BeginChild(ImGuiID id, const ImVec2& size_arg, ImGuiChildFlags child_flags, ImGuiWindowFlags window_flags) { return BeginChildEx(NULL, id, size_arg, child_flags, window_flags); } bool ImGui::BeginChildEx(const char* name, ImGuiID id, const ImVec2& size_arg, ImGuiChildFlags child_flags, ImGuiWindowFlags window_flags) { ImGuiContext& g = *GImGui; ImGuiWindow* parent_window = g.CurrentWindow; IM_ASSERT(id != 0); // Sanity check as it is likely that some user will accidentally pass ImGuiWindowFlags into the ImGuiChildFlags argument. const ImGuiChildFlags ImGuiChildFlags_SupportedMask_ = ImGuiChildFlags_Borders | ImGuiChildFlags_AlwaysUseWindowPadding | ImGuiChildFlags_ResizeX | ImGuiChildFlags_ResizeY | ImGuiChildFlags_AutoResizeX | ImGuiChildFlags_AutoResizeY | ImGuiChildFlags_AlwaysAutoResize | ImGuiChildFlags_FrameStyle | ImGuiChildFlags_NavFlattened; IM_UNUSED(ImGuiChildFlags_SupportedMask_); IM_ASSERT((child_flags & ~ImGuiChildFlags_SupportedMask_) == 0 && "Illegal ImGuiChildFlags value. Did you pass ImGuiWindowFlags values instead of ImGuiChildFlags?"); IM_ASSERT((window_flags & ImGuiWindowFlags_AlwaysAutoResize) == 0 && "Cannot specify ImGuiWindowFlags_AlwaysAutoResize for BeginChild(). Use ImGuiChildFlags_AlwaysAutoResize!"); if (child_flags & ImGuiChildFlags_AlwaysAutoResize) { IM_ASSERT((child_flags & (ImGuiChildFlags_ResizeX | ImGuiChildFlags_ResizeY)) == 0 && "Cannot use ImGuiChildFlags_ResizeX or ImGuiChildFlags_ResizeY with ImGuiChildFlags_AlwaysAutoResize!"); IM_ASSERT((child_flags & (ImGuiChildFlags_AutoResizeX | ImGuiChildFlags_AutoResizeY)) != 0 && "Must use ImGuiChildFlags_AutoResizeX or ImGuiChildFlags_AutoResizeY with ImGuiChildFlags_AlwaysAutoResize!"); } #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS if (window_flags & ImGuiWindowFlags_AlwaysUseWindowPadding) child_flags |= ImGuiChildFlags_AlwaysUseWindowPadding; if (window_flags & ImGuiWindowFlags_NavFlattened) child_flags |= ImGuiChildFlags_NavFlattened; #endif if (child_flags & ImGuiChildFlags_AutoResizeX) child_flags &= ~ImGuiChildFlags_ResizeX; if (child_flags & ImGuiChildFlags_AutoResizeY) child_flags &= ~ImGuiChildFlags_ResizeY; // Set window flags window_flags |= ImGuiWindowFlags_ChildWindow | ImGuiWindowFlags_NoTitleBar; window_flags |= (parent_window->Flags & ImGuiWindowFlags_NoMove); // Inherit the NoMove flag if (child_flags & (ImGuiChildFlags_AutoResizeX | ImGuiChildFlags_AutoResizeY | ImGuiChildFlags_AlwaysAutoResize)) window_flags |= ImGuiWindowFlags_AlwaysAutoResize; if ((child_flags & (ImGuiChildFlags_ResizeX | ImGuiChildFlags_ResizeY)) == 0) window_flags |= ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoSavedSettings; // Special framed style if (child_flags & ImGuiChildFlags_FrameStyle) { PushStyleColor(ImGuiCol_ChildBg, g.Style.Colors[ImGuiCol_FrameBg]); PushStyleVar(ImGuiStyleVar_ChildRounding, g.Style.FrameRounding); PushStyleVar(ImGuiStyleVar_ChildBorderSize, g.Style.FrameBorderSize); PushStyleVar(ImGuiStyleVar_WindowPadding, g.Style.FramePadding); child_flags |= ImGuiChildFlags_Borders | ImGuiChildFlags_AlwaysUseWindowPadding; window_flags |= ImGuiWindowFlags_NoMove; } // Forward size // Important: Begin() has special processing to switch condition to ImGuiCond_FirstUseEver for a given axis when ImGuiChildFlags_ResizeXXX is set. // (the alternative would to store conditional flags per axis, which is possible but more code) const ImVec2 size_avail = GetContentRegionAvail(); const ImVec2 size_default((child_flags & ImGuiChildFlags_AutoResizeX) ? 0.0f : size_avail.x, (child_flags & ImGuiChildFlags_AutoResizeY) ? 0.0f : size_avail.y); ImVec2 size = CalcItemSize(size_arg, size_default.x, size_default.y); // A SetNextWindowSize() call always has priority (#8020) // (since the code in Begin() never supported SizeVal==0.0f aka auto-resize via SetNextWindowSize() call, we don't support it here for now) // FIXME: We only support ImGuiCond_Always in this path. Supporting other paths would requires to obtain window pointer. if ((g.NextWindowData.HasFlags & ImGuiNextWindowDataFlags_HasSize) != 0 && (g.NextWindowData.SizeCond & ImGuiCond_Always) != 0) { if (g.NextWindowData.SizeVal.x > 0.0f) { size.x = g.NextWindowData.SizeVal.x; child_flags &= ~ImGuiChildFlags_ResizeX; } if (g.NextWindowData.SizeVal.y > 0.0f) { size.y = g.NextWindowData.SizeVal.y; child_flags &= ~ImGuiChildFlags_ResizeY; } } SetNextWindowSize(size); // Forward child flags (we allow prior settings to merge but it'll only work for adding flags) if (g.NextWindowData.HasFlags & ImGuiNextWindowDataFlags_HasChildFlags) g.NextWindowData.ChildFlags |= child_flags; else g.NextWindowData.ChildFlags = child_flags; g.NextWindowData.HasFlags |= ImGuiNextWindowDataFlags_HasChildFlags; // Build up name. If you need to append to a same child from multiple location in the ID stack, use BeginChild(ImGuiID id) with a stable value. // FIXME: 2023/11/14: commented out shorted version. We had an issue with multiple ### in child window path names, which the trailing hash helped workaround. // e.g. "ParentName###ParentIdentifier/ChildName###ChildIdentifier" would get hashed incorrectly by ImHashStr(), trailing _%08X somehow fixes it. const char* temp_window_name; /*if (name && parent_window->IDStack.back() == parent_window->ID) ImFormatStringToTempBuffer(&temp_window_name, NULL, "%s/%s", parent_window->Name, name); // May omit ID if in root of ID stack else*/ if (name) ImFormatStringToTempBuffer(&temp_window_name, NULL, "%s/%s_%08X", parent_window->Name, name, id); else ImFormatStringToTempBuffer(&temp_window_name, NULL, "%s/%08X", parent_window->Name, id); // Set style const float backup_border_size = g.Style.ChildBorderSize; if ((child_flags & ImGuiChildFlags_Borders) == 0) g.Style.ChildBorderSize = 0.0f; // Begin into window const bool ret = Begin(temp_window_name, NULL, window_flags); // Restore style g.Style.ChildBorderSize = backup_border_size; if (child_flags & ImGuiChildFlags_FrameStyle) { PopStyleVar(3); PopStyleColor(); } ImGuiWindow* child_window = g.CurrentWindow; child_window->ChildId = id; // Set the cursor to handle case where the user called SetNextWindowPos()+BeginChild() manually. // While this is not really documented/defined, it seems that the expected thing to do. if (child_window->BeginCount == 1) parent_window->DC.CursorPos = child_window->Pos; // Process navigation-in immediately so NavInit can run on first frame // Can enter a child if (A) it has navigable items or (B) it can be scrolled. const ImGuiID temp_id_for_activation = ImHashStr("##Child", 0, id); if (g.ActiveId == temp_id_for_activation) ClearActiveID(); if (g.NavActivateId == id && !(child_flags & ImGuiChildFlags_NavFlattened) && (child_window->DC.NavLayersActiveMask != 0 || child_window->DC.NavWindowHasScrollY)) { FocusWindow(child_window); NavInitWindow(child_window, false); SetActiveID(temp_id_for_activation, child_window); // Steal ActiveId with another arbitrary id so that key-press won't activate child item g.ActiveIdSource = g.NavInputSource; } return ret; } void ImGui::EndChild() { ImGuiContext& g = *GImGui; ImGuiWindow* child_window = g.CurrentWindow; const ImGuiID backup_within_end_child_id = g.WithinEndChildID; IM_ASSERT(child_window->Flags & ImGuiWindowFlags_ChildWindow); // Mismatched BeginChild()/EndChild() calls g.WithinEndChildID = child_window->ID; ImVec2 child_size = child_window->Size; End(); if (child_window->BeginCount == 1) { ImGuiWindow* parent_window = g.CurrentWindow; ImRect bb(parent_window->DC.CursorPos, parent_window->DC.CursorPos + child_size); ItemSize(child_size); const bool nav_flattened = (child_window->ChildFlags & ImGuiChildFlags_NavFlattened) != 0; if ((child_window->DC.NavLayersActiveMask != 0 || child_window->DC.NavWindowHasScrollY) && !nav_flattened) { ItemAdd(bb, child_window->ChildId); RenderNavCursor(bb, child_window->ChildId); // When browsing a window that has no activable items (scroll only) we keep a highlight on the child (pass g.NavId to trick into always displaying) if (child_window->DC.NavLayersActiveMask == 0 && child_window == g.NavWindow) RenderNavCursor(ImRect(bb.Min - ImVec2(2, 2), bb.Max + ImVec2(2, 2)), g.NavId, ImGuiNavRenderCursorFlags_Compact); } else { // Not navigable into // - This is a bit of a fringe use case, mostly useful for undecorated, non-scrolling contents childs, or empty childs. // - We could later decide to not apply this path if ImGuiChildFlags_FrameStyle or ImGuiChildFlags_Borders is set. ItemAdd(bb, child_window->ChildId, NULL, ImGuiItemFlags_NoNav); // But when flattened we directly reach items, adjust active layer mask accordingly if (nav_flattened) parent_window->DC.NavLayersActiveMaskNext |= child_window->DC.NavLayersActiveMaskNext; } if (g.HoveredWindow == child_window) g.LastItemData.StatusFlags |= ImGuiItemStatusFlags_HoveredWindow; child_window->DC.ChildItemStatusFlags = g.LastItemData.StatusFlags; //SetLastItemDataForChildWindowItem(child_window, child_window->Rect()); // Not needed, effectively done by ItemAdd() } else { SetLastItemDataForChildWindowItem(child_window, child_window->Rect()); } g.WithinEndChildID = backup_within_end_child_id; g.LogLinePosY = -FLT_MAX; // To enforce a carriage return } static void SetWindowConditionAllowFlags(ImGuiWindow* window, ImGuiCond flags, bool enabled) { window->SetWindowPosAllowFlags = enabled ? (window->SetWindowPosAllowFlags | flags) : (window->SetWindowPosAllowFlags & ~flags); window->SetWindowSizeAllowFlags = enabled ? (window->SetWindowSizeAllowFlags | flags) : (window->SetWindowSizeAllowFlags & ~flags); window->SetWindowCollapsedAllowFlags = enabled ? (window->SetWindowCollapsedAllowFlags | flags) : (window->SetWindowCollapsedAllowFlags & ~flags); } ImGuiWindow* ImGui::FindWindowByID(ImGuiID id) { ImGuiContext& g = *GImGui; return (ImGuiWindow*)g.WindowsById.GetVoidPtr(id); } ImGuiWindow* ImGui::FindWindowByName(const char* name) { ImGuiID id = ImHashStr(name); return FindWindowByID(id); } static void ApplyWindowSettings(ImGuiWindow* window, ImGuiWindowSettings* settings) { window->Pos = ImTrunc(ImVec2(settings->Pos.x, settings->Pos.y)); if (settings->Size.x > 0 && settings->Size.y > 0) window->Size = window->SizeFull = ImTrunc(ImVec2(settings->Size.x, settings->Size.y)); window->Collapsed = settings->Collapsed; } static void InitOrLoadWindowSettings(ImGuiWindow* window, ImGuiWindowSettings* settings) { // Initial window state with e.g. default/arbitrary window position // Use SetNextWindowPos() with the appropriate condition flag to change the initial position of a window. const ImGuiViewport* main_viewport = ImGui::GetMainViewport(); window->Pos = main_viewport->Pos + ImVec2(60, 60); window->Size = window->SizeFull = ImVec2(0, 0); window->SetWindowPosAllowFlags = window->SetWindowSizeAllowFlags = window->SetWindowCollapsedAllowFlags = ImGuiCond_Always | ImGuiCond_Once | ImGuiCond_FirstUseEver | ImGuiCond_Appearing; if (settings != NULL) { SetWindowConditionAllowFlags(window, ImGuiCond_FirstUseEver, false); ApplyWindowSettings(window, settings); } window->DC.CursorStartPos = window->DC.CursorMaxPos = window->DC.IdealMaxPos = window->Pos; // So first call to CalcWindowContentSizes() doesn't return crazy values if ((window->Flags & ImGuiWindowFlags_AlwaysAutoResize) != 0) { window->AutoFitFramesX = window->AutoFitFramesY = 2; window->AutoFitOnlyGrows = false; } else { if (window->Size.x <= 0.0f) window->AutoFitFramesX = 2; if (window->Size.y <= 0.0f) window->AutoFitFramesY = 2; window->AutoFitOnlyGrows = (window->AutoFitFramesX > 0) || (window->AutoFitFramesY > 0); } } static ImGuiWindow* CreateNewWindow(const char* name, ImGuiWindowFlags flags) { // Create window the first time //IMGUI_DEBUG_LOG("CreateNewWindow '%s', flags = 0x%08X\n", name, flags); ImGuiContext& g = *GImGui; ImGuiWindow* window = IM_NEW(ImGuiWindow)(&g, name); window->Flags = flags; g.WindowsById.SetVoidPtr(window->ID, window); ImGuiWindowSettings* settings = NULL; if (!(flags & ImGuiWindowFlags_NoSavedSettings)) if ((settings = ImGui::FindWindowSettingsByWindow(window)) != 0) window->SettingsOffset = g.SettingsWindows.offset_from_ptr(settings); InitOrLoadWindowSettings(window, settings); if (flags & ImGuiWindowFlags_NoBringToFrontOnFocus) g.Windows.push_front(window); // Quite slow but rare and only once else g.Windows.push_back(window); return window; } static inline ImVec2 CalcWindowMinSize(ImGuiWindow* window) { // We give windows non-zero minimum size to facilitate understanding problematic cases (e.g. empty popups) // FIXME: Essentially we want to restrict manual resizing to WindowMinSize+Decoration, and allow api resizing to be smaller. // Perhaps should tend further a neater test for this. ImGuiContext& g = *GImGui; ImVec2 size_min; if ((window->Flags & ImGuiWindowFlags_ChildWindow) && !(window->Flags & ImGuiWindowFlags_Popup)) { size_min.x = (window->ChildFlags & ImGuiChildFlags_ResizeX) ? g.Style.WindowMinSize.x : 4.0f; size_min.y = (window->ChildFlags & ImGuiChildFlags_ResizeY) ? g.Style.WindowMinSize.y : 4.0f; } else { size_min.x = ((window->Flags & ImGuiWindowFlags_AlwaysAutoResize) == 0) ? g.Style.WindowMinSize.x : 4.0f; size_min.y = ((window->Flags & ImGuiWindowFlags_AlwaysAutoResize) == 0) ? g.Style.WindowMinSize.y : 4.0f; } // Reduce artifacts with very small windows ImGuiWindow* window_for_height = window; size_min.y = ImMax(size_min.y, window_for_height->TitleBarHeight + window_for_height->MenuBarHeight + ImMax(0.0f, g.Style.WindowRounding - 1.0f)); return size_min; } static ImVec2 CalcWindowSizeAfterConstraint(ImGuiWindow* window, const ImVec2& size_desired) { ImGuiContext& g = *GImGui; ImVec2 new_size = size_desired; if (g.NextWindowData.HasFlags & ImGuiNextWindowDataFlags_HasSizeConstraint) { // See comments in SetNextWindowSizeConstraints() for details about setting size_min an size_max. ImRect cr = g.NextWindowData.SizeConstraintRect; new_size.x = (cr.Min.x >= 0 && cr.Max.x >= 0) ? ImClamp(new_size.x, cr.Min.x, cr.Max.x) : window->SizeFull.x; new_size.y = (cr.Min.y >= 0 && cr.Max.y >= 0) ? ImClamp(new_size.y, cr.Min.y, cr.Max.y) : window->SizeFull.y; if (g.NextWindowData.SizeCallback) { ImGuiSizeCallbackData data; data.UserData = g.NextWindowData.SizeCallbackUserData; data.Pos = window->Pos; data.CurrentSize = window->SizeFull; data.DesiredSize = new_size; g.NextWindowData.SizeCallback(&data); new_size = data.DesiredSize; } new_size.x = IM_TRUNC(new_size.x); new_size.y = IM_TRUNC(new_size.y); } // Minimum size ImVec2 size_min = CalcWindowMinSize(window); return ImMax(new_size, size_min); } static void CalcWindowContentSizes(ImGuiWindow* window, ImVec2* content_size_current, ImVec2* content_size_ideal) { bool preserve_old_content_sizes = false; if (window->Collapsed && window->AutoFitFramesX <= 0 && window->AutoFitFramesY <= 0) preserve_old_content_sizes = true; else if (window->Hidden && window->HiddenFramesCannotSkipItems == 0 && window->HiddenFramesCanSkipItems > 0) preserve_old_content_sizes = true; if (preserve_old_content_sizes) { *content_size_current = window->ContentSize; *content_size_ideal = window->ContentSizeIdeal; return; } content_size_current->x = (window->ContentSizeExplicit.x != 0.0f) ? window->ContentSizeExplicit.x : IM_TRUNC(window->DC.CursorMaxPos.x - window->DC.CursorStartPos.x); content_size_current->y = (window->ContentSizeExplicit.y != 0.0f) ? window->ContentSizeExplicit.y : IM_TRUNC(window->DC.CursorMaxPos.y - window->DC.CursorStartPos.y); content_size_ideal->x = (window->ContentSizeExplicit.x != 0.0f) ? window->ContentSizeExplicit.x : IM_TRUNC(ImMax(window->DC.CursorMaxPos.x, window->DC.IdealMaxPos.x) - window->DC.CursorStartPos.x); content_size_ideal->y = (window->ContentSizeExplicit.y != 0.0f) ? window->ContentSizeExplicit.y : IM_TRUNC(ImMax(window->DC.CursorMaxPos.y, window->DC.IdealMaxPos.y) - window->DC.CursorStartPos.y); } static ImVec2 CalcWindowAutoFitSize(ImGuiWindow* window, const ImVec2& size_contents) { ImGuiContext& g = *GImGui; ImGuiStyle& style = g.Style; const float decoration_w_without_scrollbars = window->DecoOuterSizeX1 + window->DecoOuterSizeX2 - window->ScrollbarSizes.x; const float decoration_h_without_scrollbars = window->DecoOuterSizeY1 + window->DecoOuterSizeY2 - window->ScrollbarSizes.y; ImVec2 size_pad = window->WindowPadding * 2.0f; ImVec2 size_desired = size_contents + size_pad + ImVec2(decoration_w_without_scrollbars, decoration_h_without_scrollbars); if (window->Flags & ImGuiWindowFlags_Tooltip) { // Tooltip always resize return size_desired; } else { // Maximum window size is determined by the viewport size or monitor size ImVec2 size_min = CalcWindowMinSize(window); ImVec2 size_max = ((window->Flags & ImGuiWindowFlags_ChildWindow) && !(window->Flags & ImGuiWindowFlags_Popup)) ? ImVec2(FLT_MAX, FLT_MAX) : ImGui::GetMainViewport()->WorkSize - style.DisplaySafeAreaPadding * 2.0f; ImVec2 size_auto_fit = ImClamp(size_desired, size_min, size_max); // FIXME: CalcWindowAutoFitSize() doesn't take into account that only one axis may be auto-fit when calculating scrollbars, // we may need to compute/store three variants of size_auto_fit, for x/y/xy. // Here we implement a workaround for child windows only, but a full solution would apply to normal windows as well: if ((window->ChildFlags & ImGuiChildFlags_ResizeX) && !(window->ChildFlags & ImGuiChildFlags_ResizeY)) size_auto_fit.y = window->SizeFull.y; else if (!(window->ChildFlags & ImGuiChildFlags_ResizeX) && (window->ChildFlags & ImGuiChildFlags_ResizeY)) size_auto_fit.x = window->SizeFull.x; // When the window cannot fit all contents (either because of constraints, either because screen is too small), // we are growing the size on the other axis to compensate for expected scrollbar. FIXME: Might turn bigger than ViewportSize-WindowPadding. ImVec2 size_auto_fit_after_constraint = CalcWindowSizeAfterConstraint(window, size_auto_fit); bool will_have_scrollbar_x = (size_auto_fit_after_constraint.x - size_pad.x - decoration_w_without_scrollbars < size_contents.x && !(window->Flags & ImGuiWindowFlags_NoScrollbar) && (window->Flags & ImGuiWindowFlags_HorizontalScrollbar)) || (window->Flags & ImGuiWindowFlags_AlwaysHorizontalScrollbar); bool will_have_scrollbar_y = (size_auto_fit_after_constraint.y - size_pad.y - decoration_h_without_scrollbars < size_contents.y && !(window->Flags & ImGuiWindowFlags_NoScrollbar)) || (window->Flags & ImGuiWindowFlags_AlwaysVerticalScrollbar); if (will_have_scrollbar_x) size_auto_fit.y += style.ScrollbarSize; if (will_have_scrollbar_y) size_auto_fit.x += style.ScrollbarSize; return size_auto_fit; } } ImVec2 ImGui::CalcWindowNextAutoFitSize(ImGuiWindow* window) { ImVec2 size_contents_current; ImVec2 size_contents_ideal; CalcWindowContentSizes(window, &size_contents_current, &size_contents_ideal); ImVec2 size_auto_fit = CalcWindowAutoFitSize(window, size_contents_ideal); ImVec2 size_final = CalcWindowSizeAfterConstraint(window, size_auto_fit); return size_final; } static ImGuiCol GetWindowBgColorIdx(ImGuiWindow* window) { if (window->Flags & (ImGuiWindowFlags_Tooltip | ImGuiWindowFlags_Popup)) return ImGuiCol_PopupBg; if (window->Flags & ImGuiWindowFlags_ChildWindow) return ImGuiCol_ChildBg; return ImGuiCol_WindowBg; } static void CalcResizePosSizeFromAnyCorner(ImGuiWindow* window, const ImVec2& corner_target, const ImVec2& corner_norm, ImVec2* out_pos, ImVec2* out_size) { ImVec2 pos_min = ImLerp(corner_target, window->Pos, corner_norm); // Expected window upper-left ImVec2 pos_max = ImLerp(window->Pos + window->Size, corner_target, corner_norm); // Expected window lower-right ImVec2 size_expected = pos_max - pos_min; ImVec2 size_constrained = CalcWindowSizeAfterConstraint(window, size_expected); *out_pos = pos_min; if (corner_norm.x == 0.0f) out_pos->x -= (size_constrained.x - size_expected.x); if (corner_norm.y == 0.0f) out_pos->y -= (size_constrained.y - size_expected.y); *out_size = size_constrained; } // Data for resizing from resize grip / corner struct ImGuiResizeGripDef { ImVec2 CornerPosN; ImVec2 InnerDir; int AngleMin12, AngleMax12; }; static const ImGuiResizeGripDef resize_grip_def[4] = { { ImVec2(1, 1), ImVec2(-1, -1), 0, 3 }, // Lower-right { ImVec2(0, 1), ImVec2(+1, -1), 3, 6 }, // Lower-left { ImVec2(0, 0), ImVec2(+1, +1), 6, 9 }, // Upper-left (Unused) { ImVec2(1, 0), ImVec2(-1, +1), 9, 12 } // Upper-right (Unused) }; // Data for resizing from borders struct ImGuiResizeBorderDef { ImVec2 InnerDir; // Normal toward inside ImVec2 SegmentN1, SegmentN2; // End positions, normalized (0,0: upper left) float OuterAngle; // Angle toward outside }; static const ImGuiResizeBorderDef resize_border_def[4] = { { ImVec2(+1, 0), ImVec2(0, 1), ImVec2(0, 0), IM_PI * 1.00f }, // Left { ImVec2(-1, 0), ImVec2(1, 0), ImVec2(1, 1), IM_PI * 0.00f }, // Right { ImVec2(0, +1), ImVec2(0, 0), ImVec2(1, 0), IM_PI * 1.50f }, // Up { ImVec2(0, -1), ImVec2(1, 1), ImVec2(0, 1), IM_PI * 0.50f } // Down }; static ImRect GetResizeBorderRect(ImGuiWindow* window, int border_n, float perp_padding, float thickness) { ImRect rect = window->Rect(); if (thickness == 0.0f) rect.Max -= ImVec2(1, 1); if (border_n == ImGuiDir_Left) { return ImRect(rect.Min.x - thickness, rect.Min.y + perp_padding, rect.Min.x + thickness, rect.Max.y - perp_padding); } if (border_n == ImGuiDir_Right) { return ImRect(rect.Max.x - thickness, rect.Min.y + perp_padding, rect.Max.x + thickness, rect.Max.y - perp_padding); } if (border_n == ImGuiDir_Up) { return ImRect(rect.Min.x + perp_padding, rect.Min.y - thickness, rect.Max.x - perp_padding, rect.Min.y + thickness); } if (border_n == ImGuiDir_Down) { return ImRect(rect.Min.x + perp_padding, rect.Max.y - thickness, rect.Max.x - perp_padding, rect.Max.y + thickness); } IM_ASSERT(0); return ImRect(); } // 0..3: corners (Lower-right, Lower-left, Unused, Unused) ImGuiID ImGui::GetWindowResizeCornerID(ImGuiWindow* window, int n) { IM_ASSERT(n >= 0 && n < 4); ImGuiID id = window->ID; id = ImHashStr("#RESIZE", 0, id); id = ImHashData(&n, sizeof(int), id); return id; } // Borders (Left, Right, Up, Down) ImGuiID ImGui::GetWindowResizeBorderID(ImGuiWindow* window, ImGuiDir dir) { IM_ASSERT(dir >= 0 && dir < 4); int n = (int)dir + 4; ImGuiID id = window->ID; id = ImHashStr("#RESIZE", 0, id); id = ImHashData(&n, sizeof(int), id); return id; } // Handle resize for: Resize Grips, Borders, Gamepad // Return true when using auto-fit (double-click on resize grip) static int ImGui::UpdateWindowManualResize(ImGuiWindow* window, const ImVec2& size_auto_fit, int* border_hovered, int* border_held, int resize_grip_count, ImU32 resize_grip_col[4], const ImRect& visibility_rect) { ImGuiContext& g = *GImGui; ImGuiWindowFlags flags = window->Flags; if ((flags & ImGuiWindowFlags_NoResize) || (flags & ImGuiWindowFlags_AlwaysAutoResize) || window->AutoFitFramesX > 0 || window->AutoFitFramesY > 0) return false; if (window->WasActive == false) // Early out to avoid running this code for e.g. a hidden implicit/fallback Debug window. return false; int ret_auto_fit_mask = 0x00; const float grip_draw_size = IM_TRUNC(ImMax(g.FontSize * 1.35f, window->WindowRounding + 1.0f + g.FontSize * 0.2f)); const float grip_hover_inner_size = (resize_grip_count > 0) ? IM_TRUNC(grip_draw_size * 0.75f) : 0.0f; const float grip_hover_outer_size = g.WindowsBorderHoverPadding; ImRect clamp_rect = visibility_rect; const bool window_move_from_title_bar = g.IO.ConfigWindowsMoveFromTitleBarOnly && !(window->Flags & ImGuiWindowFlags_NoTitleBar); if (window_move_from_title_bar) clamp_rect.Min.y -= window->TitleBarHeight; ImVec2 pos_target(FLT_MAX, FLT_MAX); ImVec2 size_target(FLT_MAX, FLT_MAX); // Resize grips and borders are on layer 1 window->DC.NavLayerCurrent = ImGuiNavLayer_Menu; // Manual resize grips PushID("#RESIZE"); for (int resize_grip_n = 0; resize_grip_n < resize_grip_count; resize_grip_n++) { const ImGuiResizeGripDef& def = resize_grip_def[resize_grip_n]; const ImVec2 corner = ImLerp(window->Pos, window->Pos + window->Size, def.CornerPosN); // Using the FlattenChilds button flag we make the resize button accessible even if we are hovering over a child window bool hovered, held; ImRect resize_rect(corner - def.InnerDir * grip_hover_outer_size, corner + def.InnerDir * grip_hover_inner_size); if (resize_rect.Min.x > resize_rect.Max.x) ImSwap(resize_rect.Min.x, resize_rect.Max.x); if (resize_rect.Min.y > resize_rect.Max.y) ImSwap(resize_rect.Min.y, resize_rect.Max.y); ImGuiID resize_grip_id = window->GetID(resize_grip_n); // == GetWindowResizeCornerID() ItemAdd(resize_rect, resize_grip_id, NULL, ImGuiItemFlags_NoNav); ButtonBehavior(resize_rect, resize_grip_id, &hovered, &held, ImGuiButtonFlags_FlattenChildren | ImGuiButtonFlags_NoNavFocus); //GetForegroundDrawList(window)->AddRect(resize_rect.Min, resize_rect.Max, IM_COL32(255, 255, 0, 255)); if (hovered || held) SetMouseCursor((resize_grip_n & 1) ? ImGuiMouseCursor_ResizeNESW : ImGuiMouseCursor_ResizeNWSE); if (held && g.IO.MouseDoubleClicked[0]) { // Auto-fit when double-clicking size_target = CalcWindowSizeAfterConstraint(window, size_auto_fit); ret_auto_fit_mask = 0x03; // Both axes ClearActiveID(); } else if (held) { // Resize from any of the four corners // We don't use an incremental MouseDelta but rather compute an absolute target size based on mouse position ImVec2 clamp_min = ImVec2(def.CornerPosN.x == 1.0f ? clamp_rect.Min.x : -FLT_MAX, (def.CornerPosN.y == 1.0f || (def.CornerPosN.y == 0.0f && window_move_from_title_bar)) ? clamp_rect.Min.y : -FLT_MAX); ImVec2 clamp_max = ImVec2(def.CornerPosN.x == 0.0f ? clamp_rect.Max.x : +FLT_MAX, def.CornerPosN.y == 0.0f ? clamp_rect.Max.y : +FLT_MAX); ImVec2 corner_target = g.IO.MousePos - g.ActiveIdClickOffset + ImLerp(def.InnerDir * grip_hover_outer_size, def.InnerDir * -grip_hover_inner_size, def.CornerPosN); // Corner of the window corresponding to our corner grip corner_target = ImClamp(corner_target, clamp_min, clamp_max); CalcResizePosSizeFromAnyCorner(window, corner_target, def.CornerPosN, &pos_target, &size_target); } // Only lower-left grip is visible before hovering/activating if (resize_grip_n == 0 || held || hovered) resize_grip_col[resize_grip_n] = GetColorU32(held ? ImGuiCol_ResizeGripActive : hovered ? ImGuiCol_ResizeGripHovered : ImGuiCol_ResizeGrip); } int resize_border_mask = 0x00; if (window->Flags & ImGuiWindowFlags_ChildWindow) resize_border_mask |= ((window->ChildFlags & ImGuiChildFlags_ResizeX) ? 0x02 : 0) | ((window->ChildFlags & ImGuiChildFlags_ResizeY) ? 0x08 : 0); else resize_border_mask = g.IO.ConfigWindowsResizeFromEdges ? 0x0F : 0x00; for (int border_n = 0; border_n < 4; border_n++) { if ((resize_border_mask & (1 << border_n)) == 0) continue; const ImGuiResizeBorderDef& def = resize_border_def[border_n]; const ImGuiAxis axis = (border_n == ImGuiDir_Left || border_n == ImGuiDir_Right) ? ImGuiAxis_X : ImGuiAxis_Y; bool hovered, held; ImRect border_rect = GetResizeBorderRect(window, border_n, grip_hover_inner_size, g.WindowsBorderHoverPadding); ImGuiID border_id = window->GetID(border_n + 4); // == GetWindowResizeBorderID() ItemAdd(border_rect, border_id, NULL, ImGuiItemFlags_NoNav); ButtonBehavior(border_rect, border_id, &hovered, &held, ImGuiButtonFlags_FlattenChildren | ImGuiButtonFlags_NoNavFocus); //GetForegroundDrawList(window)->AddRect(border_rect.Min, border_rect.Max, IM_COL32(255, 255, 0, 255)); if (hovered && g.HoveredIdTimer <= WINDOWS_RESIZE_FROM_EDGES_FEEDBACK_TIMER) hovered = false; if (hovered || held) SetMouseCursor((axis == ImGuiAxis_X) ? ImGuiMouseCursor_ResizeEW : ImGuiMouseCursor_ResizeNS); if (held && g.IO.MouseDoubleClicked[0]) { // Double-clicking bottom or right border auto-fit on this axis // FIXME: CalcWindowAutoFitSize() doesn't take into account that only one side may be auto-fit when calculating scrollbars. // FIXME: Support top and right borders: rework CalcResizePosSizeFromAnyCorner() to be reusable in both cases. if (border_n == 1 || border_n == 3) // Right and bottom border { size_target[axis] = CalcWindowSizeAfterConstraint(window, size_auto_fit)[axis]; ret_auto_fit_mask |= (1 << axis); hovered = held = false; // So border doesn't show highlighted at new position } ClearActiveID(); } else if (held) { // Switch to relative resizing mode when border geometry moved (e.g. resizing a child altering parent scroll), in order to avoid resizing feedback loop. // Currently only using relative mode on resizable child windows, as the problem to solve is more likely noticeable for them, but could apply for all windows eventually. // FIXME: May want to generalize this idiom at lower-level, so more widgets can use it! const bool just_scrolled_manually_while_resizing = (g.WheelingWindow != NULL && g.WheelingWindowScrolledFrame == g.FrameCount && IsWindowChildOf(window, g.WheelingWindow, false)); if (g.ActiveIdIsJustActivated || just_scrolled_manually_while_resizing) { g.WindowResizeBorderExpectedRect = border_rect; g.WindowResizeRelativeMode = false; } if ((window->Flags & ImGuiWindowFlags_ChildWindow) && memcmp(&g.WindowResizeBorderExpectedRect, &border_rect, sizeof(ImRect)) != 0) g.WindowResizeRelativeMode = true; const ImVec2 border_curr = (window->Pos + ImMin(def.SegmentN1, def.SegmentN2) * window->Size); const float border_target_rel_mode_for_axis = border_curr[axis] + g.IO.MouseDelta[axis]; const float border_target_abs_mode_for_axis = g.IO.MousePos[axis] - g.ActiveIdClickOffset[axis] + g.WindowsBorderHoverPadding; // Match ButtonBehavior() padding above. // Use absolute mode position ImVec2 border_target = window->Pos; border_target[axis] = border_target_abs_mode_for_axis; // Use relative mode target for child window, ignore resize when moving back toward the ideal absolute position. bool ignore_resize = false; if (g.WindowResizeRelativeMode) { //GetForegroundDrawList()->AddText(GetMainViewport()->WorkPos, IM_COL32_WHITE, "Relative Mode"); border_target[axis] = border_target_rel_mode_for_axis; if (g.IO.MouseDelta[axis] == 0.0f || (g.IO.MouseDelta[axis] > 0.0f) == (border_target_rel_mode_for_axis > border_target_abs_mode_for_axis)) ignore_resize = true; } // Clamp, apply ImVec2 clamp_min(border_n == ImGuiDir_Right ? clamp_rect.Min.x : -FLT_MAX, border_n == ImGuiDir_Down || (border_n == ImGuiDir_Up && window_move_from_title_bar) ? clamp_rect.Min.y : -FLT_MAX); ImVec2 clamp_max(border_n == ImGuiDir_Left ? clamp_rect.Max.x : +FLT_MAX, border_n == ImGuiDir_Up ? clamp_rect.Max.y : +FLT_MAX); border_target = ImClamp(border_target, clamp_min, clamp_max); if (flags & ImGuiWindowFlags_ChildWindow) // Clamp resizing of childs within parent { ImGuiWindow* parent_window = window->ParentWindow; ImGuiWindowFlags parent_flags = parent_window->Flags; ImRect border_limit_rect = parent_window->InnerRect; border_limit_rect.Expand(ImVec2(-ImMax(parent_window->WindowPadding.x, parent_window->WindowBorderSize), -ImMax(parent_window->WindowPadding.y, parent_window->WindowBorderSize))); if ((axis == ImGuiAxis_X) && ((parent_flags & (ImGuiWindowFlags_HorizontalScrollbar | ImGuiWindowFlags_AlwaysHorizontalScrollbar)) == 0 || (parent_flags & ImGuiWindowFlags_NoScrollbar))) border_target.x = ImClamp(border_target.x, border_limit_rect.Min.x, border_limit_rect.Max.x); if ((axis == ImGuiAxis_Y) && (parent_flags & ImGuiWindowFlags_NoScrollbar)) border_target.y = ImClamp(border_target.y, border_limit_rect.Min.y, border_limit_rect.Max.y); } if (!ignore_resize) CalcResizePosSizeFromAnyCorner(window, border_target, ImMin(def.SegmentN1, def.SegmentN2), &pos_target, &size_target); } if (hovered) *border_hovered = border_n; if (held) *border_held = border_n; } PopID(); // Restore nav layer window->DC.NavLayerCurrent = ImGuiNavLayer_Main; // Navigation resize (keyboard/gamepad) // FIXME: This cannot be moved to NavUpdateWindowing() because CalcWindowSizeAfterConstraint() need to callback into user. // Not even sure the callback works here. if (g.NavWindowingTarget && g.NavWindowingTarget->RootWindow == window) { ImVec2 nav_resize_dir; if (g.NavInputSource == ImGuiInputSource_Keyboard && g.IO.KeyShift) nav_resize_dir = GetKeyMagnitude2d(ImGuiKey_LeftArrow, ImGuiKey_RightArrow, ImGuiKey_UpArrow, ImGuiKey_DownArrow); if (g.NavInputSource == ImGuiInputSource_Gamepad) nav_resize_dir = GetKeyMagnitude2d(ImGuiKey_GamepadDpadLeft, ImGuiKey_GamepadDpadRight, ImGuiKey_GamepadDpadUp, ImGuiKey_GamepadDpadDown); if (nav_resize_dir.x != 0.0f || nav_resize_dir.y != 0.0f) { const float NAV_RESIZE_SPEED = 600.0f; const float resize_step = NAV_RESIZE_SPEED * g.IO.DeltaTime * ImMin(g.IO.DisplayFramebufferScale.x, g.IO.DisplayFramebufferScale.y); g.NavWindowingAccumDeltaSize += nav_resize_dir * resize_step; g.NavWindowingAccumDeltaSize = ImMax(g.NavWindowingAccumDeltaSize, clamp_rect.Min - window->Pos - window->Size); // We need Pos+Size >= clmap_rect.Min, so Size >= clmap_rect.Min - Pos, so size_delta >= clmap_rect.Min - window->Pos - window->Size g.NavWindowingToggleLayer = false; g.NavHighlightItemUnderNav = true; resize_grip_col[0] = GetColorU32(ImGuiCol_ResizeGripActive); ImVec2 accum_floored = ImTrunc(g.NavWindowingAccumDeltaSize); if (accum_floored.x != 0.0f || accum_floored.y != 0.0f) { // FIXME-NAV: Should store and accumulate into a separate size buffer to handle sizing constraints properly, right now a constraint will make us stuck. size_target = CalcWindowSizeAfterConstraint(window, window->SizeFull + accum_floored); g.NavWindowingAccumDeltaSize -= accum_floored; } } } // Apply back modified position/size to window const ImVec2 curr_pos = window->Pos; const ImVec2 curr_size = window->SizeFull; if (size_target.x != FLT_MAX && (window->Size.x != size_target.x || window->SizeFull.x != size_target.x)) window->Size.x = window->SizeFull.x = size_target.x; if (size_target.y != FLT_MAX && (window->Size.y != size_target.y || window->SizeFull.y != size_target.y)) window->Size.y = window->SizeFull.y = size_target.y; if (pos_target.x != FLT_MAX && window->Pos.x != ImTrunc(pos_target.x)) window->Pos.x = ImTrunc(pos_target.x); if (pos_target.y != FLT_MAX && window->Pos.y != ImTrunc(pos_target.y)) window->Pos.y = ImTrunc(pos_target.y); if (curr_pos.x != window->Pos.x || curr_pos.y != window->Pos.y || curr_size.x != window->SizeFull.x || curr_size.y != window->SizeFull.y) MarkIniSettingsDirty(window); // Recalculate next expected border expected coordinates if (*border_held != -1) g.WindowResizeBorderExpectedRect = GetResizeBorderRect(window, *border_held, grip_hover_inner_size, g.WindowsBorderHoverPadding); return ret_auto_fit_mask; } static inline void ClampWindowPos(ImGuiWindow* window, const ImRect& visibility_rect) { ImGuiContext& g = *GImGui; ImVec2 size_for_clamping = window->Size; if (g.IO.ConfigWindowsMoveFromTitleBarOnly && !(window->Flags & ImGuiWindowFlags_NoTitleBar)) size_for_clamping.y = window->TitleBarHeight; window->Pos = ImClamp(window->Pos, visibility_rect.Min - size_for_clamping, visibility_rect.Max); } static void RenderWindowOuterSingleBorder(ImGuiWindow* window, int border_n, ImU32 border_col, float border_size) { const ImGuiResizeBorderDef& def = resize_border_def[border_n]; const float rounding = window->WindowRounding; const ImRect border_r = GetResizeBorderRect(window, border_n, rounding, 0.0f); window->DrawList->PathArcTo(ImLerp(border_r.Min, border_r.Max, def.SegmentN1) + ImVec2(0.5f, 0.5f) + def.InnerDir * rounding, rounding, def.OuterAngle - IM_PI * 0.25f, def.OuterAngle); window->DrawList->PathArcTo(ImLerp(border_r.Min, border_r.Max, def.SegmentN2) + ImVec2(0.5f, 0.5f) + def.InnerDir * rounding, rounding, def.OuterAngle, def.OuterAngle + IM_PI * 0.25f); window->DrawList->PathStroke(border_col, ImDrawFlags_None, border_size); } static void ImGui::RenderWindowOuterBorders(ImGuiWindow* window) { ImGuiContext& g = *GImGui; const float border_size = window->WindowBorderSize; const ImU32 border_col = GetColorU32(ImGuiCol_Border); if (border_size > 0.0f && (window->Flags & ImGuiWindowFlags_NoBackground) == 0) window->DrawList->AddRect(window->Pos, window->Pos + window->Size, border_col, window->WindowRounding, 0, window->WindowBorderSize); else if (border_size > 0.0f) { if (window->ChildFlags & ImGuiChildFlags_ResizeX) // Similar code as 'resize_border_mask' computation in UpdateWindowManualResize() but we specifically only always draw explicit child resize border. RenderWindowOuterSingleBorder(window, 1, border_col, border_size); if (window->ChildFlags & ImGuiChildFlags_ResizeY) RenderWindowOuterSingleBorder(window, 3, border_col, border_size); } if (window->ResizeBorderHovered != -1 || window->ResizeBorderHeld != -1) { const int border_n = (window->ResizeBorderHeld != -1) ? window->ResizeBorderHeld : window->ResizeBorderHovered; const ImU32 border_col_resizing = GetColorU32((window->ResizeBorderHeld != -1) ? ImGuiCol_SeparatorActive : ImGuiCol_SeparatorHovered); RenderWindowOuterSingleBorder(window, border_n, border_col_resizing, ImMax(2.0f, window->WindowBorderSize)); // Thicker than usual } if (g.Style.FrameBorderSize > 0 && !(window->Flags & ImGuiWindowFlags_NoTitleBar)) { float y = window->Pos.y + window->TitleBarHeight - 1; window->DrawList->AddLine(ImVec2(window->Pos.x + border_size * 0.5f, y), ImVec2(window->Pos.x + window->Size.x - border_size * 0.5f, y), border_col, g.Style.FrameBorderSize); } } // Draw background and borders // Draw and handle scrollbars void ImGui::RenderWindowDecorations(ImGuiWindow* window, const ImRect& title_bar_rect, bool title_bar_is_highlight, bool handle_borders_and_resize_grips, int resize_grip_count, const ImU32 resize_grip_col[4], float resize_grip_draw_size) { ImGuiContext& g = *GImGui; ImGuiStyle& style = g.Style; ImGuiWindowFlags flags = window->Flags; // Ensure that Scrollbar() doesn't read last frame's SkipItems IM_ASSERT(window->BeginCount == 0); window->SkipItems = false; window->DC.NavLayerCurrent = ImGuiNavLayer_Menu; // Draw window + handle manual resize // As we highlight the title bar when want_focus is set, multiple reappearing windows will have their title bar highlighted on their reappearing frame. const float window_rounding = window->WindowRounding; const float window_border_size = window->WindowBorderSize; if (window->Collapsed) { // Title bar only const float backup_border_size = style.FrameBorderSize; g.Style.FrameBorderSize = window->WindowBorderSize; ImU32 title_bar_col = GetColorU32((title_bar_is_highlight && g.NavCursorVisible) ? ImGuiCol_TitleBgActive : ImGuiCol_TitleBgCollapsed); RenderFrame(title_bar_rect.Min, title_bar_rect.Max, title_bar_col, true, window_rounding); g.Style.FrameBorderSize = backup_border_size; } else { // Window background if (!(flags & ImGuiWindowFlags_NoBackground)) { ImU32 bg_col = GetColorU32(GetWindowBgColorIdx(window)); bool override_alpha = false; float alpha = 1.0f; if (g.NextWindowData.HasFlags & ImGuiNextWindowDataFlags_HasBgAlpha) { alpha = g.NextWindowData.BgAlphaVal; override_alpha = true; } if (override_alpha) bg_col = (bg_col & ~IM_COL32_A_MASK) | (IM_F32_TO_INT8_SAT(alpha) << IM_COL32_A_SHIFT); window->DrawList->AddRectFilled(window->Pos + ImVec2(0, window->TitleBarHeight), window->Pos + window->Size, bg_col, window_rounding, (flags & ImGuiWindowFlags_NoTitleBar) ? 0 : ImDrawFlags_RoundCornersBottom); } // Title bar if (!(flags & ImGuiWindowFlags_NoTitleBar)) { ImU32 title_bar_col = GetColorU32(title_bar_is_highlight ? ImGuiCol_TitleBgActive : ImGuiCol_TitleBg); window->DrawList->AddRectFilled(title_bar_rect.Min, title_bar_rect.Max, title_bar_col, window_rounding, ImDrawFlags_RoundCornersTop); } // Menu bar if (flags & ImGuiWindowFlags_MenuBar) { ImRect menu_bar_rect = window->MenuBarRect(); menu_bar_rect.ClipWith(window->Rect()); // Soft clipping, in particular child window don't have minimum size covering the menu bar so this is useful for them. window->DrawList->AddRectFilled(menu_bar_rect.Min, menu_bar_rect.Max, GetColorU32(ImGuiCol_MenuBarBg), (flags & ImGuiWindowFlags_NoTitleBar) ? window_rounding : 0.0f, ImDrawFlags_RoundCornersTop); if (style.FrameBorderSize > 0.0f && menu_bar_rect.Max.y < window->Pos.y + window->Size.y) window->DrawList->AddLine(menu_bar_rect.GetBL() + ImVec2(window_border_size * 0.5f, 0.0f), menu_bar_rect.GetBR() - ImVec2(window_border_size * 0.5f, 0.0f), GetColorU32(ImGuiCol_Border), style.FrameBorderSize); } // Scrollbars if (window->ScrollbarX) Scrollbar(ImGuiAxis_X); if (window->ScrollbarY) Scrollbar(ImGuiAxis_Y); // Render resize grips (after their input handling so we don't have a frame of latency) if (handle_borders_and_resize_grips && !(flags & ImGuiWindowFlags_NoResize)) { for (int resize_grip_n = 0; resize_grip_n < resize_grip_count; resize_grip_n++) { const ImU32 col = resize_grip_col[resize_grip_n]; if ((col & IM_COL32_A_MASK) == 0) continue; const ImGuiResizeGripDef& grip = resize_grip_def[resize_grip_n]; const ImVec2 corner = ImLerp(window->Pos, window->Pos + window->Size, grip.CornerPosN); const float border_inner = IM_ROUND(window_border_size * 0.5f); window->DrawList->PathLineTo(corner + grip.InnerDir * ((resize_grip_n & 1) ? ImVec2(border_inner, resize_grip_draw_size) : ImVec2(resize_grip_draw_size, border_inner))); window->DrawList->PathLineTo(corner + grip.InnerDir * ((resize_grip_n & 1) ? ImVec2(resize_grip_draw_size, border_inner) : ImVec2(border_inner, resize_grip_draw_size))); window->DrawList->PathArcToFast(ImVec2(corner.x + grip.InnerDir.x * (window_rounding + border_inner), corner.y + grip.InnerDir.y * (window_rounding + border_inner)), window_rounding, grip.AngleMin12, grip.AngleMax12); window->DrawList->PathFillConvex(col); } } // Borders if (handle_borders_and_resize_grips) RenderWindowOuterBorders(window); } window->DC.NavLayerCurrent = ImGuiNavLayer_Main; } // Render title text, collapse button, close button void ImGui::RenderWindowTitleBarContents(ImGuiWindow* window, const ImRect& title_bar_rect, const char* name, bool* p_open) { ImGuiContext& g = *GImGui; ImGuiStyle& style = g.Style; ImGuiWindowFlags flags = window->Flags; const bool has_close_button = (p_open != NULL); const bool has_collapse_button = !(flags & ImGuiWindowFlags_NoCollapse) && (style.WindowMenuButtonPosition != ImGuiDir_None); // Close & Collapse button are on the Menu NavLayer and don't default focus (unless there's nothing else on that layer) // FIXME-NAV: Might want (or not?) to set the equivalent of ImGuiButtonFlags_NoNavFocus so that mouse clicks on standard title bar items don't necessarily set nav/keyboard ref? const ImGuiItemFlags item_flags_backup = g.CurrentItemFlags; g.CurrentItemFlags |= ImGuiItemFlags_NoNavDefaultFocus; window->DC.NavLayerCurrent = ImGuiNavLayer_Menu; // Layout buttons // FIXME: Would be nice to generalize the subtleties expressed here into reusable code. float pad_l = style.FramePadding.x; float pad_r = style.FramePadding.x; float button_sz = g.FontSize; ImVec2 close_button_pos; ImVec2 collapse_button_pos; if (has_close_button) { close_button_pos = ImVec2(title_bar_rect.Max.x - pad_r - button_sz, title_bar_rect.Min.y + style.FramePadding.y); pad_r += button_sz + style.ItemInnerSpacing.x; } if (has_collapse_button && style.WindowMenuButtonPosition == ImGuiDir_Right) { collapse_button_pos = ImVec2(title_bar_rect.Max.x - pad_r - button_sz, title_bar_rect.Min.y + style.FramePadding.y); pad_r += button_sz + style.ItemInnerSpacing.x; } if (has_collapse_button && style.WindowMenuButtonPosition == ImGuiDir_Left) { collapse_button_pos = ImVec2(title_bar_rect.Min.x + pad_l, title_bar_rect.Min.y + style.FramePadding.y); pad_l += button_sz + style.ItemInnerSpacing.x; } // Collapse button (submitting first so it gets priority when choosing a navigation init fallback) if (has_collapse_button) if (CollapseButton(window->GetID("#COLLAPSE"), collapse_button_pos)) window->WantCollapseToggle = true; // Defer actual collapsing to next frame as we are too far in the Begin() function // Close button if (has_close_button) if (CloseButton(window->GetID("#CLOSE"), close_button_pos)) *p_open = false; window->DC.NavLayerCurrent = ImGuiNavLayer_Main; g.CurrentItemFlags = item_flags_backup; // Title bar text (with: horizontal alignment, avoiding collapse/close button, optional "unsaved document" marker) // FIXME: Refactor text alignment facilities along with RenderText helpers, this is WAY too much messy code.. const float marker_size_x = (flags & ImGuiWindowFlags_UnsavedDocument) ? button_sz * 0.80f : 0.0f; const ImVec2 text_size = CalcTextSize(name, NULL, true) + ImVec2(marker_size_x, 0.0f); // As a nice touch we try to ensure that centered title text doesn't get affected by visibility of Close/Collapse button, // while uncentered title text will still reach edges correctly. if (pad_l > style.FramePadding.x) pad_l += g.Style.ItemInnerSpacing.x; if (pad_r > style.FramePadding.x) pad_r += g.Style.ItemInnerSpacing.x; if (style.WindowTitleAlign.x > 0.0f && style.WindowTitleAlign.x < 1.0f) { float centerness = ImSaturate(1.0f - ImFabs(style.WindowTitleAlign.x - 0.5f) * 2.0f); // 0.0f on either edges, 1.0f on center float pad_extend = ImMin(ImMax(pad_l, pad_r), title_bar_rect.GetWidth() - pad_l - pad_r - text_size.x); pad_l = ImMax(pad_l, pad_extend * centerness); pad_r = ImMax(pad_r, pad_extend * centerness); } ImRect layout_r(title_bar_rect.Min.x + pad_l, title_bar_rect.Min.y, title_bar_rect.Max.x - pad_r, title_bar_rect.Max.y); ImRect clip_r(layout_r.Min.x, layout_r.Min.y, ImMin(layout_r.Max.x + g.Style.ItemInnerSpacing.x, title_bar_rect.Max.x), layout_r.Max.y); if (flags & ImGuiWindowFlags_UnsavedDocument) { ImVec2 marker_pos; marker_pos.x = ImClamp(layout_r.Min.x + (layout_r.GetWidth() - text_size.x) * style.WindowTitleAlign.x + text_size.x, layout_r.Min.x, layout_r.Max.x); marker_pos.y = (layout_r.Min.y + layout_r.Max.y) * 0.5f; if (marker_pos.x > layout_r.Min.x) { RenderBullet(window->DrawList, marker_pos, GetColorU32(ImGuiCol_Text)); clip_r.Max.x = ImMin(clip_r.Max.x, marker_pos.x - (int)(marker_size_x * 0.5f)); } } //if (g.IO.KeyShift) window->DrawList->AddRect(layout_r.Min, layout_r.Max, IM_COL32(255, 128, 0, 255)); // [DEBUG] //if (g.IO.KeyCtrl) window->DrawList->AddRect(clip_r.Min, clip_r.Max, IM_COL32(255, 128, 0, 255)); // [DEBUG] RenderTextClipped(layout_r.Min, layout_r.Max, name, NULL, &text_size, style.WindowTitleAlign, &clip_r); } void ImGui::UpdateWindowParentAndRootLinks(ImGuiWindow* window, ImGuiWindowFlags flags, ImGuiWindow* parent_window) { window->ParentWindow = parent_window; window->RootWindow = window->RootWindowPopupTree = window->RootWindowForTitleBarHighlight = window->RootWindowForNav = window; if (parent_window && (flags & ImGuiWindowFlags_ChildWindow) && !(flags & ImGuiWindowFlags_Tooltip)) window->RootWindow = parent_window->RootWindow; if (parent_window && (flags & ImGuiWindowFlags_Popup)) window->RootWindowPopupTree = parent_window->RootWindowPopupTree; if (parent_window && !(flags & ImGuiWindowFlags_Modal) && (flags & (ImGuiWindowFlags_ChildWindow | ImGuiWindowFlags_Popup))) window->RootWindowForTitleBarHighlight = parent_window->RootWindowForTitleBarHighlight; while (window->RootWindowForNav->ChildFlags & ImGuiChildFlags_NavFlattened) { IM_ASSERT(window->RootWindowForNav->ParentWindow != NULL); window->RootWindowForNav = window->RootWindowForNav->ParentWindow; } } // [EXPERIMENTAL] Called by Begin(). NextWindowData is valid at this point. // This is designed as a toy/test-bed for void ImGui::UpdateWindowSkipRefresh(ImGuiWindow* window) { ImGuiContext& g = *GImGui; window->SkipRefresh = false; if ((g.NextWindowData.HasFlags & ImGuiNextWindowDataFlags_HasRefreshPolicy) == 0) return; if (g.NextWindowData.RefreshFlagsVal & ImGuiWindowRefreshFlags_TryToAvoidRefresh) { // FIXME-IDLE: Tests for e.g. mouse clicks or keyboard while focused. if (window->Appearing) // If currently appearing return; if (window->Hidden) // If was hidden (previous frame) return; if ((g.NextWindowData.RefreshFlagsVal & ImGuiWindowRefreshFlags_RefreshOnHover) && g.HoveredWindow) if (window->RootWindow == g.HoveredWindow->RootWindow || IsWindowWithinBeginStackOf(g.HoveredWindow->RootWindow, window)) return; if ((g.NextWindowData.RefreshFlagsVal & ImGuiWindowRefreshFlags_RefreshOnFocus) && g.NavWindow) if (window->RootWindow == g.NavWindow->RootWindow || IsWindowWithinBeginStackOf(g.NavWindow->RootWindow, window)) return; window->DrawList = NULL; window->SkipRefresh = true; } } static void SetWindowActiveForSkipRefresh(ImGuiWindow* window) { window->Active = true; for (ImGuiWindow* child : window->DC.ChildWindows) if (!child->Hidden) { child->Active = child->SkipRefresh = true; SetWindowActiveForSkipRefresh(child); } } // Push a new Dear ImGui window to add widgets to. // - A default window called "Debug" is automatically stacked at the beginning of every frame so you can use widgets without explicitly calling a Begin/End pair. // - Begin/End can be called multiple times during the frame with the same window name to append content. // - The window name is used as a unique identifier to preserve window information across frames (and save rudimentary information to the .ini file). // You can use the "##" or "###" markers to use the same label with different id, or same id with different label. See documentation at the top of this file. // - Return false when window is collapsed, so you can early out in your code. You always need to call ImGui::End() even if false is returned. // - Passing 'bool* p_open' displays a Close button on the upper-right corner of the window, the pointed value will be set to false when the button is pressed. bool ImGui::Begin(const char* name, bool* p_open, ImGuiWindowFlags flags) { ImGuiContext& g = *GImGui; const ImGuiStyle& style = g.Style; IM_ASSERT(name != NULL && name[0] != '\0'); // Window name required IM_ASSERT(g.WithinFrameScope); // Forgot to call ImGui::NewFrame() IM_ASSERT(g.FrameCountEnded != g.FrameCount); // Called ImGui::Render() or ImGui::EndFrame() and haven't called ImGui::NewFrame() again yet // Find or create ImGuiWindow* window = FindWindowByName(name); const bool window_just_created = (window == NULL); if (window_just_created) window = CreateNewWindow(name, flags); // [DEBUG] Debug break requested by user if (g.DebugBreakInWindow == window->ID) IM_DEBUG_BREAK(); // Automatically disable manual moving/resizing when NoInputs is set if ((flags & ImGuiWindowFlags_NoInputs) == ImGuiWindowFlags_NoInputs) flags |= ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoResize; const int current_frame = g.FrameCount; const bool first_begin_of_the_frame = (window->LastFrameActive != current_frame); window->IsFallbackWindow = (g.CurrentWindowStack.Size == 0 && g.WithinFrameScopeWithImplicitWindow); // Update the Appearing flag bool window_just_activated_by_user = (window->LastFrameActive < current_frame - 1); // Not using !WasActive because the implicit "Debug" window would always toggle off->on if (flags & ImGuiWindowFlags_Popup) { ImGuiPopupData& popup_ref = g.OpenPopupStack[g.BeginPopupStack.Size]; window_just_activated_by_user |= (window->PopupId != popup_ref.PopupId); // We recycle popups so treat window as activated if popup id changed window_just_activated_by_user |= (window != popup_ref.Window); } window->Appearing = window_just_activated_by_user; if (window->Appearing) SetWindowConditionAllowFlags(window, ImGuiCond_Appearing, true); // Update Flags, LastFrameActive, BeginOrderXXX fields if (first_begin_of_the_frame) { UpdateWindowInFocusOrderList(window, window_just_created, flags); window->Flags = (ImGuiWindowFlags)flags; window->ChildFlags = (g.NextWindowData.HasFlags & ImGuiNextWindowDataFlags_HasChildFlags) ? g.NextWindowData.ChildFlags : 0; window->LastFrameActive = current_frame; window->LastTimeActive = (float)g.Time; window->BeginOrderWithinParent = 0; window->BeginOrderWithinContext = (short)(g.WindowsActiveCount++); } else { flags = window->Flags; } // Parent window is latched only on the first call to Begin() of the frame, so further append-calls can be done from a different window stack ImGuiWindow* parent_window_in_stack = g.CurrentWindowStack.empty() ? NULL : g.CurrentWindowStack.back().Window; ImGuiWindow* parent_window = first_begin_of_the_frame ? ((flags & (ImGuiWindowFlags_ChildWindow | ImGuiWindowFlags_Popup)) ? parent_window_in_stack : NULL) : window->ParentWindow; IM_ASSERT(parent_window != NULL || !(flags & ImGuiWindowFlags_ChildWindow)); // We allow window memory to be compacted so recreate the base stack when needed. if (window->IDStack.Size == 0) window->IDStack.push_back(window->ID); // Add to stack g.CurrentWindow = window; g.CurrentWindowStack.resize(g.CurrentWindowStack.Size + 1); ImGuiWindowStackData& window_stack_data = g.CurrentWindowStack.back(); window_stack_data.Window = window; window_stack_data.ParentLastItemDataBackup = g.LastItemData; window_stack_data.DisabledOverrideReenable = (flags & ImGuiWindowFlags_Tooltip) && (g.CurrentItemFlags & ImGuiItemFlags_Disabled); window_stack_data.DisabledOverrideReenableAlphaBackup = 0.0f; ErrorRecoveryStoreState(&window_stack_data.StackSizesInBegin); g.StackSizesInBeginForCurrentWindow = &window_stack_data.StackSizesInBegin; if (flags & ImGuiWindowFlags_ChildMenu) g.BeginMenuDepth++; // Update ->RootWindow and others pointers (before any possible call to FocusWindow) if (first_begin_of_the_frame) { UpdateWindowParentAndRootLinks(window, flags, parent_window); window->ParentWindowInBeginStack = parent_window_in_stack; // There's little point to expose a flag to set this: because the interesting cases won't be using parent_window_in_stack, // e.g. linking a tool window in a standalone viewport to a document window, regardless of their Begin() stack parenting. (#6798) window->ParentWindowForFocusRoute = (flags & ImGuiWindowFlags_ChildWindow) ? parent_window_in_stack : NULL; // Inherent SetWindowFontScale() from parent until we fix this system... window->FontWindowScaleParents = parent_window ? parent_window->FontWindowScaleParents * parent_window->FontWindowScale : 1.0f; } // Add to focus scope stack PushFocusScope((window->ChildFlags & ImGuiChildFlags_NavFlattened) ? g.CurrentFocusScopeId : window->ID); window->NavRootFocusScopeId = g.CurrentFocusScopeId; // Add to popup stacks: update OpenPopupStack[] data, push to BeginPopupStack[] if (flags & ImGuiWindowFlags_Popup) { ImGuiPopupData& popup_ref = g.OpenPopupStack[g.BeginPopupStack.Size]; popup_ref.Window = window; popup_ref.ParentNavLayer = parent_window_in_stack->DC.NavLayerCurrent; g.BeginPopupStack.push_back(popup_ref); window->PopupId = popup_ref.PopupId; } // Process SetNextWindow***() calls // (FIXME: Consider splitting the HasXXX flags into X/Y components bool window_pos_set_by_api = false; bool window_size_x_set_by_api = false, window_size_y_set_by_api = false; if (g.NextWindowData.HasFlags & ImGuiNextWindowDataFlags_HasPos) { window_pos_set_by_api = (window->SetWindowPosAllowFlags & g.NextWindowData.PosCond) != 0; if (window_pos_set_by_api && ImLengthSqr(g.NextWindowData.PosPivotVal) > 0.00001f) { // May be processed on the next frame if this is our first frame and we are measuring size // FIXME: Look into removing the branch so everything can go through this same code path for consistency. window->SetWindowPosVal = g.NextWindowData.PosVal; window->SetWindowPosPivot = g.NextWindowData.PosPivotVal; window->SetWindowPosAllowFlags &= ~(ImGuiCond_Once | ImGuiCond_FirstUseEver | ImGuiCond_Appearing); } else { SetWindowPos(window, g.NextWindowData.PosVal, g.NextWindowData.PosCond); } } if (g.NextWindowData.HasFlags & ImGuiNextWindowDataFlags_HasSize) { window_size_x_set_by_api = (window->SetWindowSizeAllowFlags & g.NextWindowData.SizeCond) != 0 && (g.NextWindowData.SizeVal.x > 0.0f); window_size_y_set_by_api = (window->SetWindowSizeAllowFlags & g.NextWindowData.SizeCond) != 0 && (g.NextWindowData.SizeVal.y > 0.0f); if ((window->ChildFlags & ImGuiChildFlags_ResizeX) && (window->SetWindowSizeAllowFlags & ImGuiCond_FirstUseEver) == 0) // Axis-specific conditions for BeginChild() g.NextWindowData.SizeVal.x = window->SizeFull.x; if ((window->ChildFlags & ImGuiChildFlags_ResizeY) && (window->SetWindowSizeAllowFlags & ImGuiCond_FirstUseEver) == 0) g.NextWindowData.SizeVal.y = window->SizeFull.y; SetWindowSize(window, g.NextWindowData.SizeVal, g.NextWindowData.SizeCond); } if (g.NextWindowData.HasFlags & ImGuiNextWindowDataFlags_HasScroll) { if (g.NextWindowData.ScrollVal.x >= 0.0f) { window->ScrollTarget.x = g.NextWindowData.ScrollVal.x; window->ScrollTargetCenterRatio.x = 0.0f; } if (g.NextWindowData.ScrollVal.y >= 0.0f) { window->ScrollTarget.y = g.NextWindowData.ScrollVal.y; window->ScrollTargetCenterRatio.y = 0.0f; } } if (g.NextWindowData.HasFlags & ImGuiNextWindowDataFlags_HasContentSize) window->ContentSizeExplicit = g.NextWindowData.ContentSizeVal; else if (first_begin_of_the_frame) window->ContentSizeExplicit = ImVec2(0.0f, 0.0f); if (g.NextWindowData.HasFlags & ImGuiNextWindowDataFlags_HasCollapsed) SetWindowCollapsed(window, g.NextWindowData.CollapsedVal, g.NextWindowData.CollapsedCond); if (g.NextWindowData.HasFlags & ImGuiNextWindowDataFlags_HasFocus) FocusWindow(window); if (window->Appearing) SetWindowConditionAllowFlags(window, ImGuiCond_Appearing, false); // [EXPERIMENTAL] Skip Refresh mode UpdateWindowSkipRefresh(window); // Nested root windows (typically tooltips) override disabled state if (window_stack_data.DisabledOverrideReenable && window->RootWindow == window) BeginDisabledOverrideReenable(); // We intentionally set g.CurrentWindow to NULL to prevent usage until when the viewport is set, then will call SetCurrentWindow() g.CurrentWindow = NULL; // When reusing window again multiple times a frame, just append content (don't need to setup again) if (first_begin_of_the_frame && !window->SkipRefresh) { // Initialize const bool window_is_child_tooltip = (flags & ImGuiWindowFlags_ChildWindow) && (flags & ImGuiWindowFlags_Tooltip); // FIXME-WIP: Undocumented behavior of Child+Tooltip for pinned tooltip (#1345) const bool window_just_appearing_after_hidden_for_resize = (window->HiddenFramesCannotSkipItems > 0); window->Active = true; window->HasCloseButton = (p_open != NULL); window->ClipRect = ImVec4(-FLT_MAX, -FLT_MAX, +FLT_MAX, +FLT_MAX); window->IDStack.resize(1); window->DrawList->_ResetForNewFrame(); window->DC.CurrentTableIdx = -1; // Restore buffer capacity when woken from a compacted state, to avoid if (window->MemoryCompacted) GcAwakeTransientWindowBuffers(window); // Update stored window name when it changes (which can _only_ happen with the "###" operator, so the ID would stay unchanged). // The title bar always display the 'name' parameter, so we only update the string storage if it needs to be visible to the end-user elsewhere. bool window_title_visible_elsewhere = false; if (g.NavWindowingListWindow != NULL && (flags & ImGuiWindowFlags_NoNavFocus) == 0) // Window titles visible when using CTRL+TAB window_title_visible_elsewhere = true; if (flags & ImGuiWindowFlags_ChildMenu) window_title_visible_elsewhere = true; if (window_title_visible_elsewhere && !window_just_created && strcmp(name, window->Name) != 0) { size_t buf_len = (size_t)window->NameBufLen; window->Name = ImStrdupcpy(window->Name, &buf_len, name); window->NameBufLen = (int)buf_len; } // UPDATE CONTENTS SIZE, UPDATE HIDDEN STATUS // Update contents size from last frame for auto-fitting (or use explicit size) CalcWindowContentSizes(window, &window->ContentSize, &window->ContentSizeIdeal); if (window->HiddenFramesCanSkipItems > 0) window->HiddenFramesCanSkipItems--; if (window->HiddenFramesCannotSkipItems > 0) window->HiddenFramesCannotSkipItems--; if (window->HiddenFramesForRenderOnly > 0) window->HiddenFramesForRenderOnly--; // Hide new windows for one frame until they calculate their size if (window_just_created && (!window_size_x_set_by_api || !window_size_y_set_by_api)) window->HiddenFramesCannotSkipItems = 1; // Hide popup/tooltip window when re-opening while we measure size (because we recycle the windows) // We reset Size/ContentSize for reappearing popups/tooltips early in this function, so further code won't be tempted to use the old size. if (window_just_activated_by_user && (flags & (ImGuiWindowFlags_Popup | ImGuiWindowFlags_Tooltip)) != 0) { window->HiddenFramesCannotSkipItems = 1; if (flags & ImGuiWindowFlags_AlwaysAutoResize) { if (!window_size_x_set_by_api) window->Size.x = window->SizeFull.x = 0.f; if (!window_size_y_set_by_api) window->Size.y = window->SizeFull.y = 0.f; window->ContentSize = window->ContentSizeIdeal = ImVec2(0.f, 0.f); } } // SELECT VIEWPORT // FIXME-VIEWPORT: In the docking/viewport branch, this is the point where we select the current viewport (which may affect the style) ImGuiViewportP* viewport = (ImGuiViewportP*)(void*)GetMainViewport(); SetWindowViewport(window, viewport); SetCurrentWindow(window); // LOCK BORDER SIZE AND PADDING FOR THE FRAME (so that altering them doesn't cause inconsistencies) if (flags & ImGuiWindowFlags_ChildWindow) window->WindowBorderSize = style.ChildBorderSize; else window->WindowBorderSize = ((flags & (ImGuiWindowFlags_Popup | ImGuiWindowFlags_Tooltip)) && !(flags & ImGuiWindowFlags_Modal)) ? style.PopupBorderSize : style.WindowBorderSize; window->WindowPadding = style.WindowPadding; if ((flags & ImGuiWindowFlags_ChildWindow) && !(flags & ImGuiWindowFlags_Popup) && !(window->ChildFlags & ImGuiChildFlags_AlwaysUseWindowPadding) && window->WindowBorderSize == 0.0f) window->WindowPadding = ImVec2(0.0f, (flags & ImGuiWindowFlags_MenuBar) ? style.WindowPadding.y : 0.0f); // Lock menu offset so size calculation can use it as menu-bar windows need a minimum size. window->DC.MenuBarOffset.x = ImMax(ImMax(window->WindowPadding.x, style.ItemSpacing.x), g.NextWindowData.MenuBarOffsetMinVal.x); window->DC.MenuBarOffset.y = g.NextWindowData.MenuBarOffsetMinVal.y; window->TitleBarHeight = (flags & ImGuiWindowFlags_NoTitleBar) ? 0.0f : g.FontSize + g.Style.FramePadding.y * 2.0f; window->MenuBarHeight = (flags & ImGuiWindowFlags_MenuBar) ? window->DC.MenuBarOffset.y + g.FontSize + g.Style.FramePadding.y * 2.0f : 0.0f; window->FontRefSize = g.FontSize; // Lock this to discourage calling window->CalcFontSize() outside of current window. // Depending on condition we use previous or current window size to compare against contents size to decide if a scrollbar should be visible. // Those flags will be altered further down in the function depending on more conditions. bool use_current_size_for_scrollbar_x = window_just_created; bool use_current_size_for_scrollbar_y = window_just_created; if (window_size_x_set_by_api && window->ContentSizeExplicit.x != 0.0f) use_current_size_for_scrollbar_x = true; if (window_size_y_set_by_api && window->ContentSizeExplicit.y != 0.0f) // #7252 use_current_size_for_scrollbar_y = true; // Collapse window by double-clicking on title bar // At this point we don't have a clipping rectangle setup yet, so we can use the title bar area for hit detection and drawing if (!(flags & ImGuiWindowFlags_NoTitleBar) && !(flags & ImGuiWindowFlags_NoCollapse)) { // We don't use a regular button+id to test for double-click on title bar (mostly due to legacy reason, could be fixed), // so verify that we don't have items over the title bar. ImRect title_bar_rect = window->TitleBarRect(); if (g.HoveredWindow == window && g.HoveredId == 0 && g.HoveredIdPreviousFrame == 0 && g.ActiveId == 0 && IsMouseHoveringRect(title_bar_rect.Min, title_bar_rect.Max)) if (g.IO.MouseClickedCount[0] == 2 && GetKeyOwner(ImGuiKey_MouseLeft) == ImGuiKeyOwner_NoOwner) window->WantCollapseToggle = true; if (window->WantCollapseToggle) { window->Collapsed = !window->Collapsed; if (!window->Collapsed) use_current_size_for_scrollbar_y = true; MarkIniSettingsDirty(window); } } else { window->Collapsed = false; } window->WantCollapseToggle = false; // SIZE // Outer Decoration Sizes // (we need to clear ScrollbarSize immediately as CalcWindowAutoFitSize() needs it and can be called from other locations). const ImVec2 scrollbar_sizes_from_last_frame = window->ScrollbarSizes; window->DecoOuterSizeX1 = 0.0f; window->DecoOuterSizeX2 = 0.0f; window->DecoOuterSizeY1 = window->TitleBarHeight + window->MenuBarHeight; window->DecoOuterSizeY2 = 0.0f; window->ScrollbarSizes = ImVec2(0.0f, 0.0f); // Calculate auto-fit size, handle automatic resize const ImVec2 size_auto_fit = CalcWindowAutoFitSize(window, window->ContentSizeIdeal); if ((flags & ImGuiWindowFlags_AlwaysAutoResize) && !window->Collapsed) { // Using SetNextWindowSize() overrides ImGuiWindowFlags_AlwaysAutoResize, so it can be used on tooltips/popups, etc. if (!window_size_x_set_by_api) { window->SizeFull.x = size_auto_fit.x; use_current_size_for_scrollbar_x = true; } if (!window_size_y_set_by_api) { window->SizeFull.y = size_auto_fit.y; use_current_size_for_scrollbar_y = true; } } else if (window->AutoFitFramesX > 0 || window->AutoFitFramesY > 0) { // Auto-fit may only grow window during the first few frames // We still process initial auto-fit on collapsed windows to get a window width, but otherwise don't honor ImGuiWindowFlags_AlwaysAutoResize when collapsed. if (!window_size_x_set_by_api && window->AutoFitFramesX > 0) { window->SizeFull.x = window->AutoFitOnlyGrows ? ImMax(window->SizeFull.x, size_auto_fit.x) : size_auto_fit.x; use_current_size_for_scrollbar_x = true; } if (!window_size_y_set_by_api && window->AutoFitFramesY > 0) { window->SizeFull.y = window->AutoFitOnlyGrows ? ImMax(window->SizeFull.y, size_auto_fit.y) : size_auto_fit.y; use_current_size_for_scrollbar_y = true; } if (!window->Collapsed) MarkIniSettingsDirty(window); } // Apply minimum/maximum window size constraints and final size window->SizeFull = CalcWindowSizeAfterConstraint(window, window->SizeFull); window->Size = window->Collapsed && !(flags & ImGuiWindowFlags_ChildWindow) ? window->TitleBarRect().GetSize() : window->SizeFull; // POSITION // Popup latch its initial position, will position itself when it appears next frame if (window_just_activated_by_user) { window->AutoPosLastDirection = ImGuiDir_None; if ((flags & ImGuiWindowFlags_Popup) != 0 && !(flags & ImGuiWindowFlags_Modal) && !window_pos_set_by_api) // FIXME: BeginPopup() could use SetNextWindowPos() window->Pos = g.BeginPopupStack.back().OpenPopupPos; } // Position child window if (flags & ImGuiWindowFlags_ChildWindow) { IM_ASSERT(parent_window && parent_window->Active); window->BeginOrderWithinParent = (short)parent_window->DC.ChildWindows.Size; parent_window->DC.ChildWindows.push_back(window); if (!(flags & ImGuiWindowFlags_Popup) && !window_pos_set_by_api && !window_is_child_tooltip) window->Pos = parent_window->DC.CursorPos; } const bool window_pos_with_pivot = (window->SetWindowPosVal.x != FLT_MAX && window->HiddenFramesCannotSkipItems == 0); if (window_pos_with_pivot) SetWindowPos(window, window->SetWindowPosVal - window->Size * window->SetWindowPosPivot, 0); // Position given a pivot (e.g. for centering) else if ((flags & ImGuiWindowFlags_ChildMenu) != 0) window->Pos = FindBestWindowPosForPopup(window); else if ((flags & ImGuiWindowFlags_Popup) != 0 && !window_pos_set_by_api && window_just_appearing_after_hidden_for_resize) window->Pos = FindBestWindowPosForPopup(window); else if ((flags & ImGuiWindowFlags_Tooltip) != 0 && !window_pos_set_by_api && !window_is_child_tooltip) window->Pos = FindBestWindowPosForPopup(window); // Calculate the range of allowed position for that window (to be movable and visible past safe area padding) // When clamping to stay visible, we will enforce that window->Pos stays inside of visibility_rect. ImRect viewport_rect(viewport->GetMainRect()); ImRect viewport_work_rect(viewport->GetWorkRect()); ImVec2 visibility_padding = ImMax(style.DisplayWindowPadding, style.DisplaySafeAreaPadding); ImRect visibility_rect(viewport_work_rect.Min + visibility_padding, viewport_work_rect.Max - visibility_padding); // Clamp position/size so window stays visible within its viewport or monitor // Ignore zero-sized display explicitly to avoid losing positions if a window manager reports zero-sized window when initializing or minimizing. if (!window_pos_set_by_api && !(flags & ImGuiWindowFlags_ChildWindow)) if (viewport_rect.GetWidth() > 0.0f && viewport_rect.GetHeight() > 0.0f) ClampWindowPos(window, visibility_rect); window->Pos = ImTrunc(window->Pos); // Lock window rounding for the frame (so that altering them doesn't cause inconsistencies) // Large values tend to lead to variety of artifacts and are not recommended. window->WindowRounding = (flags & ImGuiWindowFlags_ChildWindow) ? style.ChildRounding : ((flags & ImGuiWindowFlags_Popup) && !(flags & ImGuiWindowFlags_Modal)) ? style.PopupRounding : style.WindowRounding; // For windows with title bar or menu bar, we clamp to FrameHeight(FontSize + FramePadding.y * 2.0f) to completely hide artifacts. //if ((window->Flags & ImGuiWindowFlags_MenuBar) || !(window->Flags & ImGuiWindowFlags_NoTitleBar)) // window->WindowRounding = ImMin(window->WindowRounding, g.FontSize + style.FramePadding.y * 2.0f); // Apply window focus (new and reactivated windows are moved to front) bool want_focus = false; if (window_just_activated_by_user && !(flags & ImGuiWindowFlags_NoFocusOnAppearing)) { if (flags & ImGuiWindowFlags_Popup) want_focus = true; else if ((flags & (ImGuiWindowFlags_ChildWindow | ImGuiWindowFlags_Tooltip)) == 0) want_focus = true; } // [Test Engine] Register whole window in the item system (before submitting further decorations) #ifdef IMGUI_ENABLE_TEST_ENGINE if (g.TestEngineHookItems) { IM_ASSERT(window->IDStack.Size == 1); window->IDStack.Size = 0; // As window->IDStack[0] == window->ID here, make sure TestEngine doesn't erroneously see window as parent of itself. window->DC.NavLayerCurrent = ImGuiNavLayer_Menu; IMGUI_TEST_ENGINE_ITEM_ADD(window->ID, window->Rect(), NULL); IMGUI_TEST_ENGINE_ITEM_INFO(window->ID, window->Name, (g.HoveredWindow == window) ? ImGuiItemStatusFlags_HoveredRect : 0); window->IDStack.Size = 1; window->DC.NavLayerCurrent = ImGuiNavLayer_Main; } #endif // Handle manual resize: Resize Grips, Borders, Gamepad int border_hovered = -1, border_held = -1; ImU32 resize_grip_col[4] = {}; const int resize_grip_count = ((flags & ImGuiWindowFlags_ChildWindow) && !(flags & ImGuiWindowFlags_Popup)) ? 0 : g.IO.ConfigWindowsResizeFromEdges ? 2 : 1; // Allow resize from lower-left if we have the mouse cursor feedback for it. const float resize_grip_draw_size = IM_TRUNC(ImMax(g.FontSize * 1.10f, window->WindowRounding + 1.0f + g.FontSize * 0.2f)); if (!window->Collapsed) if (int auto_fit_mask = UpdateWindowManualResize(window, size_auto_fit, &border_hovered, &border_held, resize_grip_count, &resize_grip_col[0], visibility_rect)) { if (auto_fit_mask & (1 << ImGuiAxis_X)) use_current_size_for_scrollbar_x = true; if (auto_fit_mask & (1 << ImGuiAxis_Y)) use_current_size_for_scrollbar_y = true; } window->ResizeBorderHovered = (signed char)border_hovered; window->ResizeBorderHeld = (signed char)border_held; // SCROLLBAR VISIBILITY // Update scrollbar visibility (based on the Size that was effective during last frame or the auto-resized Size). if (!window->Collapsed) { // When reading the current size we need to read it after size constraints have been applied. // Intentionally use previous frame values for InnerRect and ScrollbarSizes. // And when we use window->DecorationUp here it doesn't have ScrollbarSizes.y applied yet. ImVec2 avail_size_from_current_frame = ImVec2(window->SizeFull.x, window->SizeFull.y - (window->DecoOuterSizeY1 + window->DecoOuterSizeY2)); ImVec2 avail_size_from_last_frame = window->InnerRect.GetSize() + scrollbar_sizes_from_last_frame; ImVec2 needed_size_from_last_frame = window_just_created ? ImVec2(0, 0) : window->ContentSize + window->WindowPadding * 2.0f; float size_x_for_scrollbars = use_current_size_for_scrollbar_x ? avail_size_from_current_frame.x : avail_size_from_last_frame.x; float size_y_for_scrollbars = use_current_size_for_scrollbar_y ? avail_size_from_current_frame.y : avail_size_from_last_frame.y; bool scrollbar_x_prev = window->ScrollbarX; //bool scrollbar_y_from_last_frame = window->ScrollbarY; // FIXME: May want to use that in the ScrollbarX expression? How many pros vs cons? window->ScrollbarY = (flags & ImGuiWindowFlags_AlwaysVerticalScrollbar) || ((needed_size_from_last_frame.y > size_y_for_scrollbars) && !(flags & ImGuiWindowFlags_NoScrollbar)); window->ScrollbarX = (flags & ImGuiWindowFlags_AlwaysHorizontalScrollbar) || ((needed_size_from_last_frame.x > size_x_for_scrollbars - (window->ScrollbarY ? style.ScrollbarSize : 0.0f)) && !(flags & ImGuiWindowFlags_NoScrollbar) && (flags & ImGuiWindowFlags_HorizontalScrollbar)); // Track when ScrollbarX visibility keeps toggling, which is a sign of a feedback loop, and stabilize by enforcing visibility (#3285, #8488) // (Feedback loops of this sort can manifest in various situations, but combining horizontal + vertical scrollbar + using a clipper with varying width items is one frequent cause. // The better solution is to, either (1) enforce visibility by using ImGuiWindowFlags_AlwaysHorizontalScrollbar or (2) declare stable contents width with SetNextWindowContentSize(), if you can compute it) window->ScrollbarXStabilizeToggledHistory <<= 1; window->ScrollbarXStabilizeToggledHistory |= (scrollbar_x_prev != window->ScrollbarX) ? 0x01 : 0x00; const bool scrollbar_x_stabilize = (window->ScrollbarXStabilizeToggledHistory != 0) && ImCountSetBits(window->ScrollbarXStabilizeToggledHistory) >= 4; // 4 == half of bits in our U8 history. if (scrollbar_x_stabilize) window->ScrollbarX = true; //if (scrollbar_x_stabilize && !window->ScrollbarXStabilizeEnabled) // IMGUI_DEBUG_LOG("[scroll] Stabilize ScrollbarX for Window '%s'\n", window->Name); window->ScrollbarXStabilizeEnabled = scrollbar_x_stabilize; if (window->ScrollbarX && !window->ScrollbarY) window->ScrollbarY = (needed_size_from_last_frame.y > size_y_for_scrollbars - style.ScrollbarSize) && !(flags & ImGuiWindowFlags_NoScrollbar); window->ScrollbarSizes = ImVec2(window->ScrollbarY ? style.ScrollbarSize : 0.0f, window->ScrollbarX ? style.ScrollbarSize : 0.0f); // Amend the partially filled window->DecorationXXX values. window->DecoOuterSizeX2 += window->ScrollbarSizes.x; window->DecoOuterSizeY2 += window->ScrollbarSizes.y; } // UPDATE RECTANGLES (1- THOSE NOT AFFECTED BY SCROLLING) // Update various regions. Variables they depend on should be set above in this function. // We set this up after processing the resize grip so that our rectangles doesn't lag by a frame. // Outer rectangle // Not affected by window border size. Used by: // - FindHoveredWindow() (w/ extra padding when border resize is enabled) // - Begin() initial clipping rect for drawing window background and borders. // - Begin() clipping whole child const ImRect host_rect = ((flags & ImGuiWindowFlags_ChildWindow) && !(flags & ImGuiWindowFlags_Popup) && !window_is_child_tooltip) ? parent_window->ClipRect : viewport_rect; const ImRect outer_rect = window->Rect(); const ImRect title_bar_rect = window->TitleBarRect(); window->OuterRectClipped = outer_rect; window->OuterRectClipped.ClipWith(host_rect); // Inner rectangle // Not affected by window border size. Used by: // - InnerClipRect // - ScrollToRectEx() // - NavUpdatePageUpPageDown() // - Scrollbar() window->InnerRect.Min.x = window->Pos.x + window->DecoOuterSizeX1; window->InnerRect.Min.y = window->Pos.y + window->DecoOuterSizeY1; window->InnerRect.Max.x = window->Pos.x + window->Size.x - window->DecoOuterSizeX2; window->InnerRect.Max.y = window->Pos.y + window->Size.y - window->DecoOuterSizeY2; // Inner clipping rectangle. // - Extend a outside of normal work region up to borders. // - This is to allow e.g. Selectable or CollapsingHeader or some separators to cover that space. // - It also makes clipped items be more noticeable. // - And is consistent on both axis (prior to 2024/05/03 ClipRect used WindowPadding.x * 0.5f on left and right edge), see #3312 // - Force round operator last to ensure that e.g. (int)(max.x-min.x) in user's render code produce correct result. // Note that if our window is collapsed we will end up with an inverted (~null) clipping rectangle which is the correct behavior. // Affected by window/frame border size. Used by: // - Begin() initial clip rect float top_border_size = (((flags & ImGuiWindowFlags_MenuBar) || !(flags & ImGuiWindowFlags_NoTitleBar)) ? style.FrameBorderSize : window->WindowBorderSize); // Try to match the fact that our border is drawn centered over the window rectangle, rather than inner. // This is why we do a *0.5f here. We don't currently even technically support large values for WindowBorderSize, // see e.g #7887 #7888, but may do after we move the window border to become an inner border (and then we can remove the 0.5f here). window->InnerClipRect.Min.x = ImFloor(0.5f + window->InnerRect.Min.x + window->WindowBorderSize * 0.5f); window->InnerClipRect.Min.y = ImFloor(0.5f + window->InnerRect.Min.y + top_border_size * 0.5f); window->InnerClipRect.Max.x = ImFloor(window->InnerRect.Max.x - window->WindowBorderSize * 0.5f); window->InnerClipRect.Max.y = ImFloor(window->InnerRect.Max.y - window->WindowBorderSize * 0.5f); window->InnerClipRect.ClipWithFull(host_rect); // Default item width. Make it proportional to window size if window manually resizes if (window->Size.x > 0.0f && !(flags & ImGuiWindowFlags_Tooltip) && !(flags & ImGuiWindowFlags_AlwaysAutoResize)) window->ItemWidthDefault = ImTrunc(window->Size.x * 0.65f); else window->ItemWidthDefault = ImTrunc(g.FontSize * 16.0f); // SCROLLING // Lock down maximum scrolling // The value of ScrollMax are ahead from ScrollbarX/ScrollbarY which is intentionally using InnerRect from previous rect in order to accommodate // for right/bottom aligned items without creating a scrollbar. window->ScrollMax.x = ImMax(0.0f, window->ContentSize.x + window->WindowPadding.x * 2.0f - window->InnerRect.GetWidth()); window->ScrollMax.y = ImMax(0.0f, window->ContentSize.y + window->WindowPadding.y * 2.0f - window->InnerRect.GetHeight()); // Apply scrolling window->Scroll = CalcNextScrollFromScrollTargetAndClamp(window); window->ScrollTarget = ImVec2(FLT_MAX, FLT_MAX); window->DecoInnerSizeX1 = window->DecoInnerSizeY1 = 0.0f; // DRAWING // Setup draw list and outer clipping rectangle IM_ASSERT(window->DrawList->CmdBuffer.Size == 1 && window->DrawList->CmdBuffer[0].ElemCount == 0); window->DrawList->PushTextureID(g.Font->ContainerAtlas->TexID); PushClipRect(host_rect.Min, host_rect.Max, false); // Child windows can render their decoration (bg color, border, scrollbars, etc.) within their parent to save a draw call (since 1.71) // When using overlapping child windows, this will break the assumption that child z-order is mapped to submission order. // FIXME: User code may rely on explicit sorting of overlapping child window and would need to disable this somehow. Please get in contact if you are affected (github #4493) { bool render_decorations_in_parent = false; if ((flags & ImGuiWindowFlags_ChildWindow) && !(flags & ImGuiWindowFlags_Popup) && !window_is_child_tooltip) { // - We test overlap with the previous child window only (testing all would end up being O(log N) not a good investment here) // - We disable this when the parent window has zero vertices, which is a common pattern leading to laying out multiple overlapping childs ImGuiWindow* previous_child = parent_window->DC.ChildWindows.Size >= 2 ? parent_window->DC.ChildWindows[parent_window->DC.ChildWindows.Size - 2] : NULL; bool previous_child_overlapping = previous_child ? previous_child->Rect().Overlaps(window->Rect()) : false; bool parent_is_empty = (parent_window->DrawList->VtxBuffer.Size == 0); if (window->DrawList->CmdBuffer.back().ElemCount == 0 && !parent_is_empty && !previous_child_overlapping) render_decorations_in_parent = true; } if (render_decorations_in_parent) window->DrawList = parent_window->DrawList; // Handle title bar, scrollbar, resize grips and resize borders const ImGuiWindow* window_to_highlight = g.NavWindowingTarget ? g.NavWindowingTarget : g.NavWindow; const bool title_bar_is_highlight = want_focus || (window_to_highlight && window->RootWindowForTitleBarHighlight == window_to_highlight->RootWindowForTitleBarHighlight); const bool handle_borders_and_resize_grips = true; // This exists to facilitate merge with 'docking' branch. RenderWindowDecorations(window, title_bar_rect, title_bar_is_highlight, handle_borders_and_resize_grips, resize_grip_count, resize_grip_col, resize_grip_draw_size); if (render_decorations_in_parent) window->DrawList = &window->DrawListInst; } // UPDATE RECTANGLES (2- THOSE AFFECTED BY SCROLLING) // Work rectangle. // Affected by window padding and border size. Used by: // - Columns() for right-most edge // - TreeNode(), CollapsingHeader() for right-most edge // - BeginTabBar() for right-most edge const bool allow_scrollbar_x = !(flags & ImGuiWindowFlags_NoScrollbar) && (flags & ImGuiWindowFlags_HorizontalScrollbar); const bool allow_scrollbar_y = !(flags & ImGuiWindowFlags_NoScrollbar); const float work_rect_size_x = (window->ContentSizeExplicit.x != 0.0f ? window->ContentSizeExplicit.x : ImMax(allow_scrollbar_x ? window->ContentSize.x : 0.0f, window->Size.x - window->WindowPadding.x * 2.0f - (window->DecoOuterSizeX1 + window->DecoOuterSizeX2))); const float work_rect_size_y = (window->ContentSizeExplicit.y != 0.0f ? window->ContentSizeExplicit.y : ImMax(allow_scrollbar_y ? window->ContentSize.y : 0.0f, window->Size.y - window->WindowPadding.y * 2.0f - (window->DecoOuterSizeY1 + window->DecoOuterSizeY2))); window->WorkRect.Min.x = ImTrunc(window->InnerRect.Min.x - window->Scroll.x + ImMax(window->WindowPadding.x, window->WindowBorderSize)); window->WorkRect.Min.y = ImTrunc(window->InnerRect.Min.y - window->Scroll.y + ImMax(window->WindowPadding.y, window->WindowBorderSize)); window->WorkRect.Max.x = window->WorkRect.Min.x + work_rect_size_x; window->WorkRect.Max.y = window->WorkRect.Min.y + work_rect_size_y; window->ParentWorkRect = window->WorkRect; // [LEGACY] Content Region // FIXME-OBSOLETE: window->ContentRegionRect.Max is currently very misleading / partly faulty, but some BeginChild() patterns relies on it. // Unless explicit content size is specified by user, this currently represent the region leading to no scrolling. // Used by: // - Mouse wheel scrolling + many other things window->ContentRegionRect.Min.x = window->Pos.x - window->Scroll.x + window->WindowPadding.x + window->DecoOuterSizeX1; window->ContentRegionRect.Min.y = window->Pos.y - window->Scroll.y + window->WindowPadding.y + window->DecoOuterSizeY1; window->ContentRegionRect.Max.x = window->ContentRegionRect.Min.x + (window->ContentSizeExplicit.x != 0.0f ? window->ContentSizeExplicit.x : (window->Size.x - window->WindowPadding.x * 2.0f - (window->DecoOuterSizeX1 + window->DecoOuterSizeX2))); window->ContentRegionRect.Max.y = window->ContentRegionRect.Min.y + (window->ContentSizeExplicit.y != 0.0f ? window->ContentSizeExplicit.y : (window->Size.y - window->WindowPadding.y * 2.0f - (window->DecoOuterSizeY1 + window->DecoOuterSizeY2))); // Setup drawing context // (NB: That term "drawing context / DC" lost its meaning a long time ago. Initially was meant to hold transient data only. Nowadays difference between window-> and window->DC-> is dubious.) window->DC.Indent.x = window->DecoOuterSizeX1 + window->WindowPadding.x - window->Scroll.x; window->DC.GroupOffset.x = 0.0f; window->DC.ColumnsOffset.x = 0.0f; // Record the loss of precision of CursorStartPos which can happen due to really large scrolling amount. // This is used by clipper to compensate and fix the most common use case of large scroll area. Easy and cheap, next best thing compared to switching everything to double or ImU64. double start_pos_highp_x = (double)window->Pos.x + window->WindowPadding.x - (double)window->Scroll.x + window->DecoOuterSizeX1 + window->DC.ColumnsOffset.x; double start_pos_highp_y = (double)window->Pos.y + window->WindowPadding.y - (double)window->Scroll.y + window->DecoOuterSizeY1; window->DC.CursorStartPos = ImVec2((float)start_pos_highp_x, (float)start_pos_highp_y); window->DC.CursorStartPosLossyness = ImVec2((float)(start_pos_highp_x - window->DC.CursorStartPos.x), (float)(start_pos_highp_y - window->DC.CursorStartPos.y)); window->DC.CursorPos = window->DC.CursorStartPos; window->DC.CursorPosPrevLine = window->DC.CursorPos; window->DC.CursorMaxPos = window->DC.CursorStartPos; window->DC.IdealMaxPos = window->DC.CursorStartPos; window->DC.CurrLineSize = window->DC.PrevLineSize = ImVec2(0.0f, 0.0f); window->DC.CurrLineTextBaseOffset = window->DC.PrevLineTextBaseOffset = 0.0f; window->DC.IsSameLine = window->DC.IsSetPos = false; window->DC.NavLayerCurrent = ImGuiNavLayer_Main; window->DC.NavLayersActiveMask = window->DC.NavLayersActiveMaskNext; window->DC.NavLayersActiveMaskNext = 0x00; window->DC.NavIsScrollPushableX = true; window->DC.NavHideHighlightOneFrame = false; window->DC.NavWindowHasScrollY = (window->ScrollMax.y > 0.0f); window->DC.MenuBarAppending = false; window->DC.MenuColumns.Update(style.ItemSpacing.x, window_just_activated_by_user); window->DC.TreeDepth = 0; window->DC.TreeHasStackDataDepthMask = 0x00; window->DC.ChildWindows.resize(0); window->DC.StateStorage = &window->StateStorage; window->DC.CurrentColumns = NULL; window->DC.LayoutType = ImGuiLayoutType_Vertical; window->DC.ParentLayoutType = parent_window ? parent_window->DC.LayoutType : ImGuiLayoutType_Vertical; window->DC.ItemWidth = window->ItemWidthDefault; window->DC.TextWrapPos = -1.0f; // disabled window->DC.ItemWidthStack.resize(0); window->DC.TextWrapPosStack.resize(0); if (flags & ImGuiWindowFlags_Modal) window->DC.ModalDimBgColor = ColorConvertFloat4ToU32(GetStyleColorVec4(ImGuiCol_ModalWindowDimBg)); if (window->AutoFitFramesX > 0) window->AutoFitFramesX--; if (window->AutoFitFramesY > 0) window->AutoFitFramesY--; // Apply focus (we need to call FocusWindow() AFTER setting DC.CursorStartPos so our initial navigation reference rectangle can start around there) // We ImGuiFocusRequestFlags_UnlessBelowModal to: // - Avoid focusing a window that is created outside of a modal. This will prevent active modal from being closed. // - Position window behind the modal that is not a begin-parent of this window. if (want_focus) FocusWindow(window, ImGuiFocusRequestFlags_UnlessBelowModal); if (want_focus && window == g.NavWindow) NavInitWindow(window, false); // <-- this is in the way for us to be able to defer and sort reappearing FocusWindow() calls // Pressing CTRL+C copy window content into the clipboard // [EXPERIMENTAL] Breaks on nested Begin/End pairs. We need to work that out and add better logging scope. // [EXPERIMENTAL] Text outputs has many issues. if (g.IO.ConfigWindowsCopyContentsWithCtrlC) if (g.NavWindow && g.NavWindow->RootWindow == window && g.ActiveId == 0 && Shortcut(ImGuiMod_Ctrl | ImGuiKey_C)) LogToClipboard(0); // Title bar if (!(flags & ImGuiWindowFlags_NoTitleBar)) RenderWindowTitleBarContents(window, ImRect(title_bar_rect.Min.x + window->WindowBorderSize, title_bar_rect.Min.y, title_bar_rect.Max.x - window->WindowBorderSize, title_bar_rect.Max.y), name, p_open); // Clear hit test shape every frame window->HitTestHoleSize.x = window->HitTestHoleSize.y = 0; if (flags & ImGuiWindowFlags_Tooltip) g.TooltipPreviousWindow = window; // We fill last item data based on Title Bar/Tab, in order for IsItemHovered() and IsItemActive() to be usable after Begin(). // This is useful to allow creating context menus on title bar only, etc. window->DC.WindowItemStatusFlags = ImGuiItemStatusFlags_None; window->DC.WindowItemStatusFlags |= IsMouseHoveringRect(title_bar_rect.Min, title_bar_rect.Max, false) ? ImGuiItemStatusFlags_HoveredRect : 0; SetLastItemDataForWindow(window, title_bar_rect); // [DEBUG] #ifndef IMGUI_DISABLE_DEBUG_TOOLS if (g.DebugLocateId != 0 && (window->ID == g.DebugLocateId || window->MoveId == g.DebugLocateId)) DebugLocateItemResolveWithLastItem(); #endif // [Test Engine] Register title bar / tab with MoveId. #ifdef IMGUI_ENABLE_TEST_ENGINE if (!(window->Flags & ImGuiWindowFlags_NoTitleBar)) { window->DC.NavLayerCurrent = ImGuiNavLayer_Menu; IMGUI_TEST_ENGINE_ITEM_ADD(g.LastItemData.ID, g.LastItemData.Rect, &g.LastItemData); window->DC.NavLayerCurrent = ImGuiNavLayer_Main; } #endif } else { // Skip refresh always mark active if (window->SkipRefresh) SetWindowActiveForSkipRefresh(window); // Append SetCurrentWindow(window); SetLastItemDataForWindow(window, window->TitleBarRect()); } if (!window->SkipRefresh) PushClipRect(window->InnerClipRect.Min, window->InnerClipRect.Max, true); // Clear 'accessed' flag last thing (After PushClipRect which will set the flag. We want the flag to stay false when the default "Debug" window is unused) window->WriteAccessed = false; window->BeginCount++; g.NextWindowData.ClearFlags(); // Update visibility if (first_begin_of_the_frame && !window->SkipRefresh) { if ((flags & ImGuiWindowFlags_ChildWindow) && !(flags & ImGuiWindowFlags_ChildMenu)) { // Child window can be out of sight and have "negative" clip windows. // Mark them as collapsed so commands are skipped earlier (we can't manually collapse them because they have no title bar). IM_ASSERT((flags & ImGuiWindowFlags_NoTitleBar) != 0); const bool nav_request = (window->ChildFlags & ImGuiChildFlags_NavFlattened) && (g.NavAnyRequest && g.NavWindow && g.NavWindow->RootWindowForNav == window->RootWindowForNav); if (!g.LogEnabled && !nav_request) if (window->OuterRectClipped.Min.x >= window->OuterRectClipped.Max.x || window->OuterRectClipped.Min.y >= window->OuterRectClipped.Max.y) { if (window->AutoFitFramesX > 0 || window->AutoFitFramesY > 0) window->HiddenFramesCannotSkipItems = 1; else window->HiddenFramesCanSkipItems = 1; } // Hide along with parent or if parent is collapsed if (parent_window && (parent_window->Collapsed || parent_window->HiddenFramesCanSkipItems > 0)) window->HiddenFramesCanSkipItems = 1; if (parent_window && parent_window->HiddenFramesCannotSkipItems > 0) window->HiddenFramesCannotSkipItems = 1; } // Don't render if style alpha is 0.0 at the time of Begin(). This is arbitrary and inconsistent but has been there for a long while (may remove at some point) if (style.Alpha <= 0.0f) window->HiddenFramesCanSkipItems = 1; // Update the Hidden flag bool hidden_regular = (window->HiddenFramesCanSkipItems > 0) || (window->HiddenFramesCannotSkipItems > 0); window->Hidden = hidden_regular || (window->HiddenFramesForRenderOnly > 0); // Disable inputs for requested number of frames if (window->DisableInputsFrames > 0) { window->DisableInputsFrames--; window->Flags |= ImGuiWindowFlags_NoInputs; } // Update the SkipItems flag, used to early out of all items functions (no layout required) bool skip_items = false; if (window->Collapsed || !window->Active || hidden_regular) if (window->AutoFitFramesX <= 0 && window->AutoFitFramesY <= 0 && window->HiddenFramesCannotSkipItems <= 0) skip_items = true; window->SkipItems = skip_items; } else if (first_begin_of_the_frame) { // Skip refresh mode window->SkipItems = true; } // [DEBUG] io.ConfigDebugBeginReturnValue override return value to test Begin/End and BeginChild/EndChild behaviors. // (The implicit fallback window is NOT automatically ended allowing it to always be able to receive commands without crashing) #ifndef IMGUI_DISABLE_DEBUG_TOOLS if (!window->IsFallbackWindow) if ((g.IO.ConfigDebugBeginReturnValueOnce && window_just_created) || (g.IO.ConfigDebugBeginReturnValueLoop && g.DebugBeginReturnValueCullDepth == g.CurrentWindowStack.Size)) { if (window->AutoFitFramesX > 0) { window->AutoFitFramesX++; } if (window->AutoFitFramesY > 0) { window->AutoFitFramesY++; } return false; } #endif return !window->SkipItems; } void ImGui::End() { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; // Error checking: verify that user hasn't called End() too many times! if (g.CurrentWindowStack.Size <= 1 && g.WithinFrameScopeWithImplicitWindow) { IM_ASSERT_USER_ERROR(g.CurrentWindowStack.Size > 1, "Calling End() too many times!"); return; } ImGuiWindowStackData& window_stack_data = g.CurrentWindowStack.back(); // Error checking: verify that user doesn't directly call End() on a child window. if (window->Flags & ImGuiWindowFlags_ChildWindow) IM_ASSERT_USER_ERROR(g.WithinEndChildID == window->ID, "Must call EndChild() and not End()!"); // Close anything that is open if (window->DC.CurrentColumns) EndColumns(); if (!window->SkipRefresh) PopClipRect(); // Inner window clip rectangle PopFocusScope(); if (window_stack_data.DisabledOverrideReenable && window->RootWindow == window) EndDisabledOverrideReenable(); if (window->SkipRefresh) { IM_ASSERT(window->DrawList == NULL); window->DrawList = &window->DrawListInst; } // Stop logging if (g.LogWindow == window) // FIXME: add more options for scope of logging LogFinish(); if (window->DC.IsSetPos) ErrorCheckUsingSetCursorPosToExtendParentBoundaries(); // Pop from window stack g.LastItemData = window_stack_data.ParentLastItemDataBackup; if (window->Flags & ImGuiWindowFlags_ChildMenu) g.BeginMenuDepth--; if (window->Flags & ImGuiWindowFlags_Popup) g.BeginPopupStack.pop_back(); // Error handling, state recovery if (g.IO.ConfigErrorRecovery) ErrorRecoveryTryToRecoverWindowState(&window_stack_data.StackSizesInBegin); g.CurrentWindowStack.pop_back(); SetCurrentWindow(g.CurrentWindowStack.Size == 0 ? NULL : g.CurrentWindowStack.back().Window); } // Important: this alone doesn't alter current ImDrawList state. This is called by PushFont/PopFont only. void ImGui::SetCurrentFont(ImFont* font) { ImGuiContext& g = *GImGui; IM_ASSERT(font && font->IsLoaded()); // Font Atlas not created. Did you call io.Fonts->GetTexDataAsRGBA32 / GetTexDataAsAlpha8 ? IM_ASSERT(font->Scale > 0.0f); g.Font = font; g.FontBaseSize = ImMax(1.0f, g.IO.FontGlobalScale * g.Font->FontSize * g.Font->Scale); g.FontSize = g.CurrentWindow ? g.CurrentWindow->CalcFontSize() : 0.0f; g.FontScale = g.FontSize / g.Font->FontSize; ImFontAtlas* atlas = g.Font->ContainerAtlas; g.DrawListSharedData.TexUvWhitePixel = atlas->TexUvWhitePixel; g.DrawListSharedData.TexUvLines = atlas->TexUvLines; g.DrawListSharedData.Font = g.Font; g.DrawListSharedData.FontSize = g.FontSize; g.DrawListSharedData.FontScale = g.FontScale; } // Use ImDrawList::_SetTextureID(), making our shared g.FontStack[] authorative against window-local ImDrawList. // - Whereas ImDrawList::PushTextureID()/PopTextureID() is not to be used across Begin() calls. // - Note that we don't propagate current texture id when e.g. Begin()-ing into a new window, we never really did... // - Some code paths never really fully worked with multiple atlas textures. // - The right-ish solution may be to remove _SetTextureID() and make AddText/RenderText lazily call PushTextureID()/PopTextureID() // the same way AddImage() does, but then all other primitives would also need to? I don't think we should tackle this problem // because we have a concrete need and a test bed for multiple atlas textures. void ImGui::PushFont(ImFont* font) { ImGuiContext& g = *GImGui; if (font == NULL) font = GetDefaultFont(); g.FontStack.push_back(font); SetCurrentFont(font); g.CurrentWindow->DrawList->_SetTextureID(font->ContainerAtlas->TexID); } void ImGui::PopFont() { ImGuiContext& g = *GImGui; if (g.FontStack.Size <= 0) { IM_ASSERT_USER_ERROR(0, "Calling PopFont() too many times!"); return; } g.FontStack.pop_back(); ImFont* font = g.FontStack.Size == 0 ? GetDefaultFont() : g.FontStack.back(); SetCurrentFont(font); g.CurrentWindow->DrawList->_SetTextureID(font->ContainerAtlas->TexID); } void ImGui::PushItemFlag(ImGuiItemFlags option, bool enabled) { ImGuiContext& g = *GImGui; ImGuiItemFlags item_flags = g.CurrentItemFlags; IM_ASSERT(item_flags == g.ItemFlagsStack.back()); if (enabled) item_flags |= option; else item_flags &= ~option; g.CurrentItemFlags = item_flags; g.ItemFlagsStack.push_back(item_flags); } void ImGui::PopItemFlag() { ImGuiContext& g = *GImGui; if (g.ItemFlagsStack.Size <= 1) { IM_ASSERT_USER_ERROR(0, "Calling PopItemFlag() too many times!"); return; } g.ItemFlagsStack.pop_back(); g.CurrentItemFlags = g.ItemFlagsStack.back(); } // BeginDisabled()/EndDisabled() // - Those can be nested but it cannot be used to enable an already disabled section (a single BeginDisabled(true) in the stack is enough to keep everything disabled) // - Visually this is currently altering alpha, but it is expected that in a future styling system this would work differently. // - Feedback welcome at https://github.com/ocornut/imgui/issues/211 // - BeginDisabled(false)/EndDisabled() essentially does nothing but is provided to facilitate use of boolean expressions. // (as a micro-optimization: if you have tens of thousands of BeginDisabled(false)/EndDisabled() pairs, you might want to reformulate your code to avoid making those calls) // - Note: mixing up BeginDisabled() and PushItemFlag(ImGuiItemFlags_Disabled) is currently NOT SUPPORTED. void ImGui::BeginDisabled(bool disabled) { ImGuiContext& g = *GImGui; bool was_disabled = (g.CurrentItemFlags & ImGuiItemFlags_Disabled) != 0; if (!was_disabled && disabled) { g.DisabledAlphaBackup = g.Style.Alpha; g.Style.Alpha *= g.Style.DisabledAlpha; // PushStyleVar(ImGuiStyleVar_Alpha, g.Style.Alpha * g.Style.DisabledAlpha); } if (was_disabled || disabled) g.CurrentItemFlags |= ImGuiItemFlags_Disabled; g.ItemFlagsStack.push_back(g.CurrentItemFlags); // FIXME-OPT: can we simply skip this and use DisabledStackSize? g.DisabledStackSize++; } void ImGui::EndDisabled() { ImGuiContext& g = *GImGui; if (g.DisabledStackSize <= 0) { IM_ASSERT_USER_ERROR(0, "Calling EndDisabled() too many times!"); return; } g.DisabledStackSize--; bool was_disabled = (g.CurrentItemFlags & ImGuiItemFlags_Disabled) != 0; //PopItemFlag(); g.ItemFlagsStack.pop_back(); g.CurrentItemFlags = g.ItemFlagsStack.back(); if (was_disabled && (g.CurrentItemFlags & ImGuiItemFlags_Disabled) == 0) g.Style.Alpha = g.DisabledAlphaBackup; //PopStyleVar(); } // Could have been called BeginDisabledDisable() but it didn't want to be award nominated for most awkward function name. // Ideally we would use a shared e.g. BeginDisabled()->BeginDisabledEx() but earlier needs to be optimal. // The whole code for this is awkward, will reevaluate if we find a way to implement SetNextItemDisabled(). void ImGui::BeginDisabledOverrideReenable() { ImGuiContext& g = *GImGui; IM_ASSERT(g.CurrentItemFlags & ImGuiItemFlags_Disabled); g.CurrentWindowStack.back().DisabledOverrideReenableAlphaBackup = g.Style.Alpha; g.Style.Alpha = g.DisabledAlphaBackup; g.CurrentItemFlags &= ~ImGuiItemFlags_Disabled; g.ItemFlagsStack.push_back(g.CurrentItemFlags); g.DisabledStackSize++; } void ImGui::EndDisabledOverrideReenable() { ImGuiContext& g = *GImGui; g.DisabledStackSize--; IM_ASSERT(g.DisabledStackSize > 0); g.ItemFlagsStack.pop_back(); g.CurrentItemFlags = g.ItemFlagsStack.back(); g.Style.Alpha = g.CurrentWindowStack.back().DisabledOverrideReenableAlphaBackup; } void ImGui::PushTextWrapPos(float wrap_pos_x) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; window->DC.TextWrapPosStack.push_back(window->DC.TextWrapPos); window->DC.TextWrapPos = wrap_pos_x; } void ImGui::PopTextWrapPos() { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; if (window->DC.TextWrapPosStack.Size <= 0) { IM_ASSERT_USER_ERROR(0, "Calling PopTextWrapPos() too many times!"); return; } window->DC.TextWrapPos = window->DC.TextWrapPosStack.back(); window->DC.TextWrapPosStack.pop_back(); } static ImGuiWindow* GetCombinedRootWindow(ImGuiWindow* window, bool popup_hierarchy) { ImGuiWindow* last_window = NULL; while (last_window != window) { last_window = window; window = window->RootWindow; if (popup_hierarchy) window = window->RootWindowPopupTree; } return window; } bool ImGui::IsWindowChildOf(ImGuiWindow* window, ImGuiWindow* potential_parent, bool popup_hierarchy) { ImGuiWindow* window_root = GetCombinedRootWindow(window, popup_hierarchy); if (window_root == potential_parent) return true; while (window != NULL) { if (window == potential_parent) return true; if (window == window_root) // end of chain return false; window = window->ParentWindow; } return false; } bool ImGui::IsWindowWithinBeginStackOf(ImGuiWindow* window, ImGuiWindow* potential_parent) { if (window->RootWindow == potential_parent) return true; while (window != NULL) { if (window == potential_parent) return true; window = window->ParentWindowInBeginStack; } return false; } bool ImGui::IsWindowAbove(ImGuiWindow* potential_above, ImGuiWindow* potential_below) { ImGuiContext& g = *GImGui; // It would be saner to ensure that display layer is always reflected in the g.Windows[] order, which would likely requires altering all manipulations of that array const int display_layer_delta = GetWindowDisplayLayer(potential_above) - GetWindowDisplayLayer(potential_below); if (display_layer_delta != 0) return display_layer_delta > 0; for (int i = g.Windows.Size - 1; i >= 0; i--) { ImGuiWindow* candidate_window = g.Windows[i]; if (candidate_window == potential_above) return true; if (candidate_window == potential_below) return false; } return false; } // Is current window hovered and hoverable (e.g. not blocked by a popup/modal)? See ImGuiHoveredFlags_ for options. // IMPORTANT: If you are trying to check whether your mouse should be dispatched to Dear ImGui or to your underlying app, // you should not use this function! Use the 'io.WantCaptureMouse' boolean for that! // Refer to FAQ entry "How can I tell whether to dispatch mouse/keyboard to Dear ImGui or my application?" for details. bool ImGui::IsWindowHovered(ImGuiHoveredFlags flags) { ImGuiContext& g = *GImGui; IM_ASSERT_USER_ERROR((flags & ~ImGuiHoveredFlags_AllowedMaskForIsWindowHovered) == 0, "Invalid flags for IsWindowHovered()!"); ImGuiWindow* ref_window = g.HoveredWindow; ImGuiWindow* cur_window = g.CurrentWindow; if (ref_window == NULL) return false; if ((flags & ImGuiHoveredFlags_AnyWindow) == 0) { IM_ASSERT(cur_window); // Not inside a Begin()/End() const bool popup_hierarchy = (flags & ImGuiHoveredFlags_NoPopupHierarchy) == 0; if (flags & ImGuiHoveredFlags_RootWindow) cur_window = GetCombinedRootWindow(cur_window, popup_hierarchy); bool result; if (flags & ImGuiHoveredFlags_ChildWindows) result = IsWindowChildOf(ref_window, cur_window, popup_hierarchy); else result = (ref_window == cur_window); if (!result) return false; } if (!IsWindowContentHoverable(ref_window, flags)) return false; if (!(flags & ImGuiHoveredFlags_AllowWhenBlockedByActiveItem)) if (g.ActiveId != 0 && !g.ActiveIdAllowOverlap && g.ActiveId != ref_window->MoveId) return false; // When changing hovered window we requires a bit of stationary delay before activating hover timer. // FIXME: We don't support delay other than stationary one for now, other delay would need a way // to fulfill the possibility that multiple IsWindowHovered() with varying flag could return true // for different windows of the hierarchy. Possibly need a Hash(Current+Flags) ==> (Timer) cache. // We can implement this for _Stationary because the data is linked to HoveredWindow rather than CurrentWindow. if (flags & ImGuiHoveredFlags_ForTooltip) flags = ApplyHoverFlagsForTooltip(flags, g.Style.HoverFlagsForTooltipMouse); if ((flags & ImGuiHoveredFlags_Stationary) != 0 && g.HoverWindowUnlockedStationaryId != ref_window->ID) return false; return true; } float ImGui::GetWindowWidth() { ImGuiWindow* window = GImGui->CurrentWindow; return window->Size.x; } float ImGui::GetWindowHeight() { ImGuiWindow* window = GImGui->CurrentWindow; return window->Size.y; } ImVec2 ImGui::GetWindowPos() { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; return window->Pos; } void ImGui::SetWindowPos(ImGuiWindow* window, const ImVec2& pos, ImGuiCond cond) { // Test condition (NB: bit 0 is always true) and clear flags for next time if (cond && (window->SetWindowPosAllowFlags & cond) == 0) return; IM_ASSERT(cond == 0 || ImIsPowerOfTwo(cond)); // Make sure the user doesn't attempt to combine multiple condition flags. window->SetWindowPosAllowFlags &= ~(ImGuiCond_Once | ImGuiCond_FirstUseEver | ImGuiCond_Appearing); window->SetWindowPosVal = ImVec2(FLT_MAX, FLT_MAX); // Set const ImVec2 old_pos = window->Pos; window->Pos = ImTrunc(pos); ImVec2 offset = window->Pos - old_pos; if (offset.x == 0.0f && offset.y == 0.0f) return; MarkIniSettingsDirty(window); window->DC.CursorPos += offset; // As we happen to move the window while it is being appended to (which is a bad idea - will smear) let's at least offset the cursor window->DC.CursorMaxPos += offset; // And more importantly we need to offset CursorMaxPos/CursorStartPos this so ContentSize calculation doesn't get affected. window->DC.IdealMaxPos += offset; window->DC.CursorStartPos += offset; } void ImGui::SetWindowPos(const ImVec2& pos, ImGuiCond cond) { ImGuiWindow* window = GetCurrentWindowRead(); SetWindowPos(window, pos, cond); } void ImGui::SetWindowPos(const char* name, const ImVec2& pos, ImGuiCond cond) { if (ImGuiWindow* window = FindWindowByName(name)) SetWindowPos(window, pos, cond); } ImVec2 ImGui::GetWindowSize() { ImGuiWindow* window = GetCurrentWindowRead(); return window->Size; } void ImGui::SetWindowSize(ImGuiWindow* window, const ImVec2& size, ImGuiCond cond) { // Test condition (NB: bit 0 is always true) and clear flags for next time if (cond && (window->SetWindowSizeAllowFlags & cond) == 0) return; IM_ASSERT(cond == 0 || ImIsPowerOfTwo(cond)); // Make sure the user doesn't attempt to combine multiple condition flags. window->SetWindowSizeAllowFlags &= ~(ImGuiCond_Once | ImGuiCond_FirstUseEver | ImGuiCond_Appearing); // Enable auto-fit (not done in BeginChild() path unless appearing or combined with ImGuiChildFlags_AlwaysAutoResize) if ((window->Flags & ImGuiWindowFlags_ChildWindow) == 0 || window->Appearing || (window->ChildFlags & ImGuiChildFlags_AlwaysAutoResize) != 0) window->AutoFitFramesX = (size.x <= 0.0f) ? 2 : 0; if ((window->Flags & ImGuiWindowFlags_ChildWindow) == 0 || window->Appearing || (window->ChildFlags & ImGuiChildFlags_AlwaysAutoResize) != 0) window->AutoFitFramesY = (size.y <= 0.0f) ? 2 : 0; // Set ImVec2 old_size = window->SizeFull; if (size.x <= 0.0f) window->AutoFitOnlyGrows = false; else window->SizeFull.x = IM_TRUNC(size.x); if (size.y <= 0.0f) window->AutoFitOnlyGrows = false; else window->SizeFull.y = IM_TRUNC(size.y); if (old_size.x != window->SizeFull.x || old_size.y != window->SizeFull.y) MarkIniSettingsDirty(window); } void ImGui::SetWindowSize(const ImVec2& size, ImGuiCond cond) { SetWindowSize(GImGui->CurrentWindow, size, cond); } void ImGui::SetWindowSize(const char* name, const ImVec2& size, ImGuiCond cond) { if (ImGuiWindow* window = FindWindowByName(name)) SetWindowSize(window, size, cond); } void ImGui::SetWindowCollapsed(ImGuiWindow* window, bool collapsed, ImGuiCond cond) { // Test condition (NB: bit 0 is always true) and clear flags for next time if (cond && (window->SetWindowCollapsedAllowFlags & cond) == 0) return; window->SetWindowCollapsedAllowFlags &= ~(ImGuiCond_Once | ImGuiCond_FirstUseEver | ImGuiCond_Appearing); // Set window->Collapsed = collapsed; } void ImGui::SetWindowHitTestHole(ImGuiWindow* window, const ImVec2& pos, const ImVec2& size) { IM_ASSERT(window->HitTestHoleSize.x == 0); // We don't support multiple holes/hit test filters window->HitTestHoleSize = ImVec2ih(size); window->HitTestHoleOffset = ImVec2ih(pos - window->Pos); } void ImGui::SetWindowHiddenAndSkipItemsForCurrentFrame(ImGuiWindow* window) { window->Hidden = window->SkipItems = true; window->HiddenFramesCanSkipItems = 1; } void ImGui::SetWindowCollapsed(bool collapsed, ImGuiCond cond) { SetWindowCollapsed(GImGui->CurrentWindow, collapsed, cond); } bool ImGui::IsWindowCollapsed() { ImGuiWindow* window = GetCurrentWindowRead(); return window->Collapsed; } bool ImGui::IsWindowAppearing() { ImGuiWindow* window = GetCurrentWindowRead(); return window->Appearing; } void ImGui::SetWindowCollapsed(const char* name, bool collapsed, ImGuiCond cond) { if (ImGuiWindow* window = FindWindowByName(name)) SetWindowCollapsed(window, collapsed, cond); } void ImGui::SetNextWindowPos(const ImVec2& pos, ImGuiCond cond, const ImVec2& pivot) { ImGuiContext& g = *GImGui; IM_ASSERT(cond == 0 || ImIsPowerOfTwo(cond)); // Make sure the user doesn't attempt to combine multiple condition flags. g.NextWindowData.HasFlags |= ImGuiNextWindowDataFlags_HasPos; g.NextWindowData.PosVal = pos; g.NextWindowData.PosPivotVal = pivot; g.NextWindowData.PosCond = cond ? cond : ImGuiCond_Always; } void ImGui::SetNextWindowSize(const ImVec2& size, ImGuiCond cond) { ImGuiContext& g = *GImGui; IM_ASSERT(cond == 0 || ImIsPowerOfTwo(cond)); // Make sure the user doesn't attempt to combine multiple condition flags. g.NextWindowData.HasFlags |= ImGuiNextWindowDataFlags_HasSize; g.NextWindowData.SizeVal = size; g.NextWindowData.SizeCond = cond ? cond : ImGuiCond_Always; } // For each axis: // - Use 0.0f as min or FLT_MAX as max if you don't want limits, e.g. size_min = (500.0f, 0.0f), size_max = (FLT_MAX, FLT_MAX) sets a minimum width. // - Use -1 for both min and max of same axis to preserve current size which itself is a constraint. // - See "Demo->Examples->Constrained-resizing window" for examples. void ImGui::SetNextWindowSizeConstraints(const ImVec2& size_min, const ImVec2& size_max, ImGuiSizeCallback custom_callback, void* custom_callback_user_data) { ImGuiContext& g = *GImGui; g.NextWindowData.HasFlags |= ImGuiNextWindowDataFlags_HasSizeConstraint; g.NextWindowData.SizeConstraintRect = ImRect(size_min, size_max); g.NextWindowData.SizeCallback = custom_callback; g.NextWindowData.SizeCallbackUserData = custom_callback_user_data; } // Content size = inner scrollable rectangle, padded with WindowPadding. // SetNextWindowContentSize(ImVec2(100,100) + ImGuiWindowFlags_AlwaysAutoResize will always allow submitting a 100x100 item. void ImGui::SetNextWindowContentSize(const ImVec2& size) { ImGuiContext& g = *GImGui; g.NextWindowData.HasFlags |= ImGuiNextWindowDataFlags_HasContentSize; g.NextWindowData.ContentSizeVal = ImTrunc(size); } void ImGui::SetNextWindowScroll(const ImVec2& scroll) { ImGuiContext& g = *GImGui; g.NextWindowData.HasFlags |= ImGuiNextWindowDataFlags_HasScroll; g.NextWindowData.ScrollVal = scroll; } void ImGui::SetNextWindowCollapsed(bool collapsed, ImGuiCond cond) { ImGuiContext& g = *GImGui; IM_ASSERT(cond == 0 || ImIsPowerOfTwo(cond)); // Make sure the user doesn't attempt to combine multiple condition flags. g.NextWindowData.HasFlags |= ImGuiNextWindowDataFlags_HasCollapsed; g.NextWindowData.CollapsedVal = collapsed; g.NextWindowData.CollapsedCond = cond ? cond : ImGuiCond_Always; } void ImGui::SetNextWindowBgAlpha(float alpha) { ImGuiContext& g = *GImGui; g.NextWindowData.HasFlags |= ImGuiNextWindowDataFlags_HasBgAlpha; g.NextWindowData.BgAlphaVal = alpha; } // This is experimental and meant to be a toy for exploring a future/wider range of features. void ImGui::SetNextWindowRefreshPolicy(ImGuiWindowRefreshFlags flags) { ImGuiContext& g = *GImGui; g.NextWindowData.HasFlags |= ImGuiNextWindowDataFlags_HasRefreshPolicy; g.NextWindowData.RefreshFlagsVal = flags; } ImDrawList* ImGui::GetWindowDrawList() { ImGuiWindow* window = GetCurrentWindow(); return window->DrawList; } ImFont* ImGui::GetFont() { return GImGui->Font; } float ImGui::GetFontSize() { return GImGui->FontSize; } ImVec2 ImGui::GetFontTexUvWhitePixel() { return GImGui->DrawListSharedData.TexUvWhitePixel; } void ImGui::SetWindowFontScale(float scale) { IM_ASSERT(scale > 0.0f); ImGuiContext& g = *GImGui; ImGuiWindow* window = GetCurrentWindow(); window->FontWindowScale = scale; g.FontSize = g.DrawListSharedData.FontSize = window->CalcFontSize(); g.FontScale = g.DrawListSharedData.FontScale = g.FontSize / g.Font->FontSize; } void ImGui::PushFocusScope(ImGuiID id) { ImGuiContext& g = *GImGui; ImGuiFocusScopeData data; data.ID = id; data.WindowID = g.CurrentWindow->ID; g.FocusScopeStack.push_back(data); g.CurrentFocusScopeId = id; } void ImGui::PopFocusScope() { ImGuiContext& g = *GImGui; if (g.FocusScopeStack.Size <= g.StackSizesInBeginForCurrentWindow->SizeOfFocusScopeStack) { IM_ASSERT_USER_ERROR(0, "Calling PopFocusScope() too many times!"); return; } g.FocusScopeStack.pop_back(); g.CurrentFocusScopeId = g.FocusScopeStack.Size ? g.FocusScopeStack.back().ID : 0; } void ImGui::SetNavFocusScope(ImGuiID focus_scope_id) { ImGuiContext& g = *GImGui; g.NavFocusScopeId = focus_scope_id; g.NavFocusRoute.resize(0); // Invalidate if (focus_scope_id == 0) return; IM_ASSERT(g.NavWindow != NULL); // Store current path (in reverse order) if (focus_scope_id == g.CurrentFocusScopeId) { // Top of focus stack contains local focus scopes inside current window for (int n = g.FocusScopeStack.Size - 1; n >= 0 && g.FocusScopeStack.Data[n].WindowID == g.CurrentWindow->ID; n--) g.NavFocusRoute.push_back(g.FocusScopeStack.Data[n]); } else if (focus_scope_id == g.NavWindow->NavRootFocusScopeId) g.NavFocusRoute.push_back({ focus_scope_id, g.NavWindow->ID }); else return; // Then follow on manually set ParentWindowForFocusRoute field (#6798) for (ImGuiWindow* window = g.NavWindow->ParentWindowForFocusRoute; window != NULL; window = window->ParentWindowForFocusRoute) g.NavFocusRoute.push_back({ window->NavRootFocusScopeId, window->ID }); IM_ASSERT(g.NavFocusRoute.Size < 100); // Maximum depth is technically 251 as per CalcRoutingScore(): 254 - 3 } // Focus = move navigation cursor, set scrolling, set focus window. void ImGui::FocusItem() { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; IMGUI_DEBUG_LOG_FOCUS("FocusItem(0x%08x) in window \"%s\"\n", g.LastItemData.ID, window->Name); if (g.DragDropActive || g.MovingWindow != NULL) // FIXME: Opt-in flags for this? { IMGUI_DEBUG_LOG_FOCUS("FocusItem() ignored while DragDropActive!\n"); return; } ImGuiNavMoveFlags move_flags = ImGuiNavMoveFlags_IsTabbing | ImGuiNavMoveFlags_FocusApi | ImGuiNavMoveFlags_NoSetNavCursorVisible | ImGuiNavMoveFlags_NoSelect; ImGuiScrollFlags scroll_flags = window->Appearing ? ImGuiScrollFlags_KeepVisibleEdgeX | ImGuiScrollFlags_AlwaysCenterY : ImGuiScrollFlags_KeepVisibleEdgeX | ImGuiScrollFlags_KeepVisibleEdgeY; SetNavWindow(window); NavMoveRequestSubmit(ImGuiDir_None, ImGuiDir_Up, move_flags, scroll_flags); NavMoveRequestResolveWithLastItem(&g.NavMoveResultLocal); } void ImGui::ActivateItemByID(ImGuiID id) { ImGuiContext& g = *GImGui; g.NavNextActivateId = id; g.NavNextActivateFlags = ImGuiActivateFlags_None; } // Note: this will likely be called ActivateItem() once we rework our Focus/Activation system! // But ActivateItem() should function without altering scroll/focus? void ImGui::SetKeyboardFocusHere(int offset) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; IM_ASSERT(offset >= -1); // -1 is allowed but not below IMGUI_DEBUG_LOG_FOCUS("SetKeyboardFocusHere(%d) in window \"%s\"\n", offset, window->Name); // It makes sense in the vast majority of cases to never interrupt a drag and drop. // When we refactor this function into ActivateItem() we may want to make this an option. // MovingWindow is protected from most user inputs using SetActiveIdUsingNavAndKeys(), but // is also automatically dropped in the event g.ActiveId is stolen. if (g.DragDropActive || g.MovingWindow != NULL) { IMGUI_DEBUG_LOG_FOCUS("SetKeyboardFocusHere() ignored while DragDropActive!\n"); return; } SetNavWindow(window); ImGuiNavMoveFlags move_flags = ImGuiNavMoveFlags_IsTabbing | ImGuiNavMoveFlags_Activate | ImGuiNavMoveFlags_FocusApi | ImGuiNavMoveFlags_NoSetNavCursorVisible; ImGuiScrollFlags scroll_flags = window->Appearing ? ImGuiScrollFlags_KeepVisibleEdgeX | ImGuiScrollFlags_AlwaysCenterY : ImGuiScrollFlags_KeepVisibleEdgeX | ImGuiScrollFlags_KeepVisibleEdgeY; NavMoveRequestSubmit(ImGuiDir_None, offset < 0 ? ImGuiDir_Up : ImGuiDir_Down, move_flags, scroll_flags); // FIXME-NAV: Once we refactor tabbing, add LegacyApi flag to not activate non-inputable. if (offset == -1) { NavMoveRequestResolveWithLastItem(&g.NavMoveResultLocal); } else { g.NavTabbingDir = 1; g.NavTabbingCounter = offset + 1; } } void ImGui::SetItemDefaultFocus() { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; if (!window->Appearing) return; if (g.NavWindow != window->RootWindowForNav || (!g.NavInitRequest && g.NavInitResult.ID == 0) || g.NavLayer != window->DC.NavLayerCurrent) return; g.NavInitRequest = false; NavApplyItemToResult(&g.NavInitResult); NavUpdateAnyRequestFlag(); // Scroll could be done in NavInitRequestApplyResult() via an opt-in flag (we however don't want regular init requests to scroll) if (!window->ClipRect.Contains(g.LastItemData.Rect)) ScrollToRectEx(window, g.LastItemData.Rect, ImGuiScrollFlags_None); } void ImGui::SetStateStorage(ImGuiStorage* tree) { ImGuiWindow* window = GImGui->CurrentWindow; window->DC.StateStorage = tree ? tree : &window->StateStorage; } ImGuiStorage* ImGui::GetStateStorage() { ImGuiWindow* window = GImGui->CurrentWindow; return window->DC.StateStorage; } bool ImGui::IsRectVisible(const ImVec2& size) { ImGuiWindow* window = GImGui->CurrentWindow; return window->ClipRect.Overlaps(ImRect(window->DC.CursorPos, window->DC.CursorPos + size)); } bool ImGui::IsRectVisible(const ImVec2& rect_min, const ImVec2& rect_max) { ImGuiWindow* window = GImGui->CurrentWindow; return window->ClipRect.Overlaps(ImRect(rect_min, rect_max)); } //----------------------------------------------------------------------------- // [SECTION] ID STACK //----------------------------------------------------------------------------- // This is one of the very rare legacy case where we use ImGuiWindow methods, // it should ideally be flattened at some point but it's been used a lots by widgets. IM_MSVC_RUNTIME_CHECKS_OFF ImGuiID ImGuiWindow::GetID(const char* str, const char* str_end) { ImGuiID seed = IDStack.back(); ImGuiID id = ImHashStr(str, str_end ? (str_end - str) : 0, seed); #ifndef IMGUI_DISABLE_DEBUG_TOOLS ImGuiContext& g = *Ctx; if (g.DebugHookIdInfo == id) ImGui::DebugHookIdInfo(id, ImGuiDataType_String, str, str_end); #endif return id; } ImGuiID ImGuiWindow::GetID(const void* ptr) { ImGuiID seed = IDStack.back(); ImGuiID id = ImHashData(&ptr, sizeof(void*), seed); #ifndef IMGUI_DISABLE_DEBUG_TOOLS ImGuiContext& g = *Ctx; if (g.DebugHookIdInfo == id) ImGui::DebugHookIdInfo(id, ImGuiDataType_Pointer, ptr, NULL); #endif return id; } ImGuiID ImGuiWindow::GetID(int n) { ImGuiID seed = IDStack.back(); ImGuiID id = ImHashData(&n, sizeof(n), seed); #ifndef IMGUI_DISABLE_DEBUG_TOOLS ImGuiContext& g = *Ctx; if (g.DebugHookIdInfo == id) ImGui::DebugHookIdInfo(id, ImGuiDataType_S32, (void*)(intptr_t)n, NULL); #endif return id; } // This is only used in rare/specific situations to manufacture an ID out of nowhere. // FIXME: Consider instead storing last non-zero ID + count of successive zero-ID, and combine those? ImGuiID ImGuiWindow::GetIDFromPos(const ImVec2& p_abs) { ImGuiID seed = IDStack.back(); ImVec2 p_rel = ImGui::WindowPosAbsToRel(this, p_abs); ImGuiID id = ImHashData(&p_rel, sizeof(p_rel), seed); return id; } // " ImGuiID ImGuiWindow::GetIDFromRectangle(const ImRect& r_abs) { ImGuiID seed = IDStack.back(); ImRect r_rel = ImGui::WindowRectAbsToRel(this, r_abs); ImGuiID id = ImHashData(&r_rel, sizeof(r_rel), seed); return id; } void ImGui::PushID(const char* str_id) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; ImGuiID id = window->GetID(str_id); window->IDStack.push_back(id); } void ImGui::PushID(const char* str_id_begin, const char* str_id_end) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; ImGuiID id = window->GetID(str_id_begin, str_id_end); window->IDStack.push_back(id); } void ImGui::PushID(const void* ptr_id) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; ImGuiID id = window->GetID(ptr_id); window->IDStack.push_back(id); } void ImGui::PushID(int int_id) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; ImGuiID id = window->GetID(int_id); window->IDStack.push_back(id); } // Push a given id value ignoring the ID stack as a seed. void ImGui::PushOverrideID(ImGuiID id) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; #ifndef IMGUI_DISABLE_DEBUG_TOOLS if (g.DebugHookIdInfo == id) DebugHookIdInfo(id, ImGuiDataType_ID, NULL, NULL); #endif window->IDStack.push_back(id); } // Helper to avoid a common series of PushOverrideID -> GetID() -> PopID() call // (note that when using this pattern, ID Stack Tool will tend to not display the intermediate stack level. // for that to work we would need to do PushOverrideID() -> ItemAdd() -> PopID() which would alter widget code a little more) ImGuiID ImGui::GetIDWithSeed(const char* str, const char* str_end, ImGuiID seed) { ImGuiID id = ImHashStr(str, str_end ? (str_end - str) : 0, seed); #ifndef IMGUI_DISABLE_DEBUG_TOOLS ImGuiContext& g = *GImGui; if (g.DebugHookIdInfo == id) DebugHookIdInfo(id, ImGuiDataType_String, str, str_end); #endif return id; } ImGuiID ImGui::GetIDWithSeed(int n, ImGuiID seed) { ImGuiID id = ImHashData(&n, sizeof(n), seed); #ifndef IMGUI_DISABLE_DEBUG_TOOLS ImGuiContext& g = *GImGui; if (g.DebugHookIdInfo == id) DebugHookIdInfo(id, ImGuiDataType_S32, (void*)(intptr_t)n, NULL); #endif return id; } void ImGui::PopID() { ImGuiWindow* window = GImGui->CurrentWindow; if (window->IDStack.Size <= 1) { IM_ASSERT_USER_ERROR(0, "Calling PopID() too many times!"); return; } window->IDStack.pop_back(); } ImGuiID ImGui::GetID(const char* str_id) { ImGuiWindow* window = GImGui->CurrentWindow; return window->GetID(str_id); } ImGuiID ImGui::GetID(const char* str_id_begin, const char* str_id_end) { ImGuiWindow* window = GImGui->CurrentWindow; return window->GetID(str_id_begin, str_id_end); } ImGuiID ImGui::GetID(const void* ptr_id) { ImGuiWindow* window = GImGui->CurrentWindow; return window->GetID(ptr_id); } ImGuiID ImGui::GetID(int int_id) { ImGuiWindow* window = GImGui->CurrentWindow; return window->GetID(int_id); } IM_MSVC_RUNTIME_CHECKS_RESTORE //----------------------------------------------------------------------------- // [SECTION] INPUTS //----------------------------------------------------------------------------- // - GetModForLRModKey() [Internal] // - FixupKeyChord() [Internal] // - GetKeyData() [Internal] // - GetKeyIndex() [Internal] // - GetKeyName() // - GetKeyChordName() [Internal] // - CalcTypematicRepeatAmount() [Internal] // - GetTypematicRepeatRate() [Internal] // - GetKeyPressedAmount() [Internal] // - GetKeyMagnitude2d() [Internal] //----------------------------------------------------------------------------- // - UpdateKeyRoutingTable() [Internal] // - GetRoutingIdFromOwnerId() [Internal] // - GetShortcutRoutingData() [Internal] // - CalcRoutingScore() [Internal] // - SetShortcutRouting() [Internal] // - TestShortcutRouting() [Internal] //----------------------------------------------------------------------------- // - IsKeyDown() // - IsKeyPressed() // - IsKeyReleased() //----------------------------------------------------------------------------- // - IsMouseDown() // - IsMouseClicked() // - IsMouseReleased() // - IsMouseDoubleClicked() // - GetMouseClickedCount() // - IsMouseHoveringRect() [Internal] // - IsMouseDragPastThreshold() [Internal] // - IsMouseDragging() // - GetMousePos() // - SetMousePos() [Internal] // - GetMousePosOnOpeningCurrentPopup() // - IsMousePosValid() // - IsAnyMouseDown() // - GetMouseDragDelta() // - ResetMouseDragDelta() // - GetMouseCursor() // - SetMouseCursor() //----------------------------------------------------------------------------- // - UpdateAliasKey() // - GetMergedModsFromKeys() // - UpdateKeyboardInputs() // - UpdateMouseInputs() //----------------------------------------------------------------------------- // - LockWheelingWindow [Internal] // - FindBestWheelingWindow [Internal] // - UpdateMouseWheel() [Internal] //----------------------------------------------------------------------------- // - SetNextFrameWantCaptureKeyboard() // - SetNextFrameWantCaptureMouse() //----------------------------------------------------------------------------- // - GetInputSourceName() [Internal] // - DebugPrintInputEvent() [Internal] // - UpdateInputEvents() [Internal] //----------------------------------------------------------------------------- // - GetKeyOwner() [Internal] // - TestKeyOwner() [Internal] // - SetKeyOwner() [Internal] // - SetItemKeyOwner() [Internal] // - Shortcut() [Internal] //----------------------------------------------------------------------------- static ImGuiKeyChord GetModForLRModKey(ImGuiKey key) { if (key == ImGuiKey_LeftCtrl || key == ImGuiKey_RightCtrl) return ImGuiMod_Ctrl; if (key == ImGuiKey_LeftShift || key == ImGuiKey_RightShift) return ImGuiMod_Shift; if (key == ImGuiKey_LeftAlt || key == ImGuiKey_RightAlt) return ImGuiMod_Alt; if (key == ImGuiKey_LeftSuper || key == ImGuiKey_RightSuper) return ImGuiMod_Super; return ImGuiMod_None; } ImGuiKeyChord ImGui::FixupKeyChord(ImGuiKeyChord key_chord) { // Add ImGuiMod_XXXX when a corresponding ImGuiKey_LeftXXX/ImGuiKey_RightXXX is specified. ImGuiKey key = (ImGuiKey)(key_chord & ~ImGuiMod_Mask_); if (IsLRModKey(key)) key_chord |= GetModForLRModKey(key); return key_chord; } ImGuiKeyData* ImGui::GetKeyData(ImGuiContext* ctx, ImGuiKey key) { ImGuiContext& g = *ctx; // Special storage location for mods if (key & ImGuiMod_Mask_) key = ConvertSingleModFlagToKey(key); IM_ASSERT(IsNamedKey(key) && "Support for user key indices was dropped in favor of ImGuiKey. Please update backend & user code."); return &g.IO.KeysData[key - ImGuiKey_NamedKey_BEGIN]; } // Those names are provided for debugging purpose and are not meant to be saved persistently nor compared. static const char* const GKeyNames[] = { "Tab", "LeftArrow", "RightArrow", "UpArrow", "DownArrow", "PageUp", "PageDown", "Home", "End", "Insert", "Delete", "Backspace", "Space", "Enter", "Escape", "LeftCtrl", "LeftShift", "LeftAlt", "LeftSuper", "RightCtrl", "RightShift", "RightAlt", "RightSuper", "Menu", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T", "U", "V", "W", "X", "Y", "Z", "F1", "F2", "F3", "F4", "F5", "F6", "F7", "F8", "F9", "F10", "F11", "F12", "F13", "F14", "F15", "F16", "F17", "F18", "F19", "F20", "F21", "F22", "F23", "F24", "Apostrophe", "Comma", "Minus", "Period", "Slash", "Semicolon", "Equal", "LeftBracket", "Backslash", "RightBracket", "GraveAccent", "CapsLock", "ScrollLock", "NumLock", "PrintScreen", "Pause", "Keypad0", "Keypad1", "Keypad2", "Keypad3", "Keypad4", "Keypad5", "Keypad6", "Keypad7", "Keypad8", "Keypad9", "KeypadDecimal", "KeypadDivide", "KeypadMultiply", "KeypadSubtract", "KeypadAdd", "KeypadEnter", "KeypadEqual", "AppBack", "AppForward", "Oem102", "GamepadStart", "GamepadBack", "GamepadFaceLeft", "GamepadFaceRight", "GamepadFaceUp", "GamepadFaceDown", "GamepadDpadLeft", "GamepadDpadRight", "GamepadDpadUp", "GamepadDpadDown", "GamepadL1", "GamepadR1", "GamepadL2", "GamepadR2", "GamepadL3", "GamepadR3", "GamepadLStickLeft", "GamepadLStickRight", "GamepadLStickUp", "GamepadLStickDown", "GamepadRStickLeft", "GamepadRStickRight", "GamepadRStickUp", "GamepadRStickDown", "MouseLeft", "MouseRight", "MouseMiddle", "MouseX1", "MouseX2", "MouseWheelX", "MouseWheelY", "ModCtrl", "ModShift", "ModAlt", "ModSuper", // ReservedForModXXX are showing the ModXXX names. }; IM_STATIC_ASSERT(ImGuiKey_NamedKey_COUNT == IM_ARRAYSIZE(GKeyNames)); const char* ImGui::GetKeyName(ImGuiKey key) { if (key == ImGuiKey_None) return "None"; IM_ASSERT(IsNamedKeyOrMod(key) && "Support for user key indices was dropped in favor of ImGuiKey. Please update backend and user code."); if (key & ImGuiMod_Mask_) key = ConvertSingleModFlagToKey(key); if (!IsNamedKey(key)) return "Unknown"; return GKeyNames[key - ImGuiKey_NamedKey_BEGIN]; } // Return untranslated names: on macOS, Cmd key will show as Ctrl, Ctrl key will show as super. // Lifetime of return value: valid until next call to same function. const char* ImGui::GetKeyChordName(ImGuiKeyChord key_chord) { ImGuiContext& g = *GImGui; const ImGuiKey key = (ImGuiKey)(key_chord & ~ImGuiMod_Mask_); if (IsLRModKey(key)) key_chord &= ~GetModForLRModKey(key); // Return "Ctrl+LeftShift" instead of "Ctrl+Shift+LeftShift" ImFormatString(g.TempKeychordName, IM_ARRAYSIZE(g.TempKeychordName), "%s%s%s%s%s", (key_chord & ImGuiMod_Ctrl) ? "Ctrl+" : "", (key_chord & ImGuiMod_Shift) ? "Shift+" : "", (key_chord & ImGuiMod_Alt) ? "Alt+" : "", (key_chord & ImGuiMod_Super) ? "Super+" : "", (key != ImGuiKey_None || key_chord == ImGuiKey_None) ? GetKeyName(key) : ""); size_t len; if (key == ImGuiKey_None && key_chord != 0) if ((len = ImStrlen(g.TempKeychordName)) != 0) // Remove trailing '+' g.TempKeychordName[len - 1] = 0; return g.TempKeychordName; } // t0 = previous time (e.g.: g.Time - g.IO.DeltaTime) // t1 = current time (e.g.: g.Time) // An event is triggered at: // t = 0.0f t = repeat_delay, t = repeat_delay + repeat_rate*N int ImGui::CalcTypematicRepeatAmount(float t0, float t1, float repeat_delay, float repeat_rate) { if (t1 == 0.0f) return 1; if (t0 >= t1) return 0; if (repeat_rate <= 0.0f) return (t0 < repeat_delay) && (t1 >= repeat_delay); const int count_t0 = (t0 < repeat_delay) ? -1 : (int)((t0 - repeat_delay) / repeat_rate); const int count_t1 = (t1 < repeat_delay) ? -1 : (int)((t1 - repeat_delay) / repeat_rate); const int count = count_t1 - count_t0; return count; } void ImGui::GetTypematicRepeatRate(ImGuiInputFlags flags, float* repeat_delay, float* repeat_rate) { ImGuiContext& g = *GImGui; switch (flags & ImGuiInputFlags_RepeatRateMask_) { case ImGuiInputFlags_RepeatRateNavMove: *repeat_delay = g.IO.KeyRepeatDelay * 0.72f; *repeat_rate = g.IO.KeyRepeatRate * 0.80f; return; case ImGuiInputFlags_RepeatRateNavTweak: *repeat_delay = g.IO.KeyRepeatDelay * 0.72f; *repeat_rate = g.IO.KeyRepeatRate * 0.30f; return; case ImGuiInputFlags_RepeatRateDefault: default: *repeat_delay = g.IO.KeyRepeatDelay * 1.00f; *repeat_rate = g.IO.KeyRepeatRate * 1.00f; return; } } // Return value representing the number of presses in the last time period, for the given repeat rate // (most often returns 0 or 1. The result is generally only >1 when RepeatRate is smaller than DeltaTime, aka large DeltaTime or fast RepeatRate) int ImGui::GetKeyPressedAmount(ImGuiKey key, float repeat_delay, float repeat_rate) { ImGuiContext& g = *GImGui; const ImGuiKeyData* key_data = GetKeyData(key); if (!key_data->Down) // In theory this should already be encoded as (DownDuration < 0.0f), but testing this facilitates eating mechanism (until we finish work on key ownership) return 0; const float t = key_data->DownDuration; return CalcTypematicRepeatAmount(t - g.IO.DeltaTime, t, repeat_delay, repeat_rate); } // Return 2D vector representing the combination of four cardinal direction, with analog value support (for e.g. ImGuiKey_GamepadLStick* values). ImVec2 ImGui::GetKeyMagnitude2d(ImGuiKey key_left, ImGuiKey key_right, ImGuiKey key_up, ImGuiKey key_down) { return ImVec2( GetKeyData(key_right)->AnalogValue - GetKeyData(key_left)->AnalogValue, GetKeyData(key_down)->AnalogValue - GetKeyData(key_up)->AnalogValue); } // Rewrite routing data buffers to strip old entries + sort by key to make queries not touch scattered data. // Entries D,A,B,B,A,C,B --> A,A,B,B,B,C,D // Index A:1 B:2 C:5 D:0 --> A:0 B:2 C:5 D:6 // See 'Metrics->Key Owners & Shortcut Routing' to visualize the result of that operation. static void ImGui::UpdateKeyRoutingTable(ImGuiKeyRoutingTable* rt) { ImGuiContext& g = *GImGui; rt->EntriesNext.resize(0); for (ImGuiKey key = ImGuiKey_NamedKey_BEGIN; key < ImGuiKey_NamedKey_END; key = (ImGuiKey)(key + 1)) { const int new_routing_start_idx = rt->EntriesNext.Size; ImGuiKeyRoutingData* routing_entry; for (int old_routing_idx = rt->Index[key - ImGuiKey_NamedKey_BEGIN]; old_routing_idx != -1; old_routing_idx = routing_entry->NextEntryIndex) { routing_entry = &rt->Entries[old_routing_idx]; routing_entry->RoutingCurrScore = routing_entry->RoutingNextScore; routing_entry->RoutingCurr = routing_entry->RoutingNext; // Update entry routing_entry->RoutingNext = ImGuiKeyOwner_NoOwner; routing_entry->RoutingNextScore = 255; if (routing_entry->RoutingCurr == ImGuiKeyOwner_NoOwner) continue; rt->EntriesNext.push_back(*routing_entry); // Write alive ones into new buffer // Apply routing to owner if there's no owner already (RoutingCurr == None at this point) // This is the result of previous frame's SetShortcutRouting() call. if (routing_entry->Mods == g.IO.KeyMods) { ImGuiKeyOwnerData* owner_data = GetKeyOwnerData(&g, key); if (owner_data->OwnerCurr == ImGuiKeyOwner_NoOwner) { owner_data->OwnerCurr = routing_entry->RoutingCurr; //IMGUI_DEBUG_LOG("SetKeyOwner(%s, owner_id=0x%08X) via Routing\n", GetKeyName(key), routing_entry->RoutingCurr); } } } // Rewrite linked-list rt->Index[key - ImGuiKey_NamedKey_BEGIN] = (ImGuiKeyRoutingIndex)(new_routing_start_idx < rt->EntriesNext.Size ? new_routing_start_idx : -1); for (int n = new_routing_start_idx; n < rt->EntriesNext.Size; n++) rt->EntriesNext[n].NextEntryIndex = (ImGuiKeyRoutingIndex)((n + 1 < rt->EntriesNext.Size) ? n + 1 : -1); } rt->Entries.swap(rt->EntriesNext); // Swap new and old indexes } // owner_id may be None/Any, but routing_id needs to be always be set, so we default to GetCurrentFocusScope(). static inline ImGuiID GetRoutingIdFromOwnerId(ImGuiID owner_id) { ImGuiContext& g = *GImGui; return (owner_id != ImGuiKeyOwner_NoOwner && owner_id != ImGuiKeyOwner_Any) ? owner_id : g.CurrentFocusScopeId; } ImGuiKeyRoutingData* ImGui::GetShortcutRoutingData(ImGuiKeyChord key_chord) { // Majority of shortcuts will be Key + any number of Mods // We accept _Single_ mod with ImGuiKey_None. // - Shortcut(ImGuiKey_S | ImGuiMod_Ctrl); // Legal // - Shortcut(ImGuiKey_S | ImGuiMod_Ctrl | ImGuiMod_Shift); // Legal // - Shortcut(ImGuiMod_Ctrl); // Legal // - Shortcut(ImGuiMod_Ctrl | ImGuiMod_Shift); // Not legal ImGuiContext& g = *GImGui; ImGuiKeyRoutingTable* rt = &g.KeysRoutingTable; ImGuiKeyRoutingData* routing_data; ImGuiKey key = (ImGuiKey)(key_chord & ~ImGuiMod_Mask_); ImGuiKey mods = (ImGuiKey)(key_chord & ImGuiMod_Mask_); if (key == ImGuiKey_None) key = ConvertSingleModFlagToKey(mods); IM_ASSERT(IsNamedKey(key)); // Get (in the majority of case, the linked list will have one element so this should be 2 reads. // Subsequent elements will be contiguous in memory as list is sorted/rebuilt in NewFrame). for (ImGuiKeyRoutingIndex idx = rt->Index[key - ImGuiKey_NamedKey_BEGIN]; idx != -1; idx = routing_data->NextEntryIndex) { routing_data = &rt->Entries[idx]; if (routing_data->Mods == mods) return routing_data; } // Add to linked-list ImGuiKeyRoutingIndex routing_data_idx = (ImGuiKeyRoutingIndex)rt->Entries.Size; rt->Entries.push_back(ImGuiKeyRoutingData()); routing_data = &rt->Entries[routing_data_idx]; routing_data->Mods = (ImU16)mods; routing_data->NextEntryIndex = rt->Index[key - ImGuiKey_NamedKey_BEGIN]; // Setup linked list rt->Index[key - ImGuiKey_NamedKey_BEGIN] = routing_data_idx; return routing_data; } // Current score encoding (lower is highest priority): // - 0: ImGuiInputFlags_RouteGlobal | ImGuiInputFlags_RouteOverActive // - 1: ImGuiInputFlags_ActiveItem or ImGuiInputFlags_RouteFocused (if item active) // - 2: ImGuiInputFlags_RouteGlobal | ImGuiInputFlags_RouteOverFocused // - 3+: ImGuiInputFlags_RouteFocused (if window in focus-stack) // - 254: ImGuiInputFlags_RouteGlobal // - 255: never route // 'flags' should include an explicit routing policy static int CalcRoutingScore(ImGuiID focus_scope_id, ImGuiID owner_id, ImGuiInputFlags flags) { ImGuiContext& g = *GImGui; if (flags & ImGuiInputFlags_RouteFocused) { // ActiveID gets top priority // (we don't check g.ActiveIdUsingAllKeys here. Routing is applied but if input ownership is tested later it may discard it) if (owner_id != 0 && g.ActiveId == owner_id) return 1; // Score based on distance to focused window (lower is better) // Assuming both windows are submitting a routing request, // - When Window....... is focused -> Window scores 3 (best), Window/ChildB scores 255 (no match) // - When Window/ChildB is focused -> Window scores 4, Window/ChildB scores 3 (best) // Assuming only WindowA is submitting a routing request, // - When Window/ChildB is focused -> Window scores 4 (best), Window/ChildB doesn't have a score. // This essentially follow the window->ParentWindowForFocusRoute chain. if (focus_scope_id == 0) return 255; for (int index_in_focus_path = 0; index_in_focus_path < g.NavFocusRoute.Size; index_in_focus_path++) if (g.NavFocusRoute.Data[index_in_focus_path].ID == focus_scope_id) return 3 + index_in_focus_path; return 255; } else if (flags & ImGuiInputFlags_RouteActive) { if (owner_id != 0 && g.ActiveId == owner_id) return 1; return 255; } else if (flags & ImGuiInputFlags_RouteGlobal) { if (flags & ImGuiInputFlags_RouteOverActive) return 0; if (flags & ImGuiInputFlags_RouteOverFocused) return 2; return 254; } IM_ASSERT(0); return 0; } // - We need this to filter some Shortcut() routes when an item e.g. an InputText() is active // e.g. ImGuiKey_G won't be considered a shortcut when item is active, but ImGuiMod|ImGuiKey_G can be. // - This is also used by UpdateInputEvents() to avoid trickling in the most common case of e.g. pressing ImGuiKey_G also emitting a G character. static bool IsKeyChordPotentiallyCharInput(ImGuiKeyChord key_chord) { // Mimic 'ignore_char_inputs' logic in InputText() ImGuiContext& g = *GImGui; // When the right mods are pressed it cannot be a char input so we won't filter the shortcut out. ImGuiKey mods = (ImGuiKey)(key_chord & ImGuiMod_Mask_); const bool ignore_char_inputs = ((mods & ImGuiMod_Ctrl) && !(mods & ImGuiMod_Alt)) || (g.IO.ConfigMacOSXBehaviors && (mods & ImGuiMod_Ctrl)); if (ignore_char_inputs) return false; // Return true for A-Z, 0-9 and other keys associated to char inputs. Other keys such as F1-F12 won't be filtered. ImGuiKey key = (ImGuiKey)(key_chord & ~ImGuiMod_Mask_); if (key == ImGuiKey_None) return false; return g.KeysMayBeCharInput.TestBit(key); } // Request a desired route for an input chord (key + mods). // Return true if the route is available this frame. // - Routes and key ownership are attributed at the beginning of next frame based on best score and mod state. // (Conceptually this does a "Submit for next frame" + "Test for current frame". // As such, it could be called TrySetXXX or SubmitXXX, or the Submit and Test operations should be separate.) bool ImGui::SetShortcutRouting(ImGuiKeyChord key_chord, ImGuiInputFlags flags, ImGuiID owner_id) { ImGuiContext& g = *GImGui; if ((flags & ImGuiInputFlags_RouteTypeMask_) == 0) flags |= ImGuiInputFlags_RouteGlobal | ImGuiInputFlags_RouteOverFocused | ImGuiInputFlags_RouteOverActive; // IMPORTANT: This is the default for SetShortcutRouting() but NOT Shortcut() else IM_ASSERT(ImIsPowerOfTwo(flags & ImGuiInputFlags_RouteTypeMask_)); // Check that only 1 routing flag is used IM_ASSERT(owner_id != ImGuiKeyOwner_Any && owner_id != ImGuiKeyOwner_NoOwner); if (flags & (ImGuiInputFlags_RouteOverFocused | ImGuiInputFlags_RouteOverActive | ImGuiInputFlags_RouteUnlessBgFocused)) IM_ASSERT(flags & ImGuiInputFlags_RouteGlobal); // Add ImGuiMod_XXXX when a corresponding ImGuiKey_LeftXXX/ImGuiKey_RightXXX is specified. key_chord = FixupKeyChord(key_chord); // [DEBUG] Debug break requested by user if (g.DebugBreakInShortcutRouting == key_chord) IM_DEBUG_BREAK(); if (flags & ImGuiInputFlags_RouteUnlessBgFocused) if (g.NavWindow == NULL) return false; // Note how ImGuiInputFlags_RouteAlways won't set routing and thus won't set owner. May want to rework this? if (flags & ImGuiInputFlags_RouteAlways) { IMGUI_DEBUG_LOG_INPUTROUTING("SetShortcutRouting(%s, flags=%04X, owner_id=0x%08X) -> always, no register\n", GetKeyChordName(key_chord), flags, owner_id); return true; } // Specific culling when there's an active item. if (g.ActiveId != 0 && g.ActiveId != owner_id) { if (flags & ImGuiInputFlags_RouteActive) return false; // Cull shortcuts with no modifiers when it could generate a character. // e.g. Shortcut(ImGuiKey_G) also generates 'g' character, should not trigger when InputText() is active. // but Shortcut(Ctrl+G) should generally trigger when InputText() is active. // TL;DR: lettered shortcut with no mods or with only Alt mod will not trigger while an item reading text input is active. // (We cannot filter based on io.InputQueueCharacters[] contents because of trickling and key<>chars submission order are undefined) if (g.IO.WantTextInput && IsKeyChordPotentiallyCharInput(key_chord)) { IMGUI_DEBUG_LOG_INPUTROUTING("SetShortcutRouting(%s, flags=%04X, owner_id=0x%08X) -> filtered as potential char input\n", GetKeyChordName(key_chord), flags, owner_id); return false; } // ActiveIdUsingAllKeyboardKeys trumps all for ActiveId if ((flags & ImGuiInputFlags_RouteOverActive) == 0 && g.ActiveIdUsingAllKeyboardKeys) { ImGuiKey key = (ImGuiKey)(key_chord & ~ImGuiMod_Mask_); if (key == ImGuiKey_None) key = ConvertSingleModFlagToKey((ImGuiKey)(key_chord & ImGuiMod_Mask_)); if (key >= ImGuiKey_Keyboard_BEGIN && key < ImGuiKey_Keyboard_END) return false; } } // Where do we evaluate route for? ImGuiID focus_scope_id = g.CurrentFocusScopeId; if (flags & ImGuiInputFlags_RouteFromRootWindow) focus_scope_id = g.CurrentWindow->RootWindow->ID; // See PushFocusScope() call in Begin() const int score = CalcRoutingScore(focus_scope_id, owner_id, flags); IMGUI_DEBUG_LOG_INPUTROUTING("SetShortcutRouting(%s, flags=%04X, owner_id=0x%08X) -> score %d\n", GetKeyChordName(key_chord), flags, owner_id, score); if (score == 255) return false; // Submit routing for NEXT frame (assuming score is sufficient) // FIXME: Could expose a way to use a "serve last" policy for same score resolution (using <= instead of <). ImGuiKeyRoutingData* routing_data = GetShortcutRoutingData(key_chord); //const bool set_route = (flags & ImGuiInputFlags_ServeLast) ? (score <= routing_data->RoutingNextScore) : (score < routing_data->RoutingNextScore); if (score < routing_data->RoutingNextScore) { routing_data->RoutingNext = owner_id; routing_data->RoutingNextScore = (ImU8)score; } // Return routing state for CURRENT frame if (routing_data->RoutingCurr == owner_id) IMGUI_DEBUG_LOG_INPUTROUTING("--> granting current route\n"); return routing_data->RoutingCurr == owner_id; } // Currently unused by core (but used by tests) // Note: this cannot be turned into GetShortcutRouting() because we do the owner_id->routing_id translation, name would be more misleading. bool ImGui::TestShortcutRouting(ImGuiKeyChord key_chord, ImGuiID owner_id) { const ImGuiID routing_id = GetRoutingIdFromOwnerId(owner_id); key_chord = FixupKeyChord(key_chord); ImGuiKeyRoutingData* routing_data = GetShortcutRoutingData(key_chord); // FIXME: Could avoid creating entry. return routing_data->RoutingCurr == routing_id; } // Note that Dear ImGui doesn't know the meaning/semantic of ImGuiKey from 0..511: they are legacy native keycodes. // Consider transitioning from 'IsKeyDown(MY_ENGINE_KEY_A)' (<1.87) to IsKeyDown(ImGuiKey_A) (>= 1.87) bool ImGui::IsKeyDown(ImGuiKey key) { return IsKeyDown(key, ImGuiKeyOwner_Any); } bool ImGui::IsKeyDown(ImGuiKey key, ImGuiID owner_id) { const ImGuiKeyData* key_data = GetKeyData(key); if (!key_data->Down) return false; if (!TestKeyOwner(key, owner_id)) return false; return true; } bool ImGui::IsKeyPressed(ImGuiKey key, bool repeat) { return IsKeyPressed(key, repeat ? ImGuiInputFlags_Repeat : ImGuiInputFlags_None, ImGuiKeyOwner_Any); } // Important: unlike legacy IsKeyPressed(ImGuiKey, bool repeat=true) which DEFAULT to repeat, this requires EXPLICIT repeat. bool ImGui::IsKeyPressed(ImGuiKey key, ImGuiInputFlags flags, ImGuiID owner_id) { const ImGuiKeyData* key_data = GetKeyData(key); if (!key_data->Down) // In theory this should already be encoded as (DownDuration < 0.0f), but testing this facilitates eating mechanism (until we finish work on key ownership) return false; const float t = key_data->DownDuration; if (t < 0.0f) return false; IM_ASSERT((flags & ~ImGuiInputFlags_SupportedByIsKeyPressed) == 0); // Passing flags not supported by this function! if (flags & (ImGuiInputFlags_RepeatRateMask_ | ImGuiInputFlags_RepeatUntilMask_)) // Setting any _RepeatXXX option enables _Repeat flags |= ImGuiInputFlags_Repeat; bool pressed = (t == 0.0f); if (!pressed && (flags & ImGuiInputFlags_Repeat) != 0) { float repeat_delay, repeat_rate; GetTypematicRepeatRate(flags, &repeat_delay, &repeat_rate); pressed = (t > repeat_delay) && GetKeyPressedAmount(key, repeat_delay, repeat_rate) > 0; if (pressed && (flags & ImGuiInputFlags_RepeatUntilMask_)) { // Slightly bias 'key_pressed_time' as DownDuration is an accumulation of DeltaTime which we compare to an absolute time value. // Ideally we'd replace DownDuration with KeyPressedTime but it would break user's code. ImGuiContext& g = *GImGui; double key_pressed_time = g.Time - t + 0.00001f; if ((flags & ImGuiInputFlags_RepeatUntilKeyModsChange) && (g.LastKeyModsChangeTime > key_pressed_time)) pressed = false; if ((flags & ImGuiInputFlags_RepeatUntilKeyModsChangeFromNone) && (g.LastKeyModsChangeFromNoneTime > key_pressed_time)) pressed = false; if ((flags & ImGuiInputFlags_RepeatUntilOtherKeyPress) && (g.LastKeyboardKeyPressTime > key_pressed_time)) pressed = false; } } if (!pressed) return false; if (!TestKeyOwner(key, owner_id)) return false; return true; } bool ImGui::IsKeyReleased(ImGuiKey key) { return IsKeyReleased(key, ImGuiKeyOwner_Any); } bool ImGui::IsKeyReleased(ImGuiKey key, ImGuiID owner_id) { const ImGuiKeyData* key_data = GetKeyData(key); if (key_data->DownDurationPrev < 0.0f || key_data->Down) return false; if (!TestKeyOwner(key, owner_id)) return false; return true; } bool ImGui::IsMouseDown(ImGuiMouseButton button) { ImGuiContext& g = *GImGui; IM_ASSERT(button >= 0 && button < IM_ARRAYSIZE(g.IO.MouseDown)); return g.IO.MouseDown[button] && TestKeyOwner(MouseButtonToKey(button), ImGuiKeyOwner_Any); // should be same as IsKeyDown(MouseButtonToKey(button), ImGuiKeyOwner_Any), but this allows legacy code hijacking the io.Mousedown[] array. } bool ImGui::IsMouseDown(ImGuiMouseButton button, ImGuiID owner_id) { ImGuiContext& g = *GImGui; IM_ASSERT(button >= 0 && button < IM_ARRAYSIZE(g.IO.MouseDown)); return g.IO.MouseDown[button] && TestKeyOwner(MouseButtonToKey(button), owner_id); // Should be same as IsKeyDown(MouseButtonToKey(button), owner_id), but this allows legacy code hijacking the io.Mousedown[] array. } bool ImGui::IsMouseClicked(ImGuiMouseButton button, bool repeat) { return IsMouseClicked(button, repeat ? ImGuiInputFlags_Repeat : ImGuiInputFlags_None, ImGuiKeyOwner_Any); } bool ImGui::IsMouseClicked(ImGuiMouseButton button, ImGuiInputFlags flags, ImGuiID owner_id) { ImGuiContext& g = *GImGui; IM_ASSERT(button >= 0 && button < IM_ARRAYSIZE(g.IO.MouseDown)); if (!g.IO.MouseDown[button]) // In theory this should already be encoded as (DownDuration < 0.0f), but testing this facilitates eating mechanism (until we finish work on key ownership) return false; const float t = g.IO.MouseDownDuration[button]; if (t < 0.0f) return false; IM_ASSERT((flags & ~ImGuiInputFlags_SupportedByIsMouseClicked) == 0); // Passing flags not supported by this function! // FIXME: Could support RepeatRate and RepeatUntil flags here. const bool repeat = (flags & ImGuiInputFlags_Repeat) != 0; const bool pressed = (t == 0.0f) || (repeat && t > g.IO.KeyRepeatDelay && CalcTypematicRepeatAmount(t - g.IO.DeltaTime, t, g.IO.KeyRepeatDelay, g.IO.KeyRepeatRate) > 0); if (!pressed) return false; if (!TestKeyOwner(MouseButtonToKey(button), owner_id)) return false; return true; } bool ImGui::IsMouseReleased(ImGuiMouseButton button) { ImGuiContext& g = *GImGui; IM_ASSERT(button >= 0 && button < IM_ARRAYSIZE(g.IO.MouseDown)); return g.IO.MouseReleased[button] && TestKeyOwner(MouseButtonToKey(button), ImGuiKeyOwner_Any); // Should be same as IsKeyReleased(MouseButtonToKey(button), ImGuiKeyOwner_Any) } bool ImGui::IsMouseReleased(ImGuiMouseButton button, ImGuiID owner_id) { ImGuiContext& g = *GImGui; IM_ASSERT(button >= 0 && button < IM_ARRAYSIZE(g.IO.MouseDown)); return g.IO.MouseReleased[button] && TestKeyOwner(MouseButtonToKey(button), owner_id); // Should be same as IsKeyReleased(MouseButtonToKey(button), owner_id) } // Use if you absolutely need to distinguish single-click from double-click by introducing a delay. // Generally use with 'delay >= io.MouseDoubleClickTime' + combined with a 'io.MouseClickedLastCount == 1' test. // This is a very rarely used UI idiom, but some apps use this: e.g. MS Explorer single click on an icon to rename. bool ImGui::IsMouseReleasedWithDelay(ImGuiMouseButton button, float delay) { ImGuiContext& g = *GImGui; IM_ASSERT(button >= 0 && button < IM_ARRAYSIZE(g.IO.MouseDown)); const float time_since_release = (float)(g.Time - g.IO.MouseReleasedTime[button]); return !IsMouseDown(button) && (time_since_release - g.IO.DeltaTime < delay) && (time_since_release >= delay); } bool ImGui::IsMouseDoubleClicked(ImGuiMouseButton button) { ImGuiContext& g = *GImGui; IM_ASSERT(button >= 0 && button < IM_ARRAYSIZE(g.IO.MouseDown)); return g.IO.MouseClickedCount[button] == 2 && TestKeyOwner(MouseButtonToKey(button), ImGuiKeyOwner_Any); } bool ImGui::IsMouseDoubleClicked(ImGuiMouseButton button, ImGuiID owner_id) { ImGuiContext& g = *GImGui; IM_ASSERT(button >= 0 && button < IM_ARRAYSIZE(g.IO.MouseDown)); return g.IO.MouseClickedCount[button] == 2 && TestKeyOwner(MouseButtonToKey(button), owner_id); } int ImGui::GetMouseClickedCount(ImGuiMouseButton button) { ImGuiContext& g = *GImGui; IM_ASSERT(button >= 0 && button < IM_ARRAYSIZE(g.IO.MouseDown)); return g.IO.MouseClickedCount[button]; } // Test if mouse cursor is hovering given rectangle // NB- Rectangle is clipped by our current clip setting // NB- Expand the rectangle to be generous on imprecise inputs systems (g.Style.TouchExtraPadding) bool ImGui::IsMouseHoveringRect(const ImVec2& r_min, const ImVec2& r_max, bool clip) { ImGuiContext& g = *GImGui; // Clip ImRect rect_clipped(r_min, r_max); if (clip) rect_clipped.ClipWith(g.CurrentWindow->ClipRect); // Hit testing, expanded for touch input if (!rect_clipped.ContainsWithPad(g.IO.MousePos, g.Style.TouchExtraPadding)) return false; return true; } // Return if a mouse click/drag went past the given threshold. Valid to call during the MouseReleased frame. // [Internal] This doesn't test if the button is pressed bool ImGui::IsMouseDragPastThreshold(ImGuiMouseButton button, float lock_threshold) { ImGuiContext& g = *GImGui; IM_ASSERT(button >= 0 && button < IM_ARRAYSIZE(g.IO.MouseDown)); if (lock_threshold < 0.0f) lock_threshold = g.IO.MouseDragThreshold; return g.IO.MouseDragMaxDistanceSqr[button] >= lock_threshold * lock_threshold; } bool ImGui::IsMouseDragging(ImGuiMouseButton button, float lock_threshold) { ImGuiContext& g = *GImGui; IM_ASSERT(button >= 0 && button < IM_ARRAYSIZE(g.IO.MouseDown)); if (!g.IO.MouseDown[button]) return false; return IsMouseDragPastThreshold(button, lock_threshold); } ImVec2 ImGui::GetMousePos() { ImGuiContext& g = *GImGui; return g.IO.MousePos; } // This is called TeleportMousePos() and not SetMousePos() to emphasis that setting MousePosPrev will effectively clear mouse delta as well. // It is expected you only call this if (io.BackendFlags & ImGuiBackendFlags_HasSetMousePos) is set and supported by backend. void ImGui::TeleportMousePos(const ImVec2& pos) { ImGuiContext& g = *GImGui; g.IO.MousePos = g.IO.MousePosPrev = pos; g.IO.MouseDelta = ImVec2(0.0f, 0.0f); g.IO.WantSetMousePos = true; //IMGUI_DEBUG_LOG_IO("TeleportMousePos: (%.1f,%.1f)\n", io.MousePos.x, io.MousePos.y); } // NB: prefer to call right after BeginPopup(). At the time Selectable/MenuItem is activated, the popup is already closed! ImVec2 ImGui::GetMousePosOnOpeningCurrentPopup() { ImGuiContext& g = *GImGui; if (g.BeginPopupStack.Size > 0) return g.OpenPopupStack[g.BeginPopupStack.Size - 1].OpenMousePos; return g.IO.MousePos; } // We typically use ImVec2(-FLT_MAX,-FLT_MAX) to denote an invalid mouse position. bool ImGui::IsMousePosValid(const ImVec2* mouse_pos) { // The assert is only to silence a false-positive in XCode Static Analysis. // Because GImGui is not dereferenced in every code path, the static analyzer assume that it may be NULL (which it doesn't for other functions). IM_ASSERT(GImGui != NULL); const float MOUSE_INVALID = -256000.0f; ImVec2 p = mouse_pos ? *mouse_pos : GImGui->IO.MousePos; return p.x >= MOUSE_INVALID && p.y >= MOUSE_INVALID; } // [WILL OBSOLETE] This was designed for backends, but prefer having backend maintain a mask of held mouse buttons, because upcoming input queue system will make this invalid. bool ImGui::IsAnyMouseDown() { ImGuiContext& g = *GImGui; for (int n = 0; n < IM_ARRAYSIZE(g.IO.MouseDown); n++) if (g.IO.MouseDown[n]) return true; return false; } // Return the delta from the initial clicking position while the mouse button is clicked or was just released. // This is locked and return 0.0f until the mouse moves past a distance threshold at least once. // NB: This is only valid if IsMousePosValid(). backends in theory should always keep mouse position valid when dragging even outside the client window. ImVec2 ImGui::GetMouseDragDelta(ImGuiMouseButton button, float lock_threshold) { ImGuiContext& g = *GImGui; IM_ASSERT(button >= 0 && button < IM_ARRAYSIZE(g.IO.MouseDown)); if (lock_threshold < 0.0f) lock_threshold = g.IO.MouseDragThreshold; if (g.IO.MouseDown[button] || g.IO.MouseReleased[button]) if (g.IO.MouseDragMaxDistanceSqr[button] >= lock_threshold * lock_threshold) if (IsMousePosValid(&g.IO.MousePos) && IsMousePosValid(&g.IO.MouseClickedPos[button])) return g.IO.MousePos - g.IO.MouseClickedPos[button]; return ImVec2(0.0f, 0.0f); } void ImGui::ResetMouseDragDelta(ImGuiMouseButton button) { ImGuiContext& g = *GImGui; IM_ASSERT(button >= 0 && button < IM_ARRAYSIZE(g.IO.MouseDown)); // NB: We don't need to reset g.IO.MouseDragMaxDistanceSqr g.IO.MouseClickedPos[button] = g.IO.MousePos; } // Get desired mouse cursor shape. // Important: this is meant to be used by a platform backend, it is reset in ImGui::NewFrame(), // updated during the frame, and locked in EndFrame()/Render(). // If you use software rendering by setting io.MouseDrawCursor then Dear ImGui will render those for you ImGuiMouseCursor ImGui::GetMouseCursor() { ImGuiContext& g = *GImGui; return g.MouseCursor; } // We intentionally accept values of ImGuiMouseCursor that are outside our bounds, in case users needs to hack-in a custom cursor value. // Custom cursors may be handled by custom backends. If you are using a standard backend and want to hack in a custom cursor, you may // handle it before the backend _NewFrame() call and temporarily set ImGuiConfigFlags_NoMouseCursorChange during the backend _NewFrame() call. void ImGui::SetMouseCursor(ImGuiMouseCursor cursor_type) { ImGuiContext& g = *GImGui; g.MouseCursor = cursor_type; } static void UpdateAliasKey(ImGuiKey key, bool v, float analog_value) { IM_ASSERT(ImGui::IsAliasKey(key)); ImGuiKeyData* key_data = ImGui::GetKeyData(key); key_data->Down = v; key_data->AnalogValue = analog_value; } // [Internal] Do not use directly static ImGuiKeyChord GetMergedModsFromKeys() { ImGuiKeyChord mods = 0; if (ImGui::IsKeyDown(ImGuiMod_Ctrl)) { mods |= ImGuiMod_Ctrl; } if (ImGui::IsKeyDown(ImGuiMod_Shift)) { mods |= ImGuiMod_Shift; } if (ImGui::IsKeyDown(ImGuiMod_Alt)) { mods |= ImGuiMod_Alt; } if (ImGui::IsKeyDown(ImGuiMod_Super)) { mods |= ImGuiMod_Super; } return mods; } static void ImGui::UpdateKeyboardInputs() { ImGuiContext& g = *GImGui; ImGuiIO& io = g.IO; if (io.ConfigFlags & ImGuiConfigFlags_NoKeyboard) io.ClearInputKeys(); // Update aliases for (int n = 0; n < ImGuiMouseButton_COUNT; n++) UpdateAliasKey(MouseButtonToKey(n), io.MouseDown[n], io.MouseDown[n] ? 1.0f : 0.0f); UpdateAliasKey(ImGuiKey_MouseWheelX, io.MouseWheelH != 0.0f, io.MouseWheelH); UpdateAliasKey(ImGuiKey_MouseWheelY, io.MouseWheel != 0.0f, io.MouseWheel); // Synchronize io.KeyMods and io.KeyCtrl/io.KeyShift/etc. values. // - New backends (1.87+): send io.AddKeyEvent(ImGuiMod_XXX) -> -> (here) deriving io.KeyMods + io.KeyXXX from key array. // - Legacy backends: set io.KeyXXX bools -> (above) set key array from io.KeyXXX -> (here) deriving io.KeyMods + io.KeyXXX from key array. // So with legacy backends the 4 values will do a unnecessary back-and-forth but it makes the code simpler and future facing. const ImGuiKeyChord prev_key_mods = io.KeyMods; io.KeyMods = GetMergedModsFromKeys(); io.KeyCtrl = (io.KeyMods & ImGuiMod_Ctrl) != 0; io.KeyShift = (io.KeyMods & ImGuiMod_Shift) != 0; io.KeyAlt = (io.KeyMods & ImGuiMod_Alt) != 0; io.KeySuper = (io.KeyMods & ImGuiMod_Super) != 0; if (prev_key_mods != io.KeyMods) g.LastKeyModsChangeTime = g.Time; if (prev_key_mods != io.KeyMods && prev_key_mods == 0) g.LastKeyModsChangeFromNoneTime = g.Time; // Clear gamepad data if disabled if ((io.BackendFlags & ImGuiBackendFlags_HasGamepad) == 0) for (int key = ImGuiKey_Gamepad_BEGIN; key < ImGuiKey_Gamepad_END; key++) { io.KeysData[key - ImGuiKey_NamedKey_BEGIN].Down = false; io.KeysData[key - ImGuiKey_NamedKey_BEGIN].AnalogValue = 0.0f; } // Update keys for (int key = ImGuiKey_NamedKey_BEGIN; key < ImGuiKey_NamedKey_END; key++) { ImGuiKeyData* key_data = &io.KeysData[key - ImGuiKey_NamedKey_BEGIN]; key_data->DownDurationPrev = key_data->DownDuration; key_data->DownDuration = key_data->Down ? (key_data->DownDuration < 0.0f ? 0.0f : key_data->DownDuration + io.DeltaTime) : -1.0f; if (key_data->DownDuration == 0.0f) { if (IsKeyboardKey((ImGuiKey)key)) g.LastKeyboardKeyPressTime = g.Time; else if (key == ImGuiKey_ReservedForModCtrl || key == ImGuiKey_ReservedForModShift || key == ImGuiKey_ReservedForModAlt || key == ImGuiKey_ReservedForModSuper) g.LastKeyboardKeyPressTime = g.Time; } } // Update keys/input owner (named keys only): one entry per key for (ImGuiKey key = ImGuiKey_NamedKey_BEGIN; key < ImGuiKey_NamedKey_END; key = (ImGuiKey)(key + 1)) { ImGuiKeyData* key_data = &io.KeysData[key - ImGuiKey_NamedKey_BEGIN]; ImGuiKeyOwnerData* owner_data = &g.KeysOwnerData[key - ImGuiKey_NamedKey_BEGIN]; owner_data->OwnerCurr = owner_data->OwnerNext; if (!key_data->Down) // Important: ownership is released on the frame after a release. Ensure a 'MouseDown -> CloseWindow -> MouseUp' chain doesn't lead to someone else seeing the MouseUp. owner_data->OwnerNext = ImGuiKeyOwner_NoOwner; owner_data->LockThisFrame = owner_data->LockUntilRelease = owner_data->LockUntilRelease && key_data->Down; // Clear LockUntilRelease when key is not Down anymore } // Update key routing (for e.g. shortcuts) UpdateKeyRoutingTable(&g.KeysRoutingTable); } static void ImGui::UpdateMouseInputs() { ImGuiContext& g = *GImGui; ImGuiIO& io = g.IO; // Mouse Wheel swapping flag // As a standard behavior holding SHIFT while using Vertical Mouse Wheel triggers Horizontal scroll instead // - We avoid doing it on OSX as it the OS input layer handles this already. // - FIXME: However this means when running on OSX over Emscripten, Shift+WheelY will incur two swapping (1 in OS, 1 here), canceling the feature. // - FIXME: When we can distinguish e.g. touchpad scroll events from mouse ones, we'll set this accordingly based on input source. io.MouseWheelRequestAxisSwap = io.KeyShift && !io.ConfigMacOSXBehaviors; // Round mouse position to avoid spreading non-rounded position (e.g. UpdateManualResize doesn't support them well) if (IsMousePosValid(&io.MousePos)) io.MousePos = g.MouseLastValidPos = ImFloor(io.MousePos); // If mouse just appeared or disappeared (usually denoted by -FLT_MAX components) we cancel out movement in MouseDelta if (IsMousePosValid(&io.MousePos) && IsMousePosValid(&io.MousePosPrev)) io.MouseDelta = io.MousePos - io.MousePosPrev; else io.MouseDelta = ImVec2(0.0f, 0.0f); // Update stationary timer. // FIXME: May need to rework again to have some tolerance for occasional small movement, while being functional on high-framerates. const float mouse_stationary_threshold = (io.MouseSource == ImGuiMouseSource_Mouse) ? 2.0f : 3.0f; // Slightly higher threshold for ImGuiMouseSource_TouchScreen/ImGuiMouseSource_Pen, may need rework. const bool mouse_stationary = (ImLengthSqr(io.MouseDelta) <= mouse_stationary_threshold * mouse_stationary_threshold); g.MouseStationaryTimer = mouse_stationary ? (g.MouseStationaryTimer + io.DeltaTime) : 0.0f; //IMGUI_DEBUG_LOG("%.4f\n", g.MouseStationaryTimer); // If mouse moved we re-enable mouse hovering in case it was disabled by keyboard/gamepad. In theory should use a >0.0f threshold but would need to reset in everywhere we set this to true. if (io.MouseDelta.x != 0.0f || io.MouseDelta.y != 0.0f) g.NavHighlightItemUnderNav = false; for (int i = 0; i < IM_ARRAYSIZE(io.MouseDown); i++) { io.MouseClicked[i] = io.MouseDown[i] && io.MouseDownDuration[i] < 0.0f; io.MouseClickedCount[i] = 0; // Will be filled below io.MouseReleased[i] = !io.MouseDown[i] && io.MouseDownDuration[i] >= 0.0f; if (io.MouseReleased[i]) io.MouseReleasedTime[i] = g.Time; io.MouseDownDurationPrev[i] = io.MouseDownDuration[i]; io.MouseDownDuration[i] = io.MouseDown[i] ? (io.MouseDownDuration[i] < 0.0f ? 0.0f : io.MouseDownDuration[i] + io.DeltaTime) : -1.0f; if (io.MouseClicked[i]) { bool is_repeated_click = false; if ((float)(g.Time - io.MouseClickedTime[i]) < io.MouseDoubleClickTime) { ImVec2 delta_from_click_pos = IsMousePosValid(&io.MousePos) ? (io.MousePos - io.MouseClickedPos[i]) : ImVec2(0.0f, 0.0f); if (ImLengthSqr(delta_from_click_pos) < io.MouseDoubleClickMaxDist * io.MouseDoubleClickMaxDist) is_repeated_click = true; } if (is_repeated_click) io.MouseClickedLastCount[i]++; else io.MouseClickedLastCount[i] = 1; io.MouseClickedTime[i] = g.Time; io.MouseClickedPos[i] = io.MousePos; io.MouseClickedCount[i] = io.MouseClickedLastCount[i]; io.MouseDragMaxDistanceSqr[i] = 0.0f; } else if (io.MouseDown[i]) { // Maintain the maximum distance we reaching from the initial click position, which is used with dragging threshold float delta_sqr_click_pos = IsMousePosValid(&io.MousePos) ? ImLengthSqr(io.MousePos - io.MouseClickedPos[i]) : 0.0f; io.MouseDragMaxDistanceSqr[i] = ImMax(io.MouseDragMaxDistanceSqr[i], delta_sqr_click_pos); } // We provide io.MouseDoubleClicked[] as a legacy service io.MouseDoubleClicked[i] = (io.MouseClickedCount[i] == 2); // Clicking any mouse button reactivate mouse hovering which may have been deactivated by keyboard/gamepad navigation if (io.MouseClicked[i]) g.NavHighlightItemUnderNav = false; } } static void LockWheelingWindow(ImGuiWindow* window, float wheel_amount) { ImGuiContext& g = *GImGui; if (window) g.WheelingWindowReleaseTimer = ImMin(g.WheelingWindowReleaseTimer + ImAbs(wheel_amount) * WINDOWS_MOUSE_WHEEL_SCROLL_LOCK_TIMER, WINDOWS_MOUSE_WHEEL_SCROLL_LOCK_TIMER); else g.WheelingWindowReleaseTimer = 0.0f; if (g.WheelingWindow == window) return; IMGUI_DEBUG_LOG_IO("[io] LockWheelingWindow() \"%s\"\n", window ? window->Name : "NULL"); g.WheelingWindow = window; g.WheelingWindowRefMousePos = g.IO.MousePos; if (window == NULL) { g.WheelingWindowStartFrame = -1; g.WheelingAxisAvg = ImVec2(0.0f, 0.0f); } } static ImGuiWindow* FindBestWheelingWindow(const ImVec2& wheel) { // For each axis, find window in the hierarchy that may want to use scrolling ImGuiContext& g = *GImGui; ImGuiWindow* windows[2] = { NULL, NULL }; for (int axis = 0; axis < 2; axis++) if (wheel[axis] != 0.0f) for (ImGuiWindow* window = windows[axis] = g.HoveredWindow; window->Flags & ImGuiWindowFlags_ChildWindow; window = windows[axis] = window->ParentWindow) { // Bubble up into parent window if: // - a child window doesn't allow any scrolling. // - a child window has the ImGuiWindowFlags_NoScrollWithMouse flag. //// - a child window doesn't need scrolling because it is already at the edge for the direction we are going in (FIXME-WIP) const bool has_scrolling = (window->ScrollMax[axis] != 0.0f); const bool inputs_disabled = (window->Flags & ImGuiWindowFlags_NoScrollWithMouse) && !(window->Flags & ImGuiWindowFlags_NoMouseInputs); //const bool scrolling_past_limits = (wheel_v < 0.0f) ? (window->Scroll[axis] <= 0.0f) : (window->Scroll[axis] >= window->ScrollMax[axis]); if (has_scrolling && !inputs_disabled) // && !scrolling_past_limits) break; // select this window } if (windows[0] == NULL && windows[1] == NULL) return NULL; // If there's only one window or only one axis then there's no ambiguity if (windows[0] == windows[1] || windows[0] == NULL || windows[1] == NULL) return windows[1] ? windows[1] : windows[0]; // If candidate are different windows we need to decide which one to prioritize // - First frame: only find a winner if one axis is zero. // - Subsequent frames: only find a winner when one is more than the other. if (g.WheelingWindowStartFrame == -1) g.WheelingWindowStartFrame = g.FrameCount; if ((g.WheelingWindowStartFrame == g.FrameCount && wheel.x != 0.0f && wheel.y != 0.0f) || (g.WheelingAxisAvg.x == g.WheelingAxisAvg.y)) { g.WheelingWindowWheelRemainder = wheel; return NULL; } return (g.WheelingAxisAvg.x > g.WheelingAxisAvg.y) ? windows[0] : windows[1]; } // Called by NewFrame() void ImGui::UpdateMouseWheel() { // Reset the locked window if we move the mouse or after the timer elapses. // FIXME: Ideally we could refactor to have one timer for "changing window w/ same axis" and a shorter timer for "changing window or axis w/ other axis" (#3795) ImGuiContext& g = *GImGui; if (g.WheelingWindow != NULL) { g.WheelingWindowReleaseTimer -= g.IO.DeltaTime; if (IsMousePosValid() && ImLengthSqr(g.IO.MousePos - g.WheelingWindowRefMousePos) > g.IO.MouseDragThreshold * g.IO.MouseDragThreshold) g.WheelingWindowReleaseTimer = 0.0f; if (g.WheelingWindowReleaseTimer <= 0.0f) LockWheelingWindow(NULL, 0.0f); } ImVec2 wheel; wheel.x = TestKeyOwner(ImGuiKey_MouseWheelX, ImGuiKeyOwner_NoOwner) ? g.IO.MouseWheelH : 0.0f; wheel.y = TestKeyOwner(ImGuiKey_MouseWheelY, ImGuiKeyOwner_NoOwner) ? g.IO.MouseWheel : 0.0f; //IMGUI_DEBUG_LOG("MouseWheel X:%.3f Y:%.3f\n", wheel_x, wheel_y); ImGuiWindow* mouse_window = g.WheelingWindow ? g.WheelingWindow : g.HoveredWindow; if (!mouse_window || mouse_window->Collapsed) return; // Zoom / Scale window // FIXME-OBSOLETE: This is an old feature, it still works but pretty much nobody is using it and may be best redesigned. if (wheel.y != 0.0f && g.IO.KeyCtrl && g.IO.FontAllowUserScaling) { LockWheelingWindow(mouse_window, wheel.y); ImGuiWindow* window = mouse_window; const float new_font_scale = ImClamp(window->FontWindowScale + g.IO.MouseWheel * 0.10f, 0.50f, 2.50f); const float scale = new_font_scale / window->FontWindowScale; window->FontWindowScale = new_font_scale; if (window == window->RootWindow) { const ImVec2 offset = window->Size * (1.0f - scale) * (g.IO.MousePos - window->Pos) / window->Size; SetWindowPos(window, window->Pos + offset, 0); window->Size = ImTrunc(window->Size * scale); window->SizeFull = ImTrunc(window->SizeFull * scale); } return; } if (g.IO.KeyCtrl) return; // Mouse wheel scrolling // Read about io.MouseWheelRequestAxisSwap and its issue on Mac+Emscripten in UpdateMouseInputs() if (g.IO.MouseWheelRequestAxisSwap) wheel = ImVec2(wheel.y, 0.0f); // Maintain a rough average of moving magnitude on both axes // FIXME: should by based on wall clock time rather than frame-counter g.WheelingAxisAvg.x = ImExponentialMovingAverage(g.WheelingAxisAvg.x, ImAbs(wheel.x), 30); g.WheelingAxisAvg.y = ImExponentialMovingAverage(g.WheelingAxisAvg.y, ImAbs(wheel.y), 30); // In the rare situation where FindBestWheelingWindow() had to defer first frame of wheeling due to ambiguous main axis, reinject it now. wheel += g.WheelingWindowWheelRemainder; g.WheelingWindowWheelRemainder = ImVec2(0.0f, 0.0f); if (wheel.x == 0.0f && wheel.y == 0.0f) return; // Mouse wheel scrolling: find target and apply // - don't renew lock if axis doesn't apply on the window. // - select a main axis when both axes are being moved. if (ImGuiWindow* window = (g.WheelingWindow ? g.WheelingWindow : FindBestWheelingWindow(wheel))) if (!(window->Flags & ImGuiWindowFlags_NoScrollWithMouse) && !(window->Flags & ImGuiWindowFlags_NoMouseInputs)) { bool do_scroll[2] = { wheel.x != 0.0f && window->ScrollMax.x != 0.0f, wheel.y != 0.0f && window->ScrollMax.y != 0.0f }; if (do_scroll[ImGuiAxis_X] && do_scroll[ImGuiAxis_Y]) do_scroll[(g.WheelingAxisAvg.x > g.WheelingAxisAvg.y) ? ImGuiAxis_Y : ImGuiAxis_X] = false; if (do_scroll[ImGuiAxis_X]) { LockWheelingWindow(window, wheel.x); float max_step = window->InnerRect.GetWidth() * 0.67f; float scroll_step = ImTrunc(ImMin(2 * window->FontRefSize, max_step)); SetScrollX(window, window->Scroll.x - wheel.x * scroll_step); g.WheelingWindowScrolledFrame = g.FrameCount; } if (do_scroll[ImGuiAxis_Y]) { LockWheelingWindow(window, wheel.y); float max_step = window->InnerRect.GetHeight() * 0.67f; float scroll_step = ImTrunc(ImMin(5 * window->FontRefSize, max_step)); SetScrollY(window, window->Scroll.y - wheel.y * scroll_step); g.WheelingWindowScrolledFrame = g.FrameCount; } } } void ImGui::SetNextFrameWantCaptureKeyboard(bool want_capture_keyboard) { ImGuiContext& g = *GImGui; g.WantCaptureKeyboardNextFrame = want_capture_keyboard ? 1 : 0; } void ImGui::SetNextFrameWantCaptureMouse(bool want_capture_mouse) { ImGuiContext& g = *GImGui; g.WantCaptureMouseNextFrame = want_capture_mouse ? 1 : 0; } #ifndef IMGUI_DISABLE_DEBUG_TOOLS static const char* GetInputSourceName(ImGuiInputSource source) { const char* input_source_names[] = { "None", "Mouse", "Keyboard", "Gamepad" }; IM_ASSERT(IM_ARRAYSIZE(input_source_names) == ImGuiInputSource_COUNT && source >= 0 && source < ImGuiInputSource_COUNT); return input_source_names[source]; } static const char* GetMouseSourceName(ImGuiMouseSource source) { const char* mouse_source_names[] = { "Mouse", "TouchScreen", "Pen" }; IM_ASSERT(IM_ARRAYSIZE(mouse_source_names) == ImGuiMouseSource_COUNT && source >= 0 && source < ImGuiMouseSource_COUNT); return mouse_source_names[source]; } static void DebugPrintInputEvent(const char* prefix, const ImGuiInputEvent* e) { ImGuiContext& g = *GImGui; if (e->Type == ImGuiInputEventType_MousePos) { if (e->MousePos.PosX == -FLT_MAX && e->MousePos.PosY == -FLT_MAX) IMGUI_DEBUG_LOG_IO("[io] %s: MousePos (-FLT_MAX, -FLT_MAX)\n", prefix); else IMGUI_DEBUG_LOG_IO("[io] %s: MousePos (%.1f, %.1f) (%s)\n", prefix, e->MousePos.PosX, e->MousePos.PosY, GetMouseSourceName(e->MousePos.MouseSource)); return; } if (e->Type == ImGuiInputEventType_MouseButton) { IMGUI_DEBUG_LOG_IO("[io] %s: MouseButton %d %s (%s)\n", prefix, e->MouseButton.Button, e->MouseButton.Down ? "Down" : "Up", GetMouseSourceName(e->MouseButton.MouseSource)); return; } if (e->Type == ImGuiInputEventType_MouseWheel) { IMGUI_DEBUG_LOG_IO("[io] %s: MouseWheel (%.3f, %.3f) (%s)\n", prefix, e->MouseWheel.WheelX, e->MouseWheel.WheelY, GetMouseSourceName(e->MouseWheel.MouseSource)); return; } if (e->Type == ImGuiInputEventType_Key) { IMGUI_DEBUG_LOG_IO("[io] %s: Key \"%s\" %s\n", prefix, ImGui::GetKeyName(e->Key.Key), e->Key.Down ? "Down" : "Up"); return; } if (e->Type == ImGuiInputEventType_Text) { IMGUI_DEBUG_LOG_IO("[io] %s: Text: %c (U+%08X)\n", prefix, e->Text.Char, e->Text.Char); return; } if (e->Type == ImGuiInputEventType_Focus) { IMGUI_DEBUG_LOG_IO("[io] %s: AppFocused %d\n", prefix, e->AppFocused.Focused); return; } } #endif // Process input queue // We always call this with the value of 'bool g.IO.ConfigInputTrickleEventQueue'. // - trickle_fast_inputs = false : process all events, turn into flattened input state (e.g. successive down/up/down/up will be lost) // - trickle_fast_inputs = true : process as many events as possible (successive down/up/down/up will be trickled over several frames so nothing is lost) (new feature in 1.87) void ImGui::UpdateInputEvents(bool trickle_fast_inputs) { ImGuiContext& g = *GImGui; ImGuiIO& io = g.IO; // Only trickle chars<>key when working with InputText() // FIXME: InputText() could parse event trail? // FIXME: Could specialize chars<>keys trickling rules for control keys (those not typically associated to characters) const bool trickle_interleaved_nonchar_keys_and_text = (trickle_fast_inputs && g.WantTextInputNextFrame == 1); bool mouse_moved = false, mouse_wheeled = false, key_changed = false, key_changed_nonchar = false, text_inputted = false; int mouse_button_changed = 0x00; ImBitArray key_changed_mask; int event_n = 0; for (; event_n < g.InputEventsQueue.Size; event_n++) { ImGuiInputEvent* e = &g.InputEventsQueue[event_n]; if (e->Type == ImGuiInputEventType_MousePos) { if (g.IO.WantSetMousePos) continue; // Trickling Rule: Stop processing queued events if we already handled a mouse button change ImVec2 event_pos(e->MousePos.PosX, e->MousePos.PosY); if (trickle_fast_inputs && (mouse_button_changed != 0 || mouse_wheeled || key_changed || text_inputted)) break; io.MousePos = event_pos; io.MouseSource = e->MousePos.MouseSource; mouse_moved = true; } else if (e->Type == ImGuiInputEventType_MouseButton) { // Trickling Rule: Stop processing queued events if we got multiple action on the same button const ImGuiMouseButton button = e->MouseButton.Button; IM_ASSERT(button >= 0 && button < ImGuiMouseButton_COUNT); if (trickle_fast_inputs && ((mouse_button_changed & (1 << button)) || mouse_wheeled)) break; if (trickle_fast_inputs && e->MouseButton.MouseSource == ImGuiMouseSource_TouchScreen && mouse_moved) // #2702: TouchScreen have no initial hover. break; io.MouseDown[button] = e->MouseButton.Down; io.MouseSource = e->MouseButton.MouseSource; mouse_button_changed |= (1 << button); } else if (e->Type == ImGuiInputEventType_MouseWheel) { // Trickling Rule: Stop processing queued events if we got multiple action on the event if (trickle_fast_inputs && (mouse_moved || mouse_button_changed != 0)) break; io.MouseWheelH += e->MouseWheel.WheelX; io.MouseWheel += e->MouseWheel.WheelY; io.MouseSource = e->MouseWheel.MouseSource; mouse_wheeled = true; } else if (e->Type == ImGuiInputEventType_Key) { // Trickling Rule: Stop processing queued events if we got multiple action on the same button if (io.ConfigFlags & ImGuiConfigFlags_NoKeyboard) continue; ImGuiKey key = e->Key.Key; IM_ASSERT(key != ImGuiKey_None); ImGuiKeyData* key_data = GetKeyData(key); const int key_data_index = (int)(key_data - g.IO.KeysData); if (trickle_fast_inputs && key_data->Down != e->Key.Down && (key_changed_mask.TestBit(key_data_index) || mouse_button_changed != 0)) break; const bool key_is_potentially_for_char_input = IsKeyChordPotentiallyCharInput(GetMergedModsFromKeys() | key); if (trickle_interleaved_nonchar_keys_and_text && (text_inputted && !key_is_potentially_for_char_input)) break; key_data->Down = e->Key.Down; key_data->AnalogValue = e->Key.AnalogValue; key_changed = true; key_changed_mask.SetBit(key_data_index); if (trickle_interleaved_nonchar_keys_and_text && !key_is_potentially_for_char_input) key_changed_nonchar = true; } else if (e->Type == ImGuiInputEventType_Text) { if (io.ConfigFlags & ImGuiConfigFlags_NoKeyboard) continue; // Trickling Rule: Stop processing queued events if keys/mouse have been interacted with if (trickle_fast_inputs && (mouse_button_changed != 0 || mouse_moved || mouse_wheeled)) break; if (trickle_interleaved_nonchar_keys_and_text && key_changed_nonchar) break; unsigned int c = e->Text.Char; io.InputQueueCharacters.push_back(c <= IM_UNICODE_CODEPOINT_MAX ? (ImWchar)c : IM_UNICODE_CODEPOINT_INVALID); if (trickle_interleaved_nonchar_keys_and_text) text_inputted = true; } else if (e->Type == ImGuiInputEventType_Focus) { // We intentionally overwrite this and process in NewFrame(), in order to give a chance // to multi-viewports backends to queue AddFocusEvent(false) + AddFocusEvent(true) in same frame. const bool focus_lost = !e->AppFocused.Focused; io.AppFocusLost = focus_lost; } else { IM_ASSERT(0 && "Unknown event!"); } } // Record trail (for domain-specific applications wanting to access a precise trail) //if (event_n != 0) IMGUI_DEBUG_LOG_IO("Processed: %d / Remaining: %d\n", event_n, g.InputEventsQueue.Size - event_n); for (int n = 0; n < event_n; n++) g.InputEventsTrail.push_back(g.InputEventsQueue[n]); // [DEBUG] #ifndef IMGUI_DISABLE_DEBUG_TOOLS if (event_n != 0 && (g.DebugLogFlags & ImGuiDebugLogFlags_EventIO)) for (int n = 0; n < g.InputEventsQueue.Size; n++) DebugPrintInputEvent(n < event_n ? "Processed" : "Remaining", &g.InputEventsQueue[n]); #endif // Remaining events will be processed on the next frame if (event_n == g.InputEventsQueue.Size) g.InputEventsQueue.resize(0); else g.InputEventsQueue.erase(g.InputEventsQueue.Data, g.InputEventsQueue.Data + event_n); // Clear buttons state when focus is lost // - this is useful so e.g. releasing Alt after focus loss on Alt-Tab doesn't trigger the Alt menu toggle. // - we clear in EndFrame() and not now in order allow application/user code polling this flag // (e.g. custom backend may want to clear additional data, custom widgets may want to react with a "canceling" event). if (g.IO.AppFocusLost) { g.IO.ClearInputKeys(); g.IO.ClearInputMouse(); } } ImGuiID ImGui::GetKeyOwner(ImGuiKey key) { if (!IsNamedKeyOrMod(key)) return ImGuiKeyOwner_NoOwner; ImGuiContext& g = *GImGui; ImGuiKeyOwnerData* owner_data = GetKeyOwnerData(&g, key); ImGuiID owner_id = owner_data->OwnerCurr; if (g.ActiveIdUsingAllKeyboardKeys && owner_id != g.ActiveId && owner_id != ImGuiKeyOwner_Any) if (key >= ImGuiKey_Keyboard_BEGIN && key < ImGuiKey_Keyboard_END) return ImGuiKeyOwner_NoOwner; return owner_id; } // TestKeyOwner(..., ID) : (owner == None || owner == ID) // TestKeyOwner(..., None) : (owner == None) // TestKeyOwner(..., Any) : no owner test // All paths are also testing for key not being locked, for the rare cases that key have been locked with using ImGuiInputFlags_LockXXX flags. bool ImGui::TestKeyOwner(ImGuiKey key, ImGuiID owner_id) { if (!IsNamedKeyOrMod(key)) return true; ImGuiContext& g = *GImGui; if (g.ActiveIdUsingAllKeyboardKeys && owner_id != g.ActiveId && owner_id != ImGuiKeyOwner_Any) if (key >= ImGuiKey_Keyboard_BEGIN && key < ImGuiKey_Keyboard_END) return false; ImGuiKeyOwnerData* owner_data = GetKeyOwnerData(&g, key); if (owner_id == ImGuiKeyOwner_Any) return (owner_data->LockThisFrame == false); // Note: SetKeyOwner() sets OwnerCurr. It is not strictly required for most mouse routing overlap (because of ActiveId/HoveredId // are acting as filter before this has a chance to filter), but sane as soon as user tries to look into things. // Setting OwnerCurr in SetKeyOwner() is more consistent than testing OwnerNext here: would be inconsistent with getter and other functions. if (owner_data->OwnerCurr != owner_id) { if (owner_data->LockThisFrame) return false; if (owner_data->OwnerCurr != ImGuiKeyOwner_NoOwner) return false; } return true; } // _LockXXX flags are useful to lock keys away from code which is not input-owner aware. // When using _LockXXX flags, you can use ImGuiKeyOwner_Any to lock keys from everyone. // - SetKeyOwner(..., None) : clears owner // - SetKeyOwner(..., Any, !Lock) : illegal (assert) // - SetKeyOwner(..., Any or None, Lock) : set lock void ImGui::SetKeyOwner(ImGuiKey key, ImGuiID owner_id, ImGuiInputFlags flags) { ImGuiContext& g = *GImGui; IM_ASSERT(IsNamedKeyOrMod(key) && (owner_id != ImGuiKeyOwner_Any || (flags & (ImGuiInputFlags_LockThisFrame | ImGuiInputFlags_LockUntilRelease)))); // Can only use _Any with _LockXXX flags (to eat a key away without an ID to retrieve it) IM_ASSERT((flags & ~ImGuiInputFlags_SupportedBySetKeyOwner) == 0); // Passing flags not supported by this function! //IMGUI_DEBUG_LOG("SetKeyOwner(%s, owner_id=0x%08X, flags=%08X)\n", GetKeyName(key), owner_id, flags); ImGuiKeyOwnerData* owner_data = GetKeyOwnerData(&g, key); owner_data->OwnerCurr = owner_data->OwnerNext = owner_id; // We cannot lock by default as it would likely break lots of legacy code. // In the case of using LockUntilRelease while key is not down we still lock during the frame (no key_data->Down test) owner_data->LockUntilRelease = (flags & ImGuiInputFlags_LockUntilRelease) != 0; owner_data->LockThisFrame = (flags & ImGuiInputFlags_LockThisFrame) != 0 || (owner_data->LockUntilRelease); } // Rarely used helper void ImGui::SetKeyOwnersForKeyChord(ImGuiKeyChord key_chord, ImGuiID owner_id, ImGuiInputFlags flags) { if (key_chord & ImGuiMod_Ctrl) { SetKeyOwner(ImGuiMod_Ctrl, owner_id, flags); } if (key_chord & ImGuiMod_Shift) { SetKeyOwner(ImGuiMod_Shift, owner_id, flags); } if (key_chord & ImGuiMod_Alt) { SetKeyOwner(ImGuiMod_Alt, owner_id, flags); } if (key_chord & ImGuiMod_Super) { SetKeyOwner(ImGuiMod_Super, owner_id, flags); } if (key_chord & ~ImGuiMod_Mask_) { SetKeyOwner((ImGuiKey)(key_chord & ~ImGuiMod_Mask_), owner_id, flags); } } // This is more or less equivalent to: // if (IsItemHovered() || IsItemActive()) // SetKeyOwner(key, GetItemID()); // Extensive uses of that (e.g. many calls for a single item) may want to manually perform the tests once and then call SetKeyOwner() multiple times. // More advanced usage scenarios may want to call SetKeyOwner() manually based on different condition. // Worth noting is that only one item can be hovered and only one item can be active, therefore this usage pattern doesn't need to bother with routing and priority. void ImGui::SetItemKeyOwner(ImGuiKey key, ImGuiInputFlags flags) { ImGuiContext& g = *GImGui; ImGuiID id = g.LastItemData.ID; if (id == 0 || (g.HoveredId != id && g.ActiveId != id)) return; if ((flags & ImGuiInputFlags_CondMask_) == 0) flags |= ImGuiInputFlags_CondDefault_; if ((g.HoveredId == id && (flags & ImGuiInputFlags_CondHovered)) || (g.ActiveId == id && (flags & ImGuiInputFlags_CondActive))) { IM_ASSERT((flags & ~ImGuiInputFlags_SupportedBySetItemKeyOwner) == 0); // Passing flags not supported by this function! SetKeyOwner(key, id, flags & ~ImGuiInputFlags_CondMask_); } } void ImGui::SetItemKeyOwner(ImGuiKey key) { SetItemKeyOwner(key, ImGuiInputFlags_None); } // This is the only public API until we expose owner_id versions of the API as replacements. bool ImGui::IsKeyChordPressed(ImGuiKeyChord key_chord) { return IsKeyChordPressed(key_chord, ImGuiInputFlags_None, ImGuiKeyOwner_Any); } // This is equivalent to comparing KeyMods + doing a IsKeyPressed() bool ImGui::IsKeyChordPressed(ImGuiKeyChord key_chord, ImGuiInputFlags flags, ImGuiID owner_id) { ImGuiContext& g = *GImGui; key_chord = FixupKeyChord(key_chord); ImGuiKey mods = (ImGuiKey)(key_chord & ImGuiMod_Mask_); if (g.IO.KeyMods != mods) return false; // Special storage location for mods ImGuiKey key = (ImGuiKey)(key_chord & ~ImGuiMod_Mask_); if (key == ImGuiKey_None) key = ConvertSingleModFlagToKey(mods); if (!IsKeyPressed(key, (flags & ImGuiInputFlags_RepeatMask_), owner_id)) return false; return true; } void ImGui::SetNextItemShortcut(ImGuiKeyChord key_chord, ImGuiInputFlags flags) { ImGuiContext& g = *GImGui; g.NextItemData.HasFlags |= ImGuiNextItemDataFlags_HasShortcut; g.NextItemData.Shortcut = key_chord; g.NextItemData.ShortcutFlags = flags; } // Called from within ItemAdd: at this point we can read from NextItemData and write to LastItemData void ImGui::ItemHandleShortcut(ImGuiID id) { ImGuiContext& g = *GImGui; ImGuiInputFlags flags = g.NextItemData.ShortcutFlags; IM_ASSERT((flags & ~ImGuiInputFlags_SupportedBySetNextItemShortcut) == 0); // Passing flags not supported by SetNextItemShortcut()! if (g.LastItemData.ItemFlags & ImGuiItemFlags_Disabled) return; if (flags & ImGuiInputFlags_Tooltip) { g.LastItemData.StatusFlags |= ImGuiItemStatusFlags_HasShortcut; g.LastItemData.Shortcut = g.NextItemData.Shortcut; } if (!Shortcut(g.NextItemData.Shortcut, flags & ImGuiInputFlags_SupportedByShortcut, id) || g.NavActivateId != 0) return; // FIXME: Generalize Activation queue? g.NavActivateId = id; // Will effectively disable clipping. g.NavActivateFlags = ImGuiActivateFlags_PreferInput | ImGuiActivateFlags_FromShortcut; //if (g.ActiveId == 0 || g.ActiveId == id) g.NavActivateDownId = g.NavActivatePressedId = id; NavHighlightActivated(id); } bool ImGui::Shortcut(ImGuiKeyChord key_chord, ImGuiInputFlags flags) { return Shortcut(key_chord, flags, ImGuiKeyOwner_Any); } bool ImGui::Shortcut(ImGuiKeyChord key_chord, ImGuiInputFlags flags, ImGuiID owner_id) { ImGuiContext& g = *GImGui; //IMGUI_DEBUG_LOG("Shortcut(%s, flags=%X, owner_id=0x%08X)\n", GetKeyChordName(key_chord, g.TempBuffer.Data, g.TempBuffer.Size), flags, owner_id); // When using (owner_id == 0/Any): SetShortcutRouting() will use CurrentFocusScopeId and filter with this, so IsKeyPressed() is fine with he 0/Any. if ((flags & ImGuiInputFlags_RouteTypeMask_) == 0) flags |= ImGuiInputFlags_RouteFocused; // Using 'owner_id == ImGuiKeyOwner_Any/0': auto-assign an owner based on current focus scope (each window has its focus scope by default) // Effectively makes Shortcut() always input-owner aware. if (owner_id == ImGuiKeyOwner_Any || owner_id == ImGuiKeyOwner_NoOwner) owner_id = GetRoutingIdFromOwnerId(owner_id); if (g.CurrentItemFlags & ImGuiItemFlags_Disabled) return false; // Submit route if (!SetShortcutRouting(key_chord, flags, owner_id)) return false; // Default repeat behavior for Shortcut() // So e.g. pressing Ctrl+W and releasing Ctrl while holding W will not trigger the W shortcut. if ((flags & ImGuiInputFlags_Repeat) != 0 && (flags & ImGuiInputFlags_RepeatUntilMask_) == 0) flags |= ImGuiInputFlags_RepeatUntilKeyModsChange; if (!IsKeyChordPressed(key_chord, flags, owner_id)) return false; // Claim mods during the press SetKeyOwnersForKeyChord(key_chord & ImGuiMod_Mask_, owner_id); IM_ASSERT((flags & ~ImGuiInputFlags_SupportedByShortcut) == 0); // Passing flags not supported by this function! return true; } //----------------------------------------------------------------------------- // [SECTION] ERROR CHECKING, STATE RECOVERY //----------------------------------------------------------------------------- // - DebugCheckVersionAndDataLayout() (called via IMGUI_CHECKVERSION() macros) // - ErrorCheckUsingSetCursorPosToExtendParentBoundaries() // - ErrorCheckNewFrameSanityChecks() // - ErrorCheckEndFrameSanityChecks() // - ErrorRecoveryStoreState() // - ErrorRecoveryTryToRecoverState() // - ErrorRecoveryTryToRecoverWindowState() // - ErrorLog() //----------------------------------------------------------------------------- // Verify ABI compatibility between caller code and compiled version of Dear ImGui. This helps detects some build issues. // Called by IMGUI_CHECKVERSION(). // Verify that the type sizes are matching between the calling file's compilation unit and imgui.cpp's compilation unit // If this triggers you have mismatched headers and compiled code versions. // - It could be because of a build issue (using new headers with old compiled code) // - It could be because of mismatched configuration #define, compilation settings, packing pragma etc. // THE CONFIGURATION SETTINGS MENTIONED IN imconfig.h MUST BE SET FOR ALL COMPILATION UNITS INVOLVED WITH DEAR IMGUI. // Which is why it is required you put them in your imconfig file (and NOT only before including imgui.h). // Otherwise it is possible that different compilation units would see different structure layout. // If you don't want to modify imconfig.h you can use the IMGUI_USER_CONFIG define to change filename. bool ImGui::DebugCheckVersionAndDataLayout(const char* version, size_t sz_io, size_t sz_style, size_t sz_vec2, size_t sz_vec4, size_t sz_vert, size_t sz_idx) { bool error = false; if (strcmp(version, IMGUI_VERSION) != 0) { error = true; IM_ASSERT(strcmp(version, IMGUI_VERSION) == 0 && "Mismatched version string!"); } if (sz_io != sizeof(ImGuiIO)) { error = true; IM_ASSERT(sz_io == sizeof(ImGuiIO) && "Mismatched struct layout!"); } if (sz_style != sizeof(ImGuiStyle)) { error = true; IM_ASSERT(sz_style == sizeof(ImGuiStyle) && "Mismatched struct layout!"); } if (sz_vec2 != sizeof(ImVec2)) { error = true; IM_ASSERT(sz_vec2 == sizeof(ImVec2) && "Mismatched struct layout!"); } if (sz_vec4 != sizeof(ImVec4)) { error = true; IM_ASSERT(sz_vec4 == sizeof(ImVec4) && "Mismatched struct layout!"); } if (sz_vert != sizeof(ImDrawVert)) { error = true; IM_ASSERT(sz_vert == sizeof(ImDrawVert) && "Mismatched struct layout!"); } if (sz_idx != sizeof(ImDrawIdx)) { error = true; IM_ASSERT(sz_idx == sizeof(ImDrawIdx) && "Mismatched struct layout!"); } return !error; } // Until 1.89 (IMGUI_VERSION_NUM < 18814) it was legal to use SetCursorPos() to extend the boundary of a parent (e.g. window or table cell) // This is causing issues and ambiguity and we need to retire that. // See https://github.com/ocornut/imgui/issues/5548 for more details. // [Scenario 1] // Previously this would make the window content size ~200x200: // Begin(...) + SetCursorScreenPos(GetCursorScreenPos() + ImVec2(200,200)) + End(); // NOT OK // Instead, please submit an item: // Begin(...) + SetCursorScreenPos(GetCursorScreenPos() + ImVec2(200,200)) + Dummy(ImVec2(0,0)) + End(); // OK // Alternative: // Begin(...) + Dummy(ImVec2(200,200)) + End(); // OK // [Scenario 2] // For reference this is one of the issue what we aim to fix with this change: // BeginGroup() + SomeItem("foobar") + SetCursorScreenPos(GetCursorScreenPos()) + EndGroup() // The previous logic made SetCursorScreenPos(GetCursorScreenPos()) have a side-effect! It would erroneously incorporate ItemSpacing.y after the item into content size, making the group taller! // While this code is a little twisted, no-one would expect SetXXX(GetXXX()) to have a side-effect. Using vertical alignment patterns could trigger this issue. void ImGui::ErrorCheckUsingSetCursorPosToExtendParentBoundaries() { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; IM_ASSERT(window->DC.IsSetPos); window->DC.IsSetPos = false; #ifdef IMGUI_DISABLE_OBSOLETE_FUNCTIONS if (window->DC.CursorPos.x <= window->DC.CursorMaxPos.x && window->DC.CursorPos.y <= window->DC.CursorMaxPos.y) return; if (window->SkipItems) return; IM_ASSERT(0 && "Code uses SetCursorPos()/SetCursorScreenPos() to extend window/parent boundaries. Please submit an item e.g. Dummy() to validate extent."); #else window->DC.CursorMaxPos = ImMax(window->DC.CursorMaxPos, window->DC.CursorPos); #endif } static void ImGui::ErrorCheckNewFrameSanityChecks() { ImGuiContext& g = *GImGui; // Check user IM_ASSERT macro // (IF YOU GET A WARNING OR COMPILE ERROR HERE: it means your assert macro is incorrectly defined! // If your macro uses multiple statements, it NEEDS to be surrounded by a 'do { ... } while (0)' block. // This is a common C/C++ idiom to allow multiple statements macros to be used in control flow blocks.) // #define IM_ASSERT(EXPR) if (SomeCode(EXPR)) SomeMoreCode(); // Wrong! // #define IM_ASSERT(EXPR) do { if (SomeCode(EXPR)) SomeMoreCode(); } while (0) // Correct! if (true) IM_ASSERT(1); else IM_ASSERT(0); // Emscripten backends are often imprecise in their submission of DeltaTime. (#6114, #3644) // Ideally the Emscripten app/backend should aim to fix or smooth this value and avoid feeding zero, but we tolerate it. #ifdef __EMSCRIPTEN__ if (g.IO.DeltaTime <= 0.0f && g.FrameCount > 0) g.IO.DeltaTime = 0.00001f; #endif // Check user data // (We pass an error message in the assert expression to make it visible to programmers who are not using a debugger, as most assert handlers display their argument) IM_ASSERT(g.Initialized); IM_ASSERT((g.IO.DeltaTime > 0.0f || g.FrameCount == 0) && "Need a positive DeltaTime!"); IM_ASSERT((g.FrameCount == 0 || g.FrameCountEnded == g.FrameCount) && "Forgot to call Render() or EndFrame() at the end of the previous frame?"); IM_ASSERT(g.IO.DisplaySize.x >= 0.0f && g.IO.DisplaySize.y >= 0.0f && "Invalid DisplaySize value!"); IM_ASSERT(g.IO.Fonts->IsBuilt() && "Font Atlas not built! Make sure you called ImGui_ImplXXXX_NewFrame() function for renderer backend, which should call io.Fonts->GetTexDataAsRGBA32() / GetTexDataAsAlpha8()"); IM_ASSERT(g.Style.CurveTessellationTol > 0.0f && "Invalid style setting!"); IM_ASSERT(g.Style.CircleTessellationMaxError > 0.0f && "Invalid style setting!"); IM_ASSERT(g.Style.Alpha >= 0.0f && g.Style.Alpha <= 1.0f && "Invalid style setting!"); // Allows us to avoid a few clamps in color computations IM_ASSERT(g.Style.WindowMinSize.x >= 1.0f && g.Style.WindowMinSize.y >= 1.0f && "Invalid style setting!"); IM_ASSERT(g.Style.WindowBorderHoverPadding > 0.0f && "Invalid style setting!"); // Required otherwise cannot resize from borders. IM_ASSERT(g.Style.WindowMenuButtonPosition == ImGuiDir_None || g.Style.WindowMenuButtonPosition == ImGuiDir_Left || g.Style.WindowMenuButtonPosition == ImGuiDir_Right); IM_ASSERT(g.Style.ColorButtonPosition == ImGuiDir_Left || g.Style.ColorButtonPosition == ImGuiDir_Right); // Error handling: we do not accept 100% silent recovery! Please contact me if you feel this is getting in your way. if (g.IO.ConfigErrorRecovery) IM_ASSERT(g.IO.ConfigErrorRecoveryEnableAssert || g.IO.ConfigErrorRecoveryEnableDebugLog || g.IO.ConfigErrorRecoveryEnableTooltip || g.ErrorCallback != NULL); #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS // Remap legacy names if (g.IO.ConfigFlags & ImGuiConfigFlags_NavEnableSetMousePos) { g.IO.ConfigNavMoveSetMousePos = true; g.IO.ConfigFlags &= ~ImGuiConfigFlags_NavEnableSetMousePos; } if (g.IO.ConfigFlags & ImGuiConfigFlags_NavNoCaptureKeyboard) { g.IO.ConfigNavCaptureKeyboard = false; g.IO.ConfigFlags &= ~ImGuiConfigFlags_NavNoCaptureKeyboard; } // Remap legacy clipboard handlers (OBSOLETED in 1.91.1, August 2024) if (g.IO.GetClipboardTextFn != NULL && (g.PlatformIO.Platform_GetClipboardTextFn == NULL || g.PlatformIO.Platform_GetClipboardTextFn == Platform_GetClipboardTextFn_DefaultImpl)) g.PlatformIO.Platform_GetClipboardTextFn = [](ImGuiContext* ctx) { return ctx->IO.GetClipboardTextFn(ctx->IO.ClipboardUserData); }; if (g.IO.SetClipboardTextFn != NULL && (g.PlatformIO.Platform_SetClipboardTextFn == NULL || g.PlatformIO.Platform_SetClipboardTextFn == Platform_SetClipboardTextFn_DefaultImpl)) g.PlatformIO.Platform_SetClipboardTextFn = [](ImGuiContext* ctx, const char* text) { return ctx->IO.SetClipboardTextFn(ctx->IO.ClipboardUserData, text); }; #endif } static void ImGui::ErrorCheckEndFrameSanityChecks() { // Verify that io.KeyXXX fields haven't been tampered with. Key mods should not be modified between NewFrame() and EndFrame() // One possible reason leading to this assert is that your backends update inputs _AFTER_ NewFrame(). // It is known that when some modal native windows called mid-frame takes focus away, some backends such as GLFW will // send key release events mid-frame. This would normally trigger this assertion and lead to sheared inputs. // We silently accommodate for this case by ignoring the case where all io.KeyXXX modifiers were released (aka key_mod_flags == 0), // while still correctly asserting on mid-frame key press events. ImGuiContext& g = *GImGui; const ImGuiKeyChord key_mods = GetMergedModsFromKeys(); IM_UNUSED(g); IM_UNUSED(key_mods); IM_ASSERT((key_mods == 0 || g.IO.KeyMods == key_mods) && "Mismatching io.KeyCtrl/io.KeyShift/io.KeyAlt/io.KeySuper vs io.KeyMods"); IM_UNUSED(key_mods); IM_ASSERT(g.CurrentWindowStack.Size == 1); IM_ASSERT(g.CurrentWindowStack[0].Window->IsFallbackWindow); } // Save current stack sizes. Called e.g. by NewFrame() and by Begin() but may be called for manual recovery. void ImGui::ErrorRecoveryStoreState(ImGuiErrorRecoveryState* state_out) { ImGuiContext& g = *GImGui; state_out->SizeOfWindowStack = (short)g.CurrentWindowStack.Size; state_out->SizeOfIDStack = (short)g.CurrentWindow->IDStack.Size; state_out->SizeOfTreeStack = (short)g.CurrentWindow->DC.TreeDepth; // NOT g.TreeNodeStack.Size which is a partial stack! state_out->SizeOfColorStack = (short)g.ColorStack.Size; state_out->SizeOfStyleVarStack = (short)g.StyleVarStack.Size; state_out->SizeOfFontStack = (short)g.FontStack.Size; state_out->SizeOfFocusScopeStack = (short)g.FocusScopeStack.Size; state_out->SizeOfGroupStack = (short)g.GroupStack.Size; state_out->SizeOfItemFlagsStack = (short)g.ItemFlagsStack.Size; state_out->SizeOfBeginPopupStack = (short)g.BeginPopupStack.Size; state_out->SizeOfDisabledStack = (short)g.DisabledStackSize; } // Chosen name "Try to recover" over e.g. "Restore" to suggest this is not a 100% guaranteed recovery. // Called by e.g. EndFrame() but may be called for manual recovery. // Attempt to recover full window stack. void ImGui::ErrorRecoveryTryToRecoverState(const ImGuiErrorRecoveryState* state_in) { // PVS-Studio V1044 is "Loop break conditions do not depend on the number of iterations" ImGuiContext& g = *GImGui; while (g.CurrentWindowStack.Size > state_in->SizeOfWindowStack) //-V1044 { // Recap: // - Begin()/BeginChild() return false to indicate the window is collapsed or fully clipped. // - Always call a matching End() for each Begin() call, regardless of its return value! // - Begin/End and BeginChild/EndChild logic is KNOWN TO BE INCONSISTENT WITH ALL OTHER BEGIN/END FUNCTIONS. // - We will fix that in a future major update. ImGuiWindow* window = g.CurrentWindow; if (window->Flags & ImGuiWindowFlags_ChildWindow) { if (g.CurrentTable != NULL && g.CurrentTable->InnerWindow == g.CurrentWindow) { IM_ASSERT_USER_ERROR(0, "Missing EndTable()"); EndTable(); } else { IM_ASSERT_USER_ERROR(0, "Missing EndChild()"); EndChild(); } } else { IM_ASSERT_USER_ERROR(0, "Missing End()"); End(); } } if (g.CurrentWindowStack.Size == state_in->SizeOfWindowStack) ErrorRecoveryTryToRecoverWindowState(state_in); } // Called by e.g. End() but may be called for manual recovery. // Read '// Error Handling [BETA]' block in imgui_internal.h for details. // Attempt to recover from incorrect usage of BeginXXX/EndXXX/PushXXX/PopXXX calls. void ImGui::ErrorRecoveryTryToRecoverWindowState(const ImGuiErrorRecoveryState* state_in) { ImGuiContext& g = *GImGui; while (g.CurrentTable != NULL && g.CurrentTable->InnerWindow == g.CurrentWindow) //-V1044 { IM_ASSERT_USER_ERROR(0, "Missing EndTable()"); EndTable(); } ImGuiWindow* window = g.CurrentWindow; // FIXME: Can't recover from inside BeginTabItem/EndTabItem yet. while (g.CurrentTabBar != NULL && g.CurrentTabBar->Window == window) //-V1044 { IM_ASSERT_USER_ERROR(0, "Missing EndTabBar()"); EndTabBar(); } while (g.CurrentMultiSelect != NULL && g.CurrentMultiSelect->Storage->Window == window) //-V1044 { IM_ASSERT_USER_ERROR(0, "Missing EndMultiSelect()"); EndMultiSelect(); } if (window->DC.MenuBarAppending) //-V1044 { IM_ASSERT_USER_ERROR(0, "Missing EndMenuBar()"); EndMenuBar(); } while (window->DC.TreeDepth > state_in->SizeOfTreeStack) //-V1044 { IM_ASSERT_USER_ERROR(0, "Missing TreePop()"); TreePop(); } while (g.GroupStack.Size > state_in->SizeOfGroupStack) //-V1044 { IM_ASSERT_USER_ERROR(0, "Missing EndGroup()"); EndGroup(); } IM_ASSERT(g.GroupStack.Size == state_in->SizeOfGroupStack); while (window->IDStack.Size > state_in->SizeOfIDStack) //-V1044 { IM_ASSERT_USER_ERROR(0, "Missing PopID()"); PopID(); } while (g.DisabledStackSize > state_in->SizeOfDisabledStack) //-V1044 { IM_ASSERT_USER_ERROR(0, "Missing EndDisabled()"); if (g.CurrentItemFlags & ImGuiItemFlags_Disabled) EndDisabled(); else { EndDisabledOverrideReenable(); g.CurrentWindowStack.back().DisabledOverrideReenable = false; } } IM_ASSERT(g.DisabledStackSize == state_in->SizeOfDisabledStack); while (g.ColorStack.Size > state_in->SizeOfColorStack) //-V1044 { IM_ASSERT_USER_ERROR(0, "Missing PopStyleColor()"); PopStyleColor(); } while (g.ItemFlagsStack.Size > state_in->SizeOfItemFlagsStack) //-V1044 { IM_ASSERT_USER_ERROR(0, "Missing PopItemFlag()"); PopItemFlag(); } while (g.StyleVarStack.Size > state_in->SizeOfStyleVarStack) //-V1044 { IM_ASSERT_USER_ERROR(0, "Missing PopStyleVar()"); PopStyleVar(); } while (g.FontStack.Size > state_in->SizeOfFontStack) //-V1044 { IM_ASSERT_USER_ERROR(0, "Missing PopFont()"); PopFont(); } while (g.FocusScopeStack.Size > state_in->SizeOfFocusScopeStack) //-V1044 { IM_ASSERT_USER_ERROR(0, "Missing PopFocusScope()"); PopFocusScope(); } //IM_ASSERT(g.FocusScopeStack.Size == state_in->SizeOfFocusScopeStack); } bool ImGui::ErrorLog(const char* msg) { ImGuiContext& g = *GImGui; // Output to debug log #ifndef IMGUI_DISABLE_DEBUG_TOOLS ImGuiWindow* window = g.CurrentWindow; if (g.IO.ConfigErrorRecoveryEnableDebugLog) { if (g.ErrorFirst) IMGUI_DEBUG_LOG_ERROR("[imgui-error] (current settings: Assert=%d, Log=%d, Tooltip=%d)\n", g.IO.ConfigErrorRecoveryEnableAssert, g.IO.ConfigErrorRecoveryEnableDebugLog, g.IO.ConfigErrorRecoveryEnableTooltip); IMGUI_DEBUG_LOG_ERROR("[imgui-error] In window '%s': %s\n", window ? window->Name : "NULL", msg); } g.ErrorFirst = false; // Output to tooltip if (g.IO.ConfigErrorRecoveryEnableTooltip) { if (g.WithinFrameScope && BeginErrorTooltip()) { if (g.ErrorCountCurrentFrame < 20) { Text("In window '%s': %s", window ? window->Name : "NULL", msg); if (window && (!window->IsFallbackWindow || window->WasActive)) GetForegroundDrawList(window)->AddRect(window->Pos, window->Pos + window->Size, IM_COL32(255, 0, 0, 255)); } if (g.ErrorCountCurrentFrame == 20) Text("(and more errors)"); // EndFrame() will amend debug buttons to this window, after all errors have been submitted. EndErrorTooltip(); } g.ErrorCountCurrentFrame++; } #endif // Output to callback if (g.ErrorCallback != NULL) g.ErrorCallback(&g, g.ErrorCallbackUserData, msg); // Return whether we should assert return g.IO.ConfigErrorRecoveryEnableAssert; } void ImGui::ErrorCheckEndFrameFinalizeErrorTooltip() { #ifndef IMGUI_DISABLE_DEBUG_TOOLS ImGuiContext& g = *GImGui; if (g.DebugDrawIdConflicts != 0 && g.IO.KeyCtrl == false) g.DebugDrawIdConflictsCount = g.HoveredIdPreviousFrameItemCount; if (g.DebugDrawIdConflicts != 0 && g.DebugItemPickerActive == false && BeginErrorTooltip()) { Text("Programmer error: %d visible items with conflicting ID!", g.DebugDrawIdConflictsCount); BulletText("Code should use PushID()/PopID() in loops, or append \"##xx\" to same-label identifiers!"); BulletText("Empty label e.g. Button(\"\") == same ID as parent widget/node. Use Button(\"##xx\") instead!"); //BulletText("Code intending to use duplicate ID may use e.g. PushItemFlag(ImGuiItemFlags_AllowDuplicateId, true); ... PopItemFlag()"); // Not making this too visible for fear of it being abused. BulletText("Set io.ConfigDebugHighlightIdConflicts=false to disable this warning in non-programmers builds."); Separator(); if (g.IO.ConfigDebugHighlightIdConflictsShowItemPicker) { Text("(Hold CTRL to: use "); SameLine(0.0f, 0.0f); if (SmallButton("Item Picker")) DebugStartItemPicker(); SameLine(0.0f, 0.0f); Text(" to break in item call-stack, or "); } else { Text("(Hold CTRL to "); } SameLine(0.0f, 0.0f); if (SmallButton("Open FAQ->About ID Stack System") && g.PlatformIO.Platform_OpenInShellFn != NULL) g.PlatformIO.Platform_OpenInShellFn(&g, "https://github.com/ocornut/imgui/blob/master/docs/FAQ.md#qa-usage"); SameLine(0.0f, 0.0f); Text(")"); EndErrorTooltip(); } if (g.ErrorCountCurrentFrame > 0 && BeginErrorTooltip()) // Amend at end of frame { Separator(); Text("(Hold CTRL to:"); SameLine(); if (SmallButton("Enable Asserts")) g.IO.ConfigErrorRecoveryEnableAssert = true; //SameLine(); //if (SmallButton("Hide Error Tooltips")) // g.IO.ConfigErrorRecoveryEnableTooltip = false; // Too dangerous SameLine(0, 0); Text(")"); EndErrorTooltip(); } #endif } // Pseudo-tooltip. Follow mouse until CTRL is held. When CTRL is held we lock position, allowing to click it. bool ImGui::BeginErrorTooltip() { ImGuiContext& g = *GImGui; ImGuiWindow* window = FindWindowByName("##Tooltip_Error"); const bool use_locked_pos = (g.IO.KeyCtrl && window && window->WasActive); PushStyleColor(ImGuiCol_PopupBg, ImLerp(g.Style.Colors[ImGuiCol_PopupBg], ImVec4(1.0f, 0.0f, 0.0f, 1.0f), 0.15f)); if (use_locked_pos) SetNextWindowPos(g.ErrorTooltipLockedPos); bool is_visible = Begin("##Tooltip_Error", NULL, ImGuiWindowFlags_Tooltip | ImGuiWindowFlags_NoDecoration | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoSavedSettings | ImGuiWindowFlags_AlwaysAutoResize); PopStyleColor(); if (is_visible && g.CurrentWindow->BeginCount == 1) { SeparatorText("MESSAGE FROM DEAR IMGUI"); BringWindowToDisplayFront(g.CurrentWindow); BringWindowToFocusFront(g.CurrentWindow); g.ErrorTooltipLockedPos = GetWindowPos(); } else if (!is_visible) { End(); } return is_visible; } void ImGui::EndErrorTooltip() { End(); } //----------------------------------------------------------------------------- // [SECTION] ITEM SUBMISSION //----------------------------------------------------------------------------- // - KeepAliveID() // - ItemAdd() //----------------------------------------------------------------------------- // Code not using ItemAdd() may need to call this manually otherwise ActiveId will be cleared. In IMGUI_VERSION_NUM < 18717 this was called by GetID(). void ImGui::KeepAliveID(ImGuiID id) { ImGuiContext& g = *GImGui; if (g.ActiveId == id) g.ActiveIdIsAlive = id; if (g.DeactivatedItemData.ID == id) g.DeactivatedItemData.IsAlive = true; } // Declare item bounding box for clipping and interaction. // Note that the size can be different than the one provided to ItemSize(). Typically, widgets that spread over available surface // declare their minimum size requirement to ItemSize() and provide a larger region to ItemAdd() which is used drawing/interaction. // THIS IS IN THE PERFORMANCE CRITICAL PATH (UNTIL THE CLIPPING TEST AND EARLY-RETURN) IM_MSVC_RUNTIME_CHECKS_OFF bool ImGui::ItemAdd(const ImRect& bb, ImGuiID id, const ImRect* nav_bb_arg, ImGuiItemFlags extra_flags) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; // Set item data // (DisplayRect is left untouched, made valid when ImGuiItemStatusFlags_HasDisplayRect is set) g.LastItemData.ID = id; g.LastItemData.Rect = bb; g.LastItemData.NavRect = nav_bb_arg ? *nav_bb_arg : bb; g.LastItemData.ItemFlags = g.CurrentItemFlags | g.NextItemData.ItemFlags | extra_flags; g.LastItemData.StatusFlags = ImGuiItemStatusFlags_None; // Note: we don't copy 'g.NextItemData.SelectionUserData' to an hypothetical g.LastItemData.SelectionUserData: since the former is not cleared. if (id != 0) { KeepAliveID(id); // Directional navigation processing // Runs prior to clipping early-out // (a) So that NavInitRequest can be honored, for newly opened windows to select a default widget // (b) So that we can scroll up/down past clipped items. This adds a small O(N) cost to regular navigation requests // unfortunately, but it is still limited to one window. It may not scale very well for windows with ten of // thousands of item, but at least NavMoveRequest is only set on user interaction, aka maximum once a frame. // We could early out with "if (is_clipped && !g.NavInitRequest) return false;" but when we wouldn't be able // to reach unclipped widgets. This would work if user had explicit scrolling control (e.g. mapped on a stick). // We intentionally don't check if g.NavWindow != NULL because g.NavAnyRequest should only be set when it is non null. // If we crash on a NULL g.NavWindow we need to fix the bug elsewhere. if (!(g.LastItemData.ItemFlags & ImGuiItemFlags_NoNav)) { // FIMXE-NAV: investigate changing the window tests into a simple 'if (g.NavFocusScopeId == g.CurrentFocusScopeId)' test. window->DC.NavLayersActiveMaskNext |= (1 << window->DC.NavLayerCurrent); if (g.NavId == id || g.NavAnyRequest) if (g.NavWindow->RootWindowForNav == window->RootWindowForNav) if (window == g.NavWindow || ((window->ChildFlags | g.NavWindow->ChildFlags) & ImGuiChildFlags_NavFlattened)) NavProcessItem(); } if (g.NextItemData.HasFlags & ImGuiNextItemDataFlags_HasShortcut) ItemHandleShortcut(id); } // Lightweight clear of SetNextItemXXX data. g.NextItemData.HasFlags = ImGuiNextItemDataFlags_None; g.NextItemData.ItemFlags = ImGuiItemFlags_None; #ifdef IMGUI_ENABLE_TEST_ENGINE if (id != 0) IMGUI_TEST_ENGINE_ITEM_ADD(id, g.LastItemData.NavRect, &g.LastItemData); #endif // Clipping test // (this is an inline copy of IsClippedEx() so we can reuse the is_rect_visible value, otherwise we'd do 'if (IsClippedEx(bb, id)) return false') // g.NavActivateId is not necessarily == g.NavId, in the case of remote activation (e.g. shortcuts) const bool is_rect_visible = bb.Overlaps(window->ClipRect); if (!is_rect_visible) if (id == 0 || (id != g.ActiveId && id != g.ActiveIdPreviousFrame && id != g.NavId && id != g.NavActivateId)) if (!g.ItemUnclipByLog) return false; // [DEBUG] #ifndef IMGUI_DISABLE_DEBUG_TOOLS if (id != 0) { if (id == g.DebugLocateId) DebugLocateItemResolveWithLastItem(); // [DEBUG] People keep stumbling on this problem and using "" as identifier in the root of a window instead of "##something". // Empty identifier are valid and useful in a small amount of cases, but 99.9% of the time you want to use "##something". // READ THE FAQ: https://dearimgui.com/faq IM_ASSERT(id != window->ID && "Cannot have an empty ID at the root of a window. If you need an empty label, use ## and read the FAQ about how the ID Stack works!"); } //if (g.IO.KeyAlt) window->DrawList->AddRect(bb.Min, bb.Max, IM_COL32(255,255,0,120)); // [DEBUG] //if ((g.LastItemData.ItemFlags & ImGuiItemFlags_NoNav) == 0) // window->DrawList->AddRect(g.LastItemData.NavRect.Min, g.LastItemData.NavRect.Max, IM_COL32(255,255,0,255)); // [DEBUG] #endif if (id != 0 && g.DeactivatedItemData.ID == id) g.DeactivatedItemData.ElapseFrame = g.FrameCount; // We need to calculate this now to take account of the current clipping rectangle (as items like Selectable may change them) if (is_rect_visible) g.LastItemData.StatusFlags |= ImGuiItemStatusFlags_Visible; if (IsMouseHoveringRect(bb.Min, bb.Max)) g.LastItemData.StatusFlags |= ImGuiItemStatusFlags_HoveredRect; return true; } IM_MSVC_RUNTIME_CHECKS_RESTORE //----------------------------------------------------------------------------- // [SECTION] LAYOUT //----------------------------------------------------------------------------- // - ItemSize() // - SameLine() // - GetCursorScreenPos() // - SetCursorScreenPos() // - GetCursorPos(), GetCursorPosX(), GetCursorPosY() // - SetCursorPos(), SetCursorPosX(), SetCursorPosY() // - GetCursorStartPos() // - Indent() // - Unindent() // - SetNextItemWidth() // - PushItemWidth() // - PushMultiItemsWidths() // - PopItemWidth() // - CalcItemWidth() // - CalcItemSize() // - GetTextLineHeight() // - GetTextLineHeightWithSpacing() // - GetFrameHeight() // - GetFrameHeightWithSpacing() // - GetContentRegionMax() // - GetContentRegionAvail(), // - BeginGroup() // - EndGroup() // Also see in imgui_widgets: tab bars, and in imgui_tables: tables, columns. //----------------------------------------------------------------------------- // Advance cursor given item size for layout. // Register minimum needed size so it can extend the bounding box used for auto-fit calculation. // See comments in ItemAdd() about how/why the size provided to ItemSize() vs ItemAdd() may often different. // THIS IS IN THE PERFORMANCE CRITICAL PATH. IM_MSVC_RUNTIME_CHECKS_OFF void ImGui::ItemSize(const ImVec2& size, float text_baseline_y) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; if (window->SkipItems) return; // We increase the height in this function to accommodate for baseline offset. // In theory we should be offsetting the starting position (window->DC.CursorPos), that will be the topic of a larger refactor, // but since ItemSize() is not yet an API that moves the cursor (to handle e.g. wrapping) enlarging the height has the same effect. const float offset_to_match_baseline_y = (text_baseline_y >= 0) ? ImMax(0.0f, window->DC.CurrLineTextBaseOffset - text_baseline_y) : 0.0f; const float line_y1 = window->DC.IsSameLine ? window->DC.CursorPosPrevLine.y : window->DC.CursorPos.y; const float line_height = ImMax(window->DC.CurrLineSize.y, /*ImMax(*/window->DC.CursorPos.y - line_y1/*, 0.0f)*/ + size.y + offset_to_match_baseline_y); // Always align ourselves on pixel boundaries //if (g.IO.KeyAlt) window->DrawList->AddRect(window->DC.CursorPos, window->DC.CursorPos + ImVec2(size.x, line_height), IM_COL32(255,0,0,200)); // [DEBUG] window->DC.CursorPosPrevLine.x = window->DC.CursorPos.x + size.x; window->DC.CursorPosPrevLine.y = line_y1; window->DC.CursorPos.x = IM_TRUNC(window->Pos.x + window->DC.Indent.x + window->DC.ColumnsOffset.x); // Next line window->DC.CursorPos.y = IM_TRUNC(line_y1 + line_height + g.Style.ItemSpacing.y); // Next line window->DC.CursorMaxPos.x = ImMax(window->DC.CursorMaxPos.x, window->DC.CursorPosPrevLine.x); window->DC.CursorMaxPos.y = ImMax(window->DC.CursorMaxPos.y, window->DC.CursorPos.y - g.Style.ItemSpacing.y); //if (g.IO.KeyAlt) window->DrawList->AddCircle(window->DC.CursorMaxPos, 3.0f, IM_COL32(255,0,0,255), 4); // [DEBUG] window->DC.PrevLineSize.y = line_height; window->DC.CurrLineSize.y = 0.0f; window->DC.PrevLineTextBaseOffset = ImMax(window->DC.CurrLineTextBaseOffset, text_baseline_y); window->DC.CurrLineTextBaseOffset = 0.0f; window->DC.IsSameLine = window->DC.IsSetPos = false; // Horizontal layout mode if (window->DC.LayoutType == ImGuiLayoutType_Horizontal) SameLine(); } IM_MSVC_RUNTIME_CHECKS_RESTORE // Gets back to previous line and continue with horizontal layout // offset_from_start_x == 0 : follow right after previous item // offset_from_start_x != 0 : align to specified x position (relative to window/group left) // spacing_w < 0 : use default spacing if offset_from_start_x == 0, no spacing if offset_from_start_x != 0 // spacing_w >= 0 : enforce spacing amount void ImGui::SameLine(float offset_from_start_x, float spacing_w) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; if (window->SkipItems) return; if (offset_from_start_x != 0.0f) { if (spacing_w < 0.0f) spacing_w = 0.0f; window->DC.CursorPos.x = window->Pos.x - window->Scroll.x + offset_from_start_x + spacing_w + window->DC.GroupOffset.x + window->DC.ColumnsOffset.x; window->DC.CursorPos.y = window->DC.CursorPosPrevLine.y; } else { if (spacing_w < 0.0f) spacing_w = g.Style.ItemSpacing.x; window->DC.CursorPos.x = window->DC.CursorPosPrevLine.x + spacing_w; window->DC.CursorPos.y = window->DC.CursorPosPrevLine.y; } window->DC.CurrLineSize = window->DC.PrevLineSize; window->DC.CurrLineTextBaseOffset = window->DC.PrevLineTextBaseOffset; window->DC.IsSameLine = true; } ImVec2 ImGui::GetCursorScreenPos() { ImGuiWindow* window = GetCurrentWindowRead(); return window->DC.CursorPos; } void ImGui::SetCursorScreenPos(const ImVec2& pos) { ImGuiWindow* window = GetCurrentWindow(); window->DC.CursorPos = pos; //window->DC.CursorMaxPos = ImMax(window->DC.CursorMaxPos, window->DC.CursorPos); window->DC.IsSetPos = true; } // User generally sees positions in window coordinates. Internally we store CursorPos in absolute screen coordinates because it is more convenient. // Conversion happens as we pass the value to user, but it makes our naming convention confusing because GetCursorPos() == (DC.CursorPos - window.Pos). May want to rename 'DC.CursorPos'. ImVec2 ImGui::GetCursorPos() { ImGuiWindow* window = GetCurrentWindowRead(); return window->DC.CursorPos - window->Pos + window->Scroll; } float ImGui::GetCursorPosX() { ImGuiWindow* window = GetCurrentWindowRead(); return window->DC.CursorPos.x - window->Pos.x + window->Scroll.x; } float ImGui::GetCursorPosY() { ImGuiWindow* window = GetCurrentWindowRead(); return window->DC.CursorPos.y - window->Pos.y + window->Scroll.y; } void ImGui::SetCursorPos(const ImVec2& local_pos) { ImGuiWindow* window = GetCurrentWindow(); window->DC.CursorPos = window->Pos - window->Scroll + local_pos; //window->DC.CursorMaxPos = ImMax(window->DC.CursorMaxPos, window->DC.CursorPos); window->DC.IsSetPos = true; } void ImGui::SetCursorPosX(float x) { ImGuiWindow* window = GetCurrentWindow(); window->DC.CursorPos.x = window->Pos.x - window->Scroll.x + x; //window->DC.CursorMaxPos.x = ImMax(window->DC.CursorMaxPos.x, window->DC.CursorPos.x); window->DC.IsSetPos = true; } void ImGui::SetCursorPosY(float y) { ImGuiWindow* window = GetCurrentWindow(); window->DC.CursorPos.y = window->Pos.y - window->Scroll.y + y; //window->DC.CursorMaxPos.y = ImMax(window->DC.CursorMaxPos.y, window->DC.CursorPos.y); window->DC.IsSetPos = true; } ImVec2 ImGui::GetCursorStartPos() { ImGuiWindow* window = GetCurrentWindowRead(); return window->DC.CursorStartPos - window->Pos; } void ImGui::Indent(float indent_w) { ImGuiContext& g = *GImGui; ImGuiWindow* window = GetCurrentWindow(); window->DC.Indent.x += (indent_w != 0.0f) ? indent_w : g.Style.IndentSpacing; window->DC.CursorPos.x = window->Pos.x + window->DC.Indent.x + window->DC.ColumnsOffset.x; } void ImGui::Unindent(float indent_w) { ImGuiContext& g = *GImGui; ImGuiWindow* window = GetCurrentWindow(); window->DC.Indent.x -= (indent_w != 0.0f) ? indent_w : g.Style.IndentSpacing; window->DC.CursorPos.x = window->Pos.x + window->DC.Indent.x + window->DC.ColumnsOffset.x; } // Affect large frame+labels widgets only. void ImGui::SetNextItemWidth(float item_width) { ImGuiContext& g = *GImGui; g.NextItemData.HasFlags |= ImGuiNextItemDataFlags_HasWidth; g.NextItemData.Width = item_width; } // FIXME: Remove the == 0.0f behavior? void ImGui::PushItemWidth(float item_width) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; window->DC.ItemWidthStack.push_back(window->DC.ItemWidth); // Backup current width window->DC.ItemWidth = (item_width == 0.0f ? window->ItemWidthDefault : item_width); g.NextItemData.HasFlags &= ~ImGuiNextItemDataFlags_HasWidth; } void ImGui::PushMultiItemsWidths(int components, float w_full) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; IM_ASSERT(components > 0); const ImGuiStyle& style = g.Style; window->DC.ItemWidthStack.push_back(window->DC.ItemWidth); // Backup current width float w_items = w_full - style.ItemInnerSpacing.x * (components - 1); float prev_split = w_items; for (int i = components - 1; i > 0; i--) { float next_split = IM_TRUNC(w_items * i / components); window->DC.ItemWidthStack.push_back(ImMax(prev_split - next_split, 1.0f)); prev_split = next_split; } window->DC.ItemWidth = ImMax(prev_split, 1.0f); g.NextItemData.HasFlags &= ~ImGuiNextItemDataFlags_HasWidth; } void ImGui::PopItemWidth() { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; if (window->DC.ItemWidthStack.Size <= 0) { IM_ASSERT_USER_ERROR(0, "Calling PopItemWidth() too many times!"); return; } window->DC.ItemWidth = window->DC.ItemWidthStack.back(); window->DC.ItemWidthStack.pop_back(); } // Calculate default item width given value passed to PushItemWidth() or SetNextItemWidth(). // The SetNextItemWidth() data is generally cleared/consumed by ItemAdd() or NextItemData.ClearFlags() float ImGui::CalcItemWidth() { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; float w; if (g.NextItemData.HasFlags & ImGuiNextItemDataFlags_HasWidth) w = g.NextItemData.Width; else w = window->DC.ItemWidth; if (w < 0.0f) { float region_avail_x = GetContentRegionAvail().x; w = ImMax(1.0f, region_avail_x + w); } w = IM_TRUNC(w); return w; } // [Internal] Calculate full item size given user provided 'size' parameter and default width/height. Default width is often == CalcItemWidth(). // Those two functions CalcItemWidth vs CalcItemSize are awkwardly named because they are not fully symmetrical. // Note that only CalcItemWidth() is publicly exposed. // The 4.0f here may be changed to match CalcItemWidth() and/or BeginChild() (right now we have a mismatch which is harmless but undesirable) ImVec2 ImGui::CalcItemSize(ImVec2 size, float default_w, float default_h) { ImVec2 avail; if (size.x < 0.0f || size.y < 0.0f) avail = GetContentRegionAvail(); if (size.x == 0.0f) size.x = default_w; else if (size.x < 0.0f) size.x = ImMax(4.0f, avail.x + size.x); // <-- size.x is negative here so we are subtracting if (size.y == 0.0f) size.y = default_h; else if (size.y < 0.0f) size.y = ImMax(4.0f, avail.y + size.y); // <-- size.y is negative here so we are subtracting return size; } float ImGui::GetTextLineHeight() { ImGuiContext& g = *GImGui; return g.FontSize; } float ImGui::GetTextLineHeightWithSpacing() { ImGuiContext& g = *GImGui; return g.FontSize + g.Style.ItemSpacing.y; } float ImGui::GetFrameHeight() { ImGuiContext& g = *GImGui; return g.FontSize + g.Style.FramePadding.y * 2.0f; } float ImGui::GetFrameHeightWithSpacing() { ImGuiContext& g = *GImGui; return g.FontSize + g.Style.FramePadding.y * 2.0f + g.Style.ItemSpacing.y; } ImVec2 ImGui::GetContentRegionAvail() { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; ImVec2 mx = (window->DC.CurrentColumns || g.CurrentTable) ? window->WorkRect.Max : window->ContentRegionRect.Max; return mx - window->DC.CursorPos; } #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS // You should never need those functions. Always use GetCursorScreenPos() and GetContentRegionAvail()! // They are bizarre local-coordinates which don't play well with scrolling. ImVec2 ImGui::GetContentRegionMax() { return GetContentRegionAvail() + GetCursorScreenPos() - GetWindowPos(); } ImVec2 ImGui::GetWindowContentRegionMin() { ImGuiWindow* window = GImGui->CurrentWindow; return window->ContentRegionRect.Min - window->Pos; } ImVec2 ImGui::GetWindowContentRegionMax() { ImGuiWindow* window = GImGui->CurrentWindow; return window->ContentRegionRect.Max - window->Pos; } #endif // Lock horizontal starting position + capture group bounding box into one "item" (so you can use IsItemHovered() or layout primitives such as SameLine() on whole group, etc.) // Groups are currently a mishmash of functionalities which should perhaps be clarified and separated. // FIXME-OPT: Could we safely early out on ->SkipItems? void ImGui::BeginGroup() { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; g.GroupStack.resize(g.GroupStack.Size + 1); ImGuiGroupData& group_data = g.GroupStack.back(); group_data.WindowID = window->ID; group_data.BackupCursorPos = window->DC.CursorPos; group_data.BackupCursorPosPrevLine = window->DC.CursorPosPrevLine; group_data.BackupCursorMaxPos = window->DC.CursorMaxPos; group_data.BackupIndent = window->DC.Indent; group_data.BackupGroupOffset = window->DC.GroupOffset; group_data.BackupCurrLineSize = window->DC.CurrLineSize; group_data.BackupCurrLineTextBaseOffset = window->DC.CurrLineTextBaseOffset; group_data.BackupActiveIdIsAlive = g.ActiveIdIsAlive; group_data.BackupHoveredIdIsAlive = g.HoveredId != 0; group_data.BackupIsSameLine = window->DC.IsSameLine; group_data.BackupDeactivatedIdIsAlive = g.DeactivatedItemData.IsAlive; group_data.EmitItem = true; window->DC.GroupOffset.x = window->DC.CursorPos.x - window->Pos.x - window->DC.ColumnsOffset.x; window->DC.Indent = window->DC.GroupOffset; window->DC.CursorMaxPos = window->DC.CursorPos; window->DC.CurrLineSize = ImVec2(0.0f, 0.0f); if (g.LogEnabled) g.LogLinePosY = -FLT_MAX; // To enforce a carriage return } void ImGui::EndGroup() { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; IM_ASSERT(g.GroupStack.Size > 0); // Mismatched BeginGroup()/EndGroup() calls ImGuiGroupData& group_data = g.GroupStack.back(); IM_ASSERT(group_data.WindowID == window->ID); // EndGroup() in wrong window? if (window->DC.IsSetPos) ErrorCheckUsingSetCursorPosToExtendParentBoundaries(); // Include LastItemData.Rect.Max as a workaround for e.g. EndTable() undershooting with CursorMaxPos report. (#7543) ImRect group_bb(group_data.BackupCursorPos, ImMax(ImMax(window->DC.CursorMaxPos, g.LastItemData.Rect.Max), group_data.BackupCursorPos)); window->DC.CursorPos = group_data.BackupCursorPos; window->DC.CursorPosPrevLine = group_data.BackupCursorPosPrevLine; window->DC.CursorMaxPos = ImMax(group_data.BackupCursorMaxPos, group_bb.Max); window->DC.Indent = group_data.BackupIndent; window->DC.GroupOffset = group_data.BackupGroupOffset; window->DC.CurrLineSize = group_data.BackupCurrLineSize; window->DC.CurrLineTextBaseOffset = group_data.BackupCurrLineTextBaseOffset; window->DC.IsSameLine = group_data.BackupIsSameLine; if (g.LogEnabled) g.LogLinePosY = -FLT_MAX; // To enforce a carriage return if (!group_data.EmitItem) { g.GroupStack.pop_back(); return; } window->DC.CurrLineTextBaseOffset = ImMax(window->DC.PrevLineTextBaseOffset, group_data.BackupCurrLineTextBaseOffset); // FIXME: Incorrect, we should grab the base offset from the *first line* of the group but it is hard to obtain now. ItemSize(group_bb.GetSize()); ItemAdd(group_bb, 0, NULL, ImGuiItemFlags_NoTabStop); // If the current ActiveId was declared within the boundary of our group, we copy it to LastItemId so IsItemActive(), IsItemDeactivated() etc. will be functional on the entire group. // It would be neater if we replaced window.DC.LastItemId by e.g. 'bool LastItemIsActive', but would put a little more burden on individual widgets. // Also if you grep for LastItemId you'll notice it is only used in that context. // (The two tests not the same because ActiveIdIsAlive is an ID itself, in order to be able to handle ActiveId being overwritten during the frame.) const bool group_contains_curr_active_id = (group_data.BackupActiveIdIsAlive != g.ActiveId) && (g.ActiveIdIsAlive == g.ActiveId) && g.ActiveId; const bool group_contains_deactivated_id = (group_data.BackupDeactivatedIdIsAlive == false) && (g.DeactivatedItemData.IsAlive == true); if (group_contains_curr_active_id) g.LastItemData.ID = g.ActiveId; else if (group_contains_deactivated_id) g.LastItemData.ID = g.DeactivatedItemData.ID; g.LastItemData.Rect = group_bb; // Forward Hovered flag const bool group_contains_curr_hovered_id = (group_data.BackupHoveredIdIsAlive == false) && g.HoveredId != 0; if (group_contains_curr_hovered_id) g.LastItemData.StatusFlags |= ImGuiItemStatusFlags_HoveredWindow; // Forward Edited flag if (group_contains_curr_active_id && g.ActiveIdHasBeenEditedThisFrame) g.LastItemData.StatusFlags |= ImGuiItemStatusFlags_Edited; // Forward Deactivated flag g.LastItemData.StatusFlags |= ImGuiItemStatusFlags_HasDeactivated; if (group_contains_deactivated_id) g.LastItemData.StatusFlags |= ImGuiItemStatusFlags_Deactivated; g.GroupStack.pop_back(); if (g.DebugShowGroupRects) window->DrawList->AddRect(group_bb.Min, group_bb.Max, IM_COL32(255,0,255,255)); // [Debug] } //----------------------------------------------------------------------------- // [SECTION] SCROLLING //----------------------------------------------------------------------------- // Helper to snap on edges when aiming at an item very close to the edge, // So the difference between WindowPadding and ItemSpacing will be in the visible area after scrolling. // When we refactor the scrolling API this may be configurable with a flag? // Note that the effect for this won't be visible on X axis with default Style settings as WindowPadding.x == ItemSpacing.x by default. static float CalcScrollEdgeSnap(float target, float snap_min, float snap_max, float snap_threshold, float center_ratio) { if (target <= snap_min + snap_threshold) return ImLerp(snap_min, target, center_ratio); if (target >= snap_max - snap_threshold) return ImLerp(target, snap_max, center_ratio); return target; } static ImVec2 CalcNextScrollFromScrollTargetAndClamp(ImGuiWindow* window) { ImVec2 scroll = window->Scroll; ImVec2 decoration_size(window->DecoOuterSizeX1 + window->DecoInnerSizeX1 + window->DecoOuterSizeX2, window->DecoOuterSizeY1 + window->DecoInnerSizeY1 + window->DecoOuterSizeY2); for (int axis = 0; axis < 2; axis++) { if (window->ScrollTarget[axis] < FLT_MAX) { float center_ratio = window->ScrollTargetCenterRatio[axis]; float scroll_target = window->ScrollTarget[axis]; if (window->ScrollTargetEdgeSnapDist[axis] > 0.0f) { float snap_min = 0.0f; float snap_max = window->ScrollMax[axis] + window->SizeFull[axis] - decoration_size[axis]; scroll_target = CalcScrollEdgeSnap(scroll_target, snap_min, snap_max, window->ScrollTargetEdgeSnapDist[axis], center_ratio); } scroll[axis] = scroll_target - center_ratio * (window->SizeFull[axis] - decoration_size[axis]); } scroll[axis] = IM_ROUND(ImMax(scroll[axis], 0.0f)); if (!window->Collapsed && !window->SkipItems) scroll[axis] = ImMin(scroll[axis], window->ScrollMax[axis]); } return scroll; } void ImGui::ScrollToItem(ImGuiScrollFlags flags) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; ScrollToRectEx(window, g.LastItemData.NavRect, flags); } void ImGui::ScrollToRect(ImGuiWindow* window, const ImRect& item_rect, ImGuiScrollFlags flags) { ScrollToRectEx(window, item_rect, flags); } // Scroll to keep newly navigated item fully into view ImVec2 ImGui::ScrollToRectEx(ImGuiWindow* window, const ImRect& item_rect, ImGuiScrollFlags flags) { ImGuiContext& g = *GImGui; ImRect scroll_rect(window->InnerRect.Min - ImVec2(1, 1), window->InnerRect.Max + ImVec2(1, 1)); scroll_rect.Min.x = ImMin(scroll_rect.Min.x + window->DecoInnerSizeX1, scroll_rect.Max.x); scroll_rect.Min.y = ImMin(scroll_rect.Min.y + window->DecoInnerSizeY1, scroll_rect.Max.y); //GetForegroundDrawList(window)->AddRect(item_rect.Min, item_rect.Max, IM_COL32(255,0,0,255), 0.0f, 0, 5.0f); // [DEBUG] //GetForegroundDrawList(window)->AddRect(scroll_rect.Min, scroll_rect.Max, IM_COL32_WHITE); // [DEBUG] // Check that only one behavior is selected per axis IM_ASSERT((flags & ImGuiScrollFlags_MaskX_) == 0 || ImIsPowerOfTwo(flags & ImGuiScrollFlags_MaskX_)); IM_ASSERT((flags & ImGuiScrollFlags_MaskY_) == 0 || ImIsPowerOfTwo(flags & ImGuiScrollFlags_MaskY_)); // Defaults ImGuiScrollFlags in_flags = flags; if ((flags & ImGuiScrollFlags_MaskX_) == 0 && window->ScrollbarX) flags |= ImGuiScrollFlags_KeepVisibleEdgeX; if ((flags & ImGuiScrollFlags_MaskY_) == 0) flags |= window->Appearing ? ImGuiScrollFlags_AlwaysCenterY : ImGuiScrollFlags_KeepVisibleEdgeY; const bool fully_visible_x = item_rect.Min.x >= scroll_rect.Min.x && item_rect.Max.x <= scroll_rect.Max.x; const bool fully_visible_y = item_rect.Min.y >= scroll_rect.Min.y && item_rect.Max.y <= scroll_rect.Max.y; const bool can_be_fully_visible_x = (item_rect.GetWidth() + g.Style.ItemSpacing.x * 2.0f) <= scroll_rect.GetWidth() || (window->AutoFitFramesX > 0) || (window->Flags & ImGuiWindowFlags_AlwaysAutoResize) != 0; const bool can_be_fully_visible_y = (item_rect.GetHeight() + g.Style.ItemSpacing.y * 2.0f) <= scroll_rect.GetHeight() || (window->AutoFitFramesY > 0) || (window->Flags & ImGuiWindowFlags_AlwaysAutoResize) != 0; if ((flags & ImGuiScrollFlags_KeepVisibleEdgeX) && !fully_visible_x) { if (item_rect.Min.x < scroll_rect.Min.x || !can_be_fully_visible_x) SetScrollFromPosX(window, item_rect.Min.x - g.Style.ItemSpacing.x - window->Pos.x, 0.0f); else if (item_rect.Max.x >= scroll_rect.Max.x) SetScrollFromPosX(window, item_rect.Max.x + g.Style.ItemSpacing.x - window->Pos.x, 1.0f); } else if (((flags & ImGuiScrollFlags_KeepVisibleCenterX) && !fully_visible_x) || (flags & ImGuiScrollFlags_AlwaysCenterX)) { if (can_be_fully_visible_x) SetScrollFromPosX(window, ImTrunc((item_rect.Min.x + item_rect.Max.x) * 0.5f) - window->Pos.x, 0.5f); else SetScrollFromPosX(window, item_rect.Min.x - window->Pos.x, 0.0f); } if ((flags & ImGuiScrollFlags_KeepVisibleEdgeY) && !fully_visible_y) { if (item_rect.Min.y < scroll_rect.Min.y || !can_be_fully_visible_y) SetScrollFromPosY(window, item_rect.Min.y - g.Style.ItemSpacing.y - window->Pos.y, 0.0f); else if (item_rect.Max.y >= scroll_rect.Max.y) SetScrollFromPosY(window, item_rect.Max.y + g.Style.ItemSpacing.y - window->Pos.y, 1.0f); } else if (((flags & ImGuiScrollFlags_KeepVisibleCenterY) && !fully_visible_y) || (flags & ImGuiScrollFlags_AlwaysCenterY)) { if (can_be_fully_visible_y) SetScrollFromPosY(window, ImTrunc((item_rect.Min.y + item_rect.Max.y) * 0.5f) - window->Pos.y, 0.5f); else SetScrollFromPosY(window, item_rect.Min.y - window->Pos.y, 0.0f); } ImVec2 next_scroll = CalcNextScrollFromScrollTargetAndClamp(window); ImVec2 delta_scroll = next_scroll - window->Scroll; // Also scroll parent window to keep us into view if necessary if (!(flags & ImGuiScrollFlags_NoScrollParent) && (window->Flags & ImGuiWindowFlags_ChildWindow)) { // FIXME-SCROLL: May be an option? if ((in_flags & (ImGuiScrollFlags_AlwaysCenterX | ImGuiScrollFlags_KeepVisibleCenterX)) != 0) in_flags = (in_flags & ~ImGuiScrollFlags_MaskX_) | ImGuiScrollFlags_KeepVisibleEdgeX; if ((in_flags & (ImGuiScrollFlags_AlwaysCenterY | ImGuiScrollFlags_KeepVisibleCenterY)) != 0) in_flags = (in_flags & ~ImGuiScrollFlags_MaskY_) | ImGuiScrollFlags_KeepVisibleEdgeY; delta_scroll += ScrollToRectEx(window->ParentWindow, ImRect(item_rect.Min - delta_scroll, item_rect.Max - delta_scroll), in_flags); } return delta_scroll; } float ImGui::GetScrollX() { ImGuiWindow* window = GImGui->CurrentWindow; return window->Scroll.x; } float ImGui::GetScrollY() { ImGuiWindow* window = GImGui->CurrentWindow; return window->Scroll.y; } float ImGui::GetScrollMaxX() { ImGuiWindow* window = GImGui->CurrentWindow; return window->ScrollMax.x; } float ImGui::GetScrollMaxY() { ImGuiWindow* window = GImGui->CurrentWindow; return window->ScrollMax.y; } void ImGui::SetScrollX(ImGuiWindow* window, float scroll_x) { window->ScrollTarget.x = scroll_x; window->ScrollTargetCenterRatio.x = 0.0f; window->ScrollTargetEdgeSnapDist.x = 0.0f; } void ImGui::SetScrollY(ImGuiWindow* window, float scroll_y) { window->ScrollTarget.y = scroll_y; window->ScrollTargetCenterRatio.y = 0.0f; window->ScrollTargetEdgeSnapDist.y = 0.0f; } void ImGui::SetScrollX(float scroll_x) { ImGuiContext& g = *GImGui; SetScrollX(g.CurrentWindow, scroll_x); } void ImGui::SetScrollY(float scroll_y) { ImGuiContext& g = *GImGui; SetScrollY(g.CurrentWindow, scroll_y); } // Note that a local position will vary depending on initial scroll value, // This is a little bit confusing so bear with us: // - local_pos = (absolution_pos - window->Pos) // - So local_x/local_y are 0.0f for a position at the upper-left corner of a window, // and generally local_x/local_y are >(padding+decoration) && <(size-padding-decoration) when in the visible area. // - They mostly exist because of legacy API. // Following the rules above, when trying to work with scrolling code, consider that: // - SetScrollFromPosY(0.0f) == SetScrollY(0.0f + scroll.y) == has no effect! // - SetScrollFromPosY(-scroll.y) == SetScrollY(-scroll.y + scroll.y) == SetScrollY(0.0f) == reset scroll. Of course writing SetScrollY(0.0f) directly then makes more sense // We store a target position so centering and clamping can occur on the next frame when we are guaranteed to have a known window size void ImGui::SetScrollFromPosX(ImGuiWindow* window, float local_x, float center_x_ratio) { IM_ASSERT(center_x_ratio >= 0.0f && center_x_ratio <= 1.0f); window->ScrollTarget.x = IM_TRUNC(local_x - window->DecoOuterSizeX1 - window->DecoInnerSizeX1 + window->Scroll.x); // Convert local position to scroll offset window->ScrollTargetCenterRatio.x = center_x_ratio; window->ScrollTargetEdgeSnapDist.x = 0.0f; } void ImGui::SetScrollFromPosY(ImGuiWindow* window, float local_y, float center_y_ratio) { IM_ASSERT(center_y_ratio >= 0.0f && center_y_ratio <= 1.0f); window->ScrollTarget.y = IM_TRUNC(local_y - window->DecoOuterSizeY1 - window->DecoInnerSizeY1 + window->Scroll.y); // Convert local position to scroll offset window->ScrollTargetCenterRatio.y = center_y_ratio; window->ScrollTargetEdgeSnapDist.y = 0.0f; } void ImGui::SetScrollFromPosX(float local_x, float center_x_ratio) { ImGuiContext& g = *GImGui; SetScrollFromPosX(g.CurrentWindow, local_x, center_x_ratio); } void ImGui::SetScrollFromPosY(float local_y, float center_y_ratio) { ImGuiContext& g = *GImGui; SetScrollFromPosY(g.CurrentWindow, local_y, center_y_ratio); } // center_x_ratio: 0.0f left of last item, 0.5f horizontal center of last item, 1.0f right of last item. void ImGui::SetScrollHereX(float center_x_ratio) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; float spacing_x = ImMax(window->WindowPadding.x, g.Style.ItemSpacing.x); float target_pos_x = ImLerp(g.LastItemData.Rect.Min.x - spacing_x, g.LastItemData.Rect.Max.x + spacing_x, center_x_ratio); SetScrollFromPosX(window, target_pos_x - window->Pos.x, center_x_ratio); // Convert from absolute to local pos // Tweak: snap on edges when aiming at an item very close to the edge window->ScrollTargetEdgeSnapDist.x = ImMax(0.0f, window->WindowPadding.x - spacing_x); } // center_y_ratio: 0.0f top of last item, 0.5f vertical center of last item, 1.0f bottom of last item. void ImGui::SetScrollHereY(float center_y_ratio) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; float spacing_y = ImMax(window->WindowPadding.y, g.Style.ItemSpacing.y); float target_pos_y = ImLerp(window->DC.CursorPosPrevLine.y - spacing_y, window->DC.CursorPosPrevLine.y + window->DC.PrevLineSize.y + spacing_y, center_y_ratio); SetScrollFromPosY(window, target_pos_y - window->Pos.y, center_y_ratio); // Convert from absolute to local pos // Tweak: snap on edges when aiming at an item very close to the edge window->ScrollTargetEdgeSnapDist.y = ImMax(0.0f, window->WindowPadding.y - spacing_y); } //----------------------------------------------------------------------------- // [SECTION] TOOLTIPS //----------------------------------------------------------------------------- bool ImGui::BeginTooltip() { return BeginTooltipEx(ImGuiTooltipFlags_None, ImGuiWindowFlags_None); } bool ImGui::BeginItemTooltip() { if (!IsItemHovered(ImGuiHoveredFlags_ForTooltip)) return false; return BeginTooltipEx(ImGuiTooltipFlags_None, ImGuiWindowFlags_None); } bool ImGui::BeginTooltipEx(ImGuiTooltipFlags tooltip_flags, ImGuiWindowFlags extra_window_flags) { ImGuiContext& g = *GImGui; const bool is_dragdrop_tooltip = g.DragDropWithinSource || g.DragDropWithinTarget; if (is_dragdrop_tooltip) { // Drag and Drop tooltips are positioning differently than other tooltips: // - offset visibility to increase visibility around mouse. // - never clamp within outer viewport boundary. // We call SetNextWindowPos() to enforce position and disable clamping. // See FindBestWindowPosForPopup() for positionning logic of other tooltips (not drag and drop ones). //ImVec2 tooltip_pos = g.IO.MousePos - g.ActiveIdClickOffset - g.Style.WindowPadding; const bool is_touchscreen = (g.IO.MouseSource == ImGuiMouseSource_TouchScreen); if ((g.NextWindowData.HasFlags & ImGuiNextWindowDataFlags_HasPos) == 0) { ImVec2 tooltip_pos = is_touchscreen ? (g.IO.MousePos + TOOLTIP_DEFAULT_OFFSET_TOUCH * g.Style.MouseCursorScale) : (g.IO.MousePos + TOOLTIP_DEFAULT_OFFSET_MOUSE * g.Style.MouseCursorScale); ImVec2 tooltip_pivot = is_touchscreen ? TOOLTIP_DEFAULT_PIVOT_TOUCH : ImVec2(0.0f, 0.0f); SetNextWindowPos(tooltip_pos, ImGuiCond_None, tooltip_pivot); } SetNextWindowBgAlpha(g.Style.Colors[ImGuiCol_PopupBg].w * 0.60f); //PushStyleVar(ImGuiStyleVar_Alpha, g.Style.Alpha * 0.60f); // This would be nice but e.g ColorButton with checkboard has issue with transparent colors :( tooltip_flags |= ImGuiTooltipFlags_OverridePrevious; } const char* window_name_template = is_dragdrop_tooltip ? "##Tooltip_DragDrop_%02d" : "##Tooltip_%02d"; char window_name[32]; ImFormatString(window_name, IM_ARRAYSIZE(window_name), window_name_template, g.TooltipOverrideCount); if ((tooltip_flags & ImGuiTooltipFlags_OverridePrevious) && g.TooltipPreviousWindow != NULL && g.TooltipPreviousWindow->Active) { // Hide previous tooltip from being displayed. We can't easily "reset" the content of a window so we create a new one. //IMGUI_DEBUG_LOG("[tooltip] '%s' already active, using +1 for this frame\n", window_name); SetWindowHiddenAndSkipItemsForCurrentFrame(g.TooltipPreviousWindow); ImFormatString(window_name, IM_ARRAYSIZE(window_name), window_name_template, ++g.TooltipOverrideCount); } ImGuiWindowFlags flags = ImGuiWindowFlags_Tooltip | ImGuiWindowFlags_NoInputs | ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoSavedSettings | ImGuiWindowFlags_AlwaysAutoResize; Begin(window_name, NULL, flags | extra_window_flags); // 2023-03-09: Added bool return value to the API, but currently always returning true. // If this ever returns false we need to update BeginDragDropSource() accordingly. //if (!ret) // End(); //return ret; return true; } void ImGui::EndTooltip() { IM_ASSERT(GetCurrentWindowRead()->Flags & ImGuiWindowFlags_Tooltip); // Mismatched BeginTooltip()/EndTooltip() calls End(); } void ImGui::SetTooltip(const char* fmt, ...) { va_list args; va_start(args, fmt); SetTooltipV(fmt, args); va_end(args); } void ImGui::SetTooltipV(const char* fmt, va_list args) { if (!BeginTooltipEx(ImGuiTooltipFlags_OverridePrevious, ImGuiWindowFlags_None)) return; TextV(fmt, args); EndTooltip(); } // Shortcut to use 'style.HoverFlagsForTooltipMouse' or 'style.HoverFlagsForTooltipNav'. // Defaults to == ImGuiHoveredFlags_Stationary | ImGuiHoveredFlags_DelayShort when using the mouse. void ImGui::SetItemTooltip(const char* fmt, ...) { va_list args; va_start(args, fmt); if (IsItemHovered(ImGuiHoveredFlags_ForTooltip)) SetTooltipV(fmt, args); va_end(args); } void ImGui::SetItemTooltipV(const char* fmt, va_list args) { if (IsItemHovered(ImGuiHoveredFlags_ForTooltip)) SetTooltipV(fmt, args); } //----------------------------------------------------------------------------- // [SECTION] POPUPS //----------------------------------------------------------------------------- // Supported flags: ImGuiPopupFlags_AnyPopupId, ImGuiPopupFlags_AnyPopupLevel bool ImGui::IsPopupOpen(ImGuiID id, ImGuiPopupFlags popup_flags) { ImGuiContext& g = *GImGui; if (popup_flags & ImGuiPopupFlags_AnyPopupId) { // Return true if any popup is open at the current BeginPopup() level of the popup stack // This may be used to e.g. test for another popups already opened to handle popups priorities at the same level. IM_ASSERT(id == 0); if (popup_flags & ImGuiPopupFlags_AnyPopupLevel) return g.OpenPopupStack.Size > 0; else return g.OpenPopupStack.Size > g.BeginPopupStack.Size; } else { if (popup_flags & ImGuiPopupFlags_AnyPopupLevel) { // Return true if the popup is open anywhere in the popup stack for (int n = 0; n < g.OpenPopupStack.Size; n++) if (g.OpenPopupStack[n].PopupId == id) return true; return false; } else { // Return true if the popup is open at the current BeginPopup() level of the popup stack (this is the most-common query) return g.OpenPopupStack.Size > g.BeginPopupStack.Size && g.OpenPopupStack[g.BeginPopupStack.Size].PopupId == id; } } } bool ImGui::IsPopupOpen(const char* str_id, ImGuiPopupFlags popup_flags) { ImGuiContext& g = *GImGui; ImGuiID id = (popup_flags & ImGuiPopupFlags_AnyPopupId) ? 0 : g.CurrentWindow->GetID(str_id); if ((popup_flags & ImGuiPopupFlags_AnyPopupLevel) && id != 0) IM_ASSERT(0 && "Cannot use IsPopupOpen() with a string id and ImGuiPopupFlags_AnyPopupLevel."); // But non-string version is legal and used internally return IsPopupOpen(id, popup_flags); } // Also see FindBlockingModal(NULL) ImGuiWindow* ImGui::GetTopMostPopupModal() { ImGuiContext& g = *GImGui; for (int n = g.OpenPopupStack.Size - 1; n >= 0; n--) if (ImGuiWindow* popup = g.OpenPopupStack.Data[n].Window) if (popup->Flags & ImGuiWindowFlags_Modal) return popup; return NULL; } // See Demo->Stacked Modal to confirm what this is for. ImGuiWindow* ImGui::GetTopMostAndVisiblePopupModal() { ImGuiContext& g = *GImGui; for (int n = g.OpenPopupStack.Size - 1; n >= 0; n--) if (ImGuiWindow* popup = g.OpenPopupStack.Data[n].Window) if ((popup->Flags & ImGuiWindowFlags_Modal) && IsWindowActiveAndVisible(popup)) return popup; return NULL; } // When a modal popup is open, newly created windows that want focus (i.e. are not popups and do not specify ImGuiWindowFlags_NoFocusOnAppearing) // should be positioned behind that modal window, unless the window was created inside the modal begin-stack. // In case of multiple stacked modals newly created window honors begin stack order and does not go below its own modal parent. // - WindowA // FindBlockingModal() returns Modal1 // - WindowB // .. returns Modal1 // - Modal1 // .. returns Modal2 // - WindowC // .. returns Modal2 // - WindowD // .. returns Modal2 // - Modal2 // .. returns Modal2 // - WindowE // .. returns NULL // Notes: // - FindBlockingModal(NULL) == NULL is generally equivalent to GetTopMostPopupModal() == NULL. // Only difference is here we check for ->Active/WasActive but it may be unnecessary. ImGuiWindow* ImGui::FindBlockingModal(ImGuiWindow* window) { ImGuiContext& g = *GImGui; if (g.OpenPopupStack.Size <= 0) return NULL; // Find a modal that has common parent with specified window. Specified window should be positioned behind that modal. for (ImGuiPopupData& popup_data : g.OpenPopupStack) { ImGuiWindow* popup_window = popup_data.Window; if (popup_window == NULL || !(popup_window->Flags & ImGuiWindowFlags_Modal)) continue; if (!popup_window->Active && !popup_window->WasActive) // Check WasActive, because this code may run before popup renders on current frame, also check Active to handle newly created windows. continue; if (window == NULL) // FindBlockingModal(NULL) test for if FocusWindow(NULL) is naturally possible via a mouse click. return popup_window; if (IsWindowWithinBeginStackOf(window, popup_window)) // Window may be over modal continue; return popup_window; // Place window right below first block modal } return NULL; } void ImGui::OpenPopup(const char* str_id, ImGuiPopupFlags popup_flags) { ImGuiContext& g = *GImGui; ImGuiID id = g.CurrentWindow->GetID(str_id); IMGUI_DEBUG_LOG_POPUP("[popup] OpenPopup(\"%s\" -> 0x%08X)\n", str_id, id); OpenPopupEx(id, popup_flags); } void ImGui::OpenPopup(ImGuiID id, ImGuiPopupFlags popup_flags) { OpenPopupEx(id, popup_flags); } // Mark popup as open (toggle toward open state). // Popups are closed when user click outside, or activate a pressable item, or CloseCurrentPopup() is called within a BeginPopup()/EndPopup() block. // Popup identifiers are relative to the current ID-stack (so OpenPopup and BeginPopup needs to be at the same level). // One open popup per level of the popup hierarchy (NB: when assigning we reset the Window member of ImGuiPopupRef to NULL) void ImGui::OpenPopupEx(ImGuiID id, ImGuiPopupFlags popup_flags) { ImGuiContext& g = *GImGui; ImGuiWindow* parent_window = g.CurrentWindow; const int current_stack_size = g.BeginPopupStack.Size; if (popup_flags & ImGuiPopupFlags_NoOpenOverExistingPopup) if (IsPopupOpen((ImGuiID)0, ImGuiPopupFlags_AnyPopupId)) return; ImGuiPopupData popup_ref; // Tagged as new ref as Window will be set back to NULL if we write this into OpenPopupStack. popup_ref.PopupId = id; popup_ref.Window = NULL; popup_ref.RestoreNavWindow = g.NavWindow; // When popup closes focus may be restored to NavWindow (depend on window type). popup_ref.OpenFrameCount = g.FrameCount; popup_ref.OpenParentId = parent_window->IDStack.back(); popup_ref.OpenPopupPos = NavCalcPreferredRefPos(); popup_ref.OpenMousePos = IsMousePosValid(&g.IO.MousePos) ? g.IO.MousePos : popup_ref.OpenPopupPos; IMGUI_DEBUG_LOG_POPUP("[popup] OpenPopupEx(0x%08X)\n", id); if (g.OpenPopupStack.Size < current_stack_size + 1) { g.OpenPopupStack.push_back(popup_ref); } else { // Gently handle the user mistakenly calling OpenPopup() every frames: it is likely a programming mistake! // However, if we were to run the regular code path, the ui would become completely unusable because the popup will always be // in hidden-while-calculating-size state _while_ claiming focus. Which is extremely confusing situation for the programmer. // Instead, for successive frames calls to OpenPopup(), we silently avoid reopening even if ImGuiPopupFlags_NoReopen is not specified. bool keep_existing = false; if (g.OpenPopupStack[current_stack_size].PopupId == id) if ((g.OpenPopupStack[current_stack_size].OpenFrameCount == g.FrameCount - 1) || (popup_flags & ImGuiPopupFlags_NoReopen)) keep_existing = true; if (keep_existing) { // No reopen g.OpenPopupStack[current_stack_size].OpenFrameCount = popup_ref.OpenFrameCount; } else { // Reopen: close child popups if any, then flag popup for open/reopen (set position, focus, init navigation) ClosePopupToLevel(current_stack_size, true); g.OpenPopupStack.push_back(popup_ref); } // When reopening a popup we first refocus its parent, otherwise if its parent is itself a popup it would get closed by ClosePopupsOverWindow(). // This is equivalent to what ClosePopupToLevel() does. //if (g.OpenPopupStack[current_stack_size].PopupId == id) // FocusWindow(parent_window); } } // When popups are stacked, clicking on a lower level popups puts focus back to it and close popups above it. // This function closes any popups that are over 'ref_window'. void ImGui::ClosePopupsOverWindow(ImGuiWindow* ref_window, bool restore_focus_to_window_under_popup) { ImGuiContext& g = *GImGui; if (g.OpenPopupStack.Size == 0) return; // Don't close our own child popup windows. //IMGUI_DEBUG_LOG_POPUP("[popup] ClosePopupsOverWindow(\"%s\") restore_under=%d\n", ref_window ? ref_window->Name : "", restore_focus_to_window_under_popup); int popup_count_to_keep = 0; if (ref_window) { // Find the highest popup which is a descendant of the reference window (generally reference window = NavWindow) for (; popup_count_to_keep < g.OpenPopupStack.Size; popup_count_to_keep++) { ImGuiPopupData& popup = g.OpenPopupStack[popup_count_to_keep]; if (!popup.Window) continue; IM_ASSERT((popup.Window->Flags & ImGuiWindowFlags_Popup) != 0); // Trim the stack unless the popup is a direct parent of the reference window (the reference window is often the NavWindow) // - Clicking/Focusing Window2 won't close Popup1: // Window -> Popup1 -> Window2(Ref) // - Clicking/focusing Popup1 will close Popup2 and Popup3: // Window -> Popup1(Ref) -> Popup2 -> Popup3 // - Each popups may contain child windows, which is why we compare ->RootWindow! // Window -> Popup1 -> Popup1_Child -> Popup2 -> Popup2_Child // We step through every popup from bottom to top to validate their position relative to reference window. bool ref_window_is_descendent_of_popup = false; for (int n = popup_count_to_keep; n < g.OpenPopupStack.Size; n++) if (ImGuiWindow* popup_window = g.OpenPopupStack[n].Window) if (IsWindowWithinBeginStackOf(ref_window, popup_window)) { ref_window_is_descendent_of_popup = true; break; } if (!ref_window_is_descendent_of_popup) break; } } if (popup_count_to_keep < g.OpenPopupStack.Size) // This test is not required but it allows to set a convenient breakpoint on the statement below { IMGUI_DEBUG_LOG_POPUP("[popup] ClosePopupsOverWindow(\"%s\")\n", ref_window ? ref_window->Name : ""); ClosePopupToLevel(popup_count_to_keep, restore_focus_to_window_under_popup); } } void ImGui::ClosePopupsExceptModals() { ImGuiContext& g = *GImGui; int popup_count_to_keep; for (popup_count_to_keep = g.OpenPopupStack.Size; popup_count_to_keep > 0; popup_count_to_keep--) { ImGuiWindow* window = g.OpenPopupStack[popup_count_to_keep - 1].Window; if (!window || (window->Flags & ImGuiWindowFlags_Modal)) break; } if (popup_count_to_keep < g.OpenPopupStack.Size) // This test is not required but it allows to set a convenient breakpoint on the statement below ClosePopupToLevel(popup_count_to_keep, true); } void ImGui::ClosePopupToLevel(int remaining, bool restore_focus_to_window_under_popup) { ImGuiContext& g = *GImGui; IMGUI_DEBUG_LOG_POPUP("[popup] ClosePopupToLevel(%d), restore_under=%d\n", remaining, restore_focus_to_window_under_popup); IM_ASSERT(remaining >= 0 && remaining < g.OpenPopupStack.Size); if (g.DebugLogFlags & ImGuiDebugLogFlags_EventPopup) for (int n = remaining; n < g.OpenPopupStack.Size; n++) IMGUI_DEBUG_LOG_POPUP("[popup] - Closing PopupID 0x%08X Window \"%s\"\n", g.OpenPopupStack[n].PopupId, g.OpenPopupStack[n].Window ? g.OpenPopupStack[n].Window->Name : NULL); // Trim open popup stack ImGuiPopupData prev_popup = g.OpenPopupStack[remaining]; g.OpenPopupStack.resize(remaining); // Restore focus (unless popup window was not yet submitted, and didn't have a chance to take focus anyhow. See #7325 for an edge case) if (restore_focus_to_window_under_popup && prev_popup.Window) { ImGuiWindow* popup_window = prev_popup.Window; ImGuiWindow* focus_window = (popup_window->Flags & ImGuiWindowFlags_ChildMenu) ? popup_window->ParentWindow : prev_popup.RestoreNavWindow; if (focus_window && !focus_window->WasActive) FocusTopMostWindowUnderOne(popup_window, NULL, NULL, ImGuiFocusRequestFlags_RestoreFocusedChild); // Fallback else FocusWindow(focus_window, (g.NavLayer == ImGuiNavLayer_Main) ? ImGuiFocusRequestFlags_RestoreFocusedChild : ImGuiFocusRequestFlags_None); } } // Close the popup we have begin-ed into. void ImGui::CloseCurrentPopup() { ImGuiContext& g = *GImGui; int popup_idx = g.BeginPopupStack.Size - 1; if (popup_idx < 0 || popup_idx >= g.OpenPopupStack.Size || g.BeginPopupStack[popup_idx].PopupId != g.OpenPopupStack[popup_idx].PopupId) return; // Closing a menu closes its top-most parent popup (unless a modal) while (popup_idx > 0) { ImGuiWindow* popup_window = g.OpenPopupStack[popup_idx].Window; ImGuiWindow* parent_popup_window = g.OpenPopupStack[popup_idx - 1].Window; bool close_parent = false; if (popup_window && (popup_window->Flags & ImGuiWindowFlags_ChildMenu)) if (parent_popup_window && !(parent_popup_window->Flags & ImGuiWindowFlags_MenuBar)) close_parent = true; if (!close_parent) break; popup_idx--; } IMGUI_DEBUG_LOG_POPUP("[popup] CloseCurrentPopup %d -> %d\n", g.BeginPopupStack.Size - 1, popup_idx); ClosePopupToLevel(popup_idx, true); // A common pattern is to close a popup when selecting a menu item/selectable that will open another window. // To improve this usage pattern, we avoid nav highlight for a single frame in the parent window. // Similarly, we could avoid mouse hover highlight in this window but it is less visually problematic. if (ImGuiWindow* window = g.NavWindow) window->DC.NavHideHighlightOneFrame = true; } // Attention! BeginPopup() adds default flags when calling BeginPopupEx()! bool ImGui::BeginPopupEx(ImGuiID id, ImGuiWindowFlags extra_window_flags) { ImGuiContext& g = *GImGui; if (!IsPopupOpen(id, ImGuiPopupFlags_None)) { g.NextWindowData.ClearFlags(); // We behave like Begin() and need to consume those values return false; } char name[20]; IM_ASSERT((extra_window_flags & ImGuiWindowFlags_ChildMenu) == 0); // Use BeginPopupMenuEx() ImFormatString(name, IM_ARRAYSIZE(name), "##Popup_%08x", id); // No recycling, so we can close/open during the same frame bool is_open = Begin(name, NULL, extra_window_flags | ImGuiWindowFlags_Popup); if (!is_open) // NB: Begin can return false when the popup is completely clipped (e.g. zero size display) EndPopup(); //g.CurrentWindow->FocusRouteParentWindow = g.CurrentWindow->ParentWindowInBeginStack; return is_open; } bool ImGui::BeginPopupMenuEx(ImGuiID id, const char* label, ImGuiWindowFlags extra_window_flags) { ImGuiContext& g = *GImGui; if (!IsPopupOpen(id, ImGuiPopupFlags_None)) { g.NextWindowData.ClearFlags(); // We behave like Begin() and need to consume those values return false; } char name[128]; IM_ASSERT(extra_window_flags & ImGuiWindowFlags_ChildMenu); ImFormatString(name, IM_ARRAYSIZE(name), "%s###Menu_%02d", label, g.BeginMenuDepth); // Recycle windows based on depth bool is_open = Begin(name, NULL, extra_window_flags | ImGuiWindowFlags_Popup); if (!is_open) // NB: Begin can return false when the popup is completely clipped (e.g. zero size display) EndPopup(); //g.CurrentWindow->FocusRouteParentWindow = g.CurrentWindow->ParentWindowInBeginStack; return is_open; } bool ImGui::BeginPopup(const char* str_id, ImGuiWindowFlags flags) { ImGuiContext& g = *GImGui; if (g.OpenPopupStack.Size <= g.BeginPopupStack.Size) // Early out for performance { g.NextWindowData.ClearFlags(); // We behave like Begin() and need to consume those values return false; } flags |= ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoSavedSettings; ImGuiID id = g.CurrentWindow->GetID(str_id); return BeginPopupEx(id, flags); } // If 'p_open' is specified for a modal popup window, the popup will have a regular close button which will close the popup. // Note that popup visibility status is owned by Dear ImGui (and manipulated with e.g. OpenPopup). // - *p_open set back to false in BeginPopupModal() when popup is not open. // - if you set *p_open to false before calling BeginPopupModal(), it will close the popup. bool ImGui::BeginPopupModal(const char* name, bool* p_open, ImGuiWindowFlags flags) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; const ImGuiID id = window->GetID(name); if (!IsPopupOpen(id, ImGuiPopupFlags_None)) { g.NextWindowData.ClearFlags(); // We behave like Begin() and need to consume those values if (p_open && *p_open) *p_open = false; return false; } // Center modal windows by default for increased visibility // (this won't really last as settings will kick in, and is mostly for backward compatibility. user may do the same themselves) // FIXME: Should test for (PosCond & window->SetWindowPosAllowFlags) with the upcoming window. if ((g.NextWindowData.HasFlags & ImGuiNextWindowDataFlags_HasPos) == 0) { const ImGuiViewport* viewport = GetMainViewport(); SetNextWindowPos(viewport->GetCenter(), ImGuiCond_FirstUseEver, ImVec2(0.5f, 0.5f)); } flags |= ImGuiWindowFlags_Popup | ImGuiWindowFlags_Modal | ImGuiWindowFlags_NoCollapse; const bool is_open = Begin(name, p_open, flags); if (!is_open || (p_open && !*p_open)) // NB: is_open can be 'false' when the popup is completely clipped (e.g. zero size display) { EndPopup(); if (is_open) ClosePopupToLevel(g.BeginPopupStack.Size, true); return false; } return is_open; } void ImGui::EndPopup() { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; IM_ASSERT(window->Flags & ImGuiWindowFlags_Popup); // Mismatched BeginPopup()/EndPopup() calls IM_ASSERT(g.BeginPopupStack.Size > 0); // Make all menus and popups wrap around for now, may need to expose that policy (e.g. focus scope could include wrap/loop policy flags used by new move requests) if (g.NavWindow == window) NavMoveRequestTryWrapping(window, ImGuiNavMoveFlags_LoopY); // Child-popups don't need to be laid out const ImGuiID backup_within_end_child_id = g.WithinEndChildID; if (window->Flags & ImGuiWindowFlags_ChildWindow) g.WithinEndChildID = window->ID; End(); g.WithinEndChildID = backup_within_end_child_id; } // Helper to open a popup if mouse button is released over the item // - This is essentially the same as BeginPopupContextItem() but without the trailing BeginPopup() void ImGui::OpenPopupOnItemClick(const char* str_id, ImGuiPopupFlags popup_flags) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; int mouse_button = (popup_flags & ImGuiPopupFlags_MouseButtonMask_); if (IsMouseReleased(mouse_button) && IsItemHovered(ImGuiHoveredFlags_AllowWhenBlockedByPopup)) { ImGuiID id = str_id ? window->GetID(str_id) : g.LastItemData.ID; // If user hasn't passed an ID, we can use the LastItemID. Using LastItemID as a Popup ID won't conflict! IM_ASSERT(id != 0); // You cannot pass a NULL str_id if the last item has no identifier (e.g. a Text() item) OpenPopupEx(id, popup_flags); } } // This is a helper to handle the simplest case of associating one named popup to one given widget. // - To create a popup associated to the last item, you generally want to pass a NULL value to str_id. // - To create a popup with a specific identifier, pass it in str_id. // - This is useful when using using BeginPopupContextItem() on an item which doesn't have an identifier, e.g. a Text() call. // - This is useful when multiple code locations may want to manipulate/open the same popup, given an explicit id. // - You may want to handle the whole on user side if you have specific needs (e.g. tweaking IsItemHovered() parameters). // This is essentially the same as: // id = str_id ? GetID(str_id) : GetItemID(); // OpenPopupOnItemClick(str_id, ImGuiPopupFlags_MouseButtonRight); // return BeginPopup(id); // Which is essentially the same as: // id = str_id ? GetID(str_id) : GetItemID(); // if (IsItemHovered() && IsMouseReleased(ImGuiMouseButton_Right)) // OpenPopup(id); // return BeginPopup(id); // The main difference being that this is tweaked to avoid computing the ID twice. bool ImGui::BeginPopupContextItem(const char* str_id, ImGuiPopupFlags popup_flags) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; if (window->SkipItems) return false; ImGuiID id = str_id ? window->GetID(str_id) : g.LastItemData.ID; // If user hasn't passed an ID, we can use the LastItemID. Using LastItemID as a Popup ID won't conflict! IM_ASSERT(id != 0); // You cannot pass a NULL str_id if the last item has no identifier (e.g. a Text() item) int mouse_button = (popup_flags & ImGuiPopupFlags_MouseButtonMask_); if (IsMouseReleased(mouse_button) && IsItemHovered(ImGuiHoveredFlags_AllowWhenBlockedByPopup)) OpenPopupEx(id, popup_flags); return BeginPopupEx(id, ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoSavedSettings); } bool ImGui::BeginPopupContextWindow(const char* str_id, ImGuiPopupFlags popup_flags) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; if (!str_id) str_id = "window_context"; ImGuiID id = window->GetID(str_id); int mouse_button = (popup_flags & ImGuiPopupFlags_MouseButtonMask_); if (IsMouseReleased(mouse_button) && IsWindowHovered(ImGuiHoveredFlags_AllowWhenBlockedByPopup)) if (!(popup_flags & ImGuiPopupFlags_NoOpenOverItems) || !IsAnyItemHovered()) OpenPopupEx(id, popup_flags); return BeginPopupEx(id, ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoSavedSettings); } bool ImGui::BeginPopupContextVoid(const char* str_id, ImGuiPopupFlags popup_flags) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; if (!str_id) str_id = "void_context"; ImGuiID id = window->GetID(str_id); int mouse_button = (popup_flags & ImGuiPopupFlags_MouseButtonMask_); if (IsMouseReleased(mouse_button) && !IsWindowHovered(ImGuiHoveredFlags_AnyWindow)) if (GetTopMostPopupModal() == NULL) OpenPopupEx(id, popup_flags); return BeginPopupEx(id, ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoSavedSettings); } // r_avoid = the rectangle to avoid (e.g. for tooltip it is a rectangle around the mouse cursor which we want to avoid. for popups it's a small point around the cursor.) // r_outer = the visible area rectangle, minus safe area padding. If our popup size won't fit because of safe area padding we ignore it. // (r_outer is usually equivalent to the viewport rectangle minus padding, but when multi-viewports are enabled and monitor // information are available, it may represent the entire platform monitor from the frame of reference of the current viewport. // this allows us to have tooltips/popups displayed out of the parent viewport.) ImVec2 ImGui::FindBestWindowPosForPopupEx(const ImVec2& ref_pos, const ImVec2& size, ImGuiDir* last_dir, const ImRect& r_outer, const ImRect& r_avoid, ImGuiPopupPositionPolicy policy) { ImVec2 base_pos_clamped = ImClamp(ref_pos, r_outer.Min, r_outer.Max - size); //GetForegroundDrawList()->AddRect(r_avoid.Min, r_avoid.Max, IM_COL32(255,0,0,255)); //GetForegroundDrawList()->AddRect(r_outer.Min, r_outer.Max, IM_COL32(0,255,0,255)); // Combo Box policy (we want a connecting edge) if (policy == ImGuiPopupPositionPolicy_ComboBox) { const ImGuiDir dir_prefered_order[ImGuiDir_COUNT] = { ImGuiDir_Down, ImGuiDir_Right, ImGuiDir_Left, ImGuiDir_Up }; for (int n = (*last_dir != ImGuiDir_None) ? -1 : 0; n < ImGuiDir_COUNT; n++) { const ImGuiDir dir = (n == -1) ? *last_dir : dir_prefered_order[n]; if (n != -1 && dir == *last_dir) // Already tried this direction? continue; ImVec2 pos; if (dir == ImGuiDir_Down) pos = ImVec2(r_avoid.Min.x, r_avoid.Max.y); // Below, Toward Right (default) if (dir == ImGuiDir_Right) pos = ImVec2(r_avoid.Min.x, r_avoid.Min.y - size.y); // Above, Toward Right if (dir == ImGuiDir_Left) pos = ImVec2(r_avoid.Max.x - size.x, r_avoid.Max.y); // Below, Toward Left if (dir == ImGuiDir_Up) pos = ImVec2(r_avoid.Max.x - size.x, r_avoid.Min.y - size.y); // Above, Toward Left if (!r_outer.Contains(ImRect(pos, pos + size))) continue; *last_dir = dir; return pos; } } // Tooltip and Default popup policy // (Always first try the direction we used on the last frame, if any) if (policy == ImGuiPopupPositionPolicy_Tooltip || policy == ImGuiPopupPositionPolicy_Default) { const ImGuiDir dir_prefered_order[ImGuiDir_COUNT] = { ImGuiDir_Right, ImGuiDir_Down, ImGuiDir_Up, ImGuiDir_Left }; for (int n = (*last_dir != ImGuiDir_None) ? -1 : 0; n < ImGuiDir_COUNT; n++) { const ImGuiDir dir = (n == -1) ? *last_dir : dir_prefered_order[n]; if (n != -1 && dir == *last_dir) // Already tried this direction? continue; const float avail_w = (dir == ImGuiDir_Left ? r_avoid.Min.x : r_outer.Max.x) - (dir == ImGuiDir_Right ? r_avoid.Max.x : r_outer.Min.x); const float avail_h = (dir == ImGuiDir_Up ? r_avoid.Min.y : r_outer.Max.y) - (dir == ImGuiDir_Down ? r_avoid.Max.y : r_outer.Min.y); // If there's not enough room on one axis, there's no point in positioning on a side on this axis (e.g. when not enough width, use a top/bottom position to maximize available width) if (avail_w < size.x && (dir == ImGuiDir_Left || dir == ImGuiDir_Right)) continue; if (avail_h < size.y && (dir == ImGuiDir_Up || dir == ImGuiDir_Down)) continue; ImVec2 pos; pos.x = (dir == ImGuiDir_Left) ? r_avoid.Min.x - size.x : (dir == ImGuiDir_Right) ? r_avoid.Max.x : base_pos_clamped.x; pos.y = (dir == ImGuiDir_Up) ? r_avoid.Min.y - size.y : (dir == ImGuiDir_Down) ? r_avoid.Max.y : base_pos_clamped.y; // Clamp top-left corner of popup pos.x = ImMax(pos.x, r_outer.Min.x); pos.y = ImMax(pos.y, r_outer.Min.y); *last_dir = dir; return pos; } } // Fallback when not enough room: *last_dir = ImGuiDir_None; // For tooltip we prefer avoiding the cursor at all cost even if it means that part of the tooltip won't be visible. if (policy == ImGuiPopupPositionPolicy_Tooltip) return ref_pos + ImVec2(2, 2); // Otherwise try to keep within display ImVec2 pos = ref_pos; pos.x = ImMax(ImMin(pos.x + size.x, r_outer.Max.x) - size.x, r_outer.Min.x); pos.y = ImMax(ImMin(pos.y + size.y, r_outer.Max.y) - size.y, r_outer.Min.y); return pos; } // Note that this is used for popups, which can overlap the non work-area of individual viewports. ImRect ImGui::GetPopupAllowedExtentRect(ImGuiWindow* window) { ImGuiContext& g = *GImGui; IM_UNUSED(window); ImRect r_screen = ((ImGuiViewportP*)(void*)GetMainViewport())->GetMainRect(); ImVec2 padding = g.Style.DisplaySafeAreaPadding; r_screen.Expand(ImVec2((r_screen.GetWidth() > padding.x * 2) ? -padding.x : 0.0f, (r_screen.GetHeight() > padding.y * 2) ? -padding.y : 0.0f)); return r_screen; } ImVec2 ImGui::FindBestWindowPosForPopup(ImGuiWindow* window) { ImGuiContext& g = *GImGui; ImRect r_outer = GetPopupAllowedExtentRect(window); if (window->Flags & ImGuiWindowFlags_ChildMenu) { // Child menus typically request _any_ position within the parent menu item, and then we move the new menu outside the parent bounds. // This is how we end up with child menus appearing (most-commonly) on the right of the parent menu. IM_ASSERT(g.CurrentWindow == window); ImGuiWindow* parent_window = g.CurrentWindowStack[g.CurrentWindowStack.Size - 2].Window; float horizontal_overlap = g.Style.ItemInnerSpacing.x; // We want some overlap to convey the relative depth of each menu (currently the amount of overlap is hard-coded to style.ItemSpacing.x). ImRect r_avoid; if (parent_window->DC.MenuBarAppending) r_avoid = ImRect(-FLT_MAX, parent_window->ClipRect.Min.y, FLT_MAX, parent_window->ClipRect.Max.y); // Avoid parent menu-bar. If we wanted multi-line menu-bar, we may instead want to have the calling window setup e.g. a NextWindowData.PosConstraintAvoidRect field else r_avoid = ImRect(parent_window->Pos.x + horizontal_overlap, -FLT_MAX, parent_window->Pos.x + parent_window->Size.x - horizontal_overlap - parent_window->ScrollbarSizes.x, FLT_MAX); return FindBestWindowPosForPopupEx(window->Pos, window->Size, &window->AutoPosLastDirection, r_outer, r_avoid, ImGuiPopupPositionPolicy_Default); } if (window->Flags & ImGuiWindowFlags_Popup) { return FindBestWindowPosForPopupEx(window->Pos, window->Size, &window->AutoPosLastDirection, r_outer, ImRect(window->Pos, window->Pos), ImGuiPopupPositionPolicy_Default); // Ideally we'd disable r_avoid here } if (window->Flags & ImGuiWindowFlags_Tooltip) { // Position tooltip (always follows mouse + clamp within outer boundaries) // FIXME: // - Too many paths. One problem is that FindBestWindowPosForPopupEx() doesn't allow passing a suggested position (so touch screen path doesn't use it by default). // - Drag and drop tooltips are not using this path either: BeginTooltipEx() manually sets their position. // - Require some tidying up. In theory we could handle both cases in same location, but requires a bit of shuffling // as drag and drop tooltips are calling SetNextWindowPos() leading to 'window_pos_set_by_api' being set in Begin(). IM_ASSERT(g.CurrentWindow == window); const float scale = g.Style.MouseCursorScale; const ImVec2 ref_pos = NavCalcPreferredRefPos(); if (g.IO.MouseSource == ImGuiMouseSource_TouchScreen && NavCalcPreferredRefPosSource() == ImGuiInputSource_Mouse) { ImVec2 tooltip_pos = ref_pos + TOOLTIP_DEFAULT_OFFSET_TOUCH * scale - (TOOLTIP_DEFAULT_PIVOT_TOUCH * window->Size); if (r_outer.Contains(ImRect(tooltip_pos, tooltip_pos + window->Size))) return tooltip_pos; } ImVec2 tooltip_pos = ref_pos + TOOLTIP_DEFAULT_OFFSET_MOUSE * scale; ImRect r_avoid; if (g.NavCursorVisible && g.NavHighlightItemUnderNav && !g.IO.ConfigNavMoveSetMousePos) r_avoid = ImRect(ref_pos.x - 16, ref_pos.y - 8, ref_pos.x + 16, ref_pos.y + 8); else r_avoid = ImRect(ref_pos.x - 16, ref_pos.y - 8, ref_pos.x + 24 * scale, ref_pos.y + 24 * scale); // FIXME: Hard-coded based on mouse cursor shape expectation. Exact dimension not very important. //GetForegroundDrawList()->AddRect(r_avoid.Min, r_avoid.Max, IM_COL32(255, 0, 255, 255)); return FindBestWindowPosForPopupEx(tooltip_pos, window->Size, &window->AutoPosLastDirection, r_outer, r_avoid, ImGuiPopupPositionPolicy_Tooltip); } IM_ASSERT(0); return window->Pos; } //----------------------------------------------------------------------------- // [SECTION] WINDOW FOCUS //---------------------------------------------------------------------------- // - SetWindowFocus() // - SetNextWindowFocus() // - IsWindowFocused() // - UpdateWindowInFocusOrderList() [Internal] // - BringWindowToFocusFront() [Internal] // - BringWindowToDisplayFront() [Internal] // - BringWindowToDisplayBack() [Internal] // - BringWindowToDisplayBehind() [Internal] // - FindWindowDisplayIndex() [Internal] // - FocusWindow() [Internal] // - FocusTopMostWindowUnderOne() [Internal] //----------------------------------------------------------------------------- void ImGui::SetWindowFocus() { FocusWindow(GImGui->CurrentWindow); } void ImGui::SetWindowFocus(const char* name) { if (name) { if (ImGuiWindow* window = FindWindowByName(name)) FocusWindow(window); } else { FocusWindow(NULL); } } void ImGui::SetNextWindowFocus() { ImGuiContext& g = *GImGui; g.NextWindowData.HasFlags |= ImGuiNextWindowDataFlags_HasFocus; } // Similar to IsWindowHovered() bool ImGui::IsWindowFocused(ImGuiFocusedFlags flags) { ImGuiContext& g = *GImGui; ImGuiWindow* ref_window = g.NavWindow; ImGuiWindow* cur_window = g.CurrentWindow; if (ref_window == NULL) return false; if (flags & ImGuiFocusedFlags_AnyWindow) return true; IM_ASSERT(cur_window); // Not inside a Begin()/End() const bool popup_hierarchy = (flags & ImGuiFocusedFlags_NoPopupHierarchy) == 0; if (flags & ImGuiHoveredFlags_RootWindow) cur_window = GetCombinedRootWindow(cur_window, popup_hierarchy); if (flags & ImGuiHoveredFlags_ChildWindows) return IsWindowChildOf(ref_window, cur_window, popup_hierarchy); else return (ref_window == cur_window); } static int ImGui::FindWindowFocusIndex(ImGuiWindow* window) { ImGuiContext& g = *GImGui; IM_UNUSED(g); int order = window->FocusOrder; IM_ASSERT(window->RootWindow == window); // No child window (not testing _ChildWindow because of docking) IM_ASSERT(g.WindowsFocusOrder[order] == window); return order; } static void ImGui::UpdateWindowInFocusOrderList(ImGuiWindow* window, bool just_created, ImGuiWindowFlags new_flags) { ImGuiContext& g = *GImGui; const bool new_is_explicit_child = (new_flags & ImGuiWindowFlags_ChildWindow) != 0 && ((new_flags & ImGuiWindowFlags_Popup) == 0 || (new_flags & ImGuiWindowFlags_ChildMenu) != 0); const bool child_flag_changed = new_is_explicit_child != window->IsExplicitChild; if ((just_created || child_flag_changed) && !new_is_explicit_child) { IM_ASSERT(!g.WindowsFocusOrder.contains(window)); g.WindowsFocusOrder.push_back(window); window->FocusOrder = (short)(g.WindowsFocusOrder.Size - 1); } else if (!just_created && child_flag_changed && new_is_explicit_child) { IM_ASSERT(g.WindowsFocusOrder[window->FocusOrder] == window); for (int n = window->FocusOrder + 1; n < g.WindowsFocusOrder.Size; n++) g.WindowsFocusOrder[n]->FocusOrder--; g.WindowsFocusOrder.erase(g.WindowsFocusOrder.Data + window->FocusOrder); window->FocusOrder = -1; } window->IsExplicitChild = new_is_explicit_child; } void ImGui::BringWindowToFocusFront(ImGuiWindow* window) { ImGuiContext& g = *GImGui; IM_ASSERT(window == window->RootWindow); const int cur_order = window->FocusOrder; IM_ASSERT(g.WindowsFocusOrder[cur_order] == window); if (g.WindowsFocusOrder.back() == window) return; const int new_order = g.WindowsFocusOrder.Size - 1; for (int n = cur_order; n < new_order; n++) { g.WindowsFocusOrder[n] = g.WindowsFocusOrder[n + 1]; g.WindowsFocusOrder[n]->FocusOrder--; IM_ASSERT(g.WindowsFocusOrder[n]->FocusOrder == n); } g.WindowsFocusOrder[new_order] = window; window->FocusOrder = (short)new_order; } // Note technically focus related but rather adjacent and close to BringWindowToFocusFront() void ImGui::BringWindowToDisplayFront(ImGuiWindow* window) { ImGuiContext& g = *GImGui; ImGuiWindow* current_front_window = g.Windows.back(); if (current_front_window == window || current_front_window->RootWindow == window) // Cheap early out (could be better) return; for (int i = g.Windows.Size - 2; i >= 0; i--) // We can ignore the top-most window if (g.Windows[i] == window) { memmove(&g.Windows[i], &g.Windows[i + 1], (size_t)(g.Windows.Size - i - 1) * sizeof(ImGuiWindow*)); g.Windows[g.Windows.Size - 1] = window; break; } } void ImGui::BringWindowToDisplayBack(ImGuiWindow* window) { ImGuiContext& g = *GImGui; if (g.Windows[0] == window) return; for (int i = 0; i < g.Windows.Size; i++) if (g.Windows[i] == window) { memmove(&g.Windows[1], &g.Windows[0], (size_t)i * sizeof(ImGuiWindow*)); g.Windows[0] = window; break; } } void ImGui::BringWindowToDisplayBehind(ImGuiWindow* window, ImGuiWindow* behind_window) { IM_ASSERT(window != NULL && behind_window != NULL); ImGuiContext& g = *GImGui; window = window->RootWindow; behind_window = behind_window->RootWindow; int pos_wnd = FindWindowDisplayIndex(window); int pos_beh = FindWindowDisplayIndex(behind_window); if (pos_wnd < pos_beh) { size_t copy_bytes = (pos_beh - pos_wnd - 1) * sizeof(ImGuiWindow*); memmove(&g.Windows.Data[pos_wnd], &g.Windows.Data[pos_wnd + 1], copy_bytes); g.Windows[pos_beh - 1] = window; } else { size_t copy_bytes = (pos_wnd - pos_beh) * sizeof(ImGuiWindow*); memmove(&g.Windows.Data[pos_beh + 1], &g.Windows.Data[pos_beh], copy_bytes); g.Windows[pos_beh] = window; } } int ImGui::FindWindowDisplayIndex(ImGuiWindow* window) { ImGuiContext& g = *GImGui; return g.Windows.index_from_ptr(g.Windows.find(window)); } // Moving window to front of display and set focus (which happens to be back of our sorted list) void ImGui::FocusWindow(ImGuiWindow* window, ImGuiFocusRequestFlags flags) { ImGuiContext& g = *GImGui; // Modal check? if ((flags & ImGuiFocusRequestFlags_UnlessBelowModal) && (g.NavWindow != window)) // Early out in common case. if (ImGuiWindow* blocking_modal = FindBlockingModal(window)) { // This block would typically be reached in two situations: // - API call to FocusWindow() with a window under a modal and ImGuiFocusRequestFlags_UnlessBelowModal flag. // - User clicking on void or anything behind a modal while a modal is open (window == NULL) IMGUI_DEBUG_LOG_FOCUS("[focus] FocusWindow(\"%s\", UnlessBelowModal): prevented by \"%s\".\n", window ? window->Name : "", blocking_modal->Name); if (window && window == window->RootWindow && (window->Flags & ImGuiWindowFlags_NoBringToFrontOnFocus) == 0) BringWindowToDisplayBehind(window, blocking_modal); // Still bring right under modal. (FIXME: Could move in focus list too?) ClosePopupsOverWindow(GetTopMostPopupModal(), false); // Note how we need to use GetTopMostPopupModal() aad NOT blocking_modal, to handle nested modals return; } // Find last focused child (if any) and focus it instead. if ((flags & ImGuiFocusRequestFlags_RestoreFocusedChild) && window != NULL) window = NavRestoreLastChildNavWindow(window); // Apply focus if (g.NavWindow != window) { SetNavWindow(window); if (window && g.NavHighlightItemUnderNav) g.NavMousePosDirty = true; g.NavId = window ? window->NavLastIds[0] : 0; // Restore NavId g.NavLayer = ImGuiNavLayer_Main; SetNavFocusScope(window ? window->NavRootFocusScopeId : 0); g.NavIdIsAlive = false; g.NavLastValidSelectionUserData = ImGuiSelectionUserData_Invalid; // Close popups if any ClosePopupsOverWindow(window, false); } // Move the root window to the top of the pile IM_ASSERT(window == NULL || window->RootWindow != NULL); ImGuiWindow* focus_front_window = window ? window->RootWindow : NULL; // NB: In docking branch this is window->RootWindowDockStop ImGuiWindow* display_front_window = window ? window->RootWindow : NULL; // Steal active widgets. Some of the cases it triggers includes: // - Focus a window while an InputText in another window is active, if focus happens before the old InputText can run. // - When using Nav to activate menu items (due to timing of activating on press->new window appears->losing ActiveId) if (g.ActiveId != 0 && g.ActiveIdWindow && g.ActiveIdWindow->RootWindow != focus_front_window) if (!g.ActiveIdNoClearOnFocusLoss) ClearActiveID(); // Passing NULL allow to disable keyboard focus if (!window) return; // Bring to front BringWindowToFocusFront(focus_front_window); if (((window->Flags | display_front_window->Flags) & ImGuiWindowFlags_NoBringToFrontOnFocus) == 0) BringWindowToDisplayFront(display_front_window); } void ImGui::FocusTopMostWindowUnderOne(ImGuiWindow* under_this_window, ImGuiWindow* ignore_window, ImGuiViewport* filter_viewport, ImGuiFocusRequestFlags flags) { ImGuiContext& g = *GImGui; IM_UNUSED(filter_viewport); // Unused in master branch. int start_idx = g.WindowsFocusOrder.Size - 1; if (under_this_window != NULL) { // Aim at root window behind us, if we are in a child window that's our own root (see #4640) int offset = -1; while (under_this_window->Flags & ImGuiWindowFlags_ChildWindow) { under_this_window = under_this_window->ParentWindow; offset = 0; } start_idx = FindWindowFocusIndex(under_this_window) + offset; } for (int i = start_idx; i >= 0; i--) { // We may later decide to test for different NoXXXInputs based on the active navigation input (mouse vs nav) but that may feel more confusing to the user. ImGuiWindow* window = g.WindowsFocusOrder[i]; if (window == ignore_window || !window->WasActive) continue; if ((window->Flags & (ImGuiWindowFlags_NoMouseInputs | ImGuiWindowFlags_NoNavInputs)) != (ImGuiWindowFlags_NoMouseInputs | ImGuiWindowFlags_NoNavInputs)) { FocusWindow(window, flags); return; } } FocusWindow(NULL, flags); } //----------------------------------------------------------------------------- // [SECTION] KEYBOARD/GAMEPAD NAVIGATION //----------------------------------------------------------------------------- // FIXME-NAV: The existence of SetNavID vs SetFocusID vs FocusWindow() needs to be clarified/reworked. // In our terminology those should be interchangeable, yet right now this is super confusing. // Those two functions are merely a legacy artifact, so at minimum naming should be clarified. void ImGui::SetNavCursorVisible(bool visible) { ImGuiContext& g = *GImGui; if (g.IO.ConfigNavCursorVisibleAlways) visible = true; g.NavCursorVisible = visible; } // (was called NavRestoreHighlightAfterMove() before 1.91.4) void ImGui::SetNavCursorVisibleAfterMove() { ImGuiContext& g = *GImGui; if (g.IO.ConfigNavCursorVisibleAuto) g.NavCursorVisible = true; g.NavHighlightItemUnderNav = g.NavMousePosDirty = true; } void ImGui::SetNavWindow(ImGuiWindow* window) { ImGuiContext& g = *GImGui; if (g.NavWindow != window) { IMGUI_DEBUG_LOG_FOCUS("[focus] SetNavWindow(\"%s\")\n", window ? window->Name : ""); g.NavWindow = window; g.NavLastValidSelectionUserData = ImGuiSelectionUserData_Invalid; } g.NavInitRequest = g.NavMoveSubmitted = g.NavMoveScoringItems = false; NavUpdateAnyRequestFlag(); } void ImGui::NavHighlightActivated(ImGuiID id) { ImGuiContext& g = *GImGui; g.NavHighlightActivatedId = id; g.NavHighlightActivatedTimer = NAV_ACTIVATE_HIGHLIGHT_TIMER; } void ImGui::NavClearPreferredPosForAxis(ImGuiAxis axis) { ImGuiContext& g = *GImGui; g.NavWindow->RootWindowForNav->NavPreferredScoringPosRel[g.NavLayer][axis] = FLT_MAX; } void ImGui::SetNavID(ImGuiID id, ImGuiNavLayer nav_layer, ImGuiID focus_scope_id, const ImRect& rect_rel) { ImGuiContext& g = *GImGui; IM_ASSERT(g.NavWindow != NULL); IM_ASSERT(nav_layer == ImGuiNavLayer_Main || nav_layer == ImGuiNavLayer_Menu); g.NavId = id; g.NavLayer = nav_layer; SetNavFocusScope(focus_scope_id); g.NavWindow->NavLastIds[nav_layer] = id; g.NavWindow->NavRectRel[nav_layer] = rect_rel; // Clear preferred scoring position (NavMoveRequestApplyResult() will tend to restore it) NavClearPreferredPosForAxis(ImGuiAxis_X); NavClearPreferredPosForAxis(ImGuiAxis_Y); } void ImGui::SetFocusID(ImGuiID id, ImGuiWindow* window) { ImGuiContext& g = *GImGui; IM_ASSERT(id != 0); if (g.NavWindow != window) SetNavWindow(window); // Assume that SetFocusID() is called in the context where its window->DC.NavLayerCurrent and g.CurrentFocusScopeId are valid. // Note that window may be != g.CurrentWindow (e.g. SetFocusID call in InputTextEx for multi-line text) const ImGuiNavLayer nav_layer = window->DC.NavLayerCurrent; g.NavId = id; g.NavLayer = nav_layer; SetNavFocusScope(g.CurrentFocusScopeId); window->NavLastIds[nav_layer] = id; if (g.LastItemData.ID == id) window->NavRectRel[nav_layer] = WindowRectAbsToRel(window, g.LastItemData.NavRect); if (g.ActiveIdSource == ImGuiInputSource_Keyboard || g.ActiveIdSource == ImGuiInputSource_Gamepad) g.NavHighlightItemUnderNav = true; else if (g.IO.ConfigNavCursorVisibleAuto) g.NavCursorVisible = false; // Clear preferred scoring position (NavMoveRequestApplyResult() will tend to restore it) NavClearPreferredPosForAxis(ImGuiAxis_X); NavClearPreferredPosForAxis(ImGuiAxis_Y); } static ImGuiDir ImGetDirQuadrantFromDelta(float dx, float dy) { if (ImFabs(dx) > ImFabs(dy)) return (dx > 0.0f) ? ImGuiDir_Right : ImGuiDir_Left; return (dy > 0.0f) ? ImGuiDir_Down : ImGuiDir_Up; } static float inline NavScoreItemDistInterval(float cand_min, float cand_max, float curr_min, float curr_max) { if (cand_max < curr_min) return cand_max - curr_min; if (curr_max < cand_min) return cand_min - curr_max; return 0.0f; } // Scoring function for keyboard/gamepad directional navigation. Based on https://gist.github.com/rygorous/6981057 static bool ImGui::NavScoreItem(ImGuiNavItemData* result) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; if (g.NavLayer != window->DC.NavLayerCurrent) return false; // FIXME: Those are not good variables names ImRect cand = g.LastItemData.NavRect; // Current item nav rectangle const ImRect curr = g.NavScoringRect; // Current modified source rect (NB: we've applied Max.x = Min.x in NavUpdate() to inhibit the effect of having varied item width) g.NavScoringDebugCount++; // When entering through a NavFlattened border, we consider child window items as fully clipped for scoring if (window->ParentWindow == g.NavWindow) { IM_ASSERT((window->ChildFlags | g.NavWindow->ChildFlags) & ImGuiChildFlags_NavFlattened); if (!window->ClipRect.Overlaps(cand)) return false; cand.ClipWithFull(window->ClipRect); // This allows the scored item to not overlap other candidates in the parent window } // Compute distance between boxes // FIXME-NAV: Introducing biases for vertical navigation, needs to be removed. float dbx = NavScoreItemDistInterval(cand.Min.x, cand.Max.x, curr.Min.x, curr.Max.x); float dby = NavScoreItemDistInterval(ImLerp(cand.Min.y, cand.Max.y, 0.2f), ImLerp(cand.Min.y, cand.Max.y, 0.8f), ImLerp(curr.Min.y, curr.Max.y, 0.2f), ImLerp(curr.Min.y, curr.Max.y, 0.8f)); // Scale down on Y to keep using box-distance for vertically touching items if (dby != 0.0f && dbx != 0.0f) dbx = (dbx / 1000.0f) + ((dbx > 0.0f) ? +1.0f : -1.0f); float dist_box = ImFabs(dbx) + ImFabs(dby); // Compute distance between centers (this is off by a factor of 2, but we only compare center distances with each other so it doesn't matter) float dcx = (cand.Min.x + cand.Max.x) - (curr.Min.x + curr.Max.x); float dcy = (cand.Min.y + cand.Max.y) - (curr.Min.y + curr.Max.y); float dist_center = ImFabs(dcx) + ImFabs(dcy); // L1 metric (need this for our connectedness guarantee) // Determine which quadrant of 'curr' our candidate item 'cand' lies in based on distance ImGuiDir quadrant; float dax = 0.0f, day = 0.0f, dist_axial = 0.0f; if (dbx != 0.0f || dby != 0.0f) { // For non-overlapping boxes, use distance between boxes // FIXME-NAV: Quadrant may be incorrect because of (1) dbx bias and (2) curr.Max.y bias applied by NavBiasScoringRect() where typically curr.Max.y==curr.Min.y // One typical case where this happens, with style.WindowMenuButtonPosition == ImGuiDir_Right, pressing Left to navigate from Close to Collapse tends to fail. // Also see #6344. Calling ImGetDirQuadrantFromDelta() with unbiased values may be good but side-effects are plenty. dax = dbx; day = dby; dist_axial = dist_box; quadrant = ImGetDirQuadrantFromDelta(dbx, dby); } else if (dcx != 0.0f || dcy != 0.0f) { // For overlapping boxes with different centers, use distance between centers dax = dcx; day = dcy; dist_axial = dist_center; quadrant = ImGetDirQuadrantFromDelta(dcx, dcy); } else { // Degenerate case: two overlapping buttons with same center, break ties arbitrarily (note that LastItemId here is really the _previous_ item order, but it doesn't matter) quadrant = (g.LastItemData.ID < g.NavId) ? ImGuiDir_Left : ImGuiDir_Right; } const ImGuiDir move_dir = g.NavMoveDir; #if IMGUI_DEBUG_NAV_SCORING char buf[200]; if (g.IO.KeyCtrl) // Hold CTRL to preview score in matching quadrant. CTRL+Arrow to rotate. { if (quadrant == move_dir) { ImFormatString(buf, IM_ARRAYSIZE(buf), "%.0f/%.0f", dist_box, dist_center); ImDrawList* draw_list = GetForegroundDrawList(window); draw_list->AddRectFilled(cand.Min, cand.Max, IM_COL32(255, 0, 0, 80)); draw_list->AddRectFilled(cand.Min, cand.Min + CalcTextSize(buf), IM_COL32(255, 0, 0, 200)); draw_list->AddText(cand.Min, IM_COL32(255, 255, 255, 255), buf); } } const bool debug_hovering = IsMouseHoveringRect(cand.Min, cand.Max); const bool debug_tty = (g.IO.KeyCtrl && IsKeyPressed(ImGuiKey_Space)); if (debug_hovering || debug_tty) { ImFormatString(buf, IM_ARRAYSIZE(buf), "d-box (%7.3f,%7.3f) -> %7.3f\nd-center (%7.3f,%7.3f) -> %7.3f\nd-axial (%7.3f,%7.3f) -> %7.3f\nnav %c, quadrant %c", dbx, dby, dist_box, dcx, dcy, dist_center, dax, day, dist_axial, "-WENS"[move_dir+1], "-WENS"[quadrant+1]); if (debug_hovering) { ImDrawList* draw_list = GetForegroundDrawList(window); draw_list->AddRect(curr.Min, curr.Max, IM_COL32(255, 200, 0, 100)); draw_list->AddRect(cand.Min, cand.Max, IM_COL32(255, 255, 0, 200)); draw_list->AddRectFilled(cand.Max - ImVec2(4, 4), cand.Max + CalcTextSize(buf) + ImVec2(4, 4), IM_COL32(40, 0, 0, 200)); draw_list->AddText(cand.Max, ~0U, buf); } if (debug_tty) { IMGUI_DEBUG_LOG_NAV("id 0x%08X\n%s\n", g.LastItemData.ID, buf); } } #endif // Is it in the quadrant we're interested in moving to? bool new_best = false; if (quadrant == move_dir) { // Does it beat the current best candidate? if (dist_box < result->DistBox) { result->DistBox = dist_box; result->DistCenter = dist_center; return true; } if (dist_box == result->DistBox) { // Try using distance between center points to break ties if (dist_center < result->DistCenter) { result->DistCenter = dist_center; new_best = true; } else if (dist_center == result->DistCenter) { // Still tied! we need to be extra-careful to make sure everything gets linked properly. We consistently break ties by symbolically moving "later" items // (with higher index) to the right/downwards by an infinitesimal amount since we the current "best" button already (so it must have a lower index), // this is fairly easy. This rule ensures that all buttons with dx==dy==0 will end up being linked in order of appearance along the x axis. if (((move_dir == ImGuiDir_Up || move_dir == ImGuiDir_Down) ? dby : dbx) < 0.0f) // moving bj to the right/down decreases distance new_best = true; } } } // Axial check: if 'curr' has no link at all in some direction and 'cand' lies roughly in that direction, add a tentative link. This will only be kept if no "real" matches // are found, so it only augments the graph produced by the above method using extra links. (important, since it doesn't guarantee strong connectedness) // This is just to avoid buttons having no links in a particular direction when there's a suitable neighbor. you get good graphs without this too. // 2017/09/29: FIXME: This now currently only enabled inside menu bars, ideally we'd disable it everywhere. Menus in particular need to catch failure. For general navigation it feels awkward. // Disabling it may lead to disconnected graphs when nodes are very spaced out on different axis. Perhaps consider offering this as an option? if (result->DistBox == FLT_MAX && dist_axial < result->DistAxial) // Check axial match if (g.NavLayer == ImGuiNavLayer_Menu && !(g.NavWindow->Flags & ImGuiWindowFlags_ChildMenu)) if ((move_dir == ImGuiDir_Left && dax < 0.0f) || (move_dir == ImGuiDir_Right && dax > 0.0f) || (move_dir == ImGuiDir_Up && day < 0.0f) || (move_dir == ImGuiDir_Down && day > 0.0f)) { result->DistAxial = dist_axial; new_best = true; } return new_best; } static void ImGui::NavApplyItemToResult(ImGuiNavItemData* result) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; result->Window = window; result->ID = g.LastItemData.ID; result->FocusScopeId = g.CurrentFocusScopeId; result->ItemFlags = g.LastItemData.ItemFlags; result->RectRel = WindowRectAbsToRel(window, g.LastItemData.NavRect); if (result->ItemFlags & ImGuiItemFlags_HasSelectionUserData) { IM_ASSERT(g.NextItemData.SelectionUserData != ImGuiSelectionUserData_Invalid); result->SelectionUserData = g.NextItemData.SelectionUserData; // INTENTIONAL: At this point this field is not cleared in NextItemData. Avoid unnecessary copy to LastItemData. } } // True when current work location may be scrolled horizontally when moving left / right. // This is generally always true UNLESS within a column. We don't have a vertical equivalent. void ImGui::NavUpdateCurrentWindowIsScrollPushableX() { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; window->DC.NavIsScrollPushableX = (g.CurrentTable == NULL && window->DC.CurrentColumns == NULL); } // We get there when either NavId == id, or when g.NavAnyRequest is set (which is updated by NavUpdateAnyRequestFlag above) // This is called after LastItemData is set, but NextItemData is also still valid. static void ImGui::NavProcessItem() { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; const ImGuiID id = g.LastItemData.ID; const ImGuiItemFlags item_flags = g.LastItemData.ItemFlags; // When inside a container that isn't scrollable with Left<>Right, clip NavRect accordingly (#2221) if (window->DC.NavIsScrollPushableX == false) { g.LastItemData.NavRect.Min.x = ImClamp(g.LastItemData.NavRect.Min.x, window->ClipRect.Min.x, window->ClipRect.Max.x); g.LastItemData.NavRect.Max.x = ImClamp(g.LastItemData.NavRect.Max.x, window->ClipRect.Min.x, window->ClipRect.Max.x); } const ImRect nav_bb = g.LastItemData.NavRect; // Process Init Request if (g.NavInitRequest && g.NavLayer == window->DC.NavLayerCurrent && (item_flags & ImGuiItemFlags_Disabled) == 0) { // Even if 'ImGuiItemFlags_NoNavDefaultFocus' is on (typically collapse/close button) we record the first ResultId so they can be used as a fallback const bool candidate_for_nav_default_focus = (item_flags & ImGuiItemFlags_NoNavDefaultFocus) == 0; if (candidate_for_nav_default_focus || g.NavInitResult.ID == 0) { NavApplyItemToResult(&g.NavInitResult); } if (candidate_for_nav_default_focus) { g.NavInitRequest = false; // Found a match, clear request NavUpdateAnyRequestFlag(); } } // Process Move Request (scoring for navigation) // FIXME-NAV: Consider policy for double scoring (scoring from NavScoringRect + scoring from a rect wrapped according to current wrapping policy) if (g.NavMoveScoringItems && (item_flags & ImGuiItemFlags_Disabled) == 0) { if ((g.NavMoveFlags & ImGuiNavMoveFlags_FocusApi) || (window->Flags & ImGuiWindowFlags_NoNavInputs) == 0) { const bool is_tabbing = (g.NavMoveFlags & ImGuiNavMoveFlags_IsTabbing) != 0; if (is_tabbing) { NavProcessItemForTabbingRequest(id, item_flags, g.NavMoveFlags); } else if (g.NavId != id || (g.NavMoveFlags & ImGuiNavMoveFlags_AllowCurrentNavId)) { ImGuiNavItemData* result = (window == g.NavWindow) ? &g.NavMoveResultLocal : &g.NavMoveResultOther; if (NavScoreItem(result)) NavApplyItemToResult(result); // Features like PageUp/PageDown need to maintain a separate score for the visible set of items. const float VISIBLE_RATIO = 0.70f; if ((g.NavMoveFlags & ImGuiNavMoveFlags_AlsoScoreVisibleSet) && window->ClipRect.Overlaps(nav_bb)) if (ImClamp(nav_bb.Max.y, window->ClipRect.Min.y, window->ClipRect.Max.y) - ImClamp(nav_bb.Min.y, window->ClipRect.Min.y, window->ClipRect.Max.y) >= (nav_bb.Max.y - nav_bb.Min.y) * VISIBLE_RATIO) if (NavScoreItem(&g.NavMoveResultLocalVisible)) NavApplyItemToResult(&g.NavMoveResultLocalVisible); } } } // Update information for currently focused/navigated item if (g.NavId == id) { if (g.NavWindow != window) SetNavWindow(window); // Always refresh g.NavWindow, because some operations such as FocusItem() may not have a window. g.NavLayer = window->DC.NavLayerCurrent; SetNavFocusScope(g.CurrentFocusScopeId); // Will set g.NavFocusScopeId AND store g.NavFocusScopePath g.NavFocusScopeId = g.CurrentFocusScopeId; g.NavIdIsAlive = true; if (g.LastItemData.ItemFlags & ImGuiItemFlags_HasSelectionUserData) { IM_ASSERT(g.NextItemData.SelectionUserData != ImGuiSelectionUserData_Invalid); g.NavLastValidSelectionUserData = g.NextItemData.SelectionUserData; // INTENTIONAL: At this point this field is not cleared in NextItemData. Avoid unnecessary copy to LastItemData. } window->NavRectRel[window->DC.NavLayerCurrent] = WindowRectAbsToRel(window, nav_bb); // Store item bounding box (relative to window position) } } // Handle "scoring" of an item for a tabbing/focusing request initiated by NavUpdateCreateTabbingRequest(). // Note that SetKeyboardFocusHere() API calls are considered tabbing requests! // - Case 1: no nav/active id: set result to first eligible item, stop storing. // - Case 2: tab forward: on ref id set counter, on counter elapse store result // - Case 3: tab forward wrap: set result to first eligible item (preemptively), on ref id set counter, on next frame if counter hasn't elapsed store result. // FIXME-TABBING: Could be done as a next-frame forwarded request // - Case 4: tab backward: store all results, on ref id pick prev, stop storing // - Case 5: tab backward wrap: store all results, on ref id if no result keep storing until last // FIXME-TABBING: Could be done as next-frame forwarded requested void ImGui::NavProcessItemForTabbingRequest(ImGuiID id, ImGuiItemFlags item_flags, ImGuiNavMoveFlags move_flags) { ImGuiContext& g = *GImGui; if ((move_flags & ImGuiNavMoveFlags_FocusApi) == 0) { if (g.NavLayer != g.CurrentWindow->DC.NavLayerCurrent) return; if (g.NavFocusScopeId != g.CurrentFocusScopeId) return; } // - Can always land on an item when using API call. // - Tabbing with _NavEnableKeyboard (space/enter/arrows): goes through every item. // - Tabbing without _NavEnableKeyboard: goes through inputable items only. bool can_stop; if (move_flags & ImGuiNavMoveFlags_FocusApi) can_stop = true; else can_stop = (item_flags & ImGuiItemFlags_NoTabStop) == 0 && ((g.IO.ConfigFlags & ImGuiConfigFlags_NavEnableKeyboard) || (item_flags & ImGuiItemFlags_Inputable)); // Always store in NavMoveResultLocal (unlike directional request which uses NavMoveResultOther on sibling/flattened windows) ImGuiNavItemData* result = &g.NavMoveResultLocal; if (g.NavTabbingDir == +1) { // Tab Forward or SetKeyboardFocusHere() with >= 0 if (can_stop && g.NavTabbingResultFirst.ID == 0) NavApplyItemToResult(&g.NavTabbingResultFirst); if (can_stop && g.NavTabbingCounter > 0 && --g.NavTabbingCounter == 0) NavMoveRequestResolveWithLastItem(result); else if (g.NavId == id) g.NavTabbingCounter = 1; } else if (g.NavTabbingDir == -1) { // Tab Backward if (g.NavId == id) { if (result->ID) { g.NavMoveScoringItems = false; NavUpdateAnyRequestFlag(); } } else if (can_stop) { // Keep applying until reaching NavId NavApplyItemToResult(result); } } else if (g.NavTabbingDir == 0) { if (can_stop && g.NavId == id) NavMoveRequestResolveWithLastItem(result); if (can_stop && g.NavTabbingResultFirst.ID == 0) // Tab init NavApplyItemToResult(&g.NavTabbingResultFirst); } } bool ImGui::NavMoveRequestButNoResultYet() { ImGuiContext& g = *GImGui; return g.NavMoveScoringItems && g.NavMoveResultLocal.ID == 0 && g.NavMoveResultOther.ID == 0; } // FIXME: ScoringRect is not set void ImGui::NavMoveRequestSubmit(ImGuiDir move_dir, ImGuiDir clip_dir, ImGuiNavMoveFlags move_flags, ImGuiScrollFlags scroll_flags) { ImGuiContext& g = *GImGui; IM_ASSERT(g.NavWindow != NULL); //IMGUI_DEBUG_LOG_NAV("[nav] NavMoveRequestSubmit: dir %c, window \"%s\"\n", "-WENS"[move_dir + 1], g.NavWindow->Name); if (move_flags & ImGuiNavMoveFlags_IsTabbing) move_flags |= ImGuiNavMoveFlags_AllowCurrentNavId; g.NavMoveSubmitted = g.NavMoveScoringItems = true; g.NavMoveDir = move_dir; g.NavMoveDirForDebug = move_dir; g.NavMoveClipDir = clip_dir; g.NavMoveFlags = move_flags; g.NavMoveScrollFlags = scroll_flags; g.NavMoveForwardToNextFrame = false; g.NavMoveKeyMods = (move_flags & ImGuiNavMoveFlags_FocusApi) ? 0 : g.IO.KeyMods; g.NavMoveResultLocal.Clear(); g.NavMoveResultLocalVisible.Clear(); g.NavMoveResultOther.Clear(); g.NavTabbingCounter = 0; g.NavTabbingResultFirst.Clear(); NavUpdateAnyRequestFlag(); } void ImGui::NavMoveRequestResolveWithLastItem(ImGuiNavItemData* result) { ImGuiContext& g = *GImGui; g.NavMoveScoringItems = false; // Ensure request doesn't need more processing NavApplyItemToResult(result); NavUpdateAnyRequestFlag(); } // Called by TreePop() to implement ImGuiTreeNodeFlags_NavLeftJumpsBackHere void ImGui::NavMoveRequestResolveWithPastTreeNode(ImGuiNavItemData* result, ImGuiTreeNodeStackData* tree_node_data) { ImGuiContext& g = *GImGui; g.NavMoveScoringItems = false; g.LastItemData.ID = tree_node_data->ID; g.LastItemData.ItemFlags = tree_node_data->ItemFlags & ~ImGuiItemFlags_HasSelectionUserData; // Losing SelectionUserData, recovered next-frame (cheaper). g.LastItemData.NavRect = tree_node_data->NavRect; NavApplyItemToResult(result); // Result this instead of implementing a NavApplyPastTreeNodeToResult() NavClearPreferredPosForAxis(ImGuiAxis_Y); NavUpdateAnyRequestFlag(); } void ImGui::NavMoveRequestCancel() { ImGuiContext& g = *GImGui; g.NavMoveSubmitted = g.NavMoveScoringItems = false; NavUpdateAnyRequestFlag(); } // Forward will reuse the move request again on the next frame (generally with modifications done to it) void ImGui::NavMoveRequestForward(ImGuiDir move_dir, ImGuiDir clip_dir, ImGuiNavMoveFlags move_flags, ImGuiScrollFlags scroll_flags) { ImGuiContext& g = *GImGui; IM_ASSERT(g.NavMoveForwardToNextFrame == false); NavMoveRequestCancel(); g.NavMoveForwardToNextFrame = true; g.NavMoveDir = move_dir; g.NavMoveClipDir = clip_dir; g.NavMoveFlags = move_flags | ImGuiNavMoveFlags_Forwarded; g.NavMoveScrollFlags = scroll_flags; } // Navigation wrap-around logic is delayed to the end of the frame because this operation is only valid after entire // popup is assembled and in case of appended popups it is not clear which EndPopup() call is final. void ImGui::NavMoveRequestTryWrapping(ImGuiWindow* window, ImGuiNavMoveFlags wrap_flags) { ImGuiContext& g = *GImGui; IM_ASSERT((wrap_flags & ImGuiNavMoveFlags_WrapMask_ ) != 0 && (wrap_flags & ~ImGuiNavMoveFlags_WrapMask_) == 0); // Call with _WrapX, _WrapY, _LoopX, _LoopY // In theory we should test for NavMoveRequestButNoResultYet() but there's no point doing it: // as NavEndFrame() will do the same test. It will end up calling NavUpdateCreateWrappingRequest(). if (g.NavWindow == window && g.NavMoveScoringItems && g.NavLayer == ImGuiNavLayer_Main) g.NavMoveFlags = (g.NavMoveFlags & ~ImGuiNavMoveFlags_WrapMask_) | wrap_flags; } // FIXME: This could be replaced by updating a frame number in each window when (window == NavWindow) and (NavLayer == 0). // This way we could find the last focused window among our children. It would be much less confusing this way? static void ImGui::NavSaveLastChildNavWindowIntoParent(ImGuiWindow* nav_window) { ImGuiWindow* parent = nav_window; while (parent && parent->RootWindow != parent && (parent->Flags & (ImGuiWindowFlags_Popup | ImGuiWindowFlags_ChildMenu)) == 0) parent = parent->ParentWindow; if (parent && parent != nav_window) parent->NavLastChildNavWindow = nav_window; } // Restore the last focused child. // Call when we are expected to land on the Main Layer (0) after FocusWindow() static ImGuiWindow* ImGui::NavRestoreLastChildNavWindow(ImGuiWindow* window) { if (window->NavLastChildNavWindow && window->NavLastChildNavWindow->WasActive) return window->NavLastChildNavWindow; return window; } void ImGui::NavRestoreLayer(ImGuiNavLayer layer) { ImGuiContext& g = *GImGui; if (layer == ImGuiNavLayer_Main) { ImGuiWindow* prev_nav_window = g.NavWindow; g.NavWindow = NavRestoreLastChildNavWindow(g.NavWindow); // FIXME-NAV: Should clear ongoing nav requests? g.NavLastValidSelectionUserData = ImGuiSelectionUserData_Invalid; if (prev_nav_window) IMGUI_DEBUG_LOG_FOCUS("[focus] NavRestoreLayer: from \"%s\" to SetNavWindow(\"%s\")\n", prev_nav_window->Name, g.NavWindow->Name); } ImGuiWindow* window = g.NavWindow; if (window->NavLastIds[layer] != 0) { SetNavID(window->NavLastIds[layer], layer, 0, window->NavRectRel[layer]); } else { g.NavLayer = layer; NavInitWindow(window, true); } } static inline void ImGui::NavUpdateAnyRequestFlag() { ImGuiContext& g = *GImGui; g.NavAnyRequest = g.NavMoveScoringItems || g.NavInitRequest || (IMGUI_DEBUG_NAV_SCORING && g.NavWindow != NULL); if (g.NavAnyRequest) IM_ASSERT(g.NavWindow != NULL); } // This needs to be called before we submit any widget (aka in or before Begin) void ImGui::NavInitWindow(ImGuiWindow* window, bool force_reinit) { ImGuiContext& g = *GImGui; IM_ASSERT(window == g.NavWindow); if (window->Flags & ImGuiWindowFlags_NoNavInputs) { g.NavId = 0; SetNavFocusScope(window->NavRootFocusScopeId); return; } bool init_for_nav = false; if (window == window->RootWindow || (window->Flags & ImGuiWindowFlags_Popup) || (window->NavLastIds[0] == 0) || force_reinit) init_for_nav = true; IMGUI_DEBUG_LOG_NAV("[nav] NavInitRequest: from NavInitWindow(), init_for_nav=%d, window=\"%s\", layer=%d\n", init_for_nav, window->Name, g.NavLayer); if (init_for_nav) { SetNavID(0, g.NavLayer, window->NavRootFocusScopeId, ImRect()); g.NavInitRequest = true; g.NavInitRequestFromMove = false; g.NavInitResult.ID = 0; NavUpdateAnyRequestFlag(); } else { g.NavId = window->NavLastIds[0]; SetNavFocusScope(window->NavRootFocusScopeId); } } static ImGuiInputSource ImGui::NavCalcPreferredRefPosSource() { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.NavWindow; const bool activated_shortcut = g.ActiveId != 0 && g.ActiveIdFromShortcut && g.ActiveId == g.LastItemData.ID; // Testing for !activated_shortcut here could in theory be removed if we decided that activating a remote shortcut altered one of the g.NavDisableXXX flag. if ((!g.NavCursorVisible || !g.NavHighlightItemUnderNav || !window) && !activated_shortcut) return ImGuiInputSource_Mouse; else return ImGuiInputSource_Keyboard; // or Nav in general } static ImVec2 ImGui::NavCalcPreferredRefPos() { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.NavWindow; ImGuiInputSource source = NavCalcPreferredRefPosSource(); const bool activated_shortcut = g.ActiveId != 0 && g.ActiveIdFromShortcut && g.ActiveId == g.LastItemData.ID; // Testing for !activated_shortcut here could in theory be removed if we decided that activating a remote shortcut altered one of the g.NavDisableXXX flag. if (source == ImGuiInputSource_Mouse) { // Mouse (we need a fallback in case the mouse becomes invalid after being used) // The +1.0f offset when stored by OpenPopupEx() allows reopening this or another popup (same or another mouse button) while not moving the mouse, it is pretty standard. // In theory we could move that +1.0f offset in OpenPopupEx() ImVec2 p = IsMousePosValid(&g.IO.MousePos) ? g.IO.MousePos : g.MouseLastValidPos; return ImVec2(p.x + 1.0f, p.y); } else { // When navigation is active and mouse is disabled, pick a position around the bottom left of the currently navigated item ImRect ref_rect; if (activated_shortcut) ref_rect = g.LastItemData.NavRect; else ref_rect = WindowRectRelToAbs(window, window->NavRectRel[g.NavLayer]); // Take account of upcoming scrolling (maybe set mouse pos should be done in EndFrame?) if (window->LastFrameActive != g.FrameCount && (window->ScrollTarget.x != FLT_MAX || window->ScrollTarget.y != FLT_MAX)) { ImVec2 next_scroll = CalcNextScrollFromScrollTargetAndClamp(window); ref_rect.Translate(window->Scroll - next_scroll); } ImVec2 pos = ImVec2(ref_rect.Min.x + ImMin(g.Style.FramePadding.x * 4, ref_rect.GetWidth()), ref_rect.Max.y - ImMin(g.Style.FramePadding.y, ref_rect.GetHeight())); ImGuiViewport* viewport = GetMainViewport(); return ImTrunc(ImClamp(pos, viewport->Pos, viewport->Pos + viewport->Size)); // ImTrunc() is important because non-integer mouse position application in backend might be lossy and result in undesirable non-zero delta. } } float ImGui::GetNavTweakPressedAmount(ImGuiAxis axis) { ImGuiContext& g = *GImGui; float repeat_delay, repeat_rate; GetTypematicRepeatRate(ImGuiInputFlags_RepeatRateNavTweak, &repeat_delay, &repeat_rate); ImGuiKey key_less, key_more; if (g.NavInputSource == ImGuiInputSource_Gamepad) { key_less = (axis == ImGuiAxis_X) ? ImGuiKey_GamepadDpadLeft : ImGuiKey_GamepadDpadUp; key_more = (axis == ImGuiAxis_X) ? ImGuiKey_GamepadDpadRight : ImGuiKey_GamepadDpadDown; } else { key_less = (axis == ImGuiAxis_X) ? ImGuiKey_LeftArrow : ImGuiKey_UpArrow; key_more = (axis == ImGuiAxis_X) ? ImGuiKey_RightArrow : ImGuiKey_DownArrow; } float amount = (float)GetKeyPressedAmount(key_more, repeat_delay, repeat_rate) - (float)GetKeyPressedAmount(key_less, repeat_delay, repeat_rate); if (amount != 0.0f && IsKeyDown(key_less) && IsKeyDown(key_more)) // Cancel when opposite directions are held, regardless of repeat phase amount = 0.0f; return amount; } static void ImGui::NavUpdate() { ImGuiContext& g = *GImGui; ImGuiIO& io = g.IO; io.WantSetMousePos = false; //if (g.NavScoringDebugCount > 0) IMGUI_DEBUG_LOG_NAV("[nav] NavScoringDebugCount %d for '%s' layer %d (Init:%d, Move:%d)\n", g.NavScoringDebugCount, g.NavWindow ? g.NavWindow->Name : "NULL", g.NavLayer, g.NavInitRequest || g.NavInitResultId != 0, g.NavMoveRequest); // Set input source based on which keys are last pressed (as some features differs when used with Gamepad vs Keyboard) // FIXME-NAV: Now that keys are separated maybe we can get rid of NavInputSource? const bool nav_gamepad_active = (io.ConfigFlags & ImGuiConfigFlags_NavEnableGamepad) != 0 && (io.BackendFlags & ImGuiBackendFlags_HasGamepad) != 0; const ImGuiKey nav_gamepad_keys_to_change_source[] = { ImGuiKey_GamepadFaceRight, ImGuiKey_GamepadFaceLeft, ImGuiKey_GamepadFaceUp, ImGuiKey_GamepadFaceDown, ImGuiKey_GamepadDpadRight, ImGuiKey_GamepadDpadLeft, ImGuiKey_GamepadDpadUp, ImGuiKey_GamepadDpadDown }; if (nav_gamepad_active) for (ImGuiKey key : nav_gamepad_keys_to_change_source) if (IsKeyDown(key)) g.NavInputSource = ImGuiInputSource_Gamepad; const bool nav_keyboard_active = (io.ConfigFlags & ImGuiConfigFlags_NavEnableKeyboard) != 0; const ImGuiKey nav_keyboard_keys_to_change_source[] = { ImGuiKey_Space, ImGuiKey_Enter, ImGuiKey_Escape, ImGuiKey_RightArrow, ImGuiKey_LeftArrow, ImGuiKey_UpArrow, ImGuiKey_DownArrow }; if (nav_keyboard_active) for (ImGuiKey key : nav_keyboard_keys_to_change_source) if (IsKeyDown(key)) g.NavInputSource = ImGuiInputSource_Keyboard; // Process navigation init request (select first/default focus) g.NavJustMovedToId = 0; g.NavJustMovedToFocusScopeId = g.NavJustMovedFromFocusScopeId = 0; if (g.NavInitResult.ID != 0) NavInitRequestApplyResult(); g.NavInitRequest = false; g.NavInitRequestFromMove = false; g.NavInitResult.ID = 0; // Process navigation move request if (g.NavMoveSubmitted) NavMoveRequestApplyResult(); g.NavTabbingCounter = 0; g.NavMoveSubmitted = g.NavMoveScoringItems = false; if (g.NavCursorHideFrames > 0) if (--g.NavCursorHideFrames == 0) g.NavCursorVisible = true; // Schedule mouse position update (will be done at the bottom of this function, after 1) processing all move requests and 2) updating scrolling) bool set_mouse_pos = false; if (g.NavMousePosDirty && g.NavIdIsAlive) if (g.NavCursorVisible && g.NavHighlightItemUnderNav && g.NavWindow) set_mouse_pos = true; g.NavMousePosDirty = false; IM_ASSERT(g.NavLayer == ImGuiNavLayer_Main || g.NavLayer == ImGuiNavLayer_Menu); // Store our return window (for returning from Menu Layer to Main Layer) and clear it as soon as we step back in our own Layer 0 if (g.NavWindow) NavSaveLastChildNavWindowIntoParent(g.NavWindow); if (g.NavWindow && g.NavWindow->NavLastChildNavWindow != NULL && g.NavLayer == ImGuiNavLayer_Main) g.NavWindow->NavLastChildNavWindow = NULL; // Update CTRL+TAB and Windowing features (hold Square to move/resize/etc.) NavUpdateWindowing(); // Set output flags for user application io.NavActive = (nav_keyboard_active || nav_gamepad_active) && g.NavWindow && !(g.NavWindow->Flags & ImGuiWindowFlags_NoNavInputs); io.NavVisible = (io.NavActive && g.NavId != 0 && g.NavCursorVisible) || (g.NavWindowingTarget != NULL); // Process NavCancel input (to close a popup, get back to parent, clear focus) NavUpdateCancelRequest(); // Process manual activation request g.NavActivateId = g.NavActivateDownId = g.NavActivatePressedId = 0; g.NavActivateFlags = ImGuiActivateFlags_None; if (g.NavId != 0 && g.NavCursorVisible && !g.NavWindowingTarget && g.NavWindow && !(g.NavWindow->Flags & ImGuiWindowFlags_NoNavInputs)) { const bool activate_down = (nav_keyboard_active && IsKeyDown(ImGuiKey_Space, ImGuiKeyOwner_NoOwner)) || (nav_gamepad_active && IsKeyDown(ImGuiKey_NavGamepadActivate, ImGuiKeyOwner_NoOwner)); const bool activate_pressed = activate_down && ((nav_keyboard_active && IsKeyPressed(ImGuiKey_Space, 0, ImGuiKeyOwner_NoOwner)) || (nav_gamepad_active && IsKeyPressed(ImGuiKey_NavGamepadActivate, 0, ImGuiKeyOwner_NoOwner))); const bool input_down = (nav_keyboard_active && (IsKeyDown(ImGuiKey_Enter, ImGuiKeyOwner_NoOwner) || IsKeyDown(ImGuiKey_KeypadEnter, ImGuiKeyOwner_NoOwner))) || (nav_gamepad_active && IsKeyDown(ImGuiKey_NavGamepadInput, ImGuiKeyOwner_NoOwner)); const bool input_pressed = input_down && ((nav_keyboard_active && (IsKeyPressed(ImGuiKey_Enter, 0, ImGuiKeyOwner_NoOwner) || IsKeyPressed(ImGuiKey_KeypadEnter, 0, ImGuiKeyOwner_NoOwner))) || (nav_gamepad_active && IsKeyPressed(ImGuiKey_NavGamepadInput, 0, ImGuiKeyOwner_NoOwner))); if (g.ActiveId == 0 && activate_pressed) { g.NavActivateId = g.NavId; g.NavActivateFlags = ImGuiActivateFlags_PreferTweak; } if ((g.ActiveId == 0 || g.ActiveId == g.NavId) && input_pressed) { g.NavActivateId = g.NavId; g.NavActivateFlags = ImGuiActivateFlags_PreferInput; } if ((g.ActiveId == 0 || g.ActiveId == g.NavId) && (activate_down || input_down)) g.NavActivateDownId = g.NavId; if ((g.ActiveId == 0 || g.ActiveId == g.NavId) && (activate_pressed || input_pressed)) { g.NavActivatePressedId = g.NavId; NavHighlightActivated(g.NavId); } } if (g.NavWindow && (g.NavWindow->Flags & ImGuiWindowFlags_NoNavInputs)) g.NavCursorVisible = false; else if (g.IO.ConfigNavCursorVisibleAlways && g.NavCursorHideFrames == 0) g.NavCursorVisible = true; if (g.NavActivateId != 0) IM_ASSERT(g.NavActivateDownId == g.NavActivateId); // Highlight if (g.NavHighlightActivatedTimer > 0.0f) g.NavHighlightActivatedTimer = ImMax(0.0f, g.NavHighlightActivatedTimer - io.DeltaTime); if (g.NavHighlightActivatedTimer == 0.0f) g.NavHighlightActivatedId = 0; // Process programmatic activation request // FIXME-NAV: Those should eventually be queued (unlike focus they don't cancel each others) if (g.NavNextActivateId != 0) { g.NavActivateId = g.NavActivateDownId = g.NavActivatePressedId = g.NavNextActivateId; g.NavActivateFlags = g.NavNextActivateFlags; } g.NavNextActivateId = 0; // Process move requests NavUpdateCreateMoveRequest(); if (g.NavMoveDir == ImGuiDir_None) NavUpdateCreateTabbingRequest(); NavUpdateAnyRequestFlag(); g.NavIdIsAlive = false; // Scrolling if (g.NavWindow && !(g.NavWindow->Flags & ImGuiWindowFlags_NoNavInputs) && !g.NavWindowingTarget) { // *Fallback* manual-scroll with Nav directional keys when window has no navigable item ImGuiWindow* window = g.NavWindow; const float scroll_speed = IM_ROUND(window->FontRefSize * 100 * io.DeltaTime); // We need round the scrolling speed because sub-pixel scroll isn't reliably supported. const ImGuiDir move_dir = g.NavMoveDir; if (window->DC.NavLayersActiveMask == 0x00 && window->DC.NavWindowHasScrollY && move_dir != ImGuiDir_None) { if (move_dir == ImGuiDir_Left || move_dir == ImGuiDir_Right) SetScrollX(window, ImTrunc(window->Scroll.x + ((move_dir == ImGuiDir_Left) ? -1.0f : +1.0f) * scroll_speed)); if (move_dir == ImGuiDir_Up || move_dir == ImGuiDir_Down) SetScrollY(window, ImTrunc(window->Scroll.y + ((move_dir == ImGuiDir_Up) ? -1.0f : +1.0f) * scroll_speed)); } // *Normal* Manual scroll with LStick // Next movement request will clamp the NavId reference rectangle to the visible area, so navigation will resume within those bounds. if (nav_gamepad_active) { const ImVec2 scroll_dir = GetKeyMagnitude2d(ImGuiKey_GamepadLStickLeft, ImGuiKey_GamepadLStickRight, ImGuiKey_GamepadLStickUp, ImGuiKey_GamepadLStickDown); const float tweak_factor = IsKeyDown(ImGuiKey_NavGamepadTweakSlow) ? 1.0f / 10.0f : IsKeyDown(ImGuiKey_NavGamepadTweakFast) ? 10.0f : 1.0f; if (scroll_dir.x != 0.0f && window->ScrollbarX) SetScrollX(window, ImTrunc(window->Scroll.x + scroll_dir.x * scroll_speed * tweak_factor)); if (scroll_dir.y != 0.0f) SetScrollY(window, ImTrunc(window->Scroll.y + scroll_dir.y * scroll_speed * tweak_factor)); } } // Always prioritize mouse highlight if navigation is disabled if (!nav_keyboard_active && !nav_gamepad_active) { g.NavCursorVisible = false; g.NavHighlightItemUnderNav = set_mouse_pos = false; } // Update mouse position if requested // (This will take into account the possibility that a Scroll was queued in the window to offset our absolute mouse position before scroll has been applied) if (set_mouse_pos && io.ConfigNavMoveSetMousePos && (io.BackendFlags & ImGuiBackendFlags_HasSetMousePos)) TeleportMousePos(NavCalcPreferredRefPos()); // [DEBUG] g.NavScoringDebugCount = 0; #if IMGUI_DEBUG_NAV_RECTS if (ImGuiWindow* debug_window = g.NavWindow) { ImDrawList* draw_list = GetForegroundDrawList(debug_window); int layer = g.NavLayer; /* for (int layer = 0; layer < 2; layer++)*/ { ImRect r = WindowRectRelToAbs(debug_window, debug_window->NavRectRel[layer]); draw_list->AddRect(r.Min, r.Max, IM_COL32(255, 200, 0, 255)); } //if (1) { ImU32 col = (!debug_window->Hidden) ? IM_COL32(255,0,255,255) : IM_COL32(255,0,0,255); ImVec2 p = NavCalcPreferredRefPos(); char buf[32]; ImFormatString(buf, 32, "%d", g.NavLayer); draw_list->AddCircleFilled(p, 3.0f, col); draw_list->AddText(NULL, 13.0f, p + ImVec2(8,-4), col, buf); } } #endif } void ImGui::NavInitRequestApplyResult() { // In very rare cases g.NavWindow may be null (e.g. clearing focus after requesting an init request, which does happen when releasing Alt while clicking on void) ImGuiContext& g = *GImGui; if (!g.NavWindow) return; ImGuiNavItemData* result = &g.NavInitResult; if (g.NavId != result->ID) { g.NavJustMovedFromFocusScopeId = g.NavFocusScopeId; g.NavJustMovedToId = result->ID; g.NavJustMovedToFocusScopeId = result->FocusScopeId; g.NavJustMovedToKeyMods = 0; g.NavJustMovedToIsTabbing = false; g.NavJustMovedToHasSelectionData = (result->ItemFlags & ImGuiItemFlags_HasSelectionUserData) != 0; } // Apply result from previous navigation init request (will typically select the first item, unless SetItemDefaultFocus() has been called) // FIXME-NAV: On _NavFlattened windows, g.NavWindow will only be updated during subsequent frame. Not a problem currently. IMGUI_DEBUG_LOG_NAV("[nav] NavInitRequest: ApplyResult: NavID 0x%08X in Layer %d Window \"%s\"\n", result->ID, g.NavLayer, g.NavWindow->Name); SetNavID(result->ID, g.NavLayer, result->FocusScopeId, result->RectRel); g.NavIdIsAlive = true; // Mark as alive from previous frame as we got a result if (result->SelectionUserData != ImGuiSelectionUserData_Invalid) g.NavLastValidSelectionUserData = result->SelectionUserData; if (g.NavInitRequestFromMove) SetNavCursorVisibleAfterMove(); } // Bias scoring rect ahead of scoring + update preferred pos (if missing) using source position static void NavBiasScoringRect(ImRect& r, ImVec2& preferred_pos_rel, ImGuiDir move_dir, ImGuiNavMoveFlags move_flags) { // Bias initial rect ImGuiContext& g = *GImGui; const ImVec2 rel_to_abs_offset = g.NavWindow->DC.CursorStartPos; // Initialize bias on departure if we don't have any. So mouse-click + arrow will record bias. // - We default to L/U bias, so moving down from a large source item into several columns will land on left-most column. // - But each successful move sets new bias on one axis, only cleared when using mouse. if ((move_flags & ImGuiNavMoveFlags_Forwarded) == 0) { if (preferred_pos_rel.x == FLT_MAX) preferred_pos_rel.x = ImMin(r.Min.x + 1.0f, r.Max.x) - rel_to_abs_offset.x; if (preferred_pos_rel.y == FLT_MAX) preferred_pos_rel.y = r.GetCenter().y - rel_to_abs_offset.y; } // Apply general bias on the other axis if ((move_dir == ImGuiDir_Up || move_dir == ImGuiDir_Down) && preferred_pos_rel.x != FLT_MAX) r.Min.x = r.Max.x = preferred_pos_rel.x + rel_to_abs_offset.x; else if ((move_dir == ImGuiDir_Left || move_dir == ImGuiDir_Right) && preferred_pos_rel.y != FLT_MAX) r.Min.y = r.Max.y = preferred_pos_rel.y + rel_to_abs_offset.y; } void ImGui::NavUpdateCreateMoveRequest() { ImGuiContext& g = *GImGui; ImGuiIO& io = g.IO; ImGuiWindow* window = g.NavWindow; const bool nav_gamepad_active = (io.ConfigFlags & ImGuiConfigFlags_NavEnableGamepad) != 0 && (io.BackendFlags & ImGuiBackendFlags_HasGamepad) != 0; const bool nav_keyboard_active = (io.ConfigFlags & ImGuiConfigFlags_NavEnableKeyboard) != 0; if (g.NavMoveForwardToNextFrame && window != NULL) { // Forwarding previous request (which has been modified, e.g. wrap around menus rewrite the requests with a starting rectangle at the other side of the window) // (preserve most state, which were already set by the NavMoveRequestForward() function) IM_ASSERT(g.NavMoveDir != ImGuiDir_None && g.NavMoveClipDir != ImGuiDir_None); IM_ASSERT(g.NavMoveFlags & ImGuiNavMoveFlags_Forwarded); IMGUI_DEBUG_LOG_NAV("[nav] NavMoveRequestForward %d\n", g.NavMoveDir); } else { // Initiate directional inputs request g.NavMoveDir = ImGuiDir_None; g.NavMoveFlags = ImGuiNavMoveFlags_None; g.NavMoveScrollFlags = ImGuiScrollFlags_None; if (window && !g.NavWindowingTarget && !(window->Flags & ImGuiWindowFlags_NoNavInputs)) { const ImGuiInputFlags repeat_mode = ImGuiInputFlags_Repeat | (ImGuiInputFlags)ImGuiInputFlags_RepeatRateNavMove; if (!IsActiveIdUsingNavDir(ImGuiDir_Left) && ((nav_gamepad_active && IsKeyPressed(ImGuiKey_GamepadDpadLeft, repeat_mode, ImGuiKeyOwner_NoOwner)) || (nav_keyboard_active && IsKeyPressed(ImGuiKey_LeftArrow, repeat_mode, ImGuiKeyOwner_NoOwner)))) { g.NavMoveDir = ImGuiDir_Left; } if (!IsActiveIdUsingNavDir(ImGuiDir_Right) && ((nav_gamepad_active && IsKeyPressed(ImGuiKey_GamepadDpadRight, repeat_mode, ImGuiKeyOwner_NoOwner)) || (nav_keyboard_active && IsKeyPressed(ImGuiKey_RightArrow, repeat_mode, ImGuiKeyOwner_NoOwner)))) { g.NavMoveDir = ImGuiDir_Right; } if (!IsActiveIdUsingNavDir(ImGuiDir_Up) && ((nav_gamepad_active && IsKeyPressed(ImGuiKey_GamepadDpadUp, repeat_mode, ImGuiKeyOwner_NoOwner)) || (nav_keyboard_active && IsKeyPressed(ImGuiKey_UpArrow, repeat_mode, ImGuiKeyOwner_NoOwner)))) { g.NavMoveDir = ImGuiDir_Up; } if (!IsActiveIdUsingNavDir(ImGuiDir_Down) && ((nav_gamepad_active && IsKeyPressed(ImGuiKey_GamepadDpadDown, repeat_mode, ImGuiKeyOwner_NoOwner)) || (nav_keyboard_active && IsKeyPressed(ImGuiKey_DownArrow, repeat_mode, ImGuiKeyOwner_NoOwner)))) { g.NavMoveDir = ImGuiDir_Down; } } g.NavMoveClipDir = g.NavMoveDir; g.NavScoringNoClipRect = ImRect(+FLT_MAX, +FLT_MAX, -FLT_MAX, -FLT_MAX); } // Update PageUp/PageDown/Home/End scroll // FIXME-NAV: Consider enabling those keys even without the master ImGuiConfigFlags_NavEnableKeyboard flag? float scoring_rect_offset_y = 0.0f; if (window && g.NavMoveDir == ImGuiDir_None && nav_keyboard_active) scoring_rect_offset_y = NavUpdatePageUpPageDown(); if (scoring_rect_offset_y != 0.0f) { g.NavScoringNoClipRect = window->InnerRect; g.NavScoringNoClipRect.TranslateY(scoring_rect_offset_y); } // [DEBUG] Always send a request when holding CTRL. Hold CTRL + Arrow change the direction. #if IMGUI_DEBUG_NAV_SCORING //if (io.KeyCtrl && IsKeyPressed(ImGuiKey_C)) // g.NavMoveDirForDebug = (ImGuiDir)((g.NavMoveDirForDebug + 1) & 3); if (io.KeyCtrl) { if (g.NavMoveDir == ImGuiDir_None) g.NavMoveDir = g.NavMoveDirForDebug; g.NavMoveClipDir = g.NavMoveDir; g.NavMoveFlags |= ImGuiNavMoveFlags_DebugNoResult; } #endif // Submit g.NavMoveForwardToNextFrame = false; if (g.NavMoveDir != ImGuiDir_None) NavMoveRequestSubmit(g.NavMoveDir, g.NavMoveClipDir, g.NavMoveFlags, g.NavMoveScrollFlags); // Moving with no reference triggers an init request (will be used as a fallback if the direction fails to find a match) if (g.NavMoveSubmitted && g.NavId == 0) { IMGUI_DEBUG_LOG_NAV("[nav] NavInitRequest: from move, window \"%s\", layer=%d\n", window ? window->Name : "", g.NavLayer); g.NavInitRequest = g.NavInitRequestFromMove = true; g.NavInitResult.ID = 0; if (g.IO.ConfigNavCursorVisibleAuto) g.NavCursorVisible = true; } // When using gamepad, we project the reference nav bounding box into window visible area. // This is to allow resuming navigation inside the visible area after doing a large amount of scrolling, // since with gamepad all movements are relative (can't focus a visible object like we can with the mouse). if (g.NavMoveSubmitted && g.NavInputSource == ImGuiInputSource_Gamepad && g.NavLayer == ImGuiNavLayer_Main && window != NULL)// && (g.NavMoveFlags & ImGuiNavMoveFlags_Forwarded)) { bool clamp_x = (g.NavMoveFlags & (ImGuiNavMoveFlags_LoopX | ImGuiNavMoveFlags_WrapX)) == 0; bool clamp_y = (g.NavMoveFlags & (ImGuiNavMoveFlags_LoopY | ImGuiNavMoveFlags_WrapY)) == 0; ImRect inner_rect_rel = WindowRectAbsToRel(window, ImRect(window->InnerRect.Min - ImVec2(1, 1), window->InnerRect.Max + ImVec2(1, 1))); // Take account of changing scroll to handle triggering a new move request on a scrolling frame. (#6171) // Otherwise 'inner_rect_rel' would be off on the move result frame. inner_rect_rel.Translate(CalcNextScrollFromScrollTargetAndClamp(window) - window->Scroll); if ((clamp_x || clamp_y) && !inner_rect_rel.Contains(window->NavRectRel[g.NavLayer])) { IMGUI_DEBUG_LOG_NAV("[nav] NavMoveRequest: clamp NavRectRel for gamepad move\n"); float pad_x = ImMin(inner_rect_rel.GetWidth(), window->FontRefSize * 0.5f); float pad_y = ImMin(inner_rect_rel.GetHeight(), window->FontRefSize * 0.5f); // Terrible approximation for the intent of starting navigation from first fully visible item inner_rect_rel.Min.x = clamp_x ? (inner_rect_rel.Min.x + pad_x) : -FLT_MAX; inner_rect_rel.Max.x = clamp_x ? (inner_rect_rel.Max.x - pad_x) : +FLT_MAX; inner_rect_rel.Min.y = clamp_y ? (inner_rect_rel.Min.y + pad_y) : -FLT_MAX; inner_rect_rel.Max.y = clamp_y ? (inner_rect_rel.Max.y - pad_y) : +FLT_MAX; window->NavRectRel[g.NavLayer].ClipWithFull(inner_rect_rel); g.NavId = 0; } } // For scoring we use a single segment on the left side our current item bounding box (not touching the edge to avoid box overlap with zero-spaced items) ImRect scoring_rect; if (window != NULL) { ImRect nav_rect_rel = !window->NavRectRel[g.NavLayer].IsInverted() ? window->NavRectRel[g.NavLayer] : ImRect(0, 0, 0, 0); scoring_rect = WindowRectRelToAbs(window, nav_rect_rel); scoring_rect.TranslateY(scoring_rect_offset_y); if (g.NavMoveSubmitted) NavBiasScoringRect(scoring_rect, window->RootWindowForNav->NavPreferredScoringPosRel[g.NavLayer], g.NavMoveDir, g.NavMoveFlags); IM_ASSERT(!scoring_rect.IsInverted()); // Ensure we have a non-inverted bounding box here will allow us to remove extraneous ImFabs() calls in NavScoreItem(). //GetForegroundDrawList()->AddRect(scoring_rect.Min, scoring_rect.Max, IM_COL32(255,200,0,255)); // [DEBUG] //if (!g.NavScoringNoClipRect.IsInverted()) { GetForegroundDrawList()->AddRect(g.NavScoringNoClipRect.Min, g.NavScoringNoClipRect.Max, IM_COL32(255, 200, 0, 255)); } // [DEBUG] } g.NavScoringRect = scoring_rect; g.NavScoringNoClipRect.Add(scoring_rect); } void ImGui::NavUpdateCreateTabbingRequest() { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.NavWindow; IM_ASSERT(g.NavMoveDir == ImGuiDir_None); if (window == NULL || g.NavWindowingTarget != NULL || (window->Flags & ImGuiWindowFlags_NoNavInputs)) return; const bool tab_pressed = IsKeyPressed(ImGuiKey_Tab, ImGuiInputFlags_Repeat, ImGuiKeyOwner_NoOwner) && !g.IO.KeyCtrl && !g.IO.KeyAlt; if (!tab_pressed) return; // Initiate tabbing request // (this is ALWAYS ENABLED, regardless of ImGuiConfigFlags_NavEnableKeyboard flag!) // See NavProcessItemForTabbingRequest() for a description of the various forward/backward tabbing cases with and without wrapping. const bool nav_keyboard_active = (g.IO.ConfigFlags & ImGuiConfigFlags_NavEnableKeyboard) != 0; if (nav_keyboard_active) g.NavTabbingDir = g.IO.KeyShift ? -1 : (g.NavCursorVisible == false && g.ActiveId == 0) ? 0 : +1; else g.NavTabbingDir = g.IO.KeyShift ? -1 : (g.ActiveId == 0) ? 0 : +1; ImGuiNavMoveFlags move_flags = ImGuiNavMoveFlags_IsTabbing | ImGuiNavMoveFlags_Activate; ImGuiScrollFlags scroll_flags = window->Appearing ? ImGuiScrollFlags_KeepVisibleEdgeX | ImGuiScrollFlags_AlwaysCenterY : ImGuiScrollFlags_KeepVisibleEdgeX | ImGuiScrollFlags_KeepVisibleEdgeY; ImGuiDir clip_dir = (g.NavTabbingDir < 0) ? ImGuiDir_Up : ImGuiDir_Down; NavMoveRequestSubmit(ImGuiDir_None, clip_dir, move_flags, scroll_flags); // FIXME-NAV: Once we refactor tabbing, add LegacyApi flag to not activate non-inputable. g.NavTabbingCounter = -1; } // Apply result from previous frame navigation directional move request. Always called from NavUpdate() void ImGui::NavMoveRequestApplyResult() { ImGuiContext& g = *GImGui; #if IMGUI_DEBUG_NAV_SCORING if (g.NavMoveFlags & ImGuiNavMoveFlags_DebugNoResult) // [DEBUG] Scoring all items in NavWindow at all times return; #endif // Select which result to use ImGuiNavItemData* result = (g.NavMoveResultLocal.ID != 0) ? &g.NavMoveResultLocal : (g.NavMoveResultOther.ID != 0) ? &g.NavMoveResultOther : NULL; // Tabbing forward wrap if ((g.NavMoveFlags & ImGuiNavMoveFlags_IsTabbing) && result == NULL) if ((g.NavTabbingCounter == 1 || g.NavTabbingDir == 0) && g.NavTabbingResultFirst.ID) result = &g.NavTabbingResultFirst; // In a situation when there are no results but NavId != 0, re-enable the Navigation highlight (because g.NavId is not considered as a possible result) const ImGuiAxis axis = (g.NavMoveDir == ImGuiDir_Up || g.NavMoveDir == ImGuiDir_Down) ? ImGuiAxis_Y : ImGuiAxis_X; if (result == NULL) { if (g.NavMoveFlags & ImGuiNavMoveFlags_IsTabbing) g.NavMoveFlags |= ImGuiNavMoveFlags_NoSetNavCursorVisible; if (g.NavId != 0 && (g.NavMoveFlags & ImGuiNavMoveFlags_NoSetNavCursorVisible) == 0) SetNavCursorVisibleAfterMove(); NavClearPreferredPosForAxis(axis); // On a failed move, clear preferred pos for this axis. IMGUI_DEBUG_LOG_NAV("[nav] NavMoveSubmitted but not led to a result!\n"); return; } // PageUp/PageDown behavior first jumps to the bottom/top mostly visible item, _otherwise_ use the result from the previous/next page. if (g.NavMoveFlags & ImGuiNavMoveFlags_AlsoScoreVisibleSet) if (g.NavMoveResultLocalVisible.ID != 0 && g.NavMoveResultLocalVisible.ID != g.NavId) result = &g.NavMoveResultLocalVisible; // Maybe entering a flattened child from the outside? In this case solve the tie using the regular scoring rules. if (result != &g.NavMoveResultOther && g.NavMoveResultOther.ID != 0 && g.NavMoveResultOther.Window->ParentWindow == g.NavWindow) if ((g.NavMoveResultOther.DistBox < result->DistBox) || (g.NavMoveResultOther.DistBox == result->DistBox && g.NavMoveResultOther.DistCenter < result->DistCenter)) result = &g.NavMoveResultOther; IM_ASSERT(g.NavWindow && result->Window); // Scroll to keep newly navigated item fully into view. if (g.NavLayer == ImGuiNavLayer_Main) { ImRect rect_abs = WindowRectRelToAbs(result->Window, result->RectRel); ScrollToRectEx(result->Window, rect_abs, g.NavMoveScrollFlags); if (g.NavMoveFlags & ImGuiNavMoveFlags_ScrollToEdgeY) { // FIXME: Should remove this? Or make more precise: use ScrollToRectEx() with edge? float scroll_target = (g.NavMoveDir == ImGuiDir_Up) ? result->Window->ScrollMax.y : 0.0f; SetScrollY(result->Window, scroll_target); } } if (g.NavWindow != result->Window) { IMGUI_DEBUG_LOG_FOCUS("[focus] NavMoveRequest: SetNavWindow(\"%s\")\n", result->Window->Name); g.NavWindow = result->Window; g.NavLastValidSelectionUserData = ImGuiSelectionUserData_Invalid; } // Clear active id unless requested not to // FIXME: ImGuiNavMoveFlags_NoClearActiveId is currently unused as we don't have a clear strategy to preserve active id after interaction, // so this is mostly provided as a gateway for further experiments (see #1418, #2890) if (g.ActiveId != result->ID && (g.NavMoveFlags & ImGuiNavMoveFlags_NoClearActiveId) == 0) ClearActiveID(); // Don't set NavJustMovedToId if just landed on the same spot (which may happen with ImGuiNavMoveFlags_AllowCurrentNavId) // PageUp/PageDown however sets always set NavJustMovedTo (vs Home/End which doesn't) mimicking Windows behavior. if ((g.NavId != result->ID || (g.NavMoveFlags & ImGuiNavMoveFlags_IsPageMove)) && (g.NavMoveFlags & ImGuiNavMoveFlags_NoSelect) == 0) { g.NavJustMovedFromFocusScopeId = g.NavFocusScopeId; g.NavJustMovedToId = result->ID; g.NavJustMovedToFocusScopeId = result->FocusScopeId; g.NavJustMovedToKeyMods = g.NavMoveKeyMods; g.NavJustMovedToIsTabbing = (g.NavMoveFlags & ImGuiNavMoveFlags_IsTabbing) != 0; g.NavJustMovedToHasSelectionData = (result->ItemFlags & ImGuiItemFlags_HasSelectionUserData) != 0; //IMGUI_DEBUG_LOG_NAV("[nav] NavJustMovedFromFocusScopeId = 0x%08X, NavJustMovedToFocusScopeId = 0x%08X\n", g.NavJustMovedFromFocusScopeId, g.NavJustMovedToFocusScopeId); } // Apply new NavID/Focus IMGUI_DEBUG_LOG_NAV("[nav] NavMoveRequest: result NavID 0x%08X in Layer %d Window \"%s\"\n", result->ID, g.NavLayer, g.NavWindow->Name); ImVec2 preferred_scoring_pos_rel = g.NavWindow->RootWindowForNav->NavPreferredScoringPosRel[g.NavLayer]; SetNavID(result->ID, g.NavLayer, result->FocusScopeId, result->RectRel); if (result->SelectionUserData != ImGuiSelectionUserData_Invalid) g.NavLastValidSelectionUserData = result->SelectionUserData; // Restore last preferred position for current axis // (storing in RootWindowForNav-> as the info is desirable at the beginning of a Move Request. In theory all storage should use RootWindowForNav..) if ((g.NavMoveFlags & ImGuiNavMoveFlags_IsTabbing) == 0) { preferred_scoring_pos_rel[axis] = result->RectRel.GetCenter()[axis]; g.NavWindow->RootWindowForNav->NavPreferredScoringPosRel[g.NavLayer] = preferred_scoring_pos_rel; } // Tabbing: Activates Inputable, otherwise only Focus if ((g.NavMoveFlags & ImGuiNavMoveFlags_IsTabbing) && (result->ItemFlags & ImGuiItemFlags_Inputable) == 0) g.NavMoveFlags &= ~ImGuiNavMoveFlags_Activate; // Activate if (g.NavMoveFlags & ImGuiNavMoveFlags_Activate) { g.NavNextActivateId = result->ID; g.NavNextActivateFlags = ImGuiActivateFlags_None; if (g.NavMoveFlags & ImGuiNavMoveFlags_IsTabbing) g.NavNextActivateFlags |= ImGuiActivateFlags_PreferInput | ImGuiActivateFlags_TryToPreserveState | ImGuiActivateFlags_FromTabbing; } // Make nav cursor visible if ((g.NavMoveFlags & ImGuiNavMoveFlags_NoSetNavCursorVisible) == 0) SetNavCursorVisibleAfterMove(); } // Process Escape/NavCancel input (to close a popup, get back to parent, clear focus) // FIXME: In order to support e.g. Escape to clear a selection we'll need: // - either to store the equivalent of ActiveIdUsingKeyInputMask for a FocusScope and test for it. // - either to move most/all of those tests to the epilogue/end functions of the scope they are dealing with (e.g. exit child window in EndChild()) or in EndFrame(), to allow an earlier intercept static void ImGui::NavUpdateCancelRequest() { ImGuiContext& g = *GImGui; const bool nav_gamepad_active = (g.IO.ConfigFlags & ImGuiConfigFlags_NavEnableGamepad) != 0 && (g.IO.BackendFlags & ImGuiBackendFlags_HasGamepad) != 0; const bool nav_keyboard_active = (g.IO.ConfigFlags & ImGuiConfigFlags_NavEnableKeyboard) != 0; if (!(nav_keyboard_active && IsKeyPressed(ImGuiKey_Escape, 0, ImGuiKeyOwner_NoOwner)) && !(nav_gamepad_active && IsKeyPressed(ImGuiKey_NavGamepadCancel, 0, ImGuiKeyOwner_NoOwner))) return; IMGUI_DEBUG_LOG_NAV("[nav] NavUpdateCancelRequest()\n"); if (g.ActiveId != 0) { ClearActiveID(); } else if (g.NavLayer != ImGuiNavLayer_Main) { // Leave the "menu" layer NavRestoreLayer(ImGuiNavLayer_Main); SetNavCursorVisibleAfterMove(); } else if (g.NavWindow && g.NavWindow != g.NavWindow->RootWindow && !(g.NavWindow->RootWindowForNav->Flags & ImGuiWindowFlags_Popup) && g.NavWindow->RootWindowForNav->ParentWindow) { // Exit child window ImGuiWindow* child_window = g.NavWindow->RootWindowForNav; ImGuiWindow* parent_window = child_window->ParentWindow; IM_ASSERT(child_window->ChildId != 0); FocusWindow(parent_window); SetNavID(child_window->ChildId, ImGuiNavLayer_Main, 0, WindowRectAbsToRel(parent_window, child_window->Rect())); SetNavCursorVisibleAfterMove(); } else if (g.OpenPopupStack.Size > 0 && g.OpenPopupStack.back().Window != NULL && !(g.OpenPopupStack.back().Window->Flags & ImGuiWindowFlags_Modal)) { // Close open popup/menu ClosePopupToLevel(g.OpenPopupStack.Size - 1, true); } else { // Clear NavLastId for popups but keep it for regular child window so we can leave one and come back where we were // FIXME-NAV: This should happen on window appearing. if (g.IO.ConfigNavEscapeClearFocusItem || g.IO.ConfigNavEscapeClearFocusWindow) if (g.NavWindow && ((g.NavWindow->Flags & ImGuiWindowFlags_Popup)))// || !(g.NavWindow->Flags & ImGuiWindowFlags_ChildWindow))) g.NavWindow->NavLastIds[0] = 0; // Clear nav focus if (g.IO.ConfigNavEscapeClearFocusItem || g.IO.ConfigNavEscapeClearFocusWindow) g.NavId = 0; if (g.IO.ConfigNavEscapeClearFocusWindow) FocusWindow(NULL); } } // Handle PageUp/PageDown/Home/End keys // Called from NavUpdateCreateMoveRequest() which will use our output to create a move request // FIXME-NAV: This doesn't work properly with NavFlattened siblings as we use NavWindow rectangle for reference // FIXME-NAV: how to get Home/End to aim at the beginning/end of a 2D grid? static float ImGui::NavUpdatePageUpPageDown() { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.NavWindow; if ((window->Flags & ImGuiWindowFlags_NoNavInputs) || g.NavWindowingTarget != NULL) return 0.0f; const bool page_up_held = IsKeyDown(ImGuiKey_PageUp, ImGuiKeyOwner_NoOwner); const bool page_down_held = IsKeyDown(ImGuiKey_PageDown, ImGuiKeyOwner_NoOwner); const bool home_pressed = IsKeyPressed(ImGuiKey_Home, ImGuiInputFlags_Repeat, ImGuiKeyOwner_NoOwner); const bool end_pressed = IsKeyPressed(ImGuiKey_End, ImGuiInputFlags_Repeat, ImGuiKeyOwner_NoOwner); if (page_up_held == page_down_held && home_pressed == end_pressed) // Proceed if either (not both) are pressed, otherwise early out return 0.0f; if (g.NavLayer != ImGuiNavLayer_Main) NavRestoreLayer(ImGuiNavLayer_Main); if (window->DC.NavLayersActiveMask == 0x00 && window->DC.NavWindowHasScrollY) { // Fallback manual-scroll when window has no navigable item if (IsKeyPressed(ImGuiKey_PageUp, ImGuiInputFlags_Repeat, ImGuiKeyOwner_NoOwner)) SetScrollY(window, window->Scroll.y - window->InnerRect.GetHeight()); else if (IsKeyPressed(ImGuiKey_PageDown, ImGuiInputFlags_Repeat, ImGuiKeyOwner_NoOwner)) SetScrollY(window, window->Scroll.y + window->InnerRect.GetHeight()); else if (home_pressed) SetScrollY(window, 0.0f); else if (end_pressed) SetScrollY(window, window->ScrollMax.y); } else { ImRect& nav_rect_rel = window->NavRectRel[g.NavLayer]; const float page_offset_y = ImMax(0.0f, window->InnerRect.GetHeight() - window->FontRefSize * 1.0f + nav_rect_rel.GetHeight()); float nav_scoring_rect_offset_y = 0.0f; if (IsKeyPressed(ImGuiKey_PageUp, true)) { nav_scoring_rect_offset_y = -page_offset_y; g.NavMoveDir = ImGuiDir_Down; // Because our scoring rect is offset up, we request the down direction (so we can always land on the last item) g.NavMoveClipDir = ImGuiDir_Up; g.NavMoveFlags = ImGuiNavMoveFlags_AllowCurrentNavId | ImGuiNavMoveFlags_AlsoScoreVisibleSet | ImGuiNavMoveFlags_IsPageMove; } else if (IsKeyPressed(ImGuiKey_PageDown, true)) { nav_scoring_rect_offset_y = +page_offset_y; g.NavMoveDir = ImGuiDir_Up; // Because our scoring rect is offset down, we request the up direction (so we can always land on the last item) g.NavMoveClipDir = ImGuiDir_Down; g.NavMoveFlags = ImGuiNavMoveFlags_AllowCurrentNavId | ImGuiNavMoveFlags_AlsoScoreVisibleSet | ImGuiNavMoveFlags_IsPageMove; } else if (home_pressed) { // FIXME-NAV: handling of Home/End is assuming that the top/bottom most item will be visible with Scroll.y == 0/ScrollMax.y // Scrolling will be handled via the ImGuiNavMoveFlags_ScrollToEdgeY flag, we don't scroll immediately to avoid scrolling happening before nav result. // Preserve current horizontal position if we have any. nav_rect_rel.Min.y = nav_rect_rel.Max.y = 0.0f; if (nav_rect_rel.IsInverted()) nav_rect_rel.Min.x = nav_rect_rel.Max.x = 0.0f; g.NavMoveDir = ImGuiDir_Down; g.NavMoveFlags = ImGuiNavMoveFlags_AllowCurrentNavId | ImGuiNavMoveFlags_ScrollToEdgeY; // FIXME-NAV: MoveClipDir left to _None, intentional? } else if (end_pressed) { nav_rect_rel.Min.y = nav_rect_rel.Max.y = window->ContentSize.y; if (nav_rect_rel.IsInverted()) nav_rect_rel.Min.x = nav_rect_rel.Max.x = 0.0f; g.NavMoveDir = ImGuiDir_Up; g.NavMoveFlags = ImGuiNavMoveFlags_AllowCurrentNavId | ImGuiNavMoveFlags_ScrollToEdgeY; // FIXME-NAV: MoveClipDir left to _None, intentional? } return nav_scoring_rect_offset_y; } return 0.0f; } static void ImGui::NavEndFrame() { ImGuiContext& g = *GImGui; // Show CTRL+TAB list window if (g.NavWindowingTarget != NULL) NavUpdateWindowingOverlay(); // Perform wrap-around in menus // FIXME-NAV: Wrap may need to apply a weight bias on the other axis. e.g. 4x4 grid with 2 last items missing on last item won't handle LoopY/WrapY correctly. // FIXME-NAV: Wrap (not Loop) support could be handled by the scoring function and then WrapX would function without an extra frame. if (g.NavWindow && NavMoveRequestButNoResultYet() && (g.NavMoveFlags & ImGuiNavMoveFlags_WrapMask_) && (g.NavMoveFlags & ImGuiNavMoveFlags_Forwarded) == 0) NavUpdateCreateWrappingRequest(); } static void ImGui::NavUpdateCreateWrappingRequest() { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.NavWindow; bool do_forward = false; ImRect bb_rel = window->NavRectRel[g.NavLayer]; ImGuiDir clip_dir = g.NavMoveDir; const ImGuiNavMoveFlags move_flags = g.NavMoveFlags; //const ImGuiAxis move_axis = (g.NavMoveDir == ImGuiDir_Up || g.NavMoveDir == ImGuiDir_Down) ? ImGuiAxis_Y : ImGuiAxis_X; if (g.NavMoveDir == ImGuiDir_Left && (move_flags & (ImGuiNavMoveFlags_WrapX | ImGuiNavMoveFlags_LoopX))) { bb_rel.Min.x = bb_rel.Max.x = window->ContentSize.x + window->WindowPadding.x; if (move_flags & ImGuiNavMoveFlags_WrapX) { bb_rel.TranslateY(-bb_rel.GetHeight()); // Previous row clip_dir = ImGuiDir_Up; } do_forward = true; } if (g.NavMoveDir == ImGuiDir_Right && (move_flags & (ImGuiNavMoveFlags_WrapX | ImGuiNavMoveFlags_LoopX))) { bb_rel.Min.x = bb_rel.Max.x = -window->WindowPadding.x; if (move_flags & ImGuiNavMoveFlags_WrapX) { bb_rel.TranslateY(+bb_rel.GetHeight()); // Next row clip_dir = ImGuiDir_Down; } do_forward = true; } if (g.NavMoveDir == ImGuiDir_Up && (move_flags & (ImGuiNavMoveFlags_WrapY | ImGuiNavMoveFlags_LoopY))) { bb_rel.Min.y = bb_rel.Max.y = window->ContentSize.y + window->WindowPadding.y; if (move_flags & ImGuiNavMoveFlags_WrapY) { bb_rel.TranslateX(-bb_rel.GetWidth()); // Previous column clip_dir = ImGuiDir_Left; } do_forward = true; } if (g.NavMoveDir == ImGuiDir_Down && (move_flags & (ImGuiNavMoveFlags_WrapY | ImGuiNavMoveFlags_LoopY))) { bb_rel.Min.y = bb_rel.Max.y = -window->WindowPadding.y; if (move_flags & ImGuiNavMoveFlags_WrapY) { bb_rel.TranslateX(+bb_rel.GetWidth()); // Next column clip_dir = ImGuiDir_Right; } do_forward = true; } if (!do_forward) return; window->NavRectRel[g.NavLayer] = bb_rel; NavClearPreferredPosForAxis(ImGuiAxis_X); NavClearPreferredPosForAxis(ImGuiAxis_Y); NavMoveRequestForward(g.NavMoveDir, clip_dir, move_flags, g.NavMoveScrollFlags); } // Can we focus this window with CTRL+TAB (or PadMenu + PadFocusPrev/PadFocusNext) // Note that NoNavFocus makes the window not reachable with CTRL+TAB but it can still be focused with mouse or programmatically. // If you want a window to never be focused, you may use the e.g. NoInputs flag. bool ImGui::IsWindowNavFocusable(ImGuiWindow* window) { return window->WasActive && window == window->RootWindow && !(window->Flags & ImGuiWindowFlags_NoNavFocus); } static ImGuiWindow* FindWindowNavFocusable(int i_start, int i_stop, int dir) // FIXME-OPT O(N) { ImGuiContext& g = *GImGui; for (int i = i_start; i >= 0 && i < g.WindowsFocusOrder.Size && i != i_stop; i += dir) if (ImGui::IsWindowNavFocusable(g.WindowsFocusOrder[i])) return g.WindowsFocusOrder[i]; return NULL; } static void NavUpdateWindowingTarget(int focus_change_dir) { ImGuiContext& g = *GImGui; IM_ASSERT(g.NavWindowingTarget); if (g.NavWindowingTarget->Flags & ImGuiWindowFlags_Modal) return; const int i_current = ImGui::FindWindowFocusIndex(g.NavWindowingTarget); ImGuiWindow* window_target = FindWindowNavFocusable(i_current + focus_change_dir, -INT_MAX, focus_change_dir); if (!window_target) window_target = FindWindowNavFocusable((focus_change_dir < 0) ? (g.WindowsFocusOrder.Size - 1) : 0, i_current, focus_change_dir); if (window_target) // Don't reset windowing target if there's a single window in the list { g.NavWindowingTarget = g.NavWindowingTargetAnim = window_target; g.NavWindowingAccumDeltaPos = g.NavWindowingAccumDeltaSize = ImVec2(0.0f, 0.0f); } g.NavWindowingToggleLayer = false; } // Apply focus and close overlay static void ImGui::NavUpdateWindowingApplyFocus(ImGuiWindow* apply_focus_window) { ImGuiContext& g = *GImGui; if (g.NavWindow == NULL || apply_focus_window != g.NavWindow->RootWindow) { ClearActiveID(); SetNavCursorVisibleAfterMove(); ClosePopupsOverWindow(apply_focus_window, false); FocusWindow(apply_focus_window, ImGuiFocusRequestFlags_RestoreFocusedChild); apply_focus_window = g.NavWindow; if (apply_focus_window->NavLastIds[0] == 0) NavInitWindow(apply_focus_window, false); // If the window has ONLY a menu layer (no main layer), select it directly // Use NavLayersActiveMaskNext since windows didn't have a chance to be Begin()-ed on this frame, // so CTRL+Tab where the keys are only held for 1 frame will be able to use correct layers mask since // the target window as already been previewed once. // FIXME-NAV: This should be done in NavInit.. or in FocusWindow... However in both of those cases, // we won't have a guarantee that windows has been visible before and therefore NavLayersActiveMask* // won't be valid. if (apply_focus_window->DC.NavLayersActiveMaskNext == (1 << ImGuiNavLayer_Menu)) g.NavLayer = ImGuiNavLayer_Menu; } g.NavWindowingTarget = NULL; } // Windowing management mode // Keyboard: CTRL+Tab (change focus/move/resize), Alt (toggle menu layer) // Gamepad: Hold Menu/Square (change focus/move/resize), Tap Menu/Square (toggle menu layer) static void ImGui::NavUpdateWindowing() { ImGuiContext& g = *GImGui; ImGuiIO& io = g.IO; ImGuiWindow* apply_focus_window = NULL; bool apply_toggle_layer = false; ImGuiWindow* modal_window = GetTopMostPopupModal(); bool allow_windowing = (modal_window == NULL); // FIXME: This prevent CTRL+TAB from being usable with windows that are inside the Begin-stack of that modal. if (!allow_windowing) g.NavWindowingTarget = NULL; // Fade out if (g.NavWindowingTargetAnim && g.NavWindowingTarget == NULL) { g.NavWindowingHighlightAlpha = ImMax(g.NavWindowingHighlightAlpha - io.DeltaTime * 10.0f, 0.0f); if (g.DimBgRatio <= 0.0f && g.NavWindowingHighlightAlpha <= 0.0f) g.NavWindowingTargetAnim = NULL; } // Start CTRL+Tab or Square+L/R window selection // (g.ConfigNavWindowingKeyNext/g.ConfigNavWindowingKeyPrev defaults are ImGuiMod_Ctrl|ImGuiKey_Tab and ImGuiMod_Ctrl|ImGuiMod_Shift|ImGuiKey_Tab) const ImGuiID owner_id = ImHashStr("##NavUpdateWindowing"); const bool nav_gamepad_active = (io.ConfigFlags & ImGuiConfigFlags_NavEnableGamepad) != 0 && (io.BackendFlags & ImGuiBackendFlags_HasGamepad) != 0; const bool nav_keyboard_active = (io.ConfigFlags & ImGuiConfigFlags_NavEnableKeyboard) != 0; const bool keyboard_next_window = allow_windowing && g.ConfigNavWindowingKeyNext && Shortcut(g.ConfigNavWindowingKeyNext, ImGuiInputFlags_Repeat | ImGuiInputFlags_RouteAlways, owner_id); const bool keyboard_prev_window = allow_windowing && g.ConfigNavWindowingKeyPrev && Shortcut(g.ConfigNavWindowingKeyPrev, ImGuiInputFlags_Repeat | ImGuiInputFlags_RouteAlways, owner_id); const bool start_windowing_with_gamepad = allow_windowing && nav_gamepad_active && !g.NavWindowingTarget && IsKeyPressed(ImGuiKey_NavGamepadMenu, ImGuiInputFlags_None); const bool start_windowing_with_keyboard = allow_windowing && !g.NavWindowingTarget && (keyboard_next_window || keyboard_prev_window); // Note: enabled even without NavEnableKeyboard! bool just_started_windowing_from_null_focus = false; if (start_windowing_with_gamepad || start_windowing_with_keyboard) if (ImGuiWindow* window = g.NavWindow ? g.NavWindow : FindWindowNavFocusable(g.WindowsFocusOrder.Size - 1, -INT_MAX, -1)) { g.NavWindowingTarget = g.NavWindowingTargetAnim = window->RootWindow; // Current location g.NavWindowingTimer = g.NavWindowingHighlightAlpha = 0.0f; g.NavWindowingAccumDeltaPos = g.NavWindowingAccumDeltaSize = ImVec2(0.0f, 0.0f); g.NavWindowingToggleLayer = start_windowing_with_gamepad ? true : false; // Gamepad starts toggling layer g.NavInputSource = start_windowing_with_keyboard ? ImGuiInputSource_Keyboard : ImGuiInputSource_Gamepad; if (g.NavWindow == NULL) just_started_windowing_from_null_focus = true; // Manually register ownership of our mods. Using a global route in the Shortcut() calls instead would probably be correct but may have more side-effects. if (keyboard_next_window || keyboard_prev_window) SetKeyOwnersForKeyChord((g.ConfigNavWindowingKeyNext | g.ConfigNavWindowingKeyPrev) & ImGuiMod_Mask_, owner_id); } // Gamepad update g.NavWindowingTimer += io.DeltaTime; if (g.NavWindowingTarget && g.NavInputSource == ImGuiInputSource_Gamepad) { // Highlight only appears after a brief time holding the button, so that a fast tap on PadMenu (to toggle NavLayer) doesn't add visual noise g.NavWindowingHighlightAlpha = ImMax(g.NavWindowingHighlightAlpha, ImSaturate((g.NavWindowingTimer - NAV_WINDOWING_HIGHLIGHT_DELAY) / 0.05f)); // Select window to focus const int focus_change_dir = (int)IsKeyPressed(ImGuiKey_GamepadL1) - (int)IsKeyPressed(ImGuiKey_GamepadR1); if (focus_change_dir != 0 && !just_started_windowing_from_null_focus) { NavUpdateWindowingTarget(focus_change_dir); g.NavWindowingHighlightAlpha = 1.0f; } // Single press toggles NavLayer, long press with L/R apply actual focus on release (until then the window was merely rendered top-most) if (!IsKeyDown(ImGuiKey_NavGamepadMenu)) { g.NavWindowingToggleLayer &= (g.NavWindowingHighlightAlpha < 1.0f); // Once button was held long enough we don't consider it a tap-to-toggle-layer press anymore. if (g.NavWindowingToggleLayer && g.NavWindow) apply_toggle_layer = true; else if (!g.NavWindowingToggleLayer) apply_focus_window = g.NavWindowingTarget; g.NavWindowingTarget = NULL; } } // Keyboard: Focus if (g.NavWindowingTarget && g.NavInputSource == ImGuiInputSource_Keyboard) { // Visuals only appears after a brief time after pressing TAB the first time, so that a fast CTRL+TAB doesn't add visual noise ImGuiKeyChord shared_mods = ((g.ConfigNavWindowingKeyNext ? g.ConfigNavWindowingKeyNext : ImGuiMod_Mask_) & (g.ConfigNavWindowingKeyPrev ? g.ConfigNavWindowingKeyPrev : ImGuiMod_Mask_)) & ImGuiMod_Mask_; IM_ASSERT(shared_mods != 0); // Next/Prev shortcut currently needs a shared modifier to "hold", otherwise Prev actions would keep cycling between two windows. g.NavWindowingHighlightAlpha = ImMax(g.NavWindowingHighlightAlpha, ImSaturate((g.NavWindowingTimer - NAV_WINDOWING_HIGHLIGHT_DELAY) / 0.05f)); // 1.0f if ((keyboard_next_window || keyboard_prev_window) && !just_started_windowing_from_null_focus) NavUpdateWindowingTarget(keyboard_next_window ? -1 : +1); else if ((io.KeyMods & shared_mods) != shared_mods) apply_focus_window = g.NavWindowingTarget; } // Keyboard: Press and Release ALT to toggle menu layer const ImGuiKey windowing_toggle_keys[] = { ImGuiKey_LeftAlt, ImGuiKey_RightAlt }; bool windowing_toggle_layer_start = false; if (g.NavWindow != NULL && !(g.NavWindow->Flags & ImGuiWindowFlags_NoNavInputs)) for (ImGuiKey windowing_toggle_key : windowing_toggle_keys) if (nav_keyboard_active && IsKeyPressed(windowing_toggle_key, 0, ImGuiKeyOwner_NoOwner)) { windowing_toggle_layer_start = true; g.NavWindowingToggleLayer = true; g.NavWindowingToggleKey = windowing_toggle_key; g.NavInputSource = ImGuiInputSource_Keyboard; break; } if (g.NavWindowingToggleLayer && g.NavInputSource == ImGuiInputSource_Keyboard) { // We cancel toggling nav layer when any text has been typed (generally while holding Alt). (See #370) // We cancel toggling nav layer when other modifiers are pressed. (See #4439) // - AltGR is Alt+Ctrl on some layout but we can't reliably detect it (not all backends/systems/layout emit it as Alt+Ctrl). // We cancel toggling nav layer if an owner has claimed the key. if (io.InputQueueCharacters.Size > 0 || io.KeyCtrl || io.KeyShift || io.KeySuper) g.NavWindowingToggleLayer = false; else if (windowing_toggle_layer_start == false && g.LastKeyboardKeyPressTime == g.Time) g.NavWindowingToggleLayer = false; else if (TestKeyOwner(g.NavWindowingToggleKey, ImGuiKeyOwner_NoOwner) == false || TestKeyOwner(ImGuiMod_Alt, ImGuiKeyOwner_NoOwner) == false) g.NavWindowingToggleLayer = false; // Apply layer toggle on Alt release // Important: as before version <18314 we lacked an explicit IO event for focus gain/loss, we also compare mouse validity to detect old backends clearing mouse pos on focus loss. if (IsKeyReleased(g.NavWindowingToggleKey) && g.NavWindowingToggleLayer) if (g.ActiveId == 0 || g.ActiveIdAllowOverlap) if (IsMousePosValid(&io.MousePos) == IsMousePosValid(&io.MousePosPrev)) apply_toggle_layer = true; if (!IsKeyDown(g.NavWindowingToggleKey)) g.NavWindowingToggleLayer = false; } // Move window if (g.NavWindowingTarget && !(g.NavWindowingTarget->Flags & ImGuiWindowFlags_NoMove)) { ImVec2 nav_move_dir; if (g.NavInputSource == ImGuiInputSource_Keyboard && !io.KeyShift) nav_move_dir = GetKeyMagnitude2d(ImGuiKey_LeftArrow, ImGuiKey_RightArrow, ImGuiKey_UpArrow, ImGuiKey_DownArrow); if (g.NavInputSource == ImGuiInputSource_Gamepad) nav_move_dir = GetKeyMagnitude2d(ImGuiKey_GamepadLStickLeft, ImGuiKey_GamepadLStickRight, ImGuiKey_GamepadLStickUp, ImGuiKey_GamepadLStickDown); if (nav_move_dir.x != 0.0f || nav_move_dir.y != 0.0f) { const float NAV_MOVE_SPEED = 800.0f; const float move_step = NAV_MOVE_SPEED * io.DeltaTime * ImMin(io.DisplayFramebufferScale.x, io.DisplayFramebufferScale.y); g.NavWindowingAccumDeltaPos += nav_move_dir * move_step; g.NavHighlightItemUnderNav = true; ImVec2 accum_floored = ImTrunc(g.NavWindowingAccumDeltaPos); if (accum_floored.x != 0.0f || accum_floored.y != 0.0f) { ImGuiWindow* moving_window = g.NavWindowingTarget->RootWindow; SetWindowPos(moving_window, moving_window->Pos + accum_floored, ImGuiCond_Always); g.NavWindowingAccumDeltaPos -= accum_floored; } } } // Apply final focus if (apply_focus_window) NavUpdateWindowingApplyFocus(apply_focus_window); // Apply menu/layer toggle if (apply_toggle_layer && g.NavWindow) { ClearActiveID(); // Move to parent menu if necessary ImGuiWindow* new_nav_window = g.NavWindow; while (new_nav_window->ParentWindow && (new_nav_window->DC.NavLayersActiveMask & (1 << ImGuiNavLayer_Menu)) == 0 && (new_nav_window->Flags & ImGuiWindowFlags_ChildWindow) != 0 && (new_nav_window->Flags & (ImGuiWindowFlags_Popup | ImGuiWindowFlags_ChildMenu)) == 0) new_nav_window = new_nav_window->ParentWindow; if (new_nav_window != g.NavWindow) { ImGuiWindow* old_nav_window = g.NavWindow; FocusWindow(new_nav_window); new_nav_window->NavLastChildNavWindow = old_nav_window; } // Toggle layer const ImGuiNavLayer new_nav_layer = (g.NavWindow->DC.NavLayersActiveMask & (1 << ImGuiNavLayer_Menu)) ? (ImGuiNavLayer)((int)g.NavLayer ^ 1) : ImGuiNavLayer_Main; if (new_nav_layer != g.NavLayer) { // Reinitialize navigation when entering menu bar with the Alt key (FIXME: could be a properly of the layer?) if (new_nav_layer == ImGuiNavLayer_Menu) g.NavWindow->NavLastIds[new_nav_layer] = 0; NavRestoreLayer(new_nav_layer); SetNavCursorVisibleAfterMove(); } } } // Window has already passed the IsWindowNavFocusable() static const char* GetFallbackWindowNameForWindowingList(ImGuiWindow* window) { if (window->Flags & ImGuiWindowFlags_Popup) return ImGui::LocalizeGetMsg(ImGuiLocKey_WindowingPopup); if ((window->Flags & ImGuiWindowFlags_MenuBar) && strcmp(window->Name, "##MainMenuBar") == 0) return ImGui::LocalizeGetMsg(ImGuiLocKey_WindowingMainMenuBar); return ImGui::LocalizeGetMsg(ImGuiLocKey_WindowingUntitled); } // Overlay displayed when using CTRL+TAB. Called by EndFrame(). void ImGui::NavUpdateWindowingOverlay() { ImGuiContext& g = *GImGui; IM_ASSERT(g.NavWindowingTarget != NULL); if (g.NavWindowingTimer < NAV_WINDOWING_LIST_APPEAR_DELAY) return; if (g.NavWindowingListWindow == NULL) g.NavWindowingListWindow = FindWindowByName("##NavWindowingOverlay"); const ImGuiViewport* viewport = GetMainViewport(); SetNextWindowSizeConstraints(ImVec2(viewport->Size.x * 0.20f, viewport->Size.y * 0.20f), ImVec2(FLT_MAX, FLT_MAX)); SetNextWindowPos(viewport->GetCenter(), ImGuiCond_Always, ImVec2(0.5f, 0.5f)); PushStyleVar(ImGuiStyleVar_WindowPadding, g.Style.WindowPadding * 2.0f); Begin("##NavWindowingOverlay", NULL, ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoFocusOnAppearing | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoInputs | ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_NoSavedSettings); if (g.ContextName[0] != 0) SeparatorText(g.ContextName); for (int n = g.WindowsFocusOrder.Size - 1; n >= 0; n--) { ImGuiWindow* window = g.WindowsFocusOrder[n]; IM_ASSERT(window != NULL); // Fix static analyzers if (!IsWindowNavFocusable(window)) continue; const char* label = window->Name; if (label == FindRenderedTextEnd(label)) label = GetFallbackWindowNameForWindowingList(window); Selectable(label, g.NavWindowingTarget == window); } End(); PopStyleVar(); } //----------------------------------------------------------------------------- // [SECTION] DRAG AND DROP //----------------------------------------------------------------------------- bool ImGui::IsDragDropActive() { ImGuiContext& g = *GImGui; return g.DragDropActive; } void ImGui::ClearDragDrop() { ImGuiContext& g = *GImGui; if (g.DragDropActive) IMGUI_DEBUG_LOG_ACTIVEID("[dragdrop] ClearDragDrop()\n"); g.DragDropActive = false; g.DragDropPayload.Clear(); g.DragDropAcceptFlags = ImGuiDragDropFlags_None; g.DragDropAcceptIdCurr = g.DragDropAcceptIdPrev = 0; g.DragDropAcceptIdCurrRectSurface = FLT_MAX; g.DragDropAcceptFrameCount = -1; g.DragDropPayloadBufHeap.clear(); memset(&g.DragDropPayloadBufLocal, 0, sizeof(g.DragDropPayloadBufLocal)); } bool ImGui::BeginTooltipHidden() { ImGuiContext& g = *GImGui; bool ret = Begin("##Tooltip_Hidden", NULL, ImGuiWindowFlags_Tooltip | ImGuiWindowFlags_NoInputs | ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoSavedSettings | ImGuiWindowFlags_AlwaysAutoResize); SetWindowHiddenAndSkipItemsForCurrentFrame(g.CurrentWindow); return ret; } // When this returns true you need to: a) call SetDragDropPayload() exactly once, b) you may render the payload visual/description, c) call EndDragDropSource() // If the item has an identifier: // - This assume/require the item to be activated (typically via ButtonBehavior). // - Therefore if you want to use this with a mouse button other than left mouse button, it is up to the item itself to activate with another button. // - We then pull and use the mouse button that was used to activate the item and use it to carry on the drag. // If the item has no identifier: // - Currently always assume left mouse button. bool ImGui::BeginDragDropSource(ImGuiDragDropFlags flags) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; // FIXME-DRAGDROP: While in the common-most "drag from non-zero active id" case we can tell the mouse button, // in both SourceExtern and id==0 cases we may requires something else (explicit flags or some heuristic). ImGuiMouseButton mouse_button = ImGuiMouseButton_Left; bool source_drag_active = false; ImGuiID source_id = 0; ImGuiID source_parent_id = 0; if ((flags & ImGuiDragDropFlags_SourceExtern) == 0) { source_id = g.LastItemData.ID; if (source_id != 0) { // Common path: items with ID if (g.ActiveId != source_id) return false; if (g.ActiveIdMouseButton != -1) mouse_button = g.ActiveIdMouseButton; if (g.IO.MouseDown[mouse_button] == false || window->SkipItems) return false; g.ActiveIdAllowOverlap = false; } else { // Uncommon path: items without ID if (g.IO.MouseDown[mouse_button] == false || window->SkipItems) return false; if ((g.LastItemData.StatusFlags & ImGuiItemStatusFlags_HoveredRect) == 0 && (g.ActiveId == 0 || g.ActiveIdWindow != window)) return false; // If you want to use BeginDragDropSource() on an item with no unique identifier for interaction, such as Text() or Image(), you need to: // A) Read the explanation below, B) Use the ImGuiDragDropFlags_SourceAllowNullID flag. if (!(flags & ImGuiDragDropFlags_SourceAllowNullID)) { IM_ASSERT(0); return false; } // Magic fallback to handle items with no assigned ID, e.g. Text(), Image() // We build a throwaway ID based on current ID stack + relative AABB of items in window. // THE IDENTIFIER WON'T SURVIVE ANY REPOSITIONING/RESIZINGG OF THE WIDGET, so if your widget moves your dragging operation will be canceled. // We don't need to maintain/call ClearActiveID() as releasing the button will early out this function and trigger !ActiveIdIsAlive. // Rely on keeping other window->LastItemXXX fields intact. source_id = g.LastItemData.ID = window->GetIDFromRectangle(g.LastItemData.Rect); KeepAliveID(source_id); bool is_hovered = ItemHoverable(g.LastItemData.Rect, source_id, g.LastItemData.ItemFlags); if (is_hovered && g.IO.MouseClicked[mouse_button]) { SetActiveID(source_id, window); FocusWindow(window); } if (g.ActiveId == source_id) // Allow the underlying widget to display/return hovered during the mouse release frame, else we would get a flicker. g.ActiveIdAllowOverlap = is_hovered; } if (g.ActiveId != source_id) return false; source_parent_id = window->IDStack.back(); source_drag_active = IsMouseDragging(mouse_button); // Disable navigation and key inputs while dragging + cancel existing request if any SetActiveIdUsingAllKeyboardKeys(); } else { // When ImGuiDragDropFlags_SourceExtern is set: window = NULL; source_id = ImHashStr("#SourceExtern"); source_drag_active = true; mouse_button = g.IO.MouseDown[0] ? 0 : -1; KeepAliveID(source_id); SetActiveID(source_id, NULL); } IM_ASSERT(g.DragDropWithinTarget == false); // Can't nest BeginDragDropSource() and BeginDragDropTarget() if (!source_drag_active) return false; // Activate drag and drop if (!g.DragDropActive) { IM_ASSERT(source_id != 0); ClearDragDrop(); IMGUI_DEBUG_LOG_ACTIVEID("[dragdrop] BeginDragDropSource() DragDropActive = true, source_id = 0x%08X%s\n", source_id, (flags & ImGuiDragDropFlags_SourceExtern) ? " (EXTERN)" : ""); ImGuiPayload& payload = g.DragDropPayload; payload.SourceId = source_id; payload.SourceParentId = source_parent_id; g.DragDropActive = true; g.DragDropSourceFlags = flags; g.DragDropMouseButton = mouse_button; if (payload.SourceId == g.ActiveId) g.ActiveIdNoClearOnFocusLoss = true; } g.DragDropSourceFrameCount = g.FrameCount; g.DragDropWithinSource = true; if (!(flags & ImGuiDragDropFlags_SourceNoPreviewTooltip)) { // Target can request the Source to not display its tooltip (we use a dedicated flag to make this request explicit) // We unfortunately can't just modify the source flags and skip the call to BeginTooltip, as caller may be emitting contents. bool ret; if (g.DragDropAcceptIdPrev && (g.DragDropAcceptFlags & ImGuiDragDropFlags_AcceptNoPreviewTooltip)) ret = BeginTooltipHidden(); else ret = BeginTooltip(); IM_ASSERT(ret); // FIXME-NEWBEGIN: If this ever becomes false, we need to Begin("##Hidden", NULL, ImGuiWindowFlags_NoSavedSettings) + SetWindowHiddendAndSkipItemsForCurrentFrame(). IM_UNUSED(ret); } if (!(flags & ImGuiDragDropFlags_SourceNoDisableHover) && !(flags & ImGuiDragDropFlags_SourceExtern)) g.LastItemData.StatusFlags &= ~ImGuiItemStatusFlags_HoveredRect; return true; } void ImGui::EndDragDropSource() { ImGuiContext& g = *GImGui; IM_ASSERT(g.DragDropActive); IM_ASSERT(g.DragDropWithinSource && "Not after a BeginDragDropSource()?"); if (!(g.DragDropSourceFlags & ImGuiDragDropFlags_SourceNoPreviewTooltip)) EndTooltip(); // Discard the drag if have not called SetDragDropPayload() if (g.DragDropPayload.DataFrameCount == -1) ClearDragDrop(); g.DragDropWithinSource = false; } // Use 'cond' to choose to submit payload on drag start or every frame bool ImGui::SetDragDropPayload(const char* type, const void* data, size_t data_size, ImGuiCond cond) { ImGuiContext& g = *GImGui; ImGuiPayload& payload = g.DragDropPayload; if (cond == 0) cond = ImGuiCond_Always; IM_ASSERT(type != NULL); IM_ASSERT(ImStrlen(type) < IM_ARRAYSIZE(payload.DataType) && "Payload type can be at most 32 characters long"); IM_ASSERT((data != NULL && data_size > 0) || (data == NULL && data_size == 0)); IM_ASSERT(cond == ImGuiCond_Always || cond == ImGuiCond_Once); IM_ASSERT(payload.SourceId != 0); // Not called between BeginDragDropSource() and EndDragDropSource() if (cond == ImGuiCond_Always || payload.DataFrameCount == -1) { // Copy payload ImStrncpy(payload.DataType, type, IM_ARRAYSIZE(payload.DataType)); g.DragDropPayloadBufHeap.resize(0); if (data_size > sizeof(g.DragDropPayloadBufLocal)) { // Store in heap g.DragDropPayloadBufHeap.resize((int)data_size); payload.Data = g.DragDropPayloadBufHeap.Data; memcpy(payload.Data, data, data_size); } else if (data_size > 0) { // Store locally memset(&g.DragDropPayloadBufLocal, 0, sizeof(g.DragDropPayloadBufLocal)); payload.Data = g.DragDropPayloadBufLocal; memcpy(payload.Data, data, data_size); } else { payload.Data = NULL; } payload.DataSize = (int)data_size; } payload.DataFrameCount = g.FrameCount; // Return whether the payload has been accepted return (g.DragDropAcceptFrameCount == g.FrameCount) || (g.DragDropAcceptFrameCount == g.FrameCount - 1); } bool ImGui::BeginDragDropTargetCustom(const ImRect& bb, ImGuiID id) { ImGuiContext& g = *GImGui; if (!g.DragDropActive) return false; ImGuiWindow* window = g.CurrentWindow; ImGuiWindow* hovered_window = g.HoveredWindowUnderMovingWindow; if (hovered_window == NULL || window->RootWindow != hovered_window->RootWindow) return false; IM_ASSERT(id != 0); if (!IsMouseHoveringRect(bb.Min, bb.Max) || (id == g.DragDropPayload.SourceId)) return false; if (window->SkipItems) return false; IM_ASSERT(g.DragDropWithinTarget == false && g.DragDropWithinSource == false); // Can't nest BeginDragDropSource() and BeginDragDropTarget() g.DragDropTargetRect = bb; g.DragDropTargetClipRect = window->ClipRect; // May want to be overridden by user depending on use case? g.DragDropTargetId = id; g.DragDropWithinTarget = true; return true; } // We don't use BeginDragDropTargetCustom() and duplicate its code because: // 1) we use LastItemData's ImGuiItemStatusFlags_HoveredRect which handles items that push a temporarily clip rectangle in their code. Calling BeginDragDropTargetCustom(LastItemRect) would not handle them. // 2) and it's faster. as this code may be very frequently called, we want to early out as fast as we can. // Also note how the HoveredWindow test is positioned differently in both functions (in both functions we optimize for the cheapest early out case) bool ImGui::BeginDragDropTarget() { ImGuiContext& g = *GImGui; if (!g.DragDropActive) return false; ImGuiWindow* window = g.CurrentWindow; if (!(g.LastItemData.StatusFlags & ImGuiItemStatusFlags_HoveredRect)) return false; ImGuiWindow* hovered_window = g.HoveredWindowUnderMovingWindow; if (hovered_window == NULL || window->RootWindow != hovered_window->RootWindow || window->SkipItems) return false; const ImRect& display_rect = (g.LastItemData.StatusFlags & ImGuiItemStatusFlags_HasDisplayRect) ? g.LastItemData.DisplayRect : g.LastItemData.Rect; ImGuiID id = g.LastItemData.ID; if (id == 0) { id = window->GetIDFromRectangle(display_rect); KeepAliveID(id); } if (g.DragDropPayload.SourceId == id) return false; IM_ASSERT(g.DragDropWithinTarget == false && g.DragDropWithinSource == false); // Can't nest BeginDragDropSource() and BeginDragDropTarget() g.DragDropTargetRect = display_rect; g.DragDropTargetClipRect = (g.LastItemData.StatusFlags & ImGuiItemStatusFlags_HasClipRect) ? g.LastItemData.ClipRect : window->ClipRect; g.DragDropTargetId = id; g.DragDropWithinTarget = true; return true; } bool ImGui::IsDragDropPayloadBeingAccepted() { ImGuiContext& g = *GImGui; return g.DragDropActive && g.DragDropAcceptIdPrev != 0; } const ImGuiPayload* ImGui::AcceptDragDropPayload(const char* type, ImGuiDragDropFlags flags) { ImGuiContext& g = *GImGui; ImGuiPayload& payload = g.DragDropPayload; IM_ASSERT(g.DragDropActive); // Not called between BeginDragDropTarget() and EndDragDropTarget() ? IM_ASSERT(payload.DataFrameCount != -1); // Forgot to call EndDragDropTarget() ? if (type != NULL && !payload.IsDataType(type)) return NULL; // Accept smallest drag target bounding box, this allows us to nest drag targets conveniently without ordering constraints. // NB: We currently accept NULL id as target. However, overlapping targets requires a unique ID to function! const bool was_accepted_previously = (g.DragDropAcceptIdPrev == g.DragDropTargetId); ImRect r = g.DragDropTargetRect; float r_surface = r.GetWidth() * r.GetHeight(); if (r_surface > g.DragDropAcceptIdCurrRectSurface) return NULL; g.DragDropAcceptFlags = flags; g.DragDropAcceptIdCurr = g.DragDropTargetId; g.DragDropAcceptIdCurrRectSurface = r_surface; //IMGUI_DEBUG_LOG("AcceptDragDropPayload(): %08X: accept\n", g.DragDropTargetId); // Render default drop visuals payload.Preview = was_accepted_previously; flags |= (g.DragDropSourceFlags & ImGuiDragDropFlags_AcceptNoDrawDefaultRect); // Source can also inhibit the preview (useful for external sources that live for 1 frame) if (!(flags & ImGuiDragDropFlags_AcceptNoDrawDefaultRect) && payload.Preview) RenderDragDropTargetRect(r, g.DragDropTargetClipRect); g.DragDropAcceptFrameCount = g.FrameCount; if ((g.DragDropSourceFlags & ImGuiDragDropFlags_SourceExtern) && g.DragDropMouseButton == -1) payload.Delivery = was_accepted_previously && (g.DragDropSourceFrameCount < g.FrameCount); else payload.Delivery = was_accepted_previously && !IsMouseDown(g.DragDropMouseButton); // For extern drag sources affecting OS window focus, it's easier to just test !IsMouseDown() instead of IsMouseReleased() if (!payload.Delivery && !(flags & ImGuiDragDropFlags_AcceptBeforeDelivery)) return NULL; if (payload.Delivery) IMGUI_DEBUG_LOG_ACTIVEID("[dragdrop] AcceptDragDropPayload(): 0x%08X: payload delivery\n", g.DragDropTargetId); return &payload; } // FIXME-STYLE FIXME-DRAGDROP: Settle on a proper default visuals for drop target. void ImGui::RenderDragDropTargetRect(const ImRect& bb, const ImRect& item_clip_rect) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; ImRect bb_display = bb; bb_display.ClipWith(item_clip_rect); // Clip THEN expand so we have a way to visualize that target is not entirely visible. bb_display.Expand(3.5f); bool push_clip_rect = !window->ClipRect.Contains(bb_display); if (push_clip_rect) window->DrawList->PushClipRectFullScreen(); window->DrawList->AddRect(bb_display.Min, bb_display.Max, GetColorU32(ImGuiCol_DragDropTarget), 0.0f, 0, 2.0f); if (push_clip_rect) window->DrawList->PopClipRect(); } const ImGuiPayload* ImGui::GetDragDropPayload() { ImGuiContext& g = *GImGui; return (g.DragDropActive && g.DragDropPayload.DataFrameCount != -1) ? &g.DragDropPayload : NULL; } void ImGui::EndDragDropTarget() { ImGuiContext& g = *GImGui; IM_ASSERT(g.DragDropActive); IM_ASSERT(g.DragDropWithinTarget); g.DragDropWithinTarget = false; // Clear drag and drop state payload right after delivery if (g.DragDropPayload.Delivery) ClearDragDrop(); } //----------------------------------------------------------------------------- // [SECTION] LOGGING/CAPTURING //----------------------------------------------------------------------------- // All text output from the interface can be captured into tty/file/clipboard. // By default, tree nodes are automatically opened during logging. //----------------------------------------------------------------------------- // Pass text data straight to log (without being displayed) static inline void LogTextV(ImGuiContext& g, const char* fmt, va_list args) { if (g.LogFile) { g.LogBuffer.Buf.resize(0); g.LogBuffer.appendfv(fmt, args); ImFileWrite(g.LogBuffer.c_str(), sizeof(char), (ImU64)g.LogBuffer.size(), g.LogFile); } else { g.LogBuffer.appendfv(fmt, args); } } void ImGui::LogText(const char* fmt, ...) { ImGuiContext& g = *GImGui; if (!g.LogEnabled) return; va_list args; va_start(args, fmt); LogTextV(g, fmt, args); va_end(args); } void ImGui::LogTextV(const char* fmt, va_list args) { ImGuiContext& g = *GImGui; if (!g.LogEnabled) return; LogTextV(g, fmt, args); } // Internal version that takes a position to decide on newline placement and pad items according to their depth. // We split text into individual lines to add current tree level padding // FIXME: This code is a little complicated perhaps, considering simplifying the whole system. void ImGui::LogRenderedText(const ImVec2* ref_pos, const char* text, const char* text_end) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; const char* prefix = g.LogNextPrefix; const char* suffix = g.LogNextSuffix; g.LogNextPrefix = g.LogNextSuffix = NULL; if (!text_end) text_end = FindRenderedTextEnd(text, text_end); const bool log_new_line = ref_pos && (ref_pos->y > g.LogLinePosY + g.Style.FramePadding.y + 1); if (ref_pos) g.LogLinePosY = ref_pos->y; if (log_new_line) { LogText(IM_NEWLINE); g.LogLineFirstItem = true; } if (prefix) LogRenderedText(ref_pos, prefix, prefix + ImStrlen(prefix)); // Calculate end ourself to ensure "##" are included here. // Re-adjust padding if we have popped out of our starting depth if (g.LogDepthRef > window->DC.TreeDepth) g.LogDepthRef = window->DC.TreeDepth; const int tree_depth = (window->DC.TreeDepth - g.LogDepthRef); const char* text_remaining = text; for (;;) { // Split the string. Each new line (after a '\n') is followed by indentation corresponding to the current depth of our log entry. // We don't add a trailing \n yet to allow a subsequent item on the same line to be captured. const char* line_start = text_remaining; const char* line_end = ImStreolRange(line_start, text_end); const bool is_last_line = (line_end == text_end); if (line_start != line_end || !is_last_line) { const int line_length = (int)(line_end - line_start); const int indentation = g.LogLineFirstItem ? tree_depth * 4 : 1; LogText("%*s%.*s", indentation, "", line_length, line_start); g.LogLineFirstItem = false; if (*line_end == '\n') { LogText(IM_NEWLINE); g.LogLineFirstItem = true; } } if (is_last_line) break; text_remaining = line_end + 1; } if (suffix) LogRenderedText(ref_pos, suffix, suffix + ImStrlen(suffix)); } // Start logging/capturing text output void ImGui::LogBegin(ImGuiLogFlags flags, int auto_open_depth) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; IM_ASSERT(g.LogEnabled == false); IM_ASSERT(g.LogFile == NULL && g.LogBuffer.empty()); IM_ASSERT(ImIsPowerOfTwo(flags & ImGuiLogFlags_OutputMask_)); // Check that only 1 type flag is used g.LogEnabled = g.ItemUnclipByLog = true; g.LogFlags = flags; g.LogWindow = window; g.LogNextPrefix = g.LogNextSuffix = NULL; g.LogDepthRef = window->DC.TreeDepth; g.LogDepthToExpand = ((auto_open_depth >= 0) ? auto_open_depth : g.LogDepthToExpandDefault); g.LogLinePosY = FLT_MAX; g.LogLineFirstItem = true; } // Important: doesn't copy underlying data, use carefully (prefix/suffix must be in scope at the time of the next LogRenderedText) void ImGui::LogSetNextTextDecoration(const char* prefix, const char* suffix) { ImGuiContext& g = *GImGui; g.LogNextPrefix = prefix; g.LogNextSuffix = suffix; } void ImGui::LogToTTY(int auto_open_depth) { ImGuiContext& g = *GImGui; if (g.LogEnabled) return; IM_UNUSED(auto_open_depth); #ifndef IMGUI_DISABLE_TTY_FUNCTIONS LogBegin(ImGuiLogFlags_OutputTTY, auto_open_depth); g.LogFile = stdout; #endif } // Start logging/capturing text output to given file void ImGui::LogToFile(int auto_open_depth, const char* filename) { ImGuiContext& g = *GImGui; if (g.LogEnabled) return; // FIXME: We could probably open the file in text mode "at", however note that clipboard/buffer logging will still // be subject to outputting OS-incompatible carriage return if within strings the user doesn't use IM_NEWLINE. // By opening the file in binary mode "ab" we have consistent output everywhere. if (!filename) filename = g.IO.LogFilename; if (!filename || !filename[0]) return; ImFileHandle f = ImFileOpen(filename, "ab"); if (!f) { IM_ASSERT(0); return; } LogBegin(ImGuiLogFlags_OutputFile, auto_open_depth); g.LogFile = f; } // Start logging/capturing text output to clipboard void ImGui::LogToClipboard(int auto_open_depth) { ImGuiContext& g = *GImGui; if (g.LogEnabled) return; LogBegin(ImGuiLogFlags_OutputClipboard, auto_open_depth); } void ImGui::LogToBuffer(int auto_open_depth) { ImGuiContext& g = *GImGui; if (g.LogEnabled) return; LogBegin(ImGuiLogFlags_OutputBuffer, auto_open_depth); } void ImGui::LogFinish() { ImGuiContext& g = *GImGui; if (!g.LogEnabled) return; LogText(IM_NEWLINE); switch (g.LogFlags & ImGuiLogFlags_OutputMask_) { case ImGuiLogFlags_OutputTTY: #ifndef IMGUI_DISABLE_TTY_FUNCTIONS fflush(g.LogFile); #endif break; case ImGuiLogFlags_OutputFile: ImFileClose(g.LogFile); break; case ImGuiLogFlags_OutputBuffer: break; case ImGuiLogFlags_OutputClipboard: if (!g.LogBuffer.empty()) SetClipboardText(g.LogBuffer.begin()); break; default: IM_ASSERT(0); break; } g.LogEnabled = g.ItemUnclipByLog = false; g.LogFlags = ImGuiLogFlags_None; g.LogFile = NULL; g.LogBuffer.clear(); } // Helper to display logging buttons // FIXME-OBSOLETE: We should probably obsolete this and let the user have their own helper (this is one of the oldest function alive!) void ImGui::LogButtons() { ImGuiContext& g = *GImGui; PushID("LogButtons"); #ifndef IMGUI_DISABLE_TTY_FUNCTIONS const bool log_to_tty = Button("Log To TTY"); SameLine(); #else const bool log_to_tty = false; #endif const bool log_to_file = Button("Log To File"); SameLine(); const bool log_to_clipboard = Button("Log To Clipboard"); SameLine(); PushItemFlag(ImGuiItemFlags_NoTabStop, true); SetNextItemWidth(80.0f); SliderInt("Default Depth", &g.LogDepthToExpandDefault, 0, 9, NULL); PopItemFlag(); PopID(); // Start logging at the end of the function so that the buttons don't appear in the log if (log_to_tty) LogToTTY(); if (log_to_file) LogToFile(); if (log_to_clipboard) LogToClipboard(); } //----------------------------------------------------------------------------- // [SECTION] SETTINGS //----------------------------------------------------------------------------- // - UpdateSettings() [Internal] // - MarkIniSettingsDirty() [Internal] // - FindSettingsHandler() [Internal] // - ClearIniSettings() [Internal] // - LoadIniSettingsFromDisk() // - LoadIniSettingsFromMemory() // - SaveIniSettingsToDisk() // - SaveIniSettingsToMemory() //----------------------------------------------------------------------------- // - CreateNewWindowSettings() [Internal] // - FindWindowSettingsByID() [Internal] // - FindWindowSettingsByWindow() [Internal] // - ClearWindowSettings() [Internal] // - WindowSettingsHandler_***() [Internal] //----------------------------------------------------------------------------- // Called by NewFrame() void ImGui::UpdateSettings() { // Load settings on first frame (if not explicitly loaded manually before) ImGuiContext& g = *GImGui; if (!g.SettingsLoaded) { IM_ASSERT(g.SettingsWindows.empty()); if (g.IO.IniFilename) LoadIniSettingsFromDisk(g.IO.IniFilename); g.SettingsLoaded = true; } // Save settings (with a delay after the last modification, so we don't spam disk too much) if (g.SettingsDirtyTimer > 0.0f) { g.SettingsDirtyTimer -= g.IO.DeltaTime; if (g.SettingsDirtyTimer <= 0.0f) { if (g.IO.IniFilename != NULL) SaveIniSettingsToDisk(g.IO.IniFilename); else g.IO.WantSaveIniSettings = true; // Let user know they can call SaveIniSettingsToMemory(). user will need to clear io.WantSaveIniSettings themselves. g.SettingsDirtyTimer = 0.0f; } } } void ImGui::MarkIniSettingsDirty() { ImGuiContext& g = *GImGui; if (g.SettingsDirtyTimer <= 0.0f) g.SettingsDirtyTimer = g.IO.IniSavingRate; } void ImGui::MarkIniSettingsDirty(ImGuiWindow* window) { ImGuiContext& g = *GImGui; if (!(window->Flags & ImGuiWindowFlags_NoSavedSettings)) if (g.SettingsDirtyTimer <= 0.0f) g.SettingsDirtyTimer = g.IO.IniSavingRate; } void ImGui::AddSettingsHandler(const ImGuiSettingsHandler* handler) { ImGuiContext& g = *GImGui; IM_ASSERT(FindSettingsHandler(handler->TypeName) == NULL); g.SettingsHandlers.push_back(*handler); } void ImGui::RemoveSettingsHandler(const char* type_name) { ImGuiContext& g = *GImGui; if (ImGuiSettingsHandler* handler = FindSettingsHandler(type_name)) g.SettingsHandlers.erase(handler); } ImGuiSettingsHandler* ImGui::FindSettingsHandler(const char* type_name) { ImGuiContext& g = *GImGui; const ImGuiID type_hash = ImHashStr(type_name); for (ImGuiSettingsHandler& handler : g.SettingsHandlers) if (handler.TypeHash == type_hash) return &handler; return NULL; } // Clear all settings (windows, tables, docking etc.) void ImGui::ClearIniSettings() { ImGuiContext& g = *GImGui; g.SettingsIniData.clear(); for (ImGuiSettingsHandler& handler : g.SettingsHandlers) if (handler.ClearAllFn != NULL) handler.ClearAllFn(&g, &handler); } void ImGui::LoadIniSettingsFromDisk(const char* ini_filename) { size_t file_data_size = 0; char* file_data = (char*)ImFileLoadToMemory(ini_filename, "rb", &file_data_size); if (!file_data) return; if (file_data_size > 0) LoadIniSettingsFromMemory(file_data, (size_t)file_data_size); IM_FREE(file_data); } // Zero-tolerance, no error reporting, cheap .ini parsing // Set ini_size==0 to let us use strlen(ini_data). Do not call this function with a 0 if your buffer is actually empty! void ImGui::LoadIniSettingsFromMemory(const char* ini_data, size_t ini_size) { ImGuiContext& g = *GImGui; IM_ASSERT(g.Initialized); //IM_ASSERT(!g.WithinFrameScope && "Cannot be called between NewFrame() and EndFrame()"); //IM_ASSERT(g.SettingsLoaded == false && g.FrameCount == 0); // For user convenience, we allow passing a non zero-terminated string (hence the ini_size parameter). // For our convenience and to make the code simpler, we'll also write zero-terminators within the buffer. So let's create a writable copy.. if (ini_size == 0) ini_size = ImStrlen(ini_data); g.SettingsIniData.Buf.resize((int)ini_size + 1); char* const buf = g.SettingsIniData.Buf.Data; char* const buf_end = buf + ini_size; memcpy(buf, ini_data, ini_size); buf_end[0] = 0; // Call pre-read handlers // Some types will clear their data (e.g. dock information) some types will allow merge/override (window) for (ImGuiSettingsHandler& handler : g.SettingsHandlers) if (handler.ReadInitFn != NULL) handler.ReadInitFn(&g, &handler); void* entry_data = NULL; ImGuiSettingsHandler* entry_handler = NULL; char* line_end = NULL; for (char* line = buf; line < buf_end; line = line_end + 1) { // Skip new lines markers, then find end of the line while (*line == '\n' || *line == '\r') line++; line_end = line; while (line_end < buf_end && *line_end != '\n' && *line_end != '\r') line_end++; line_end[0] = 0; if (line[0] == ';') continue; if (line[0] == '[' && line_end > line && line_end[-1] == ']') { // Parse "[Type][Name]". Note that 'Name' can itself contains [] characters, which is acceptable with the current format and parsing code. line_end[-1] = 0; const char* name_end = line_end - 1; const char* type_start = line + 1; char* type_end = (char*)(void*)ImStrchrRange(type_start, name_end, ']'); const char* name_start = type_end ? ImStrchrRange(type_end + 1, name_end, '[') : NULL; if (!type_end || !name_start) continue; *type_end = 0; // Overwrite first ']' name_start++; // Skip second '[' entry_handler = FindSettingsHandler(type_start); entry_data = entry_handler ? entry_handler->ReadOpenFn(&g, entry_handler, name_start) : NULL; } else if (entry_handler != NULL && entry_data != NULL) { // Let type handler parse the line entry_handler->ReadLineFn(&g, entry_handler, entry_data, line); } } g.SettingsLoaded = true; // [DEBUG] Restore untouched copy so it can be browsed in Metrics (not strictly necessary) memcpy(buf, ini_data, ini_size); // Call post-read handlers for (ImGuiSettingsHandler& handler : g.SettingsHandlers) if (handler.ApplyAllFn != NULL) handler.ApplyAllFn(&g, &handler); } void ImGui::SaveIniSettingsToDisk(const char* ini_filename) { ImGuiContext& g = *GImGui; g.SettingsDirtyTimer = 0.0f; if (!ini_filename) return; size_t ini_data_size = 0; const char* ini_data = SaveIniSettingsToMemory(&ini_data_size); ImFileHandle f = ImFileOpen(ini_filename, "wt"); if (!f) return; ImFileWrite(ini_data, sizeof(char), ini_data_size, f); ImFileClose(f); } // Call registered handlers (e.g. SettingsHandlerWindow_WriteAll() + custom handlers) to write their stuff into a text buffer const char* ImGui::SaveIniSettingsToMemory(size_t* out_size) { ImGuiContext& g = *GImGui; g.SettingsDirtyTimer = 0.0f; g.SettingsIniData.Buf.resize(0); g.SettingsIniData.Buf.push_back(0); for (ImGuiSettingsHandler& handler : g.SettingsHandlers) handler.WriteAllFn(&g, &handler, &g.SettingsIniData); if (out_size) *out_size = (size_t)g.SettingsIniData.size(); return g.SettingsIniData.c_str(); } ImGuiWindowSettings* ImGui::CreateNewWindowSettings(const char* name) { ImGuiContext& g = *GImGui; if (g.IO.ConfigDebugIniSettings == false) { // Skip to the "###" marker if any. We don't skip past to match the behavior of GetID() // Preserve the full string when ConfigDebugVerboseIniSettings is set to make .ini inspection easier. if (const char* p = strstr(name, "###")) name = p; } const size_t name_len = ImStrlen(name); // Allocate chunk const size_t chunk_size = sizeof(ImGuiWindowSettings) + name_len + 1; ImGuiWindowSettings* settings = g.SettingsWindows.alloc_chunk(chunk_size); IM_PLACEMENT_NEW(settings) ImGuiWindowSettings(); settings->ID = ImHashStr(name, name_len); memcpy(settings->GetName(), name, name_len + 1); // Store with zero terminator return settings; } // We don't provide a FindWindowSettingsByName() because Docking system doesn't always hold on names. // This is called once per window .ini entry + once per newly instantiated window. ImGuiWindowSettings* ImGui::FindWindowSettingsByID(ImGuiID id) { ImGuiContext& g = *GImGui; for (ImGuiWindowSettings* settings = g.SettingsWindows.begin(); settings != NULL; settings = g.SettingsWindows.next_chunk(settings)) if (settings->ID == id && !settings->WantDelete) return settings; return NULL; } // This is faster if you are holding on a Window already as we don't need to perform a search. ImGuiWindowSettings* ImGui::FindWindowSettingsByWindow(ImGuiWindow* window) { ImGuiContext& g = *GImGui; if (window->SettingsOffset != -1) return g.SettingsWindows.ptr_from_offset(window->SettingsOffset); return FindWindowSettingsByID(window->ID); } // This will revert window to its initial state, including enabling the ImGuiCond_FirstUseEver/ImGuiCond_Once conditions once more. void ImGui::ClearWindowSettings(const char* name) { //IMGUI_DEBUG_LOG("ClearWindowSettings('%s')\n", name); ImGuiWindow* window = FindWindowByName(name); if (window != NULL) { window->Flags |= ImGuiWindowFlags_NoSavedSettings; InitOrLoadWindowSettings(window, NULL); } if (ImGuiWindowSettings* settings = window ? FindWindowSettingsByWindow(window) : FindWindowSettingsByID(ImHashStr(name))) settings->WantDelete = true; } static void WindowSettingsHandler_ClearAll(ImGuiContext* ctx, ImGuiSettingsHandler*) { ImGuiContext& g = *ctx; for (ImGuiWindow* window : g.Windows) window->SettingsOffset = -1; g.SettingsWindows.clear(); } static void* WindowSettingsHandler_ReadOpen(ImGuiContext*, ImGuiSettingsHandler*, const char* name) { ImGuiID id = ImHashStr(name); ImGuiWindowSettings* settings = ImGui::FindWindowSettingsByID(id); if (settings) *settings = ImGuiWindowSettings(); // Clear existing if recycling previous entry else settings = ImGui::CreateNewWindowSettings(name); settings->ID = id; settings->WantApply = true; return (void*)settings; } static void WindowSettingsHandler_ReadLine(ImGuiContext*, ImGuiSettingsHandler*, void* entry, const char* line) { ImGuiWindowSettings* settings = (ImGuiWindowSettings*)entry; int x, y; int i; if (sscanf(line, "Pos=%i,%i", &x, &y) == 2) { settings->Pos = ImVec2ih((short)x, (short)y); } else if (sscanf(line, "Size=%i,%i", &x, &y) == 2) { settings->Size = ImVec2ih((short)x, (short)y); } else if (sscanf(line, "Collapsed=%d", &i) == 1) { settings->Collapsed = (i != 0); } else if (sscanf(line, "IsChild=%d", &i) == 1) { settings->IsChild = (i != 0); } } // Apply to existing windows (if any) static void WindowSettingsHandler_ApplyAll(ImGuiContext* ctx, ImGuiSettingsHandler*) { ImGuiContext& g = *ctx; for (ImGuiWindowSettings* settings = g.SettingsWindows.begin(); settings != NULL; settings = g.SettingsWindows.next_chunk(settings)) if (settings->WantApply) { if (ImGuiWindow* window = ImGui::FindWindowByID(settings->ID)) ApplyWindowSettings(window, settings); settings->WantApply = false; } } static void WindowSettingsHandler_WriteAll(ImGuiContext* ctx, ImGuiSettingsHandler* handler, ImGuiTextBuffer* buf) { // Gather data from windows that were active during this session // (if a window wasn't opened in this session we preserve its settings) ImGuiContext& g = *ctx; for (ImGuiWindow* window : g.Windows) { if (window->Flags & ImGuiWindowFlags_NoSavedSettings) continue; ImGuiWindowSettings* settings = ImGui::FindWindowSettingsByWindow(window); if (!settings) { settings = ImGui::CreateNewWindowSettings(window->Name); window->SettingsOffset = g.SettingsWindows.offset_from_ptr(settings); } IM_ASSERT(settings->ID == window->ID); settings->Pos = ImVec2ih(window->Pos); settings->Size = ImVec2ih(window->SizeFull); settings->IsChild = (window->Flags & ImGuiWindowFlags_ChildWindow) != 0; settings->Collapsed = window->Collapsed; settings->WantDelete = false; } // Write to text buffer buf->reserve(buf->size() + g.SettingsWindows.size() * 6); // ballpark reserve for (ImGuiWindowSettings* settings = g.SettingsWindows.begin(); settings != NULL; settings = g.SettingsWindows.next_chunk(settings)) { if (settings->WantDelete) continue; const char* settings_name = settings->GetName(); buf->appendf("[%s][%s]\n", handler->TypeName, settings_name); if (settings->IsChild) { buf->appendf("IsChild=1\n"); buf->appendf("Size=%d,%d\n", settings->Size.x, settings->Size.y); } else { buf->appendf("Pos=%d,%d\n", settings->Pos.x, settings->Pos.y); buf->appendf("Size=%d,%d\n", settings->Size.x, settings->Size.y); if (settings->Collapsed) buf->appendf("Collapsed=1\n"); } buf->append("\n"); } } //----------------------------------------------------------------------------- // [SECTION] LOCALIZATION //----------------------------------------------------------------------------- void ImGui::LocalizeRegisterEntries(const ImGuiLocEntry* entries, int count) { ImGuiContext& g = *GImGui; for (int n = 0; n < count; n++) g.LocalizationTable[entries[n].Key] = entries[n].Text; } //----------------------------------------------------------------------------- // [SECTION] VIEWPORTS, PLATFORM WINDOWS //----------------------------------------------------------------------------- // - GetMainViewport() // - SetWindowViewport() [Internal] // - ScaleWindowsInViewport() [Internal] // - UpdateViewportsNewFrame() [Internal] // (this section is more complete in the 'docking' branch) //----------------------------------------------------------------------------- ImGuiViewport* ImGui::GetMainViewport() { ImGuiContext& g = *GImGui; return g.Viewports[0]; } void ImGui::SetWindowViewport(ImGuiWindow* window, ImGuiViewportP* viewport) { window->Viewport = viewport; } static void ScaleWindow(ImGuiWindow* window, float scale) { ImVec2 origin = window->Viewport->Pos; window->Pos = ImFloor((window->Pos - origin) * scale + origin); window->Size = ImTrunc(window->Size * scale); window->SizeFull = ImTrunc(window->SizeFull * scale); window->ContentSize = ImTrunc(window->ContentSize * scale); } // Scale all windows (position, size). Use when e.g. changing DPI. (This is a lossy operation!) void ImGui::ScaleWindowsInViewport(ImGuiViewportP* viewport, float scale) { ImGuiContext& g = *GImGui; for (ImGuiWindow* window : g.Windows) if (window->Viewport == viewport) ScaleWindow(window, scale); } // Update viewports and monitor infos static void ImGui::UpdateViewportsNewFrame() { ImGuiContext& g = *GImGui; IM_ASSERT(g.Viewports.Size == 1); // Update main viewport with current platform position. // FIXME-VIEWPORT: Size is driven by backend/user code for backward-compatibility but we should aim to make this more consistent. ImGuiViewportP* main_viewport = g.Viewports[0]; main_viewport->Flags = ImGuiViewportFlags_IsPlatformWindow | ImGuiViewportFlags_OwnedByApp; main_viewport->Pos = ImVec2(0.0f, 0.0f); main_viewport->Size = g.IO.DisplaySize; for (ImGuiViewportP* viewport : g.Viewports) { // Lock down space taken by menu bars and status bars // Setup initial value for functions like BeginMainMenuBar(), DockSpaceOverViewport() etc. viewport->WorkInsetMin = viewport->BuildWorkInsetMin; viewport->WorkInsetMax = viewport->BuildWorkInsetMax; viewport->BuildWorkInsetMin = viewport->BuildWorkInsetMax = ImVec2(0.0f, 0.0f); viewport->UpdateWorkRect(); } } //----------------------------------------------------------------------------- // [SECTION] DOCKING //----------------------------------------------------------------------------- // (this section is filled in the 'docking' branch) //----------------------------------------------------------------------------- // [SECTION] PLATFORM DEPENDENT HELPERS //----------------------------------------------------------------------------- // - Default clipboard handlers // - Default shell function handlers // - Default IME handlers //----------------------------------------------------------------------------- #if defined(_WIN32) && !defined(IMGUI_DISABLE_WIN32_FUNCTIONS) && !defined(IMGUI_DISABLE_WIN32_DEFAULT_CLIPBOARD_FUNCTIONS) #ifdef _MSC_VER #pragma comment(lib, "user32") #pragma comment(lib, "kernel32") #endif // Win32 clipboard implementation // We use g.ClipboardHandlerData for temporary storage to ensure it is freed on Shutdown() static const char* Platform_GetClipboardTextFn_DefaultImpl(ImGuiContext* ctx) { ImGuiContext& g = *ctx; g.ClipboardHandlerData.clear(); if (!::OpenClipboard(NULL)) return NULL; HANDLE wbuf_handle = ::GetClipboardData(CF_UNICODETEXT); if (wbuf_handle == NULL) { ::CloseClipboard(); return NULL; } if (const WCHAR* wbuf_global = (const WCHAR*)::GlobalLock(wbuf_handle)) { int buf_len = ::WideCharToMultiByte(CP_UTF8, 0, wbuf_global, -1, NULL, 0, NULL, NULL); g.ClipboardHandlerData.resize(buf_len); ::WideCharToMultiByte(CP_UTF8, 0, wbuf_global, -1, g.ClipboardHandlerData.Data, buf_len, NULL, NULL); } ::GlobalUnlock(wbuf_handle); ::CloseClipboard(); return g.ClipboardHandlerData.Data; } static void Platform_SetClipboardTextFn_DefaultImpl(ImGuiContext*, const char* text) { if (!::OpenClipboard(NULL)) return; const int wbuf_length = ::MultiByteToWideChar(CP_UTF8, 0, text, -1, NULL, 0); HGLOBAL wbuf_handle = ::GlobalAlloc(GMEM_MOVEABLE, (SIZE_T)wbuf_length * sizeof(WCHAR)); if (wbuf_handle == NULL) { ::CloseClipboard(); return; } WCHAR* wbuf_global = (WCHAR*)::GlobalLock(wbuf_handle); ::MultiByteToWideChar(CP_UTF8, 0, text, -1, wbuf_global, wbuf_length); ::GlobalUnlock(wbuf_handle); ::EmptyClipboard(); if (::SetClipboardData(CF_UNICODETEXT, wbuf_handle) == NULL) ::GlobalFree(wbuf_handle); ::CloseClipboard(); } #elif defined(__APPLE__) && TARGET_OS_OSX && defined(IMGUI_ENABLE_OSX_DEFAULT_CLIPBOARD_FUNCTIONS) #include // Use old API to avoid need for separate .mm file static PasteboardRef main_clipboard = 0; // OSX clipboard implementation // If you enable this you will need to add '-framework ApplicationServices' to your linker command-line! static void Platform_SetClipboardTextFn_DefaultImpl(ImGuiContext*, const char* text) { if (!main_clipboard) PasteboardCreate(kPasteboardClipboard, &main_clipboard); PasteboardClear(main_clipboard); CFDataRef cf_data = CFDataCreate(kCFAllocatorDefault, (const UInt8*)text, ImStrlen(text)); if (cf_data) { PasteboardPutItemFlavor(main_clipboard, (PasteboardItemID)1, CFSTR("public.utf8-plain-text"), cf_data, 0); CFRelease(cf_data); } } static const char* Platform_GetClipboardTextFn_DefaultImpl(ImGuiContext* ctx) { ImGuiContext& g = *ctx; if (!main_clipboard) PasteboardCreate(kPasteboardClipboard, &main_clipboard); PasteboardSynchronize(main_clipboard); ItemCount item_count = 0; PasteboardGetItemCount(main_clipboard, &item_count); for (ItemCount i = 0; i < item_count; i++) { PasteboardItemID item_id = 0; PasteboardGetItemIdentifier(main_clipboard, i + 1, &item_id); CFArrayRef flavor_type_array = 0; PasteboardCopyItemFlavors(main_clipboard, item_id, &flavor_type_array); for (CFIndex j = 0, nj = CFArrayGetCount(flavor_type_array); j < nj; j++) { CFDataRef cf_data; if (PasteboardCopyItemFlavorData(main_clipboard, item_id, CFSTR("public.utf8-plain-text"), &cf_data) == noErr) { g.ClipboardHandlerData.clear(); int length = (int)CFDataGetLength(cf_data); g.ClipboardHandlerData.resize(length + 1); CFDataGetBytes(cf_data, CFRangeMake(0, length), (UInt8*)g.ClipboardHandlerData.Data); g.ClipboardHandlerData[length] = 0; CFRelease(cf_data); return g.ClipboardHandlerData.Data; } } } return NULL; } #else // Local Dear ImGui-only clipboard implementation, if user hasn't defined better clipboard handlers. static const char* Platform_GetClipboardTextFn_DefaultImpl(ImGuiContext* ctx) { ImGuiContext& g = *ctx; return g.ClipboardHandlerData.empty() ? NULL : g.ClipboardHandlerData.begin(); } static void Platform_SetClipboardTextFn_DefaultImpl(ImGuiContext* ctx, const char* text) { ImGuiContext& g = *ctx; g.ClipboardHandlerData.clear(); const char* text_end = text + ImStrlen(text); g.ClipboardHandlerData.resize((int)(text_end - text) + 1); memcpy(&g.ClipboardHandlerData[0], text, (size_t)(text_end - text)); g.ClipboardHandlerData[(int)(text_end - text)] = 0; } #endif // Default clipboard handlers //----------------------------------------------------------------------------- #ifndef IMGUI_DISABLE_DEFAULT_SHELL_FUNCTIONS #if defined(__APPLE__) && TARGET_OS_IPHONE #define IMGUI_DISABLE_DEFAULT_SHELL_FUNCTIONS #endif #if defined(__3DS__) #define IMGUI_DISABLE_DEFAULT_SHELL_FUNCTIONS #endif #if defined(_WIN32) && defined(IMGUI_DISABLE_WIN32_FUNCTIONS) #define IMGUI_DISABLE_DEFAULT_SHELL_FUNCTIONS #endif #endif // #ifndef IMGUI_DISABLE_DEFAULT_SHELL_FUNCTIONS #ifndef IMGUI_DISABLE_DEFAULT_SHELL_FUNCTIONS #ifdef _WIN32 #include // ShellExecuteA() #ifdef _MSC_VER #pragma comment(lib, "shell32") #endif static bool Platform_OpenInShellFn_DefaultImpl(ImGuiContext*, const char* path) { const int path_wsize = ::MultiByteToWideChar(CP_UTF8, 0, path, -1, NULL, 0); ImVector path_wbuf; path_wbuf.resize(path_wsize); ::MultiByteToWideChar(CP_UTF8, 0, path, -1, path_wbuf.Data, path_wsize); return (INT_PTR)::ShellExecuteW(NULL, L"open", path_wbuf.Data, NULL, NULL, SW_SHOWDEFAULT) > 32; } #else #include #include static bool Platform_OpenInShellFn_DefaultImpl(ImGuiContext*, const char* path) { #if defined(__APPLE__) const char* args[] { "open", "--", path, NULL }; #else const char* args[] { "xdg-open", path, NULL }; #endif pid_t pid = fork(); if (pid < 0) return false; if (!pid) { execvp(args[0], const_cast(args)); exit(-1); } else { int status; waitpid(pid, &status, 0); return WEXITSTATUS(status) == 0; } } #endif #else static bool Platform_OpenInShellFn_DefaultImpl(ImGuiContext*, const char*) { return false; } #endif // Default shell handlers //----------------------------------------------------------------------------- // Win32 API IME support (for Asian languages, etc.) #if defined(_WIN32) && !defined(IMGUI_DISABLE_WIN32_FUNCTIONS) && !defined(IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCTIONS) #include #ifdef _MSC_VER #pragma comment(lib, "imm32") #endif static void Platform_SetImeDataFn_DefaultImpl(ImGuiContext*, ImGuiViewport* viewport, ImGuiPlatformImeData* data) { // Notify OS Input Method Editor of text input position HWND hwnd = (HWND)viewport->PlatformHandleRaw; if (hwnd == 0) return; //::ImmAssociateContextEx(hwnd, NULL, data->WantVisible ? IACE_DEFAULT : 0); if (HIMC himc = ::ImmGetContext(hwnd)) { COMPOSITIONFORM composition_form = {}; composition_form.ptCurrentPos.x = (LONG)data->InputPos.x; composition_form.ptCurrentPos.y = (LONG)data->InputPos.y; composition_form.dwStyle = CFS_FORCE_POSITION; ::ImmSetCompositionWindow(himc, &composition_form); CANDIDATEFORM candidate_form = {}; candidate_form.dwStyle = CFS_CANDIDATEPOS; candidate_form.ptCurrentPos.x = (LONG)data->InputPos.x; candidate_form.ptCurrentPos.y = (LONG)data->InputPos.y; ::ImmSetCandidateWindow(himc, &candidate_form); ::ImmReleaseContext(hwnd, himc); } } #else static void Platform_SetImeDataFn_DefaultImpl(ImGuiContext*, ImGuiViewport*, ImGuiPlatformImeData*) {} #endif // Default IME handlers //----------------------------------------------------------------------------- // [SECTION] METRICS/DEBUGGER WINDOW //----------------------------------------------------------------------------- // - DebugRenderViewportThumbnail() [Internal] // - RenderViewportsThumbnails() [Internal] // - DebugTextEncoding() // - MetricsHelpMarker() [Internal] // - ShowFontAtlas() [Internal] // - ShowMetricsWindow() // - DebugNodeColumns() [Internal] // - DebugNodeDrawList() [Internal] // - DebugNodeDrawCmdShowMeshAndBoundingBox() [Internal] // - DebugNodeFont() [Internal] // - DebugNodeFontGlyph() [Internal] // - DebugNodeStorage() [Internal] // - DebugNodeTabBar() [Internal] // - DebugNodeViewport() [Internal] // - DebugNodeWindow() [Internal] // - DebugNodeWindowSettings() [Internal] // - DebugNodeWindowsList() [Internal] // - DebugNodeWindowsListByBeginStackParent() [Internal] //----------------------------------------------------------------------------- #ifndef IMGUI_DISABLE_DEBUG_TOOLS void ImGui::DebugRenderViewportThumbnail(ImDrawList* draw_list, ImGuiViewportP* viewport, const ImRect& bb) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; ImVec2 scale = bb.GetSize() / viewport->Size; ImVec2 off = bb.Min - viewport->Pos * scale; float alpha_mul = 1.0f; window->DrawList->AddRectFilled(bb.Min, bb.Max, GetColorU32(ImGuiCol_Border, alpha_mul * 0.40f)); for (ImGuiWindow* thumb_window : g.Windows) { if (!thumb_window->WasActive || (thumb_window->Flags & ImGuiWindowFlags_ChildWindow)) continue; ImRect thumb_r = thumb_window->Rect(); ImRect title_r = thumb_window->TitleBarRect(); thumb_r = ImRect(ImTrunc(off + thumb_r.Min * scale), ImTrunc(off + thumb_r.Max * scale)); title_r = ImRect(ImTrunc(off + title_r.Min * scale), ImTrunc(off + ImVec2(title_r.Max.x, title_r.Min.y + title_r.GetHeight() * 3.0f) * scale)); // Exaggerate title bar height thumb_r.ClipWithFull(bb); title_r.ClipWithFull(bb); const bool window_is_focused = (g.NavWindow && thumb_window->RootWindowForTitleBarHighlight == g.NavWindow->RootWindowForTitleBarHighlight); window->DrawList->AddRectFilled(thumb_r.Min, thumb_r.Max, GetColorU32(ImGuiCol_WindowBg, alpha_mul)); window->DrawList->AddRectFilled(title_r.Min, title_r.Max, GetColorU32(window_is_focused ? ImGuiCol_TitleBgActive : ImGuiCol_TitleBg, alpha_mul)); window->DrawList->AddRect(thumb_r.Min, thumb_r.Max, GetColorU32(ImGuiCol_Border, alpha_mul)); window->DrawList->AddText(g.Font, g.FontSize * 1.0f, title_r.Min, GetColorU32(ImGuiCol_Text, alpha_mul), thumb_window->Name, FindRenderedTextEnd(thumb_window->Name)); } draw_list->AddRect(bb.Min, bb.Max, GetColorU32(ImGuiCol_Border, alpha_mul)); if (viewport->ID == g.DebugMetricsConfig.HighlightViewportID) window->DrawList->AddRect(bb.Min, bb.Max, IM_COL32(255, 255, 0, 255)); } static void RenderViewportsThumbnails() { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; float SCALE = 1.0f / 8.0f; ImRect bb_full(g.Viewports[0]->Pos, g.Viewports[0]->Pos + g.Viewports[0]->Size); ImVec2 p = window->DC.CursorPos; ImVec2 off = p - bb_full.Min * SCALE; // Draw viewports for (ImGuiViewportP* viewport : g.Viewports) { ImRect viewport_draw_bb(off + (viewport->Pos) * SCALE, off + (viewport->Pos + viewport->Size) * SCALE); ImGui::DebugRenderViewportThumbnail(window->DrawList, viewport, viewport_draw_bb); } ImGui::Dummy(bb_full.GetSize() * SCALE); } // Draw an arbitrary US keyboard layout to visualize translated keys void ImGui::DebugRenderKeyboardPreview(ImDrawList* draw_list) { const float scale = ImGui::GetFontSize() / 13.0f; const ImVec2 key_size = ImVec2(35.0f, 35.0f) * scale; const float key_rounding = 3.0f * scale; const ImVec2 key_face_size = ImVec2(25.0f, 25.0f) * scale; const ImVec2 key_face_pos = ImVec2(5.0f, 3.0f) * scale; const float key_face_rounding = 2.0f * scale; const ImVec2 key_label_pos = ImVec2(7.0f, 4.0f) * scale; const ImVec2 key_step = ImVec2(key_size.x - 1.0f, key_size.y - 1.0f); const float key_row_offset = 9.0f * scale; ImVec2 board_min = GetCursorScreenPos(); ImVec2 board_max = ImVec2(board_min.x + 3 * key_step.x + 2 * key_row_offset + 10.0f, board_min.y + 3 * key_step.y + 10.0f); ImVec2 start_pos = ImVec2(board_min.x + 5.0f - key_step.x, board_min.y); struct KeyLayoutData { int Row, Col; const char* Label; ImGuiKey Key; }; const KeyLayoutData keys_to_display[] = { { 0, 0, "", ImGuiKey_Tab }, { 0, 1, "Q", ImGuiKey_Q }, { 0, 2, "W", ImGuiKey_W }, { 0, 3, "E", ImGuiKey_E }, { 0, 4, "R", ImGuiKey_R }, { 1, 0, "", ImGuiKey_CapsLock }, { 1, 1, "A", ImGuiKey_A }, { 1, 2, "S", ImGuiKey_S }, { 1, 3, "D", ImGuiKey_D }, { 1, 4, "F", ImGuiKey_F }, { 2, 0, "", ImGuiKey_LeftShift },{ 2, 1, "Z", ImGuiKey_Z }, { 2, 2, "X", ImGuiKey_X }, { 2, 3, "C", ImGuiKey_C }, { 2, 4, "V", ImGuiKey_V } }; // Elements rendered manually via ImDrawList API are not clipped automatically. // While not strictly necessary, here IsItemVisible() is used to avoid rendering these shapes when they are out of view. Dummy(board_max - board_min); if (!IsItemVisible()) return; draw_list->PushClipRect(board_min, board_max, true); for (int n = 0; n < IM_ARRAYSIZE(keys_to_display); n++) { const KeyLayoutData* key_data = &keys_to_display[n]; ImVec2 key_min = ImVec2(start_pos.x + key_data->Col * key_step.x + key_data->Row * key_row_offset, start_pos.y + key_data->Row * key_step.y); ImVec2 key_max = key_min + key_size; draw_list->AddRectFilled(key_min, key_max, IM_COL32(204, 204, 204, 255), key_rounding); draw_list->AddRect(key_min, key_max, IM_COL32(24, 24, 24, 255), key_rounding); ImVec2 face_min = ImVec2(key_min.x + key_face_pos.x, key_min.y + key_face_pos.y); ImVec2 face_max = ImVec2(face_min.x + key_face_size.x, face_min.y + key_face_size.y); draw_list->AddRect(face_min, face_max, IM_COL32(193, 193, 193, 255), key_face_rounding, ImDrawFlags_None, 2.0f); draw_list->AddRectFilled(face_min, face_max, IM_COL32(252, 252, 252, 255), key_face_rounding); ImVec2 label_min = ImVec2(key_min.x + key_label_pos.x, key_min.y + key_label_pos.y); draw_list->AddText(label_min, IM_COL32(64, 64, 64, 255), key_data->Label); if (IsKeyDown(key_data->Key)) draw_list->AddRectFilled(key_min, key_max, IM_COL32(255, 0, 0, 128), key_rounding); } draw_list->PopClipRect(); } // Helper tool to diagnose between text encoding issues and font loading issues. Pass your UTF-8 string and verify that there are correct. void ImGui::DebugTextEncoding(const char* str) { Text("Text: \"%s\"", str); if (!BeginTable("##DebugTextEncoding", 4, ImGuiTableFlags_Borders | ImGuiTableFlags_RowBg | ImGuiTableFlags_SizingFixedFit | ImGuiTableFlags_Resizable)) return; TableSetupColumn("Offset"); TableSetupColumn("UTF-8"); TableSetupColumn("Glyph"); TableSetupColumn("Codepoint"); TableHeadersRow(); for (const char* p = str; *p != 0; ) { unsigned int c; const int c_utf8_len = ImTextCharFromUtf8(&c, p, NULL); TableNextColumn(); Text("%d", (int)(p - str)); TableNextColumn(); for (int byte_index = 0; byte_index < c_utf8_len; byte_index++) { if (byte_index > 0) SameLine(); Text("0x%02X", (int)(unsigned char)p[byte_index]); } TableNextColumn(); if (GetFont()->FindGlyphNoFallback((ImWchar)c)) TextUnformatted(p, p + c_utf8_len); else TextUnformatted((c == IM_UNICODE_CODEPOINT_INVALID) ? "[invalid]" : "[missing]"); TableNextColumn(); Text("U+%04X", (int)c); p += c_utf8_len; } EndTable(); } static void DebugFlashStyleColorStop() { ImGuiContext& g = *GImGui; if (g.DebugFlashStyleColorIdx != ImGuiCol_COUNT) g.Style.Colors[g.DebugFlashStyleColorIdx] = g.DebugFlashStyleColorBackup; g.DebugFlashStyleColorIdx = ImGuiCol_COUNT; } // Flash a given style color for some + inhibit modifications of this color via PushStyleColor() calls. void ImGui::DebugFlashStyleColor(ImGuiCol idx) { ImGuiContext& g = *GImGui; DebugFlashStyleColorStop(); g.DebugFlashStyleColorTime = 0.5f; g.DebugFlashStyleColorIdx = idx; g.DebugFlashStyleColorBackup = g.Style.Colors[idx]; } void ImGui::UpdateDebugToolFlashStyleColor() { ImGuiContext& g = *GImGui; if (g.DebugFlashStyleColorTime <= 0.0f) return; ColorConvertHSVtoRGB(ImCos(g.DebugFlashStyleColorTime * 6.0f) * 0.5f + 0.5f, 0.5f, 0.5f, g.Style.Colors[g.DebugFlashStyleColorIdx].x, g.Style.Colors[g.DebugFlashStyleColorIdx].y, g.Style.Colors[g.DebugFlashStyleColorIdx].z); g.Style.Colors[g.DebugFlashStyleColorIdx].w = 1.0f; if ((g.DebugFlashStyleColorTime -= g.IO.DeltaTime) <= 0.0f) DebugFlashStyleColorStop(); } static const char* FormatTextureIDForDebugDisplay(char* buf, int buf_size, ImTextureID tex_id) { union { void* ptr; int integer; } tex_id_opaque; memcpy(&tex_id_opaque, &tex_id, ImMin(sizeof(void*), sizeof(tex_id))); if (sizeof(tex_id) >= sizeof(void*)) ImFormatString(buf, buf_size, "0x%p", tex_id_opaque.ptr); else ImFormatString(buf, buf_size, "0x%04X", tex_id_opaque.integer); return buf; } // Avoid naming collision with imgui_demo.cpp's HelpMarker() for unity builds. static void MetricsHelpMarker(const char* desc) { ImGui::TextDisabled("(?)"); if (ImGui::BeginItemTooltip()) { ImGui::PushTextWrapPos(ImGui::GetFontSize() * 35.0f); ImGui::TextUnformatted(desc); ImGui::PopTextWrapPos(); ImGui::EndTooltip(); } } // [DEBUG] List fonts in a font atlas and display its texture void ImGui::ShowFontAtlas(ImFontAtlas* atlas) { for (ImFont* font : atlas->Fonts) { PushID(font); DebugNodeFont(font); PopID(); } if (TreeNode("Font Atlas", "Font Atlas (%dx%d pixels)", atlas->TexWidth, atlas->TexHeight)) { ImGuiContext& g = *GImGui; PushStyleVar(ImGuiStyleVar_ImageBorderSize, ImMax(1.0f, g.Style.ImageBorderSize)); ImageWithBg(atlas->TexID, ImVec2((float)atlas->TexWidth, (float)atlas->TexHeight), ImVec2(0.0f, 0.0f), ImVec2(1.0f, 1.0f), ImVec4(0.0f, 0.0f, 0.0f, 1.0f)); PopStyleVar(); TreePop(); } } void ImGui::ShowMetricsWindow(bool* p_open) { ImGuiContext& g = *GImGui; ImGuiIO& io = g.IO; ImGuiMetricsConfig* cfg = &g.DebugMetricsConfig; if (cfg->ShowDebugLog) ShowDebugLogWindow(&cfg->ShowDebugLog); if (cfg->ShowIDStackTool) ShowIDStackToolWindow(&cfg->ShowIDStackTool); if (!Begin("Dear ImGui Metrics/Debugger", p_open) || GetCurrentWindow()->BeginCount > 1) { End(); return; } // [DEBUG] Clear debug breaks hooks after exactly one cycle. DebugBreakClearData(); // Basic info Text("Dear ImGui %s (%d)", IMGUI_VERSION, IMGUI_VERSION_NUM); if (g.ContextName[0] != 0) { SameLine(); Text("(Context Name: \"%s\")", g.ContextName); } Text("Application average %.3f ms/frame (%.1f FPS)", 1000.0f / io.Framerate, io.Framerate); Text("%d vertices, %d indices (%d triangles)", io.MetricsRenderVertices, io.MetricsRenderIndices, io.MetricsRenderIndices / 3); Text("%d visible windows, %d current allocations", io.MetricsRenderWindows, g.DebugAllocInfo.TotalAllocCount - g.DebugAllocInfo.TotalFreeCount); //SameLine(); if (SmallButton("GC")) { g.GcCompactAll = true; } Separator(); // Debugging enums enum { WRT_OuterRect, WRT_OuterRectClipped, WRT_InnerRect, WRT_InnerClipRect, WRT_WorkRect, WRT_Content, WRT_ContentIdeal, WRT_ContentRegionRect, WRT_Count }; // Windows Rect Type const char* wrt_rects_names[WRT_Count] = { "OuterRect", "OuterRectClipped", "InnerRect", "InnerClipRect", "WorkRect", "Content", "ContentIdeal", "ContentRegionRect" }; enum { TRT_OuterRect, TRT_InnerRect, TRT_WorkRect, TRT_HostClipRect, TRT_InnerClipRect, TRT_BackgroundClipRect, TRT_ColumnsRect, TRT_ColumnsWorkRect, TRT_ColumnsClipRect, TRT_ColumnsContentHeadersUsed, TRT_ColumnsContentHeadersIdeal, TRT_ColumnsContentFrozen, TRT_ColumnsContentUnfrozen, TRT_Count }; // Tables Rect Type const char* trt_rects_names[TRT_Count] = { "OuterRect", "InnerRect", "WorkRect", "HostClipRect", "InnerClipRect", "BackgroundClipRect", "ColumnsRect", "ColumnsWorkRect", "ColumnsClipRect", "ColumnsContentHeadersUsed", "ColumnsContentHeadersIdeal", "ColumnsContentFrozen", "ColumnsContentUnfrozen" }; if (cfg->ShowWindowsRectsType < 0) cfg->ShowWindowsRectsType = WRT_WorkRect; if (cfg->ShowTablesRectsType < 0) cfg->ShowTablesRectsType = TRT_WorkRect; struct Funcs { static ImRect GetTableRect(ImGuiTable* table, int rect_type, int n) { ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent); // Always using last submitted instance if (rect_type == TRT_OuterRect) { return table->OuterRect; } else if (rect_type == TRT_InnerRect) { return table->InnerRect; } else if (rect_type == TRT_WorkRect) { return table->WorkRect; } else if (rect_type == TRT_HostClipRect) { return table->HostClipRect; } else if (rect_type == TRT_InnerClipRect) { return table->InnerClipRect; } else if (rect_type == TRT_BackgroundClipRect) { return table->BgClipRect; } else if (rect_type == TRT_ColumnsRect) { ImGuiTableColumn* c = &table->Columns[n]; return ImRect(c->MinX, table->InnerClipRect.Min.y, c->MaxX, table->InnerClipRect.Min.y + table_instance->LastOuterHeight); } else if (rect_type == TRT_ColumnsWorkRect) { ImGuiTableColumn* c = &table->Columns[n]; return ImRect(c->WorkMinX, table->WorkRect.Min.y, c->WorkMaxX, table->WorkRect.Max.y); } else if (rect_type == TRT_ColumnsClipRect) { ImGuiTableColumn* c = &table->Columns[n]; return c->ClipRect; } else if (rect_type == TRT_ColumnsContentHeadersUsed){ ImGuiTableColumn* c = &table->Columns[n]; return ImRect(c->WorkMinX, table->InnerClipRect.Min.y, c->ContentMaxXHeadersUsed, table->InnerClipRect.Min.y + table_instance->LastTopHeadersRowHeight); } // Note: y1/y2 not always accurate else if (rect_type == TRT_ColumnsContentHeadersIdeal){ImGuiTableColumn* c = &table->Columns[n]; return ImRect(c->WorkMinX, table->InnerClipRect.Min.y, c->ContentMaxXHeadersIdeal, table->InnerClipRect.Min.y + table_instance->LastTopHeadersRowHeight); } else if (rect_type == TRT_ColumnsContentFrozen) { ImGuiTableColumn* c = &table->Columns[n]; return ImRect(c->WorkMinX, table->InnerClipRect.Min.y, c->ContentMaxXFrozen, table->InnerClipRect.Min.y + table_instance->LastFrozenHeight); } else if (rect_type == TRT_ColumnsContentUnfrozen) { ImGuiTableColumn* c = &table->Columns[n]; return ImRect(c->WorkMinX, table->InnerClipRect.Min.y + table_instance->LastFrozenHeight, c->ContentMaxXUnfrozen, table->InnerClipRect.Max.y); } IM_ASSERT(0); return ImRect(); } static ImRect GetWindowRect(ImGuiWindow* window, int rect_type) { if (rect_type == WRT_OuterRect) { return window->Rect(); } else if (rect_type == WRT_OuterRectClipped) { return window->OuterRectClipped; } else if (rect_type == WRT_InnerRect) { return window->InnerRect; } else if (rect_type == WRT_InnerClipRect) { return window->InnerClipRect; } else if (rect_type == WRT_WorkRect) { return window->WorkRect; } else if (rect_type == WRT_Content) { ImVec2 min = window->InnerRect.Min - window->Scroll + window->WindowPadding; return ImRect(min, min + window->ContentSize); } else if (rect_type == WRT_ContentIdeal) { ImVec2 min = window->InnerRect.Min - window->Scroll + window->WindowPadding; return ImRect(min, min + window->ContentSizeIdeal); } else if (rect_type == WRT_ContentRegionRect) { return window->ContentRegionRect; } IM_ASSERT(0); return ImRect(); } }; // Tools if (TreeNode("Tools")) { // Debug Break features // The Item Picker tool is super useful to visually select an item and break into the call-stack of where it was submitted. SeparatorTextEx(0, "Debug breaks", NULL, CalcTextSize("(?)").x + g.Style.SeparatorTextPadding.x); SameLine(); MetricsHelpMarker("Will call the IM_DEBUG_BREAK() macro to break in debugger.\nWarning: If you don't have a debugger attached, this will probably crash."); if (Checkbox("Show Item Picker", &g.DebugItemPickerActive) && g.DebugItemPickerActive) DebugStartItemPicker(); Checkbox("Show \"Debug Break\" buttons in other sections (io.ConfigDebugIsDebuggerPresent)", &g.IO.ConfigDebugIsDebuggerPresent); SeparatorText("Visualize"); Checkbox("Show Debug Log", &cfg->ShowDebugLog); SameLine(); MetricsHelpMarker("You can also call ImGui::ShowDebugLogWindow() from your code."); Checkbox("Show ID Stack Tool", &cfg->ShowIDStackTool); SameLine(); MetricsHelpMarker("You can also call ImGui::ShowIDStackToolWindow() from your code."); Checkbox("Show windows begin order", &cfg->ShowWindowsBeginOrder); Checkbox("Show windows rectangles", &cfg->ShowWindowsRects); SameLine(); SetNextItemWidth(GetFontSize() * 12); cfg->ShowWindowsRects |= Combo("##show_windows_rect_type", &cfg->ShowWindowsRectsType, wrt_rects_names, WRT_Count, WRT_Count); if (cfg->ShowWindowsRects && g.NavWindow != NULL) { BulletText("'%s':", g.NavWindow->Name); Indent(); for (int rect_n = 0; rect_n < WRT_Count; rect_n++) { ImRect r = Funcs::GetWindowRect(g.NavWindow, rect_n); Text("(%6.1f,%6.1f) (%6.1f,%6.1f) Size (%6.1f,%6.1f) %s", r.Min.x, r.Min.y, r.Max.x, r.Max.y, r.GetWidth(), r.GetHeight(), wrt_rects_names[rect_n]); } Unindent(); } Checkbox("Show tables rectangles", &cfg->ShowTablesRects); SameLine(); SetNextItemWidth(GetFontSize() * 12); cfg->ShowTablesRects |= Combo("##show_table_rects_type", &cfg->ShowTablesRectsType, trt_rects_names, TRT_Count, TRT_Count); if (cfg->ShowTablesRects && g.NavWindow != NULL) { for (int table_n = 0; table_n < g.Tables.GetMapSize(); table_n++) { ImGuiTable* table = g.Tables.TryGetMapData(table_n); if (table == NULL || table->LastFrameActive < g.FrameCount - 1 || (table->OuterWindow != g.NavWindow && table->InnerWindow != g.NavWindow)) continue; BulletText("Table 0x%08X (%d columns, in '%s')", table->ID, table->ColumnsCount, table->OuterWindow->Name); if (IsItemHovered()) GetForegroundDrawList()->AddRect(table->OuterRect.Min - ImVec2(1, 1), table->OuterRect.Max + ImVec2(1, 1), IM_COL32(255, 255, 0, 255), 0.0f, 0, 2.0f); Indent(); char buf[128]; for (int rect_n = 0; rect_n < TRT_Count; rect_n++) { if (rect_n >= TRT_ColumnsRect) { if (rect_n != TRT_ColumnsRect && rect_n != TRT_ColumnsClipRect) continue; for (int column_n = 0; column_n < table->ColumnsCount; column_n++) { ImRect r = Funcs::GetTableRect(table, rect_n, column_n); ImFormatString(buf, IM_ARRAYSIZE(buf), "(%6.1f,%6.1f) (%6.1f,%6.1f) Size (%6.1f,%6.1f) Col %d %s", r.Min.x, r.Min.y, r.Max.x, r.Max.y, r.GetWidth(), r.GetHeight(), column_n, trt_rects_names[rect_n]); Selectable(buf); if (IsItemHovered()) GetForegroundDrawList()->AddRect(r.Min - ImVec2(1, 1), r.Max + ImVec2(1, 1), IM_COL32(255, 255, 0, 255), 0.0f, 0, 2.0f); } } else { ImRect r = Funcs::GetTableRect(table, rect_n, -1); ImFormatString(buf, IM_ARRAYSIZE(buf), "(%6.1f,%6.1f) (%6.1f,%6.1f) Size (%6.1f,%6.1f) %s", r.Min.x, r.Min.y, r.Max.x, r.Max.y, r.GetWidth(), r.GetHeight(), trt_rects_names[rect_n]); Selectable(buf); if (IsItemHovered()) GetForegroundDrawList()->AddRect(r.Min - ImVec2(1, 1), r.Max + ImVec2(1, 1), IM_COL32(255, 255, 0, 255), 0.0f, 0, 2.0f); } } Unindent(); } } Checkbox("Show groups rectangles", &g.DebugShowGroupRects); // Storing in context as this is used by group code and prefers to be in hot-data SeparatorText("Validate"); Checkbox("Debug Begin/BeginChild return value", &io.ConfigDebugBeginReturnValueLoop); SameLine(); MetricsHelpMarker("Some calls to Begin()/BeginChild() will return false.\n\nWill cycle through window depths then repeat. Windows should be flickering while running."); Checkbox("UTF-8 Encoding viewer", &cfg->ShowTextEncodingViewer); SameLine(); MetricsHelpMarker("You can also call ImGui::DebugTextEncoding() from your code with a given string to test that your UTF-8 encoding settings are correct."); if (cfg->ShowTextEncodingViewer) { static char buf[64] = ""; SetNextItemWidth(-FLT_MIN); InputText("##DebugTextEncodingBuf", buf, IM_ARRAYSIZE(buf)); if (buf[0] != 0) DebugTextEncoding(buf); } TreePop(); } // Windows if (TreeNode("Windows", "Windows (%d)", g.Windows.Size)) { //SetNextItemOpen(true, ImGuiCond_Once); DebugNodeWindowsList(&g.Windows, "By display order"); DebugNodeWindowsList(&g.WindowsFocusOrder, "By focus order (root windows)"); if (TreeNode("By submission order (begin stack)")) { // Here we display windows in their submitted order/hierarchy, however note that the Begin stack doesn't constitute a Parent<>Child relationship! ImVector& temp_buffer = g.WindowsTempSortBuffer; temp_buffer.resize(0); for (ImGuiWindow* window : g.Windows) if (window->LastFrameActive + 1 >= g.FrameCount) temp_buffer.push_back(window); struct Func { static int IMGUI_CDECL WindowComparerByBeginOrder(const void* lhs, const void* rhs) { return ((int)(*(const ImGuiWindow* const *)lhs)->BeginOrderWithinContext - (*(const ImGuiWindow* const*)rhs)->BeginOrderWithinContext); } }; ImQsort(temp_buffer.Data, (size_t)temp_buffer.Size, sizeof(ImGuiWindow*), Func::WindowComparerByBeginOrder); DebugNodeWindowsListByBeginStackParent(temp_buffer.Data, temp_buffer.Size, NULL); TreePop(); } TreePop(); } // DrawLists int drawlist_count = 0; for (ImGuiViewportP* viewport : g.Viewports) drawlist_count += viewport->DrawDataP.CmdLists.Size; if (TreeNode("DrawLists", "DrawLists (%d)", drawlist_count)) { Checkbox("Show ImDrawCmd mesh when hovering", &cfg->ShowDrawCmdMesh); Checkbox("Show ImDrawCmd bounding boxes when hovering", &cfg->ShowDrawCmdBoundingBoxes); for (ImGuiViewportP* viewport : g.Viewports) for (ImDrawList* draw_list : viewport->DrawDataP.CmdLists) DebugNodeDrawList(NULL, viewport, draw_list, "DrawList"); TreePop(); } // Viewports if (TreeNode("Viewports", "Viewports (%d)", g.Viewports.Size)) { SetNextItemOpen(true, ImGuiCond_Once); if (TreeNode("Windows Minimap")) { RenderViewportsThumbnails(); TreePop(); } cfg->HighlightViewportID = 0; for (ImGuiViewportP* viewport : g.Viewports) DebugNodeViewport(viewport); TreePop(); } // Details for Popups if (TreeNode("Popups", "Popups (%d)", g.OpenPopupStack.Size)) { for (const ImGuiPopupData& popup_data : g.OpenPopupStack) { // As it's difficult to interact with tree nodes while popups are open, we display everything inline. ImGuiWindow* window = popup_data.Window; BulletText("PopupID: %08x, Window: '%s' (%s%s), RestoreNavWindow '%s', ParentWindow '%s'", popup_data.PopupId, window ? window->Name : "NULL", window && (window->Flags & ImGuiWindowFlags_ChildWindow) ? "Child;" : "", window && (window->Flags & ImGuiWindowFlags_ChildMenu) ? "Menu;" : "", popup_data.RestoreNavWindow ? popup_data.RestoreNavWindow->Name : "NULL", window && window->ParentWindow ? window->ParentWindow->Name : "NULL"); } TreePop(); } // Details for TabBars if (TreeNode("TabBars", "Tab Bars (%d)", g.TabBars.GetAliveCount())) { for (int n = 0; n < g.TabBars.GetMapSize(); n++) if (ImGuiTabBar* tab_bar = g.TabBars.TryGetMapData(n)) { PushID(tab_bar); DebugNodeTabBar(tab_bar, "TabBar"); PopID(); } TreePop(); } // Details for Tables if (TreeNode("Tables", "Tables (%d)", g.Tables.GetAliveCount())) { for (int n = 0; n < g.Tables.GetMapSize(); n++) if (ImGuiTable* table = g.Tables.TryGetMapData(n)) DebugNodeTable(table); TreePop(); } // Details for Fonts ImFontAtlas* atlas = g.IO.Fonts; if (TreeNode("Fonts", "Fonts (%d)", atlas->Fonts.Size)) { ShowFontAtlas(atlas); TreePop(); } // Details for InputText if (TreeNode("InputText")) { DebugNodeInputTextState(&g.InputTextState); TreePop(); } // Details for TypingSelect if (TreeNode("TypingSelect", "TypingSelect (%d)", g.TypingSelectState.SearchBuffer[0] != 0 ? 1 : 0)) { DebugNodeTypingSelectState(&g.TypingSelectState); TreePop(); } // Details for MultiSelect if (TreeNode("MultiSelect", "MultiSelect (%d)", g.MultiSelectStorage.GetAliveCount())) { ImGuiBoxSelectState* bs = &g.BoxSelectState; BulletText("BoxSelect ID=0x%08X, Starting = %d, Active %d", bs->ID, bs->IsStarting, bs->IsActive); for (int n = 0; n < g.MultiSelectStorage.GetMapSize(); n++) if (ImGuiMultiSelectState* state = g.MultiSelectStorage.TryGetMapData(n)) DebugNodeMultiSelectState(state); TreePop(); } // Details for Docking #ifdef IMGUI_HAS_DOCK if (TreeNode("Docking")) { TreePop(); } #endif // #ifdef IMGUI_HAS_DOCK // Settings if (TreeNode("Settings")) { if (SmallButton("Clear")) ClearIniSettings(); SameLine(); if (SmallButton("Save to memory")) SaveIniSettingsToMemory(); SameLine(); if (SmallButton("Save to disk")) SaveIniSettingsToDisk(g.IO.IniFilename); SameLine(); if (g.IO.IniFilename) Text("\"%s\"", g.IO.IniFilename); else TextUnformatted(""); Checkbox("io.ConfigDebugIniSettings", &io.ConfigDebugIniSettings); Text("SettingsDirtyTimer %.2f", g.SettingsDirtyTimer); if (TreeNode("SettingsHandlers", "Settings handlers: (%d)", g.SettingsHandlers.Size)) { for (ImGuiSettingsHandler& handler : g.SettingsHandlers) BulletText("\"%s\"", handler.TypeName); TreePop(); } if (TreeNode("SettingsWindows", "Settings packed data: Windows: %d bytes", g.SettingsWindows.size())) { for (ImGuiWindowSettings* settings = g.SettingsWindows.begin(); settings != NULL; settings = g.SettingsWindows.next_chunk(settings)) DebugNodeWindowSettings(settings); TreePop(); } if (TreeNode("SettingsTables", "Settings packed data: Tables: %d bytes", g.SettingsTables.size())) { for (ImGuiTableSettings* settings = g.SettingsTables.begin(); settings != NULL; settings = g.SettingsTables.next_chunk(settings)) DebugNodeTableSettings(settings); TreePop(); } #ifdef IMGUI_HAS_DOCK #endif // #ifdef IMGUI_HAS_DOCK if (TreeNode("SettingsIniData", "Settings unpacked data (.ini): %d bytes", g.SettingsIniData.size())) { InputTextMultiline("##Ini", (char*)(void*)g.SettingsIniData.c_str(), g.SettingsIniData.Buf.Size, ImVec2(-FLT_MIN, GetTextLineHeight() * 20), ImGuiInputTextFlags_ReadOnly); TreePop(); } TreePop(); } // Settings if (TreeNode("Memory allocations")) { ImGuiDebugAllocInfo* info = &g.DebugAllocInfo; Text("%d current allocations", info->TotalAllocCount - info->TotalFreeCount); if (SmallButton("GC now")) { g.GcCompactAll = true; } Text("Recent frames with allocations:"); int buf_size = IM_ARRAYSIZE(info->LastEntriesBuf); for (int n = buf_size - 1; n >= 0; n--) { ImGuiDebugAllocEntry* entry = &info->LastEntriesBuf[(info->LastEntriesIdx - n + buf_size) % buf_size]; BulletText("Frame %06d: %+3d ( %2d alloc, %2d free )", entry->FrameCount, entry->AllocCount - entry->FreeCount, entry->AllocCount, entry->FreeCount); if (n == 0) { SameLine(); Text("<- %d frames ago", g.FrameCount - entry->FrameCount); } } TreePop(); } if (TreeNode("Inputs")) { Text("KEYBOARD/GAMEPAD/MOUSE KEYS"); { // User code should never have to go through such hoops! You can generally iterate between ImGuiKey_NamedKey_BEGIN and ImGuiKey_NamedKey_END. Indent(); Text("Keys down:"); for (ImGuiKey key = ImGuiKey_NamedKey_BEGIN; key < ImGuiKey_NamedKey_END; key = (ImGuiKey)(key + 1)) { if (!IsKeyDown(key)) continue; SameLine(); Text(IsNamedKey(key) ? "\"%s\"" : "\"%s\" %d", GetKeyName(key), key); SameLine(); Text("(%.02f)", GetKeyData(key)->DownDuration); } Text("Keys pressed:"); for (ImGuiKey key = ImGuiKey_NamedKey_BEGIN; key < ImGuiKey_NamedKey_END; key = (ImGuiKey)(key + 1)) { if (!IsKeyPressed(key)) continue; SameLine(); Text(IsNamedKey(key) ? "\"%s\"" : "\"%s\" %d", GetKeyName(key), key); } Text("Keys released:"); for (ImGuiKey key = ImGuiKey_NamedKey_BEGIN; key < ImGuiKey_NamedKey_END; key = (ImGuiKey)(key + 1)) { if (!IsKeyReleased(key)) continue; SameLine(); Text(IsNamedKey(key) ? "\"%s\"" : "\"%s\" %d", GetKeyName(key), key); } Text("Keys mods: %s%s%s%s", io.KeyCtrl ? "CTRL " : "", io.KeyShift ? "SHIFT " : "", io.KeyAlt ? "ALT " : "", io.KeySuper ? "SUPER " : ""); Text("Chars queue:"); for (int i = 0; i < io.InputQueueCharacters.Size; i++) { ImWchar c = io.InputQueueCharacters[i]; SameLine(); Text("\'%c\' (0x%04X)", (c > ' ' && c <= 255) ? (char)c : '?', c); } // FIXME: We should convert 'c' to UTF-8 here but the functions are not public. DebugRenderKeyboardPreview(GetWindowDrawList()); Unindent(); } Text("MOUSE STATE"); { Indent(); if (IsMousePosValid()) Text("Mouse pos: (%g, %g)", io.MousePos.x, io.MousePos.y); else Text("Mouse pos: "); Text("Mouse delta: (%g, %g)", io.MouseDelta.x, io.MouseDelta.y); int count = IM_ARRAYSIZE(io.MouseDown); Text("Mouse down:"); for (int i = 0; i < count; i++) if (IsMouseDown(i)) { SameLine(); Text("b%d (%.02f secs)", i, io.MouseDownDuration[i]); } Text("Mouse clicked:"); for (int i = 0; i < count; i++) if (IsMouseClicked(i)) { SameLine(); Text("b%d (%d)", i, io.MouseClickedCount[i]); } Text("Mouse released:"); for (int i = 0; i < count; i++) if (IsMouseReleased(i)) { SameLine(); Text("b%d", i); } Text("Mouse wheel: %.1f", io.MouseWheel); Text("MouseStationaryTimer: %.2f", g.MouseStationaryTimer); Text("Mouse source: %s", GetMouseSourceName(io.MouseSource)); Text("Pen Pressure: %.1f", io.PenPressure); // Note: currently unused Unindent(); } Text("MOUSE WHEELING"); { Indent(); Text("WheelingWindow: '%s'", g.WheelingWindow ? g.WheelingWindow->Name : "NULL"); Text("WheelingWindowReleaseTimer: %.2f", g.WheelingWindowReleaseTimer); Text("WheelingAxisAvg[] = { %.3f, %.3f }, Main Axis: %s", g.WheelingAxisAvg.x, g.WheelingAxisAvg.y, (g.WheelingAxisAvg.x > g.WheelingAxisAvg.y) ? "X" : (g.WheelingAxisAvg.x < g.WheelingAxisAvg.y) ? "Y" : ""); Unindent(); } Text("KEY OWNERS"); { Indent(); if (BeginChild("##owners", ImVec2(-FLT_MIN, GetTextLineHeightWithSpacing() * 8), ImGuiChildFlags_FrameStyle | ImGuiChildFlags_ResizeY, ImGuiWindowFlags_NoSavedSettings)) for (ImGuiKey key = ImGuiKey_NamedKey_BEGIN; key < ImGuiKey_NamedKey_END; key = (ImGuiKey)(key + 1)) { ImGuiKeyOwnerData* owner_data = GetKeyOwnerData(&g, key); if (owner_data->OwnerCurr == ImGuiKeyOwner_NoOwner) continue; Text("%s: 0x%08X%s", GetKeyName(key), owner_data->OwnerCurr, owner_data->LockUntilRelease ? " LockUntilRelease" : owner_data->LockThisFrame ? " LockThisFrame" : ""); DebugLocateItemOnHover(owner_data->OwnerCurr); } EndChild(); Unindent(); } Text("SHORTCUT ROUTING"); SameLine(); MetricsHelpMarker("Declared shortcut routes automatically set key owner when mods matches."); { Indent(); if (BeginChild("##routes", ImVec2(-FLT_MIN, GetTextLineHeightWithSpacing() * 8), ImGuiChildFlags_FrameStyle | ImGuiChildFlags_ResizeY, ImGuiWindowFlags_NoSavedSettings)) for (ImGuiKey key = ImGuiKey_NamedKey_BEGIN; key < ImGuiKey_NamedKey_END; key = (ImGuiKey)(key + 1)) { ImGuiKeyRoutingTable* rt = &g.KeysRoutingTable; for (ImGuiKeyRoutingIndex idx = rt->Index[key - ImGuiKey_NamedKey_BEGIN]; idx != -1; ) { ImGuiKeyRoutingData* routing_data = &rt->Entries[idx]; ImGuiKeyChord key_chord = key | routing_data->Mods; Text("%s: 0x%08X (scored %d)", GetKeyChordName(key_chord), routing_data->RoutingCurr, routing_data->RoutingCurrScore); DebugLocateItemOnHover(routing_data->RoutingCurr); if (g.IO.ConfigDebugIsDebuggerPresent) { SameLine(); if (DebugBreakButton("**DebugBreak**", "in SetShortcutRouting() for this KeyChord")) g.DebugBreakInShortcutRouting = key_chord; } idx = routing_data->NextEntryIndex; } } EndChild(); Text("(ActiveIdUsing: AllKeyboardKeys: %d, NavDirMask: 0x%X)", g.ActiveIdUsingAllKeyboardKeys, g.ActiveIdUsingNavDirMask); Unindent(); } TreePop(); } if (TreeNode("Internal state")) { Text("WINDOWING"); Indent(); Text("HoveredWindow: '%s'", g.HoveredWindow ? g.HoveredWindow->Name : "NULL"); Text("HoveredWindow->Root: '%s'", g.HoveredWindow ? g.HoveredWindow->RootWindow->Name : "NULL"); Text("HoveredWindowUnderMovingWindow: '%s'", g.HoveredWindowUnderMovingWindow ? g.HoveredWindowUnderMovingWindow->Name : "NULL"); Text("MovingWindow: '%s'", g.MovingWindow ? g.MovingWindow->Name : "NULL"); Unindent(); Text("ITEMS"); Indent(); Text("ActiveId: 0x%08X/0x%08X (%.2f sec), AllowOverlap: %d, Source: %s", g.ActiveId, g.ActiveIdPreviousFrame, g.ActiveIdTimer, g.ActiveIdAllowOverlap, GetInputSourceName(g.ActiveIdSource)); DebugLocateItemOnHover(g.ActiveId); Text("ActiveIdWindow: '%s'", g.ActiveIdWindow ? g.ActiveIdWindow->Name : "NULL"); Text("ActiveIdUsing: AllKeyboardKeys: %d, NavDirMask: %X", g.ActiveIdUsingAllKeyboardKeys, g.ActiveIdUsingNavDirMask); Text("HoveredId: 0x%08X (%.2f sec), AllowOverlap: %d", g.HoveredIdPreviousFrame, g.HoveredIdTimer, g.HoveredIdAllowOverlap); // Not displaying g.HoveredId as it is update mid-frame Text("HoverItemDelayId: 0x%08X, Timer: %.2f, ClearTimer: %.2f", g.HoverItemDelayId, g.HoverItemDelayTimer, g.HoverItemDelayClearTimer); Text("DragDrop: %d, SourceId = 0x%08X, Payload \"%s\" (%d bytes)", g.DragDropActive, g.DragDropPayload.SourceId, g.DragDropPayload.DataType, g.DragDropPayload.DataSize); DebugLocateItemOnHover(g.DragDropPayload.SourceId); Unindent(); Text("NAV,FOCUS"); Indent(); Text("NavWindow: '%s'", g.NavWindow ? g.NavWindow->Name : "NULL"); Text("NavId: 0x%08X, NavLayer: %d", g.NavId, g.NavLayer); DebugLocateItemOnHover(g.NavId); Text("NavInputSource: %s", GetInputSourceName(g.NavInputSource)); Text("NavLastValidSelectionUserData = %" IM_PRId64 " (0x%" IM_PRIX64 ")", g.NavLastValidSelectionUserData, g.NavLastValidSelectionUserData); Text("NavActive: %d, NavVisible: %d", g.IO.NavActive, g.IO.NavVisible); Text("NavActivateId/DownId/PressedId: %08X/%08X/%08X", g.NavActivateId, g.NavActivateDownId, g.NavActivatePressedId); Text("NavActivateFlags: %04X", g.NavActivateFlags); Text("NavCursorVisible: %d, NavHighlightItemUnderNav: %d", g.NavCursorVisible, g.NavHighlightItemUnderNav); Text("NavFocusScopeId = 0x%08X", g.NavFocusScopeId); Text("NavFocusRoute[] = "); for (int path_n = g.NavFocusRoute.Size - 1; path_n >= 0; path_n--) { const ImGuiFocusScopeData& focus_scope = g.NavFocusRoute[path_n]; SameLine(0.0f, 0.0f); Text("0x%08X/", focus_scope.ID); SetItemTooltip("In window \"%s\"", FindWindowByID(focus_scope.WindowID)->Name); } Text("NavWindowingTarget: '%s'", g.NavWindowingTarget ? g.NavWindowingTarget->Name : "NULL"); Unindent(); TreePop(); } // Overlay: Display windows Rectangles and Begin Order if (cfg->ShowWindowsRects || cfg->ShowWindowsBeginOrder) { for (ImGuiWindow* window : g.Windows) { if (!window->WasActive) continue; ImDrawList* draw_list = GetForegroundDrawList(window); if (cfg->ShowWindowsRects) { ImRect r = Funcs::GetWindowRect(window, cfg->ShowWindowsRectsType); draw_list->AddRect(r.Min, r.Max, IM_COL32(255, 0, 128, 255)); } if (cfg->ShowWindowsBeginOrder && !(window->Flags & ImGuiWindowFlags_ChildWindow)) { char buf[32]; ImFormatString(buf, IM_ARRAYSIZE(buf), "%d", window->BeginOrderWithinContext); float font_size = GetFontSize(); draw_list->AddRectFilled(window->Pos, window->Pos + ImVec2(font_size, font_size), IM_COL32(200, 100, 100, 255)); draw_list->AddText(window->Pos, IM_COL32(255, 255, 255, 255), buf); } } } // Overlay: Display Tables Rectangles if (cfg->ShowTablesRects) { for (int table_n = 0; table_n < g.Tables.GetMapSize(); table_n++) { ImGuiTable* table = g.Tables.TryGetMapData(table_n); if (table == NULL || table->LastFrameActive < g.FrameCount - 1) continue; ImDrawList* draw_list = GetForegroundDrawList(table->OuterWindow); if (cfg->ShowTablesRectsType >= TRT_ColumnsRect) { for (int column_n = 0; column_n < table->ColumnsCount; column_n++) { ImRect r = Funcs::GetTableRect(table, cfg->ShowTablesRectsType, column_n); ImU32 col = (table->HoveredColumnBody == column_n) ? IM_COL32(255, 255, 128, 255) : IM_COL32(255, 0, 128, 255); float thickness = (table->HoveredColumnBody == column_n) ? 3.0f : 1.0f; draw_list->AddRect(r.Min, r.Max, col, 0.0f, 0, thickness); } } else { ImRect r = Funcs::GetTableRect(table, cfg->ShowTablesRectsType, -1); draw_list->AddRect(r.Min, r.Max, IM_COL32(255, 0, 128, 255)); } } } #ifdef IMGUI_HAS_DOCK // Overlay: Display Docking info if (show_docking_nodes && g.IO.KeyCtrl) { } #endif // #ifdef IMGUI_HAS_DOCK End(); } void ImGui::DebugBreakClearData() { // Those fields are scattered in their respective subsystem to stay in hot-data locations ImGuiContext& g = *GImGui; g.DebugBreakInWindow = 0; g.DebugBreakInTable = 0; g.DebugBreakInShortcutRouting = ImGuiKey_None; } void ImGui::DebugBreakButtonTooltip(bool keyboard_only, const char* description_of_location) { if (!BeginItemTooltip()) return; Text("To call IM_DEBUG_BREAK() %s:", description_of_location); Separator(); TextUnformatted(keyboard_only ? "- Press 'Pause/Break' on keyboard." : "- Press 'Pause/Break' on keyboard.\n- or Click (may alter focus/active id).\n- or navigate using keyboard and press space."); Separator(); TextUnformatted("Choose one way that doesn't interfere with what you are trying to debug!\nYou need a debugger attached or this will crash!"); EndTooltip(); } // Special button that doesn't take focus, doesn't take input owner, and can be activated without a click etc. // In order to reduce interferences with the contents we are trying to debug into. bool ImGui::DebugBreakButton(const char* label, const char* description_of_location) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; ImGuiContext& g = *GImGui; const ImGuiID id = window->GetID(label); const ImVec2 label_size = CalcTextSize(label, NULL, true); ImVec2 pos = window->DC.CursorPos + ImVec2(0.0f, window->DC.CurrLineTextBaseOffset); ImVec2 size = ImVec2(label_size.x + g.Style.FramePadding.x * 2.0f, label_size.y); const ImRect bb(pos, pos + size); ItemSize(size, 0.0f); if (!ItemAdd(bb, id)) return false; // WE DO NOT USE ButtonEx() or ButtonBehavior() in order to reduce our side-effects. bool hovered = ItemHoverable(bb, id, g.CurrentItemFlags); bool pressed = hovered && (IsKeyChordPressed(g.DebugBreakKeyChord) || IsMouseClicked(0) || g.NavActivateId == id); DebugBreakButtonTooltip(false, description_of_location); ImVec4 col4f = GetStyleColorVec4(hovered ? ImGuiCol_ButtonHovered : ImGuiCol_Button); ImVec4 hsv; ColorConvertRGBtoHSV(col4f.x, col4f.y, col4f.z, hsv.x, hsv.y, hsv.z); ColorConvertHSVtoRGB(hsv.x + 0.20f, hsv.y, hsv.z, col4f.x, col4f.y, col4f.z); RenderNavCursor(bb, id); RenderFrame(bb.Min, bb.Max, GetColorU32(col4f), true, g.Style.FrameRounding); RenderTextClipped(bb.Min, bb.Max, label, NULL, &label_size, g.Style.ButtonTextAlign, &bb); IMGUI_TEST_ENGINE_ITEM_INFO(id, label, g.LastItemData.StatusFlags); return pressed; } // [DEBUG] Display contents of Columns void ImGui::DebugNodeColumns(ImGuiOldColumns* columns) { if (!TreeNode((void*)(uintptr_t)columns->ID, "Columns Id: 0x%08X, Count: %d, Flags: 0x%04X", columns->ID, columns->Count, columns->Flags)) return; BulletText("Width: %.1f (MinX: %.1f, MaxX: %.1f)", columns->OffMaxX - columns->OffMinX, columns->OffMinX, columns->OffMaxX); for (ImGuiOldColumnData& column : columns->Columns) BulletText("Column %02d: OffsetNorm %.3f (= %.1f px)", (int)columns->Columns.index_from_ptr(&column), column.OffsetNorm, GetColumnOffsetFromNorm(columns, column.OffsetNorm)); TreePop(); } // [DEBUG] Display contents of ImDrawList void ImGui::DebugNodeDrawList(ImGuiWindow* window, ImGuiViewportP* viewport, const ImDrawList* draw_list, const char* label) { ImGuiContext& g = *GImGui; IM_UNUSED(viewport); // Used in docking branch ImGuiMetricsConfig* cfg = &g.DebugMetricsConfig; int cmd_count = draw_list->CmdBuffer.Size; if (cmd_count > 0 && draw_list->CmdBuffer.back().ElemCount == 0 && draw_list->CmdBuffer.back().UserCallback == NULL) cmd_count--; bool node_open = TreeNode(draw_list, "%s: '%s' %d vtx, %d indices, %d cmds", label, draw_list->_OwnerName ? draw_list->_OwnerName : "", draw_list->VtxBuffer.Size, draw_list->IdxBuffer.Size, cmd_count); if (draw_list == GetWindowDrawList()) { SameLine(); TextColored(ImVec4(1.0f, 0.4f, 0.4f, 1.0f), "CURRENTLY APPENDING"); // Can't display stats for active draw list! (we don't have the data double-buffered) if (node_open) TreePop(); return; } ImDrawList* fg_draw_list = GetForegroundDrawList(window); // Render additional visuals into the top-most draw list if (window && IsItemHovered() && fg_draw_list) fg_draw_list->AddRect(window->Pos, window->Pos + window->Size, IM_COL32(255, 255, 0, 255)); if (!node_open) return; if (window && !window->WasActive) TextDisabled("Warning: owning Window is inactive. This DrawList is not being rendered!"); for (const ImDrawCmd* pcmd = draw_list->CmdBuffer.Data; pcmd < draw_list->CmdBuffer.Data + cmd_count; pcmd++) { if (pcmd->UserCallback) { BulletText("Callback %p, user_data %p", pcmd->UserCallback, pcmd->UserCallbackData); continue; } char texid_desc[20]; FormatTextureIDForDebugDisplay(texid_desc, IM_ARRAYSIZE(texid_desc), pcmd->TextureId); char buf[300]; ImFormatString(buf, IM_ARRAYSIZE(buf), "DrawCmd:%5d tris, Tex %s, ClipRect (%4.0f,%4.0f)-(%4.0f,%4.0f)", pcmd->ElemCount / 3, texid_desc, pcmd->ClipRect.x, pcmd->ClipRect.y, pcmd->ClipRect.z, pcmd->ClipRect.w); bool pcmd_node_open = TreeNode((void*)(pcmd - draw_list->CmdBuffer.begin()), "%s", buf); if (IsItemHovered() && (cfg->ShowDrawCmdMesh || cfg->ShowDrawCmdBoundingBoxes) && fg_draw_list) DebugNodeDrawCmdShowMeshAndBoundingBox(fg_draw_list, draw_list, pcmd, cfg->ShowDrawCmdMesh, cfg->ShowDrawCmdBoundingBoxes); if (!pcmd_node_open) continue; // Calculate approximate coverage area (touched pixel count) // This will be in pixels squared as long there's no post-scaling happening to the renderer output. const ImDrawIdx* idx_buffer = (draw_list->IdxBuffer.Size > 0) ? draw_list->IdxBuffer.Data : NULL; const ImDrawVert* vtx_buffer = draw_list->VtxBuffer.Data + pcmd->VtxOffset; float total_area = 0.0f; for (unsigned int idx_n = pcmd->IdxOffset; idx_n < pcmd->IdxOffset + pcmd->ElemCount; ) { ImVec2 triangle[3]; for (int n = 0; n < 3; n++, idx_n++) triangle[n] = vtx_buffer[idx_buffer ? idx_buffer[idx_n] : idx_n].pos; total_area += ImTriangleArea(triangle[0], triangle[1], triangle[2]); } // Display vertex information summary. Hover to get all triangles drawn in wire-frame ImFormatString(buf, IM_ARRAYSIZE(buf), "Mesh: ElemCount: %d, VtxOffset: +%d, IdxOffset: +%d, Area: ~%0.f px", pcmd->ElemCount, pcmd->VtxOffset, pcmd->IdxOffset, total_area); Selectable(buf); if (IsItemHovered() && fg_draw_list) DebugNodeDrawCmdShowMeshAndBoundingBox(fg_draw_list, draw_list, pcmd, true, false); // Display individual triangles/vertices. Hover on to get the corresponding triangle highlighted. ImGuiListClipper clipper; clipper.Begin(pcmd->ElemCount / 3); // Manually coarse clip our print out of individual vertices to save CPU, only items that may be visible. while (clipper.Step()) for (int prim = clipper.DisplayStart, idx_i = pcmd->IdxOffset + clipper.DisplayStart * 3; prim < clipper.DisplayEnd; prim++) { char* buf_p = buf, * buf_end = buf + IM_ARRAYSIZE(buf); ImVec2 triangle[3]; for (int n = 0; n < 3; n++, idx_i++) { const ImDrawVert& v = vtx_buffer[idx_buffer ? idx_buffer[idx_i] : idx_i]; triangle[n] = v.pos; buf_p += ImFormatString(buf_p, buf_end - buf_p, "%s %04d: pos (%8.2f,%8.2f), uv (%.6f,%.6f), col %08X\n", (n == 0) ? "Vert:" : " ", idx_i, v.pos.x, v.pos.y, v.uv.x, v.uv.y, v.col); } Selectable(buf, false); if (fg_draw_list && IsItemHovered()) { ImDrawListFlags backup_flags = fg_draw_list->Flags; fg_draw_list->Flags &= ~ImDrawListFlags_AntiAliasedLines; // Disable AA on triangle outlines is more readable for very large and thin triangles. fg_draw_list->AddPolyline(triangle, 3, IM_COL32(255, 255, 0, 255), ImDrawFlags_Closed, 1.0f); fg_draw_list->Flags = backup_flags; } } TreePop(); } TreePop(); } // [DEBUG] Display mesh/aabb of a ImDrawCmd void ImGui::DebugNodeDrawCmdShowMeshAndBoundingBox(ImDrawList* out_draw_list, const ImDrawList* draw_list, const ImDrawCmd* draw_cmd, bool show_mesh, bool show_aabb) { IM_ASSERT(show_mesh || show_aabb); // Draw wire-frame version of all triangles ImRect clip_rect = draw_cmd->ClipRect; ImRect vtxs_rect(FLT_MAX, FLT_MAX, -FLT_MAX, -FLT_MAX); ImDrawListFlags backup_flags = out_draw_list->Flags; out_draw_list->Flags &= ~ImDrawListFlags_AntiAliasedLines; // Disable AA on triangle outlines is more readable for very large and thin triangles. for (unsigned int idx_n = draw_cmd->IdxOffset, idx_end = draw_cmd->IdxOffset + draw_cmd->ElemCount; idx_n < idx_end; ) { ImDrawIdx* idx_buffer = (draw_list->IdxBuffer.Size > 0) ? draw_list->IdxBuffer.Data : NULL; // We don't hold on those pointers past iterations as ->AddPolyline() may invalidate them if out_draw_list==draw_list ImDrawVert* vtx_buffer = draw_list->VtxBuffer.Data + draw_cmd->VtxOffset; ImVec2 triangle[3]; for (int n = 0; n < 3; n++, idx_n++) vtxs_rect.Add((triangle[n] = vtx_buffer[idx_buffer ? idx_buffer[idx_n] : idx_n].pos)); if (show_mesh) out_draw_list->AddPolyline(triangle, 3, IM_COL32(255, 255, 0, 255), ImDrawFlags_Closed, 1.0f); // In yellow: mesh triangles } // Draw bounding boxes if (show_aabb) { out_draw_list->AddRect(ImTrunc(clip_rect.Min), ImTrunc(clip_rect.Max), IM_COL32(255, 0, 255, 255)); // In pink: clipping rectangle submitted to GPU out_draw_list->AddRect(ImTrunc(vtxs_rect.Min), ImTrunc(vtxs_rect.Max), IM_COL32(0, 255, 255, 255)); // In cyan: bounding box of triangles } out_draw_list->Flags = backup_flags; } // [DEBUG] Display details for a single font, called by ShowStyleEditor(). void ImGui::DebugNodeFont(ImFont* font) { bool opened = TreeNode(font, "Font: \"%s\": %.2f px, %d glyphs, %d sources(s)", font->Sources ? font->Sources[0].Name : "", font->FontSize, font->Glyphs.Size, font->SourcesCount); // Display preview text if (!opened) Indent(); Indent(); PushFont(font); Text("The quick brown fox jumps over the lazy dog"); PopFont(); if (!opened) { Unindent(); Unindent(); return; } if (SmallButton("Set as default")) GetIO().FontDefault = font; // Display details SetNextItemWidth(GetFontSize() * 8); DragFloat("Font scale", &font->Scale, 0.005f, 0.3f, 2.0f, "%.1f"); SameLine(); MetricsHelpMarker( "Note that the default embedded font is NOT meant to be scaled.\n\n" "Font are currently rendered into bitmaps at a given size at the time of building the atlas. " "You may oversample them to get some flexibility with scaling. " "You can also render at multiple sizes and select which one to use at runtime.\n\n" "(Glimmer of hope: the atlas system will be rewritten in the future to make scaling more flexible.)"); Text("Ascent: %f, Descent: %f, Height: %f", font->Ascent, font->Descent, font->Ascent - font->Descent); char c_str[5]; Text("Fallback character: '%s' (U+%04X)", ImTextCharToUtf8(c_str, font->FallbackChar), font->FallbackChar); Text("Ellipsis character: '%s' (U+%04X)", ImTextCharToUtf8(c_str, font->EllipsisChar), font->EllipsisChar); const int surface_sqrt = (int)ImSqrt((float)font->MetricsTotalSurface); Text("Texture Area: about %d px ~%dx%d px", font->MetricsTotalSurface, surface_sqrt, surface_sqrt); for (int config_i = 0; config_i < font->SourcesCount; config_i++) if (font->Sources) { const ImFontConfig* src = &font->Sources[config_i]; int oversample_h, oversample_v; ImFontAtlasBuildGetOversampleFactors(src, &oversample_h, &oversample_v); BulletText("Input %d: \'%s\', Oversample: (%d=>%d,%d=>%d), PixelSnapH: %d, Offset: (%.1f,%.1f)", config_i, src->Name, src->OversampleH, oversample_h, src->OversampleV, oversample_v, src->PixelSnapH, src->GlyphOffset.x, src->GlyphOffset.y); } // Display all glyphs of the fonts in separate pages of 256 characters { if (TreeNode("Glyphs", "Glyphs (%d)", font->Glyphs.Size)) { ImDrawList* draw_list = GetWindowDrawList(); const ImU32 glyph_col = GetColorU32(ImGuiCol_Text); const float cell_size = font->FontSize * 1; const float cell_spacing = GetStyle().ItemSpacing.y; for (unsigned int base = 0; base <= IM_UNICODE_CODEPOINT_MAX; base += 256) { // Skip ahead if a large bunch of glyphs are not present in the font (test in chunks of 4k) // This is only a small optimization to reduce the number of iterations when IM_UNICODE_MAX_CODEPOINT // is large // (if ImWchar==ImWchar32 we will do at least about 272 queries here) if (!(base & 8191) && font->IsGlyphRangeUnused(base, base + 8191)) { base += 8192 - 256; continue; } int count = 0; for (unsigned int n = 0; n < 256; n++) if (font->FindGlyphNoFallback((ImWchar)(base + n))) count++; if (count <= 0) continue; if (!TreeNode((void*)(intptr_t)base, "U+%04X..U+%04X (%d %s)", base, base + 255, count, count > 1 ? "glyphs" : "glyph")) continue; // Draw a 16x16 grid of glyphs ImVec2 base_pos = GetCursorScreenPos(); for (unsigned int n = 0; n < 256; n++) { // We use ImFont::RenderChar as a shortcut because we don't have UTF-8 conversion functions // available here and thus cannot easily generate a zero-terminated UTF-8 encoded string. ImVec2 cell_p1(base_pos.x + (n % 16) * (cell_size + cell_spacing), base_pos.y + (n / 16) * (cell_size + cell_spacing)); ImVec2 cell_p2(cell_p1.x + cell_size, cell_p1.y + cell_size); const ImFontGlyph* glyph = font->FindGlyphNoFallback((ImWchar)(base + n)); draw_list->AddRect(cell_p1, cell_p2, glyph ? IM_COL32(255, 255, 255, 100) : IM_COL32(255, 255, 255, 50)); if (!glyph) continue; font->RenderChar(draw_list, cell_size, cell_p1, glyph_col, (ImWchar)(base + n)); if (IsMouseHoveringRect(cell_p1, cell_p2) && BeginTooltip()) { DebugNodeFontGlyph(font, glyph); EndTooltip(); } } Dummy(ImVec2((cell_size + cell_spacing) * 16, (cell_size + cell_spacing) * 16)); TreePop(); } TreePop(); } } TreePop(); Unindent(); } void ImGui::DebugNodeFontGlyph(ImFont*, const ImFontGlyph* glyph) { Text("Codepoint: U+%04X", glyph->Codepoint); Separator(); Text("Visible: %d", glyph->Visible); Text("AdvanceX: %.1f", glyph->AdvanceX); Text("Pos: (%.2f,%.2f)->(%.2f,%.2f)", glyph->X0, glyph->Y0, glyph->X1, glyph->Y1); Text("UV: (%.3f,%.3f)->(%.3f,%.3f)", glyph->U0, glyph->V0, glyph->U1, glyph->V1); } // [DEBUG] Display contents of ImGuiStorage void ImGui::DebugNodeStorage(ImGuiStorage* storage, const char* label) { if (!TreeNode(label, "%s: %d entries, %d bytes", label, storage->Data.Size, storage->Data.size_in_bytes())) return; for (const ImGuiStoragePair& p : storage->Data) { BulletText("Key 0x%08X Value { i: %d }", p.key, p.val_i); // Important: we currently don't store a type, real value may not be integer. DebugLocateItemOnHover(p.key); } TreePop(); } // [DEBUG] Display contents of ImGuiTabBar void ImGui::DebugNodeTabBar(ImGuiTabBar* tab_bar, const char* label) { // Standalone tab bars (not associated to docking/windows functionality) currently hold no discernible strings. char buf[256]; char* p = buf; const char* buf_end = buf + IM_ARRAYSIZE(buf); const bool is_active = (tab_bar->PrevFrameVisible >= GetFrameCount() - 2); p += ImFormatString(p, buf_end - p, "%s 0x%08X (%d tabs)%s {", label, tab_bar->ID, tab_bar->Tabs.Size, is_active ? "" : " *Inactive*"); for (int tab_n = 0; tab_n < ImMin(tab_bar->Tabs.Size, 3); tab_n++) { ImGuiTabItem* tab = &tab_bar->Tabs[tab_n]; p += ImFormatString(p, buf_end - p, "%s'%s'", tab_n > 0 ? ", " : "", TabBarGetTabName(tab_bar, tab)); } p += ImFormatString(p, buf_end - p, (tab_bar->Tabs.Size > 3) ? " ... }" : " } "); if (!is_active) { PushStyleColor(ImGuiCol_Text, GetStyleColorVec4(ImGuiCol_TextDisabled)); } bool open = TreeNode(label, "%s", buf); if (!is_active) { PopStyleColor(); } if (is_active && IsItemHovered()) { ImDrawList* draw_list = GetForegroundDrawList(); draw_list->AddRect(tab_bar->BarRect.Min, tab_bar->BarRect.Max, IM_COL32(255, 255, 0, 255)); draw_list->AddLine(ImVec2(tab_bar->ScrollingRectMinX, tab_bar->BarRect.Min.y), ImVec2(tab_bar->ScrollingRectMinX, tab_bar->BarRect.Max.y), IM_COL32(0, 255, 0, 255)); draw_list->AddLine(ImVec2(tab_bar->ScrollingRectMaxX, tab_bar->BarRect.Min.y), ImVec2(tab_bar->ScrollingRectMaxX, tab_bar->BarRect.Max.y), IM_COL32(0, 255, 0, 255)); } if (open) { for (int tab_n = 0; tab_n < tab_bar->Tabs.Size; tab_n++) { ImGuiTabItem* tab = &tab_bar->Tabs[tab_n]; PushID(tab); if (SmallButton("<")) { TabBarQueueReorder(tab_bar, tab, -1); } SameLine(0, 2); if (SmallButton(">")) { TabBarQueueReorder(tab_bar, tab, +1); } SameLine(); Text("%02d%c Tab 0x%08X '%s' Offset: %.2f, Width: %.2f/%.2f", tab_n, (tab->ID == tab_bar->SelectedTabId) ? '*' : ' ', tab->ID, TabBarGetTabName(tab_bar, tab), tab->Offset, tab->Width, tab->ContentWidth); PopID(); } TreePop(); } } void ImGui::DebugNodeViewport(ImGuiViewportP* viewport) { ImGuiContext& g = *GImGui; SetNextItemOpen(true, ImGuiCond_Once); bool open = TreeNode("viewport0", "Viewport #%d", 0); if (IsItemHovered()) g.DebugMetricsConfig.HighlightViewportID = viewport->ID; if (open) { ImGuiWindowFlags flags = viewport->Flags; BulletText("Main Pos: (%.0f,%.0f), Size: (%.0f,%.0f)\nWorkArea Inset Left: %.0f Top: %.0f, Right: %.0f, Bottom: %.0f", viewport->Pos.x, viewport->Pos.y, viewport->Size.x, viewport->Size.y, viewport->WorkInsetMin.x, viewport->WorkInsetMin.y, viewport->WorkInsetMax.x, viewport->WorkInsetMax.y); BulletText("Flags: 0x%04X =%s%s%s", viewport->Flags, (flags & ImGuiViewportFlags_IsPlatformWindow) ? " IsPlatformWindow" : "", (flags & ImGuiViewportFlags_IsPlatformMonitor) ? " IsPlatformMonitor" : "", (flags & ImGuiViewportFlags_OwnedByApp) ? " OwnedByApp" : ""); for (ImDrawList* draw_list : viewport->DrawDataP.CmdLists) DebugNodeDrawList(NULL, viewport, draw_list, "DrawList"); TreePop(); } } void ImGui::DebugNodeWindow(ImGuiWindow* window, const char* label) { if (window == NULL) { BulletText("%s: NULL", label); return; } ImGuiContext& g = *GImGui; const bool is_active = window->WasActive; ImGuiTreeNodeFlags tree_node_flags = (window == g.NavWindow) ? ImGuiTreeNodeFlags_Selected : ImGuiTreeNodeFlags_None; if (!is_active) { PushStyleColor(ImGuiCol_Text, GetStyleColorVec4(ImGuiCol_TextDisabled)); } const bool open = TreeNodeEx(label, tree_node_flags, "%s '%s'%s", label, window->Name, is_active ? "" : " *Inactive*"); if (!is_active) { PopStyleColor(); } if (IsItemHovered() && is_active) GetForegroundDrawList(window)->AddRect(window->Pos, window->Pos + window->Size, IM_COL32(255, 255, 0, 255)); if (!open) return; if (window->MemoryCompacted) TextDisabled("Note: some memory buffers have been compacted/freed."); if (g.IO.ConfigDebugIsDebuggerPresent && DebugBreakButton("**DebugBreak**", "in Begin()")) g.DebugBreakInWindow = window->ID; ImGuiWindowFlags flags = window->Flags; DebugNodeDrawList(window, window->Viewport, window->DrawList, "DrawList"); BulletText("Pos: (%.1f,%.1f), Size: (%.1f,%.1f), ContentSize (%.1f,%.1f) Ideal (%.1f,%.1f)", window->Pos.x, window->Pos.y, window->Size.x, window->Size.y, window->ContentSize.x, window->ContentSize.y, window->ContentSizeIdeal.x, window->ContentSizeIdeal.y); BulletText("Flags: 0x%08X (%s%s%s%s%s%s%s%s%s..)", flags, (flags & ImGuiWindowFlags_ChildWindow) ? "Child " : "", (flags & ImGuiWindowFlags_Tooltip) ? "Tooltip " : "", (flags & ImGuiWindowFlags_Popup) ? "Popup " : "", (flags & ImGuiWindowFlags_Modal) ? "Modal " : "", (flags & ImGuiWindowFlags_ChildMenu) ? "ChildMenu " : "", (flags & ImGuiWindowFlags_NoSavedSettings) ? "NoSavedSettings " : "", (flags & ImGuiWindowFlags_NoMouseInputs)? "NoMouseInputs":"", (flags & ImGuiWindowFlags_NoNavInputs) ? "NoNavInputs" : "", (flags & ImGuiWindowFlags_AlwaysAutoResize) ? "AlwaysAutoResize" : ""); if (flags & ImGuiWindowFlags_ChildWindow) BulletText("ChildFlags: 0x%08X (%s%s%s%s..)", window->ChildFlags, (window->ChildFlags & ImGuiChildFlags_Borders) ? "Borders " : "", (window->ChildFlags & ImGuiChildFlags_ResizeX) ? "ResizeX " : "", (window->ChildFlags & ImGuiChildFlags_ResizeY) ? "ResizeY " : "", (window->ChildFlags & ImGuiChildFlags_NavFlattened) ? "NavFlattened " : ""); BulletText("Scroll: (%.2f/%.2f,%.2f/%.2f) Scrollbar:%s%s", window->Scroll.x, window->ScrollMax.x, window->Scroll.y, window->ScrollMax.y, window->ScrollbarX ? "X" : "", window->ScrollbarY ? "Y" : ""); BulletText("Active: %d/%d, WriteAccessed: %d, BeginOrderWithinContext: %d", window->Active, window->WasActive, window->WriteAccessed, (window->Active || window->WasActive) ? window->BeginOrderWithinContext : -1); BulletText("Appearing: %d, Hidden: %d (CanSkip %d Cannot %d), SkipItems: %d", window->Appearing, window->Hidden, window->HiddenFramesCanSkipItems, window->HiddenFramesCannotSkipItems, window->SkipItems); for (int layer = 0; layer < ImGuiNavLayer_COUNT; layer++) { ImRect r = window->NavRectRel[layer]; if (r.Min.x >= r.Max.x && r.Min.y >= r.Max.y) BulletText("NavLastIds[%d]: 0x%08X", layer, window->NavLastIds[layer]); else BulletText("NavLastIds[%d]: 0x%08X at +(%.1f,%.1f)(%.1f,%.1f)", layer, window->NavLastIds[layer], r.Min.x, r.Min.y, r.Max.x, r.Max.y); DebugLocateItemOnHover(window->NavLastIds[layer]); } const ImVec2* pr = window->NavPreferredScoringPosRel; for (int layer = 0; layer < ImGuiNavLayer_COUNT; layer++) BulletText("NavPreferredScoringPosRel[%d] = {%.1f,%.1f)", layer, (pr[layer].x == FLT_MAX ? -99999.0f : pr[layer].x), (pr[layer].y == FLT_MAX ? -99999.0f : pr[layer].y)); // Display as 99999.0f so it looks neater. BulletText("NavLayersActiveMask: %X, NavLastChildNavWindow: %s", window->DC.NavLayersActiveMask, window->NavLastChildNavWindow ? window->NavLastChildNavWindow->Name : "NULL"); if (window->RootWindow != window) { DebugNodeWindow(window->RootWindow, "RootWindow"); } if (window->ParentWindow != NULL) { DebugNodeWindow(window->ParentWindow, "ParentWindow"); } if (window->ParentWindowForFocusRoute != NULL) { DebugNodeWindow(window->ParentWindowForFocusRoute, "ParentWindowForFocusRoute"); } if (window->DC.ChildWindows.Size > 0) { DebugNodeWindowsList(&window->DC.ChildWindows, "ChildWindows"); } if (window->ColumnsStorage.Size > 0 && TreeNode("Columns", "Columns sets (%d)", window->ColumnsStorage.Size)) { for (ImGuiOldColumns& columns : window->ColumnsStorage) DebugNodeColumns(&columns); TreePop(); } DebugNodeStorage(&window->StateStorage, "Storage"); TreePop(); } void ImGui::DebugNodeWindowSettings(ImGuiWindowSettings* settings) { if (settings->WantDelete) BeginDisabled(); Text("0x%08X \"%s\" Pos (%d,%d) Size (%d,%d) Collapsed=%d", settings->ID, settings->GetName(), settings->Pos.x, settings->Pos.y, settings->Size.x, settings->Size.y, settings->Collapsed); if (settings->WantDelete) EndDisabled(); } void ImGui::DebugNodeWindowsList(ImVector* windows, const char* label) { if (!TreeNode(label, "%s (%d)", label, windows->Size)) return; for (int i = windows->Size - 1; i >= 0; i--) // Iterate front to back { PushID((*windows)[i]); DebugNodeWindow((*windows)[i], "Window"); PopID(); } TreePop(); } // FIXME-OPT: This is technically suboptimal, but it is simpler this way. void ImGui::DebugNodeWindowsListByBeginStackParent(ImGuiWindow** windows, int windows_size, ImGuiWindow* parent_in_begin_stack) { for (int i = 0; i < windows_size; i++) { ImGuiWindow* window = windows[i]; if (window->ParentWindowInBeginStack != parent_in_begin_stack) continue; char buf[20]; ImFormatString(buf, IM_ARRAYSIZE(buf), "[%04d] Window", window->BeginOrderWithinContext); //BulletText("[%04d] Window '%s'", window->BeginOrderWithinContext, window->Name); DebugNodeWindow(window, buf); Indent(); DebugNodeWindowsListByBeginStackParent(windows + i + 1, windows_size - i - 1, window); Unindent(); } } //----------------------------------------------------------------------------- // [SECTION] DEBUG LOG WINDOW //----------------------------------------------------------------------------- void ImGui::DebugLog(const char* fmt, ...) { va_list args; va_start(args, fmt); DebugLogV(fmt, args); va_end(args); } void ImGui::DebugLogV(const char* fmt, va_list args) { ImGuiContext& g = *GImGui; const int old_size = g.DebugLogBuf.size(); if (g.ContextName[0] != 0) g.DebugLogBuf.appendf("[%s] [%05d] ", g.ContextName, g.FrameCount); else g.DebugLogBuf.appendf("[%05d] ", g.FrameCount); g.DebugLogBuf.appendfv(fmt, args); g.DebugLogIndex.append(g.DebugLogBuf.c_str(), old_size, g.DebugLogBuf.size()); if (g.DebugLogFlags & ImGuiDebugLogFlags_OutputToTTY) IMGUI_DEBUG_PRINTF("%s", g.DebugLogBuf.begin() + old_size); #ifdef IMGUI_ENABLE_TEST_ENGINE // IMGUI_TEST_ENGINE_LOG() adds a trailing \n automatically const int new_size = g.DebugLogBuf.size(); const bool trailing_carriage_return = (g.DebugLogBuf[new_size - 1] == '\n'); if (g.DebugLogFlags & ImGuiDebugLogFlags_OutputToTestEngine) IMGUI_TEST_ENGINE_LOG("%.*s", new_size - old_size - (trailing_carriage_return ? 1 : 0), g.DebugLogBuf.begin() + old_size); #endif } // FIXME-LAYOUT: To be done automatically via layout mode once we rework ItemSize/ItemAdd into ItemLayout. static void SameLineOrWrap(const ImVec2& size) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; ImVec2 pos(window->DC.CursorPosPrevLine.x + g.Style.ItemSpacing.x, window->DC.CursorPosPrevLine.y); if (window->WorkRect.Contains(ImRect(pos, pos + size))) ImGui::SameLine(); } static void ShowDebugLogFlag(const char* name, ImGuiDebugLogFlags flags) { ImGuiContext& g = *GImGui; ImVec2 size(ImGui::GetFrameHeight() + g.Style.ItemInnerSpacing.x + ImGui::CalcTextSize(name).x, ImGui::GetFrameHeight()); SameLineOrWrap(size); // FIXME-LAYOUT: To be done automatically once we rework ItemSize/ItemAdd into ItemLayout. bool highlight_errors = (flags == ImGuiDebugLogFlags_EventError && g.DebugLogSkippedErrors > 0); if (highlight_errors) ImGui::PushStyleColor(ImGuiCol_Text, ImLerp(g.Style.Colors[ImGuiCol_Text], ImVec4(1.0f, 0.0f, 0.0f, 1.0f), 0.30f)); if (ImGui::CheckboxFlags(name, &g.DebugLogFlags, flags) && g.IO.KeyShift && (g.DebugLogFlags & flags) != 0) { g.DebugLogAutoDisableFrames = 2; g.DebugLogAutoDisableFlags |= flags; } if (highlight_errors) { ImGui::PopStyleColor(); ImGui::SetItemTooltip("%d past errors skipped.", g.DebugLogSkippedErrors); } else { ImGui::SetItemTooltip("Hold SHIFT when clicking to enable for 2 frames only (useful for spammy log entries)"); } } void ImGui::ShowDebugLogWindow(bool* p_open) { ImGuiContext& g = *GImGui; if ((g.NextWindowData.HasFlags & ImGuiNextWindowDataFlags_HasSize) == 0) SetNextWindowSize(ImVec2(0.0f, GetFontSize() * 12.0f), ImGuiCond_FirstUseEver); if (!Begin("Dear ImGui Debug Log", p_open) || GetCurrentWindow()->BeginCount > 1) { End(); return; } ImGuiDebugLogFlags all_enable_flags = ImGuiDebugLogFlags_EventMask_ & ~ImGuiDebugLogFlags_EventInputRouting; CheckboxFlags("All", &g.DebugLogFlags, all_enable_flags); SetItemTooltip("(except InputRouting which is spammy)"); ShowDebugLogFlag("Errors", ImGuiDebugLogFlags_EventError); ShowDebugLogFlag("ActiveId", ImGuiDebugLogFlags_EventActiveId); ShowDebugLogFlag("Clipper", ImGuiDebugLogFlags_EventClipper); ShowDebugLogFlag("Focus", ImGuiDebugLogFlags_EventFocus); ShowDebugLogFlag("IO", ImGuiDebugLogFlags_EventIO); //ShowDebugLogFlag("Font", ImGuiDebugLogFlags_EventFont); ShowDebugLogFlag("Nav", ImGuiDebugLogFlags_EventNav); ShowDebugLogFlag("Popup", ImGuiDebugLogFlags_EventPopup); ShowDebugLogFlag("Selection", ImGuiDebugLogFlags_EventSelection); ShowDebugLogFlag("InputRouting", ImGuiDebugLogFlags_EventInputRouting); if (SmallButton("Clear")) { g.DebugLogBuf.clear(); g.DebugLogIndex.clear(); g.DebugLogSkippedErrors = 0; } SameLine(); if (SmallButton("Copy")) SetClipboardText(g.DebugLogBuf.c_str()); SameLine(); if (SmallButton("Configure Outputs..")) OpenPopup("Outputs"); if (BeginPopup("Outputs")) { CheckboxFlags("OutputToTTY", &g.DebugLogFlags, ImGuiDebugLogFlags_OutputToTTY); #ifndef IMGUI_ENABLE_TEST_ENGINE BeginDisabled(); #endif CheckboxFlags("OutputToTestEngine", &g.DebugLogFlags, ImGuiDebugLogFlags_OutputToTestEngine); #ifndef IMGUI_ENABLE_TEST_ENGINE EndDisabled(); #endif EndPopup(); } BeginChild("##log", ImVec2(0.0f, 0.0f), ImGuiChildFlags_Borders, ImGuiWindowFlags_AlwaysVerticalScrollbar | ImGuiWindowFlags_AlwaysHorizontalScrollbar); const ImGuiDebugLogFlags backup_log_flags = g.DebugLogFlags; g.DebugLogFlags &= ~ImGuiDebugLogFlags_EventClipper; ImGuiListClipper clipper; clipper.Begin(g.DebugLogIndex.size()); while (clipper.Step()) for (int line_no = clipper.DisplayStart; line_no < clipper.DisplayEnd; line_no++) DebugTextUnformattedWithLocateItem(g.DebugLogIndex.get_line_begin(g.DebugLogBuf.c_str(), line_no), g.DebugLogIndex.get_line_end(g.DebugLogBuf.c_str(), line_no)); g.DebugLogFlags = backup_log_flags; if (GetScrollY() >= GetScrollMaxY()) SetScrollHereY(1.0f); EndChild(); End(); } // Display line, search for 0xXXXXXXXX identifiers and call DebugLocateItemOnHover() when hovered. void ImGui::DebugTextUnformattedWithLocateItem(const char* line_begin, const char* line_end) { TextUnformatted(line_begin, line_end); if (!IsItemHovered(ImGuiHoveredFlags_AllowWhenBlockedByPopup | ImGuiHoveredFlags_AllowWhenBlockedByActiveItem)) return; ImGuiContext& g = *GImGui; ImRect text_rect = g.LastItemData.Rect; for (const char* p = line_begin; p <= line_end - 10; p++) { ImGuiID id = 0; if (p[0] != '0' || (p[1] != 'x' && p[1] != 'X') || sscanf(p + 2, "%X", &id) != 1 || ImCharIsXdigitA(p[10])) continue; ImVec2 p0 = CalcTextSize(line_begin, p); ImVec2 p1 = CalcTextSize(p, p + 10); g.LastItemData.Rect = ImRect(text_rect.Min + ImVec2(p0.x, 0.0f), text_rect.Min + ImVec2(p0.x + p1.x, p1.y)); if (IsMouseHoveringRect(g.LastItemData.Rect.Min, g.LastItemData.Rect.Max, true)) DebugLocateItemOnHover(id); p += 10; } } //----------------------------------------------------------------------------- // [SECTION] OTHER DEBUG TOOLS (ITEM PICKER, ID STACK TOOL) //----------------------------------------------------------------------------- // Draw a small cross at current CursorPos in current window's DrawList void ImGui::DebugDrawCursorPos(ImU32 col) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; ImVec2 pos = window->DC.CursorPos; window->DrawList->AddLine(ImVec2(pos.x, pos.y - 3.0f), ImVec2(pos.x, pos.y + 4.0f), col, 1.0f); window->DrawList->AddLine(ImVec2(pos.x - 3.0f, pos.y), ImVec2(pos.x + 4.0f, pos.y), col, 1.0f); } // Draw a 10px wide rectangle around CurposPos.x using Line Y1/Y2 in current window's DrawList void ImGui::DebugDrawLineExtents(ImU32 col) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; float curr_x = window->DC.CursorPos.x; float line_y1 = (window->DC.IsSameLine ? window->DC.CursorPosPrevLine.y : window->DC.CursorPos.y); float line_y2 = line_y1 + (window->DC.IsSameLine ? window->DC.PrevLineSize.y : window->DC.CurrLineSize.y); window->DrawList->AddLine(ImVec2(curr_x - 5.0f, line_y1), ImVec2(curr_x + 5.0f, line_y1), col, 1.0f); window->DrawList->AddLine(ImVec2(curr_x - 0.5f, line_y1), ImVec2(curr_x - 0.5f, line_y2), col, 1.0f); window->DrawList->AddLine(ImVec2(curr_x - 5.0f, line_y2), ImVec2(curr_x + 5.0f, line_y2), col, 1.0f); } // Draw last item rect in ForegroundDrawList (so it is always visible) void ImGui::DebugDrawItemRect(ImU32 col) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; GetForegroundDrawList(window)->AddRect(g.LastItemData.Rect.Min, g.LastItemData.Rect.Max, col); } // [DEBUG] Locate item position/rectangle given an ID. static const ImU32 DEBUG_LOCATE_ITEM_COLOR = IM_COL32(0, 255, 0, 255); // Green void ImGui::DebugLocateItem(ImGuiID target_id) { ImGuiContext& g = *GImGui; g.DebugLocateId = target_id; g.DebugLocateFrames = 2; g.DebugBreakInLocateId = false; } // FIXME: Doesn't work over through a modal window, because they clear HoveredWindow. void ImGui::DebugLocateItemOnHover(ImGuiID target_id) { if (target_id == 0 || !IsItemHovered(ImGuiHoveredFlags_AllowWhenBlockedByActiveItem | ImGuiHoveredFlags_AllowWhenBlockedByPopup)) return; ImGuiContext& g = *GImGui; DebugLocateItem(target_id); GetForegroundDrawList(g.CurrentWindow)->AddRect(g.LastItemData.Rect.Min - ImVec2(3.0f, 3.0f), g.LastItemData.Rect.Max + ImVec2(3.0f, 3.0f), DEBUG_LOCATE_ITEM_COLOR); // Can't easily use a context menu here because it will mess with focus, active id etc. if (g.IO.ConfigDebugIsDebuggerPresent && g.MouseStationaryTimer > 1.0f) { DebugBreakButtonTooltip(false, "in ItemAdd()"); if (IsKeyChordPressed(g.DebugBreakKeyChord)) g.DebugBreakInLocateId = true; } } void ImGui::DebugLocateItemResolveWithLastItem() { ImGuiContext& g = *GImGui; // [DEBUG] Debug break requested by user if (g.DebugBreakInLocateId) IM_DEBUG_BREAK(); ImGuiLastItemData item_data = g.LastItemData; g.DebugLocateId = 0; ImDrawList* draw_list = GetForegroundDrawList(g.CurrentWindow); ImRect r = item_data.Rect; r.Expand(3.0f); ImVec2 p1 = g.IO.MousePos; ImVec2 p2 = ImVec2((p1.x < r.Min.x) ? r.Min.x : (p1.x > r.Max.x) ? r.Max.x : p1.x, (p1.y < r.Min.y) ? r.Min.y : (p1.y > r.Max.y) ? r.Max.y : p1.y); draw_list->AddRect(r.Min, r.Max, DEBUG_LOCATE_ITEM_COLOR); draw_list->AddLine(p1, p2, DEBUG_LOCATE_ITEM_COLOR); } void ImGui::DebugStartItemPicker() { ImGuiContext& g = *GImGui; g.DebugItemPickerActive = true; } // [DEBUG] Item picker tool - start with DebugStartItemPicker() - useful to visually select an item and break into its call-stack. void ImGui::UpdateDebugToolItemPicker() { ImGuiContext& g = *GImGui; g.DebugItemPickerBreakId = 0; if (!g.DebugItemPickerActive) return; const ImGuiID hovered_id = g.HoveredIdPreviousFrame; SetMouseCursor(ImGuiMouseCursor_Hand); if (IsKeyPressed(ImGuiKey_Escape)) g.DebugItemPickerActive = false; const bool change_mapping = g.IO.KeyMods == (ImGuiMod_Ctrl | ImGuiMod_Shift); if (!change_mapping && IsMouseClicked(g.DebugItemPickerMouseButton) && hovered_id) { g.DebugItemPickerBreakId = hovered_id; g.DebugItemPickerActive = false; } for (int mouse_button = 0; mouse_button < 3; mouse_button++) if (change_mapping && IsMouseClicked(mouse_button)) g.DebugItemPickerMouseButton = (ImU8)mouse_button; SetNextWindowBgAlpha(0.70f); if (!BeginTooltip()) return; Text("HoveredId: 0x%08X", hovered_id); Text("Press ESC to abort picking."); const char* mouse_button_names[] = { "Left", "Right", "Middle" }; if (change_mapping) Text("Remap w/ Ctrl+Shift: click anywhere to select new mouse button."); else TextColored(GetStyleColorVec4(hovered_id ? ImGuiCol_Text : ImGuiCol_TextDisabled), "Click %s Button to break in debugger! (remap w/ Ctrl+Shift)", mouse_button_names[g.DebugItemPickerMouseButton]); EndTooltip(); } // [DEBUG] ID Stack Tool: update queries. Called by NewFrame() void ImGui::UpdateDebugToolStackQueries() { ImGuiContext& g = *GImGui; ImGuiIDStackTool* tool = &g.DebugIDStackTool; // Clear hook when id stack tool is not visible g.DebugHookIdInfo = 0; if (g.FrameCount != tool->LastActiveFrame + 1) return; // Update queries. The steps are: -1: query Stack, >= 0: query each stack item // We can only perform 1 ID Info query every frame. This is designed so the GetID() tests are cheap and constant-time const ImGuiID query_id = g.HoveredIdPreviousFrame ? g.HoveredIdPreviousFrame : g.ActiveId; if (tool->QueryId != query_id) { tool->QueryId = query_id; tool->StackLevel = -1; tool->Results.resize(0); } if (query_id == 0) return; // Advance to next stack level when we got our result, or after 2 frames (in case we never get a result) int stack_level = tool->StackLevel; if (stack_level >= 0 && stack_level < tool->Results.Size) if (tool->Results[stack_level].QuerySuccess || tool->Results[stack_level].QueryFrameCount > 2) tool->StackLevel++; // Update hook stack_level = tool->StackLevel; if (stack_level == -1) g.DebugHookIdInfo = query_id; if (stack_level >= 0 && stack_level < tool->Results.Size) { g.DebugHookIdInfo = tool->Results[stack_level].ID; tool->Results[stack_level].QueryFrameCount++; } } // [DEBUG] ID Stack tool: hooks called by GetID() family functions void ImGui::DebugHookIdInfo(ImGuiID id, ImGuiDataType data_type, const void* data_id, const void* data_id_end) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; ImGuiIDStackTool* tool = &g.DebugIDStackTool; // Step 0: stack query // This assumes that the ID was computed with the current ID stack, which tends to be the case for our widget. if (tool->StackLevel == -1) { tool->StackLevel++; tool->Results.resize(window->IDStack.Size + 1, ImGuiStackLevelInfo()); for (int n = 0; n < window->IDStack.Size + 1; n++) tool->Results[n].ID = (n < window->IDStack.Size) ? window->IDStack[n] : id; return; } // Step 1+: query for individual level IM_ASSERT(tool->StackLevel >= 0); if (tool->StackLevel != window->IDStack.Size) return; ImGuiStackLevelInfo* info = &tool->Results[tool->StackLevel]; IM_ASSERT(info->ID == id && info->QueryFrameCount > 0); switch (data_type) { case ImGuiDataType_S32: ImFormatString(info->Desc, IM_ARRAYSIZE(info->Desc), "%d", (int)(intptr_t)data_id); break; case ImGuiDataType_String: ImFormatString(info->Desc, IM_ARRAYSIZE(info->Desc), "%.*s", data_id_end ? (int)((const char*)data_id_end - (const char*)data_id) : (int)ImStrlen((const char*)data_id), (const char*)data_id); break; case ImGuiDataType_Pointer: ImFormatString(info->Desc, IM_ARRAYSIZE(info->Desc), "(void*)0x%p", data_id); break; case ImGuiDataType_ID: if (info->Desc[0] != 0) // PushOverrideID() is often used to avoid hashing twice, which would lead to 2 calls to DebugHookIdInfo(). We prioritize the first one. return; ImFormatString(info->Desc, IM_ARRAYSIZE(info->Desc), "0x%08X [override]", id); break; default: IM_ASSERT(0); } info->QuerySuccess = true; info->DataType = data_type; } static int StackToolFormatLevelInfo(ImGuiIDStackTool* tool, int n, bool format_for_ui, char* buf, size_t buf_size) { ImGuiStackLevelInfo* info = &tool->Results[n]; ImGuiWindow* window = (info->Desc[0] == 0 && n == 0) ? ImGui::FindWindowByID(info->ID) : NULL; if (window) // Source: window name (because the root ID don't call GetID() and so doesn't get hooked) return ImFormatString(buf, buf_size, format_for_ui ? "\"%s\" [window]" : "%s", window->Name); if (info->QuerySuccess) // Source: GetID() hooks (prioritize over ItemInfo() because we frequently use patterns like: PushID(str), Button("") where they both have same id) return ImFormatString(buf, buf_size, (format_for_ui && info->DataType == ImGuiDataType_String) ? "\"%s\"" : "%s", info->Desc); if (tool->StackLevel < tool->Results.Size) // Only start using fallback below when all queries are done, so during queries we don't flickering ??? markers. return (*buf = 0); #ifdef IMGUI_ENABLE_TEST_ENGINE if (const char* label = ImGuiTestEngine_FindItemDebugLabel(GImGui, info->ID)) // Source: ImGuiTestEngine's ItemInfo() return ImFormatString(buf, buf_size, format_for_ui ? "??? \"%s\"" : "%s", label); #endif return ImFormatString(buf, buf_size, "???"); } // ID Stack Tool: Display UI void ImGui::ShowIDStackToolWindow(bool* p_open) { ImGuiContext& g = *GImGui; if ((g.NextWindowData.HasFlags & ImGuiNextWindowDataFlags_HasSize) == 0) SetNextWindowSize(ImVec2(0.0f, GetFontSize() * 8.0f), ImGuiCond_FirstUseEver); if (!Begin("Dear ImGui ID Stack Tool", p_open) || GetCurrentWindow()->BeginCount > 1) { End(); return; } // Display hovered/active status ImGuiIDStackTool* tool = &g.DebugIDStackTool; // Build and display path tool->ResultPathBuf.resize(0); for (int stack_n = 0; stack_n < tool->Results.Size; stack_n++) { char level_desc[256]; StackToolFormatLevelInfo(tool, stack_n, false, level_desc, IM_ARRAYSIZE(level_desc)); tool->ResultPathBuf.append(stack_n == 0 ? "//" : "/"); for (int n = 0; level_desc[n]; n++) { if (level_desc[n] == '/') tool->ResultPathBuf.append("\\"); tool->ResultPathBuf.append(level_desc + n, level_desc + n + 1); } } Text("0x%08X", tool->QueryId); SameLine(); MetricsHelpMarker("Hover an item with the mouse to display elements of the ID Stack leading to the item's final ID.\nEach level of the stack correspond to a PushID() call.\nAll levels of the stack are hashed together to make the final ID of a widget (ID displayed at the bottom level of the stack).\nRead FAQ entry about the ID stack for details."); // CTRL+C to copy path const float time_since_copy = (float)g.Time - tool->CopyToClipboardLastTime; SameLine(); PushStyleVarY(ImGuiStyleVar_FramePadding, 0.0f); Checkbox("Ctrl+C: copy path", &tool->CopyToClipboardOnCtrlC); PopStyleVar(); SameLine(); TextColored((time_since_copy >= 0.0f && time_since_copy < 0.75f && ImFmod(time_since_copy, 0.25f) < 0.25f * 0.5f) ? ImVec4(1.f, 1.f, 0.3f, 1.f) : ImVec4(), "*COPIED*"); if (tool->CopyToClipboardOnCtrlC && Shortcut(ImGuiMod_Ctrl | ImGuiKey_C, ImGuiInputFlags_RouteGlobal | ImGuiInputFlags_RouteOverFocused)) { tool->CopyToClipboardLastTime = (float)g.Time; SetClipboardText(tool->ResultPathBuf.c_str()); } Text("- Path \"%s\"", tool->ResultPathBuf.c_str()); #ifdef IMGUI_ENABLE_TEST_ENGINE Text("- Label \"%s\"", tool->QueryId ? ImGuiTestEngine_FindItemDebugLabel(&g, tool->QueryId) : ""); #endif Separator(); // Display decorated stack tool->LastActiveFrame = g.FrameCount; if (tool->Results.Size > 0 && BeginTable("##table", 3, ImGuiTableFlags_Borders)) { const float id_width = CalcTextSize("0xDDDDDDDD").x; TableSetupColumn("Seed", ImGuiTableColumnFlags_WidthFixed, id_width); TableSetupColumn("PushID", ImGuiTableColumnFlags_WidthStretch); TableSetupColumn("Result", ImGuiTableColumnFlags_WidthFixed, id_width); TableHeadersRow(); for (int n = 0; n < tool->Results.Size; n++) { ImGuiStackLevelInfo* info = &tool->Results[n]; TableNextColumn(); Text("0x%08X", (n > 0) ? tool->Results[n - 1].ID : 0); TableNextColumn(); StackToolFormatLevelInfo(tool, n, true, g.TempBuffer.Data, g.TempBuffer.Size); TextUnformatted(g.TempBuffer.Data); TableNextColumn(); Text("0x%08X", info->ID); if (n == tool->Results.Size - 1) TableSetBgColor(ImGuiTableBgTarget_CellBg, GetColorU32(ImGuiCol_Header)); } EndTable(); } End(); } #else void ImGui::ShowMetricsWindow(bool*) {} void ImGui::ShowFontAtlas(ImFontAtlas*) {} void ImGui::DebugNodeColumns(ImGuiOldColumns*) {} void ImGui::DebugNodeDrawList(ImGuiWindow*, ImGuiViewportP*, const ImDrawList*, const char*) {} void ImGui::DebugNodeDrawCmdShowMeshAndBoundingBox(ImDrawList*, const ImDrawList*, const ImDrawCmd*, bool, bool) {} void ImGui::DebugNodeFont(ImFont*) {} void ImGui::DebugNodeStorage(ImGuiStorage*, const char*) {} void ImGui::DebugNodeTabBar(ImGuiTabBar*, const char*) {} void ImGui::DebugNodeWindow(ImGuiWindow*, const char*) {} void ImGui::DebugNodeWindowSettings(ImGuiWindowSettings*) {} void ImGui::DebugNodeWindowsList(ImVector*, const char*) {} void ImGui::DebugNodeViewport(ImGuiViewportP*) {} void ImGui::ShowDebugLogWindow(bool*) {} void ImGui::ShowIDStackToolWindow(bool*) {} void ImGui::DebugStartItemPicker() {} void ImGui::DebugHookIdInfo(ImGuiID, ImGuiDataType, const void*, const void*) {} #endif // #ifndef IMGUI_DISABLE_DEBUG_TOOLS //----------------------------------------------------------------------------- // Include imgui_user.inl at the end of imgui.cpp to access private data/functions that aren't exposed. // Prefer just including imgui_internal.h from your code rather than using this define. If a declaration is missing from imgui_internal.h add it or request it on the github. #ifdef IMGUI_INCLUDE_IMGUI_USER_INL #include "imgui_user.inl" #endif //----------------------------------------------------------------------------- #endif // #ifndef IMGUI_DISABLE ================================================ FILE: src/DesktopPlusUI/imgui/imgui.h ================================================ // dear imgui, v1.91.9b // (headers) // Help: // - See links below. // - Call and read ImGui::ShowDemoWindow() in imgui_demo.cpp. All applications in examples/ are doing that. // - Read top of imgui.cpp for more details, links and comments. // - Add '#define IMGUI_DEFINE_MATH_OPERATORS' before including this file (or in imconfig.h) to access courtesy maths operators for ImVec2 and ImVec4. // Resources: // - FAQ ........................ https://dearimgui.com/faq (in repository as docs/FAQ.md) // - Homepage ................... https://github.com/ocornut/imgui // - Releases & changelog ....... https://github.com/ocornut/imgui/releases // - Gallery .................... https://github.com/ocornut/imgui/issues?q=label%3Agallery (please post your screenshots/video there!) // - Wiki ....................... https://github.com/ocornut/imgui/wiki (lots of good stuff there) // - Getting Started https://github.com/ocornut/imgui/wiki/Getting-Started (how to integrate in an existing app by adding ~25 lines of code) // - Third-party Extensions https://github.com/ocornut/imgui/wiki/Useful-Extensions (ImPlot & many more) // - Bindings/Backends https://github.com/ocornut/imgui/wiki/Bindings (language bindings, backends for various tech/engines) // - Glossary https://github.com/ocornut/imgui/wiki/Glossary // - Debug Tools https://github.com/ocornut/imgui/wiki/Debug-Tools // - Software using Dear ImGui https://github.com/ocornut/imgui/wiki/Software-using-dear-imgui // - Issues & support ........... https://github.com/ocornut/imgui/issues // - Test Engine & Automation ... https://github.com/ocornut/imgui_test_engine (test suite, test engine to automate your apps) // For first-time users having issues compiling/linking/running/loading fonts: // please post in https://github.com/ocornut/imgui/discussions if you cannot find a solution in resources above. // Everything else should be asked in 'Issues'! We are building a database of cross-linked knowledge there. // Library Version // (Integer encoded as XYYZZ for use in #if preprocessor conditionals, e.g. '#if IMGUI_VERSION_NUM >= 12345') #define IMGUI_VERSION "1.91.9b" #define IMGUI_VERSION_NUM 19191 #define IMGUI_HAS_TABLE /* Index of this file: // [SECTION] Header mess // [SECTION] Forward declarations and basic types // [SECTION] Texture identifier (ImTextureID) // [SECTION] Dear ImGui end-user API functions // [SECTION] Flags & Enumerations // [SECTION] Tables API flags and structures (ImGuiTableFlags, ImGuiTableColumnFlags, ImGuiTableRowFlags, ImGuiTableBgTarget, ImGuiTableSortSpecs, ImGuiTableColumnSortSpecs) // [SECTION] Helpers: Debug log, Memory allocations macros, ImVector<> // [SECTION] ImGuiStyle // [SECTION] ImGuiIO // [SECTION] Misc data structures (ImGuiInputTextCallbackData, ImGuiSizeCallbackData, ImGuiPayload) // [SECTION] Helpers (ImGuiOnceUponAFrame, ImGuiTextFilter, ImGuiTextBuffer, ImGuiStorage, ImGuiListClipper, Math Operators, ImColor) // [SECTION] Multi-Select API flags and structures (ImGuiMultiSelectFlags, ImGuiMultiSelectIO, ImGuiSelectionRequest, ImGuiSelectionBasicStorage, ImGuiSelectionExternalStorage) // [SECTION] Drawing API (ImDrawCallback, ImDrawCmd, ImDrawIdx, ImDrawVert, ImDrawChannel, ImDrawListSplitter, ImDrawFlags, ImDrawListFlags, ImDrawList, ImDrawData) // [SECTION] Font API (ImFontConfig, ImFontGlyph, ImFontGlyphRangesBuilder, ImFontAtlasFlags, ImFontAtlas, ImFont) // [SECTION] Viewports (ImGuiViewportFlags, ImGuiViewport) // [SECTION] ImGuiPlatformIO + other Platform Dependent Interfaces (ImGuiPlatformImeData) // [SECTION] Obsolete functions and types */ #pragma once // Configuration file with compile-time options // (edit imconfig.h or '#define IMGUI_USER_CONFIG "myfilename.h" from your build system) #ifdef IMGUI_USER_CONFIG #include IMGUI_USER_CONFIG #endif #include "imconfig.h" #ifndef IMGUI_DISABLE //----------------------------------------------------------------------------- // [SECTION] Header mess //----------------------------------------------------------------------------- // Includes #include // FLT_MIN, FLT_MAX #include // va_list, va_start, va_end #include // ptrdiff_t, NULL #include // memset, memmove, memcpy, strlen, strchr, strcpy, strcmp // Define attributes of all API symbols declarations (e.g. for DLL under Windows) // IMGUI_API is used for core imgui functions, IMGUI_IMPL_API is used for the default backends files (imgui_impl_xxx.h) // Using dear imgui via a shared library is not recommended: we don't guarantee backward nor forward ABI compatibility + this is a call-heavy library and function call overhead adds up. #ifndef IMGUI_API #define IMGUI_API #endif #ifndef IMGUI_IMPL_API #define IMGUI_IMPL_API IMGUI_API #endif // Helper Macros #ifndef IM_ASSERT #include #define IM_ASSERT(_EXPR) assert(_EXPR) // You can override the default assert handler by editing imconfig.h #endif #define IM_ARRAYSIZE(_ARR) ((int)(sizeof(_ARR) / sizeof(*(_ARR)))) // Size of a static C-style array. Don't use on pointers! #define IM_UNUSED(_VAR) ((void)(_VAR)) // Used to silence "unused variable warnings". Often useful as asserts may be stripped out from final builds. // Check that version and structures layouts are matching between compiled imgui code and caller. Read comments above DebugCheckVersionAndDataLayout() for details. #define IMGUI_CHECKVERSION() ImGui::DebugCheckVersionAndDataLayout(IMGUI_VERSION, sizeof(ImGuiIO), sizeof(ImGuiStyle), sizeof(ImVec2), sizeof(ImVec4), sizeof(ImDrawVert), sizeof(ImDrawIdx)) // Helper Macros - IM_FMTARGS, IM_FMTLIST: Apply printf-style warnings to our formatting functions. // (MSVC provides an equivalent mechanism via SAL Annotations but it would require the macros in a different // location. e.g. #include + void myprintf(_Printf_format_string_ const char* format, ...)) #if !defined(IMGUI_USE_STB_SPRINTF) && defined(__MINGW32__) && !defined(__clang__) #define IM_FMTARGS(FMT) __attribute__((format(gnu_printf, FMT, FMT+1))) #define IM_FMTLIST(FMT) __attribute__((format(gnu_printf, FMT, 0))) #elif !defined(IMGUI_USE_STB_SPRINTF) && (defined(__clang__) || defined(__GNUC__)) #define IM_FMTARGS(FMT) __attribute__((format(printf, FMT, FMT+1))) #define IM_FMTLIST(FMT) __attribute__((format(printf, FMT, 0))) #else #define IM_FMTARGS(FMT) #define IM_FMTLIST(FMT) #endif // Disable some of MSVC most aggressive Debug runtime checks in function header/footer (used in some simple/low-level functions) #if defined(_MSC_VER) && !defined(__clang__) && !defined(__INTEL_COMPILER) && !defined(IMGUI_DEBUG_PARANOID) #define IM_MSVC_RUNTIME_CHECKS_OFF __pragma(runtime_checks("",off)) __pragma(check_stack(off)) __pragma(strict_gs_check(push,off)) #define IM_MSVC_RUNTIME_CHECKS_RESTORE __pragma(runtime_checks("",restore)) __pragma(check_stack()) __pragma(strict_gs_check(pop)) #else #define IM_MSVC_RUNTIME_CHECKS_OFF #define IM_MSVC_RUNTIME_CHECKS_RESTORE #endif // Warnings #ifdef _MSC_VER #pragma warning (push) #pragma warning (disable: 26495) // [Static Analyzer] Variable 'XXX' is uninitialized. Always initialize a member variable (type.6). #endif #if defined(__clang__) #pragma clang diagnostic push #if __has_warning("-Wunknown-warning-option") #pragma clang diagnostic ignored "-Wunknown-warning-option" // warning: unknown warning group 'xxx' #endif #pragma clang diagnostic ignored "-Wunknown-pragmas" // warning: unknown warning group 'xxx' #pragma clang diagnostic ignored "-Wold-style-cast" // warning: use of old-style cast #pragma clang diagnostic ignored "-Wfloat-equal" // warning: comparing floating point with == or != is unsafe #pragma clang diagnostic ignored "-Wzero-as-null-pointer-constant" // warning: zero as null pointer constant #pragma clang diagnostic ignored "-Wreserved-identifier" // warning: identifier '_Xxx' is reserved because it starts with '_' followed by a capital letter #pragma clang diagnostic ignored "-Wunsafe-buffer-usage" // warning: 'xxx' is an unsafe pointer used for buffer access #pragma clang diagnostic ignored "-Wnontrivial-memaccess" // warning: first argument in call to 'memset' is a pointer to non-trivially copyable type #elif defined(__GNUC__) #pragma GCC diagnostic push #pragma GCC diagnostic ignored "-Wpragmas" // warning: unknown option after '#pragma GCC diagnostic' kind #pragma GCC diagnostic ignored "-Wfloat-equal" // warning: comparing floating-point with '==' or '!=' is unsafe #pragma GCC diagnostic ignored "-Wclass-memaccess" // [__GNUC__ >= 8] warning: 'memset/memcpy' clearing/writing an object of type 'xxxx' with no trivial copy-assignment; use assignment or value-initialization instead #endif //----------------------------------------------------------------------------- // [SECTION] Forward declarations and basic types //----------------------------------------------------------------------------- // Scalar data types typedef unsigned int ImGuiID;// A unique ID used by widgets (typically the result of hashing a stack of string) typedef signed char ImS8; // 8-bit signed integer typedef unsigned char ImU8; // 8-bit unsigned integer typedef signed short ImS16; // 16-bit signed integer typedef unsigned short ImU16; // 16-bit unsigned integer typedef signed int ImS32; // 32-bit signed integer == int typedef unsigned int ImU32; // 32-bit unsigned integer (often used to store packed colors) typedef signed long long ImS64; // 64-bit signed integer typedef unsigned long long ImU64; // 64-bit unsigned integer // Forward declarations: ImDrawList, ImFontAtlas layer struct ImDrawChannel; // Temporary storage to output draw commands out of order, used by ImDrawListSplitter and ImDrawList::ChannelsSplit() struct ImDrawCmd; // A single draw command within a parent ImDrawList (generally maps to 1 GPU draw call, unless it is a callback) struct ImDrawData; // All draw command lists required to render the frame + pos/size coordinates to use for the projection matrix. struct ImDrawList; // A single draw command list (generally one per window, conceptually you may see this as a dynamic "mesh" builder) struct ImDrawListSharedData; // Data shared among multiple draw lists (typically owned by parent ImGui context, but you may create one yourself) struct ImDrawListSplitter; // Helper to split a draw list into different layers which can be drawn into out of order, then flattened back. struct ImDrawVert; // A single vertex (pos + uv + col = 20 bytes by default. Override layout with IMGUI_OVERRIDE_DRAWVERT_STRUCT_LAYOUT) struct ImFont; // Runtime data for a single font within a parent ImFontAtlas struct ImFontAtlas; // Runtime data for multiple fonts, bake multiple fonts into a single texture, TTF/OTF font loader struct ImFontBuilderIO; // Opaque interface to a font builder (stb_truetype or FreeType). struct ImFontConfig; // Configuration data when adding a font or merging fonts struct ImFontGlyph; // A single font glyph (code point + coordinates within in ImFontAtlas + offset) struct ImFontGlyphRangesBuilder; // Helper to build glyph ranges from text/string data struct ImColor; // Helper functions to create a color that can be converted to either u32 or float4 (*OBSOLETE* please avoid using) // Forward declarations: ImGui layer struct ImGuiContext; // Dear ImGui context (opaque structure, unless including imgui_internal.h) struct ImGuiIO; // Main configuration and I/O between your application and ImGui (also see: ImGuiPlatformIO) struct ImGuiInputTextCallbackData; // Shared state of InputText() when using custom ImGuiInputTextCallback (rare/advanced use) struct ImGuiKeyData; // Storage for ImGuiIO and IsKeyDown(), IsKeyPressed() etc functions. struct ImGuiListClipper; // Helper to manually clip large list of items struct ImGuiMultiSelectIO; // Structure to interact with a BeginMultiSelect()/EndMultiSelect() block struct ImGuiOnceUponAFrame; // Helper for running a block of code not more than once a frame struct ImGuiPayload; // User data payload for drag and drop operations struct ImGuiPlatformIO; // Interface between platform/renderer backends and ImGui (e.g. Clipboard, IME hooks). Extends ImGuiIO. In docking branch, this gets extended to support multi-viewports. struct ImGuiPlatformImeData; // Platform IME data for io.PlatformSetImeDataFn() function. struct ImGuiSelectionBasicStorage; // Optional helper to store multi-selection state + apply multi-selection requests. struct ImGuiSelectionExternalStorage;//Optional helper to apply multi-selection requests to existing randomly accessible storage. struct ImGuiSelectionRequest; // A selection request (stored in ImGuiMultiSelectIO) struct ImGuiSizeCallbackData; // Callback data when using SetNextWindowSizeConstraints() (rare/advanced use) struct ImGuiStorage; // Helper for key->value storage (container sorted by key) struct ImGuiStoragePair; // Helper for key->value storage (pair) struct ImGuiStyle; // Runtime data for styling/colors struct ImGuiTableSortSpecs; // Sorting specifications for a table (often handling sort specs for a single column, occasionally more) struct ImGuiTableColumnSortSpecs; // Sorting specification for one column of a table struct ImGuiTextBuffer; // Helper to hold and append into a text buffer (~string builder) struct ImGuiTextFilter; // Helper to parse and apply text filters (e.g. "aaaaa[,bbbbb][,ccccc]") struct ImGuiViewport; // A Platform Window (always only one in 'master' branch), in the future may represent Platform Monitor // Enumerations // - We don't use strongly typed enums much because they add constraints (can't extend in private code, can't store typed in bit fields, extra casting on iteration) // - Tip: Use your programming IDE navigation facilities on the names in the _central column_ below to find the actual flags/enum lists! // - In Visual Studio: CTRL+comma ("Edit.GoToAll") can follow symbols inside comments, whereas CTRL+F12 ("Edit.GoToImplementation") cannot. // - In Visual Studio w/ Visual Assist installed: ALT+G ("VAssistX.GoToImplementation") can also follow symbols inside comments. // - In VS Code, CLion, etc.: CTRL+click can follow symbols inside comments. enum ImGuiDir : int; // -> enum ImGuiDir // Enum: A cardinal direction (Left, Right, Up, Down) enum ImGuiKey : int; // -> enum ImGuiKey // Enum: A key identifier (ImGuiKey_XXX or ImGuiMod_XXX value) enum ImGuiMouseSource : int; // -> enum ImGuiMouseSource // Enum; A mouse input source identifier (Mouse, TouchScreen, Pen) enum ImGuiSortDirection : ImU8; // -> enum ImGuiSortDirection // Enum: A sorting direction (ascending or descending) typedef int ImGuiCol; // -> enum ImGuiCol_ // Enum: A color identifier for styling typedef int ImGuiCond; // -> enum ImGuiCond_ // Enum: A condition for many Set*() functions typedef int ImGuiDataType; // -> enum ImGuiDataType_ // Enum: A primary data type typedef int ImGuiMouseButton; // -> enum ImGuiMouseButton_ // Enum: A mouse button identifier (0=left, 1=right, 2=middle) typedef int ImGuiMouseCursor; // -> enum ImGuiMouseCursor_ // Enum: A mouse cursor shape typedef int ImGuiStyleVar; // -> enum ImGuiStyleVar_ // Enum: A variable identifier for styling typedef int ImGuiTableBgTarget; // -> enum ImGuiTableBgTarget_ // Enum: A color target for TableSetBgColor() // Flags (declared as int to allow using as flags without overhead, and to not pollute the top of this file) // - Tip: Use your programming IDE navigation facilities on the names in the _central column_ below to find the actual flags/enum lists! // - In Visual Studio: CTRL+comma ("Edit.GoToAll") can follow symbols inside comments, whereas CTRL+F12 ("Edit.GoToImplementation") cannot. // - In Visual Studio w/ Visual Assist installed: ALT+G ("VAssistX.GoToImplementation") can also follow symbols inside comments. // - In VS Code, CLion, etc.: CTRL+click can follow symbols inside comments. typedef int ImDrawFlags; // -> enum ImDrawFlags_ // Flags: for ImDrawList functions typedef int ImDrawListFlags; // -> enum ImDrawListFlags_ // Flags: for ImDrawList instance typedef int ImFontAtlasFlags; // -> enum ImFontAtlasFlags_ // Flags: for ImFontAtlas build typedef int ImGuiBackendFlags; // -> enum ImGuiBackendFlags_ // Flags: for io.BackendFlags typedef int ImGuiButtonFlags; // -> enum ImGuiButtonFlags_ // Flags: for InvisibleButton() typedef int ImGuiChildFlags; // -> enum ImGuiChildFlags_ // Flags: for BeginChild() typedef int ImGuiColorEditFlags; // -> enum ImGuiColorEditFlags_ // Flags: for ColorEdit4(), ColorPicker4() etc. typedef int ImGuiConfigFlags; // -> enum ImGuiConfigFlags_ // Flags: for io.ConfigFlags typedef int ImGuiComboFlags; // -> enum ImGuiComboFlags_ // Flags: for BeginCombo() typedef int ImGuiDragDropFlags; // -> enum ImGuiDragDropFlags_ // Flags: for BeginDragDropSource(), AcceptDragDropPayload() typedef int ImGuiFocusedFlags; // -> enum ImGuiFocusedFlags_ // Flags: for IsWindowFocused() typedef int ImGuiHoveredFlags; // -> enum ImGuiHoveredFlags_ // Flags: for IsItemHovered(), IsWindowHovered() etc. typedef int ImGuiInputFlags; // -> enum ImGuiInputFlags_ // Flags: for Shortcut(), SetNextItemShortcut() typedef int ImGuiInputTextFlags; // -> enum ImGuiInputTextFlags_ // Flags: for InputText(), InputTextMultiline() typedef int ImGuiItemFlags; // -> enum ImGuiItemFlags_ // Flags: for PushItemFlag(), shared by all items typedef int ImGuiKeyChord; // -> ImGuiKey | ImGuiMod_XXX // Flags: for IsKeyChordPressed(), Shortcut() etc. an ImGuiKey optionally OR-ed with one or more ImGuiMod_XXX values. typedef int ImGuiPopupFlags; // -> enum ImGuiPopupFlags_ // Flags: for OpenPopup*(), BeginPopupContext*(), IsPopupOpen() typedef int ImGuiMultiSelectFlags; // -> enum ImGuiMultiSelectFlags_// Flags: for BeginMultiSelect() typedef int ImGuiSelectableFlags; // -> enum ImGuiSelectableFlags_ // Flags: for Selectable() typedef int ImGuiSliderFlags; // -> enum ImGuiSliderFlags_ // Flags: for DragFloat(), DragInt(), SliderFloat(), SliderInt() etc. typedef int ImGuiTabBarFlags; // -> enum ImGuiTabBarFlags_ // Flags: for BeginTabBar() typedef int ImGuiTabItemFlags; // -> enum ImGuiTabItemFlags_ // Flags: for BeginTabItem() typedef int ImGuiTableFlags; // -> enum ImGuiTableFlags_ // Flags: For BeginTable() typedef int ImGuiTableColumnFlags; // -> enum ImGuiTableColumnFlags_// Flags: For TableSetupColumn() typedef int ImGuiTableRowFlags; // -> enum ImGuiTableRowFlags_ // Flags: For TableNextRow() typedef int ImGuiTreeNodeFlags; // -> enum ImGuiTreeNodeFlags_ // Flags: for TreeNode(), TreeNodeEx(), CollapsingHeader() typedef int ImGuiViewportFlags; // -> enum ImGuiViewportFlags_ // Flags: for ImGuiViewport typedef int ImGuiWindowFlags; // -> enum ImGuiWindowFlags_ // Flags: for Begin(), BeginChild() // Character types // (we generally use UTF-8 encoded string in the API. This is storage specifically for a decoded character used for keyboard input and display) typedef unsigned int ImWchar32; // A single decoded U32 character/code point. We encode them as multi bytes UTF-8 when used in strings. typedef unsigned short ImWchar16; // A single decoded U16 character/code point. We encode them as multi bytes UTF-8 when used in strings. #ifdef IMGUI_USE_WCHAR32 // ImWchar [configurable type: override in imconfig.h with '#define IMGUI_USE_WCHAR32' to support Unicode planes 1-16] typedef ImWchar32 ImWchar; #else typedef ImWchar16 ImWchar; #endif // Multi-Selection item index or identifier when using BeginMultiSelect() // - Used by SetNextItemSelectionUserData() + and inside ImGuiMultiSelectIO structure. // - Most users are likely to use this store an item INDEX but this may be used to store a POINTER/ID as well. Read comments near ImGuiMultiSelectIO for details. typedef ImS64 ImGuiSelectionUserData; // Callback and functions types typedef int (*ImGuiInputTextCallback)(ImGuiInputTextCallbackData* data); // Callback function for ImGui::InputText() typedef void (*ImGuiSizeCallback)(ImGuiSizeCallbackData* data); // Callback function for ImGui::SetNextWindowSizeConstraints() typedef void* (*ImGuiMemAllocFunc)(size_t sz, void* user_data); // Function signature for ImGui::SetAllocatorFunctions() typedef void (*ImGuiMemFreeFunc)(void* ptr, void* user_data); // Function signature for ImGui::SetAllocatorFunctions() // ImVec2: 2D vector used to store positions, sizes etc. [Compile-time configurable type] // - This is a frequently used type in the API. Consider using IM_VEC2_CLASS_EXTRA to create implicit cast from/to our preferred type. // - Add '#define IMGUI_DEFINE_MATH_OPERATORS' before including this file (or in imconfig.h) to access courtesy maths operators for ImVec2 and ImVec4. IM_MSVC_RUNTIME_CHECKS_OFF struct ImVec2 { float x, y; constexpr ImVec2() : x(0.0f), y(0.0f) { } constexpr ImVec2(float _x, float _y) : x(_x), y(_y) { } float& operator[] (size_t idx) { IM_ASSERT(idx == 0 || idx == 1); return ((float*)(void*)(char*)this)[idx]; } // We very rarely use this [] operator, so the assert overhead is fine. float operator[] (size_t idx) const { IM_ASSERT(idx == 0 || idx == 1); return ((const float*)(const void*)(const char*)this)[idx]; } #ifdef IM_VEC2_CLASS_EXTRA IM_VEC2_CLASS_EXTRA // Define additional constructors and implicit cast operators in imconfig.h to convert back and forth between your math types and ImVec2. #endif }; // ImVec4: 4D vector used to store clipping rectangles, colors etc. [Compile-time configurable type] struct ImVec4 { float x, y, z, w; constexpr ImVec4() : x(0.0f), y(0.0f), z(0.0f), w(0.0f) { } constexpr ImVec4(float _x, float _y, float _z, float _w) : x(_x), y(_y), z(_z), w(_w) { } #ifdef IM_VEC4_CLASS_EXTRA IM_VEC4_CLASS_EXTRA // Define additional constructors and implicit cast operators in imconfig.h to convert back and forth between your math types and ImVec4. #endif }; IM_MSVC_RUNTIME_CHECKS_RESTORE //----------------------------------------------------------------------------- // [SECTION] Texture identifier (ImTextureID) //----------------------------------------------------------------------------- // ImTexture: user data for renderer backend to identify a texture [Compile-time configurable type] // - To use something else than an opaque void* pointer: override with e.g. '#define ImTextureID MyTextureType*' in your imconfig.h file. // - This can be whatever to you want it to be! read the FAQ about ImTextureID for details. // - You can make this a structure with various constructors if you need. You will have to implement ==/!= operators. // - (note: before v1.91.4 (2024/10/08) the default type for ImTextureID was void*. Use intermediary intptr_t cast and read FAQ if you have casting warnings) #ifndef ImTextureID typedef ImU64 ImTextureID; // Default: store a pointer or an integer fitting in a pointer (most renderer backends are ok with that) #endif //----------------------------------------------------------------------------- // [SECTION] Dear ImGui end-user API functions // (Note that ImGui:: being a namespace, you can add extra ImGui:: functions in your own separate file. Please don't modify imgui source files!) //----------------------------------------------------------------------------- namespace ImGui { // Context creation and access // - Each context create its own ImFontAtlas by default. You may instance one yourself and pass it to CreateContext() to share a font atlas between contexts. // - DLL users: heaps and globals are not shared across DLL boundaries! You will need to call SetCurrentContext() + SetAllocatorFunctions() // for each static/DLL boundary you are calling from. Read "Context and Memory Allocators" section of imgui.cpp for details. IMGUI_API ImGuiContext* CreateContext(ImFontAtlas* shared_font_atlas = NULL); IMGUI_API void DestroyContext(ImGuiContext* ctx = NULL); // NULL = destroy current context IMGUI_API ImGuiContext* GetCurrentContext(); IMGUI_API void SetCurrentContext(ImGuiContext* ctx); // Main IMGUI_API ImGuiIO& GetIO(); // access the ImGuiIO structure (mouse/keyboard/gamepad inputs, time, various configuration options/flags) IMGUI_API ImGuiPlatformIO& GetPlatformIO(); // access the ImGuiPlatformIO structure (mostly hooks/functions to connect to platform/renderer and OS Clipboard, IME etc.) IMGUI_API ImGuiStyle& GetStyle(); // access the Style structure (colors, sizes). Always use PushStyleColor(), PushStyleVar() to modify style mid-frame! IMGUI_API void NewFrame(); // start a new Dear ImGui frame, you can submit any command from this point until Render()/EndFrame(). IMGUI_API void EndFrame(); // ends the Dear ImGui frame. automatically called by Render(). If you don't need to render data (skipping rendering) you may call EndFrame() without Render()... but you'll have wasted CPU already! If you don't need to render, better to not create any windows and not call NewFrame() at all! IMGUI_API void Render(); // ends the Dear ImGui frame, finalize the draw data. You can then get call GetDrawData(). IMGUI_API ImDrawData* GetDrawData(); // valid after Render() and until the next call to NewFrame(). this is what you have to render. // Demo, Debug, Information IMGUI_API void ShowDemoWindow(bool* p_open = NULL); // create Demo window. demonstrate most ImGui features. call this to learn about the library! try to make it always available in your application! IMGUI_API void ShowMetricsWindow(bool* p_open = NULL); // create Metrics/Debugger window. display Dear ImGui internals: windows, draw commands, various internal state, etc. IMGUI_API void ShowDebugLogWindow(bool* p_open = NULL); // create Debug Log window. display a simplified log of important dear imgui events. IMGUI_API void ShowIDStackToolWindow(bool* p_open = NULL); // create Stack Tool window. hover items with mouse to query information about the source of their unique ID. IMGUI_API void ShowAboutWindow(bool* p_open = NULL); // create About window. display Dear ImGui version, credits and build/system information. IMGUI_API void ShowStyleEditor(ImGuiStyle* ref = NULL); // add style editor block (not a window). you can pass in a reference ImGuiStyle structure to compare to, revert to and save to (else it uses the default style) IMGUI_API bool ShowStyleSelector(const char* label); // add style selector block (not a window), essentially a combo listing the default styles. IMGUI_API void ShowFontSelector(const char* label); // add font selector block (not a window), essentially a combo listing the loaded fonts. IMGUI_API void ShowUserGuide(); // add basic help/info block (not a window): how to manipulate ImGui as an end-user (mouse/keyboard controls). IMGUI_API const char* GetVersion(); // get the compiled version string e.g. "1.80 WIP" (essentially the value for IMGUI_VERSION from the compiled version of imgui.cpp) // Styles IMGUI_API void StyleColorsDark(ImGuiStyle* dst = NULL); // new, recommended style (default) IMGUI_API void StyleColorsLight(ImGuiStyle* dst = NULL); // best used with borders and a custom, thicker font IMGUI_API void StyleColorsClassic(ImGuiStyle* dst = NULL); // classic imgui style // Windows // - Begin() = push window to the stack and start appending to it. End() = pop window from the stack. // - Passing 'bool* p_open != NULL' shows a window-closing widget in the upper-right corner of the window, // which clicking will set the boolean to false when clicked. // - You may append multiple times to the same window during the same frame by calling Begin()/End() pairs multiple times. // Some information such as 'flags' or 'p_open' will only be considered by the first call to Begin(). // - Begin() return false to indicate the window is collapsed or fully clipped, so you may early out and omit submitting // anything to the window. Always call a matching End() for each Begin() call, regardless of its return value! // [Important: due to legacy reason, Begin/End and BeginChild/EndChild are inconsistent with all other functions // such as BeginMenu/EndMenu, BeginPopup/EndPopup, etc. where the EndXXX call should only be called if the corresponding // BeginXXX function returned true. Begin and BeginChild are the only odd ones out. Will be fixed in a future update.] // - Note that the bottom of window stack always contains a window called "Debug". IMGUI_API bool Begin(const char* name, bool* p_open = NULL, ImGuiWindowFlags flags = 0); IMGUI_API void End(); // Child Windows // - Use child windows to begin into a self-contained independent scrolling/clipping regions within a host window. Child windows can embed their own child. // - Before 1.90 (November 2023), the "ImGuiChildFlags child_flags = 0" parameter was "bool border = false". // This API is backward compatible with old code, as we guarantee that ImGuiChildFlags_Borders == true. // Consider updating your old code: // BeginChild("Name", size, false) -> Begin("Name", size, 0); or Begin("Name", size, ImGuiChildFlags_None); // BeginChild("Name", size, true) -> Begin("Name", size, ImGuiChildFlags_Borders); // - Manual sizing (each axis can use a different setting e.g. ImVec2(0.0f, 400.0f)): // == 0.0f: use remaining parent window size for this axis. // > 0.0f: use specified size for this axis. // < 0.0f: right/bottom-align to specified distance from available content boundaries. // - Specifying ImGuiChildFlags_AutoResizeX or ImGuiChildFlags_AutoResizeY makes the sizing automatic based on child contents. // Combining both ImGuiChildFlags_AutoResizeX _and_ ImGuiChildFlags_AutoResizeY defeats purpose of a scrolling region and is NOT recommended. // - BeginChild() returns false to indicate the window is collapsed or fully clipped, so you may early out and omit submitting // anything to the window. Always call a matching EndChild() for each BeginChild() call, regardless of its return value. // [Important: due to legacy reason, Begin/End and BeginChild/EndChild are inconsistent with all other functions // such as BeginMenu/EndMenu, BeginPopup/EndPopup, etc. where the EndXXX call should only be called if the corresponding // BeginXXX function returned true. Begin and BeginChild are the only odd ones out. Will be fixed in a future update.] IMGUI_API bool BeginChild(const char* str_id, const ImVec2& size = ImVec2(0, 0), ImGuiChildFlags child_flags = 0, ImGuiWindowFlags window_flags = 0); IMGUI_API bool BeginChild(ImGuiID id, const ImVec2& size = ImVec2(0, 0), ImGuiChildFlags child_flags = 0, ImGuiWindowFlags window_flags = 0); IMGUI_API void EndChild(); // Windows Utilities // - 'current window' = the window we are appending into while inside a Begin()/End() block. 'next window' = next window we will Begin() into. IMGUI_API bool IsWindowAppearing(); IMGUI_API bool IsWindowCollapsed(); IMGUI_API bool IsWindowFocused(ImGuiFocusedFlags flags=0); // is current window focused? or its root/child, depending on flags. see flags for options. IMGUI_API bool IsWindowHovered(ImGuiHoveredFlags flags=0); // is current window hovered and hoverable (e.g. not blocked by a popup/modal)? See ImGuiHoveredFlags_ for options. IMPORTANT: If you are trying to check whether your mouse should be dispatched to Dear ImGui or to your underlying app, you should not use this function! Use the 'io.WantCaptureMouse' boolean for that! Refer to FAQ entry "How can I tell whether to dispatch mouse/keyboard to Dear ImGui or my application?" for details. IMGUI_API ImDrawList* GetWindowDrawList(); // get draw list associated to the current window, to append your own drawing primitives IMGUI_API ImVec2 GetWindowPos(); // get current window position in screen space (IT IS UNLIKELY YOU EVER NEED TO USE THIS. Consider always using GetCursorScreenPos() and GetContentRegionAvail() instead) IMGUI_API ImVec2 GetWindowSize(); // get current window size (IT IS UNLIKELY YOU EVER NEED TO USE THIS. Consider always using GetCursorScreenPos() and GetContentRegionAvail() instead) IMGUI_API float GetWindowWidth(); // get current window width (IT IS UNLIKELY YOU EVER NEED TO USE THIS). Shortcut for GetWindowSize().x. IMGUI_API float GetWindowHeight(); // get current window height (IT IS UNLIKELY YOU EVER NEED TO USE THIS). Shortcut for GetWindowSize().y. // Window manipulation // - Prefer using SetNextXXX functions (before Begin) rather that SetXXX functions (after Begin). IMGUI_API void SetNextWindowPos(const ImVec2& pos, ImGuiCond cond = 0, const ImVec2& pivot = ImVec2(0, 0)); // set next window position. call before Begin(). use pivot=(0.5f,0.5f) to center on given point, etc. IMGUI_API void SetNextWindowSize(const ImVec2& size, ImGuiCond cond = 0); // set next window size. set axis to 0.0f to force an auto-fit on this axis. call before Begin() IMGUI_API void SetNextWindowSizeConstraints(const ImVec2& size_min, const ImVec2& size_max, ImGuiSizeCallback custom_callback = NULL, void* custom_callback_data = NULL); // set next window size limits. use 0.0f or FLT_MAX if you don't want limits. Use -1 for both min and max of same axis to preserve current size (which itself is a constraint). Use callback to apply non-trivial programmatic constraints. IMGUI_API void SetNextWindowContentSize(const ImVec2& size); // set next window content size (~ scrollable client area, which enforce the range of scrollbars). Not including window decorations (title bar, menu bar, etc.) nor WindowPadding. set an axis to 0.0f to leave it automatic. call before Begin() IMGUI_API void SetNextWindowCollapsed(bool collapsed, ImGuiCond cond = 0); // set next window collapsed state. call before Begin() IMGUI_API void SetNextWindowFocus(); // set next window to be focused / top-most. call before Begin() IMGUI_API void SetNextWindowScroll(const ImVec2& scroll); // set next window scrolling value (use < 0.0f to not affect a given axis). IMGUI_API void SetNextWindowBgAlpha(float alpha); // set next window background color alpha. helper to easily override the Alpha component of ImGuiCol_WindowBg/ChildBg/PopupBg. you may also use ImGuiWindowFlags_NoBackground. IMGUI_API void SetWindowPos(const ImVec2& pos, ImGuiCond cond = 0); // (not recommended) set current window position - call within Begin()/End(). prefer using SetNextWindowPos(), as this may incur tearing and side-effects. IMGUI_API void SetWindowSize(const ImVec2& size, ImGuiCond cond = 0); // (not recommended) set current window size - call within Begin()/End(). set to ImVec2(0, 0) to force an auto-fit. prefer using SetNextWindowSize(), as this may incur tearing and minor side-effects. IMGUI_API void SetWindowCollapsed(bool collapsed, ImGuiCond cond = 0); // (not recommended) set current window collapsed state. prefer using SetNextWindowCollapsed(). IMGUI_API void SetWindowFocus(); // (not recommended) set current window to be focused / top-most. prefer using SetNextWindowFocus(). IMGUI_API void SetWindowFontScale(float scale); // [OBSOLETE] set font scale. Adjust IO.FontGlobalScale if you want to scale all windows. This is an old API! For correct scaling, prefer to reload font + rebuild ImFontAtlas + call style.ScaleAllSizes(). IMGUI_API void SetWindowPos(const char* name, const ImVec2& pos, ImGuiCond cond = 0); // set named window position. IMGUI_API void SetWindowSize(const char* name, const ImVec2& size, ImGuiCond cond = 0); // set named window size. set axis to 0.0f to force an auto-fit on this axis. IMGUI_API void SetWindowCollapsed(const char* name, bool collapsed, ImGuiCond cond = 0); // set named window collapsed state IMGUI_API void SetWindowFocus(const char* name); // set named window to be focused / top-most. use NULL to remove focus. // Windows Scrolling // - Any change of Scroll will be applied at the beginning of next frame in the first call to Begin(). // - You may instead use SetNextWindowScroll() prior to calling Begin() to avoid this delay, as an alternative to using SetScrollX()/SetScrollY(). IMGUI_API float GetScrollX(); // get scrolling amount [0 .. GetScrollMaxX()] IMGUI_API float GetScrollY(); // get scrolling amount [0 .. GetScrollMaxY()] IMGUI_API void SetScrollX(float scroll_x); // set scrolling amount [0 .. GetScrollMaxX()] IMGUI_API void SetScrollY(float scroll_y); // set scrolling amount [0 .. GetScrollMaxY()] IMGUI_API float GetScrollMaxX(); // get maximum scrolling amount ~~ ContentSize.x - WindowSize.x - DecorationsSize.x IMGUI_API float GetScrollMaxY(); // get maximum scrolling amount ~~ ContentSize.y - WindowSize.y - DecorationsSize.y IMGUI_API void SetScrollHereX(float center_x_ratio = 0.5f); // adjust scrolling amount to make current cursor position visible. center_x_ratio=0.0: left, 0.5: center, 1.0: right. When using to make a "default/current item" visible, consider using SetItemDefaultFocus() instead. IMGUI_API void SetScrollHereY(float center_y_ratio = 0.5f); // adjust scrolling amount to make current cursor position visible. center_y_ratio=0.0: top, 0.5: center, 1.0: bottom. When using to make a "default/current item" visible, consider using SetItemDefaultFocus() instead. IMGUI_API void SetScrollFromPosX(float local_x, float center_x_ratio = 0.5f); // adjust scrolling amount to make given position visible. Generally GetCursorStartPos() + offset to compute a valid position. IMGUI_API void SetScrollFromPosY(float local_y, float center_y_ratio = 0.5f); // adjust scrolling amount to make given position visible. Generally GetCursorStartPos() + offset to compute a valid position. // Parameters stacks (shared) IMGUI_API void PushFont(ImFont* font); // use NULL as a shortcut to push default font IMGUI_API void PopFont(); IMGUI_API void PushStyleColor(ImGuiCol idx, ImU32 col); // modify a style color. always use this if you modify the style after NewFrame(). IMGUI_API void PushStyleColor(ImGuiCol idx, const ImVec4& col); IMGUI_API void PopStyleColor(int count = 1); IMGUI_API void PushStyleVar(ImGuiStyleVar idx, float val); // modify a style float variable. always use this if you modify the style after NewFrame()! IMGUI_API void PushStyleVar(ImGuiStyleVar idx, const ImVec2& val); // modify a style ImVec2 variable. " IMGUI_API void PushStyleVarX(ImGuiStyleVar idx, float val_x); // modify X component of a style ImVec2 variable. " IMGUI_API void PushStyleVarY(ImGuiStyleVar idx, float val_y); // modify Y component of a style ImVec2 variable. " IMGUI_API void PopStyleVar(int count = 1); IMGUI_API void PushItemFlag(ImGuiItemFlags option, bool enabled); // modify specified shared item flag, e.g. PushItemFlag(ImGuiItemFlags_NoTabStop, true) IMGUI_API void PopItemFlag(); // Parameters stacks (current window) IMGUI_API void PushItemWidth(float item_width); // push width of items for common large "item+label" widgets. >0.0f: width in pixels, <0.0f align xx pixels to the right of window (so -FLT_MIN always align width to the right side). IMGUI_API void PopItemWidth(); IMGUI_API void SetNextItemWidth(float item_width); // set width of the _next_ common large "item+label" widget. >0.0f: width in pixels, <0.0f align xx pixels to the right of window (so -FLT_MIN always align width to the right side) IMGUI_API float CalcItemWidth(); // width of item given pushed settings and current cursor position. NOT necessarily the width of last item unlike most 'Item' functions. IMGUI_API void PushTextWrapPos(float wrap_local_pos_x = 0.0f); // push word-wrapping position for Text*() commands. < 0.0f: no wrapping; 0.0f: wrap to end of window (or column); > 0.0f: wrap at 'wrap_pos_x' position in window local space IMGUI_API void PopTextWrapPos(); // Style read access // - Use the ShowStyleEditor() function to interactively see/edit the colors. IMGUI_API ImFont* GetFont(); // get current font IMGUI_API float GetFontSize(); // get current font size (= height in pixels) of current font with current scale applied IMGUI_API ImVec2 GetFontTexUvWhitePixel(); // get UV coordinate for a white pixel, useful to draw custom shapes via the ImDrawList API IMGUI_API ImU32 GetColorU32(ImGuiCol idx, float alpha_mul = 1.0f); // retrieve given style color with style alpha applied and optional extra alpha multiplier, packed as a 32-bit value suitable for ImDrawList IMGUI_API ImU32 GetColorU32(const ImVec4& col); // retrieve given color with style alpha applied, packed as a 32-bit value suitable for ImDrawList IMGUI_API ImU32 GetColorU32(ImU32 col, float alpha_mul = 1.0f); // retrieve given color with style alpha applied, packed as a 32-bit value suitable for ImDrawList IMGUI_API const ImVec4& GetStyleColorVec4(ImGuiCol idx); // retrieve style color as stored in ImGuiStyle structure. use to feed back into PushStyleColor(), otherwise use GetColorU32() to get style color with style alpha baked in. // Layout cursor positioning // - By "cursor" we mean the current output position. // - The typical widget behavior is to output themselves at the current cursor position, then move the cursor one line down. // - You can call SameLine() between widgets to undo the last carriage return and output at the right of the preceding widget. // - YOU CAN DO 99% OF WHAT YOU NEED WITH ONLY GetCursorScreenPos() and GetContentRegionAvail(). // - Attention! We currently have inconsistencies between window-local and absolute positions we will aim to fix with future API: // - Absolute coordinate: GetCursorScreenPos(), SetCursorScreenPos(), all ImDrawList:: functions. -> this is the preferred way forward. // - Window-local coordinates: SameLine(offset), GetCursorPos(), SetCursorPos(), GetCursorStartPos(), PushTextWrapPos() // - Window-local coordinates: GetContentRegionMax(), GetWindowContentRegionMin(), GetWindowContentRegionMax() --> all obsoleted. YOU DON'T NEED THEM. // - GetCursorScreenPos() = GetCursorPos() + GetWindowPos(). GetWindowPos() is almost only ever useful to convert from window-local to absolute coordinates. Try not to use it. IMGUI_API ImVec2 GetCursorScreenPos(); // cursor position, absolute coordinates. THIS IS YOUR BEST FRIEND (prefer using this rather than GetCursorPos(), also more useful to work with ImDrawList API). IMGUI_API void SetCursorScreenPos(const ImVec2& pos); // cursor position, absolute coordinates. THIS IS YOUR BEST FRIEND. IMGUI_API ImVec2 GetContentRegionAvail(); // available space from current position. THIS IS YOUR BEST FRIEND. IMGUI_API ImVec2 GetCursorPos(); // [window-local] cursor position in window-local coordinates. This is not your best friend. IMGUI_API float GetCursorPosX(); // [window-local] " IMGUI_API float GetCursorPosY(); // [window-local] " IMGUI_API void SetCursorPos(const ImVec2& local_pos); // [window-local] " IMGUI_API void SetCursorPosX(float local_x); // [window-local] " IMGUI_API void SetCursorPosY(float local_y); // [window-local] " IMGUI_API ImVec2 GetCursorStartPos(); // [window-local] initial cursor position, in window-local coordinates. Call GetCursorScreenPos() after Begin() to get the absolute coordinates version. // Other layout functions IMGUI_API void Separator(); // separator, generally horizontal. inside a menu bar or in horizontal layout mode, this becomes a vertical separator. IMGUI_API void SameLine(float offset_from_start_x=0.0f, float spacing=-1.0f); // call between widgets or groups to layout them horizontally. X position given in window coordinates. IMGUI_API void NewLine(); // undo a SameLine() or force a new line when in a horizontal-layout context. IMGUI_API void Spacing(); // add vertical spacing. IMGUI_API void Dummy(const ImVec2& size); // add a dummy item of given size. unlike InvisibleButton(), Dummy() won't take the mouse click or be navigable into. IMGUI_API void Indent(float indent_w = 0.0f); // move content position toward the right, by indent_w, or style.IndentSpacing if indent_w <= 0 IMGUI_API void Unindent(float indent_w = 0.0f); // move content position back to the left, by indent_w, or style.IndentSpacing if indent_w <= 0 IMGUI_API void BeginGroup(); // lock horizontal starting position IMGUI_API void EndGroup(); // unlock horizontal starting position + capture the whole group bounding box into one "item" (so you can use IsItemHovered() or layout primitives such as SameLine() on whole group, etc.) IMGUI_API void AlignTextToFramePadding(); // vertically align upcoming text baseline to FramePadding.y so that it will align properly to regularly framed items (call if you have text on a line before a framed item) IMGUI_API float GetTextLineHeight(); // ~ FontSize IMGUI_API float GetTextLineHeightWithSpacing(); // ~ FontSize + style.ItemSpacing.y (distance in pixels between 2 consecutive lines of text) IMGUI_API float GetFrameHeight(); // ~ FontSize + style.FramePadding.y * 2 IMGUI_API float GetFrameHeightWithSpacing(); // ~ FontSize + style.FramePadding.y * 2 + style.ItemSpacing.y (distance in pixels between 2 consecutive lines of framed widgets) // ID stack/scopes // Read the FAQ (docs/FAQ.md or http://dearimgui.com/faq) for more details about how ID are handled in dear imgui. // - Those questions are answered and impacted by understanding of the ID stack system: // - "Q: Why is my widget not reacting when I click on it?" // - "Q: How can I have widgets with an empty label?" // - "Q: How can I have multiple widgets with the same label?" // - Short version: ID are hashes of the entire ID stack. If you are creating widgets in a loop you most likely // want to push a unique identifier (e.g. object pointer, loop index) to uniquely differentiate them. // - You can also use the "Label##foobar" syntax within widget label to distinguish them from each others. // - In this header file we use the "label"/"name" terminology to denote a string that will be displayed + used as an ID, // whereas "str_id" denote a string that is only used as an ID and not normally displayed. IMGUI_API void PushID(const char* str_id); // push string into the ID stack (will hash string). IMGUI_API void PushID(const char* str_id_begin, const char* str_id_end); // push string into the ID stack (will hash string). IMGUI_API void PushID(const void* ptr_id); // push pointer into the ID stack (will hash pointer). IMGUI_API void PushID(int int_id); // push integer into the ID stack (will hash integer). IMGUI_API void PopID(); // pop from the ID stack. IMGUI_API ImGuiID GetID(const char* str_id); // calculate unique ID (hash of whole ID stack + given parameter). e.g. if you want to query into ImGuiStorage yourself IMGUI_API ImGuiID GetID(const char* str_id_begin, const char* str_id_end); IMGUI_API ImGuiID GetID(const void* ptr_id); IMGUI_API ImGuiID GetID(int int_id); // Widgets: Text IMGUI_API void TextUnformatted(const char* text, const char* text_end = NULL); // raw text without formatting. Roughly equivalent to Text("%s", text) but: A) doesn't require null terminated string if 'text_end' is specified, B) it's faster, no memory copy is done, no buffer size limits, recommended for long chunks of text. IMGUI_API void Text(const char* fmt, ...) IM_FMTARGS(1); // formatted text IMGUI_API void TextV(const char* fmt, va_list args) IM_FMTLIST(1); IMGUI_API void TextColored(const ImVec4& col, const char* fmt, ...) IM_FMTARGS(2); // shortcut for PushStyleColor(ImGuiCol_Text, col); Text(fmt, ...); PopStyleColor(); IMGUI_API void TextColoredV(const ImVec4& col, const char* fmt, va_list args) IM_FMTLIST(2); IMGUI_API void TextDisabled(const char* fmt, ...) IM_FMTARGS(1); // shortcut for PushStyleColor(ImGuiCol_Text, style.Colors[ImGuiCol_TextDisabled]); Text(fmt, ...); PopStyleColor(); IMGUI_API void TextDisabledV(const char* fmt, va_list args) IM_FMTLIST(1); IMGUI_API void TextWrapped(const char* fmt, ...) IM_FMTARGS(1); // shortcut for PushTextWrapPos(0.0f); Text(fmt, ...); PopTextWrapPos();. Note that this won't work on an auto-resizing window if there's no other widgets to extend the window width, yoy may need to set a size using SetNextWindowSize(). IMGUI_API void TextWrappedV(const char* fmt, va_list args) IM_FMTLIST(1); IMGUI_API void LabelText(const char* label, const char* fmt, ...) IM_FMTARGS(2); // display text+label aligned the same way as value+label widgets IMGUI_API void LabelTextV(const char* label, const char* fmt, va_list args) IM_FMTLIST(2); IMGUI_API void BulletText(const char* fmt, ...) IM_FMTARGS(1); // shortcut for Bullet()+Text() IMGUI_API void BulletTextV(const char* fmt, va_list args) IM_FMTLIST(1); IMGUI_API void SeparatorText(const char* label); // currently: formatted text with a horizontal line // Widgets: Main // - Most widgets return true when the value has been changed or when pressed/selected // - You may also use one of the many IsItemXXX functions (e.g. IsItemActive, IsItemHovered, etc.) to query widget state. IMGUI_API bool Button(const char* label, const ImVec2& size = ImVec2(0, 0)); // button IMGUI_API bool SmallButton(const char* label); // button with (FramePadding.y == 0) to easily embed within text IMGUI_API bool InvisibleButton(const char* str_id, const ImVec2& size, ImGuiButtonFlags flags = 0); // flexible button behavior without the visuals, frequently useful to build custom behaviors using the public api (along with IsItemActive, IsItemHovered, etc.) IMGUI_API bool ArrowButton(const char* str_id, ImGuiDir dir); // square button with an arrow shape IMGUI_API bool Checkbox(const char* label, bool* v); IMGUI_API bool CheckboxFlags(const char* label, int* flags, int flags_value); IMGUI_API bool CheckboxFlags(const char* label, unsigned int* flags, unsigned int flags_value); IMGUI_API bool RadioButton(const char* label, bool active); // use with e.g. if (RadioButton("one", my_value==1)) { my_value = 1; } IMGUI_API bool RadioButton(const char* label, int* v, int v_button); // shortcut to handle the above pattern when value is an integer IMGUI_API void ProgressBar(float fraction, const ImVec2& size_arg = ImVec2(-FLT_MIN, 0), const char* overlay = NULL); IMGUI_API void Bullet(); // draw a small circle + keep the cursor on the same line. advance cursor x position by GetTreeNodeToLabelSpacing(), same distance that TreeNode() uses IMGUI_API bool TextLink(const char* label); // hyperlink text button, return true when clicked IMGUI_API void TextLinkOpenURL(const char* label, const char* url = NULL); // hyperlink text button, automatically open file/url when clicked // Widgets: Images // - Read about ImTextureID here: https://github.com/ocornut/imgui/wiki/Image-Loading-and-Displaying-Examples // - 'uv0' and 'uv1' are texture coordinates. Read about them from the same link above. // - Image() pads adds style.ImageBorderSize on each side, ImageButton() adds style.FramePadding on each side. // - ImageButton() draws a background based on regular Button() color + optionally an inner background if specified. IMGUI_API void Image(ImTextureID user_texture_id, const ImVec2& image_size, const ImVec2& uv0 = ImVec2(0, 0), const ImVec2& uv1 = ImVec2(1, 1)); IMGUI_API void ImageWithBg(ImTextureID user_texture_id, const ImVec2& image_size, const ImVec2& uv0 = ImVec2(0, 0), const ImVec2& uv1 = ImVec2(1, 1), const ImVec4& bg_col = ImVec4(0, 0, 0, 0), const ImVec4& tint_col = ImVec4(1, 1, 1, 1)); IMGUI_API bool ImageButton(const char* str_id, ImTextureID user_texture_id, const ImVec2& image_size, const ImVec2& uv0 = ImVec2(0, 0), const ImVec2& uv1 = ImVec2(1, 1), const ImVec4& bg_col = ImVec4(0, 0, 0, 0), const ImVec4& tint_col = ImVec4(1, 1, 1, 1)); // Widgets: Combo Box (Dropdown) // - The BeginCombo()/EndCombo() api allows you to manage your contents and selection state however you want it, by creating e.g. Selectable() items. // - The old Combo() api are helpers over BeginCombo()/EndCombo() which are kept available for convenience purpose. This is analogous to how ListBox are created. IMGUI_API bool BeginCombo(const char* label, const char* preview_value, ImGuiComboFlags flags = 0); IMGUI_API void EndCombo(); // only call EndCombo() if BeginCombo() returns true! IMGUI_API bool Combo(const char* label, int* current_item, const char* const items[], int items_count, int popup_max_height_in_items = -1); IMGUI_API bool Combo(const char* label, int* current_item, const char* items_separated_by_zeros, int popup_max_height_in_items = -1); // Separate items with \0 within a string, end item-list with \0\0. e.g. "One\0Two\0Three\0" IMGUI_API bool Combo(const char* label, int* current_item, const char* (*getter)(void* user_data, int idx), void* user_data, int items_count, int popup_max_height_in_items = -1); // Widgets: Drag Sliders // - CTRL+Click on any drag box to turn them into an input box. Manually input values aren't clamped by default and can go off-bounds. Use ImGuiSliderFlags_AlwaysClamp to always clamp. // - For all the Float2/Float3/Float4/Int2/Int3/Int4 versions of every function, note that a 'float v[X]' function argument is the same as 'float* v', // the array syntax is just a way to document the number of elements that are expected to be accessible. You can pass address of your first element out of a contiguous set, e.g. &myvector.x // - Adjust format string to decorate the value with a prefix, a suffix, or adapt the editing and display precision e.g. "%.3f" -> 1.234; "%5.2f secs" -> 01.23 secs; "Biscuit: %.0f" -> Biscuit: 1; etc. // - Format string may also be set to NULL or use the default format ("%f" or "%d"). // - Speed are per-pixel of mouse movement (v_speed=0.2f: mouse needs to move by 5 pixels to increase value by 1). For keyboard/gamepad navigation, minimum speed is Max(v_speed, minimum_step_at_given_precision). // - Use v_min < v_max to clamp edits to given limits. Note that CTRL+Click manual input can override those limits if ImGuiSliderFlags_AlwaysClamp is not used. // - Use v_max = FLT_MAX / INT_MAX etc to avoid clamping to a maximum, same with v_min = -FLT_MAX / INT_MIN to avoid clamping to a minimum. // - We use the same sets of flags for DragXXX() and SliderXXX() functions as the features are the same and it makes it easier to swap them. // - Legacy: Pre-1.78 there are DragXXX() function signatures that take a final `float power=1.0f' argument instead of the `ImGuiSliderFlags flags=0' argument. // If you get a warning converting a float to ImGuiSliderFlags, read https://github.com/ocornut/imgui/issues/3361 IMGUI_API bool DragFloat(const char* label, float* v, float v_speed = 1.0f, float v_min = 0.0f, float v_max = 0.0f, const char* format = "%.3f", ImGuiSliderFlags flags = 0); // If v_min >= v_max we have no bound IMGUI_API bool DragFloat2(const char* label, float v[2], float v_speed = 1.0f, float v_min = 0.0f, float v_max = 0.0f, const char* format = "%.3f", ImGuiSliderFlags flags = 0); IMGUI_API bool DragFloat3(const char* label, float v[3], float v_speed = 1.0f, float v_min = 0.0f, float v_max = 0.0f, const char* format = "%.3f", ImGuiSliderFlags flags = 0); IMGUI_API bool DragFloat4(const char* label, float v[4], float v_speed = 1.0f, float v_min = 0.0f, float v_max = 0.0f, const char* format = "%.3f", ImGuiSliderFlags flags = 0); IMGUI_API bool DragFloatRange2(const char* label, float* v_current_min, float* v_current_max, float v_speed = 1.0f, float v_min = 0.0f, float v_max = 0.0f, const char* format = "%.3f", const char* format_max = NULL, ImGuiSliderFlags flags = 0); IMGUI_API bool DragInt(const char* label, int* v, float v_speed = 1.0f, int v_min = 0, int v_max = 0, const char* format = "%d", ImGuiSliderFlags flags = 0); // If v_min >= v_max we have no bound IMGUI_API bool DragInt2(const char* label, int v[2], float v_speed = 1.0f, int v_min = 0, int v_max = 0, const char* format = "%d", ImGuiSliderFlags flags = 0); IMGUI_API bool DragInt3(const char* label, int v[3], float v_speed = 1.0f, int v_min = 0, int v_max = 0, const char* format = "%d", ImGuiSliderFlags flags = 0); IMGUI_API bool DragInt4(const char* label, int v[4], float v_speed = 1.0f, int v_min = 0, int v_max = 0, const char* format = "%d", ImGuiSliderFlags flags = 0); IMGUI_API bool DragIntRange2(const char* label, int* v_current_min, int* v_current_max, float v_speed = 1.0f, int v_min = 0, int v_max = 0, const char* format = "%d", const char* format_max = NULL, ImGuiSliderFlags flags = 0); IMGUI_API bool DragScalar(const char* label, ImGuiDataType data_type, void* p_data, float v_speed = 1.0f, const void* p_min = NULL, const void* p_max = NULL, const char* format = NULL, ImGuiSliderFlags flags = 0); IMGUI_API bool DragScalarN(const char* label, ImGuiDataType data_type, void* p_data, int components, float v_speed = 1.0f, const void* p_min = NULL, const void* p_max = NULL, const char* format = NULL, ImGuiSliderFlags flags = 0); // Widgets: Regular Sliders // - CTRL+Click on any slider to turn them into an input box. Manually input values aren't clamped by default and can go off-bounds. Use ImGuiSliderFlags_AlwaysClamp to always clamp. // - Adjust format string to decorate the value with a prefix, a suffix, or adapt the editing and display precision e.g. "%.3f" -> 1.234; "%5.2f secs" -> 01.23 secs; "Biscuit: %.0f" -> Biscuit: 1; etc. // - Format string may also be set to NULL or use the default format ("%f" or "%d"). // - Legacy: Pre-1.78 there are SliderXXX() function signatures that take a final `float power=1.0f' argument instead of the `ImGuiSliderFlags flags=0' argument. // If you get a warning converting a float to ImGuiSliderFlags, read https://github.com/ocornut/imgui/issues/3361 IMGUI_API bool SliderFloat(const char* label, float* v, float v_min, float v_max, const char* format = "%.3f", ImGuiSliderFlags flags = 0); // adjust format to decorate the value with a prefix or a suffix for in-slider labels or unit display. IMGUI_API bool SliderFloat2(const char* label, float v[2], float v_min, float v_max, const char* format = "%.3f", ImGuiSliderFlags flags = 0); IMGUI_API bool SliderFloat3(const char* label, float v[3], float v_min, float v_max, const char* format = "%.3f", ImGuiSliderFlags flags = 0); IMGUI_API bool SliderFloat4(const char* label, float v[4], float v_min, float v_max, const char* format = "%.3f", ImGuiSliderFlags flags = 0); IMGUI_API bool SliderAngle(const char* label, float* v_rad, float v_degrees_min = -360.0f, float v_degrees_max = +360.0f, const char* format = "%.0f deg", ImGuiSliderFlags flags = 0); IMGUI_API bool SliderInt(const char* label, int* v, int v_min, int v_max, const char* format = "%d", ImGuiSliderFlags flags = 0); IMGUI_API bool SliderInt2(const char* label, int v[2], int v_min, int v_max, const char* format = "%d", ImGuiSliderFlags flags = 0); IMGUI_API bool SliderInt3(const char* label, int v[3], int v_min, int v_max, const char* format = "%d", ImGuiSliderFlags flags = 0); IMGUI_API bool SliderInt4(const char* label, int v[4], int v_min, int v_max, const char* format = "%d", ImGuiSliderFlags flags = 0); IMGUI_API bool SliderScalar(const char* label, ImGuiDataType data_type, void* p_data, const void* p_min, const void* p_max, const char* format = NULL, ImGuiSliderFlags flags = 0); IMGUI_API bool SliderScalarN(const char* label, ImGuiDataType data_type, void* p_data, int components, const void* p_min, const void* p_max, const char* format = NULL, ImGuiSliderFlags flags = 0); IMGUI_API bool VSliderFloat(const char* label, const ImVec2& size, float* v, float v_min, float v_max, const char* format = "%.3f", ImGuiSliderFlags flags = 0); IMGUI_API bool VSliderInt(const char* label, const ImVec2& size, int* v, int v_min, int v_max, const char* format = "%d", ImGuiSliderFlags flags = 0); IMGUI_API bool VSliderScalar(const char* label, const ImVec2& size, ImGuiDataType data_type, void* p_data, const void* p_min, const void* p_max, const char* format = NULL, ImGuiSliderFlags flags = 0); // Widgets: Input with Keyboard // - If you want to use InputText() with std::string or any custom dynamic string type, see misc/cpp/imgui_stdlib.h and comments in imgui_demo.cpp. // - Most of the ImGuiInputTextFlags flags are only useful for InputText() and not for InputFloatX, InputIntX, InputDouble etc. IMGUI_API bool InputText(const char* label, char* buf, size_t buf_size, ImGuiInputTextFlags flags = 0, ImGuiInputTextCallback callback = NULL, void* user_data = NULL); IMGUI_API bool InputTextMultiline(const char* label, char* buf, size_t buf_size, const ImVec2& size = ImVec2(0, 0), ImGuiInputTextFlags flags = 0, ImGuiInputTextCallback callback = NULL, void* user_data = NULL); IMGUI_API bool InputTextWithHint(const char* label, const char* hint, char* buf, size_t buf_size, ImGuiInputTextFlags flags = 0, ImGuiInputTextCallback callback = NULL, void* user_data = NULL); IMGUI_API bool InputFloat(const char* label, float* v, float step = 0.0f, float step_fast = 0.0f, const char* format = "%.3f", ImGuiInputTextFlags flags = 0); IMGUI_API bool InputFloat2(const char* label, float v[2], const char* format = "%.3f", ImGuiInputTextFlags flags = 0); IMGUI_API bool InputFloat3(const char* label, float v[3], const char* format = "%.3f", ImGuiInputTextFlags flags = 0); IMGUI_API bool InputFloat4(const char* label, float v[4], const char* format = "%.3f", ImGuiInputTextFlags flags = 0); IMGUI_API bool InputInt(const char* label, int* v, int step = 1, int step_fast = 100, ImGuiInputTextFlags flags = 0); IMGUI_API bool InputInt2(const char* label, int v[2], ImGuiInputTextFlags flags = 0); IMGUI_API bool InputInt3(const char* label, int v[3], ImGuiInputTextFlags flags = 0); IMGUI_API bool InputInt4(const char* label, int v[4], ImGuiInputTextFlags flags = 0); IMGUI_API bool InputDouble(const char* label, double* v, double step = 0.0, double step_fast = 0.0, const char* format = "%.6f", ImGuiInputTextFlags flags = 0); IMGUI_API bool InputScalar(const char* label, ImGuiDataType data_type, void* p_data, const void* p_step = NULL, const void* p_step_fast = NULL, const char* format = NULL, ImGuiInputTextFlags flags = 0); IMGUI_API bool InputScalarN(const char* label, ImGuiDataType data_type, void* p_data, int components, const void* p_step = NULL, const void* p_step_fast = NULL, const char* format = NULL, ImGuiInputTextFlags flags = 0); // Widgets: Color Editor/Picker (tip: the ColorEdit* functions have a little color square that can be left-clicked to open a picker, and right-clicked to open an option menu.) // - Note that in C++ a 'float v[X]' function argument is the _same_ as 'float* v', the array syntax is just a way to document the number of elements that are expected to be accessible. // - You can pass the address of a first float element out of a contiguous structure, e.g. &myvector.x IMGUI_API bool ColorEdit3(const char* label, float col[3], ImGuiColorEditFlags flags = 0); IMGUI_API bool ColorEdit4(const char* label, float col[4], ImGuiColorEditFlags flags = 0); IMGUI_API bool ColorPicker3(const char* label, float col[3], ImGuiColorEditFlags flags = 0); IMGUI_API bool ColorPicker4(const char* label, float col[4], ImGuiColorEditFlags flags = 0, const float* ref_col = NULL); IMGUI_API bool ColorButton(const char* desc_id, const ImVec4& col, ImGuiColorEditFlags flags = 0, const ImVec2& size = ImVec2(0, 0)); // display a color square/button, hover for details, return true when pressed. IMGUI_API void SetColorEditOptions(ImGuiColorEditFlags flags); // initialize current options (generally on application startup) if you want to select a default format, picker type, etc. User will be able to change many settings, unless you pass the _NoOptions flag to your calls. // Widgets: Trees // - TreeNode functions return true when the node is open, in which case you need to also call TreePop() when you are finished displaying the tree node contents. IMGUI_API bool TreeNode(const char* label); IMGUI_API bool TreeNode(const char* str_id, const char* fmt, ...) IM_FMTARGS(2); // helper variation to easily decorelate the id from the displayed string. Read the FAQ about why and how to use ID. to align arbitrary text at the same level as a TreeNode() you can use Bullet(). IMGUI_API bool TreeNode(const void* ptr_id, const char* fmt, ...) IM_FMTARGS(2); // " IMGUI_API bool TreeNodeV(const char* str_id, const char* fmt, va_list args) IM_FMTLIST(2); IMGUI_API bool TreeNodeV(const void* ptr_id, const char* fmt, va_list args) IM_FMTLIST(2); IMGUI_API bool TreeNodeEx(const char* label, ImGuiTreeNodeFlags flags = 0); IMGUI_API bool TreeNodeEx(const char* str_id, ImGuiTreeNodeFlags flags, const char* fmt, ...) IM_FMTARGS(3); IMGUI_API bool TreeNodeEx(const void* ptr_id, ImGuiTreeNodeFlags flags, const char* fmt, ...) IM_FMTARGS(3); IMGUI_API bool TreeNodeExV(const char* str_id, ImGuiTreeNodeFlags flags, const char* fmt, va_list args) IM_FMTLIST(3); IMGUI_API bool TreeNodeExV(const void* ptr_id, ImGuiTreeNodeFlags flags, const char* fmt, va_list args) IM_FMTLIST(3); IMGUI_API void TreePush(const char* str_id); // ~ Indent()+PushID(). Already called by TreeNode() when returning true, but you can call TreePush/TreePop yourself if desired. IMGUI_API void TreePush(const void* ptr_id); // " IMGUI_API void TreePop(); // ~ Unindent()+PopID() IMGUI_API float GetTreeNodeToLabelSpacing(); // horizontal distance preceding label when using TreeNode*() or Bullet() == (g.FontSize + style.FramePadding.x*2) for a regular unframed TreeNode IMGUI_API bool CollapsingHeader(const char* label, ImGuiTreeNodeFlags flags = 0); // if returning 'true' the header is open. doesn't indent nor push on ID stack. user doesn't have to call TreePop(). IMGUI_API bool CollapsingHeader(const char* label, bool* p_visible, ImGuiTreeNodeFlags flags = 0); // when 'p_visible != NULL': if '*p_visible==true' display an additional small close button on upper right of the header which will set the bool to false when clicked, if '*p_visible==false' don't display the header. IMGUI_API void SetNextItemOpen(bool is_open, ImGuiCond cond = 0); // set next TreeNode/CollapsingHeader open state. IMGUI_API void SetNextItemStorageID(ImGuiID storage_id); // set id to use for open/close storage (default to same as item id). // Widgets: Selectables // - A selectable highlights when hovered, and can display another color when selected. // - Neighbors selectable extend their highlight bounds in order to leave no gap between them. This is so a series of selected Selectable appear contiguous. IMGUI_API bool Selectable(const char* label, bool selected = false, ImGuiSelectableFlags flags = 0, const ImVec2& size = ImVec2(0, 0)); // "bool selected" carry the selection state (read-only). Selectable() is clicked is returns true so you can modify your selection state. size.x==0.0: use remaining width, size.x>0.0: specify width. size.y==0.0: use label height, size.y>0.0: specify height IMGUI_API bool Selectable(const char* label, bool* p_selected, ImGuiSelectableFlags flags = 0, const ImVec2& size = ImVec2(0, 0)); // "bool* p_selected" point to the selection state (read-write), as a convenient helper. // Multi-selection system for Selectable(), Checkbox(), TreeNode() functions [BETA] // - This enables standard multi-selection/range-selection idioms (CTRL+Mouse/Keyboard, SHIFT+Mouse/Keyboard, etc.) in a way that also allow a clipper to be used. // - ImGuiSelectionUserData is often used to store your item index within the current view (but may store something else). // - Read comments near ImGuiMultiSelectIO for instructions/details and see 'Demo->Widgets->Selection State & Multi-Select' for demo. // - TreeNode() is technically supported but... using this correctly is more complicated. You need some sort of linear/random access to your tree, // which is suited to advanced trees setups already implementing filters and clipper. We will work simplifying the current demo. // - 'selection_size' and 'items_count' parameters are optional and used by a few features. If they are costly for you to compute, you may avoid them. IMGUI_API ImGuiMultiSelectIO* BeginMultiSelect(ImGuiMultiSelectFlags flags, int selection_size = -1, int items_count = -1); IMGUI_API ImGuiMultiSelectIO* EndMultiSelect(); IMGUI_API void SetNextItemSelectionUserData(ImGuiSelectionUserData selection_user_data); IMGUI_API bool IsItemToggledSelection(); // Was the last item selection state toggled? Useful if you need the per-item information _before_ reaching EndMultiSelect(). We only returns toggle _event_ in order to handle clipping correctly. // Widgets: List Boxes // - This is essentially a thin wrapper to using BeginChild/EndChild with the ImGuiChildFlags_FrameStyle flag for stylistic changes + displaying a label. // - If you don't need a label you can probably simply use BeginChild() with the ImGuiChildFlags_FrameStyle flag for the same result. // - You can submit contents and manage your selection state however you want it, by creating e.g. Selectable() or any other items. // - The simplified/old ListBox() api are helpers over BeginListBox()/EndListBox() which are kept available for convenience purpose. This is analoguous to how Combos are created. // - Choose frame width: size.x > 0.0f: custom / size.x < 0.0f or -FLT_MIN: right-align / size.x = 0.0f (default): use current ItemWidth // - Choose frame height: size.y > 0.0f: custom / size.y < 0.0f or -FLT_MIN: bottom-align / size.y = 0.0f (default): arbitrary default height which can fit ~7 items IMGUI_API bool BeginListBox(const char* label, const ImVec2& size = ImVec2(0, 0)); // open a framed scrolling region IMGUI_API void EndListBox(); // only call EndListBox() if BeginListBox() returned true! IMGUI_API bool ListBox(const char* label, int* current_item, const char* const items[], int items_count, int height_in_items = -1); IMGUI_API bool ListBox(const char* label, int* current_item, const char* (*getter)(void* user_data, int idx), void* user_data, int items_count, int height_in_items = -1); // Widgets: Data Plotting // - Consider using ImPlot (https://github.com/epezent/implot) which is much better! IMGUI_API void PlotLines(const char* label, const float* values, int values_count, int values_offset = 0, const char* overlay_text = NULL, float scale_min = FLT_MAX, float scale_max = FLT_MAX, ImVec2 graph_size = ImVec2(0, 0), int stride = sizeof(float)); IMGUI_API void PlotLines(const char* label, float(*values_getter)(void* data, int idx), void* data, int values_count, int values_offset = 0, const char* overlay_text = NULL, float scale_min = FLT_MAX, float scale_max = FLT_MAX, ImVec2 graph_size = ImVec2(0, 0)); IMGUI_API void PlotHistogram(const char* label, const float* values, int values_count, int values_offset = 0, const char* overlay_text = NULL, float scale_min = FLT_MAX, float scale_max = FLT_MAX, ImVec2 graph_size = ImVec2(0, 0), int stride = sizeof(float)); IMGUI_API void PlotHistogram(const char* label, float (*values_getter)(void* data, int idx), void* data, int values_count, int values_offset = 0, const char* overlay_text = NULL, float scale_min = FLT_MAX, float scale_max = FLT_MAX, ImVec2 graph_size = ImVec2(0, 0)); // Widgets: Value() Helpers. // - Those are merely shortcut to calling Text() with a format string. Output single value in "name: value" format (tip: freely declare more in your code to handle your types. you can add functions to the ImGui namespace) IMGUI_API void Value(const char* prefix, bool b); IMGUI_API void Value(const char* prefix, int v); IMGUI_API void Value(const char* prefix, unsigned int v); IMGUI_API void Value(const char* prefix, float v, const char* float_format = NULL); // Widgets: Menus // - Use BeginMenuBar() on a window ImGuiWindowFlags_MenuBar to append to its menu bar. // - Use BeginMainMenuBar() to create a menu bar at the top of the screen and append to it. // - Use BeginMenu() to create a menu. You can call BeginMenu() multiple time with the same identifier to append more items to it. // - Not that MenuItem() keyboardshortcuts are displayed as a convenience but _not processed_ by Dear ImGui at the moment. IMGUI_API bool BeginMenuBar(); // append to menu-bar of current window (requires ImGuiWindowFlags_MenuBar flag set on parent window). IMGUI_API void EndMenuBar(); // only call EndMenuBar() if BeginMenuBar() returns true! IMGUI_API bool BeginMainMenuBar(); // create and append to a full screen menu-bar. IMGUI_API void EndMainMenuBar(); // only call EndMainMenuBar() if BeginMainMenuBar() returns true! IMGUI_API bool BeginMenu(const char* label, bool enabled = true); // create a sub-menu entry. only call EndMenu() if this returns true! IMGUI_API void EndMenu(); // only call EndMenu() if BeginMenu() returns true! IMGUI_API bool MenuItem(const char* label, const char* shortcut = NULL, bool selected = false, bool enabled = true); // return true when activated. IMGUI_API bool MenuItem(const char* label, const char* shortcut, bool* p_selected, bool enabled = true); // return true when activated + toggle (*p_selected) if p_selected != NULL // Tooltips // - Tooltips are windows following the mouse. They do not take focus away. // - A tooltip window can contain items of any types. // - SetTooltip() is more or less a shortcut for the 'if (BeginTooltip()) { Text(...); EndTooltip(); }' idiom (with a subtlety that it discard any previously submitted tooltip) IMGUI_API bool BeginTooltip(); // begin/append a tooltip window. IMGUI_API void EndTooltip(); // only call EndTooltip() if BeginTooltip()/BeginItemTooltip() returns true! IMGUI_API void SetTooltip(const char* fmt, ...) IM_FMTARGS(1); // set a text-only tooltip. Often used after a ImGui::IsItemHovered() check. Override any previous call to SetTooltip(). IMGUI_API void SetTooltipV(const char* fmt, va_list args) IM_FMTLIST(1); // Tooltips: helpers for showing a tooltip when hovering an item // - BeginItemTooltip() is a shortcut for the 'if (IsItemHovered(ImGuiHoveredFlags_ForTooltip) && BeginTooltip())' idiom. // - SetItemTooltip() is a shortcut for the 'if (IsItemHovered(ImGuiHoveredFlags_ForTooltip)) { SetTooltip(...); }' idiom. // - Where 'ImGuiHoveredFlags_ForTooltip' itself is a shortcut to use 'style.HoverFlagsForTooltipMouse' or 'style.HoverFlagsForTooltipNav' depending on active input type. For mouse it defaults to 'ImGuiHoveredFlags_Stationary | ImGuiHoveredFlags_DelayShort'. IMGUI_API bool BeginItemTooltip(); // begin/append a tooltip window if preceding item was hovered. IMGUI_API void SetItemTooltip(const char* fmt, ...) IM_FMTARGS(1); // set a text-only tooltip if preceding item was hovered. override any previous call to SetTooltip(). IMGUI_API void SetItemTooltipV(const char* fmt, va_list args) IM_FMTLIST(1); // Popups, Modals // - They block normal mouse hovering detection (and therefore most mouse interactions) behind them. // - If not modal: they can be closed by clicking anywhere outside them, or by pressing ESCAPE. // - Their visibility state (~bool) is held internally instead of being held by the programmer as we are used to with regular Begin*() calls. // - The 3 properties above are related: we need to retain popup visibility state in the library because popups may be closed as any time. // - You can bypass the hovering restriction by using ImGuiHoveredFlags_AllowWhenBlockedByPopup when calling IsItemHovered() or IsWindowHovered(). // - IMPORTANT: Popup identifiers are relative to the current ID stack, so OpenPopup and BeginPopup generally needs to be at the same level of the stack. // This is sometimes leading to confusing mistakes. May rework this in the future. // - BeginPopup(): query popup state, if open start appending into the window. Call EndPopup() afterwards if returned true. ImGuiWindowFlags are forwarded to the window. // - BeginPopupModal(): block every interaction behind the window, cannot be closed by user, add a dimming background, has a title bar. IMGUI_API bool BeginPopup(const char* str_id, ImGuiWindowFlags flags = 0); // return true if the popup is open, and you can start outputting to it. IMGUI_API bool BeginPopupModal(const char* name, bool* p_open = NULL, ImGuiWindowFlags flags = 0); // return true if the modal is open, and you can start outputting to it. IMGUI_API void EndPopup(); // only call EndPopup() if BeginPopupXXX() returns true! // Popups: open/close functions // - OpenPopup(): set popup state to open. ImGuiPopupFlags are available for opening options. // - If not modal: they can be closed by clicking anywhere outside them, or by pressing ESCAPE. // - CloseCurrentPopup(): use inside the BeginPopup()/EndPopup() scope to close manually. // - CloseCurrentPopup() is called by default by Selectable()/MenuItem() when activated (FIXME: need some options). // - Use ImGuiPopupFlags_NoOpenOverExistingPopup to avoid opening a popup if there's already one at the same level. This is equivalent to e.g. testing for !IsAnyPopupOpen() prior to OpenPopup(). // - Use IsWindowAppearing() after BeginPopup() to tell if a window just opened. // - IMPORTANT: Notice that for OpenPopupOnItemClick() we exceptionally default flags to 1 (== ImGuiPopupFlags_MouseButtonRight) for backward compatibility with older API taking 'int mouse_button = 1' parameter IMGUI_API void OpenPopup(const char* str_id, ImGuiPopupFlags popup_flags = 0); // call to mark popup as open (don't call every frame!). IMGUI_API void OpenPopup(ImGuiID id, ImGuiPopupFlags popup_flags = 0); // id overload to facilitate calling from nested stacks IMGUI_API void OpenPopupOnItemClick(const char* str_id = NULL, ImGuiPopupFlags popup_flags = 1); // helper to open popup when clicked on last item. Default to ImGuiPopupFlags_MouseButtonRight == 1. (note: actually triggers on the mouse _released_ event to be consistent with popup behaviors) IMGUI_API void CloseCurrentPopup(); // manually close the popup we have begin-ed into. // Popups: open+begin combined functions helpers // - Helpers to do OpenPopup+BeginPopup where the Open action is triggered by e.g. hovering an item and right-clicking. // - They are convenient to easily create context menus, hence the name. // - IMPORTANT: Notice that BeginPopupContextXXX takes ImGuiPopupFlags just like OpenPopup() and unlike BeginPopup(). For full consistency, we may add ImGuiWindowFlags to the BeginPopupContextXXX functions in the future. // - IMPORTANT: Notice that we exceptionally default their flags to 1 (== ImGuiPopupFlags_MouseButtonRight) for backward compatibility with older API taking 'int mouse_button = 1' parameter, so if you add other flags remember to re-add the ImGuiPopupFlags_MouseButtonRight. IMGUI_API bool BeginPopupContextItem(const char* str_id = NULL, ImGuiPopupFlags popup_flags = 1); // open+begin popup when clicked on last item. Use str_id==NULL to associate the popup to previous item. If you want to use that on a non-interactive item such as Text() you need to pass in an explicit ID here. read comments in .cpp! IMGUI_API bool BeginPopupContextWindow(const char* str_id = NULL, ImGuiPopupFlags popup_flags = 1);// open+begin popup when clicked on current window. IMGUI_API bool BeginPopupContextVoid(const char* str_id = NULL, ImGuiPopupFlags popup_flags = 1); // open+begin popup when clicked in void (where there are no windows). // Popups: query functions // - IsPopupOpen(): return true if the popup is open at the current BeginPopup() level of the popup stack. // - IsPopupOpen() with ImGuiPopupFlags_AnyPopupId: return true if any popup is open at the current BeginPopup() level of the popup stack. // - IsPopupOpen() with ImGuiPopupFlags_AnyPopupId + ImGuiPopupFlags_AnyPopupLevel: return true if any popup is open. IMGUI_API bool IsPopupOpen(const char* str_id, ImGuiPopupFlags flags = 0); // return true if the popup is open. // Tables // - Full-featured replacement for old Columns API. // - See Demo->Tables for demo code. See top of imgui_tables.cpp for general commentary. // - See ImGuiTableFlags_ and ImGuiTableColumnFlags_ enums for a description of available flags. // The typical call flow is: // - 1. Call BeginTable(), early out if returning false. // - 2. Optionally call TableSetupColumn() to submit column name/flags/defaults. // - 3. Optionally call TableSetupScrollFreeze() to request scroll freezing of columns/rows. // - 4. Optionally call TableHeadersRow() to submit a header row. Names are pulled from TableSetupColumn() data. // - 5. Populate contents: // - In most situations you can use TableNextRow() + TableSetColumnIndex(N) to start appending into a column. // - If you are using tables as a sort of grid, where every column is holding the same type of contents, // you may prefer using TableNextColumn() instead of TableNextRow() + TableSetColumnIndex(). // TableNextColumn() will automatically wrap-around into the next row if needed. // - IMPORTANT: Comparatively to the old Columns() API, we need to call TableNextColumn() for the first column! // - Summary of possible call flow: // - TableNextRow() -> TableSetColumnIndex(0) -> Text("Hello 0") -> TableSetColumnIndex(1) -> Text("Hello 1") // OK // - TableNextRow() -> TableNextColumn() -> Text("Hello 0") -> TableNextColumn() -> Text("Hello 1") // OK // - TableNextColumn() -> Text("Hello 0") -> TableNextColumn() -> Text("Hello 1") // OK: TableNextColumn() automatically gets to next row! // - TableNextRow() -> Text("Hello 0") // Not OK! Missing TableSetColumnIndex() or TableNextColumn()! Text will not appear! // - 5. Call EndTable() IMGUI_API bool BeginTable(const char* str_id, int columns, ImGuiTableFlags flags = 0, const ImVec2& outer_size = ImVec2(0.0f, 0.0f), float inner_width = 0.0f); IMGUI_API void EndTable(); // only call EndTable() if BeginTable() returns true! IMGUI_API void TableNextRow(ImGuiTableRowFlags row_flags = 0, float min_row_height = 0.0f); // append into the first cell of a new row. IMGUI_API bool TableNextColumn(); // append into the next column (or first column of next row if currently in last column). Return true when column is visible. IMGUI_API bool TableSetColumnIndex(int column_n); // append into the specified column. Return true when column is visible. // Tables: Headers & Columns declaration // - Use TableSetupColumn() to specify label, resizing policy, default width/weight, id, various other flags etc. // - Use TableHeadersRow() to create a header row and automatically submit a TableHeader() for each column. // Headers are required to perform: reordering, sorting, and opening the context menu. // The context menu can also be made available in columns body using ImGuiTableFlags_ContextMenuInBody. // - You may manually submit headers using TableNextRow() + TableHeader() calls, but this is only useful in // some advanced use cases (e.g. adding custom widgets in header row). // - Use TableSetupScrollFreeze() to lock columns/rows so they stay visible when scrolled. IMGUI_API void TableSetupColumn(const char* label, ImGuiTableColumnFlags flags = 0, float init_width_or_weight = 0.0f, ImGuiID user_id = 0); IMGUI_API void TableSetupScrollFreeze(int cols, int rows); // lock columns/rows so they stay visible when scrolled. IMGUI_API void TableHeader(const char* label); // submit one header cell manually (rarely used) IMGUI_API void TableHeadersRow(); // submit a row with headers cells based on data provided to TableSetupColumn() + submit context menu IMGUI_API void TableAngledHeadersRow(); // submit a row with angled headers for every column with the ImGuiTableColumnFlags_AngledHeader flag. MUST BE FIRST ROW. // Tables: Sorting & Miscellaneous functions // - Sorting: call TableGetSortSpecs() to retrieve latest sort specs for the table. NULL when not sorting. // When 'sort_specs->SpecsDirty == true' you should sort your data. It will be true when sorting specs have // changed since last call, or the first time. Make sure to set 'SpecsDirty = false' after sorting, // else you may wastefully sort your data every frame! // - Functions args 'int column_n' treat the default value of -1 as the same as passing the current column index. IMGUI_API ImGuiTableSortSpecs* TableGetSortSpecs(); // get latest sort specs for the table (NULL if not sorting). Lifetime: don't hold on this pointer over multiple frames or past any subsequent call to BeginTable(). IMGUI_API int TableGetColumnCount(); // return number of columns (value passed to BeginTable) IMGUI_API int TableGetColumnIndex(); // return current column index. IMGUI_API int TableGetRowIndex(); // return current row index. IMGUI_API const char* TableGetColumnName(int column_n = -1); // return "" if column didn't have a name declared by TableSetupColumn(). Pass -1 to use current column. IMGUI_API ImGuiTableColumnFlags TableGetColumnFlags(int column_n = -1); // return column flags so you can query their Enabled/Visible/Sorted/Hovered status flags. Pass -1 to use current column. IMGUI_API void TableSetColumnEnabled(int column_n, bool v);// change user accessible enabled/disabled state of a column. Set to false to hide the column. User can use the context menu to change this themselves (right-click in headers, or right-click in columns body with ImGuiTableFlags_ContextMenuInBody) IMGUI_API int TableGetHoveredColumn(); // return hovered column. return -1 when table is not hovered. return columns_count if the unused space at the right of visible columns is hovered. Can also use (TableGetColumnFlags() & ImGuiTableColumnFlags_IsHovered) instead. IMGUI_API void TableSetBgColor(ImGuiTableBgTarget target, ImU32 color, int column_n = -1); // change the color of a cell, row, or column. See ImGuiTableBgTarget_ flags for details. // Legacy Columns API (prefer using Tables!) // - You can also use SameLine(pos_x) to mimic simplified columns. IMGUI_API void Columns(int count = 1, const char* id = NULL, bool borders = true); IMGUI_API void NextColumn(); // next column, defaults to current row or next row if the current row is finished IMGUI_API int GetColumnIndex(); // get current column index IMGUI_API float GetColumnWidth(int column_index = -1); // get column width (in pixels). pass -1 to use current column IMGUI_API void SetColumnWidth(int column_index, float width); // set column width (in pixels). pass -1 to use current column IMGUI_API float GetColumnOffset(int column_index = -1); // get position of column line (in pixels, from the left side of the contents region). pass -1 to use current column, otherwise 0..GetColumnsCount() inclusive. column 0 is typically 0.0f IMGUI_API void SetColumnOffset(int column_index, float offset_x); // set position of column line (in pixels, from the left side of the contents region). pass -1 to use current column IMGUI_API int GetColumnsCount(); // Tab Bars, Tabs // - Note: Tabs are automatically created by the docking system (when in 'docking' branch). Use this to create tab bars/tabs yourself. IMGUI_API bool BeginTabBar(const char* str_id, ImGuiTabBarFlags flags = 0); // create and append into a TabBar IMGUI_API void EndTabBar(); // only call EndTabBar() if BeginTabBar() returns true! IMGUI_API bool BeginTabItem(const char* label, bool* p_open = NULL, ImGuiTabItemFlags flags = 0); // create a Tab. Returns true if the Tab is selected. IMGUI_API void EndTabItem(); // only call EndTabItem() if BeginTabItem() returns true! IMGUI_API bool TabItemButton(const char* label, ImGuiTabItemFlags flags = 0); // create a Tab behaving like a button. return true when clicked. cannot be selected in the tab bar. IMGUI_API void SetTabItemClosed(const char* tab_or_docked_window_label); // notify TabBar or Docking system of a closed tab/window ahead (useful to reduce visual flicker on reorderable tab bars). For tab-bar: call after BeginTabBar() and before Tab submissions. Otherwise call with a window name. // Logging/Capture // - All text output from the interface can be captured into tty/file/clipboard. By default, tree nodes are automatically opened during logging. IMGUI_API void LogToTTY(int auto_open_depth = -1); // start logging to tty (stdout) IMGUI_API void LogToFile(int auto_open_depth = -1, const char* filename = NULL); // start logging to file IMGUI_API void LogToClipboard(int auto_open_depth = -1); // start logging to OS clipboard IMGUI_API void LogFinish(); // stop logging (close file, etc.) IMGUI_API void LogButtons(); // helper to display buttons for logging to tty/file/clipboard IMGUI_API void LogText(const char* fmt, ...) IM_FMTARGS(1); // pass text data straight to log (without being displayed) IMGUI_API void LogTextV(const char* fmt, va_list args) IM_FMTLIST(1); // Drag and Drop // - On source items, call BeginDragDropSource(), if it returns true also call SetDragDropPayload() + EndDragDropSource(). // - On target candidates, call BeginDragDropTarget(), if it returns true also call AcceptDragDropPayload() + EndDragDropTarget(). // - If you stop calling BeginDragDropSource() the payload is preserved however it won't have a preview tooltip (we currently display a fallback "..." tooltip, see #1725) // - An item can be both drag source and drop target. IMGUI_API bool BeginDragDropSource(ImGuiDragDropFlags flags = 0); // call after submitting an item which may be dragged. when this return true, you can call SetDragDropPayload() + EndDragDropSource() IMGUI_API bool SetDragDropPayload(const char* type, const void* data, size_t sz, ImGuiCond cond = 0); // type is a user defined string of maximum 32 characters. Strings starting with '_' are reserved for dear imgui internal types. Data is copied and held by imgui. Return true when payload has been accepted. IMGUI_API void EndDragDropSource(); // only call EndDragDropSource() if BeginDragDropSource() returns true! IMGUI_API bool BeginDragDropTarget(); // call after submitting an item that may receive a payload. If this returns true, you can call AcceptDragDropPayload() + EndDragDropTarget() IMGUI_API const ImGuiPayload* AcceptDragDropPayload(const char* type, ImGuiDragDropFlags flags = 0); // accept contents of a given type. If ImGuiDragDropFlags_AcceptBeforeDelivery is set you can peek into the payload before the mouse button is released. IMGUI_API void EndDragDropTarget(); // only call EndDragDropTarget() if BeginDragDropTarget() returns true! IMGUI_API const ImGuiPayload* GetDragDropPayload(); // peek directly into the current payload from anywhere. returns NULL when drag and drop is finished or inactive. use ImGuiPayload::IsDataType() to test for the payload type. // Disabling [BETA API] // - Disable all user interactions and dim items visuals (applying style.DisabledAlpha over current colors) // - Those can be nested but it cannot be used to enable an already disabled section (a single BeginDisabled(true) in the stack is enough to keep everything disabled) // - Tooltips windows by exception are opted out of disabling. // - BeginDisabled(false)/EndDisabled() essentially does nothing but is provided to facilitate use of boolean expressions (as a micro-optimization: if you have tens of thousands of BeginDisabled(false)/EndDisabled() pairs, you might want to reformulate your code to avoid making those calls) IMGUI_API void BeginDisabled(bool disabled = true); IMGUI_API void EndDisabled(); // Clipping // - Mouse hovering is affected by ImGui::PushClipRect() calls, unlike direct calls to ImDrawList::PushClipRect() which are render only. IMGUI_API void PushClipRect(const ImVec2& clip_rect_min, const ImVec2& clip_rect_max, bool intersect_with_current_clip_rect); IMGUI_API void PopClipRect(); // Focus, Activation IMGUI_API void SetItemDefaultFocus(); // make last item the default focused item of a newly appearing window. IMGUI_API void SetKeyboardFocusHere(int offset = 0); // focus keyboard on the next widget. Use positive 'offset' to access sub components of a multiple component widget. Use -1 to access previous widget. // Keyboard/Gamepad Navigation IMGUI_API void SetNavCursorVisible(bool visible); // alter visibility of keyboard/gamepad cursor. by default: show when using an arrow key, hide when clicking with mouse. // Overlapping mode IMGUI_API void SetNextItemAllowOverlap(); // allow next item to be overlapped by a subsequent item. Useful with invisible buttons, selectable, treenode covering an area where subsequent items may need to be added. Note that both Selectable() and TreeNode() have dedicated flags doing this. // Item/Widgets Utilities and Query Functions // - Most of the functions are referring to the previous Item that has been submitted. // - See Demo Window under "Widgets->Querying Status" for an interactive visualization of most of those functions. IMGUI_API bool IsItemHovered(ImGuiHoveredFlags flags = 0); // is the last item hovered? (and usable, aka not blocked by a popup, etc.). See ImGuiHoveredFlags for more options. IMGUI_API bool IsItemActive(); // is the last item active? (e.g. button being held, text field being edited. This will continuously return true while holding mouse button on an item. Items that don't interact will always return false) IMGUI_API bool IsItemFocused(); // is the last item focused for keyboard/gamepad navigation? IMGUI_API bool IsItemClicked(ImGuiMouseButton mouse_button = 0); // is the last item hovered and mouse clicked on? (**) == IsMouseClicked(mouse_button) && IsItemHovered()Important. (**) this is NOT equivalent to the behavior of e.g. Button(). Read comments in function definition. IMGUI_API bool IsItemVisible(); // is the last item visible? (items may be out of sight because of clipping/scrolling) IMGUI_API bool IsItemEdited(); // did the last item modify its underlying value this frame? or was pressed? This is generally the same as the "bool" return value of many widgets. IMGUI_API bool IsItemActivated(); // was the last item just made active (item was previously inactive). IMGUI_API bool IsItemDeactivated(); // was the last item just made inactive (item was previously active). Useful for Undo/Redo patterns with widgets that require continuous editing. IMGUI_API bool IsItemDeactivatedAfterEdit(); // was the last item just made inactive and made a value change when it was active? (e.g. Slider/Drag moved). Useful for Undo/Redo patterns with widgets that require continuous editing. Note that you may get false positives (some widgets such as Combo()/ListBox()/Selectable() will return true even when clicking an already selected item). IMGUI_API bool IsItemToggledOpen(); // was the last item open state toggled? set by TreeNode(). IMGUI_API bool IsAnyItemHovered(); // is any item hovered? IMGUI_API bool IsAnyItemActive(); // is any item active? IMGUI_API bool IsAnyItemFocused(); // is any item focused? IMGUI_API ImGuiID GetItemID(); // get ID of last item (~~ often same ImGui::GetID(label) beforehand) IMGUI_API ImVec2 GetItemRectMin(); // get upper-left bounding rectangle of the last item (screen space) IMGUI_API ImVec2 GetItemRectMax(); // get lower-right bounding rectangle of the last item (screen space) IMGUI_API ImVec2 GetItemRectSize(); // get size of last item // Viewports // - Currently represents the Platform Window created by the application which is hosting our Dear ImGui windows. // - In 'docking' branch with multi-viewport enabled, we extend this concept to have multiple active viewports. // - In the future we will extend this concept further to also represent Platform Monitor and support a "no main platform window" operation mode. IMGUI_API ImGuiViewport* GetMainViewport(); // return primary/default viewport. This can never be NULL. // Background/Foreground Draw Lists IMGUI_API ImDrawList* GetBackgroundDrawList(); // this draw list will be the first rendered one. Useful to quickly draw shapes/text behind dear imgui contents. IMGUI_API ImDrawList* GetForegroundDrawList(); // this draw list will be the last rendered one. Useful to quickly draw shapes/text over dear imgui contents. // Miscellaneous Utilities IMGUI_API bool IsRectVisible(const ImVec2& size); // test if rectangle (of given size, starting from cursor position) is visible / not clipped. IMGUI_API bool IsRectVisible(const ImVec2& rect_min, const ImVec2& rect_max); // test if rectangle (in screen space) is visible / not clipped. to perform coarse clipping on user's side. IMGUI_API double GetTime(); // get global imgui time. incremented by io.DeltaTime every frame. IMGUI_API int GetFrameCount(); // get global imgui frame count. incremented by 1 every frame. IMGUI_API ImDrawListSharedData* GetDrawListSharedData(); // you may use this when creating your own ImDrawList instances. IMGUI_API const char* GetStyleColorName(ImGuiCol idx); // get a string corresponding to the enum value (for display, saving, etc.). IMGUI_API void SetStateStorage(ImGuiStorage* storage); // replace current window storage with our own (if you want to manipulate it yourself, typically clear subsection of it) IMGUI_API ImGuiStorage* GetStateStorage(); // Text Utilities IMGUI_API ImVec2 CalcTextSize(const char* text, const char* text_end = NULL, bool hide_text_after_double_hash = false, float wrap_width = -1.0f); // Color Utilities IMGUI_API ImVec4 ColorConvertU32ToFloat4(ImU32 in); IMGUI_API ImU32 ColorConvertFloat4ToU32(const ImVec4& in); IMGUI_API void ColorConvertRGBtoHSV(float r, float g, float b, float& out_h, float& out_s, float& out_v); IMGUI_API void ColorConvertHSVtoRGB(float h, float s, float v, float& out_r, float& out_g, float& out_b); // Inputs Utilities: Keyboard/Mouse/Gamepad // - the ImGuiKey enum contains all possible keyboard, mouse and gamepad inputs (e.g. ImGuiKey_A, ImGuiKey_MouseLeft, ImGuiKey_GamepadDpadUp...). // - (legacy: before v1.87, we used ImGuiKey to carry native/user indices as defined by each backends. This was obsoleted in 1.87 (2022-02) and completely removed in 1.91.5 (2024-11). See https://github.com/ocornut/imgui/issues/4921) // - (legacy: any use of ImGuiKey will assert when key < 512 to detect passing legacy native/user indices) IMGUI_API bool IsKeyDown(ImGuiKey key); // is key being held. IMGUI_API bool IsKeyPressed(ImGuiKey key, bool repeat = true); // was key pressed (went from !Down to Down)? if repeat=true, uses io.KeyRepeatDelay / KeyRepeatRate IMGUI_API bool IsKeyReleased(ImGuiKey key); // was key released (went from Down to !Down)? IMGUI_API bool IsKeyChordPressed(ImGuiKeyChord key_chord); // was key chord (mods + key) pressed, e.g. you can pass 'ImGuiMod_Ctrl | ImGuiKey_S' as a key-chord. This doesn't do any routing or focus check, please consider using Shortcut() function instead. IMGUI_API int GetKeyPressedAmount(ImGuiKey key, float repeat_delay, float rate); // uses provided repeat rate/delay. return a count, most often 0 or 1 but might be >1 if RepeatRate is small enough that DeltaTime > RepeatRate IMGUI_API const char* GetKeyName(ImGuiKey key); // [DEBUG] returns English name of the key. Those names are provided for debugging purpose and are not meant to be saved persistently nor compared. IMGUI_API void SetNextFrameWantCaptureKeyboard(bool want_capture_keyboard); // Override io.WantCaptureKeyboard flag next frame (said flag is left for your application to handle, typically when true it instructs your app to ignore inputs). e.g. force capture keyboard when your widget is being hovered. This is equivalent to setting "io.WantCaptureKeyboard = want_capture_keyboard"; after the next NewFrame() call. // Inputs Utilities: Shortcut Testing & Routing [BETA] // - ImGuiKeyChord = a ImGuiKey + optional ImGuiMod_Alt/ImGuiMod_Ctrl/ImGuiMod_Shift/ImGuiMod_Super. // ImGuiKey_C // Accepted by functions taking ImGuiKey or ImGuiKeyChord arguments) // ImGuiMod_Ctrl | ImGuiKey_C // Accepted by functions taking ImGuiKeyChord arguments) // only ImGuiMod_XXX values are legal to combine with an ImGuiKey. You CANNOT combine two ImGuiKey values. // - The general idea is that several callers may register interest in a shortcut, and only one owner gets it. // Parent -> call Shortcut(Ctrl+S) // When Parent is focused, Parent gets the shortcut. // Child1 -> call Shortcut(Ctrl+S) // When Child1 is focused, Child1 gets the shortcut (Child1 overrides Parent shortcuts) // Child2 -> no call // When Child2 is focused, Parent gets the shortcut. // The whole system is order independent, so if Child1 makes its calls before Parent, results will be identical. // This is an important property as it facilitate working with foreign code or larger codebase. // - To understand the difference: // - IsKeyChordPressed() compares mods and call IsKeyPressed() -> function has no side-effect. // - Shortcut() submits a route, routes are resolved, if it currently can be routed it calls IsKeyChordPressed() -> function has (desirable) side-effects as it can prevents another call from getting the route. // - Visualize registered routes in 'Metrics/Debugger->Inputs'. IMGUI_API bool Shortcut(ImGuiKeyChord key_chord, ImGuiInputFlags flags = 0); IMGUI_API void SetNextItemShortcut(ImGuiKeyChord key_chord, ImGuiInputFlags flags = 0); // Inputs Utilities: Key/Input Ownership [BETA] // - One common use case would be to allow your items to disable standard inputs behaviors such // as Tab or Alt key handling, Mouse Wheel scrolling, etc. // e.g. Button(...); SetItemKeyOwner(ImGuiKey_MouseWheelY); to make hovering/activating a button disable wheel for scrolling. // - Reminder ImGuiKey enum include access to mouse buttons and gamepad, so key ownership can apply to them. // - Many related features are still in imgui_internal.h. For instance, most IsKeyXXX()/IsMouseXXX() functions have an owner-id-aware version. IMGUI_API void SetItemKeyOwner(ImGuiKey key); // Set key owner to last item ID if it is hovered or active. Equivalent to 'if (IsItemHovered() || IsItemActive()) { SetKeyOwner(key, GetItemID());'. // Inputs Utilities: Mouse // - To refer to a mouse button, you may use named enums in your code e.g. ImGuiMouseButton_Left, ImGuiMouseButton_Right. // - You can also use regular integer: it is forever guaranteed that 0=Left, 1=Right, 2=Middle. // - Dragging operations are only reported after mouse has moved a certain distance away from the initial clicking position (see 'lock_threshold' and 'io.MouseDraggingThreshold') IMGUI_API bool IsMouseDown(ImGuiMouseButton button); // is mouse button held? IMGUI_API bool IsMouseClicked(ImGuiMouseButton button, bool repeat = false); // did mouse button clicked? (went from !Down to Down). Same as GetMouseClickedCount() == 1. IMGUI_API bool IsMouseReleased(ImGuiMouseButton button); // did mouse button released? (went from Down to !Down) IMGUI_API bool IsMouseDoubleClicked(ImGuiMouseButton button); // did mouse button double-clicked? Same as GetMouseClickedCount() == 2. (note that a double-click will also report IsMouseClicked() == true) IMGUI_API bool IsMouseReleasedWithDelay(ImGuiMouseButton button, float delay); // delayed mouse release (use very sparingly!). Generally used with 'delay >= io.MouseDoubleClickTime' + combined with a 'io.MouseClickedLastCount==1' test. This is a very rarely used UI idiom, but some apps use this: e.g. MS Explorer single click on an icon to rename. IMGUI_API int GetMouseClickedCount(ImGuiMouseButton button); // return the number of successive mouse-clicks at the time where a click happen (otherwise 0). IMGUI_API bool IsMouseHoveringRect(const ImVec2& r_min, const ImVec2& r_max, bool clip = true);// is mouse hovering given bounding rect (in screen space). clipped by current clipping settings, but disregarding of other consideration of focus/window ordering/popup-block. IMGUI_API bool IsMousePosValid(const ImVec2* mouse_pos = NULL); // by convention we use (-FLT_MAX,-FLT_MAX) to denote that there is no mouse available IMGUI_API bool IsAnyMouseDown(); // [WILL OBSOLETE] is any mouse button held? This was designed for backends, but prefer having backend maintain a mask of held mouse buttons, because upcoming input queue system will make this invalid. IMGUI_API ImVec2 GetMousePos(); // shortcut to ImGui::GetIO().MousePos provided by user, to be consistent with other calls IMGUI_API ImVec2 GetMousePosOnOpeningCurrentPopup(); // retrieve mouse position at the time of opening popup we have BeginPopup() into (helper to avoid user backing that value themselves) IMGUI_API bool IsMouseDragging(ImGuiMouseButton button, float lock_threshold = -1.0f); // is mouse dragging? (uses io.MouseDraggingThreshold if lock_threshold < 0.0f) IMGUI_API ImVec2 GetMouseDragDelta(ImGuiMouseButton button = 0, float lock_threshold = -1.0f); // return the delta from the initial clicking position while the mouse button is pressed or was just released. This is locked and return 0.0f until the mouse moves past a distance threshold at least once (uses io.MouseDraggingThreshold if lock_threshold < 0.0f) IMGUI_API void ResetMouseDragDelta(ImGuiMouseButton button = 0); // IMGUI_API ImGuiMouseCursor GetMouseCursor(); // get desired mouse cursor shape. Important: reset in ImGui::NewFrame(), this is updated during the frame. valid before Render(). If you use software rendering by setting io.MouseDrawCursor ImGui will render those for you IMGUI_API void SetMouseCursor(ImGuiMouseCursor cursor_type); // set desired mouse cursor shape IMGUI_API void SetNextFrameWantCaptureMouse(bool want_capture_mouse); // Override io.WantCaptureMouse flag next frame (said flag is left for your application to handle, typical when true it instucts your app to ignore inputs). This is equivalent to setting "io.WantCaptureMouse = want_capture_mouse;" after the next NewFrame() call. // Clipboard Utilities // - Also see the LogToClipboard() function to capture GUI into clipboard, or easily output text data to the clipboard. IMGUI_API const char* GetClipboardText(); IMGUI_API void SetClipboardText(const char* text); // Settings/.Ini Utilities // - The disk functions are automatically called if io.IniFilename != NULL (default is "imgui.ini"). // - Set io.IniFilename to NULL to load/save manually. Read io.WantSaveIniSettings description about handling .ini saving manually. // - Important: default value "imgui.ini" is relative to current working dir! Most apps will want to lock this to an absolute path (e.g. same path as executables). IMGUI_API void LoadIniSettingsFromDisk(const char* ini_filename); // call after CreateContext() and before the first call to NewFrame(). NewFrame() automatically calls LoadIniSettingsFromDisk(io.IniFilename). IMGUI_API void LoadIniSettingsFromMemory(const char* ini_data, size_t ini_size=0); // call after CreateContext() and before the first call to NewFrame() to provide .ini data from your own data source. IMGUI_API void SaveIniSettingsToDisk(const char* ini_filename); // this is automatically called (if io.IniFilename is not empty) a few seconds after any modification that should be reflected in the .ini file (and also by DestroyContext). IMGUI_API const char* SaveIniSettingsToMemory(size_t* out_ini_size = NULL); // return a zero-terminated string with the .ini data which you can save by your own mean. call when io.WantSaveIniSettings is set, then save data by your own mean and clear io.WantSaveIniSettings. // Debug Utilities // - Your main debugging friend is the ShowMetricsWindow() function, which is also accessible from Demo->Tools->Metrics Debugger IMGUI_API void DebugTextEncoding(const char* text); IMGUI_API void DebugFlashStyleColor(ImGuiCol idx); IMGUI_API void DebugStartItemPicker(); IMGUI_API bool DebugCheckVersionAndDataLayout(const char* version_str, size_t sz_io, size_t sz_style, size_t sz_vec2, size_t sz_vec4, size_t sz_drawvert, size_t sz_drawidx); // This is called by IMGUI_CHECKVERSION() macro. #ifndef IMGUI_DISABLE_DEBUG_TOOLS IMGUI_API void DebugLog(const char* fmt, ...) IM_FMTARGS(1); // Call via IMGUI_DEBUG_LOG() for maximum stripping in caller code! IMGUI_API void DebugLogV(const char* fmt, va_list args) IM_FMTLIST(1); #endif // Memory Allocators // - Those functions are not reliant on the current context. // - DLL users: heaps and globals are not shared across DLL boundaries! You will need to call SetCurrentContext() + SetAllocatorFunctions() // for each static/DLL boundary you are calling from. Read "Context and Memory Allocators" section of imgui.cpp for more details. IMGUI_API void SetAllocatorFunctions(ImGuiMemAllocFunc alloc_func, ImGuiMemFreeFunc free_func, void* user_data = NULL); IMGUI_API void GetAllocatorFunctions(ImGuiMemAllocFunc* p_alloc_func, ImGuiMemFreeFunc* p_free_func, void** p_user_data); IMGUI_API void* MemAlloc(size_t size); IMGUI_API void MemFree(void* ptr); } // namespace ImGui //----------------------------------------------------------------------------- // [SECTION] Flags & Enumerations //----------------------------------------------------------------------------- // Flags for ImGui::Begin() // (Those are per-window flags. There are shared flags in ImGuiIO: io.ConfigWindowsResizeFromEdges and io.ConfigWindowsMoveFromTitleBarOnly) enum ImGuiWindowFlags_ { ImGuiWindowFlags_None = 0, ImGuiWindowFlags_NoTitleBar = 1 << 0, // Disable title-bar ImGuiWindowFlags_NoResize = 1 << 1, // Disable user resizing with the lower-right grip ImGuiWindowFlags_NoMove = 1 << 2, // Disable user moving the window ImGuiWindowFlags_NoScrollbar = 1 << 3, // Disable scrollbars (window can still scroll with mouse or programmatically) ImGuiWindowFlags_NoScrollWithMouse = 1 << 4, // Disable user vertically scrolling with mouse wheel. On child window, mouse wheel will be forwarded to the parent unless NoScrollbar is also set. ImGuiWindowFlags_NoCollapse = 1 << 5, // Disable user collapsing window by double-clicking on it. Also referred to as Window Menu Button (e.g. within a docking node). ImGuiWindowFlags_AlwaysAutoResize = 1 << 6, // Resize every window to its content every frame ImGuiWindowFlags_NoBackground = 1 << 7, // Disable drawing background color (WindowBg, etc.) and outside border. Similar as using SetNextWindowBgAlpha(0.0f). ImGuiWindowFlags_NoSavedSettings = 1 << 8, // Never load/save settings in .ini file ImGuiWindowFlags_NoMouseInputs = 1 << 9, // Disable catching mouse, hovering test with pass through. ImGuiWindowFlags_MenuBar = 1 << 10, // Has a menu-bar ImGuiWindowFlags_HorizontalScrollbar = 1 << 11, // Allow horizontal scrollbar to appear (off by default). You may use SetNextWindowContentSize(ImVec2(width,0.0f)); prior to calling Begin() to specify width. Read code in imgui_demo in the "Horizontal Scrolling" section. ImGuiWindowFlags_NoFocusOnAppearing = 1 << 12, // Disable taking focus when transitioning from hidden to visible state ImGuiWindowFlags_NoBringToFrontOnFocus = 1 << 13, // Disable bringing window to front when taking focus (e.g. clicking on it or programmatically giving it focus) ImGuiWindowFlags_AlwaysVerticalScrollbar= 1 << 14, // Always show vertical scrollbar (even if ContentSize.y < Size.y) ImGuiWindowFlags_AlwaysHorizontalScrollbar=1<< 15, // Always show horizontal scrollbar (even if ContentSize.x < Size.x) ImGuiWindowFlags_NoNavInputs = 1 << 16, // No keyboard/gamepad navigation within the window ImGuiWindowFlags_NoNavFocus = 1 << 17, // No focusing toward this window with keyboard/gamepad navigation (e.g. skipped by CTRL+TAB) ImGuiWindowFlags_UnsavedDocument = 1 << 18, // Display a dot next to the title. When used in a tab/docking context, tab is selected when clicking the X + closure is not assumed (will wait for user to stop submitting the tab). Otherwise closure is assumed when pressing the X, so if you keep submitting the tab may reappear at end of tab bar. ImGuiWindowFlags_NoNav = ImGuiWindowFlags_NoNavInputs | ImGuiWindowFlags_NoNavFocus, ImGuiWindowFlags_NoDecoration = ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoScrollbar | ImGuiWindowFlags_NoCollapse, ImGuiWindowFlags_NoInputs = ImGuiWindowFlags_NoMouseInputs | ImGuiWindowFlags_NoNavInputs | ImGuiWindowFlags_NoNavFocus, // [Internal] ImGuiWindowFlags_ChildWindow = 1 << 24, // Don't use! For internal use by BeginChild() ImGuiWindowFlags_Tooltip = 1 << 25, // Don't use! For internal use by BeginTooltip() ImGuiWindowFlags_Popup = 1 << 26, // Don't use! For internal use by BeginPopup() ImGuiWindowFlags_Modal = 1 << 27, // Don't use! For internal use by BeginPopupModal() ImGuiWindowFlags_ChildMenu = 1 << 28, // Don't use! For internal use by BeginMenu() // Obsolete names #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS ImGuiWindowFlags_NavFlattened = 1 << 29, // Obsoleted in 1.90.9: Use ImGuiChildFlags_NavFlattened in BeginChild() call. ImGuiWindowFlags_AlwaysUseWindowPadding = 1 << 30, // Obsoleted in 1.90.0: Use ImGuiChildFlags_AlwaysUseWindowPadding in BeginChild() call. #endif }; // Flags for ImGui::BeginChild() // (Legacy: bit 0 must always correspond to ImGuiChildFlags_Borders to be backward compatible with old API using 'bool border = false'. // About using AutoResizeX/AutoResizeY flags: // - May be combined with SetNextWindowSizeConstraints() to set a min/max size for each axis (see "Demo->Child->Auto-resize with Constraints"). // - Size measurement for a given axis is only performed when the child window is within visible boundaries, or is just appearing. // - This allows BeginChild() to return false when not within boundaries (e.g. when scrolling), which is more optimal. BUT it won't update its auto-size while clipped. // While not perfect, it is a better default behavior as the always-on performance gain is more valuable than the occasional "resizing after becoming visible again" glitch. // - You may also use ImGuiChildFlags_AlwaysAutoResize to force an update even when child window is not in view. // HOWEVER PLEASE UNDERSTAND THAT DOING SO WILL PREVENT BeginChild() FROM EVER RETURNING FALSE, disabling benefits of coarse clipping. enum ImGuiChildFlags_ { ImGuiChildFlags_None = 0, ImGuiChildFlags_Borders = 1 << 0, // Show an outer border and enable WindowPadding. (IMPORTANT: this is always == 1 == true for legacy reason) ImGuiChildFlags_AlwaysUseWindowPadding = 1 << 1, // Pad with style.WindowPadding even if no border are drawn (no padding by default for non-bordered child windows because it makes more sense) ImGuiChildFlags_ResizeX = 1 << 2, // Allow resize from right border (layout direction). Enable .ini saving (unless ImGuiWindowFlags_NoSavedSettings passed to window flags) ImGuiChildFlags_ResizeY = 1 << 3, // Allow resize from bottom border (layout direction). " ImGuiChildFlags_AutoResizeX = 1 << 4, // Enable auto-resizing width. Read "IMPORTANT: Size measurement" details above. ImGuiChildFlags_AutoResizeY = 1 << 5, // Enable auto-resizing height. Read "IMPORTANT: Size measurement" details above. ImGuiChildFlags_AlwaysAutoResize = 1 << 6, // Combined with AutoResizeX/AutoResizeY. Always measure size even when child is hidden, always return true, always disable clipping optimization! NOT RECOMMENDED. ImGuiChildFlags_FrameStyle = 1 << 7, // Style the child window like a framed item: use FrameBg, FrameRounding, FrameBorderSize, FramePadding instead of ChildBg, ChildRounding, ChildBorderSize, WindowPadding. ImGuiChildFlags_NavFlattened = 1 << 8, // [BETA] Share focus scope, allow keyboard/gamepad navigation to cross over parent border to this child or between sibling child windows. // Obsolete names #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS ImGuiChildFlags_Border = ImGuiChildFlags_Borders, // Renamed in 1.91.1 (August 2024) for consistency. #endif }; // Flags for ImGui::PushItemFlag() // (Those are shared by all items) enum ImGuiItemFlags_ { ImGuiItemFlags_None = 0, // (Default) ImGuiItemFlags_NoTabStop = 1 << 0, // false // Disable keyboard tabbing. This is a "lighter" version of ImGuiItemFlags_NoNav. ImGuiItemFlags_NoNav = 1 << 1, // false // Disable any form of focusing (keyboard/gamepad directional navigation and SetKeyboardFocusHere() calls). ImGuiItemFlags_NoNavDefaultFocus = 1 << 2, // false // Disable item being a candidate for default focus (e.g. used by title bar items). ImGuiItemFlags_ButtonRepeat = 1 << 3, // false // Any button-like behavior will have repeat mode enabled (based on io.KeyRepeatDelay and io.KeyRepeatRate values). Note that you can also call IsItemActive() after any button to tell if it is being held. ImGuiItemFlags_AutoClosePopups = 1 << 4, // true // MenuItem()/Selectable() automatically close their parent popup window. ImGuiItemFlags_AllowDuplicateId = 1 << 5, // false // Allow submitting an item with the same identifier as an item already submitted this frame without triggering a warning tooltip if io.ConfigDebugHighlightIdConflicts is set. }; // Flags for ImGui::InputText() // (Those are per-item flags. There are shared flags in ImGuiIO: io.ConfigInputTextCursorBlink and io.ConfigInputTextEnterKeepActive) enum ImGuiInputTextFlags_ { // Basic filters (also see ImGuiInputTextFlags_CallbackCharFilter) ImGuiInputTextFlags_None = 0, ImGuiInputTextFlags_CharsDecimal = 1 << 0, // Allow 0123456789.+-*/ ImGuiInputTextFlags_CharsHexadecimal = 1 << 1, // Allow 0123456789ABCDEFabcdef ImGuiInputTextFlags_CharsScientific = 1 << 2, // Allow 0123456789.+-*/eE (Scientific notation input) ImGuiInputTextFlags_CharsUppercase = 1 << 3, // Turn a..z into A..Z ImGuiInputTextFlags_CharsNoBlank = 1 << 4, // Filter out spaces, tabs // Inputs ImGuiInputTextFlags_AllowTabInput = 1 << 5, // Pressing TAB input a '\t' character into the text field ImGuiInputTextFlags_EnterReturnsTrue = 1 << 6, // Return 'true' when Enter is pressed (as opposed to every time the value was modified). Consider using IsItemDeactivatedAfterEdit() instead! ImGuiInputTextFlags_EscapeClearsAll = 1 << 7, // Escape key clears content if not empty, and deactivate otherwise (contrast to default behavior of Escape to revert) ImGuiInputTextFlags_CtrlEnterForNewLine = 1 << 8, // In multi-line mode, validate with Enter, add new line with Ctrl+Enter (default is opposite: validate with Ctrl+Enter, add line with Enter). // Other options ImGuiInputTextFlags_ReadOnly = 1 << 9, // Read-only mode ImGuiInputTextFlags_Password = 1 << 10, // Password mode, display all characters as '*', disable copy ImGuiInputTextFlags_AlwaysOverwrite = 1 << 11, // Overwrite mode ImGuiInputTextFlags_AutoSelectAll = 1 << 12, // Select entire text when first taking mouse focus ImGuiInputTextFlags_ParseEmptyRefVal = 1 << 13, // InputFloat(), InputInt(), InputScalar() etc. only: parse empty string as zero value. ImGuiInputTextFlags_DisplayEmptyRefVal = 1 << 14, // InputFloat(), InputInt(), InputScalar() etc. only: when value is zero, do not display it. Generally used with ImGuiInputTextFlags_ParseEmptyRefVal. ImGuiInputTextFlags_NoHorizontalScroll = 1 << 15, // Disable following the cursor horizontally ImGuiInputTextFlags_NoUndoRedo = 1 << 16, // Disable undo/redo. Note that input text owns the text data while active, if you want to provide your own undo/redo stack you need e.g. to call ClearActiveID(). // Elide display / Alignment ImGuiInputTextFlags_ElideLeft = 1 << 17, // When text doesn't fit, elide left side to ensure right side stays visible. Useful for path/filenames. Single-line only! // Callback features ImGuiInputTextFlags_CallbackCompletion = 1 << 18, // Callback on pressing TAB (for completion handling) ImGuiInputTextFlags_CallbackHistory = 1 << 19, // Callback on pressing Up/Down arrows (for history handling) ImGuiInputTextFlags_CallbackAlways = 1 << 20, // Callback on each iteration. User code may query cursor position, modify text buffer. ImGuiInputTextFlags_CallbackCharFilter = 1 << 21, // Callback on character inputs to replace or discard them. Modify 'EventChar' to replace or discard, or return 1 in callback to discard. ImGuiInputTextFlags_CallbackResize = 1 << 22, // Callback on buffer capacity changes request (beyond 'buf_size' parameter value), allowing the string to grow. Notify when the string wants to be resized (for string types which hold a cache of their Size). You will be provided a new BufSize in the callback and NEED to honor it. (see misc/cpp/imgui_stdlib.h for an example of using this) ImGuiInputTextFlags_CallbackEdit = 1 << 23, // Callback on any edit. Note that InputText() already returns true on edit + you can always use IsItemEdited(). The callback is useful to manipulate the underlying buffer while focus is active. // Obsolete names //ImGuiInputTextFlags_AlwaysInsertMode = ImGuiInputTextFlags_AlwaysOverwrite // [renamed in 1.82] name was not matching behavior }; // Flags for ImGui::TreeNodeEx(), ImGui::CollapsingHeader*() enum ImGuiTreeNodeFlags_ { ImGuiTreeNodeFlags_None = 0, ImGuiTreeNodeFlags_Selected = 1 << 0, // Draw as selected ImGuiTreeNodeFlags_Framed = 1 << 1, // Draw frame with background (e.g. for CollapsingHeader) ImGuiTreeNodeFlags_AllowOverlap = 1 << 2, // Hit testing to allow subsequent widgets to overlap this one ImGuiTreeNodeFlags_NoTreePushOnOpen = 1 << 3, // Don't do a TreePush() when open (e.g. for CollapsingHeader) = no extra indent nor pushing on ID stack ImGuiTreeNodeFlags_NoAutoOpenOnLog = 1 << 4, // Don't automatically and temporarily open node when Logging is active (by default logging will automatically open tree nodes) ImGuiTreeNodeFlags_DefaultOpen = 1 << 5, // Default node to be open ImGuiTreeNodeFlags_OpenOnDoubleClick = 1 << 6, // Open on double-click instead of simple click (default for multi-select unless any _OpenOnXXX behavior is set explicitly). Both behaviors may be combined. ImGuiTreeNodeFlags_OpenOnArrow = 1 << 7, // Open when clicking on the arrow part (default for multi-select unless any _OpenOnXXX behavior is set explicitly). Both behaviors may be combined. ImGuiTreeNodeFlags_Leaf = 1 << 8, // No collapsing, no arrow (use as a convenience for leaf nodes). ImGuiTreeNodeFlags_Bullet = 1 << 9, // Display a bullet instead of arrow. IMPORTANT: node can still be marked open/close if you don't set the _Leaf flag! ImGuiTreeNodeFlags_FramePadding = 1 << 10, // Use FramePadding (even for an unframed text node) to vertically align text baseline to regular widget height. Equivalent to calling AlignTextToFramePadding() before the node. ImGuiTreeNodeFlags_SpanAvailWidth = 1 << 11, // Extend hit box to the right-most edge, even if not framed. This is not the default in order to allow adding other items on the same line without using AllowOverlap mode. ImGuiTreeNodeFlags_SpanFullWidth = 1 << 12, // Extend hit box to the left-most and right-most edges (cover the indent area). ImGuiTreeNodeFlags_SpanLabelWidth = 1 << 13, // Narrow hit box + narrow hovering highlight, will only cover the label text. ImGuiTreeNodeFlags_SpanAllColumns = 1 << 14, // Frame will span all columns of its container table (label will still fit in current column) ImGuiTreeNodeFlags_LabelSpanAllColumns = 1 << 15, // Label will span all columns of its container table //ImGuiTreeNodeFlags_NoScrollOnOpen = 1 << 16, // FIXME: TODO: Disable automatic scroll on TreePop() if node got just open and contents is not visible ImGuiTreeNodeFlags_NavLeftJumpsBackHere = 1 << 17, // (WIP) Nav: left direction may move to this TreeNode() from any of its child (items submitted between TreeNode and TreePop) ImGuiTreeNodeFlags_CollapsingHeader = ImGuiTreeNodeFlags_Framed | ImGuiTreeNodeFlags_NoTreePushOnOpen | ImGuiTreeNodeFlags_NoAutoOpenOnLog, #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS ImGuiTreeNodeFlags_AllowItemOverlap = ImGuiTreeNodeFlags_AllowOverlap, // Renamed in 1.89.7 ImGuiTreeNodeFlags_SpanTextWidth = ImGuiTreeNodeFlags_SpanLabelWidth,// Renamed in 1.90.7 #endif }; // Flags for OpenPopup*(), BeginPopupContext*(), IsPopupOpen() functions. // - To be backward compatible with older API which took an 'int mouse_button = 1' argument instead of 'ImGuiPopupFlags flags', // we need to treat small flags values as a mouse button index, so we encode the mouse button in the first few bits of the flags. // It is therefore guaranteed to be legal to pass a mouse button index in ImGuiPopupFlags. // - For the same reason, we exceptionally default the ImGuiPopupFlags argument of BeginPopupContextXXX functions to 1 instead of 0. // IMPORTANT: because the default parameter is 1 (==ImGuiPopupFlags_MouseButtonRight), if you rely on the default parameter // and want to use another flag, you need to pass in the ImGuiPopupFlags_MouseButtonRight flag explicitly. // - Multiple buttons currently cannot be combined/or-ed in those functions (we could allow it later). enum ImGuiPopupFlags_ { ImGuiPopupFlags_None = 0, ImGuiPopupFlags_MouseButtonLeft = 0, // For BeginPopupContext*(): open on Left Mouse release. Guaranteed to always be == 0 (same as ImGuiMouseButton_Left) ImGuiPopupFlags_MouseButtonRight = 1, // For BeginPopupContext*(): open on Right Mouse release. Guaranteed to always be == 1 (same as ImGuiMouseButton_Right) ImGuiPopupFlags_MouseButtonMiddle = 2, // For BeginPopupContext*(): open on Middle Mouse release. Guaranteed to always be == 2 (same as ImGuiMouseButton_Middle) ImGuiPopupFlags_MouseButtonMask_ = 0x1F, ImGuiPopupFlags_MouseButtonDefault_ = 1, ImGuiPopupFlags_NoReopen = 1 << 5, // For OpenPopup*(), BeginPopupContext*(): don't reopen same popup if already open (won't reposition, won't reinitialize navigation) //ImGuiPopupFlags_NoReopenAlwaysNavInit = 1 << 6, // For OpenPopup*(), BeginPopupContext*(): focus and initialize navigation even when not reopening. ImGuiPopupFlags_NoOpenOverExistingPopup = 1 << 7, // For OpenPopup*(), BeginPopupContext*(): don't open if there's already a popup at the same level of the popup stack ImGuiPopupFlags_NoOpenOverItems = 1 << 8, // For BeginPopupContextWindow(): don't return true when hovering items, only when hovering empty space ImGuiPopupFlags_AnyPopupId = 1 << 10, // For IsPopupOpen(): ignore the ImGuiID parameter and test for any popup. ImGuiPopupFlags_AnyPopupLevel = 1 << 11, // For IsPopupOpen(): search/test at any level of the popup stack (default test in the current level) ImGuiPopupFlags_AnyPopup = ImGuiPopupFlags_AnyPopupId | ImGuiPopupFlags_AnyPopupLevel, }; // Flags for ImGui::Selectable() enum ImGuiSelectableFlags_ { ImGuiSelectableFlags_None = 0, ImGuiSelectableFlags_NoAutoClosePopups = 1 << 0, // Clicking this doesn't close parent popup window (overrides ImGuiItemFlags_AutoClosePopups) ImGuiSelectableFlags_SpanAllColumns = 1 << 1, // Frame will span all columns of its container table (text will still fit in current column) ImGuiSelectableFlags_AllowDoubleClick = 1 << 2, // Generate press events on double clicks too ImGuiSelectableFlags_Disabled = 1 << 3, // Cannot be selected, display grayed out text ImGuiSelectableFlags_AllowOverlap = 1 << 4, // (WIP) Hit testing to allow subsequent widgets to overlap this one ImGuiSelectableFlags_Highlight = 1 << 5, // Make the item be displayed as if it is hovered #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS ImGuiSelectableFlags_DontClosePopups = ImGuiSelectableFlags_NoAutoClosePopups, // Renamed in 1.91.0 ImGuiSelectableFlags_AllowItemOverlap = ImGuiSelectableFlags_AllowOverlap, // Renamed in 1.89.7 #endif }; // Flags for ImGui::BeginCombo() enum ImGuiComboFlags_ { ImGuiComboFlags_None = 0, ImGuiComboFlags_PopupAlignLeft = 1 << 0, // Align the popup toward the left by default ImGuiComboFlags_HeightSmall = 1 << 1, // Max ~4 items visible. Tip: If you want your combo popup to be a specific size you can use SetNextWindowSizeConstraints() prior to calling BeginCombo() ImGuiComboFlags_HeightRegular = 1 << 2, // Max ~8 items visible (default) ImGuiComboFlags_HeightLarge = 1 << 3, // Max ~20 items visible ImGuiComboFlags_HeightLargest = 1 << 4, // As many fitting items as possible ImGuiComboFlags_NoArrowButton = 1 << 5, // Display on the preview box without the square arrow button ImGuiComboFlags_NoPreview = 1 << 6, // Display only a square arrow button ImGuiComboFlags_WidthFitPreview = 1 << 7, // Width dynamically calculated from preview contents ImGuiComboFlags_HeightMask_ = ImGuiComboFlags_HeightSmall | ImGuiComboFlags_HeightRegular | ImGuiComboFlags_HeightLarge | ImGuiComboFlags_HeightLargest, }; // Flags for ImGui::BeginTabBar() enum ImGuiTabBarFlags_ { ImGuiTabBarFlags_None = 0, ImGuiTabBarFlags_Reorderable = 1 << 0, // Allow manually dragging tabs to re-order them + New tabs are appended at the end of list ImGuiTabBarFlags_AutoSelectNewTabs = 1 << 1, // Automatically select new tabs when they appear ImGuiTabBarFlags_TabListPopupButton = 1 << 2, // Disable buttons to open the tab list popup ImGuiTabBarFlags_NoCloseWithMiddleMouseButton = 1 << 3, // Disable behavior of closing tabs (that are submitted with p_open != NULL) with middle mouse button. You may handle this behavior manually on user's side with if (IsItemHovered() && IsMouseClicked(2)) *p_open = false. ImGuiTabBarFlags_NoTabListScrollingButtons = 1 << 4, // Disable scrolling buttons (apply when fitting policy is ImGuiTabBarFlags_FittingPolicyScroll) ImGuiTabBarFlags_NoTooltip = 1 << 5, // Disable tooltips when hovering a tab ImGuiTabBarFlags_DrawSelectedOverline = 1 << 6, // Draw selected overline markers over selected tab ImGuiTabBarFlags_FittingPolicyResizeDown = 1 << 7, // Resize tabs when they don't fit ImGuiTabBarFlags_FittingPolicyScroll = 1 << 8, // Add scroll buttons when tabs don't fit ImGuiTabBarFlags_FittingPolicyMask_ = ImGuiTabBarFlags_FittingPolicyResizeDown | ImGuiTabBarFlags_FittingPolicyScroll, ImGuiTabBarFlags_FittingPolicyDefault_ = ImGuiTabBarFlags_FittingPolicyResizeDown, }; // Flags for ImGui::BeginTabItem() enum ImGuiTabItemFlags_ { ImGuiTabItemFlags_None = 0, ImGuiTabItemFlags_UnsavedDocument = 1 << 0, // Display a dot next to the title + set ImGuiTabItemFlags_NoAssumedClosure. ImGuiTabItemFlags_SetSelected = 1 << 1, // Trigger flag to programmatically make the tab selected when calling BeginTabItem() ImGuiTabItemFlags_NoCloseWithMiddleMouseButton = 1 << 2, // Disable behavior of closing tabs (that are submitted with p_open != NULL) with middle mouse button. You may handle this behavior manually on user's side with if (IsItemHovered() && IsMouseClicked(2)) *p_open = false. ImGuiTabItemFlags_NoPushId = 1 << 3, // Don't call PushID()/PopID() on BeginTabItem()/EndTabItem() ImGuiTabItemFlags_NoTooltip = 1 << 4, // Disable tooltip for the given tab ImGuiTabItemFlags_NoReorder = 1 << 5, // Disable reordering this tab or having another tab cross over this tab ImGuiTabItemFlags_Leading = 1 << 6, // Enforce the tab position to the left of the tab bar (after the tab list popup button) ImGuiTabItemFlags_Trailing = 1 << 7, // Enforce the tab position to the right of the tab bar (before the scrolling buttons) ImGuiTabItemFlags_NoAssumedClosure = 1 << 8, // Tab is selected when trying to close + closure is not immediately assumed (will wait for user to stop submitting the tab). Otherwise closure is assumed when pressing the X, so if you keep submitting the tab may reappear at end of tab bar. }; // Flags for ImGui::IsWindowFocused() enum ImGuiFocusedFlags_ { ImGuiFocusedFlags_None = 0, ImGuiFocusedFlags_ChildWindows = 1 << 0, // Return true if any children of the window is focused ImGuiFocusedFlags_RootWindow = 1 << 1, // Test from root window (top most parent of the current hierarchy) ImGuiFocusedFlags_AnyWindow = 1 << 2, // Return true if any window is focused. Important: If you are trying to tell how to dispatch your low-level inputs, do NOT use this. Use 'io.WantCaptureMouse' instead! Please read the FAQ! ImGuiFocusedFlags_NoPopupHierarchy = 1 << 3, // Do not consider popup hierarchy (do not treat popup emitter as parent of popup) (when used with _ChildWindows or _RootWindow) //ImGuiFocusedFlags_DockHierarchy = 1 << 4, // Consider docking hierarchy (treat dockspace host as parent of docked window) (when used with _ChildWindows or _RootWindow) ImGuiFocusedFlags_RootAndChildWindows = ImGuiFocusedFlags_RootWindow | ImGuiFocusedFlags_ChildWindows, }; // Flags for ImGui::IsItemHovered(), ImGui::IsWindowHovered() // Note: if you are trying to check whether your mouse should be dispatched to Dear ImGui or to your app, you should use 'io.WantCaptureMouse' instead! Please read the FAQ! // Note: windows with the ImGuiWindowFlags_NoInputs flag are ignored by IsWindowHovered() calls. enum ImGuiHoveredFlags_ { ImGuiHoveredFlags_None = 0, // Return true if directly over the item/window, not obstructed by another window, not obstructed by an active popup or modal blocking inputs under them. ImGuiHoveredFlags_ChildWindows = 1 << 0, // IsWindowHovered() only: Return true if any children of the window is hovered ImGuiHoveredFlags_RootWindow = 1 << 1, // IsWindowHovered() only: Test from root window (top most parent of the current hierarchy) ImGuiHoveredFlags_AnyWindow = 1 << 2, // IsWindowHovered() only: Return true if any window is hovered ImGuiHoveredFlags_NoPopupHierarchy = 1 << 3, // IsWindowHovered() only: Do not consider popup hierarchy (do not treat popup emitter as parent of popup) (when used with _ChildWindows or _RootWindow) //ImGuiHoveredFlags_DockHierarchy = 1 << 4, // IsWindowHovered() only: Consider docking hierarchy (treat dockspace host as parent of docked window) (when used with _ChildWindows or _RootWindow) ImGuiHoveredFlags_AllowWhenBlockedByPopup = 1 << 5, // Return true even if a popup window is normally blocking access to this item/window //ImGuiHoveredFlags_AllowWhenBlockedByModal = 1 << 6, // Return true even if a modal popup window is normally blocking access to this item/window. FIXME-TODO: Unavailable yet. ImGuiHoveredFlags_AllowWhenBlockedByActiveItem = 1 << 7, // Return true even if an active item is blocking access to this item/window. Useful for Drag and Drop patterns. ImGuiHoveredFlags_AllowWhenOverlappedByItem = 1 << 8, // IsItemHovered() only: Return true even if the item uses AllowOverlap mode and is overlapped by another hoverable item. ImGuiHoveredFlags_AllowWhenOverlappedByWindow = 1 << 9, // IsItemHovered() only: Return true even if the position is obstructed or overlapped by another window. ImGuiHoveredFlags_AllowWhenDisabled = 1 << 10, // IsItemHovered() only: Return true even if the item is disabled ImGuiHoveredFlags_NoNavOverride = 1 << 11, // IsItemHovered() only: Disable using keyboard/gamepad navigation state when active, always query mouse ImGuiHoveredFlags_AllowWhenOverlapped = ImGuiHoveredFlags_AllowWhenOverlappedByItem | ImGuiHoveredFlags_AllowWhenOverlappedByWindow, ImGuiHoveredFlags_RectOnly = ImGuiHoveredFlags_AllowWhenBlockedByPopup | ImGuiHoveredFlags_AllowWhenBlockedByActiveItem | ImGuiHoveredFlags_AllowWhenOverlapped, ImGuiHoveredFlags_RootAndChildWindows = ImGuiHoveredFlags_RootWindow | ImGuiHoveredFlags_ChildWindows, // Tooltips mode // - typically used in IsItemHovered() + SetTooltip() sequence. // - this is a shortcut to pull flags from 'style.HoverFlagsForTooltipMouse' or 'style.HoverFlagsForTooltipNav' where you can reconfigure desired behavior. // e.g. 'TooltipHoveredFlagsForMouse' defaults to 'ImGuiHoveredFlags_Stationary | ImGuiHoveredFlags_DelayShort'. // - for frequently actioned or hovered items providing a tooltip, you want may to use ImGuiHoveredFlags_ForTooltip (stationary + delay) so the tooltip doesn't show too often. // - for items which main purpose is to be hovered, or items with low affordance, or in less consistent apps, prefer no delay or shorter delay. ImGuiHoveredFlags_ForTooltip = 1 << 12, // Shortcut for standard flags when using IsItemHovered() + SetTooltip() sequence. // (Advanced) Mouse Hovering delays. // - generally you can use ImGuiHoveredFlags_ForTooltip to use application-standardized flags. // - use those if you need specific overrides. ImGuiHoveredFlags_Stationary = 1 << 13, // Require mouse to be stationary for style.HoverStationaryDelay (~0.15 sec) _at least one time_. After this, can move on same item/window. Using the stationary test tends to reduces the need for a long delay. ImGuiHoveredFlags_DelayNone = 1 << 14, // IsItemHovered() only: Return true immediately (default). As this is the default you generally ignore this. ImGuiHoveredFlags_DelayShort = 1 << 15, // IsItemHovered() only: Return true after style.HoverDelayShort elapsed (~0.15 sec) (shared between items) + requires mouse to be stationary for style.HoverStationaryDelay (once per item). ImGuiHoveredFlags_DelayNormal = 1 << 16, // IsItemHovered() only: Return true after style.HoverDelayNormal elapsed (~0.40 sec) (shared between items) + requires mouse to be stationary for style.HoverStationaryDelay (once per item). ImGuiHoveredFlags_NoSharedDelay = 1 << 17, // IsItemHovered() only: Disable shared delay system where moving from one item to the next keeps the previous timer for a short time (standard for tooltips with long delays) }; // Flags for ImGui::BeginDragDropSource(), ImGui::AcceptDragDropPayload() enum ImGuiDragDropFlags_ { ImGuiDragDropFlags_None = 0, // BeginDragDropSource() flags ImGuiDragDropFlags_SourceNoPreviewTooltip = 1 << 0, // Disable preview tooltip. By default, a successful call to BeginDragDropSource opens a tooltip so you can display a preview or description of the source contents. This flag disables this behavior. ImGuiDragDropFlags_SourceNoDisableHover = 1 << 1, // By default, when dragging we clear data so that IsItemHovered() will return false, to avoid subsequent user code submitting tooltips. This flag disables this behavior so you can still call IsItemHovered() on the source item. ImGuiDragDropFlags_SourceNoHoldToOpenOthers = 1 << 2, // Disable the behavior that allows to open tree nodes and collapsing header by holding over them while dragging a source item. ImGuiDragDropFlags_SourceAllowNullID = 1 << 3, // Allow items such as Text(), Image() that have no unique identifier to be used as drag source, by manufacturing a temporary identifier based on their window-relative position. This is extremely unusual within the dear imgui ecosystem and so we made it explicit. ImGuiDragDropFlags_SourceExtern = 1 << 4, // External source (from outside of dear imgui), won't attempt to read current item/window info. Will always return true. Only one Extern source can be active simultaneously. ImGuiDragDropFlags_PayloadAutoExpire = 1 << 5, // Automatically expire the payload if the source cease to be submitted (otherwise payloads are persisting while being dragged) ImGuiDragDropFlags_PayloadNoCrossContext = 1 << 6, // Hint to specify that the payload may not be copied outside current dear imgui context. ImGuiDragDropFlags_PayloadNoCrossProcess = 1 << 7, // Hint to specify that the payload may not be copied outside current process. // AcceptDragDropPayload() flags ImGuiDragDropFlags_AcceptBeforeDelivery = 1 << 10, // AcceptDragDropPayload() will returns true even before the mouse button is released. You can then call IsDelivery() to test if the payload needs to be delivered. ImGuiDragDropFlags_AcceptNoDrawDefaultRect = 1 << 11, // Do not draw the default highlight rectangle when hovering over target. ImGuiDragDropFlags_AcceptNoPreviewTooltip = 1 << 12, // Request hiding the BeginDragDropSource tooltip from the BeginDragDropTarget site. ImGuiDragDropFlags_AcceptPeekOnly = ImGuiDragDropFlags_AcceptBeforeDelivery | ImGuiDragDropFlags_AcceptNoDrawDefaultRect, // For peeking ahead and inspecting the payload before delivery. #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS ImGuiDragDropFlags_SourceAutoExpirePayload = ImGuiDragDropFlags_PayloadAutoExpire, // Renamed in 1.90.9 #endif }; // Standard Drag and Drop payload types. You can define you own payload types using short strings. Types starting with '_' are defined by Dear ImGui. #define IMGUI_PAYLOAD_TYPE_COLOR_3F "_COL3F" // float[3]: Standard type for colors, without alpha. User code may use this type. #define IMGUI_PAYLOAD_TYPE_COLOR_4F "_COL4F" // float[4]: Standard type for colors. User code may use this type. // A primary data type enum ImGuiDataType_ { ImGuiDataType_S8, // signed char / char (with sensible compilers) ImGuiDataType_U8, // unsigned char ImGuiDataType_S16, // short ImGuiDataType_U16, // unsigned short ImGuiDataType_S32, // int ImGuiDataType_U32, // unsigned int ImGuiDataType_S64, // long long / __int64 ImGuiDataType_U64, // unsigned long long / unsigned __int64 ImGuiDataType_Float, // float ImGuiDataType_Double, // double ImGuiDataType_Bool, // bool (provided for user convenience, not supported by scalar widgets) ImGuiDataType_String, // char* (provided for user convenience, not supported by scalar widgets) ImGuiDataType_COUNT }; // A cardinal direction enum ImGuiDir : int { ImGuiDir_None = -1, ImGuiDir_Left = 0, ImGuiDir_Right = 1, ImGuiDir_Up = 2, ImGuiDir_Down = 3, ImGuiDir_COUNT }; // A sorting direction enum ImGuiSortDirection : ImU8 { ImGuiSortDirection_None = 0, ImGuiSortDirection_Ascending = 1, // Ascending = 0->9, A->Z etc. ImGuiSortDirection_Descending = 2 // Descending = 9->0, Z->A etc. }; // A key identifier (ImGuiKey_XXX or ImGuiMod_XXX value): can represent Keyboard, Mouse and Gamepad values. // All our named keys are >= 512. Keys value 0 to 511 are left unused and were legacy native/opaque key values (< 1.87). // Support for legacy keys was completely removed in 1.91.5. // Read details about the 1.87+ transition : https://github.com/ocornut/imgui/issues/4921 // Note that "Keys" related to physical keys and are not the same concept as input "Characters", the later are submitted via io.AddInputCharacter(). // The keyboard key enum values are named after the keys on a standard US keyboard, and on other keyboard types the keys reported may not match the keycaps. enum ImGuiKey : int { // Keyboard ImGuiKey_None = 0, ImGuiKey_NamedKey_BEGIN = 512, // First valid key value (other than 0) ImGuiKey_Tab = 512, // == ImGuiKey_NamedKey_BEGIN ImGuiKey_LeftArrow, ImGuiKey_RightArrow, ImGuiKey_UpArrow, ImGuiKey_DownArrow, ImGuiKey_PageUp, ImGuiKey_PageDown, ImGuiKey_Home, ImGuiKey_End, ImGuiKey_Insert, ImGuiKey_Delete, ImGuiKey_Backspace, ImGuiKey_Space, ImGuiKey_Enter, ImGuiKey_Escape, ImGuiKey_LeftCtrl, ImGuiKey_LeftShift, ImGuiKey_LeftAlt, ImGuiKey_LeftSuper, ImGuiKey_RightCtrl, ImGuiKey_RightShift, ImGuiKey_RightAlt, ImGuiKey_RightSuper, ImGuiKey_Menu, ImGuiKey_0, ImGuiKey_1, ImGuiKey_2, ImGuiKey_3, ImGuiKey_4, ImGuiKey_5, ImGuiKey_6, ImGuiKey_7, ImGuiKey_8, ImGuiKey_9, ImGuiKey_A, ImGuiKey_B, ImGuiKey_C, ImGuiKey_D, ImGuiKey_E, ImGuiKey_F, ImGuiKey_G, ImGuiKey_H, ImGuiKey_I, ImGuiKey_J, ImGuiKey_K, ImGuiKey_L, ImGuiKey_M, ImGuiKey_N, ImGuiKey_O, ImGuiKey_P, ImGuiKey_Q, ImGuiKey_R, ImGuiKey_S, ImGuiKey_T, ImGuiKey_U, ImGuiKey_V, ImGuiKey_W, ImGuiKey_X, ImGuiKey_Y, ImGuiKey_Z, ImGuiKey_F1, ImGuiKey_F2, ImGuiKey_F3, ImGuiKey_F4, ImGuiKey_F5, ImGuiKey_F6, ImGuiKey_F7, ImGuiKey_F8, ImGuiKey_F9, ImGuiKey_F10, ImGuiKey_F11, ImGuiKey_F12, ImGuiKey_F13, ImGuiKey_F14, ImGuiKey_F15, ImGuiKey_F16, ImGuiKey_F17, ImGuiKey_F18, ImGuiKey_F19, ImGuiKey_F20, ImGuiKey_F21, ImGuiKey_F22, ImGuiKey_F23, ImGuiKey_F24, ImGuiKey_Apostrophe, // ' ImGuiKey_Comma, // , ImGuiKey_Minus, // - ImGuiKey_Period, // . ImGuiKey_Slash, // / ImGuiKey_Semicolon, // ; ImGuiKey_Equal, // = ImGuiKey_LeftBracket, // [ ImGuiKey_Backslash, // \ (this text inhibit multiline comment caused by backslash) ImGuiKey_RightBracket, // ] ImGuiKey_GraveAccent, // ` ImGuiKey_CapsLock, ImGuiKey_ScrollLock, ImGuiKey_NumLock, ImGuiKey_PrintScreen, ImGuiKey_Pause, ImGuiKey_Keypad0, ImGuiKey_Keypad1, ImGuiKey_Keypad2, ImGuiKey_Keypad3, ImGuiKey_Keypad4, ImGuiKey_Keypad5, ImGuiKey_Keypad6, ImGuiKey_Keypad7, ImGuiKey_Keypad8, ImGuiKey_Keypad9, ImGuiKey_KeypadDecimal, ImGuiKey_KeypadDivide, ImGuiKey_KeypadMultiply, ImGuiKey_KeypadSubtract, ImGuiKey_KeypadAdd, ImGuiKey_KeypadEnter, ImGuiKey_KeypadEqual, ImGuiKey_AppBack, // Available on some keyboard/mouses. Often referred as "Browser Back" ImGuiKey_AppForward, ImGuiKey_Oem102, // Non-US backslash. // Gamepad (some of those are analog values, 0.0f to 1.0f) // NAVIGATION ACTION // (download controller mapping PNG/PSD at http://dearimgui.com/controls_sheets) ImGuiKey_GamepadStart, // Menu (Xbox) + (Switch) Start/Options (PS) ImGuiKey_GamepadBack, // View (Xbox) - (Switch) Share (PS) ImGuiKey_GamepadFaceLeft, // X (Xbox) Y (Switch) Square (PS) // Tap: Toggle Menu. Hold: Windowing mode (Focus/Move/Resize windows) ImGuiKey_GamepadFaceRight, // B (Xbox) A (Switch) Circle (PS) // Cancel / Close / Exit ImGuiKey_GamepadFaceUp, // Y (Xbox) X (Switch) Triangle (PS) // Text Input / On-screen Keyboard ImGuiKey_GamepadFaceDown, // A (Xbox) B (Switch) Cross (PS) // Activate / Open / Toggle / Tweak ImGuiKey_GamepadDpadLeft, // D-pad Left // Move / Tweak / Resize Window (in Windowing mode) ImGuiKey_GamepadDpadRight, // D-pad Right // Move / Tweak / Resize Window (in Windowing mode) ImGuiKey_GamepadDpadUp, // D-pad Up // Move / Tweak / Resize Window (in Windowing mode) ImGuiKey_GamepadDpadDown, // D-pad Down // Move / Tweak / Resize Window (in Windowing mode) ImGuiKey_GamepadL1, // L Bumper (Xbox) L (Switch) L1 (PS) // Tweak Slower / Focus Previous (in Windowing mode) ImGuiKey_GamepadR1, // R Bumper (Xbox) R (Switch) R1 (PS) // Tweak Faster / Focus Next (in Windowing mode) ImGuiKey_GamepadL2, // L Trig. (Xbox) ZL (Switch) L2 (PS) [Analog] ImGuiKey_GamepadR2, // R Trig. (Xbox) ZR (Switch) R2 (PS) [Analog] ImGuiKey_GamepadL3, // L Stick (Xbox) L3 (Switch) L3 (PS) ImGuiKey_GamepadR3, // R Stick (Xbox) R3 (Switch) R3 (PS) ImGuiKey_GamepadLStickLeft, // [Analog] // Move Window (in Windowing mode) ImGuiKey_GamepadLStickRight, // [Analog] // Move Window (in Windowing mode) ImGuiKey_GamepadLStickUp, // [Analog] // Move Window (in Windowing mode) ImGuiKey_GamepadLStickDown, // [Analog] // Move Window (in Windowing mode) ImGuiKey_GamepadRStickLeft, // [Analog] ImGuiKey_GamepadRStickRight, // [Analog] ImGuiKey_GamepadRStickUp, // [Analog] ImGuiKey_GamepadRStickDown, // [Analog] // Aliases: Mouse Buttons (auto-submitted from AddMouseButtonEvent() calls) // - This is mirroring the data also written to io.MouseDown[], io.MouseWheel, in a format allowing them to be accessed via standard key API. ImGuiKey_MouseLeft, ImGuiKey_MouseRight, ImGuiKey_MouseMiddle, ImGuiKey_MouseX1, ImGuiKey_MouseX2, ImGuiKey_MouseWheelX, ImGuiKey_MouseWheelY, // [Internal] Reserved for mod storage ImGuiKey_ReservedForModCtrl, ImGuiKey_ReservedForModShift, ImGuiKey_ReservedForModAlt, ImGuiKey_ReservedForModSuper, ImGuiKey_NamedKey_END, // Keyboard Modifiers (explicitly submitted by backend via AddKeyEvent() calls) // - This is mirroring the data also written to io.KeyCtrl, io.KeyShift, io.KeyAlt, io.KeySuper, in a format allowing // them to be accessed via standard key API, allowing calls such as IsKeyPressed(), IsKeyReleased(), querying duration etc. // - Code polling every key (e.g. an interface to detect a key press for input mapping) might want to ignore those // and prefer using the real keys (e.g. ImGuiKey_LeftCtrl, ImGuiKey_RightCtrl instead of ImGuiMod_Ctrl). // - In theory the value of keyboard modifiers should be roughly equivalent to a logical or of the equivalent left/right keys. // In practice: it's complicated; mods are often provided from different sources. Keyboard layout, IME, sticky keys and // backends tend to interfere and break that equivalence. The safer decision is to relay that ambiguity down to the end-user... // - On macOS, we swap Cmd(Super) and Ctrl keys at the time of the io.AddKeyEvent() call. ImGuiMod_None = 0, ImGuiMod_Ctrl = 1 << 12, // Ctrl (non-macOS), Cmd (macOS) ImGuiMod_Shift = 1 << 13, // Shift ImGuiMod_Alt = 1 << 14, // Option/Menu ImGuiMod_Super = 1 << 15, // Windows/Super (non-macOS), Ctrl (macOS) ImGuiMod_Mask_ = 0xF000, // 4-bits // [Internal] If you need to iterate all keys (for e.g. an input mapper) you may use ImGuiKey_NamedKey_BEGIN..ImGuiKey_NamedKey_END. ImGuiKey_NamedKey_COUNT = ImGuiKey_NamedKey_END - ImGuiKey_NamedKey_BEGIN, //ImGuiKey_KeysData_SIZE = ImGuiKey_NamedKey_COUNT, // Size of KeysData[]: only hold named keys //ImGuiKey_KeysData_OFFSET = ImGuiKey_NamedKey_BEGIN, // Accesses to io.KeysData[] must use (key - ImGuiKey_NamedKey_BEGIN) index. #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS ImGuiKey_COUNT = ImGuiKey_NamedKey_END, // Obsoleted in 1.91.5 because it was extremely misleading (since named keys don't start at 0 anymore) ImGuiMod_Shortcut = ImGuiMod_Ctrl, // Removed in 1.90.7, you can now simply use ImGuiMod_Ctrl ImGuiKey_ModCtrl = ImGuiMod_Ctrl, ImGuiKey_ModShift = ImGuiMod_Shift, ImGuiKey_ModAlt = ImGuiMod_Alt, ImGuiKey_ModSuper = ImGuiMod_Super, // Renamed in 1.89 //ImGuiKey_KeyPadEnter = ImGuiKey_KeypadEnter, // Renamed in 1.87 #endif }; // Flags for Shortcut(), SetNextItemShortcut(), // (and for upcoming extended versions of IsKeyPressed(), IsMouseClicked(), Shortcut(), SetKeyOwner(), SetItemKeyOwner() that are still in imgui_internal.h) // Don't mistake with ImGuiInputTextFlags! (which is for ImGui::InputText() function) enum ImGuiInputFlags_ { ImGuiInputFlags_None = 0, ImGuiInputFlags_Repeat = 1 << 0, // Enable repeat. Return true on successive repeats. Default for legacy IsKeyPressed(). NOT Default for legacy IsMouseClicked(). MUST BE == 1. // Flags for Shortcut(), SetNextItemShortcut() // - Routing policies: RouteGlobal+OverActive >> RouteActive or RouteFocused (if owner is active item) >> RouteGlobal+OverFocused >> RouteFocused (if in focused window stack) >> RouteGlobal. // - Default policy is RouteFocused. Can select only 1 policy among all available. ImGuiInputFlags_RouteActive = 1 << 10, // Route to active item only. ImGuiInputFlags_RouteFocused = 1 << 11, // Route to windows in the focus stack (DEFAULT). Deep-most focused window takes inputs. Active item takes inputs over deep-most focused window. ImGuiInputFlags_RouteGlobal = 1 << 12, // Global route (unless a focused window or active item registered the route). ImGuiInputFlags_RouteAlways = 1 << 13, // Do not register route, poll keys directly. // - Routing options ImGuiInputFlags_RouteOverFocused = 1 << 14, // Option: global route: higher priority than focused route (unless active item in focused route). ImGuiInputFlags_RouteOverActive = 1 << 15, // Option: global route: higher priority than active item. Unlikely you need to use that: will interfere with every active items, e.g. CTRL+A registered by InputText will be overridden by this. May not be fully honored as user/internal code is likely to always assume they can access keys when active. ImGuiInputFlags_RouteUnlessBgFocused = 1 << 16, // Option: global route: will not be applied if underlying background/void is focused (== no Dear ImGui windows are focused). Useful for overlay applications. ImGuiInputFlags_RouteFromRootWindow = 1 << 17, // Option: route evaluated from the point of view of root window rather than current window. // Flags for SetNextItemShortcut() ImGuiInputFlags_Tooltip = 1 << 18, // Automatically display a tooltip when hovering item [BETA] Unsure of right api (opt-in/opt-out) }; // Configuration flags stored in io.ConfigFlags. Set by user/application. enum ImGuiConfigFlags_ { ImGuiConfigFlags_None = 0, ImGuiConfigFlags_NavEnableKeyboard = 1 << 0, // Master keyboard navigation enable flag. Enable full Tabbing + directional arrows + space/enter to activate. ImGuiConfigFlags_NavEnableGamepad = 1 << 1, // Master gamepad navigation enable flag. Backend also needs to set ImGuiBackendFlags_HasGamepad. ImGuiConfigFlags_NoMouse = 1 << 4, // Instruct dear imgui to disable mouse inputs and interactions. ImGuiConfigFlags_NoMouseCursorChange = 1 << 5, // Instruct backend to not alter mouse cursor shape and visibility. Use if the backend cursor changes are interfering with yours and you don't want to use SetMouseCursor() to change mouse cursor. You may want to honor requests from imgui by reading GetMouseCursor() yourself instead. ImGuiConfigFlags_NoKeyboard = 1 << 6, // Instruct dear imgui to disable keyboard inputs and interactions. This is done by ignoring keyboard events and clearing existing states. // User storage (to allow your backend/engine to communicate to code that may be shared between multiple projects. Those flags are NOT used by core Dear ImGui) ImGuiConfigFlags_IsSRGB = 1 << 20, // Application is SRGB-aware. ImGuiConfigFlags_IsTouchScreen = 1 << 21, // Application is using a touch screen instead of a mouse. #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS ImGuiConfigFlags_NavEnableSetMousePos = 1 << 2, // [moved/renamed in 1.91.4] -> use bool io.ConfigNavMoveSetMousePos ImGuiConfigFlags_NavNoCaptureKeyboard = 1 << 3, // [moved/renamed in 1.91.4] -> use bool io.ConfigNavCaptureKeyboard #endif }; // Backend capabilities flags stored in io.BackendFlags. Set by imgui_impl_xxx or custom backend. enum ImGuiBackendFlags_ { ImGuiBackendFlags_None = 0, ImGuiBackendFlags_HasGamepad = 1 << 0, // Backend Platform supports gamepad and currently has one connected. ImGuiBackendFlags_HasMouseCursors = 1 << 1, // Backend Platform supports honoring GetMouseCursor() value to change the OS cursor shape. ImGuiBackendFlags_HasSetMousePos = 1 << 2, // Backend Platform supports io.WantSetMousePos requests to reposition the OS mouse position (only used if io.ConfigNavMoveSetMousePos is set). ImGuiBackendFlags_RendererHasVtxOffset = 1 << 3, // Backend Renderer supports ImDrawCmd::VtxOffset. This enables output of large meshes (64K+ vertices) while still using 16-bit indices. }; // Enumeration for PushStyleColor() / PopStyleColor() enum ImGuiCol_ { ImGuiCol_Text, ImGuiCol_TextDisabled, ImGuiCol_WindowBg, // Background of normal windows ImGuiCol_ChildBg, // Background of child windows ImGuiCol_PopupBg, // Background of popups, menus, tooltips windows ImGuiCol_Border, ImGuiCol_BorderShadow, ImGuiCol_FrameBg, // Background of checkbox, radio button, plot, slider, text input ImGuiCol_FrameBgHovered, ImGuiCol_FrameBgActive, ImGuiCol_TitleBg, // Title bar ImGuiCol_TitleBgActive, // Title bar when focused ImGuiCol_TitleBgCollapsed, // Title bar when collapsed ImGuiCol_MenuBarBg, ImGuiCol_ScrollbarBg, ImGuiCol_ScrollbarGrab, ImGuiCol_ScrollbarGrabHovered, ImGuiCol_ScrollbarGrabActive, ImGuiCol_CheckMark, // Checkbox tick and RadioButton circle ImGuiCol_SliderGrab, ImGuiCol_SliderGrabActive, ImGuiCol_Button, ImGuiCol_ButtonHovered, ImGuiCol_ButtonActive, ImGuiCol_Header, // Header* colors are used for CollapsingHeader, TreeNode, Selectable, MenuItem ImGuiCol_HeaderHovered, ImGuiCol_HeaderActive, ImGuiCol_Separator, ImGuiCol_SeparatorHovered, ImGuiCol_SeparatorActive, ImGuiCol_ResizeGrip, // Resize grip in lower-right and lower-left corners of windows. ImGuiCol_ResizeGripHovered, ImGuiCol_ResizeGripActive, ImGuiCol_TabHovered, // Tab background, when hovered ImGuiCol_Tab, // Tab background, when tab-bar is focused & tab is unselected ImGuiCol_TabSelected, // Tab background, when tab-bar is focused & tab is selected ImGuiCol_TabSelectedOverline, // Tab horizontal overline, when tab-bar is focused & tab is selected ImGuiCol_TabDimmed, // Tab background, when tab-bar is unfocused & tab is unselected ImGuiCol_TabDimmedSelected, // Tab background, when tab-bar is unfocused & tab is selected ImGuiCol_TabDimmedSelectedOverline,//..horizontal overline, when tab-bar is unfocused & tab is selected ImGuiCol_PlotLines, ImGuiCol_PlotLinesHovered, ImGuiCol_PlotHistogram, ImGuiCol_PlotHistogramHovered, ImGuiCol_TableHeaderBg, // Table header background ImGuiCol_TableBorderStrong, // Table outer and header borders (prefer using Alpha=1.0 here) ImGuiCol_TableBorderLight, // Table inner borders (prefer using Alpha=1.0 here) ImGuiCol_TableRowBg, // Table row background (even rows) ImGuiCol_TableRowBgAlt, // Table row background (odd rows) ImGuiCol_TextLink, // Hyperlink color ImGuiCol_TextSelectedBg, ImGuiCol_DragDropTarget, // Rectangle highlighting a drop target ImGuiCol_NavCursor, // Color of keyboard/gamepad navigation cursor/rectangle, when visible ImGuiCol_NavWindowingHighlight, // Highlight window when using CTRL+TAB ImGuiCol_NavWindowingDimBg, // Darken/colorize entire screen behind the CTRL+TAB window list, when active ImGuiCol_ModalWindowDimBg, // Darken/colorize entire screen behind a modal window, when one is active ImGuiCol_COUNT, #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS ImGuiCol_TabActive = ImGuiCol_TabSelected, // [renamed in 1.90.9] ImGuiCol_TabUnfocused = ImGuiCol_TabDimmed, // [renamed in 1.90.9] ImGuiCol_TabUnfocusedActive = ImGuiCol_TabDimmedSelected, // [renamed in 1.90.9] ImGuiCol_NavHighlight = ImGuiCol_NavCursor, // [renamed in 1.91.4] #endif }; // Enumeration for PushStyleVar() / PopStyleVar() to temporarily modify the ImGuiStyle structure. // - The enum only refers to fields of ImGuiStyle which makes sense to be pushed/popped inside UI code. // During initialization or between frames, feel free to just poke into ImGuiStyle directly. // - Tip: Use your programming IDE navigation facilities on the names in the _second column_ below to find the actual members and their description. // - In Visual Studio: CTRL+comma ("Edit.GoToAll") can follow symbols inside comments, whereas CTRL+F12 ("Edit.GoToImplementation") cannot. // - In Visual Studio w/ Visual Assist installed: ALT+G ("VAssistX.GoToImplementation") can also follow symbols inside comments. // - In VS Code, CLion, etc.: CTRL+click can follow symbols inside comments. // - When changing this enum, you need to update the associated internal table GStyleVarInfo[] accordingly. This is where we link enum values to members offset/type. enum ImGuiStyleVar_ { // Enum name -------------------------- // Member in ImGuiStyle structure (see ImGuiStyle for descriptions) ImGuiStyleVar_Alpha, // float Alpha ImGuiStyleVar_DisabledAlpha, // float DisabledAlpha ImGuiStyleVar_WindowPadding, // ImVec2 WindowPadding ImGuiStyleVar_WindowRounding, // float WindowRounding ImGuiStyleVar_WindowBorderSize, // float WindowBorderSize ImGuiStyleVar_WindowMinSize, // ImVec2 WindowMinSize ImGuiStyleVar_WindowTitleAlign, // ImVec2 WindowTitleAlign ImGuiStyleVar_ChildRounding, // float ChildRounding ImGuiStyleVar_ChildBorderSize, // float ChildBorderSize ImGuiStyleVar_PopupRounding, // float PopupRounding ImGuiStyleVar_PopupBorderSize, // float PopupBorderSize ImGuiStyleVar_FramePadding, // ImVec2 FramePadding ImGuiStyleVar_FrameRounding, // float FrameRounding ImGuiStyleVar_FrameBorderSize, // float FrameBorderSize ImGuiStyleVar_ItemSpacing, // ImVec2 ItemSpacing ImGuiStyleVar_ItemInnerSpacing, // ImVec2 ItemInnerSpacing ImGuiStyleVar_IndentSpacing, // float IndentSpacing ImGuiStyleVar_CellPadding, // ImVec2 CellPadding ImGuiStyleVar_ScrollbarSize, // float ScrollbarSize ImGuiStyleVar_ScrollbarRounding, // float ScrollbarRounding ImGuiStyleVar_GrabMinSize, // float GrabMinSize ImGuiStyleVar_GrabRounding, // float GrabRounding ImGuiStyleVar_ImageBorderSize, // float ImageBorderSize ImGuiStyleVar_TabRounding, // float TabRounding ImGuiStyleVar_TabBorderSize, // float TabBorderSize ImGuiStyleVar_TabBarBorderSize, // float TabBarBorderSize ImGuiStyleVar_TabBarOverlineSize, // float TabBarOverlineSize ImGuiStyleVar_TableAngledHeadersAngle, // float TableAngledHeadersAngle ImGuiStyleVar_TableAngledHeadersTextAlign,// ImVec2 TableAngledHeadersTextAlign ImGuiStyleVar_ButtonTextAlign, // ImVec2 ButtonTextAlign ImGuiStyleVar_SelectableTextAlign, // ImVec2 SelectableTextAlign ImGuiStyleVar_SeparatorTextBorderSize, // float SeparatorTextBorderSize ImGuiStyleVar_SeparatorTextAlign, // ImVec2 SeparatorTextAlign ImGuiStyleVar_SeparatorTextPadding, // ImVec2 SeparatorTextPadding ImGuiStyleVar_COUNT }; // Flags for InvisibleButton() [extended in imgui_internal.h] enum ImGuiButtonFlags_ { ImGuiButtonFlags_None = 0, ImGuiButtonFlags_MouseButtonLeft = 1 << 0, // React on left mouse button (default) ImGuiButtonFlags_MouseButtonRight = 1 << 1, // React on right mouse button ImGuiButtonFlags_MouseButtonMiddle = 1 << 2, // React on center mouse button ImGuiButtonFlags_MouseButtonMask_ = ImGuiButtonFlags_MouseButtonLeft | ImGuiButtonFlags_MouseButtonRight | ImGuiButtonFlags_MouseButtonMiddle, // [Internal] ImGuiButtonFlags_EnableNav = 1 << 3, // InvisibleButton(): do not disable navigation/tabbing. Otherwise disabled by default. }; // Flags for ColorEdit3() / ColorEdit4() / ColorPicker3() / ColorPicker4() / ColorButton() enum ImGuiColorEditFlags_ { ImGuiColorEditFlags_None = 0, ImGuiColorEditFlags_NoAlpha = 1 << 1, // // ColorEdit, ColorPicker, ColorButton: ignore Alpha component (will only read 3 components from the input pointer). ImGuiColorEditFlags_NoPicker = 1 << 2, // // ColorEdit: disable picker when clicking on color square. ImGuiColorEditFlags_NoOptions = 1 << 3, // // ColorEdit: disable toggling options menu when right-clicking on inputs/small preview. ImGuiColorEditFlags_NoSmallPreview = 1 << 4, // // ColorEdit, ColorPicker: disable color square preview next to the inputs. (e.g. to show only the inputs) ImGuiColorEditFlags_NoInputs = 1 << 5, // // ColorEdit, ColorPicker: disable inputs sliders/text widgets (e.g. to show only the small preview color square). ImGuiColorEditFlags_NoTooltip = 1 << 6, // // ColorEdit, ColorPicker, ColorButton: disable tooltip when hovering the preview. ImGuiColorEditFlags_NoLabel = 1 << 7, // // ColorEdit, ColorPicker: disable display of inline text label (the label is still forwarded to the tooltip and picker). ImGuiColorEditFlags_NoSidePreview = 1 << 8, // // ColorPicker: disable bigger color preview on right side of the picker, use small color square preview instead. ImGuiColorEditFlags_NoDragDrop = 1 << 9, // // ColorEdit: disable drag and drop target. ColorButton: disable drag and drop source. ImGuiColorEditFlags_NoBorder = 1 << 10, // // ColorButton: disable border (which is enforced by default) // Alpha preview // - Prior to 1.91.8 (2025/01/21): alpha was made opaque in the preview by default using old name ImGuiColorEditFlags_AlphaPreview. // - We now display the preview as transparent by default. You can use ImGuiColorEditFlags_AlphaOpaque to use old behavior. // - The new flags may be combined better and allow finer controls. ImGuiColorEditFlags_AlphaOpaque = 1 << 11, // // ColorEdit, ColorPicker, ColorButton: disable alpha in the preview,. Contrary to _NoAlpha it may still be edited when calling ColorEdit4()/ColorPicker4(). For ColorButton() this does the same as _NoAlpha. ImGuiColorEditFlags_AlphaNoBg = 1 << 12, // // ColorEdit, ColorPicker, ColorButton: disable rendering a checkerboard background behind transparent color. ImGuiColorEditFlags_AlphaPreviewHalf= 1 << 13, // // ColorEdit, ColorPicker, ColorButton: display half opaque / half transparent preview. // User Options (right-click on widget to change some of them). ImGuiColorEditFlags_AlphaBar = 1 << 16, // // ColorEdit, ColorPicker: show vertical alpha bar/gradient in picker. ImGuiColorEditFlags_HDR = 1 << 19, // // (WIP) ColorEdit: Currently only disable 0.0f..1.0f limits in RGBA edition (note: you probably want to use ImGuiColorEditFlags_Float flag as well). ImGuiColorEditFlags_DisplayRGB = 1 << 20, // [Display] // ColorEdit: override _display_ type among RGB/HSV/Hex. ColorPicker: select any combination using one or more of RGB/HSV/Hex. ImGuiColorEditFlags_DisplayHSV = 1 << 21, // [Display] // " ImGuiColorEditFlags_DisplayHex = 1 << 22, // [Display] // " ImGuiColorEditFlags_Uint8 = 1 << 23, // [DataType] // ColorEdit, ColorPicker, ColorButton: _display_ values formatted as 0..255. ImGuiColorEditFlags_Float = 1 << 24, // [DataType] // ColorEdit, ColorPicker, ColorButton: _display_ values formatted as 0.0f..1.0f floats instead of 0..255 integers. No round-trip of value via integers. ImGuiColorEditFlags_PickerHueBar = 1 << 25, // [Picker] // ColorPicker: bar for Hue, rectangle for Sat/Value. ImGuiColorEditFlags_PickerHueWheel = 1 << 26, // [Picker] // ColorPicker: wheel for Hue, triangle for Sat/Value. ImGuiColorEditFlags_InputRGB = 1 << 27, // [Input] // ColorEdit, ColorPicker: input and output data in RGB format. ImGuiColorEditFlags_InputHSV = 1 << 28, // [Input] // ColorEdit, ColorPicker: input and output data in HSV format. // Defaults Options. You can set application defaults using SetColorEditOptions(). The intent is that you probably don't want to // override them in most of your calls. Let the user choose via the option menu and/or call SetColorEditOptions() once during startup. ImGuiColorEditFlags_DefaultOptions_ = ImGuiColorEditFlags_Uint8 | ImGuiColorEditFlags_DisplayRGB | ImGuiColorEditFlags_InputRGB | ImGuiColorEditFlags_PickerHueBar, // [Internal] Masks ImGuiColorEditFlags_AlphaMask_ = ImGuiColorEditFlags_NoAlpha | ImGuiColorEditFlags_AlphaOpaque | ImGuiColorEditFlags_AlphaNoBg | ImGuiColorEditFlags_AlphaPreviewHalf, ImGuiColorEditFlags_DisplayMask_ = ImGuiColorEditFlags_DisplayRGB | ImGuiColorEditFlags_DisplayHSV | ImGuiColorEditFlags_DisplayHex, ImGuiColorEditFlags_DataTypeMask_ = ImGuiColorEditFlags_Uint8 | ImGuiColorEditFlags_Float, ImGuiColorEditFlags_PickerMask_ = ImGuiColorEditFlags_PickerHueWheel | ImGuiColorEditFlags_PickerHueBar, ImGuiColorEditFlags_InputMask_ = ImGuiColorEditFlags_InputRGB | ImGuiColorEditFlags_InputHSV, // Obsolete names #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS ImGuiColorEditFlags_AlphaPreview = 0, // [Removed in 1.91.8] This is the default now. Will display a checkerboard unless ImGuiColorEditFlags_AlphaNoBg is set. #endif //ImGuiColorEditFlags_RGB = ImGuiColorEditFlags_DisplayRGB, ImGuiColorEditFlags_HSV = ImGuiColorEditFlags_DisplayHSV, ImGuiColorEditFlags_HEX = ImGuiColorEditFlags_DisplayHex // [renamed in 1.69] }; // Flags for DragFloat(), DragInt(), SliderFloat(), SliderInt() etc. // We use the same sets of flags for DragXXX() and SliderXXX() functions as the features are the same and it makes it easier to swap them. // (Those are per-item flags. There is shared behavior flag too: ImGuiIO: io.ConfigDragClickToInputText) enum ImGuiSliderFlags_ { ImGuiSliderFlags_None = 0, ImGuiSliderFlags_Logarithmic = 1 << 5, // Make the widget logarithmic (linear otherwise). Consider using ImGuiSliderFlags_NoRoundToFormat with this if using a format-string with small amount of digits. ImGuiSliderFlags_NoRoundToFormat = 1 << 6, // Disable rounding underlying value to match precision of the display format string (e.g. %.3f values are rounded to those 3 digits). ImGuiSliderFlags_NoInput = 1 << 7, // Disable CTRL+Click or Enter key allowing to input text directly into the widget. ImGuiSliderFlags_WrapAround = 1 << 8, // Enable wrapping around from max to min and from min to max. Only supported by DragXXX() functions for now. ImGuiSliderFlags_ClampOnInput = 1 << 9, // Clamp value to min/max bounds when input manually with CTRL+Click. By default CTRL+Click allows going out of bounds. ImGuiSliderFlags_ClampZeroRange = 1 << 10, // Clamp even if min==max==0.0f. Otherwise due to legacy reason DragXXX functions don't clamp with those values. When your clamping limits are dynamic you almost always want to use it. ImGuiSliderFlags_NoSpeedTweaks = 1 << 11, // Disable keyboard modifiers altering tweak speed. Useful if you want to alter tweak speed yourself based on your own logic. ImGuiSliderFlags_AlwaysClamp = ImGuiSliderFlags_ClampOnInput | ImGuiSliderFlags_ClampZeroRange, ImGuiSliderFlags_InvalidMask_ = 0x7000000F, // [Internal] We treat using those bits as being potentially a 'float power' argument from the previous API that has got miscast to this enum, and will trigger an assert if needed. }; // Identify a mouse button. // Those values are guaranteed to be stable and we frequently use 0/1 directly. Named enums provided for convenience. enum ImGuiMouseButton_ { ImGuiMouseButton_Left = 0, ImGuiMouseButton_Right = 1, ImGuiMouseButton_Middle = 2, ImGuiMouseButton_COUNT = 5 }; // Enumeration for GetMouseCursor() // User code may request backend to display given cursor by calling SetMouseCursor(), which is why we have some cursors that are marked unused here enum ImGuiMouseCursor_ { ImGuiMouseCursor_None = -1, ImGuiMouseCursor_Arrow = 0, ImGuiMouseCursor_TextInput, // When hovering over InputText, etc. ImGuiMouseCursor_ResizeAll, // (Unused by Dear ImGui functions) ImGuiMouseCursor_ResizeNS, // When hovering over a horizontal border ImGuiMouseCursor_ResizeEW, // When hovering over a vertical border or a column ImGuiMouseCursor_ResizeNESW, // When hovering over the bottom-left corner of a window ImGuiMouseCursor_ResizeNWSE, // When hovering over the bottom-right corner of a window ImGuiMouseCursor_Hand, // (Unused by Dear ImGui functions. Use for e.g. hyperlinks) ImGuiMouseCursor_Wait, // When waiting for something to process/load. ImGuiMouseCursor_Progress, // When waiting for something to process/load, but application is still interactive. ImGuiMouseCursor_NotAllowed, // When hovering something with disallowed interaction. Usually a crossed circle. ImGuiMouseCursor_COUNT }; // Enumeration for AddMouseSourceEvent() actual source of Mouse Input data. // Historically we use "Mouse" terminology everywhere to indicate pointer data, e.g. MousePos, IsMousePressed(), io.AddMousePosEvent() // But that "Mouse" data can come from different source which occasionally may be useful for application to know about. // You can submit a change of pointer type using io.AddMouseSourceEvent(). enum ImGuiMouseSource : int { ImGuiMouseSource_Mouse = 0, // Input is coming from an actual mouse. ImGuiMouseSource_TouchScreen, // Input is coming from a touch screen (no hovering prior to initial press, less precise initial press aiming, dual-axis wheeling possible). ImGuiMouseSource_Pen, // Input is coming from a pressure/magnetic pen (often used in conjunction with high-sampling rates). ImGuiMouseSource_COUNT }; // Enumeration for ImGui::SetNextWindow***(), SetWindow***(), SetNextItem***() functions // Represent a condition. // Important: Treat as a regular enum! Do NOT combine multiple values using binary operators! All the functions above treat 0 as a shortcut to ImGuiCond_Always. enum ImGuiCond_ { ImGuiCond_None = 0, // No condition (always set the variable), same as _Always ImGuiCond_Always = 1 << 0, // No condition (always set the variable), same as _None ImGuiCond_Once = 1 << 1, // Set the variable once per runtime session (only the first call will succeed) ImGuiCond_FirstUseEver = 1 << 2, // Set the variable if the object/window has no persistently saved data (no entry in .ini file) ImGuiCond_Appearing = 1 << 3, // Set the variable if the object/window is appearing after being hidden/inactive (or the first time) }; //----------------------------------------------------------------------------- // [SECTION] Tables API flags and structures (ImGuiTableFlags, ImGuiTableColumnFlags, ImGuiTableRowFlags, ImGuiTableBgTarget, ImGuiTableSortSpecs, ImGuiTableColumnSortSpecs) //----------------------------------------------------------------------------- // Flags for ImGui::BeginTable() // - Important! Sizing policies have complex and subtle side effects, much more so than you would expect. // Read comments/demos carefully + experiment with live demos to get acquainted with them. // - The DEFAULT sizing policies are: // - Default to ImGuiTableFlags_SizingFixedFit if ScrollX is on, or if host window has ImGuiWindowFlags_AlwaysAutoResize. // - Default to ImGuiTableFlags_SizingStretchSame if ScrollX is off. // - When ScrollX is off: // - Table defaults to ImGuiTableFlags_SizingStretchSame -> all Columns defaults to ImGuiTableColumnFlags_WidthStretch with same weight. // - Columns sizing policy allowed: Stretch (default), Fixed/Auto. // - Fixed Columns (if any) will generally obtain their requested width (unless the table cannot fit them all). // - Stretch Columns will share the remaining width according to their respective weight. // - Mixed Fixed/Stretch columns is possible but has various side-effects on resizing behaviors. // The typical use of mixing sizing policies is: any number of LEADING Fixed columns, followed by one or two TRAILING Stretch columns. // (this is because the visible order of columns have subtle but necessary effects on how they react to manual resizing). // - When ScrollX is on: // - Table defaults to ImGuiTableFlags_SizingFixedFit -> all Columns defaults to ImGuiTableColumnFlags_WidthFixed // - Columns sizing policy allowed: Fixed/Auto mostly. // - Fixed Columns can be enlarged as needed. Table will show a horizontal scrollbar if needed. // - When using auto-resizing (non-resizable) fixed columns, querying the content width to use item right-alignment e.g. SetNextItemWidth(-FLT_MIN) doesn't make sense, would create a feedback loop. // - Using Stretch columns OFTEN DOES NOT MAKE SENSE if ScrollX is on, UNLESS you have specified a value for 'inner_width' in BeginTable(). // If you specify a value for 'inner_width' then effectively the scrolling space is known and Stretch or mixed Fixed/Stretch columns become meaningful again. // - Read on documentation at the top of imgui_tables.cpp for details. enum ImGuiTableFlags_ { // Features ImGuiTableFlags_None = 0, ImGuiTableFlags_Resizable = 1 << 0, // Enable resizing columns. ImGuiTableFlags_Reorderable = 1 << 1, // Enable reordering columns in header row (need calling TableSetupColumn() + TableHeadersRow() to display headers) ImGuiTableFlags_Hideable = 1 << 2, // Enable hiding/disabling columns in context menu. ImGuiTableFlags_Sortable = 1 << 3, // Enable sorting. Call TableGetSortSpecs() to obtain sort specs. Also see ImGuiTableFlags_SortMulti and ImGuiTableFlags_SortTristate. ImGuiTableFlags_NoSavedSettings = 1 << 4, // Disable persisting columns order, width and sort settings in the .ini file. ImGuiTableFlags_ContextMenuInBody = 1 << 5, // Right-click on columns body/contents will display table context menu. By default it is available in TableHeadersRow(). // Decorations ImGuiTableFlags_RowBg = 1 << 6, // Set each RowBg color with ImGuiCol_TableRowBg or ImGuiCol_TableRowBgAlt (equivalent of calling TableSetBgColor with ImGuiTableBgFlags_RowBg0 on each row manually) ImGuiTableFlags_BordersInnerH = 1 << 7, // Draw horizontal borders between rows. ImGuiTableFlags_BordersOuterH = 1 << 8, // Draw horizontal borders at the top and bottom. ImGuiTableFlags_BordersInnerV = 1 << 9, // Draw vertical borders between columns. ImGuiTableFlags_BordersOuterV = 1 << 10, // Draw vertical borders on the left and right sides. ImGuiTableFlags_BordersH = ImGuiTableFlags_BordersInnerH | ImGuiTableFlags_BordersOuterH, // Draw horizontal borders. ImGuiTableFlags_BordersV = ImGuiTableFlags_BordersInnerV | ImGuiTableFlags_BordersOuterV, // Draw vertical borders. ImGuiTableFlags_BordersInner = ImGuiTableFlags_BordersInnerV | ImGuiTableFlags_BordersInnerH, // Draw inner borders. ImGuiTableFlags_BordersOuter = ImGuiTableFlags_BordersOuterV | ImGuiTableFlags_BordersOuterH, // Draw outer borders. ImGuiTableFlags_Borders = ImGuiTableFlags_BordersInner | ImGuiTableFlags_BordersOuter, // Draw all borders. ImGuiTableFlags_NoBordersInBody = 1 << 11, // [ALPHA] Disable vertical borders in columns Body (borders will always appear in Headers). -> May move to style ImGuiTableFlags_NoBordersInBodyUntilResize = 1 << 12, // [ALPHA] Disable vertical borders in columns Body until hovered for resize (borders will always appear in Headers). -> May move to style // Sizing Policy (read above for defaults) ImGuiTableFlags_SizingFixedFit = 1 << 13, // Columns default to _WidthFixed or _WidthAuto (if resizable or not resizable), matching contents width. ImGuiTableFlags_SizingFixedSame = 2 << 13, // Columns default to _WidthFixed or _WidthAuto (if resizable or not resizable), matching the maximum contents width of all columns. Implicitly enable ImGuiTableFlags_NoKeepColumnsVisible. ImGuiTableFlags_SizingStretchProp = 3 << 13, // Columns default to _WidthStretch with default weights proportional to each columns contents widths. ImGuiTableFlags_SizingStretchSame = 4 << 13, // Columns default to _WidthStretch with default weights all equal, unless overridden by TableSetupColumn(). // Sizing Extra Options ImGuiTableFlags_NoHostExtendX = 1 << 16, // Make outer width auto-fit to columns, overriding outer_size.x value. Only available when ScrollX/ScrollY are disabled and Stretch columns are not used. ImGuiTableFlags_NoHostExtendY = 1 << 17, // Make outer height stop exactly at outer_size.y (prevent auto-extending table past the limit). Only available when ScrollX/ScrollY are disabled. Data below the limit will be clipped and not visible. ImGuiTableFlags_NoKeepColumnsVisible = 1 << 18, // Disable keeping column always minimally visible when ScrollX is off and table gets too small. Not recommended if columns are resizable. ImGuiTableFlags_PreciseWidths = 1 << 19, // Disable distributing remainder width to stretched columns (width allocation on a 100-wide table with 3 columns: Without this flag: 33,33,34. With this flag: 33,33,33). With larger number of columns, resizing will appear to be less smooth. // Clipping ImGuiTableFlags_NoClip = 1 << 20, // Disable clipping rectangle for every individual columns (reduce draw command count, items will be able to overflow into other columns). Generally incompatible with TableSetupScrollFreeze(). // Padding ImGuiTableFlags_PadOuterX = 1 << 21, // Default if BordersOuterV is on. Enable outermost padding. Generally desirable if you have headers. ImGuiTableFlags_NoPadOuterX = 1 << 22, // Default if BordersOuterV is off. Disable outermost padding. ImGuiTableFlags_NoPadInnerX = 1 << 23, // Disable inner padding between columns (double inner padding if BordersOuterV is on, single inner padding if BordersOuterV is off). // Scrolling ImGuiTableFlags_ScrollX = 1 << 24, // Enable horizontal scrolling. Require 'outer_size' parameter of BeginTable() to specify the container size. Changes default sizing policy. Because this creates a child window, ScrollY is currently generally recommended when using ScrollX. ImGuiTableFlags_ScrollY = 1 << 25, // Enable vertical scrolling. Require 'outer_size' parameter of BeginTable() to specify the container size. // Sorting ImGuiTableFlags_SortMulti = 1 << 26, // Hold shift when clicking headers to sort on multiple column. TableGetSortSpecs() may return specs where (SpecsCount > 1). ImGuiTableFlags_SortTristate = 1 << 27, // Allow no sorting, disable default sorting. TableGetSortSpecs() may return specs where (SpecsCount == 0). // Miscellaneous ImGuiTableFlags_HighlightHoveredColumn = 1 << 28, // Highlight column headers when hovered (may evolve into a fuller highlight) // [Internal] Combinations and masks ImGuiTableFlags_SizingMask_ = ImGuiTableFlags_SizingFixedFit | ImGuiTableFlags_SizingFixedSame | ImGuiTableFlags_SizingStretchProp | ImGuiTableFlags_SizingStretchSame, }; // Flags for ImGui::TableSetupColumn() enum ImGuiTableColumnFlags_ { // Input configuration flags ImGuiTableColumnFlags_None = 0, ImGuiTableColumnFlags_Disabled = 1 << 0, // Overriding/master disable flag: hide column, won't show in context menu (unlike calling TableSetColumnEnabled() which manipulates the user accessible state) ImGuiTableColumnFlags_DefaultHide = 1 << 1, // Default as a hidden/disabled column. ImGuiTableColumnFlags_DefaultSort = 1 << 2, // Default as a sorting column. ImGuiTableColumnFlags_WidthStretch = 1 << 3, // Column will stretch. Preferable with horizontal scrolling disabled (default if table sizing policy is _SizingStretchSame or _SizingStretchProp). ImGuiTableColumnFlags_WidthFixed = 1 << 4, // Column will not stretch. Preferable with horizontal scrolling enabled (default if table sizing policy is _SizingFixedFit and table is resizable). ImGuiTableColumnFlags_NoResize = 1 << 5, // Disable manual resizing. ImGuiTableColumnFlags_NoReorder = 1 << 6, // Disable manual reordering this column, this will also prevent other columns from crossing over this column. ImGuiTableColumnFlags_NoHide = 1 << 7, // Disable ability to hide/disable this column. ImGuiTableColumnFlags_NoClip = 1 << 8, // Disable clipping for this column (all NoClip columns will render in a same draw command). ImGuiTableColumnFlags_NoSort = 1 << 9, // Disable ability to sort on this field (even if ImGuiTableFlags_Sortable is set on the table). ImGuiTableColumnFlags_NoSortAscending = 1 << 10, // Disable ability to sort in the ascending direction. ImGuiTableColumnFlags_NoSortDescending = 1 << 11, // Disable ability to sort in the descending direction. ImGuiTableColumnFlags_NoHeaderLabel = 1 << 12, // TableHeadersRow() will submit an empty label for this column. Convenient for some small columns. Name will still appear in context menu or in angled headers. You may append into this cell by calling TableSetColumnIndex() right after the TableHeadersRow() call. ImGuiTableColumnFlags_NoHeaderWidth = 1 << 13, // Disable header text width contribution to automatic column width. ImGuiTableColumnFlags_PreferSortAscending = 1 << 14, // Make the initial sort direction Ascending when first sorting on this column (default). ImGuiTableColumnFlags_PreferSortDescending = 1 << 15, // Make the initial sort direction Descending when first sorting on this column. ImGuiTableColumnFlags_IndentEnable = 1 << 16, // Use current Indent value when entering cell (default for column 0). ImGuiTableColumnFlags_IndentDisable = 1 << 17, // Ignore current Indent value when entering cell (default for columns > 0). Indentation changes _within_ the cell will still be honored. ImGuiTableColumnFlags_AngledHeader = 1 << 18, // TableHeadersRow() will submit an angled header row for this column. Note this will add an extra row. // Output status flags, read-only via TableGetColumnFlags() ImGuiTableColumnFlags_IsEnabled = 1 << 24, // Status: is enabled == not hidden by user/api (referred to as "Hide" in _DefaultHide and _NoHide) flags. ImGuiTableColumnFlags_IsVisible = 1 << 25, // Status: is visible == is enabled AND not clipped by scrolling. ImGuiTableColumnFlags_IsSorted = 1 << 26, // Status: is currently part of the sort specs ImGuiTableColumnFlags_IsHovered = 1 << 27, // Status: is hovered by mouse // [Internal] Combinations and masks ImGuiTableColumnFlags_WidthMask_ = ImGuiTableColumnFlags_WidthStretch | ImGuiTableColumnFlags_WidthFixed, ImGuiTableColumnFlags_IndentMask_ = ImGuiTableColumnFlags_IndentEnable | ImGuiTableColumnFlags_IndentDisable, ImGuiTableColumnFlags_StatusMask_ = ImGuiTableColumnFlags_IsEnabled | ImGuiTableColumnFlags_IsVisible | ImGuiTableColumnFlags_IsSorted | ImGuiTableColumnFlags_IsHovered, ImGuiTableColumnFlags_NoDirectResize_ = 1 << 30, // [Internal] Disable user resizing this column directly (it may however we resized indirectly from its left edge) }; // Flags for ImGui::TableNextRow() enum ImGuiTableRowFlags_ { ImGuiTableRowFlags_None = 0, ImGuiTableRowFlags_Headers = 1 << 0, // Identify header row (set default background color + width of its contents accounted differently for auto column width) }; // Enum for ImGui::TableSetBgColor() // Background colors are rendering in 3 layers: // - Layer 0: draw with RowBg0 color if set, otherwise draw with ColumnBg0 if set. // - Layer 1: draw with RowBg1 color if set, otherwise draw with ColumnBg1 if set. // - Layer 2: draw with CellBg color if set. // The purpose of the two row/columns layers is to let you decide if a background color change should override or blend with the existing color. // When using ImGuiTableFlags_RowBg on the table, each row has the RowBg0 color automatically set for odd/even rows. // If you set the color of RowBg0 target, your color will override the existing RowBg0 color. // If you set the color of RowBg1 or ColumnBg1 target, your color will blend over the RowBg0 color. enum ImGuiTableBgTarget_ { ImGuiTableBgTarget_None = 0, ImGuiTableBgTarget_RowBg0 = 1, // Set row background color 0 (generally used for background, automatically set when ImGuiTableFlags_RowBg is used) ImGuiTableBgTarget_RowBg1 = 2, // Set row background color 1 (generally used for selection marking) ImGuiTableBgTarget_CellBg = 3, // Set cell background color (top-most color) }; // Sorting specifications for a table (often handling sort specs for a single column, occasionally more) // Obtained by calling TableGetSortSpecs(). // When 'SpecsDirty == true' you can sort your data. It will be true with sorting specs have changed since last call, or the first time. // Make sure to set 'SpecsDirty = false' after sorting, else you may wastefully sort your data every frame! struct ImGuiTableSortSpecs { const ImGuiTableColumnSortSpecs* Specs; // Pointer to sort spec array. int SpecsCount; // Sort spec count. Most often 1. May be > 1 when ImGuiTableFlags_SortMulti is enabled. May be == 0 when ImGuiTableFlags_SortTristate is enabled. bool SpecsDirty; // Set to true when specs have changed since last time! Use this to sort again, then clear the flag. ImGuiTableSortSpecs() { memset(this, 0, sizeof(*this)); } }; // Sorting specification for one column of a table (sizeof == 12 bytes) struct ImGuiTableColumnSortSpecs { ImGuiID ColumnUserID; // User id of the column (if specified by a TableSetupColumn() call) ImS16 ColumnIndex; // Index of the column ImS16 SortOrder; // Index within parent ImGuiTableSortSpecs (always stored in order starting from 0, tables sorted on a single criteria will always have a 0 here) ImGuiSortDirection SortDirection; // ImGuiSortDirection_Ascending or ImGuiSortDirection_Descending ImGuiTableColumnSortSpecs() { memset(this, 0, sizeof(*this)); } }; //----------------------------------------------------------------------------- // [SECTION] Helpers: Debug log, memory allocations macros, ImVector<> //----------------------------------------------------------------------------- //----------------------------------------------------------------------------- // Debug Logging into ShowDebugLogWindow(), tty and more. //----------------------------------------------------------------------------- #ifndef IMGUI_DISABLE_DEBUG_TOOLS #define IMGUI_DEBUG_LOG(...) ImGui::DebugLog(__VA_ARGS__) #else #define IMGUI_DEBUG_LOG(...) ((void)0) #endif //----------------------------------------------------------------------------- // IM_MALLOC(), IM_FREE(), IM_NEW(), IM_PLACEMENT_NEW(), IM_DELETE() // We call C++ constructor on own allocated memory via the placement "new(ptr) Type()" syntax. // Defining a custom placement new() with a custom parameter allows us to bypass including which on some platforms complains when user has disabled exceptions. //----------------------------------------------------------------------------- struct ImNewWrapper {}; inline void* operator new(size_t, ImNewWrapper, void* ptr) { return ptr; } inline void operator delete(void*, ImNewWrapper, void*) {} // This is only required so we can use the symmetrical new() #define IM_ALLOC(_SIZE) ImGui::MemAlloc(_SIZE) #define IM_FREE(_PTR) ImGui::MemFree(_PTR) #define IM_PLACEMENT_NEW(_PTR) new(ImNewWrapper(), _PTR) #define IM_NEW(_TYPE) new(ImNewWrapper(), ImGui::MemAlloc(sizeof(_TYPE))) _TYPE template void IM_DELETE(T* p) { if (p) { p->~T(); ImGui::MemFree(p); } } //----------------------------------------------------------------------------- // ImVector<> // Lightweight std::vector<>-like class to avoid dragging dependencies (also, some implementations of STL with debug enabled are absurdly slow, we bypass it so our code runs fast in debug). //----------------------------------------------------------------------------- // - You generally do NOT need to care or use this ever. But we need to make it available in imgui.h because some of our public structures are relying on it. // - We use std-like naming convention here, which is a little unusual for this codebase. // - Important: clear() frees memory, resize(0) keep the allocated buffer. We use resize(0) a lot to intentionally recycle allocated buffers across frames and amortize our costs. // - Important: our implementation does NOT call C++ constructors/destructors, we treat everything as raw data! This is intentional but be extra mindful of that, // Do NOT use this class as a std::vector replacement in your own code! Many of the structures used by dear imgui can be safely initialized by a zero-memset. //----------------------------------------------------------------------------- IM_MSVC_RUNTIME_CHECKS_OFF template struct ImVector { int Size; int Capacity; T* Data; // Provide standard typedefs but we don't use them ourselves. typedef T value_type; typedef value_type* iterator; typedef const value_type* const_iterator; // Constructors, destructor inline ImVector() { Size = Capacity = 0; Data = NULL; } inline ImVector(const ImVector& src) { Size = Capacity = 0; Data = NULL; operator=(src); } inline ImVector& operator=(const ImVector& src) { clear(); resize(src.Size); if (src.Data) memcpy(Data, src.Data, (size_t)Size * sizeof(T)); return *this; } inline ~ImVector() { if (Data) IM_FREE(Data); } // Important: does not destruct anything inline void clear() { if (Data) { Size = Capacity = 0; IM_FREE(Data); Data = NULL; } } // Important: does not destruct anything inline void clear_delete() { for (int n = 0; n < Size; n++) IM_DELETE(Data[n]); clear(); } // Important: never called automatically! always explicit. inline void clear_destruct() { for (int n = 0; n < Size; n++) Data[n].~T(); clear(); } // Important: never called automatically! always explicit. inline bool empty() const { return Size == 0; } inline int size() const { return Size; } inline int size_in_bytes() const { return Size * (int)sizeof(T); } inline int max_size() const { return 0x7FFFFFFF / (int)sizeof(T); } inline int capacity() const { return Capacity; } inline T& operator[](int i) { IM_ASSERT(i >= 0 && i < Size); return Data[i]; } inline const T& operator[](int i) const { IM_ASSERT(i >= 0 && i < Size); return Data[i]; } inline T* begin() { return Data; } inline const T* begin() const { return Data; } inline T* end() { return Data + Size; } inline const T* end() const { return Data + Size; } inline T& front() { IM_ASSERT(Size > 0); return Data[0]; } inline const T& front() const { IM_ASSERT(Size > 0); return Data[0]; } inline T& back() { IM_ASSERT(Size > 0); return Data[Size - 1]; } inline const T& back() const { IM_ASSERT(Size > 0); return Data[Size - 1]; } inline void swap(ImVector& rhs) { int rhs_size = rhs.Size; rhs.Size = Size; Size = rhs_size; int rhs_cap = rhs.Capacity; rhs.Capacity = Capacity; Capacity = rhs_cap; T* rhs_data = rhs.Data; rhs.Data = Data; Data = rhs_data; } inline int _grow_capacity(int sz) const { int new_capacity = Capacity ? (Capacity + Capacity / 2) : 8; return new_capacity > sz ? new_capacity : sz; } inline void resize(int new_size) { if (new_size > Capacity) reserve(_grow_capacity(new_size)); Size = new_size; } inline void resize(int new_size, const T& v) { if (new_size > Capacity) reserve(_grow_capacity(new_size)); if (new_size > Size) for (int n = Size; n < new_size; n++) memcpy(&Data[n], &v, sizeof(v)); Size = new_size; } inline void shrink(int new_size) { IM_ASSERT(new_size <= Size); Size = new_size; } // Resize a vector to a smaller size, guaranteed not to cause a reallocation inline void reserve(int new_capacity) { if (new_capacity <= Capacity) return; T* new_data = (T*)IM_ALLOC((size_t)new_capacity * sizeof(T)); if (Data) { memcpy(new_data, Data, (size_t)Size * sizeof(T)); IM_FREE(Data); } Data = new_data; Capacity = new_capacity; } inline void reserve_discard(int new_capacity) { if (new_capacity <= Capacity) return; if (Data) IM_FREE(Data); Data = (T*)IM_ALLOC((size_t)new_capacity * sizeof(T)); Capacity = new_capacity; } // NB: It is illegal to call push_back/push_front/insert with a reference pointing inside the ImVector data itself! e.g. v.push_back(v[10]) is forbidden. inline void push_back(const T& v) { if (Size == Capacity) reserve(_grow_capacity(Size + 1)); memcpy(&Data[Size], &v, sizeof(v)); Size++; } inline void pop_back() { IM_ASSERT(Size > 0); Size--; } inline void push_front(const T& v) { if (Size == 0) push_back(v); else insert(Data, v); } inline T* erase(const T* it) { IM_ASSERT(it >= Data && it < Data + Size); const ptrdiff_t off = it - Data; memmove(Data + off, Data + off + 1, ((size_t)Size - (size_t)off - 1) * sizeof(T)); Size--; return Data + off; } inline T* erase(const T* it, const T* it_last){ IM_ASSERT(it >= Data && it < Data + Size && it_last >= it && it_last <= Data + Size); const ptrdiff_t count = it_last - it; const ptrdiff_t off = it - Data; memmove(Data + off, Data + off + count, ((size_t)Size - (size_t)off - (size_t)count) * sizeof(T)); Size -= (int)count; return Data + off; } inline T* erase_unsorted(const T* it) { IM_ASSERT(it >= Data && it < Data + Size); const ptrdiff_t off = it - Data; if (it < Data + Size - 1) memcpy(Data + off, Data + Size - 1, sizeof(T)); Size--; return Data + off; } inline T* insert(const T* it, const T& v) { IM_ASSERT(it >= Data && it <= Data + Size); const ptrdiff_t off = it - Data; if (Size == Capacity) reserve(_grow_capacity(Size + 1)); if (off < (int)Size) memmove(Data + off + 1, Data + off, ((size_t)Size - (size_t)off) * sizeof(T)); memcpy(&Data[off], &v, sizeof(v)); Size++; return Data + off; } inline bool contains(const T& v) const { const T* data = Data; const T* data_end = Data + Size; while (data < data_end) if (*data++ == v) return true; return false; } inline T* find(const T& v) { T* data = Data; const T* data_end = Data + Size; while (data < data_end) if (*data == v) break; else ++data; return data; } inline const T* find(const T& v) const { const T* data = Data; const T* data_end = Data + Size; while (data < data_end) if (*data == v) break; else ++data; return data; } inline int find_index(const T& v) const { const T* data_end = Data + Size; const T* it = find(v); if (it == data_end) return -1; const ptrdiff_t off = it - Data; return (int)off; } inline bool find_erase(const T& v) { const T* it = find(v); if (it < Data + Size) { erase(it); return true; } return false; } inline bool find_erase_unsorted(const T& v) { const T* it = find(v); if (it < Data + Size) { erase_unsorted(it); return true; } return false; } inline int index_from_ptr(const T* it) const { IM_ASSERT(it >= Data && it < Data + Size); const ptrdiff_t off = it - Data; return (int)off; } }; IM_MSVC_RUNTIME_CHECKS_RESTORE //----------------------------------------------------------------------------- // [SECTION] ImGuiStyle //----------------------------------------------------------------------------- // You may modify the ImGui::GetStyle() main instance during initialization and before NewFrame(). // During the frame, use ImGui::PushStyleVar(ImGuiStyleVar_XXXX)/PopStyleVar() to alter the main style values, // and ImGui::PushStyleColor(ImGuiCol_XXX)/PopStyleColor() for colors. //----------------------------------------------------------------------------- struct ImGuiStyle { float Alpha; // Global alpha applies to everything in Dear ImGui. float DisabledAlpha; // Additional alpha multiplier applied by BeginDisabled(). Multiply over current value of Alpha. ImVec2 WindowPadding; // Padding within a window. float WindowRounding; // Radius of window corners rounding. Set to 0.0f to have rectangular windows. Large values tend to lead to variety of artifacts and are not recommended. float WindowBorderSize; // Thickness of border around windows. Generally set to 0.0f or 1.0f. (Other values are not well tested and more CPU/GPU costly). float WindowBorderHoverPadding; // Hit-testing extent outside/inside resizing border. Also extend determination of hovered window. Generally meaningfully larger than WindowBorderSize to make it easy to reach borders. ImVec2 WindowMinSize; // Minimum window size. This is a global setting. If you want to constrain individual windows, use SetNextWindowSizeConstraints(). ImVec2 WindowTitleAlign; // Alignment for title bar text. Defaults to (0.0f,0.5f) for left-aligned,vertically centered. ImGuiDir WindowMenuButtonPosition; // Side of the collapsing/docking button in the title bar (None/Left/Right). Defaults to ImGuiDir_Left. float ChildRounding; // Radius of child window corners rounding. Set to 0.0f to have rectangular windows. float ChildBorderSize; // Thickness of border around child windows. Generally set to 0.0f or 1.0f. (Other values are not well tested and more CPU/GPU costly). float PopupRounding; // Radius of popup window corners rounding. (Note that tooltip windows use WindowRounding) float PopupBorderSize; // Thickness of border around popup/tooltip windows. Generally set to 0.0f or 1.0f. (Other values are not well tested and more CPU/GPU costly). ImVec2 FramePadding; // Padding within a framed rectangle (used by most widgets). float FrameRounding; // Radius of frame corners rounding. Set to 0.0f to have rectangular frame (used by most widgets). float FrameBorderSize; // Thickness of border around frames. Generally set to 0.0f or 1.0f. (Other values are not well tested and more CPU/GPU costly). ImVec2 ItemSpacing; // Horizontal and vertical spacing between widgets/lines. ImVec2 ItemInnerSpacing; // Horizontal and vertical spacing between within elements of a composed widget (e.g. a slider and its label). ImVec2 CellPadding; // Padding within a table cell. Cellpadding.x is locked for entire table. CellPadding.y may be altered between different rows. ImVec2 TouchExtraPadding; // Expand reactive bounding box for touch-based system where touch position is not accurate enough. Unfortunately we don't sort widgets so priority on overlap will always be given to the first widget. So don't grow this too much! float IndentSpacing; // Horizontal indentation when e.g. entering a tree node. Generally == (FontSize + FramePadding.x*2). float ColumnsMinSpacing; // Minimum horizontal spacing between two columns. Preferably > (FramePadding.x + 1). float ScrollbarSize; // Width of the vertical scrollbar, Height of the horizontal scrollbar. float ScrollbarRounding; // Radius of grab corners for scrollbar. float GrabMinSize; // Minimum width/height of a grab box for slider/scrollbar. float GrabRounding; // Radius of grabs corners rounding. Set to 0.0f to have rectangular slider grabs. float LogSliderDeadzone; // The size in pixels of the dead-zone around zero on logarithmic sliders that cross zero. float ImageBorderSize; // Thickness of border around Image() calls. float TabRounding; // Radius of upper corners of a tab. Set to 0.0f to have rectangular tabs. float TabBorderSize; // Thickness of border around tabs. float TabCloseButtonMinWidthSelected; // -1: always visible. 0.0f: visible when hovered. >0.0f: visible when hovered if minimum width. float TabCloseButtonMinWidthUnselected; // -1: always visible. 0.0f: visible when hovered. >0.0f: visible when hovered if minimum width. FLT_MAX: never show close button when unselected. float TabBarBorderSize; // Thickness of tab-bar separator, which takes on the tab active color to denote focus. float TabBarOverlineSize; // Thickness of tab-bar overline, which highlights the selected tab-bar. float TableAngledHeadersAngle; // Angle of angled headers (supported values range from -50.0f degrees to +50.0f degrees). ImVec2 TableAngledHeadersTextAlign;// Alignment of angled headers within the cell ImGuiDir ColorButtonPosition; // Side of the color button in the ColorEdit4 widget (left/right). Defaults to ImGuiDir_Right. ImVec2 ButtonTextAlign; // Alignment of button text when button is larger than text. Defaults to (0.5f, 0.5f) (centered). ImVec2 SelectableTextAlign; // Alignment of selectable text. Defaults to (0.0f, 0.0f) (top-left aligned). It's generally important to keep this left-aligned if you want to lay multiple items on a same line. float SeparatorTextBorderSize; // Thickness of border in SeparatorText() ImVec2 SeparatorTextAlign; // Alignment of text within the separator. Defaults to (0.0f, 0.5f) (left aligned, center). ImVec2 SeparatorTextPadding; // Horizontal offset of text from each edge of the separator + spacing on other axis. Generally small values. .y is recommended to be == FramePadding.y. ImVec2 DisplayWindowPadding; // Apply to regular windows: amount which we enforce to keep visible when moving near edges of your screen. ImVec2 DisplaySafeAreaPadding; // Apply to every windows, menus, popups, tooltips: amount where we avoid displaying contents. Adjust if you cannot see the edges of your screen (e.g. on a TV where scaling has not been configured). float MouseCursorScale; // Scale software rendered mouse cursor (when io.MouseDrawCursor is enabled). We apply per-monitor DPI scaling over this scale. May be removed later. bool AntiAliasedLines; // Enable anti-aliased lines/borders. Disable if you are really tight on CPU/GPU. Latched at the beginning of the frame (copied to ImDrawList). bool AntiAliasedLinesUseTex; // Enable anti-aliased lines/borders using textures where possible. Require backend to render with bilinear filtering (NOT point/nearest filtering). Latched at the beginning of the frame (copied to ImDrawList). bool AntiAliasedFill; // Enable anti-aliased edges around filled shapes (rounded rectangles, circles, etc.). Disable if you are really tight on CPU/GPU. Latched at the beginning of the frame (copied to ImDrawList). float CurveTessellationTol; // Tessellation tolerance when using PathBezierCurveTo() without a specific number of segments. Decrease for highly tessellated curves (higher quality, more polygons), increase to reduce quality. float CircleTessellationMaxError; // Maximum error (in pixels) allowed when using AddCircle()/AddCircleFilled() or drawing rounded corner rectangles with no explicit segment count specified. Decrease for higher quality but more geometry. // Colors ImVec4 Colors[ImGuiCol_COUNT]; // Behaviors // (It is possible to modify those fields mid-frame if specific behavior need it, unlike e.g. configuration fields in ImGuiIO) float HoverStationaryDelay; // Delay for IsItemHovered(ImGuiHoveredFlags_Stationary). Time required to consider mouse stationary. float HoverDelayShort; // Delay for IsItemHovered(ImGuiHoveredFlags_DelayShort). Usually used along with HoverStationaryDelay. float HoverDelayNormal; // Delay for IsItemHovered(ImGuiHoveredFlags_DelayNormal). " ImGuiHoveredFlags HoverFlagsForTooltipMouse;// Default flags when using IsItemHovered(ImGuiHoveredFlags_ForTooltip) or BeginItemTooltip()/SetItemTooltip() while using mouse. ImGuiHoveredFlags HoverFlagsForTooltipNav; // Default flags when using IsItemHovered(ImGuiHoveredFlags_ForTooltip) or BeginItemTooltip()/SetItemTooltip() while using keyboard/gamepad. IMGUI_API ImGuiStyle(); IMGUI_API void ScaleAllSizes(float scale_factor); // Obsolete names #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS // TabMinWidthForCloseButton = TabCloseButtonMinWidthUnselected // Renamed in 1.91.9. #endif }; //----------------------------------------------------------------------------- // [SECTION] ImGuiIO //----------------------------------------------------------------------------- // Communicate most settings and inputs/outputs to Dear ImGui using this structure. // Access via ImGui::GetIO(). Read 'Programmer guide' section in .cpp file for general usage. // It is generally expected that: // - initialization: backends and user code writes to ImGuiIO. // - main loop: backends writes to ImGuiIO, user code and imgui code reads from ImGuiIO. //----------------------------------------------------------------------------- // Also see ImGui::GetPlatformIO() and ImGuiPlatformIO struct for OS/platform related functions: clipboard, IME etc. //----------------------------------------------------------------------------- // [Internal] Storage used by IsKeyDown(), IsKeyPressed() etc functions. // If prior to 1.87 you used io.KeysDownDuration[] (which was marked as internal), you should use GetKeyData(key)->DownDuration and *NOT* io.KeysData[key]->DownDuration. struct ImGuiKeyData { bool Down; // True for if key is down float DownDuration; // Duration the key has been down (<0.0f: not pressed, 0.0f: just pressed, >0.0f: time held) float DownDurationPrev; // Last frame duration the key has been down float AnalogValue; // 0.0f..1.0f for gamepad values }; struct ImGuiIO { //------------------------------------------------------------------ // Configuration // Default value //------------------------------------------------------------------ ImGuiConfigFlags ConfigFlags; // = 0 // See ImGuiConfigFlags_ enum. Set by user/application. Keyboard/Gamepad navigation options, etc. ImGuiBackendFlags BackendFlags; // = 0 // See ImGuiBackendFlags_ enum. Set by backend (imgui_impl_xxx files or custom backend) to communicate features supported by the backend. ImVec2 DisplaySize; // // Main display size, in pixels (generally == GetMainViewport()->Size). May change every frame. float DeltaTime; // = 1.0f/60.0f // Time elapsed since last frame, in seconds. May change every frame. float IniSavingRate; // = 5.0f // Minimum time between saving positions/sizes to .ini file, in seconds. const char* IniFilename; // = "imgui.ini" // Path to .ini file (important: default "imgui.ini" is relative to current working dir!). Set NULL to disable automatic .ini loading/saving or if you want to manually call LoadIniSettingsXXX() / SaveIniSettingsXXX() functions. const char* LogFilename; // = "imgui_log.txt"// Path to .log file (default parameter to ImGui::LogToFile when no file is specified). void* UserData; // = NULL // Store your own data. // Font system ImFontAtlas*Fonts; // // Font atlas: load, rasterize and pack one or more fonts into a single texture. float FontGlobalScale; // = 1.0f // Global scale all fonts bool FontAllowUserScaling; // = false // [OBSOLETE] Allow user scaling text of individual window with CTRL+Wheel. ImFont* FontDefault; // = NULL // Font to use on NewFrame(). Use NULL to uses Fonts->Fonts[0]. ImVec2 DisplayFramebufferScale; // = (1, 1) // For retina display or other situations where window coordinates are different from framebuffer coordinates. This generally ends up in ImDrawData::FramebufferScale. // Keyboard/Gamepad Navigation options bool ConfigNavSwapGamepadButtons; // = false // Swap Activate<>Cancel (A<>B) buttons, matching typical "Nintendo/Japanese style" gamepad layout. bool ConfigNavMoveSetMousePos; // = false // Directional/tabbing navigation teleports the mouse cursor. May be useful on TV/console systems where moving a virtual mouse is difficult. Will update io.MousePos and set io.WantSetMousePos=true. bool ConfigNavCaptureKeyboard; // = true // Sets io.WantCaptureKeyboard when io.NavActive is set. bool ConfigNavEscapeClearFocusItem; // = true // Pressing Escape can clear focused item + navigation id/highlight. Set to false if you want to always keep highlight on. bool ConfigNavEscapeClearFocusWindow;// = false // Pressing Escape can clear focused window as well (super set of io.ConfigNavEscapeClearFocusItem). bool ConfigNavCursorVisibleAuto; // = true // Using directional navigation key makes the cursor visible. Mouse click hides the cursor. bool ConfigNavCursorVisibleAlways; // = false // Navigation cursor is always visible. // Miscellaneous options // (you can visualize and interact with all options in 'Demo->Configuration') bool MouseDrawCursor; // = false // Request ImGui to draw a mouse cursor for you (if you are on a platform without a mouse cursor). Cannot be easily renamed to 'io.ConfigXXX' because this is frequently used by backend implementations. bool ConfigMacOSXBehaviors; // = defined(__APPLE__) // Swap Cmd<>Ctrl keys + OS X style text editing cursor movement using Alt instead of Ctrl, Shortcuts using Cmd/Super instead of Ctrl, Line/Text Start and End using Cmd+Arrows instead of Home/End, Double click selects by word instead of selecting whole text, Multi-selection in lists uses Cmd/Super instead of Ctrl. bool ConfigInputTrickleEventQueue; // = true // Enable input queue trickling: some types of events submitted during the same frame (e.g. button down + up) will be spread over multiple frames, improving interactions with low framerates. bool ConfigInputTextCursorBlink; // = true // Enable blinking cursor (optional as some users consider it to be distracting). bool ConfigInputTextEnterKeepActive; // = false // [BETA] Pressing Enter will keep item active and select contents (single-line only). bool ConfigDragClickToInputText; // = false // [BETA] Enable turning DragXXX widgets into text input with a simple mouse click-release (without moving). Not desirable on devices without a keyboard. bool ConfigWindowsResizeFromEdges; // = true // Enable resizing of windows from their edges and from the lower-left corner. This requires ImGuiBackendFlags_HasMouseCursors for better mouse cursor feedback. (This used to be a per-window ImGuiWindowFlags_ResizeFromAnySide flag) bool ConfigWindowsMoveFromTitleBarOnly; // = false // Enable allowing to move windows only when clicking on their title bar. Does not apply to windows without a title bar. bool ConfigWindowsCopyContentsWithCtrlC; // = false // [EXPERIMENTAL] CTRL+C copy the contents of focused window into the clipboard. Experimental because: (1) has known issues with nested Begin/End pairs (2) text output quality varies (3) text output is in submission order rather than spatial order. bool ConfigScrollbarScrollByPage; // = true // Enable scrolling page by page when clicking outside the scrollbar grab. When disabled, always scroll to clicked location. When enabled, Shift+Click scrolls to clicked location. float ConfigMemoryCompactTimer; // = 60.0f // Timer (in seconds) to free transient windows/tables memory buffers when unused. Set to -1.0f to disable. // Inputs Behaviors // (other variables, ones which are expected to be tweaked within UI code, are exposed in ImGuiStyle) float MouseDoubleClickTime; // = 0.30f // Time for a double-click, in seconds. float MouseDoubleClickMaxDist; // = 6.0f // Distance threshold to stay in to validate a double-click, in pixels. float MouseDragThreshold; // = 6.0f // Distance threshold before considering we are dragging. float KeyRepeatDelay; // = 0.275f // When holding a key/button, time before it starts repeating, in seconds (for buttons in Repeat mode, etc.). float KeyRepeatRate; // = 0.050f // When holding a key/button, rate at which it repeats, in seconds. //------------------------------------------------------------------ // Debug options //------------------------------------------------------------------ // Options to configure Error Handling and how we handle recoverable errors [EXPERIMENTAL] // - Error recovery is provided as a way to facilitate: // - Recovery after a programming error (native code or scripting language - the later tends to facilitate iterating on code while running). // - Recovery after running an exception handler or any error processing which may skip code after an error has been detected. // - Error recovery is not perfect nor guaranteed! It is a feature to ease development. // You not are not supposed to rely on it in the course of a normal application run. // - Functions that support error recovery are using IM_ASSERT_USER_ERROR() instead of IM_ASSERT(). // - By design, we do NOT allow error recovery to be 100% silent. One of the three options needs to be checked! // - Always ensure that on programmers seats you have at minimum Asserts or Tooltips enabled when making direct imgui API calls! // Otherwise it would severely hinder your ability to catch and correct mistakes! // Read https://github.com/ocornut/imgui/wiki/Error-Handling for details. // - Programmer seats: keep asserts (default), or disable asserts and keep error tooltips (new and nice!) // - Non-programmer seats: maybe disable asserts, but make sure errors are resurfaced (tooltips, visible log entries, use callback etc.) // - Recovery after error/exception: record stack sizes with ErrorRecoveryStoreState(), disable assert, set log callback (to e.g. trigger high-level breakpoint), recover with ErrorRecoveryTryToRecoverState(), restore settings. bool ConfigErrorRecovery; // = true // Enable error recovery support. Some errors won't be detected and lead to direct crashes if recovery is disabled. bool ConfigErrorRecoveryEnableAssert; // = true // Enable asserts on recoverable error. By default call IM_ASSERT() when returning from a failing IM_ASSERT_USER_ERROR() bool ConfigErrorRecoveryEnableDebugLog; // = true // Enable debug log output on recoverable errors. bool ConfigErrorRecoveryEnableTooltip; // = true // Enable tooltip on recoverable errors. The tooltip include a way to enable asserts if they were disabled. // Option to enable various debug tools showing buttons that will call the IM_DEBUG_BREAK() macro. // - The Item Picker tool will be available regardless of this being enabled, in order to maximize its discoverability. // - Requires a debugger being attached, otherwise IM_DEBUG_BREAK() options will appear to crash your application. // e.g. io.ConfigDebugIsDebuggerPresent = ::IsDebuggerPresent() on Win32, or refer to ImOsIsDebuggerPresent() imgui_test_engine/imgui_te_utils.cpp for a Unix compatible version). bool ConfigDebugIsDebuggerPresent; // = false // Enable various tools calling IM_DEBUG_BREAK(). // Tools to detect code submitting items with conflicting/duplicate IDs // - Code should use PushID()/PopID() in loops, or append "##xx" to same-label identifiers. // - Empty label e.g. Button("") == same ID as parent widget/node. Use Button("##xx") instead! // - See FAQ https://github.com/ocornut/imgui/blob/master/docs/FAQ.md#q-about-the-id-stack-system bool ConfigDebugHighlightIdConflicts;// = true // Highlight and show an error message popup when multiple items have conflicting identifiers. bool ConfigDebugHighlightIdConflictsShowItemPicker;//=true // Show "Item Picker" button in aforementioned popup. // Tools to test correct Begin/End and BeginChild/EndChild behaviors. // - Presently Begin()/End() and BeginChild()/EndChild() needs to ALWAYS be called in tandem, regardless of return value of BeginXXX() // - This is inconsistent with other BeginXXX functions and create confusion for many users. // - We expect to update the API eventually. In the meanwhile we provide tools to facilitate checking user-code behavior. bool ConfigDebugBeginReturnValueOnce;// = false // First-time calls to Begin()/BeginChild() will return false. NEEDS TO BE SET AT APPLICATION BOOT TIME if you don't want to miss windows. bool ConfigDebugBeginReturnValueLoop;// = false // Some calls to Begin()/BeginChild() will return false. Will cycle through window depths then repeat. Suggested use: add "io.ConfigDebugBeginReturnValue = io.KeyShift" in your main loop then occasionally press SHIFT. Windows should be flickering while running. // Option to deactivate io.AddFocusEvent(false) handling. // - May facilitate interactions with a debugger when focus loss leads to clearing inputs data. // - Backends may have other side-effects on focus loss, so this will reduce side-effects but not necessary remove all of them. bool ConfigDebugIgnoreFocusLoss; // = false // Ignore io.AddFocusEvent(false), consequently not calling io.ClearInputKeys()/io.ClearInputMouse() in input processing. // Option to audit .ini data bool ConfigDebugIniSettings; // = false // Save .ini data with extra comments (particularly helpful for Docking, but makes saving slower) //------------------------------------------------------------------ // Platform Identifiers // (the imgui_impl_xxxx backend files are setting those up for you) //------------------------------------------------------------------ // Nowadays those would be stored in ImGuiPlatformIO but we are leaving them here for legacy reasons. // Optional: Platform/Renderer backend name (informational only! will be displayed in About Window) + User data for backend/wrappers to store their own stuff. const char* BackendPlatformName; // = NULL const char* BackendRendererName; // = NULL void* BackendPlatformUserData; // = NULL // User data for platform backend void* BackendRendererUserData; // = NULL // User data for renderer backend void* BackendLanguageUserData; // = NULL // User data for non C++ programming language backend //------------------------------------------------------------------ // Input - Call before calling NewFrame() //------------------------------------------------------------------ // Input Functions IMGUI_API void AddKeyEvent(ImGuiKey key, bool down); // Queue a new key down/up event. Key should be "translated" (as in, generally ImGuiKey_A matches the key end-user would use to emit an 'A' character) IMGUI_API void AddKeyAnalogEvent(ImGuiKey key, bool down, float v); // Queue a new key down/up event for analog values (e.g. ImGuiKey_Gamepad_ values). Dead-zones should be handled by the backend. IMGUI_API void AddMousePosEvent(float x, float y); // Queue a mouse position update. Use -FLT_MAX,-FLT_MAX to signify no mouse (e.g. app not focused and not hovered) IMGUI_API void AddMouseButtonEvent(int button, bool down); // Queue a mouse button change IMGUI_API void AddMouseWheelEvent(float wheel_x, float wheel_y); // Queue a mouse wheel update. wheel_y<0: scroll down, wheel_y>0: scroll up, wheel_x<0: scroll right, wheel_x>0: scroll left. IMGUI_API void AddMouseSourceEvent(ImGuiMouseSource source); // Queue a mouse source change (Mouse/TouchScreen/Pen) IMGUI_API void AddFocusEvent(bool focused); // Queue a gain/loss of focus for the application (generally based on OS/platform focus of your window) IMGUI_API void AddInputCharacter(unsigned int c); // Queue a new character input IMGUI_API void AddInputCharacterUTF16(ImWchar16 c); // Queue a new character input from a UTF-16 character, it can be a surrogate IMGUI_API void AddInputCharactersUTF8(const char* str); // Queue a new characters input from a UTF-8 string IMGUI_API void SetKeyEventNativeData(ImGuiKey key, int native_keycode, int native_scancode, int native_legacy_index = -1); // [Optional] Specify index for legacy <1.87 IsKeyXXX() functions with native indices + specify native keycode, scancode. IMGUI_API void SetAppAcceptingEvents(bool accepting_events); // Set master flag for accepting key/mouse/text events (default to true). Useful if you have native dialog boxes that are interrupting your application loop/refresh, and you want to disable events being queued while your app is frozen. IMGUI_API void ClearEventsQueue(); // Clear all incoming events. IMGUI_API void ClearInputKeys(); // Clear current keyboard/gamepad state + current frame text input buffer. Equivalent to releasing all keys/buttons. IMGUI_API void ClearInputMouse(); // Clear current mouse state. #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS IMGUI_API void ClearInputCharacters(); // [Obsoleted in 1.89.8] Clear the current frame text input buffer. Now included within ClearInputKeys(). #endif //------------------------------------------------------------------ // Output - Updated by NewFrame() or EndFrame()/Render() // (when reading from the io.WantCaptureMouse, io.WantCaptureKeyboard flags to dispatch your inputs, it is // generally easier and more correct to use their state BEFORE calling NewFrame(). See FAQ for details!) //------------------------------------------------------------------ bool WantCaptureMouse; // Set when Dear ImGui will use mouse inputs, in this case do not dispatch them to your main game/application (either way, always pass on mouse inputs to imgui). (e.g. unclicked mouse is hovering over an imgui window, widget is active, mouse was clicked over an imgui window, etc.). bool WantCaptureKeyboard; // Set when Dear ImGui will use keyboard inputs, in this case do not dispatch them to your main game/application (either way, always pass keyboard inputs to imgui). (e.g. InputText active, or an imgui window is focused and navigation is enabled, etc.). bool WantTextInput; // Mobile/console: when set, you may display an on-screen keyboard. This is set by Dear ImGui when it wants textual keyboard input to happen (e.g. when a InputText widget is active). bool WantSetMousePos; // MousePos has been altered, backend should reposition mouse on next frame. Rarely used! Set only when io.ConfigNavMoveSetMousePos is enabled. bool WantSaveIniSettings; // When manual .ini load/save is active (io.IniFilename == NULL), this will be set to notify your application that you can call SaveIniSettingsToMemory() and save yourself. Important: clear io.WantSaveIniSettings yourself after saving! bool NavActive; // Keyboard/Gamepad navigation is currently allowed (will handle ImGuiKey_NavXXX events) = a window is focused and it doesn't use the ImGuiWindowFlags_NoNavInputs flag. bool NavVisible; // Keyboard/Gamepad navigation highlight is visible and allowed (will handle ImGuiKey_NavXXX events). float Framerate; // Estimate of application framerate (rolling average over 60 frames, based on io.DeltaTime), in frame per second. Solely for convenience. Slow applications may not want to use a moving average or may want to reset underlying buffers occasionally. int MetricsRenderVertices; // Vertices output during last call to Render() int MetricsRenderIndices; // Indices output during last call to Render() = number of triangles * 3 int MetricsRenderWindows; // Number of visible windows int MetricsActiveWindows; // Number of active windows ImVec2 MouseDelta; // Mouse delta. Note that this is zero if either current or previous position are invalid (-FLT_MAX,-FLT_MAX), so a disappearing/reappearing mouse won't have a huge delta. //------------------------------------------------------------------ // [Internal] Dear ImGui will maintain those fields. Forward compatibility not guaranteed! //------------------------------------------------------------------ ImGuiContext* Ctx; // Parent UI context (needs to be set explicitly by parent). // Main Input State // (this block used to be written by backend, since 1.87 it is best to NOT write to those directly, call the AddXXX functions above instead) // (reading from those variables is fair game, as they are extremely unlikely to be moving anywhere) ImVec2 MousePos; // Mouse position, in pixels. Set to ImVec2(-FLT_MAX, -FLT_MAX) if mouse is unavailable (on another screen, etc.) bool MouseDown[5]; // Mouse buttons: 0=left, 1=right, 2=middle + extras (ImGuiMouseButton_COUNT == 5). Dear ImGui mostly uses left and right buttons. Other buttons allow us to track if the mouse is being used by your application + available to user as a convenience via IsMouse** API. float MouseWheel; // Mouse wheel Vertical: 1 unit scrolls about 5 lines text. >0 scrolls Up, <0 scrolls Down. Hold SHIFT to turn vertical scroll into horizontal scroll. float MouseWheelH; // Mouse wheel Horizontal. >0 scrolls Left, <0 scrolls Right. Most users don't have a mouse with a horizontal wheel, may not be filled by all backends. ImGuiMouseSource MouseSource; // Mouse actual input peripheral (Mouse/TouchScreen/Pen). bool KeyCtrl; // Keyboard modifier down: Control bool KeyShift; // Keyboard modifier down: Shift bool KeyAlt; // Keyboard modifier down: Alt bool KeySuper; // Keyboard modifier down: Cmd/Super/Windows // Other state maintained from data above + IO function calls ImGuiKeyChord KeyMods; // Key mods flags (any of ImGuiMod_Ctrl/ImGuiMod_Shift/ImGuiMod_Alt/ImGuiMod_Super flags, same as io.KeyCtrl/KeyShift/KeyAlt/KeySuper but merged into flags. Read-only, updated by NewFrame() ImGuiKeyData KeysData[ImGuiKey_NamedKey_COUNT];// Key state for all known keys. Use IsKeyXXX() functions to access this. bool WantCaptureMouseUnlessPopupClose; // Alternative to WantCaptureMouse: (WantCaptureMouse == true && WantCaptureMouseUnlessPopupClose == false) when a click over void is expected to close a popup. ImVec2 MousePosPrev; // Previous mouse position (note that MouseDelta is not necessary == MousePos-MousePosPrev, in case either position is invalid) ImVec2 MouseClickedPos[5]; // Position at time of clicking double MouseClickedTime[5]; // Time of last click (used to figure out double-click) bool MouseClicked[5]; // Mouse button went from !Down to Down (same as MouseClickedCount[x] != 0) bool MouseDoubleClicked[5]; // Has mouse button been double-clicked? (same as MouseClickedCount[x] == 2) ImU16 MouseClickedCount[5]; // == 0 (not clicked), == 1 (same as MouseClicked[]), == 2 (double-clicked), == 3 (triple-clicked) etc. when going from !Down to Down ImU16 MouseClickedLastCount[5]; // Count successive number of clicks. Stays valid after mouse release. Reset after another click is done. bool MouseReleased[5]; // Mouse button went from Down to !Down double MouseReleasedTime[5]; // Time of last released (rarely used! but useful to handle delayed single-click when trying to disambiguate them from double-click). bool MouseDownOwned[5]; // Track if button was clicked inside a dear imgui window or over void blocked by a popup. We don't request mouse capture from the application if click started outside ImGui bounds. bool MouseDownOwnedUnlessPopupClose[5]; // Track if button was clicked inside a dear imgui window. bool MouseWheelRequestAxisSwap; // On a non-Mac system, holding SHIFT requests WheelY to perform the equivalent of a WheelX event. On a Mac system this is already enforced by the system. bool MouseCtrlLeftAsRightClick; // (OSX) Set to true when the current click was a Ctrl+click that spawned a simulated right click float MouseDownDuration[5]; // Duration the mouse button has been down (0.0f == just clicked) float MouseDownDurationPrev[5]; // Previous time the mouse button has been down float MouseDragMaxDistanceSqr[5]; // Squared maximum distance of how much mouse has traveled from the clicking point (used for moving thresholds) float PenPressure; // Touch/Pen pressure (0.0f to 1.0f, should be >0.0f only when MouseDown[0] == true). Helper storage currently unused by Dear ImGui. bool AppFocusLost; // Only modify via AddFocusEvent() bool AppAcceptingEvents; // Only modify via SetAppAcceptingEvents() ImWchar16 InputQueueSurrogate; // For AddInputCharacterUTF16() ImVector InputQueueCharacters; // Queue of _characters_ input (obtained by platform backend). Fill using AddInputCharacter() helper. // Legacy: before 1.87, we required backend to fill io.KeyMap[] (imgui->native map) during initialization and io.KeysDown[] (native indices) every frame. // This is still temporarily supported as a legacy feature. However the new preferred scheme is for backend to call io.AddKeyEvent(). // Old (<1.87): ImGui::IsKeyPressed(ImGui::GetIO().KeyMap[ImGuiKey_Space]) --> New (1.87+) ImGui::IsKeyPressed(ImGuiKey_Space) // Old (<1.87): ImGui::IsKeyPressed(MYPLATFORM_KEY_SPACE) --> New (1.87+) ImGui::IsKeyPressed(ImGuiKey_Space) // Read https://github.com/ocornut/imgui/issues/4921 for details. //int KeyMap[ImGuiKey_COUNT]; // [LEGACY] Input: map of indices into the KeysDown[512] entries array which represent your "native" keyboard state. The first 512 are now unused and should be kept zero. Legacy backend will write into KeyMap[] using ImGuiKey_ indices which are always >512. //bool KeysDown[ImGuiKey_COUNT]; // [LEGACY] Input: Keyboard keys that are pressed (ideally left in the "native" order your engine has access to keyboard keys, so you can use your own defines/enums for keys). This used to be [512] sized. It is now ImGuiKey_COUNT to allow legacy io.KeysDown[GetKeyIndex(...)] to work without an overflow. //float NavInputs[ImGuiNavInput_COUNT]; // [LEGACY] Since 1.88, NavInputs[] was removed. Backends from 1.60 to 1.86 won't build. Feed gamepad inputs via io.AddKeyEvent() and ImGuiKey_GamepadXXX enums. //void* ImeWindowHandle; // [Obsoleted in 1.87] Set ImGuiViewport::PlatformHandleRaw instead. Set this to your HWND to get automatic IME cursor positioning. // Legacy: before 1.91.1, clipboard functions were stored in ImGuiIO instead of ImGuiPlatformIO. // As this is will affect all users of custom engines/backends, we are providing proper legacy redirection (will obsolete). #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS const char* (*GetClipboardTextFn)(void* user_data); void (*SetClipboardTextFn)(void* user_data, const char* text); void* ClipboardUserData; #endif IMGUI_API ImGuiIO(); }; //----------------------------------------------------------------------------- // [SECTION] Misc data structures (ImGuiInputTextCallbackData, ImGuiSizeCallbackData, ImGuiPayload) //----------------------------------------------------------------------------- // Shared state of InputText(), passed as an argument to your callback when a ImGuiInputTextFlags_Callback* flag is used. // The callback function should return 0 by default. // Callbacks (follow a flag name and see comments in ImGuiInputTextFlags_ declarations for more details) // - ImGuiInputTextFlags_CallbackEdit: Callback on buffer edit. Note that InputText() already returns true on edit + you can always use IsItemEdited(). The callback is useful to manipulate the underlying buffer while focus is active. // - ImGuiInputTextFlags_CallbackAlways: Callback on each iteration // - ImGuiInputTextFlags_CallbackCompletion: Callback on pressing TAB // - ImGuiInputTextFlags_CallbackHistory: Callback on pressing Up/Down arrows // - ImGuiInputTextFlags_CallbackCharFilter: Callback on character inputs to replace or discard them. Modify 'EventChar' to replace or discard, or return 1 in callback to discard. // - ImGuiInputTextFlags_CallbackResize: Callback on buffer capacity changes request (beyond 'buf_size' parameter value), allowing the string to grow. struct ImGuiInputTextCallbackData { ImGuiContext* Ctx; // Parent UI context ImGuiInputTextFlags EventFlag; // One ImGuiInputTextFlags_Callback* // Read-only ImGuiInputTextFlags Flags; // What user passed to InputText() // Read-only void* UserData; // What user passed to InputText() // Read-only // Arguments for the different callback events // - During Resize callback, Buf will be same as your input buffer. // - However, during Completion/History/Always callback, Buf always points to our own internal data (it is not the same as your buffer)! Changes to it will be reflected into your own buffer shortly after the callback. // - To modify the text buffer in a callback, prefer using the InsertChars() / DeleteChars() function. InsertChars() will take care of calling the resize callback if necessary. // - If you know your edits are not going to resize the underlying buffer allocation, you may modify the contents of 'Buf[]' directly. You need to update 'BufTextLen' accordingly (0 <= BufTextLen < BufSize) and set 'BufDirty'' to true so InputText can update its internal state. ImWchar EventChar; // Character input // Read-write // [CharFilter] Replace character with another one, or set to zero to drop. return 1 is equivalent to setting EventChar=0; ImGuiKey EventKey; // Key pressed (Up/Down/TAB) // Read-only // [Completion,History] char* Buf; // Text buffer // Read-write // [Resize] Can replace pointer / [Completion,History,Always] Only write to pointed data, don't replace the actual pointer! int BufTextLen; // Text length (in bytes) // Read-write // [Resize,Completion,History,Always] Exclude zero-terminator storage. In C land: == strlen(some_text), in C++ land: string.length() int BufSize; // Buffer size (in bytes) = capacity+1 // Read-only // [Resize,Completion,History,Always] Include zero-terminator storage. In C land == ARRAYSIZE(my_char_array), in C++ land: string.capacity()+1 bool BufDirty; // Set if you modify Buf/BufTextLen! // Write // [Completion,History,Always] int CursorPos; // // Read-write // [Completion,History,Always] int SelectionStart; // // Read-write // [Completion,History,Always] == to SelectionEnd when no selection) int SelectionEnd; // // Read-write // [Completion,History,Always] // Helper functions for text manipulation. // Use those function to benefit from the CallbackResize behaviors. Calling those function reset the selection. IMGUI_API ImGuiInputTextCallbackData(); IMGUI_API void DeleteChars(int pos, int bytes_count); IMGUI_API void InsertChars(int pos, const char* text, const char* text_end = NULL); void SelectAll() { SelectionStart = 0; SelectionEnd = BufTextLen; } void ClearSelection() { SelectionStart = SelectionEnd = BufTextLen; } bool HasSelection() const { return SelectionStart != SelectionEnd; } }; // Resizing callback data to apply custom constraint. As enabled by SetNextWindowSizeConstraints(). Callback is called during the next Begin(). // NB: For basic min/max size constraint on each axis you don't need to use the callback! The SetNextWindowSizeConstraints() parameters are enough. struct ImGuiSizeCallbackData { void* UserData; // Read-only. What user passed to SetNextWindowSizeConstraints(). Generally store an integer or float in here (need reinterpret_cast<>). ImVec2 Pos; // Read-only. Window position, for reference. ImVec2 CurrentSize; // Read-only. Current window size. ImVec2 DesiredSize; // Read-write. Desired size, based on user's mouse position. Write to this field to restrain resizing. }; // Data payload for Drag and Drop operations: AcceptDragDropPayload(), GetDragDropPayload() struct ImGuiPayload { // Members void* Data; // Data (copied and owned by dear imgui) int DataSize; // Data size // [Internal] ImGuiID SourceId; // Source item id ImGuiID SourceParentId; // Source parent id (if available) int DataFrameCount; // Data timestamp char DataType[32 + 1]; // Data type tag (short user-supplied string, 32 characters max) bool Preview; // Set when AcceptDragDropPayload() was called and mouse has been hovering the target item (nb: handle overlapping drag targets) bool Delivery; // Set when AcceptDragDropPayload() was called and mouse button is released over the target item. ImGuiPayload() { Clear(); } void Clear() { SourceId = SourceParentId = 0; Data = NULL; DataSize = 0; memset(DataType, 0, sizeof(DataType)); DataFrameCount = -1; Preview = Delivery = false; } bool IsDataType(const char* type) const { return DataFrameCount != -1 && strcmp(type, DataType) == 0; } bool IsPreview() const { return Preview; } bool IsDelivery() const { return Delivery; } }; //----------------------------------------------------------------------------- // [SECTION] Helpers (ImGuiOnceUponAFrame, ImGuiTextFilter, ImGuiTextBuffer, ImGuiStorage, ImGuiListClipper, Math Operators, ImColor) //----------------------------------------------------------------------------- // Helper: Unicode defines #define IM_UNICODE_CODEPOINT_INVALID 0xFFFD // Invalid Unicode code point (standard value). #ifdef IMGUI_USE_WCHAR32 #define IM_UNICODE_CODEPOINT_MAX 0x10FFFF // Maximum Unicode code point supported by this build. #else #define IM_UNICODE_CODEPOINT_MAX 0xFFFF // Maximum Unicode code point supported by this build. #endif // Helper: Execute a block of code at maximum once a frame. Convenient if you want to quickly create a UI within deep-nested code that runs multiple times every frame. // Usage: static ImGuiOnceUponAFrame oaf; if (oaf) ImGui::Text("This will be called only once per frame"); struct ImGuiOnceUponAFrame { ImGuiOnceUponAFrame() { RefFrame = -1; } mutable int RefFrame; operator bool() const { int current_frame = ImGui::GetFrameCount(); if (RefFrame == current_frame) return false; RefFrame = current_frame; return true; } }; // Helper: Parse and apply text filters. In format "aaaaa[,bbbb][,ccccc]" struct ImGuiTextFilter { IMGUI_API ImGuiTextFilter(const char* default_filter = ""); IMGUI_API bool Draw(const char* label = "Filter (inc,-exc)", float width = 0.0f); // Helper calling InputText+Build IMGUI_API bool PassFilter(const char* text, const char* text_end = NULL) const; IMGUI_API void Build(); void Clear() { InputBuf[0] = 0; Build(); } bool IsActive() const { return !Filters.empty(); } // [Internal] struct ImGuiTextRange { const char* b; const char* e; ImGuiTextRange() { b = e = NULL; } ImGuiTextRange(const char* _b, const char* _e) { b = _b; e = _e; } bool empty() const { return b == e; } IMGUI_API void split(char separator, ImVector* out) const; }; char InputBuf[256]; ImVectorFilters; int CountGrep; }; // Helper: Growable text buffer for logging/accumulating text // (this could be called 'ImGuiTextBuilder' / 'ImGuiStringBuilder') struct ImGuiTextBuffer { ImVector Buf; IMGUI_API static char EmptyString[1]; ImGuiTextBuffer() { } inline char operator[](int i) const { IM_ASSERT(Buf.Data != NULL); return Buf.Data[i]; } const char* begin() const { return Buf.Data ? &Buf.front() : EmptyString; } const char* end() const { return Buf.Data ? &Buf.back() : EmptyString; } // Buf is zero-terminated, so end() will point on the zero-terminator int size() const { return Buf.Size ? Buf.Size - 1 : 0; } bool empty() const { return Buf.Size <= 1; } void clear() { Buf.clear(); } void resize(int size) { if (Buf.Size > size) Buf.Data[size] = 0; Buf.resize(size ? size + 1 : 0, 0); } // Similar to resize(0) on ImVector: empty string but don't free buffer. void reserve(int capacity) { Buf.reserve(capacity); } const char* c_str() const { return Buf.Data ? Buf.Data : EmptyString; } IMGUI_API void append(const char* str, const char* str_end = NULL); IMGUI_API void appendf(const char* fmt, ...) IM_FMTARGS(2); IMGUI_API void appendfv(const char* fmt, va_list args) IM_FMTLIST(2); }; // [Internal] Key+Value for ImGuiStorage struct ImGuiStoragePair { ImGuiID key; union { int val_i; float val_f; void* val_p; }; ImGuiStoragePair(ImGuiID _key, int _val) { key = _key; val_i = _val; } ImGuiStoragePair(ImGuiID _key, float _val) { key = _key; val_f = _val; } ImGuiStoragePair(ImGuiID _key, void* _val) { key = _key; val_p = _val; } }; // Helper: Key->Value storage // Typically you don't have to worry about this since a storage is held within each Window. // We use it to e.g. store collapse state for a tree (Int 0/1) // This is optimized for efficient lookup (dichotomy into a contiguous buffer) and rare insertion (typically tied to user interactions aka max once a frame) // You can use it as custom user storage for temporary values. Declare your own storage if, for example: // - You want to manipulate the open/close state of a particular sub-tree in your interface (tree node uses Int 0/1 to store their state). // - You want to store custom debug data easily without adding or editing structures in your code (probably not efficient, but convenient) // Types are NOT stored, so it is up to you to make sure your Key don't collide with different types. struct ImGuiStorage { // [Internal] ImVector Data; // - Get***() functions find pair, never add/allocate. Pairs are sorted so a query is O(log N) // - Set***() functions find pair, insertion on demand if missing. // - Sorted insertion is costly, paid once. A typical frame shouldn't need to insert any new pair. void Clear() { Data.clear(); } IMGUI_API int GetInt(ImGuiID key, int default_val = 0) const; IMGUI_API void SetInt(ImGuiID key, int val); IMGUI_API bool GetBool(ImGuiID key, bool default_val = false) const; IMGUI_API void SetBool(ImGuiID key, bool val); IMGUI_API float GetFloat(ImGuiID key, float default_val = 0.0f) const; IMGUI_API void SetFloat(ImGuiID key, float val); IMGUI_API void* GetVoidPtr(ImGuiID key) const; // default_val is NULL IMGUI_API void SetVoidPtr(ImGuiID key, void* val); // - Get***Ref() functions finds pair, insert on demand if missing, return pointer. Useful if you intend to do Get+Set. // - References are only valid until a new value is added to the storage. Calling a Set***() function or a Get***Ref() function invalidates the pointer. // - A typical use case where this is convenient for quick hacking (e.g. add storage during a live Edit&Continue session if you can't modify existing struct) // float* pvar = ImGui::GetFloatRef(key); ImGui::SliderFloat("var", pvar, 0, 100.0f); some_var += *pvar; IMGUI_API int* GetIntRef(ImGuiID key, int default_val = 0); IMGUI_API bool* GetBoolRef(ImGuiID key, bool default_val = false); IMGUI_API float* GetFloatRef(ImGuiID key, float default_val = 0.0f); IMGUI_API void** GetVoidPtrRef(ImGuiID key, void* default_val = NULL); // Advanced: for quicker full rebuild of a storage (instead of an incremental one), you may add all your contents and then sort once. IMGUI_API void BuildSortByKey(); // Obsolete: use on your own storage if you know only integer are being stored (open/close all tree nodes) IMGUI_API void SetAllInt(int val); #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS //typedef ::ImGuiStoragePair ImGuiStoragePair; // 1.90.8: moved type outside struct #endif }; // Helper: Manually clip large list of items. // If you have lots evenly spaced items and you have random access to the list, you can perform coarse // clipping based on visibility to only submit items that are in view. // The clipper calculates the range of visible items and advance the cursor to compensate for the non-visible items we have skipped. // (Dear ImGui already clip items based on their bounds but: it needs to first layout the item to do so, and generally // fetching/submitting your own data incurs additional cost. Coarse clipping using ImGuiListClipper allows you to easily // scale using lists with tens of thousands of items without a problem) // Usage: // ImGuiListClipper clipper; // clipper.Begin(1000); // We have 1000 elements, evenly spaced. // while (clipper.Step()) // for (int i = clipper.DisplayStart; i < clipper.DisplayEnd; i++) // ImGui::Text("line number %d", i); // Generally what happens is: // - Clipper lets you process the first element (DisplayStart = 0, DisplayEnd = 1) regardless of it being visible or not. // - User code submit that one element. // - Clipper can measure the height of the first element // - Clipper calculate the actual range of elements to display based on the current clipping rectangle, position the cursor before the first visible element. // - User code submit visible elements. // - The clipper also handles various subtleties related to keyboard/gamepad navigation, wrapping etc. struct ImGuiListClipper { ImGuiContext* Ctx; // Parent UI context int DisplayStart; // First item to display, updated by each call to Step() int DisplayEnd; // End of items to display (exclusive) int ItemsCount; // [Internal] Number of items float ItemsHeight; // [Internal] Height of item after a first step and item submission can calculate it float StartPosY; // [Internal] Cursor position at the time of Begin() or after table frozen rows are all processed double StartSeekOffsetY; // [Internal] Account for frozen rows in a table and initial loss of precision in very large windows. void* TempData; // [Internal] Internal data // items_count: Use INT_MAX if you don't know how many items you have (in which case the cursor won't be advanced in the final step, and you can call SeekCursorForItem() manually if you need) // items_height: Use -1.0f to be calculated automatically on first step. Otherwise pass in the distance between your items, typically GetTextLineHeightWithSpacing() or GetFrameHeightWithSpacing(). IMGUI_API ImGuiListClipper(); IMGUI_API ~ImGuiListClipper(); IMGUI_API void Begin(int items_count, float items_height = -1.0f); IMGUI_API void End(); // Automatically called on the last call of Step() that returns false. IMGUI_API bool Step(); // Call until it returns false. The DisplayStart/DisplayEnd fields will be set and you can process/draw those items. // Call IncludeItemByIndex() or IncludeItemsByIndex() *BEFORE* first call to Step() if you need a range of items to not be clipped, regardless of their visibility. // (Due to alignment / padding of certain items it is possible that an extra item may be included on either end of the display range). inline void IncludeItemByIndex(int item_index) { IncludeItemsByIndex(item_index, item_index + 1); } IMGUI_API void IncludeItemsByIndex(int item_begin, int item_end); // item_end is exclusive e.g. use (42, 42+1) to make item 42 never clipped. // Seek cursor toward given item. This is automatically called while stepping. // - The only reason to call this is: you can use ImGuiListClipper::Begin(INT_MAX) if you don't know item count ahead of time. // - In this case, after all steps are done, you'll want to call SeekCursorForItem(item_count). IMGUI_API void SeekCursorForItem(int item_index); #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS inline void IncludeRangeByIndices(int item_begin, int item_end) { IncludeItemsByIndex(item_begin, item_end); } // [renamed in 1.89.9] inline void ForceDisplayRangeByIndices(int item_begin, int item_end) { IncludeItemsByIndex(item_begin, item_end); } // [renamed in 1.89.6] //inline ImGuiListClipper(int items_count, float items_height = -1.0f) { memset(this, 0, sizeof(*this)); ItemsCount = -1; Begin(items_count, items_height); } // [removed in 1.79] #endif }; // Helpers: ImVec2/ImVec4 operators // - It is important that we are keeping those disabled by default so they don't leak in user space. // - This is in order to allow user enabling implicit cast operators between ImVec2/ImVec4 and their own types (using IM_VEC2_CLASS_EXTRA in imconfig.h) // - Add '#define IMGUI_DEFINE_MATH_OPERATORS' before including this file (or in imconfig.h) to access courtesy maths operators for ImVec2 and ImVec4. // - We intentionally provide ImVec2*float but not float*ImVec2: this is rare enough and we want to reduce the surface for possible user mistake. #ifdef IMGUI_DEFINE_MATH_OPERATORS #define IMGUI_DEFINE_MATH_OPERATORS_IMPLEMENTED IM_MSVC_RUNTIME_CHECKS_OFF static inline ImVec2 operator*(const ImVec2& lhs, const float rhs) { return ImVec2(lhs.x * rhs, lhs.y * rhs); } static inline ImVec2 operator/(const ImVec2& lhs, const float rhs) { return ImVec2(lhs.x / rhs, lhs.y / rhs); } static inline ImVec2 operator+(const ImVec2& lhs, const ImVec2& rhs) { return ImVec2(lhs.x + rhs.x, lhs.y + rhs.y); } static inline ImVec2 operator-(const ImVec2& lhs, const ImVec2& rhs) { return ImVec2(lhs.x - rhs.x, lhs.y - rhs.y); } static inline ImVec2 operator*(const ImVec2& lhs, const ImVec2& rhs) { return ImVec2(lhs.x * rhs.x, lhs.y * rhs.y); } static inline ImVec2 operator/(const ImVec2& lhs, const ImVec2& rhs) { return ImVec2(lhs.x / rhs.x, lhs.y / rhs.y); } static inline ImVec2 operator-(const ImVec2& lhs) { return ImVec2(-lhs.x, -lhs.y); } static inline ImVec2& operator*=(ImVec2& lhs, const float rhs) { lhs.x *= rhs; lhs.y *= rhs; return lhs; } static inline ImVec2& operator/=(ImVec2& lhs, const float rhs) { lhs.x /= rhs; lhs.y /= rhs; return lhs; } static inline ImVec2& operator+=(ImVec2& lhs, const ImVec2& rhs) { lhs.x += rhs.x; lhs.y += rhs.y; return lhs; } static inline ImVec2& operator-=(ImVec2& lhs, const ImVec2& rhs) { lhs.x -= rhs.x; lhs.y -= rhs.y; return lhs; } static inline ImVec2& operator*=(ImVec2& lhs, const ImVec2& rhs) { lhs.x *= rhs.x; lhs.y *= rhs.y; return lhs; } static inline ImVec2& operator/=(ImVec2& lhs, const ImVec2& rhs) { lhs.x /= rhs.x; lhs.y /= rhs.y; return lhs; } static inline bool operator==(const ImVec2& lhs, const ImVec2& rhs) { return lhs.x == rhs.x && lhs.y == rhs.y; } static inline bool operator!=(const ImVec2& lhs, const ImVec2& rhs) { return lhs.x != rhs.x || lhs.y != rhs.y; } static inline ImVec4 operator+(const ImVec4& lhs, const ImVec4& rhs) { return ImVec4(lhs.x + rhs.x, lhs.y + rhs.y, lhs.z + rhs.z, lhs.w + rhs.w); } static inline ImVec4 operator-(const ImVec4& lhs, const ImVec4& rhs) { return ImVec4(lhs.x - rhs.x, lhs.y - rhs.y, lhs.z - rhs.z, lhs.w - rhs.w); } static inline ImVec4 operator*(const ImVec4& lhs, const ImVec4& rhs) { return ImVec4(lhs.x * rhs.x, lhs.y * rhs.y, lhs.z * rhs.z, lhs.w * rhs.w); } static inline bool operator==(const ImVec4& lhs, const ImVec4& rhs) { return lhs.x == rhs.x && lhs.y == rhs.y && lhs.z == rhs.z && lhs.w == rhs.w; } static inline bool operator!=(const ImVec4& lhs, const ImVec4& rhs) { return lhs.x != rhs.x || lhs.y != rhs.y || lhs.z != rhs.z || lhs.w != rhs.w; } IM_MSVC_RUNTIME_CHECKS_RESTORE #endif // Helpers macros to generate 32-bit encoded colors // - User can declare their own format by #defining the 5 _SHIFT/_MASK macros in their imconfig file. // - Any setting other than the default will need custom backend support. The only standard backend that supports anything else than the default is DirectX9. #ifndef IM_COL32_R_SHIFT #ifdef IMGUI_USE_BGRA_PACKED_COLOR #define IM_COL32_R_SHIFT 16 #define IM_COL32_G_SHIFT 8 #define IM_COL32_B_SHIFT 0 #define IM_COL32_A_SHIFT 24 #define IM_COL32_A_MASK 0xFF000000 #else #define IM_COL32_R_SHIFT 0 #define IM_COL32_G_SHIFT 8 #define IM_COL32_B_SHIFT 16 #define IM_COL32_A_SHIFT 24 #define IM_COL32_A_MASK 0xFF000000 #endif #endif #define IM_COL32(R,G,B,A) (((ImU32)(A)<> IM_COL32_R_SHIFT) & 0xFF) * (1.0f / 255.0f), (float)((rgba >> IM_COL32_G_SHIFT) & 0xFF) * (1.0f / 255.0f), (float)((rgba >> IM_COL32_B_SHIFT) & 0xFF) * (1.0f / 255.0f), (float)((rgba >> IM_COL32_A_SHIFT) & 0xFF) * (1.0f / 255.0f)) {} inline operator ImU32() const { return ImGui::ColorConvertFloat4ToU32(Value); } inline operator ImVec4() const { return Value; } // FIXME-OBSOLETE: May need to obsolete/cleanup those helpers. inline void SetHSV(float h, float s, float v, float a = 1.0f){ ImGui::ColorConvertHSVtoRGB(h, s, v, Value.x, Value.y, Value.z); Value.w = a; } static ImColor HSV(float h, float s, float v, float a = 1.0f) { float r, g, b; ImGui::ColorConvertHSVtoRGB(h, s, v, r, g, b); return ImColor(r, g, b, a); } }; //----------------------------------------------------------------------------- // [SECTION] Multi-Select API flags and structures (ImGuiMultiSelectFlags, ImGuiSelectionRequestType, ImGuiSelectionRequest, ImGuiMultiSelectIO, ImGuiSelectionBasicStorage) //----------------------------------------------------------------------------- // Multi-selection system // Documentation at: https://github.com/ocornut/imgui/wiki/Multi-Select // - Refer to 'Demo->Widgets->Selection State & Multi-Select' for demos using this. // - This system implements standard multi-selection idioms (CTRL+Mouse/Keyboard, SHIFT+Mouse/Keyboard, etc) // with support for clipper (skipping non-visible items), box-select and many other details. // - Selectable(), Checkbox() are supported but custom widgets may use it as well. // - TreeNode() is technically supported but... using this correctly is more complicated: you need some sort of linear/random access to your tree, // which is suited to advanced trees setups also implementing filters and clipper. We will work toward simplifying and demoing it. // - In the spirit of Dear ImGui design, your code owns actual selection data. // This is designed to allow all kinds of selection storage you may use in your application e.g. set/map/hash. // About ImGuiSelectionBasicStorage: // - This is an optional helper to store a selection state and apply selection requests. // - It is used by our demos and provided as a convenience to quickly implement multi-selection. // Usage: // - Identify submitted items with SetNextItemSelectionUserData(), most likely using an index into your current data-set. // - Store and maintain actual selection data using persistent object identifiers. // - Usage flow: // BEGIN - (1) Call BeginMultiSelect() and retrieve the ImGuiMultiSelectIO* result. // - (2) Honor request list (SetAll/SetRange requests) by updating your selection data. Same code as Step 6. // - (3) [If using clipper] You need to make sure RangeSrcItem is always submitted. Calculate its index and pass to clipper.IncludeItemByIndex(). If storing indices in ImGuiSelectionUserData, a simple clipper.IncludeItemByIndex(ms_io->RangeSrcItem) call will work. // LOOP - (4) Submit your items with SetNextItemSelectionUserData() + Selectable()/TreeNode() calls. // END - (5) Call EndMultiSelect() and retrieve the ImGuiMultiSelectIO* result. // - (6) Honor request list (SetAll/SetRange requests) by updating your selection data. Same code as Step 2. // If you submit all items (no clipper), Step 2 and 3 are optional and will be handled by each item themselves. It is fine to always honor those steps. // About ImGuiSelectionUserData: // - This can store an application-defined identifier (e.g. index or pointer) submitted via SetNextItemSelectionUserData(). // - In return we store them into RangeSrcItem/RangeFirstItem/RangeLastItem and other fields in ImGuiMultiSelectIO. // - Most applications will store an object INDEX, hence the chosen name and type. Storing an index is natural, because // SetRange requests will give you two end-points and you will need to iterate/interpolate between them to update your selection. // - However it is perfectly possible to store a POINTER or another IDENTIFIER inside ImGuiSelectionUserData. // Our system never assume that you identify items by indices, it never attempts to interpolate between two values. // - If you enable ImGuiMultiSelectFlags_NoRangeSelect then it is guaranteed that you will never have to interpolate // between two ImGuiSelectionUserData, which may be a convenient way to use part of the feature with less code work. // - As most users will want to store an index, for convenience and to reduce confusion we use ImS64 instead of void*, // being syntactically easier to downcast. Feel free to reinterpret_cast and store a pointer inside. // Flags for BeginMultiSelect() enum ImGuiMultiSelectFlags_ { ImGuiMultiSelectFlags_None = 0, ImGuiMultiSelectFlags_SingleSelect = 1 << 0, // Disable selecting more than one item. This is available to allow single-selection code to share same code/logic if desired. It essentially disables the main purpose of BeginMultiSelect() tho! ImGuiMultiSelectFlags_NoSelectAll = 1 << 1, // Disable CTRL+A shortcut to select all. ImGuiMultiSelectFlags_NoRangeSelect = 1 << 2, // Disable Shift+selection mouse/keyboard support (useful for unordered 2D selection). With BoxSelect is also ensure contiguous SetRange requests are not combined into one. This allows not handling interpolation in SetRange requests. ImGuiMultiSelectFlags_NoAutoSelect = 1 << 3, // Disable selecting items when navigating (useful for e.g. supporting range-select in a list of checkboxes). ImGuiMultiSelectFlags_NoAutoClear = 1 << 4, // Disable clearing selection when navigating or selecting another one (generally used with ImGuiMultiSelectFlags_NoAutoSelect. useful for e.g. supporting range-select in a list of checkboxes). ImGuiMultiSelectFlags_NoAutoClearOnReselect = 1 << 5, // Disable clearing selection when clicking/selecting an already selected item. ImGuiMultiSelectFlags_BoxSelect1d = 1 << 6, // Enable box-selection with same width and same x pos items (e.g. full row Selectable()). Box-selection works better with little bit of spacing between items hit-box in order to be able to aim at empty space. ImGuiMultiSelectFlags_BoxSelect2d = 1 << 7, // Enable box-selection with varying width or varying x pos items support (e.g. different width labels, or 2D layout/grid). This is slower: alters clipping logic so that e.g. horizontal movements will update selection of normally clipped items. ImGuiMultiSelectFlags_BoxSelectNoScroll = 1 << 8, // Disable scrolling when box-selecting near edges of scope. ImGuiMultiSelectFlags_ClearOnEscape = 1 << 9, // Clear selection when pressing Escape while scope is focused. ImGuiMultiSelectFlags_ClearOnClickVoid = 1 << 10, // Clear selection when clicking on empty location within scope. ImGuiMultiSelectFlags_ScopeWindow = 1 << 11, // Scope for _BoxSelect and _ClearOnClickVoid is whole window (Default). Use if BeginMultiSelect() covers a whole window or used a single time in same window. ImGuiMultiSelectFlags_ScopeRect = 1 << 12, // Scope for _BoxSelect and _ClearOnClickVoid is rectangle encompassing BeginMultiSelect()/EndMultiSelect(). Use if BeginMultiSelect() is called multiple times in same window. ImGuiMultiSelectFlags_SelectOnClick = 1 << 13, // Apply selection on mouse down when clicking on unselected item. (Default) ImGuiMultiSelectFlags_SelectOnClickRelease = 1 << 14, // Apply selection on mouse release when clicking an unselected item. Allow dragging an unselected item without altering selection. //ImGuiMultiSelectFlags_RangeSelect2d = 1 << 15, // Shift+Selection uses 2d geometry instead of linear sequence, so possible to use Shift+up/down to select vertically in grid. Analogous to what BoxSelect does. ImGuiMultiSelectFlags_NavWrapX = 1 << 16, // [Temporary] Enable navigation wrapping on X axis. Provided as a convenience because we don't have a design for the general Nav API for this yet. When the more general feature be public we may obsolete this flag in favor of new one. }; // Main IO structure returned by BeginMultiSelect()/EndMultiSelect(). // This mainly contains a list of selection requests. // - Use 'Demo->Tools->Debug Log->Selection' to see requests as they happen. // - Some fields are only useful if your list is dynamic and allows deletion (getting post-deletion focus/state right is shown in the demo) // - Below: who reads/writes each fields? 'r'=read, 'w'=write, 'ms'=multi-select code, 'app'=application/user code. struct ImGuiMultiSelectIO { //------------------------------------------// BeginMultiSelect / EndMultiSelect ImVector Requests; // ms:w, app:r / ms:w app:r // Requests to apply to your selection data. ImGuiSelectionUserData RangeSrcItem; // ms:w app:r / // (If using clipper) Begin: Source item (often the first selected item) must never be clipped: use clipper.IncludeItemByIndex() to ensure it is submitted. ImGuiSelectionUserData NavIdItem; // ms:w, app:r / // (If using deletion) Last known SetNextItemSelectionUserData() value for NavId (if part of submitted items). bool NavIdSelected; // ms:w, app:r / app:r // (If using deletion) Last known selection state for NavId (if part of submitted items). bool RangeSrcReset; // app:w / ms:r // (If using deletion) Set before EndMultiSelect() to reset ResetSrcItem (e.g. if deleted selection). int ItemsCount; // ms:w, app:r / app:r // 'int items_count' parameter to BeginMultiSelect() is copied here for convenience, allowing simpler calls to your ApplyRequests handler. Not used internally. }; // Selection request type enum ImGuiSelectionRequestType { ImGuiSelectionRequestType_None = 0, ImGuiSelectionRequestType_SetAll, // Request app to clear selection (if Selected==false) or select all items (if Selected==true). We cannot set RangeFirstItem/RangeLastItem as its contents is entirely up to user (not necessarily an index) ImGuiSelectionRequestType_SetRange, // Request app to select/unselect [RangeFirstItem..RangeLastItem] items (inclusive) based on value of Selected. Only EndMultiSelect() request this, app code can read after BeginMultiSelect() and it will always be false. }; // Selection request item struct ImGuiSelectionRequest { //------------------------------------------// BeginMultiSelect / EndMultiSelect ImGuiSelectionRequestType Type; // ms:w, app:r / ms:w, app:r // Request type. You'll most often receive 1 Clear + 1 SetRange with a single-item range. bool Selected; // ms:w, app:r / ms:w, app:r // Parameter for SetAll/SetRange requests (true = select, false = unselect) ImS8 RangeDirection; // / ms:w app:r // Parameter for SetRange request: +1 when RangeFirstItem comes before RangeLastItem, -1 otherwise. Useful if you want to preserve selection order on a backward Shift+Click. ImGuiSelectionUserData RangeFirstItem; // / ms:w, app:r // Parameter for SetRange request (this is generally == RangeSrcItem when shift selecting from top to bottom). ImGuiSelectionUserData RangeLastItem; // / ms:w, app:r // Parameter for SetRange request (this is generally == RangeSrcItem when shift selecting from bottom to top). Inclusive! }; // Optional helper to store multi-selection state + apply multi-selection requests. // - Used by our demos and provided as a convenience to easily implement basic multi-selection. // - Iterate selection with 'void* it = NULL; ImGuiID id; while (selection.GetNextSelectedItem(&it, &id)) { ... }' // Or you can check 'if (Contains(id)) { ... }' for each possible object if their number is not too high to iterate. // - USING THIS IS NOT MANDATORY. This is only a helper and not a required API. // To store a multi-selection, in your application you could: // - Use this helper as a convenience. We use our simple key->value ImGuiStorage as a std::set replacement. // - Use your own external storage: e.g. std::set, std::vector, interval trees, intrusively stored selection etc. // In ImGuiSelectionBasicStorage we: // - always use indices in the multi-selection API (passed to SetNextItemSelectionUserData(), retrieved in ImGuiMultiSelectIO) // - use the AdapterIndexToStorageId() indirection layer to abstract how persistent selection data is derived from an index. // - use decently optimized logic to allow queries and insertion of very large selection sets. // - do not preserve selection order. // Many combinations are possible depending on how you prefer to store your items and how you prefer to store your selection. // Large applications are likely to eventually want to get rid of this indirection layer and do their own thing. // See https://github.com/ocornut/imgui/wiki/Multi-Select for details and pseudo-code using this helper. struct ImGuiSelectionBasicStorage { // Members int Size; // // Number of selected items, maintained by this helper. bool PreserveOrder; // = false // GetNextSelectedItem() will return ordered selection (currently implemented by two additional sorts of selection. Could be improved) void* UserData; // = NULL // User data for use by adapter function // e.g. selection.UserData = (void*)my_items; ImGuiID (*AdapterIndexToStorageId)(ImGuiSelectionBasicStorage* self, int idx); // e.g. selection.AdapterIndexToStorageId = [](ImGuiSelectionBasicStorage* self, int idx) { return ((MyItems**)self->UserData)[idx]->ID; }; int _SelectionOrder;// [Internal] Increasing counter to store selection order ImGuiStorage _Storage; // [Internal] Selection set. Think of this as similar to e.g. std::set. Prefer not accessing directly: iterate with GetNextSelectedItem(). // Methods IMGUI_API ImGuiSelectionBasicStorage(); IMGUI_API void ApplyRequests(ImGuiMultiSelectIO* ms_io); // Apply selection requests coming from BeginMultiSelect() and EndMultiSelect() functions. It uses 'items_count' passed to BeginMultiSelect() IMGUI_API bool Contains(ImGuiID id) const; // Query if an item id is in selection. IMGUI_API void Clear(); // Clear selection IMGUI_API void Swap(ImGuiSelectionBasicStorage& r); // Swap two selections IMGUI_API void SetItemSelected(ImGuiID id, bool selected); // Add/remove an item from selection (generally done by ApplyRequests() function) IMGUI_API bool GetNextSelectedItem(void** opaque_it, ImGuiID* out_id); // Iterate selection with 'void* it = NULL; ImGuiID id; while (selection.GetNextSelectedItem(&it, &id)) { ... }' inline ImGuiID GetStorageIdFromIndex(int idx) { return AdapterIndexToStorageId(this, idx); } // Convert index to item id based on provided adapter. }; // Optional helper to apply multi-selection requests to existing randomly accessible storage. // Convenient if you want to quickly wire multi-select API on e.g. an array of bool or items storing their own selection state. struct ImGuiSelectionExternalStorage { // Members void* UserData; // User data for use by adapter function // e.g. selection.UserData = (void*)my_items; void (*AdapterSetItemSelected)(ImGuiSelectionExternalStorage* self, int idx, bool selected); // e.g. AdapterSetItemSelected = [](ImGuiSelectionExternalStorage* self, int idx, bool selected) { ((MyItems**)self->UserData)[idx]->Selected = selected; } // Methods IMGUI_API ImGuiSelectionExternalStorage(); IMGUI_API void ApplyRequests(ImGuiMultiSelectIO* ms_io); // Apply selection requests by using AdapterSetItemSelected() calls }; //----------------------------------------------------------------------------- // [SECTION] Drawing API (ImDrawCmd, ImDrawIdx, ImDrawVert, ImDrawChannel, ImDrawListSplitter, ImDrawListFlags, ImDrawList, ImDrawData) // Hold a series of drawing commands. The user provides a renderer for ImDrawData which essentially contains an array of ImDrawList. //----------------------------------------------------------------------------- // The maximum line width to bake anti-aliased textures for. Build atlas with ImFontAtlasFlags_NoBakedLines to disable baking. #ifndef IM_DRAWLIST_TEX_LINES_WIDTH_MAX #define IM_DRAWLIST_TEX_LINES_WIDTH_MAX (32) #endif // ImDrawIdx: vertex index. [Compile-time configurable type] // - To use 16-bit indices + allow large meshes: backend need to set 'io.BackendFlags |= ImGuiBackendFlags_RendererHasVtxOffset' and handle ImDrawCmd::VtxOffset (recommended). // - To use 32-bit indices: override with '#define ImDrawIdx unsigned int' in your imconfig.h file. #ifndef ImDrawIdx typedef unsigned short ImDrawIdx; // Default: 16-bit (for maximum compatibility with renderer backends) #endif // ImDrawCallback: Draw callbacks for advanced uses [configurable type: override in imconfig.h] // NB: You most likely do NOT need to use draw callbacks just to create your own widget or customized UI rendering, // you can poke into the draw list for that! Draw callback may be useful for example to: // A) Change your GPU render state, // B) render a complex 3D scene inside a UI element without an intermediate texture/render target, etc. // The expected behavior from your rendering function is 'if (cmd.UserCallback != NULL) { cmd.UserCallback(parent_list, cmd); } else { RenderTriangles() }' // If you want to override the signature of ImDrawCallback, you can simply use e.g. '#define ImDrawCallback MyDrawCallback' (in imconfig.h) + update rendering backend accordingly. #ifndef ImDrawCallback typedef void (*ImDrawCallback)(const ImDrawList* parent_list, const ImDrawCmd* cmd); #endif // Special Draw callback value to request renderer backend to reset the graphics/render state. // The renderer backend needs to handle this special value, otherwise it will crash trying to call a function at this address. // This is useful, for example, if you submitted callbacks which you know have altered the render state and you want it to be restored. // Render state is not reset by default because they are many perfectly useful way of altering render state (e.g. changing shader/blending settings before an Image call). #define ImDrawCallback_ResetRenderState (ImDrawCallback)(-8) // Typically, 1 command = 1 GPU draw call (unless command is a callback) // - VtxOffset: When 'io.BackendFlags & ImGuiBackendFlags_RendererHasVtxOffset' is enabled, // this fields allow us to render meshes larger than 64K vertices while keeping 16-bit indices. // Backends made for <1.71. will typically ignore the VtxOffset fields. // - The ClipRect/TextureId/VtxOffset fields must be contiguous as we memcmp() them together (this is asserted for). struct ImDrawCmd { ImVec4 ClipRect; // 4*4 // Clipping rectangle (x1, y1, x2, y2). Subtract ImDrawData->DisplayPos to get clipping rectangle in "viewport" coordinates ImTextureID TextureId; // 4-8 // User-provided texture ID. Set by user in ImfontAtlas::SetTexID() for fonts or passed to Image*() functions. Ignore if never using images or multiple fonts atlas. unsigned int VtxOffset; // 4 // Start offset in vertex buffer. ImGuiBackendFlags_RendererHasVtxOffset: always 0, otherwise may be >0 to support meshes larger than 64K vertices with 16-bit indices. unsigned int IdxOffset; // 4 // Start offset in index buffer. unsigned int ElemCount; // 4 // Number of indices (multiple of 3) to be rendered as triangles. Vertices are stored in the callee ImDrawList's vtx_buffer[] array, indices in idx_buffer[]. ImDrawCallback UserCallback; // 4-8 // If != NULL, call the function instead of rendering the vertices. clip_rect and texture_id will be set normally. void* UserCallbackData; // 4-8 // Callback user data (when UserCallback != NULL). If called AddCallback() with size == 0, this is a copy of the AddCallback() argument. If called AddCallback() with size > 0, this is pointing to a buffer where data is stored. int UserCallbackDataSize; // 4 // Size of callback user data when using storage, otherwise 0. int UserCallbackDataOffset;// 4 // [Internal] Offset of callback user data when using storage, otherwise -1. ImDrawCmd() { memset(this, 0, sizeof(*this)); } // Also ensure our padding fields are zeroed // Since 1.83: returns ImTextureID associated with this draw call. Warning: DO NOT assume this is always same as 'TextureId' (we will change this function for an upcoming feature) inline ImTextureID GetTexID() const { return TextureId; } }; // Vertex layout #ifndef IMGUI_OVERRIDE_DRAWVERT_STRUCT_LAYOUT struct ImDrawVert { ImVec2 pos; ImVec2 uv; ImU32 col; }; #else // You can override the vertex format layout by defining IMGUI_OVERRIDE_DRAWVERT_STRUCT_LAYOUT in imconfig.h // The code expect ImVec2 pos (8 bytes), ImVec2 uv (8 bytes), ImU32 col (4 bytes), but you can re-order them or add other fields as needed to simplify integration in your engine. // The type has to be described within the macro (you can either declare the struct or use a typedef). This is because ImVec2/ImU32 are likely not declared at the time you'd want to set your type up. // NOTE: IMGUI DOESN'T CLEAR THE STRUCTURE AND DOESN'T CALL A CONSTRUCTOR SO ANY CUSTOM FIELD WILL BE UNINITIALIZED. IF YOU ADD EXTRA FIELDS (SUCH AS A 'Z' COORDINATES) YOU WILL NEED TO CLEAR THEM DURING RENDER OR TO IGNORE THEM. IMGUI_OVERRIDE_DRAWVERT_STRUCT_LAYOUT; #endif // [Internal] For use by ImDrawList struct ImDrawCmdHeader { ImVec4 ClipRect; ImTextureID TextureId; unsigned int VtxOffset; }; // [Internal] For use by ImDrawListSplitter struct ImDrawChannel { ImVector _CmdBuffer; ImVector _IdxBuffer; }; // Split/Merge functions are used to split the draw list into different layers which can be drawn into out of order. // This is used by the Columns/Tables API, so items of each column can be batched together in a same draw call. struct ImDrawListSplitter { int _Current; // Current channel number (0) int _Count; // Number of active channels (1+) ImVector _Channels; // Draw channels (not resized down so _Count might be < Channels.Size) inline ImDrawListSplitter() { memset(this, 0, sizeof(*this)); } inline ~ImDrawListSplitter() { ClearFreeMemory(); } inline void Clear() { _Current = 0; _Count = 1; } // Do not clear Channels[] so our allocations are reused next frame IMGUI_API void ClearFreeMemory(); IMGUI_API void Split(ImDrawList* draw_list, int count); IMGUI_API void Merge(ImDrawList* draw_list); IMGUI_API void SetCurrentChannel(ImDrawList* draw_list, int channel_idx); }; // Flags for ImDrawList functions // (Legacy: bit 0 must always correspond to ImDrawFlags_Closed to be backward compatible with old API using a bool. Bits 1..3 must be unused) enum ImDrawFlags_ { ImDrawFlags_None = 0, ImDrawFlags_Closed = 1 << 0, // PathStroke(), AddPolyline(): specify that shape should be closed (Important: this is always == 1 for legacy reason) ImDrawFlags_RoundCornersTopLeft = 1 << 4, // AddRect(), AddRectFilled(), PathRect(): enable rounding top-left corner only (when rounding > 0.0f, we default to all corners). Was 0x01. ImDrawFlags_RoundCornersTopRight = 1 << 5, // AddRect(), AddRectFilled(), PathRect(): enable rounding top-right corner only (when rounding > 0.0f, we default to all corners). Was 0x02. ImDrawFlags_RoundCornersBottomLeft = 1 << 6, // AddRect(), AddRectFilled(), PathRect(): enable rounding bottom-left corner only (when rounding > 0.0f, we default to all corners). Was 0x04. ImDrawFlags_RoundCornersBottomRight = 1 << 7, // AddRect(), AddRectFilled(), PathRect(): enable rounding bottom-right corner only (when rounding > 0.0f, we default to all corners). Wax 0x08. ImDrawFlags_RoundCornersNone = 1 << 8, // AddRect(), AddRectFilled(), PathRect(): disable rounding on all corners (when rounding > 0.0f). This is NOT zero, NOT an implicit flag! ImDrawFlags_RoundCornersTop = ImDrawFlags_RoundCornersTopLeft | ImDrawFlags_RoundCornersTopRight, ImDrawFlags_RoundCornersBottom = ImDrawFlags_RoundCornersBottomLeft | ImDrawFlags_RoundCornersBottomRight, ImDrawFlags_RoundCornersLeft = ImDrawFlags_RoundCornersBottomLeft | ImDrawFlags_RoundCornersTopLeft, ImDrawFlags_RoundCornersRight = ImDrawFlags_RoundCornersBottomRight | ImDrawFlags_RoundCornersTopRight, ImDrawFlags_RoundCornersAll = ImDrawFlags_RoundCornersTopLeft | ImDrawFlags_RoundCornersTopRight | ImDrawFlags_RoundCornersBottomLeft | ImDrawFlags_RoundCornersBottomRight, ImDrawFlags_RoundCornersDefault_ = ImDrawFlags_RoundCornersAll, // Default to ALL corners if none of the _RoundCornersXX flags are specified. ImDrawFlags_RoundCornersMask_ = ImDrawFlags_RoundCornersAll | ImDrawFlags_RoundCornersNone, }; // Flags for ImDrawList instance. Those are set automatically by ImGui:: functions from ImGuiIO settings, and generally not manipulated directly. // It is however possible to temporarily alter flags between calls to ImDrawList:: functions. enum ImDrawListFlags_ { ImDrawListFlags_None = 0, ImDrawListFlags_AntiAliasedLines = 1 << 0, // Enable anti-aliased lines/borders (*2 the number of triangles for 1.0f wide line or lines thin enough to be drawn using textures, otherwise *3 the number of triangles) ImDrawListFlags_AntiAliasedLinesUseTex = 1 << 1, // Enable anti-aliased lines/borders using textures when possible. Require backend to render with bilinear filtering (NOT point/nearest filtering). ImDrawListFlags_AntiAliasedFill = 1 << 2, // Enable anti-aliased edge around filled shapes (rounded rectangles, circles). ImDrawListFlags_AllowVtxOffset = 1 << 3, // Can emit 'VtxOffset > 0' to allow large meshes. Set when 'ImGuiBackendFlags_RendererHasVtxOffset' is enabled. }; // Draw command list // This is the low-level list of polygons that ImGui:: functions are filling. At the end of the frame, // all command lists are passed to your ImGuiIO::RenderDrawListFn function for rendering. // Each dear imgui window contains its own ImDrawList. You can use ImGui::GetWindowDrawList() to // access the current window draw list and draw custom primitives. // You can interleave normal ImGui:: calls and adding primitives to the current draw list. // In single viewport mode, top-left is == GetMainViewport()->Pos (generally 0,0), bottom-right is == GetMainViewport()->Pos+Size (generally io.DisplaySize). // You are totally free to apply whatever transformation matrix you want to the data (depending on the use of the transformation you may want to apply it to ClipRect as well!) // Important: Primitives are always added to the list and not culled (culling is done at higher-level by ImGui:: functions), if you use this API a lot consider coarse culling your drawn objects. struct ImDrawList { // This is what you have to render ImVector CmdBuffer; // Draw commands. Typically 1 command = 1 GPU draw call, unless the command is a callback. ImVector IdxBuffer; // Index buffer. Each command consume ImDrawCmd::ElemCount of those ImVector VtxBuffer; // Vertex buffer. ImDrawListFlags Flags; // Flags, you may poke into these to adjust anti-aliasing settings per-primitive. // [Internal, used while building lists] unsigned int _VtxCurrentIdx; // [Internal] generally == VtxBuffer.Size unless we are past 64K vertices, in which case this gets reset to 0. ImDrawListSharedData* _Data; // Pointer to shared draw data (you can use ImGui::GetDrawListSharedData() to get the one from current ImGui context) ImDrawVert* _VtxWritePtr; // [Internal] point within VtxBuffer.Data after each add command (to avoid using the ImVector<> operators too much) ImDrawIdx* _IdxWritePtr; // [Internal] point within IdxBuffer.Data after each add command (to avoid using the ImVector<> operators too much) ImVector _Path; // [Internal] current path building ImDrawCmdHeader _CmdHeader; // [Internal] template of active commands. Fields should match those of CmdBuffer.back(). ImDrawListSplitter _Splitter; // [Internal] for channels api (note: prefer using your own persistent instance of ImDrawListSplitter!) ImVector _ClipRectStack; // [Internal] ImVector _TextureIdStack; // [Internal] ImVector _CallbacksDataBuf; // [Internal] float _FringeScale; // [Internal] anti-alias fringe is scaled by this value, this helps to keep things sharp while zooming at vertex buffer content const char* _OwnerName; // Pointer to owner window's name for debugging // If you want to create ImDrawList instances, pass them ImGui::GetDrawListSharedData(). // (advanced: you may create and use your own ImDrawListSharedData so you can use ImDrawList without ImGui, but that's more involved) IMGUI_API ImDrawList(ImDrawListSharedData* shared_data); IMGUI_API ~ImDrawList(); IMGUI_API void PushClipRect(const ImVec2& clip_rect_min, const ImVec2& clip_rect_max, bool intersect_with_current_clip_rect = false); // Render-level scissoring. This is passed down to your render function but not used for CPU-side coarse clipping. Prefer using higher-level ImGui::PushClipRect() to affect logic (hit-testing and widget culling) IMGUI_API void PushClipRectFullScreen(); IMGUI_API void PopClipRect(); IMGUI_API void PushTextureID(ImTextureID texture_id); IMGUI_API void PopTextureID(); inline ImVec2 GetClipRectMin() const { const ImVec4& cr = _ClipRectStack.back(); return ImVec2(cr.x, cr.y); } inline ImVec2 GetClipRectMax() const { const ImVec4& cr = _ClipRectStack.back(); return ImVec2(cr.z, cr.w); } // Primitives // - Filled shapes must always use clockwise winding order. The anti-aliasing fringe depends on it. Counter-clockwise shapes will have "inward" anti-aliasing. // - For rectangular primitives, "p_min" and "p_max" represent the upper-left and lower-right corners. // - For circle primitives, use "num_segments == 0" to automatically calculate tessellation (preferred). // In older versions (until Dear ImGui 1.77) the AddCircle functions defaulted to num_segments == 12. // In future versions we will use textures to provide cheaper and higher-quality circles. // Use AddNgon() and AddNgonFilled() functions if you need to guarantee a specific number of sides. IMGUI_API void AddLine(const ImVec2& p1, const ImVec2& p2, ImU32 col, float thickness = 1.0f); IMGUI_API void AddRect(const ImVec2& p_min, const ImVec2& p_max, ImU32 col, float rounding = 0.0f, ImDrawFlags flags = 0, float thickness = 1.0f); // a: upper-left, b: lower-right (== upper-left + size) IMGUI_API void AddRectFilled(const ImVec2& p_min, const ImVec2& p_max, ImU32 col, float rounding = 0.0f, ImDrawFlags flags = 0); // a: upper-left, b: lower-right (== upper-left + size) IMGUI_API void AddRectFilledMultiColor(const ImVec2& p_min, const ImVec2& p_max, ImU32 col_upr_left, ImU32 col_upr_right, ImU32 col_bot_right, ImU32 col_bot_left); IMGUI_API void AddQuad(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, ImU32 col, float thickness = 1.0f); IMGUI_API void AddQuadFilled(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, ImU32 col); IMGUI_API void AddTriangle(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, ImU32 col, float thickness = 1.0f); IMGUI_API void AddTriangleFilled(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, ImU32 col); IMGUI_API void AddCircle(const ImVec2& center, float radius, ImU32 col, int num_segments = 0, float thickness = 1.0f); IMGUI_API void AddCircleFilled(const ImVec2& center, float radius, ImU32 col, int num_segments = 0); IMGUI_API void AddNgon(const ImVec2& center, float radius, ImU32 col, int num_segments, float thickness = 1.0f); IMGUI_API void AddNgonFilled(const ImVec2& center, float radius, ImU32 col, int num_segments); IMGUI_API void AddEllipse(const ImVec2& center, const ImVec2& radius, ImU32 col, float rot = 0.0f, int num_segments = 0, float thickness = 1.0f); IMGUI_API void AddEllipseFilled(const ImVec2& center, const ImVec2& radius, ImU32 col, float rot = 0.0f, int num_segments = 0); IMGUI_API void AddText(const ImVec2& pos, ImU32 col, const char* text_begin, const char* text_end = NULL); IMGUI_API void AddText(ImFont* font, float font_size, const ImVec2& pos, ImU32 col, const char* text_begin, const char* text_end = NULL, float wrap_width = 0.0f, const ImVec4* cpu_fine_clip_rect = NULL); IMGUI_API void AddBezierCubic(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, ImU32 col, float thickness, int num_segments = 0); // Cubic Bezier (4 control points) IMGUI_API void AddBezierQuadratic(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, ImU32 col, float thickness, int num_segments = 0); // Quadratic Bezier (3 control points) // General polygon // - Only simple polygons are supported by filling functions (no self-intersections, no holes). // - Concave polygon fill is more expensive than convex one: it has O(N^2) complexity. Provided as a convenience for the user but not used by the main library. IMGUI_API void AddPolyline(const ImVec2* points, int num_points, ImU32 col, ImDrawFlags flags, float thickness); IMGUI_API void AddConvexPolyFilled(const ImVec2* points, int num_points, ImU32 col); IMGUI_API void AddConcavePolyFilled(const ImVec2* points, int num_points, ImU32 col); // Image primitives // - Read FAQ to understand what ImTextureID is. // - "p_min" and "p_max" represent the upper-left and lower-right corners of the rectangle. // - "uv_min" and "uv_max" represent the normalized texture coordinates to use for those corners. Using (0,0)->(1,1) texture coordinates will generally display the entire texture. IMGUI_API void AddImage(ImTextureID user_texture_id, const ImVec2& p_min, const ImVec2& p_max, const ImVec2& uv_min = ImVec2(0, 0), const ImVec2& uv_max = ImVec2(1, 1), ImU32 col = IM_COL32_WHITE); IMGUI_API void AddImageQuad(ImTextureID user_texture_id, const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, const ImVec2& uv1 = ImVec2(0, 0), const ImVec2& uv2 = ImVec2(1, 0), const ImVec2& uv3 = ImVec2(1, 1), const ImVec2& uv4 = ImVec2(0, 1), ImU32 col = IM_COL32_WHITE); IMGUI_API void AddImageRounded(ImTextureID user_texture_id, const ImVec2& p_min, const ImVec2& p_max, const ImVec2& uv_min, const ImVec2& uv_max, ImU32 col, float rounding, ImDrawFlags flags = 0); // Stateful path API, add points then finish with PathFillConvex() or PathStroke() // - Important: filled shapes must always use clockwise winding order! The anti-aliasing fringe depends on it. Counter-clockwise shapes will have "inward" anti-aliasing. // so e.g. 'PathArcTo(center, radius, PI * -0.5f, PI)' is ok, whereas 'PathArcTo(center, radius, PI, PI * -0.5f)' won't have correct anti-aliasing when followed by PathFillConvex(). inline void PathClear() { _Path.Size = 0; } inline void PathLineTo(const ImVec2& pos) { _Path.push_back(pos); } inline void PathLineToMergeDuplicate(const ImVec2& pos) { if (_Path.Size == 0 || memcmp(&_Path.Data[_Path.Size - 1], &pos, 8) != 0) _Path.push_back(pos); } inline void PathFillConvex(ImU32 col) { AddConvexPolyFilled(_Path.Data, _Path.Size, col); _Path.Size = 0; } inline void PathFillConcave(ImU32 col) { AddConcavePolyFilled(_Path.Data, _Path.Size, col); _Path.Size = 0; } inline void PathStroke(ImU32 col, ImDrawFlags flags = 0, float thickness = 1.0f) { AddPolyline(_Path.Data, _Path.Size, col, flags, thickness); _Path.Size = 0; } IMGUI_API void PathArcTo(const ImVec2& center, float radius, float a_min, float a_max, int num_segments = 0); IMGUI_API void PathArcToFast(const ImVec2& center, float radius, int a_min_of_12, int a_max_of_12); // Use precomputed angles for a 12 steps circle IMGUI_API void PathEllipticalArcTo(const ImVec2& center, const ImVec2& radius, float rot, float a_min, float a_max, int num_segments = 0); // Ellipse IMGUI_API void PathBezierCubicCurveTo(const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, int num_segments = 0); // Cubic Bezier (4 control points) IMGUI_API void PathBezierQuadraticCurveTo(const ImVec2& p2, const ImVec2& p3, int num_segments = 0); // Quadratic Bezier (3 control points) IMGUI_API void PathRect(const ImVec2& rect_min, const ImVec2& rect_max, float rounding = 0.0f, ImDrawFlags flags = 0); // Advanced: Draw Callbacks // - May be used to alter render state (change sampler, blending, current shader). May be used to emit custom rendering commands (difficult to do correctly, but possible). // - Use special ImDrawCallback_ResetRenderState callback to instruct backend to reset its render state to the default. // - Your rendering loop must check for 'UserCallback' in ImDrawCmd and call the function instead of rendering triangles. All standard backends are honoring this. // - For some backends, the callback may access selected render-states exposed by the backend in a ImGui_ImplXXXX_RenderState structure pointed to by platform_io.Renderer_RenderState. // - IMPORTANT: please be mindful of the different level of indirection between using size==0 (copying argument) and using size>0 (copying pointed data into a buffer). // - If userdata_size == 0: we copy/store the 'userdata' argument as-is. It will be available unmodified in ImDrawCmd::UserCallbackData during render. // - If userdata_size > 0, we copy/store 'userdata_size' bytes pointed to by 'userdata'. We store them in a buffer stored inside the drawlist. ImDrawCmd::UserCallbackData will point inside that buffer so you have to retrieve data from there. Your callback may need to use ImDrawCmd::UserCallbackDataSize if you expect dynamically-sized data. // - Support for userdata_size > 0 was added in v1.91.4, October 2024. So earlier code always only allowed to copy/store a simple void*. IMGUI_API void AddCallback(ImDrawCallback callback, void* userdata, size_t userdata_size = 0); // Advanced: Miscellaneous IMGUI_API void AddDrawCmd(); // This is useful if you need to forcefully create a new draw call (to allow for dependent rendering / blending). Otherwise primitives are merged into the same draw-call as much as possible IMGUI_API ImDrawList* CloneOutput() const; // Create a clone of the CmdBuffer/IdxBuffer/VtxBuffer. // Advanced: Channels // - Use to split render into layers. By switching channels to can render out-of-order (e.g. submit FG primitives before BG primitives) // - Use to minimize draw calls (e.g. if going back-and-forth between multiple clipping rectangles, prefer to append into separate channels then merge at the end) // - This API shouldn't have been in ImDrawList in the first place! // Prefer using your own persistent instance of ImDrawListSplitter as you can stack them. // Using the ImDrawList::ChannelsXXXX you cannot stack a split over another. inline void ChannelsSplit(int count) { _Splitter.Split(this, count); } inline void ChannelsMerge() { _Splitter.Merge(this); } inline void ChannelsSetCurrent(int n) { _Splitter.SetCurrentChannel(this, n); } // Advanced: Primitives allocations // - We render triangles (three vertices) // - All primitives needs to be reserved via PrimReserve() beforehand. IMGUI_API void PrimReserve(int idx_count, int vtx_count); IMGUI_API void PrimUnreserve(int idx_count, int vtx_count); IMGUI_API void PrimRect(const ImVec2& a, const ImVec2& b, ImU32 col); // Axis aligned rectangle (composed of two triangles) IMGUI_API void PrimRectUV(const ImVec2& a, const ImVec2& b, const ImVec2& uv_a, const ImVec2& uv_b, ImU32 col); IMGUI_API void PrimQuadUV(const ImVec2& a, const ImVec2& b, const ImVec2& c, const ImVec2& d, const ImVec2& uv_a, const ImVec2& uv_b, const ImVec2& uv_c, const ImVec2& uv_d, ImU32 col); inline void PrimWriteVtx(const ImVec2& pos, const ImVec2& uv, ImU32 col) { _VtxWritePtr->pos = pos; _VtxWritePtr->uv = uv; _VtxWritePtr->col = col; _VtxWritePtr++; _VtxCurrentIdx++; } inline void PrimWriteIdx(ImDrawIdx idx) { *_IdxWritePtr = idx; _IdxWritePtr++; } inline void PrimVtx(const ImVec2& pos, const ImVec2& uv, ImU32 col) { PrimWriteIdx((ImDrawIdx)_VtxCurrentIdx); PrimWriteVtx(pos, uv, col); } // Write vertex with unique index // Obsolete names //inline void AddEllipse(const ImVec2& center, float radius_x, float radius_y, ImU32 col, float rot = 0.0f, int num_segments = 0, float thickness = 1.0f) { AddEllipse(center, ImVec2(radius_x, radius_y), col, rot, num_segments, thickness); } // OBSOLETED in 1.90.5 (Mar 2024) //inline void AddEllipseFilled(const ImVec2& center, float radius_x, float radius_y, ImU32 col, float rot = 0.0f, int num_segments = 0) { AddEllipseFilled(center, ImVec2(radius_x, radius_y), col, rot, num_segments); } // OBSOLETED in 1.90.5 (Mar 2024) //inline void PathEllipticalArcTo(const ImVec2& center, float radius_x, float radius_y, float rot, float a_min, float a_max, int num_segments = 0) { PathEllipticalArcTo(center, ImVec2(radius_x, radius_y), rot, a_min, a_max, num_segments); } // OBSOLETED in 1.90.5 (Mar 2024) //inline void AddBezierCurve(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, ImU32 col, float thickness, int num_segments = 0) { AddBezierCubic(p1, p2, p3, p4, col, thickness, num_segments); } // OBSOLETED in 1.80 (Jan 2021) //inline void PathBezierCurveTo(const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, int num_segments = 0) { PathBezierCubicCurveTo(p2, p3, p4, num_segments); } // OBSOLETED in 1.80 (Jan 2021) // [Internal helpers] IMGUI_API void _ResetForNewFrame(); IMGUI_API void _ClearFreeMemory(); IMGUI_API void _PopUnusedDrawCmd(); IMGUI_API void _TryMergeDrawCmds(); IMGUI_API void _OnChangedClipRect(); IMGUI_API void _OnChangedTextureID(); IMGUI_API void _OnChangedVtxOffset(); IMGUI_API void _SetTextureID(ImTextureID texture_id); IMGUI_API int _CalcCircleAutoSegmentCount(float radius) const; IMGUI_API void _PathArcToFastEx(const ImVec2& center, float radius, int a_min_sample, int a_max_sample, int a_step); IMGUI_API void _PathArcToN(const ImVec2& center, float radius, float a_min, float a_max, int num_segments); }; // All draw data to render a Dear ImGui frame // (NB: the style and the naming convention here is a little inconsistent, we currently preserve them for backward compatibility purpose, // as this is one of the oldest structure exposed by the library! Basically, ImDrawList == CmdList) struct ImDrawData { bool Valid; // Only valid after Render() is called and before the next NewFrame() is called. int CmdListsCount; // Number of ImDrawList* to render (should always be == CmdLists.size) int TotalIdxCount; // For convenience, sum of all ImDrawList's IdxBuffer.Size int TotalVtxCount; // For convenience, sum of all ImDrawList's VtxBuffer.Size ImVector CmdLists; // Array of ImDrawList* to render. The ImDrawLists are owned by ImGuiContext and only pointed to from here. ImVec2 DisplayPos; // Top-left position of the viewport to render (== top-left of the orthogonal projection matrix to use) (== GetMainViewport()->Pos for the main viewport, == (0.0) in most single-viewport applications) ImVec2 DisplaySize; // Size of the viewport to render (== GetMainViewport()->Size for the main viewport, == io.DisplaySize in most single-viewport applications) ImVec2 FramebufferScale; // Amount of pixels for each unit of DisplaySize. Based on io.DisplayFramebufferScale. Generally (1,1) on normal display, (2,2) on OSX with Retina display. ImGuiViewport* OwnerViewport; // Viewport carrying the ImDrawData instance, might be of use to the renderer (generally not). // Functions ImDrawData() { Clear(); } IMGUI_API void Clear(); IMGUI_API void AddDrawList(ImDrawList* draw_list); // Helper to add an external draw list into an existing ImDrawData. IMGUI_API void DeIndexAllBuffers(); // Helper to convert all buffers from indexed to non-indexed, in case you cannot render indexed. Note: this is slow and most likely a waste of resources. Always prefer indexed rendering! IMGUI_API void ScaleClipRects(const ImVec2& fb_scale); // Helper to scale the ClipRect field of each ImDrawCmd. Use if your final output buffer is at a different scale than Dear ImGui expects, or if there is a difference between your window resolution and framebuffer resolution. }; //----------------------------------------------------------------------------- // [SECTION] Font API (ImFontConfig, ImFontGlyph, ImFontAtlasFlags, ImFontAtlas, ImFontGlyphRangesBuilder, ImFont) //----------------------------------------------------------------------------- // A font input/source (we may rename this to ImFontSource in the future) struct ImFontConfig { void* FontData; // // TTF/OTF data int FontDataSize; // // TTF/OTF data size bool FontDataOwnedByAtlas; // true // TTF/OTF data ownership taken by the container ImFontAtlas (will delete memory itself). bool MergeMode; // false // Merge into previous ImFont, so you can combine multiple inputs font into one ImFont (e.g. ASCII font + icons + Japanese glyphs). You may want to use GlyphOffset.y when merge font of different heights. bool PixelSnapH; // false // Align every glyph AdvanceX to pixel boundaries. Useful e.g. if you are merging a non-pixel aligned font with the default font. If enabled, you can set OversampleH/V to 1. int FontNo; // 0 // Index of font within TTF/OTF file int OversampleH; // 0 (2) // Rasterize at higher quality for sub-pixel positioning. 0 == auto == 1 or 2 depending on size. Note the difference between 2 and 3 is minimal. You can reduce this to 1 for large glyphs save memory. Read https://github.com/nothings/stb/blob/master/tests/oversample/README.md for details. int OversampleV; // 0 (1) // Rasterize at higher quality for sub-pixel positioning. 0 == auto == 1. This is not really useful as we don't use sub-pixel positions on the Y axis. float SizePixels; // // Size in pixels for rasterizer (more or less maps to the resulting font height). //ImVec2 GlyphExtraSpacing; // 0, 0 // (REMOVED IN 1.91.9: use GlyphExtraAdvanceX) ImVec2 GlyphOffset; // 0, 0 // Offset all glyphs from this font input. const ImWchar* GlyphRanges; // NULL // THE ARRAY DATA NEEDS TO PERSIST AS LONG AS THE FONT IS ALIVE. Pointer to a user-provided list of Unicode range (2 value per range, values are inclusive, zero-terminated list). float GlyphMinAdvanceX; // 0 // Minimum AdvanceX for glyphs, set Min to align font icons, set both Min/Max to enforce mono-space font float GlyphMaxAdvanceX; // FLT_MAX // Maximum AdvanceX for glyphs float GlyphExtraAdvanceX; // 0 // Extra spacing (in pixels) between glyphs. Please contact us if you are using this. unsigned int FontBuilderFlags; // 0 // Settings for custom font builder. THIS IS BUILDER IMPLEMENTATION DEPENDENT. Leave as zero if unsure. float RasterizerMultiply; // 1.0f // Linearly brighten (>1.0f) or darken (<1.0f) font output. Brightening small fonts may be a good workaround to make them more readable. This is a silly thing we may remove in the future. float RasterizerDensity; // 1.0f // DPI scale for rasterization, not altering other font metrics: make it easy to swap between e.g. a 100% and a 400% fonts for a zooming display. IMPORTANT: If you increase this it is expected that you increase font scale accordingly, otherwise quality may look lowered. ImWchar EllipsisChar; // 0 // Explicitly specify Unicode codepoint of ellipsis character. When fonts are being merged first specified ellipsis will be used. // [Internal] char Name[40]; // Name (strictly to ease debugging) ImFont* DstFont; IMGUI_API ImFontConfig(); }; // Hold rendering data for one glyph. // (Note: some language parsers may fail to convert the 31+1 bitfield members, in this case maybe drop store a single u32 or we can rework this) struct ImFontGlyph { unsigned int Colored : 1; // Flag to indicate glyph is colored and should generally ignore tinting (make it usable with no shift on little-endian as this is used in loops) unsigned int Visible : 1; // Flag to indicate glyph has no visible pixels (e.g. space). Allow early out when rendering. unsigned int Codepoint : 30; // 0x0000..0x10FFFF float AdvanceX; // Horizontal distance to advance layout with float X0, Y0, X1, Y1; // Glyph corners float U0, V0, U1, V1; // Texture coordinates }; // Helper to build glyph ranges from text/string data. Feed your application strings/characters to it then call BuildRanges(). // This is essentially a tightly packed of vector of 64k booleans = 8KB storage. struct ImFontGlyphRangesBuilder { ImVector UsedChars; // Store 1-bit per Unicode code point (0=unused, 1=used) ImFontGlyphRangesBuilder() { Clear(); } inline void Clear() { int size_in_bytes = (IM_UNICODE_CODEPOINT_MAX + 1) / 8; UsedChars.resize(size_in_bytes / (int)sizeof(ImU32)); memset(UsedChars.Data, 0, (size_t)size_in_bytes); } inline bool GetBit(size_t n) const { int off = (int)(n >> 5); ImU32 mask = 1u << (n & 31); return (UsedChars[off] & mask) != 0; } // Get bit n in the array inline void SetBit(size_t n) { int off = (int)(n >> 5); ImU32 mask = 1u << (n & 31); UsedChars[off] |= mask; } // Set bit n in the array inline void AddChar(ImWchar c) { SetBit(c); } // Add character IMGUI_API void AddText(const char* text, const char* text_end = NULL); // Add string (each character of the UTF-8 string are added) IMGUI_API void AddRanges(const ImWchar* ranges); // Add ranges, e.g. builder.AddRanges(ImFontAtlas::GetGlyphRangesDefault()) to force add all of ASCII/Latin+Ext IMGUI_API void BuildRanges(ImVector* out_ranges); // Output new ranges }; // See ImFontAtlas::AddCustomRectXXX functions. struct ImFontAtlasCustomRect { unsigned short X, Y; // Output // Packed position in Atlas // [Internal] unsigned short Width, Height; // Input // Desired rectangle dimension unsigned int GlyphID : 31; // Input // For custom font glyphs only (ID < 0x110000) unsigned int GlyphColored : 1; // Input // For custom font glyphs only: glyph is colored, removed tinting. float GlyphAdvanceX; // Input // For custom font glyphs only: glyph xadvance ImVec2 GlyphOffset; // Input // For custom font glyphs only: glyph display offset ImFont* Font; // Input // For custom font glyphs only: target font ImFontAtlasCustomRect() { X = Y = 0xFFFF; Width = Height = 0; GlyphID = 0; GlyphColored = 0; GlyphAdvanceX = 0.0f; GlyphOffset = ImVec2(0, 0); Font = NULL; } bool IsPacked() const { return X != 0xFFFF; } }; // Flags for ImFontAtlas build enum ImFontAtlasFlags_ { ImFontAtlasFlags_None = 0, ImFontAtlasFlags_NoPowerOfTwoHeight = 1 << 0, // Don't round the height to next power of two ImFontAtlasFlags_NoMouseCursors = 1 << 1, // Don't build software mouse cursors into the atlas (save a little texture memory) ImFontAtlasFlags_NoBakedLines = 1 << 2, // Don't build thick line textures into the atlas (save a little texture memory, allow support for point/nearest filtering). The AntiAliasedLinesUseTex features uses them, otherwise they will be rendered using polygons (more expensive for CPU/GPU). }; // Load and rasterize multiple TTF/OTF fonts into a same texture. The font atlas will build a single texture holding: // - One or more fonts. // - Custom graphics data needed to render the shapes needed by Dear ImGui. // - Mouse cursor shapes for software cursor rendering (unless setting 'Flags |= ImFontAtlasFlags_NoMouseCursors' in the font atlas). // It is the user-code responsibility to setup/build the atlas, then upload the pixel data into a texture accessible by your graphics api. // - Optionally, call any of the AddFont*** functions. If you don't call any, the default font embedded in the code will be loaded for you. // - Call GetTexDataAsAlpha8() or GetTexDataAsRGBA32() to build and retrieve pixels data. // - Upload the pixels data into a texture within your graphics system (see imgui_impl_xxxx.cpp examples) // - Call SetTexID(my_tex_id); and pass the pointer/identifier to your texture in a format natural to your graphics API. // This value will be passed back to you during rendering to identify the texture. Read FAQ entry about ImTextureID for more details. // Common pitfalls: // - If you pass a 'glyph_ranges' array to AddFont*** functions, you need to make sure that your array persist up until the // atlas is build (when calling GetTexData*** or Build()). We only copy the pointer, not the data. // - Important: By default, AddFontFromMemoryTTF() takes ownership of the data. Even though we are not writing to it, we will free the pointer on destruction. // You can set font_cfg->FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed, // - Even though many functions are suffixed with "TTF", OTF data is supported just as well. // - This is an old API and it is currently awkward for those and various other reasons! We will address them in the future! struct ImFontAtlas { IMGUI_API ImFontAtlas(); IMGUI_API ~ImFontAtlas(); IMGUI_API ImFont* AddFont(const ImFontConfig* font_cfg); IMGUI_API ImFont* AddFontDefault(const ImFontConfig* font_cfg = NULL); IMGUI_API ImFont* AddFontFromFileTTF(const char* filename, float size_pixels, const ImFontConfig* font_cfg = NULL, const ImWchar* glyph_ranges = NULL); IMGUI_API ImFont* AddFontFromMemoryTTF(void* font_data, int font_data_size, float size_pixels, const ImFontConfig* font_cfg = NULL, const ImWchar* glyph_ranges = NULL); // Note: Transfer ownership of 'ttf_data' to ImFontAtlas! Will be deleted after destruction of the atlas. Set font_cfg->FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed. IMGUI_API ImFont* AddFontFromMemoryCompressedTTF(const void* compressed_font_data, int compressed_font_data_size, float size_pixels, const ImFontConfig* font_cfg = NULL, const ImWchar* glyph_ranges = NULL); // 'compressed_font_data' still owned by caller. Compress with binary_to_compressed_c.cpp. IMGUI_API ImFont* AddFontFromMemoryCompressedBase85TTF(const char* compressed_font_data_base85, float size_pixels, const ImFontConfig* font_cfg = NULL, const ImWchar* glyph_ranges = NULL); // 'compressed_font_data_base85' still owned by caller. Compress with binary_to_compressed_c.cpp with -base85 parameter. IMGUI_API void ClearInputData(); // Clear input data (all ImFontConfig structures including sizes, TTF data, glyph ranges, etc.) = all the data used to build the texture and fonts. IMGUI_API void ClearFonts(); // Clear input+output font data (same as ClearInputData() + glyphs storage, UV coordinates). IMGUI_API void ClearTexData(); // Clear output texture data (CPU side). Saves RAM once the texture has been copied to graphics memory. IMGUI_API void Clear(); // Clear all input and output. // Build atlas, retrieve pixel data. // User is in charge of copying the pixels into graphics memory (e.g. create a texture with your engine). Then store your texture handle with SetTexID(). // The pitch is always = Width * BytesPerPixels (1 or 4) // Building in RGBA32 format is provided for convenience and compatibility, but note that unless you manually manipulate or copy color data into // the texture (e.g. when using the AddCustomRect*** api), then the RGB pixels emitted will always be white (~75% of memory/bandwidth waste. IMGUI_API bool Build(); // Build pixels data. This is called automatically for you by the GetTexData*** functions. IMGUI_API void GetTexDataAsAlpha8(unsigned char** out_pixels, int* out_width, int* out_height, int* out_bytes_per_pixel = NULL); // 1 byte per-pixel IMGUI_API void GetTexDataAsRGBA32(unsigned char** out_pixels, int* out_width, int* out_height, int* out_bytes_per_pixel = NULL); // 4 bytes-per-pixel bool IsBuilt() const { return Fonts.Size > 0 && TexReady; } // Bit ambiguous: used to detect when user didn't build texture but effectively we should check TexID != 0 except that would be backend dependent... void SetTexID(ImTextureID id) { TexID = id; } //------------------------------------------- // Glyph Ranges //------------------------------------------- // Helpers to retrieve list of common Unicode ranges (2 value per range, values are inclusive, zero-terminated list) // NB: Make sure that your string are UTF-8 and NOT in your local code page. // Read https://github.com/ocornut/imgui/blob/master/docs/FONTS.md/#about-utf-8-encoding for details. // NB: Consider using ImFontGlyphRangesBuilder to build glyph ranges from textual data. IMGUI_API const ImWchar* GetGlyphRangesDefault(); // Basic Latin, Extended Latin IMGUI_API const ImWchar* GetGlyphRangesGreek(); // Default + Greek and Coptic IMGUI_API const ImWchar* GetGlyphRangesKorean(); // Default + Korean characters IMGUI_API const ImWchar* GetGlyphRangesJapanese(); // Default + Hiragana, Katakana, Half-Width, Selection of 2999 Ideographs IMGUI_API const ImWchar* GetGlyphRangesChineseFull(); // Default + Half-Width + Japanese Hiragana/Katakana + full set of about 21000 CJK Unified Ideographs IMGUI_API const ImWchar* GetGlyphRangesChineseSimplifiedCommon();// Default + Half-Width + Japanese Hiragana/Katakana + set of 2500 CJK Unified Ideographs for common simplified Chinese IMGUI_API const ImWchar* GetGlyphRangesCyrillic(); // Default + about 400 Cyrillic characters IMGUI_API const ImWchar* GetGlyphRangesThai(); // Default + Thai characters IMGUI_API const ImWchar* GetGlyphRangesVietnamese(); // Default + Vietnamese characters //------------------------------------------- // [ALPHA] Custom Rectangles/Glyphs API //------------------------------------------- // You can request arbitrary rectangles to be packed into the atlas, for your own purposes. // - After calling Build(), you can query the rectangle position and render your pixels. // - If you render colored output, set 'atlas->TexPixelsUseColors = true' as this may help some backends decide of preferred texture format. // - You can also request your rectangles to be mapped as font glyph (given a font + Unicode point), // so you can render e.g. custom colorful icons and use them as regular glyphs. // - Read docs/FONTS.md for more details about using colorful icons. // - Note: this API may be redesigned later in order to support multi-monitor varying DPI settings. IMGUI_API int AddCustomRectRegular(int width, int height); IMGUI_API int AddCustomRectFontGlyph(ImFont* font, ImWchar id, int width, int height, float advance_x, const ImVec2& offset = ImVec2(0, 0)); ImFontAtlasCustomRect* GetCustomRectByIndex(int index) { IM_ASSERT(index >= 0); return &CustomRects[index]; } // [Internal] IMGUI_API void CalcCustomRectUV(const ImFontAtlasCustomRect* rect, ImVec2* out_uv_min, ImVec2* out_uv_max) const; //------------------------------------------- // Members //------------------------------------------- // Input ImFontAtlasFlags Flags; // Build flags (see ImFontAtlasFlags_) ImTextureID TexID; // User data to refer to the texture once it has been uploaded to user's graphic systems. It is passed back to you during rendering via the ImDrawCmd structure. int TexDesiredWidth; // Texture width desired by user before Build(). Must be a power-of-two. If have many glyphs your graphics API have texture size restrictions you may want to increase texture width to decrease height. int TexGlyphPadding; // FIXME: Should be called "TexPackPadding". Padding between glyphs within texture in pixels. Defaults to 1. If your rendering method doesn't rely on bilinear filtering you may set this to 0 (will also need to set AntiAliasedLinesUseTex = false). void* UserData; // Store your own atlas related user-data (if e.g. you have multiple font atlas). // [Internal] // NB: Access texture data via GetTexData*() calls! Which will setup a default font for you. bool Locked; // Marked as Locked by ImGui::NewFrame() so attempt to modify the atlas will assert. bool TexReady; // Set when texture was built matching current font input bool TexPixelsUseColors; // Tell whether our texture data is known to use colors (rather than just alpha channel), in order to help backend select a format. unsigned char* TexPixelsAlpha8; // 1 component per pixel, each component is unsigned 8-bit. Total size = TexWidth * TexHeight unsigned int* TexPixelsRGBA32; // 4 component per pixel, each component is unsigned 8-bit. Total size = TexWidth * TexHeight * 4 int TexWidth; // Texture width calculated during Build(). int TexHeight; // Texture height calculated during Build(). ImVec2 TexUvScale; // = (1.0f/TexWidth, 1.0f/TexHeight) ImVec2 TexUvWhitePixel; // Texture coordinates to a white pixel ImVector Fonts; // Hold all the fonts returned by AddFont*. Fonts[0] is the default font upon calling ImGui::NewFrame(), use ImGui::PushFont()/PopFont() to change the current font. ImVector CustomRects; // Rectangles for packing custom texture data into the atlas. ImVector Sources; // Source/configuration data ImVec4 TexUvLines[IM_DRAWLIST_TEX_LINES_WIDTH_MAX + 1]; // UVs for baked anti-aliased lines // [Internal] Font builder const ImFontBuilderIO* FontBuilderIO; // Opaque interface to a font builder (default to stb_truetype, can be changed to use FreeType by defining IMGUI_ENABLE_FREETYPE). unsigned int FontBuilderFlags; // Shared flags (for all fonts) for custom font builder. THIS IS BUILD IMPLEMENTATION DEPENDENT. Per-font override is also available in ImFontConfig. // [Internal] Packing data int PackIdMouseCursors; // Custom texture rectangle ID for white pixel and mouse cursors int PackIdLines; // Custom texture rectangle ID for baked anti-aliased lines // [Obsolete] //typedef ImFontAtlasCustomRect CustomRect; // OBSOLETED in 1.72+ //typedef ImFontGlyphRangesBuilder GlyphRangesBuilder; // OBSOLETED in 1.67+ }; // Font runtime data and rendering // ImFontAtlas automatically loads a default embedded font for you when you call GetTexDataAsAlpha8() or GetTexDataAsRGBA32(). struct ImFont { // [Internal] Members: Hot ~20/24 bytes (for CalcTextSize) ImVector IndexAdvanceX; // 12-16 // out // Sparse. Glyphs->AdvanceX in a directly indexable way (cache-friendly for CalcTextSize functions which only this info, and are often bottleneck in large UI). float FallbackAdvanceX; // 4 // out // = FallbackGlyph->AdvanceX float FontSize; // 4 // in // Height of characters/line, set during loading (don't change after loading) // [Internal] Members: Hot ~28/40 bytes (for RenderText loop) ImVector IndexLookup; // 12-16 // out // Sparse. Index glyphs by Unicode code-point. ImVector Glyphs; // 12-16 // out // All glyphs. ImFontGlyph* FallbackGlyph; // 4-8 // out // = FindGlyph(FontFallbackChar) // [Internal] Members: Cold ~32/40 bytes // Conceptually Sources[] is the list of font sources merged to create this font. ImFontAtlas* ContainerAtlas; // 4-8 // out // What we has been loaded into ImFontConfig* Sources; // 4-8 // in // Pointer within ContainerAtlas->Sources[], to SourcesCount instances short SourcesCount; // 2 // in // Number of ImFontConfig involved in creating this font. Usually 1, or >1 when merging multiple font sources into one ImFont. short EllipsisCharCount; // 1 // out // 1 or 3 ImWchar EllipsisChar; // 2-4 // out // Character used for ellipsis rendering ('...'). ImWchar FallbackChar; // 2-4 // out // Character used if a glyph isn't found (U+FFFD, '?') float EllipsisWidth; // 4 // out // Total ellipsis Width float EllipsisCharStep; // 4 // out // Step between characters when EllipsisCount > 0 float Scale; // 4 // in // Base font scale (1.0f), multiplied by the per-window font scale which you can adjust with SetWindowFontScale() float Ascent, Descent; // 4+4 // out // Ascent: distance from top to bottom of e.g. 'A' [0..FontSize] (unscaled) int MetricsTotalSurface;// 4 // out // Total surface in pixels to get an idea of the font rasterization/texture cost (not exact, we approximate the cost of padding between glyphs) bool DirtyLookupTables; // 1 // out // ImU8 Used8kPagesMap[(IM_UNICODE_CODEPOINT_MAX+1)/8192/8]; // 1 bytes if ImWchar=ImWchar16, 16 bytes if ImWchar==ImWchar32. Store 1-bit for each block of 4K codepoints that has one active glyph. This is mainly used to facilitate iterations across all used codepoints. // Methods IMGUI_API ImFont(); IMGUI_API ~ImFont(); IMGUI_API ImFontGlyph* FindGlyph(ImWchar c); IMGUI_API ImFontGlyph* FindGlyphNoFallback(ImWchar c); float GetCharAdvance(ImWchar c) { return ((int)c < IndexAdvanceX.Size) ? IndexAdvanceX[(int)c] : FallbackAdvanceX; } bool IsLoaded() const { return ContainerAtlas != NULL; } const char* GetDebugName() const { return Sources ? Sources->Name : ""; } // [Internal] Don't use! // 'max_width' stops rendering after a certain width (could be turned into a 2d size). FLT_MAX to disable. // 'wrap_width' enable automatic word-wrapping across multiple lines to fit into given width. 0.0f to disable. IMGUI_API ImVec2 CalcTextSizeA(float size, float max_width, float wrap_width, const char* text_begin, const char* text_end = NULL, const char** remaining = NULL); // utf8 IMGUI_API const char* CalcWordWrapPositionA(float scale, const char* text, const char* text_end, float wrap_width); IMGUI_API void RenderChar(ImDrawList* draw_list, float size, const ImVec2& pos, ImU32 col, ImWchar c); IMGUI_API void RenderText(ImDrawList* draw_list, float size, const ImVec2& pos, ImU32 col, const ImVec4& clip_rect, const char* text_begin, const char* text_end, float wrap_width = 0.0f, bool cpu_fine_clip = false); // [Internal] Don't use! IMGUI_API void BuildLookupTable(); IMGUI_API void ClearOutputData(); IMGUI_API void GrowIndex(int new_size); IMGUI_API void AddGlyph(const ImFontConfig* src_cfg, ImWchar c, float x0, float y0, float x1, float y1, float u0, float v0, float u1, float v1, float advance_x); IMGUI_API void AddRemapChar(ImWchar dst, ImWchar src, bool overwrite_dst = true); // Makes 'dst' character/glyph points to 'src' character/glyph. Currently needs to be called AFTER fonts have been built. IMGUI_API bool IsGlyphRangeUnused(unsigned int c_begin, unsigned int c_last); }; //----------------------------------------------------------------------------- // [SECTION] Viewports //----------------------------------------------------------------------------- // Flags stored in ImGuiViewport::Flags, giving indications to the platform backends. enum ImGuiViewportFlags_ { ImGuiViewportFlags_None = 0, ImGuiViewportFlags_IsPlatformWindow = 1 << 0, // Represent a Platform Window ImGuiViewportFlags_IsPlatformMonitor = 1 << 1, // Represent a Platform Monitor (unused yet) ImGuiViewportFlags_OwnedByApp = 1 << 2, // Platform Window: Is created/managed by the application (rather than a dear imgui backend) }; // - Currently represents the Platform Window created by the application which is hosting our Dear ImGui windows. // - In 'docking' branch with multi-viewport enabled, we extend this concept to have multiple active viewports. // - In the future we will extend this concept further to also represent Platform Monitor and support a "no main platform window" operation mode. // - About Main Area vs Work Area: // - Main Area = entire viewport. // - Work Area = entire viewport minus sections used by main menu bars (for platform windows), or by task bar (for platform monitor). // - Windows are generally trying to stay within the Work Area of their host viewport. struct ImGuiViewport { ImGuiID ID; // Unique identifier for the viewport ImGuiViewportFlags Flags; // See ImGuiViewportFlags_ ImVec2 Pos; // Main Area: Position of the viewport (Dear ImGui coordinates are the same as OS desktop/native coordinates) ImVec2 Size; // Main Area: Size of the viewport. ImVec2 WorkPos; // Work Area: Position of the viewport minus task bars, menus bars, status bars (>= Pos) ImVec2 WorkSize; // Work Area: Size of the viewport minus task bars, menu bars, status bars (<= Size) // Platform/Backend Dependent Data void* PlatformHandle; // void* to hold higher-level, platform window handle (e.g. HWND, GLFWWindow*, SDL_Window*) void* PlatformHandleRaw; // void* to hold lower-level, platform-native window handle (under Win32 this is expected to be a HWND, unused for other platforms) ImGuiViewport() { memset(this, 0, sizeof(*this)); } // Helpers ImVec2 GetCenter() const { return ImVec2(Pos.x + Size.x * 0.5f, Pos.y + Size.y * 0.5f); } ImVec2 GetWorkCenter() const { return ImVec2(WorkPos.x + WorkSize.x * 0.5f, WorkPos.y + WorkSize.y * 0.5f); } }; //----------------------------------------------------------------------------- // [SECTION] Platform Dependent Interfaces //----------------------------------------------------------------------------- // Access via ImGui::GetPlatformIO() struct ImGuiPlatformIO { IMGUI_API ImGuiPlatformIO(); //------------------------------------------------------------------ // Input - Interface with OS and Platform backend (most common stuff) //------------------------------------------------------------------ // Optional: Access OS clipboard // (default to use native Win32 clipboard on Windows, otherwise uses a private clipboard. Override to access OS clipboard on other architectures) const char* (*Platform_GetClipboardTextFn)(ImGuiContext* ctx); void (*Platform_SetClipboardTextFn)(ImGuiContext* ctx, const char* text); void* Platform_ClipboardUserData; // Optional: Open link/folder/file in OS Shell // (default to use ShellExecuteW() on Windows, system() on Linux/Mac) bool (*Platform_OpenInShellFn)(ImGuiContext* ctx, const char* path); void* Platform_OpenInShellUserData; // Optional: Notify OS Input Method Editor of the screen position of your cursor for text input position (e.g. when using Japanese/Chinese IME on Windows) // (default to use native imm32 api on Windows) void (*Platform_SetImeDataFn)(ImGuiContext* ctx, ImGuiViewport* viewport, ImGuiPlatformImeData* data); void* Platform_ImeUserData; //void (*SetPlatformImeDataFn)(ImGuiViewport* viewport, ImGuiPlatformImeData* data); // [Renamed to platform_io.PlatformSetImeDataFn in 1.91.1] // Optional: Platform locale // [Experimental] Configure decimal point e.g. '.' or ',' useful for some languages (e.g. German), generally pulled from *localeconv()->decimal_point ImWchar Platform_LocaleDecimalPoint; // '.' //------------------------------------------------------------------ // Input - Interface with Renderer Backend //------------------------------------------------------------------ // Written by some backends during ImGui_ImplXXXX_RenderDrawData() call to point backend_specific ImGui_ImplXXXX_RenderState* structure. void* Renderer_RenderState; }; // (Optional) Support for IME (Input Method Editor) via the platform_io.Platform_SetImeDataFn() function. struct ImGuiPlatformImeData { bool WantVisible; // A widget wants the IME to be visible ImVec2 InputPos; // Position of the input cursor float InputLineHeight; // Line height ImGuiPlatformImeData() { memset(this, 0, sizeof(*this)); } }; //----------------------------------------------------------------------------- // [SECTION] Obsolete functions and types // (Will be removed! Read 'API BREAKING CHANGES' section in imgui.cpp for details) // Please keep your copy of dear imgui up to date! Occasionally set '#define IMGUI_DISABLE_OBSOLETE_FUNCTIONS' in imconfig.h to stay ahead. //----------------------------------------------------------------------------- #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS namespace ImGui { // OBSOLETED in 1.91.9 (from February 2025) IMGUI_API void Image(ImTextureID user_texture_id, const ImVec2& image_size, const ImVec2& uv0, const ImVec2& uv1, const ImVec4& tint_col, const ImVec4& border_col); // <-- border_col was removed in favor of ImGuiCol_ImageBorder. // OBSOLETED in 1.91.0 (from July 2024) static inline void PushButtonRepeat(bool repeat) { PushItemFlag(ImGuiItemFlags_ButtonRepeat, repeat); } static inline void PopButtonRepeat() { PopItemFlag(); } static inline void PushTabStop(bool tab_stop) { PushItemFlag(ImGuiItemFlags_NoTabStop, !tab_stop); } static inline void PopTabStop() { PopItemFlag(); } IMGUI_API ImVec2 GetContentRegionMax(); // Content boundaries max (e.g. window boundaries including scrolling, or current column boundaries). You should never need this. Always use GetCursorScreenPos() and GetContentRegionAvail()! IMGUI_API ImVec2 GetWindowContentRegionMin(); // Content boundaries min for the window (roughly (0,0)-Scroll), in window-local coordinates. You should never need this. Always use GetCursorScreenPos() and GetContentRegionAvail()! IMGUI_API ImVec2 GetWindowContentRegionMax(); // Content boundaries max for the window (roughly (0,0)+Size-Scroll), in window-local coordinates. You should never need this. Always use GetCursorScreenPos() and GetContentRegionAvail()! // OBSOLETED in 1.90.0 (from September 2023) static inline bool BeginChildFrame(ImGuiID id, const ImVec2& size, ImGuiWindowFlags window_flags = 0) { return BeginChild(id, size, ImGuiChildFlags_FrameStyle, window_flags); } static inline void EndChildFrame() { EndChild(); } //static inline bool BeginChild(const char* str_id, const ImVec2& size_arg, bool borders, ImGuiWindowFlags window_flags){ return BeginChild(str_id, size_arg, borders ? ImGuiChildFlags_Borders : ImGuiChildFlags_None, window_flags); } // Unnecessary as true == ImGuiChildFlags_Borders //static inline bool BeginChild(ImGuiID id, const ImVec2& size_arg, bool borders, ImGuiWindowFlags window_flags) { return BeginChild(id, size_arg, borders ? ImGuiChildFlags_Borders : ImGuiChildFlags_None, window_flags); } // Unnecessary as true == ImGuiChildFlags_Borders static inline void ShowStackToolWindow(bool* p_open = NULL) { ShowIDStackToolWindow(p_open); } IMGUI_API bool Combo(const char* label, int* current_item, bool (*old_callback)(void* user_data, int idx, const char** out_text), void* user_data, int items_count, int popup_max_height_in_items = -1); IMGUI_API bool ListBox(const char* label, int* current_item, bool (*old_callback)(void* user_data, int idx, const char** out_text), void* user_data, int items_count, int height_in_items = -1); // OBSOLETED in 1.89.7 (from June 2023) IMGUI_API void SetItemAllowOverlap(); // Use SetNextItemAllowOverlap() before item. // OBSOLETED in 1.89.4 (from March 2023) static inline void PushAllowKeyboardFocus(bool tab_stop) { PushItemFlag(ImGuiItemFlags_NoTabStop, !tab_stop); } static inline void PopAllowKeyboardFocus() { PopItemFlag(); } // Some of the older obsolete names along with their replacement (commented out so they are not reported in IDE) //-- OBSOLETED in 1.89 (from August 2022) //IMGUI_API bool ImageButton(ImTextureID user_texture_id, const ImVec2& size, const ImVec2& uv0 = ImVec2(0, 0), const ImVec2& uv1 = ImVec2(1, 1), int frame_padding = -1, const ImVec4& bg_col = ImVec4(0, 0, 0, 0), const ImVec4& tint_col = ImVec4(1, 1, 1, 1)); // --> Use new ImageButton() signature (explicit item id, regular FramePadding). Refer to code in 1.91 if you want to grab a copy of this version. //-- OBSOLETED in 1.88 (from May 2022) //static inline void CaptureKeyboardFromApp(bool want_capture_keyboard = true) { SetNextFrameWantCaptureKeyboard(want_capture_keyboard); } // Renamed as name was misleading + removed default value. //static inline void CaptureMouseFromApp(bool want_capture_mouse = true) { SetNextFrameWantCaptureMouse(want_capture_mouse); } // Renamed as name was misleading + removed default value. //-- OBSOLETED in 1.87 (from February 2022, more formally obsoleted April 2024) //IMGUI_API ImGuiKey GetKeyIndex(ImGuiKey key); { IM_ASSERT(key >= ImGuiKey_NamedKey_BEGIN && key < ImGuiKey_NamedKey_END); const ImGuiKeyData* key_data = GetKeyData(key); return (ImGuiKey)(key_data - g.IO.KeysData); } // Map ImGuiKey_* values into legacy native key index. == io.KeyMap[key]. When using a 1.87+ backend using io.AddKeyEvent(), calling GetKeyIndex() with ANY ImGuiKey_XXXX values will return the same value! //static inline ImGuiKey GetKeyIndex(ImGuiKey key) { IM_ASSERT(key >= ImGuiKey_NamedKey_BEGIN && key < ImGuiKey_NamedKey_END); return key; } //-- OBSOLETED in 1.86 (from November 2021) //IMGUI_API void CalcListClipping(int items_count, float items_height, int* out_items_display_start, int* out_items_display_end); // Code removed, see 1.90 for last version of the code. Calculate range of visible items for large list of evenly sized items. Prefer using ImGuiListClipper. //-- OBSOLETED in 1.85 (from August 2021) //static inline float GetWindowContentRegionWidth() { return GetWindowContentRegionMax().x - GetWindowContentRegionMin().x; } //-- OBSOLETED in 1.81 (from February 2021) //static inline bool ListBoxHeader(const char* label, const ImVec2& size = ImVec2(0, 0)) { return BeginListBox(label, size); } //static inline bool ListBoxHeader(const char* label, int items_count, int height_in_items = -1) { float height = GetTextLineHeightWithSpacing() * ((height_in_items < 0 ? ImMin(items_count, 7) : height_in_items) + 0.25f) + GetStyle().FramePadding.y * 2.0f; return BeginListBox(label, ImVec2(0.0f, height)); } // Helper to calculate size from items_count and height_in_items //static inline void ListBoxFooter() { EndListBox(); } //-- OBSOLETED in 1.79 (from August 2020) //static inline void OpenPopupContextItem(const char* str_id = NULL, ImGuiMouseButton mb = 1) { OpenPopupOnItemClick(str_id, mb); } // Bool return value removed. Use IsWindowAppearing() in BeginPopup() instead. Renamed in 1.77, renamed back in 1.79. Sorry! //-- OBSOLETED in 1.78 (from June 2020): Old drag/sliders functions that took a 'float power > 1.0f' argument instead of ImGuiSliderFlags_Logarithmic. See github.com/ocornut/imgui/issues/3361 for details. //IMGUI_API bool DragScalar(const char* label, ImGuiDataType data_type, void* p_data, float v_speed, const void* p_min, const void* p_max, const char* format, float power = 1.0f) // OBSOLETED in 1.78 (from June 2020) //IMGUI_API bool DragScalarN(const char* label, ImGuiDataType data_type, void* p_data, int components, float v_speed, const void* p_min, const void* p_max, const char* format, float power = 1.0f); // OBSOLETED in 1.78 (from June 2020) //IMGUI_API bool SliderScalar(const char* label, ImGuiDataType data_type, void* p_data, const void* p_min, const void* p_max, const char* format, float power = 1.0f); // OBSOLETED in 1.78 (from June 2020) //IMGUI_API bool SliderScalarN(const char* label, ImGuiDataType data_type, void* p_data, int components, const void* p_min, const void* p_max, const char* format, float power = 1.0f); // OBSOLETED in 1.78 (from June 2020) //static inline bool DragFloat(const char* label, float* v, float v_speed, float v_min, float v_max, const char* format, float power = 1.0f) { return DragScalar(label, ImGuiDataType_Float, v, v_speed, &v_min, &v_max, format, power); } // OBSOLETED in 1.78 (from June 2020) //static inline bool DragFloat2(const char* label, float v[2], float v_speed, float v_min, float v_max, const char* format, float power = 1.0f) { return DragScalarN(label, ImGuiDataType_Float, v, 2, v_speed, &v_min, &v_max, format, power); } // OBSOLETED in 1.78 (from June 2020) //static inline bool DragFloat3(const char* label, float v[3], float v_speed, float v_min, float v_max, const char* format, float power = 1.0f) { return DragScalarN(label, ImGuiDataType_Float, v, 3, v_speed, &v_min, &v_max, format, power); } // OBSOLETED in 1.78 (from June 2020) //static inline bool DragFloat4(const char* label, float v[4], float v_speed, float v_min, float v_max, const char* format, float power = 1.0f) { return DragScalarN(label, ImGuiDataType_Float, v, 4, v_speed, &v_min, &v_max, format, power); } // OBSOLETED in 1.78 (from June 2020) //static inline bool SliderFloat(const char* label, float* v, float v_min, float v_max, const char* format, float power = 1.0f) { return SliderScalar(label, ImGuiDataType_Float, v, &v_min, &v_max, format, power); } // OBSOLETED in 1.78 (from June 2020) //static inline bool SliderFloat2(const char* label, float v[2], float v_min, float v_max, const char* format, float power = 1.0f) { return SliderScalarN(label, ImGuiDataType_Float, v, 2, &v_min, &v_max, format, power); } // OBSOLETED in 1.78 (from June 2020) //static inline bool SliderFloat3(const char* label, float v[3], float v_min, float v_max, const char* format, float power = 1.0f) { return SliderScalarN(label, ImGuiDataType_Float, v, 3, &v_min, &v_max, format, power); } // OBSOLETED in 1.78 (from June 2020) //static inline bool SliderFloat4(const char* label, float v[4], float v_min, float v_max, const char* format, float power = 1.0f) { return SliderScalarN(label, ImGuiDataType_Float, v, 4, &v_min, &v_max, format, power); } // OBSOLETED in 1.78 (from June 2020) //-- OBSOLETED in 1.77 and before //static inline bool BeginPopupContextWindow(const char* str_id, ImGuiMouseButton mb, bool over_items) { return BeginPopupContextWindow(str_id, mb | (over_items ? 0 : ImGuiPopupFlags_NoOpenOverItems)); } // OBSOLETED in 1.77 (from June 2020) //static inline void TreeAdvanceToLabelPos() { SetCursorPosX(GetCursorPosX() + GetTreeNodeToLabelSpacing()); } // OBSOLETED in 1.72 (from July 2019) //static inline void SetNextTreeNodeOpen(bool open, ImGuiCond cond = 0) { SetNextItemOpen(open, cond); } // OBSOLETED in 1.71 (from June 2019) //static inline float GetContentRegionAvailWidth() { return GetContentRegionAvail().x; } // OBSOLETED in 1.70 (from May 2019) //static inline ImDrawList* GetOverlayDrawList() { return GetForegroundDrawList(); } // OBSOLETED in 1.69 (from Mar 2019) //static inline void SetScrollHere(float ratio = 0.5f) { SetScrollHereY(ratio); } // OBSOLETED in 1.66 (from Nov 2018) //static inline bool IsItemDeactivatedAfterChange() { return IsItemDeactivatedAfterEdit(); } // OBSOLETED in 1.63 (from Aug 2018) //-- OBSOLETED in 1.60 and before //static inline bool IsAnyWindowFocused() { return IsWindowFocused(ImGuiFocusedFlags_AnyWindow); } // OBSOLETED in 1.60 (from Apr 2018) //static inline bool IsAnyWindowHovered() { return IsWindowHovered(ImGuiHoveredFlags_AnyWindow); } // OBSOLETED in 1.60 (between Dec 2017 and Apr 2018) //static inline void ShowTestWindow() { return ShowDemoWindow(); } // OBSOLETED in 1.53 (between Oct 2017 and Dec 2017) //static inline bool IsRootWindowFocused() { return IsWindowFocused(ImGuiFocusedFlags_RootWindow); } // OBSOLETED in 1.53 (between Oct 2017 and Dec 2017) //static inline bool IsRootWindowOrAnyChildFocused() { return IsWindowFocused(ImGuiFocusedFlags_RootAndChildWindows); } // OBSOLETED in 1.53 (between Oct 2017 and Dec 2017) //static inline void SetNextWindowContentWidth(float w) { SetNextWindowContentSize(ImVec2(w, 0.0f)); } // OBSOLETED in 1.53 (between Oct 2017 and Dec 2017) //static inline float GetItemsLineHeightWithSpacing() { return GetFrameHeightWithSpacing(); } // OBSOLETED in 1.53 (between Oct 2017 and Dec 2017) //IMGUI_API bool Begin(char* name, bool* p_open, ImVec2 size_first_use, float bg_alpha = -1.0f, ImGuiWindowFlags flags=0); // OBSOLETED in 1.52 (between Aug 2017 and Oct 2017): Equivalent of using SetNextWindowSize(size, ImGuiCond_FirstUseEver) and SetNextWindowBgAlpha(). //static inline bool IsRootWindowOrAnyChildHovered() { return IsWindowHovered(ImGuiHoveredFlags_RootAndChildWindows); } // OBSOLETED in 1.52 (between Aug 2017 and Oct 2017) //static inline void AlignFirstTextHeightToWidgets() { AlignTextToFramePadding(); } // OBSOLETED in 1.52 (between Aug 2017 and Oct 2017) //static inline void SetNextWindowPosCenter(ImGuiCond c=0) { SetNextWindowPos(GetMainViewport()->GetCenter(), c, ImVec2(0.5f,0.5f)); } // OBSOLETED in 1.52 (between Aug 2017 and Oct 2017) //static inline bool IsItemHoveredRect() { return IsItemHovered(ImGuiHoveredFlags_RectOnly); } // OBSOLETED in 1.51 (between Jun 2017 and Aug 2017) //static inline bool IsPosHoveringAnyWindow(const ImVec2&) { IM_ASSERT(0); return false; } // OBSOLETED in 1.51 (between Jun 2017 and Aug 2017): This was misleading and partly broken. You probably want to use the io.WantCaptureMouse flag instead. //static inline bool IsMouseHoveringAnyWindow() { return IsWindowHovered(ImGuiHoveredFlags_AnyWindow); } // OBSOLETED in 1.51 (between Jun 2017 and Aug 2017) //static inline bool IsMouseHoveringWindow() { return IsWindowHovered(ImGuiHoveredFlags_AllowWhenBlockedByPopup | ImGuiHoveredFlags_AllowWhenBlockedByActiveItem); } // OBSOLETED in 1.51 (between Jun 2017 and Aug 2017) //-- OBSOLETED in 1.50 and before //static inline bool CollapsingHeader(char* label, const char* str_id, bool framed = true, bool default_open = false) { return CollapsingHeader(label, (default_open ? (1 << 5) : 0)); } // OBSOLETED in 1.49 //static inline ImFont*GetWindowFont() { return GetFont(); } // OBSOLETED in 1.48 //static inline float GetWindowFontSize() { return GetFontSize(); } // OBSOLETED in 1.48 //static inline void SetScrollPosHere() { SetScrollHere(); } // OBSOLETED in 1.42 } //-- OBSOLETED in 1.82 (from Mars 2021): flags for AddRect(), AddRectFilled(), AddImageRounded(), PathRect() //typedef ImDrawFlags ImDrawCornerFlags; //enum ImDrawCornerFlags_ //{ // ImDrawCornerFlags_None = ImDrawFlags_RoundCornersNone, // Was == 0 prior to 1.82, this is now == ImDrawFlags_RoundCornersNone which is != 0 and not implicit // ImDrawCornerFlags_TopLeft = ImDrawFlags_RoundCornersTopLeft, // Was == 0x01 (1 << 0) prior to 1.82. Order matches ImDrawFlags_NoRoundCorner* flag (we exploit this internally). // ImDrawCornerFlags_TopRight = ImDrawFlags_RoundCornersTopRight, // Was == 0x02 (1 << 1) prior to 1.82. // ImDrawCornerFlags_BotLeft = ImDrawFlags_RoundCornersBottomLeft, // Was == 0x04 (1 << 2) prior to 1.82. // ImDrawCornerFlags_BotRight = ImDrawFlags_RoundCornersBottomRight, // Was == 0x08 (1 << 3) prior to 1.82. // ImDrawCornerFlags_All = ImDrawFlags_RoundCornersAll, // Was == 0x0F prior to 1.82 // ImDrawCornerFlags_Top = ImDrawCornerFlags_TopLeft | ImDrawCornerFlags_TopRight, // ImDrawCornerFlags_Bot = ImDrawCornerFlags_BotLeft | ImDrawCornerFlags_BotRight, // ImDrawCornerFlags_Left = ImDrawCornerFlags_TopLeft | ImDrawCornerFlags_BotLeft, // ImDrawCornerFlags_Right = ImDrawCornerFlags_TopRight | ImDrawCornerFlags_BotRight, //}; // RENAMED and MERGED both ImGuiKey_ModXXX and ImGuiModFlags_XXX into ImGuiMod_XXX (from September 2022) // RENAMED ImGuiKeyModFlags -> ImGuiModFlags in 1.88 (from April 2022). Exceptionally commented out ahead of obscolescence schedule to reduce confusion and because they were not meant to be used in the first place. //typedef ImGuiKeyChord ImGuiModFlags; // == int. We generally use ImGuiKeyChord to mean "a ImGuiKey or-ed with any number of ImGuiMod_XXX value", so you may store mods in there. //enum ImGuiModFlags_ { ImGuiModFlags_None = 0, ImGuiModFlags_Ctrl = ImGuiMod_Ctrl, ImGuiModFlags_Shift = ImGuiMod_Shift, ImGuiModFlags_Alt = ImGuiMod_Alt, ImGuiModFlags_Super = ImGuiMod_Super }; //typedef ImGuiKeyChord ImGuiKeyModFlags; // == int //enum ImGuiKeyModFlags_ { ImGuiKeyModFlags_None = 0, ImGuiKeyModFlags_Ctrl = ImGuiMod_Ctrl, ImGuiKeyModFlags_Shift = ImGuiMod_Shift, ImGuiKeyModFlags_Alt = ImGuiMod_Alt, ImGuiKeyModFlags_Super = ImGuiMod_Super }; #define IM_OFFSETOF(_TYPE,_MEMBER) offsetof(_TYPE, _MEMBER) // OBSOLETED IN 1.90 (now using C++11 standard version) #endif // #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS // RENAMED IMGUI_DISABLE_METRICS_WINDOW > IMGUI_DISABLE_DEBUG_TOOLS in 1.88 (from June 2022) #ifdef IMGUI_DISABLE_METRICS_WINDOW #error IMGUI_DISABLE_METRICS_WINDOW was renamed to IMGUI_DISABLE_DEBUG_TOOLS, please use new name. #endif //----------------------------------------------------------------------------- #if defined(__clang__) #pragma clang diagnostic pop #elif defined(__GNUC__) #pragma GCC diagnostic pop #endif #ifdef _MSC_VER #pragma warning (pop) #endif // Include imgui_user.h at the end of imgui.h // May be convenient for some users to only explicitly include vanilla imgui.h and have extra stuff included. #ifdef IMGUI_INCLUDE_IMGUI_USER_H #ifdef IMGUI_USER_H_FILENAME #include IMGUI_USER_H_FILENAME #else #include "imgui_user.h" #endif #endif #endif // #ifndef IMGUI_DISABLE ================================================ FILE: src/DesktopPlusUI/imgui/imgui_demo.cpp ================================================ // dear imgui, v1.91.9b // (demo code) // Help: // - Read FAQ at http://dearimgui.com/faq // - Call and read ImGui::ShowDemoWindow() in imgui_demo.cpp. All applications in examples/ are doing that. // - Need help integrating Dear ImGui in your codebase? // - Read Getting Started https://github.com/ocornut/imgui/wiki/Getting-Started // - Read 'Programmer guide' in imgui.cpp for notes on how to setup Dear ImGui in your codebase. // Read top of imgui.cpp and imgui.h for many details, documentation, comments, links. // Get the latest version at https://github.com/ocornut/imgui // How to easily locate code? // - Use Tools->Item Picker to debug break in code by clicking any widgets: https://github.com/ocornut/imgui/wiki/Debug-Tools // - Browse an online version the demo with code linked to hovered widgets: https://pthom.github.io/imgui_manual_online/manual/imgui_manual.html // - Find a visible string and search for it in the code! //--------------------------------------------------- // PLEASE DO NOT REMOVE THIS FILE FROM YOUR PROJECT! //--------------------------------------------------- // Message to the person tempted to delete this file when integrating Dear ImGui into their codebase: // Think again! It is the most useful reference code that you and other coders will want to refer to and call. // Have the ImGui::ShowDemoWindow() function wired in an always-available debug menu of your game/app! // Also include Metrics! ItemPicker! DebugLog! and other debug features. // Removing this file from your project is hindering access to documentation for everyone in your team, // likely leading you to poorer usage of the library. // Everything in this file will be stripped out by the linker if you don't call ImGui::ShowDemoWindow(). // If you want to link core Dear ImGui in your shipped builds but want a thorough guarantee that the demo will not be // linked, you can setup your imconfig.h with #define IMGUI_DISABLE_DEMO_WINDOWS and those functions will be empty. // In another situation, whenever you have Dear ImGui available you probably want this to be available for reference. // Thank you, // -Your beloved friend, imgui_demo.cpp (which you won't delete) //-------------------------------------------- // ABOUT THE MEANING OF THE 'static' KEYWORD: //-------------------------------------------- // In this demo code, we frequently use 'static' variables inside functions. // A static variable persists across calls. It is essentially a global variable but declared inside the scope of the function. // Think of "static int n = 0;" as "global int n = 0;" ! // We do this IN THE DEMO because we want: // - to gather code and data in the same place. // - to make the demo source code faster to read, faster to change, smaller in size. // - it is also a convenient way of storing simple UI related information as long as your function // doesn't need to be reentrant or used in multiple threads. // This might be a pattern you will want to use in your code, but most of the data you would be working // with in a complex codebase is likely going to be stored outside your functions. //----------------------------------------- // ABOUT THE CODING STYLE OF OUR DEMO CODE //----------------------------------------- // The Demo code in this file is designed to be easy to copy-and-paste into your application! // Because of this: // - We never omit the ImGui:: prefix when calling functions, even though most code here is in the same namespace. // - We try to declare static variables in the local scope, as close as possible to the code using them. // - We never use any of the helpers/facilities used internally by Dear ImGui, unless available in the public API. // - We never use maths operators on ImVec2/ImVec4. For our other sources files we use them, and they are provided // by imgui.h using the IMGUI_DEFINE_MATH_OPERATORS define. For your own sources file they are optional // and require you either enable those, either provide your own via IM_VEC2_CLASS_EXTRA in imconfig.h. // Because we can't assume anything about your support of maths operators, we cannot use them in imgui_demo.cpp. // Navigating this file: // - In Visual Studio: CTRL+comma ("Edit.GoToAll") can follow symbols inside comments, whereas CTRL+F12 ("Edit.GoToImplementation") cannot. // - In Visual Studio w/ Visual Assist installed: ALT+G ("VAssistX.GoToImplementation") can also follow symbols inside comments. // - In VS Code, CLion, etc.: CTRL+click can follow symbols inside comments. // - You can search/grep for all sections listed in the index to find the section. /* Index of this file: // [SECTION] Forward Declarations // [SECTION] Helpers // [SECTION] Demo Window / ShowDemoWindow() // [SECTION] DemoWindowMenuBar() // [SECTION] Helpers: ExampleTreeNode, ExampleMemberInfo (for use by Property Editor & Multi-Select demos) // [SECTION] DemoWindowWidgetsBasic() // [SECTION] DemoWindowWidgetsBullets() // [SECTION] DemoWindowWidgetsCollapsingHeaders() // [SECTION] DemoWindowWidgetsComboBoxes() // [SECTION] DemoWindowWidgetsColorAndPickers() // [SECTION] DemoWindowWidgetsDataTypes() // [SECTION] DemoWindowWidgetsDisableBlocks() // [SECTION] DemoWindowWidgetsDragAndDrop() // [SECTION] DemoWindowWidgetsDragsAndSliders() // [SECTION] DemoWindowWidgetsImages() // [SECTION] DemoWindowWidgetsListBoxes() // [SECTION] DemoWindowWidgetsMultiComponents() // [SECTION] DemoWindowWidgetsPlotting() // [SECTION] DemoWindowWidgetsProgressBars() // [SECTION] DemoWindowWidgetsQueryingStatuses() // [SECTION] DemoWindowWidgetsSelectables() // [SECTION] DemoWindowWidgetsSelectionAndMultiSelect() // [SECTION] DemoWindowWidgetsTabs() // [SECTION] DemoWindowWidgetsText() // [SECTION] DemoWindowWidgetsTextFilter() // [SECTION] DemoWindowWidgetsTextInput() // [SECTION] DemoWindowWidgetsTooltips() // [SECTION] DemoWindowWidgetsTreeNodes() // [SECTION] DemoWindowWidgetsVerticalSliders() // [SECTION] DemoWindowWidgets() // [SECTION] DemoWindowLayout() // [SECTION] DemoWindowPopups() // [SECTION] DemoWindowTables() // [SECTION] DemoWindowInputs() // [SECTION] About Window / ShowAboutWindow() // [SECTION] Style Editor / ShowStyleEditor() // [SECTION] User Guide / ShowUserGuide() // [SECTION] Example App: Main Menu Bar / ShowExampleAppMainMenuBar() // [SECTION] Example App: Debug Console / ShowExampleAppConsole() // [SECTION] Example App: Debug Log / ShowExampleAppLog() // [SECTION] Example App: Simple Layout / ShowExampleAppLayout() // [SECTION] Example App: Property Editor / ShowExampleAppPropertyEditor() // [SECTION] Example App: Long Text / ShowExampleAppLongText() // [SECTION] Example App: Auto Resize / ShowExampleAppAutoResize() // [SECTION] Example App: Constrained Resize / ShowExampleAppConstrainedResize() // [SECTION] Example App: Simple overlay / ShowExampleAppSimpleOverlay() // [SECTION] Example App: Fullscreen window / ShowExampleAppFullscreen() // [SECTION] Example App: Manipulating window titles / ShowExampleAppWindowTitles() // [SECTION] Example App: Custom Rendering using ImDrawList API / ShowExampleAppCustomRendering() // [SECTION] Example App: Documents Handling / ShowExampleAppDocuments() // [SECTION] Example App: Assets Browser / ShowExampleAppAssetsBrowser() */ #if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_WARNINGS) #define _CRT_SECURE_NO_WARNINGS #endif #include "imgui.h" #ifndef IMGUI_DISABLE // System includes #include // toupper #include // INT_MIN, INT_MAX #include // sqrtf, powf, cosf, sinf, floorf, ceilf #include // vsnprintf, sscanf, printf #include // NULL, malloc, free, atoi #include // intptr_t #if !defined(_MSC_VER) || _MSC_VER >= 1800 #include // PRId64/PRIu64, not avail in some MinGW headers. #endif #ifdef __EMSCRIPTEN__ #include // __EMSCRIPTEN_major__ etc. #endif // Visual Studio warnings #ifdef _MSC_VER #pragma warning (disable: 4127) // condition expression is constant #pragma warning (disable: 4996) // 'This function or variable may be unsafe': strcpy, strdup, sprintf, vsnprintf, sscanf, fopen #pragma warning (disable: 26451) // [Static Analyzer] Arithmetic overflow : Using operator 'xxx' on a 4 byte value and then casting the result to an 8 byte value. Cast the value to the wider type before calling operator 'xxx' to avoid overflow(io.2). #endif // Clang/GCC warnings with -Weverything #if defined(__clang__) #if __has_warning("-Wunknown-warning-option") #pragma clang diagnostic ignored "-Wunknown-warning-option" // warning: unknown warning group 'xxx' // not all warnings are known by all Clang versions and they tend to be rename-happy.. so ignoring warnings triggers new warnings on some configuration. Great! #endif #pragma clang diagnostic ignored "-Wunknown-pragmas" // warning: unknown warning group 'xxx' #pragma clang diagnostic ignored "-Wold-style-cast" // warning: use of old-style cast // yes, they are more terse. #pragma clang diagnostic ignored "-Wdeprecated-declarations" // warning: 'xx' is deprecated: The POSIX name for this.. // for strdup used in demo code (so user can copy & paste the code) #pragma clang diagnostic ignored "-Wint-to-void-pointer-cast" // warning: cast to 'void *' from smaller integer type #pragma clang diagnostic ignored "-Wformat" // warning: format specifies type 'int' but the argument has type 'unsigned int' #pragma clang diagnostic ignored "-Wformat-security" // warning: format string is not a string literal #pragma clang diagnostic ignored "-Wexit-time-destructors" // warning: declaration requires an exit-time destructor // exit-time destruction order is undefined. if MemFree() leads to users code that has been disabled before exit it might cause problems. ImGui coding style welcomes static/globals. #pragma clang diagnostic ignored "-Wunused-macros" // warning: macro is not used // we define snprintf/vsnprintf on Windows so they are available, but not always used. #pragma clang diagnostic ignored "-Wzero-as-null-pointer-constant" // warning: zero as null pointer constant // some standard header variations use #define NULL 0 #pragma clang diagnostic ignored "-Wdouble-promotion" // warning: implicit conversion from 'float' to 'double' when passing argument to function // using printf() is a misery with this as C++ va_arg ellipsis changes float to double. #pragma clang diagnostic ignored "-Wreserved-id-macro" // warning: macro name is a reserved identifier #pragma clang diagnostic ignored "-Wimplicit-int-float-conversion" // warning: implicit conversion from 'xxx' to 'float' may lose precision #pragma clang diagnostic ignored "-Wunsafe-buffer-usage" // warning: 'xxx' is an unsafe pointer used for buffer access #pragma clang diagnostic ignored "-Wswitch-default" // warning: 'switch' missing 'default' label #elif defined(__GNUC__) #pragma GCC diagnostic ignored "-Wpragmas" // warning: unknown option after '#pragma GCC diagnostic' kind #pragma GCC diagnostic ignored "-Wfloat-equal" // warning: comparing floating-point with '==' or '!=' is unsafe #pragma GCC diagnostic ignored "-Wint-to-pointer-cast" // warning: cast to pointer from integer of different size #pragma GCC diagnostic ignored "-Wformat" // warning: format '%p' expects argument of type 'int'/'void*', but argument X has type 'unsigned int'/'ImGuiWindow*' #pragma GCC diagnostic ignored "-Wformat-security" // warning: format string is not a string literal (potentially insecure) #pragma GCC diagnostic ignored "-Wdouble-promotion" // warning: implicit conversion from 'float' to 'double' when passing argument to function #pragma GCC diagnostic ignored "-Wconversion" // warning: conversion to 'xxxx' from 'xxxx' may alter its value #pragma GCC diagnostic ignored "-Wmisleading-indentation" // [__GNUC__ >= 6] warning: this 'if' clause does not guard this statement // GCC 6.0+ only. See #883 on GitHub. #pragma GCC diagnostic ignored "-Wstrict-overflow" // warning: assuming signed overflow does not occur when simplifying division / ..when changing X +- C1 cmp C2 to X cmp C2 -+ C1 #pragma GCC diagnostic ignored "-Wcast-qual" // warning: cast from type 'const xxxx *' to type 'xxxx *' casts away qualifiers #endif // Play it nice with Windows users (Update: May 2018, Notepad now supports Unix-style carriage returns!) #ifdef _WIN32 #define IM_NEWLINE "\r\n" #else #define IM_NEWLINE "\n" #endif // Helpers #if defined(_MSC_VER) && !defined(snprintf) #define snprintf _snprintf #endif #if defined(_MSC_VER) && !defined(vsnprintf) #define vsnprintf _vsnprintf #endif // Format specifiers for 64-bit values (hasn't been decently standardized before VS2013) #if !defined(PRId64) && defined(_MSC_VER) #define PRId64 "I64d" #define PRIu64 "I64u" #elif !defined(PRId64) #define PRId64 "lld" #define PRIu64 "llu" #endif // Helpers macros // We normally try to not use many helpers in imgui_demo.cpp in order to make code easier to copy and paste, // but making an exception here as those are largely simplifying code... // In other imgui sources we can use nicer internal functions from imgui_internal.h (ImMin/ImMax) but not in the demo. #define IM_MIN(A, B) (((A) < (B)) ? (A) : (B)) #define IM_MAX(A, B) (((A) >= (B)) ? (A) : (B)) #define IM_CLAMP(V, MN, MX) ((V) < (MN) ? (MN) : (V) > (MX) ? (MX) : (V)) // Enforce cdecl calling convention for functions called by the standard library, // in case compilation settings changed the default to e.g. __vectorcall #ifndef IMGUI_CDECL #ifdef _MSC_VER #define IMGUI_CDECL __cdecl #else #define IMGUI_CDECL #endif #endif //----------------------------------------------------------------------------- // [SECTION] Forward Declarations //----------------------------------------------------------------------------- #if !defined(IMGUI_DISABLE_DEMO_WINDOWS) // Forward Declarations struct ImGuiDemoWindowData; static void ShowExampleAppMainMenuBar(); static void ShowExampleAppAssetsBrowser(bool* p_open); static void ShowExampleAppConsole(bool* p_open); static void ShowExampleAppCustomRendering(bool* p_open); static void ShowExampleAppDocuments(bool* p_open); static void ShowExampleAppLog(bool* p_open); static void ShowExampleAppLayout(bool* p_open); static void ShowExampleAppPropertyEditor(bool* p_open, ImGuiDemoWindowData* demo_data); static void ShowExampleAppSimpleOverlay(bool* p_open); static void ShowExampleAppAutoResize(bool* p_open); static void ShowExampleAppConstrainedResize(bool* p_open); static void ShowExampleAppFullscreen(bool* p_open); static void ShowExampleAppLongText(bool* p_open); static void ShowExampleAppWindowTitles(bool* p_open); static void ShowExampleMenuFile(); // We split the contents of the big ShowDemoWindow() function into smaller functions // (because the link time of very large functions tends to grow non-linearly) static void DemoWindowMenuBar(ImGuiDemoWindowData* demo_data); static void DemoWindowWidgets(ImGuiDemoWindowData* demo_data); static void DemoWindowLayout(); static void DemoWindowPopups(); static void DemoWindowTables(); static void DemoWindowColumns(); static void DemoWindowInputs(); // Helper tree functions used by Property Editor & Multi-Select demos struct ExampleTreeNode; static ExampleTreeNode* ExampleTree_CreateNode(const char* name, int uid, ExampleTreeNode* parent); static void ExampleTree_DestroyNode(ExampleTreeNode* node); //----------------------------------------------------------------------------- // [SECTION] Helpers //----------------------------------------------------------------------------- // Helper to display a little (?) mark which shows a tooltip when hovered. // In your own code you may want to display an actual icon if you are using a merged icon fonts (see docs/FONTS.md) static void HelpMarker(const char* desc) { ImGui::TextDisabled("(?)"); if (ImGui::BeginItemTooltip()) { ImGui::PushTextWrapPos(ImGui::GetFontSize() * 35.0f); ImGui::TextUnformatted(desc); ImGui::PopTextWrapPos(); ImGui::EndTooltip(); } } // Helper to wire demo markers located in code to an interactive browser typedef void (*ImGuiDemoMarkerCallback)(const char* file, int line, const char* section, void* user_data); extern ImGuiDemoMarkerCallback GImGuiDemoMarkerCallback; extern void* GImGuiDemoMarkerCallbackUserData; ImGuiDemoMarkerCallback GImGuiDemoMarkerCallback = NULL; void* GImGuiDemoMarkerCallbackUserData = NULL; #define IMGUI_DEMO_MARKER(section) do { if (GImGuiDemoMarkerCallback != NULL) GImGuiDemoMarkerCallback(__FILE__, __LINE__, section, GImGuiDemoMarkerCallbackUserData); } while (0) //----------------------------------------------------------------------------- // [SECTION] Demo Window / ShowDemoWindow() //----------------------------------------------------------------------------- // Data to be shared across different functions of the demo. struct ImGuiDemoWindowData { // Examples Apps (accessible from the "Examples" menu) bool ShowMainMenuBar = false; bool ShowAppAssetsBrowser = false; bool ShowAppConsole = false; bool ShowAppCustomRendering = false; bool ShowAppDocuments = false; bool ShowAppLog = false; bool ShowAppLayout = false; bool ShowAppPropertyEditor = false; bool ShowAppSimpleOverlay = false; bool ShowAppAutoResize = false; bool ShowAppConstrainedResize = false; bool ShowAppFullscreen = false; bool ShowAppLongText = false; bool ShowAppWindowTitles = false; // Dear ImGui Tools (accessible from the "Tools" menu) bool ShowMetrics = false; bool ShowDebugLog = false; bool ShowIDStackTool = false; bool ShowStyleEditor = false; bool ShowAbout = false; // Other data bool DisableSections = false; ExampleTreeNode* DemoTree = NULL; ~ImGuiDemoWindowData() { if (DemoTree) ExampleTree_DestroyNode(DemoTree); } }; // Demonstrate most Dear ImGui features (this is big function!) // You may execute this function to experiment with the UI and understand what it does. // You may then search for keywords in the code when you are interested by a specific feature. void ImGui::ShowDemoWindow(bool* p_open) { // Exceptionally add an extra assert here for people confused about initial Dear ImGui setup // Most functions would normally just assert/crash if the context is missing. IM_ASSERT(ImGui::GetCurrentContext() != NULL && "Missing Dear ImGui context. Refer to examples app!"); // Verify ABI compatibility between caller code and compiled version of Dear ImGui. This helps detects some build issues. IMGUI_CHECKVERSION(); // Stored data static ImGuiDemoWindowData demo_data; // Examples Apps (accessible from the "Examples" menu) if (demo_data.ShowMainMenuBar) { ShowExampleAppMainMenuBar(); } if (demo_data.ShowAppDocuments) { ShowExampleAppDocuments(&demo_data.ShowAppDocuments); } if (demo_data.ShowAppAssetsBrowser) { ShowExampleAppAssetsBrowser(&demo_data.ShowAppAssetsBrowser); } if (demo_data.ShowAppConsole) { ShowExampleAppConsole(&demo_data.ShowAppConsole); } if (demo_data.ShowAppCustomRendering) { ShowExampleAppCustomRendering(&demo_data.ShowAppCustomRendering); } if (demo_data.ShowAppLog) { ShowExampleAppLog(&demo_data.ShowAppLog); } if (demo_data.ShowAppLayout) { ShowExampleAppLayout(&demo_data.ShowAppLayout); } if (demo_data.ShowAppPropertyEditor) { ShowExampleAppPropertyEditor(&demo_data.ShowAppPropertyEditor, &demo_data); } if (demo_data.ShowAppSimpleOverlay) { ShowExampleAppSimpleOverlay(&demo_data.ShowAppSimpleOverlay); } if (demo_data.ShowAppAutoResize) { ShowExampleAppAutoResize(&demo_data.ShowAppAutoResize); } if (demo_data.ShowAppConstrainedResize) { ShowExampleAppConstrainedResize(&demo_data.ShowAppConstrainedResize); } if (demo_data.ShowAppFullscreen) { ShowExampleAppFullscreen(&demo_data.ShowAppFullscreen); } if (demo_data.ShowAppLongText) { ShowExampleAppLongText(&demo_data.ShowAppLongText); } if (demo_data.ShowAppWindowTitles) { ShowExampleAppWindowTitles(&demo_data.ShowAppWindowTitles); } // Dear ImGui Tools (accessible from the "Tools" menu) if (demo_data.ShowMetrics) { ImGui::ShowMetricsWindow(&demo_data.ShowMetrics); } if (demo_data.ShowDebugLog) { ImGui::ShowDebugLogWindow(&demo_data.ShowDebugLog); } if (demo_data.ShowIDStackTool) { ImGui::ShowIDStackToolWindow(&demo_data.ShowIDStackTool); } if (demo_data.ShowAbout) { ImGui::ShowAboutWindow(&demo_data.ShowAbout); } if (demo_data.ShowStyleEditor) { ImGui::Begin("Dear ImGui Style Editor", &demo_data.ShowStyleEditor); ImGui::ShowStyleEditor(); ImGui::End(); } // Demonstrate the various window flags. Typically you would just use the default! static bool no_titlebar = false; static bool no_scrollbar = false; static bool no_menu = false; static bool no_move = false; static bool no_resize = false; static bool no_collapse = false; static bool no_close = false; static bool no_nav = false; static bool no_background = false; static bool no_bring_to_front = false; static bool unsaved_document = false; ImGuiWindowFlags window_flags = 0; if (no_titlebar) window_flags |= ImGuiWindowFlags_NoTitleBar; if (no_scrollbar) window_flags |= ImGuiWindowFlags_NoScrollbar; if (!no_menu) window_flags |= ImGuiWindowFlags_MenuBar; if (no_move) window_flags |= ImGuiWindowFlags_NoMove; if (no_resize) window_flags |= ImGuiWindowFlags_NoResize; if (no_collapse) window_flags |= ImGuiWindowFlags_NoCollapse; if (no_nav) window_flags |= ImGuiWindowFlags_NoNav; if (no_background) window_flags |= ImGuiWindowFlags_NoBackground; if (no_bring_to_front) window_flags |= ImGuiWindowFlags_NoBringToFrontOnFocus; if (unsaved_document) window_flags |= ImGuiWindowFlags_UnsavedDocument; if (no_close) p_open = NULL; // Don't pass our bool* to Begin // We specify a default position/size in case there's no data in the .ini file. // We only do it to make the demo applications a little more welcoming, but typically this isn't required. const ImGuiViewport* main_viewport = ImGui::GetMainViewport(); ImGui::SetNextWindowPos(ImVec2(main_viewport->WorkPos.x + 650, main_viewport->WorkPos.y + 20), ImGuiCond_FirstUseEver); ImGui::SetNextWindowSize(ImVec2(550, 680), ImGuiCond_FirstUseEver); // Main body of the Demo window starts here. if (!ImGui::Begin("Dear ImGui Demo", p_open, window_flags)) { // Early out if the window is collapsed, as an optimization. ImGui::End(); return; } // Most "big" widgets share a common width settings by default. See 'Demo->Layout->Widgets Width' for details. ImGui::PushItemWidth(ImGui::GetFontSize() * -12); // e.g. Leave a fixed amount of width for labels (by passing a negative value), the rest goes to widgets. //ImGui::PushItemWidth(-ImGui::GetWindowWidth() * 0.35f); // e.g. Use 2/3 of the space for widgets and 1/3 for labels (right align) // Menu Bar DemoWindowMenuBar(&demo_data); ImGui::Text("dear imgui says hello! (%s) (%d)", IMGUI_VERSION, IMGUI_VERSION_NUM); ImGui::Spacing(); IMGUI_DEMO_MARKER("Help"); if (ImGui::CollapsingHeader("Help")) { ImGui::SeparatorText("ABOUT THIS DEMO:"); ImGui::BulletText("Sections below are demonstrating many aspects of the library."); ImGui::BulletText("The \"Examples\" menu above leads to more demo contents."); ImGui::BulletText("The \"Tools\" menu above gives access to: About Box, Style Editor,\n" "and Metrics/Debugger (general purpose Dear ImGui debugging tool)."); ImGui::SeparatorText("PROGRAMMER GUIDE:"); ImGui::BulletText("See the ShowDemoWindow() code in imgui_demo.cpp. <- you are here!"); ImGui::BulletText("See comments in imgui.cpp."); ImGui::BulletText("See example applications in the examples/ folder."); ImGui::BulletText("Read the FAQ at "); ImGui::SameLine(0, 0); ImGui::TextLinkOpenURL("https://www.dearimgui.com/faq/"); ImGui::BulletText("Set 'io.ConfigFlags |= NavEnableKeyboard' for keyboard controls."); ImGui::BulletText("Set 'io.ConfigFlags |= NavEnableGamepad' for gamepad controls."); ImGui::SeparatorText("USER GUIDE:"); ImGui::ShowUserGuide(); } IMGUI_DEMO_MARKER("Configuration"); if (ImGui::CollapsingHeader("Configuration")) { ImGuiIO& io = ImGui::GetIO(); if (ImGui::TreeNode("Configuration##2")) { ImGui::SeparatorText("General"); ImGui::CheckboxFlags("io.ConfigFlags: NavEnableKeyboard", &io.ConfigFlags, ImGuiConfigFlags_NavEnableKeyboard); ImGui::SameLine(); HelpMarker("Enable keyboard controls."); ImGui::CheckboxFlags("io.ConfigFlags: NavEnableGamepad", &io.ConfigFlags, ImGuiConfigFlags_NavEnableGamepad); ImGui::SameLine(); HelpMarker("Enable gamepad controls. Require backend to set io.BackendFlags |= ImGuiBackendFlags_HasGamepad.\n\nRead instructions in imgui.cpp for details."); ImGui::CheckboxFlags("io.ConfigFlags: NoMouse", &io.ConfigFlags, ImGuiConfigFlags_NoMouse); ImGui::SameLine(); HelpMarker("Instruct dear imgui to disable mouse inputs and interactions."); // The "NoMouse" option can get us stuck with a disabled mouse! Let's provide an alternative way to fix it: if (io.ConfigFlags & ImGuiConfigFlags_NoMouse) { if (fmodf((float)ImGui::GetTime(), 0.40f) < 0.20f) { ImGui::SameLine(); ImGui::Text("<>"); } // Prevent both being checked if (ImGui::IsKeyPressed(ImGuiKey_Space) || (io.ConfigFlags & ImGuiConfigFlags_NoKeyboard)) io.ConfigFlags &= ~ImGuiConfigFlags_NoMouse; } ImGui::CheckboxFlags("io.ConfigFlags: NoMouseCursorChange", &io.ConfigFlags, ImGuiConfigFlags_NoMouseCursorChange); ImGui::SameLine(); HelpMarker("Instruct backend to not alter mouse cursor shape and visibility."); ImGui::CheckboxFlags("io.ConfigFlags: NoKeyboard", &io.ConfigFlags, ImGuiConfigFlags_NoKeyboard); ImGui::SameLine(); HelpMarker("Instruct dear imgui to disable keyboard inputs and interactions."); ImGui::Checkbox("io.ConfigInputTrickleEventQueue", &io.ConfigInputTrickleEventQueue); ImGui::SameLine(); HelpMarker("Enable input queue trickling: some types of events submitted during the same frame (e.g. button down + up) will be spread over multiple frames, improving interactions with low framerates."); ImGui::Checkbox("io.MouseDrawCursor", &io.MouseDrawCursor); ImGui::SameLine(); HelpMarker("Instruct Dear ImGui to render a mouse cursor itself. Note that a mouse cursor rendered via your application GPU rendering path will feel more laggy than hardware cursor, but will be more in sync with your other visuals.\n\nSome desktop applications may use both kinds of cursors (e.g. enable software cursor only when resizing/dragging something)."); ImGui::SeparatorText("Keyboard/Gamepad Navigation"); ImGui::Checkbox("io.ConfigNavSwapGamepadButtons", &io.ConfigNavSwapGamepadButtons); ImGui::Checkbox("io.ConfigNavMoveSetMousePos", &io.ConfigNavMoveSetMousePos); ImGui::SameLine(); HelpMarker("Directional/tabbing navigation teleports the mouse cursor. May be useful on TV/console systems where moving a virtual mouse is difficult"); ImGui::Checkbox("io.ConfigNavCaptureKeyboard", &io.ConfigNavCaptureKeyboard); ImGui::Checkbox("io.ConfigNavEscapeClearFocusItem", &io.ConfigNavEscapeClearFocusItem); ImGui::SameLine(); HelpMarker("Pressing Escape clears focused item."); ImGui::Checkbox("io.ConfigNavEscapeClearFocusWindow", &io.ConfigNavEscapeClearFocusWindow); ImGui::SameLine(); HelpMarker("Pressing Escape clears focused window."); ImGui::Checkbox("io.ConfigNavCursorVisibleAuto", &io.ConfigNavCursorVisibleAuto); ImGui::SameLine(); HelpMarker("Using directional navigation key makes the cursor visible. Mouse click hides the cursor."); ImGui::Checkbox("io.ConfigNavCursorVisibleAlways", &io.ConfigNavCursorVisibleAlways); ImGui::SameLine(); HelpMarker("Navigation cursor is always visible."); ImGui::SeparatorText("Windows"); ImGui::Checkbox("io.ConfigWindowsResizeFromEdges", &io.ConfigWindowsResizeFromEdges); ImGui::SameLine(); HelpMarker("Enable resizing of windows from their edges and from the lower-left corner.\nThis requires ImGuiBackendFlags_HasMouseCursors for better mouse cursor feedback."); ImGui::Checkbox("io.ConfigWindowsMoveFromTitleBarOnly", &io.ConfigWindowsMoveFromTitleBarOnly); ImGui::Checkbox("io.ConfigWindowsCopyContentsWithCtrlC", &io.ConfigWindowsCopyContentsWithCtrlC); // [EXPERIMENTAL] ImGui::SameLine(); HelpMarker("*EXPERIMENTAL* CTRL+C copy the contents of focused window into the clipboard.\n\nExperimental because:\n- (1) has known issues with nested Begin/End pairs.\n- (2) text output quality varies.\n- (3) text output is in submission order rather than spatial order."); ImGui::Checkbox("io.ConfigScrollbarScrollByPage", &io.ConfigScrollbarScrollByPage); ImGui::SameLine(); HelpMarker("Enable scrolling page by page when clicking outside the scrollbar grab.\nWhen disabled, always scroll to clicked location.\nWhen enabled, Shift+Click scrolls to clicked location."); ImGui::SeparatorText("Widgets"); ImGui::Checkbox("io.ConfigInputTextCursorBlink", &io.ConfigInputTextCursorBlink); ImGui::SameLine(); HelpMarker("Enable blinking cursor (optional as some users consider it to be distracting)."); ImGui::Checkbox("io.ConfigInputTextEnterKeepActive", &io.ConfigInputTextEnterKeepActive); ImGui::SameLine(); HelpMarker("Pressing Enter will keep item active and select contents (single-line only)."); ImGui::Checkbox("io.ConfigDragClickToInputText", &io.ConfigDragClickToInputText); ImGui::SameLine(); HelpMarker("Enable turning DragXXX widgets into text input with a simple mouse click-release (without moving)."); ImGui::Checkbox("io.ConfigMacOSXBehaviors", &io.ConfigMacOSXBehaviors); ImGui::SameLine(); HelpMarker("Swap Cmd<>Ctrl keys, enable various MacOS style behaviors."); ImGui::Text("Also see Style->Rendering for rendering options."); // Also read: https://github.com/ocornut/imgui/wiki/Error-Handling ImGui::SeparatorText("Error Handling"); ImGui::Checkbox("io.ConfigErrorRecovery", &io.ConfigErrorRecovery); ImGui::SameLine(); HelpMarker( "Options to configure how we handle recoverable errors.\n" "- Error recovery is not perfect nor guaranteed! It is a feature to ease development.\n" "- You not are not supposed to rely on it in the course of a normal application run.\n" "- Possible usage: facilitate recovery from errors triggered from a scripting language or after specific exceptions handlers.\n" "- Always ensure that on programmers seat you have at minimum Asserts or Tooltips enabled when making direct imgui API call! " "Otherwise it would severely hinder your ability to catch and correct mistakes!"); ImGui::Checkbox("io.ConfigErrorRecoveryEnableAssert", &io.ConfigErrorRecoveryEnableAssert); ImGui::Checkbox("io.ConfigErrorRecoveryEnableDebugLog", &io.ConfigErrorRecoveryEnableDebugLog); ImGui::Checkbox("io.ConfigErrorRecoveryEnableTooltip", &io.ConfigErrorRecoveryEnableTooltip); if (!io.ConfigErrorRecoveryEnableAssert && !io.ConfigErrorRecoveryEnableDebugLog && !io.ConfigErrorRecoveryEnableTooltip) io.ConfigErrorRecoveryEnableAssert = io.ConfigErrorRecoveryEnableDebugLog = io.ConfigErrorRecoveryEnableTooltip = true; // Also read: https://github.com/ocornut/imgui/wiki/Debug-Tools ImGui::SeparatorText("Debug"); ImGui::Checkbox("io.ConfigDebugIsDebuggerPresent", &io.ConfigDebugIsDebuggerPresent); ImGui::SameLine(); HelpMarker("Enable various tools calling IM_DEBUG_BREAK().\n\nRequires a debugger being attached, otherwise IM_DEBUG_BREAK() options will appear to crash your application."); ImGui::Checkbox("io.ConfigDebugHighlightIdConflicts", &io.ConfigDebugHighlightIdConflicts); ImGui::SameLine(); HelpMarker("Highlight and show an error message when multiple items have conflicting identifiers."); ImGui::BeginDisabled(); ImGui::Checkbox("io.ConfigDebugBeginReturnValueOnce", &io.ConfigDebugBeginReturnValueOnce); ImGui::EndDisabled(); ImGui::SameLine(); HelpMarker("First calls to Begin()/BeginChild() will return false.\n\nTHIS OPTION IS DISABLED because it needs to be set at application boot-time to make sense. Showing the disabled option is a way to make this feature easier to discover."); ImGui::Checkbox("io.ConfigDebugBeginReturnValueLoop", &io.ConfigDebugBeginReturnValueLoop); ImGui::SameLine(); HelpMarker("Some calls to Begin()/BeginChild() will return false.\n\nWill cycle through window depths then repeat. Windows should be flickering while running."); ImGui::Checkbox("io.ConfigDebugIgnoreFocusLoss", &io.ConfigDebugIgnoreFocusLoss); ImGui::SameLine(); HelpMarker("Option to deactivate io.AddFocusEvent(false) handling. May facilitate interactions with a debugger when focus loss leads to clearing inputs data."); ImGui::Checkbox("io.ConfigDebugIniSettings", &io.ConfigDebugIniSettings); ImGui::SameLine(); HelpMarker("Option to save .ini data with extra comments (particularly helpful for Docking, but makes saving slower)."); ImGui::TreePop(); ImGui::Spacing(); } IMGUI_DEMO_MARKER("Configuration/Backend Flags"); if (ImGui::TreeNode("Backend Flags")) { HelpMarker( "Those flags are set by the backends (imgui_impl_xxx files) to specify their capabilities.\n" "Here we expose them as read-only fields to avoid breaking interactions with your backend."); // FIXME: Maybe we need a BeginReadonly() equivalent to keep label bright? ImGui::BeginDisabled(); ImGui::CheckboxFlags("io.BackendFlags: HasGamepad", &io.BackendFlags, ImGuiBackendFlags_HasGamepad); ImGui::CheckboxFlags("io.BackendFlags: HasMouseCursors", &io.BackendFlags, ImGuiBackendFlags_HasMouseCursors); ImGui::CheckboxFlags("io.BackendFlags: HasSetMousePos", &io.BackendFlags, ImGuiBackendFlags_HasSetMousePos); ImGui::CheckboxFlags("io.BackendFlags: RendererHasVtxOffset", &io.BackendFlags, ImGuiBackendFlags_RendererHasVtxOffset); ImGui::EndDisabled(); ImGui::TreePop(); ImGui::Spacing(); } IMGUI_DEMO_MARKER("Configuration/Style"); if (ImGui::TreeNode("Style")) { ImGui::Checkbox("Style Editor", &demo_data.ShowStyleEditor); ImGui::SameLine(); HelpMarker("The same contents can be accessed in 'Tools->Style Editor' or by calling the ShowStyleEditor() function."); ImGui::TreePop(); ImGui::Spacing(); } IMGUI_DEMO_MARKER("Configuration/Capture, Logging"); if (ImGui::TreeNode("Capture/Logging")) { HelpMarker( "The logging API redirects all text output so you can easily capture the content of " "a window or a block. Tree nodes can be automatically expanded.\n" "Try opening any of the contents below in this window and then click one of the \"Log To\" button."); ImGui::LogButtons(); HelpMarker("You can also call ImGui::LogText() to output directly to the log without a visual output."); if (ImGui::Button("Copy \"Hello, world!\" to clipboard")) { ImGui::LogToClipboard(); ImGui::LogText("Hello, world!"); ImGui::LogFinish(); } ImGui::TreePop(); } } IMGUI_DEMO_MARKER("Window options"); if (ImGui::CollapsingHeader("Window options")) { if (ImGui::BeginTable("split", 3)) { ImGui::TableNextColumn(); ImGui::Checkbox("No titlebar", &no_titlebar); ImGui::TableNextColumn(); ImGui::Checkbox("No scrollbar", &no_scrollbar); ImGui::TableNextColumn(); ImGui::Checkbox("No menu", &no_menu); ImGui::TableNextColumn(); ImGui::Checkbox("No move", &no_move); ImGui::TableNextColumn(); ImGui::Checkbox("No resize", &no_resize); ImGui::TableNextColumn(); ImGui::Checkbox("No collapse", &no_collapse); ImGui::TableNextColumn(); ImGui::Checkbox("No close", &no_close); ImGui::TableNextColumn(); ImGui::Checkbox("No nav", &no_nav); ImGui::TableNextColumn(); ImGui::Checkbox("No background", &no_background); ImGui::TableNextColumn(); ImGui::Checkbox("No bring to front", &no_bring_to_front); ImGui::TableNextColumn(); ImGui::Checkbox("Unsaved document", &unsaved_document); ImGui::EndTable(); } } // All demo contents DemoWindowWidgets(&demo_data); DemoWindowLayout(); DemoWindowPopups(); DemoWindowTables(); DemoWindowInputs(); // End of ShowDemoWindow() ImGui::PopItemWidth(); ImGui::End(); } //----------------------------------------------------------------------------- // [SECTION] DemoWindowMenuBar() //----------------------------------------------------------------------------- static void DemoWindowMenuBar(ImGuiDemoWindowData* demo_data) { IMGUI_DEMO_MARKER("Menu"); if (ImGui::BeginMenuBar()) { if (ImGui::BeginMenu("Menu")) { IMGUI_DEMO_MARKER("Menu/File"); ShowExampleMenuFile(); ImGui::EndMenu(); } if (ImGui::BeginMenu("Examples")) { IMGUI_DEMO_MARKER("Menu/Examples"); ImGui::MenuItem("Main menu bar", NULL, &demo_data->ShowMainMenuBar); ImGui::SeparatorText("Mini apps"); ImGui::MenuItem("Assets Browser", NULL, &demo_data->ShowAppAssetsBrowser); ImGui::MenuItem("Console", NULL, &demo_data->ShowAppConsole); ImGui::MenuItem("Custom rendering", NULL, &demo_data->ShowAppCustomRendering); ImGui::MenuItem("Documents", NULL, &demo_data->ShowAppDocuments); ImGui::MenuItem("Log", NULL, &demo_data->ShowAppLog); ImGui::MenuItem("Property editor", NULL, &demo_data->ShowAppPropertyEditor); ImGui::MenuItem("Simple layout", NULL, &demo_data->ShowAppLayout); ImGui::MenuItem("Simple overlay", NULL, &demo_data->ShowAppSimpleOverlay); ImGui::SeparatorText("Concepts"); ImGui::MenuItem("Auto-resizing window", NULL, &demo_data->ShowAppAutoResize); ImGui::MenuItem("Constrained-resizing window", NULL, &demo_data->ShowAppConstrainedResize); ImGui::MenuItem("Fullscreen window", NULL, &demo_data->ShowAppFullscreen); ImGui::MenuItem("Long text display", NULL, &demo_data->ShowAppLongText); ImGui::MenuItem("Manipulating window titles", NULL, &demo_data->ShowAppWindowTitles); ImGui::EndMenu(); } //if (ImGui::MenuItem("MenuItem")) {} // You can also use MenuItem() inside a menu bar! if (ImGui::BeginMenu("Tools")) { IMGUI_DEMO_MARKER("Menu/Tools"); ImGuiIO& io = ImGui::GetIO(); #ifndef IMGUI_DISABLE_DEBUG_TOOLS const bool has_debug_tools = true; #else const bool has_debug_tools = false; #endif ImGui::MenuItem("Metrics/Debugger", NULL, &demo_data->ShowMetrics, has_debug_tools); if (ImGui::BeginMenu("Debug Options")) { ImGui::BeginDisabled(!has_debug_tools); ImGui::Checkbox("Highlight ID Conflicts", &io.ConfigDebugHighlightIdConflicts); ImGui::EndDisabled(); ImGui::Checkbox("Assert on error recovery", &io.ConfigErrorRecoveryEnableAssert); ImGui::TextDisabled("(see Demo->Configuration for details & more)"); ImGui::EndMenu(); } ImGui::MenuItem("Debug Log", NULL, &demo_data->ShowDebugLog, has_debug_tools); ImGui::MenuItem("ID Stack Tool", NULL, &demo_data->ShowIDStackTool, has_debug_tools); bool is_debugger_present = io.ConfigDebugIsDebuggerPresent; if (ImGui::MenuItem("Item Picker", NULL, false, has_debug_tools))// && is_debugger_present)) ImGui::DebugStartItemPicker(); if (!is_debugger_present) ImGui::SetItemTooltip("Requires io.ConfigDebugIsDebuggerPresent=true to be set.\n\nWe otherwise disable some extra features to avoid casual users crashing the application."); ImGui::MenuItem("Style Editor", NULL, &demo_data->ShowStyleEditor); ImGui::MenuItem("About Dear ImGui", NULL, &demo_data->ShowAbout); ImGui::EndMenu(); } ImGui::EndMenuBar(); } } //----------------------------------------------------------------------------- // [SECTION] Helpers: ExampleTreeNode, ExampleMemberInfo (for use by Property Editor & Multi-Select demos) //----------------------------------------------------------------------------- // Simple representation for a tree // (this is designed to be simple to understand for our demos, not to be fancy or efficient etc.) struct ExampleTreeNode { // Tree structure char Name[28] = ""; int UID = 0; ExampleTreeNode* Parent = NULL; ImVector Childs; unsigned short IndexInParent = 0; // Maintaining this allows us to implement linear traversal more easily // Leaf Data bool HasData = false; // All leaves have data bool DataMyBool = true; int DataMyInt = 128; ImVec2 DataMyVec2 = ImVec2(0.0f, 3.141592f); }; // Simple representation of struct metadata/serialization data. // (this is a minimal version of what a typical advanced application may provide) struct ExampleMemberInfo { const char* Name; // Member name ImGuiDataType DataType; // Member type int DataCount; // Member count (1 when scalar) int Offset; // Offset inside parent structure }; // Metadata description of ExampleTreeNode struct. static const ExampleMemberInfo ExampleTreeNodeMemberInfos[] { { "MyName", ImGuiDataType_String, 1, offsetof(ExampleTreeNode, Name) }, { "MyBool", ImGuiDataType_Bool, 1, offsetof(ExampleTreeNode, DataMyBool) }, { "MyInt", ImGuiDataType_S32, 1, offsetof(ExampleTreeNode, DataMyInt) }, { "MyVec2", ImGuiDataType_Float, 2, offsetof(ExampleTreeNode, DataMyVec2) }, }; static ExampleTreeNode* ExampleTree_CreateNode(const char* name, int uid, ExampleTreeNode* parent) { ExampleTreeNode* node = IM_NEW(ExampleTreeNode); snprintf(node->Name, IM_ARRAYSIZE(node->Name), "%s", name); node->UID = uid; node->Parent = parent; node->IndexInParent = parent ? (unsigned short)parent->Childs.Size : 0; if (parent) parent->Childs.push_back(node); return node; } static void ExampleTree_DestroyNode(ExampleTreeNode* node) { for (ExampleTreeNode* child_node : node->Childs) ExampleTree_DestroyNode(child_node); IM_DELETE(node); } // Create example tree data // (this allocates _many_ more times than most other code in either Dear ImGui or others demo) static ExampleTreeNode* ExampleTree_CreateDemoTree() { static const char* root_names[] = { "Apple", "Banana", "Cherry", "Kiwi", "Mango", "Orange", "Pear", "Pineapple", "Strawberry", "Watermelon" }; const size_t NAME_MAX_LEN = sizeof(ExampleTreeNode::Name); char name_buf[NAME_MAX_LEN]; int uid = 0; ExampleTreeNode* node_L0 = ExampleTree_CreateNode("", ++uid, NULL); const int root_items_multiplier = 2; for (int idx_L0 = 0; idx_L0 < IM_ARRAYSIZE(root_names) * root_items_multiplier; idx_L0++) { snprintf(name_buf, IM_ARRAYSIZE(name_buf), "%s %d", root_names[idx_L0 / root_items_multiplier], idx_L0 % root_items_multiplier); ExampleTreeNode* node_L1 = ExampleTree_CreateNode(name_buf, ++uid, node_L0); const int number_of_childs = (int)strlen(node_L1->Name); for (int idx_L1 = 0; idx_L1 < number_of_childs; idx_L1++) { snprintf(name_buf, IM_ARRAYSIZE(name_buf), "Child %d", idx_L1); ExampleTreeNode* node_L2 = ExampleTree_CreateNode(name_buf, ++uid, node_L1); node_L2->HasData = true; if (idx_L1 == 0) { snprintf(name_buf, IM_ARRAYSIZE(name_buf), "Sub-child %d", 0); ExampleTreeNode* node_L3 = ExampleTree_CreateNode(name_buf, ++uid, node_L2); node_L3->HasData = true; } } } return node_L0; } //----------------------------------------------------------------------------- // [SECTION] DemoWindowWidgetsBasic() //----------------------------------------------------------------------------- static void DemoWindowWidgetsBasic() { IMGUI_DEMO_MARKER("Widgets/Basic"); if (ImGui::TreeNode("Basic")) { ImGui::SeparatorText("General"); IMGUI_DEMO_MARKER("Widgets/Basic/Button"); static int clicked = 0; if (ImGui::Button("Button")) clicked++; if (clicked & 1) { ImGui::SameLine(); ImGui::Text("Thanks for clicking me!"); } IMGUI_DEMO_MARKER("Widgets/Basic/Checkbox"); static bool check = true; ImGui::Checkbox("checkbox", &check); IMGUI_DEMO_MARKER("Widgets/Basic/RadioButton"); static int e = 0; ImGui::RadioButton("radio a", &e, 0); ImGui::SameLine(); ImGui::RadioButton("radio b", &e, 1); ImGui::SameLine(); ImGui::RadioButton("radio c", &e, 2); // Color buttons, demonstrate using PushID() to add unique identifier in the ID stack, and changing style. IMGUI_DEMO_MARKER("Widgets/Basic/Buttons (Colored)"); for (int i = 0; i < 7; i++) { if (i > 0) ImGui::SameLine(); ImGui::PushID(i); ImGui::PushStyleColor(ImGuiCol_Button, (ImVec4)ImColor::HSV(i / 7.0f, 0.6f, 0.6f)); ImGui::PushStyleColor(ImGuiCol_ButtonHovered, (ImVec4)ImColor::HSV(i / 7.0f, 0.7f, 0.7f)); ImGui::PushStyleColor(ImGuiCol_ButtonActive, (ImVec4)ImColor::HSV(i / 7.0f, 0.8f, 0.8f)); ImGui::Button("Click"); ImGui::PopStyleColor(3); ImGui::PopID(); } // Use AlignTextToFramePadding() to align text baseline to the baseline of framed widgets elements // (otherwise a Text+SameLine+Button sequence will have the text a little too high by default!) // See 'Demo->Layout->Text Baseline Alignment' for details. ImGui::AlignTextToFramePadding(); ImGui::Text("Hold to repeat:"); ImGui::SameLine(); // Arrow buttons with Repeater IMGUI_DEMO_MARKER("Widgets/Basic/Buttons (Repeating)"); static int counter = 0; float spacing = ImGui::GetStyle().ItemInnerSpacing.x; ImGui::PushItemFlag(ImGuiItemFlags_ButtonRepeat, true); if (ImGui::ArrowButton("##left", ImGuiDir_Left)) { counter--; } ImGui::SameLine(0.0f, spacing); if (ImGui::ArrowButton("##right", ImGuiDir_Right)) { counter++; } ImGui::PopItemFlag(); ImGui::SameLine(); ImGui::Text("%d", counter); ImGui::Button("Tooltip"); ImGui::SetItemTooltip("I am a tooltip"); ImGui::LabelText("label", "Value"); ImGui::SeparatorText("Inputs"); { // To wire InputText() with std::string or any other custom string type, // see the "Text Input > Resize Callback" section of this demo, and the misc/cpp/imgui_stdlib.h file. IMGUI_DEMO_MARKER("Widgets/Basic/InputText"); static char str0[128] = "Hello, world!"; ImGui::InputText("input text", str0, IM_ARRAYSIZE(str0)); ImGui::SameLine(); HelpMarker( "USER:\n" "Hold SHIFT or use mouse to select text.\n" "CTRL+Left/Right to word jump.\n" "CTRL+A or Double-Click to select all.\n" "CTRL+X,CTRL+C,CTRL+V for clipboard.\n" "CTRL+Z to undo, CTRL+Y/CTRL+SHIFT+Z to redo.\n" "ESCAPE to revert.\n\n" "PROGRAMMER:\n" "You can use the ImGuiInputTextFlags_CallbackResize facility if you need to wire InputText() " "to a dynamic string type. See misc/cpp/imgui_stdlib.h for an example (this is not demonstrated " "in imgui_demo.cpp)."); static char str1[128] = ""; ImGui::InputTextWithHint("input text (w/ hint)", "enter text here", str1, IM_ARRAYSIZE(str1)); IMGUI_DEMO_MARKER("Widgets/Basic/InputInt, InputFloat"); static int i0 = 123; ImGui::InputInt("input int", &i0); static float f0 = 0.001f; ImGui::InputFloat("input float", &f0, 0.01f, 1.0f, "%.3f"); static double d0 = 999999.00000001; ImGui::InputDouble("input double", &d0, 0.01f, 1.0f, "%.8f"); static float f1 = 1.e10f; ImGui::InputFloat("input scientific", &f1, 0.0f, 0.0f, "%e"); ImGui::SameLine(); HelpMarker( "You can input value using the scientific notation,\n" " e.g. \"1e+8\" becomes \"100000000\"."); static float vec4a[4] = { 0.10f, 0.20f, 0.30f, 0.44f }; ImGui::InputFloat3("input float3", vec4a); } ImGui::SeparatorText("Drags"); { IMGUI_DEMO_MARKER("Widgets/Basic/DragInt, DragFloat"); static int i1 = 50, i2 = 42, i3 = 128; ImGui::DragInt("drag int", &i1, 1); ImGui::SameLine(); HelpMarker( "Click and drag to edit value.\n" "Hold SHIFT/ALT for faster/slower edit.\n" "Double-click or CTRL+click to input value."); ImGui::DragInt("drag int 0..100", &i2, 1, 0, 100, "%d%%", ImGuiSliderFlags_AlwaysClamp); ImGui::DragInt("drag int wrap 100..200", &i3, 1, 100, 200, "%d", ImGuiSliderFlags_WrapAround); static float f1 = 1.00f, f2 = 0.0067f; ImGui::DragFloat("drag float", &f1, 0.005f); ImGui::DragFloat("drag small float", &f2, 0.0001f, 0.0f, 0.0f, "%.06f ns"); //ImGui::DragFloat("drag wrap -1..1", &f3, 0.005f, -1.0f, 1.0f, NULL, ImGuiSliderFlags_WrapAround); } ImGui::SeparatorText("Sliders"); { IMGUI_DEMO_MARKER("Widgets/Basic/SliderInt, SliderFloat"); static int i1 = 0; ImGui::SliderInt("slider int", &i1, -1, 3); ImGui::SameLine(); HelpMarker("CTRL+click to input value."); static float f1 = 0.123f, f2 = 0.0f; ImGui::SliderFloat("slider float", &f1, 0.0f, 1.0f, "ratio = %.3f"); ImGui::SliderFloat("slider float (log)", &f2, -10.0f, 10.0f, "%.4f", ImGuiSliderFlags_Logarithmic); IMGUI_DEMO_MARKER("Widgets/Basic/SliderAngle"); static float angle = 0.0f; ImGui::SliderAngle("slider angle", &angle); // Using the format string to display a name instead of an integer. // Here we completely omit '%d' from the format string, so it'll only display a name. // This technique can also be used with DragInt(). IMGUI_DEMO_MARKER("Widgets/Basic/Slider (enum)"); enum Element { Element_Fire, Element_Earth, Element_Air, Element_Water, Element_COUNT }; static int elem = Element_Fire; const char* elems_names[Element_COUNT] = { "Fire", "Earth", "Air", "Water" }; const char* elem_name = (elem >= 0 && elem < Element_COUNT) ? elems_names[elem] : "Unknown"; ImGui::SliderInt("slider enum", &elem, 0, Element_COUNT - 1, elem_name); // Use ImGuiSliderFlags_NoInput flag to disable CTRL+Click here. ImGui::SameLine(); HelpMarker("Using the format string parameter to display a name instead of the underlying integer."); } ImGui::SeparatorText("Selectors/Pickers"); { IMGUI_DEMO_MARKER("Widgets/Basic/ColorEdit3, ColorEdit4"); static float col1[3] = { 1.0f, 0.0f, 0.2f }; static float col2[4] = { 0.4f, 0.7f, 0.0f, 0.5f }; ImGui::ColorEdit3("color 1", col1); ImGui::SameLine(); HelpMarker( "Click on the color square to open a color picker.\n" "Click and hold to use drag and drop.\n" "Right-click on the color square to show options.\n" "CTRL+click on individual component to input value.\n"); ImGui::ColorEdit4("color 2", col2); } { // Using the _simplified_ one-liner Combo() api here // See "Combo" section for examples of how to use the more flexible BeginCombo()/EndCombo() api. IMGUI_DEMO_MARKER("Widgets/Basic/Combo"); const char* items[] = { "AAAA", "BBBB", "CCCC", "DDDD", "EEEE", "FFFF", "GGGG", "HHHH", "IIIIIII", "JJJJ", "KKKKKKK" }; static int item_current = 0; ImGui::Combo("combo", &item_current, items, IM_ARRAYSIZE(items)); ImGui::SameLine(); HelpMarker( "Using the simplified one-liner Combo API here.\n" "Refer to the \"Combo\" section below for an explanation of how to use the more flexible and general BeginCombo/EndCombo API."); } { // Using the _simplified_ one-liner ListBox() api here // See "List boxes" section for examples of how to use the more flexible BeginListBox()/EndListBox() api. IMGUI_DEMO_MARKER("Widgets/Basic/ListBox"); const char* items[] = { "Apple", "Banana", "Cherry", "Kiwi", "Mango", "Orange", "Pineapple", "Strawberry", "Watermelon" }; static int item_current = 1; ImGui::ListBox("listbox", &item_current, items, IM_ARRAYSIZE(items), 4); ImGui::SameLine(); HelpMarker( "Using the simplified one-liner ListBox API here.\n" "Refer to the \"List boxes\" section below for an explanation of how to use the more flexible and general BeginListBox/EndListBox API."); } // Testing ImGuiOnceUponAFrame helper. //static ImGuiOnceUponAFrame once; //for (int i = 0; i < 5; i++) // if (once) // ImGui::Text("This will be displayed only once."); ImGui::TreePop(); } } //----------------------------------------------------------------------------- // [SECTION] DemoWindowWidgetsBullets() //----------------------------------------------------------------------------- static void DemoWindowWidgetsBullets() { IMGUI_DEMO_MARKER("Widgets/Bullets"); if (ImGui::TreeNode("Bullets")) { ImGui::BulletText("Bullet point 1"); ImGui::BulletText("Bullet point 2\nOn multiple lines"); if (ImGui::TreeNode("Tree node")) { ImGui::BulletText("Another bullet point"); ImGui::TreePop(); } ImGui::Bullet(); ImGui::Text("Bullet point 3 (two calls)"); ImGui::Bullet(); ImGui::SmallButton("Button"); ImGui::TreePop(); } } //----------------------------------------------------------------------------- // [SECTION] DemoWindowWidgetsCollapsingHeaders() //----------------------------------------------------------------------------- static void DemoWindowWidgetsCollapsingHeaders() { IMGUI_DEMO_MARKER("Widgets/Collapsing Headers"); if (ImGui::TreeNode("Collapsing Headers")) { static bool closable_group = true; ImGui::Checkbox("Show 2nd header", &closable_group); if (ImGui::CollapsingHeader("Header", ImGuiTreeNodeFlags_None)) { ImGui::Text("IsItemHovered: %d", ImGui::IsItemHovered()); for (int i = 0; i < 5; i++) ImGui::Text("Some content %d", i); } if (ImGui::CollapsingHeader("Header with a close button", &closable_group)) { ImGui::Text("IsItemHovered: %d", ImGui::IsItemHovered()); for (int i = 0; i < 5; i++) ImGui::Text("More content %d", i); } /* if (ImGui::CollapsingHeader("Header with a bullet", ImGuiTreeNodeFlags_Bullet)) ImGui::Text("IsItemHovered: %d", ImGui::IsItemHovered()); */ ImGui::TreePop(); } } //----------------------------------------------------------------------------- // [SECTION] DemoWindowWidgetsColorAndPickers() //----------------------------------------------------------------------------- static void DemoWindowWidgetsColorAndPickers() { IMGUI_DEMO_MARKER("Widgets/Color"); if (ImGui::TreeNode("Color/Picker Widgets")) { static ImVec4 color = ImVec4(114.0f / 255.0f, 144.0f / 255.0f, 154.0f / 255.0f, 200.0f / 255.0f); static ImGuiColorEditFlags base_flags = ImGuiColorEditFlags_None; ImGui::SeparatorText("Options"); ImGui::CheckboxFlags("ImGuiColorEditFlags_NoAlpha", &base_flags, ImGuiColorEditFlags_NoAlpha); ImGui::CheckboxFlags("ImGuiColorEditFlags_AlphaOpaque", &base_flags, ImGuiColorEditFlags_AlphaOpaque); ImGui::CheckboxFlags("ImGuiColorEditFlags_AlphaNoBg", &base_flags, ImGuiColorEditFlags_AlphaNoBg); ImGui::CheckboxFlags("ImGuiColorEditFlags_AlphaPreviewHalf", &base_flags, ImGuiColorEditFlags_AlphaPreviewHalf); ImGui::CheckboxFlags("ImGuiColorEditFlags_NoDragDrop", &base_flags, ImGuiColorEditFlags_NoDragDrop); ImGui::CheckboxFlags("ImGuiColorEditFlags_NoOptions", &base_flags, ImGuiColorEditFlags_NoOptions); ImGui::SameLine(); HelpMarker("Right-click on the individual color widget to show options."); ImGui::CheckboxFlags("ImGuiColorEditFlags_HDR", &base_flags, ImGuiColorEditFlags_HDR); ImGui::SameLine(); HelpMarker("Currently all this does is to lift the 0..1 limits on dragging widgets."); IMGUI_DEMO_MARKER("Widgets/Color/ColorEdit"); ImGui::SeparatorText("Inline color editor"); ImGui::Text("Color widget:"); ImGui::SameLine(); HelpMarker( "Click on the color square to open a color picker.\n" "CTRL+click on individual component to input value.\n"); ImGui::ColorEdit3("MyColor##1", (float*)&color, base_flags); IMGUI_DEMO_MARKER("Widgets/Color/ColorEdit (HSV, with Alpha)"); ImGui::Text("Color widget HSV with Alpha:"); ImGui::ColorEdit4("MyColor##2", (float*)&color, ImGuiColorEditFlags_DisplayHSV | base_flags); IMGUI_DEMO_MARKER("Widgets/Color/ColorEdit (float display)"); ImGui::Text("Color widget with Float Display:"); ImGui::ColorEdit4("MyColor##2f", (float*)&color, ImGuiColorEditFlags_Float | base_flags); IMGUI_DEMO_MARKER("Widgets/Color/ColorButton (with Picker)"); ImGui::Text("Color button with Picker:"); ImGui::SameLine(); HelpMarker( "With the ImGuiColorEditFlags_NoInputs flag you can hide all the slider/text inputs.\n" "With the ImGuiColorEditFlags_NoLabel flag you can pass a non-empty label which will only " "be used for the tooltip and picker popup."); ImGui::ColorEdit4("MyColor##3", (float*)&color, ImGuiColorEditFlags_NoInputs | ImGuiColorEditFlags_NoLabel | base_flags); IMGUI_DEMO_MARKER("Widgets/Color/ColorButton (with custom Picker popup)"); ImGui::Text("Color button with Custom Picker Popup:"); // Generate a default palette. The palette will persist and can be edited. static bool saved_palette_init = true; static ImVec4 saved_palette[32] = {}; if (saved_palette_init) { for (int n = 0; n < IM_ARRAYSIZE(saved_palette); n++) { ImGui::ColorConvertHSVtoRGB(n / 31.0f, 0.8f, 0.8f, saved_palette[n].x, saved_palette[n].y, saved_palette[n].z); saved_palette[n].w = 1.0f; // Alpha } saved_palette_init = false; } static ImVec4 backup_color; bool open_popup = ImGui::ColorButton("MyColor##3b", color, base_flags); ImGui::SameLine(0, ImGui::GetStyle().ItemInnerSpacing.x); open_popup |= ImGui::Button("Palette"); if (open_popup) { ImGui::OpenPopup("mypicker"); backup_color = color; } if (ImGui::BeginPopup("mypicker")) { ImGui::Text("MY CUSTOM COLOR PICKER WITH AN AMAZING PALETTE!"); ImGui::Separator(); ImGui::ColorPicker4("##picker", (float*)&color, base_flags | ImGuiColorEditFlags_NoSidePreview | ImGuiColorEditFlags_NoSmallPreview); ImGui::SameLine(); ImGui::BeginGroup(); // Lock X position ImGui::Text("Current"); ImGui::ColorButton("##current", color, ImGuiColorEditFlags_NoPicker | ImGuiColorEditFlags_AlphaPreviewHalf, ImVec2(60, 40)); ImGui::Text("Previous"); if (ImGui::ColorButton("##previous", backup_color, ImGuiColorEditFlags_NoPicker | ImGuiColorEditFlags_AlphaPreviewHalf, ImVec2(60, 40))) color = backup_color; ImGui::Separator(); ImGui::Text("Palette"); for (int n = 0; n < IM_ARRAYSIZE(saved_palette); n++) { ImGui::PushID(n); if ((n % 8) != 0) ImGui::SameLine(0.0f, ImGui::GetStyle().ItemSpacing.y); ImGuiColorEditFlags palette_button_flags = ImGuiColorEditFlags_NoAlpha | ImGuiColorEditFlags_NoPicker | ImGuiColorEditFlags_NoTooltip; if (ImGui::ColorButton("##palette", saved_palette[n], palette_button_flags, ImVec2(20, 20))) color = ImVec4(saved_palette[n].x, saved_palette[n].y, saved_palette[n].z, color.w); // Preserve alpha! // Allow user to drop colors into each palette entry. Note that ColorButton() is already a // drag source by default, unless specifying the ImGuiColorEditFlags_NoDragDrop flag. if (ImGui::BeginDragDropTarget()) { if (const ImGuiPayload* payload = ImGui::AcceptDragDropPayload(IMGUI_PAYLOAD_TYPE_COLOR_3F)) memcpy((float*)&saved_palette[n], payload->Data, sizeof(float) * 3); if (const ImGuiPayload* payload = ImGui::AcceptDragDropPayload(IMGUI_PAYLOAD_TYPE_COLOR_4F)) memcpy((float*)&saved_palette[n], payload->Data, sizeof(float) * 4); ImGui::EndDragDropTarget(); } ImGui::PopID(); } ImGui::EndGroup(); ImGui::EndPopup(); } IMGUI_DEMO_MARKER("Widgets/Color/ColorButton (simple)"); ImGui::Text("Color button only:"); static bool no_border = false; ImGui::Checkbox("ImGuiColorEditFlags_NoBorder", &no_border); ImGui::ColorButton("MyColor##3c", *(ImVec4*)&color, base_flags | (no_border ? ImGuiColorEditFlags_NoBorder : 0), ImVec2(80, 80)); IMGUI_DEMO_MARKER("Widgets/Color/ColorPicker"); ImGui::SeparatorText("Color picker"); static bool ref_color = false; static ImVec4 ref_color_v(1.0f, 0.0f, 1.0f, 0.5f); static int picker_mode = 0; static int display_mode = 0; static ImGuiColorEditFlags color_picker_flags = ImGuiColorEditFlags_AlphaBar; ImGui::PushID("Color picker"); ImGui::CheckboxFlags("ImGuiColorEditFlags_NoAlpha", &color_picker_flags, ImGuiColorEditFlags_NoAlpha); ImGui::CheckboxFlags("ImGuiColorEditFlags_AlphaBar", &color_picker_flags, ImGuiColorEditFlags_AlphaBar); ImGui::CheckboxFlags("ImGuiColorEditFlags_NoSidePreview", &color_picker_flags, ImGuiColorEditFlags_NoSidePreview); if (color_picker_flags & ImGuiColorEditFlags_NoSidePreview) { ImGui::SameLine(); ImGui::Checkbox("With Ref Color", &ref_color); if (ref_color) { ImGui::SameLine(); ImGui::ColorEdit4("##RefColor", &ref_color_v.x, ImGuiColorEditFlags_NoInputs | base_flags); } } ImGui::Combo("Picker Mode", &picker_mode, "Auto/Current\0ImGuiColorEditFlags_PickerHueBar\0ImGuiColorEditFlags_PickerHueWheel\0"); ImGui::SameLine(); HelpMarker("When not specified explicitly, user can right-click the picker to change mode."); ImGui::Combo("Display Mode", &display_mode, "Auto/Current\0ImGuiColorEditFlags_NoInputs\0ImGuiColorEditFlags_DisplayRGB\0ImGuiColorEditFlags_DisplayHSV\0ImGuiColorEditFlags_DisplayHex\0"); ImGui::SameLine(); HelpMarker( "ColorEdit defaults to displaying RGB inputs if you don't specify a display mode, " "but the user can change it with a right-click on those inputs.\n\nColorPicker defaults to displaying RGB+HSV+Hex " "if you don't specify a display mode.\n\nYou can change the defaults using SetColorEditOptions()."); ImGuiColorEditFlags flags = base_flags | color_picker_flags; if (picker_mode == 1) flags |= ImGuiColorEditFlags_PickerHueBar; if (picker_mode == 2) flags |= ImGuiColorEditFlags_PickerHueWheel; if (display_mode == 1) flags |= ImGuiColorEditFlags_NoInputs; // Disable all RGB/HSV/Hex displays if (display_mode == 2) flags |= ImGuiColorEditFlags_DisplayRGB; // Override display mode if (display_mode == 3) flags |= ImGuiColorEditFlags_DisplayHSV; if (display_mode == 4) flags |= ImGuiColorEditFlags_DisplayHex; ImGui::ColorPicker4("MyColor##4", (float*)&color, flags, ref_color ? &ref_color_v.x : NULL); ImGui::Text("Set defaults in code:"); ImGui::SameLine(); HelpMarker( "SetColorEditOptions() is designed to allow you to set boot-time default.\n" "We don't have Push/Pop functions because you can force options on a per-widget basis if needed, " "and the user can change non-forced ones with the options menu.\nWe don't have a getter to avoid " "encouraging you to persistently save values that aren't forward-compatible."); if (ImGui::Button("Default: Uint8 + HSV + Hue Bar")) ImGui::SetColorEditOptions(ImGuiColorEditFlags_Uint8 | ImGuiColorEditFlags_DisplayHSV | ImGuiColorEditFlags_PickerHueBar); if (ImGui::Button("Default: Float + HDR + Hue Wheel")) ImGui::SetColorEditOptions(ImGuiColorEditFlags_Float | ImGuiColorEditFlags_HDR | ImGuiColorEditFlags_PickerHueWheel); // Always display a small version of both types of pickers // (that's in order to make it more visible in the demo to people who are skimming quickly through it) ImGui::Text("Both types:"); float w = (ImGui::GetContentRegionAvail().x - ImGui::GetStyle().ItemSpacing.y) * 0.40f; ImGui::SetNextItemWidth(w); ImGui::ColorPicker3("##MyColor##5", (float*)&color, ImGuiColorEditFlags_PickerHueBar | ImGuiColorEditFlags_NoSidePreview | ImGuiColorEditFlags_NoInputs | ImGuiColorEditFlags_NoAlpha); ImGui::SameLine(); ImGui::SetNextItemWidth(w); ImGui::ColorPicker3("##MyColor##6", (float*)&color, ImGuiColorEditFlags_PickerHueWheel | ImGuiColorEditFlags_NoSidePreview | ImGuiColorEditFlags_NoInputs | ImGuiColorEditFlags_NoAlpha); ImGui::PopID(); // HSV encoded support (to avoid RGB<>HSV round trips and singularities when S==0 or V==0) static ImVec4 color_hsv(0.23f, 1.0f, 1.0f, 1.0f); // Stored as HSV! ImGui::Spacing(); ImGui::Text("HSV encoded colors"); ImGui::SameLine(); HelpMarker( "By default, colors are given to ColorEdit and ColorPicker in RGB, but ImGuiColorEditFlags_InputHSV " "allows you to store colors as HSV and pass them to ColorEdit and ColorPicker as HSV. This comes with the " "added benefit that you can manipulate hue values with the picker even when saturation or value are zero."); ImGui::Text("Color widget with InputHSV:"); ImGui::ColorEdit4("HSV shown as RGB##1", (float*)&color_hsv, ImGuiColorEditFlags_DisplayRGB | ImGuiColorEditFlags_InputHSV | ImGuiColorEditFlags_Float); ImGui::ColorEdit4("HSV shown as HSV##1", (float*)&color_hsv, ImGuiColorEditFlags_DisplayHSV | ImGuiColorEditFlags_InputHSV | ImGuiColorEditFlags_Float); ImGui::DragFloat4("Raw HSV values", (float*)&color_hsv, 0.01f, 0.0f, 1.0f); ImGui::TreePop(); } } //----------------------------------------------------------------------------- // [SECTION] DemoWindowWidgetsComboBoxes() //----------------------------------------------------------------------------- static void DemoWindowWidgetsComboBoxes() { IMGUI_DEMO_MARKER("Widgets/Combo"); if (ImGui::TreeNode("Combo")) { // Combo Boxes are also called "Dropdown" in other systems // Expose flags as checkbox for the demo static ImGuiComboFlags flags = 0; ImGui::CheckboxFlags("ImGuiComboFlags_PopupAlignLeft", &flags, ImGuiComboFlags_PopupAlignLeft); ImGui::SameLine(); HelpMarker("Only makes a difference if the popup is larger than the combo"); if (ImGui::CheckboxFlags("ImGuiComboFlags_NoArrowButton", &flags, ImGuiComboFlags_NoArrowButton)) flags &= ~ImGuiComboFlags_NoPreview; // Clear incompatible flags if (ImGui::CheckboxFlags("ImGuiComboFlags_NoPreview", &flags, ImGuiComboFlags_NoPreview)) flags &= ~(ImGuiComboFlags_NoArrowButton | ImGuiComboFlags_WidthFitPreview); // Clear incompatible flags if (ImGui::CheckboxFlags("ImGuiComboFlags_WidthFitPreview", &flags, ImGuiComboFlags_WidthFitPreview)) flags &= ~ImGuiComboFlags_NoPreview; // Override default popup height if (ImGui::CheckboxFlags("ImGuiComboFlags_HeightSmall", &flags, ImGuiComboFlags_HeightSmall)) flags &= ~(ImGuiComboFlags_HeightMask_ & ~ImGuiComboFlags_HeightSmall); if (ImGui::CheckboxFlags("ImGuiComboFlags_HeightRegular", &flags, ImGuiComboFlags_HeightRegular)) flags &= ~(ImGuiComboFlags_HeightMask_ & ~ImGuiComboFlags_HeightRegular); if (ImGui::CheckboxFlags("ImGuiComboFlags_HeightLargest", &flags, ImGuiComboFlags_HeightLargest)) flags &= ~(ImGuiComboFlags_HeightMask_ & ~ImGuiComboFlags_HeightLargest); // Using the generic BeginCombo() API, you have full control over how to display the combo contents. // (your selection data could be an index, a pointer to the object, an id for the object, a flag intrusively // stored in the object itself, etc.) const char* items[] = { "AAAA", "BBBB", "CCCC", "DDDD", "EEEE", "FFFF", "GGGG", "HHHH", "IIII", "JJJJ", "KKKK", "LLLLLLL", "MMMM", "OOOOOOO" }; static int item_selected_idx = 0; // Here we store our selection data as an index. // Pass in the preview value visible before opening the combo (it could technically be different contents or not pulled from items[]) const char* combo_preview_value = items[item_selected_idx]; if (ImGui::BeginCombo("combo 1", combo_preview_value, flags)) { for (int n = 0; n < IM_ARRAYSIZE(items); n++) { const bool is_selected = (item_selected_idx == n); if (ImGui::Selectable(items[n], is_selected)) item_selected_idx = n; // Set the initial focus when opening the combo (scrolling + keyboard navigation focus) if (is_selected) ImGui::SetItemDefaultFocus(); } ImGui::EndCombo(); } // Show case embedding a filter using a simple trick: displaying the filter inside combo contents. // See https://github.com/ocornut/imgui/issues/718 for advanced/esoteric alternatives. if (ImGui::BeginCombo("combo 2 (w/ filter)", combo_preview_value, flags)) { static ImGuiTextFilter filter; if (ImGui::IsWindowAppearing()) { ImGui::SetKeyboardFocusHere(); filter.Clear(); } ImGui::SetNextItemShortcut(ImGuiMod_Ctrl | ImGuiKey_F); filter.Draw("##Filter", -FLT_MIN); for (int n = 0; n < IM_ARRAYSIZE(items); n++) { const bool is_selected = (item_selected_idx == n); if (filter.PassFilter(items[n])) if (ImGui::Selectable(items[n], is_selected)) item_selected_idx = n; } ImGui::EndCombo(); } ImGui::Spacing(); ImGui::SeparatorText("One-liner variants"); HelpMarker("The Combo() function is not greatly useful apart from cases were you want to embed all options in a single strings.\nFlags above don't apply to this section."); // Simplified one-liner Combo() API, using values packed in a single constant string // This is a convenience for when the selection set is small and known at compile-time. static int item_current_2 = 0; ImGui::Combo("combo 3 (one-liner)", &item_current_2, "aaaa\0bbbb\0cccc\0dddd\0eeee\0\0"); // Simplified one-liner Combo() using an array of const char* // This is not very useful (may obsolete): prefer using BeginCombo()/EndCombo() for full control. static int item_current_3 = -1; // If the selection isn't within 0..count, Combo won't display a preview ImGui::Combo("combo 4 (array)", &item_current_3, items, IM_ARRAYSIZE(items)); // Simplified one-liner Combo() using an accessor function static int item_current_4 = 0; ImGui::Combo("combo 5 (function)", &item_current_4, [](void* data, int n) { return ((const char**)data)[n]; }, items, IM_ARRAYSIZE(items)); ImGui::TreePop(); } } //----------------------------------------------------------------------------- // [SECTION] DemoWindowWidgetsDataTypes() //----------------------------------------------------------------------------- static void DemoWindowWidgetsDataTypes() { IMGUI_DEMO_MARKER("Widgets/Data Types"); if (ImGui::TreeNode("Data Types")) { // DragScalar/InputScalar/SliderScalar functions allow various data types // - signed/unsigned // - 8/16/32/64-bits // - integer/float/double // To avoid polluting the public API with all possible combinations, we use the ImGuiDataType enum // to pass the type, and passing all arguments by pointer. // This is the reason the test code below creates local variables to hold "zero" "one" etc. for each type. // In practice, if you frequently use a given type that is not covered by the normal API entry points, // you can wrap it yourself inside a 1 line function which can take typed argument as value instead of void*, // and then pass their address to the generic function. For example: // bool MySliderU64(const char *label, u64* value, u64 min = 0, u64 max = 0, const char* format = "%lld") // { // return SliderScalar(label, ImGuiDataType_U64, value, &min, &max, format); // } // Setup limits (as helper variables so we can take their address, as explained above) // Note: SliderScalar() functions have a maximum usable range of half the natural type maximum, hence the /2. #ifndef LLONG_MIN ImS64 LLONG_MIN = -9223372036854775807LL - 1; ImS64 LLONG_MAX = 9223372036854775807LL; ImU64 ULLONG_MAX = (2ULL * 9223372036854775807LL + 1); #endif const char s8_zero = 0, s8_one = 1, s8_fifty = 50, s8_min = -128, s8_max = 127; const ImU8 u8_zero = 0, u8_one = 1, u8_fifty = 50, u8_min = 0, u8_max = 255; const short s16_zero = 0, s16_one = 1, s16_fifty = 50, s16_min = -32768, s16_max = 32767; const ImU16 u16_zero = 0, u16_one = 1, u16_fifty = 50, u16_min = 0, u16_max = 65535; const ImS32 s32_zero = 0, s32_one = 1, s32_fifty = 50, s32_min = INT_MIN/2, s32_max = INT_MAX/2, s32_hi_a = INT_MAX/2 - 100, s32_hi_b = INT_MAX/2; const ImU32 u32_zero = 0, u32_one = 1, u32_fifty = 50, u32_min = 0, u32_max = UINT_MAX/2, u32_hi_a = UINT_MAX/2 - 100, u32_hi_b = UINT_MAX/2; const ImS64 s64_zero = 0, s64_one = 1, s64_fifty = 50, s64_min = LLONG_MIN/2, s64_max = LLONG_MAX/2, s64_hi_a = LLONG_MAX/2 - 100, s64_hi_b = LLONG_MAX/2; const ImU64 u64_zero = 0, u64_one = 1, u64_fifty = 50, u64_min = 0, u64_max = ULLONG_MAX/2, u64_hi_a = ULLONG_MAX/2 - 100, u64_hi_b = ULLONG_MAX/2; const float f32_zero = 0.f, f32_one = 1.f, f32_lo_a = -10000000000.0f, f32_hi_a = +10000000000.0f; const double f64_zero = 0., f64_one = 1., f64_lo_a = -1000000000000000.0, f64_hi_a = +1000000000000000.0; // State static char s8_v = 127; static ImU8 u8_v = 255; static short s16_v = 32767; static ImU16 u16_v = 65535; static ImS32 s32_v = -1; static ImU32 u32_v = (ImU32)-1; static ImS64 s64_v = -1; static ImU64 u64_v = (ImU64)-1; static float f32_v = 0.123f; static double f64_v = 90000.01234567890123456789; const float drag_speed = 0.2f; static bool drag_clamp = false; IMGUI_DEMO_MARKER("Widgets/Data Types/Drags"); ImGui::SeparatorText("Drags"); ImGui::Checkbox("Clamp integers to 0..50", &drag_clamp); ImGui::SameLine(); HelpMarker( "As with every widget in dear imgui, we never modify values unless there is a user interaction.\n" "You can override the clamping limits by using CTRL+Click to input a value."); ImGui::DragScalar("drag s8", ImGuiDataType_S8, &s8_v, drag_speed, drag_clamp ? &s8_zero : NULL, drag_clamp ? &s8_fifty : NULL); ImGui::DragScalar("drag u8", ImGuiDataType_U8, &u8_v, drag_speed, drag_clamp ? &u8_zero : NULL, drag_clamp ? &u8_fifty : NULL, "%u ms"); ImGui::DragScalar("drag s16", ImGuiDataType_S16, &s16_v, drag_speed, drag_clamp ? &s16_zero : NULL, drag_clamp ? &s16_fifty : NULL); ImGui::DragScalar("drag u16", ImGuiDataType_U16, &u16_v, drag_speed, drag_clamp ? &u16_zero : NULL, drag_clamp ? &u16_fifty : NULL, "%u ms"); ImGui::DragScalar("drag s32", ImGuiDataType_S32, &s32_v, drag_speed, drag_clamp ? &s32_zero : NULL, drag_clamp ? &s32_fifty : NULL); ImGui::DragScalar("drag s32 hex", ImGuiDataType_S32, &s32_v, drag_speed, drag_clamp ? &s32_zero : NULL, drag_clamp ? &s32_fifty : NULL, "0x%08X"); ImGui::DragScalar("drag u32", ImGuiDataType_U32, &u32_v, drag_speed, drag_clamp ? &u32_zero : NULL, drag_clamp ? &u32_fifty : NULL, "%u ms"); ImGui::DragScalar("drag s64", ImGuiDataType_S64, &s64_v, drag_speed, drag_clamp ? &s64_zero : NULL, drag_clamp ? &s64_fifty : NULL); ImGui::DragScalar("drag u64", ImGuiDataType_U64, &u64_v, drag_speed, drag_clamp ? &u64_zero : NULL, drag_clamp ? &u64_fifty : NULL); ImGui::DragScalar("drag float", ImGuiDataType_Float, &f32_v, 0.005f, &f32_zero, &f32_one, "%f"); ImGui::DragScalar("drag float log", ImGuiDataType_Float, &f32_v, 0.005f, &f32_zero, &f32_one, "%f", ImGuiSliderFlags_Logarithmic); ImGui::DragScalar("drag double", ImGuiDataType_Double, &f64_v, 0.0005f, &f64_zero, NULL, "%.10f grams"); ImGui::DragScalar("drag double log",ImGuiDataType_Double, &f64_v, 0.0005f, &f64_zero, &f64_one, "0 < %.10f < 1", ImGuiSliderFlags_Logarithmic); IMGUI_DEMO_MARKER("Widgets/Data Types/Sliders"); ImGui::SeparatorText("Sliders"); ImGui::SliderScalar("slider s8 full", ImGuiDataType_S8, &s8_v, &s8_min, &s8_max, "%d"); ImGui::SliderScalar("slider u8 full", ImGuiDataType_U8, &u8_v, &u8_min, &u8_max, "%u"); ImGui::SliderScalar("slider s16 full", ImGuiDataType_S16, &s16_v, &s16_min, &s16_max, "%d"); ImGui::SliderScalar("slider u16 full", ImGuiDataType_U16, &u16_v, &u16_min, &u16_max, "%u"); ImGui::SliderScalar("slider s32 low", ImGuiDataType_S32, &s32_v, &s32_zero, &s32_fifty,"%d"); ImGui::SliderScalar("slider s32 high", ImGuiDataType_S32, &s32_v, &s32_hi_a, &s32_hi_b, "%d"); ImGui::SliderScalar("slider s32 full", ImGuiDataType_S32, &s32_v, &s32_min, &s32_max, "%d"); ImGui::SliderScalar("slider s32 hex", ImGuiDataType_S32, &s32_v, &s32_zero, &s32_fifty, "0x%04X"); ImGui::SliderScalar("slider u32 low", ImGuiDataType_U32, &u32_v, &u32_zero, &u32_fifty,"%u"); ImGui::SliderScalar("slider u32 high", ImGuiDataType_U32, &u32_v, &u32_hi_a, &u32_hi_b, "%u"); ImGui::SliderScalar("slider u32 full", ImGuiDataType_U32, &u32_v, &u32_min, &u32_max, "%u"); ImGui::SliderScalar("slider s64 low", ImGuiDataType_S64, &s64_v, &s64_zero, &s64_fifty,"%" PRId64); ImGui::SliderScalar("slider s64 high", ImGuiDataType_S64, &s64_v, &s64_hi_a, &s64_hi_b, "%" PRId64); ImGui::SliderScalar("slider s64 full", ImGuiDataType_S64, &s64_v, &s64_min, &s64_max, "%" PRId64); ImGui::SliderScalar("slider u64 low", ImGuiDataType_U64, &u64_v, &u64_zero, &u64_fifty,"%" PRIu64 " ms"); ImGui::SliderScalar("slider u64 high", ImGuiDataType_U64, &u64_v, &u64_hi_a, &u64_hi_b, "%" PRIu64 " ms"); ImGui::SliderScalar("slider u64 full", ImGuiDataType_U64, &u64_v, &u64_min, &u64_max, "%" PRIu64 " ms"); ImGui::SliderScalar("slider float low", ImGuiDataType_Float, &f32_v, &f32_zero, &f32_one); ImGui::SliderScalar("slider float low log", ImGuiDataType_Float, &f32_v, &f32_zero, &f32_one, "%.10f", ImGuiSliderFlags_Logarithmic); ImGui::SliderScalar("slider float high", ImGuiDataType_Float, &f32_v, &f32_lo_a, &f32_hi_a, "%e"); ImGui::SliderScalar("slider double low", ImGuiDataType_Double, &f64_v, &f64_zero, &f64_one, "%.10f grams"); ImGui::SliderScalar("slider double low log",ImGuiDataType_Double, &f64_v, &f64_zero, &f64_one, "%.10f", ImGuiSliderFlags_Logarithmic); ImGui::SliderScalar("slider double high", ImGuiDataType_Double, &f64_v, &f64_lo_a, &f64_hi_a, "%e grams"); ImGui::SeparatorText("Sliders (reverse)"); ImGui::SliderScalar("slider s8 reverse", ImGuiDataType_S8, &s8_v, &s8_max, &s8_min, "%d"); ImGui::SliderScalar("slider u8 reverse", ImGuiDataType_U8, &u8_v, &u8_max, &u8_min, "%u"); ImGui::SliderScalar("slider s32 reverse", ImGuiDataType_S32, &s32_v, &s32_fifty, &s32_zero, "%d"); ImGui::SliderScalar("slider u32 reverse", ImGuiDataType_U32, &u32_v, &u32_fifty, &u32_zero, "%u"); ImGui::SliderScalar("slider s64 reverse", ImGuiDataType_S64, &s64_v, &s64_fifty, &s64_zero, "%" PRId64); ImGui::SliderScalar("slider u64 reverse", ImGuiDataType_U64, &u64_v, &u64_fifty, &u64_zero, "%" PRIu64 " ms"); IMGUI_DEMO_MARKER("Widgets/Data Types/Inputs"); static bool inputs_step = true; static ImGuiInputTextFlags flags = ImGuiInputTextFlags_None; ImGui::SeparatorText("Inputs"); ImGui::Checkbox("Show step buttons", &inputs_step); ImGui::CheckboxFlags("ImGuiInputTextFlags_ReadOnly", &flags, ImGuiInputTextFlags_ReadOnly); ImGui::CheckboxFlags("ImGuiInputTextFlags_ParseEmptyRefVal", &flags, ImGuiInputTextFlags_ParseEmptyRefVal); ImGui::CheckboxFlags("ImGuiInputTextFlags_DisplayEmptyRefVal", &flags, ImGuiInputTextFlags_DisplayEmptyRefVal); ImGui::InputScalar("input s8", ImGuiDataType_S8, &s8_v, inputs_step ? &s8_one : NULL, NULL, "%d", flags); ImGui::InputScalar("input u8", ImGuiDataType_U8, &u8_v, inputs_step ? &u8_one : NULL, NULL, "%u", flags); ImGui::InputScalar("input s16", ImGuiDataType_S16, &s16_v, inputs_step ? &s16_one : NULL, NULL, "%d", flags); ImGui::InputScalar("input u16", ImGuiDataType_U16, &u16_v, inputs_step ? &u16_one : NULL, NULL, "%u", flags); ImGui::InputScalar("input s32", ImGuiDataType_S32, &s32_v, inputs_step ? &s32_one : NULL, NULL, "%d", flags); ImGui::InputScalar("input s32 hex", ImGuiDataType_S32, &s32_v, inputs_step ? &s32_one : NULL, NULL, "%04X", flags); ImGui::InputScalar("input u32", ImGuiDataType_U32, &u32_v, inputs_step ? &u32_one : NULL, NULL, "%u", flags); ImGui::InputScalar("input u32 hex", ImGuiDataType_U32, &u32_v, inputs_step ? &u32_one : NULL, NULL, "%08X", flags); ImGui::InputScalar("input s64", ImGuiDataType_S64, &s64_v, inputs_step ? &s64_one : NULL, NULL, NULL, flags); ImGui::InputScalar("input u64", ImGuiDataType_U64, &u64_v, inputs_step ? &u64_one : NULL, NULL, NULL, flags); ImGui::InputScalar("input float", ImGuiDataType_Float, &f32_v, inputs_step ? &f32_one : NULL, NULL, NULL, flags); ImGui::InputScalar("input double", ImGuiDataType_Double, &f64_v, inputs_step ? &f64_one : NULL, NULL, NULL, flags); ImGui::TreePop(); } } //----------------------------------------------------------------------------- // [SECTION] DemoWindowWidgetsDisableBlocks() //----------------------------------------------------------------------------- static void DemoWindowWidgetsDisableBlocks(ImGuiDemoWindowData* demo_data) { IMGUI_DEMO_MARKER("Widgets/Disable Blocks"); if (ImGui::TreeNode("Disable Blocks")) { ImGui::Checkbox("Disable entire section above", &demo_data->DisableSections); ImGui::SameLine(); HelpMarker("Demonstrate using BeginDisabled()/EndDisabled() across other sections."); ImGui::TreePop(); } } //----------------------------------------------------------------------------- // [SECTION] DemoWindowWidgetsDragAndDrop() //----------------------------------------------------------------------------- static void DemoWindowWidgetsDragAndDrop() { IMGUI_DEMO_MARKER("Widgets/Drag and drop"); if (ImGui::TreeNode("Drag and Drop")) { IMGUI_DEMO_MARKER("Widgets/Drag and drop/Standard widgets"); if (ImGui::TreeNode("Drag and drop in standard widgets")) { // ColorEdit widgets automatically act as drag source and drag target. // They are using standardized payload strings IMGUI_PAYLOAD_TYPE_COLOR_3F and IMGUI_PAYLOAD_TYPE_COLOR_4F // to allow your own widgets to use colors in their drag and drop interaction. // Also see 'Demo->Widgets->Color/Picker Widgets->Palette' demo. HelpMarker("You can drag from the color squares."); static float col1[3] = { 1.0f, 0.0f, 0.2f }; static float col2[4] = { 0.4f, 0.7f, 0.0f, 0.5f }; ImGui::ColorEdit3("color 1", col1); ImGui::ColorEdit4("color 2", col2); ImGui::TreePop(); } IMGUI_DEMO_MARKER("Widgets/Drag and drop/Copy-swap items"); if (ImGui::TreeNode("Drag and drop to copy/swap items")) { enum Mode { Mode_Copy, Mode_Move, Mode_Swap }; static int mode = 0; if (ImGui::RadioButton("Copy", mode == Mode_Copy)) { mode = Mode_Copy; } ImGui::SameLine(); if (ImGui::RadioButton("Move", mode == Mode_Move)) { mode = Mode_Move; } ImGui::SameLine(); if (ImGui::RadioButton("Swap", mode == Mode_Swap)) { mode = Mode_Swap; } static const char* names[9] = { "Bobby", "Beatrice", "Betty", "Brianna", "Barry", "Bernard", "Bibi", "Blaine", "Bryn" }; for (int n = 0; n < IM_ARRAYSIZE(names); n++) { ImGui::PushID(n); if ((n % 3) != 0) ImGui::SameLine(); ImGui::Button(names[n], ImVec2(60, 60)); // Our buttons are both drag sources and drag targets here! if (ImGui::BeginDragDropSource(ImGuiDragDropFlags_None)) { // Set payload to carry the index of our item (could be anything) ImGui::SetDragDropPayload("DND_DEMO_CELL", &n, sizeof(int)); // Display preview (could be anything, e.g. when dragging an image we could decide to display // the filename and a small preview of the image, etc.) if (mode == Mode_Copy) { ImGui::Text("Copy %s", names[n]); } if (mode == Mode_Move) { ImGui::Text("Move %s", names[n]); } if (mode == Mode_Swap) { ImGui::Text("Swap %s", names[n]); } ImGui::EndDragDropSource(); } if (ImGui::BeginDragDropTarget()) { if (const ImGuiPayload* payload = ImGui::AcceptDragDropPayload("DND_DEMO_CELL")) { IM_ASSERT(payload->DataSize == sizeof(int)); int payload_n = *(const int*)payload->Data; if (mode == Mode_Copy) { names[n] = names[payload_n]; } if (mode == Mode_Move) { names[n] = names[payload_n]; names[payload_n] = ""; } if (mode == Mode_Swap) { const char* tmp = names[n]; names[n] = names[payload_n]; names[payload_n] = tmp; } } ImGui::EndDragDropTarget(); } ImGui::PopID(); } ImGui::TreePop(); } IMGUI_DEMO_MARKER("Widgets/Drag and Drop/Drag to reorder items (simple)"); if (ImGui::TreeNode("Drag to reorder items (simple)")) { // FIXME: there is temporary (usually single-frame) ID Conflict during reordering as a same item may be submitting twice. // This code was always slightly faulty but in a way which was not easily noticeable. // Until we fix this, enable ImGuiItemFlags_AllowDuplicateId to disable detecting the issue. ImGui::PushItemFlag(ImGuiItemFlags_AllowDuplicateId, true); // Simple reordering HelpMarker( "We don't use the drag and drop api at all here! " "Instead we query when the item is held but not hovered, and order items accordingly."); static const char* item_names[] = { "Item One", "Item Two", "Item Three", "Item Four", "Item Five" }; for (int n = 0; n < IM_ARRAYSIZE(item_names); n++) { const char* item = item_names[n]; ImGui::Selectable(item); if (ImGui::IsItemActive() && !ImGui::IsItemHovered()) { int n_next = n + (ImGui::GetMouseDragDelta(0).y < 0.f ? -1 : 1); if (n_next >= 0 && n_next < IM_ARRAYSIZE(item_names)) { item_names[n] = item_names[n_next]; item_names[n_next] = item; ImGui::ResetMouseDragDelta(); } } } ImGui::PopItemFlag(); ImGui::TreePop(); } IMGUI_DEMO_MARKER("Widgets/Drag and Drop/Tooltip at target location"); if (ImGui::TreeNode("Tooltip at target location")) { for (int n = 0; n < 2; n++) { // Drop targets ImGui::Button(n ? "drop here##1" : "drop here##0"); if (ImGui::BeginDragDropTarget()) { ImGuiDragDropFlags drop_target_flags = ImGuiDragDropFlags_AcceptBeforeDelivery | ImGuiDragDropFlags_AcceptNoPreviewTooltip; if (const ImGuiPayload* payload = ImGui::AcceptDragDropPayload(IMGUI_PAYLOAD_TYPE_COLOR_4F, drop_target_flags)) { IM_UNUSED(payload); ImGui::SetMouseCursor(ImGuiMouseCursor_NotAllowed); ImGui::SetTooltip("Cannot drop here!"); } ImGui::EndDragDropTarget(); } // Drop source static ImVec4 col4 = { 1.0f, 0.0f, 0.2f, 1.0f }; if (n == 0) ImGui::ColorButton("drag me", col4); } ImGui::TreePop(); } ImGui::TreePop(); } } //----------------------------------------------------------------------------- // [SECTION] DemoWindowWidgetsDragsAndSliders() //----------------------------------------------------------------------------- static void DemoWindowWidgetsDragsAndSliders() { IMGUI_DEMO_MARKER("Widgets/Drag and Slider Flags"); if (ImGui::TreeNode("Drag/Slider Flags")) { // Demonstrate using advanced flags for DragXXX and SliderXXX functions. Note that the flags are the same! static ImGuiSliderFlags flags = ImGuiSliderFlags_None; ImGui::CheckboxFlags("ImGuiSliderFlags_AlwaysClamp", &flags, ImGuiSliderFlags_AlwaysClamp); ImGui::CheckboxFlags("ImGuiSliderFlags_ClampOnInput", &flags, ImGuiSliderFlags_ClampOnInput); ImGui::SameLine(); HelpMarker("Clamp value to min/max bounds when input manually with CTRL+Click. By default CTRL+Click allows going out of bounds."); ImGui::CheckboxFlags("ImGuiSliderFlags_ClampZeroRange", &flags, ImGuiSliderFlags_ClampZeroRange); ImGui::SameLine(); HelpMarker("Clamp even if min==max==0.0f. Otherwise DragXXX functions don't clamp."); ImGui::CheckboxFlags("ImGuiSliderFlags_Logarithmic", &flags, ImGuiSliderFlags_Logarithmic); ImGui::SameLine(); HelpMarker("Enable logarithmic editing (more precision for small values)."); ImGui::CheckboxFlags("ImGuiSliderFlags_NoRoundToFormat", &flags, ImGuiSliderFlags_NoRoundToFormat); ImGui::SameLine(); HelpMarker("Disable rounding underlying value to match precision of the format string (e.g. %.3f values are rounded to those 3 digits)."); ImGui::CheckboxFlags("ImGuiSliderFlags_NoInput", &flags, ImGuiSliderFlags_NoInput); ImGui::SameLine(); HelpMarker("Disable CTRL+Click or Enter key allowing to input text directly into the widget."); ImGui::CheckboxFlags("ImGuiSliderFlags_NoSpeedTweaks", &flags, ImGuiSliderFlags_NoSpeedTweaks); ImGui::SameLine(); HelpMarker("Disable keyboard modifiers altering tweak speed. Useful if you want to alter tweak speed yourself based on your own logic."); ImGui::CheckboxFlags("ImGuiSliderFlags_WrapAround", &flags, ImGuiSliderFlags_WrapAround); ImGui::SameLine(); HelpMarker("Enable wrapping around from max to min and from min to max (only supported by DragXXX() functions)"); // Drags static float drag_f = 0.5f; static int drag_i = 50; ImGui::Text("Underlying float value: %f", drag_f); ImGui::DragFloat("DragFloat (0 -> 1)", &drag_f, 0.005f, 0.0f, 1.0f, "%.3f", flags); ImGui::DragFloat("DragFloat (0 -> +inf)", &drag_f, 0.005f, 0.0f, FLT_MAX, "%.3f", flags); ImGui::DragFloat("DragFloat (-inf -> 1)", &drag_f, 0.005f, -FLT_MAX, 1.0f, "%.3f", flags); ImGui::DragFloat("DragFloat (-inf -> +inf)", &drag_f, 0.005f, -FLT_MAX, +FLT_MAX, "%.3f", flags); //ImGui::DragFloat("DragFloat (0 -> 0)", &drag_f, 0.005f, 0.0f, 0.0f, "%.3f", flags); // To test ClampZeroRange //ImGui::DragFloat("DragFloat (100 -> 100)", &drag_f, 0.005f, 100.0f, 100.0f, "%.3f", flags); ImGui::DragInt("DragInt (0 -> 100)", &drag_i, 0.5f, 0, 100, "%d", flags); // Sliders static float slider_f = 0.5f; static int slider_i = 50; const ImGuiSliderFlags flags_for_sliders = flags & ~ImGuiSliderFlags_WrapAround; ImGui::Text("Underlying float value: %f", slider_f); ImGui::SliderFloat("SliderFloat (0 -> 1)", &slider_f, 0.0f, 1.0f, "%.3f", flags_for_sliders); ImGui::SliderInt("SliderInt (0 -> 100)", &slider_i, 0, 100, "%d", flags_for_sliders); ImGui::TreePop(); } } //----------------------------------------------------------------------------- // [SECTION] DemoWindowWidgetsImages() //----------------------------------------------------------------------------- static void DemoWindowWidgetsImages() { IMGUI_DEMO_MARKER("Widgets/Images"); if (ImGui::TreeNode("Images")) { ImGuiIO& io = ImGui::GetIO(); ImGui::TextWrapped( "Below we are displaying the font texture (which is the only texture we have access to in this demo). " "Use the 'ImTextureID' type as storage to pass pointers or identifier to your own texture data. " "Hover the texture for a zoomed view!"); // Below we are displaying the font texture because it is the only texture we have access to inside the demo! // Remember that ImTextureID is just storage for whatever you want it to be. It is essentially a value that // will be passed to the rendering backend via the ImDrawCmd structure. // If you use one of the default imgui_impl_XXXX.cpp rendering backend, they all have comments at the top // of their respective source file to specify what they expect to be stored in ImTextureID, for example: // - The imgui_impl_dx11.cpp renderer expect a 'ID3D11ShaderResourceView*' pointer // - The imgui_impl_opengl3.cpp renderer expect a GLuint OpenGL texture identifier, etc. // More: // - If you decided that ImTextureID = MyEngineTexture*, then you can pass your MyEngineTexture* pointers // to ImGui::Image(), and gather width/height through your own functions, etc. // - You can use ShowMetricsWindow() to inspect the draw data that are being passed to your renderer, // it will help you debug issues if you are confused about it. // - Consider using the lower-level ImDrawList::AddImage() API, via ImGui::GetWindowDrawList()->AddImage(). // - Read https://github.com/ocornut/imgui/blob/master/docs/FAQ.md // - Read https://github.com/ocornut/imgui/wiki/Image-Loading-and-Displaying-Examples ImTextureID my_tex_id = io.Fonts->TexID; float my_tex_w = (float)io.Fonts->TexWidth; float my_tex_h = (float)io.Fonts->TexHeight; { ImGui::Text("%.0fx%.0f", my_tex_w, my_tex_h); ImVec2 pos = ImGui::GetCursorScreenPos(); ImVec2 uv_min = ImVec2(0.0f, 0.0f); // Top-left ImVec2 uv_max = ImVec2(1.0f, 1.0f); // Lower-right ImGui::PushStyleVar(ImGuiStyleVar_ImageBorderSize, IM_MAX(1.0f, ImGui::GetStyle().ImageBorderSize)); ImGui::ImageWithBg(my_tex_id, ImVec2(my_tex_w, my_tex_h), uv_min, uv_max, ImVec4(0.0f, 0.0f, 0.0f, 1.0f)); if (ImGui::BeginItemTooltip()) { float region_sz = 32.0f; float region_x = io.MousePos.x - pos.x - region_sz * 0.5f; float region_y = io.MousePos.y - pos.y - region_sz * 0.5f; float zoom = 4.0f; if (region_x < 0.0f) { region_x = 0.0f; } else if (region_x > my_tex_w - region_sz) { region_x = my_tex_w - region_sz; } if (region_y < 0.0f) { region_y = 0.0f; } else if (region_y > my_tex_h - region_sz) { region_y = my_tex_h - region_sz; } ImGui::Text("Min: (%.2f, %.2f)", region_x, region_y); ImGui::Text("Max: (%.2f, %.2f)", region_x + region_sz, region_y + region_sz); ImVec2 uv0 = ImVec2((region_x) / my_tex_w, (region_y) / my_tex_h); ImVec2 uv1 = ImVec2((region_x + region_sz) / my_tex_w, (region_y + region_sz) / my_tex_h); ImGui::ImageWithBg(my_tex_id, ImVec2(region_sz * zoom, region_sz * zoom), uv0, uv1, ImVec4(0.0f, 0.0f, 0.0f, 1.0f)); ImGui::EndTooltip(); } ImGui::PopStyleVar(); } IMGUI_DEMO_MARKER("Widgets/Images/Textured buttons"); ImGui::TextWrapped("And now some textured buttons.."); static int pressed_count = 0; for (int i = 0; i < 8; i++) { // UV coordinates are often (0.0f, 0.0f) and (1.0f, 1.0f) to display an entire textures. // Here are trying to display only a 32x32 pixels area of the texture, hence the UV computation. // Read about UV coordinates here: https://github.com/ocornut/imgui/wiki/Image-Loading-and-Displaying-Examples ImGui::PushID(i); if (i > 0) ImGui::PushStyleVar(ImGuiStyleVar_FramePadding, ImVec2(i - 1.0f, i - 1.0f)); ImVec2 size = ImVec2(32.0f, 32.0f); // Size of the image we want to make visible ImVec2 uv0 = ImVec2(0.0f, 0.0f); // UV coordinates for lower-left ImVec2 uv1 = ImVec2(32.0f / my_tex_w, 32.0f / my_tex_h); // UV coordinates for (32,32) in our texture ImVec4 bg_col = ImVec4(0.0f, 0.0f, 0.0f, 1.0f); // Black background ImVec4 tint_col = ImVec4(1.0f, 1.0f, 1.0f, 1.0f); // No tint if (ImGui::ImageButton("", my_tex_id, size, uv0, uv1, bg_col, tint_col)) pressed_count += 1; if (i > 0) ImGui::PopStyleVar(); ImGui::PopID(); ImGui::SameLine(); } ImGui::NewLine(); ImGui::Text("Pressed %d times.", pressed_count); ImGui::TreePop(); } } //----------------------------------------------------------------------------- // [SECTION] DemoWindowWidgetsListBoxes() //----------------------------------------------------------------------------- static void DemoWindowWidgetsListBoxes() { IMGUI_DEMO_MARKER("Widgets/List Boxes"); if (ImGui::TreeNode("List Boxes")) { // BeginListBox() is essentially a thin wrapper to using BeginChild()/EndChild() // using the ImGuiChildFlags_FrameStyle flag for stylistic changes + displaying a label. // You may be tempted to simply use BeginChild() directly. However note that BeginChild() requires EndChild() // to always be called (inconsistent with BeginListBox()/EndListBox()). // Using the generic BeginListBox() API, you have full control over how to display the combo contents. // (your selection data could be an index, a pointer to the object, an id for the object, a flag intrusively // stored in the object itself, etc.) const char* items[] = { "AAAA", "BBBB", "CCCC", "DDDD", "EEEE", "FFFF", "GGGG", "HHHH", "IIII", "JJJJ", "KKKK", "LLLLLLL", "MMMM", "OOOOOOO" }; static int item_selected_idx = 0; // Here we store our selected data as an index. static bool item_highlight = false; int item_highlighted_idx = -1; // Here we store our highlighted data as an index. ImGui::Checkbox("Highlight hovered item in second listbox", &item_highlight); if (ImGui::BeginListBox("listbox 1")) { for (int n = 0; n < IM_ARRAYSIZE(items); n++) { const bool is_selected = (item_selected_idx == n); if (ImGui::Selectable(items[n], is_selected)) item_selected_idx = n; if (item_highlight && ImGui::IsItemHovered()) item_highlighted_idx = n; // Set the initial focus when opening the combo (scrolling + keyboard navigation focus) if (is_selected) ImGui::SetItemDefaultFocus(); } ImGui::EndListBox(); } ImGui::SameLine(); HelpMarker("Here we are sharing selection state between both boxes."); // Custom size: use all width, 5 items tall ImGui::Text("Full-width:"); if (ImGui::BeginListBox("##listbox 2", ImVec2(-FLT_MIN, 5 * ImGui::GetTextLineHeightWithSpacing()))) { for (int n = 0; n < IM_ARRAYSIZE(items); n++) { bool is_selected = (item_selected_idx == n); ImGuiSelectableFlags flags = (item_highlighted_idx == n) ? ImGuiSelectableFlags_Highlight : 0; if (ImGui::Selectable(items[n], is_selected, flags)) item_selected_idx = n; // Set the initial focus when opening the combo (scrolling + keyboard navigation focus) if (is_selected) ImGui::SetItemDefaultFocus(); } ImGui::EndListBox(); } ImGui::TreePop(); } } //----------------------------------------------------------------------------- // [SECTION] DemoWindowWidgetsMultiComponents() //----------------------------------------------------------------------------- static void DemoWindowWidgetsMultiComponents() { IMGUI_DEMO_MARKER("Widgets/Multi-component Widgets"); if (ImGui::TreeNode("Multi-component Widgets")) { static float vec4f[4] = { 0.10f, 0.20f, 0.30f, 0.44f }; static int vec4i[4] = { 1, 5, 100, 255 }; ImGui::SeparatorText("2-wide"); ImGui::InputFloat2("input float2", vec4f); ImGui::DragFloat2("drag float2", vec4f, 0.01f, 0.0f, 1.0f); ImGui::SliderFloat2("slider float2", vec4f, 0.0f, 1.0f); ImGui::InputInt2("input int2", vec4i); ImGui::DragInt2("drag int2", vec4i, 1, 0, 255); ImGui::SliderInt2("slider int2", vec4i, 0, 255); ImGui::SeparatorText("3-wide"); ImGui::InputFloat3("input float3", vec4f); ImGui::DragFloat3("drag float3", vec4f, 0.01f, 0.0f, 1.0f); ImGui::SliderFloat3("slider float3", vec4f, 0.0f, 1.0f); ImGui::InputInt3("input int3", vec4i); ImGui::DragInt3("drag int3", vec4i, 1, 0, 255); ImGui::SliderInt3("slider int3", vec4i, 0, 255); ImGui::SeparatorText("4-wide"); ImGui::InputFloat4("input float4", vec4f); ImGui::DragFloat4("drag float4", vec4f, 0.01f, 0.0f, 1.0f); ImGui::SliderFloat4("slider float4", vec4f, 0.0f, 1.0f); ImGui::InputInt4("input int4", vec4i); ImGui::DragInt4("drag int4", vec4i, 1, 0, 255); ImGui::SliderInt4("slider int4", vec4i, 0, 255); ImGui::SeparatorText("Ranges"); static float begin = 10, end = 90; static int begin_i = 100, end_i = 1000; ImGui::DragFloatRange2("range float", &begin, &end, 0.25f, 0.0f, 100.0f, "Min: %.1f %%", "Max: %.1f %%", ImGuiSliderFlags_AlwaysClamp); ImGui::DragIntRange2("range int", &begin_i, &end_i, 5, 0, 1000, "Min: %d units", "Max: %d units"); ImGui::DragIntRange2("range int (no bounds)", &begin_i, &end_i, 5, 0, 0, "Min: %d units", "Max: %d units"); ImGui::TreePop(); } } //----------------------------------------------------------------------------- // [SECTION] DemoWindowWidgetsPlotting() //----------------------------------------------------------------------------- static void DemoWindowWidgetsPlotting() { // Plot/Graph widgets are not very good. // Consider using a third-party library such as ImPlot: https://github.com/epezent/implot // (see others https://github.com/ocornut/imgui/wiki/Useful-Extensions) IMGUI_DEMO_MARKER("Widgets/Plotting"); if (ImGui::TreeNode("Plotting")) { ImGui::Text("Need better plotting and graphing? Consider using ImPlot:"); ImGui::TextLinkOpenURL("https://github.com/epezent/implot"); ImGui::Separator(); static bool animate = true; ImGui::Checkbox("Animate", &animate); // Plot as lines and plot as histogram static float arr[] = { 0.6f, 0.1f, 1.0f, 0.5f, 0.92f, 0.1f, 0.2f }; ImGui::PlotLines("Frame Times", arr, IM_ARRAYSIZE(arr)); ImGui::PlotHistogram("Histogram", arr, IM_ARRAYSIZE(arr), 0, NULL, 0.0f, 1.0f, ImVec2(0, 80.0f)); //ImGui::SameLine(); HelpMarker("Consider using ImPlot instead!"); // Fill an array of contiguous float values to plot // Tip: If your float aren't contiguous but part of a structure, you can pass a pointer to your first float // and the sizeof() of your structure in the "stride" parameter. static float values[90] = {}; static int values_offset = 0; static double refresh_time = 0.0; if (!animate || refresh_time == 0.0) refresh_time = ImGui::GetTime(); while (refresh_time < ImGui::GetTime()) // Create data at fixed 60 Hz rate for the demo { static float phase = 0.0f; values[values_offset] = cosf(phase); values_offset = (values_offset + 1) % IM_ARRAYSIZE(values); phase += 0.10f * values_offset; refresh_time += 1.0f / 60.0f; } // Plots can display overlay texts // (in this example, we will display an average value) { float average = 0.0f; for (int n = 0; n < IM_ARRAYSIZE(values); n++) average += values[n]; average /= (float)IM_ARRAYSIZE(values); char overlay[32]; sprintf(overlay, "avg %f", average); ImGui::PlotLines("Lines", values, IM_ARRAYSIZE(values), values_offset, overlay, -1.0f, 1.0f, ImVec2(0, 80.0f)); } // Use functions to generate output // FIXME: This is actually VERY awkward because current plot API only pass in indices. // We probably want an API passing floats and user provide sample rate/count. struct Funcs { static float Sin(void*, int i) { return sinf(i * 0.1f); } static float Saw(void*, int i) { return (i & 1) ? 1.0f : -1.0f; } }; static int func_type = 0, display_count = 70; ImGui::SeparatorText("Functions"); ImGui::SetNextItemWidth(ImGui::GetFontSize() * 8); ImGui::Combo("func", &func_type, "Sin\0Saw\0"); ImGui::SameLine(); ImGui::SliderInt("Sample count", &display_count, 1, 400); float (*func)(void*, int) = (func_type == 0) ? Funcs::Sin : Funcs::Saw; ImGui::PlotLines("Lines##2", func, NULL, display_count, 0, NULL, -1.0f, 1.0f, ImVec2(0, 80)); ImGui::PlotHistogram("Histogram##2", func, NULL, display_count, 0, NULL, -1.0f, 1.0f, ImVec2(0, 80)); ImGui::TreePop(); } } //----------------------------------------------------------------------------- // [SECTION] DemoWindowWidgetsProgressBars() //----------------------------------------------------------------------------- static void DemoWindowWidgetsProgressBars() { IMGUI_DEMO_MARKER("Widgets/Progress Bars"); if (ImGui::TreeNode("Progress Bars")) { // Animate a simple progress bar static float progress = 0.0f, progress_dir = 1.0f; progress += progress_dir * 0.4f * ImGui::GetIO().DeltaTime; if (progress >= +1.1f) { progress = +1.1f; progress_dir *= -1.0f; } if (progress <= -0.1f) { progress = -0.1f; progress_dir *= -1.0f; } // Typically we would use ImVec2(-1.0f,0.0f) or ImVec2(-FLT_MIN,0.0f) to use all available width, // or ImVec2(width,0.0f) for a specified width. ImVec2(0.0f,0.0f) uses ItemWidth. ImGui::ProgressBar(progress, ImVec2(0.0f, 0.0f)); ImGui::SameLine(0.0f, ImGui::GetStyle().ItemInnerSpacing.x); ImGui::Text("Progress Bar"); float progress_saturated = IM_CLAMP(progress, 0.0f, 1.0f); char buf[32]; sprintf(buf, "%d/%d", (int)(progress_saturated * 1753), 1753); ImGui::ProgressBar(progress, ImVec2(0.f, 0.f), buf); // Pass an animated negative value, e.g. -1.0f * (float)ImGui::GetTime() is the recommended value. // Adjust the factor if you want to adjust the animation speed. ImGui::ProgressBar(-1.0f * (float)ImGui::GetTime(), ImVec2(0.0f, 0.0f), "Searching.."); ImGui::SameLine(0.0f, ImGui::GetStyle().ItemInnerSpacing.x); ImGui::Text("Indeterminate"); ImGui::TreePop(); } } //----------------------------------------------------------------------------- // [SECTION] DemoWindowWidgetsQueryingStatuses() //----------------------------------------------------------------------------- static void DemoWindowWidgetsQueryingStatuses() { IMGUI_DEMO_MARKER("Widgets/Querying Item Status (Edited,Active,Hovered etc.)"); if (ImGui::TreeNode("Querying Item Status (Edited/Active/Hovered etc.)")) { // Select an item type const char* item_names[] = { "Text", "Button", "Button (w/ repeat)", "Checkbox", "SliderFloat", "InputText", "InputTextMultiline", "InputFloat", "InputFloat3", "ColorEdit4", "Selectable", "MenuItem", "TreeNode", "TreeNode (w/ double-click)", "Combo", "ListBox" }; static int item_type = 4; static bool item_disabled = false; ImGui::Combo("Item Type", &item_type, item_names, IM_ARRAYSIZE(item_names), IM_ARRAYSIZE(item_names)); ImGui::SameLine(); HelpMarker("Testing how various types of items are interacting with the IsItemXXX functions. Note that the bool return value of most ImGui function is generally equivalent to calling ImGui::IsItemHovered()."); ImGui::Checkbox("Item Disabled", &item_disabled); // Submit selected items so we can query their status in the code following it. bool ret = false; static bool b = false; static float col4f[4] = { 1.0f, 0.5, 0.0f, 1.0f }; static char str[16] = {}; if (item_disabled) ImGui::BeginDisabled(true); if (item_type == 0) { ImGui::Text("ITEM: Text"); } // Testing text items with no identifier/interaction if (item_type == 1) { ret = ImGui::Button("ITEM: Button"); } // Testing button if (item_type == 2) { ImGui::PushItemFlag(ImGuiItemFlags_ButtonRepeat, true); ret = ImGui::Button("ITEM: Button"); ImGui::PopItemFlag(); } // Testing button (with repeater) if (item_type == 3) { ret = ImGui::Checkbox("ITEM: Checkbox", &b); } // Testing checkbox if (item_type == 4) { ret = ImGui::SliderFloat("ITEM: SliderFloat", &col4f[0], 0.0f, 1.0f); } // Testing basic item if (item_type == 5) { ret = ImGui::InputText("ITEM: InputText", &str[0], IM_ARRAYSIZE(str)); } // Testing input text (which handles tabbing) if (item_type == 6) { ret = ImGui::InputTextMultiline("ITEM: InputTextMultiline", &str[0], IM_ARRAYSIZE(str)); } // Testing input text (which uses a child window) if (item_type == 7) { ret = ImGui::InputFloat("ITEM: InputFloat", col4f, 1.0f); } // Testing +/- buttons on scalar input if (item_type == 8) { ret = ImGui::InputFloat3("ITEM: InputFloat3", col4f); } // Testing multi-component items (IsItemXXX flags are reported merged) if (item_type == 9) { ret = ImGui::ColorEdit4("ITEM: ColorEdit4", col4f); } // Testing multi-component items (IsItemXXX flags are reported merged) if (item_type == 10) { ret = ImGui::Selectable("ITEM: Selectable"); } // Testing selectable item if (item_type == 11) { ret = ImGui::MenuItem("ITEM: MenuItem"); } // Testing menu item (they use ImGuiButtonFlags_PressedOnRelease button policy) if (item_type == 12) { ret = ImGui::TreeNode("ITEM: TreeNode"); if (ret) ImGui::TreePop(); } // Testing tree node if (item_type == 13) { ret = ImGui::TreeNodeEx("ITEM: TreeNode w/ ImGuiTreeNodeFlags_OpenOnDoubleClick", ImGuiTreeNodeFlags_OpenOnDoubleClick | ImGuiTreeNodeFlags_NoTreePushOnOpen); } // Testing tree node with ImGuiButtonFlags_PressedOnDoubleClick button policy. if (item_type == 14) { const char* items[] = { "Apple", "Banana", "Cherry", "Kiwi" }; static int current = 1; ret = ImGui::Combo("ITEM: Combo", ¤t, items, IM_ARRAYSIZE(items)); } if (item_type == 15) { const char* items[] = { "Apple", "Banana", "Cherry", "Kiwi" }; static int current = 1; ret = ImGui::ListBox("ITEM: ListBox", ¤t, items, IM_ARRAYSIZE(items), IM_ARRAYSIZE(items)); } bool hovered_delay_none = ImGui::IsItemHovered(); bool hovered_delay_stationary = ImGui::IsItemHovered(ImGuiHoveredFlags_Stationary); bool hovered_delay_short = ImGui::IsItemHovered(ImGuiHoveredFlags_DelayShort); bool hovered_delay_normal = ImGui::IsItemHovered(ImGuiHoveredFlags_DelayNormal); bool hovered_delay_tooltip = ImGui::IsItemHovered(ImGuiHoveredFlags_ForTooltip); // = Normal + Stationary // Display the values of IsItemHovered() and other common item state functions. // Note that the ImGuiHoveredFlags_XXX flags can be combined. // Because BulletText is an item itself and that would affect the output of IsItemXXX functions, // we query every state in a single call to avoid storing them and to simplify the code. ImGui::BulletText( "Return value = %d\n" "IsItemFocused() = %d\n" "IsItemHovered() = %d\n" "IsItemHovered(_AllowWhenBlockedByPopup) = %d\n" "IsItemHovered(_AllowWhenBlockedByActiveItem) = %d\n" "IsItemHovered(_AllowWhenOverlappedByItem) = %d\n" "IsItemHovered(_AllowWhenOverlappedByWindow) = %d\n" "IsItemHovered(_AllowWhenDisabled) = %d\n" "IsItemHovered(_RectOnly) = %d\n" "IsItemActive() = %d\n" "IsItemEdited() = %d\n" "IsItemActivated() = %d\n" "IsItemDeactivated() = %d\n" "IsItemDeactivatedAfterEdit() = %d\n" "IsItemVisible() = %d\n" "IsItemClicked() = %d\n" "IsItemToggledOpen() = %d\n" "GetItemRectMin() = (%.1f, %.1f)\n" "GetItemRectMax() = (%.1f, %.1f)\n" "GetItemRectSize() = (%.1f, %.1f)", ret, ImGui::IsItemFocused(), ImGui::IsItemHovered(), ImGui::IsItemHovered(ImGuiHoveredFlags_AllowWhenBlockedByPopup), ImGui::IsItemHovered(ImGuiHoveredFlags_AllowWhenBlockedByActiveItem), ImGui::IsItemHovered(ImGuiHoveredFlags_AllowWhenOverlappedByItem), ImGui::IsItemHovered(ImGuiHoveredFlags_AllowWhenOverlappedByWindow), ImGui::IsItemHovered(ImGuiHoveredFlags_AllowWhenDisabled), ImGui::IsItemHovered(ImGuiHoveredFlags_RectOnly), ImGui::IsItemActive(), ImGui::IsItemEdited(), ImGui::IsItemActivated(), ImGui::IsItemDeactivated(), ImGui::IsItemDeactivatedAfterEdit(), ImGui::IsItemVisible(), ImGui::IsItemClicked(), ImGui::IsItemToggledOpen(), ImGui::GetItemRectMin().x, ImGui::GetItemRectMin().y, ImGui::GetItemRectMax().x, ImGui::GetItemRectMax().y, ImGui::GetItemRectSize().x, ImGui::GetItemRectSize().y ); ImGui::BulletText( "with Hovering Delay or Stationary test:\n" "IsItemHovered() = = %d\n" "IsItemHovered(_Stationary) = %d\n" "IsItemHovered(_DelayShort) = %d\n" "IsItemHovered(_DelayNormal) = %d\n" "IsItemHovered(_Tooltip) = %d", hovered_delay_none, hovered_delay_stationary, hovered_delay_short, hovered_delay_normal, hovered_delay_tooltip); if (item_disabled) ImGui::EndDisabled(); char buf[1] = ""; ImGui::InputText("unused", buf, IM_ARRAYSIZE(buf), ImGuiInputTextFlags_ReadOnly); ImGui::SameLine(); HelpMarker("This widget is only here to be able to tab-out of the widgets above and see e.g. Deactivated() status."); ImGui::TreePop(); } IMGUI_DEMO_MARKER("Widgets/Querying Window Status (Focused,Hovered etc.)"); if (ImGui::TreeNode("Querying Window Status (Focused/Hovered etc.)")) { static bool embed_all_inside_a_child_window = false; ImGui::Checkbox("Embed everything inside a child window for testing _RootWindow flag.", &embed_all_inside_a_child_window); if (embed_all_inside_a_child_window) ImGui::BeginChild("outer_child", ImVec2(0, ImGui::GetFontSize() * 20.0f), ImGuiChildFlags_Borders); // Testing IsWindowFocused() function with its various flags. ImGui::BulletText( "IsWindowFocused() = %d\n" "IsWindowFocused(_ChildWindows) = %d\n" "IsWindowFocused(_ChildWindows|_NoPopupHierarchy) = %d\n" "IsWindowFocused(_ChildWindows|_RootWindow) = %d\n" "IsWindowFocused(_ChildWindows|_RootWindow|_NoPopupHierarchy) = %d\n" "IsWindowFocused(_RootWindow) = %d\n" "IsWindowFocused(_RootWindow|_NoPopupHierarchy) = %d\n" "IsWindowFocused(_AnyWindow) = %d\n", ImGui::IsWindowFocused(), ImGui::IsWindowFocused(ImGuiFocusedFlags_ChildWindows), ImGui::IsWindowFocused(ImGuiFocusedFlags_ChildWindows | ImGuiFocusedFlags_NoPopupHierarchy), ImGui::IsWindowFocused(ImGuiFocusedFlags_ChildWindows | ImGuiFocusedFlags_RootWindow), ImGui::IsWindowFocused(ImGuiFocusedFlags_ChildWindows | ImGuiFocusedFlags_RootWindow | ImGuiFocusedFlags_NoPopupHierarchy), ImGui::IsWindowFocused(ImGuiFocusedFlags_RootWindow), ImGui::IsWindowFocused(ImGuiFocusedFlags_RootWindow | ImGuiFocusedFlags_NoPopupHierarchy), ImGui::IsWindowFocused(ImGuiFocusedFlags_AnyWindow)); // Testing IsWindowHovered() function with its various flags. ImGui::BulletText( "IsWindowHovered() = %d\n" "IsWindowHovered(_AllowWhenBlockedByPopup) = %d\n" "IsWindowHovered(_AllowWhenBlockedByActiveItem) = %d\n" "IsWindowHovered(_ChildWindows) = %d\n" "IsWindowHovered(_ChildWindows|_NoPopupHierarchy) = %d\n" "IsWindowHovered(_ChildWindows|_RootWindow) = %d\n" "IsWindowHovered(_ChildWindows|_RootWindow|_NoPopupHierarchy) = %d\n" "IsWindowHovered(_RootWindow) = %d\n" "IsWindowHovered(_RootWindow|_NoPopupHierarchy) = %d\n" "IsWindowHovered(_ChildWindows|_AllowWhenBlockedByPopup) = %d\n" "IsWindowHovered(_AnyWindow) = %d\n" "IsWindowHovered(_Stationary) = %d\n", ImGui::IsWindowHovered(), ImGui::IsWindowHovered(ImGuiHoveredFlags_AllowWhenBlockedByPopup), ImGui::IsWindowHovered(ImGuiHoveredFlags_AllowWhenBlockedByActiveItem), ImGui::IsWindowHovered(ImGuiHoveredFlags_ChildWindows), ImGui::IsWindowHovered(ImGuiHoveredFlags_ChildWindows | ImGuiHoveredFlags_NoPopupHierarchy), ImGui::IsWindowHovered(ImGuiHoveredFlags_ChildWindows | ImGuiHoveredFlags_RootWindow), ImGui::IsWindowHovered(ImGuiHoveredFlags_ChildWindows | ImGuiHoveredFlags_RootWindow | ImGuiHoveredFlags_NoPopupHierarchy), ImGui::IsWindowHovered(ImGuiHoveredFlags_RootWindow), ImGui::IsWindowHovered(ImGuiHoveredFlags_RootWindow | ImGuiHoveredFlags_NoPopupHierarchy), ImGui::IsWindowHovered(ImGuiHoveredFlags_ChildWindows | ImGuiHoveredFlags_AllowWhenBlockedByPopup), ImGui::IsWindowHovered(ImGuiHoveredFlags_AnyWindow), ImGui::IsWindowHovered(ImGuiHoveredFlags_Stationary)); ImGui::BeginChild("child", ImVec2(0, 50), ImGuiChildFlags_Borders); ImGui::Text("This is another child window for testing the _ChildWindows flag."); ImGui::EndChild(); if (embed_all_inside_a_child_window) ImGui::EndChild(); // Calling IsItemHovered() after begin returns the hovered status of the title bar. // This is useful in particular if you want to create a context menu associated to the title bar of a window. static bool test_window = false; ImGui::Checkbox("Hovered/Active tests after Begin() for title bar testing", &test_window); if (test_window) { ImGui::Begin("Title bar Hovered/Active tests", &test_window); if (ImGui::BeginPopupContextItem()) // <-- This is using IsItemHovered() { if (ImGui::MenuItem("Close")) { test_window = false; } ImGui::EndPopup(); } ImGui::Text( "IsItemHovered() after begin = %d (== is title bar hovered)\n" "IsItemActive() after begin = %d (== is window being clicked/moved)\n", ImGui::IsItemHovered(), ImGui::IsItemActive()); ImGui::End(); } ImGui::TreePop(); } } //----------------------------------------------------------------------------- // [SECTION] DemoWindowWidgetsSelectables() //----------------------------------------------------------------------------- static void DemoWindowWidgetsSelectables() { IMGUI_DEMO_MARKER("Widgets/Selectables"); //ImGui::SetNextItemOpen(true, ImGuiCond_Once); if (ImGui::TreeNode("Selectables")) { // Selectable() has 2 overloads: // - The one taking "bool selected" as a read-only selection information. // When Selectable() has been clicked it returns true and you can alter selection state accordingly. // - The one taking "bool* p_selected" as a read-write selection information (convenient in some cases) // The earlier is more flexible, as in real application your selection may be stored in many different ways // and not necessarily inside a bool value (e.g. in flags within objects, as an external list, etc). IMGUI_DEMO_MARKER("Widgets/Selectables/Basic"); if (ImGui::TreeNode("Basic")) { static bool selection[5] = { false, true, false, false }; ImGui::Selectable("1. I am selectable", &selection[0]); ImGui::Selectable("2. I am selectable", &selection[1]); ImGui::Selectable("3. I am selectable", &selection[2]); if (ImGui::Selectable("4. I am double clickable", selection[3], ImGuiSelectableFlags_AllowDoubleClick)) if (ImGui::IsMouseDoubleClicked(0)) selection[3] = !selection[3]; ImGui::TreePop(); } IMGUI_DEMO_MARKER("Widgets/Selectables/Rendering more items on the same line"); if (ImGui::TreeNode("Rendering more items on the same line")) { // (1) Using SetNextItemAllowOverlap() // (2) Using the Selectable() override that takes "bool* p_selected" parameter, the bool value is toggled automatically. static bool selected[3] = { false, false, false }; ImGui::SetNextItemAllowOverlap(); ImGui::Selectable("main.c", &selected[0]); ImGui::SameLine(); ImGui::SmallButton("Link 1"); ImGui::SetNextItemAllowOverlap(); ImGui::Selectable("Hello.cpp", &selected[1]); ImGui::SameLine(); ImGui::SmallButton("Link 2"); ImGui::SetNextItemAllowOverlap(); ImGui::Selectable("Hello.h", &selected[2]); ImGui::SameLine(); ImGui::SmallButton("Link 3"); ImGui::TreePop(); } IMGUI_DEMO_MARKER("Widgets/Selectables/In Tables"); if (ImGui::TreeNode("In Tables")) { static bool selected[10] = {}; if (ImGui::BeginTable("split1", 3, ImGuiTableFlags_Resizable | ImGuiTableFlags_NoSavedSettings | ImGuiTableFlags_Borders)) { for (int i = 0; i < 10; i++) { char label[32]; sprintf(label, "Item %d", i); ImGui::TableNextColumn(); ImGui::Selectable(label, &selected[i]); // FIXME-TABLE: Selection overlap } ImGui::EndTable(); } ImGui::Spacing(); if (ImGui::BeginTable("split2", 3, ImGuiTableFlags_Resizable | ImGuiTableFlags_NoSavedSettings | ImGuiTableFlags_Borders)) { for (int i = 0; i < 10; i++) { char label[32]; sprintf(label, "Item %d", i); ImGui::TableNextRow(); ImGui::TableNextColumn(); ImGui::Selectable(label, &selected[i], ImGuiSelectableFlags_SpanAllColumns); ImGui::TableNextColumn(); ImGui::Text("Some other contents"); ImGui::TableNextColumn(); ImGui::Text("123456"); } ImGui::EndTable(); } ImGui::TreePop(); } IMGUI_DEMO_MARKER("Widgets/Selectables/Grid"); if (ImGui::TreeNode("Grid")) { static char selected[4][4] = { { 1, 0, 0, 0 }, { 0, 1, 0, 0 }, { 0, 0, 1, 0 }, { 0, 0, 0, 1 } }; // Add in a bit of silly fun... const float time = (float)ImGui::GetTime(); const bool winning_state = memchr(selected, 0, sizeof(selected)) == NULL; // If all cells are selected... if (winning_state) ImGui::PushStyleVar(ImGuiStyleVar_SelectableTextAlign, ImVec2(0.5f + 0.5f * cosf(time * 2.0f), 0.5f + 0.5f * sinf(time * 3.0f))); for (int y = 0; y < 4; y++) for (int x = 0; x < 4; x++) { if (x > 0) ImGui::SameLine(); ImGui::PushID(y * 4 + x); if (ImGui::Selectable("Sailor", selected[y][x] != 0, 0, ImVec2(50, 50))) { // Toggle clicked cell + toggle neighbors selected[y][x] ^= 1; if (x > 0) { selected[y][x - 1] ^= 1; } if (x < 3) { selected[y][x + 1] ^= 1; } if (y > 0) { selected[y - 1][x] ^= 1; } if (y < 3) { selected[y + 1][x] ^= 1; } } ImGui::PopID(); } if (winning_state) ImGui::PopStyleVar(); ImGui::TreePop(); } IMGUI_DEMO_MARKER("Widgets/Selectables/Alignment"); if (ImGui::TreeNode("Alignment")) { HelpMarker( "By default, Selectables uses style.SelectableTextAlign but it can be overridden on a per-item " "basis using PushStyleVar(). You'll probably want to always keep your default situation to " "left-align otherwise it becomes difficult to layout multiple items on a same line"); static bool selected[3 * 3] = { true, false, true, false, true, false, true, false, true }; for (int y = 0; y < 3; y++) { for (int x = 0; x < 3; x++) { ImVec2 alignment = ImVec2((float)x / 2.0f, (float)y / 2.0f); char name[32]; sprintf(name, "(%.1f,%.1f)", alignment.x, alignment.y); if (x > 0) ImGui::SameLine(); ImGui::PushStyleVar(ImGuiStyleVar_SelectableTextAlign, alignment); ImGui::Selectable(name, &selected[3 * y + x], ImGuiSelectableFlags_None, ImVec2(80, 80)); ImGui::PopStyleVar(); } } ImGui::TreePop(); } ImGui::TreePop(); } } //----------------------------------------------------------------------------- // [SECTION] DemoWindowWidgetsSelectionAndMultiSelect() //----------------------------------------------------------------------------- // Multi-selection demos // Also read: https://github.com/ocornut/imgui/wiki/Multi-Select //----------------------------------------------------------------------------- static const char* ExampleNames[] = { "Artichoke", "Arugula", "Asparagus", "Avocado", "Bamboo Shoots", "Bean Sprouts", "Beans", "Beet", "Belgian Endive", "Bell Pepper", "Bitter Gourd", "Bok Choy", "Broccoli", "Brussels Sprouts", "Burdock Root", "Cabbage", "Calabash", "Capers", "Carrot", "Cassava", "Cauliflower", "Celery", "Celery Root", "Celcuce", "Chayote", "Chinese Broccoli", "Corn", "Cucumber" }; // Extra functions to add deletion support to ImGuiSelectionBasicStorage struct ExampleSelectionWithDeletion : ImGuiSelectionBasicStorage { // Find which item should be Focused after deletion. // Call _before_ item submission. Retunr an index in the before-deletion item list, your item loop should call SetKeyboardFocusHere() on it. // The subsequent ApplyDeletionPostLoop() code will use it to apply Selection. // - We cannot provide this logic in core Dear ImGui because we don't have access to selection data. // - We don't actually manipulate the ImVector<> here, only in ApplyDeletionPostLoop(), but using similar API for consistency and flexibility. // - Important: Deletion only works if the underlying ImGuiID for your items are stable: aka not depend on their index, but on e.g. item id/ptr. // FIXME-MULTISELECT: Doesn't take account of the possibility focus target will be moved during deletion. Need refocus or scroll offset. int ApplyDeletionPreLoop(ImGuiMultiSelectIO* ms_io, int items_count) { if (Size == 0) return -1; // If focused item is not selected... const int focused_idx = (int)ms_io->NavIdItem; // Index of currently focused item if (ms_io->NavIdSelected == false) // This is merely a shortcut, == Contains(adapter->IndexToStorage(items, focused_idx)) { ms_io->RangeSrcReset = true; // Request to recover RangeSrc from NavId next frame. Would be ok to reset even when NavIdSelected==true, but it would take an extra frame to recover RangeSrc when deleting a selected item. return focused_idx; // Request to focus same item after deletion. } // If focused item is selected: land on first unselected item after focused item. for (int idx = focused_idx + 1; idx < items_count; idx++) if (!Contains(GetStorageIdFromIndex(idx))) return idx; // If focused item is selected: otherwise return last unselected item before focused item. for (int idx = IM_MIN(focused_idx, items_count) - 1; idx >= 0; idx--) if (!Contains(GetStorageIdFromIndex(idx))) return idx; return -1; } // Rewrite item list (delete items) + update selection. // - Call after EndMultiSelect() // - We cannot provide this logic in core Dear ImGui because we don't have access to your items, nor to selection data. template void ApplyDeletionPostLoop(ImGuiMultiSelectIO* ms_io, ImVector& items, int item_curr_idx_to_select) { // Rewrite item list (delete items) + convert old selection index (before deletion) to new selection index (after selection). // If NavId was not part of selection, we will stay on same item. ImVector new_items; new_items.reserve(items.Size - Size); int item_next_idx_to_select = -1; for (int idx = 0; idx < items.Size; idx++) { if (!Contains(GetStorageIdFromIndex(idx))) new_items.push_back(items[idx]); if (item_curr_idx_to_select == idx) item_next_idx_to_select = new_items.Size - 1; } items.swap(new_items); // Update selection Clear(); if (item_next_idx_to_select != -1 && ms_io->NavIdSelected) SetItemSelected(GetStorageIdFromIndex(item_next_idx_to_select), true); } }; // Example: Implement dual list box storage and interface struct ExampleDualListBox { ImVector Items[2]; // ID is index into ExampleName[] ImGuiSelectionBasicStorage Selections[2]; // Store ExampleItemId into selection bool OptKeepSorted = true; void MoveAll(int src, int dst) { IM_ASSERT((src == 0 && dst == 1) || (src == 1 && dst == 0)); for (ImGuiID item_id : Items[src]) Items[dst].push_back(item_id); Items[src].clear(); SortItems(dst); Selections[src].Swap(Selections[dst]); Selections[src].Clear(); } void MoveSelected(int src, int dst) { for (int src_n = 0; src_n < Items[src].Size; src_n++) { ImGuiID item_id = Items[src][src_n]; if (!Selections[src].Contains(item_id)) continue; Items[src].erase(&Items[src][src_n]); // FIXME-OPT: Could be implemented more optimally (rebuild src items and swap) Items[dst].push_back(item_id); src_n--; } if (OptKeepSorted) SortItems(dst); Selections[src].Swap(Selections[dst]); Selections[src].Clear(); } void ApplySelectionRequests(ImGuiMultiSelectIO* ms_io, int side) { // In this example we store item id in selection (instead of item index) Selections[side].UserData = Items[side].Data; Selections[side].AdapterIndexToStorageId = [](ImGuiSelectionBasicStorage* self, int idx) { ImGuiID* items = (ImGuiID*)self->UserData; return items[idx]; }; Selections[side].ApplyRequests(ms_io); } static int IMGUI_CDECL CompareItemsByValue(const void* lhs, const void* rhs) { const int* a = (const int*)lhs; const int* b = (const int*)rhs; return (*a - *b) > 0 ? +1 : -1; } void SortItems(int n) { qsort(Items[n].Data, (size_t)Items[n].Size, sizeof(Items[n][0]), CompareItemsByValue); } void Show() { //ImGui::Checkbox("Sorted", &OptKeepSorted); if (ImGui::BeginTable("split", 3, ImGuiTableFlags_None)) { ImGui::TableSetupColumn("", ImGuiTableColumnFlags_WidthStretch); // Left side ImGui::TableSetupColumn("", ImGuiTableColumnFlags_WidthFixed); // Buttons ImGui::TableSetupColumn("", ImGuiTableColumnFlags_WidthStretch); // Right side ImGui::TableNextRow(); int request_move_selected = -1; int request_move_all = -1; float child_height_0 = 0.0f; for (int side = 0; side < 2; side++) { // FIXME-MULTISELECT: Dual List Box: Add context menus // FIXME-NAV: Using ImGuiWindowFlags_NavFlattened exhibit many issues. ImVector& items = Items[side]; ImGuiSelectionBasicStorage& selection = Selections[side]; ImGui::TableSetColumnIndex((side == 0) ? 0 : 2); ImGui::Text("%s (%d)", (side == 0) ? "Available" : "Basket", items.Size); // Submit scrolling range to avoid glitches on moving/deletion const float items_height = ImGui::GetTextLineHeightWithSpacing(); ImGui::SetNextWindowContentSize(ImVec2(0.0f, items.Size * items_height)); bool child_visible; if (side == 0) { // Left child is resizable ImGui::SetNextWindowSizeConstraints(ImVec2(0.0f, ImGui::GetFrameHeightWithSpacing() * 4), ImVec2(FLT_MAX, FLT_MAX)); child_visible = ImGui::BeginChild("0", ImVec2(-FLT_MIN, ImGui::GetFontSize() * 20), ImGuiChildFlags_FrameStyle | ImGuiChildFlags_ResizeY); child_height_0 = ImGui::GetWindowSize().y; } else { // Right child use same height as left one child_visible = ImGui::BeginChild("1", ImVec2(-FLT_MIN, child_height_0), ImGuiChildFlags_FrameStyle); } if (child_visible) { ImGuiMultiSelectFlags flags = ImGuiMultiSelectFlags_None; ImGuiMultiSelectIO* ms_io = ImGui::BeginMultiSelect(flags, selection.Size, items.Size); ApplySelectionRequests(ms_io, side); for (int item_n = 0; item_n < items.Size; item_n++) { ImGuiID item_id = items[item_n]; bool item_is_selected = selection.Contains(item_id); ImGui::SetNextItemSelectionUserData(item_n); ImGui::Selectable(ExampleNames[item_id], item_is_selected, ImGuiSelectableFlags_AllowDoubleClick); if (ImGui::IsItemFocused()) { // FIXME-MULTISELECT: Dual List Box: Transfer focus if (ImGui::IsKeyPressed(ImGuiKey_Enter) || ImGui::IsKeyPressed(ImGuiKey_KeypadEnter)) request_move_selected = side; if (ImGui::IsMouseDoubleClicked(0)) // FIXME-MULTISELECT: Double-click on multi-selection? request_move_selected = side; } } ms_io = ImGui::EndMultiSelect(); ApplySelectionRequests(ms_io, side); } ImGui::EndChild(); } // Buttons columns ImGui::TableSetColumnIndex(1); ImGui::NewLine(); //ImVec2 button_sz = { ImGui::CalcTextSize(">>").x + ImGui::GetStyle().FramePadding.x * 2.0f, ImGui::GetFrameHeight() + padding.y * 2.0f }; ImVec2 button_sz = { ImGui::GetFrameHeight(), ImGui::GetFrameHeight() }; // (Using BeginDisabled()/EndDisabled() works but feels distracting given how it is currently visualized) if (ImGui::Button(">>", button_sz)) request_move_all = 0; if (ImGui::Button(">", button_sz)) request_move_selected = 0; if (ImGui::Button("<", button_sz)) request_move_selected = 1; if (ImGui::Button("<<", button_sz)) request_move_all = 1; // Process requests if (request_move_all != -1) MoveAll(request_move_all, request_move_all ^ 1); if (request_move_selected != -1) MoveSelected(request_move_selected, request_move_selected ^ 1); // FIXME-MULTISELECT: Support action from outside /* if (OptKeepSorted == false) { ImGui::NewLine(); if (ImGui::ArrowButton("MoveUp", ImGuiDir_Up)) {} if (ImGui::ArrowButton("MoveDown", ImGuiDir_Down)) {} } */ ImGui::EndTable(); } } }; static void DemoWindowWidgetsSelectionAndMultiSelect(ImGuiDemoWindowData* demo_data) { IMGUI_DEMO_MARKER("Widgets/Selection State & Multi-Select"); if (ImGui::TreeNode("Selection State & Multi-Select")) { HelpMarker("Selections can be built using Selectable(), TreeNode() or other widgets. Selection state is owned by application code/data."); // Without any fancy API: manage single-selection yourself. IMGUI_DEMO_MARKER("Widgets/Selection State/Single-Select"); if (ImGui::TreeNode("Single-Select")) { static int selected = -1; for (int n = 0; n < 5; n++) { char buf[32]; sprintf(buf, "Object %d", n); if (ImGui::Selectable(buf, selected == n)) selected = n; } ImGui::TreePop(); } // Demonstrate implementation a most-basic form of multi-selection manually // This doesn't support the SHIFT modifier which requires BeginMultiSelect()! IMGUI_DEMO_MARKER("Widgets/Selection State/Multi-Select (manual/simplified, without BeginMultiSelect)"); if (ImGui::TreeNode("Multi-Select (manual/simplified, without BeginMultiSelect)")) { HelpMarker("Hold CTRL and click to select multiple items."); static bool selection[5] = { false, false, false, false, false }; for (int n = 0; n < 5; n++) { char buf[32]; sprintf(buf, "Object %d", n); if (ImGui::Selectable(buf, selection[n])) { if (!ImGui::GetIO().KeyCtrl) // Clear selection when CTRL is not held memset(selection, 0, sizeof(selection)); selection[n] ^= 1; // Toggle current item } } ImGui::TreePop(); } // Demonstrate handling proper multi-selection using the BeginMultiSelect/EndMultiSelect API. // SHIFT+Click w/ CTRL and other standard features are supported. // We use the ImGuiSelectionBasicStorage helper which you may freely reimplement. IMGUI_DEMO_MARKER("Widgets/Selection State/Multi-Select"); if (ImGui::TreeNode("Multi-Select")) { ImGui::Text("Supported features:"); ImGui::BulletText("Keyboard navigation (arrows, page up/down, home/end, space)."); ImGui::BulletText("Ctrl modifier to preserve and toggle selection."); ImGui::BulletText("Shift modifier for range selection."); ImGui::BulletText("CTRL+A to select all."); ImGui::BulletText("Escape to clear selection."); ImGui::BulletText("Click and drag to box-select."); ImGui::Text("Tip: Use 'Demo->Tools->Debug Log->Selection' to see selection requests as they happen."); // Use default selection.Adapter: Pass index to SetNextItemSelectionUserData(), store index in Selection const int ITEMS_COUNT = 50; static ImGuiSelectionBasicStorage selection; ImGui::Text("Selection: %d/%d", selection.Size, ITEMS_COUNT); // The BeginChild() has no purpose for selection logic, other that offering a scrolling region. if (ImGui::BeginChild("##Basket", ImVec2(-FLT_MIN, ImGui::GetFontSize() * 20), ImGuiChildFlags_FrameStyle | ImGuiChildFlags_ResizeY)) { ImGuiMultiSelectFlags flags = ImGuiMultiSelectFlags_ClearOnEscape | ImGuiMultiSelectFlags_BoxSelect1d; ImGuiMultiSelectIO* ms_io = ImGui::BeginMultiSelect(flags, selection.Size, ITEMS_COUNT); selection.ApplyRequests(ms_io); for (int n = 0; n < ITEMS_COUNT; n++) { char label[64]; sprintf(label, "Object %05d: %s", n, ExampleNames[n % IM_ARRAYSIZE(ExampleNames)]); bool item_is_selected = selection.Contains((ImGuiID)n); ImGui::SetNextItemSelectionUserData(n); ImGui::Selectable(label, item_is_selected); } ms_io = ImGui::EndMultiSelect(); selection.ApplyRequests(ms_io); } ImGui::EndChild(); ImGui::TreePop(); } // Demonstrate using the clipper with BeginMultiSelect()/EndMultiSelect() IMGUI_DEMO_MARKER("Widgets/Selection State/Multi-Select (with clipper)"); if (ImGui::TreeNode("Multi-Select (with clipper)")) { // Use default selection.Adapter: Pass index to SetNextItemSelectionUserData(), store index in Selection static ImGuiSelectionBasicStorage selection; ImGui::Text("Added features:"); ImGui::BulletText("Using ImGuiListClipper."); const int ITEMS_COUNT = 10000; ImGui::Text("Selection: %d/%d", selection.Size, ITEMS_COUNT); if (ImGui::BeginChild("##Basket", ImVec2(-FLT_MIN, ImGui::GetFontSize() * 20), ImGuiChildFlags_FrameStyle | ImGuiChildFlags_ResizeY)) { ImGuiMultiSelectFlags flags = ImGuiMultiSelectFlags_ClearOnEscape | ImGuiMultiSelectFlags_BoxSelect1d; ImGuiMultiSelectIO* ms_io = ImGui::BeginMultiSelect(flags, selection.Size, ITEMS_COUNT); selection.ApplyRequests(ms_io); ImGuiListClipper clipper; clipper.Begin(ITEMS_COUNT); if (ms_io->RangeSrcItem != -1) clipper.IncludeItemByIndex((int)ms_io->RangeSrcItem); // Ensure RangeSrc item is not clipped. while (clipper.Step()) { for (int n = clipper.DisplayStart; n < clipper.DisplayEnd; n++) { char label[64]; sprintf(label, "Object %05d: %s", n, ExampleNames[n % IM_ARRAYSIZE(ExampleNames)]); bool item_is_selected = selection.Contains((ImGuiID)n); ImGui::SetNextItemSelectionUserData(n); ImGui::Selectable(label, item_is_selected); } } ms_io = ImGui::EndMultiSelect(); selection.ApplyRequests(ms_io); } ImGui::EndChild(); ImGui::TreePop(); } // Demonstrate dynamic item list + deletion support using the BeginMultiSelect/EndMultiSelect API. // In order to support Deletion without any glitches you need to: // - (1) If items are submitted in their own scrolling area, submit contents size SetNextWindowContentSize() ahead of time to prevent one-frame readjustment of scrolling. // - (2) Items needs to have persistent ID Stack identifier = ID needs to not depends on their index. PushID(index) = KO. PushID(item_id) = OK. This is in order to focus items reliably after a selection. // - (3) BeginXXXX process // - (4) Focus process // - (5) EndXXXX process IMGUI_DEMO_MARKER("Widgets/Selection State/Multi-Select (with deletion)"); if (ImGui::TreeNode("Multi-Select (with deletion)")) { // Storing items data separately from selection data. // (you may decide to store selection data inside your item (aka intrusive storage) if you don't need multiple views over same items) // Use a custom selection.Adapter: store item identifier in Selection (instead of index) static ImVector items; static ExampleSelectionWithDeletion selection; selection.UserData = (void*)&items; selection.AdapterIndexToStorageId = [](ImGuiSelectionBasicStorage* self, int idx) { ImVector* p_items = (ImVector*)self->UserData; return (*p_items)[idx]; }; // Index -> ID ImGui::Text("Added features:"); ImGui::BulletText("Dynamic list with Delete key support."); ImGui::Text("Selection size: %d/%d", selection.Size, items.Size); // Initialize default list with 50 items + button to add/remove items. static ImGuiID items_next_id = 0; if (items_next_id == 0) for (ImGuiID n = 0; n < 50; n++) items.push_back(items_next_id++); if (ImGui::SmallButton("Add 20 items")) { for (int n = 0; n < 20; n++) { items.push_back(items_next_id++); } } ImGui::SameLine(); if (ImGui::SmallButton("Remove 20 items")) { for (int n = IM_MIN(20, items.Size); n > 0; n--) { selection.SetItemSelected(items.back(), false); items.pop_back(); } } // (1) Extra to support deletion: Submit scrolling range to avoid glitches on deletion const float items_height = ImGui::GetTextLineHeightWithSpacing(); ImGui::SetNextWindowContentSize(ImVec2(0.0f, items.Size * items_height)); if (ImGui::BeginChild("##Basket", ImVec2(-FLT_MIN, ImGui::GetFontSize() * 20), ImGuiChildFlags_FrameStyle | ImGuiChildFlags_ResizeY)) { ImGuiMultiSelectFlags flags = ImGuiMultiSelectFlags_ClearOnEscape | ImGuiMultiSelectFlags_BoxSelect1d; ImGuiMultiSelectIO* ms_io = ImGui::BeginMultiSelect(flags, selection.Size, items.Size); selection.ApplyRequests(ms_io); const bool want_delete = ImGui::Shortcut(ImGuiKey_Delete, ImGuiInputFlags_Repeat) && (selection.Size > 0); const int item_curr_idx_to_focus = want_delete ? selection.ApplyDeletionPreLoop(ms_io, items.Size) : -1; for (int n = 0; n < items.Size; n++) { const ImGuiID item_id = items[n]; char label[64]; sprintf(label, "Object %05u: %s", item_id, ExampleNames[item_id % IM_ARRAYSIZE(ExampleNames)]); bool item_is_selected = selection.Contains(item_id); ImGui::SetNextItemSelectionUserData(n); ImGui::Selectable(label, item_is_selected); if (item_curr_idx_to_focus == n) ImGui::SetKeyboardFocusHere(-1); } // Apply multi-select requests ms_io = ImGui::EndMultiSelect(); selection.ApplyRequests(ms_io); if (want_delete) selection.ApplyDeletionPostLoop(ms_io, items, item_curr_idx_to_focus); } ImGui::EndChild(); ImGui::TreePop(); } // Implement a Dual List Box (#6648) IMGUI_DEMO_MARKER("Widgets/Selection State/Multi-Select (dual list box)"); if (ImGui::TreeNode("Multi-Select (dual list box)")) { // Init default state static ExampleDualListBox dlb; if (dlb.Items[0].Size == 0 && dlb.Items[1].Size == 0) for (int item_id = 0; item_id < IM_ARRAYSIZE(ExampleNames); item_id++) dlb.Items[0].push_back((ImGuiID)item_id); // Show dlb.Show(); ImGui::TreePop(); } // Demonstrate using the clipper with BeginMultiSelect()/EndMultiSelect() IMGUI_DEMO_MARKER("Widgets/Selection State/Multi-Select (in a table)"); if (ImGui::TreeNode("Multi-Select (in a table)")) { static ImGuiSelectionBasicStorage selection; const int ITEMS_COUNT = 10000; ImGui::Text("Selection: %d/%d", selection.Size, ITEMS_COUNT); if (ImGui::BeginTable("##Basket", 2, ImGuiTableFlags_ScrollY | ImGuiTableFlags_RowBg | ImGuiTableFlags_BordersOuter)) { ImGui::TableSetupColumn("Object"); ImGui::TableSetupColumn("Action"); ImGui::TableSetupScrollFreeze(0, 1); ImGui::TableHeadersRow(); ImGuiMultiSelectFlags flags = ImGuiMultiSelectFlags_ClearOnEscape | ImGuiMultiSelectFlags_BoxSelect1d; ImGuiMultiSelectIO* ms_io = ImGui::BeginMultiSelect(flags, selection.Size, ITEMS_COUNT); selection.ApplyRequests(ms_io); ImGuiListClipper clipper; clipper.Begin(ITEMS_COUNT); if (ms_io->RangeSrcItem != -1) clipper.IncludeItemByIndex((int)ms_io->RangeSrcItem); // Ensure RangeSrc item is not clipped. while (clipper.Step()) { for (int n = clipper.DisplayStart; n < clipper.DisplayEnd; n++) { ImGui::TableNextRow(); ImGui::TableNextColumn(); char label[64]; sprintf(label, "Object %05d: %s", n, ExampleNames[n % IM_ARRAYSIZE(ExampleNames)]); bool item_is_selected = selection.Contains((ImGuiID)n); ImGui::SetNextItemSelectionUserData(n); ImGui::Selectable(label, item_is_selected, ImGuiSelectableFlags_SpanAllColumns | ImGuiSelectableFlags_AllowOverlap); ImGui::TableNextColumn(); ImGui::SmallButton("hello"); } } ms_io = ImGui::EndMultiSelect(); selection.ApplyRequests(ms_io); ImGui::EndTable(); } ImGui::TreePop(); } IMGUI_DEMO_MARKER("Widgets/Selection State/Multi-Select (checkboxes)"); if (ImGui::TreeNode("Multi-Select (checkboxes)")) { ImGui::Text("In a list of checkboxes (not selectable):"); ImGui::BulletText("Using _NoAutoSelect + _NoAutoClear flags."); ImGui::BulletText("Shift+Click to check multiple boxes."); ImGui::BulletText("Shift+Keyboard to copy current value to other boxes."); // If you have an array of checkboxes, you may want to use NoAutoSelect + NoAutoClear and the ImGuiSelectionExternalStorage helper. static bool items[20] = {}; static ImGuiMultiSelectFlags flags = ImGuiMultiSelectFlags_NoAutoSelect | ImGuiMultiSelectFlags_NoAutoClear | ImGuiMultiSelectFlags_ClearOnEscape; ImGui::CheckboxFlags("ImGuiMultiSelectFlags_NoAutoSelect", &flags, ImGuiMultiSelectFlags_NoAutoSelect); ImGui::CheckboxFlags("ImGuiMultiSelectFlags_NoAutoClear", &flags, ImGuiMultiSelectFlags_NoAutoClear); ImGui::CheckboxFlags("ImGuiMultiSelectFlags_BoxSelect2d", &flags, ImGuiMultiSelectFlags_BoxSelect2d); // Cannot use ImGuiMultiSelectFlags_BoxSelect1d as checkboxes are varying width. if (ImGui::BeginChild("##Basket", ImVec2(-FLT_MIN, ImGui::GetFontSize() * 20), ImGuiChildFlags_Borders | ImGuiChildFlags_ResizeY)) { ImGuiMultiSelectIO* ms_io = ImGui::BeginMultiSelect(flags, -1, IM_ARRAYSIZE(items)); ImGuiSelectionExternalStorage storage_wrapper; storage_wrapper.UserData = (void*)items; storage_wrapper.AdapterSetItemSelected = [](ImGuiSelectionExternalStorage* self, int n, bool selected) { bool* array = (bool*)self->UserData; array[n] = selected; }; storage_wrapper.ApplyRequests(ms_io); for (int n = 0; n < 20; n++) { char label[32]; sprintf(label, "Item %d", n); ImGui::SetNextItemSelectionUserData(n); ImGui::Checkbox(label, &items[n]); } ms_io = ImGui::EndMultiSelect(); storage_wrapper.ApplyRequests(ms_io); } ImGui::EndChild(); ImGui::TreePop(); } // Demonstrate individual selection scopes in same window IMGUI_DEMO_MARKER("Widgets/Selection State/Multi-Select (multiple scopes)"); if (ImGui::TreeNode("Multi-Select (multiple scopes)")) { // Use default select: Pass index to SetNextItemSelectionUserData(), store index in Selection const int SCOPES_COUNT = 3; const int ITEMS_COUNT = 8; // Per scope static ImGuiSelectionBasicStorage selections_data[SCOPES_COUNT]; // Use ImGuiMultiSelectFlags_ScopeRect to not affect other selections in same window. static ImGuiMultiSelectFlags flags = ImGuiMultiSelectFlags_ScopeRect | ImGuiMultiSelectFlags_ClearOnEscape;// | ImGuiMultiSelectFlags_ClearOnClickVoid; if (ImGui::CheckboxFlags("ImGuiMultiSelectFlags_ScopeWindow", &flags, ImGuiMultiSelectFlags_ScopeWindow) && (flags & ImGuiMultiSelectFlags_ScopeWindow)) flags &= ~ImGuiMultiSelectFlags_ScopeRect; if (ImGui::CheckboxFlags("ImGuiMultiSelectFlags_ScopeRect", &flags, ImGuiMultiSelectFlags_ScopeRect) && (flags & ImGuiMultiSelectFlags_ScopeRect)) flags &= ~ImGuiMultiSelectFlags_ScopeWindow; ImGui::CheckboxFlags("ImGuiMultiSelectFlags_ClearOnClickVoid", &flags, ImGuiMultiSelectFlags_ClearOnClickVoid); ImGui::CheckboxFlags("ImGuiMultiSelectFlags_BoxSelect1d", &flags, ImGuiMultiSelectFlags_BoxSelect1d); for (int selection_scope_n = 0; selection_scope_n < SCOPES_COUNT; selection_scope_n++) { ImGui::PushID(selection_scope_n); ImGuiSelectionBasicStorage* selection = &selections_data[selection_scope_n]; ImGuiMultiSelectIO* ms_io = ImGui::BeginMultiSelect(flags, selection->Size, ITEMS_COUNT); selection->ApplyRequests(ms_io); ImGui::SeparatorText("Selection scope"); ImGui::Text("Selection size: %d/%d", selection->Size, ITEMS_COUNT); for (int n = 0; n < ITEMS_COUNT; n++) { char label[64]; sprintf(label, "Object %05d: %s", n, ExampleNames[n % IM_ARRAYSIZE(ExampleNames)]); bool item_is_selected = selection->Contains((ImGuiID)n); ImGui::SetNextItemSelectionUserData(n); ImGui::Selectable(label, item_is_selected); } // Apply multi-select requests ms_io = ImGui::EndMultiSelect(); selection->ApplyRequests(ms_io); ImGui::PopID(); } ImGui::TreePop(); } // See ShowExampleAppAssetsBrowser() if (ImGui::TreeNode("Multi-Select (tiled assets browser)")) { ImGui::Checkbox("Assets Browser", &demo_data->ShowAppAssetsBrowser); ImGui::Text("(also access from 'Examples->Assets Browser' in menu)"); ImGui::TreePop(); } // Demonstrate supporting multiple-selection in a tree. // - We don't use linear indices for selection user data, but our ExampleTreeNode* pointer directly! // This showcase how SetNextItemSelectionUserData() never assume indices! // - The difficulty here is to "interpolate" from RangeSrcItem to RangeDstItem in the SetAll/SetRange request. // We want this interpolation to match what the user sees: in visible order, skipping closed nodes. // This is implemented by our TreeGetNextNodeInVisibleOrder() user-space helper. // - Important: In a real codebase aiming to implement full-featured selectable tree with custom filtering, you // are more likely to build an array mapping sequential indices to visible tree nodes, since your // filtering/search + clipping process will benefit from it. Having this will make this interpolation much easier. // - Consider this a prototype: we are working toward simplifying some of it. IMGUI_DEMO_MARKER("Widgets/Selection State/Multi-Select (trees)"); if (ImGui::TreeNode("Multi-Select (trees)")) { HelpMarker( "This is rather advanced and experimental. If you are getting started with multi-select, " "please don't start by looking at how to use it for a tree!\n\n" "Future versions will try to simplify and formalize some of this."); struct ExampleTreeFuncs { static void DrawNode(ExampleTreeNode* node, ImGuiSelectionBasicStorage* selection) { ImGuiTreeNodeFlags tree_node_flags = ImGuiTreeNodeFlags_SpanAvailWidth | ImGuiTreeNodeFlags_OpenOnArrow | ImGuiTreeNodeFlags_OpenOnDoubleClick; tree_node_flags |= ImGuiTreeNodeFlags_NavLeftJumpsBackHere; // Enable pressing left to jump to parent if (node->Childs.Size == 0) tree_node_flags |= ImGuiTreeNodeFlags_Bullet | ImGuiTreeNodeFlags_Leaf; if (selection->Contains((ImGuiID)node->UID)) tree_node_flags |= ImGuiTreeNodeFlags_Selected; // Using SetNextItemStorageID() to specify storage id, so we can easily peek into // the storage holding open/close stage, using our TreeNodeGetOpen/TreeNodeSetOpen() functions. ImGui::SetNextItemSelectionUserData((ImGuiSelectionUserData)(intptr_t)node); ImGui::SetNextItemStorageID((ImGuiID)node->UID); if (ImGui::TreeNodeEx(node->Name, tree_node_flags)) { for (ExampleTreeNode* child : node->Childs) DrawNode(child, selection); ImGui::TreePop(); } else if (ImGui::IsItemToggledOpen()) { TreeCloseAndUnselectChildNodes(node, selection); } } static bool TreeNodeGetOpen(ExampleTreeNode* node) { return ImGui::GetStateStorage()->GetBool((ImGuiID)node->UID); } static void TreeNodeSetOpen(ExampleTreeNode* node, bool open) { ImGui::GetStateStorage()->SetBool((ImGuiID)node->UID, open); } // When closing a node: 1) close and unselect all child nodes, 2) select parent if any child was selected. // FIXME: This is currently handled by user logic but I'm hoping to eventually provide tree node // features to do this automatically, e.g. a ImGuiTreeNodeFlags_AutoCloseChildNodes etc. static int TreeCloseAndUnselectChildNodes(ExampleTreeNode* node, ImGuiSelectionBasicStorage* selection, int depth = 0) { // Recursive close (the test for depth == 0 is because we call this on a node that was just closed!) int unselected_count = selection->Contains((ImGuiID)node->UID) ? 1 : 0; if (depth == 0 || TreeNodeGetOpen(node)) { for (ExampleTreeNode* child : node->Childs) unselected_count += TreeCloseAndUnselectChildNodes(child, selection, depth + 1); TreeNodeSetOpen(node, false); } // Select root node if any of its child was selected, otherwise unselect selection->SetItemSelected((ImGuiID)node->UID, (depth == 0 && unselected_count > 0)); return unselected_count; } // Apply multi-selection requests static void ApplySelectionRequests(ImGuiMultiSelectIO* ms_io, ExampleTreeNode* tree, ImGuiSelectionBasicStorage* selection) { for (ImGuiSelectionRequest& req : ms_io->Requests) { if (req.Type == ImGuiSelectionRequestType_SetAll) { if (req.Selected) TreeSetAllInOpenNodes(tree, selection, req.Selected); else selection->Clear(); } else if (req.Type == ImGuiSelectionRequestType_SetRange) { ExampleTreeNode* first_node = (ExampleTreeNode*)(intptr_t)req.RangeFirstItem; ExampleTreeNode* last_node = (ExampleTreeNode*)(intptr_t)req.RangeLastItem; for (ExampleTreeNode* node = first_node; node != NULL; node = TreeGetNextNodeInVisibleOrder(node, last_node)) selection->SetItemSelected((ImGuiID)node->UID, req.Selected); } } } static void TreeSetAllInOpenNodes(ExampleTreeNode* node, ImGuiSelectionBasicStorage* selection, bool selected) { if (node->Parent != NULL) // Root node isn't visible nor selectable in our scheme selection->SetItemSelected((ImGuiID)node->UID, selected); if (node->Parent == NULL || TreeNodeGetOpen(node)) for (ExampleTreeNode* child : node->Childs) TreeSetAllInOpenNodes(child, selection, selected); } // Interpolate in *user-visible order* AND only *over opened nodes*. // If you have a sequential mapping tables (e.g. generated after a filter/search pass) this would be simpler. // Here the tricks are that: // - we store/maintain ExampleTreeNode::IndexInParent which allows implementing a linear iterator easily, without searches, without recursion. // this could be replaced by a search in parent, aka 'int index_in_parent = curr_node->Parent->Childs.find_index(curr_node)' // which would only be called when crossing from child to a parent, aka not too much. // - we call SetNextItemStorageID() before our TreeNode() calls with an ID which doesn't relate to UI stack, // making it easier to call TreeNodeGetOpen()/TreeNodeSetOpen() from any location. static ExampleTreeNode* TreeGetNextNodeInVisibleOrder(ExampleTreeNode* curr_node, ExampleTreeNode* last_node) { // Reached last node if (curr_node == last_node) return NULL; // Recurse into childs. Query storage to tell if the node is open. if (curr_node->Childs.Size > 0 && TreeNodeGetOpen(curr_node)) return curr_node->Childs[0]; // Next sibling, then into our own parent while (curr_node->Parent != NULL) { if (curr_node->IndexInParent + 1 < curr_node->Parent->Childs.Size) return curr_node->Parent->Childs[curr_node->IndexInParent + 1]; curr_node = curr_node->Parent; } return NULL; } }; // ExampleTreeFuncs static ImGuiSelectionBasicStorage selection; if (demo_data->DemoTree == NULL) demo_data->DemoTree = ExampleTree_CreateDemoTree(); // Create tree once ImGui::Text("Selection size: %d", selection.Size); if (ImGui::BeginChild("##Tree", ImVec2(-FLT_MIN, ImGui::GetFontSize() * 20), ImGuiChildFlags_FrameStyle | ImGuiChildFlags_ResizeY)) { ExampleTreeNode* tree = demo_data->DemoTree; ImGuiMultiSelectFlags ms_flags = ImGuiMultiSelectFlags_ClearOnEscape | ImGuiMultiSelectFlags_BoxSelect2d; ImGuiMultiSelectIO* ms_io = ImGui::BeginMultiSelect(ms_flags, selection.Size, -1); ExampleTreeFuncs::ApplySelectionRequests(ms_io, tree, &selection); for (ExampleTreeNode* node : tree->Childs) ExampleTreeFuncs::DrawNode(node, &selection); ms_io = ImGui::EndMultiSelect(); ExampleTreeFuncs::ApplySelectionRequests(ms_io, tree, &selection); } ImGui::EndChild(); ImGui::TreePop(); } // Advanced demonstration of BeginMultiSelect() // - Showcase clipping. // - Showcase deletion. // - Showcase basic drag and drop. // - Showcase TreeNode variant (note that tree node don't expand in the demo: supporting expanding tree nodes + clipping a separate thing). // - Showcase using inside a table. IMGUI_DEMO_MARKER("Widgets/Selection State/Multi-Select (advanced)"); //ImGui::SetNextItemOpen(true, ImGuiCond_Once); if (ImGui::TreeNode("Multi-Select (advanced)")) { // Options enum WidgetType { WidgetType_Selectable, WidgetType_TreeNode }; static bool use_clipper = true; static bool use_deletion = true; static bool use_drag_drop = true; static bool show_in_table = false; static bool show_color_button = true; static ImGuiMultiSelectFlags flags = ImGuiMultiSelectFlags_ClearOnEscape | ImGuiMultiSelectFlags_BoxSelect1d; static WidgetType widget_type = WidgetType_Selectable; if (ImGui::TreeNode("Options")) { if (ImGui::RadioButton("Selectables", widget_type == WidgetType_Selectable)) { widget_type = WidgetType_Selectable; } ImGui::SameLine(); if (ImGui::RadioButton("Tree nodes", widget_type == WidgetType_TreeNode)) { widget_type = WidgetType_TreeNode; } ImGui::SameLine(); HelpMarker("TreeNode() is technically supported but... using this correctly is more complicated (you need some sort of linear/random access to your tree, which is suited to advanced trees setups already implementing filters and clipper. We will work toward simplifying and demoing this.\n\nFor now the tree demo is actually a little bit meaningless because it is an empty tree with only root nodes."); ImGui::Checkbox("Enable clipper", &use_clipper); ImGui::Checkbox("Enable deletion", &use_deletion); ImGui::Checkbox("Enable drag & drop", &use_drag_drop); ImGui::Checkbox("Show in a table", &show_in_table); ImGui::Checkbox("Show color button", &show_color_button); ImGui::CheckboxFlags("ImGuiMultiSelectFlags_SingleSelect", &flags, ImGuiMultiSelectFlags_SingleSelect); ImGui::CheckboxFlags("ImGuiMultiSelectFlags_NoSelectAll", &flags, ImGuiMultiSelectFlags_NoSelectAll); ImGui::CheckboxFlags("ImGuiMultiSelectFlags_NoRangeSelect", &flags, ImGuiMultiSelectFlags_NoRangeSelect); ImGui::CheckboxFlags("ImGuiMultiSelectFlags_NoAutoSelect", &flags, ImGuiMultiSelectFlags_NoAutoSelect); ImGui::CheckboxFlags("ImGuiMultiSelectFlags_NoAutoClear", &flags, ImGuiMultiSelectFlags_NoAutoClear); ImGui::CheckboxFlags("ImGuiMultiSelectFlags_NoAutoClearOnReselect", &flags, ImGuiMultiSelectFlags_NoAutoClearOnReselect); ImGui::CheckboxFlags("ImGuiMultiSelectFlags_BoxSelect1d", &flags, ImGuiMultiSelectFlags_BoxSelect1d); ImGui::CheckboxFlags("ImGuiMultiSelectFlags_BoxSelect2d", &flags, ImGuiMultiSelectFlags_BoxSelect2d); ImGui::CheckboxFlags("ImGuiMultiSelectFlags_BoxSelectNoScroll", &flags, ImGuiMultiSelectFlags_BoxSelectNoScroll); ImGui::CheckboxFlags("ImGuiMultiSelectFlags_ClearOnEscape", &flags, ImGuiMultiSelectFlags_ClearOnEscape); ImGui::CheckboxFlags("ImGuiMultiSelectFlags_ClearOnClickVoid", &flags, ImGuiMultiSelectFlags_ClearOnClickVoid); if (ImGui::CheckboxFlags("ImGuiMultiSelectFlags_ScopeWindow", &flags, ImGuiMultiSelectFlags_ScopeWindow) && (flags & ImGuiMultiSelectFlags_ScopeWindow)) flags &= ~ImGuiMultiSelectFlags_ScopeRect; if (ImGui::CheckboxFlags("ImGuiMultiSelectFlags_ScopeRect", &flags, ImGuiMultiSelectFlags_ScopeRect) && (flags & ImGuiMultiSelectFlags_ScopeRect)) flags &= ~ImGuiMultiSelectFlags_ScopeWindow; if (ImGui::CheckboxFlags("ImGuiMultiSelectFlags_SelectOnClick", &flags, ImGuiMultiSelectFlags_SelectOnClick) && (flags & ImGuiMultiSelectFlags_SelectOnClick)) flags &= ~ImGuiMultiSelectFlags_SelectOnClickRelease; if (ImGui::CheckboxFlags("ImGuiMultiSelectFlags_SelectOnClickRelease", &flags, ImGuiMultiSelectFlags_SelectOnClickRelease) && (flags & ImGuiMultiSelectFlags_SelectOnClickRelease)) flags &= ~ImGuiMultiSelectFlags_SelectOnClick; ImGui::SameLine(); HelpMarker("Allow dragging an unselected item without altering selection."); ImGui::TreePop(); } // Initialize default list with 1000 items. // Use default selection.Adapter: Pass index to SetNextItemSelectionUserData(), store index in Selection static ImVector items; static int items_next_id = 0; if (items_next_id == 0) { for (int n = 0; n < 1000; n++) { items.push_back(items_next_id++); } } static ExampleSelectionWithDeletion selection; static bool request_deletion_from_menu = false; // Queue deletion triggered from context menu ImGui::Text("Selection size: %d/%d", selection.Size, items.Size); const float items_height = (widget_type == WidgetType_TreeNode) ? ImGui::GetTextLineHeight() : ImGui::GetTextLineHeightWithSpacing(); ImGui::SetNextWindowContentSize(ImVec2(0.0f, items.Size * items_height)); if (ImGui::BeginChild("##Basket", ImVec2(-FLT_MIN, ImGui::GetFontSize() * 20), ImGuiChildFlags_FrameStyle | ImGuiChildFlags_ResizeY)) { ImVec2 color_button_sz(ImGui::GetFontSize(), ImGui::GetFontSize()); if (widget_type == WidgetType_TreeNode) ImGui::PushStyleVarY(ImGuiStyleVar_ItemSpacing, 0.0f); ImGuiMultiSelectIO* ms_io = ImGui::BeginMultiSelect(flags, selection.Size, items.Size); selection.ApplyRequests(ms_io); const bool want_delete = (ImGui::Shortcut(ImGuiKey_Delete, ImGuiInputFlags_Repeat) && (selection.Size > 0)) || request_deletion_from_menu; const int item_curr_idx_to_focus = want_delete ? selection.ApplyDeletionPreLoop(ms_io, items.Size) : -1; request_deletion_from_menu = false; if (show_in_table) { if (widget_type == WidgetType_TreeNode) ImGui::PushStyleVar(ImGuiStyleVar_CellPadding, ImVec2(0.0f, 0.0f)); ImGui::BeginTable("##Split", 2, ImGuiTableFlags_Resizable | ImGuiTableFlags_NoSavedSettings | ImGuiTableFlags_NoPadOuterX); ImGui::TableSetupColumn("", ImGuiTableColumnFlags_WidthStretch, 0.70f); ImGui::TableSetupColumn("", ImGuiTableColumnFlags_WidthStretch, 0.30f); //ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacingY, 0.0f); } ImGuiListClipper clipper; if (use_clipper) { clipper.Begin(items.Size); if (item_curr_idx_to_focus != -1) clipper.IncludeItemByIndex(item_curr_idx_to_focus); // Ensure focused item is not clipped. if (ms_io->RangeSrcItem != -1) clipper.IncludeItemByIndex((int)ms_io->RangeSrcItem); // Ensure RangeSrc item is not clipped. } while (!use_clipper || clipper.Step()) { const int item_begin = use_clipper ? clipper.DisplayStart : 0; const int item_end = use_clipper ? clipper.DisplayEnd : items.Size; for (int n = item_begin; n < item_end; n++) { if (show_in_table) ImGui::TableNextColumn(); const int item_id = items[n]; const char* item_category = ExampleNames[item_id % IM_ARRAYSIZE(ExampleNames)]; char label[64]; sprintf(label, "Object %05d: %s", item_id, item_category); // IMPORTANT: for deletion refocus to work we need object ID to be stable, // aka not depend on their index in the list. Here we use our persistent item_id // instead of index to build a unique ID that will persist. // (If we used PushID(index) instead, focus wouldn't be restored correctly after deletion). ImGui::PushID(item_id); // Emit a color button, to test that Shift+LeftArrow landing on an item that is not part // of the selection scope doesn't erroneously alter our selection. if (show_color_button) { ImU32 dummy_col = (ImU32)((unsigned int)n * 0xC250B74B) | IM_COL32_A_MASK; ImGui::ColorButton("##", ImColor(dummy_col), ImGuiColorEditFlags_NoTooltip, color_button_sz); ImGui::SameLine(); } // Submit item bool item_is_selected = selection.Contains((ImGuiID)n); bool item_is_open = false; ImGui::SetNextItemSelectionUserData(n); if (widget_type == WidgetType_Selectable) { ImGui::Selectable(label, item_is_selected, ImGuiSelectableFlags_None); } else if (widget_type == WidgetType_TreeNode) { ImGuiTreeNodeFlags tree_node_flags = ImGuiTreeNodeFlags_SpanAvailWidth | ImGuiTreeNodeFlags_OpenOnArrow | ImGuiTreeNodeFlags_OpenOnDoubleClick; if (item_is_selected) tree_node_flags |= ImGuiTreeNodeFlags_Selected; item_is_open = ImGui::TreeNodeEx(label, tree_node_flags); } // Focus (for after deletion) if (item_curr_idx_to_focus == n) ImGui::SetKeyboardFocusHere(-1); // Drag and Drop if (use_drag_drop && ImGui::BeginDragDropSource()) { // Create payload with full selection OR single unselected item. // (the later is only possible when using ImGuiMultiSelectFlags_SelectOnClickRelease) if (ImGui::GetDragDropPayload() == NULL) { ImVector payload_items; void* it = NULL; ImGuiID id = 0; if (!item_is_selected) payload_items.push_back(item_id); else while (selection.GetNextSelectedItem(&it, &id)) payload_items.push_back((int)id); ImGui::SetDragDropPayload("MULTISELECT_DEMO_ITEMS", payload_items.Data, (size_t)payload_items.size_in_bytes()); } // Display payload content in tooltip const ImGuiPayload* payload = ImGui::GetDragDropPayload(); const int* payload_items = (int*)payload->Data; const int payload_count = (int)payload->DataSize / (int)sizeof(int); if (payload_count == 1) ImGui::Text("Object %05d: %s", payload_items[0], ExampleNames[payload_items[0] % IM_ARRAYSIZE(ExampleNames)]); else ImGui::Text("Dragging %d objects", payload_count); ImGui::EndDragDropSource(); } if (widget_type == WidgetType_TreeNode && item_is_open) ImGui::TreePop(); // Right-click: context menu if (ImGui::BeginPopupContextItem()) { ImGui::BeginDisabled(!use_deletion || selection.Size == 0); sprintf(label, "Delete %d item(s)###DeleteSelected", selection.Size); if (ImGui::Selectable(label)) request_deletion_from_menu = true; ImGui::EndDisabled(); ImGui::Selectable("Close"); ImGui::EndPopup(); } // Demo content within a table if (show_in_table) { ImGui::TableNextColumn(); ImGui::SetNextItemWidth(-FLT_MIN); ImGui::PushStyleVar(ImGuiStyleVar_FramePadding, ImVec2(0, 0)); ImGui::InputText("###NoLabel", (char*)(void*)item_category, strlen(item_category), ImGuiInputTextFlags_ReadOnly); ImGui::PopStyleVar(); } ImGui::PopID(); } if (!use_clipper) break; } if (show_in_table) { ImGui::EndTable(); if (widget_type == WidgetType_TreeNode) ImGui::PopStyleVar(); } // Apply multi-select requests ms_io = ImGui::EndMultiSelect(); selection.ApplyRequests(ms_io); if (want_delete) selection.ApplyDeletionPostLoop(ms_io, items, item_curr_idx_to_focus); if (widget_type == WidgetType_TreeNode) ImGui::PopStyleVar(); } ImGui::EndChild(); ImGui::TreePop(); } ImGui::TreePop(); } } //----------------------------------------------------------------------------- // [SECTION] DemoWindowWidgetsTabs() //----------------------------------------------------------------------------- static void DemoWindowWidgetsTabs() { IMGUI_DEMO_MARKER("Widgets/Tabs"); if (ImGui::TreeNode("Tabs")) { IMGUI_DEMO_MARKER("Widgets/Tabs/Basic"); if (ImGui::TreeNode("Basic")) { ImGuiTabBarFlags tab_bar_flags = ImGuiTabBarFlags_None; if (ImGui::BeginTabBar("MyTabBar", tab_bar_flags)) { if (ImGui::BeginTabItem("Avocado")) { ImGui::Text("This is the Avocado tab!\nblah blah blah blah blah"); ImGui::EndTabItem(); } if (ImGui::BeginTabItem("Broccoli")) { ImGui::Text("This is the Broccoli tab!\nblah blah blah blah blah"); ImGui::EndTabItem(); } if (ImGui::BeginTabItem("Cucumber")) { ImGui::Text("This is the Cucumber tab!\nblah blah blah blah blah"); ImGui::EndTabItem(); } ImGui::EndTabBar(); } ImGui::Separator(); ImGui::TreePop(); } IMGUI_DEMO_MARKER("Widgets/Tabs/Advanced & Close Button"); if (ImGui::TreeNode("Advanced & Close Button")) { // Expose a couple of the available flags. In most cases you may just call BeginTabBar() with no flags (0). static ImGuiTabBarFlags tab_bar_flags = ImGuiTabBarFlags_Reorderable; ImGui::CheckboxFlags("ImGuiTabBarFlags_Reorderable", &tab_bar_flags, ImGuiTabBarFlags_Reorderable); ImGui::CheckboxFlags("ImGuiTabBarFlags_AutoSelectNewTabs", &tab_bar_flags, ImGuiTabBarFlags_AutoSelectNewTabs); ImGui::CheckboxFlags("ImGuiTabBarFlags_TabListPopupButton", &tab_bar_flags, ImGuiTabBarFlags_TabListPopupButton); ImGui::CheckboxFlags("ImGuiTabBarFlags_NoCloseWithMiddleMouseButton", &tab_bar_flags, ImGuiTabBarFlags_NoCloseWithMiddleMouseButton); ImGui::CheckboxFlags("ImGuiTabBarFlags_DrawSelectedOverline", &tab_bar_flags, ImGuiTabBarFlags_DrawSelectedOverline); if ((tab_bar_flags & ImGuiTabBarFlags_FittingPolicyMask_) == 0) tab_bar_flags |= ImGuiTabBarFlags_FittingPolicyDefault_; if (ImGui::CheckboxFlags("ImGuiTabBarFlags_FittingPolicyResizeDown", &tab_bar_flags, ImGuiTabBarFlags_FittingPolicyResizeDown)) tab_bar_flags &= ~(ImGuiTabBarFlags_FittingPolicyMask_ ^ ImGuiTabBarFlags_FittingPolicyResizeDown); if (ImGui::CheckboxFlags("ImGuiTabBarFlags_FittingPolicyScroll", &tab_bar_flags, ImGuiTabBarFlags_FittingPolicyScroll)) tab_bar_flags &= ~(ImGuiTabBarFlags_FittingPolicyMask_ ^ ImGuiTabBarFlags_FittingPolicyScroll); // Tab Bar ImGui::AlignTextToFramePadding(); ImGui::Text("Opened:"); const char* names[4] = { "Artichoke", "Beetroot", "Celery", "Daikon" }; static bool opened[4] = { true, true, true, true }; // Persistent user state for (int n = 0; n < IM_ARRAYSIZE(opened); n++) { ImGui::SameLine(); ImGui::Checkbox(names[n], &opened[n]); } // Passing a bool* to BeginTabItem() is similar to passing one to Begin(): // the underlying bool will be set to false when the tab is closed. if (ImGui::BeginTabBar("MyTabBar", tab_bar_flags)) { for (int n = 0; n < IM_ARRAYSIZE(opened); n++) if (opened[n] && ImGui::BeginTabItem(names[n], &opened[n], ImGuiTabItemFlags_None)) { ImGui::Text("This is the %s tab!", names[n]); if (n & 1) ImGui::Text("I am an odd tab."); ImGui::EndTabItem(); } ImGui::EndTabBar(); } ImGui::Separator(); ImGui::TreePop(); } IMGUI_DEMO_MARKER("Widgets/Tabs/TabItemButton & Leading-Trailing flags"); if (ImGui::TreeNode("TabItemButton & Leading/Trailing flags")) { static ImVector active_tabs; static int next_tab_id = 0; if (next_tab_id == 0) // Initialize with some default tabs for (int i = 0; i < 3; i++) active_tabs.push_back(next_tab_id++); // TabItemButton() and Leading/Trailing flags are distinct features which we will demo together. // (It is possible to submit regular tabs with Leading/Trailing flags, or TabItemButton tabs without Leading/Trailing flags... // but they tend to make more sense together) static bool show_leading_button = true; static bool show_trailing_button = true; ImGui::Checkbox("Show Leading TabItemButton()", &show_leading_button); ImGui::Checkbox("Show Trailing TabItemButton()", &show_trailing_button); // Expose some other flags which are useful to showcase how they interact with Leading/Trailing tabs static ImGuiTabBarFlags tab_bar_flags = ImGuiTabBarFlags_AutoSelectNewTabs | ImGuiTabBarFlags_Reorderable | ImGuiTabBarFlags_FittingPolicyResizeDown; ImGui::CheckboxFlags("ImGuiTabBarFlags_TabListPopupButton", &tab_bar_flags, ImGuiTabBarFlags_TabListPopupButton); if (ImGui::CheckboxFlags("ImGuiTabBarFlags_FittingPolicyResizeDown", &tab_bar_flags, ImGuiTabBarFlags_FittingPolicyResizeDown)) tab_bar_flags &= ~(ImGuiTabBarFlags_FittingPolicyMask_ ^ ImGuiTabBarFlags_FittingPolicyResizeDown); if (ImGui::CheckboxFlags("ImGuiTabBarFlags_FittingPolicyScroll", &tab_bar_flags, ImGuiTabBarFlags_FittingPolicyScroll)) tab_bar_flags &= ~(ImGuiTabBarFlags_FittingPolicyMask_ ^ ImGuiTabBarFlags_FittingPolicyScroll); if (ImGui::BeginTabBar("MyTabBar", tab_bar_flags)) { // Demo a Leading TabItemButton(): click the "?" button to open a menu if (show_leading_button) if (ImGui::TabItemButton("?", ImGuiTabItemFlags_Leading | ImGuiTabItemFlags_NoTooltip)) ImGui::OpenPopup("MyHelpMenu"); if (ImGui::BeginPopup("MyHelpMenu")) { ImGui::Selectable("Hello!"); ImGui::EndPopup(); } // Demo Trailing Tabs: click the "+" button to add a new tab. // (In your app you may want to use a font icon instead of the "+") // We submit it before the regular tabs, but thanks to the ImGuiTabItemFlags_Trailing flag it will always appear at the end. if (show_trailing_button) if (ImGui::TabItemButton("+", ImGuiTabItemFlags_Trailing | ImGuiTabItemFlags_NoTooltip)) active_tabs.push_back(next_tab_id++); // Add new tab // Submit our regular tabs for (int n = 0; n < active_tabs.Size; ) { bool open = true; char name[16]; snprintf(name, IM_ARRAYSIZE(name), "%04d", active_tabs[n]); if (ImGui::BeginTabItem(name, &open, ImGuiTabItemFlags_None)) { ImGui::Text("This is the %s tab!", name); ImGui::EndTabItem(); } if (!open) active_tabs.erase(active_tabs.Data + n); else n++; } ImGui::EndTabBar(); } ImGui::Separator(); ImGui::TreePop(); } ImGui::TreePop(); } } //----------------------------------------------------------------------------- // [SECTION] DemoWindowWidgetsText() //----------------------------------------------------------------------------- static void DemoWindowWidgetsText() { IMGUI_DEMO_MARKER("Widgets/Text"); if (ImGui::TreeNode("Text")) { IMGUI_DEMO_MARKER("Widgets/Text/Colored Text"); if (ImGui::TreeNode("Colorful Text")) { // Using shortcut. You can use PushStyleColor()/PopStyleColor() for more flexibility. ImGui::TextColored(ImVec4(1.0f, 0.0f, 1.0f, 1.0f), "Pink"); ImGui::TextColored(ImVec4(1.0f, 1.0f, 0.0f, 1.0f), "Yellow"); ImGui::TextDisabled("Disabled"); ImGui::SameLine(); HelpMarker("The TextDisabled color is stored in ImGuiStyle."); ImGui::TreePop(); } IMGUI_DEMO_MARKER("Widgets/Text/Word Wrapping"); if (ImGui::TreeNode("Word Wrapping")) { // Using shortcut. You can use PushTextWrapPos()/PopTextWrapPos() for more flexibility. ImGui::TextWrapped( "This text should automatically wrap on the edge of the window. The current implementation " "for text wrapping follows simple rules suitable for English and possibly other languages."); ImGui::Spacing(); static float wrap_width = 200.0f; ImGui::SliderFloat("Wrap width", &wrap_width, -20, 600, "%.0f"); ImDrawList* draw_list = ImGui::GetWindowDrawList(); for (int n = 0; n < 2; n++) { ImGui::Text("Test paragraph %d:", n); ImVec2 pos = ImGui::GetCursorScreenPos(); ImVec2 marker_min = ImVec2(pos.x + wrap_width, pos.y); ImVec2 marker_max = ImVec2(pos.x + wrap_width + 10, pos.y + ImGui::GetTextLineHeight()); ImGui::PushTextWrapPos(ImGui::GetCursorPos().x + wrap_width); if (n == 0) ImGui::Text("The lazy dog is a good dog. This paragraph should fit within %.0f pixels. Testing a 1 character word. The quick brown fox jumps over the lazy dog.", wrap_width); else ImGui::Text("aaaaaaaa bbbbbbbb, c cccccccc,dddddddd. d eeeeeeee ffffffff. gggggggg!hhhhhhhh"); // Draw actual text bounding box, following by marker of our expected limit (should not overlap!) draw_list->AddRect(ImGui::GetItemRectMin(), ImGui::GetItemRectMax(), IM_COL32(255, 255, 0, 255)); draw_list->AddRectFilled(marker_min, marker_max, IM_COL32(255, 0, 255, 255)); ImGui::PopTextWrapPos(); } ImGui::TreePop(); } IMGUI_DEMO_MARKER("Widgets/Text/UTF-8 Text"); if (ImGui::TreeNode("UTF-8 Text")) { // UTF-8 test with Japanese characters // (Needs a suitable font? Try "Google Noto" or "Arial Unicode". See docs/FONTS.md for details.) // - From C++11 you can use the u8"my text" syntax to encode literal strings as UTF-8 // - For earlier compiler, you may be able to encode your sources as UTF-8 (e.g. in Visual Studio, you // can save your source files as 'UTF-8 without signature'). // - FOR THIS DEMO FILE ONLY, BECAUSE WE WANT TO SUPPORT OLD COMPILERS, WE ARE *NOT* INCLUDING RAW UTF-8 // CHARACTERS IN THIS SOURCE FILE. Instead we are encoding a few strings with hexadecimal constants. // Don't do this in your application! Please use u8"text in any language" in your application! // Note that characters values are preserved even by InputText() if the font cannot be displayed, // so you can safely copy & paste garbled characters into another application. ImGui::TextWrapped( "CJK text will only appear if the font was loaded with the appropriate CJK character ranges. " "Call io.Fonts->AddFontFromFileTTF() manually to load extra character ranges. " "Read docs/FONTS.md for details."); ImGui::Text("Hiragana: \xe3\x81\x8b\xe3\x81\x8d\xe3\x81\x8f\xe3\x81\x91\xe3\x81\x93 (kakikukeko)"); ImGui::Text("Kanjis: \xe6\x97\xa5\xe6\x9c\xac\xe8\xaa\x9e (nihongo)"); static char buf[32] = "\xe6\x97\xa5\xe6\x9c\xac\xe8\xaa\x9e"; //static char buf[32] = u8"NIHONGO"; // <- this is how you would write it with C++11, using real kanjis ImGui::InputText("UTF-8 input", buf, IM_ARRAYSIZE(buf)); ImGui::TreePop(); } ImGui::TreePop(); } } //----------------------------------------------------------------------------- // [SECTION] DemoWindowWidgetsTextFilter() //----------------------------------------------------------------------------- static void DemoWindowWidgetsTextFilter() { IMGUI_DEMO_MARKER("Widgets/Text Filter"); if (ImGui::TreeNode("Text Filter")) { // Helper class to easy setup a text filter. // You may want to implement a more feature-full filtering scheme in your own application. HelpMarker("Not a widget per-se, but ImGuiTextFilter is a helper to perform simple filtering on text strings."); static ImGuiTextFilter filter; ImGui::Text("Filter usage:\n" " \"\" display all lines\n" " \"xxx\" display lines containing \"xxx\"\n" " \"xxx,yyy\" display lines containing \"xxx\" or \"yyy\"\n" " \"-xxx\" hide lines containing \"xxx\""); filter.Draw(); const char* lines[] = { "aaa1.c", "bbb1.c", "ccc1.c", "aaa2.cpp", "bbb2.cpp", "ccc2.cpp", "abc.h", "hello, world" }; for (int i = 0; i < IM_ARRAYSIZE(lines); i++) if (filter.PassFilter(lines[i])) ImGui::BulletText("%s", lines[i]); ImGui::TreePop(); } } //----------------------------------------------------------------------------- // [SECTION] DemoWindowWidgetsTextInput() //----------------------------------------------------------------------------- static void DemoWindowWidgetsTextInput() { // To wire InputText() with std::string or any other custom string type, // see the "Text Input > Resize Callback" section of this demo, and the misc/cpp/imgui_stdlib.h file. IMGUI_DEMO_MARKER("Widgets/Text Input"); if (ImGui::TreeNode("Text Input")) { IMGUI_DEMO_MARKER("Widgets/Text Input/Multi-line Text Input"); if (ImGui::TreeNode("Multi-line Text Input")) { // Note: we are using a fixed-sized buffer for simplicity here. See ImGuiInputTextFlags_CallbackResize // and the code in misc/cpp/imgui_stdlib.h for how to setup InputText() for dynamically resizing strings. static char text[1024 * 16] = "/*\n" " The Pentium F00F bug, shorthand for F0 0F C7 C8,\n" " the hexadecimal encoding of one offending instruction,\n" " more formally, the invalid operand with locked CMPXCHG8B\n" " instruction bug, is a design flaw in the majority of\n" " Intel Pentium, Pentium MMX, and Pentium OverDrive\n" " processors (all in the P5 microarchitecture).\n" "*/\n\n" "label:\n" "\tlock cmpxchg8b eax\n"; static ImGuiInputTextFlags flags = ImGuiInputTextFlags_AllowTabInput; HelpMarker("You can use the ImGuiInputTextFlags_CallbackResize facility if you need to wire InputTextMultiline() to a dynamic string type. See misc/cpp/imgui_stdlib.h for an example. (This is not demonstrated in imgui_demo.cpp because we don't want to include in here)"); ImGui::CheckboxFlags("ImGuiInputTextFlags_ReadOnly", &flags, ImGuiInputTextFlags_ReadOnly); ImGui::CheckboxFlags("ImGuiInputTextFlags_AllowTabInput", &flags, ImGuiInputTextFlags_AllowTabInput); ImGui::SameLine(); HelpMarker("When _AllowTabInput is set, passing through the widget with Tabbing doesn't automatically activate it, in order to also cycling through subsequent widgets."); ImGui::CheckboxFlags("ImGuiInputTextFlags_CtrlEnterForNewLine", &flags, ImGuiInputTextFlags_CtrlEnterForNewLine); ImGui::InputTextMultiline("##source", text, IM_ARRAYSIZE(text), ImVec2(-FLT_MIN, ImGui::GetTextLineHeight() * 16), flags); ImGui::TreePop(); } IMGUI_DEMO_MARKER("Widgets/Text Input/Filtered Text Input"); if (ImGui::TreeNode("Filtered Text Input")) { struct TextFilters { // Modify character input by altering 'data->Eventchar' (ImGuiInputTextFlags_CallbackCharFilter callback) static int FilterCasingSwap(ImGuiInputTextCallbackData* data) { if (data->EventChar >= 'a' && data->EventChar <= 'z') { data->EventChar -= 'a' - 'A'; } // Lowercase becomes uppercase else if (data->EventChar >= 'A' && data->EventChar <= 'Z') { data->EventChar += 'a' - 'A'; } // Uppercase becomes lowercase return 0; } // Return 0 (pass) if the character is 'i' or 'm' or 'g' or 'u' or 'i', otherwise return 1 (filter out) static int FilterImGuiLetters(ImGuiInputTextCallbackData* data) { if (data->EventChar < 256 && strchr("imgui", (char)data->EventChar)) return 0; return 1; } }; static char buf1[32] = ""; ImGui::InputText("default", buf1, 32); static char buf2[32] = ""; ImGui::InputText("decimal", buf2, 32, ImGuiInputTextFlags_CharsDecimal); static char buf3[32] = ""; ImGui::InputText("hexadecimal", buf3, 32, ImGuiInputTextFlags_CharsHexadecimal | ImGuiInputTextFlags_CharsUppercase); static char buf4[32] = ""; ImGui::InputText("uppercase", buf4, 32, ImGuiInputTextFlags_CharsUppercase); static char buf5[32] = ""; ImGui::InputText("no blank", buf5, 32, ImGuiInputTextFlags_CharsNoBlank); static char buf6[32] = ""; ImGui::InputText("casing swap", buf6, 32, ImGuiInputTextFlags_CallbackCharFilter, TextFilters::FilterCasingSwap); // Use CharFilter callback to replace characters. static char buf7[32] = ""; ImGui::InputText("\"imgui\"", buf7, 32, ImGuiInputTextFlags_CallbackCharFilter, TextFilters::FilterImGuiLetters); // Use CharFilter callback to disable some characters. ImGui::TreePop(); } IMGUI_DEMO_MARKER("Widgets/Text Input/Password input"); if (ImGui::TreeNode("Password Input")) { static char password[64] = "password123"; ImGui::InputText("password", password, IM_ARRAYSIZE(password), ImGuiInputTextFlags_Password); ImGui::SameLine(); HelpMarker("Display all characters as '*'.\nDisable clipboard cut and copy.\nDisable logging.\n"); ImGui::InputTextWithHint("password (w/ hint)", "", password, IM_ARRAYSIZE(password), ImGuiInputTextFlags_Password); ImGui::InputText("password (clear)", password, IM_ARRAYSIZE(password)); ImGui::TreePop(); } IMGUI_DEMO_MARKER("Widgets/Text Input/Completion, History, Edit Callbacks"); if (ImGui::TreeNode("Completion, History, Edit Callbacks")) { struct Funcs { static int MyCallback(ImGuiInputTextCallbackData* data) { if (data->EventFlag == ImGuiInputTextFlags_CallbackCompletion) { data->InsertChars(data->CursorPos, ".."); } else if (data->EventFlag == ImGuiInputTextFlags_CallbackHistory) { if (data->EventKey == ImGuiKey_UpArrow) { data->DeleteChars(0, data->BufTextLen); data->InsertChars(0, "Pressed Up!"); data->SelectAll(); } else if (data->EventKey == ImGuiKey_DownArrow) { data->DeleteChars(0, data->BufTextLen); data->InsertChars(0, "Pressed Down!"); data->SelectAll(); } } else if (data->EventFlag == ImGuiInputTextFlags_CallbackEdit) { // Toggle casing of first character char c = data->Buf[0]; if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')) data->Buf[0] ^= 32; data->BufDirty = true; // Increment a counter int* p_int = (int*)data->UserData; *p_int = *p_int + 1; } return 0; } }; static char buf1[64]; ImGui::InputText("Completion", buf1, 64, ImGuiInputTextFlags_CallbackCompletion, Funcs::MyCallback); ImGui::SameLine(); HelpMarker( "Here we append \"..\" each time Tab is pressed. " "See 'Examples>Console' for a more meaningful demonstration of using this callback."); static char buf2[64]; ImGui::InputText("History", buf2, 64, ImGuiInputTextFlags_CallbackHistory, Funcs::MyCallback); ImGui::SameLine(); HelpMarker( "Here we replace and select text each time Up/Down are pressed. " "See 'Examples>Console' for a more meaningful demonstration of using this callback."); static char buf3[64]; static int edit_count = 0; ImGui::InputText("Edit", buf3, 64, ImGuiInputTextFlags_CallbackEdit, Funcs::MyCallback, (void*)&edit_count); ImGui::SameLine(); HelpMarker( "Here we toggle the casing of the first character on every edit + count edits."); ImGui::SameLine(); ImGui::Text("(%d)", edit_count); ImGui::TreePop(); } IMGUI_DEMO_MARKER("Widgets/Text Input/Resize Callback"); if (ImGui::TreeNode("Resize Callback")) { // To wire InputText() with std::string or any other custom string type, // you can use the ImGuiInputTextFlags_CallbackResize flag + create a custom ImGui::InputText() wrapper // using your preferred type. See misc/cpp/imgui_stdlib.h for an implementation of this using std::string. HelpMarker( "Using ImGuiInputTextFlags_CallbackResize to wire your custom string type to InputText().\n\n" "See misc/cpp/imgui_stdlib.h for an implementation of this for std::string."); struct Funcs { static int MyResizeCallback(ImGuiInputTextCallbackData* data) { if (data->EventFlag == ImGuiInputTextFlags_CallbackResize) { ImVector* my_str = (ImVector*)data->UserData; IM_ASSERT(my_str->begin() == data->Buf); my_str->resize(data->BufSize); // NB: On resizing calls, generally data->BufSize == data->BufTextLen + 1 data->Buf = my_str->begin(); } return 0; } // Note: Because ImGui:: is a namespace you would typically add your own function into the namespace. // For example, you code may declare a function 'ImGui::InputText(const char* label, MyString* my_str)' static bool MyInputTextMultiline(const char* label, ImVector* my_str, const ImVec2& size = ImVec2(0, 0), ImGuiInputTextFlags flags = 0) { IM_ASSERT((flags & ImGuiInputTextFlags_CallbackResize) == 0); return ImGui::InputTextMultiline(label, my_str->begin(), (size_t)my_str->size(), size, flags | ImGuiInputTextFlags_CallbackResize, Funcs::MyResizeCallback, (void*)my_str); } }; // For this demo we are using ImVector as a string container. // Note that because we need to store a terminating zero character, our size/capacity are 1 more // than usually reported by a typical string class. static ImVector my_str; if (my_str.empty()) my_str.push_back(0); Funcs::MyInputTextMultiline("##MyStr", &my_str, ImVec2(-FLT_MIN, ImGui::GetTextLineHeight() * 16)); ImGui::Text("Data: %p\nSize: %d\nCapacity: %d", (void*)my_str.begin(), my_str.size(), my_str.capacity()); ImGui::TreePop(); } IMGUI_DEMO_MARKER("Widgets/Text Input/Eliding, Alignment"); if (ImGui::TreeNode("Eliding, Alignment")) { static char buf1[128] = "/path/to/some/folder/with/long/filename.cpp"; static ImGuiInputTextFlags flags = ImGuiInputTextFlags_ElideLeft; ImGui::CheckboxFlags("ImGuiInputTextFlags_ElideLeft", &flags, ImGuiInputTextFlags_ElideLeft); ImGui::InputText("Path", buf1, IM_ARRAYSIZE(buf1), flags); ImGui::TreePop(); } IMGUI_DEMO_MARKER("Widgets/Text Input/Miscellaneous"); if (ImGui::TreeNode("Miscellaneous")) { static char buf1[16]; static ImGuiInputTextFlags flags = ImGuiInputTextFlags_EscapeClearsAll; ImGui::CheckboxFlags("ImGuiInputTextFlags_EscapeClearsAll", &flags, ImGuiInputTextFlags_EscapeClearsAll); ImGui::CheckboxFlags("ImGuiInputTextFlags_ReadOnly", &flags, ImGuiInputTextFlags_ReadOnly); ImGui::CheckboxFlags("ImGuiInputTextFlags_NoUndoRedo", &flags, ImGuiInputTextFlags_NoUndoRedo); ImGui::InputText("Hello", buf1, IM_ARRAYSIZE(buf1), flags); ImGui::TreePop(); } ImGui::TreePop(); } } //----------------------------------------------------------------------------- // [SECTION] DemoWindowWidgetsTooltips() //----------------------------------------------------------------------------- static void DemoWindowWidgetsTooltips() { IMGUI_DEMO_MARKER("Widgets/Tooltips"); if (ImGui::TreeNode("Tooltips")) { // Tooltips are windows following the mouse. They do not take focus away. ImGui::SeparatorText("General"); // Typical use cases: // - Short-form (text only): SetItemTooltip("Hello"); // - Short-form (any contents): if (BeginItemTooltip()) { Text("Hello"); EndTooltip(); } // - Full-form (text only): if (IsItemHovered(...)) { SetTooltip("Hello"); } // - Full-form (any contents): if (IsItemHovered(...) && BeginTooltip()) { Text("Hello"); EndTooltip(); } HelpMarker( "Tooltip are typically created by using a IsItemHovered() + SetTooltip() sequence.\n\n" "We provide a helper SetItemTooltip() function to perform the two with standards flags."); ImVec2 sz = ImVec2(-FLT_MIN, 0.0f); ImGui::Button("Basic", sz); ImGui::SetItemTooltip("I am a tooltip"); ImGui::Button("Fancy", sz); if (ImGui::BeginItemTooltip()) { ImGui::Text("I am a fancy tooltip"); static float arr[] = { 0.6f, 0.1f, 1.0f, 0.5f, 0.92f, 0.1f, 0.2f }; ImGui::PlotLines("Curve", arr, IM_ARRAYSIZE(arr)); ImGui::Text("Sin(time) = %f", sinf((float)ImGui::GetTime())); ImGui::EndTooltip(); } ImGui::SeparatorText("Always On"); // Showcase NOT relying on a IsItemHovered() to emit a tooltip. // Here the tooltip is always emitted when 'always_on == true'. static int always_on = 0; ImGui::RadioButton("Off", &always_on, 0); ImGui::SameLine(); ImGui::RadioButton("Always On (Simple)", &always_on, 1); ImGui::SameLine(); ImGui::RadioButton("Always On (Advanced)", &always_on, 2); if (always_on == 1) ImGui::SetTooltip("I am following you around."); else if (always_on == 2 && ImGui::BeginTooltip()) { ImGui::ProgressBar(sinf((float)ImGui::GetTime()) * 0.5f + 0.5f, ImVec2(ImGui::GetFontSize() * 25, 0.0f)); ImGui::EndTooltip(); } ImGui::SeparatorText("Custom"); HelpMarker( "Passing ImGuiHoveredFlags_ForTooltip to IsItemHovered() is the preferred way to standardize " "tooltip activation details across your application. You may however decide to use custom " "flags for a specific tooltip instance."); // The following examples are passed for documentation purpose but may not be useful to most users. // Passing ImGuiHoveredFlags_ForTooltip to IsItemHovered() will pull ImGuiHoveredFlags flags values from // 'style.HoverFlagsForTooltipMouse' or 'style.HoverFlagsForTooltipNav' depending on whether mouse or keyboard/gamepad is being used. // With default settings, ImGuiHoveredFlags_ForTooltip is equivalent to ImGuiHoveredFlags_DelayShort + ImGuiHoveredFlags_Stationary. ImGui::Button("Manual", sz); if (ImGui::IsItemHovered(ImGuiHoveredFlags_ForTooltip)) ImGui::SetTooltip("I am a manually emitted tooltip."); ImGui::Button("DelayNone", sz); if (ImGui::IsItemHovered(ImGuiHoveredFlags_DelayNone)) ImGui::SetTooltip("I am a tooltip with no delay."); ImGui::Button("DelayShort", sz); if (ImGui::IsItemHovered(ImGuiHoveredFlags_DelayShort | ImGuiHoveredFlags_NoSharedDelay)) ImGui::SetTooltip("I am a tooltip with a short delay (%0.2f sec).", ImGui::GetStyle().HoverDelayShort); ImGui::Button("DelayLong", sz); if (ImGui::IsItemHovered(ImGuiHoveredFlags_DelayNormal | ImGuiHoveredFlags_NoSharedDelay)) ImGui::SetTooltip("I am a tooltip with a long delay (%0.2f sec).", ImGui::GetStyle().HoverDelayNormal); ImGui::Button("Stationary", sz); if (ImGui::IsItemHovered(ImGuiHoveredFlags_Stationary)) ImGui::SetTooltip("I am a tooltip requiring mouse to be stationary before activating."); // Using ImGuiHoveredFlags_ForTooltip will pull flags from 'style.HoverFlagsForTooltipMouse' or 'style.HoverFlagsForTooltipNav', // which default value include the ImGuiHoveredFlags_AllowWhenDisabled flag. ImGui::BeginDisabled(); ImGui::Button("Disabled item", sz); if (ImGui::IsItemHovered(ImGuiHoveredFlags_ForTooltip)) ImGui::SetTooltip("I am a a tooltip for a disabled item."); ImGui::EndDisabled(); ImGui::TreePop(); } } //----------------------------------------------------------------------------- // [SECTION] DemoWindowWidgetsTreeNodes() //----------------------------------------------------------------------------- static void DemoWindowWidgetsTreeNodes() { IMGUI_DEMO_MARKER("Widgets/Tree Nodes"); if (ImGui::TreeNode("Tree Nodes")) { IMGUI_DEMO_MARKER("Widgets/Tree Nodes/Basic trees"); if (ImGui::TreeNode("Basic trees")) { for (int i = 0; i < 5; i++) { // Use SetNextItemOpen() so set the default state of a node to be open. We could // also use TreeNodeEx() with the ImGuiTreeNodeFlags_DefaultOpen flag to achieve the same thing! if (i == 0) ImGui::SetNextItemOpen(true, ImGuiCond_Once); // Here we use PushID() to generate a unique base ID, and then the "" used as TreeNode id won't conflict. // An alternative to using 'PushID() + TreeNode("", ...)' to generate a unique ID is to use 'TreeNode((void*)(intptr_t)i, ...)', // aka generate a dummy pointer-sized value to be hashed. The demo below uses that technique. Both are fine. ImGui::PushID(i); if (ImGui::TreeNode("", "Child %d", i)) { ImGui::Text("blah blah"); ImGui::SameLine(); if (ImGui::SmallButton("button")) {} ImGui::TreePop(); } ImGui::PopID(); } ImGui::TreePop(); } IMGUI_DEMO_MARKER("Widgets/Tree Nodes/Advanced, with Selectable nodes"); if (ImGui::TreeNode("Advanced, with Selectable nodes")) { HelpMarker( "This is a more typical looking tree with selectable nodes.\n" "Click to select, CTRL+Click to toggle, click on arrows or double-click to open."); static ImGuiTreeNodeFlags base_flags = ImGuiTreeNodeFlags_OpenOnArrow | ImGuiTreeNodeFlags_OpenOnDoubleClick | ImGuiTreeNodeFlags_SpanAvailWidth; static bool align_label_with_current_x_position = false; static bool test_drag_and_drop = false; ImGui::CheckboxFlags("ImGuiTreeNodeFlags_OpenOnArrow", &base_flags, ImGuiTreeNodeFlags_OpenOnArrow); ImGui::CheckboxFlags("ImGuiTreeNodeFlags_OpenOnDoubleClick", &base_flags, ImGuiTreeNodeFlags_OpenOnDoubleClick); ImGui::CheckboxFlags("ImGuiTreeNodeFlags_SpanAvailWidth", &base_flags, ImGuiTreeNodeFlags_SpanAvailWidth); ImGui::SameLine(); HelpMarker("Extend hit area to all available width instead of allowing more items to be laid out after the node."); ImGui::CheckboxFlags("ImGuiTreeNodeFlags_SpanFullWidth", &base_flags, ImGuiTreeNodeFlags_SpanFullWidth); ImGui::CheckboxFlags("ImGuiTreeNodeFlags_SpanLabelWidth", &base_flags, ImGuiTreeNodeFlags_SpanLabelWidth); ImGui::SameLine(); HelpMarker("Reduce hit area to the text label and a bit of margin."); ImGui::CheckboxFlags("ImGuiTreeNodeFlags_SpanAllColumns", &base_flags, ImGuiTreeNodeFlags_SpanAllColumns); ImGui::SameLine(); HelpMarker("For use in Tables only."); ImGui::CheckboxFlags("ImGuiTreeNodeFlags_AllowOverlap", &base_flags, ImGuiTreeNodeFlags_AllowOverlap); ImGui::CheckboxFlags("ImGuiTreeNodeFlags_Framed", &base_flags, ImGuiTreeNodeFlags_Framed); ImGui::SameLine(); HelpMarker("Draw frame with background (e.g. for CollapsingHeader)"); ImGui::CheckboxFlags("ImGuiTreeNodeFlags_NavLeftJumpsBackHere", &base_flags, ImGuiTreeNodeFlags_NavLeftJumpsBackHere); ImGui::Checkbox("Align label with current X position", &align_label_with_current_x_position); ImGui::Checkbox("Test tree node as drag source", &test_drag_and_drop); ImGui::Text("Hello!"); if (align_label_with_current_x_position) ImGui::Unindent(ImGui::GetTreeNodeToLabelSpacing()); // 'selection_mask' is dumb representation of what may be user-side selection state. // You may retain selection state inside or outside your objects in whatever format you see fit. // 'node_clicked' is temporary storage of what node we have clicked to process selection at the end /// of the loop. May be a pointer to your own node type, etc. static int selection_mask = (1 << 2); int node_clicked = -1; for (int i = 0; i < 6; i++) { // Disable the default "open on single-click behavior" + set Selected flag according to our selection. // To alter selection we use IsItemClicked() && !IsItemToggledOpen(), so clicking on an arrow doesn't alter selection. ImGuiTreeNodeFlags node_flags = base_flags; const bool is_selected = (selection_mask & (1 << i)) != 0; if (is_selected) node_flags |= ImGuiTreeNodeFlags_Selected; if (i < 3) { // Items 0..2 are Tree Node bool node_open = ImGui::TreeNodeEx((void*)(intptr_t)i, node_flags, "Selectable Node %d", i); if (ImGui::IsItemClicked() && !ImGui::IsItemToggledOpen()) node_clicked = i; if (test_drag_and_drop && ImGui::BeginDragDropSource()) { ImGui::SetDragDropPayload("_TREENODE", NULL, 0); ImGui::Text("This is a drag and drop source"); ImGui::EndDragDropSource(); } if (i == 2 && (base_flags & ImGuiTreeNodeFlags_SpanLabelWidth)) { // Item 2 has an additional inline button to help demonstrate SpanLabelWidth. ImGui::SameLine(); if (ImGui::SmallButton("button")) {} } if (node_open) { ImGui::BulletText("Blah blah\nBlah Blah"); ImGui::SameLine(); ImGui::SmallButton("Button"); ImGui::TreePop(); } } else { // Items 3..5 are Tree Leaves // The only reason we use TreeNode at all is to allow selection of the leaf. Otherwise we can // use BulletText() or advance the cursor by GetTreeNodeToLabelSpacing() and call Text(). node_flags |= ImGuiTreeNodeFlags_Leaf | ImGuiTreeNodeFlags_NoTreePushOnOpen; // ImGuiTreeNodeFlags_Bullet ImGui::TreeNodeEx((void*)(intptr_t)i, node_flags, "Selectable Leaf %d", i); if (ImGui::IsItemClicked() && !ImGui::IsItemToggledOpen()) node_clicked = i; if (test_drag_and_drop && ImGui::BeginDragDropSource()) { ImGui::SetDragDropPayload("_TREENODE", NULL, 0); ImGui::Text("This is a drag and drop source"); ImGui::EndDragDropSource(); } } } if (node_clicked != -1) { // Update selection state // (process outside of tree loop to avoid visual inconsistencies during the clicking frame) if (ImGui::GetIO().KeyCtrl) selection_mask ^= (1 << node_clicked); // CTRL+click to toggle else //if (!(selection_mask & (1 << node_clicked))) // Depending on selection behavior you want, may want to preserve selection when clicking on item that is part of the selection selection_mask = (1 << node_clicked); // Click to single-select } if (align_label_with_current_x_position) ImGui::Indent(ImGui::GetTreeNodeToLabelSpacing()); ImGui::TreePop(); } ImGui::TreePop(); } } //----------------------------------------------------------------------------- // [SECTION] DemoWindowWidgetsVerticalSliders() //----------------------------------------------------------------------------- static void DemoWindowWidgetsVerticalSliders() { IMGUI_DEMO_MARKER("Widgets/Vertical Sliders"); if (ImGui::TreeNode("Vertical Sliders")) { const float spacing = 4; ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, ImVec2(spacing, spacing)); static int int_value = 0; ImGui::VSliderInt("##int", ImVec2(18, 160), &int_value, 0, 5); ImGui::SameLine(); static float values[7] = { 0.0f, 0.60f, 0.35f, 0.9f, 0.70f, 0.20f, 0.0f }; ImGui::PushID("set1"); for (int i = 0; i < 7; i++) { if (i > 0) ImGui::SameLine(); ImGui::PushID(i); ImGui::PushStyleColor(ImGuiCol_FrameBg, (ImVec4)ImColor::HSV(i / 7.0f, 0.5f, 0.5f)); ImGui::PushStyleColor(ImGuiCol_FrameBgHovered, (ImVec4)ImColor::HSV(i / 7.0f, 0.6f, 0.5f)); ImGui::PushStyleColor(ImGuiCol_FrameBgActive, (ImVec4)ImColor::HSV(i / 7.0f, 0.7f, 0.5f)); ImGui::PushStyleColor(ImGuiCol_SliderGrab, (ImVec4)ImColor::HSV(i / 7.0f, 0.9f, 0.9f)); ImGui::VSliderFloat("##v", ImVec2(18, 160), &values[i], 0.0f, 1.0f, ""); if (ImGui::IsItemActive() || ImGui::IsItemHovered()) ImGui::SetTooltip("%.3f", values[i]); ImGui::PopStyleColor(4); ImGui::PopID(); } ImGui::PopID(); ImGui::SameLine(); ImGui::PushID("set2"); static float values2[4] = { 0.20f, 0.80f, 0.40f, 0.25f }; const int rows = 3; const ImVec2 small_slider_size(18, (float)(int)((160.0f - (rows - 1) * spacing) / rows)); for (int nx = 0; nx < 4; nx++) { if (nx > 0) ImGui::SameLine(); ImGui::BeginGroup(); for (int ny = 0; ny < rows; ny++) { ImGui::PushID(nx * rows + ny); ImGui::VSliderFloat("##v", small_slider_size, &values2[nx], 0.0f, 1.0f, ""); if (ImGui::IsItemActive() || ImGui::IsItemHovered()) ImGui::SetTooltip("%.3f", values2[nx]); ImGui::PopID(); } ImGui::EndGroup(); } ImGui::PopID(); ImGui::SameLine(); ImGui::PushID("set3"); for (int i = 0; i < 4; i++) { if (i > 0) ImGui::SameLine(); ImGui::PushID(i); ImGui::PushStyleVar(ImGuiStyleVar_GrabMinSize, 40); ImGui::VSliderFloat("##v", ImVec2(40, 160), &values[i], 0.0f, 1.0f, "%.2f\nsec"); ImGui::PopStyleVar(); ImGui::PopID(); } ImGui::PopID(); ImGui::PopStyleVar(); ImGui::TreePop(); } } //----------------------------------------------------------------------------- // [SECTION] DemoWindowWidgets() //----------------------------------------------------------------------------- static void DemoWindowWidgets(ImGuiDemoWindowData* demo_data) { IMGUI_DEMO_MARKER("Widgets"); //ImGui::SetNextItemOpen(true, ImGuiCond_Once); if (!ImGui::CollapsingHeader("Widgets")) return; const bool disable_all = demo_data->DisableSections; // The Checkbox for that is inside the "Disabled" section at the bottom if (disable_all) ImGui::BeginDisabled(); DemoWindowWidgetsBasic(); DemoWindowWidgetsBullets(); DemoWindowWidgetsCollapsingHeaders(); DemoWindowWidgetsComboBoxes(); DemoWindowWidgetsColorAndPickers(); DemoWindowWidgetsDataTypes(); if (disable_all) ImGui::EndDisabled(); DemoWindowWidgetsDisableBlocks(demo_data); if (disable_all) ImGui::BeginDisabled(); DemoWindowWidgetsDragAndDrop(); DemoWindowWidgetsDragsAndSliders(); DemoWindowWidgetsImages(); DemoWindowWidgetsListBoxes(); DemoWindowWidgetsMultiComponents(); DemoWindowWidgetsPlotting(); DemoWindowWidgetsProgressBars(); DemoWindowWidgetsQueryingStatuses(); DemoWindowWidgetsSelectables(); DemoWindowWidgetsSelectionAndMultiSelect(demo_data); DemoWindowWidgetsTabs(); DemoWindowWidgetsText(); DemoWindowWidgetsTextFilter(); DemoWindowWidgetsTextInput(); DemoWindowWidgetsTooltips(); DemoWindowWidgetsTreeNodes(); DemoWindowWidgetsVerticalSliders(); if (disable_all) ImGui::EndDisabled(); } //----------------------------------------------------------------------------- // [SECTION] DemoWindowLayout() //----------------------------------------------------------------------------- static void DemoWindowLayout() { IMGUI_DEMO_MARKER("Layout"); if (!ImGui::CollapsingHeader("Layout & Scrolling")) return; IMGUI_DEMO_MARKER("Layout/Child windows"); if (ImGui::TreeNode("Child windows")) { ImGui::SeparatorText("Child windows"); HelpMarker("Use child windows to begin into a self-contained independent scrolling/clipping regions within a host window."); static bool disable_mouse_wheel = false; static bool disable_menu = false; ImGui::Checkbox("Disable Mouse Wheel", &disable_mouse_wheel); ImGui::Checkbox("Disable Menu", &disable_menu); // Child 1: no border, enable horizontal scrollbar { ImGuiWindowFlags window_flags = ImGuiWindowFlags_HorizontalScrollbar; if (disable_mouse_wheel) window_flags |= ImGuiWindowFlags_NoScrollWithMouse; ImGui::BeginChild("ChildL", ImVec2(ImGui::GetContentRegionAvail().x * 0.5f, 260), ImGuiChildFlags_None, window_flags); for (int i = 0; i < 100; i++) ImGui::Text("%04d: scrollable region", i); ImGui::EndChild(); } ImGui::SameLine(); // Child 2: rounded border { ImGuiWindowFlags window_flags = ImGuiWindowFlags_None; if (disable_mouse_wheel) window_flags |= ImGuiWindowFlags_NoScrollWithMouse; if (!disable_menu) window_flags |= ImGuiWindowFlags_MenuBar; ImGui::PushStyleVar(ImGuiStyleVar_ChildRounding, 5.0f); ImGui::BeginChild("ChildR", ImVec2(0, 260), ImGuiChildFlags_Borders, window_flags); if (!disable_menu && ImGui::BeginMenuBar()) { if (ImGui::BeginMenu("Menu")) { ShowExampleMenuFile(); ImGui::EndMenu(); } ImGui::EndMenuBar(); } if (ImGui::BeginTable("split", 2, ImGuiTableFlags_Resizable | ImGuiTableFlags_NoSavedSettings)) { for (int i = 0; i < 100; i++) { char buf[32]; sprintf(buf, "%03d", i); ImGui::TableNextColumn(); ImGui::Button(buf, ImVec2(-FLT_MIN, 0.0f)); } ImGui::EndTable(); } ImGui::EndChild(); ImGui::PopStyleVar(); } // Child 3: manual-resize ImGui::SeparatorText("Manual-resize"); { HelpMarker("Drag bottom border to resize. Double-click bottom border to auto-fit to vertical contents."); //if (ImGui::Button("Set Height to 200")) // ImGui::SetNextWindowSize(ImVec2(-FLT_MIN, 200.0f)); ImGui::PushStyleColor(ImGuiCol_ChildBg, ImGui::GetStyleColorVec4(ImGuiCol_FrameBg)); if (ImGui::BeginChild("ResizableChild", ImVec2(-FLT_MIN, ImGui::GetTextLineHeightWithSpacing() * 8), ImGuiChildFlags_Borders | ImGuiChildFlags_ResizeY)) for (int n = 0; n < 10; n++) ImGui::Text("Line %04d", n); ImGui::PopStyleColor(); ImGui::EndChild(); } // Child 4: auto-resizing height with a limit ImGui::SeparatorText("Auto-resize with constraints"); { static int draw_lines = 3; static int max_height_in_lines = 10; ImGui::SetNextItemWidth(ImGui::GetFontSize() * 8); ImGui::DragInt("Lines Count", &draw_lines, 0.2f); ImGui::SetNextItemWidth(ImGui::GetFontSize() * 8); ImGui::DragInt("Max Height (in Lines)", &max_height_in_lines, 0.2f); ImGui::SetNextWindowSizeConstraints(ImVec2(0.0f, ImGui::GetTextLineHeightWithSpacing() * 1), ImVec2(FLT_MAX, ImGui::GetTextLineHeightWithSpacing() * max_height_in_lines)); if (ImGui::BeginChild("ConstrainedChild", ImVec2(-FLT_MIN, 0.0f), ImGuiChildFlags_Borders | ImGuiChildFlags_AutoResizeY)) for (int n = 0; n < draw_lines; n++) ImGui::Text("Line %04d", n); ImGui::EndChild(); } ImGui::SeparatorText("Misc/Advanced"); // Demonstrate a few extra things // - Changing ImGuiCol_ChildBg (which is transparent black in default styles) // - Using SetCursorPos() to position child window (the child window is an item from the POV of parent window) // You can also call SetNextWindowPos() to position the child window. The parent window will effectively // layout from this position. // - Using ImGui::GetItemRectMin/Max() to query the "item" state (because the child window is an item from // the POV of the parent window). See 'Demo->Querying Status (Edited/Active/Hovered etc.)' for details. { static int offset_x = 0; static bool override_bg_color = true; static ImGuiChildFlags child_flags = ImGuiChildFlags_Borders | ImGuiChildFlags_ResizeX | ImGuiChildFlags_ResizeY; ImGui::SetNextItemWidth(ImGui::GetFontSize() * 8); ImGui::DragInt("Offset X", &offset_x, 1.0f, -1000, 1000); ImGui::Checkbox("Override ChildBg color", &override_bg_color); ImGui::CheckboxFlags("ImGuiChildFlags_Borders", &child_flags, ImGuiChildFlags_Borders); ImGui::CheckboxFlags("ImGuiChildFlags_AlwaysUseWindowPadding", &child_flags, ImGuiChildFlags_AlwaysUseWindowPadding); ImGui::CheckboxFlags("ImGuiChildFlags_ResizeX", &child_flags, ImGuiChildFlags_ResizeX); ImGui::CheckboxFlags("ImGuiChildFlags_ResizeY", &child_flags, ImGuiChildFlags_ResizeY); ImGui::CheckboxFlags("ImGuiChildFlags_FrameStyle", &child_flags, ImGuiChildFlags_FrameStyle); ImGui::SameLine(); HelpMarker("Style the child window like a framed item: use FrameBg, FrameRounding, FrameBorderSize, FramePadding instead of ChildBg, ChildRounding, ChildBorderSize, WindowPadding."); if (child_flags & ImGuiChildFlags_FrameStyle) override_bg_color = false; ImGui::SetCursorPosX(ImGui::GetCursorPosX() + (float)offset_x); if (override_bg_color) ImGui::PushStyleColor(ImGuiCol_ChildBg, IM_COL32(255, 0, 0, 100)); ImGui::BeginChild("Red", ImVec2(200, 100), child_flags, ImGuiWindowFlags_None); if (override_bg_color) ImGui::PopStyleColor(); for (int n = 0; n < 50; n++) ImGui::Text("Some test %d", n); ImGui::EndChild(); bool child_is_hovered = ImGui::IsItemHovered(); ImVec2 child_rect_min = ImGui::GetItemRectMin(); ImVec2 child_rect_max = ImGui::GetItemRectMax(); ImGui::Text("Hovered: %d", child_is_hovered); ImGui::Text("Rect of child window is: (%.0f,%.0f) (%.0f,%.0f)", child_rect_min.x, child_rect_min.y, child_rect_max.x, child_rect_max.y); } ImGui::TreePop(); } IMGUI_DEMO_MARKER("Layout/Widgets Width"); if (ImGui::TreeNode("Widgets Width")) { static float f = 0.0f; static bool show_indented_items = true; ImGui::Checkbox("Show indented items", &show_indented_items); // Use SetNextItemWidth() to set the width of a single upcoming item. // Use PushItemWidth()/PopItemWidth() to set the width of a group of items. // In real code use you'll probably want to choose width values that are proportional to your font size // e.g. Using '20.0f * GetFontSize()' as width instead of '200.0f', etc. ImGui::Text("SetNextItemWidth/PushItemWidth(100)"); ImGui::SameLine(); HelpMarker("Fixed width."); ImGui::PushItemWidth(100); ImGui::DragFloat("float##1b", &f); if (show_indented_items) { ImGui::Indent(); ImGui::DragFloat("float (indented)##1b", &f); ImGui::Unindent(); } ImGui::PopItemWidth(); ImGui::Text("SetNextItemWidth/PushItemWidth(-100)"); ImGui::SameLine(); HelpMarker("Align to right edge minus 100"); ImGui::PushItemWidth(-100); ImGui::DragFloat("float##2a", &f); if (show_indented_items) { ImGui::Indent(); ImGui::DragFloat("float (indented)##2b", &f); ImGui::Unindent(); } ImGui::PopItemWidth(); ImGui::Text("SetNextItemWidth/PushItemWidth(GetContentRegionAvail().x * 0.5f)"); ImGui::SameLine(); HelpMarker("Half of available width.\n(~ right-cursor_pos)\n(works within a column set)"); ImGui::PushItemWidth(ImGui::GetContentRegionAvail().x * 0.5f); ImGui::DragFloat("float##3a", &f); if (show_indented_items) { ImGui::Indent(); ImGui::DragFloat("float (indented)##3b", &f); ImGui::Unindent(); } ImGui::PopItemWidth(); ImGui::Text("SetNextItemWidth/PushItemWidth(-GetContentRegionAvail().x * 0.5f)"); ImGui::SameLine(); HelpMarker("Align to right edge minus half"); ImGui::PushItemWidth(-ImGui::GetContentRegionAvail().x * 0.5f); ImGui::DragFloat("float##4a", &f); if (show_indented_items) { ImGui::Indent(); ImGui::DragFloat("float (indented)##4b", &f); ImGui::Unindent(); } ImGui::PopItemWidth(); // Demonstrate using PushItemWidth to surround three items. // Calling SetNextItemWidth() before each of them would have the same effect. ImGui::Text("SetNextItemWidth/PushItemWidth(-FLT_MIN)"); ImGui::SameLine(); HelpMarker("Align to right edge"); ImGui::PushItemWidth(-FLT_MIN); ImGui::DragFloat("##float5a", &f); if (show_indented_items) { ImGui::Indent(); ImGui::DragFloat("float (indented)##5b", &f); ImGui::Unindent(); } ImGui::PopItemWidth(); ImGui::TreePop(); } IMGUI_DEMO_MARKER("Layout/Basic Horizontal Layout"); if (ImGui::TreeNode("Basic Horizontal Layout")) { ImGui::TextWrapped("(Use ImGui::SameLine() to keep adding items to the right of the preceding item)"); // Text IMGUI_DEMO_MARKER("Layout/Basic Horizontal Layout/SameLine"); ImGui::Text("Two items: Hello"); ImGui::SameLine(); ImGui::TextColored(ImVec4(1, 1, 0, 1), "Sailor"); // Adjust spacing ImGui::Text("More spacing: Hello"); ImGui::SameLine(0, 20); ImGui::TextColored(ImVec4(1, 1, 0, 1), "Sailor"); // Button ImGui::AlignTextToFramePadding(); ImGui::Text("Normal buttons"); ImGui::SameLine(); ImGui::Button("Banana"); ImGui::SameLine(); ImGui::Button("Apple"); ImGui::SameLine(); ImGui::Button("Corniflower"); // Button ImGui::Text("Small buttons"); ImGui::SameLine(); ImGui::SmallButton("Like this one"); ImGui::SameLine(); ImGui::Text("can fit within a text block."); // Aligned to arbitrary position. Easy/cheap column. IMGUI_DEMO_MARKER("Layout/Basic Horizontal Layout/SameLine (with offset)"); ImGui::Text("Aligned"); ImGui::SameLine(150); ImGui::Text("x=150"); ImGui::SameLine(300); ImGui::Text("x=300"); ImGui::Text("Aligned"); ImGui::SameLine(150); ImGui::SmallButton("x=150"); ImGui::SameLine(300); ImGui::SmallButton("x=300"); // Checkbox IMGUI_DEMO_MARKER("Layout/Basic Horizontal Layout/SameLine (more)"); static bool c1 = false, c2 = false, c3 = false, c4 = false; ImGui::Checkbox("My", &c1); ImGui::SameLine(); ImGui::Checkbox("Tailor", &c2); ImGui::SameLine(); ImGui::Checkbox("Is", &c3); ImGui::SameLine(); ImGui::Checkbox("Rich", &c4); // Various static float f0 = 1.0f, f1 = 2.0f, f2 = 3.0f; ImGui::PushItemWidth(80); const char* items[] = { "AAAA", "BBBB", "CCCC", "DDDD" }; static int item = -1; ImGui::Combo("Combo", &item, items, IM_ARRAYSIZE(items)); ImGui::SameLine(); ImGui::SliderFloat("X", &f0, 0.0f, 5.0f); ImGui::SameLine(); ImGui::SliderFloat("Y", &f1, 0.0f, 5.0f); ImGui::SameLine(); ImGui::SliderFloat("Z", &f2, 0.0f, 5.0f); ImGui::PopItemWidth(); ImGui::PushItemWidth(80); ImGui::Text("Lists:"); static int selection[4] = { 0, 1, 2, 3 }; for (int i = 0; i < 4; i++) { if (i > 0) ImGui::SameLine(); ImGui::PushID(i); ImGui::ListBox("", &selection[i], items, IM_ARRAYSIZE(items)); ImGui::PopID(); //ImGui::SetItemTooltip("ListBox %d hovered", i); } ImGui::PopItemWidth(); // Dummy IMGUI_DEMO_MARKER("Layout/Basic Horizontal Layout/Dummy"); ImVec2 button_sz(40, 40); ImGui::Button("A", button_sz); ImGui::SameLine(); ImGui::Dummy(button_sz); ImGui::SameLine(); ImGui::Button("B", button_sz); // Manually wrapping // (we should eventually provide this as an automatic layout feature, but for now you can do it manually) IMGUI_DEMO_MARKER("Layout/Basic Horizontal Layout/Manual wrapping"); ImGui::Text("Manual wrapping:"); ImGuiStyle& style = ImGui::GetStyle(); int buttons_count = 20; float window_visible_x2 = ImGui::GetCursorScreenPos().x + ImGui::GetContentRegionAvail().x; for (int n = 0; n < buttons_count; n++) { ImGui::PushID(n); ImGui::Button("Box", button_sz); float last_button_x2 = ImGui::GetItemRectMax().x; float next_button_x2 = last_button_x2 + style.ItemSpacing.x + button_sz.x; // Expected position if next button was on same line if (n + 1 < buttons_count && next_button_x2 < window_visible_x2) ImGui::SameLine(); ImGui::PopID(); } ImGui::TreePop(); } IMGUI_DEMO_MARKER("Layout/Groups"); if (ImGui::TreeNode("Groups")) { HelpMarker( "BeginGroup() basically locks the horizontal position for new line. " "EndGroup() bundles the whole group so that you can use \"item\" functions such as " "IsItemHovered()/IsItemActive() or SameLine() etc. on the whole group."); ImGui::BeginGroup(); { ImGui::BeginGroup(); ImGui::Button("AAA"); ImGui::SameLine(); ImGui::Button("BBB"); ImGui::SameLine(); ImGui::BeginGroup(); ImGui::Button("CCC"); ImGui::Button("DDD"); ImGui::EndGroup(); ImGui::SameLine(); ImGui::Button("EEE"); ImGui::EndGroup(); ImGui::SetItemTooltip("First group hovered"); } // Capture the group size and create widgets using the same size ImVec2 size = ImGui::GetItemRectSize(); const float values[5] = { 0.5f, 0.20f, 0.80f, 0.60f, 0.25f }; ImGui::PlotHistogram("##values", values, IM_ARRAYSIZE(values), 0, NULL, 0.0f, 1.0f, size); ImGui::Button("ACTION", ImVec2((size.x - ImGui::GetStyle().ItemSpacing.x) * 0.5f, size.y)); ImGui::SameLine(); ImGui::Button("REACTION", ImVec2((size.x - ImGui::GetStyle().ItemSpacing.x) * 0.5f, size.y)); ImGui::EndGroup(); ImGui::SameLine(); ImGui::Button("LEVERAGE\nBUZZWORD", size); ImGui::SameLine(); if (ImGui::BeginListBox("List", size)) { ImGui::Selectable("Selected", true); ImGui::Selectable("Not Selected", false); ImGui::EndListBox(); } ImGui::TreePop(); } IMGUI_DEMO_MARKER("Layout/Text Baseline Alignment"); if (ImGui::TreeNode("Text Baseline Alignment")) { { ImGui::BulletText("Text baseline:"); ImGui::SameLine(); HelpMarker( "This is testing the vertical alignment that gets applied on text to keep it aligned with widgets. " "Lines only composed of text or \"small\" widgets use less vertical space than lines with framed widgets."); ImGui::Indent(); ImGui::Text("KO Blahblah"); ImGui::SameLine(); ImGui::Button("Some framed item"); ImGui::SameLine(); HelpMarker("Baseline of button will look misaligned with text.."); // If your line starts with text, call AlignTextToFramePadding() to align text to upcoming widgets. // (because we don't know what's coming after the Text() statement, we need to move the text baseline // down by FramePadding.y ahead of time) ImGui::AlignTextToFramePadding(); ImGui::Text("OK Blahblah"); ImGui::SameLine(); ImGui::Button("Some framed item##2"); ImGui::SameLine(); HelpMarker("We call AlignTextToFramePadding() to vertically align the text baseline by +FramePadding.y"); // SmallButton() uses the same vertical padding as Text ImGui::Button("TEST##1"); ImGui::SameLine(); ImGui::Text("TEST"); ImGui::SameLine(); ImGui::SmallButton("TEST##2"); // If your line starts with text, call AlignTextToFramePadding() to align text to upcoming widgets. ImGui::AlignTextToFramePadding(); ImGui::Text("Text aligned to framed item"); ImGui::SameLine(); ImGui::Button("Item##1"); ImGui::SameLine(); ImGui::Text("Item"); ImGui::SameLine(); ImGui::SmallButton("Item##2"); ImGui::SameLine(); ImGui::Button("Item##3"); ImGui::Unindent(); } ImGui::Spacing(); { ImGui::BulletText("Multi-line text:"); ImGui::Indent(); ImGui::Text("One\nTwo\nThree"); ImGui::SameLine(); ImGui::Text("Hello\nWorld"); ImGui::SameLine(); ImGui::Text("Banana"); ImGui::Text("Banana"); ImGui::SameLine(); ImGui::Text("Hello\nWorld"); ImGui::SameLine(); ImGui::Text("One\nTwo\nThree"); ImGui::Button("HOP##1"); ImGui::SameLine(); ImGui::Text("Banana"); ImGui::SameLine(); ImGui::Text("Hello\nWorld"); ImGui::SameLine(); ImGui::Text("Banana"); ImGui::Button("HOP##2"); ImGui::SameLine(); ImGui::Text("Hello\nWorld"); ImGui::SameLine(); ImGui::Text("Banana"); ImGui::Unindent(); } ImGui::Spacing(); { ImGui::BulletText("Misc items:"); ImGui::Indent(); // SmallButton() sets FramePadding to zero. Text baseline is aligned to match baseline of previous Button. ImGui::Button("80x80", ImVec2(80, 80)); ImGui::SameLine(); ImGui::Button("50x50", ImVec2(50, 50)); ImGui::SameLine(); ImGui::Button("Button()"); ImGui::SameLine(); ImGui::SmallButton("SmallButton()"); // Tree const float spacing = ImGui::GetStyle().ItemInnerSpacing.x; ImGui::Button("Button##1"); ImGui::SameLine(0.0f, spacing); if (ImGui::TreeNode("Node##1")) { // Placeholder tree data for (int i = 0; i < 6; i++) ImGui::BulletText("Item %d..", i); ImGui::TreePop(); } // Vertically align text node a bit lower so it'll be vertically centered with upcoming widget. // Otherwise you can use SmallButton() (smaller fit). ImGui::AlignTextToFramePadding(); // Common mistake to avoid: if we want to SameLine after TreeNode we need to do it before we add // other contents below the node. bool node_open = ImGui::TreeNode("Node##2"); ImGui::SameLine(0.0f, spacing); ImGui::Button("Button##2"); if (node_open) { // Placeholder tree data for (int i = 0; i < 6; i++) ImGui::BulletText("Item %d..", i); ImGui::TreePop(); } // Bullet ImGui::Button("Button##3"); ImGui::SameLine(0.0f, spacing); ImGui::BulletText("Bullet text"); ImGui::AlignTextToFramePadding(); ImGui::BulletText("Node"); ImGui::SameLine(0.0f, spacing); ImGui::Button("Button##4"); ImGui::Unindent(); } ImGui::TreePop(); } IMGUI_DEMO_MARKER("Layout/Scrolling"); if (ImGui::TreeNode("Scrolling")) { // Vertical scroll functions IMGUI_DEMO_MARKER("Layout/Scrolling/Vertical"); HelpMarker("Use SetScrollHereY() or SetScrollFromPosY() to scroll to a given vertical position."); static int track_item = 50; static bool enable_track = true; static bool enable_extra_decorations = false; static float scroll_to_off_px = 0.0f; static float scroll_to_pos_px = 200.0f; ImGui::Checkbox("Decoration", &enable_extra_decorations); ImGui::Checkbox("Track", &enable_track); ImGui::PushItemWidth(100); ImGui::SameLine(140); enable_track |= ImGui::DragInt("##item", &track_item, 0.25f, 0, 99, "Item = %d"); bool scroll_to_off = ImGui::Button("Scroll Offset"); ImGui::SameLine(140); scroll_to_off |= ImGui::DragFloat("##off", &scroll_to_off_px, 1.00f, 0, FLT_MAX, "+%.0f px"); bool scroll_to_pos = ImGui::Button("Scroll To Pos"); ImGui::SameLine(140); scroll_to_pos |= ImGui::DragFloat("##pos", &scroll_to_pos_px, 1.00f, -10, FLT_MAX, "X/Y = %.0f px"); ImGui::PopItemWidth(); if (scroll_to_off || scroll_to_pos) enable_track = false; ImGuiStyle& style = ImGui::GetStyle(); float child_w = (ImGui::GetContentRegionAvail().x - 4 * style.ItemSpacing.x) / 5; if (child_w < 1.0f) child_w = 1.0f; ImGui::PushID("##VerticalScrolling"); for (int i = 0; i < 5; i++) { if (i > 0) ImGui::SameLine(); ImGui::BeginGroup(); const char* names[] = { "Top", "25%", "Center", "75%", "Bottom" }; ImGui::TextUnformatted(names[i]); const ImGuiWindowFlags child_flags = enable_extra_decorations ? ImGuiWindowFlags_MenuBar : 0; const ImGuiID child_id = ImGui::GetID((void*)(intptr_t)i); const bool child_is_visible = ImGui::BeginChild(child_id, ImVec2(child_w, 200.0f), ImGuiChildFlags_Borders, child_flags); if (ImGui::BeginMenuBar()) { ImGui::TextUnformatted("abc"); ImGui::EndMenuBar(); } if (scroll_to_off) ImGui::SetScrollY(scroll_to_off_px); if (scroll_to_pos) ImGui::SetScrollFromPosY(ImGui::GetCursorStartPos().y + scroll_to_pos_px, i * 0.25f); if (child_is_visible) // Avoid calling SetScrollHereY when running with culled items { for (int item = 0; item < 100; item++) { if (enable_track && item == track_item) { ImGui::TextColored(ImVec4(1, 1, 0, 1), "Item %d", item); ImGui::SetScrollHereY(i * 0.25f); // 0.0f:top, 0.5f:center, 1.0f:bottom } else { ImGui::Text("Item %d", item); } } } float scroll_y = ImGui::GetScrollY(); float scroll_max_y = ImGui::GetScrollMaxY(); ImGui::EndChild(); ImGui::Text("%.0f/%.0f", scroll_y, scroll_max_y); ImGui::EndGroup(); } ImGui::PopID(); // Horizontal scroll functions IMGUI_DEMO_MARKER("Layout/Scrolling/Horizontal"); ImGui::Spacing(); HelpMarker( "Use SetScrollHereX() or SetScrollFromPosX() to scroll to a given horizontal position.\n\n" "Because the clipping rectangle of most window hides half worth of WindowPadding on the " "left/right, using SetScrollFromPosX(+1) will usually result in clipped text whereas the " "equivalent SetScrollFromPosY(+1) wouldn't."); ImGui::PushID("##HorizontalScrolling"); for (int i = 0; i < 5; i++) { float child_height = ImGui::GetTextLineHeight() + style.ScrollbarSize + style.WindowPadding.y * 2.0f; ImGuiWindowFlags child_flags = ImGuiWindowFlags_HorizontalScrollbar | (enable_extra_decorations ? ImGuiWindowFlags_AlwaysVerticalScrollbar : 0); ImGuiID child_id = ImGui::GetID((void*)(intptr_t)i); bool child_is_visible = ImGui::BeginChild(child_id, ImVec2(-100, child_height), ImGuiChildFlags_Borders, child_flags); if (scroll_to_off) ImGui::SetScrollX(scroll_to_off_px); if (scroll_to_pos) ImGui::SetScrollFromPosX(ImGui::GetCursorStartPos().x + scroll_to_pos_px, i * 0.25f); if (child_is_visible) // Avoid calling SetScrollHereY when running with culled items { for (int item = 0; item < 100; item++) { if (item > 0) ImGui::SameLine(); if (enable_track && item == track_item) { ImGui::TextColored(ImVec4(1, 1, 0, 1), "Item %d", item); ImGui::SetScrollHereX(i * 0.25f); // 0.0f:left, 0.5f:center, 1.0f:right } else { ImGui::Text("Item %d", item); } } } float scroll_x = ImGui::GetScrollX(); float scroll_max_x = ImGui::GetScrollMaxX(); ImGui::EndChild(); ImGui::SameLine(); const char* names[] = { "Left", "25%", "Center", "75%", "Right" }; ImGui::Text("%s\n%.0f/%.0f", names[i], scroll_x, scroll_max_x); ImGui::Spacing(); } ImGui::PopID(); // Miscellaneous Horizontal Scrolling Demo IMGUI_DEMO_MARKER("Layout/Scrolling/Horizontal (more)"); HelpMarker( "Horizontal scrolling for a window is enabled via the ImGuiWindowFlags_HorizontalScrollbar flag.\n\n" "You may want to also explicitly specify content width by using SetNextWindowContentWidth() before Begin()."); static int lines = 7; ImGui::SliderInt("Lines", &lines, 1, 15); ImGui::PushStyleVar(ImGuiStyleVar_FrameRounding, 3.0f); ImGui::PushStyleVar(ImGuiStyleVar_FramePadding, ImVec2(2.0f, 1.0f)); ImVec2 scrolling_child_size = ImVec2(0, ImGui::GetFrameHeightWithSpacing() * 7 + 30); ImGui::BeginChild("scrolling", scrolling_child_size, ImGuiChildFlags_Borders, ImGuiWindowFlags_HorizontalScrollbar); for (int line = 0; line < lines; line++) { // Display random stuff. For the sake of this trivial demo we are using basic Button() + SameLine() // If you want to create your own time line for a real application you may be better off manipulating // the cursor position yourself, aka using SetCursorPos/SetCursorScreenPos to position the widgets // yourself. You may also want to use the lower-level ImDrawList API. int num_buttons = 10 + ((line & 1) ? line * 9 : line * 3); for (int n = 0; n < num_buttons; n++) { if (n > 0) ImGui::SameLine(); ImGui::PushID(n + line * 1000); char num_buf[16]; sprintf(num_buf, "%d", n); const char* label = (!(n % 15)) ? "FizzBuzz" : (!(n % 3)) ? "Fizz" : (!(n % 5)) ? "Buzz" : num_buf; float hue = n * 0.05f; ImGui::PushStyleColor(ImGuiCol_Button, (ImVec4)ImColor::HSV(hue, 0.6f, 0.6f)); ImGui::PushStyleColor(ImGuiCol_ButtonHovered, (ImVec4)ImColor::HSV(hue, 0.7f, 0.7f)); ImGui::PushStyleColor(ImGuiCol_ButtonActive, (ImVec4)ImColor::HSV(hue, 0.8f, 0.8f)); ImGui::Button(label, ImVec2(40.0f + sinf((float)(line + n)) * 20.0f, 0.0f)); ImGui::PopStyleColor(3); ImGui::PopID(); } } float scroll_x = ImGui::GetScrollX(); float scroll_max_x = ImGui::GetScrollMaxX(); ImGui::EndChild(); ImGui::PopStyleVar(2); float scroll_x_delta = 0.0f; ImGui::SmallButton("<<"); if (ImGui::IsItemActive()) scroll_x_delta = -ImGui::GetIO().DeltaTime * 1000.0f; ImGui::SameLine(); ImGui::Text("Scroll from code"); ImGui::SameLine(); ImGui::SmallButton(">>"); if (ImGui::IsItemActive()) scroll_x_delta = +ImGui::GetIO().DeltaTime * 1000.0f; ImGui::SameLine(); ImGui::Text("%.0f/%.0f", scroll_x, scroll_max_x); if (scroll_x_delta != 0.0f) { // Demonstrate a trick: you can use Begin to set yourself in the context of another window // (here we are already out of your child window) ImGui::BeginChild("scrolling"); ImGui::SetScrollX(ImGui::GetScrollX() + scroll_x_delta); ImGui::EndChild(); } ImGui::Spacing(); static bool show_horizontal_contents_size_demo_window = false; ImGui::Checkbox("Show Horizontal contents size demo window", &show_horizontal_contents_size_demo_window); if (show_horizontal_contents_size_demo_window) { static bool show_h_scrollbar = true; static bool show_button = true; static bool show_tree_nodes = true; static bool show_text_wrapped = false; static bool show_columns = true; static bool show_tab_bar = true; static bool show_child = false; static bool explicit_content_size = false; static float contents_size_x = 300.0f; if (explicit_content_size) ImGui::SetNextWindowContentSize(ImVec2(contents_size_x, 0.0f)); ImGui::Begin("Horizontal contents size demo window", &show_horizontal_contents_size_demo_window, show_h_scrollbar ? ImGuiWindowFlags_HorizontalScrollbar : 0); IMGUI_DEMO_MARKER("Layout/Scrolling/Horizontal contents size demo window"); ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, ImVec2(2, 0)); ImGui::PushStyleVar(ImGuiStyleVar_FramePadding, ImVec2(2, 0)); HelpMarker( "Test how different widgets react and impact the work rectangle growing when horizontal scrolling is enabled.\n\n" "Use 'Metrics->Tools->Show windows rectangles' to visualize rectangles."); ImGui::Checkbox("H-scrollbar", &show_h_scrollbar); ImGui::Checkbox("Button", &show_button); // Will grow contents size (unless explicitly overwritten) ImGui::Checkbox("Tree nodes", &show_tree_nodes); // Will grow contents size and display highlight over full width ImGui::Checkbox("Text wrapped", &show_text_wrapped);// Will grow and use contents size ImGui::Checkbox("Columns", &show_columns); // Will use contents size ImGui::Checkbox("Tab bar", &show_tab_bar); // Will use contents size ImGui::Checkbox("Child", &show_child); // Will grow and use contents size ImGui::Checkbox("Explicit content size", &explicit_content_size); ImGui::Text("Scroll %.1f/%.1f %.1f/%.1f", ImGui::GetScrollX(), ImGui::GetScrollMaxX(), ImGui::GetScrollY(), ImGui::GetScrollMaxY()); if (explicit_content_size) { ImGui::SameLine(); ImGui::SetNextItemWidth(100); ImGui::DragFloat("##csx", &contents_size_x); ImVec2 p = ImGui::GetCursorScreenPos(); ImGui::GetWindowDrawList()->AddRectFilled(p, ImVec2(p.x + 10, p.y + 10), IM_COL32_WHITE); ImGui::GetWindowDrawList()->AddRectFilled(ImVec2(p.x + contents_size_x - 10, p.y), ImVec2(p.x + contents_size_x, p.y + 10), IM_COL32_WHITE); ImGui::Dummy(ImVec2(0, 10)); } ImGui::PopStyleVar(2); ImGui::Separator(); if (show_button) { ImGui::Button("this is a 300-wide button", ImVec2(300, 0)); } if (show_tree_nodes) { bool open = true; if (ImGui::TreeNode("this is a tree node")) { if (ImGui::TreeNode("another one of those tree node...")) { ImGui::Text("Some tree contents"); ImGui::TreePop(); } ImGui::TreePop(); } ImGui::CollapsingHeader("CollapsingHeader", &open); } if (show_text_wrapped) { ImGui::TextWrapped("This text should automatically wrap on the edge of the work rectangle."); } if (show_columns) { ImGui::Text("Tables:"); if (ImGui::BeginTable("table", 4, ImGuiTableFlags_Borders)) { for (int n = 0; n < 4; n++) { ImGui::TableNextColumn(); ImGui::Text("Width %.2f", ImGui::GetContentRegionAvail().x); } ImGui::EndTable(); } ImGui::Text("Columns:"); ImGui::Columns(4); for (int n = 0; n < 4; n++) { ImGui::Text("Width %.2f", ImGui::GetColumnWidth()); ImGui::NextColumn(); } ImGui::Columns(1); } if (show_tab_bar && ImGui::BeginTabBar("Hello")) { if (ImGui::BeginTabItem("OneOneOne")) { ImGui::EndTabItem(); } if (ImGui::BeginTabItem("TwoTwoTwo")) { ImGui::EndTabItem(); } if (ImGui::BeginTabItem("ThreeThreeThree")) { ImGui::EndTabItem(); } if (ImGui::BeginTabItem("FourFourFour")) { ImGui::EndTabItem(); } ImGui::EndTabBar(); } if (show_child) { ImGui::BeginChild("child", ImVec2(0, 0), ImGuiChildFlags_Borders); ImGui::EndChild(); } ImGui::End(); } ImGui::TreePop(); } IMGUI_DEMO_MARKER("Layout/Text Clipping"); if (ImGui::TreeNode("Text Clipping")) { static ImVec2 size(100.0f, 100.0f); static ImVec2 offset(30.0f, 30.0f); ImGui::DragFloat2("size", (float*)&size, 0.5f, 1.0f, 200.0f, "%.0f"); ImGui::TextWrapped("(Click and drag to scroll)"); HelpMarker( "(Left) Using ImGui::PushClipRect():\n" "Will alter ImGui hit-testing logic + ImDrawList rendering.\n" "(use this if you want your clipping rectangle to affect interactions)\n\n" "(Center) Using ImDrawList::PushClipRect():\n" "Will alter ImDrawList rendering only.\n" "(use this as a shortcut if you are only using ImDrawList calls)\n\n" "(Right) Using ImDrawList::AddText() with a fine ClipRect:\n" "Will alter only this specific ImDrawList::AddText() rendering.\n" "This is often used internally to avoid altering the clipping rectangle and minimize draw calls."); for (int n = 0; n < 3; n++) { if (n > 0) ImGui::SameLine(); ImGui::PushID(n); ImGui::InvisibleButton("##canvas", size); if (ImGui::IsItemActive() && ImGui::IsMouseDragging(ImGuiMouseButton_Left)) { offset.x += ImGui::GetIO().MouseDelta.x; offset.y += ImGui::GetIO().MouseDelta.y; } ImGui::PopID(); if (!ImGui::IsItemVisible()) // Skip rendering as ImDrawList elements are not clipped. continue; const ImVec2 p0 = ImGui::GetItemRectMin(); const ImVec2 p1 = ImGui::GetItemRectMax(); const char* text_str = "Line 1 hello\nLine 2 clip me!"; const ImVec2 text_pos = ImVec2(p0.x + offset.x, p0.y + offset.y); ImDrawList* draw_list = ImGui::GetWindowDrawList(); switch (n) { case 0: ImGui::PushClipRect(p0, p1, true); draw_list->AddRectFilled(p0, p1, IM_COL32(90, 90, 120, 255)); draw_list->AddText(text_pos, IM_COL32_WHITE, text_str); ImGui::PopClipRect(); break; case 1: draw_list->PushClipRect(p0, p1, true); draw_list->AddRectFilled(p0, p1, IM_COL32(90, 90, 120, 255)); draw_list->AddText(text_pos, IM_COL32_WHITE, text_str); draw_list->PopClipRect(); break; case 2: ImVec4 clip_rect(p0.x, p0.y, p1.x, p1.y); // AddText() takes a ImVec4* here so let's convert. draw_list->AddRectFilled(p0, p1, IM_COL32(90, 90, 120, 255)); draw_list->AddText(ImGui::GetFont(), ImGui::GetFontSize(), text_pos, IM_COL32_WHITE, text_str, NULL, 0.0f, &clip_rect); break; } } ImGui::TreePop(); } IMGUI_DEMO_MARKER("Layout/Overlap Mode"); if (ImGui::TreeNode("Overlap Mode")) { static bool enable_allow_overlap = true; HelpMarker( "Hit-testing is by default performed in item submission order, which generally is perceived as 'back-to-front'.\n\n" "By using SetNextItemAllowOverlap() you can notify that an item may be overlapped by another. " "Doing so alters the hovering logic: items using AllowOverlap mode requires an extra frame to accept hovered state."); ImGui::Checkbox("Enable AllowOverlap", &enable_allow_overlap); ImVec2 button1_pos = ImGui::GetCursorScreenPos(); ImVec2 button2_pos = ImVec2(button1_pos.x + 50.0f, button1_pos.y + 50.0f); if (enable_allow_overlap) ImGui::SetNextItemAllowOverlap(); ImGui::Button("Button 1", ImVec2(80, 80)); ImGui::SetCursorScreenPos(button2_pos); ImGui::Button("Button 2", ImVec2(80, 80)); // This is typically used with width-spanning items. // (note that Selectable() has a dedicated flag ImGuiSelectableFlags_AllowOverlap, which is a shortcut // for using SetNextItemAllowOverlap(). For demo purpose we use SetNextItemAllowOverlap() here.) if (enable_allow_overlap) ImGui::SetNextItemAllowOverlap(); ImGui::Selectable("Some Selectable", false); ImGui::SameLine(); ImGui::SmallButton("++"); ImGui::TreePop(); } } //----------------------------------------------------------------------------- // [SECTION] DemoWindowPopups() //----------------------------------------------------------------------------- static void DemoWindowPopups() { IMGUI_DEMO_MARKER("Popups"); if (!ImGui::CollapsingHeader("Popups & Modal windows")) return; // The properties of popups windows are: // - They block normal mouse hovering detection outside them. (*) // - Unless modal, they can be closed by clicking anywhere outside them, or by pressing ESCAPE. // - Their visibility state (~bool) is held internally by Dear ImGui instead of being held by the programmer as // we are used to with regular Begin() calls. User can manipulate the visibility state by calling OpenPopup(). // (*) One can use IsItemHovered(ImGuiHoveredFlags_AllowWhenBlockedByPopup) to bypass it and detect hovering even // when normally blocked by a popup. // Those three properties are connected. The library needs to hold their visibility state BECAUSE it can close // popups at any time. // Typical use for regular windows: // bool my_tool_is_active = false; if (ImGui::Button("Open")) my_tool_is_active = true; [...] if (my_tool_is_active) Begin("My Tool", &my_tool_is_active) { [...] } End(); // Typical use for popups: // if (ImGui::Button("Open")) ImGui::OpenPopup("MyPopup"); if (ImGui::BeginPopup("MyPopup") { [...] EndPopup(); } // With popups we have to go through a library call (here OpenPopup) to manipulate the visibility state. // This may be a bit confusing at first but it should quickly make sense. Follow on the examples below. IMGUI_DEMO_MARKER("Popups/Popups"); if (ImGui::TreeNode("Popups")) { ImGui::TextWrapped( "When a popup is active, it inhibits interacting with windows that are behind the popup. " "Clicking outside the popup closes it."); static int selected_fish = -1; const char* names[] = { "Bream", "Haddock", "Mackerel", "Pollock", "Tilefish" }; static bool toggles[] = { true, false, false, false, false }; // Simple selection popup (if you want to show the current selection inside the Button itself, // you may want to build a string using the "###" operator to preserve a constant ID with a variable label) if (ImGui::Button("Select..")) ImGui::OpenPopup("my_select_popup"); ImGui::SameLine(); ImGui::TextUnformatted(selected_fish == -1 ? "" : names[selected_fish]); if (ImGui::BeginPopup("my_select_popup")) { ImGui::SeparatorText("Aquarium"); for (int i = 0; i < IM_ARRAYSIZE(names); i++) if (ImGui::Selectable(names[i])) selected_fish = i; ImGui::EndPopup(); } // Showing a menu with toggles if (ImGui::Button("Toggle..")) ImGui::OpenPopup("my_toggle_popup"); if (ImGui::BeginPopup("my_toggle_popup")) { for (int i = 0; i < IM_ARRAYSIZE(names); i++) ImGui::MenuItem(names[i], "", &toggles[i]); if (ImGui::BeginMenu("Sub-menu")) { ImGui::MenuItem("Click me"); ImGui::EndMenu(); } ImGui::Separator(); ImGui::Text("Tooltip here"); ImGui::SetItemTooltip("I am a tooltip over a popup"); if (ImGui::Button("Stacked Popup")) ImGui::OpenPopup("another popup"); if (ImGui::BeginPopup("another popup")) { for (int i = 0; i < IM_ARRAYSIZE(names); i++) ImGui::MenuItem(names[i], "", &toggles[i]); if (ImGui::BeginMenu("Sub-menu")) { ImGui::MenuItem("Click me"); if (ImGui::Button("Stacked Popup")) ImGui::OpenPopup("another popup"); if (ImGui::BeginPopup("another popup")) { ImGui::Text("I am the last one here."); ImGui::EndPopup(); } ImGui::EndMenu(); } ImGui::EndPopup(); } ImGui::EndPopup(); } // Call the more complete ShowExampleMenuFile which we use in various places of this demo if (ImGui::Button("With a menu..")) ImGui::OpenPopup("my_file_popup"); if (ImGui::BeginPopup("my_file_popup", ImGuiWindowFlags_MenuBar)) { if (ImGui::BeginMenuBar()) { if (ImGui::BeginMenu("File")) { ShowExampleMenuFile(); ImGui::EndMenu(); } if (ImGui::BeginMenu("Edit")) { ImGui::MenuItem("Dummy"); ImGui::EndMenu(); } ImGui::EndMenuBar(); } ImGui::Text("Hello from popup!"); ImGui::Button("This is a dummy button.."); ImGui::EndPopup(); } ImGui::TreePop(); } IMGUI_DEMO_MARKER("Popups/Context menus"); if (ImGui::TreeNode("Context menus")) { HelpMarker("\"Context\" functions are simple helpers to associate a Popup to a given Item or Window identifier."); // BeginPopupContextItem() is a helper to provide common/simple popup behavior of essentially doing: // if (id == 0) // id = GetItemID(); // Use last item id // if (IsItemHovered() && IsMouseReleased(ImGuiMouseButton_Right)) // OpenPopup(id); // return BeginPopup(id); // For advanced uses you may want to replicate and customize this code. // See more details in BeginPopupContextItem(). // Example 1 // When used after an item that has an ID (e.g. Button), we can skip providing an ID to BeginPopupContextItem(), // and BeginPopupContextItem() will use the last item ID as the popup ID. { const char* names[5] = { "Label1", "Label2", "Label3", "Label4", "Label5" }; static int selected = -1; for (int n = 0; n < 5; n++) { if (ImGui::Selectable(names[n], selected == n)) selected = n; if (ImGui::BeginPopupContextItem()) // <-- use last item id as popup id { selected = n; ImGui::Text("This a popup for \"%s\"!", names[n]); if (ImGui::Button("Close")) ImGui::CloseCurrentPopup(); ImGui::EndPopup(); } ImGui::SetItemTooltip("Right-click to open popup"); } } // Example 2 // Popup on a Text() element which doesn't have an identifier: we need to provide an identifier to BeginPopupContextItem(). // Using an explicit identifier is also convenient if you want to activate the popups from different locations. { HelpMarker("Text() elements don't have stable identifiers so we need to provide one."); static float value = 0.5f; ImGui::Text("Value = %.3f <-- (1) right-click this text", value); if (ImGui::BeginPopupContextItem("my popup")) { if (ImGui::Selectable("Set to zero")) value = 0.0f; if (ImGui::Selectable("Set to PI")) value = 3.1415f; ImGui::SetNextItemWidth(-FLT_MIN); ImGui::DragFloat("##Value", &value, 0.1f, 0.0f, 0.0f); ImGui::EndPopup(); } // We can also use OpenPopupOnItemClick() to toggle the visibility of a given popup. // Here we make it that right-clicking this other text element opens the same popup as above. // The popup itself will be submitted by the code above. ImGui::Text("(2) Or right-click this text"); ImGui::OpenPopupOnItemClick("my popup", ImGuiPopupFlags_MouseButtonRight); // Back to square one: manually open the same popup. if (ImGui::Button("(3) Or click this button")) ImGui::OpenPopup("my popup"); } // Example 3 // When using BeginPopupContextItem() with an implicit identifier (NULL == use last item ID), // we need to make sure your item identifier is stable. // In this example we showcase altering the item label while preserving its identifier, using the ### operator (see FAQ). { HelpMarker("Showcase using a popup ID linked to item ID, with the item having a changing label + stable ID using the ### operator."); static char name[32] = "Label1"; char buf[64]; sprintf(buf, "Button: %s###Button", name); // ### operator override ID ignoring the preceding label ImGui::Button(buf); if (ImGui::BeginPopupContextItem()) { ImGui::Text("Edit name:"); ImGui::InputText("##edit", name, IM_ARRAYSIZE(name)); if (ImGui::Button("Close")) ImGui::CloseCurrentPopup(); ImGui::EndPopup(); } ImGui::SameLine(); ImGui::Text("(<-- right-click here)"); } ImGui::TreePop(); } IMGUI_DEMO_MARKER("Popups/Modals"); if (ImGui::TreeNode("Modals")) { ImGui::TextWrapped("Modal windows are like popups but the user cannot close them by clicking outside."); if (ImGui::Button("Delete..")) ImGui::OpenPopup("Delete?"); // Always center this window when appearing ImVec2 center = ImGui::GetMainViewport()->GetCenter(); ImGui::SetNextWindowPos(center, ImGuiCond_Appearing, ImVec2(0.5f, 0.5f)); if (ImGui::BeginPopupModal("Delete?", NULL, ImGuiWindowFlags_AlwaysAutoResize)) { ImGui::Text("All those beautiful files will be deleted.\nThis operation cannot be undone!"); ImGui::Separator(); //static int unused_i = 0; //ImGui::Combo("Combo", &unused_i, "Delete\0Delete harder\0"); static bool dont_ask_me_next_time = false; ImGui::PushStyleVar(ImGuiStyleVar_FramePadding, ImVec2(0, 0)); ImGui::Checkbox("Don't ask me next time", &dont_ask_me_next_time); ImGui::PopStyleVar(); if (ImGui::Button("OK", ImVec2(120, 0))) { ImGui::CloseCurrentPopup(); } ImGui::SetItemDefaultFocus(); ImGui::SameLine(); if (ImGui::Button("Cancel", ImVec2(120, 0))) { ImGui::CloseCurrentPopup(); } ImGui::EndPopup(); } if (ImGui::Button("Stacked modals..")) ImGui::OpenPopup("Stacked 1"); if (ImGui::BeginPopupModal("Stacked 1", NULL, ImGuiWindowFlags_MenuBar)) { if (ImGui::BeginMenuBar()) { if (ImGui::BeginMenu("File")) { if (ImGui::MenuItem("Some menu item")) {} ImGui::EndMenu(); } ImGui::EndMenuBar(); } ImGui::Text("Hello from Stacked The First\nUsing style.Colors[ImGuiCol_ModalWindowDimBg] behind it."); // Testing behavior of widgets stacking their own regular popups over the modal. static int item = 1; static float color[4] = { 0.4f, 0.7f, 0.0f, 0.5f }; ImGui::Combo("Combo", &item, "aaaa\0bbbb\0cccc\0dddd\0eeee\0\0"); ImGui::ColorEdit4("Color", color); if (ImGui::Button("Add another modal..")) ImGui::OpenPopup("Stacked 2"); // Also demonstrate passing a bool* to BeginPopupModal(), this will create a regular close button which // will close the popup. Note that the visibility state of popups is owned by imgui, so the input value // of the bool actually doesn't matter here. bool unused_open = true; if (ImGui::BeginPopupModal("Stacked 2", &unused_open)) { ImGui::Text("Hello from Stacked The Second!"); ImGui::ColorEdit4("Color", color); // Allow opening another nested popup if (ImGui::Button("Close")) ImGui::CloseCurrentPopup(); ImGui::EndPopup(); } if (ImGui::Button("Close")) ImGui::CloseCurrentPopup(); ImGui::EndPopup(); } ImGui::TreePop(); } IMGUI_DEMO_MARKER("Popups/Menus inside a regular window"); if (ImGui::TreeNode("Menus inside a regular window")) { ImGui::TextWrapped("Below we are testing adding menu items to a regular window. It's rather unusual but should work!"); ImGui::Separator(); ImGui::MenuItem("Menu item", "CTRL+M"); if (ImGui::BeginMenu("Menu inside a regular window")) { ShowExampleMenuFile(); ImGui::EndMenu(); } ImGui::Separator(); ImGui::TreePop(); } } // Dummy data structure that we use for the Table demo. // (pre-C++11 doesn't allow us to instantiate ImVector template if this structure is defined inside the demo function) namespace { // We are passing our own identifier to TableSetupColumn() to facilitate identifying columns in the sorting code. // This identifier will be passed down into ImGuiTableSortSpec::ColumnUserID. // But it is possible to omit the user id parameter of TableSetupColumn() and just use the column index instead! (ImGuiTableSortSpec::ColumnIndex) // If you don't use sorting, you will generally never care about giving column an ID! enum MyItemColumnID { MyItemColumnID_ID, MyItemColumnID_Name, MyItemColumnID_Action, MyItemColumnID_Quantity, MyItemColumnID_Description }; struct MyItem { int ID; const char* Name; int Quantity; // We have a problem which is affecting _only this demo_ and should not affect your code: // As we don't rely on std:: or other third-party library to compile dear imgui, we only have reliable access to qsort(), // however qsort doesn't allow passing user data to comparing function. // As a workaround, we are storing the sort specs in a static/global for the comparing function to access. // In your own use case you would probably pass the sort specs to your sorting/comparing functions directly and not use a global. // We could technically call ImGui::TableGetSortSpecs() in CompareWithSortSpecs(), but considering that this function is called // very often by the sorting algorithm it would be a little wasteful. static const ImGuiTableSortSpecs* s_current_sort_specs; static void SortWithSortSpecs(ImGuiTableSortSpecs* sort_specs, MyItem* items, int items_count) { s_current_sort_specs = sort_specs; // Store in variable accessible by the sort function. if (items_count > 1) qsort(items, (size_t)items_count, sizeof(items[0]), MyItem::CompareWithSortSpecs); s_current_sort_specs = NULL; } // Compare function to be used by qsort() static int IMGUI_CDECL CompareWithSortSpecs(const void* lhs, const void* rhs) { const MyItem* a = (const MyItem*)lhs; const MyItem* b = (const MyItem*)rhs; for (int n = 0; n < s_current_sort_specs->SpecsCount; n++) { // Here we identify columns using the ColumnUserID value that we ourselves passed to TableSetupColumn() // We could also choose to identify columns based on their index (sort_spec->ColumnIndex), which is simpler! const ImGuiTableColumnSortSpecs* sort_spec = &s_current_sort_specs->Specs[n]; int delta = 0; switch (sort_spec->ColumnUserID) { case MyItemColumnID_ID: delta = (a->ID - b->ID); break; case MyItemColumnID_Name: delta = (strcmp(a->Name, b->Name)); break; case MyItemColumnID_Quantity: delta = (a->Quantity - b->Quantity); break; case MyItemColumnID_Description: delta = (strcmp(a->Name, b->Name)); break; default: IM_ASSERT(0); break; } if (delta > 0) return (sort_spec->SortDirection == ImGuiSortDirection_Ascending) ? +1 : -1; if (delta < 0) return (sort_spec->SortDirection == ImGuiSortDirection_Ascending) ? -1 : +1; } // qsort() is instable so always return a way to differenciate items. // Your own compare function may want to avoid fallback on implicit sort specs. // e.g. a Name compare if it wasn't already part of the sort specs. return (a->ID - b->ID); } }; const ImGuiTableSortSpecs* MyItem::s_current_sort_specs = NULL; } // Make the UI compact because there are so many fields static void PushStyleCompact() { ImGuiStyle& style = ImGui::GetStyle(); ImGui::PushStyleVarY(ImGuiStyleVar_FramePadding, (float)(int)(style.FramePadding.y * 0.60f)); ImGui::PushStyleVarY(ImGuiStyleVar_ItemSpacing, (float)(int)(style.ItemSpacing.y * 0.60f)); } static void PopStyleCompact() { ImGui::PopStyleVar(2); } // Show a combo box with a choice of sizing policies static void EditTableSizingFlags(ImGuiTableFlags* p_flags) { struct EnumDesc { ImGuiTableFlags Value; const char* Name; const char* Tooltip; }; static const EnumDesc policies[] = { { ImGuiTableFlags_None, "Default", "Use default sizing policy:\n- ImGuiTableFlags_SizingFixedFit if ScrollX is on or if host window has ImGuiWindowFlags_AlwaysAutoResize.\n- ImGuiTableFlags_SizingStretchSame otherwise." }, { ImGuiTableFlags_SizingFixedFit, "ImGuiTableFlags_SizingFixedFit", "Columns default to _WidthFixed (if resizable) or _WidthAuto (if not resizable), matching contents width." }, { ImGuiTableFlags_SizingFixedSame, "ImGuiTableFlags_SizingFixedSame", "Columns are all the same width, matching the maximum contents width.\nImplicitly disable ImGuiTableFlags_Resizable and enable ImGuiTableFlags_NoKeepColumnsVisible." }, { ImGuiTableFlags_SizingStretchProp, "ImGuiTableFlags_SizingStretchProp", "Columns default to _WidthStretch with weights proportional to their widths." }, { ImGuiTableFlags_SizingStretchSame, "ImGuiTableFlags_SizingStretchSame", "Columns default to _WidthStretch with same weights." } }; int idx; for (idx = 0; idx < IM_ARRAYSIZE(policies); idx++) if (policies[idx].Value == (*p_flags & ImGuiTableFlags_SizingMask_)) break; const char* preview_text = (idx < IM_ARRAYSIZE(policies)) ? policies[idx].Name + (idx > 0 ? strlen("ImGuiTableFlags") : 0) : ""; if (ImGui::BeginCombo("Sizing Policy", preview_text)) { for (int n = 0; n < IM_ARRAYSIZE(policies); n++) if (ImGui::Selectable(policies[n].Name, idx == n)) *p_flags = (*p_flags & ~ImGuiTableFlags_SizingMask_) | policies[n].Value; ImGui::EndCombo(); } ImGui::SameLine(); ImGui::TextDisabled("(?)"); if (ImGui::BeginItemTooltip()) { ImGui::PushTextWrapPos(ImGui::GetFontSize() * 50.0f); for (int m = 0; m < IM_ARRAYSIZE(policies); m++) { ImGui::Separator(); ImGui::Text("%s:", policies[m].Name); ImGui::Separator(); ImGui::SetCursorPosX(ImGui::GetCursorPosX() + ImGui::GetStyle().IndentSpacing * 0.5f); ImGui::TextUnformatted(policies[m].Tooltip); } ImGui::PopTextWrapPos(); ImGui::EndTooltip(); } } static void EditTableColumnsFlags(ImGuiTableColumnFlags* p_flags) { ImGui::CheckboxFlags("_Disabled", p_flags, ImGuiTableColumnFlags_Disabled); ImGui::SameLine(); HelpMarker("Master disable flag (also hide from context menu)"); ImGui::CheckboxFlags("_DefaultHide", p_flags, ImGuiTableColumnFlags_DefaultHide); ImGui::CheckboxFlags("_DefaultSort", p_flags, ImGuiTableColumnFlags_DefaultSort); if (ImGui::CheckboxFlags("_WidthStretch", p_flags, ImGuiTableColumnFlags_WidthStretch)) *p_flags &= ~(ImGuiTableColumnFlags_WidthMask_ ^ ImGuiTableColumnFlags_WidthStretch); if (ImGui::CheckboxFlags("_WidthFixed", p_flags, ImGuiTableColumnFlags_WidthFixed)) *p_flags &= ~(ImGuiTableColumnFlags_WidthMask_ ^ ImGuiTableColumnFlags_WidthFixed); ImGui::CheckboxFlags("_NoResize", p_flags, ImGuiTableColumnFlags_NoResize); ImGui::CheckboxFlags("_NoReorder", p_flags, ImGuiTableColumnFlags_NoReorder); ImGui::CheckboxFlags("_NoHide", p_flags, ImGuiTableColumnFlags_NoHide); ImGui::CheckboxFlags("_NoClip", p_flags, ImGuiTableColumnFlags_NoClip); ImGui::CheckboxFlags("_NoSort", p_flags, ImGuiTableColumnFlags_NoSort); ImGui::CheckboxFlags("_NoSortAscending", p_flags, ImGuiTableColumnFlags_NoSortAscending); ImGui::CheckboxFlags("_NoSortDescending", p_flags, ImGuiTableColumnFlags_NoSortDescending); ImGui::CheckboxFlags("_NoHeaderLabel", p_flags, ImGuiTableColumnFlags_NoHeaderLabel); ImGui::CheckboxFlags("_NoHeaderWidth", p_flags, ImGuiTableColumnFlags_NoHeaderWidth); ImGui::CheckboxFlags("_PreferSortAscending", p_flags, ImGuiTableColumnFlags_PreferSortAscending); ImGui::CheckboxFlags("_PreferSortDescending", p_flags, ImGuiTableColumnFlags_PreferSortDescending); ImGui::CheckboxFlags("_IndentEnable", p_flags, ImGuiTableColumnFlags_IndentEnable); ImGui::SameLine(); HelpMarker("Default for column 0"); ImGui::CheckboxFlags("_IndentDisable", p_flags, ImGuiTableColumnFlags_IndentDisable); ImGui::SameLine(); HelpMarker("Default for column >0"); ImGui::CheckboxFlags("_AngledHeader", p_flags, ImGuiTableColumnFlags_AngledHeader); } static void ShowTableColumnsStatusFlags(ImGuiTableColumnFlags flags) { ImGui::CheckboxFlags("_IsEnabled", &flags, ImGuiTableColumnFlags_IsEnabled); ImGui::CheckboxFlags("_IsVisible", &flags, ImGuiTableColumnFlags_IsVisible); ImGui::CheckboxFlags("_IsSorted", &flags, ImGuiTableColumnFlags_IsSorted); ImGui::CheckboxFlags("_IsHovered", &flags, ImGuiTableColumnFlags_IsHovered); } //----------------------------------------------------------------------------- // [SECTION] DemoWindowTables() //----------------------------------------------------------------------------- static void DemoWindowTables() { //ImGui::SetNextItemOpen(true, ImGuiCond_Once); IMGUI_DEMO_MARKER("Tables"); if (!ImGui::CollapsingHeader("Tables & Columns")) return; // Using those as a base value to create width/height that are factor of the size of our font const float TEXT_BASE_WIDTH = ImGui::CalcTextSize("A").x; const float TEXT_BASE_HEIGHT = ImGui::GetTextLineHeightWithSpacing(); ImGui::PushID("Tables"); int open_action = -1; if (ImGui::Button("Expand all")) open_action = 1; ImGui::SameLine(); if (ImGui::Button("Collapse all")) open_action = 0; ImGui::SameLine(); // Options static bool disable_indent = false; ImGui::Checkbox("Disable tree indentation", &disable_indent); ImGui::SameLine(); HelpMarker("Disable the indenting of tree nodes so demo tables can use the full window width."); ImGui::Separator(); if (disable_indent) ImGui::PushStyleVar(ImGuiStyleVar_IndentSpacing, 0.0f); // About Styling of tables // Most settings are configured on a per-table basis via the flags passed to BeginTable() and TableSetupColumns APIs. // There are however a few settings that a shared and part of the ImGuiStyle structure: // style.CellPadding // Padding within each cell // style.Colors[ImGuiCol_TableHeaderBg] // Table header background // style.Colors[ImGuiCol_TableBorderStrong] // Table outer and header borders // style.Colors[ImGuiCol_TableBorderLight] // Table inner borders // style.Colors[ImGuiCol_TableRowBg] // Table row background when ImGuiTableFlags_RowBg is enabled (even rows) // style.Colors[ImGuiCol_TableRowBgAlt] // Table row background when ImGuiTableFlags_RowBg is enabled (odds rows) // Demos if (open_action != -1) ImGui::SetNextItemOpen(open_action != 0); IMGUI_DEMO_MARKER("Tables/Basic"); if (ImGui::TreeNode("Basic")) { // Here we will showcase three different ways to output a table. // They are very simple variations of a same thing! // [Method 1] Using TableNextRow() to create a new row, and TableSetColumnIndex() to select the column. // In many situations, this is the most flexible and easy to use pattern. HelpMarker("Using TableNextRow() + calling TableSetColumnIndex() _before_ each cell, in a loop."); if (ImGui::BeginTable("table1", 3)) { for (int row = 0; row < 4; row++) { ImGui::TableNextRow(); for (int column = 0; column < 3; column++) { ImGui::TableSetColumnIndex(column); ImGui::Text("Row %d Column %d", row, column); } } ImGui::EndTable(); } // [Method 2] Using TableNextColumn() called multiple times, instead of using a for loop + TableSetColumnIndex(). // This is generally more convenient when you have code manually submitting the contents of each column. HelpMarker("Using TableNextRow() + calling TableNextColumn() _before_ each cell, manually."); if (ImGui::BeginTable("table2", 3)) { for (int row = 0; row < 4; row++) { ImGui::TableNextRow(); ImGui::TableNextColumn(); ImGui::Text("Row %d", row); ImGui::TableNextColumn(); ImGui::Text("Some contents"); ImGui::TableNextColumn(); ImGui::Text("123.456"); } ImGui::EndTable(); } // [Method 3] We call TableNextColumn() _before_ each cell. We never call TableNextRow(), // as TableNextColumn() will automatically wrap around and create new rows as needed. // This is generally more convenient when your cells all contains the same type of data. HelpMarker( "Only using TableNextColumn(), which tends to be convenient for tables where every cell contains " "the same type of contents.\n This is also more similar to the old NextColumn() function of the " "Columns API, and provided to facilitate the Columns->Tables API transition."); if (ImGui::BeginTable("table3", 3)) { for (int item = 0; item < 14; item++) { ImGui::TableNextColumn(); ImGui::Text("Item %d", item); } ImGui::EndTable(); } ImGui::TreePop(); } if (open_action != -1) ImGui::SetNextItemOpen(open_action != 0); IMGUI_DEMO_MARKER("Tables/Borders, background"); if (ImGui::TreeNode("Borders, background")) { // Expose a few Borders related flags interactively enum ContentsType { CT_Text, CT_FillButton }; static ImGuiTableFlags flags = ImGuiTableFlags_Borders | ImGuiTableFlags_RowBg; static bool display_headers = false; static int contents_type = CT_Text; PushStyleCompact(); ImGui::CheckboxFlags("ImGuiTableFlags_RowBg", &flags, ImGuiTableFlags_RowBg); ImGui::CheckboxFlags("ImGuiTableFlags_Borders", &flags, ImGuiTableFlags_Borders); ImGui::SameLine(); HelpMarker("ImGuiTableFlags_Borders\n = ImGuiTableFlags_BordersInnerV\n | ImGuiTableFlags_BordersOuterV\n | ImGuiTableFlags_BordersInnerH\n | ImGuiTableFlags_BordersOuterH"); ImGui::Indent(); ImGui::CheckboxFlags("ImGuiTableFlags_BordersH", &flags, ImGuiTableFlags_BordersH); ImGui::Indent(); ImGui::CheckboxFlags("ImGuiTableFlags_BordersOuterH", &flags, ImGuiTableFlags_BordersOuterH); ImGui::CheckboxFlags("ImGuiTableFlags_BordersInnerH", &flags, ImGuiTableFlags_BordersInnerH); ImGui::Unindent(); ImGui::CheckboxFlags("ImGuiTableFlags_BordersV", &flags, ImGuiTableFlags_BordersV); ImGui::Indent(); ImGui::CheckboxFlags("ImGuiTableFlags_BordersOuterV", &flags, ImGuiTableFlags_BordersOuterV); ImGui::CheckboxFlags("ImGuiTableFlags_BordersInnerV", &flags, ImGuiTableFlags_BordersInnerV); ImGui::Unindent(); ImGui::CheckboxFlags("ImGuiTableFlags_BordersOuter", &flags, ImGuiTableFlags_BordersOuter); ImGui::CheckboxFlags("ImGuiTableFlags_BordersInner", &flags, ImGuiTableFlags_BordersInner); ImGui::Unindent(); ImGui::AlignTextToFramePadding(); ImGui::Text("Cell contents:"); ImGui::SameLine(); ImGui::RadioButton("Text", &contents_type, CT_Text); ImGui::SameLine(); ImGui::RadioButton("FillButton", &contents_type, CT_FillButton); ImGui::Checkbox("Display headers", &display_headers); ImGui::CheckboxFlags("ImGuiTableFlags_NoBordersInBody", &flags, ImGuiTableFlags_NoBordersInBody); ImGui::SameLine(); HelpMarker("Disable vertical borders in columns Body (borders will always appear in Headers"); PopStyleCompact(); if (ImGui::BeginTable("table1", 3, flags)) { // Display headers so we can inspect their interaction with borders // (Headers are not the main purpose of this section of the demo, so we are not elaborating on them now. See other sections for details) if (display_headers) { ImGui::TableSetupColumn("One"); ImGui::TableSetupColumn("Two"); ImGui::TableSetupColumn("Three"); ImGui::TableHeadersRow(); } for (int row = 0; row < 5; row++) { ImGui::TableNextRow(); for (int column = 0; column < 3; column++) { ImGui::TableSetColumnIndex(column); char buf[32]; sprintf(buf, "Hello %d,%d", column, row); if (contents_type == CT_Text) ImGui::TextUnformatted(buf); else if (contents_type == CT_FillButton) ImGui::Button(buf, ImVec2(-FLT_MIN, 0.0f)); } } ImGui::EndTable(); } ImGui::TreePop(); } if (open_action != -1) ImGui::SetNextItemOpen(open_action != 0); IMGUI_DEMO_MARKER("Tables/Resizable, stretch"); if (ImGui::TreeNode("Resizable, stretch")) { // By default, if we don't enable ScrollX the sizing policy for each column is "Stretch" // All columns maintain a sizing weight, and they will occupy all available width. static ImGuiTableFlags flags = ImGuiTableFlags_SizingStretchSame | ImGuiTableFlags_Resizable | ImGuiTableFlags_BordersOuter | ImGuiTableFlags_BordersV | ImGuiTableFlags_ContextMenuInBody; PushStyleCompact(); ImGui::CheckboxFlags("ImGuiTableFlags_Resizable", &flags, ImGuiTableFlags_Resizable); ImGui::CheckboxFlags("ImGuiTableFlags_BordersV", &flags, ImGuiTableFlags_BordersV); ImGui::SameLine(); HelpMarker( "Using the _Resizable flag automatically enables the _BordersInnerV flag as well, " "this is why the resize borders are still showing when unchecking this."); PopStyleCompact(); if (ImGui::BeginTable("table1", 3, flags)) { for (int row = 0; row < 5; row++) { ImGui::TableNextRow(); for (int column = 0; column < 3; column++) { ImGui::TableSetColumnIndex(column); ImGui::Text("Hello %d,%d", column, row); } } ImGui::EndTable(); } ImGui::TreePop(); } if (open_action != -1) ImGui::SetNextItemOpen(open_action != 0); IMGUI_DEMO_MARKER("Tables/Resizable, fixed"); if (ImGui::TreeNode("Resizable, fixed")) { // Here we use ImGuiTableFlags_SizingFixedFit (even though _ScrollX is not set) // So columns will adopt the "Fixed" policy and will maintain a fixed width regardless of the whole available width (unless table is small) // If there is not enough available width to fit all columns, they will however be resized down. // FIXME-TABLE: Providing a stretch-on-init would make sense especially for tables which don't have saved settings HelpMarker( "Using _Resizable + _SizingFixedFit flags.\n" "Fixed-width columns generally makes more sense if you want to use horizontal scrolling.\n\n" "Double-click a column border to auto-fit the column to its contents."); PushStyleCompact(); static ImGuiTableFlags flags = ImGuiTableFlags_SizingFixedFit | ImGuiTableFlags_Resizable | ImGuiTableFlags_BordersOuter | ImGuiTableFlags_BordersV | ImGuiTableFlags_ContextMenuInBody; ImGui::CheckboxFlags("ImGuiTableFlags_NoHostExtendX", &flags, ImGuiTableFlags_NoHostExtendX); PopStyleCompact(); if (ImGui::BeginTable("table1", 3, flags)) { for (int row = 0; row < 5; row++) { ImGui::TableNextRow(); for (int column = 0; column < 3; column++) { ImGui::TableSetColumnIndex(column); ImGui::Text("Hello %d,%d", column, row); } } ImGui::EndTable(); } ImGui::TreePop(); } if (open_action != -1) ImGui::SetNextItemOpen(open_action != 0); IMGUI_DEMO_MARKER("Tables/Resizable, mixed"); if (ImGui::TreeNode("Resizable, mixed")) { HelpMarker( "Using TableSetupColumn() to alter resizing policy on a per-column basis.\n\n" "When combining Fixed and Stretch columns, generally you only want one, maybe two trailing columns to use _WidthStretch."); static ImGuiTableFlags flags = ImGuiTableFlags_SizingFixedFit | ImGuiTableFlags_RowBg | ImGuiTableFlags_Borders | ImGuiTableFlags_Resizable | ImGuiTableFlags_Reorderable | ImGuiTableFlags_Hideable; if (ImGui::BeginTable("table1", 3, flags)) { ImGui::TableSetupColumn("AAA", ImGuiTableColumnFlags_WidthFixed); ImGui::TableSetupColumn("BBB", ImGuiTableColumnFlags_WidthFixed); ImGui::TableSetupColumn("CCC", ImGuiTableColumnFlags_WidthStretch); ImGui::TableHeadersRow(); for (int row = 0; row < 5; row++) { ImGui::TableNextRow(); for (int column = 0; column < 3; column++) { ImGui::TableSetColumnIndex(column); ImGui::Text("%s %d,%d", (column == 2) ? "Stretch" : "Fixed", column, row); } } ImGui::EndTable(); } if (ImGui::BeginTable("table2", 6, flags)) { ImGui::TableSetupColumn("AAA", ImGuiTableColumnFlags_WidthFixed); ImGui::TableSetupColumn("BBB", ImGuiTableColumnFlags_WidthFixed); ImGui::TableSetupColumn("CCC", ImGuiTableColumnFlags_WidthFixed | ImGuiTableColumnFlags_DefaultHide); ImGui::TableSetupColumn("DDD", ImGuiTableColumnFlags_WidthStretch); ImGui::TableSetupColumn("EEE", ImGuiTableColumnFlags_WidthStretch); ImGui::TableSetupColumn("FFF", ImGuiTableColumnFlags_WidthStretch | ImGuiTableColumnFlags_DefaultHide); ImGui::TableHeadersRow(); for (int row = 0; row < 5; row++) { ImGui::TableNextRow(); for (int column = 0; column < 6; column++) { ImGui::TableSetColumnIndex(column); ImGui::Text("%s %d,%d", (column >= 3) ? "Stretch" : "Fixed", column, row); } } ImGui::EndTable(); } ImGui::TreePop(); } if (open_action != -1) ImGui::SetNextItemOpen(open_action != 0); IMGUI_DEMO_MARKER("Tables/Reorderable, hideable, with headers"); if (ImGui::TreeNode("Reorderable, hideable, with headers")) { HelpMarker( "Click and drag column headers to reorder columns.\n\n" "Right-click on a header to open a context menu."); static ImGuiTableFlags flags = ImGuiTableFlags_Resizable | ImGuiTableFlags_Reorderable | ImGuiTableFlags_Hideable | ImGuiTableFlags_BordersOuter | ImGuiTableFlags_BordersV; PushStyleCompact(); ImGui::CheckboxFlags("ImGuiTableFlags_Resizable", &flags, ImGuiTableFlags_Resizable); ImGui::CheckboxFlags("ImGuiTableFlags_Reorderable", &flags, ImGuiTableFlags_Reorderable); ImGui::CheckboxFlags("ImGuiTableFlags_Hideable", &flags, ImGuiTableFlags_Hideable); ImGui::CheckboxFlags("ImGuiTableFlags_NoBordersInBody", &flags, ImGuiTableFlags_NoBordersInBody); ImGui::CheckboxFlags("ImGuiTableFlags_NoBordersInBodyUntilResize", &flags, ImGuiTableFlags_NoBordersInBodyUntilResize); ImGui::SameLine(); HelpMarker("Disable vertical borders in columns Body until hovered for resize (borders will always appear in Headers)"); ImGui::CheckboxFlags("ImGuiTableFlags_HighlightHoveredColumn", &flags, ImGuiTableFlags_HighlightHoveredColumn); PopStyleCompact(); if (ImGui::BeginTable("table1", 3, flags)) { // Submit columns name with TableSetupColumn() and call TableHeadersRow() to create a row with a header in each column. // (Later we will show how TableSetupColumn() has other uses, optional flags, sizing weight etc.) ImGui::TableSetupColumn("One"); ImGui::TableSetupColumn("Two"); ImGui::TableSetupColumn("Three"); ImGui::TableHeadersRow(); for (int row = 0; row < 6; row++) { ImGui::TableNextRow(); for (int column = 0; column < 3; column++) { ImGui::TableSetColumnIndex(column); ImGui::Text("Hello %d,%d", column, row); } } ImGui::EndTable(); } // Use outer_size.x == 0.0f instead of default to make the table as tight as possible // (only valid when no scrolling and no stretch column) if (ImGui::BeginTable("table2", 3, flags | ImGuiTableFlags_SizingFixedFit, ImVec2(0.0f, 0.0f))) { ImGui::TableSetupColumn("One"); ImGui::TableSetupColumn("Two"); ImGui::TableSetupColumn("Three"); ImGui::TableHeadersRow(); for (int row = 0; row < 6; row++) { ImGui::TableNextRow(); for (int column = 0; column < 3; column++) { ImGui::TableSetColumnIndex(column); ImGui::Text("Fixed %d,%d", column, row); } } ImGui::EndTable(); } ImGui::TreePop(); } if (open_action != -1) ImGui::SetNextItemOpen(open_action != 0); IMGUI_DEMO_MARKER("Tables/Padding"); if (ImGui::TreeNode("Padding")) { // First example: showcase use of padding flags and effect of BorderOuterV/BorderInnerV on X padding. // We don't expose BorderOuterH/BorderInnerH here because they have no effect on X padding. HelpMarker( "We often want outer padding activated when any using features which makes the edges of a column visible:\n" "e.g.:\n" "- BorderOuterV\n" "- any form of row selection\n" "Because of this, activating BorderOuterV sets the default to PadOuterX. " "Using PadOuterX or NoPadOuterX you can override the default.\n\n" "Actual padding values are using style.CellPadding.\n\n" "In this demo we don't show horizontal borders to emphasize how they don't affect default horizontal padding."); static ImGuiTableFlags flags1 = ImGuiTableFlags_BordersV; PushStyleCompact(); ImGui::CheckboxFlags("ImGuiTableFlags_PadOuterX", &flags1, ImGuiTableFlags_PadOuterX); ImGui::SameLine(); HelpMarker("Enable outer-most padding (default if ImGuiTableFlags_BordersOuterV is set)"); ImGui::CheckboxFlags("ImGuiTableFlags_NoPadOuterX", &flags1, ImGuiTableFlags_NoPadOuterX); ImGui::SameLine(); HelpMarker("Disable outer-most padding (default if ImGuiTableFlags_BordersOuterV is not set)"); ImGui::CheckboxFlags("ImGuiTableFlags_NoPadInnerX", &flags1, ImGuiTableFlags_NoPadInnerX); ImGui::SameLine(); HelpMarker("Disable inner padding between columns (double inner padding if BordersOuterV is on, single inner padding if BordersOuterV is off)"); ImGui::CheckboxFlags("ImGuiTableFlags_BordersOuterV", &flags1, ImGuiTableFlags_BordersOuterV); ImGui::CheckboxFlags("ImGuiTableFlags_BordersInnerV", &flags1, ImGuiTableFlags_BordersInnerV); static bool show_headers = false; ImGui::Checkbox("show_headers", &show_headers); PopStyleCompact(); if (ImGui::BeginTable("table_padding", 3, flags1)) { if (show_headers) { ImGui::TableSetupColumn("One"); ImGui::TableSetupColumn("Two"); ImGui::TableSetupColumn("Three"); ImGui::TableHeadersRow(); } for (int row = 0; row < 5; row++) { ImGui::TableNextRow(); for (int column = 0; column < 3; column++) { ImGui::TableSetColumnIndex(column); if (row == 0) { ImGui::Text("Avail %.2f", ImGui::GetContentRegionAvail().x); } else { char buf[32]; sprintf(buf, "Hello %d,%d", column, row); ImGui::Button(buf, ImVec2(-FLT_MIN, 0.0f)); } //if (ImGui::TableGetColumnFlags() & ImGuiTableColumnFlags_IsHovered) // ImGui::TableSetBgColor(ImGuiTableBgTarget_CellBg, IM_COL32(0, 100, 0, 255)); } } ImGui::EndTable(); } // Second example: set style.CellPadding to (0.0) or a custom value. // FIXME-TABLE: Vertical border effectively not displayed the same way as horizontal one... HelpMarker("Setting style.CellPadding to (0,0) or a custom value."); static ImGuiTableFlags flags2 = ImGuiTableFlags_Borders | ImGuiTableFlags_RowBg; static ImVec2 cell_padding(0.0f, 0.0f); static bool show_widget_frame_bg = true; PushStyleCompact(); ImGui::CheckboxFlags("ImGuiTableFlags_Borders", &flags2, ImGuiTableFlags_Borders); ImGui::CheckboxFlags("ImGuiTableFlags_BordersH", &flags2, ImGuiTableFlags_BordersH); ImGui::CheckboxFlags("ImGuiTableFlags_BordersV", &flags2, ImGuiTableFlags_BordersV); ImGui::CheckboxFlags("ImGuiTableFlags_BordersInner", &flags2, ImGuiTableFlags_BordersInner); ImGui::CheckboxFlags("ImGuiTableFlags_BordersOuter", &flags2, ImGuiTableFlags_BordersOuter); ImGui::CheckboxFlags("ImGuiTableFlags_RowBg", &flags2, ImGuiTableFlags_RowBg); ImGui::CheckboxFlags("ImGuiTableFlags_Resizable", &flags2, ImGuiTableFlags_Resizable); ImGui::Checkbox("show_widget_frame_bg", &show_widget_frame_bg); ImGui::SliderFloat2("CellPadding", &cell_padding.x, 0.0f, 10.0f, "%.0f"); PopStyleCompact(); ImGui::PushStyleVar(ImGuiStyleVar_CellPadding, cell_padding); if (ImGui::BeginTable("table_padding_2", 3, flags2)) { static char text_bufs[3 * 5][16]; // Mini text storage for 3x5 cells static bool init = true; if (!show_widget_frame_bg) ImGui::PushStyleColor(ImGuiCol_FrameBg, 0); for (int cell = 0; cell < 3 * 5; cell++) { ImGui::TableNextColumn(); if (init) strcpy(text_bufs[cell], "edit me"); ImGui::SetNextItemWidth(-FLT_MIN); ImGui::PushID(cell); ImGui::InputText("##cell", text_bufs[cell], IM_ARRAYSIZE(text_bufs[cell])); ImGui::PopID(); } if (!show_widget_frame_bg) ImGui::PopStyleColor(); init = false; ImGui::EndTable(); } ImGui::PopStyleVar(); ImGui::TreePop(); } if (open_action != -1) ImGui::SetNextItemOpen(open_action != 0); IMGUI_DEMO_MARKER("Tables/Explicit widths"); if (ImGui::TreeNode("Sizing policies")) { static ImGuiTableFlags flags1 = ImGuiTableFlags_BordersV | ImGuiTableFlags_BordersOuterH | ImGuiTableFlags_RowBg | ImGuiTableFlags_ContextMenuInBody; PushStyleCompact(); ImGui::CheckboxFlags("ImGuiTableFlags_Resizable", &flags1, ImGuiTableFlags_Resizable); ImGui::CheckboxFlags("ImGuiTableFlags_NoHostExtendX", &flags1, ImGuiTableFlags_NoHostExtendX); PopStyleCompact(); static ImGuiTableFlags sizing_policy_flags[4] = { ImGuiTableFlags_SizingFixedFit, ImGuiTableFlags_SizingFixedSame, ImGuiTableFlags_SizingStretchProp, ImGuiTableFlags_SizingStretchSame }; for (int table_n = 0; table_n < 4; table_n++) { ImGui::PushID(table_n); ImGui::SetNextItemWidth(TEXT_BASE_WIDTH * 30); EditTableSizingFlags(&sizing_policy_flags[table_n]); // To make it easier to understand the different sizing policy, // For each policy: we display one table where the columns have equal contents width, // and one where the columns have different contents width. if (ImGui::BeginTable("table1", 3, sizing_policy_flags[table_n] | flags1)) { for (int row = 0; row < 3; row++) { ImGui::TableNextRow(); ImGui::TableNextColumn(); ImGui::Text("Oh dear"); ImGui::TableNextColumn(); ImGui::Text("Oh dear"); ImGui::TableNextColumn(); ImGui::Text("Oh dear"); } ImGui::EndTable(); } if (ImGui::BeginTable("table2", 3, sizing_policy_flags[table_n] | flags1)) { for (int row = 0; row < 3; row++) { ImGui::TableNextRow(); ImGui::TableNextColumn(); ImGui::Text("AAAA"); ImGui::TableNextColumn(); ImGui::Text("BBBBBBBB"); ImGui::TableNextColumn(); ImGui::Text("CCCCCCCCCCCC"); } ImGui::EndTable(); } ImGui::PopID(); } ImGui::Spacing(); ImGui::TextUnformatted("Advanced"); ImGui::SameLine(); HelpMarker( "This section allows you to interact and see the effect of various sizing policies " "depending on whether Scroll is enabled and the contents of your columns."); enum ContentsType { CT_ShowWidth, CT_ShortText, CT_LongText, CT_Button, CT_FillButton, CT_InputText }; static ImGuiTableFlags flags = ImGuiTableFlags_ScrollY | ImGuiTableFlags_Borders | ImGuiTableFlags_RowBg | ImGuiTableFlags_Resizable; static int contents_type = CT_ShowWidth; static int column_count = 3; PushStyleCompact(); ImGui::PushID("Advanced"); ImGui::PushItemWidth(TEXT_BASE_WIDTH * 30); EditTableSizingFlags(&flags); ImGui::Combo("Contents", &contents_type, "Show width\0Short Text\0Long Text\0Button\0Fill Button\0InputText\0"); if (contents_type == CT_FillButton) { ImGui::SameLine(); HelpMarker( "Be mindful that using right-alignment (e.g. size.x = -FLT_MIN) creates a feedback loop " "where contents width can feed into auto-column width can feed into contents width."); } ImGui::DragInt("Columns", &column_count, 0.1f, 1, 64, "%d", ImGuiSliderFlags_AlwaysClamp); ImGui::CheckboxFlags("ImGuiTableFlags_Resizable", &flags, ImGuiTableFlags_Resizable); ImGui::CheckboxFlags("ImGuiTableFlags_PreciseWidths", &flags, ImGuiTableFlags_PreciseWidths); ImGui::SameLine(); HelpMarker("Disable distributing remainder width to stretched columns (width allocation on a 100-wide table with 3 columns: Without this flag: 33,33,34. With this flag: 33,33,33). With larger number of columns, resizing will appear to be less smooth."); ImGui::CheckboxFlags("ImGuiTableFlags_ScrollX", &flags, ImGuiTableFlags_ScrollX); ImGui::CheckboxFlags("ImGuiTableFlags_ScrollY", &flags, ImGuiTableFlags_ScrollY); ImGui::CheckboxFlags("ImGuiTableFlags_NoClip", &flags, ImGuiTableFlags_NoClip); ImGui::PopItemWidth(); ImGui::PopID(); PopStyleCompact(); if (ImGui::BeginTable("table2", column_count, flags, ImVec2(0.0f, TEXT_BASE_HEIGHT * 7))) { for (int cell = 0; cell < 10 * column_count; cell++) { ImGui::TableNextColumn(); int column = ImGui::TableGetColumnIndex(); int row = ImGui::TableGetRowIndex(); ImGui::PushID(cell); char label[32]; static char text_buf[32] = ""; sprintf(label, "Hello %d,%d", column, row); switch (contents_type) { case CT_ShortText: ImGui::TextUnformatted(label); break; case CT_LongText: ImGui::Text("Some %s text %d,%d\nOver two lines..", column == 0 ? "long" : "longeeer", column, row); break; case CT_ShowWidth: ImGui::Text("W: %.1f", ImGui::GetContentRegionAvail().x); break; case CT_Button: ImGui::Button(label); break; case CT_FillButton: ImGui::Button(label, ImVec2(-FLT_MIN, 0.0f)); break; case CT_InputText: ImGui::SetNextItemWidth(-FLT_MIN); ImGui::InputText("##", text_buf, IM_ARRAYSIZE(text_buf)); break; } ImGui::PopID(); } ImGui::EndTable(); } ImGui::TreePop(); } if (open_action != -1) ImGui::SetNextItemOpen(open_action != 0); IMGUI_DEMO_MARKER("Tables/Vertical scrolling, with clipping"); if (ImGui::TreeNode("Vertical scrolling, with clipping")) { HelpMarker( "Here we activate ScrollY, which will create a child window container to allow hosting scrollable contents.\n\n" "We also demonstrate using ImGuiListClipper to virtualize the submission of many items."); static ImGuiTableFlags flags = ImGuiTableFlags_ScrollY | ImGuiTableFlags_RowBg | ImGuiTableFlags_BordersOuter | ImGuiTableFlags_BordersV | ImGuiTableFlags_Resizable | ImGuiTableFlags_Reorderable | ImGuiTableFlags_Hideable; PushStyleCompact(); ImGui::CheckboxFlags("ImGuiTableFlags_ScrollY", &flags, ImGuiTableFlags_ScrollY); PopStyleCompact(); // When using ScrollX or ScrollY we need to specify a size for our table container! // Otherwise by default the table will fit all available space, like a BeginChild() call. ImVec2 outer_size = ImVec2(0.0f, TEXT_BASE_HEIGHT * 8); if (ImGui::BeginTable("table_scrolly", 3, flags, outer_size)) { ImGui::TableSetupScrollFreeze(0, 1); // Make top row always visible ImGui::TableSetupColumn("One", ImGuiTableColumnFlags_None); ImGui::TableSetupColumn("Two", ImGuiTableColumnFlags_None); ImGui::TableSetupColumn("Three", ImGuiTableColumnFlags_None); ImGui::TableHeadersRow(); // Demonstrate using clipper for large vertical lists ImGuiListClipper clipper; clipper.Begin(1000); while (clipper.Step()) { for (int row = clipper.DisplayStart; row < clipper.DisplayEnd; row++) { ImGui::TableNextRow(); for (int column = 0; column < 3; column++) { ImGui::TableSetColumnIndex(column); ImGui::Text("Hello %d,%d", column, row); } } } ImGui::EndTable(); } ImGui::TreePop(); } if (open_action != -1) ImGui::SetNextItemOpen(open_action != 0); IMGUI_DEMO_MARKER("Tables/Horizontal scrolling"); if (ImGui::TreeNode("Horizontal scrolling")) { HelpMarker( "When ScrollX is enabled, the default sizing policy becomes ImGuiTableFlags_SizingFixedFit, " "as automatically stretching columns doesn't make much sense with horizontal scrolling.\n\n" "Also note that as of the current version, you will almost always want to enable ScrollY along with ScrollX, " "because the container window won't automatically extend vertically to fix contents " "(this may be improved in future versions)."); static ImGuiTableFlags flags = ImGuiTableFlags_ScrollX | ImGuiTableFlags_ScrollY | ImGuiTableFlags_RowBg | ImGuiTableFlags_BordersOuter | ImGuiTableFlags_BordersV | ImGuiTableFlags_Resizable | ImGuiTableFlags_Reorderable | ImGuiTableFlags_Hideable; static int freeze_cols = 1; static int freeze_rows = 1; PushStyleCompact(); ImGui::CheckboxFlags("ImGuiTableFlags_Resizable", &flags, ImGuiTableFlags_Resizable); ImGui::CheckboxFlags("ImGuiTableFlags_ScrollX", &flags, ImGuiTableFlags_ScrollX); ImGui::CheckboxFlags("ImGuiTableFlags_ScrollY", &flags, ImGuiTableFlags_ScrollY); ImGui::SetNextItemWidth(ImGui::GetFrameHeight()); ImGui::DragInt("freeze_cols", &freeze_cols, 0.2f, 0, 9, NULL, ImGuiSliderFlags_NoInput); ImGui::SetNextItemWidth(ImGui::GetFrameHeight()); ImGui::DragInt("freeze_rows", &freeze_rows, 0.2f, 0, 9, NULL, ImGuiSliderFlags_NoInput); PopStyleCompact(); // When using ScrollX or ScrollY we need to specify a size for our table container! // Otherwise by default the table will fit all available space, like a BeginChild() call. ImVec2 outer_size = ImVec2(0.0f, TEXT_BASE_HEIGHT * 8); if (ImGui::BeginTable("table_scrollx", 7, flags, outer_size)) { ImGui::TableSetupScrollFreeze(freeze_cols, freeze_rows); ImGui::TableSetupColumn("Line #", ImGuiTableColumnFlags_NoHide); // Make the first column not hideable to match our use of TableSetupScrollFreeze() ImGui::TableSetupColumn("One"); ImGui::TableSetupColumn("Two"); ImGui::TableSetupColumn("Three"); ImGui::TableSetupColumn("Four"); ImGui::TableSetupColumn("Five"); ImGui::TableSetupColumn("Six"); ImGui::TableHeadersRow(); for (int row = 0; row < 20; row++) { ImGui::TableNextRow(); for (int column = 0; column < 7; column++) { // Both TableNextColumn() and TableSetColumnIndex() return true when a column is visible or performing width measurement. // Because here we know that: // - A) all our columns are contributing the same to row height // - B) column 0 is always visible, // We only always submit this one column and can skip others. // More advanced per-column clipping behaviors may benefit from polling the status flags via TableGetColumnFlags(). if (!ImGui::TableSetColumnIndex(column) && column > 0) continue; if (column == 0) ImGui::Text("Line %d", row); else ImGui::Text("Hello world %d,%d", column, row); } } ImGui::EndTable(); } ImGui::Spacing(); ImGui::TextUnformatted("Stretch + ScrollX"); ImGui::SameLine(); HelpMarker( "Showcase using Stretch columns + ScrollX together: " "this is rather unusual and only makes sense when specifying an 'inner_width' for the table!\n" "Without an explicit value, inner_width is == outer_size.x and therefore using Stretch columns " "along with ScrollX doesn't make sense."); static ImGuiTableFlags flags2 = ImGuiTableFlags_SizingStretchSame | ImGuiTableFlags_ScrollX | ImGuiTableFlags_ScrollY | ImGuiTableFlags_BordersOuter | ImGuiTableFlags_RowBg | ImGuiTableFlags_ContextMenuInBody; static float inner_width = 1000.0f; PushStyleCompact(); ImGui::PushID("flags3"); ImGui::PushItemWidth(TEXT_BASE_WIDTH * 30); ImGui::CheckboxFlags("ImGuiTableFlags_ScrollX", &flags2, ImGuiTableFlags_ScrollX); ImGui::DragFloat("inner_width", &inner_width, 1.0f, 0.0f, FLT_MAX, "%.1f"); ImGui::PopItemWidth(); ImGui::PopID(); PopStyleCompact(); if (ImGui::BeginTable("table2", 7, flags2, outer_size, inner_width)) { for (int cell = 0; cell < 20 * 7; cell++) { ImGui::TableNextColumn(); ImGui::Text("Hello world %d,%d", ImGui::TableGetColumnIndex(), ImGui::TableGetRowIndex()); } ImGui::EndTable(); } ImGui::TreePop(); } if (open_action != -1) ImGui::SetNextItemOpen(open_action != 0); IMGUI_DEMO_MARKER("Tables/Columns flags"); if (ImGui::TreeNode("Columns flags")) { // Create a first table just to show all the options/flags we want to make visible in our example! const int column_count = 3; const char* column_names[column_count] = { "One", "Two", "Three" }; static ImGuiTableColumnFlags column_flags[column_count] = { ImGuiTableColumnFlags_DefaultSort, ImGuiTableColumnFlags_None, ImGuiTableColumnFlags_DefaultHide }; static ImGuiTableColumnFlags column_flags_out[column_count] = { 0, 0, 0 }; // Output from TableGetColumnFlags() if (ImGui::BeginTable("table_columns_flags_checkboxes", column_count, ImGuiTableFlags_None)) { PushStyleCompact(); for (int column = 0; column < column_count; column++) { ImGui::TableNextColumn(); ImGui::PushID(column); ImGui::AlignTextToFramePadding(); // FIXME-TABLE: Workaround for wrong text baseline propagation across columns ImGui::Text("'%s'", column_names[column]); ImGui::Spacing(); ImGui::Text("Input flags:"); EditTableColumnsFlags(&column_flags[column]); ImGui::Spacing(); ImGui::Text("Output flags:"); ImGui::BeginDisabled(); ShowTableColumnsStatusFlags(column_flags_out[column]); ImGui::EndDisabled(); ImGui::PopID(); } PopStyleCompact(); ImGui::EndTable(); } // Create the real table we care about for the example! // We use a scrolling table to be able to showcase the difference between the _IsEnabled and _IsVisible flags above, // otherwise in a non-scrolling table columns are always visible (unless using ImGuiTableFlags_NoKeepColumnsVisible // + resizing the parent window down). const ImGuiTableFlags flags = ImGuiTableFlags_SizingFixedFit | ImGuiTableFlags_ScrollX | ImGuiTableFlags_ScrollY | ImGuiTableFlags_RowBg | ImGuiTableFlags_BordersOuter | ImGuiTableFlags_BordersV | ImGuiTableFlags_Resizable | ImGuiTableFlags_Reorderable | ImGuiTableFlags_Hideable | ImGuiTableFlags_Sortable; ImVec2 outer_size = ImVec2(0.0f, TEXT_BASE_HEIGHT * 9); if (ImGui::BeginTable("table_columns_flags", column_count, flags, outer_size)) { bool has_angled_header = false; for (int column = 0; column < column_count; column++) { has_angled_header |= (column_flags[column] & ImGuiTableColumnFlags_AngledHeader) != 0; ImGui::TableSetupColumn(column_names[column], column_flags[column]); } if (has_angled_header) ImGui::TableAngledHeadersRow(); ImGui::TableHeadersRow(); for (int column = 0; column < column_count; column++) column_flags_out[column] = ImGui::TableGetColumnFlags(column); float indent_step = (float)((int)TEXT_BASE_WIDTH / 2); for (int row = 0; row < 8; row++) { // Add some indentation to demonstrate usage of per-column IndentEnable/IndentDisable flags. ImGui::Indent(indent_step); ImGui::TableNextRow(); for (int column = 0; column < column_count; column++) { ImGui::TableSetColumnIndex(column); ImGui::Text("%s %s", (column == 0) ? "Indented" : "Hello", ImGui::TableGetColumnName(column)); } } ImGui::Unindent(indent_step * 8.0f); ImGui::EndTable(); } ImGui::TreePop(); } if (open_action != -1) ImGui::SetNextItemOpen(open_action != 0); IMGUI_DEMO_MARKER("Tables/Columns widths"); if (ImGui::TreeNode("Columns widths")) { HelpMarker("Using TableSetupColumn() to setup default width."); static ImGuiTableFlags flags1 = ImGuiTableFlags_Borders | ImGuiTableFlags_NoBordersInBodyUntilResize; PushStyleCompact(); ImGui::CheckboxFlags("ImGuiTableFlags_Resizable", &flags1, ImGuiTableFlags_Resizable); ImGui::CheckboxFlags("ImGuiTableFlags_NoBordersInBodyUntilResize", &flags1, ImGuiTableFlags_NoBordersInBodyUntilResize); PopStyleCompact(); if (ImGui::BeginTable("table1", 3, flags1)) { // We could also set ImGuiTableFlags_SizingFixedFit on the table and all columns will default to ImGuiTableColumnFlags_WidthFixed. ImGui::TableSetupColumn("one", ImGuiTableColumnFlags_WidthFixed, 100.0f); // Default to 100.0f ImGui::TableSetupColumn("two", ImGuiTableColumnFlags_WidthFixed, 200.0f); // Default to 200.0f ImGui::TableSetupColumn("three", ImGuiTableColumnFlags_WidthFixed); // Default to auto ImGui::TableHeadersRow(); for (int row = 0; row < 4; row++) { ImGui::TableNextRow(); for (int column = 0; column < 3; column++) { ImGui::TableSetColumnIndex(column); if (row == 0) ImGui::Text("(w: %5.1f)", ImGui::GetContentRegionAvail().x); else ImGui::Text("Hello %d,%d", column, row); } } ImGui::EndTable(); } HelpMarker( "Using TableSetupColumn() to setup explicit width.\n\nUnless _NoKeepColumnsVisible is set, " "fixed columns with set width may still be shrunk down if there's not enough space in the host."); static ImGuiTableFlags flags2 = ImGuiTableFlags_None; PushStyleCompact(); ImGui::CheckboxFlags("ImGuiTableFlags_NoKeepColumnsVisible", &flags2, ImGuiTableFlags_NoKeepColumnsVisible); ImGui::CheckboxFlags("ImGuiTableFlags_BordersInnerV", &flags2, ImGuiTableFlags_BordersInnerV); ImGui::CheckboxFlags("ImGuiTableFlags_BordersOuterV", &flags2, ImGuiTableFlags_BordersOuterV); PopStyleCompact(); if (ImGui::BeginTable("table2", 4, flags2)) { // We could also set ImGuiTableFlags_SizingFixedFit on the table and then all columns // will default to ImGuiTableColumnFlags_WidthFixed. ImGui::TableSetupColumn("", ImGuiTableColumnFlags_WidthFixed, 100.0f); ImGui::TableSetupColumn("", ImGuiTableColumnFlags_WidthFixed, TEXT_BASE_WIDTH * 15.0f); ImGui::TableSetupColumn("", ImGuiTableColumnFlags_WidthFixed, TEXT_BASE_WIDTH * 30.0f); ImGui::TableSetupColumn("", ImGuiTableColumnFlags_WidthFixed, TEXT_BASE_WIDTH * 15.0f); for (int row = 0; row < 5; row++) { ImGui::TableNextRow(); for (int column = 0; column < 4; column++) { ImGui::TableSetColumnIndex(column); if (row == 0) ImGui::Text("(w: %5.1f)", ImGui::GetContentRegionAvail().x); else ImGui::Text("Hello %d,%d", column, row); } } ImGui::EndTable(); } ImGui::TreePop(); } if (open_action != -1) ImGui::SetNextItemOpen(open_action != 0); IMGUI_DEMO_MARKER("Tables/Nested tables"); if (ImGui::TreeNode("Nested tables")) { HelpMarker("This demonstrates embedding a table into another table cell."); if (ImGui::BeginTable("table_nested1", 2, ImGuiTableFlags_Borders | ImGuiTableFlags_Resizable | ImGuiTableFlags_Reorderable | ImGuiTableFlags_Hideable)) { ImGui::TableSetupColumn("A0"); ImGui::TableSetupColumn("A1"); ImGui::TableHeadersRow(); ImGui::TableNextColumn(); ImGui::Text("A0 Row 0"); { float rows_height = TEXT_BASE_HEIGHT * 2; if (ImGui::BeginTable("table_nested2", 2, ImGuiTableFlags_Borders | ImGuiTableFlags_Resizable | ImGuiTableFlags_Reorderable | ImGuiTableFlags_Hideable)) { ImGui::TableSetupColumn("B0"); ImGui::TableSetupColumn("B1"); ImGui::TableHeadersRow(); ImGui::TableNextRow(ImGuiTableRowFlags_None, rows_height); ImGui::TableNextColumn(); ImGui::Text("B0 Row 0"); ImGui::TableNextColumn(); ImGui::Text("B1 Row 0"); ImGui::TableNextRow(ImGuiTableRowFlags_None, rows_height); ImGui::TableNextColumn(); ImGui::Text("B0 Row 1"); ImGui::TableNextColumn(); ImGui::Text("B1 Row 1"); ImGui::EndTable(); } } ImGui::TableNextColumn(); ImGui::Text("A1 Row 0"); ImGui::TableNextColumn(); ImGui::Text("A0 Row 1"); ImGui::TableNextColumn(); ImGui::Text("A1 Row 1"); ImGui::EndTable(); } ImGui::TreePop(); } if (open_action != -1) ImGui::SetNextItemOpen(open_action != 0); IMGUI_DEMO_MARKER("Tables/Row height"); if (ImGui::TreeNode("Row height")) { HelpMarker( "You can pass a 'min_row_height' to TableNextRow().\n\nRows are padded with 'style.CellPadding.y' on top and bottom, " "so effectively the minimum row height will always be >= 'style.CellPadding.y * 2.0f'.\n\n" "We cannot honor a _maximum_ row height as that would require a unique clipping rectangle per row."); if (ImGui::BeginTable("table_row_height", 1, ImGuiTableFlags_Borders)) { for (int row = 0; row < 8; row++) { float min_row_height = (float)(int)(TEXT_BASE_HEIGHT * 0.30f * row); ImGui::TableNextRow(ImGuiTableRowFlags_None, min_row_height); ImGui::TableNextColumn(); ImGui::Text("min_row_height = %.2f", min_row_height); } ImGui::EndTable(); } HelpMarker( "Showcase using SameLine(0,0) to share Current Line Height between cells.\n\n" "Please note that Tables Row Height is not the same thing as Current Line Height, " "as a table cell may contains multiple lines."); if (ImGui::BeginTable("table_share_lineheight", 2, ImGuiTableFlags_Borders)) { ImGui::TableNextRow(); ImGui::TableNextColumn(); ImGui::ColorButton("##1", ImVec4(0.13f, 0.26f, 0.40f, 1.0f), ImGuiColorEditFlags_None, ImVec2(40, 40)); ImGui::TableNextColumn(); ImGui::Text("Line 1"); ImGui::Text("Line 2"); ImGui::TableNextRow(); ImGui::TableNextColumn(); ImGui::ColorButton("##2", ImVec4(0.13f, 0.26f, 0.40f, 1.0f), ImGuiColorEditFlags_None, ImVec2(40, 40)); ImGui::TableNextColumn(); ImGui::SameLine(0.0f, 0.0f); // Reuse line height from previous column ImGui::Text("Line 1, with SameLine(0,0)"); ImGui::Text("Line 2"); ImGui::EndTable(); } HelpMarker("Showcase altering CellPadding.y between rows. Note that CellPadding.x is locked for the entire table."); if (ImGui::BeginTable("table_changing_cellpadding_y", 1, ImGuiTableFlags_Borders)) { ImGuiStyle& style = ImGui::GetStyle(); for (int row = 0; row < 8; row++) { if ((row % 3) == 2) ImGui::PushStyleVarY(ImGuiStyleVar_CellPadding, 20.0f); ImGui::TableNextRow(ImGuiTableRowFlags_None); ImGui::TableNextColumn(); ImGui::Text("CellPadding.y = %.2f", style.CellPadding.y); if ((row % 3) == 2) ImGui::PopStyleVar(); } ImGui::EndTable(); } ImGui::TreePop(); } if (open_action != -1) ImGui::SetNextItemOpen(open_action != 0); IMGUI_DEMO_MARKER("Tables/Outer size"); if (ImGui::TreeNode("Outer size")) { // Showcasing use of ImGuiTableFlags_NoHostExtendX and ImGuiTableFlags_NoHostExtendY // Important to that note how the two flags have slightly different behaviors! ImGui::Text("Using NoHostExtendX and NoHostExtendY:"); PushStyleCompact(); static ImGuiTableFlags flags = ImGuiTableFlags_Borders | ImGuiTableFlags_Resizable | ImGuiTableFlags_ContextMenuInBody | ImGuiTableFlags_RowBg | ImGuiTableFlags_SizingFixedFit | ImGuiTableFlags_NoHostExtendX; ImGui::CheckboxFlags("ImGuiTableFlags_NoHostExtendX", &flags, ImGuiTableFlags_NoHostExtendX); ImGui::SameLine(); HelpMarker("Make outer width auto-fit to columns, overriding outer_size.x value.\n\nOnly available when ScrollX/ScrollY are disabled and Stretch columns are not used."); ImGui::CheckboxFlags("ImGuiTableFlags_NoHostExtendY", &flags, ImGuiTableFlags_NoHostExtendY); ImGui::SameLine(); HelpMarker("Make outer height stop exactly at outer_size.y (prevent auto-extending table past the limit).\n\nOnly available when ScrollX/ScrollY are disabled. Data below the limit will be clipped and not visible."); PopStyleCompact(); ImVec2 outer_size = ImVec2(0.0f, TEXT_BASE_HEIGHT * 5.5f); if (ImGui::BeginTable("table1", 3, flags, outer_size)) { for (int row = 0; row < 10; row++) { ImGui::TableNextRow(); for (int column = 0; column < 3; column++) { ImGui::TableNextColumn(); ImGui::Text("Cell %d,%d", column, row); } } ImGui::EndTable(); } ImGui::SameLine(); ImGui::Text("Hello!"); ImGui::Spacing(); ImGui::Text("Using explicit size:"); if (ImGui::BeginTable("table2", 3, ImGuiTableFlags_Borders | ImGuiTableFlags_RowBg, ImVec2(TEXT_BASE_WIDTH * 30, 0.0f))) { for (int row = 0; row < 5; row++) { ImGui::TableNextRow(); for (int column = 0; column < 3; column++) { ImGui::TableNextColumn(); ImGui::Text("Cell %d,%d", column, row); } } ImGui::EndTable(); } ImGui::SameLine(); if (ImGui::BeginTable("table3", 3, ImGuiTableFlags_Borders | ImGuiTableFlags_RowBg, ImVec2(TEXT_BASE_WIDTH * 30, 0.0f))) { for (int row = 0; row < 3; row++) { ImGui::TableNextRow(0, TEXT_BASE_HEIGHT * 1.5f); for (int column = 0; column < 3; column++) { ImGui::TableNextColumn(); ImGui::Text("Cell %d,%d", column, row); } } ImGui::EndTable(); } ImGui::TreePop(); } if (open_action != -1) ImGui::SetNextItemOpen(open_action != 0); IMGUI_DEMO_MARKER("Tables/Background color"); if (ImGui::TreeNode("Background color")) { static ImGuiTableFlags flags = ImGuiTableFlags_RowBg; static int row_bg_type = 1; static int row_bg_target = 1; static int cell_bg_type = 1; PushStyleCompact(); ImGui::CheckboxFlags("ImGuiTableFlags_Borders", &flags, ImGuiTableFlags_Borders); ImGui::CheckboxFlags("ImGuiTableFlags_RowBg", &flags, ImGuiTableFlags_RowBg); ImGui::SameLine(); HelpMarker("ImGuiTableFlags_RowBg automatically sets RowBg0 to alternative colors pulled from the Style."); ImGui::Combo("row bg type", (int*)&row_bg_type, "None\0Red\0Gradient\0"); ImGui::Combo("row bg target", (int*)&row_bg_target, "RowBg0\0RowBg1\0"); ImGui::SameLine(); HelpMarker("Target RowBg0 to override the alternating odd/even colors,\nTarget RowBg1 to blend with them."); ImGui::Combo("cell bg type", (int*)&cell_bg_type, "None\0Blue\0"); ImGui::SameLine(); HelpMarker("We are colorizing cells to B1->C2 here."); IM_ASSERT(row_bg_type >= 0 && row_bg_type <= 2); IM_ASSERT(row_bg_target >= 0 && row_bg_target <= 1); IM_ASSERT(cell_bg_type >= 0 && cell_bg_type <= 1); PopStyleCompact(); if (ImGui::BeginTable("table1", 5, flags)) { for (int row = 0; row < 6; row++) { ImGui::TableNextRow(); // Demonstrate setting a row background color with 'ImGui::TableSetBgColor(ImGuiTableBgTarget_RowBgX, ...)' // We use a transparent color so we can see the one behind in case our target is RowBg1 and RowBg0 was already targeted by the ImGuiTableFlags_RowBg flag. if (row_bg_type != 0) { ImU32 row_bg_color = ImGui::GetColorU32(row_bg_type == 1 ? ImVec4(0.7f, 0.3f, 0.3f, 0.65f) : ImVec4(0.2f + row * 0.1f, 0.2f, 0.2f, 0.65f)); // Flat or Gradient? ImGui::TableSetBgColor(ImGuiTableBgTarget_RowBg0 + row_bg_target, row_bg_color); } // Fill cells for (int column = 0; column < 5; column++) { ImGui::TableSetColumnIndex(column); ImGui::Text("%c%c", 'A' + row, '0' + column); // Change background of Cells B1->C2 // Demonstrate setting a cell background color with 'ImGui::TableSetBgColor(ImGuiTableBgTarget_CellBg, ...)' // (the CellBg color will be blended over the RowBg and ColumnBg colors) // We can also pass a column number as a third parameter to TableSetBgColor() and do this outside the column loop. if (row >= 1 && row <= 2 && column >= 1 && column <= 2 && cell_bg_type == 1) { ImU32 cell_bg_color = ImGui::GetColorU32(ImVec4(0.3f, 0.3f, 0.7f, 0.65f)); ImGui::TableSetBgColor(ImGuiTableBgTarget_CellBg, cell_bg_color); } } } ImGui::EndTable(); } ImGui::TreePop(); } if (open_action != -1) ImGui::SetNextItemOpen(open_action != 0); IMGUI_DEMO_MARKER("Tables/Tree view"); if (ImGui::TreeNode("Tree view")) { static ImGuiTableFlags table_flags = ImGuiTableFlags_BordersV | ImGuiTableFlags_BordersOuterH | ImGuiTableFlags_Resizable | ImGuiTableFlags_RowBg | ImGuiTableFlags_NoBordersInBody; static ImGuiTreeNodeFlags tree_node_flags_base = ImGuiTreeNodeFlags_SpanAllColumns; ImGui::CheckboxFlags("ImGuiTreeNodeFlags_SpanFullWidth", &tree_node_flags_base, ImGuiTreeNodeFlags_SpanFullWidth); ImGui::CheckboxFlags("ImGuiTreeNodeFlags_SpanLabelWidth", &tree_node_flags_base, ImGuiTreeNodeFlags_SpanLabelWidth); ImGui::CheckboxFlags("ImGuiTreeNodeFlags_SpanAllColumns", &tree_node_flags_base, ImGuiTreeNodeFlags_SpanAllColumns); ImGui::CheckboxFlags("ImGuiTreeNodeFlags_LabelSpanAllColumns", &tree_node_flags_base, ImGuiTreeNodeFlags_LabelSpanAllColumns); ImGui::SameLine(); HelpMarker("Useful if you know that you aren't displaying contents in other columns"); HelpMarker("See \"Columns flags\" section to configure how indentation is applied to individual columns."); if (ImGui::BeginTable("3ways", 3, table_flags)) { // The first column will use the default _WidthStretch when ScrollX is Off and _WidthFixed when ScrollX is On ImGui::TableSetupColumn("Name", ImGuiTableColumnFlags_NoHide); ImGui::TableSetupColumn("Size", ImGuiTableColumnFlags_WidthFixed, TEXT_BASE_WIDTH * 12.0f); ImGui::TableSetupColumn("Type", ImGuiTableColumnFlags_WidthFixed, TEXT_BASE_WIDTH * 18.0f); ImGui::TableHeadersRow(); // Simple storage to output a dummy file-system. struct MyTreeNode { const char* Name; const char* Type; int Size; int ChildIdx; int ChildCount; static void DisplayNode(const MyTreeNode* node, const MyTreeNode* all_nodes) { ImGui::TableNextRow(); ImGui::TableNextColumn(); const bool is_folder = (node->ChildCount > 0); ImGuiTreeNodeFlags node_flags = tree_node_flags_base; if (node != &all_nodes[0]) node_flags &= ~ImGuiTreeNodeFlags_LabelSpanAllColumns; // Only demonstrate this on the root node. if (is_folder) { bool open = ImGui::TreeNodeEx(node->Name, node_flags); if ((node_flags & ImGuiTreeNodeFlags_LabelSpanAllColumns) == 0) { ImGui::TableNextColumn(); ImGui::TextDisabled("--"); ImGui::TableNextColumn(); ImGui::TextUnformatted(node->Type); } if (open) { for (int child_n = 0; child_n < node->ChildCount; child_n++) DisplayNode(&all_nodes[node->ChildIdx + child_n], all_nodes); ImGui::TreePop(); } } else { ImGui::TreeNodeEx(node->Name, node_flags | ImGuiTreeNodeFlags_Leaf | ImGuiTreeNodeFlags_Bullet | ImGuiTreeNodeFlags_NoTreePushOnOpen); ImGui::TableNextColumn(); ImGui::Text("%d", node->Size); ImGui::TableNextColumn(); ImGui::TextUnformatted(node->Type); } } }; static const MyTreeNode nodes[] = { { "Root with Long Name", "Folder", -1, 1, 3 }, // 0 { "Music", "Folder", -1, 4, 2 }, // 1 { "Textures", "Folder", -1, 6, 3 }, // 2 { "desktop.ini", "System file", 1024, -1,-1 }, // 3 { "File1_a.wav", "Audio file", 123000, -1,-1 }, // 4 { "File1_b.wav", "Audio file", 456000, -1,-1 }, // 5 { "Image001.png", "Image file", 203128, -1,-1 }, // 6 { "Copy of Image001.png", "Image file", 203256, -1,-1 }, // 7 { "Copy of Image001 (Final2).png","Image file", 203512, -1,-1 }, // 8 }; MyTreeNode::DisplayNode(&nodes[0], nodes); ImGui::EndTable(); } ImGui::TreePop(); } if (open_action != -1) ImGui::SetNextItemOpen(open_action != 0); IMGUI_DEMO_MARKER("Tables/Item width"); if (ImGui::TreeNode("Item width")) { HelpMarker( "Showcase using PushItemWidth() and how it is preserved on a per-column basis.\n\n" "Note that on auto-resizing non-resizable fixed columns, querying the content width for " "e.g. right-alignment doesn't make sense."); if (ImGui::BeginTable("table_item_width", 3, ImGuiTableFlags_Borders)) { ImGui::TableSetupColumn("small"); ImGui::TableSetupColumn("half"); ImGui::TableSetupColumn("right-align"); ImGui::TableHeadersRow(); for (int row = 0; row < 3; row++) { ImGui::TableNextRow(); if (row == 0) { // Setup ItemWidth once (instead of setting up every time, which is also possible but less efficient) ImGui::TableSetColumnIndex(0); ImGui::PushItemWidth(TEXT_BASE_WIDTH * 3.0f); // Small ImGui::TableSetColumnIndex(1); ImGui::PushItemWidth(-ImGui::GetContentRegionAvail().x * 0.5f); ImGui::TableSetColumnIndex(2); ImGui::PushItemWidth(-FLT_MIN); // Right-aligned } // Draw our contents static float dummy_f = 0.0f; ImGui::PushID(row); ImGui::TableSetColumnIndex(0); ImGui::SliderFloat("float0", &dummy_f, 0.0f, 1.0f); ImGui::TableSetColumnIndex(1); ImGui::SliderFloat("float1", &dummy_f, 0.0f, 1.0f); ImGui::TableSetColumnIndex(2); ImGui::SliderFloat("##float2", &dummy_f, 0.0f, 1.0f); // No visible label since right-aligned ImGui::PopID(); } ImGui::EndTable(); } ImGui::TreePop(); } // Demonstrate using TableHeader() calls instead of TableHeadersRow() if (open_action != -1) ImGui::SetNextItemOpen(open_action != 0); IMGUI_DEMO_MARKER("Tables/Custom headers"); if (ImGui::TreeNode("Custom headers")) { const int COLUMNS_COUNT = 3; if (ImGui::BeginTable("table_custom_headers", COLUMNS_COUNT, ImGuiTableFlags_Borders | ImGuiTableFlags_Reorderable | ImGuiTableFlags_Hideable)) { ImGui::TableSetupColumn("Apricot"); ImGui::TableSetupColumn("Banana"); ImGui::TableSetupColumn("Cherry"); // Dummy entire-column selection storage // FIXME: It would be nice to actually demonstrate full-featured selection using those checkbox. static bool column_selected[3] = {}; // Instead of calling TableHeadersRow() we'll submit custom headers ourselves. // (A different approach is also possible: // - Specify ImGuiTableColumnFlags_NoHeaderLabel in some TableSetupColumn() call. // - Call TableHeadersRow() normally. This will submit TableHeader() with no name. // - Then call TableSetColumnIndex() to position yourself in the column and submit your stuff e.g. Checkbox().) ImGui::TableNextRow(ImGuiTableRowFlags_Headers); for (int column = 0; column < COLUMNS_COUNT; column++) { ImGui::TableSetColumnIndex(column); const char* column_name = ImGui::TableGetColumnName(column); // Retrieve name passed to TableSetupColumn() ImGui::PushID(column); ImGui::PushStyleVar(ImGuiStyleVar_FramePadding, ImVec2(0, 0)); ImGui::Checkbox("##checkall", &column_selected[column]); ImGui::PopStyleVar(); ImGui::SameLine(0.0f, ImGui::GetStyle().ItemInnerSpacing.x); ImGui::TableHeader(column_name); ImGui::PopID(); } // Submit table contents for (int row = 0; row < 5; row++) { ImGui::TableNextRow(); for (int column = 0; column < 3; column++) { char buf[32]; sprintf(buf, "Cell %d,%d", column, row); ImGui::TableSetColumnIndex(column); ImGui::Selectable(buf, column_selected[column]); } } ImGui::EndTable(); } ImGui::TreePop(); } // Demonstrate using ImGuiTableColumnFlags_AngledHeader flag to create angled headers if (open_action != -1) ImGui::SetNextItemOpen(open_action != 0); IMGUI_DEMO_MARKER("Tables/Angled headers"); if (ImGui::TreeNode("Angled headers")) { const char* column_names[] = { "Track", "cabasa", "ride", "smash", "tom-hi", "tom-mid", "tom-low", "hihat-o", "hihat-c", "snare-s", "snare-c", "clap", "rim", "kick" }; const int columns_count = IM_ARRAYSIZE(column_names); const int rows_count = 12; static ImGuiTableFlags table_flags = ImGuiTableFlags_SizingFixedFit | ImGuiTableFlags_ScrollX | ImGuiTableFlags_ScrollY | ImGuiTableFlags_BordersOuter | ImGuiTableFlags_BordersInnerH | ImGuiTableFlags_Hideable | ImGuiTableFlags_Resizable | ImGuiTableFlags_Reorderable | ImGuiTableFlags_HighlightHoveredColumn; static ImGuiTableColumnFlags column_flags = ImGuiTableColumnFlags_AngledHeader | ImGuiTableColumnFlags_WidthFixed; static bool bools[columns_count * rows_count] = {}; // Dummy storage selection storage static int frozen_cols = 1; static int frozen_rows = 2; ImGui::CheckboxFlags("_ScrollX", &table_flags, ImGuiTableFlags_ScrollX); ImGui::CheckboxFlags("_ScrollY", &table_flags, ImGuiTableFlags_ScrollY); ImGui::CheckboxFlags("_Resizable", &table_flags, ImGuiTableFlags_Resizable); ImGui::CheckboxFlags("_Sortable", &table_flags, ImGuiTableFlags_Sortable); ImGui::CheckboxFlags("_NoBordersInBody", &table_flags, ImGuiTableFlags_NoBordersInBody); ImGui::CheckboxFlags("_HighlightHoveredColumn", &table_flags, ImGuiTableFlags_HighlightHoveredColumn); ImGui::SetNextItemWidth(ImGui::GetFontSize() * 8); ImGui::SliderInt("Frozen columns", &frozen_cols, 0, 2); ImGui::SetNextItemWidth(ImGui::GetFontSize() * 8); ImGui::SliderInt("Frozen rows", &frozen_rows, 0, 2); ImGui::CheckboxFlags("Disable header contributing to column width", &column_flags, ImGuiTableColumnFlags_NoHeaderWidth); if (ImGui::TreeNode("Style settings")) { ImGui::SameLine(); HelpMarker("Giving access to some ImGuiStyle value in this demo for convenience."); ImGui::SetNextItemWidth(ImGui::GetFontSize() * 8); ImGui::SliderAngle("style.TableAngledHeadersAngle", &ImGui::GetStyle().TableAngledHeadersAngle, -50.0f, +50.0f); ImGui::SetNextItemWidth(ImGui::GetFontSize() * 8); ImGui::SliderFloat2("style.TableAngledHeadersTextAlign", (float*)&ImGui::GetStyle().TableAngledHeadersTextAlign, 0.0f, 1.0f, "%.2f"); ImGui::TreePop(); } if (ImGui::BeginTable("table_angled_headers", columns_count, table_flags, ImVec2(0.0f, TEXT_BASE_HEIGHT * 12))) { ImGui::TableSetupColumn(column_names[0], ImGuiTableColumnFlags_NoHide | ImGuiTableColumnFlags_NoReorder); for (int n = 1; n < columns_count; n++) ImGui::TableSetupColumn(column_names[n], column_flags); ImGui::TableSetupScrollFreeze(frozen_cols, frozen_rows); ImGui::TableAngledHeadersRow(); // Draw angled headers for all columns with the ImGuiTableColumnFlags_AngledHeader flag. ImGui::TableHeadersRow(); // Draw remaining headers and allow access to context-menu and other functions. for (int row = 0; row < rows_count; row++) { ImGui::PushID(row); ImGui::TableNextRow(); ImGui::TableSetColumnIndex(0); ImGui::AlignTextToFramePadding(); ImGui::Text("Track %d", row); for (int column = 1; column < columns_count; column++) if (ImGui::TableSetColumnIndex(column)) { ImGui::PushID(column); ImGui::Checkbox("", &bools[row * columns_count + column]); ImGui::PopID(); } ImGui::PopID(); } ImGui::EndTable(); } ImGui::TreePop(); } // Demonstrate creating custom context menus inside columns, // while playing it nice with context menus provided by TableHeadersRow()/TableHeader() if (open_action != -1) ImGui::SetNextItemOpen(open_action != 0); IMGUI_DEMO_MARKER("Tables/Context menus"); if (ImGui::TreeNode("Context menus")) { HelpMarker( "By default, right-clicking over a TableHeadersRow()/TableHeader() line will open the default context-menu.\n" "Using ImGuiTableFlags_ContextMenuInBody we also allow right-clicking over columns body."); static ImGuiTableFlags flags1 = ImGuiTableFlags_Resizable | ImGuiTableFlags_Reorderable | ImGuiTableFlags_Hideable | ImGuiTableFlags_Borders | ImGuiTableFlags_ContextMenuInBody; PushStyleCompact(); ImGui::CheckboxFlags("ImGuiTableFlags_ContextMenuInBody", &flags1, ImGuiTableFlags_ContextMenuInBody); PopStyleCompact(); // Context Menus: first example // [1.1] Right-click on the TableHeadersRow() line to open the default table context menu. // [1.2] Right-click in columns also open the default table context menu (if ImGuiTableFlags_ContextMenuInBody is set) const int COLUMNS_COUNT = 3; if (ImGui::BeginTable("table_context_menu", COLUMNS_COUNT, flags1)) { ImGui::TableSetupColumn("One"); ImGui::TableSetupColumn("Two"); ImGui::TableSetupColumn("Three"); // [1.1]] Right-click on the TableHeadersRow() line to open the default table context menu. ImGui::TableHeadersRow(); // Submit dummy contents for (int row = 0; row < 4; row++) { ImGui::TableNextRow(); for (int column = 0; column < COLUMNS_COUNT; column++) { ImGui::TableSetColumnIndex(column); ImGui::Text("Cell %d,%d", column, row); } } ImGui::EndTable(); } // Context Menus: second example // [2.1] Right-click on the TableHeadersRow() line to open the default table context menu. // [2.2] Right-click on the ".." to open a custom popup // [2.3] Right-click in columns to open another custom popup HelpMarker( "Demonstrate mixing table context menu (over header), item context button (over button) " "and custom per-colunm context menu (over column body)."); ImGuiTableFlags flags2 = ImGuiTableFlags_Resizable | ImGuiTableFlags_SizingFixedFit | ImGuiTableFlags_Reorderable | ImGuiTableFlags_Hideable | ImGuiTableFlags_Borders; if (ImGui::BeginTable("table_context_menu_2", COLUMNS_COUNT, flags2)) { ImGui::TableSetupColumn("One"); ImGui::TableSetupColumn("Two"); ImGui::TableSetupColumn("Three"); // [2.1] Right-click on the TableHeadersRow() line to open the default table context menu. ImGui::TableHeadersRow(); for (int row = 0; row < 4; row++) { ImGui::TableNextRow(); for (int column = 0; column < COLUMNS_COUNT; column++) { // Submit dummy contents ImGui::TableSetColumnIndex(column); ImGui::Text("Cell %d,%d", column, row); ImGui::SameLine(); // [2.2] Right-click on the ".." to open a custom popup ImGui::PushID(row * COLUMNS_COUNT + column); ImGui::SmallButton(".."); if (ImGui::BeginPopupContextItem()) { ImGui::Text("This is the popup for Button(\"..\") in Cell %d,%d", column, row); if (ImGui::Button("Close")) ImGui::CloseCurrentPopup(); ImGui::EndPopup(); } ImGui::PopID(); } } // [2.3] Right-click anywhere in columns to open another custom popup // (instead of testing for !IsAnyItemHovered() we could also call OpenPopup() with ImGuiPopupFlags_NoOpenOverExistingPopup // to manage popup priority as the popups triggers, here "are we hovering a column" are overlapping) int hovered_column = -1; for (int column = 0; column < COLUMNS_COUNT + 1; column++) { ImGui::PushID(column); if (ImGui::TableGetColumnFlags(column) & ImGuiTableColumnFlags_IsHovered) hovered_column = column; if (hovered_column == column && !ImGui::IsAnyItemHovered() && ImGui::IsMouseReleased(1)) ImGui::OpenPopup("MyPopup"); if (ImGui::BeginPopup("MyPopup")) { if (column == COLUMNS_COUNT) ImGui::Text("This is a custom popup for unused space after the last column."); else ImGui::Text("This is a custom popup for Column %d", column); if (ImGui::Button("Close")) ImGui::CloseCurrentPopup(); ImGui::EndPopup(); } ImGui::PopID(); } ImGui::EndTable(); ImGui::Text("Hovered column: %d", hovered_column); } ImGui::TreePop(); } // Demonstrate creating multiple tables with the same ID if (open_action != -1) ImGui::SetNextItemOpen(open_action != 0); IMGUI_DEMO_MARKER("Tables/Synced instances"); if (ImGui::TreeNode("Synced instances")) { HelpMarker("Multiple tables with the same identifier will share their settings, width, visibility, order etc."); static ImGuiTableFlags flags = ImGuiTableFlags_Resizable | ImGuiTableFlags_Reorderable | ImGuiTableFlags_Hideable | ImGuiTableFlags_Borders | ImGuiTableFlags_SizingFixedFit | ImGuiTableFlags_NoSavedSettings; ImGui::CheckboxFlags("ImGuiTableFlags_Resizable", &flags, ImGuiTableFlags_Resizable); ImGui::CheckboxFlags("ImGuiTableFlags_ScrollY", &flags, ImGuiTableFlags_ScrollY); ImGui::CheckboxFlags("ImGuiTableFlags_SizingFixedFit", &flags, ImGuiTableFlags_SizingFixedFit); ImGui::CheckboxFlags("ImGuiTableFlags_HighlightHoveredColumn", &flags, ImGuiTableFlags_HighlightHoveredColumn); for (int n = 0; n < 3; n++) { char buf[32]; sprintf(buf, "Synced Table %d", n); bool open = ImGui::CollapsingHeader(buf, ImGuiTreeNodeFlags_DefaultOpen); if (open && ImGui::BeginTable("Table", 3, flags, ImVec2(0.0f, ImGui::GetTextLineHeightWithSpacing() * 5))) { ImGui::TableSetupColumn("One"); ImGui::TableSetupColumn("Two"); ImGui::TableSetupColumn("Three"); ImGui::TableHeadersRow(); const int cell_count = (n == 1) ? 27 : 9; // Make second table have a scrollbar to verify that additional decoration is not affecting column positions. for (int cell = 0; cell < cell_count; cell++) { ImGui::TableNextColumn(); ImGui::Text("this cell %d", cell); } ImGui::EndTable(); } } ImGui::TreePop(); } // Demonstrate using Sorting facilities // This is a simplified version of the "Advanced" example, where we mostly focus on the code necessary to handle sorting. // Note that the "Advanced" example also showcase manually triggering a sort (e.g. if item quantities have been modified) static const char* template_items_names[] = { "Banana", "Apple", "Cherry", "Watermelon", "Grapefruit", "Strawberry", "Mango", "Kiwi", "Orange", "Pineapple", "Blueberry", "Plum", "Coconut", "Pear", "Apricot" }; if (open_action != -1) ImGui::SetNextItemOpen(open_action != 0); IMGUI_DEMO_MARKER("Tables/Sorting"); if (ImGui::TreeNode("Sorting")) { // Create item list static ImVector items; if (items.Size == 0) { items.resize(50, MyItem()); for (int n = 0; n < items.Size; n++) { const int template_n = n % IM_ARRAYSIZE(template_items_names); MyItem& item = items[n]; item.ID = n; item.Name = template_items_names[template_n]; item.Quantity = (n * n - n) % 20; // Assign default quantities } } // Options static ImGuiTableFlags flags = ImGuiTableFlags_Resizable | ImGuiTableFlags_Reorderable | ImGuiTableFlags_Hideable | ImGuiTableFlags_Sortable | ImGuiTableFlags_SortMulti | ImGuiTableFlags_RowBg | ImGuiTableFlags_BordersOuter | ImGuiTableFlags_BordersV | ImGuiTableFlags_NoBordersInBody | ImGuiTableFlags_ScrollY; PushStyleCompact(); ImGui::CheckboxFlags("ImGuiTableFlags_SortMulti", &flags, ImGuiTableFlags_SortMulti); ImGui::SameLine(); HelpMarker("When sorting is enabled: hold shift when clicking headers to sort on multiple column. TableGetSortSpecs() may return specs where (SpecsCount > 1)."); ImGui::CheckboxFlags("ImGuiTableFlags_SortTristate", &flags, ImGuiTableFlags_SortTristate); ImGui::SameLine(); HelpMarker("When sorting is enabled: allow no sorting, disable default sorting. TableGetSortSpecs() may return specs where (SpecsCount == 0)."); PopStyleCompact(); if (ImGui::BeginTable("table_sorting", 4, flags, ImVec2(0.0f, TEXT_BASE_HEIGHT * 15), 0.0f)) { // Declare columns // We use the "user_id" parameter of TableSetupColumn() to specify a user id that will be stored in the sort specifications. // This is so our sort function can identify a column given our own identifier. We could also identify them based on their index! // Demonstrate using a mixture of flags among available sort-related flags: // - ImGuiTableColumnFlags_DefaultSort // - ImGuiTableColumnFlags_NoSort / ImGuiTableColumnFlags_NoSortAscending / ImGuiTableColumnFlags_NoSortDescending // - ImGuiTableColumnFlags_PreferSortAscending / ImGuiTableColumnFlags_PreferSortDescending ImGui::TableSetupColumn("ID", ImGuiTableColumnFlags_DefaultSort | ImGuiTableColumnFlags_WidthFixed, 0.0f, MyItemColumnID_ID); ImGui::TableSetupColumn("Name", ImGuiTableColumnFlags_WidthFixed, 0.0f, MyItemColumnID_Name); ImGui::TableSetupColumn("Action", ImGuiTableColumnFlags_NoSort | ImGuiTableColumnFlags_WidthFixed, 0.0f, MyItemColumnID_Action); ImGui::TableSetupColumn("Quantity", ImGuiTableColumnFlags_PreferSortDescending | ImGuiTableColumnFlags_WidthStretch, 0.0f, MyItemColumnID_Quantity); ImGui::TableSetupScrollFreeze(0, 1); // Make row always visible ImGui::TableHeadersRow(); // Sort our data if sort specs have been changed! if (ImGuiTableSortSpecs* sort_specs = ImGui::TableGetSortSpecs()) if (sort_specs->SpecsDirty) { MyItem::SortWithSortSpecs(sort_specs, items.Data, items.Size); sort_specs->SpecsDirty = false; } // Demonstrate using clipper for large vertical lists ImGuiListClipper clipper; clipper.Begin(items.Size); while (clipper.Step()) for (int row_n = clipper.DisplayStart; row_n < clipper.DisplayEnd; row_n++) { // Display a data item MyItem* item = &items[row_n]; ImGui::PushID(item->ID); ImGui::TableNextRow(); ImGui::TableNextColumn(); ImGui::Text("%04d", item->ID); ImGui::TableNextColumn(); ImGui::TextUnformatted(item->Name); ImGui::TableNextColumn(); ImGui::SmallButton("None"); ImGui::TableNextColumn(); ImGui::Text("%d", item->Quantity); ImGui::PopID(); } ImGui::EndTable(); } ImGui::TreePop(); } // In this example we'll expose most table flags and settings. // For specific flags and settings refer to the corresponding section for more detailed explanation. // This section is mostly useful to experiment with combining certain flags or settings with each others. //ImGui::SetNextItemOpen(true, ImGuiCond_Once); // [DEBUG] if (open_action != -1) ImGui::SetNextItemOpen(open_action != 0); IMGUI_DEMO_MARKER("Tables/Advanced"); if (ImGui::TreeNode("Advanced")) { static ImGuiTableFlags flags = ImGuiTableFlags_Resizable | ImGuiTableFlags_Reorderable | ImGuiTableFlags_Hideable | ImGuiTableFlags_Sortable | ImGuiTableFlags_SortMulti | ImGuiTableFlags_RowBg | ImGuiTableFlags_Borders | ImGuiTableFlags_NoBordersInBody | ImGuiTableFlags_ScrollX | ImGuiTableFlags_ScrollY | ImGuiTableFlags_SizingFixedFit; static ImGuiTableColumnFlags columns_base_flags = ImGuiTableColumnFlags_None; enum ContentsType { CT_Text, CT_Button, CT_SmallButton, CT_FillButton, CT_Selectable, CT_SelectableSpanRow }; static int contents_type = CT_SelectableSpanRow; const char* contents_type_names[] = { "Text", "Button", "SmallButton", "FillButton", "Selectable", "Selectable (span row)" }; static int freeze_cols = 1; static int freeze_rows = 1; static int items_count = IM_ARRAYSIZE(template_items_names) * 2; static ImVec2 outer_size_value = ImVec2(0.0f, TEXT_BASE_HEIGHT * 12); static float row_min_height = 0.0f; // Auto static float inner_width_with_scroll = 0.0f; // Auto-extend static bool outer_size_enabled = true; static bool show_headers = true; static bool show_wrapped_text = false; //static ImGuiTextFilter filter; //ImGui::SetNextItemOpen(true, ImGuiCond_Once); // FIXME-TABLE: Enabling this results in initial clipped first pass on table which tend to affect column sizing if (ImGui::TreeNode("Options")) { // Make the UI compact because there are so many fields PushStyleCompact(); ImGui::PushItemWidth(TEXT_BASE_WIDTH * 28.0f); if (ImGui::TreeNodeEx("Features:", ImGuiTreeNodeFlags_DefaultOpen)) { ImGui::CheckboxFlags("ImGuiTableFlags_Resizable", &flags, ImGuiTableFlags_Resizable); ImGui::CheckboxFlags("ImGuiTableFlags_Reorderable", &flags, ImGuiTableFlags_Reorderable); ImGui::CheckboxFlags("ImGuiTableFlags_Hideable", &flags, ImGuiTableFlags_Hideable); ImGui::CheckboxFlags("ImGuiTableFlags_Sortable", &flags, ImGuiTableFlags_Sortable); ImGui::CheckboxFlags("ImGuiTableFlags_NoSavedSettings", &flags, ImGuiTableFlags_NoSavedSettings); ImGui::CheckboxFlags("ImGuiTableFlags_ContextMenuInBody", &flags, ImGuiTableFlags_ContextMenuInBody); ImGui::TreePop(); } if (ImGui::TreeNodeEx("Decorations:", ImGuiTreeNodeFlags_DefaultOpen)) { ImGui::CheckboxFlags("ImGuiTableFlags_RowBg", &flags, ImGuiTableFlags_RowBg); ImGui::CheckboxFlags("ImGuiTableFlags_BordersV", &flags, ImGuiTableFlags_BordersV); ImGui::CheckboxFlags("ImGuiTableFlags_BordersOuterV", &flags, ImGuiTableFlags_BordersOuterV); ImGui::CheckboxFlags("ImGuiTableFlags_BordersInnerV", &flags, ImGuiTableFlags_BordersInnerV); ImGui::CheckboxFlags("ImGuiTableFlags_BordersH", &flags, ImGuiTableFlags_BordersH); ImGui::CheckboxFlags("ImGuiTableFlags_BordersOuterH", &flags, ImGuiTableFlags_BordersOuterH); ImGui::CheckboxFlags("ImGuiTableFlags_BordersInnerH", &flags, ImGuiTableFlags_BordersInnerH); ImGui::CheckboxFlags("ImGuiTableFlags_NoBordersInBody", &flags, ImGuiTableFlags_NoBordersInBody); ImGui::SameLine(); HelpMarker("Disable vertical borders in columns Body (borders will always appear in Headers"); ImGui::CheckboxFlags("ImGuiTableFlags_NoBordersInBodyUntilResize", &flags, ImGuiTableFlags_NoBordersInBodyUntilResize); ImGui::SameLine(); HelpMarker("Disable vertical borders in columns Body until hovered for resize (borders will always appear in Headers)"); ImGui::TreePop(); } if (ImGui::TreeNodeEx("Sizing:", ImGuiTreeNodeFlags_DefaultOpen)) { EditTableSizingFlags(&flags); ImGui::SameLine(); HelpMarker("In the Advanced demo we override the policy of each column so those table-wide settings have less effect that typical."); ImGui::CheckboxFlags("ImGuiTableFlags_NoHostExtendX", &flags, ImGuiTableFlags_NoHostExtendX); ImGui::SameLine(); HelpMarker("Make outer width auto-fit to columns, overriding outer_size.x value.\n\nOnly available when ScrollX/ScrollY are disabled and Stretch columns are not used."); ImGui::CheckboxFlags("ImGuiTableFlags_NoHostExtendY", &flags, ImGuiTableFlags_NoHostExtendY); ImGui::SameLine(); HelpMarker("Make outer height stop exactly at outer_size.y (prevent auto-extending table past the limit).\n\nOnly available when ScrollX/ScrollY are disabled. Data below the limit will be clipped and not visible."); ImGui::CheckboxFlags("ImGuiTableFlags_NoKeepColumnsVisible", &flags, ImGuiTableFlags_NoKeepColumnsVisible); ImGui::SameLine(); HelpMarker("Only available if ScrollX is disabled."); ImGui::CheckboxFlags("ImGuiTableFlags_PreciseWidths", &flags, ImGuiTableFlags_PreciseWidths); ImGui::SameLine(); HelpMarker("Disable distributing remainder width to stretched columns (width allocation on a 100-wide table with 3 columns: Without this flag: 33,33,34. With this flag: 33,33,33). With larger number of columns, resizing will appear to be less smooth."); ImGui::CheckboxFlags("ImGuiTableFlags_NoClip", &flags, ImGuiTableFlags_NoClip); ImGui::SameLine(); HelpMarker("Disable clipping rectangle for every individual columns (reduce draw command count, items will be able to overflow into other columns). Generally incompatible with ScrollFreeze options."); ImGui::TreePop(); } if (ImGui::TreeNodeEx("Padding:", ImGuiTreeNodeFlags_DefaultOpen)) { ImGui::CheckboxFlags("ImGuiTableFlags_PadOuterX", &flags, ImGuiTableFlags_PadOuterX); ImGui::CheckboxFlags("ImGuiTableFlags_NoPadOuterX", &flags, ImGuiTableFlags_NoPadOuterX); ImGui::CheckboxFlags("ImGuiTableFlags_NoPadInnerX", &flags, ImGuiTableFlags_NoPadInnerX); ImGui::TreePop(); } if (ImGui::TreeNodeEx("Scrolling:", ImGuiTreeNodeFlags_DefaultOpen)) { ImGui::CheckboxFlags("ImGuiTableFlags_ScrollX", &flags, ImGuiTableFlags_ScrollX); ImGui::SameLine(); ImGui::SetNextItemWidth(ImGui::GetFrameHeight()); ImGui::DragInt("freeze_cols", &freeze_cols, 0.2f, 0, 9, NULL, ImGuiSliderFlags_NoInput); ImGui::CheckboxFlags("ImGuiTableFlags_ScrollY", &flags, ImGuiTableFlags_ScrollY); ImGui::SameLine(); ImGui::SetNextItemWidth(ImGui::GetFrameHeight()); ImGui::DragInt("freeze_rows", &freeze_rows, 0.2f, 0, 9, NULL, ImGuiSliderFlags_NoInput); ImGui::TreePop(); } if (ImGui::TreeNodeEx("Sorting:", ImGuiTreeNodeFlags_DefaultOpen)) { ImGui::CheckboxFlags("ImGuiTableFlags_SortMulti", &flags, ImGuiTableFlags_SortMulti); ImGui::SameLine(); HelpMarker("When sorting is enabled: hold shift when clicking headers to sort on multiple column. TableGetSortSpecs() may return specs where (SpecsCount > 1)."); ImGui::CheckboxFlags("ImGuiTableFlags_SortTristate", &flags, ImGuiTableFlags_SortTristate); ImGui::SameLine(); HelpMarker("When sorting is enabled: allow no sorting, disable default sorting. TableGetSortSpecs() may return specs where (SpecsCount == 0)."); ImGui::TreePop(); } if (ImGui::TreeNodeEx("Headers:", ImGuiTreeNodeFlags_DefaultOpen)) { ImGui::Checkbox("show_headers", &show_headers); ImGui::CheckboxFlags("ImGuiTableFlags_HighlightHoveredColumn", &flags, ImGuiTableFlags_HighlightHoveredColumn); ImGui::CheckboxFlags("ImGuiTableColumnFlags_AngledHeader", &columns_base_flags, ImGuiTableColumnFlags_AngledHeader); ImGui::SameLine(); HelpMarker("Enable AngledHeader on all columns. Best enabled on selected narrow columns (see \"Angled headers\" section of the demo)."); ImGui::TreePop(); } if (ImGui::TreeNodeEx("Other:", ImGuiTreeNodeFlags_DefaultOpen)) { ImGui::Checkbox("show_wrapped_text", &show_wrapped_text); ImGui::DragFloat2("##OuterSize", &outer_size_value.x); ImGui::SameLine(0.0f, ImGui::GetStyle().ItemInnerSpacing.x); ImGui::Checkbox("outer_size", &outer_size_enabled); ImGui::SameLine(); HelpMarker("If scrolling is disabled (ScrollX and ScrollY not set):\n" "- The table is output directly in the parent window.\n" "- OuterSize.x < 0.0f will right-align the table.\n" "- OuterSize.x = 0.0f will narrow fit the table unless there are any Stretch columns.\n" "- OuterSize.y then becomes the minimum size for the table, which will extend vertically if there are more rows (unless NoHostExtendY is set)."); // From a user point of view we will tend to use 'inner_width' differently depending on whether our table is embedding scrolling. // To facilitate toying with this demo we will actually pass 0.0f to the BeginTable() when ScrollX is disabled. ImGui::DragFloat("inner_width (when ScrollX active)", &inner_width_with_scroll, 1.0f, 0.0f, FLT_MAX); ImGui::DragFloat("row_min_height", &row_min_height, 1.0f, 0.0f, FLT_MAX); ImGui::SameLine(); HelpMarker("Specify height of the Selectable item."); ImGui::DragInt("items_count", &items_count, 0.1f, 0, 9999); ImGui::Combo("items_type (first column)", &contents_type, contents_type_names, IM_ARRAYSIZE(contents_type_names)); //filter.Draw("filter"); ImGui::TreePop(); } ImGui::PopItemWidth(); PopStyleCompact(); ImGui::Spacing(); ImGui::TreePop(); } // Update item list if we changed the number of items static ImVector items; static ImVector selection; static bool items_need_sort = false; if (items.Size != items_count) { items.resize(items_count, MyItem()); for (int n = 0; n < items_count; n++) { const int template_n = n % IM_ARRAYSIZE(template_items_names); MyItem& item = items[n]; item.ID = n; item.Name = template_items_names[template_n]; item.Quantity = (template_n == 3) ? 10 : (template_n == 4) ? 20 : 0; // Assign default quantities } } const ImDrawList* parent_draw_list = ImGui::GetWindowDrawList(); const int parent_draw_list_draw_cmd_count = parent_draw_list->CmdBuffer.Size; ImVec2 table_scroll_cur, table_scroll_max; // For debug display const ImDrawList* table_draw_list = NULL; // " // Submit table const float inner_width_to_use = (flags & ImGuiTableFlags_ScrollX) ? inner_width_with_scroll : 0.0f; if (ImGui::BeginTable("table_advanced", 6, flags, outer_size_enabled ? outer_size_value : ImVec2(0, 0), inner_width_to_use)) { // Declare columns // We use the "user_id" parameter of TableSetupColumn() to specify a user id that will be stored in the sort specifications. // This is so our sort function can identify a column given our own identifier. We could also identify them based on their index! ImGui::TableSetupColumn("ID", columns_base_flags | ImGuiTableColumnFlags_DefaultSort | ImGuiTableColumnFlags_WidthFixed | ImGuiTableColumnFlags_NoHide, 0.0f, MyItemColumnID_ID); ImGui::TableSetupColumn("Name", columns_base_flags | ImGuiTableColumnFlags_WidthFixed, 0.0f, MyItemColumnID_Name); ImGui::TableSetupColumn("Action", columns_base_flags | ImGuiTableColumnFlags_NoSort | ImGuiTableColumnFlags_WidthFixed, 0.0f, MyItemColumnID_Action); ImGui::TableSetupColumn("Quantity", columns_base_flags | ImGuiTableColumnFlags_PreferSortDescending, 0.0f, MyItemColumnID_Quantity); ImGui::TableSetupColumn("Description", columns_base_flags | ((flags & ImGuiTableFlags_NoHostExtendX) ? 0 : ImGuiTableColumnFlags_WidthStretch), 0.0f, MyItemColumnID_Description); ImGui::TableSetupColumn("Hidden", columns_base_flags | ImGuiTableColumnFlags_DefaultHide | ImGuiTableColumnFlags_NoSort); ImGui::TableSetupScrollFreeze(freeze_cols, freeze_rows); // Sort our data if sort specs have been changed! ImGuiTableSortSpecs* sort_specs = ImGui::TableGetSortSpecs(); if (sort_specs && sort_specs->SpecsDirty) items_need_sort = true; if (sort_specs && items_need_sort && items.Size > 1) { MyItem::SortWithSortSpecs(sort_specs, items.Data, items.Size); sort_specs->SpecsDirty = false; } items_need_sort = false; // Take note of whether we are currently sorting based on the Quantity field, // we will use this to trigger sorting when we know the data of this column has been modified. const bool sorts_specs_using_quantity = (ImGui::TableGetColumnFlags(3) & ImGuiTableColumnFlags_IsSorted) != 0; // Show headers if (show_headers && (columns_base_flags & ImGuiTableColumnFlags_AngledHeader) != 0) ImGui::TableAngledHeadersRow(); if (show_headers) ImGui::TableHeadersRow(); // Show data // FIXME-TABLE FIXME-NAV: How we can get decent up/down even though we have the buttons here? #if 1 // Demonstrate using clipper for large vertical lists ImGuiListClipper clipper; clipper.Begin(items.Size); while (clipper.Step()) { for (int row_n = clipper.DisplayStart; row_n < clipper.DisplayEnd; row_n++) #else // Without clipper { for (int row_n = 0; row_n < items.Size; row_n++) #endif { MyItem* item = &items[row_n]; //if (!filter.PassFilter(item->Name)) // continue; const bool item_is_selected = selection.contains(item->ID); ImGui::PushID(item->ID); ImGui::TableNextRow(ImGuiTableRowFlags_None, row_min_height); // For the demo purpose we can select among different type of items submitted in the first column ImGui::TableSetColumnIndex(0); char label[32]; sprintf(label, "%04d", item->ID); if (contents_type == CT_Text) ImGui::TextUnformatted(label); else if (contents_type == CT_Button) ImGui::Button(label); else if (contents_type == CT_SmallButton) ImGui::SmallButton(label); else if (contents_type == CT_FillButton) ImGui::Button(label, ImVec2(-FLT_MIN, 0.0f)); else if (contents_type == CT_Selectable || contents_type == CT_SelectableSpanRow) { ImGuiSelectableFlags selectable_flags = (contents_type == CT_SelectableSpanRow) ? ImGuiSelectableFlags_SpanAllColumns | ImGuiSelectableFlags_AllowOverlap : ImGuiSelectableFlags_None; if (ImGui::Selectable(label, item_is_selected, selectable_flags, ImVec2(0, row_min_height))) { if (ImGui::GetIO().KeyCtrl) { if (item_is_selected) selection.find_erase_unsorted(item->ID); else selection.push_back(item->ID); } else { selection.clear(); selection.push_back(item->ID); } } } if (ImGui::TableSetColumnIndex(1)) ImGui::TextUnformatted(item->Name); // Here we demonstrate marking our data set as needing to be sorted again if we modified a quantity, // and we are currently sorting on the column showing the Quantity. // To avoid triggering a sort while holding the button, we only trigger it when the button has been released. // You will probably need some extra logic if you want to automatically sort when a specific entry changes. if (ImGui::TableSetColumnIndex(2)) { if (ImGui::SmallButton("Chop")) { item->Quantity += 1; } if (sorts_specs_using_quantity && ImGui::IsItemDeactivated()) { items_need_sort = true; } ImGui::SameLine(); if (ImGui::SmallButton("Eat")) { item->Quantity -= 1; } if (sorts_specs_using_quantity && ImGui::IsItemDeactivated()) { items_need_sort = true; } } if (ImGui::TableSetColumnIndex(3)) ImGui::Text("%d", item->Quantity); ImGui::TableSetColumnIndex(4); if (show_wrapped_text) ImGui::TextWrapped("Lorem ipsum dolor sit amet"); else ImGui::Text("Lorem ipsum dolor sit amet"); if (ImGui::TableSetColumnIndex(5)) ImGui::Text("1234"); ImGui::PopID(); } } // Store some info to display debug details below table_scroll_cur = ImVec2(ImGui::GetScrollX(), ImGui::GetScrollY()); table_scroll_max = ImVec2(ImGui::GetScrollMaxX(), ImGui::GetScrollMaxY()); table_draw_list = ImGui::GetWindowDrawList(); ImGui::EndTable(); } static bool show_debug_details = false; ImGui::Checkbox("Debug details", &show_debug_details); if (show_debug_details && table_draw_list) { ImGui::SameLine(0.0f, 0.0f); const int table_draw_list_draw_cmd_count = table_draw_list->CmdBuffer.Size; if (table_draw_list == parent_draw_list) ImGui::Text(": DrawCmd: +%d (in same window)", table_draw_list_draw_cmd_count - parent_draw_list_draw_cmd_count); else ImGui::Text(": DrawCmd: +%d (in child window), Scroll: (%.f/%.f) (%.f/%.f)", table_draw_list_draw_cmd_count - 1, table_scroll_cur.x, table_scroll_max.x, table_scroll_cur.y, table_scroll_max.y); } ImGui::TreePop(); } ImGui::PopID(); DemoWindowColumns(); if (disable_indent) ImGui::PopStyleVar(); } // Demonstrate old/legacy Columns API! // [2020: Columns are under-featured and not maintained. Prefer using the more flexible and powerful BeginTable() API!] static void DemoWindowColumns() { IMGUI_DEMO_MARKER("Columns (legacy API)"); bool open = ImGui::TreeNode("Legacy Columns API"); ImGui::SameLine(); HelpMarker("Columns() is an old API! Prefer using the more flexible and powerful BeginTable() API!"); if (!open) return; // Basic columns IMGUI_DEMO_MARKER("Columns (legacy API)/Basic"); if (ImGui::TreeNode("Basic")) { ImGui::Text("Without border:"); ImGui::Columns(3, "mycolumns3", false); // 3-ways, no border ImGui::Separator(); for (int n = 0; n < 14; n++) { char label[32]; sprintf(label, "Item %d", n); if (ImGui::Selectable(label)) {} //if (ImGui::Button(label, ImVec2(-FLT_MIN,0.0f))) {} ImGui::NextColumn(); } ImGui::Columns(1); ImGui::Separator(); ImGui::Text("With border:"); ImGui::Columns(4, "mycolumns"); // 4-ways, with border ImGui::Separator(); ImGui::Text("ID"); ImGui::NextColumn(); ImGui::Text("Name"); ImGui::NextColumn(); ImGui::Text("Path"); ImGui::NextColumn(); ImGui::Text("Hovered"); ImGui::NextColumn(); ImGui::Separator(); const char* names[3] = { "One", "Two", "Three" }; const char* paths[3] = { "/path/one", "/path/two", "/path/three" }; static int selected = -1; for (int i = 0; i < 3; i++) { char label[32]; sprintf(label, "%04d", i); if (ImGui::Selectable(label, selected == i, ImGuiSelectableFlags_SpanAllColumns)) selected = i; bool hovered = ImGui::IsItemHovered(); ImGui::NextColumn(); ImGui::Text(names[i]); ImGui::NextColumn(); ImGui::Text(paths[i]); ImGui::NextColumn(); ImGui::Text("%d", hovered); ImGui::NextColumn(); } ImGui::Columns(1); ImGui::Separator(); ImGui::TreePop(); } IMGUI_DEMO_MARKER("Columns (legacy API)/Borders"); if (ImGui::TreeNode("Borders")) { // NB: Future columns API should allow automatic horizontal borders. static bool h_borders = true; static bool v_borders = true; static int columns_count = 4; const int lines_count = 3; ImGui::SetNextItemWidth(ImGui::GetFontSize() * 8); ImGui::DragInt("##columns_count", &columns_count, 0.1f, 2, 10, "%d columns"); if (columns_count < 2) columns_count = 2; ImGui::SameLine(); ImGui::Checkbox("horizontal", &h_borders); ImGui::SameLine(); ImGui::Checkbox("vertical", &v_borders); ImGui::Columns(columns_count, NULL, v_borders); for (int i = 0; i < columns_count * lines_count; i++) { if (h_borders && ImGui::GetColumnIndex() == 0) ImGui::Separator(); ImGui::PushID(i); ImGui::Text("%c%c%c", 'a' + i, 'a' + i, 'a' + i); ImGui::Text("Width %.2f", ImGui::GetColumnWidth()); ImGui::Text("Avail %.2f", ImGui::GetContentRegionAvail().x); ImGui::Text("Offset %.2f", ImGui::GetColumnOffset()); ImGui::Text("Long text that is likely to clip"); ImGui::Button("Button", ImVec2(-FLT_MIN, 0.0f)); ImGui::PopID(); ImGui::NextColumn(); } ImGui::Columns(1); if (h_borders) ImGui::Separator(); ImGui::TreePop(); } // Create multiple items in a same cell before switching to next column IMGUI_DEMO_MARKER("Columns (legacy API)/Mixed items"); if (ImGui::TreeNode("Mixed items")) { ImGui::Columns(3, "mixed"); ImGui::Separator(); ImGui::Text("Hello"); ImGui::Button("Banana"); ImGui::NextColumn(); ImGui::Text("ImGui"); ImGui::Button("Apple"); static float foo = 1.0f; ImGui::InputFloat("red", &foo, 0.05f, 0, "%.3f"); ImGui::Text("An extra line here."); ImGui::NextColumn(); ImGui::Text("Sailor"); ImGui::Button("Corniflower"); static float bar = 1.0f; ImGui::InputFloat("blue", &bar, 0.05f, 0, "%.3f"); ImGui::NextColumn(); if (ImGui::CollapsingHeader("Category A")) { ImGui::Text("Blah blah blah"); } ImGui::NextColumn(); if (ImGui::CollapsingHeader("Category B")) { ImGui::Text("Blah blah blah"); } ImGui::NextColumn(); if (ImGui::CollapsingHeader("Category C")) { ImGui::Text("Blah blah blah"); } ImGui::NextColumn(); ImGui::Columns(1); ImGui::Separator(); ImGui::TreePop(); } // Word wrapping IMGUI_DEMO_MARKER("Columns (legacy API)/Word-wrapping"); if (ImGui::TreeNode("Word-wrapping")) { ImGui::Columns(2, "word-wrapping"); ImGui::Separator(); ImGui::TextWrapped("The quick brown fox jumps over the lazy dog."); ImGui::TextWrapped("Hello Left"); ImGui::NextColumn(); ImGui::TextWrapped("The quick brown fox jumps over the lazy dog."); ImGui::TextWrapped("Hello Right"); ImGui::Columns(1); ImGui::Separator(); ImGui::TreePop(); } IMGUI_DEMO_MARKER("Columns (legacy API)/Horizontal Scrolling"); if (ImGui::TreeNode("Horizontal Scrolling")) { ImGui::SetNextWindowContentSize(ImVec2(1500.0f, 0.0f)); ImVec2 child_size = ImVec2(0, ImGui::GetFontSize() * 20.0f); ImGui::BeginChild("##ScrollingRegion", child_size, ImGuiChildFlags_None, ImGuiWindowFlags_HorizontalScrollbar); ImGui::Columns(10); // Also demonstrate using clipper for large vertical lists int ITEMS_COUNT = 2000; ImGuiListClipper clipper; clipper.Begin(ITEMS_COUNT); while (clipper.Step()) { for (int i = clipper.DisplayStart; i < clipper.DisplayEnd; i++) for (int j = 0; j < 10; j++) { ImGui::Text("Line %d Column %d...", i, j); ImGui::NextColumn(); } } ImGui::Columns(1); ImGui::EndChild(); ImGui::TreePop(); } IMGUI_DEMO_MARKER("Columns (legacy API)/Tree"); if (ImGui::TreeNode("Tree")) { ImGui::Columns(2, "tree", true); for (int x = 0; x < 3; x++) { bool open1 = ImGui::TreeNode((void*)(intptr_t)x, "Node%d", x); ImGui::NextColumn(); ImGui::Text("Node contents"); ImGui::NextColumn(); if (open1) { for (int y = 0; y < 3; y++) { bool open2 = ImGui::TreeNode((void*)(intptr_t)y, "Node%d.%d", x, y); ImGui::NextColumn(); ImGui::Text("Node contents"); if (open2) { ImGui::Text("Even more contents"); if (ImGui::TreeNode("Tree in column")) { ImGui::Text("The quick brown fox jumps over the lazy dog"); ImGui::TreePop(); } } ImGui::NextColumn(); if (open2) ImGui::TreePop(); } ImGui::TreePop(); } } ImGui::Columns(1); ImGui::TreePop(); } ImGui::TreePop(); } //----------------------------------------------------------------------------- // [SECTION] DemoWindowInputs() //----------------------------------------------------------------------------- static void DemoWindowInputs() { IMGUI_DEMO_MARKER("Inputs & Focus"); if (ImGui::CollapsingHeader("Inputs & Focus")) { ImGuiIO& io = ImGui::GetIO(); // Display inputs submitted to ImGuiIO IMGUI_DEMO_MARKER("Inputs & Focus/Inputs"); ImGui::SetNextItemOpen(true, ImGuiCond_Once); bool inputs_opened = ImGui::TreeNode("Inputs"); ImGui::SameLine(); HelpMarker( "This is a simplified view. See more detailed input state:\n" "- in 'Tools->Metrics/Debugger->Inputs'.\n" "- in 'Tools->Debug Log->IO'."); if (inputs_opened) { if (ImGui::IsMousePosValid()) ImGui::Text("Mouse pos: (%g, %g)", io.MousePos.x, io.MousePos.y); else ImGui::Text("Mouse pos: "); ImGui::Text("Mouse delta: (%g, %g)", io.MouseDelta.x, io.MouseDelta.y); ImGui::Text("Mouse down:"); for (int i = 0; i < IM_ARRAYSIZE(io.MouseDown); i++) if (ImGui::IsMouseDown(i)) { ImGui::SameLine(); ImGui::Text("b%d (%.02f secs)", i, io.MouseDownDuration[i]); } ImGui::Text("Mouse wheel: %.1f", io.MouseWheel); ImGui::Text("Mouse clicked count:"); for (int i = 0; i < IM_ARRAYSIZE(io.MouseDown); i++) if (io.MouseClickedCount[i] > 0) { ImGui::SameLine(); ImGui::Text("b%d: %d", i, io.MouseClickedCount[i]); } // We iterate both legacy native range and named ImGuiKey ranges. This is a little unusual/odd but this allows // displaying the data for old/new backends. // User code should never have to go through such hoops! // You can generally iterate between ImGuiKey_NamedKey_BEGIN and ImGuiKey_NamedKey_END. struct funcs { static bool IsLegacyNativeDupe(ImGuiKey) { return false; } }; ImGuiKey start_key = ImGuiKey_NamedKey_BEGIN; ImGui::Text("Keys down:"); for (ImGuiKey key = start_key; key < ImGuiKey_NamedKey_END; key = (ImGuiKey)(key + 1)) { if (funcs::IsLegacyNativeDupe(key) || !ImGui::IsKeyDown(key)) continue; ImGui::SameLine(); ImGui::Text((key < ImGuiKey_NamedKey_BEGIN) ? "\"%s\"" : "\"%s\" %d", ImGui::GetKeyName(key), key); } ImGui::Text("Keys mods: %s%s%s%s", io.KeyCtrl ? "CTRL " : "", io.KeyShift ? "SHIFT " : "", io.KeyAlt ? "ALT " : "", io.KeySuper ? "SUPER " : ""); ImGui::Text("Chars queue:"); for (int i = 0; i < io.InputQueueCharacters.Size; i++) { ImWchar c = io.InputQueueCharacters[i]; ImGui::SameLine(); ImGui::Text("\'%c\' (0x%04X)", (c > ' ' && c <= 255) ? (char)c : '?', c); } // FIXME: We should convert 'c' to UTF-8 here but the functions are not public. ImGui::TreePop(); } // Display ImGuiIO output flags IMGUI_DEMO_MARKER("Inputs & Focus/Outputs"); ImGui::SetNextItemOpen(true, ImGuiCond_Once); bool outputs_opened = ImGui::TreeNode("Outputs"); ImGui::SameLine(); HelpMarker( "The value of io.WantCaptureMouse and io.WantCaptureKeyboard are normally set by Dear ImGui " "to instruct your application of how to route inputs. Typically, when a value is true, it means " "Dear ImGui wants the corresponding inputs and we expect the underlying application to ignore them.\n\n" "The most typical case is: when hovering a window, Dear ImGui set io.WantCaptureMouse to true, " "and underlying application should ignore mouse inputs (in practice there are many and more subtle " "rules leading to how those flags are set)."); if (outputs_opened) { ImGui::Text("io.WantCaptureMouse: %d", io.WantCaptureMouse); ImGui::Text("io.WantCaptureMouseUnlessPopupClose: %d", io.WantCaptureMouseUnlessPopupClose); ImGui::Text("io.WantCaptureKeyboard: %d", io.WantCaptureKeyboard); ImGui::Text("io.WantTextInput: %d", io.WantTextInput); ImGui::Text("io.WantSetMousePos: %d", io.WantSetMousePos); ImGui::Text("io.NavActive: %d, io.NavVisible: %d", io.NavActive, io.NavVisible); IMGUI_DEMO_MARKER("Inputs & Focus/Outputs/WantCapture override"); if (ImGui::TreeNode("WantCapture override")) { HelpMarker( "Hovering the colored canvas will override io.WantCaptureXXX fields.\n" "Notice how normally (when set to none), the value of io.WantCaptureKeyboard would be false when hovering " "and true when clicking."); static int capture_override_mouse = -1; static int capture_override_keyboard = -1; const char* capture_override_desc[] = { "None", "Set to false", "Set to true" }; ImGui::SetNextItemWidth(ImGui::GetFontSize() * 15); ImGui::SliderInt("SetNextFrameWantCaptureMouse() on hover", &capture_override_mouse, -1, +1, capture_override_desc[capture_override_mouse + 1], ImGuiSliderFlags_AlwaysClamp); ImGui::SetNextItemWidth(ImGui::GetFontSize() * 15); ImGui::SliderInt("SetNextFrameWantCaptureKeyboard() on hover", &capture_override_keyboard, -1, +1, capture_override_desc[capture_override_keyboard + 1], ImGuiSliderFlags_AlwaysClamp); ImGui::ColorButton("##panel", ImVec4(0.7f, 0.1f, 0.7f, 1.0f), ImGuiColorEditFlags_NoTooltip | ImGuiColorEditFlags_NoDragDrop, ImVec2(128.0f, 96.0f)); // Dummy item if (ImGui::IsItemHovered() && capture_override_mouse != -1) ImGui::SetNextFrameWantCaptureMouse(capture_override_mouse == 1); if (ImGui::IsItemHovered() && capture_override_keyboard != -1) ImGui::SetNextFrameWantCaptureKeyboard(capture_override_keyboard == 1); ImGui::TreePop(); } ImGui::TreePop(); } // Demonstrate using Shortcut() and Routing Policies. // The general flow is: // - Code interested in a chord (e.g. "Ctrl+A") declares their intent. // - Multiple locations may be interested in same chord! Routing helps find a winner. // - Every frame, we resolve all claims and assign one owner if the modifiers are matching. // - The lower-level function is 'bool SetShortcutRouting()', returns true when caller got the route. // - Most of the times, SetShortcutRouting() is not called directly. User mostly calls Shortcut() with routing flags. // - If you call Shortcut() WITHOUT any routing option, it uses ImGuiInputFlags_RouteFocused. // TL;DR: Most uses will simply be: // - Shortcut(ImGuiMod_Ctrl | ImGuiKey_A); // Use ImGuiInputFlags_RouteFocused policy. IMGUI_DEMO_MARKER("Inputs & Focus/Shortcuts"); if (ImGui::TreeNode("Shortcuts")) { static ImGuiInputFlags route_options = ImGuiInputFlags_Repeat; static ImGuiInputFlags route_type = ImGuiInputFlags_RouteFocused; ImGui::CheckboxFlags("ImGuiInputFlags_Repeat", &route_options, ImGuiInputFlags_Repeat); ImGui::RadioButton("ImGuiInputFlags_RouteActive", &route_type, ImGuiInputFlags_RouteActive); ImGui::RadioButton("ImGuiInputFlags_RouteFocused (default)", &route_type, ImGuiInputFlags_RouteFocused); ImGui::RadioButton("ImGuiInputFlags_RouteGlobal", &route_type, ImGuiInputFlags_RouteGlobal); ImGui::Indent(); ImGui::BeginDisabled(route_type != ImGuiInputFlags_RouteGlobal); ImGui::CheckboxFlags("ImGuiInputFlags_RouteOverFocused", &route_options, ImGuiInputFlags_RouteOverFocused); ImGui::CheckboxFlags("ImGuiInputFlags_RouteOverActive", &route_options, ImGuiInputFlags_RouteOverActive); ImGui::CheckboxFlags("ImGuiInputFlags_RouteUnlessBgFocused", &route_options, ImGuiInputFlags_RouteUnlessBgFocused); ImGui::EndDisabled(); ImGui::Unindent(); ImGui::RadioButton("ImGuiInputFlags_RouteAlways", &route_type, ImGuiInputFlags_RouteAlways); ImGuiInputFlags flags = route_type | route_options; // Merged flags if (route_type != ImGuiInputFlags_RouteGlobal) flags &= ~(ImGuiInputFlags_RouteOverFocused | ImGuiInputFlags_RouteOverActive | ImGuiInputFlags_RouteUnlessBgFocused); ImGui::SeparatorText("Using SetNextItemShortcut()"); ImGui::Text("Ctrl+S"); ImGui::SetNextItemShortcut(ImGuiMod_Ctrl | ImGuiKey_S, flags | ImGuiInputFlags_Tooltip); ImGui::Button("Save"); ImGui::Text("Alt+F"); ImGui::SetNextItemShortcut(ImGuiMod_Alt | ImGuiKey_F, flags | ImGuiInputFlags_Tooltip); static float f = 0.5f; ImGui::SliderFloat("Factor", &f, 0.0f, 1.0f); ImGui::SeparatorText("Using Shortcut()"); const float line_height = ImGui::GetTextLineHeightWithSpacing(); const ImGuiKeyChord key_chord = ImGuiMod_Ctrl | ImGuiKey_A; ImGui::Text("Ctrl+A"); ImGui::Text("IsWindowFocused: %d, Shortcut: %s", ImGui::IsWindowFocused(), ImGui::Shortcut(key_chord, flags) ? "PRESSED" : "..."); ImGui::PushStyleColor(ImGuiCol_ChildBg, ImVec4(1.0f, 0.0f, 1.0f, 0.1f)); ImGui::BeginChild("WindowA", ImVec2(-FLT_MIN, line_height * 14), true); ImGui::Text("Press CTRL+A and see who receives it!"); ImGui::Separator(); // 1: Window polling for CTRL+A ImGui::Text("(in WindowA)"); ImGui::Text("IsWindowFocused: %d, Shortcut: %s", ImGui::IsWindowFocused(), ImGui::Shortcut(key_chord, flags) ? "PRESSED" : "..."); // 2: InputText also polling for CTRL+A: it always uses _RouteFocused internally (gets priority when active) // (Commmented because the owner-aware version of Shortcut() is still in imgui_internal.h) //char str[16] = "Press CTRL+A"; //ImGui::Spacing(); //ImGui::InputText("InputTextB", str, IM_ARRAYSIZE(str), ImGuiInputTextFlags_ReadOnly); //ImGuiID item_id = ImGui::GetItemID(); //ImGui::SameLine(); HelpMarker("Internal widgets always use _RouteFocused"); //ImGui::Text("IsWindowFocused: %d, Shortcut: %s", ImGui::IsWindowFocused(), ImGui::Shortcut(key_chord, flags, item_id) ? "PRESSED" : "..."); // 3: Dummy child is not claiming the route: focusing them shouldn't steal route away from WindowA ImGui::BeginChild("ChildD", ImVec2(-FLT_MIN, line_height * 4), true); ImGui::Text("(in ChildD: not using same Shortcut)"); ImGui::Text("IsWindowFocused: %d", ImGui::IsWindowFocused()); ImGui::EndChild(); // 4: Child window polling for CTRL+A. It is deeper than WindowA and gets priority when focused. ImGui::BeginChild("ChildE", ImVec2(-FLT_MIN, line_height * 4), true); ImGui::Text("(in ChildE: using same Shortcut)"); ImGui::Text("IsWindowFocused: %d, Shortcut: %s", ImGui::IsWindowFocused(), ImGui::Shortcut(key_chord, flags) ? "PRESSED" : "..."); ImGui::EndChild(); // 5: In a popup if (ImGui::Button("Open Popup")) ImGui::OpenPopup("PopupF"); if (ImGui::BeginPopup("PopupF")) { ImGui::Text("(in PopupF)"); ImGui::Text("IsWindowFocused: %d, Shortcut: %s", ImGui::IsWindowFocused(), ImGui::Shortcut(key_chord, flags) ? "PRESSED" : "..."); // (Commmented because the owner-aware version of Shortcut() is still in imgui_internal.h) //ImGui::InputText("InputTextG", str, IM_ARRAYSIZE(str), ImGuiInputTextFlags_ReadOnly); //ImGui::Text("IsWindowFocused: %d, Shortcut: %s", ImGui::IsWindowFocused(), ImGui::Shortcut(key_chord, flags, ImGui::GetItemID()) ? "PRESSED" : "..."); ImGui::EndPopup(); } ImGui::EndChild(); ImGui::PopStyleColor(); ImGui::TreePop(); } // Display mouse cursors IMGUI_DEMO_MARKER("Inputs & Focus/Mouse Cursors"); if (ImGui::TreeNode("Mouse Cursors")) { const char* mouse_cursors_names[] = { "Arrow", "TextInput", "ResizeAll", "ResizeNS", "ResizeEW", "ResizeNESW", "ResizeNWSE", "Hand", "Wait", "Progress", "NotAllowed" }; IM_ASSERT(IM_ARRAYSIZE(mouse_cursors_names) == ImGuiMouseCursor_COUNT); ImGuiMouseCursor current = ImGui::GetMouseCursor(); const char* cursor_name = (current >= ImGuiMouseCursor_Arrow) && (current < ImGuiMouseCursor_COUNT) ? mouse_cursors_names[current] : "N/A"; ImGui::Text("Current mouse cursor = %d: %s", current, cursor_name); ImGui::BeginDisabled(true); ImGui::CheckboxFlags("io.BackendFlags: HasMouseCursors", &io.BackendFlags, ImGuiBackendFlags_HasMouseCursors); ImGui::EndDisabled(); ImGui::Text("Hover to see mouse cursors:"); ImGui::SameLine(); HelpMarker( "Your application can render a different mouse cursor based on what ImGui::GetMouseCursor() returns. " "If software cursor rendering (io.MouseDrawCursor) is set ImGui will draw the right cursor for you, " "otherwise your backend needs to handle it."); for (int i = 0; i < ImGuiMouseCursor_COUNT; i++) { char label[32]; sprintf(label, "Mouse cursor %d: %s", i, mouse_cursors_names[i]); ImGui::Bullet(); ImGui::Selectable(label, false); if (ImGui::IsItemHovered()) ImGui::SetMouseCursor(i); } ImGui::TreePop(); } IMGUI_DEMO_MARKER("Inputs & Focus/Tabbing"); if (ImGui::TreeNode("Tabbing")) { ImGui::Text("Use TAB/SHIFT+TAB to cycle through keyboard editable fields."); static char buf[32] = "hello"; ImGui::InputText("1", buf, IM_ARRAYSIZE(buf)); ImGui::InputText("2", buf, IM_ARRAYSIZE(buf)); ImGui::InputText("3", buf, IM_ARRAYSIZE(buf)); ImGui::PushItemFlag(ImGuiItemFlags_NoTabStop, true); ImGui::InputText("4 (tab skip)", buf, IM_ARRAYSIZE(buf)); ImGui::SameLine(); HelpMarker("Item won't be cycled through when using TAB or Shift+Tab."); ImGui::PopItemFlag(); ImGui::InputText("5", buf, IM_ARRAYSIZE(buf)); ImGui::TreePop(); } IMGUI_DEMO_MARKER("Inputs & Focus/Focus from code"); if (ImGui::TreeNode("Focus from code")) { bool focus_1 = ImGui::Button("Focus on 1"); ImGui::SameLine(); bool focus_2 = ImGui::Button("Focus on 2"); ImGui::SameLine(); bool focus_3 = ImGui::Button("Focus on 3"); int has_focus = 0; static char buf[128] = "click on a button to set focus"; if (focus_1) ImGui::SetKeyboardFocusHere(); ImGui::InputText("1", buf, IM_ARRAYSIZE(buf)); if (ImGui::IsItemActive()) has_focus = 1; if (focus_2) ImGui::SetKeyboardFocusHere(); ImGui::InputText("2", buf, IM_ARRAYSIZE(buf)); if (ImGui::IsItemActive()) has_focus = 2; ImGui::PushItemFlag(ImGuiItemFlags_NoTabStop, true); if (focus_3) ImGui::SetKeyboardFocusHere(); ImGui::InputText("3 (tab skip)", buf, IM_ARRAYSIZE(buf)); if (ImGui::IsItemActive()) has_focus = 3; ImGui::SameLine(); HelpMarker("Item won't be cycled through when using TAB or Shift+Tab."); ImGui::PopItemFlag(); if (has_focus) ImGui::Text("Item with focus: %d", has_focus); else ImGui::Text("Item with focus: "); // Use >= 0 parameter to SetKeyboardFocusHere() to focus an upcoming item static float f3[3] = { 0.0f, 0.0f, 0.0f }; int focus_ahead = -1; if (ImGui::Button("Focus on X")) { focus_ahead = 0; } ImGui::SameLine(); if (ImGui::Button("Focus on Y")) { focus_ahead = 1; } ImGui::SameLine(); if (ImGui::Button("Focus on Z")) { focus_ahead = 2; } if (focus_ahead != -1) ImGui::SetKeyboardFocusHere(focus_ahead); ImGui::SliderFloat3("Float3", &f3[0], 0.0f, 1.0f); ImGui::TextWrapped("NB: Cursor & selection are preserved when refocusing last used item in code."); ImGui::TreePop(); } IMGUI_DEMO_MARKER("Inputs & Focus/Dragging"); if (ImGui::TreeNode("Dragging")) { ImGui::TextWrapped("You can use ImGui::GetMouseDragDelta(0) to query for the dragged amount on any widget."); for (int button = 0; button < 3; button++) { ImGui::Text("IsMouseDragging(%d):", button); ImGui::Text(" w/ default threshold: %d,", ImGui::IsMouseDragging(button)); ImGui::Text(" w/ zero threshold: %d,", ImGui::IsMouseDragging(button, 0.0f)); ImGui::Text(" w/ large threshold: %d,", ImGui::IsMouseDragging(button, 20.0f)); } ImGui::Button("Drag Me"); if (ImGui::IsItemActive()) ImGui::GetForegroundDrawList()->AddLine(io.MouseClickedPos[0], io.MousePos, ImGui::GetColorU32(ImGuiCol_Button), 4.0f); // Draw a line between the button and the mouse cursor // Drag operations gets "unlocked" when the mouse has moved past a certain threshold // (the default threshold is stored in io.MouseDragThreshold). You can request a lower or higher // threshold using the second parameter of IsMouseDragging() and GetMouseDragDelta(). ImVec2 value_raw = ImGui::GetMouseDragDelta(0, 0.0f); ImVec2 value_with_lock_threshold = ImGui::GetMouseDragDelta(0); ImVec2 mouse_delta = io.MouseDelta; ImGui::Text("GetMouseDragDelta(0):"); ImGui::Text(" w/ default threshold: (%.1f, %.1f)", value_with_lock_threshold.x, value_with_lock_threshold.y); ImGui::Text(" w/ zero threshold: (%.1f, %.1f)", value_raw.x, value_raw.y); ImGui::Text("io.MouseDelta: (%.1f, %.1f)", mouse_delta.x, mouse_delta.y); ImGui::TreePop(); } } } //----------------------------------------------------------------------------- // [SECTION] About Window / ShowAboutWindow() // Access from Dear ImGui Demo -> Tools -> About //----------------------------------------------------------------------------- void ImGui::ShowAboutWindow(bool* p_open) { if (!ImGui::Begin("About Dear ImGui", p_open, ImGuiWindowFlags_AlwaysAutoResize)) { ImGui::End(); return; } IMGUI_DEMO_MARKER("Tools/About Dear ImGui"); ImGui::Text("Dear ImGui %s (%d)", IMGUI_VERSION, IMGUI_VERSION_NUM); ImGui::TextLinkOpenURL("Homepage", "https://github.com/ocornut/imgui"); ImGui::SameLine(); ImGui::TextLinkOpenURL("FAQ", "https://github.com/ocornut/imgui/blob/master/docs/FAQ.md"); ImGui::SameLine(); ImGui::TextLinkOpenURL("Wiki", "https://github.com/ocornut/imgui/wiki"); ImGui::SameLine(); ImGui::TextLinkOpenURL("Releases", "https://github.com/ocornut/imgui/releases"); ImGui::SameLine(); ImGui::TextLinkOpenURL("Funding", "https://github.com/ocornut/imgui/wiki/Funding"); ImGui::Separator(); ImGui::Text("(c) 2014-2025 Omar Cornut"); ImGui::Text("Developed by Omar Cornut and all Dear ImGui contributors."); ImGui::Text("Dear ImGui is licensed under the MIT License, see LICENSE for more information."); ImGui::Text("If your company uses this, please consider funding the project."); static bool show_config_info = false; ImGui::Checkbox("Config/Build Information", &show_config_info); if (show_config_info) { ImGuiIO& io = ImGui::GetIO(); ImGuiStyle& style = ImGui::GetStyle(); bool copy_to_clipboard = ImGui::Button("Copy to clipboard"); ImVec2 child_size = ImVec2(0, ImGui::GetTextLineHeightWithSpacing() * 18); ImGui::BeginChild(ImGui::GetID("cfg_infos"), child_size, ImGuiChildFlags_FrameStyle); if (copy_to_clipboard) { ImGui::LogToClipboard(); ImGui::LogText("```\n"); // Back quotes will make text appears without formatting when pasting on GitHub } ImGui::Text("Dear ImGui %s (%d)", IMGUI_VERSION, IMGUI_VERSION_NUM); ImGui::Separator(); ImGui::Text("sizeof(size_t): %d, sizeof(ImDrawIdx): %d, sizeof(ImDrawVert): %d", (int)sizeof(size_t), (int)sizeof(ImDrawIdx), (int)sizeof(ImDrawVert)); ImGui::Text("define: __cplusplus=%d", (int)__cplusplus); #ifdef IMGUI_DISABLE_OBSOLETE_FUNCTIONS ImGui::Text("define: IMGUI_DISABLE_OBSOLETE_FUNCTIONS"); #endif #ifdef IMGUI_DISABLE_WIN32_DEFAULT_CLIPBOARD_FUNCTIONS ImGui::Text("define: IMGUI_DISABLE_WIN32_DEFAULT_CLIPBOARD_FUNCTIONS"); #endif #ifdef IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCTIONS ImGui::Text("define: IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCTIONS"); #endif #ifdef IMGUI_DISABLE_WIN32_FUNCTIONS ImGui::Text("define: IMGUI_DISABLE_WIN32_FUNCTIONS"); #endif #ifdef IMGUI_DISABLE_DEFAULT_SHELL_FUNCTIONS ImGui::Text("define: IMGUI_DISABLE_DEFAULT_SHELL_FUNCTIONS"); #endif #ifdef IMGUI_DISABLE_DEFAULT_FORMAT_FUNCTIONS ImGui::Text("define: IMGUI_DISABLE_DEFAULT_FORMAT_FUNCTIONS"); #endif #ifdef IMGUI_DISABLE_DEFAULT_MATH_FUNCTIONS ImGui::Text("define: IMGUI_DISABLE_DEFAULT_MATH_FUNCTIONS"); #endif #ifdef IMGUI_DISABLE_DEFAULT_FILE_FUNCTIONS ImGui::Text("define: IMGUI_DISABLE_DEFAULT_FILE_FUNCTIONS"); #endif #ifdef IMGUI_DISABLE_FILE_FUNCTIONS ImGui::Text("define: IMGUI_DISABLE_FILE_FUNCTIONS"); #endif #ifdef IMGUI_DISABLE_DEFAULT_ALLOCATORS ImGui::Text("define: IMGUI_DISABLE_DEFAULT_ALLOCATORS"); #endif #ifdef IMGUI_USE_BGRA_PACKED_COLOR ImGui::Text("define: IMGUI_USE_BGRA_PACKED_COLOR"); #endif #ifdef _WIN32 ImGui::Text("define: _WIN32"); #endif #ifdef _WIN64 ImGui::Text("define: _WIN64"); #endif #ifdef __linux__ ImGui::Text("define: __linux__"); #endif #ifdef __APPLE__ ImGui::Text("define: __APPLE__"); #endif #ifdef _MSC_VER ImGui::Text("define: _MSC_VER=%d", _MSC_VER); #endif #ifdef _MSVC_LANG ImGui::Text("define: _MSVC_LANG=%d", (int)_MSVC_LANG); #endif #ifdef __MINGW32__ ImGui::Text("define: __MINGW32__"); #endif #ifdef __MINGW64__ ImGui::Text("define: __MINGW64__"); #endif #ifdef __GNUC__ ImGui::Text("define: __GNUC__=%d", (int)__GNUC__); #endif #ifdef __clang_version__ ImGui::Text("define: __clang_version__=%s", __clang_version__); #endif #ifdef __EMSCRIPTEN__ ImGui::Text("define: __EMSCRIPTEN__"); ImGui::Text("Emscripten: %d.%d.%d", __EMSCRIPTEN_major__, __EMSCRIPTEN_minor__, __EMSCRIPTEN_tiny__); #endif ImGui::Separator(); ImGui::Text("io.BackendPlatformName: %s", io.BackendPlatformName ? io.BackendPlatformName : "NULL"); ImGui::Text("io.BackendRendererName: %s", io.BackendRendererName ? io.BackendRendererName : "NULL"); ImGui::Text("io.ConfigFlags: 0x%08X", io.ConfigFlags); if (io.ConfigFlags & ImGuiConfigFlags_NavEnableKeyboard) ImGui::Text(" NavEnableKeyboard"); if (io.ConfigFlags & ImGuiConfigFlags_NavEnableGamepad) ImGui::Text(" NavEnableGamepad"); if (io.ConfigFlags & ImGuiConfigFlags_NoMouse) ImGui::Text(" NoMouse"); if (io.ConfigFlags & ImGuiConfigFlags_NoMouseCursorChange) ImGui::Text(" NoMouseCursorChange"); if (io.ConfigFlags & ImGuiConfigFlags_NoKeyboard) ImGui::Text(" NoKeyboard"); if (io.MouseDrawCursor) ImGui::Text("io.MouseDrawCursor"); if (io.ConfigMacOSXBehaviors) ImGui::Text("io.ConfigMacOSXBehaviors"); if (io.ConfigNavMoveSetMousePos) ImGui::Text("io.ConfigNavMoveSetMousePos"); if (io.ConfigNavCaptureKeyboard) ImGui::Text("io.ConfigNavCaptureKeyboard"); if (io.ConfigInputTextCursorBlink) ImGui::Text("io.ConfigInputTextCursorBlink"); if (io.ConfigWindowsResizeFromEdges) ImGui::Text("io.ConfigWindowsResizeFromEdges"); if (io.ConfigWindowsMoveFromTitleBarOnly) ImGui::Text("io.ConfigWindowsMoveFromTitleBarOnly"); if (io.ConfigMemoryCompactTimer >= 0.0f) ImGui::Text("io.ConfigMemoryCompactTimer = %.1f", io.ConfigMemoryCompactTimer); ImGui::Text("io.BackendFlags: 0x%08X", io.BackendFlags); if (io.BackendFlags & ImGuiBackendFlags_HasGamepad) ImGui::Text(" HasGamepad"); if (io.BackendFlags & ImGuiBackendFlags_HasMouseCursors) ImGui::Text(" HasMouseCursors"); if (io.BackendFlags & ImGuiBackendFlags_HasSetMousePos) ImGui::Text(" HasSetMousePos"); if (io.BackendFlags & ImGuiBackendFlags_RendererHasVtxOffset) ImGui::Text(" RendererHasVtxOffset"); ImGui::Separator(); ImGui::Text("io.Fonts: %d fonts, Flags: 0x%08X, TexSize: %d,%d", io.Fonts->Fonts.Size, io.Fonts->Flags, io.Fonts->TexWidth, io.Fonts->TexHeight); ImGui::Text("io.DisplaySize: %.2f,%.2f", io.DisplaySize.x, io.DisplaySize.y); ImGui::Text("io.DisplayFramebufferScale: %.2f,%.2f", io.DisplayFramebufferScale.x, io.DisplayFramebufferScale.y); ImGui::Separator(); ImGui::Text("style.WindowPadding: %.2f,%.2f", style.WindowPadding.x, style.WindowPadding.y); ImGui::Text("style.WindowBorderSize: %.2f", style.WindowBorderSize); ImGui::Text("style.FramePadding: %.2f,%.2f", style.FramePadding.x, style.FramePadding.y); ImGui::Text("style.FrameRounding: %.2f", style.FrameRounding); ImGui::Text("style.FrameBorderSize: %.2f", style.FrameBorderSize); ImGui::Text("style.ItemSpacing: %.2f,%.2f", style.ItemSpacing.x, style.ItemSpacing.y); ImGui::Text("style.ItemInnerSpacing: %.2f,%.2f", style.ItemInnerSpacing.x, style.ItemInnerSpacing.y); if (copy_to_clipboard) { ImGui::LogText("\n```\n"); ImGui::LogFinish(); } ImGui::EndChild(); } ImGui::End(); } //----------------------------------------------------------------------------- // [SECTION] Style Editor / ShowStyleEditor() //----------------------------------------------------------------------------- // - ShowFontSelector() // - ShowStyleSelector() // - ShowStyleEditor() //----------------------------------------------------------------------------- // Forward declare ShowFontAtlas() which isn't worth putting in public API yet namespace ImGui { IMGUI_API void ShowFontAtlas(ImFontAtlas* atlas); } // Demo helper function to select among loaded fonts. // Here we use the regular BeginCombo()/EndCombo() api which is the more flexible one. void ImGui::ShowFontSelector(const char* label) { ImGuiIO& io = ImGui::GetIO(); ImFont* font_current = ImGui::GetFont(); if (ImGui::BeginCombo(label, font_current->GetDebugName())) { for (ImFont* font : io.Fonts->Fonts) { ImGui::PushID((void*)font); if (ImGui::Selectable(font->GetDebugName(), font == font_current)) io.FontDefault = font; if (font == font_current) ImGui::SetItemDefaultFocus(); ImGui::PopID(); } ImGui::EndCombo(); } ImGui::SameLine(); HelpMarker( "- Load additional fonts with io.Fonts->AddFontFromFileTTF().\n" "- The font atlas is built when calling io.Fonts->GetTexDataAsXXXX() or io.Fonts->Build().\n" "- Read FAQ and docs/FONTS.md for more details.\n" "- If you need to add/remove fonts at runtime (e.g. for DPI change), do it before calling NewFrame()."); } // Demo helper function to select among default colors. See ShowStyleEditor() for more advanced options. // Here we use the simplified Combo() api that packs items into a single literal string. // Useful for quick combo boxes where the choices are known locally. bool ImGui::ShowStyleSelector(const char* label) { static int style_idx = -1; if (ImGui::Combo(label, &style_idx, "Dark\0Light\0Classic\0")) { switch (style_idx) { case 0: ImGui::StyleColorsDark(); break; case 1: ImGui::StyleColorsLight(); break; case 2: ImGui::StyleColorsClassic(); break; } return true; } return false; } void ImGui::ShowStyleEditor(ImGuiStyle* ref) { IMGUI_DEMO_MARKER("Tools/Style Editor"); // You can pass in a reference ImGuiStyle structure to compare to, revert to and save to // (without a reference style pointer, we will use one compared locally as a reference) ImGuiStyle& style = ImGui::GetStyle(); static ImGuiStyle ref_saved_style; // Default to using internal storage as reference static bool init = true; if (init && ref == NULL) ref_saved_style = style; init = false; if (ref == NULL) ref = &ref_saved_style; ImGui::PushItemWidth(ImGui::GetWindowWidth() * 0.50f); if (ImGui::ShowStyleSelector("Colors##Selector")) ref_saved_style = style; ImGui::ShowFontSelector("Fonts##Selector"); // Simplified Settings (expose floating-pointer border sizes as boolean representing 0.0f or 1.0f) if (ImGui::SliderFloat("FrameRounding", &style.FrameRounding, 0.0f, 12.0f, "%.0f")) style.GrabRounding = style.FrameRounding; // Make GrabRounding always the same value as FrameRounding { bool border = (style.WindowBorderSize > 0.0f); if (ImGui::Checkbox("WindowBorder", &border)) { style.WindowBorderSize = border ? 1.0f : 0.0f; } } ImGui::SameLine(); { bool border = (style.FrameBorderSize > 0.0f); if (ImGui::Checkbox("FrameBorder", &border)) { style.FrameBorderSize = border ? 1.0f : 0.0f; } } ImGui::SameLine(); { bool border = (style.PopupBorderSize > 0.0f); if (ImGui::Checkbox("PopupBorder", &border)) { style.PopupBorderSize = border ? 1.0f : 0.0f; } } // Save/Revert button if (ImGui::Button("Save Ref")) *ref = ref_saved_style = style; ImGui::SameLine(); if (ImGui::Button("Revert Ref")) style = *ref; ImGui::SameLine(); HelpMarker( "Save/Revert in local non-persistent storage. Default Colors definition are not affected. " "Use \"Export\" below to save them somewhere."); ImGui::Separator(); if (ImGui::BeginTabBar("##tabs", ImGuiTabBarFlags_None)) { if (ImGui::BeginTabItem("Sizes")) { ImGui::SeparatorText("Main"); ImGui::SliderFloat2("WindowPadding", (float*)&style.WindowPadding, 0.0f, 20.0f, "%.0f"); ImGui::SliderFloat2("FramePadding", (float*)&style.FramePadding, 0.0f, 20.0f, "%.0f"); ImGui::SliderFloat2("ItemSpacing", (float*)&style.ItemSpacing, 0.0f, 20.0f, "%.0f"); ImGui::SliderFloat2("ItemInnerSpacing", (float*)&style.ItemInnerSpacing, 0.0f, 20.0f, "%.0f"); ImGui::SliderFloat2("TouchExtraPadding", (float*)&style.TouchExtraPadding, 0.0f, 10.0f, "%.0f"); ImGui::SliderFloat("IndentSpacing", &style.IndentSpacing, 0.0f, 30.0f, "%.0f"); ImGui::SliderFloat("ScrollbarSize", &style.ScrollbarSize, 1.0f, 20.0f, "%.0f"); ImGui::SliderFloat("GrabMinSize", &style.GrabMinSize, 1.0f, 20.0f, "%.0f"); ImGui::SeparatorText("Borders"); ImGui::SliderFloat("WindowBorderSize", &style.WindowBorderSize, 0.0f, 1.0f, "%.0f"); ImGui::SliderFloat("ChildBorderSize", &style.ChildBorderSize, 0.0f, 1.0f, "%.0f"); ImGui::SliderFloat("PopupBorderSize", &style.PopupBorderSize, 0.0f, 1.0f, "%.0f"); ImGui::SliderFloat("FrameBorderSize", &style.FrameBorderSize, 0.0f, 1.0f, "%.0f"); ImGui::SeparatorText("Rounding"); ImGui::SliderFloat("WindowRounding", &style.WindowRounding, 0.0f, 12.0f, "%.0f"); ImGui::SliderFloat("ChildRounding", &style.ChildRounding, 0.0f, 12.0f, "%.0f"); ImGui::SliderFloat("FrameRounding", &style.FrameRounding, 0.0f, 12.0f, "%.0f"); ImGui::SliderFloat("PopupRounding", &style.PopupRounding, 0.0f, 12.0f, "%.0f"); ImGui::SliderFloat("ScrollbarRounding", &style.ScrollbarRounding, 0.0f, 12.0f, "%.0f"); ImGui::SliderFloat("GrabRounding", &style.GrabRounding, 0.0f, 12.0f, "%.0f"); ImGui::SeparatorText("Tabs"); ImGui::SliderFloat("TabBorderSize", &style.TabBorderSize, 0.0f, 1.0f, "%.0f"); ImGui::SliderFloat("TabBarBorderSize", &style.TabBarBorderSize, 0.0f, 2.0f, "%.0f"); ImGui::SliderFloat("TabBarOverlineSize", &style.TabBarOverlineSize, 0.0f, 3.0f, "%.0f"); ImGui::SameLine(); HelpMarker("Overline is only drawn over the selected tab when ImGuiTabBarFlags_DrawSelectedOverline is set."); ImGui::DragFloat("TabCloseButtonMinWidthSelected", &style.TabCloseButtonMinWidthSelected, 0.1f, -1.0f, 100.0f, (style.TabCloseButtonMinWidthSelected < 0.0f) ? "%.0f (Always)" : "%.0f"); ImGui::DragFloat("TabCloseButtonMinWidthUnselected", &style.TabCloseButtonMinWidthUnselected, 0.1f, -1.0f, 100.0f, (style.TabCloseButtonMinWidthUnselected < 0.0f) ? "%.0f (Always)" : "%.0f"); ImGui::SliderFloat("TabRounding", &style.TabRounding, 0.0f, 12.0f, "%.0f"); ImGui::SeparatorText("Tables"); ImGui::SliderFloat2("CellPadding", (float*)&style.CellPadding, 0.0f, 20.0f, "%.0f"); ImGui::SliderAngle("TableAngledHeadersAngle", &style.TableAngledHeadersAngle, -50.0f, +50.0f); ImGui::SliderFloat2("TableAngledHeadersTextAlign", (float*)&style.TableAngledHeadersTextAlign, 0.0f, 1.0f, "%.2f"); ImGui::SeparatorText("Windows"); ImGui::SliderFloat2("WindowTitleAlign", (float*)&style.WindowTitleAlign, 0.0f, 1.0f, "%.2f"); ImGui::SliderFloat("WindowBorderHoverPadding", &style.WindowBorderHoverPadding, 1.0f, 20.0f, "%.0f"); int window_menu_button_position = style.WindowMenuButtonPosition + 1; if (ImGui::Combo("WindowMenuButtonPosition", (int*)&window_menu_button_position, "None\0Left\0Right\0")) style.WindowMenuButtonPosition = (ImGuiDir)(window_menu_button_position - 1); ImGui::SeparatorText("Widgets"); ImGui::Combo("ColorButtonPosition", (int*)&style.ColorButtonPosition, "Left\0Right\0"); ImGui::SliderFloat2("ButtonTextAlign", (float*)&style.ButtonTextAlign, 0.0f, 1.0f, "%.2f"); ImGui::SameLine(); HelpMarker("Alignment applies when a button is larger than its text content."); ImGui::SliderFloat2("SelectableTextAlign", (float*)&style.SelectableTextAlign, 0.0f, 1.0f, "%.2f"); ImGui::SameLine(); HelpMarker("Alignment applies when a selectable is larger than its text content."); ImGui::SliderFloat("SeparatorTextBorderSize", &style.SeparatorTextBorderSize, 0.0f, 10.0f, "%.0f"); ImGui::SliderFloat2("SeparatorTextAlign", (float*)&style.SeparatorTextAlign, 0.0f, 1.0f, "%.2f"); ImGui::SliderFloat2("SeparatorTextPadding", (float*)&style.SeparatorTextPadding, 0.0f, 40.0f, "%.0f"); ImGui::SliderFloat("LogSliderDeadzone", &style.LogSliderDeadzone, 0.0f, 12.0f, "%.0f"); ImGui::SliderFloat("ImageBorderSize", &style.ImageBorderSize, 0.0f, 1.0f, "%.0f"); ImGui::SeparatorText("Tooltips"); for (int n = 0; n < 2; n++) if (ImGui::TreeNodeEx(n == 0 ? "HoverFlagsForTooltipMouse" : "HoverFlagsForTooltipNav")) { ImGuiHoveredFlags* p = (n == 0) ? &style.HoverFlagsForTooltipMouse : &style.HoverFlagsForTooltipNav; ImGui::CheckboxFlags("ImGuiHoveredFlags_DelayNone", p, ImGuiHoveredFlags_DelayNone); ImGui::CheckboxFlags("ImGuiHoveredFlags_DelayShort", p, ImGuiHoveredFlags_DelayShort); ImGui::CheckboxFlags("ImGuiHoveredFlags_DelayNormal", p, ImGuiHoveredFlags_DelayNormal); ImGui::CheckboxFlags("ImGuiHoveredFlags_Stationary", p, ImGuiHoveredFlags_Stationary); ImGui::CheckboxFlags("ImGuiHoveredFlags_NoSharedDelay", p, ImGuiHoveredFlags_NoSharedDelay); ImGui::TreePop(); } ImGui::SeparatorText("Misc"); ImGui::SliderFloat2("DisplayWindowPadding", (float*)&style.DisplayWindowPadding, 0.0f, 30.0f, "%.0f"); ImGui::SameLine(); HelpMarker("Apply to regular windows: amount which we enforce to keep visible when moving near edges of your screen."); ImGui::SliderFloat2("DisplaySafeAreaPadding", (float*)&style.DisplaySafeAreaPadding, 0.0f, 30.0f, "%.0f"); ImGui::SameLine(); HelpMarker("Apply to every windows, menus, popups, tooltips: amount where we avoid displaying contents. Adjust if you cannot see the edges of your screen (e.g. on a TV where scaling has not been configured)."); ImGui::EndTabItem(); } if (ImGui::BeginTabItem("Colors")) { static int output_dest = 0; static bool output_only_modified = true; if (ImGui::Button("Export")) { if (output_dest == 0) ImGui::LogToClipboard(); else ImGui::LogToTTY(); ImGui::LogText("ImVec4* colors = ImGui::GetStyle().Colors;" IM_NEWLINE); for (int i = 0; i < ImGuiCol_COUNT; i++) { const ImVec4& col = style.Colors[i]; const char* name = ImGui::GetStyleColorName(i); if (!output_only_modified || memcmp(&col, &ref->Colors[i], sizeof(ImVec4)) != 0) ImGui::LogText("colors[ImGuiCol_%s]%*s= ImVec4(%.2ff, %.2ff, %.2ff, %.2ff);" IM_NEWLINE, name, 23 - (int)strlen(name), "", col.x, col.y, col.z, col.w); } ImGui::LogFinish(); } ImGui::SameLine(); ImGui::SetNextItemWidth(120); ImGui::Combo("##output_type", &output_dest, "To Clipboard\0To TTY\0"); ImGui::SameLine(); ImGui::Checkbox("Only Modified Colors", &output_only_modified); static ImGuiTextFilter filter; filter.Draw("Filter colors", ImGui::GetFontSize() * 16); static ImGuiColorEditFlags alpha_flags = 0; if (ImGui::RadioButton("Opaque", alpha_flags == ImGuiColorEditFlags_AlphaOpaque)) { alpha_flags = ImGuiColorEditFlags_AlphaOpaque; } ImGui::SameLine(); if (ImGui::RadioButton("Alpha", alpha_flags == ImGuiColorEditFlags_None)) { alpha_flags = ImGuiColorEditFlags_None; } ImGui::SameLine(); if (ImGui::RadioButton("Both", alpha_flags == ImGuiColorEditFlags_AlphaPreviewHalf)) { alpha_flags = ImGuiColorEditFlags_AlphaPreviewHalf; } ImGui::SameLine(); HelpMarker( "In the color list:\n" "Left-click on color square to open color picker,\n" "Right-click to open edit options menu."); ImGui::SetNextWindowSizeConstraints(ImVec2(0.0f, ImGui::GetTextLineHeightWithSpacing() * 10), ImVec2(FLT_MAX, FLT_MAX)); ImGui::BeginChild("##colors", ImVec2(0, 0), ImGuiChildFlags_Borders | ImGuiChildFlags_NavFlattened, ImGuiWindowFlags_AlwaysVerticalScrollbar | ImGuiWindowFlags_AlwaysHorizontalScrollbar); ImGui::PushItemWidth(ImGui::GetFontSize() * -12); for (int i = 0; i < ImGuiCol_COUNT; i++) { const char* name = ImGui::GetStyleColorName(i); if (!filter.PassFilter(name)) continue; ImGui::PushID(i); #ifndef IMGUI_DISABLE_DEBUG_TOOLS if (ImGui::Button("?")) ImGui::DebugFlashStyleColor((ImGuiCol)i); ImGui::SetItemTooltip("Flash given color to identify places where it is used."); ImGui::SameLine(); #endif ImGui::ColorEdit4("##color", (float*)&style.Colors[i], ImGuiColorEditFlags_AlphaBar | alpha_flags); if (memcmp(&style.Colors[i], &ref->Colors[i], sizeof(ImVec4)) != 0) { // Tips: in a real user application, you may want to merge and use an icon font into the main font, // so instead of "Save"/"Revert" you'd use icons! // Read the FAQ and docs/FONTS.md about using icon fonts. It's really easy and super convenient! ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); if (ImGui::Button("Save")) { ref->Colors[i] = style.Colors[i]; } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); if (ImGui::Button("Revert")) { style.Colors[i] = ref->Colors[i]; } } ImGui::SameLine(0.0f, style.ItemInnerSpacing.x); ImGui::TextUnformatted(name); ImGui::PopID(); } ImGui::PopItemWidth(); ImGui::EndChild(); ImGui::EndTabItem(); } if (ImGui::BeginTabItem("Fonts")) { ImGuiIO& io = ImGui::GetIO(); ImFontAtlas* atlas = io.Fonts; HelpMarker("Read FAQ and docs/FONTS.md for details on font loading."); ImGui::ShowFontAtlas(atlas); // Post-baking font scaling. Note that this is NOT the nice way of scaling fonts, read below. // (we enforce hard clamping manually as by default DragFloat/SliderFloat allows CTRL+Click text to get out of bounds). const float MIN_SCALE = 0.3f; const float MAX_SCALE = 2.0f; HelpMarker( "Those are old settings provided for convenience.\n" "However, the _correct_ way of scaling your UI is currently to reload your font at the designed size, " "rebuild the font atlas, and call style.ScaleAllSizes() on a reference ImGuiStyle structure.\n" "Using those settings here will give you poor quality results."); static float window_scale = 1.0f; ImGui::PushItemWidth(ImGui::GetFontSize() * 8); if (ImGui::DragFloat("window scale", &window_scale, 0.005f, MIN_SCALE, MAX_SCALE, "%.2f", ImGuiSliderFlags_AlwaysClamp)) // Scale only this window ImGui::SetWindowFontScale(window_scale); ImGui::DragFloat("global scale", &io.FontGlobalScale, 0.005f, MIN_SCALE, MAX_SCALE, "%.2f", ImGuiSliderFlags_AlwaysClamp); // Scale everything ImGui::PopItemWidth(); ImGui::EndTabItem(); } if (ImGui::BeginTabItem("Rendering")) { ImGui::Checkbox("Anti-aliased lines", &style.AntiAliasedLines); ImGui::SameLine(); HelpMarker("When disabling anti-aliasing lines, you'll probably want to disable borders in your style as well."); ImGui::Checkbox("Anti-aliased lines use texture", &style.AntiAliasedLinesUseTex); ImGui::SameLine(); HelpMarker("Faster lines using texture data. Require backend to render with bilinear filtering (not point/nearest filtering)."); ImGui::Checkbox("Anti-aliased fill", &style.AntiAliasedFill); ImGui::PushItemWidth(ImGui::GetFontSize() * 8); ImGui::DragFloat("Curve Tessellation Tolerance", &style.CurveTessellationTol, 0.02f, 0.10f, 10.0f, "%.2f"); if (style.CurveTessellationTol < 0.10f) style.CurveTessellationTol = 0.10f; // When editing the "Circle Segment Max Error" value, draw a preview of its effect on auto-tessellated circles. ImGui::DragFloat("Circle Tessellation Max Error", &style.CircleTessellationMaxError , 0.005f, 0.10f, 5.0f, "%.2f", ImGuiSliderFlags_AlwaysClamp); const bool show_samples = ImGui::IsItemActive(); if (show_samples) ImGui::SetNextWindowPos(ImGui::GetCursorScreenPos()); if (show_samples && ImGui::BeginTooltip()) { ImGui::TextUnformatted("(R = radius, N = approx number of segments)"); ImGui::Spacing(); ImDrawList* draw_list = ImGui::GetWindowDrawList(); const float min_widget_width = ImGui::CalcTextSize("R: MMM\nN: MMM").x; for (int n = 0; n < 8; n++) { const float RAD_MIN = 5.0f; const float RAD_MAX = 70.0f; const float rad = RAD_MIN + (RAD_MAX - RAD_MIN) * (float)n / (8.0f - 1.0f); ImGui::BeginGroup(); // N is not always exact here due to how PathArcTo() function work internally ImGui::Text("R: %.f\nN: %d", rad, draw_list->_CalcCircleAutoSegmentCount(rad)); const float canvas_width = IM_MAX(min_widget_width, rad * 2.0f); const float offset_x = floorf(canvas_width * 0.5f); const float offset_y = floorf(RAD_MAX); const ImVec2 p1 = ImGui::GetCursorScreenPos(); draw_list->AddCircle(ImVec2(p1.x + offset_x, p1.y + offset_y), rad, ImGui::GetColorU32(ImGuiCol_Text)); ImGui::Dummy(ImVec2(canvas_width, RAD_MAX * 2)); /* const ImVec2 p2 = ImGui::GetCursorScreenPos(); draw_list->AddCircleFilled(ImVec2(p2.x + offset_x, p2.y + offset_y), rad, ImGui::GetColorU32(ImGuiCol_Text)); ImGui::Dummy(ImVec2(canvas_width, RAD_MAX * 2)); */ ImGui::EndGroup(); ImGui::SameLine(); } ImGui::EndTooltip(); } ImGui::SameLine(); HelpMarker("When drawing circle primitives with \"num_segments == 0\" tessellation will be calculated automatically."); ImGui::DragFloat("Global Alpha", &style.Alpha, 0.005f, 0.20f, 1.0f, "%.2f"); // Not exposing zero here so user doesn't "lose" the UI (zero alpha clips all widgets). But application code could have a toggle to switch between zero and non-zero. ImGui::DragFloat("Disabled Alpha", &style.DisabledAlpha, 0.005f, 0.0f, 1.0f, "%.2f"); ImGui::SameLine(); HelpMarker("Additional alpha multiplier for disabled items (multiply over current value of Alpha)."); ImGui::PopItemWidth(); ImGui::EndTabItem(); } ImGui::EndTabBar(); } ImGui::PopItemWidth(); } //----------------------------------------------------------------------------- // [SECTION] User Guide / ShowUserGuide() //----------------------------------------------------------------------------- void ImGui::ShowUserGuide() { ImGuiIO& io = ImGui::GetIO(); ImGui::BulletText("Double-click on title bar to collapse window."); ImGui::BulletText( "Click and drag on lower corner to resize window\n" "(double-click to auto fit window to its contents)."); ImGui::BulletText("CTRL+Click on a slider or drag box to input value as text."); ImGui::BulletText("TAB/SHIFT+TAB to cycle through keyboard editable fields."); ImGui::BulletText("CTRL+Tab to select a window."); if (io.FontAllowUserScaling) ImGui::BulletText("CTRL+Mouse Wheel to zoom window contents."); ImGui::BulletText("While inputting text:\n"); ImGui::Indent(); ImGui::BulletText("CTRL+Left/Right to word jump."); ImGui::BulletText("CTRL+A or double-click to select all."); ImGui::BulletText("CTRL+X/C/V to use clipboard cut/copy/paste."); ImGui::BulletText("CTRL+Z to undo, CTRL+Y/CTRL+SHIFT+Z to redo."); ImGui::BulletText("ESCAPE to revert."); ImGui::Unindent(); ImGui::BulletText("With keyboard navigation enabled:"); ImGui::Indent(); ImGui::BulletText("Arrow keys to navigate."); ImGui::BulletText("Space to activate a widget."); ImGui::BulletText("Return to input text into a widget."); ImGui::BulletText("Escape to deactivate a widget, close popup, exit child window."); ImGui::BulletText("Alt to jump to the menu layer of a window."); ImGui::Unindent(); } //----------------------------------------------------------------------------- // [SECTION] Example App: Main Menu Bar / ShowExampleAppMainMenuBar() //----------------------------------------------------------------------------- // - ShowExampleAppMainMenuBar() // - ShowExampleMenuFile() //----------------------------------------------------------------------------- // Demonstrate creating a "main" fullscreen menu bar and populating it. // Note the difference between BeginMainMenuBar() and BeginMenuBar(): // - BeginMenuBar() = menu-bar inside current window (which needs the ImGuiWindowFlags_MenuBar flag!) // - BeginMainMenuBar() = helper to create menu-bar-sized window at the top of the main viewport + call BeginMenuBar() into it. static void ShowExampleAppMainMenuBar() { if (ImGui::BeginMainMenuBar()) { if (ImGui::BeginMenu("File")) { ShowExampleMenuFile(); ImGui::EndMenu(); } if (ImGui::BeginMenu("Edit")) { if (ImGui::MenuItem("Undo", "CTRL+Z")) {} if (ImGui::MenuItem("Redo", "CTRL+Y", false, false)) {} // Disabled item ImGui::Separator(); if (ImGui::MenuItem("Cut", "CTRL+X")) {} if (ImGui::MenuItem("Copy", "CTRL+C")) {} if (ImGui::MenuItem("Paste", "CTRL+V")) {} ImGui::EndMenu(); } ImGui::EndMainMenuBar(); } } // Note that shortcuts are currently provided for display only // (future version will add explicit flags to BeginMenu() to request processing shortcuts) static void ShowExampleMenuFile() { IMGUI_DEMO_MARKER("Examples/Menu"); ImGui::MenuItem("(demo menu)", NULL, false, false); if (ImGui::MenuItem("New")) {} if (ImGui::MenuItem("Open", "Ctrl+O")) {} if (ImGui::BeginMenu("Open Recent")) { ImGui::MenuItem("fish_hat.c"); ImGui::MenuItem("fish_hat.inl"); ImGui::MenuItem("fish_hat.h"); if (ImGui::BeginMenu("More..")) { ImGui::MenuItem("Hello"); ImGui::MenuItem("Sailor"); if (ImGui::BeginMenu("Recurse..")) { ShowExampleMenuFile(); ImGui::EndMenu(); } ImGui::EndMenu(); } ImGui::EndMenu(); } if (ImGui::MenuItem("Save", "Ctrl+S")) {} if (ImGui::MenuItem("Save As..")) {} ImGui::Separator(); IMGUI_DEMO_MARKER("Examples/Menu/Options"); if (ImGui::BeginMenu("Options")) { static bool enabled = true; ImGui::MenuItem("Enabled", "", &enabled); ImGui::BeginChild("child", ImVec2(0, 60), ImGuiChildFlags_Borders); for (int i = 0; i < 10; i++) ImGui::Text("Scrolling Text %d", i); ImGui::EndChild(); static float f = 0.5f; static int n = 0; ImGui::SliderFloat("Value", &f, 0.0f, 1.0f); ImGui::InputFloat("Input", &f, 0.1f); ImGui::Combo("Combo", &n, "Yes\0No\0Maybe\0\0"); ImGui::EndMenu(); } IMGUI_DEMO_MARKER("Examples/Menu/Colors"); if (ImGui::BeginMenu("Colors")) { float sz = ImGui::GetTextLineHeight(); for (int i = 0; i < ImGuiCol_COUNT; i++) { const char* name = ImGui::GetStyleColorName((ImGuiCol)i); ImVec2 p = ImGui::GetCursorScreenPos(); ImGui::GetWindowDrawList()->AddRectFilled(p, ImVec2(p.x + sz, p.y + sz), ImGui::GetColorU32((ImGuiCol)i)); ImGui::Dummy(ImVec2(sz, sz)); ImGui::SameLine(); ImGui::MenuItem(name); } ImGui::EndMenu(); } // Here we demonstrate appending again to the "Options" menu (which we already created above) // Of course in this demo it is a little bit silly that this function calls BeginMenu("Options") twice. // In a real code-base using it would make senses to use this feature from very different code locations. if (ImGui::BeginMenu("Options")) // <-- Append! { IMGUI_DEMO_MARKER("Examples/Menu/Append to an existing menu"); static bool b = true; ImGui::Checkbox("SomeOption", &b); ImGui::EndMenu(); } if (ImGui::BeginMenu("Disabled", false)) // Disabled { IM_ASSERT(0); } if (ImGui::MenuItem("Checked", NULL, true)) {} ImGui::Separator(); if (ImGui::MenuItem("Quit", "Alt+F4")) {} } //----------------------------------------------------------------------------- // [SECTION] Example App: Debug Console / ShowExampleAppConsole() //----------------------------------------------------------------------------- // Demonstrate creating a simple console window, with scrolling, filtering, completion and history. // For the console example, we are using a more C++ like approach of declaring a class to hold both data and functions. struct ExampleAppConsole { char InputBuf[256]; ImVector Items; ImVector Commands; ImVector History; int HistoryPos; // -1: new line, 0..History.Size-1 browsing history. ImGuiTextFilter Filter; bool AutoScroll; bool ScrollToBottom; ExampleAppConsole() { IMGUI_DEMO_MARKER("Examples/Console"); ClearLog(); memset(InputBuf, 0, sizeof(InputBuf)); HistoryPos = -1; // "CLASSIFY" is here to provide the test case where "C"+[tab] completes to "CL" and display multiple matches. Commands.push_back("HELP"); Commands.push_back("HISTORY"); Commands.push_back("CLEAR"); Commands.push_back("CLASSIFY"); AutoScroll = true; ScrollToBottom = false; AddLog("Welcome to Dear ImGui!"); } ~ExampleAppConsole() { ClearLog(); for (int i = 0; i < History.Size; i++) ImGui::MemFree(History[i]); } // Portable helpers static int Stricmp(const char* s1, const char* s2) { int d; while ((d = toupper(*s2) - toupper(*s1)) == 0 && *s1) { s1++; s2++; } return d; } static int Strnicmp(const char* s1, const char* s2, int n) { int d = 0; while (n > 0 && (d = toupper(*s2) - toupper(*s1)) == 0 && *s1) { s1++; s2++; n--; } return d; } static char* Strdup(const char* s) { IM_ASSERT(s); size_t len = strlen(s) + 1; void* buf = ImGui::MemAlloc(len); IM_ASSERT(buf); return (char*)memcpy(buf, (const void*)s, len); } static void Strtrim(char* s) { char* str_end = s + strlen(s); while (str_end > s && str_end[-1] == ' ') str_end--; *str_end = 0; } void ClearLog() { for (int i = 0; i < Items.Size; i++) ImGui::MemFree(Items[i]); Items.clear(); } void AddLog(const char* fmt, ...) IM_FMTARGS(2) { // FIXME-OPT char buf[1024]; va_list args; va_start(args, fmt); vsnprintf(buf, IM_ARRAYSIZE(buf), fmt, args); buf[IM_ARRAYSIZE(buf)-1] = 0; va_end(args); Items.push_back(Strdup(buf)); } void Draw(const char* title, bool* p_open) { ImGui::SetNextWindowSize(ImVec2(520, 600), ImGuiCond_FirstUseEver); if (!ImGui::Begin(title, p_open)) { ImGui::End(); return; } // As a specific feature guaranteed by the library, after calling Begin() the last Item represent the title bar. // So e.g. IsItemHovered() will return true when hovering the title bar. // Here we create a context menu only available from the title bar. if (ImGui::BeginPopupContextItem()) { if (ImGui::MenuItem("Close Console")) *p_open = false; ImGui::EndPopup(); } ImGui::TextWrapped( "This example implements a console with basic coloring, completion (TAB key) and history (Up/Down keys). A more elaborate " "implementation may want to store entries along with extra data such as timestamp, emitter, etc."); ImGui::TextWrapped("Enter 'HELP' for help."); // TODO: display items starting from the bottom if (ImGui::SmallButton("Add Debug Text")) { AddLog("%d some text", Items.Size); AddLog("some more text"); AddLog("display very important message here!"); } ImGui::SameLine(); if (ImGui::SmallButton("Add Debug Error")) { AddLog("[error] something went wrong"); } ImGui::SameLine(); if (ImGui::SmallButton("Clear")) { ClearLog(); } ImGui::SameLine(); bool copy_to_clipboard = ImGui::SmallButton("Copy"); //static float t = 0.0f; if (ImGui::GetTime() - t > 0.02f) { t = ImGui::GetTime(); AddLog("Spam %f", t); } ImGui::Separator(); // Options menu if (ImGui::BeginPopup("Options")) { ImGui::Checkbox("Auto-scroll", &AutoScroll); ImGui::EndPopup(); } // Options, Filter ImGui::SetNextItemShortcut(ImGuiMod_Ctrl | ImGuiKey_O, ImGuiInputFlags_Tooltip); if (ImGui::Button("Options")) ImGui::OpenPopup("Options"); ImGui::SameLine(); Filter.Draw("Filter (\"incl,-excl\") (\"error\")", 180); ImGui::Separator(); // Reserve enough left-over height for 1 separator + 1 input text const float footer_height_to_reserve = ImGui::GetStyle().ItemSpacing.y + ImGui::GetFrameHeightWithSpacing(); if (ImGui::BeginChild("ScrollingRegion", ImVec2(0, -footer_height_to_reserve), ImGuiChildFlags_NavFlattened, ImGuiWindowFlags_HorizontalScrollbar)) { if (ImGui::BeginPopupContextWindow()) { if (ImGui::Selectable("Clear")) ClearLog(); ImGui::EndPopup(); } // Display every line as a separate entry so we can change their color or add custom widgets. // If you only want raw text you can use ImGui::TextUnformatted(log.begin(), log.end()); // NB- if you have thousands of entries this approach may be too inefficient and may require user-side clipping // to only process visible items. The clipper will automatically measure the height of your first item and then // "seek" to display only items in the visible area. // To use the clipper we can replace your standard loop: // for (int i = 0; i < Items.Size; i++) // With: // ImGuiListClipper clipper; // clipper.Begin(Items.Size); // while (clipper.Step()) // for (int i = clipper.DisplayStart; i < clipper.DisplayEnd; i++) // - That your items are evenly spaced (same height) // - That you have cheap random access to your elements (you can access them given their index, // without processing all the ones before) // You cannot this code as-is if a filter is active because it breaks the 'cheap random-access' property. // We would need random-access on the post-filtered list. // A typical application wanting coarse clipping and filtering may want to pre-compute an array of indices // or offsets of items that passed the filtering test, recomputing this array when user changes the filter, // and appending newly elements as they are inserted. This is left as a task to the user until we can manage // to improve this example code! // If your items are of variable height: // - Split them into same height items would be simpler and facilitate random-seeking into your list. // - Consider using manual call to IsRectVisible() and skipping extraneous decoration from your items. ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, ImVec2(4, 1)); // Tighten spacing if (copy_to_clipboard) ImGui::LogToClipboard(); for (const char* item : Items) { if (!Filter.PassFilter(item)) continue; // Normally you would store more information in your item than just a string. // (e.g. make Items[] an array of structure, store color/type etc.) ImVec4 color; bool has_color = false; if (strstr(item, "[error]")) { color = ImVec4(1.0f, 0.4f, 0.4f, 1.0f); has_color = true; } else if (strncmp(item, "# ", 2) == 0) { color = ImVec4(1.0f, 0.8f, 0.6f, 1.0f); has_color = true; } if (has_color) ImGui::PushStyleColor(ImGuiCol_Text, color); ImGui::TextUnformatted(item); if (has_color) ImGui::PopStyleColor(); } if (copy_to_clipboard) ImGui::LogFinish(); // Keep up at the bottom of the scroll region if we were already at the bottom at the beginning of the frame. // Using a scrollbar or mouse-wheel will take away from the bottom edge. if (ScrollToBottom || (AutoScroll && ImGui::GetScrollY() >= ImGui::GetScrollMaxY())) ImGui::SetScrollHereY(1.0f); ScrollToBottom = false; ImGui::PopStyleVar(); } ImGui::EndChild(); ImGui::Separator(); // Command-line bool reclaim_focus = false; ImGuiInputTextFlags input_text_flags = ImGuiInputTextFlags_EnterReturnsTrue | ImGuiInputTextFlags_EscapeClearsAll | ImGuiInputTextFlags_CallbackCompletion | ImGuiInputTextFlags_CallbackHistory; if (ImGui::InputText("Input", InputBuf, IM_ARRAYSIZE(InputBuf), input_text_flags, &TextEditCallbackStub, (void*)this)) { char* s = InputBuf; Strtrim(s); if (s[0]) ExecCommand(s); strcpy(s, ""); reclaim_focus = true; } // Auto-focus on window apparition ImGui::SetItemDefaultFocus(); if (reclaim_focus) ImGui::SetKeyboardFocusHere(-1); // Auto focus previous widget ImGui::End(); } void ExecCommand(const char* command_line) { AddLog("# %s\n", command_line); // Insert into history. First find match and delete it so it can be pushed to the back. // This isn't trying to be smart or optimal. HistoryPos = -1; for (int i = History.Size - 1; i >= 0; i--) if (Stricmp(History[i], command_line) == 0) { ImGui::MemFree(History[i]); History.erase(History.begin() + i); break; } History.push_back(Strdup(command_line)); // Process command if (Stricmp(command_line, "CLEAR") == 0) { ClearLog(); } else if (Stricmp(command_line, "HELP") == 0) { AddLog("Commands:"); for (int i = 0; i < Commands.Size; i++) AddLog("- %s", Commands[i]); } else if (Stricmp(command_line, "HISTORY") == 0) { int first = History.Size - 10; for (int i = first > 0 ? first : 0; i < History.Size; i++) AddLog("%3d: %s\n", i, History[i]); } else { AddLog("Unknown command: '%s'\n", command_line); } // On command input, we scroll to bottom even if AutoScroll==false ScrollToBottom = true; } // In C++11 you'd be better off using lambdas for this sort of forwarding callbacks static int TextEditCallbackStub(ImGuiInputTextCallbackData* data) { ExampleAppConsole* console = (ExampleAppConsole*)data->UserData; return console->TextEditCallback(data); } int TextEditCallback(ImGuiInputTextCallbackData* data) { //AddLog("cursor: %d, selection: %d-%d", data->CursorPos, data->SelectionStart, data->SelectionEnd); switch (data->EventFlag) { case ImGuiInputTextFlags_CallbackCompletion: { // Example of TEXT COMPLETION // Locate beginning of current word const char* word_end = data->Buf + data->CursorPos; const char* word_start = word_end; while (word_start > data->Buf) { const char c = word_start[-1]; if (c == ' ' || c == '\t' || c == ',' || c == ';') break; word_start--; } // Build a list of candidates ImVector candidates; for (int i = 0; i < Commands.Size; i++) if (Strnicmp(Commands[i], word_start, (int)(word_end - word_start)) == 0) candidates.push_back(Commands[i]); if (candidates.Size == 0) { // No match AddLog("No match for \"%.*s\"!\n", (int)(word_end - word_start), word_start); } else if (candidates.Size == 1) { // Single match. Delete the beginning of the word and replace it entirely so we've got nice casing. data->DeleteChars((int)(word_start - data->Buf), (int)(word_end - word_start)); data->InsertChars(data->CursorPos, candidates[0]); data->InsertChars(data->CursorPos, " "); } else { // Multiple matches. Complete as much as we can.. // So inputting "C"+Tab will complete to "CL" then display "CLEAR" and "CLASSIFY" as matches. int match_len = (int)(word_end - word_start); for (;;) { int c = 0; bool all_candidates_matches = true; for (int i = 0; i < candidates.Size && all_candidates_matches; i++) if (i == 0) c = toupper(candidates[i][match_len]); else if (c == 0 || c != toupper(candidates[i][match_len])) all_candidates_matches = false; if (!all_candidates_matches) break; match_len++; } if (match_len > 0) { data->DeleteChars((int)(word_start - data->Buf), (int)(word_end - word_start)); data->InsertChars(data->CursorPos, candidates[0], candidates[0] + match_len); } // List matches AddLog("Possible matches:\n"); for (int i = 0; i < candidates.Size; i++) AddLog("- %s\n", candidates[i]); } break; } case ImGuiInputTextFlags_CallbackHistory: { // Example of HISTORY const int prev_history_pos = HistoryPos; if (data->EventKey == ImGuiKey_UpArrow) { if (HistoryPos == -1) HistoryPos = History.Size - 1; else if (HistoryPos > 0) HistoryPos--; } else if (data->EventKey == ImGuiKey_DownArrow) { if (HistoryPos != -1) if (++HistoryPos >= History.Size) HistoryPos = -1; } // A better implementation would preserve the data on the current input line along with cursor position. if (prev_history_pos != HistoryPos) { const char* history_str = (HistoryPos >= 0) ? History[HistoryPos] : ""; data->DeleteChars(0, data->BufTextLen); data->InsertChars(0, history_str); } } } return 0; } }; static void ShowExampleAppConsole(bool* p_open) { static ExampleAppConsole console; console.Draw("Example: Console", p_open); } //----------------------------------------------------------------------------- // [SECTION] Example App: Debug Log / ShowExampleAppLog() //----------------------------------------------------------------------------- // Usage: // static ExampleAppLog my_log; // my_log.AddLog("Hello %d world\n", 123); // my_log.Draw("title"); struct ExampleAppLog { ImGuiTextBuffer Buf; ImGuiTextFilter Filter; ImVector LineOffsets; // Index to lines offset. We maintain this with AddLog() calls. bool AutoScroll; // Keep scrolling if already at the bottom. ExampleAppLog() { AutoScroll = true; Clear(); } void Clear() { Buf.clear(); LineOffsets.clear(); LineOffsets.push_back(0); } void AddLog(const char* fmt, ...) IM_FMTARGS(2) { int old_size = Buf.size(); va_list args; va_start(args, fmt); Buf.appendfv(fmt, args); va_end(args); for (int new_size = Buf.size(); old_size < new_size; old_size++) if (Buf[old_size] == '\n') LineOffsets.push_back(old_size + 1); } void Draw(const char* title, bool* p_open = NULL) { if (!ImGui::Begin(title, p_open)) { ImGui::End(); return; } // Options menu if (ImGui::BeginPopup("Options")) { ImGui::Checkbox("Auto-scroll", &AutoScroll); ImGui::EndPopup(); } // Main window if (ImGui::Button("Options")) ImGui::OpenPopup("Options"); ImGui::SameLine(); bool clear = ImGui::Button("Clear"); ImGui::SameLine(); bool copy = ImGui::Button("Copy"); ImGui::SameLine(); Filter.Draw("Filter", -100.0f); ImGui::Separator(); if (ImGui::BeginChild("scrolling", ImVec2(0, 0), ImGuiChildFlags_None, ImGuiWindowFlags_HorizontalScrollbar)) { if (clear) Clear(); if (copy) ImGui::LogToClipboard(); ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, ImVec2(0, 0)); const char* buf = Buf.begin(); const char* buf_end = Buf.end(); if (Filter.IsActive()) { // In this example we don't use the clipper when Filter is enabled. // This is because we don't have random access to the result of our filter. // A real application processing logs with ten of thousands of entries may want to store the result of // search/filter.. especially if the filtering function is not trivial (e.g. reg-exp). for (int line_no = 0; line_no < LineOffsets.Size; line_no++) { const char* line_start = buf + LineOffsets[line_no]; const char* line_end = (line_no + 1 < LineOffsets.Size) ? (buf + LineOffsets[line_no + 1] - 1) : buf_end; if (Filter.PassFilter(line_start, line_end)) ImGui::TextUnformatted(line_start, line_end); } } else { // The simplest and easy way to display the entire buffer: // ImGui::TextUnformatted(buf_begin, buf_end); // And it'll just work. TextUnformatted() has specialization for large blob of text and will fast-forward // to skip non-visible lines. Here we instead demonstrate using the clipper to only process lines that are // within the visible area. // If you have tens of thousands of items and their processing cost is non-negligible, coarse clipping them // on your side is recommended. Using ImGuiListClipper requires // - A) random access into your data // - B) items all being the same height, // both of which we can handle since we have an array pointing to the beginning of each line of text. // When using the filter (in the block of code above) we don't have random access into the data to display // anymore, which is why we don't use the clipper. Storing or skimming through the search result would make // it possible (and would be recommended if you want to search through tens of thousands of entries). ImGuiListClipper clipper; clipper.Begin(LineOffsets.Size); while (clipper.Step()) { for (int line_no = clipper.DisplayStart; line_no < clipper.DisplayEnd; line_no++) { const char* line_start = buf + LineOffsets[line_no]; const char* line_end = (line_no + 1 < LineOffsets.Size) ? (buf + LineOffsets[line_no + 1] - 1) : buf_end; ImGui::TextUnformatted(line_start, line_end); } } clipper.End(); } ImGui::PopStyleVar(); // Keep up at the bottom of the scroll region if we were already at the bottom at the beginning of the frame. // Using a scrollbar or mouse-wheel will take away from the bottom edge. if (AutoScroll && ImGui::GetScrollY() >= ImGui::GetScrollMaxY()) ImGui::SetScrollHereY(1.0f); } ImGui::EndChild(); ImGui::End(); } }; // Demonstrate creating a simple log window with basic filtering. static void ShowExampleAppLog(bool* p_open) { static ExampleAppLog log; // For the demo: add a debug button _BEFORE_ the normal log window contents // We take advantage of a rarely used feature: multiple calls to Begin()/End() are appending to the _same_ window. // Most of the contents of the window will be added by the log.Draw() call. ImGui::SetNextWindowSize(ImVec2(500, 400), ImGuiCond_FirstUseEver); ImGui::Begin("Example: Log", p_open); IMGUI_DEMO_MARKER("Examples/Log"); if (ImGui::SmallButton("[Debug] Add 5 entries")) { static int counter = 0; const char* categories[3] = { "info", "warn", "error" }; const char* words[] = { "Bumfuzzled", "Cattywampus", "Snickersnee", "Abibliophobia", "Absquatulate", "Nincompoop", "Pauciloquent" }; for (int n = 0; n < 5; n++) { const char* category = categories[counter % IM_ARRAYSIZE(categories)]; const char* word = words[counter % IM_ARRAYSIZE(words)]; log.AddLog("[%05d] [%s] Hello, current time is %.1f, here's a word: '%s'\n", ImGui::GetFrameCount(), category, ImGui::GetTime(), word); counter++; } } ImGui::End(); // Actually call in the regular Log helper (which will Begin() into the same window as we just did) log.Draw("Example: Log", p_open); } //----------------------------------------------------------------------------- // [SECTION] Example App: Simple Layout / ShowExampleAppLayout() //----------------------------------------------------------------------------- // Demonstrate create a window with multiple child windows. static void ShowExampleAppLayout(bool* p_open) { ImGui::SetNextWindowSize(ImVec2(500, 440), ImGuiCond_FirstUseEver); if (ImGui::Begin("Example: Simple layout", p_open, ImGuiWindowFlags_MenuBar)) { IMGUI_DEMO_MARKER("Examples/Simple layout"); if (ImGui::BeginMenuBar()) { if (ImGui::BeginMenu("File")) { if (ImGui::MenuItem("Close", "Ctrl+W")) { *p_open = false; } ImGui::EndMenu(); } ImGui::EndMenuBar(); } // Left static int selected = 0; { ImGui::BeginChild("left pane", ImVec2(150, 0), ImGuiChildFlags_Borders | ImGuiChildFlags_ResizeX); for (int i = 0; i < 100; i++) { // FIXME: Good candidate to use ImGuiSelectableFlags_SelectOnNav char label[128]; sprintf(label, "MyObject %d", i); if (ImGui::Selectable(label, selected == i)) selected = i; } ImGui::EndChild(); } ImGui::SameLine(); // Right { ImGui::BeginGroup(); ImGui::BeginChild("item view", ImVec2(0, -ImGui::GetFrameHeightWithSpacing())); // Leave room for 1 line below us ImGui::Text("MyObject: %d", selected); ImGui::Separator(); if (ImGui::BeginTabBar("##Tabs", ImGuiTabBarFlags_None)) { if (ImGui::BeginTabItem("Description")) { ImGui::TextWrapped("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. "); ImGui::EndTabItem(); } if (ImGui::BeginTabItem("Details")) { ImGui::Text("ID: 0123456789"); ImGui::EndTabItem(); } ImGui::EndTabBar(); } ImGui::EndChild(); if (ImGui::Button("Revert")) {} ImGui::SameLine(); if (ImGui::Button("Save")) {} ImGui::EndGroup(); } } ImGui::End(); } //----------------------------------------------------------------------------- // [SECTION] Example App: Property Editor / ShowExampleAppPropertyEditor() //----------------------------------------------------------------------------- // Some of the interactions are a bit lack-luster: // - We would want pressing validating or leaving the filter to somehow restore focus. // - We may want more advanced filtering (child nodes) and clipper support: both will need extra work. // - We would want to customize some keyboard interactions to easily keyboard navigate between the tree and the properties. //----------------------------------------------------------------------------- struct ExampleAppPropertyEditor { ImGuiTextFilter Filter; ExampleTreeNode* VisibleNode = NULL; void Draw(ExampleTreeNode* root_node) { // Left side: draw tree // - Currently using a table to benefit from RowBg feature if (ImGui::BeginChild("##tree", ImVec2(300, 0), ImGuiChildFlags_ResizeX | ImGuiChildFlags_Borders | ImGuiChildFlags_NavFlattened)) { ImGui::SetNextItemWidth(-FLT_MIN); ImGui::SetNextItemShortcut(ImGuiMod_Ctrl | ImGuiKey_F, ImGuiInputFlags_Tooltip); ImGui::PushItemFlag(ImGuiItemFlags_NoNavDefaultFocus, true); if (ImGui::InputTextWithHint("##Filter", "incl,-excl", Filter.InputBuf, IM_ARRAYSIZE(Filter.InputBuf), ImGuiInputTextFlags_EscapeClearsAll)) Filter.Build(); ImGui::PopItemFlag(); if (ImGui::BeginTable("##bg", 1, ImGuiTableFlags_RowBg)) { for (ExampleTreeNode* node : root_node->Childs) if (Filter.PassFilter(node->Name)) // Filter root node DrawTreeNode(node); ImGui::EndTable(); } } ImGui::EndChild(); // Right side: draw properties ImGui::SameLine(); ImGui::BeginGroup(); // Lock X position if (ExampleTreeNode* node = VisibleNode) { ImGui::Text("%s", node->Name); ImGui::TextDisabled("UID: 0x%08X", node->UID); ImGui::Separator(); if (ImGui::BeginTable("##properties", 2, ImGuiTableFlags_Resizable | ImGuiTableFlags_ScrollY)) { // Push object ID after we entered the table, so table is shared for all objects ImGui::PushID((int)node->UID); ImGui::TableSetupColumn("", ImGuiTableColumnFlags_WidthFixed); ImGui::TableSetupColumn("", ImGuiTableColumnFlags_WidthStretch, 2.0f); // Default twice larger if (node->HasData) { // In a typical application, the structure description would be derived from a data-driven system. // - We try to mimic this with our ExampleMemberInfo structure and the ExampleTreeNodeMemberInfos[] array. // - Limits and some details are hard-coded to simplify the demo. for (const ExampleMemberInfo& field_desc : ExampleTreeNodeMemberInfos) { ImGui::TableNextRow(); ImGui::PushID(field_desc.Name); ImGui::TableNextColumn(); ImGui::AlignTextToFramePadding(); ImGui::TextUnformatted(field_desc.Name); ImGui::TableNextColumn(); void* field_ptr = (void*)(((unsigned char*)node) + field_desc.Offset); switch (field_desc.DataType) { case ImGuiDataType_Bool: { IM_ASSERT(field_desc.DataCount == 1); ImGui::Checkbox("##Editor", (bool*)field_ptr); break; } case ImGuiDataType_S32: { int v_min = INT_MIN, v_max = INT_MAX; ImGui::SetNextItemWidth(-FLT_MIN); ImGui::DragScalarN("##Editor", field_desc.DataType, field_ptr, field_desc.DataCount, 1.0f, &v_min, &v_max); break; } case ImGuiDataType_Float: { float v_min = 0.0f, v_max = 1.0f; ImGui::SetNextItemWidth(-FLT_MIN); ImGui::SliderScalarN("##Editor", field_desc.DataType, field_ptr, field_desc.DataCount, &v_min, &v_max); break; } case ImGuiDataType_String: { ImGui::InputText("##Editor", reinterpret_cast(field_ptr), 28); break; } } ImGui::PopID(); } } ImGui::PopID(); ImGui::EndTable(); } } ImGui::EndGroup(); } void DrawTreeNode(ExampleTreeNode* node) { ImGui::TableNextRow(); ImGui::TableNextColumn(); ImGui::PushID(node->UID); ImGuiTreeNodeFlags tree_flags = ImGuiTreeNodeFlags_None; tree_flags |= ImGuiTreeNodeFlags_OpenOnArrow | ImGuiTreeNodeFlags_OpenOnDoubleClick; // Standard opening mode as we are likely to want to add selection afterwards tree_flags |= ImGuiTreeNodeFlags_NavLeftJumpsBackHere; // Left arrow support if (node == VisibleNode) tree_flags |= ImGuiTreeNodeFlags_Selected; if (node->Childs.Size == 0) tree_flags |= ImGuiTreeNodeFlags_Leaf | ImGuiTreeNodeFlags_Bullet; if (node->DataMyBool == false) ImGui::PushStyleColor(ImGuiCol_Text, ImGui::GetStyle().Colors[ImGuiCol_TextDisabled]); bool node_open = ImGui::TreeNodeEx("", tree_flags, "%s", node->Name); if (node->DataMyBool == false) ImGui::PopStyleColor(); if (ImGui::IsItemFocused()) VisibleNode = node; if (node_open) { for (ExampleTreeNode* child : node->Childs) DrawTreeNode(child); ImGui::TreePop(); } ImGui::PopID(); } }; // Demonstrate creating a simple property editor. static void ShowExampleAppPropertyEditor(bool* p_open, ImGuiDemoWindowData* demo_data) { ImGui::SetNextWindowSize(ImVec2(430, 450), ImGuiCond_FirstUseEver); if (!ImGui::Begin("Example: Property editor", p_open)) { ImGui::End(); return; } IMGUI_DEMO_MARKER("Examples/Property Editor"); static ExampleAppPropertyEditor property_editor; if (demo_data->DemoTree == NULL) demo_data->DemoTree = ExampleTree_CreateDemoTree(); property_editor.Draw(demo_data->DemoTree); ImGui::End(); } //----------------------------------------------------------------------------- // [SECTION] Example App: Long Text / ShowExampleAppLongText() //----------------------------------------------------------------------------- // Demonstrate/test rendering huge amount of text, and the incidence of clipping. static void ShowExampleAppLongText(bool* p_open) { ImGui::SetNextWindowSize(ImVec2(520, 600), ImGuiCond_FirstUseEver); if (!ImGui::Begin("Example: Long text display", p_open)) { ImGui::End(); return; } IMGUI_DEMO_MARKER("Examples/Long text display"); static int test_type = 0; static ImGuiTextBuffer log; static int lines = 0; ImGui::Text("Printing unusually long amount of text."); ImGui::Combo("Test type", &test_type, "Single call to TextUnformatted()\0" "Multiple calls to Text(), clipped\0" "Multiple calls to Text(), not clipped (slow)\0"); ImGui::Text("Buffer contents: %d lines, %d bytes", lines, log.size()); if (ImGui::Button("Clear")) { log.clear(); lines = 0; } ImGui::SameLine(); if (ImGui::Button("Add 1000 lines")) { for (int i = 0; i < 1000; i++) log.appendf("%i The quick brown fox jumps over the lazy dog\n", lines + i); lines += 1000; } ImGui::BeginChild("Log"); switch (test_type) { case 0: // Single call to TextUnformatted() with a big buffer ImGui::TextUnformatted(log.begin(), log.end()); break; case 1: { // Multiple calls to Text(), manually coarsely clipped - demonstrate how to use the ImGuiListClipper helper. ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, ImVec2(0, 0)); ImGuiListClipper clipper; clipper.Begin(lines); while (clipper.Step()) for (int i = clipper.DisplayStart; i < clipper.DisplayEnd; i++) ImGui::Text("%i The quick brown fox jumps over the lazy dog", i); ImGui::PopStyleVar(); break; } case 2: // Multiple calls to Text(), not clipped (slow) ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, ImVec2(0, 0)); for (int i = 0; i < lines; i++) ImGui::Text("%i The quick brown fox jumps over the lazy dog", i); ImGui::PopStyleVar(); break; } ImGui::EndChild(); ImGui::End(); } //----------------------------------------------------------------------------- // [SECTION] Example App: Auto Resize / ShowExampleAppAutoResize() //----------------------------------------------------------------------------- // Demonstrate creating a window which gets auto-resized according to its content. static void ShowExampleAppAutoResize(bool* p_open) { if (!ImGui::Begin("Example: Auto-resizing window", p_open, ImGuiWindowFlags_AlwaysAutoResize)) { ImGui::End(); return; } IMGUI_DEMO_MARKER("Examples/Auto-resizing window"); static int lines = 10; ImGui::TextUnformatted( "Window will resize every-frame to the size of its content.\n" "Note that you probably don't want to query the window size to\n" "output your content because that would create a feedback loop."); ImGui::SliderInt("Number of lines", &lines, 1, 20); for (int i = 0; i < lines; i++) ImGui::Text("%*sThis is line %d", i * 4, "", i); // Pad with space to extend size horizontally ImGui::End(); } //----------------------------------------------------------------------------- // [SECTION] Example App: Constrained Resize / ShowExampleAppConstrainedResize() //----------------------------------------------------------------------------- // Demonstrate creating a window with custom resize constraints. // Note that size constraints currently don't work on a docked window (when in 'docking' branch) static void ShowExampleAppConstrainedResize(bool* p_open) { struct CustomConstraints { // Helper functions to demonstrate programmatic constraints // FIXME: This doesn't take account of decoration size (e.g. title bar), library should make this easier. // FIXME: None of the three demos works consistently when resizing from borders. static void AspectRatio(ImGuiSizeCallbackData* data) { float aspect_ratio = *(float*)data->UserData; data->DesiredSize.y = (float)(int)(data->DesiredSize.x / aspect_ratio); } static void Square(ImGuiSizeCallbackData* data) { data->DesiredSize.x = data->DesiredSize.y = IM_MAX(data->DesiredSize.x, data->DesiredSize.y); } static void Step(ImGuiSizeCallbackData* data) { float step = *(float*)data->UserData; data->DesiredSize = ImVec2((int)(data->DesiredSize.x / step + 0.5f) * step, (int)(data->DesiredSize.y / step + 0.5f) * step); } }; const char* test_desc[] = { "Between 100x100 and 500x500", "At least 100x100", "Resize vertical + lock current width", "Resize horizontal + lock current height", "Width Between 400 and 500", "Height at least 400", "Custom: Aspect Ratio 16:9", "Custom: Always Square", "Custom: Fixed Steps (100)", }; // Options static bool auto_resize = false; static bool window_padding = true; static int type = 6; // Aspect Ratio static int display_lines = 10; // Submit constraint float aspect_ratio = 16.0f / 9.0f; float fixed_step = 100.0f; if (type == 0) ImGui::SetNextWindowSizeConstraints(ImVec2(100, 100), ImVec2(500, 500)); // Between 100x100 and 500x500 if (type == 1) ImGui::SetNextWindowSizeConstraints(ImVec2(100, 100), ImVec2(FLT_MAX, FLT_MAX)); // Width > 100, Height > 100 if (type == 2) ImGui::SetNextWindowSizeConstraints(ImVec2(-1, 0), ImVec2(-1, FLT_MAX)); // Resize vertical + lock current width if (type == 3) ImGui::SetNextWindowSizeConstraints(ImVec2(0, -1), ImVec2(FLT_MAX, -1)); // Resize horizontal + lock current height if (type == 4) ImGui::SetNextWindowSizeConstraints(ImVec2(400, -1), ImVec2(500, -1)); // Width Between and 400 and 500 if (type == 5) ImGui::SetNextWindowSizeConstraints(ImVec2(-1, 400), ImVec2(-1, FLT_MAX)); // Height at least 400 if (type == 6) ImGui::SetNextWindowSizeConstraints(ImVec2(0, 0), ImVec2(FLT_MAX, FLT_MAX), CustomConstraints::AspectRatio, (void*)&aspect_ratio); // Aspect ratio if (type == 7) ImGui::SetNextWindowSizeConstraints(ImVec2(0, 0), ImVec2(FLT_MAX, FLT_MAX), CustomConstraints::Square); // Always Square if (type == 8) ImGui::SetNextWindowSizeConstraints(ImVec2(0, 0), ImVec2(FLT_MAX, FLT_MAX), CustomConstraints::Step, (void*)&fixed_step); // Fixed Step // Submit window if (!window_padding) ImGui::PushStyleVar(ImGuiStyleVar_WindowPadding, ImVec2(0.0f, 0.0f)); const ImGuiWindowFlags window_flags = auto_resize ? ImGuiWindowFlags_AlwaysAutoResize : 0; const bool window_open = ImGui::Begin("Example: Constrained Resize", p_open, window_flags); if (!window_padding) ImGui::PopStyleVar(); if (window_open) { IMGUI_DEMO_MARKER("Examples/Constrained Resizing window"); if (ImGui::GetIO().KeyShift) { // Display a dummy viewport (in your real app you would likely use ImageButton() to display a texture. ImVec2 avail_size = ImGui::GetContentRegionAvail(); ImVec2 pos = ImGui::GetCursorScreenPos(); ImGui::ColorButton("viewport", ImVec4(0.5f, 0.2f, 0.5f, 1.0f), ImGuiColorEditFlags_NoTooltip | ImGuiColorEditFlags_NoDragDrop, avail_size); ImGui::SetCursorScreenPos(ImVec2(pos.x + 10, pos.y + 10)); ImGui::Text("%.2f x %.2f", avail_size.x, avail_size.y); } else { ImGui::Text("(Hold SHIFT to display a dummy viewport)"); if (ImGui::Button("Set 200x200")) { ImGui::SetWindowSize(ImVec2(200, 200)); } ImGui::SameLine(); if (ImGui::Button("Set 500x500")) { ImGui::SetWindowSize(ImVec2(500, 500)); } ImGui::SameLine(); if (ImGui::Button("Set 800x200")) { ImGui::SetWindowSize(ImVec2(800, 200)); } ImGui::SetNextItemWidth(ImGui::GetFontSize() * 20); ImGui::Combo("Constraint", &type, test_desc, IM_ARRAYSIZE(test_desc)); ImGui::SetNextItemWidth(ImGui::GetFontSize() * 20); ImGui::DragInt("Lines", &display_lines, 0.2f, 1, 100); ImGui::Checkbox("Auto-resize", &auto_resize); ImGui::Checkbox("Window padding", &window_padding); for (int i = 0; i < display_lines; i++) ImGui::Text("%*sHello, sailor! Making this line long enough for the example.", i * 4, ""); } } ImGui::End(); } //----------------------------------------------------------------------------- // [SECTION] Example App: Simple overlay / ShowExampleAppSimpleOverlay() //----------------------------------------------------------------------------- // Demonstrate creating a simple static window with no decoration // + a context-menu to choose which corner of the screen to use. static void ShowExampleAppSimpleOverlay(bool* p_open) { static int location = 0; ImGuiIO& io = ImGui::GetIO(); ImGuiWindowFlags window_flags = ImGuiWindowFlags_NoDecoration | ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_NoSavedSettings | ImGuiWindowFlags_NoFocusOnAppearing | ImGuiWindowFlags_NoNav; if (location >= 0) { const float PAD = 10.0f; const ImGuiViewport* viewport = ImGui::GetMainViewport(); ImVec2 work_pos = viewport->WorkPos; // Use work area to avoid menu-bar/task-bar, if any! ImVec2 work_size = viewport->WorkSize; ImVec2 window_pos, window_pos_pivot; window_pos.x = (location & 1) ? (work_pos.x + work_size.x - PAD) : (work_pos.x + PAD); window_pos.y = (location & 2) ? (work_pos.y + work_size.y - PAD) : (work_pos.y + PAD); window_pos_pivot.x = (location & 1) ? 1.0f : 0.0f; window_pos_pivot.y = (location & 2) ? 1.0f : 0.0f; ImGui::SetNextWindowPos(window_pos, ImGuiCond_Always, window_pos_pivot); window_flags |= ImGuiWindowFlags_NoMove; } else if (location == -2) { // Center window ImGui::SetNextWindowPos(ImGui::GetMainViewport()->GetCenter(), ImGuiCond_Always, ImVec2(0.5f, 0.5f)); window_flags |= ImGuiWindowFlags_NoMove; } ImGui::SetNextWindowBgAlpha(0.35f); // Transparent background if (ImGui::Begin("Example: Simple overlay", p_open, window_flags)) { IMGUI_DEMO_MARKER("Examples/Simple Overlay"); ImGui::Text("Simple overlay\n" "(right-click to change position)"); ImGui::Separator(); if (ImGui::IsMousePosValid()) ImGui::Text("Mouse Position: (%.1f,%.1f)", io.MousePos.x, io.MousePos.y); else ImGui::Text("Mouse Position: "); if (ImGui::BeginPopupContextWindow()) { if (ImGui::MenuItem("Custom", NULL, location == -1)) location = -1; if (ImGui::MenuItem("Center", NULL, location == -2)) location = -2; if (ImGui::MenuItem("Top-left", NULL, location == 0)) location = 0; if (ImGui::MenuItem("Top-right", NULL, location == 1)) location = 1; if (ImGui::MenuItem("Bottom-left", NULL, location == 2)) location = 2; if (ImGui::MenuItem("Bottom-right", NULL, location == 3)) location = 3; if (p_open && ImGui::MenuItem("Close")) *p_open = false; ImGui::EndPopup(); } } ImGui::End(); } //----------------------------------------------------------------------------- // [SECTION] Example App: Fullscreen window / ShowExampleAppFullscreen() //----------------------------------------------------------------------------- // Demonstrate creating a window covering the entire screen/viewport static void ShowExampleAppFullscreen(bool* p_open) { static bool use_work_area = true; static ImGuiWindowFlags flags = ImGuiWindowFlags_NoDecoration | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoSavedSettings; // We demonstrate using the full viewport area or the work area (without menu-bars, task-bars etc.) // Based on your use case you may want one or the other. const ImGuiViewport* viewport = ImGui::GetMainViewport(); ImGui::SetNextWindowPos(use_work_area ? viewport->WorkPos : viewport->Pos); ImGui::SetNextWindowSize(use_work_area ? viewport->WorkSize : viewport->Size); if (ImGui::Begin("Example: Fullscreen window", p_open, flags)) { ImGui::Checkbox("Use work area instead of main area", &use_work_area); ImGui::SameLine(); HelpMarker("Main Area = entire viewport,\nWork Area = entire viewport minus sections used by the main menu bars, task bars etc.\n\nEnable the main-menu bar in Examples menu to see the difference."); ImGui::CheckboxFlags("ImGuiWindowFlags_NoBackground", &flags, ImGuiWindowFlags_NoBackground); ImGui::CheckboxFlags("ImGuiWindowFlags_NoDecoration", &flags, ImGuiWindowFlags_NoDecoration); ImGui::Indent(); ImGui::CheckboxFlags("ImGuiWindowFlags_NoTitleBar", &flags, ImGuiWindowFlags_NoTitleBar); ImGui::CheckboxFlags("ImGuiWindowFlags_NoCollapse", &flags, ImGuiWindowFlags_NoCollapse); ImGui::CheckboxFlags("ImGuiWindowFlags_NoScrollbar", &flags, ImGuiWindowFlags_NoScrollbar); ImGui::Unindent(); if (p_open && ImGui::Button("Close this window")) *p_open = false; } ImGui::End(); } //----------------------------------------------------------------------------- // [SECTION] Example App: Manipulating Window Titles / ShowExampleAppWindowTitles() //----------------------------------------------------------------------------- // Demonstrate the use of "##" and "###" in identifiers to manipulate ID generation. // This applies to all regular items as well. // Read FAQ section "How can I have multiple widgets with the same label?" for details. static void ShowExampleAppWindowTitles(bool*) { const ImGuiViewport* viewport = ImGui::GetMainViewport(); const ImVec2 base_pos = viewport->Pos; // By default, Windows are uniquely identified by their title. // You can use the "##" and "###" markers to manipulate the display/ID. // Using "##" to display same title but have unique identifier. ImGui::SetNextWindowPos(ImVec2(base_pos.x + 100, base_pos.y + 100), ImGuiCond_FirstUseEver); ImGui::Begin("Same title as another window##1"); IMGUI_DEMO_MARKER("Examples/Manipulating window titles"); ImGui::Text("This is window 1.\nMy title is the same as window 2, but my identifier is unique."); ImGui::End(); ImGui::SetNextWindowPos(ImVec2(base_pos.x + 100, base_pos.y + 200), ImGuiCond_FirstUseEver); ImGui::Begin("Same title as another window##2"); ImGui::Text("This is window 2.\nMy title is the same as window 1, but my identifier is unique."); ImGui::End(); // Using "###" to display a changing title but keep a static identifier "AnimatedTitle" char buf[128]; sprintf(buf, "Animated title %c %d###AnimatedTitle", "|/-\\"[(int)(ImGui::GetTime() / 0.25f) & 3], ImGui::GetFrameCount()); ImGui::SetNextWindowPos(ImVec2(base_pos.x + 100, base_pos.y + 300), ImGuiCond_FirstUseEver); ImGui::Begin(buf); ImGui::Text("This window has a changing title."); ImGui::End(); } //----------------------------------------------------------------------------- // [SECTION] Example App: Custom Rendering using ImDrawList API / ShowExampleAppCustomRendering() //----------------------------------------------------------------------------- // Add a |_| looking shape static void PathConcaveShape(ImDrawList* draw_list, float x, float y, float sz) { const ImVec2 pos_norms[] = { { 0.0f, 0.0f }, { 0.3f, 0.0f }, { 0.3f, 0.7f }, { 0.7f, 0.7f }, { 0.7f, 0.0f }, { 1.0f, 0.0f }, { 1.0f, 1.0f }, { 0.0f, 1.0f } }; for (const ImVec2& p : pos_norms) draw_list->PathLineTo(ImVec2(x + 0.5f + (int)(sz * p.x), y + 0.5f + (int)(sz * p.y))); } // Demonstrate using the low-level ImDrawList to draw custom shapes. static void ShowExampleAppCustomRendering(bool* p_open) { if (!ImGui::Begin("Example: Custom rendering", p_open)) { ImGui::End(); return; } IMGUI_DEMO_MARKER("Examples/Custom Rendering"); // Tip: If you do a lot of custom rendering, you probably want to use your own geometrical types and benefit of // overloaded operators, etc. Define IM_VEC2_CLASS_EXTRA in imconfig.h to create implicit conversions between your // types and ImVec2/ImVec4. Dear ImGui defines overloaded operators but they are internal to imgui.cpp and not // exposed outside (to avoid messing with your types) In this example we are not using the maths operators! if (ImGui::BeginTabBar("##TabBar")) { if (ImGui::BeginTabItem("Primitives")) { ImGui::PushItemWidth(-ImGui::GetFontSize() * 15); ImDrawList* draw_list = ImGui::GetWindowDrawList(); // Draw gradients // (note that those are currently exacerbating our sRGB/Linear issues) // Calling ImGui::GetColorU32() multiplies the given colors by the current Style Alpha, but you may pass the IM_COL32() directly as well.. ImGui::Text("Gradients"); ImVec2 gradient_size = ImVec2(ImGui::CalcItemWidth(), ImGui::GetFrameHeight()); { ImVec2 p0 = ImGui::GetCursorScreenPos(); ImVec2 p1 = ImVec2(p0.x + gradient_size.x, p0.y + gradient_size.y); ImU32 col_a = ImGui::GetColorU32(IM_COL32(0, 0, 0, 255)); ImU32 col_b = ImGui::GetColorU32(IM_COL32(255, 255, 255, 255)); draw_list->AddRectFilledMultiColor(p0, p1, col_a, col_b, col_b, col_a); ImGui::InvisibleButton("##gradient1", gradient_size); } { ImVec2 p0 = ImGui::GetCursorScreenPos(); ImVec2 p1 = ImVec2(p0.x + gradient_size.x, p0.y + gradient_size.y); ImU32 col_a = ImGui::GetColorU32(IM_COL32(0, 255, 0, 255)); ImU32 col_b = ImGui::GetColorU32(IM_COL32(255, 0, 0, 255)); draw_list->AddRectFilledMultiColor(p0, p1, col_a, col_b, col_b, col_a); ImGui::InvisibleButton("##gradient2", gradient_size); } // Draw a bunch of primitives ImGui::Text("All primitives"); static float sz = 36.0f; static float thickness = 3.0f; static int ngon_sides = 6; static bool circle_segments_override = false; static int circle_segments_override_v = 12; static bool curve_segments_override = false; static int curve_segments_override_v = 8; static ImVec4 colf = ImVec4(1.0f, 1.0f, 0.4f, 1.0f); ImGui::DragFloat("Size", &sz, 0.2f, 2.0f, 100.0f, "%.0f"); ImGui::DragFloat("Thickness", &thickness, 0.05f, 1.0f, 8.0f, "%.02f"); ImGui::SliderInt("N-gon sides", &ngon_sides, 3, 12); ImGui::Checkbox("##circlesegmentoverride", &circle_segments_override); ImGui::SameLine(0.0f, ImGui::GetStyle().ItemInnerSpacing.x); circle_segments_override |= ImGui::SliderInt("Circle segments override", &circle_segments_override_v, 3, 40); ImGui::Checkbox("##curvessegmentoverride", &curve_segments_override); ImGui::SameLine(0.0f, ImGui::GetStyle().ItemInnerSpacing.x); curve_segments_override |= ImGui::SliderInt("Curves segments override", &curve_segments_override_v, 3, 40); ImGui::ColorEdit4("Color", &colf.x); const ImVec2 p = ImGui::GetCursorScreenPos(); const ImU32 col = ImColor(colf); const float spacing = 10.0f; const ImDrawFlags corners_tl_br = ImDrawFlags_RoundCornersTopLeft | ImDrawFlags_RoundCornersBottomRight; const float rounding = sz / 5.0f; const int circle_segments = circle_segments_override ? circle_segments_override_v : 0; const int curve_segments = curve_segments_override ? curve_segments_override_v : 0; const ImVec2 cp3[3] = { ImVec2(0.0f, sz * 0.6f), ImVec2(sz * 0.5f, -sz * 0.4f), ImVec2(sz, sz) }; // Control points for curves const ImVec2 cp4[4] = { ImVec2(0.0f, 0.0f), ImVec2(sz * 1.3f, sz * 0.3f), ImVec2(sz - sz * 1.3f, sz - sz * 0.3f), ImVec2(sz, sz) }; float x = p.x + 4.0f; float y = p.y + 4.0f; for (int n = 0; n < 2; n++) { // First line uses a thickness of 1.0f, second line uses the configurable thickness float th = (n == 0) ? 1.0f : thickness; draw_list->AddNgon(ImVec2(x + sz*0.5f, y + sz*0.5f), sz*0.5f, col, ngon_sides, th); x += sz + spacing; // N-gon draw_list->AddCircle(ImVec2(x + sz*0.5f, y + sz*0.5f), sz*0.5f, col, circle_segments, th); x += sz + spacing; // Circle draw_list->AddEllipse(ImVec2(x + sz*0.5f, y + sz*0.5f), ImVec2(sz*0.5f, sz*0.3f), col, -0.3f, circle_segments, th); x += sz + spacing; // Ellipse draw_list->AddRect(ImVec2(x, y), ImVec2(x + sz, y + sz), col, 0.0f, ImDrawFlags_None, th); x += sz + spacing; // Square draw_list->AddRect(ImVec2(x, y), ImVec2(x + sz, y + sz), col, rounding, ImDrawFlags_None, th); x += sz + spacing; // Square with all rounded corners draw_list->AddRect(ImVec2(x, y), ImVec2(x + sz, y + sz), col, rounding, corners_tl_br, th); x += sz + spacing; // Square with two rounded corners draw_list->AddTriangle(ImVec2(x+sz*0.5f,y), ImVec2(x+sz, y+sz-0.5f), ImVec2(x, y+sz-0.5f), col, th);x += sz + spacing; // Triangle //draw_list->AddTriangle(ImVec2(x+sz*0.2f,y), ImVec2(x, y+sz-0.5f), ImVec2(x+sz*0.4f, y+sz-0.5f), col, th);x+= sz*0.4f + spacing; // Thin triangle PathConcaveShape(draw_list, x, y, sz); draw_list->PathStroke(col, ImDrawFlags_Closed, th); x += sz + spacing; // Concave Shape //draw_list->AddPolyline(concave_shape, IM_ARRAYSIZE(concave_shape), col, ImDrawFlags_Closed, th); draw_list->AddLine(ImVec2(x, y), ImVec2(x + sz, y), col, th); x += sz + spacing; // Horizontal line (note: drawing a filled rectangle will be faster!) draw_list->AddLine(ImVec2(x, y), ImVec2(x, y + sz), col, th); x += spacing; // Vertical line (note: drawing a filled rectangle will be faster!) draw_list->AddLine(ImVec2(x, y), ImVec2(x + sz, y + sz), col, th); x += sz + spacing; // Diagonal line // Path draw_list->PathArcTo(ImVec2(x + sz*0.5f, y + sz*0.5f), sz*0.5f, 3.141592f, 3.141592f * -0.5f); draw_list->PathStroke(col, ImDrawFlags_None, th); x += sz + spacing; // Quadratic Bezier Curve (3 control points) draw_list->AddBezierQuadratic(ImVec2(x + cp3[0].x, y + cp3[0].y), ImVec2(x + cp3[1].x, y + cp3[1].y), ImVec2(x + cp3[2].x, y + cp3[2].y), col, th, curve_segments); x += sz + spacing; // Cubic Bezier Curve (4 control points) draw_list->AddBezierCubic(ImVec2(x + cp4[0].x, y + cp4[0].y), ImVec2(x + cp4[1].x, y + cp4[1].y), ImVec2(x + cp4[2].x, y + cp4[2].y), ImVec2(x + cp4[3].x, y + cp4[3].y), col, th, curve_segments); x = p.x + 4; y += sz + spacing; } // Filled shapes draw_list->AddNgonFilled(ImVec2(x + sz * 0.5f, y + sz * 0.5f), sz * 0.5f, col, ngon_sides); x += sz + spacing; // N-gon draw_list->AddCircleFilled(ImVec2(x + sz * 0.5f, y + sz * 0.5f), sz * 0.5f, col, circle_segments); x += sz + spacing; // Circle draw_list->AddEllipseFilled(ImVec2(x + sz * 0.5f, y + sz * 0.5f), ImVec2(sz * 0.5f, sz * 0.3f), col, -0.3f, circle_segments); x += sz + spacing;// Ellipse draw_list->AddRectFilled(ImVec2(x, y), ImVec2(x + sz, y + sz), col); x += sz + spacing; // Square draw_list->AddRectFilled(ImVec2(x, y), ImVec2(x + sz, y + sz), col, 10.0f); x += sz + spacing; // Square with all rounded corners draw_list->AddRectFilled(ImVec2(x, y), ImVec2(x + sz, y + sz), col, 10.0f, corners_tl_br); x += sz + spacing; // Square with two rounded corners draw_list->AddTriangleFilled(ImVec2(x+sz*0.5f,y), ImVec2(x+sz, y+sz-0.5f), ImVec2(x, y+sz-0.5f), col); x += sz + spacing; // Triangle //draw_list->AddTriangleFilled(ImVec2(x+sz*0.2f,y), ImVec2(x, y+sz-0.5f), ImVec2(x+sz*0.4f, y+sz-0.5f), col); x += sz*0.4f + spacing; // Thin triangle PathConcaveShape(draw_list, x, y, sz); draw_list->PathFillConcave(col); x += sz + spacing; // Concave shape draw_list->AddRectFilled(ImVec2(x, y), ImVec2(x + sz, y + thickness), col); x += sz + spacing; // Horizontal line (faster than AddLine, but only handle integer thickness) draw_list->AddRectFilled(ImVec2(x, y), ImVec2(x + thickness, y + sz), col); x += spacing * 2.0f;// Vertical line (faster than AddLine, but only handle integer thickness) draw_list->AddRectFilled(ImVec2(x, y), ImVec2(x + 1, y + 1), col); x += sz; // Pixel (faster than AddLine) // Path draw_list->PathArcTo(ImVec2(x + sz * 0.5f, y + sz * 0.5f), sz * 0.5f, 3.141592f * -0.5f, 3.141592f); draw_list->PathFillConvex(col); x += sz + spacing; // Quadratic Bezier Curve (3 control points) draw_list->PathLineTo(ImVec2(x + cp3[0].x, y + cp3[0].y)); draw_list->PathBezierQuadraticCurveTo(ImVec2(x + cp3[1].x, y + cp3[1].y), ImVec2(x + cp3[2].x, y + cp3[2].y), curve_segments); draw_list->PathFillConvex(col); x += sz + spacing; draw_list->AddRectFilledMultiColor(ImVec2(x, y), ImVec2(x + sz, y + sz), IM_COL32(0, 0, 0, 255), IM_COL32(255, 0, 0, 255), IM_COL32(255, 255, 0, 255), IM_COL32(0, 255, 0, 255)); x += sz + spacing; ImGui::Dummy(ImVec2((sz + spacing) * 13.2f, (sz + spacing) * 3.0f)); ImGui::PopItemWidth(); ImGui::EndTabItem(); } if (ImGui::BeginTabItem("Canvas")) { static ImVector points; static ImVec2 scrolling(0.0f, 0.0f); static bool opt_enable_grid = true; static bool opt_enable_context_menu = true; static bool adding_line = false; ImGui::Checkbox("Enable grid", &opt_enable_grid); ImGui::Checkbox("Enable context menu", &opt_enable_context_menu); ImGui::Text("Mouse Left: drag to add lines,\nMouse Right: drag to scroll, click for context menu."); // Typically you would use a BeginChild()/EndChild() pair to benefit from a clipping region + own scrolling. // Here we demonstrate that this can be replaced by simple offsetting + custom drawing + PushClipRect/PopClipRect() calls. // To use a child window instead we could use, e.g: // ImGui::PushStyleVar(ImGuiStyleVar_WindowPadding, ImVec2(0, 0)); // Disable padding // ImGui::PushStyleColor(ImGuiCol_ChildBg, IM_COL32(50, 50, 50, 255)); // Set a background color // ImGui::BeginChild("canvas", ImVec2(0.0f, 0.0f), ImGuiChildFlags_Borders, ImGuiWindowFlags_NoMove); // ImGui::PopStyleColor(); // ImGui::PopStyleVar(); // [...] // ImGui::EndChild(); // Using InvisibleButton() as a convenience 1) it will advance the layout cursor and 2) allows us to use IsItemHovered()/IsItemActive() ImVec2 canvas_p0 = ImGui::GetCursorScreenPos(); // ImDrawList API uses screen coordinates! ImVec2 canvas_sz = ImGui::GetContentRegionAvail(); // Resize canvas to what's available if (canvas_sz.x < 50.0f) canvas_sz.x = 50.0f; if (canvas_sz.y < 50.0f) canvas_sz.y = 50.0f; ImVec2 canvas_p1 = ImVec2(canvas_p0.x + canvas_sz.x, canvas_p0.y + canvas_sz.y); // Draw border and background color ImGuiIO& io = ImGui::GetIO(); ImDrawList* draw_list = ImGui::GetWindowDrawList(); draw_list->AddRectFilled(canvas_p0, canvas_p1, IM_COL32(50, 50, 50, 255)); draw_list->AddRect(canvas_p0, canvas_p1, IM_COL32(255, 255, 255, 255)); // This will catch our interactions ImGui::InvisibleButton("canvas", canvas_sz, ImGuiButtonFlags_MouseButtonLeft | ImGuiButtonFlags_MouseButtonRight); const bool is_hovered = ImGui::IsItemHovered(); // Hovered const bool is_active = ImGui::IsItemActive(); // Held const ImVec2 origin(canvas_p0.x + scrolling.x, canvas_p0.y + scrolling.y); // Lock scrolled origin const ImVec2 mouse_pos_in_canvas(io.MousePos.x - origin.x, io.MousePos.y - origin.y); // Add first and second point if (is_hovered && !adding_line && ImGui::IsMouseClicked(ImGuiMouseButton_Left)) { points.push_back(mouse_pos_in_canvas); points.push_back(mouse_pos_in_canvas); adding_line = true; } if (adding_line) { points.back() = mouse_pos_in_canvas; if (!ImGui::IsMouseDown(ImGuiMouseButton_Left)) adding_line = false; } // Pan (we use a zero mouse threshold when there's no context menu) // You may decide to make that threshold dynamic based on whether the mouse is hovering something etc. const float mouse_threshold_for_pan = opt_enable_context_menu ? -1.0f : 0.0f; if (is_active && ImGui::IsMouseDragging(ImGuiMouseButton_Right, mouse_threshold_for_pan)) { scrolling.x += io.MouseDelta.x; scrolling.y += io.MouseDelta.y; } // Context menu (under default mouse threshold) ImVec2 drag_delta = ImGui::GetMouseDragDelta(ImGuiMouseButton_Right); if (opt_enable_context_menu && drag_delta.x == 0.0f && drag_delta.y == 0.0f) ImGui::OpenPopupOnItemClick("context", ImGuiPopupFlags_MouseButtonRight); if (ImGui::BeginPopup("context")) { if (adding_line) points.resize(points.size() - 2); adding_line = false; if (ImGui::MenuItem("Remove one", NULL, false, points.Size > 0)) { points.resize(points.size() - 2); } if (ImGui::MenuItem("Remove all", NULL, false, points.Size > 0)) { points.clear(); } ImGui::EndPopup(); } // Draw grid + all lines in the canvas draw_list->PushClipRect(canvas_p0, canvas_p1, true); if (opt_enable_grid) { const float GRID_STEP = 64.0f; for (float x = fmodf(scrolling.x, GRID_STEP); x < canvas_sz.x; x += GRID_STEP) draw_list->AddLine(ImVec2(canvas_p0.x + x, canvas_p0.y), ImVec2(canvas_p0.x + x, canvas_p1.y), IM_COL32(200, 200, 200, 40)); for (float y = fmodf(scrolling.y, GRID_STEP); y < canvas_sz.y; y += GRID_STEP) draw_list->AddLine(ImVec2(canvas_p0.x, canvas_p0.y + y), ImVec2(canvas_p1.x, canvas_p0.y + y), IM_COL32(200, 200, 200, 40)); } for (int n = 0; n < points.Size; n += 2) draw_list->AddLine(ImVec2(origin.x + points[n].x, origin.y + points[n].y), ImVec2(origin.x + points[n + 1].x, origin.y + points[n + 1].y), IM_COL32(255, 255, 0, 255), 2.0f); draw_list->PopClipRect(); ImGui::EndTabItem(); } if (ImGui::BeginTabItem("BG/FG draw lists")) { static bool draw_bg = true; static bool draw_fg = true; ImGui::Checkbox("Draw in Background draw list", &draw_bg); ImGui::SameLine(); HelpMarker("The Background draw list will be rendered below every Dear ImGui windows."); ImGui::Checkbox("Draw in Foreground draw list", &draw_fg); ImGui::SameLine(); HelpMarker("The Foreground draw list will be rendered over every Dear ImGui windows."); ImVec2 window_pos = ImGui::GetWindowPos(); ImVec2 window_size = ImGui::GetWindowSize(); ImVec2 window_center = ImVec2(window_pos.x + window_size.x * 0.5f, window_pos.y + window_size.y * 0.5f); if (draw_bg) ImGui::GetBackgroundDrawList()->AddCircle(window_center, window_size.x * 0.6f, IM_COL32(255, 0, 0, 200), 0, 10 + 4); if (draw_fg) ImGui::GetForegroundDrawList()->AddCircle(window_center, window_size.y * 0.6f, IM_COL32(0, 255, 0, 200), 0, 10); ImGui::EndTabItem(); } // Demonstrate out-of-order rendering via channels splitting // We use functions in ImDrawList as each draw list contains a convenience splitter, // but you can also instantiate your own ImDrawListSplitter if you need to nest them. if (ImGui::BeginTabItem("Draw Channels")) { ImDrawList* draw_list = ImGui::GetWindowDrawList(); { ImGui::Text("Blue shape is drawn first: appears in back"); ImGui::Text("Red shape is drawn after: appears in front"); ImVec2 p0 = ImGui::GetCursorScreenPos(); draw_list->AddRectFilled(ImVec2(p0.x, p0.y), ImVec2(p0.x + 50, p0.y + 50), IM_COL32(0, 0, 255, 255)); // Blue draw_list->AddRectFilled(ImVec2(p0.x + 25, p0.y + 25), ImVec2(p0.x + 75, p0.y + 75), IM_COL32(255, 0, 0, 255)); // Red ImGui::Dummy(ImVec2(75, 75)); } ImGui::Separator(); { ImGui::Text("Blue shape is drawn first, into channel 1: appears in front"); ImGui::Text("Red shape is drawn after, into channel 0: appears in back"); ImVec2 p1 = ImGui::GetCursorScreenPos(); // Create 2 channels and draw a Blue shape THEN a Red shape. // You can create any number of channels. Tables API use 1 channel per column in order to better batch draw calls. draw_list->ChannelsSplit(2); draw_list->ChannelsSetCurrent(1); draw_list->AddRectFilled(ImVec2(p1.x, p1.y), ImVec2(p1.x + 50, p1.y + 50), IM_COL32(0, 0, 255, 255)); // Blue draw_list->ChannelsSetCurrent(0); draw_list->AddRectFilled(ImVec2(p1.x + 25, p1.y + 25), ImVec2(p1.x + 75, p1.y + 75), IM_COL32(255, 0, 0, 255)); // Red // Flatten/reorder channels. Red shape is in channel 0 and it appears below the Blue shape in channel 1. // This works by copying draw indices only (vertices are not copied). draw_list->ChannelsMerge(); ImGui::Dummy(ImVec2(75, 75)); ImGui::Text("After reordering, contents of channel 0 appears below channel 1."); } ImGui::EndTabItem(); } ImGui::EndTabBar(); } ImGui::End(); } //----------------------------------------------------------------------------- // [SECTION] Example App: Documents Handling / ShowExampleAppDocuments() //----------------------------------------------------------------------------- // Simplified structure to mimic a Document model struct MyDocument { char Name[32]; // Document title int UID; // Unique ID (necessary as we can change title) bool Open; // Set when open (we keep an array of all available documents to simplify demo code!) bool OpenPrev; // Copy of Open from last update. bool Dirty; // Set when the document has been modified ImVec4 Color; // An arbitrary variable associated to the document MyDocument(int uid, const char* name, bool open = true, const ImVec4& color = ImVec4(1.0f, 1.0f, 1.0f, 1.0f)) { UID = uid; snprintf(Name, sizeof(Name), "%s", name); Open = OpenPrev = open; Dirty = false; Color = color; } void DoOpen() { Open = true; } void DoForceClose() { Open = false; Dirty = false; } void DoSave() { Dirty = false; } }; struct ExampleAppDocuments { ImVector Documents; ImVector CloseQueue; MyDocument* RenamingDoc = NULL; bool RenamingStarted = false; ExampleAppDocuments() { Documents.push_back(MyDocument(0, "Lettuce", true, ImVec4(0.4f, 0.8f, 0.4f, 1.0f))); Documents.push_back(MyDocument(1, "Eggplant", true, ImVec4(0.8f, 0.5f, 1.0f, 1.0f))); Documents.push_back(MyDocument(2, "Carrot", true, ImVec4(1.0f, 0.8f, 0.5f, 1.0f))); Documents.push_back(MyDocument(3, "Tomato", false, ImVec4(1.0f, 0.3f, 0.4f, 1.0f))); Documents.push_back(MyDocument(4, "A Rather Long Title", false, ImVec4(0.4f, 0.8f, 0.8f, 1.0f))); Documents.push_back(MyDocument(5, "Some Document", false, ImVec4(0.8f, 0.8f, 1.0f, 1.0f))); } // As we allow to change document name, we append a never-changing document ID so tabs are stable void GetTabName(MyDocument* doc, char* out_buf, size_t out_buf_size) { snprintf(out_buf, out_buf_size, "%s###doc%d", doc->Name, doc->UID); } // Display placeholder contents for the Document void DisplayDocContents(MyDocument* doc) { ImGui::PushID(doc); ImGui::Text("Document \"%s\"", doc->Name); ImGui::PushStyleColor(ImGuiCol_Text, doc->Color); ImGui::TextWrapped("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."); ImGui::PopStyleColor(); ImGui::SetNextItemShortcut(ImGuiMod_Ctrl | ImGuiKey_R, ImGuiInputFlags_Tooltip); if (ImGui::Button("Rename..")) { RenamingDoc = doc; RenamingStarted = true; } ImGui::SameLine(); ImGui::SetNextItemShortcut(ImGuiMod_Ctrl | ImGuiKey_M, ImGuiInputFlags_Tooltip); if (ImGui::Button("Modify")) doc->Dirty = true; ImGui::SameLine(); ImGui::SetNextItemShortcut(ImGuiMod_Ctrl | ImGuiKey_S, ImGuiInputFlags_Tooltip); if (ImGui::Button("Save")) doc->DoSave(); ImGui::SameLine(); ImGui::SetNextItemShortcut(ImGuiMod_Ctrl | ImGuiKey_W, ImGuiInputFlags_Tooltip); if (ImGui::Button("Close")) CloseQueue.push_back(doc); ImGui::ColorEdit3("color", &doc->Color.x); // Useful to test drag and drop and hold-dragged-to-open-tab behavior. ImGui::PopID(); } // Display context menu for the Document void DisplayDocContextMenu(MyDocument* doc) { if (!ImGui::BeginPopupContextItem()) return; char buf[256]; sprintf(buf, "Save %s", doc->Name); if (ImGui::MenuItem(buf, "Ctrl+S", false, doc->Open)) doc->DoSave(); if (ImGui::MenuItem("Rename...", "Ctrl+R", false, doc->Open)) RenamingDoc = doc; if (ImGui::MenuItem("Close", "Ctrl+W", false, doc->Open)) CloseQueue.push_back(doc); ImGui::EndPopup(); } // [Optional] Notify the system of Tabs/Windows closure that happened outside the regular tab interface. // If a tab has been closed programmatically (aka closed from another source such as the Checkbox() in the demo, // as opposed to clicking on the regular tab closing button) and stops being submitted, it will take a frame for // the tab bar to notice its absence. During this frame there will be a gap in the tab bar, and if the tab that has // disappeared was the selected one, the tab bar will report no selected tab during the frame. This will effectively // give the impression of a flicker for one frame. // We call SetTabItemClosed() to manually notify the Tab Bar or Docking system of removed tabs to avoid this glitch. // Note that this completely optional, and only affect tab bars with the ImGuiTabBarFlags_Reorderable flag. void NotifyOfDocumentsClosedElsewhere() { for (MyDocument& doc : Documents) { if (!doc.Open && doc.OpenPrev) ImGui::SetTabItemClosed(doc.Name); doc.OpenPrev = doc.Open; } } }; void ShowExampleAppDocuments(bool* p_open) { static ExampleAppDocuments app; // Options static bool opt_reorderable = true; static ImGuiTabBarFlags opt_fitting_flags = ImGuiTabBarFlags_FittingPolicyDefault_; bool window_contents_visible = ImGui::Begin("Example: Documents", p_open, ImGuiWindowFlags_MenuBar); if (!window_contents_visible) { ImGui::End(); return; } // Menu if (ImGui::BeginMenuBar()) { if (ImGui::BeginMenu("File")) { int open_count = 0; for (MyDocument& doc : app.Documents) open_count += doc.Open ? 1 : 0; if (ImGui::BeginMenu("Open", open_count < app.Documents.Size)) { for (MyDocument& doc : app.Documents) if (!doc.Open && ImGui::MenuItem(doc.Name)) doc.DoOpen(); ImGui::EndMenu(); } if (ImGui::MenuItem("Close All Documents", NULL, false, open_count > 0)) for (MyDocument& doc : app.Documents) app.CloseQueue.push_back(&doc); if (ImGui::MenuItem("Exit") && p_open) *p_open = false; ImGui::EndMenu(); } ImGui::EndMenuBar(); } // [Debug] List documents with one checkbox for each for (int doc_n = 0; doc_n < app.Documents.Size; doc_n++) { MyDocument& doc = app.Documents[doc_n]; if (doc_n > 0) ImGui::SameLine(); ImGui::PushID(&doc); if (ImGui::Checkbox(doc.Name, &doc.Open)) if (!doc.Open) doc.DoForceClose(); ImGui::PopID(); } ImGui::Separator(); // About the ImGuiWindowFlags_UnsavedDocument / ImGuiTabItemFlags_UnsavedDocument flags. // They have multiple effects: // - Display a dot next to the title. // - Tab is selected when clicking the X close button. // - Closure is not assumed (will wait for user to stop submitting the tab). // Otherwise closure is assumed when pressing the X, so if you keep submitting the tab may reappear at end of tab bar. // We need to assume closure by default otherwise waiting for "lack of submission" on the next frame would leave an empty // hole for one-frame, both in the tab-bar and in tab-contents when closing a tab/window. // The rarely used SetTabItemClosed() function is a way to notify of programmatic closure to avoid the one-frame hole. // Submit Tab Bar and Tabs { ImGuiTabBarFlags tab_bar_flags = (opt_fitting_flags) | (opt_reorderable ? ImGuiTabBarFlags_Reorderable : 0); tab_bar_flags |= ImGuiTabBarFlags_DrawSelectedOverline; if (ImGui::BeginTabBar("##tabs", tab_bar_flags)) { if (opt_reorderable) app.NotifyOfDocumentsClosedElsewhere(); // [DEBUG] Stress tests //if ((ImGui::GetFrameCount() % 30) == 0) docs[1].Open ^= 1; // [DEBUG] Automatically show/hide a tab. Test various interactions e.g. dragging with this on. //if (ImGui::GetIO().KeyCtrl) ImGui::SetTabItemSelected(docs[1].Name); // [DEBUG] Test SetTabItemSelected(), probably not very useful as-is anyway.. // Submit Tabs for (MyDocument& doc : app.Documents) { if (!doc.Open) continue; // As we allow to change document name, we append a never-changing document id so tabs are stable char doc_name_buf[64]; app.GetTabName(&doc, doc_name_buf, sizeof(doc_name_buf)); ImGuiTabItemFlags tab_flags = (doc.Dirty ? ImGuiTabItemFlags_UnsavedDocument : 0); bool visible = ImGui::BeginTabItem(doc_name_buf, &doc.Open, tab_flags); // Cancel attempt to close when unsaved add to save queue so we can display a popup. if (!doc.Open && doc.Dirty) { doc.Open = true; app.CloseQueue.push_back(&doc); } app.DisplayDocContextMenu(&doc); if (visible) { app.DisplayDocContents(&doc); ImGui::EndTabItem(); } } ImGui::EndTabBar(); } } // Display renaming UI if (app.RenamingDoc != NULL) { if (app.RenamingStarted) ImGui::OpenPopup("Rename"); if (ImGui::BeginPopup("Rename")) { ImGui::SetNextItemWidth(ImGui::GetFontSize() * 30); if (ImGui::InputText("###Name", app.RenamingDoc->Name, IM_ARRAYSIZE(app.RenamingDoc->Name), ImGuiInputTextFlags_EnterReturnsTrue)) { ImGui::CloseCurrentPopup(); app.RenamingDoc = NULL; } if (app.RenamingStarted) ImGui::SetKeyboardFocusHere(-1); ImGui::EndPopup(); } else { app.RenamingDoc = NULL; } app.RenamingStarted = false; } // Display closing confirmation UI if (!app.CloseQueue.empty()) { int close_queue_unsaved_documents = 0; for (int n = 0; n < app.CloseQueue.Size; n++) if (app.CloseQueue[n]->Dirty) close_queue_unsaved_documents++; if (close_queue_unsaved_documents == 0) { // Close documents when all are unsaved for (int n = 0; n < app.CloseQueue.Size; n++) app.CloseQueue[n]->DoForceClose(); app.CloseQueue.clear(); } else { if (!ImGui::IsPopupOpen("Save?")) ImGui::OpenPopup("Save?"); if (ImGui::BeginPopupModal("Save?", NULL, ImGuiWindowFlags_AlwaysAutoResize)) { ImGui::Text("Save change to the following items?"); float item_height = ImGui::GetTextLineHeightWithSpacing(); if (ImGui::BeginChild(ImGui::GetID("frame"), ImVec2(-FLT_MIN, 6.25f * item_height), ImGuiChildFlags_FrameStyle)) for (MyDocument* doc : app.CloseQueue) if (doc->Dirty) ImGui::Text("%s", doc->Name); ImGui::EndChild(); ImVec2 button_size(ImGui::GetFontSize() * 7.0f, 0.0f); if (ImGui::Button("Yes", button_size)) { for (MyDocument* doc : app.CloseQueue) { if (doc->Dirty) doc->DoSave(); doc->DoForceClose(); } app.CloseQueue.clear(); ImGui::CloseCurrentPopup(); } ImGui::SameLine(); if (ImGui::Button("No", button_size)) { for (MyDocument* doc : app.CloseQueue) doc->DoForceClose(); app.CloseQueue.clear(); ImGui::CloseCurrentPopup(); } ImGui::SameLine(); if (ImGui::Button("Cancel", button_size)) { app.CloseQueue.clear(); ImGui::CloseCurrentPopup(); } ImGui::EndPopup(); } } } ImGui::End(); } //----------------------------------------------------------------------------- // [SECTION] Example App: Assets Browser / ShowExampleAppAssetsBrowser() //----------------------------------------------------------------------------- //#include "imgui_internal.h" // NavMoveRequestTryWrapping() struct ExampleAsset { ImGuiID ID; int Type; ExampleAsset(ImGuiID id, int type) { ID = id; Type = type; } static const ImGuiTableSortSpecs* s_current_sort_specs; static void SortWithSortSpecs(ImGuiTableSortSpecs* sort_specs, ExampleAsset* items, int items_count) { s_current_sort_specs = sort_specs; // Store in variable accessible by the sort function. if (items_count > 1) qsort(items, (size_t)items_count, sizeof(items[0]), ExampleAsset::CompareWithSortSpecs); s_current_sort_specs = NULL; } // Compare function to be used by qsort() static int IMGUI_CDECL CompareWithSortSpecs(const void* lhs, const void* rhs) { const ExampleAsset* a = (const ExampleAsset*)lhs; const ExampleAsset* b = (const ExampleAsset*)rhs; for (int n = 0; n < s_current_sort_specs->SpecsCount; n++) { const ImGuiTableColumnSortSpecs* sort_spec = &s_current_sort_specs->Specs[n]; int delta = 0; if (sort_spec->ColumnIndex == 0) delta = ((int)a->ID - (int)b->ID); else if (sort_spec->ColumnIndex == 1) delta = (a->Type - b->Type); if (delta > 0) return (sort_spec->SortDirection == ImGuiSortDirection_Ascending) ? +1 : -1; if (delta < 0) return (sort_spec->SortDirection == ImGuiSortDirection_Ascending) ? -1 : +1; } return ((int)a->ID - (int)b->ID); } }; const ImGuiTableSortSpecs* ExampleAsset::s_current_sort_specs = NULL; struct ExampleAssetsBrowser { // Options bool ShowTypeOverlay = true; bool AllowSorting = true; bool AllowDragUnselected = false; bool AllowBoxSelect = true; float IconSize = 32.0f; int IconSpacing = 10; int IconHitSpacing = 4; // Increase hit-spacing if you want to make it possible to clear or box-select from gaps. Some spacing is required to able to amend with Shift+box-select. Value is small in Explorer. bool StretchSpacing = true; // State ImVector Items; // Our items ExampleSelectionWithDeletion Selection; // Our selection (ImGuiSelectionBasicStorage + helper funcs to handle deletion) ImGuiID NextItemId = 0; // Unique identifier when creating new items bool RequestDelete = false; // Deferred deletion request bool RequestSort = false; // Deferred sort request float ZoomWheelAccum = 0.0f; // Mouse wheel accumulator to handle smooth wheels better // Calculated sizes for layout, output of UpdateLayoutSizes(). Could be locals but our code is simpler this way. ImVec2 LayoutItemSize; ImVec2 LayoutItemStep; // == LayoutItemSize + LayoutItemSpacing float LayoutItemSpacing = 0.0f; float LayoutSelectableSpacing = 0.0f; float LayoutOuterPadding = 0.0f; int LayoutColumnCount = 0; int LayoutLineCount = 0; // Functions ExampleAssetsBrowser() { AddItems(10000); } void AddItems(int count) { if (Items.Size == 0) NextItemId = 0; Items.reserve(Items.Size + count); for (int n = 0; n < count; n++, NextItemId++) Items.push_back(ExampleAsset(NextItemId, (NextItemId % 20) < 15 ? 0 : (NextItemId % 20) < 18 ? 1 : 2)); RequestSort = true; } void ClearItems() { Items.clear(); Selection.Clear(); } // Logic would be written in the main code BeginChild() and outputing to local variables. // We extracted it into a function so we can call it easily from multiple places. void UpdateLayoutSizes(float avail_width) { // Layout: when not stretching: allow extending into right-most spacing. LayoutItemSpacing = (float)IconSpacing; if (StretchSpacing == false) avail_width += floorf(LayoutItemSpacing * 0.5f); // Layout: calculate number of icon per line and number of lines LayoutItemSize = ImVec2(floorf(IconSize), floorf(IconSize)); LayoutColumnCount = IM_MAX((int)(avail_width / (LayoutItemSize.x + LayoutItemSpacing)), 1); LayoutLineCount = (Items.Size + LayoutColumnCount - 1) / LayoutColumnCount; // Layout: when stretching: allocate remaining space to more spacing. Round before division, so item_spacing may be non-integer. if (StretchSpacing && LayoutColumnCount > 1) LayoutItemSpacing = floorf(avail_width - LayoutItemSize.x * LayoutColumnCount) / LayoutColumnCount; LayoutItemStep = ImVec2(LayoutItemSize.x + LayoutItemSpacing, LayoutItemSize.y + LayoutItemSpacing); LayoutSelectableSpacing = IM_MAX(floorf(LayoutItemSpacing) - IconHitSpacing, 0.0f); LayoutOuterPadding = floorf(LayoutItemSpacing * 0.5f); } void Draw(const char* title, bool* p_open) { ImGui::SetNextWindowSize(ImVec2(IconSize * 25, IconSize * 15), ImGuiCond_FirstUseEver); if (!ImGui::Begin(title, p_open, ImGuiWindowFlags_MenuBar)) { ImGui::End(); return; } // Menu bar if (ImGui::BeginMenuBar()) { if (ImGui::BeginMenu("File")) { if (ImGui::MenuItem("Add 10000 items")) AddItems(10000); if (ImGui::MenuItem("Clear items")) ClearItems(); ImGui::Separator(); if (ImGui::MenuItem("Close", NULL, false, p_open != NULL)) *p_open = false; ImGui::EndMenu(); } if (ImGui::BeginMenu("Edit")) { if (ImGui::MenuItem("Delete", "Del", false, Selection.Size > 0)) RequestDelete = true; ImGui::EndMenu(); } if (ImGui::BeginMenu("Options")) { ImGui::PushItemWidth(ImGui::GetFontSize() * 10); ImGui::SeparatorText("Contents"); ImGui::Checkbox("Show Type Overlay", &ShowTypeOverlay); ImGui::Checkbox("Allow Sorting", &AllowSorting); ImGui::SeparatorText("Selection Behavior"); ImGui::Checkbox("Allow dragging unselected item", &AllowDragUnselected); ImGui::Checkbox("Allow box-selection", &AllowBoxSelect); ImGui::SeparatorText("Layout"); ImGui::SliderFloat("Icon Size", &IconSize, 16.0f, 128.0f, "%.0f"); ImGui::SameLine(); HelpMarker("Use CTRL+Wheel to zoom"); ImGui::SliderInt("Icon Spacing", &IconSpacing, 0, 32); ImGui::SliderInt("Icon Hit Spacing", &IconHitSpacing, 0, 32); ImGui::Checkbox("Stretch Spacing", &StretchSpacing); ImGui::PopItemWidth(); ImGui::EndMenu(); } ImGui::EndMenuBar(); } // Show a table with ONLY one header row to showcase the idea/possibility of using this to provide a sorting UI if (AllowSorting) { ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, ImVec2(0, 0)); ImGuiTableFlags table_flags_for_sort_specs = ImGuiTableFlags_Sortable | ImGuiTableFlags_SortMulti | ImGuiTableFlags_SizingFixedFit | ImGuiTableFlags_Borders; if (ImGui::BeginTable("for_sort_specs_only", 2, table_flags_for_sort_specs, ImVec2(0.0f, ImGui::GetFrameHeight()))) { ImGui::TableSetupColumn("Index"); ImGui::TableSetupColumn("Type"); ImGui::TableHeadersRow(); if (ImGuiTableSortSpecs* sort_specs = ImGui::TableGetSortSpecs()) if (sort_specs->SpecsDirty || RequestSort) { ExampleAsset::SortWithSortSpecs(sort_specs, Items.Data, Items.Size); sort_specs->SpecsDirty = RequestSort = false; } ImGui::EndTable(); } ImGui::PopStyleVar(); } ImGuiIO& io = ImGui::GetIO(); ImGui::SetNextWindowContentSize(ImVec2(0.0f, LayoutOuterPadding + LayoutLineCount * (LayoutItemSize.y + LayoutItemSpacing))); if (ImGui::BeginChild("Assets", ImVec2(0.0f, -ImGui::GetTextLineHeightWithSpacing()), ImGuiChildFlags_Borders, ImGuiWindowFlags_NoMove)) { ImDrawList* draw_list = ImGui::GetWindowDrawList(); const float avail_width = ImGui::GetContentRegionAvail().x; UpdateLayoutSizes(avail_width); // Calculate and store start position. ImVec2 start_pos = ImGui::GetCursorScreenPos(); start_pos = ImVec2(start_pos.x + LayoutOuterPadding, start_pos.y + LayoutOuterPadding); ImGui::SetCursorScreenPos(start_pos); // Multi-select ImGuiMultiSelectFlags ms_flags = ImGuiMultiSelectFlags_ClearOnEscape | ImGuiMultiSelectFlags_ClearOnClickVoid; // - Enable box-select (in 2D mode, so that changing box-select rectangle X1/X2 boundaries will affect clipped items) if (AllowBoxSelect) ms_flags |= ImGuiMultiSelectFlags_BoxSelect2d; // - This feature allows dragging an unselected item without selecting it (rarely used) if (AllowDragUnselected) ms_flags |= ImGuiMultiSelectFlags_SelectOnClickRelease; // - Enable keyboard wrapping on X axis // (FIXME-MULTISELECT: We haven't designed/exposed a general nav wrapping api yet, so this flag is provided as a courtesy to avoid doing: // ImGui::NavMoveRequestTryWrapping(ImGui::GetCurrentWindow(), ImGuiNavMoveFlags_WrapX); // When we finish implementing a more general API for this, we will obsolete this flag in favor of the new system) ms_flags |= ImGuiMultiSelectFlags_NavWrapX; ImGuiMultiSelectIO* ms_io = ImGui::BeginMultiSelect(ms_flags, Selection.Size, Items.Size); // Use custom selection adapter: store ID in selection (recommended) Selection.UserData = this; Selection.AdapterIndexToStorageId = [](ImGuiSelectionBasicStorage* self_, int idx) { ExampleAssetsBrowser* self = (ExampleAssetsBrowser*)self_->UserData; return self->Items[idx].ID; }; Selection.ApplyRequests(ms_io); const bool want_delete = (ImGui::Shortcut(ImGuiKey_Delete, ImGuiInputFlags_Repeat) && (Selection.Size > 0)) || RequestDelete; const int item_curr_idx_to_focus = want_delete ? Selection.ApplyDeletionPreLoop(ms_io, Items.Size) : -1; RequestDelete = false; // Push LayoutSelectableSpacing (which is LayoutItemSpacing minus hit-spacing, if we decide to have hit gaps between items) // Altering style ItemSpacing may seem unnecessary as we position every items using SetCursorScreenPos()... // But it is necessary for two reasons: // - Selectables uses it by default to visually fill the space between two items. // - The vertical spacing would be measured by Clipper to calculate line height if we didn't provide it explicitly (here we do). ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, ImVec2(LayoutSelectableSpacing, LayoutSelectableSpacing)); // Rendering parameters const ImU32 icon_type_overlay_colors[3] = { 0, IM_COL32(200, 70, 70, 255), IM_COL32(70, 170, 70, 255) }; const ImU32 icon_bg_color = ImGui::GetColorU32(IM_COL32(35, 35, 35, 220)); const ImVec2 icon_type_overlay_size = ImVec2(4.0f, 4.0f); const bool display_label = (LayoutItemSize.x >= ImGui::CalcTextSize("999").x); const int column_count = LayoutColumnCount; ImGuiListClipper clipper; clipper.Begin(LayoutLineCount, LayoutItemStep.y); if (item_curr_idx_to_focus != -1) clipper.IncludeItemByIndex(item_curr_idx_to_focus / column_count); // Ensure focused item line is not clipped. if (ms_io->RangeSrcItem != -1) clipper.IncludeItemByIndex((int)ms_io->RangeSrcItem / column_count); // Ensure RangeSrc item line is not clipped. while (clipper.Step()) { for (int line_idx = clipper.DisplayStart; line_idx < clipper.DisplayEnd; line_idx++) { const int item_min_idx_for_current_line = line_idx * column_count; const int item_max_idx_for_current_line = IM_MIN((line_idx + 1) * column_count, Items.Size); for (int item_idx = item_min_idx_for_current_line; item_idx < item_max_idx_for_current_line; ++item_idx) { ExampleAsset* item_data = &Items[item_idx]; ImGui::PushID((int)item_data->ID); // Position item ImVec2 pos = ImVec2(start_pos.x + (item_idx % column_count) * LayoutItemStep.x, start_pos.y + line_idx * LayoutItemStep.y); ImGui::SetCursorScreenPos(pos); ImGui::SetNextItemSelectionUserData(item_idx); bool item_is_selected = Selection.Contains((ImGuiID)item_data->ID); bool item_is_visible = ImGui::IsRectVisible(LayoutItemSize); ImGui::Selectable("", item_is_selected, ImGuiSelectableFlags_None, LayoutItemSize); // Update our selection state immediately (without waiting for EndMultiSelect() requests) // because we use this to alter the color of our text/icon. if (ImGui::IsItemToggledSelection()) item_is_selected = !item_is_selected; // Focus (for after deletion) if (item_curr_idx_to_focus == item_idx) ImGui::SetKeyboardFocusHere(-1); // Drag and drop if (ImGui::BeginDragDropSource()) { // Create payload with full selection OR single unselected item. // (the later is only possible when using ImGuiMultiSelectFlags_SelectOnClickRelease) if (ImGui::GetDragDropPayload() == NULL) { ImVector payload_items; void* it = NULL; ImGuiID id = 0; if (!item_is_selected) payload_items.push_back(item_data->ID); else while (Selection.GetNextSelectedItem(&it, &id)) payload_items.push_back(id); ImGui::SetDragDropPayload("ASSETS_BROWSER_ITEMS", payload_items.Data, (size_t)payload_items.size_in_bytes()); } // Display payload content in tooltip, by extracting it from the payload data // (we could read from selection, but it is more correct and reusable to read from payload) const ImGuiPayload* payload = ImGui::GetDragDropPayload(); const int payload_count = (int)payload->DataSize / (int)sizeof(ImGuiID); ImGui::Text("%d assets", payload_count); ImGui::EndDragDropSource(); } // Render icon (a real app would likely display an image/thumbnail here) // Because we use ImGuiMultiSelectFlags_BoxSelect2d, clipping vertical may occasionally be larger, so we coarse-clip our rendering as well. if (item_is_visible) { ImVec2 box_min(pos.x - 1, pos.y - 1); ImVec2 box_max(box_min.x + LayoutItemSize.x + 2, box_min.y + LayoutItemSize.y + 2); // Dubious draw_list->AddRectFilled(box_min, box_max, icon_bg_color); // Background color if (ShowTypeOverlay && item_data->Type != 0) { ImU32 type_col = icon_type_overlay_colors[item_data->Type % IM_ARRAYSIZE(icon_type_overlay_colors)]; draw_list->AddRectFilled(ImVec2(box_max.x - 2 - icon_type_overlay_size.x, box_min.y + 2), ImVec2(box_max.x - 2, box_min.y + 2 + icon_type_overlay_size.y), type_col); } if (display_label) { ImU32 label_col = ImGui::GetColorU32(item_is_selected ? ImGuiCol_Text : ImGuiCol_TextDisabled); char label[32]; sprintf(label, "%d", item_data->ID); draw_list->AddText(ImVec2(box_min.x, box_max.y - ImGui::GetFontSize()), label_col, label); } } ImGui::PopID(); } } } clipper.End(); ImGui::PopStyleVar(); // ImGuiStyleVar_ItemSpacing // Context menu if (ImGui::BeginPopupContextWindow()) { ImGui::Text("Selection: %d items", Selection.Size); ImGui::Separator(); if (ImGui::MenuItem("Delete", "Del", false, Selection.Size > 0)) RequestDelete = true; ImGui::EndPopup(); } ms_io = ImGui::EndMultiSelect(); Selection.ApplyRequests(ms_io); if (want_delete) Selection.ApplyDeletionPostLoop(ms_io, Items, item_curr_idx_to_focus); // Zooming with CTRL+Wheel if (ImGui::IsWindowAppearing()) ZoomWheelAccum = 0.0f; if (ImGui::IsWindowHovered() && io.MouseWheel != 0.0f && ImGui::IsKeyDown(ImGuiMod_Ctrl) && ImGui::IsAnyItemActive() == false) { ZoomWheelAccum += io.MouseWheel; if (fabsf(ZoomWheelAccum) >= 1.0f) { // Calculate hovered item index from mouse location // FIXME: Locking aiming on 'hovered_item_idx' (with a cool-down timer) would ensure zoom keeps on it. const float hovered_item_nx = (io.MousePos.x - start_pos.x + LayoutItemSpacing * 0.5f) / LayoutItemStep.x; const float hovered_item_ny = (io.MousePos.y - start_pos.y + LayoutItemSpacing * 0.5f) / LayoutItemStep.y; const int hovered_item_idx = ((int)hovered_item_ny * LayoutColumnCount) + (int)hovered_item_nx; //ImGui::SetTooltip("%f,%f -> item %d", hovered_item_nx, hovered_item_ny, hovered_item_idx); // Move those 4 lines in block above for easy debugging // Zoom IconSize *= powf(1.1f, (float)(int)ZoomWheelAccum); IconSize = IM_CLAMP(IconSize, 16.0f, 128.0f); ZoomWheelAccum -= (int)ZoomWheelAccum; UpdateLayoutSizes(avail_width); // Manipulate scroll to that we will land at the same Y location of currently hovered item. // - Calculate next frame position of item under mouse // - Set new scroll position to be used in next ImGui::BeginChild() call. float hovered_item_rel_pos_y = ((float)(hovered_item_idx / LayoutColumnCount) + fmodf(hovered_item_ny, 1.0f)) * LayoutItemStep.y; hovered_item_rel_pos_y += ImGui::GetStyle().WindowPadding.y; float mouse_local_y = io.MousePos.y - ImGui::GetWindowPos().y; ImGui::SetScrollY(hovered_item_rel_pos_y - mouse_local_y); } } } ImGui::EndChild(); ImGui::Text("Selected: %d/%d items", Selection.Size, Items.Size); ImGui::End(); } }; void ShowExampleAppAssetsBrowser(bool* p_open) { IMGUI_DEMO_MARKER("Examples/Assets Browser"); static ExampleAssetsBrowser assets_browser; assets_browser.Draw("Example: Assets Browser", p_open); } // End of Demo code #else void ImGui::ShowAboutWindow(bool*) {} void ImGui::ShowDemoWindow(bool*) {} void ImGui::ShowUserGuide() {} void ImGui::ShowStyleEditor(ImGuiStyle*) {} bool ImGui::ShowStyleSelector(const char* label) { return false; } void ImGui::ShowFontSelector(const char* label) {} #endif #endif // #ifndef IMGUI_DISABLE ================================================ FILE: src/DesktopPlusUI/imgui/imgui_draw.cpp ================================================ // dear imgui, v1.91.9b // (drawing and font code) /* Index of this file: // [SECTION] STB libraries implementation // [SECTION] Style functions // [SECTION] ImDrawList // [SECTION] ImTriangulator, ImDrawList concave polygon fill // [SECTION] ImDrawListSplitter // [SECTION] ImDrawData // [SECTION] Helpers ShadeVertsXXX functions // [SECTION] ImFontConfig // [SECTION] ImFontAtlas // [SECTION] ImFontAtlas: glyph ranges helpers // [SECTION] ImFontGlyphRangesBuilder // [SECTION] ImFont // [SECTION] ImGui Internal Render Helpers // [SECTION] Decompression code // [SECTION] Default font data (ProggyClean.ttf) */ #if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_WARNINGS) #define _CRT_SECURE_NO_WARNINGS #endif #ifndef IMGUI_DEFINE_MATH_OPERATORS #define IMGUI_DEFINE_MATH_OPERATORS #endif #include "imgui.h" #ifndef IMGUI_DISABLE #include "imgui_internal.h" #ifdef IMGUI_ENABLE_FREETYPE #include "misc/freetype/imgui_freetype.h" #endif #include // vsnprintf, sscanf, printf // Visual Studio warnings #ifdef _MSC_VER #pragma warning (disable: 4127) // condition expression is constant #pragma warning (disable: 4505) // unreferenced local function has been removed (stb stuff) #pragma warning (disable: 4996) // 'This function or variable may be unsafe': strcpy, strdup, sprintf, vsnprintf, sscanf, fopen #pragma warning (disable: 26451) // [Static Analyzer] Arithmetic overflow : Using operator 'xxx' on a 4 byte value and then casting the result to a 8 byte value. Cast the value to the wider type before calling operator 'xxx' to avoid overflow(io.2). #pragma warning (disable: 26812) // [Static Analyzer] The enum type 'xxx' is unscoped. Prefer 'enum class' over 'enum' (Enum.3). [MSVC Static Analyzer) #endif // Clang/GCC warnings with -Weverything #if defined(__clang__) #if __has_warning("-Wunknown-warning-option") #pragma clang diagnostic ignored "-Wunknown-warning-option" // warning: unknown warning group 'xxx' // not all warnings are known by all Clang versions and they tend to be rename-happy.. so ignoring warnings triggers new warnings on some configuration. Great! #endif #pragma clang diagnostic ignored "-Wunknown-pragmas" // warning: unknown warning group 'xxx' #pragma clang diagnostic ignored "-Wold-style-cast" // warning: use of old-style cast // yes, they are more terse. #pragma clang diagnostic ignored "-Wfloat-equal" // warning: comparing floating point with == or != is unsafe // storing and comparing against same constants ok. #pragma clang diagnostic ignored "-Wglobal-constructors" // warning: declaration requires a global destructor // similar to above, not sure what the exact difference is. #pragma clang diagnostic ignored "-Wsign-conversion" // warning: implicit conversion changes signedness #pragma clang diagnostic ignored "-Wzero-as-null-pointer-constant" // warning: zero as null pointer constant // some standard header variations use #define NULL 0 #pragma clang diagnostic ignored "-Wcomma" // warning: possible misuse of comma operator here #pragma clang diagnostic ignored "-Wreserved-id-macro" // warning: macro name is a reserved identifier #pragma clang diagnostic ignored "-Wdouble-promotion" // warning: implicit conversion from 'float' to 'double' when passing argument to function // using printf() is a misery with this as C++ va_arg ellipsis changes float to double. #pragma clang diagnostic ignored "-Wimplicit-int-float-conversion" // warning: implicit conversion from 'xxx' to 'float' may lose precision #pragma clang diagnostic ignored "-Wreserved-identifier" // warning: identifier '_Xxx' is reserved because it starts with '_' followed by a capital letter #pragma clang diagnostic ignored "-Wunsafe-buffer-usage" // warning: 'xxx' is an unsafe pointer used for buffer access #pragma clang diagnostic ignored "-Wnontrivial-memaccess" // warning: first argument in call to 'memset' is a pointer to non-trivially copyable type #pragma clang diagnostic ignored "-Wcast-qual" // warning: cast from 'const xxxx *' to 'xxx *' drops const qualifier #pragma clang diagnostic ignored "-Wswitch-default" // warning: 'switch' missing 'default' label #elif defined(__GNUC__) #pragma GCC diagnostic ignored "-Wpragmas" // warning: unknown option after '#pragma GCC diagnostic' kind #pragma GCC diagnostic ignored "-Wunused-function" // warning: 'xxxx' defined but not used #pragma GCC diagnostic ignored "-Wfloat-equal" // warning: comparing floating-point with '==' or '!=' is unsafe #pragma GCC diagnostic ignored "-Wdouble-promotion" // warning: implicit conversion from 'float' to 'double' when passing argument to function #pragma GCC diagnostic ignored "-Wconversion" // warning: conversion to 'xxxx' from 'xxxx' may alter its value #pragma GCC diagnostic ignored "-Wstack-protector" // warning: stack protector not protecting local variables: variable length buffer #pragma GCC diagnostic ignored "-Wstrict-overflow" // warning: assuming signed overflow does not occur when simplifying division / ..when changing X +- C1 cmp C2 to X cmp C2 -+ C1 #pragma GCC diagnostic ignored "-Wclass-memaccess" // [__GNUC__ >= 8] warning: 'memset/memcpy' clearing/writing an object of type 'xxxx' with no trivial copy-assignment; use assignment or value-initialization instead #pragma GCC diagnostic ignored "-Wcast-qual" // warning: cast from type 'const xxxx *' to type 'xxxx *' casts away qualifiers #endif //------------------------------------------------------------------------- // [SECTION] STB libraries implementation (for stb_truetype and stb_rect_pack) //------------------------------------------------------------------------- // Compile time options: //#define IMGUI_STB_NAMESPACE ImStb //#define IMGUI_STB_TRUETYPE_FILENAME "my_folder/stb_truetype.h" //#define IMGUI_STB_RECT_PACK_FILENAME "my_folder/stb_rect_pack.h" //#define IMGUI_DISABLE_STB_TRUETYPE_IMPLEMENTATION //#define IMGUI_DISABLE_STB_RECT_PACK_IMPLEMENTATION #ifdef IMGUI_STB_NAMESPACE namespace IMGUI_STB_NAMESPACE { #endif #ifdef _MSC_VER #pragma warning (push) #pragma warning (disable: 4456) // declaration of 'xx' hides previous local declaration #pragma warning (disable: 6011) // (stb_rectpack) Dereferencing NULL pointer 'cur->next'. #pragma warning (disable: 6385) // (stb_truetype) Reading invalid data from 'buffer': the readable size is '_Old_3`kernel_width' bytes, but '3' bytes may be read. #pragma warning (disable: 28182) // (stb_rectpack) Dereferencing NULL pointer. 'cur' contains the same NULL value as 'cur->next' did. #endif #if defined(__clang__) #pragma clang diagnostic push #pragma clang diagnostic ignored "-Wunused-function" // warning: 'xxxx' defined but not used #pragma clang diagnostic ignored "-Wmissing-prototypes" #pragma clang diagnostic ignored "-Wimplicit-fallthrough" #endif #if defined(__GNUC__) #pragma GCC diagnostic push #pragma GCC diagnostic ignored "-Wtype-limits" // warning: comparison is always true due to limited range of data type [-Wtype-limits] #pragma GCC diagnostic ignored "-Wimplicit-fallthrough" // warning: this statement may fall through #endif #ifndef STB_RECT_PACK_IMPLEMENTATION // in case the user already have an implementation in the _same_ compilation unit (e.g. unity builds) #ifndef IMGUI_DISABLE_STB_RECT_PACK_IMPLEMENTATION // in case the user already have an implementation in another compilation unit #define STBRP_STATIC #define STBRP_ASSERT(x) do { IM_ASSERT(x); } while (0) #define STBRP_SORT ImQsort #define STB_RECT_PACK_IMPLEMENTATION #endif #ifdef IMGUI_STB_RECT_PACK_FILENAME #include IMGUI_STB_RECT_PACK_FILENAME #else #include "imstb_rectpack.h" #endif #endif #ifdef IMGUI_ENABLE_STB_TRUETYPE #ifndef STB_TRUETYPE_IMPLEMENTATION // in case the user already have an implementation in the _same_ compilation unit (e.g. unity builds) #ifndef IMGUI_DISABLE_STB_TRUETYPE_IMPLEMENTATION // in case the user already have an implementation in another compilation unit #define STBTT_malloc(x,u) ((void)(u), IM_ALLOC(x)) #define STBTT_free(x,u) ((void)(u), IM_FREE(x)) #define STBTT_assert(x) do { IM_ASSERT(x); } while(0) #define STBTT_fmod(x,y) ImFmod(x,y) #define STBTT_sqrt(x) ImSqrt(x) #define STBTT_pow(x,y) ImPow(x,y) #define STBTT_fabs(x) ImFabs(x) #define STBTT_ifloor(x) ((int)ImFloor(x)) #define STBTT_iceil(x) ((int)ImCeil(x)) #define STBTT_strlen(x) ImStrlen(x) #define STBTT_STATIC #define STB_TRUETYPE_IMPLEMENTATION #else #define STBTT_DEF extern #endif #ifdef IMGUI_STB_TRUETYPE_FILENAME #include IMGUI_STB_TRUETYPE_FILENAME #else #include "imstb_truetype.h" #endif #endif #endif // IMGUI_ENABLE_STB_TRUETYPE #if defined(__GNUC__) #pragma GCC diagnostic pop #endif #if defined(__clang__) #pragma clang diagnostic pop #endif #if defined(_MSC_VER) #pragma warning (pop) #endif #ifdef IMGUI_STB_NAMESPACE } // namespace ImStb using namespace IMGUI_STB_NAMESPACE; #endif //----------------------------------------------------------------------------- // [SECTION] Style functions //----------------------------------------------------------------------------- void ImGui::StyleColorsDark(ImGuiStyle* dst) { ImGuiStyle* style = dst ? dst : &ImGui::GetStyle(); ImVec4* colors = style->Colors; colors[ImGuiCol_Text] = ImVec4(1.00f, 1.00f, 1.00f, 1.00f); colors[ImGuiCol_TextDisabled] = ImVec4(0.50f, 0.50f, 0.50f, 1.00f); colors[ImGuiCol_WindowBg] = ImVec4(0.06f, 0.06f, 0.06f, 0.94f); colors[ImGuiCol_ChildBg] = ImVec4(0.00f, 0.00f, 0.00f, 0.00f); colors[ImGuiCol_PopupBg] = ImVec4(0.08f, 0.08f, 0.08f, 0.94f); colors[ImGuiCol_Border] = ImVec4(0.43f, 0.43f, 0.50f, 0.50f); colors[ImGuiCol_BorderShadow] = ImVec4(0.00f, 0.00f, 0.00f, 0.00f); colors[ImGuiCol_FrameBg] = ImVec4(0.16f, 0.29f, 0.48f, 0.54f); colors[ImGuiCol_FrameBgHovered] = ImVec4(0.26f, 0.59f, 0.98f, 0.40f); colors[ImGuiCol_FrameBgActive] = ImVec4(0.26f, 0.59f, 0.98f, 0.67f); colors[ImGuiCol_TitleBg] = ImVec4(0.04f, 0.04f, 0.04f, 1.00f); colors[ImGuiCol_TitleBgActive] = ImVec4(0.16f, 0.29f, 0.48f, 1.00f); colors[ImGuiCol_TitleBgCollapsed] = ImVec4(0.00f, 0.00f, 0.00f, 0.51f); colors[ImGuiCol_MenuBarBg] = ImVec4(0.14f, 0.14f, 0.14f, 1.00f); colors[ImGuiCol_ScrollbarBg] = ImVec4(0.02f, 0.02f, 0.02f, 0.53f); colors[ImGuiCol_ScrollbarGrab] = ImVec4(0.31f, 0.31f, 0.31f, 1.00f); colors[ImGuiCol_ScrollbarGrabHovered] = ImVec4(0.41f, 0.41f, 0.41f, 1.00f); colors[ImGuiCol_ScrollbarGrabActive] = ImVec4(0.51f, 0.51f, 0.51f, 1.00f); colors[ImGuiCol_CheckMark] = ImVec4(0.26f, 0.59f, 0.98f, 1.00f); colors[ImGuiCol_SliderGrab] = ImVec4(0.24f, 0.52f, 0.88f, 1.00f); colors[ImGuiCol_SliderGrabActive] = ImVec4(0.26f, 0.59f, 0.98f, 1.00f); colors[ImGuiCol_Button] = ImVec4(0.26f, 0.59f, 0.98f, 0.40f); colors[ImGuiCol_ButtonHovered] = ImVec4(0.26f, 0.59f, 0.98f, 1.00f); colors[ImGuiCol_ButtonActive] = ImVec4(0.06f, 0.53f, 0.98f, 1.00f); colors[ImGuiCol_Header] = ImVec4(0.26f, 0.59f, 0.98f, 0.31f); colors[ImGuiCol_HeaderHovered] = ImVec4(0.26f, 0.59f, 0.98f, 0.80f); colors[ImGuiCol_HeaderActive] = ImVec4(0.26f, 0.59f, 0.98f, 1.00f); colors[ImGuiCol_Separator] = colors[ImGuiCol_Border]; colors[ImGuiCol_SeparatorHovered] = ImVec4(0.10f, 0.40f, 0.75f, 0.78f); colors[ImGuiCol_SeparatorActive] = ImVec4(0.10f, 0.40f, 0.75f, 1.00f); colors[ImGuiCol_ResizeGrip] = ImVec4(0.26f, 0.59f, 0.98f, 0.20f); colors[ImGuiCol_ResizeGripHovered] = ImVec4(0.26f, 0.59f, 0.98f, 0.67f); colors[ImGuiCol_ResizeGripActive] = ImVec4(0.26f, 0.59f, 0.98f, 0.95f); colors[ImGuiCol_TabHovered] = colors[ImGuiCol_HeaderHovered]; colors[ImGuiCol_Tab] = ImLerp(colors[ImGuiCol_Header], colors[ImGuiCol_TitleBgActive], 0.80f); colors[ImGuiCol_TabSelected] = ImLerp(colors[ImGuiCol_HeaderActive], colors[ImGuiCol_TitleBgActive], 0.60f); colors[ImGuiCol_TabSelectedOverline] = colors[ImGuiCol_HeaderActive]; colors[ImGuiCol_TabDimmed] = ImLerp(colors[ImGuiCol_Tab], colors[ImGuiCol_TitleBg], 0.80f); colors[ImGuiCol_TabDimmedSelected] = ImLerp(colors[ImGuiCol_TabSelected], colors[ImGuiCol_TitleBg], 0.40f); colors[ImGuiCol_TabDimmedSelectedOverline] = ImVec4(0.50f, 0.50f, 0.50f, 0.00f); colors[ImGuiCol_PlotLines] = ImVec4(0.61f, 0.61f, 0.61f, 1.00f); colors[ImGuiCol_PlotLinesHovered] = ImVec4(1.00f, 0.43f, 0.35f, 1.00f); colors[ImGuiCol_PlotHistogram] = ImVec4(0.90f, 0.70f, 0.00f, 1.00f); colors[ImGuiCol_PlotHistogramHovered] = ImVec4(1.00f, 0.60f, 0.00f, 1.00f); colors[ImGuiCol_TableHeaderBg] = ImVec4(0.19f, 0.19f, 0.20f, 1.00f); colors[ImGuiCol_TableBorderStrong] = ImVec4(0.31f, 0.31f, 0.35f, 1.00f); // Prefer using Alpha=1.0 here colors[ImGuiCol_TableBorderLight] = ImVec4(0.23f, 0.23f, 0.25f, 1.00f); // Prefer using Alpha=1.0 here colors[ImGuiCol_TableRowBg] = ImVec4(0.00f, 0.00f, 0.00f, 0.00f); colors[ImGuiCol_TableRowBgAlt] = ImVec4(1.00f, 1.00f, 1.00f, 0.06f); colors[ImGuiCol_TextLink] = colors[ImGuiCol_HeaderActive]; colors[ImGuiCol_TextSelectedBg] = ImVec4(0.26f, 0.59f, 0.98f, 0.35f); colors[ImGuiCol_DragDropTarget] = ImVec4(1.00f, 1.00f, 0.00f, 0.90f); colors[ImGuiCol_NavCursor] = ImVec4(0.26f, 0.59f, 0.98f, 1.00f); colors[ImGuiCol_NavWindowingHighlight] = ImVec4(1.00f, 1.00f, 1.00f, 0.70f); colors[ImGuiCol_NavWindowingDimBg] = ImVec4(0.80f, 0.80f, 0.80f, 0.20f); colors[ImGuiCol_ModalWindowDimBg] = ImVec4(0.80f, 0.80f, 0.80f, 0.35f); } void ImGui::StyleColorsClassic(ImGuiStyle* dst) { ImGuiStyle* style = dst ? dst : &ImGui::GetStyle(); ImVec4* colors = style->Colors; colors[ImGuiCol_Text] = ImVec4(0.90f, 0.90f, 0.90f, 1.00f); colors[ImGuiCol_TextDisabled] = ImVec4(0.60f, 0.60f, 0.60f, 1.00f); colors[ImGuiCol_WindowBg] = ImVec4(0.00f, 0.00f, 0.00f, 0.85f); colors[ImGuiCol_ChildBg] = ImVec4(0.00f, 0.00f, 0.00f, 0.00f); colors[ImGuiCol_PopupBg] = ImVec4(0.11f, 0.11f, 0.14f, 0.92f); colors[ImGuiCol_Border] = ImVec4(0.50f, 0.50f, 0.50f, 0.50f); colors[ImGuiCol_BorderShadow] = ImVec4(0.00f, 0.00f, 0.00f, 0.00f); colors[ImGuiCol_FrameBg] = ImVec4(0.43f, 0.43f, 0.43f, 0.39f); colors[ImGuiCol_FrameBgHovered] = ImVec4(0.47f, 0.47f, 0.69f, 0.40f); colors[ImGuiCol_FrameBgActive] = ImVec4(0.42f, 0.41f, 0.64f, 0.69f); colors[ImGuiCol_TitleBg] = ImVec4(0.27f, 0.27f, 0.54f, 0.83f); colors[ImGuiCol_TitleBgActive] = ImVec4(0.32f, 0.32f, 0.63f, 0.87f); colors[ImGuiCol_TitleBgCollapsed] = ImVec4(0.40f, 0.40f, 0.80f, 0.20f); colors[ImGuiCol_MenuBarBg] = ImVec4(0.40f, 0.40f, 0.55f, 0.80f); colors[ImGuiCol_ScrollbarBg] = ImVec4(0.20f, 0.25f, 0.30f, 0.60f); colors[ImGuiCol_ScrollbarGrab] = ImVec4(0.40f, 0.40f, 0.80f, 0.30f); colors[ImGuiCol_ScrollbarGrabHovered] = ImVec4(0.40f, 0.40f, 0.80f, 0.40f); colors[ImGuiCol_ScrollbarGrabActive] = ImVec4(0.41f, 0.39f, 0.80f, 0.60f); colors[ImGuiCol_CheckMark] = ImVec4(0.90f, 0.90f, 0.90f, 0.50f); colors[ImGuiCol_SliderGrab] = ImVec4(1.00f, 1.00f, 1.00f, 0.30f); colors[ImGuiCol_SliderGrabActive] = ImVec4(0.41f, 0.39f, 0.80f, 0.60f); colors[ImGuiCol_Button] = ImVec4(0.35f, 0.40f, 0.61f, 0.62f); colors[ImGuiCol_ButtonHovered] = ImVec4(0.40f, 0.48f, 0.71f, 0.79f); colors[ImGuiCol_ButtonActive] = ImVec4(0.46f, 0.54f, 0.80f, 1.00f); colors[ImGuiCol_Header] = ImVec4(0.40f, 0.40f, 0.90f, 0.45f); colors[ImGuiCol_HeaderHovered] = ImVec4(0.45f, 0.45f, 0.90f, 0.80f); colors[ImGuiCol_HeaderActive] = ImVec4(0.53f, 0.53f, 0.87f, 0.80f); colors[ImGuiCol_Separator] = ImVec4(0.50f, 0.50f, 0.50f, 0.60f); colors[ImGuiCol_SeparatorHovered] = ImVec4(0.60f, 0.60f, 0.70f, 1.00f); colors[ImGuiCol_SeparatorActive] = ImVec4(0.70f, 0.70f, 0.90f, 1.00f); colors[ImGuiCol_ResizeGrip] = ImVec4(1.00f, 1.00f, 1.00f, 0.10f); colors[ImGuiCol_ResizeGripHovered] = ImVec4(0.78f, 0.82f, 1.00f, 0.60f); colors[ImGuiCol_ResizeGripActive] = ImVec4(0.78f, 0.82f, 1.00f, 0.90f); colors[ImGuiCol_TabHovered] = colors[ImGuiCol_HeaderHovered]; colors[ImGuiCol_Tab] = ImLerp(colors[ImGuiCol_Header], colors[ImGuiCol_TitleBgActive], 0.80f); colors[ImGuiCol_TabSelected] = ImLerp(colors[ImGuiCol_HeaderActive], colors[ImGuiCol_TitleBgActive], 0.60f); colors[ImGuiCol_TabSelectedOverline] = colors[ImGuiCol_HeaderActive]; colors[ImGuiCol_TabDimmed] = ImLerp(colors[ImGuiCol_Tab], colors[ImGuiCol_TitleBg], 0.80f); colors[ImGuiCol_TabDimmedSelected] = ImLerp(colors[ImGuiCol_TabSelected], colors[ImGuiCol_TitleBg], 0.40f); colors[ImGuiCol_TabDimmedSelectedOverline] = ImVec4(0.53f, 0.53f, 0.87f, 0.00f); colors[ImGuiCol_PlotLines] = ImVec4(1.00f, 1.00f, 1.00f, 1.00f); colors[ImGuiCol_PlotLinesHovered] = ImVec4(0.90f, 0.70f, 0.00f, 1.00f); colors[ImGuiCol_PlotHistogram] = ImVec4(0.90f, 0.70f, 0.00f, 1.00f); colors[ImGuiCol_PlotHistogramHovered] = ImVec4(1.00f, 0.60f, 0.00f, 1.00f); colors[ImGuiCol_TableHeaderBg] = ImVec4(0.27f, 0.27f, 0.38f, 1.00f); colors[ImGuiCol_TableBorderStrong] = ImVec4(0.31f, 0.31f, 0.45f, 1.00f); // Prefer using Alpha=1.0 here colors[ImGuiCol_TableBorderLight] = ImVec4(0.26f, 0.26f, 0.28f, 1.00f); // Prefer using Alpha=1.0 here colors[ImGuiCol_TableRowBg] = ImVec4(0.00f, 0.00f, 0.00f, 0.00f); colors[ImGuiCol_TableRowBgAlt] = ImVec4(1.00f, 1.00f, 1.00f, 0.07f); colors[ImGuiCol_TextLink] = colors[ImGuiCol_HeaderActive]; colors[ImGuiCol_TextSelectedBg] = ImVec4(0.00f, 0.00f, 1.00f, 0.35f); colors[ImGuiCol_DragDropTarget] = ImVec4(1.00f, 1.00f, 0.00f, 0.90f); colors[ImGuiCol_NavCursor] = colors[ImGuiCol_HeaderHovered]; colors[ImGuiCol_NavWindowingHighlight] = ImVec4(1.00f, 1.00f, 1.00f, 0.70f); colors[ImGuiCol_NavWindowingDimBg] = ImVec4(0.80f, 0.80f, 0.80f, 0.20f); colors[ImGuiCol_ModalWindowDimBg] = ImVec4(0.20f, 0.20f, 0.20f, 0.35f); } // Those light colors are better suited with a thicker font than the default one + FrameBorder void ImGui::StyleColorsLight(ImGuiStyle* dst) { ImGuiStyle* style = dst ? dst : &ImGui::GetStyle(); ImVec4* colors = style->Colors; colors[ImGuiCol_Text] = ImVec4(0.00f, 0.00f, 0.00f, 1.00f); colors[ImGuiCol_TextDisabled] = ImVec4(0.60f, 0.60f, 0.60f, 1.00f); colors[ImGuiCol_WindowBg] = ImVec4(0.94f, 0.94f, 0.94f, 1.00f); colors[ImGuiCol_ChildBg] = ImVec4(0.00f, 0.00f, 0.00f, 0.00f); colors[ImGuiCol_PopupBg] = ImVec4(1.00f, 1.00f, 1.00f, 0.98f); colors[ImGuiCol_Border] = ImVec4(0.00f, 0.00f, 0.00f, 0.30f); colors[ImGuiCol_BorderShadow] = ImVec4(0.00f, 0.00f, 0.00f, 0.00f); colors[ImGuiCol_FrameBg] = ImVec4(1.00f, 1.00f, 1.00f, 1.00f); colors[ImGuiCol_FrameBgHovered] = ImVec4(0.26f, 0.59f, 0.98f, 0.40f); colors[ImGuiCol_FrameBgActive] = ImVec4(0.26f, 0.59f, 0.98f, 0.67f); colors[ImGuiCol_TitleBg] = ImVec4(0.96f, 0.96f, 0.96f, 1.00f); colors[ImGuiCol_TitleBgActive] = ImVec4(0.82f, 0.82f, 0.82f, 1.00f); colors[ImGuiCol_TitleBgCollapsed] = ImVec4(1.00f, 1.00f, 1.00f, 0.51f); colors[ImGuiCol_MenuBarBg] = ImVec4(0.86f, 0.86f, 0.86f, 1.00f); colors[ImGuiCol_ScrollbarBg] = ImVec4(0.98f, 0.98f, 0.98f, 0.53f); colors[ImGuiCol_ScrollbarGrab] = ImVec4(0.69f, 0.69f, 0.69f, 0.80f); colors[ImGuiCol_ScrollbarGrabHovered] = ImVec4(0.49f, 0.49f, 0.49f, 0.80f); colors[ImGuiCol_ScrollbarGrabActive] = ImVec4(0.49f, 0.49f, 0.49f, 1.00f); colors[ImGuiCol_CheckMark] = ImVec4(0.26f, 0.59f, 0.98f, 1.00f); colors[ImGuiCol_SliderGrab] = ImVec4(0.26f, 0.59f, 0.98f, 0.78f); colors[ImGuiCol_SliderGrabActive] = ImVec4(0.46f, 0.54f, 0.80f, 0.60f); colors[ImGuiCol_Button] = ImVec4(0.26f, 0.59f, 0.98f, 0.40f); colors[ImGuiCol_ButtonHovered] = ImVec4(0.26f, 0.59f, 0.98f, 1.00f); colors[ImGuiCol_ButtonActive] = ImVec4(0.06f, 0.53f, 0.98f, 1.00f); colors[ImGuiCol_Header] = ImVec4(0.26f, 0.59f, 0.98f, 0.31f); colors[ImGuiCol_HeaderHovered] = ImVec4(0.26f, 0.59f, 0.98f, 0.80f); colors[ImGuiCol_HeaderActive] = ImVec4(0.26f, 0.59f, 0.98f, 1.00f); colors[ImGuiCol_Separator] = ImVec4(0.39f, 0.39f, 0.39f, 0.62f); colors[ImGuiCol_SeparatorHovered] = ImVec4(0.14f, 0.44f, 0.80f, 0.78f); colors[ImGuiCol_SeparatorActive] = ImVec4(0.14f, 0.44f, 0.80f, 1.00f); colors[ImGuiCol_ResizeGrip] = ImVec4(0.35f, 0.35f, 0.35f, 0.17f); colors[ImGuiCol_ResizeGripHovered] = ImVec4(0.26f, 0.59f, 0.98f, 0.67f); colors[ImGuiCol_ResizeGripActive] = ImVec4(0.26f, 0.59f, 0.98f, 0.95f); colors[ImGuiCol_TabHovered] = colors[ImGuiCol_HeaderHovered]; colors[ImGuiCol_Tab] = ImLerp(colors[ImGuiCol_Header], colors[ImGuiCol_TitleBgActive], 0.90f); colors[ImGuiCol_TabSelected] = ImLerp(colors[ImGuiCol_HeaderActive], colors[ImGuiCol_TitleBgActive], 0.60f); colors[ImGuiCol_TabSelectedOverline] = colors[ImGuiCol_HeaderActive]; colors[ImGuiCol_TabDimmed] = ImLerp(colors[ImGuiCol_Tab], colors[ImGuiCol_TitleBg], 0.80f); colors[ImGuiCol_TabDimmedSelected] = ImLerp(colors[ImGuiCol_TabSelected], colors[ImGuiCol_TitleBg], 0.40f); colors[ImGuiCol_TabDimmedSelectedOverline] = ImVec4(0.26f, 0.59f, 1.00f, 0.00f); colors[ImGuiCol_PlotLines] = ImVec4(0.39f, 0.39f, 0.39f, 1.00f); colors[ImGuiCol_PlotLinesHovered] = ImVec4(1.00f, 0.43f, 0.35f, 1.00f); colors[ImGuiCol_PlotHistogram] = ImVec4(0.90f, 0.70f, 0.00f, 1.00f); colors[ImGuiCol_PlotHistogramHovered] = ImVec4(1.00f, 0.45f, 0.00f, 1.00f); colors[ImGuiCol_TableHeaderBg] = ImVec4(0.78f, 0.87f, 0.98f, 1.00f); colors[ImGuiCol_TableBorderStrong] = ImVec4(0.57f, 0.57f, 0.64f, 1.00f); // Prefer using Alpha=1.0 here colors[ImGuiCol_TableBorderLight] = ImVec4(0.68f, 0.68f, 0.74f, 1.00f); // Prefer using Alpha=1.0 here colors[ImGuiCol_TableRowBg] = ImVec4(0.00f, 0.00f, 0.00f, 0.00f); colors[ImGuiCol_TableRowBgAlt] = ImVec4(0.30f, 0.30f, 0.30f, 0.09f); colors[ImGuiCol_TextLink] = colors[ImGuiCol_HeaderActive]; colors[ImGuiCol_TextSelectedBg] = ImVec4(0.26f, 0.59f, 0.98f, 0.35f); colors[ImGuiCol_DragDropTarget] = ImVec4(0.26f, 0.59f, 0.98f, 0.95f); colors[ImGuiCol_NavCursor] = colors[ImGuiCol_HeaderHovered]; colors[ImGuiCol_NavWindowingHighlight] = ImVec4(0.70f, 0.70f, 0.70f, 0.70f); colors[ImGuiCol_NavWindowingDimBg] = ImVec4(0.20f, 0.20f, 0.20f, 0.20f); colors[ImGuiCol_ModalWindowDimBg] = ImVec4(0.20f, 0.20f, 0.20f, 0.35f); } //----------------------------------------------------------------------------- // [SECTION] ImDrawList //----------------------------------------------------------------------------- ImDrawListSharedData::ImDrawListSharedData() { memset(this, 0, sizeof(*this)); InitialFringeScale = 1.0f; for (int i = 0; i < IM_ARRAYSIZE(ArcFastVtx); i++) { const float a = ((float)i * 2 * IM_PI) / (float)IM_ARRAYSIZE(ArcFastVtx); ArcFastVtx[i] = ImVec2(ImCos(a), ImSin(a)); } ArcFastRadiusCutoff = IM_DRAWLIST_CIRCLE_AUTO_SEGMENT_CALC_R(IM_DRAWLIST_ARCFAST_SAMPLE_MAX, CircleSegmentMaxError); } void ImDrawListSharedData::SetCircleTessellationMaxError(float max_error) { if (CircleSegmentMaxError == max_error) return; IM_ASSERT(max_error > 0.0f); CircleSegmentMaxError = max_error; for (int i = 0; i < IM_ARRAYSIZE(CircleSegmentCounts); i++) { const float radius = (float)i; CircleSegmentCounts[i] = (ImU8)((i > 0) ? IM_DRAWLIST_CIRCLE_AUTO_SEGMENT_CALC(radius, CircleSegmentMaxError) : IM_DRAWLIST_ARCFAST_SAMPLE_MAX); } ArcFastRadiusCutoff = IM_DRAWLIST_CIRCLE_AUTO_SEGMENT_CALC_R(IM_DRAWLIST_ARCFAST_SAMPLE_MAX, CircleSegmentMaxError); } ImDrawList::ImDrawList(ImDrawListSharedData* shared_data) { memset(this, 0, sizeof(*this)); _Data = shared_data; } ImDrawList::~ImDrawList() { _ClearFreeMemory(); } // Initialize before use in a new frame. We always have a command ready in the buffer. // In the majority of cases, you would want to call PushClipRect() and PushTextureID() after this. void ImDrawList::_ResetForNewFrame() { // Verify that the ImDrawCmd fields we want to memcmp() are contiguous in memory. IM_STATIC_ASSERT(offsetof(ImDrawCmd, ClipRect) == 0); IM_STATIC_ASSERT(offsetof(ImDrawCmd, TextureId) == sizeof(ImVec4)); IM_STATIC_ASSERT(offsetof(ImDrawCmd, VtxOffset) == sizeof(ImVec4) + sizeof(ImTextureID)); if (_Splitter._Count > 1) _Splitter.Merge(this); CmdBuffer.resize(0); IdxBuffer.resize(0); VtxBuffer.resize(0); Flags = _Data->InitialFlags; memset(&_CmdHeader, 0, sizeof(_CmdHeader)); _VtxCurrentIdx = 0; _VtxWritePtr = NULL; _IdxWritePtr = NULL; _ClipRectStack.resize(0); _TextureIdStack.resize(0); _CallbacksDataBuf.resize(0); _Path.resize(0); _Splitter.Clear(); CmdBuffer.push_back(ImDrawCmd()); _FringeScale = _Data->InitialFringeScale; } void ImDrawList::_ClearFreeMemory() { CmdBuffer.clear(); IdxBuffer.clear(); VtxBuffer.clear(); Flags = ImDrawListFlags_None; _VtxCurrentIdx = 0; _VtxWritePtr = NULL; _IdxWritePtr = NULL; _ClipRectStack.clear(); _TextureIdStack.clear(); _CallbacksDataBuf.clear(); _Path.clear(); _Splitter.ClearFreeMemory(); } ImDrawList* ImDrawList::CloneOutput() const { ImDrawList* dst = IM_NEW(ImDrawList(_Data)); dst->CmdBuffer = CmdBuffer; dst->IdxBuffer = IdxBuffer; dst->VtxBuffer = VtxBuffer; dst->Flags = Flags; return dst; } void ImDrawList::AddDrawCmd() { ImDrawCmd draw_cmd; draw_cmd.ClipRect = _CmdHeader.ClipRect; // Same as calling ImDrawCmd_HeaderCopy() draw_cmd.TextureId = _CmdHeader.TextureId; draw_cmd.VtxOffset = _CmdHeader.VtxOffset; draw_cmd.IdxOffset = IdxBuffer.Size; IM_ASSERT(draw_cmd.ClipRect.x <= draw_cmd.ClipRect.z && draw_cmd.ClipRect.y <= draw_cmd.ClipRect.w); CmdBuffer.push_back(draw_cmd); } // Pop trailing draw command (used before merging or presenting to user) // Note that this leaves the ImDrawList in a state unfit for further commands, as most code assume that CmdBuffer.Size > 0 && CmdBuffer.back().UserCallback == NULL void ImDrawList::_PopUnusedDrawCmd() { while (CmdBuffer.Size > 0) { ImDrawCmd* curr_cmd = &CmdBuffer.Data[CmdBuffer.Size - 1]; if (curr_cmd->ElemCount != 0 || curr_cmd->UserCallback != NULL) return;// break; CmdBuffer.pop_back(); } } void ImDrawList::AddCallback(ImDrawCallback callback, void* userdata, size_t userdata_size) { IM_ASSERT_PARANOID(CmdBuffer.Size > 0); ImDrawCmd* curr_cmd = &CmdBuffer.Data[CmdBuffer.Size - 1]; IM_ASSERT(curr_cmd->UserCallback == NULL); if (curr_cmd->ElemCount != 0) { AddDrawCmd(); curr_cmd = &CmdBuffer.Data[CmdBuffer.Size - 1]; } curr_cmd->UserCallback = callback; if (userdata_size == 0) { // Store user data directly in command (no indirection) curr_cmd->UserCallbackData = userdata; curr_cmd->UserCallbackDataSize = 0; curr_cmd->UserCallbackDataOffset = -1; } else { // Copy and store user data in a buffer IM_ASSERT(userdata != NULL); IM_ASSERT(userdata_size < (1u << 31)); curr_cmd->UserCallbackData = NULL; // Will be resolved during Render() curr_cmd->UserCallbackDataSize = (int)userdata_size; curr_cmd->UserCallbackDataOffset = _CallbacksDataBuf.Size; _CallbacksDataBuf.resize(_CallbacksDataBuf.Size + (int)userdata_size); memcpy(_CallbacksDataBuf.Data + (size_t)curr_cmd->UserCallbackDataOffset, userdata, userdata_size); } AddDrawCmd(); // Force a new command after us (see comment below) } // Compare ClipRect, TextureId and VtxOffset with a single memcmp() #define ImDrawCmd_HeaderSize (offsetof(ImDrawCmd, VtxOffset) + sizeof(unsigned int)) #define ImDrawCmd_HeaderCompare(CMD_LHS, CMD_RHS) (memcmp(CMD_LHS, CMD_RHS, ImDrawCmd_HeaderSize)) // Compare ClipRect, TextureId, VtxOffset #define ImDrawCmd_HeaderCopy(CMD_DST, CMD_SRC) (memcpy(CMD_DST, CMD_SRC, ImDrawCmd_HeaderSize)) // Copy ClipRect, TextureId, VtxOffset #define ImDrawCmd_AreSequentialIdxOffset(CMD_0, CMD_1) (CMD_0->IdxOffset + CMD_0->ElemCount == CMD_1->IdxOffset) // Try to merge two last draw commands void ImDrawList::_TryMergeDrawCmds() { IM_ASSERT_PARANOID(CmdBuffer.Size > 0); ImDrawCmd* curr_cmd = &CmdBuffer.Data[CmdBuffer.Size - 1]; ImDrawCmd* prev_cmd = curr_cmd - 1; if (ImDrawCmd_HeaderCompare(curr_cmd, prev_cmd) == 0 && ImDrawCmd_AreSequentialIdxOffset(prev_cmd, curr_cmd) && curr_cmd->UserCallback == NULL && prev_cmd->UserCallback == NULL) { prev_cmd->ElemCount += curr_cmd->ElemCount; CmdBuffer.pop_back(); } } // Our scheme may appears a bit unusual, basically we want the most-common calls AddLine AddRect etc. to not have to perform any check so we always have a command ready in the stack. // The cost of figuring out if a new command has to be added or if we can merge is paid in those Update** functions only. void ImDrawList::_OnChangedClipRect() { // If current command is used with different settings we need to add a new command IM_ASSERT_PARANOID(CmdBuffer.Size > 0); ImDrawCmd* curr_cmd = &CmdBuffer.Data[CmdBuffer.Size - 1]; if (curr_cmd->ElemCount != 0 && memcmp(&curr_cmd->ClipRect, &_CmdHeader.ClipRect, sizeof(ImVec4)) != 0) { AddDrawCmd(); return; } IM_ASSERT(curr_cmd->UserCallback == NULL); // Try to merge with previous command if it matches, else use current command ImDrawCmd* prev_cmd = curr_cmd - 1; if (curr_cmd->ElemCount == 0 && CmdBuffer.Size > 1 && ImDrawCmd_HeaderCompare(&_CmdHeader, prev_cmd) == 0 && ImDrawCmd_AreSequentialIdxOffset(prev_cmd, curr_cmd) && prev_cmd->UserCallback == NULL) { CmdBuffer.pop_back(); return; } curr_cmd->ClipRect = _CmdHeader.ClipRect; } void ImDrawList::_OnChangedTextureID() { // If current command is used with different settings we need to add a new command IM_ASSERT_PARANOID(CmdBuffer.Size > 0); ImDrawCmd* curr_cmd = &CmdBuffer.Data[CmdBuffer.Size - 1]; if (curr_cmd->ElemCount != 0 && curr_cmd->TextureId != _CmdHeader.TextureId) { AddDrawCmd(); return; } IM_ASSERT(curr_cmd->UserCallback == NULL); // Try to merge with previous command if it matches, else use current command ImDrawCmd* prev_cmd = curr_cmd - 1; if (curr_cmd->ElemCount == 0 && CmdBuffer.Size > 1 && ImDrawCmd_HeaderCompare(&_CmdHeader, prev_cmd) == 0 && ImDrawCmd_AreSequentialIdxOffset(prev_cmd, curr_cmd) && prev_cmd->UserCallback == NULL) { CmdBuffer.pop_back(); return; } curr_cmd->TextureId = _CmdHeader.TextureId; } void ImDrawList::_OnChangedVtxOffset() { // We don't need to compare curr_cmd->VtxOffset != _CmdHeader.VtxOffset because we know it'll be different at the time we call this. _VtxCurrentIdx = 0; IM_ASSERT_PARANOID(CmdBuffer.Size > 0); ImDrawCmd* curr_cmd = &CmdBuffer.Data[CmdBuffer.Size - 1]; //IM_ASSERT(curr_cmd->VtxOffset != _CmdHeader.VtxOffset); // See #3349 if (curr_cmd->ElemCount != 0) { AddDrawCmd(); return; } IM_ASSERT(curr_cmd->UserCallback == NULL); curr_cmd->VtxOffset = _CmdHeader.VtxOffset; } int ImDrawList::_CalcCircleAutoSegmentCount(float radius) const { // Automatic segment count const int radius_idx = (int)(radius + 0.999999f); // ceil to never reduce accuracy if (radius_idx >= 0 && radius_idx < IM_ARRAYSIZE(_Data->CircleSegmentCounts)) return _Data->CircleSegmentCounts[radius_idx]; // Use cached value else return IM_DRAWLIST_CIRCLE_AUTO_SEGMENT_CALC(radius, _Data->CircleSegmentMaxError); } // Render-level scissoring. This is passed down to your render function but not used for CPU-side coarse clipping. Prefer using higher-level ImGui::PushClipRect() to affect logic (hit-testing and widget culling) void ImDrawList::PushClipRect(const ImVec2& cr_min, const ImVec2& cr_max, bool intersect_with_current_clip_rect) { ImVec4 cr(cr_min.x, cr_min.y, cr_max.x, cr_max.y); if (intersect_with_current_clip_rect) { ImVec4 current = _CmdHeader.ClipRect; if (cr.x < current.x) cr.x = current.x; if (cr.y < current.y) cr.y = current.y; if (cr.z > current.z) cr.z = current.z; if (cr.w > current.w) cr.w = current.w; } cr.z = ImMax(cr.x, cr.z); cr.w = ImMax(cr.y, cr.w); _ClipRectStack.push_back(cr); _CmdHeader.ClipRect = cr; _OnChangedClipRect(); } void ImDrawList::PushClipRectFullScreen() { PushClipRect(ImVec2(_Data->ClipRectFullscreen.x, _Data->ClipRectFullscreen.y), ImVec2(_Data->ClipRectFullscreen.z, _Data->ClipRectFullscreen.w)); } void ImDrawList::PopClipRect() { _ClipRectStack.pop_back(); _CmdHeader.ClipRect = (_ClipRectStack.Size == 0) ? _Data->ClipRectFullscreen : _ClipRectStack.Data[_ClipRectStack.Size - 1]; _OnChangedClipRect(); } void ImDrawList::PushTextureID(ImTextureID texture_id) { _TextureIdStack.push_back(texture_id); _CmdHeader.TextureId = texture_id; _OnChangedTextureID(); } void ImDrawList::PopTextureID() { _TextureIdStack.pop_back(); _CmdHeader.TextureId = (_TextureIdStack.Size == 0) ? (ImTextureID)NULL : _TextureIdStack.Data[_TextureIdStack.Size - 1]; _OnChangedTextureID(); } // This is used by ImGui::PushFont()/PopFont(). It works because we never use _TextureIdStack[] elsewhere than in PushTextureID()/PopTextureID(). void ImDrawList::_SetTextureID(ImTextureID texture_id) { if (_CmdHeader.TextureId == texture_id) return; _CmdHeader.TextureId = texture_id; _OnChangedTextureID(); } // Reserve space for a number of vertices and indices. // You must finish filling your reserved data before calling PrimReserve() again, as it may reallocate or // submit the intermediate results. PrimUnreserve() can be used to release unused allocations. void ImDrawList::PrimReserve(int idx_count, int vtx_count) { // Large mesh support (when enabled) IM_ASSERT_PARANOID(idx_count >= 0 && vtx_count >= 0); if (sizeof(ImDrawIdx) == 2 && (_VtxCurrentIdx + vtx_count >= (1 << 16)) && (Flags & ImDrawListFlags_AllowVtxOffset)) { // FIXME: In theory we should be testing that vtx_count <64k here. // In practice, RenderText() relies on reserving ahead for a worst case scenario so it is currently useful for us // to not make that check until we rework the text functions to handle clipping and large horizontal lines better. _CmdHeader.VtxOffset = VtxBuffer.Size; _OnChangedVtxOffset(); } ImDrawCmd* draw_cmd = &CmdBuffer.Data[CmdBuffer.Size - 1]; draw_cmd->ElemCount += idx_count; int vtx_buffer_old_size = VtxBuffer.Size; VtxBuffer.resize(vtx_buffer_old_size + vtx_count); _VtxWritePtr = VtxBuffer.Data + vtx_buffer_old_size; int idx_buffer_old_size = IdxBuffer.Size; IdxBuffer.resize(idx_buffer_old_size + idx_count); _IdxWritePtr = IdxBuffer.Data + idx_buffer_old_size; } // Release the number of reserved vertices/indices from the end of the last reservation made with PrimReserve(). void ImDrawList::PrimUnreserve(int idx_count, int vtx_count) { IM_ASSERT_PARANOID(idx_count >= 0 && vtx_count >= 0); ImDrawCmd* draw_cmd = &CmdBuffer.Data[CmdBuffer.Size - 1]; draw_cmd->ElemCount -= idx_count; VtxBuffer.shrink(VtxBuffer.Size - vtx_count); IdxBuffer.shrink(IdxBuffer.Size - idx_count); } // Fully unrolled with inline call to keep our debug builds decently fast. void ImDrawList::PrimRect(const ImVec2& a, const ImVec2& c, ImU32 col) { ImVec2 b(c.x, a.y), d(a.x, c.y), uv(_Data->TexUvWhitePixel); ImDrawIdx idx = (ImDrawIdx)_VtxCurrentIdx; _IdxWritePtr[0] = idx; _IdxWritePtr[1] = (ImDrawIdx)(idx+1); _IdxWritePtr[2] = (ImDrawIdx)(idx+2); _IdxWritePtr[3] = idx; _IdxWritePtr[4] = (ImDrawIdx)(idx+2); _IdxWritePtr[5] = (ImDrawIdx)(idx+3); _VtxWritePtr[0].pos = a; _VtxWritePtr[0].uv = uv; _VtxWritePtr[0].col = col; _VtxWritePtr[1].pos = b; _VtxWritePtr[1].uv = uv; _VtxWritePtr[1].col = col; _VtxWritePtr[2].pos = c; _VtxWritePtr[2].uv = uv; _VtxWritePtr[2].col = col; _VtxWritePtr[3].pos = d; _VtxWritePtr[3].uv = uv; _VtxWritePtr[3].col = col; _VtxWritePtr += 4; _VtxCurrentIdx += 4; _IdxWritePtr += 6; } void ImDrawList::PrimRectUV(const ImVec2& a, const ImVec2& c, const ImVec2& uv_a, const ImVec2& uv_c, ImU32 col) { ImVec2 b(c.x, a.y), d(a.x, c.y), uv_b(uv_c.x, uv_a.y), uv_d(uv_a.x, uv_c.y); ImDrawIdx idx = (ImDrawIdx)_VtxCurrentIdx; _IdxWritePtr[0] = idx; _IdxWritePtr[1] = (ImDrawIdx)(idx+1); _IdxWritePtr[2] = (ImDrawIdx)(idx+2); _IdxWritePtr[3] = idx; _IdxWritePtr[4] = (ImDrawIdx)(idx+2); _IdxWritePtr[5] = (ImDrawIdx)(idx+3); _VtxWritePtr[0].pos = a; _VtxWritePtr[0].uv = uv_a; _VtxWritePtr[0].col = col; _VtxWritePtr[1].pos = b; _VtxWritePtr[1].uv = uv_b; _VtxWritePtr[1].col = col; _VtxWritePtr[2].pos = c; _VtxWritePtr[2].uv = uv_c; _VtxWritePtr[2].col = col; _VtxWritePtr[3].pos = d; _VtxWritePtr[3].uv = uv_d; _VtxWritePtr[3].col = col; _VtxWritePtr += 4; _VtxCurrentIdx += 4; _IdxWritePtr += 6; } void ImDrawList::PrimQuadUV(const ImVec2& a, const ImVec2& b, const ImVec2& c, const ImVec2& d, const ImVec2& uv_a, const ImVec2& uv_b, const ImVec2& uv_c, const ImVec2& uv_d, ImU32 col) { ImDrawIdx idx = (ImDrawIdx)_VtxCurrentIdx; _IdxWritePtr[0] = idx; _IdxWritePtr[1] = (ImDrawIdx)(idx+1); _IdxWritePtr[2] = (ImDrawIdx)(idx+2); _IdxWritePtr[3] = idx; _IdxWritePtr[4] = (ImDrawIdx)(idx+2); _IdxWritePtr[5] = (ImDrawIdx)(idx+3); _VtxWritePtr[0].pos = a; _VtxWritePtr[0].uv = uv_a; _VtxWritePtr[0].col = col; _VtxWritePtr[1].pos = b; _VtxWritePtr[1].uv = uv_b; _VtxWritePtr[1].col = col; _VtxWritePtr[2].pos = c; _VtxWritePtr[2].uv = uv_c; _VtxWritePtr[2].col = col; _VtxWritePtr[3].pos = d; _VtxWritePtr[3].uv = uv_d; _VtxWritePtr[3].col = col; _VtxWritePtr += 4; _VtxCurrentIdx += 4; _IdxWritePtr += 6; } // On AddPolyline() and AddConvexPolyFilled() we intentionally avoid using ImVec2 and superfluous function calls to optimize debug/non-inlined builds. // - Those macros expects l-values and need to be used as their own statement. // - Those macros are intentionally not surrounded by the 'do {} while (0)' idiom because even that translates to runtime with debug compilers. #define IM_NORMALIZE2F_OVER_ZERO(VX,VY) { float d2 = VX*VX + VY*VY; if (d2 > 0.0f) { float inv_len = ImRsqrt(d2); VX *= inv_len; VY *= inv_len; } } (void)0 #define IM_FIXNORMAL2F_MAX_INVLEN2 100.0f // 500.0f (see #4053, #3366) #define IM_FIXNORMAL2F(VX,VY) { float d2 = VX*VX + VY*VY; if (d2 > 0.000001f) { float inv_len2 = 1.0f / d2; if (inv_len2 > IM_FIXNORMAL2F_MAX_INVLEN2) inv_len2 = IM_FIXNORMAL2F_MAX_INVLEN2; VX *= inv_len2; VY *= inv_len2; } } (void)0 // TODO: Thickness anti-aliased lines cap are missing their AA fringe. // We avoid using the ImVec2 math operators here to reduce cost to a minimum for debug/non-inlined builds. void ImDrawList::AddPolyline(const ImVec2* points, const int points_count, ImU32 col, ImDrawFlags flags, float thickness) { if (points_count < 2 || (col & IM_COL32_A_MASK) == 0) return; const bool closed = (flags & ImDrawFlags_Closed) != 0; const ImVec2 opaque_uv = _Data->TexUvWhitePixel; const int count = closed ? points_count : points_count - 1; // The number of line segments we need to draw const bool thick_line = (thickness > _FringeScale); if (Flags & ImDrawListFlags_AntiAliasedLines) { // Anti-aliased stroke const float AA_SIZE = _FringeScale; const ImU32 col_trans = col & ~IM_COL32_A_MASK; // Thicknesses <1.0 should behave like thickness 1.0 thickness = ImMax(thickness, 1.0f); const int integer_thickness = (int)thickness; const float fractional_thickness = thickness - integer_thickness; // Do we want to draw this line using a texture? // - For now, only draw integer-width lines using textures to avoid issues with the way scaling occurs, could be improved. // - If AA_SIZE is not 1.0f we cannot use the texture path. const bool use_texture = (Flags & ImDrawListFlags_AntiAliasedLinesUseTex) && (integer_thickness < IM_DRAWLIST_TEX_LINES_WIDTH_MAX) && (fractional_thickness <= 0.00001f) && (AA_SIZE == 1.0f); // We should never hit this, because NewFrame() doesn't set ImDrawListFlags_AntiAliasedLinesUseTex unless ImFontAtlasFlags_NoBakedLines is off IM_ASSERT_PARANOID(!use_texture || !(_Data->Font->ContainerAtlas->Flags & ImFontAtlasFlags_NoBakedLines)); const int idx_count = use_texture ? (count * 6) : (thick_line ? count * 18 : count * 12); const int vtx_count = use_texture ? (points_count * 2) : (thick_line ? points_count * 4 : points_count * 3); PrimReserve(idx_count, vtx_count); // Temporary buffer // The first items are normals at each line point, then after that there are either 2 or 4 temp points for each line point _Data->TempBuffer.reserve_discard(points_count * ((use_texture || !thick_line) ? 3 : 5)); ImVec2* temp_normals = _Data->TempBuffer.Data; ImVec2* temp_points = temp_normals + points_count; // Calculate normals (tangents) for each line segment for (int i1 = 0; i1 < count; i1++) { const int i2 = (i1 + 1) == points_count ? 0 : i1 + 1; float dx = points[i2].x - points[i1].x; float dy = points[i2].y - points[i1].y; IM_NORMALIZE2F_OVER_ZERO(dx, dy); temp_normals[i1].x = dy; temp_normals[i1].y = -dx; } if (!closed) temp_normals[points_count - 1] = temp_normals[points_count - 2]; // If we are drawing a one-pixel-wide line without a texture, or a textured line of any width, we only need 2 or 3 vertices per point if (use_texture || !thick_line) { // [PATH 1] Texture-based lines (thick or non-thick) // [PATH 2] Non texture-based lines (non-thick) // The width of the geometry we need to draw - this is essentially pixels for the line itself, plus "one pixel" for AA. // - In the texture-based path, we don't use AA_SIZE here because the +1 is tied to the generated texture // (see ImFontAtlasBuildRenderLinesTexData() function), and so alternate values won't work without changes to that code. // - In the non texture-based paths, we would allow AA_SIZE to potentially be != 1.0f with a patch (e.g. fringe_scale patch to // allow scaling geometry while preserving one-screen-pixel AA fringe). const float half_draw_size = use_texture ? ((thickness * 0.5f) + 1) : AA_SIZE; // If line is not closed, the first and last points need to be generated differently as there are no normals to blend if (!closed) { temp_points[0] = points[0] + temp_normals[0] * half_draw_size; temp_points[1] = points[0] - temp_normals[0] * half_draw_size; temp_points[(points_count-1)*2+0] = points[points_count-1] + temp_normals[points_count-1] * half_draw_size; temp_points[(points_count-1)*2+1] = points[points_count-1] - temp_normals[points_count-1] * half_draw_size; } // Generate the indices to form a number of triangles for each line segment, and the vertices for the line edges // This takes points n and n+1 and writes into n+1, with the first point in a closed line being generated from the final one (as n+1 wraps) // FIXME-OPT: Merge the different loops, possibly remove the temporary buffer. unsigned int idx1 = _VtxCurrentIdx; // Vertex index for start of line segment for (int i1 = 0; i1 < count; i1++) // i1 is the first point of the line segment { const int i2 = (i1 + 1) == points_count ? 0 : i1 + 1; // i2 is the second point of the line segment const unsigned int idx2 = ((i1 + 1) == points_count) ? _VtxCurrentIdx : (idx1 + (use_texture ? 2 : 3)); // Vertex index for end of segment // Average normals float dm_x = (temp_normals[i1].x + temp_normals[i2].x) * 0.5f; float dm_y = (temp_normals[i1].y + temp_normals[i2].y) * 0.5f; IM_FIXNORMAL2F(dm_x, dm_y); dm_x *= half_draw_size; // dm_x, dm_y are offset to the outer edge of the AA area dm_y *= half_draw_size; // Add temporary vertexes for the outer edges ImVec2* out_vtx = &temp_points[i2 * 2]; out_vtx[0].x = points[i2].x + dm_x; out_vtx[0].y = points[i2].y + dm_y; out_vtx[1].x = points[i2].x - dm_x; out_vtx[1].y = points[i2].y - dm_y; if (use_texture) { // Add indices for two triangles _IdxWritePtr[0] = (ImDrawIdx)(idx2 + 0); _IdxWritePtr[1] = (ImDrawIdx)(idx1 + 0); _IdxWritePtr[2] = (ImDrawIdx)(idx1 + 1); // Right tri _IdxWritePtr[3] = (ImDrawIdx)(idx2 + 1); _IdxWritePtr[4] = (ImDrawIdx)(idx1 + 1); _IdxWritePtr[5] = (ImDrawIdx)(idx2 + 0); // Left tri _IdxWritePtr += 6; } else { // Add indexes for four triangles _IdxWritePtr[0] = (ImDrawIdx)(idx2 + 0); _IdxWritePtr[1] = (ImDrawIdx)(idx1 + 0); _IdxWritePtr[2] = (ImDrawIdx)(idx1 + 2); // Right tri 1 _IdxWritePtr[3] = (ImDrawIdx)(idx1 + 2); _IdxWritePtr[4] = (ImDrawIdx)(idx2 + 2); _IdxWritePtr[5] = (ImDrawIdx)(idx2 + 0); // Right tri 2 _IdxWritePtr[6] = (ImDrawIdx)(idx2 + 1); _IdxWritePtr[7] = (ImDrawIdx)(idx1 + 1); _IdxWritePtr[8] = (ImDrawIdx)(idx1 + 0); // Left tri 1 _IdxWritePtr[9] = (ImDrawIdx)(idx1 + 0); _IdxWritePtr[10] = (ImDrawIdx)(idx2 + 0); _IdxWritePtr[11] = (ImDrawIdx)(idx2 + 1); // Left tri 2 _IdxWritePtr += 12; } idx1 = idx2; } // Add vertexes for each point on the line if (use_texture) { // If we're using textures we only need to emit the left/right edge vertices ImVec4 tex_uvs = _Data->TexUvLines[integer_thickness]; /*if (fractional_thickness != 0.0f) // Currently always zero when use_texture==false! { const ImVec4 tex_uvs_1 = _Data->TexUvLines[integer_thickness + 1]; tex_uvs.x = tex_uvs.x + (tex_uvs_1.x - tex_uvs.x) * fractional_thickness; // inlined ImLerp() tex_uvs.y = tex_uvs.y + (tex_uvs_1.y - tex_uvs.y) * fractional_thickness; tex_uvs.z = tex_uvs.z + (tex_uvs_1.z - tex_uvs.z) * fractional_thickness; tex_uvs.w = tex_uvs.w + (tex_uvs_1.w - tex_uvs.w) * fractional_thickness; }*/ ImVec2 tex_uv0(tex_uvs.x, tex_uvs.y); ImVec2 tex_uv1(tex_uvs.z, tex_uvs.w); for (int i = 0; i < points_count; i++) { _VtxWritePtr[0].pos = temp_points[i * 2 + 0]; _VtxWritePtr[0].uv = tex_uv0; _VtxWritePtr[0].col = col; // Left-side outer edge _VtxWritePtr[1].pos = temp_points[i * 2 + 1]; _VtxWritePtr[1].uv = tex_uv1; _VtxWritePtr[1].col = col; // Right-side outer edge _VtxWritePtr += 2; } } else { // If we're not using a texture, we need the center vertex as well for (int i = 0; i < points_count; i++) { _VtxWritePtr[0].pos = points[i]; _VtxWritePtr[0].uv = opaque_uv; _VtxWritePtr[0].col = col; // Center of line _VtxWritePtr[1].pos = temp_points[i * 2 + 0]; _VtxWritePtr[1].uv = opaque_uv; _VtxWritePtr[1].col = col_trans; // Left-side outer edge _VtxWritePtr[2].pos = temp_points[i * 2 + 1]; _VtxWritePtr[2].uv = opaque_uv; _VtxWritePtr[2].col = col_trans; // Right-side outer edge _VtxWritePtr += 3; } } } else { // [PATH 2] Non texture-based lines (thick): we need to draw the solid line core and thus require four vertices per point const float half_inner_thickness = (thickness - AA_SIZE) * 0.5f; // If line is not closed, the first and last points need to be generated differently as there are no normals to blend if (!closed) { const int points_last = points_count - 1; temp_points[0] = points[0] + temp_normals[0] * (half_inner_thickness + AA_SIZE); temp_points[1] = points[0] + temp_normals[0] * (half_inner_thickness); temp_points[2] = points[0] - temp_normals[0] * (half_inner_thickness); temp_points[3] = points[0] - temp_normals[0] * (half_inner_thickness + AA_SIZE); temp_points[points_last * 4 + 0] = points[points_last] + temp_normals[points_last] * (half_inner_thickness + AA_SIZE); temp_points[points_last * 4 + 1] = points[points_last] + temp_normals[points_last] * (half_inner_thickness); temp_points[points_last * 4 + 2] = points[points_last] - temp_normals[points_last] * (half_inner_thickness); temp_points[points_last * 4 + 3] = points[points_last] - temp_normals[points_last] * (half_inner_thickness + AA_SIZE); } // Generate the indices to form a number of triangles for each line segment, and the vertices for the line edges // This takes points n and n+1 and writes into n+1, with the first point in a closed line being generated from the final one (as n+1 wraps) // FIXME-OPT: Merge the different loops, possibly remove the temporary buffer. unsigned int idx1 = _VtxCurrentIdx; // Vertex index for start of line segment for (int i1 = 0; i1 < count; i1++) // i1 is the first point of the line segment { const int i2 = (i1 + 1) == points_count ? 0 : (i1 + 1); // i2 is the second point of the line segment const unsigned int idx2 = (i1 + 1) == points_count ? _VtxCurrentIdx : (idx1 + 4); // Vertex index for end of segment // Average normals float dm_x = (temp_normals[i1].x + temp_normals[i2].x) * 0.5f; float dm_y = (temp_normals[i1].y + temp_normals[i2].y) * 0.5f; IM_FIXNORMAL2F(dm_x, dm_y); float dm_out_x = dm_x * (half_inner_thickness + AA_SIZE); float dm_out_y = dm_y * (half_inner_thickness + AA_SIZE); float dm_in_x = dm_x * half_inner_thickness; float dm_in_y = dm_y * half_inner_thickness; // Add temporary vertices ImVec2* out_vtx = &temp_points[i2 * 4]; out_vtx[0].x = points[i2].x + dm_out_x; out_vtx[0].y = points[i2].y + dm_out_y; out_vtx[1].x = points[i2].x + dm_in_x; out_vtx[1].y = points[i2].y + dm_in_y; out_vtx[2].x = points[i2].x - dm_in_x; out_vtx[2].y = points[i2].y - dm_in_y; out_vtx[3].x = points[i2].x - dm_out_x; out_vtx[3].y = points[i2].y - dm_out_y; // Add indexes _IdxWritePtr[0] = (ImDrawIdx)(idx2 + 1); _IdxWritePtr[1] = (ImDrawIdx)(idx1 + 1); _IdxWritePtr[2] = (ImDrawIdx)(idx1 + 2); _IdxWritePtr[3] = (ImDrawIdx)(idx1 + 2); _IdxWritePtr[4] = (ImDrawIdx)(idx2 + 2); _IdxWritePtr[5] = (ImDrawIdx)(idx2 + 1); _IdxWritePtr[6] = (ImDrawIdx)(idx2 + 1); _IdxWritePtr[7] = (ImDrawIdx)(idx1 + 1); _IdxWritePtr[8] = (ImDrawIdx)(idx1 + 0); _IdxWritePtr[9] = (ImDrawIdx)(idx1 + 0); _IdxWritePtr[10] = (ImDrawIdx)(idx2 + 0); _IdxWritePtr[11] = (ImDrawIdx)(idx2 + 1); _IdxWritePtr[12] = (ImDrawIdx)(idx2 + 2); _IdxWritePtr[13] = (ImDrawIdx)(idx1 + 2); _IdxWritePtr[14] = (ImDrawIdx)(idx1 + 3); _IdxWritePtr[15] = (ImDrawIdx)(idx1 + 3); _IdxWritePtr[16] = (ImDrawIdx)(idx2 + 3); _IdxWritePtr[17] = (ImDrawIdx)(idx2 + 2); _IdxWritePtr += 18; idx1 = idx2; } // Add vertices for (int i = 0; i < points_count; i++) { _VtxWritePtr[0].pos = temp_points[i * 4 + 0]; _VtxWritePtr[0].uv = opaque_uv; _VtxWritePtr[0].col = col_trans; _VtxWritePtr[1].pos = temp_points[i * 4 + 1]; _VtxWritePtr[1].uv = opaque_uv; _VtxWritePtr[1].col = col; _VtxWritePtr[2].pos = temp_points[i * 4 + 2]; _VtxWritePtr[2].uv = opaque_uv; _VtxWritePtr[2].col = col; _VtxWritePtr[3].pos = temp_points[i * 4 + 3]; _VtxWritePtr[3].uv = opaque_uv; _VtxWritePtr[3].col = col_trans; _VtxWritePtr += 4; } } _VtxCurrentIdx += (ImDrawIdx)vtx_count; } else { // [PATH 4] Non texture-based, Non anti-aliased lines const int idx_count = count * 6; const int vtx_count = count * 4; // FIXME-OPT: Not sharing edges PrimReserve(idx_count, vtx_count); for (int i1 = 0; i1 < count; i1++) { const int i2 = (i1 + 1) == points_count ? 0 : i1 + 1; const ImVec2& p1 = points[i1]; const ImVec2& p2 = points[i2]; float dx = p2.x - p1.x; float dy = p2.y - p1.y; IM_NORMALIZE2F_OVER_ZERO(dx, dy); dx *= (thickness * 0.5f); dy *= (thickness * 0.5f); _VtxWritePtr[0].pos.x = p1.x + dy; _VtxWritePtr[0].pos.y = p1.y - dx; _VtxWritePtr[0].uv = opaque_uv; _VtxWritePtr[0].col = col; _VtxWritePtr[1].pos.x = p2.x + dy; _VtxWritePtr[1].pos.y = p2.y - dx; _VtxWritePtr[1].uv = opaque_uv; _VtxWritePtr[1].col = col; _VtxWritePtr[2].pos.x = p2.x - dy; _VtxWritePtr[2].pos.y = p2.y + dx; _VtxWritePtr[2].uv = opaque_uv; _VtxWritePtr[2].col = col; _VtxWritePtr[3].pos.x = p1.x - dy; _VtxWritePtr[3].pos.y = p1.y + dx; _VtxWritePtr[3].uv = opaque_uv; _VtxWritePtr[3].col = col; _VtxWritePtr += 4; _IdxWritePtr[0] = (ImDrawIdx)(_VtxCurrentIdx); _IdxWritePtr[1] = (ImDrawIdx)(_VtxCurrentIdx + 1); _IdxWritePtr[2] = (ImDrawIdx)(_VtxCurrentIdx + 2); _IdxWritePtr[3] = (ImDrawIdx)(_VtxCurrentIdx); _IdxWritePtr[4] = (ImDrawIdx)(_VtxCurrentIdx + 2); _IdxWritePtr[5] = (ImDrawIdx)(_VtxCurrentIdx + 3); _IdxWritePtr += 6; _VtxCurrentIdx += 4; } } } // - We intentionally avoid using ImVec2 and its math operators here to reduce cost to a minimum for debug/non-inlined builds. // - Filled shapes must always use clockwise winding order. The anti-aliasing fringe depends on it. Counter-clockwise shapes will have "inward" anti-aliasing. void ImDrawList::AddConvexPolyFilled(const ImVec2* points, const int points_count, ImU32 col) { if (points_count < 3 || (col & IM_COL32_A_MASK) == 0) return; const ImVec2 uv = _Data->TexUvWhitePixel; if (Flags & ImDrawListFlags_AntiAliasedFill) { // Anti-aliased Fill const float AA_SIZE = _FringeScale; const ImU32 col_trans = col & ~IM_COL32_A_MASK; const int idx_count = (points_count - 2)*3 + points_count * 6; const int vtx_count = (points_count * 2); PrimReserve(idx_count, vtx_count); // Add indexes for fill unsigned int vtx_inner_idx = _VtxCurrentIdx; unsigned int vtx_outer_idx = _VtxCurrentIdx + 1; for (int i = 2; i < points_count; i++) { _IdxWritePtr[0] = (ImDrawIdx)(vtx_inner_idx); _IdxWritePtr[1] = (ImDrawIdx)(vtx_inner_idx + ((i - 1) << 1)); _IdxWritePtr[2] = (ImDrawIdx)(vtx_inner_idx + (i << 1)); _IdxWritePtr += 3; } // Compute normals _Data->TempBuffer.reserve_discard(points_count); ImVec2* temp_normals = _Data->TempBuffer.Data; for (int i0 = points_count - 1, i1 = 0; i1 < points_count; i0 = i1++) { const ImVec2& p0 = points[i0]; const ImVec2& p1 = points[i1]; float dx = p1.x - p0.x; float dy = p1.y - p0.y; IM_NORMALIZE2F_OVER_ZERO(dx, dy); temp_normals[i0].x = dy; temp_normals[i0].y = -dx; } for (int i0 = points_count - 1, i1 = 0; i1 < points_count; i0 = i1++) { // Average normals const ImVec2& n0 = temp_normals[i0]; const ImVec2& n1 = temp_normals[i1]; float dm_x = (n0.x + n1.x) * 0.5f; float dm_y = (n0.y + n1.y) * 0.5f; IM_FIXNORMAL2F(dm_x, dm_y); dm_x *= AA_SIZE * 0.5f; dm_y *= AA_SIZE * 0.5f; // Add vertices _VtxWritePtr[0].pos.x = (points[i1].x - dm_x); _VtxWritePtr[0].pos.y = (points[i1].y - dm_y); _VtxWritePtr[0].uv = uv; _VtxWritePtr[0].col = col; // Inner _VtxWritePtr[1].pos.x = (points[i1].x + dm_x); _VtxWritePtr[1].pos.y = (points[i1].y + dm_y); _VtxWritePtr[1].uv = uv; _VtxWritePtr[1].col = col_trans; // Outer _VtxWritePtr += 2; // Add indexes for fringes _IdxWritePtr[0] = (ImDrawIdx)(vtx_inner_idx + (i1 << 1)); _IdxWritePtr[1] = (ImDrawIdx)(vtx_inner_idx + (i0 << 1)); _IdxWritePtr[2] = (ImDrawIdx)(vtx_outer_idx + (i0 << 1)); _IdxWritePtr[3] = (ImDrawIdx)(vtx_outer_idx + (i0 << 1)); _IdxWritePtr[4] = (ImDrawIdx)(vtx_outer_idx + (i1 << 1)); _IdxWritePtr[5] = (ImDrawIdx)(vtx_inner_idx + (i1 << 1)); _IdxWritePtr += 6; } _VtxCurrentIdx += (ImDrawIdx)vtx_count; } else { // Non Anti-aliased Fill const int idx_count = (points_count - 2)*3; const int vtx_count = points_count; PrimReserve(idx_count, vtx_count); for (int i = 0; i < vtx_count; i++) { _VtxWritePtr[0].pos = points[i]; _VtxWritePtr[0].uv = uv; _VtxWritePtr[0].col = col; _VtxWritePtr++; } for (int i = 2; i < points_count; i++) { _IdxWritePtr[0] = (ImDrawIdx)(_VtxCurrentIdx); _IdxWritePtr[1] = (ImDrawIdx)(_VtxCurrentIdx + i - 1); _IdxWritePtr[2] = (ImDrawIdx)(_VtxCurrentIdx + i); _IdxWritePtr += 3; } _VtxCurrentIdx += (ImDrawIdx)vtx_count; } } void ImDrawList::_PathArcToFastEx(const ImVec2& center, float radius, int a_min_sample, int a_max_sample, int a_step) { if (radius < 0.5f) { _Path.push_back(center); return; } // Calculate arc auto segment step size if (a_step <= 0) a_step = IM_DRAWLIST_ARCFAST_SAMPLE_MAX / _CalcCircleAutoSegmentCount(radius); // Make sure we never do steps larger than one quarter of the circle a_step = ImClamp(a_step, 1, IM_DRAWLIST_ARCFAST_TABLE_SIZE / 4); const int sample_range = ImAbs(a_max_sample - a_min_sample); const int a_next_step = a_step; int samples = sample_range + 1; bool extra_max_sample = false; if (a_step > 1) { samples = sample_range / a_step + 1; const int overstep = sample_range % a_step; if (overstep > 0) { extra_max_sample = true; samples++; // When we have overstep to avoid awkwardly looking one long line and one tiny one at the end, // distribute first step range evenly between them by reducing first step size. if (sample_range > 0) a_step -= (a_step - overstep) / 2; } } _Path.resize(_Path.Size + samples); ImVec2* out_ptr = _Path.Data + (_Path.Size - samples); int sample_index = a_min_sample; if (sample_index < 0 || sample_index >= IM_DRAWLIST_ARCFAST_SAMPLE_MAX) { sample_index = sample_index % IM_DRAWLIST_ARCFAST_SAMPLE_MAX; if (sample_index < 0) sample_index += IM_DRAWLIST_ARCFAST_SAMPLE_MAX; } if (a_max_sample >= a_min_sample) { for (int a = a_min_sample; a <= a_max_sample; a += a_step, sample_index += a_step, a_step = a_next_step) { // a_step is clamped to IM_DRAWLIST_ARCFAST_SAMPLE_MAX, so we have guaranteed that it will not wrap over range twice or more if (sample_index >= IM_DRAWLIST_ARCFAST_SAMPLE_MAX) sample_index -= IM_DRAWLIST_ARCFAST_SAMPLE_MAX; const ImVec2 s = _Data->ArcFastVtx[sample_index]; out_ptr->x = center.x + s.x * radius; out_ptr->y = center.y + s.y * radius; out_ptr++; } } else { for (int a = a_min_sample; a >= a_max_sample; a -= a_step, sample_index -= a_step, a_step = a_next_step) { // a_step is clamped to IM_DRAWLIST_ARCFAST_SAMPLE_MAX, so we have guaranteed that it will not wrap over range twice or more if (sample_index < 0) sample_index += IM_DRAWLIST_ARCFAST_SAMPLE_MAX; const ImVec2 s = _Data->ArcFastVtx[sample_index]; out_ptr->x = center.x + s.x * radius; out_ptr->y = center.y + s.y * radius; out_ptr++; } } if (extra_max_sample) { int normalized_max_sample = a_max_sample % IM_DRAWLIST_ARCFAST_SAMPLE_MAX; if (normalized_max_sample < 0) normalized_max_sample += IM_DRAWLIST_ARCFAST_SAMPLE_MAX; const ImVec2 s = _Data->ArcFastVtx[normalized_max_sample]; out_ptr->x = center.x + s.x * radius; out_ptr->y = center.y + s.y * radius; out_ptr++; } IM_ASSERT_PARANOID(_Path.Data + _Path.Size == out_ptr); } void ImDrawList::_PathArcToN(const ImVec2& center, float radius, float a_min, float a_max, int num_segments) { if (radius < 0.5f) { _Path.push_back(center); return; } // Note that we are adding a point at both a_min and a_max. // If you are trying to draw a full closed circle you don't want the overlapping points! _Path.reserve(_Path.Size + (num_segments + 1)); for (int i = 0; i <= num_segments; i++) { const float a = a_min + ((float)i / (float)num_segments) * (a_max - a_min); _Path.push_back(ImVec2(center.x + ImCos(a) * radius, center.y + ImSin(a) * radius)); } } // 0: East, 3: South, 6: West, 9: North, 12: East void ImDrawList::PathArcToFast(const ImVec2& center, float radius, int a_min_of_12, int a_max_of_12) { if (radius < 0.5f) { _Path.push_back(center); return; } _PathArcToFastEx(center, radius, a_min_of_12 * IM_DRAWLIST_ARCFAST_SAMPLE_MAX / 12, a_max_of_12 * IM_DRAWLIST_ARCFAST_SAMPLE_MAX / 12, 0); } void ImDrawList::PathArcTo(const ImVec2& center, float radius, float a_min, float a_max, int num_segments) { if (radius < 0.5f) { _Path.push_back(center); return; } if (num_segments > 0) { _PathArcToN(center, radius, a_min, a_max, num_segments); return; } // Automatic segment count if (radius <= _Data->ArcFastRadiusCutoff) { const bool a_is_reverse = a_max < a_min; // We are going to use precomputed values for mid samples. // Determine first and last sample in lookup table that belong to the arc. const float a_min_sample_f = IM_DRAWLIST_ARCFAST_SAMPLE_MAX * a_min / (IM_PI * 2.0f); const float a_max_sample_f = IM_DRAWLIST_ARCFAST_SAMPLE_MAX * a_max / (IM_PI * 2.0f); const int a_min_sample = a_is_reverse ? (int)ImFloor(a_min_sample_f) : (int)ImCeil(a_min_sample_f); const int a_max_sample = a_is_reverse ? (int)ImCeil(a_max_sample_f) : (int)ImFloor(a_max_sample_f); const int a_mid_samples = a_is_reverse ? ImMax(a_min_sample - a_max_sample, 0) : ImMax(a_max_sample - a_min_sample, 0); const float a_min_segment_angle = a_min_sample * IM_PI * 2.0f / IM_DRAWLIST_ARCFAST_SAMPLE_MAX; const float a_max_segment_angle = a_max_sample * IM_PI * 2.0f / IM_DRAWLIST_ARCFAST_SAMPLE_MAX; const bool a_emit_start = ImAbs(a_min_segment_angle - a_min) >= 1e-5f; const bool a_emit_end = ImAbs(a_max - a_max_segment_angle) >= 1e-5f; _Path.reserve(_Path.Size + (a_mid_samples + 1 + (a_emit_start ? 1 : 0) + (a_emit_end ? 1 : 0))); if (a_emit_start) _Path.push_back(ImVec2(center.x + ImCos(a_min) * radius, center.y + ImSin(a_min) * radius)); if (a_mid_samples > 0) _PathArcToFastEx(center, radius, a_min_sample, a_max_sample, 0); if (a_emit_end) _Path.push_back(ImVec2(center.x + ImCos(a_max) * radius, center.y + ImSin(a_max) * radius)); } else { const float arc_length = ImAbs(a_max - a_min); const int circle_segment_count = _CalcCircleAutoSegmentCount(radius); const int arc_segment_count = ImMax((int)ImCeil(circle_segment_count * arc_length / (IM_PI * 2.0f)), (int)(2.0f * IM_PI / arc_length)); _PathArcToN(center, radius, a_min, a_max, arc_segment_count); } } void ImDrawList::PathEllipticalArcTo(const ImVec2& center, const ImVec2& radius, float rot, float a_min, float a_max, int num_segments) { if (num_segments <= 0) num_segments = _CalcCircleAutoSegmentCount(ImMax(radius.x, radius.y)); // A bit pessimistic, maybe there's a better computation to do here. _Path.reserve(_Path.Size + (num_segments + 1)); const float cos_rot = ImCos(rot); const float sin_rot = ImSin(rot); for (int i = 0; i <= num_segments; i++) { const float a = a_min + ((float)i / (float)num_segments) * (a_max - a_min); ImVec2 point(ImCos(a) * radius.x, ImSin(a) * radius.y); const ImVec2 rel((point.x * cos_rot) - (point.y * sin_rot), (point.x * sin_rot) + (point.y * cos_rot)); point.x = rel.x + center.x; point.y = rel.y + center.y; _Path.push_back(point); } } ImVec2 ImBezierCubicCalc(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, float t) { float u = 1.0f - t; float w1 = u * u * u; float w2 = 3 * u * u * t; float w3 = 3 * u * t * t; float w4 = t * t * t; return ImVec2(w1 * p1.x + w2 * p2.x + w3 * p3.x + w4 * p4.x, w1 * p1.y + w2 * p2.y + w3 * p3.y + w4 * p4.y); } ImVec2 ImBezierQuadraticCalc(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, float t) { float u = 1.0f - t; float w1 = u * u; float w2 = 2 * u * t; float w3 = t * t; return ImVec2(w1 * p1.x + w2 * p2.x + w3 * p3.x, w1 * p1.y + w2 * p2.y + w3 * p3.y); } // Closely mimics ImBezierCubicClosestPointCasteljau() in imgui.cpp static void PathBezierCubicCurveToCasteljau(ImVector* path, float x1, float y1, float x2, float y2, float x3, float y3, float x4, float y4, float tess_tol, int level) { float dx = x4 - x1; float dy = y4 - y1; float d2 = (x2 - x4) * dy - (y2 - y4) * dx; float d3 = (x3 - x4) * dy - (y3 - y4) * dx; d2 = (d2 >= 0) ? d2 : -d2; d3 = (d3 >= 0) ? d3 : -d3; if ((d2 + d3) * (d2 + d3) < tess_tol * (dx * dx + dy * dy)) { path->push_back(ImVec2(x4, y4)); } else if (level < 10) { float x12 = (x1 + x2) * 0.5f, y12 = (y1 + y2) * 0.5f; float x23 = (x2 + x3) * 0.5f, y23 = (y2 + y3) * 0.5f; float x34 = (x3 + x4) * 0.5f, y34 = (y3 + y4) * 0.5f; float x123 = (x12 + x23) * 0.5f, y123 = (y12 + y23) * 0.5f; float x234 = (x23 + x34) * 0.5f, y234 = (y23 + y34) * 0.5f; float x1234 = (x123 + x234) * 0.5f, y1234 = (y123 + y234) * 0.5f; PathBezierCubicCurveToCasteljau(path, x1, y1, x12, y12, x123, y123, x1234, y1234, tess_tol, level + 1); PathBezierCubicCurveToCasteljau(path, x1234, y1234, x234, y234, x34, y34, x4, y4, tess_tol, level + 1); } } static void PathBezierQuadraticCurveToCasteljau(ImVector* path, float x1, float y1, float x2, float y2, float x3, float y3, float tess_tol, int level) { float dx = x3 - x1, dy = y3 - y1; float det = (x2 - x3) * dy - (y2 - y3) * dx; if (det * det * 4.0f < tess_tol * (dx * dx + dy * dy)) { path->push_back(ImVec2(x3, y3)); } else if (level < 10) { float x12 = (x1 + x2) * 0.5f, y12 = (y1 + y2) * 0.5f; float x23 = (x2 + x3) * 0.5f, y23 = (y2 + y3) * 0.5f; float x123 = (x12 + x23) * 0.5f, y123 = (y12 + y23) * 0.5f; PathBezierQuadraticCurveToCasteljau(path, x1, y1, x12, y12, x123, y123, tess_tol, level + 1); PathBezierQuadraticCurveToCasteljau(path, x123, y123, x23, y23, x3, y3, tess_tol, level + 1); } } void ImDrawList::PathBezierCubicCurveTo(const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, int num_segments) { ImVec2 p1 = _Path.back(); if (num_segments == 0) { IM_ASSERT(_Data->CurveTessellationTol > 0.0f); PathBezierCubicCurveToCasteljau(&_Path, p1.x, p1.y, p2.x, p2.y, p3.x, p3.y, p4.x, p4.y, _Data->CurveTessellationTol, 0); // Auto-tessellated } else { float t_step = 1.0f / (float)num_segments; for (int i_step = 1; i_step <= num_segments; i_step++) _Path.push_back(ImBezierCubicCalc(p1, p2, p3, p4, t_step * i_step)); } } void ImDrawList::PathBezierQuadraticCurveTo(const ImVec2& p2, const ImVec2& p3, int num_segments) { ImVec2 p1 = _Path.back(); if (num_segments == 0) { IM_ASSERT(_Data->CurveTessellationTol > 0.0f); PathBezierQuadraticCurveToCasteljau(&_Path, p1.x, p1.y, p2.x, p2.y, p3.x, p3.y, _Data->CurveTessellationTol, 0);// Auto-tessellated } else { float t_step = 1.0f / (float)num_segments; for (int i_step = 1; i_step <= num_segments; i_step++) _Path.push_back(ImBezierQuadraticCalc(p1, p2, p3, t_step * i_step)); } } static inline ImDrawFlags FixRectCornerFlags(ImDrawFlags flags) { /* IM_STATIC_ASSERT(ImDrawFlags_RoundCornersTopLeft == (1 << 4)); #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS // Obsoleted in 1.82 (from February 2021). This code was stripped/simplified and mostly commented in 1.90 (from September 2023) // - Legacy Support for hard coded ~0 (used to be a suggested equivalent to ImDrawCornerFlags_All) if (flags == ~0) { return ImDrawFlags_RoundCornersAll; } // - Legacy Support for hard coded 0x01 to 0x0F (matching 15 out of 16 old flags combinations). Read details in older version of this code. if (flags >= 0x01 && flags <= 0x0F) { return (flags << 4); } // We cannot support hard coded 0x00 with 'float rounding > 0.0f' --> replace with ImDrawFlags_RoundCornersNone or use 'float rounding = 0.0f' #endif */ // If this assert triggers, please update your code replacing hardcoded values with new ImDrawFlags_RoundCorners* values. // Note that ImDrawFlags_Closed (== 0x01) is an invalid flag for AddRect(), AddRectFilled(), PathRect() etc. anyway. // See details in 1.82 Changelog as well as 2021/03/12 and 2023/09/08 entries in "API BREAKING CHANGES" section. IM_ASSERT((flags & 0x0F) == 0 && "Misuse of legacy hardcoded ImDrawCornerFlags values!"); if ((flags & ImDrawFlags_RoundCornersMask_) == 0) flags |= ImDrawFlags_RoundCornersAll; return flags; } void ImDrawList::PathRect(const ImVec2& a, const ImVec2& b, float rounding, ImDrawFlags flags) { if (rounding >= 0.5f) { flags = FixRectCornerFlags(flags); rounding = ImMin(rounding, ImFabs(b.x - a.x) * (((flags & ImDrawFlags_RoundCornersTop) == ImDrawFlags_RoundCornersTop) || ((flags & ImDrawFlags_RoundCornersBottom) == ImDrawFlags_RoundCornersBottom) ? 0.5f : 1.0f) - 1.0f); rounding = ImMin(rounding, ImFabs(b.y - a.y) * (((flags & ImDrawFlags_RoundCornersLeft) == ImDrawFlags_RoundCornersLeft) || ((flags & ImDrawFlags_RoundCornersRight) == ImDrawFlags_RoundCornersRight) ? 0.5f : 1.0f) - 1.0f); } if (rounding < 0.5f || (flags & ImDrawFlags_RoundCornersMask_) == ImDrawFlags_RoundCornersNone) { PathLineTo(a); PathLineTo(ImVec2(b.x, a.y)); PathLineTo(b); PathLineTo(ImVec2(a.x, b.y)); } else { const float rounding_tl = (flags & ImDrawFlags_RoundCornersTopLeft) ? rounding : 0.0f; const float rounding_tr = (flags & ImDrawFlags_RoundCornersTopRight) ? rounding : 0.0f; const float rounding_br = (flags & ImDrawFlags_RoundCornersBottomRight) ? rounding : 0.0f; const float rounding_bl = (flags & ImDrawFlags_RoundCornersBottomLeft) ? rounding : 0.0f; PathArcToFast(ImVec2(a.x + rounding_tl, a.y + rounding_tl), rounding_tl, 6, 9); PathArcToFast(ImVec2(b.x - rounding_tr, a.y + rounding_tr), rounding_tr, 9, 12); PathArcToFast(ImVec2(b.x - rounding_br, b.y - rounding_br), rounding_br, 0, 3); PathArcToFast(ImVec2(a.x + rounding_bl, b.y - rounding_bl), rounding_bl, 3, 6); } } void ImDrawList::AddLine(const ImVec2& p1, const ImVec2& p2, ImU32 col, float thickness) { if ((col & IM_COL32_A_MASK) == 0) return; PathLineTo(p1 + ImVec2(0.5f, 0.5f)); PathLineTo(p2 + ImVec2(0.5f, 0.5f)); PathStroke(col, 0, thickness); } // p_min = upper-left, p_max = lower-right // Note we don't render 1 pixels sized rectangles properly. void ImDrawList::AddRect(const ImVec2& p_min, const ImVec2& p_max, ImU32 col, float rounding, ImDrawFlags flags, float thickness) { if ((col & IM_COL32_A_MASK) == 0) return; if (Flags & ImDrawListFlags_AntiAliasedLines) PathRect(p_min + ImVec2(0.50f, 0.50f), p_max - ImVec2(0.50f, 0.50f), rounding, flags); else PathRect(p_min + ImVec2(0.50f, 0.50f), p_max - ImVec2(0.49f, 0.49f), rounding, flags); // Better looking lower-right corner and rounded non-AA shapes. PathStroke(col, ImDrawFlags_Closed, thickness); } void ImDrawList::AddRectFilled(const ImVec2& p_min, const ImVec2& p_max, ImU32 col, float rounding, ImDrawFlags flags) { if ((col & IM_COL32_A_MASK) == 0) return; if (rounding < 0.5f || (flags & ImDrawFlags_RoundCornersMask_) == ImDrawFlags_RoundCornersNone) { PrimReserve(6, 4); PrimRect(p_min, p_max, col); } else { PathRect(p_min, p_max, rounding, flags); PathFillConvex(col); } } // p_min = upper-left, p_max = lower-right void ImDrawList::AddRectFilledMultiColor(const ImVec2& p_min, const ImVec2& p_max, ImU32 col_upr_left, ImU32 col_upr_right, ImU32 col_bot_right, ImU32 col_bot_left) { if (((col_upr_left | col_upr_right | col_bot_right | col_bot_left) & IM_COL32_A_MASK) == 0) return; const ImVec2 uv = _Data->TexUvWhitePixel; PrimReserve(6, 4); PrimWriteIdx((ImDrawIdx)(_VtxCurrentIdx)); PrimWriteIdx((ImDrawIdx)(_VtxCurrentIdx + 1)); PrimWriteIdx((ImDrawIdx)(_VtxCurrentIdx + 2)); PrimWriteIdx((ImDrawIdx)(_VtxCurrentIdx)); PrimWriteIdx((ImDrawIdx)(_VtxCurrentIdx + 2)); PrimWriteIdx((ImDrawIdx)(_VtxCurrentIdx + 3)); PrimWriteVtx(p_min, uv, col_upr_left); PrimWriteVtx(ImVec2(p_max.x, p_min.y), uv, col_upr_right); PrimWriteVtx(p_max, uv, col_bot_right); PrimWriteVtx(ImVec2(p_min.x, p_max.y), uv, col_bot_left); } void ImDrawList::AddQuad(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, ImU32 col, float thickness) { if ((col & IM_COL32_A_MASK) == 0) return; PathLineTo(p1); PathLineTo(p2); PathLineTo(p3); PathLineTo(p4); PathStroke(col, ImDrawFlags_Closed, thickness); } void ImDrawList::AddQuadFilled(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, ImU32 col) { if ((col & IM_COL32_A_MASK) == 0) return; PathLineTo(p1); PathLineTo(p2); PathLineTo(p3); PathLineTo(p4); PathFillConvex(col); } void ImDrawList::AddTriangle(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, ImU32 col, float thickness) { if ((col & IM_COL32_A_MASK) == 0) return; PathLineTo(p1); PathLineTo(p2); PathLineTo(p3); PathStroke(col, ImDrawFlags_Closed, thickness); } void ImDrawList::AddTriangleFilled(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, ImU32 col) { if ((col & IM_COL32_A_MASK) == 0) return; PathLineTo(p1); PathLineTo(p2); PathLineTo(p3); PathFillConvex(col); } void ImDrawList::AddCircle(const ImVec2& center, float radius, ImU32 col, int num_segments, float thickness) { if ((col & IM_COL32_A_MASK) == 0 || radius < 0.5f) return; if (num_segments <= 0) { // Use arc with automatic segment count _PathArcToFastEx(center, radius - 0.5f, 0, IM_DRAWLIST_ARCFAST_SAMPLE_MAX, 0); _Path.Size--; } else { // Explicit segment count (still clamp to avoid drawing insanely tessellated shapes) num_segments = ImClamp(num_segments, 3, IM_DRAWLIST_CIRCLE_AUTO_SEGMENT_MAX); // Because we are filling a closed shape we remove 1 from the count of segments/points const float a_max = (IM_PI * 2.0f) * ((float)num_segments - 1.0f) / (float)num_segments; PathArcTo(center, radius - 0.5f, 0.0f, a_max, num_segments - 1); } PathStroke(col, ImDrawFlags_Closed, thickness); } void ImDrawList::AddCircleFilled(const ImVec2& center, float radius, ImU32 col, int num_segments) { if ((col & IM_COL32_A_MASK) == 0 || radius < 0.5f) return; if (num_segments <= 0) { // Use arc with automatic segment count _PathArcToFastEx(center, radius, 0, IM_DRAWLIST_ARCFAST_SAMPLE_MAX, 0); _Path.Size--; } else { // Explicit segment count (still clamp to avoid drawing insanely tessellated shapes) num_segments = ImClamp(num_segments, 3, IM_DRAWLIST_CIRCLE_AUTO_SEGMENT_MAX); // Because we are filling a closed shape we remove 1 from the count of segments/points const float a_max = (IM_PI * 2.0f) * ((float)num_segments - 1.0f) / (float)num_segments; PathArcTo(center, radius, 0.0f, a_max, num_segments - 1); } PathFillConvex(col); } // Guaranteed to honor 'num_segments' void ImDrawList::AddNgon(const ImVec2& center, float radius, ImU32 col, int num_segments, float thickness) { if ((col & IM_COL32_A_MASK) == 0 || num_segments <= 2) return; // Because we are filling a closed shape we remove 1 from the count of segments/points const float a_max = (IM_PI * 2.0f) * ((float)num_segments - 1.0f) / (float)num_segments; PathArcTo(center, radius - 0.5f, 0.0f, a_max, num_segments - 1); PathStroke(col, ImDrawFlags_Closed, thickness); } // Guaranteed to honor 'num_segments' void ImDrawList::AddNgonFilled(const ImVec2& center, float radius, ImU32 col, int num_segments) { if ((col & IM_COL32_A_MASK) == 0 || num_segments <= 2) return; // Because we are filling a closed shape we remove 1 from the count of segments/points const float a_max = (IM_PI * 2.0f) * ((float)num_segments - 1.0f) / (float)num_segments; PathArcTo(center, radius, 0.0f, a_max, num_segments - 1); PathFillConvex(col); } // Ellipse void ImDrawList::AddEllipse(const ImVec2& center, const ImVec2& radius, ImU32 col, float rot, int num_segments, float thickness) { if ((col & IM_COL32_A_MASK) == 0) return; if (num_segments <= 0) num_segments = _CalcCircleAutoSegmentCount(ImMax(radius.x, radius.y)); // A bit pessimistic, maybe there's a better computation to do here. // Because we are filling a closed shape we remove 1 from the count of segments/points const float a_max = IM_PI * 2.0f * ((float)num_segments - 1.0f) / (float)num_segments; PathEllipticalArcTo(center, radius, rot, 0.0f, a_max, num_segments - 1); PathStroke(col, true, thickness); } void ImDrawList::AddEllipseFilled(const ImVec2& center, const ImVec2& radius, ImU32 col, float rot, int num_segments) { if ((col & IM_COL32_A_MASK) == 0) return; if (num_segments <= 0) num_segments = _CalcCircleAutoSegmentCount(ImMax(radius.x, radius.y)); // A bit pessimistic, maybe there's a better computation to do here. // Because we are filling a closed shape we remove 1 from the count of segments/points const float a_max = IM_PI * 2.0f * ((float)num_segments - 1.0f) / (float)num_segments; PathEllipticalArcTo(center, radius, rot, 0.0f, a_max, num_segments - 1); PathFillConvex(col); } // Cubic Bezier takes 4 controls points void ImDrawList::AddBezierCubic(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, ImU32 col, float thickness, int num_segments) { if ((col & IM_COL32_A_MASK) == 0) return; PathLineTo(p1); PathBezierCubicCurveTo(p2, p3, p4, num_segments); PathStroke(col, 0, thickness); } // Quadratic Bezier takes 3 controls points void ImDrawList::AddBezierQuadratic(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, ImU32 col, float thickness, int num_segments) { if ((col & IM_COL32_A_MASK) == 0) return; PathLineTo(p1); PathBezierQuadraticCurveTo(p2, p3, num_segments); PathStroke(col, 0, thickness); } void ImDrawList::AddText(ImFont* font, float font_size, const ImVec2& pos, ImU32 col, const char* text_begin, const char* text_end, float wrap_width, const ImVec4* cpu_fine_clip_rect) { if ((col & IM_COL32_A_MASK) == 0) return; // Accept null ranges if (text_begin == text_end || text_begin[0] == 0) return; // No need to strlen() here: font->RenderText() will do it and may early out. // Pull default font/size from the shared ImDrawListSharedData instance if (font == NULL) font = _Data->Font; if (font_size == 0.0f) font_size = _Data->FontSize; IM_ASSERT(font->ContainerAtlas->TexID == _CmdHeader.TextureId); // Use high-level ImGui::PushFont() or low-level ImDrawList::PushTextureId() to change font. ImVec4 clip_rect = _CmdHeader.ClipRect; if (cpu_fine_clip_rect) { clip_rect.x = ImMax(clip_rect.x, cpu_fine_clip_rect->x); clip_rect.y = ImMax(clip_rect.y, cpu_fine_clip_rect->y); clip_rect.z = ImMin(clip_rect.z, cpu_fine_clip_rect->z); clip_rect.w = ImMin(clip_rect.w, cpu_fine_clip_rect->w); } font->RenderText(this, font_size, pos, col, clip_rect, text_begin, text_end, wrap_width, cpu_fine_clip_rect != NULL); } void ImDrawList::AddText(const ImVec2& pos, ImU32 col, const char* text_begin, const char* text_end) { AddText(_Data->Font, _Data->FontSize, pos, col, text_begin, text_end); } void ImDrawList::AddImage(ImTextureID user_texture_id, const ImVec2& p_min, const ImVec2& p_max, const ImVec2& uv_min, const ImVec2& uv_max, ImU32 col) { if ((col & IM_COL32_A_MASK) == 0) return; const bool push_texture_id = user_texture_id != _CmdHeader.TextureId; if (push_texture_id) PushTextureID(user_texture_id); PrimReserve(6, 4); PrimRectUV(p_min, p_max, uv_min, uv_max, col); if (push_texture_id) PopTextureID(); } void ImDrawList::AddImageQuad(ImTextureID user_texture_id, const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, const ImVec2& uv1, const ImVec2& uv2, const ImVec2& uv3, const ImVec2& uv4, ImU32 col) { if ((col & IM_COL32_A_MASK) == 0) return; const bool push_texture_id = user_texture_id != _CmdHeader.TextureId; if (push_texture_id) PushTextureID(user_texture_id); PrimReserve(6, 4); PrimQuadUV(p1, p2, p3, p4, uv1, uv2, uv3, uv4, col); if (push_texture_id) PopTextureID(); } void ImDrawList::AddImageRounded(ImTextureID user_texture_id, const ImVec2& p_min, const ImVec2& p_max, const ImVec2& uv_min, const ImVec2& uv_max, ImU32 col, float rounding, ImDrawFlags flags) { if ((col & IM_COL32_A_MASK) == 0) return; flags = FixRectCornerFlags(flags); if (rounding < 0.5f || (flags & ImDrawFlags_RoundCornersMask_) == ImDrawFlags_RoundCornersNone) { AddImage(user_texture_id, p_min, p_max, uv_min, uv_max, col); return; } const bool push_texture_id = user_texture_id != _CmdHeader.TextureId; if (push_texture_id) PushTextureID(user_texture_id); int vert_start_idx = VtxBuffer.Size; PathRect(p_min, p_max, rounding, flags); PathFillConvex(col); int vert_end_idx = VtxBuffer.Size; ImGui::ShadeVertsLinearUV(this, vert_start_idx, vert_end_idx, p_min, p_max, uv_min, uv_max, true); if (push_texture_id) PopTextureID(); } //----------------------------------------------------------------------------- // [SECTION] ImTriangulator, ImDrawList concave polygon fill //----------------------------------------------------------------------------- // Triangulate concave polygons. Based on "Triangulation by Ear Clipping" paper, O(N^2) complexity. // Reference: https://www.geometrictools.com/Documentation/TriangulationByEarClipping.pdf // Provided as a convenience for user but not used by main library. //----------------------------------------------------------------------------- // - ImTriangulator [Internal] // - AddConcavePolyFilled() //----------------------------------------------------------------------------- enum ImTriangulatorNodeType { ImTriangulatorNodeType_Convex, ImTriangulatorNodeType_Ear, ImTriangulatorNodeType_Reflex }; struct ImTriangulatorNode { ImTriangulatorNodeType Type; int Index; ImVec2 Pos; ImTriangulatorNode* Next; ImTriangulatorNode* Prev; void Unlink() { Next->Prev = Prev; Prev->Next = Next; } }; struct ImTriangulatorNodeSpan { ImTriangulatorNode** Data = NULL; int Size = 0; void push_back(ImTriangulatorNode* node) { Data[Size++] = node; } void find_erase_unsorted(int idx) { for (int i = Size - 1; i >= 0; i--) if (Data[i]->Index == idx) { Data[i] = Data[Size - 1]; Size--; return; } } }; struct ImTriangulator { static int EstimateTriangleCount(int points_count) { return (points_count < 3) ? 0 : points_count - 2; } static int EstimateScratchBufferSize(int points_count) { return sizeof(ImTriangulatorNode) * points_count + sizeof(ImTriangulatorNode*) * points_count * 2; } void Init(const ImVec2* points, int points_count, void* scratch_buffer); void GetNextTriangle(unsigned int out_triangle[3]); // Return relative indexes for next triangle // Internal functions void BuildNodes(const ImVec2* points, int points_count); void BuildReflexes(); void BuildEars(); void FlipNodeList(); bool IsEar(int i0, int i1, int i2, const ImVec2& v0, const ImVec2& v1, const ImVec2& v2) const; void ReclassifyNode(ImTriangulatorNode* node); // Internal members int _TrianglesLeft = 0; ImTriangulatorNode* _Nodes = NULL; ImTriangulatorNodeSpan _Ears; ImTriangulatorNodeSpan _Reflexes; }; // Distribute storage for nodes, ears and reflexes. // FIXME-OPT: if everything is convex, we could report it to caller and let it switch to an convex renderer // (this would require first building reflexes to bail to convex if empty, without even building nodes) void ImTriangulator::Init(const ImVec2* points, int points_count, void* scratch_buffer) { IM_ASSERT(scratch_buffer != NULL && points_count >= 3); _TrianglesLeft = EstimateTriangleCount(points_count); _Nodes = (ImTriangulatorNode*)scratch_buffer; // points_count x Node _Ears.Data = (ImTriangulatorNode**)(_Nodes + points_count); // points_count x Node* _Reflexes.Data = (ImTriangulatorNode**)(_Nodes + points_count) + points_count; // points_count x Node* BuildNodes(points, points_count); BuildReflexes(); BuildEars(); } void ImTriangulator::BuildNodes(const ImVec2* points, int points_count) { for (int i = 0; i < points_count; i++) { _Nodes[i].Type = ImTriangulatorNodeType_Convex; _Nodes[i].Index = i; _Nodes[i].Pos = points[i]; _Nodes[i].Next = _Nodes + i + 1; _Nodes[i].Prev = _Nodes + i - 1; } _Nodes[0].Prev = _Nodes + points_count - 1; _Nodes[points_count - 1].Next = _Nodes; } void ImTriangulator::BuildReflexes() { ImTriangulatorNode* n1 = _Nodes; for (int i = _TrianglesLeft; i >= 0; i--, n1 = n1->Next) { if (ImTriangleIsClockwise(n1->Prev->Pos, n1->Pos, n1->Next->Pos)) continue; n1->Type = ImTriangulatorNodeType_Reflex; _Reflexes.push_back(n1); } } void ImTriangulator::BuildEars() { ImTriangulatorNode* n1 = _Nodes; for (int i = _TrianglesLeft; i >= 0; i--, n1 = n1->Next) { if (n1->Type != ImTriangulatorNodeType_Convex) continue; if (!IsEar(n1->Prev->Index, n1->Index, n1->Next->Index, n1->Prev->Pos, n1->Pos, n1->Next->Pos)) continue; n1->Type = ImTriangulatorNodeType_Ear; _Ears.push_back(n1); } } void ImTriangulator::GetNextTriangle(unsigned int out_triangle[3]) { if (_Ears.Size == 0) { FlipNodeList(); ImTriangulatorNode* node = _Nodes; for (int i = _TrianglesLeft; i >= 0; i--, node = node->Next) node->Type = ImTriangulatorNodeType_Convex; _Reflexes.Size = 0; BuildReflexes(); BuildEars(); // If we still don't have ears, it means geometry is degenerated. if (_Ears.Size == 0) { // Return first triangle available, mimicking the behavior of convex fill. IM_ASSERT(_TrianglesLeft > 0); // Geometry is degenerated _Ears.Data[0] = _Nodes; _Ears.Size = 1; } } ImTriangulatorNode* ear = _Ears.Data[--_Ears.Size]; out_triangle[0] = ear->Prev->Index; out_triangle[1] = ear->Index; out_triangle[2] = ear->Next->Index; ear->Unlink(); if (ear == _Nodes) _Nodes = ear->Next; ReclassifyNode(ear->Prev); ReclassifyNode(ear->Next); _TrianglesLeft--; } void ImTriangulator::FlipNodeList() { ImTriangulatorNode* prev = _Nodes; ImTriangulatorNode* temp = _Nodes; ImTriangulatorNode* current = _Nodes->Next; prev->Next = prev; prev->Prev = prev; while (current != _Nodes) { temp = current->Next; current->Next = prev; prev->Prev = current; _Nodes->Next = current; current->Prev = _Nodes; prev = current; current = temp; } _Nodes = prev; } // A triangle is an ear is no other vertex is inside it. We can test reflexes vertices only (see reference algorithm) bool ImTriangulator::IsEar(int i0, int i1, int i2, const ImVec2& v0, const ImVec2& v1, const ImVec2& v2) const { ImTriangulatorNode** p_end = _Reflexes.Data + _Reflexes.Size; for (ImTriangulatorNode** p = _Reflexes.Data; p < p_end; p++) { ImTriangulatorNode* reflex = *p; if (reflex->Index != i0 && reflex->Index != i1 && reflex->Index != i2) if (ImTriangleContainsPoint(v0, v1, v2, reflex->Pos)) return false; } return true; } void ImTriangulator::ReclassifyNode(ImTriangulatorNode* n1) { // Classify node ImTriangulatorNodeType type; const ImTriangulatorNode* n0 = n1->Prev; const ImTriangulatorNode* n2 = n1->Next; if (!ImTriangleIsClockwise(n0->Pos, n1->Pos, n2->Pos)) type = ImTriangulatorNodeType_Reflex; else if (IsEar(n0->Index, n1->Index, n2->Index, n0->Pos, n1->Pos, n2->Pos)) type = ImTriangulatorNodeType_Ear; else type = ImTriangulatorNodeType_Convex; // Update lists when a type changes if (type == n1->Type) return; if (n1->Type == ImTriangulatorNodeType_Reflex) _Reflexes.find_erase_unsorted(n1->Index); else if (n1->Type == ImTriangulatorNodeType_Ear) _Ears.find_erase_unsorted(n1->Index); if (type == ImTriangulatorNodeType_Reflex) _Reflexes.push_back(n1); else if (type == ImTriangulatorNodeType_Ear) _Ears.push_back(n1); n1->Type = type; } // Use ear-clipping algorithm to triangulate a simple polygon (no self-interaction, no holes). // (Reminder: we don't perform any coarse clipping/culling in ImDrawList layer! // It is up to caller to ensure not making costly calls that will be outside of visible area. // As concave fill is noticeably more expensive than other primitives, be mindful of this... // Caller can build AABB of points, and avoid filling if 'draw_list->_CmdHeader.ClipRect.Overlays(points_bb) == false') void ImDrawList::AddConcavePolyFilled(const ImVec2* points, const int points_count, ImU32 col) { if (points_count < 3 || (col & IM_COL32_A_MASK) == 0) return; const ImVec2 uv = _Data->TexUvWhitePixel; ImTriangulator triangulator; unsigned int triangle[3]; if (Flags & ImDrawListFlags_AntiAliasedFill) { // Anti-aliased Fill const float AA_SIZE = _FringeScale; const ImU32 col_trans = col & ~IM_COL32_A_MASK; const int idx_count = (points_count - 2) * 3 + points_count * 6; const int vtx_count = (points_count * 2); PrimReserve(idx_count, vtx_count); // Add indexes for fill unsigned int vtx_inner_idx = _VtxCurrentIdx; unsigned int vtx_outer_idx = _VtxCurrentIdx + 1; _Data->TempBuffer.reserve_discard((ImTriangulator::EstimateScratchBufferSize(points_count) + sizeof(ImVec2)) / sizeof(ImVec2)); triangulator.Init(points, points_count, _Data->TempBuffer.Data); while (triangulator._TrianglesLeft > 0) { triangulator.GetNextTriangle(triangle); _IdxWritePtr[0] = (ImDrawIdx)(vtx_inner_idx + (triangle[0] << 1)); _IdxWritePtr[1] = (ImDrawIdx)(vtx_inner_idx + (triangle[1] << 1)); _IdxWritePtr[2] = (ImDrawIdx)(vtx_inner_idx + (triangle[2] << 1)); _IdxWritePtr += 3; } // Compute normals _Data->TempBuffer.reserve_discard(points_count); ImVec2* temp_normals = _Data->TempBuffer.Data; for (int i0 = points_count - 1, i1 = 0; i1 < points_count; i0 = i1++) { const ImVec2& p0 = points[i0]; const ImVec2& p1 = points[i1]; float dx = p1.x - p0.x; float dy = p1.y - p0.y; IM_NORMALIZE2F_OVER_ZERO(dx, dy); temp_normals[i0].x = dy; temp_normals[i0].y = -dx; } for (int i0 = points_count - 1, i1 = 0; i1 < points_count; i0 = i1++) { // Average normals const ImVec2& n0 = temp_normals[i0]; const ImVec2& n1 = temp_normals[i1]; float dm_x = (n0.x + n1.x) * 0.5f; float dm_y = (n0.y + n1.y) * 0.5f; IM_FIXNORMAL2F(dm_x, dm_y); dm_x *= AA_SIZE * 0.5f; dm_y *= AA_SIZE * 0.5f; // Add vertices _VtxWritePtr[0].pos.x = (points[i1].x - dm_x); _VtxWritePtr[0].pos.y = (points[i1].y - dm_y); _VtxWritePtr[0].uv = uv; _VtxWritePtr[0].col = col; // Inner _VtxWritePtr[1].pos.x = (points[i1].x + dm_x); _VtxWritePtr[1].pos.y = (points[i1].y + dm_y); _VtxWritePtr[1].uv = uv; _VtxWritePtr[1].col = col_trans; // Outer _VtxWritePtr += 2; // Add indexes for fringes _IdxWritePtr[0] = (ImDrawIdx)(vtx_inner_idx + (i1 << 1)); _IdxWritePtr[1] = (ImDrawIdx)(vtx_inner_idx + (i0 << 1)); _IdxWritePtr[2] = (ImDrawIdx)(vtx_outer_idx + (i0 << 1)); _IdxWritePtr[3] = (ImDrawIdx)(vtx_outer_idx + (i0 << 1)); _IdxWritePtr[4] = (ImDrawIdx)(vtx_outer_idx + (i1 << 1)); _IdxWritePtr[5] = (ImDrawIdx)(vtx_inner_idx + (i1 << 1)); _IdxWritePtr += 6; } _VtxCurrentIdx += (ImDrawIdx)vtx_count; } else { // Non Anti-aliased Fill const int idx_count = (points_count - 2) * 3; const int vtx_count = points_count; PrimReserve(idx_count, vtx_count); for (int i = 0; i < vtx_count; i++) { _VtxWritePtr[0].pos = points[i]; _VtxWritePtr[0].uv = uv; _VtxWritePtr[0].col = col; _VtxWritePtr++; } _Data->TempBuffer.reserve_discard((ImTriangulator::EstimateScratchBufferSize(points_count) + sizeof(ImVec2)) / sizeof(ImVec2)); triangulator.Init(points, points_count, _Data->TempBuffer.Data); while (triangulator._TrianglesLeft > 0) { triangulator.GetNextTriangle(triangle); _IdxWritePtr[0] = (ImDrawIdx)(_VtxCurrentIdx + triangle[0]); _IdxWritePtr[1] = (ImDrawIdx)(_VtxCurrentIdx + triangle[1]); _IdxWritePtr[2] = (ImDrawIdx)(_VtxCurrentIdx + triangle[2]); _IdxWritePtr += 3; } _VtxCurrentIdx += (ImDrawIdx)vtx_count; } } //----------------------------------------------------------------------------- // [SECTION] ImDrawListSplitter //----------------------------------------------------------------------------- // FIXME: This may be a little confusing, trying to be a little too low-level/optimal instead of just doing vector swap.. //----------------------------------------------------------------------------- void ImDrawListSplitter::ClearFreeMemory() { for (int i = 0; i < _Channels.Size; i++) { if (i == _Current) memset(&_Channels[i], 0, sizeof(_Channels[i])); // Current channel is a copy of CmdBuffer/IdxBuffer, don't destruct again _Channels[i]._CmdBuffer.clear(); _Channels[i]._IdxBuffer.clear(); } _Current = 0; _Count = 1; _Channels.clear(); } void ImDrawListSplitter::Split(ImDrawList* draw_list, int channels_count) { IM_UNUSED(draw_list); IM_ASSERT(_Current == 0 && _Count <= 1 && "Nested channel splitting is not supported. Please use separate instances of ImDrawListSplitter."); int old_channels_count = _Channels.Size; if (old_channels_count < channels_count) { _Channels.reserve(channels_count); // Avoid over reserving since this is likely to stay stable _Channels.resize(channels_count); } _Count = channels_count; // Channels[] (24/32 bytes each) hold storage that we'll swap with draw_list->_CmdBuffer/_IdxBuffer // The content of Channels[0] at this point doesn't matter. We clear it to make state tidy in a debugger but we don't strictly need to. // When we switch to the next channel, we'll copy draw_list->_CmdBuffer/_IdxBuffer into Channels[0] and then Channels[1] into draw_list->CmdBuffer/_IdxBuffer memset(&_Channels[0], 0, sizeof(ImDrawChannel)); for (int i = 1; i < channels_count; i++) { if (i >= old_channels_count) { IM_PLACEMENT_NEW(&_Channels[i]) ImDrawChannel(); } else { _Channels[i]._CmdBuffer.resize(0); _Channels[i]._IdxBuffer.resize(0); } } } void ImDrawListSplitter::Merge(ImDrawList* draw_list) { // Note that we never use or rely on _Channels.Size because it is merely a buffer that we never shrink back to 0 to keep all sub-buffers ready for use. if (_Count <= 1) return; SetCurrentChannel(draw_list, 0); draw_list->_PopUnusedDrawCmd(); // Calculate our final buffer sizes. Also fix the incorrect IdxOffset values in each command. int new_cmd_buffer_count = 0; int new_idx_buffer_count = 0; ImDrawCmd* last_cmd = (_Count > 0 && draw_list->CmdBuffer.Size > 0) ? &draw_list->CmdBuffer.back() : NULL; int idx_offset = last_cmd ? last_cmd->IdxOffset + last_cmd->ElemCount : 0; for (int i = 1; i < _Count; i++) { ImDrawChannel& ch = _Channels[i]; if (ch._CmdBuffer.Size > 0 && ch._CmdBuffer.back().ElemCount == 0 && ch._CmdBuffer.back().UserCallback == NULL) // Equivalent of PopUnusedDrawCmd() ch._CmdBuffer.pop_back(); if (ch._CmdBuffer.Size > 0 && last_cmd != NULL) { // Do not include ImDrawCmd_AreSequentialIdxOffset() in the compare as we rebuild IdxOffset values ourselves. // Manipulating IdxOffset (e.g. by reordering draw commands like done by RenderDimmedBackgroundBehindWindow()) is not supported within a splitter. ImDrawCmd* next_cmd = &ch._CmdBuffer[0]; if (ImDrawCmd_HeaderCompare(last_cmd, next_cmd) == 0 && last_cmd->UserCallback == NULL && next_cmd->UserCallback == NULL) { // Merge previous channel last draw command with current channel first draw command if matching. last_cmd->ElemCount += next_cmd->ElemCount; idx_offset += next_cmd->ElemCount; ch._CmdBuffer.erase(ch._CmdBuffer.Data); // FIXME-OPT: Improve for multiple merges. } } if (ch._CmdBuffer.Size > 0) last_cmd = &ch._CmdBuffer.back(); new_cmd_buffer_count += ch._CmdBuffer.Size; new_idx_buffer_count += ch._IdxBuffer.Size; for (int cmd_n = 0; cmd_n < ch._CmdBuffer.Size; cmd_n++) { ch._CmdBuffer.Data[cmd_n].IdxOffset = idx_offset; idx_offset += ch._CmdBuffer.Data[cmd_n].ElemCount; } } draw_list->CmdBuffer.resize(draw_list->CmdBuffer.Size + new_cmd_buffer_count); draw_list->IdxBuffer.resize(draw_list->IdxBuffer.Size + new_idx_buffer_count); // Write commands and indices in order (they are fairly small structures, we don't copy vertices only indices) ImDrawCmd* cmd_write = draw_list->CmdBuffer.Data + draw_list->CmdBuffer.Size - new_cmd_buffer_count; ImDrawIdx* idx_write = draw_list->IdxBuffer.Data + draw_list->IdxBuffer.Size - new_idx_buffer_count; for (int i = 1; i < _Count; i++) { ImDrawChannel& ch = _Channels[i]; if (int sz = ch._CmdBuffer.Size) { memcpy(cmd_write, ch._CmdBuffer.Data, sz * sizeof(ImDrawCmd)); cmd_write += sz; } if (int sz = ch._IdxBuffer.Size) { memcpy(idx_write, ch._IdxBuffer.Data, sz * sizeof(ImDrawIdx)); idx_write += sz; } } draw_list->_IdxWritePtr = idx_write; // Ensure there's always a non-callback draw command trailing the command-buffer if (draw_list->CmdBuffer.Size == 0 || draw_list->CmdBuffer.back().UserCallback != NULL) draw_list->AddDrawCmd(); // If current command is used with different settings we need to add a new command ImDrawCmd* curr_cmd = &draw_list->CmdBuffer.Data[draw_list->CmdBuffer.Size - 1]; if (curr_cmd->ElemCount == 0) ImDrawCmd_HeaderCopy(curr_cmd, &draw_list->_CmdHeader); // Copy ClipRect, TextureId, VtxOffset else if (ImDrawCmd_HeaderCompare(curr_cmd, &draw_list->_CmdHeader) != 0) draw_list->AddDrawCmd(); _Count = 1; } void ImDrawListSplitter::SetCurrentChannel(ImDrawList* draw_list, int idx) { IM_ASSERT(idx >= 0 && idx < _Count); if (_Current == idx) return; // Overwrite ImVector (12/16 bytes), four times. This is merely a silly optimization instead of doing .swap() memcpy(&_Channels.Data[_Current]._CmdBuffer, &draw_list->CmdBuffer, sizeof(draw_list->CmdBuffer)); memcpy(&_Channels.Data[_Current]._IdxBuffer, &draw_list->IdxBuffer, sizeof(draw_list->IdxBuffer)); _Current = idx; memcpy(&draw_list->CmdBuffer, &_Channels.Data[idx]._CmdBuffer, sizeof(draw_list->CmdBuffer)); memcpy(&draw_list->IdxBuffer, &_Channels.Data[idx]._IdxBuffer, sizeof(draw_list->IdxBuffer)); draw_list->_IdxWritePtr = draw_list->IdxBuffer.Data + draw_list->IdxBuffer.Size; // If current command is used with different settings we need to add a new command ImDrawCmd* curr_cmd = (draw_list->CmdBuffer.Size == 0) ? NULL : &draw_list->CmdBuffer.Data[draw_list->CmdBuffer.Size - 1]; if (curr_cmd == NULL) draw_list->AddDrawCmd(); else if (curr_cmd->ElemCount == 0) ImDrawCmd_HeaderCopy(curr_cmd, &draw_list->_CmdHeader); // Copy ClipRect, TextureId, VtxOffset else if (ImDrawCmd_HeaderCompare(curr_cmd, &draw_list->_CmdHeader) != 0) draw_list->AddDrawCmd(); } //----------------------------------------------------------------------------- // [SECTION] ImDrawData //----------------------------------------------------------------------------- void ImDrawData::Clear() { Valid = false; CmdListsCount = TotalIdxCount = TotalVtxCount = 0; CmdLists.resize(0); // The ImDrawList are NOT owned by ImDrawData but e.g. by ImGuiContext, so we don't clear them. DisplayPos = DisplaySize = FramebufferScale = ImVec2(0.0f, 0.0f); OwnerViewport = NULL; } // Important: 'out_list' is generally going to be draw_data->CmdLists, but may be another temporary list // as long at it is expected that the result will be later merged into draw_data->CmdLists[]. void ImGui::AddDrawListToDrawDataEx(ImDrawData* draw_data, ImVector* out_list, ImDrawList* draw_list) { if (draw_list->CmdBuffer.Size == 0) return; if (draw_list->CmdBuffer.Size == 1 && draw_list->CmdBuffer[0].ElemCount == 0 && draw_list->CmdBuffer[0].UserCallback == NULL) return; // Draw list sanity check. Detect mismatch between PrimReserve() calls and incrementing _VtxCurrentIdx, _VtxWritePtr etc. // May trigger for you if you are using PrimXXX functions incorrectly. IM_ASSERT(draw_list->VtxBuffer.Size == 0 || draw_list->_VtxWritePtr == draw_list->VtxBuffer.Data + draw_list->VtxBuffer.Size); IM_ASSERT(draw_list->IdxBuffer.Size == 0 || draw_list->_IdxWritePtr == draw_list->IdxBuffer.Data + draw_list->IdxBuffer.Size); if (!(draw_list->Flags & ImDrawListFlags_AllowVtxOffset)) IM_ASSERT((int)draw_list->_VtxCurrentIdx == draw_list->VtxBuffer.Size); // Check that draw_list doesn't use more vertices than indexable (default ImDrawIdx = unsigned short = 2 bytes = 64K vertices per ImDrawList = per window) // If this assert triggers because you are drawing lots of stuff manually: // - First, make sure you are coarse clipping yourself and not trying to draw many things outside visible bounds. // Be mindful that the lower-level ImDrawList API doesn't filter vertices. Use the Metrics/Debugger window to inspect draw list contents. // - If you want large meshes with more than 64K vertices, you can either: // (A) Handle the ImDrawCmd::VtxOffset value in your renderer backend, and set 'io.BackendFlags |= ImGuiBackendFlags_RendererHasVtxOffset'. // Most example backends already support this from 1.71. Pre-1.71 backends won't. // Some graphics API such as GL ES 1/2 don't have a way to offset the starting vertex so it is not supported for them. // (B) Or handle 32-bit indices in your renderer backend, and uncomment '#define ImDrawIdx unsigned int' line in imconfig.h. // Most example backends already support this. For example, the OpenGL example code detect index size at compile-time: // glDrawElements(GL_TRIANGLES, (GLsizei)pcmd->ElemCount, sizeof(ImDrawIdx) == 2 ? GL_UNSIGNED_SHORT : GL_UNSIGNED_INT, idx_buffer_offset); // Your own engine or render API may use different parameters or function calls to specify index sizes. // 2 and 4 bytes indices are generally supported by most graphics API. // - If for some reason neither of those solutions works for you, a workaround is to call BeginChild()/EndChild() before reaching // the 64K limit to split your draw commands in multiple draw lists. if (sizeof(ImDrawIdx) == 2) IM_ASSERT(draw_list->_VtxCurrentIdx < (1 << 16) && "Too many vertices in ImDrawList using 16-bit indices. Read comment above"); // Resolve callback data pointers if (draw_list->_CallbacksDataBuf.Size > 0) for (ImDrawCmd& cmd : draw_list->CmdBuffer) if (cmd.UserCallback != NULL && cmd.UserCallbackDataOffset != -1 && cmd.UserCallbackDataSize > 0) cmd.UserCallbackData = draw_list->_CallbacksDataBuf.Data + cmd.UserCallbackDataOffset; // Add to output list + records state in ImDrawData out_list->push_back(draw_list); draw_data->CmdListsCount++; draw_data->TotalVtxCount += draw_list->VtxBuffer.Size; draw_data->TotalIdxCount += draw_list->IdxBuffer.Size; } void ImDrawData::AddDrawList(ImDrawList* draw_list) { IM_ASSERT(CmdLists.Size == CmdListsCount); draw_list->_PopUnusedDrawCmd(); ImGui::AddDrawListToDrawDataEx(this, &CmdLists, draw_list); } // For backward compatibility: convert all buffers from indexed to de-indexed, in case you cannot render indexed. Note: this is slow and most likely a waste of resources. Always prefer indexed rendering! void ImDrawData::DeIndexAllBuffers() { ImVector new_vtx_buffer; TotalVtxCount = TotalIdxCount = 0; for (int i = 0; i < CmdListsCount; i++) { ImDrawList* cmd_list = CmdLists[i]; if (cmd_list->IdxBuffer.empty()) continue; new_vtx_buffer.resize(cmd_list->IdxBuffer.Size); for (int j = 0; j < cmd_list->IdxBuffer.Size; j++) new_vtx_buffer[j] = cmd_list->VtxBuffer[cmd_list->IdxBuffer[j]]; cmd_list->VtxBuffer.swap(new_vtx_buffer); cmd_list->IdxBuffer.resize(0); TotalVtxCount += cmd_list->VtxBuffer.Size; } } // Helper to scale the ClipRect field of each ImDrawCmd. // Use if your final output buffer is at a different scale than draw_data->DisplaySize, // or if there is a difference between your window resolution and framebuffer resolution. void ImDrawData::ScaleClipRects(const ImVec2& fb_scale) { for (ImDrawList* draw_list : CmdLists) for (ImDrawCmd& cmd : draw_list->CmdBuffer) cmd.ClipRect = ImVec4(cmd.ClipRect.x * fb_scale.x, cmd.ClipRect.y * fb_scale.y, cmd.ClipRect.z * fb_scale.x, cmd.ClipRect.w * fb_scale.y); } //----------------------------------------------------------------------------- // [SECTION] Helpers ShadeVertsXXX functions //----------------------------------------------------------------------------- // Generic linear color gradient, write to RGB fields, leave A untouched. void ImGui::ShadeVertsLinearColorGradientKeepAlpha(ImDrawList* draw_list, int vert_start_idx, int vert_end_idx, ImVec2 gradient_p0, ImVec2 gradient_p1, ImU32 col0, ImU32 col1) { ImVec2 gradient_extent = gradient_p1 - gradient_p0; float gradient_inv_length2 = 1.0f / ImLengthSqr(gradient_extent); ImDrawVert* vert_start = draw_list->VtxBuffer.Data + vert_start_idx; ImDrawVert* vert_end = draw_list->VtxBuffer.Data + vert_end_idx; const int col0_r = (int)(col0 >> IM_COL32_R_SHIFT) & 0xFF; const int col0_g = (int)(col0 >> IM_COL32_G_SHIFT) & 0xFF; const int col0_b = (int)(col0 >> IM_COL32_B_SHIFT) & 0xFF; const int col_delta_r = ((int)(col1 >> IM_COL32_R_SHIFT) & 0xFF) - col0_r; const int col_delta_g = ((int)(col1 >> IM_COL32_G_SHIFT) & 0xFF) - col0_g; const int col_delta_b = ((int)(col1 >> IM_COL32_B_SHIFT) & 0xFF) - col0_b; for (ImDrawVert* vert = vert_start; vert < vert_end; vert++) { float d = ImDot(vert->pos - gradient_p0, gradient_extent); float t = ImClamp(d * gradient_inv_length2, 0.0f, 1.0f); int r = (int)(col0_r + col_delta_r * t); int g = (int)(col0_g + col_delta_g * t); int b = (int)(col0_b + col_delta_b * t); vert->col = (r << IM_COL32_R_SHIFT) | (g << IM_COL32_G_SHIFT) | (b << IM_COL32_B_SHIFT) | (vert->col & IM_COL32_A_MASK); } } // Distribute UV over (a, b) rectangle void ImGui::ShadeVertsLinearUV(ImDrawList* draw_list, int vert_start_idx, int vert_end_idx, const ImVec2& a, const ImVec2& b, const ImVec2& uv_a, const ImVec2& uv_b, bool clamp) { const ImVec2 size = b - a; const ImVec2 uv_size = uv_b - uv_a; const ImVec2 scale = ImVec2( size.x != 0.0f ? (uv_size.x / size.x) : 0.0f, size.y != 0.0f ? (uv_size.y / size.y) : 0.0f); ImDrawVert* vert_start = draw_list->VtxBuffer.Data + vert_start_idx; ImDrawVert* vert_end = draw_list->VtxBuffer.Data + vert_end_idx; if (clamp) { const ImVec2 min = ImMin(uv_a, uv_b); const ImVec2 max = ImMax(uv_a, uv_b); for (ImDrawVert* vertex = vert_start; vertex < vert_end; ++vertex) vertex->uv = ImClamp(uv_a + ImMul(ImVec2(vertex->pos.x, vertex->pos.y) - a, scale), min, max); } else { for (ImDrawVert* vertex = vert_start; vertex < vert_end; ++vertex) vertex->uv = uv_a + ImMul(ImVec2(vertex->pos.x, vertex->pos.y) - a, scale); } } void ImGui::ShadeVertsTransformPos(ImDrawList* draw_list, int vert_start_idx, int vert_end_idx, const ImVec2& pivot_in, float cos_a, float sin_a, const ImVec2& pivot_out) { ImDrawVert* vert_start = draw_list->VtxBuffer.Data + vert_start_idx; ImDrawVert* vert_end = draw_list->VtxBuffer.Data + vert_end_idx; for (ImDrawVert* vertex = vert_start; vertex < vert_end; ++vertex) vertex->pos = ImRotate(vertex->pos- pivot_in, cos_a, sin_a) + pivot_out; } //----------------------------------------------------------------------------- // [SECTION] ImFontConfig //----------------------------------------------------------------------------- ImFontConfig::ImFontConfig() { memset(this, 0, sizeof(*this)); FontDataOwnedByAtlas = true; OversampleH = 0; // Auto == 1 or 2 depending on size OversampleV = 0; // Auto == 1 GlyphMaxAdvanceX = FLT_MAX; RasterizerMultiply = 1.0f; RasterizerDensity = 1.0f; EllipsisChar = 0; } //----------------------------------------------------------------------------- // [SECTION] ImFontAtlas //----------------------------------------------------------------------------- // - Default texture data encoded in ASCII // - ImFontAtlas::ClearInputData() // - ImFontAtlas::ClearTexData() // - ImFontAtlas::ClearFonts() // - ImFontAtlas::Clear() // - ImFontAtlas::GetTexDataAsAlpha8() // - ImFontAtlas::GetTexDataAsRGBA32() // - ImFontAtlas::AddFont() // - ImFontAtlas::AddFontDefault() // - ImFontAtlas::AddFontFromFileTTF() // - ImFontAtlas::AddFontFromMemoryTTF() // - ImFontAtlas::AddFontFromMemoryCompressedTTF() // - ImFontAtlas::AddFontFromMemoryCompressedBase85TTF() // - ImFontAtlas::AddCustomRectRegular() // - ImFontAtlas::AddCustomRectFontGlyph() // - ImFontAtlas::CalcCustomRectUV() // - ImFontAtlasGetMouseCursorTexData() // - ImFontAtlas::Build() // - ImFontAtlasBuildMultiplyCalcLookupTable() // - ImFontAtlasBuildMultiplyRectAlpha8() // - ImFontAtlasBuildWithStbTruetype() // - ImFontAtlasGetBuilderForStbTruetype() // - ImFontAtlasUpdateSourcesPointers() // - ImFontAtlasBuildSetupFont() // - ImFontAtlasBuildPackCustomRects() // - ImFontAtlasBuildRender8bppRectFromString() // - ImFontAtlasBuildRender32bppRectFromString() // - ImFontAtlasBuildRenderDefaultTexData() // - ImFontAtlasBuildRenderLinesTexData() // - ImFontAtlasBuildInit() // - ImFontAtlasBuildFinish() //----------------------------------------------------------------------------- // A work of art lies ahead! (. = white layer, X = black layer, others are blank) // The 2x2 white texels on the top left are the ones we'll use everywhere in Dear ImGui to render filled shapes. // (This is used when io.MouseDrawCursor = true) const int FONT_ATLAS_DEFAULT_TEX_DATA_W = 122; // Actual texture will be 2 times that + 1 spacing. const int FONT_ATLAS_DEFAULT_TEX_DATA_H = 27; static const char FONT_ATLAS_DEFAULT_TEX_DATA_PIXELS[FONT_ATLAS_DEFAULT_TEX_DATA_W * FONT_ATLAS_DEFAULT_TEX_DATA_H + 1] = { "..- -XXXXXXX- X - X -XXXXXXX - XXXXXXX- XX - XX XX " "..- -X.....X- X.X - X.X -X.....X - X.....X- X..X -X..X X..X" "--- -XXX.XXX- X...X - X...X -X....X - X....X- X..X -X...X X...X" "X - X.X - X.....X - X.....X -X...X - X...X- X..X - X...X X...X " "XX - X.X -X.......X- X.......X -X..X.X - X.X..X- X..X - X...X...X " "X.X - X.X -XXXX.XXXX- XXXX.XXXX -X.X X.X - X.X X.X- X..XXX - X.....X " "X..X - X.X - X.X - X.X -XX X.X - X.X XX- X..X..XXX - X...X " "X...X - X.X - X.X - XX X.X XX - X.X - X.X - X..X..X..XX - X.X " "X....X - X.X - X.X - X.X X.X X.X - X.X - X.X - X..X..X..X.X - X...X " "X.....X - X.X - X.X - X..X X.X X..X - X.X - X.X -XXX X..X..X..X..X- X.....X " "X......X - X.X - X.X - X...XXXXXX.XXXXXX...X - X.X XX-XX X.X -X..XX........X..X- X...X...X " "X.......X - X.X - X.X -X.....................X- X.X X.X-X.X X.X -X...X...........X- X...X X...X " "X........X - X.X - X.X - X...XXXXXX.XXXXXX...X - X.X..X-X..X.X - X..............X-X...X X...X" "X.........X -XXX.XXX- X.X - X..X X.X X..X - X...X-X...X - X.............X-X..X X..X" "X..........X-X.....X- X.X - X.X X.X X.X - X....X-X....X - X.............X- XX XX " "X......XXXXX-XXXXXXX- X.X - XX X.X XX - X.....X-X.....X - X............X--------------" "X...X..X --------- X.X - X.X - XXXXXXX-XXXXXXX - X...........X - " "X..X X..X - -XXXX.XXXX- XXXX.XXXX ------------------------------------- X..........X - " "X.X X..X - -X.......X- X.......X - XX XX - - X..........X - " "XX X..X - - X.....X - X.....X - X.X X.X - - X........X - " " X..X - - X...X - X...X - X..X X..X - - X........X - " " XX - - X.X - X.X - X...XXXXXXXXXXXXX...X - - XXXXXXXXXX - " "------------- - X - X -X.....................X- ------------------- " " ----------------------------------- X...XXXXXXXXXXXXX...X - " " - X..X X..X - " " - X.X X.X - " " - XX XX - " }; static const ImVec2 FONT_ATLAS_DEFAULT_TEX_CURSOR_DATA[ImGuiMouseCursor_COUNT][3] = { // Pos ........ Size ......... Offset ...... { ImVec2( 0,3), ImVec2(12,19), ImVec2( 0, 0) }, // ImGuiMouseCursor_Arrow { ImVec2(13,0), ImVec2( 7,16), ImVec2( 1, 8) }, // ImGuiMouseCursor_TextInput { ImVec2(31,0), ImVec2(23,23), ImVec2(11,11) }, // ImGuiMouseCursor_ResizeAll { ImVec2(21,0), ImVec2( 9,23), ImVec2( 4,11) }, // ImGuiMouseCursor_ResizeNS { ImVec2(55,18),ImVec2(23, 9), ImVec2(11, 4) }, // ImGuiMouseCursor_ResizeEW { ImVec2(73,0), ImVec2(17,17), ImVec2( 8, 8) }, // ImGuiMouseCursor_ResizeNESW { ImVec2(55,0), ImVec2(17,17), ImVec2( 8, 8) }, // ImGuiMouseCursor_ResizeNWSE { ImVec2(91,0), ImVec2(17,22), ImVec2( 5, 0) }, // ImGuiMouseCursor_Hand { ImVec2(0,3), ImVec2(12,19), ImVec2(0, 0) }, // ImGuiMouseCursor_Wait // Arrow + custom code in ImGui::RenderMouseCursor() { ImVec2(0,3), ImVec2(12,19), ImVec2(0, 0) }, // ImGuiMouseCursor_Progress // Arrow + custom code in ImGui::RenderMouseCursor() { ImVec2(109,0),ImVec2(13,15), ImVec2( 6, 7) }, // ImGuiMouseCursor_NotAllowed }; ImFontAtlas::ImFontAtlas() { memset(this, 0, sizeof(*this)); TexGlyphPadding = 1; PackIdMouseCursors = PackIdLines = -1; } ImFontAtlas::~ImFontAtlas() { IM_ASSERT(!Locked && "Cannot modify a locked ImFontAtlas between NewFrame() and EndFrame/Render()!"); Clear(); } void ImFontAtlas::ClearInputData() { IM_ASSERT(!Locked && "Cannot modify a locked ImFontAtlas between NewFrame() and EndFrame/Render()!"); for (ImFontConfig& font_cfg : Sources) if (font_cfg.FontData && font_cfg.FontDataOwnedByAtlas) { IM_FREE(font_cfg.FontData); font_cfg.FontData = NULL; } // When clearing this we lose access to the font name and other information used to build the font. for (ImFont* font : Fonts) if (font->Sources >= Sources.Data && font->Sources < Sources.Data + Sources.Size) { font->Sources = NULL; font->SourcesCount = 0; } Sources.clear(); CustomRects.clear(); PackIdMouseCursors = PackIdLines = -1; // Important: we leave TexReady untouched } void ImFontAtlas::ClearTexData() { IM_ASSERT(!Locked && "Cannot modify a locked ImFontAtlas between NewFrame() and EndFrame/Render()!"); if (TexPixelsAlpha8) IM_FREE(TexPixelsAlpha8); if (TexPixelsRGBA32) IM_FREE(TexPixelsRGBA32); TexPixelsAlpha8 = NULL; TexPixelsRGBA32 = NULL; TexPixelsUseColors = false; // Important: we leave TexReady untouched } void ImFontAtlas::ClearFonts() { IM_ASSERT(!Locked && "Cannot modify a locked ImFontAtlas between NewFrame() and EndFrame/Render()!"); ClearInputData(); Fonts.clear_delete(); TexReady = false; } void ImFontAtlas::Clear() { ClearInputData(); ClearTexData(); ClearFonts(); } void ImFontAtlas::GetTexDataAsAlpha8(unsigned char** out_pixels, int* out_width, int* out_height, int* out_bytes_per_pixel) { // Build atlas on demand if (TexPixelsAlpha8 == NULL) Build(); *out_pixels = TexPixelsAlpha8; if (out_width) *out_width = TexWidth; if (out_height) *out_height = TexHeight; if (out_bytes_per_pixel) *out_bytes_per_pixel = 1; } void ImFontAtlas::GetTexDataAsRGBA32(unsigned char** out_pixels, int* out_width, int* out_height, int* out_bytes_per_pixel) { // Convert to RGBA32 format on demand // Although it is likely to be the most commonly used format, our font rendering is 1 channel / 8 bpp if (!TexPixelsRGBA32) { unsigned char* pixels = NULL; GetTexDataAsAlpha8(&pixels, NULL, NULL); if (pixels) { TexPixelsRGBA32 = (unsigned int*)IM_ALLOC((size_t)TexWidth * (size_t)TexHeight * 4); const unsigned char* src = pixels; unsigned int* dst = TexPixelsRGBA32; for (int n = TexWidth * TexHeight; n > 0; n--) *dst++ = IM_COL32(255, 255, 255, (unsigned int)(*src++)); } } *out_pixels = (unsigned char*)TexPixelsRGBA32; if (out_width) *out_width = TexWidth; if (out_height) *out_height = TexHeight; if (out_bytes_per_pixel) *out_bytes_per_pixel = 4; } ImFont* ImFontAtlas::AddFont(const ImFontConfig* font_cfg) { IM_ASSERT(!Locked && "Cannot modify a locked ImFontAtlas between NewFrame() and EndFrame/Render()!"); IM_ASSERT(font_cfg->FontData != NULL && font_cfg->FontDataSize > 0); IM_ASSERT(font_cfg->SizePixels > 0.0f && "Is ImFontConfig struct correctly initialized?"); IM_ASSERT(font_cfg->RasterizerDensity > 0.0f && "Is ImFontConfig struct correctly initialized?"); // Create new font if (!font_cfg->MergeMode) Fonts.push_back(IM_NEW(ImFont)); else IM_ASSERT(Fonts.Size > 0 && "Cannot use MergeMode for the first font"); // When using MergeMode make sure that a font has already been added before. You can use ImGui::GetIO().Fonts->AddFontDefault() to add the default imgui font. Sources.push_back(*font_cfg); ImFontConfig& new_font_cfg = Sources.back(); if (new_font_cfg.DstFont == NULL) new_font_cfg.DstFont = Fonts.back(); if (!new_font_cfg.FontDataOwnedByAtlas) { new_font_cfg.FontData = IM_ALLOC(new_font_cfg.FontDataSize); new_font_cfg.FontDataOwnedByAtlas = true; memcpy(new_font_cfg.FontData, font_cfg->FontData, (size_t)new_font_cfg.FontDataSize); } // Round font size // - We started rounding in 1.90 WIP (18991) as our layout system currently doesn't support non-rounded font size well yet. // - Note that using io.FontGlobalScale or SetWindowFontScale(), with are legacy-ish, partially supported features, can still lead to unrounded sizes. // - We may support it better later and remove this rounding. new_font_cfg.SizePixels = ImTrunc(new_font_cfg.SizePixels); // Pointers to Sources data are otherwise dangling ImFontAtlasUpdateSourcesPointers(this); // Invalidate texture TexReady = false; ClearTexData(); return new_font_cfg.DstFont; } // Default font TTF is compressed with stb_compress then base85 encoded (see misc/fonts/binary_to_compressed_c.cpp for encoder) static unsigned int stb_decompress_length(const unsigned char* input); static unsigned int stb_decompress(unsigned char* output, const unsigned char* input, unsigned int length); static unsigned int Decode85Byte(char c) { return c >= '\\' ? c-36 : c-35; } static void Decode85(const unsigned char* src, unsigned char* dst) { while (*src) { unsigned int tmp = Decode85Byte(src[0]) + 85 * (Decode85Byte(src[1]) + 85 * (Decode85Byte(src[2]) + 85 * (Decode85Byte(src[3]) + 85 * Decode85Byte(src[4])))); dst[0] = ((tmp >> 0) & 0xFF); dst[1] = ((tmp >> 8) & 0xFF); dst[2] = ((tmp >> 16) & 0xFF); dst[3] = ((tmp >> 24) & 0xFF); // We can't assume little-endianness. src += 5; dst += 4; } } #ifndef IMGUI_DISABLE_DEFAULT_FONT static const char* GetDefaultCompressedFontDataTTF(int* out_size); #endif // Load embedded ProggyClean.ttf at size 13, disable oversampling ImFont* ImFontAtlas::AddFontDefault(const ImFontConfig* font_cfg_template) { #ifndef IMGUI_DISABLE_DEFAULT_FONT ImFontConfig font_cfg = font_cfg_template ? *font_cfg_template : ImFontConfig(); if (!font_cfg_template) { font_cfg.OversampleH = font_cfg.OversampleV = 1; font_cfg.PixelSnapH = true; } if (font_cfg.SizePixels <= 0.0f) font_cfg.SizePixels = 13.0f * 1.0f; if (font_cfg.Name[0] == '\0') ImFormatString(font_cfg.Name, IM_ARRAYSIZE(font_cfg.Name), "ProggyClean.ttf, %dpx", (int)font_cfg.SizePixels); font_cfg.EllipsisChar = (ImWchar)0x0085; font_cfg.GlyphOffset.y = 1.0f * IM_TRUNC(font_cfg.SizePixels / 13.0f); // Add +1 offset per 13 units int ttf_compressed_size = 0; const char* ttf_compressed = GetDefaultCompressedFontDataTTF(&ttf_compressed_size); const ImWchar* glyph_ranges = font_cfg.GlyphRanges != NULL ? font_cfg.GlyphRanges : GetGlyphRangesDefault(); ImFont* font = AddFontFromMemoryCompressedTTF(ttf_compressed, ttf_compressed_size, font_cfg.SizePixels, &font_cfg, glyph_ranges); return font; #else IM_ASSERT(0 && "AddFontDefault() disabled in this build."); IM_UNUSED(font_cfg_template); return NULL; #endif // #ifndef IMGUI_DISABLE_DEFAULT_FONT } ImFont* ImFontAtlas::AddFontFromFileTTF(const char* filename, float size_pixels, const ImFontConfig* font_cfg_template, const ImWchar* glyph_ranges) { IM_ASSERT(!Locked && "Cannot modify a locked ImFontAtlas between NewFrame() and EndFrame/Render()!"); size_t data_size = 0; void* data = ImFileLoadToMemory(filename, "rb", &data_size, 0); if (!data) { IM_ASSERT_USER_ERROR(0, "Could not load font file!"); return NULL; } ImFontConfig font_cfg = font_cfg_template ? *font_cfg_template : ImFontConfig(); if (font_cfg.Name[0] == '\0') { // Store a short copy of filename into into the font name for convenience const char* p; for (p = filename + ImStrlen(filename); p > filename && p[-1] != '/' && p[-1] != '\\'; p--) {} ImFormatString(font_cfg.Name, IM_ARRAYSIZE(font_cfg.Name), "%s, %.0fpx", p, size_pixels); } return AddFontFromMemoryTTF(data, (int)data_size, size_pixels, &font_cfg, glyph_ranges); } // NB: Transfer ownership of 'ttf_data' to ImFontAtlas, unless font_cfg_template->FontDataOwnedByAtlas == false. Owned TTF buffer will be deleted after Build(). ImFont* ImFontAtlas::AddFontFromMemoryTTF(void* font_data, int font_data_size, float size_pixels, const ImFontConfig* font_cfg_template, const ImWchar* glyph_ranges) { IM_ASSERT(!Locked && "Cannot modify a locked ImFontAtlas between NewFrame() and EndFrame/Render()!"); ImFontConfig font_cfg = font_cfg_template ? *font_cfg_template : ImFontConfig(); IM_ASSERT(font_cfg.FontData == NULL); IM_ASSERT(font_data_size > 100 && "Incorrect value for font_data_size!"); // Heuristic to prevent accidentally passing a wrong value to font_data_size. font_cfg.FontData = font_data; font_cfg.FontDataSize = font_data_size; font_cfg.SizePixels = size_pixels > 0.0f ? size_pixels : font_cfg.SizePixels; if (glyph_ranges) font_cfg.GlyphRanges = glyph_ranges; return AddFont(&font_cfg); } ImFont* ImFontAtlas::AddFontFromMemoryCompressedTTF(const void* compressed_ttf_data, int compressed_ttf_size, float size_pixels, const ImFontConfig* font_cfg_template, const ImWchar* glyph_ranges) { const unsigned int buf_decompressed_size = stb_decompress_length((const unsigned char*)compressed_ttf_data); unsigned char* buf_decompressed_data = (unsigned char*)IM_ALLOC(buf_decompressed_size); stb_decompress(buf_decompressed_data, (const unsigned char*)compressed_ttf_data, (unsigned int)compressed_ttf_size); ImFontConfig font_cfg = font_cfg_template ? *font_cfg_template : ImFontConfig(); IM_ASSERT(font_cfg.FontData == NULL); font_cfg.FontDataOwnedByAtlas = true; return AddFontFromMemoryTTF(buf_decompressed_data, (int)buf_decompressed_size, size_pixels, &font_cfg, glyph_ranges); } ImFont* ImFontAtlas::AddFontFromMemoryCompressedBase85TTF(const char* compressed_ttf_data_base85, float size_pixels, const ImFontConfig* font_cfg, const ImWchar* glyph_ranges) { int compressed_ttf_size = (((int)ImStrlen(compressed_ttf_data_base85) + 4) / 5) * 4; void* compressed_ttf = IM_ALLOC((size_t)compressed_ttf_size); Decode85((const unsigned char*)compressed_ttf_data_base85, (unsigned char*)compressed_ttf); ImFont* font = AddFontFromMemoryCompressedTTF(compressed_ttf, compressed_ttf_size, size_pixels, font_cfg, glyph_ranges); IM_FREE(compressed_ttf); return font; } int ImFontAtlas::AddCustomRectRegular(int width, int height) { IM_ASSERT(width > 0 && width <= 0xFFFF); IM_ASSERT(height > 0 && height <= 0xFFFF); ImFontAtlasCustomRect r; r.Width = (unsigned short)width; r.Height = (unsigned short)height; CustomRects.push_back(r); return CustomRects.Size - 1; // Return index } int ImFontAtlas::AddCustomRectFontGlyph(ImFont* font, ImWchar id, int width, int height, float advance_x, const ImVec2& offset) { #ifdef IMGUI_USE_WCHAR32 IM_ASSERT(id <= IM_UNICODE_CODEPOINT_MAX); #endif IM_ASSERT(font != NULL); IM_ASSERT(width > 0 && width <= 0xFFFF); IM_ASSERT(height > 0 && height <= 0xFFFF); ImFontAtlasCustomRect r; r.Width = (unsigned short)width; r.Height = (unsigned short)height; r.GlyphID = id; r.GlyphColored = 0; // Set to 1 manually to mark glyph as colored // FIXME: No official API for that (#8133) r.GlyphAdvanceX = advance_x; r.GlyphOffset = offset; r.Font = font; CustomRects.push_back(r); return CustomRects.Size - 1; // Return index } void ImFontAtlas::CalcCustomRectUV(const ImFontAtlasCustomRect* rect, ImVec2* out_uv_min, ImVec2* out_uv_max) const { IM_ASSERT(TexWidth > 0 && TexHeight > 0); // Font atlas needs to be built before we can calculate UV coordinates IM_ASSERT(rect->IsPacked()); // Make sure the rectangle has been packed *out_uv_min = ImVec2((float)rect->X * TexUvScale.x, (float)rect->Y * TexUvScale.y); *out_uv_max = ImVec2((float)(rect->X + rect->Width) * TexUvScale.x, (float)(rect->Y + rect->Height) * TexUvScale.y); } bool ImFontAtlasGetMouseCursorTexData(ImFontAtlas* atlas, ImGuiMouseCursor cursor_type, ImVec2* out_offset, ImVec2* out_size, ImVec2 out_uv_border[2], ImVec2 out_uv_fill[2]) { if (cursor_type <= ImGuiMouseCursor_None || cursor_type >= ImGuiMouseCursor_COUNT) return false; if (atlas->Flags & ImFontAtlasFlags_NoMouseCursors) return false; IM_ASSERT(atlas->PackIdMouseCursors != -1); ImFontAtlasCustomRect* r = atlas->GetCustomRectByIndex(atlas->PackIdMouseCursors); ImVec2 pos = FONT_ATLAS_DEFAULT_TEX_CURSOR_DATA[cursor_type][0] + ImVec2((float)r->X, (float)r->Y); ImVec2 size = FONT_ATLAS_DEFAULT_TEX_CURSOR_DATA[cursor_type][1]; *out_size = size; *out_offset = FONT_ATLAS_DEFAULT_TEX_CURSOR_DATA[cursor_type][2]; out_uv_border[0] = (pos) * atlas->TexUvScale; out_uv_border[1] = (pos + size) * atlas->TexUvScale; pos.x += FONT_ATLAS_DEFAULT_TEX_DATA_W + 1; out_uv_fill[0] = (pos) * atlas->TexUvScale; out_uv_fill[1] = (pos + size) * atlas->TexUvScale; return true; } bool ImFontAtlas::Build() { IM_ASSERT(!Locked && "Cannot modify a locked ImFontAtlas between NewFrame() and EndFrame/Render()!"); // Default font is none are specified if (Sources.Size == 0) AddFontDefault(); // Select builder // - Note that we do not reassign to atlas->FontBuilderIO, since it is likely to point to static data which // may mess with some hot-reloading schemes. If you need to assign to this (for dynamic selection) AND are // using a hot-reloading scheme that messes up static data, store your own instance of ImFontBuilderIO somewhere // and point to it instead of pointing directly to return value of the GetBuilderXXX functions. const ImFontBuilderIO* builder_io = FontBuilderIO; if (builder_io == NULL) { #ifdef IMGUI_ENABLE_FREETYPE builder_io = ImGuiFreeType::GetBuilderForFreeType(); #elif defined(IMGUI_ENABLE_STB_TRUETYPE) builder_io = ImFontAtlasGetBuilderForStbTruetype(); #else IM_ASSERT(0); // Invalid Build function #endif } // Build return builder_io->FontBuilder_Build(this); } void ImFontAtlasBuildMultiplyCalcLookupTable(unsigned char out_table[256], float in_brighten_factor) { for (unsigned int i = 0; i < 256; i++) { unsigned int value = (unsigned int)(i * in_brighten_factor); out_table[i] = value > 255 ? 255 : (value & 0xFF); } } void ImFontAtlasBuildMultiplyRectAlpha8(const unsigned char table[256], unsigned char* pixels, int x, int y, int w, int h, int stride) { IM_ASSERT_PARANOID(w <= stride); unsigned char* data = pixels + x + y * stride; for (int j = h; j > 0; j--, data += stride - w) for (int i = w; i > 0; i--, data++) *data = table[*data]; } void ImFontAtlasBuildGetOversampleFactors(const ImFontConfig* src, int* out_oversample_h, int* out_oversample_v) { // Automatically disable horizontal oversampling over size 36 *out_oversample_h = (src->OversampleH != 0) ? src->OversampleH : (src->SizePixels * src->RasterizerDensity > 36.0f || src->PixelSnapH) ? 1 : 2; *out_oversample_v = (src->OversampleV != 0) ? src->OversampleV : 1; } #ifdef IMGUI_ENABLE_STB_TRUETYPE // Temporary data for one source font (multiple source fonts can be merged into one destination ImFont) // (C++03 doesn't allow instancing ImVector<> with function-local types so we declare the type here.) struct ImFontBuildSrcData { stbtt_fontinfo FontInfo; stbtt_pack_range PackRange; // Hold the list of codepoints to pack (essentially points to Codepoints.Data) stbrp_rect* Rects; // Rectangle to pack. We first fill in their size and the packer will give us their position. stbtt_packedchar* PackedChars; // Output glyphs const ImWchar* SrcRanges; // Ranges as requested by user (user is allowed to request too much, e.g. 0x0020..0xFFFF) int DstIndex; // Index into atlas->Fonts[] and dst_tmp_array[] int GlyphsHighest; // Highest requested codepoint int GlyphsCount; // Glyph count (excluding missing glyphs and glyphs already set by an earlier source font) ImBitVector GlyphsSet; // Glyph bit map (random access, 1-bit per codepoint. This will be a maximum of 8KB) ImVector GlyphsList; // Glyph codepoints list (flattened version of GlyphsSet) }; // Temporary data for one destination ImFont* (multiple source fonts can be merged into one destination ImFont) struct ImFontBuildDstData { int SrcCount; // Number of source fonts targeting this destination font. int GlyphsHighest; int GlyphsCount; ImBitVector GlyphsSet; // This is used to resolve collision when multiple sources are merged into a same destination font. }; static void UnpackBitVectorToFlatIndexList(const ImBitVector* in, ImVector* out) { IM_ASSERT(sizeof(in->Storage.Data[0]) == sizeof(int)); const ImU32* it_begin = in->Storage.begin(); const ImU32* it_end = in->Storage.end(); for (const ImU32* it = it_begin; it < it_end; it++) if (ImU32 entries_32 = *it) for (ImU32 bit_n = 0; bit_n < 32; bit_n++) if (entries_32 & ((ImU32)1 << bit_n)) out->push_back((int)(((it - it_begin) << 5) + bit_n)); } static bool ImFontAtlasBuildWithStbTruetype(ImFontAtlas* atlas) { IM_ASSERT(atlas->Sources.Size > 0); ImFontAtlasBuildInit(atlas); // Clear atlas atlas->TexID = (ImTextureID)NULL; atlas->TexWidth = atlas->TexHeight = 0; atlas->TexUvScale = ImVec2(0.0f, 0.0f); atlas->TexUvWhitePixel = ImVec2(0.0f, 0.0f); atlas->ClearTexData(); // Temporary storage for building ImVector src_tmp_array; ImVector dst_tmp_array; src_tmp_array.resize(atlas->Sources.Size); dst_tmp_array.resize(atlas->Fonts.Size); memset(src_tmp_array.Data, 0, (size_t)src_tmp_array.size_in_bytes()); memset(dst_tmp_array.Data, 0, (size_t)dst_tmp_array.size_in_bytes()); // 1. Initialize font loading structure, check font data validity for (int src_i = 0; src_i < atlas->Sources.Size; src_i++) { ImFontBuildSrcData& src_tmp = src_tmp_array[src_i]; ImFontConfig& src = atlas->Sources[src_i]; IM_ASSERT(src.DstFont && (!src.DstFont->IsLoaded() || src.DstFont->ContainerAtlas == atlas)); // Find index from src.DstFont (we allow the user to set cfg.DstFont. Also it makes casual debugging nicer than when storing indices) src_tmp.DstIndex = -1; for (int output_i = 0; output_i < atlas->Fonts.Size && src_tmp.DstIndex == -1; output_i++) if (src.DstFont == atlas->Fonts[output_i]) src_tmp.DstIndex = output_i; if (src_tmp.DstIndex == -1) { IM_ASSERT(src_tmp.DstIndex != -1); // src.DstFont not pointing within atlas->Fonts[] array? return false; } // Initialize helper structure for font loading and verify that the TTF/OTF data is correct const int font_offset = stbtt_GetFontOffsetForIndex((unsigned char*)src.FontData, src.FontNo); IM_ASSERT(font_offset >= 0 && "FontData is incorrect, or FontNo cannot be found."); if (!stbtt_InitFont(&src_tmp.FontInfo, (unsigned char*)src.FontData, font_offset)) { IM_ASSERT(0 && "stbtt_InitFont(): failed to parse FontData. It is correct and complete? Check FontDataSize."); return false; } // Measure highest codepoints ImFontBuildDstData& dst_tmp = dst_tmp_array[src_tmp.DstIndex]; src_tmp.SrcRanges = src.GlyphRanges ? src.GlyphRanges : atlas->GetGlyphRangesDefault(); for (const ImWchar* src_range = src_tmp.SrcRanges; src_range[0] && src_range[1]; src_range += 2) { // Check for valid range. This may also help detect *some* dangling pointers, because a common // user error is to setup ImFontConfig::GlyphRanges with a pointer to data that isn't persistent, // or to forget to zero-terminate the glyph range array. IM_ASSERT(src_range[0] <= src_range[1] && "Invalid range: is your glyph range array persistent? it is zero-terminated?"); src_tmp.GlyphsHighest = ImMax(src_tmp.GlyphsHighest, (int)src_range[1]); } dst_tmp.SrcCount++; dst_tmp.GlyphsHighest = ImMax(dst_tmp.GlyphsHighest, src_tmp.GlyphsHighest); } // 2. For every requested codepoint, check for their presence in the font data, and handle redundancy or overlaps between source fonts to avoid unused glyphs. int total_glyphs_count = 0; for (int src_i = 0; src_i < src_tmp_array.Size; src_i++) { ImFontBuildSrcData& src_tmp = src_tmp_array[src_i]; ImFontBuildDstData& dst_tmp = dst_tmp_array[src_tmp.DstIndex]; src_tmp.GlyphsSet.Create(src_tmp.GlyphsHighest + 1); if (dst_tmp.GlyphsSet.Storage.empty()) dst_tmp.GlyphsSet.Create(dst_tmp.GlyphsHighest + 1); for (const ImWchar* src_range = src_tmp.SrcRanges; src_range[0] && src_range[1]; src_range += 2) for (unsigned int codepoint = src_range[0]; codepoint <= src_range[1]; codepoint++) { if (dst_tmp.GlyphsSet.TestBit(codepoint)) // Don't overwrite existing glyphs. We could make this an option for MergeMode (e.g. MergeOverwrite==true) continue; if (!stbtt_FindGlyphIndex(&src_tmp.FontInfo, codepoint)) // It is actually in the font? continue; // Add to avail set/counters src_tmp.GlyphsCount++; dst_tmp.GlyphsCount++; src_tmp.GlyphsSet.SetBit(codepoint); dst_tmp.GlyphsSet.SetBit(codepoint); total_glyphs_count++; } } // 3. Unpack our bit map into a flat list (we now have all the Unicode points that we know are requested _and_ available _and_ not overlapping another) for (int src_i = 0; src_i < src_tmp_array.Size; src_i++) { ImFontBuildSrcData& src_tmp = src_tmp_array[src_i]; src_tmp.GlyphsList.reserve(src_tmp.GlyphsCount); UnpackBitVectorToFlatIndexList(&src_tmp.GlyphsSet, &src_tmp.GlyphsList); src_tmp.GlyphsSet.Clear(); IM_ASSERT(src_tmp.GlyphsList.Size == src_tmp.GlyphsCount); } for (int dst_i = 0; dst_i < dst_tmp_array.Size; dst_i++) dst_tmp_array[dst_i].GlyphsSet.Clear(); dst_tmp_array.clear(); // Allocate packing character data and flag packed characters buffer as non-packed (x0=y0=x1=y1=0) // (We technically don't need to zero-clear buf_rects, but let's do it for the sake of sanity) ImVector buf_rects; ImVector buf_packedchars; buf_rects.resize(total_glyphs_count); buf_packedchars.resize(total_glyphs_count); memset(buf_rects.Data, 0, (size_t)buf_rects.size_in_bytes()); memset(buf_packedchars.Data, 0, (size_t)buf_packedchars.size_in_bytes()); // 4. Gather glyphs sizes so we can pack them in our virtual canvas. int total_surface = 0; int buf_rects_out_n = 0; int buf_packedchars_out_n = 0; const int pack_padding = atlas->TexGlyphPadding; for (int src_i = 0; src_i < src_tmp_array.Size; src_i++) { ImFontBuildSrcData& src_tmp = src_tmp_array[src_i]; if (src_tmp.GlyphsCount == 0) continue; src_tmp.Rects = &buf_rects[buf_rects_out_n]; src_tmp.PackedChars = &buf_packedchars[buf_packedchars_out_n]; buf_rects_out_n += src_tmp.GlyphsCount; buf_packedchars_out_n += src_tmp.GlyphsCount; // Automatic selection of oversampling parameters ImFontConfig& src = atlas->Sources[src_i]; int oversample_h, oversample_v; ImFontAtlasBuildGetOversampleFactors(&src, &oversample_h, &oversample_v); // Convert our ranges in the format stb_truetype wants src_tmp.PackRange.font_size = src.SizePixels * src.RasterizerDensity; src_tmp.PackRange.first_unicode_codepoint_in_range = 0; src_tmp.PackRange.array_of_unicode_codepoints = src_tmp.GlyphsList.Data; src_tmp.PackRange.num_chars = src_tmp.GlyphsList.Size; src_tmp.PackRange.chardata_for_range = src_tmp.PackedChars; src_tmp.PackRange.h_oversample = (unsigned char)oversample_h; src_tmp.PackRange.v_oversample = (unsigned char)oversample_v; // Gather the sizes of all rectangles we will need to pack (this loop is based on stbtt_PackFontRangesGatherRects) const float scale = (src.SizePixels > 0.0f) ? stbtt_ScaleForPixelHeight(&src_tmp.FontInfo, src.SizePixels * src.RasterizerDensity) : stbtt_ScaleForMappingEmToPixels(&src_tmp.FontInfo, -src.SizePixels * src.RasterizerDensity); for (int glyph_i = 0; glyph_i < src_tmp.GlyphsList.Size; glyph_i++) { int x0, y0, x1, y1; const int glyph_index_in_font = stbtt_FindGlyphIndex(&src_tmp.FontInfo, src_tmp.GlyphsList[glyph_i]); IM_ASSERT(glyph_index_in_font != 0); stbtt_GetGlyphBitmapBoxSubpixel(&src_tmp.FontInfo, glyph_index_in_font, scale * oversample_h, scale * oversample_v, 0, 0, &x0, &y0, &x1, &y1); src_tmp.Rects[glyph_i].w = (stbrp_coord)(x1 - x0 + pack_padding + oversample_h - 1); src_tmp.Rects[glyph_i].h = (stbrp_coord)(y1 - y0 + pack_padding + oversample_v - 1); total_surface += src_tmp.Rects[glyph_i].w * src_tmp.Rects[glyph_i].h; } } for (int i = 0; i < atlas->CustomRects.Size; i++) total_surface += (atlas->CustomRects[i].Width + pack_padding) * (atlas->CustomRects[i].Height + pack_padding); // We need a width for the skyline algorithm, any width! // The exact width doesn't really matter much, but some API/GPU have texture size limitations and increasing width can decrease height. // User can override TexDesiredWidth and TexGlyphPadding if they wish, otherwise we use a simple heuristic to select the width based on expected surface. const int surface_sqrt = (int)ImSqrt((float)total_surface) + 1; atlas->TexHeight = 0; if (atlas->TexDesiredWidth > 0) atlas->TexWidth = atlas->TexDesiredWidth; else atlas->TexWidth = (surface_sqrt >= 4096 * 0.7f) ? 4096 : (surface_sqrt >= 2048 * 0.7f) ? 2048 : (surface_sqrt >= 1024 * 0.7f) ? 1024 : 512; // 5. Start packing // Pack our extra data rectangles first, so it will be on the upper-left corner of our texture (UV will have small values). const int TEX_HEIGHT_MAX = 1024 * 32; stbtt_pack_context spc = {}; stbtt_PackBegin(&spc, NULL, atlas->TexWidth, TEX_HEIGHT_MAX, 0, 0, NULL); spc.padding = atlas->TexGlyphPadding; // Because we mixup stbtt_PackXXX and stbrp_PackXXX there's a bit of a hack here, not passing the value to stbtt_PackBegin() allows us to still pack a TexWidth-1 wide item. (#8107) ImFontAtlasBuildPackCustomRects(atlas, spc.pack_info); // 6. Pack each source font. No rendering yet, we are working with rectangles in an infinitely tall texture at this point. for (int src_i = 0; src_i < src_tmp_array.Size; src_i++) { ImFontBuildSrcData& src_tmp = src_tmp_array[src_i]; if (src_tmp.GlyphsCount == 0) continue; stbrp_pack_rects((stbrp_context*)spc.pack_info, src_tmp.Rects, src_tmp.GlyphsCount); // Extend texture height and mark missing glyphs as non-packed so we won't render them. // FIXME: We are not handling packing failure here (would happen if we got off TEX_HEIGHT_MAX or if a single if larger than TexWidth?) for (int glyph_i = 0; glyph_i < src_tmp.GlyphsCount; glyph_i++) if (src_tmp.Rects[glyph_i].was_packed) atlas->TexHeight = ImMax(atlas->TexHeight, src_tmp.Rects[glyph_i].y + src_tmp.Rects[glyph_i].h); } // 7. Allocate texture atlas->TexHeight = (atlas->Flags & ImFontAtlasFlags_NoPowerOfTwoHeight) ? (atlas->TexHeight + 1) : ImUpperPowerOfTwo(atlas->TexHeight); atlas->TexUvScale = ImVec2(1.0f / atlas->TexWidth, 1.0f / atlas->TexHeight); atlas->TexPixelsAlpha8 = (unsigned char*)IM_ALLOC(atlas->TexWidth * atlas->TexHeight); memset(atlas->TexPixelsAlpha8, 0, atlas->TexWidth * atlas->TexHeight); spc.pixels = atlas->TexPixelsAlpha8; spc.height = atlas->TexHeight; // 8. Render/rasterize font characters into the texture for (int src_i = 0; src_i < src_tmp_array.Size; src_i++) { ImFontConfig& src = atlas->Sources[src_i]; ImFontBuildSrcData& src_tmp = src_tmp_array[src_i]; if (src_tmp.GlyphsCount == 0) continue; stbtt_PackFontRangesRenderIntoRects(&spc, &src_tmp.FontInfo, &src_tmp.PackRange, 1, src_tmp.Rects); // Apply multiply operator if (src.RasterizerMultiply != 1.0f) { unsigned char multiply_table[256]; ImFontAtlasBuildMultiplyCalcLookupTable(multiply_table, src.RasterizerMultiply); stbrp_rect* r = &src_tmp.Rects[0]; for (int glyph_i = 0; glyph_i < src_tmp.GlyphsCount; glyph_i++, r++) if (r->was_packed) ImFontAtlasBuildMultiplyRectAlpha8(multiply_table, atlas->TexPixelsAlpha8, r->x, r->y, r->w, r->h, atlas->TexWidth * 1); } src_tmp.Rects = NULL; } // End packing stbtt_PackEnd(&spc); buf_rects.clear(); // 9. Setup ImFont and glyphs for runtime for (int src_i = 0; src_i < src_tmp_array.Size; src_i++) { // When merging fonts with MergeMode=true: // - We can have multiple input fonts writing into a same destination font. // - dst_font->Sources is != from src which is our source configuration. ImFontBuildSrcData& src_tmp = src_tmp_array[src_i]; ImFontConfig& src = atlas->Sources[src_i]; ImFont* dst_font = src.DstFont; const float font_scale = stbtt_ScaleForPixelHeight(&src_tmp.FontInfo, src.SizePixels); int unscaled_ascent, unscaled_descent, unscaled_line_gap; stbtt_GetFontVMetrics(&src_tmp.FontInfo, &unscaled_ascent, &unscaled_descent, &unscaled_line_gap); const float ascent = ImCeil(unscaled_ascent * font_scale); const float descent = ImFloor(unscaled_descent * font_scale); ImFontAtlasBuildSetupFont(atlas, dst_font, &src, ascent, descent); const float font_off_x = src.GlyphOffset.x; const float font_off_y = src.GlyphOffset.y + IM_ROUND(dst_font->Ascent); const float inv_rasterization_scale = 1.0f / src.RasterizerDensity; for (int glyph_i = 0; glyph_i < src_tmp.GlyphsCount; glyph_i++) { // Register glyph const int codepoint = src_tmp.GlyphsList[glyph_i]; const stbtt_packedchar& pc = src_tmp.PackedChars[glyph_i]; stbtt_aligned_quad q; float unused_x = 0.0f, unused_y = 0.0f; stbtt_GetPackedQuad(src_tmp.PackedChars, atlas->TexWidth, atlas->TexHeight, glyph_i, &unused_x, &unused_y, &q, 0); float x0 = q.x0 * inv_rasterization_scale + font_off_x; float y0 = q.y0 * inv_rasterization_scale + font_off_y; float x1 = q.x1 * inv_rasterization_scale + font_off_x; float y1 = q.y1 * inv_rasterization_scale + font_off_y; dst_font->AddGlyph(&src, (ImWchar)codepoint, x0, y0, x1, y1, q.s0, q.t0, q.s1, q.t1, pc.xadvance * inv_rasterization_scale); } } // Cleanup src_tmp_array.clear_destruct(); ImFontAtlasBuildFinish(atlas); return true; } const ImFontBuilderIO* ImFontAtlasGetBuilderForStbTruetype() { static ImFontBuilderIO io; io.FontBuilder_Build = ImFontAtlasBuildWithStbTruetype; return &io; } #endif // IMGUI_ENABLE_STB_TRUETYPE void ImFontAtlasUpdateSourcesPointers(ImFontAtlas* atlas) { for (ImFontConfig& src : atlas->Sources) { ImFont* font = src.DstFont; if (!src.MergeMode) { font->Sources = &src; font->SourcesCount = 0; } font->SourcesCount++; } } void ImFontAtlasBuildSetupFont(ImFontAtlas* atlas, ImFont* font, ImFontConfig* font_config, float ascent, float descent) { if (!font_config->MergeMode) { font->ClearOutputData(); font->FontSize = font_config->SizePixels; IM_ASSERT(font->Sources == font_config); font->ContainerAtlas = atlas; font->Ascent = ascent; font->Descent = descent; } } void ImFontAtlasBuildPackCustomRects(ImFontAtlas* atlas, void* stbrp_context_opaque) { stbrp_context* pack_context = (stbrp_context*)stbrp_context_opaque; IM_ASSERT(pack_context != NULL); ImVector& user_rects = atlas->CustomRects; IM_ASSERT(user_rects.Size >= 1); // We expect at least the default custom rects to be registered, else something went wrong. #ifdef __GNUC__ if (user_rects.Size < 1) { __builtin_unreachable(); } // Workaround for GCC bug if IM_ASSERT() is defined to conditionally throw (see #5343) #endif const int pack_padding = atlas->TexGlyphPadding; ImVector pack_rects; pack_rects.resize(user_rects.Size); memset(pack_rects.Data, 0, (size_t)pack_rects.size_in_bytes()); for (int i = 0; i < user_rects.Size; i++) { pack_rects[i].w = user_rects[i].Width + pack_padding; pack_rects[i].h = user_rects[i].Height + pack_padding; } stbrp_pack_rects(pack_context, &pack_rects[0], pack_rects.Size); for (int i = 0; i < pack_rects.Size; i++) if (pack_rects[i].was_packed) { user_rects[i].X = (unsigned short)pack_rects[i].x; user_rects[i].Y = (unsigned short)pack_rects[i].y; IM_ASSERT(pack_rects[i].w == user_rects[i].Width + pack_padding && pack_rects[i].h == user_rects[i].Height + pack_padding); atlas->TexHeight = ImMax(atlas->TexHeight, pack_rects[i].y + pack_rects[i].h); } } void ImFontAtlasBuildRender8bppRectFromString(ImFontAtlas* atlas, int x, int y, int w, int h, const char* in_str, char in_marker_char, unsigned char in_marker_pixel_value) { IM_ASSERT(x >= 0 && x + w <= atlas->TexWidth); IM_ASSERT(y >= 0 && y + h <= atlas->TexHeight); unsigned char* out_pixel = atlas->TexPixelsAlpha8 + x + (y * atlas->TexWidth); for (int off_y = 0; off_y < h; off_y++, out_pixel += atlas->TexWidth, in_str += w) for (int off_x = 0; off_x < w; off_x++) out_pixel[off_x] = (in_str[off_x] == in_marker_char) ? in_marker_pixel_value : 0x00; } void ImFontAtlasBuildRender32bppRectFromString(ImFontAtlas* atlas, int x, int y, int w, int h, const char* in_str, char in_marker_char, unsigned int in_marker_pixel_value) { IM_ASSERT(x >= 0 && x + w <= atlas->TexWidth); IM_ASSERT(y >= 0 && y + h <= atlas->TexHeight); unsigned int* out_pixel = atlas->TexPixelsRGBA32 + x + (y * atlas->TexWidth); for (int off_y = 0; off_y < h; off_y++, out_pixel += atlas->TexWidth, in_str += w) for (int off_x = 0; off_x < w; off_x++) out_pixel[off_x] = (in_str[off_x] == in_marker_char) ? in_marker_pixel_value : IM_COL32_BLACK_TRANS; } static void ImFontAtlasBuildRenderDefaultTexData(ImFontAtlas* atlas) { ImFontAtlasCustomRect* r = atlas->GetCustomRectByIndex(atlas->PackIdMouseCursors); IM_ASSERT(r->IsPacked()); const int w = atlas->TexWidth; if (atlas->Flags & ImFontAtlasFlags_NoMouseCursors) { // White pixels only IM_ASSERT(r->Width == 2 && r->Height == 2); const int offset = (int)r->X + (int)r->Y * w; if (atlas->TexPixelsAlpha8 != NULL) { atlas->TexPixelsAlpha8[offset] = atlas->TexPixelsAlpha8[offset + 1] = atlas->TexPixelsAlpha8[offset + w] = atlas->TexPixelsAlpha8[offset + w + 1] = 0xFF; } else { atlas->TexPixelsRGBA32[offset] = atlas->TexPixelsRGBA32[offset + 1] = atlas->TexPixelsRGBA32[offset + w] = atlas->TexPixelsRGBA32[offset + w + 1] = IM_COL32_WHITE; } } else { // White pixels and mouse cursor IM_ASSERT(r->Width == FONT_ATLAS_DEFAULT_TEX_DATA_W * 2 + 1 && r->Height == FONT_ATLAS_DEFAULT_TEX_DATA_H); const int x_for_white = r->X; const int x_for_black = r->X + FONT_ATLAS_DEFAULT_TEX_DATA_W + 1; if (atlas->TexPixelsAlpha8 != NULL) { ImFontAtlasBuildRender8bppRectFromString(atlas, x_for_white, r->Y, FONT_ATLAS_DEFAULT_TEX_DATA_W, FONT_ATLAS_DEFAULT_TEX_DATA_H, FONT_ATLAS_DEFAULT_TEX_DATA_PIXELS, '.', 0xFF); ImFontAtlasBuildRender8bppRectFromString(atlas, x_for_black, r->Y, FONT_ATLAS_DEFAULT_TEX_DATA_W, FONT_ATLAS_DEFAULT_TEX_DATA_H, FONT_ATLAS_DEFAULT_TEX_DATA_PIXELS, 'X', 0xFF); } else { ImFontAtlasBuildRender32bppRectFromString(atlas, x_for_white, r->Y, FONT_ATLAS_DEFAULT_TEX_DATA_W, FONT_ATLAS_DEFAULT_TEX_DATA_H, FONT_ATLAS_DEFAULT_TEX_DATA_PIXELS, '.', IM_COL32_WHITE); ImFontAtlasBuildRender32bppRectFromString(atlas, x_for_black, r->Y, FONT_ATLAS_DEFAULT_TEX_DATA_W, FONT_ATLAS_DEFAULT_TEX_DATA_H, FONT_ATLAS_DEFAULT_TEX_DATA_PIXELS, 'X', IM_COL32_WHITE); } } atlas->TexUvWhitePixel = ImVec2((r->X + 0.5f) * atlas->TexUvScale.x, (r->Y + 0.5f) * atlas->TexUvScale.y); } static void ImFontAtlasBuildRenderLinesTexData(ImFontAtlas* atlas) { if (atlas->Flags & ImFontAtlasFlags_NoBakedLines) return; // This generates a triangular shape in the texture, with the various line widths stacked on top of each other to allow interpolation between them ImFontAtlasCustomRect* r = atlas->GetCustomRectByIndex(atlas->PackIdLines); IM_ASSERT(r->IsPacked()); for (int n = 0; n < IM_DRAWLIST_TEX_LINES_WIDTH_MAX + 1; n++) // +1 because of the zero-width row { // Each line consists of at least two empty pixels at the ends, with a line of solid pixels in the middle int y = n; int line_width = n; int pad_left = (r->Width - line_width) / 2; int pad_right = r->Width - (pad_left + line_width); // Write each slice IM_ASSERT(pad_left + line_width + pad_right == r->Width && y < r->Height); // Make sure we're inside the texture bounds before we start writing pixels if (atlas->TexPixelsAlpha8 != NULL) { unsigned char* write_ptr = &atlas->TexPixelsAlpha8[r->X + ((r->Y + y) * atlas->TexWidth)]; for (int i = 0; i < pad_left; i++) *(write_ptr + i) = 0x00; for (int i = 0; i < line_width; i++) *(write_ptr + pad_left + i) = 0xFF; for (int i = 0; i < pad_right; i++) *(write_ptr + pad_left + line_width + i) = 0x00; } else { unsigned int* write_ptr = &atlas->TexPixelsRGBA32[r->X + ((r->Y + y) * atlas->TexWidth)]; for (int i = 0; i < pad_left; i++) *(write_ptr + i) = IM_COL32(255, 255, 255, 0); for (int i = 0; i < line_width; i++) *(write_ptr + pad_left + i) = IM_COL32_WHITE; for (int i = 0; i < pad_right; i++) *(write_ptr + pad_left + line_width + i) = IM_COL32(255, 255, 255, 0); } // Calculate UVs for this line ImVec2 uv0 = ImVec2((float)(r->X + pad_left - 1), (float)(r->Y + y)) * atlas->TexUvScale; ImVec2 uv1 = ImVec2((float)(r->X + pad_left + line_width + 1), (float)(r->Y + y + 1)) * atlas->TexUvScale; float half_v = (uv0.y + uv1.y) * 0.5f; // Calculate a constant V in the middle of the row to avoid sampling artifacts atlas->TexUvLines[n] = ImVec4(uv0.x, half_v, uv1.x, half_v); } } // Note: this is called / shared by both the stb_truetype and the FreeType builder void ImFontAtlasBuildInit(ImFontAtlas* atlas) { // Register texture region for mouse cursors or standard white pixels if (atlas->PackIdMouseCursors < 0) { if (!(atlas->Flags & ImFontAtlasFlags_NoMouseCursors)) atlas->PackIdMouseCursors = atlas->AddCustomRectRegular(FONT_ATLAS_DEFAULT_TEX_DATA_W * 2 + 1, FONT_ATLAS_DEFAULT_TEX_DATA_H); else atlas->PackIdMouseCursors = atlas->AddCustomRectRegular(2, 2); } // Register texture region for thick lines // The +2 here is to give space for the end caps, whilst height +1 is to accommodate the fact we have a zero-width row if (atlas->PackIdLines < 0) { if (!(atlas->Flags & ImFontAtlasFlags_NoBakedLines)) atlas->PackIdLines = atlas->AddCustomRectRegular(IM_DRAWLIST_TEX_LINES_WIDTH_MAX + 2, IM_DRAWLIST_TEX_LINES_WIDTH_MAX + 1); } } // This is called/shared by both the stb_truetype and the FreeType builder. void ImFontAtlasBuildFinish(ImFontAtlas* atlas) { // Render into our custom data blocks IM_ASSERT(atlas->TexPixelsAlpha8 != NULL || atlas->TexPixelsRGBA32 != NULL); ImFontAtlasBuildRenderDefaultTexData(atlas); ImFontAtlasBuildRenderLinesTexData(atlas); // Register custom rectangle glyphs for (int i = 0; i < atlas->CustomRects.Size; i++) { const ImFontAtlasCustomRect* r = &atlas->CustomRects[i]; if (r->Font == NULL || r->GlyphID == 0) continue; // Will ignore ImFontConfig settings: GlyphMinAdvanceX, GlyphMinAdvanceY, PixelSnapH IM_ASSERT(r->Font->ContainerAtlas == atlas); ImVec2 uv0, uv1; atlas->CalcCustomRectUV(r, &uv0, &uv1); r->Font->AddGlyph(NULL, (ImWchar)r->GlyphID, r->GlyphOffset.x, r->GlyphOffset.y, r->GlyphOffset.x + r->Width, r->GlyphOffset.y + r->Height, uv0.x, uv0.y, uv1.x, uv1.y, r->GlyphAdvanceX); if (r->GlyphColored) r->Font->Glyphs.back().Colored = 1; } // Build all fonts lookup tables for (ImFont* font : atlas->Fonts) if (font->DirtyLookupTables) font->BuildLookupTable(); atlas->TexReady = true; } //------------------------------------------------------------------------- // [SECTION] ImFontAtlas: glyph ranges helpers //------------------------------------------------------------------------- // - GetGlyphRangesDefault() // - GetGlyphRangesGreek() // - GetGlyphRangesKorean() // - GetGlyphRangesChineseFull() // - GetGlyphRangesChineseSimplifiedCommon() // - GetGlyphRangesJapanese() // - GetGlyphRangesCyrillic() // - GetGlyphRangesThai() // - GetGlyphRangesVietnamese() //----------------------------------------------------------------------------- // Retrieve list of range (2 int per range, values are inclusive) const ImWchar* ImFontAtlas::GetGlyphRangesDefault() { static const ImWchar ranges[] = { 0x0020, 0x00FF, // Basic Latin + Latin Supplement 0, }; return &ranges[0]; } const ImWchar* ImFontAtlas::GetGlyphRangesGreek() { static const ImWchar ranges[] = { 0x0020, 0x00FF, // Basic Latin + Latin Supplement 0x0370, 0x03FF, // Greek and Coptic 0, }; return &ranges[0]; } const ImWchar* ImFontAtlas::GetGlyphRangesKorean() { static const ImWchar ranges[] = { 0x0020, 0x00FF, // Basic Latin + Latin Supplement 0x3131, 0x3163, // Korean alphabets 0xAC00, 0xD7A3, // Korean characters 0xFFFD, 0xFFFD, // Invalid 0, }; return &ranges[0]; } const ImWchar* ImFontAtlas::GetGlyphRangesChineseFull() { static const ImWchar ranges[] = { 0x0020, 0x00FF, // Basic Latin + Latin Supplement 0x2000, 0x206F, // General Punctuation 0x3000, 0x30FF, // CJK Symbols and Punctuations, Hiragana, Katakana 0x31F0, 0x31FF, // Katakana Phonetic Extensions 0xFF00, 0xFFEF, // Half-width characters 0xFFFD, 0xFFFD, // Invalid 0x4e00, 0x9FAF, // CJK Ideograms 0, }; return &ranges[0]; } static void UnpackAccumulativeOffsetsIntoRanges(int base_codepoint, const short* accumulative_offsets, int accumulative_offsets_count, ImWchar* out_ranges) { for (int n = 0; n < accumulative_offsets_count; n++, out_ranges += 2) { out_ranges[0] = out_ranges[1] = (ImWchar)(base_codepoint + accumulative_offsets[n]); base_codepoint += accumulative_offsets[n]; } out_ranges[0] = 0; } const ImWchar* ImFontAtlas::GetGlyphRangesChineseSimplifiedCommon() { // Store 2500 regularly used characters for Simplified Chinese. // Sourced from https://zh.wiktionary.org/wiki/%E9%99%84%E5%BD%95:%E7%8E%B0%E4%BB%A3%E6%B1%89%E8%AF%AD%E5%B8%B8%E7%94%A8%E5%AD%97%E8%A1%A8 // This table covers 97.97% of all characters used during the month in July, 1987. // You can use ImFontGlyphRangesBuilder to create your own ranges derived from this, by merging existing ranges or adding new characters. // (Stored as accumulative offsets from the initial unicode codepoint 0x4E00. This encoding is designed to helps us compact the source code size.) static const short accumulative_offsets_from_0x4E00[] = { 0,1,2,4,1,1,1,1,2,1,3,2,1,2,2,1,1,1,1,1,5,2,1,2,3,3,3,2,2,4,1,1,1,2,1,5,2,3,1,2,1,2,1,1,2,1,1,2,2,1,4,1,1,1,1,5,10,1,2,19,2,1,2,1,2,1,2,1,2, 1,5,1,6,3,2,1,2,2,1,1,1,4,8,5,1,1,4,1,1,3,1,2,1,5,1,2,1,1,1,10,1,1,5,2,4,6,1,4,2,2,2,12,2,1,1,6,1,1,1,4,1,1,4,6,5,1,4,2,2,4,10,7,1,1,4,2,4, 2,1,4,3,6,10,12,5,7,2,14,2,9,1,1,6,7,10,4,7,13,1,5,4,8,4,1,1,2,28,5,6,1,1,5,2,5,20,2,2,9,8,11,2,9,17,1,8,6,8,27,4,6,9,20,11,27,6,68,2,2,1,1, 1,2,1,2,2,7,6,11,3,3,1,1,3,1,2,1,1,1,1,1,3,1,1,8,3,4,1,5,7,2,1,4,4,8,4,2,1,2,1,1,4,5,6,3,6,2,12,3,1,3,9,2,4,3,4,1,5,3,3,1,3,7,1,5,1,1,1,1,2, 3,4,5,2,3,2,6,1,1,2,1,7,1,7,3,4,5,15,2,2,1,5,3,22,19,2,1,1,1,1,2,5,1,1,1,6,1,1,12,8,2,9,18,22,4,1,1,5,1,16,1,2,7,10,15,1,1,6,2,4,1,2,4,1,6, 1,1,3,2,4,1,6,4,5,1,2,1,1,2,1,10,3,1,3,2,1,9,3,2,5,7,2,19,4,3,6,1,1,1,1,1,4,3,2,1,1,1,2,5,3,1,1,1,2,2,1,1,2,1,1,2,1,3,1,1,1,3,7,1,4,1,1,2,1, 1,2,1,2,4,4,3,8,1,1,1,2,1,3,5,1,3,1,3,4,6,2,2,14,4,6,6,11,9,1,15,3,1,28,5,2,5,5,3,1,3,4,5,4,6,14,3,2,3,5,21,2,7,20,10,1,2,19,2,4,28,28,2,3, 2,1,14,4,1,26,28,42,12,40,3,52,79,5,14,17,3,2,2,11,3,4,6,3,1,8,2,23,4,5,8,10,4,2,7,3,5,1,1,6,3,1,2,2,2,5,28,1,1,7,7,20,5,3,29,3,17,26,1,8,4, 27,3,6,11,23,5,3,4,6,13,24,16,6,5,10,25,35,7,3,2,3,3,14,3,6,2,6,1,4,2,3,8,2,1,1,3,3,3,4,1,1,13,2,2,4,5,2,1,14,14,1,2,2,1,4,5,2,3,1,14,3,12, 3,17,2,16,5,1,2,1,8,9,3,19,4,2,2,4,17,25,21,20,28,75,1,10,29,103,4,1,2,1,1,4,2,4,1,2,3,24,2,2,2,1,1,2,1,3,8,1,1,1,2,1,1,3,1,1,1,6,1,5,3,1,1, 1,3,4,1,1,5,2,1,5,6,13,9,16,1,1,1,1,3,2,3,2,4,5,2,5,2,2,3,7,13,7,2,2,1,1,1,1,2,3,3,2,1,6,4,9,2,1,14,2,14,2,1,18,3,4,14,4,11,41,15,23,15,23, 176,1,3,4,1,1,1,1,5,3,1,2,3,7,3,1,1,2,1,2,4,4,6,2,4,1,9,7,1,10,5,8,16,29,1,1,2,2,3,1,3,5,2,4,5,4,1,1,2,2,3,3,7,1,6,10,1,17,1,44,4,6,2,1,1,6, 5,4,2,10,1,6,9,2,8,1,24,1,2,13,7,8,8,2,1,4,1,3,1,3,3,5,2,5,10,9,4,9,12,2,1,6,1,10,1,1,7,7,4,10,8,3,1,13,4,3,1,6,1,3,5,2,1,2,17,16,5,2,16,6, 1,4,2,1,3,3,6,8,5,11,11,1,3,3,2,4,6,10,9,5,7,4,7,4,7,1,1,4,2,1,3,6,8,7,1,6,11,5,5,3,24,9,4,2,7,13,5,1,8,82,16,61,1,1,1,4,2,2,16,10,3,8,1,1, 6,4,2,1,3,1,1,1,4,3,8,4,2,2,1,1,1,1,1,6,3,5,1,1,4,6,9,2,1,1,1,2,1,7,2,1,6,1,5,4,4,3,1,8,1,3,3,1,3,2,2,2,2,3,1,6,1,2,1,2,1,3,7,1,8,2,1,2,1,5, 2,5,3,5,10,1,2,1,1,3,2,5,11,3,9,3,5,1,1,5,9,1,2,1,5,7,9,9,8,1,3,3,3,6,8,2,3,2,1,1,32,6,1,2,15,9,3,7,13,1,3,10,13,2,14,1,13,10,2,1,3,10,4,15, 2,15,15,10,1,3,9,6,9,32,25,26,47,7,3,2,3,1,6,3,4,3,2,8,5,4,1,9,4,2,2,19,10,6,2,3,8,1,2,2,4,2,1,9,4,4,4,6,4,8,9,2,3,1,1,1,1,3,5,5,1,3,8,4,6, 2,1,4,12,1,5,3,7,13,2,5,8,1,6,1,2,5,14,6,1,5,2,4,8,15,5,1,23,6,62,2,10,1,1,8,1,2,2,10,4,2,2,9,2,1,1,3,2,3,1,5,3,3,2,1,3,8,1,1,1,11,3,1,1,4, 3,7,1,14,1,2,3,12,5,2,5,1,6,7,5,7,14,11,1,3,1,8,9,12,2,1,11,8,4,4,2,6,10,9,13,1,1,3,1,5,1,3,2,4,4,1,18,2,3,14,11,4,29,4,2,7,1,3,13,9,2,2,5, 3,5,20,7,16,8,5,72,34,6,4,22,12,12,28,45,36,9,7,39,9,191,1,1,1,4,11,8,4,9,2,3,22,1,1,1,1,4,17,1,7,7,1,11,31,10,2,4,8,2,3,2,1,4,2,16,4,32,2, 3,19,13,4,9,1,5,2,14,8,1,1,3,6,19,6,5,1,16,6,2,10,8,5,1,2,3,1,5,5,1,11,6,6,1,3,3,2,6,3,8,1,1,4,10,7,5,7,7,5,8,9,2,1,3,4,1,1,3,1,3,3,2,6,16, 1,4,6,3,1,10,6,1,3,15,2,9,2,10,25,13,9,16,6,2,2,10,11,4,3,9,1,2,6,6,5,4,30,40,1,10,7,12,14,33,6,3,6,7,3,1,3,1,11,14,4,9,5,12,11,49,18,51,31, 140,31,2,2,1,5,1,8,1,10,1,4,4,3,24,1,10,1,3,6,6,16,3,4,5,2,1,4,2,57,10,6,22,2,22,3,7,22,6,10,11,36,18,16,33,36,2,5,5,1,1,1,4,10,1,4,13,2,7, 5,2,9,3,4,1,7,43,3,7,3,9,14,7,9,1,11,1,1,3,7,4,18,13,1,14,1,3,6,10,73,2,2,30,6,1,11,18,19,13,22,3,46,42,37,89,7,3,16,34,2,2,3,9,1,7,1,1,1,2, 2,4,10,7,3,10,3,9,5,28,9,2,6,13,7,3,1,3,10,2,7,2,11,3,6,21,54,85,2,1,4,2,2,1,39,3,21,2,2,5,1,1,1,4,1,1,3,4,15,1,3,2,4,4,2,3,8,2,20,1,8,7,13, 4,1,26,6,2,9,34,4,21,52,10,4,4,1,5,12,2,11,1,7,2,30,12,44,2,30,1,1,3,6,16,9,17,39,82,2,2,24,7,1,7,3,16,9,14,44,2,1,2,1,2,3,5,2,4,1,6,7,5,3, 2,6,1,11,5,11,2,1,18,19,8,1,3,24,29,2,1,3,5,2,2,1,13,6,5,1,46,11,3,5,1,1,5,8,2,10,6,12,6,3,7,11,2,4,16,13,2,5,1,1,2,2,5,2,28,5,2,23,10,8,4, 4,22,39,95,38,8,14,9,5,1,13,5,4,3,13,12,11,1,9,1,27,37,2,5,4,4,63,211,95,2,2,2,1,3,5,2,1,1,2,2,1,1,1,3,2,4,1,2,1,1,5,2,2,1,1,2,3,1,3,1,1,1, 3,1,4,2,1,3,6,1,1,3,7,15,5,3,2,5,3,9,11,4,2,22,1,6,3,8,7,1,4,28,4,16,3,3,25,4,4,27,27,1,4,1,2,2,7,1,3,5,2,28,8,2,14,1,8,6,16,25,3,3,3,14,3, 3,1,1,2,1,4,6,3,8,4,1,1,1,2,3,6,10,6,2,3,18,3,2,5,5,4,3,1,5,2,5,4,23,7,6,12,6,4,17,11,9,5,1,1,10,5,12,1,1,11,26,33,7,3,6,1,17,7,1,5,12,1,11, 2,4,1,8,14,17,23,1,2,1,7,8,16,11,9,6,5,2,6,4,16,2,8,14,1,11,8,9,1,1,1,9,25,4,11,19,7,2,15,2,12,8,52,7,5,19,2,16,4,36,8,1,16,8,24,26,4,6,2,9, 5,4,36,3,28,12,25,15,37,27,17,12,59,38,5,32,127,1,2,9,17,14,4,1,2,1,1,8,11,50,4,14,2,19,16,4,17,5,4,5,26,12,45,2,23,45,104,30,12,8,3,10,2,2, 3,3,1,4,20,7,2,9,6,15,2,20,1,3,16,4,11,15,6,134,2,5,59,1,2,2,2,1,9,17,3,26,137,10,211,59,1,2,4,1,4,1,1,1,2,6,2,3,1,1,2,3,2,3,1,3,4,4,2,3,3, 1,4,3,1,7,2,2,3,1,2,1,3,3,3,2,2,3,2,1,3,14,6,1,3,2,9,6,15,27,9,34,145,1,1,2,1,1,1,1,2,1,1,1,1,2,2,2,3,1,2,1,1,1,2,3,5,8,3,5,2,4,1,3,2,2,2,12, 4,1,1,1,10,4,5,1,20,4,16,1,15,9,5,12,2,9,2,5,4,2,26,19,7,1,26,4,30,12,15,42,1,6,8,172,1,1,4,2,1,1,11,2,2,4,2,1,2,1,10,8,1,2,1,4,5,1,2,5,1,8, 4,1,3,4,2,1,6,2,1,3,4,1,2,1,1,1,1,12,5,7,2,4,3,1,1,1,3,3,6,1,2,2,3,3,3,2,1,2,12,14,11,6,6,4,12,2,8,1,7,10,1,35,7,4,13,15,4,3,23,21,28,52,5, 26,5,6,1,7,10,2,7,53,3,2,1,1,1,2,163,532,1,10,11,1,3,3,4,8,2,8,6,2,2,23,22,4,2,2,4,2,1,3,1,3,3,5,9,8,2,1,2,8,1,10,2,12,21,20,15,105,2,3,1,1, 3,2,3,1,1,2,5,1,4,15,11,19,1,1,1,1,5,4,5,1,1,2,5,3,5,12,1,2,5,1,11,1,1,15,9,1,4,5,3,26,8,2,1,3,1,1,15,19,2,12,1,2,5,2,7,2,19,2,20,6,26,7,5, 2,2,7,34,21,13,70,2,128,1,1,2,1,1,2,1,1,3,2,2,2,15,1,4,1,3,4,42,10,6,1,49,85,8,1,2,1,1,4,4,2,3,6,1,5,7,4,3,211,4,1,2,1,2,5,1,2,4,2,2,6,5,6, 10,3,4,48,100,6,2,16,296,5,27,387,2,2,3,7,16,8,5,38,15,39,21,9,10,3,7,59,13,27,21,47,5,21,6 }; static ImWchar base_ranges[] = // not zero-terminated { 0x0020, 0x00FF, // Basic Latin + Latin Supplement 0x2000, 0x206F, // General Punctuation 0x3000, 0x30FF, // CJK Symbols and Punctuations, Hiragana, Katakana 0x31F0, 0x31FF, // Katakana Phonetic Extensions 0xFF00, 0xFFEF, // Half-width characters 0xFFFD, 0xFFFD // Invalid }; static ImWchar full_ranges[IM_ARRAYSIZE(base_ranges) + IM_ARRAYSIZE(accumulative_offsets_from_0x4E00) * 2 + 1] = { 0 }; if (!full_ranges[0]) { memcpy(full_ranges, base_ranges, sizeof(base_ranges)); UnpackAccumulativeOffsetsIntoRanges(0x4E00, accumulative_offsets_from_0x4E00, IM_ARRAYSIZE(accumulative_offsets_from_0x4E00), full_ranges + IM_ARRAYSIZE(base_ranges)); } return &full_ranges[0]; } const ImWchar* ImFontAtlas::GetGlyphRangesJapanese() { // 2999 ideograms code points for Japanese // - 2136 Joyo (meaning "for regular use" or "for common use") Kanji code points // - 863 Jinmeiyo (meaning "for personal name") Kanji code points // - Sourced from official information provided by the government agencies of Japan: // - List of Joyo Kanji by the Agency for Cultural Affairs // - https://www.bunka.go.jp/kokugo_nihongo/sisaku/joho/joho/kijun/naikaku/kanji/ // - List of Jinmeiyo Kanji by the Ministry of Justice // - http://www.moj.go.jp/MINJI/minji86.html // - Available under the terms of the Creative Commons Attribution 4.0 International (CC BY 4.0). // - https://creativecommons.org/licenses/by/4.0/legalcode // - You can generate this code by the script at: // - https://github.com/vaiorabbit/everyday_use_kanji // - References: // - List of Joyo Kanji // - (Wikipedia) https://en.wikipedia.org/wiki/List_of_j%C5%8Dy%C5%8D_kanji // - List of Jinmeiyo Kanji // - (Wikipedia) https://en.wikipedia.org/wiki/Jinmeiy%C5%8D_kanji // - Missing 1 Joyo Kanji: U+20B9F (Kun'yomi: Shikaru, On'yomi: Shitsu,shichi), see https://github.com/ocornut/imgui/pull/3627 for details. // You can use ImFontGlyphRangesBuilder to create your own ranges derived from this, by merging existing ranges or adding new characters. // (Stored as accumulative offsets from the initial unicode codepoint 0x4E00. This encoding is designed to helps us compact the source code size.) static const short accumulative_offsets_from_0x4E00[] = { 0,1,2,4,1,1,1,1,2,1,3,3,2,2,1,5,3,5,7,5,6,1,2,1,7,2,6,3,1,8,1,1,4,1,1,18,2,11,2,6,2,1,2,1,5,1,2,1,3,1,2,1,2,3,3,1,1,2,3,1,1,1,12,7,9,1,4,5,1, 1,2,1,10,1,1,9,2,2,4,5,6,9,3,1,1,1,1,9,3,18,5,2,2,2,2,1,6,3,7,1,1,1,1,2,2,4,2,1,23,2,10,4,3,5,2,4,10,2,4,13,1,6,1,9,3,1,1,6,6,7,6,3,1,2,11,3, 2,2,3,2,15,2,2,5,4,3,6,4,1,2,5,2,12,16,6,13,9,13,2,1,1,7,16,4,7,1,19,1,5,1,2,2,7,7,8,2,6,5,4,9,18,7,4,5,9,13,11,8,15,2,1,1,1,2,1,2,2,1,2,2,8, 2,9,3,3,1,1,4,4,1,1,1,4,9,1,4,3,5,5,2,7,5,3,4,8,2,1,13,2,3,3,1,14,1,1,4,5,1,3,6,1,5,2,1,1,3,3,3,3,1,1,2,7,6,6,7,1,4,7,6,1,1,1,1,1,12,3,3,9,5, 2,6,1,5,6,1,2,3,18,2,4,14,4,1,3,6,1,1,6,3,5,5,3,2,2,2,2,12,3,1,4,2,3,2,3,11,1,7,4,1,2,1,3,17,1,9,1,24,1,1,4,2,2,4,1,2,7,1,1,1,3,1,2,2,4,15,1, 1,2,1,1,2,1,5,2,5,20,2,5,9,1,10,8,7,6,1,1,1,1,1,1,6,2,1,2,8,1,1,1,1,5,1,1,3,1,1,1,1,3,1,1,12,4,1,3,1,1,1,1,1,10,3,1,7,5,13,1,2,3,4,6,1,1,30, 2,9,9,1,15,38,11,3,1,8,24,7,1,9,8,10,2,1,9,31,2,13,6,2,9,4,49,5,2,15,2,1,10,2,1,1,1,2,2,6,15,30,35,3,14,18,8,1,16,10,28,12,19,45,38,1,3,2,3, 13,2,1,7,3,6,5,3,4,3,1,5,7,8,1,5,3,18,5,3,6,1,21,4,24,9,24,40,3,14,3,21,3,2,1,2,4,2,3,1,15,15,6,5,1,1,3,1,5,6,1,9,7,3,3,2,1,4,3,8,21,5,16,4, 5,2,10,11,11,3,6,3,2,9,3,6,13,1,2,1,1,1,1,11,12,6,6,1,4,2,6,5,2,1,1,3,3,6,13,3,1,1,5,1,2,3,3,14,2,1,2,2,2,5,1,9,5,1,1,6,12,3,12,3,4,13,2,14, 2,8,1,17,5,1,16,4,2,2,21,8,9,6,23,20,12,25,19,9,38,8,3,21,40,25,33,13,4,3,1,4,1,2,4,1,2,5,26,2,1,1,2,1,3,6,2,1,1,1,1,1,1,2,3,1,1,1,9,2,3,1,1, 1,3,6,3,2,1,1,6,6,1,8,2,2,2,1,4,1,2,3,2,7,3,2,4,1,2,1,2,2,1,1,1,1,1,3,1,2,5,4,10,9,4,9,1,1,1,1,1,1,5,3,2,1,6,4,9,6,1,10,2,31,17,8,3,7,5,40,1, 7,7,1,6,5,2,10,7,8,4,15,39,25,6,28,47,18,10,7,1,3,1,1,2,1,1,1,3,3,3,1,1,1,3,4,2,1,4,1,3,6,10,7,8,6,2,2,1,3,3,2,5,8,7,9,12,2,15,1,1,4,1,2,1,1, 1,3,2,1,3,3,5,6,2,3,2,10,1,4,2,8,1,1,1,11,6,1,21,4,16,3,1,3,1,4,2,3,6,5,1,3,1,1,3,3,4,6,1,1,10,4,2,7,10,4,7,4,2,9,4,3,1,1,1,4,1,8,3,4,1,3,1, 6,1,4,2,1,4,7,2,1,8,1,4,5,1,1,2,2,4,6,2,7,1,10,1,1,3,4,11,10,8,21,4,6,1,3,5,2,1,2,28,5,5,2,3,13,1,2,3,1,4,2,1,5,20,3,8,11,1,3,3,3,1,8,10,9,2, 10,9,2,3,1,1,2,4,1,8,3,6,1,7,8,6,11,1,4,29,8,4,3,1,2,7,13,1,4,1,6,2,6,12,12,2,20,3,2,3,6,4,8,9,2,7,34,5,1,18,6,1,1,4,4,5,7,9,1,2,2,4,3,4,1,7, 2,2,2,6,2,3,25,5,3,6,1,4,6,7,4,2,1,4,2,13,6,4,4,3,1,5,3,4,4,3,2,1,1,4,1,2,1,1,3,1,11,1,6,3,1,7,3,6,2,8,8,6,9,3,4,11,3,2,10,12,2,5,11,1,6,4,5, 3,1,8,5,4,6,6,3,5,1,1,3,2,1,2,2,6,17,12,1,10,1,6,12,1,6,6,19,9,6,16,1,13,4,4,15,7,17,6,11,9,15,12,6,7,2,1,2,2,15,9,3,21,4,6,49,18,7,3,2,3,1, 6,8,2,2,6,2,9,1,3,6,4,4,1,2,16,2,5,2,1,6,2,3,5,3,1,2,5,1,2,1,9,3,1,8,6,4,8,11,3,1,1,1,1,3,1,13,8,4,1,3,2,2,1,4,1,11,1,5,2,1,5,2,5,8,6,1,1,7, 4,3,8,3,2,7,2,1,5,1,5,2,4,7,6,2,8,5,1,11,4,5,3,6,18,1,2,13,3,3,1,21,1,1,4,1,4,1,1,1,8,1,2,2,7,1,2,4,2,2,9,2,1,1,1,4,3,6,3,12,5,1,1,1,5,6,3,2, 4,8,2,2,4,2,7,1,8,9,5,2,3,2,1,3,2,13,7,14,6,5,1,1,2,1,4,2,23,2,1,1,6,3,1,4,1,15,3,1,7,3,9,14,1,3,1,4,1,1,5,8,1,3,8,3,8,15,11,4,14,4,4,2,5,5, 1,7,1,6,14,7,7,8,5,15,4,8,6,5,6,2,1,13,1,20,15,11,9,2,5,6,2,11,2,6,2,5,1,5,8,4,13,19,25,4,1,1,11,1,34,2,5,9,14,6,2,2,6,1,1,14,1,3,14,13,1,6, 12,21,14,14,6,32,17,8,32,9,28,1,2,4,11,8,3,1,14,2,5,15,1,1,1,1,3,6,4,1,3,4,11,3,1,1,11,30,1,5,1,4,1,5,8,1,1,3,2,4,3,17,35,2,6,12,17,3,1,6,2, 1,1,12,2,7,3,3,2,1,16,2,8,3,6,5,4,7,3,3,8,1,9,8,5,1,2,1,3,2,8,1,2,9,12,1,1,2,3,8,3,24,12,4,3,7,5,8,3,3,3,3,3,3,1,23,10,3,1,2,2,6,3,1,16,1,16, 22,3,10,4,11,6,9,7,7,3,6,2,2,2,4,10,2,1,1,2,8,7,1,6,4,1,3,3,3,5,10,12,12,2,3,12,8,15,1,1,16,6,6,1,5,9,11,4,11,4,2,6,12,1,17,5,13,1,4,9,5,1,11, 2,1,8,1,5,7,28,8,3,5,10,2,17,3,38,22,1,2,18,12,10,4,38,18,1,4,44,19,4,1,8,4,1,12,1,4,31,12,1,14,7,75,7,5,10,6,6,13,3,2,11,11,3,2,5,28,15,6,18, 18,5,6,4,3,16,1,7,18,7,36,3,5,3,1,7,1,9,1,10,7,2,4,2,6,2,9,7,4,3,32,12,3,7,10,2,23,16,3,1,12,3,31,4,11,1,3,8,9,5,1,30,15,6,12,3,2,2,11,19,9, 14,2,6,2,3,19,13,17,5,3,3,25,3,14,1,1,1,36,1,3,2,19,3,13,36,9,13,31,6,4,16,34,2,5,4,2,3,3,5,1,1,1,4,3,1,17,3,2,3,5,3,1,3,2,3,5,6,3,12,11,1,3, 1,2,26,7,12,7,2,14,3,3,7,7,11,25,25,28,16,4,36,1,2,1,6,2,1,9,3,27,17,4,3,4,13,4,1,3,2,2,1,10,4,2,4,6,3,8,2,1,18,1,1,24,2,2,4,33,2,3,63,7,1,6, 40,7,3,4,4,2,4,15,18,1,16,1,1,11,2,41,14,1,3,18,13,3,2,4,16,2,17,7,15,24,7,18,13,44,2,2,3,6,1,1,7,5,1,7,1,4,3,3,5,10,8,2,3,1,8,1,1,27,4,2,1, 12,1,2,1,10,6,1,6,7,5,2,3,7,11,5,11,3,6,6,2,3,15,4,9,1,1,2,1,2,11,2,8,12,8,5,4,2,3,1,5,2,2,1,14,1,12,11,4,1,11,17,17,4,3,2,5,5,7,3,1,5,9,9,8, 2,5,6,6,13,13,2,1,2,6,1,2,2,49,4,9,1,2,10,16,7,8,4,3,2,23,4,58,3,29,1,14,19,19,11,11,2,7,5,1,3,4,6,2,18,5,12,12,17,17,3,3,2,4,1,6,2,3,4,3,1, 1,1,1,5,1,1,9,1,3,1,3,6,1,8,1,1,2,6,4,14,3,1,4,11,4,1,3,32,1,2,4,13,4,1,2,4,2,1,3,1,11,1,4,2,1,4,4,6,3,5,1,6,5,7,6,3,23,3,5,3,5,3,3,13,3,9,10, 1,12,10,2,3,18,13,7,160,52,4,2,2,3,2,14,5,4,12,4,6,4,1,20,4,11,6,2,12,27,1,4,1,2,2,7,4,5,2,28,3,7,25,8,3,19,3,6,10,2,2,1,10,2,5,4,1,3,4,1,5, 3,2,6,9,3,6,2,16,3,3,16,4,5,5,3,2,1,2,16,15,8,2,6,21,2,4,1,22,5,8,1,1,21,11,2,1,11,11,19,13,12,4,2,3,2,3,6,1,8,11,1,4,2,9,5,2,1,11,2,9,1,1,2, 14,31,9,3,4,21,14,4,8,1,7,2,2,2,5,1,4,20,3,3,4,10,1,11,9,8,2,1,4,5,14,12,14,2,17,9,6,31,4,14,1,20,13,26,5,2,7,3,6,13,2,4,2,19,6,2,2,18,9,3,5, 12,12,14,4,6,2,3,6,9,5,22,4,5,25,6,4,8,5,2,6,27,2,35,2,16,3,7,8,8,6,6,5,9,17,2,20,6,19,2,13,3,1,1,1,4,17,12,2,14,7,1,4,18,12,38,33,2,10,1,1, 2,13,14,17,11,50,6,33,20,26,74,16,23,45,50,13,38,33,6,6,7,4,4,2,1,3,2,5,8,7,8,9,3,11,21,9,13,1,3,10,6,7,1,2,2,18,5,5,1,9,9,2,68,9,19,13,2,5, 1,4,4,7,4,13,3,9,10,21,17,3,26,2,1,5,2,4,5,4,1,7,4,7,3,4,2,1,6,1,1,20,4,1,9,2,2,1,3,3,2,3,2,1,1,1,20,2,3,1,6,2,3,6,2,4,8,1,3,2,10,3,5,3,4,4, 3,4,16,1,6,1,10,2,4,2,1,1,2,10,11,2,2,3,1,24,31,4,10,10,2,5,12,16,164,15,4,16,7,9,15,19,17,1,2,1,1,5,1,1,1,1,1,3,1,4,3,1,3,1,3,1,2,1,1,3,3,7, 2,8,1,2,2,2,1,3,4,3,7,8,12,92,2,10,3,1,3,14,5,25,16,42,4,7,7,4,2,21,5,27,26,27,21,25,30,31,2,1,5,13,3,22,5,6,6,11,9,12,1,5,9,7,5,5,22,60,3,5, 13,1,1,8,1,1,3,3,2,1,9,3,3,18,4,1,2,3,7,6,3,1,2,3,9,1,3,1,3,2,1,3,1,1,1,2,1,11,3,1,6,9,1,3,2,3,1,2,1,5,1,1,4,3,4,1,2,2,4,4,1,7,2,1,2,2,3,5,13, 18,3,4,14,9,9,4,16,3,7,5,8,2,6,48,28,3,1,1,4,2,14,8,2,9,2,1,15,2,4,3,2,10,16,12,8,7,1,1,3,1,1,1,2,7,4,1,6,4,38,39,16,23,7,15,15,3,2,12,7,21, 37,27,6,5,4,8,2,10,8,8,6,5,1,2,1,3,24,1,16,17,9,23,10,17,6,1,51,55,44,13,294,9,3,6,2,4,2,2,15,1,1,1,13,21,17,68,14,8,9,4,1,4,9,3,11,7,1,1,1, 5,6,3,2,1,1,1,2,3,8,1,2,2,4,1,5,5,2,1,4,3,7,13,4,1,4,1,3,1,1,1,5,5,10,1,6,1,5,2,1,5,2,4,1,4,5,7,3,18,2,9,11,32,4,3,3,2,4,7,11,16,9,11,8,13,38, 32,8,4,2,1,1,2,1,2,4,4,1,1,1,4,1,21,3,11,1,16,1,1,6,1,3,2,4,9,8,57,7,44,1,3,3,13,3,10,1,1,7,5,2,7,21,47,63,3,15,4,7,1,16,1,1,2,8,2,3,42,15,4, 1,29,7,22,10,3,78,16,12,20,18,4,67,11,5,1,3,15,6,21,31,32,27,18,13,71,35,5,142,4,10,1,2,50,19,33,16,35,37,16,19,27,7,1,133,19,1,4,8,7,20,1,4, 4,1,10,3,1,6,1,2,51,5,40,15,24,43,22928,11,1,13,154,70,3,1,1,7,4,10,1,2,1,1,2,1,2,1,2,2,1,1,2,1,1,1,1,1,2,1,1,1,1,1,1,1,1,1,1,1,1,1,2,1,1,1, 3,2,1,1,1,1,2,1,1, }; static ImWchar base_ranges[] = // not zero-terminated { 0x0020, 0x00FF, // Basic Latin + Latin Supplement 0x3000, 0x30FF, // CJK Symbols and Punctuations, Hiragana, Katakana 0x31F0, 0x31FF, // Katakana Phonetic Extensions 0xFF00, 0xFFEF, // Half-width characters 0xFFFD, 0xFFFD // Invalid }; static ImWchar full_ranges[IM_ARRAYSIZE(base_ranges) + IM_ARRAYSIZE(accumulative_offsets_from_0x4E00)*2 + 1] = { 0 }; if (!full_ranges[0]) { memcpy(full_ranges, base_ranges, sizeof(base_ranges)); UnpackAccumulativeOffsetsIntoRanges(0x4E00, accumulative_offsets_from_0x4E00, IM_ARRAYSIZE(accumulative_offsets_from_0x4E00), full_ranges + IM_ARRAYSIZE(base_ranges)); } return &full_ranges[0]; } const ImWchar* ImFontAtlas::GetGlyphRangesCyrillic() { static const ImWchar ranges[] = { 0x0020, 0x00FF, // Basic Latin + Latin Supplement 0x0400, 0x052F, // Cyrillic + Cyrillic Supplement 0x2DE0, 0x2DFF, // Cyrillic Extended-A 0xA640, 0xA69F, // Cyrillic Extended-B 0, }; return &ranges[0]; } const ImWchar* ImFontAtlas::GetGlyphRangesThai() { static const ImWchar ranges[] = { 0x0020, 0x00FF, // Basic Latin 0x2010, 0x205E, // Punctuations 0x0E00, 0x0E7F, // Thai 0, }; return &ranges[0]; } const ImWchar* ImFontAtlas::GetGlyphRangesVietnamese() { static const ImWchar ranges[] = { 0x0020, 0x00FF, // Basic Latin 0x0102, 0x0103, 0x0110, 0x0111, 0x0128, 0x0129, 0x0168, 0x0169, 0x01A0, 0x01A1, 0x01AF, 0x01B0, 0x1EA0, 0x1EF9, 0, }; return &ranges[0]; } //----------------------------------------------------------------------------- // [SECTION] ImFontGlyphRangesBuilder //----------------------------------------------------------------------------- void ImFontGlyphRangesBuilder::AddText(const char* text, const char* text_end) { while (text_end ? (text < text_end) : *text) { unsigned int c = 0; int c_len = ImTextCharFromUtf8(&c, text, text_end); text += c_len; if (c_len == 0) break; AddChar((ImWchar)c); } } void ImFontGlyphRangesBuilder::AddRanges(const ImWchar* ranges) { for (; ranges[0]; ranges += 2) for (unsigned int c = ranges[0]; c <= ranges[1] && c <= IM_UNICODE_CODEPOINT_MAX; c++) //-V560 AddChar((ImWchar)c); } void ImFontGlyphRangesBuilder::BuildRanges(ImVector* out_ranges) { const int max_codepoint = IM_UNICODE_CODEPOINT_MAX; for (int n = 0; n <= max_codepoint; n++) if (GetBit(n)) { out_ranges->push_back((ImWchar)n); while (n < max_codepoint && GetBit(n + 1)) n++; out_ranges->push_back((ImWchar)n); } out_ranges->push_back(0); } //----------------------------------------------------------------------------- // [SECTION] ImFont //----------------------------------------------------------------------------- ImFont::ImFont() { memset(this, 0, sizeof(*this)); Scale = 1.0f; } ImFont::~ImFont() { ClearOutputData(); } void ImFont::ClearOutputData() { FontSize = 0.0f; FallbackAdvanceX = 0.0f; Glyphs.clear(); IndexAdvanceX.clear(); IndexLookup.clear(); FallbackGlyph = NULL; ContainerAtlas = NULL; DirtyLookupTables = true; Ascent = Descent = 0.0f; MetricsTotalSurface = 0; memset(Used8kPagesMap, 0, sizeof(Used8kPagesMap)); } static ImWchar FindFirstExistingGlyph(ImFont* font, const ImWchar* candidate_chars, int candidate_chars_count) { for (int n = 0; n < candidate_chars_count; n++) if (font->FindGlyphNoFallback(candidate_chars[n]) != NULL) return candidate_chars[n]; return 0; } void ImFont::BuildLookupTable() { int max_codepoint = 0; for (int i = 0; i != Glyphs.Size; i++) max_codepoint = ImMax(max_codepoint, (int)Glyphs[i].Codepoint); // Build lookup table IM_ASSERT(Glyphs.Size > 0 && "Font has not loaded glyph!"); IM_ASSERT(Glyphs.Size < 0xFFFF); // -1 is reserved IndexAdvanceX.clear(); IndexLookup.clear(); DirtyLookupTables = false; memset(Used8kPagesMap, 0, sizeof(Used8kPagesMap)); GrowIndex(max_codepoint + 1); for (int i = 0; i < Glyphs.Size; i++) { int codepoint = (int)Glyphs[i].Codepoint; IndexAdvanceX[codepoint] = Glyphs[i].AdvanceX; IndexLookup[codepoint] = (ImU16)i; // Mark 4K page as used const int page_n = codepoint / 8192; Used8kPagesMap[page_n >> 3] |= 1 << (page_n & 7); } // Create a glyph to handle TAB // FIXME: Needs proper TAB handling but it needs to be contextualized (or we could arbitrary say that each string starts at "column 0" ?) if (FindGlyph((ImWchar)' ')) { if (Glyphs.back().Codepoint != '\t') // So we can call this function multiple times (FIXME: Flaky) Glyphs.resize(Glyphs.Size + 1); ImFontGlyph& tab_glyph = Glyphs.back(); tab_glyph = *FindGlyph((ImWchar)' '); tab_glyph.Codepoint = '\t'; tab_glyph.AdvanceX *= IM_TABSIZE; IndexAdvanceX[(int)tab_glyph.Codepoint] = (float)tab_glyph.AdvanceX; IndexLookup[(int)tab_glyph.Codepoint] = (ImU16)(Glyphs.Size - 1); } // Mark special glyphs as not visible (note that AddGlyph already mark as non-visible glyphs with zero-size polygons) if (ImFontGlyph* glyph = (ImFontGlyph*)(void*)FindGlyph((ImWchar)' ')) glyph->Visible = false; if (ImFontGlyph* glyph = (ImFontGlyph*)(void*)FindGlyph((ImWchar)'\t')) glyph->Visible = false; // Setup Fallback character const ImWchar fallback_chars[] = { (ImWchar)IM_UNICODE_CODEPOINT_INVALID, (ImWchar)'?', (ImWchar)' ' }; FallbackGlyph = FindGlyphNoFallback(FallbackChar); if (FallbackGlyph == NULL) { FallbackChar = FindFirstExistingGlyph(this, fallback_chars, IM_ARRAYSIZE(fallback_chars)); FallbackGlyph = FindGlyphNoFallback(FallbackChar); if (FallbackGlyph == NULL) { FallbackGlyph = &Glyphs.back(); FallbackChar = (ImWchar)FallbackGlyph->Codepoint; } } FallbackAdvanceX = FallbackGlyph->AdvanceX; for (int i = 0; i < max_codepoint + 1; i++) if (IndexAdvanceX[i] < 0.0f) IndexAdvanceX[i] = FallbackAdvanceX; // Setup Ellipsis character. It is required for rendering elided text. We prefer using U+2026 (horizontal ellipsis). // However some old fonts may contain ellipsis at U+0085. Here we auto-detect most suitable ellipsis character. // FIXME: Note that 0x2026 is rarely included in our font ranges. Because of this we are more likely to use three individual dots. const ImWchar ellipsis_chars[] = { Sources->EllipsisChar, (ImWchar)0x2026, (ImWchar)0x0085 }; const ImWchar dots_chars[] = { (ImWchar)'.', (ImWchar)0xFF0E }; if (EllipsisChar == 0) EllipsisChar = FindFirstExistingGlyph(this, ellipsis_chars, IM_ARRAYSIZE(ellipsis_chars)); const ImWchar dot_char = FindFirstExistingGlyph(this, dots_chars, IM_ARRAYSIZE(dots_chars)); if (EllipsisChar != 0) { EllipsisCharCount = 1; EllipsisWidth = EllipsisCharStep = FindGlyph(EllipsisChar)->X1; } else if (dot_char != 0) { const ImFontGlyph* dot_glyph = FindGlyph(dot_char); EllipsisChar = dot_char; EllipsisCharCount = 3; EllipsisCharStep = (float)(int)(dot_glyph->X1 - dot_glyph->X0) + 1.0f; EllipsisWidth = ImMax(dot_glyph->AdvanceX, dot_glyph->X0 + EllipsisCharStep * 3.0f - 1.0f); // FIXME: Slightly odd for normally mono-space fonts but since this is used for trailing contents. } } // API is designed this way to avoid exposing the 8K page size // e.g. use with IsGlyphRangeUnused(0, 255) bool ImFont::IsGlyphRangeUnused(unsigned int c_begin, unsigned int c_last) { unsigned int page_begin = (c_begin / 8192); unsigned int page_last = (c_last / 8192); for (unsigned int page_n = page_begin; page_n <= page_last; page_n++) if ((page_n >> 3) < sizeof(Used8kPagesMap)) if (Used8kPagesMap[page_n >> 3] & (1 << (page_n & 7))) return false; return true; } void ImFont::GrowIndex(int new_size) { IM_ASSERT(IndexAdvanceX.Size == IndexLookup.Size); if (new_size <= IndexLookup.Size) return; IndexAdvanceX.resize(new_size, -1.0f); IndexLookup.resize(new_size, (ImU16)-1); } // x0/y0/x1/y1 are offset from the character upper-left layout position, in pixels. Therefore x0/y0 are often fairly close to zero. // Not to be mistaken with texture coordinates, which are held by u0/v0/u1/v1 in normalized format (0.0..1.0 on each texture axis). // 'src' is not necessarily == 'this->Sources' because multiple source fonts+configs can be used to build one target font. void ImFont::AddGlyph(const ImFontConfig* src, ImWchar codepoint, float x0, float y0, float x1, float y1, float u0, float v0, float u1, float v1, float advance_x) { if (src != NULL) { // Clamp & recenter if needed const float advance_x_original = advance_x; advance_x = ImClamp(advance_x, src->GlyphMinAdvanceX, src->GlyphMaxAdvanceX); if (advance_x != advance_x_original) { float char_off_x = src->PixelSnapH ? ImTrunc((advance_x - advance_x_original) * 0.5f) : (advance_x - advance_x_original) * 0.5f; x0 += char_off_x; x1 += char_off_x; } // Snap to pixel if (src->PixelSnapH) advance_x = IM_ROUND(advance_x); // Bake extra spacing advance_x += src->GlyphExtraAdvanceX; } int glyph_idx = Glyphs.Size; Glyphs.resize(Glyphs.Size + 1); ImFontGlyph& glyph = Glyphs[glyph_idx]; glyph.Codepoint = (unsigned int)codepoint; glyph.Visible = (x0 != x1) && (y0 != y1); glyph.Colored = false; glyph.X0 = x0; glyph.Y0 = y0; glyph.X1 = x1; glyph.Y1 = y1; glyph.U0 = u0; glyph.V0 = v0; glyph.U1 = u1; glyph.V1 = v1; glyph.AdvanceX = advance_x; IM_ASSERT(Glyphs.Size < 0xFFFF); // IndexLookup[] hold 16-bit values and -1 is reserved. // Compute rough surface usage metrics (+1 to account for average padding, +0.99 to round) // We use (U1-U0)*TexWidth instead of X1-X0 to account for oversampling. float pad = ContainerAtlas->TexGlyphPadding + 0.99f; DirtyLookupTables = true; MetricsTotalSurface += (int)((glyph.U1 - glyph.U0) * ContainerAtlas->TexWidth + pad) * (int)((glyph.V1 - glyph.V0) * ContainerAtlas->TexHeight + pad); } void ImFont::AddRemapChar(ImWchar dst, ImWchar src, bool overwrite_dst) { IM_ASSERT(IndexLookup.Size > 0); // Currently this can only be called AFTER the font has been built, aka after calling ImFontAtlas::GetTexDataAs*() function. unsigned int index_size = (unsigned int)IndexLookup.Size; if (dst < index_size && IndexLookup.Data[dst] == (ImU16)-1 && !overwrite_dst) // 'dst' already exists return; if (src >= index_size && dst >= index_size) // both 'dst' and 'src' don't exist -> no-op return; GrowIndex(dst + 1); IndexLookup[dst] = (src < index_size) ? IndexLookup.Data[src] : (ImU16)-1; IndexAdvanceX[dst] = (src < index_size) ? IndexAdvanceX.Data[src] : 1.0f; } // Find glyph, return fallback if missing ImFontGlyph* ImFont::FindGlyph(ImWchar c) { if (c >= (size_t)IndexLookup.Size) return FallbackGlyph; const ImU16 i = IndexLookup.Data[c]; if (i == (ImU16)-1) return FallbackGlyph; return &Glyphs.Data[i]; } ImFontGlyph* ImFont::FindGlyphNoFallback(ImWchar c) { if (c >= (size_t)IndexLookup.Size) return NULL; const ImU16 i = IndexLookup.Data[c]; if (i == (ImU16)-1) return NULL; return &Glyphs.Data[i]; } // Trim trailing space and find beginning of next line static inline const char* CalcWordWrapNextLineStartA(const char* text, const char* text_end) { while (text < text_end && ImCharIsBlankA(*text)) text++; if (*text == '\n') text++; return text; } #define ImFontGetCharAdvanceX(_FONT, _CH) ((int)(_CH) < (_FONT)->IndexAdvanceX.Size ? (_FONT)->IndexAdvanceX.Data[_CH] : (_FONT)->FallbackAdvanceX) // Simple word-wrapping for English, not full-featured. Please submit failing cases! // This will return the next location to wrap from. If no wrapping if necessary, this will fast-forward to e.g. text_end. // FIXME: Much possible improvements (don't cut things like "word !", "word!!!" but cut within "word,,,,", more sensible support for punctuations, support for Unicode punctuations, etc.) const char* ImFont::CalcWordWrapPositionA(float scale, const char* text, const char* text_end, float wrap_width) { // For references, possible wrap point marked with ^ // "aaa bbb, ccc,ddd. eee fff. ggg!" // ^ ^ ^ ^ ^__ ^ ^ // List of hardcoded separators: .,;!?'" // Skip extra blanks after a line returns (that includes not counting them in width computation) // e.g. "Hello world" --> "Hello" "World" // Cut words that cannot possibly fit within one line. // e.g.: "The tropical fish" with ~5 characters worth of width --> "The tr" "opical" "fish" float line_width = 0.0f; float word_width = 0.0f; float blank_width = 0.0f; wrap_width /= scale; // We work with unscaled widths to avoid scaling every characters const char* word_end = text; const char* prev_word_end = NULL; bool inside_word = true; const char* s = text; IM_ASSERT(text_end != NULL); while (s < text_end) { unsigned int c = (unsigned int)*s; const char* next_s; if (c < 0x80) next_s = s + 1; else next_s = s + ImTextCharFromUtf8(&c, s, text_end); if (c < 32) { if (c == '\n') { line_width = word_width = blank_width = 0.0f; inside_word = true; s = next_s; continue; } if (c == '\r') { s = next_s; continue; } } const float char_width = ImFontGetCharAdvanceX(this, c); if (ImCharIsBlankW(c)) { if (inside_word) { line_width += blank_width; blank_width = 0.0f; word_end = s; } blank_width += char_width; inside_word = false; } else { word_width += char_width; if (inside_word) { word_end = next_s; } else { prev_word_end = word_end; line_width += word_width + blank_width; word_width = blank_width = 0.0f; } // Allow wrapping after punctuation. inside_word = (c != '.' && c != ',' && c != ';' && c != '!' && c != '?' && c != '\"'); } // We ignore blank width at the end of the line (they can be skipped) if (line_width + word_width > wrap_width) { // Words that cannot possibly fit within an entire line will be cut anywhere. if (word_width < wrap_width) s = prev_word_end ? prev_word_end : word_end; break; } s = next_s; } // Wrap_width is too small to fit anything. Force displaying 1 character to minimize the height discontinuity. // +1 may not be a character start point in UTF-8 but it's ok because caller loops use (text >= word_wrap_eol). if (s == text && text < text_end) return s + 1; return s; } ImVec2 ImFont::CalcTextSizeA(float size, float max_width, float wrap_width, const char* text_begin, const char* text_end, const char** remaining) { if (!text_end) text_end = text_begin + ImStrlen(text_begin); // FIXME-OPT: Need to avoid this. const float line_height = size; const float scale = size / FontSize; ImVec2 text_size = ImVec2(0, 0); float line_width = 0.0f; const bool word_wrap_enabled = (wrap_width > 0.0f); const char* word_wrap_eol = NULL; const char* s = text_begin; while (s < text_end) { if (word_wrap_enabled) { // Calculate how far we can render. Requires two passes on the string data but keeps the code simple and not intrusive for what's essentially an uncommon feature. if (!word_wrap_eol) word_wrap_eol = CalcWordWrapPositionA(scale, s, text_end, wrap_width - line_width); if (s >= word_wrap_eol) { if (text_size.x < line_width) text_size.x = line_width; text_size.y += line_height; line_width = 0.0f; word_wrap_eol = NULL; s = CalcWordWrapNextLineStartA(s, text_end); // Wrapping skips upcoming blanks continue; } } // Decode and advance source const char* prev_s = s; unsigned int c = (unsigned int)*s; if (c < 0x80) s += 1; else s += ImTextCharFromUtf8(&c, s, text_end); if (c < 32) { if (c == '\n') { text_size.x = ImMax(text_size.x, line_width); text_size.y += line_height; line_width = 0.0f; continue; } if (c == '\r') continue; } const float char_width = ImFontGetCharAdvanceX(this, c) * scale; if (line_width + char_width >= max_width) { s = prev_s; break; } line_width += char_width; } if (text_size.x < line_width) text_size.x = line_width; if (line_width > 0 || text_size.y == 0.0f) text_size.y += line_height; if (remaining) *remaining = s; return text_size; } // Note: as with every ImDrawList drawing function, this expects that the font atlas texture is bound. void ImFont::RenderChar(ImDrawList* draw_list, float size, const ImVec2& pos, ImU32 col, ImWchar c) { const ImFontGlyph* glyph = FindGlyph(c); if (!glyph || !glyph->Visible) return; if (glyph->Colored) col |= ~IM_COL32_A_MASK; float scale = (size >= 0.0f) ? (size / FontSize) : 1.0f; float x = IM_TRUNC(pos.x); float y = IM_TRUNC(pos.y); draw_list->PrimReserve(6, 4); draw_list->PrimRectUV(ImVec2(x + glyph->X0 * scale, y + glyph->Y0 * scale), ImVec2(x + glyph->X1 * scale, y + glyph->Y1 * scale), ImVec2(glyph->U0, glyph->V0), ImVec2(glyph->U1, glyph->V1), col); } // Note: as with every ImDrawList drawing function, this expects that the font atlas texture is bound. void ImFont::RenderText(ImDrawList* draw_list, float size, const ImVec2& pos, ImU32 col, const ImVec4& clip_rect, const char* text_begin, const char* text_end, float wrap_width, bool cpu_fine_clip) { // Align to be pixel perfect float x = IM_TRUNC(pos.x); float y = IM_TRUNC(pos.y); if (y > clip_rect.w) return; if (!text_end) text_end = text_begin + ImStrlen(text_begin); // ImGui:: functions generally already provides a valid text_end, so this is merely to handle direct calls. const float scale = size / FontSize; const float line_height = FontSize * scale; const float origin_x = x; const bool word_wrap_enabled = (wrap_width > 0.0f); // Fast-forward to first visible line const char* s = text_begin; if (y + line_height < clip_rect.y) while (y + line_height < clip_rect.y && s < text_end) { const char* line_end = (const char*)ImMemchr(s, '\n', text_end - s); if (word_wrap_enabled) { // FIXME-OPT: This is not optimal as do first do a search for \n before calling CalcWordWrapPositionA(). // If the specs for CalcWordWrapPositionA() were reworked to optionally return on \n we could combine both. // However it is still better than nothing performing the fast-forward! s = CalcWordWrapPositionA(scale, s, line_end ? line_end : text_end, wrap_width); s = CalcWordWrapNextLineStartA(s, text_end); } else { s = line_end ? line_end + 1 : text_end; } y += line_height; } // For large text, scan for the last visible line in order to avoid over-reserving in the call to PrimReserve() // Note that very large horizontal line will still be affected by the issue (e.g. a one megabyte string buffer without a newline will likely crash atm) if (text_end - s > 10000 && !word_wrap_enabled) { const char* s_end = s; float y_end = y; while (y_end < clip_rect.w && s_end < text_end) { s_end = (const char*)ImMemchr(s_end, '\n', text_end - s_end); s_end = s_end ? s_end + 1 : text_end; y_end += line_height; } text_end = s_end; } if (s == text_end) return; // Reserve vertices for remaining worse case (over-reserving is useful and easily amortized) const int vtx_count_max = (int)(text_end - s) * 4; const int idx_count_max = (int)(text_end - s) * 6; const int idx_expected_size = draw_list->IdxBuffer.Size + idx_count_max; draw_list->PrimReserve(idx_count_max, vtx_count_max); ImDrawVert* vtx_write = draw_list->_VtxWritePtr; ImDrawIdx* idx_write = draw_list->_IdxWritePtr; unsigned int vtx_index = draw_list->_VtxCurrentIdx; const ImU32 col_untinted = col | ~IM_COL32_A_MASK; const char* word_wrap_eol = NULL; while (s < text_end) { if (word_wrap_enabled) { // Calculate how far we can render. Requires two passes on the string data but keeps the code simple and not intrusive for what's essentially an uncommon feature. if (!word_wrap_eol) word_wrap_eol = CalcWordWrapPositionA(scale, s, text_end, wrap_width - (x - origin_x)); if (s >= word_wrap_eol) { x = origin_x; y += line_height; if (y > clip_rect.w) break; // break out of main loop word_wrap_eol = NULL; s = CalcWordWrapNextLineStartA(s, text_end); // Wrapping skips upcoming blanks continue; } } // Decode and advance source unsigned int c = (unsigned int)*s; if (c < 0x80) s += 1; else s += ImTextCharFromUtf8(&c, s, text_end); if (c < 32) { if (c == '\n') { x = origin_x; y += line_height; if (y > clip_rect.w) break; // break out of main loop continue; } if (c == '\r') continue; } const ImFontGlyph* glyph = FindGlyph((ImWchar)c); if (glyph == NULL) continue; float char_width = glyph->AdvanceX * scale; if (glyph->Visible) { // We don't do a second finer clipping test on the Y axis as we've already skipped anything before clip_rect.y and exit once we pass clip_rect.w float x1 = x + glyph->X0 * scale; float x2 = x + glyph->X1 * scale; float y1 = y + glyph->Y0 * scale; float y2 = y + glyph->Y1 * scale; if (x1 <= clip_rect.z && x2 >= clip_rect.x) { // Render a character float u1 = glyph->U0; float v1 = glyph->V0; float u2 = glyph->U1; float v2 = glyph->V1; // CPU side clipping used to fit text in their frame when the frame is too small. Only does clipping for axis aligned quads. if (cpu_fine_clip) { if (x1 < clip_rect.x) { u1 = u1 + (1.0f - (x2 - clip_rect.x) / (x2 - x1)) * (u2 - u1); x1 = clip_rect.x; } if (y1 < clip_rect.y) { v1 = v1 + (1.0f - (y2 - clip_rect.y) / (y2 - y1)) * (v2 - v1); y1 = clip_rect.y; } if (x2 > clip_rect.z) { u2 = u1 + ((clip_rect.z - x1) / (x2 - x1)) * (u2 - u1); x2 = clip_rect.z; } if (y2 > clip_rect.w) { v2 = v1 + ((clip_rect.w - y1) / (y2 - y1)) * (v2 - v1); y2 = clip_rect.w; } if (y1 >= y2) { x += char_width; continue; } } // Support for untinted glyphs ImU32 glyph_col = glyph->Colored ? col_untinted : col; // We are NOT calling PrimRectUV() here because non-inlined causes too much overhead in a debug builds. Inlined here: { vtx_write[0].pos.x = x1; vtx_write[0].pos.y = y1; vtx_write[0].col = glyph_col; vtx_write[0].uv.x = u1; vtx_write[0].uv.y = v1; vtx_write[1].pos.x = x2; vtx_write[1].pos.y = y1; vtx_write[1].col = glyph_col; vtx_write[1].uv.x = u2; vtx_write[1].uv.y = v1; vtx_write[2].pos.x = x2; vtx_write[2].pos.y = y2; vtx_write[2].col = glyph_col; vtx_write[2].uv.x = u2; vtx_write[2].uv.y = v2; vtx_write[3].pos.x = x1; vtx_write[3].pos.y = y2; vtx_write[3].col = glyph_col; vtx_write[3].uv.x = u1; vtx_write[3].uv.y = v2; idx_write[0] = (ImDrawIdx)(vtx_index); idx_write[1] = (ImDrawIdx)(vtx_index + 1); idx_write[2] = (ImDrawIdx)(vtx_index + 2); idx_write[3] = (ImDrawIdx)(vtx_index); idx_write[4] = (ImDrawIdx)(vtx_index + 2); idx_write[5] = (ImDrawIdx)(vtx_index + 3); vtx_write += 4; vtx_index += 4; idx_write += 6; } } } x += char_width; } // Give back unused vertices (clipped ones, blanks) ~ this is essentially a PrimUnreserve() action. draw_list->VtxBuffer.Size = (int)(vtx_write - draw_list->VtxBuffer.Data); // Same as calling shrink() draw_list->IdxBuffer.Size = (int)(idx_write - draw_list->IdxBuffer.Data); draw_list->CmdBuffer[draw_list->CmdBuffer.Size - 1].ElemCount -= (idx_expected_size - draw_list->IdxBuffer.Size); draw_list->_VtxWritePtr = vtx_write; draw_list->_IdxWritePtr = idx_write; draw_list->_VtxCurrentIdx = vtx_index; } //----------------------------------------------------------------------------- // [SECTION] ImGui Internal Render Helpers //----------------------------------------------------------------------------- // Vaguely redesigned to stop accessing ImGui global state: // - RenderArrow() // - RenderBullet() // - RenderCheckMark() // - RenderArrowPointingAt() // - RenderRectFilledRangeH() // - RenderRectFilledWithHole() //----------------------------------------------------------------------------- // Function in need of a redesign (legacy mess) // - RenderColorRectWithAlphaCheckerboard() //----------------------------------------------------------------------------- // Render an arrow aimed to be aligned with text (p_min is a position in the same space text would be positioned). To e.g. denote expanded/collapsed state void ImGui::RenderArrow(ImDrawList* draw_list, ImVec2 pos, ImU32 col, ImGuiDir dir, float scale) { const float h = draw_list->_Data->FontSize * 1.00f; float r = h * 0.40f * scale; ImVec2 center = pos + ImVec2(h * 0.50f, h * 0.50f * scale); ImVec2 a, b, c; switch (dir) { case ImGuiDir_Up: case ImGuiDir_Down: if (dir == ImGuiDir_Up) r = -r; a = ImVec2(+0.000f, +0.750f) * r; b = ImVec2(-0.866f, -0.750f) * r; c = ImVec2(+0.866f, -0.750f) * r; break; case ImGuiDir_Left: case ImGuiDir_Right: if (dir == ImGuiDir_Left) r = -r; a = ImVec2(+0.750f, +0.000f) * r; b = ImVec2(-0.750f, +0.866f) * r; c = ImVec2(-0.750f, -0.866f) * r; break; case ImGuiDir_None: case ImGuiDir_COUNT: IM_ASSERT(0); break; } draw_list->AddTriangleFilled(center + a, center + b, center + c, col); } void ImGui::RenderBullet(ImDrawList* draw_list, ImVec2 pos, ImU32 col) { // FIXME-OPT: This should be baked in font. draw_list->AddCircleFilled(pos, draw_list->_Data->FontSize * 0.20f, col, 8); } void ImGui::RenderCheckMark(ImDrawList* draw_list, ImVec2 pos, ImU32 col, float sz) { float thickness = ImMax(sz / 5.0f, 1.0f); sz -= thickness * 0.5f; pos += ImVec2(thickness * 0.25f, thickness * 0.25f); float third = sz / 3.0f; float bx = pos.x + third; float by = pos.y + sz - third * 0.5f; draw_list->PathLineTo(ImVec2(bx - third, by - third)); draw_list->PathLineTo(ImVec2(bx, by)); draw_list->PathLineTo(ImVec2(bx + third * 2.0f, by - third * 2.0f)); draw_list->PathStroke(col, 0, thickness); } // Render an arrow. 'pos' is position of the arrow tip. half_sz.x is length from base to tip. half_sz.y is length on each side. void ImGui::RenderArrowPointingAt(ImDrawList* draw_list, ImVec2 pos, ImVec2 half_sz, ImGuiDir direction, ImU32 col) { switch (direction) { case ImGuiDir_Left: draw_list->AddTriangleFilled(ImVec2(pos.x + half_sz.x, pos.y - half_sz.y), ImVec2(pos.x + half_sz.x, pos.y + half_sz.y), pos, col); return; case ImGuiDir_Right: draw_list->AddTriangleFilled(ImVec2(pos.x - half_sz.x, pos.y + half_sz.y), ImVec2(pos.x - half_sz.x, pos.y - half_sz.y), pos, col); return; case ImGuiDir_Up: draw_list->AddTriangleFilled(ImVec2(pos.x + half_sz.x, pos.y + half_sz.y), ImVec2(pos.x - half_sz.x, pos.y + half_sz.y), pos, col); return; case ImGuiDir_Down: draw_list->AddTriangleFilled(ImVec2(pos.x - half_sz.x, pos.y - half_sz.y), ImVec2(pos.x + half_sz.x, pos.y - half_sz.y), pos, col); return; case ImGuiDir_None: case ImGuiDir_COUNT: break; // Fix warnings } } static inline float ImAcos01(float x) { if (x <= 0.0f) return IM_PI * 0.5f; if (x >= 1.0f) return 0.0f; return ImAcos(x); //return (-0.69813170079773212f * x * x - 0.87266462599716477f) * x + 1.5707963267948966f; // Cheap approximation, may be enough for what we do. } // FIXME: Cleanup and move code to ImDrawList. void ImGui::RenderRectFilledRangeH(ImDrawList* draw_list, const ImRect& rect, ImU32 col, float x_start_norm, float x_end_norm, float rounding) { if (x_end_norm == x_start_norm) return; if (x_start_norm > x_end_norm) ImSwap(x_start_norm, x_end_norm); ImVec2 p0 = ImVec2(ImLerp(rect.Min.x, rect.Max.x, x_start_norm), rect.Min.y); ImVec2 p1 = ImVec2(ImLerp(rect.Min.x, rect.Max.x, x_end_norm), rect.Max.y); if (rounding == 0.0f) { draw_list->AddRectFilled(p0, p1, col, 0.0f); return; } rounding = ImClamp(ImMin((rect.Max.x - rect.Min.x) * 0.5f, (rect.Max.y - rect.Min.y) * 0.5f) - 1.0f, 0.0f, rounding); const float inv_rounding = 1.0f / rounding; const float arc0_b = ImAcos01(1.0f - (p0.x - rect.Min.x) * inv_rounding); const float arc0_e = ImAcos01(1.0f - (p1.x - rect.Min.x) * inv_rounding); const float half_pi = IM_PI * 0.5f; // We will == compare to this because we know this is the exact value ImAcos01 can return. const float x0 = ImMax(p0.x, rect.Min.x + rounding); if (arc0_b == arc0_e) { draw_list->PathLineTo(ImVec2(x0, p1.y)); draw_list->PathLineTo(ImVec2(x0, p0.y)); } else if (arc0_b == 0.0f && arc0_e == half_pi) { draw_list->PathArcToFast(ImVec2(x0, p1.y - rounding), rounding, 3, 6); // BL draw_list->PathArcToFast(ImVec2(x0, p0.y + rounding), rounding, 6, 9); // TR } else { draw_list->PathArcTo(ImVec2(x0, p1.y - rounding), rounding, IM_PI - arc0_e, IM_PI - arc0_b); // BL draw_list->PathArcTo(ImVec2(x0, p0.y + rounding), rounding, IM_PI + arc0_b, IM_PI + arc0_e); // TR } if (p1.x > rect.Min.x + rounding) { const float arc1_b = ImAcos01(1.0f - (rect.Max.x - p1.x) * inv_rounding); const float arc1_e = ImAcos01(1.0f - (rect.Max.x - p0.x) * inv_rounding); const float x1 = ImMin(p1.x, rect.Max.x - rounding); if (arc1_b == arc1_e) { draw_list->PathLineTo(ImVec2(x1, p0.y)); draw_list->PathLineTo(ImVec2(x1, p1.y)); } else if (arc1_b == 0.0f && arc1_e == half_pi) { draw_list->PathArcToFast(ImVec2(x1, p0.y + rounding), rounding, 9, 12); // TR draw_list->PathArcToFast(ImVec2(x1, p1.y - rounding), rounding, 0, 3); // BR } else { draw_list->PathArcTo(ImVec2(x1, p0.y + rounding), rounding, -arc1_e, -arc1_b); // TR draw_list->PathArcTo(ImVec2(x1, p1.y - rounding), rounding, +arc1_b, +arc1_e); // BR } } draw_list->PathFillConvex(col); } void ImGui::RenderRectFilledWithHole(ImDrawList* draw_list, const ImRect& outer, const ImRect& inner, ImU32 col, float rounding) { const bool fill_L = (inner.Min.x > outer.Min.x); const bool fill_R = (inner.Max.x < outer.Max.x); const bool fill_U = (inner.Min.y > outer.Min.y); const bool fill_D = (inner.Max.y < outer.Max.y); if (fill_L) draw_list->AddRectFilled(ImVec2(outer.Min.x, inner.Min.y), ImVec2(inner.Min.x, inner.Max.y), col, rounding, ImDrawFlags_RoundCornersNone | (fill_U ? 0 : ImDrawFlags_RoundCornersTopLeft) | (fill_D ? 0 : ImDrawFlags_RoundCornersBottomLeft)); if (fill_R) draw_list->AddRectFilled(ImVec2(inner.Max.x, inner.Min.y), ImVec2(outer.Max.x, inner.Max.y), col, rounding, ImDrawFlags_RoundCornersNone | (fill_U ? 0 : ImDrawFlags_RoundCornersTopRight) | (fill_D ? 0 : ImDrawFlags_RoundCornersBottomRight)); if (fill_U) draw_list->AddRectFilled(ImVec2(inner.Min.x, outer.Min.y), ImVec2(inner.Max.x, inner.Min.y), col, rounding, ImDrawFlags_RoundCornersNone | (fill_L ? 0 : ImDrawFlags_RoundCornersTopLeft) | (fill_R ? 0 : ImDrawFlags_RoundCornersTopRight)); if (fill_D) draw_list->AddRectFilled(ImVec2(inner.Min.x, inner.Max.y), ImVec2(inner.Max.x, outer.Max.y), col, rounding, ImDrawFlags_RoundCornersNone | (fill_L ? 0 : ImDrawFlags_RoundCornersBottomLeft) | (fill_R ? 0 : ImDrawFlags_RoundCornersBottomRight)); if (fill_L && fill_U) draw_list->AddRectFilled(ImVec2(outer.Min.x, outer.Min.y), ImVec2(inner.Min.x, inner.Min.y), col, rounding, ImDrawFlags_RoundCornersTopLeft); if (fill_R && fill_U) draw_list->AddRectFilled(ImVec2(inner.Max.x, outer.Min.y), ImVec2(outer.Max.x, inner.Min.y), col, rounding, ImDrawFlags_RoundCornersTopRight); if (fill_L && fill_D) draw_list->AddRectFilled(ImVec2(outer.Min.x, inner.Max.y), ImVec2(inner.Min.x, outer.Max.y), col, rounding, ImDrawFlags_RoundCornersBottomLeft); if (fill_R && fill_D) draw_list->AddRectFilled(ImVec2(inner.Max.x, inner.Max.y), ImVec2(outer.Max.x, outer.Max.y), col, rounding, ImDrawFlags_RoundCornersBottomRight); } // Helper for ColorPicker4() // NB: This is rather brittle and will show artifact when rounding this enabled if rounded corners overlap multiple cells. Caller currently responsible for avoiding that. // Spent a non reasonable amount of time trying to getting this right for ColorButton with rounding+anti-aliasing+ImGuiColorEditFlags_HalfAlphaPreview flag + various grid sizes and offsets, and eventually gave up... probably more reasonable to disable rounding altogether. // FIXME: uses ImGui::GetColorU32 void ImGui::RenderColorRectWithAlphaCheckerboard(ImDrawList* draw_list, ImVec2 p_min, ImVec2 p_max, ImU32 col, float grid_step, ImVec2 grid_off, float rounding, ImDrawFlags flags) { if ((flags & ImDrawFlags_RoundCornersMask_) == 0) flags = ImDrawFlags_RoundCornersDefault_; if (((col & IM_COL32_A_MASK) >> IM_COL32_A_SHIFT) < 0xFF) { ImU32 col_bg1 = GetColorU32(ImAlphaBlendColors(IM_COL32(204, 204, 204, 255), col)); ImU32 col_bg2 = GetColorU32(ImAlphaBlendColors(IM_COL32(128, 128, 128, 255), col)); draw_list->AddRectFilled(p_min, p_max, col_bg1, rounding, flags); int yi = 0; for (float y = p_min.y + grid_off.y; y < p_max.y; y += grid_step, yi++) { float y1 = ImClamp(y, p_min.y, p_max.y), y2 = ImMin(y + grid_step, p_max.y); if (y2 <= y1) continue; for (float x = p_min.x + grid_off.x + (yi & 1) * grid_step; x < p_max.x; x += grid_step * 2.0f) { float x1 = ImClamp(x, p_min.x, p_max.x), x2 = ImMin(x + grid_step, p_max.x); if (x2 <= x1) continue; ImDrawFlags cell_flags = ImDrawFlags_RoundCornersNone; if (y1 <= p_min.y) { if (x1 <= p_min.x) cell_flags |= ImDrawFlags_RoundCornersTopLeft; if (x2 >= p_max.x) cell_flags |= ImDrawFlags_RoundCornersTopRight; } if (y2 >= p_max.y) { if (x1 <= p_min.x) cell_flags |= ImDrawFlags_RoundCornersBottomLeft; if (x2 >= p_max.x) cell_flags |= ImDrawFlags_RoundCornersBottomRight; } // Combine flags cell_flags = (flags == ImDrawFlags_RoundCornersNone || cell_flags == ImDrawFlags_RoundCornersNone) ? ImDrawFlags_RoundCornersNone : (cell_flags & flags); draw_list->AddRectFilled(ImVec2(x1, y1), ImVec2(x2, y2), col_bg2, rounding, cell_flags); } } } else { draw_list->AddRectFilled(p_min, p_max, col, rounding, flags); } } //----------------------------------------------------------------------------- // [SECTION] Decompression code //----------------------------------------------------------------------------- // Compressed with stb_compress() then converted to a C array and encoded as base85. // Use the program in misc/fonts/binary_to_compressed_c.cpp to create the array from a TTF file. // The purpose of encoding as base85 instead of "0x00,0x01,..." style is only save on _source code_ size. // Decompression from stb.h (public domain) by Sean Barrett https://github.com/nothings/stb/blob/master/stb.h //----------------------------------------------------------------------------- static unsigned int stb_decompress_length(const unsigned char *input) { return (input[8] << 24) + (input[9] << 16) + (input[10] << 8) + input[11]; } static unsigned char *stb__barrier_out_e, *stb__barrier_out_b; static const unsigned char *stb__barrier_in_b; static unsigned char *stb__dout; static void stb__match(const unsigned char *data, unsigned int length) { // INVERSE of memmove... write each byte before copying the next... IM_ASSERT(stb__dout + length <= stb__barrier_out_e); if (stb__dout + length > stb__barrier_out_e) { stb__dout += length; return; } if (data < stb__barrier_out_b) { stb__dout = stb__barrier_out_e+1; return; } while (length--) *stb__dout++ = *data++; } static void stb__lit(const unsigned char *data, unsigned int length) { IM_ASSERT(stb__dout + length <= stb__barrier_out_e); if (stb__dout + length > stb__barrier_out_e) { stb__dout += length; return; } if (data < stb__barrier_in_b) { stb__dout = stb__barrier_out_e+1; return; } memcpy(stb__dout, data, length); stb__dout += length; } #define stb__in2(x) ((i[x] << 8) + i[(x)+1]) #define stb__in3(x) ((i[x] << 16) + stb__in2((x)+1)) #define stb__in4(x) ((i[x] << 24) + stb__in3((x)+1)) static const unsigned char *stb_decompress_token(const unsigned char *i) { if (*i >= 0x20) { // use fewer if's for cases that expand small if (*i >= 0x80) stb__match(stb__dout-i[1]-1, i[0] - 0x80 + 1), i += 2; else if (*i >= 0x40) stb__match(stb__dout-(stb__in2(0) - 0x4000 + 1), i[2]+1), i += 3; else /* *i >= 0x20 */ stb__lit(i+1, i[0] - 0x20 + 1), i += 1 + (i[0] - 0x20 + 1); } else { // more ifs for cases that expand large, since overhead is amortized if (*i >= 0x18) stb__match(stb__dout-(stb__in3(0) - 0x180000 + 1), i[3]+1), i += 4; else if (*i >= 0x10) stb__match(stb__dout-(stb__in3(0) - 0x100000 + 1), stb__in2(3)+1), i += 5; else if (*i >= 0x08) stb__lit(i+2, stb__in2(0) - 0x0800 + 1), i += 2 + (stb__in2(0) - 0x0800 + 1); else if (*i == 0x07) stb__lit(i+3, stb__in2(1) + 1), i += 3 + (stb__in2(1) + 1); else if (*i == 0x06) stb__match(stb__dout-(stb__in3(1)+1), i[4]+1), i += 5; else if (*i == 0x04) stb__match(stb__dout-(stb__in3(1)+1), stb__in2(4)+1), i += 6; } return i; } static unsigned int stb_adler32(unsigned int adler32, unsigned char *buffer, unsigned int buflen) { const unsigned long ADLER_MOD = 65521; unsigned long s1 = adler32 & 0xffff, s2 = adler32 >> 16; unsigned long blocklen = buflen % 5552; unsigned long i; while (buflen) { for (i=0; i + 7 < blocklen; i += 8) { s1 += buffer[0], s2 += s1; s1 += buffer[1], s2 += s1; s1 += buffer[2], s2 += s1; s1 += buffer[3], s2 += s1; s1 += buffer[4], s2 += s1; s1 += buffer[5], s2 += s1; s1 += buffer[6], s2 += s1; s1 += buffer[7], s2 += s1; buffer += 8; } for (; i < blocklen; ++i) s1 += *buffer++, s2 += s1; s1 %= ADLER_MOD, s2 %= ADLER_MOD; buflen -= blocklen; blocklen = 5552; } return (unsigned int)(s2 << 16) + (unsigned int)s1; } static unsigned int stb_decompress(unsigned char *output, const unsigned char *i, unsigned int /*length*/) { if (stb__in4(0) != 0x57bC0000) return 0; if (stb__in4(4) != 0) return 0; // error! stream is > 4GB const unsigned int olen = stb_decompress_length(i); stb__barrier_in_b = i; stb__barrier_out_e = output + olen; stb__barrier_out_b = output; i += 16; stb__dout = output; for (;;) { const unsigned char *old_i = i; i = stb_decompress_token(i); if (i == old_i) { if (*i == 0x05 && i[1] == 0xfa) { IM_ASSERT(stb__dout == output + olen); if (stb__dout != output + olen) return 0; if (stb_adler32(1, output, olen) != (unsigned int) stb__in4(2)) return 0; return olen; } else { IM_ASSERT(0); /* NOTREACHED */ return 0; } } IM_ASSERT(stb__dout <= output + olen); if (stb__dout > output + olen) return 0; } } //----------------------------------------------------------------------------- // [SECTION] Default font data (ProggyClean.ttf) //----------------------------------------------------------------------------- // ProggyClean.ttf // Copyright (c) 2004, 2005 Tristan Grimmer // MIT license (see License.txt in http://www.proggyfonts.net/index.php?menu=download) // Download and more information at http://www.proggyfonts.net or http://upperboundsinteractive.com/fonts.php //----------------------------------------------------------------------------- #ifndef IMGUI_DISABLE_DEFAULT_FONT // File: 'ProggyClean.ttf' (41208 bytes) // Exported using binary_to_compressed_c.exe -u8 "ProggyClean.ttf" proggy_clean_ttf static const unsigned int proggy_clean_ttf_compressed_size = 9583; static const unsigned char proggy_clean_ttf_compressed_data[9583] = { 87,188,0,0,0,0,0,0,0,0,160,248,0,4,0,0,55,0,1,0,0,0,12,0,128,0,3,0,64,79,83,47,50,136,235,116,144,0,0,1,72,130,21,44,78,99,109,97,112,2,18,35,117,0,0,3,160,130,19,36,82,99,118,116, 32,130,23,130,2,33,4,252,130,4,56,2,103,108,121,102,18,175,137,86,0,0,7,4,0,0,146,128,104,101,97,100,215,145,102,211,130,27,32,204,130,3,33,54,104,130,16,39,8,66,1,195,0,0,1,4,130, 15,59,36,104,109,116,120,138,0,126,128,0,0,1,152,0,0,2,6,108,111,99,97,140,115,176,216,0,0,5,130,30,41,2,4,109,97,120,112,1,174,0,218,130,31,32,40,130,16,44,32,110,97,109,101,37,89, 187,150,0,0,153,132,130,19,44,158,112,111,115,116,166,172,131,239,0,0,155,36,130,51,44,210,112,114,101,112,105,2,1,18,0,0,4,244,130,47,32,8,132,203,46,1,0,0,60,85,233,213,95,15,60, 245,0,3,8,0,131,0,34,183,103,119,130,63,43,0,0,189,146,166,215,0,0,254,128,3,128,131,111,130,241,33,2,0,133,0,32,1,130,65,38,192,254,64,0,0,3,128,131,16,130,5,32,1,131,7,138,3,33,2, 0,130,17,36,1,1,0,144,0,130,121,130,23,38,2,0,8,0,64,0,10,130,9,32,118,130,9,130,6,32,0,130,59,33,1,144,131,200,35,2,188,2,138,130,16,32,143,133,7,37,1,197,0,50,2,0,131,0,33,4,9,131, 5,145,3,43,65,108,116,115,0,64,0,0,32,172,8,0,131,0,35,5,0,1,128,131,77,131,3,33,3,128,191,1,33,1,128,130,184,35,0,0,128,0,130,3,131,11,32,1,130,7,33,0,128,131,1,32,1,136,9,32,0,132, 15,135,5,32,1,131,13,135,27,144,35,32,1,149,25,131,21,32,0,130,0,32,128,132,103,130,35,132,39,32,0,136,45,136,97,133,17,130,5,33,0,0,136,19,34,0,128,1,133,13,133,5,32,128,130,15,132, 131,32,3,130,5,32,3,132,27,144,71,32,0,133,27,130,29,130,31,136,29,131,63,131,3,65,63,5,132,5,132,205,130,9,33,0,0,131,9,137,119,32,3,132,19,138,243,130,55,32,1,132,35,135,19,131,201, 136,11,132,143,137,13,130,41,32,0,131,3,144,35,33,128,0,135,1,131,223,131,3,141,17,134,13,136,63,134,15,136,53,143,15,130,96,33,0,3,131,4,130,3,34,28,0,1,130,5,34,0,0,76,130,17,131, 9,36,28,0,4,0,48,130,17,46,8,0,8,0,2,0,0,0,127,0,255,32,172,255,255,130,9,34,0,0,129,132,9,130,102,33,223,213,134,53,132,22,33,1,6,132,6,64,4,215,32,129,165,216,39,177,0,1,141,184, 1,255,133,134,45,33,198,0,193,1,8,190,244,1,28,1,158,2,20,2,136,2,252,3,20,3,88,3,156,3,222,4,20,4,50,4,80,4,98,4,162,5,22,5,102,5,188,6,18,6,116,6,214,7,56,7,126,7,236,8,78,8,108, 8,150,8,208,9,16,9,74,9,136,10,22,10,128,11,4,11,86,11,200,12,46,12,130,12,234,13,94,13,164,13,234,14,80,14,150,15,40,15,176,16,18,16,116,16,224,17,82,17,182,18,4,18,110,18,196,19, 76,19,172,19,246,20,88,20,174,20,234,21,64,21,128,21,166,21,184,22,18,22,126,22,198,23,52,23,142,23,224,24,86,24,186,24,238,25,54,25,150,25,212,26,72,26,156,26,240,27,92,27,200,28, 4,28,76,28,150,28,234,29,42,29,146,29,210,30,64,30,142,30,224,31,36,31,118,31,166,31,166,32,16,130,1,52,46,32,138,32,178,32,200,33,20,33,116,33,152,33,238,34,98,34,134,35,12,130,1, 33,128,35,131,1,60,152,35,176,35,216,36,0,36,74,36,104,36,144,36,174,37,6,37,96,37,130,37,248,37,248,38,88,38,170,130,1,8,190,216,39,64,39,154,40,10,40,104,40,168,41,14,41,32,41,184, 41,248,42,54,42,96,42,96,43,2,43,42,43,94,43,172,43,230,44,32,44,52,44,154,45,40,45,92,45,120,45,170,45,232,46,38,46,166,47,38,47,182,47,244,48,94,48,200,49,62,49,180,50,30,50,158, 51,30,51,130,51,238,52,92,52,206,53,58,53,134,53,212,54,38,54,114,54,230,55,118,55,216,56,58,56,166,57,18,57,116,57,174,58,46,58,154,59,6,59,124,59,232,60,58,60,150,61,34,61,134,61, 236,62,86,62,198,63,42,63,154,64,18,64,106,64,208,65,54,65,162,66,8,66,64,66,122,66,184,66,240,67,98,67,204,68,42,68,138,68,238,69,88,69,182,69,226,70,84,70,180,71,20,71,122,71,218, 72,84,72,198,73,64,0,36,70,21,8,8,77,3,0,7,0,11,0,15,0,19,0,23,0,27,0,31,0,35,0,39,0,43,0,47,0,51,0,55,0,59,0,63,0,67,0,71,0,75,0,79,0,83,0,87,0,91,0,95,0,99,0,103,0,107,0,111,0,115, 0,119,0,123,0,127,0,131,0,135,0,139,0,143,0,0,17,53,51,21,49,150,3,32,5,130,23,32,33,130,3,211,7,151,115,32,128,133,0,37,252,128,128,2,128,128,190,5,133,74,32,4,133,6,206,5,42,0,7, 1,128,0,0,2,0,4,0,0,65,139,13,37,0,1,53,51,21,7,146,3,32,3,130,19,32,1,141,133,32,3,141,14,131,13,38,255,0,128,128,0,6,1,130,84,35,2,128,4,128,140,91,132,89,32,51,65,143,6,139,7,33, 1,0,130,57,32,254,130,3,32,128,132,4,32,4,131,14,138,89,35,0,0,24,0,130,0,33,3,128,144,171,66,55,33,148,115,65,187,19,32,5,130,151,143,155,163,39,32,1,136,182,32,253,134,178,132,7, 132,200,145,17,32,3,65,48,17,165,17,39,0,0,21,0,128,255,128,3,65,175,17,65,3,27,132,253,131,217,139,201,155,233,155,27,131,67,131,31,130,241,33,255,0,131,181,137,232,132,15,132,4,138, 247,34,255,0,128,179,238,32,0,130,0,32,20,65,239,48,33,0,19,67,235,10,32,51,65,203,14,65,215,11,32,7,154,27,135,39,32,33,130,35,33,128,128,130,231,32,253,132,231,32,128,132,232,34, 128,128,254,133,13,136,8,32,253,65,186,5,130,36,130,42,176,234,133,231,34,128,0,0,66,215,44,33,0,1,68,235,6,68,211,19,32,49,68,239,14,139,207,139,47,66,13,7,32,51,130,47,33,1,0,130, 207,35,128,128,1,0,131,222,131,5,130,212,130,6,131,212,32,0,130,10,133,220,130,233,130,226,32,254,133,255,178,233,39,3,1,128,3,0,2,0,4,68,15,7,68,99,12,130,89,130,104,33,128,4,133, 93,130,10,38,0,0,11,1,0,255,0,68,63,16,70,39,9,66,215,8,32,7,68,77,6,68,175,14,32,29,68,195,6,132,7,35,2,0,128,255,131,91,132,4,65,178,5,141,111,67,129,23,165,135,140,107,142,135,33, 21,5,69,71,6,131,7,33,1,0,140,104,132,142,130,4,137,247,140,30,68,255,12,39,11,0,128,0,128,3,0,3,69,171,15,67,251,7,65,15,8,66,249,11,65,229,7,67,211,7,66,13,7,35,1,128,128,254,133, 93,32,254,131,145,132,4,132,18,32,2,151,128,130,23,34,0,0,9,154,131,65,207,8,68,107,15,68,51,7,32,7,70,59,7,135,121,130,82,32,128,151,111,41,0,0,4,0,128,255,0,1,128,1,137,239,33,0, 37,70,145,10,65,77,10,65,212,14,37,0,0,0,5,0,128,66,109,5,70,123,10,33,0,19,72,33,18,133,237,70,209,11,33,0,2,130,113,137,119,136,115,33,1,0,133,43,130,5,34,0,0,10,69,135,6,70,219, 13,66,155,7,65,9,12,66,157,11,66,9,11,32,7,130,141,132,252,66,151,9,137,9,66,15,30,36,0,20,0,128,0,130,218,71,11,42,68,51,8,65,141,7,73,19,15,69,47,23,143,39,66,81,7,32,1,66,55,6,34, 1,128,128,68,25,5,69,32,6,137,6,136,25,32,254,131,42,32,3,66,88,26,148,26,32,0,130,0,32,14,164,231,70,225,12,66,233,7,67,133,19,71,203,15,130,161,32,255,130,155,32,254,139,127,134, 12,164,174,33,0,15,164,159,33,59,0,65,125,20,66,25,7,32,5,68,191,6,66,29,7,144,165,65,105,9,35,128,128,255,0,137,2,133,182,164,169,33,128,128,197,171,130,155,68,235,7,32,21,70,77,19, 66,21,10,68,97,8,66,30,5,66,4,43,34,0,17,0,71,19,41,65,253,20,71,25,23,65,91,15,65,115,7,34,2,128,128,66,9,8,130,169,33,1,0,66,212,13,132,28,72,201,43,35,0,0,0,18,66,27,38,76,231,5, 68,157,20,135,157,32,7,68,185,13,65,129,28,66,20,5,32,253,66,210,11,65,128,49,133,61,32,0,65,135,6,74,111,37,72,149,12,66,203,19,65,147,19,68,93,7,68,85,8,76,4,5,33,255,0,133,129,34, 254,0,128,68,69,8,181,197,34,0,0,12,65,135,32,65,123,20,69,183,27,133,156,66,50,5,72,87,10,67,137,32,33,0,19,160,139,78,251,13,68,55,20,67,119,19,65,91,36,69,177,15,32,254,143,16,65, 98,53,32,128,130,0,32,0,66,43,54,70,141,23,66,23,15,131,39,69,47,11,131,15,70,129,19,74,161,9,36,128,255,0,128,254,130,153,65,148,32,67,41,9,34,0,0,4,79,15,5,73,99,10,71,203,8,32,3, 72,123,6,72,43,8,32,2,133,56,131,99,130,9,34,0,0,6,72,175,5,73,159,14,144,63,135,197,132,189,133,66,33,255,0,73,6,7,70,137,12,35,0,0,0,10,130,3,73,243,25,67,113,12,65,73,7,69,161,7, 138,7,37,21,2,0,128,128,254,134,3,73,116,27,33,128,128,130,111,39,12,0,128,1,0,3,128,2,72,219,21,35,43,0,47,0,67,47,20,130,111,33,21,1,68,167,13,81,147,8,133,230,32,128,77,73,6,32, 128,131,142,134,18,130,6,32,255,75,18,12,131,243,37,128,0,128,3,128,3,74,231,21,135,123,32,29,134,107,135,7,32,21,74,117,7,135,7,134,96,135,246,74,103,23,132,242,33,0,10,67,151,28, 67,133,20,66,141,11,131,11,32,3,77,71,6,32,128,130,113,32,1,81,4,6,134,218,66,130,24,131,31,34,0,26,0,130,0,77,255,44,83,15,11,148,155,68,13,7,32,49,78,231,18,79,7,11,73,243,11,32, 33,65,187,10,130,63,65,87,8,73,239,19,35,0,128,1,0,131,226,32,252,65,100,6,32,128,139,8,33,1,0,130,21,32,253,72,155,44,73,255,20,32,128,71,67,8,81,243,39,67,15,20,74,191,23,68,121, 27,32,1,66,150,6,32,254,79,19,11,131,214,32,128,130,215,37,2,0,128,253,0,128,136,5,65,220,24,147,212,130,210,33,0,24,72,219,42,84,255,13,67,119,16,69,245,19,72,225,19,65,3,15,69,93, 19,131,55,132,178,71,115,14,81,228,6,142,245,33,253,0,132,43,172,252,65,16,11,75,219,8,65,219,31,66,223,24,75,223,10,33,29,1,80,243,10,66,175,8,131,110,134,203,133,172,130,16,70,30, 7,164,183,130,163,32,20,65,171,48,65,163,36,65,143,23,65,151,19,65,147,13,65,134,17,133,17,130,216,67,114,5,164,217,65,137,12,72,147,48,79,71,19,74,169,22,80,251,8,65,173,7,66,157, 15,74,173,15,32,254,65,170,8,71,186,45,72,131,6,77,143,40,187,195,152,179,65,123,38,68,215,57,68,179,15,65,85,7,69,187,14,32,21,66,95,15,67,19,25,32,1,83,223,6,32,2,76,240,7,77,166, 43,65,8,5,130,206,32,0,67,39,54,143,167,66,255,19,82,193,11,151,47,85,171,5,67,27,17,132,160,69,172,11,69,184,56,66,95,6,33,12,1,130,237,32,2,68,179,27,68,175,16,80,135,15,72,55,7, 71,87,12,73,3,12,132,12,66,75,32,76,215,5,169,139,147,135,148,139,81,12,12,81,185,36,75,251,7,65,23,27,76,215,9,87,165,12,65,209,15,72,157,7,65,245,31,32,128,71,128,6,32,1,82,125,5, 34,0,128,254,131,169,32,254,131,187,71,180,9,132,27,32,2,88,129,44,32,0,78,47,40,65,79,23,79,171,14,32,21,71,87,8,72,15,14,65,224,33,130,139,74,27,62,93,23,7,68,31,7,75,27,7,139,15, 74,3,7,74,23,27,65,165,11,65,177,15,67,123,5,32,1,130,221,32,252,71,96,5,74,12,12,133,244,130,25,34,1,0,128,130,2,139,8,93,26,8,65,9,32,65,57,14,140,14,32,0,73,79,67,68,119,11,135, 11,32,51,90,75,14,139,247,65,43,7,131,19,139,11,69,159,11,65,247,6,36,1,128,128,253,0,90,71,9,33,1,0,132,14,32,128,89,93,14,69,133,6,130,44,131,30,131,6,65,20,56,33,0,16,72,179,40, 75,47,12,65,215,19,74,95,19,65,43,11,131,168,67,110,5,75,23,17,69,106,6,75,65,5,71,204,43,32,0,80,75,47,71,203,15,159,181,68,91,11,67,197,7,73,101,13,68,85,6,33,128,128,130,214,130, 25,32,254,74,236,48,130,194,37,0,18,0,128,255,128,77,215,40,65,139,64,32,51,80,159,10,65,147,39,130,219,84,212,43,130,46,75,19,97,74,33,11,65,201,23,65,173,31,33,1,0,79,133,6,66,150, 5,67,75,48,85,187,6,70,207,37,32,71,87,221,13,73,163,14,80,167,15,132,15,83,193,19,82,209,8,78,99,9,72,190,11,77,110,49,89,63,5,80,91,35,99,63,32,70,235,23,81,99,10,69,148,10,65,110, 36,32,0,65,99,47,95,219,11,68,171,51,66,87,7,72,57,7,74,45,17,143,17,65,114,50,33,14,0,65,111,40,159,195,98,135,15,35,7,53,51,21,100,78,9,95,146,16,32,254,82,114,6,32,128,67,208,37, 130,166,99,79,58,32,17,96,99,14,72,31,19,72,87,31,82,155,7,67,47,14,32,21,131,75,134,231,72,51,17,72,78,8,133,8,80,133,6,33,253,128,88,37,9,66,124,36,72,65,12,134,12,71,55,43,66,139, 27,85,135,10,91,33,12,65,35,11,66,131,11,71,32,8,90,127,6,130,244,71,76,11,168,207,33,0,12,66,123,32,32,0,65,183,15,68,135,11,66,111,7,67,235,11,66,111,15,32,254,97,66,12,160,154,67, 227,52,80,33,15,87,249,15,93,45,31,75,111,12,93,45,11,77,99,9,160,184,81,31,12,32,15,98,135,30,104,175,7,77,249,36,69,73,15,78,5,12,32,254,66,151,19,34,128,128,4,87,32,12,149,35,133, 21,96,151,31,32,19,72,35,5,98,173,15,143,15,32,21,143,99,158,129,33,0,0,65,35,52,65,11,15,147,15,98,75,11,33,1,0,143,151,132,15,32,254,99,200,37,132,43,130,4,39,0,10,0,128,1,128,3, 0,104,151,14,97,187,20,69,131,15,67,195,11,87,227,7,33,128,128,132,128,33,254,0,68,131,9,65,46,26,42,0,0,0,7,0,0,255,128,3,128,0,88,223,15,33,0,21,89,61,22,66,209,12,65,2,12,37,0,2, 1,0,3,128,101,83,8,36,0,1,53,51,29,130,3,34,21,1,0,66,53,8,32,0,68,215,6,100,55,25,107,111,9,66,193,11,72,167,8,73,143,31,139,31,33,1,0,131,158,32,254,132,5,33,253,128,65,16,9,133, 17,89,130,25,141,212,33,0,0,93,39,8,90,131,25,93,39,14,66,217,6,106,179,8,159,181,71,125,15,139,47,138,141,87,11,14,76,23,14,65,231,26,140,209,66,122,8,81,179,5,101,195,26,32,47,74, 75,13,69,159,11,83,235,11,67,21,16,136,167,131,106,130,165,130,15,32,128,101,90,24,134,142,32,0,65,103,51,108,23,11,101,231,15,75,173,23,74,237,23,66,15,6,66,46,17,66,58,17,65,105, 49,66,247,55,71,179,12,70,139,15,86,229,7,84,167,15,32,1,95,72,12,89,49,6,33,128,128,65,136,38,66,30,9,32,0,100,239,7,66,247,29,70,105,20,65,141,19,69,81,15,130,144,32,128,83,41,5, 32,255,131,177,68,185,5,133,126,65,97,37,32,0,130,0,33,21,0,130,55,66,195,28,67,155,13,34,79,0,83,66,213,13,73,241,19,66,59,19,65,125,11,135,201,66,249,16,32,128,66,44,11,66,56,17, 68,143,8,68,124,38,67,183,12,96,211,9,65,143,29,112,171,5,32,0,68,131,63,34,33,53,51,71,121,11,32,254,98,251,16,32,253,74,231,10,65,175,37,133,206,37,0,0,8,1,0,0,107,123,11,113,115, 9,33,0,1,130,117,131,3,73,103,7,66,51,18,66,44,5,133,75,70,88,5,32,254,65,39,12,68,80,9,34,12,0,128,107,179,28,68,223,6,155,111,86,147,15,32,2,131,82,141,110,33,254,0,130,15,32,4,103, 184,15,141,35,87,176,5,83,11,5,71,235,23,114,107,11,65,189,16,70,33,15,86,153,31,135,126,86,145,30,65,183,41,32,0,130,0,32,10,65,183,24,34,35,0,39,67,85,9,65,179,15,143,15,33,1,0,65, 28,17,157,136,130,123,32,20,130,3,32,0,97,135,24,115,167,19,80,71,12,32,51,110,163,14,78,35,19,131,19,155,23,77,229,8,78,9,17,151,17,67,231,46,94,135,8,73,31,31,93,215,56,82,171,25, 72,77,8,162,179,169,167,99,131,11,69,85,19,66,215,15,76,129,13,68,115,22,72,79,35,67,113,5,34,0,0,19,70,31,46,65,89,52,73,223,15,85,199,33,95,33,8,132,203,73,29,32,67,48,16,177,215, 101,13,15,65,141,43,69,141,15,75,89,5,70,0,11,70,235,21,178,215,36,10,0,128,0,0,71,207,24,33,0,19,100,67,6,80,215,11,66,67,7,80,43,12,71,106,7,80,192,5,65,63,5,66,217,26,33,0,13,156, 119,68,95,5,72,233,12,134,129,85,81,11,76,165,20,65,43,8,73,136,8,75,10,31,38,128,128,0,0,0,13,1,130,4,32,3,106,235,29,114,179,12,66,131,23,32,7,77,133,6,67,89,12,131,139,116,60,9, 89,15,37,32,0,74,15,7,103,11,22,65,35,5,33,55,0,93,81,28,67,239,23,78,85,5,107,93,14,66,84,17,65,193,26,74,183,10,66,67,34,143,135,79,91,15,32,7,117,111,8,75,56,9,84,212,9,154,134, 32,0,130,0,32,18,130,3,70,171,41,83,7,16,70,131,19,84,191,15,84,175,19,84,167,30,84,158,12,154,193,68,107,15,33,0,0,65,79,42,65,71,7,73,55,7,118,191,16,83,180,9,32,255,76,166,9,154, 141,32,0,130,0,69,195,52,65,225,15,151,15,75,215,31,80,56,10,68,240,17,100,32,9,70,147,39,65,93,12,71,71,41,92,85,15,84,135,23,78,35,15,110,27,10,84,125,8,107,115,29,136,160,38,0,0, 14,0,128,255,0,82,155,24,67,239,8,119,255,11,69,131,11,77,29,6,112,31,8,134,27,105,203,8,32,2,75,51,11,75,195,12,74,13,29,136,161,37,128,0,0,0,11,1,130,163,82,115,8,125,191,17,69,35, 12,74,137,15,143,15,32,1,65,157,12,136,12,161,142,65,43,40,65,199,6,65,19,24,102,185,11,76,123,11,99,6,12,135,12,32,254,130,8,161,155,101,23,9,39,8,0,0,1,128,3,128,2,78,63,17,72,245, 12,67,41,11,90,167,9,32,128,97,49,9,32,128,109,51,14,132,97,81,191,8,130,97,125,99,12,121,35,9,127,75,15,71,79,12,81,151,23,87,97,7,70,223,15,80,245,16,105,97,15,32,254,113,17,6,32, 128,130,8,105,105,8,76,122,18,65,243,21,74,63,7,38,4,1,0,255,0,2,0,119,247,28,133,65,32,255,141,91,35,0,0,0,16,67,63,36,34,59,0,63,77,59,9,119,147,11,143,241,66,173,15,66,31,11,67, 75,8,81,74,16,32,128,131,255,87,181,42,127,43,5,34,255,128,2,120,235,11,37,19,0,23,0,0,37,109,191,14,118,219,7,127,43,14,65,79,14,35,0,0,0,3,73,91,5,130,5,38,3,0,7,0,11,0,0,70,205, 11,88,221,12,32,0,73,135,7,87,15,22,73,135,10,79,153,15,97,71,19,65,49,11,32,1,131,104,121,235,11,80,65,11,142,179,144,14,81,123,46,32,1,88,217,5,112,5,8,65,201,15,83,29,15,122,147, 11,135,179,142,175,143,185,67,247,39,66,199,7,35,5,0,128,3,69,203,15,123,163,12,67,127,7,130,119,71,153,10,141,102,70,175,8,32,128,121,235,30,136,89,100,191,11,116,195,11,111,235,15, 72,39,7,32,2,97,43,5,132,5,94,67,8,131,8,125,253,10,32,3,65,158,16,146,16,130,170,40,0,21,0,128,0,0,3,128,5,88,219,15,24,64,159,32,135,141,65,167,15,68,163,10,97,73,49,32,255,82,58, 7,93,80,8,97,81,16,24,67,87,52,34,0,0,5,130,231,33,128,2,80,51,13,65,129,8,113,61,6,132,175,65,219,5,130,136,77,152,17,32,0,95,131,61,70,215,6,33,21,51,90,53,10,78,97,23,105,77,31, 65,117,7,139,75,24,68,195,9,24,64,22,9,33,0,128,130,11,33,128,128,66,25,5,121,38,5,134,5,134,45,66,40,36,66,59,18,34,128,0,0,66,59,81,135,245,123,103,19,120,159,19,77,175,12,33,255, 0,87,29,10,94,70,21,66,59,54,39,3,1,128,3,0,2,128,4,24,65,7,15,66,47,7,72,98,12,37,0,0,0,3,1,0,24,65,55,21,131,195,32,1,67,178,6,33,4,0,77,141,8,32,6,131,47,74,67,16,24,69,3,20,24, 65,251,7,133,234,130,229,94,108,17,35,0,0,6,0,141,175,86,59,5,162,79,85,166,8,70,112,13,32,13,24,64,67,26,24,71,255,7,123,211,12,80,121,11,69,215,15,66,217,11,69,71,10,131,113,132, 126,119,90,9,66,117,19,132,19,32,0,130,0,24,64,47,59,33,7,0,73,227,5,68,243,15,85,13,12,76,37,22,74,254,15,130,138,33,0,4,65,111,6,137,79,65,107,16,32,1,77,200,6,34,128,128,3,75,154, 12,37,0,16,0,0,2,0,104,115,36,140,157,68,67,19,68,51,15,106,243,15,134,120,70,37,10,68,27,10,140,152,65,121,24,32,128,94,155,7,67,11,8,24,74,11,25,65,3,12,83,89,18,82,21,37,67,200, 5,130,144,24,64,172,12,33,4,0,134,162,74,80,14,145,184,32,0,130,0,69,251,20,32,19,81,243,5,82,143,8,33,5,53,89,203,5,133,112,79,109,15,33,0,21,130,71,80,175,41,36,75,0,79,0,83,121, 117,9,87,89,27,66,103,11,70,13,15,75,191,11,135,67,87,97,20,109,203,5,69,246,8,108,171,5,78,195,38,65,51,13,107,203,11,77,3,17,24,75,239,17,65,229,28,79,129,39,130,175,32,128,123,253, 7,132,142,24,65,51,15,65,239,41,36,128,128,0,0,13,65,171,5,66,163,28,136,183,118,137,11,80,255,15,67,65,7,74,111,8,32,0,130,157,32,253,24,76,35,10,103,212,5,81,175,9,69,141,7,66,150, 29,131,158,24,75,199,28,124,185,7,76,205,15,68,124,14,32,3,123,139,16,130,16,33,128,128,108,199,6,33,0,3,65,191,35,107,11,6,73,197,11,24,70,121,15,83,247,15,24,70,173,23,69,205,14, 32,253,131,140,32,254,136,4,94,198,9,32,3,78,4,13,66,127,13,143,13,32,0,130,0,33,16,0,24,69,59,39,109,147,12,76,253,19,24,69,207,15,69,229,15,130,195,71,90,10,139,10,130,152,73,43, 40,91,139,10,65,131,37,35,75,0,79,0,84,227,12,143,151,68,25,15,80,9,23,95,169,11,34,128,2,128,112,186,5,130,6,83,161,19,76,50,6,130,37,65,145,44,110,83,5,32,16,67,99,6,71,67,15,76, 55,17,140,215,67,97,23,76,69,15,77,237,11,104,211,23,77,238,11,65,154,43,33,0,10,83,15,28,83,13,20,67,145,19,67,141,14,97,149,21,68,9,15,86,251,5,66,207,5,66,27,37,82,1,23,127,71,12, 94,235,10,110,175,24,98,243,15,132,154,132,4,24,66,69,10,32,4,67,156,43,130,198,35,2,1,0,4,75,27,9,69,85,9,95,240,7,32,128,130,35,32,28,66,43,40,24,82,63,23,83,123,12,72,231,15,127, 59,23,116,23,19,117,71,7,24,77,99,15,67,111,15,71,101,8,36,2,128,128,252,128,127,60,11,32,1,132,16,130,18,141,24,67,107,9,32,3,68,194,15,175,15,38,0,11,0,128,1,128,2,80,63,25,32,0, 24,65,73,11,69,185,15,83,243,16,32,0,24,81,165,8,130,86,77,35,6,155,163,88,203,5,24,66,195,30,70,19,19,24,80,133,15,32,1,75,211,8,32,254,108,133,8,79,87,20,65,32,9,41,0,0,7,0,128,0, 0,2,128,2,68,87,15,66,1,16,92,201,16,24,76,24,17,133,17,34,128,0,30,66,127,64,34,115,0,119,73,205,9,66,43,11,109,143,15,24,79,203,11,90,143,15,131,15,155,31,65,185,15,86,87,11,35,128, 128,253,0,69,7,6,130,213,33,1,0,119,178,15,142,17,66,141,74,83,28,6,36,7,0,0,4,128,82,39,18,76,149,12,67,69,21,32,128,79,118,15,32,0,130,0,32,8,131,206,32,2,79,83,9,100,223,14,102, 113,23,115,115,7,24,65,231,12,130,162,32,4,68,182,19,130,102,93,143,8,69,107,29,24,77,255,12,143,197,72,51,7,76,195,15,132,139,85,49,15,130,152,131,18,71,81,23,70,14,11,36,0,10,0,128, 2,69,59,9,89,151,15,66,241,11,76,165,12,71,43,15,75,49,13,65,12,23,132,37,32,0,179,115,130,231,95,181,16,132,77,32,254,67,224,8,65,126,20,79,171,8,32,2,89,81,5,75,143,6,80,41,8,34, 2,0,128,24,81,72,9,32,0,130,0,35,17,0,0,255,77,99,39,95,65,36,67,109,15,24,69,93,11,77,239,5,95,77,23,35,128,1,0,128,24,86,7,8,132,167,32,2,69,198,41,130,202,33,0,26,120,75,44,24,89, 51,15,71,243,12,70,239,11,24,84,3,11,66,7,11,71,255,10,32,21,69,155,35,88,151,12,32,128,74,38,10,65,210,8,74,251,5,65,226,5,75,201,13,32,3,65,9,41,146,41,40,0,0,0,9,1,0,1,0,2,91,99, 19,32,35,106,119,13,70,219,15,83,239,12,137,154,32,2,67,252,19,36,128,0,0,4,1,130,196,32,2,130,8,91,107,8,32,0,135,81,24,73,211,8,132,161,73,164,13,36,0,8,0,128,2,105,123,26,139,67, 76,99,15,34,1,0,128,135,76,83,156,20,92,104,8,67,251,30,24,86,47,27,123,207,12,24,86,7,15,71,227,8,32,4,65,20,20,131,127,32,0,130,123,32,0,71,223,26,32,19,90,195,22,71,223,15,84,200, 6,32,128,133,241,24,84,149,9,67,41,25,36,0,0,0,22,0,88,111,49,32,87,66,21,5,77,3,27,123,75,7,71,143,19,135,183,71,183,19,130,171,74,252,5,131,5,89,87,17,32,1,132,18,130,232,68,11,10, 33,1,128,70,208,16,66,230,18,147,18,130,254,223,255,75,27,23,65,59,15,135,39,155,255,34,128,128,254,104,92,8,33,0,128,65,32,11,65,1,58,33,26,0,130,0,72,71,18,78,55,17,76,11,19,86,101, 12,75,223,11,89,15,11,24,76,87,15,75,235,15,131,15,72,95,7,85,71,11,72,115,11,73,64,6,34,1,128,128,66,215,9,34,128,254,128,134,14,33,128,255,67,102,5,32,0,130,16,70,38,11,66,26,57, 88,11,8,24,76,215,34,78,139,7,95,245,7,32,7,24,73,75,23,32,128,131,167,130,170,101,158,9,82,49,22,118,139,6,32,18,67,155,44,116,187,9,108,55,14,80,155,23,66,131,15,93,77,10,131,168, 32,128,73,211,12,24,75,187,22,32,4,96,71,20,67,108,19,132,19,120,207,8,32,5,76,79,15,66,111,21,66,95,8,32,3,190,211,111,3,8,211,212,32,20,65,167,44,34,75,0,79,97,59,13,32,33,112,63, 10,65,147,19,69,39,19,143,39,24,66,71,9,130,224,65,185,43,94,176,12,65,183,24,71,38,8,24,72,167,7,65,191,38,136,235,24,96,167,12,65,203,62,115,131,13,65,208,42,175,235,67,127,6,32, 4,76,171,29,114,187,5,32,71,65,211,5,65,203,68,72,51,8,164,219,32,0,172,214,71,239,58,78,3,27,66,143,15,77,19,15,147,31,35,33,53,51,21,66,183,10,173,245,66,170,30,150,30,34,0,0,23, 80,123,54,76,1,16,73,125,15,82,245,11,167,253,24,76,85,12,70,184,5,32,254,131,185,37,254,0,128,1,0,128,133,16,117,158,18,92,27,38,65,3,17,130,251,35,17,0,128,254,24,69,83,39,140,243, 121,73,19,109,167,7,81,41,15,24,95,175,12,102,227,15,121,96,11,24,95,189,7,32,3,145,171,154,17,24,77,47,9,33,0,5,70,71,37,68,135,7,32,29,117,171,11,69,87,15,24,79,97,19,24,79,149,23, 131,59,32,1,75,235,5,72,115,11,72,143,7,132,188,71,27,46,131,51,32,0,69,95,6,175,215,32,21,131,167,81,15,19,151,191,151,23,131,215,71,43,5,32,254,24,79,164,24,74,109,8,77,166,13,65, 176,26,88,162,5,98,159,6,171,219,120,247,6,79,29,8,99,169,10,103,59,19,65,209,35,131,35,91,25,19,112,94,15,83,36,8,173,229,33,20,0,88,75,43,71,31,12,65,191,71,33,1,0,130,203,32,254, 131,4,68,66,7,67,130,6,104,61,13,173,215,38,13,1,0,0,0,2,128,67,111,28,74,129,16,104,35,19,79,161,16,87,14,7,138,143,132,10,67,62,36,114,115,5,162,151,67,33,16,108,181,15,143,151,67, 5,5,24,100,242,15,170,153,34,0,0,14,65,51,34,32,55,79,75,9,32,51,74,7,10,65,57,38,132,142,32,254,72,0,14,139,163,32,128,80,254,8,67,158,21,65,63,7,32,4,72,227,27,95,155,12,67,119,19, 124,91,24,149,154,72,177,34,97,223,8,155,151,24,108,227,15,88,147,16,72,117,19,68,35,11,92,253,15,70,199,15,24,87,209,17,32,2,87,233,7,32,1,24,88,195,10,119,24,8,32,3,81,227,24,65, 125,21,35,128,128,0,25,76,59,48,24,90,187,9,97,235,12,66,61,11,91,105,19,24,79,141,11,24,79,117,15,24,79,129,27,90,53,13,130,13,32,253,131,228,24,79,133,40,69,70,8,66,137,31,65,33, 19,96,107,8,68,119,29,66,7,5,68,125,16,65,253,19,65,241,27,24,90,179,13,24,79,143,18,33,128,128,130,246,32,254,130,168,68,154,36,77,51,9,97,47,5,167,195,32,21,131,183,78,239,27,155, 195,78,231,14,201,196,77,11,6,32,5,73,111,37,97,247,12,77,19,31,155,207,78,215,19,162,212,69,17,14,66,91,19,80,143,57,78,203,39,159,215,32,128,93,134,8,24,80,109,24,66,113,15,169,215, 66,115,6,32,4,69,63,33,32,0,101,113,7,86,227,35,143,211,36,49,53,51,21,1,77,185,14,65,159,28,69,251,34,67,56,8,33,9,0,24,107,175,25,90,111,12,110,251,11,119,189,24,119,187,34,87,15, 9,32,4,66,231,37,90,39,7,66,239,8,84,219,15,69,105,23,24,85,27,27,87,31,11,33,1,128,76,94,6,32,1,85,241,7,33,128,128,106,48,10,33,128,128,69,136,11,133,13,24,79,116,49,84,236,8,24, 91,87,9,32,5,165,255,69,115,12,66,27,15,159,15,24,72,247,12,74,178,5,24,80,64,15,33,0,128,143,17,77,89,51,130,214,24,81,43,7,170,215,74,49,8,159,199,143,31,139,215,69,143,5,32,254, 24,81,50,35,181,217,84,123,70,143,195,159,15,65,187,16,66,123,7,65,175,15,65,193,29,68,207,39,79,27,5,70,131,6,32,4,68,211,33,33,67,0,83,143,14,159,207,143,31,140,223,33,0,128,24,80, 82,14,24,93,16,23,32,253,65,195,5,68,227,40,133,214,107,31,7,32,5,67,115,27,87,9,8,107,31,43,66,125,6,32,0,103,177,23,131,127,72,203,36,32,0,110,103,8,155,163,73,135,6,32,19,24,112, 99,10,65,71,11,73,143,19,143,31,126,195,5,24,85,21,9,24,76,47,14,32,254,24,93,77,36,68,207,11,39,25,0,0,255,128,3,128,4,66,51,37,95,247,13,82,255,24,76,39,19,147,221,66,85,27,24,118, 7,8,24,74,249,12,76,74,8,91,234,8,67,80,17,131,222,33,253,0,121,30,44,73,0,16,69,15,6,32,0,65,23,38,69,231,12,65,179,6,98,131,16,86,31,27,24,108,157,14,80,160,8,24,65,46,17,33,4,0, 96,2,18,144,191,65,226,8,68,19,5,171,199,80,9,15,180,199,67,89,5,32,255,24,79,173,28,174,201,24,79,179,50,32,1,24,122,5,10,82,61,10,180,209,83,19,8,32,128,24,80,129,27,111,248,43,131, 71,24,115,103,8,67,127,41,78,213,24,100,247,19,66,115,39,75,107,5,32,254,165,219,78,170,40,24,112,163,49,32,1,97,203,6,65,173,64,32,0,83,54,7,133,217,88,37,12,32,254,131,28,33,128, 3,67,71,44,84,183,6,32,5,69,223,33,96,7,7,123,137,16,192,211,24,112,14,9,32,255,67,88,29,68,14,10,84,197,38,33,0,22,116,47,50,32,87,106,99,9,116,49,15,89,225,15,97,231,23,70,41,19, 82,85,8,93,167,6,32,253,132,236,108,190,7,89,251,5,116,49,58,33,128,128,131,234,32,15,24,74,67,38,70,227,24,24,83,45,23,89,219,12,70,187,12,89,216,19,32,2,69,185,24,141,24,70,143,66, 24,82,119,56,78,24,10,32,253,133,149,132,6,24,106,233,7,69,198,48,178,203,81,243,12,68,211,15,106,255,23,66,91,15,69,193,7,100,39,10,24,83,72,16,176,204,33,19,0,88,207,45,68,21,12, 68,17,10,65,157,53,68,17,6,32,254,92,67,10,65,161,25,69,182,43,24,118,91,47,69,183,18,181,209,111,253,12,89,159,8,66,112,12,69,184,45,35,0,0,0,9,24,80,227,26,73,185,16,118,195,15,131, 15,33,1,0,65,59,15,66,39,27,160,111,66,205,12,148,111,143,110,33,128,128,156,112,24,81,199,8,75,199,23,66,117,20,155,121,32,254,68,126,12,72,213,29,134,239,149,123,89,27,16,148,117, 65,245,8,24,71,159,14,141,134,134,28,73,51,55,109,77,15,105,131,11,68,67,11,76,169,27,107,209,12,102,174,8,32,128,72,100,18,116,163,56,79,203,11,75,183,44,85,119,19,71,119,23,151,227, 32,1,93,27,8,65,122,5,77,102,8,110,120,20,66,23,8,66,175,17,66,63,12,133,12,79,35,8,74,235,33,67,149,16,69,243,15,78,57,15,69,235,16,67,177,7,151,192,130,23,67,84,29,141,192,174,187, 77,67,15,69,11,12,159,187,77,59,10,199,189,24,70,235,50,96,83,19,66,53,23,105,65,19,77,47,12,163,199,66,67,37,78,207,50,67,23,23,174,205,67,228,6,71,107,13,67,22,14,66,85,11,83,187, 38,124,47,49,95,7,19,66,83,23,67,23,19,24,96,78,17,80,101,16,71,98,40,33,0,7,88,131,22,24,89,245,12,84,45,12,102,213,5,123,12,9,32,2,126,21,14,43,255,0,128,128,0,0,20,0,128,255,128, 3,126,19,39,32,75,106,51,7,113,129,15,24,110,135,19,126,47,15,115,117,11,69,47,11,32,2,109,76,9,102,109,9,32,128,75,2,10,130,21,32,254,69,47,6,32,3,94,217,47,32,0,65,247,10,69,15,46, 65,235,31,65,243,15,101,139,10,66,174,14,65,247,16,72,102,28,69,17,14,84,243,9,165,191,88,47,48,66,53,12,32,128,71,108,6,203,193,32,17,75,187,42,73,65,16,65,133,52,114,123,9,167,199, 69,21,37,86,127,44,75,171,11,180,197,78,213,12,148,200,81,97,46,24,95,243,9,32,4,66,75,33,113,103,9,87,243,36,143,225,24,84,27,31,90,145,8,148,216,67,49,5,24,84,34,14,75,155,27,67, 52,13,140,13,36,0,20,0,128,255,24,135,99,46,88,59,43,155,249,80,165,7,136,144,71,161,23,32,253,132,33,32,254,88,87,44,136,84,35,128,0,0,21,81,103,5,94,47,44,76,51,12,143,197,151,15, 65,215,31,24,64,77,13,65,220,20,65,214,14,71,4,40,65,213,13,32,0,130,0,35,21,1,2,0,135,0,34,36,0,72,134,10,36,1,0,26,0,130,134,11,36,2,0,14,0,108,134,11,32,3,138,23,32,4,138,11,34, 5,0,20,134,33,34,0,0,6,132,23,32,1,134,15,32,18,130,25,133,11,37,1,0,13,0,49,0,133,11,36,2,0,7,0,38,134,11,36,3,0,17,0,45,134,11,32,4,138,35,36,5,0,10,0,62,134,23,32,6,132,23,36,3, 0,1,4,9,130,87,131,167,133,11,133,167,133,11,133,167,133,11,37,3,0,34,0,122,0,133,11,133,167,133,11,133,167,133,11,133,167,34,50,0,48,130,1,34,52,0,47,134,5,8,49,49,0,53,98,121,32, 84,114,105,115,116,97,110,32,71,114,105,109,109,101,114,82,101,103,117,108,97,114,84,84,88,32,80,114,111,103,103,121,67,108,101,97,110,84,84,50,48,48,52,47,130,2,53,49,53,0,98,0,121, 0,32,0,84,0,114,0,105,0,115,0,116,0,97,0,110,130,15,32,71,132,15,36,109,0,109,0,101,130,9,32,82,130,5,36,103,0,117,0,108,130,29,32,114,130,43,34,84,0,88,130,35,32,80,130,25,34,111, 0,103,130,1,34,121,0,67,130,27,32,101,132,59,32,84,130,31,33,0,0,65,155,9,34,20,0,0,65,11,6,130,8,135,2,33,1,1,130,9,8,120,1,1,2,1,3,1,4,1,5,1,6,1,7,1,8,1,9,1,10,1,11,1,12,1,13,1,14, 1,15,1,16,1,17,1,18,1,19,1,20,1,21,1,22,1,23,1,24,1,25,1,26,1,27,1,28,1,29,1,30,1,31,1,32,0,3,0,4,0,5,0,6,0,7,0,8,0,9,0,10,0,11,0,12,0,13,0,14,0,15,0,16,0,17,0,18,0,19,0,20,0,21,0, 22,0,23,0,24,0,25,0,26,0,27,0,28,0,29,0,30,0,31,130,187,8,66,33,0,34,0,35,0,36,0,37,0,38,0,39,0,40,0,41,0,42,0,43,0,44,0,45,0,46,0,47,0,48,0,49,0,50,0,51,0,52,0,53,0,54,0,55,0,56,0, 57,0,58,0,59,0,60,0,61,0,62,0,63,0,64,0,65,0,66,130,243,9,75,68,0,69,0,70,0,71,0,72,0,73,0,74,0,75,0,76,0,77,0,78,0,79,0,80,0,81,0,82,0,83,0,84,0,85,0,86,0,87,0,88,0,89,0,90,0,91,0, 92,0,93,0,94,0,95,0,96,0,97,1,33,1,34,1,35,1,36,1,37,1,38,1,39,1,40,1,41,1,42,1,43,1,44,1,45,1,46,1,47,1,48,1,49,1,50,1,51,1,52,1,53,1,54,1,55,1,56,1,57,1,58,1,59,1,60,1,61,1,62,1, 63,1,64,1,65,0,172,0,163,0,132,0,133,0,189,0,150,0,232,0,134,0,142,0,139,0,157,0,169,0,164,0,239,0,138,0,218,0,131,0,147,0,242,0,243,0,141,0,151,0,136,0,195,0,222,0,241,0,158,0,170, 0,245,0,244,0,246,0,162,0,173,0,201,0,199,0,174,0,98,0,99,0,144,0,100,0,203,0,101,0,200,0,202,0,207,0,204,0,205,0,206,0,233,0,102,0,211,0,208,0,209,0,175,0,103,0,240,0,145,0,214,0, 212,0,213,0,104,0,235,0,237,0,137,0,106,0,105,0,107,0,109,0,108,0,110,0,160,0,111,0,113,0,112,0,114,0,115,0,117,0,116,0,118,0,119,0,234,0,120,0,122,0,121,0,123,0,125,0,124,0,184,0, 161,0,127,0,126,0,128,0,129,0,236,0,238,0,186,14,117,110,105,99,111,100,101,35,48,120,48,48,48,49,141,14,32,50,141,14,32,51,141,14,32,52,141,14,32,53,141,14,32,54,141,14,32,55,141, 14,32,56,141,14,32,57,141,14,32,97,141,14,32,98,141,14,32,99,141,14,32,100,141,14,32,101,141,14,32,102,140,14,33,49,48,141,14,141,239,32,49,141,239,32,49,141,239,32,49,141,239,32,49, 141,239,32,49,141,239,32,49,141,239,32,49,141,239,32,49,141,239,32,49,141,239,32,49,141,239,32,49,141,239,32,49,141,239,32,49,141,239,45,49,102,6,100,101,108,101,116,101,4,69,117,114, 111,140,236,32,56,141,236,32,56,141,236,32,56,141,236,32,56,141,236,32,56,141,236,32,56,141,236,32,56,141,236,32,56,141,236,32,56,141,236,32,56,141,236,32,56,141,236,32,56,141,236, 32,56,141,236,32,56,141,236,32,56,65,220,13,32,57,65,220,13,32,57,141,239,32,57,141,239,32,57,141,239,32,57,141,239,32,57,141,239,32,57,141,239,32,57,141,239,32,57,141,239,32,57,141, 239,32,57,141,239,32,57,141,239,32,57,141,239,32,57,141,239,32,57,141,239,35,57,102,0,0,5,250,72,249,98,247, }; static const char* GetDefaultCompressedFontDataTTF(int* out_size) { *out_size = proggy_clean_ttf_compressed_size; return (const char*)proggy_clean_ttf_compressed_data; } #endif // #ifndef IMGUI_DISABLE_DEFAULT_FONT #endif // #ifndef IMGUI_DISABLE ================================================ FILE: src/DesktopPlusUI/imgui/imgui_internal.h ================================================ // dear imgui, v1.91.9b // (internal structures/api) // You may use this file to debug, understand or extend Dear ImGui features but we don't provide any guarantee of forward compatibility. /* Index of this file: // [SECTION] Header mess // [SECTION] Forward declarations // [SECTION] Context pointer // [SECTION] STB libraries includes // [SECTION] Macros // [SECTION] Generic helpers // [SECTION] ImDrawList support // [SECTION] Style support // [SECTION] Data types support // [SECTION] Widgets support: flags, enums, data structures // [SECTION] Popup support // [SECTION] Inputs support // [SECTION] Clipper support // [SECTION] Navigation support // [SECTION] Typing-select support // [SECTION] Columns support // [SECTION] Box-select support // [SECTION] Multi-select support // [SECTION] Docking support // [SECTION] Viewport support // [SECTION] Settings support // [SECTION] Localization support // [SECTION] Error handling, State recovery support // [SECTION] Metrics, Debug tools // [SECTION] Generic context hooks // [SECTION] ImGuiContext (main imgui context) // [SECTION] ImGuiWindowTempData, ImGuiWindow // [SECTION] Tab bar, Tab item support // [SECTION] Table support // [SECTION] ImGui internal API // [SECTION] ImFontAtlas internal API // [SECTION] Test Engine specific hooks (imgui_test_engine) */ #pragma once #ifndef IMGUI_DISABLE //----------------------------------------------------------------------------- // [SECTION] Header mess //----------------------------------------------------------------------------- #ifndef IMGUI_VERSION #include "imgui.h" #endif #include // FILE*, sscanf #include // NULL, malloc, free, qsort, atoi, atof #include // sqrtf, fabsf, fmodf, powf, floorf, ceilf, cosf, sinf #include // INT_MIN, INT_MAX // Enable SSE intrinsics if available #if (defined __SSE__ || defined __x86_64__ || defined _M_X64 || (defined(_M_IX86_FP) && (_M_IX86_FP >= 1))) && !defined(IMGUI_DISABLE_SSE) #define IMGUI_ENABLE_SSE #include #if (defined __AVX__ || defined __SSE4_2__) #define IMGUI_ENABLE_SSE4_2 #include #endif #endif // Emscripten has partial SSE 4.2 support where _mm_crc32_u32 is not available. See https://emscripten.org/docs/porting/simd.html#id11 and #8213 #if defined(IMGUI_ENABLE_SSE4_2) && !defined(IMGUI_USE_LEGACY_CRC32_ADLER) && !defined(__EMSCRIPTEN__) #define IMGUI_ENABLE_SSE4_2_CRC #endif // Visual Studio warnings #ifdef _MSC_VER #pragma warning (push) #pragma warning (disable: 4251) // class 'xxx' needs to have dll-interface to be used by clients of struct 'xxx' // when IMGUI_API is set to__declspec(dllexport) #pragma warning (disable: 26812) // The enum type 'xxx' is unscoped. Prefer 'enum class' over 'enum' (Enum.3). [MSVC Static Analyzer) #pragma warning (disable: 26495) // [Static Analyzer] Variable 'XXX' is uninitialized. Always initialize a member variable (type.6). #if defined(_MSC_VER) && _MSC_VER >= 1922 // MSVC 2019 16.2 or later #pragma warning (disable: 5054) // operator '|': deprecated between enumerations of different types #endif #endif // Clang/GCC warnings with -Weverything #if defined(__clang__) #pragma clang diagnostic push #if __has_warning("-Wunknown-warning-option") #pragma clang diagnostic ignored "-Wunknown-warning-option" // warning: unknown warning group 'xxx' #endif #pragma clang diagnostic ignored "-Wunknown-pragmas" // warning: unknown warning group 'xxx' #pragma clang diagnostic ignored "-Wfloat-equal" // warning: comparing floating point with == or != is unsafe // storing and comparing against same constants ok, for ImFloor() #pragma clang diagnostic ignored "-Wold-style-cast" // warning: use of old-style cast #pragma clang diagnostic ignored "-Wzero-as-null-pointer-constant" // warning: zero as null pointer constant #pragma clang diagnostic ignored "-Wdouble-promotion" // warning: implicit conversion from 'float' to 'double' when passing argument to function #pragma clang diagnostic ignored "-Wimplicit-int-float-conversion" // warning: implicit conversion from 'xxx' to 'float' may lose precision #pragma clang diagnostic ignored "-Wmissing-noreturn" // warning: function 'xxx' could be declared with attribute 'noreturn' #pragma clang diagnostic ignored "-Wdeprecated-enum-enum-conversion"// warning: bitwise operation between different enumeration types ('XXXFlags_' and 'XXXFlagsPrivate_') is deprecated #pragma clang diagnostic ignored "-Wunsafe-buffer-usage" // warning: 'xxx' is an unsafe pointer used for buffer access #pragma clang diagnostic ignored "-Wnontrivial-memaccess" // warning: first argument in call to 'memset' is a pointer to non-trivially copyable type #elif defined(__GNUC__) #pragma GCC diagnostic push #pragma GCC diagnostic ignored "-Wpragmas" // warning: unknown option after '#pragma GCC diagnostic' kind #pragma GCC diagnostic ignored "-Wfloat-equal" // warning: comparing floating-point with '==' or '!=' is unsafe #pragma GCC diagnostic ignored "-Wclass-memaccess" // [__GNUC__ >= 8] warning: 'memset/memcpy' clearing/writing an object of type 'xxxx' with no trivial copy-assignment; use assignment or value-initialization instead #pragma GCC diagnostic ignored "-Wdeprecated-enum-enum-conversion" // warning: bitwise operation between different enumeration types ('XXXFlags_' and 'XXXFlagsPrivate_') is deprecated #endif // In 1.89.4, we moved the implementation of "courtesy maths operators" from imgui_internal.h in imgui.h // As they are frequently requested, we do not want to encourage to many people using imgui_internal.h #if defined(IMGUI_DEFINE_MATH_OPERATORS) && !defined(IMGUI_DEFINE_MATH_OPERATORS_IMPLEMENTED) #error Please '#define IMGUI_DEFINE_MATH_OPERATORS' _BEFORE_ including imgui.h! #endif // Legacy defines #ifdef IMGUI_DISABLE_FORMAT_STRING_FUNCTIONS // Renamed in 1.74 #error Use IMGUI_DISABLE_DEFAULT_FORMAT_FUNCTIONS #endif #ifdef IMGUI_DISABLE_MATH_FUNCTIONS // Renamed in 1.74 #error Use IMGUI_DISABLE_DEFAULT_MATH_FUNCTIONS #endif // Enable stb_truetype by default unless FreeType is enabled. // You can compile with both by defining both IMGUI_ENABLE_FREETYPE and IMGUI_ENABLE_STB_TRUETYPE together. #ifndef IMGUI_ENABLE_FREETYPE #define IMGUI_ENABLE_STB_TRUETYPE #endif //----------------------------------------------------------------------------- // [SECTION] Forward declarations //----------------------------------------------------------------------------- // Utilities // (other types which are not forwarded declared are: ImBitArray<>, ImSpan<>, ImSpanAllocator<>, ImPool<>, ImChunkStream<>) struct ImBitVector; // Store 1-bit per value struct ImRect; // An axis-aligned rectangle (2 points) struct ImGuiTextIndex; // Maintain a line index for a text buffer. // ImDrawList/ImFontAtlas struct ImDrawDataBuilder; // Helper to build a ImDrawData instance struct ImDrawListSharedData; // Data shared between all ImDrawList instances // ImGui struct ImGuiBoxSelectState; // Box-selection state (currently used by multi-selection, could potentially be used by others) struct ImGuiColorMod; // Stacked color modifier, backup of modified data so we can restore it struct ImGuiContext; // Main Dear ImGui context struct ImGuiContextHook; // Hook for extensions like ImGuiTestEngine struct ImGuiDataTypeInfo; // Type information associated to a ImGuiDataType enum struct ImGuiDeactivatedItemData; // Data for IsItemDeactivated()/IsItemDeactivatedAfterEdit() function. struct ImGuiErrorRecoveryState; // Storage of stack sizes for error handling and recovery struct ImGuiGroupData; // Stacked storage data for BeginGroup()/EndGroup() struct ImGuiInputTextState; // Internal state of the currently focused/edited text input box struct ImGuiInputTextDeactivateData;// Short term storage to backup text of a deactivating InputText() while another is stealing active id struct ImGuiLastItemData; // Status storage for last submitted items struct ImGuiLocEntry; // A localization entry. struct ImGuiMenuColumns; // Simple column measurement, currently used for MenuItem() only struct ImGuiMultiSelectState; // Multi-selection persistent state (for focused selection). struct ImGuiMultiSelectTempData; // Multi-selection temporary state (while traversing). struct ImGuiNavItemData; // Result of a keyboard/gamepad directional navigation move query result struct ImGuiMetricsConfig; // Storage for ShowMetricsWindow() and DebugNodeXXX() functions struct ImGuiNextWindowData; // Storage for SetNextWindow** functions struct ImGuiNextItemData; // Storage for SetNextItem** functions struct ImGuiOldColumnData; // Storage data for a single column for legacy Columns() api struct ImGuiOldColumns; // Storage data for a columns set for legacy Columns() api struct ImGuiPopupData; // Storage for current popup stack struct ImGuiSettingsHandler; // Storage for one type registered in the .ini file struct ImGuiStyleMod; // Stacked style modifier, backup of modified data so we can restore it struct ImGuiStyleVarInfo; // Style variable information (e.g. to access style variables from an enum) struct ImGuiTabBar; // Storage for a tab bar struct ImGuiTabItem; // Storage for a tab item (within a tab bar) struct ImGuiTable; // Storage for a table struct ImGuiTableHeaderData; // Storage for TableAngledHeadersRow() struct ImGuiTableColumn; // Storage for one column of a table struct ImGuiTableInstanceData; // Storage for one instance of a same table struct ImGuiTableTempData; // Temporary storage for one table (one per table in the stack), shared between tables. struct ImGuiTableSettings; // Storage for a table .ini settings struct ImGuiTableColumnsSettings; // Storage for a column .ini settings struct ImGuiTreeNodeStackData; // Temporary storage for TreeNode(). struct ImGuiTypingSelectState; // Storage for GetTypingSelectRequest() struct ImGuiTypingSelectRequest; // Storage for GetTypingSelectRequest() (aimed to be public) struct ImGuiWindow; // Storage for one window struct ImGuiWindowTempData; // Temporary storage for one window (that's the data which in theory we could ditch at the end of the frame, in practice we currently keep it for each window) struct ImGuiWindowSettings; // Storage for a window .ini settings (we keep one of those even if the actual window wasn't instanced during this session) // Enumerations // Use your programming IDE "Go to definition" facility on the names of the center columns to find the actual flags/enum lists. enum ImGuiLocKey : int; // -> enum ImGuiLocKey // Enum: a localization entry for translation. typedef int ImGuiLayoutType; // -> enum ImGuiLayoutType_ // Enum: Horizontal or vertical // Flags typedef int ImGuiActivateFlags; // -> enum ImGuiActivateFlags_ // Flags: for navigation/focus function (will be for ActivateItem() later) typedef int ImGuiDebugLogFlags; // -> enum ImGuiDebugLogFlags_ // Flags: for ShowDebugLogWindow(), g.DebugLogFlags typedef int ImGuiFocusRequestFlags; // -> enum ImGuiFocusRequestFlags_ // Flags: for FocusWindow() typedef int ImGuiItemStatusFlags; // -> enum ImGuiItemStatusFlags_ // Flags: for g.LastItemData.StatusFlags typedef int ImGuiOldColumnFlags; // -> enum ImGuiOldColumnFlags_ // Flags: for BeginColumns() typedef int ImGuiLogFlags; // -> enum ImGuiLogFlags_ // Flags: for LogBegin() text capturing function typedef int ImGuiNavRenderCursorFlags; // -> enum ImGuiNavRenderCursorFlags_//Flags: for RenderNavCursor() typedef int ImGuiNavMoveFlags; // -> enum ImGuiNavMoveFlags_ // Flags: for navigation requests typedef int ImGuiNextItemDataFlags; // -> enum ImGuiNextItemDataFlags_ // Flags: for SetNextItemXXX() functions typedef int ImGuiNextWindowDataFlags; // -> enum ImGuiNextWindowDataFlags_// Flags: for SetNextWindowXXX() functions typedef int ImGuiScrollFlags; // -> enum ImGuiScrollFlags_ // Flags: for ScrollToItem() and navigation requests typedef int ImGuiSeparatorFlags; // -> enum ImGuiSeparatorFlags_ // Flags: for SeparatorEx() typedef int ImGuiTextFlags; // -> enum ImGuiTextFlags_ // Flags: for TextEx() typedef int ImGuiTooltipFlags; // -> enum ImGuiTooltipFlags_ // Flags: for BeginTooltipEx() typedef int ImGuiTypingSelectFlags; // -> enum ImGuiTypingSelectFlags_ // Flags: for GetTypingSelectRequest() typedef int ImGuiWindowRefreshFlags; // -> enum ImGuiWindowRefreshFlags_ // Flags: for SetNextWindowRefreshPolicy() //----------------------------------------------------------------------------- // [SECTION] Context pointer // See implementation of this variable in imgui.cpp for comments and details. //----------------------------------------------------------------------------- #ifndef GImGui extern IMGUI_API ImGuiContext* GImGui; // Current implicit context pointer #endif //----------------------------------------------------------------------------- // [SECTION] Macros //----------------------------------------------------------------------------- // Debug Printing Into TTY // (since IMGUI_VERSION_NUM >= 18729: IMGUI_DEBUG_LOG was reworked into IMGUI_DEBUG_PRINTF (and removed framecount from it). If you were using a #define IMGUI_DEBUG_LOG please rename) #ifndef IMGUI_DEBUG_PRINTF #ifndef IMGUI_DISABLE_DEFAULT_FORMAT_FUNCTIONS #define IMGUI_DEBUG_PRINTF(_FMT,...) printf(_FMT, __VA_ARGS__) #else #define IMGUI_DEBUG_PRINTF(_FMT,...) ((void)0) #endif #endif // Debug Logging for ShowDebugLogWindow(). This is designed for relatively rare events so please don't spam. #define IMGUI_DEBUG_LOG_ERROR(...) do { if (g.DebugLogFlags & ImGuiDebugLogFlags_EventError) IMGUI_DEBUG_LOG(__VA_ARGS__); else g.DebugLogSkippedErrors++; } while (0) #define IMGUI_DEBUG_LOG_ACTIVEID(...) do { if (g.DebugLogFlags & ImGuiDebugLogFlags_EventActiveId) IMGUI_DEBUG_LOG(__VA_ARGS__); } while (0) #define IMGUI_DEBUG_LOG_FOCUS(...) do { if (g.DebugLogFlags & ImGuiDebugLogFlags_EventFocus) IMGUI_DEBUG_LOG(__VA_ARGS__); } while (0) #define IMGUI_DEBUG_LOG_POPUP(...) do { if (g.DebugLogFlags & ImGuiDebugLogFlags_EventPopup) IMGUI_DEBUG_LOG(__VA_ARGS__); } while (0) #define IMGUI_DEBUG_LOG_NAV(...) do { if (g.DebugLogFlags & ImGuiDebugLogFlags_EventNav) IMGUI_DEBUG_LOG(__VA_ARGS__); } while (0) #define IMGUI_DEBUG_LOG_SELECTION(...) do { if (g.DebugLogFlags & ImGuiDebugLogFlags_EventSelection) IMGUI_DEBUG_LOG(__VA_ARGS__); } while (0) #define IMGUI_DEBUG_LOG_CLIPPER(...) do { if (g.DebugLogFlags & ImGuiDebugLogFlags_EventClipper) IMGUI_DEBUG_LOG(__VA_ARGS__); } while (0) #define IMGUI_DEBUG_LOG_IO(...) do { if (g.DebugLogFlags & ImGuiDebugLogFlags_EventIO) IMGUI_DEBUG_LOG(__VA_ARGS__); } while (0) #define IMGUI_DEBUG_LOG_FONT(...) do { if (g.DebugLogFlags & ImGuiDebugLogFlags_EventFont) IMGUI_DEBUG_LOG(__VA_ARGS__); } while (0) #define IMGUI_DEBUG_LOG_INPUTROUTING(...) do{if (g.DebugLogFlags & ImGuiDebugLogFlags_EventInputRouting)IMGUI_DEBUG_LOG(__VA_ARGS__); } while (0) // Static Asserts #define IM_STATIC_ASSERT(_COND) static_assert(_COND, "") // "Paranoid" Debug Asserts are meant to only be enabled during specific debugging/work, otherwise would slow down the code too much. // We currently don't have many of those so the effect is currently negligible, but onward intent to add more aggressive ones in the code. //#define IMGUI_DEBUG_PARANOID #ifdef IMGUI_DEBUG_PARANOID #define IM_ASSERT_PARANOID(_EXPR) IM_ASSERT(_EXPR) #else #define IM_ASSERT_PARANOID(_EXPR) #endif // Misc Macros #define IM_PI 3.14159265358979323846f #ifdef _WIN32 #define IM_NEWLINE "\r\n" // Play it nice with Windows users (Update: since 2018-05, Notepad finally appears to support Unix-style carriage returns!) #else #define IM_NEWLINE "\n" #endif #ifndef IM_TABSIZE // Until we move this to runtime and/or add proper tab support, at least allow users to compile-time override #define IM_TABSIZE (4) #endif #define IM_MEMALIGN(_OFF,_ALIGN) (((_OFF) + ((_ALIGN) - 1)) & ~((_ALIGN) - 1)) // Memory align e.g. IM_ALIGN(0,4)=0, IM_ALIGN(1,4)=4, IM_ALIGN(4,4)=4, IM_ALIGN(5,4)=8 #define IM_F32_TO_INT8_UNBOUND(_VAL) ((int)((_VAL) * 255.0f + ((_VAL)>=0 ? 0.5f : -0.5f))) // Unsaturated, for display purpose #define IM_F32_TO_INT8_SAT(_VAL) ((int)(ImSaturate(_VAL) * 255.0f + 0.5f)) // Saturated, always output 0..255 #define IM_TRUNC(_VAL) ((float)(int)(_VAL)) // ImTrunc() is not inlined in MSVC debug builds #define IM_ROUND(_VAL) ((float)(int)((_VAL) + 0.5f)) // #define IM_STRINGIFY_HELPER(_X) #_X #define IM_STRINGIFY(_X) IM_STRINGIFY_HELPER(_X) // Preprocessor idiom to stringify e.g. an integer. #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS #define IM_FLOOR IM_TRUNC #endif // Hint for branch prediction #if (defined(__cplusplus) && (__cplusplus >= 202002L)) || (defined(_MSVC_LANG) && (_MSVC_LANG >= 202002L)) #define IM_LIKELY [[likely]] #define IM_UNLIKELY [[unlikely]] #else #define IM_LIKELY #define IM_UNLIKELY #endif // Enforce cdecl calling convention for functions called by the standard library, in case compilation settings changed the default to e.g. __vectorcall #ifdef _MSC_VER #define IMGUI_CDECL __cdecl #else #define IMGUI_CDECL #endif // Warnings #if defined(_MSC_VER) && !defined(__clang__) #define IM_MSVC_WARNING_SUPPRESS(XXXX) __pragma(warning(suppress: XXXX)) #else #define IM_MSVC_WARNING_SUPPRESS(XXXX) #endif // Debug Tools // Use 'Metrics/Debugger->Tools->Item Picker' to break into the call-stack of a specific item. // This will call IM_DEBUG_BREAK() which you may redefine yourself. See https://github.com/scottt/debugbreak for more reference. #ifndef IM_DEBUG_BREAK #if defined (_MSC_VER) #define IM_DEBUG_BREAK() __debugbreak() #elif defined(__clang__) #define IM_DEBUG_BREAK() __builtin_debugtrap() #elif defined(__GNUC__) && (defined(__i386__) || defined(__x86_64__)) #define IM_DEBUG_BREAK() __asm__ volatile("int3;nop") #elif defined(__GNUC__) && defined(__thumb__) #define IM_DEBUG_BREAK() __asm__ volatile(".inst 0xde01") #elif defined(__GNUC__) && defined(__arm__) && !defined(__thumb__) #define IM_DEBUG_BREAK() __asm__ volatile(".inst 0xe7f001f0") #else #define IM_DEBUG_BREAK() IM_ASSERT(0) // It is expected that you define IM_DEBUG_BREAK() into something that will break nicely in a debugger! #endif #endif // #ifndef IM_DEBUG_BREAK // Format specifiers, printing 64-bit hasn't been decently standardized... // In a real application you should be using PRId64 and PRIu64 from (non-windows) and on Windows define them yourself. #if defined(_MSC_VER) && !defined(__clang__) #define IM_PRId64 "I64d" #define IM_PRIu64 "I64u" #define IM_PRIX64 "I64X" #else #define IM_PRId64 "lld" #define IM_PRIu64 "llu" #define IM_PRIX64 "llX" #endif //----------------------------------------------------------------------------- // [SECTION] Generic helpers // Note that the ImXXX helpers functions are lower-level than ImGui functions. // ImGui functions or the ImGui context are never called/used from other ImXXX functions. //----------------------------------------------------------------------------- // - Helpers: Hashing // - Helpers: Sorting // - Helpers: Bit manipulation // - Helpers: String // - Helpers: Formatting // - Helpers: UTF-8 <> wchar conversions // - Helpers: ImVec2/ImVec4 operators // - Helpers: Maths // - Helpers: Geometry // - Helper: ImVec1 // - Helper: ImVec2ih // - Helper: ImRect // - Helper: ImBitArray // - Helper: ImBitVector // - Helper: ImSpan<>, ImSpanAllocator<> // - Helper: ImPool<> // - Helper: ImChunkStream<> // - Helper: ImGuiTextIndex // - Helper: ImGuiStorage //----------------------------------------------------------------------------- // Helpers: Hashing IMGUI_API ImGuiID ImHashData(const void* data, size_t data_size, ImGuiID seed = 0); IMGUI_API ImGuiID ImHashStr(const char* data, size_t data_size = 0, ImGuiID seed = 0); // Helpers: Sorting #ifndef ImQsort static inline void ImQsort(void* base, size_t count, size_t size_of_element, int(IMGUI_CDECL *compare_func)(void const*, void const*)) { if (count > 1) qsort(base, count, size_of_element, compare_func); } #endif // Helpers: Color Blending IMGUI_API ImU32 ImAlphaBlendColors(ImU32 col_a, ImU32 col_b); // Helpers: Bit manipulation static inline bool ImIsPowerOfTwo(int v) { return v != 0 && (v & (v - 1)) == 0; } static inline bool ImIsPowerOfTwo(ImU64 v) { return v != 0 && (v & (v - 1)) == 0; } static inline int ImUpperPowerOfTwo(int v) { v--; v |= v >> 1; v |= v >> 2; v |= v >> 4; v |= v >> 8; v |= v >> 16; v++; return v; } static inline unsigned int ImCountSetBits(unsigned int v) { unsigned int count = 0; while (v > 0) { v = v & (v - 1); count++; } return count; } // Helpers: String #define ImStrlen strlen #define ImMemchr memchr IMGUI_API int ImStricmp(const char* str1, const char* str2); // Case insensitive compare. IMGUI_API int ImStrnicmp(const char* str1, const char* str2, size_t count); // Case insensitive compare to a certain count. IMGUI_API void ImStrncpy(char* dst, const char* src, size_t count); // Copy to a certain count and always zero terminate (strncpy doesn't). IMGUI_API char* ImStrdup(const char* str); // Duplicate a string. IMGUI_API char* ImStrdupcpy(char* dst, size_t* p_dst_size, const char* str); // Copy in provided buffer, recreate buffer if needed. IMGUI_API const char* ImStrchrRange(const char* str_begin, const char* str_end, char c); // Find first occurrence of 'c' in string range. IMGUI_API const char* ImStreolRange(const char* str, const char* str_end); // End end-of-line IMGUI_API const char* ImStristr(const char* haystack, const char* haystack_end, const char* needle, const char* needle_end); // Find a substring in a string range. IMGUI_API void ImStrTrimBlanks(char* str); // Remove leading and trailing blanks from a buffer. IMGUI_API const char* ImStrSkipBlank(const char* str); // Find first non-blank character. IMGUI_API int ImStrlenW(const ImWchar* str); // Computer string length (ImWchar string) IMGUI_API const char* ImStrbol(const char* buf_mid_line, const char* buf_begin); // Find beginning-of-line IM_MSVC_RUNTIME_CHECKS_OFF static inline char ImToUpper(char c) { return (c >= 'a' && c <= 'z') ? c &= ~32 : c; } static inline bool ImCharIsBlankA(char c) { return c == ' ' || c == '\t'; } static inline bool ImCharIsBlankW(unsigned int c) { return c == ' ' || c == '\t' || c == 0x3000; } static inline bool ImCharIsXdigitA(char c) { return (c >= '0' && c <= '9') || (c >= 'A' && c <= 'F') || (c >= 'a' && c <= 'f'); } IM_MSVC_RUNTIME_CHECKS_RESTORE // Helpers: Formatting IMGUI_API int ImFormatString(char* buf, size_t buf_size, const char* fmt, ...) IM_FMTARGS(3); IMGUI_API int ImFormatStringV(char* buf, size_t buf_size, const char* fmt, va_list args) IM_FMTLIST(3); IMGUI_API void ImFormatStringToTempBuffer(const char** out_buf, const char** out_buf_end, const char* fmt, ...) IM_FMTARGS(3); IMGUI_API void ImFormatStringToTempBufferV(const char** out_buf, const char** out_buf_end, const char* fmt, va_list args) IM_FMTLIST(3); IMGUI_API const char* ImParseFormatFindStart(const char* format); IMGUI_API const char* ImParseFormatFindEnd(const char* format); IMGUI_API const char* ImParseFormatTrimDecorations(const char* format, char* buf, size_t buf_size); IMGUI_API void ImParseFormatSanitizeForPrinting(const char* fmt_in, char* fmt_out, size_t fmt_out_size); IMGUI_API const char* ImParseFormatSanitizeForScanning(const char* fmt_in, char* fmt_out, size_t fmt_out_size); IMGUI_API int ImParseFormatPrecision(const char* format, int default_value); // Helpers: UTF-8 <> wchar conversions IMGUI_API const char* ImTextCharToUtf8(char out_buf[5], unsigned int c); // return out_buf IMGUI_API int ImTextStrToUtf8(char* out_buf, int out_buf_size, const ImWchar* in_text, const ImWchar* in_text_end); // return output UTF-8 bytes count IMGUI_API int ImTextCharFromUtf8(unsigned int* out_char, const char* in_text, const char* in_text_end); // read one character. return input UTF-8 bytes count IMGUI_API int ImTextStrFromUtf8(ImWchar* out_buf, int out_buf_size, const char* in_text, const char* in_text_end, const char** in_remaining = NULL); // return input UTF-8 bytes count IMGUI_API int ImTextCountCharsFromUtf8(const char* in_text, const char* in_text_end); // return number of UTF-8 code-points (NOT bytes count) IMGUI_API int ImTextCountUtf8BytesFromChar(const char* in_text, const char* in_text_end); // return number of bytes to express one char in UTF-8 IMGUI_API int ImTextCountUtf8BytesFromStr(const ImWchar* in_text, const ImWchar* in_text_end); // return number of bytes to express string in UTF-8 IMGUI_API const char* ImTextFindPreviousUtf8Codepoint(const char* in_text_start, const char* in_text_curr); // return previous UTF-8 code-point. IMGUI_API int ImTextCountLines(const char* in_text, const char* in_text_end); // return number of lines taken by text. trailing carriage return doesn't count as an extra line. // Helpers: File System #ifdef IMGUI_DISABLE_FILE_FUNCTIONS #define IMGUI_DISABLE_DEFAULT_FILE_FUNCTIONS typedef void* ImFileHandle; static inline ImFileHandle ImFileOpen(const char*, const char*) { return NULL; } static inline bool ImFileClose(ImFileHandle) { return false; } static inline ImU64 ImFileGetSize(ImFileHandle) { return (ImU64)-1; } static inline ImU64 ImFileRead(void*, ImU64, ImU64, ImFileHandle) { return 0; } static inline ImU64 ImFileWrite(const void*, ImU64, ImU64, ImFileHandle) { return 0; } #endif #ifndef IMGUI_DISABLE_DEFAULT_FILE_FUNCTIONS typedef FILE* ImFileHandle; IMGUI_API ImFileHandle ImFileOpen(const char* filename, const char* mode); IMGUI_API bool ImFileClose(ImFileHandle file); IMGUI_API ImU64 ImFileGetSize(ImFileHandle file); IMGUI_API ImU64 ImFileRead(void* data, ImU64 size, ImU64 count, ImFileHandle file); IMGUI_API ImU64 ImFileWrite(const void* data, ImU64 size, ImU64 count, ImFileHandle file); #else #define IMGUI_DISABLE_TTY_FUNCTIONS // Can't use stdout, fflush if we are not using default file functions #endif IMGUI_API void* ImFileLoadToMemory(const char* filename, const char* mode, size_t* out_file_size = NULL, int padding_bytes = 0); // Helpers: Maths IM_MSVC_RUNTIME_CHECKS_OFF // - Wrapper for standard libs functions. (Note that imgui_demo.cpp does _not_ use them to keep the code easy to copy) #ifndef IMGUI_DISABLE_DEFAULT_MATH_FUNCTIONS #define ImFabs(X) fabsf(X) #define ImSqrt(X) sqrtf(X) #define ImFmod(X, Y) fmodf((X), (Y)) #define ImCos(X) cosf(X) #define ImSin(X) sinf(X) #define ImAcos(X) acosf(X) #define ImAtan2(Y, X) atan2f((Y), (X)) #define ImAtof(STR) atof(STR) #define ImCeil(X) ceilf(X) static inline float ImPow(float x, float y) { return powf(x, y); } // DragBehaviorT/SliderBehaviorT uses ImPow with either float/double and need the precision static inline double ImPow(double x, double y) { return pow(x, y); } static inline float ImLog(float x) { return logf(x); } // DragBehaviorT/SliderBehaviorT uses ImLog with either float/double and need the precision static inline double ImLog(double x) { return log(x); } static inline int ImAbs(int x) { return x < 0 ? -x : x; } static inline float ImAbs(float x) { return fabsf(x); } static inline double ImAbs(double x) { return fabs(x); } static inline float ImSign(float x) { return (x < 0.0f) ? -1.0f : (x > 0.0f) ? 1.0f : 0.0f; } // Sign operator - returns -1, 0 or 1 based on sign of argument static inline double ImSign(double x) { return (x < 0.0) ? -1.0 : (x > 0.0) ? 1.0 : 0.0; } #ifdef IMGUI_ENABLE_SSE static inline float ImRsqrt(float x) { return _mm_cvtss_f32(_mm_rsqrt_ss(_mm_set_ss(x))); } #else static inline float ImRsqrt(float x) { return 1.0f / sqrtf(x); } #endif static inline double ImRsqrt(double x) { return 1.0 / sqrt(x); } #endif // - ImMin/ImMax/ImClamp/ImLerp/ImSwap are used by widgets which support variety of types: signed/unsigned int/long long float/double // (Exceptionally using templates here but we could also redefine them for those types) template static inline T ImMin(T lhs, T rhs) { return lhs < rhs ? lhs : rhs; } template static inline T ImMax(T lhs, T rhs) { return lhs >= rhs ? lhs : rhs; } template static inline T ImClamp(T v, T mn, T mx) { return (v < mn) ? mn : (v > mx) ? mx : v; } template static inline T ImLerp(T a, T b, float t) { return (T)(a + (b - a) * t); } template static inline void ImSwap(T& a, T& b) { T tmp = a; a = b; b = tmp; } template static inline T ImAddClampOverflow(T a, T b, T mn, T mx) { if (b < 0 && (a < mn - b)) return mn; if (b > 0 && (a > mx - b)) return mx; return a + b; } template static inline T ImSubClampOverflow(T a, T b, T mn, T mx) { if (b > 0 && (a < mn + b)) return mn; if (b < 0 && (a > mx + b)) return mx; return a - b; } // - Misc maths helpers static inline ImVec2 ImMin(const ImVec2& lhs, const ImVec2& rhs) { return ImVec2(lhs.x < rhs.x ? lhs.x : rhs.x, lhs.y < rhs.y ? lhs.y : rhs.y); } static inline ImVec2 ImMax(const ImVec2& lhs, const ImVec2& rhs) { return ImVec2(lhs.x >= rhs.x ? lhs.x : rhs.x, lhs.y >= rhs.y ? lhs.y : rhs.y); } static inline ImVec2 ImClamp(const ImVec2& v, const ImVec2&mn, const ImVec2&mx) { return ImVec2((v.x < mn.x) ? mn.x : (v.x > mx.x) ? mx.x : v.x, (v.y < mn.y) ? mn.y : (v.y > mx.y) ? mx.y : v.y); } static inline ImVec2 ImLerp(const ImVec2& a, const ImVec2& b, float t) { return ImVec2(a.x + (b.x - a.x) * t, a.y + (b.y - a.y) * t); } static inline ImVec2 ImLerp(const ImVec2& a, const ImVec2& b, const ImVec2& t) { return ImVec2(a.x + (b.x - a.x) * t.x, a.y + (b.y - a.y) * t.y); } static inline ImVec4 ImLerp(const ImVec4& a, const ImVec4& b, float t) { return ImVec4(a.x + (b.x - a.x) * t, a.y + (b.y - a.y) * t, a.z + (b.z - a.z) * t, a.w + (b.w - a.w) * t); } static inline float ImSaturate(float f) { return (f < 0.0f) ? 0.0f : (f > 1.0f) ? 1.0f : f; } static inline float ImLengthSqr(const ImVec2& lhs) { return (lhs.x * lhs.x) + (lhs.y * lhs.y); } static inline float ImLengthSqr(const ImVec4& lhs) { return (lhs.x * lhs.x) + (lhs.y * lhs.y) + (lhs.z * lhs.z) + (lhs.w * lhs.w); } static inline float ImInvLength(const ImVec2& lhs, float fail_value) { float d = (lhs.x * lhs.x) + (lhs.y * lhs.y); if (d > 0.0f) return ImRsqrt(d); return fail_value; } static inline float ImTrunc(float f) { return (float)(int)(f); } static inline ImVec2 ImTrunc(const ImVec2& v) { return ImVec2((float)(int)(v.x), (float)(int)(v.y)); } static inline float ImFloor(float f) { return (float)((f >= 0 || (float)(int)f == f) ? (int)f : (int)f - 1); } // Decent replacement for floorf() static inline ImVec2 ImFloor(const ImVec2& v) { return ImVec2(ImFloor(v.x), ImFloor(v.y)); } static inline int ImModPositive(int a, int b) { return (a + b) % b; } static inline float ImDot(const ImVec2& a, const ImVec2& b) { return a.x * b.x + a.y * b.y; } static inline ImVec2 ImRotate(const ImVec2& v, float cos_a, float sin_a) { return ImVec2(v.x * cos_a - v.y * sin_a, v.x * sin_a + v.y * cos_a); } static inline float ImLinearSweep(float current, float target, float speed) { if (current < target) return ImMin(current + speed, target); if (current > target) return ImMax(current - speed, target); return current; } static inline float ImLinearRemapClamp(float s0, float s1, float d0, float d1, float x) { return ImSaturate((x - s0) / (s1 - s0)) * (d1 - d0) + d0; } static inline ImVec2 ImMul(const ImVec2& lhs, const ImVec2& rhs) { return ImVec2(lhs.x * rhs.x, lhs.y * rhs.y); } static inline bool ImIsFloatAboveGuaranteedIntegerPrecision(float f) { return f <= -16777216 || f >= 16777216; } static inline float ImExponentialMovingAverage(float avg, float sample, int n) { avg -= avg / n; avg += sample / n; return avg; } IM_MSVC_RUNTIME_CHECKS_RESTORE // Helpers: Geometry IMGUI_API ImVec2 ImBezierCubicCalc(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, float t); IMGUI_API ImVec2 ImBezierCubicClosestPoint(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, const ImVec2& p, int num_segments); // For curves with explicit number of segments IMGUI_API ImVec2 ImBezierCubicClosestPointCasteljau(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, const ImVec2& p4, const ImVec2& p, float tess_tol);// For auto-tessellated curves you can use tess_tol = style.CurveTessellationTol IMGUI_API ImVec2 ImBezierQuadraticCalc(const ImVec2& p1, const ImVec2& p2, const ImVec2& p3, float t); IMGUI_API ImVec2 ImLineClosestPoint(const ImVec2& a, const ImVec2& b, const ImVec2& p); IMGUI_API bool ImTriangleContainsPoint(const ImVec2& a, const ImVec2& b, const ImVec2& c, const ImVec2& p); IMGUI_API ImVec2 ImTriangleClosestPoint(const ImVec2& a, const ImVec2& b, const ImVec2& c, const ImVec2& p); IMGUI_API void ImTriangleBarycentricCoords(const ImVec2& a, const ImVec2& b, const ImVec2& c, const ImVec2& p, float& out_u, float& out_v, float& out_w); inline float ImTriangleArea(const ImVec2& a, const ImVec2& b, const ImVec2& c) { return ImFabs((a.x * (b.y - c.y)) + (b.x * (c.y - a.y)) + (c.x * (a.y - b.y))) * 0.5f; } inline bool ImTriangleIsClockwise(const ImVec2& a, const ImVec2& b, const ImVec2& c) { return ((b.x - a.x) * (c.y - b.y)) - ((c.x - b.x) * (b.y - a.y)) > 0.0f; } // Helper: ImVec1 (1D vector) // (this odd construct is used to facilitate the transition between 1D and 2D, and the maintenance of some branches/patches) IM_MSVC_RUNTIME_CHECKS_OFF struct ImVec1 { float x; constexpr ImVec1() : x(0.0f) { } constexpr ImVec1(float _x) : x(_x) { } }; // Helper: ImVec2ih (2D vector, half-size integer, for long-term packed storage) struct ImVec2ih { short x, y; constexpr ImVec2ih() : x(0), y(0) {} constexpr ImVec2ih(short _x, short _y) : x(_x), y(_y) {} constexpr explicit ImVec2ih(const ImVec2& rhs) : x((short)rhs.x), y((short)rhs.y) {} }; // Helper: ImRect (2D axis aligned bounding-box) // NB: we can't rely on ImVec2 math operators being available here! struct IMGUI_API ImRect { ImVec2 Min; // Upper-left ImVec2 Max; // Lower-right constexpr ImRect() : Min(0.0f, 0.0f), Max(0.0f, 0.0f) {} constexpr ImRect(const ImVec2& min, const ImVec2& max) : Min(min), Max(max) {} constexpr ImRect(const ImVec4& v) : Min(v.x, v.y), Max(v.z, v.w) {} constexpr ImRect(float x1, float y1, float x2, float y2) : Min(x1, y1), Max(x2, y2) {} ImVec2 GetCenter() const { return ImVec2((Min.x + Max.x) * 0.5f, (Min.y + Max.y) * 0.5f); } ImVec2 GetSize() const { return ImVec2(Max.x - Min.x, Max.y - Min.y); } float GetWidth() const { return Max.x - Min.x; } float GetHeight() const { return Max.y - Min.y; } float GetArea() const { return (Max.x - Min.x) * (Max.y - Min.y); } ImVec2 GetTL() const { return Min; } // Top-left ImVec2 GetTR() const { return ImVec2(Max.x, Min.y); } // Top-right ImVec2 GetBL() const { return ImVec2(Min.x, Max.y); } // Bottom-left ImVec2 GetBR() const { return Max; } // Bottom-right bool Contains(const ImVec2& p) const { return p.x >= Min.x && p.y >= Min.y && p.x < Max.x && p.y < Max.y; } bool Contains(const ImRect& r) const { return r.Min.x >= Min.x && r.Min.y >= Min.y && r.Max.x <= Max.x && r.Max.y <= Max.y; } bool ContainsWithPad(const ImVec2& p, const ImVec2& pad) const { return p.x >= Min.x - pad.x && p.y >= Min.y - pad.y && p.x < Max.x + pad.x && p.y < Max.y + pad.y; } bool Overlaps(const ImRect& r) const { return r.Min.y < Max.y && r.Max.y > Min.y && r.Min.x < Max.x && r.Max.x > Min.x; } void Add(const ImVec2& p) { if (Min.x > p.x) Min.x = p.x; if (Min.y > p.y) Min.y = p.y; if (Max.x < p.x) Max.x = p.x; if (Max.y < p.y) Max.y = p.y; } void Add(const ImRect& r) { if (Min.x > r.Min.x) Min.x = r.Min.x; if (Min.y > r.Min.y) Min.y = r.Min.y; if (Max.x < r.Max.x) Max.x = r.Max.x; if (Max.y < r.Max.y) Max.y = r.Max.y; } void Expand(const float amount) { Min.x -= amount; Min.y -= amount; Max.x += amount; Max.y += amount; } void Expand(const ImVec2& amount) { Min.x -= amount.x; Min.y -= amount.y; Max.x += amount.x; Max.y += amount.y; } void Translate(const ImVec2& d) { Min.x += d.x; Min.y += d.y; Max.x += d.x; Max.y += d.y; } void TranslateX(float dx) { Min.x += dx; Max.x += dx; } void TranslateY(float dy) { Min.y += dy; Max.y += dy; } void ClipWith(const ImRect& r) { Min = ImMax(Min, r.Min); Max = ImMin(Max, r.Max); } // Simple version, may lead to an inverted rectangle, which is fine for Contains/Overlaps test but not for display. void ClipWithFull(const ImRect& r) { Min = ImClamp(Min, r.Min, r.Max); Max = ImClamp(Max, r.Min, r.Max); } // Full version, ensure both points are fully clipped. void Floor() { Min.x = IM_TRUNC(Min.x); Min.y = IM_TRUNC(Min.y); Max.x = IM_TRUNC(Max.x); Max.y = IM_TRUNC(Max.y); } bool IsInverted() const { return Min.x > Max.x || Min.y > Max.y; } ImVec4 ToVec4() const { return ImVec4(Min.x, Min.y, Max.x, Max.y); } }; // Helper: ImBitArray #define IM_BITARRAY_TESTBIT(_ARRAY, _N) ((_ARRAY[(_N) >> 5] & ((ImU32)1 << ((_N) & 31))) != 0) // Macro version of ImBitArrayTestBit(): ensure args have side-effect or are costly! #define IM_BITARRAY_CLEARBIT(_ARRAY, _N) ((_ARRAY[(_N) >> 5] &= ~((ImU32)1 << ((_N) & 31)))) // Macro version of ImBitArrayClearBit(): ensure args have side-effect or are costly! inline size_t ImBitArrayGetStorageSizeInBytes(int bitcount) { return (size_t)((bitcount + 31) >> 5) << 2; } inline void ImBitArrayClearAllBits(ImU32* arr, int bitcount){ memset(arr, 0, ImBitArrayGetStorageSizeInBytes(bitcount)); } inline bool ImBitArrayTestBit(const ImU32* arr, int n) { ImU32 mask = (ImU32)1 << (n & 31); return (arr[n >> 5] & mask) != 0; } inline void ImBitArrayClearBit(ImU32* arr, int n) { ImU32 mask = (ImU32)1 << (n & 31); arr[n >> 5] &= ~mask; } inline void ImBitArraySetBit(ImU32* arr, int n) { ImU32 mask = (ImU32)1 << (n & 31); arr[n >> 5] |= mask; } inline void ImBitArraySetBitRange(ImU32* arr, int n, int n2) // Works on range [n..n2) { n2--; while (n <= n2) { int a_mod = (n & 31); int b_mod = (n2 > (n | 31) ? 31 : (n2 & 31)) + 1; ImU32 mask = (ImU32)(((ImU64)1 << b_mod) - 1) & ~(ImU32)(((ImU64)1 << a_mod) - 1); arr[n >> 5] |= mask; n = (n + 32) & ~31; } } typedef ImU32* ImBitArrayPtr; // Name for use in structs // Helper: ImBitArray class (wrapper over ImBitArray functions) // Store 1-bit per value. template struct ImBitArray { ImU32 Storage[(BITCOUNT + 31) >> 5]; ImBitArray() { ClearAllBits(); } void ClearAllBits() { memset(Storage, 0, sizeof(Storage)); } void SetAllBits() { memset(Storage, 255, sizeof(Storage)); } bool TestBit(int n) const { n += OFFSET; IM_ASSERT(n >= 0 && n < BITCOUNT); return IM_BITARRAY_TESTBIT(Storage, n); } void SetBit(int n) { n += OFFSET; IM_ASSERT(n >= 0 && n < BITCOUNT); ImBitArraySetBit(Storage, n); } void ClearBit(int n) { n += OFFSET; IM_ASSERT(n >= 0 && n < BITCOUNT); ImBitArrayClearBit(Storage, n); } void SetBitRange(int n, int n2) { n += OFFSET; n2 += OFFSET; IM_ASSERT(n >= 0 && n < BITCOUNT && n2 > n && n2 <= BITCOUNT); ImBitArraySetBitRange(Storage, n, n2); } // Works on range [n..n2) bool operator[](int n) const { n += OFFSET; IM_ASSERT(n >= 0 && n < BITCOUNT); return IM_BITARRAY_TESTBIT(Storage, n); } }; // Helper: ImBitVector // Store 1-bit per value. struct IMGUI_API ImBitVector { ImVector Storage; void Create(int sz) { Storage.resize((sz + 31) >> 5); memset(Storage.Data, 0, (size_t)Storage.Size * sizeof(Storage.Data[0])); } void Clear() { Storage.clear(); } bool TestBit(int n) const { IM_ASSERT(n < (Storage.Size << 5)); return IM_BITARRAY_TESTBIT(Storage.Data, n); } void SetBit(int n) { IM_ASSERT(n < (Storage.Size << 5)); ImBitArraySetBit(Storage.Data, n); } void ClearBit(int n) { IM_ASSERT(n < (Storage.Size << 5)); ImBitArrayClearBit(Storage.Data, n); } }; IM_MSVC_RUNTIME_CHECKS_RESTORE // Helper: ImSpan<> // Pointing to a span of data we don't own. template struct ImSpan { T* Data; T* DataEnd; // Constructors, destructor inline ImSpan() { Data = DataEnd = NULL; } inline ImSpan(T* data, int size) { Data = data; DataEnd = data + size; } inline ImSpan(T* data, T* data_end) { Data = data; DataEnd = data_end; } inline void set(T* data, int size) { Data = data; DataEnd = data + size; } inline void set(T* data, T* data_end) { Data = data; DataEnd = data_end; } inline int size() const { return (int)(ptrdiff_t)(DataEnd - Data); } inline int size_in_bytes() const { return (int)(ptrdiff_t)(DataEnd - Data) * (int)sizeof(T); } inline T& operator[](int i) { T* p = Data + i; IM_ASSERT(p >= Data && p < DataEnd); return *p; } inline const T& operator[](int i) const { const T* p = Data + i; IM_ASSERT(p >= Data && p < DataEnd); return *p; } inline T* begin() { return Data; } inline const T* begin() const { return Data; } inline T* end() { return DataEnd; } inline const T* end() const { return DataEnd; } // Utilities inline int index_from_ptr(const T* it) const { IM_ASSERT(it >= Data && it < DataEnd); const ptrdiff_t off = it - Data; return (int)off; } }; // Helper: ImSpanAllocator<> // Facilitate storing multiple chunks into a single large block (the "arena") // - Usage: call Reserve() N times, allocate GetArenaSizeInBytes() worth, pass it to SetArenaBasePtr(), call GetSpan() N times to retrieve the aligned ranges. template struct ImSpanAllocator { char* BasePtr; int CurrOff; int CurrIdx; int Offsets[CHUNKS]; int Sizes[CHUNKS]; ImSpanAllocator() { memset(this, 0, sizeof(*this)); } inline void Reserve(int n, size_t sz, int a=4) { IM_ASSERT(n == CurrIdx && n < CHUNKS); CurrOff = IM_MEMALIGN(CurrOff, a); Offsets[n] = CurrOff; Sizes[n] = (int)sz; CurrIdx++; CurrOff += (int)sz; } inline int GetArenaSizeInBytes() { return CurrOff; } inline void SetArenaBasePtr(void* base_ptr) { BasePtr = (char*)base_ptr; } inline void* GetSpanPtrBegin(int n) { IM_ASSERT(n >= 0 && n < CHUNKS && CurrIdx == CHUNKS); return (void*)(BasePtr + Offsets[n]); } inline void* GetSpanPtrEnd(int n) { IM_ASSERT(n >= 0 && n < CHUNKS && CurrIdx == CHUNKS); return (void*)(BasePtr + Offsets[n] + Sizes[n]); } template inline void GetSpan(int n, ImSpan* span) { span->set((T*)GetSpanPtrBegin(n), (T*)GetSpanPtrEnd(n)); } }; // Helper: ImPool<> // Basic keyed storage for contiguous instances, slow/amortized insertion, O(1) indexable, O(Log N) queries by ID over a dense/hot buffer, // Honor constructor/destructor. Add/remove invalidate all pointers. Indexes have the same lifetime as the associated object. typedef int ImPoolIdx; template struct ImPool { ImVector Buf; // Contiguous data ImGuiStorage Map; // ID->Index ImPoolIdx FreeIdx; // Next free idx to use ImPoolIdx AliveCount; // Number of active/alive items (for display purpose) ImPool() { FreeIdx = AliveCount = 0; } ~ImPool() { Clear(); } T* GetByKey(ImGuiID key) { int idx = Map.GetInt(key, -1); return (idx != -1) ? &Buf[idx] : NULL; } T* GetByIndex(ImPoolIdx n) { return &Buf[n]; } ImPoolIdx GetIndex(const T* p) const { IM_ASSERT(p >= Buf.Data && p < Buf.Data + Buf.Size); return (ImPoolIdx)(p - Buf.Data); } T* GetOrAddByKey(ImGuiID key) { int* p_idx = Map.GetIntRef(key, -1); if (*p_idx != -1) return &Buf[*p_idx]; *p_idx = FreeIdx; return Add(); } bool Contains(const T* p) const { return (p >= Buf.Data && p < Buf.Data + Buf.Size); } void Clear() { for (int n = 0; n < Map.Data.Size; n++) { int idx = Map.Data[n].val_i; if (idx != -1) Buf[idx].~T(); } Map.Clear(); Buf.clear(); FreeIdx = AliveCount = 0; } T* Add() { int idx = FreeIdx; if (idx == Buf.Size) { Buf.resize(Buf.Size + 1); FreeIdx++; } else { FreeIdx = *(int*)&Buf[idx]; } IM_PLACEMENT_NEW(&Buf[idx]) T(); AliveCount++; return &Buf[idx]; } void Remove(ImGuiID key, const T* p) { Remove(key, GetIndex(p)); } void Remove(ImGuiID key, ImPoolIdx idx) { Buf[idx].~T(); *(int*)&Buf[idx] = FreeIdx; FreeIdx = idx; Map.SetInt(key, -1); AliveCount--; } void Reserve(int capacity) { Buf.reserve(capacity); Map.Data.reserve(capacity); } // To iterate a ImPool: for (int n = 0; n < pool.GetMapSize(); n++) if (T* t = pool.TryGetMapData(n)) { ... } // Can be avoided if you know .Remove() has never been called on the pool, or AliveCount == GetMapSize() int GetAliveCount() const { return AliveCount; } // Number of active/alive items in the pool (for display purpose) int GetBufSize() const { return Buf.Size; } int GetMapSize() const { return Map.Data.Size; } // It is the map we need iterate to find valid items, since we don't have "alive" storage anywhere T* TryGetMapData(ImPoolIdx n) { int idx = Map.Data[n].val_i; if (idx == -1) return NULL; return GetByIndex(idx); } }; // Helper: ImChunkStream<> // Build and iterate a contiguous stream of variable-sized structures. // This is used by Settings to store persistent data while reducing allocation count. // We store the chunk size first, and align the final size on 4 bytes boundaries. // The tedious/zealous amount of casting is to avoid -Wcast-align warnings. template struct ImChunkStream { ImVector Buf; void clear() { Buf.clear(); } bool empty() const { return Buf.Size == 0; } int size() const { return Buf.Size; } T* alloc_chunk(size_t sz) { size_t HDR_SZ = 4; sz = IM_MEMALIGN(HDR_SZ + sz, 4u); int off = Buf.Size; Buf.resize(off + (int)sz); ((int*)(void*)(Buf.Data + off))[0] = (int)sz; return (T*)(void*)(Buf.Data + off + (int)HDR_SZ); } T* begin() { size_t HDR_SZ = 4; if (!Buf.Data) return NULL; return (T*)(void*)(Buf.Data + HDR_SZ); } T* next_chunk(T* p) { size_t HDR_SZ = 4; IM_ASSERT(p >= begin() && p < end()); p = (T*)(void*)((char*)(void*)p + chunk_size(p)); if (p == (T*)(void*)((char*)end() + HDR_SZ)) return (T*)0; IM_ASSERT(p < end()); return p; } int chunk_size(const T* p) { return ((const int*)p)[-1]; } T* end() { return (T*)(void*)(Buf.Data + Buf.Size); } int offset_from_ptr(const T* p) { IM_ASSERT(p >= begin() && p < end()); const ptrdiff_t off = (const char*)p - Buf.Data; return (int)off; } T* ptr_from_offset(int off) { IM_ASSERT(off >= 4 && off < Buf.Size); return (T*)(void*)(Buf.Data + off); } void swap(ImChunkStream& rhs) { rhs.Buf.swap(Buf); } }; // Helper: ImGuiTextIndex // Maintain a line index for a text buffer. This is a strong candidate to be moved into the public API. struct ImGuiTextIndex { ImVector LineOffsets; int EndOffset = 0; // Because we don't own text buffer we need to maintain EndOffset (may bake in LineOffsets?) void clear() { LineOffsets.clear(); EndOffset = 0; } int size() { return LineOffsets.Size; } const char* get_line_begin(const char* base, int n) { return base + LineOffsets[n]; } const char* get_line_end(const char* base, int n) { return base + (n + 1 < LineOffsets.Size ? (LineOffsets[n + 1] - 1) : EndOffset); } void append(const char* base, int old_size, int new_size); }; // Helper: ImGuiStorage IMGUI_API ImGuiStoragePair* ImLowerBound(ImGuiStoragePair* in_begin, ImGuiStoragePair* in_end, ImGuiID key); //----------------------------------------------------------------------------- // [SECTION] ImDrawList support //----------------------------------------------------------------------------- // ImDrawList: Helper function to calculate a circle's segment count given its radius and a "maximum error" value. // Estimation of number of circle segment based on error is derived using method described in https://stackoverflow.com/a/2244088/15194693 // Number of segments (N) is calculated using equation: // N = ceil ( pi / acos(1 - error / r) ) where r > 0, error <= r // Our equation is significantly simpler that one in the post thanks for choosing segment that is // perpendicular to X axis. Follow steps in the article from this starting condition and you will // will get this result. // // Rendering circles with an odd number of segments, while mathematically correct will produce // asymmetrical results on the raster grid. Therefore we're rounding N to next even number (7->8, 8->8, 9->10 etc.) #define IM_ROUNDUP_TO_EVEN(_V) ((((_V) + 1) / 2) * 2) #define IM_DRAWLIST_CIRCLE_AUTO_SEGMENT_MIN 4 #define IM_DRAWLIST_CIRCLE_AUTO_SEGMENT_MAX 512 #define IM_DRAWLIST_CIRCLE_AUTO_SEGMENT_CALC(_RAD,_MAXERROR) ImClamp(IM_ROUNDUP_TO_EVEN((int)ImCeil(IM_PI / ImAcos(1 - ImMin((_MAXERROR), (_RAD)) / (_RAD)))), IM_DRAWLIST_CIRCLE_AUTO_SEGMENT_MIN, IM_DRAWLIST_CIRCLE_AUTO_SEGMENT_MAX) // Raw equation from IM_DRAWLIST_CIRCLE_AUTO_SEGMENT_CALC rewritten for 'r' and 'error'. #define IM_DRAWLIST_CIRCLE_AUTO_SEGMENT_CALC_R(_N,_MAXERROR) ((_MAXERROR) / (1 - ImCos(IM_PI / ImMax((float)(_N), IM_PI)))) #define IM_DRAWLIST_CIRCLE_AUTO_SEGMENT_CALC_ERROR(_N,_RAD) ((1 - ImCos(IM_PI / ImMax((float)(_N), IM_PI))) / (_RAD)) // ImDrawList: Lookup table size for adaptive arc drawing, cover full circle. #ifndef IM_DRAWLIST_ARCFAST_TABLE_SIZE #define IM_DRAWLIST_ARCFAST_TABLE_SIZE 48 // Number of samples in lookup table. #endif #define IM_DRAWLIST_ARCFAST_SAMPLE_MAX IM_DRAWLIST_ARCFAST_TABLE_SIZE // Sample index _PathArcToFastEx() for 360 angle. // Data shared between all ImDrawList instances // Conceptually this could have been called e.g. ImDrawListSharedContext // Typically one ImGui context would create and maintain one of this. // You may want to create your own instance of you try to ImDrawList completely without ImGui. In that case, watch out for future changes to this structure. struct IMGUI_API ImDrawListSharedData { ImVec2 TexUvWhitePixel; // UV of white pixel in the atlas const ImVec4* TexUvLines; // UV of anti-aliased lines in the atlas ImFont* Font; // Current/default font (optional, for simplified AddText overload) float FontSize; // Current/default font size (optional, for simplified AddText overload) float FontScale; // Current/default font scale (== FontSize / Font->FontSize) float CurveTessellationTol; // Tessellation tolerance when using PathBezierCurveTo() float CircleSegmentMaxError; // Number of circle segments to use per pixel of radius for AddCircle() etc float InitialFringeScale; // Initial scale to apply to AA fringe ImDrawListFlags InitialFlags; // Initial flags at the beginning of the frame (it is possible to alter flags on a per-drawlist basis afterwards) ImVec4 ClipRectFullscreen; // Value for PushClipRectFullscreen() ImVector TempBuffer; // Temporary write buffer // Lookup tables ImVec2 ArcFastVtx[IM_DRAWLIST_ARCFAST_TABLE_SIZE]; // Sample points on the quarter of the circle. float ArcFastRadiusCutoff; // Cutoff radius after which arc drawing will fallback to slower PathArcTo() ImU8 CircleSegmentCounts[64]; // Precomputed segment count for given radius before we calculate it dynamically (to avoid calculation overhead) ImDrawListSharedData(); void SetCircleTessellationMaxError(float max_error); }; struct ImDrawDataBuilder { ImVector* Layers[2]; // Pointers to global layers for: regular, tooltip. LayersP[0] is owned by DrawData. ImVector LayerData1; ImDrawDataBuilder() { memset(this, 0, sizeof(*this)); } }; //----------------------------------------------------------------------------- // [SECTION] Style support //----------------------------------------------------------------------------- struct ImGuiStyleVarInfo { ImU32 Count : 8; // 1+ ImGuiDataType DataType : 8; ImU32 Offset : 16; // Offset in parent structure void* GetVarPtr(void* parent) const { return (void*)((unsigned char*)parent + Offset); } }; // Stacked color modifier, backup of modified data so we can restore it struct ImGuiColorMod { ImGuiCol Col; ImVec4 BackupValue; }; // Stacked style modifier, backup of modified data so we can restore it. Data type inferred from the variable. struct ImGuiStyleMod { ImGuiStyleVar VarIdx; union { int BackupInt[2]; float BackupFloat[2]; }; ImGuiStyleMod(ImGuiStyleVar idx, int v) { VarIdx = idx; BackupInt[0] = v; } ImGuiStyleMod(ImGuiStyleVar idx, float v) { VarIdx = idx; BackupFloat[0] = v; } ImGuiStyleMod(ImGuiStyleVar idx, ImVec2 v) { VarIdx = idx; BackupFloat[0] = v.x; BackupFloat[1] = v.y; } }; //----------------------------------------------------------------------------- // [SECTION] Data types support //----------------------------------------------------------------------------- struct ImGuiDataTypeStorage { ImU8 Data[8]; // Opaque storage to fit any data up to ImGuiDataType_COUNT }; // Type information associated to one ImGuiDataType. Retrieve with DataTypeGetInfo(). struct ImGuiDataTypeInfo { size_t Size; // Size in bytes const char* Name; // Short descriptive name for the type, for debugging const char* PrintFmt; // Default printf format for the type const char* ScanFmt; // Default scanf format for the type }; // Extend ImGuiDataType_ enum ImGuiDataTypePrivate_ { ImGuiDataType_Pointer = ImGuiDataType_COUNT, ImGuiDataType_ID, }; //----------------------------------------------------------------------------- // [SECTION] Widgets support: flags, enums, data structures //----------------------------------------------------------------------------- // Extend ImGuiItemFlags // - input: PushItemFlag() manipulates g.CurrentItemFlags, g.NextItemData.ItemFlags, ItemAdd() calls may add extra flags too. // - output: stored in g.LastItemData.ItemFlags enum ImGuiItemFlagsPrivate_ { // Controlled by user ImGuiItemFlags_Disabled = 1 << 10, // false // Disable interactions (DOES NOT affect visuals. DO NOT mix direct use of this with BeginDisabled(). See BeginDisabled()/EndDisabled() for full disable feature, and github #211). ImGuiItemFlags_ReadOnly = 1 << 11, // false // [ALPHA] Allow hovering interactions but underlying value is not changed. ImGuiItemFlags_MixedValue = 1 << 12, // false // [BETA] Represent a mixed/indeterminate value, generally multi-selection where values differ. Currently only supported by Checkbox() (later should support all sorts of widgets) ImGuiItemFlags_NoWindowHoverableCheck = 1 << 13, // false // Disable hoverable check in ItemHoverable() ImGuiItemFlags_AllowOverlap = 1 << 14, // false // Allow being overlapped by another widget. Not-hovered to Hovered transition deferred by a frame. ImGuiItemFlags_NoNavDisableMouseHover = 1 << 15, // false // Nav keyboard/gamepad mode doesn't disable hover highlight (behave as if NavHighlightItemUnderNav==false). ImGuiItemFlags_NoMarkEdited = 1 << 16, // false // Skip calling MarkItemEdited() // Controlled by widget code ImGuiItemFlags_Inputable = 1 << 20, // false // [WIP] Auto-activate input mode when tab focused. Currently only used and supported by a few items before it becomes a generic feature. ImGuiItemFlags_HasSelectionUserData = 1 << 21, // false // Set by SetNextItemSelectionUserData() ImGuiItemFlags_IsMultiSelect = 1 << 22, // false // Set by SetNextItemSelectionUserData() ImGuiItemFlags_Default_ = ImGuiItemFlags_AutoClosePopups, // Please don't change, use PushItemFlag() instead. // Obsolete //ImGuiItemFlags_SelectableDontClosePopup = !ImGuiItemFlags_AutoClosePopups, // Can't have a redirect as we inverted the behavior }; // Status flags for an already submitted item // - output: stored in g.LastItemData.StatusFlags enum ImGuiItemStatusFlags_ { ImGuiItemStatusFlags_None = 0, ImGuiItemStatusFlags_HoveredRect = 1 << 0, // Mouse position is within item rectangle (does NOT mean that the window is in correct z-order and can be hovered!, this is only one part of the most-common IsItemHovered test) ImGuiItemStatusFlags_HasDisplayRect = 1 << 1, // g.LastItemData.DisplayRect is valid ImGuiItemStatusFlags_Edited = 1 << 2, // Value exposed by item was edited in the current frame (should match the bool return value of most widgets) ImGuiItemStatusFlags_ToggledSelection = 1 << 3, // Set when Selectable(), TreeNode() reports toggling a selection. We can't report "Selected", only state changes, in order to easily handle clipping with less issues. ImGuiItemStatusFlags_ToggledOpen = 1 << 4, // Set when TreeNode() reports toggling their open state. ImGuiItemStatusFlags_HasDeactivated = 1 << 5, // Set if the widget/group is able to provide data for the ImGuiItemStatusFlags_Deactivated flag. ImGuiItemStatusFlags_Deactivated = 1 << 6, // Only valid if ImGuiItemStatusFlags_HasDeactivated is set. ImGuiItemStatusFlags_HoveredWindow = 1 << 7, // Override the HoveredWindow test to allow cross-window hover testing. ImGuiItemStatusFlags_Visible = 1 << 8, // [WIP] Set when item is overlapping the current clipping rectangle (Used internally. Please don't use yet: API/system will change as we refactor Itemadd()). ImGuiItemStatusFlags_HasClipRect = 1 << 9, // g.LastItemData.ClipRect is valid. ImGuiItemStatusFlags_HasShortcut = 1 << 10, // g.LastItemData.Shortcut valid. Set by SetNextItemShortcut() -> ItemAdd(). // Additional status + semantic for ImGuiTestEngine #ifdef IMGUI_ENABLE_TEST_ENGINE ImGuiItemStatusFlags_Openable = 1 << 20, // Item is an openable (e.g. TreeNode) ImGuiItemStatusFlags_Opened = 1 << 21, // Opened status ImGuiItemStatusFlags_Checkable = 1 << 22, // Item is a checkable (e.g. CheckBox, MenuItem) ImGuiItemStatusFlags_Checked = 1 << 23, // Checked status ImGuiItemStatusFlags_Inputable = 1 << 24, // Item is a text-inputable (e.g. InputText, SliderXXX, DragXXX) #endif }; // Extend ImGuiHoveredFlags_ enum ImGuiHoveredFlagsPrivate_ { ImGuiHoveredFlags_DelayMask_ = ImGuiHoveredFlags_DelayNone | ImGuiHoveredFlags_DelayShort | ImGuiHoveredFlags_DelayNormal | ImGuiHoveredFlags_NoSharedDelay, ImGuiHoveredFlags_AllowedMaskForIsWindowHovered = ImGuiHoveredFlags_ChildWindows | ImGuiHoveredFlags_RootWindow | ImGuiHoveredFlags_AnyWindow | ImGuiHoveredFlags_NoPopupHierarchy | ImGuiHoveredFlags_AllowWhenBlockedByPopup | ImGuiHoveredFlags_AllowWhenBlockedByActiveItem | ImGuiHoveredFlags_ForTooltip | ImGuiHoveredFlags_Stationary, ImGuiHoveredFlags_AllowedMaskForIsItemHovered = ImGuiHoveredFlags_AllowWhenBlockedByPopup | ImGuiHoveredFlags_AllowWhenBlockedByActiveItem | ImGuiHoveredFlags_AllowWhenOverlapped | ImGuiHoveredFlags_AllowWhenDisabled | ImGuiHoveredFlags_NoNavOverride | ImGuiHoveredFlags_ForTooltip | ImGuiHoveredFlags_Stationary | ImGuiHoveredFlags_DelayMask_, }; // Extend ImGuiInputTextFlags_ enum ImGuiInputTextFlagsPrivate_ { // [Internal] ImGuiInputTextFlags_Multiline = 1 << 26, // For internal use by InputTextMultiline() ImGuiInputTextFlags_MergedItem = 1 << 27, // For internal use by TempInputText(), will skip calling ItemAdd(). Require bounding-box to strictly match. ImGuiInputTextFlags_LocalizeDecimalPoint= 1 << 28, // For internal use by InputScalar() and TempInputScalar() }; // Extend ImGuiButtonFlags_ enum ImGuiButtonFlagsPrivate_ { ImGuiButtonFlags_PressedOnClick = 1 << 4, // return true on click (mouse down event) ImGuiButtonFlags_PressedOnClickRelease = 1 << 5, // [Default] return true on click + release on same item <-- this is what the majority of Button are using ImGuiButtonFlags_PressedOnClickReleaseAnywhere = 1 << 6, // return true on click + release even if the release event is not done while hovering the item ImGuiButtonFlags_PressedOnRelease = 1 << 7, // return true on release (default requires click+release) ImGuiButtonFlags_PressedOnDoubleClick = 1 << 8, // return true on double-click (default requires click+release) ImGuiButtonFlags_PressedOnDragDropHold = 1 << 9, // return true when held into while we are drag and dropping another item (used by e.g. tree nodes, collapsing headers) //ImGuiButtonFlags_Repeat = 1 << 10, // hold to repeat -> use ImGuiItemFlags_ButtonRepeat instead. ImGuiButtonFlags_FlattenChildren = 1 << 11, // allow interactions even if a child window is overlapping ImGuiButtonFlags_AllowOverlap = 1 << 12, // require previous frame HoveredId to either match id or be null before being usable. //ImGuiButtonFlags_DontClosePopups = 1 << 13, // disable automatically closing parent popup on press //ImGuiButtonFlags_Disabled = 1 << 14, // disable interactions -> use BeginDisabled() or ImGuiItemFlags_Disabled ImGuiButtonFlags_AlignTextBaseLine = 1 << 15, // vertically align button to match text baseline - ButtonEx() only // FIXME: Should be removed and handled by SmallButton(), not possible currently because of DC.CursorPosPrevLine ImGuiButtonFlags_NoKeyModsAllowed = 1 << 16, // disable mouse interaction if a key modifier is held ImGuiButtonFlags_NoHoldingActiveId = 1 << 17, // don't set ActiveId while holding the mouse (ImGuiButtonFlags_PressedOnClick only) ImGuiButtonFlags_NoNavFocus = 1 << 18, // don't override navigation focus when activated (FIXME: this is essentially used every time an item uses ImGuiItemFlags_NoNav, but because legacy specs don't requires LastItemData to be set ButtonBehavior(), we can't poll g.LastItemData.ItemFlags) ImGuiButtonFlags_NoHoveredOnFocus = 1 << 19, // don't report as hovered when nav focus is on this item ImGuiButtonFlags_NoSetKeyOwner = 1 << 20, // don't set key/input owner on the initial click (note: mouse buttons are keys! often, the key in question will be ImGuiKey_MouseLeft!) ImGuiButtonFlags_NoTestKeyOwner = 1 << 21, // don't test key/input owner when polling the key (note: mouse buttons are keys! often, the key in question will be ImGuiKey_MouseLeft!) ImGuiButtonFlags_PressedOnMask_ = ImGuiButtonFlags_PressedOnClick | ImGuiButtonFlags_PressedOnClickRelease | ImGuiButtonFlags_PressedOnClickReleaseAnywhere | ImGuiButtonFlags_PressedOnRelease | ImGuiButtonFlags_PressedOnDoubleClick | ImGuiButtonFlags_PressedOnDragDropHold, ImGuiButtonFlags_PressedOnDefault_ = ImGuiButtonFlags_PressedOnClickRelease, }; // Extend ImGuiComboFlags_ enum ImGuiComboFlagsPrivate_ { ImGuiComboFlags_CustomPreview = 1 << 20, // enable BeginComboPreview() }; // Extend ImGuiSliderFlags_ enum ImGuiSliderFlagsPrivate_ { ImGuiSliderFlags_Vertical = 1 << 20, // Should this slider be orientated vertically? ImGuiSliderFlags_ReadOnly = 1 << 21, // Consider using g.NextItemData.ItemFlags |= ImGuiItemFlags_ReadOnly instead. }; // Extend ImGuiSelectableFlags_ enum ImGuiSelectableFlagsPrivate_ { // NB: need to be in sync with last value of ImGuiSelectableFlags_ ImGuiSelectableFlags_NoHoldingActiveID = 1 << 20, ImGuiSelectableFlags_SelectOnNav = 1 << 21, // (WIP) Auto-select when moved into. This is not exposed in public API as to handle multi-select and modifiers we will need user to explicitly control focus scope. May be replaced with a BeginSelection() API. ImGuiSelectableFlags_SelectOnClick = 1 << 22, // Override button behavior to react on Click (default is Click+Release) ImGuiSelectableFlags_SelectOnRelease = 1 << 23, // Override button behavior to react on Release (default is Click+Release) ImGuiSelectableFlags_SpanAvailWidth = 1 << 24, // Span all avail width even if we declared less for layout purpose. FIXME: We may be able to remove this (added in 6251d379, 2bcafc86 for menus) ImGuiSelectableFlags_SetNavIdOnHover = 1 << 25, // Set Nav/Focus ID on mouse hover (used by MenuItem) ImGuiSelectableFlags_NoPadWithHalfSpacing = 1 << 26, // Disable padding each side with ItemSpacing * 0.5f ImGuiSelectableFlags_NoSetKeyOwner = 1 << 27, // Don't set key/input owner on the initial click (note: mouse buttons are keys! often, the key in question will be ImGuiKey_MouseLeft!) }; // Extend ImGuiTreeNodeFlags_ enum ImGuiTreeNodeFlagsPrivate_ { ImGuiTreeNodeFlags_ClipLabelForTrailingButton = 1 << 28,// FIXME-WIP: Hard-coded for CollapsingHeader() ImGuiTreeNodeFlags_UpsideDownArrow = 1 << 29,// FIXME-WIP: Turn Down arrow into an Up arrow, for reversed trees (#6517) ImGuiTreeNodeFlags_OpenOnMask_ = ImGuiTreeNodeFlags_OpenOnDoubleClick | ImGuiTreeNodeFlags_OpenOnArrow, }; enum ImGuiSeparatorFlags_ { ImGuiSeparatorFlags_None = 0, ImGuiSeparatorFlags_Horizontal = 1 << 0, // Axis default to current layout type, so generally Horizontal unless e.g. in a menu bar ImGuiSeparatorFlags_Vertical = 1 << 1, ImGuiSeparatorFlags_SpanAllColumns = 1 << 2, // Make separator cover all columns of a legacy Columns() set. }; // Flags for FocusWindow(). This is not called ImGuiFocusFlags to avoid confusion with public-facing ImGuiFocusedFlags. // FIXME: Once we finishing replacing more uses of GetTopMostPopupModal()+IsWindowWithinBeginStackOf() // and FindBlockingModal() with this, we may want to change the flag to be opt-out instead of opt-in. enum ImGuiFocusRequestFlags_ { ImGuiFocusRequestFlags_None = 0, ImGuiFocusRequestFlags_RestoreFocusedChild = 1 << 0, // Find last focused child (if any) and focus it instead. ImGuiFocusRequestFlags_UnlessBelowModal = 1 << 1, // Do not set focus if the window is below a modal. }; enum ImGuiTextFlags_ { ImGuiTextFlags_None = 0, ImGuiTextFlags_NoWidthForLargeClippedText = 1 << 0, }; enum ImGuiTooltipFlags_ { ImGuiTooltipFlags_None = 0, ImGuiTooltipFlags_OverridePrevious = 1 << 1, // Clear/ignore previously submitted tooltip (defaults to append) }; // FIXME: this is in development, not exposed/functional as a generic feature yet. // Horizontal/Vertical enums are fixed to 0/1 so they may be used to index ImVec2 enum ImGuiLayoutType_ { ImGuiLayoutType_Horizontal = 0, ImGuiLayoutType_Vertical = 1 }; // Flags for LogBegin() text capturing function enum ImGuiLogFlags_ { ImGuiLogFlags_None = 0, ImGuiLogFlags_OutputTTY = 1 << 0, ImGuiLogFlags_OutputFile = 1 << 1, ImGuiLogFlags_OutputBuffer = 1 << 2, ImGuiLogFlags_OutputClipboard = 1 << 3, ImGuiLogFlags_OutputMask_ = ImGuiLogFlags_OutputTTY | ImGuiLogFlags_OutputFile | ImGuiLogFlags_OutputBuffer | ImGuiLogFlags_OutputClipboard, }; // X/Y enums are fixed to 0/1 so they may be used to index ImVec2 enum ImGuiAxis { ImGuiAxis_None = -1, ImGuiAxis_X = 0, ImGuiAxis_Y = 1 }; enum ImGuiPlotType { ImGuiPlotType_Lines, ImGuiPlotType_Histogram, }; // Storage data for BeginComboPreview()/EndComboPreview() struct IMGUI_API ImGuiComboPreviewData { ImRect PreviewRect; ImVec2 BackupCursorPos; ImVec2 BackupCursorMaxPos; ImVec2 BackupCursorPosPrevLine; float BackupPrevLineTextBaseOffset; ImGuiLayoutType BackupLayout; ImGuiComboPreviewData() { memset(this, 0, sizeof(*this)); } }; // Stacked storage data for BeginGroup()/EndGroup() struct IMGUI_API ImGuiGroupData { ImGuiID WindowID; ImVec2 BackupCursorPos; ImVec2 BackupCursorMaxPos; ImVec2 BackupCursorPosPrevLine; ImVec1 BackupIndent; ImVec1 BackupGroupOffset; ImVec2 BackupCurrLineSize; float BackupCurrLineTextBaseOffset; ImGuiID BackupActiveIdIsAlive; bool BackupDeactivatedIdIsAlive; bool BackupHoveredIdIsAlive; bool BackupIsSameLine; bool EmitItem; }; // Simple column measurement, currently used for MenuItem() only.. This is very short-sighted/throw-away code and NOT a generic helper. struct IMGUI_API ImGuiMenuColumns { ImU32 TotalWidth; ImU32 NextTotalWidth; ImU16 Spacing; ImU16 OffsetIcon; // Always zero for now ImU16 OffsetLabel; // Offsets are locked in Update() ImU16 OffsetShortcut; ImU16 OffsetMark; ImU16 Widths[4]; // Width of: Icon, Label, Shortcut, Mark (accumulators for current frame) ImGuiMenuColumns() { memset(this, 0, sizeof(*this)); } void Update(float spacing, bool window_reappearing); float DeclColumns(float w_icon, float w_label, float w_shortcut, float w_mark); void CalcNextTotalWidth(bool update_offsets); }; // Internal temporary state for deactivating InputText() instances. struct IMGUI_API ImGuiInputTextDeactivatedState { ImGuiID ID; // widget id owning the text state (which just got deactivated) ImVector TextA; // text buffer ImGuiInputTextDeactivatedState() { memset(this, 0, sizeof(*this)); } void ClearFreeMemory() { ID = 0; TextA.clear(); } }; // Forward declare imstb_textedit.h structure + make its main configuration define accessible #undef IMSTB_TEXTEDIT_STRING #undef IMSTB_TEXTEDIT_CHARTYPE #define IMSTB_TEXTEDIT_STRING ImGuiInputTextState #define IMSTB_TEXTEDIT_CHARTYPE char #define IMSTB_TEXTEDIT_GETWIDTH_NEWLINE (-1.0f) #define IMSTB_TEXTEDIT_UNDOSTATECOUNT 99 #define IMSTB_TEXTEDIT_UNDOCHARCOUNT 999 namespace ImStb { struct STB_TexteditState; } typedef ImStb::STB_TexteditState ImStbTexteditState; // Internal state of the currently focused/edited text input box // For a given item ID, access with ImGui::GetInputTextState() struct IMGUI_API ImGuiInputTextState { ImGuiContext* Ctx; // parent UI context (needs to be set explicitly by parent). ImStbTexteditState* Stb; // State for stb_textedit.h ImGuiInputTextFlags Flags; // copy of InputText() flags. may be used to check if e.g. ImGuiInputTextFlags_Password is set. ImGuiID ID; // widget id owning the text state int TextLen; // UTF-8 length of the string in TextA (in bytes) const char* TextSrc; // == TextA.Data unless read-only, in which case == buf passed to InputText(). Field only set and valid _inside_ the call InputText() call. ImVector TextA; // main UTF8 buffer. TextA.Size is a buffer size! Should always be >= buf_size passed by user (and of course >= CurLenA + 1). ImVector TextToRevertTo; // value to revert to when pressing Escape = backup of end-user buffer at the time of focus (in UTF-8, unaltered) ImVector CallbackTextBackup; // temporary storage for callback to support automatic reconcile of undo-stack int BufCapacity; // end-user buffer capacity (include zero terminator) ImVec2 Scroll; // horizontal offset (managed manually) + vertical scrolling (pulled from child window's own Scroll.y) float CursorAnim; // timer for cursor blink, reset on every user action so the cursor reappears immediately bool CursorFollow; // set when we want scrolling to follow the current cursor position (not always!) bool SelectedAllMouseLock; // after a double-click to select all, we ignore further mouse drags to update selection bool Edited; // edited this frame bool WantReloadUserBuf; // force a reload of user buf so it may be modified externally. may be automatic in future version. int ReloadSelectionStart; int ReloadSelectionEnd; ImGuiInputTextState(); ~ImGuiInputTextState(); void ClearText() { TextLen = 0; TextA[0] = 0; CursorClamp(); } void ClearFreeMemory() { TextA.clear(); TextToRevertTo.clear(); } void OnKeyPressed(int key); // Cannot be inline because we call in code in stb_textedit.h implementation void OnCharPressed(unsigned int c); // Cursor & Selection void CursorAnimReset(); void CursorClamp(); bool HasSelection() const; void ClearSelection(); int GetCursorPos() const; int GetSelectionStart() const; int GetSelectionEnd() const; void SelectAll(); // Reload user buf (WIP #2890) // If you modify underlying user-passed const char* while active you need to call this (InputText V2 may lift this) // strcpy(my_buf, "hello"); // if (ImGuiInputTextState* state = ImGui::GetInputTextState(id)) // id may be ImGui::GetItemID() is last item // state->ReloadUserBufAndSelectAll(); void ReloadUserBufAndSelectAll(); void ReloadUserBufAndKeepSelection(); void ReloadUserBufAndMoveToEnd(); }; enum ImGuiWindowRefreshFlags_ { ImGuiWindowRefreshFlags_None = 0, ImGuiWindowRefreshFlags_TryToAvoidRefresh = 1 << 0, // [EXPERIMENTAL] Try to keep existing contents, USER MUST NOT HONOR BEGIN() RETURNING FALSE AND NOT APPEND. ImGuiWindowRefreshFlags_RefreshOnHover = 1 << 1, // [EXPERIMENTAL] Always refresh on hover ImGuiWindowRefreshFlags_RefreshOnFocus = 1 << 2, // [EXPERIMENTAL] Always refresh on focus // Refresh policy/frequency, Load Balancing etc. }; enum ImGuiNextWindowDataFlags_ { ImGuiNextWindowDataFlags_None = 0, ImGuiNextWindowDataFlags_HasPos = 1 << 0, ImGuiNextWindowDataFlags_HasSize = 1 << 1, ImGuiNextWindowDataFlags_HasContentSize = 1 << 2, ImGuiNextWindowDataFlags_HasCollapsed = 1 << 3, ImGuiNextWindowDataFlags_HasSizeConstraint = 1 << 4, ImGuiNextWindowDataFlags_HasFocus = 1 << 5, ImGuiNextWindowDataFlags_HasBgAlpha = 1 << 6, ImGuiNextWindowDataFlags_HasScroll = 1 << 7, ImGuiNextWindowDataFlags_HasWindowFlags = 1 << 8, ImGuiNextWindowDataFlags_HasChildFlags = 1 << 9, ImGuiNextWindowDataFlags_HasRefreshPolicy = 1 << 10, }; // Storage for SetNexWindow** functions struct ImGuiNextWindowData { ImGuiNextWindowDataFlags HasFlags; // Members below are NOT cleared. Always rely on HasFlags. ImGuiCond PosCond; ImGuiCond SizeCond; ImGuiCond CollapsedCond; ImVec2 PosVal; ImVec2 PosPivotVal; ImVec2 SizeVal; ImVec2 ContentSizeVal; ImVec2 ScrollVal; ImGuiWindowFlags WindowFlags; // Only honored by BeginTable() ImGuiChildFlags ChildFlags; bool CollapsedVal; ImRect SizeConstraintRect; ImGuiSizeCallback SizeCallback; void* SizeCallbackUserData; float BgAlphaVal; // Override background alpha ImVec2 MenuBarOffsetMinVal; // (Always on) This is not exposed publicly, so we don't clear it and it doesn't have a corresponding flag (could we? for consistency?) ImGuiWindowRefreshFlags RefreshFlagsVal; ImGuiNextWindowData() { memset(this, 0, sizeof(*this)); } inline void ClearFlags() { HasFlags = ImGuiNextWindowDataFlags_None; } }; enum ImGuiNextItemDataFlags_ { ImGuiNextItemDataFlags_None = 0, ImGuiNextItemDataFlags_HasWidth = 1 << 0, ImGuiNextItemDataFlags_HasOpen = 1 << 1, ImGuiNextItemDataFlags_HasShortcut = 1 << 2, ImGuiNextItemDataFlags_HasRefVal = 1 << 3, ImGuiNextItemDataFlags_HasStorageID = 1 << 4, }; struct ImGuiNextItemData { ImGuiNextItemDataFlags HasFlags; // Called HasFlags instead of Flags to avoid mistaking this ImGuiItemFlags ItemFlags; // Currently only tested/used for ImGuiItemFlags_AllowOverlap and ImGuiItemFlags_HasSelectionUserData. // Members below are NOT cleared by ItemAdd() meaning they are still valid during e.g. NavProcessItem(). Always rely on HasFlags. ImGuiID FocusScopeId; // Set by SetNextItemSelectionUserData() ImGuiSelectionUserData SelectionUserData; // Set by SetNextItemSelectionUserData() (note that NULL/0 is a valid value, we use -1 == ImGuiSelectionUserData_Invalid to mark invalid values) float Width; // Set by SetNextItemWidth() ImGuiKeyChord Shortcut; // Set by SetNextItemShortcut() ImGuiInputFlags ShortcutFlags; // Set by SetNextItemShortcut() bool OpenVal; // Set by SetNextItemOpen() ImU8 OpenCond; // Set by SetNextItemOpen() ImGuiDataTypeStorage RefVal; // Not exposed yet, for ImGuiInputTextFlags_ParseEmptyAsRefVal ImGuiID StorageId; // Set by SetNextItemStorageID() ImGuiNextItemData() { memset(this, 0, sizeof(*this)); SelectionUserData = -1; } inline void ClearFlags() { HasFlags = ImGuiNextItemDataFlags_None; ItemFlags = ImGuiItemFlags_None; } // Also cleared manually by ItemAdd()! }; // Status storage for the last submitted item struct ImGuiLastItemData { ImGuiID ID; ImGuiItemFlags ItemFlags; // See ImGuiItemFlags_ (called 'InFlags' before v1.91.4). ImGuiItemStatusFlags StatusFlags; // See ImGuiItemStatusFlags_ ImRect Rect; // Full rectangle ImRect NavRect; // Navigation scoring rectangle (not displayed) // Rarely used fields are not explicitly cleared, only valid when the corresponding ImGuiItemStatusFlags are set. ImRect DisplayRect; // Display rectangle. ONLY VALID IF (StatusFlags & ImGuiItemStatusFlags_HasDisplayRect) is set. ImRect ClipRect; // Clip rectangle at the time of submitting item. ONLY VALID IF (StatusFlags & ImGuiItemStatusFlags_HasClipRect) is set.. ImGuiKeyChord Shortcut; // Shortcut at the time of submitting item. ONLY VALID IF (StatusFlags & ImGuiItemStatusFlags_HasShortcut) is set.. ImGuiLastItemData() { memset(this, 0, sizeof(*this)); } }; // Store data emitted by TreeNode() for usage by TreePop() // - To implement ImGuiTreeNodeFlags_NavLeftJumpsBackHere: store the minimum amount of data // which we can't infer in TreePop(), to perform the equivalent of NavApplyItemToResult(). // Only stored when the node is a potential candidate for landing on a Left arrow jump. struct ImGuiTreeNodeStackData { ImGuiID ID; ImGuiTreeNodeFlags TreeFlags; ImGuiItemFlags ItemFlags; // Used for nav landing ImRect NavRect; // Used for nav landing }; // sizeof() = 20 struct IMGUI_API ImGuiErrorRecoveryState { short SizeOfWindowStack; short SizeOfIDStack; short SizeOfTreeStack; short SizeOfColorStack; short SizeOfStyleVarStack; short SizeOfFontStack; short SizeOfFocusScopeStack; short SizeOfGroupStack; short SizeOfItemFlagsStack; short SizeOfBeginPopupStack; short SizeOfDisabledStack; ImGuiErrorRecoveryState() { memset(this, 0, sizeof(*this)); } }; // Data saved for each window pushed into the stack struct ImGuiWindowStackData { ImGuiWindow* Window; ImGuiLastItemData ParentLastItemDataBackup; ImGuiErrorRecoveryState StackSizesInBegin; // Store size of various stacks for asserting bool DisabledOverrideReenable; // Non-child window override disabled flag float DisabledOverrideReenableAlphaBackup; }; struct ImGuiShrinkWidthItem { int Index; float Width; float InitialWidth; }; struct ImGuiPtrOrIndex { void* Ptr; // Either field can be set, not both. e.g. Dock node tab bars are loose while BeginTabBar() ones are in a pool. int Index; // Usually index in a main pool. ImGuiPtrOrIndex(void* ptr) { Ptr = ptr; Index = -1; } ImGuiPtrOrIndex(int index) { Ptr = NULL; Index = index; } }; // Data used by IsItemDeactivated()/IsItemDeactivatedAfterEdit() functions struct ImGuiDeactivatedItemData { ImGuiID ID; int ElapseFrame; bool HasBeenEditedBefore; bool IsAlive; }; //----------------------------------------------------------------------------- // [SECTION] Popup support //----------------------------------------------------------------------------- enum ImGuiPopupPositionPolicy { ImGuiPopupPositionPolicy_Default, ImGuiPopupPositionPolicy_ComboBox, ImGuiPopupPositionPolicy_Tooltip, }; // Storage for popup stacks (g.OpenPopupStack and g.BeginPopupStack) struct ImGuiPopupData { ImGuiID PopupId; // Set on OpenPopup() ImGuiWindow* Window; // Resolved on BeginPopup() - may stay unresolved if user never calls OpenPopup() ImGuiWindow* RestoreNavWindow;// Set on OpenPopup(), a NavWindow that will be restored on popup close int ParentNavLayer; // Resolved on BeginPopup(). Actually a ImGuiNavLayer type (declared down below), initialized to -1 which is not part of an enum, but serves well-enough as "not any of layers" value int OpenFrameCount; // Set on OpenPopup() ImGuiID OpenParentId; // Set on OpenPopup(), we need this to differentiate multiple menu sets from each others (e.g. inside menu bar vs loose menu items) ImVec2 OpenPopupPos; // Set on OpenPopup(), preferred popup position (typically == OpenMousePos when using mouse) ImVec2 OpenMousePos; // Set on OpenPopup(), copy of mouse position at the time of opening popup ImGuiPopupData() { memset(this, 0, sizeof(*this)); ParentNavLayer = OpenFrameCount = -1; } }; //----------------------------------------------------------------------------- // [SECTION] Inputs support //----------------------------------------------------------------------------- // Bit array for named keys typedef ImBitArray ImBitArrayForNamedKeys; // [Internal] Key ranges #define ImGuiKey_LegacyNativeKey_BEGIN 0 #define ImGuiKey_LegacyNativeKey_END 512 #define ImGuiKey_Keyboard_BEGIN (ImGuiKey_NamedKey_BEGIN) #define ImGuiKey_Keyboard_END (ImGuiKey_GamepadStart) #define ImGuiKey_Gamepad_BEGIN (ImGuiKey_GamepadStart) #define ImGuiKey_Gamepad_END (ImGuiKey_GamepadRStickDown + 1) #define ImGuiKey_Mouse_BEGIN (ImGuiKey_MouseLeft) #define ImGuiKey_Mouse_END (ImGuiKey_MouseWheelY + 1) #define ImGuiKey_Aliases_BEGIN (ImGuiKey_Mouse_BEGIN) #define ImGuiKey_Aliases_END (ImGuiKey_Mouse_END) // [Internal] Named shortcuts for Navigation #define ImGuiKey_NavKeyboardTweakSlow ImGuiMod_Ctrl #define ImGuiKey_NavKeyboardTweakFast ImGuiMod_Shift #define ImGuiKey_NavGamepadTweakSlow ImGuiKey_GamepadL1 #define ImGuiKey_NavGamepadTweakFast ImGuiKey_GamepadR1 #define ImGuiKey_NavGamepadActivate (g.IO.ConfigNavSwapGamepadButtons ? ImGuiKey_GamepadFaceRight : ImGuiKey_GamepadFaceDown) #define ImGuiKey_NavGamepadCancel (g.IO.ConfigNavSwapGamepadButtons ? ImGuiKey_GamepadFaceDown : ImGuiKey_GamepadFaceRight) #define ImGuiKey_NavGamepadMenu ImGuiKey_GamepadFaceLeft #define ImGuiKey_NavGamepadInput ImGuiKey_GamepadFaceUp enum ImGuiInputEventType { ImGuiInputEventType_None = 0, ImGuiInputEventType_MousePos, ImGuiInputEventType_MouseWheel, ImGuiInputEventType_MouseButton, ImGuiInputEventType_Key, ImGuiInputEventType_Text, ImGuiInputEventType_Focus, ImGuiInputEventType_COUNT }; enum ImGuiInputSource { ImGuiInputSource_None = 0, ImGuiInputSource_Mouse, // Note: may be Mouse or TouchScreen or Pen. See io.MouseSource to distinguish them. ImGuiInputSource_Keyboard, ImGuiInputSource_Gamepad, ImGuiInputSource_COUNT }; // FIXME: Structures in the union below need to be declared as anonymous unions appears to be an extension? // Using ImVec2() would fail on Clang 'union member 'MousePos' has a non-trivial default constructor' struct ImGuiInputEventMousePos { float PosX, PosY; ImGuiMouseSource MouseSource; }; struct ImGuiInputEventMouseWheel { float WheelX, WheelY; ImGuiMouseSource MouseSource; }; struct ImGuiInputEventMouseButton { int Button; bool Down; ImGuiMouseSource MouseSource; }; struct ImGuiInputEventKey { ImGuiKey Key; bool Down; float AnalogValue; }; struct ImGuiInputEventText { unsigned int Char; }; struct ImGuiInputEventAppFocused { bool Focused; }; struct ImGuiInputEvent { ImGuiInputEventType Type; ImGuiInputSource Source; ImU32 EventId; // Unique, sequential increasing integer to identify an event (if you need to correlate them to other data). union { ImGuiInputEventMousePos MousePos; // if Type == ImGuiInputEventType_MousePos ImGuiInputEventMouseWheel MouseWheel; // if Type == ImGuiInputEventType_MouseWheel ImGuiInputEventMouseButton MouseButton; // if Type == ImGuiInputEventType_MouseButton ImGuiInputEventKey Key; // if Type == ImGuiInputEventType_Key ImGuiInputEventText Text; // if Type == ImGuiInputEventType_Text ImGuiInputEventAppFocused AppFocused; // if Type == ImGuiInputEventType_Focus }; bool AddedByTestEngine; ImGuiInputEvent() { memset(this, 0, sizeof(*this)); } }; // Input function taking an 'ImGuiID owner_id' argument defaults to (ImGuiKeyOwner_Any == 0) aka don't test ownership, which matches legacy behavior. #define ImGuiKeyOwner_Any ((ImGuiID)0) // Accept key that have an owner, UNLESS a call to SetKeyOwner() explicitly used ImGuiInputFlags_LockThisFrame or ImGuiInputFlags_LockUntilRelease. #define ImGuiKeyOwner_NoOwner ((ImGuiID)-1) // Require key to have no owner. //#define ImGuiKeyOwner_None ImGuiKeyOwner_NoOwner // We previously called this 'ImGuiKeyOwner_None' but it was inconsistent with our pattern that _None values == 0 and quite dangerous. Also using _NoOwner makes the IsKeyPressed() calls more explicit. typedef ImS16 ImGuiKeyRoutingIndex; // Routing table entry (sizeof() == 16 bytes) struct ImGuiKeyRoutingData { ImGuiKeyRoutingIndex NextEntryIndex; ImU16 Mods; // Technically we'd only need 4-bits but for simplify we store ImGuiMod_ values which need 16-bits. ImU8 RoutingCurrScore; // [DEBUG] For debug display ImU8 RoutingNextScore; // Lower is better (0: perfect score) ImGuiID RoutingCurr; ImGuiID RoutingNext; ImGuiKeyRoutingData() { NextEntryIndex = -1; Mods = 0; RoutingCurrScore = RoutingNextScore = 255; RoutingCurr = RoutingNext = ImGuiKeyOwner_NoOwner; } }; // Routing table: maintain a desired owner for each possible key-chord (key + mods), and setup owner in NewFrame() when mods are matching. // Stored in main context (1 instance) struct ImGuiKeyRoutingTable { ImGuiKeyRoutingIndex Index[ImGuiKey_NamedKey_COUNT]; // Index of first entry in Entries[] ImVector Entries; ImVector EntriesNext; // Double-buffer to avoid reallocation (could use a shared buffer) ImGuiKeyRoutingTable() { Clear(); } void Clear() { for (int n = 0; n < IM_ARRAYSIZE(Index); n++) Index[n] = -1; Entries.clear(); EntriesNext.clear(); } }; // This extends ImGuiKeyData but only for named keys (legacy keys don't support the new features) // Stored in main context (1 per named key). In the future it might be merged into ImGuiKeyData. struct ImGuiKeyOwnerData { ImGuiID OwnerCurr; ImGuiID OwnerNext; bool LockThisFrame; // Reading this key requires explicit owner id (until end of frame). Set by ImGuiInputFlags_LockThisFrame. bool LockUntilRelease; // Reading this key requires explicit owner id (until key is released). Set by ImGuiInputFlags_LockUntilRelease. When this is true LockThisFrame is always true as well. ImGuiKeyOwnerData() { OwnerCurr = OwnerNext = ImGuiKeyOwner_NoOwner; LockThisFrame = LockUntilRelease = false; } }; // Extend ImGuiInputFlags_ // Flags for extended versions of IsKeyPressed(), IsMouseClicked(), Shortcut(), SetKeyOwner(), SetItemKeyOwner() // Don't mistake with ImGuiInputTextFlags! (which is for ImGui::InputText() function) enum ImGuiInputFlagsPrivate_ { // Flags for IsKeyPressed(), IsKeyChordPressed(), IsMouseClicked(), Shortcut() // - Repeat mode: Repeat rate selection ImGuiInputFlags_RepeatRateDefault = 1 << 1, // Repeat rate: Regular (default) ImGuiInputFlags_RepeatRateNavMove = 1 << 2, // Repeat rate: Fast ImGuiInputFlags_RepeatRateNavTweak = 1 << 3, // Repeat rate: Faster // - Repeat mode: Specify when repeating key pressed can be interrupted. // - In theory ImGuiInputFlags_RepeatUntilOtherKeyPress may be a desirable default, but it would break too many behavior so everything is opt-in. ImGuiInputFlags_RepeatUntilRelease = 1 << 4, // Stop repeating when released (default for all functions except Shortcut). This only exists to allow overriding Shortcut() default behavior. ImGuiInputFlags_RepeatUntilKeyModsChange = 1 << 5, // Stop repeating when released OR if keyboard mods are changed (default for Shortcut) ImGuiInputFlags_RepeatUntilKeyModsChangeFromNone = 1 << 6, // Stop repeating when released OR if keyboard mods are leaving the None state. Allows going from Mod+Key to Key by releasing Mod. ImGuiInputFlags_RepeatUntilOtherKeyPress = 1 << 7, // Stop repeating when released OR if any other keyboard key is pressed during the repeat // Flags for SetKeyOwner(), SetItemKeyOwner() // - Locking key away from non-input aware code. Locking is useful to make input-owner-aware code steal keys from non-input-owner-aware code. If all code is input-owner-aware locking would never be necessary. ImGuiInputFlags_LockThisFrame = 1 << 20, // Further accesses to key data will require EXPLICIT owner ID (ImGuiKeyOwner_Any/0 will NOT accepted for polling). Cleared at end of frame. ImGuiInputFlags_LockUntilRelease = 1 << 21, // Further accesses to key data will require EXPLICIT owner ID (ImGuiKeyOwner_Any/0 will NOT accepted for polling). Cleared when the key is released or at end of each frame if key is released. // - Condition for SetItemKeyOwner() ImGuiInputFlags_CondHovered = 1 << 22, // Only set if item is hovered (default to both) ImGuiInputFlags_CondActive = 1 << 23, // Only set if item is active (default to both) ImGuiInputFlags_CondDefault_ = ImGuiInputFlags_CondHovered | ImGuiInputFlags_CondActive, // [Internal] Mask of which function support which flags ImGuiInputFlags_RepeatRateMask_ = ImGuiInputFlags_RepeatRateDefault | ImGuiInputFlags_RepeatRateNavMove | ImGuiInputFlags_RepeatRateNavTweak, ImGuiInputFlags_RepeatUntilMask_ = ImGuiInputFlags_RepeatUntilRelease | ImGuiInputFlags_RepeatUntilKeyModsChange | ImGuiInputFlags_RepeatUntilKeyModsChangeFromNone | ImGuiInputFlags_RepeatUntilOtherKeyPress, ImGuiInputFlags_RepeatMask_ = ImGuiInputFlags_Repeat | ImGuiInputFlags_RepeatRateMask_ | ImGuiInputFlags_RepeatUntilMask_, ImGuiInputFlags_CondMask_ = ImGuiInputFlags_CondHovered | ImGuiInputFlags_CondActive, ImGuiInputFlags_RouteTypeMask_ = ImGuiInputFlags_RouteActive | ImGuiInputFlags_RouteFocused | ImGuiInputFlags_RouteGlobal | ImGuiInputFlags_RouteAlways, ImGuiInputFlags_RouteOptionsMask_ = ImGuiInputFlags_RouteOverFocused | ImGuiInputFlags_RouteOverActive | ImGuiInputFlags_RouteUnlessBgFocused | ImGuiInputFlags_RouteFromRootWindow, ImGuiInputFlags_SupportedByIsKeyPressed = ImGuiInputFlags_RepeatMask_, ImGuiInputFlags_SupportedByIsMouseClicked = ImGuiInputFlags_Repeat, ImGuiInputFlags_SupportedByShortcut = ImGuiInputFlags_RepeatMask_ | ImGuiInputFlags_RouteTypeMask_ | ImGuiInputFlags_RouteOptionsMask_, ImGuiInputFlags_SupportedBySetNextItemShortcut = ImGuiInputFlags_RepeatMask_ | ImGuiInputFlags_RouteTypeMask_ | ImGuiInputFlags_RouteOptionsMask_ | ImGuiInputFlags_Tooltip, ImGuiInputFlags_SupportedBySetKeyOwner = ImGuiInputFlags_LockThisFrame | ImGuiInputFlags_LockUntilRelease, ImGuiInputFlags_SupportedBySetItemKeyOwner = ImGuiInputFlags_SupportedBySetKeyOwner | ImGuiInputFlags_CondMask_, }; //----------------------------------------------------------------------------- // [SECTION] Clipper support //----------------------------------------------------------------------------- // Note that Max is exclusive, so perhaps should be using a Begin/End convention. struct ImGuiListClipperRange { int Min; int Max; bool PosToIndexConvert; // Begin/End are absolute position (will be converted to indices later) ImS8 PosToIndexOffsetMin; // Add to Min after converting to indices ImS8 PosToIndexOffsetMax; // Add to Min after converting to indices static ImGuiListClipperRange FromIndices(int min, int max) { ImGuiListClipperRange r = { min, max, false, 0, 0 }; return r; } static ImGuiListClipperRange FromPositions(float y1, float y2, int off_min, int off_max) { ImGuiListClipperRange r = { (int)y1, (int)y2, true, (ImS8)off_min, (ImS8)off_max }; return r; } }; // Temporary clipper data, buffers shared/reused between instances struct ImGuiListClipperData { ImGuiListClipper* ListClipper; float LossynessOffset; int StepNo; int ItemsFrozen; ImVector Ranges; ImGuiListClipperData() { memset(this, 0, sizeof(*this)); } void Reset(ImGuiListClipper* clipper) { ListClipper = clipper; StepNo = ItemsFrozen = 0; Ranges.resize(0); } }; //----------------------------------------------------------------------------- // [SECTION] Navigation support //----------------------------------------------------------------------------- enum ImGuiActivateFlags_ { ImGuiActivateFlags_None = 0, ImGuiActivateFlags_PreferInput = 1 << 0, // Favor activation that requires keyboard text input (e.g. for Slider/Drag). Default for Enter key. ImGuiActivateFlags_PreferTweak = 1 << 1, // Favor activation for tweaking with arrows or gamepad (e.g. for Slider/Drag). Default for Space key and if keyboard is not used. ImGuiActivateFlags_TryToPreserveState = 1 << 2, // Request widget to preserve state if it can (e.g. InputText will try to preserve cursor/selection) ImGuiActivateFlags_FromTabbing = 1 << 3, // Activation requested by a tabbing request ImGuiActivateFlags_FromShortcut = 1 << 4, // Activation requested by an item shortcut via SetNextItemShortcut() function. }; // Early work-in-progress API for ScrollToItem() enum ImGuiScrollFlags_ { ImGuiScrollFlags_None = 0, ImGuiScrollFlags_KeepVisibleEdgeX = 1 << 0, // If item is not visible: scroll as little as possible on X axis to bring item back into view [default for X axis] ImGuiScrollFlags_KeepVisibleEdgeY = 1 << 1, // If item is not visible: scroll as little as possible on Y axis to bring item back into view [default for Y axis for windows that are already visible] ImGuiScrollFlags_KeepVisibleCenterX = 1 << 2, // If item is not visible: scroll to make the item centered on X axis [rarely used] ImGuiScrollFlags_KeepVisibleCenterY = 1 << 3, // If item is not visible: scroll to make the item centered on Y axis ImGuiScrollFlags_AlwaysCenterX = 1 << 4, // Always center the result item on X axis [rarely used] ImGuiScrollFlags_AlwaysCenterY = 1 << 5, // Always center the result item on Y axis [default for Y axis for appearing window) ImGuiScrollFlags_NoScrollParent = 1 << 6, // Disable forwarding scrolling to parent window if required to keep item/rect visible (only scroll window the function was applied to). ImGuiScrollFlags_MaskX_ = ImGuiScrollFlags_KeepVisibleEdgeX | ImGuiScrollFlags_KeepVisibleCenterX | ImGuiScrollFlags_AlwaysCenterX, ImGuiScrollFlags_MaskY_ = ImGuiScrollFlags_KeepVisibleEdgeY | ImGuiScrollFlags_KeepVisibleCenterY | ImGuiScrollFlags_AlwaysCenterY, }; enum ImGuiNavRenderCursorFlags_ { ImGuiNavRenderCursorFlags_None = 0, ImGuiNavRenderCursorFlags_Compact = 1 << 1, // Compact highlight, no padding/distance from focused item ImGuiNavRenderCursorFlags_AlwaysDraw = 1 << 2, // Draw rectangular highlight if (g.NavId == id) even when g.NavCursorVisible == false, aka even when using the mouse. ImGuiNavRenderCursorFlags_NoRounding = 1 << 3, #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS ImGuiNavHighlightFlags_None = ImGuiNavRenderCursorFlags_None, // Renamed in 1.91.4 ImGuiNavHighlightFlags_Compact = ImGuiNavRenderCursorFlags_Compact, // Renamed in 1.91.4 ImGuiNavHighlightFlags_AlwaysDraw = ImGuiNavRenderCursorFlags_AlwaysDraw, // Renamed in 1.91.4 ImGuiNavHighlightFlags_NoRounding = ImGuiNavRenderCursorFlags_NoRounding, // Renamed in 1.91.4 #endif }; enum ImGuiNavMoveFlags_ { ImGuiNavMoveFlags_None = 0, ImGuiNavMoveFlags_LoopX = 1 << 0, // On failed request, restart from opposite side ImGuiNavMoveFlags_LoopY = 1 << 1, ImGuiNavMoveFlags_WrapX = 1 << 2, // On failed request, request from opposite side one line down (when NavDir==right) or one line up (when NavDir==left) ImGuiNavMoveFlags_WrapY = 1 << 3, // This is not super useful but provided for completeness ImGuiNavMoveFlags_WrapMask_ = ImGuiNavMoveFlags_LoopX | ImGuiNavMoveFlags_LoopY | ImGuiNavMoveFlags_WrapX | ImGuiNavMoveFlags_WrapY, ImGuiNavMoveFlags_AllowCurrentNavId = 1 << 4, // Allow scoring and considering the current NavId as a move target candidate. This is used when the move source is offset (e.g. pressing PageDown actually needs to send a Up move request, if we are pressing PageDown from the bottom-most item we need to stay in place) ImGuiNavMoveFlags_AlsoScoreVisibleSet = 1 << 5, // Store alternate result in NavMoveResultLocalVisible that only comprise elements that are already fully visible (used by PageUp/PageDown) ImGuiNavMoveFlags_ScrollToEdgeY = 1 << 6, // Force scrolling to min/max (used by Home/End) // FIXME-NAV: Aim to remove or reword, probably unnecessary ImGuiNavMoveFlags_Forwarded = 1 << 7, ImGuiNavMoveFlags_DebugNoResult = 1 << 8, // Dummy scoring for debug purpose, don't apply result ImGuiNavMoveFlags_FocusApi = 1 << 9, // Requests from focus API can land/focus/activate items even if they are marked with _NoTabStop (see NavProcessItemForTabbingRequest() for details) ImGuiNavMoveFlags_IsTabbing = 1 << 10, // == Focus + Activate if item is Inputable + DontChangeNavHighlight ImGuiNavMoveFlags_IsPageMove = 1 << 11, // Identify a PageDown/PageUp request. ImGuiNavMoveFlags_Activate = 1 << 12, // Activate/select target item. ImGuiNavMoveFlags_NoSelect = 1 << 13, // Don't trigger selection by not setting g.NavJustMovedTo ImGuiNavMoveFlags_NoSetNavCursorVisible = 1 << 14, // Do not alter the nav cursor visible state ImGuiNavMoveFlags_NoClearActiveId = 1 << 15, // (Experimental) Do not clear active id when applying move result }; enum ImGuiNavLayer { ImGuiNavLayer_Main = 0, // Main scrolling layer ImGuiNavLayer_Menu = 1, // Menu layer (access with Alt) ImGuiNavLayer_COUNT }; // Storage for navigation query/results struct ImGuiNavItemData { ImGuiWindow* Window; // Init,Move // Best candidate window (result->ItemWindow->RootWindowForNav == request->Window) ImGuiID ID; // Init,Move // Best candidate item ID ImGuiID FocusScopeId; // Init,Move // Best candidate focus scope ID ImRect RectRel; // Init,Move // Best candidate bounding box in window relative space ImGuiItemFlags ItemFlags; // ????,Move // Best candidate item flags float DistBox; // Move // Best candidate box distance to current NavId float DistCenter; // Move // Best candidate center distance to current NavId float DistAxial; // Move // Best candidate axial distance to current NavId ImGuiSelectionUserData SelectionUserData;//I+Mov // Best candidate SetNextItemSelectionUserData() value. Valid if (ItemFlags & ImGuiItemFlags_HasSelectionUserData) ImGuiNavItemData() { Clear(); } void Clear() { Window = NULL; ID = FocusScopeId = 0; ItemFlags = 0; SelectionUserData = -1; DistBox = DistCenter = DistAxial = FLT_MAX; } }; // Storage for PushFocusScope(), g.FocusScopeStack[], g.NavFocusRoute[] struct ImGuiFocusScopeData { ImGuiID ID; ImGuiID WindowID; }; //----------------------------------------------------------------------------- // [SECTION] Typing-select support //----------------------------------------------------------------------------- // Flags for GetTypingSelectRequest() enum ImGuiTypingSelectFlags_ { ImGuiTypingSelectFlags_None = 0, ImGuiTypingSelectFlags_AllowBackspace = 1 << 0, // Backspace to delete character inputs. If using: ensure GetTypingSelectRequest() is not called more than once per frame (filter by e.g. focus state) ImGuiTypingSelectFlags_AllowSingleCharMode = 1 << 1, // Allow "single char" search mode which is activated when pressing the same character multiple times. }; // Returned by GetTypingSelectRequest(), designed to eventually be public. struct IMGUI_API ImGuiTypingSelectRequest { ImGuiTypingSelectFlags Flags; // Flags passed to GetTypingSelectRequest() int SearchBufferLen; const char* SearchBuffer; // Search buffer contents (use full string. unless SingleCharMode is set, in which case use SingleCharSize). bool SelectRequest; // Set when buffer was modified this frame, requesting a selection. bool SingleCharMode; // Notify when buffer contains same character repeated, to implement special mode. In this situation it preferred to not display any on-screen search indication. ImS8 SingleCharSize; // Length in bytes of first letter codepoint (1 for ascii, 2-4 for UTF-8). If (SearchBufferLen==RepeatCharSize) only 1 letter has been input. }; // Storage for GetTypingSelectRequest() struct IMGUI_API ImGuiTypingSelectState { ImGuiTypingSelectRequest Request; // User-facing data char SearchBuffer[64]; // Search buffer: no need to make dynamic as this search is very transient. ImGuiID FocusScope; int LastRequestFrame = 0; float LastRequestTime = 0.0f; bool SingleCharModeLock = false; // After a certain single char repeat count we lock into SingleCharMode. Two benefits: 1) buffer never fill, 2) we can provide an immediate SingleChar mode without timer elapsing. ImGuiTypingSelectState() { memset(this, 0, sizeof(*this)); } void Clear() { SearchBuffer[0] = 0; SingleCharModeLock = false; } // We preserve remaining data for easier debugging }; //----------------------------------------------------------------------------- // [SECTION] Columns support //----------------------------------------------------------------------------- // Flags for internal's BeginColumns(). This is an obsolete API. Prefer using BeginTable() nowadays! enum ImGuiOldColumnFlags_ { ImGuiOldColumnFlags_None = 0, ImGuiOldColumnFlags_NoBorder = 1 << 0, // Disable column dividers ImGuiOldColumnFlags_NoResize = 1 << 1, // Disable resizing columns when clicking on the dividers ImGuiOldColumnFlags_NoPreserveWidths = 1 << 2, // Disable column width preservation when adjusting columns ImGuiOldColumnFlags_NoForceWithinWindow = 1 << 3, // Disable forcing columns to fit within window ImGuiOldColumnFlags_GrowParentContentsSize = 1 << 4, // Restore pre-1.51 behavior of extending the parent window contents size but _without affecting the columns width at all_. Will eventually remove. // Obsolete names (will be removed) #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS //ImGuiColumnsFlags_None = ImGuiOldColumnFlags_None, //ImGuiColumnsFlags_NoBorder = ImGuiOldColumnFlags_NoBorder, //ImGuiColumnsFlags_NoResize = ImGuiOldColumnFlags_NoResize, //ImGuiColumnsFlags_NoPreserveWidths = ImGuiOldColumnFlags_NoPreserveWidths, //ImGuiColumnsFlags_NoForceWithinWindow = ImGuiOldColumnFlags_NoForceWithinWindow, //ImGuiColumnsFlags_GrowParentContentsSize = ImGuiOldColumnFlags_GrowParentContentsSize, #endif }; struct ImGuiOldColumnData { float OffsetNorm; // Column start offset, normalized 0.0 (far left) -> 1.0 (far right) float OffsetNormBeforeResize; ImGuiOldColumnFlags Flags; // Not exposed ImRect ClipRect; ImGuiOldColumnData() { memset(this, 0, sizeof(*this)); } }; struct ImGuiOldColumns { ImGuiID ID; ImGuiOldColumnFlags Flags; bool IsFirstFrame; bool IsBeingResized; int Current; int Count; float OffMinX, OffMaxX; // Offsets from HostWorkRect.Min.x float LineMinY, LineMaxY; float HostCursorPosY; // Backup of CursorPos at the time of BeginColumns() float HostCursorMaxPosX; // Backup of CursorMaxPos at the time of BeginColumns() ImRect HostInitialClipRect; // Backup of ClipRect at the time of BeginColumns() ImRect HostBackupClipRect; // Backup of ClipRect during PushColumnsBackground()/PopColumnsBackground() ImRect HostBackupParentWorkRect;//Backup of WorkRect at the time of BeginColumns() ImVector Columns; ImDrawListSplitter Splitter; ImGuiOldColumns() { memset(this, 0, sizeof(*this)); } }; //----------------------------------------------------------------------------- // [SECTION] Box-select support //----------------------------------------------------------------------------- struct ImGuiBoxSelectState { // Active box-selection data (persistent, 1 active at a time) ImGuiID ID; bool IsActive; bool IsStarting; bool IsStartedFromVoid; // Starting click was not from an item. bool IsStartedSetNavIdOnce; bool RequestClear; ImGuiKeyChord KeyMods : 16; // Latched key-mods for box-select logic. ImVec2 StartPosRel; // Start position in window-contents relative space (to support scrolling) ImVec2 EndPosRel; // End position in window-contents relative space ImVec2 ScrollAccum; // Scrolling accumulator (to behave at high-frame spaces) ImGuiWindow* Window; // Temporary/Transient data bool UnclipMode; // (Temp/Transient, here in hot area). Set/cleared by the BeginMultiSelect()/EndMultiSelect() owning active box-select. ImRect UnclipRect; // Rectangle where ItemAdd() clipping may be temporarily disabled. Need support by multi-select supporting widgets. ImRect BoxSelectRectPrev; // Selection rectangle in absolute coordinates (derived every frame from BoxSelectStartPosRel and MousePos) ImRect BoxSelectRectCurr; ImGuiBoxSelectState() { memset(this, 0, sizeof(*this)); } }; //----------------------------------------------------------------------------- // [SECTION] Multi-select support //----------------------------------------------------------------------------- // We always assume that -1 is an invalid value (which works for indices and pointers) #define ImGuiSelectionUserData_Invalid ((ImGuiSelectionUserData)-1) // Temporary storage for multi-select struct IMGUI_API ImGuiMultiSelectTempData { ImGuiMultiSelectIO IO; // MUST BE FIRST FIELD. Requests are set and returned by BeginMultiSelect()/EndMultiSelect() + written to by user during the loop. ImGuiMultiSelectState* Storage; ImGuiID FocusScopeId; // Copied from g.CurrentFocusScopeId (unless another selection scope was pushed manually) ImGuiMultiSelectFlags Flags; ImVec2 ScopeRectMin; ImVec2 BackupCursorMaxPos; ImGuiSelectionUserData LastSubmittedItem; // Copy of last submitted item data, used to merge output ranges. ImGuiID BoxSelectId; ImGuiKeyChord KeyMods; ImS8 LoopRequestSetAll; // -1: no operation, 0: clear all, 1: select all. bool IsEndIO; // Set when switching IO from BeginMultiSelect() to EndMultiSelect() state. bool IsFocused; // Set if currently focusing the selection scope (any item of the selection). May be used if you have custom shortcut associated to selection. bool IsKeyboardSetRange; // Set by BeginMultiSelect() when using Shift+Navigation. Because scrolling may be affected we can't afford a frame of lag with Shift+Navigation. bool NavIdPassedBy; bool RangeSrcPassedBy; // Set by the item that matches RangeSrcItem. bool RangeDstPassedBy; // Set by the item that matches NavJustMovedToId when IsSetRange is set. ImGuiMultiSelectTempData() { Clear(); } void Clear() { size_t io_sz = sizeof(IO); ClearIO(); memset((void*)(&IO + 1), 0, sizeof(*this) - io_sz); } // Zero-clear except IO as we preserve IO.Requests[] buffer allocation. void ClearIO() { IO.Requests.resize(0); IO.RangeSrcItem = IO.NavIdItem = ImGuiSelectionUserData_Invalid; IO.NavIdSelected = IO.RangeSrcReset = false; } }; // Persistent storage for multi-select (as long as selection is alive) struct IMGUI_API ImGuiMultiSelectState { ImGuiWindow* Window; ImGuiID ID; int LastFrameActive; // Last used frame-count, for GC. int LastSelectionSize; // Set by BeginMultiSelect() based on optional info provided by user. May be -1 if unknown. ImS8 RangeSelected; // -1 (don't have) or true/false ImS8 NavIdSelected; // -1 (don't have) or true/false ImGuiSelectionUserData RangeSrcItem; // ImGuiSelectionUserData NavIdItem; // SetNextItemSelectionUserData() value for NavId (if part of submitted items) ImGuiMultiSelectState() { Window = NULL; ID = 0; LastFrameActive = LastSelectionSize = 0; RangeSelected = NavIdSelected = -1; RangeSrcItem = NavIdItem = ImGuiSelectionUserData_Invalid; } }; //----------------------------------------------------------------------------- // [SECTION] Docking support //----------------------------------------------------------------------------- #ifdef IMGUI_HAS_DOCK // #endif // #ifdef IMGUI_HAS_DOCK //----------------------------------------------------------------------------- // [SECTION] Viewport support //----------------------------------------------------------------------------- // ImGuiViewport Private/Internals fields (cardinal sin: we are using inheritance!) // Every instance of ImGuiViewport is in fact a ImGuiViewportP. struct ImGuiViewportP : public ImGuiViewport { int BgFgDrawListsLastFrame[2]; // Last frame number the background (0) and foreground (1) draw lists were used ImDrawList* BgFgDrawLists[2]; // Convenience background (0) and foreground (1) draw lists. We use them to draw software mouser cursor when io.MouseDrawCursor is set and to draw most debug overlays. ImDrawData DrawDataP; ImDrawDataBuilder DrawDataBuilder; // Temporary data while building final ImDrawData // Per-viewport work area // - Insets are >= 0.0f values, distance from viewport corners to work area. // - BeginMainMenuBar() and DockspaceOverViewport() tend to use work area to avoid stepping over existing contents. // - Generally 'safeAreaInsets' in iOS land, 'DisplayCutout' in Android land. ImVec2 WorkInsetMin; // Work Area inset locked for the frame. GetWorkRect() always fits within GetMainRect(). ImVec2 WorkInsetMax; // " ImVec2 BuildWorkInsetMin; // Work Area inset accumulator for current frame, to become next frame's WorkInset ImVec2 BuildWorkInsetMax; // " ImGuiViewportP() { BgFgDrawListsLastFrame[0] = BgFgDrawListsLastFrame[1] = -1; BgFgDrawLists[0] = BgFgDrawLists[1] = NULL; } ~ImGuiViewportP() { if (BgFgDrawLists[0]) IM_DELETE(BgFgDrawLists[0]); if (BgFgDrawLists[1]) IM_DELETE(BgFgDrawLists[1]); } // Calculate work rect pos/size given a set of offset (we have 1 pair of offset for rect locked from last frame data, and 1 pair for currently building rect) ImVec2 CalcWorkRectPos(const ImVec2& inset_min) const { return ImVec2(Pos.x + inset_min.x, Pos.y + inset_min.y); } ImVec2 CalcWorkRectSize(const ImVec2& inset_min, const ImVec2& inset_max) const { return ImVec2(ImMax(0.0f, Size.x - inset_min.x - inset_max.x), ImMax(0.0f, Size.y - inset_min.y - inset_max.y)); } void UpdateWorkRect() { WorkPos = CalcWorkRectPos(WorkInsetMin); WorkSize = CalcWorkRectSize(WorkInsetMin, WorkInsetMax); } // Update public fields // Helpers to retrieve ImRect (we don't need to store BuildWorkRect as every access tend to change it, hence the code asymmetry) ImRect GetMainRect() const { return ImRect(Pos.x, Pos.y, Pos.x + Size.x, Pos.y + Size.y); } ImRect GetWorkRect() const { return ImRect(WorkPos.x, WorkPos.y, WorkPos.x + WorkSize.x, WorkPos.y + WorkSize.y); } ImRect GetBuildWorkRect() const { ImVec2 pos = CalcWorkRectPos(BuildWorkInsetMin); ImVec2 size = CalcWorkRectSize(BuildWorkInsetMin, BuildWorkInsetMax); return ImRect(pos.x, pos.y, pos.x + size.x, pos.y + size.y); } }; //----------------------------------------------------------------------------- // [SECTION] Settings support //----------------------------------------------------------------------------- // Windows data saved in imgui.ini file // Because we never destroy or rename ImGuiWindowSettings, we can store the names in a separate buffer easily. // (this is designed to be stored in a ImChunkStream buffer, with the variable-length Name following our structure) struct ImGuiWindowSettings { ImGuiID ID; ImVec2ih Pos; ImVec2ih Size; bool Collapsed; bool IsChild; bool WantApply; // Set when loaded from .ini data (to enable merging/loading .ini data into an already running context) bool WantDelete; // Set to invalidate/delete the settings entry ImGuiWindowSettings() { memset(this, 0, sizeof(*this)); } char* GetName() { return (char*)(this + 1); } }; struct ImGuiSettingsHandler { const char* TypeName; // Short description stored in .ini file. Disallowed characters: '[' ']' ImGuiID TypeHash; // == ImHashStr(TypeName) void (*ClearAllFn)(ImGuiContext* ctx, ImGuiSettingsHandler* handler); // Clear all settings data void (*ReadInitFn)(ImGuiContext* ctx, ImGuiSettingsHandler* handler); // Read: Called before reading (in registration order) void* (*ReadOpenFn)(ImGuiContext* ctx, ImGuiSettingsHandler* handler, const char* name); // Read: Called when entering into a new ini entry e.g. "[Window][Name]" void (*ReadLineFn)(ImGuiContext* ctx, ImGuiSettingsHandler* handler, void* entry, const char* line); // Read: Called for every line of text within an ini entry void (*ApplyAllFn)(ImGuiContext* ctx, ImGuiSettingsHandler* handler); // Read: Called after reading (in registration order) void (*WriteAllFn)(ImGuiContext* ctx, ImGuiSettingsHandler* handler, ImGuiTextBuffer* out_buf); // Write: Output every entries into 'out_buf' void* UserData; ImGuiSettingsHandler() { memset(this, 0, sizeof(*this)); } }; //----------------------------------------------------------------------------- // [SECTION] Localization support //----------------------------------------------------------------------------- // This is experimental and not officially supported, it'll probably fall short of features, if/when it does we may backtrack. enum ImGuiLocKey : int { ImGuiLocKey_VersionStr, ImGuiLocKey_TableSizeOne, ImGuiLocKey_TableSizeAllFit, ImGuiLocKey_TableSizeAllDefault, ImGuiLocKey_TableResetOrder, ImGuiLocKey_WindowingMainMenuBar, ImGuiLocKey_WindowingPopup, ImGuiLocKey_WindowingUntitled, ImGuiLocKey_OpenLink_s, ImGuiLocKey_CopyLink, ImGuiLocKey_COUNT }; struct ImGuiLocEntry { ImGuiLocKey Key; const char* Text; }; //----------------------------------------------------------------------------- // [SECTION] Error handling, State recovery support //----------------------------------------------------------------------------- // Macros used by Recoverable Error handling // - Only dispatch error if _EXPR: evaluate as assert (similar to an assert macro). // - The message will always be a string literal, in order to increase likelihood of being display by an assert handler. // - See 'Demo->Configuration->Error Handling' and ImGuiIO definitions for details on error handling. // - Read https://github.com/ocornut/imgui/wiki/Error-Handling for details on error handling. #ifndef IM_ASSERT_USER_ERROR #define IM_ASSERT_USER_ERROR(_EXPR,_MSG) do { if (!(_EXPR) && ImGui::ErrorLog(_MSG)) { IM_ASSERT((_EXPR) && _MSG); } } while (0) // Recoverable User Error #endif // The error callback is currently not public, as it is expected that only advanced users will rely on it. typedef void (*ImGuiErrorCallback)(ImGuiContext* ctx, void* user_data, const char* msg); // Function signature for g.ErrorCallback //----------------------------------------------------------------------------- // [SECTION] Metrics, Debug Tools //----------------------------------------------------------------------------- // See IMGUI_DEBUG_LOG() and IMGUI_DEBUG_LOG_XXX() macros. enum ImGuiDebugLogFlags_ { // Event types ImGuiDebugLogFlags_None = 0, ImGuiDebugLogFlags_EventError = 1 << 0, // Error submitted by IM_ASSERT_USER_ERROR() ImGuiDebugLogFlags_EventActiveId = 1 << 1, ImGuiDebugLogFlags_EventFocus = 1 << 2, ImGuiDebugLogFlags_EventPopup = 1 << 3, ImGuiDebugLogFlags_EventNav = 1 << 4, ImGuiDebugLogFlags_EventClipper = 1 << 5, ImGuiDebugLogFlags_EventSelection = 1 << 6, ImGuiDebugLogFlags_EventIO = 1 << 7, ImGuiDebugLogFlags_EventFont = 1 << 8, ImGuiDebugLogFlags_EventInputRouting = 1 << 9, ImGuiDebugLogFlags_EventDocking = 1 << 10, // Unused in this branch ImGuiDebugLogFlags_EventViewport = 1 << 11, // Unused in this branch ImGuiDebugLogFlags_EventMask_ = ImGuiDebugLogFlags_EventError | ImGuiDebugLogFlags_EventActiveId | ImGuiDebugLogFlags_EventFocus | ImGuiDebugLogFlags_EventPopup | ImGuiDebugLogFlags_EventNav | ImGuiDebugLogFlags_EventClipper | ImGuiDebugLogFlags_EventSelection | ImGuiDebugLogFlags_EventIO | ImGuiDebugLogFlags_EventFont | ImGuiDebugLogFlags_EventInputRouting | ImGuiDebugLogFlags_EventDocking | ImGuiDebugLogFlags_EventViewport, ImGuiDebugLogFlags_OutputToTTY = 1 << 20, // Also send output to TTY ImGuiDebugLogFlags_OutputToTestEngine = 1 << 21, // Also send output to Test Engine }; struct ImGuiDebugAllocEntry { int FrameCount; ImS16 AllocCount; ImS16 FreeCount; }; struct ImGuiDebugAllocInfo { int TotalAllocCount; // Number of call to MemAlloc(). int TotalFreeCount; ImS16 LastEntriesIdx; // Current index in buffer ImGuiDebugAllocEntry LastEntriesBuf[6]; // Track last 6 frames that had allocations ImGuiDebugAllocInfo() { memset(this, 0, sizeof(*this)); } }; struct ImGuiMetricsConfig { bool ShowDebugLog = false; bool ShowIDStackTool = false; bool ShowWindowsRects = false; bool ShowWindowsBeginOrder = false; bool ShowTablesRects = false; bool ShowDrawCmdMesh = true; bool ShowDrawCmdBoundingBoxes = true; bool ShowTextEncodingViewer = false; int ShowWindowsRectsType = -1; int ShowTablesRectsType = -1; int HighlightMonitorIdx = -1; ImGuiID HighlightViewportID = 0; }; struct ImGuiStackLevelInfo { ImGuiID ID; ImS8 QueryFrameCount; // >= 1: Query in progress bool QuerySuccess; // Obtained result from DebugHookIdInfo() ImGuiDataType DataType : 8; char Desc[57]; // Arbitrarily sized buffer to hold a result (FIXME: could replace Results[] with a chunk stream?) FIXME: Now that we added CTRL+C this should be fixed. ImGuiStackLevelInfo() { memset(this, 0, sizeof(*this)); } }; // State for ID Stack tool queries struct ImGuiIDStackTool { int LastActiveFrame; int StackLevel; // -1: query stack and resize Results, >= 0: individual stack level ImGuiID QueryId; // ID to query details for ImVector Results; bool CopyToClipboardOnCtrlC; float CopyToClipboardLastTime; ImGuiTextBuffer ResultPathBuf; ImGuiIDStackTool() { memset(this, 0, sizeof(*this)); CopyToClipboardLastTime = -FLT_MAX; } }; //----------------------------------------------------------------------------- // [SECTION] Generic context hooks //----------------------------------------------------------------------------- typedef void (*ImGuiContextHookCallback)(ImGuiContext* ctx, ImGuiContextHook* hook); enum ImGuiContextHookType { ImGuiContextHookType_NewFramePre, ImGuiContextHookType_NewFramePost, ImGuiContextHookType_EndFramePre, ImGuiContextHookType_EndFramePost, ImGuiContextHookType_RenderPre, ImGuiContextHookType_RenderPost, ImGuiContextHookType_Shutdown, ImGuiContextHookType_PendingRemoval_ }; struct ImGuiContextHook { ImGuiID HookId; // A unique ID assigned by AddContextHook() ImGuiContextHookType Type; ImGuiID Owner; ImGuiContextHookCallback Callback; void* UserData; ImGuiContextHook() { memset(this, 0, sizeof(*this)); } }; //----------------------------------------------------------------------------- // [SECTION] ImGuiContext (main Dear ImGui context) //----------------------------------------------------------------------------- struct ImGuiContext { bool Initialized; bool FontAtlasOwnedByContext; // IO.Fonts-> is owned by the ImGuiContext and will be destructed along with it. ImGuiIO IO; ImGuiPlatformIO PlatformIO; ImGuiStyle Style; ImFont* Font; // (Shortcut) == FontStack.empty() ? IO.Font : FontStack.back() float FontSize; // (Shortcut) == FontBaseSize * g.CurrentWindow->FontWindowScale == window->FontSize(). Text height for current window. float FontBaseSize; // (Shortcut) == IO.FontGlobalScale * Font->Scale * Font->FontSize. Base text height. float FontScale; // == FontSize / Font->FontSize float CurrentDpiScale; // Current window/viewport DpiScale ImDrawListSharedData DrawListSharedData; double Time; int FrameCount; int FrameCountEnded; int FrameCountRendered; ImGuiID WithinEndChildID; // Set within EndChild() bool WithinFrameScope; // Set by NewFrame(), cleared by EndFrame() bool WithinFrameScopeWithImplicitWindow; // Set by NewFrame(), cleared by EndFrame() when the implicit debug window has been pushed bool GcCompactAll; // Request full GC bool TestEngineHookItems; // Will call test engine hooks: ImGuiTestEngineHook_ItemAdd(), ImGuiTestEngineHook_ItemInfo(), ImGuiTestEngineHook_Log() void* TestEngine; // Test engine user data char ContextName[16]; // Storage for a context name (to facilitate debugging multi-context setups) // Inputs ImVector InputEventsQueue; // Input events which will be trickled/written into IO structure. ImVector InputEventsTrail; // Past input events processed in NewFrame(). This is to allow domain-specific application to access e.g mouse/pen trail. ImGuiMouseSource InputEventsNextMouseSource; ImU32 InputEventsNextEventId; // Windows state ImVector Windows; // Windows, sorted in display order, back to front ImVector WindowsFocusOrder; // Root windows, sorted in focus order, back to front. ImVector WindowsTempSortBuffer; // Temporary buffer used in EndFrame() to reorder windows so parents are kept before their child ImVector CurrentWindowStack; ImGuiStorage WindowsById; // Map window's ImGuiID to ImGuiWindow* int WindowsActiveCount; // Number of unique windows submitted by frame float WindowsBorderHoverPadding; // Padding around resizable windows for which hovering on counts as hovering the window == ImMax(style.TouchExtraPadding, style.WindowBorderHoverPadding). This isn't so multi-dpi friendly. ImGuiID DebugBreakInWindow; // Set to break in Begin() call. ImGuiWindow* CurrentWindow; // Window being drawn into ImGuiWindow* HoveredWindow; // Window the mouse is hovering. Will typically catch mouse inputs. ImGuiWindow* HoveredWindowUnderMovingWindow; // Hovered window ignoring MovingWindow. Only set if MovingWindow is set. ImGuiWindow* HoveredWindowBeforeClear; // Window the mouse is hovering. Filled even with _NoMouse. This is currently useful for multi-context compositors. ImGuiWindow* MovingWindow; // Track the window we clicked on (in order to preserve focus). The actual window that is moved is generally MovingWindow->RootWindow. ImGuiWindow* WheelingWindow; // Track the window we started mouse-wheeling on. Until a timer elapse or mouse has moved, generally keep scrolling the same window even if during the course of scrolling the mouse ends up hovering a child window. ImVec2 WheelingWindowRefMousePos; int WheelingWindowStartFrame; // This may be set one frame before WheelingWindow is != NULL int WheelingWindowScrolledFrame; float WheelingWindowReleaseTimer; ImVec2 WheelingWindowWheelRemainder; ImVec2 WheelingAxisAvg; // Item/widgets state and tracking information ImGuiID DebugDrawIdConflicts; // Set when we detect multiple items with the same identifier ImGuiID DebugHookIdInfo; // Will call core hooks: DebugHookIdInfo() from GetID functions, used by ID Stack Tool [next HoveredId/ActiveId to not pull in an extra cache-line] ImGuiID HoveredId; // Hovered widget, filled during the frame ImGuiID HoveredIdPreviousFrame; int HoveredIdPreviousFrameItemCount; // Count numbers of items using the same ID as last frame's hovered id float HoveredIdTimer; // Measure contiguous hovering time float HoveredIdNotActiveTimer; // Measure contiguous hovering time where the item has not been active bool HoveredIdAllowOverlap; bool HoveredIdIsDisabled; // At least one widget passed the rect test, but has been discarded by disabled flag or popup inhibit. May be true even if HoveredId == 0. bool ItemUnclipByLog; // Disable ItemAdd() clipping, essentially a memory-locality friendly copy of LogEnabled ImGuiID ActiveId; // Active widget ImGuiID ActiveIdIsAlive; // Active widget has been seen this frame (we can't use a bool as the ActiveId may change within the frame) float ActiveIdTimer; bool ActiveIdIsJustActivated; // Set at the time of activation for one frame bool ActiveIdAllowOverlap; // Active widget allows another widget to steal active id (generally for overlapping widgets, but not always) bool ActiveIdNoClearOnFocusLoss; // Disable losing active id if the active id window gets unfocused. bool ActiveIdHasBeenPressedBefore; // Track whether the active id led to a press (this is to allow changing between PressOnClick and PressOnRelease without pressing twice). Used by range_select branch. bool ActiveIdHasBeenEditedBefore; // Was the value associated to the widget Edited over the course of the Active state. bool ActiveIdHasBeenEditedThisFrame; bool ActiveIdFromShortcut; int ActiveIdMouseButton : 8; ImVec2 ActiveIdClickOffset; // Clicked offset from upper-left corner, if applicable (currently only set by ButtonBehavior) ImGuiWindow* ActiveIdWindow; ImGuiInputSource ActiveIdSource; // Activating source: ImGuiInputSource_Mouse OR ImGuiInputSource_Keyboard OR ImGuiInputSource_Gamepad ImGuiID ActiveIdPreviousFrame; ImGuiDeactivatedItemData DeactivatedItemData; ImGuiDataTypeStorage ActiveIdValueOnActivation; // Backup of initial value at the time of activation. ONLY SET BY SPECIFIC WIDGETS: DragXXX and SliderXXX. ImGuiID LastActiveId; // Store the last non-zero ActiveId, useful for animation. float LastActiveIdTimer; // Store the last non-zero ActiveId timer since the beginning of activation, useful for animation. // Key/Input Ownership + Shortcut Routing system // - The idea is that instead of "eating" a given key, we can link to an owner. // - Input query can then read input by specifying ImGuiKeyOwner_Any (== 0), ImGuiKeyOwner_NoOwner (== -1) or a custom ID. // - Routing is requested ahead of time for a given chord (Key + Mods) and granted in NewFrame(). double LastKeyModsChangeTime; // Record the last time key mods changed (affect repeat delay when using shortcut logic) double LastKeyModsChangeFromNoneTime; // Record the last time key mods changed away from being 0 (affect repeat delay when using shortcut logic) double LastKeyboardKeyPressTime; // Record the last time a keyboard key (ignore mouse/gamepad ones) was pressed. ImBitArrayForNamedKeys KeysMayBeCharInput; // Lookup to tell if a key can emit char input, see IsKeyChordPotentiallyCharInput(). sizeof() = 20 bytes ImGuiKeyOwnerData KeysOwnerData[ImGuiKey_NamedKey_COUNT]; ImGuiKeyRoutingTable KeysRoutingTable; ImU32 ActiveIdUsingNavDirMask; // Active widget will want to read those nav move requests (e.g. can activate a button and move away from it) bool ActiveIdUsingAllKeyboardKeys; // Active widget will want to read all keyboard keys inputs. (this is a shortcut for not taking ownership of 100+ keys, frequently used by drag operations) ImGuiKeyChord DebugBreakInShortcutRouting; // Set to break in SetShortcutRouting()/Shortcut() calls. //ImU32 ActiveIdUsingNavInputMask; // [OBSOLETE] Since (IMGUI_VERSION_NUM >= 18804) : 'g.ActiveIdUsingNavInputMask |= (1 << ImGuiNavInput_Cancel);' becomes --> 'SetKeyOwner(ImGuiKey_Escape, g.ActiveId) and/or SetKeyOwner(ImGuiKey_NavGamepadCancel, g.ActiveId);' // Next window/item data ImGuiID CurrentFocusScopeId; // Value for currently appending items == g.FocusScopeStack.back(). Not to be mistaken with g.NavFocusScopeId. ImGuiItemFlags CurrentItemFlags; // Value for currently appending items == g.ItemFlagsStack.back() ImGuiID DebugLocateId; // Storage for DebugLocateItemOnHover() feature: this is read by ItemAdd() so we keep it in a hot/cached location ImGuiNextItemData NextItemData; // Storage for SetNextItem** functions ImGuiLastItemData LastItemData; // Storage for last submitted item (setup by ItemAdd) ImGuiNextWindowData NextWindowData; // Storage for SetNextWindow** functions bool DebugShowGroupRects; // Shared stacks ImGuiCol DebugFlashStyleColorIdx; // (Keep close to ColorStack to share cache line) ImVector ColorStack; // Stack for PushStyleColor()/PopStyleColor() - inherited by Begin() ImVector StyleVarStack; // Stack for PushStyleVar()/PopStyleVar() - inherited by Begin() ImVector FontStack; // Stack for PushFont()/PopFont() - inherited by Begin() ImVector FocusScopeStack; // Stack for PushFocusScope()/PopFocusScope() - inherited by BeginChild(), pushed into by Begin() ImVector ItemFlagsStack; // Stack for PushItemFlag()/PopItemFlag() - inherited by Begin() ImVector GroupStack; // Stack for BeginGroup()/EndGroup() - not inherited by Begin() ImVector OpenPopupStack; // Which popups are open (persistent) ImVector BeginPopupStack; // Which level of BeginPopup() we are in (reset every frame) ImVectorTreeNodeStack; // Stack for TreeNode() // Viewports ImVector Viewports; // Active viewports (Size==1 in 'master' branch). Each viewports hold their copy of ImDrawData. // Keyboard/Gamepad Navigation bool NavCursorVisible; // Nav focus cursor/rectangle is visible? We hide it after a mouse click. We show it after a nav move. bool NavHighlightItemUnderNav; // Disable mouse hovering highlight. Highlight navigation focused item instead of mouse hovered item. //bool NavDisableHighlight; // Old name for !g.NavCursorVisible before 1.91.4 (2024/10/18). OPPOSITE VALUE (g.NavDisableHighlight == !g.NavCursorVisible) //bool NavDisableMouseHover; // Old name for g.NavHighlightItemUnderNav before 1.91.1 (2024/10/18) this was called When user starts using keyboard/gamepad, we hide mouse hovering highlight until mouse is touched again. bool NavMousePosDirty; // When set we will update mouse position if io.ConfigNavMoveSetMousePos is set (not enabled by default) bool NavIdIsAlive; // Nav widget has been seen this frame ~~ NavRectRel is valid ImGuiID NavId; // Focused item for navigation ImGuiWindow* NavWindow; // Focused window for navigation. Could be called 'FocusedWindow' ImGuiID NavFocusScopeId; // Focused focus scope (e.g. selection code often wants to "clear other items" when landing on an item of the same scope) ImGuiNavLayer NavLayer; // Focused layer (main scrolling layer, or menu/title bar layer) ImGuiID NavActivateId; // ~~ (g.ActiveId == 0) && (IsKeyPressed(ImGuiKey_Space) || IsKeyDown(ImGuiKey_Enter) || IsKeyPressed(ImGuiKey_NavGamepadActivate)) ? NavId : 0, also set when calling ActivateItem() ImGuiID NavActivateDownId; // ~~ IsKeyDown(ImGuiKey_Space) || IsKeyDown(ImGuiKey_Enter) || IsKeyDown(ImGuiKey_NavGamepadActivate) ? NavId : 0 ImGuiID NavActivatePressedId; // ~~ IsKeyPressed(ImGuiKey_Space) || IsKeyPressed(ImGuiKey_Enter) || IsKeyPressed(ImGuiKey_NavGamepadActivate) ? NavId : 0 (no repeat) ImGuiActivateFlags NavActivateFlags; ImVector NavFocusRoute; // Reversed copy focus scope stack for NavId (should contains NavFocusScopeId). This essentially follow the window->ParentWindowForFocusRoute chain. ImGuiID NavHighlightActivatedId; float NavHighlightActivatedTimer; ImGuiID NavNextActivateId; // Set by ActivateItem(), queued until next frame. ImGuiActivateFlags NavNextActivateFlags; ImGuiInputSource NavInputSource; // Keyboard or Gamepad mode? THIS CAN ONLY BE ImGuiInputSource_Keyboard or ImGuiInputSource_Mouse ImGuiSelectionUserData NavLastValidSelectionUserData; // Last valid data passed to SetNextItemSelectionUser(), or -1. For current window. Not reset when focusing an item that doesn't have selection data. ImS8 NavCursorHideFrames; // Navigation: Init & Move Requests bool NavAnyRequest; // ~~ NavMoveRequest || NavInitRequest this is to perform early out in ItemAdd() bool NavInitRequest; // Init request for appearing window to select first item bool NavInitRequestFromMove; ImGuiNavItemData NavInitResult; // Init request result (first item of the window, or one for which SetItemDefaultFocus() was called) bool NavMoveSubmitted; // Move request submitted, will process result on next NewFrame() bool NavMoveScoringItems; // Move request submitted, still scoring incoming items bool NavMoveForwardToNextFrame; ImGuiNavMoveFlags NavMoveFlags; ImGuiScrollFlags NavMoveScrollFlags; ImGuiKeyChord NavMoveKeyMods; ImGuiDir NavMoveDir; // Direction of the move request (left/right/up/down) ImGuiDir NavMoveDirForDebug; ImGuiDir NavMoveClipDir; // FIXME-NAV: Describe the purpose of this better. Might want to rename? ImRect NavScoringRect; // Rectangle used for scoring, in screen space. Based of window->NavRectRel[], modified for directional navigation scoring. ImRect NavScoringNoClipRect; // Some nav operations (such as PageUp/PageDown) enforce a region which clipper will attempt to always keep submitted int NavScoringDebugCount; // Metrics for debugging int NavTabbingDir; // Generally -1 or +1, 0 when tabbing without a nav id int NavTabbingCounter; // >0 when counting items for tabbing ImGuiNavItemData NavMoveResultLocal; // Best move request candidate within NavWindow ImGuiNavItemData NavMoveResultLocalVisible; // Best move request candidate within NavWindow that are mostly visible (when using ImGuiNavMoveFlags_AlsoScoreVisibleSet flag) ImGuiNavItemData NavMoveResultOther; // Best move request candidate within NavWindow's flattened hierarchy (when using ImGuiWindowFlags_NavFlattened flag) ImGuiNavItemData NavTabbingResultFirst; // First tabbing request candidate within NavWindow and flattened hierarchy // Navigation: record of last move request ImGuiID NavJustMovedFromFocusScopeId; // Just navigated from this focus scope id (result of a successfully MoveRequest). ImGuiID NavJustMovedToId; // Just navigated to this id (result of a successfully MoveRequest). ImGuiID NavJustMovedToFocusScopeId; // Just navigated to this focus scope id (result of a successfully MoveRequest). ImGuiKeyChord NavJustMovedToKeyMods; bool NavJustMovedToIsTabbing; // Copy of ImGuiNavMoveFlags_IsTabbing. Maybe we should store whole flags. bool NavJustMovedToHasSelectionData; // Copy of move result's ItemFlags & ImGuiItemFlags_HasSelectionUserData). Maybe we should just store ImGuiNavItemData. // Navigation: Windowing (CTRL+TAB for list, or Menu button + keys or directional pads to move/resize) ImGuiKeyChord ConfigNavWindowingKeyNext; // = ImGuiMod_Ctrl | ImGuiKey_Tab (or ImGuiMod_Super | ImGuiKey_Tab on OS X). For reconfiguration (see #4828) ImGuiKeyChord ConfigNavWindowingKeyPrev; // = ImGuiMod_Ctrl | ImGuiMod_Shift | ImGuiKey_Tab (or ImGuiMod_Super | ImGuiMod_Shift | ImGuiKey_Tab on OS X) ImGuiWindow* NavWindowingTarget; // Target window when doing CTRL+Tab (or Pad Menu + FocusPrev/Next), this window is temporarily displayed top-most! ImGuiWindow* NavWindowingTargetAnim; // Record of last valid NavWindowingTarget until DimBgRatio and NavWindowingHighlightAlpha becomes 0.0f, so the fade-out can stay on it. ImGuiWindow* NavWindowingListWindow; // Internal window actually listing the CTRL+Tab contents float NavWindowingTimer; float NavWindowingHighlightAlpha; bool NavWindowingToggleLayer; ImGuiKey NavWindowingToggleKey; ImVec2 NavWindowingAccumDeltaPos; ImVec2 NavWindowingAccumDeltaSize; // Render float DimBgRatio; // 0.0..1.0 animation when fading in a dimming background (for modal window and CTRL+TAB list) // Drag and Drop bool DragDropActive; bool DragDropWithinSource; // Set when within a BeginDragDropXXX/EndDragDropXXX block for a drag source. bool DragDropWithinTarget; // Set when within a BeginDragDropXXX/EndDragDropXXX block for a drag target. ImGuiDragDropFlags DragDropSourceFlags; int DragDropSourceFrameCount; int DragDropMouseButton; ImGuiPayload DragDropPayload; ImRect DragDropTargetRect; // Store rectangle of current target candidate (we favor small targets when overlapping) ImRect DragDropTargetClipRect; // Store ClipRect at the time of item's drawing ImGuiID DragDropTargetId; ImGuiDragDropFlags DragDropAcceptFlags; float DragDropAcceptIdCurrRectSurface; // Target item surface (we resolve overlapping targets by prioritizing the smaller surface) ImGuiID DragDropAcceptIdCurr; // Target item id (set at the time of accepting the payload) ImGuiID DragDropAcceptIdPrev; // Target item id from previous frame (we need to store this to allow for overlapping drag and drop targets) int DragDropAcceptFrameCount; // Last time a target expressed a desire to accept the source ImGuiID DragDropHoldJustPressedId; // Set when holding a payload just made ButtonBehavior() return a press. ImVector DragDropPayloadBufHeap; // We don't expose the ImVector<> directly, ImGuiPayload only holds pointer+size unsigned char DragDropPayloadBufLocal[16]; // Local buffer for small payloads // Clipper int ClipperTempDataStacked; ImVector ClipperTempData; // Tables ImGuiTable* CurrentTable; ImGuiID DebugBreakInTable; // Set to break in BeginTable() call. int TablesTempDataStacked; // Temporary table data size (because we leave previous instances undestructed, we generally don't use TablesTempData.Size) ImVector TablesTempData; // Temporary table data (buffers reused/shared across instances, support nesting) ImPool Tables; // Persistent table data ImVector TablesLastTimeActive; // Last used timestamp of each tables (SOA, for efficient GC) ImVector DrawChannelsTempMergeBuffer; // Tab bars ImGuiTabBar* CurrentTabBar; ImPool TabBars; ImVector CurrentTabBarStack; ImVector ShrinkWidthBuffer; // Multi-Select state ImGuiBoxSelectState BoxSelectState; ImGuiMultiSelectTempData* CurrentMultiSelect; int MultiSelectTempDataStacked; // Temporary multi-select data size (because we leave previous instances undestructed, we generally don't use MultiSelectTempData.Size) ImVector MultiSelectTempData; ImPool MultiSelectStorage; // Hover Delay system ImGuiID HoverItemDelayId; ImGuiID HoverItemDelayIdPreviousFrame; float HoverItemDelayTimer; // Currently used by IsItemHovered() float HoverItemDelayClearTimer; // Currently used by IsItemHovered(): grace time before g.TooltipHoverTimer gets cleared. ImGuiID HoverItemUnlockedStationaryId; // Mouse has once been stationary on this item. Only reset after departing the item. ImGuiID HoverWindowUnlockedStationaryId; // Mouse has once been stationary on this window. Only reset after departing the window. // Mouse state ImGuiMouseCursor MouseCursor; float MouseStationaryTimer; // Time the mouse has been stationary (with some loose heuristic) ImVec2 MouseLastValidPos; // Widget state ImGuiInputTextState InputTextState; ImGuiInputTextDeactivatedState InputTextDeactivatedState; ImFont InputTextPasswordFont; ImGuiID TempInputId; // Temporary text input when CTRL+clicking on a slider, etc. ImGuiDataTypeStorage DataTypeZeroValue; // 0 for all data types int BeginMenuDepth; int BeginComboDepth; ImGuiColorEditFlags ColorEditOptions; // Store user options for color edit widgets ImGuiID ColorEditCurrentID; // Set temporarily while inside of the parent-most ColorEdit4/ColorPicker4 (because they call each others). ImGuiID ColorEditSavedID; // ID we are saving/restoring HS for float ColorEditSavedHue; // Backup of last Hue associated to LastColor, so we can restore Hue in lossy RGB<>HSV round trips float ColorEditSavedSat; // Backup of last Saturation associated to LastColor, so we can restore Saturation in lossy RGB<>HSV round trips ImU32 ColorEditSavedColor; // RGB value with alpha set to 0. ImVec4 ColorPickerRef; // Initial/reference color at the time of opening the color picker. ImGuiComboPreviewData ComboPreviewData; ImRect WindowResizeBorderExpectedRect; // Expected border rect, switch to relative edit if moving bool WindowResizeRelativeMode; short ScrollbarSeekMode; // 0: scroll to clicked location, -1/+1: prev/next page. float ScrollbarClickDeltaToGrabCenter; // When scrolling to mouse location: distance between mouse and center of grab box, normalized in parent space. float SliderGrabClickOffset; float SliderCurrentAccum; // Accumulated slider delta when using navigation controls. bool SliderCurrentAccumDirty; // Has the accumulated slider delta changed since last time we tried to apply it? bool DragCurrentAccumDirty; float DragCurrentAccum; // Accumulator for dragging modification. Always high-precision, not rounded by end-user precision settings float DragSpeedDefaultRatio; // If speed == 0.0f, uses (max-min) * DragSpeedDefaultRatio float DisabledAlphaBackup; // Backup for style.Alpha for BeginDisabled() short DisabledStackSize; short TooltipOverrideCount; ImGuiWindow* TooltipPreviousWindow; // Window of last tooltip submitted during the frame ImVector ClipboardHandlerData; // If no custom clipboard handler is defined ImVector MenusIdSubmittedThisFrame; // A list of menu IDs that were rendered at least once ImGuiTypingSelectState TypingSelectState; // State for GetTypingSelectRequest() // Platform support ImGuiPlatformImeData PlatformImeData; // Data updated by current frame ImGuiPlatformImeData PlatformImeDataPrev; // Previous frame data. When changed we call the platform_io.Platform_SetImeDataFn() handler. // Settings bool SettingsLoaded; float SettingsDirtyTimer; // Save .ini Settings to memory when time reaches zero ImGuiTextBuffer SettingsIniData; // In memory .ini settings ImVector SettingsHandlers; // List of .ini settings handlers ImChunkStream SettingsWindows; // ImGuiWindow .ini settings entries ImChunkStream SettingsTables; // ImGuiTable .ini settings entries ImVector Hooks; // Hooks for extensions (e.g. test engine) ImGuiID HookIdNext; // Next available HookId // Localization const char* LocalizationTable[ImGuiLocKey_COUNT]; // Capture/Logging bool LogEnabled; // Currently capturing ImGuiLogFlags LogFlags; // Capture flags/type ImGuiWindow* LogWindow; ImFileHandle LogFile; // If != NULL log to stdout/ file ImGuiTextBuffer LogBuffer; // Accumulation buffer when log to clipboard. This is pointer so our GImGui static constructor doesn't call heap allocators. const char* LogNextPrefix; const char* LogNextSuffix; float LogLinePosY; bool LogLineFirstItem; int LogDepthRef; int LogDepthToExpand; int LogDepthToExpandDefault; // Default/stored value for LogDepthMaxExpand if not specified in the LogXXX function call. // Error Handling ImGuiErrorCallback ErrorCallback; // = NULL. May be exposed in public API eventually. void* ErrorCallbackUserData; // = NULL ImVec2 ErrorTooltipLockedPos; bool ErrorFirst; int ErrorCountCurrentFrame; // [Internal] Number of errors submitted this frame. ImGuiErrorRecoveryState StackSizesInNewFrame; // [Internal] ImGuiErrorRecoveryState*StackSizesInBeginForCurrentWindow; // [Internal] // Debug Tools // (some of the highly frequently used data are interleaved in other structures above: DebugBreakXXX fields, DebugHookIdInfo, DebugLocateId etc.) int DebugDrawIdConflictsCount; // Locked count (preserved when holding CTRL) ImGuiDebugLogFlags DebugLogFlags; ImGuiTextBuffer DebugLogBuf; ImGuiTextIndex DebugLogIndex; int DebugLogSkippedErrors; ImGuiDebugLogFlags DebugLogAutoDisableFlags; ImU8 DebugLogAutoDisableFrames; ImU8 DebugLocateFrames; // For DebugLocateItemOnHover(). This is used together with DebugLocateId which is in a hot/cached spot above. bool DebugBreakInLocateId; // Debug break in ItemAdd() call for g.DebugLocateId. ImGuiKeyChord DebugBreakKeyChord; // = ImGuiKey_Pause ImS8 DebugBeginReturnValueCullDepth; // Cycle between 0..9 then wrap around. bool DebugItemPickerActive; // Item picker is active (started with DebugStartItemPicker()) ImU8 DebugItemPickerMouseButton; ImGuiID DebugItemPickerBreakId; // Will call IM_DEBUG_BREAK() when encountering this ID float DebugFlashStyleColorTime; ImVec4 DebugFlashStyleColorBackup; ImGuiMetricsConfig DebugMetricsConfig; ImGuiIDStackTool DebugIDStackTool; ImGuiDebugAllocInfo DebugAllocInfo; // Misc float FramerateSecPerFrame[60]; // Calculate estimate of framerate for user over the last 60 frames.. int FramerateSecPerFrameIdx; int FramerateSecPerFrameCount; float FramerateSecPerFrameAccum; int WantCaptureMouseNextFrame; // Explicit capture override via SetNextFrameWantCaptureMouse()/SetNextFrameWantCaptureKeyboard(). Default to -1. int WantCaptureKeyboardNextFrame; // " int WantTextInputNextFrame; ImVector TempBuffer; // Temporary text buffer char TempKeychordName[64]; ImGuiContext(ImFontAtlas* shared_font_atlas); }; //----------------------------------------------------------------------------- // [SECTION] ImGuiWindowTempData, ImGuiWindow //----------------------------------------------------------------------------- // Transient per-window data, reset at the beginning of the frame. This used to be called ImGuiDrawContext, hence the DC variable name in ImGuiWindow. // (That's theory, in practice the delimitation between ImGuiWindow and ImGuiWindowTempData is quite tenuous and could be reconsidered..) // (This doesn't need a constructor because we zero-clear it as part of ImGuiWindow and all frame-temporary data are setup on Begin) struct IMGUI_API ImGuiWindowTempData { // Layout ImVec2 CursorPos; // Current emitting position, in absolute coordinates. ImVec2 CursorPosPrevLine; ImVec2 CursorStartPos; // Initial position after Begin(), generally ~ window position + WindowPadding. ImVec2 CursorMaxPos; // Used to implicitly calculate ContentSize at the beginning of next frame, for scrolling range and auto-resize. Always growing during the frame. ImVec2 IdealMaxPos; // Used to implicitly calculate ContentSizeIdeal at the beginning of next frame, for auto-resize only. Always growing during the frame. ImVec2 CurrLineSize; ImVec2 PrevLineSize; float CurrLineTextBaseOffset; // Baseline offset (0.0f by default on a new line, generally == style.FramePadding.y when a framed item has been added). float PrevLineTextBaseOffset; bool IsSameLine; bool IsSetPos; ImVec1 Indent; // Indentation / start position from left of window (increased by TreePush/TreePop, etc.) ImVec1 ColumnsOffset; // Offset to the current column (if ColumnsCurrent > 0). FIXME: This and the above should be a stack to allow use cases like Tree->Column->Tree. Need revamp columns API. ImVec1 GroupOffset; ImVec2 CursorStartPosLossyness;// Record the loss of precision of CursorStartPos due to really large scrolling amount. This is used by clipper to compensate and fix the most common use case of large scroll area. // Keyboard/Gamepad navigation ImGuiNavLayer NavLayerCurrent; // Current layer, 0..31 (we currently only use 0..1) short NavLayersActiveMask; // Which layers have been written to (result from previous frame) short NavLayersActiveMaskNext;// Which layers have been written to (accumulator for current frame) bool NavIsScrollPushableX; // Set when current work location may be scrolled horizontally when moving left / right. This is generally always true UNLESS within a column. bool NavHideHighlightOneFrame; bool NavWindowHasScrollY; // Set per window when scrolling can be used (== ScrollMax.y > 0.0f) // Miscellaneous bool MenuBarAppending; // FIXME: Remove this ImVec2 MenuBarOffset; // MenuBarOffset.x is sort of equivalent of a per-layer CursorPos.x, saved/restored as we switch to the menu bar. The only situation when MenuBarOffset.y is > 0 if when (SafeAreaPadding.y > FramePadding.y), often used on TVs. ImGuiMenuColumns MenuColumns; // Simplified columns storage for menu items measurement int TreeDepth; // Current tree depth. ImU32 TreeHasStackDataDepthMask; // Store whether given depth has ImGuiTreeNodeStackData data. Could be turned into a ImU64 if necessary. ImVector ChildWindows; ImGuiStorage* StateStorage; // Current persistent per-window storage (store e.g. tree node open/close state) ImGuiOldColumns* CurrentColumns; // Current columns set int CurrentTableIdx; // Current table index (into g.Tables) ImGuiLayoutType LayoutType; ImGuiLayoutType ParentLayoutType; // Layout type of parent window at the time of Begin() ImU32 ModalDimBgColor; ImGuiItemStatusFlags WindowItemStatusFlags; ImGuiItemStatusFlags ChildItemStatusFlags; // Local parameters stacks // We store the current settings outside of the vectors to increase memory locality (reduce cache misses). The vectors are rarely modified. Also it allows us to not heap allocate for short-lived windows which are not using those settings. float ItemWidth; // Current item width (>0.0: width in pixels, <0.0: align xx pixels to the right of window). float TextWrapPos; // Current text wrap pos. ImVector ItemWidthStack; // Store item widths to restore (attention: .back() is not == ItemWidth) ImVector TextWrapPosStack; // Store text wrap pos to restore (attention: .back() is not == TextWrapPos) }; // Storage for one window struct IMGUI_API ImGuiWindow { ImGuiContext* Ctx; // Parent UI context (needs to be set explicitly by parent). char* Name; // Window name, owned by the window. ImGuiID ID; // == ImHashStr(Name) ImGuiWindowFlags Flags; // See enum ImGuiWindowFlags_ ImGuiChildFlags ChildFlags; // Set when window is a child window. See enum ImGuiChildFlags_ ImGuiViewportP* Viewport; // Always set in Begin(). Inactive windows may have a NULL value here if their viewport was discarded. ImVec2 Pos; // Position (always rounded-up to nearest pixel) ImVec2 Size; // Current size (==SizeFull or collapsed title bar size) ImVec2 SizeFull; // Size when non collapsed ImVec2 ContentSize; // Size of contents/scrollable client area (calculated from the extents reach of the cursor) from previous frame. Does not include window decoration or window padding. ImVec2 ContentSizeIdeal; ImVec2 ContentSizeExplicit; // Size of contents/scrollable client area explicitly request by the user via SetNextWindowContentSize(). ImVec2 WindowPadding; // Window padding at the time of Begin(). float WindowRounding; // Window rounding at the time of Begin(). May be clamped lower to avoid rendering artifacts with title bar, menu bar etc. float WindowBorderSize; // Window border size at the time of Begin(). float TitleBarHeight, MenuBarHeight; // Note that those used to be function before 2024/05/28. If you have old code calling TitleBarHeight() you can change it to TitleBarHeight. float DecoOuterSizeX1, DecoOuterSizeY1; // Left/Up offsets. Sum of non-scrolling outer decorations (X1 generally == 0.0f. Y1 generally = TitleBarHeight + MenuBarHeight). Locked during Begin(). float DecoOuterSizeX2, DecoOuterSizeY2; // Right/Down offsets (X2 generally == ScrollbarSize.x, Y2 == ScrollbarSizes.y). float DecoInnerSizeX1, DecoInnerSizeY1; // Applied AFTER/OVER InnerRect. Specialized for Tables as they use specialized form of clipping and frozen rows/columns are inside InnerRect (and not part of regular decoration sizes). int NameBufLen; // Size of buffer storing Name. May be larger than strlen(Name)! ImGuiID MoveId; // == window->GetID("#MOVE") ImGuiID ChildId; // ID of corresponding item in parent window (for navigation to return from child window to parent window) ImGuiID PopupId; // ID in the popup stack when this window is used as a popup/menu (because we use generic Name/ID for recycling) ImVec2 Scroll; ImVec2 ScrollMax; ImVec2 ScrollTarget; // target scroll position. stored as cursor position with scrolling canceled out, so the highest point is always 0.0f. (FLT_MAX for no change) ImVec2 ScrollTargetCenterRatio; // 0.0f = scroll so that target position is at top, 0.5f = scroll so that target position is centered ImVec2 ScrollTargetEdgeSnapDist; // 0.0f = no snapping, >0.0f snapping threshold ImVec2 ScrollbarSizes; // Size taken by each scrollbars on their smaller axis. Pay attention! ScrollbarSizes.x == width of the vertical scrollbar, ScrollbarSizes.y = height of the horizontal scrollbar. bool ScrollbarX, ScrollbarY; // Are scrollbars visible? bool ScrollbarXStabilizeEnabled; // Was ScrollbarX previously auto-stabilized? ImU8 ScrollbarXStabilizeToggledHistory; // Used to stabilize scrollbar visibility in case of feedback loops bool Active; // Set to true on Begin(), unless Collapsed bool WasActive; bool WriteAccessed; // Set to true when any widget access the current window bool Collapsed; // Set when collapsing window to become only title-bar bool WantCollapseToggle; bool SkipItems; // Set when items can safely be all clipped (e.g. window not visible or collapsed) bool SkipRefresh; // [EXPERIMENTAL] Reuse previous frame drawn contents, Begin() returns false. bool Appearing; // Set during the frame where the window is appearing (or re-appearing) bool Hidden; // Do not display (== HiddenFrames*** > 0) bool IsFallbackWindow; // Set on the "Debug##Default" window. bool IsExplicitChild; // Set when passed _ChildWindow, left to false by BeginDocked() bool HasCloseButton; // Set when the window has a close button (p_open != NULL) signed char ResizeBorderHovered; // Current border being hovered for resize (-1: none, otherwise 0-3) signed char ResizeBorderHeld; // Current border being held for resize (-1: none, otherwise 0-3) short BeginCount; // Number of Begin() during the current frame (generally 0 or 1, 1+ if appending via multiple Begin/End pairs) short BeginCountPreviousFrame; // Number of Begin() during the previous frame short BeginOrderWithinParent; // Begin() order within immediate parent window, if we are a child window. Otherwise 0. short BeginOrderWithinContext; // Begin() order within entire imgui context. This is mostly used for debugging submission order related issues. short FocusOrder; // Order within WindowsFocusOrder[], altered when windows are focused. ImS8 AutoFitFramesX, AutoFitFramesY; bool AutoFitOnlyGrows; ImGuiDir AutoPosLastDirection; ImS8 HiddenFramesCanSkipItems; // Hide the window for N frames ImS8 HiddenFramesCannotSkipItems; // Hide the window for N frames while allowing items to be submitted so we can measure their size ImS8 HiddenFramesForRenderOnly; // Hide the window until frame N at Render() time only ImS8 DisableInputsFrames; // Disable window interactions for N frames ImGuiCond SetWindowPosAllowFlags : 8; // store acceptable condition flags for SetNextWindowPos() use. ImGuiCond SetWindowSizeAllowFlags : 8; // store acceptable condition flags for SetNextWindowSize() use. ImGuiCond SetWindowCollapsedAllowFlags : 8; // store acceptable condition flags for SetNextWindowCollapsed() use. ImVec2 SetWindowPosVal; // store window position when using a non-zero Pivot (position set needs to be processed when we know the window size) ImVec2 SetWindowPosPivot; // store window pivot for positioning. ImVec2(0, 0) when positioning from top-left corner; ImVec2(0.5f, 0.5f) for centering; ImVec2(1, 1) for bottom right. ImVector IDStack; // ID stack. ID are hashes seeded with the value at the top of the stack. (In theory this should be in the TempData structure) ImGuiWindowTempData DC; // Temporary per-window data, reset at the beginning of the frame. This used to be called ImGuiDrawContext, hence the "DC" variable name. // The best way to understand what those rectangles are is to use the 'Metrics->Tools->Show Windows Rectangles' viewer. // The main 'OuterRect', omitted as a field, is window->Rect(). ImRect OuterRectClipped; // == Window->Rect() just after setup in Begin(). == window->Rect() for root window. ImRect InnerRect; // Inner rectangle (omit title bar, menu bar, scroll bar) ImRect InnerClipRect; // == InnerRect shrunk by WindowPadding*0.5f on each side, clipped within viewport or parent clip rect. ImRect WorkRect; // Initially covers the whole scrolling region. Reduced by containers e.g columns/tables when active. Shrunk by WindowPadding*1.0f on each side. This is meant to replace ContentRegionRect over time (from 1.71+ onward). ImRect ParentWorkRect; // Backup of WorkRect before entering a container such as columns/tables. Used by e.g. SpanAllColumns functions to easily access. Stacked containers are responsible for maintaining this. // FIXME-WORKRECT: Could be a stack? ImRect ClipRect; // Current clipping/scissoring rectangle, evolve as we are using PushClipRect(), etc. == DrawList->clip_rect_stack.back(). ImRect ContentRegionRect; // FIXME: This is currently confusing/misleading. It is essentially WorkRect but not handling of scrolling. We currently rely on it as right/bottom aligned sizing operation need some size to rely on. ImVec2ih HitTestHoleSize; // Define an optional rectangular hole where mouse will pass-through the window. ImVec2ih HitTestHoleOffset; int LastFrameActive; // Last frame number the window was Active. float LastTimeActive; // Last timestamp the window was Active (using float as we don't need high precision there) float ItemWidthDefault; ImGuiStorage StateStorage; ImVector ColumnsStorage; float FontWindowScale; // User scale multiplier per-window, via SetWindowFontScale() float FontWindowScaleParents; float FontRefSize; // This is a copy of window->CalcFontSize() at the time of Begin(), trying to phase out CalcFontSize() especially as it may be called on non-current window. int SettingsOffset; // Offset into SettingsWindows[] (offsets are always valid as we only grow the array from the back) ImDrawList* DrawList; // == &DrawListInst (for backward compatibility reason with code using imgui_internal.h we keep this a pointer) ImDrawList DrawListInst; ImGuiWindow* ParentWindow; // If we are a child _or_ popup _or_ docked window, this is pointing to our parent. Otherwise NULL. ImGuiWindow* ParentWindowInBeginStack; ImGuiWindow* RootWindow; // Point to ourself or first ancestor that is not a child window. Doesn't cross through popups/dock nodes. ImGuiWindow* RootWindowPopupTree; // Point to ourself or first ancestor that is not a child window. Cross through popups parent<>child. ImGuiWindow* RootWindowForTitleBarHighlight; // Point to ourself or first ancestor which will display TitleBgActive color when this window is active. ImGuiWindow* RootWindowForNav; // Point to ourself or first ancestor which doesn't have the NavFlattened flag. ImGuiWindow* ParentWindowForFocusRoute; // Set to manual link a window to its logical parent so that Shortcut() chain are honoerd (e.g. Tool linked to Document) ImGuiWindow* NavLastChildNavWindow; // When going to the menu bar, we remember the child window we came from. (This could probably be made implicit if we kept g.Windows sorted by last focused including child window.) ImGuiID NavLastIds[ImGuiNavLayer_COUNT]; // Last known NavId for this window, per layer (0/1) ImRect NavRectRel[ImGuiNavLayer_COUNT]; // Reference rectangle, in window relative space ImVec2 NavPreferredScoringPosRel[ImGuiNavLayer_COUNT]; // Preferred X/Y position updated when moving on a given axis, reset to FLT_MAX. ImGuiID NavRootFocusScopeId; // Focus Scope ID at the time of Begin() int MemoryDrawListIdxCapacity; // Backup of last idx/vtx count, so when waking up the window we can preallocate and avoid iterative alloc/copy int MemoryDrawListVtxCapacity; bool MemoryCompacted; // Set when window extraneous data have been garbage collected public: ImGuiWindow(ImGuiContext* context, const char* name); ~ImGuiWindow(); ImGuiID GetID(const char* str, const char* str_end = NULL); ImGuiID GetID(const void* ptr); ImGuiID GetID(int n); ImGuiID GetIDFromPos(const ImVec2& p_abs); ImGuiID GetIDFromRectangle(const ImRect& r_abs); // We don't use g.FontSize because the window may be != g.CurrentWindow. ImRect Rect() const { return ImRect(Pos.x, Pos.y, Pos.x + Size.x, Pos.y + Size.y); } float CalcFontSize() const { ImGuiContext& g = *Ctx; return g.FontBaseSize * FontWindowScale * FontWindowScaleParents; } ImRect TitleBarRect() const { return ImRect(Pos, ImVec2(Pos.x + SizeFull.x, Pos.y + TitleBarHeight)); } ImRect MenuBarRect() const { float y1 = Pos.y + TitleBarHeight; return ImRect(Pos.x, y1, Pos.x + SizeFull.x, y1 + MenuBarHeight); } }; //----------------------------------------------------------------------------- // [SECTION] Tab bar, Tab item support //----------------------------------------------------------------------------- // Extend ImGuiTabBarFlags_ enum ImGuiTabBarFlagsPrivate_ { ImGuiTabBarFlags_DockNode = 1 << 20, // Part of a dock node [we don't use this in the master branch but it facilitate branch syncing to keep this around] ImGuiTabBarFlags_IsFocused = 1 << 21, ImGuiTabBarFlags_SaveSettings = 1 << 22, // FIXME: Settings are handled by the docking system, this only request the tab bar to mark settings dirty when reordering tabs }; // Extend ImGuiTabItemFlags_ enum ImGuiTabItemFlagsPrivate_ { ImGuiTabItemFlags_SectionMask_ = ImGuiTabItemFlags_Leading | ImGuiTabItemFlags_Trailing, ImGuiTabItemFlags_NoCloseButton = 1 << 20, // Track whether p_open was set or not (we'll need this info on the next frame to recompute ContentWidth during layout) ImGuiTabItemFlags_Button = 1 << 21, // Used by TabItemButton, change the tab item behavior to mimic a button ImGuiTabItemFlags_Invisible = 1 << 22, // To reserve space e.g. with ImGuiTabItemFlags_Leading //ImGuiTabItemFlags_Unsorted = 1 << 23, // [Docking] Trailing tabs with the _Unsorted flag will be sorted based on the DockOrder of their Window. }; // Storage for one active tab item (sizeof() 40 bytes) struct ImGuiTabItem { ImGuiID ID; ImGuiTabItemFlags Flags; int LastFrameVisible; int LastFrameSelected; // This allows us to infer an ordered list of the last activated tabs with little maintenance float Offset; // Position relative to beginning of tab float Width; // Width currently displayed float ContentWidth; // Width of label, stored during BeginTabItem() call float RequestedWidth; // Width optionally requested by caller, -1.0f is unused ImS32 NameOffset; // When Window==NULL, offset to name within parent ImGuiTabBar::TabsNames ImS16 BeginOrder; // BeginTabItem() order, used to re-order tabs after toggling ImGuiTabBarFlags_Reorderable ImS16 IndexDuringLayout; // Index only used during TabBarLayout(). Tabs gets reordered so 'Tabs[n].IndexDuringLayout == n' but may mismatch during additions. bool WantClose; // Marked as closed by SetTabItemClosed() ImGuiTabItem() { memset(this, 0, sizeof(*this)); LastFrameVisible = LastFrameSelected = -1; RequestedWidth = -1.0f; NameOffset = -1; BeginOrder = IndexDuringLayout = -1; } }; // Storage for a tab bar (sizeof() 160 bytes) struct IMGUI_API ImGuiTabBar { ImGuiWindow* Window; ImVector Tabs; ImGuiTabBarFlags Flags; ImGuiID ID; // Zero for tab-bars used by docking ImGuiID SelectedTabId; // Selected tab/window ImGuiID NextSelectedTabId; // Next selected tab/window. Will also trigger a scrolling animation ImGuiID VisibleTabId; // Can occasionally be != SelectedTabId (e.g. when previewing contents for CTRL+TAB preview) int CurrFrameVisible; int PrevFrameVisible; ImRect BarRect; float CurrTabsContentsHeight; float PrevTabsContentsHeight; // Record the height of contents submitted below the tab bar float WidthAllTabs; // Actual width of all tabs (locked during layout) float WidthAllTabsIdeal; // Ideal width if all tabs were visible and not clipped float ScrollingAnim; float ScrollingTarget; float ScrollingTargetDistToVisibility; float ScrollingSpeed; float ScrollingRectMinX; float ScrollingRectMaxX; float SeparatorMinX; float SeparatorMaxX; ImGuiID ReorderRequestTabId; ImS16 ReorderRequestOffset; ImS8 BeginCount; bool WantLayout; bool VisibleTabWasSubmitted; bool TabsAddedNew; // Set to true when a new tab item or button has been added to the tab bar during last frame ImS16 TabsActiveCount; // Number of tabs submitted this frame. ImS16 LastTabItemIdx; // Index of last BeginTabItem() tab for use by EndTabItem() float ItemSpacingY; ImVec2 FramePadding; // style.FramePadding locked at the time of BeginTabBar() ImVec2 BackupCursorPos; ImGuiTextBuffer TabsNames; // For non-docking tab bar we re-append names in a contiguous buffer. ImGuiTabBar(); }; //----------------------------------------------------------------------------- // [SECTION] Table support //----------------------------------------------------------------------------- #define IM_COL32_DISABLE IM_COL32(0,0,0,1) // Special sentinel code which cannot be used as a regular color. #define IMGUI_TABLE_MAX_COLUMNS 512 // May be further lifted // Our current column maximum is 64 but we may raise that in the future. typedef ImS16 ImGuiTableColumnIdx; typedef ImU16 ImGuiTableDrawChannelIdx; // [Internal] sizeof() ~ 112 // We use the terminology "Enabled" to refer to a column that is not Hidden by user/api. // We use the terminology "Clipped" to refer to a column that is out of sight because of scrolling/clipping. // This is in contrast with some user-facing api such as IsItemVisible() / IsRectVisible() which use "Visible" to mean "not clipped". struct ImGuiTableColumn { ImGuiTableColumnFlags Flags; // Flags after some patching (not directly same as provided by user). See ImGuiTableColumnFlags_ float WidthGiven; // Final/actual width visible == (MaxX - MinX), locked in TableUpdateLayout(). May be > WidthRequest to honor minimum width, may be < WidthRequest to honor shrinking columns down in tight space. float MinX; // Absolute positions float MaxX; float WidthRequest; // Master width absolute value when !(Flags & _WidthStretch). When Stretch this is derived every frame from StretchWeight in TableUpdateLayout() float WidthAuto; // Automatic width float WidthMax; // Maximum width (FIXME: overwritten by each instance) float StretchWeight; // Master width weight when (Flags & _WidthStretch). Often around ~1.0f initially. float InitStretchWeightOrWidth; // Value passed to TableSetupColumn(). For Width it is a content width (_without padding_). ImRect ClipRect; // Clipping rectangle for the column ImGuiID UserID; // Optional, value passed to TableSetupColumn() float WorkMinX; // Contents region min ~(MinX + CellPaddingX + CellSpacingX1) == cursor start position when entering column float WorkMaxX; // Contents region max ~(MaxX - CellPaddingX - CellSpacingX2) float ItemWidth; // Current item width for the column, preserved across rows float ContentMaxXFrozen; // Contents maximum position for frozen rows (apart from headers), from which we can infer content width. float ContentMaxXUnfrozen; float ContentMaxXHeadersUsed; // Contents maximum position for headers rows (regardless of freezing). TableHeader() automatically softclip itself + report ideal desired size, to avoid creating extraneous draw calls float ContentMaxXHeadersIdeal; ImS16 NameOffset; // Offset into parent ColumnsNames[] ImGuiTableColumnIdx DisplayOrder; // Index within Table's IndexToDisplayOrder[] (column may be reordered by users) ImGuiTableColumnIdx IndexWithinEnabledSet; // Index within enabled/visible set (<= IndexToDisplayOrder) ImGuiTableColumnIdx PrevEnabledColumn; // Index of prev enabled/visible column within Columns[], -1 if first enabled/visible column ImGuiTableColumnIdx NextEnabledColumn; // Index of next enabled/visible column within Columns[], -1 if last enabled/visible column ImGuiTableColumnIdx SortOrder; // Index of this column within sort specs, -1 if not sorting on this column, 0 for single-sort, may be >0 on multi-sort ImGuiTableDrawChannelIdx DrawChannelCurrent; // Index within DrawSplitter.Channels[] ImGuiTableDrawChannelIdx DrawChannelFrozen; // Draw channels for frozen rows (often headers) ImGuiTableDrawChannelIdx DrawChannelUnfrozen; // Draw channels for unfrozen rows bool IsEnabled; // IsUserEnabled && (Flags & ImGuiTableColumnFlags_Disabled) == 0 bool IsUserEnabled; // Is the column not marked Hidden by the user? (unrelated to being off view, e.g. clipped by scrolling). bool IsUserEnabledNextFrame; bool IsVisibleX; // Is actually in view (e.g. overlapping the host window clipping rectangle, not scrolled). bool IsVisibleY; bool IsRequestOutput; // Return value for TableSetColumnIndex() / TableNextColumn(): whether we request user to output contents or not. bool IsSkipItems; // Do we want item submissions to this column to be completely ignored (no layout will happen). bool IsPreserveWidthAuto; ImS8 NavLayerCurrent; // ImGuiNavLayer in 1 byte ImU8 AutoFitQueue; // Queue of 8 values for the next 8 frames to request auto-fit ImU8 CannotSkipItemsQueue; // Queue of 8 values for the next 8 frames to disable Clipped/SkipItem ImU8 SortDirection : 2; // ImGuiSortDirection_Ascending or ImGuiSortDirection_Descending ImU8 SortDirectionsAvailCount : 2; // Number of available sort directions (0 to 3) ImU8 SortDirectionsAvailMask : 4; // Mask of available sort directions (1-bit each) ImU8 SortDirectionsAvailList; // Ordered list of available sort directions (2-bits each, total 8-bits) ImGuiTableColumn() { memset(this, 0, sizeof(*this)); StretchWeight = WidthRequest = -1.0f; NameOffset = -1; DisplayOrder = IndexWithinEnabledSet = -1; PrevEnabledColumn = NextEnabledColumn = -1; SortOrder = -1; SortDirection = ImGuiSortDirection_None; DrawChannelCurrent = DrawChannelFrozen = DrawChannelUnfrozen = (ImU8)-1; } }; // Transient cell data stored per row. // sizeof() ~ 6 bytes struct ImGuiTableCellData { ImU32 BgColor; // Actual color ImGuiTableColumnIdx Column; // Column number }; // Parameters for TableAngledHeadersRowEx() // This may end up being refactored for more general purpose. // sizeof() ~ 12 bytes struct ImGuiTableHeaderData { ImGuiTableColumnIdx Index; // Column index ImU32 TextColor; ImU32 BgColor0; ImU32 BgColor1; }; // Per-instance data that needs preserving across frames (seemingly most others do not need to be preserved aside from debug needs. Does that means they could be moved to ImGuiTableTempData?) // sizeof() ~ 24 bytes struct ImGuiTableInstanceData { ImGuiID TableInstanceID; float LastOuterHeight; // Outer height from last frame float LastTopHeadersRowHeight; // Height of first consecutive header rows from last frame (FIXME: this is used assuming consecutive headers are in same frozen set) float LastFrozenHeight; // Height of frozen section from last frame int HoveredRowLast; // Index of row which was hovered last frame. int HoveredRowNext; // Index of row hovered this frame, set after encountering it. ImGuiTableInstanceData() { TableInstanceID = 0; LastOuterHeight = LastTopHeadersRowHeight = LastFrozenHeight = 0.0f; HoveredRowLast = HoveredRowNext = -1; } }; // sizeof() ~ 592 bytes + heap allocs described in TableBeginInitMemory() struct IMGUI_API ImGuiTable { ImGuiID ID; ImGuiTableFlags Flags; void* RawData; // Single allocation to hold Columns[], DisplayOrderToIndex[], and RowCellData[] ImGuiTableTempData* TempData; // Transient data while table is active. Point within g.CurrentTableStack[] ImSpan Columns; // Point within RawData[] ImSpan DisplayOrderToIndex; // Point within RawData[]. Store display order of columns (when not reordered, the values are 0...Count-1) ImSpan RowCellData; // Point within RawData[]. Store cells background requests for current row. ImBitArrayPtr EnabledMaskByDisplayOrder; // Column DisplayOrder -> IsEnabled map ImBitArrayPtr EnabledMaskByIndex; // Column Index -> IsEnabled map (== not hidden by user/api) in a format adequate for iterating column without touching cold data ImBitArrayPtr VisibleMaskByIndex; // Column Index -> IsVisibleX|IsVisibleY map (== not hidden by user/api && not hidden by scrolling/cliprect) ImGuiTableFlags SettingsLoadedFlags; // Which data were loaded from the .ini file (e.g. when order is not altered we won't save order) int SettingsOffset; // Offset in g.SettingsTables int LastFrameActive; int ColumnsCount; // Number of columns declared in BeginTable() int CurrentRow; int CurrentColumn; ImS16 InstanceCurrent; // Count of BeginTable() calls with same ID in the same frame (generally 0). This is a little bit similar to BeginCount for a window, but multiple tables with the same ID are multiple tables, they are just synced. ImS16 InstanceInteracted; // Mark which instance (generally 0) of the same ID is being interacted with float RowPosY1; float RowPosY2; float RowMinHeight; // Height submitted to TableNextRow() float RowCellPaddingY; // Top and bottom padding. Reloaded during row change. float RowTextBaseline; float RowIndentOffsetX; ImGuiTableRowFlags RowFlags : 16; // Current row flags, see ImGuiTableRowFlags_ ImGuiTableRowFlags LastRowFlags : 16; int RowBgColorCounter; // Counter for alternating background colors (can be fast-forwarded by e.g clipper), not same as CurrentRow because header rows typically don't increase this. ImU32 RowBgColor[2]; // Background color override for current row. ImU32 BorderColorStrong; ImU32 BorderColorLight; float BorderX1; float BorderX2; float HostIndentX; float MinColumnWidth; float OuterPaddingX; float CellPaddingX; // Padding from each borders. Locked in BeginTable()/Layout. float CellSpacingX1; // Spacing between non-bordered cells. Locked in BeginTable()/Layout. float CellSpacingX2; float InnerWidth; // User value passed to BeginTable(), see comments at the top of BeginTable() for details. float ColumnsGivenWidth; // Sum of current column width float ColumnsAutoFitWidth; // Sum of ideal column width in order nothing to be clipped, used for auto-fitting and content width submission in outer window float ColumnsStretchSumWeights; // Sum of weight of all enabled stretching columns float ResizedColumnNextWidth; float ResizeLockMinContentsX2; // Lock minimum contents width while resizing down in order to not create feedback loops. But we allow growing the table. float RefScale; // Reference scale to be able to rescale columns on font/dpi changes. float AngledHeadersHeight; // Set by TableAngledHeadersRow(), used in TableUpdateLayout() float AngledHeadersSlope; // Set by TableAngledHeadersRow(), used in TableUpdateLayout() ImRect OuterRect; // Note: for non-scrolling table, OuterRect.Max.y is often FLT_MAX until EndTable(), unless a height has been specified in BeginTable(). ImRect InnerRect; // InnerRect but without decoration. As with OuterRect, for non-scrolling tables, InnerRect.Max.y is " ImRect WorkRect; ImRect InnerClipRect; ImRect BgClipRect; // We use this to cpu-clip cell background color fill, evolve during the frame as we cross frozen rows boundaries ImRect Bg0ClipRectForDrawCmd; // Actual ImDrawCmd clip rect for BG0/1 channel. This tends to be == OuterWindow->ClipRect at BeginTable() because output in BG0/BG1 is cpu-clipped ImRect Bg2ClipRectForDrawCmd; // Actual ImDrawCmd clip rect for BG2 channel. This tends to be a correct, tight-fit, because output to BG2 are done by widgets relying on regular ClipRect. ImRect HostClipRect; // This is used to check if we can eventually merge our columns draw calls into the current draw call of the current window. ImRect HostBackupInnerClipRect; // Backup of InnerWindow->ClipRect during PushTableBackground()/PopTableBackground() ImGuiWindow* OuterWindow; // Parent window for the table ImGuiWindow* InnerWindow; // Window holding the table data (== OuterWindow or a child window) ImGuiTextBuffer ColumnsNames; // Contiguous buffer holding columns names ImDrawListSplitter* DrawSplitter; // Shortcut to TempData->DrawSplitter while in table. Isolate draw commands per columns to avoid switching clip rect constantly ImGuiTableInstanceData InstanceDataFirst; ImVector InstanceDataExtra; // FIXME-OPT: Using a small-vector pattern would be good. ImGuiTableColumnSortSpecs SortSpecsSingle; ImVector SortSpecsMulti; // FIXME-OPT: Using a small-vector pattern would be good. ImGuiTableSortSpecs SortSpecs; // Public facing sorts specs, this is what we return in TableGetSortSpecs() ImGuiTableColumnIdx SortSpecsCount; ImGuiTableColumnIdx ColumnsEnabledCount; // Number of enabled columns (<= ColumnsCount) ImGuiTableColumnIdx ColumnsEnabledFixedCount; // Number of enabled columns using fixed width (<= ColumnsCount) ImGuiTableColumnIdx DeclColumnsCount; // Count calls to TableSetupColumn() ImGuiTableColumnIdx AngledHeadersCount; // Count columns with angled headers ImGuiTableColumnIdx HoveredColumnBody; // Index of column whose visible region is being hovered. Important: == ColumnsCount when hovering empty region after the right-most column! ImGuiTableColumnIdx HoveredColumnBorder; // Index of column whose right-border is being hovered (for resizing). ImGuiTableColumnIdx HighlightColumnHeader; // Index of column which should be highlighted. ImGuiTableColumnIdx AutoFitSingleColumn; // Index of single column requesting auto-fit. ImGuiTableColumnIdx ResizedColumn; // Index of column being resized. Reset when InstanceCurrent==0. ImGuiTableColumnIdx LastResizedColumn; // Index of column being resized from previous frame. ImGuiTableColumnIdx HeldHeaderColumn; // Index of column header being held. ImGuiTableColumnIdx ReorderColumn; // Index of column being reordered. (not cleared) ImGuiTableColumnIdx ReorderColumnDir; // -1 or +1 ImGuiTableColumnIdx LeftMostEnabledColumn; // Index of left-most non-hidden column. ImGuiTableColumnIdx RightMostEnabledColumn; // Index of right-most non-hidden column. ImGuiTableColumnIdx LeftMostStretchedColumn; // Index of left-most stretched column. ImGuiTableColumnIdx RightMostStretchedColumn; // Index of right-most stretched column. ImGuiTableColumnIdx ContextPopupColumn; // Column right-clicked on, of -1 if opening context menu from a neutral/empty spot ImGuiTableColumnIdx FreezeRowsRequest; // Requested frozen rows count ImGuiTableColumnIdx FreezeRowsCount; // Actual frozen row count (== FreezeRowsRequest, or == 0 when no scrolling offset) ImGuiTableColumnIdx FreezeColumnsRequest; // Requested frozen columns count ImGuiTableColumnIdx FreezeColumnsCount; // Actual frozen columns count (== FreezeColumnsRequest, or == 0 when no scrolling offset) ImGuiTableColumnIdx RowCellDataCurrent; // Index of current RowCellData[] entry in current row ImGuiTableDrawChannelIdx DummyDrawChannel; // Redirect non-visible columns here. ImGuiTableDrawChannelIdx Bg2DrawChannelCurrent; // For Selectable() and other widgets drawing across columns after the freezing line. Index within DrawSplitter.Channels[] ImGuiTableDrawChannelIdx Bg2DrawChannelUnfrozen; ImS8 NavLayer; // ImGuiNavLayer at the time of BeginTable(). bool IsLayoutLocked; // Set by TableUpdateLayout() which is called when beginning the first row. bool IsInsideRow; // Set when inside TableBeginRow()/TableEndRow(). bool IsInitializing; bool IsSortSpecsDirty; bool IsUsingHeaders; // Set when the first row had the ImGuiTableRowFlags_Headers flag. bool IsContextPopupOpen; // Set when default context menu is open (also see: ContextPopupColumn, InstanceInteracted). bool DisableDefaultContextMenu; // Disable default context menu contents. You may submit your own using TableBeginContextMenuPopup()/EndPopup() bool IsSettingsRequestLoad; bool IsSettingsDirty; // Set when table settings have changed and needs to be reported into ImGuiTableSetttings data. bool IsDefaultDisplayOrder; // Set when display order is unchanged from default (DisplayOrder contains 0...Count-1) bool IsResetAllRequest; bool IsResetDisplayOrderRequest; bool IsUnfrozenRows; // Set when we got past the frozen row. bool IsDefaultSizingPolicy; // Set if user didn't explicitly set a sizing policy in BeginTable() bool IsActiveIdAliveBeforeTable; bool IsActiveIdInTable; bool HasScrollbarYCurr; // Whether ANY instance of this table had a vertical scrollbar during the current frame. bool HasScrollbarYPrev; // Whether ANY instance of this table had a vertical scrollbar during the previous. bool MemoryCompacted; bool HostSkipItems; // Backup of InnerWindow->SkipItem at the end of BeginTable(), because we will overwrite InnerWindow->SkipItem on a per-column basis ImGuiTable() { memset(this, 0, sizeof(*this)); LastFrameActive = -1; } ~ImGuiTable() { IM_FREE(RawData); } }; // Transient data that are only needed between BeginTable() and EndTable(), those buffers are shared (1 per level of stacked table). // - Accessing those requires chasing an extra pointer so for very frequently used data we leave them in the main table structure. // - We also leave out of this structure data that tend to be particularly useful for debugging/metrics. // FIXME-TABLE: more transient data could be stored in a stacked ImGuiTableTempData: e.g. SortSpecs. // sizeof() ~ 136 bytes. struct IMGUI_API ImGuiTableTempData { int TableIndex; // Index in g.Tables.Buf[] pool float LastTimeActive; // Last timestamp this structure was used float AngledHeadersExtraWidth; // Used in EndTable() ImVector AngledHeadersRequests; // Used in TableAngledHeadersRow() ImVec2 UserOuterSize; // outer_size.x passed to BeginTable() ImDrawListSplitter DrawSplitter; ImRect HostBackupWorkRect; // Backup of InnerWindow->WorkRect at the end of BeginTable() ImRect HostBackupParentWorkRect; // Backup of InnerWindow->ParentWorkRect at the end of BeginTable() ImVec2 HostBackupPrevLineSize; // Backup of InnerWindow->DC.PrevLineSize at the end of BeginTable() ImVec2 HostBackupCurrLineSize; // Backup of InnerWindow->DC.CurrLineSize at the end of BeginTable() ImVec2 HostBackupCursorMaxPos; // Backup of InnerWindow->DC.CursorMaxPos at the end of BeginTable() ImVec1 HostBackupColumnsOffset; // Backup of OuterWindow->DC.ColumnsOffset at the end of BeginTable() float HostBackupItemWidth; // Backup of OuterWindow->DC.ItemWidth at the end of BeginTable() int HostBackupItemWidthStackSize;//Backup of OuterWindow->DC.ItemWidthStack.Size at the end of BeginTable() ImGuiTableTempData() { memset(this, 0, sizeof(*this)); LastTimeActive = -1.0f; } }; // sizeof() ~ 16 struct ImGuiTableColumnSettings { float WidthOrWeight; ImGuiID UserID; ImGuiTableColumnIdx Index; ImGuiTableColumnIdx DisplayOrder; ImGuiTableColumnIdx SortOrder; ImU8 SortDirection : 2; ImS8 IsEnabled : 2; // "Visible" in ini file ImU8 IsStretch : 1; ImGuiTableColumnSettings() { WidthOrWeight = 0.0f; UserID = 0; Index = -1; DisplayOrder = SortOrder = -1; SortDirection = ImGuiSortDirection_None; IsEnabled = -1; IsStretch = 0; } }; // This is designed to be stored in a single ImChunkStream (1 header followed by N ImGuiTableColumnSettings, etc.) struct ImGuiTableSettings { ImGuiID ID; // Set to 0 to invalidate/delete the setting ImGuiTableFlags SaveFlags; // Indicate data we want to save using the Resizable/Reorderable/Sortable/Hideable flags (could be using its own flags..) float RefScale; // Reference scale to be able to rescale columns on font/dpi changes. ImGuiTableColumnIdx ColumnsCount; ImGuiTableColumnIdx ColumnsCountMax; // Maximum number of columns this settings instance can store, we can recycle a settings instance with lower number of columns but not higher bool WantApply; // Set when loaded from .ini data (to enable merging/loading .ini data into an already running context) ImGuiTableSettings() { memset(this, 0, sizeof(*this)); } ImGuiTableColumnSettings* GetColumnSettings() { return (ImGuiTableColumnSettings*)(this + 1); } }; //----------------------------------------------------------------------------- // [SECTION] ImGui internal API // No guarantee of forward compatibility here! //----------------------------------------------------------------------------- namespace ImGui { // Windows // We should always have a CurrentWindow in the stack (there is an implicit "Debug" window) // If this ever crashes because g.CurrentWindow is NULL, it means that either: // - ImGui::NewFrame() has never been called, which is illegal. // - You are calling ImGui functions after ImGui::EndFrame()/ImGui::Render() and before the next ImGui::NewFrame(), which is also illegal. IMGUI_API ImGuiIO& GetIO(ImGuiContext* ctx); IMGUI_API ImGuiPlatformIO& GetPlatformIO(ImGuiContext* ctx); inline ImGuiWindow* GetCurrentWindowRead() { ImGuiContext& g = *GImGui; return g.CurrentWindow; } inline ImGuiWindow* GetCurrentWindow() { ImGuiContext& g = *GImGui; g.CurrentWindow->WriteAccessed = true; return g.CurrentWindow; } IMGUI_API ImGuiWindow* FindWindowByID(ImGuiID id); IMGUI_API ImGuiWindow* FindWindowByName(const char* name); IMGUI_API void UpdateWindowParentAndRootLinks(ImGuiWindow* window, ImGuiWindowFlags flags, ImGuiWindow* parent_window); IMGUI_API void UpdateWindowSkipRefresh(ImGuiWindow* window); IMGUI_API ImVec2 CalcWindowNextAutoFitSize(ImGuiWindow* window); IMGUI_API bool IsWindowChildOf(ImGuiWindow* window, ImGuiWindow* potential_parent, bool popup_hierarchy); IMGUI_API bool IsWindowWithinBeginStackOf(ImGuiWindow* window, ImGuiWindow* potential_parent); IMGUI_API bool IsWindowAbove(ImGuiWindow* potential_above, ImGuiWindow* potential_below); IMGUI_API bool IsWindowNavFocusable(ImGuiWindow* window); IMGUI_API void SetWindowPos(ImGuiWindow* window, const ImVec2& pos, ImGuiCond cond = 0); IMGUI_API void SetWindowSize(ImGuiWindow* window, const ImVec2& size, ImGuiCond cond = 0); IMGUI_API void SetWindowCollapsed(ImGuiWindow* window, bool collapsed, ImGuiCond cond = 0); IMGUI_API void SetWindowHitTestHole(ImGuiWindow* window, const ImVec2& pos, const ImVec2& size); IMGUI_API void SetWindowHiddenAndSkipItemsForCurrentFrame(ImGuiWindow* window); inline void SetWindowParentWindowForFocusRoute(ImGuiWindow* window, ImGuiWindow* parent_window) { window->ParentWindowForFocusRoute = parent_window; } inline ImRect WindowRectAbsToRel(ImGuiWindow* window, const ImRect& r) { ImVec2 off = window->DC.CursorStartPos; return ImRect(r.Min.x - off.x, r.Min.y - off.y, r.Max.x - off.x, r.Max.y - off.y); } inline ImRect WindowRectRelToAbs(ImGuiWindow* window, const ImRect& r) { ImVec2 off = window->DC.CursorStartPos; return ImRect(r.Min.x + off.x, r.Min.y + off.y, r.Max.x + off.x, r.Max.y + off.y); } inline ImVec2 WindowPosAbsToRel(ImGuiWindow* window, const ImVec2& p) { ImVec2 off = window->DC.CursorStartPos; return ImVec2(p.x - off.x, p.y - off.y); } inline ImVec2 WindowPosRelToAbs(ImGuiWindow* window, const ImVec2& p) { ImVec2 off = window->DC.CursorStartPos; return ImVec2(p.x + off.x, p.y + off.y); } // Windows: Display Order and Focus Order IMGUI_API void FocusWindow(ImGuiWindow* window, ImGuiFocusRequestFlags flags = 0); IMGUI_API void FocusTopMostWindowUnderOne(ImGuiWindow* under_this_window, ImGuiWindow* ignore_window, ImGuiViewport* filter_viewport, ImGuiFocusRequestFlags flags); IMGUI_API void BringWindowToFocusFront(ImGuiWindow* window); IMGUI_API void BringWindowToDisplayFront(ImGuiWindow* window); IMGUI_API void BringWindowToDisplayBack(ImGuiWindow* window); IMGUI_API void BringWindowToDisplayBehind(ImGuiWindow* window, ImGuiWindow* above_window); IMGUI_API int FindWindowDisplayIndex(ImGuiWindow* window); IMGUI_API ImGuiWindow* FindBottomMostVisibleWindowWithinBeginStack(ImGuiWindow* window); // Windows: Idle, Refresh Policies [EXPERIMENTAL] IMGUI_API void SetNextWindowRefreshPolicy(ImGuiWindowRefreshFlags flags); // Fonts, drawing IMGUI_API void SetCurrentFont(ImFont* font); inline ImFont* GetDefaultFont() { ImGuiContext& g = *GImGui; return g.IO.FontDefault ? g.IO.FontDefault : g.IO.Fonts->Fonts[0]; } IMGUI_API void PushPasswordFont(); inline ImDrawList* GetForegroundDrawList(ImGuiWindow* window) { IM_UNUSED(window); return GetForegroundDrawList(); } // This seemingly unnecessary wrapper simplifies compatibility between the 'master' and 'docking' branches. IMGUI_API ImDrawList* GetBackgroundDrawList(ImGuiViewport* viewport); // get background draw list for the given viewport. this draw list will be the first rendering one. Useful to quickly draw shapes/text behind dear imgui contents. IMGUI_API ImDrawList* GetForegroundDrawList(ImGuiViewport* viewport); // get foreground draw list for the given viewport. this draw list will be the last rendered one. Useful to quickly draw shapes/text over dear imgui contents. IMGUI_API void AddDrawListToDrawDataEx(ImDrawData* draw_data, ImVector* out_list, ImDrawList* draw_list); // Init IMGUI_API void Initialize(); IMGUI_API void Shutdown(); // Since 1.60 this is a _private_ function. You can call DestroyContext() to destroy the context created by CreateContext(). // NewFrame IMGUI_API void UpdateInputEvents(bool trickle_fast_inputs); IMGUI_API void UpdateHoveredWindowAndCaptureFlags(); IMGUI_API void FindHoveredWindowEx(const ImVec2& pos, bool find_first_and_in_any_viewport, ImGuiWindow** out_hovered_window, ImGuiWindow** out_hovered_window_under_moving_window); IMGUI_API void StartMouseMovingWindow(ImGuiWindow* window); IMGUI_API void UpdateMouseMovingWindowNewFrame(); IMGUI_API void UpdateMouseMovingWindowEndFrame(); // Generic context hooks IMGUI_API ImGuiID AddContextHook(ImGuiContext* context, const ImGuiContextHook* hook); IMGUI_API void RemoveContextHook(ImGuiContext* context, ImGuiID hook_to_remove); IMGUI_API void CallContextHooks(ImGuiContext* context, ImGuiContextHookType type); // Viewports IMGUI_API void ScaleWindowsInViewport(ImGuiViewportP* viewport, float scale); IMGUI_API void SetWindowViewport(ImGuiWindow* window, ImGuiViewportP* viewport); // Settings IMGUI_API void MarkIniSettingsDirty(); IMGUI_API void MarkIniSettingsDirty(ImGuiWindow* window); IMGUI_API void ClearIniSettings(); IMGUI_API void AddSettingsHandler(const ImGuiSettingsHandler* handler); IMGUI_API void RemoveSettingsHandler(const char* type_name); IMGUI_API ImGuiSettingsHandler* FindSettingsHandler(const char* type_name); // Settings - Windows IMGUI_API ImGuiWindowSettings* CreateNewWindowSettings(const char* name); IMGUI_API ImGuiWindowSettings* FindWindowSettingsByID(ImGuiID id); IMGUI_API ImGuiWindowSettings* FindWindowSettingsByWindow(ImGuiWindow* window); IMGUI_API void ClearWindowSettings(const char* name); // Localization IMGUI_API void LocalizeRegisterEntries(const ImGuiLocEntry* entries, int count); inline const char* LocalizeGetMsg(ImGuiLocKey key) { ImGuiContext& g = *GImGui; const char* msg = g.LocalizationTable[key]; return msg ? msg : "*Missing Text*"; } // Scrolling IMGUI_API void SetScrollX(ImGuiWindow* window, float scroll_x); IMGUI_API void SetScrollY(ImGuiWindow* window, float scroll_y); IMGUI_API void SetScrollFromPosX(ImGuiWindow* window, float local_x, float center_x_ratio); IMGUI_API void SetScrollFromPosY(ImGuiWindow* window, float local_y, float center_y_ratio); // Early work-in-progress API (ScrollToItem() will become public) IMGUI_API void ScrollToItem(ImGuiScrollFlags flags = 0); IMGUI_API void ScrollToRect(ImGuiWindow* window, const ImRect& rect, ImGuiScrollFlags flags = 0); IMGUI_API ImVec2 ScrollToRectEx(ImGuiWindow* window, const ImRect& rect, ImGuiScrollFlags flags = 0); //#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS inline void ScrollToBringRectIntoView(ImGuiWindow* window, const ImRect& rect) { ScrollToRect(window, rect, ImGuiScrollFlags_KeepVisibleEdgeY); } //#endif // Basic Accessors inline ImGuiItemStatusFlags GetItemStatusFlags() { ImGuiContext& g = *GImGui; return g.LastItemData.StatusFlags; } inline ImGuiItemFlags GetItemFlags() { ImGuiContext& g = *GImGui; return g.LastItemData.ItemFlags; } inline ImGuiID GetActiveID() { ImGuiContext& g = *GImGui; return g.ActiveId; } inline ImGuiID GetFocusID() { ImGuiContext& g = *GImGui; return g.NavId; } IMGUI_API void SetActiveID(ImGuiID id, ImGuiWindow* window); IMGUI_API void SetFocusID(ImGuiID id, ImGuiWindow* window); IMGUI_API void ClearActiveID(); IMGUI_API ImGuiID GetHoveredID(); IMGUI_API void SetHoveredID(ImGuiID id); IMGUI_API void KeepAliveID(ImGuiID id); IMGUI_API void MarkItemEdited(ImGuiID id); // Mark data associated to given item as "edited", used by IsItemDeactivatedAfterEdit() function. IMGUI_API void PushOverrideID(ImGuiID id); // Push given value as-is at the top of the ID stack (whereas PushID combines old and new hashes) IMGUI_API ImGuiID GetIDWithSeed(const char* str_id_begin, const char* str_id_end, ImGuiID seed); IMGUI_API ImGuiID GetIDWithSeed(int n, ImGuiID seed); // Basic Helpers for widget code IMGUI_API void ItemSize(const ImVec2& size, float text_baseline_y = -1.0f); inline void ItemSize(const ImRect& bb, float text_baseline_y = -1.0f) { ItemSize(bb.GetSize(), text_baseline_y); } // FIXME: This is a misleading API since we expect CursorPos to be bb.Min. IMGUI_API bool ItemAdd(const ImRect& bb, ImGuiID id, const ImRect* nav_bb = NULL, ImGuiItemFlags extra_flags = 0); IMGUI_API bool ItemHoverable(const ImRect& bb, ImGuiID id, ImGuiItemFlags item_flags); IMGUI_API bool IsWindowContentHoverable(ImGuiWindow* window, ImGuiHoveredFlags flags = 0); IMGUI_API bool IsClippedEx(const ImRect& bb, ImGuiID id); IMGUI_API void SetLastItemData(ImGuiID item_id, ImGuiItemFlags item_flags, ImGuiItemStatusFlags status_flags, const ImRect& item_rect); IMGUI_API ImVec2 CalcItemSize(ImVec2 size, float default_w, float default_h); IMGUI_API float CalcWrapWidthForPos(const ImVec2& pos, float wrap_pos_x); IMGUI_API void PushMultiItemsWidths(int components, float width_full); IMGUI_API void ShrinkWidths(ImGuiShrinkWidthItem* items, int count, float width_excess); // Parameter stacks (shared) IMGUI_API const ImGuiStyleVarInfo* GetStyleVarInfo(ImGuiStyleVar idx); IMGUI_API void BeginDisabledOverrideReenable(); IMGUI_API void EndDisabledOverrideReenable(); // Logging/Capture IMGUI_API void LogBegin(ImGuiLogFlags flags, int auto_open_depth); // -> BeginCapture() when we design v2 api, for now stay under the radar by using the old name. IMGUI_API void LogToBuffer(int auto_open_depth = -1); // Start logging/capturing to internal buffer IMGUI_API void LogRenderedText(const ImVec2* ref_pos, const char* text, const char* text_end = NULL); IMGUI_API void LogSetNextTextDecoration(const char* prefix, const char* suffix); // Childs IMGUI_API bool BeginChildEx(const char* name, ImGuiID id, const ImVec2& size_arg, ImGuiChildFlags child_flags, ImGuiWindowFlags window_flags); // Popups, Modals IMGUI_API bool BeginPopupEx(ImGuiID id, ImGuiWindowFlags extra_window_flags); IMGUI_API bool BeginPopupMenuEx(ImGuiID id, const char* label, ImGuiWindowFlags extra_window_flags); IMGUI_API void OpenPopupEx(ImGuiID id, ImGuiPopupFlags popup_flags = ImGuiPopupFlags_None); IMGUI_API void ClosePopupToLevel(int remaining, bool restore_focus_to_window_under_popup); IMGUI_API void ClosePopupsOverWindow(ImGuiWindow* ref_window, bool restore_focus_to_window_under_popup); IMGUI_API void ClosePopupsExceptModals(); IMGUI_API bool IsPopupOpen(ImGuiID id, ImGuiPopupFlags popup_flags); IMGUI_API ImRect GetPopupAllowedExtentRect(ImGuiWindow* window); IMGUI_API ImGuiWindow* GetTopMostPopupModal(); IMGUI_API ImGuiWindow* GetTopMostAndVisiblePopupModal(); IMGUI_API ImGuiWindow* FindBlockingModal(ImGuiWindow* window); IMGUI_API ImVec2 FindBestWindowPosForPopup(ImGuiWindow* window); IMGUI_API ImVec2 FindBestWindowPosForPopupEx(const ImVec2& ref_pos, const ImVec2& size, ImGuiDir* last_dir, const ImRect& r_outer, const ImRect& r_avoid, ImGuiPopupPositionPolicy policy); // Tooltips IMGUI_API bool BeginTooltipEx(ImGuiTooltipFlags tooltip_flags, ImGuiWindowFlags extra_window_flags); IMGUI_API bool BeginTooltipHidden(); // Menus IMGUI_API bool BeginViewportSideBar(const char* name, ImGuiViewport* viewport, ImGuiDir dir, float size, ImGuiWindowFlags window_flags); IMGUI_API bool BeginMenuEx(const char* label, const char* icon, bool enabled = true); IMGUI_API bool MenuItemEx(const char* label, const char* icon, const char* shortcut = NULL, bool selected = false, bool enabled = true); // Combos IMGUI_API bool BeginComboPopup(ImGuiID popup_id, const ImRect& bb, ImGuiComboFlags flags); IMGUI_API bool BeginComboPreview(); IMGUI_API void EndComboPreview(); // Keyboard/Gamepad Navigation IMGUI_API void NavInitWindow(ImGuiWindow* window, bool force_reinit); IMGUI_API void NavInitRequestApplyResult(); IMGUI_API bool NavMoveRequestButNoResultYet(); IMGUI_API void NavMoveRequestSubmit(ImGuiDir move_dir, ImGuiDir clip_dir, ImGuiNavMoveFlags move_flags, ImGuiScrollFlags scroll_flags); IMGUI_API void NavMoveRequestForward(ImGuiDir move_dir, ImGuiDir clip_dir, ImGuiNavMoveFlags move_flags, ImGuiScrollFlags scroll_flags); IMGUI_API void NavMoveRequestResolveWithLastItem(ImGuiNavItemData* result); IMGUI_API void NavMoveRequestResolveWithPastTreeNode(ImGuiNavItemData* result, ImGuiTreeNodeStackData* tree_node_data); IMGUI_API void NavMoveRequestCancel(); IMGUI_API void NavMoveRequestApplyResult(); IMGUI_API void NavMoveRequestTryWrapping(ImGuiWindow* window, ImGuiNavMoveFlags move_flags); IMGUI_API void NavHighlightActivated(ImGuiID id); IMGUI_API void NavClearPreferredPosForAxis(ImGuiAxis axis); IMGUI_API void SetNavCursorVisibleAfterMove(); IMGUI_API void NavUpdateCurrentWindowIsScrollPushableX(); IMGUI_API void SetNavWindow(ImGuiWindow* window); IMGUI_API void SetNavID(ImGuiID id, ImGuiNavLayer nav_layer, ImGuiID focus_scope_id, const ImRect& rect_rel); IMGUI_API void SetNavFocusScope(ImGuiID focus_scope_id); // Focus/Activation // This should be part of a larger set of API: FocusItem(offset = -1), FocusItemByID(id), ActivateItem(offset = -1), ActivateItemByID(id) etc. which are // much harder to design and implement than expected. I have a couple of private branches on this matter but it's not simple. For now implementing the easy ones. IMGUI_API void FocusItem(); // Focus last item (no selection/activation). IMGUI_API void ActivateItemByID(ImGuiID id); // Activate an item by ID (button, checkbox, tree node etc.). Activation is queued and processed on the next frame when the item is encountered again. // Inputs // FIXME: Eventually we should aim to move e.g. IsActiveIdUsingKey() into IsKeyXXX functions. inline bool IsNamedKey(ImGuiKey key) { return key >= ImGuiKey_NamedKey_BEGIN && key < ImGuiKey_NamedKey_END; } inline bool IsNamedKeyOrMod(ImGuiKey key) { return (key >= ImGuiKey_NamedKey_BEGIN && key < ImGuiKey_NamedKey_END) || key == ImGuiMod_Ctrl || key == ImGuiMod_Shift || key == ImGuiMod_Alt || key == ImGuiMod_Super; } inline bool IsLegacyKey(ImGuiKey key) { return key >= ImGuiKey_LegacyNativeKey_BEGIN && key < ImGuiKey_LegacyNativeKey_END; } inline bool IsKeyboardKey(ImGuiKey key) { return key >= ImGuiKey_Keyboard_BEGIN && key < ImGuiKey_Keyboard_END; } inline bool IsGamepadKey(ImGuiKey key) { return key >= ImGuiKey_Gamepad_BEGIN && key < ImGuiKey_Gamepad_END; } inline bool IsMouseKey(ImGuiKey key) { return key >= ImGuiKey_Mouse_BEGIN && key < ImGuiKey_Mouse_END; } inline bool IsAliasKey(ImGuiKey key) { return key >= ImGuiKey_Aliases_BEGIN && key < ImGuiKey_Aliases_END; } inline bool IsLRModKey(ImGuiKey key) { return key >= ImGuiKey_LeftCtrl && key <= ImGuiKey_RightSuper; } ImGuiKeyChord FixupKeyChord(ImGuiKeyChord key_chord); inline ImGuiKey ConvertSingleModFlagToKey(ImGuiKey key) { if (key == ImGuiMod_Ctrl) return ImGuiKey_ReservedForModCtrl; if (key == ImGuiMod_Shift) return ImGuiKey_ReservedForModShift; if (key == ImGuiMod_Alt) return ImGuiKey_ReservedForModAlt; if (key == ImGuiMod_Super) return ImGuiKey_ReservedForModSuper; return key; } IMGUI_API ImGuiKeyData* GetKeyData(ImGuiContext* ctx, ImGuiKey key); inline ImGuiKeyData* GetKeyData(ImGuiKey key) { ImGuiContext& g = *GImGui; return GetKeyData(&g, key); } IMGUI_API const char* GetKeyChordName(ImGuiKeyChord key_chord); inline ImGuiKey MouseButtonToKey(ImGuiMouseButton button) { IM_ASSERT(button >= 0 && button < ImGuiMouseButton_COUNT); return (ImGuiKey)(ImGuiKey_MouseLeft + button); } IMGUI_API bool IsMouseDragPastThreshold(ImGuiMouseButton button, float lock_threshold = -1.0f); IMGUI_API ImVec2 GetKeyMagnitude2d(ImGuiKey key_left, ImGuiKey key_right, ImGuiKey key_up, ImGuiKey key_down); IMGUI_API float GetNavTweakPressedAmount(ImGuiAxis axis); IMGUI_API int CalcTypematicRepeatAmount(float t0, float t1, float repeat_delay, float repeat_rate); IMGUI_API void GetTypematicRepeatRate(ImGuiInputFlags flags, float* repeat_delay, float* repeat_rate); IMGUI_API void TeleportMousePos(const ImVec2& pos); IMGUI_API void SetActiveIdUsingAllKeyboardKeys(); inline bool IsActiveIdUsingNavDir(ImGuiDir dir) { ImGuiContext& g = *GImGui; return (g.ActiveIdUsingNavDirMask & (1 << dir)) != 0; } // [EXPERIMENTAL] Low-Level: Key/Input Ownership // - The idea is that instead of "eating" a given input, we can link to an owner id. // - Ownership is most often claimed as a result of reacting to a press/down event (but occasionally may be claimed ahead). // - Input queries can then read input by specifying ImGuiKeyOwner_Any (== 0), ImGuiKeyOwner_NoOwner (== -1) or a custom ID. // - Legacy input queries (without specifying an owner or _Any or _None) are equivalent to using ImGuiKeyOwner_Any (== 0). // - Input ownership is automatically released on the frame after a key is released. Therefore: // - for ownership registration happening as a result of a down/press event, the SetKeyOwner() call may be done once (common case). // - for ownership registration happening ahead of a down/press event, the SetKeyOwner() call needs to be made every frame (happens if e.g. claiming ownership on hover). // - SetItemKeyOwner() is a shortcut for common simple case. A custom widget will probably want to call SetKeyOwner() multiple times directly based on its interaction state. // - This is marked experimental because not all widgets are fully honoring the Set/Test idioms. We will need to move forward step by step. // Please open a GitHub Issue to submit your usage scenario or if there's a use case you need solved. IMGUI_API ImGuiID GetKeyOwner(ImGuiKey key); IMGUI_API void SetKeyOwner(ImGuiKey key, ImGuiID owner_id, ImGuiInputFlags flags = 0); IMGUI_API void SetKeyOwnersForKeyChord(ImGuiKeyChord key, ImGuiID owner_id, ImGuiInputFlags flags = 0); IMGUI_API void SetItemKeyOwner(ImGuiKey key, ImGuiInputFlags flags); // Set key owner to last item if it is hovered or active. Equivalent to 'if (IsItemHovered() || IsItemActive()) { SetKeyOwner(key, GetItemID());'. IMGUI_API bool TestKeyOwner(ImGuiKey key, ImGuiID owner_id); // Test that key is either not owned, either owned by 'owner_id' inline ImGuiKeyOwnerData* GetKeyOwnerData(ImGuiContext* ctx, ImGuiKey key) { if (key & ImGuiMod_Mask_) key = ConvertSingleModFlagToKey(key); IM_ASSERT(IsNamedKey(key)); return &ctx->KeysOwnerData[key - ImGuiKey_NamedKey_BEGIN]; } // [EXPERIMENTAL] High-Level: Input Access functions w/ support for Key/Input Ownership // - Important: legacy IsKeyPressed(ImGuiKey, bool repeat=true) _DEFAULTS_ to repeat, new IsKeyPressed() requires _EXPLICIT_ ImGuiInputFlags_Repeat flag. // - Expected to be later promoted to public API, the prototypes are designed to replace existing ones (since owner_id can default to Any == 0) // - Specifying a value for 'ImGuiID owner' will test that EITHER the key is NOT owned (UNLESS locked), EITHER the key is owned by 'owner'. // Legacy functions use ImGuiKeyOwner_Any meaning that they typically ignore ownership, unless a call to SetKeyOwner() explicitly used ImGuiInputFlags_LockThisFrame or ImGuiInputFlags_LockUntilRelease. // - Binding generators may want to ignore those for now, or suffix them with Ex() until we decide if this gets moved into public API. IMGUI_API bool IsKeyDown(ImGuiKey key, ImGuiID owner_id); IMGUI_API bool IsKeyPressed(ImGuiKey key, ImGuiInputFlags flags, ImGuiID owner_id = 0); // Important: when transitioning from old to new IsKeyPressed(): old API has "bool repeat = true", so would default to repeat. New API requiress explicit ImGuiInputFlags_Repeat. IMGUI_API bool IsKeyReleased(ImGuiKey key, ImGuiID owner_id); IMGUI_API bool IsKeyChordPressed(ImGuiKeyChord key_chord, ImGuiInputFlags flags, ImGuiID owner_id = 0); IMGUI_API bool IsMouseDown(ImGuiMouseButton button, ImGuiID owner_id); IMGUI_API bool IsMouseClicked(ImGuiMouseButton button, ImGuiInputFlags flags, ImGuiID owner_id = 0); IMGUI_API bool IsMouseReleased(ImGuiMouseButton button, ImGuiID owner_id); IMGUI_API bool IsMouseDoubleClicked(ImGuiMouseButton button, ImGuiID owner_id); // Shortcut Testing & Routing // - Set Shortcut() and SetNextItemShortcut() in imgui.h // - When a policy (except for ImGuiInputFlags_RouteAlways *) is set, Shortcut() will register itself with SetShortcutRouting(), // allowing the system to decide where to route the input among other route-aware calls. // (* using ImGuiInputFlags_RouteAlways is roughly equivalent to calling IsKeyChordPressed(key) and bypassing route registration and check) // - When using one of the routing option: // - The default route is ImGuiInputFlags_RouteFocused (accept inputs if window is in focus stack. Deep-most focused window takes inputs. ActiveId takes inputs over deep-most focused window.) // - Routes are requested given a chord (key + modifiers) and a routing policy. // - Routes are resolved during NewFrame(): if keyboard modifiers are matching current ones: SetKeyOwner() is called + route is granted for the frame. // - Each route may be granted to a single owner. When multiple requests are made we have policies to select the winning route (e.g. deep most window). // - Multiple read sites may use the same owner id can all access the granted route. // - When owner_id is 0 we use the current Focus Scope ID as a owner ID in order to identify our location. // - You can chain two unrelated windows in the focus stack using SetWindowParentWindowForFocusRoute() // e.g. if you have a tool window associated to a document, and you want document shortcuts to run when the tool is focused. IMGUI_API bool Shortcut(ImGuiKeyChord key_chord, ImGuiInputFlags flags, ImGuiID owner_id); IMGUI_API bool SetShortcutRouting(ImGuiKeyChord key_chord, ImGuiInputFlags flags, ImGuiID owner_id); // owner_id needs to be explicit and cannot be 0 IMGUI_API bool TestShortcutRouting(ImGuiKeyChord key_chord, ImGuiID owner_id); IMGUI_API ImGuiKeyRoutingData* GetShortcutRoutingData(ImGuiKeyChord key_chord); // [EXPERIMENTAL] Focus Scope // This is generally used to identify a unique input location (for e.g. a selection set) // There is one per window (automatically set in Begin), but: // - Selection patterns generally need to react (e.g. clear a selection) when landing on one item of the set. // So in order to identify a set multiple lists in same window may each need a focus scope. // If you imagine an hypothetical BeginSelectionGroup()/EndSelectionGroup() api, it would likely call PushFocusScope()/EndFocusScope() // - Shortcut routing also use focus scope as a default location identifier if an owner is not provided. // We don't use the ID Stack for this as it is common to want them separate. IMGUI_API void PushFocusScope(ImGuiID id); IMGUI_API void PopFocusScope(); inline ImGuiID GetCurrentFocusScope() { ImGuiContext& g = *GImGui; return g.CurrentFocusScopeId; } // Focus scope we are outputting into, set by PushFocusScope() // Drag and Drop IMGUI_API bool IsDragDropActive(); IMGUI_API bool BeginDragDropTargetCustom(const ImRect& bb, ImGuiID id); IMGUI_API void ClearDragDrop(); IMGUI_API bool IsDragDropPayloadBeingAccepted(); IMGUI_API void RenderDragDropTargetRect(const ImRect& bb, const ImRect& item_clip_rect); // Typing-Select API // (provide Windows Explorer style "select items by typing partial name" + "cycle through items by typing same letter" feature) // (this is currently not documented nor used by main library, but should work. See "widgets_typingselect" in imgui_test_suite for usage code. Please let us know if you use this!) IMGUI_API ImGuiTypingSelectRequest* GetTypingSelectRequest(ImGuiTypingSelectFlags flags = ImGuiTypingSelectFlags_None); IMGUI_API int TypingSelectFindMatch(ImGuiTypingSelectRequest* req, int items_count, const char* (*get_item_name_func)(void*, int), void* user_data, int nav_item_idx); IMGUI_API int TypingSelectFindNextSingleCharMatch(ImGuiTypingSelectRequest* req, int items_count, const char* (*get_item_name_func)(void*, int), void* user_data, int nav_item_idx); IMGUI_API int TypingSelectFindBestLeadingMatch(ImGuiTypingSelectRequest* req, int items_count, const char* (*get_item_name_func)(void*, int), void* user_data); // Box-Select API IMGUI_API bool BeginBoxSelect(const ImRect& scope_rect, ImGuiWindow* window, ImGuiID box_select_id, ImGuiMultiSelectFlags ms_flags); IMGUI_API void EndBoxSelect(const ImRect& scope_rect, ImGuiMultiSelectFlags ms_flags); // Multi-Select API IMGUI_API void MultiSelectItemHeader(ImGuiID id, bool* p_selected, ImGuiButtonFlags* p_button_flags); IMGUI_API void MultiSelectItemFooter(ImGuiID id, bool* p_selected, bool* p_pressed); IMGUI_API void MultiSelectAddSetAll(ImGuiMultiSelectTempData* ms, bool selected); IMGUI_API void MultiSelectAddSetRange(ImGuiMultiSelectTempData* ms, bool selected, int range_dir, ImGuiSelectionUserData first_item, ImGuiSelectionUserData last_item); inline ImGuiBoxSelectState* GetBoxSelectState(ImGuiID id) { ImGuiContext& g = *GImGui; return (id != 0 && g.BoxSelectState.ID == id && g.BoxSelectState.IsActive) ? &g.BoxSelectState : NULL; } inline ImGuiMultiSelectState* GetMultiSelectState(ImGuiID id) { ImGuiContext& g = *GImGui; return g.MultiSelectStorage.GetByKey(id); } // Internal Columns API (this is not exposed because we will encourage transitioning to the Tables API) IMGUI_API void SetWindowClipRectBeforeSetChannel(ImGuiWindow* window, const ImRect& clip_rect); IMGUI_API void BeginColumns(const char* str_id, int count, ImGuiOldColumnFlags flags = 0); // setup number of columns. use an identifier to distinguish multiple column sets. close with EndColumns(). IMGUI_API void EndColumns(); // close columns IMGUI_API void PushColumnClipRect(int column_index); IMGUI_API void PushColumnsBackground(); IMGUI_API void PopColumnsBackground(); IMGUI_API ImGuiID GetColumnsID(const char* str_id, int count); IMGUI_API ImGuiOldColumns* FindOrCreateColumns(ImGuiWindow* window, ImGuiID id); IMGUI_API float GetColumnOffsetFromNorm(const ImGuiOldColumns* columns, float offset_norm); IMGUI_API float GetColumnNormFromOffset(const ImGuiOldColumns* columns, float offset); // Tables: Candidates for public API IMGUI_API void TableOpenContextMenu(int column_n = -1); IMGUI_API void TableSetColumnWidth(int column_n, float width); IMGUI_API void TableSetColumnSortDirection(int column_n, ImGuiSortDirection sort_direction, bool append_to_sort_specs); IMGUI_API int TableGetHoveredRow(); // Retrieve *PREVIOUS FRAME* hovered row. This difference with TableGetHoveredColumn() is the reason why this is not public yet. IMGUI_API float TableGetHeaderRowHeight(); IMGUI_API float TableGetHeaderAngledMaxLabelWidth(); IMGUI_API void TablePushBackgroundChannel(); IMGUI_API void TablePopBackgroundChannel(); IMGUI_API void TableAngledHeadersRowEx(ImGuiID row_id, float angle, float max_label_width, const ImGuiTableHeaderData* data, int data_count); // Tables: Internals inline ImGuiTable* GetCurrentTable() { ImGuiContext& g = *GImGui; return g.CurrentTable; } IMGUI_API ImGuiTable* TableFindByID(ImGuiID id); IMGUI_API bool BeginTableEx(const char* name, ImGuiID id, int columns_count, ImGuiTableFlags flags = 0, const ImVec2& outer_size = ImVec2(0, 0), float inner_width = 0.0f); IMGUI_API void TableBeginInitMemory(ImGuiTable* table, int columns_count); IMGUI_API void TableBeginApplyRequests(ImGuiTable* table); IMGUI_API void TableSetupDrawChannels(ImGuiTable* table); IMGUI_API void TableUpdateLayout(ImGuiTable* table); IMGUI_API void TableUpdateBorders(ImGuiTable* table); IMGUI_API void TableUpdateColumnsWeightFromWidth(ImGuiTable* table); IMGUI_API void TableDrawBorders(ImGuiTable* table); IMGUI_API void TableDrawDefaultContextMenu(ImGuiTable* table, ImGuiTableFlags flags_for_section_to_display); IMGUI_API bool TableBeginContextMenuPopup(ImGuiTable* table); IMGUI_API void TableMergeDrawChannels(ImGuiTable* table); inline ImGuiTableInstanceData* TableGetInstanceData(ImGuiTable* table, int instance_no) { if (instance_no == 0) return &table->InstanceDataFirst; return &table->InstanceDataExtra[instance_no - 1]; } inline ImGuiID TableGetInstanceID(ImGuiTable* table, int instance_no) { return TableGetInstanceData(table, instance_no)->TableInstanceID; } IMGUI_API void TableSortSpecsSanitize(ImGuiTable* table); IMGUI_API void TableSortSpecsBuild(ImGuiTable* table); IMGUI_API ImGuiSortDirection TableGetColumnNextSortDirection(ImGuiTableColumn* column); IMGUI_API void TableFixColumnSortDirection(ImGuiTable* table, ImGuiTableColumn* column); IMGUI_API float TableGetColumnWidthAuto(ImGuiTable* table, ImGuiTableColumn* column); IMGUI_API void TableBeginRow(ImGuiTable* table); IMGUI_API void TableEndRow(ImGuiTable* table); IMGUI_API void TableBeginCell(ImGuiTable* table, int column_n); IMGUI_API void TableEndCell(ImGuiTable* table); IMGUI_API ImRect TableGetCellBgRect(const ImGuiTable* table, int column_n); IMGUI_API const char* TableGetColumnName(const ImGuiTable* table, int column_n); IMGUI_API ImGuiID TableGetColumnResizeID(ImGuiTable* table, int column_n, int instance_no = 0); IMGUI_API float TableCalcMaxColumnWidth(const ImGuiTable* table, int column_n); IMGUI_API void TableSetColumnWidthAutoSingle(ImGuiTable* table, int column_n); IMGUI_API void TableSetColumnWidthAutoAll(ImGuiTable* table); IMGUI_API void TableRemove(ImGuiTable* table); IMGUI_API void TableGcCompactTransientBuffers(ImGuiTable* table); IMGUI_API void TableGcCompactTransientBuffers(ImGuiTableTempData* table); IMGUI_API void TableGcCompactSettings(); // Tables: Settings IMGUI_API void TableLoadSettings(ImGuiTable* table); IMGUI_API void TableSaveSettings(ImGuiTable* table); IMGUI_API void TableResetSettings(ImGuiTable* table); IMGUI_API ImGuiTableSettings* TableGetBoundSettings(ImGuiTable* table); IMGUI_API void TableSettingsAddSettingsHandler(); IMGUI_API ImGuiTableSettings* TableSettingsCreate(ImGuiID id, int columns_count); IMGUI_API ImGuiTableSettings* TableSettingsFindByID(ImGuiID id); // Tab Bars inline ImGuiTabBar* GetCurrentTabBar() { ImGuiContext& g = *GImGui; return g.CurrentTabBar; } IMGUI_API bool BeginTabBarEx(ImGuiTabBar* tab_bar, const ImRect& bb, ImGuiTabBarFlags flags); IMGUI_API ImGuiTabItem* TabBarFindTabByID(ImGuiTabBar* tab_bar, ImGuiID tab_id); IMGUI_API ImGuiTabItem* TabBarFindTabByOrder(ImGuiTabBar* tab_bar, int order); IMGUI_API ImGuiTabItem* TabBarGetCurrentTab(ImGuiTabBar* tab_bar); inline int TabBarGetTabOrder(ImGuiTabBar* tab_bar, ImGuiTabItem* tab) { return tab_bar->Tabs.index_from_ptr(tab); } IMGUI_API const char* TabBarGetTabName(ImGuiTabBar* tab_bar, ImGuiTabItem* tab); IMGUI_API void TabBarRemoveTab(ImGuiTabBar* tab_bar, ImGuiID tab_id); IMGUI_API void TabBarCloseTab(ImGuiTabBar* tab_bar, ImGuiTabItem* tab); IMGUI_API void TabBarQueueFocus(ImGuiTabBar* tab_bar, ImGuiTabItem* tab); IMGUI_API void TabBarQueueFocus(ImGuiTabBar* tab_bar, const char* tab_name); IMGUI_API void TabBarQueueReorder(ImGuiTabBar* tab_bar, ImGuiTabItem* tab, int offset); IMGUI_API void TabBarQueueReorderFromMousePos(ImGuiTabBar* tab_bar, ImGuiTabItem* tab, ImVec2 mouse_pos); IMGUI_API bool TabBarProcessReorder(ImGuiTabBar* tab_bar); IMGUI_API bool TabItemEx(ImGuiTabBar* tab_bar, const char* label, bool* p_open, ImGuiTabItemFlags flags, ImGuiWindow* docked_window); IMGUI_API void TabItemSpacing(const char* str_id, ImGuiTabItemFlags flags, float width); IMGUI_API ImVec2 TabItemCalcSize(const char* label, bool has_close_button_or_unsaved_marker); IMGUI_API ImVec2 TabItemCalcSize(ImGuiWindow* window); IMGUI_API void TabItemBackground(ImDrawList* draw_list, const ImRect& bb, ImGuiTabItemFlags flags, ImU32 col); IMGUI_API void TabItemLabelAndCloseButton(ImDrawList* draw_list, const ImRect& bb, ImGuiTabItemFlags flags, ImVec2 frame_padding, const char* label, ImGuiID tab_id, ImGuiID close_button_id, bool is_contents_visible, bool* out_just_closed, bool* out_text_clipped); // Render helpers // AVOID USING OUTSIDE OF IMGUI.CPP! NOT FOR PUBLIC CONSUMPTION. THOSE FUNCTIONS ARE A MESS. THEIR SIGNATURE AND BEHAVIOR WILL CHANGE, THEY NEED TO BE REFACTORED INTO SOMETHING DECENT. // NB: All position are in absolute pixels coordinates (we are never using window coordinates internally) IMGUI_API void RenderText(ImVec2 pos, const char* text, const char* text_end = NULL, bool hide_text_after_hash = true); IMGUI_API void RenderTextWrapped(ImVec2 pos, const char* text, const char* text_end, float wrap_width); IMGUI_API void RenderTextClipped(const ImVec2& pos_min, const ImVec2& pos_max, const char* text, const char* text_end, const ImVec2* text_size_if_known, const ImVec2& align = ImVec2(0, 0), const ImRect* clip_rect = NULL); IMGUI_API void RenderTextClippedEx(ImDrawList* draw_list, const ImVec2& pos_min, const ImVec2& pos_max, const char* text, const char* text_end, const ImVec2* text_size_if_known, const ImVec2& align = ImVec2(0, 0), const ImRect* clip_rect = NULL); IMGUI_API void RenderTextEllipsis(ImDrawList* draw_list, const ImVec2& pos_min, const ImVec2& pos_max, float clip_max_x, float ellipsis_max_x, const char* text, const char* text_end, const ImVec2* text_size_if_known); IMGUI_API void RenderFrame(ImVec2 p_min, ImVec2 p_max, ImU32 fill_col, bool borders = true, float rounding = 0.0f); IMGUI_API void RenderFrameBorder(ImVec2 p_min, ImVec2 p_max, float rounding = 0.0f); IMGUI_API void RenderColorRectWithAlphaCheckerboard(ImDrawList* draw_list, ImVec2 p_min, ImVec2 p_max, ImU32 fill_col, float grid_step, ImVec2 grid_off, float rounding = 0.0f, ImDrawFlags flags = 0); IMGUI_API void RenderNavCursor(const ImRect& bb, ImGuiID id, ImGuiNavRenderCursorFlags flags = ImGuiNavRenderCursorFlags_None); // Navigation highlight #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS inline void RenderNavHighlight(const ImRect& bb, ImGuiID id, ImGuiNavRenderCursorFlags flags = ImGuiNavRenderCursorFlags_None) { RenderNavCursor(bb, id, flags); } // Renamed in 1.91.4 #endif IMGUI_API const char* FindRenderedTextEnd(const char* text, const char* text_end = NULL); // Find the optional ## from which we stop displaying text. IMGUI_API void RenderMouseCursor(ImVec2 pos, float scale, ImGuiMouseCursor mouse_cursor, ImU32 col_fill, ImU32 col_border, ImU32 col_shadow); // Render helpers (those functions don't access any ImGui state!) IMGUI_API void RenderArrow(ImDrawList* draw_list, ImVec2 pos, ImU32 col, ImGuiDir dir, float scale = 1.0f); IMGUI_API void RenderBullet(ImDrawList* draw_list, ImVec2 pos, ImU32 col); IMGUI_API void RenderCheckMark(ImDrawList* draw_list, ImVec2 pos, ImU32 col, float sz); IMGUI_API void RenderArrowPointingAt(ImDrawList* draw_list, ImVec2 pos, ImVec2 half_sz, ImGuiDir direction, ImU32 col); IMGUI_API void RenderRectFilledRangeH(ImDrawList* draw_list, const ImRect& rect, ImU32 col, float x_start_norm, float x_end_norm, float rounding); IMGUI_API void RenderRectFilledWithHole(ImDrawList* draw_list, const ImRect& outer, const ImRect& inner, ImU32 col, float rounding); // Widgets IMGUI_API void TextEx(const char* text, const char* text_end = NULL, ImGuiTextFlags flags = 0); IMGUI_API bool ButtonEx(const char* label, const ImVec2& size_arg = ImVec2(0, 0), ImGuiButtonFlags flags = 0); IMGUI_API bool ArrowButtonEx(const char* str_id, ImGuiDir dir, ImVec2 size_arg, ImGuiButtonFlags flags = 0); IMGUI_API bool ImageButtonEx(ImGuiID id, ImTextureID user_texture_id, const ImVec2& image_size, const ImVec2& uv0, const ImVec2& uv1, const ImVec4& bg_col, const ImVec4& tint_col, ImGuiButtonFlags flags = 0); IMGUI_API void SeparatorEx(ImGuiSeparatorFlags flags, float thickness = 1.0f); IMGUI_API void SeparatorTextEx(ImGuiID id, const char* label, const char* label_end, float extra_width); IMGUI_API bool CheckboxFlags(const char* label, ImS64* flags, ImS64 flags_value); IMGUI_API bool CheckboxFlags(const char* label, ImU64* flags, ImU64 flags_value); // Widgets: Window Decorations IMGUI_API bool CloseButton(ImGuiID id, const ImVec2& pos); IMGUI_API bool CollapseButton(ImGuiID id, const ImVec2& pos); IMGUI_API void Scrollbar(ImGuiAxis axis); IMGUI_API bool ScrollbarEx(const ImRect& bb, ImGuiID id, ImGuiAxis axis, ImS64* p_scroll_v, ImS64 avail_v, ImS64 contents_v, ImDrawFlags draw_rounding_flags = 0); IMGUI_API ImRect GetWindowScrollbarRect(ImGuiWindow* window, ImGuiAxis axis); IMGUI_API ImGuiID GetWindowScrollbarID(ImGuiWindow* window, ImGuiAxis axis); IMGUI_API ImGuiID GetWindowResizeCornerID(ImGuiWindow* window, int n); // 0..3: corners IMGUI_API ImGuiID GetWindowResizeBorderID(ImGuiWindow* window, ImGuiDir dir); // Widgets low-level behaviors IMGUI_API bool ButtonBehavior(const ImRect& bb, ImGuiID id, bool* out_hovered, bool* out_held, ImGuiButtonFlags flags = 0); IMGUI_API bool DragBehavior(ImGuiID id, ImGuiDataType data_type, void* p_v, float v_speed, const void* p_min, const void* p_max, const char* format, ImGuiSliderFlags flags); IMGUI_API bool SliderBehavior(const ImRect& bb, ImGuiID id, ImGuiDataType data_type, void* p_v, const void* p_min, const void* p_max, const char* format, ImGuiSliderFlags flags, ImRect* out_grab_bb); IMGUI_API bool SplitterBehavior(const ImRect& bb, ImGuiID id, ImGuiAxis axis, float* size1, float* size2, float min_size1, float min_size2, float hover_extend = 0.0f, float hover_visibility_delay = 0.0f, ImU32 bg_col = 0); // Widgets: Tree Nodes IMGUI_API bool TreeNodeBehavior(ImGuiID id, ImGuiTreeNodeFlags flags, const char* label, const char* label_end = NULL); IMGUI_API void TreePushOverrideID(ImGuiID id); IMGUI_API bool TreeNodeGetOpen(ImGuiID storage_id); IMGUI_API void TreeNodeSetOpen(ImGuiID storage_id, bool open); IMGUI_API bool TreeNodeUpdateNextOpen(ImGuiID storage_id, ImGuiTreeNodeFlags flags); // Return open state. Consume previous SetNextItemOpen() data, if any. May return true when logging. // Template functions are instantiated in imgui_widgets.cpp for a finite number of types. // To use them externally (for custom widget) you may need an "extern template" statement in your code in order to link to existing instances and silence Clang warnings (see #2036). // e.g. " extern template IMGUI_API float RoundScalarWithFormatT(const char* format, ImGuiDataType data_type, float v); " template IMGUI_API float ScaleRatioFromValueT(ImGuiDataType data_type, T v, T v_min, T v_max, bool is_logarithmic, float logarithmic_zero_epsilon, float zero_deadzone_size); template IMGUI_API T ScaleValueFromRatioT(ImGuiDataType data_type, float t, T v_min, T v_max, bool is_logarithmic, float logarithmic_zero_epsilon, float zero_deadzone_size); template IMGUI_API bool DragBehaviorT(ImGuiDataType data_type, T* v, float v_speed, T v_min, T v_max, const char* format, ImGuiSliderFlags flags); template IMGUI_API bool SliderBehaviorT(const ImRect& bb, ImGuiID id, ImGuiDataType data_type, T* v, T v_min, T v_max, const char* format, ImGuiSliderFlags flags, ImRect* out_grab_bb); template IMGUI_API T RoundScalarWithFormatT(const char* format, ImGuiDataType data_type, T v); template IMGUI_API bool CheckboxFlagsT(const char* label, T* flags, T flags_value); // Data type helpers IMGUI_API const ImGuiDataTypeInfo* DataTypeGetInfo(ImGuiDataType data_type); IMGUI_API int DataTypeFormatString(char* buf, int buf_size, ImGuiDataType data_type, const void* p_data, const char* format); IMGUI_API void DataTypeApplyOp(ImGuiDataType data_type, int op, void* output, const void* arg_1, const void* arg_2); IMGUI_API bool DataTypeApplyFromText(const char* buf, ImGuiDataType data_type, void* p_data, const char* format, void* p_data_when_empty = NULL); IMGUI_API int DataTypeCompare(ImGuiDataType data_type, const void* arg_1, const void* arg_2); IMGUI_API bool DataTypeClamp(ImGuiDataType data_type, void* p_data, const void* p_min, const void* p_max); IMGUI_API bool DataTypeIsZero(ImGuiDataType data_type, const void* p_data); // InputText IMGUI_API bool InputTextEx(const char* label, const char* hint, char* buf, int buf_size, const ImVec2& size_arg, ImGuiInputTextFlags flags, ImGuiInputTextCallback callback = NULL, void* user_data = NULL); IMGUI_API void InputTextDeactivateHook(ImGuiID id); IMGUI_API bool TempInputText(const ImRect& bb, ImGuiID id, const char* label, char* buf, int buf_size, ImGuiInputTextFlags flags); IMGUI_API bool TempInputScalar(const ImRect& bb, ImGuiID id, const char* label, ImGuiDataType data_type, void* p_data, const char* format, const void* p_clamp_min = NULL, const void* p_clamp_max = NULL); inline bool TempInputIsActive(ImGuiID id) { ImGuiContext& g = *GImGui; return (g.ActiveId == id && g.TempInputId == id); } inline ImGuiInputTextState* GetInputTextState(ImGuiID id) { ImGuiContext& g = *GImGui; return (id != 0 && g.InputTextState.ID == id) ? &g.InputTextState : NULL; } // Get input text state if active IMGUI_API void SetNextItemRefVal(ImGuiDataType data_type, void* p_data); inline bool IsItemActiveAsInputText() { ImGuiContext& g = *GImGui; return g.ActiveId != 0 && g.ActiveId == g.LastItemData.ID && g.InputTextState.ID == g.LastItemData.ID; } // This may be useful to apply workaround that a based on distinguish whenever an item is active as a text input field. // Color IMGUI_API void ColorTooltip(const char* text, const float* col, ImGuiColorEditFlags flags); IMGUI_API void ColorEditOptionsPopup(const float* col, ImGuiColorEditFlags flags); IMGUI_API void ColorPickerOptionsPopup(const float* ref_col, ImGuiColorEditFlags flags); // Plot IMGUI_API int PlotEx(ImGuiPlotType plot_type, const char* label, float (*values_getter)(void* data, int idx), void* data, int values_count, int values_offset, const char* overlay_text, float scale_min, float scale_max, const ImVec2& size_arg); // Shade functions (write over already created vertices) IMGUI_API void ShadeVertsLinearColorGradientKeepAlpha(ImDrawList* draw_list, int vert_start_idx, int vert_end_idx, ImVec2 gradient_p0, ImVec2 gradient_p1, ImU32 col0, ImU32 col1); IMGUI_API void ShadeVertsLinearUV(ImDrawList* draw_list, int vert_start_idx, int vert_end_idx, const ImVec2& a, const ImVec2& b, const ImVec2& uv_a, const ImVec2& uv_b, bool clamp); IMGUI_API void ShadeVertsTransformPos(ImDrawList* draw_list, int vert_start_idx, int vert_end_idx, const ImVec2& pivot_in, float cos_a, float sin_a, const ImVec2& pivot_out); // Garbage collection IMGUI_API void GcCompactTransientMiscBuffers(); IMGUI_API void GcCompactTransientWindowBuffers(ImGuiWindow* window); IMGUI_API void GcAwakeTransientWindowBuffers(ImGuiWindow* window); // Error handling, State Recovery IMGUI_API bool ErrorLog(const char* msg); IMGUI_API void ErrorRecoveryStoreState(ImGuiErrorRecoveryState* state_out); IMGUI_API void ErrorRecoveryTryToRecoverState(const ImGuiErrorRecoveryState* state_in); IMGUI_API void ErrorRecoveryTryToRecoverWindowState(const ImGuiErrorRecoveryState* state_in); IMGUI_API void ErrorCheckUsingSetCursorPosToExtendParentBoundaries(); IMGUI_API void ErrorCheckEndFrameFinalizeErrorTooltip(); IMGUI_API bool BeginErrorTooltip(); IMGUI_API void EndErrorTooltip(); // Debug Tools IMGUI_API void DebugAllocHook(ImGuiDebugAllocInfo* info, int frame_count, void* ptr, size_t size); // size >= 0 : alloc, size = -1 : free IMGUI_API void DebugDrawCursorPos(ImU32 col = IM_COL32(255, 0, 0, 255)); IMGUI_API void DebugDrawLineExtents(ImU32 col = IM_COL32(255, 0, 0, 255)); IMGUI_API void DebugDrawItemRect(ImU32 col = IM_COL32(255, 0, 0, 255)); IMGUI_API void DebugTextUnformattedWithLocateItem(const char* line_begin, const char* line_end); IMGUI_API void DebugLocateItem(ImGuiID target_id); // Call sparingly: only 1 at the same time! IMGUI_API void DebugLocateItemOnHover(ImGuiID target_id); // Only call on reaction to a mouse Hover: because only 1 at the same time! IMGUI_API void DebugLocateItemResolveWithLastItem(); IMGUI_API void DebugBreakClearData(); IMGUI_API bool DebugBreakButton(const char* label, const char* description_of_location); IMGUI_API void DebugBreakButtonTooltip(bool keyboard_only, const char* description_of_location); IMGUI_API void ShowFontAtlas(ImFontAtlas* atlas); IMGUI_API void DebugHookIdInfo(ImGuiID id, ImGuiDataType data_type, const void* data_id, const void* data_id_end); IMGUI_API void DebugNodeColumns(ImGuiOldColumns* columns); IMGUI_API void DebugNodeDrawList(ImGuiWindow* window, ImGuiViewportP* viewport, const ImDrawList* draw_list, const char* label); IMGUI_API void DebugNodeDrawCmdShowMeshAndBoundingBox(ImDrawList* out_draw_list, const ImDrawList* draw_list, const ImDrawCmd* draw_cmd, bool show_mesh, bool show_aabb); IMGUI_API void DebugNodeFont(ImFont* font); IMGUI_API void DebugNodeFontGlyph(ImFont* font, const ImFontGlyph* glyph); IMGUI_API void DebugNodeStorage(ImGuiStorage* storage, const char* label); IMGUI_API void DebugNodeTabBar(ImGuiTabBar* tab_bar, const char* label); IMGUI_API void DebugNodeTable(ImGuiTable* table); IMGUI_API void DebugNodeTableSettings(ImGuiTableSettings* settings); IMGUI_API void DebugNodeInputTextState(ImGuiInputTextState* state); IMGUI_API void DebugNodeTypingSelectState(ImGuiTypingSelectState* state); IMGUI_API void DebugNodeMultiSelectState(ImGuiMultiSelectState* state); IMGUI_API void DebugNodeWindow(ImGuiWindow* window, const char* label); IMGUI_API void DebugNodeWindowSettings(ImGuiWindowSettings* settings); IMGUI_API void DebugNodeWindowsList(ImVector* windows, const char* label); IMGUI_API void DebugNodeWindowsListByBeginStackParent(ImGuiWindow** windows, int windows_size, ImGuiWindow* parent_in_begin_stack); IMGUI_API void DebugNodeViewport(ImGuiViewportP* viewport); IMGUI_API void DebugRenderKeyboardPreview(ImDrawList* draw_list); IMGUI_API void DebugRenderViewportThumbnail(ImDrawList* draw_list, ImGuiViewportP* viewport, const ImRect& bb); // Obsolete functions #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS //inline void SetItemUsingMouseWheel() { SetItemKeyOwner(ImGuiKey_MouseWheelY); } // Changed in 1.89 //inline bool TreeNodeBehaviorIsOpen(ImGuiID id, ImGuiTreeNodeFlags flags = 0) { return TreeNodeUpdateNextOpen(id, flags); } // Renamed in 1.89 //inline bool IsKeyPressedMap(ImGuiKey key, bool repeat = true) { IM_ASSERT(IsNamedKey(key)); return IsKeyPressed(key, repeat); } // Removed in 1.87: Mapping from named key is always identity! // Refactored focus/nav/tabbing system in 1.82 and 1.84. If you have old/custom copy-and-pasted widgets which used FocusableItemRegister(): // (Old) IMGUI_VERSION_NUM < 18209: using 'ItemAdd(....)' and 'bool tab_focused = FocusableItemRegister(...)' // (Old) IMGUI_VERSION_NUM >= 18209: using 'ItemAdd(..., ImGuiItemAddFlags_Focusable)' and 'bool tab_focused = (g.LastItemData.StatusFlags & ImGuiItemStatusFlags_Focused) != 0' // (New) IMGUI_VERSION_NUM >= 18413: using 'ItemAdd(..., ImGuiItemFlags_Inputable)' and 'bool tab_focused = (g.NavActivateId == id && (g.NavActivateFlags & ImGuiActivateFlags_PreferInput))' //inline bool FocusableItemRegister(ImGuiWindow* window, ImGuiID id) // -> pass ImGuiItemAddFlags_Inputable flag to ItemAdd() //inline void FocusableItemUnregister(ImGuiWindow* window) // -> unnecessary: TempInputText() uses ImGuiInputTextFlags_MergedItem #endif } // namespace ImGui //----------------------------------------------------------------------------- // [SECTION] ImFontAtlas internal API //----------------------------------------------------------------------------- // This structure is likely to evolve as we add support for incremental atlas updates. // Conceptually this could be in ImGuiPlatformIO, but we are far from ready to make this public. struct ImFontBuilderIO { bool (*FontBuilder_Build)(ImFontAtlas* atlas); }; // Helper for font builder #ifdef IMGUI_ENABLE_STB_TRUETYPE IMGUI_API const ImFontBuilderIO* ImFontAtlasGetBuilderForStbTruetype(); #endif IMGUI_API void ImFontAtlasUpdateSourcesPointers(ImFontAtlas* atlas); IMGUI_API void ImFontAtlasBuildInit(ImFontAtlas* atlas); IMGUI_API void ImFontAtlasBuildSetupFont(ImFontAtlas* atlas, ImFont* font, ImFontConfig* src, float ascent, float descent); IMGUI_API void ImFontAtlasBuildPackCustomRects(ImFontAtlas* atlas, void* stbrp_context_opaque); IMGUI_API void ImFontAtlasBuildFinish(ImFontAtlas* atlas); IMGUI_API void ImFontAtlasBuildRender8bppRectFromString(ImFontAtlas* atlas, int x, int y, int w, int h, const char* in_str, char in_marker_char, unsigned char in_marker_pixel_value); IMGUI_API void ImFontAtlasBuildRender32bppRectFromString(ImFontAtlas* atlas, int x, int y, int w, int h, const char* in_str, char in_marker_char, unsigned int in_marker_pixel_value); IMGUI_API void ImFontAtlasBuildMultiplyCalcLookupTable(unsigned char out_table[256], float in_multiply_factor); IMGUI_API void ImFontAtlasBuildMultiplyRectAlpha8(const unsigned char table[256], unsigned char* pixels, int x, int y, int w, int h, int stride); IMGUI_API void ImFontAtlasBuildGetOversampleFactors(const ImFontConfig* src, int* out_oversample_h, int* out_oversample_v); IMGUI_API bool ImFontAtlasGetMouseCursorTexData(ImFontAtlas* atlas, ImGuiMouseCursor cursor_type, ImVec2* out_offset, ImVec2* out_size, ImVec2 out_uv_border[2], ImVec2 out_uv_fill[2]); //----------------------------------------------------------------------------- // [SECTION] Test Engine specific hooks (imgui_test_engine) //----------------------------------------------------------------------------- #ifdef IMGUI_ENABLE_TEST_ENGINE extern void ImGuiTestEngineHook_ItemAdd(ImGuiContext* ctx, ImGuiID id, const ImRect& bb, const ImGuiLastItemData* item_data); // item_data may be NULL extern void ImGuiTestEngineHook_ItemInfo(ImGuiContext* ctx, ImGuiID id, const char* label, ImGuiItemStatusFlags flags); extern void ImGuiTestEngineHook_Log(ImGuiContext* ctx, const char* fmt, ...); extern const char* ImGuiTestEngine_FindItemDebugLabel(ImGuiContext* ctx, ImGuiID id); // In IMGUI_VERSION_NUM >= 18934: changed IMGUI_TEST_ENGINE_ITEM_ADD(bb,id) to IMGUI_TEST_ENGINE_ITEM_ADD(id,bb,item_data); #define IMGUI_TEST_ENGINE_ITEM_ADD(_ID,_BB,_ITEM_DATA) if (g.TestEngineHookItems) ImGuiTestEngineHook_ItemAdd(&g, _ID, _BB, _ITEM_DATA) // Register item bounding box #define IMGUI_TEST_ENGINE_ITEM_INFO(_ID,_LABEL,_FLAGS) if (g.TestEngineHookItems) ImGuiTestEngineHook_ItemInfo(&g, _ID, _LABEL, _FLAGS) // Register item label and status flags (optional) #define IMGUI_TEST_ENGINE_LOG(_FMT,...) ImGuiTestEngineHook_Log(&g, _FMT, __VA_ARGS__) // Custom log entry from user land into test log #else #define IMGUI_TEST_ENGINE_ITEM_ADD(_BB,_ID) ((void)0) #define IMGUI_TEST_ENGINE_ITEM_INFO(_ID,_LABEL,_FLAGS) ((void)g) #endif //----------------------------------------------------------------------------- #if defined(__clang__) #pragma clang diagnostic pop #elif defined(__GNUC__) #pragma GCC diagnostic pop #endif #ifdef _MSC_VER #pragma warning (pop) #endif #endif // #ifndef IMGUI_DISABLE ================================================ FILE: src/DesktopPlusUI/imgui/imgui_tables.cpp ================================================ // dear imgui, v1.91b // (tables and columns code) /* Index of this file: // [SECTION] Commentary // [SECTION] Header mess // [SECTION] Tables: Main code // [SECTION] Tables: Simple accessors // [SECTION] Tables: Row changes // [SECTION] Tables: Columns changes // [SECTION] Tables: Columns width management // [SECTION] Tables: Drawing // [SECTION] Tables: Sorting // [SECTION] Tables: Headers // [SECTION] Tables: Context Menu // [SECTION] Tables: Settings (.ini data) // [SECTION] Tables: Garbage Collection // [SECTION] Tables: Debugging // [SECTION] Columns, BeginColumns, EndColumns, etc. */ // Navigating this file: // - In Visual Studio: CTRL+comma ("Edit.GoToAll") can follow symbols inside comments, whereas CTRL+F12 ("Edit.GoToImplementation") cannot. // - In Visual Studio w/ Visual Assist installed: ALT+G ("VAssistX.GoToImplementation") can also follow symbols inside comments. // - In VS Code, CLion, etc.: CTRL+click can follow symbols inside comments. //----------------------------------------------------------------------------- // [SECTION] Commentary //----------------------------------------------------------------------------- //----------------------------------------------------------------------------- // Typical tables call flow: (root level is generally public API): //----------------------------------------------------------------------------- // - BeginTable() user begin into a table // | BeginChild() - (if ScrollX/ScrollY is set) // | TableBeginInitMemory() - first time table is used // | TableResetSettings() - on settings reset // | TableLoadSettings() - on settings load // | TableBeginApplyRequests() - apply queued resizing/reordering/hiding requests // | - TableSetColumnWidth() - apply resizing width (for mouse resize, often requested by previous frame) // | - TableUpdateColumnsWeightFromWidth()- recompute columns weights (of stretch columns) from their respective width // - TableSetupColumn() user submit columns details (optional) // - TableSetupScrollFreeze() user submit scroll freeze information (optional) //----------------------------------------------------------------------------- // - TableUpdateLayout() [Internal] followup to BeginTable(): setup everything: widths, columns positions, clipping rectangles. Automatically called by the FIRST call to TableNextRow() or TableHeadersRow(). // | TableSetupDrawChannels() - setup ImDrawList channels // | TableUpdateBorders() - detect hovering columns for resize, ahead of contents submission // | TableBeginContextMenuPopup() // | - TableDrawDefaultContextMenu() - draw right-click context menu contents //----------------------------------------------------------------------------- // - TableHeadersRow() or TableHeader() user submit a headers row (optional) // | TableSortSpecsClickColumn() - when left-clicked: alter sort order and sort direction // | TableOpenContextMenu() - when right-clicked: trigger opening of the default context menu // - TableGetSortSpecs() user queries updated sort specs (optional, generally after submitting headers) // - TableNextRow() user begin into a new row (also automatically called by TableHeadersRow()) // | TableEndRow() - finish existing row // | TableBeginRow() - add a new row // - TableSetColumnIndex() / TableNextColumn() user begin into a cell // | TableEndCell() - close existing column/cell // | TableBeginCell() - enter into current column/cell // - [...] user emit contents //----------------------------------------------------------------------------- // - EndTable() user ends the table // | TableDrawBorders() - draw outer borders, inner vertical borders // | TableMergeDrawChannels() - merge draw channels if clipping isn't required // | EndChild() - (if ScrollX/ScrollY is set) //----------------------------------------------------------------------------- //----------------------------------------------------------------------------- // TABLE SIZING //----------------------------------------------------------------------------- // (Read carefully because this is subtle but it does make sense!) //----------------------------------------------------------------------------- // About 'outer_size': // Its meaning needs to differ slightly depending on if we are using ScrollX/ScrollY flags. // Default value is ImVec2(0.0f, 0.0f). // X // - outer_size.x <= 0.0f -> Right-align from window/work-rect right-most edge. With -FLT_MIN or 0.0f will align exactly on right-most edge. // - outer_size.x > 0.0f -> Set Fixed width. // Y with ScrollX/ScrollY disabled: we output table directly in current window // - outer_size.y < 0.0f -> Bottom-align (but will auto extend, unless _NoHostExtendY is set). Not meaningful if parent window can vertically scroll. // - outer_size.y = 0.0f -> No minimum height (but will auto extend, unless _NoHostExtendY is set) // - outer_size.y > 0.0f -> Set Minimum height (but will auto extend, unless _NoHostExtendY is set) // Y with ScrollX/ScrollY enabled: using a child window for scrolling // - outer_size.y < 0.0f -> Bottom-align. Not meaningful if parent window can vertically scroll. // - outer_size.y = 0.0f -> Bottom-align, consistent with BeginChild(). Not recommended unless table is last item in parent window. // - outer_size.y > 0.0f -> Set Exact height. Recommended when using Scrolling on any axis. //----------------------------------------------------------------------------- // Outer size is also affected by the NoHostExtendX/NoHostExtendY flags. // Important to note how the two flags have slightly different behaviors! // - ImGuiTableFlags_NoHostExtendX -> Make outer width auto-fit to columns (overriding outer_size.x value). Only available when ScrollX/ScrollY are disabled and Stretch columns are not used. // - ImGuiTableFlags_NoHostExtendY -> Make outer height stop exactly at outer_size.y (prevent auto-extending table past the limit). Only available when ScrollX/ScrollY is disabled. Data below the limit will be clipped and not visible. // In theory ImGuiTableFlags_NoHostExtendY could be the default and any non-scrolling tables with outer_size.y != 0.0f would use exact height. // This would be consistent but perhaps less useful and more confusing (as vertically clipped items are not useful and not easily noticeable). //----------------------------------------------------------------------------- // About 'inner_width': // With ScrollX disabled: // - inner_width -> *ignored* // With ScrollX enabled: // - inner_width < 0.0f -> *illegal* fit in known width (right align from outer_size.x) <-- weird // - inner_width = 0.0f -> fit in outer_width: Fixed size columns will take space they need (if avail, otherwise shrink down), Stretch columns becomes Fixed columns. // - inner_width > 0.0f -> override scrolling width, generally to be larger than outer_size.x. Fixed column take space they need (if avail, otherwise shrink down), Stretch columns share remaining space! //----------------------------------------------------------------------------- // Details: // - If you want to use Stretch columns with ScrollX, you generally need to specify 'inner_width' otherwise the concept // of "available space" doesn't make sense. // - Even if not really useful, we allow 'inner_width < outer_size.x' for consistency and to facilitate understanding // of what the value does. //----------------------------------------------------------------------------- //----------------------------------------------------------------------------- // COLUMNS SIZING POLICIES // (Reference: ImGuiTableFlags_SizingXXX flags and ImGuiTableColumnFlags_WidthXXX flags) //----------------------------------------------------------------------------- // About overriding column sizing policy and width/weight with TableSetupColumn(): // We use a default parameter of -1 for 'init_width'/'init_weight'. // - with ImGuiTableColumnFlags_WidthFixed, init_width <= 0 (default) --> width is automatic // - with ImGuiTableColumnFlags_WidthFixed, init_width > 0 (explicit) --> width is custom // - with ImGuiTableColumnFlags_WidthStretch, init_weight <= 0 (default) --> weight is 1.0f // - with ImGuiTableColumnFlags_WidthStretch, init_weight > 0 (explicit) --> weight is custom // Widths are specified _without_ CellPadding. If you specify a width of 100.0f, the column will be cover (100.0f + Padding * 2.0f) // and you can fit a 100.0f wide item in it without clipping and with padding honored. //----------------------------------------------------------------------------- // About default sizing policy (if you don't specify a ImGuiTableColumnFlags_WidthXXXX flag) // - with Table policy ImGuiTableFlags_SizingFixedFit --> default Column policy is ImGuiTableColumnFlags_WidthFixed, default Width is equal to contents width // - with Table policy ImGuiTableFlags_SizingFixedSame --> default Column policy is ImGuiTableColumnFlags_WidthFixed, default Width is max of all contents width // - with Table policy ImGuiTableFlags_SizingStretchSame --> default Column policy is ImGuiTableColumnFlags_WidthStretch, default Weight is 1.0f // - with Table policy ImGuiTableFlags_SizingStretchWeight --> default Column policy is ImGuiTableColumnFlags_WidthStretch, default Weight is proportional to contents // Default Width and default Weight can be overridden when calling TableSetupColumn(). //----------------------------------------------------------------------------- // About mixing Fixed/Auto and Stretch columns together: // - the typical use of mixing sizing policies is: any number of LEADING Fixed columns, followed by one or two TRAILING Stretch columns. // - using mixed policies with ScrollX does not make much sense, as using Stretch columns with ScrollX does not make much sense in the first place! // that is, unless 'inner_width' is passed to BeginTable() to explicitly provide a total width to layout columns in. // - when using ImGuiTableFlags_SizingFixedSame with mixed columns, only the Fixed/Auto columns will match their widths to the width of the maximum contents. // - when using ImGuiTableFlags_SizingStretchSame with mixed columns, only the Stretch columns will match their weights/widths. //----------------------------------------------------------------------------- // About using column width: // If a column is manually resizable or has a width specified with TableSetupColumn(): // - you may use GetContentRegionAvail().x to query the width available in a given column. // - right-side alignment features such as SetNextItemWidth(-x) or PushItemWidth(-x) will rely on this width. // If the column is not resizable and has no width specified with TableSetupColumn(): // - its width will be automatic and be set to the max of items submitted. // - therefore you generally cannot have ALL items of the columns use e.g. SetNextItemWidth(-FLT_MIN). // - but if the column has one or more items of known/fixed size, this will become the reference width used by SetNextItemWidth(-FLT_MIN). //----------------------------------------------------------------------------- //----------------------------------------------------------------------------- // TABLES CLIPPING/CULLING //----------------------------------------------------------------------------- // About clipping/culling of Rows in Tables: // - For large numbers of rows, it is recommended you use ImGuiListClipper to submit only visible rows. // ImGuiListClipper is reliant on the fact that rows are of equal height. // See 'Demo->Tables->Vertical Scrolling' or 'Demo->Tables->Advanced' for a demo of using the clipper. // - Note that auto-resizing columns don't play well with using the clipper. // By default a table with _ScrollX but without _Resizable will have column auto-resize. // So, if you want to use the clipper, make sure to either enable _Resizable, either setup columns width explicitly with _WidthFixed. //----------------------------------------------------------------------------- // About clipping/culling of Columns in Tables: // - Both TableSetColumnIndex() and TableNextColumn() return true when the column is visible or performing // width measurements. Otherwise, you may skip submitting the contents of a cell/column, BUT ONLY if you know // it is not going to contribute to row height. // In many situations, you may skip submitting contents for every column but one (e.g. the first one). // - Case A: column is not hidden by user, and at least partially in sight (most common case). // - Case B: column is clipped / out of sight (because of scrolling or parent ClipRect): TableNextColumn() return false as a hint but we still allow layout output. // - Case C: column is hidden explicitly by the user (e.g. via the context menu, or _DefaultHide column flag, etc.). // // [A] [B] [C] // TableNextColumn(): true false false -> [userland] when TableNextColumn() / TableSetColumnIndex() returns false, user can skip submitting items but only if the column doesn't contribute to row height. // SkipItems: false false true -> [internal] when SkipItems is true, most widgets will early out if submitted, resulting is no layout output. // ClipRect: normal zero-width zero-width -> [internal] when ClipRect is zero, ItemAdd() will return false and most widgets will early out mid-way. // ImDrawList output: normal dummy dummy -> [internal] when using the dummy channel, ImDrawList submissions (if any) will be wasted (because cliprect is zero-width anyway). // // - We need to distinguish those cases because non-hidden columns that are clipped outside of scrolling bounds should still contribute their height to the row. // However, in the majority of cases, the contribution to row height is the same for all columns, or the tallest cells are known by the programmer. //----------------------------------------------------------------------------- // About clipping/culling of whole Tables: // - Scrolling tables with a known outer size can be clipped earlier as BeginTable() will return false. //----------------------------------------------------------------------------- //----------------------------------------------------------------------------- // [SECTION] Header mess //----------------------------------------------------------------------------- #if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_WARNINGS) #define _CRT_SECURE_NO_WARNINGS #endif #ifndef IMGUI_DEFINE_MATH_OPERATORS #define IMGUI_DEFINE_MATH_OPERATORS #endif #include "imgui.h" #ifndef IMGUI_DISABLE #include "imgui_internal.h" // System includes #include // intptr_t // Visual Studio warnings #ifdef _MSC_VER #pragma warning (disable: 4127) // condition expression is constant #pragma warning (disable: 4996) // 'This function or variable may be unsafe': strcpy, strdup, sprintf, vsnprintf, sscanf, fopen #if defined(_MSC_VER) && _MSC_VER >= 1922 // MSVC 2019 16.2 or later #pragma warning (disable: 5054) // operator '|': deprecated between enumerations of different types #endif #pragma warning (disable: 26451) // [Static Analyzer] Arithmetic overflow : Using operator 'xxx' on a 4 byte value and then casting the result to a 8 byte value. Cast the value to the wider type before calling operator 'xxx' to avoid overflow(io.2). #pragma warning (disable: 26812) // [Static Analyzer] The enum type 'xxx' is unscoped. Prefer 'enum class' over 'enum' (Enum.3). #endif // Clang/GCC warnings with -Weverything #if defined(__clang__) #if __has_warning("-Wunknown-warning-option") #pragma clang diagnostic ignored "-Wunknown-warning-option" // warning: unknown warning group 'xxx' // not all warnings are known by all Clang versions and they tend to be rename-happy.. so ignoring warnings triggers new warnings on some configuration. Great! #endif #pragma clang diagnostic ignored "-Wunknown-pragmas" // warning: unknown warning group 'xxx' #pragma clang diagnostic ignored "-Wold-style-cast" // warning: use of old-style cast // yes, they are more terse. #pragma clang diagnostic ignored "-Wfloat-equal" // warning: comparing floating point with == or != is unsafe // storing and comparing against same constants (typically 0.0f) is ok. #pragma clang diagnostic ignored "-Wformat" // warning: format specifies type 'int' but the argument has type 'unsigned int' #pragma clang diagnostic ignored "-Wformat-nonliteral" // warning: format string is not a string literal // passing non-literal to vsnformat(). yes, user passing incorrect format strings can crash the code. #pragma clang diagnostic ignored "-Wsign-conversion" // warning: implicit conversion changes signedness #pragma clang diagnostic ignored "-Wzero-as-null-pointer-constant" // warning: zero as null pointer constant // some standard header variations use #define NULL 0 #pragma clang diagnostic ignored "-Wdouble-promotion" // warning: implicit conversion from 'float' to 'double' when passing argument to function // using printf() is a misery with this as C++ va_arg ellipsis changes float to double. #pragma clang diagnostic ignored "-Wenum-enum-conversion" // warning: bitwise operation between different enumeration types ('XXXFlags_' and 'XXXFlagsPrivate_') #pragma clang diagnostic ignored "-Wdeprecated-enum-enum-conversion"// warning: bitwise operation between different enumeration types ('XXXFlags_' and 'XXXFlagsPrivate_') is deprecated #pragma clang diagnostic ignored "-Wimplicit-int-float-conversion" // warning: implicit conversion from 'xxx' to 'float' may lose precision #pragma clang diagnostic ignored "-Wunsafe-buffer-usage" // warning: 'xxx' is an unsafe pointer used for buffer access #pragma clang diagnostic ignored "-Wnontrivial-memaccess" // warning: first argument in call to 'memset' is a pointer to non-trivially copyable type #pragma clang diagnostic ignored "-Wswitch-default" // warning: 'switch' missing 'default' label #elif defined(__GNUC__) #pragma GCC diagnostic ignored "-Wpragmas" // warning: unknown option after '#pragma GCC diagnostic' kind #pragma GCC diagnostic ignored "-Wfloat-equal" // warning: comparing floating-point with '==' or '!=' is unsafe #pragma GCC diagnostic ignored "-Wformat-nonliteral" // warning: format not a string literal, format string not checked #pragma GCC diagnostic ignored "-Wdouble-promotion" // warning: implicit conversion from 'float' to 'double' when passing argument to function #pragma GCC diagnostic ignored "-Wformat" // warning: format '%p' expects argument of type 'int'/'void*', but argument X has type 'unsigned int'/'ImGuiWindow*' #pragma GCC diagnostic ignored "-Wstrict-overflow" #pragma GCC diagnostic ignored "-Wclass-memaccess" // [__GNUC__ >= 8] warning: 'memset/memcpy' clearing/writing an object of type 'xxxx' with no trivial copy-assignment; use assignment or value-initialization instead #endif //----------------------------------------------------------------------------- // [SECTION] Tables: Main code //----------------------------------------------------------------------------- // - TableFixFlags() [Internal] // - TableFindByID() [Internal] // - BeginTable() // - BeginTableEx() [Internal] // - TableBeginInitMemory() [Internal] // - TableBeginApplyRequests() [Internal] // - TableSetupColumnFlags() [Internal] // - TableUpdateLayout() [Internal] // - TableUpdateBorders() [Internal] // - EndTable() // - TableSetupColumn() // - TableSetupScrollFreeze() //----------------------------------------------------------------------------- // Configuration static const int TABLE_DRAW_CHANNEL_BG0 = 0; static const int TABLE_DRAW_CHANNEL_BG2_FROZEN = 1; static const int TABLE_DRAW_CHANNEL_NOCLIP = 2; // When using ImGuiTableFlags_NoClip (this becomes the last visible channel) static const float TABLE_BORDER_SIZE = 1.0f; // FIXME-TABLE: Currently hard-coded because of clipping assumptions with outer borders rendering. static const float TABLE_RESIZE_SEPARATOR_HALF_THICKNESS = 4.0f; // Extend outside inner borders. static const float TABLE_RESIZE_SEPARATOR_FEEDBACK_TIMER = 0.06f; // Delay/timer before making the hover feedback (color+cursor) visible because tables/columns tends to be more cramped. // Helper inline ImGuiTableFlags TableFixFlags(ImGuiTableFlags flags, ImGuiWindow* outer_window) { // Adjust flags: set default sizing policy if ((flags & ImGuiTableFlags_SizingMask_) == 0) flags |= ((flags & ImGuiTableFlags_ScrollX) || (outer_window->Flags & ImGuiWindowFlags_AlwaysAutoResize)) ? ImGuiTableFlags_SizingFixedFit : ImGuiTableFlags_SizingStretchSame; // Adjust flags: enable NoKeepColumnsVisible when using ImGuiTableFlags_SizingFixedSame if ((flags & ImGuiTableFlags_SizingMask_) == ImGuiTableFlags_SizingFixedSame) flags |= ImGuiTableFlags_NoKeepColumnsVisible; // Adjust flags: enforce borders when resizable if (flags & ImGuiTableFlags_Resizable) flags |= ImGuiTableFlags_BordersInnerV; // Adjust flags: disable NoHostExtendX/NoHostExtendY if we have any scrolling going on if (flags & (ImGuiTableFlags_ScrollX | ImGuiTableFlags_ScrollY)) flags &= ~(ImGuiTableFlags_NoHostExtendX | ImGuiTableFlags_NoHostExtendY); // Adjust flags: NoBordersInBodyUntilResize takes priority over NoBordersInBody if (flags & ImGuiTableFlags_NoBordersInBodyUntilResize) flags &= ~ImGuiTableFlags_NoBordersInBody; // Adjust flags: disable saved settings if there's nothing to save if ((flags & (ImGuiTableFlags_Resizable | ImGuiTableFlags_Hideable | ImGuiTableFlags_Reorderable | ImGuiTableFlags_Sortable)) == 0) flags |= ImGuiTableFlags_NoSavedSettings; // Inherit _NoSavedSettings from top-level window (child windows always have _NoSavedSettings set) if (outer_window->RootWindow->Flags & ImGuiWindowFlags_NoSavedSettings) flags |= ImGuiTableFlags_NoSavedSettings; return flags; } ImGuiTable* ImGui::TableFindByID(ImGuiID id) { ImGuiContext& g = *GImGui; return g.Tables.GetByKey(id); } // Read about "TABLE SIZING" at the top of this file. bool ImGui::BeginTable(const char* str_id, int columns_count, ImGuiTableFlags flags, const ImVec2& outer_size, float inner_width) { ImGuiID id = GetID(str_id); return BeginTableEx(str_id, id, columns_count, flags, outer_size, inner_width); } bool ImGui::BeginTableEx(const char* name, ImGuiID id, int columns_count, ImGuiTableFlags flags, const ImVec2& outer_size, float inner_width) { ImGuiContext& g = *GImGui; ImGuiWindow* outer_window = GetCurrentWindow(); if (outer_window->SkipItems) // Consistent with other tables + beneficial side effect that assert on miscalling EndTable() will be more visible. return false; // Sanity checks IM_ASSERT(columns_count > 0 && columns_count < IMGUI_TABLE_MAX_COLUMNS); if (flags & ImGuiTableFlags_ScrollX) IM_ASSERT(inner_width >= 0.0f); // If an outer size is specified ahead we will be able to early out when not visible. Exact clipping criteria may evolve. // FIXME: coarse clipping because access to table data causes two issues: // - instance numbers varying/unstable. may not be a direct problem for users, but could make outside access broken or confusing, e.g. TestEngine. // - can't implement support for ImGuiChildFlags_ResizeY as we need to somehow pull the height data from somewhere. this also needs stable instance numbers. // The side-effects of accessing table data on coarse clip would be: // - always reserving the pooled ImGuiTable data ahead for a fully clipped table (minor IMHO). Also the 'outer_window_is_measuring_size' criteria may already be defeating this in some situations. // - always performing the GetOrAddByKey() O(log N) query in g.Tables.Map[]. const bool use_child_window = (flags & (ImGuiTableFlags_ScrollX | ImGuiTableFlags_ScrollY)) != 0; const ImVec2 avail_size = GetContentRegionAvail(); const ImVec2 actual_outer_size = ImTrunc(CalcItemSize(outer_size, ImMax(avail_size.x, 1.0f), use_child_window ? ImMax(avail_size.y, 1.0f) : 0.0f)); const ImRect outer_rect(outer_window->DC.CursorPos, outer_window->DC.CursorPos + actual_outer_size); const bool outer_window_is_measuring_size = (outer_window->AutoFitFramesX > 0) || (outer_window->AutoFitFramesY > 0); // Doesn't apply to AlwaysAutoResize windows! if (use_child_window && IsClippedEx(outer_rect, 0) && !outer_window_is_measuring_size) { ItemSize(outer_rect); ItemAdd(outer_rect, id); g.NextWindowData.ClearFlags(); return false; } // [DEBUG] Debug break requested by user if (g.DebugBreakInTable == id) IM_DEBUG_BREAK(); // Acquire storage for the table ImGuiTable* table = g.Tables.GetOrAddByKey(id); // Acquire temporary buffers const int table_idx = g.Tables.GetIndex(table); if (++g.TablesTempDataStacked > g.TablesTempData.Size) g.TablesTempData.resize(g.TablesTempDataStacked, ImGuiTableTempData()); ImGuiTableTempData* temp_data = table->TempData = &g.TablesTempData[g.TablesTempDataStacked - 1]; temp_data->TableIndex = table_idx; table->DrawSplitter = &table->TempData->DrawSplitter; table->DrawSplitter->Clear(); // Fix flags table->IsDefaultSizingPolicy = (flags & ImGuiTableFlags_SizingMask_) == 0; flags = TableFixFlags(flags, outer_window); // Initialize const int previous_frame_active = table->LastFrameActive; const int instance_no = (previous_frame_active != g.FrameCount) ? 0 : table->InstanceCurrent + 1; const ImGuiTableFlags previous_flags = table->Flags; table->ID = id; table->Flags = flags; table->LastFrameActive = g.FrameCount; table->OuterWindow = table->InnerWindow = outer_window; table->ColumnsCount = columns_count; table->IsLayoutLocked = false; table->InnerWidth = inner_width; table->NavLayer = (ImS8)outer_window->DC.NavLayerCurrent; temp_data->UserOuterSize = outer_size; // Instance data (for instance 0, TableID == TableInstanceID) ImGuiID instance_id; table->InstanceCurrent = (ImS16)instance_no; if (instance_no > 0) { IM_ASSERT(table->ColumnsCount == columns_count && "BeginTable(): Cannot change columns count mid-frame while preserving same ID"); if (table->InstanceDataExtra.Size < instance_no) table->InstanceDataExtra.push_back(ImGuiTableInstanceData()); instance_id = GetIDWithSeed(instance_no, GetIDWithSeed("##Instances", NULL, id)); // Push "##Instances" followed by (int)instance_no in ID stack. } else { instance_id = id; } ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent); table_instance->TableInstanceID = instance_id; // When not using a child window, WorkRect.Max will grow as we append contents. if (use_child_window) { // Ensure no vertical scrollbar appears if we only want horizontal one, to make flag consistent // (we have no other way to disable vertical scrollbar of a window while keeping the horizontal one showing) ImVec2 override_content_size(FLT_MAX, FLT_MAX); if ((flags & ImGuiTableFlags_ScrollX) && !(flags & ImGuiTableFlags_ScrollY)) override_content_size.y = FLT_MIN; // Ensure specified width (when not specified, Stretched columns will act as if the width == OuterWidth and // never lead to any scrolling). We don't handle inner_width < 0.0f, we could potentially use it to right-align // based on the right side of the child window work rect, which would require knowing ahead if we are going to // have decoration taking horizontal spaces (typically a vertical scrollbar). if ((flags & ImGuiTableFlags_ScrollX) && inner_width > 0.0f) override_content_size.x = inner_width; if (override_content_size.x != FLT_MAX || override_content_size.y != FLT_MAX) SetNextWindowContentSize(ImVec2(override_content_size.x != FLT_MAX ? override_content_size.x : 0.0f, override_content_size.y != FLT_MAX ? override_content_size.y : 0.0f)); // Reset scroll if we are reactivating it if ((previous_flags & (ImGuiTableFlags_ScrollX | ImGuiTableFlags_ScrollY)) == 0) if ((g.NextWindowData.HasFlags & ImGuiNextWindowDataFlags_HasScroll) == 0) SetNextWindowScroll(ImVec2(0.0f, 0.0f)); // Create scrolling region (without border and zero window padding) ImGuiChildFlags child_child_flags = (g.NextWindowData.HasFlags & ImGuiNextWindowDataFlags_HasChildFlags) ? g.NextWindowData.ChildFlags : ImGuiChildFlags_None; ImGuiWindowFlags child_window_flags = (g.NextWindowData.HasFlags & ImGuiNextWindowDataFlags_HasWindowFlags) ? g.NextWindowData.WindowFlags : ImGuiWindowFlags_None; if (flags & ImGuiTableFlags_ScrollX) child_window_flags |= ImGuiWindowFlags_HorizontalScrollbar; BeginChildEx(name, instance_id, outer_rect.GetSize(), child_child_flags, child_window_flags); table->InnerWindow = g.CurrentWindow; table->WorkRect = table->InnerWindow->WorkRect; table->OuterRect = table->InnerWindow->Rect(); table->InnerRect = table->InnerWindow->InnerRect; IM_ASSERT(table->InnerWindow->WindowPadding.x == 0.0f && table->InnerWindow->WindowPadding.y == 0.0f && table->InnerWindow->WindowBorderSize == 0.0f); // Allow submitting when host is measuring if (table->InnerWindow->SkipItems && outer_window_is_measuring_size) table->InnerWindow->SkipItems = false; // When using multiple instances, ensure they have the same amount of horizontal decorations (aka vertical scrollbar) so stretched columns can be aligned) if (instance_no == 0) { table->HasScrollbarYPrev = table->HasScrollbarYCurr; table->HasScrollbarYCurr = false; } table->HasScrollbarYCurr |= table->InnerWindow->ScrollbarY; } else { // For non-scrolling tables, WorkRect == OuterRect == InnerRect. // But at this point we do NOT have a correct value for .Max.y (unless a height has been explicitly passed in). It will only be updated in EndTable(). table->WorkRect = table->OuterRect = table->InnerRect = outer_rect; table->HasScrollbarYPrev = table->HasScrollbarYCurr = false; } // Push a standardized ID for both child-using and not-child-using tables PushOverrideID(id); if (instance_no > 0) PushOverrideID(instance_id); // FIXME: Somehow this is not resolved by stack-tool, even tho GetIDWithSeed() submitted the symbol. // Backup a copy of host window members we will modify ImGuiWindow* inner_window = table->InnerWindow; table->HostIndentX = inner_window->DC.Indent.x; table->HostClipRect = inner_window->ClipRect; table->HostSkipItems = inner_window->SkipItems; temp_data->HostBackupWorkRect = inner_window->WorkRect; temp_data->HostBackupParentWorkRect = inner_window->ParentWorkRect; temp_data->HostBackupColumnsOffset = outer_window->DC.ColumnsOffset; temp_data->HostBackupPrevLineSize = inner_window->DC.PrevLineSize; temp_data->HostBackupCurrLineSize = inner_window->DC.CurrLineSize; temp_data->HostBackupCursorMaxPos = inner_window->DC.CursorMaxPos; temp_data->HostBackupItemWidth = outer_window->DC.ItemWidth; temp_data->HostBackupItemWidthStackSize = outer_window->DC.ItemWidthStack.Size; inner_window->DC.PrevLineSize = inner_window->DC.CurrLineSize = ImVec2(0.0f, 0.0f); // Make borders not overlap our contents by offsetting HostClipRect (#6765, #7428, #3752) // (we normally shouldn't alter HostClipRect as we rely on TableMergeDrawChannels() expanding non-clipped column toward the // limits of that rectangle, in order for ImDrawListSplitter::Merge() to merge the draw commands. However since the overlap // problem only affect scrolling tables in this case we can get away with doing it without extra cost). if (inner_window != outer_window) { // FIXME: Because inner_window's Scrollbar doesn't know about border size, since it's not encoded in window->WindowBorderSize, // it already overlaps it and doesn't need an extra offset. Ideally we should be able to pass custom border size with // different x/y values to BeginChild(). if (flags & ImGuiTableFlags_BordersOuterV) { table->HostClipRect.Min.x = ImMin(table->HostClipRect.Min.x + TABLE_BORDER_SIZE, table->HostClipRect.Max.x); if (inner_window->DecoOuterSizeX2 == 0.0f) table->HostClipRect.Max.x = ImMax(table->HostClipRect.Max.x - TABLE_BORDER_SIZE, table->HostClipRect.Min.x); } if (flags & ImGuiTableFlags_BordersOuterH) { table->HostClipRect.Min.y = ImMin(table->HostClipRect.Min.y + TABLE_BORDER_SIZE, table->HostClipRect.Max.y); if (inner_window->DecoOuterSizeY2 == 0.0f) table->HostClipRect.Max.y = ImMax(table->HostClipRect.Max.y - TABLE_BORDER_SIZE, table->HostClipRect.Min.y); } } // Padding and Spacing // - None ........Content..... Pad .....Content........ // - PadOuter | Pad ..Content..... Pad .....Content.. Pad | // - PadInner ........Content.. Pad | Pad ..Content........ // - PadOuter+PadInner | Pad ..Content.. Pad | Pad ..Content.. Pad | const bool pad_outer_x = (flags & ImGuiTableFlags_NoPadOuterX) ? false : (flags & ImGuiTableFlags_PadOuterX) ? true : (flags & ImGuiTableFlags_BordersOuterV) != 0; const bool pad_inner_x = (flags & ImGuiTableFlags_NoPadInnerX) ? false : true; const float inner_spacing_for_border = (flags & ImGuiTableFlags_BordersInnerV) ? TABLE_BORDER_SIZE : 0.0f; const float inner_spacing_explicit = (pad_inner_x && (flags & ImGuiTableFlags_BordersInnerV) == 0) ? g.Style.CellPadding.x : 0.0f; const float inner_padding_explicit = (pad_inner_x && (flags & ImGuiTableFlags_BordersInnerV) != 0) ? g.Style.CellPadding.x : 0.0f; table->CellSpacingX1 = inner_spacing_explicit + inner_spacing_for_border; table->CellSpacingX2 = inner_spacing_explicit; table->CellPaddingX = inner_padding_explicit; const float outer_padding_for_border = (flags & ImGuiTableFlags_BordersOuterV) ? TABLE_BORDER_SIZE : 0.0f; const float outer_padding_explicit = pad_outer_x ? g.Style.CellPadding.x : 0.0f; table->OuterPaddingX = (outer_padding_for_border + outer_padding_explicit) - table->CellPaddingX; table->CurrentColumn = -1; table->CurrentRow = -1; table->RowBgColorCounter = 0; table->LastRowFlags = ImGuiTableRowFlags_None; table->InnerClipRect = (inner_window == outer_window) ? table->WorkRect : inner_window->ClipRect; table->InnerClipRect.ClipWith(table->WorkRect); // We need this to honor inner_width table->InnerClipRect.ClipWithFull(table->HostClipRect); table->InnerClipRect.Max.y = (flags & ImGuiTableFlags_NoHostExtendY) ? ImMin(table->InnerClipRect.Max.y, inner_window->WorkRect.Max.y) : table->HostClipRect.Max.y; table->RowPosY1 = table->RowPosY2 = table->WorkRect.Min.y; // This is needed somehow table->RowTextBaseline = 0.0f; // This will be cleared again by TableBeginRow() table->RowCellPaddingY = 0.0f; table->FreezeRowsRequest = table->FreezeRowsCount = 0; // This will be setup by TableSetupScrollFreeze(), if any table->FreezeColumnsRequest = table->FreezeColumnsCount = 0; table->IsUnfrozenRows = true; table->DeclColumnsCount = table->AngledHeadersCount = 0; if (previous_frame_active + 1 < g.FrameCount) table->IsActiveIdInTable = false; table->AngledHeadersHeight = 0.0f; temp_data->AngledHeadersExtraWidth = 0.0f; // Using opaque colors facilitate overlapping lines of the grid, otherwise we'd need to improve TableDrawBorders() table->BorderColorStrong = GetColorU32(ImGuiCol_TableBorderStrong); table->BorderColorLight = GetColorU32(ImGuiCol_TableBorderLight); // Make table current g.CurrentTable = table; outer_window->DC.NavIsScrollPushableX = false; // Shortcut for NavUpdateCurrentWindowIsScrollPushableX(); outer_window->DC.CurrentTableIdx = table_idx; if (inner_window != outer_window) // So EndChild() within the inner window can restore the table properly. inner_window->DC.CurrentTableIdx = table_idx; if ((previous_flags & ImGuiTableFlags_Reorderable) && (flags & ImGuiTableFlags_Reorderable) == 0) table->IsResetDisplayOrderRequest = true; // Mark as used to avoid GC if (table_idx >= g.TablesLastTimeActive.Size) g.TablesLastTimeActive.resize(table_idx + 1, -1.0f); g.TablesLastTimeActive[table_idx] = (float)g.Time; temp_data->LastTimeActive = (float)g.Time; table->MemoryCompacted = false; // Setup memory buffer (clear data if columns count changed) ImGuiTableColumn* old_columns_to_preserve = NULL; void* old_columns_raw_data = NULL; const int old_columns_count = table->Columns.size(); if (old_columns_count != 0 && old_columns_count != columns_count) { // Attempt to preserve width on column count change (#4046) old_columns_to_preserve = table->Columns.Data; old_columns_raw_data = table->RawData; table->RawData = NULL; } if (table->RawData == NULL) { TableBeginInitMemory(table, columns_count); table->IsInitializing = table->IsSettingsRequestLoad = true; } if (table->IsResetAllRequest) TableResetSettings(table); if (table->IsInitializing) { // Initialize table->SettingsOffset = -1; table->IsSortSpecsDirty = true; table->IsSettingsDirty = true; // Records itself into .ini file even when in default state (#7934) table->InstanceInteracted = -1; table->ContextPopupColumn = -1; table->ReorderColumn = table->ResizedColumn = table->LastResizedColumn = -1; table->AutoFitSingleColumn = -1; table->HoveredColumnBody = table->HoveredColumnBorder = -1; for (int n = 0; n < columns_count; n++) { ImGuiTableColumn* column = &table->Columns[n]; if (old_columns_to_preserve && n < old_columns_count) { // FIXME: We don't attempt to preserve column order in this path. *column = old_columns_to_preserve[n]; } else { float width_auto = column->WidthAuto; *column = ImGuiTableColumn(); column->WidthAuto = width_auto; column->IsPreserveWidthAuto = true; // Preserve WidthAuto when reinitializing a live table: not technically necessary but remove a visible flicker column->IsEnabled = column->IsUserEnabled = column->IsUserEnabledNextFrame = true; } column->DisplayOrder = table->DisplayOrderToIndex[n] = (ImGuiTableColumnIdx)n; } } if (old_columns_raw_data) IM_FREE(old_columns_raw_data); // Load settings if (table->IsSettingsRequestLoad) TableLoadSettings(table); // Handle DPI/font resize // This is designed to facilitate DPI changes with the assumption that e.g. style.CellPadding has been scaled as well. // It will also react to changing fonts with mixed results. It doesn't need to be perfect but merely provide a decent transition. // FIXME-DPI: Provide consistent standards for reference size. Perhaps using g.CurrentDpiScale would be more self explanatory. // This is will lead us to non-rounded WidthRequest in columns, which should work but is a poorly tested path. const float new_ref_scale_unit = g.FontSize; // g.Font->GetCharAdvance('A') ? if (table->RefScale != 0.0f && table->RefScale != new_ref_scale_unit) { const float scale_factor = new_ref_scale_unit / table->RefScale; //IMGUI_DEBUG_PRINT("[table] %08X RefScaleUnit %.3f -> %.3f, scaling width by %.3f\n", table->ID, table->RefScaleUnit, new_ref_scale_unit, scale_factor); for (int n = 0; n < columns_count; n++) table->Columns[n].WidthRequest = table->Columns[n].WidthRequest * scale_factor; } table->RefScale = new_ref_scale_unit; // Disable output until user calls TableNextRow() or TableNextColumn() leading to the TableUpdateLayout() call.. // This is not strictly necessary but will reduce cases were "out of table" output will be misleading to the user. // Because we cannot safely assert in EndTable() when no rows have been created, this seems like our best option. inner_window->SkipItems = true; // Clear names // At this point the ->NameOffset field of each column will be invalid until TableUpdateLayout() or the first call to TableSetupColumn() if (table->ColumnsNames.Buf.Size > 0) table->ColumnsNames.Buf.resize(0); // Apply queued resizing/reordering/hiding requests TableBeginApplyRequests(table); return true; } // For reference, the average total _allocation count_ for a table is: // + 0 (for ImGuiTable instance, we are pooling allocations in g.Tables[]) // + 1 (for table->RawData allocated below) // + 1 (for table->ColumnsNames, if names are used) // Shared allocations for the maximum number of simultaneously nested tables (generally a very small number) // + 1 (for table->Splitter._Channels) // + 2 * active_channels_count (for ImDrawCmd and ImDrawIdx buffers inside channels) // Where active_channels_count is variable but often == columns_count or == columns_count + 1, see TableSetupDrawChannels() for details. // Unused channels don't perform their +2 allocations. void ImGui::TableBeginInitMemory(ImGuiTable* table, int columns_count) { // Allocate single buffer for our arrays const int columns_bit_array_size = (int)ImBitArrayGetStorageSizeInBytes(columns_count); ImSpanAllocator<6> span_allocator; span_allocator.Reserve(0, columns_count * sizeof(ImGuiTableColumn)); span_allocator.Reserve(1, columns_count * sizeof(ImGuiTableColumnIdx)); span_allocator.Reserve(2, columns_count * sizeof(ImGuiTableCellData), 4); for (int n = 3; n < 6; n++) span_allocator.Reserve(n, columns_bit_array_size); table->RawData = IM_ALLOC(span_allocator.GetArenaSizeInBytes()); memset(table->RawData, 0, span_allocator.GetArenaSizeInBytes()); span_allocator.SetArenaBasePtr(table->RawData); span_allocator.GetSpan(0, &table->Columns); span_allocator.GetSpan(1, &table->DisplayOrderToIndex); span_allocator.GetSpan(2, &table->RowCellData); table->EnabledMaskByDisplayOrder = (ImU32*)span_allocator.GetSpanPtrBegin(3); table->EnabledMaskByIndex = (ImU32*)span_allocator.GetSpanPtrBegin(4); table->VisibleMaskByIndex = (ImU32*)span_allocator.GetSpanPtrBegin(5); } // Apply queued resizing/reordering/hiding requests void ImGui::TableBeginApplyRequests(ImGuiTable* table) { // Handle resizing request // (We process this in the TableBegin() of the first instance of each table) // FIXME-TABLE: Contains columns if our work area doesn't allow for scrolling? if (table->InstanceCurrent == 0) { if (table->ResizedColumn != -1 && table->ResizedColumnNextWidth != FLT_MAX) TableSetColumnWidth(table->ResizedColumn, table->ResizedColumnNextWidth); table->LastResizedColumn = table->ResizedColumn; table->ResizedColumnNextWidth = FLT_MAX; table->ResizedColumn = -1; // Process auto-fit for single column, which is a special case for stretch columns and fixed columns with FixedSame policy. // FIXME-TABLE: Would be nice to redistribute available stretch space accordingly to other weights, instead of giving it all to siblings. if (table->AutoFitSingleColumn != -1) { TableSetColumnWidth(table->AutoFitSingleColumn, table->Columns[table->AutoFitSingleColumn].WidthAuto); table->AutoFitSingleColumn = -1; } } // Handle reordering request // Note: we don't clear ReorderColumn after handling the request. if (table->InstanceCurrent == 0) { if (table->HeldHeaderColumn == -1 && table->ReorderColumn != -1) table->ReorderColumn = -1; table->HeldHeaderColumn = -1; if (table->ReorderColumn != -1 && table->ReorderColumnDir != 0) { // We need to handle reordering across hidden columns. // In the configuration below, moving C to the right of E will lead to: // ... C [D] E ---> ... [D] E C (Column name/index) // ... 2 3 4 ... 2 3 4 (Display order) const int reorder_dir = table->ReorderColumnDir; IM_ASSERT(reorder_dir == -1 || reorder_dir == +1); IM_ASSERT(table->Flags & ImGuiTableFlags_Reorderable); ImGuiTableColumn* src_column = &table->Columns[table->ReorderColumn]; ImGuiTableColumn* dst_column = &table->Columns[(reorder_dir == -1) ? src_column->PrevEnabledColumn : src_column->NextEnabledColumn]; IM_UNUSED(dst_column); const int src_order = src_column->DisplayOrder; const int dst_order = dst_column->DisplayOrder; src_column->DisplayOrder = (ImGuiTableColumnIdx)dst_order; for (int order_n = src_order + reorder_dir; order_n != dst_order + reorder_dir; order_n += reorder_dir) table->Columns[table->DisplayOrderToIndex[order_n]].DisplayOrder -= (ImGuiTableColumnIdx)reorder_dir; IM_ASSERT(dst_column->DisplayOrder == dst_order - reorder_dir); // Display order is stored in both columns->IndexDisplayOrder and table->DisplayOrder[]. Rebuild later from the former. for (int column_n = 0; column_n < table->ColumnsCount; column_n++) table->DisplayOrderToIndex[table->Columns[column_n].DisplayOrder] = (ImGuiTableColumnIdx)column_n; table->ReorderColumnDir = 0; table->IsSettingsDirty = true; } } // Handle display order reset request if (table->IsResetDisplayOrderRequest) { for (int n = 0; n < table->ColumnsCount; n++) table->DisplayOrderToIndex[n] = table->Columns[n].DisplayOrder = (ImGuiTableColumnIdx)n; table->IsResetDisplayOrderRequest = false; table->IsSettingsDirty = true; } } // Adjust flags: default width mode + stretch columns are not allowed when auto extending static void TableSetupColumnFlags(ImGuiTable* table, ImGuiTableColumn* column, ImGuiTableColumnFlags flags_in) { ImGuiTableColumnFlags flags = flags_in; // Sizing Policy if ((flags & ImGuiTableColumnFlags_WidthMask_) == 0) { const ImGuiTableFlags table_sizing_policy = (table->Flags & ImGuiTableFlags_SizingMask_); if (table_sizing_policy == ImGuiTableFlags_SizingFixedFit || table_sizing_policy == ImGuiTableFlags_SizingFixedSame) flags |= ImGuiTableColumnFlags_WidthFixed; else flags |= ImGuiTableColumnFlags_WidthStretch; } else { IM_ASSERT(ImIsPowerOfTwo(flags & ImGuiTableColumnFlags_WidthMask_)); // Check that only 1 of each set is used. } // Resize if ((table->Flags & ImGuiTableFlags_Resizable) == 0) flags |= ImGuiTableColumnFlags_NoResize; // Sorting if ((flags & ImGuiTableColumnFlags_NoSortAscending) && (flags & ImGuiTableColumnFlags_NoSortDescending)) flags |= ImGuiTableColumnFlags_NoSort; // Indentation if ((flags & ImGuiTableColumnFlags_IndentMask_) == 0) flags |= (table->Columns.index_from_ptr(column) == 0) ? ImGuiTableColumnFlags_IndentEnable : ImGuiTableColumnFlags_IndentDisable; // Alignment //if ((flags & ImGuiTableColumnFlags_AlignMask_) == 0) // flags |= ImGuiTableColumnFlags_AlignCenter; //IM_ASSERT(ImIsPowerOfTwo(flags & ImGuiTableColumnFlags_AlignMask_)); // Check that only 1 of each set is used. // Preserve status flags column->Flags = flags | (column->Flags & ImGuiTableColumnFlags_StatusMask_); // Build an ordered list of available sort directions column->SortDirectionsAvailCount = column->SortDirectionsAvailMask = column->SortDirectionsAvailList = 0; if (table->Flags & ImGuiTableFlags_Sortable) { int count = 0, mask = 0, list = 0; if ((flags & ImGuiTableColumnFlags_PreferSortAscending) != 0 && (flags & ImGuiTableColumnFlags_NoSortAscending) == 0) { mask |= 1 << ImGuiSortDirection_Ascending; list |= ImGuiSortDirection_Ascending << (count << 1); count++; } if ((flags & ImGuiTableColumnFlags_PreferSortDescending) != 0 && (flags & ImGuiTableColumnFlags_NoSortDescending) == 0) { mask |= 1 << ImGuiSortDirection_Descending; list |= ImGuiSortDirection_Descending << (count << 1); count++; } if ((flags & ImGuiTableColumnFlags_PreferSortAscending) == 0 && (flags & ImGuiTableColumnFlags_NoSortAscending) == 0) { mask |= 1 << ImGuiSortDirection_Ascending; list |= ImGuiSortDirection_Ascending << (count << 1); count++; } if ((flags & ImGuiTableColumnFlags_PreferSortDescending) == 0 && (flags & ImGuiTableColumnFlags_NoSortDescending) == 0) { mask |= 1 << ImGuiSortDirection_Descending; list |= ImGuiSortDirection_Descending << (count << 1); count++; } if ((table->Flags & ImGuiTableFlags_SortTristate) || count == 0) { mask |= 1 << ImGuiSortDirection_None; count++; } column->SortDirectionsAvailList = (ImU8)list; column->SortDirectionsAvailMask = (ImU8)mask; column->SortDirectionsAvailCount = (ImU8)count; ImGui::TableFixColumnSortDirection(table, column); } } // Layout columns for the frame. This is in essence the followup to BeginTable() and this is our largest function. // Runs on the first call to TableNextRow(), to give a chance for TableSetupColumn() and other TableSetupXXXXX() functions to be called first. // FIXME-TABLE: Our width (and therefore our WorkRect) will be minimal in the first frame for _WidthAuto columns. // Increase feedback side-effect with widgets relying on WorkRect.Max.x... Maybe provide a default distribution for _WidthAuto columns? void ImGui::TableUpdateLayout(ImGuiTable* table) { ImGuiContext& g = *GImGui; IM_ASSERT(table->IsLayoutLocked == false); const ImGuiTableFlags table_sizing_policy = (table->Flags & ImGuiTableFlags_SizingMask_); table->IsDefaultDisplayOrder = true; table->ColumnsEnabledCount = 0; ImBitArrayClearAllBits(table->EnabledMaskByIndex, table->ColumnsCount); ImBitArrayClearAllBits(table->EnabledMaskByDisplayOrder, table->ColumnsCount); table->LeftMostEnabledColumn = -1; table->MinColumnWidth = ImMax(1.0f, g.Style.FramePadding.x * 1.0f); // g.Style.ColumnsMinSpacing; // FIXME-TABLE // [Part 1] Apply/lock Enabled and Order states. Calculate auto/ideal width for columns. Count fixed/stretch columns. // Process columns in their visible orders as we are building the Prev/Next indices. int count_fixed = 0; // Number of columns that have fixed sizing policies int count_stretch = 0; // Number of columns that have stretch sizing policies int prev_visible_column_idx = -1; bool has_auto_fit_request = false; bool has_resizable = false; float stretch_sum_width_auto = 0.0f; float fixed_max_width_auto = 0.0f; for (int order_n = 0; order_n < table->ColumnsCount; order_n++) { const int column_n = table->DisplayOrderToIndex[order_n]; if (column_n != order_n) table->IsDefaultDisplayOrder = false; ImGuiTableColumn* column = &table->Columns[column_n]; // Clear column setup if not submitted by user. Currently we make it mandatory to call TableSetupColumn() every frame. // It would easily work without but we're not ready to guarantee it since e.g. names need resubmission anyway. // We take a slight shortcut but in theory we could be calling TableSetupColumn() here with dummy values, it should yield the same effect. if (table->DeclColumnsCount <= column_n) { TableSetupColumnFlags(table, column, ImGuiTableColumnFlags_None); column->NameOffset = -1; column->UserID = 0; column->InitStretchWeightOrWidth = -1.0f; } // Update Enabled state, mark settings and sort specs dirty if (!(table->Flags & ImGuiTableFlags_Hideable) || (column->Flags & ImGuiTableColumnFlags_NoHide)) column->IsUserEnabledNextFrame = true; if (column->IsUserEnabled != column->IsUserEnabledNextFrame) { column->IsUserEnabled = column->IsUserEnabledNextFrame; table->IsSettingsDirty = true; } column->IsEnabled = column->IsUserEnabled && (column->Flags & ImGuiTableColumnFlags_Disabled) == 0; if (column->SortOrder != -1 && !column->IsEnabled) table->IsSortSpecsDirty = true; if (column->SortOrder > 0 && !(table->Flags & ImGuiTableFlags_SortMulti)) table->IsSortSpecsDirty = true; // Auto-fit unsized columns const bool start_auto_fit = (column->Flags & ImGuiTableColumnFlags_WidthFixed) ? (column->WidthRequest < 0.0f) : (column->StretchWeight < 0.0f); if (start_auto_fit) column->AutoFitQueue = column->CannotSkipItemsQueue = (1 << 3) - 1; // Fit for three frames if (!column->IsEnabled) { column->IndexWithinEnabledSet = -1; continue; } // Mark as enabled and link to previous/next enabled column column->PrevEnabledColumn = (ImGuiTableColumnIdx)prev_visible_column_idx; column->NextEnabledColumn = -1; if (prev_visible_column_idx != -1) table->Columns[prev_visible_column_idx].NextEnabledColumn = (ImGuiTableColumnIdx)column_n; else table->LeftMostEnabledColumn = (ImGuiTableColumnIdx)column_n; column->IndexWithinEnabledSet = table->ColumnsEnabledCount++; ImBitArraySetBit(table->EnabledMaskByIndex, column_n); ImBitArraySetBit(table->EnabledMaskByDisplayOrder, column->DisplayOrder); prev_visible_column_idx = column_n; IM_ASSERT(column->IndexWithinEnabledSet <= column->DisplayOrder); // Calculate ideal/auto column width (that's the width required for all contents to be visible without clipping) // Combine width from regular rows + width from headers unless requested not to. if (!column->IsPreserveWidthAuto && table->InstanceCurrent == 0) column->WidthAuto = TableGetColumnWidthAuto(table, column); // Non-resizable columns keep their requested width (apply user value regardless of IsPreserveWidthAuto) const bool column_is_resizable = (column->Flags & ImGuiTableColumnFlags_NoResize) == 0; if (column_is_resizable) has_resizable = true; if ((column->Flags & ImGuiTableColumnFlags_WidthFixed) && column->InitStretchWeightOrWidth > 0.0f && !column_is_resizable) column->WidthAuto = column->InitStretchWeightOrWidth; if (column->AutoFitQueue != 0x00) has_auto_fit_request = true; if (column->Flags & ImGuiTableColumnFlags_WidthStretch) { stretch_sum_width_auto += column->WidthAuto; count_stretch++; } else { fixed_max_width_auto = ImMax(fixed_max_width_auto, column->WidthAuto); count_fixed++; } } if ((table->Flags & ImGuiTableFlags_Sortable) && table->SortSpecsCount == 0 && !(table->Flags & ImGuiTableFlags_SortTristate)) table->IsSortSpecsDirty = true; table->RightMostEnabledColumn = (ImGuiTableColumnIdx)prev_visible_column_idx; IM_ASSERT(table->LeftMostEnabledColumn >= 0 && table->RightMostEnabledColumn >= 0); // [Part 2] Disable child window clipping while fitting columns. This is not strictly necessary but makes it possible to avoid // the column fitting having to wait until the first visible frame of the child container (may or not be a good thing). Also see #6510. // FIXME-TABLE: for always auto-resizing columns may not want to do that all the time. if (has_auto_fit_request && table->OuterWindow != table->InnerWindow) table->InnerWindow->SkipItems = false; if (has_auto_fit_request) table->IsSettingsDirty = true; // [Part 3] Fix column flags and record a few extra information. float sum_width_requests = 0.0f; // Sum of all width for fixed and auto-resize columns, excluding width contributed by Stretch columns but including spacing/padding. float stretch_sum_weights = 0.0f; // Sum of all weights for stretch columns. table->LeftMostStretchedColumn = table->RightMostStretchedColumn = -1; for (int column_n = 0; column_n < table->ColumnsCount; column_n++) { if (!IM_BITARRAY_TESTBIT(table->EnabledMaskByIndex, column_n)) continue; ImGuiTableColumn* column = &table->Columns[column_n]; const bool column_is_resizable = (column->Flags & ImGuiTableColumnFlags_NoResize) == 0; if (column->Flags & ImGuiTableColumnFlags_WidthFixed) { // Apply same widths policy float width_auto = column->WidthAuto; if (table_sizing_policy == ImGuiTableFlags_SizingFixedSame && (column->AutoFitQueue != 0x00 || !column_is_resizable)) width_auto = fixed_max_width_auto; // Apply automatic width // Latch initial size for fixed columns and update it constantly for auto-resizing column (unless clipped!) if (column->AutoFitQueue != 0x00) column->WidthRequest = width_auto; else if ((column->Flags & ImGuiTableColumnFlags_WidthFixed) && !column_is_resizable && column->IsRequestOutput) column->WidthRequest = width_auto; // FIXME-TABLE: Increase minimum size during init frame to avoid biasing auto-fitting widgets // (e.g. TextWrapped) too much. Otherwise what tends to happen is that TextWrapped would output a very // large height (= first frame scrollbar display very off + clipper would skip lots of items). // This is merely making the side-effect less extreme, but doesn't properly fixes it. // FIXME: Move this to ->WidthGiven to avoid temporary lossyless? // FIXME: This break IsPreserveWidthAuto from not flickering if the stored WidthAuto was smaller. if (column->AutoFitQueue > 0x01 && table->IsInitializing && !column->IsPreserveWidthAuto) column->WidthRequest = ImMax(column->WidthRequest, table->MinColumnWidth * 4.0f); // FIXME-TABLE: Another constant/scale? sum_width_requests += column->WidthRequest; } else { // Initialize stretch weight if (column->AutoFitQueue != 0x00 || column->StretchWeight < 0.0f || !column_is_resizable) { if (column->InitStretchWeightOrWidth > 0.0f) column->StretchWeight = column->InitStretchWeightOrWidth; else if (table_sizing_policy == ImGuiTableFlags_SizingStretchProp) column->StretchWeight = (column->WidthAuto / stretch_sum_width_auto) * count_stretch; else column->StretchWeight = 1.0f; } stretch_sum_weights += column->StretchWeight; if (table->LeftMostStretchedColumn == -1 || table->Columns[table->LeftMostStretchedColumn].DisplayOrder > column->DisplayOrder) table->LeftMostStretchedColumn = (ImGuiTableColumnIdx)column_n; if (table->RightMostStretchedColumn == -1 || table->Columns[table->RightMostStretchedColumn].DisplayOrder < column->DisplayOrder) table->RightMostStretchedColumn = (ImGuiTableColumnIdx)column_n; } column->IsPreserveWidthAuto = false; sum_width_requests += table->CellPaddingX * 2.0f; } table->ColumnsEnabledFixedCount = (ImGuiTableColumnIdx)count_fixed; table->ColumnsStretchSumWeights = stretch_sum_weights; // [Part 4] Apply final widths based on requested widths const ImRect work_rect = table->WorkRect; const float width_spacings = (table->OuterPaddingX * 2.0f) + (table->CellSpacingX1 + table->CellSpacingX2) * (table->ColumnsEnabledCount - 1); const float width_removed = (table->HasScrollbarYPrev && !table->InnerWindow->ScrollbarY) ? g.Style.ScrollbarSize : 0.0f; // To synchronize decoration width of synced tables with mismatching scrollbar state (#5920) const float width_avail = ImMax(1.0f, (((table->Flags & ImGuiTableFlags_ScrollX) && table->InnerWidth == 0.0f) ? table->InnerClipRect.GetWidth() : work_rect.GetWidth()) - width_removed); const float width_avail_for_stretched_columns = width_avail - width_spacings - sum_width_requests; float width_remaining_for_stretched_columns = width_avail_for_stretched_columns; table->ColumnsGivenWidth = width_spacings + (table->CellPaddingX * 2.0f) * table->ColumnsEnabledCount; for (int column_n = 0; column_n < table->ColumnsCount; column_n++) { if (!IM_BITARRAY_TESTBIT(table->EnabledMaskByIndex, column_n)) continue; ImGuiTableColumn* column = &table->Columns[column_n]; // Allocate width for stretched/weighted columns (StretchWeight gets converted into WidthRequest) if (column->Flags & ImGuiTableColumnFlags_WidthStretch) { float weight_ratio = column->StretchWeight / stretch_sum_weights; column->WidthRequest = IM_TRUNC(ImMax(width_avail_for_stretched_columns * weight_ratio, table->MinColumnWidth) + 0.01f); width_remaining_for_stretched_columns -= column->WidthRequest; } // [Resize Rule 1] The right-most Visible column is not resizable if there is at least one Stretch column // See additional comments in TableSetColumnWidth(). if (column->NextEnabledColumn == -1 && table->LeftMostStretchedColumn != -1) column->Flags |= ImGuiTableColumnFlags_NoDirectResize_; // Assign final width, record width in case we will need to shrink column->WidthGiven = ImTrunc(ImMax(column->WidthRequest, table->MinColumnWidth)); table->ColumnsGivenWidth += column->WidthGiven; } // [Part 5] Redistribute stretch remainder width due to rounding (remainder width is < 1.0f * number of Stretch column). // Using right-to-left distribution (more likely to match resizing cursor). if (width_remaining_for_stretched_columns >= 1.0f && !(table->Flags & ImGuiTableFlags_PreciseWidths)) for (int order_n = table->ColumnsCount - 1; stretch_sum_weights > 0.0f && width_remaining_for_stretched_columns >= 1.0f && order_n >= 0; order_n--) { if (!IM_BITARRAY_TESTBIT(table->EnabledMaskByDisplayOrder, order_n)) continue; ImGuiTableColumn* column = &table->Columns[table->DisplayOrderToIndex[order_n]]; if (!(column->Flags & ImGuiTableColumnFlags_WidthStretch)) continue; column->WidthRequest += 1.0f; column->WidthGiven += 1.0f; width_remaining_for_stretched_columns -= 1.0f; } // Determine if table is hovered which will be used to flag columns as hovered. // - In principle we'd like to use the equivalent of IsItemHovered(ImGuiHoveredFlags_AllowWhenBlockedByActiveItem), // but because our item is partially submitted at this point we use ItemHoverable() and a workaround (temporarily // clear ActiveId, which is equivalent to the change provided by _AllowWhenBLockedByActiveItem). // - This allows columns to be marked as hovered when e.g. clicking a button inside the column, or using drag and drop. ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent); table_instance->HoveredRowLast = table_instance->HoveredRowNext; table_instance->HoveredRowNext = -1; table->HoveredColumnBody = table->HoveredColumnBorder = -1; const ImRect mouse_hit_rect(table->OuterRect.Min.x, table->OuterRect.Min.y, table->OuterRect.Max.x, ImMax(table->OuterRect.Max.y, table->OuterRect.Min.y + table_instance->LastOuterHeight)); const ImGuiID backup_active_id = g.ActiveId; g.ActiveId = 0; const bool is_hovering_table = ItemHoverable(mouse_hit_rect, 0, ImGuiItemFlags_None); g.ActiveId = backup_active_id; // Determine skewed MousePos.x to support angled headers. float mouse_skewed_x = g.IO.MousePos.x; if (table->AngledHeadersHeight > 0.0f) if (g.IO.MousePos.y >= table->OuterRect.Min.y && g.IO.MousePos.y <= table->OuterRect.Min.y + table->AngledHeadersHeight) mouse_skewed_x += ImTrunc((table->OuterRect.Min.y + table->AngledHeadersHeight - g.IO.MousePos.y) * table->AngledHeadersSlope); // [Part 6] Setup final position, offset, skip/clip states and clipping rectangles, detect hovered column // Process columns in their visible orders as we are comparing the visible order and adjusting host_clip_rect while looping. int visible_n = 0; bool has_at_least_one_column_requesting_output = false; bool offset_x_frozen = (table->FreezeColumnsCount > 0); float offset_x = ((table->FreezeColumnsCount > 0) ? table->OuterRect.Min.x : work_rect.Min.x) + table->OuterPaddingX - table->CellSpacingX1; ImRect host_clip_rect = table->InnerClipRect; //host_clip_rect.Max.x += table->CellPaddingX + table->CellSpacingX2; ImBitArrayClearAllBits(table->VisibleMaskByIndex, table->ColumnsCount); for (int order_n = 0; order_n < table->ColumnsCount; order_n++) { const int column_n = table->DisplayOrderToIndex[order_n]; ImGuiTableColumn* column = &table->Columns[column_n]; // Initial nav layer: using FreezeRowsCount, NOT FreezeRowsRequest, so Header line changes layer when frozen column->NavLayerCurrent = (ImS8)(table->FreezeRowsCount > 0 ? ImGuiNavLayer_Menu : (ImGuiNavLayer)table->NavLayer); if (offset_x_frozen && table->FreezeColumnsCount == visible_n) { offset_x += work_rect.Min.x - table->OuterRect.Min.x; offset_x_frozen = false; } // Clear status flags column->Flags &= ~ImGuiTableColumnFlags_StatusMask_; if (!IM_BITARRAY_TESTBIT(table->EnabledMaskByDisplayOrder, order_n)) { // Hidden column: clear a few fields and we are done with it for the remainder of the function. // We set a zero-width clip rect but set Min.y/Max.y properly to not interfere with the clipper. column->MinX = column->MaxX = column->WorkMinX = column->ClipRect.Min.x = column->ClipRect.Max.x = offset_x; column->WidthGiven = 0.0f; column->ClipRect.Min.y = work_rect.Min.y; column->ClipRect.Max.y = FLT_MAX; column->ClipRect.ClipWithFull(host_clip_rect); column->IsVisibleX = column->IsVisibleY = column->IsRequestOutput = false; column->IsSkipItems = true; column->ItemWidth = 1.0f; continue; } // Lock start position column->MinX = offset_x; // Lock width based on start position and minimum/maximum width for this position column->WidthMax = TableCalcMaxColumnWidth(table, column_n); column->WidthGiven = ImMin(column->WidthGiven, column->WidthMax); column->WidthGiven = ImMax(column->WidthGiven, ImMin(column->WidthRequest, table->MinColumnWidth)); column->MaxX = offset_x + column->WidthGiven + table->CellSpacingX1 + table->CellSpacingX2 + table->CellPaddingX * 2.0f; // Lock other positions // - ClipRect.Min.x: Because merging draw commands doesn't compare min boundaries, we make ClipRect.Min.x match left bounds to be consistent regardless of merging. // - ClipRect.Max.x: using WorkMaxX instead of MaxX (aka including padding) makes things more consistent when resizing down, tho slightly detrimental to visibility in very-small column. // - ClipRect.Max.x: using MaxX makes it easier for header to receive hover highlight with no discontinuity and display sorting arrow. // - FIXME-TABLE: We want equal width columns to have equal (ClipRect.Max.x - WorkMinX) width, which means ClipRect.max.x cannot stray off host_clip_rect.Max.x else right-most column may appear shorter. const float previous_instance_work_min_x = column->WorkMinX; column->WorkMinX = column->MinX + table->CellPaddingX + table->CellSpacingX1; column->WorkMaxX = column->MaxX - table->CellPaddingX - table->CellSpacingX2; // Expected max column->ItemWidth = ImTrunc(column->WidthGiven * 0.65f); column->ClipRect.Min.x = column->MinX; column->ClipRect.Min.y = work_rect.Min.y; column->ClipRect.Max.x = column->MaxX; //column->WorkMaxX; column->ClipRect.Max.y = FLT_MAX; column->ClipRect.ClipWithFull(host_clip_rect); // Mark column as Clipped (not in sight) // Note that scrolling tables (where inner_window != outer_window) handle Y clipped earlier in BeginTable() so IsVisibleY really only applies to non-scrolling tables. // FIXME-TABLE: Because InnerClipRect.Max.y is conservatively ==outer_window->ClipRect.Max.y, we never can mark columns _Above_ the scroll line as not IsVisibleY. // Taking advantage of LastOuterHeight would yield good results there... // FIXME-TABLE: Y clipping is disabled because it effectively means not submitting will reduce contents width which is fed to outer_window->DC.CursorMaxPos.x, // and this may be used (e.g. typically by outer_window using AlwaysAutoResize or outer_window's horizontal scrollbar, but could be something else). // Possible solution to preserve last known content width for clipped column. Test 'table_reported_size' fails when enabling Y clipping and window is resized small. column->IsVisibleX = (column->ClipRect.Max.x > column->ClipRect.Min.x); column->IsVisibleY = true; // (column->ClipRect.Max.y > column->ClipRect.Min.y); const bool is_visible = column->IsVisibleX; //&& column->IsVisibleY; if (is_visible) ImBitArraySetBit(table->VisibleMaskByIndex, column_n); // Mark column as requesting output from user. Note that fixed + non-resizable sets are auto-fitting at all times and therefore always request output. column->IsRequestOutput = is_visible || column->AutoFitQueue != 0 || column->CannotSkipItemsQueue != 0; // Mark column as SkipItems (ignoring all items/layout) // (table->HostSkipItems is a copy of inner_window->SkipItems before we cleared it above in Part 2) column->IsSkipItems = !column->IsEnabled || table->HostSkipItems; if (column->IsSkipItems) IM_ASSERT(!is_visible); if (column->IsRequestOutput && !column->IsSkipItems) has_at_least_one_column_requesting_output = true; // Update status flags column->Flags |= ImGuiTableColumnFlags_IsEnabled; if (is_visible) column->Flags |= ImGuiTableColumnFlags_IsVisible; if (column->SortOrder != -1) column->Flags |= ImGuiTableColumnFlags_IsSorted; // Detect hovered column if (is_hovering_table && mouse_skewed_x >= column->ClipRect.Min.x && mouse_skewed_x < column->ClipRect.Max.x) { column->Flags |= ImGuiTableColumnFlags_IsHovered; table->HoveredColumnBody = (ImGuiTableColumnIdx)column_n; } // Alignment // FIXME-TABLE: This align based on the whole column width, not per-cell, and therefore isn't useful in // many cases (to be able to honor this we might be able to store a log of cells width, per row, for // visible rows, but nav/programmatic scroll would have visible artifacts.) //if (column->Flags & ImGuiTableColumnFlags_AlignRight) // column->WorkMinX = ImMax(column->WorkMinX, column->MaxX - column->ContentWidthRowsUnfrozen); //else if (column->Flags & ImGuiTableColumnFlags_AlignCenter) // column->WorkMinX = ImLerp(column->WorkMinX, ImMax(column->StartX, column->MaxX - column->ContentWidthRowsUnfrozen), 0.5f); // Reset content width variables if (table->InstanceCurrent == 0) { column->ContentMaxXFrozen = column->WorkMinX; column->ContentMaxXUnfrozen = column->WorkMinX; column->ContentMaxXHeadersUsed = column->WorkMinX; column->ContentMaxXHeadersIdeal = column->WorkMinX; } else { // As we store an absolute value to make per-cell updates faster, we need to offset values used for width computation. const float offset_from_previous_instance = column->WorkMinX - previous_instance_work_min_x; column->ContentMaxXFrozen += offset_from_previous_instance; column->ContentMaxXUnfrozen += offset_from_previous_instance; column->ContentMaxXHeadersUsed += offset_from_previous_instance; column->ContentMaxXHeadersIdeal += offset_from_previous_instance; } // Don't decrement auto-fit counters until container window got a chance to submit its items if (table->HostSkipItems == false && table->InstanceCurrent == 0) { column->AutoFitQueue >>= 1; column->CannotSkipItemsQueue >>= 1; } if (visible_n < table->FreezeColumnsCount) host_clip_rect.Min.x = ImClamp(column->MaxX + TABLE_BORDER_SIZE, host_clip_rect.Min.x, host_clip_rect.Max.x); offset_x += column->WidthGiven + table->CellSpacingX1 + table->CellSpacingX2 + table->CellPaddingX * 2.0f; visible_n++; } // In case the table is visible (e.g. decorations) but all columns clipped, we keep a column visible. // Else if give no chance to a clipper-savy user to submit rows and therefore total contents height used by scrollbar. if (has_at_least_one_column_requesting_output == false) { table->Columns[table->LeftMostEnabledColumn].IsRequestOutput = true; table->Columns[table->LeftMostEnabledColumn].IsSkipItems = false; } // [Part 7] Detect/store when we are hovering the unused space after the right-most column (so e.g. context menus can react on it) // Clear Resizable flag if none of our column are actually resizable (either via an explicit _NoResize flag, either // because of using _WidthAuto/_WidthStretch). This will hide the resizing option from the context menu. const float unused_x1 = ImMax(table->WorkRect.Min.x, table->Columns[table->RightMostEnabledColumn].ClipRect.Max.x); if (is_hovering_table && table->HoveredColumnBody == -1) if (mouse_skewed_x >= unused_x1) table->HoveredColumnBody = (ImGuiTableColumnIdx)table->ColumnsCount; if (has_resizable == false && (table->Flags & ImGuiTableFlags_Resizable)) table->Flags &= ~ImGuiTableFlags_Resizable; table->IsActiveIdAliveBeforeTable = (g.ActiveIdIsAlive != 0); // [Part 8] Lock actual OuterRect/WorkRect right-most position. // This is done late to handle the case of fixed-columns tables not claiming more widths that they need. // Because of this we are careful with uses of WorkRect and InnerClipRect before this point. if (table->RightMostStretchedColumn != -1) table->Flags &= ~ImGuiTableFlags_NoHostExtendX; if (table->Flags & ImGuiTableFlags_NoHostExtendX) { table->OuterRect.Max.x = table->WorkRect.Max.x = unused_x1; table->InnerClipRect.Max.x = ImMin(table->InnerClipRect.Max.x, unused_x1); } table->InnerWindow->ParentWorkRect = table->WorkRect; table->BorderX1 = table->InnerClipRect.Min.x; table->BorderX2 = table->InnerClipRect.Max.x; // Setup window's WorkRect.Max.y for GetContentRegionAvail(). Other values will be updated in each TableBeginCell() call. float window_content_max_y; if (table->Flags & ImGuiTableFlags_NoHostExtendY) window_content_max_y = table->OuterRect.Max.y; else window_content_max_y = ImMax(table->InnerWindow->ContentRegionRect.Max.y, (table->Flags & ImGuiTableFlags_ScrollY) ? 0.0f : table->OuterRect.Max.y); table->InnerWindow->WorkRect.Max.y = ImClamp(window_content_max_y - g.Style.CellPadding.y, table->InnerWindow->WorkRect.Min.y, table->InnerWindow->WorkRect.Max.y); // [Part 9] Allocate draw channels and setup background cliprect TableSetupDrawChannels(table); // [Part 10] Hit testing on borders if (table->Flags & ImGuiTableFlags_Resizable) TableUpdateBorders(table); table_instance->LastTopHeadersRowHeight = 0.0f; table->IsLayoutLocked = true; table->IsUsingHeaders = false; // Highlight header table->HighlightColumnHeader = -1; if (table->IsContextPopupOpen && table->ContextPopupColumn != -1 && table->InstanceInteracted == table->InstanceCurrent) table->HighlightColumnHeader = table->ContextPopupColumn; else if ((table->Flags & ImGuiTableFlags_HighlightHoveredColumn) && table->HoveredColumnBody != -1 && table->HoveredColumnBody != table->ColumnsCount && table->HoveredColumnBorder == -1) if (g.ActiveId == 0 || (table->IsActiveIdInTable || g.DragDropActive)) table->HighlightColumnHeader = table->HoveredColumnBody; // [Part 11] Default context menu // - To append to this menu: you can call TableBeginContextMenuPopup()/.../EndPopup(). // - To modify or replace this: set table->IsContextPopupNoDefaultContents = true, then call TableBeginContextMenuPopup()/.../EndPopup(). // - You may call TableDrawDefaultContextMenu() with selected flags to display specific sections of the default menu, // e.g. TableDrawDefaultContextMenu(table, table->Flags & ~ImGuiTableFlags_Hideable) will display everything EXCEPT columns visibility options. if (table->DisableDefaultContextMenu == false && TableBeginContextMenuPopup(table)) { TableDrawDefaultContextMenu(table, table->Flags); EndPopup(); } // [Part 12] Sanitize and build sort specs before we have a chance to use them for display. // This path will only be exercised when sort specs are modified before header rows (e.g. init or visibility change) if (table->IsSortSpecsDirty && (table->Flags & ImGuiTableFlags_Sortable)) TableSortSpecsBuild(table); // [Part 13] Setup inner window decoration size (for scrolling / nav tracking to properly take account of frozen rows/columns) if (table->FreezeColumnsRequest > 0) table->InnerWindow->DecoInnerSizeX1 = table->Columns[table->DisplayOrderToIndex[table->FreezeColumnsRequest - 1]].MaxX - table->OuterRect.Min.x; if (table->FreezeRowsRequest > 0) table->InnerWindow->DecoInnerSizeY1 = table_instance->LastFrozenHeight; table_instance->LastFrozenHeight = 0.0f; // Initial state ImGuiWindow* inner_window = table->InnerWindow; if (table->Flags & ImGuiTableFlags_NoClip) table->DrawSplitter->SetCurrentChannel(inner_window->DrawList, TABLE_DRAW_CHANNEL_NOCLIP); else inner_window->DrawList->PushClipRect(inner_window->InnerClipRect.Min, inner_window->InnerClipRect.Max, false); // FIXME: use table->InnerClipRect? } // Process hit-testing on resizing borders. Actual size change will be applied in EndTable() // - Set table->HoveredColumnBorder with a short delay/timer to reduce visual feedback noise. void ImGui::TableUpdateBorders(ImGuiTable* table) { ImGuiContext& g = *GImGui; IM_ASSERT(table->Flags & ImGuiTableFlags_Resizable); // At this point OuterRect height may be zero or under actual final height, so we rely on temporal coherency and // use the final height from last frame. Because this is only affecting _interaction_ with columns, it is not // really problematic (whereas the actual visual will be displayed in EndTable() and using the current frame height). // Actual columns highlight/render will be performed in EndTable() and not be affected. ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent); const float hit_half_width = ImTrunc(TABLE_RESIZE_SEPARATOR_HALF_THICKNESS * g.CurrentDpiScale); const float hit_y1 = (table->FreezeRowsCount >= 1 ? table->OuterRect.Min.y : table->WorkRect.Min.y) + table->AngledHeadersHeight; const float hit_y2_body = ImMax(table->OuterRect.Max.y, hit_y1 + table_instance->LastOuterHeight - table->AngledHeadersHeight); const float hit_y2_head = hit_y1 + table_instance->LastTopHeadersRowHeight; for (int order_n = 0; order_n < table->ColumnsCount; order_n++) { if (!IM_BITARRAY_TESTBIT(table->EnabledMaskByDisplayOrder, order_n)) continue; const int column_n = table->DisplayOrderToIndex[order_n]; ImGuiTableColumn* column = &table->Columns[column_n]; if (column->Flags & (ImGuiTableColumnFlags_NoResize | ImGuiTableColumnFlags_NoDirectResize_)) continue; // ImGuiTableFlags_NoBordersInBodyUntilResize will be honored in TableDrawBorders() const float border_y2_hit = (table->Flags & ImGuiTableFlags_NoBordersInBody) ? hit_y2_head : hit_y2_body; if ((table->Flags & ImGuiTableFlags_NoBordersInBody) && table->IsUsingHeaders == false) continue; if (!column->IsVisibleX && table->LastResizedColumn != column_n) continue; ImGuiID column_id = TableGetColumnResizeID(table, column_n, table->InstanceCurrent); ImRect hit_rect(column->MaxX - hit_half_width, hit_y1, column->MaxX + hit_half_width, border_y2_hit); ItemAdd(hit_rect, column_id, NULL, ImGuiItemFlags_NoNav); //GetForegroundDrawList()->AddRect(hit_rect.Min, hit_rect.Max, IM_COL32(255, 0, 0, 100)); bool hovered = false, held = false; bool pressed = ButtonBehavior(hit_rect, column_id, &hovered, &held, ImGuiButtonFlags_FlattenChildren | ImGuiButtonFlags_PressedOnClick | ImGuiButtonFlags_PressedOnDoubleClick | ImGuiButtonFlags_NoNavFocus); if (pressed && IsMouseDoubleClicked(0)) { TableSetColumnWidthAutoSingle(table, column_n); ClearActiveID(); held = false; } if (held) { if (table->LastResizedColumn == -1) table->ResizeLockMinContentsX2 = table->RightMostEnabledColumn != -1 ? table->Columns[table->RightMostEnabledColumn].MaxX : -FLT_MAX; table->ResizedColumn = (ImGuiTableColumnIdx)column_n; table->InstanceInteracted = table->InstanceCurrent; } if ((hovered && g.HoveredIdTimer > TABLE_RESIZE_SEPARATOR_FEEDBACK_TIMER) || held) { table->HoveredColumnBorder = (ImGuiTableColumnIdx)column_n; SetMouseCursor(ImGuiMouseCursor_ResizeEW); } } } void ImGui::EndTable() { ImGuiContext& g = *GImGui; ImGuiTable* table = g.CurrentTable; if (table == NULL) { IM_ASSERT_USER_ERROR(table != NULL, "EndTable() call should only be done while in BeginTable() scope!"); return; } // This assert would be very useful to catch a common error... unfortunately it would probably trigger in some // cases, and for consistency user may sometimes output empty tables (and still benefit from e.g. outer border) //IM_ASSERT(table->IsLayoutLocked && "Table unused: never called TableNextRow(), is that the intent?"); // If the user never got to call TableNextRow() or TableNextColumn(), we call layout ourselves to ensure all our // code paths are consistent (instead of just hoping that TableBegin/TableEnd will work), get borders drawn, etc. if (!table->IsLayoutLocked) TableUpdateLayout(table); const ImGuiTableFlags flags = table->Flags; ImGuiWindow* inner_window = table->InnerWindow; ImGuiWindow* outer_window = table->OuterWindow; ImGuiTableTempData* temp_data = table->TempData; IM_ASSERT(inner_window == g.CurrentWindow); IM_ASSERT(outer_window == inner_window || outer_window == inner_window->ParentWindow); if (table->IsInsideRow) TableEndRow(table); // Context menu in columns body if (flags & ImGuiTableFlags_ContextMenuInBody) if (table->HoveredColumnBody != -1 && !IsAnyItemHovered() && IsMouseReleased(ImGuiMouseButton_Right)) TableOpenContextMenu((int)table->HoveredColumnBody); // Finalize table height ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent); inner_window->DC.PrevLineSize = temp_data->HostBackupPrevLineSize; inner_window->DC.CurrLineSize = temp_data->HostBackupCurrLineSize; inner_window->DC.CursorMaxPos = temp_data->HostBackupCursorMaxPos; const float inner_content_max_y = table->RowPosY2; IM_ASSERT(table->RowPosY2 == inner_window->DC.CursorPos.y); if (inner_window != outer_window) inner_window->DC.CursorMaxPos.y = inner_content_max_y; else if (!(flags & ImGuiTableFlags_NoHostExtendY)) table->OuterRect.Max.y = table->InnerRect.Max.y = ImMax(table->OuterRect.Max.y, inner_content_max_y); // Patch OuterRect/InnerRect height table->WorkRect.Max.y = ImMax(table->WorkRect.Max.y, table->OuterRect.Max.y); table_instance->LastOuterHeight = table->OuterRect.GetHeight(); // Setup inner scrolling range // FIXME: This ideally should be done earlier, in BeginTable() SetNextWindowContentSize call, just like writing to inner_window->DC.CursorMaxPos.y, // but since the later is likely to be impossible to do we'd rather update both axes together. if (table->Flags & ImGuiTableFlags_ScrollX) { const float outer_padding_for_border = (table->Flags & ImGuiTableFlags_BordersOuterV) ? TABLE_BORDER_SIZE : 0.0f; float max_pos_x = table->InnerWindow->DC.CursorMaxPos.x; if (table->RightMostEnabledColumn != -1) max_pos_x = ImMax(max_pos_x, table->Columns[table->RightMostEnabledColumn].WorkMaxX + table->CellPaddingX + table->OuterPaddingX - outer_padding_for_border); if (table->ResizedColumn != -1) max_pos_x = ImMax(max_pos_x, table->ResizeLockMinContentsX2); table->InnerWindow->DC.CursorMaxPos.x = max_pos_x + table->TempData->AngledHeadersExtraWidth; } // Pop clipping rect if (!(flags & ImGuiTableFlags_NoClip)) inner_window->DrawList->PopClipRect(); inner_window->ClipRect = inner_window->DrawList->_ClipRectStack.back(); // Draw borders if ((flags & ImGuiTableFlags_Borders) != 0) TableDrawBorders(table); #if 0 // Strip out dummy channel draw calls // We have no way to prevent user submitting direct ImDrawList calls into a hidden column (but ImGui:: calls will be clipped out) // Pros: remove draw calls which will have no effect. since they'll have zero-size cliprect they may be early out anyway. // Cons: making it harder for users watching metrics/debugger to spot the wasted vertices. if (table->DummyDrawChannel != (ImGuiTableColumnIdx)-1) { ImDrawChannel* dummy_channel = &table->DrawSplitter._Channels[table->DummyDrawChannel]; dummy_channel->_CmdBuffer.resize(0); dummy_channel->_IdxBuffer.resize(0); } #endif // Flatten channels and merge draw calls ImDrawListSplitter* splitter = table->DrawSplitter; splitter->SetCurrentChannel(inner_window->DrawList, 0); if ((table->Flags & ImGuiTableFlags_NoClip) == 0) TableMergeDrawChannels(table); splitter->Merge(inner_window->DrawList); // Update ColumnsAutoFitWidth to get us ahead for host using our size to auto-resize without waiting for next BeginTable() float auto_fit_width_for_fixed = 0.0f; float auto_fit_width_for_stretched = 0.0f; float auto_fit_width_for_stretched_min = 0.0f; for (int column_n = 0; column_n < table->ColumnsCount; column_n++) if (IM_BITARRAY_TESTBIT(table->EnabledMaskByIndex, column_n)) { ImGuiTableColumn* column = &table->Columns[column_n]; float column_width_request = ((column->Flags & ImGuiTableColumnFlags_WidthFixed) && !(column->Flags & ImGuiTableColumnFlags_NoResize)) ? column->WidthRequest : TableGetColumnWidthAuto(table, column); if (column->Flags & ImGuiTableColumnFlags_WidthFixed) auto_fit_width_for_fixed += column_width_request; else auto_fit_width_for_stretched += column_width_request; if ((column->Flags & ImGuiTableColumnFlags_WidthStretch) && (column->Flags & ImGuiTableColumnFlags_NoResize) != 0) auto_fit_width_for_stretched_min = ImMax(auto_fit_width_for_stretched_min, column_width_request / (column->StretchWeight / table->ColumnsStretchSumWeights)); } const float width_spacings = (table->OuterPaddingX * 2.0f) + (table->CellSpacingX1 + table->CellSpacingX2) * (table->ColumnsEnabledCount - 1); table->ColumnsAutoFitWidth = width_spacings + (table->CellPaddingX * 2.0f) * table->ColumnsEnabledCount + auto_fit_width_for_fixed + ImMax(auto_fit_width_for_stretched, auto_fit_width_for_stretched_min); // Update scroll if ((table->Flags & ImGuiTableFlags_ScrollX) == 0 && inner_window != outer_window) { inner_window->Scroll.x = 0.0f; } else if (table->LastResizedColumn != -1 && table->ResizedColumn == -1 && inner_window->ScrollbarX && table->InstanceInteracted == table->InstanceCurrent) { // When releasing a column being resized, scroll to keep the resulting column in sight const float neighbor_width_to_keep_visible = table->MinColumnWidth + table->CellPaddingX * 2.0f; ImGuiTableColumn* column = &table->Columns[table->LastResizedColumn]; if (column->MaxX < table->InnerClipRect.Min.x) SetScrollFromPosX(inner_window, column->MaxX - inner_window->Pos.x - neighbor_width_to_keep_visible, 1.0f); else if (column->MaxX > table->InnerClipRect.Max.x) SetScrollFromPosX(inner_window, column->MaxX - inner_window->Pos.x + neighbor_width_to_keep_visible, 1.0f); } // Apply resizing/dragging at the end of the frame if (table->ResizedColumn != -1 && table->InstanceCurrent == table->InstanceInteracted) { ImGuiTableColumn* column = &table->Columns[table->ResizedColumn]; const float new_x2 = (g.IO.MousePos.x - g.ActiveIdClickOffset.x + ImTrunc(TABLE_RESIZE_SEPARATOR_HALF_THICKNESS * g.CurrentDpiScale)); const float new_width = ImTrunc(new_x2 - column->MinX - table->CellSpacingX1 - table->CellPaddingX * 2.0f); table->ResizedColumnNextWidth = new_width; } table->IsActiveIdInTable = (g.ActiveIdIsAlive != 0 && table->IsActiveIdAliveBeforeTable == false); // Pop from id stack IM_ASSERT_USER_ERROR(inner_window->IDStack.back() == table_instance->TableInstanceID, "Mismatching PushID/PopID!"); IM_ASSERT_USER_ERROR(outer_window->DC.ItemWidthStack.Size >= temp_data->HostBackupItemWidthStackSize, "Too many PopItemWidth!"); if (table->InstanceCurrent > 0) PopID(); PopID(); // Restore window data that we modified const ImVec2 backup_outer_max_pos = outer_window->DC.CursorMaxPos; inner_window->WorkRect = temp_data->HostBackupWorkRect; inner_window->ParentWorkRect = temp_data->HostBackupParentWorkRect; inner_window->SkipItems = table->HostSkipItems; outer_window->DC.CursorPos = table->OuterRect.Min; outer_window->DC.ItemWidth = temp_data->HostBackupItemWidth; outer_window->DC.ItemWidthStack.Size = temp_data->HostBackupItemWidthStackSize; outer_window->DC.ColumnsOffset = temp_data->HostBackupColumnsOffset; // Layout in outer window // (FIXME: To allow auto-fit and allow desirable effect of SameLine() we dissociate 'used' vs 'ideal' size by overriding // CursorPosPrevLine and CursorMaxPos manually. That should be a more general layout feature, see same problem e.g. #3414) if (inner_window != outer_window) { short backup_nav_layers_active_mask = inner_window->DC.NavLayersActiveMask; inner_window->DC.NavLayersActiveMask |= 1 << table->NavLayer; // So empty table don't appear to navigate differently. g.CurrentTable = NULL; // To avoid error recovery recursing EndChild(); g.CurrentTable = table; inner_window->DC.NavLayersActiveMask = backup_nav_layers_active_mask; } else { ItemSize(table->OuterRect.GetSize()); ItemAdd(table->OuterRect, 0); } // Override declared contents width/height to enable auto-resize while not needlessly adding a scrollbar if (table->Flags & ImGuiTableFlags_NoHostExtendX) { // FIXME-TABLE: Could we remove this section? // ColumnsAutoFitWidth may be one frame ahead here since for Fixed+NoResize is calculated from latest contents IM_ASSERT((table->Flags & ImGuiTableFlags_ScrollX) == 0); outer_window->DC.CursorMaxPos.x = ImMax(backup_outer_max_pos.x, table->OuterRect.Min.x + table->ColumnsAutoFitWidth); } else if (temp_data->UserOuterSize.x <= 0.0f) { // Some references for this: #7651 + tests "table_reported_size", "table_reported_size_outer" equivalent Y block // - Checking for ImGuiTableFlags_ScrollX/ScrollY flag makes us a frame ahead when disabling those flags. // - FIXME-TABLE: Would make sense to pre-compute expected scrollbar visibility/sizes to generally save a frame of feedback. const float inner_content_max_x = table->OuterRect.Min.x + table->ColumnsAutoFitWidth; // Slightly misleading name but used for code symmetry with inner_content_max_y const float decoration_size = table->TempData->AngledHeadersExtraWidth + ((table->Flags & ImGuiTableFlags_ScrollY) ? inner_window->ScrollbarSizes.x : 0.0f); outer_window->DC.IdealMaxPos.x = ImMax(outer_window->DC.IdealMaxPos.x, inner_content_max_x + decoration_size - temp_data->UserOuterSize.x); outer_window->DC.CursorMaxPos.x = ImMax(backup_outer_max_pos.x, ImMin(table->OuterRect.Max.x, inner_content_max_x + decoration_size)); } else { outer_window->DC.CursorMaxPos.x = ImMax(backup_outer_max_pos.x, table->OuterRect.Max.x); } if (temp_data->UserOuterSize.y <= 0.0f) { const float decoration_size = (table->Flags & ImGuiTableFlags_ScrollX) ? inner_window->ScrollbarSizes.y : 0.0f; outer_window->DC.IdealMaxPos.y = ImMax(outer_window->DC.IdealMaxPos.y, inner_content_max_y + decoration_size - temp_data->UserOuterSize.y); outer_window->DC.CursorMaxPos.y = ImMax(backup_outer_max_pos.y, ImMin(table->OuterRect.Max.y, inner_content_max_y + decoration_size)); } else { // OuterRect.Max.y may already have been pushed downward from the initial value (unless ImGuiTableFlags_NoHostExtendY is set) outer_window->DC.CursorMaxPos.y = ImMax(backup_outer_max_pos.y, table->OuterRect.Max.y); } // Save settings if (table->IsSettingsDirty) TableSaveSettings(table); table->IsInitializing = false; // Clear or restore current table, if any IM_ASSERT(g.CurrentWindow == outer_window && g.CurrentTable == table); IM_ASSERT(g.TablesTempDataStacked > 0); temp_data = (--g.TablesTempDataStacked > 0) ? &g.TablesTempData[g.TablesTempDataStacked - 1] : NULL; g.CurrentTable = temp_data ? g.Tables.GetByIndex(temp_data->TableIndex) : NULL; if (g.CurrentTable) { g.CurrentTable->TempData = temp_data; g.CurrentTable->DrawSplitter = &temp_data->DrawSplitter; } outer_window->DC.CurrentTableIdx = g.CurrentTable ? g.Tables.GetIndex(g.CurrentTable) : -1; NavUpdateCurrentWindowIsScrollPushableX(); } // Called in TableSetupColumn() when initializing and in TableLoadSettings() for defaults before applying stored settings. // 'init_mask' specify which fields to initialize. static void TableInitColumnDefaults(ImGuiTable* table, ImGuiTableColumn* column, ImGuiTableColumnFlags init_mask) { ImGuiTableColumnFlags flags = column->Flags; if (init_mask & ImGuiTableFlags_Resizable) { float init_width_or_weight = column->InitStretchWeightOrWidth; column->WidthRequest = ((flags & ImGuiTableColumnFlags_WidthFixed) && init_width_or_weight > 0.0f) ? init_width_or_weight : -1.0f; column->StretchWeight = (init_width_or_weight > 0.0f && (flags & ImGuiTableColumnFlags_WidthStretch)) ? init_width_or_weight : -1.0f; if (init_width_or_weight > 0.0f) // Disable auto-fit if an explicit width/weight has been specified column->AutoFitQueue = 0x00; } if (init_mask & ImGuiTableFlags_Reorderable) column->DisplayOrder = (ImGuiTableColumnIdx)table->Columns.index_from_ptr(column); if (init_mask & ImGuiTableFlags_Hideable) column->IsUserEnabled = column->IsUserEnabledNextFrame = (flags & ImGuiTableColumnFlags_DefaultHide) ? 0 : 1; if (init_mask & ImGuiTableFlags_Sortable) { // Multiple columns using _DefaultSort will be reassigned unique SortOrder values when building the sort specs. column->SortOrder = (flags & ImGuiTableColumnFlags_DefaultSort) ? 0 : -1; column->SortDirection = (flags & ImGuiTableColumnFlags_DefaultSort) ? ((flags & ImGuiTableColumnFlags_PreferSortDescending) ? (ImS8)ImGuiSortDirection_Descending : (ImU8)(ImGuiSortDirection_Ascending)) : (ImS8)ImGuiSortDirection_None; } } // See "COLUMNS SIZING POLICIES" comments at the top of this file // If (init_width_or_weight <= 0.0f) it is ignored void ImGui::TableSetupColumn(const char* label, ImGuiTableColumnFlags flags, float init_width_or_weight, ImGuiID user_id) { ImGuiContext& g = *GImGui; ImGuiTable* table = g.CurrentTable; if (table == NULL) { IM_ASSERT_USER_ERROR(table != NULL, "Call should only be done while in BeginTable() scope!"); return; } IM_ASSERT(table->IsLayoutLocked == false && "Need to call TableSetupColumn() before first row!"); IM_ASSERT((flags & ImGuiTableColumnFlags_StatusMask_) == 0 && "Illegal to pass StatusMask values to TableSetupColumn()"); if (table->DeclColumnsCount >= table->ColumnsCount) { IM_ASSERT_USER_ERROR(table->DeclColumnsCount < table->ColumnsCount, "Called TableSetupColumn() too many times!"); return; } ImGuiTableColumn* column = &table->Columns[table->DeclColumnsCount]; table->DeclColumnsCount++; // Assert when passing a width or weight if policy is entirely left to default, to avoid storing width into weight and vice-versa. // Give a grace to users of ImGuiTableFlags_ScrollX. if (table->IsDefaultSizingPolicy && (flags & ImGuiTableColumnFlags_WidthMask_) == 0 && (flags & ImGuiTableFlags_ScrollX) == 0) IM_ASSERT(init_width_or_weight <= 0.0f && "Can only specify width/weight if sizing policy is set explicitly in either Table or Column."); // When passing a width automatically enforce WidthFixed policy // (whereas TableSetupColumnFlags would default to WidthAuto if table is not resizable) if ((flags & ImGuiTableColumnFlags_WidthMask_) == 0 && init_width_or_weight > 0.0f) if ((table->Flags & ImGuiTableFlags_SizingMask_) == ImGuiTableFlags_SizingFixedFit || (table->Flags & ImGuiTableFlags_SizingMask_) == ImGuiTableFlags_SizingFixedSame) flags |= ImGuiTableColumnFlags_WidthFixed; if (flags & ImGuiTableColumnFlags_AngledHeader) { flags |= ImGuiTableColumnFlags_NoHeaderLabel; table->AngledHeadersCount++; } TableSetupColumnFlags(table, column, flags); column->UserID = user_id; flags = column->Flags; // Initialize defaults column->InitStretchWeightOrWidth = init_width_or_weight; if (table->IsInitializing) { ImGuiTableFlags init_flags = ~table->SettingsLoadedFlags; if (column->WidthRequest < 0.0f && column->StretchWeight < 0.0f) init_flags |= ImGuiTableFlags_Resizable; TableInitColumnDefaults(table, column, init_flags); } // Store name (append with zero-terminator in contiguous buffer) // FIXME: If we recorded the number of \n in names we could compute header row height column->NameOffset = -1; if (label != NULL && label[0] != 0) { column->NameOffset = (ImS16)table->ColumnsNames.size(); table->ColumnsNames.append(label, label + ImStrlen(label) + 1); } } // [Public] void ImGui::TableSetupScrollFreeze(int columns, int rows) { ImGuiContext& g = *GImGui; ImGuiTable* table = g.CurrentTable; if (table == NULL) { IM_ASSERT_USER_ERROR(table != NULL, "Call should only be done while in BeginTable() scope!"); return; } IM_ASSERT(table->IsLayoutLocked == false && "Need to call TableSetupColumn() before first row!"); IM_ASSERT(columns >= 0 && columns < IMGUI_TABLE_MAX_COLUMNS); IM_ASSERT(rows >= 0 && rows < 128); // Arbitrary limit table->FreezeColumnsRequest = (table->Flags & ImGuiTableFlags_ScrollX) ? (ImGuiTableColumnIdx)ImMin(columns, table->ColumnsCount) : 0; table->FreezeColumnsCount = (table->InnerWindow->Scroll.x != 0.0f) ? table->FreezeColumnsRequest : 0; table->FreezeRowsRequest = (table->Flags & ImGuiTableFlags_ScrollY) ? (ImGuiTableColumnIdx)rows : 0; table->FreezeRowsCount = (table->InnerWindow->Scroll.y != 0.0f) ? table->FreezeRowsRequest : 0; table->IsUnfrozenRows = (table->FreezeRowsCount == 0); // Make sure this is set before TableUpdateLayout() so ImGuiListClipper can benefit from it.b // Ensure frozen columns are ordered in their section. We still allow multiple frozen columns to be reordered. // FIXME-TABLE: This work for preserving 2143 into 21|43. How about 4321 turning into 21|43? (preserve relative order in each section) for (int column_n = 0; column_n < table->FreezeColumnsRequest; column_n++) { int order_n = table->DisplayOrderToIndex[column_n]; if (order_n != column_n && order_n >= table->FreezeColumnsRequest) { ImSwap(table->Columns[table->DisplayOrderToIndex[order_n]].DisplayOrder, table->Columns[table->DisplayOrderToIndex[column_n]].DisplayOrder); ImSwap(table->DisplayOrderToIndex[order_n], table->DisplayOrderToIndex[column_n]); } } } //----------------------------------------------------------------------------- // [SECTION] Tables: Simple accessors //----------------------------------------------------------------------------- // - TableGetColumnCount() // - TableGetColumnName() // - TableGetColumnName() [Internal] // - TableSetColumnEnabled() // - TableGetColumnFlags() // - TableGetCellBgRect() [Internal] // - TableGetColumnResizeID() [Internal] // - TableGetHoveredColumn() [Internal] // - TableGetHoveredRow() [Internal] // - TableSetBgColor() //----------------------------------------------------------------------------- int ImGui::TableGetColumnCount() { ImGuiContext& g = *GImGui; ImGuiTable* table = g.CurrentTable; return table ? table->ColumnsCount : 0; } const char* ImGui::TableGetColumnName(int column_n) { ImGuiContext& g = *GImGui; ImGuiTable* table = g.CurrentTable; if (!table) return NULL; if (column_n < 0) column_n = table->CurrentColumn; return TableGetColumnName(table, column_n); } const char* ImGui::TableGetColumnName(const ImGuiTable* table, int column_n) { if (table->IsLayoutLocked == false && column_n >= table->DeclColumnsCount) return ""; // NameOffset is invalid at this point const ImGuiTableColumn* column = &table->Columns[column_n]; if (column->NameOffset == -1) return ""; return &table->ColumnsNames.Buf[column->NameOffset]; } // Change user accessible enabled/disabled state of a column (often perceived as "showing/hiding" from users point of view) // Note that end-user can use the context menu to change this themselves (right-click in headers, or right-click in columns body with ImGuiTableFlags_ContextMenuInBody) // - Require table to have the ImGuiTableFlags_Hideable flag because we are manipulating user accessible state. // - Request will be applied during next layout, which happens on the first call to TableNextRow() after BeginTable(). // - For the getter you can test (TableGetColumnFlags() & ImGuiTableColumnFlags_IsEnabled) != 0. // - Alternative: the ImGuiTableColumnFlags_Disabled is an overriding/master disable flag which will also hide the column from context menu. void ImGui::TableSetColumnEnabled(int column_n, bool enabled) { ImGuiContext& g = *GImGui; ImGuiTable* table = g.CurrentTable; if (table == NULL) { IM_ASSERT_USER_ERROR(table != NULL, "Call should only be done while in BeginTable() scope!"); return; } IM_ASSERT(table->Flags & ImGuiTableFlags_Hideable); // See comments above if (column_n < 0) column_n = table->CurrentColumn; IM_ASSERT(column_n >= 0 && column_n < table->ColumnsCount); ImGuiTableColumn* column = &table->Columns[column_n]; column->IsUserEnabledNextFrame = enabled; } // We allow querying for an extra column in order to poll the IsHovered state of the right-most section ImGuiTableColumnFlags ImGui::TableGetColumnFlags(int column_n) { ImGuiContext& g = *GImGui; ImGuiTable* table = g.CurrentTable; if (!table) return ImGuiTableColumnFlags_None; if (column_n < 0) column_n = table->CurrentColumn; if (column_n == table->ColumnsCount) return (table->HoveredColumnBody == column_n) ? ImGuiTableColumnFlags_IsHovered : ImGuiTableColumnFlags_None; return table->Columns[column_n].Flags; } // Return the cell rectangle based on currently known height. // - Important: we generally don't know our row height until the end of the row, so Max.y will be incorrect in many situations. // The only case where this is correct is if we provided a min_row_height to TableNextRow() and don't go below it, or in TableEndRow() when we locked that height. // - Important: if ImGuiTableFlags_PadOuterX is set but ImGuiTableFlags_PadInnerX is not set, the outer-most left and right // columns report a small offset so their CellBgRect can extend up to the outer border. // FIXME: But the rendering code in TableEndRow() nullifies that with clamping required for scrolling. ImRect ImGui::TableGetCellBgRect(const ImGuiTable* table, int column_n) { const ImGuiTableColumn* column = &table->Columns[column_n]; float x1 = column->MinX; float x2 = column->MaxX; //if (column->PrevEnabledColumn == -1) // x1 -= table->OuterPaddingX; //if (column->NextEnabledColumn == -1) // x2 += table->OuterPaddingX; x1 = ImMax(x1, table->WorkRect.Min.x); x2 = ImMin(x2, table->WorkRect.Max.x); return ImRect(x1, table->RowPosY1, x2, table->RowPosY2); } // Return the resizing ID for the right-side of the given column. ImGuiID ImGui::TableGetColumnResizeID(ImGuiTable* table, int column_n, int instance_no) { IM_ASSERT(column_n >= 0 && column_n < table->ColumnsCount); ImGuiID instance_id = TableGetInstanceID(table, instance_no); return instance_id + 1 + column_n; // FIXME: #6140: still not ideal } // Return -1 when table is not hovered. return columns_count if hovering the unused space at the right of the right-most visible column. int ImGui::TableGetHoveredColumn() { ImGuiContext& g = *GImGui; ImGuiTable* table = g.CurrentTable; if (!table) return -1; return (int)table->HoveredColumnBody; } // Return -1 when table is not hovered. Return maxrow+1 if in table but below last submitted row. // *IMPORTANT* Unlike TableGetHoveredColumn(), this has a one frame latency in updating the value. // This difference with is the reason why this is not public yet. int ImGui::TableGetHoveredRow() { ImGuiContext& g = *GImGui; ImGuiTable* table = g.CurrentTable; if (!table) return -1; ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent); return (int)table_instance->HoveredRowLast; } void ImGui::TableSetBgColor(ImGuiTableBgTarget target, ImU32 color, int column_n) { ImGuiContext& g = *GImGui; ImGuiTable* table = g.CurrentTable; IM_ASSERT(target != ImGuiTableBgTarget_None); if (color == IM_COL32_DISABLE) color = 0; // We cannot draw neither the cell or row background immediately as we don't know the row height at this point in time. switch (target) { case ImGuiTableBgTarget_CellBg: { if (table->RowPosY1 > table->InnerClipRect.Max.y) // Discard return; if (column_n == -1) column_n = table->CurrentColumn; if (!IM_BITARRAY_TESTBIT(table->VisibleMaskByIndex, column_n)) return; if (table->RowCellDataCurrent < 0 || table->RowCellData[table->RowCellDataCurrent].Column != column_n) table->RowCellDataCurrent++; ImGuiTableCellData* cell_data = &table->RowCellData[table->RowCellDataCurrent]; cell_data->BgColor = color; cell_data->Column = (ImGuiTableColumnIdx)column_n; break; } case ImGuiTableBgTarget_RowBg0: case ImGuiTableBgTarget_RowBg1: { if (table->RowPosY1 > table->InnerClipRect.Max.y) // Discard return; IM_ASSERT(column_n == -1); int bg_idx = (target == ImGuiTableBgTarget_RowBg1) ? 1 : 0; table->RowBgColor[bg_idx] = color; break; } default: IM_ASSERT(0); } } //------------------------------------------------------------------------- // [SECTION] Tables: Row changes //------------------------------------------------------------------------- // - TableGetRowIndex() // - TableNextRow() // - TableBeginRow() [Internal] // - TableEndRow() [Internal] //------------------------------------------------------------------------- // [Public] Note: for row coloring we use ->RowBgColorCounter which is the same value without counting header rows int ImGui::TableGetRowIndex() { ImGuiContext& g = *GImGui; ImGuiTable* table = g.CurrentTable; if (!table) return 0; return table->CurrentRow; } // [Public] Starts into the first cell of a new row void ImGui::TableNextRow(ImGuiTableRowFlags row_flags, float row_min_height) { ImGuiContext& g = *GImGui; ImGuiTable* table = g.CurrentTable; if (!table->IsLayoutLocked) TableUpdateLayout(table); if (table->IsInsideRow) TableEndRow(table); table->LastRowFlags = table->RowFlags; table->RowFlags = row_flags; table->RowCellPaddingY = g.Style.CellPadding.y; table->RowMinHeight = row_min_height; TableBeginRow(table); // We honor min_row_height requested by user, but cannot guarantee per-row maximum height, // because that would essentially require a unique clipping rectangle per-cell. table->RowPosY2 += table->RowCellPaddingY * 2.0f; table->RowPosY2 = ImMax(table->RowPosY2, table->RowPosY1 + row_min_height); // Disable output until user calls TableNextColumn() table->InnerWindow->SkipItems = true; } // [Internal] Only called by TableNextRow() void ImGui::TableBeginRow(ImGuiTable* table) { ImGuiWindow* window = table->InnerWindow; IM_ASSERT(!table->IsInsideRow); // New row table->CurrentRow++; table->CurrentColumn = -1; table->RowBgColor[0] = table->RowBgColor[1] = IM_COL32_DISABLE; table->RowCellDataCurrent = -1; table->IsInsideRow = true; // Begin frozen rows float next_y1 = table->RowPosY2; if (table->CurrentRow == 0 && table->FreezeRowsCount > 0) next_y1 = window->DC.CursorPos.y = table->OuterRect.Min.y; table->RowPosY1 = table->RowPosY2 = next_y1; table->RowTextBaseline = 0.0f; table->RowIndentOffsetX = window->DC.Indent.x - table->HostIndentX; // Lock indent window->DC.PrevLineTextBaseOffset = 0.0f; window->DC.CursorPosPrevLine = ImVec2(window->DC.CursorPos.x, window->DC.CursorPos.y + table->RowCellPaddingY); // This allows users to call SameLine() to share LineSize between columns. window->DC.PrevLineSize = window->DC.CurrLineSize = ImVec2(0.0f, 0.0f); // This allows users to call SameLine() to share LineSize between columns, and to call it from first column too. window->DC.IsSameLine = window->DC.IsSetPos = false; window->DC.CursorMaxPos.y = next_y1; // Making the header BG color non-transparent will allow us to overlay it multiple times when handling smooth dragging. if (table->RowFlags & ImGuiTableRowFlags_Headers) { TableSetBgColor(ImGuiTableBgTarget_RowBg0, GetColorU32(ImGuiCol_TableHeaderBg)); if (table->CurrentRow == 0) table->IsUsingHeaders = true; } } // [Internal] Called by TableNextRow() void ImGui::TableEndRow(ImGuiTable* table) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; IM_ASSERT(window == table->InnerWindow); IM_ASSERT(table->IsInsideRow); if (table->CurrentColumn != -1) TableEndCell(table); // Logging if (g.LogEnabled) LogRenderedText(NULL, "|"); // Position cursor at the bottom of our row so it can be used for e.g. clipping calculation. However it is // likely that the next call to TableBeginCell() will reposition the cursor to take account of vertical padding. window->DC.CursorPos.y = table->RowPosY2; // Row background fill const float bg_y1 = table->RowPosY1; const float bg_y2 = table->RowPosY2; const bool unfreeze_rows_actual = (table->CurrentRow + 1 == table->FreezeRowsCount); const bool unfreeze_rows_request = (table->CurrentRow + 1 == table->FreezeRowsRequest); ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent); if ((table->RowFlags & ImGuiTableRowFlags_Headers) && (table->CurrentRow == 0 || (table->LastRowFlags & ImGuiTableRowFlags_Headers))) table_instance->LastTopHeadersRowHeight += bg_y2 - bg_y1; const bool is_visible = (bg_y2 >= table->InnerClipRect.Min.y && bg_y1 <= table->InnerClipRect.Max.y); if (is_visible) { // Update data for TableGetHoveredRow() if (table->HoveredColumnBody != -1 && g.IO.MousePos.y >= bg_y1 && g.IO.MousePos.y < bg_y2 && table_instance->HoveredRowNext < 0) table_instance->HoveredRowNext = table->CurrentRow; // Decide of background color for the row ImU32 bg_col0 = 0; ImU32 bg_col1 = 0; if (table->RowBgColor[0] != IM_COL32_DISABLE) bg_col0 = table->RowBgColor[0]; else if (table->Flags & ImGuiTableFlags_RowBg) bg_col0 = GetColorU32((table->RowBgColorCounter & 1) ? ImGuiCol_TableRowBgAlt : ImGuiCol_TableRowBg); if (table->RowBgColor[1] != IM_COL32_DISABLE) bg_col1 = table->RowBgColor[1]; // Decide of top border color ImU32 top_border_col = 0; const float border_size = TABLE_BORDER_SIZE; if (table->CurrentRow > 0 && (table->Flags & ImGuiTableFlags_BordersInnerH)) top_border_col = (table->LastRowFlags & ImGuiTableRowFlags_Headers) ? table->BorderColorStrong : table->BorderColorLight; const bool draw_cell_bg_color = table->RowCellDataCurrent >= 0; const bool draw_strong_bottom_border = unfreeze_rows_actual; if ((bg_col0 | bg_col1 | top_border_col) != 0 || draw_strong_bottom_border || draw_cell_bg_color) { // In theory we could call SetWindowClipRectBeforeSetChannel() but since we know TableEndRow() is // always followed by a change of clipping rectangle we perform the smallest overwrite possible here. if ((table->Flags & ImGuiTableFlags_NoClip) == 0) window->DrawList->_CmdHeader.ClipRect = table->Bg0ClipRectForDrawCmd.ToVec4(); table->DrawSplitter->SetCurrentChannel(window->DrawList, TABLE_DRAW_CHANNEL_BG0); } // Draw row background // We soft/cpu clip this so all backgrounds and borders can share the same clipping rectangle if (bg_col0 || bg_col1) { ImRect row_rect(table->WorkRect.Min.x, bg_y1, table->WorkRect.Max.x, bg_y2); row_rect.ClipWith(table->BgClipRect); if (bg_col0 != 0 && row_rect.Min.y < row_rect.Max.y) window->DrawList->AddRectFilled(row_rect.Min, row_rect.Max, bg_col0); if (bg_col1 != 0 && row_rect.Min.y < row_rect.Max.y) window->DrawList->AddRectFilled(row_rect.Min, row_rect.Max, bg_col1); } // Draw cell background color if (draw_cell_bg_color) { ImGuiTableCellData* cell_data_end = &table->RowCellData[table->RowCellDataCurrent]; for (ImGuiTableCellData* cell_data = &table->RowCellData[0]; cell_data <= cell_data_end; cell_data++) { // As we render the BG here we need to clip things (for layout we would not) // FIXME: This cancels the OuterPadding addition done by TableGetCellBgRect(), need to keep it while rendering correctly while scrolling. const ImGuiTableColumn* column = &table->Columns[cell_data->Column]; ImRect cell_bg_rect = TableGetCellBgRect(table, cell_data->Column); cell_bg_rect.ClipWith(table->BgClipRect); cell_bg_rect.Min.x = ImMax(cell_bg_rect.Min.x, column->ClipRect.Min.x); // So that first column after frozen one gets clipped when scrolling cell_bg_rect.Max.x = ImMin(cell_bg_rect.Max.x, column->MaxX); if (cell_bg_rect.Min.y < cell_bg_rect.Max.y) window->DrawList->AddRectFilled(cell_bg_rect.Min, cell_bg_rect.Max, cell_data->BgColor); } } // Draw top border if (top_border_col && bg_y1 >= table->BgClipRect.Min.y && bg_y1 < table->BgClipRect.Max.y) window->DrawList->AddLine(ImVec2(table->BorderX1, bg_y1), ImVec2(table->BorderX2, bg_y1), top_border_col, border_size); // Draw bottom border at the row unfreezing mark (always strong) if (draw_strong_bottom_border && bg_y2 >= table->BgClipRect.Min.y && bg_y2 < table->BgClipRect.Max.y) window->DrawList->AddLine(ImVec2(table->BorderX1, bg_y2), ImVec2(table->BorderX2, bg_y2), table->BorderColorStrong, border_size); } // End frozen rows (when we are past the last frozen row line, teleport cursor and alter clipping rectangle) // We need to do that in TableEndRow() instead of TableBeginRow() so the list clipper can mark end of row and // get the new cursor position. if (unfreeze_rows_request) { for (int column_n = 0; column_n < table->ColumnsCount; column_n++) table->Columns[column_n].NavLayerCurrent = table->NavLayer; const float y0 = ImMax(table->RowPosY2 + 1, table->InnerClipRect.Min.y); table_instance->LastFrozenHeight = y0 - table->OuterRect.Min.y; if (unfreeze_rows_actual) { IM_ASSERT(table->IsUnfrozenRows == false); table->IsUnfrozenRows = true; // BgClipRect starts as table->InnerClipRect, reduce it now and make BgClipRectForDrawCmd == BgClipRect table->BgClipRect.Min.y = table->Bg2ClipRectForDrawCmd.Min.y = ImMin(y0, table->InnerClipRect.Max.y); table->BgClipRect.Max.y = table->Bg2ClipRectForDrawCmd.Max.y = table->InnerClipRect.Max.y; table->Bg2DrawChannelCurrent = table->Bg2DrawChannelUnfrozen; IM_ASSERT(table->Bg2ClipRectForDrawCmd.Min.y <= table->Bg2ClipRectForDrawCmd.Max.y); float row_height = table->RowPosY2 - table->RowPosY1; table->RowPosY2 = window->DC.CursorPos.y = table->WorkRect.Min.y + table->RowPosY2 - table->OuterRect.Min.y; table->RowPosY1 = table->RowPosY2 - row_height; for (int column_n = 0; column_n < table->ColumnsCount; column_n++) { ImGuiTableColumn* column = &table->Columns[column_n]; column->DrawChannelCurrent = column->DrawChannelUnfrozen; column->ClipRect.Min.y = table->Bg2ClipRectForDrawCmd.Min.y; } // Update cliprect ahead of TableBeginCell() so clipper can access to new ClipRect->Min.y SetWindowClipRectBeforeSetChannel(window, table->Columns[0].ClipRect); table->DrawSplitter->SetCurrentChannel(window->DrawList, table->Columns[0].DrawChannelCurrent); } } if (!(table->RowFlags & ImGuiTableRowFlags_Headers)) table->RowBgColorCounter++; table->IsInsideRow = false; } //------------------------------------------------------------------------- // [SECTION] Tables: Columns changes //------------------------------------------------------------------------- // - TableGetColumnIndex() // - TableSetColumnIndex() // - TableNextColumn() // - TableBeginCell() [Internal] // - TableEndCell() [Internal] //------------------------------------------------------------------------- int ImGui::TableGetColumnIndex() { ImGuiContext& g = *GImGui; ImGuiTable* table = g.CurrentTable; if (!table) return 0; return table->CurrentColumn; } // [Public] Append into a specific column bool ImGui::TableSetColumnIndex(int column_n) { ImGuiContext& g = *GImGui; ImGuiTable* table = g.CurrentTable; if (!table) return false; if (table->CurrentColumn != column_n) { if (table->CurrentColumn != -1) TableEndCell(table); if ((column_n >= 0 && column_n < table->ColumnsCount) == false) { IM_ASSERT_USER_ERROR(column_n >= 0 && column_n < table->ColumnsCount, "TableSetColumnIndex() invalid column index!"); return false; } TableBeginCell(table, column_n); } // Return whether the column is visible. User may choose to skip submitting items based on this return value, // however they shouldn't skip submitting for columns that may have the tallest contribution to row height. return table->Columns[column_n].IsRequestOutput; } // [Public] Append into the next column, wrap and create a new row when already on last column bool ImGui::TableNextColumn() { ImGuiContext& g = *GImGui; ImGuiTable* table = g.CurrentTable; if (!table) return false; if (table->IsInsideRow && table->CurrentColumn + 1 < table->ColumnsCount) { if (table->CurrentColumn != -1) TableEndCell(table); TableBeginCell(table, table->CurrentColumn + 1); } else { TableNextRow(); TableBeginCell(table, 0); } // Return whether the column is visible. User may choose to skip submitting items based on this return value, // however they shouldn't skip submitting for columns that may have the tallest contribution to row height. return table->Columns[table->CurrentColumn].IsRequestOutput; } // [Internal] Called by TableSetColumnIndex()/TableNextColumn() // This is called very frequently, so we need to be mindful of unnecessary overhead. // FIXME-TABLE FIXME-OPT: Could probably shortcut some things for non-active or clipped columns. void ImGui::TableBeginCell(ImGuiTable* table, int column_n) { ImGuiContext& g = *GImGui; ImGuiTableColumn* column = &table->Columns[column_n]; ImGuiWindow* window = table->InnerWindow; table->CurrentColumn = column_n; // Start position is roughly ~~ CellRect.Min + CellPadding + Indent float start_x = column->WorkMinX; if (column->Flags & ImGuiTableColumnFlags_IndentEnable) start_x += table->RowIndentOffsetX; // ~~ += window.DC.Indent.x - table->HostIndentX, except we locked it for the row. window->DC.CursorPos.x = start_x; window->DC.CursorPos.y = table->RowPosY1 + table->RowCellPaddingY; window->DC.CursorMaxPos.x = window->DC.CursorPos.x; window->DC.ColumnsOffset.x = start_x - window->Pos.x - window->DC.Indent.x; // FIXME-WORKRECT window->DC.CursorPosPrevLine.x = window->DC.CursorPos.x; // PrevLine.y is preserved. This allows users to call SameLine() to share LineSize between columns. window->DC.CurrLineTextBaseOffset = table->RowTextBaseline; window->DC.NavLayerCurrent = (ImGuiNavLayer)column->NavLayerCurrent; // Note how WorkRect.Max.y is only set once during layout window->WorkRect.Min.y = window->DC.CursorPos.y; window->WorkRect.Min.x = column->WorkMinX; window->WorkRect.Max.x = column->WorkMaxX; window->DC.ItemWidth = column->ItemWidth; window->SkipItems = column->IsSkipItems; if (column->IsSkipItems) { g.LastItemData.ID = 0; g.LastItemData.StatusFlags = 0; } if (table->Flags & ImGuiTableFlags_NoClip) { // FIXME: if we end up drawing all borders/bg in EndTable, could remove this and just assert that channel hasn't changed. table->DrawSplitter->SetCurrentChannel(window->DrawList, TABLE_DRAW_CHANNEL_NOCLIP); //IM_ASSERT(table->DrawSplitter._Current == TABLE_DRAW_CHANNEL_NOCLIP); } else { // FIXME-TABLE: Could avoid this if draw channel is dummy channel? SetWindowClipRectBeforeSetChannel(window, column->ClipRect); table->DrawSplitter->SetCurrentChannel(window->DrawList, column->DrawChannelCurrent); } // Logging if (g.LogEnabled && !column->IsSkipItems) { LogRenderedText(&window->DC.CursorPos, "|"); g.LogLinePosY = FLT_MAX; } } // [Internal] Called by TableNextRow()/TableSetColumnIndex()/TableNextColumn() void ImGui::TableEndCell(ImGuiTable* table) { ImGuiTableColumn* column = &table->Columns[table->CurrentColumn]; ImGuiWindow* window = table->InnerWindow; if (window->DC.IsSetPos) ErrorCheckUsingSetCursorPosToExtendParentBoundaries(); // Report maximum position so we can infer content size per column. float* p_max_pos_x; if (table->RowFlags & ImGuiTableRowFlags_Headers) p_max_pos_x = &column->ContentMaxXHeadersUsed; // Useful in case user submit contents in header row that is not a TableHeader() call else p_max_pos_x = table->IsUnfrozenRows ? &column->ContentMaxXUnfrozen : &column->ContentMaxXFrozen; *p_max_pos_x = ImMax(*p_max_pos_x, window->DC.CursorMaxPos.x); if (column->IsEnabled) table->RowPosY2 = ImMax(table->RowPosY2, window->DC.CursorMaxPos.y + table->RowCellPaddingY); column->ItemWidth = window->DC.ItemWidth; // Propagate text baseline for the entire row // FIXME-TABLE: Here we propagate text baseline from the last line of the cell.. instead of the first one. table->RowTextBaseline = ImMax(table->RowTextBaseline, window->DC.PrevLineTextBaseOffset); } //------------------------------------------------------------------------- // [SECTION] Tables: Columns width management //------------------------------------------------------------------------- // - TableGetMaxColumnWidth() [Internal] // - TableGetColumnWidthAuto() [Internal] // - TableSetColumnWidth() // - TableSetColumnWidthAutoSingle() [Internal] // - TableSetColumnWidthAutoAll() [Internal] // - TableUpdateColumnsWeightFromWidth() [Internal] //------------------------------------------------------------------------- // Note that actual columns widths are computed in TableUpdateLayout(). //------------------------------------------------------------------------- // Maximum column content width given current layout. Use column->MinX so this value differs on a per-column basis. float ImGui::TableCalcMaxColumnWidth(const ImGuiTable* table, int column_n) { const ImGuiTableColumn* column = &table->Columns[column_n]; float max_width = FLT_MAX; const float min_column_distance = table->MinColumnWidth + table->CellPaddingX * 2.0f + table->CellSpacingX1 + table->CellSpacingX2; if (table->Flags & ImGuiTableFlags_ScrollX) { // Frozen columns can't reach beyond visible width else scrolling will naturally break. // (we use DisplayOrder as within a set of multiple frozen column reordering is possible) if (column->DisplayOrder < table->FreezeColumnsRequest) { max_width = (table->InnerClipRect.Max.x - (table->FreezeColumnsRequest - column->DisplayOrder) * min_column_distance) - column->MinX; max_width = max_width - table->OuterPaddingX - table->CellPaddingX - table->CellSpacingX2; } } else if ((table->Flags & ImGuiTableFlags_NoKeepColumnsVisible) == 0) { // If horizontal scrolling if disabled, we apply a final lossless shrinking of columns in order to make // sure they are all visible. Because of this we also know that all of the columns will always fit in // table->WorkRect and therefore in table->InnerRect (because ScrollX is off) // FIXME-TABLE: This is solved incorrectly but also quite a difficult problem to fix as we also want ClipRect width to match. // See "table_width_distrib" and "table_width_keep_visible" tests max_width = table->WorkRect.Max.x - (table->ColumnsEnabledCount - column->IndexWithinEnabledSet - 1) * min_column_distance - column->MinX; //max_width -= table->CellSpacingX1; max_width -= table->CellSpacingX2; max_width -= table->CellPaddingX * 2.0f; max_width -= table->OuterPaddingX; } return max_width; } // Note this is meant to be stored in column->WidthAuto, please generally use the WidthAuto field float ImGui::TableGetColumnWidthAuto(ImGuiTable* table, ImGuiTableColumn* column) { const float content_width_body = ImMax(column->ContentMaxXFrozen, column->ContentMaxXUnfrozen) - column->WorkMinX; const float content_width_headers = column->ContentMaxXHeadersIdeal - column->WorkMinX; float width_auto = content_width_body; if (!(column->Flags & ImGuiTableColumnFlags_NoHeaderWidth)) width_auto = ImMax(width_auto, content_width_headers); // Non-resizable fixed columns preserve their requested width if ((column->Flags & ImGuiTableColumnFlags_WidthFixed) && column->InitStretchWeightOrWidth > 0.0f) if (!(table->Flags & ImGuiTableFlags_Resizable) || (column->Flags & ImGuiTableColumnFlags_NoResize)) width_auto = column->InitStretchWeightOrWidth; return ImMax(width_auto, table->MinColumnWidth); } // 'width' = inner column width, without padding void ImGui::TableSetColumnWidth(int column_n, float width) { ImGuiContext& g = *GImGui; ImGuiTable* table = g.CurrentTable; IM_ASSERT(table != NULL && table->IsLayoutLocked == false); IM_ASSERT(column_n >= 0 && column_n < table->ColumnsCount); ImGuiTableColumn* column_0 = &table->Columns[column_n]; float column_0_width = width; // Apply constraints early // Compare both requested and actual given width to avoid overwriting requested width when column is stuck (minimum size, bounded) IM_ASSERT(table->MinColumnWidth > 0.0f); const float min_width = table->MinColumnWidth; const float max_width = ImMax(min_width, column_0->WidthMax); // Don't use TableCalcMaxColumnWidth() here as it would rely on MinX from last instance (#7933) column_0_width = ImClamp(column_0_width, min_width, max_width); if (column_0->WidthGiven == column_0_width || column_0->WidthRequest == column_0_width) return; //IMGUI_DEBUG_PRINT("TableSetColumnWidth(%d, %.1f->%.1f)\n", column_0_idx, column_0->WidthGiven, column_0_width); ImGuiTableColumn* column_1 = (column_0->NextEnabledColumn != -1) ? &table->Columns[column_0->NextEnabledColumn] : NULL; // In this surprisingly not simple because of how we support mixing Fixed and multiple Stretch columns. // - All fixed: easy. // - All stretch: easy. // - One or more fixed + one stretch: easy. // - One or more fixed + more than one stretch: tricky. // Qt when manual resize is enabled only supports a single _trailing_ stretch column, we support more cases here. // When forwarding resize from Wn| to Fn+1| we need to be considerate of the _NoResize flag on Fn+1. // FIXME-TABLE: Find a way to rewrite all of this so interactions feel more consistent for the user. // Scenarios: // - F1 F2 F3 resize from F1| or F2| --> ok: alter ->WidthRequested of Fixed column. Subsequent columns will be offset. // - F1 F2 F3 resize from F3| --> ok: alter ->WidthRequested of Fixed column. If active, ScrollX extent can be altered. // - F1 F2 W3 resize from F1| or F2| --> ok: alter ->WidthRequested of Fixed column. If active, ScrollX extent can be altered, but it doesn't make much sense as the Stretch column will always be minimal size. // - F1 F2 W3 resize from W3| --> ok: no-op (disabled by Resize Rule 1) // - W1 W2 W3 resize from W1| or W2| --> ok // - W1 W2 W3 resize from W3| --> ok: no-op (disabled by Resize Rule 1) // - W1 F2 F3 resize from F3| --> ok: no-op (disabled by Resize Rule 1) // - W1 F2 resize from F2| --> ok: no-op (disabled by Resize Rule 1) // - W1 W2 F3 resize from W1| or W2| --> ok // - W1 F2 W3 resize from W1| or F2| --> ok // - F1 W2 F3 resize from W2| --> ok // - F1 W3 F2 resize from W3| --> ok // - W1 F2 F3 resize from W1| --> ok: equivalent to resizing |F2. F3 will not move. // - W1 F2 F3 resize from F2| --> ok // All resizes from a Wx columns are locking other columns. // Possible improvements: // - W1 W2 W3 resize W1| --> to not be stuck, both W2 and W3 would stretch down. Seems possible to fix. Would be most beneficial to simplify resize of all-weighted columns. // - W3 F1 F2 resize W3| --> to not be stuck past F1|, both F1 and F2 would need to stretch down, which would be lossy or ambiguous. Seems hard to fix. // [Resize Rule 1] Can't resize from right of right-most visible column if there is any Stretch column. Implemented in TableUpdateLayout(). // If we have all Fixed columns OR resizing a Fixed column that doesn't come after a Stretch one, we can do an offsetting resize. // This is the preferred resize path if (column_0->Flags & ImGuiTableColumnFlags_WidthFixed) if (!column_1 || table->LeftMostStretchedColumn == -1 || table->Columns[table->LeftMostStretchedColumn].DisplayOrder >= column_0->DisplayOrder) { column_0->WidthRequest = column_0_width; table->IsSettingsDirty = true; return; } // We can also use previous column if there's no next one (this is used when doing an auto-fit on the right-most stretch column) if (column_1 == NULL) column_1 = (column_0->PrevEnabledColumn != -1) ? &table->Columns[column_0->PrevEnabledColumn] : NULL; if (column_1 == NULL) return; // Resizing from right-side of a Stretch column before a Fixed column forward sizing to left-side of fixed column. // (old_a + old_b == new_a + new_b) --> (new_a == old_a + old_b - new_b) float column_1_width = ImMax(column_1->WidthRequest - (column_0_width - column_0->WidthRequest), min_width); column_0_width = column_0->WidthRequest + column_1->WidthRequest - column_1_width; IM_ASSERT(column_0_width > 0.0f && column_1_width > 0.0f); column_0->WidthRequest = column_0_width; column_1->WidthRequest = column_1_width; if ((column_0->Flags | column_1->Flags) & ImGuiTableColumnFlags_WidthStretch) TableUpdateColumnsWeightFromWidth(table); table->IsSettingsDirty = true; } // Disable clipping then auto-fit, will take 2 frames // (we don't take a shortcut for unclipped columns to reduce inconsistencies when e.g. resizing multiple columns) void ImGui::TableSetColumnWidthAutoSingle(ImGuiTable* table, int column_n) { // Single auto width uses auto-fit ImGuiTableColumn* column = &table->Columns[column_n]; if (!column->IsEnabled) return; column->CannotSkipItemsQueue = (1 << 0); table->AutoFitSingleColumn = (ImGuiTableColumnIdx)column_n; } void ImGui::TableSetColumnWidthAutoAll(ImGuiTable* table) { for (int column_n = 0; column_n < table->ColumnsCount; column_n++) { ImGuiTableColumn* column = &table->Columns[column_n]; if (!column->IsEnabled && !(column->Flags & ImGuiTableColumnFlags_WidthStretch)) // Cannot reset weight of hidden stretch column continue; column->CannotSkipItemsQueue = (1 << 0); column->AutoFitQueue = (1 << 1); } } void ImGui::TableUpdateColumnsWeightFromWidth(ImGuiTable* table) { IM_ASSERT(table->LeftMostStretchedColumn != -1 && table->RightMostStretchedColumn != -1); // Measure existing quantities float visible_weight = 0.0f; float visible_width = 0.0f; for (int column_n = 0; column_n < table->ColumnsCount; column_n++) { ImGuiTableColumn* column = &table->Columns[column_n]; if (!column->IsEnabled || !(column->Flags & ImGuiTableColumnFlags_WidthStretch)) continue; IM_ASSERT(column->StretchWeight > 0.0f); visible_weight += column->StretchWeight; visible_width += column->WidthRequest; } IM_ASSERT(visible_weight > 0.0f && visible_width > 0.0f); // Apply new weights for (int column_n = 0; column_n < table->ColumnsCount; column_n++) { ImGuiTableColumn* column = &table->Columns[column_n]; if (!column->IsEnabled || !(column->Flags & ImGuiTableColumnFlags_WidthStretch)) continue; column->StretchWeight = (column->WidthRequest / visible_width) * visible_weight; IM_ASSERT(column->StretchWeight > 0.0f); } } //------------------------------------------------------------------------- // [SECTION] Tables: Drawing //------------------------------------------------------------------------- // - TablePushBackgroundChannel() [Internal] // - TablePopBackgroundChannel() [Internal] // - TableSetupDrawChannels() [Internal] // - TableMergeDrawChannels() [Internal] // - TableGetColumnBorderCol() [Internal] // - TableDrawBorders() [Internal] //------------------------------------------------------------------------- // Bg2 is used by Selectable (and possibly other widgets) to render to the background. // Unlike our Bg0/1 channel which we uses for RowBg/CellBg/Borders and where we guarantee all shapes to be CPU-clipped, the Bg2 channel being widgets-facing will rely on regular ClipRect. void ImGui::TablePushBackgroundChannel() { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; ImGuiTable* table = g.CurrentTable; // Optimization: avoid SetCurrentChannel() + PushClipRect() table->HostBackupInnerClipRect = window->ClipRect; SetWindowClipRectBeforeSetChannel(window, table->Bg2ClipRectForDrawCmd); table->DrawSplitter->SetCurrentChannel(window->DrawList, table->Bg2DrawChannelCurrent); } void ImGui::TablePopBackgroundChannel() { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; ImGuiTable* table = g.CurrentTable; ImGuiTableColumn* column = &table->Columns[table->CurrentColumn]; // Optimization: avoid PopClipRect() + SetCurrentChannel() SetWindowClipRectBeforeSetChannel(window, table->HostBackupInnerClipRect); table->DrawSplitter->SetCurrentChannel(window->DrawList, column->DrawChannelCurrent); } // Allocate draw channels. Called by TableUpdateLayout() // - We allocate them following storage order instead of display order so reordering columns won't needlessly // increase overall dormant memory cost. // - We isolate headers draw commands in their own channels instead of just altering clip rects. // This is in order to facilitate merging of draw commands. // - After crossing FreezeRowsCount, all columns see their current draw channel changed to a second set of channels. // - We only use the dummy draw channel so we can push a null clipping rectangle into it without affecting other // channels, while simplifying per-row/per-cell overhead. It will be empty and discarded when merged. // - We allocate 1 or 2 background draw channels. This is because we know TablePushBackgroundChannel() is only used for // horizontal spanning. If we allowed vertical spanning we'd need one background draw channel per merge group (1-4). // Draw channel allocation (before merging): // - NoClip --> 2+D+1 channels: bg0/1 + bg2 + foreground (same clip rect == always 1 draw call) // - Clip --> 2+D+N channels // - FreezeRows --> 2+D+N*2 (unless scrolling value is zero) // - FreezeRows || FreezeColunns --> 3+D+N*2 (unless scrolling value is zero) // Where D is 1 if any column is clipped or hidden (dummy channel) otherwise 0. void ImGui::TableSetupDrawChannels(ImGuiTable* table) { const int freeze_row_multiplier = (table->FreezeRowsCount > 0) ? 2 : 1; const int channels_for_row = (table->Flags & ImGuiTableFlags_NoClip) ? 1 : table->ColumnsEnabledCount; const int channels_for_bg = 1 + 1 * freeze_row_multiplier; const int channels_for_dummy = (table->ColumnsEnabledCount < table->ColumnsCount || (memcmp(table->VisibleMaskByIndex, table->EnabledMaskByIndex, ImBitArrayGetStorageSizeInBytes(table->ColumnsCount)) != 0)) ? +1 : 0; const int channels_total = channels_for_bg + (channels_for_row * freeze_row_multiplier) + channels_for_dummy; table->DrawSplitter->Split(table->InnerWindow->DrawList, channels_total); table->DummyDrawChannel = (ImGuiTableDrawChannelIdx)((channels_for_dummy > 0) ? channels_total - 1 : -1); table->Bg2DrawChannelCurrent = TABLE_DRAW_CHANNEL_BG2_FROZEN; table->Bg2DrawChannelUnfrozen = (ImGuiTableDrawChannelIdx)((table->FreezeRowsCount > 0) ? 2 + channels_for_row : TABLE_DRAW_CHANNEL_BG2_FROZEN); int draw_channel_current = 2; for (int column_n = 0; column_n < table->ColumnsCount; column_n++) { ImGuiTableColumn* column = &table->Columns[column_n]; if (column->IsVisibleX && column->IsVisibleY) { column->DrawChannelFrozen = (ImGuiTableDrawChannelIdx)(draw_channel_current); column->DrawChannelUnfrozen = (ImGuiTableDrawChannelIdx)(draw_channel_current + (table->FreezeRowsCount > 0 ? channels_for_row + 1 : 0)); if (!(table->Flags & ImGuiTableFlags_NoClip)) draw_channel_current++; } else { column->DrawChannelFrozen = column->DrawChannelUnfrozen = table->DummyDrawChannel; } column->DrawChannelCurrent = column->DrawChannelFrozen; } // Initial draw cmd starts with a BgClipRect that matches the one of its host, to facilitate merge draw commands by default. // All our cell highlight are manually clipped with BgClipRect. When unfreezing it will be made smaller to fit scrolling rect. // (This technically isn't part of setting up draw channels, but is reasonably related to be done here) table->BgClipRect = table->InnerClipRect; table->Bg0ClipRectForDrawCmd = table->OuterWindow->ClipRect; table->Bg2ClipRectForDrawCmd = table->HostClipRect; IM_ASSERT(table->BgClipRect.Min.y <= table->BgClipRect.Max.y); } // This function reorder draw channels based on matching clip rectangle, to facilitate merging them. Called by EndTable(). // For simplicity we call it TableMergeDrawChannels() but in fact it only reorder channels + overwrite ClipRect, // actual merging is done by table->DrawSplitter.Merge() which is called right after TableMergeDrawChannels(). // // Columns where the contents didn't stray off their local clip rectangle can be merged. To achieve // this we merge their clip rect and make them contiguous in the channel list, so they can be merged // by the call to DrawSplitter.Merge() following to the call to this function. // We reorder draw commands by arranging them into a maximum of 4 distinct groups: // // 1 group: 2 groups: 2 groups: 4 groups: // [ 0. ] no freeze [ 0. ] row freeze [ 01 ] col freeze [ 01 ] row+col freeze // [ .. ] or no scroll [ 2. ] and v-scroll [ .. ] and h-scroll [ 23 ] and v+h-scroll // // Each column itself can use 1 channel (row freeze disabled) or 2 channels (row freeze enabled). // When the contents of a column didn't stray off its limit, we move its channels into the corresponding group // based on its position (within frozen rows/columns groups or not). // At the end of the operation our 1-4 groups will each have a ImDrawCmd using the same ClipRect. // This function assume that each column are pointing to a distinct draw channel, // otherwise merge_group->ChannelsCount will not match set bit count of merge_group->ChannelsMask. // // Column channels will not be merged into one of the 1-4 groups in the following cases: // - The contents stray off its clipping rectangle (we only compare the MaxX value, not the MinX value). // Direct ImDrawList calls won't be taken into account by default, if you use them make sure the ImGui:: bounds // matches, by e.g. calling SetCursorScreenPos(). // - The channel uses more than one draw command itself. We drop all our attempt at merging stuff here.. // we could do better but it's going to be rare and probably not worth the hassle. // Columns for which the draw channel(s) haven't been merged with other will use their own ImDrawCmd. // // This function is particularly tricky to understand.. take a breath. void ImGui::TableMergeDrawChannels(ImGuiTable* table) { ImGuiContext& g = *GImGui; ImDrawListSplitter* splitter = table->DrawSplitter; const bool has_freeze_v = (table->FreezeRowsCount > 0); const bool has_freeze_h = (table->FreezeColumnsCount > 0); IM_ASSERT(splitter->_Current == 0); // Track which groups we are going to attempt to merge, and which channels goes into each group. struct MergeGroup { ImRect ClipRect; int ChannelsCount = 0; ImBitArrayPtr ChannelsMask = NULL; }; int merge_group_mask = 0x00; MergeGroup merge_groups[4]; // Use a reusable temp buffer for the merge masks as they are dynamically sized. const int max_draw_channels = (4 + table->ColumnsCount * 2); const int size_for_masks_bitarrays_one = (int)ImBitArrayGetStorageSizeInBytes(max_draw_channels); g.TempBuffer.reserve(size_for_masks_bitarrays_one * 5); memset(g.TempBuffer.Data, 0, size_for_masks_bitarrays_one * 5); for (int n = 0; n < IM_ARRAYSIZE(merge_groups); n++) merge_groups[n].ChannelsMask = (ImBitArrayPtr)(void*)(g.TempBuffer.Data + (size_for_masks_bitarrays_one * n)); ImBitArrayPtr remaining_mask = (ImBitArrayPtr)(void*)(g.TempBuffer.Data + (size_for_masks_bitarrays_one * 4)); // 1. Scan channels and take note of those which can be merged for (int column_n = 0; column_n < table->ColumnsCount; column_n++) { if (!IM_BITARRAY_TESTBIT(table->VisibleMaskByIndex, column_n)) continue; ImGuiTableColumn* column = &table->Columns[column_n]; const int merge_group_sub_count = has_freeze_v ? 2 : 1; for (int merge_group_sub_n = 0; merge_group_sub_n < merge_group_sub_count; merge_group_sub_n++) { const int channel_no = (merge_group_sub_n == 0) ? column->DrawChannelFrozen : column->DrawChannelUnfrozen; // Don't attempt to merge if there are multiple draw calls within the column ImDrawChannel* src_channel = &splitter->_Channels[channel_no]; if (src_channel->_CmdBuffer.Size > 0 && src_channel->_CmdBuffer.back().ElemCount == 0 && src_channel->_CmdBuffer.back().UserCallback == NULL) // Equivalent of PopUnusedDrawCmd() src_channel->_CmdBuffer.pop_back(); if (src_channel->_CmdBuffer.Size != 1) continue; // Find out the width of this merge group and check if it will fit in our column // (note that we assume that rendering didn't stray on the left direction. we should need a CursorMinPos to detect it) if (!(column->Flags & ImGuiTableColumnFlags_NoClip)) { float content_max_x; if (!has_freeze_v) content_max_x = ImMax(column->ContentMaxXUnfrozen, column->ContentMaxXHeadersUsed); // No row freeze else if (merge_group_sub_n == 0) content_max_x = ImMax(column->ContentMaxXFrozen, column->ContentMaxXHeadersUsed); // Row freeze: use width before freeze else content_max_x = column->ContentMaxXUnfrozen; // Row freeze: use width after freeze if (content_max_x > column->ClipRect.Max.x) continue; } const int merge_group_n = (has_freeze_h && column_n < table->FreezeColumnsCount ? 0 : 1) + (has_freeze_v && merge_group_sub_n == 0 ? 0 : 2); IM_ASSERT(channel_no < max_draw_channels); MergeGroup* merge_group = &merge_groups[merge_group_n]; if (merge_group->ChannelsCount == 0) merge_group->ClipRect = ImRect(+FLT_MAX, +FLT_MAX, -FLT_MAX, -FLT_MAX); ImBitArraySetBit(merge_group->ChannelsMask, channel_no); merge_group->ChannelsCount++; merge_group->ClipRect.Add(src_channel->_CmdBuffer[0].ClipRect); merge_group_mask |= (1 << merge_group_n); } // Invalidate current draw channel // (we don't clear DrawChannelFrozen/DrawChannelUnfrozen solely to facilitate debugging/later inspection of data) column->DrawChannelCurrent = (ImGuiTableDrawChannelIdx)-1; } // [DEBUG] Display merge groups #if 0 if (g.IO.KeyShift) for (int merge_group_n = 0; merge_group_n < IM_ARRAYSIZE(merge_groups); merge_group_n++) { MergeGroup* merge_group = &merge_groups[merge_group_n]; if (merge_group->ChannelsCount == 0) continue; char buf[32]; ImFormatString(buf, 32, "MG%d:%d", merge_group_n, merge_group->ChannelsCount); ImVec2 text_pos = merge_group->ClipRect.Min + ImVec2(4, 4); ImVec2 text_size = CalcTextSize(buf, NULL); GetForegroundDrawList()->AddRectFilled(text_pos, text_pos + text_size, IM_COL32(0, 0, 0, 255)); GetForegroundDrawList()->AddText(text_pos, IM_COL32(255, 255, 0, 255), buf, NULL); GetForegroundDrawList()->AddRect(merge_group->ClipRect.Min, merge_group->ClipRect.Max, IM_COL32(255, 255, 0, 255)); } #endif // 2. Rewrite channel list in our preferred order if (merge_group_mask != 0) { // We skip channel 0 (Bg0/Bg1) and 1 (Bg2 frozen) from the shuffling since they won't move - see channels allocation in TableSetupDrawChannels(). const int LEADING_DRAW_CHANNELS = 2; g.DrawChannelsTempMergeBuffer.resize(splitter->_Count - LEADING_DRAW_CHANNELS); // Use shared temporary storage so the allocation gets amortized ImDrawChannel* dst_tmp = g.DrawChannelsTempMergeBuffer.Data; ImBitArraySetBitRange(remaining_mask, LEADING_DRAW_CHANNELS, splitter->_Count); ImBitArrayClearBit(remaining_mask, table->Bg2DrawChannelUnfrozen); IM_ASSERT(has_freeze_v == false || table->Bg2DrawChannelUnfrozen != TABLE_DRAW_CHANNEL_BG2_FROZEN); int remaining_count = splitter->_Count - (has_freeze_v ? LEADING_DRAW_CHANNELS + 1 : LEADING_DRAW_CHANNELS); //ImRect host_rect = (table->InnerWindow == table->OuterWindow) ? table->InnerClipRect : table->HostClipRect; ImRect host_rect = table->HostClipRect; for (int merge_group_n = 0; merge_group_n < IM_ARRAYSIZE(merge_groups); merge_group_n++) { if (int merge_channels_count = merge_groups[merge_group_n].ChannelsCount) { MergeGroup* merge_group = &merge_groups[merge_group_n]; ImRect merge_clip_rect = merge_group->ClipRect; // Extend outer-most clip limits to match those of host, so draw calls can be merged even if // outer-most columns have some outer padding offsetting them from their parent ClipRect. // The principal cases this is dealing with are: // - On a same-window table (not scrolling = single group), all fitting columns ClipRect -> will extend and match host ClipRect -> will merge // - Columns can use padding and have left-most ClipRect.Min.x and right-most ClipRect.Max.x != from host ClipRect -> will extend and match host ClipRect -> will merge // FIXME-TABLE FIXME-WORKRECT: We are wasting a merge opportunity on tables without scrolling if column doesn't fit // within host clip rect, solely because of the half-padding difference between window->WorkRect and window->InnerClipRect. if ((merge_group_n & 1) == 0 || !has_freeze_h) merge_clip_rect.Min.x = ImMin(merge_clip_rect.Min.x, host_rect.Min.x); if ((merge_group_n & 2) == 0 || !has_freeze_v) merge_clip_rect.Min.y = ImMin(merge_clip_rect.Min.y, host_rect.Min.y); if ((merge_group_n & 1) != 0) merge_clip_rect.Max.x = ImMax(merge_clip_rect.Max.x, host_rect.Max.x); if ((merge_group_n & 2) != 0 && (table->Flags & ImGuiTableFlags_NoHostExtendY) == 0) merge_clip_rect.Max.y = ImMax(merge_clip_rect.Max.y, host_rect.Max.y); //GetForegroundDrawList()->AddRect(merge_group->ClipRect.Min, merge_group->ClipRect.Max, IM_COL32(255, 0, 0, 200), 0.0f, 0, 1.0f); // [DEBUG] //GetForegroundDrawList()->AddLine(merge_group->ClipRect.Min, merge_clip_rect.Min, IM_COL32(255, 100, 0, 200)); //GetForegroundDrawList()->AddLine(merge_group->ClipRect.Max, merge_clip_rect.Max, IM_COL32(255, 100, 0, 200)); remaining_count -= merge_group->ChannelsCount; for (int n = 0; n < (size_for_masks_bitarrays_one >> 2); n++) remaining_mask[n] &= ~merge_group->ChannelsMask[n]; for (int n = 0; n < splitter->_Count && merge_channels_count != 0; n++) { // Copy + overwrite new clip rect if (!IM_BITARRAY_TESTBIT(merge_group->ChannelsMask, n)) continue; IM_BITARRAY_CLEARBIT(merge_group->ChannelsMask, n); merge_channels_count--; ImDrawChannel* channel = &splitter->_Channels[n]; IM_ASSERT(channel->_CmdBuffer.Size == 1 && merge_clip_rect.Contains(ImRect(channel->_CmdBuffer[0].ClipRect))); channel->_CmdBuffer[0].ClipRect = merge_clip_rect.ToVec4(); memcpy(dst_tmp++, channel, sizeof(ImDrawChannel)); } } // Make sure Bg2DrawChannelUnfrozen appears in the middle of our groups (whereas Bg0/Bg1 and Bg2 frozen are fixed to 0 and 1) if (merge_group_n == 1 && has_freeze_v) memcpy(dst_tmp++, &splitter->_Channels[table->Bg2DrawChannelUnfrozen], sizeof(ImDrawChannel)); } // Append unmergeable channels that we didn't reorder at the end of the list for (int n = 0; n < splitter->_Count && remaining_count != 0; n++) { if (!IM_BITARRAY_TESTBIT(remaining_mask, n)) continue; ImDrawChannel* channel = &splitter->_Channels[n]; memcpy(dst_tmp++, channel, sizeof(ImDrawChannel)); remaining_count--; } IM_ASSERT(dst_tmp == g.DrawChannelsTempMergeBuffer.Data + g.DrawChannelsTempMergeBuffer.Size); memcpy(splitter->_Channels.Data + LEADING_DRAW_CHANNELS, g.DrawChannelsTempMergeBuffer.Data, (splitter->_Count - LEADING_DRAW_CHANNELS) * sizeof(ImDrawChannel)); } } static ImU32 TableGetColumnBorderCol(ImGuiTable* table, int order_n, int column_n) { const bool is_hovered = (table->HoveredColumnBorder == column_n); const bool is_resized = (table->ResizedColumn == column_n) && (table->InstanceInteracted == table->InstanceCurrent); const bool is_frozen_separator = (table->FreezeColumnsCount == order_n + 1); if (is_resized || is_hovered) return ImGui::GetColorU32(is_resized ? ImGuiCol_SeparatorActive : ImGuiCol_SeparatorHovered); if (is_frozen_separator || (table->Flags & (ImGuiTableFlags_NoBordersInBody | ImGuiTableFlags_NoBordersInBodyUntilResize))) return table->BorderColorStrong; return table->BorderColorLight; } // FIXME-TABLE: This is a mess, need to redesign how we render borders (as some are also done in TableEndRow) void ImGui::TableDrawBorders(ImGuiTable* table) { ImGuiWindow* inner_window = table->InnerWindow; if (!table->OuterWindow->ClipRect.Overlaps(table->OuterRect)) return; ImDrawList* inner_drawlist = inner_window->DrawList; table->DrawSplitter->SetCurrentChannel(inner_drawlist, TABLE_DRAW_CHANNEL_BG0); inner_drawlist->PushClipRect(table->Bg0ClipRectForDrawCmd.Min, table->Bg0ClipRectForDrawCmd.Max, false); // Draw inner border and resizing feedback ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent); const float border_size = TABLE_BORDER_SIZE; const float draw_y1 = ImMax(table->InnerRect.Min.y, (table->FreezeRowsCount >= 1 ? table->InnerRect.Min.y : table->WorkRect.Min.y) + table->AngledHeadersHeight) + ((table->Flags & ImGuiTableFlags_BordersOuterH) ? 1.0f : 0.0f); const float draw_y2_body = table->InnerRect.Max.y; const float draw_y2_head = table->IsUsingHeaders ? ImMin(table->InnerRect.Max.y, (table->FreezeRowsCount >= 1 ? table->InnerRect.Min.y : table->WorkRect.Min.y) + table_instance->LastTopHeadersRowHeight) : draw_y1; if (table->Flags & ImGuiTableFlags_BordersInnerV) { for (int order_n = 0; order_n < table->ColumnsCount; order_n++) { if (!IM_BITARRAY_TESTBIT(table->EnabledMaskByDisplayOrder, order_n)) continue; const int column_n = table->DisplayOrderToIndex[order_n]; ImGuiTableColumn* column = &table->Columns[column_n]; const bool is_hovered = (table->HoveredColumnBorder == column_n); const bool is_resized = (table->ResizedColumn == column_n) && (table->InstanceInteracted == table->InstanceCurrent); const bool is_resizable = (column->Flags & (ImGuiTableColumnFlags_NoResize | ImGuiTableColumnFlags_NoDirectResize_)) == 0; const bool is_frozen_separator = (table->FreezeColumnsCount == order_n + 1); if (column->MaxX > table->InnerClipRect.Max.x && !is_resized) continue; // Decide whether right-most column is visible if (column->NextEnabledColumn == -1 && !is_resizable) if ((table->Flags & ImGuiTableFlags_SizingMask_) != ImGuiTableFlags_SizingFixedSame || (table->Flags & ImGuiTableFlags_NoHostExtendX)) continue; if (column->MaxX <= column->ClipRect.Min.x) // FIXME-TABLE FIXME-STYLE: Assume BorderSize==1, this is problematic if we want to increase the border size.. continue; // Draw in outer window so right-most column won't be clipped // Always draw full height border when being resized/hovered, or on the delimitation of frozen column scrolling. float draw_y2 = (is_hovered || is_resized || is_frozen_separator || (table->Flags & (ImGuiTableFlags_NoBordersInBody | ImGuiTableFlags_NoBordersInBodyUntilResize)) == 0) ? draw_y2_body : draw_y2_head; if (draw_y2 > draw_y1) inner_drawlist->AddLine(ImVec2(column->MaxX, draw_y1), ImVec2(column->MaxX, draw_y2), TableGetColumnBorderCol(table, order_n, column_n), border_size); } } // Draw outer border // FIXME: could use AddRect or explicit VLine/HLine helper? if (table->Flags & ImGuiTableFlags_BordersOuter) { // Display outer border offset by 1 which is a simple way to display it without adding an extra draw call // (Without the offset, in outer_window it would be rendered behind cells, because child windows are above their // parent. In inner_window, it won't reach out over scrollbars. Another weird solution would be to display part // of it in inner window, and the part that's over scrollbars in the outer window..) // Either solution currently won't allow us to use a larger border size: the border would clipped. const ImRect outer_border = table->OuterRect; const ImU32 outer_col = table->BorderColorStrong; if ((table->Flags & ImGuiTableFlags_BordersOuter) == ImGuiTableFlags_BordersOuter) { inner_drawlist->AddRect(outer_border.Min, outer_border.Max, outer_col, 0.0f, 0, border_size); } else if (table->Flags & ImGuiTableFlags_BordersOuterV) { inner_drawlist->AddLine(outer_border.Min, ImVec2(outer_border.Min.x, outer_border.Max.y), outer_col, border_size); inner_drawlist->AddLine(ImVec2(outer_border.Max.x, outer_border.Min.y), outer_border.Max, outer_col, border_size); } else if (table->Flags & ImGuiTableFlags_BordersOuterH) { inner_drawlist->AddLine(outer_border.Min, ImVec2(outer_border.Max.x, outer_border.Min.y), outer_col, border_size); inner_drawlist->AddLine(ImVec2(outer_border.Min.x, outer_border.Max.y), outer_border.Max, outer_col, border_size); } } if ((table->Flags & ImGuiTableFlags_BordersInnerH) && table->RowPosY2 < table->OuterRect.Max.y) { // Draw bottom-most row border between it is above outer border. const float border_y = table->RowPosY2; if (border_y >= table->BgClipRect.Min.y && border_y < table->BgClipRect.Max.y) inner_drawlist->AddLine(ImVec2(table->BorderX1, border_y), ImVec2(table->BorderX2, border_y), table->BorderColorLight, border_size); } inner_drawlist->PopClipRect(); } //------------------------------------------------------------------------- // [SECTION] Tables: Sorting //------------------------------------------------------------------------- // - TableGetSortSpecs() // - TableFixColumnSortDirection() [Internal] // - TableGetColumnNextSortDirection() [Internal] // - TableSetColumnSortDirection() [Internal] // - TableSortSpecsSanitize() [Internal] // - TableSortSpecsBuild() [Internal] //------------------------------------------------------------------------- // Return NULL if no sort specs (most often when ImGuiTableFlags_Sortable is not set) // When 'sort_specs->SpecsDirty == true' you should sort your data. It will be true when sorting specs have // changed since last call, or the first time. Make sure to set 'SpecsDirty = false' after sorting, // else you may wastefully sort your data every frame! // Lifetime: don't hold on this pointer over multiple frames or past any subsequent call to BeginTable()! ImGuiTableSortSpecs* ImGui::TableGetSortSpecs() { ImGuiContext& g = *GImGui; ImGuiTable* table = g.CurrentTable; IM_ASSERT(table != NULL); if (!(table->Flags & ImGuiTableFlags_Sortable)) return NULL; // Require layout (in case TableHeadersRow() hasn't been called) as it may alter IsSortSpecsDirty in some paths. if (!table->IsLayoutLocked) TableUpdateLayout(table); TableSortSpecsBuild(table); return &table->SortSpecs; } static inline ImGuiSortDirection TableGetColumnAvailSortDirection(ImGuiTableColumn* column, int n) { IM_ASSERT(n < column->SortDirectionsAvailCount); return (ImGuiSortDirection)((column->SortDirectionsAvailList >> (n << 1)) & 0x03); } // Fix sort direction if currently set on a value which is unavailable (e.g. activating NoSortAscending/NoSortDescending) void ImGui::TableFixColumnSortDirection(ImGuiTable* table, ImGuiTableColumn* column) { if (column->SortOrder == -1 || (column->SortDirectionsAvailMask & (1 << column->SortDirection)) != 0) return; column->SortDirection = (ImU8)TableGetColumnAvailSortDirection(column, 0); table->IsSortSpecsDirty = true; } // Calculate next sort direction that would be set after clicking the column // - If the PreferSortDescending flag is set, we will default to a Descending direction on the first click. // - Note that the PreferSortAscending flag is never checked, it is essentially the default and therefore a no-op. IM_STATIC_ASSERT(ImGuiSortDirection_None == 0 && ImGuiSortDirection_Ascending == 1 && ImGuiSortDirection_Descending == 2); ImGuiSortDirection ImGui::TableGetColumnNextSortDirection(ImGuiTableColumn* column) { IM_ASSERT(column->SortDirectionsAvailCount > 0); if (column->SortOrder == -1) return TableGetColumnAvailSortDirection(column, 0); for (int n = 0; n < 3; n++) if (column->SortDirection == TableGetColumnAvailSortDirection(column, n)) return TableGetColumnAvailSortDirection(column, (n + 1) % column->SortDirectionsAvailCount); IM_ASSERT(0); return ImGuiSortDirection_None; } // Note that the NoSortAscending/NoSortDescending flags are processed in TableSortSpecsSanitize(), and they may change/revert // the value of SortDirection. We could technically also do it here but it would be unnecessary and duplicate code. void ImGui::TableSetColumnSortDirection(int column_n, ImGuiSortDirection sort_direction, bool append_to_sort_specs) { ImGuiContext& g = *GImGui; ImGuiTable* table = g.CurrentTable; if (!(table->Flags & ImGuiTableFlags_SortMulti)) append_to_sort_specs = false; if (!(table->Flags & ImGuiTableFlags_SortTristate)) IM_ASSERT(sort_direction != ImGuiSortDirection_None); ImGuiTableColumnIdx sort_order_max = 0; if (append_to_sort_specs) for (int other_column_n = 0; other_column_n < table->ColumnsCount; other_column_n++) sort_order_max = ImMax(sort_order_max, table->Columns[other_column_n].SortOrder); ImGuiTableColumn* column = &table->Columns[column_n]; column->SortDirection = (ImU8)sort_direction; if (column->SortDirection == ImGuiSortDirection_None) column->SortOrder = -1; else if (column->SortOrder == -1 || !append_to_sort_specs) column->SortOrder = append_to_sort_specs ? sort_order_max + 1 : 0; for (int other_column_n = 0; other_column_n < table->ColumnsCount; other_column_n++) { ImGuiTableColumn* other_column = &table->Columns[other_column_n]; if (other_column != column && !append_to_sort_specs) other_column->SortOrder = -1; TableFixColumnSortDirection(table, other_column); } table->IsSettingsDirty = true; table->IsSortSpecsDirty = true; } void ImGui::TableSortSpecsSanitize(ImGuiTable* table) { IM_ASSERT(table->Flags & ImGuiTableFlags_Sortable); // Clear SortOrder from hidden column and verify that there's no gap or duplicate. int sort_order_count = 0; ImU64 sort_order_mask = 0x00; for (int column_n = 0; column_n < table->ColumnsCount; column_n++) { ImGuiTableColumn* column = &table->Columns[column_n]; if (column->SortOrder != -1 && !column->IsEnabled) column->SortOrder = -1; if (column->SortOrder == -1) continue; sort_order_count++; sort_order_mask |= ((ImU64)1 << column->SortOrder); IM_ASSERT(sort_order_count < (int)sizeof(sort_order_mask) * 8); } const bool need_fix_linearize = ((ImU64)1 << sort_order_count) != (sort_order_mask + 1); const bool need_fix_single_sort_order = (sort_order_count > 1) && !(table->Flags & ImGuiTableFlags_SortMulti); if (need_fix_linearize || need_fix_single_sort_order) { ImU64 fixed_mask = 0x00; for (int sort_n = 0; sort_n < sort_order_count; sort_n++) { // Fix: Rewrite sort order fields if needed so they have no gap or duplicate. // (e.g. SortOrder 0 disappeared, SortOrder 1..2 exists --> rewrite then as SortOrder 0..1) int column_with_smallest_sort_order = -1; for (int column_n = 0; column_n < table->ColumnsCount; column_n++) if ((fixed_mask & ((ImU64)1 << (ImU64)column_n)) == 0 && table->Columns[column_n].SortOrder != -1) if (column_with_smallest_sort_order == -1 || table->Columns[column_n].SortOrder < table->Columns[column_with_smallest_sort_order].SortOrder) column_with_smallest_sort_order = column_n; IM_ASSERT(column_with_smallest_sort_order != -1); fixed_mask |= ((ImU64)1 << column_with_smallest_sort_order); table->Columns[column_with_smallest_sort_order].SortOrder = (ImGuiTableColumnIdx)sort_n; // Fix: Make sure only one column has a SortOrder if ImGuiTableFlags_MultiSortable is not set. if (need_fix_single_sort_order) { sort_order_count = 1; for (int column_n = 0; column_n < table->ColumnsCount; column_n++) if (column_n != column_with_smallest_sort_order) table->Columns[column_n].SortOrder = -1; break; } } } // Fallback default sort order (if no column with the ImGuiTableColumnFlags_DefaultSort flag) if (sort_order_count == 0 && !(table->Flags & ImGuiTableFlags_SortTristate)) for (int column_n = 0; column_n < table->ColumnsCount; column_n++) { ImGuiTableColumn* column = &table->Columns[column_n]; if (column->IsEnabled && !(column->Flags & ImGuiTableColumnFlags_NoSort)) { sort_order_count = 1; column->SortOrder = 0; column->SortDirection = (ImU8)TableGetColumnAvailSortDirection(column, 0); break; } } table->SortSpecsCount = (ImGuiTableColumnIdx)sort_order_count; } void ImGui::TableSortSpecsBuild(ImGuiTable* table) { bool dirty = table->IsSortSpecsDirty; if (dirty) { TableSortSpecsSanitize(table); table->SortSpecsMulti.resize(table->SortSpecsCount <= 1 ? 0 : table->SortSpecsCount); table->SortSpecs.SpecsDirty = true; // Mark as dirty for user table->IsSortSpecsDirty = false; // Mark as not dirty for us } // Write output // May be able to move all SortSpecs data from table (48 bytes) to ImGuiTableTempData if we decide to write it back on every BeginTable() ImGuiTableColumnSortSpecs* sort_specs = (table->SortSpecsCount == 0) ? NULL : (table->SortSpecsCount == 1) ? &table->SortSpecsSingle : table->SortSpecsMulti.Data; if (dirty && sort_specs != NULL) for (int column_n = 0; column_n < table->ColumnsCount; column_n++) { ImGuiTableColumn* column = &table->Columns[column_n]; if (column->SortOrder == -1) continue; IM_ASSERT(column->SortOrder < table->SortSpecsCount); ImGuiTableColumnSortSpecs* sort_spec = &sort_specs[column->SortOrder]; sort_spec->ColumnUserID = column->UserID; sort_spec->ColumnIndex = (ImGuiTableColumnIdx)column_n; sort_spec->SortOrder = (ImGuiTableColumnIdx)column->SortOrder; sort_spec->SortDirection = (ImGuiSortDirection)column->SortDirection; } table->SortSpecs.Specs = sort_specs; table->SortSpecs.SpecsCount = table->SortSpecsCount; } //------------------------------------------------------------------------- // [SECTION] Tables: Headers //------------------------------------------------------------------------- // - TableGetHeaderRowHeight() [Internal] // - TableGetHeaderAngledMaxLabelWidth() [Internal] // - TableHeadersRow() // - TableHeader() // - TableAngledHeadersRow() // - TableAngledHeadersRowEx() [Internal] //------------------------------------------------------------------------- float ImGui::TableGetHeaderRowHeight() { // Caring for a minor edge case: // Calculate row height, for the unlikely case that some labels may be taller than others. // If we didn't do that, uneven header height would highlight but smaller one before the tallest wouldn't catch input for all height. // In your custom header row you may omit this all together and just call TableNextRow() without a height... ImGuiContext& g = *GImGui; ImGuiTable* table = g.CurrentTable; float row_height = g.FontSize; for (int column_n = 0; column_n < table->ColumnsCount; column_n++) if (IM_BITARRAY_TESTBIT(table->EnabledMaskByIndex, column_n)) if ((table->Columns[column_n].Flags & ImGuiTableColumnFlags_NoHeaderLabel) == 0) row_height = ImMax(row_height, CalcTextSize(TableGetColumnName(table, column_n)).y); return row_height + g.Style.CellPadding.y * 2.0f; } float ImGui::TableGetHeaderAngledMaxLabelWidth() { ImGuiContext& g = *GImGui; ImGuiTable* table = g.CurrentTable; float width = 0.0f; for (int column_n = 0; column_n < table->ColumnsCount; column_n++) if (IM_BITARRAY_TESTBIT(table->EnabledMaskByIndex, column_n)) if (table->Columns[column_n].Flags & ImGuiTableColumnFlags_AngledHeader) width = ImMax(width, CalcTextSize(TableGetColumnName(table, column_n), NULL, true).x); return width + g.Style.CellPadding.y * 2.0f; // Swap padding } // [Public] This is a helper to output TableHeader() calls based on the column names declared in TableSetupColumn(). // The intent is that advanced users willing to create customized headers would not need to use this helper // and can create their own! For example: TableHeader() may be preceded by Checkbox() or other custom widgets. // See 'Demo->Tables->Custom headers' for a demonstration of implementing a custom version of this. // This code is intentionally written to not make much use of internal functions, to give you better direction // if you need to write your own. // FIXME-TABLE: TableOpenContextMenu() and TableGetHeaderRowHeight() are not public. void ImGui::TableHeadersRow() { ImGuiContext& g = *GImGui; ImGuiTable* table = g.CurrentTable; if (table == NULL) { IM_ASSERT_USER_ERROR(table != NULL, "Call should only be done while in BeginTable() scope!"); return; } // Call layout if not already done. This is automatically done by TableNextRow: we do it here _only_ to make // it easier to debug-step in TableUpdateLayout(). Your own version of this function doesn't need this. if (!table->IsLayoutLocked) TableUpdateLayout(table); // Open row const float row_height = TableGetHeaderRowHeight(); TableNextRow(ImGuiTableRowFlags_Headers, row_height); const float row_y1 = GetCursorScreenPos().y; if (table->HostSkipItems) // Merely an optimization, you may skip in your own code. return; const int columns_count = TableGetColumnCount(); for (int column_n = 0; column_n < columns_count; column_n++) { if (!TableSetColumnIndex(column_n)) continue; // Push an id to allow empty/unnamed headers. This is also idiomatic as it ensure there is a consistent ID path to access columns (for e.g. automation) const char* name = (TableGetColumnFlags(column_n) & ImGuiTableColumnFlags_NoHeaderLabel) ? "" : TableGetColumnName(column_n); PushID(column_n); TableHeader(name); PopID(); } // Allow opening popup from the right-most section after the last column. ImVec2 mouse_pos = ImGui::GetMousePos(); if (IsMouseReleased(1) && TableGetHoveredColumn() == columns_count) if (mouse_pos.y >= row_y1 && mouse_pos.y < row_y1 + row_height) TableOpenContextMenu(columns_count); // Will open a non-column-specific popup. } // Emit a column header (text + optional sort order) // We cpu-clip text here so that all columns headers can be merged into a same draw call. // Note that because of how we cpu-clip and display sorting indicators, you _cannot_ use SameLine() after a TableHeader() void ImGui::TableHeader(const char* label) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; if (window->SkipItems) return; ImGuiTable* table = g.CurrentTable; if (table == NULL) { IM_ASSERT_USER_ERROR(table != NULL, "Call should only be done while in BeginTable() scope!"); return; } IM_ASSERT(table->CurrentColumn != -1); const int column_n = table->CurrentColumn; ImGuiTableColumn* column = &table->Columns[column_n]; // Label if (label == NULL) label = ""; const char* label_end = FindRenderedTextEnd(label); ImVec2 label_size = CalcTextSize(label, label_end, true); ImVec2 label_pos = window->DC.CursorPos; // If we already got a row height, there's use that. // FIXME-TABLE: Padding problem if the correct outer-padding CellBgRect strays off our ClipRect? ImRect cell_r = TableGetCellBgRect(table, column_n); float label_height = ImMax(label_size.y, table->RowMinHeight - table->RowCellPaddingY * 2.0f); // Calculate ideal size for sort order arrow float w_arrow = 0.0f; float w_sort_text = 0.0f; bool sort_arrow = false; char sort_order_suf[4] = ""; const float ARROW_SCALE = 0.65f; if ((table->Flags & ImGuiTableFlags_Sortable) && !(column->Flags & ImGuiTableColumnFlags_NoSort)) { w_arrow = ImTrunc(g.FontSize * ARROW_SCALE + g.Style.FramePadding.x); if (column->SortOrder != -1) sort_arrow = true; if (column->SortOrder > 0) { ImFormatString(sort_order_suf, IM_ARRAYSIZE(sort_order_suf), "%d", column->SortOrder + 1); w_sort_text = g.Style.ItemInnerSpacing.x + CalcTextSize(sort_order_suf).x; } } // We feed our unclipped width to the column without writing on CursorMaxPos, so that column is still considered for merging. float max_pos_x = label_pos.x + label_size.x + w_sort_text + w_arrow; column->ContentMaxXHeadersUsed = ImMax(column->ContentMaxXHeadersUsed, sort_arrow ? cell_r.Max.x : ImMin(max_pos_x, cell_r.Max.x)); column->ContentMaxXHeadersIdeal = ImMax(column->ContentMaxXHeadersIdeal, max_pos_x); // Keep header highlighted when context menu is open. ImGuiID id = window->GetID(label); ImRect bb(cell_r.Min.x, cell_r.Min.y, cell_r.Max.x, ImMax(cell_r.Max.y, cell_r.Min.y + label_height + g.Style.CellPadding.y * 2.0f)); ItemSize(ImVec2(0.0f, label_height)); // Don't declare unclipped width, it'll be fed ContentMaxPosHeadersIdeal if (!ItemAdd(bb, id)) return; //GetForegroundDrawList()->AddRect(cell_r.Min, cell_r.Max, IM_COL32(255, 0, 0, 255)); // [DEBUG] //GetForegroundDrawList()->AddRect(bb.Min, bb.Max, IM_COL32(255, 0, 0, 255)); // [DEBUG] // Using AllowOverlap mode because we cover the whole cell, and we want user to be able to submit subsequent items. const bool highlight = (table->HighlightColumnHeader == column_n); bool hovered, held; bool pressed = ButtonBehavior(bb, id, &hovered, &held, ImGuiButtonFlags_AllowOverlap); if (held || hovered || highlight) { const ImU32 col = GetColorU32(held ? ImGuiCol_HeaderActive : hovered ? ImGuiCol_HeaderHovered : ImGuiCol_Header); //RenderFrame(bb.Min, bb.Max, col, false, 0.0f); TableSetBgColor(ImGuiTableBgTarget_CellBg, col, table->CurrentColumn); } else { // Submit single cell bg color in the case we didn't submit a full header row if ((table->RowFlags & ImGuiTableRowFlags_Headers) == 0) TableSetBgColor(ImGuiTableBgTarget_CellBg, GetColorU32(ImGuiCol_TableHeaderBg), table->CurrentColumn); } RenderNavCursor(bb, id, ImGuiNavRenderCursorFlags_Compact | ImGuiNavRenderCursorFlags_NoRounding); if (held) table->HeldHeaderColumn = (ImGuiTableColumnIdx)column_n; window->DC.CursorPos.y -= g.Style.ItemSpacing.y * 0.5f; // Drag and drop to re-order columns. // FIXME-TABLE: Scroll request while reordering a column and it lands out of the scrolling zone. if (held && (table->Flags & ImGuiTableFlags_Reorderable) && IsMouseDragging(0) && !g.DragDropActive) { // While moving a column it will jump on the other side of the mouse, so we also test for MouseDelta.x table->ReorderColumn = (ImGuiTableColumnIdx)column_n; table->InstanceInteracted = table->InstanceCurrent; // We don't reorder: through the frozen<>unfrozen line, or through a column that is marked with ImGuiTableColumnFlags_NoReorder. if (g.IO.MouseDelta.x < 0.0f && g.IO.MousePos.x < cell_r.Min.x) if (ImGuiTableColumn* prev_column = (column->PrevEnabledColumn != -1) ? &table->Columns[column->PrevEnabledColumn] : NULL) if (!((column->Flags | prev_column->Flags) & ImGuiTableColumnFlags_NoReorder)) if ((column->IndexWithinEnabledSet < table->FreezeColumnsRequest) == (prev_column->IndexWithinEnabledSet < table->FreezeColumnsRequest)) table->ReorderColumnDir = -1; if (g.IO.MouseDelta.x > 0.0f && g.IO.MousePos.x > cell_r.Max.x) if (ImGuiTableColumn* next_column = (column->NextEnabledColumn != -1) ? &table->Columns[column->NextEnabledColumn] : NULL) if (!((column->Flags | next_column->Flags) & ImGuiTableColumnFlags_NoReorder)) if ((column->IndexWithinEnabledSet < table->FreezeColumnsRequest) == (next_column->IndexWithinEnabledSet < table->FreezeColumnsRequest)) table->ReorderColumnDir = +1; } // Sort order arrow const float ellipsis_max = ImMax(cell_r.Max.x - w_arrow - w_sort_text, label_pos.x); if ((table->Flags & ImGuiTableFlags_Sortable) && !(column->Flags & ImGuiTableColumnFlags_NoSort)) { if (column->SortOrder != -1) { float x = ImMax(cell_r.Min.x, cell_r.Max.x - w_arrow - w_sort_text); float y = label_pos.y; if (column->SortOrder > 0) { PushStyleColor(ImGuiCol_Text, GetColorU32(ImGuiCol_Text, 0.70f)); RenderText(ImVec2(x + g.Style.ItemInnerSpacing.x, y), sort_order_suf); PopStyleColor(); x += w_sort_text; } RenderArrow(window->DrawList, ImVec2(x, y), GetColorU32(ImGuiCol_Text), column->SortDirection == ImGuiSortDirection_Ascending ? ImGuiDir_Up : ImGuiDir_Down, ARROW_SCALE); } // Handle clicking on column header to adjust Sort Order if (pressed && table->ReorderColumn != column_n) { ImGuiSortDirection sort_direction = TableGetColumnNextSortDirection(column); TableSetColumnSortDirection(column_n, sort_direction, g.IO.KeyShift); } } // Render clipped label. Clipping here ensure that in the majority of situations, all our header cells will // be merged into a single draw call. //window->DrawList->AddCircleFilled(ImVec2(ellipsis_max, label_pos.y), 40, IM_COL32_WHITE); RenderTextEllipsis(window->DrawList, label_pos, ImVec2(ellipsis_max, label_pos.y + label_height + g.Style.FramePadding.y), ellipsis_max, ellipsis_max, label, label_end, &label_size); const bool text_clipped = label_size.x > (ellipsis_max - label_pos.x); if (text_clipped && hovered && g.ActiveId == 0) SetItemTooltip("%.*s", (int)(label_end - label), label); // We don't use BeginPopupContextItem() because we want the popup to stay up even after the column is hidden if (IsMouseReleased(1) && IsItemHovered()) TableOpenContextMenu(column_n); } // Unlike TableHeadersRow() it is not expected that you can reimplement or customize this with custom widgets. // FIXME: No hit-testing/button on the angled header. void ImGui::TableAngledHeadersRow() { ImGuiContext& g = *GImGui; ImGuiTable* table = g.CurrentTable; ImGuiTableTempData* temp_data = table->TempData; temp_data->AngledHeadersRequests.resize(0); temp_data->AngledHeadersRequests.reserve(table->ColumnsEnabledCount); // Which column needs highlight? const ImGuiID row_id = GetID("##AngledHeaders"); ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent); int highlight_column_n = table->HighlightColumnHeader; if (highlight_column_n == -1 && table->HoveredColumnBody != -1) if (table_instance->HoveredRowLast == 0 && table->HoveredColumnBorder == -1 && (g.ActiveId == 0 || g.ActiveId == row_id || (table->IsActiveIdInTable || g.DragDropActive))) highlight_column_n = table->HoveredColumnBody; // Build up request ImU32 col_header_bg = GetColorU32(ImGuiCol_TableHeaderBg); ImU32 col_text = GetColorU32(ImGuiCol_Text); for (int order_n = 0; order_n < table->ColumnsCount; order_n++) if (IM_BITARRAY_TESTBIT(table->EnabledMaskByDisplayOrder, order_n)) { const int column_n = table->DisplayOrderToIndex[order_n]; ImGuiTableColumn* column = &table->Columns[column_n]; if ((column->Flags & ImGuiTableColumnFlags_AngledHeader) == 0) // Note: can't rely on ImGuiTableColumnFlags_IsVisible test here. continue; ImGuiTableHeaderData request = { (ImGuiTableColumnIdx)column_n, col_text, col_header_bg, (column_n == highlight_column_n) ? GetColorU32(ImGuiCol_Header) : 0 }; temp_data->AngledHeadersRequests.push_back(request); } // Render row TableAngledHeadersRowEx(row_id, g.Style.TableAngledHeadersAngle, 0.0f, temp_data->AngledHeadersRequests.Data, temp_data->AngledHeadersRequests.Size); } // Important: data must be fed left to right void ImGui::TableAngledHeadersRowEx(ImGuiID row_id, float angle, float max_label_width, const ImGuiTableHeaderData* data, int data_count) { ImGuiContext& g = *GImGui; ImGuiTable* table = g.CurrentTable; ImGuiWindow* window = g.CurrentWindow; ImDrawList* draw_list = window->DrawList; if (table == NULL) { IM_ASSERT_USER_ERROR(table != NULL, "Call should only be done while in BeginTable() scope!"); return; } IM_ASSERT(table->CurrentRow == -1 && "Must be first row"); if (max_label_width == 0.0f) max_label_width = TableGetHeaderAngledMaxLabelWidth(); // Angle argument expressed in (-IM_PI/2 .. +IM_PI/2) as it is easier to think about for user. const bool flip_label = (angle < 0.0f); angle -= IM_PI * 0.5f; const float cos_a = ImCos(angle); const float sin_a = ImSin(angle); const float label_cos_a = flip_label ? ImCos(angle + IM_PI) : cos_a; const float label_sin_a = flip_label ? ImSin(angle + IM_PI) : sin_a; const ImVec2 unit_right = ImVec2(cos_a, sin_a); // Calculate our base metrics and set angled headers data _before_ the first call to TableNextRow() // FIXME-STYLE: Would it be better for user to submit 'max_label_width' or 'row_height' ? One can be derived from the other. const float header_height = g.FontSize + g.Style.CellPadding.x * 2.0f; const float row_height = ImTrunc(ImFabs(ImRotate(ImVec2(max_label_width, flip_label ? +header_height : -header_height), cos_a, sin_a).y)); table->AngledHeadersHeight = row_height; table->AngledHeadersSlope = (sin_a != 0.0f) ? (cos_a / sin_a) : 0.0f; const ImVec2 header_angled_vector = unit_right * (row_height / -sin_a); // vector from bottom-left to top-left, and from bottom-right to top-right // Declare row, override and draw our own background TableNextRow(ImGuiTableRowFlags_Headers, row_height); TableNextColumn(); const ImRect row_r(table->WorkRect.Min.x, table->BgClipRect.Min.y, table->WorkRect.Max.x, table->RowPosY2); table->DrawSplitter->SetCurrentChannel(draw_list, TABLE_DRAW_CHANNEL_BG0); float clip_rect_min_x = table->BgClipRect.Min.x; if (table->FreezeColumnsCount > 0) clip_rect_min_x = ImMax(clip_rect_min_x, table->Columns[table->FreezeColumnsCount - 1].MaxX); TableSetBgColor(ImGuiTableBgTarget_RowBg0, 0); // Cancel PushClipRect(table->BgClipRect.Min, table->BgClipRect.Max, false); // Span all columns draw_list->AddRectFilled(ImVec2(table->BgClipRect.Min.x, row_r.Min.y), ImVec2(table->BgClipRect.Max.x, row_r.Max.y), GetColorU32(ImGuiCol_TableHeaderBg, 0.25f)); // FIXME-STYLE: Change row background with an arbitrary color. PushClipRect(ImVec2(clip_rect_min_x, table->BgClipRect.Min.y), table->BgClipRect.Max, true); // Span all columns ButtonBehavior(row_r, row_id, NULL, NULL); KeepAliveID(row_id); const float ascent_scaled = g.Font->Ascent * g.FontScale; // FIXME: Standardize those scaling factors better const float line_off_for_ascent_x = (ImMax((g.FontSize - ascent_scaled) * 0.5f, 0.0f) / -sin_a) * (flip_label ? -1.0f : 1.0f); const ImVec2 padding = g.Style.CellPadding; // We will always use swapped component const ImVec2 align = g.Style.TableAngledHeadersTextAlign; // Draw background and labels in first pass, then all borders. float max_x = -FLT_MAX; for (int pass = 0; pass < 2; pass++) for (int order_n = 0; order_n < data_count; order_n++) { const ImGuiTableHeaderData* request = &data[order_n]; const int column_n = request->Index; ImGuiTableColumn* column = &table->Columns[column_n]; ImVec2 bg_shape[4]; bg_shape[0] = ImVec2(column->MaxX, row_r.Max.y); bg_shape[1] = ImVec2(column->MinX, row_r.Max.y); bg_shape[2] = bg_shape[1] + header_angled_vector; bg_shape[3] = bg_shape[0] + header_angled_vector; if (pass == 0) { // Draw shape draw_list->AddQuadFilled(bg_shape[0], bg_shape[1], bg_shape[2], bg_shape[3], request->BgColor0); draw_list->AddQuadFilled(bg_shape[0], bg_shape[1], bg_shape[2], bg_shape[3], request->BgColor1); // Optional highlight max_x = ImMax(max_x, bg_shape[3].x); // Draw label // - First draw at an offset where RenderTextXXX() function won't meddle with applying current ClipRect, then transform to final offset. // - Handle multiple lines manually, as we want each lines to follow on the horizontal border, rather than see a whole block rotated. const char* label_name = TableGetColumnName(table, column_n); const char* label_name_end = FindRenderedTextEnd(label_name); const float line_off_step_x = (g.FontSize / -sin_a); const int label_lines = ImTextCountLines(label_name, label_name_end); // Left<>Right alignment float line_off_curr_x = flip_label ? (label_lines - 1) * line_off_step_x : 0.0f; float line_off_for_align_x = ImMax((((column->MaxX - column->MinX) - padding.x * 2.0f) - (label_lines * line_off_step_x)), 0.0f) * align.x; line_off_curr_x += line_off_for_align_x - line_off_for_ascent_x; // Register header width column->ContentMaxXHeadersUsed = column->ContentMaxXHeadersIdeal = column->WorkMinX + ImCeil(label_lines * line_off_step_x - line_off_for_align_x); while (label_name < label_name_end) { const char* label_name_eol = strchr(label_name, '\n'); if (label_name_eol == NULL) label_name_eol = label_name_end; // FIXME: Individual line clipping for right-most column is broken for negative angles. ImVec2 label_size = CalcTextSize(label_name, label_name_eol); float clip_width = max_label_width - padding.y; // Using padding.y*2.0f would be symmetrical but hide more text. float clip_height = ImMin(label_size.y, column->ClipRect.Max.x - column->WorkMinX - line_off_curr_x); ImRect clip_r(window->ClipRect.Min, window->ClipRect.Min + ImVec2(clip_width, clip_height)); int vtx_idx_begin = draw_list->_VtxCurrentIdx; PushStyleColor(ImGuiCol_Text, request->TextColor); RenderTextEllipsis(draw_list, clip_r.Min, clip_r.Max, clip_r.Max.x, clip_r.Max.x, label_name, label_name_eol, &label_size); PopStyleColor(); int vtx_idx_end = draw_list->_VtxCurrentIdx; // Up<>Down alignment const float available_space = ImMax(clip_width - label_size.x + ImAbs(padding.x * cos_a) * 2.0f - ImAbs(padding.y * sin_a) * 2.0f, 0.0f); const float vertical_offset = available_space * align.y * (flip_label ? -1.0f : 1.0f); // Rotate and offset label ImVec2 pivot_in = ImVec2(window->ClipRect.Min.x - vertical_offset, window->ClipRect.Min.y + label_size.y); ImVec2 pivot_out = ImVec2(column->WorkMinX, row_r.Max.y); line_off_curr_x += flip_label ? -line_off_step_x : line_off_step_x; pivot_out += unit_right * padding.y; if (flip_label) pivot_out += unit_right * (clip_width - ImMax(0.0f, clip_width - label_size.x)); pivot_out.x += flip_label ? line_off_curr_x + line_off_step_x : line_off_curr_x; ShadeVertsTransformPos(draw_list, vtx_idx_begin, vtx_idx_end, pivot_in, label_cos_a, label_sin_a, pivot_out); // Rotate and offset //if (g.IO.KeyShift) { ImDrawList* fg_dl = GetForegroundDrawList(); vtx_idx_begin = fg_dl->_VtxCurrentIdx; fg_dl->AddRect(clip_r.Min, clip_r.Max, IM_COL32(0, 255, 0, 255), 0.0f, 0, 1.0f); ShadeVertsTransformPos(fg_dl, vtx_idx_begin, fg_dl->_VtxCurrentIdx, pivot_in, label_cos_a, label_sin_a, pivot_out); } label_name = label_name_eol + 1; } } if (pass == 1) { // Draw border draw_list->AddLine(bg_shape[0], bg_shape[3], TableGetColumnBorderCol(table, order_n, column_n)); } } PopClipRect(); PopClipRect(); table->TempData->AngledHeadersExtraWidth = ImMax(0.0f, max_x - table->Columns[table->RightMostEnabledColumn].MaxX); } //------------------------------------------------------------------------- // [SECTION] Tables: Context Menu //------------------------------------------------------------------------- // - TableOpenContextMenu() [Internal] // - TableBeginContextMenuPopup() [Internal] // - TableDrawDefaultContextMenu() [Internal] //------------------------------------------------------------------------- // Use -1 to open menu not specific to a given column. void ImGui::TableOpenContextMenu(int column_n) { ImGuiContext& g = *GImGui; ImGuiTable* table = g.CurrentTable; if (column_n == -1 && table->CurrentColumn != -1) // When called within a column automatically use this one (for consistency) column_n = table->CurrentColumn; if (column_n == table->ColumnsCount) // To facilitate using with TableGetHoveredColumn() column_n = -1; IM_ASSERT(column_n >= -1 && column_n < table->ColumnsCount); if (table->Flags & (ImGuiTableFlags_Resizable | ImGuiTableFlags_Reorderable | ImGuiTableFlags_Hideable)) { table->IsContextPopupOpen = true; table->ContextPopupColumn = (ImGuiTableColumnIdx)column_n; table->InstanceInteracted = table->InstanceCurrent; const ImGuiID context_menu_id = ImHashStr("##ContextMenu", 0, table->ID); OpenPopupEx(context_menu_id, ImGuiPopupFlags_None); } } bool ImGui::TableBeginContextMenuPopup(ImGuiTable* table) { if (!table->IsContextPopupOpen || table->InstanceCurrent != table->InstanceInteracted) return false; const ImGuiID context_menu_id = ImHashStr("##ContextMenu", 0, table->ID); if (BeginPopupEx(context_menu_id, ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoSavedSettings)) return true; table->IsContextPopupOpen = false; return false; } // Output context menu into current window (generally a popup) // FIXME-TABLE: Ideally this should be writable by the user. Full programmatic access to that data? // Sections to display are pulled from 'flags_for_section_to_display', which is typically == table->Flags. // - ImGuiTableFlags_Resizable -> display Sizing menu items // - ImGuiTableFlags_Reorderable -> display "Reset Order" ////- ImGuiTableFlags_Sortable -> display sorting options (disabled) // - ImGuiTableFlags_Hideable -> display columns visibility menu items // It means if you have a custom context menus you can call this section and omit some sections, and add your own. void ImGui::TableDrawDefaultContextMenu(ImGuiTable* table, ImGuiTableFlags flags_for_section_to_display) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; if (window->SkipItems) return; bool want_separator = false; const int column_n = (table->ContextPopupColumn >= 0 && table->ContextPopupColumn < table->ColumnsCount) ? table->ContextPopupColumn : -1; ImGuiTableColumn* column = (column_n != -1) ? &table->Columns[column_n] : NULL; // Sizing if (flags_for_section_to_display & ImGuiTableFlags_Resizable) { if (column != NULL) { const bool can_resize = !(column->Flags & ImGuiTableColumnFlags_NoResize) && column->IsEnabled; if (MenuItem(LocalizeGetMsg(ImGuiLocKey_TableSizeOne), NULL, false, can_resize)) // "###SizeOne" TableSetColumnWidthAutoSingle(table, column_n); } const char* size_all_desc; if (table->ColumnsEnabledFixedCount == table->ColumnsEnabledCount && (table->Flags & ImGuiTableFlags_SizingMask_) != ImGuiTableFlags_SizingFixedSame) size_all_desc = LocalizeGetMsg(ImGuiLocKey_TableSizeAllFit); // "###SizeAll" All fixed else size_all_desc = LocalizeGetMsg(ImGuiLocKey_TableSizeAllDefault); // "###SizeAll" All stretch or mixed if (MenuItem(size_all_desc, NULL)) TableSetColumnWidthAutoAll(table); want_separator = true; } // Ordering if (flags_for_section_to_display & ImGuiTableFlags_Reorderable) { if (MenuItem(LocalizeGetMsg(ImGuiLocKey_TableResetOrder), NULL, false, !table->IsDefaultDisplayOrder)) table->IsResetDisplayOrderRequest = true; want_separator = true; } // Reset all (should work but seems unnecessary/noisy to expose?) //if (MenuItem("Reset all")) // table->IsResetAllRequest = true; // Sorting // (modify TableOpenContextMenu() to add _Sortable flag if enabling this) #if 0 if ((flags_for_section_to_display & ImGuiTableFlags_Sortable) && column != NULL && (column->Flags & ImGuiTableColumnFlags_NoSort) == 0) { if (want_separator) Separator(); want_separator = true; bool append_to_sort_specs = g.IO.KeyShift; if (MenuItem("Sort in Ascending Order", NULL, column->SortOrder != -1 && column->SortDirection == ImGuiSortDirection_Ascending, (column->Flags & ImGuiTableColumnFlags_NoSortAscending) == 0)) TableSetColumnSortDirection(table, column_n, ImGuiSortDirection_Ascending, append_to_sort_specs); if (MenuItem("Sort in Descending Order", NULL, column->SortOrder != -1 && column->SortDirection == ImGuiSortDirection_Descending, (column->Flags & ImGuiTableColumnFlags_NoSortDescending) == 0)) TableSetColumnSortDirection(table, column_n, ImGuiSortDirection_Descending, append_to_sort_specs); } #endif // Hiding / Visibility if (flags_for_section_to_display & ImGuiTableFlags_Hideable) { if (want_separator) Separator(); want_separator = true; PushItemFlag(ImGuiItemFlags_AutoClosePopups, false); for (int other_column_n = 0; other_column_n < table->ColumnsCount; other_column_n++) { ImGuiTableColumn* other_column = &table->Columns[other_column_n]; if (other_column->Flags & ImGuiTableColumnFlags_Disabled) continue; const char* name = TableGetColumnName(table, other_column_n); if (name == NULL || name[0] == 0) name = ""; // Make sure we can't hide the last active column bool menu_item_active = (other_column->Flags & ImGuiTableColumnFlags_NoHide) ? false : true; if (other_column->IsUserEnabled && table->ColumnsEnabledCount <= 1) menu_item_active = false; if (MenuItem(name, NULL, other_column->IsUserEnabled, menu_item_active)) other_column->IsUserEnabledNextFrame = !other_column->IsUserEnabled; } PopItemFlag(); } } //------------------------------------------------------------------------- // [SECTION] Tables: Settings (.ini data) //------------------------------------------------------------------------- // FIXME: The binding/finding/creating flow are too confusing. //------------------------------------------------------------------------- // - TableSettingsInit() [Internal] // - TableSettingsCalcChunkSize() [Internal] // - TableSettingsCreate() [Internal] // - TableSettingsFindByID() [Internal] // - TableGetBoundSettings() [Internal] // - TableResetSettings() // - TableSaveSettings() [Internal] // - TableLoadSettings() [Internal] // - TableSettingsHandler_ClearAll() [Internal] // - TableSettingsHandler_ApplyAll() [Internal] // - TableSettingsHandler_ReadOpen() [Internal] // - TableSettingsHandler_ReadLine() [Internal] // - TableSettingsHandler_WriteAll() [Internal] // - TableSettingsInstallHandler() [Internal] //------------------------------------------------------------------------- // [Init] 1: TableSettingsHandler_ReadXXXX() Load and parse .ini file into TableSettings. // [Main] 2: TableLoadSettings() When table is created, bind Table to TableSettings, serialize TableSettings data into Table. // [Main] 3: TableSaveSettings() When table properties are modified, serialize Table data into bound or new TableSettings, mark .ini as dirty. // [Main] 4: TableSettingsHandler_WriteAll() When .ini file is dirty (which can come from other source), save TableSettings into .ini file. //------------------------------------------------------------------------- // Clear and initialize empty settings instance static void TableSettingsInit(ImGuiTableSettings* settings, ImGuiID id, int columns_count, int columns_count_max) { IM_PLACEMENT_NEW(settings) ImGuiTableSettings(); ImGuiTableColumnSettings* settings_column = settings->GetColumnSettings(); for (int n = 0; n < columns_count_max; n++, settings_column++) IM_PLACEMENT_NEW(settings_column) ImGuiTableColumnSettings(); settings->ID = id; settings->ColumnsCount = (ImGuiTableColumnIdx)columns_count; settings->ColumnsCountMax = (ImGuiTableColumnIdx)columns_count_max; settings->WantApply = true; } static size_t TableSettingsCalcChunkSize(int columns_count) { return sizeof(ImGuiTableSettings) + (size_t)columns_count * sizeof(ImGuiTableColumnSettings); } ImGuiTableSettings* ImGui::TableSettingsCreate(ImGuiID id, int columns_count) { ImGuiContext& g = *GImGui; ImGuiTableSettings* settings = g.SettingsTables.alloc_chunk(TableSettingsCalcChunkSize(columns_count)); TableSettingsInit(settings, id, columns_count, columns_count); return settings; } // Find existing settings ImGuiTableSettings* ImGui::TableSettingsFindByID(ImGuiID id) { // FIXME-OPT: Might want to store a lookup map for this? ImGuiContext& g = *GImGui; for (ImGuiTableSettings* settings = g.SettingsTables.begin(); settings != NULL; settings = g.SettingsTables.next_chunk(settings)) if (settings->ID == id) return settings; return NULL; } // Get settings for a given table, NULL if none ImGuiTableSettings* ImGui::TableGetBoundSettings(ImGuiTable* table) { if (table->SettingsOffset != -1) { ImGuiContext& g = *GImGui; ImGuiTableSettings* settings = g.SettingsTables.ptr_from_offset(table->SettingsOffset); IM_ASSERT(settings->ID == table->ID); if (settings->ColumnsCountMax >= table->ColumnsCount) return settings; // OK settings->ID = 0; // Invalidate storage, we won't fit because of a count change } return NULL; } // Restore initial state of table (with or without saved settings) void ImGui::TableResetSettings(ImGuiTable* table) { table->IsInitializing = table->IsSettingsDirty = true; table->IsResetAllRequest = false; table->IsSettingsRequestLoad = false; // Don't reload from ini table->SettingsLoadedFlags = ImGuiTableFlags_None; // Mark as nothing loaded so our initialized data becomes authoritative } void ImGui::TableSaveSettings(ImGuiTable* table) { table->IsSettingsDirty = false; if (table->Flags & ImGuiTableFlags_NoSavedSettings) return; // Bind or create settings data ImGuiContext& g = *GImGui; ImGuiTableSettings* settings = TableGetBoundSettings(table); if (settings == NULL) { settings = TableSettingsCreate(table->ID, table->ColumnsCount); table->SettingsOffset = g.SettingsTables.offset_from_ptr(settings); } settings->ColumnsCount = (ImGuiTableColumnIdx)table->ColumnsCount; // Serialize ImGuiTable/ImGuiTableColumn into ImGuiTableSettings/ImGuiTableColumnSettings IM_ASSERT(settings->ID == table->ID); IM_ASSERT(settings->ColumnsCount == table->ColumnsCount && settings->ColumnsCountMax >= settings->ColumnsCount); ImGuiTableColumn* column = table->Columns.Data; ImGuiTableColumnSettings* column_settings = settings->GetColumnSettings(); bool save_ref_scale = false; settings->SaveFlags = ImGuiTableFlags_None; for (int n = 0; n < table->ColumnsCount; n++, column++, column_settings++) { const float width_or_weight = (column->Flags & ImGuiTableColumnFlags_WidthStretch) ? column->StretchWeight : column->WidthRequest; column_settings->WidthOrWeight = width_or_weight; column_settings->Index = (ImGuiTableColumnIdx)n; column_settings->DisplayOrder = column->DisplayOrder; column_settings->SortOrder = column->SortOrder; column_settings->SortDirection = column->SortDirection; column_settings->IsEnabled = column->IsUserEnabled; column_settings->IsStretch = (column->Flags & ImGuiTableColumnFlags_WidthStretch) ? 1 : 0; if ((column->Flags & ImGuiTableColumnFlags_WidthStretch) == 0) save_ref_scale = true; // We skip saving some data in the .ini file when they are unnecessary to restore our state. // Note that fixed width where initial width was derived from auto-fit will always be saved as InitStretchWeightOrWidth will be 0.0f. // FIXME-TABLE: We don't have logic to easily compare SortOrder to DefaultSortOrder yet so it's always saved when present. if (width_or_weight != column->InitStretchWeightOrWidth) settings->SaveFlags |= ImGuiTableFlags_Resizable; if (column->DisplayOrder != n) settings->SaveFlags |= ImGuiTableFlags_Reorderable; if (column->SortOrder != -1) settings->SaveFlags |= ImGuiTableFlags_Sortable; if (column->IsUserEnabled != ((column->Flags & ImGuiTableColumnFlags_DefaultHide) == 0)) settings->SaveFlags |= ImGuiTableFlags_Hideable; } settings->SaveFlags &= table->Flags; settings->RefScale = save_ref_scale ? table->RefScale : 0.0f; MarkIniSettingsDirty(); } void ImGui::TableLoadSettings(ImGuiTable* table) { ImGuiContext& g = *GImGui; table->IsSettingsRequestLoad = false; if (table->Flags & ImGuiTableFlags_NoSavedSettings) return; // Bind settings ImGuiTableSettings* settings; if (table->SettingsOffset == -1) { settings = TableSettingsFindByID(table->ID); if (settings == NULL) return; if (settings->ColumnsCount != table->ColumnsCount) // Allow settings if columns count changed. We could otherwise decide to return... table->IsSettingsDirty = true; table->SettingsOffset = g.SettingsTables.offset_from_ptr(settings); } else { settings = TableGetBoundSettings(table); } table->SettingsLoadedFlags = settings->SaveFlags; table->RefScale = settings->RefScale; // Initialize default columns settings for (int column_n = 0; column_n < table->ColumnsCount; column_n++) { ImGuiTableColumn* column = &table->Columns[column_n]; TableInitColumnDefaults(table, column, ~0); column->AutoFitQueue = 0x00; } // Serialize ImGuiTableSettings/ImGuiTableColumnSettings into ImGuiTable/ImGuiTableColumn ImGuiTableColumnSettings* column_settings = settings->GetColumnSettings(); ImU64 display_order_mask = 0; for (int data_n = 0; data_n < settings->ColumnsCount; data_n++, column_settings++) { int column_n = column_settings->Index; if (column_n < 0 || column_n >= table->ColumnsCount) continue; ImGuiTableColumn* column = &table->Columns[column_n]; if (settings->SaveFlags & ImGuiTableFlags_Resizable) { if (column_settings->IsStretch) column->StretchWeight = column_settings->WidthOrWeight; else column->WidthRequest = column_settings->WidthOrWeight; } if (settings->SaveFlags & ImGuiTableFlags_Reorderable) column->DisplayOrder = column_settings->DisplayOrder; display_order_mask |= (ImU64)1 << column->DisplayOrder; if ((settings->SaveFlags & ImGuiTableFlags_Hideable) && column_settings->IsEnabled != -1) column->IsUserEnabled = column->IsUserEnabledNextFrame = column_settings->IsEnabled == 1; column->SortOrder = column_settings->SortOrder; column->SortDirection = column_settings->SortDirection; } // Validate and fix invalid display order data const ImU64 expected_display_order_mask = (settings->ColumnsCount == 64) ? ~0 : ((ImU64)1 << settings->ColumnsCount) - 1; if (display_order_mask != expected_display_order_mask) for (int column_n = 0; column_n < table->ColumnsCount; column_n++) table->Columns[column_n].DisplayOrder = (ImGuiTableColumnIdx)column_n; // Rebuild index for (int column_n = 0; column_n < table->ColumnsCount; column_n++) table->DisplayOrderToIndex[table->Columns[column_n].DisplayOrder] = (ImGuiTableColumnIdx)column_n; } static void TableSettingsHandler_ClearAll(ImGuiContext* ctx, ImGuiSettingsHandler*) { ImGuiContext& g = *ctx; for (int i = 0; i != g.Tables.GetMapSize(); i++) if (ImGuiTable* table = g.Tables.TryGetMapData(i)) table->SettingsOffset = -1; g.SettingsTables.clear(); } // Apply to existing windows (if any) static void TableSettingsHandler_ApplyAll(ImGuiContext* ctx, ImGuiSettingsHandler*) { ImGuiContext& g = *ctx; for (int i = 0; i != g.Tables.GetMapSize(); i++) if (ImGuiTable* table = g.Tables.TryGetMapData(i)) { table->IsSettingsRequestLoad = true; table->SettingsOffset = -1; } } static void* TableSettingsHandler_ReadOpen(ImGuiContext*, ImGuiSettingsHandler*, const char* name) { ImGuiID id = 0; int columns_count = 0; if (sscanf(name, "0x%08X,%d", &id, &columns_count) < 2) return NULL; if (ImGuiTableSettings* settings = ImGui::TableSettingsFindByID(id)) { if (settings->ColumnsCountMax >= columns_count) { TableSettingsInit(settings, id, columns_count, settings->ColumnsCountMax); // Recycle return settings; } settings->ID = 0; // Invalidate storage, we won't fit because of a count change } return ImGui::TableSettingsCreate(id, columns_count); } static void TableSettingsHandler_ReadLine(ImGuiContext*, ImGuiSettingsHandler*, void* entry, const char* line) { // "Column 0 UserID=0x42AD2D21 Width=100 Visible=1 Order=0 Sort=0v" ImGuiTableSettings* settings = (ImGuiTableSettings*)entry; float f = 0.0f; int column_n = 0, r = 0, n = 0; if (sscanf(line, "RefScale=%f", &f) == 1) { settings->RefScale = f; return; } if (sscanf(line, "Column %d%n", &column_n, &r) == 1) { if (column_n < 0 || column_n >= settings->ColumnsCount) return; line = ImStrSkipBlank(line + r); char c = 0; ImGuiTableColumnSettings* column = settings->GetColumnSettings() + column_n; column->Index = (ImGuiTableColumnIdx)column_n; if (sscanf(line, "UserID=0x%08X%n", (ImU32*)&n, &r)==1) { line = ImStrSkipBlank(line + r); column->UserID = (ImGuiID)n; } if (sscanf(line, "Width=%d%n", &n, &r) == 1) { line = ImStrSkipBlank(line + r); column->WidthOrWeight = (float)n; column->IsStretch = 0; settings->SaveFlags |= ImGuiTableFlags_Resizable; } if (sscanf(line, "Weight=%f%n", &f, &r) == 1) { line = ImStrSkipBlank(line + r); column->WidthOrWeight = f; column->IsStretch = 1; settings->SaveFlags |= ImGuiTableFlags_Resizable; } if (sscanf(line, "Visible=%d%n", &n, &r) == 1) { line = ImStrSkipBlank(line + r); column->IsEnabled = (ImU8)n; settings->SaveFlags |= ImGuiTableFlags_Hideable; } if (sscanf(line, "Order=%d%n", &n, &r) == 1) { line = ImStrSkipBlank(line + r); column->DisplayOrder = (ImGuiTableColumnIdx)n; settings->SaveFlags |= ImGuiTableFlags_Reorderable; } if (sscanf(line, "Sort=%d%c%n", &n, &c, &r) == 2) { line = ImStrSkipBlank(line + r); column->SortOrder = (ImGuiTableColumnIdx)n; column->SortDirection = (c == '^') ? ImGuiSortDirection_Descending : ImGuiSortDirection_Ascending; settings->SaveFlags |= ImGuiTableFlags_Sortable; } } } static void TableSettingsHandler_WriteAll(ImGuiContext* ctx, ImGuiSettingsHandler* handler, ImGuiTextBuffer* buf) { ImGuiContext& g = *ctx; for (ImGuiTableSettings* settings = g.SettingsTables.begin(); settings != NULL; settings = g.SettingsTables.next_chunk(settings)) { if (settings->ID == 0) // Skip ditched settings continue; // TableSaveSettings() may clear some of those flags when we establish that the data can be stripped // (e.g. Order was unchanged) const bool save_size = (settings->SaveFlags & ImGuiTableFlags_Resizable) != 0; const bool save_visible = (settings->SaveFlags & ImGuiTableFlags_Hideable) != 0; const bool save_order = (settings->SaveFlags & ImGuiTableFlags_Reorderable) != 0; const bool save_sort = (settings->SaveFlags & ImGuiTableFlags_Sortable) != 0; // We need to save the [Table] entry even if all the bools are false, since this records a table with "default settings". buf->reserve(buf->size() + 30 + settings->ColumnsCount * 50); // ballpark reserve buf->appendf("[%s][0x%08X,%d]\n", handler->TypeName, settings->ID, settings->ColumnsCount); if (settings->RefScale != 0.0f) buf->appendf("RefScale=%g\n", settings->RefScale); ImGuiTableColumnSettings* column = settings->GetColumnSettings(); for (int column_n = 0; column_n < settings->ColumnsCount; column_n++, column++) { // "Column 0 UserID=0x42AD2D21 Width=100 Visible=1 Order=0 Sort=0v" bool save_column = column->UserID != 0 || save_size || save_visible || save_order || (save_sort && column->SortOrder != -1); if (!save_column) continue; buf->appendf("Column %-2d", column_n); if (column->UserID != 0) { buf->appendf(" UserID=%08X", column->UserID); } if (save_size && column->IsStretch) { buf->appendf(" Weight=%.4f", column->WidthOrWeight); } if (save_size && !column->IsStretch) { buf->appendf(" Width=%d", (int)column->WidthOrWeight); } if (save_visible) { buf->appendf(" Visible=%d", column->IsEnabled); } if (save_order) { buf->appendf(" Order=%d", column->DisplayOrder); } if (save_sort && column->SortOrder != -1) { buf->appendf(" Sort=%d%c", column->SortOrder, (column->SortDirection == ImGuiSortDirection_Ascending) ? 'v' : '^'); } buf->append("\n"); } buf->append("\n"); } } void ImGui::TableSettingsAddSettingsHandler() { ImGuiSettingsHandler ini_handler; ini_handler.TypeName = "Table"; ini_handler.TypeHash = ImHashStr("Table"); ini_handler.ClearAllFn = TableSettingsHandler_ClearAll; ini_handler.ReadOpenFn = TableSettingsHandler_ReadOpen; ini_handler.ReadLineFn = TableSettingsHandler_ReadLine; ini_handler.ApplyAllFn = TableSettingsHandler_ApplyAll; ini_handler.WriteAllFn = TableSettingsHandler_WriteAll; AddSettingsHandler(&ini_handler); } //------------------------------------------------------------------------- // [SECTION] Tables: Garbage Collection //------------------------------------------------------------------------- // - TableRemove() [Internal] // - TableGcCompactTransientBuffers() [Internal] // - TableGcCompactSettings() [Internal] //------------------------------------------------------------------------- // Remove Table (currently only used by TestEngine) void ImGui::TableRemove(ImGuiTable* table) { //IMGUI_DEBUG_PRINT("TableRemove() id=0x%08X\n", table->ID); ImGuiContext& g = *GImGui; int table_idx = g.Tables.GetIndex(table); //memset(table->RawData.Data, 0, table->RawData.size_in_bytes()); //memset(table, 0, sizeof(ImGuiTable)); g.Tables.Remove(table->ID, table); g.TablesLastTimeActive[table_idx] = -1.0f; } // Free up/compact internal Table buffers for when it gets unused void ImGui::TableGcCompactTransientBuffers(ImGuiTable* table) { //IMGUI_DEBUG_PRINT("TableGcCompactTransientBuffers() id=0x%08X\n", table->ID); ImGuiContext& g = *GImGui; IM_ASSERT(table->MemoryCompacted == false); table->SortSpecs.Specs = NULL; table->SortSpecsMulti.clear(); table->IsSortSpecsDirty = true; // FIXME: In theory shouldn't have to leak into user performing a sort on resume. table->ColumnsNames.clear(); table->MemoryCompacted = true; for (int n = 0; n < table->ColumnsCount; n++) table->Columns[n].NameOffset = -1; g.TablesLastTimeActive[g.Tables.GetIndex(table)] = -1.0f; } void ImGui::TableGcCompactTransientBuffers(ImGuiTableTempData* temp_data) { temp_data->DrawSplitter.ClearFreeMemory(); temp_data->LastTimeActive = -1.0f; } // Compact and remove unused settings data (currently only used by TestEngine) void ImGui::TableGcCompactSettings() { ImGuiContext& g = *GImGui; int required_memory = 0; for (ImGuiTableSettings* settings = g.SettingsTables.begin(); settings != NULL; settings = g.SettingsTables.next_chunk(settings)) if (settings->ID != 0) required_memory += (int)TableSettingsCalcChunkSize(settings->ColumnsCount); if (required_memory == g.SettingsTables.Buf.Size) return; ImChunkStream new_chunk_stream; new_chunk_stream.Buf.reserve(required_memory); for (ImGuiTableSettings* settings = g.SettingsTables.begin(); settings != NULL; settings = g.SettingsTables.next_chunk(settings)) if (settings->ID != 0) memcpy(new_chunk_stream.alloc_chunk(TableSettingsCalcChunkSize(settings->ColumnsCount)), settings, TableSettingsCalcChunkSize(settings->ColumnsCount)); g.SettingsTables.swap(new_chunk_stream); } //------------------------------------------------------------------------- // [SECTION] Tables: Debugging //------------------------------------------------------------------------- // - DebugNodeTable() [Internal] //------------------------------------------------------------------------- #ifndef IMGUI_DISABLE_DEBUG_TOOLS static const char* DebugNodeTableGetSizingPolicyDesc(ImGuiTableFlags sizing_policy) { sizing_policy &= ImGuiTableFlags_SizingMask_; if (sizing_policy == ImGuiTableFlags_SizingFixedFit) { return "FixedFit"; } if (sizing_policy == ImGuiTableFlags_SizingFixedSame) { return "FixedSame"; } if (sizing_policy == ImGuiTableFlags_SizingStretchProp) { return "StretchProp"; } if (sizing_policy == ImGuiTableFlags_SizingStretchSame) { return "StretchSame"; } return "N/A"; } void ImGui::DebugNodeTable(ImGuiTable* table) { ImGuiContext& g = *GImGui; const bool is_active = (table->LastFrameActive >= g.FrameCount - 2); // Note that fully clipped early out scrolling tables will appear as inactive here. if (!is_active) { PushStyleColor(ImGuiCol_Text, GetStyleColorVec4(ImGuiCol_TextDisabled)); } bool open = TreeNode(table, "Table 0x%08X (%d columns, in '%s')%s", table->ID, table->ColumnsCount, table->OuterWindow->Name, is_active ? "" : " *Inactive*"); if (!is_active) { PopStyleColor(); } if (IsItemHovered()) GetForegroundDrawList()->AddRect(table->OuterRect.Min, table->OuterRect.Max, IM_COL32(255, 255, 0, 255)); if (IsItemVisible() && table->HoveredColumnBody != -1) GetForegroundDrawList()->AddRect(GetItemRectMin(), GetItemRectMax(), IM_COL32(255, 255, 0, 255)); if (!open) return; if (table->InstanceCurrent > 0) Text("** %d instances of same table! Some data below will refer to last instance.", table->InstanceCurrent + 1); if (g.IO.ConfigDebugIsDebuggerPresent) { if (DebugBreakButton("**DebugBreak**", "in BeginTable()")) g.DebugBreakInTable = table->ID; SameLine(); } bool clear_settings = SmallButton("Clear settings"); BulletText("OuterRect: Pos: (%.1f,%.1f) Size: (%.1f,%.1f) Sizing: '%s'", table->OuterRect.Min.x, table->OuterRect.Min.y, table->OuterRect.GetWidth(), table->OuterRect.GetHeight(), DebugNodeTableGetSizingPolicyDesc(table->Flags)); BulletText("ColumnsGivenWidth: %.1f, ColumnsAutoFitWidth: %.1f, InnerWidth: %.1f%s", table->ColumnsGivenWidth, table->ColumnsAutoFitWidth, table->InnerWidth, table->InnerWidth == 0.0f ? " (auto)" : ""); BulletText("CellPaddingX: %.1f, CellSpacingX: %.1f/%.1f, OuterPaddingX: %.1f", table->CellPaddingX, table->CellSpacingX1, table->CellSpacingX2, table->OuterPaddingX); BulletText("HoveredColumnBody: %d, HoveredColumnBorder: %d", table->HoveredColumnBody, table->HoveredColumnBorder); BulletText("ResizedColumn: %d, ReorderColumn: %d, HeldHeaderColumn: %d", table->ResizedColumn, table->ReorderColumn, table->HeldHeaderColumn); for (int n = 0; n < table->InstanceCurrent + 1; n++) { ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, n); BulletText("Instance %d: HoveredRow: %d, LastOuterHeight: %.2f", n, table_instance->HoveredRowLast, table_instance->LastOuterHeight); } //BulletText("BgDrawChannels: %d/%d", 0, table->BgDrawChannelUnfrozen); float sum_weights = 0.0f; for (int n = 0; n < table->ColumnsCount; n++) if (table->Columns[n].Flags & ImGuiTableColumnFlags_WidthStretch) sum_weights += table->Columns[n].StretchWeight; for (int n = 0; n < table->ColumnsCount; n++) { ImGuiTableColumn* column = &table->Columns[n]; const char* name = TableGetColumnName(table, n); char buf[512]; ImFormatString(buf, IM_ARRAYSIZE(buf), "Column %d order %d '%s': offset %+.2f to %+.2f%s\n" "Enabled: %d, VisibleX/Y: %d/%d, RequestOutput: %d, SkipItems: %d, DrawChannels: %d,%d\n" "WidthGiven: %.1f, Request/Auto: %.1f/%.1f, StretchWeight: %.3f (%.1f%%)\n" "MinX: %.1f, MaxX: %.1f (%+.1f), ClipRect: %.1f to %.1f (+%.1f)\n" "ContentWidth: %.1f,%.1f, HeadersUsed/Ideal %.1f/%.1f\n" "Sort: %d%s, UserID: 0x%08X, Flags: 0x%04X: %s%s%s..", n, column->DisplayOrder, name, column->MinX - table->WorkRect.Min.x, column->MaxX - table->WorkRect.Min.x, (n < table->FreezeColumnsRequest) ? " (Frozen)" : "", column->IsEnabled, column->IsVisibleX, column->IsVisibleY, column->IsRequestOutput, column->IsSkipItems, column->DrawChannelFrozen, column->DrawChannelUnfrozen, column->WidthGiven, column->WidthRequest, column->WidthAuto, column->StretchWeight, column->StretchWeight > 0.0f ? (column->StretchWeight / sum_weights) * 100.0f : 0.0f, column->MinX, column->MaxX, column->MaxX - column->MinX, column->ClipRect.Min.x, column->ClipRect.Max.x, column->ClipRect.Max.x - column->ClipRect.Min.x, column->ContentMaxXFrozen - column->WorkMinX, column->ContentMaxXUnfrozen - column->WorkMinX, column->ContentMaxXHeadersUsed - column->WorkMinX, column->ContentMaxXHeadersIdeal - column->WorkMinX, column->SortOrder, (column->SortDirection == ImGuiSortDirection_Ascending) ? " (Asc)" : (column->SortDirection == ImGuiSortDirection_Descending) ? " (Des)" : "", column->UserID, column->Flags, (column->Flags & ImGuiTableColumnFlags_WidthStretch) ? "WidthStretch " : "", (column->Flags & ImGuiTableColumnFlags_WidthFixed) ? "WidthFixed " : "", (column->Flags & ImGuiTableColumnFlags_NoResize) ? "NoResize " : ""); Bullet(); Selectable(buf); if (IsItemHovered()) { ImRect r(column->MinX, table->OuterRect.Min.y, column->MaxX, table->OuterRect.Max.y); GetForegroundDrawList()->AddRect(r.Min, r.Max, IM_COL32(255, 255, 0, 255)); } } if (ImGuiTableSettings* settings = TableGetBoundSettings(table)) DebugNodeTableSettings(settings); if (clear_settings) table->IsResetAllRequest = true; TreePop(); } void ImGui::DebugNodeTableSettings(ImGuiTableSettings* settings) { if (!TreeNode((void*)(intptr_t)settings->ID, "Settings 0x%08X (%d columns)", settings->ID, settings->ColumnsCount)) return; BulletText("SaveFlags: 0x%08X", settings->SaveFlags); BulletText("ColumnsCount: %d (max %d)", settings->ColumnsCount, settings->ColumnsCountMax); for (int n = 0; n < settings->ColumnsCount; n++) { ImGuiTableColumnSettings* column_settings = &settings->GetColumnSettings()[n]; ImGuiSortDirection sort_dir = (column_settings->SortOrder != -1) ? (ImGuiSortDirection)column_settings->SortDirection : ImGuiSortDirection_None; BulletText("Column %d Order %d SortOrder %d %s Vis %d %s %7.3f UserID 0x%08X", n, column_settings->DisplayOrder, column_settings->SortOrder, (sort_dir == ImGuiSortDirection_Ascending) ? "Asc" : (sort_dir == ImGuiSortDirection_Descending) ? "Des" : "---", column_settings->IsEnabled, column_settings->IsStretch ? "Weight" : "Width ", column_settings->WidthOrWeight, column_settings->UserID); } TreePop(); } #else // #ifndef IMGUI_DISABLE_DEBUG_TOOLS void ImGui::DebugNodeTable(ImGuiTable*) {} void ImGui::DebugNodeTableSettings(ImGuiTableSettings*) {} #endif //------------------------------------------------------------------------- // [SECTION] Columns, BeginColumns, EndColumns, etc. // (This is a legacy API, prefer using BeginTable/EndTable!) //------------------------------------------------------------------------- // FIXME: sizing is lossy when columns width is very small (default width may turn negative etc.) //------------------------------------------------------------------------- // - SetWindowClipRectBeforeSetChannel() [Internal] // - GetColumnIndex() // - GetColumnsCount() // - GetColumnOffset() // - GetColumnWidth() // - SetColumnOffset() // - SetColumnWidth() // - PushColumnClipRect() [Internal] // - PushColumnsBackground() [Internal] // - PopColumnsBackground() [Internal] // - FindOrCreateColumns() [Internal] // - GetColumnsID() [Internal] // - BeginColumns() // - NextColumn() // - EndColumns() // - Columns() //------------------------------------------------------------------------- // [Internal] Small optimization to avoid calls to PopClipRect/SetCurrentChannel/PushClipRect in sequences, // they would meddle many times with the underlying ImDrawCmd. // Instead, we do a preemptive overwrite of clipping rectangle _without_ altering the command-buffer and let // the subsequent single call to SetCurrentChannel() does it things once. void ImGui::SetWindowClipRectBeforeSetChannel(ImGuiWindow* window, const ImRect& clip_rect) { ImVec4 clip_rect_vec4 = clip_rect.ToVec4(); window->ClipRect = clip_rect; window->DrawList->_CmdHeader.ClipRect = clip_rect_vec4; window->DrawList->_ClipRectStack.Data[window->DrawList->_ClipRectStack.Size - 1] = clip_rect_vec4; } int ImGui::GetColumnIndex() { ImGuiWindow* window = GetCurrentWindowRead(); return window->DC.CurrentColumns ? window->DC.CurrentColumns->Current : 0; } int ImGui::GetColumnsCount() { ImGuiWindow* window = GetCurrentWindowRead(); return window->DC.CurrentColumns ? window->DC.CurrentColumns->Count : 1; } float ImGui::GetColumnOffsetFromNorm(const ImGuiOldColumns* columns, float offset_norm) { return offset_norm * (columns->OffMaxX - columns->OffMinX); } float ImGui::GetColumnNormFromOffset(const ImGuiOldColumns* columns, float offset) { return offset / (columns->OffMaxX - columns->OffMinX); } static const float COLUMNS_HIT_RECT_HALF_THICKNESS = 4.0f; static float GetDraggedColumnOffset(ImGuiOldColumns* columns, int column_index) { // Active (dragged) column always follow mouse. The reason we need this is that dragging a column to the right edge of an auto-resizing // window creates a feedback loop because we store normalized positions. So while dragging we enforce absolute positioning. ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; IM_ASSERT(column_index > 0); // We are not supposed to drag column 0. IM_ASSERT(g.ActiveId == columns->ID + ImGuiID(column_index)); float x = g.IO.MousePos.x - g.ActiveIdClickOffset.x + ImTrunc(COLUMNS_HIT_RECT_HALF_THICKNESS * g.CurrentDpiScale) - window->Pos.x; x = ImMax(x, ImGui::GetColumnOffset(column_index - 1) + g.Style.ColumnsMinSpacing); if ((columns->Flags & ImGuiOldColumnFlags_NoPreserveWidths)) x = ImMin(x, ImGui::GetColumnOffset(column_index + 1) - g.Style.ColumnsMinSpacing); return x; } float ImGui::GetColumnOffset(int column_index) { ImGuiWindow* window = GetCurrentWindowRead(); ImGuiOldColumns* columns = window->DC.CurrentColumns; if (columns == NULL) return 0.0f; if (column_index < 0) column_index = columns->Current; IM_ASSERT(column_index < columns->Columns.Size); const float t = columns->Columns[column_index].OffsetNorm; const float x_offset = ImLerp(columns->OffMinX, columns->OffMaxX, t); return x_offset; } static float GetColumnWidthEx(ImGuiOldColumns* columns, int column_index, bool before_resize = false) { if (column_index < 0) column_index = columns->Current; float offset_norm; if (before_resize) offset_norm = columns->Columns[column_index + 1].OffsetNormBeforeResize - columns->Columns[column_index].OffsetNormBeforeResize; else offset_norm = columns->Columns[column_index + 1].OffsetNorm - columns->Columns[column_index].OffsetNorm; return ImGui::GetColumnOffsetFromNorm(columns, offset_norm); } float ImGui::GetColumnWidth(int column_index) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; ImGuiOldColumns* columns = window->DC.CurrentColumns; if (columns == NULL) return GetContentRegionAvail().x; if (column_index < 0) column_index = columns->Current; return GetColumnOffsetFromNorm(columns, columns->Columns[column_index + 1].OffsetNorm - columns->Columns[column_index].OffsetNorm); } void ImGui::SetColumnOffset(int column_index, float offset) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; ImGuiOldColumns* columns = window->DC.CurrentColumns; IM_ASSERT(columns != NULL); if (column_index < 0) column_index = columns->Current; IM_ASSERT(column_index < columns->Columns.Size); const bool preserve_width = !(columns->Flags & ImGuiOldColumnFlags_NoPreserveWidths) && (column_index < columns->Count - 1); const float width = preserve_width ? GetColumnWidthEx(columns, column_index, columns->IsBeingResized) : 0.0f; if (!(columns->Flags & ImGuiOldColumnFlags_NoForceWithinWindow)) offset = ImMin(offset, columns->OffMaxX - g.Style.ColumnsMinSpacing * (columns->Count - column_index)); columns->Columns[column_index].OffsetNorm = GetColumnNormFromOffset(columns, offset - columns->OffMinX); if (preserve_width) SetColumnOffset(column_index + 1, offset + ImMax(g.Style.ColumnsMinSpacing, width)); } void ImGui::SetColumnWidth(int column_index, float width) { ImGuiWindow* window = GetCurrentWindowRead(); ImGuiOldColumns* columns = window->DC.CurrentColumns; IM_ASSERT(columns != NULL); if (column_index < 0) column_index = columns->Current; SetColumnOffset(column_index + 1, GetColumnOffset(column_index) + width); } void ImGui::PushColumnClipRect(int column_index) { ImGuiWindow* window = GetCurrentWindowRead(); ImGuiOldColumns* columns = window->DC.CurrentColumns; if (column_index < 0) column_index = columns->Current; ImGuiOldColumnData* column = &columns->Columns[column_index]; PushClipRect(column->ClipRect.Min, column->ClipRect.Max, false); } // Get into the columns background draw command (which is generally the same draw command as before we called BeginColumns) void ImGui::PushColumnsBackground() { ImGuiWindow* window = GetCurrentWindowRead(); ImGuiOldColumns* columns = window->DC.CurrentColumns; if (columns->Count == 1) return; // Optimization: avoid SetCurrentChannel() + PushClipRect() columns->HostBackupClipRect = window->ClipRect; SetWindowClipRectBeforeSetChannel(window, columns->HostInitialClipRect); columns->Splitter.SetCurrentChannel(window->DrawList, 0); } void ImGui::PopColumnsBackground() { ImGuiWindow* window = GetCurrentWindowRead(); ImGuiOldColumns* columns = window->DC.CurrentColumns; if (columns->Count == 1) return; // Optimization: avoid PopClipRect() + SetCurrentChannel() SetWindowClipRectBeforeSetChannel(window, columns->HostBackupClipRect); columns->Splitter.SetCurrentChannel(window->DrawList, columns->Current + 1); } ImGuiOldColumns* ImGui::FindOrCreateColumns(ImGuiWindow* window, ImGuiID id) { // We have few columns per window so for now we don't need bother much with turning this into a faster lookup. for (int n = 0; n < window->ColumnsStorage.Size; n++) if (window->ColumnsStorage[n].ID == id) return &window->ColumnsStorage[n]; window->ColumnsStorage.push_back(ImGuiOldColumns()); ImGuiOldColumns* columns = &window->ColumnsStorage.back(); columns->ID = id; return columns; } ImGuiID ImGui::GetColumnsID(const char* str_id, int columns_count) { ImGuiWindow* window = GetCurrentWindow(); // Differentiate column ID with an arbitrary prefix for cases where users name their columns set the same as another widget. // In addition, when an identifier isn't explicitly provided we include the number of columns in the hash to make it uniquer. PushID(0x11223347 + (str_id ? 0 : columns_count)); ImGuiID id = window->GetID(str_id ? str_id : "columns"); PopID(); return id; } void ImGui::BeginColumns(const char* str_id, int columns_count, ImGuiOldColumnFlags flags) { ImGuiContext& g = *GImGui; ImGuiWindow* window = GetCurrentWindow(); IM_ASSERT(columns_count >= 1); IM_ASSERT(window->DC.CurrentColumns == NULL); // Nested columns are currently not supported // Acquire storage for the columns set ImGuiID id = GetColumnsID(str_id, columns_count); ImGuiOldColumns* columns = FindOrCreateColumns(window, id); IM_ASSERT(columns->ID == id); columns->Current = 0; columns->Count = columns_count; columns->Flags = flags; window->DC.CurrentColumns = columns; window->DC.NavIsScrollPushableX = false; // Shortcut for NavUpdateCurrentWindowIsScrollPushableX(); columns->HostCursorPosY = window->DC.CursorPos.y; columns->HostCursorMaxPosX = window->DC.CursorMaxPos.x; columns->HostInitialClipRect = window->ClipRect; columns->HostBackupParentWorkRect = window->ParentWorkRect; window->ParentWorkRect = window->WorkRect; // Set state for first column // We aim so that the right-most column will have the same clipping width as other after being clipped by parent ClipRect const float column_padding = g.Style.ItemSpacing.x; const float half_clip_extend_x = ImTrunc(ImMax(window->WindowPadding.x * 0.5f, window->WindowBorderSize)); const float max_1 = window->WorkRect.Max.x + column_padding - ImMax(column_padding - window->WindowPadding.x, 0.0f); const float max_2 = window->WorkRect.Max.x + half_clip_extend_x; columns->OffMinX = window->DC.Indent.x - column_padding + ImMax(column_padding - window->WindowPadding.x, 0.0f); columns->OffMaxX = ImMax(ImMin(max_1, max_2) - window->Pos.x, columns->OffMinX + 1.0f); columns->LineMinY = columns->LineMaxY = window->DC.CursorPos.y; // Clear data if columns count changed if (columns->Columns.Size != 0 && columns->Columns.Size != columns_count + 1) columns->Columns.resize(0); // Initialize default widths columns->IsFirstFrame = (columns->Columns.Size == 0); if (columns->Columns.Size == 0) { columns->Columns.reserve(columns_count + 1); for (int n = 0; n < columns_count + 1; n++) { ImGuiOldColumnData column; column.OffsetNorm = n / (float)columns_count; columns->Columns.push_back(column); } } for (int n = 0; n < columns_count; n++) { // Compute clipping rectangle ImGuiOldColumnData* column = &columns->Columns[n]; float clip_x1 = IM_ROUND(window->Pos.x + GetColumnOffset(n)); float clip_x2 = IM_ROUND(window->Pos.x + GetColumnOffset(n + 1) - 1.0f); column->ClipRect = ImRect(clip_x1, -FLT_MAX, clip_x2, +FLT_MAX); column->ClipRect.ClipWithFull(window->ClipRect); } if (columns->Count > 1) { columns->Splitter.Split(window->DrawList, 1 + columns->Count); columns->Splitter.SetCurrentChannel(window->DrawList, 1); PushColumnClipRect(0); } // We don't generally store Indent.x inside ColumnsOffset because it may be manipulated by the user. float offset_0 = GetColumnOffset(columns->Current); float offset_1 = GetColumnOffset(columns->Current + 1); float width = offset_1 - offset_0; PushItemWidth(width * 0.65f); window->DC.ColumnsOffset.x = ImMax(column_padding - window->WindowPadding.x, 0.0f); window->DC.CursorPos.x = IM_TRUNC(window->Pos.x + window->DC.Indent.x + window->DC.ColumnsOffset.x); window->WorkRect.Max.x = window->Pos.x + offset_1 - column_padding; window->WorkRect.Max.y = window->ContentRegionRect.Max.y; } void ImGui::NextColumn() { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems || window->DC.CurrentColumns == NULL) return; ImGuiContext& g = *GImGui; ImGuiOldColumns* columns = window->DC.CurrentColumns; if (columns->Count == 1) { window->DC.CursorPos.x = IM_TRUNC(window->Pos.x + window->DC.Indent.x + window->DC.ColumnsOffset.x); IM_ASSERT(columns->Current == 0); return; } // Next column if (++columns->Current == columns->Count) columns->Current = 0; PopItemWidth(); // Optimization: avoid PopClipRect() + SetCurrentChannel() + PushClipRect() // (which would needlessly attempt to update commands in the wrong channel, then pop or overwrite them), ImGuiOldColumnData* column = &columns->Columns[columns->Current]; SetWindowClipRectBeforeSetChannel(window, column->ClipRect); columns->Splitter.SetCurrentChannel(window->DrawList, columns->Current + 1); const float column_padding = g.Style.ItemSpacing.x; columns->LineMaxY = ImMax(columns->LineMaxY, window->DC.CursorPos.y); if (columns->Current > 0) { // Columns 1+ ignore IndentX (by canceling it out) // FIXME-COLUMNS: Unnecessary, could be locked? window->DC.ColumnsOffset.x = GetColumnOffset(columns->Current) - window->DC.Indent.x + column_padding; } else { // New row/line: column 0 honor IndentX. window->DC.ColumnsOffset.x = ImMax(column_padding - window->WindowPadding.x, 0.0f); window->DC.IsSameLine = false; columns->LineMinY = columns->LineMaxY; } window->DC.CursorPos.x = IM_TRUNC(window->Pos.x + window->DC.Indent.x + window->DC.ColumnsOffset.x); window->DC.CursorPos.y = columns->LineMinY; window->DC.CurrLineSize = ImVec2(0.0f, 0.0f); window->DC.CurrLineTextBaseOffset = 0.0f; // FIXME-COLUMNS: Share code with BeginColumns() - move code on columns setup. float offset_0 = GetColumnOffset(columns->Current); float offset_1 = GetColumnOffset(columns->Current + 1); float width = offset_1 - offset_0; PushItemWidth(width * 0.65f); window->WorkRect.Max.x = window->Pos.x + offset_1 - column_padding; } void ImGui::EndColumns() { ImGuiContext& g = *GImGui; ImGuiWindow* window = GetCurrentWindow(); ImGuiOldColumns* columns = window->DC.CurrentColumns; IM_ASSERT(columns != NULL); PopItemWidth(); if (columns->Count > 1) { PopClipRect(); columns->Splitter.Merge(window->DrawList); } const ImGuiOldColumnFlags flags = columns->Flags; columns->LineMaxY = ImMax(columns->LineMaxY, window->DC.CursorPos.y); window->DC.CursorPos.y = columns->LineMaxY; if (!(flags & ImGuiOldColumnFlags_GrowParentContentsSize)) window->DC.CursorMaxPos.x = columns->HostCursorMaxPosX; // Restore cursor max pos, as columns don't grow parent // Draw columns borders and handle resize // The IsBeingResized flag ensure we preserve pre-resize columns width so back-and-forth are not lossy bool is_being_resized = false; if (!(flags & ImGuiOldColumnFlags_NoBorder) && !window->SkipItems) { // We clip Y boundaries CPU side because very long triangles are mishandled by some GPU drivers. const float y1 = ImMax(columns->HostCursorPosY, window->ClipRect.Min.y); const float y2 = ImMin(window->DC.CursorPos.y, window->ClipRect.Max.y); int dragging_column = -1; for (int n = 1; n < columns->Count; n++) { ImGuiOldColumnData* column = &columns->Columns[n]; float x = window->Pos.x + GetColumnOffset(n); const ImGuiID column_id = columns->ID + ImGuiID(n); const float column_hit_hw = ImTrunc(COLUMNS_HIT_RECT_HALF_THICKNESS * g.CurrentDpiScale); const ImRect column_hit_rect(ImVec2(x - column_hit_hw, y1), ImVec2(x + column_hit_hw, y2)); if (!ItemAdd(column_hit_rect, column_id, NULL, ImGuiItemFlags_NoNav)) continue; bool hovered = false, held = false; if (!(flags & ImGuiOldColumnFlags_NoResize)) { ButtonBehavior(column_hit_rect, column_id, &hovered, &held); if (hovered || held) SetMouseCursor(ImGuiMouseCursor_ResizeEW); if (held && !(column->Flags & ImGuiOldColumnFlags_NoResize)) dragging_column = n; } // Draw column const ImU32 col = GetColorU32(held ? ImGuiCol_SeparatorActive : hovered ? ImGuiCol_SeparatorHovered : ImGuiCol_Separator); const float xi = IM_TRUNC(x); window->DrawList->AddLine(ImVec2(xi, y1 + 1.0f), ImVec2(xi, y2), col); } // Apply dragging after drawing the column lines, so our rendered lines are in sync with how items were displayed during the frame. if (dragging_column != -1) { if (!columns->IsBeingResized) for (int n = 0; n < columns->Count + 1; n++) columns->Columns[n].OffsetNormBeforeResize = columns->Columns[n].OffsetNorm; columns->IsBeingResized = is_being_resized = true; float x = GetDraggedColumnOffset(columns, dragging_column); SetColumnOffset(dragging_column, x); } } columns->IsBeingResized = is_being_resized; window->WorkRect = window->ParentWorkRect; window->ParentWorkRect = columns->HostBackupParentWorkRect; window->DC.CurrentColumns = NULL; window->DC.ColumnsOffset.x = 0.0f; window->DC.CursorPos.x = IM_TRUNC(window->Pos.x + window->DC.Indent.x + window->DC.ColumnsOffset.x); NavUpdateCurrentWindowIsScrollPushableX(); } void ImGui::Columns(int columns_count, const char* id, bool borders) { ImGuiWindow* window = GetCurrentWindow(); IM_ASSERT(columns_count >= 1); ImGuiOldColumnFlags flags = (borders ? 0 : ImGuiOldColumnFlags_NoBorder); //flags |= ImGuiOldColumnFlags_NoPreserveWidths; // NB: Legacy behavior ImGuiOldColumns* columns = window->DC.CurrentColumns; if (columns != NULL && columns->Count == columns_count && columns->Flags == flags) return; if (columns != NULL) EndColumns(); if (columns_count != 1) BeginColumns(id, columns_count, flags); } //------------------------------------------------------------------------- #endif // #ifndef IMGUI_DISABLE ================================================ FILE: src/DesktopPlusUI/imgui/imgui_widgets.cpp ================================================ // dear imgui, v1.91b // (widgets code) /* Index of this file: // [SECTION] Forward Declarations // [SECTION] Widgets: Text, etc. // [SECTION] Widgets: Main (Button, Image, Checkbox, RadioButton, ProgressBar, Bullet, etc.) // [SECTION] Widgets: Low-level Layout helpers (Spacing, Dummy, NewLine, Separator, etc.) // [SECTION] Widgets: ComboBox // [SECTION] Data Type and Data Formatting Helpers // [SECTION] Widgets: DragScalar, DragFloat, DragInt, etc. // [SECTION] Widgets: SliderScalar, SliderFloat, SliderInt, etc. // [SECTION] Widgets: InputScalar, InputFloat, InputInt, etc. // [SECTION] Widgets: InputText, InputTextMultiline // [SECTION] Widgets: ColorEdit, ColorPicker, ColorButton, etc. // [SECTION] Widgets: TreeNode, CollapsingHeader, etc. // [SECTION] Widgets: Selectable // [SECTION] Widgets: Typing-Select support // [SECTION] Widgets: Box-Select support // [SECTION] Widgets: Multi-Select support // [SECTION] Widgets: Multi-Select helpers // [SECTION] Widgets: ListBox // [SECTION] Widgets: PlotLines, PlotHistogram // [SECTION] Widgets: Value helpers // [SECTION] Widgets: MenuItem, BeginMenu, EndMenu, etc. // [SECTION] Widgets: BeginTabBar, EndTabBar, etc. // [SECTION] Widgets: BeginTabItem, EndTabItem, etc. // [SECTION] Widgets: Columns, BeginColumns, EndColumns, etc. */ #if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_WARNINGS) #define _CRT_SECURE_NO_WARNINGS #endif #ifndef IMGUI_DEFINE_MATH_OPERATORS #define IMGUI_DEFINE_MATH_OPERATORS #endif #include "imgui.h" #ifndef IMGUI_DISABLE #include "imgui_internal.h" // System includes #include // intptr_t //------------------------------------------------------------------------- // Warnings //------------------------------------------------------------------------- // Visual Studio warnings #ifdef _MSC_VER #pragma warning (disable: 4127) // condition expression is constant #pragma warning (disable: 4996) // 'This function or variable may be unsafe': strcpy, strdup, sprintf, vsnprintf, sscanf, fopen #if defined(_MSC_VER) && _MSC_VER >= 1922 // MSVC 2019 16.2 or later #pragma warning (disable: 5054) // operator '|': deprecated between enumerations of different types #endif #pragma warning (disable: 26451) // [Static Analyzer] Arithmetic overflow : Using operator 'xxx' on a 4 byte value and then casting the result to a 8 byte value. Cast the value to the wider type before calling operator 'xxx' to avoid overflow(io.2). #pragma warning (disable: 26812) // [Static Analyzer] The enum type 'xxx' is unscoped. Prefer 'enum class' over 'enum' (Enum.3). #endif // Clang/GCC warnings with -Weverything #if defined(__clang__) #if __has_warning("-Wunknown-warning-option") #pragma clang diagnostic ignored "-Wunknown-warning-option" // warning: unknown warning group 'xxx' // not all warnings are known by all Clang versions and they tend to be rename-happy.. so ignoring warnings triggers new warnings on some configuration. Great! #endif #pragma clang diagnostic ignored "-Wunknown-pragmas" // warning: unknown warning group 'xxx' #pragma clang diagnostic ignored "-Wold-style-cast" // warning: use of old-style cast // yes, they are more terse. #pragma clang diagnostic ignored "-Wfloat-equal" // warning: comparing floating point with == or != is unsafe // storing and comparing against same constants (typically 0.0f) is ok. #pragma clang diagnostic ignored "-Wformat" // warning: format specifies type 'int' but the argument has type 'unsigned int' #pragma clang diagnostic ignored "-Wformat-nonliteral" // warning: format string is not a string literal // passing non-literal to vsnformat(). yes, user passing incorrect format strings can crash the code. #pragma clang diagnostic ignored "-Wsign-conversion" // warning: implicit conversion changes signedness #pragma clang diagnostic ignored "-Wunused-macros" // warning: macro is not used // we define snprintf/vsnprintf on Windows so they are available, but not always used. #pragma clang diagnostic ignored "-Wzero-as-null-pointer-constant" // warning: zero as null pointer constant // some standard header variations use #define NULL 0 #pragma clang diagnostic ignored "-Wdouble-promotion" // warning: implicit conversion from 'float' to 'double' when passing argument to function // using printf() is a misery with this as C++ va_arg ellipsis changes float to double. #pragma clang diagnostic ignored "-Wenum-enum-conversion" // warning: bitwise operation between different enumeration types ('XXXFlags_' and 'XXXFlagsPrivate_') #pragma clang diagnostic ignored "-Wdeprecated-enum-enum-conversion"// warning: bitwise operation between different enumeration types ('XXXFlags_' and 'XXXFlagsPrivate_') is deprecated #pragma clang diagnostic ignored "-Wimplicit-int-float-conversion" // warning: implicit conversion from 'xxx' to 'float' may lose precision #pragma clang diagnostic ignored "-Wunsafe-buffer-usage" // warning: 'xxx' is an unsafe pointer used for buffer access #pragma clang diagnostic ignored "-Wnontrivial-memaccess" // warning: first argument in call to 'memset' is a pointer to non-trivially copyable type #pragma clang diagnostic ignored "-Wswitch-default" // warning: 'switch' missing 'default' label #elif defined(__GNUC__) #pragma GCC diagnostic ignored "-Wpragmas" // warning: unknown option after '#pragma GCC diagnostic' kind #pragma GCC diagnostic ignored "-Wfloat-equal" // warning: comparing floating-point with '==' or '!=' is unsafe #pragma GCC diagnostic ignored "-Wformat" // warning: format '%p' expects argument of type 'int'/'void*', but argument X has type 'unsigned int'/'ImGuiWindow*' #pragma GCC diagnostic ignored "-Wformat-nonliteral" // warning: format not a string literal, format string not checked #pragma GCC diagnostic ignored "-Wdeprecated-enum-enum-conversion" // warning: bitwise operation between different enumeration types ('XXXFlags_' and 'XXXFlagsPrivate_') is deprecated #pragma GCC diagnostic ignored "-Wdouble-promotion" // warning: implicit conversion from 'float' to 'double' when passing argument to function #pragma GCC diagnostic ignored "-Wstrict-overflow" // warning: assuming signed overflow does not occur when simplifying division / ..when changing X +- C1 cmp C2 to X cmp C2 -+ C1 #pragma GCC diagnostic ignored "-Wclass-memaccess" // [__GNUC__ >= 8] warning: 'memset/memcpy' clearing/writing an object of type 'xxxx' with no trivial copy-assignment; use assignment or value-initialization instead #pragma GCC diagnostic ignored "-Wcast-qual" // warning: cast from type 'const xxxx *' to type 'xxxx *' casts away qualifiers #endif //------------------------------------------------------------------------- // Data //------------------------------------------------------------------------- // Widgets static const float DRAGDROP_HOLD_TO_OPEN_TIMER = 0.70f; // Time for drag-hold to activate items accepting the ImGuiButtonFlags_PressedOnDragDropHold button behavior. static const float DRAG_MOUSE_THRESHOLD_FACTOR = 0.50f; // Multiplier for the default value of io.MouseDragThreshold to make DragFloat/DragInt react faster to mouse drags. // Those MIN/MAX values are not define because we need to point to them static const signed char IM_S8_MIN = -128; static const signed char IM_S8_MAX = 127; static const unsigned char IM_U8_MIN = 0; static const unsigned char IM_U8_MAX = 0xFF; static const signed short IM_S16_MIN = -32768; static const signed short IM_S16_MAX = 32767; static const unsigned short IM_U16_MIN = 0; static const unsigned short IM_U16_MAX = 0xFFFF; static const ImS32 IM_S32_MIN = INT_MIN; // (-2147483647 - 1), (0x80000000); static const ImS32 IM_S32_MAX = INT_MAX; // (2147483647), (0x7FFFFFFF) static const ImU32 IM_U32_MIN = 0; static const ImU32 IM_U32_MAX = UINT_MAX; // (0xFFFFFFFF) #ifdef LLONG_MIN static const ImS64 IM_S64_MIN = LLONG_MIN; // (-9223372036854775807ll - 1ll); static const ImS64 IM_S64_MAX = LLONG_MAX; // (9223372036854775807ll); #else static const ImS64 IM_S64_MIN = -9223372036854775807LL - 1; static const ImS64 IM_S64_MAX = 9223372036854775807LL; #endif static const ImU64 IM_U64_MIN = 0; #ifdef ULLONG_MAX static const ImU64 IM_U64_MAX = ULLONG_MAX; // (0xFFFFFFFFFFFFFFFFull); #else static const ImU64 IM_U64_MAX = (2ULL * 9223372036854775807LL + 1); #endif //------------------------------------------------------------------------- // [SECTION] Forward Declarations //------------------------------------------------------------------------- // For InputTextEx() static bool InputTextFilterCharacter(ImGuiContext* ctx, unsigned int* p_char, ImGuiInputTextFlags flags, ImGuiInputTextCallback callback, void* user_data, bool input_source_is_clipboard = false); static int InputTextCalcTextLenAndLineCount(const char* text_begin, const char** out_text_end); static ImVec2 InputTextCalcTextSize(ImGuiContext* ctx, const char* text_begin, const char* text_end, const char** remaining = NULL, ImVec2* out_offset = NULL, bool stop_on_new_line = false); //------------------------------------------------------------------------- // [SECTION] Widgets: Text, etc. //------------------------------------------------------------------------- // - TextEx() [Internal] // - TextUnformatted() // - Text() // - TextV() // - TextColored() // - TextColoredV() // - TextDisabled() // - TextDisabledV() // - TextWrapped() // - TextWrappedV() // - LabelText() // - LabelTextV() // - BulletText() // - BulletTextV() //------------------------------------------------------------------------- void ImGui::TextEx(const char* text, const char* text_end, ImGuiTextFlags flags) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return; ImGuiContext& g = *GImGui; // Accept null ranges if (text == text_end) text = text_end = ""; // Calculate length const char* text_begin = text; if (text_end == NULL) text_end = text + ImStrlen(text); // FIXME-OPT const ImVec2 text_pos(window->DC.CursorPos.x, window->DC.CursorPos.y + window->DC.CurrLineTextBaseOffset); const float wrap_pos_x = window->DC.TextWrapPos; const bool wrap_enabled = (wrap_pos_x >= 0.0f); if (text_end - text <= 2000 || wrap_enabled) { // Common case const float wrap_width = wrap_enabled ? CalcWrapWidthForPos(window->DC.CursorPos, wrap_pos_x) : 0.0f; const ImVec2 text_size = CalcTextSize(text_begin, text_end, false, wrap_width); ImRect bb(text_pos, text_pos + text_size); ItemSize(text_size, 0.0f); if (!ItemAdd(bb, 0)) return; // Render (we don't hide text after ## in this end-user function) RenderTextWrapped(bb.Min, text_begin, text_end, wrap_width); } else { // Long text! // Perform manual coarse clipping to optimize for long multi-line text // - From this point we will only compute the width of lines that are visible. Optimization only available when word-wrapping is disabled. // - We also don't vertically center the text within the line full height, which is unlikely to matter because we are likely the biggest and only item on the line. // - We use memchr(), pay attention that well optimized versions of those str/mem functions are much faster than a casually written loop. const char* line = text; const float line_height = GetTextLineHeight(); ImVec2 text_size(0, 0); // Lines to skip (can't skip when logging text) ImVec2 pos = text_pos; if (!g.LogEnabled) { int lines_skippable = (int)((window->ClipRect.Min.y - text_pos.y) / line_height); if (lines_skippable > 0) { int lines_skipped = 0; while (line < text_end && lines_skipped < lines_skippable) { const char* line_end = (const char*)ImMemchr(line, '\n', text_end - line); if (!line_end) line_end = text_end; if ((flags & ImGuiTextFlags_NoWidthForLargeClippedText) == 0) text_size.x = ImMax(text_size.x, CalcTextSize(line, line_end).x); line = line_end + 1; lines_skipped++; } pos.y += lines_skipped * line_height; } } // Lines to render if (line < text_end) { ImRect line_rect(pos, pos + ImVec2(FLT_MAX, line_height)); while (line < text_end) { if (IsClippedEx(line_rect, 0)) break; const char* line_end = (const char*)ImMemchr(line, '\n', text_end - line); if (!line_end) line_end = text_end; text_size.x = ImMax(text_size.x, CalcTextSize(line, line_end).x); RenderText(pos, line, line_end, false); line = line_end + 1; line_rect.Min.y += line_height; line_rect.Max.y += line_height; pos.y += line_height; } // Count remaining lines int lines_skipped = 0; while (line < text_end) { const char* line_end = (const char*)ImMemchr(line, '\n', text_end - line); if (!line_end) line_end = text_end; if ((flags & ImGuiTextFlags_NoWidthForLargeClippedText) == 0) text_size.x = ImMax(text_size.x, CalcTextSize(line, line_end).x); line = line_end + 1; lines_skipped++; } pos.y += lines_skipped * line_height; } text_size.y = (pos - text_pos).y; ImRect bb(text_pos, text_pos + text_size); ItemSize(text_size, 0.0f); ItemAdd(bb, 0); } } void ImGui::TextUnformatted(const char* text, const char* text_end) { TextEx(text, text_end, ImGuiTextFlags_NoWidthForLargeClippedText); } void ImGui::Text(const char* fmt, ...) { va_list args; va_start(args, fmt); TextV(fmt, args); va_end(args); } void ImGui::TextV(const char* fmt, va_list args) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return; const char* text, *text_end; ImFormatStringToTempBufferV(&text, &text_end, fmt, args); TextEx(text, text_end, ImGuiTextFlags_NoWidthForLargeClippedText); } void ImGui::TextColored(const ImVec4& col, const char* fmt, ...) { va_list args; va_start(args, fmt); TextColoredV(col, fmt, args); va_end(args); } void ImGui::TextColoredV(const ImVec4& col, const char* fmt, va_list args) { PushStyleColor(ImGuiCol_Text, col); TextV(fmt, args); PopStyleColor(); } void ImGui::TextDisabled(const char* fmt, ...) { va_list args; va_start(args, fmt); TextDisabledV(fmt, args); va_end(args); } void ImGui::TextDisabledV(const char* fmt, va_list args) { ImGuiContext& g = *GImGui; PushStyleColor(ImGuiCol_Text, g.Style.Colors[ImGuiCol_TextDisabled]); TextV(fmt, args); PopStyleColor(); } void ImGui::TextWrapped(const char* fmt, ...) { va_list args; va_start(args, fmt); TextWrappedV(fmt, args); va_end(args); } void ImGui::TextWrappedV(const char* fmt, va_list args) { ImGuiContext& g = *GImGui; const bool need_backup = (g.CurrentWindow->DC.TextWrapPos < 0.0f); // Keep existing wrap position if one is already set if (need_backup) PushTextWrapPos(0.0f); TextV(fmt, args); if (need_backup) PopTextWrapPos(); } void ImGui::LabelText(const char* label, const char* fmt, ...) { va_list args; va_start(args, fmt); LabelTextV(label, fmt, args); va_end(args); } // Add a label+text combo aligned to other label+value widgets void ImGui::LabelTextV(const char* label, const char* fmt, va_list args) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return; ImGuiContext& g = *GImGui; const ImGuiStyle& style = g.Style; const float w = CalcItemWidth(); const char* value_text_begin, *value_text_end; ImFormatStringToTempBufferV(&value_text_begin, &value_text_end, fmt, args); const ImVec2 value_size = CalcTextSize(value_text_begin, value_text_end, false); const ImVec2 label_size = CalcTextSize(label, NULL, true); const ImVec2 pos = window->DC.CursorPos; const ImRect value_bb(pos, pos + ImVec2(w, value_size.y + style.FramePadding.y * 2)); const ImRect total_bb(pos, pos + ImVec2(w + (label_size.x > 0.0f ? style.ItemInnerSpacing.x + label_size.x : 0.0f), ImMax(value_size.y, label_size.y) + style.FramePadding.y * 2)); ItemSize(total_bb, style.FramePadding.y); if (!ItemAdd(total_bb, 0)) return; // Render RenderTextClipped(value_bb.Min + style.FramePadding, value_bb.Max, value_text_begin, value_text_end, &value_size, ImVec2(0.0f, 0.0f)); if (label_size.x > 0.0f) RenderText(ImVec2(value_bb.Max.x + style.ItemInnerSpacing.x, value_bb.Min.y + style.FramePadding.y), label); } void ImGui::BulletText(const char* fmt, ...) { va_list args; va_start(args, fmt); BulletTextV(fmt, args); va_end(args); } // Text with a little bullet aligned to the typical tree node. void ImGui::BulletTextV(const char* fmt, va_list args) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return; ImGuiContext& g = *GImGui; const ImGuiStyle& style = g.Style; const char* text_begin, *text_end; ImFormatStringToTempBufferV(&text_begin, &text_end, fmt, args); const ImVec2 label_size = CalcTextSize(text_begin, text_end, false); const ImVec2 total_size = ImVec2(g.FontSize + (label_size.x > 0.0f ? (label_size.x + style.FramePadding.x * 2) : 0.0f), label_size.y); // Empty text doesn't add padding ImVec2 pos = window->DC.CursorPos; pos.y += window->DC.CurrLineTextBaseOffset; ItemSize(total_size, 0.0f); const ImRect bb(pos, pos + total_size); if (!ItemAdd(bb, 0)) return; // Render ImU32 text_col = GetColorU32(ImGuiCol_Text); RenderBullet(window->DrawList, bb.Min + ImVec2(style.FramePadding.x + g.FontSize * 0.5f, g.FontSize * 0.5f), text_col); RenderText(bb.Min + ImVec2(g.FontSize + style.FramePadding.x * 2, 0.0f), text_begin, text_end, false); } //------------------------------------------------------------------------- // [SECTION] Widgets: Main //------------------------------------------------------------------------- // - ButtonBehavior() [Internal] // - Button() // - SmallButton() // - InvisibleButton() // - ArrowButton() // - CloseButton() [Internal] // - CollapseButton() [Internal] // - GetWindowScrollbarID() [Internal] // - GetWindowScrollbarRect() [Internal] // - Scrollbar() [Internal] // - ScrollbarEx() [Internal] // - Image() // - ImageButton() // - Checkbox() // - CheckboxFlagsT() [Internal] // - CheckboxFlags() // - RadioButton() // - ProgressBar() // - Bullet() // - Hyperlink() //------------------------------------------------------------------------- // The ButtonBehavior() function is key to many interactions and used by many/most widgets. // Because we handle so many cases (keyboard/gamepad navigation, drag and drop) and many specific behavior (via ImGuiButtonFlags_), // this code is a little complex. // By far the most common path is interacting with the Mouse using the default ImGuiButtonFlags_PressedOnClickRelease button behavior. // See the series of events below and the corresponding state reported by dear imgui: //------------------------------------------------------------------------------------------------------------------------------------------------ // with PressedOnClickRelease: return-value IsItemHovered() IsItemActive() IsItemActivated() IsItemDeactivated() IsItemClicked() // Frame N+0 (mouse is outside bb) - - - - - - // Frame N+1 (mouse moves inside bb) - true - - - - // Frame N+2 (mouse button is down) - true true true - true // Frame N+3 (mouse button is down) - true true - - - // Frame N+4 (mouse moves outside bb) - - true - - - // Frame N+5 (mouse moves inside bb) - true true - - - // Frame N+6 (mouse button is released) true true - - true - // Frame N+7 (mouse button is released) - true - - - - // Frame N+8 (mouse moves outside bb) - - - - - - //------------------------------------------------------------------------------------------------------------------------------------------------ // with PressedOnClick: return-value IsItemHovered() IsItemActive() IsItemActivated() IsItemDeactivated() IsItemClicked() // Frame N+2 (mouse button is down) true true true true - true // Frame N+3 (mouse button is down) - true true - - - // Frame N+6 (mouse button is released) - true - - true - // Frame N+7 (mouse button is released) - true - - - - //------------------------------------------------------------------------------------------------------------------------------------------------ // with PressedOnRelease: return-value IsItemHovered() IsItemActive() IsItemActivated() IsItemDeactivated() IsItemClicked() // Frame N+2 (mouse button is down) - true - - - true // Frame N+3 (mouse button is down) - true - - - - // Frame N+6 (mouse button is released) true true - - - - // Frame N+7 (mouse button is released) - true - - - - //------------------------------------------------------------------------------------------------------------------------------------------------ // with PressedOnDoubleClick: return-value IsItemHovered() IsItemActive() IsItemActivated() IsItemDeactivated() IsItemClicked() // Frame N+0 (mouse button is down) - true - - - true // Frame N+1 (mouse button is down) - true - - - - // Frame N+2 (mouse button is released) - true - - - - // Frame N+3 (mouse button is released) - true - - - - // Frame N+4 (mouse button is down) true true true true - true // Frame N+5 (mouse button is down) - true true - - - // Frame N+6 (mouse button is released) - true - - true - // Frame N+7 (mouse button is released) - true - - - - //------------------------------------------------------------------------------------------------------------------------------------------------ // Note that some combinations are supported, // - PressedOnDragDropHold can generally be associated with any flag. // - PressedOnDoubleClick can be associated by PressedOnClickRelease/PressedOnRelease, in which case the second release event won't be reported. //------------------------------------------------------------------------------------------------------------------------------------------------ // The behavior of the return-value changes when ImGuiItemFlags_ButtonRepeat is set: // Repeat+ Repeat+ Repeat+ Repeat+ // PressedOnClickRelease PressedOnClick PressedOnRelease PressedOnDoubleClick //------------------------------------------------------------------------------------------------------------------------------------------------- // Frame N+0 (mouse button is down) - true - true // ... - - - - // Frame N + RepeatDelay true true - true // ... - - - - // Frame N + RepeatDelay + RepeatRate*N true true - true //------------------------------------------------------------------------------------------------------------------------------------------------- // - FIXME: For refactor we could output flags, incl mouse hovered vs nav keyboard vs nav triggered etc. // And better standardize how widgets use 'GetColor32((held && hovered) ? ... : hovered ? ...)' vs 'GetColor32(held ? ... : hovered ? ...);' // For mouse feedback we typically prefer the 'held && hovered' test, but for nav feedback not always. Outputting hovered=true on Activation may be misleading. // - Since v1.91.2 (Sept 2024) we included io.ConfigDebugHighlightIdConflicts feature. // One idiom which was previously valid which will now emit a warning is when using multiple overlayed ButtonBehavior() // with same ID and different MouseButton (see #8030). You can fix it by: // (1) switching to use a single ButtonBehavior() with multiple _MouseButton flags. // or (2) surrounding those calls with PushItemFlag(ImGuiItemFlags_AllowDuplicateId, true); ... PopItemFlag() bool ImGui::ButtonBehavior(const ImRect& bb, ImGuiID id, bool* out_hovered, bool* out_held, ImGuiButtonFlags flags) { ImGuiContext& g = *GImGui; ImGuiWindow* window = GetCurrentWindow(); // Default behavior inherited from item flags // Note that _both_ ButtonFlags and ItemFlags are valid sources, so copy one into the item_flags and only check that. ImGuiItemFlags item_flags = (g.LastItemData.ID == id ? g.LastItemData.ItemFlags : g.CurrentItemFlags); if (flags & ImGuiButtonFlags_AllowOverlap) item_flags |= ImGuiItemFlags_AllowOverlap; // Default only reacts to left mouse button if ((flags & ImGuiButtonFlags_MouseButtonMask_) == 0) flags |= ImGuiButtonFlags_MouseButtonLeft; // Default behavior requires click + release inside bounding box if ((flags & ImGuiButtonFlags_PressedOnMask_) == 0) flags |= (item_flags & ImGuiItemFlags_ButtonRepeat) ? ImGuiButtonFlags_PressedOnClick : ImGuiButtonFlags_PressedOnDefault_; ImGuiWindow* backup_hovered_window = g.HoveredWindow; const bool flatten_hovered_children = (flags & ImGuiButtonFlags_FlattenChildren) && g.HoveredWindow && g.HoveredWindow->RootWindow == window; if (flatten_hovered_children) g.HoveredWindow = window; #ifdef IMGUI_ENABLE_TEST_ENGINE // Alternate registration spot, for when caller didn't use ItemAdd() if (g.LastItemData.ID != id) IMGUI_TEST_ENGINE_ITEM_ADD(id, bb, NULL); #endif bool pressed = false; bool hovered = ItemHoverable(bb, id, item_flags); // Special mode for Drag and Drop where holding button pressed for a long time while dragging another item triggers the button if (g.DragDropActive && (flags & ImGuiButtonFlags_PressedOnDragDropHold) && !(g.DragDropSourceFlags & ImGuiDragDropFlags_SourceNoHoldToOpenOthers)) if (IsItemHovered(ImGuiHoveredFlags_AllowWhenBlockedByActiveItem)) { hovered = true; SetHoveredID(id); if (g.HoveredIdTimer - g.IO.DeltaTime <= DRAGDROP_HOLD_TO_OPEN_TIMER && g.HoveredIdTimer >= DRAGDROP_HOLD_TO_OPEN_TIMER) { pressed = true; g.DragDropHoldJustPressedId = id; FocusWindow(window); } } if (flatten_hovered_children) g.HoveredWindow = backup_hovered_window; // Mouse handling const ImGuiID test_owner_id = (flags & ImGuiButtonFlags_NoTestKeyOwner) ? ImGuiKeyOwner_Any : id; if (hovered) { IM_ASSERT(id != 0); // Lazily check inside rare path. // Poll mouse buttons // - 'mouse_button_clicked' is generally carried into ActiveIdMouseButton when setting ActiveId. // - Technically we only need some values in one code path, but since this is gated by hovered test this is fine. int mouse_button_clicked = -1; int mouse_button_released = -1; for (int button = 0; button < 3; button++) if (flags & (ImGuiButtonFlags_MouseButtonLeft << button)) // Handle ImGuiButtonFlags_MouseButtonRight and ImGuiButtonFlags_MouseButtonMiddle here. { if (IsMouseClicked(button, ImGuiInputFlags_None, test_owner_id) && mouse_button_clicked == -1) { mouse_button_clicked = button; } if (IsMouseReleased(button, test_owner_id) && mouse_button_released == -1) { mouse_button_released = button; } } // Process initial action const bool mods_ok = !(flags & ImGuiButtonFlags_NoKeyModsAllowed) || (!g.IO.KeyCtrl && !g.IO.KeyShift && !g.IO.KeyAlt); if (mods_ok) { if (mouse_button_clicked != -1 && g.ActiveId != id) { if (!(flags & ImGuiButtonFlags_NoSetKeyOwner)) SetKeyOwner(MouseButtonToKey(mouse_button_clicked), id); if (flags & (ImGuiButtonFlags_PressedOnClickRelease | ImGuiButtonFlags_PressedOnClickReleaseAnywhere)) { SetActiveID(id, window); g.ActiveIdMouseButton = mouse_button_clicked; if (!(flags & ImGuiButtonFlags_NoNavFocus)) { SetFocusID(id, window); FocusWindow(window); } else { FocusWindow(window, ImGuiFocusRequestFlags_RestoreFocusedChild); // Still need to focus and bring to front, but try to avoid losing NavId when navigating a child } } if ((flags & ImGuiButtonFlags_PressedOnClick) || ((flags & ImGuiButtonFlags_PressedOnDoubleClick) && g.IO.MouseClickedCount[mouse_button_clicked] == 2)) { pressed = true; if (flags & ImGuiButtonFlags_NoHoldingActiveId) ClearActiveID(); else SetActiveID(id, window); // Hold on ID g.ActiveIdMouseButton = mouse_button_clicked; if (!(flags & ImGuiButtonFlags_NoNavFocus)) { SetFocusID(id, window); FocusWindow(window); } else { FocusWindow(window, ImGuiFocusRequestFlags_RestoreFocusedChild); // Still need to focus and bring to front, but try to avoid losing NavId when navigating a child } } } if (flags & ImGuiButtonFlags_PressedOnRelease) { if (mouse_button_released != -1) { const bool has_repeated_at_least_once = (item_flags & ImGuiItemFlags_ButtonRepeat) && g.IO.MouseDownDurationPrev[mouse_button_released] >= g.IO.KeyRepeatDelay; // Repeat mode trumps on release behavior if (!has_repeated_at_least_once) pressed = true; if (!(flags & ImGuiButtonFlags_NoNavFocus)) SetFocusID(id, window); // FIXME: Lack of FocusWindow() call here is inconsistent with other paths. Research why. ClearActiveID(); } } // 'Repeat' mode acts when held regardless of _PressedOn flags (see table above). // Relies on repeat logic of IsMouseClicked() but we may as well do it ourselves if we end up exposing finer RepeatDelay/RepeatRate settings. if (g.ActiveId == id && (item_flags & ImGuiItemFlags_ButtonRepeat)) if (g.IO.MouseDownDuration[g.ActiveIdMouseButton] > 0.0f && IsMouseClicked(g.ActiveIdMouseButton, ImGuiInputFlags_Repeat, test_owner_id)) pressed = true; } if (pressed && g.IO.ConfigNavCursorVisibleAuto) g.NavCursorVisible = false; } // Keyboard/Gamepad navigation handling // We report navigated and navigation-activated items as hovered but we don't set g.HoveredId to not interfere with mouse. if (g.NavId == id && g.NavCursorVisible && g.NavHighlightItemUnderNav) if (!(flags & ImGuiButtonFlags_NoHoveredOnFocus)) hovered = true; if (g.NavActivateDownId == id) { bool nav_activated_by_code = (g.NavActivateId == id); bool nav_activated_by_inputs = (g.NavActivatePressedId == id); if (!nav_activated_by_inputs && (item_flags & ImGuiItemFlags_ButtonRepeat)) { // Avoid pressing multiple keys from triggering excessive amount of repeat events const ImGuiKeyData* key1 = GetKeyData(ImGuiKey_Space); const ImGuiKeyData* key2 = GetKeyData(ImGuiKey_Enter); const ImGuiKeyData* key3 = GetKeyData(ImGuiKey_NavGamepadActivate); const float t1 = ImMax(ImMax(key1->DownDuration, key2->DownDuration), key3->DownDuration); nav_activated_by_inputs = CalcTypematicRepeatAmount(t1 - g.IO.DeltaTime, t1, g.IO.KeyRepeatDelay, g.IO.KeyRepeatRate) > 0; } if (nav_activated_by_code || nav_activated_by_inputs) { // Set active id so it can be queried by user via IsItemActive(), equivalent of holding the mouse button. pressed = true; SetActiveID(id, window); g.ActiveIdSource = g.NavInputSource; if (!(flags & ImGuiButtonFlags_NoNavFocus) && !(g.NavActivateFlags & ImGuiActivateFlags_FromShortcut)) SetFocusID(id, window); if (g.NavActivateFlags & ImGuiActivateFlags_FromShortcut) g.ActiveIdFromShortcut = true; } } // Process while held bool held = false; if (g.ActiveId == id) { if (g.ActiveIdSource == ImGuiInputSource_Mouse) { if (g.ActiveIdIsJustActivated) g.ActiveIdClickOffset = g.IO.MousePos - bb.Min; const int mouse_button = g.ActiveIdMouseButton; if (mouse_button == -1) { // Fallback for the rare situation were g.ActiveId was set programmatically or from another widget (e.g. #6304). ClearActiveID(); } else if (IsMouseDown(mouse_button, test_owner_id)) { held = true; } else { bool release_in = hovered && (flags & ImGuiButtonFlags_PressedOnClickRelease) != 0; bool release_anywhere = (flags & ImGuiButtonFlags_PressedOnClickReleaseAnywhere) != 0; if ((release_in || release_anywhere) && !g.DragDropActive) { // Report as pressed when releasing the mouse (this is the most common path) bool is_double_click_release = (flags & ImGuiButtonFlags_PressedOnDoubleClick) && g.IO.MouseReleased[mouse_button] && g.IO.MouseClickedLastCount[mouse_button] == 2; bool is_repeating_already = (item_flags & ImGuiItemFlags_ButtonRepeat) && g.IO.MouseDownDurationPrev[mouse_button] >= g.IO.KeyRepeatDelay; // Repeat mode trumps bool is_button_avail_or_owned = TestKeyOwner(MouseButtonToKey(mouse_button), test_owner_id); if (!is_double_click_release && !is_repeating_already && is_button_avail_or_owned) pressed = true; } ClearActiveID(); } if (!(flags & ImGuiButtonFlags_NoNavFocus) && g.IO.ConfigNavCursorVisibleAuto) g.NavCursorVisible = false; } else if (g.ActiveIdSource == ImGuiInputSource_Keyboard || g.ActiveIdSource == ImGuiInputSource_Gamepad) { // When activated using Nav, we hold on the ActiveID until activation button is released if (g.NavActivateDownId == id) held = true; // hovered == true not true as we are already likely hovered on direct activation. else ClearActiveID(); } if (pressed) g.ActiveIdHasBeenPressedBefore = true; } // Activation highlight (this may be a remote activation) if (g.NavHighlightActivatedId == id) hovered = true; if (out_hovered) *out_hovered = hovered; if (out_held) *out_held = held; return pressed; } bool ImGui::ButtonEx(const char* label, const ImVec2& size_arg, ImGuiButtonFlags flags) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; ImGuiContext& g = *GImGui; const ImGuiStyle& style = g.Style; const ImGuiID id = window->GetID(label); const ImVec2 label_size = CalcTextSize(label, NULL, true); ImVec2 pos = window->DC.CursorPos; if ((flags & ImGuiButtonFlags_AlignTextBaseLine) && style.FramePadding.y < window->DC.CurrLineTextBaseOffset) // Try to vertically align buttons that are smaller/have no padding so that text baseline matches (bit hacky, since it shouldn't be a flag) pos.y += window->DC.CurrLineTextBaseOffset - style.FramePadding.y; ImVec2 size = CalcItemSize(size_arg, label_size.x + style.FramePadding.x * 2.0f, label_size.y + style.FramePadding.y * 2.0f); const ImRect bb(pos, pos + size); ItemSize(size, style.FramePadding.y); if (!ItemAdd(bb, id)) return false; bool hovered, held; bool pressed = ButtonBehavior(bb, id, &hovered, &held, flags); // Render const ImU32 col = GetColorU32((held && hovered) ? ImGuiCol_ButtonActive : hovered ? ImGuiCol_ButtonHovered : ImGuiCol_Button); RenderNavCursor(bb, id); RenderFrame(bb.Min, bb.Max, col, true, style.FrameRounding); if (g.LogEnabled) LogSetNextTextDecoration("[", "]"); RenderTextClipped(bb.Min + style.FramePadding, bb.Max - style.FramePadding, label, NULL, &label_size, style.ButtonTextAlign, &bb); // Automatically close popups //if (pressed && !(flags & ImGuiButtonFlags_DontClosePopups) && (window->Flags & ImGuiWindowFlags_Popup)) // CloseCurrentPopup(); IMGUI_TEST_ENGINE_ITEM_INFO(id, label, g.LastItemData.StatusFlags); return pressed; } bool ImGui::Button(const char* label, const ImVec2& size_arg) { return ButtonEx(label, size_arg, ImGuiButtonFlags_None); } // Small buttons fits within text without additional vertical spacing. bool ImGui::SmallButton(const char* label) { ImGuiContext& g = *GImGui; float backup_padding_y = g.Style.FramePadding.y; g.Style.FramePadding.y = 0.0f; bool pressed = ButtonEx(label, ImVec2(0, 0), ImGuiButtonFlags_AlignTextBaseLine); g.Style.FramePadding.y = backup_padding_y; return pressed; } // Tip: use ImGui::PushID()/PopID() to push indices or pointers in the ID stack. // Then you can keep 'str_id' empty or the same for all your buttons (instead of creating a string based on a non-string id) bool ImGui::InvisibleButton(const char* str_id, const ImVec2& size_arg, ImGuiButtonFlags flags) { ImGuiContext& g = *GImGui; ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; // Cannot use zero-size for InvisibleButton(). Unlike Button() there is not way to fallback using the label size. IM_ASSERT(size_arg.x != 0.0f && size_arg.y != 0.0f); const ImGuiID id = window->GetID(str_id); ImVec2 size = CalcItemSize(size_arg, 0.0f, 0.0f); const ImRect bb(window->DC.CursorPos, window->DC.CursorPos + size); ItemSize(size); if (!ItemAdd(bb, id, NULL, (flags & ImGuiButtonFlags_EnableNav) ? ImGuiItemFlags_None : ImGuiItemFlags_NoNav)) return false; bool hovered, held; bool pressed = ButtonBehavior(bb, id, &hovered, &held, flags); RenderNavCursor(bb, id); IMGUI_TEST_ENGINE_ITEM_INFO(id, str_id, g.LastItemData.StatusFlags); return pressed; } bool ImGui::ArrowButtonEx(const char* str_id, ImGuiDir dir, ImVec2 size, ImGuiButtonFlags flags) { ImGuiContext& g = *GImGui; ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; const ImGuiID id = window->GetID(str_id); const ImRect bb(window->DC.CursorPos, window->DC.CursorPos + size); const float default_size = GetFrameHeight(); ItemSize(size, (size.y >= default_size) ? g.Style.FramePadding.y : -1.0f); if (!ItemAdd(bb, id)) return false; bool hovered, held; bool pressed = ButtonBehavior(bb, id, &hovered, &held, flags); // Render const ImU32 bg_col = GetColorU32((held && hovered) ? ImGuiCol_ButtonActive : hovered ? ImGuiCol_ButtonHovered : ImGuiCol_Button); const ImU32 text_col = GetColorU32(ImGuiCol_Text); RenderNavCursor(bb, id); RenderFrame(bb.Min, bb.Max, bg_col, true, g.Style.FrameRounding); RenderArrow(window->DrawList, bb.Min + ImVec2(ImMax(0.0f, (size.x - g.FontSize) * 0.5f), ImMax(0.0f, (size.y - g.FontSize) * 0.5f)), text_col, dir); IMGUI_TEST_ENGINE_ITEM_INFO(id, str_id, g.LastItemData.StatusFlags); return pressed; } bool ImGui::ArrowButton(const char* str_id, ImGuiDir dir) { float sz = GetFrameHeight(); return ArrowButtonEx(str_id, dir, ImVec2(sz, sz), ImGuiButtonFlags_None); } // Button to close a window bool ImGui::CloseButton(ImGuiID id, const ImVec2& pos) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; // Tweak 1: Shrink hit-testing area if button covers an abnormally large proportion of the visible region. That's in order to facilitate moving the window away. (#3825) // This may better be applied as a general hit-rect reduction mechanism for all widgets to ensure the area to move window is always accessible? const ImRect bb(pos, pos + ImVec2(g.FontSize, g.FontSize)); ImRect bb_interact = bb; const float area_to_visible_ratio = window->OuterRectClipped.GetArea() / bb.GetArea(); if (area_to_visible_ratio < 1.5f) bb_interact.Expand(ImTrunc(bb_interact.GetSize() * -0.25f)); // Tweak 2: We intentionally allow interaction when clipped so that a mechanical Alt,Right,Activate sequence can always close a window. // (this isn't the common behavior of buttons, but it doesn't affect the user because navigation tends to keep items visible in scrolling layer). bool is_clipped = !ItemAdd(bb_interact, id); bool hovered, held; bool pressed = ButtonBehavior(bb_interact, id, &hovered, &held); if (is_clipped) return pressed; // Render ImU32 bg_col = GetColorU32(held ? ImGuiCol_ButtonActive : ImGuiCol_ButtonHovered); if (hovered) window->DrawList->AddRectFilled(bb.Min, bb.Max, bg_col); RenderNavCursor(bb, id, ImGuiNavRenderCursorFlags_Compact); ImU32 cross_col = GetColorU32(ImGuiCol_Text); ImVec2 cross_center = bb.GetCenter() - ImVec2(0.5f, 0.5f); float cross_extent = g.FontSize * 0.5f * 0.7071f - 1.0f; window->DrawList->AddLine(cross_center + ImVec2(+cross_extent, +cross_extent), cross_center + ImVec2(-cross_extent, -cross_extent), cross_col, 1.0f); window->DrawList->AddLine(cross_center + ImVec2(+cross_extent, -cross_extent), cross_center + ImVec2(-cross_extent, +cross_extent), cross_col, 1.0f); return pressed; } bool ImGui::CollapseButton(ImGuiID id, const ImVec2& pos) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; ImRect bb(pos, pos + ImVec2(g.FontSize, g.FontSize)); bool is_clipped = !ItemAdd(bb, id); bool hovered, held; bool pressed = ButtonBehavior(bb, id, &hovered, &held, ImGuiButtonFlags_None); if (is_clipped) return pressed; // Render ImU32 bg_col = GetColorU32((held && hovered) ? ImGuiCol_ButtonActive : hovered ? ImGuiCol_ButtonHovered : ImGuiCol_Button); ImU32 text_col = GetColorU32(ImGuiCol_Text); if (hovered || held) window->DrawList->AddRectFilled(bb.Min, bb.Max, bg_col); RenderNavCursor(bb, id, ImGuiNavRenderCursorFlags_Compact); RenderArrow(window->DrawList, bb.Min, text_col, window->Collapsed ? ImGuiDir_Right : ImGuiDir_Down, 1.0f); // Switch to moving the window after mouse is moved beyond the initial drag threshold if (IsItemActive() && IsMouseDragging(0)) StartMouseMovingWindow(window); return pressed; } ImGuiID ImGui::GetWindowScrollbarID(ImGuiWindow* window, ImGuiAxis axis) { return window->GetID(axis == ImGuiAxis_X ? "#SCROLLX" : "#SCROLLY"); } // Return scrollbar rectangle, must only be called for corresponding axis if window->ScrollbarX/Y is set. ImRect ImGui::GetWindowScrollbarRect(ImGuiWindow* window, ImGuiAxis axis) { ImGuiContext& g = *GImGui; const ImRect outer_rect = window->Rect(); const ImRect inner_rect = window->InnerRect; const float scrollbar_size = window->ScrollbarSizes[axis ^ 1]; // (ScrollbarSizes.x = width of Y scrollbar; ScrollbarSizes.y = height of X scrollbar) IM_ASSERT(scrollbar_size >= 0.0f); const float border_size = IM_ROUND(window->WindowBorderSize * 0.5f); const float border_top = (window->Flags & ImGuiWindowFlags_MenuBar) ? IM_ROUND(g.Style.FrameBorderSize * 0.5f) : 0.0f; if (axis == ImGuiAxis_X) return ImRect(inner_rect.Min.x + border_size, ImMax(outer_rect.Min.y + border_size, outer_rect.Max.y - border_size - scrollbar_size), inner_rect.Max.x - border_size, outer_rect.Max.y - border_size); else return ImRect(ImMax(outer_rect.Min.x, outer_rect.Max.x - border_size - scrollbar_size), inner_rect.Min.y + border_top, outer_rect.Max.x - border_size, inner_rect.Max.y - border_size); } void ImGui::Scrollbar(ImGuiAxis axis) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; const ImGuiID id = GetWindowScrollbarID(window, axis); // Calculate scrollbar bounding box ImRect bb = GetWindowScrollbarRect(window, axis); ImDrawFlags rounding_corners = ImDrawFlags_RoundCornersNone; if (axis == ImGuiAxis_X) { rounding_corners |= ImDrawFlags_RoundCornersBottomLeft; if (!window->ScrollbarY) rounding_corners |= ImDrawFlags_RoundCornersBottomRight; } else { if ((window->Flags & ImGuiWindowFlags_NoTitleBar) && !(window->Flags & ImGuiWindowFlags_MenuBar)) rounding_corners |= ImDrawFlags_RoundCornersTopRight; if (!window->ScrollbarX) rounding_corners |= ImDrawFlags_RoundCornersBottomRight; } float size_visible = window->InnerRect.Max[axis] - window->InnerRect.Min[axis]; float size_contents = window->ContentSize[axis] + window->WindowPadding[axis] * 2.0f; ImS64 scroll = (ImS64)window->Scroll[axis]; ScrollbarEx(bb, id, axis, &scroll, (ImS64)size_visible, (ImS64)size_contents, rounding_corners); window->Scroll[axis] = (float)scroll; } // Vertical/Horizontal scrollbar // The entire piece of code below is rather confusing because: // - We handle absolute seeking (when first clicking outside the grab) and relative manipulation (afterward or when clicking inside the grab) // - We store values as normalized ratio and in a form that allows the window content to change while we are holding on a scrollbar // - We handle both horizontal and vertical scrollbars, which makes the terminology not ideal. // Still, the code should probably be made simpler.. bool ImGui::ScrollbarEx(const ImRect& bb_frame, ImGuiID id, ImGuiAxis axis, ImS64* p_scroll_v, ImS64 size_visible_v, ImS64 size_contents_v, ImDrawFlags draw_rounding_flags) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; if (window->SkipItems) return false; const float bb_frame_width = bb_frame.GetWidth(); const float bb_frame_height = bb_frame.GetHeight(); if (bb_frame_width <= 0.0f || bb_frame_height <= 0.0f) return false; // When we are too small, start hiding and disabling the grab (this reduce visual noise on very small window and facilitate using the window resize grab) float alpha = 1.0f; if ((axis == ImGuiAxis_Y) && bb_frame_height < bb_frame_width) alpha = ImSaturate(bb_frame_height / ImMax(bb_frame_width * 2.0f, 1.0f)); if (alpha <= 0.0f) return false; const ImGuiStyle& style = g.Style; const bool allow_interaction = (alpha >= 1.0f); ImRect bb = bb_frame; bb.Expand(ImVec2(-ImClamp(IM_TRUNC((bb_frame_width - 2.0f) * 0.5f), 0.0f, 3.0f), -ImClamp(IM_TRUNC((bb_frame_height - 2.0f) * 0.5f), 0.0f, 3.0f))); // V denote the main, longer axis of the scrollbar (= height for a vertical scrollbar) const float scrollbar_size_v = (axis == ImGuiAxis_X) ? bb.GetWidth() : bb.GetHeight(); // Calculate the height of our grabbable box. It generally represent the amount visible (vs the total scrollable amount) // But we maintain a minimum size in pixel to allow for the user to still aim inside. IM_ASSERT(ImMax(size_contents_v, size_visible_v) > 0.0f); // Adding this assert to check if the ImMax(XXX,1.0f) is still needed. PLEASE CONTACT ME if this triggers. const ImS64 win_size_v = ImMax(ImMax(size_contents_v, size_visible_v), (ImS64)1); const float grab_h_minsize = ImMin(bb.GetSize()[axis], style.GrabMinSize); const float grab_h_pixels = ImClamp(scrollbar_size_v * ((float)size_visible_v / (float)win_size_v), grab_h_minsize, scrollbar_size_v); const float grab_h_norm = grab_h_pixels / scrollbar_size_v; // Handle input right away. None of the code of Begin() is relying on scrolling position before calling Scrollbar(). bool held = false; bool hovered = false; ItemAdd(bb_frame, id, NULL, ImGuiItemFlags_NoNav); ButtonBehavior(bb, id, &hovered, &held, ImGuiButtonFlags_NoNavFocus); const ImS64 scroll_max = ImMax((ImS64)1, size_contents_v - size_visible_v); float scroll_ratio = ImSaturate((float)*p_scroll_v / (float)scroll_max); float grab_v_norm = scroll_ratio * (scrollbar_size_v - grab_h_pixels) / scrollbar_size_v; // Grab position in normalized space if (held && allow_interaction && grab_h_norm < 1.0f) { const float scrollbar_pos_v = bb.Min[axis]; const float mouse_pos_v = g.IO.MousePos[axis]; // Click position in scrollbar normalized space (0.0f->1.0f) const float clicked_v_norm = ImSaturate((mouse_pos_v - scrollbar_pos_v) / scrollbar_size_v); const int held_dir = (clicked_v_norm < grab_v_norm) ? -1 : (clicked_v_norm > grab_v_norm + grab_h_norm) ? +1 : 0; if (g.ActiveIdIsJustActivated) { // On initial click when held_dir == 0 (clicked over grab): calculate the distance between mouse and the center of the grab const bool scroll_to_clicked_location = (g.IO.ConfigScrollbarScrollByPage == false || g.IO.KeyShift || held_dir == 0); g.ScrollbarSeekMode = scroll_to_clicked_location ? 0 : (short)held_dir; g.ScrollbarClickDeltaToGrabCenter = (held_dir == 0 && !g.IO.KeyShift) ? clicked_v_norm - grab_v_norm - grab_h_norm * 0.5f : 0.0f; } // Apply scroll (p_scroll_v will generally point on one member of window->Scroll) // It is ok to modify Scroll here because we are being called in Begin() after the calculation of ContentSize and before setting up our starting position if (g.ScrollbarSeekMode == 0) { // Absolute seeking const float scroll_v_norm = ImSaturate((clicked_v_norm - g.ScrollbarClickDeltaToGrabCenter - grab_h_norm * 0.5f) / (1.0f - grab_h_norm)); *p_scroll_v = (ImS64)(scroll_v_norm * scroll_max); } else { // Page by page if (IsMouseClicked(ImGuiMouseButton_Left, ImGuiInputFlags_Repeat) && held_dir == g.ScrollbarSeekMode) { float page_dir = (g.ScrollbarSeekMode > 0.0f) ? +1.0f : -1.0f; *p_scroll_v = ImClamp(*p_scroll_v + (ImS64)(page_dir * size_visible_v), (ImS64)0, scroll_max); } } // Update values for rendering scroll_ratio = ImSaturate((float)*p_scroll_v / (float)scroll_max); grab_v_norm = scroll_ratio * (scrollbar_size_v - grab_h_pixels) / scrollbar_size_v; // Update distance to grab now that we have seek'ed and saturated //if (seek_absolute) // g.ScrollbarClickDeltaToGrabCenter = clicked_v_norm - grab_v_norm - grab_h_norm * 0.5f; } // Render const ImU32 bg_col = GetColorU32(ImGuiCol_ScrollbarBg); const ImU32 grab_col = GetColorU32(held ? ImGuiCol_ScrollbarGrabActive : hovered ? ImGuiCol_ScrollbarGrabHovered : ImGuiCol_ScrollbarGrab, alpha); window->DrawList->AddRectFilled(bb_frame.Min, bb_frame.Max, bg_col, window->WindowRounding, draw_rounding_flags); ImRect grab_rect; if (axis == ImGuiAxis_X) grab_rect = ImRect(ImLerp(bb.Min.x, bb.Max.x, grab_v_norm), bb.Min.y, ImLerp(bb.Min.x, bb.Max.x, grab_v_norm) + grab_h_pixels, bb.Max.y); else grab_rect = ImRect(bb.Min.x, ImLerp(bb.Min.y, bb.Max.y, grab_v_norm), bb.Max.x, ImLerp(bb.Min.y, bb.Max.y, grab_v_norm) + grab_h_pixels); window->DrawList->AddRectFilled(grab_rect.Min, grab_rect.Max, grab_col, style.ScrollbarRounding); return held; } // - Read about ImTextureID here: https://github.com/ocornut/imgui/wiki/Image-Loading-and-Displaying-Examples // - 'uv0' and 'uv1' are texture coordinates. Read about them from the same link above. void ImGui::ImageWithBg(ImTextureID user_texture_id, const ImVec2& image_size, const ImVec2& uv0, const ImVec2& uv1, const ImVec4& bg_col, const ImVec4& tint_col) { ImGuiContext& g = *GImGui; ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return; const ImVec2 padding(g.Style.ImageBorderSize, g.Style.ImageBorderSize); const ImRect bb(window->DC.CursorPos, window->DC.CursorPos + image_size + padding * 2.0f); ItemSize(bb); if (!ItemAdd(bb, 0)) return; // Render if (g.Style.ImageBorderSize > 0.0f) window->DrawList->AddRect(bb.Min, bb.Max, GetColorU32(ImGuiCol_Border), 0.0f, ImDrawFlags_None, g.Style.ImageBorderSize); if (bg_col.w > 0.0f) window->DrawList->AddRectFilled(bb.Min + padding, bb.Max - padding, GetColorU32(bg_col)); window->DrawList->AddImage(user_texture_id, bb.Min + padding, bb.Max - padding, uv0, uv1, GetColorU32(tint_col)); } void ImGui::Image(ImTextureID user_texture_id, const ImVec2& image_size, const ImVec2& uv0, const ImVec2& uv1) { ImageWithBg(user_texture_id, image_size, uv0, uv1); } // 1.91.9 (February 2025) removed 'tint_col' and 'border_col' parameters, made border size not depend on color value. (#8131, #8238) #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS void ImGui::Image(ImTextureID user_texture_id, const ImVec2& image_size, const ImVec2& uv0, const ImVec2& uv1, const ImVec4& tint_col, const ImVec4& border_col) { ImGuiContext& g = *GImGui; PushStyleVar(ImGuiStyleVar_ImageBorderSize, (border_col.w > 0.0f) ? ImMax(1.0f, g.Style.ImageBorderSize) : 0.0f); // Preserve legacy behavior where border is always visible when border_col's Alpha is >0.0f PushStyleColor(ImGuiCol_Border, border_col); ImageWithBg(user_texture_id, image_size, uv0, uv1, ImVec4(0, 0, 0, 0), tint_col); PopStyleColor(); PopStyleVar(); } #endif bool ImGui::ImageButtonEx(ImGuiID id, ImTextureID user_texture_id, const ImVec2& image_size, const ImVec2& uv0, const ImVec2& uv1, const ImVec4& bg_col, const ImVec4& tint_col, ImGuiButtonFlags flags) { ImGuiContext& g = *GImGui; ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; const ImVec2 padding = g.Style.FramePadding; const ImRect bb(window->DC.CursorPos, window->DC.CursorPos + image_size + padding * 2.0f); ItemSize(bb); if (!ItemAdd(bb, id)) return false; bool hovered, held; bool pressed = ButtonBehavior(bb, id, &hovered, &held, flags); // Render const ImU32 col = GetColorU32((held && hovered) ? ImGuiCol_ButtonActive : hovered ? ImGuiCol_ButtonHovered : ImGuiCol_Button); RenderNavCursor(bb, id); RenderFrame(bb.Min, bb.Max, col, true, ImClamp((float)ImMin(padding.x, padding.y), 0.0f, g.Style.FrameRounding)); if (bg_col.w > 0.0f) window->DrawList->AddRectFilled(bb.Min + padding, bb.Max - padding, GetColorU32(bg_col)); window->DrawList->AddImage(user_texture_id, bb.Min + padding, bb.Max - padding, uv0, uv1, GetColorU32(tint_col)); return pressed; } // - ImageButton() adds style.FramePadding*2.0f to provided size. This is in order to facilitate fitting an image in a button. // - ImageButton() draws a background based on regular Button() color + optionally an inner background if specified. (#8165) // FIXME: Maybe that's not the best design? bool ImGui::ImageButton(const char* str_id, ImTextureID user_texture_id, const ImVec2& image_size, const ImVec2& uv0, const ImVec2& uv1, const ImVec4& bg_col, const ImVec4& tint_col) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; if (window->SkipItems) return false; return ImageButtonEx(window->GetID(str_id), user_texture_id, image_size, uv0, uv1, bg_col, tint_col); } #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS // Legacy API obsoleted in 1.89. Two differences with new ImageButton() // - old ImageButton() used ImTextureID as item id (created issue with multiple buttons with same image, transient texture id values, opaque computation of ID) // - new ImageButton() requires an explicit 'const char* str_id' // - old ImageButton() had frame_padding' override argument. // - new ImageButton() always use style.FramePadding. /* bool ImGui::ImageButton(ImTextureID user_texture_id, const ImVec2& size, const ImVec2& uv0, const ImVec2& uv1, int frame_padding, const ImVec4& bg_col, const ImVec4& tint_col) { // Default to using texture ID as ID. User can still push string/integer prefixes. PushID((ImTextureID)(intptr_t)user_texture_id); if (frame_padding >= 0) PushStyleVar(ImGuiStyleVar_FramePadding, ImVec2((float)frame_padding, (float)frame_padding)); bool ret = ImageButton("", user_texture_id, size, uv0, uv1, bg_col, tint_col); if (frame_padding >= 0) PopStyleVar(); PopID(); return ret; } */ #endif // #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS bool ImGui::Checkbox(const char* label, bool* v) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; ImGuiContext& g = *GImGui; const ImGuiStyle& style = g.Style; const ImGuiID id = window->GetID(label); const ImVec2 label_size = CalcTextSize(label, NULL, true); const float square_sz = GetFrameHeight(); const ImVec2 pos = window->DC.CursorPos; const ImRect total_bb(pos, pos + ImVec2(square_sz + (label_size.x > 0.0f ? style.ItemInnerSpacing.x + label_size.x : 0.0f), label_size.y + style.FramePadding.y * 2.0f)); ItemSize(total_bb, style.FramePadding.y); const bool is_visible = ItemAdd(total_bb, id); const bool is_multi_select = (g.LastItemData.ItemFlags & ImGuiItemFlags_IsMultiSelect) != 0; if (!is_visible) if (!is_multi_select || !g.BoxSelectState.UnclipMode || !g.BoxSelectState.UnclipRect.Overlaps(total_bb)) // Extra layer of "no logic clip" for box-select support { IMGUI_TEST_ENGINE_ITEM_INFO(id, label, g.LastItemData.StatusFlags | ImGuiItemStatusFlags_Checkable | (*v ? ImGuiItemStatusFlags_Checked : 0)); return false; } // Range-Selection/Multi-selection support (header) bool checked = *v; if (is_multi_select) MultiSelectItemHeader(id, &checked, NULL); bool hovered, held; bool pressed = ButtonBehavior(total_bb, id, &hovered, &held); // Range-Selection/Multi-selection support (footer) if (is_multi_select) MultiSelectItemFooter(id, &checked, &pressed); else if (pressed) checked = !checked; if (*v != checked) { *v = checked; pressed = true; // return value MarkItemEdited(id); } const ImRect check_bb(pos, pos + ImVec2(square_sz, square_sz)); const bool mixed_value = (g.LastItemData.ItemFlags & ImGuiItemFlags_MixedValue) != 0; if (is_visible) { RenderNavCursor(total_bb, id); RenderFrame(check_bb.Min, check_bb.Max, GetColorU32((held && hovered) ? ImGuiCol_FrameBgActive : hovered ? ImGuiCol_FrameBgHovered : ImGuiCol_FrameBg), true, style.FrameRounding); ImU32 check_col = GetColorU32(ImGuiCol_CheckMark); if (mixed_value) { // Undocumented tristate/mixed/indeterminate checkbox (#2644) // This may seem awkwardly designed because the aim is to make ImGuiItemFlags_MixedValue supported by all widgets (not just checkbox) ImVec2 pad(ImMax(1.0f, IM_TRUNC(square_sz / 3.6f)), ImMax(1.0f, IM_TRUNC(square_sz / 3.6f))); window->DrawList->AddRectFilled(check_bb.Min + pad, check_bb.Max - pad, check_col, style.FrameRounding); } else if (*v) { const float pad = ImMax(1.0f, IM_TRUNC(square_sz / 6.0f)); RenderCheckMark(window->DrawList, check_bb.Min + ImVec2(pad, pad), check_col, square_sz - pad * 2.0f); } } const ImVec2 label_pos = ImVec2(check_bb.Max.x + style.ItemInnerSpacing.x, check_bb.Min.y + style.FramePadding.y); if (g.LogEnabled) LogRenderedText(&label_pos, mixed_value ? "[~]" : *v ? "[x]" : "[ ]"); if (is_visible && label_size.x > 0.0f) RenderText(label_pos, label); IMGUI_TEST_ENGINE_ITEM_INFO(id, label, g.LastItemData.StatusFlags | ImGuiItemStatusFlags_Checkable | (*v ? ImGuiItemStatusFlags_Checked : 0)); return pressed; } template bool ImGui::CheckboxFlagsT(const char* label, T* flags, T flags_value) { bool all_on = (*flags & flags_value) == flags_value; bool any_on = (*flags & flags_value) != 0; bool pressed; if (!all_on && any_on) { ImGuiContext& g = *GImGui; g.NextItemData.ItemFlags |= ImGuiItemFlags_MixedValue; pressed = Checkbox(label, &all_on); } else { pressed = Checkbox(label, &all_on); } if (pressed) { if (all_on) *flags |= flags_value; else *flags &= ~flags_value; } return pressed; } bool ImGui::CheckboxFlags(const char* label, int* flags, int flags_value) { return CheckboxFlagsT(label, flags, flags_value); } bool ImGui::CheckboxFlags(const char* label, unsigned int* flags, unsigned int flags_value) { return CheckboxFlagsT(label, flags, flags_value); } bool ImGui::CheckboxFlags(const char* label, ImS64* flags, ImS64 flags_value) { return CheckboxFlagsT(label, flags, flags_value); } bool ImGui::CheckboxFlags(const char* label, ImU64* flags, ImU64 flags_value) { return CheckboxFlagsT(label, flags, flags_value); } bool ImGui::RadioButton(const char* label, bool active) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; ImGuiContext& g = *GImGui; const ImGuiStyle& style = g.Style; const ImGuiID id = window->GetID(label); const ImVec2 label_size = CalcTextSize(label, NULL, true); const float square_sz = GetFrameHeight(); const ImVec2 pos = window->DC.CursorPos; const ImRect check_bb(pos, pos + ImVec2(square_sz, square_sz)); const ImRect total_bb(pos, pos + ImVec2(square_sz + (label_size.x > 0.0f ? style.ItemInnerSpacing.x + label_size.x : 0.0f), label_size.y + style.FramePadding.y * 2.0f)); ItemSize(total_bb, style.FramePadding.y); if (!ItemAdd(total_bb, id)) return false; ImVec2 center = check_bb.GetCenter(); center.x = IM_ROUND(center.x); center.y = IM_ROUND(center.y); const float radius = (square_sz - 1.0f) * 0.5f; bool hovered, held; bool pressed = ButtonBehavior(total_bb, id, &hovered, &held); if (pressed) MarkItemEdited(id); RenderNavCursor(total_bb, id); const int num_segment = window->DrawList->_CalcCircleAutoSegmentCount(radius); window->DrawList->AddCircleFilled(center, radius, GetColorU32((held && hovered) ? ImGuiCol_FrameBgActive : hovered ? ImGuiCol_FrameBgHovered : ImGuiCol_FrameBg), num_segment); if (active) { const float pad = ImMax(1.0f, IM_TRUNC(square_sz / 6.0f)); window->DrawList->AddCircleFilled(center, radius - pad, GetColorU32(ImGuiCol_CheckMark)); } if (style.FrameBorderSize > 0.0f) { window->DrawList->AddCircle(center + ImVec2(1, 1), radius, GetColorU32(ImGuiCol_BorderShadow), num_segment, style.FrameBorderSize); window->DrawList->AddCircle(center, radius, GetColorU32(ImGuiCol_Border), num_segment, style.FrameBorderSize); } ImVec2 label_pos = ImVec2(check_bb.Max.x + style.ItemInnerSpacing.x, check_bb.Min.y + style.FramePadding.y); if (g.LogEnabled) LogRenderedText(&label_pos, active ? "(x)" : "( )"); if (label_size.x > 0.0f) RenderText(label_pos, label); IMGUI_TEST_ENGINE_ITEM_INFO(id, label, g.LastItemData.StatusFlags); return pressed; } // FIXME: This would work nicely if it was a public template, e.g. 'template RadioButton(const char* label, T* v, T v_button)', but I'm not sure how we would expose it.. bool ImGui::RadioButton(const char* label, int* v, int v_button) { const bool pressed = RadioButton(label, *v == v_button); if (pressed) *v = v_button; return pressed; } // size_arg (for each axis) < 0.0f: align to end, 0.0f: auto, > 0.0f: specified size void ImGui::ProgressBar(float fraction, const ImVec2& size_arg, const char* overlay) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return; ImGuiContext& g = *GImGui; const ImGuiStyle& style = g.Style; ImVec2 pos = window->DC.CursorPos; ImVec2 size = CalcItemSize(size_arg, CalcItemWidth(), g.FontSize + style.FramePadding.y * 2.0f); ImRect bb(pos, pos + size); ItemSize(size, style.FramePadding.y); if (!ItemAdd(bb, 0)) return; // Fraction < 0.0f will display an indeterminate progress bar animation // The value must be animated along with time, so e.g. passing '-1.0f * ImGui::GetTime()' as fraction works. const bool is_indeterminate = (fraction < 0.0f); if (!is_indeterminate) fraction = ImSaturate(fraction); // Out of courtesy we accept a NaN fraction without crashing float fill_n0 = 0.0f; float fill_n1 = (fraction == fraction) ? fraction : 0.0f; if (is_indeterminate) { const float fill_width_n = 0.2f; fill_n0 = ImFmod(-fraction, 1.0f) * (1.0f + fill_width_n) - fill_width_n; fill_n1 = ImSaturate(fill_n0 + fill_width_n); fill_n0 = ImSaturate(fill_n0); } // Render RenderFrame(bb.Min, bb.Max, GetColorU32(ImGuiCol_FrameBg), true, style.FrameRounding); bb.Expand(ImVec2(-style.FrameBorderSize, -style.FrameBorderSize)); RenderRectFilledRangeH(window->DrawList, bb, GetColorU32(ImGuiCol_PlotHistogram), fill_n0, fill_n1, style.FrameRounding); // Default displaying the fraction as percentage string, but user can override it // Don't display text for indeterminate bars by default char overlay_buf[32]; if (!is_indeterminate || overlay != NULL) { if (!overlay) { ImFormatString(overlay_buf, IM_ARRAYSIZE(overlay_buf), "%.0f%%", fraction * 100 + 0.01f); overlay = overlay_buf; } ImVec2 overlay_size = CalcTextSize(overlay, NULL); if (overlay_size.x > 0.0f) { float text_x = is_indeterminate ? (bb.Min.x + bb.Max.x - overlay_size.x) * 0.5f : ImLerp(bb.Min.x, bb.Max.x, fill_n1) + style.ItemSpacing.x; RenderTextClipped(ImVec2(ImClamp(text_x, bb.Min.x, bb.Max.x - overlay_size.x - style.ItemInnerSpacing.x), bb.Min.y), bb.Max, overlay, NULL, &overlay_size, ImVec2(0.0f, 0.5f), &bb); } } } void ImGui::Bullet() { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return; ImGuiContext& g = *GImGui; const ImGuiStyle& style = g.Style; const float line_height = ImMax(ImMin(window->DC.CurrLineSize.y, g.FontSize + style.FramePadding.y * 2), g.FontSize); const ImRect bb(window->DC.CursorPos, window->DC.CursorPos + ImVec2(g.FontSize, line_height)); ItemSize(bb); if (!ItemAdd(bb, 0)) { SameLine(0, style.FramePadding.x * 2); return; } // Render and stay on same line ImU32 text_col = GetColorU32(ImGuiCol_Text); RenderBullet(window->DrawList, bb.Min + ImVec2(style.FramePadding.x + g.FontSize * 0.5f, line_height * 0.5f), text_col); SameLine(0, style.FramePadding.x * 2.0f); } // This is provided as a convenience for being an often requested feature. // FIXME-STYLE: we delayed adding as there is a larger plan to revamp the styling system. // Because of this we currently don't provide many styling options for this widget // (e.g. hovered/active colors are automatically inferred from a single color). bool ImGui::TextLink(const char* label) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; ImGuiContext& g = *GImGui; const ImGuiID id = window->GetID(label); const char* label_end = FindRenderedTextEnd(label); ImVec2 pos(window->DC.CursorPos.x, window->DC.CursorPos.y + window->DC.CurrLineTextBaseOffset); ImVec2 size = CalcTextSize(label, label_end, true); ImRect bb(pos, pos + size); ItemSize(size, 0.0f); if (!ItemAdd(bb, id)) return false; bool hovered, held; bool pressed = ButtonBehavior(bb, id, &hovered, &held); RenderNavCursor(bb, id); if (hovered) SetMouseCursor(ImGuiMouseCursor_Hand); ImVec4 text_colf = g.Style.Colors[ImGuiCol_TextLink]; ImVec4 line_colf = text_colf; { // FIXME-STYLE: Read comments above. This widget is NOT written in the same style as some earlier widgets, // as we are currently experimenting/planning a different styling system. float h, s, v; ColorConvertRGBtoHSV(text_colf.x, text_colf.y, text_colf.z, h, s, v); if (held || hovered) { v = ImSaturate(v + (held ? 0.4f : 0.3f)); h = ImFmod(h + 0.02f, 1.0f); } ColorConvertHSVtoRGB(h, s, v, text_colf.x, text_colf.y, text_colf.z); v = ImSaturate(v - 0.20f); ColorConvertHSVtoRGB(h, s, v, line_colf.x, line_colf.y, line_colf.z); } float line_y = bb.Max.y + ImFloor(g.Font->Descent * g.FontScale * 0.20f); window->DrawList->AddLine(ImVec2(bb.Min.x, line_y), ImVec2(bb.Max.x, line_y), GetColorU32(line_colf)); // FIXME-TEXT: Underline mode. PushStyleColor(ImGuiCol_Text, GetColorU32(text_colf)); RenderText(bb.Min, label, label_end); PopStyleColor(); IMGUI_TEST_ENGINE_ITEM_INFO(id, label, g.LastItemData.StatusFlags); return pressed; } void ImGui::TextLinkOpenURL(const char* label, const char* url) { ImGuiContext& g = *GImGui; if (url == NULL) url = label; if (TextLink(label)) if (g.PlatformIO.Platform_OpenInShellFn != NULL) g.PlatformIO.Platform_OpenInShellFn(&g, url); SetItemTooltip(LocalizeGetMsg(ImGuiLocKey_OpenLink_s), url); // It is more reassuring for user to _always_ display URL when we same as label if (BeginPopupContextItem()) { if (MenuItem(LocalizeGetMsg(ImGuiLocKey_CopyLink))) SetClipboardText(url); EndPopup(); } } //------------------------------------------------------------------------- // [SECTION] Widgets: Low-level Layout helpers //------------------------------------------------------------------------- // - Spacing() // - Dummy() // - NewLine() // - AlignTextToFramePadding() // - SeparatorEx() [Internal] // - Separator() // - SplitterBehavior() [Internal] // - ShrinkWidths() [Internal] //------------------------------------------------------------------------- void ImGui::Spacing() { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return; ItemSize(ImVec2(0, 0)); } void ImGui::Dummy(const ImVec2& size) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return; const ImRect bb(window->DC.CursorPos, window->DC.CursorPos + size); ItemSize(size); ItemAdd(bb, 0); } void ImGui::NewLine() { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return; ImGuiContext& g = *GImGui; const ImGuiLayoutType backup_layout_type = window->DC.LayoutType; window->DC.LayoutType = ImGuiLayoutType_Vertical; window->DC.IsSameLine = false; if (window->DC.CurrLineSize.y > 0.0f) // In the event that we are on a line with items that is smaller that FontSize high, we will preserve its height. ItemSize(ImVec2(0, 0)); else ItemSize(ImVec2(0.0f, g.FontSize)); window->DC.LayoutType = backup_layout_type; } void ImGui::AlignTextToFramePadding() { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return; ImGuiContext& g = *GImGui; window->DC.CurrLineSize.y = ImMax(window->DC.CurrLineSize.y, g.FontSize + g.Style.FramePadding.y * 2); window->DC.CurrLineTextBaseOffset = ImMax(window->DC.CurrLineTextBaseOffset, g.Style.FramePadding.y); } // Horizontal/vertical separating line // FIXME: Surprisingly, this seemingly trivial widget is a victim of many different legacy/tricky layout issues. // Note how thickness == 1.0f is handled specifically as not moving CursorPos by 'thickness', but other values are. void ImGui::SeparatorEx(ImGuiSeparatorFlags flags, float thickness) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return; ImGuiContext& g = *GImGui; IM_ASSERT(ImIsPowerOfTwo(flags & (ImGuiSeparatorFlags_Horizontal | ImGuiSeparatorFlags_Vertical))); // Check that only 1 option is selected IM_ASSERT(thickness > 0.0f); if (flags & ImGuiSeparatorFlags_Vertical) { // Vertical separator, for menu bars (use current line height). float y1 = window->DC.CursorPos.y; float y2 = window->DC.CursorPos.y + window->DC.CurrLineSize.y; const ImRect bb(ImVec2(window->DC.CursorPos.x, y1), ImVec2(window->DC.CursorPos.x + thickness, y2)); ItemSize(ImVec2(thickness, 0.0f)); if (!ItemAdd(bb, 0)) return; // Draw window->DrawList->AddRectFilled(bb.Min, bb.Max, GetColorU32(ImGuiCol_Separator)); if (g.LogEnabled) LogText(" |"); } else if (flags & ImGuiSeparatorFlags_Horizontal) { // Horizontal Separator float x1 = window->DC.CursorPos.x; float x2 = window->WorkRect.Max.x; // Preserve legacy behavior inside Columns() // Before Tables API happened, we relied on Separator() to span all columns of a Columns() set. // We currently don't need to provide the same feature for tables because tables naturally have border features. ImGuiOldColumns* columns = (flags & ImGuiSeparatorFlags_SpanAllColumns) ? window->DC.CurrentColumns : NULL; if (columns) { x1 = window->Pos.x + window->DC.Indent.x; // Used to be Pos.x before 2023/10/03 x2 = window->Pos.x + window->Size.x; PushColumnsBackground(); } // We don't provide our width to the layout so that it doesn't get feed back into AutoFit // FIXME: This prevents ->CursorMaxPos based bounding box evaluation from working (e.g. TableEndCell) const float thickness_for_layout = (thickness == 1.0f) ? 0.0f : thickness; // FIXME: See 1.70/1.71 Separator() change: makes legacy 1-px separator not affect layout yet. Should change. const ImRect bb(ImVec2(x1, window->DC.CursorPos.y), ImVec2(x2, window->DC.CursorPos.y + thickness)); ItemSize(ImVec2(0.0f, thickness_for_layout)); if (ItemAdd(bb, 0)) { // Draw window->DrawList->AddRectFilled(bb.Min, bb.Max, GetColorU32(ImGuiCol_Separator)); if (g.LogEnabled) LogRenderedText(&bb.Min, "--------------------------------\n"); } if (columns) { PopColumnsBackground(); columns->LineMinY = window->DC.CursorPos.y; } } } void ImGui::Separator() { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; if (window->SkipItems) return; // Those flags should eventually be configurable by the user // FIXME: We cannot g.Style.SeparatorTextBorderSize for thickness as it relates to SeparatorText() which is a decorated separator, not defaulting to 1.0f. ImGuiSeparatorFlags flags = (window->DC.LayoutType == ImGuiLayoutType_Horizontal) ? ImGuiSeparatorFlags_Vertical : ImGuiSeparatorFlags_Horizontal; // Only applies to legacy Columns() api as they relied on Separator() a lot. if (window->DC.CurrentColumns) flags |= ImGuiSeparatorFlags_SpanAllColumns; SeparatorEx(flags, 1.0f); } void ImGui::SeparatorTextEx(ImGuiID id, const char* label, const char* label_end, float extra_w) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; ImGuiStyle& style = g.Style; const ImVec2 label_size = CalcTextSize(label, label_end, false); const ImVec2 pos = window->DC.CursorPos; const ImVec2 padding = style.SeparatorTextPadding; const float separator_thickness = style.SeparatorTextBorderSize; const ImVec2 min_size(label_size.x + extra_w + padding.x * 2.0f, ImMax(label_size.y + padding.y * 2.0f, separator_thickness)); const ImRect bb(pos, ImVec2(window->WorkRect.Max.x, pos.y + min_size.y)); const float text_baseline_y = ImTrunc((bb.GetHeight() - label_size.y) * style.SeparatorTextAlign.y + 0.99999f); //ImMax(padding.y, ImFloor((style.SeparatorTextSize - label_size.y) * 0.5f)); ItemSize(min_size, text_baseline_y); if (!ItemAdd(bb, id)) return; const float sep1_x1 = pos.x; const float sep2_x2 = bb.Max.x; const float seps_y = ImTrunc((bb.Min.y + bb.Max.y) * 0.5f + 0.99999f); const float label_avail_w = ImMax(0.0f, sep2_x2 - sep1_x1 - padding.x * 2.0f); const ImVec2 label_pos(pos.x + padding.x + ImMax(0.0f, (label_avail_w - label_size.x - extra_w) * style.SeparatorTextAlign.x), pos.y + text_baseline_y); // FIXME-ALIGN // This allows using SameLine() to position something in the 'extra_w' window->DC.CursorPosPrevLine.x = label_pos.x + label_size.x; const ImU32 separator_col = GetColorU32(ImGuiCol_Separator); if (label_size.x > 0.0f) { const float sep1_x2 = label_pos.x - style.ItemSpacing.x; const float sep2_x1 = label_pos.x + label_size.x + extra_w + style.ItemSpacing.x; if (sep1_x2 > sep1_x1 && separator_thickness > 0.0f) window->DrawList->AddLine(ImVec2(sep1_x1, seps_y), ImVec2(sep1_x2, seps_y), separator_col, separator_thickness); if (sep2_x2 > sep2_x1 && separator_thickness > 0.0f) window->DrawList->AddLine(ImVec2(sep2_x1, seps_y), ImVec2(sep2_x2, seps_y), separator_col, separator_thickness); if (g.LogEnabled) LogSetNextTextDecoration("---", NULL); RenderTextEllipsis(window->DrawList, label_pos, ImVec2(bb.Max.x, bb.Max.y + style.ItemSpacing.y), bb.Max.x, bb.Max.x, label, label_end, &label_size); } else { if (g.LogEnabled) LogText("---"); if (separator_thickness > 0.0f) window->DrawList->AddLine(ImVec2(sep1_x1, seps_y), ImVec2(sep2_x2, seps_y), separator_col, separator_thickness); } } void ImGui::SeparatorText(const char* label) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return; // The SeparatorText() vs SeparatorTextEx() distinction is designed to be considerate that we may want: // - allow separator-text to be draggable items (would require a stable ID + a noticeable highlight) // - this high-level entry point to allow formatting? (which in turns may require ID separate from formatted string) // - because of this we probably can't turn 'const char* label' into 'const char* fmt, ...' // Otherwise, we can decide that users wanting to drag this would layout a dedicated drag-item, // and then we can turn this into a format function. SeparatorTextEx(0, label, FindRenderedTextEnd(label), 0.0f); } // Using 'hover_visibility_delay' allows us to hide the highlight and mouse cursor for a short time, which can be convenient to reduce visual noise. bool ImGui::SplitterBehavior(const ImRect& bb, ImGuiID id, ImGuiAxis axis, float* size1, float* size2, float min_size1, float min_size2, float hover_extend, float hover_visibility_delay, ImU32 bg_col) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; if (!ItemAdd(bb, id, NULL, ImGuiItemFlags_NoNav)) return false; // FIXME: AFAIK the only leftover reason for passing ImGuiButtonFlags_AllowOverlap here is // to allow caller of SplitterBehavior() to call SetItemAllowOverlap() after the item. // Nowadays we would instead want to use SetNextItemAllowOverlap() before the item. ImGuiButtonFlags button_flags = ImGuiButtonFlags_FlattenChildren; #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS button_flags |= ImGuiButtonFlags_AllowOverlap; #endif bool hovered, held; ImRect bb_interact = bb; bb_interact.Expand(axis == ImGuiAxis_Y ? ImVec2(0.0f, hover_extend) : ImVec2(hover_extend, 0.0f)); ButtonBehavior(bb_interact, id, &hovered, &held, button_flags); if (hovered) g.LastItemData.StatusFlags |= ImGuiItemStatusFlags_HoveredRect; // for IsItemHovered(), because bb_interact is larger than bb if (held || (hovered && g.HoveredIdPreviousFrame == id && g.HoveredIdTimer >= hover_visibility_delay)) SetMouseCursor(axis == ImGuiAxis_Y ? ImGuiMouseCursor_ResizeNS : ImGuiMouseCursor_ResizeEW); ImRect bb_render = bb; if (held) { float mouse_delta = (g.IO.MousePos - g.ActiveIdClickOffset - bb_interact.Min)[axis]; // Minimum pane size float size_1_maximum_delta = ImMax(0.0f, *size1 - min_size1); float size_2_maximum_delta = ImMax(0.0f, *size2 - min_size2); if (mouse_delta < -size_1_maximum_delta) mouse_delta = -size_1_maximum_delta; if (mouse_delta > size_2_maximum_delta) mouse_delta = size_2_maximum_delta; // Apply resize if (mouse_delta != 0.0f) { *size1 = ImMax(*size1 + mouse_delta, min_size1); *size2 = ImMax(*size2 - mouse_delta, min_size2); bb_render.Translate((axis == ImGuiAxis_X) ? ImVec2(mouse_delta, 0.0f) : ImVec2(0.0f, mouse_delta)); MarkItemEdited(id); } } // Render at new position if (bg_col & IM_COL32_A_MASK) window->DrawList->AddRectFilled(bb_render.Min, bb_render.Max, bg_col, 0.0f); const ImU32 col = GetColorU32(held ? ImGuiCol_SeparatorActive : (hovered && g.HoveredIdTimer >= hover_visibility_delay) ? ImGuiCol_SeparatorHovered : ImGuiCol_Separator); window->DrawList->AddRectFilled(bb_render.Min, bb_render.Max, col, 0.0f); return held; } static int IMGUI_CDECL ShrinkWidthItemComparer(const void* lhs, const void* rhs) { const ImGuiShrinkWidthItem* a = (const ImGuiShrinkWidthItem*)lhs; const ImGuiShrinkWidthItem* b = (const ImGuiShrinkWidthItem*)rhs; if (int d = (int)(b->Width - a->Width)) return d; return (b->Index - a->Index); } // Shrink excess width from a set of item, by removing width from the larger items first. // Set items Width to -1.0f to disable shrinking this item. void ImGui::ShrinkWidths(ImGuiShrinkWidthItem* items, int count, float width_excess) { if (count == 1) { if (items[0].Width >= 0.0f) items[0].Width = ImMax(items[0].Width - width_excess, 1.0f); return; } ImQsort(items, (size_t)count, sizeof(ImGuiShrinkWidthItem), ShrinkWidthItemComparer); int count_same_width = 1; while (width_excess > 0.0f && count_same_width < count) { while (count_same_width < count && items[0].Width <= items[count_same_width].Width) count_same_width++; float max_width_to_remove_per_item = (count_same_width < count && items[count_same_width].Width >= 0.0f) ? (items[0].Width - items[count_same_width].Width) : (items[0].Width - 1.0f); if (max_width_to_remove_per_item <= 0.0f) break; float width_to_remove_per_item = ImMin(width_excess / count_same_width, max_width_to_remove_per_item); for (int item_n = 0; item_n < count_same_width; item_n++) items[item_n].Width -= width_to_remove_per_item; width_excess -= width_to_remove_per_item * count_same_width; } // Round width and redistribute remainder // Ensure that e.g. the right-most tab of a shrunk tab-bar always reaches exactly at the same distance from the right-most edge of the tab bar separator. width_excess = 0.0f; for (int n = 0; n < count; n++) { float width_rounded = ImTrunc(items[n].Width); width_excess += items[n].Width - width_rounded; items[n].Width = width_rounded; } while (width_excess > 0.0f) for (int n = 0; n < count && width_excess > 0.0f; n++) { float width_to_add = ImMin(items[n].InitialWidth - items[n].Width, 1.0f); items[n].Width += width_to_add; width_excess -= width_to_add; } } //------------------------------------------------------------------------- // [SECTION] Widgets: ComboBox //------------------------------------------------------------------------- // - CalcMaxPopupHeightFromItemCount() [Internal] // - BeginCombo() // - BeginComboPopup() [Internal] // - EndCombo() // - BeginComboPreview() [Internal] // - EndComboPreview() [Internal] // - Combo() //------------------------------------------------------------------------- static float CalcMaxPopupHeightFromItemCount(int items_count) { ImGuiContext& g = *GImGui; if (items_count <= 0) return FLT_MAX; return (g.FontSize + g.Style.ItemSpacing.y) * items_count - g.Style.ItemSpacing.y + (g.Style.WindowPadding.y * 2); } bool ImGui::BeginCombo(const char* label, const char* preview_value, ImGuiComboFlags flags) { ImGuiContext& g = *GImGui; ImGuiWindow* window = GetCurrentWindow(); ImGuiNextWindowDataFlags backup_next_window_data_flags = g.NextWindowData.HasFlags; g.NextWindowData.ClearFlags(); // We behave like Begin() and need to consume those values if (window->SkipItems) return false; const ImGuiStyle& style = g.Style; const ImGuiID id = window->GetID(label); IM_ASSERT((flags & (ImGuiComboFlags_NoArrowButton | ImGuiComboFlags_NoPreview)) != (ImGuiComboFlags_NoArrowButton | ImGuiComboFlags_NoPreview)); // Can't use both flags together if (flags & ImGuiComboFlags_WidthFitPreview) IM_ASSERT((flags & (ImGuiComboFlags_NoPreview | (ImGuiComboFlags)ImGuiComboFlags_CustomPreview)) == 0); const float arrow_size = (flags & ImGuiComboFlags_NoArrowButton) ? 0.0f : GetFrameHeight(); const ImVec2 label_size = CalcTextSize(label, NULL, true); const float preview_width = ((flags & ImGuiComboFlags_WidthFitPreview) && (preview_value != NULL)) ? CalcTextSize(preview_value, NULL, true).x : 0.0f; const float w = (flags & ImGuiComboFlags_NoPreview) ? arrow_size : ((flags & ImGuiComboFlags_WidthFitPreview) ? (arrow_size + preview_width + style.FramePadding.x * 2.0f) : CalcItemWidth()); const ImRect bb(window->DC.CursorPos, window->DC.CursorPos + ImVec2(w, label_size.y + style.FramePadding.y * 2.0f)); const ImRect total_bb(bb.Min, bb.Max + ImVec2(label_size.x > 0.0f ? style.ItemInnerSpacing.x + label_size.x : 0.0f, 0.0f)); ItemSize(total_bb, style.FramePadding.y); if (!ItemAdd(total_bb, id, &bb)) return false; // Open on click bool hovered, held; bool pressed = ButtonBehavior(bb, id, &hovered, &held); const ImGuiID popup_id = ImHashStr("##ComboPopup", 0, id); bool popup_open = IsPopupOpen(popup_id, ImGuiPopupFlags_None); if (pressed && !popup_open) { OpenPopupEx(popup_id, ImGuiPopupFlags_None); popup_open = true; } // Render shape const ImU32 frame_col = GetColorU32(hovered ? ImGuiCol_FrameBgHovered : ImGuiCol_FrameBg); const float value_x2 = ImMax(bb.Min.x, bb.Max.x - arrow_size); RenderNavCursor(bb, id); if (!(flags & ImGuiComboFlags_NoPreview)) window->DrawList->AddRectFilled(bb.Min, ImVec2(value_x2, bb.Max.y), frame_col, style.FrameRounding, (flags & ImGuiComboFlags_NoArrowButton) ? ImDrawFlags_RoundCornersAll : ImDrawFlags_RoundCornersLeft); if (!(flags & ImGuiComboFlags_NoArrowButton)) { ImU32 bg_col = GetColorU32((popup_open || hovered) ? ImGuiCol_ButtonHovered : ImGuiCol_Button); ImU32 text_col = GetColorU32(ImGuiCol_Text); window->DrawList->AddRectFilled(ImVec2(value_x2, bb.Min.y), bb.Max, bg_col, style.FrameRounding, (w <= arrow_size) ? ImDrawFlags_RoundCornersAll : ImDrawFlags_RoundCornersRight); if (value_x2 + arrow_size - style.FramePadding.x <= bb.Max.x) RenderArrow(window->DrawList, ImVec2(value_x2 + style.FramePadding.y, bb.Min.y + style.FramePadding.y), text_col, ImGuiDir_Down, 1.0f); } RenderFrameBorder(bb.Min, bb.Max, style.FrameRounding); // Custom preview if (flags & ImGuiComboFlags_CustomPreview) { g.ComboPreviewData.PreviewRect = ImRect(bb.Min.x, bb.Min.y, value_x2, bb.Max.y); IM_ASSERT(preview_value == NULL || preview_value[0] == 0); preview_value = NULL; } // Render preview and label if (preview_value != NULL && !(flags & ImGuiComboFlags_NoPreview)) { if (g.LogEnabled) LogSetNextTextDecoration("{", "}"); RenderTextClipped(bb.Min + style.FramePadding, ImVec2(value_x2, bb.Max.y), preview_value, NULL, NULL); } if (label_size.x > 0) RenderText(ImVec2(bb.Max.x + style.ItemInnerSpacing.x, bb.Min.y + style.FramePadding.y), label); if (!popup_open) return false; g.NextWindowData.HasFlags = backup_next_window_data_flags; return BeginComboPopup(popup_id, bb, flags); } bool ImGui::BeginComboPopup(ImGuiID popup_id, const ImRect& bb, ImGuiComboFlags flags) { ImGuiContext& g = *GImGui; if (!IsPopupOpen(popup_id, ImGuiPopupFlags_None)) { g.NextWindowData.ClearFlags(); return false; } // Set popup size float w = bb.GetWidth(); if (g.NextWindowData.HasFlags & ImGuiNextWindowDataFlags_HasSizeConstraint) { g.NextWindowData.SizeConstraintRect.Min.x = ImMax(g.NextWindowData.SizeConstraintRect.Min.x, w); } else { if ((flags & ImGuiComboFlags_HeightMask_) == 0) flags |= ImGuiComboFlags_HeightRegular; IM_ASSERT(ImIsPowerOfTwo(flags & ImGuiComboFlags_HeightMask_)); // Only one int popup_max_height_in_items = -1; if (flags & ImGuiComboFlags_HeightRegular) popup_max_height_in_items = 8; else if (flags & ImGuiComboFlags_HeightSmall) popup_max_height_in_items = 4; else if (flags & ImGuiComboFlags_HeightLarge) popup_max_height_in_items = 20; ImVec2 constraint_min(0.0f, 0.0f), constraint_max(FLT_MAX, FLT_MAX); if ((g.NextWindowData.HasFlags & ImGuiNextWindowDataFlags_HasSize) == 0 || g.NextWindowData.SizeVal.x <= 0.0f) // Don't apply constraints if user specified a size constraint_min.x = w; if ((g.NextWindowData.HasFlags & ImGuiNextWindowDataFlags_HasSize) == 0 || g.NextWindowData.SizeVal.y <= 0.0f) constraint_max.y = CalcMaxPopupHeightFromItemCount(popup_max_height_in_items); SetNextWindowSizeConstraints(constraint_min, constraint_max); } // This is essentially a specialized version of BeginPopupEx() char name[16]; ImFormatString(name, IM_ARRAYSIZE(name), "##Combo_%02d", g.BeginComboDepth); // Recycle windows based on depth // Set position given a custom constraint (peak into expected window size so we can position it) // FIXME: This might be easier to express with an hypothetical SetNextWindowPosConstraints() function? // FIXME: This might be moved to Begin() or at least around the same spot where Tooltips and other Popups are calling FindBestWindowPosForPopupEx()? if (ImGuiWindow* popup_window = FindWindowByName(name)) if (popup_window->WasActive) { // Always override 'AutoPosLastDirection' to not leave a chance for a past value to affect us. ImVec2 size_expected = CalcWindowNextAutoFitSize(popup_window); popup_window->AutoPosLastDirection = (flags & ImGuiComboFlags_PopupAlignLeft) ? ImGuiDir_Left : ImGuiDir_Down; // Left = "Below, Toward Left", Down = "Below, Toward Right (default)" ImRect r_outer = GetPopupAllowedExtentRect(popup_window); ImVec2 pos = FindBestWindowPosForPopupEx(bb.GetBL(), size_expected, &popup_window->AutoPosLastDirection, r_outer, bb, ImGuiPopupPositionPolicy_ComboBox); SetNextWindowPos(pos); } // We don't use BeginPopupEx() solely because we have a custom name string, which we could make an argument to BeginPopupEx() ImGuiWindowFlags window_flags = ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_Popup | ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoSavedSettings | ImGuiWindowFlags_NoMove; PushStyleVarX(ImGuiStyleVar_WindowPadding, g.Style.FramePadding.x); // Horizontally align ourselves with the framed text bool ret = Begin(name, NULL, window_flags); PopStyleVar(); if (!ret) { EndPopup(); IM_ASSERT(0); // This should never happen as we tested for IsPopupOpen() above return false; } g.BeginComboDepth++; return true; } void ImGui::EndCombo() { ImGuiContext& g = *GImGui; EndPopup(); g.BeginComboDepth--; } // Call directly after the BeginCombo/EndCombo block. The preview is designed to only host non-interactive elements // (Experimental, see GitHub issues: #1658, #4168) bool ImGui::BeginComboPreview() { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; ImGuiComboPreviewData* preview_data = &g.ComboPreviewData; if (window->SkipItems || !(g.LastItemData.StatusFlags & ImGuiItemStatusFlags_Visible)) return false; IM_ASSERT(g.LastItemData.Rect.Min.x == preview_data->PreviewRect.Min.x && g.LastItemData.Rect.Min.y == preview_data->PreviewRect.Min.y); // Didn't call after BeginCombo/EndCombo block or forgot to pass ImGuiComboFlags_CustomPreview flag? if (!window->ClipRect.Overlaps(preview_data->PreviewRect)) // Narrower test (optional) return false; // FIXME: This could be contained in a PushWorkRect() api preview_data->BackupCursorPos = window->DC.CursorPos; preview_data->BackupCursorMaxPos = window->DC.CursorMaxPos; preview_data->BackupCursorPosPrevLine = window->DC.CursorPosPrevLine; preview_data->BackupPrevLineTextBaseOffset = window->DC.PrevLineTextBaseOffset; preview_data->BackupLayout = window->DC.LayoutType; window->DC.CursorPos = preview_data->PreviewRect.Min + g.Style.FramePadding; window->DC.CursorMaxPos = window->DC.CursorPos; window->DC.LayoutType = ImGuiLayoutType_Horizontal; window->DC.IsSameLine = false; PushClipRect(preview_data->PreviewRect.Min, preview_data->PreviewRect.Max, true); return true; } void ImGui::EndComboPreview() { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; ImGuiComboPreviewData* preview_data = &g.ComboPreviewData; // FIXME: Using CursorMaxPos approximation instead of correct AABB which we will store in ImDrawCmd in the future ImDrawList* draw_list = window->DrawList; if (window->DC.CursorMaxPos.x < preview_data->PreviewRect.Max.x && window->DC.CursorMaxPos.y < preview_data->PreviewRect.Max.y) if (draw_list->CmdBuffer.Size > 1) // Unlikely case that the PushClipRect() didn't create a command { draw_list->_CmdHeader.ClipRect = draw_list->CmdBuffer[draw_list->CmdBuffer.Size - 1].ClipRect = draw_list->CmdBuffer[draw_list->CmdBuffer.Size - 2].ClipRect; draw_list->_TryMergeDrawCmds(); } PopClipRect(); window->DC.CursorPos = preview_data->BackupCursorPos; window->DC.CursorMaxPos = ImMax(window->DC.CursorMaxPos, preview_data->BackupCursorMaxPos); window->DC.CursorPosPrevLine = preview_data->BackupCursorPosPrevLine; window->DC.PrevLineTextBaseOffset = preview_data->BackupPrevLineTextBaseOffset; window->DC.LayoutType = preview_data->BackupLayout; window->DC.IsSameLine = false; preview_data->PreviewRect = ImRect(); } // Getter for the old Combo() API: const char*[] static const char* Items_ArrayGetter(void* data, int idx) { const char* const* items = (const char* const*)data; return items[idx]; } // Getter for the old Combo() API: "item1\0item2\0item3\0" static const char* Items_SingleStringGetter(void* data, int idx) { const char* items_separated_by_zeros = (const char*)data; int items_count = 0; const char* p = items_separated_by_zeros; while (*p) { if (idx == items_count) break; p += ImStrlen(p) + 1; items_count++; } return *p ? p : NULL; } // Old API, prefer using BeginCombo() nowadays if you can. bool ImGui::Combo(const char* label, int* current_item, const char* (*getter)(void* user_data, int idx), void* user_data, int items_count, int popup_max_height_in_items) { ImGuiContext& g = *GImGui; // Call the getter to obtain the preview string which is a parameter to BeginCombo() const char* preview_value = NULL; if (*current_item >= 0 && *current_item < items_count) preview_value = getter(user_data, *current_item); // The old Combo() API exposed "popup_max_height_in_items". The new more general BeginCombo() API doesn't have/need it, but we emulate it here. if (popup_max_height_in_items != -1 && !(g.NextWindowData.HasFlags & ImGuiNextWindowDataFlags_HasSizeConstraint)) SetNextWindowSizeConstraints(ImVec2(0, 0), ImVec2(FLT_MAX, CalcMaxPopupHeightFromItemCount(popup_max_height_in_items))); if (!BeginCombo(label, preview_value, ImGuiComboFlags_None)) return false; // Display items bool value_changed = false; ImGuiListClipper clipper; clipper.Begin(items_count); clipper.IncludeItemByIndex(*current_item); while (clipper.Step()) for (int i = clipper.DisplayStart; i < clipper.DisplayEnd; i++) { const char* item_text = getter(user_data, i); if (item_text == NULL) item_text = "*Unknown item*"; PushID(i); const bool item_selected = (i == *current_item); if (Selectable(item_text, item_selected) && *current_item != i) { value_changed = true; *current_item = i; } if (item_selected) SetItemDefaultFocus(); PopID(); } EndCombo(); if (value_changed) MarkItemEdited(g.LastItemData.ID); return value_changed; } // Combo box helper allowing to pass an array of strings. bool ImGui::Combo(const char* label, int* current_item, const char* const items[], int items_count, int height_in_items) { const bool value_changed = Combo(label, current_item, Items_ArrayGetter, (void*)items, items_count, height_in_items); return value_changed; } // Combo box helper allowing to pass all items in a single string literal holding multiple zero-terminated items "item1\0item2\0" bool ImGui::Combo(const char* label, int* current_item, const char* items_separated_by_zeros, int height_in_items) { int items_count = 0; const char* p = items_separated_by_zeros; // FIXME-OPT: Avoid computing this, or at least only when combo is open while (*p) { p += ImStrlen(p) + 1; items_count++; } bool value_changed = Combo(label, current_item, Items_SingleStringGetter, (void*)items_separated_by_zeros, items_count, height_in_items); return value_changed; } #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS struct ImGuiGetNameFromIndexOldToNewCallbackData { void* UserData; bool (*OldCallback)(void*, int, const char**); }; static const char* ImGuiGetNameFromIndexOldToNewCallback(void* user_data, int idx) { ImGuiGetNameFromIndexOldToNewCallbackData* data = (ImGuiGetNameFromIndexOldToNewCallbackData*)user_data; const char* s = NULL; data->OldCallback(data->UserData, idx, &s); return s; } bool ImGui::ListBox(const char* label, int* current_item, bool (*old_getter)(void*, int, const char**), void* user_data, int items_count, int height_in_items) { ImGuiGetNameFromIndexOldToNewCallbackData old_to_new_data = { user_data, old_getter }; return ListBox(label, current_item, ImGuiGetNameFromIndexOldToNewCallback, &old_to_new_data, items_count, height_in_items); } bool ImGui::Combo(const char* label, int* current_item, bool (*old_getter)(void*, int, const char**), void* user_data, int items_count, int popup_max_height_in_items) { ImGuiGetNameFromIndexOldToNewCallbackData old_to_new_data = { user_data, old_getter }; return Combo(label, current_item, ImGuiGetNameFromIndexOldToNewCallback, &old_to_new_data, items_count, popup_max_height_in_items); } #endif //------------------------------------------------------------------------- // [SECTION] Data Type and Data Formatting Helpers [Internal] //------------------------------------------------------------------------- // - DataTypeGetInfo() // - DataTypeFormatString() // - DataTypeApplyOp() // - DataTypeApplyFromText() // - DataTypeCompare() // - DataTypeClamp() // - GetMinimumStepAtDecimalPrecision // - RoundScalarWithFormat<>() //------------------------------------------------------------------------- static const ImGuiDataTypeInfo GDataTypeInfo[] = { { sizeof(char), "S8", "%d", "%d" }, // ImGuiDataType_S8 { sizeof(unsigned char), "U8", "%u", "%u" }, { sizeof(short), "S16", "%d", "%d" }, // ImGuiDataType_S16 { sizeof(unsigned short), "U16", "%u", "%u" }, { sizeof(int), "S32", "%d", "%d" }, // ImGuiDataType_S32 { sizeof(unsigned int), "U32", "%u", "%u" }, #ifdef _MSC_VER { sizeof(ImS64), "S64", "%I64d","%I64d" }, // ImGuiDataType_S64 { sizeof(ImU64), "U64", "%I64u","%I64u" }, #else { sizeof(ImS64), "S64", "%lld", "%lld" }, // ImGuiDataType_S64 { sizeof(ImU64), "U64", "%llu", "%llu" }, #endif { sizeof(float), "float", "%.3f","%f" }, // ImGuiDataType_Float (float are promoted to double in va_arg) { sizeof(double), "double","%f", "%lf" }, // ImGuiDataType_Double { sizeof(bool), "bool", "%d", "%d" }, // ImGuiDataType_Bool { 0, "char*","%s", "%s" }, // ImGuiDataType_String }; IM_STATIC_ASSERT(IM_ARRAYSIZE(GDataTypeInfo) == ImGuiDataType_COUNT); const ImGuiDataTypeInfo* ImGui::DataTypeGetInfo(ImGuiDataType data_type) { IM_ASSERT(data_type >= 0 && data_type < ImGuiDataType_COUNT); return &GDataTypeInfo[data_type]; } int ImGui::DataTypeFormatString(char* buf, int buf_size, ImGuiDataType data_type, const void* p_data, const char* format) { // Signedness doesn't matter when pushing integer arguments if (data_type == ImGuiDataType_S32 || data_type == ImGuiDataType_U32) return ImFormatString(buf, buf_size, format, *(const ImU32*)p_data); if (data_type == ImGuiDataType_S64 || data_type == ImGuiDataType_U64) return ImFormatString(buf, buf_size, format, *(const ImU64*)p_data); if (data_type == ImGuiDataType_Float) return ImFormatString(buf, buf_size, format, *(const float*)p_data); if (data_type == ImGuiDataType_Double) return ImFormatString(buf, buf_size, format, *(const double*)p_data); if (data_type == ImGuiDataType_S8) return ImFormatString(buf, buf_size, format, *(const ImS8*)p_data); if (data_type == ImGuiDataType_U8) return ImFormatString(buf, buf_size, format, *(const ImU8*)p_data); if (data_type == ImGuiDataType_S16) return ImFormatString(buf, buf_size, format, *(const ImS16*)p_data); if (data_type == ImGuiDataType_U16) return ImFormatString(buf, buf_size, format, *(const ImU16*)p_data); IM_ASSERT(0); return 0; } void ImGui::DataTypeApplyOp(ImGuiDataType data_type, int op, void* output, const void* arg1, const void* arg2) { IM_ASSERT(op == '+' || op == '-'); switch (data_type) { case ImGuiDataType_S8: if (op == '+') { *(ImS8*)output = ImAddClampOverflow(*(const ImS8*)arg1, *(const ImS8*)arg2, IM_S8_MIN, IM_S8_MAX); } if (op == '-') { *(ImS8*)output = ImSubClampOverflow(*(const ImS8*)arg1, *(const ImS8*)arg2, IM_S8_MIN, IM_S8_MAX); } return; case ImGuiDataType_U8: if (op == '+') { *(ImU8*)output = ImAddClampOverflow(*(const ImU8*)arg1, *(const ImU8*)arg2, IM_U8_MIN, IM_U8_MAX); } if (op == '-') { *(ImU8*)output = ImSubClampOverflow(*(const ImU8*)arg1, *(const ImU8*)arg2, IM_U8_MIN, IM_U8_MAX); } return; case ImGuiDataType_S16: if (op == '+') { *(ImS16*)output = ImAddClampOverflow(*(const ImS16*)arg1, *(const ImS16*)arg2, IM_S16_MIN, IM_S16_MAX); } if (op == '-') { *(ImS16*)output = ImSubClampOverflow(*(const ImS16*)arg1, *(const ImS16*)arg2, IM_S16_MIN, IM_S16_MAX); } return; case ImGuiDataType_U16: if (op == '+') { *(ImU16*)output = ImAddClampOverflow(*(const ImU16*)arg1, *(const ImU16*)arg2, IM_U16_MIN, IM_U16_MAX); } if (op == '-') { *(ImU16*)output = ImSubClampOverflow(*(const ImU16*)arg1, *(const ImU16*)arg2, IM_U16_MIN, IM_U16_MAX); } return; case ImGuiDataType_S32: if (op == '+') { *(ImS32*)output = ImAddClampOverflow(*(const ImS32*)arg1, *(const ImS32*)arg2, IM_S32_MIN, IM_S32_MAX); } if (op == '-') { *(ImS32*)output = ImSubClampOverflow(*(const ImS32*)arg1, *(const ImS32*)arg2, IM_S32_MIN, IM_S32_MAX); } return; case ImGuiDataType_U32: if (op == '+') { *(ImU32*)output = ImAddClampOverflow(*(const ImU32*)arg1, *(const ImU32*)arg2, IM_U32_MIN, IM_U32_MAX); } if (op == '-') { *(ImU32*)output = ImSubClampOverflow(*(const ImU32*)arg1, *(const ImU32*)arg2, IM_U32_MIN, IM_U32_MAX); } return; case ImGuiDataType_S64: if (op == '+') { *(ImS64*)output = ImAddClampOverflow(*(const ImS64*)arg1, *(const ImS64*)arg2, IM_S64_MIN, IM_S64_MAX); } if (op == '-') { *(ImS64*)output = ImSubClampOverflow(*(const ImS64*)arg1, *(const ImS64*)arg2, IM_S64_MIN, IM_S64_MAX); } return; case ImGuiDataType_U64: if (op == '+') { *(ImU64*)output = ImAddClampOverflow(*(const ImU64*)arg1, *(const ImU64*)arg2, IM_U64_MIN, IM_U64_MAX); } if (op == '-') { *(ImU64*)output = ImSubClampOverflow(*(const ImU64*)arg1, *(const ImU64*)arg2, IM_U64_MIN, IM_U64_MAX); } return; case ImGuiDataType_Float: if (op == '+') { *(float*)output = *(const float*)arg1 + *(const float*)arg2; } if (op == '-') { *(float*)output = *(const float*)arg1 - *(const float*)arg2; } return; case ImGuiDataType_Double: if (op == '+') { *(double*)output = *(const double*)arg1 + *(const double*)arg2; } if (op == '-') { *(double*)output = *(const double*)arg1 - *(const double*)arg2; } return; case ImGuiDataType_COUNT: break; } IM_ASSERT(0); } // User can input math operators (e.g. +100) to edit a numerical values. // NB: This is _not_ a full expression evaluator. We should probably add one and replace this dumb mess.. bool ImGui::DataTypeApplyFromText(const char* buf, ImGuiDataType data_type, void* p_data, const char* format, void* p_data_when_empty) { // Copy the value in an opaque buffer so we can compare at the end of the function if it changed at all. const ImGuiDataTypeInfo* type_info = DataTypeGetInfo(data_type); ImGuiDataTypeStorage data_backup; memcpy(&data_backup, p_data, type_info->Size); while (ImCharIsBlankA(*buf)) buf++; if (!buf[0]) { if (p_data_when_empty != NULL) { memcpy(p_data, p_data_when_empty, type_info->Size); return memcmp(&data_backup, p_data, type_info->Size) != 0; } return false; } // Sanitize format // - For float/double we have to ignore format with precision (e.g. "%.2f") because sscanf doesn't take them in, so force them into %f and %lf // - In theory could treat empty format as using default, but this would only cover rare/bizarre case of using InputScalar() + integer + format string without %. char format_sanitized[32]; if (data_type == ImGuiDataType_Float || data_type == ImGuiDataType_Double) format = type_info->ScanFmt; else format = ImParseFormatSanitizeForScanning(format, format_sanitized, IM_ARRAYSIZE(format_sanitized)); // Small types need a 32-bit buffer to receive the result from scanf() int v32 = 0; if (sscanf(buf, format, type_info->Size >= 4 ? p_data : &v32) < 1) return false; if (type_info->Size < 4) { if (data_type == ImGuiDataType_S8) *(ImS8*)p_data = (ImS8)ImClamp(v32, (int)IM_S8_MIN, (int)IM_S8_MAX); else if (data_type == ImGuiDataType_U8) *(ImU8*)p_data = (ImU8)ImClamp(v32, (int)IM_U8_MIN, (int)IM_U8_MAX); else if (data_type == ImGuiDataType_S16) *(ImS16*)p_data = (ImS16)ImClamp(v32, (int)IM_S16_MIN, (int)IM_S16_MAX); else if (data_type == ImGuiDataType_U16) *(ImU16*)p_data = (ImU16)ImClamp(v32, (int)IM_U16_MIN, (int)IM_U16_MAX); else IM_ASSERT(0); } return memcmp(&data_backup, p_data, type_info->Size) != 0; } template static int DataTypeCompareT(const T* lhs, const T* rhs) { if (*lhs < *rhs) return -1; if (*lhs > *rhs) return +1; return 0; } int ImGui::DataTypeCompare(ImGuiDataType data_type, const void* arg_1, const void* arg_2) { switch (data_type) { case ImGuiDataType_S8: return DataTypeCompareT((const ImS8* )arg_1, (const ImS8* )arg_2); case ImGuiDataType_U8: return DataTypeCompareT((const ImU8* )arg_1, (const ImU8* )arg_2); case ImGuiDataType_S16: return DataTypeCompareT((const ImS16* )arg_1, (const ImS16* )arg_2); case ImGuiDataType_U16: return DataTypeCompareT((const ImU16* )arg_1, (const ImU16* )arg_2); case ImGuiDataType_S32: return DataTypeCompareT((const ImS32* )arg_1, (const ImS32* )arg_2); case ImGuiDataType_U32: return DataTypeCompareT((const ImU32* )arg_1, (const ImU32* )arg_2); case ImGuiDataType_S64: return DataTypeCompareT((const ImS64* )arg_1, (const ImS64* )arg_2); case ImGuiDataType_U64: return DataTypeCompareT((const ImU64* )arg_1, (const ImU64* )arg_2); case ImGuiDataType_Float: return DataTypeCompareT((const float* )arg_1, (const float* )arg_2); case ImGuiDataType_Double: return DataTypeCompareT((const double*)arg_1, (const double*)arg_2); case ImGuiDataType_COUNT: break; } IM_ASSERT(0); return 0; } template static bool DataTypeClampT(T* v, const T* v_min, const T* v_max) { // Clamp, both sides are optional, return true if modified if (v_min && *v < *v_min) { *v = *v_min; return true; } if (v_max && *v > *v_max) { *v = *v_max; return true; } return false; } bool ImGui::DataTypeClamp(ImGuiDataType data_type, void* p_data, const void* p_min, const void* p_max) { switch (data_type) { case ImGuiDataType_S8: return DataTypeClampT((ImS8* )p_data, (const ImS8* )p_min, (const ImS8* )p_max); case ImGuiDataType_U8: return DataTypeClampT((ImU8* )p_data, (const ImU8* )p_min, (const ImU8* )p_max); case ImGuiDataType_S16: return DataTypeClampT((ImS16* )p_data, (const ImS16* )p_min, (const ImS16* )p_max); case ImGuiDataType_U16: return DataTypeClampT((ImU16* )p_data, (const ImU16* )p_min, (const ImU16* )p_max); case ImGuiDataType_S32: return DataTypeClampT((ImS32* )p_data, (const ImS32* )p_min, (const ImS32* )p_max); case ImGuiDataType_U32: return DataTypeClampT((ImU32* )p_data, (const ImU32* )p_min, (const ImU32* )p_max); case ImGuiDataType_S64: return DataTypeClampT((ImS64* )p_data, (const ImS64* )p_min, (const ImS64* )p_max); case ImGuiDataType_U64: return DataTypeClampT((ImU64* )p_data, (const ImU64* )p_min, (const ImU64* )p_max); case ImGuiDataType_Float: return DataTypeClampT((float* )p_data, (const float* )p_min, (const float* )p_max); case ImGuiDataType_Double: return DataTypeClampT((double*)p_data, (const double*)p_min, (const double*)p_max); case ImGuiDataType_COUNT: break; } IM_ASSERT(0); return false; } bool ImGui::DataTypeIsZero(ImGuiDataType data_type, const void* p_data) { ImGuiContext& g = *GImGui; return DataTypeCompare(data_type, p_data, &g.DataTypeZeroValue) == 0; } static float GetMinimumStepAtDecimalPrecision(int decimal_precision) { static const float min_steps[10] = { 1.0f, 0.1f, 0.01f, 0.001f, 0.0001f, 0.00001f, 0.000001f, 0.0000001f, 0.00000001f, 0.000000001f }; if (decimal_precision < 0) return FLT_MIN; return (decimal_precision < IM_ARRAYSIZE(min_steps)) ? min_steps[decimal_precision] : ImPow(10.0f, (float)-decimal_precision); } template TYPE ImGui::RoundScalarWithFormatT(const char* format, ImGuiDataType data_type, TYPE v) { IM_UNUSED(data_type); IM_ASSERT(data_type == ImGuiDataType_Float || data_type == ImGuiDataType_Double); const char* fmt_start = ImParseFormatFindStart(format); if (fmt_start[0] != '%' || fmt_start[1] == '%') // Don't apply if the value is not visible in the format string return v; // Sanitize format char fmt_sanitized[32]; ImParseFormatSanitizeForPrinting(fmt_start, fmt_sanitized, IM_ARRAYSIZE(fmt_sanitized)); fmt_start = fmt_sanitized; // Format value with our rounding, and read back char v_str[64]; ImFormatString(v_str, IM_ARRAYSIZE(v_str), fmt_start, v); const char* p = v_str; while (*p == ' ') p++; v = (TYPE)ImAtof(p); return v; } //------------------------------------------------------------------------- // [SECTION] Widgets: DragScalar, DragFloat, DragInt, etc. //------------------------------------------------------------------------- // - DragBehaviorT<>() [Internal] // - DragBehavior() [Internal] // - DragScalar() // - DragScalarN() // - DragFloat() // - DragFloat2() // - DragFloat3() // - DragFloat4() // - DragFloatRange2() // - DragInt() // - DragInt2() // - DragInt3() // - DragInt4() // - DragIntRange2() //------------------------------------------------------------------------- // This is called by DragBehavior() when the widget is active (held by mouse or being manipulated with Nav controls) template bool ImGui::DragBehaviorT(ImGuiDataType data_type, TYPE* v, float v_speed, const TYPE v_min, const TYPE v_max, const char* format, ImGuiSliderFlags flags) { ImGuiContext& g = *GImGui; const ImGuiAxis axis = (flags & ImGuiSliderFlags_Vertical) ? ImGuiAxis_Y : ImGuiAxis_X; const bool is_bounded = (v_min < v_max) || ((v_min == v_max) && (v_min != 0.0f || (flags & ImGuiSliderFlags_ClampZeroRange))); const bool is_wrapped = is_bounded && (flags & ImGuiSliderFlags_WrapAround); const bool is_logarithmic = (flags & ImGuiSliderFlags_Logarithmic) != 0; const bool is_floating_point = (data_type == ImGuiDataType_Float) || (data_type == ImGuiDataType_Double); // Default tweak speed if (v_speed == 0.0f && is_bounded && (v_max - v_min < FLT_MAX)) v_speed = (float)((v_max - v_min) * g.DragSpeedDefaultRatio); // Inputs accumulates into g.DragCurrentAccum, which is flushed into the current value as soon as it makes a difference with our precision settings float adjust_delta = 0.0f; if (g.ActiveIdSource == ImGuiInputSource_Mouse && IsMousePosValid() && IsMouseDragPastThreshold(0, g.IO.MouseDragThreshold * DRAG_MOUSE_THRESHOLD_FACTOR)) { adjust_delta = g.IO.MouseDelta[axis]; if (g.IO.KeyAlt && !(flags & ImGuiSliderFlags_NoSpeedTweaks)) adjust_delta *= 1.0f / 100.0f; if (g.IO.KeyShift && !(flags & ImGuiSliderFlags_NoSpeedTweaks)) adjust_delta *= 10.0f; } else if (g.ActiveIdSource == ImGuiInputSource_Keyboard || g.ActiveIdSource == ImGuiInputSource_Gamepad) { const int decimal_precision = is_floating_point ? ImParseFormatPrecision(format, 3) : 0; const bool tweak_slow = IsKeyDown((g.NavInputSource == ImGuiInputSource_Gamepad) ? ImGuiKey_NavGamepadTweakSlow : ImGuiKey_NavKeyboardTweakSlow); const bool tweak_fast = IsKeyDown((g.NavInputSource == ImGuiInputSource_Gamepad) ? ImGuiKey_NavGamepadTweakFast : ImGuiKey_NavKeyboardTweakFast); const float tweak_factor = (flags & ImGuiSliderFlags_NoSpeedTweaks) ? 1.0f : tweak_slow ? 1.0f / 10.0f : tweak_fast ? 10.0f : 1.0f; adjust_delta = GetNavTweakPressedAmount(axis) * tweak_factor; v_speed = ImMax(v_speed, GetMinimumStepAtDecimalPrecision(decimal_precision)); } adjust_delta *= v_speed; // For vertical drag we currently assume that Up=higher value (like we do with vertical sliders). This may become a parameter. if (axis == ImGuiAxis_Y) adjust_delta = -adjust_delta; // For logarithmic use our range is effectively 0..1 so scale the delta into that range if (is_logarithmic && (v_max - v_min < FLT_MAX) && ((v_max - v_min) > 0.000001f)) // Epsilon to avoid /0 adjust_delta /= (float)(v_max - v_min); // Clear current value on activation // Avoid altering values and clamping when we are _already_ past the limits and heading in the same direction, so e.g. if range is 0..255, current value is 300 and we are pushing to the right side, keep the 300. const bool is_just_activated = g.ActiveIdIsJustActivated; const bool is_already_past_limits_and_pushing_outward = is_bounded && !is_wrapped && ((*v >= v_max && adjust_delta > 0.0f) || (*v <= v_min && adjust_delta < 0.0f)); if (is_just_activated || is_already_past_limits_and_pushing_outward) { g.DragCurrentAccum = 0.0f; g.DragCurrentAccumDirty = false; } else if (adjust_delta != 0.0f) { g.DragCurrentAccum += adjust_delta; g.DragCurrentAccumDirty = true; } if (!g.DragCurrentAccumDirty) return false; TYPE v_cur = *v; FLOATTYPE v_old_ref_for_accum_remainder = (FLOATTYPE)0.0f; float logarithmic_zero_epsilon = 0.0f; // Only valid when is_logarithmic is true const float zero_deadzone_halfsize = 0.0f; // Drag widgets have no deadzone (as it doesn't make sense) if (is_logarithmic) { // When using logarithmic sliders, we need to clamp to avoid hitting zero, but our choice of clamp value greatly affects slider precision. We attempt to use the specified precision to estimate a good lower bound. const int decimal_precision = is_floating_point ? ImParseFormatPrecision(format, 3) : 1; logarithmic_zero_epsilon = ImPow(0.1f, (float)decimal_precision); // Convert to parametric space, apply delta, convert back float v_old_parametric = ScaleRatioFromValueT(data_type, v_cur, v_min, v_max, is_logarithmic, logarithmic_zero_epsilon, zero_deadzone_halfsize); float v_new_parametric = v_old_parametric + g.DragCurrentAccum; v_cur = ScaleValueFromRatioT(data_type, v_new_parametric, v_min, v_max, is_logarithmic, logarithmic_zero_epsilon, zero_deadzone_halfsize); v_old_ref_for_accum_remainder = v_old_parametric; } else { v_cur += (SIGNEDTYPE)g.DragCurrentAccum; } // Round to user desired precision based on format string if (is_floating_point && !(flags & ImGuiSliderFlags_NoRoundToFormat)) v_cur = RoundScalarWithFormatT(format, data_type, v_cur); // Preserve remainder after rounding has been applied. This also allow slow tweaking of values. g.DragCurrentAccumDirty = false; if (is_logarithmic) { // Convert to parametric space, apply delta, convert back float v_new_parametric = ScaleRatioFromValueT(data_type, v_cur, v_min, v_max, is_logarithmic, logarithmic_zero_epsilon, zero_deadzone_halfsize); g.DragCurrentAccum -= (float)(v_new_parametric - v_old_ref_for_accum_remainder); } else { g.DragCurrentAccum -= (float)((SIGNEDTYPE)v_cur - (SIGNEDTYPE)*v); } // Lose zero sign for float/double if (v_cur == (TYPE)-0) v_cur = (TYPE)0; if (*v != v_cur && is_bounded) { if (is_wrapped) { // Wrap values if (v_cur < v_min) v_cur += v_max - v_min + (is_floating_point ? 0 : 1); if (v_cur > v_max) v_cur -= v_max - v_min + (is_floating_point ? 0 : 1); } else { // Clamp values + handle overflow/wrap-around for integer types. if (v_cur < v_min || (v_cur > *v && adjust_delta < 0.0f && !is_floating_point)) v_cur = v_min; if (v_cur > v_max || (v_cur < *v && adjust_delta > 0.0f && !is_floating_point)) v_cur = v_max; } } // Apply result if (*v == v_cur) return false; *v = v_cur; return true; } bool ImGui::DragBehavior(ImGuiID id, ImGuiDataType data_type, void* p_v, float v_speed, const void* p_min, const void* p_max, const char* format, ImGuiSliderFlags flags) { // Read imgui.cpp "API BREAKING CHANGES" section for 1.78 if you hit this assert. IM_ASSERT((flags == 1 || (flags & ImGuiSliderFlags_InvalidMask_) == 0) && "Invalid ImGuiSliderFlags flags! Has the legacy 'float power' argument been mistakenly cast to flags? Call function with ImGuiSliderFlags_Logarithmic flags instead."); ImGuiContext& g = *GImGui; if (g.ActiveId == id) { // Those are the things we can do easily outside the DragBehaviorT<> template, saves code generation. if (g.ActiveIdSource == ImGuiInputSource_Mouse && !g.IO.MouseDown[0]) ClearActiveID(); else if ((g.ActiveIdSource == ImGuiInputSource_Keyboard || g.ActiveIdSource == ImGuiInputSource_Gamepad) && g.NavActivatePressedId == id && !g.ActiveIdIsJustActivated) ClearActiveID(); } if (g.ActiveId != id) return false; if ((g.LastItemData.ItemFlags & ImGuiItemFlags_ReadOnly) || (flags & ImGuiSliderFlags_ReadOnly)) return false; switch (data_type) { case ImGuiDataType_S8: { ImS32 v32 = (ImS32)*(ImS8*)p_v; bool r = DragBehaviorT(ImGuiDataType_S32, &v32, v_speed, p_min ? *(const ImS8*) p_min : IM_S8_MIN, p_max ? *(const ImS8*)p_max : IM_S8_MAX, format, flags); if (r) *(ImS8*)p_v = (ImS8)v32; return r; } case ImGuiDataType_U8: { ImU32 v32 = (ImU32)*(ImU8*)p_v; bool r = DragBehaviorT(ImGuiDataType_U32, &v32, v_speed, p_min ? *(const ImU8*) p_min : IM_U8_MIN, p_max ? *(const ImU8*)p_max : IM_U8_MAX, format, flags); if (r) *(ImU8*)p_v = (ImU8)v32; return r; } case ImGuiDataType_S16: { ImS32 v32 = (ImS32)*(ImS16*)p_v; bool r = DragBehaviorT(ImGuiDataType_S32, &v32, v_speed, p_min ? *(const ImS16*)p_min : IM_S16_MIN, p_max ? *(const ImS16*)p_max : IM_S16_MAX, format, flags); if (r) *(ImS16*)p_v = (ImS16)v32; return r; } case ImGuiDataType_U16: { ImU32 v32 = (ImU32)*(ImU16*)p_v; bool r = DragBehaviorT(ImGuiDataType_U32, &v32, v_speed, p_min ? *(const ImU16*)p_min : IM_U16_MIN, p_max ? *(const ImU16*)p_max : IM_U16_MAX, format, flags); if (r) *(ImU16*)p_v = (ImU16)v32; return r; } case ImGuiDataType_S32: return DragBehaviorT(data_type, (ImS32*)p_v, v_speed, p_min ? *(const ImS32* )p_min : IM_S32_MIN, p_max ? *(const ImS32* )p_max : IM_S32_MAX, format, flags); case ImGuiDataType_U32: return DragBehaviorT(data_type, (ImU32*)p_v, v_speed, p_min ? *(const ImU32* )p_min : IM_U32_MIN, p_max ? *(const ImU32* )p_max : IM_U32_MAX, format, flags); case ImGuiDataType_S64: return DragBehaviorT(data_type, (ImS64*)p_v, v_speed, p_min ? *(const ImS64* )p_min : IM_S64_MIN, p_max ? *(const ImS64* )p_max : IM_S64_MAX, format, flags); case ImGuiDataType_U64: return DragBehaviorT(data_type, (ImU64*)p_v, v_speed, p_min ? *(const ImU64* )p_min : IM_U64_MIN, p_max ? *(const ImU64* )p_max : IM_U64_MAX, format, flags); case ImGuiDataType_Float: return DragBehaviorT(data_type, (float*)p_v, v_speed, p_min ? *(const float* )p_min : -FLT_MAX, p_max ? *(const float* )p_max : FLT_MAX, format, flags); case ImGuiDataType_Double: return DragBehaviorT(data_type, (double*)p_v, v_speed, p_min ? *(const double*)p_min : -DBL_MAX, p_max ? *(const double*)p_max : DBL_MAX, format, flags); case ImGuiDataType_COUNT: break; } IM_ASSERT(0); return false; } // Note: p_data, p_min and p_max are _pointers_ to a memory address holding the data. For a Drag widget, p_min and p_max are optional. // Read code of e.g. DragFloat(), DragInt() etc. or examples in 'Demo->Widgets->Data Types' to understand how to use this function directly. bool ImGui::DragScalar(const char* label, ImGuiDataType data_type, void* p_data, float v_speed, const void* p_min, const void* p_max, const char* format, ImGuiSliderFlags flags) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; ImGuiContext& g = *GImGui; const ImGuiStyle& style = g.Style; const ImGuiID id = window->GetID(label); const float w = CalcItemWidth(); const ImVec2 label_size = CalcTextSize(label, NULL, true); const ImRect frame_bb(window->DC.CursorPos, window->DC.CursorPos + ImVec2(w, label_size.y + style.FramePadding.y * 2.0f)); const ImRect total_bb(frame_bb.Min, frame_bb.Max + ImVec2(label_size.x > 0.0f ? style.ItemInnerSpacing.x + label_size.x : 0.0f, 0.0f)); const bool temp_input_allowed = (flags & ImGuiSliderFlags_NoInput) == 0; ItemSize(total_bb, style.FramePadding.y); if (!ItemAdd(total_bb, id, &frame_bb, temp_input_allowed ? ImGuiItemFlags_Inputable : 0)) return false; // Default format string when passing NULL if (format == NULL) format = DataTypeGetInfo(data_type)->PrintFmt; const bool hovered = ItemHoverable(frame_bb, id, g.LastItemData.ItemFlags); bool temp_input_is_active = temp_input_allowed && TempInputIsActive(id); if (!temp_input_is_active) { // Tabbing or CTRL+click on Drag turns it into an InputText const bool clicked = hovered && IsMouseClicked(0, ImGuiInputFlags_None, id); const bool double_clicked = (hovered && g.IO.MouseClickedCount[0] == 2 && TestKeyOwner(ImGuiKey_MouseLeft, id)); const bool make_active = (clicked || double_clicked || g.NavActivateId == id); if (make_active && (clicked || double_clicked)) SetKeyOwner(ImGuiKey_MouseLeft, id); if (make_active && temp_input_allowed) if ((clicked && g.IO.KeyCtrl) || double_clicked || (g.NavActivateId == id && (g.NavActivateFlags & ImGuiActivateFlags_PreferInput))) temp_input_is_active = true; // (Optional) simple click (without moving) turns Drag into an InputText if (g.IO.ConfigDragClickToInputText && temp_input_allowed && !temp_input_is_active) if (g.ActiveId == id && hovered && g.IO.MouseReleased[0] && !IsMouseDragPastThreshold(0, g.IO.MouseDragThreshold * DRAG_MOUSE_THRESHOLD_FACTOR)) { g.NavActivateId = id; g.NavActivateFlags = ImGuiActivateFlags_PreferInput; temp_input_is_active = true; } // Store initial value (not used by main lib but available as a convenience but some mods e.g. to revert) if (make_active) memcpy(&g.ActiveIdValueOnActivation, p_data, DataTypeGetInfo(data_type)->Size); if (make_active && !temp_input_is_active) { SetActiveID(id, window); SetFocusID(id, window); FocusWindow(window); g.ActiveIdUsingNavDirMask = (1 << ImGuiDir_Left) | (1 << ImGuiDir_Right); } } if (temp_input_is_active) { // Only clamp CTRL+Click input when ImGuiSliderFlags_ClampOnInput is set (generally via ImGuiSliderFlags_AlwaysClamp) bool clamp_enabled = false; if ((flags & ImGuiSliderFlags_ClampOnInput) && (p_min != NULL || p_max != NULL)) { const int clamp_range_dir = (p_min != NULL && p_max != NULL) ? DataTypeCompare(data_type, p_min, p_max) : 0; // -1 when *p_min < *p_max, == 0 when *p_min == *p_max if (p_min == NULL || p_max == NULL || clamp_range_dir < 0) clamp_enabled = true; else if (clamp_range_dir == 0) clamp_enabled = DataTypeIsZero(data_type, p_min) ? ((flags & ImGuiSliderFlags_ClampZeroRange) != 0) : true; } return TempInputScalar(frame_bb, id, label, data_type, p_data, format, clamp_enabled ? p_min : NULL, clamp_enabled ? p_max : NULL); } // Draw frame const ImU32 frame_col = GetColorU32(g.ActiveId == id ? ImGuiCol_FrameBgActive : hovered ? ImGuiCol_FrameBgHovered : ImGuiCol_FrameBg); RenderNavCursor(frame_bb, id); RenderFrame(frame_bb.Min, frame_bb.Max, frame_col, true, style.FrameRounding); // Drag behavior const bool value_changed = DragBehavior(id, data_type, p_data, v_speed, p_min, p_max, format, flags); if (value_changed) MarkItemEdited(id); // Display value using user-provided display format so user can add prefix/suffix/decorations to the value. char value_buf[64]; const char* value_buf_end = value_buf + DataTypeFormatString(value_buf, IM_ARRAYSIZE(value_buf), data_type, p_data, format); if (g.LogEnabled) LogSetNextTextDecoration("{", "}"); RenderTextClipped(frame_bb.Min, frame_bb.Max, value_buf, value_buf_end, NULL, ImVec2(0.5f, 0.5f)); if (label_size.x > 0.0f) RenderText(ImVec2(frame_bb.Max.x + style.ItemInnerSpacing.x, frame_bb.Min.y + style.FramePadding.y), label); IMGUI_TEST_ENGINE_ITEM_INFO(id, label, g.LastItemData.StatusFlags | (temp_input_allowed ? ImGuiItemStatusFlags_Inputable : 0)); return value_changed; } bool ImGui::DragScalarN(const char* label, ImGuiDataType data_type, void* p_data, int components, float v_speed, const void* p_min, const void* p_max, const char* format, ImGuiSliderFlags flags) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; ImGuiContext& g = *GImGui; bool value_changed = false; BeginGroup(); PushID(label); PushMultiItemsWidths(components, CalcItemWidth()); size_t type_size = GDataTypeInfo[data_type].Size; for (int i = 0; i < components; i++) { PushID(i); if (i > 0) SameLine(0, g.Style.ItemInnerSpacing.x); value_changed |= DragScalar("", data_type, p_data, v_speed, p_min, p_max, format, flags); PopID(); PopItemWidth(); p_data = (void*)((char*)p_data + type_size); } PopID(); const char* label_end = FindRenderedTextEnd(label); if (label != label_end) { SameLine(0, g.Style.ItemInnerSpacing.x); TextEx(label, label_end); } EndGroup(); return value_changed; } bool ImGui::DragFloat(const char* label, float* v, float v_speed, float v_min, float v_max, const char* format, ImGuiSliderFlags flags) { return DragScalar(label, ImGuiDataType_Float, v, v_speed, &v_min, &v_max, format, flags); } bool ImGui::DragFloat2(const char* label, float v[2], float v_speed, float v_min, float v_max, const char* format, ImGuiSliderFlags flags) { return DragScalarN(label, ImGuiDataType_Float, v, 2, v_speed, &v_min, &v_max, format, flags); } bool ImGui::DragFloat3(const char* label, float v[3], float v_speed, float v_min, float v_max, const char* format, ImGuiSliderFlags flags) { return DragScalarN(label, ImGuiDataType_Float, v, 3, v_speed, &v_min, &v_max, format, flags); } bool ImGui::DragFloat4(const char* label, float v[4], float v_speed, float v_min, float v_max, const char* format, ImGuiSliderFlags flags) { return DragScalarN(label, ImGuiDataType_Float, v, 4, v_speed, &v_min, &v_max, format, flags); } // NB: You likely want to specify the ImGuiSliderFlags_AlwaysClamp when using this. bool ImGui::DragFloatRange2(const char* label, float* v_current_min, float* v_current_max, float v_speed, float v_min, float v_max, const char* format, const char* format_max, ImGuiSliderFlags flags) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; ImGuiContext& g = *GImGui; PushID(label); BeginGroup(); PushMultiItemsWidths(2, CalcItemWidth()); float min_min = (v_min >= v_max) ? -FLT_MAX : v_min; float min_max = (v_min >= v_max) ? *v_current_max : ImMin(v_max, *v_current_max); ImGuiSliderFlags min_flags = flags | ((min_min == min_max) ? ImGuiSliderFlags_ReadOnly : 0); bool value_changed = DragScalar("##min", ImGuiDataType_Float, v_current_min, v_speed, &min_min, &min_max, format, min_flags); PopItemWidth(); SameLine(0, g.Style.ItemInnerSpacing.x); float max_min = (v_min >= v_max) ? *v_current_min : ImMax(v_min, *v_current_min); float max_max = (v_min >= v_max) ? FLT_MAX : v_max; ImGuiSliderFlags max_flags = flags | ((max_min == max_max) ? ImGuiSliderFlags_ReadOnly : 0); value_changed |= DragScalar("##max", ImGuiDataType_Float, v_current_max, v_speed, &max_min, &max_max, format_max ? format_max : format, max_flags); PopItemWidth(); SameLine(0, g.Style.ItemInnerSpacing.x); TextEx(label, FindRenderedTextEnd(label)); EndGroup(); PopID(); return value_changed; } // NB: v_speed is float to allow adjusting the drag speed with more precision bool ImGui::DragInt(const char* label, int* v, float v_speed, int v_min, int v_max, const char* format, ImGuiSliderFlags flags) { return DragScalar(label, ImGuiDataType_S32, v, v_speed, &v_min, &v_max, format, flags); } bool ImGui::DragInt2(const char* label, int v[2], float v_speed, int v_min, int v_max, const char* format, ImGuiSliderFlags flags) { return DragScalarN(label, ImGuiDataType_S32, v, 2, v_speed, &v_min, &v_max, format, flags); } bool ImGui::DragInt3(const char* label, int v[3], float v_speed, int v_min, int v_max, const char* format, ImGuiSliderFlags flags) { return DragScalarN(label, ImGuiDataType_S32, v, 3, v_speed, &v_min, &v_max, format, flags); } bool ImGui::DragInt4(const char* label, int v[4], float v_speed, int v_min, int v_max, const char* format, ImGuiSliderFlags flags) { return DragScalarN(label, ImGuiDataType_S32, v, 4, v_speed, &v_min, &v_max, format, flags); } // NB: You likely want to specify the ImGuiSliderFlags_AlwaysClamp when using this. bool ImGui::DragIntRange2(const char* label, int* v_current_min, int* v_current_max, float v_speed, int v_min, int v_max, const char* format, const char* format_max, ImGuiSliderFlags flags) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; ImGuiContext& g = *GImGui; PushID(label); BeginGroup(); PushMultiItemsWidths(2, CalcItemWidth()); int min_min = (v_min >= v_max) ? INT_MIN : v_min; int min_max = (v_min >= v_max) ? *v_current_max : ImMin(v_max, *v_current_max); ImGuiSliderFlags min_flags = flags | ((min_min == min_max) ? ImGuiSliderFlags_ReadOnly : 0); bool value_changed = DragInt("##min", v_current_min, v_speed, min_min, min_max, format, min_flags); PopItemWidth(); SameLine(0, g.Style.ItemInnerSpacing.x); int max_min = (v_min >= v_max) ? *v_current_min : ImMax(v_min, *v_current_min); int max_max = (v_min >= v_max) ? INT_MAX : v_max; ImGuiSliderFlags max_flags = flags | ((max_min == max_max) ? ImGuiSliderFlags_ReadOnly : 0); value_changed |= DragInt("##max", v_current_max, v_speed, max_min, max_max, format_max ? format_max : format, max_flags); PopItemWidth(); SameLine(0, g.Style.ItemInnerSpacing.x); TextEx(label, FindRenderedTextEnd(label)); EndGroup(); PopID(); return value_changed; } //------------------------------------------------------------------------- // [SECTION] Widgets: SliderScalar, SliderFloat, SliderInt, etc. //------------------------------------------------------------------------- // - ScaleRatioFromValueT<> [Internal] // - ScaleValueFromRatioT<> [Internal] // - SliderBehaviorT<>() [Internal] // - SliderBehavior() [Internal] // - SliderScalar() // - SliderScalarN() // - SliderFloat() // - SliderFloat2() // - SliderFloat3() // - SliderFloat4() // - SliderAngle() // - SliderInt() // - SliderInt2() // - SliderInt3() // - SliderInt4() // - VSliderScalar() // - VSliderFloat() // - VSliderInt() //------------------------------------------------------------------------- // Convert a value v in the output space of a slider into a parametric position on the slider itself (the logical opposite of ScaleValueFromRatioT) template float ImGui::ScaleRatioFromValueT(ImGuiDataType data_type, TYPE v, TYPE v_min, TYPE v_max, bool is_logarithmic, float logarithmic_zero_epsilon, float zero_deadzone_halfsize) { if (v_min == v_max) return 0.0f; IM_UNUSED(data_type); const TYPE v_clamped = (v_min < v_max) ? ImClamp(v, v_min, v_max) : ImClamp(v, v_max, v_min); if (is_logarithmic) { bool flipped = v_max < v_min; if (flipped) // Handle the case where the range is backwards ImSwap(v_min, v_max); // Fudge min/max to avoid getting close to log(0) FLOATTYPE v_min_fudged = (ImAbs((FLOATTYPE)v_min) < logarithmic_zero_epsilon) ? ((v_min < 0.0f) ? -logarithmic_zero_epsilon : logarithmic_zero_epsilon) : (FLOATTYPE)v_min; FLOATTYPE v_max_fudged = (ImAbs((FLOATTYPE)v_max) < logarithmic_zero_epsilon) ? ((v_max < 0.0f) ? -logarithmic_zero_epsilon : logarithmic_zero_epsilon) : (FLOATTYPE)v_max; // Awkward special cases - we need ranges of the form (-100 .. 0) to convert to (-100 .. -epsilon), not (-100 .. epsilon) if ((v_min == 0.0f) && (v_max < 0.0f)) v_min_fudged = -logarithmic_zero_epsilon; else if ((v_max == 0.0f) && (v_min < 0.0f)) v_max_fudged = -logarithmic_zero_epsilon; float result; if (v_clamped <= v_min_fudged) result = 0.0f; // Workaround for values that are in-range but below our fudge else if (v_clamped >= v_max_fudged) result = 1.0f; // Workaround for values that are in-range but above our fudge else if ((v_min * v_max) < 0.0f) // Range crosses zero, so split into two portions { float zero_point_center = (-(float)v_min) / ((float)v_max - (float)v_min); // The zero point in parametric space. There's an argument we should take the logarithmic nature into account when calculating this, but for now this should do (and the most common case of a symmetrical range works fine) float zero_point_snap_L = zero_point_center - zero_deadzone_halfsize; float zero_point_snap_R = zero_point_center + zero_deadzone_halfsize; if (v == 0.0f) result = zero_point_center; // Special case for exactly zero else if (v < 0.0f) result = (1.0f - (float)(ImLog(-(FLOATTYPE)v_clamped / logarithmic_zero_epsilon) / ImLog(-v_min_fudged / logarithmic_zero_epsilon))) * zero_point_snap_L; else result = zero_point_snap_R + ((float)(ImLog((FLOATTYPE)v_clamped / logarithmic_zero_epsilon) / ImLog(v_max_fudged / logarithmic_zero_epsilon)) * (1.0f - zero_point_snap_R)); } else if ((v_min < 0.0f) || (v_max < 0.0f)) // Entirely negative slider result = 1.0f - (float)(ImLog(-(FLOATTYPE)v_clamped / -v_max_fudged) / ImLog(-v_min_fudged / -v_max_fudged)); else result = (float)(ImLog((FLOATTYPE)v_clamped / v_min_fudged) / ImLog(v_max_fudged / v_min_fudged)); return flipped ? (1.0f - result) : result; } else { // Linear slider return (float)((FLOATTYPE)(SIGNEDTYPE)(v_clamped - v_min) / (FLOATTYPE)(SIGNEDTYPE)(v_max - v_min)); } } // Convert a parametric position on a slider into a value v in the output space (the logical opposite of ScaleRatioFromValueT) template TYPE ImGui::ScaleValueFromRatioT(ImGuiDataType data_type, float t, TYPE v_min, TYPE v_max, bool is_logarithmic, float logarithmic_zero_epsilon, float zero_deadzone_halfsize) { // We special-case the extents because otherwise our logarithmic fudging can lead to "mathematically correct" // but non-intuitive behaviors like a fully-left slider not actually reaching the minimum value. Also generally simpler. if (t <= 0.0f || v_min == v_max) return v_min; if (t >= 1.0f) return v_max; TYPE result = (TYPE)0; if (is_logarithmic) { // Fudge min/max to avoid getting silly results close to zero FLOATTYPE v_min_fudged = (ImAbs((FLOATTYPE)v_min) < logarithmic_zero_epsilon) ? ((v_min < 0.0f) ? -logarithmic_zero_epsilon : logarithmic_zero_epsilon) : (FLOATTYPE)v_min; FLOATTYPE v_max_fudged = (ImAbs((FLOATTYPE)v_max) < logarithmic_zero_epsilon) ? ((v_max < 0.0f) ? -logarithmic_zero_epsilon : logarithmic_zero_epsilon) : (FLOATTYPE)v_max; const bool flipped = v_max < v_min; // Check if range is "backwards" if (flipped) ImSwap(v_min_fudged, v_max_fudged); // Awkward special case - we need ranges of the form (-100 .. 0) to convert to (-100 .. -epsilon), not (-100 .. epsilon) if ((v_max == 0.0f) && (v_min < 0.0f)) v_max_fudged = -logarithmic_zero_epsilon; float t_with_flip = flipped ? (1.0f - t) : t; // t, but flipped if necessary to account for us flipping the range if ((v_min * v_max) < 0.0f) // Range crosses zero, so we have to do this in two parts { float zero_point_center = (-(float)ImMin(v_min, v_max)) / ImAbs((float)v_max - (float)v_min); // The zero point in parametric space float zero_point_snap_L = zero_point_center - zero_deadzone_halfsize; float zero_point_snap_R = zero_point_center + zero_deadzone_halfsize; if (t_with_flip >= zero_point_snap_L && t_with_flip <= zero_point_snap_R) result = (TYPE)0.0f; // Special case to make getting exactly zero possible (the epsilon prevents it otherwise) else if (t_with_flip < zero_point_center) result = (TYPE)-(logarithmic_zero_epsilon * ImPow(-v_min_fudged / logarithmic_zero_epsilon, (FLOATTYPE)(1.0f - (t_with_flip / zero_point_snap_L)))); else result = (TYPE)(logarithmic_zero_epsilon * ImPow(v_max_fudged / logarithmic_zero_epsilon, (FLOATTYPE)((t_with_flip - zero_point_snap_R) / (1.0f - zero_point_snap_R)))); } else if ((v_min < 0.0f) || (v_max < 0.0f)) // Entirely negative slider result = (TYPE)-(-v_max_fudged * ImPow(-v_min_fudged / -v_max_fudged, (FLOATTYPE)(1.0f - t_with_flip))); else result = (TYPE)(v_min_fudged * ImPow(v_max_fudged / v_min_fudged, (FLOATTYPE)t_with_flip)); } else { // Linear slider const bool is_floating_point = (data_type == ImGuiDataType_Float) || (data_type == ImGuiDataType_Double); if (is_floating_point) { result = ImLerp(v_min, v_max, t); } else if (t < 1.0) { // - For integer values we want the clicking position to match the grab box so we round above // This code is carefully tuned to work with large values (e.g. high ranges of U64) while preserving this property.. // - Not doing a *1.0 multiply at the end of a range as it tends to be lossy. While absolute aiming at a large s64/u64 // range is going to be imprecise anyway, with this check we at least make the edge values matches expected limits. FLOATTYPE v_new_off_f = (SIGNEDTYPE)(v_max - v_min) * t; result = (TYPE)((SIGNEDTYPE)v_min + (SIGNEDTYPE)(v_new_off_f + (FLOATTYPE)(v_min > v_max ? -0.5 : 0.5))); } } return result; } // FIXME: Try to move more of the code into shared SliderBehavior() template bool ImGui::SliderBehaviorT(const ImRect& bb, ImGuiID id, ImGuiDataType data_type, TYPE* v, const TYPE v_min, const TYPE v_max, const char* format, ImGuiSliderFlags flags, ImRect* out_grab_bb) { ImGuiContext& g = *GImGui; const ImGuiStyle& style = g.Style; const ImGuiAxis axis = (flags & ImGuiSliderFlags_Vertical) ? ImGuiAxis_Y : ImGuiAxis_X; const bool is_logarithmic = (flags & ImGuiSliderFlags_Logarithmic) != 0; const bool is_floating_point = (data_type == ImGuiDataType_Float) || (data_type == ImGuiDataType_Double); const float v_range_f = (float)(v_min < v_max ? v_max - v_min : v_min - v_max); // We don't need high precision for what we do with it. // Calculate bounds const float grab_padding = 2.0f; // FIXME: Should be part of style. const float slider_sz = (bb.Max[axis] - bb.Min[axis]) - grab_padding * 2.0f; float grab_sz = style.GrabMinSize; if (!is_floating_point && v_range_f >= 0.0f) // v_range_f < 0 may happen on integer overflows grab_sz = ImMax(slider_sz / (v_range_f + 1), style.GrabMinSize); // For integer sliders: if possible have the grab size represent 1 unit grab_sz = ImMin(grab_sz, slider_sz); const float slider_usable_sz = slider_sz - grab_sz; const float slider_usable_pos_min = bb.Min[axis] + grab_padding + grab_sz * 0.5f; const float slider_usable_pos_max = bb.Max[axis] - grab_padding - grab_sz * 0.5f; float logarithmic_zero_epsilon = 0.0f; // Only valid when is_logarithmic is true float zero_deadzone_halfsize = 0.0f; // Only valid when is_logarithmic is true if (is_logarithmic) { // When using logarithmic sliders, we need to clamp to avoid hitting zero, but our choice of clamp value greatly affects slider precision. We attempt to use the specified precision to estimate a good lower bound. const int decimal_precision = is_floating_point ? ImParseFormatPrecision(format, 3) : 1; logarithmic_zero_epsilon = ImPow(0.1f, (float)decimal_precision); zero_deadzone_halfsize = (style.LogSliderDeadzone * 0.5f) / ImMax(slider_usable_sz, 1.0f); } // Process interacting with the slider bool value_changed = false; if (g.ActiveId == id) { bool set_new_value = false; float clicked_t = 0.0f; if (g.ActiveIdSource == ImGuiInputSource_Mouse) { if (!g.IO.MouseDown[0]) { ClearActiveID(); } else { const float mouse_abs_pos = g.IO.MousePos[axis]; if (g.ActiveIdIsJustActivated) { float grab_t = ScaleRatioFromValueT(data_type, *v, v_min, v_max, is_logarithmic, logarithmic_zero_epsilon, zero_deadzone_halfsize); if (axis == ImGuiAxis_Y) grab_t = 1.0f - grab_t; const float grab_pos = ImLerp(slider_usable_pos_min, slider_usable_pos_max, grab_t); const bool clicked_around_grab = (mouse_abs_pos >= grab_pos - grab_sz * 0.5f - 1.0f) && (mouse_abs_pos <= grab_pos + grab_sz * 0.5f + 1.0f); // No harm being extra generous here. g.SliderGrabClickOffset = (clicked_around_grab && is_floating_point) ? mouse_abs_pos - grab_pos : 0.0f; } if (slider_usable_sz > 0.0f) clicked_t = ImSaturate((mouse_abs_pos - g.SliderGrabClickOffset - slider_usable_pos_min) / slider_usable_sz); if (axis == ImGuiAxis_Y) clicked_t = 1.0f - clicked_t; set_new_value = true; } } else if (g.ActiveIdSource == ImGuiInputSource_Keyboard || g.ActiveIdSource == ImGuiInputSource_Gamepad) { if (g.ActiveIdIsJustActivated) { g.SliderCurrentAccum = 0.0f; // Reset any stored nav delta upon activation g.SliderCurrentAccumDirty = false; } float input_delta = (axis == ImGuiAxis_X) ? GetNavTweakPressedAmount(axis) : -GetNavTweakPressedAmount(axis); if (input_delta != 0.0f) { const bool tweak_slow = IsKeyDown((g.NavInputSource == ImGuiInputSource_Gamepad) ? ImGuiKey_NavGamepadTweakSlow : ImGuiKey_NavKeyboardTweakSlow); const bool tweak_fast = IsKeyDown((g.NavInputSource == ImGuiInputSource_Gamepad) ? ImGuiKey_NavGamepadTweakFast : ImGuiKey_NavKeyboardTweakFast); const int decimal_precision = is_floating_point ? ImParseFormatPrecision(format, 3) : 0; if (decimal_precision > 0) { input_delta /= 100.0f; // Keyboard/Gamepad tweak speeds in % of slider bounds if (tweak_slow) input_delta /= 10.0f; } else { if ((v_range_f >= -100.0f && v_range_f <= 100.0f && v_range_f != 0.0f) || tweak_slow) input_delta = ((input_delta < 0.0f) ? -1.0f : +1.0f) / v_range_f; // Keyboard/Gamepad tweak speeds in integer steps else input_delta /= 100.0f; } if (tweak_fast) input_delta *= 10.0f; g.SliderCurrentAccum += input_delta; g.SliderCurrentAccumDirty = true; } float delta = g.SliderCurrentAccum; if (g.NavActivatePressedId == id && !g.ActiveIdIsJustActivated) { ClearActiveID(); } else if (g.SliderCurrentAccumDirty) { clicked_t = ScaleRatioFromValueT(data_type, *v, v_min, v_max, is_logarithmic, logarithmic_zero_epsilon, zero_deadzone_halfsize); if ((clicked_t >= 1.0f && delta > 0.0f) || (clicked_t <= 0.0f && delta < 0.0f)) // This is to avoid applying the saturation when already past the limits { set_new_value = false; g.SliderCurrentAccum = 0.0f; // If pushing up against the limits, don't continue to accumulate } else { set_new_value = true; float old_clicked_t = clicked_t; clicked_t = ImSaturate(clicked_t + delta); // Calculate what our "new" clicked_t will be, and thus how far we actually moved the slider, and subtract this from the accumulator TYPE v_new = ScaleValueFromRatioT(data_type, clicked_t, v_min, v_max, is_logarithmic, logarithmic_zero_epsilon, zero_deadzone_halfsize); if (is_floating_point && !(flags & ImGuiSliderFlags_NoRoundToFormat)) v_new = RoundScalarWithFormatT(format, data_type, v_new); float new_clicked_t = ScaleRatioFromValueT(data_type, v_new, v_min, v_max, is_logarithmic, logarithmic_zero_epsilon, zero_deadzone_halfsize); if (delta > 0) g.SliderCurrentAccum -= ImMin(new_clicked_t - old_clicked_t, delta); else g.SliderCurrentAccum -= ImMax(new_clicked_t - old_clicked_t, delta); } g.SliderCurrentAccumDirty = false; } } if (set_new_value) if ((g.LastItemData.ItemFlags & ImGuiItemFlags_ReadOnly) || (flags & ImGuiSliderFlags_ReadOnly)) set_new_value = false; if (set_new_value) { TYPE v_new = ScaleValueFromRatioT(data_type, clicked_t, v_min, v_max, is_logarithmic, logarithmic_zero_epsilon, zero_deadzone_halfsize); // Round to user desired precision based on format string if (is_floating_point && !(flags & ImGuiSliderFlags_NoRoundToFormat)) v_new = RoundScalarWithFormatT(format, data_type, v_new); // Apply result if (*v != v_new) { *v = v_new; value_changed = true; } } } if (slider_sz < 1.0f) { *out_grab_bb = ImRect(bb.Min, bb.Min); } else { // Output grab position so it can be displayed by the caller float grab_t = ScaleRatioFromValueT(data_type, *v, v_min, v_max, is_logarithmic, logarithmic_zero_epsilon, zero_deadzone_halfsize); if (axis == ImGuiAxis_Y) grab_t = 1.0f - grab_t; const float grab_pos = ImLerp(slider_usable_pos_min, slider_usable_pos_max, grab_t); if (axis == ImGuiAxis_X) *out_grab_bb = ImRect(grab_pos - grab_sz * 0.5f, bb.Min.y + grab_padding, grab_pos + grab_sz * 0.5f, bb.Max.y - grab_padding); else *out_grab_bb = ImRect(bb.Min.x + grab_padding, grab_pos - grab_sz * 0.5f, bb.Max.x - grab_padding, grab_pos + grab_sz * 0.5f); } return value_changed; } // For 32-bit and larger types, slider bounds are limited to half the natural type range. // So e.g. an integer Slider between INT_MAX-10 and INT_MAX will fail, but an integer Slider between INT_MAX/2-10 and INT_MAX/2 will be ok. // It would be possible to lift that limitation with some work but it doesn't seem to be worth it for sliders. bool ImGui::SliderBehavior(const ImRect& bb, ImGuiID id, ImGuiDataType data_type, void* p_v, const void* p_min, const void* p_max, const char* format, ImGuiSliderFlags flags, ImRect* out_grab_bb) { // Read imgui.cpp "API BREAKING CHANGES" section for 1.78 if you hit this assert. IM_ASSERT((flags == 1 || (flags & ImGuiSliderFlags_InvalidMask_) == 0) && "Invalid ImGuiSliderFlags flags! Has the legacy 'float power' argument been mistakenly cast to flags? Call function with ImGuiSliderFlags_Logarithmic flags instead."); IM_ASSERT((flags & ImGuiSliderFlags_WrapAround) == 0); // Not supported by SliderXXX(), only by DragXXX() switch (data_type) { case ImGuiDataType_S8: { ImS32 v32 = (ImS32)*(ImS8*)p_v; bool r = SliderBehaviorT(bb, id, ImGuiDataType_S32, &v32, *(const ImS8*)p_min, *(const ImS8*)p_max, format, flags, out_grab_bb); if (r) *(ImS8*)p_v = (ImS8)v32; return r; } case ImGuiDataType_U8: { ImU32 v32 = (ImU32)*(ImU8*)p_v; bool r = SliderBehaviorT(bb, id, ImGuiDataType_U32, &v32, *(const ImU8*)p_min, *(const ImU8*)p_max, format, flags, out_grab_bb); if (r) *(ImU8*)p_v = (ImU8)v32; return r; } case ImGuiDataType_S16: { ImS32 v32 = (ImS32)*(ImS16*)p_v; bool r = SliderBehaviorT(bb, id, ImGuiDataType_S32, &v32, *(const ImS16*)p_min, *(const ImS16*)p_max, format, flags, out_grab_bb); if (r) *(ImS16*)p_v = (ImS16)v32; return r; } case ImGuiDataType_U16: { ImU32 v32 = (ImU32)*(ImU16*)p_v; bool r = SliderBehaviorT(bb, id, ImGuiDataType_U32, &v32, *(const ImU16*)p_min, *(const ImU16*)p_max, format, flags, out_grab_bb); if (r) *(ImU16*)p_v = (ImU16)v32; return r; } case ImGuiDataType_S32: IM_ASSERT(*(const ImS32*)p_min >= IM_S32_MIN / 2 && *(const ImS32*)p_max <= IM_S32_MAX / 2); return SliderBehaviorT(bb, id, data_type, (ImS32*)p_v, *(const ImS32*)p_min, *(const ImS32*)p_max, format, flags, out_grab_bb); case ImGuiDataType_U32: IM_ASSERT(*(const ImU32*)p_max <= IM_U32_MAX / 2); return SliderBehaviorT(bb, id, data_type, (ImU32*)p_v, *(const ImU32*)p_min, *(const ImU32*)p_max, format, flags, out_grab_bb); case ImGuiDataType_S64: IM_ASSERT(*(const ImS64*)p_min >= IM_S64_MIN / 2 && *(const ImS64*)p_max <= IM_S64_MAX / 2); return SliderBehaviorT(bb, id, data_type, (ImS64*)p_v, *(const ImS64*)p_min, *(const ImS64*)p_max, format, flags, out_grab_bb); case ImGuiDataType_U64: IM_ASSERT(*(const ImU64*)p_max <= IM_U64_MAX / 2); return SliderBehaviorT(bb, id, data_type, (ImU64*)p_v, *(const ImU64*)p_min, *(const ImU64*)p_max, format, flags, out_grab_bb); case ImGuiDataType_Float: IM_ASSERT(*(const float*)p_min >= -FLT_MAX / 2.0f && *(const float*)p_max <= FLT_MAX / 2.0f); return SliderBehaviorT(bb, id, data_type, (float*)p_v, *(const float*)p_min, *(const float*)p_max, format, flags, out_grab_bb); case ImGuiDataType_Double: IM_ASSERT(*(const double*)p_min >= -DBL_MAX / 2.0f && *(const double*)p_max <= DBL_MAX / 2.0f); return SliderBehaviorT(bb, id, data_type, (double*)p_v, *(const double*)p_min, *(const double*)p_max, format, flags, out_grab_bb); case ImGuiDataType_COUNT: break; } IM_ASSERT(0); return false; } // Note: p_data, p_min and p_max are _pointers_ to a memory address holding the data. For a slider, they are all required. // Read code of e.g. SliderFloat(), SliderInt() etc. or examples in 'Demo->Widgets->Data Types' to understand how to use this function directly. bool ImGui::SliderScalar(const char* label, ImGuiDataType data_type, void* p_data, const void* p_min, const void* p_max, const char* format, ImGuiSliderFlags flags) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; ImGuiContext& g = *GImGui; const ImGuiStyle& style = g.Style; const ImGuiID id = window->GetID(label); const float w = CalcItemWidth(); const ImVec2 label_size = CalcTextSize(label, NULL, true); const ImRect frame_bb(window->DC.CursorPos, window->DC.CursorPos + ImVec2(w, label_size.y + style.FramePadding.y * 2.0f)); const ImRect total_bb(frame_bb.Min, frame_bb.Max + ImVec2(label_size.x > 0.0f ? style.ItemInnerSpacing.x + label_size.x : 0.0f, 0.0f)); const bool temp_input_allowed = (flags & ImGuiSliderFlags_NoInput) == 0; ItemSize(total_bb, style.FramePadding.y); if (!ItemAdd(total_bb, id, &frame_bb, temp_input_allowed ? ImGuiItemFlags_Inputable : 0)) return false; // Default format string when passing NULL if (format == NULL) format = DataTypeGetInfo(data_type)->PrintFmt; const bool hovered = ItemHoverable(frame_bb, id, g.LastItemData.ItemFlags); bool temp_input_is_active = temp_input_allowed && TempInputIsActive(id); if (!temp_input_is_active) { // Tabbing or CTRL+click on Slider turns it into an input box const bool clicked = hovered && IsMouseClicked(0, ImGuiInputFlags_None, id); const bool make_active = (clicked || g.NavActivateId == id); if (make_active && clicked) SetKeyOwner(ImGuiKey_MouseLeft, id); if (make_active && temp_input_allowed) if ((clicked && g.IO.KeyCtrl) || (g.NavActivateId == id && (g.NavActivateFlags & ImGuiActivateFlags_PreferInput))) temp_input_is_active = true; // Store initial value (not used by main lib but available as a convenience but some mods e.g. to revert) if (make_active) memcpy(&g.ActiveIdValueOnActivation, p_data, DataTypeGetInfo(data_type)->Size); if (make_active && !temp_input_is_active) { SetActiveID(id, window); SetFocusID(id, window); FocusWindow(window); g.ActiveIdUsingNavDirMask |= (1 << ImGuiDir_Left) | (1 << ImGuiDir_Right); } } if (temp_input_is_active) { // Only clamp CTRL+Click input when ImGuiSliderFlags_ClampOnInput is set (generally via ImGuiSliderFlags_AlwaysClamp) const bool clamp_enabled = (flags & ImGuiSliderFlags_ClampOnInput) != 0; return TempInputScalar(frame_bb, id, label, data_type, p_data, format, clamp_enabled ? p_min : NULL, clamp_enabled ? p_max : NULL); } // Draw frame const ImU32 frame_col = GetColorU32(g.ActiveId == id ? ImGuiCol_FrameBgActive : hovered ? ImGuiCol_FrameBgHovered : ImGuiCol_FrameBg); RenderNavCursor(frame_bb, id); RenderFrame(frame_bb.Min, frame_bb.Max, frame_col, true, g.Style.FrameRounding); // Slider behavior ImRect grab_bb; const bool value_changed = SliderBehavior(frame_bb, id, data_type, p_data, p_min, p_max, format, flags, &grab_bb); if (value_changed) MarkItemEdited(id); // Render grab if (grab_bb.Max.x > grab_bb.Min.x) window->DrawList->AddRectFilled(grab_bb.Min, grab_bb.Max, GetColorU32(g.ActiveId == id ? ImGuiCol_SliderGrabActive : ImGuiCol_SliderGrab), style.GrabRounding); // Display value using user-provided display format so user can add prefix/suffix/decorations to the value. char value_buf[64]; const char* value_buf_end = value_buf + DataTypeFormatString(value_buf, IM_ARRAYSIZE(value_buf), data_type, p_data, format); if (g.LogEnabled) LogSetNextTextDecoration("{", "}"); RenderTextClipped(frame_bb.Min, frame_bb.Max, value_buf, value_buf_end, NULL, ImVec2(0.5f, 0.5f)); if (label_size.x > 0.0f) RenderText(ImVec2(frame_bb.Max.x + style.ItemInnerSpacing.x, frame_bb.Min.y + style.FramePadding.y), label); IMGUI_TEST_ENGINE_ITEM_INFO(id, label, g.LastItemData.StatusFlags | (temp_input_allowed ? ImGuiItemStatusFlags_Inputable : 0)); return value_changed; } // Add multiple sliders on 1 line for compact edition of multiple components bool ImGui::SliderScalarN(const char* label, ImGuiDataType data_type, void* v, int components, const void* v_min, const void* v_max, const char* format, ImGuiSliderFlags flags) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; ImGuiContext& g = *GImGui; bool value_changed = false; BeginGroup(); PushID(label); PushMultiItemsWidths(components, CalcItemWidth()); size_t type_size = GDataTypeInfo[data_type].Size; for (int i = 0; i < components; i++) { PushID(i); if (i > 0) SameLine(0, g.Style.ItemInnerSpacing.x); value_changed |= SliderScalar("", data_type, v, v_min, v_max, format, flags); PopID(); PopItemWidth(); v = (void*)((char*)v + type_size); } PopID(); const char* label_end = FindRenderedTextEnd(label); if (label != label_end) { SameLine(0, g.Style.ItemInnerSpacing.x); TextEx(label, label_end); } EndGroup(); return value_changed; } bool ImGui::SliderFloat(const char* label, float* v, float v_min, float v_max, const char* format, ImGuiSliderFlags flags) { return SliderScalar(label, ImGuiDataType_Float, v, &v_min, &v_max, format, flags); } bool ImGui::SliderFloat2(const char* label, float v[2], float v_min, float v_max, const char* format, ImGuiSliderFlags flags) { return SliderScalarN(label, ImGuiDataType_Float, v, 2, &v_min, &v_max, format, flags); } bool ImGui::SliderFloat3(const char* label, float v[3], float v_min, float v_max, const char* format, ImGuiSliderFlags flags) { return SliderScalarN(label, ImGuiDataType_Float, v, 3, &v_min, &v_max, format, flags); } bool ImGui::SliderFloat4(const char* label, float v[4], float v_min, float v_max, const char* format, ImGuiSliderFlags flags) { return SliderScalarN(label, ImGuiDataType_Float, v, 4, &v_min, &v_max, format, flags); } bool ImGui::SliderAngle(const char* label, float* v_rad, float v_degrees_min, float v_degrees_max, const char* format, ImGuiSliderFlags flags) { if (format == NULL) format = "%.0f deg"; float v_deg = (*v_rad) * 360.0f / (2 * IM_PI); bool value_changed = SliderFloat(label, &v_deg, v_degrees_min, v_degrees_max, format, flags); if (value_changed) *v_rad = v_deg * (2 * IM_PI) / 360.0f; return value_changed; } bool ImGui::SliderInt(const char* label, int* v, int v_min, int v_max, const char* format, ImGuiSliderFlags flags) { return SliderScalar(label, ImGuiDataType_S32, v, &v_min, &v_max, format, flags); } bool ImGui::SliderInt2(const char* label, int v[2], int v_min, int v_max, const char* format, ImGuiSliderFlags flags) { return SliderScalarN(label, ImGuiDataType_S32, v, 2, &v_min, &v_max, format, flags); } bool ImGui::SliderInt3(const char* label, int v[3], int v_min, int v_max, const char* format, ImGuiSliderFlags flags) { return SliderScalarN(label, ImGuiDataType_S32, v, 3, &v_min, &v_max, format, flags); } bool ImGui::SliderInt4(const char* label, int v[4], int v_min, int v_max, const char* format, ImGuiSliderFlags flags) { return SliderScalarN(label, ImGuiDataType_S32, v, 4, &v_min, &v_max, format, flags); } bool ImGui::VSliderScalar(const char* label, const ImVec2& size, ImGuiDataType data_type, void* p_data, const void* p_min, const void* p_max, const char* format, ImGuiSliderFlags flags) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; ImGuiContext& g = *GImGui; const ImGuiStyle& style = g.Style; const ImGuiID id = window->GetID(label); const ImVec2 label_size = CalcTextSize(label, NULL, true); const ImRect frame_bb(window->DC.CursorPos, window->DC.CursorPos + size); const ImRect bb(frame_bb.Min, frame_bb.Max + ImVec2(label_size.x > 0.0f ? style.ItemInnerSpacing.x + label_size.x : 0.0f, 0.0f)); ItemSize(bb, style.FramePadding.y); if (!ItemAdd(frame_bb, id)) return false; // Default format string when passing NULL if (format == NULL) format = DataTypeGetInfo(data_type)->PrintFmt; const bool hovered = ItemHoverable(frame_bb, id, g.LastItemData.ItemFlags); const bool clicked = hovered && IsMouseClicked(0, ImGuiInputFlags_None, id); if (clicked || g.NavActivateId == id) { if (clicked) SetKeyOwner(ImGuiKey_MouseLeft, id); SetActiveID(id, window); SetFocusID(id, window); FocusWindow(window); g.ActiveIdUsingNavDirMask |= (1 << ImGuiDir_Up) | (1 << ImGuiDir_Down); } // Draw frame const ImU32 frame_col = GetColorU32(g.ActiveId == id ? ImGuiCol_FrameBgActive : hovered ? ImGuiCol_FrameBgHovered : ImGuiCol_FrameBg); RenderNavCursor(frame_bb, id); RenderFrame(frame_bb.Min, frame_bb.Max, frame_col, true, g.Style.FrameRounding); // Slider behavior ImRect grab_bb; const bool value_changed = SliderBehavior(frame_bb, id, data_type, p_data, p_min, p_max, format, flags | ImGuiSliderFlags_Vertical, &grab_bb); if (value_changed) MarkItemEdited(id); // Render grab if (grab_bb.Max.y > grab_bb.Min.y) window->DrawList->AddRectFilled(grab_bb.Min, grab_bb.Max, GetColorU32(g.ActiveId == id ? ImGuiCol_SliderGrabActive : ImGuiCol_SliderGrab), style.GrabRounding); // Display value using user-provided display format so user can add prefix/suffix/decorations to the value. // For the vertical slider we allow centered text to overlap the frame padding char value_buf[64]; const char* value_buf_end = value_buf + DataTypeFormatString(value_buf, IM_ARRAYSIZE(value_buf), data_type, p_data, format); RenderTextClipped(ImVec2(frame_bb.Min.x, frame_bb.Min.y + style.FramePadding.y), frame_bb.Max, value_buf, value_buf_end, NULL, ImVec2(0.5f, 0.0f)); if (label_size.x > 0.0f) RenderText(ImVec2(frame_bb.Max.x + style.ItemInnerSpacing.x, frame_bb.Min.y + style.FramePadding.y), label); return value_changed; } bool ImGui::VSliderFloat(const char* label, const ImVec2& size, float* v, float v_min, float v_max, const char* format, ImGuiSliderFlags flags) { return VSliderScalar(label, size, ImGuiDataType_Float, v, &v_min, &v_max, format, flags); } bool ImGui::VSliderInt(const char* label, const ImVec2& size, int* v, int v_min, int v_max, const char* format, ImGuiSliderFlags flags) { return VSliderScalar(label, size, ImGuiDataType_S32, v, &v_min, &v_max, format, flags); } //------------------------------------------------------------------------- // [SECTION] Widgets: InputScalar, InputFloat, InputInt, etc. //------------------------------------------------------------------------- // - ImParseFormatFindStart() [Internal] // - ImParseFormatFindEnd() [Internal] // - ImParseFormatTrimDecorations() [Internal] // - ImParseFormatSanitizeForPrinting() [Internal] // - ImParseFormatSanitizeForScanning() [Internal] // - ImParseFormatPrecision() [Internal] // - TempInputTextScalar() [Internal] // - InputScalar() // - InputScalarN() // - InputFloat() // - InputFloat2() // - InputFloat3() // - InputFloat4() // - InputInt() // - InputInt2() // - InputInt3() // - InputInt4() // - InputDouble() //------------------------------------------------------------------------- // We don't use strchr() because our strings are usually very short and often start with '%' const char* ImParseFormatFindStart(const char* fmt) { while (char c = fmt[0]) { if (c == '%' && fmt[1] != '%') return fmt; else if (c == '%') fmt++; fmt++; } return fmt; } const char* ImParseFormatFindEnd(const char* fmt) { // Printf/scanf types modifiers: I/L/h/j/l/t/w/z. Other uppercase letters qualify as types aka end of the format. if (fmt[0] != '%') return fmt; const unsigned int ignored_uppercase_mask = (1 << ('I'-'A')) | (1 << ('L'-'A')); const unsigned int ignored_lowercase_mask = (1 << ('h'-'a')) | (1 << ('j'-'a')) | (1 << ('l'-'a')) | (1 << ('t'-'a')) | (1 << ('w'-'a')) | (1 << ('z'-'a')); for (char c; (c = *fmt) != 0; fmt++) { if (c >= 'A' && c <= 'Z' && ((1 << (c - 'A')) & ignored_uppercase_mask) == 0) return fmt + 1; if (c >= 'a' && c <= 'z' && ((1 << (c - 'a')) & ignored_lowercase_mask) == 0) return fmt + 1; } return fmt; } // Extract the format out of a format string with leading or trailing decorations // fmt = "blah blah" -> return "" // fmt = "%.3f" -> return fmt // fmt = "hello %.3f" -> return fmt + 6 // fmt = "%.3f hello" -> return buf written with "%.3f" const char* ImParseFormatTrimDecorations(const char* fmt, char* buf, size_t buf_size) { const char* fmt_start = ImParseFormatFindStart(fmt); if (fmt_start[0] != '%') return ""; const char* fmt_end = ImParseFormatFindEnd(fmt_start); if (fmt_end[0] == 0) // If we only have leading decoration, we don't need to copy the data. return fmt_start; ImStrncpy(buf, fmt_start, ImMin((size_t)(fmt_end - fmt_start) + 1, buf_size)); return buf; } // Sanitize format // - Zero terminate so extra characters after format (e.g. "%f123") don't confuse atof/atoi // - stb_sprintf.h supports several new modifiers which format numbers in a way that also makes them incompatible atof/atoi. void ImParseFormatSanitizeForPrinting(const char* fmt_in, char* fmt_out, size_t fmt_out_size) { const char* fmt_end = ImParseFormatFindEnd(fmt_in); IM_UNUSED(fmt_out_size); IM_ASSERT((size_t)(fmt_end - fmt_in + 1) < fmt_out_size); // Format is too long, let us know if this happens to you! while (fmt_in < fmt_end) { char c = *fmt_in++; if (c != '\'' && c != '$' && c != '_') // Custom flags provided by stb_sprintf.h. POSIX 2008 also supports '. *(fmt_out++) = c; } *fmt_out = 0; // Zero-terminate } // - For scanning we need to remove all width and precision fields and flags "%+3.7f" -> "%f". BUT don't strip types like "%I64d" which includes digits. ! "%07I64d" -> "%I64d" const char* ImParseFormatSanitizeForScanning(const char* fmt_in, char* fmt_out, size_t fmt_out_size) { const char* fmt_end = ImParseFormatFindEnd(fmt_in); const char* fmt_out_begin = fmt_out; IM_UNUSED(fmt_out_size); IM_ASSERT((size_t)(fmt_end - fmt_in + 1) < fmt_out_size); // Format is too long, let us know if this happens to you! bool has_type = false; while (fmt_in < fmt_end) { char c = *fmt_in++; if (!has_type && ((c >= '0' && c <= '9') || c == '.' || c == '+' || c == '#')) continue; has_type |= ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')); // Stop skipping digits if (c != '\'' && c != '$' && c != '_') // Custom flags provided by stb_sprintf.h. POSIX 2008 also supports '. *(fmt_out++) = c; } *fmt_out = 0; // Zero-terminate return fmt_out_begin; } template static const char* ImAtoi(const char* src, TYPE* output) { int negative = 0; if (*src == '-') { negative = 1; src++; } if (*src == '+') { src++; } TYPE v = 0; while (*src >= '0' && *src <= '9') v = (v * 10) + (*src++ - '0'); *output = negative ? -v : v; return src; } // Parse display precision back from the display format string // FIXME: This is still used by some navigation code path to infer a minimum tweak step, but we should aim to rework widgets so it isn't needed. int ImParseFormatPrecision(const char* fmt, int default_precision) { fmt = ImParseFormatFindStart(fmt); if (fmt[0] != '%') return default_precision; fmt++; while (*fmt >= '0' && *fmt <= '9') fmt++; int precision = INT_MAX; if (*fmt == '.') { fmt = ImAtoi(fmt + 1, &precision); if (precision < 0 || precision > 99) precision = default_precision; } if (*fmt == 'e' || *fmt == 'E') // Maximum precision with scientific notation precision = -1; if ((*fmt == 'g' || *fmt == 'G') && precision == INT_MAX) precision = -1; return (precision == INT_MAX) ? default_precision : precision; } // Create text input in place of another active widget (e.g. used when doing a CTRL+Click on drag/slider widgets) // FIXME: Facilitate using this in variety of other situations. // FIXME: Among other things, setting ImGuiItemFlags_AllowDuplicateId in LastItemData is currently correct but // the expected relationship between TempInputXXX functions and LastItemData is a little fishy. bool ImGui::TempInputText(const ImRect& bb, ImGuiID id, const char* label, char* buf, int buf_size, ImGuiInputTextFlags flags) { // On the first frame, g.TempInputTextId == 0, then on subsequent frames it becomes == id. // We clear ActiveID on the first frame to allow the InputText() taking it back. ImGuiContext& g = *GImGui; const bool init = (g.TempInputId != id); if (init) ClearActiveID(); g.CurrentWindow->DC.CursorPos = bb.Min; g.LastItemData.ItemFlags |= ImGuiItemFlags_AllowDuplicateId; bool value_changed = InputTextEx(label, NULL, buf, buf_size, bb.GetSize(), flags | ImGuiInputTextFlags_MergedItem); if (init) { // First frame we started displaying the InputText widget, we expect it to take the active id. IM_ASSERT(g.ActiveId == id); g.TempInputId = g.ActiveId; } return value_changed; } // Note that Drag/Slider functions are only forwarding the min/max values clamping values if the ImGuiSliderFlags_AlwaysClamp flag is set! // This is intended: this way we allow CTRL+Click manual input to set a value out of bounds, for maximum flexibility. // However this may not be ideal for all uses, as some user code may break on out of bound values. bool ImGui::TempInputScalar(const ImRect& bb, ImGuiID id, const char* label, ImGuiDataType data_type, void* p_data, const char* format, const void* p_clamp_min, const void* p_clamp_max) { // FIXME: May need to clarify display behavior if format doesn't contain %. // "%d" -> "%d" / "There are %d items" -> "%d" / "items" -> "%d" (fallback). Also see #6405 ImGuiContext& g = *GImGui; const ImGuiDataTypeInfo* type_info = DataTypeGetInfo(data_type); char fmt_buf[32]; char data_buf[32]; format = ImParseFormatTrimDecorations(format, fmt_buf, IM_ARRAYSIZE(fmt_buf)); if (format[0] == 0) format = type_info->PrintFmt; DataTypeFormatString(data_buf, IM_ARRAYSIZE(data_buf), data_type, p_data, format); ImStrTrimBlanks(data_buf); ImGuiInputTextFlags flags = ImGuiInputTextFlags_AutoSelectAll | (ImGuiInputTextFlags)ImGuiInputTextFlags_LocalizeDecimalPoint; g.LastItemData.ItemFlags |= ImGuiItemFlags_NoMarkEdited; // Because TempInputText() uses ImGuiInputTextFlags_MergedItem it doesn't submit a new item, so we poke LastItemData. bool value_changed = false; if (TempInputText(bb, id, label, data_buf, IM_ARRAYSIZE(data_buf), flags)) { // Backup old value size_t data_type_size = type_info->Size; ImGuiDataTypeStorage data_backup; memcpy(&data_backup, p_data, data_type_size); // Apply new value (or operations) then clamp DataTypeApplyFromText(data_buf, data_type, p_data, format, NULL); if (p_clamp_min || p_clamp_max) { if (p_clamp_min && p_clamp_max && DataTypeCompare(data_type, p_clamp_min, p_clamp_max) > 0) ImSwap(p_clamp_min, p_clamp_max); DataTypeClamp(data_type, p_data, p_clamp_min, p_clamp_max); } // Only mark as edited if new value is different g.LastItemData.ItemFlags &= ~ImGuiItemFlags_NoMarkEdited; value_changed = memcmp(&data_backup, p_data, data_type_size) != 0; if (value_changed) MarkItemEdited(id); } return value_changed; } void ImGui::SetNextItemRefVal(ImGuiDataType data_type, void* p_data) { ImGuiContext& g = *GImGui; g.NextItemData.HasFlags |= ImGuiNextItemDataFlags_HasRefVal; memcpy(&g.NextItemData.RefVal, p_data, DataTypeGetInfo(data_type)->Size); } // Note: p_data, p_step, p_step_fast are _pointers_ to a memory address holding the data. For an Input widget, p_step and p_step_fast are optional. // Read code of e.g. InputFloat(), InputInt() etc. or examples in 'Demo->Widgets->Data Types' to understand how to use this function directly. bool ImGui::InputScalar(const char* label, ImGuiDataType data_type, void* p_data, const void* p_step, const void* p_step_fast, const char* format, ImGuiInputTextFlags flags) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; ImGuiContext& g = *GImGui; ImGuiStyle& style = g.Style; IM_ASSERT((flags & ImGuiInputTextFlags_EnterReturnsTrue) == 0); // Not supported by InputScalar(). Please open an issue if you this would be useful to you. Otherwise use IsItemDeactivatedAfterEdit()! if (format == NULL) format = DataTypeGetInfo(data_type)->PrintFmt; void* p_data_default = (g.NextItemData.HasFlags & ImGuiNextItemDataFlags_HasRefVal) ? &g.NextItemData.RefVal : &g.DataTypeZeroValue; char buf[64]; if ((flags & ImGuiInputTextFlags_DisplayEmptyRefVal) && DataTypeCompare(data_type, p_data, p_data_default) == 0) buf[0] = 0; else DataTypeFormatString(buf, IM_ARRAYSIZE(buf), data_type, p_data, format); // Disable the MarkItemEdited() call in InputText but keep ImGuiItemStatusFlags_Edited. // We call MarkItemEdited() ourselves by comparing the actual data rather than the string. g.NextItemData.ItemFlags |= ImGuiItemFlags_NoMarkEdited; flags |= ImGuiInputTextFlags_AutoSelectAll | (ImGuiInputTextFlags)ImGuiInputTextFlags_LocalizeDecimalPoint; bool value_changed = false; if (p_step == NULL) { if (InputText(label, buf, IM_ARRAYSIZE(buf), flags)) value_changed = DataTypeApplyFromText(buf, data_type, p_data, format, (flags & ImGuiInputTextFlags_ParseEmptyRefVal) ? p_data_default : NULL); } else { const float button_size = GetFrameHeight(); BeginGroup(); // The only purpose of the group here is to allow the caller to query item data e.g. IsItemActive() PushID(label); SetNextItemWidth(ImMax(1.0f, CalcItemWidth() - (button_size + style.ItemInnerSpacing.x) * 2)); if (InputText("", buf, IM_ARRAYSIZE(buf), flags)) // PushId(label) + "" gives us the expected ID from outside point of view value_changed = DataTypeApplyFromText(buf, data_type, p_data, format, (flags & ImGuiInputTextFlags_ParseEmptyRefVal) ? p_data_default : NULL); IMGUI_TEST_ENGINE_ITEM_INFO(g.LastItemData.ID, label, g.LastItemData.StatusFlags | ImGuiItemStatusFlags_Inputable); // Step buttons const ImVec2 backup_frame_padding = style.FramePadding; style.FramePadding.x = style.FramePadding.y; if (flags & ImGuiInputTextFlags_ReadOnly) BeginDisabled(); PushItemFlag(ImGuiItemFlags_ButtonRepeat, true); SameLine(0, style.ItemInnerSpacing.x); if (ButtonEx("-", ImVec2(button_size, button_size))) { DataTypeApplyOp(data_type, '-', p_data, p_data, g.IO.KeyCtrl && p_step_fast ? p_step_fast : p_step); value_changed = true; } SameLine(0, style.ItemInnerSpacing.x); if (ButtonEx("+", ImVec2(button_size, button_size))) { DataTypeApplyOp(data_type, '+', p_data, p_data, g.IO.KeyCtrl && p_step_fast ? p_step_fast : p_step); value_changed = true; } PopItemFlag(); if (flags & ImGuiInputTextFlags_ReadOnly) EndDisabled(); const char* label_end = FindRenderedTextEnd(label); if (label != label_end) { SameLine(0, style.ItemInnerSpacing.x); TextEx(label, label_end); } style.FramePadding = backup_frame_padding; PopID(); EndGroup(); } g.LastItemData.ItemFlags &= ~ImGuiItemFlags_NoMarkEdited; if (value_changed) MarkItemEdited(g.LastItemData.ID); return value_changed; } bool ImGui::InputScalarN(const char* label, ImGuiDataType data_type, void* p_data, int components, const void* p_step, const void* p_step_fast, const char* format, ImGuiInputTextFlags flags) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; ImGuiContext& g = *GImGui; bool value_changed = false; BeginGroup(); PushID(label); PushMultiItemsWidths(components, CalcItemWidth()); size_t type_size = GDataTypeInfo[data_type].Size; for (int i = 0; i < components; i++) { PushID(i); if (i > 0) SameLine(0, g.Style.ItemInnerSpacing.x); value_changed |= InputScalar("", data_type, p_data, p_step, p_step_fast, format, flags); PopID(); PopItemWidth(); p_data = (void*)((char*)p_data + type_size); } PopID(); const char* label_end = FindRenderedTextEnd(label); if (label != label_end) { SameLine(0.0f, g.Style.ItemInnerSpacing.x); TextEx(label, label_end); } EndGroup(); return value_changed; } bool ImGui::InputFloat(const char* label, float* v, float step, float step_fast, const char* format, ImGuiInputTextFlags flags) { return InputScalar(label, ImGuiDataType_Float, (void*)v, (void*)(step > 0.0f ? &step : NULL), (void*)(step_fast > 0.0f ? &step_fast : NULL), format, flags); } bool ImGui::InputFloat2(const char* label, float v[2], const char* format, ImGuiInputTextFlags flags) { return InputScalarN(label, ImGuiDataType_Float, v, 2, NULL, NULL, format, flags); } bool ImGui::InputFloat3(const char* label, float v[3], const char* format, ImGuiInputTextFlags flags) { return InputScalarN(label, ImGuiDataType_Float, v, 3, NULL, NULL, format, flags); } bool ImGui::InputFloat4(const char* label, float v[4], const char* format, ImGuiInputTextFlags flags) { return InputScalarN(label, ImGuiDataType_Float, v, 4, NULL, NULL, format, flags); } bool ImGui::InputInt(const char* label, int* v, int step, int step_fast, ImGuiInputTextFlags flags) { // Hexadecimal input provided as a convenience but the flag name is awkward. Typically you'd use InputText() to parse your own data, if you want to handle prefixes. const char* format = (flags & ImGuiInputTextFlags_CharsHexadecimal) ? "%08X" : "%d"; return InputScalar(label, ImGuiDataType_S32, (void*)v, (void*)(step > 0 ? &step : NULL), (void*)(step_fast > 0 ? &step_fast : NULL), format, flags); } bool ImGui::InputInt2(const char* label, int v[2], ImGuiInputTextFlags flags) { return InputScalarN(label, ImGuiDataType_S32, v, 2, NULL, NULL, "%d", flags); } bool ImGui::InputInt3(const char* label, int v[3], ImGuiInputTextFlags flags) { return InputScalarN(label, ImGuiDataType_S32, v, 3, NULL, NULL, "%d", flags); } bool ImGui::InputInt4(const char* label, int v[4], ImGuiInputTextFlags flags) { return InputScalarN(label, ImGuiDataType_S32, v, 4, NULL, NULL, "%d", flags); } bool ImGui::InputDouble(const char* label, double* v, double step, double step_fast, const char* format, ImGuiInputTextFlags flags) { return InputScalar(label, ImGuiDataType_Double, (void*)v, (void*)(step > 0.0 ? &step : NULL), (void*)(step_fast > 0.0 ? &step_fast : NULL), format, flags); } //------------------------------------------------------------------------- // [SECTION] Widgets: InputText, InputTextMultiline, InputTextWithHint //------------------------------------------------------------------------- // - imstb_textedit.h include // - InputText() // - InputTextWithHint() // - InputTextMultiline() // - InputTextGetCharInfo() [Internal] // - InputTextReindexLines() [Internal] // - InputTextReindexLinesRange() [Internal] // - InputTextEx() [Internal] // - DebugNodeInputTextState() [Internal] //------------------------------------------------------------------------- namespace ImStb { #include "imstb_textedit.h" } bool ImGui::InputText(const char* label, char* buf, size_t buf_size, ImGuiInputTextFlags flags, ImGuiInputTextCallback callback, void* user_data) { IM_ASSERT(!(flags & ImGuiInputTextFlags_Multiline)); // call InputTextMultiline() return InputTextEx(label, NULL, buf, (int)buf_size, ImVec2(0, 0), flags, callback, user_data); } bool ImGui::InputTextMultiline(const char* label, char* buf, size_t buf_size, const ImVec2& size, ImGuiInputTextFlags flags, ImGuiInputTextCallback callback, void* user_data) { return InputTextEx(label, NULL, buf, (int)buf_size, size, flags | ImGuiInputTextFlags_Multiline, callback, user_data); } bool ImGui::InputTextWithHint(const char* label, const char* hint, char* buf, size_t buf_size, ImGuiInputTextFlags flags, ImGuiInputTextCallback callback, void* user_data) { IM_ASSERT(!(flags & ImGuiInputTextFlags_Multiline)); // call InputTextMultiline() or InputTextEx() manually if you need multi-line + hint. return InputTextEx(label, hint, buf, (int)buf_size, ImVec2(0, 0), flags, callback, user_data); } // This is only used in the path where the multiline widget is inactivate. static int InputTextCalcTextLenAndLineCount(const char* text_begin, const char** out_text_end) { int line_count = 0; const char* s = text_begin; while (true) { const char* s_eol = strchr(s, '\n'); line_count++; if (s_eol == NULL) { s = s + ImStrlen(s); break; } s = s_eol + 1; } *out_text_end = s; return line_count; } // FIXME: Ideally we'd share code with ImFont::CalcTextSizeA() static ImVec2 InputTextCalcTextSize(ImGuiContext* ctx, const char* text_begin, const char* text_end, const char** remaining, ImVec2* out_offset, bool stop_on_new_line) { ImGuiContext& g = *ctx; ImFont* font = g.Font; const float line_height = g.FontSize; const float scale = line_height / font->FontSize; ImVec2 text_size = ImVec2(0, 0); float line_width = 0.0f; const char* s = text_begin; while (s < text_end) { unsigned int c = (unsigned int)*s; if (c < 0x80) s += 1; else s += ImTextCharFromUtf8(&c, s, text_end); if (c == '\n') { text_size.x = ImMax(text_size.x, line_width); text_size.y += line_height; line_width = 0.0f; if (stop_on_new_line) break; continue; } if (c == '\r') continue; const float char_width = ((int)c < font->IndexAdvanceX.Size ? font->IndexAdvanceX.Data[c] : font->FallbackAdvanceX) * scale; line_width += char_width; } if (text_size.x < line_width) text_size.x = line_width; if (out_offset) *out_offset = ImVec2(line_width, text_size.y + line_height); // offset allow for the possibility of sitting after a trailing \n if (line_width > 0 || text_size.y == 0.0f) // whereas size.y will ignore the trailing \n text_size.y += line_height; if (remaining) *remaining = s; return text_size; } // Wrapper for stb_textedit.h to edit text (our wrapper is for: statically sized buffer, single-line, wchar characters. InputText converts between UTF-8 and wchar) // With our UTF-8 use of stb_textedit: // - STB_TEXTEDIT_GETCHAR is nothing more than a a "GETBYTE". It's only used to compare to ascii or to copy blocks of text so we are fine. // - One exception is the STB_TEXTEDIT_IS_SPACE feature which would expect a full char in order to handle full-width space such as 0x3000 (see ImCharIsBlankW). // - ...but we don't use that feature. namespace ImStb { static int STB_TEXTEDIT_STRINGLEN(const ImGuiInputTextState* obj) { return obj->TextLen; } static char STB_TEXTEDIT_GETCHAR(const ImGuiInputTextState* obj, int idx) { IM_ASSERT(idx <= obj->TextLen); return obj->TextSrc[idx]; } static float STB_TEXTEDIT_GETWIDTH(ImGuiInputTextState* obj, int line_start_idx, int char_idx) { unsigned int c; ImTextCharFromUtf8(&c, obj->TextSrc + line_start_idx + char_idx, obj->TextSrc + obj->TextLen); if ((ImWchar)c == '\n') return IMSTB_TEXTEDIT_GETWIDTH_NEWLINE; ImGuiContext& g = *obj->Ctx; return g.Font->GetCharAdvance((ImWchar)c) * g.FontScale; } static char STB_TEXTEDIT_NEWLINE = '\n'; static void STB_TEXTEDIT_LAYOUTROW(StbTexteditRow* r, ImGuiInputTextState* obj, int line_start_idx) { const char* text = obj->TextSrc; const char* text_remaining = NULL; const ImVec2 size = InputTextCalcTextSize(obj->Ctx, text + line_start_idx, text + obj->TextLen, &text_remaining, NULL, true); r->x0 = 0.0f; r->x1 = size.x; r->baseline_y_delta = size.y; r->ymin = 0.0f; r->ymax = size.y; r->num_chars = (int)(text_remaining - (text + line_start_idx)); } #define IMSTB_TEXTEDIT_GETNEXTCHARINDEX IMSTB_TEXTEDIT_GETNEXTCHARINDEX_IMPL #define IMSTB_TEXTEDIT_GETPREVCHARINDEX IMSTB_TEXTEDIT_GETPREVCHARINDEX_IMPL static int IMSTB_TEXTEDIT_GETNEXTCHARINDEX_IMPL(ImGuiInputTextState* obj, int idx) { if (idx >= obj->TextLen) return obj->TextLen + 1; unsigned int c; return idx + ImTextCharFromUtf8(&c, obj->TextSrc + idx, obj->TextSrc + obj->TextLen); } static int IMSTB_TEXTEDIT_GETPREVCHARINDEX_IMPL(ImGuiInputTextState* obj, int idx) { if (idx <= 0) return -1; const char* p = ImTextFindPreviousUtf8Codepoint(obj->TextSrc, obj->TextSrc + idx); return (int)(p - obj->TextSrc); } static bool ImCharIsSeparatorW(unsigned int c) { static const unsigned int separator_list[] = { ',', 0x3001, '.', 0x3002, ';', 0xFF1B, '(', 0xFF08, ')', 0xFF09, '{', 0xFF5B, '}', 0xFF5D, '[', 0x300C, ']', 0x300D, '|', 0xFF5C, '!', 0xFF01, '\\', 0xFFE5, '/', 0x30FB, 0xFF0F, '\n', '\r', }; for (unsigned int separator : separator_list) if (c == separator) return true; return false; } static int is_word_boundary_from_right(ImGuiInputTextState* obj, int idx) { // When ImGuiInputTextFlags_Password is set, we don't want actions such as CTRL+Arrow to leak the fact that underlying data are blanks or separators. if ((obj->Flags & ImGuiInputTextFlags_Password) || idx <= 0) return 0; const char* curr_p = obj->TextSrc + idx; const char* prev_p = ImTextFindPreviousUtf8Codepoint(obj->TextSrc, curr_p); unsigned int curr_c; ImTextCharFromUtf8(&curr_c, curr_p, obj->TextSrc + obj->TextLen); unsigned int prev_c; ImTextCharFromUtf8(&prev_c, prev_p, obj->TextSrc + obj->TextLen); bool prev_white = ImCharIsBlankW(prev_c); bool prev_separ = ImCharIsSeparatorW(prev_c); bool curr_white = ImCharIsBlankW(curr_c); bool curr_separ = ImCharIsSeparatorW(curr_c); return ((prev_white || prev_separ) && !(curr_separ || curr_white)) || (curr_separ && !prev_separ); } static int is_word_boundary_from_left(ImGuiInputTextState* obj, int idx) { if ((obj->Flags & ImGuiInputTextFlags_Password) || idx <= 0) return 0; const char* curr_p = obj->TextSrc + idx; const char* prev_p = ImTextFindPreviousUtf8Codepoint(obj->TextSrc, curr_p); unsigned int prev_c; ImTextCharFromUtf8(&prev_c, curr_p, obj->TextSrc + obj->TextLen); unsigned int curr_c; ImTextCharFromUtf8(&curr_c, prev_p, obj->TextSrc + obj->TextLen); bool prev_white = ImCharIsBlankW(prev_c); bool prev_separ = ImCharIsSeparatorW(prev_c); bool curr_white = ImCharIsBlankW(curr_c); bool curr_separ = ImCharIsSeparatorW(curr_c); return ((prev_white) && !(curr_separ || curr_white)) || (curr_separ && !prev_separ); } static int STB_TEXTEDIT_MOVEWORDLEFT_IMPL(ImGuiInputTextState* obj, int idx) { idx = IMSTB_TEXTEDIT_GETPREVCHARINDEX(obj, idx); while (idx >= 0 && !is_word_boundary_from_right(obj, idx)) idx = IMSTB_TEXTEDIT_GETPREVCHARINDEX(obj, idx); return idx < 0 ? 0 : idx; } static int STB_TEXTEDIT_MOVEWORDRIGHT_MAC(ImGuiInputTextState* obj, int idx) { int len = obj->TextLen; idx = IMSTB_TEXTEDIT_GETNEXTCHARINDEX(obj, idx); while (idx < len && !is_word_boundary_from_left(obj, idx)) idx = IMSTB_TEXTEDIT_GETNEXTCHARINDEX(obj, idx); return idx > len ? len : idx; } static int STB_TEXTEDIT_MOVEWORDRIGHT_WIN(ImGuiInputTextState* obj, int idx) { idx = IMSTB_TEXTEDIT_GETNEXTCHARINDEX(obj, idx); int len = obj->TextLen; while (idx < len && !is_word_boundary_from_right(obj, idx)) idx = IMSTB_TEXTEDIT_GETNEXTCHARINDEX(obj, idx); return idx > len ? len : idx; } static int STB_TEXTEDIT_MOVEWORDRIGHT_IMPL(ImGuiInputTextState* obj, int idx) { ImGuiContext& g = *obj->Ctx; if (g.IO.ConfigMacOSXBehaviors) return STB_TEXTEDIT_MOVEWORDRIGHT_MAC(obj, idx); else return STB_TEXTEDIT_MOVEWORDRIGHT_WIN(obj, idx); } #define STB_TEXTEDIT_MOVEWORDLEFT STB_TEXTEDIT_MOVEWORDLEFT_IMPL // They need to be #define for stb_textedit.h #define STB_TEXTEDIT_MOVEWORDRIGHT STB_TEXTEDIT_MOVEWORDRIGHT_IMPL static void STB_TEXTEDIT_DELETECHARS(ImGuiInputTextState* obj, int pos, int n) { // Offset remaining text (+ copy zero terminator) IM_ASSERT(obj->TextSrc == obj->TextA.Data); char* dst = obj->TextA.Data + pos; char* src = obj->TextA.Data + pos + n; memmove(dst, src, obj->TextLen - n - pos + 1); obj->Edited = true; obj->TextLen -= n; } static bool STB_TEXTEDIT_INSERTCHARS(ImGuiInputTextState* obj, int pos, const char* new_text, int new_text_len) { const bool is_resizable = (obj->Flags & ImGuiInputTextFlags_CallbackResize) != 0; const int text_len = obj->TextLen; IM_ASSERT(pos <= text_len); if (!is_resizable && (new_text_len + obj->TextLen + 1 > obj->BufCapacity)) return false; // Grow internal buffer if needed IM_ASSERT(obj->TextSrc == obj->TextA.Data); if (new_text_len + text_len + 1 > obj->TextA.Size) { if (!is_resizable) return false; obj->TextA.resize(text_len + ImClamp(new_text_len, 32, ImMax(256, new_text_len)) + 1); obj->TextSrc = obj->TextA.Data; } char* text = obj->TextA.Data; if (pos != text_len) memmove(text + pos + new_text_len, text + pos, (size_t)(text_len - pos)); memcpy(text + pos, new_text, (size_t)new_text_len); obj->Edited = true; obj->TextLen += new_text_len; obj->TextA[obj->TextLen] = '\0'; return true; } // We don't use an enum so we can build even with conflicting symbols (if another user of stb_textedit.h leak their STB_TEXTEDIT_K_* symbols) #define STB_TEXTEDIT_K_LEFT 0x200000 // keyboard input to move cursor left #define STB_TEXTEDIT_K_RIGHT 0x200001 // keyboard input to move cursor right #define STB_TEXTEDIT_K_UP 0x200002 // keyboard input to move cursor up #define STB_TEXTEDIT_K_DOWN 0x200003 // keyboard input to move cursor down #define STB_TEXTEDIT_K_LINESTART 0x200004 // keyboard input to move cursor to start of line #define STB_TEXTEDIT_K_LINEEND 0x200005 // keyboard input to move cursor to end of line #define STB_TEXTEDIT_K_TEXTSTART 0x200006 // keyboard input to move cursor to start of text #define STB_TEXTEDIT_K_TEXTEND 0x200007 // keyboard input to move cursor to end of text #define STB_TEXTEDIT_K_DELETE 0x200008 // keyboard input to delete selection or character under cursor #define STB_TEXTEDIT_K_BACKSPACE 0x200009 // keyboard input to delete selection or character left of cursor #define STB_TEXTEDIT_K_UNDO 0x20000A // keyboard input to perform undo #define STB_TEXTEDIT_K_REDO 0x20000B // keyboard input to perform redo #define STB_TEXTEDIT_K_WORDLEFT 0x20000C // keyboard input to move cursor left one word #define STB_TEXTEDIT_K_WORDRIGHT 0x20000D // keyboard input to move cursor right one word #define STB_TEXTEDIT_K_PGUP 0x20000E // keyboard input to move cursor up a page #define STB_TEXTEDIT_K_PGDOWN 0x20000F // keyboard input to move cursor down a page #define STB_TEXTEDIT_K_SHIFT 0x400000 #define IMSTB_TEXTEDIT_IMPLEMENTATION #define IMSTB_TEXTEDIT_memmove memmove #include "imstb_textedit.h" // stb_textedit internally allows for a single undo record to do addition and deletion, but somehow, calling // the stb_textedit_paste() function creates two separate records, so we perform it manually. (FIXME: Report to nothings/stb?) static void stb_textedit_replace(ImGuiInputTextState* str, STB_TexteditState* state, const IMSTB_TEXTEDIT_CHARTYPE* text, int text_len) { stb_text_makeundo_replace(str, state, 0, str->TextLen, text_len); ImStb::STB_TEXTEDIT_DELETECHARS(str, 0, str->TextLen); state->cursor = state->select_start = state->select_end = 0; if (text_len <= 0) return; if (ImStb::STB_TEXTEDIT_INSERTCHARS(str, 0, text, text_len)) { state->cursor = state->select_start = state->select_end = text_len; state->has_preferred_x = 0; return; } IM_ASSERT(0); // Failed to insert character, normally shouldn't happen because of how we currently use stb_textedit_replace() } } // namespace ImStb // We added an extra indirection where 'Stb' is heap-allocated, in order facilitate the work of bindings generators. ImGuiInputTextState::ImGuiInputTextState() { memset(this, 0, sizeof(*this)); Stb = IM_NEW(ImStbTexteditState); memset(Stb, 0, sizeof(*Stb)); } ImGuiInputTextState::~ImGuiInputTextState() { IM_DELETE(Stb); } void ImGuiInputTextState::OnKeyPressed(int key) { stb_textedit_key(this, Stb, key); CursorFollow = true; CursorAnimReset(); } void ImGuiInputTextState::OnCharPressed(unsigned int c) { // Convert the key to a UTF8 byte sequence. // The changes we had to make to stb_textedit_key made it very much UTF-8 specific which is not too great. char utf8[5]; ImTextCharToUtf8(utf8, c); stb_textedit_text(this, Stb, utf8, (int)ImStrlen(utf8)); CursorFollow = true; CursorAnimReset(); } // Those functions are not inlined in imgui_internal.h, allowing us to hide ImStbTexteditState from that header. void ImGuiInputTextState::CursorAnimReset() { CursorAnim = -0.30f; } // After a user-input the cursor stays on for a while without blinking void ImGuiInputTextState::CursorClamp() { Stb->cursor = ImMin(Stb->cursor, TextLen); Stb->select_start = ImMin(Stb->select_start, TextLen); Stb->select_end = ImMin(Stb->select_end, TextLen); } bool ImGuiInputTextState::HasSelection() const { return Stb->select_start != Stb->select_end; } void ImGuiInputTextState::ClearSelection() { Stb->select_start = Stb->select_end = Stb->cursor; } int ImGuiInputTextState::GetCursorPos() const { return Stb->cursor; } int ImGuiInputTextState::GetSelectionStart() const { return Stb->select_start; } int ImGuiInputTextState::GetSelectionEnd() const { return Stb->select_end; } void ImGuiInputTextState::SelectAll() { Stb->select_start = 0; Stb->cursor = Stb->select_end = TextLen; Stb->has_preferred_x = 0; } void ImGuiInputTextState::ReloadUserBufAndSelectAll() { WantReloadUserBuf = true; ReloadSelectionStart = 0; ReloadSelectionEnd = INT_MAX; } void ImGuiInputTextState::ReloadUserBufAndKeepSelection() { WantReloadUserBuf = true; ReloadSelectionStart = Stb->select_start; ReloadSelectionEnd = Stb->select_end; } void ImGuiInputTextState::ReloadUserBufAndMoveToEnd() { WantReloadUserBuf = true; ReloadSelectionStart = ReloadSelectionEnd = INT_MAX; } ImGuiInputTextCallbackData::ImGuiInputTextCallbackData() { memset(this, 0, sizeof(*this)); } // Public API to manipulate UTF-8 text from within a callback. // FIXME: The existence of this rarely exercised code path is a bit of a nuisance. // Historically they existed because STB_TEXTEDIT_INSERTCHARS() etc. worked on our ImWchar // buffer, but nowadays they both work on UTF-8 data. Should aim to merge both. void ImGuiInputTextCallbackData::DeleteChars(int pos, int bytes_count) { IM_ASSERT(pos + bytes_count <= BufTextLen); char* dst = Buf + pos; const char* src = Buf + pos + bytes_count; memmove(dst, src, BufTextLen - bytes_count - pos + 1); if (CursorPos >= pos + bytes_count) CursorPos -= bytes_count; else if (CursorPos >= pos) CursorPos = pos; SelectionStart = SelectionEnd = CursorPos; BufDirty = true; BufTextLen -= bytes_count; } void ImGuiInputTextCallbackData::InsertChars(int pos, const char* new_text, const char* new_text_end) { // Accept null ranges if (new_text == new_text_end) return; // Grow internal buffer if needed const bool is_resizable = (Flags & ImGuiInputTextFlags_CallbackResize) != 0; const int new_text_len = new_text_end ? (int)(new_text_end - new_text) : (int)ImStrlen(new_text); if (new_text_len + BufTextLen >= BufSize) { if (!is_resizable) return; ImGuiContext& g = *Ctx; ImGuiInputTextState* edit_state = &g.InputTextState; IM_ASSERT(edit_state->ID != 0 && g.ActiveId == edit_state->ID); IM_ASSERT(Buf == edit_state->TextA.Data); int new_buf_size = BufTextLen + ImClamp(new_text_len * 4, 32, ImMax(256, new_text_len)) + 1; edit_state->TextA.resize(new_buf_size + 1); edit_state->TextSrc = edit_state->TextA.Data; Buf = edit_state->TextA.Data; BufSize = edit_state->BufCapacity = new_buf_size; } if (BufTextLen != pos) memmove(Buf + pos + new_text_len, Buf + pos, (size_t)(BufTextLen - pos)); memcpy(Buf + pos, new_text, (size_t)new_text_len * sizeof(char)); Buf[BufTextLen + new_text_len] = '\0'; if (CursorPos >= pos) CursorPos += new_text_len; SelectionStart = SelectionEnd = CursorPos; BufDirty = true; BufTextLen += new_text_len; } void ImGui::PushPasswordFont() { ImGuiContext& g = *GImGui; ImFont* in_font = g.Font; ImFont* out_font = &g.InputTextPasswordFont; ImFontGlyph* glyph = in_font->FindGlyph('*'); out_font->FontSize = in_font->FontSize; out_font->Scale = in_font->Scale; out_font->Ascent = in_font->Ascent; out_font->Descent = in_font->Descent; out_font->ContainerAtlas = in_font->ContainerAtlas; out_font->FallbackGlyph = glyph; out_font->FallbackAdvanceX = glyph->AdvanceX; IM_ASSERT(out_font->Glyphs.Size == 0 && out_font->IndexAdvanceX.Size == 0 && out_font->IndexLookup.Size == 0); PushFont(out_font); } // Return false to discard a character. static bool InputTextFilterCharacter(ImGuiContext* ctx, unsigned int* p_char, ImGuiInputTextFlags flags, ImGuiInputTextCallback callback, void* user_data, bool input_source_is_clipboard) { unsigned int c = *p_char; // Filter non-printable (NB: isprint is unreliable! see #2467) bool apply_named_filters = true; if (c < 0x20) { bool pass = false; pass |= (c == '\n') && (flags & ImGuiInputTextFlags_Multiline) != 0; // Note that an Enter KEY will emit \r and be ignored (we poll for KEY in InputText() code) if (c == '\n' && input_source_is_clipboard && (flags & ImGuiInputTextFlags_Multiline) == 0) // In single line mode, replace \n with a space { c = *p_char = ' '; pass = true; } pass |= (c == '\n') && (flags & ImGuiInputTextFlags_Multiline) != 0; pass |= (c == '\t') && (flags & ImGuiInputTextFlags_AllowTabInput) != 0; if (!pass) return false; apply_named_filters = false; // Override named filters below so newline and tabs can still be inserted. } if (input_source_is_clipboard == false) { // We ignore Ascii representation of delete (emitted from Backspace on OSX, see #2578, #2817) if (c == 127) return false; // Filter private Unicode range. GLFW on OSX seems to send private characters for special keys like arrow keys (FIXME) if (c >= 0xE000 && c <= 0xF8FF) return false; } // Filter Unicode ranges we are not handling in this build if (c > IM_UNICODE_CODEPOINT_MAX) return false; // Generic named filters if (apply_named_filters && (flags & (ImGuiInputTextFlags_CharsDecimal | ImGuiInputTextFlags_CharsHexadecimal | ImGuiInputTextFlags_CharsUppercase | ImGuiInputTextFlags_CharsNoBlank | ImGuiInputTextFlags_CharsScientific | (ImGuiInputTextFlags)ImGuiInputTextFlags_LocalizeDecimalPoint))) { // The libc allows overriding locale, with e.g. 'setlocale(LC_NUMERIC, "de_DE.UTF-8");' which affect the output/input of printf/scanf to use e.g. ',' instead of '.'. // The standard mandate that programs starts in the "C" locale where the decimal point is '.'. // We don't really intend to provide widespread support for it, but out of empathy for people stuck with using odd API, we support the bare minimum aka overriding the decimal point. // Change the default decimal_point with: // ImGui::GetPlatformIO()->Platform_LocaleDecimalPoint = *localeconv()->decimal_point; // Users of non-default decimal point (in particular ',') may be affected by word-selection logic (is_word_boundary_from_right/is_word_boundary_from_left) functions. ImGuiContext& g = *ctx; const unsigned c_decimal_point = (unsigned int)g.PlatformIO.Platform_LocaleDecimalPoint; if (flags & (ImGuiInputTextFlags_CharsDecimal | ImGuiInputTextFlags_CharsScientific | (ImGuiInputTextFlags)ImGuiInputTextFlags_LocalizeDecimalPoint)) if (c == '.' || c == ',') c = c_decimal_point; // Full-width -> half-width conversion for numeric fields (https://en.wikipedia.org/wiki/Halfwidth_and_Fullwidth_Forms_(Unicode_block) // While this is mostly convenient, this has the side-effect for uninformed users accidentally inputting full-width characters that they may // scratch their head as to why it works in numerical fields vs in generic text fields it would require support in the font. if (flags & (ImGuiInputTextFlags_CharsDecimal | ImGuiInputTextFlags_CharsScientific | ImGuiInputTextFlags_CharsHexadecimal)) if (c >= 0xFF01 && c <= 0xFF5E) c = c - 0xFF01 + 0x21; // Allow 0-9 . - + * / if (flags & ImGuiInputTextFlags_CharsDecimal) if (!(c >= '0' && c <= '9') && (c != c_decimal_point) && (c != '-') && (c != '+') && (c != '*') && (c != '/')) return false; // Allow 0-9 . - + * / e E if (flags & ImGuiInputTextFlags_CharsScientific) if (!(c >= '0' && c <= '9') && (c != c_decimal_point) && (c != '-') && (c != '+') && (c != '*') && (c != '/') && (c != 'e') && (c != 'E')) return false; // Allow 0-9 a-F A-F if (flags & ImGuiInputTextFlags_CharsHexadecimal) if (!(c >= '0' && c <= '9') && !(c >= 'a' && c <= 'f') && !(c >= 'A' && c <= 'F')) return false; // Turn a-z into A-Z if (flags & ImGuiInputTextFlags_CharsUppercase) if (c >= 'a' && c <= 'z') c += (unsigned int)('A' - 'a'); if (flags & ImGuiInputTextFlags_CharsNoBlank) if (ImCharIsBlankW(c)) return false; *p_char = c; } // Custom callback filter if (flags & ImGuiInputTextFlags_CallbackCharFilter) { ImGuiContext& g = *GImGui; ImGuiInputTextCallbackData callback_data; callback_data.Ctx = &g; callback_data.EventFlag = ImGuiInputTextFlags_CallbackCharFilter; callback_data.EventChar = (ImWchar)c; callback_data.Flags = flags; callback_data.UserData = user_data; if (callback(&callback_data) != 0) return false; *p_char = callback_data.EventChar; if (!callback_data.EventChar) return false; } return true; } // Find the shortest single replacement we can make to get from old_buf to new_buf // Note that this doesn't directly alter state->TextA, state->TextLen. They are expected to be made valid separately. // FIXME: Ideally we should transition toward (1) making InsertChars()/DeleteChars() update undo-stack (2) discourage (and keep reconcile) or obsolete (and remove reconcile) accessing buffer directly. static void InputTextReconcileUndoState(ImGuiInputTextState* state, const char* old_buf, int old_length, const char* new_buf, int new_length) { const int shorter_length = ImMin(old_length, new_length); int first_diff; for (first_diff = 0; first_diff < shorter_length; first_diff++) if (old_buf[first_diff] != new_buf[first_diff]) break; if (first_diff == old_length && first_diff == new_length) return; int old_last_diff = old_length - 1; int new_last_diff = new_length - 1; for (; old_last_diff >= first_diff && new_last_diff >= first_diff; old_last_diff--, new_last_diff--) if (old_buf[old_last_diff] != new_buf[new_last_diff]) break; const int insert_len = new_last_diff - first_diff + 1; const int delete_len = old_last_diff - first_diff + 1; if (insert_len > 0 || delete_len > 0) if (IMSTB_TEXTEDIT_CHARTYPE* p = stb_text_createundo(&state->Stb->undostate, first_diff, delete_len, insert_len)) for (int i = 0; i < delete_len; i++) p[i] = old_buf[first_diff + i]; } // As InputText() retain textual data and we currently provide a path for user to not retain it (via local variables) // we need some form of hook to reapply data back to user buffer on deactivation frame. (#4714) // It would be more desirable that we discourage users from taking advantage of the "user not retaining data" trick, // but that more likely be attractive when we do have _NoLiveEdit flag available. void ImGui::InputTextDeactivateHook(ImGuiID id) { ImGuiContext& g = *GImGui; ImGuiInputTextState* state = &g.InputTextState; if (id == 0 || state->ID != id) return; g.InputTextDeactivatedState.ID = state->ID; if (state->Flags & ImGuiInputTextFlags_ReadOnly) { g.InputTextDeactivatedState.TextA.resize(0); // In theory this data won't be used, but clear to be neat. } else { IM_ASSERT(state->TextA.Data != 0); IM_ASSERT(state->TextA[state->TextLen] == 0); g.InputTextDeactivatedState.TextA.resize(state->TextLen + 1); memcpy(g.InputTextDeactivatedState.TextA.Data, state->TextA.Data, state->TextLen + 1); } } // Edit a string of text // - buf_size account for the zero-terminator, so a buf_size of 6 can hold "Hello" but not "Hello!". // This is so we can easily call InputText() on static arrays using ARRAYSIZE() and to match // Note that in std::string world, capacity() would omit 1 byte used by the zero-terminator. // - When active, hold on a privately held copy of the text (and apply back to 'buf'). So changing 'buf' while the InputText is active has no effect. // - If you want to use ImGui::InputText() with std::string, see misc/cpp/imgui_stdlib.h // (FIXME: Rather confusing and messy function, among the worse part of our codebase, expecting to rewrite a V2 at some point.. Partly because we are // doing UTF8 > U16 > UTF8 conversions on the go to easily interface with stb_textedit. Ideally should stay in UTF-8 all the time. See https://github.com/nothings/stb/issues/188) bool ImGui::InputTextEx(const char* label, const char* hint, char* buf, int buf_size, const ImVec2& size_arg, ImGuiInputTextFlags flags, ImGuiInputTextCallback callback, void* callback_user_data) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; IM_ASSERT(buf != NULL && buf_size >= 0); IM_ASSERT(!((flags & ImGuiInputTextFlags_CallbackHistory) && (flags & ImGuiInputTextFlags_Multiline))); // Can't use both together (they both use up/down keys) IM_ASSERT(!((flags & ImGuiInputTextFlags_CallbackCompletion) && (flags & ImGuiInputTextFlags_AllowTabInput))); // Can't use both together (they both use tab key) IM_ASSERT(!((flags & ImGuiInputTextFlags_ElideLeft) && (flags & ImGuiInputTextFlags_Multiline))); // Multiline will not work with left-trimming ImGuiContext& g = *GImGui; ImGuiIO& io = g.IO; const ImGuiStyle& style = g.Style; const bool RENDER_SELECTION_WHEN_INACTIVE = false; const bool is_multiline = (flags & ImGuiInputTextFlags_Multiline) != 0; if (is_multiline) // Open group before calling GetID() because groups tracks id created within their scope (including the scrollbar) BeginGroup(); const ImGuiID id = window->GetID(label); const ImVec2 label_size = CalcTextSize(label, NULL, true); const ImVec2 frame_size = CalcItemSize(size_arg, CalcItemWidth(), (is_multiline ? g.FontSize * 8.0f : label_size.y) + style.FramePadding.y * 2.0f); // Arbitrary default of 8 lines high for multi-line const ImVec2 total_size = ImVec2(frame_size.x + (label_size.x > 0.0f ? style.ItemInnerSpacing.x + label_size.x : 0.0f), frame_size.y); const ImRect frame_bb(window->DC.CursorPos, window->DC.CursorPos + frame_size); const ImRect total_bb(frame_bb.Min, frame_bb.Min + total_size); ImGuiWindow* draw_window = window; ImVec2 inner_size = frame_size; ImGuiLastItemData item_data_backup; if (is_multiline) { ImVec2 backup_pos = window->DC.CursorPos; ItemSize(total_bb, style.FramePadding.y); if (!ItemAdd(total_bb, id, &frame_bb, ImGuiItemFlags_Inputable)) { EndGroup(); return false; } item_data_backup = g.LastItemData; window->DC.CursorPos = backup_pos; // Prevent NavActivation from Tabbing when our widget accepts Tab inputs: this allows cycling through widgets without stopping. if (g.NavActivateId == id && (g.NavActivateFlags & ImGuiActivateFlags_FromTabbing) && (flags & ImGuiInputTextFlags_AllowTabInput)) g.NavActivateId = 0; // Prevent NavActivate reactivating in BeginChild() when we are already active. const ImGuiID backup_activate_id = g.NavActivateId; if (g.ActiveId == id) // Prevent reactivation g.NavActivateId = 0; // We reproduce the contents of BeginChildFrame() in order to provide 'label' so our window internal data are easier to read/debug. PushStyleColor(ImGuiCol_ChildBg, style.Colors[ImGuiCol_FrameBg]); PushStyleVar(ImGuiStyleVar_ChildRounding, style.FrameRounding); PushStyleVar(ImGuiStyleVar_ChildBorderSize, style.FrameBorderSize); PushStyleVar(ImGuiStyleVar_WindowPadding, ImVec2(0, 0)); // Ensure no clip rect so mouse hover can reach FramePadding edges bool child_visible = BeginChildEx(label, id, frame_bb.GetSize(), ImGuiChildFlags_Borders, ImGuiWindowFlags_NoMove); g.NavActivateId = backup_activate_id; PopStyleVar(3); PopStyleColor(); if (!child_visible) { EndChild(); EndGroup(); return false; } draw_window = g.CurrentWindow; // Child window draw_window->DC.NavLayersActiveMaskNext |= (1 << draw_window->DC.NavLayerCurrent); // This is to ensure that EndChild() will display a navigation highlight so we can "enter" into it. draw_window->DC.CursorPos += style.FramePadding; inner_size.x -= draw_window->ScrollbarSizes.x; } else { // Support for internal ImGuiInputTextFlags_MergedItem flag, which could be redesigned as an ItemFlags if needed (with test performed in ItemAdd) ItemSize(total_bb, style.FramePadding.y); if (!(flags & ImGuiInputTextFlags_MergedItem)) if (!ItemAdd(total_bb, id, &frame_bb, ImGuiItemFlags_Inputable)) return false; } // Ensure mouse cursor is set even after switching to keyboard/gamepad mode. May generalize further? (#6417) bool hovered = ItemHoverable(frame_bb, id, g.LastItemData.ItemFlags | ImGuiItemFlags_NoNavDisableMouseHover); if (hovered) SetMouseCursor(ImGuiMouseCursor_TextInput); if (hovered && g.NavHighlightItemUnderNav) hovered = false; // We are only allowed to access the state if we are already the active widget. ImGuiInputTextState* state = GetInputTextState(id); if (g.LastItemData.ItemFlags & ImGuiItemFlags_ReadOnly) flags |= ImGuiInputTextFlags_ReadOnly; const bool is_readonly = (flags & ImGuiInputTextFlags_ReadOnly) != 0; const bool is_password = (flags & ImGuiInputTextFlags_Password) != 0; const bool is_undoable = (flags & ImGuiInputTextFlags_NoUndoRedo) == 0; const bool is_resizable = (flags & ImGuiInputTextFlags_CallbackResize) != 0; if (is_resizable) IM_ASSERT(callback != NULL); // Must provide a callback if you set the ImGuiInputTextFlags_CallbackResize flag! const bool input_requested_by_nav = (g.ActiveId != id) && ((g.NavActivateId == id) && ((g.NavActivateFlags & ImGuiActivateFlags_PreferInput) || (g.NavInputSource == ImGuiInputSource_Keyboard))); const bool user_clicked = hovered && io.MouseClicked[0]; const bool user_scroll_finish = is_multiline && state != NULL && g.ActiveId == 0 && g.ActiveIdPreviousFrame == GetWindowScrollbarID(draw_window, ImGuiAxis_Y); const bool user_scroll_active = is_multiline && state != NULL && g.ActiveId == GetWindowScrollbarID(draw_window, ImGuiAxis_Y); bool clear_active_id = false; bool select_all = false; float scroll_y = is_multiline ? draw_window->Scroll.y : FLT_MAX; const bool init_reload_from_user_buf = (state != NULL && state->WantReloadUserBuf); const bool init_changed_specs = (state != NULL && state->Stb->single_line != !is_multiline); // state != NULL means its our state. const bool init_make_active = (user_clicked || user_scroll_finish || input_requested_by_nav); const bool init_state = (init_make_active || user_scroll_active); if (init_reload_from_user_buf) { int new_len = (int)ImStrlen(buf); IM_ASSERT(new_len + 1 <= buf_size && "Is your input buffer properly zero-terminated?"); state->WantReloadUserBuf = false; InputTextReconcileUndoState(state, state->TextA.Data, state->TextLen, buf, new_len); state->TextA.resize(buf_size + 1); // we use +1 to make sure that .Data is always pointing to at least an empty string. state->TextLen = new_len; memcpy(state->TextA.Data, buf, state->TextLen + 1); state->Stb->select_start = state->ReloadSelectionStart; state->Stb->cursor = state->Stb->select_end = state->ReloadSelectionEnd; state->CursorClamp(); } else if ((init_state && g.ActiveId != id) || init_changed_specs) { // Access state even if we don't own it yet. state = &g.InputTextState; state->CursorAnimReset(); // Backup state of deactivating item so they'll have a chance to do a write to output buffer on the same frame they report IsItemDeactivatedAfterEdit (#4714) InputTextDeactivateHook(state->ID); // Take a copy of the initial buffer value. // From the moment we focused we are normally ignoring the content of 'buf' (unless we are in read-only mode) const int buf_len = (int)ImStrlen(buf); IM_ASSERT(buf_len + 1 <= buf_size && "Is your input buffer properly zero-terminated?"); state->TextToRevertTo.resize(buf_len + 1); // UTF-8. we use +1 to make sure that .Data is always pointing to at least an empty string. memcpy(state->TextToRevertTo.Data, buf, buf_len + 1); // Preserve cursor position and undo/redo stack if we come back to same widget // FIXME: Since we reworked this on 2022/06, may want to differentiate recycle_cursor vs recycle_undostate? bool recycle_state = (state->ID == id && !init_changed_specs); if (recycle_state && (state->TextLen != buf_len || (state->TextA.Data == NULL || strncmp(state->TextA.Data, buf, buf_len) != 0))) recycle_state = false; // Start edition state->ID = id; state->TextLen = buf_len; if (!is_readonly) { state->TextA.resize(buf_size + 1); // we use +1 to make sure that .Data is always pointing to at least an empty string. memcpy(state->TextA.Data, buf, state->TextLen + 1); } // Find initial scroll position for right alignment state->Scroll = ImVec2(0.0f, 0.0f); if (flags & ImGuiInputTextFlags_ElideLeft) state->Scroll.x += ImMax(0.0f, CalcTextSize(buf).x - frame_size.x + style.FramePadding.x * 2.0f); // Recycle existing cursor/selection/undo stack but clamp position // Note a single mouse click will override the cursor/position immediately by calling stb_textedit_click handler. if (recycle_state) state->CursorClamp(); else stb_textedit_initialize_state(state->Stb, !is_multiline); if (!is_multiline) { if (flags & ImGuiInputTextFlags_AutoSelectAll) select_all = true; if (input_requested_by_nav && (!recycle_state || !(g.NavActivateFlags & ImGuiActivateFlags_TryToPreserveState))) select_all = true; if (user_clicked && io.KeyCtrl) select_all = true; } if (flags & ImGuiInputTextFlags_AlwaysOverwrite) state->Stb->insert_mode = 1; // stb field name is indeed incorrect (see #2863) } const bool is_osx = io.ConfigMacOSXBehaviors; if (g.ActiveId != id && init_make_active) { IM_ASSERT(state && state->ID == id); SetActiveID(id, window); SetFocusID(id, window); FocusWindow(window); } if (g.ActiveId == id) { // Declare some inputs, the other are registered and polled via Shortcut() routing system. // FIXME: The reason we don't use Shortcut() is we would need a routing flag to specify multiple mods, or to all mods combinaison into individual shortcuts. const ImGuiKey always_owned_keys[] = { ImGuiKey_LeftArrow, ImGuiKey_RightArrow, ImGuiKey_Enter, ImGuiKey_KeypadEnter, ImGuiKey_Delete, ImGuiKey_Backspace, ImGuiKey_Home, ImGuiKey_End }; for (ImGuiKey key : always_owned_keys) SetKeyOwner(key, id); if (user_clicked) SetKeyOwner(ImGuiKey_MouseLeft, id); g.ActiveIdUsingNavDirMask |= (1 << ImGuiDir_Left) | (1 << ImGuiDir_Right); if (is_multiline || (flags & ImGuiInputTextFlags_CallbackHistory)) { g.ActiveIdUsingNavDirMask |= (1 << ImGuiDir_Up) | (1 << ImGuiDir_Down); SetKeyOwner(ImGuiKey_UpArrow, id); SetKeyOwner(ImGuiKey_DownArrow, id); } if (is_multiline) { SetKeyOwner(ImGuiKey_PageUp, id); SetKeyOwner(ImGuiKey_PageDown, id); } // FIXME: May be a problem to always steal Alt on OSX, would ideally still allow an uninterrupted Alt down-up to toggle menu if (is_osx) SetKeyOwner(ImGuiMod_Alt, id); // Expose scroll in a manner that is agnostic to us using a child window if (is_multiline && state != NULL) state->Scroll.y = draw_window->Scroll.y; // Read-only mode always ever read from source buffer. Refresh TextLen when active. if (is_readonly && state != NULL) state->TextLen = (int)ImStrlen(buf); //if (is_readonly && state != NULL) // state->TextA.clear(); // Uncomment to facilitate debugging, but we otherwise prefer to keep/amortize th allocation. } if (state != NULL) state->TextSrc = is_readonly ? buf : state->TextA.Data; // We have an edge case if ActiveId was set through another widget (e.g. widget being swapped), clear id immediately (don't wait until the end of the function) if (g.ActiveId == id && state == NULL) ClearActiveID(); // Release focus when we click outside if (g.ActiveId == id && io.MouseClicked[0] && !init_state && !init_make_active) //-V560 clear_active_id = true; // Lock the decision of whether we are going to take the path displaying the cursor or selection bool render_cursor = (g.ActiveId == id) || (state && user_scroll_active); bool render_selection = state && (state->HasSelection() || select_all) && (RENDER_SELECTION_WHEN_INACTIVE || render_cursor); bool value_changed = false; bool validated = false; // Select the buffer to render. const bool buf_display_from_state = (render_cursor || render_selection || g.ActiveId == id) && !is_readonly && state; bool is_displaying_hint = (hint != NULL && (buf_display_from_state ? state->TextA.Data : buf)[0] == 0); // Password pushes a temporary font with only a fallback glyph if (is_password && !is_displaying_hint) PushPasswordFont(); // Process mouse inputs and character inputs if (g.ActiveId == id) { IM_ASSERT(state != NULL); state->Edited = false; state->BufCapacity = buf_size; state->Flags = flags; // Although we are active we don't prevent mouse from hovering other elements unless we are interacting right now with the widget. // Down the line we should have a cleaner library-wide concept of Selected vs Active. g.ActiveIdAllowOverlap = !io.MouseDown[0]; // Edit in progress const float mouse_x = (io.MousePos.x - frame_bb.Min.x - style.FramePadding.x) + state->Scroll.x; const float mouse_y = (is_multiline ? (io.MousePos.y - draw_window->DC.CursorPos.y) : (g.FontSize * 0.5f)); if (select_all) { state->SelectAll(); state->SelectedAllMouseLock = true; } else if (hovered && io.MouseClickedCount[0] >= 2 && !io.KeyShift) { stb_textedit_click(state, state->Stb, mouse_x, mouse_y); const int multiclick_count = (io.MouseClickedCount[0] - 2); if ((multiclick_count % 2) == 0) { // Double-click: Select word // We always use the "Mac" word advance for double-click select vs CTRL+Right which use the platform dependent variant: // FIXME: There are likely many ways to improve this behavior, but there's no "right" behavior (depends on use-case, software, OS) const bool is_bol = (state->Stb->cursor == 0) || ImStb::STB_TEXTEDIT_GETCHAR(state, state->Stb->cursor - 1) == '\n'; if (STB_TEXT_HAS_SELECTION(state->Stb) || !is_bol) state->OnKeyPressed(STB_TEXTEDIT_K_WORDLEFT); //state->OnKeyPressed(STB_TEXTEDIT_K_WORDRIGHT | STB_TEXTEDIT_K_SHIFT); if (!STB_TEXT_HAS_SELECTION(state->Stb)) ImStb::stb_textedit_prep_selection_at_cursor(state->Stb); state->Stb->cursor = ImStb::STB_TEXTEDIT_MOVEWORDRIGHT_MAC(state, state->Stb->cursor); state->Stb->select_end = state->Stb->cursor; ImStb::stb_textedit_clamp(state, state->Stb); } else { // Triple-click: Select line const bool is_eol = ImStb::STB_TEXTEDIT_GETCHAR(state, state->Stb->cursor) == '\n'; state->OnKeyPressed(STB_TEXTEDIT_K_LINESTART); state->OnKeyPressed(STB_TEXTEDIT_K_LINEEND | STB_TEXTEDIT_K_SHIFT); state->OnKeyPressed(STB_TEXTEDIT_K_RIGHT | STB_TEXTEDIT_K_SHIFT); if (!is_eol && is_multiline) { ImSwap(state->Stb->select_start, state->Stb->select_end); state->Stb->cursor = state->Stb->select_end; } state->CursorFollow = false; } state->CursorAnimReset(); } else if (io.MouseClicked[0] && !state->SelectedAllMouseLock) { if (hovered) { if (io.KeyShift) stb_textedit_drag(state, state->Stb, mouse_x, mouse_y); else stb_textedit_click(state, state->Stb, mouse_x, mouse_y); state->CursorAnimReset(); } } else if (io.MouseDown[0] && !state->SelectedAllMouseLock && (io.MouseDelta.x != 0.0f || io.MouseDelta.y != 0.0f)) { stb_textedit_drag(state, state->Stb, mouse_x, mouse_y); state->CursorAnimReset(); state->CursorFollow = true; } if (state->SelectedAllMouseLock && !io.MouseDown[0]) state->SelectedAllMouseLock = false; // We expect backends to emit a Tab key but some also emit a Tab character which we ignore (#2467, #1336) // (For Tab and Enter: Win32/SFML/Allegro are sending both keys and chars, GLFW and SDL are only sending keys. For Space they all send all threes) if ((flags & ImGuiInputTextFlags_AllowTabInput) && !is_readonly) { if (Shortcut(ImGuiKey_Tab, ImGuiInputFlags_Repeat, id)) { unsigned int c = '\t'; // Insert TAB if (InputTextFilterCharacter(&g, &c, flags, callback, callback_user_data)) state->OnCharPressed(c); } // FIXME: Implement Shift+Tab /* if (Shortcut(ImGuiKey_Tab | ImGuiMod_Shift, ImGuiInputFlags_Repeat, id)) { } */ } // Process regular text input (before we check for Return because using some IME will effectively send a Return?) // We ignore CTRL inputs, but need to allow ALT+CTRL as some keyboards (e.g. German) use AltGR (which _is_ Alt+Ctrl) to input certain characters. const bool ignore_char_inputs = (io.KeyCtrl && !io.KeyAlt) || (is_osx && io.KeyCtrl); if (io.InputQueueCharacters.Size > 0) { if (!ignore_char_inputs && !is_readonly && !input_requested_by_nav) for (int n = 0; n < io.InputQueueCharacters.Size; n++) { // Insert character if they pass filtering unsigned int c = (unsigned int)io.InputQueueCharacters[n]; if (c == '\t') // Skip Tab, see above. continue; if (InputTextFilterCharacter(&g, &c, flags, callback, callback_user_data)) state->OnCharPressed(c); } // Consume characters io.InputQueueCharacters.resize(0); } } // Process other shortcuts/key-presses bool revert_edit = false; if (g.ActiveId == id && !g.ActiveIdIsJustActivated && !clear_active_id) { IM_ASSERT(state != NULL); const int row_count_per_page = ImMax((int)((inner_size.y - style.FramePadding.y) / g.FontSize), 1); state->Stb->row_count_per_page = row_count_per_page; const int k_mask = (io.KeyShift ? STB_TEXTEDIT_K_SHIFT : 0); const bool is_wordmove_key_down = is_osx ? io.KeyAlt : io.KeyCtrl; // OS X style: Text editing cursor movement using Alt instead of Ctrl const bool is_startend_key_down = is_osx && io.KeyCtrl && !io.KeySuper && !io.KeyAlt; // OS X style: Line/Text Start and End using Cmd+Arrows instead of Home/End // Using Shortcut() with ImGuiInputFlags_RouteFocused (default policy) to allow routing operations for other code (e.g. calling window trying to use CTRL+A and CTRL+B: former would be handled by InputText) // Otherwise we could simply assume that we own the keys as we are active. const ImGuiInputFlags f_repeat = ImGuiInputFlags_Repeat; const bool is_cut = (Shortcut(ImGuiMod_Ctrl | ImGuiKey_X, f_repeat, id) || Shortcut(ImGuiMod_Shift | ImGuiKey_Delete, f_repeat, id)) && !is_readonly && !is_password && (!is_multiline || state->HasSelection()); const bool is_copy = (Shortcut(ImGuiMod_Ctrl | ImGuiKey_C, 0, id) || Shortcut(ImGuiMod_Ctrl | ImGuiKey_Insert, 0, id)) && !is_password && (!is_multiline || state->HasSelection()); const bool is_paste = (Shortcut(ImGuiMod_Ctrl | ImGuiKey_V, f_repeat, id) || Shortcut(ImGuiMod_Shift | ImGuiKey_Insert, f_repeat, id)) && !is_readonly; const bool is_undo = (Shortcut(ImGuiMod_Ctrl | ImGuiKey_Z, f_repeat, id)) && !is_readonly && is_undoable; const bool is_redo = (Shortcut(ImGuiMod_Ctrl | ImGuiKey_Y, f_repeat, id) || Shortcut(ImGuiMod_Ctrl | ImGuiMod_Shift | ImGuiKey_Z, f_repeat, id)) && !is_readonly && is_undoable; const bool is_select_all = Shortcut(ImGuiMod_Ctrl | ImGuiKey_A, 0, id); // We allow validate/cancel with Nav source (gamepad) to makes it easier to undo an accidental NavInput press with no keyboard wired, but otherwise it isn't very useful. const bool nav_gamepad_active = (io.ConfigFlags & ImGuiConfigFlags_NavEnableGamepad) != 0 && (io.BackendFlags & ImGuiBackendFlags_HasGamepad) != 0; const bool is_enter_pressed = IsKeyPressed(ImGuiKey_Enter, true) || IsKeyPressed(ImGuiKey_KeypadEnter, true); const bool is_gamepad_validate = nav_gamepad_active && (IsKeyPressed(ImGuiKey_NavGamepadActivate, false) || IsKeyPressed(ImGuiKey_NavGamepadInput, false)); const bool is_cancel = Shortcut(ImGuiKey_Escape, f_repeat, id) || (nav_gamepad_active && Shortcut(ImGuiKey_NavGamepadCancel, f_repeat, id)); // FIXME: Should use more Shortcut() and reduce IsKeyPressed()+SetKeyOwner(), but requires modifiers combination to be taken account of. // FIXME-OSX: Missing support for Alt(option)+Right/Left = go to end of line, or next line if already in end of line. if (IsKeyPressed(ImGuiKey_LeftArrow)) { state->OnKeyPressed((is_startend_key_down ? STB_TEXTEDIT_K_LINESTART : is_wordmove_key_down ? STB_TEXTEDIT_K_WORDLEFT : STB_TEXTEDIT_K_LEFT) | k_mask); } else if (IsKeyPressed(ImGuiKey_RightArrow)) { state->OnKeyPressed((is_startend_key_down ? STB_TEXTEDIT_K_LINEEND : is_wordmove_key_down ? STB_TEXTEDIT_K_WORDRIGHT : STB_TEXTEDIT_K_RIGHT) | k_mask); } else if (IsKeyPressed(ImGuiKey_UpArrow) && is_multiline) { if (io.KeyCtrl) SetScrollY(draw_window, ImMax(draw_window->Scroll.y - g.FontSize, 0.0f)); else state->OnKeyPressed((is_startend_key_down ? STB_TEXTEDIT_K_TEXTSTART : STB_TEXTEDIT_K_UP) | k_mask); } else if (IsKeyPressed(ImGuiKey_DownArrow) && is_multiline) { if (io.KeyCtrl) SetScrollY(draw_window, ImMin(draw_window->Scroll.y + g.FontSize, GetScrollMaxY())); else state->OnKeyPressed((is_startend_key_down ? STB_TEXTEDIT_K_TEXTEND : STB_TEXTEDIT_K_DOWN) | k_mask); } else if (IsKeyPressed(ImGuiKey_PageUp) && is_multiline) { state->OnKeyPressed(STB_TEXTEDIT_K_PGUP | k_mask); scroll_y -= row_count_per_page * g.FontSize; } else if (IsKeyPressed(ImGuiKey_PageDown) && is_multiline) { state->OnKeyPressed(STB_TEXTEDIT_K_PGDOWN | k_mask); scroll_y += row_count_per_page * g.FontSize; } else if (IsKeyPressed(ImGuiKey_Home)) { state->OnKeyPressed(io.KeyCtrl ? STB_TEXTEDIT_K_TEXTSTART | k_mask : STB_TEXTEDIT_K_LINESTART | k_mask); } else if (IsKeyPressed(ImGuiKey_End)) { state->OnKeyPressed(io.KeyCtrl ? STB_TEXTEDIT_K_TEXTEND | k_mask : STB_TEXTEDIT_K_LINEEND | k_mask); } else if (IsKeyPressed(ImGuiKey_Delete) && !is_readonly && !is_cut) { if (!state->HasSelection()) { // OSX doesn't seem to have Super+Delete to delete until end-of-line, so we don't emulate that (as opposed to Super+Backspace) if (is_wordmove_key_down) state->OnKeyPressed(STB_TEXTEDIT_K_WORDRIGHT | STB_TEXTEDIT_K_SHIFT); } state->OnKeyPressed(STB_TEXTEDIT_K_DELETE | k_mask); } else if (IsKeyPressed(ImGuiKey_Backspace) && !is_readonly) { if (!state->HasSelection()) { if (is_wordmove_key_down) state->OnKeyPressed(STB_TEXTEDIT_K_WORDLEFT | STB_TEXTEDIT_K_SHIFT); else if (is_osx && io.KeyCtrl && !io.KeyAlt && !io.KeySuper) state->OnKeyPressed(STB_TEXTEDIT_K_LINESTART | STB_TEXTEDIT_K_SHIFT); } state->OnKeyPressed(STB_TEXTEDIT_K_BACKSPACE | k_mask); } else if (is_enter_pressed || is_gamepad_validate) { // Determine if we turn Enter into a \n character bool ctrl_enter_for_new_line = (flags & ImGuiInputTextFlags_CtrlEnterForNewLine) != 0; if (!is_multiline || is_gamepad_validate || (ctrl_enter_for_new_line && !io.KeyCtrl) || (!ctrl_enter_for_new_line && io.KeyCtrl)) { validated = true; if (io.ConfigInputTextEnterKeepActive && !is_multiline) state->SelectAll(); // No need to scroll else clear_active_id = true; } else if (!is_readonly) { unsigned int c = '\n'; // Insert new line if (InputTextFilterCharacter(&g, &c, flags, callback, callback_user_data)) state->OnCharPressed(c); } } else if (is_cancel) { if (flags & ImGuiInputTextFlags_EscapeClearsAll) { if (buf[0] != 0) { revert_edit = true; } else { render_cursor = render_selection = false; clear_active_id = true; } } else { clear_active_id = revert_edit = true; render_cursor = render_selection = false; } } else if (is_undo || is_redo) { state->OnKeyPressed(is_undo ? STB_TEXTEDIT_K_UNDO : STB_TEXTEDIT_K_REDO); state->ClearSelection(); } else if (is_select_all) { state->SelectAll(); state->CursorFollow = true; } else if (is_cut || is_copy) { // Cut, Copy if (g.PlatformIO.Platform_SetClipboardTextFn != NULL) { // SetClipboardText() only takes null terminated strings + state->TextSrc may point to read-only user buffer, so we need to make a copy. const int ib = state->HasSelection() ? ImMin(state->Stb->select_start, state->Stb->select_end) : 0; const int ie = state->HasSelection() ? ImMax(state->Stb->select_start, state->Stb->select_end) : state->TextLen; g.TempBuffer.reserve(ie - ib + 1); memcpy(g.TempBuffer.Data, state->TextSrc + ib, ie - ib); g.TempBuffer.Data[ie - ib] = 0; SetClipboardText(g.TempBuffer.Data); } if (is_cut) { if (!state->HasSelection()) state->SelectAll(); state->CursorFollow = true; stb_textedit_cut(state, state->Stb); } } else if (is_paste) { if (const char* clipboard = GetClipboardText()) { // Filter pasted buffer const int clipboard_len = (int)ImStrlen(clipboard); ImVector clipboard_filtered; clipboard_filtered.reserve(clipboard_len + 1); for (const char* s = clipboard; *s != 0; ) { unsigned int c; int in_len = ImTextCharFromUtf8(&c, s, NULL); s += in_len; if (!InputTextFilterCharacter(&g, &c, flags, callback, callback_user_data, true)) continue; char c_utf8[5]; ImTextCharToUtf8(c_utf8, c); int out_len = (int)ImStrlen(c_utf8); clipboard_filtered.resize(clipboard_filtered.Size + out_len); memcpy(clipboard_filtered.Data + clipboard_filtered.Size - out_len, c_utf8, out_len); } if (clipboard_filtered.Size > 0) // If everything was filtered, ignore the pasting operation { clipboard_filtered.push_back(0); stb_textedit_paste(state, state->Stb, clipboard_filtered.Data, clipboard_filtered.Size - 1); state->CursorFollow = true; } } } // Update render selection flag after events have been handled, so selection highlight can be displayed during the same frame. render_selection |= state->HasSelection() && (RENDER_SELECTION_WHEN_INACTIVE || render_cursor); } // Process callbacks and apply result back to user's buffer. const char* apply_new_text = NULL; int apply_new_text_length = 0; if (g.ActiveId == id) { IM_ASSERT(state != NULL); if (revert_edit && !is_readonly) { if (flags & ImGuiInputTextFlags_EscapeClearsAll) { // Clear input IM_ASSERT(buf[0] != 0); apply_new_text = ""; apply_new_text_length = 0; value_changed = true; IMSTB_TEXTEDIT_CHARTYPE empty_string; stb_textedit_replace(state, state->Stb, &empty_string, 0); } else if (strcmp(buf, state->TextToRevertTo.Data) != 0) { apply_new_text = state->TextToRevertTo.Data; apply_new_text_length = state->TextToRevertTo.Size - 1; // Restore initial value. Only return true if restoring to the initial value changes the current buffer contents. // Push records into the undo stack so we can CTRL+Z the revert operation itself value_changed = true; stb_textedit_replace(state, state->Stb, state->TextToRevertTo.Data, state->TextToRevertTo.Size - 1); } } // FIXME-OPT: We always reapply the live buffer back to the input buffer before clearing ActiveId, // even though strictly speaking it wasn't modified on this frame. Should mark dirty state from the stb_textedit callbacks. // If we do that, need to ensure that as special case, 'validated == true' also writes back. // This also allows the user to use InputText() without maintaining any user-side storage. // (please note that if you use this property along ImGuiInputTextFlags_CallbackResize you can end up with your temporary string object // unnecessarily allocating once a frame, either store your string data, either if you don't then don't use ImGuiInputTextFlags_CallbackResize). const bool apply_edit_back_to_user_buffer = true;// !revert_edit || (validated && (flags & ImGuiInputTextFlags_EnterReturnsTrue) != 0); if (apply_edit_back_to_user_buffer) { // Apply current edited text immediately. // Note that as soon as the input box is active, the in-widget value gets priority over any underlying modification of the input buffer // User callback if ((flags & (ImGuiInputTextFlags_CallbackCompletion | ImGuiInputTextFlags_CallbackHistory | ImGuiInputTextFlags_CallbackEdit | ImGuiInputTextFlags_CallbackAlways)) != 0) { IM_ASSERT(callback != NULL); // The reason we specify the usage semantic (Completion/History) is that Completion needs to disable keyboard TABBING at the moment. ImGuiInputTextFlags event_flag = 0; ImGuiKey event_key = ImGuiKey_None; if ((flags & ImGuiInputTextFlags_CallbackCompletion) != 0 && Shortcut(ImGuiKey_Tab, 0, id)) { event_flag = ImGuiInputTextFlags_CallbackCompletion; event_key = ImGuiKey_Tab; } else if ((flags & ImGuiInputTextFlags_CallbackHistory) != 0 && IsKeyPressed(ImGuiKey_UpArrow)) { event_flag = ImGuiInputTextFlags_CallbackHistory; event_key = ImGuiKey_UpArrow; } else if ((flags & ImGuiInputTextFlags_CallbackHistory) != 0 && IsKeyPressed(ImGuiKey_DownArrow)) { event_flag = ImGuiInputTextFlags_CallbackHistory; event_key = ImGuiKey_DownArrow; } else if ((flags & ImGuiInputTextFlags_CallbackEdit) && state->Edited) { event_flag = ImGuiInputTextFlags_CallbackEdit; } else if (flags & ImGuiInputTextFlags_CallbackAlways) { event_flag = ImGuiInputTextFlags_CallbackAlways; } if (event_flag) { ImGuiInputTextCallbackData callback_data; callback_data.Ctx = &g; callback_data.EventFlag = event_flag; callback_data.Flags = flags; callback_data.UserData = callback_user_data; // FIXME-OPT: Undo stack reconcile needs a backup of the data until we rework API, see #7925 char* callback_buf = is_readonly ? buf : state->TextA.Data; IM_ASSERT(callback_buf == state->TextSrc); state->CallbackTextBackup.resize(state->TextLen + 1); memcpy(state->CallbackTextBackup.Data, callback_buf, state->TextLen + 1); callback_data.EventKey = event_key; callback_data.Buf = callback_buf; callback_data.BufTextLen = state->TextLen; callback_data.BufSize = state->BufCapacity; callback_data.BufDirty = false; const int utf8_cursor_pos = callback_data.CursorPos = state->Stb->cursor; const int utf8_selection_start = callback_data.SelectionStart = state->Stb->select_start; const int utf8_selection_end = callback_data.SelectionEnd = state->Stb->select_end; // Call user code callback(&callback_data); // Read back what user may have modified callback_buf = is_readonly ? buf : state->TextA.Data; // Pointer may have been invalidated by a resize callback IM_ASSERT(callback_data.Buf == callback_buf); // Invalid to modify those fields IM_ASSERT(callback_data.BufSize == state->BufCapacity); IM_ASSERT(callback_data.Flags == flags); const bool buf_dirty = callback_data.BufDirty; if (callback_data.CursorPos != utf8_cursor_pos || buf_dirty) { state->Stb->cursor = callback_data.CursorPos; state->CursorFollow = true; } if (callback_data.SelectionStart != utf8_selection_start || buf_dirty) { state->Stb->select_start = (callback_data.SelectionStart == callback_data.CursorPos) ? state->Stb->cursor : callback_data.SelectionStart; } if (callback_data.SelectionEnd != utf8_selection_end || buf_dirty) { state->Stb->select_end = (callback_data.SelectionEnd == callback_data.SelectionStart) ? state->Stb->select_start : callback_data.SelectionEnd; } if (buf_dirty) { // Callback may update buffer and thus set buf_dirty even in read-only mode. IM_ASSERT(callback_data.BufTextLen == (int)ImStrlen(callback_data.Buf)); // You need to maintain BufTextLen if you change the text! InputTextReconcileUndoState(state, state->CallbackTextBackup.Data, state->CallbackTextBackup.Size - 1, callback_data.Buf, callback_data.BufTextLen); state->TextLen = callback_data.BufTextLen; // Assume correct length and valid UTF-8 from user, saves us an extra strlen() state->CursorAnimReset(); } } } // Will copy result string if modified if (!is_readonly && strcmp(state->TextSrc, buf) != 0) { apply_new_text = state->TextSrc; apply_new_text_length = state->TextLen; value_changed = true; } } } // Handle reapplying final data on deactivation (see InputTextDeactivateHook() for details) if (g.InputTextDeactivatedState.ID == id) { if (g.ActiveId != id && IsItemDeactivatedAfterEdit() && !is_readonly && strcmp(g.InputTextDeactivatedState.TextA.Data, buf) != 0) { apply_new_text = g.InputTextDeactivatedState.TextA.Data; apply_new_text_length = g.InputTextDeactivatedState.TextA.Size - 1; value_changed = true; //IMGUI_DEBUG_LOG("InputText(): apply Deactivated data for 0x%08X: \"%.*s\".\n", id, apply_new_text_length, apply_new_text); } g.InputTextDeactivatedState.ID = 0; } // Copy result to user buffer. This can currently only happen when (g.ActiveId == id) if (apply_new_text != NULL) { //// We cannot test for 'backup_current_text_length != apply_new_text_length' here because we have no guarantee that the size //// of our owned buffer matches the size of the string object held by the user, and by design we allow InputText() to be used //// without any storage on user's side. IM_ASSERT(apply_new_text_length >= 0); if (is_resizable) { ImGuiInputTextCallbackData callback_data; callback_data.Ctx = &g; callback_data.EventFlag = ImGuiInputTextFlags_CallbackResize; callback_data.Flags = flags; callback_data.Buf = buf; callback_data.BufTextLen = apply_new_text_length; callback_data.BufSize = ImMax(buf_size, apply_new_text_length + 1); callback_data.UserData = callback_user_data; callback(&callback_data); buf = callback_data.Buf; buf_size = callback_data.BufSize; apply_new_text_length = ImMin(callback_data.BufTextLen, buf_size - 1); IM_ASSERT(apply_new_text_length <= buf_size); } //IMGUI_DEBUG_PRINT("InputText(\"%s\"): apply_new_text length %d\n", label, apply_new_text_length); // If the underlying buffer resize was denied or not carried to the next frame, apply_new_text_length+1 may be >= buf_size. ImStrncpy(buf, apply_new_text, ImMin(apply_new_text_length + 1, buf_size)); } // Release active ID at the end of the function (so e.g. pressing Return still does a final application of the value) // Otherwise request text input ahead for next frame. if (g.ActiveId == id && clear_active_id) ClearActiveID(); else if (g.ActiveId == id) g.WantTextInputNextFrame = 1; // Render frame if (!is_multiline) { RenderNavCursor(frame_bb, id); RenderFrame(frame_bb.Min, frame_bb.Max, GetColorU32(ImGuiCol_FrameBg), true, style.FrameRounding); } const ImVec4 clip_rect(frame_bb.Min.x, frame_bb.Min.y, frame_bb.Min.x + inner_size.x, frame_bb.Min.y + inner_size.y); // Not using frame_bb.Max because we have adjusted size ImVec2 draw_pos = is_multiline ? draw_window->DC.CursorPos : frame_bb.Min + style.FramePadding; ImVec2 text_size(0.0f, 0.0f); // Set upper limit of single-line InputTextEx() at 2 million characters strings. The current pathological worst case is a long line // without any carriage return, which would makes ImFont::RenderText() reserve too many vertices and probably crash. Avoid it altogether. // Note that we only use this limit on single-line InputText(), so a pathologically large line on a InputTextMultiline() would still crash. const int buf_display_max_length = 2 * 1024 * 1024; const char* buf_display = buf_display_from_state ? state->TextA.Data : buf; //-V595 const char* buf_display_end = NULL; // We have specialized paths below for setting the length // Display hint when contents is empty // At this point we need to handle the possibility that a callback could have modified the underlying buffer (#8368) const bool new_is_displaying_hint = (hint != NULL && (buf_display_from_state ? state->TextA.Data : buf)[0] == 0); if (new_is_displaying_hint != is_displaying_hint) { if (is_password && !is_displaying_hint) PopFont(); is_displaying_hint = new_is_displaying_hint; if (is_password && !is_displaying_hint) PushPasswordFont(); } if (is_displaying_hint) { buf_display = hint; buf_display_end = hint + ImStrlen(hint); } // Render text. We currently only render selection when the widget is active or while scrolling. // FIXME: We could remove the '&& render_cursor' to keep rendering selection when inactive. if (render_cursor || render_selection) { IM_ASSERT(state != NULL); if (!is_displaying_hint) buf_display_end = buf_display + state->TextLen; // Render text (with cursor and selection) // This is going to be messy. We need to: // - Display the text (this alone can be more easily clipped) // - Handle scrolling, highlight selection, display cursor (those all requires some form of 1d->2d cursor position calculation) // - Measure text height (for scrollbar) // We are attempting to do most of that in **one main pass** to minimize the computation cost (non-negligible for large amount of text) + 2nd pass for selection rendering (we could merge them by an extra refactoring effort) // FIXME: This should occur on buf_display but we'd need to maintain cursor/select_start/select_end for UTF-8. const char* text_begin = buf_display; const char* text_end = text_begin + state->TextLen; ImVec2 cursor_offset, select_start_offset; { // Find lines numbers straddling cursor and selection min position int cursor_line_no = render_cursor ? -1 : -1000; int selmin_line_no = render_selection ? -1 : -1000; const char* cursor_ptr = render_cursor ? text_begin + state->Stb->cursor : NULL; const char* selmin_ptr = render_selection ? text_begin + ImMin(state->Stb->select_start, state->Stb->select_end) : NULL; // Count lines and find line number for cursor and selection ends int line_count = 1; if (is_multiline) { for (const char* s = text_begin; (s = (const char*)ImMemchr(s, '\n', (size_t)(text_end - s))) != NULL; s++) { if (cursor_line_no == -1 && s >= cursor_ptr) { cursor_line_no = line_count; } if (selmin_line_no == -1 && s >= selmin_ptr) { selmin_line_no = line_count; } line_count++; } } if (cursor_line_no == -1) cursor_line_no = line_count; if (selmin_line_no == -1) selmin_line_no = line_count; // Calculate 2d position by finding the beginning of the line and measuring distance cursor_offset.x = InputTextCalcTextSize(&g, ImStrbol(cursor_ptr, text_begin), cursor_ptr).x; cursor_offset.y = cursor_line_no * g.FontSize; if (selmin_line_no >= 0) { select_start_offset.x = InputTextCalcTextSize(&g, ImStrbol(selmin_ptr, text_begin), selmin_ptr).x; select_start_offset.y = selmin_line_no * g.FontSize; } // Store text height (note that we haven't calculated text width at all, see GitHub issues #383, #1224) if (is_multiline) text_size = ImVec2(inner_size.x, line_count * g.FontSize); } // Scroll if (render_cursor && state->CursorFollow) { // Horizontal scroll in chunks of quarter width if (!(flags & ImGuiInputTextFlags_NoHorizontalScroll)) { const float scroll_increment_x = inner_size.x * 0.25f; const float visible_width = inner_size.x - style.FramePadding.x; if (cursor_offset.x < state->Scroll.x) state->Scroll.x = IM_TRUNC(ImMax(0.0f, cursor_offset.x - scroll_increment_x)); else if (cursor_offset.x - visible_width >= state->Scroll.x) state->Scroll.x = IM_TRUNC(cursor_offset.x - visible_width + scroll_increment_x); } else { state->Scroll.y = 0.0f; } // Vertical scroll if (is_multiline) { // Test if cursor is vertically visible if (cursor_offset.y - g.FontSize < scroll_y) scroll_y = ImMax(0.0f, cursor_offset.y - g.FontSize); else if (cursor_offset.y - (inner_size.y - style.FramePadding.y * 2.0f) >= scroll_y) scroll_y = cursor_offset.y - inner_size.y + style.FramePadding.y * 2.0f; const float scroll_max_y = ImMax((text_size.y + style.FramePadding.y * 2.0f) - inner_size.y, 0.0f); scroll_y = ImClamp(scroll_y, 0.0f, scroll_max_y); draw_pos.y += (draw_window->Scroll.y - scroll_y); // Manipulate cursor pos immediately avoid a frame of lag draw_window->Scroll.y = scroll_y; } state->CursorFollow = false; } // Draw selection const ImVec2 draw_scroll = ImVec2(state->Scroll.x, 0.0f); if (render_selection) { const char* text_selected_begin = text_begin + ImMin(state->Stb->select_start, state->Stb->select_end); const char* text_selected_end = text_begin + ImMax(state->Stb->select_start, state->Stb->select_end); ImU32 bg_color = GetColorU32(ImGuiCol_TextSelectedBg, render_cursor ? 1.0f : 0.6f); // FIXME: current code flow mandate that render_cursor is always true here, we are leaving the transparent one for tests. float bg_offy_up = is_multiline ? 0.0f : -1.0f; // FIXME: those offsets should be part of the style? they don't play so well with multi-line selection. float bg_offy_dn = is_multiline ? 0.0f : 2.0f; ImVec2 rect_pos = draw_pos + select_start_offset - draw_scroll; for (const char* p = text_selected_begin; p < text_selected_end; ) { if (rect_pos.y > clip_rect.w + g.FontSize) break; if (rect_pos.y < clip_rect.y) { p = (const char*)ImMemchr((void*)p, '\n', text_selected_end - p); p = p ? p + 1 : text_selected_end; } else { ImVec2 rect_size = InputTextCalcTextSize(&g, p, text_selected_end, &p, NULL, true); if (rect_size.x <= 0.0f) rect_size.x = IM_TRUNC(g.Font->GetCharAdvance((ImWchar)' ') * 0.50f); // So we can see selected empty lines ImRect rect(rect_pos + ImVec2(0.0f, bg_offy_up - g.FontSize), rect_pos + ImVec2(rect_size.x, bg_offy_dn)); rect.ClipWith(clip_rect); if (rect.Overlaps(clip_rect)) draw_window->DrawList->AddRectFilled(rect.Min, rect.Max, bg_color); rect_pos.x = draw_pos.x - draw_scroll.x; } rect_pos.y += g.FontSize; } } // We test for 'buf_display_max_length' as a way to avoid some pathological cases (e.g. single-line 1 MB string) which would make ImDrawList crash. // FIXME-OPT: Multiline could submit a smaller amount of contents to AddText() since we already iterated through it. if (is_multiline || (buf_display_end - buf_display) < buf_display_max_length) { ImU32 col = GetColorU32(is_displaying_hint ? ImGuiCol_TextDisabled : ImGuiCol_Text); draw_window->DrawList->AddText(g.Font, g.FontSize, draw_pos - draw_scroll, col, buf_display, buf_display_end, 0.0f, is_multiline ? NULL : &clip_rect); } // Draw blinking cursor if (render_cursor) { state->CursorAnim += io.DeltaTime; bool cursor_is_visible = (!g.IO.ConfigInputTextCursorBlink) || (state->CursorAnim <= 0.0f) || ImFmod(state->CursorAnim, 1.20f) <= 0.80f; ImVec2 cursor_screen_pos = ImTrunc(draw_pos + cursor_offset - draw_scroll); ImRect cursor_screen_rect(cursor_screen_pos.x, cursor_screen_pos.y - g.FontSize + 0.5f, cursor_screen_pos.x + 1.0f, cursor_screen_pos.y - 1.5f); if (cursor_is_visible && cursor_screen_rect.Overlaps(clip_rect)) draw_window->DrawList->AddLine(cursor_screen_rect.Min, cursor_screen_rect.GetBL(), GetColorU32(ImGuiCol_Text)); // Notify OS of text input position for advanced IME (-1 x offset so that Windows IME can cover our cursor. Bit of an extra nicety.) if (!is_readonly) { g.PlatformImeData.WantVisible = true; g.PlatformImeData.InputPos = ImVec2(cursor_screen_pos.x - 1.0f, cursor_screen_pos.y - g.FontSize); g.PlatformImeData.InputLineHeight = g.FontSize; } } } else { // Render text only (no selection, no cursor) if (is_multiline) text_size = ImVec2(inner_size.x, InputTextCalcTextLenAndLineCount(buf_display, &buf_display_end) * g.FontSize); // We don't need width else if (!is_displaying_hint && g.ActiveId == id) buf_display_end = buf_display + state->TextLen; else if (!is_displaying_hint) buf_display_end = buf_display + ImStrlen(buf_display); if (is_multiline || (buf_display_end - buf_display) < buf_display_max_length) { // Find render position for right alignment if (flags & ImGuiInputTextFlags_ElideLeft) draw_pos.x = ImMin(draw_pos.x, frame_bb.Max.x - CalcTextSize(buf_display, NULL).x - style.FramePadding.x); const ImVec2 draw_scroll = /*state ? ImVec2(state->Scroll.x, 0.0f) :*/ ImVec2(0.0f, 0.0f); // Preserve scroll when inactive? ImU32 col = GetColorU32(is_displaying_hint ? ImGuiCol_TextDisabled : ImGuiCol_Text); draw_window->DrawList->AddText(g.Font, g.FontSize, draw_pos - draw_scroll, col, buf_display, buf_display_end, 0.0f, is_multiline ? NULL : &clip_rect); } } if (is_password && !is_displaying_hint) PopFont(); if (is_multiline) { // For focus requests to work on our multiline we need to ensure our child ItemAdd() call specifies the ImGuiItemFlags_Inputable (see #4761, #7870)... Dummy(ImVec2(text_size.x, text_size.y + style.FramePadding.y)); g.NextItemData.ItemFlags |= (ImGuiItemFlags)ImGuiItemFlags_Inputable | ImGuiItemFlags_NoTabStop; EndChild(); item_data_backup.StatusFlags |= (g.LastItemData.StatusFlags & ImGuiItemStatusFlags_HoveredWindow); // ...and then we need to undo the group overriding last item data, which gets a bit messy as EndGroup() tries to forward scrollbar being active... // FIXME: This quite messy/tricky, should attempt to get rid of the child window. EndGroup(); if (g.LastItemData.ID == 0 || g.LastItemData.ID != GetWindowScrollbarID(draw_window, ImGuiAxis_Y)) { g.LastItemData.ID = id; g.LastItemData.ItemFlags = item_data_backup.ItemFlags; g.LastItemData.StatusFlags = item_data_backup.StatusFlags; } } if (state) state->TextSrc = NULL; // Log as text if (g.LogEnabled && (!is_password || is_displaying_hint)) { LogSetNextTextDecoration("{", "}"); LogRenderedText(&draw_pos, buf_display, buf_display_end); } if (label_size.x > 0) RenderText(ImVec2(frame_bb.Max.x + style.ItemInnerSpacing.x, frame_bb.Min.y + style.FramePadding.y), label); if (value_changed) MarkItemEdited(id); IMGUI_TEST_ENGINE_ITEM_INFO(id, label, g.LastItemData.StatusFlags | ImGuiItemStatusFlags_Inputable); if ((flags & ImGuiInputTextFlags_EnterReturnsTrue) != 0) return validated; else return value_changed; } void ImGui::DebugNodeInputTextState(ImGuiInputTextState* state) { #ifndef IMGUI_DISABLE_DEBUG_TOOLS ImGuiContext& g = *GImGui; ImStb::STB_TexteditState* stb_state = state->Stb; ImStb::StbUndoState* undo_state = &stb_state->undostate; Text("ID: 0x%08X, ActiveID: 0x%08X", state->ID, g.ActiveId); DebugLocateItemOnHover(state->ID); Text("CurLenA: %d, Cursor: %d, Selection: %d..%d", state->TextLen, stb_state->cursor, stb_state->select_start, stb_state->select_end); Text("BufCapacityA: %d", state->BufCapacity); Text("(Internal Buffer: TextA Size: %d, Capacity: %d)", state->TextA.Size, state->TextA.Capacity); Text("has_preferred_x: %d (%.2f)", stb_state->has_preferred_x, stb_state->preferred_x); Text("undo_point: %d, redo_point: %d, undo_char_point: %d, redo_char_point: %d", undo_state->undo_point, undo_state->redo_point, undo_state->undo_char_point, undo_state->redo_char_point); if (BeginChild("undopoints", ImVec2(0.0f, GetTextLineHeight() * 10), ImGuiChildFlags_Borders | ImGuiChildFlags_ResizeY)) // Visualize undo state { PushStyleVar(ImGuiStyleVar_ItemSpacing, ImVec2(0, 0)); for (int n = 0; n < IMSTB_TEXTEDIT_UNDOSTATECOUNT; n++) { ImStb::StbUndoRecord* undo_rec = &undo_state->undo_rec[n]; const char undo_rec_type = (n < undo_state->undo_point) ? 'u' : (n >= undo_state->redo_point) ? 'r' : ' '; if (undo_rec_type == ' ') BeginDisabled(); const int buf_preview_len = (undo_rec_type != ' ' && undo_rec->char_storage != -1) ? undo_rec->insert_length : 0; const char* buf_preview_str = undo_state->undo_char + undo_rec->char_storage; Text("%c [%02d] where %03d, insert %03d, delete %03d, char_storage %03d \"%.*s\"", undo_rec_type, n, undo_rec->where, undo_rec->insert_length, undo_rec->delete_length, undo_rec->char_storage, buf_preview_len, buf_preview_str); if (undo_rec_type == ' ') EndDisabled(); } PopStyleVar(); } EndChild(); #else IM_UNUSED(state); #endif } //------------------------------------------------------------------------- // [SECTION] Widgets: ColorEdit, ColorPicker, ColorButton, etc. //------------------------------------------------------------------------- // - ColorEdit3() // - ColorEdit4() // - ColorPicker3() // - RenderColorRectWithAlphaCheckerboard() [Internal] // - ColorPicker4() // - ColorButton() // - SetColorEditOptions() // - ColorTooltip() [Internal] // - ColorEditOptionsPopup() [Internal] // - ColorPickerOptionsPopup() [Internal] //------------------------------------------------------------------------- bool ImGui::ColorEdit3(const char* label, float col[3], ImGuiColorEditFlags flags) { return ColorEdit4(label, col, flags | ImGuiColorEditFlags_NoAlpha); } static void ColorEditRestoreH(const float* col, float* H) { ImGuiContext& g = *GImGui; IM_ASSERT(g.ColorEditCurrentID != 0); if (g.ColorEditSavedID != g.ColorEditCurrentID || g.ColorEditSavedColor != ImGui::ColorConvertFloat4ToU32(ImVec4(col[0], col[1], col[2], 0))) return; *H = g.ColorEditSavedHue; } // ColorEdit supports RGB and HSV inputs. In case of RGB input resulting color may have undefined hue and/or saturation. // Since widget displays both RGB and HSV values we must preserve hue and saturation to prevent these values resetting. static void ColorEditRestoreHS(const float* col, float* H, float* S, float* V) { ImGuiContext& g = *GImGui; IM_ASSERT(g.ColorEditCurrentID != 0); if (g.ColorEditSavedID != g.ColorEditCurrentID || g.ColorEditSavedColor != ImGui::ColorConvertFloat4ToU32(ImVec4(col[0], col[1], col[2], 0))) return; // When S == 0, H is undefined. // When H == 1 it wraps around to 0. if (*S == 0.0f || (*H == 0.0f && g.ColorEditSavedHue == 1)) *H = g.ColorEditSavedHue; // When V == 0, S is undefined. if (*V == 0.0f) *S = g.ColorEditSavedSat; } // Edit colors components (each component in 0.0f..1.0f range). // See enum ImGuiColorEditFlags_ for available options. e.g. Only access 3 floats if ImGuiColorEditFlags_NoAlpha flag is set. // With typical options: Left-click on color square to open color picker. Right-click to open option menu. CTRL+Click over input fields to edit them and TAB to go to next item. bool ImGui::ColorEdit4(const char* label, float col[4], ImGuiColorEditFlags flags) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; ImGuiContext& g = *GImGui; const ImGuiStyle& style = g.Style; const float square_sz = GetFrameHeight(); const char* label_display_end = FindRenderedTextEnd(label); float w_full = CalcItemWidth(); g.NextItemData.ClearFlags(); BeginGroup(); PushID(label); const bool set_current_color_edit_id = (g.ColorEditCurrentID == 0); if (set_current_color_edit_id) g.ColorEditCurrentID = window->IDStack.back(); // If we're not showing any slider there's no point in doing any HSV conversions const ImGuiColorEditFlags flags_untouched = flags; if (flags & ImGuiColorEditFlags_NoInputs) flags = (flags & (~ImGuiColorEditFlags_DisplayMask_)) | ImGuiColorEditFlags_DisplayRGB | ImGuiColorEditFlags_NoOptions; // Context menu: display and modify options (before defaults are applied) if (!(flags & ImGuiColorEditFlags_NoOptions)) ColorEditOptionsPopup(col, flags); // Read stored options if (!(flags & ImGuiColorEditFlags_DisplayMask_)) flags |= (g.ColorEditOptions & ImGuiColorEditFlags_DisplayMask_); if (!(flags & ImGuiColorEditFlags_DataTypeMask_)) flags |= (g.ColorEditOptions & ImGuiColorEditFlags_DataTypeMask_); if (!(flags & ImGuiColorEditFlags_PickerMask_)) flags |= (g.ColorEditOptions & ImGuiColorEditFlags_PickerMask_); if (!(flags & ImGuiColorEditFlags_InputMask_)) flags |= (g.ColorEditOptions & ImGuiColorEditFlags_InputMask_); flags |= (g.ColorEditOptions & ~(ImGuiColorEditFlags_DisplayMask_ | ImGuiColorEditFlags_DataTypeMask_ | ImGuiColorEditFlags_PickerMask_ | ImGuiColorEditFlags_InputMask_)); IM_ASSERT(ImIsPowerOfTwo(flags & ImGuiColorEditFlags_DisplayMask_)); // Check that only 1 is selected IM_ASSERT(ImIsPowerOfTwo(flags & ImGuiColorEditFlags_InputMask_)); // Check that only 1 is selected const bool alpha = (flags & ImGuiColorEditFlags_NoAlpha) == 0; const bool hdr = (flags & ImGuiColorEditFlags_HDR) != 0; const int components = alpha ? 4 : 3; const float w_button = (flags & ImGuiColorEditFlags_NoSmallPreview) ? 0.0f : (square_sz + style.ItemInnerSpacing.x); const float w_inputs = ImMax(w_full - w_button, 1.0f); w_full = w_inputs + w_button; // Convert to the formats we need float f[4] = { col[0], col[1], col[2], alpha ? col[3] : 1.0f }; if ((flags & ImGuiColorEditFlags_InputHSV) && (flags & ImGuiColorEditFlags_DisplayRGB)) ColorConvertHSVtoRGB(f[0], f[1], f[2], f[0], f[1], f[2]); else if ((flags & ImGuiColorEditFlags_InputRGB) && (flags & ImGuiColorEditFlags_DisplayHSV)) { // Hue is lost when converting from grayscale rgb (saturation=0). Restore it. ColorConvertRGBtoHSV(f[0], f[1], f[2], f[0], f[1], f[2]); ColorEditRestoreHS(col, &f[0], &f[1], &f[2]); } int i[4] = { IM_F32_TO_INT8_UNBOUND(f[0]), IM_F32_TO_INT8_UNBOUND(f[1]), IM_F32_TO_INT8_UNBOUND(f[2]), IM_F32_TO_INT8_UNBOUND(f[3]) }; bool value_changed = false; bool value_changed_as_float = false; const ImVec2 pos = window->DC.CursorPos; const float inputs_offset_x = (style.ColorButtonPosition == ImGuiDir_Left) ? w_button : 0.0f; window->DC.CursorPos.x = pos.x + inputs_offset_x; if ((flags & (ImGuiColorEditFlags_DisplayRGB | ImGuiColorEditFlags_DisplayHSV)) != 0 && (flags & ImGuiColorEditFlags_NoInputs) == 0) { // RGB/HSV 0..255 Sliders const float w_items = w_inputs - style.ItemInnerSpacing.x * (components - 1); const bool hide_prefix = (IM_TRUNC(w_items / components) <= CalcTextSize((flags & ImGuiColorEditFlags_Float) ? "M:0.000" : "M:000").x); static const char* ids[4] = { "##X", "##Y", "##Z", "##W" }; static const char* fmt_table_int[3][4] = { { "%3d", "%3d", "%3d", "%3d" }, // Short display { "R:%3d", "G:%3d", "B:%3d", "A:%3d" }, // Long display for RGBA { "H:%3d", "S:%3d", "V:%3d", "A:%3d" } // Long display for HSVA }; static const char* fmt_table_float[3][4] = { { "%0.3f", "%0.3f", "%0.3f", "%0.3f" }, // Short display { "R:%0.3f", "G:%0.3f", "B:%0.3f", "A:%0.3f" }, // Long display for RGBA { "H:%0.3f", "S:%0.3f", "V:%0.3f", "A:%0.3f" } // Long display for HSVA }; const int fmt_idx = hide_prefix ? 0 : (flags & ImGuiColorEditFlags_DisplayHSV) ? 2 : 1; float prev_split = 0.0f; for (int n = 0; n < components; n++) { if (n > 0) SameLine(0, style.ItemInnerSpacing.x); float next_split = IM_TRUNC(w_items * (n + 1) / components); SetNextItemWidth(ImMax(next_split - prev_split, 1.0f)); prev_split = next_split; // FIXME: When ImGuiColorEditFlags_HDR flag is passed HS values snap in weird ways when SV values go below 0. if (flags & ImGuiColorEditFlags_Float) { value_changed |= DragFloat(ids[n], &f[n], 1.0f / 255.0f, 0.0f, hdr ? 0.0f : 1.0f, fmt_table_float[fmt_idx][n]); value_changed_as_float |= value_changed; } else { value_changed |= DragInt(ids[n], &i[n], 1.0f, 0, hdr ? 0 : 255, fmt_table_int[fmt_idx][n]); } if (!(flags & ImGuiColorEditFlags_NoOptions)) OpenPopupOnItemClick("context", ImGuiPopupFlags_MouseButtonRight); } } else if ((flags & ImGuiColorEditFlags_DisplayHex) != 0 && (flags & ImGuiColorEditFlags_NoInputs) == 0) { // RGB Hexadecimal Input char buf[64]; if (alpha) ImFormatString(buf, IM_ARRAYSIZE(buf), "#%02X%02X%02X%02X", ImClamp(i[0], 0, 255), ImClamp(i[1], 0, 255), ImClamp(i[2], 0, 255), ImClamp(i[3], 0, 255)); else ImFormatString(buf, IM_ARRAYSIZE(buf), "#%02X%02X%02X", ImClamp(i[0], 0, 255), ImClamp(i[1], 0, 255), ImClamp(i[2], 0, 255)); SetNextItemWidth(w_inputs); if (InputText("##Text", buf, IM_ARRAYSIZE(buf), ImGuiInputTextFlags_CharsUppercase)) { value_changed = true; char* p = buf; while (*p == '#' || ImCharIsBlankA(*p)) p++; i[0] = i[1] = i[2] = 0; i[3] = 0xFF; // alpha default to 255 is not parsed by scanf (e.g. inputting #FFFFFF omitting alpha) int r; if (alpha) r = sscanf(p, "%02X%02X%02X%02X", (unsigned int*)&i[0], (unsigned int*)&i[1], (unsigned int*)&i[2], (unsigned int*)&i[3]); // Treat at unsigned (%X is unsigned) else r = sscanf(p, "%02X%02X%02X", (unsigned int*)&i[0], (unsigned int*)&i[1], (unsigned int*)&i[2]); IM_UNUSED(r); // Fixes C6031: Return value ignored: 'sscanf'. } if (!(flags & ImGuiColorEditFlags_NoOptions)) OpenPopupOnItemClick("context", ImGuiPopupFlags_MouseButtonRight); } ImGuiWindow* picker_active_window = NULL; if (!(flags & ImGuiColorEditFlags_NoSmallPreview)) { const float button_offset_x = ((flags & ImGuiColorEditFlags_NoInputs) || (style.ColorButtonPosition == ImGuiDir_Left)) ? 0.0f : w_inputs + style.ItemInnerSpacing.x; window->DC.CursorPos = ImVec2(pos.x + button_offset_x, pos.y); const ImVec4 col_v4(col[0], col[1], col[2], alpha ? col[3] : 1.0f); if (ColorButton("##ColorButton", col_v4, flags)) { if (!(flags & ImGuiColorEditFlags_NoPicker)) { // Store current color and open a picker g.ColorPickerRef = col_v4; OpenPopup("picker"); SetNextWindowPos(g.LastItemData.Rect.GetBL() + ImVec2(0.0f, style.ItemSpacing.y)); } } if (!(flags & ImGuiColorEditFlags_NoOptions)) OpenPopupOnItemClick("context", ImGuiPopupFlags_MouseButtonRight); if (BeginPopup("picker")) { if (g.CurrentWindow->BeginCount == 1) { picker_active_window = g.CurrentWindow; if (label != label_display_end) { TextEx(label, label_display_end); Spacing(); } ImGuiColorEditFlags picker_flags_to_forward = ImGuiColorEditFlags_DataTypeMask_ | ImGuiColorEditFlags_PickerMask_ | ImGuiColorEditFlags_InputMask_ | ImGuiColorEditFlags_HDR | ImGuiColorEditFlags_NoAlpha | ImGuiColorEditFlags_AlphaBar; ImGuiColorEditFlags picker_flags = (flags_untouched & picker_flags_to_forward) | ImGuiColorEditFlags_DisplayMask_ | ImGuiColorEditFlags_NoLabel | ImGuiColorEditFlags_AlphaPreviewHalf; SetNextItemWidth(square_sz * 12.0f); // Use 256 + bar sizes? value_changed |= ColorPicker4("##picker", col, picker_flags, &g.ColorPickerRef.x); } EndPopup(); } } if (label != label_display_end && !(flags & ImGuiColorEditFlags_NoLabel)) { // Position not necessarily next to last submitted button (e.g. if style.ColorButtonPosition == ImGuiDir_Left), // but we need to use SameLine() to setup baseline correctly. Might want to refactor SameLine() to simplify this. SameLine(0.0f, style.ItemInnerSpacing.x); window->DC.CursorPos.x = pos.x + ((flags & ImGuiColorEditFlags_NoInputs) ? w_button : w_full + style.ItemInnerSpacing.x); TextEx(label, label_display_end); } // Convert back if (value_changed && picker_active_window == NULL) { if (!value_changed_as_float) for (int n = 0; n < 4; n++) f[n] = i[n] / 255.0f; if ((flags & ImGuiColorEditFlags_DisplayHSV) && (flags & ImGuiColorEditFlags_InputRGB)) { g.ColorEditSavedHue = f[0]; g.ColorEditSavedSat = f[1]; ColorConvertHSVtoRGB(f[0], f[1], f[2], f[0], f[1], f[2]); g.ColorEditSavedID = g.ColorEditCurrentID; g.ColorEditSavedColor = ColorConvertFloat4ToU32(ImVec4(f[0], f[1], f[2], 0)); } if ((flags & ImGuiColorEditFlags_DisplayRGB) && (flags & ImGuiColorEditFlags_InputHSV)) ColorConvertRGBtoHSV(f[0], f[1], f[2], f[0], f[1], f[2]); col[0] = f[0]; col[1] = f[1]; col[2] = f[2]; if (alpha) col[3] = f[3]; } if (set_current_color_edit_id) g.ColorEditCurrentID = 0; PopID(); EndGroup(); // Drag and Drop Target // NB: The flag test is merely an optional micro-optimization, BeginDragDropTarget() does the same test. if ((g.LastItemData.StatusFlags & ImGuiItemStatusFlags_HoveredRect) && !(g.LastItemData.ItemFlags & ImGuiItemFlags_ReadOnly) && !(flags & ImGuiColorEditFlags_NoDragDrop) && BeginDragDropTarget()) { bool accepted_drag_drop = false; if (const ImGuiPayload* payload = AcceptDragDropPayload(IMGUI_PAYLOAD_TYPE_COLOR_3F)) { memcpy((float*)col, payload->Data, sizeof(float) * 3); // Preserve alpha if any //-V512 //-V1086 value_changed = accepted_drag_drop = true; } if (const ImGuiPayload* payload = AcceptDragDropPayload(IMGUI_PAYLOAD_TYPE_COLOR_4F)) { memcpy((float*)col, payload->Data, sizeof(float) * components); value_changed = accepted_drag_drop = true; } // Drag-drop payloads are always RGB if (accepted_drag_drop && (flags & ImGuiColorEditFlags_InputHSV)) ColorConvertRGBtoHSV(col[0], col[1], col[2], col[0], col[1], col[2]); EndDragDropTarget(); } // When picker is being actively used, use its active id so IsItemActive() will function on ColorEdit4(). if (picker_active_window && g.ActiveId != 0 && g.ActiveIdWindow == picker_active_window) g.LastItemData.ID = g.ActiveId; if (value_changed && g.LastItemData.ID != 0) // In case of ID collision, the second EndGroup() won't catch g.ActiveId MarkItemEdited(g.LastItemData.ID); return value_changed; } bool ImGui::ColorPicker3(const char* label, float col[3], ImGuiColorEditFlags flags) { float col4[4] = { col[0], col[1], col[2], 1.0f }; if (!ColorPicker4(label, col4, flags | ImGuiColorEditFlags_NoAlpha)) return false; col[0] = col4[0]; col[1] = col4[1]; col[2] = col4[2]; return true; } // Helper for ColorPicker4() static void RenderArrowsForVerticalBar(ImDrawList* draw_list, ImVec2 pos, ImVec2 half_sz, float bar_w, float alpha) { ImU32 alpha8 = IM_F32_TO_INT8_SAT(alpha); ImGui::RenderArrowPointingAt(draw_list, ImVec2(pos.x + half_sz.x + 1, pos.y), ImVec2(half_sz.x + 2, half_sz.y + 1), ImGuiDir_Right, IM_COL32(0,0,0,alpha8)); ImGui::RenderArrowPointingAt(draw_list, ImVec2(pos.x + half_sz.x, pos.y), half_sz, ImGuiDir_Right, IM_COL32(255,255,255,alpha8)); ImGui::RenderArrowPointingAt(draw_list, ImVec2(pos.x + bar_w - half_sz.x - 1, pos.y), ImVec2(half_sz.x + 2, half_sz.y + 1), ImGuiDir_Left, IM_COL32(0,0,0,alpha8)); ImGui::RenderArrowPointingAt(draw_list, ImVec2(pos.x + bar_w - half_sz.x, pos.y), half_sz, ImGuiDir_Left, IM_COL32(255,255,255,alpha8)); } // Note: ColorPicker4() only accesses 3 floats if ImGuiColorEditFlags_NoAlpha flag is set. // (In C++ the 'float col[4]' notation for a function argument is equivalent to 'float* col', we only specify a size to facilitate understanding of the code.) // FIXME: we adjust the big color square height based on item width, which may cause a flickering feedback loop (if automatic height makes a vertical scrollbar appears, affecting automatic width..) // FIXME: this is trying to be aware of style.Alpha but not fully correct. Also, the color wheel will have overlapping glitches with (style.Alpha < 1.0) bool ImGui::ColorPicker4(const char* label, float col[4], ImGuiColorEditFlags flags, const float* ref_col) { ImGuiContext& g = *GImGui; ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; ImDrawList* draw_list = window->DrawList; ImGuiStyle& style = g.Style; ImGuiIO& io = g.IO; const float width = CalcItemWidth(); const bool is_readonly = ((g.NextItemData.ItemFlags | g.CurrentItemFlags) & ImGuiItemFlags_ReadOnly) != 0; g.NextItemData.ClearFlags(); PushID(label); const bool set_current_color_edit_id = (g.ColorEditCurrentID == 0); if (set_current_color_edit_id) g.ColorEditCurrentID = window->IDStack.back(); BeginGroup(); if (!(flags & ImGuiColorEditFlags_NoSidePreview)) flags |= ImGuiColorEditFlags_NoSmallPreview; // Context menu: display and store options. if (!(flags & ImGuiColorEditFlags_NoOptions)) ColorPickerOptionsPopup(col, flags); // Read stored options if (!(flags & ImGuiColorEditFlags_PickerMask_)) flags |= ((g.ColorEditOptions & ImGuiColorEditFlags_PickerMask_) ? g.ColorEditOptions : ImGuiColorEditFlags_DefaultOptions_) & ImGuiColorEditFlags_PickerMask_; if (!(flags & ImGuiColorEditFlags_InputMask_)) flags |= ((g.ColorEditOptions & ImGuiColorEditFlags_InputMask_) ? g.ColorEditOptions : ImGuiColorEditFlags_DefaultOptions_) & ImGuiColorEditFlags_InputMask_; IM_ASSERT(ImIsPowerOfTwo(flags & ImGuiColorEditFlags_PickerMask_)); // Check that only 1 is selected IM_ASSERT(ImIsPowerOfTwo(flags & ImGuiColorEditFlags_InputMask_)); // Check that only 1 is selected if (!(flags & ImGuiColorEditFlags_NoOptions)) flags |= (g.ColorEditOptions & ImGuiColorEditFlags_AlphaBar); // Setup int components = (flags & ImGuiColorEditFlags_NoAlpha) ? 3 : 4; bool alpha_bar = (flags & ImGuiColorEditFlags_AlphaBar) && !(flags & ImGuiColorEditFlags_NoAlpha); ImVec2 picker_pos = window->DC.CursorPos; float square_sz = GetFrameHeight(); float bars_width = square_sz; // Arbitrary smallish width of Hue/Alpha picking bars float sv_picker_size = ImMax(bars_width * 1, width - (alpha_bar ? 2 : 1) * (bars_width + style.ItemInnerSpacing.x)); // Saturation/Value picking box float bar0_pos_x = picker_pos.x + sv_picker_size + style.ItemInnerSpacing.x; float bar1_pos_x = bar0_pos_x + bars_width + style.ItemInnerSpacing.x; float bars_triangles_half_sz = IM_TRUNC(bars_width * 0.20f); float backup_initial_col[4]; memcpy(backup_initial_col, col, components * sizeof(float)); float wheel_thickness = sv_picker_size * 0.08f; float wheel_r_outer = sv_picker_size * 0.50f; float wheel_r_inner = wheel_r_outer - wheel_thickness; ImVec2 wheel_center(picker_pos.x + (sv_picker_size + bars_width)*0.5f, picker_pos.y + sv_picker_size * 0.5f); // Note: the triangle is displayed rotated with triangle_pa pointing to Hue, but most coordinates stays unrotated for logic. float triangle_r = wheel_r_inner - (int)(sv_picker_size * 0.027f); ImVec2 triangle_pa = ImVec2(triangle_r, 0.0f); // Hue point. ImVec2 triangle_pb = ImVec2(triangle_r * -0.5f, triangle_r * -0.866025f); // Black point. ImVec2 triangle_pc = ImVec2(triangle_r * -0.5f, triangle_r * +0.866025f); // White point. float H = col[0], S = col[1], V = col[2]; float R = col[0], G = col[1], B = col[2]; if (flags & ImGuiColorEditFlags_InputRGB) { // Hue is lost when converting from grayscale rgb (saturation=0). Restore it. ColorConvertRGBtoHSV(R, G, B, H, S, V); ColorEditRestoreHS(col, &H, &S, &V); } else if (flags & ImGuiColorEditFlags_InputHSV) { ColorConvertHSVtoRGB(H, S, V, R, G, B); } bool value_changed = false, value_changed_h = false, value_changed_sv = false; PushItemFlag(ImGuiItemFlags_NoNav, true); if (flags & ImGuiColorEditFlags_PickerHueWheel) { // Hue wheel + SV triangle logic InvisibleButton("hsv", ImVec2(sv_picker_size + style.ItemInnerSpacing.x + bars_width, sv_picker_size)); if (IsItemActive() && !is_readonly) { ImVec2 initial_off = g.IO.MouseClickedPos[0] - wheel_center; ImVec2 current_off = g.IO.MousePos - wheel_center; float initial_dist2 = ImLengthSqr(initial_off); if (initial_dist2 >= (wheel_r_inner - 1) * (wheel_r_inner - 1) && initial_dist2 <= (wheel_r_outer + 1) * (wheel_r_outer + 1)) { // Interactive with Hue wheel H = ImAtan2(current_off.y, current_off.x) / IM_PI * 0.5f; if (H < 0.0f) H += 1.0f; value_changed = value_changed_h = true; } float cos_hue_angle = ImCos(-H * 2.0f * IM_PI); float sin_hue_angle = ImSin(-H * 2.0f * IM_PI); if (ImTriangleContainsPoint(triangle_pa, triangle_pb, triangle_pc, ImRotate(initial_off, cos_hue_angle, sin_hue_angle))) { // Interacting with SV triangle ImVec2 current_off_unrotated = ImRotate(current_off, cos_hue_angle, sin_hue_angle); if (!ImTriangleContainsPoint(triangle_pa, triangle_pb, triangle_pc, current_off_unrotated)) current_off_unrotated = ImTriangleClosestPoint(triangle_pa, triangle_pb, triangle_pc, current_off_unrotated); float uu, vv, ww; ImTriangleBarycentricCoords(triangle_pa, triangle_pb, triangle_pc, current_off_unrotated, uu, vv, ww); V = ImClamp(1.0f - vv, 0.0001f, 1.0f); S = ImClamp(uu / V, 0.0001f, 1.0f); value_changed = value_changed_sv = true; } } if (!(flags & ImGuiColorEditFlags_NoOptions)) OpenPopupOnItemClick("context", ImGuiPopupFlags_MouseButtonRight); } else if (flags & ImGuiColorEditFlags_PickerHueBar) { // SV rectangle logic InvisibleButton("sv", ImVec2(sv_picker_size, sv_picker_size)); if (IsItemActive() && !is_readonly) { S = ImSaturate((io.MousePos.x - picker_pos.x) / (sv_picker_size - 1)); V = 1.0f - ImSaturate((io.MousePos.y - picker_pos.y) / (sv_picker_size - 1)); ColorEditRestoreH(col, &H); // Greatly reduces hue jitter and reset to 0 when hue == 255 and color is rapidly modified using SV square. value_changed = value_changed_sv = true; } if (!(flags & ImGuiColorEditFlags_NoOptions)) OpenPopupOnItemClick("context", ImGuiPopupFlags_MouseButtonRight); // Hue bar logic SetCursorScreenPos(ImVec2(bar0_pos_x, picker_pos.y)); InvisibleButton("hue", ImVec2(bars_width, sv_picker_size)); if (IsItemActive() && !is_readonly) { H = ImSaturate((io.MousePos.y - picker_pos.y) / (sv_picker_size - 1)); value_changed = value_changed_h = true; } } // Alpha bar logic if (alpha_bar) { SetCursorScreenPos(ImVec2(bar1_pos_x, picker_pos.y)); InvisibleButton("alpha", ImVec2(bars_width, sv_picker_size)); if (IsItemActive()) { col[3] = 1.0f - ImSaturate((io.MousePos.y - picker_pos.y) / (sv_picker_size - 1)); value_changed = true; } } PopItemFlag(); // ImGuiItemFlags_NoNav if (!(flags & ImGuiColorEditFlags_NoSidePreview)) { SameLine(0, style.ItemInnerSpacing.x); BeginGroup(); } if (!(flags & ImGuiColorEditFlags_NoLabel)) { const char* label_display_end = FindRenderedTextEnd(label); if (label != label_display_end) { if ((flags & ImGuiColorEditFlags_NoSidePreview)) SameLine(0, style.ItemInnerSpacing.x); TextEx(label, label_display_end); } } if (!(flags & ImGuiColorEditFlags_NoSidePreview)) { PushItemFlag(ImGuiItemFlags_NoNavDefaultFocus, true); ImVec4 col_v4(col[0], col[1], col[2], (flags & ImGuiColorEditFlags_NoAlpha) ? 1.0f : col[3]); if ((flags & ImGuiColorEditFlags_NoLabel)) Text("Current"); ImGuiColorEditFlags sub_flags_to_forward = ImGuiColorEditFlags_InputMask_ | ImGuiColorEditFlags_HDR | ImGuiColorEditFlags_AlphaMask_ | ImGuiColorEditFlags_NoTooltip; ColorButton("##current", col_v4, (flags & sub_flags_to_forward), ImVec2(square_sz * 3, square_sz * 2)); if (ref_col != NULL) { Text("Original"); ImVec4 ref_col_v4(ref_col[0], ref_col[1], ref_col[2], (flags & ImGuiColorEditFlags_NoAlpha) ? 1.0f : ref_col[3]); if (ColorButton("##original", ref_col_v4, (flags & sub_flags_to_forward), ImVec2(square_sz * 3, square_sz * 2))) { memcpy(col, ref_col, components * sizeof(float)); value_changed = true; } } PopItemFlag(); EndGroup(); } // Convert back color to RGB if (value_changed_h || value_changed_sv) { if (flags & ImGuiColorEditFlags_InputRGB) { ColorConvertHSVtoRGB(H, S, V, col[0], col[1], col[2]); g.ColorEditSavedHue = H; g.ColorEditSavedSat = S; g.ColorEditSavedID = g.ColorEditCurrentID; g.ColorEditSavedColor = ColorConvertFloat4ToU32(ImVec4(col[0], col[1], col[2], 0)); } else if (flags & ImGuiColorEditFlags_InputHSV) { col[0] = H; col[1] = S; col[2] = V; } } // R,G,B and H,S,V slider color editor bool value_changed_fix_hue_wrap = false; if ((flags & ImGuiColorEditFlags_NoInputs) == 0) { PushItemWidth((alpha_bar ? bar1_pos_x : bar0_pos_x) + bars_width - picker_pos.x); ImGuiColorEditFlags sub_flags_to_forward = ImGuiColorEditFlags_DataTypeMask_ | ImGuiColorEditFlags_InputMask_ | ImGuiColorEditFlags_HDR | ImGuiColorEditFlags_AlphaMask_ | ImGuiColorEditFlags_NoOptions | ImGuiColorEditFlags_NoTooltip | ImGuiColorEditFlags_NoSmallPreview; ImGuiColorEditFlags sub_flags = (flags & sub_flags_to_forward) | ImGuiColorEditFlags_NoPicker; if (flags & ImGuiColorEditFlags_DisplayRGB || (flags & ImGuiColorEditFlags_DisplayMask_) == 0) if (ColorEdit4("##rgb", col, sub_flags | ImGuiColorEditFlags_DisplayRGB)) { // FIXME: Hackily differentiating using the DragInt (ActiveId != 0 && !ActiveIdAllowOverlap) vs. using the InputText or DropTarget. // For the later we don't want to run the hue-wrap canceling code. If you are well versed in HSV picker please provide your input! (See #2050) value_changed_fix_hue_wrap = (g.ActiveId != 0 && !g.ActiveIdAllowOverlap); value_changed = true; } if (flags & ImGuiColorEditFlags_DisplayHSV || (flags & ImGuiColorEditFlags_DisplayMask_) == 0) value_changed |= ColorEdit4("##hsv", col, sub_flags | ImGuiColorEditFlags_DisplayHSV); if (flags & ImGuiColorEditFlags_DisplayHex || (flags & ImGuiColorEditFlags_DisplayMask_) == 0) value_changed |= ColorEdit4("##hex", col, sub_flags | ImGuiColorEditFlags_DisplayHex); PopItemWidth(); } // Try to cancel hue wrap (after ColorEdit4 call), if any if (value_changed_fix_hue_wrap && (flags & ImGuiColorEditFlags_InputRGB)) { float new_H, new_S, new_V; ColorConvertRGBtoHSV(col[0], col[1], col[2], new_H, new_S, new_V); if (new_H <= 0 && H > 0) { if (new_V <= 0 && V != new_V) ColorConvertHSVtoRGB(H, S, new_V <= 0 ? V * 0.5f : new_V, col[0], col[1], col[2]); else if (new_S <= 0) ColorConvertHSVtoRGB(H, new_S <= 0 ? S * 0.5f : new_S, new_V, col[0], col[1], col[2]); } } if (value_changed) { if (flags & ImGuiColorEditFlags_InputRGB) { R = col[0]; G = col[1]; B = col[2]; ColorConvertRGBtoHSV(R, G, B, H, S, V); ColorEditRestoreHS(col, &H, &S, &V); // Fix local Hue as display below will use it immediately. } else if (flags & ImGuiColorEditFlags_InputHSV) { H = col[0]; S = col[1]; V = col[2]; ColorConvertHSVtoRGB(H, S, V, R, G, B); } } const int style_alpha8 = IM_F32_TO_INT8_SAT(style.Alpha); const ImU32 col_black = IM_COL32(0,0,0,style_alpha8); const ImU32 col_white = IM_COL32(255,255,255,style_alpha8); const ImU32 col_midgrey = IM_COL32(128,128,128,style_alpha8); const ImU32 col_hues[6 + 1] = { IM_COL32(255,0,0,style_alpha8), IM_COL32(255,255,0,style_alpha8), IM_COL32(0,255,0,style_alpha8), IM_COL32(0,255,255,style_alpha8), IM_COL32(0,0,255,style_alpha8), IM_COL32(255,0,255,style_alpha8), IM_COL32(255,0,0,style_alpha8) }; ImVec4 hue_color_f(1, 1, 1, style.Alpha); ColorConvertHSVtoRGB(H, 1, 1, hue_color_f.x, hue_color_f.y, hue_color_f.z); ImU32 hue_color32 = ColorConvertFloat4ToU32(hue_color_f); ImU32 user_col32_striped_of_alpha = ColorConvertFloat4ToU32(ImVec4(R, G, B, style.Alpha)); // Important: this is still including the main rendering/style alpha!! ImVec2 sv_cursor_pos; if (flags & ImGuiColorEditFlags_PickerHueWheel) { // Render Hue Wheel const float aeps = 0.5f / wheel_r_outer; // Half a pixel arc length in radians (2pi cancels out). const int segment_per_arc = ImMax(4, (int)wheel_r_outer / 12); for (int n = 0; n < 6; n++) { const float a0 = (n) /6.0f * 2.0f * IM_PI - aeps; const float a1 = (n+1.0f)/6.0f * 2.0f * IM_PI + aeps; const int vert_start_idx = draw_list->VtxBuffer.Size; draw_list->PathArcTo(wheel_center, (wheel_r_inner + wheel_r_outer)*0.5f, a0, a1, segment_per_arc); draw_list->PathStroke(col_white, 0, wheel_thickness); const int vert_end_idx = draw_list->VtxBuffer.Size; // Paint colors over existing vertices ImVec2 gradient_p0(wheel_center.x + ImCos(a0) * wheel_r_inner, wheel_center.y + ImSin(a0) * wheel_r_inner); ImVec2 gradient_p1(wheel_center.x + ImCos(a1) * wheel_r_inner, wheel_center.y + ImSin(a1) * wheel_r_inner); ShadeVertsLinearColorGradientKeepAlpha(draw_list, vert_start_idx, vert_end_idx, gradient_p0, gradient_p1, col_hues[n], col_hues[n + 1]); } // Render Cursor + preview on Hue Wheel float cos_hue_angle = ImCos(H * 2.0f * IM_PI); float sin_hue_angle = ImSin(H * 2.0f * IM_PI); ImVec2 hue_cursor_pos(wheel_center.x + cos_hue_angle * (wheel_r_inner + wheel_r_outer) * 0.5f, wheel_center.y + sin_hue_angle * (wheel_r_inner + wheel_r_outer) * 0.5f); float hue_cursor_rad = value_changed_h ? wheel_thickness * 0.65f : wheel_thickness * 0.55f; int hue_cursor_segments = draw_list->_CalcCircleAutoSegmentCount(hue_cursor_rad); // Lock segment count so the +1 one matches others. draw_list->AddCircleFilled(hue_cursor_pos, hue_cursor_rad, hue_color32, hue_cursor_segments); draw_list->AddCircle(hue_cursor_pos, hue_cursor_rad + 1, col_midgrey, hue_cursor_segments); draw_list->AddCircle(hue_cursor_pos, hue_cursor_rad, col_white, hue_cursor_segments); // Render SV triangle (rotated according to hue) ImVec2 tra = wheel_center + ImRotate(triangle_pa, cos_hue_angle, sin_hue_angle); ImVec2 trb = wheel_center + ImRotate(triangle_pb, cos_hue_angle, sin_hue_angle); ImVec2 trc = wheel_center + ImRotate(triangle_pc, cos_hue_angle, sin_hue_angle); ImVec2 uv_white = GetFontTexUvWhitePixel(); draw_list->PrimReserve(3, 3); draw_list->PrimVtx(tra, uv_white, hue_color32); draw_list->PrimVtx(trb, uv_white, col_black); draw_list->PrimVtx(trc, uv_white, col_white); draw_list->AddTriangle(tra, trb, trc, col_midgrey, 1.5f); sv_cursor_pos = ImLerp(ImLerp(trc, tra, ImSaturate(S)), trb, ImSaturate(1 - V)); } else if (flags & ImGuiColorEditFlags_PickerHueBar) { // Render SV Square draw_list->AddRectFilledMultiColor(picker_pos, picker_pos + ImVec2(sv_picker_size, sv_picker_size), col_white, hue_color32, hue_color32, col_white); draw_list->AddRectFilledMultiColor(picker_pos, picker_pos + ImVec2(sv_picker_size, sv_picker_size), 0, 0, col_black, col_black); RenderFrameBorder(picker_pos, picker_pos + ImVec2(sv_picker_size, sv_picker_size), 0.0f); sv_cursor_pos.x = ImClamp(IM_ROUND(picker_pos.x + ImSaturate(S) * sv_picker_size), picker_pos.x + 2, picker_pos.x + sv_picker_size - 2); // Sneakily prevent the circle to stick out too much sv_cursor_pos.y = ImClamp(IM_ROUND(picker_pos.y + ImSaturate(1 - V) * sv_picker_size), picker_pos.y + 2, picker_pos.y + sv_picker_size - 2); // Render Hue Bar for (int i = 0; i < 6; ++i) draw_list->AddRectFilledMultiColor(ImVec2(bar0_pos_x, picker_pos.y + i * (sv_picker_size / 6)), ImVec2(bar0_pos_x + bars_width, picker_pos.y + (i + 1) * (sv_picker_size / 6)), col_hues[i], col_hues[i], col_hues[i + 1], col_hues[i + 1]); float bar0_line_y = IM_ROUND(picker_pos.y + H * sv_picker_size); RenderFrameBorder(ImVec2(bar0_pos_x, picker_pos.y), ImVec2(bar0_pos_x + bars_width, picker_pos.y + sv_picker_size), 0.0f); RenderArrowsForVerticalBar(draw_list, ImVec2(bar0_pos_x - 1, bar0_line_y), ImVec2(bars_triangles_half_sz + 1, bars_triangles_half_sz), bars_width + 2.0f, style.Alpha); } // Render cursor/preview circle (clamp S/V within 0..1 range because floating points colors may lead HSV values to be out of range) float sv_cursor_rad = value_changed_sv ? wheel_thickness * 0.55f : wheel_thickness * 0.40f; int sv_cursor_segments = draw_list->_CalcCircleAutoSegmentCount(sv_cursor_rad); // Lock segment count so the +1 one matches others. draw_list->AddCircleFilled(sv_cursor_pos, sv_cursor_rad, user_col32_striped_of_alpha, sv_cursor_segments); draw_list->AddCircle(sv_cursor_pos, sv_cursor_rad + 1, col_midgrey, sv_cursor_segments); draw_list->AddCircle(sv_cursor_pos, sv_cursor_rad, col_white, sv_cursor_segments); // Render alpha bar if (alpha_bar) { float alpha = ImSaturate(col[3]); ImRect bar1_bb(bar1_pos_x, picker_pos.y, bar1_pos_x + bars_width, picker_pos.y + sv_picker_size); RenderColorRectWithAlphaCheckerboard(draw_list, bar1_bb.Min, bar1_bb.Max, 0, bar1_bb.GetWidth() / 2.0f, ImVec2(0.0f, 0.0f)); draw_list->AddRectFilledMultiColor(bar1_bb.Min, bar1_bb.Max, user_col32_striped_of_alpha, user_col32_striped_of_alpha, user_col32_striped_of_alpha & ~IM_COL32_A_MASK, user_col32_striped_of_alpha & ~IM_COL32_A_MASK); float bar1_line_y = IM_ROUND(picker_pos.y + (1.0f - alpha) * sv_picker_size); RenderFrameBorder(bar1_bb.Min, bar1_bb.Max, 0.0f); RenderArrowsForVerticalBar(draw_list, ImVec2(bar1_pos_x - 1, bar1_line_y), ImVec2(bars_triangles_half_sz + 1, bars_triangles_half_sz), bars_width + 2.0f, style.Alpha); } EndGroup(); if (value_changed && memcmp(backup_initial_col, col, components * sizeof(float)) == 0) value_changed = false; if (value_changed && g.LastItemData.ID != 0) // In case of ID collision, the second EndGroup() won't catch g.ActiveId MarkItemEdited(g.LastItemData.ID); if (set_current_color_edit_id) g.ColorEditCurrentID = 0; PopID(); return value_changed; } // A little color square. Return true when clicked. // FIXME: May want to display/ignore the alpha component in the color display? Yet show it in the tooltip. // 'desc_id' is not called 'label' because we don't display it next to the button, but only in the tooltip. // Note that 'col' may be encoded in HSV if ImGuiColorEditFlags_InputHSV is set. bool ImGui::ColorButton(const char* desc_id, const ImVec4& col, ImGuiColorEditFlags flags, const ImVec2& size_arg) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; ImGuiContext& g = *GImGui; const ImGuiID id = window->GetID(desc_id); const float default_size = GetFrameHeight(); const ImVec2 size(size_arg.x == 0.0f ? default_size : size_arg.x, size_arg.y == 0.0f ? default_size : size_arg.y); const ImRect bb(window->DC.CursorPos, window->DC.CursorPos + size); ItemSize(bb, (size.y >= default_size) ? g.Style.FramePadding.y : 0.0f); if (!ItemAdd(bb, id)) return false; bool hovered, held; bool pressed = ButtonBehavior(bb, id, &hovered, &held); if (flags & (ImGuiColorEditFlags_NoAlpha | ImGuiColorEditFlags_AlphaOpaque)) flags &= ~(ImGuiColorEditFlags_AlphaNoBg | ImGuiColorEditFlags_AlphaPreviewHalf); ImVec4 col_rgb = col; if (flags & ImGuiColorEditFlags_InputHSV) ColorConvertHSVtoRGB(col_rgb.x, col_rgb.y, col_rgb.z, col_rgb.x, col_rgb.y, col_rgb.z); ImVec4 col_rgb_without_alpha(col_rgb.x, col_rgb.y, col_rgb.z, 1.0f); float grid_step = ImMin(size.x, size.y) / 2.99f; float rounding = ImMin(g.Style.FrameRounding, grid_step * 0.5f); ImRect bb_inner = bb; float off = 0.0f; if ((flags & ImGuiColorEditFlags_NoBorder) == 0) { off = -0.75f; // The border (using Col_FrameBg) tends to look off when color is near-opaque and rounding is enabled. This offset seemed like a good middle ground to reduce those artifacts. bb_inner.Expand(off); } if ((flags & ImGuiColorEditFlags_AlphaPreviewHalf) && col_rgb.w < 1.0f) { float mid_x = IM_ROUND((bb_inner.Min.x + bb_inner.Max.x) * 0.5f); if ((flags & ImGuiColorEditFlags_AlphaNoBg) == 0) RenderColorRectWithAlphaCheckerboard(window->DrawList, ImVec2(bb_inner.Min.x + grid_step, bb_inner.Min.y), bb_inner.Max, GetColorU32(col_rgb), grid_step, ImVec2(-grid_step + off, off), rounding, ImDrawFlags_RoundCornersRight); else window->DrawList->AddRectFilled(ImVec2(bb_inner.Min.x + grid_step, bb_inner.Min.y), bb_inner.Max, GetColorU32(col_rgb), rounding, ImDrawFlags_RoundCornersRight); window->DrawList->AddRectFilled(bb_inner.Min, ImVec2(mid_x, bb_inner.Max.y), GetColorU32(col_rgb_without_alpha), rounding, ImDrawFlags_RoundCornersLeft); } else { // Because GetColorU32() multiplies by the global style Alpha and we don't want to display a checkerboard if the source code had no alpha ImVec4 col_source = (flags & ImGuiColorEditFlags_AlphaOpaque) ? col_rgb_without_alpha : col_rgb; if (col_source.w < 1.0f && (flags & ImGuiColorEditFlags_AlphaNoBg) == 0) RenderColorRectWithAlphaCheckerboard(window->DrawList, bb_inner.Min, bb_inner.Max, GetColorU32(col_source), grid_step, ImVec2(off, off), rounding); else window->DrawList->AddRectFilled(bb_inner.Min, bb_inner.Max, GetColorU32(col_source), rounding); } RenderNavCursor(bb, id); if ((flags & ImGuiColorEditFlags_NoBorder) == 0) { if (g.Style.FrameBorderSize > 0.0f) RenderFrameBorder(bb.Min, bb.Max, rounding); else window->DrawList->AddRect(bb.Min, bb.Max, GetColorU32(ImGuiCol_FrameBg), rounding); // Color buttons are often in need of some sort of border } // Drag and Drop Source // NB: The ActiveId test is merely an optional micro-optimization, BeginDragDropSource() does the same test. if (g.ActiveId == id && !(flags & ImGuiColorEditFlags_NoDragDrop) && BeginDragDropSource()) { if (flags & ImGuiColorEditFlags_NoAlpha) SetDragDropPayload(IMGUI_PAYLOAD_TYPE_COLOR_3F, &col_rgb, sizeof(float) * 3, ImGuiCond_Once); else SetDragDropPayload(IMGUI_PAYLOAD_TYPE_COLOR_4F, &col_rgb, sizeof(float) * 4, ImGuiCond_Once); ColorButton(desc_id, col, flags); SameLine(); TextEx("Color"); EndDragDropSource(); } // Tooltip if (!(flags & ImGuiColorEditFlags_NoTooltip) && hovered && IsItemHovered(ImGuiHoveredFlags_ForTooltip)) ColorTooltip(desc_id, &col.x, flags & (ImGuiColorEditFlags_InputMask_ | ImGuiColorEditFlags_AlphaMask_)); return pressed; } // Initialize/override default color options void ImGui::SetColorEditOptions(ImGuiColorEditFlags flags) { ImGuiContext& g = *GImGui; if ((flags & ImGuiColorEditFlags_DisplayMask_) == 0) flags |= ImGuiColorEditFlags_DefaultOptions_ & ImGuiColorEditFlags_DisplayMask_; if ((flags & ImGuiColorEditFlags_DataTypeMask_) == 0) flags |= ImGuiColorEditFlags_DefaultOptions_ & ImGuiColorEditFlags_DataTypeMask_; if ((flags & ImGuiColorEditFlags_PickerMask_) == 0) flags |= ImGuiColorEditFlags_DefaultOptions_ & ImGuiColorEditFlags_PickerMask_; if ((flags & ImGuiColorEditFlags_InputMask_) == 0) flags |= ImGuiColorEditFlags_DefaultOptions_ & ImGuiColorEditFlags_InputMask_; IM_ASSERT(ImIsPowerOfTwo(flags & ImGuiColorEditFlags_DisplayMask_)); // Check only 1 option is selected IM_ASSERT(ImIsPowerOfTwo(flags & ImGuiColorEditFlags_DataTypeMask_)); // Check only 1 option is selected IM_ASSERT(ImIsPowerOfTwo(flags & ImGuiColorEditFlags_PickerMask_)); // Check only 1 option is selected IM_ASSERT(ImIsPowerOfTwo(flags & ImGuiColorEditFlags_InputMask_)); // Check only 1 option is selected g.ColorEditOptions = flags; } // Note: only access 3 floats if ImGuiColorEditFlags_NoAlpha flag is set. void ImGui::ColorTooltip(const char* text, const float* col, ImGuiColorEditFlags flags) { ImGuiContext& g = *GImGui; if (!BeginTooltipEx(ImGuiTooltipFlags_OverridePrevious, ImGuiWindowFlags_None)) return; const char* text_end = text ? FindRenderedTextEnd(text, NULL) : text; if (text_end > text) { TextEx(text, text_end); Separator(); } ImVec2 sz(g.FontSize * 3 + g.Style.FramePadding.y * 2, g.FontSize * 3 + g.Style.FramePadding.y * 2); ImVec4 cf(col[0], col[1], col[2], (flags & ImGuiColorEditFlags_NoAlpha) ? 1.0f : col[3]); int cr = IM_F32_TO_INT8_SAT(col[0]), cg = IM_F32_TO_INT8_SAT(col[1]), cb = IM_F32_TO_INT8_SAT(col[2]), ca = (flags & ImGuiColorEditFlags_NoAlpha) ? 255 : IM_F32_TO_INT8_SAT(col[3]); ImGuiColorEditFlags flags_to_forward = ImGuiColorEditFlags_InputMask_ | ImGuiColorEditFlags_AlphaMask_; ColorButton("##preview", cf, (flags & flags_to_forward) | ImGuiColorEditFlags_NoTooltip, sz); SameLine(); if ((flags & ImGuiColorEditFlags_InputRGB) || !(flags & ImGuiColorEditFlags_InputMask_)) { if (flags & ImGuiColorEditFlags_NoAlpha) Text("#%02X%02X%02X\nR: %d, G: %d, B: %d\n(%.3f, %.3f, %.3f)", cr, cg, cb, cr, cg, cb, col[0], col[1], col[2]); else Text("#%02X%02X%02X%02X\nR:%d, G:%d, B:%d, A:%d\n(%.3f, %.3f, %.3f, %.3f)", cr, cg, cb, ca, cr, cg, cb, ca, col[0], col[1], col[2], col[3]); } else if (flags & ImGuiColorEditFlags_InputHSV) { if (flags & ImGuiColorEditFlags_NoAlpha) Text("H: %.3f, S: %.3f, V: %.3f", col[0], col[1], col[2]); else Text("H: %.3f, S: %.3f, V: %.3f, A: %.3f", col[0], col[1], col[2], col[3]); } EndTooltip(); } void ImGui::ColorEditOptionsPopup(const float* col, ImGuiColorEditFlags flags) { bool allow_opt_inputs = !(flags & ImGuiColorEditFlags_DisplayMask_); bool allow_opt_datatype = !(flags & ImGuiColorEditFlags_DataTypeMask_); if ((!allow_opt_inputs && !allow_opt_datatype) || !BeginPopup("context")) return; ImGuiContext& g = *GImGui; PushItemFlag(ImGuiItemFlags_NoMarkEdited, true); ImGuiColorEditFlags opts = g.ColorEditOptions; if (allow_opt_inputs) { if (RadioButton("RGB", (opts & ImGuiColorEditFlags_DisplayRGB) != 0)) opts = (opts & ~ImGuiColorEditFlags_DisplayMask_) | ImGuiColorEditFlags_DisplayRGB; if (RadioButton("HSV", (opts & ImGuiColorEditFlags_DisplayHSV) != 0)) opts = (opts & ~ImGuiColorEditFlags_DisplayMask_) | ImGuiColorEditFlags_DisplayHSV; if (RadioButton("Hex", (opts & ImGuiColorEditFlags_DisplayHex) != 0)) opts = (opts & ~ImGuiColorEditFlags_DisplayMask_) | ImGuiColorEditFlags_DisplayHex; } if (allow_opt_datatype) { if (allow_opt_inputs) Separator(); if (RadioButton("0..255", (opts & ImGuiColorEditFlags_Uint8) != 0)) opts = (opts & ~ImGuiColorEditFlags_DataTypeMask_) | ImGuiColorEditFlags_Uint8; if (RadioButton("0.00..1.00", (opts & ImGuiColorEditFlags_Float) != 0)) opts = (opts & ~ImGuiColorEditFlags_DataTypeMask_) | ImGuiColorEditFlags_Float; } if (allow_opt_inputs || allow_opt_datatype) Separator(); if (Button("Copy as..", ImVec2(-1, 0))) OpenPopup("Copy"); if (BeginPopup("Copy")) { int cr = IM_F32_TO_INT8_SAT(col[0]), cg = IM_F32_TO_INT8_SAT(col[1]), cb = IM_F32_TO_INT8_SAT(col[2]), ca = (flags & ImGuiColorEditFlags_NoAlpha) ? 255 : IM_F32_TO_INT8_SAT(col[3]); char buf[64]; ImFormatString(buf, IM_ARRAYSIZE(buf), "(%.3ff, %.3ff, %.3ff, %.3ff)", col[0], col[1], col[2], (flags & ImGuiColorEditFlags_NoAlpha) ? 1.0f : col[3]); if (Selectable(buf)) SetClipboardText(buf); ImFormatString(buf, IM_ARRAYSIZE(buf), "(%d,%d,%d,%d)", cr, cg, cb, ca); if (Selectable(buf)) SetClipboardText(buf); ImFormatString(buf, IM_ARRAYSIZE(buf), "#%02X%02X%02X", cr, cg, cb); if (Selectable(buf)) SetClipboardText(buf); if (!(flags & ImGuiColorEditFlags_NoAlpha)) { ImFormatString(buf, IM_ARRAYSIZE(buf), "#%02X%02X%02X%02X", cr, cg, cb, ca); if (Selectable(buf)) SetClipboardText(buf); } EndPopup(); } g.ColorEditOptions = opts; PopItemFlag(); EndPopup(); } void ImGui::ColorPickerOptionsPopup(const float* ref_col, ImGuiColorEditFlags flags) { bool allow_opt_picker = !(flags & ImGuiColorEditFlags_PickerMask_); bool allow_opt_alpha_bar = !(flags & ImGuiColorEditFlags_NoAlpha) && !(flags & ImGuiColorEditFlags_AlphaBar); if ((!allow_opt_picker && !allow_opt_alpha_bar) || !BeginPopup("context")) return; ImGuiContext& g = *GImGui; PushItemFlag(ImGuiItemFlags_NoMarkEdited, true); if (allow_opt_picker) { ImVec2 picker_size(g.FontSize * 8, ImMax(g.FontSize * 8 - (GetFrameHeight() + g.Style.ItemInnerSpacing.x), 1.0f)); // FIXME: Picker size copied from main picker function PushItemWidth(picker_size.x); for (int picker_type = 0; picker_type < 2; picker_type++) { // Draw small/thumbnail version of each picker type (over an invisible button for selection) if (picker_type > 0) Separator(); PushID(picker_type); ImGuiColorEditFlags picker_flags = ImGuiColorEditFlags_NoInputs | ImGuiColorEditFlags_NoOptions | ImGuiColorEditFlags_NoLabel | ImGuiColorEditFlags_NoSidePreview | (flags & ImGuiColorEditFlags_NoAlpha); if (picker_type == 0) picker_flags |= ImGuiColorEditFlags_PickerHueBar; if (picker_type == 1) picker_flags |= ImGuiColorEditFlags_PickerHueWheel; ImVec2 backup_pos = GetCursorScreenPos(); if (Selectable("##selectable", false, 0, picker_size)) // By default, Selectable() is closing popup g.ColorEditOptions = (g.ColorEditOptions & ~ImGuiColorEditFlags_PickerMask_) | (picker_flags & ImGuiColorEditFlags_PickerMask_); SetCursorScreenPos(backup_pos); ImVec4 previewing_ref_col; memcpy(&previewing_ref_col, ref_col, sizeof(float) * ((picker_flags & ImGuiColorEditFlags_NoAlpha) ? 3 : 4)); ColorPicker4("##previewing_picker", &previewing_ref_col.x, picker_flags); PopID(); } PopItemWidth(); } if (allow_opt_alpha_bar) { if (allow_opt_picker) Separator(); CheckboxFlags("Alpha Bar", &g.ColorEditOptions, ImGuiColorEditFlags_AlphaBar); } PopItemFlag(); EndPopup(); } //------------------------------------------------------------------------- // [SECTION] Widgets: TreeNode, CollapsingHeader, etc. //------------------------------------------------------------------------- // - TreeNode() // - TreeNodeV() // - TreeNodeEx() // - TreeNodeExV() // - TreeNodeBehavior() [Internal] // - TreePush() // - TreePop() // - GetTreeNodeToLabelSpacing() // - SetNextItemOpen() // - CollapsingHeader() //------------------------------------------------------------------------- bool ImGui::TreeNode(const char* str_id, const char* fmt, ...) { va_list args; va_start(args, fmt); bool is_open = TreeNodeExV(str_id, 0, fmt, args); va_end(args); return is_open; } bool ImGui::TreeNode(const void* ptr_id, const char* fmt, ...) { va_list args; va_start(args, fmt); bool is_open = TreeNodeExV(ptr_id, 0, fmt, args); va_end(args); return is_open; } bool ImGui::TreeNode(const char* label) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; ImGuiID id = window->GetID(label); return TreeNodeBehavior(id, ImGuiTreeNodeFlags_None, label, NULL); } bool ImGui::TreeNodeV(const char* str_id, const char* fmt, va_list args) { return TreeNodeExV(str_id, 0, fmt, args); } bool ImGui::TreeNodeV(const void* ptr_id, const char* fmt, va_list args) { return TreeNodeExV(ptr_id, 0, fmt, args); } bool ImGui::TreeNodeEx(const char* label, ImGuiTreeNodeFlags flags) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; ImGuiID id = window->GetID(label); return TreeNodeBehavior(id, flags, label, NULL); } bool ImGui::TreeNodeEx(const char* str_id, ImGuiTreeNodeFlags flags, const char* fmt, ...) { va_list args; va_start(args, fmt); bool is_open = TreeNodeExV(str_id, flags, fmt, args); va_end(args); return is_open; } bool ImGui::TreeNodeEx(const void* ptr_id, ImGuiTreeNodeFlags flags, const char* fmt, ...) { va_list args; va_start(args, fmt); bool is_open = TreeNodeExV(ptr_id, flags, fmt, args); va_end(args); return is_open; } bool ImGui::TreeNodeExV(const char* str_id, ImGuiTreeNodeFlags flags, const char* fmt, va_list args) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; ImGuiID id = window->GetID(str_id); const char* label, *label_end; ImFormatStringToTempBufferV(&label, &label_end, fmt, args); return TreeNodeBehavior(id, flags, label, label_end); } bool ImGui::TreeNodeExV(const void* ptr_id, ImGuiTreeNodeFlags flags, const char* fmt, va_list args) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; ImGuiID id = window->GetID(ptr_id); const char* label, *label_end; ImFormatStringToTempBufferV(&label, &label_end, fmt, args); return TreeNodeBehavior(id, flags, label, label_end); } bool ImGui::TreeNodeGetOpen(ImGuiID storage_id) { ImGuiContext& g = *GImGui; ImGuiStorage* storage = g.CurrentWindow->DC.StateStorage; return storage->GetInt(storage_id, 0) != 0; } void ImGui::TreeNodeSetOpen(ImGuiID storage_id, bool open) { ImGuiContext& g = *GImGui; ImGuiStorage* storage = g.CurrentWindow->DC.StateStorage; storage->SetInt(storage_id, open ? 1 : 0); } bool ImGui::TreeNodeUpdateNextOpen(ImGuiID storage_id, ImGuiTreeNodeFlags flags) { if (flags & ImGuiTreeNodeFlags_Leaf) return true; // We only write to the tree storage if the user clicks, or explicitly use the SetNextItemOpen function ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; ImGuiStorage* storage = window->DC.StateStorage; bool is_open; if (g.NextItemData.HasFlags & ImGuiNextItemDataFlags_HasOpen) { if (g.NextItemData.OpenCond & ImGuiCond_Always) { is_open = g.NextItemData.OpenVal; TreeNodeSetOpen(storage_id, is_open); } else { // We treat ImGuiCond_Once and ImGuiCond_FirstUseEver the same because tree node state are not saved persistently. const int stored_value = storage->GetInt(storage_id, -1); if (stored_value == -1) { is_open = g.NextItemData.OpenVal; TreeNodeSetOpen(storage_id, is_open); } else { is_open = stored_value != 0; } } } else { is_open = storage->GetInt(storage_id, (flags & ImGuiTreeNodeFlags_DefaultOpen) ? 1 : 0) != 0; } // When logging is enabled, we automatically expand tree nodes (but *NOT* collapsing headers.. seems like sensible behavior). // NB- If we are above max depth we still allow manually opened nodes to be logged. if (g.LogEnabled && !(flags & ImGuiTreeNodeFlags_NoAutoOpenOnLog) && (window->DC.TreeDepth - g.LogDepthRef) < g.LogDepthToExpand) is_open = true; return is_open; } // Store ImGuiTreeNodeStackData for just submitted node. // Currently only supports 32 level deep and we are fine with (1 << Depth) overflowing into a zero, easy to increase. static void TreeNodeStoreStackData(ImGuiTreeNodeFlags flags) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; g.TreeNodeStack.resize(g.TreeNodeStack.Size + 1); ImGuiTreeNodeStackData* tree_node_data = &g.TreeNodeStack.back(); tree_node_data->ID = g.LastItemData.ID; tree_node_data->TreeFlags = flags; tree_node_data->ItemFlags = g.LastItemData.ItemFlags; tree_node_data->NavRect = g.LastItemData.NavRect; window->DC.TreeHasStackDataDepthMask |= (1 << window->DC.TreeDepth); } // When using public API, currently 'id == storage_id' is always true, but we separate the values to facilitate advanced user code doing storage queries outside of UI loop. bool ImGui::TreeNodeBehavior(ImGuiID id, ImGuiTreeNodeFlags flags, const char* label, const char* label_end) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; ImGuiContext& g = *GImGui; const ImGuiStyle& style = g.Style; const bool display_frame = (flags & ImGuiTreeNodeFlags_Framed) != 0; const ImVec2 padding = (display_frame || (flags & ImGuiTreeNodeFlags_FramePadding)) ? style.FramePadding : ImVec2(style.FramePadding.x, ImMin(window->DC.CurrLineTextBaseOffset, style.FramePadding.y)); if (!label_end) label_end = FindRenderedTextEnd(label); const ImVec2 label_size = CalcTextSize(label, label_end, false); const float text_offset_x = g.FontSize + (display_frame ? padding.x * 3 : padding.x * 2); // Collapsing arrow width + Spacing const float text_offset_y = ImMax(padding.y, window->DC.CurrLineTextBaseOffset); // Latch before ItemSize changes it const float text_width = g.FontSize + label_size.x + padding.x * 2; // Include collapsing arrow // We vertically grow up to current line height up the typical widget height. const float frame_height = ImMax(ImMin(window->DC.CurrLineSize.y, g.FontSize + style.FramePadding.y * 2), label_size.y + padding.y * 2); const bool span_all_columns = (flags & ImGuiTreeNodeFlags_SpanAllColumns) != 0 && (g.CurrentTable != NULL); const bool span_all_columns_label = (flags & ImGuiTreeNodeFlags_LabelSpanAllColumns) != 0 && (g.CurrentTable != NULL); ImRect frame_bb; frame_bb.Min.x = span_all_columns ? window->ParentWorkRect.Min.x : (flags & ImGuiTreeNodeFlags_SpanFullWidth) ? window->WorkRect.Min.x : window->DC.CursorPos.x; frame_bb.Min.y = window->DC.CursorPos.y; frame_bb.Max.x = span_all_columns ? window->ParentWorkRect.Max.x : (flags & ImGuiTreeNodeFlags_SpanLabelWidth) ? window->DC.CursorPos.x + text_width + padding.x : window->WorkRect.Max.x; frame_bb.Max.y = window->DC.CursorPos.y + frame_height; if (display_frame) { const float outer_extend = IM_TRUNC(window->WindowPadding.x * 0.5f); // Framed header expand a little outside of current limits frame_bb.Min.x -= outer_extend; frame_bb.Max.x += outer_extend; } ImVec2 text_pos(window->DC.CursorPos.x + text_offset_x, window->DC.CursorPos.y + text_offset_y); ItemSize(ImVec2(text_width, frame_height), padding.y); // For regular tree nodes, we arbitrary allow to click past 2 worth of ItemSpacing ImRect interact_bb = frame_bb; if ((flags & (ImGuiTreeNodeFlags_Framed | ImGuiTreeNodeFlags_SpanAvailWidth | ImGuiTreeNodeFlags_SpanFullWidth | ImGuiTreeNodeFlags_SpanLabelWidth | ImGuiTreeNodeFlags_SpanAllColumns)) == 0) interact_bb.Max.x = frame_bb.Min.x + text_width + (label_size.x > 0.0f ? style.ItemSpacing.x * 2.0f : 0.0f); // Compute open and multi-select states before ItemAdd() as it clear NextItem data. ImGuiID storage_id = (g.NextItemData.HasFlags & ImGuiNextItemDataFlags_HasStorageID) ? g.NextItemData.StorageId : id; bool is_open = TreeNodeUpdateNextOpen(storage_id, flags); bool is_visible; if (span_all_columns || span_all_columns_label) { // Modify ClipRect for the ItemAdd(), faster than doing a PushColumnsBackground/PushTableBackgroundChannel for every Selectable.. const float backup_clip_rect_min_x = window->ClipRect.Min.x; const float backup_clip_rect_max_x = window->ClipRect.Max.x; window->ClipRect.Min.x = window->ParentWorkRect.Min.x; window->ClipRect.Max.x = window->ParentWorkRect.Max.x; is_visible = ItemAdd(interact_bb, id); window->ClipRect.Min.x = backup_clip_rect_min_x; window->ClipRect.Max.x = backup_clip_rect_max_x; } else { is_visible = ItemAdd(interact_bb, id); } g.LastItemData.StatusFlags |= ImGuiItemStatusFlags_HasDisplayRect; g.LastItemData.DisplayRect = frame_bb; // If a NavLeft request is happening and ImGuiTreeNodeFlags_NavLeftJumpsBackHere enabled: // Store data for the current depth to allow returning to this node from any child item. // For this purpose we essentially compare if g.NavIdIsAlive went from 0 to 1 between TreeNode() and TreePop(). // It will become tempting to enable ImGuiTreeNodeFlags_NavLeftJumpsBackHere by default or move it to ImGuiStyle. bool store_tree_node_stack_data = false; if (!(flags & ImGuiTreeNodeFlags_NoTreePushOnOpen)) { if ((flags & ImGuiTreeNodeFlags_NavLeftJumpsBackHere) && is_open && !g.NavIdIsAlive) if (g.NavMoveDir == ImGuiDir_Left && g.NavWindow == window && NavMoveRequestButNoResultYet()) store_tree_node_stack_data = true; } const bool is_leaf = (flags & ImGuiTreeNodeFlags_Leaf) != 0; if (!is_visible) { if (store_tree_node_stack_data && is_open) TreeNodeStoreStackData(flags); // Call before TreePushOverrideID() if (is_open && !(flags & ImGuiTreeNodeFlags_NoTreePushOnOpen)) TreePushOverrideID(id); IMGUI_TEST_ENGINE_ITEM_INFO(g.LastItemData.ID, label, g.LastItemData.StatusFlags | (is_leaf ? 0 : ImGuiItemStatusFlags_Openable) | (is_open ? ImGuiItemStatusFlags_Opened : 0)); return is_open; } if (span_all_columns || span_all_columns_label) { TablePushBackgroundChannel(); g.LastItemData.StatusFlags |= ImGuiItemStatusFlags_HasClipRect; g.LastItemData.ClipRect = window->ClipRect; } ImGuiButtonFlags button_flags = ImGuiTreeNodeFlags_None; if ((flags & ImGuiTreeNodeFlags_AllowOverlap) || (g.LastItemData.ItemFlags & ImGuiItemFlags_AllowOverlap)) button_flags |= ImGuiButtonFlags_AllowOverlap; if (!is_leaf) button_flags |= ImGuiButtonFlags_PressedOnDragDropHold; // We allow clicking on the arrow section with keyboard modifiers held, in order to easily // allow browsing a tree while preserving selection with code implementing multi-selection patterns. // When clicking on the rest of the tree node we always disallow keyboard modifiers. const float arrow_hit_x1 = (text_pos.x - text_offset_x) - style.TouchExtraPadding.x; const float arrow_hit_x2 = (text_pos.x - text_offset_x) + (g.FontSize + padding.x * 2.0f) + style.TouchExtraPadding.x; const bool is_mouse_x_over_arrow = (g.IO.MousePos.x >= arrow_hit_x1 && g.IO.MousePos.x < arrow_hit_x2); const bool is_multi_select = (g.LastItemData.ItemFlags & ImGuiItemFlags_IsMultiSelect) != 0; if (is_multi_select) // We absolutely need to distinguish open vs select so _OpenOnArrow comes by default flags |= (flags & ImGuiTreeNodeFlags_OpenOnMask_) == 0 ? ImGuiTreeNodeFlags_OpenOnArrow | ImGuiTreeNodeFlags_OpenOnDoubleClick : ImGuiTreeNodeFlags_OpenOnArrow; // Open behaviors can be altered with the _OpenOnArrow and _OnOnDoubleClick flags. // Some alteration have subtle effects (e.g. toggle on MouseUp vs MouseDown events) due to requirements for multi-selection and drag and drop support. // - Single-click on label = Toggle on MouseUp (default, when _OpenOnArrow=0) // - Single-click on arrow = Toggle on MouseDown (when _OpenOnArrow=0) // - Single-click on arrow = Toggle on MouseDown (when _OpenOnArrow=1) // - Double-click on label = Toggle on MouseDoubleClick (when _OpenOnDoubleClick=1) // - Double-click on arrow = Toggle on MouseDoubleClick (when _OpenOnDoubleClick=1 and _OpenOnArrow=0) // It is rather standard that arrow click react on Down rather than Up. // We set ImGuiButtonFlags_PressedOnClickRelease on OpenOnDoubleClick because we want the item to be active on the initial MouseDown in order for drag and drop to work. if (is_mouse_x_over_arrow) button_flags |= ImGuiButtonFlags_PressedOnClick; else if (flags & ImGuiTreeNodeFlags_OpenOnDoubleClick) button_flags |= ImGuiButtonFlags_PressedOnClickRelease | ImGuiButtonFlags_PressedOnDoubleClick; else button_flags |= ImGuiButtonFlags_PressedOnClickRelease; bool selected = (flags & ImGuiTreeNodeFlags_Selected) != 0; const bool was_selected = selected; // Multi-selection support (header) if (is_multi_select) { // Handle multi-select + alter button flags for it MultiSelectItemHeader(id, &selected, &button_flags); if (is_mouse_x_over_arrow) button_flags = (button_flags | ImGuiButtonFlags_PressedOnClick) & ~ImGuiButtonFlags_PressedOnClickRelease; } else { if (window != g.HoveredWindow || !is_mouse_x_over_arrow) button_flags |= ImGuiButtonFlags_NoKeyModsAllowed; } bool hovered, held; bool pressed = ButtonBehavior(interact_bb, id, &hovered, &held, button_flags); bool toggled = false; if (!is_leaf) { if (pressed && g.DragDropHoldJustPressedId != id) { if ((flags & ImGuiTreeNodeFlags_OpenOnMask_) == 0 || (g.NavActivateId == id && !is_multi_select)) toggled = true; // Single click if (flags & ImGuiTreeNodeFlags_OpenOnArrow) toggled |= is_mouse_x_over_arrow && !g.NavHighlightItemUnderNav; // Lightweight equivalent of IsMouseHoveringRect() since ButtonBehavior() already did the job if ((flags & ImGuiTreeNodeFlags_OpenOnDoubleClick) && g.IO.MouseClickedCount[0] == 2) toggled = true; // Double click } else if (pressed && g.DragDropHoldJustPressedId == id) { IM_ASSERT(button_flags & ImGuiButtonFlags_PressedOnDragDropHold); if (!is_open) // When using Drag and Drop "hold to open" we keep the node highlighted after opening, but never close it again. toggled = true; else pressed = false; // Cancel press so it doesn't trigger selection. } if (g.NavId == id && g.NavMoveDir == ImGuiDir_Left && is_open) { toggled = true; NavClearPreferredPosForAxis(ImGuiAxis_X); NavMoveRequestCancel(); } if (g.NavId == id && g.NavMoveDir == ImGuiDir_Right && !is_open) // If there's something upcoming on the line we may want to give it the priority? { toggled = true; NavClearPreferredPosForAxis(ImGuiAxis_X); NavMoveRequestCancel(); } if (toggled) { is_open = !is_open; window->DC.StateStorage->SetInt(storage_id, is_open); g.LastItemData.StatusFlags |= ImGuiItemStatusFlags_ToggledOpen; } } // Multi-selection support (footer) if (is_multi_select) { bool pressed_copy = pressed && !toggled; MultiSelectItemFooter(id, &selected, &pressed_copy); if (pressed) SetNavID(id, window->DC.NavLayerCurrent, g.CurrentFocusScopeId, interact_bb); } if (selected != was_selected) g.LastItemData.StatusFlags |= ImGuiItemStatusFlags_ToggledSelection; // Render { const ImU32 text_col = GetColorU32(ImGuiCol_Text); ImGuiNavRenderCursorFlags nav_render_cursor_flags = ImGuiNavRenderCursorFlags_Compact; if (is_multi_select) nav_render_cursor_flags |= ImGuiNavRenderCursorFlags_AlwaysDraw; // Always show the nav rectangle if (display_frame) { // Framed type const ImU32 bg_col = GetColorU32((held && hovered) ? ImGuiCol_HeaderActive : hovered ? ImGuiCol_HeaderHovered : ImGuiCol_Header); RenderFrame(frame_bb.Min, frame_bb.Max, bg_col, true, style.FrameRounding); RenderNavCursor(frame_bb, id, nav_render_cursor_flags); if (flags & ImGuiTreeNodeFlags_Bullet) RenderBullet(window->DrawList, ImVec2(text_pos.x - text_offset_x * 0.60f, text_pos.y + g.FontSize * 0.5f), text_col); else if (!is_leaf) RenderArrow(window->DrawList, ImVec2(text_pos.x - text_offset_x + padding.x, text_pos.y), text_col, is_open ? ((flags & ImGuiTreeNodeFlags_UpsideDownArrow) ? ImGuiDir_Up : ImGuiDir_Down) : ImGuiDir_Right, 1.0f); else // Leaf without bullet, left-adjusted text text_pos.x -= text_offset_x - padding.x; if (flags & ImGuiTreeNodeFlags_ClipLabelForTrailingButton) frame_bb.Max.x -= g.FontSize + style.FramePadding.x; if (g.LogEnabled) LogSetNextTextDecoration("###", "###"); } else { // Unframed typed for tree nodes if (hovered || selected) { const ImU32 bg_col = GetColorU32((held && hovered) ? ImGuiCol_HeaderActive : hovered ? ImGuiCol_HeaderHovered : ImGuiCol_Header); RenderFrame(frame_bb.Min, frame_bb.Max, bg_col, false); } RenderNavCursor(frame_bb, id, nav_render_cursor_flags); if (flags & ImGuiTreeNodeFlags_Bullet) RenderBullet(window->DrawList, ImVec2(text_pos.x - text_offset_x * 0.5f, text_pos.y + g.FontSize * 0.5f), text_col); else if (!is_leaf) RenderArrow(window->DrawList, ImVec2(text_pos.x - text_offset_x + padding.x, text_pos.y + g.FontSize * 0.15f), text_col, is_open ? ((flags & ImGuiTreeNodeFlags_UpsideDownArrow) ? ImGuiDir_Up : ImGuiDir_Down) : ImGuiDir_Right, 0.70f); if (g.LogEnabled) LogSetNextTextDecoration(">", NULL); } if (span_all_columns && !span_all_columns_label) TablePopBackgroundChannel(); // Label if (display_frame) RenderTextClipped(text_pos, frame_bb.Max, label, label_end, &label_size); else RenderText(text_pos, label, label_end, false); if (span_all_columns_label) TablePopBackgroundChannel(); } if (store_tree_node_stack_data && is_open) TreeNodeStoreStackData(flags); // Call before TreePushOverrideID() if (is_open && !(flags & ImGuiTreeNodeFlags_NoTreePushOnOpen)) TreePushOverrideID(id); // Could use TreePush(label) but this avoid computing twice IMGUI_TEST_ENGINE_ITEM_INFO(id, label, g.LastItemData.StatusFlags | (is_leaf ? 0 : ImGuiItemStatusFlags_Openable) | (is_open ? ImGuiItemStatusFlags_Opened : 0)); return is_open; } void ImGui::TreePush(const char* str_id) { ImGuiWindow* window = GetCurrentWindow(); Indent(); window->DC.TreeDepth++; PushID(str_id); } void ImGui::TreePush(const void* ptr_id) { ImGuiWindow* window = GetCurrentWindow(); Indent(); window->DC.TreeDepth++; PushID(ptr_id); } void ImGui::TreePushOverrideID(ImGuiID id) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; Indent(); window->DC.TreeDepth++; PushOverrideID(id); } void ImGui::TreePop() { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; Unindent(); window->DC.TreeDepth--; ImU32 tree_depth_mask = (1 << window->DC.TreeDepth); if (window->DC.TreeHasStackDataDepthMask & tree_depth_mask) // Only set during request { ImGuiTreeNodeStackData* data = &g.TreeNodeStack.back(); IM_ASSERT(data->ID == window->IDStack.back()); if (data->TreeFlags & ImGuiTreeNodeFlags_NavLeftJumpsBackHere) { // Handle Left arrow to move to parent tree node (when ImGuiTreeNodeFlags_NavLeftJumpsBackHere is enabled) if (g.NavIdIsAlive && g.NavMoveDir == ImGuiDir_Left && g.NavWindow == window && NavMoveRequestButNoResultYet()) NavMoveRequestResolveWithPastTreeNode(&g.NavMoveResultLocal, data); } g.TreeNodeStack.pop_back(); window->DC.TreeHasStackDataDepthMask &= ~tree_depth_mask; } IM_ASSERT(window->IDStack.Size > 1); // There should always be 1 element in the IDStack (pushed during window creation). If this triggers you called TreePop/PopID too much. PopID(); } // Horizontal distance preceding label when using TreeNode() or Bullet() float ImGui::GetTreeNodeToLabelSpacing() { ImGuiContext& g = *GImGui; return g.FontSize + (g.Style.FramePadding.x * 2.0f); } // Set next TreeNode/CollapsingHeader open state. void ImGui::SetNextItemOpen(bool is_open, ImGuiCond cond) { ImGuiContext& g = *GImGui; if (g.CurrentWindow->SkipItems) return; g.NextItemData.HasFlags |= ImGuiNextItemDataFlags_HasOpen; g.NextItemData.OpenVal = is_open; g.NextItemData.OpenCond = (ImU8)(cond ? cond : ImGuiCond_Always); } // Set next TreeNode/CollapsingHeader storage id. void ImGui::SetNextItemStorageID(ImGuiID storage_id) { ImGuiContext& g = *GImGui; if (g.CurrentWindow->SkipItems) return; g.NextItemData.HasFlags |= ImGuiNextItemDataFlags_HasStorageID; g.NextItemData.StorageId = storage_id; } // CollapsingHeader returns true when opened but do not indent nor push into the ID stack (because of the ImGuiTreeNodeFlags_NoTreePushOnOpen flag). // This is basically the same as calling TreeNodeEx(label, ImGuiTreeNodeFlags_CollapsingHeader). You can remove the _NoTreePushOnOpen flag if you want behavior closer to normal TreeNode(). bool ImGui::CollapsingHeader(const char* label, ImGuiTreeNodeFlags flags) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; ImGuiID id = window->GetID(label); return TreeNodeBehavior(id, flags | ImGuiTreeNodeFlags_CollapsingHeader, label); } // p_visible == NULL : regular collapsing header // p_visible != NULL && *p_visible == true : show a small close button on the corner of the header, clicking the button will set *p_visible = false // p_visible != NULL && *p_visible == false : do not show the header at all // Do not mistake this with the Open state of the header itself, which you can adjust with SetNextItemOpen() or ImGuiTreeNodeFlags_DefaultOpen. bool ImGui::CollapsingHeader(const char* label, bool* p_visible, ImGuiTreeNodeFlags flags) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; if (p_visible && !*p_visible) return false; ImGuiID id = window->GetID(label); flags |= ImGuiTreeNodeFlags_CollapsingHeader; if (p_visible) flags |= ImGuiTreeNodeFlags_AllowOverlap | (ImGuiTreeNodeFlags)ImGuiTreeNodeFlags_ClipLabelForTrailingButton; bool is_open = TreeNodeBehavior(id, flags, label); if (p_visible != NULL) { // Create a small overlapping close button // FIXME: We can evolve this into user accessible helpers to add extra buttons on title bars, headers, etc. // FIXME: CloseButton can overlap into text, need find a way to clip the text somehow. ImGuiContext& g = *GImGui; ImGuiLastItemData last_item_backup = g.LastItemData; float button_size = g.FontSize; float button_x = ImMax(g.LastItemData.Rect.Min.x, g.LastItemData.Rect.Max.x - g.Style.FramePadding.x - button_size); float button_y = g.LastItemData.Rect.Min.y + g.Style.FramePadding.y; ImGuiID close_button_id = GetIDWithSeed("#CLOSE", NULL, id); if (CloseButton(close_button_id, ImVec2(button_x, button_y))) *p_visible = false; g.LastItemData = last_item_backup; } return is_open; } //------------------------------------------------------------------------- // [SECTION] Widgets: Selectable //------------------------------------------------------------------------- // - Selectable() //------------------------------------------------------------------------- // Tip: pass a non-visible label (e.g. "##hello") then you can use the space to draw other text or image. // But you need to make sure the ID is unique, e.g. enclose calls in PushID/PopID or use ##unique_id. // With this scheme, ImGuiSelectableFlags_SpanAllColumns and ImGuiSelectableFlags_AllowOverlap are also frequently used flags. // FIXME: Selectable() with (size.x == 0.0f) and (SelectableTextAlign.x > 0.0f) followed by SameLine() is currently not supported. bool ImGui::Selectable(const char* label, bool selected, ImGuiSelectableFlags flags, const ImVec2& size_arg) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; ImGuiContext& g = *GImGui; const ImGuiStyle& style = g.Style; // Submit label or explicit size to ItemSize(), whereas ItemAdd() will submit a larger/spanning rectangle. ImGuiID id = window->GetID(label); ImVec2 label_size = CalcTextSize(label, NULL, true); ImVec2 size(size_arg.x != 0.0f ? size_arg.x : label_size.x, size_arg.y != 0.0f ? size_arg.y : label_size.y); ImVec2 pos = window->DC.CursorPos; pos.y += window->DC.CurrLineTextBaseOffset; ItemSize(size, 0.0f); // Fill horizontal space // We don't support (size < 0.0f) in Selectable() because the ItemSpacing extension would make explicitly right-aligned sizes not visibly match other widgets. const bool span_all_columns = (flags & ImGuiSelectableFlags_SpanAllColumns) != 0; const float min_x = span_all_columns ? window->ParentWorkRect.Min.x : pos.x; const float max_x = span_all_columns ? window->ParentWorkRect.Max.x : window->WorkRect.Max.x; if (size_arg.x == 0.0f || (flags & ImGuiSelectableFlags_SpanAvailWidth)) size.x = ImMax(label_size.x, max_x - min_x); // Selectables are meant to be tightly packed together with no click-gap, so we extend their box to cover spacing between selectable. // FIXME: Not part of layout so not included in clipper calculation, but ItemSize currently doesn't allow offsetting CursorPos. ImRect bb(min_x, pos.y, min_x + size.x, pos.y + size.y); if ((flags & ImGuiSelectableFlags_NoPadWithHalfSpacing) == 0) { const float spacing_x = span_all_columns ? 0.0f : style.ItemSpacing.x; const float spacing_y = style.ItemSpacing.y; const float spacing_L = IM_TRUNC(spacing_x * 0.50f); const float spacing_U = IM_TRUNC(spacing_y * 0.50f); bb.Min.x -= spacing_L; bb.Min.y -= spacing_U; bb.Max.x += (spacing_x - spacing_L); bb.Max.y += (spacing_y - spacing_U); } //if (g.IO.KeyCtrl) { GetForegroundDrawList()->AddRect(bb.Min, bb.Max, IM_COL32(0, 255, 0, 255)); } const bool disabled_item = (flags & ImGuiSelectableFlags_Disabled) != 0; const ImGuiItemFlags extra_item_flags = disabled_item ? (ImGuiItemFlags)ImGuiItemFlags_Disabled : ImGuiItemFlags_None; bool is_visible; if (span_all_columns) { // Modify ClipRect for the ItemAdd(), faster than doing a PushColumnsBackground/PushTableBackgroundChannel for every Selectable.. const float backup_clip_rect_min_x = window->ClipRect.Min.x; const float backup_clip_rect_max_x = window->ClipRect.Max.x; window->ClipRect.Min.x = window->ParentWorkRect.Min.x; window->ClipRect.Max.x = window->ParentWorkRect.Max.x; is_visible = ItemAdd(bb, id, NULL, extra_item_flags); window->ClipRect.Min.x = backup_clip_rect_min_x; window->ClipRect.Max.x = backup_clip_rect_max_x; } else { is_visible = ItemAdd(bb, id, NULL, extra_item_flags); } const bool is_multi_select = (g.LastItemData.ItemFlags & ImGuiItemFlags_IsMultiSelect) != 0; if (!is_visible) if (!is_multi_select || !g.BoxSelectState.UnclipMode || !g.BoxSelectState.UnclipRect.Overlaps(bb)) // Extra layer of "no logic clip" for box-select support (would be more overhead to add to ItemAdd) return false; const bool disabled_global = (g.CurrentItemFlags & ImGuiItemFlags_Disabled) != 0; if (disabled_item && !disabled_global) // Only testing this as an optimization BeginDisabled(); // FIXME: We can standardize the behavior of those two, we could also keep the fast path of override ClipRect + full push on render only, // which would be advantageous since most selectable are not selected. if (span_all_columns) { if (g.CurrentTable) TablePushBackgroundChannel(); else if (window->DC.CurrentColumns) PushColumnsBackground(); g.LastItemData.StatusFlags |= ImGuiItemStatusFlags_HasClipRect; g.LastItemData.ClipRect = window->ClipRect; } // We use NoHoldingActiveID on menus so user can click and _hold_ on a menu then drag to browse child entries ImGuiButtonFlags button_flags = 0; if (flags & ImGuiSelectableFlags_NoHoldingActiveID) { button_flags |= ImGuiButtonFlags_NoHoldingActiveId; } if (flags & ImGuiSelectableFlags_NoSetKeyOwner) { button_flags |= ImGuiButtonFlags_NoSetKeyOwner; } if (flags & ImGuiSelectableFlags_SelectOnClick) { button_flags |= ImGuiButtonFlags_PressedOnClick; } if (flags & ImGuiSelectableFlags_SelectOnRelease) { button_flags |= ImGuiButtonFlags_PressedOnRelease; } if (flags & ImGuiSelectableFlags_AllowDoubleClick) { button_flags |= ImGuiButtonFlags_PressedOnClickRelease | ImGuiButtonFlags_PressedOnDoubleClick; } if ((flags & ImGuiSelectableFlags_AllowOverlap) || (g.LastItemData.ItemFlags & ImGuiItemFlags_AllowOverlap)) { button_flags |= ImGuiButtonFlags_AllowOverlap; } // Multi-selection support (header) const bool was_selected = selected; if (is_multi_select) { // Handle multi-select + alter button flags for it MultiSelectItemHeader(id, &selected, &button_flags); } bool hovered, held; bool pressed = ButtonBehavior(bb, id, &hovered, &held, button_flags); // Multi-selection support (footer) if (is_multi_select) { MultiSelectItemFooter(id, &selected, &pressed); } else { // Auto-select when moved into // - This will be more fully fleshed in the range-select branch // - This is not exposed as it won't nicely work with some user side handling of shift/control // - We cannot do 'if (g.NavJustMovedToId != id) { selected = false; pressed = was_selected; }' for two reasons // - (1) it would require focus scope to be set, need exposing PushFocusScope() or equivalent (e.g. BeginSelection() calling PushFocusScope()) // - (2) usage will fail with clipped items // The multi-select API aim to fix those issues, e.g. may be replaced with a BeginSelection() API. if ((flags & ImGuiSelectableFlags_SelectOnNav) && g.NavJustMovedToId != 0 && g.NavJustMovedToFocusScopeId == g.CurrentFocusScopeId) if (g.NavJustMovedToId == id) selected = pressed = true; } // Update NavId when clicking or when Hovering (this doesn't happen on most widgets), so navigation can be resumed with keyboard/gamepad if (pressed || (hovered && (flags & ImGuiSelectableFlags_SetNavIdOnHover))) { if (!g.NavHighlightItemUnderNav && g.NavWindow == window && g.NavLayer == window->DC.NavLayerCurrent) { SetNavID(id, window->DC.NavLayerCurrent, g.CurrentFocusScopeId, WindowRectAbsToRel(window, bb)); // (bb == NavRect) if (g.IO.ConfigNavCursorVisibleAuto) g.NavCursorVisible = false; } } if (pressed) MarkItemEdited(id); if (selected != was_selected) g.LastItemData.StatusFlags |= ImGuiItemStatusFlags_ToggledSelection; // Render if (is_visible) { const bool highlighted = hovered || (flags & ImGuiSelectableFlags_Highlight); if (highlighted || selected) { // Between 1.91.0 and 1.91.4 we made selected Selectable use an arbitrary lerp between _Header and _HeaderHovered. Removed that now. (#8106) ImU32 col = GetColorU32((held && highlighted) ? ImGuiCol_HeaderActive : highlighted ? ImGuiCol_HeaderHovered : ImGuiCol_Header); RenderFrame(bb.Min, bb.Max, col, false, 0.0f); } if (g.NavId == id) { ImGuiNavRenderCursorFlags nav_render_cursor_flags = ImGuiNavRenderCursorFlags_Compact | ImGuiNavRenderCursorFlags_NoRounding; if (is_multi_select) nav_render_cursor_flags |= ImGuiNavRenderCursorFlags_AlwaysDraw; // Always show the nav rectangle RenderNavCursor(bb, id, nav_render_cursor_flags); } } if (span_all_columns) { if (g.CurrentTable) TablePopBackgroundChannel(); else if (window->DC.CurrentColumns) PopColumnsBackground(); } // Text stays at the submission position. Alignment/clipping extents ignore SpanAllColumns. if (is_visible) RenderTextClipped(pos, ImVec2(ImMin(pos.x + size.x, window->WorkRect.Max.x), pos.y + size.y), label, NULL, &label_size, style.SelectableTextAlign, &bb); // Automatically close popups if (pressed && (window->Flags & ImGuiWindowFlags_Popup) && !(flags & ImGuiSelectableFlags_NoAutoClosePopups) && (g.LastItemData.ItemFlags & ImGuiItemFlags_AutoClosePopups)) CloseCurrentPopup(); if (disabled_item && !disabled_global) EndDisabled(); // Selectable() always returns a pressed state! // Users of BeginMultiSelect()/EndMultiSelect() scope: you may call ImGui::IsItemToggledSelection() to retrieve // selection toggle, only useful if you need that state updated (e.g. for rendering purpose) before reaching EndMultiSelect(). IMGUI_TEST_ENGINE_ITEM_INFO(id, label, g.LastItemData.StatusFlags); return pressed; //-V1020 } bool ImGui::Selectable(const char* label, bool* p_selected, ImGuiSelectableFlags flags, const ImVec2& size_arg) { if (Selectable(label, *p_selected, flags, size_arg)) { *p_selected = !*p_selected; return true; } return false; } //------------------------------------------------------------------------- // [SECTION] Widgets: Typing-Select support //------------------------------------------------------------------------- // [Experimental] Currently not exposed in public API. // Consume character inputs and return search request, if any. // This would typically only be called on the focused window or location you want to grab inputs for, e.g. // if (ImGui::IsWindowFocused(...)) // if (ImGuiTypingSelectRequest* req = ImGui::GetTypingSelectRequest()) // focus_idx = ImGui::TypingSelectFindMatch(req, my_items.size(), [](void*, int n) { return my_items[n]->Name; }, &my_items, -1); // However the code is written in a way where calling it from multiple locations is safe (e.g. to obtain buffer). ImGuiTypingSelectRequest* ImGui::GetTypingSelectRequest(ImGuiTypingSelectFlags flags) { ImGuiContext& g = *GImGui; ImGuiTypingSelectState* data = &g.TypingSelectState; ImGuiTypingSelectRequest* out_request = &data->Request; // Clear buffer const float TYPING_SELECT_RESET_TIMER = 1.80f; // FIXME: Potentially move to IO config. const int TYPING_SELECT_SINGLE_CHAR_COUNT_FOR_LOCK = 4; // Lock single char matching when repeating same char 4 times if (data->SearchBuffer[0] != 0) { bool clear_buffer = false; clear_buffer |= (g.NavFocusScopeId != data->FocusScope); clear_buffer |= (data->LastRequestTime + TYPING_SELECT_RESET_TIMER < g.Time); clear_buffer |= g.NavAnyRequest; clear_buffer |= g.ActiveId != 0 && g.NavActivateId == 0; // Allow temporary SPACE activation to not interfere clear_buffer |= IsKeyPressed(ImGuiKey_Escape) || IsKeyPressed(ImGuiKey_Enter); clear_buffer |= IsKeyPressed(ImGuiKey_Backspace) && (flags & ImGuiTypingSelectFlags_AllowBackspace) == 0; //if (clear_buffer) { IMGUI_DEBUG_LOG("GetTypingSelectRequest(): Clear SearchBuffer.\n"); } if (clear_buffer) data->Clear(); } // Append to buffer const int buffer_max_len = IM_ARRAYSIZE(data->SearchBuffer) - 1; int buffer_len = (int)ImStrlen(data->SearchBuffer); bool select_request = false; for (ImWchar w : g.IO.InputQueueCharacters) { const int w_len = ImTextCountUtf8BytesFromStr(&w, &w + 1); if (w < 32 || (buffer_len == 0 && ImCharIsBlankW(w)) || (buffer_len + w_len > buffer_max_len)) // Ignore leading blanks continue; char w_buf[5]; ImTextCharToUtf8(w_buf, (unsigned int)w); if (data->SingleCharModeLock && w_len == out_request->SingleCharSize && memcmp(w_buf, data->SearchBuffer, w_len) == 0) { select_request = true; // Same character: don't need to append to buffer. continue; } if (data->SingleCharModeLock) { data->Clear(); // Different character: clear buffer_len = 0; } memcpy(data->SearchBuffer + buffer_len, w_buf, w_len + 1); // Append buffer_len += w_len; select_request = true; } g.IO.InputQueueCharacters.resize(0); // Handle backspace if ((flags & ImGuiTypingSelectFlags_AllowBackspace) && IsKeyPressed(ImGuiKey_Backspace, ImGuiInputFlags_Repeat)) { char* p = (char*)(void*)ImTextFindPreviousUtf8Codepoint(data->SearchBuffer, data->SearchBuffer + buffer_len); *p = 0; buffer_len = (int)(p - data->SearchBuffer); } // Return request if any if (buffer_len == 0) return NULL; if (select_request) { data->FocusScope = g.NavFocusScopeId; data->LastRequestFrame = g.FrameCount; data->LastRequestTime = (float)g.Time; } out_request->Flags = flags; out_request->SearchBufferLen = buffer_len; out_request->SearchBuffer = data->SearchBuffer; out_request->SelectRequest = (data->LastRequestFrame == g.FrameCount); out_request->SingleCharMode = false; out_request->SingleCharSize = 0; // Calculate if buffer contains the same character repeated. // - This can be used to implement a special search mode on first character. // - Performed on UTF-8 codepoint for correctness. // - SingleCharMode is always set for first input character, because it usually leads to a "next". if (flags & ImGuiTypingSelectFlags_AllowSingleCharMode) { const char* buf_begin = out_request->SearchBuffer; const char* buf_end = out_request->SearchBuffer + out_request->SearchBufferLen; const int c0_len = ImTextCountUtf8BytesFromChar(buf_begin, buf_end); const char* p = buf_begin + c0_len; for (; p < buf_end; p += c0_len) if (memcmp(buf_begin, p, (size_t)c0_len) != 0) break; const int single_char_count = (p == buf_end) ? (out_request->SearchBufferLen / c0_len) : 0; out_request->SingleCharMode = (single_char_count > 0 || data->SingleCharModeLock); out_request->SingleCharSize = (ImS8)c0_len; data->SingleCharModeLock |= (single_char_count >= TYPING_SELECT_SINGLE_CHAR_COUNT_FOR_LOCK); // From now on we stop search matching to lock to single char mode. } return out_request; } static int ImStrimatchlen(const char* s1, const char* s1_end, const char* s2) { int match_len = 0; while (s1 < s1_end && ImToUpper(*s1++) == ImToUpper(*s2++)) match_len++; return match_len; } // Default handler for finding a result for typing-select. You may implement your own. // You might want to display a tooltip to visualize the current request SearchBuffer // When SingleCharMode is set: // - it is better to NOT display a tooltip of other on-screen display indicator. // - the index of the currently focused item is required. // if your SetNextItemSelectionUserData() values are indices, you can obtain it from ImGuiMultiSelectIO::NavIdItem, otherwise from g.NavLastValidSelectionUserData. int ImGui::TypingSelectFindMatch(ImGuiTypingSelectRequest* req, int items_count, const char* (*get_item_name_func)(void*, int), void* user_data, int nav_item_idx) { if (req == NULL || req->SelectRequest == false) // Support NULL parameter so both calls can be done from same spot. return -1; int idx = -1; if (req->SingleCharMode && (req->Flags & ImGuiTypingSelectFlags_AllowSingleCharMode)) idx = TypingSelectFindNextSingleCharMatch(req, items_count, get_item_name_func, user_data, nav_item_idx); else idx = TypingSelectFindBestLeadingMatch(req, items_count, get_item_name_func, user_data); if (idx != -1) SetNavCursorVisibleAfterMove(); return idx; } // Special handling when a single character is repeated: perform search on a single letter and goes to next. int ImGui::TypingSelectFindNextSingleCharMatch(ImGuiTypingSelectRequest* req, int items_count, const char* (*get_item_name_func)(void*, int), void* user_data, int nav_item_idx) { // FIXME: Assume selection user data is index. Would be extremely practical. //if (nav_item_idx == -1) // nav_item_idx = (int)g.NavLastValidSelectionUserData; int first_match_idx = -1; bool return_next_match = false; for (int idx = 0; idx < items_count; idx++) { const char* item_name = get_item_name_func(user_data, idx); if (ImStrimatchlen(req->SearchBuffer, req->SearchBuffer + req->SingleCharSize, item_name) < req->SingleCharSize) continue; if (return_next_match) // Return next matching item after current item. return idx; if (first_match_idx == -1 && nav_item_idx == -1) // Return first match immediately if we don't have a nav_item_idx value. return idx; if (first_match_idx == -1) // Record first match for wrapping. first_match_idx = idx; if (nav_item_idx == idx) // Record that we encountering nav_item so we can return next match. return_next_match = true; } return first_match_idx; // First result } int ImGui::TypingSelectFindBestLeadingMatch(ImGuiTypingSelectRequest* req, int items_count, const char* (*get_item_name_func)(void*, int), void* user_data) { int longest_match_idx = -1; int longest_match_len = 0; for (int idx = 0; idx < items_count; idx++) { const char* item_name = get_item_name_func(user_data, idx); const int match_len = ImStrimatchlen(req->SearchBuffer, req->SearchBuffer + req->SearchBufferLen, item_name); if (match_len <= longest_match_len) continue; longest_match_idx = idx; longest_match_len = match_len; if (match_len == req->SearchBufferLen) break; } return longest_match_idx; } void ImGui::DebugNodeTypingSelectState(ImGuiTypingSelectState* data) { #ifndef IMGUI_DISABLE_DEBUG_TOOLS Text("SearchBuffer = \"%s\"", data->SearchBuffer); Text("SingleCharMode = %d, Size = %d, Lock = %d", data->Request.SingleCharMode, data->Request.SingleCharSize, data->SingleCharModeLock); Text("LastRequest = time: %.2f, frame: %d", data->LastRequestTime, data->LastRequestFrame); #else IM_UNUSED(data); #endif } //------------------------------------------------------------------------- // [SECTION] Widgets: Box-Select support // This has been extracted away from Multi-Select logic in the hope that it could eventually be used elsewhere, but hasn't been yet. //------------------------------------------------------------------------- // Extra logic in MultiSelectItemFooter() and ImGuiListClipper::Step() //------------------------------------------------------------------------- // - BoxSelectPreStartDrag() [Internal] // - BoxSelectActivateDrag() [Internal] // - BoxSelectDeactivateDrag() [Internal] // - BoxSelectScrollWithMouseDrag() [Internal] // - BeginBoxSelect() [Internal] // - EndBoxSelect() [Internal] //------------------------------------------------------------------------- // Call on the initial click. static void BoxSelectPreStartDrag(ImGuiID id, ImGuiSelectionUserData clicked_item) { ImGuiContext& g = *GImGui; ImGuiBoxSelectState* bs = &g.BoxSelectState; bs->ID = id; bs->IsStarting = true; // Consider starting box-select. bs->IsStartedFromVoid = (clicked_item == ImGuiSelectionUserData_Invalid); bs->IsStartedSetNavIdOnce = bs->IsStartedFromVoid; bs->KeyMods = g.IO.KeyMods; bs->StartPosRel = bs->EndPosRel = ImGui::WindowPosAbsToRel(g.CurrentWindow, g.IO.MousePos); bs->ScrollAccum = ImVec2(0.0f, 0.0f); } static void BoxSelectActivateDrag(ImGuiBoxSelectState* bs, ImGuiWindow* window) { ImGuiContext& g = *GImGui; IMGUI_DEBUG_LOG_SELECTION("[selection] BeginBoxSelect() 0X%08X: Activate\n", bs->ID); bs->IsActive = true; bs->Window = window; bs->IsStarting = false; ImGui::SetActiveID(bs->ID, window); ImGui::SetActiveIdUsingAllKeyboardKeys(); if (bs->IsStartedFromVoid && (bs->KeyMods & (ImGuiMod_Ctrl | ImGuiMod_Shift)) == 0) bs->RequestClear = true; } static void BoxSelectDeactivateDrag(ImGuiBoxSelectState* bs) { ImGuiContext& g = *GImGui; bs->IsActive = bs->IsStarting = false; if (g.ActiveId == bs->ID) { IMGUI_DEBUG_LOG_SELECTION("[selection] BeginBoxSelect() 0X%08X: Deactivate\n", bs->ID); ImGui::ClearActiveID(); } bs->ID = 0; } static void BoxSelectScrollWithMouseDrag(ImGuiBoxSelectState* bs, ImGuiWindow* window, const ImRect& inner_r) { ImGuiContext& g = *GImGui; IM_ASSERT(bs->Window == window); for (int n = 0; n < 2; n++) // each axis { const float mouse_pos = g.IO.MousePos[n]; const float dist = (mouse_pos > inner_r.Max[n]) ? mouse_pos - inner_r.Max[n] : (mouse_pos < inner_r.Min[n]) ? mouse_pos - inner_r.Min[n] : 0.0f; const float scroll_curr = window->Scroll[n]; if (dist == 0.0f || (dist < 0.0f && scroll_curr < 0.0f) || (dist > 0.0f && scroll_curr >= window->ScrollMax[n])) continue; const float speed_multiplier = ImLinearRemapClamp(g.FontSize, g.FontSize * 5.0f, 1.0f, 4.0f, ImAbs(dist)); // x1 to x4 depending on distance const float scroll_step = g.FontSize * 35.0f * speed_multiplier * ImSign(dist) * g.IO.DeltaTime; bs->ScrollAccum[n] += scroll_step; // Accumulate into a stored value so we can handle high-framerate const float scroll_step_i = ImFloor(bs->ScrollAccum[n]); if (scroll_step_i == 0.0f) continue; if (n == 0) ImGui::SetScrollX(window, scroll_curr + scroll_step_i); else ImGui::SetScrollY(window, scroll_curr + scroll_step_i); bs->ScrollAccum[n] -= scroll_step_i; } } bool ImGui::BeginBoxSelect(const ImRect& scope_rect, ImGuiWindow* window, ImGuiID box_select_id, ImGuiMultiSelectFlags ms_flags) { ImGuiContext& g = *GImGui; ImGuiBoxSelectState* bs = &g.BoxSelectState; KeepAliveID(box_select_id); if (bs->ID != box_select_id) return false; // IsStarting is set by MultiSelectItemFooter() when considering a possible box-select. We validate it here and lock geometry. bs->UnclipMode = false; bs->RequestClear = false; if (bs->IsStarting && IsMouseDragPastThreshold(0)) BoxSelectActivateDrag(bs, window); else if ((bs->IsStarting || bs->IsActive) && g.IO.MouseDown[0] == false) BoxSelectDeactivateDrag(bs); if (!bs->IsActive) return false; // Current frame absolute prev/current rectangles are used to toggle selection. // They are derived from positions relative to scrolling space. ImVec2 start_pos_abs = WindowPosRelToAbs(window, bs->StartPosRel); ImVec2 prev_end_pos_abs = WindowPosRelToAbs(window, bs->EndPosRel); // Clamped already ImVec2 curr_end_pos_abs = g.IO.MousePos; if (ms_flags & ImGuiMultiSelectFlags_ScopeWindow) // Box-select scrolling only happens with ScopeWindow curr_end_pos_abs = ImClamp(curr_end_pos_abs, scope_rect.Min, scope_rect.Max); bs->BoxSelectRectPrev.Min = ImMin(start_pos_abs, prev_end_pos_abs); bs->BoxSelectRectPrev.Max = ImMax(start_pos_abs, prev_end_pos_abs); bs->BoxSelectRectCurr.Min = ImMin(start_pos_abs, curr_end_pos_abs); bs->BoxSelectRectCurr.Max = ImMax(start_pos_abs, curr_end_pos_abs); // Box-select 2D mode detects horizontal changes (vertical ones are already picked by Clipper) // Storing an extra rect used by widgets supporting box-select. if (ms_flags & ImGuiMultiSelectFlags_BoxSelect2d) if (bs->BoxSelectRectPrev.Min.x != bs->BoxSelectRectCurr.Min.x || bs->BoxSelectRectPrev.Max.x != bs->BoxSelectRectCurr.Max.x) { bs->UnclipMode = true; bs->UnclipRect = bs->BoxSelectRectPrev; // FIXME-OPT: UnclipRect x coordinates could be intersection of Prev and Curr rect on X axis. bs->UnclipRect.Add(bs->BoxSelectRectCurr); } //GetForegroundDrawList()->AddRect(bs->UnclipRect.Min, bs->UnclipRect.Max, IM_COL32(255,0,0,200), 0.0f, 0, 3.0f); //GetForegroundDrawList()->AddRect(bs->BoxSelectRectPrev.Min, bs->BoxSelectRectPrev.Max, IM_COL32(255,0,0,200), 0.0f, 0, 3.0f); //GetForegroundDrawList()->AddRect(bs->BoxSelectRectCurr.Min, bs->BoxSelectRectCurr.Max, IM_COL32(0,255,0,200), 0.0f, 0, 1.0f); return true; } void ImGui::EndBoxSelect(const ImRect& scope_rect, ImGuiMultiSelectFlags ms_flags) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; ImGuiBoxSelectState* bs = &g.BoxSelectState; IM_ASSERT(bs->IsActive); bs->UnclipMode = false; // Render selection rectangle bs->EndPosRel = WindowPosAbsToRel(window, ImClamp(g.IO.MousePos, scope_rect.Min, scope_rect.Max)); // Clamp stored position according to current scrolling view ImRect box_select_r = bs->BoxSelectRectCurr; box_select_r.ClipWith(scope_rect); window->DrawList->AddRectFilled(box_select_r.Min, box_select_r.Max, GetColorU32(ImGuiCol_SeparatorHovered, 0.30f)); // FIXME-MULTISELECT: Styling window->DrawList->AddRect(box_select_r.Min, box_select_r.Max, GetColorU32(ImGuiCol_NavCursor)); // FIXME-MULTISELECT: Styling // Scroll const bool enable_scroll = (ms_flags & ImGuiMultiSelectFlags_ScopeWindow) && (ms_flags & ImGuiMultiSelectFlags_BoxSelectNoScroll) == 0; if (enable_scroll) { ImRect scroll_r = scope_rect; scroll_r.Expand(-g.FontSize); //GetForegroundDrawList()->AddRect(scroll_r.Min, scroll_r.Max, IM_COL32(0, 255, 0, 255)); if (!scroll_r.Contains(g.IO.MousePos)) BoxSelectScrollWithMouseDrag(bs, window, scroll_r); } } //------------------------------------------------------------------------- // [SECTION] Widgets: Multi-Select support //------------------------------------------------------------------------- // - DebugLogMultiSelectRequests() [Internal] // - CalcScopeRect() [Internal] // - BeginMultiSelect() // - EndMultiSelect() // - SetNextItemSelectionUserData() // - MultiSelectItemHeader() [Internal] // - MultiSelectItemFooter() [Internal] // - DebugNodeMultiSelectState() [Internal] //------------------------------------------------------------------------- static void DebugLogMultiSelectRequests(const char* function, const ImGuiMultiSelectIO* io) { ImGuiContext& g = *GImGui; IM_UNUSED(function); for (const ImGuiSelectionRequest& req : io->Requests) { if (req.Type == ImGuiSelectionRequestType_SetAll) IMGUI_DEBUG_LOG_SELECTION("[selection] %s: Request: SetAll %d (= %s)\n", function, req.Selected, req.Selected ? "SelectAll" : "Clear"); if (req.Type == ImGuiSelectionRequestType_SetRange) IMGUI_DEBUG_LOG_SELECTION("[selection] %s: Request: SetRange %" IM_PRId64 "..%" IM_PRId64 " (0x%" IM_PRIX64 "..0x%" IM_PRIX64 ") = %d (dir %d)\n", function, req.RangeFirstItem, req.RangeLastItem, req.RangeFirstItem, req.RangeLastItem, req.Selected, req.RangeDirection); } } static ImRect CalcScopeRect(ImGuiMultiSelectTempData* ms, ImGuiWindow* window) { ImGuiContext& g = *GImGui; if (ms->Flags & ImGuiMultiSelectFlags_ScopeRect) { // Warning: this depends on CursorMaxPos so it means to be called by EndMultiSelect() only return ImRect(ms->ScopeRectMin, ImMax(window->DC.CursorMaxPos, ms->ScopeRectMin)); } else { // When a table, pull HostClipRect, which allows us to predict ClipRect before first row/layout is performed. (#7970) ImRect scope_rect = window->InnerClipRect; if (g.CurrentTable != NULL) scope_rect = g.CurrentTable->HostClipRect; // Add inner table decoration (#7821) // FIXME: Why not baking in InnerClipRect? scope_rect.Min = ImMin(scope_rect.Min + ImVec2(window->DecoInnerSizeX1, window->DecoInnerSizeY1), scope_rect.Max); return scope_rect; } } // Return ImGuiMultiSelectIO structure. // Lifetime: don't hold on ImGuiMultiSelectIO* pointers over multiple frames or past any subsequent call to BeginMultiSelect() or EndMultiSelect(). // Passing 'selection_size' and 'items_count' parameters is currently optional. // - 'selection_size' is useful to disable some shortcut routing: e.g. ImGuiMultiSelectFlags_ClearOnEscape won't claim Escape key when selection_size 0, // allowing a first press to clear selection THEN the second press to leave child window and return to parent. // - 'items_count' is stored in ImGuiMultiSelectIO which makes it a convenient way to pass the information to your ApplyRequest() handler (but you may pass it differently). // - If they are costly for you to compute (e.g. external intrusive selection without maintaining size), you may avoid them and pass -1. // - If you can easily tell if your selection is empty or not, you may pass 0/1, or you may enable ImGuiMultiSelectFlags_ClearOnEscape flag dynamically. ImGuiMultiSelectIO* ImGui::BeginMultiSelect(ImGuiMultiSelectFlags flags, int selection_size, int items_count) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; if (++g.MultiSelectTempDataStacked > g.MultiSelectTempData.Size) g.MultiSelectTempData.resize(g.MultiSelectTempDataStacked, ImGuiMultiSelectTempData()); ImGuiMultiSelectTempData* ms = &g.MultiSelectTempData[g.MultiSelectTempDataStacked - 1]; IM_STATIC_ASSERT(offsetof(ImGuiMultiSelectTempData, IO) == 0); // Clear() relies on that. g.CurrentMultiSelect = ms; if ((flags & (ImGuiMultiSelectFlags_ScopeWindow | ImGuiMultiSelectFlags_ScopeRect)) == 0) flags |= ImGuiMultiSelectFlags_ScopeWindow; if (flags & ImGuiMultiSelectFlags_SingleSelect) flags &= ~(ImGuiMultiSelectFlags_BoxSelect2d | ImGuiMultiSelectFlags_BoxSelect1d); if (flags & ImGuiMultiSelectFlags_BoxSelect2d) flags &= ~ImGuiMultiSelectFlags_BoxSelect1d; // FIXME: Workaround to the fact we override CursorMaxPos, meaning size measurement are lost. (#8250) // They should perhaps be stacked properly? if (ImGuiTable* table = g.CurrentTable) if (table->CurrentColumn != -1) TableEndCell(table); // This is currently safe to call multiple time. If that properly is lost we can extract the "save measurement" part of it. // FIXME: BeginFocusScope() const ImGuiID id = window->IDStack.back(); ms->Clear(); ms->FocusScopeId = id; ms->Flags = flags; ms->IsFocused = (ms->FocusScopeId == g.NavFocusScopeId); ms->BackupCursorMaxPos = window->DC.CursorMaxPos; ms->ScopeRectMin = window->DC.CursorMaxPos = window->DC.CursorPos; PushFocusScope(ms->FocusScopeId); if (flags & ImGuiMultiSelectFlags_ScopeWindow) // Mark parent child window as navigable into, with highlight. Assume user will always submit interactive items. window->DC.NavLayersActiveMask |= 1 << ImGuiNavLayer_Main; // Use copy of keyboard mods at the time of the request, otherwise we would requires mods to be held for an extra frame. ms->KeyMods = g.NavJustMovedToId ? (g.NavJustMovedToIsTabbing ? 0 : g.NavJustMovedToKeyMods) : g.IO.KeyMods; if (flags & ImGuiMultiSelectFlags_NoRangeSelect) ms->KeyMods &= ~ImGuiMod_Shift; // Bind storage ImGuiMultiSelectState* storage = g.MultiSelectStorage.GetOrAddByKey(id); storage->ID = id; storage->LastFrameActive = g.FrameCount; storage->LastSelectionSize = selection_size; storage->Window = window; ms->Storage = storage; // Output to user ms->IO.Requests.resize(0); ms->IO.RangeSrcItem = storage->RangeSrcItem; ms->IO.NavIdItem = storage->NavIdItem; ms->IO.NavIdSelected = (storage->NavIdSelected == 1) ? true : false; ms->IO.ItemsCount = items_count; // Clear when using Navigation to move within the scope // (we compare FocusScopeId so it possible to use multiple selections inside a same window) bool request_clear = false; bool request_select_all = false; if (g.NavJustMovedToId != 0 && g.NavJustMovedToFocusScopeId == ms->FocusScopeId && g.NavJustMovedToHasSelectionData) { if (ms->KeyMods & ImGuiMod_Shift) ms->IsKeyboardSetRange = true; if (ms->IsKeyboardSetRange) IM_ASSERT(storage->RangeSrcItem != ImGuiSelectionUserData_Invalid); // Not ready -> could clear? if ((ms->KeyMods & (ImGuiMod_Ctrl | ImGuiMod_Shift)) == 0 && (flags & (ImGuiMultiSelectFlags_NoAutoClear | ImGuiMultiSelectFlags_NoAutoSelect)) == 0) request_clear = true; } else if (g.NavJustMovedFromFocusScopeId == ms->FocusScopeId) { // Also clear on leaving scope (may be optional?) if ((ms->KeyMods & (ImGuiMod_Ctrl | ImGuiMod_Shift)) == 0 && (flags & (ImGuiMultiSelectFlags_NoAutoClear | ImGuiMultiSelectFlags_NoAutoSelect)) == 0) request_clear = true; } // Box-select handling: update active state. ImGuiBoxSelectState* bs = &g.BoxSelectState; if (flags & (ImGuiMultiSelectFlags_BoxSelect1d | ImGuiMultiSelectFlags_BoxSelect2d)) { ms->BoxSelectId = GetID("##BoxSelect"); if (BeginBoxSelect(CalcScopeRect(ms, window), window, ms->BoxSelectId, flags)) request_clear |= bs->RequestClear; } if (ms->IsFocused) { // Shortcut: Clear selection (Escape) // - Only claim shortcut if selection is not empty, allowing further presses on Escape to e.g. leave current child window. // - Box select also handle Escape and needs to pass an id to bypass ActiveIdUsingAllKeyboardKeys lock. if (flags & ImGuiMultiSelectFlags_ClearOnEscape) { if (selection_size != 0 || bs->IsActive) if (Shortcut(ImGuiKey_Escape, ImGuiInputFlags_None, bs->IsActive ? bs->ID : 0)) { request_clear = true; if (bs->IsActive) BoxSelectDeactivateDrag(bs); } } // Shortcut: Select all (CTRL+A) if (!(flags & ImGuiMultiSelectFlags_SingleSelect) && !(flags & ImGuiMultiSelectFlags_NoSelectAll)) if (Shortcut(ImGuiMod_Ctrl | ImGuiKey_A)) request_select_all = true; } if (request_clear || request_select_all) { MultiSelectAddSetAll(ms, request_select_all); if (!request_select_all) storage->LastSelectionSize = 0; } ms->LoopRequestSetAll = request_select_all ? 1 : request_clear ? 0 : -1; ms->LastSubmittedItem = ImGuiSelectionUserData_Invalid; if (g.DebugLogFlags & ImGuiDebugLogFlags_EventSelection) DebugLogMultiSelectRequests("BeginMultiSelect", &ms->IO); return &ms->IO; } // Return updated ImGuiMultiSelectIO structure. // Lifetime: don't hold on ImGuiMultiSelectIO* pointers over multiple frames or past any subsequent call to BeginMultiSelect() or EndMultiSelect(). ImGuiMultiSelectIO* ImGui::EndMultiSelect() { ImGuiContext& g = *GImGui; ImGuiMultiSelectTempData* ms = g.CurrentMultiSelect; ImGuiMultiSelectState* storage = ms->Storage; ImGuiWindow* window = g.CurrentWindow; IM_ASSERT_USER_ERROR(ms->FocusScopeId == g.CurrentFocusScopeId, "EndMultiSelect() FocusScope mismatch!"); IM_ASSERT(g.CurrentMultiSelect != NULL && storage->Window == g.CurrentWindow); IM_ASSERT(g.MultiSelectTempDataStacked > 0 && &g.MultiSelectTempData[g.MultiSelectTempDataStacked - 1] == g.CurrentMultiSelect); ImRect scope_rect = CalcScopeRect(ms, window); if (ms->IsFocused) { // We currently don't allow user code to modify RangeSrcItem by writing to BeginIO's version, but that would be an easy change here. if (ms->IO.RangeSrcReset || (ms->RangeSrcPassedBy == false && ms->IO.RangeSrcItem != ImGuiSelectionUserData_Invalid)) // Can't read storage->RangeSrcItem here -> we want the state at begining of the scope (see tests for easy failure) { IMGUI_DEBUG_LOG_SELECTION("[selection] EndMultiSelect: Reset RangeSrcItem.\n"); // Will set be to NavId. storage->RangeSrcItem = ImGuiSelectionUserData_Invalid; } if (ms->NavIdPassedBy == false && storage->NavIdItem != ImGuiSelectionUserData_Invalid) { IMGUI_DEBUG_LOG_SELECTION("[selection] EndMultiSelect: Reset NavIdItem.\n"); storage->NavIdItem = ImGuiSelectionUserData_Invalid; storage->NavIdSelected = -1; } if ((ms->Flags & (ImGuiMultiSelectFlags_BoxSelect1d | ImGuiMultiSelectFlags_BoxSelect2d)) && GetBoxSelectState(ms->BoxSelectId)) EndBoxSelect(scope_rect, ms->Flags); } if (ms->IsEndIO == false) ms->IO.Requests.resize(0); // Clear selection when clicking void? // We specifically test for IsMouseDragPastThreshold(0) == false to allow box-selection! // The InnerRect test is necessary for non-child/decorated windows. bool scope_hovered = IsWindowHovered() && window->InnerRect.Contains(g.IO.MousePos); if (scope_hovered && (ms->Flags & ImGuiMultiSelectFlags_ScopeRect)) scope_hovered &= scope_rect.Contains(g.IO.MousePos); if (scope_hovered && g.HoveredId == 0 && g.ActiveId == 0) { if (ms->Flags & (ImGuiMultiSelectFlags_BoxSelect1d | ImGuiMultiSelectFlags_BoxSelect2d)) { if (!g.BoxSelectState.IsActive && !g.BoxSelectState.IsStarting && g.IO.MouseClickedCount[0] == 1) { BoxSelectPreStartDrag(ms->BoxSelectId, ImGuiSelectionUserData_Invalid); FocusWindow(window, ImGuiFocusRequestFlags_UnlessBelowModal); SetHoveredID(ms->BoxSelectId); if (ms->Flags & ImGuiMultiSelectFlags_ScopeRect) SetNavID(0, ImGuiNavLayer_Main, ms->FocusScopeId, ImRect(g.IO.MousePos, g.IO.MousePos)); // Automatically switch FocusScope for initial click from void to box-select. } } if (ms->Flags & ImGuiMultiSelectFlags_ClearOnClickVoid) if (IsMouseReleased(0) && IsMouseDragPastThreshold(0) == false && g.IO.KeyMods == ImGuiMod_None) MultiSelectAddSetAll(ms, false); } // Courtesy nav wrapping helper flag if (ms->Flags & ImGuiMultiSelectFlags_NavWrapX) { IM_ASSERT(ms->Flags & ImGuiMultiSelectFlags_ScopeWindow); // Only supported at window scope ImGui::NavMoveRequestTryWrapping(ImGui::GetCurrentWindow(), ImGuiNavMoveFlags_WrapX); } // Unwind window->DC.CursorMaxPos = ImMax(ms->BackupCursorMaxPos, window->DC.CursorMaxPos); PopFocusScope(); if (g.DebugLogFlags & ImGuiDebugLogFlags_EventSelection) DebugLogMultiSelectRequests("EndMultiSelect", &ms->IO); ms->FocusScopeId = 0; ms->Flags = ImGuiMultiSelectFlags_None; g.CurrentMultiSelect = (--g.MultiSelectTempDataStacked > 0) ? &g.MultiSelectTempData[g.MultiSelectTempDataStacked - 1] : NULL; return &ms->IO; } void ImGui::SetNextItemSelectionUserData(ImGuiSelectionUserData selection_user_data) { // Note that flags will be cleared by ItemAdd(), so it's only useful for Navigation code! // This designed so widgets can also cheaply set this before calling ItemAdd(), so we are not tied to MultiSelect api. ImGuiContext& g = *GImGui; g.NextItemData.SelectionUserData = selection_user_data; g.NextItemData.FocusScopeId = g.CurrentFocusScopeId; if (ImGuiMultiSelectTempData* ms = g.CurrentMultiSelect) { // Auto updating RangeSrcPassedBy for cases were clipper is not used (done before ItemAdd() clipping) g.NextItemData.ItemFlags |= ImGuiItemFlags_HasSelectionUserData | ImGuiItemFlags_IsMultiSelect; if (ms->IO.RangeSrcItem == selection_user_data) ms->RangeSrcPassedBy = true; } else { g.NextItemData.ItemFlags |= ImGuiItemFlags_HasSelectionUserData; } } // In charge of: // - Applying SetAll for submitted items. // - Applying SetRange for submitted items and record end points. // - Altering button behavior flags to facilitate use with drag and drop. void ImGui::MultiSelectItemHeader(ImGuiID id, bool* p_selected, ImGuiButtonFlags* p_button_flags) { ImGuiContext& g = *GImGui; ImGuiMultiSelectTempData* ms = g.CurrentMultiSelect; bool selected = *p_selected; if (ms->IsFocused) { ImGuiMultiSelectState* storage = ms->Storage; ImGuiSelectionUserData item_data = g.NextItemData.SelectionUserData; IM_ASSERT(g.NextItemData.FocusScopeId == g.CurrentFocusScopeId && "Forgot to call SetNextItemSelectionUserData() prior to item, required in BeginMultiSelect()/EndMultiSelect() scope"); // Apply SetAll (Clear/SelectAll) requests requested by BeginMultiSelect(). // This is only useful if the user hasn't processed them already, and this only works if the user isn't using the clipper. // If you are using a clipper you need to process the SetAll request after calling BeginMultiSelect() if (ms->LoopRequestSetAll != -1) selected = (ms->LoopRequestSetAll == 1); // When using SHIFT+Nav: because it can incur scrolling we cannot afford a frame of lag with the selection highlight (otherwise scrolling would happen before selection) // For this to work, we need someone to set 'RangeSrcPassedBy = true' at some point (either clipper either SetNextItemSelectionUserData() function) if (ms->IsKeyboardSetRange) { IM_ASSERT(id != 0 && (ms->KeyMods & ImGuiMod_Shift) != 0); const bool is_range_dst = (ms->RangeDstPassedBy == false) && g.NavJustMovedToId == id; // Assume that g.NavJustMovedToId is not clipped. if (is_range_dst) ms->RangeDstPassedBy = true; if (is_range_dst && storage->RangeSrcItem == ImGuiSelectionUserData_Invalid) // If we don't have RangeSrc, assign RangeSrc = RangeDst { storage->RangeSrcItem = item_data; storage->RangeSelected = selected ? 1 : 0; } const bool is_range_src = storage->RangeSrcItem == item_data; if (is_range_src || is_range_dst || ms->RangeSrcPassedBy != ms->RangeDstPassedBy) { // Apply range-select value to visible items IM_ASSERT(storage->RangeSrcItem != ImGuiSelectionUserData_Invalid && storage->RangeSelected != -1); selected = (storage->RangeSelected != 0); } else if ((ms->KeyMods & ImGuiMod_Ctrl) == 0 && (ms->Flags & ImGuiMultiSelectFlags_NoAutoClear) == 0) { // Clear other items selected = false; } } *p_selected = selected; } // Alter button behavior flags // To handle drag and drop of multiple items we need to avoid clearing selection on click. // Enabling this test makes actions using CTRL+SHIFT delay their effect on MouseUp which is annoying, but it allows drag and drop of multiple items. if (p_button_flags != NULL) { ImGuiButtonFlags button_flags = *p_button_flags; button_flags |= ImGuiButtonFlags_NoHoveredOnFocus; if ((!selected || (g.ActiveId == id && g.ActiveIdHasBeenPressedBefore)) && !(ms->Flags & ImGuiMultiSelectFlags_SelectOnClickRelease)) button_flags = (button_flags | ImGuiButtonFlags_PressedOnClick) & ~ImGuiButtonFlags_PressedOnClickRelease; else button_flags |= ImGuiButtonFlags_PressedOnClickRelease; *p_button_flags = button_flags; } } // In charge of: // - Auto-select on navigation. // - Box-select toggle handling. // - Right-click handling. // - Altering selection based on Ctrl/Shift modifiers, both for keyboard and mouse. // - Record current selection state for RangeSrc // This is all rather complex, best to run and refer to "widgets_multiselect_xxx" tests in imgui_test_suite. void ImGui::MultiSelectItemFooter(ImGuiID id, bool* p_selected, bool* p_pressed) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; bool selected = *p_selected; bool pressed = *p_pressed; ImGuiMultiSelectTempData* ms = g.CurrentMultiSelect; ImGuiMultiSelectState* storage = ms->Storage; if (pressed) ms->IsFocused = true; bool hovered = false; if (g.LastItemData.StatusFlags & ImGuiItemStatusFlags_HoveredRect) hovered = IsItemHovered(ImGuiHoveredFlags_AllowWhenBlockedByPopup); if (!ms->IsFocused && !hovered) return; ImGuiSelectionUserData item_data = g.NextItemData.SelectionUserData; ImGuiMultiSelectFlags flags = ms->Flags; const bool is_singleselect = (flags & ImGuiMultiSelectFlags_SingleSelect) != 0; bool is_ctrl = (ms->KeyMods & ImGuiMod_Ctrl) != 0; bool is_shift = (ms->KeyMods & ImGuiMod_Shift) != 0; bool apply_to_range_src = false; if (g.NavId == id && storage->RangeSrcItem == ImGuiSelectionUserData_Invalid) apply_to_range_src = true; if (ms->IsEndIO == false) { ms->IO.Requests.resize(0); ms->IsEndIO = true; } // Auto-select as you navigate a list if (g.NavJustMovedToId == id) { if ((flags & ImGuiMultiSelectFlags_NoAutoSelect) == 0) { if (is_ctrl && is_shift) pressed = true; else if (!is_ctrl) selected = pressed = true; } else { // With NoAutoSelect, using Shift+keyboard performs a write/copy if (is_shift) pressed = true; else if (!is_ctrl) apply_to_range_src = true; // Since if (pressed) {} main block is not running we update this } } if (apply_to_range_src) { storage->RangeSrcItem = item_data; storage->RangeSelected = selected; // Will be updated at the end of this function anyway. } // Box-select toggle handling if (ms->BoxSelectId != 0) if (ImGuiBoxSelectState* bs = GetBoxSelectState(ms->BoxSelectId)) { const bool rect_overlap_curr = bs->BoxSelectRectCurr.Overlaps(g.LastItemData.Rect); const bool rect_overlap_prev = bs->BoxSelectRectPrev.Overlaps(g.LastItemData.Rect); if ((rect_overlap_curr && !rect_overlap_prev && !selected) || (rect_overlap_prev && !rect_overlap_curr)) { if (storage->LastSelectionSize <= 0 && bs->IsStartedSetNavIdOnce) { pressed = true; // First item act as a pressed: code below will emit selection request and set NavId (whatever we emit here will be overridden anyway) bs->IsStartedSetNavIdOnce = false; } else { selected = !selected; MultiSelectAddSetRange(ms, selected, +1, item_data, item_data); } storage->LastSelectionSize = ImMax(storage->LastSelectionSize + 1, 1); } } // Right-click handling. // FIXME-MULTISELECT: Currently filtered out by ImGuiMultiSelectFlags_NoAutoSelect but maybe should be moved to Selectable(). See https://github.com/ocornut/imgui/pull/5816 if (hovered && IsMouseClicked(1) && (flags & ImGuiMultiSelectFlags_NoAutoSelect) == 0) { if (g.ActiveId != 0 && g.ActiveId != id) ClearActiveID(); SetFocusID(id, window); if (!pressed && !selected) { pressed = true; is_ctrl = is_shift = false; } } // Unlike Space, Enter doesn't alter selection (but can still return a press) unless current item is not selected. // The later, "unless current item is not select", may become optional? It seems like a better default if Enter doesn't necessarily open something // (unlike e.g. Windows explorer). For use case where Enter always open something, we might decide to make this optional? const bool enter_pressed = pressed && (g.NavActivateId == id) && (g.NavActivateFlags & ImGuiActivateFlags_PreferInput); // Alter selection if (pressed && (!enter_pressed || !selected)) { // Box-select ImGuiInputSource input_source = (g.NavJustMovedToId == id || g.NavActivateId == id) ? g.NavInputSource : ImGuiInputSource_Mouse; if (flags & (ImGuiMultiSelectFlags_BoxSelect1d | ImGuiMultiSelectFlags_BoxSelect2d)) if (selected == false && !g.BoxSelectState.IsActive && !g.BoxSelectState.IsStarting && input_source == ImGuiInputSource_Mouse && g.IO.MouseClickedCount[0] == 1) BoxSelectPreStartDrag(ms->BoxSelectId, item_data); //---------------------------------------------------------------------------------------- // ACTION | Begin | Pressed/Activated | End //---------------------------------------------------------------------------------------- // Keys Navigated: | Clear | Src=item, Sel=1 SetRange 1 // Keys Navigated: Ctrl | n/a | n/a // Keys Navigated: Shift | n/a | Dst=item, Sel=1, => Clear + SetRange 1 // Keys Navigated: Ctrl+Shift | n/a | Dst=item, Sel=Src => Clear + SetRange Src-Dst // Keys Activated: | n/a | Src=item, Sel=1 => Clear + SetRange 1 // Keys Activated: Ctrl | n/a | Src=item, Sel=!Sel => SetSange 1 // Keys Activated: Shift | n/a | Dst=item, Sel=1 => Clear + SetSange 1 //---------------------------------------------------------------------------------------- // Mouse Pressed: | n/a | Src=item, Sel=1, => Clear + SetRange 1 // Mouse Pressed: Ctrl | n/a | Src=item, Sel=!Sel => SetRange 1 // Mouse Pressed: Shift | n/a | Dst=item, Sel=1, => Clear + SetRange 1 // Mouse Pressed: Ctrl+Shift | n/a | Dst=item, Sel=!Sel => SetRange Src-Dst //---------------------------------------------------------------------------------------- if ((flags & ImGuiMultiSelectFlags_NoAutoClear) == 0) { bool request_clear = false; if (is_singleselect) request_clear = true; else if ((input_source == ImGuiInputSource_Mouse || g.NavActivateId == id) && !is_ctrl) request_clear = (flags & ImGuiMultiSelectFlags_NoAutoClearOnReselect) ? !selected : true; else if ((input_source == ImGuiInputSource_Keyboard || input_source == ImGuiInputSource_Gamepad) && is_shift && !is_ctrl) request_clear = true; // With is_shift==false the RequestClear was done in BeginIO, not necessary to do again. if (request_clear) MultiSelectAddSetAll(ms, false); } int range_direction; bool range_selected; if (is_shift && !is_singleselect) { //IM_ASSERT(storage->HasRangeSrc && storage->HasRangeValue); if (storage->RangeSrcItem == ImGuiSelectionUserData_Invalid) storage->RangeSrcItem = item_data; if ((flags & ImGuiMultiSelectFlags_NoAutoSelect) == 0) { // Shift+Arrow always select // Ctrl+Shift+Arrow copy source selection state (already stored by BeginMultiSelect() in storage->RangeSelected) range_selected = (is_ctrl && storage->RangeSelected != -1) ? (storage->RangeSelected != 0) : true; } else { // Shift+Arrow copy source selection state // Shift+Click always copy from target selection state if (ms->IsKeyboardSetRange) range_selected = (storage->RangeSelected != -1) ? (storage->RangeSelected != 0) : true; else range_selected = !selected; } range_direction = ms->RangeSrcPassedBy ? +1 : -1; } else { // Ctrl inverts selection, otherwise always select if ((flags & ImGuiMultiSelectFlags_NoAutoSelect) == 0) selected = is_ctrl ? !selected : true; else selected = !selected; storage->RangeSrcItem = item_data; range_selected = selected; range_direction = +1; } MultiSelectAddSetRange(ms, range_selected, range_direction, storage->RangeSrcItem, item_data); } // Update/store the selection state of the Source item (used by CTRL+SHIFT, when Source is unselected we perform a range unselect) if (storage->RangeSrcItem == item_data) storage->RangeSelected = selected ? 1 : 0; // Update/store the selection state of focused item if (g.NavId == id) { storage->NavIdItem = item_data; storage->NavIdSelected = selected ? 1 : 0; } if (storage->NavIdItem == item_data) ms->NavIdPassedBy = true; ms->LastSubmittedItem = item_data; *p_selected = selected; *p_pressed = pressed; } void ImGui::MultiSelectAddSetAll(ImGuiMultiSelectTempData* ms, bool selected) { ImGuiSelectionRequest req = { ImGuiSelectionRequestType_SetAll, selected, 0, ImGuiSelectionUserData_Invalid, ImGuiSelectionUserData_Invalid }; ms->IO.Requests.resize(0); // Can always clear previous requests ms->IO.Requests.push_back(req); // Add new request } void ImGui::MultiSelectAddSetRange(ImGuiMultiSelectTempData* ms, bool selected, int range_dir, ImGuiSelectionUserData first_item, ImGuiSelectionUserData last_item) { // Merge contiguous spans into same request (unless NoRangeSelect is set which guarantees single-item ranges) if (ms->IO.Requests.Size > 0 && first_item == last_item && (ms->Flags & ImGuiMultiSelectFlags_NoRangeSelect) == 0) { ImGuiSelectionRequest* prev = &ms->IO.Requests.Data[ms->IO.Requests.Size - 1]; if (prev->Type == ImGuiSelectionRequestType_SetRange && prev->RangeLastItem == ms->LastSubmittedItem && prev->Selected == selected) { prev->RangeLastItem = last_item; return; } } ImGuiSelectionRequest req = { ImGuiSelectionRequestType_SetRange, selected, (ImS8)range_dir, (range_dir > 0) ? first_item : last_item, (range_dir > 0) ? last_item : first_item }; ms->IO.Requests.push_back(req); // Add new request } void ImGui::DebugNodeMultiSelectState(ImGuiMultiSelectState* storage) { #ifndef IMGUI_DISABLE_DEBUG_TOOLS const bool is_active = (storage->LastFrameActive >= GetFrameCount() - 2); // Note that fully clipped early out scrolling tables will appear as inactive here. if (!is_active) { PushStyleColor(ImGuiCol_Text, GetStyleColorVec4(ImGuiCol_TextDisabled)); } bool open = TreeNode((void*)(intptr_t)storage->ID, "MultiSelect 0x%08X in '%s'%s", storage->ID, storage->Window ? storage->Window->Name : "N/A", is_active ? "" : " *Inactive*"); if (!is_active) { PopStyleColor(); } if (!open) return; Text("RangeSrcItem = %" IM_PRId64 " (0x%" IM_PRIX64 "), RangeSelected = %d", storage->RangeSrcItem, storage->RangeSrcItem, storage->RangeSelected); Text("NavIdItem = %" IM_PRId64 " (0x%" IM_PRIX64 "), NavIdSelected = %d", storage->NavIdItem, storage->NavIdItem, storage->NavIdSelected); Text("LastSelectionSize = %d", storage->LastSelectionSize); // Provided by user TreePop(); #else IM_UNUSED(storage); #endif } //------------------------------------------------------------------------- // [SECTION] Widgets: Multi-Select helpers //------------------------------------------------------------------------- // - ImGuiSelectionBasicStorage // - ImGuiSelectionExternalStorage //------------------------------------------------------------------------- ImGuiSelectionBasicStorage::ImGuiSelectionBasicStorage() { Size = 0; PreserveOrder = false; UserData = NULL; AdapterIndexToStorageId = [](ImGuiSelectionBasicStorage*, int idx) { return (ImGuiID)idx; }; _SelectionOrder = 1; // Always >0 } void ImGuiSelectionBasicStorage::Clear() { Size = 0; _SelectionOrder = 1; // Always >0 _Storage.Data.resize(0); } void ImGuiSelectionBasicStorage::Swap(ImGuiSelectionBasicStorage& r) { ImSwap(Size, r.Size); ImSwap(_SelectionOrder, r._SelectionOrder); _Storage.Data.swap(r._Storage.Data); } bool ImGuiSelectionBasicStorage::Contains(ImGuiID id) const { return _Storage.GetInt(id, 0) != 0; } static int IMGUI_CDECL PairComparerByValueInt(const void* lhs, const void* rhs) { int lhs_v = ((const ImGuiStoragePair*)lhs)->val_i; int rhs_v = ((const ImGuiStoragePair*)rhs)->val_i; return (lhs_v > rhs_v ? +1 : lhs_v < rhs_v ? -1 : 0); } // GetNextSelectedItem() is an abstraction allowing us to change our underlying actual storage system without impacting user. // (e.g. store unselected vs compact down, compact down on demand, use raw ImVector instead of ImGuiStorage...) bool ImGuiSelectionBasicStorage::GetNextSelectedItem(void** opaque_it, ImGuiID* out_id) { ImGuiStoragePair* it = (ImGuiStoragePair*)*opaque_it; ImGuiStoragePair* it_end = _Storage.Data.Data + _Storage.Data.Size; if (PreserveOrder && it == NULL && it_end != NULL) ImQsort(_Storage.Data.Data, (size_t)_Storage.Data.Size, sizeof(ImGuiStoragePair), PairComparerByValueInt); // ~ImGuiStorage::BuildSortByValueInt() if (it == NULL) it = _Storage.Data.Data; IM_ASSERT(it >= _Storage.Data.Data && it <= it_end); if (it != it_end) while (it->val_i == 0 && it < it_end) it++; const bool has_more = (it != it_end); *opaque_it = has_more ? (void**)(it + 1) : (void**)(it); *out_id = has_more ? it->key : 0; if (PreserveOrder && !has_more) _Storage.BuildSortByKey(); return has_more; } void ImGuiSelectionBasicStorage::SetItemSelected(ImGuiID id, bool selected) { int* p_int = _Storage.GetIntRef(id, 0); if (selected && *p_int == 0) { *p_int = _SelectionOrder++; Size++; } else if (!selected && *p_int != 0) { *p_int = 0; Size--; } } // Optimized for batch edits (with same value of 'selected') static void ImGuiSelectionBasicStorage_BatchSetItemSelected(ImGuiSelectionBasicStorage* selection, ImGuiID id, bool selected, int size_before_amends, int selection_order) { ImGuiStorage* storage = &selection->_Storage; ImGuiStoragePair* it = ImLowerBound(storage->Data.Data, storage->Data.Data + size_before_amends, id); const bool is_contained = (it != storage->Data.Data + size_before_amends) && (it->key == id); if (selected == (is_contained && it->val_i != 0)) return; if (selected && !is_contained) storage->Data.push_back(ImGuiStoragePair(id, selection_order)); // Push unsorted at end of vector, will be sorted in SelectionMultiAmendsFinish() else if (is_contained) it->val_i = selected ? selection_order : 0; // Modify in-place. selection->Size += selected ? +1 : -1; } static void ImGuiSelectionBasicStorage_BatchFinish(ImGuiSelectionBasicStorage* selection, bool selected, int size_before_amends) { ImGuiStorage* storage = &selection->_Storage; if (selected && selection->Size != size_before_amends) storage->BuildSortByKey(); // When done selecting: sort everything } // Apply requests coming from BeginMultiSelect() and EndMultiSelect(). // - Enable 'Demo->Tools->Debug Log->Selection' to see selection requests as they happen. // - Honoring SetRange requests requires that you can iterate/interpolate between RangeFirstItem and RangeLastItem. // - In this demo we often submit indices to SetNextItemSelectionUserData() + store the same indices in persistent selection. // - Your code may do differently. If you store pointers or objects ID in ImGuiSelectionUserData you may need to perform // a lookup in order to have some way to iterate/interpolate between two items. // - A full-featured application is likely to allow search/filtering which is likely to lead to using indices // and constructing a view index <> object id/ptr data structure anyway. // WHEN YOUR APPLICATION SETTLES ON A CHOICE, YOU WILL PROBABLY PREFER TO GET RID OF THIS UNNECESSARY 'ImGuiSelectionBasicStorage' INDIRECTION LOGIC. // Notice that with the simplest adapter (using indices everywhere), all functions return their parameters. // The most simple implementation (using indices everywhere) would look like: // for (ImGuiSelectionRequest& req : ms_io->Requests) // { // if (req.Type == ImGuiSelectionRequestType_SetAll) { Clear(); if (req.Selected) { for (int n = 0; n < items_count; n++) { SetItemSelected(n, true); } } // if (req.Type == ImGuiSelectionRequestType_SetRange) { for (int n = (int)ms_io->RangeFirstItem; n <= (int)ms_io->RangeLastItem; n++) { SetItemSelected(n, ms_io->Selected); } } // } void ImGuiSelectionBasicStorage::ApplyRequests(ImGuiMultiSelectIO* ms_io) { // For convenience we obtain ItemsCount as passed to BeginMultiSelect(), which is optional. // It makes sense when using ImGuiSelectionBasicStorage to simply pass your items count to BeginMultiSelect(). // Other scheme may handle SetAll differently. IM_ASSERT(ms_io->ItemsCount != -1 && "Missing value for items_count in BeginMultiSelect() call!"); IM_ASSERT(AdapterIndexToStorageId != NULL); // This is optimized/specialized to cope with very large selections (e.g. 100k+ items) // - A simpler version could call SetItemSelected() directly instead of ImGuiSelectionBasicStorage_BatchSetItemSelected() + ImGuiSelectionBasicStorage_BatchFinish(). // - Optimized select can append unsorted, then sort in a second pass. Optimized unselect can clear in-place then compact in a second pass. // - A more optimal version wouldn't even use ImGuiStorage but directly a ImVector to reduce bandwidth, but this is a reasonable trade off to reuse code. // - There are many ways this could be better optimized. The worse case scenario being: using BoxSelect2d in a grid, box-select scrolling down while wiggling // left and right: it affects coarse clipping + can emit multiple SetRange with 1 item each.) // FIXME-OPT: For each block of consecutive SetRange request: // - add all requests to a sorted list, store ID, selected, offset in ImGuiStorage. // - rewrite sorted storage a single time. for (ImGuiSelectionRequest& req : ms_io->Requests) { if (req.Type == ImGuiSelectionRequestType_SetAll) { Clear(); if (req.Selected) { _Storage.Data.reserve(ms_io->ItemsCount); const int size_before_amends = _Storage.Data.Size; for (int idx = 0; idx < ms_io->ItemsCount; idx++, _SelectionOrder++) ImGuiSelectionBasicStorage_BatchSetItemSelected(this, GetStorageIdFromIndex(idx), req.Selected, size_before_amends, _SelectionOrder); ImGuiSelectionBasicStorage_BatchFinish(this, req.Selected, size_before_amends); } } else if (req.Type == ImGuiSelectionRequestType_SetRange) { const int selection_changes = (int)req.RangeLastItem - (int)req.RangeFirstItem + 1; //ImGuiContext& g = *GImGui; IMGUI_DEBUG_LOG_SELECTION("Req %d/%d: set %d to %d\n", ms_io->Requests.index_from_ptr(&req), ms_io->Requests.Size, selection_changes, req.Selected); if (selection_changes == 1 || (selection_changes < Size / 100)) { // Multiple sorted insertion + copy likely to be faster. // Technically we could do a single copy with a little more work (sort sequential SetRange requests) for (int idx = (int)req.RangeFirstItem; idx <= (int)req.RangeLastItem; idx++) SetItemSelected(GetStorageIdFromIndex(idx), req.Selected); } else { // Append insertion + single sort likely be faster. // Use req.RangeDirection to set order field so that shift+clicking from 1 to 5 is different than shift+clicking from 5 to 1 const int size_before_amends = _Storage.Data.Size; int selection_order = _SelectionOrder + ((req.RangeDirection < 0) ? selection_changes - 1 : 0); for (int idx = (int)req.RangeFirstItem; idx <= (int)req.RangeLastItem; idx++, selection_order += req.RangeDirection) ImGuiSelectionBasicStorage_BatchSetItemSelected(this, GetStorageIdFromIndex(idx), req.Selected, size_before_amends, selection_order); if (req.Selected) _SelectionOrder += selection_changes; ImGuiSelectionBasicStorage_BatchFinish(this, req.Selected, size_before_amends); } } } } //------------------------------------------------------------------------- ImGuiSelectionExternalStorage::ImGuiSelectionExternalStorage() { UserData = NULL; AdapterSetItemSelected = NULL; } // Apply requests coming from BeginMultiSelect() and EndMultiSelect(). // We also pull 'ms_io->ItemsCount' as passed for BeginMultiSelect() for consistency with ImGuiSelectionBasicStorage // This makes no assumption about underlying storage. void ImGuiSelectionExternalStorage::ApplyRequests(ImGuiMultiSelectIO* ms_io) { IM_ASSERT(AdapterSetItemSelected); for (ImGuiSelectionRequest& req : ms_io->Requests) { if (req.Type == ImGuiSelectionRequestType_SetAll) for (int idx = 0; idx < ms_io->ItemsCount; idx++) AdapterSetItemSelected(this, idx, req.Selected); if (req.Type == ImGuiSelectionRequestType_SetRange) for (int idx = (int)req.RangeFirstItem; idx <= (int)req.RangeLastItem; idx++) AdapterSetItemSelected(this, idx, req.Selected); } } //------------------------------------------------------------------------- // [SECTION] Widgets: ListBox //------------------------------------------------------------------------- // - BeginListBox() // - EndListBox() // - ListBox() //------------------------------------------------------------------------- // This is essentially a thin wrapper to using BeginChild/EndChild with the ImGuiChildFlags_FrameStyle flag for stylistic changes + displaying a label. // This handle some subtleties with capturing info from the label. // If you don't need a label you can pretty much directly use ImGui::BeginChild() with ImGuiChildFlags_FrameStyle. // Tip: To have a list filling the entire window width, use size.x = -FLT_MIN and pass an non-visible label e.g. "##empty" // Tip: If your vertical size is calculated from an item count (e.g. 10 * item_height) consider adding a fractional part to facilitate seeing scrolling boundaries (e.g. 10.5f * item_height). bool ImGui::BeginListBox(const char* label, const ImVec2& size_arg) { ImGuiContext& g = *GImGui; ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; const ImGuiStyle& style = g.Style; const ImGuiID id = GetID(label); const ImVec2 label_size = CalcTextSize(label, NULL, true); // Size default to hold ~7.25 items. // Fractional number of items helps seeing that we can scroll down/up without looking at scrollbar. ImVec2 size = ImTrunc(CalcItemSize(size_arg, CalcItemWidth(), GetTextLineHeightWithSpacing() * 7.25f + style.FramePadding.y * 2.0f)); ImVec2 frame_size = ImVec2(size.x, ImMax(size.y, label_size.y)); ImRect frame_bb(window->DC.CursorPos, window->DC.CursorPos + frame_size); ImRect bb(frame_bb.Min, frame_bb.Max + ImVec2(label_size.x > 0.0f ? style.ItemInnerSpacing.x + label_size.x : 0.0f, 0.0f)); g.NextItemData.ClearFlags(); if (!IsRectVisible(bb.Min, bb.Max)) { ItemSize(bb.GetSize(), style.FramePadding.y); ItemAdd(bb, 0, &frame_bb); g.NextWindowData.ClearFlags(); // We behave like Begin() and need to consume those values return false; } // FIXME-OPT: We could omit the BeginGroup() if label_size.x == 0.0f but would need to omit the EndGroup() as well. BeginGroup(); if (label_size.x > 0.0f) { ImVec2 label_pos = ImVec2(frame_bb.Max.x + style.ItemInnerSpacing.x, frame_bb.Min.y + style.FramePadding.y); RenderText(label_pos, label); window->DC.CursorMaxPos = ImMax(window->DC.CursorMaxPos, label_pos + label_size); AlignTextToFramePadding(); } BeginChild(id, frame_bb.GetSize(), ImGuiChildFlags_FrameStyle); return true; } void ImGui::EndListBox() { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; IM_ASSERT((window->Flags & ImGuiWindowFlags_ChildWindow) && "Mismatched BeginListBox/EndListBox calls. Did you test the return value of BeginListBox?"); IM_UNUSED(window); EndChild(); EndGroup(); // This is only required to be able to do IsItemXXX query on the whole ListBox including label } bool ImGui::ListBox(const char* label, int* current_item, const char* const items[], int items_count, int height_items) { const bool value_changed = ListBox(label, current_item, Items_ArrayGetter, (void*)items, items_count, height_items); return value_changed; } // This is merely a helper around BeginListBox(), EndListBox(). // Considering using those directly to submit custom data or store selection differently. bool ImGui::ListBox(const char* label, int* current_item, const char* (*getter)(void* user_data, int idx), void* user_data, int items_count, int height_in_items) { ImGuiContext& g = *GImGui; // Calculate size from "height_in_items" if (height_in_items < 0) height_in_items = ImMin(items_count, 7); float height_in_items_f = height_in_items + 0.25f; ImVec2 size(0.0f, ImTrunc(GetTextLineHeightWithSpacing() * height_in_items_f + g.Style.FramePadding.y * 2.0f)); if (!BeginListBox(label, size)) return false; // Assume all items have even height (= 1 line of text). If you need items of different height, // you can create a custom version of ListBox() in your code without using the clipper. bool value_changed = false; ImGuiListClipper clipper; clipper.Begin(items_count, GetTextLineHeightWithSpacing()); // We know exactly our line height here so we pass it as a minor optimization, but generally you don't need to. clipper.IncludeItemByIndex(*current_item); while (clipper.Step()) for (int i = clipper.DisplayStart; i < clipper.DisplayEnd; i++) { const char* item_text = getter(user_data, i); if (item_text == NULL) item_text = "*Unknown item*"; PushID(i); const bool item_selected = (i == *current_item); if (Selectable(item_text, item_selected)) { *current_item = i; value_changed = true; } if (item_selected) SetItemDefaultFocus(); PopID(); } EndListBox(); if (value_changed) MarkItemEdited(g.LastItemData.ID); return value_changed; } //------------------------------------------------------------------------- // [SECTION] Widgets: PlotLines, PlotHistogram //------------------------------------------------------------------------- // - PlotEx() [Internal] // - PlotLines() // - PlotHistogram() //------------------------------------------------------------------------- // Plot/Graph widgets are not very good. // Consider writing your own, or using a third-party one, see: // - ImPlot https://github.com/epezent/implot // - others https://github.com/ocornut/imgui/wiki/Useful-Extensions //------------------------------------------------------------------------- int ImGui::PlotEx(ImGuiPlotType plot_type, const char* label, float (*values_getter)(void* data, int idx), void* data, int values_count, int values_offset, const char* overlay_text, float scale_min, float scale_max, const ImVec2& size_arg) { ImGuiContext& g = *GImGui; ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return -1; const ImGuiStyle& style = g.Style; const ImGuiID id = window->GetID(label); const ImVec2 label_size = CalcTextSize(label, NULL, true); const ImVec2 frame_size = CalcItemSize(size_arg, CalcItemWidth(), label_size.y + style.FramePadding.y * 2.0f); const ImRect frame_bb(window->DC.CursorPos, window->DC.CursorPos + frame_size); const ImRect inner_bb(frame_bb.Min + style.FramePadding, frame_bb.Max - style.FramePadding); const ImRect total_bb(frame_bb.Min, frame_bb.Max + ImVec2(label_size.x > 0.0f ? style.ItemInnerSpacing.x + label_size.x : 0.0f, 0)); ItemSize(total_bb, style.FramePadding.y); if (!ItemAdd(total_bb, id, &frame_bb, ImGuiItemFlags_NoNav)) return -1; bool hovered; ButtonBehavior(frame_bb, id, &hovered, NULL); // Determine scale from values if not specified if (scale_min == FLT_MAX || scale_max == FLT_MAX) { float v_min = FLT_MAX; float v_max = -FLT_MAX; for (int i = 0; i < values_count; i++) { const float v = values_getter(data, i); if (v != v) // Ignore NaN values continue; v_min = ImMin(v_min, v); v_max = ImMax(v_max, v); } if (scale_min == FLT_MAX) scale_min = v_min; if (scale_max == FLT_MAX) scale_max = v_max; } RenderFrame(frame_bb.Min, frame_bb.Max, GetColorU32(ImGuiCol_FrameBg), true, style.FrameRounding); const int values_count_min = (plot_type == ImGuiPlotType_Lines) ? 2 : 1; int idx_hovered = -1; if (values_count >= values_count_min) { int res_w = ImMin((int)frame_size.x, values_count) + ((plot_type == ImGuiPlotType_Lines) ? -1 : 0); int item_count = values_count + ((plot_type == ImGuiPlotType_Lines) ? -1 : 0); // Tooltip on hover if (hovered && inner_bb.Contains(g.IO.MousePos)) { const float t = ImClamp((g.IO.MousePos.x - inner_bb.Min.x) / (inner_bb.Max.x - inner_bb.Min.x), 0.0f, 0.9999f); const int v_idx = (int)(t * item_count); IM_ASSERT(v_idx >= 0 && v_idx < values_count); const float v0 = values_getter(data, (v_idx + values_offset) % values_count); const float v1 = values_getter(data, (v_idx + 1 + values_offset) % values_count); if (plot_type == ImGuiPlotType_Lines) SetTooltip("%d: %8.4g\n%d: %8.4g", v_idx, v0, v_idx + 1, v1); else if (plot_type == ImGuiPlotType_Histogram) SetTooltip("%d: %8.4g", v_idx, v0); idx_hovered = v_idx; } const float t_step = 1.0f / (float)res_w; const float inv_scale = (scale_min == scale_max) ? 0.0f : (1.0f / (scale_max - scale_min)); float v0 = values_getter(data, (0 + values_offset) % values_count); float t0 = 0.0f; ImVec2 tp0 = ImVec2( t0, 1.0f - ImSaturate((v0 - scale_min) * inv_scale) ); // Point in the normalized space of our target rectangle float histogram_zero_line_t = (scale_min * scale_max < 0.0f) ? (1 + scale_min * inv_scale) : (scale_min < 0.0f ? 0.0f : 1.0f); // Where does the zero line stands const ImU32 col_base = GetColorU32((plot_type == ImGuiPlotType_Lines) ? ImGuiCol_PlotLines : ImGuiCol_PlotHistogram); const ImU32 col_hovered = GetColorU32((plot_type == ImGuiPlotType_Lines) ? ImGuiCol_PlotLinesHovered : ImGuiCol_PlotHistogramHovered); for (int n = 0; n < res_w; n++) { const float t1 = t0 + t_step; const int v1_idx = (int)(t0 * item_count + 0.5f); IM_ASSERT(v1_idx >= 0 && v1_idx < values_count); const float v1 = values_getter(data, (v1_idx + values_offset + 1) % values_count); const ImVec2 tp1 = ImVec2( t1, 1.0f - ImSaturate((v1 - scale_min) * inv_scale) ); // NB: Draw calls are merged together by the DrawList system. Still, we should render our batch are lower level to save a bit of CPU. ImVec2 pos0 = ImLerp(inner_bb.Min, inner_bb.Max, tp0); ImVec2 pos1 = ImLerp(inner_bb.Min, inner_bb.Max, (plot_type == ImGuiPlotType_Lines) ? tp1 : ImVec2(tp1.x, histogram_zero_line_t)); if (plot_type == ImGuiPlotType_Lines) { window->DrawList->AddLine(pos0, pos1, idx_hovered == v1_idx ? col_hovered : col_base); } else if (plot_type == ImGuiPlotType_Histogram) { if (pos1.x >= pos0.x + 2.0f) pos1.x -= 1.0f; window->DrawList->AddRectFilled(pos0, pos1, idx_hovered == v1_idx ? col_hovered : col_base); } t0 = t1; tp0 = tp1; } } // Text overlay if (overlay_text) RenderTextClipped(ImVec2(frame_bb.Min.x, frame_bb.Min.y + style.FramePadding.y), frame_bb.Max, overlay_text, NULL, NULL, ImVec2(0.5f, 0.0f)); if (label_size.x > 0.0f) RenderText(ImVec2(frame_bb.Max.x + style.ItemInnerSpacing.x, inner_bb.Min.y), label); // Return hovered index or -1 if none are hovered. // This is currently not exposed in the public API because we need a larger redesign of the whole thing, but in the short-term we are making it available in PlotEx(). return idx_hovered; } struct ImGuiPlotArrayGetterData { const float* Values; int Stride; ImGuiPlotArrayGetterData(const float* values, int stride) { Values = values; Stride = stride; } }; static float Plot_ArrayGetter(void* data, int idx) { ImGuiPlotArrayGetterData* plot_data = (ImGuiPlotArrayGetterData*)data; const float v = *(const float*)(const void*)((const unsigned char*)plot_data->Values + (size_t)idx * plot_data->Stride); return v; } void ImGui::PlotLines(const char* label, const float* values, int values_count, int values_offset, const char* overlay_text, float scale_min, float scale_max, ImVec2 graph_size, int stride) { ImGuiPlotArrayGetterData data(values, stride); PlotEx(ImGuiPlotType_Lines, label, &Plot_ArrayGetter, (void*)&data, values_count, values_offset, overlay_text, scale_min, scale_max, graph_size); } void ImGui::PlotLines(const char* label, float (*values_getter)(void* data, int idx), void* data, int values_count, int values_offset, const char* overlay_text, float scale_min, float scale_max, ImVec2 graph_size) { PlotEx(ImGuiPlotType_Lines, label, values_getter, data, values_count, values_offset, overlay_text, scale_min, scale_max, graph_size); } void ImGui::PlotHistogram(const char* label, const float* values, int values_count, int values_offset, const char* overlay_text, float scale_min, float scale_max, ImVec2 graph_size, int stride) { ImGuiPlotArrayGetterData data(values, stride); PlotEx(ImGuiPlotType_Histogram, label, &Plot_ArrayGetter, (void*)&data, values_count, values_offset, overlay_text, scale_min, scale_max, graph_size); } void ImGui::PlotHistogram(const char* label, float (*values_getter)(void* data, int idx), void* data, int values_count, int values_offset, const char* overlay_text, float scale_min, float scale_max, ImVec2 graph_size) { PlotEx(ImGuiPlotType_Histogram, label, values_getter, data, values_count, values_offset, overlay_text, scale_min, scale_max, graph_size); } //------------------------------------------------------------------------- // [SECTION] Widgets: Value helpers // Those is not very useful, legacy API. //------------------------------------------------------------------------- // - Value() //------------------------------------------------------------------------- void ImGui::Value(const char* prefix, bool b) { Text("%s: %s", prefix, (b ? "true" : "false")); } void ImGui::Value(const char* prefix, int v) { Text("%s: %d", prefix, v); } void ImGui::Value(const char* prefix, unsigned int v) { Text("%s: %d", prefix, v); } void ImGui::Value(const char* prefix, float v, const char* float_format) { if (float_format) { char fmt[64]; ImFormatString(fmt, IM_ARRAYSIZE(fmt), "%%s: %s", float_format); Text(fmt, prefix, v); } else { Text("%s: %.3f", prefix, v); } } //------------------------------------------------------------------------- // [SECTION] MenuItem, BeginMenu, EndMenu, etc. //------------------------------------------------------------------------- // - ImGuiMenuColumns [Internal] // - BeginMenuBar() // - EndMenuBar() // - BeginMainMenuBar() // - EndMainMenuBar() // - BeginMenu() // - EndMenu() // - MenuItemEx() [Internal] // - MenuItem() //------------------------------------------------------------------------- // Helpers for internal use void ImGuiMenuColumns::Update(float spacing, bool window_reappearing) { if (window_reappearing) memset(Widths, 0, sizeof(Widths)); Spacing = (ImU16)spacing; CalcNextTotalWidth(true); memset(Widths, 0, sizeof(Widths)); TotalWidth = NextTotalWidth; NextTotalWidth = 0; } void ImGuiMenuColumns::CalcNextTotalWidth(bool update_offsets) { ImU16 offset = 0; bool want_spacing = false; for (int i = 0; i < IM_ARRAYSIZE(Widths); i++) { ImU16 width = Widths[i]; if (want_spacing && width > 0) offset += Spacing; want_spacing |= (width > 0); if (update_offsets) { if (i == 1) { OffsetLabel = offset; } if (i == 2) { OffsetShortcut = offset; } if (i == 3) { OffsetMark = offset; } } offset += width; } NextTotalWidth = offset; } float ImGuiMenuColumns::DeclColumns(float w_icon, float w_label, float w_shortcut, float w_mark) { Widths[0] = ImMax(Widths[0], (ImU16)w_icon); Widths[1] = ImMax(Widths[1], (ImU16)w_label); Widths[2] = ImMax(Widths[2], (ImU16)w_shortcut); Widths[3] = ImMax(Widths[3], (ImU16)w_mark); CalcNextTotalWidth(false); return (float)ImMax(TotalWidth, NextTotalWidth); } // FIXME: Provided a rectangle perhaps e.g. a BeginMenuBarEx() could be used anywhere.. // Currently the main responsibility of this function being to setup clip-rect + horizontal layout + menu navigation layer. // Ideally we also want this to be responsible for claiming space out of the main window scrolling rectangle, in which case ImGuiWindowFlags_MenuBar will become unnecessary. // Then later the same system could be used for multiple menu-bars, scrollbars, side-bars. bool ImGui::BeginMenuBar() { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; if (!(window->Flags & ImGuiWindowFlags_MenuBar)) return false; IM_ASSERT(!window->DC.MenuBarAppending); BeginGroup(); // Backup position on layer 0 // FIXME: Misleading to use a group for that backup/restore PushID("##MenuBar"); // We don't clip with current window clipping rectangle as it is already set to the area below. However we clip with window full rect. // We remove 1 worth of rounding to Max.x to that text in long menus and small windows don't tend to display over the lower-right rounded area, which looks particularly glitchy. const float border_top = ImMax(window->WindowBorderSize * 0.5f - window->TitleBarHeight, 0.0f); ImRect bar_rect = window->MenuBarRect(); ImRect clip_rect(IM_ROUND(bar_rect.Min.x + window->WindowBorderSize * 0.5f), IM_ROUND(bar_rect.Min.y + border_top), IM_ROUND(ImMax(bar_rect.Min.x, bar_rect.Max.x - ImMax(window->WindowRounding, window->WindowBorderSize * 0.5f))), IM_ROUND(bar_rect.Max.y)); clip_rect.ClipWith(window->OuterRectClipped); PushClipRect(clip_rect.Min, clip_rect.Max, false); // We overwrite CursorMaxPos because BeginGroup sets it to CursorPos (essentially the .EmitItem hack in EndMenuBar() would need something analogous here, maybe a BeginGroupEx() with flags). window->DC.CursorPos = window->DC.CursorMaxPos = ImVec2(bar_rect.Min.x + window->DC.MenuBarOffset.x, bar_rect.Min.y + window->DC.MenuBarOffset.y); window->DC.LayoutType = ImGuiLayoutType_Horizontal; window->DC.IsSameLine = false; window->DC.NavLayerCurrent = ImGuiNavLayer_Menu; window->DC.MenuBarAppending = true; AlignTextToFramePadding(); return true; } void ImGui::EndMenuBar() { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return; ImGuiContext& g = *GImGui; IM_MSVC_WARNING_SUPPRESS(6011); // Static Analysis false positive "warning C6011: Dereferencing NULL pointer 'window'" IM_ASSERT(window->Flags & ImGuiWindowFlags_MenuBar); IM_ASSERT(window->DC.MenuBarAppending); // Nav: When a move request within one of our child menu failed, capture the request to navigate among our siblings. if (NavMoveRequestButNoResultYet() && (g.NavMoveDir == ImGuiDir_Left || g.NavMoveDir == ImGuiDir_Right) && (g.NavWindow->Flags & ImGuiWindowFlags_ChildMenu)) { // Try to find out if the request is for one of our child menu ImGuiWindow* nav_earliest_child = g.NavWindow; while (nav_earliest_child->ParentWindow && (nav_earliest_child->ParentWindow->Flags & ImGuiWindowFlags_ChildMenu)) nav_earliest_child = nav_earliest_child->ParentWindow; if (nav_earliest_child->ParentWindow == window && nav_earliest_child->DC.ParentLayoutType == ImGuiLayoutType_Horizontal && (g.NavMoveFlags & ImGuiNavMoveFlags_Forwarded) == 0) { // To do so we claim focus back, restore NavId and then process the movement request for yet another frame. // This involve a one-frame delay which isn't very problematic in this situation. We could remove it by scoring in advance for multiple window (probably not worth bothering) const ImGuiNavLayer layer = ImGuiNavLayer_Menu; IM_ASSERT(window->DC.NavLayersActiveMaskNext & (1 << layer)); // Sanity check (FIXME: Seems unnecessary) FocusWindow(window); SetNavID(window->NavLastIds[layer], layer, 0, window->NavRectRel[layer]); // FIXME-NAV: How to deal with this when not using g.IO.ConfigNavCursorVisibleAuto? if (g.NavCursorVisible) { g.NavCursorVisible = false; // Hide nav cursor for the current frame so we don't see the intermediary selection. Will be set again g.NavCursorHideFrames = 2; } g.NavHighlightItemUnderNav = g.NavMousePosDirty = true; NavMoveRequestForward(g.NavMoveDir, g.NavMoveClipDir, g.NavMoveFlags, g.NavMoveScrollFlags); // Repeat } } PopClipRect(); PopID(); window->DC.MenuBarOffset.x = window->DC.CursorPos.x - window->Pos.x; // Save horizontal position so next append can reuse it. This is kinda equivalent to a per-layer CursorPos. // FIXME: Extremely confusing, cleanup by (a) working on WorkRect stack system (b) not using a Group confusingly here. ImGuiGroupData& group_data = g.GroupStack.back(); group_data.EmitItem = false; ImVec2 restore_cursor_max_pos = group_data.BackupCursorMaxPos; window->DC.IdealMaxPos.x = ImMax(window->DC.IdealMaxPos.x, window->DC.CursorMaxPos.x - window->Scroll.x); // Convert ideal extents for scrolling layer equivalent. EndGroup(); // Restore position on layer 0 // FIXME: Misleading to use a group for that backup/restore window->DC.LayoutType = ImGuiLayoutType_Vertical; window->DC.IsSameLine = false; window->DC.NavLayerCurrent = ImGuiNavLayer_Main; window->DC.MenuBarAppending = false; window->DC.CursorMaxPos = restore_cursor_max_pos; } // Important: calling order matters! // FIXME: Somehow overlapping with docking tech. // FIXME: The "rect-cut" aspect of this could be formalized into a lower-level helper (rect-cut: https://halt.software/dead-simple-layouts) bool ImGui::BeginViewportSideBar(const char* name, ImGuiViewport* viewport_p, ImGuiDir dir, float axis_size, ImGuiWindowFlags window_flags) { IM_ASSERT(dir != ImGuiDir_None); ImGuiWindow* bar_window = FindWindowByName(name); if (bar_window == NULL || bar_window->BeginCount == 0) { // Calculate and set window size/position ImGuiViewportP* viewport = (ImGuiViewportP*)(void*)(viewport_p ? viewport_p : GetMainViewport()); ImRect avail_rect = viewport->GetBuildWorkRect(); ImGuiAxis axis = (dir == ImGuiDir_Up || dir == ImGuiDir_Down) ? ImGuiAxis_Y : ImGuiAxis_X; ImVec2 pos = avail_rect.Min; if (dir == ImGuiDir_Right || dir == ImGuiDir_Down) pos[axis] = avail_rect.Max[axis] - axis_size; ImVec2 size = avail_rect.GetSize(); size[axis] = axis_size; SetNextWindowPos(pos); SetNextWindowSize(size); // Report our size into work area (for next frame) using actual window size if (dir == ImGuiDir_Up || dir == ImGuiDir_Left) viewport->BuildWorkInsetMin[axis] += axis_size; else if (dir == ImGuiDir_Down || dir == ImGuiDir_Right) viewport->BuildWorkInsetMax[axis] += axis_size; } window_flags |= ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoMove; PushStyleVar(ImGuiStyleVar_WindowRounding, 0.0f); PushStyleVar(ImGuiStyleVar_WindowMinSize, ImVec2(0, 0)); // Lift normal size constraint bool is_open = Begin(name, NULL, window_flags); PopStyleVar(2); return is_open; } bool ImGui::BeginMainMenuBar() { ImGuiContext& g = *GImGui; ImGuiViewportP* viewport = (ImGuiViewportP*)(void*)GetMainViewport(); // For the main menu bar, which cannot be moved, we honor g.Style.DisplaySafeAreaPadding to ensure text can be visible on a TV set. // FIXME: This could be generalized as an opt-in way to clamp window->DC.CursorStartPos to avoid SafeArea? // FIXME: Consider removing support for safe area down the line... it's messy. Nowadays consoles have support for TV calibration in OS settings. g.NextWindowData.MenuBarOffsetMinVal = ImVec2(g.Style.DisplaySafeAreaPadding.x, ImMax(g.Style.DisplaySafeAreaPadding.y - g.Style.FramePadding.y, 0.0f)); ImGuiWindowFlags window_flags = ImGuiWindowFlags_NoScrollbar | ImGuiWindowFlags_NoSavedSettings | ImGuiWindowFlags_MenuBar; float height = GetFrameHeight(); bool is_open = BeginViewportSideBar("##MainMenuBar", viewport, ImGuiDir_Up, height, window_flags); g.NextWindowData.MenuBarOffsetMinVal = ImVec2(0.0f, 0.0f); if (!is_open) { End(); return false; } // Temporarily disable _NoSavedSettings, in the off-chance that tables or child windows submitted within the menu-bar may want to use settings. (#8356) g.CurrentWindow->Flags &= ~ImGuiWindowFlags_NoSavedSettings; BeginMenuBar(); return is_open; } void ImGui::EndMainMenuBar() { ImGuiContext& g = *GImGui; if (!g.CurrentWindow->DC.MenuBarAppending) { IM_ASSERT_USER_ERROR(0, "Calling EndMainMenuBar() not from a menu-bar!"); // Not technically testing that it is the main menu bar return; } EndMenuBar(); g.CurrentWindow->Flags |= ImGuiWindowFlags_NoSavedSettings; // Restore _NoSavedSettings (#8356) // When the user has left the menu layer (typically: closed menus through activation of an item), we restore focus to the previous window // FIXME: With this strategy we won't be able to restore a NULL focus. if (g.CurrentWindow == g.NavWindow && g.NavLayer == ImGuiNavLayer_Main && !g.NavAnyRequest && g.ActiveId == 0) FocusTopMostWindowUnderOne(g.NavWindow, NULL, NULL, ImGuiFocusRequestFlags_UnlessBelowModal | ImGuiFocusRequestFlags_RestoreFocusedChild); End(); } static bool IsRootOfOpenMenuSet() { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; if ((g.OpenPopupStack.Size <= g.BeginPopupStack.Size) || (window->Flags & ImGuiWindowFlags_ChildMenu)) return false; // Initially we used 'upper_popup->OpenParentId == window->IDStack.back()' to differentiate multiple menu sets from each others // (e.g. inside menu bar vs loose menu items) based on parent ID. // This would however prevent the use of e.g. PushID() user code submitting menus. // Previously this worked between popup and a first child menu because the first child menu always had the _ChildWindow flag, // making hovering on parent popup possible while first child menu was focused - but this was generally a bug with other side effects. // Instead we don't treat Popup specifically (in order to consistently support menu features in them), maybe the first child menu of a Popup // doesn't have the _ChildWindow flag, and we rely on this IsRootOfOpenMenuSet() check to allow hovering between root window/popup and first child menu. // In the end, lack of ID check made it so we could no longer differentiate between separate menu sets. To compensate for that, we at least check parent window nav layer. // This fixes the most common case of menu opening on hover when moving between window content and menu bar. Multiple different menu sets in same nav layer would still // open on hover, but that should be a lesser problem, because if such menus are close in proximity in window content then it won't feel weird and if they are far apart // it likely won't be a problem anyone runs into. const ImGuiPopupData* upper_popup = &g.OpenPopupStack[g.BeginPopupStack.Size]; if (window->DC.NavLayerCurrent != upper_popup->ParentNavLayer) return false; return upper_popup->Window && (upper_popup->Window->Flags & ImGuiWindowFlags_ChildMenu) && ImGui::IsWindowChildOf(upper_popup->Window, window, true); } bool ImGui::BeginMenuEx(const char* label, const char* icon, bool enabled) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; ImGuiContext& g = *GImGui; const ImGuiStyle& style = g.Style; const ImGuiID id = window->GetID(label); bool menu_is_open = IsPopupOpen(id, ImGuiPopupFlags_None); // Sub-menus are ChildWindow so that mouse can be hovering across them (otherwise top-most popup menu would steal focus and not allow hovering on parent menu) // The first menu in a hierarchy isn't so hovering doesn't get across (otherwise e.g. resizing borders with ImGuiButtonFlags_FlattenChildren would react), but top-most BeginMenu() will bypass that limitation. ImGuiWindowFlags window_flags = ImGuiWindowFlags_ChildMenu | ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoSavedSettings | ImGuiWindowFlags_NoNavFocus; if (window->Flags & ImGuiWindowFlags_ChildMenu) window_flags |= ImGuiWindowFlags_ChildWindow; // If a menu with same the ID was already submitted, we will append to it, matching the behavior of Begin(). // We are relying on a O(N) search - so O(N log N) over the frame - which seems like the most efficient for the expected small amount of BeginMenu() calls per frame. // If somehow this is ever becoming a problem we can switch to use e.g. ImGuiStorage mapping key to last frame used. if (g.MenusIdSubmittedThisFrame.contains(id)) { if (menu_is_open) menu_is_open = BeginPopupMenuEx(id, label, window_flags); // menu_is_open can be 'false' when the popup is completely clipped (e.g. zero size display) else g.NextWindowData.ClearFlags(); // we behave like Begin() and need to consume those values return menu_is_open; } // Tag menu as used. Next time BeginMenu() with same ID is called it will append to existing menu g.MenusIdSubmittedThisFrame.push_back(id); ImVec2 label_size = CalcTextSize(label, NULL, true); // Odd hack to allow hovering across menus of a same menu-set (otherwise we wouldn't be able to hover parent without always being a Child window) // This is only done for items for the menu set and not the full parent window. const bool menuset_is_open = IsRootOfOpenMenuSet(); if (menuset_is_open) PushItemFlag(ImGuiItemFlags_NoWindowHoverableCheck, true); // The reference position stored in popup_pos will be used by Begin() to find a suitable position for the child menu, // However the final position is going to be different! It is chosen by FindBestWindowPosForPopup(). // e.g. Menus tend to overlap each other horizontally to amplify relative Z-ordering. ImVec2 popup_pos, pos = window->DC.CursorPos; PushID(label); if (!enabled) BeginDisabled(); const ImGuiMenuColumns* offsets = &window->DC.MenuColumns; bool pressed; // We use ImGuiSelectableFlags_NoSetKeyOwner to allow down on one menu item, move, up on another. const ImGuiSelectableFlags selectable_flags = ImGuiSelectableFlags_NoHoldingActiveID | ImGuiSelectableFlags_NoSetKeyOwner | ImGuiSelectableFlags_SelectOnClick | ImGuiSelectableFlags_NoAutoClosePopups; if (window->DC.LayoutType == ImGuiLayoutType_Horizontal) { // Menu inside a horizontal menu bar // Selectable extend their highlight by half ItemSpacing in each direction. // For ChildMenu, the popup position will be overwritten by the call to FindBestWindowPosForPopup() in Begin() popup_pos = ImVec2(pos.x - 1.0f - IM_TRUNC(style.ItemSpacing.x * 0.5f), pos.y - style.FramePadding.y + window->MenuBarHeight); window->DC.CursorPos.x += IM_TRUNC(style.ItemSpacing.x * 0.5f); PushStyleVarX(ImGuiStyleVar_ItemSpacing, style.ItemSpacing.x * 2.0f); float w = label_size.x; ImVec2 text_pos(window->DC.CursorPos.x + offsets->OffsetLabel, window->DC.CursorPos.y + window->DC.CurrLineTextBaseOffset); pressed = Selectable("", menu_is_open, selectable_flags, ImVec2(w, label_size.y)); LogSetNextTextDecoration("[", "]"); RenderText(text_pos, label); PopStyleVar(); window->DC.CursorPos.x += IM_TRUNC(style.ItemSpacing.x * (-1.0f + 0.5f)); // -1 spacing to compensate the spacing added when Selectable() did a SameLine(). It would also work to call SameLine() ourselves after the PopStyleVar(). } else { // Menu inside a regular/vertical menu // (In a typical menu window where all items are BeginMenu() or MenuItem() calls, extra_w will always be 0.0f. // Only when they are other items sticking out we're going to add spacing, yet only register minimum width into the layout system. popup_pos = ImVec2(pos.x, pos.y - style.WindowPadding.y); float icon_w = (icon && icon[0]) ? CalcTextSize(icon, NULL).x : 0.0f; float checkmark_w = IM_TRUNC(g.FontSize * 1.20f); float min_w = window->DC.MenuColumns.DeclColumns(icon_w, label_size.x, 0.0f, checkmark_w); // Feedback to next frame float extra_w = ImMax(0.0f, GetContentRegionAvail().x - min_w); ImVec2 text_pos(window->DC.CursorPos.x + offsets->OffsetLabel, window->DC.CursorPos.y + window->DC.CurrLineTextBaseOffset); pressed = Selectable("", menu_is_open, selectable_flags | ImGuiSelectableFlags_SpanAvailWidth, ImVec2(min_w, label_size.y)); LogSetNextTextDecoration("", ">"); RenderText(text_pos, label); if (icon_w > 0.0f) RenderText(pos + ImVec2(offsets->OffsetIcon, 0.0f), icon); RenderArrow(window->DrawList, pos + ImVec2(offsets->OffsetMark + extra_w + g.FontSize * 0.30f, 0.0f), GetColorU32(ImGuiCol_Text), ImGuiDir_Right); } if (!enabled) EndDisabled(); const bool hovered = (g.HoveredId == id) && enabled && !g.NavHighlightItemUnderNav; if (menuset_is_open) PopItemFlag(); bool want_open = false; bool want_open_nav_init = false; bool want_close = false; if (window->DC.LayoutType == ImGuiLayoutType_Vertical) // (window->Flags & (ImGuiWindowFlags_Popup|ImGuiWindowFlags_ChildMenu)) { // Close menu when not hovering it anymore unless we are moving roughly in the direction of the menu // Implement http://bjk5.com/post/44698559168/breaking-down-amazons-mega-dropdown to avoid using timers, so menus feels more reactive. bool moving_toward_child_menu = false; ImGuiPopupData* child_popup = (g.BeginPopupStack.Size < g.OpenPopupStack.Size) ? &g.OpenPopupStack[g.BeginPopupStack.Size] : NULL; // Popup candidate (testing below) ImGuiWindow* child_menu_window = (child_popup && child_popup->Window && child_popup->Window->ParentWindow == window) ? child_popup->Window : NULL; if (g.HoveredWindow == window && child_menu_window != NULL) { const float ref_unit = g.FontSize; // FIXME-DPI const float child_dir = (window->Pos.x < child_menu_window->Pos.x) ? 1.0f : -1.0f; const ImRect next_window_rect = child_menu_window->Rect(); ImVec2 ta = (g.IO.MousePos - g.IO.MouseDelta); ImVec2 tb = (child_dir > 0.0f) ? next_window_rect.GetTL() : next_window_rect.GetTR(); ImVec2 tc = (child_dir > 0.0f) ? next_window_rect.GetBL() : next_window_rect.GetBR(); const float pad_farmost_h = ImClamp(ImFabs(ta.x - tb.x) * 0.30f, ref_unit * 0.5f, ref_unit * 2.5f); // Add a bit of extra slack. ta.x += child_dir * -0.5f; tb.x += child_dir * ref_unit; tc.x += child_dir * ref_unit; tb.y = ta.y + ImMax((tb.y - pad_farmost_h) - ta.y, -ref_unit * 8.0f); // Triangle has maximum height to limit the slope and the bias toward large sub-menus tc.y = ta.y + ImMin((tc.y + pad_farmost_h) - ta.y, +ref_unit * 8.0f); moving_toward_child_menu = ImTriangleContainsPoint(ta, tb, tc, g.IO.MousePos); //GetForegroundDrawList()->AddTriangleFilled(ta, tb, tc, moving_toward_child_menu ? IM_COL32(0,128,0,128) : IM_COL32(128,0,0,128)); // [DEBUG] } // The 'HovereWindow == window' check creates an inconsistency (e.g. moving away from menu slowly tends to hit same window, whereas moving away fast does not) // But we also need to not close the top-menu menu when moving over void. Perhaps we should extend the triangle check to a larger polygon. // (Remember to test this on BeginPopup("A")->BeginMenu("B") sequence which behaves slightly differently as B isn't a Child of A and hovering isn't shared.) if (menu_is_open && !hovered && g.HoveredWindow == window && !moving_toward_child_menu && !g.NavHighlightItemUnderNav && g.ActiveId == 0) want_close = true; // Open // (note: at this point 'hovered' actually includes the NavDisableMouseHover == false test) if (!menu_is_open && pressed) // Click/activate to open want_open = true; else if (!menu_is_open && hovered && !moving_toward_child_menu) // Hover to open want_open = true; else if (!menu_is_open && hovered && g.HoveredIdTimer >= 0.30f && g.MouseStationaryTimer >= 0.30f) // Hover to open (timer fallback) want_open = true; if (g.NavId == id && g.NavMoveDir == ImGuiDir_Right) // Nav-Right to open { want_open = want_open_nav_init = true; NavMoveRequestCancel(); SetNavCursorVisibleAfterMove(); } } else { // Menu bar if (menu_is_open && pressed && menuset_is_open) // Click an open menu again to close it { want_close = true; want_open = menu_is_open = false; } else if (pressed || (hovered && menuset_is_open && !menu_is_open)) // First click to open, then hover to open others { want_open = true; } else if (g.NavId == id && g.NavMoveDir == ImGuiDir_Down) // Nav-Down to open { want_open = true; NavMoveRequestCancel(); } } if (!enabled) // explicitly close if an open menu becomes disabled, facilitate users code a lot in pattern such as 'if (BeginMenu("options", has_object)) { ..use object.. }' want_close = true; if (want_close && IsPopupOpen(id, ImGuiPopupFlags_None)) ClosePopupToLevel(g.BeginPopupStack.Size, true); IMGUI_TEST_ENGINE_ITEM_INFO(id, label, g.LastItemData.StatusFlags | ImGuiItemStatusFlags_Openable | (menu_is_open ? ImGuiItemStatusFlags_Opened : 0)); PopID(); if (want_open && !menu_is_open && g.OpenPopupStack.Size > g.BeginPopupStack.Size) { // Don't reopen/recycle same menu level in the same frame if it is a different menu ID, first close the other menu and yield for a frame. OpenPopup(label); } else if (want_open) { menu_is_open = true; OpenPopup(label, ImGuiPopupFlags_NoReopen);// | (want_open_nav_init ? ImGuiPopupFlags_NoReopenAlwaysNavInit : 0)); } if (menu_is_open) { ImGuiLastItemData last_item_in_parent = g.LastItemData; SetNextWindowPos(popup_pos, ImGuiCond_Always); // Note: misleading: the value will serve as reference for FindBestWindowPosForPopup(), not actual pos. PushStyleVar(ImGuiStyleVar_ChildRounding, style.PopupRounding); // First level will use _PopupRounding, subsequent will use _ChildRounding menu_is_open = BeginPopupMenuEx(id, label, window_flags); // menu_is_open may be 'false' when the popup is completely clipped (e.g. zero size display) PopStyleVar(); if (menu_is_open) { // Implement what ImGuiPopupFlags_NoReopenAlwaysNavInit would do: // Perform an init request in the case the popup was already open (via a previous mouse hover) if (want_open && want_open_nav_init && !g.NavInitRequest) { FocusWindow(g.CurrentWindow, ImGuiFocusRequestFlags_UnlessBelowModal); NavInitWindow(g.CurrentWindow, false); } // Restore LastItemData so IsItemXXXX functions can work after BeginMenu()/EndMenu() // (This fixes using IsItemClicked() and IsItemHovered(), but IsItemHovered() also relies on its support for ImGuiItemFlags_NoWindowHoverableCheck) g.LastItemData = last_item_in_parent; if (g.HoveredWindow == window) g.LastItemData.StatusFlags |= ImGuiItemStatusFlags_HoveredWindow; } } else { g.NextWindowData.ClearFlags(); // We behave like Begin() and need to consume those values } return menu_is_open; } bool ImGui::BeginMenu(const char* label, bool enabled) { return BeginMenuEx(label, NULL, enabled); } void ImGui::EndMenu() { // Nav: When a left move request our menu failed, close ourselves. ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; IM_ASSERT(window->Flags & ImGuiWindowFlags_Popup); // Mismatched BeginMenu()/EndMenu() calls ImGuiWindow* parent_window = window->ParentWindow; // Should always be != NULL is we passed assert. if (window->BeginCount == window->BeginCountPreviousFrame) if (g.NavMoveDir == ImGuiDir_Left && NavMoveRequestButNoResultYet()) if (g.NavWindow && (g.NavWindow->RootWindowForNav == window) && parent_window->DC.LayoutType == ImGuiLayoutType_Vertical) { ClosePopupToLevel(g.BeginPopupStack.Size - 1, true); NavMoveRequestCancel(); } EndPopup(); } bool ImGui::MenuItemEx(const char* label, const char* icon, const char* shortcut, bool selected, bool enabled) { ImGuiWindow* window = GetCurrentWindow(); if (window->SkipItems) return false; ImGuiContext& g = *GImGui; ImGuiStyle& style = g.Style; ImVec2 pos = window->DC.CursorPos; ImVec2 label_size = CalcTextSize(label, NULL, true); // See BeginMenuEx() for comments about this. const bool menuset_is_open = IsRootOfOpenMenuSet(); if (menuset_is_open) PushItemFlag(ImGuiItemFlags_NoWindowHoverableCheck, true); // We've been using the equivalent of ImGuiSelectableFlags_SetNavIdOnHover on all Selectable() since early Nav system days (commit 43ee5d73), // but I am unsure whether this should be kept at all. For now moved it to be an opt-in feature used by menus only. bool pressed; PushID(label); if (!enabled) BeginDisabled(); // We use ImGuiSelectableFlags_NoSetKeyOwner to allow down on one menu item, move, up on another. const ImGuiSelectableFlags selectable_flags = ImGuiSelectableFlags_SelectOnRelease | ImGuiSelectableFlags_NoSetKeyOwner | ImGuiSelectableFlags_SetNavIdOnHover; const ImGuiMenuColumns* offsets = &window->DC.MenuColumns; if (window->DC.LayoutType == ImGuiLayoutType_Horizontal) { // Mimic the exact layout spacing of BeginMenu() to allow MenuItem() inside a menu bar, which is a little misleading but may be useful // Note that in this situation: we don't render the shortcut, we render a highlight instead of the selected tick mark. float w = label_size.x; window->DC.CursorPos.x += IM_TRUNC(style.ItemSpacing.x * 0.5f); ImVec2 text_pos(window->DC.CursorPos.x + offsets->OffsetLabel, window->DC.CursorPos.y + window->DC.CurrLineTextBaseOffset); PushStyleVarX(ImGuiStyleVar_ItemSpacing, style.ItemSpacing.x * 2.0f); pressed = Selectable("", selected, selectable_flags, ImVec2(w, 0.0f)); PopStyleVar(); if (g.LastItemData.StatusFlags & ImGuiItemStatusFlags_Visible) RenderText(text_pos, label); window->DC.CursorPos.x += IM_TRUNC(style.ItemSpacing.x * (-1.0f + 0.5f)); // -1 spacing to compensate the spacing added when Selectable() did a SameLine(). It would also work to call SameLine() ourselves after the PopStyleVar(). } else { // Menu item inside a vertical menu // (In a typical menu window where all items are BeginMenu() or MenuItem() calls, extra_w will always be 0.0f. // Only when they are other items sticking out we're going to add spacing, yet only register minimum width into the layout system. float icon_w = (icon && icon[0]) ? CalcTextSize(icon, NULL).x : 0.0f; float shortcut_w = (shortcut && shortcut[0]) ? CalcTextSize(shortcut, NULL).x : 0.0f; float checkmark_w = IM_TRUNC(g.FontSize * 1.20f); float min_w = window->DC.MenuColumns.DeclColumns(icon_w, label_size.x, shortcut_w, checkmark_w); // Feedback for next frame float stretch_w = ImMax(0.0f, GetContentRegionAvail().x - min_w); pressed = Selectable("", false, selectable_flags | ImGuiSelectableFlags_SpanAvailWidth, ImVec2(min_w, label_size.y)); if (g.LastItemData.StatusFlags & ImGuiItemStatusFlags_Visible) { RenderText(pos + ImVec2(offsets->OffsetLabel, 0.0f), label); if (icon_w > 0.0f) RenderText(pos + ImVec2(offsets->OffsetIcon, 0.0f), icon); if (shortcut_w > 0.0f) { PushStyleColor(ImGuiCol_Text, style.Colors[ImGuiCol_TextDisabled]); LogSetNextTextDecoration("(", ")"); RenderText(pos + ImVec2(offsets->OffsetShortcut + stretch_w, 0.0f), shortcut, NULL, false); PopStyleColor(); } if (selected) RenderCheckMark(window->DrawList, pos + ImVec2(offsets->OffsetMark + stretch_w + g.FontSize * 0.40f, g.FontSize * 0.134f * 0.5f), GetColorU32(ImGuiCol_Text), g.FontSize * 0.866f); } } IMGUI_TEST_ENGINE_ITEM_INFO(g.LastItemData.ID, label, g.LastItemData.StatusFlags | ImGuiItemStatusFlags_Checkable | (selected ? ImGuiItemStatusFlags_Checked : 0)); if (!enabled) EndDisabled(); PopID(); if (menuset_is_open) PopItemFlag(); return pressed; } bool ImGui::MenuItem(const char* label, const char* shortcut, bool selected, bool enabled) { return MenuItemEx(label, NULL, shortcut, selected, enabled); } bool ImGui::MenuItem(const char* label, const char* shortcut, bool* p_selected, bool enabled) { if (MenuItemEx(label, NULL, shortcut, p_selected ? *p_selected : false, enabled)) { if (p_selected) *p_selected = !*p_selected; return true; } return false; } //------------------------------------------------------------------------- // [SECTION] Widgets: BeginTabBar, EndTabBar, etc. //------------------------------------------------------------------------- // - BeginTabBar() // - BeginTabBarEx() [Internal] // - EndTabBar() // - TabBarLayout() [Internal] // - TabBarCalcTabID() [Internal] // - TabBarCalcMaxTabWidth() [Internal] // - TabBarFindTabById() [Internal] // - TabBarFindTabByOrder() [Internal] // - TabBarGetCurrentTab() [Internal] // - TabBarGetTabName() [Internal] // - TabBarRemoveTab() [Internal] // - TabBarCloseTab() [Internal] // - TabBarScrollClamp() [Internal] // - TabBarScrollToTab() [Internal] // - TabBarQueueFocus() [Internal] // - TabBarQueueReorder() [Internal] // - TabBarProcessReorderFromMousePos() [Internal] // - TabBarProcessReorder() [Internal] // - TabBarScrollingButtons() [Internal] // - TabBarTabListPopupButton() [Internal] //------------------------------------------------------------------------- struct ImGuiTabBarSection { int TabCount; // Number of tabs in this section. float Width; // Sum of width of tabs in this section (after shrinking down) float Spacing; // Horizontal spacing at the end of the section. ImGuiTabBarSection() { memset(this, 0, sizeof(*this)); } }; namespace ImGui { static void TabBarLayout(ImGuiTabBar* tab_bar); static ImU32 TabBarCalcTabID(ImGuiTabBar* tab_bar, const char* label, ImGuiWindow* docked_window); static float TabBarCalcMaxTabWidth(); static float TabBarScrollClamp(ImGuiTabBar* tab_bar, float scrolling); static void TabBarScrollToTab(ImGuiTabBar* tab_bar, ImGuiID tab_id, ImGuiTabBarSection* sections); static ImGuiTabItem* TabBarScrollingButtons(ImGuiTabBar* tab_bar); static ImGuiTabItem* TabBarTabListPopupButton(ImGuiTabBar* tab_bar); } ImGuiTabBar::ImGuiTabBar() { memset(this, 0, sizeof(*this)); CurrFrameVisible = PrevFrameVisible = -1; LastTabItemIdx = -1; } static inline int TabItemGetSectionIdx(const ImGuiTabItem* tab) { return (tab->Flags & ImGuiTabItemFlags_Leading) ? 0 : (tab->Flags & ImGuiTabItemFlags_Trailing) ? 2 : 1; } static int IMGUI_CDECL TabItemComparerBySection(const void* lhs, const void* rhs) { const ImGuiTabItem* a = (const ImGuiTabItem*)lhs; const ImGuiTabItem* b = (const ImGuiTabItem*)rhs; const int a_section = TabItemGetSectionIdx(a); const int b_section = TabItemGetSectionIdx(b); if (a_section != b_section) return a_section - b_section; return (int)(a->IndexDuringLayout - b->IndexDuringLayout); } static int IMGUI_CDECL TabItemComparerByBeginOrder(const void* lhs, const void* rhs) { const ImGuiTabItem* a = (const ImGuiTabItem*)lhs; const ImGuiTabItem* b = (const ImGuiTabItem*)rhs; return (int)(a->BeginOrder - b->BeginOrder); } static ImGuiTabBar* GetTabBarFromTabBarRef(const ImGuiPtrOrIndex& ref) { ImGuiContext& g = *GImGui; return ref.Ptr ? (ImGuiTabBar*)ref.Ptr : g.TabBars.GetByIndex(ref.Index); } static ImGuiPtrOrIndex GetTabBarRefFromTabBar(ImGuiTabBar* tab_bar) { ImGuiContext& g = *GImGui; if (g.TabBars.Contains(tab_bar)) return ImGuiPtrOrIndex(g.TabBars.GetIndex(tab_bar)); return ImGuiPtrOrIndex(tab_bar); } bool ImGui::BeginTabBar(const char* str_id, ImGuiTabBarFlags flags) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; if (window->SkipItems) return false; ImGuiID id = window->GetID(str_id); ImGuiTabBar* tab_bar = g.TabBars.GetOrAddByKey(id); ImRect tab_bar_bb = ImRect(window->DC.CursorPos.x, window->DC.CursorPos.y, window->WorkRect.Max.x, window->DC.CursorPos.y + g.FontSize + g.Style.FramePadding.y * 2); tab_bar->ID = id; tab_bar->SeparatorMinX = tab_bar->BarRect.Min.x - IM_TRUNC(window->WindowPadding.x * 0.5f); tab_bar->SeparatorMaxX = tab_bar->BarRect.Max.x + IM_TRUNC(window->WindowPadding.x * 0.5f); //if (g.NavWindow && IsWindowChildOf(g.NavWindow, window, false, false)) flags |= ImGuiTabBarFlags_IsFocused; return BeginTabBarEx(tab_bar, tab_bar_bb, flags); } bool ImGui::BeginTabBarEx(ImGuiTabBar* tab_bar, const ImRect& tab_bar_bb, ImGuiTabBarFlags flags) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; if (window->SkipItems) return false; IM_ASSERT(tab_bar->ID != 0); if ((flags & ImGuiTabBarFlags_DockNode) == 0) PushOverrideID(tab_bar->ID); // Add to stack g.CurrentTabBarStack.push_back(GetTabBarRefFromTabBar(tab_bar)); g.CurrentTabBar = tab_bar; tab_bar->Window = window; // Append with multiple BeginTabBar()/EndTabBar() pairs. tab_bar->BackupCursorPos = window->DC.CursorPos; if (tab_bar->CurrFrameVisible == g.FrameCount) { window->DC.CursorPos = ImVec2(tab_bar->BarRect.Min.x, tab_bar->BarRect.Max.y + tab_bar->ItemSpacingY); tab_bar->BeginCount++; return true; } // Ensure correct ordering when toggling ImGuiTabBarFlags_Reorderable flag, or when a new tab was added while being not reorderable if ((flags & ImGuiTabBarFlags_Reorderable) != (tab_bar->Flags & ImGuiTabBarFlags_Reorderable) || (tab_bar->TabsAddedNew && !(flags & ImGuiTabBarFlags_Reorderable))) ImQsort(tab_bar->Tabs.Data, tab_bar->Tabs.Size, sizeof(ImGuiTabItem), TabItemComparerByBeginOrder); tab_bar->TabsAddedNew = false; // Flags if ((flags & ImGuiTabBarFlags_FittingPolicyMask_) == 0) flags |= ImGuiTabBarFlags_FittingPolicyDefault_; tab_bar->Flags = flags; tab_bar->BarRect = tab_bar_bb; tab_bar->WantLayout = true; // Layout will be done on the first call to ItemTab() tab_bar->PrevFrameVisible = tab_bar->CurrFrameVisible; tab_bar->CurrFrameVisible = g.FrameCount; tab_bar->PrevTabsContentsHeight = tab_bar->CurrTabsContentsHeight; tab_bar->CurrTabsContentsHeight = 0.0f; tab_bar->ItemSpacingY = g.Style.ItemSpacing.y; tab_bar->FramePadding = g.Style.FramePadding; tab_bar->TabsActiveCount = 0; tab_bar->LastTabItemIdx = -1; tab_bar->BeginCount = 1; // Set cursor pos in a way which only be used in the off-chance the user erroneously submits item before BeginTabItem(): items will overlap window->DC.CursorPos = ImVec2(tab_bar->BarRect.Min.x, tab_bar->BarRect.Max.y + tab_bar->ItemSpacingY); // Draw separator // (it would be misleading to draw this in EndTabBar() suggesting that it may be drawn over tabs, as tab bar are appendable) const ImU32 col = GetColorU32((flags & ImGuiTabBarFlags_IsFocused) ? ImGuiCol_TabSelected : ImGuiCol_TabDimmedSelected); if (g.Style.TabBarBorderSize > 0.0f) { const float y = tab_bar->BarRect.Max.y; window->DrawList->AddRectFilled(ImVec2(tab_bar->SeparatorMinX, y - g.Style.TabBarBorderSize), ImVec2(tab_bar->SeparatorMaxX, y), col); } return true; } void ImGui::EndTabBar() { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; if (window->SkipItems) return; ImGuiTabBar* tab_bar = g.CurrentTabBar; if (tab_bar == NULL) { IM_ASSERT_USER_ERROR(tab_bar != NULL, "Mismatched BeginTabBar()/EndTabBar()!"); return; } // Fallback in case no TabItem have been submitted if (tab_bar->WantLayout) TabBarLayout(tab_bar); // Restore the last visible height if no tab is visible, this reduce vertical flicker/movement when a tabs gets removed without calling SetTabItemClosed(). const bool tab_bar_appearing = (tab_bar->PrevFrameVisible + 1 < g.FrameCount); if (tab_bar->VisibleTabWasSubmitted || tab_bar->VisibleTabId == 0 || tab_bar_appearing) { tab_bar->CurrTabsContentsHeight = ImMax(window->DC.CursorPos.y - tab_bar->BarRect.Max.y, tab_bar->CurrTabsContentsHeight); window->DC.CursorPos.y = tab_bar->BarRect.Max.y + tab_bar->CurrTabsContentsHeight; } else { window->DC.CursorPos.y = tab_bar->BarRect.Max.y + tab_bar->PrevTabsContentsHeight; } if (tab_bar->BeginCount > 1) window->DC.CursorPos = tab_bar->BackupCursorPos; tab_bar->LastTabItemIdx = -1; if ((tab_bar->Flags & ImGuiTabBarFlags_DockNode) == 0) PopID(); g.CurrentTabBarStack.pop_back(); g.CurrentTabBar = g.CurrentTabBarStack.empty() ? NULL : GetTabBarFromTabBarRef(g.CurrentTabBarStack.back()); } // Scrolling happens only in the central section (leading/trailing sections are not scrolling) static float TabBarCalcScrollableWidth(ImGuiTabBar* tab_bar, ImGuiTabBarSection* sections) { return tab_bar->BarRect.GetWidth() - sections[0].Width - sections[2].Width - sections[1].Spacing; } // This is called only once a frame before by the first call to ItemTab() // The reason we're not calling it in BeginTabBar() is to leave a chance to the user to call the SetTabItemClosed() functions. static void ImGui::TabBarLayout(ImGuiTabBar* tab_bar) { ImGuiContext& g = *GImGui; tab_bar->WantLayout = false; // Garbage collect by compacting list // Detect if we need to sort out tab list (e.g. in rare case where a tab changed section) int tab_dst_n = 0; bool need_sort_by_section = false; ImGuiTabBarSection sections[3]; // Layout sections: Leading, Central, Trailing for (int tab_src_n = 0; tab_src_n < tab_bar->Tabs.Size; tab_src_n++) { ImGuiTabItem* tab = &tab_bar->Tabs[tab_src_n]; if (tab->LastFrameVisible < tab_bar->PrevFrameVisible || tab->WantClose) { // Remove tab if (tab_bar->VisibleTabId == tab->ID) { tab_bar->VisibleTabId = 0; } if (tab_bar->SelectedTabId == tab->ID) { tab_bar->SelectedTabId = 0; } if (tab_bar->NextSelectedTabId == tab->ID) { tab_bar->NextSelectedTabId = 0; } continue; } if (tab_dst_n != tab_src_n) tab_bar->Tabs[tab_dst_n] = tab_bar->Tabs[tab_src_n]; tab = &tab_bar->Tabs[tab_dst_n]; tab->IndexDuringLayout = (ImS16)tab_dst_n; // We will need sorting if tabs have changed section (e.g. moved from one of Leading/Central/Trailing to another) int curr_tab_section_n = TabItemGetSectionIdx(tab); if (tab_dst_n > 0) { ImGuiTabItem* prev_tab = &tab_bar->Tabs[tab_dst_n - 1]; int prev_tab_section_n = TabItemGetSectionIdx(prev_tab); if (curr_tab_section_n == 0 && prev_tab_section_n != 0) need_sort_by_section = true; if (prev_tab_section_n == 2 && curr_tab_section_n != 2) need_sort_by_section = true; } sections[curr_tab_section_n].TabCount++; tab_dst_n++; } if (tab_bar->Tabs.Size != tab_dst_n) tab_bar->Tabs.resize(tab_dst_n); if (need_sort_by_section) ImQsort(tab_bar->Tabs.Data, tab_bar->Tabs.Size, sizeof(ImGuiTabItem), TabItemComparerBySection); // Calculate spacing between sections sections[0].Spacing = sections[0].TabCount > 0 && (sections[1].TabCount + sections[2].TabCount) > 0 ? g.Style.ItemInnerSpacing.x : 0.0f; sections[1].Spacing = sections[1].TabCount > 0 && sections[2].TabCount > 0 ? g.Style.ItemInnerSpacing.x : 0.0f; // Setup next selected tab ImGuiID scroll_to_tab_id = 0; if (tab_bar->NextSelectedTabId) { tab_bar->SelectedTabId = tab_bar->NextSelectedTabId; tab_bar->NextSelectedTabId = 0; scroll_to_tab_id = tab_bar->SelectedTabId; } // Process order change request (we could probably process it when requested but it's just saner to do it in a single spot). if (tab_bar->ReorderRequestTabId != 0) { if (TabBarProcessReorder(tab_bar)) if (tab_bar->ReorderRequestTabId == tab_bar->SelectedTabId) scroll_to_tab_id = tab_bar->ReorderRequestTabId; tab_bar->ReorderRequestTabId = 0; } // Tab List Popup (will alter tab_bar->BarRect and therefore the available width!) const bool tab_list_popup_button = (tab_bar->Flags & ImGuiTabBarFlags_TabListPopupButton) != 0; if (tab_list_popup_button) if (ImGuiTabItem* tab_to_select = TabBarTabListPopupButton(tab_bar)) // NB: Will alter BarRect.Min.x! scroll_to_tab_id = tab_bar->SelectedTabId = tab_to_select->ID; // Leading/Trailing tabs will be shrink only if central one aren't visible anymore, so layout the shrink data as: leading, trailing, central // (whereas our tabs are stored as: leading, central, trailing) int shrink_buffer_indexes[3] = { 0, sections[0].TabCount + sections[2].TabCount, sections[0].TabCount }; g.ShrinkWidthBuffer.resize(tab_bar->Tabs.Size); // Compute ideal tabs widths + store them into shrink buffer ImGuiTabItem* most_recently_selected_tab = NULL; int curr_section_n = -1; bool found_selected_tab_id = false; for (int tab_n = 0; tab_n < tab_bar->Tabs.Size; tab_n++) { ImGuiTabItem* tab = &tab_bar->Tabs[tab_n]; IM_ASSERT(tab->LastFrameVisible >= tab_bar->PrevFrameVisible); if ((most_recently_selected_tab == NULL || most_recently_selected_tab->LastFrameSelected < tab->LastFrameSelected) && !(tab->Flags & ImGuiTabItemFlags_Button)) most_recently_selected_tab = tab; if (tab->ID == tab_bar->SelectedTabId) found_selected_tab_id = true; if (scroll_to_tab_id == 0 && g.NavJustMovedToId == tab->ID) scroll_to_tab_id = tab->ID; // Refresh tab width immediately, otherwise changes of style e.g. style.FramePadding.x would noticeably lag in the tab bar. // Additionally, when using TabBarAddTab() to manipulate tab bar order we occasionally insert new tabs that don't have a width yet, // and we cannot wait for the next BeginTabItem() call. We cannot compute this width within TabBarAddTab() because font size depends on the active window. const char* tab_name = TabBarGetTabName(tab_bar, tab); const bool has_close_button_or_unsaved_marker = (tab->Flags & ImGuiTabItemFlags_NoCloseButton) == 0 || (tab->Flags & ImGuiTabItemFlags_UnsavedDocument); tab->ContentWidth = (tab->RequestedWidth >= 0.0f) ? tab->RequestedWidth : TabItemCalcSize(tab_name, has_close_button_or_unsaved_marker).x; int section_n = TabItemGetSectionIdx(tab); ImGuiTabBarSection* section = §ions[section_n]; section->Width += tab->ContentWidth + (section_n == curr_section_n ? g.Style.ItemInnerSpacing.x : 0.0f); curr_section_n = section_n; // Store data so we can build an array sorted by width if we need to shrink tabs down IM_MSVC_WARNING_SUPPRESS(6385); ImGuiShrinkWidthItem* shrink_width_item = &g.ShrinkWidthBuffer[shrink_buffer_indexes[section_n]++]; shrink_width_item->Index = tab_n; shrink_width_item->Width = shrink_width_item->InitialWidth = tab->ContentWidth; tab->Width = ImMax(tab->ContentWidth, 1.0f); } // Compute total ideal width (used for e.g. auto-resizing a window) tab_bar->WidthAllTabsIdeal = 0.0f; for (int section_n = 0; section_n < 3; section_n++) tab_bar->WidthAllTabsIdeal += sections[section_n].Width + sections[section_n].Spacing; // Horizontal scrolling buttons // (note that TabBarScrollButtons() will alter BarRect.Max.x) if ((tab_bar->WidthAllTabsIdeal > tab_bar->BarRect.GetWidth() && tab_bar->Tabs.Size > 1) && !(tab_bar->Flags & ImGuiTabBarFlags_NoTabListScrollingButtons) && (tab_bar->Flags & ImGuiTabBarFlags_FittingPolicyScroll)) if (ImGuiTabItem* scroll_and_select_tab = TabBarScrollingButtons(tab_bar)) { scroll_to_tab_id = scroll_and_select_tab->ID; if ((scroll_and_select_tab->Flags & ImGuiTabItemFlags_Button) == 0) tab_bar->SelectedTabId = scroll_to_tab_id; } // Shrink widths if full tabs don't fit in their allocated space float section_0_w = sections[0].Width + sections[0].Spacing; float section_1_w = sections[1].Width + sections[1].Spacing; float section_2_w = sections[2].Width + sections[2].Spacing; bool central_section_is_visible = (section_0_w + section_2_w) < tab_bar->BarRect.GetWidth(); float width_excess; if (central_section_is_visible) width_excess = ImMax(section_1_w - (tab_bar->BarRect.GetWidth() - section_0_w - section_2_w), 0.0f); // Excess used to shrink central section else width_excess = (section_0_w + section_2_w) - tab_bar->BarRect.GetWidth(); // Excess used to shrink leading/trailing section // With ImGuiTabBarFlags_FittingPolicyScroll policy, we will only shrink leading/trailing if the central section is not visible anymore if (width_excess >= 1.0f && ((tab_bar->Flags & ImGuiTabBarFlags_FittingPolicyResizeDown) || !central_section_is_visible)) { int shrink_data_count = (central_section_is_visible ? sections[1].TabCount : sections[0].TabCount + sections[2].TabCount); int shrink_data_offset = (central_section_is_visible ? sections[0].TabCount + sections[2].TabCount : 0); ShrinkWidths(g.ShrinkWidthBuffer.Data + shrink_data_offset, shrink_data_count, width_excess); // Apply shrunk values into tabs and sections for (int tab_n = shrink_data_offset; tab_n < shrink_data_offset + shrink_data_count; tab_n++) { ImGuiTabItem* tab = &tab_bar->Tabs[g.ShrinkWidthBuffer[tab_n].Index]; float shrinked_width = IM_TRUNC(g.ShrinkWidthBuffer[tab_n].Width); if (shrinked_width < 0.0f) continue; shrinked_width = ImMax(1.0f, shrinked_width); int section_n = TabItemGetSectionIdx(tab); sections[section_n].Width -= (tab->Width - shrinked_width); tab->Width = shrinked_width; } } // Layout all active tabs int section_tab_index = 0; float tab_offset = 0.0f; tab_bar->WidthAllTabs = 0.0f; for (int section_n = 0; section_n < 3; section_n++) { ImGuiTabBarSection* section = §ions[section_n]; if (section_n == 2) tab_offset = ImMin(ImMax(0.0f, tab_bar->BarRect.GetWidth() - section->Width), tab_offset); for (int tab_n = 0; tab_n < section->TabCount; tab_n++) { ImGuiTabItem* tab = &tab_bar->Tabs[section_tab_index + tab_n]; tab->Offset = tab_offset; tab->NameOffset = -1; tab_offset += tab->Width + (tab_n < section->TabCount - 1 ? g.Style.ItemInnerSpacing.x : 0.0f); } tab_bar->WidthAllTabs += ImMax(section->Width + section->Spacing, 0.0f); tab_offset += section->Spacing; section_tab_index += section->TabCount; } // Clear name buffers tab_bar->TabsNames.Buf.resize(0); // If we have lost the selected tab, select the next most recently active one if (found_selected_tab_id == false) tab_bar->SelectedTabId = 0; if (tab_bar->SelectedTabId == 0 && tab_bar->NextSelectedTabId == 0 && most_recently_selected_tab != NULL) scroll_to_tab_id = tab_bar->SelectedTabId = most_recently_selected_tab->ID; // Lock in visible tab tab_bar->VisibleTabId = tab_bar->SelectedTabId; tab_bar->VisibleTabWasSubmitted = false; // Apply request requests if (scroll_to_tab_id != 0) TabBarScrollToTab(tab_bar, scroll_to_tab_id, sections); else if ((tab_bar->Flags & ImGuiTabBarFlags_FittingPolicyScroll) && IsMouseHoveringRect(tab_bar->BarRect.Min, tab_bar->BarRect.Max, true) && IsWindowContentHoverable(g.CurrentWindow)) { const float wheel = g.IO.MouseWheelRequestAxisSwap ? g.IO.MouseWheel : g.IO.MouseWheelH; const ImGuiKey wheel_key = g.IO.MouseWheelRequestAxisSwap ? ImGuiKey_MouseWheelY : ImGuiKey_MouseWheelX; if (TestKeyOwner(wheel_key, tab_bar->ID) && wheel != 0.0f) { const float scroll_step = wheel * TabBarCalcScrollableWidth(tab_bar, sections) / 3.0f; tab_bar->ScrollingTargetDistToVisibility = 0.0f; tab_bar->ScrollingTarget = TabBarScrollClamp(tab_bar, tab_bar->ScrollingTarget - scroll_step); } SetKeyOwner(wheel_key, tab_bar->ID); } // Update scrolling tab_bar->ScrollingAnim = TabBarScrollClamp(tab_bar, tab_bar->ScrollingAnim); tab_bar->ScrollingTarget = TabBarScrollClamp(tab_bar, tab_bar->ScrollingTarget); if (tab_bar->ScrollingAnim != tab_bar->ScrollingTarget) { // Scrolling speed adjust itself so we can always reach our target in 1/3 seconds. // Teleport if we are aiming far off the visible line tab_bar->ScrollingSpeed = ImMax(tab_bar->ScrollingSpeed, 70.0f * g.FontSize); tab_bar->ScrollingSpeed = ImMax(tab_bar->ScrollingSpeed, ImFabs(tab_bar->ScrollingTarget - tab_bar->ScrollingAnim) / 0.3f); const bool teleport = (tab_bar->PrevFrameVisible + 1 < g.FrameCount) || (tab_bar->ScrollingTargetDistToVisibility > 10.0f * g.FontSize); tab_bar->ScrollingAnim = teleport ? tab_bar->ScrollingTarget : ImLinearSweep(tab_bar->ScrollingAnim, tab_bar->ScrollingTarget, g.IO.DeltaTime * tab_bar->ScrollingSpeed); } else { tab_bar->ScrollingSpeed = 0.0f; } tab_bar->ScrollingRectMinX = tab_bar->BarRect.Min.x + sections[0].Width + sections[0].Spacing; tab_bar->ScrollingRectMaxX = tab_bar->BarRect.Max.x - sections[2].Width - sections[1].Spacing; // Actual layout in host window (we don't do it in BeginTabBar() so as not to waste an extra frame) ImGuiWindow* window = g.CurrentWindow; window->DC.CursorPos = tab_bar->BarRect.Min; ItemSize(ImVec2(tab_bar->WidthAllTabs, tab_bar->BarRect.GetHeight()), tab_bar->FramePadding.y); window->DC.IdealMaxPos.x = ImMax(window->DC.IdealMaxPos.x, tab_bar->BarRect.Min.x + tab_bar->WidthAllTabsIdeal); } // Dockable windows uses Name/ID in the global namespace. Non-dockable items use the ID stack. static ImU32 ImGui::TabBarCalcTabID(ImGuiTabBar* tab_bar, const char* label, ImGuiWindow* docked_window) { IM_ASSERT(docked_window == NULL); // master branch only IM_UNUSED(docked_window); if (tab_bar->Flags & ImGuiTabBarFlags_DockNode) { ImGuiID id = ImHashStr(label); KeepAliveID(id); return id; } else { ImGuiWindow* window = GImGui->CurrentWindow; return window->GetID(label); } } static float ImGui::TabBarCalcMaxTabWidth() { ImGuiContext& g = *GImGui; return g.FontSize * 20.0f; } ImGuiTabItem* ImGui::TabBarFindTabByID(ImGuiTabBar* tab_bar, ImGuiID tab_id) { if (tab_id != 0) for (int n = 0; n < tab_bar->Tabs.Size; n++) if (tab_bar->Tabs[n].ID == tab_id) return &tab_bar->Tabs[n]; return NULL; } // Order = visible order, not submission order! (which is tab->BeginOrder) ImGuiTabItem* ImGui::TabBarFindTabByOrder(ImGuiTabBar* tab_bar, int order) { if (order < 0 || order >= tab_bar->Tabs.Size) return NULL; return &tab_bar->Tabs[order]; } ImGuiTabItem* ImGui::TabBarGetCurrentTab(ImGuiTabBar* tab_bar) { if (tab_bar->LastTabItemIdx < 0 || tab_bar->LastTabItemIdx >= tab_bar->Tabs.Size) return NULL; return &tab_bar->Tabs[tab_bar->LastTabItemIdx]; } const char* ImGui::TabBarGetTabName(ImGuiTabBar* tab_bar, ImGuiTabItem* tab) { if (tab->NameOffset == -1) return "N/A"; IM_ASSERT(tab->NameOffset < tab_bar->TabsNames.Buf.Size); return tab_bar->TabsNames.Buf.Data + tab->NameOffset; } // The *TabId fields are already set by the docking system _before_ the actual TabItem was created, so we clear them regardless. void ImGui::TabBarRemoveTab(ImGuiTabBar* tab_bar, ImGuiID tab_id) { if (ImGuiTabItem* tab = TabBarFindTabByID(tab_bar, tab_id)) tab_bar->Tabs.erase(tab); if (tab_bar->VisibleTabId == tab_id) { tab_bar->VisibleTabId = 0; } if (tab_bar->SelectedTabId == tab_id) { tab_bar->SelectedTabId = 0; } if (tab_bar->NextSelectedTabId == tab_id) { tab_bar->NextSelectedTabId = 0; } } // Called on manual closure attempt void ImGui::TabBarCloseTab(ImGuiTabBar* tab_bar, ImGuiTabItem* tab) { if (tab->Flags & ImGuiTabItemFlags_Button) return; // A button appended with TabItemButton(). if ((tab->Flags & (ImGuiTabItemFlags_UnsavedDocument | ImGuiTabItemFlags_NoAssumedClosure)) == 0) { // This will remove a frame of lag for selecting another tab on closure. // However we don't run it in the case where the 'Unsaved' flag is set, so user gets a chance to fully undo the closure tab->WantClose = true; if (tab_bar->VisibleTabId == tab->ID) { tab->LastFrameVisible = -1; tab_bar->SelectedTabId = tab_bar->NextSelectedTabId = 0; } } else { // Actually select before expecting closure attempt (on an UnsavedDocument tab user is expect to e.g. show a popup) if (tab_bar->VisibleTabId != tab->ID) TabBarQueueFocus(tab_bar, tab); } } static float ImGui::TabBarScrollClamp(ImGuiTabBar* tab_bar, float scrolling) { scrolling = ImMin(scrolling, tab_bar->WidthAllTabs - tab_bar->BarRect.GetWidth()); return ImMax(scrolling, 0.0f); } // Note: we may scroll to tab that are not selected! e.g. using keyboard arrow keys static void ImGui::TabBarScrollToTab(ImGuiTabBar* tab_bar, ImGuiID tab_id, ImGuiTabBarSection* sections) { ImGuiTabItem* tab = TabBarFindTabByID(tab_bar, tab_id); if (tab == NULL) return; if (tab->Flags & ImGuiTabItemFlags_SectionMask_) return; ImGuiContext& g = *GImGui; float margin = g.FontSize * 1.0f; // When to scroll to make Tab N+1 visible always make a bit of N visible to suggest more scrolling area (since we don't have a scrollbar) int order = TabBarGetTabOrder(tab_bar, tab); // Scrolling happens only in the central section (leading/trailing sections are not scrolling) float scrollable_width = TabBarCalcScrollableWidth(tab_bar, sections); // We make all tabs positions all relative Sections[0].Width to make code simpler float tab_x1 = tab->Offset - sections[0].Width + (order > sections[0].TabCount - 1 ? -margin : 0.0f); float tab_x2 = tab->Offset - sections[0].Width + tab->Width + (order + 1 < tab_bar->Tabs.Size - sections[2].TabCount ? margin : 1.0f); tab_bar->ScrollingTargetDistToVisibility = 0.0f; if (tab_bar->ScrollingTarget > tab_x1 || (tab_x2 - tab_x1 >= scrollable_width)) { // Scroll to the left tab_bar->ScrollingTargetDistToVisibility = ImMax(tab_bar->ScrollingAnim - tab_x2, 0.0f); tab_bar->ScrollingTarget = tab_x1; } else if (tab_bar->ScrollingTarget < tab_x2 - scrollable_width) { // Scroll to the right tab_bar->ScrollingTargetDistToVisibility = ImMax((tab_x1 - scrollable_width) - tab_bar->ScrollingAnim, 0.0f); tab_bar->ScrollingTarget = tab_x2 - scrollable_width; } } void ImGui::TabBarQueueFocus(ImGuiTabBar* tab_bar, ImGuiTabItem* tab) { tab_bar->NextSelectedTabId = tab->ID; } void ImGui::TabBarQueueFocus(ImGuiTabBar* tab_bar, const char* tab_name) { IM_ASSERT((tab_bar->Flags & ImGuiTabBarFlags_DockNode) == 0); // Only supported for manual/explicit tab bars ImGuiID tab_id = TabBarCalcTabID(tab_bar, tab_name, NULL); tab_bar->NextSelectedTabId = tab_id; } void ImGui::TabBarQueueReorder(ImGuiTabBar* tab_bar, ImGuiTabItem* tab, int offset) { IM_ASSERT(offset != 0); IM_ASSERT(tab_bar->ReorderRequestTabId == 0); tab_bar->ReorderRequestTabId = tab->ID; tab_bar->ReorderRequestOffset = (ImS16)offset; } void ImGui::TabBarQueueReorderFromMousePos(ImGuiTabBar* tab_bar, ImGuiTabItem* src_tab, ImVec2 mouse_pos) { ImGuiContext& g = *GImGui; IM_ASSERT(tab_bar->ReorderRequestTabId == 0); if ((tab_bar->Flags & ImGuiTabBarFlags_Reorderable) == 0) return; const bool is_central_section = (src_tab->Flags & ImGuiTabItemFlags_SectionMask_) == 0; const float bar_offset = tab_bar->BarRect.Min.x - (is_central_section ? tab_bar->ScrollingTarget : 0); // Count number of contiguous tabs we are crossing over const int dir = (bar_offset + src_tab->Offset) > mouse_pos.x ? -1 : +1; const int src_idx = tab_bar->Tabs.index_from_ptr(src_tab); int dst_idx = src_idx; for (int i = src_idx; i >= 0 && i < tab_bar->Tabs.Size; i += dir) { // Reordered tabs must share the same section const ImGuiTabItem* dst_tab = &tab_bar->Tabs[i]; if (dst_tab->Flags & ImGuiTabItemFlags_NoReorder) break; if ((dst_tab->Flags & ImGuiTabItemFlags_SectionMask_) != (src_tab->Flags & ImGuiTabItemFlags_SectionMask_)) break; dst_idx = i; // Include spacing after tab, so when mouse cursor is between tabs we would not continue checking further tabs that are not hovered. const float x1 = bar_offset + dst_tab->Offset - g.Style.ItemInnerSpacing.x; const float x2 = bar_offset + dst_tab->Offset + dst_tab->Width + g.Style.ItemInnerSpacing.x; //GetForegroundDrawList()->AddRect(ImVec2(x1, tab_bar->BarRect.Min.y), ImVec2(x2, tab_bar->BarRect.Max.y), IM_COL32(255, 0, 0, 255)); if ((dir < 0 && mouse_pos.x > x1) || (dir > 0 && mouse_pos.x < x2)) break; } if (dst_idx != src_idx) TabBarQueueReorder(tab_bar, src_tab, dst_idx - src_idx); } bool ImGui::TabBarProcessReorder(ImGuiTabBar* tab_bar) { ImGuiTabItem* tab1 = TabBarFindTabByID(tab_bar, tab_bar->ReorderRequestTabId); if (tab1 == NULL || (tab1->Flags & ImGuiTabItemFlags_NoReorder)) return false; //IM_ASSERT(tab_bar->Flags & ImGuiTabBarFlags_Reorderable); // <- this may happen when using debug tools int tab2_order = TabBarGetTabOrder(tab_bar, tab1) + tab_bar->ReorderRequestOffset; if (tab2_order < 0 || tab2_order >= tab_bar->Tabs.Size) return false; // Reordered tabs must share the same section // (Note: TabBarQueueReorderFromMousePos() also has a similar test but since we allow direct calls to TabBarQueueReorder() we do it here too) ImGuiTabItem* tab2 = &tab_bar->Tabs[tab2_order]; if (tab2->Flags & ImGuiTabItemFlags_NoReorder) return false; if ((tab1->Flags & ImGuiTabItemFlags_SectionMask_) != (tab2->Flags & ImGuiTabItemFlags_SectionMask_)) return false; ImGuiTabItem item_tmp = *tab1; ImGuiTabItem* src_tab = (tab_bar->ReorderRequestOffset > 0) ? tab1 + 1 : tab2; ImGuiTabItem* dst_tab = (tab_bar->ReorderRequestOffset > 0) ? tab1 : tab2 + 1; const int move_count = (tab_bar->ReorderRequestOffset > 0) ? tab_bar->ReorderRequestOffset : -tab_bar->ReorderRequestOffset; memmove(dst_tab, src_tab, move_count * sizeof(ImGuiTabItem)); *tab2 = item_tmp; if (tab_bar->Flags & ImGuiTabBarFlags_SaveSettings) MarkIniSettingsDirty(); return true; } static ImGuiTabItem* ImGui::TabBarScrollingButtons(ImGuiTabBar* tab_bar) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; const ImVec2 arrow_button_size(g.FontSize - 2.0f, g.FontSize + g.Style.FramePadding.y * 2.0f); const float scrolling_buttons_width = arrow_button_size.x * 2.0f; const ImVec2 backup_cursor_pos = window->DC.CursorPos; //window->DrawList->AddRect(ImVec2(tab_bar->BarRect.Max.x - scrolling_buttons_width, tab_bar->BarRect.Min.y), ImVec2(tab_bar->BarRect.Max.x, tab_bar->BarRect.Max.y), IM_COL32(255,0,0,255)); int select_dir = 0; ImVec4 arrow_col = g.Style.Colors[ImGuiCol_Text]; arrow_col.w *= 0.5f; PushStyleColor(ImGuiCol_Text, arrow_col); PushStyleColor(ImGuiCol_Button, ImVec4(0, 0, 0, 0)); PushItemFlag(ImGuiItemFlags_ButtonRepeat, true); const float backup_repeat_delay = g.IO.KeyRepeatDelay; const float backup_repeat_rate = g.IO.KeyRepeatRate; g.IO.KeyRepeatDelay = 0.250f; g.IO.KeyRepeatRate = 0.200f; float x = ImMax(tab_bar->BarRect.Min.x, tab_bar->BarRect.Max.x - scrolling_buttons_width); window->DC.CursorPos = ImVec2(x, tab_bar->BarRect.Min.y); if (ArrowButtonEx("##<", ImGuiDir_Left, arrow_button_size, ImGuiButtonFlags_PressedOnClick)) select_dir = -1; window->DC.CursorPos = ImVec2(x + arrow_button_size.x, tab_bar->BarRect.Min.y); if (ArrowButtonEx("##>", ImGuiDir_Right, arrow_button_size, ImGuiButtonFlags_PressedOnClick)) select_dir = +1; PopItemFlag(); PopStyleColor(2); g.IO.KeyRepeatRate = backup_repeat_rate; g.IO.KeyRepeatDelay = backup_repeat_delay; ImGuiTabItem* tab_to_scroll_to = NULL; if (select_dir != 0) if (ImGuiTabItem* tab_item = TabBarFindTabByID(tab_bar, tab_bar->SelectedTabId)) { int selected_order = TabBarGetTabOrder(tab_bar, tab_item); int target_order = selected_order + select_dir; // Skip tab item buttons until another tab item is found or end is reached while (tab_to_scroll_to == NULL) { // If we are at the end of the list, still scroll to make our tab visible tab_to_scroll_to = &tab_bar->Tabs[(target_order >= 0 && target_order < tab_bar->Tabs.Size) ? target_order : selected_order]; // Cross through buttons // (even if first/last item is a button, return it so we can update the scroll) if (tab_to_scroll_to->Flags & ImGuiTabItemFlags_Button) { target_order += select_dir; selected_order += select_dir; tab_to_scroll_to = (target_order < 0 || target_order >= tab_bar->Tabs.Size) ? tab_to_scroll_to : NULL; } } } window->DC.CursorPos = backup_cursor_pos; tab_bar->BarRect.Max.x -= scrolling_buttons_width + 1.0f; return tab_to_scroll_to; } static ImGuiTabItem* ImGui::TabBarTabListPopupButton(ImGuiTabBar* tab_bar) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; // We use g.Style.FramePadding.y to match the square ArrowButton size const float tab_list_popup_button_width = g.FontSize + g.Style.FramePadding.y; const ImVec2 backup_cursor_pos = window->DC.CursorPos; window->DC.CursorPos = ImVec2(tab_bar->BarRect.Min.x - g.Style.FramePadding.y, tab_bar->BarRect.Min.y); tab_bar->BarRect.Min.x += tab_list_popup_button_width; ImVec4 arrow_col = g.Style.Colors[ImGuiCol_Text]; arrow_col.w *= 0.5f; PushStyleColor(ImGuiCol_Text, arrow_col); PushStyleColor(ImGuiCol_Button, ImVec4(0, 0, 0, 0)); bool open = BeginCombo("##v", NULL, ImGuiComboFlags_NoPreview | ImGuiComboFlags_HeightLargest); PopStyleColor(2); ImGuiTabItem* tab_to_select = NULL; if (open) { for (int tab_n = 0; tab_n < tab_bar->Tabs.Size; tab_n++) { ImGuiTabItem* tab = &tab_bar->Tabs[tab_n]; if (tab->Flags & ImGuiTabItemFlags_Button) continue; const char* tab_name = TabBarGetTabName(tab_bar, tab); if (Selectable(tab_name, tab_bar->SelectedTabId == tab->ID)) tab_to_select = tab; } EndCombo(); } window->DC.CursorPos = backup_cursor_pos; return tab_to_select; } //------------------------------------------------------------------------- // [SECTION] Widgets: BeginTabItem, EndTabItem, etc. //------------------------------------------------------------------------- // - BeginTabItem() // - EndTabItem() // - TabItemButton() // - TabItemEx() [Internal] // - SetTabItemClosed() // - TabItemCalcSize() [Internal] // - TabItemBackground() [Internal] // - TabItemLabelAndCloseButton() [Internal] //------------------------------------------------------------------------- bool ImGui::BeginTabItem(const char* label, bool* p_open, ImGuiTabItemFlags flags) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; if (window->SkipItems) return false; ImGuiTabBar* tab_bar = g.CurrentTabBar; if (tab_bar == NULL) { IM_ASSERT_USER_ERROR(tab_bar, "Needs to be called between BeginTabBar() and EndTabBar()!"); return false; } IM_ASSERT((flags & ImGuiTabItemFlags_Button) == 0); // BeginTabItem() Can't be used with button flags, use TabItemButton() instead! bool ret = TabItemEx(tab_bar, label, p_open, flags, NULL); if (ret && !(flags & ImGuiTabItemFlags_NoPushId)) { ImGuiTabItem* tab = &tab_bar->Tabs[tab_bar->LastTabItemIdx]; PushOverrideID(tab->ID); // We already hashed 'label' so push into the ID stack directly instead of doing another hash through PushID(label) } return ret; } void ImGui::EndTabItem() { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; if (window->SkipItems) return; ImGuiTabBar* tab_bar = g.CurrentTabBar; if (tab_bar == NULL) { IM_ASSERT_USER_ERROR(tab_bar != NULL, "Needs to be called between BeginTabBar() and EndTabBar()!"); return; } IM_ASSERT(tab_bar->LastTabItemIdx >= 0); ImGuiTabItem* tab = &tab_bar->Tabs[tab_bar->LastTabItemIdx]; if (!(tab->Flags & ImGuiTabItemFlags_NoPushId)) PopID(); } bool ImGui::TabItemButton(const char* label, ImGuiTabItemFlags flags) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; if (window->SkipItems) return false; ImGuiTabBar* tab_bar = g.CurrentTabBar; if (tab_bar == NULL) { IM_ASSERT_USER_ERROR(tab_bar != NULL, "Needs to be called between BeginTabBar() and EndTabBar()!"); return false; } return TabItemEx(tab_bar, label, NULL, flags | ImGuiTabItemFlags_Button | ImGuiTabItemFlags_NoReorder, NULL); } void ImGui::TabItemSpacing(const char* str_id, ImGuiTabItemFlags flags, float width) { ImGuiContext& g = *GImGui; ImGuiWindow* window = g.CurrentWindow; if (window->SkipItems) return; ImGuiTabBar* tab_bar = g.CurrentTabBar; if (tab_bar == NULL) { IM_ASSERT_USER_ERROR(tab_bar != NULL, "Needs to be called between BeginTabBar() and EndTabBar()!"); return; } SetNextItemWidth(width); TabItemEx(tab_bar, str_id, NULL, flags | ImGuiTabItemFlags_Button | ImGuiTabItemFlags_NoReorder | ImGuiTabItemFlags_Invisible, NULL); } bool ImGui::TabItemEx(ImGuiTabBar* tab_bar, const char* label, bool* p_open, ImGuiTabItemFlags flags, ImGuiWindow* docked_window) { // Layout whole tab bar if not already done ImGuiContext& g = *GImGui; if (tab_bar->WantLayout) { ImGuiNextItemData backup_next_item_data = g.NextItemData; TabBarLayout(tab_bar); g.NextItemData = backup_next_item_data; } ImGuiWindow* window = g.CurrentWindow; if (window->SkipItems) return false; const ImGuiStyle& style = g.Style; const ImGuiID id = TabBarCalcTabID(tab_bar, label, docked_window); // If the user called us with *p_open == false, we early out and don't render. // We make a call to ItemAdd() so that attempts to use a contextual popup menu with an implicit ID won't use an older ID. IMGUI_TEST_ENGINE_ITEM_INFO(id, label, g.LastItemData.StatusFlags); if (p_open && !*p_open) { ItemAdd(ImRect(), id, NULL, ImGuiItemFlags_NoNav); return false; } IM_ASSERT(!p_open || !(flags & ImGuiTabItemFlags_Button)); IM_ASSERT((flags & (ImGuiTabItemFlags_Leading | ImGuiTabItemFlags_Trailing)) != (ImGuiTabItemFlags_Leading | ImGuiTabItemFlags_Trailing)); // Can't use both Leading and Trailing // Store into ImGuiTabItemFlags_NoCloseButton, also honor ImGuiTabItemFlags_NoCloseButton passed by user (although not documented) if (flags & ImGuiTabItemFlags_NoCloseButton) p_open = NULL; else if (p_open == NULL) flags |= ImGuiTabItemFlags_NoCloseButton; // Acquire tab data ImGuiTabItem* tab = TabBarFindTabByID(tab_bar, id); bool tab_is_new = false; if (tab == NULL) { tab_bar->Tabs.push_back(ImGuiTabItem()); tab = &tab_bar->Tabs.back(); tab->ID = id; tab_bar->TabsAddedNew = tab_is_new = true; } tab_bar->LastTabItemIdx = (ImS16)tab_bar->Tabs.index_from_ptr(tab); // Calculate tab contents size ImVec2 size = TabItemCalcSize(label, (p_open != NULL) || (flags & ImGuiTabItemFlags_UnsavedDocument)); tab->RequestedWidth = -1.0f; if (g.NextItemData.HasFlags & ImGuiNextItemDataFlags_HasWidth) size.x = tab->RequestedWidth = g.NextItemData.Width; if (tab_is_new) tab->Width = ImMax(1.0f, size.x); tab->ContentWidth = size.x; tab->BeginOrder = tab_bar->TabsActiveCount++; const bool tab_bar_appearing = (tab_bar->PrevFrameVisible + 1 < g.FrameCount); const bool tab_bar_focused = (tab_bar->Flags & ImGuiTabBarFlags_IsFocused) != 0; const bool tab_appearing = (tab->LastFrameVisible + 1 < g.FrameCount); const bool tab_just_unsaved = (flags & ImGuiTabItemFlags_UnsavedDocument) && !(tab->Flags & ImGuiTabItemFlags_UnsavedDocument); const bool is_tab_button = (flags & ImGuiTabItemFlags_Button) != 0; tab->LastFrameVisible = g.FrameCount; tab->Flags = flags; // Append name _WITH_ the zero-terminator if (docked_window != NULL) { IM_ASSERT(docked_window == NULL); // master branch only } else { tab->NameOffset = (ImS32)tab_bar->TabsNames.size(); tab_bar->TabsNames.append(label, label + ImStrlen(label) + 1); } // Update selected tab if (!is_tab_button) { if (tab_appearing && (tab_bar->Flags & ImGuiTabBarFlags_AutoSelectNewTabs) && tab_bar->NextSelectedTabId == 0) if (!tab_bar_appearing || tab_bar->SelectedTabId == 0) TabBarQueueFocus(tab_bar, tab); // New tabs gets activated if ((flags & ImGuiTabItemFlags_SetSelected) && (tab_bar->SelectedTabId != id)) // _SetSelected can only be passed on explicit tab bar TabBarQueueFocus(tab_bar, tab); } // Lock visibility // (Note: tab_contents_visible != tab_selected... because CTRL+TAB operations may preview some tabs without selecting them!) bool tab_contents_visible = (tab_bar->VisibleTabId == id); if (tab_contents_visible) tab_bar->VisibleTabWasSubmitted = true; // On the very first frame of a tab bar we let first tab contents be visible to minimize appearing glitches if (!tab_contents_visible && tab_bar->SelectedTabId == 0 && tab_bar_appearing) if (tab_bar->Tabs.Size == 1 && !(tab_bar->Flags & ImGuiTabBarFlags_AutoSelectNewTabs)) tab_contents_visible = true; // Note that tab_is_new is not necessarily the same as tab_appearing! When a tab bar stops being submitted // and then gets submitted again, the tabs will have 'tab_appearing=true' but 'tab_is_new=false'. if (tab_appearing && (!tab_bar_appearing || tab_is_new)) { ItemAdd(ImRect(), id, NULL, ImGuiItemFlags_NoNav); if (is_tab_button) return false; return tab_contents_visible; } if (tab_bar->SelectedTabId == id) tab->LastFrameSelected = g.FrameCount; // Backup current layout position const ImVec2 backup_main_cursor_pos = window->DC.CursorPos; // Layout const bool is_central_section = (tab->Flags & ImGuiTabItemFlags_SectionMask_) == 0; size.x = tab->Width; if (is_central_section) window->DC.CursorPos = tab_bar->BarRect.Min + ImVec2(IM_TRUNC(tab->Offset - tab_bar->ScrollingAnim), 0.0f); else window->DC.CursorPos = tab_bar->BarRect.Min + ImVec2(tab->Offset, 0.0f); ImVec2 pos = window->DC.CursorPos; ImRect bb(pos, pos + size); // We don't have CPU clipping primitives to clip the CloseButton (until it becomes a texture), so need to add an extra draw call (temporary in the case of vertical animation) const bool want_clip_rect = is_central_section && (bb.Min.x < tab_bar->ScrollingRectMinX || bb.Max.x > tab_bar->ScrollingRectMaxX); if (want_clip_rect) PushClipRect(ImVec2(ImMax(bb.Min.x, tab_bar->ScrollingRectMinX), bb.Min.y - 1), ImVec2(tab_bar->ScrollingRectMaxX, bb.Max.y), true); ImVec2 backup_cursor_max_pos = window->DC.CursorMaxPos; ItemSize(bb.GetSize(), style.FramePadding.y); window->DC.CursorMaxPos = backup_cursor_max_pos; if (!ItemAdd(bb, id)) { if (want_clip_rect) PopClipRect(); window->DC.CursorPos = backup_main_cursor_pos; return tab_contents_visible; } // Click to Select a tab // Allow the close button to overlap ImGuiButtonFlags button_flags = ((is_tab_button ? ImGuiButtonFlags_PressedOnClickRelease : ImGuiButtonFlags_PressedOnClick) | ImGuiButtonFlags_AllowOverlap); if (g.DragDropActive) button_flags |= ImGuiButtonFlags_PressedOnDragDropHold; bool hovered, held, pressed; if (flags & ImGuiTabItemFlags_Invisible) hovered = held = pressed = false; else pressed = ButtonBehavior(bb, id, &hovered, &held, button_flags); if (pressed && !is_tab_button) TabBarQueueFocus(tab_bar, tab); // Drag and drop: re-order tabs if (held && !tab_appearing && IsMouseDragging(0)) { if (!g.DragDropActive && (tab_bar->Flags & ImGuiTabBarFlags_Reorderable)) { // While moving a tab it will jump on the other side of the mouse, so we also test for MouseDelta.x if (g.IO.MouseDelta.x < 0.0f && g.IO.MousePos.x < bb.Min.x) { TabBarQueueReorderFromMousePos(tab_bar, tab, g.IO.MousePos); } else if (g.IO.MouseDelta.x > 0.0f && g.IO.MousePos.x > bb.Max.x) { TabBarQueueReorderFromMousePos(tab_bar, tab, g.IO.MousePos); } } } #if 0 if (hovered && g.HoveredIdNotActiveTimer > TOOLTIP_DELAY && bb.GetWidth() < tab->ContentWidth) { // Enlarge tab display when hovering bb.Max.x = bb.Min.x + IM_TRUNC(ImLerp(bb.GetWidth(), tab->ContentWidth, ImSaturate((g.HoveredIdNotActiveTimer - 0.40f) * 6.0f))); display_draw_list = GetForegroundDrawList(window); TabItemBackground(display_draw_list, bb, flags, GetColorU32(ImGuiCol_TitleBgActive)); } #endif // Render tab shape const bool is_visible = (g.LastItemData.StatusFlags & ImGuiItemStatusFlags_Visible) && !(flags & ImGuiTabItemFlags_Invisible); if (is_visible) { ImDrawList* display_draw_list = window->DrawList; const ImU32 tab_col = GetColorU32((held || hovered) ? ImGuiCol_TabHovered : tab_contents_visible ? (tab_bar_focused ? ImGuiCol_TabSelected : ImGuiCol_TabDimmedSelected) : (tab_bar_focused ? ImGuiCol_Tab : ImGuiCol_TabDimmed)); TabItemBackground(display_draw_list, bb, flags, tab_col); if (tab_contents_visible && (tab_bar->Flags & ImGuiTabBarFlags_DrawSelectedOverline) && style.TabBarOverlineSize > 0.0f) { // Might be moved to TabItemBackground() ? ImVec2 tl = bb.GetTL() + ImVec2(0, 1.0f * g.CurrentDpiScale); ImVec2 tr = bb.GetTR() + ImVec2(0, 1.0f * g.CurrentDpiScale); ImU32 overline_col = GetColorU32(tab_bar_focused ? ImGuiCol_TabSelectedOverline : ImGuiCol_TabDimmedSelectedOverline); if (style.TabRounding > 0.0f) { float rounding = style.TabRounding; display_draw_list->PathArcToFast(tl + ImVec2(+rounding, +rounding), rounding, 7, 9); display_draw_list->PathArcToFast(tr + ImVec2(-rounding, +rounding), rounding, 9, 11); display_draw_list->PathStroke(overline_col, 0, style.TabBarOverlineSize); } else { display_draw_list->AddLine(tl - ImVec2(0.5f, 0.5f), tr - ImVec2(0.5f, 0.5f), overline_col, style.TabBarOverlineSize); } } RenderNavCursor(bb, id); // Select with right mouse button. This is so the common idiom for context menu automatically highlight the current widget. const bool hovered_unblocked = IsItemHovered(ImGuiHoveredFlags_AllowWhenBlockedByPopup); if (tab_bar->SelectedTabId != tab->ID && hovered_unblocked && (IsMouseClicked(1) || IsMouseReleased(1)) && !is_tab_button) TabBarQueueFocus(tab_bar, tab); if (tab_bar->Flags & ImGuiTabBarFlags_NoCloseWithMiddleMouseButton) flags |= ImGuiTabItemFlags_NoCloseWithMiddleMouseButton; // Render tab label, process close button const ImGuiID close_button_id = p_open ? GetIDWithSeed("#CLOSE", NULL, id) : 0; bool just_closed; bool text_clipped; TabItemLabelAndCloseButton(display_draw_list, bb, tab_just_unsaved ? (flags & ~ImGuiTabItemFlags_UnsavedDocument) : flags, tab_bar->FramePadding, label, id, close_button_id, tab_contents_visible, &just_closed, &text_clipped); if (just_closed && p_open != NULL) { *p_open = false; TabBarCloseTab(tab_bar, tab); } // Tooltip // (Won't work over the close button because ItemOverlap systems messes up with HoveredIdTimer-> seems ok) // (We test IsItemHovered() to discard e.g. when another item is active or drag and drop over the tab bar, which g.HoveredId ignores) // FIXME: This is a mess. // FIXME: We may want disabled tab to still display the tooltip? if (text_clipped && g.HoveredId == id && !held) if (!(tab_bar->Flags & ImGuiTabBarFlags_NoTooltip) && !(tab->Flags & ImGuiTabItemFlags_NoTooltip)) SetItemTooltip("%.*s", (int)(FindRenderedTextEnd(label) - label), label); } // Restore main window position so user can draw there if (want_clip_rect) PopClipRect(); window->DC.CursorPos = backup_main_cursor_pos; IM_ASSERT(!is_tab_button || !(tab_bar->SelectedTabId == tab->ID && is_tab_button)); // TabItemButton should not be selected if (is_tab_button) return pressed; return tab_contents_visible; } // [Public] This is call is 100% optional but it allows to remove some one-frame glitches when a tab has been unexpectedly removed. // To use it to need to call the function SetTabItemClosed() between BeginTabBar() and EndTabBar(). // Tabs closed by the close button will automatically be flagged to avoid this issue. void ImGui::SetTabItemClosed(const char* label) { ImGuiContext& g = *GImGui; bool is_within_manual_tab_bar = g.CurrentTabBar && !(g.CurrentTabBar->Flags & ImGuiTabBarFlags_DockNode); if (is_within_manual_tab_bar) { ImGuiTabBar* tab_bar = g.CurrentTabBar; ImGuiID tab_id = TabBarCalcTabID(tab_bar, label, NULL); if (ImGuiTabItem* tab = TabBarFindTabByID(tab_bar, tab_id)) tab->WantClose = true; // Will be processed by next call to TabBarLayout() } } ImVec2 ImGui::TabItemCalcSize(const char* label, bool has_close_button_or_unsaved_marker) { ImGuiContext& g = *GImGui; ImVec2 label_size = CalcTextSize(label, NULL, true); ImVec2 size = ImVec2(label_size.x + g.Style.FramePadding.x, label_size.y + g.Style.FramePadding.y * 2.0f); if (has_close_button_or_unsaved_marker) size.x += g.Style.FramePadding.x + (g.Style.ItemInnerSpacing.x + g.FontSize); // We use Y intentionally to fit the close button circle. else size.x += g.Style.FramePadding.x + 1.0f; return ImVec2(ImMin(size.x, TabBarCalcMaxTabWidth()), size.y); } ImVec2 ImGui::TabItemCalcSize(ImGuiWindow*) { IM_ASSERT(0); // This function exists to facilitate merge with 'docking' branch. return ImVec2(0.0f, 0.0f); } void ImGui::TabItemBackground(ImDrawList* draw_list, const ImRect& bb, ImGuiTabItemFlags flags, ImU32 col) { // While rendering tabs, we trim 1 pixel off the top of our bounding box so they can fit within a regular frame height while looking "detached" from it. ImGuiContext& g = *GImGui; const float width = bb.GetWidth(); IM_UNUSED(flags); IM_ASSERT(width > 0.0f); const float rounding = ImMax(0.0f, ImMin((flags & ImGuiTabItemFlags_Button) ? g.Style.FrameRounding : g.Style.TabRounding, width * 0.5f - 1.0f)); const float y1 = bb.Min.y + 1.0f; const float y2 = bb.Max.y - g.Style.TabBarBorderSize; draw_list->PathLineTo(ImVec2(bb.Min.x, y2)); draw_list->PathArcToFast(ImVec2(bb.Min.x + rounding, y1 + rounding), rounding, 6, 9); draw_list->PathArcToFast(ImVec2(bb.Max.x - rounding, y1 + rounding), rounding, 9, 12); draw_list->PathLineTo(ImVec2(bb.Max.x, y2)); draw_list->PathFillConvex(col); if (g.Style.TabBorderSize > 0.0f) { draw_list->PathLineTo(ImVec2(bb.Min.x + 0.5f, y2)); draw_list->PathArcToFast(ImVec2(bb.Min.x + rounding + 0.5f, y1 + rounding + 0.5f), rounding, 6, 9); draw_list->PathArcToFast(ImVec2(bb.Max.x - rounding - 0.5f, y1 + rounding + 0.5f), rounding, 9, 12); draw_list->PathLineTo(ImVec2(bb.Max.x - 0.5f, y2)); draw_list->PathStroke(GetColorU32(ImGuiCol_Border), 0, g.Style.TabBorderSize); } } // Render text label (with custom clipping) + Unsaved Document marker + Close Button logic // We tend to lock style.FramePadding for a given tab-bar, hence the 'frame_padding' parameter. void ImGui::TabItemLabelAndCloseButton(ImDrawList* draw_list, const ImRect& bb, ImGuiTabItemFlags flags, ImVec2 frame_padding, const char* label, ImGuiID tab_id, ImGuiID close_button_id, bool is_contents_visible, bool* out_just_closed, bool* out_text_clipped) { ImGuiContext& g = *GImGui; ImVec2 label_size = CalcTextSize(label, NULL, true); if (out_just_closed) *out_just_closed = false; if (out_text_clipped) *out_text_clipped = false; if (bb.GetWidth() <= 1.0f) return; // In Style V2 we'll have full override of all colors per state (e.g. focused, selected) // But right now if you want to alter text color of tabs this is what you need to do. #if 0 const float backup_alpha = g.Style.Alpha; if (!is_contents_visible) g.Style.Alpha *= 0.7f; #endif // Render text label (with clipping + alpha gradient) + unsaved marker ImRect text_pixel_clip_bb(bb.Min.x + frame_padding.x, bb.Min.y + frame_padding.y, bb.Max.x - frame_padding.x, bb.Max.y); ImRect text_ellipsis_clip_bb = text_pixel_clip_bb; // Return clipped state ignoring the close button if (out_text_clipped) { *out_text_clipped = (text_ellipsis_clip_bb.Min.x + label_size.x) > text_pixel_clip_bb.Max.x; //draw_list->AddCircle(text_ellipsis_clip_bb.Min, 3.0f, *out_text_clipped ? IM_COL32(255, 0, 0, 255) : IM_COL32(0, 255, 0, 255)); } const float button_sz = g.FontSize; const ImVec2 button_pos(ImMax(bb.Min.x, bb.Max.x - frame_padding.x - button_sz), bb.Min.y + frame_padding.y); // Close Button & Unsaved Marker // We are relying on a subtle and confusing distinction between 'hovered' and 'g.HoveredId' which happens because we are using ImGuiButtonFlags_AllowOverlapMode + SetItemAllowOverlap() // 'hovered' will be true when hovering the Tab but NOT when hovering the close button // 'g.HoveredId==id' will be true when hovering the Tab including when hovering the close button // 'g.ActiveId==close_button_id' will be true when we are holding on the close button, in which case both hovered booleans are false bool close_button_pressed = false; bool close_button_visible = false; bool is_hovered = g.HoveredId == tab_id || g.HoveredId == close_button_id || g.ActiveId == tab_id || g.ActiveId == close_button_id; // Any interaction account for this too. if (close_button_id != 0) { if (is_contents_visible) close_button_visible = (g.Style.TabCloseButtonMinWidthSelected < 0.0f) ? true : (is_hovered && bb.GetWidth() >= ImMax(button_sz, g.Style.TabCloseButtonMinWidthSelected)); else close_button_visible = (g.Style.TabCloseButtonMinWidthUnselected < 0.0f) ? true : (is_hovered && bb.GetWidth() >= ImMax(button_sz, g.Style.TabCloseButtonMinWidthUnselected)); } // When tabs/document is unsaved, the unsaved marker takes priority over the close button. const bool unsaved_marker_visible = (flags & ImGuiTabItemFlags_UnsavedDocument) != 0 && (button_pos.x + button_sz <= bb.Max.x) && (!close_button_visible || !is_hovered); if (unsaved_marker_visible) { const ImRect bullet_bb(button_pos, button_pos + ImVec2(button_sz, button_sz)); RenderBullet(draw_list, bullet_bb.GetCenter(), GetColorU32(ImGuiCol_Text)); } else if (close_button_visible) { ImGuiLastItemData last_item_backup = g.LastItemData; if (CloseButton(close_button_id, button_pos)) close_button_pressed = true; g.LastItemData = last_item_backup; // Close with middle mouse button if (is_hovered && !(flags & ImGuiTabItemFlags_NoCloseWithMiddleMouseButton) && IsMouseClicked(2)) close_button_pressed = true; } // This is all rather complicated // (the main idea is that because the close button only appears on hover, we don't want it to alter the ellipsis position) // FIXME: if FramePadding is noticeably large, ellipsis_max_x will be wrong here (e.g. #3497), maybe for consistency that parameter of RenderTextEllipsis() shouldn't exist.. float ellipsis_max_x = close_button_visible ? text_pixel_clip_bb.Max.x : bb.Max.x - 1.0f; if (close_button_visible || unsaved_marker_visible) { text_pixel_clip_bb.Max.x -= close_button_visible ? (button_sz) : (button_sz * 0.80f); text_ellipsis_clip_bb.Max.x -= unsaved_marker_visible ? (button_sz * 0.80f) : 0.0f; ellipsis_max_x = text_pixel_clip_bb.Max.x; } LogSetNextTextDecoration("/", "\\"); RenderTextEllipsis(draw_list, text_ellipsis_clip_bb.Min, text_ellipsis_clip_bb.Max, text_pixel_clip_bb.Max.x, ellipsis_max_x, label, NULL, &label_size); #if 0 if (!is_contents_visible) g.Style.Alpha = backup_alpha; #endif if (out_just_closed) *out_just_closed = close_button_pressed; } #endif // #ifndef IMGUI_DISABLE ================================================ FILE: src/DesktopPlusUI/imgui/imstb_rectpack.h ================================================ // [DEAR IMGUI] // This is a slightly modified version of stb_rect_pack.h 1.01. // Grep for [DEAR IMGUI] to find the changes. // // stb_rect_pack.h - v1.01 - public domain - rectangle packing // Sean Barrett 2014 // // Useful for e.g. packing rectangular textures into an atlas. // Does not do rotation. // // Before #including, // // #define STB_RECT_PACK_IMPLEMENTATION // // in the file that you want to have the implementation. // // Not necessarily the awesomest packing method, but better than // the totally naive one in stb_truetype (which is primarily what // this is meant to replace). // // Has only had a few tests run, may have issues. // // More docs to come. // // No memory allocations; uses qsort() and assert() from stdlib. // Can override those by defining STBRP_SORT and STBRP_ASSERT. // // This library currently uses the Skyline Bottom-Left algorithm. // // Please note: better rectangle packers are welcome! Please // implement them to the same API, but with a different init // function. // // Credits // // Library // Sean Barrett // Minor features // Martins Mozeiko // github:IntellectualKitty // // Bugfixes / warning fixes // Jeremy Jaussaud // Fabian Giesen // // Version history: // // 1.01 (2021-07-11) always use large rect mode, expose STBRP__MAXVAL in public section // 1.00 (2019-02-25) avoid small space waste; gracefully fail too-wide rectangles // 0.99 (2019-02-07) warning fixes // 0.11 (2017-03-03) return packing success/fail result // 0.10 (2016-10-25) remove cast-away-const to avoid warnings // 0.09 (2016-08-27) fix compiler warnings // 0.08 (2015-09-13) really fix bug with empty rects (w=0 or h=0) // 0.07 (2015-09-13) fix bug with empty rects (w=0 or h=0) // 0.06 (2015-04-15) added STBRP_SORT to allow replacing qsort // 0.05: added STBRP_ASSERT to allow replacing assert // 0.04: fixed minor bug in STBRP_LARGE_RECTS support // 0.01: initial release // // LICENSE // // See end of file for license information. ////////////////////////////////////////////////////////////////////////////// // // INCLUDE SECTION // #ifndef STB_INCLUDE_STB_RECT_PACK_H #define STB_INCLUDE_STB_RECT_PACK_H #define STB_RECT_PACK_VERSION 1 #ifdef STBRP_STATIC #define STBRP_DEF static #else #define STBRP_DEF extern #endif #ifdef __cplusplus extern "C" { #endif typedef struct stbrp_context stbrp_context; typedef struct stbrp_node stbrp_node; typedef struct stbrp_rect stbrp_rect; typedef int stbrp_coord; #define STBRP__MAXVAL 0x7fffffff // Mostly for internal use, but this is the maximum supported coordinate value. STBRP_DEF int stbrp_pack_rects (stbrp_context *context, stbrp_rect *rects, int num_rects); // Assign packed locations to rectangles. The rectangles are of type // 'stbrp_rect' defined below, stored in the array 'rects', and there // are 'num_rects' many of them. // // Rectangles which are successfully packed have the 'was_packed' flag // set to a non-zero value and 'x' and 'y' store the minimum location // on each axis (i.e. bottom-left in cartesian coordinates, top-left // if you imagine y increasing downwards). Rectangles which do not fit // have the 'was_packed' flag set to 0. // // You should not try to access the 'rects' array from another thread // while this function is running, as the function temporarily reorders // the array while it executes. // // To pack into another rectangle, you need to call stbrp_init_target // again. To continue packing into the same rectangle, you can call // this function again. Calling this multiple times with multiple rect // arrays will probably produce worse packing results than calling it // a single time with the full rectangle array, but the option is // available. // // The function returns 1 if all of the rectangles were successfully // packed and 0 otherwise. struct stbrp_rect { // reserved for your use: int id; // input: stbrp_coord w, h; // output: stbrp_coord x, y; int was_packed; // non-zero if valid packing }; // 16 bytes, nominally STBRP_DEF void stbrp_init_target (stbrp_context *context, int width, int height, stbrp_node *nodes, int num_nodes); // Initialize a rectangle packer to: // pack a rectangle that is 'width' by 'height' in dimensions // using temporary storage provided by the array 'nodes', which is 'num_nodes' long // // You must call this function every time you start packing into a new target. // // There is no "shutdown" function. The 'nodes' memory must stay valid for // the following stbrp_pack_rects() call (or calls), but can be freed after // the call (or calls) finish. // // Note: to guarantee best results, either: // 1. make sure 'num_nodes' >= 'width' // or 2. call stbrp_allow_out_of_mem() defined below with 'allow_out_of_mem = 1' // // If you don't do either of the above things, widths will be quantized to multiples // of small integers to guarantee the algorithm doesn't run out of temporary storage. // // If you do #2, then the non-quantized algorithm will be used, but the algorithm // may run out of temporary storage and be unable to pack some rectangles. STBRP_DEF void stbrp_setup_allow_out_of_mem (stbrp_context *context, int allow_out_of_mem); // Optionally call this function after init but before doing any packing to // change the handling of the out-of-temp-memory scenario, described above. // If you call init again, this will be reset to the default (false). STBRP_DEF void stbrp_setup_heuristic (stbrp_context *context, int heuristic); // Optionally select which packing heuristic the library should use. Different // heuristics will produce better/worse results for different data sets. // If you call init again, this will be reset to the default. enum { STBRP_HEURISTIC_Skyline_default=0, STBRP_HEURISTIC_Skyline_BL_sortHeight = STBRP_HEURISTIC_Skyline_default, STBRP_HEURISTIC_Skyline_BF_sortHeight }; ////////////////////////////////////////////////////////////////////////////// // // the details of the following structures don't matter to you, but they must // be visible so you can handle the memory allocations for them struct stbrp_node { stbrp_coord x,y; stbrp_node *next; }; struct stbrp_context { int width; int height; int align; int init_mode; int heuristic; int num_nodes; stbrp_node *active_head; stbrp_node *free_head; stbrp_node extra[2]; // we allocate two extra nodes so optimal user-node-count is 'width' not 'width+2' }; #ifdef __cplusplus } #endif #endif ////////////////////////////////////////////////////////////////////////////// // // IMPLEMENTATION SECTION // #ifdef STB_RECT_PACK_IMPLEMENTATION #ifndef STBRP_SORT #include #define STBRP_SORT qsort #endif #ifndef STBRP_ASSERT #include #define STBRP_ASSERT assert #endif #ifdef _MSC_VER #define STBRP__NOTUSED(v) (void)(v) #define STBRP__CDECL __cdecl #else #define STBRP__NOTUSED(v) (void)sizeof(v) #define STBRP__CDECL #endif enum { STBRP__INIT_skyline = 1 }; STBRP_DEF void stbrp_setup_heuristic(stbrp_context *context, int heuristic) { switch (context->init_mode) { case STBRP__INIT_skyline: STBRP_ASSERT(heuristic == STBRP_HEURISTIC_Skyline_BL_sortHeight || heuristic == STBRP_HEURISTIC_Skyline_BF_sortHeight); context->heuristic = heuristic; break; default: STBRP_ASSERT(0); } } STBRP_DEF void stbrp_setup_allow_out_of_mem(stbrp_context *context, int allow_out_of_mem) { if (allow_out_of_mem) // if it's ok to run out of memory, then don't bother aligning them; // this gives better packing, but may fail due to OOM (even though // the rectangles easily fit). @TODO a smarter approach would be to only // quantize once we've hit OOM, then we could get rid of this parameter. context->align = 1; else { // if it's not ok to run out of memory, then quantize the widths // so that num_nodes is always enough nodes. // // I.e. num_nodes * align >= width // align >= width / num_nodes // align = ceil(width/num_nodes) context->align = (context->width + context->num_nodes-1) / context->num_nodes; } } STBRP_DEF void stbrp_init_target(stbrp_context *context, int width, int height, stbrp_node *nodes, int num_nodes) { int i; for (i=0; i < num_nodes-1; ++i) nodes[i].next = &nodes[i+1]; nodes[i].next = NULL; context->init_mode = STBRP__INIT_skyline; context->heuristic = STBRP_HEURISTIC_Skyline_default; context->free_head = &nodes[0]; context->active_head = &context->extra[0]; context->width = width; context->height = height; context->num_nodes = num_nodes; stbrp_setup_allow_out_of_mem(context, 0); // node 0 is the full width, node 1 is the sentinel (lets us not store width explicitly) context->extra[0].x = 0; context->extra[0].y = 0; context->extra[0].next = &context->extra[1]; context->extra[1].x = (stbrp_coord) width; context->extra[1].y = (1<<30); context->extra[1].next = NULL; } // find minimum y position if it starts at x1 static int stbrp__skyline_find_min_y(stbrp_context *c, stbrp_node *first, int x0, int width, int *pwaste) { stbrp_node *node = first; int x1 = x0 + width; int min_y, visited_width, waste_area; STBRP__NOTUSED(c); STBRP_ASSERT(first->x <= x0); #if 0 // skip in case we're past the node while (node->next->x <= x0) ++node; #else STBRP_ASSERT(node->next->x > x0); // we ended up handling this in the caller for efficiency #endif STBRP_ASSERT(node->x <= x0); min_y = 0; waste_area = 0; visited_width = 0; while (node->x < x1) { if (node->y > min_y) { // raise min_y higher. // we've accounted for all waste up to min_y, // but we'll now add more waste for everything we've visted waste_area += visited_width * (node->y - min_y); min_y = node->y; // the first time through, visited_width might be reduced if (node->x < x0) visited_width += node->next->x - x0; else visited_width += node->next->x - node->x; } else { // add waste area int under_width = node->next->x - node->x; if (under_width + visited_width > width) under_width = width - visited_width; waste_area += under_width * (min_y - node->y); visited_width += under_width; } node = node->next; } *pwaste = waste_area; return min_y; } typedef struct { int x,y; stbrp_node **prev_link; } stbrp__findresult; static stbrp__findresult stbrp__skyline_find_best_pos(stbrp_context *c, int width, int height) { int best_waste = (1<<30), best_x, best_y = (1 << 30); stbrp__findresult fr; stbrp_node **prev, *node, *tail, **best = NULL; // align to multiple of c->align width = (width + c->align - 1); width -= width % c->align; STBRP_ASSERT(width % c->align == 0); // if it can't possibly fit, bail immediately if (width > c->width || height > c->height) { fr.prev_link = NULL; fr.x = fr.y = 0; return fr; } node = c->active_head; prev = &c->active_head; while (node->x + width <= c->width) { int y,waste; y = stbrp__skyline_find_min_y(c, node, node->x, width, &waste); if (c->heuristic == STBRP_HEURISTIC_Skyline_BL_sortHeight) { // actually just want to test BL // bottom left if (y < best_y) { best_y = y; best = prev; } } else { // best-fit if (y + height <= c->height) { // can only use it if it first vertically if (y < best_y || (y == best_y && waste < best_waste)) { best_y = y; best_waste = waste; best = prev; } } } prev = &node->next; node = node->next; } best_x = (best == NULL) ? 0 : (*best)->x; // if doing best-fit (BF), we also have to try aligning right edge to each node position // // e.g, if fitting // // ____________________ // |____________________| // // into // // | | // | ____________| // |____________| // // then right-aligned reduces waste, but bottom-left BL is always chooses left-aligned // // This makes BF take about 2x the time if (c->heuristic == STBRP_HEURISTIC_Skyline_BF_sortHeight) { tail = c->active_head; node = c->active_head; prev = &c->active_head; // find first node that's admissible while (tail->x < width) tail = tail->next; while (tail) { int xpos = tail->x - width; int y,waste; STBRP_ASSERT(xpos >= 0); // find the left position that matches this while (node->next->x <= xpos) { prev = &node->next; node = node->next; } STBRP_ASSERT(node->next->x > xpos && node->x <= xpos); y = stbrp__skyline_find_min_y(c, node, xpos, width, &waste); if (y + height <= c->height) { if (y <= best_y) { if (y < best_y || waste < best_waste || (waste==best_waste && xpos < best_x)) { best_x = xpos; //STBRP_ASSERT(y <= best_y); [DEAR IMGUI] best_y = y; best_waste = waste; best = prev; } } } tail = tail->next; } } fr.prev_link = best; fr.x = best_x; fr.y = best_y; return fr; } static stbrp__findresult stbrp__skyline_pack_rectangle(stbrp_context *context, int width, int height) { // find best position according to heuristic stbrp__findresult res = stbrp__skyline_find_best_pos(context, width, height); stbrp_node *node, *cur; // bail if: // 1. it failed // 2. the best node doesn't fit (we don't always check this) // 3. we're out of memory if (res.prev_link == NULL || res.y + height > context->height || context->free_head == NULL) { res.prev_link = NULL; return res; } // on success, create new node node = context->free_head; node->x = (stbrp_coord) res.x; node->y = (stbrp_coord) (res.y + height); context->free_head = node->next; // insert the new node into the right starting point, and // let 'cur' point to the remaining nodes needing to be // stiched back in cur = *res.prev_link; if (cur->x < res.x) { // preserve the existing one, so start testing with the next one stbrp_node *next = cur->next; cur->next = node; cur = next; } else { *res.prev_link = node; } // from here, traverse cur and free the nodes, until we get to one // that shouldn't be freed while (cur->next && cur->next->x <= res.x + width) { stbrp_node *next = cur->next; // move the current node to the free list cur->next = context->free_head; context->free_head = cur; cur = next; } // stitch the list back in node->next = cur; if (cur->x < res.x + width) cur->x = (stbrp_coord) (res.x + width); #ifdef _DEBUG cur = context->active_head; while (cur->x < context->width) { STBRP_ASSERT(cur->x < cur->next->x); cur = cur->next; } STBRP_ASSERT(cur->next == NULL); { int count=0; cur = context->active_head; while (cur) { cur = cur->next; ++count; } cur = context->free_head; while (cur) { cur = cur->next; ++count; } STBRP_ASSERT(count == context->num_nodes+2); } #endif return res; } static int STBRP__CDECL rect_height_compare(const void *a, const void *b) { const stbrp_rect *p = (const stbrp_rect *) a; const stbrp_rect *q = (const stbrp_rect *) b; if (p->h > q->h) return -1; if (p->h < q->h) return 1; return (p->w > q->w) ? -1 : (p->w < q->w); } static int STBRP__CDECL rect_original_order(const void *a, const void *b) { const stbrp_rect *p = (const stbrp_rect *) a; const stbrp_rect *q = (const stbrp_rect *) b; return (p->was_packed < q->was_packed) ? -1 : (p->was_packed > q->was_packed); } STBRP_DEF int stbrp_pack_rects(stbrp_context *context, stbrp_rect *rects, int num_rects) { int i, all_rects_packed = 1; // we use the 'was_packed' field internally to allow sorting/unsorting for (i=0; i < num_rects; ++i) { rects[i].was_packed = i; } // sort according to heuristic STBRP_SORT(rects, num_rects, sizeof(rects[0]), rect_height_compare); for (i=0; i < num_rects; ++i) { if (rects[i].w == 0 || rects[i].h == 0) { rects[i].x = rects[i].y = 0; // empty rect needs no space } else { stbrp__findresult fr = stbrp__skyline_pack_rectangle(context, rects[i].w, rects[i].h); if (fr.prev_link) { rects[i].x = (stbrp_coord) fr.x; rects[i].y = (stbrp_coord) fr.y; } else { rects[i].x = rects[i].y = STBRP__MAXVAL; } } } // unsort STBRP_SORT(rects, num_rects, sizeof(rects[0]), rect_original_order); // set was_packed flags and all_rects_packed status for (i=0; i < num_rects; ++i) { rects[i].was_packed = !(rects[i].x == STBRP__MAXVAL && rects[i].y == STBRP__MAXVAL); if (!rects[i].was_packed) all_rects_packed = 0; } // return the all_rects_packed status return all_rects_packed; } #endif /* ------------------------------------------------------------------------------ This software is available under 2 licenses -- choose whichever you prefer. ------------------------------------------------------------------------------ ALTERNATIVE A - MIT License Copyright (c) 2017 Sean Barrett Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ------------------------------------------------------------------------------ ALTERNATIVE B - Public Domain (www.unlicense.org) This is free and unencumbered software released into the public domain. Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means. In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ------------------------------------------------------------------------------ */ ================================================ FILE: src/DesktopPlusUI/imgui/imstb_textedit.h ================================================ // [DEAR IMGUI] // This is a slightly modified version of stb_textedit.h 1.14. // Those changes would need to be pushed into nothings/stb: // - Fix in stb_textedit_discard_redo (see https://github.com/nothings/stb/issues/321) // - Fix in stb_textedit_find_charpos to handle last line (see https://github.com/ocornut/imgui/issues/6000 + #6783) // - Added name to struct or it may be forward declared in our code. // - Added UTF-8 support (see https://github.com/nothings/stb/issues/188 + https://github.com/ocornut/imgui/pull/7925) // Grep for [DEAR IMGUI] to find the changes. // - Also renamed macros used or defined outside of IMSTB_TEXTEDIT_IMPLEMENTATION block from STB_TEXTEDIT_* to IMSTB_TEXTEDIT_* // stb_textedit.h - v1.14 - public domain - Sean Barrett // Development of this library was sponsored by RAD Game Tools // // This C header file implements the guts of a multi-line text-editing // widget; you implement display, word-wrapping, and low-level string // insertion/deletion, and stb_textedit will map user inputs into // insertions & deletions, plus updates to the cursor position, // selection state, and undo state. // // It is intended for use in games and other systems that need to build // their own custom widgets and which do not have heavy text-editing // requirements (this library is not recommended for use for editing large // texts, as its performance does not scale and it has limited undo). // // Non-trivial behaviors are modelled after Windows text controls. // // // LICENSE // // See end of file for license information. // // // DEPENDENCIES // // Uses the C runtime function 'memmove', which you can override // by defining IMSTB_TEXTEDIT_memmove before the implementation. // Uses no other functions. Performs no runtime allocations. // // // VERSION HISTORY // // 1.14 (2021-07-11) page up/down, various fixes // 1.13 (2019-02-07) fix bug in undo size management // 1.12 (2018-01-29) user can change STB_TEXTEDIT_KEYTYPE, fix redo to avoid crash // 1.11 (2017-03-03) fix HOME on last line, dragging off single-line textfield // 1.10 (2016-10-25) suppress warnings about casting away const with -Wcast-qual // 1.9 (2016-08-27) customizable move-by-word // 1.8 (2016-04-02) better keyboard handling when mouse button is down // 1.7 (2015-09-13) change y range handling in case baseline is non-0 // 1.6 (2015-04-15) allow STB_TEXTEDIT_memmove // 1.5 (2014-09-10) add support for secondary keys for OS X // 1.4 (2014-08-17) fix signed/unsigned warnings // 1.3 (2014-06-19) fix mouse clicking to round to nearest char boundary // 1.2 (2014-05-27) fix some RAD types that had crept into the new code // 1.1 (2013-12-15) move-by-word (requires STB_TEXTEDIT_IS_SPACE ) // 1.0 (2012-07-26) improve documentation, initial public release // 0.3 (2012-02-24) bugfixes, single-line mode; insert mode // 0.2 (2011-11-28) fixes to undo/redo // 0.1 (2010-07-08) initial version // // ADDITIONAL CONTRIBUTORS // // Ulf Winklemann: move-by-word in 1.1 // Fabian Giesen: secondary key inputs in 1.5 // Martins Mozeiko: STB_TEXTEDIT_memmove in 1.6 // Louis Schnellbach: page up/down in 1.14 // // Bugfixes: // Scott Graham // Daniel Keller // Omar Cornut // Dan Thompson // // USAGE // // This file behaves differently depending on what symbols you define // before including it. // // // Header-file mode: // // If you do not define STB_TEXTEDIT_IMPLEMENTATION before including this, // it will operate in "header file" mode. In this mode, it declares a // single public symbol, STB_TexteditState, which encapsulates the current // state of a text widget (except for the string, which you will store // separately). // // To compile in this mode, you must define STB_TEXTEDIT_CHARTYPE to a // primitive type that defines a single character (e.g. char, wchar_t, etc). // // To save space or increase undo-ability, you can optionally define the // following things that are used by the undo system: // // STB_TEXTEDIT_POSITIONTYPE small int type encoding a valid cursor position // STB_TEXTEDIT_UNDOSTATECOUNT the number of undo states to allow // STB_TEXTEDIT_UNDOCHARCOUNT the number of characters to store in the undo buffer // // If you don't define these, they are set to permissive types and // moderate sizes. The undo system does no memory allocations, so // it grows STB_TexteditState by the worst-case storage which is (in bytes): // // [4 + 3 * sizeof(STB_TEXTEDIT_POSITIONTYPE)] * STB_TEXTEDIT_UNDOSTATECOUNT // + sizeof(STB_TEXTEDIT_CHARTYPE) * STB_TEXTEDIT_UNDOCHARCOUNT // // // Implementation mode: // // If you define STB_TEXTEDIT_IMPLEMENTATION before including this, it // will compile the implementation of the text edit widget, depending // on a large number of symbols which must be defined before the include. // // The implementation is defined only as static functions. You will then // need to provide your own APIs in the same file which will access the // static functions. // // The basic concept is that you provide a "string" object which // behaves like an array of characters. stb_textedit uses indices to // refer to positions in the string, implicitly representing positions // in the displayed textedit. This is true for both plain text and // rich text; even with rich text stb_truetype interacts with your // code as if there was an array of all the displayed characters. // // Symbols that must be the same in header-file and implementation mode: // // STB_TEXTEDIT_CHARTYPE the character type // STB_TEXTEDIT_POSITIONTYPE small type that is a valid cursor position // STB_TEXTEDIT_UNDOSTATECOUNT the number of undo states to allow // STB_TEXTEDIT_UNDOCHARCOUNT the number of characters to store in the undo buffer // // Symbols you must define for implementation mode: // // STB_TEXTEDIT_STRING the type of object representing a string being edited, // typically this is a wrapper object with other data you need // // STB_TEXTEDIT_STRINGLEN(obj) the length of the string (ideally O(1)) // STB_TEXTEDIT_LAYOUTROW(&r,obj,n) returns the results of laying out a line of characters // starting from character #n (see discussion below) // STB_TEXTEDIT_GETWIDTH(obj,n,i) returns the pixel delta from the xpos of the i'th character // to the xpos of the i+1'th char for a line of characters // starting at character #n (i.e. accounts for kerning // with previous char) // STB_TEXTEDIT_KEYTOTEXT(k) maps a keyboard input to an insertable character // (return type is int, -1 means not valid to insert) // STB_TEXTEDIT_GETCHAR(obj,i) returns the i'th character of obj, 0-based // STB_TEXTEDIT_NEWLINE the character returned by _GETCHAR() we recognize // as manually wordwrapping for end-of-line positioning // // STB_TEXTEDIT_DELETECHARS(obj,i,n) delete n characters starting at i // STB_TEXTEDIT_INSERTCHARS(obj,i,c*,n) insert n characters at i (pointed to by STB_TEXTEDIT_CHARTYPE*) // // STB_TEXTEDIT_K_SHIFT a power of two that is or'd in to a keyboard input to represent the shift key // // STB_TEXTEDIT_K_LEFT keyboard input to move cursor left // STB_TEXTEDIT_K_RIGHT keyboard input to move cursor right // STB_TEXTEDIT_K_UP keyboard input to move cursor up // STB_TEXTEDIT_K_DOWN keyboard input to move cursor down // STB_TEXTEDIT_K_PGUP keyboard input to move cursor up a page // STB_TEXTEDIT_K_PGDOWN keyboard input to move cursor down a page // STB_TEXTEDIT_K_LINESTART keyboard input to move cursor to start of line // e.g. HOME // STB_TEXTEDIT_K_LINEEND keyboard input to move cursor to end of line // e.g. END // STB_TEXTEDIT_K_TEXTSTART keyboard input to move cursor to start of text // e.g. ctrl-HOME // STB_TEXTEDIT_K_TEXTEND keyboard input to move cursor to end of text // e.g. ctrl-END // STB_TEXTEDIT_K_DELETE keyboard input to delete selection or character under cursor // STB_TEXTEDIT_K_BACKSPACE keyboard input to delete selection or character left of cursor // STB_TEXTEDIT_K_UNDO keyboard input to perform undo // STB_TEXTEDIT_K_REDO keyboard input to perform redo // // Optional: // STB_TEXTEDIT_K_INSERT keyboard input to toggle insert mode // STB_TEXTEDIT_IS_SPACE(ch) true if character is whitespace (e.g. 'isspace'), // required for default WORDLEFT/WORDRIGHT handlers // STB_TEXTEDIT_MOVEWORDLEFT(obj,i) custom handler for WORDLEFT, returns index to move cursor to // STB_TEXTEDIT_MOVEWORDRIGHT(obj,i) custom handler for WORDRIGHT, returns index to move cursor to // STB_TEXTEDIT_K_WORDLEFT keyboard input to move cursor left one word // e.g. ctrl-LEFT // STB_TEXTEDIT_K_WORDRIGHT keyboard input to move cursor right one word // e.g. ctrl-RIGHT // STB_TEXTEDIT_K_LINESTART2 secondary keyboard input to move cursor to start of line // STB_TEXTEDIT_K_LINEEND2 secondary keyboard input to move cursor to end of line // STB_TEXTEDIT_K_TEXTSTART2 secondary keyboard input to move cursor to start of text // STB_TEXTEDIT_K_TEXTEND2 secondary keyboard input to move cursor to end of text // // Keyboard input must be encoded as a single integer value; e.g. a character code // and some bitflags that represent shift states. to simplify the interface, SHIFT must // be a bitflag, so we can test the shifted state of cursor movements to allow selection, // i.e. (STB_TEXTEDIT_K_RIGHT|STB_TEXTEDIT_K_SHIFT) should be shifted right-arrow. // // You can encode other things, such as CONTROL or ALT, in additional bits, and // then test for their presence in e.g. STB_TEXTEDIT_K_WORDLEFT. For example, // my Windows implementations add an additional CONTROL bit, and an additional KEYDOWN // bit. Then all of the STB_TEXTEDIT_K_ values bitwise-or in the KEYDOWN bit, // and I pass both WM_KEYDOWN and WM_CHAR events to the "key" function in the // API below. The control keys will only match WM_KEYDOWN events because of the // keydown bit I add, and STB_TEXTEDIT_KEYTOTEXT only tests for the KEYDOWN // bit so it only decodes WM_CHAR events. // // STB_TEXTEDIT_LAYOUTROW returns information about the shape of one displayed // row of characters assuming they start on the i'th character--the width and // the height and the number of characters consumed. This allows this library // to traverse the entire layout incrementally. You need to compute word-wrapping // here. // // Each textfield keeps its own insert mode state, which is not how normal // applications work. To keep an app-wide insert mode, update/copy the // "insert_mode" field of STB_TexteditState before/after calling API functions. // // API // // void stb_textedit_initialize_state(STB_TexteditState *state, int is_single_line) // // void stb_textedit_click(STB_TEXTEDIT_STRING *str, STB_TexteditState *state, float x, float y) // void stb_textedit_drag(STB_TEXTEDIT_STRING *str, STB_TexteditState *state, float x, float y) // int stb_textedit_cut(STB_TEXTEDIT_STRING *str, STB_TexteditState *state) // int stb_textedit_paste(STB_TEXTEDIT_STRING *str, STB_TexteditState *state, STB_TEXTEDIT_CHARTYPE *text, int len) // void stb_textedit_key(STB_TEXTEDIT_STRING *str, STB_TexteditState *state, STB_TEXEDIT_KEYTYPE key) // void stb_textedit_text(STB_TEXTEDIT_STRING *str, STB_TexteditState *state, STB_TEXTEDIT_CHARTYPE *text, int text_len) // // Each of these functions potentially updates the string and updates the // state. // // initialize_state: // set the textedit state to a known good default state when initially // constructing the textedit. // // click: // call this with the mouse x,y on a mouse down; it will update the cursor // and reset the selection start/end to the cursor point. the x,y must // be relative to the text widget, with (0,0) being the top left. // // drag: // call this with the mouse x,y on a mouse drag/up; it will update the // cursor and the selection end point // // cut: // call this to delete the current selection; returns true if there was // one. you should FIRST copy the current selection to the system paste buffer. // (To copy, just copy the current selection out of the string yourself.) // // paste: // call this to paste text at the current cursor point or over the current // selection if there is one. // // key: // call this for keyboard inputs sent to the textfield. you can use it // for "key down" events or for "translated" key events. if you need to // do both (as in Win32), or distinguish Unicode characters from control // inputs, set a high bit to distinguish the two; then you can define the // various definitions like STB_TEXTEDIT_K_LEFT have the is-key-event bit // set, and make STB_TEXTEDIT_KEYTOCHAR check that the is-key-event bit is // clear. STB_TEXTEDIT_KEYTYPE defaults to int, but you can #define it to // anything other type you want before including. // if the STB_TEXTEDIT_KEYTOTEXT function is defined, selected keys are // transformed into text and stb_textedit_text() is automatically called. // // text: [DEAR IMGUI] added 2024-09 // call this to text inputs sent to the textfield. // // // When rendering, you can read the cursor position and selection state from // the STB_TexteditState. // // // Notes: // // This is designed to be usable in IMGUI, so it allows for the possibility of // running in an IMGUI that has NOT cached the multi-line layout. For this // reason, it provides an interface that is compatible with computing the // layout incrementally--we try to make sure we make as few passes through // as possible. (For example, to locate the mouse pointer in the text, we // could define functions that return the X and Y positions of characters // and binary search Y and then X, but if we're doing dynamic layout this // will run the layout algorithm many times, so instead we manually search // forward in one pass. Similar logic applies to e.g. up-arrow and // down-arrow movement.) // // If it's run in a widget that *has* cached the layout, then this is less // efficient, but it's not horrible on modern computers. But you wouldn't // want to edit million-line files with it. //////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////// //// //// Header-file mode //// //// #ifndef INCLUDE_IMSTB_TEXTEDIT_H #define INCLUDE_IMSTB_TEXTEDIT_H //////////////////////////////////////////////////////////////////////// // // STB_TexteditState // // Definition of STB_TexteditState which you should store // per-textfield; it includes cursor position, selection state, // and undo state. // #ifndef IMSTB_TEXTEDIT_UNDOSTATECOUNT #define IMSTB_TEXTEDIT_UNDOSTATECOUNT 99 #endif #ifndef IMSTB_TEXTEDIT_UNDOCHARCOUNT #define IMSTB_TEXTEDIT_UNDOCHARCOUNT 999 #endif #ifndef IMSTB_TEXTEDIT_CHARTYPE #define IMSTB_TEXTEDIT_CHARTYPE int #endif #ifndef IMSTB_TEXTEDIT_POSITIONTYPE #define IMSTB_TEXTEDIT_POSITIONTYPE int #endif typedef struct { // private data IMSTB_TEXTEDIT_POSITIONTYPE where; IMSTB_TEXTEDIT_POSITIONTYPE insert_length; IMSTB_TEXTEDIT_POSITIONTYPE delete_length; int char_storage; } StbUndoRecord; typedef struct { // private data StbUndoRecord undo_rec [IMSTB_TEXTEDIT_UNDOSTATECOUNT]; IMSTB_TEXTEDIT_CHARTYPE undo_char[IMSTB_TEXTEDIT_UNDOCHARCOUNT]; short undo_point, redo_point; int undo_char_point, redo_char_point; } StbUndoState; typedef struct STB_TexteditState { ///////////////////// // // public data // int cursor; // position of the text cursor within the string int select_start; // selection start point int select_end; // selection start and end point in characters; if equal, no selection. // note that start may be less than or greater than end (e.g. when // dragging the mouse, start is where the initial click was, and you // can drag in either direction) unsigned char insert_mode; // each textfield keeps its own insert mode state. to keep an app-wide // insert mode, copy this value in/out of the app state int row_count_per_page; // page size in number of row. // this value MUST be set to >0 for pageup or pagedown in multilines documents. ///////////////////// // // private data // unsigned char cursor_at_end_of_line; // not implemented yet unsigned char initialized; unsigned char has_preferred_x; unsigned char single_line; unsigned char padding1, padding2, padding3; float preferred_x; // this determines where the cursor up/down tries to seek to along x StbUndoState undostate; } STB_TexteditState; //////////////////////////////////////////////////////////////////////// // // StbTexteditRow // // Result of layout query, used by stb_textedit to determine where // the text in each row is. // result of layout query typedef struct { float x0,x1; // starting x location, end x location (allows for align=right, etc) float baseline_y_delta; // position of baseline relative to previous row's baseline float ymin,ymax; // height of row above and below baseline int num_chars; } StbTexteditRow; #endif //INCLUDE_IMSTB_TEXTEDIT_H //////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////// //// //// Implementation mode //// //// // implementation isn't include-guarded, since it might have indirectly // included just the "header" portion #ifdef IMSTB_TEXTEDIT_IMPLEMENTATION #ifndef IMSTB_TEXTEDIT_memmove #include #define IMSTB_TEXTEDIT_memmove memmove #endif ///////////////////////////////////////////////////////////////////////////// // // Mouse input handling // // traverse the layout to locate the nearest character to a display position static int stb_text_locate_coord(IMSTB_TEXTEDIT_STRING *str, float x, float y) { StbTexteditRow r; int n = STB_TEXTEDIT_STRINGLEN(str); float base_y = 0, prev_x; int i=0, k; r.x0 = r.x1 = 0; r.ymin = r.ymax = 0; r.num_chars = 0; // search rows to find one that straddles 'y' while (i < n) { STB_TEXTEDIT_LAYOUTROW(&r, str, i); if (r.num_chars <= 0) return n; if (i==0 && y < base_y + r.ymin) return 0; if (y < base_y + r.ymax) break; i += r.num_chars; base_y += r.baseline_y_delta; } // below all text, return 'after' last character if (i >= n) return n; // check if it's before the beginning of the line if (x < r.x0) return i; // check if it's before the end of the line if (x < r.x1) { // search characters in row for one that straddles 'x' prev_x = r.x0; for (k=0; k < r.num_chars; k = IMSTB_TEXTEDIT_GETNEXTCHARINDEX(str, i + k) - i) { float w = STB_TEXTEDIT_GETWIDTH(str, i, k); if (x < prev_x+w) { if (x < prev_x+w/2) return k+i; else return IMSTB_TEXTEDIT_GETNEXTCHARINDEX(str, i + k); } prev_x += w; } // shouldn't happen, but if it does, fall through to end-of-line case } // if the last character is a newline, return that. otherwise return 'after' the last character if (STB_TEXTEDIT_GETCHAR(str, i+r.num_chars-1) == STB_TEXTEDIT_NEWLINE) return i+r.num_chars-1; else return i+r.num_chars; } // API click: on mouse down, move the cursor to the clicked location, and reset the selection static void stb_textedit_click(IMSTB_TEXTEDIT_STRING *str, STB_TexteditState *state, float x, float y) { // In single-line mode, just always make y = 0. This lets the drag keep working if the mouse // goes off the top or bottom of the text if( state->single_line ) { StbTexteditRow r; STB_TEXTEDIT_LAYOUTROW(&r, str, 0); y = r.ymin; } state->cursor = stb_text_locate_coord(str, x, y); state->select_start = state->cursor; state->select_end = state->cursor; state->has_preferred_x = 0; } // API drag: on mouse drag, move the cursor and selection endpoint to the clicked location static void stb_textedit_drag(IMSTB_TEXTEDIT_STRING *str, STB_TexteditState *state, float x, float y) { int p = 0; // In single-line mode, just always make y = 0. This lets the drag keep working if the mouse // goes off the top or bottom of the text if( state->single_line ) { StbTexteditRow r; STB_TEXTEDIT_LAYOUTROW(&r, str, 0); y = r.ymin; } if (state->select_start == state->select_end) state->select_start = state->cursor; p = stb_text_locate_coord(str, x, y); state->cursor = state->select_end = p; } ///////////////////////////////////////////////////////////////////////////// // // Keyboard input handling // // forward declarations static void stb_text_undo(IMSTB_TEXTEDIT_STRING *str, STB_TexteditState *state); static void stb_text_redo(IMSTB_TEXTEDIT_STRING *str, STB_TexteditState *state); static void stb_text_makeundo_delete(IMSTB_TEXTEDIT_STRING *str, STB_TexteditState *state, int where, int length); static void stb_text_makeundo_insert(STB_TexteditState *state, int where, int length); static void stb_text_makeundo_replace(IMSTB_TEXTEDIT_STRING *str, STB_TexteditState *state, int where, int old_length, int new_length); typedef struct { float x,y; // position of n'th character float height; // height of line int first_char, length; // first char of row, and length int prev_first; // first char of previous row } StbFindState; // find the x/y location of a character, and remember info about the previous row in // case we get a move-up event (for page up, we'll have to rescan) static void stb_textedit_find_charpos(StbFindState *find, IMSTB_TEXTEDIT_STRING *str, int n, int single_line) { StbTexteditRow r; int prev_start = 0; int z = STB_TEXTEDIT_STRINGLEN(str); int i=0, first; if (n == z && single_line) { // special case if it's at the end (may not be needed?) STB_TEXTEDIT_LAYOUTROW(&r, str, 0); find->y = 0; find->first_char = 0; find->length = z; find->height = r.ymax - r.ymin; find->x = r.x1; return; } // search rows to find the one that straddles character n find->y = 0; for(;;) { STB_TEXTEDIT_LAYOUTROW(&r, str, i); if (n < i + r.num_chars) break; if (i + r.num_chars == z && z > 0 && STB_TEXTEDIT_GETCHAR(str, z - 1) != STB_TEXTEDIT_NEWLINE) // [DEAR IMGUI] special handling for last line break; // [DEAR IMGUI] prev_start = i; i += r.num_chars; find->y += r.baseline_y_delta; if (i == z) // [DEAR IMGUI] { r.num_chars = 0; // [DEAR IMGUI] break; // [DEAR IMGUI] } } find->first_char = first = i; find->length = r.num_chars; find->height = r.ymax - r.ymin; find->prev_first = prev_start; // now scan to find xpos find->x = r.x0; for (i=0; first+i < n; i = IMSTB_TEXTEDIT_GETNEXTCHARINDEX(str, first + i) - first) find->x += STB_TEXTEDIT_GETWIDTH(str, first, i); } #define STB_TEXT_HAS_SELECTION(s) ((s)->select_start != (s)->select_end) // make the selection/cursor state valid if client altered the string static void stb_textedit_clamp(IMSTB_TEXTEDIT_STRING *str, STB_TexteditState *state) { int n = STB_TEXTEDIT_STRINGLEN(str); if (STB_TEXT_HAS_SELECTION(state)) { if (state->select_start > n) state->select_start = n; if (state->select_end > n) state->select_end = n; // if clamping forced them to be equal, move the cursor to match if (state->select_start == state->select_end) state->cursor = state->select_start; } if (state->cursor > n) state->cursor = n; } // delete characters while updating undo static void stb_textedit_delete(IMSTB_TEXTEDIT_STRING *str, STB_TexteditState *state, int where, int len) { stb_text_makeundo_delete(str, state, where, len); STB_TEXTEDIT_DELETECHARS(str, where, len); state->has_preferred_x = 0; } // delete the section static void stb_textedit_delete_selection(IMSTB_TEXTEDIT_STRING *str, STB_TexteditState *state) { stb_textedit_clamp(str, state); if (STB_TEXT_HAS_SELECTION(state)) { if (state->select_start < state->select_end) { stb_textedit_delete(str, state, state->select_start, state->select_end - state->select_start); state->select_end = state->cursor = state->select_start; } else { stb_textedit_delete(str, state, state->select_end, state->select_start - state->select_end); state->select_start = state->cursor = state->select_end; } state->has_preferred_x = 0; } } // canoncialize the selection so start <= end static void stb_textedit_sortselection(STB_TexteditState *state) { if (state->select_end < state->select_start) { int temp = state->select_end; state->select_end = state->select_start; state->select_start = temp; } } // move cursor to first character of selection static void stb_textedit_move_to_first(STB_TexteditState *state) { if (STB_TEXT_HAS_SELECTION(state)) { stb_textedit_sortselection(state); state->cursor = state->select_start; state->select_end = state->select_start; state->has_preferred_x = 0; } } // move cursor to last character of selection static void stb_textedit_move_to_last(IMSTB_TEXTEDIT_STRING *str, STB_TexteditState *state) { if (STB_TEXT_HAS_SELECTION(state)) { stb_textedit_sortselection(state); stb_textedit_clamp(str, state); state->cursor = state->select_end; state->select_start = state->select_end; state->has_preferred_x = 0; } } // [DEAR IMGUI] // Functions must be implemented for UTF8 support // Code in this file that uses those functions is modified for [DEAR IMGUI] and deviates from the original stb_textedit. // There is not necessarily a '[DEAR IMGUI]' at the usage sites. #ifndef IMSTB_TEXTEDIT_GETPREVCHARINDEX #define IMSTB_TEXTEDIT_GETPREVCHARINDEX(obj, idx) (idx - 1) #endif #ifndef IMSTB_TEXTEDIT_GETNEXTCHARINDEX #define IMSTB_TEXTEDIT_GETNEXTCHARINDEX(obj, idx) (idx + 1) #endif #ifdef STB_TEXTEDIT_IS_SPACE static int is_word_boundary( IMSTB_TEXTEDIT_STRING *str, int idx ) { return idx > 0 ? (STB_TEXTEDIT_IS_SPACE( STB_TEXTEDIT_GETCHAR(str,idx-1) ) && !STB_TEXTEDIT_IS_SPACE( STB_TEXTEDIT_GETCHAR(str, idx) ) ) : 1; } #ifndef STB_TEXTEDIT_MOVEWORDLEFT static int stb_textedit_move_to_word_previous( IMSTB_TEXTEDIT_STRING *str, int c ) { --c; // always move at least one character while( c >= 0 && !is_word_boundary( str, c ) ) --c; if( c < 0 ) c = 0; return c; } #define STB_TEXTEDIT_MOVEWORDLEFT stb_textedit_move_to_word_previous #endif #ifndef STB_TEXTEDIT_MOVEWORDRIGHT static int stb_textedit_move_to_word_next( IMSTB_TEXTEDIT_STRING *str, int c ) { const int len = STB_TEXTEDIT_STRINGLEN(str); ++c; // always move at least one character while( c < len && !is_word_boundary( str, c ) ) ++c; if( c > len ) c = len; return c; } #define STB_TEXTEDIT_MOVEWORDRIGHT stb_textedit_move_to_word_next #endif #endif // update selection and cursor to match each other static void stb_textedit_prep_selection_at_cursor(STB_TexteditState *state) { if (!STB_TEXT_HAS_SELECTION(state)) state->select_start = state->select_end = state->cursor; else state->cursor = state->select_end; } // API cut: delete selection static int stb_textedit_cut(IMSTB_TEXTEDIT_STRING *str, STB_TexteditState *state) { if (STB_TEXT_HAS_SELECTION(state)) { stb_textedit_delete_selection(str,state); // implicitly clamps state->has_preferred_x = 0; return 1; } return 0; } // API paste: replace existing selection with passed-in text static int stb_textedit_paste_internal(IMSTB_TEXTEDIT_STRING *str, STB_TexteditState *state, IMSTB_TEXTEDIT_CHARTYPE *text, int len) { // if there's a selection, the paste should delete it stb_textedit_clamp(str, state); stb_textedit_delete_selection(str,state); // try to insert the characters if (STB_TEXTEDIT_INSERTCHARS(str, state->cursor, text, len)) { stb_text_makeundo_insert(state, state->cursor, len); state->cursor += len; state->has_preferred_x = 0; return 1; } // note: paste failure will leave deleted selection, may be restored with an undo (see https://github.com/nothings/stb/issues/734 for details) return 0; } #ifndef STB_TEXTEDIT_KEYTYPE #define STB_TEXTEDIT_KEYTYPE int #endif // [DEAR IMGUI] Added stb_textedit_text(), extracted out and called by stb_textedit_key() for backward compatibility. static void stb_textedit_text(IMSTB_TEXTEDIT_STRING* str, STB_TexteditState* state, const IMSTB_TEXTEDIT_CHARTYPE* text, int text_len) { // can't add newline in single-line mode if (text[0] == '\n' && state->single_line) return; if (state->insert_mode && !STB_TEXT_HAS_SELECTION(state) && state->cursor < STB_TEXTEDIT_STRINGLEN(str)) { stb_text_makeundo_replace(str, state, state->cursor, 1, 1); STB_TEXTEDIT_DELETECHARS(str, state->cursor, 1); if (STB_TEXTEDIT_INSERTCHARS(str, state->cursor, text, text_len)) { state->cursor += text_len; state->has_preferred_x = 0; } } else { stb_textedit_delete_selection(str, state); // implicitly clamps if (STB_TEXTEDIT_INSERTCHARS(str, state->cursor, text, text_len)) { stb_text_makeundo_insert(state, state->cursor, text_len); state->cursor += text_len; state->has_preferred_x = 0; } } } // API key: process a keyboard input static void stb_textedit_key(IMSTB_TEXTEDIT_STRING *str, STB_TexteditState *state, STB_TEXTEDIT_KEYTYPE key) { retry: switch (key) { default: { #ifdef STB_TEXTEDIT_KEYTOTEXT int c = STB_TEXTEDIT_KEYTOTEXT(key); if (c > 0) { IMSTB_TEXTEDIT_CHARTYPE ch = (IMSTB_TEXTEDIT_CHARTYPE)c; stb_textedit_text(str, state, &ch, 1); } #endif break; } #ifdef STB_TEXTEDIT_K_INSERT case STB_TEXTEDIT_K_INSERT: state->insert_mode = !state->insert_mode; break; #endif case STB_TEXTEDIT_K_UNDO: stb_text_undo(str, state); state->has_preferred_x = 0; break; case STB_TEXTEDIT_K_REDO: stb_text_redo(str, state); state->has_preferred_x = 0; break; case STB_TEXTEDIT_K_LEFT: // if currently there's a selection, move cursor to start of selection if (STB_TEXT_HAS_SELECTION(state)) stb_textedit_move_to_first(state); else if (state->cursor > 0) state->cursor = IMSTB_TEXTEDIT_GETPREVCHARINDEX(str, state->cursor); state->has_preferred_x = 0; break; case STB_TEXTEDIT_K_RIGHT: // if currently there's a selection, move cursor to end of selection if (STB_TEXT_HAS_SELECTION(state)) stb_textedit_move_to_last(str, state); else state->cursor = IMSTB_TEXTEDIT_GETNEXTCHARINDEX(str, state->cursor); stb_textedit_clamp(str, state); state->has_preferred_x = 0; break; case STB_TEXTEDIT_K_LEFT | STB_TEXTEDIT_K_SHIFT: stb_textedit_clamp(str, state); stb_textedit_prep_selection_at_cursor(state); // move selection left if (state->select_end > 0) state->select_end = IMSTB_TEXTEDIT_GETPREVCHARINDEX(str, state->select_end); state->cursor = state->select_end; state->has_preferred_x = 0; break; #ifdef STB_TEXTEDIT_MOVEWORDLEFT case STB_TEXTEDIT_K_WORDLEFT: if (STB_TEXT_HAS_SELECTION(state)) stb_textedit_move_to_first(state); else { state->cursor = STB_TEXTEDIT_MOVEWORDLEFT(str, state->cursor); stb_textedit_clamp( str, state ); } break; case STB_TEXTEDIT_K_WORDLEFT | STB_TEXTEDIT_K_SHIFT: if( !STB_TEXT_HAS_SELECTION( state ) ) stb_textedit_prep_selection_at_cursor(state); state->cursor = STB_TEXTEDIT_MOVEWORDLEFT(str, state->cursor); state->select_end = state->cursor; stb_textedit_clamp( str, state ); break; #endif #ifdef STB_TEXTEDIT_MOVEWORDRIGHT case STB_TEXTEDIT_K_WORDRIGHT: if (STB_TEXT_HAS_SELECTION(state)) stb_textedit_move_to_last(str, state); else { state->cursor = STB_TEXTEDIT_MOVEWORDRIGHT(str, state->cursor); stb_textedit_clamp( str, state ); } break; case STB_TEXTEDIT_K_WORDRIGHT | STB_TEXTEDIT_K_SHIFT: if( !STB_TEXT_HAS_SELECTION( state ) ) stb_textedit_prep_selection_at_cursor(state); state->cursor = STB_TEXTEDIT_MOVEWORDRIGHT(str, state->cursor); state->select_end = state->cursor; stb_textedit_clamp( str, state ); break; #endif case STB_TEXTEDIT_K_RIGHT | STB_TEXTEDIT_K_SHIFT: stb_textedit_prep_selection_at_cursor(state); // move selection right state->select_end = IMSTB_TEXTEDIT_GETNEXTCHARINDEX(str, state->select_end); stb_textedit_clamp(str, state); state->cursor = state->select_end; state->has_preferred_x = 0; break; case STB_TEXTEDIT_K_DOWN: case STB_TEXTEDIT_K_DOWN | STB_TEXTEDIT_K_SHIFT: case STB_TEXTEDIT_K_PGDOWN: case STB_TEXTEDIT_K_PGDOWN | STB_TEXTEDIT_K_SHIFT: { StbFindState find; StbTexteditRow row; int i, j, sel = (key & STB_TEXTEDIT_K_SHIFT) != 0; int is_page = (key & ~STB_TEXTEDIT_K_SHIFT) == STB_TEXTEDIT_K_PGDOWN; int row_count = is_page ? state->row_count_per_page : 1; if (!is_page && state->single_line) { // on windows, up&down in single-line behave like left&right key = STB_TEXTEDIT_K_RIGHT | (key & STB_TEXTEDIT_K_SHIFT); goto retry; } if (sel) stb_textedit_prep_selection_at_cursor(state); else if (STB_TEXT_HAS_SELECTION(state)) stb_textedit_move_to_last(str, state); // compute current position of cursor point stb_textedit_clamp(str, state); stb_textedit_find_charpos(&find, str, state->cursor, state->single_line); for (j = 0; j < row_count; ++j) { float x, goal_x = state->has_preferred_x ? state->preferred_x : find.x; int start = find.first_char + find.length; if (find.length == 0) break; // [DEAR IMGUI] // going down while being on the last line shouldn't bring us to that line end if (STB_TEXTEDIT_GETCHAR(str, find.first_char + find.length - 1) != STB_TEXTEDIT_NEWLINE) break; // now find character position down a row state->cursor = start; STB_TEXTEDIT_LAYOUTROW(&row, str, state->cursor); x = row.x0; for (i=0; i < row.num_chars; ++i) { float dx = STB_TEXTEDIT_GETWIDTH(str, start, i); #ifdef IMSTB_TEXTEDIT_GETWIDTH_NEWLINE if (dx == IMSTB_TEXTEDIT_GETWIDTH_NEWLINE) break; #endif x += dx; if (x > goal_x) break; state->cursor = IMSTB_TEXTEDIT_GETNEXTCHARINDEX(str, state->cursor); } stb_textedit_clamp(str, state); state->has_preferred_x = 1; state->preferred_x = goal_x; if (sel) state->select_end = state->cursor; // go to next line find.first_char = find.first_char + find.length; find.length = row.num_chars; } break; } case STB_TEXTEDIT_K_UP: case STB_TEXTEDIT_K_UP | STB_TEXTEDIT_K_SHIFT: case STB_TEXTEDIT_K_PGUP: case STB_TEXTEDIT_K_PGUP | STB_TEXTEDIT_K_SHIFT: { StbFindState find; StbTexteditRow row; int i, j, prev_scan, sel = (key & STB_TEXTEDIT_K_SHIFT) != 0; int is_page = (key & ~STB_TEXTEDIT_K_SHIFT) == STB_TEXTEDIT_K_PGUP; int row_count = is_page ? state->row_count_per_page : 1; if (!is_page && state->single_line) { // on windows, up&down become left&right key = STB_TEXTEDIT_K_LEFT | (key & STB_TEXTEDIT_K_SHIFT); goto retry; } if (sel) stb_textedit_prep_selection_at_cursor(state); else if (STB_TEXT_HAS_SELECTION(state)) stb_textedit_move_to_first(state); // compute current position of cursor point stb_textedit_clamp(str, state); stb_textedit_find_charpos(&find, str, state->cursor, state->single_line); for (j = 0; j < row_count; ++j) { float x, goal_x = state->has_preferred_x ? state->preferred_x : find.x; // can only go up if there's a previous row if (find.prev_first == find.first_char) break; // now find character position up a row state->cursor = find.prev_first; STB_TEXTEDIT_LAYOUTROW(&row, str, state->cursor); x = row.x0; for (i=0; i < row.num_chars; ++i) { float dx = STB_TEXTEDIT_GETWIDTH(str, find.prev_first, i); #ifdef IMSTB_TEXTEDIT_GETWIDTH_NEWLINE if (dx == IMSTB_TEXTEDIT_GETWIDTH_NEWLINE) break; #endif x += dx; if (x > goal_x) break; state->cursor = IMSTB_TEXTEDIT_GETNEXTCHARINDEX(str, state->cursor); } stb_textedit_clamp(str, state); state->has_preferred_x = 1; state->preferred_x = goal_x; if (sel) state->select_end = state->cursor; // go to previous line // (we need to scan previous line the hard way. maybe we could expose this as a new API function?) prev_scan = find.prev_first > 0 ? find.prev_first - 1 : 0; while (prev_scan > 0 && STB_TEXTEDIT_GETCHAR(str, prev_scan - 1) != STB_TEXTEDIT_NEWLINE) --prev_scan; find.first_char = find.prev_first; find.prev_first = prev_scan; } break; } case STB_TEXTEDIT_K_DELETE: case STB_TEXTEDIT_K_DELETE | STB_TEXTEDIT_K_SHIFT: if (STB_TEXT_HAS_SELECTION(state)) stb_textedit_delete_selection(str, state); else { int n = STB_TEXTEDIT_STRINGLEN(str); if (state->cursor < n) stb_textedit_delete(str, state, state->cursor, IMSTB_TEXTEDIT_GETNEXTCHARINDEX(str, state->cursor) - state->cursor); } state->has_preferred_x = 0; break; case STB_TEXTEDIT_K_BACKSPACE: case STB_TEXTEDIT_K_BACKSPACE | STB_TEXTEDIT_K_SHIFT: if (STB_TEXT_HAS_SELECTION(state)) stb_textedit_delete_selection(str, state); else { stb_textedit_clamp(str, state); if (state->cursor > 0) { int prev = IMSTB_TEXTEDIT_GETPREVCHARINDEX(str, state->cursor); stb_textedit_delete(str, state, prev, state->cursor - prev); state->cursor = prev; } } state->has_preferred_x = 0; break; #ifdef STB_TEXTEDIT_K_TEXTSTART2 case STB_TEXTEDIT_K_TEXTSTART2: #endif case STB_TEXTEDIT_K_TEXTSTART: state->cursor = state->select_start = state->select_end = 0; state->has_preferred_x = 0; break; #ifdef STB_TEXTEDIT_K_TEXTEND2 case STB_TEXTEDIT_K_TEXTEND2: #endif case STB_TEXTEDIT_K_TEXTEND: state->cursor = STB_TEXTEDIT_STRINGLEN(str); state->select_start = state->select_end = 0; state->has_preferred_x = 0; break; #ifdef STB_TEXTEDIT_K_TEXTSTART2 case STB_TEXTEDIT_K_TEXTSTART2 | STB_TEXTEDIT_K_SHIFT: #endif case STB_TEXTEDIT_K_TEXTSTART | STB_TEXTEDIT_K_SHIFT: stb_textedit_prep_selection_at_cursor(state); state->cursor = state->select_end = 0; state->has_preferred_x = 0; break; #ifdef STB_TEXTEDIT_K_TEXTEND2 case STB_TEXTEDIT_K_TEXTEND2 | STB_TEXTEDIT_K_SHIFT: #endif case STB_TEXTEDIT_K_TEXTEND | STB_TEXTEDIT_K_SHIFT: stb_textedit_prep_selection_at_cursor(state); state->cursor = state->select_end = STB_TEXTEDIT_STRINGLEN(str); state->has_preferred_x = 0; break; #ifdef STB_TEXTEDIT_K_LINESTART2 case STB_TEXTEDIT_K_LINESTART2: #endif case STB_TEXTEDIT_K_LINESTART: stb_textedit_clamp(str, state); stb_textedit_move_to_first(state); if (state->single_line) state->cursor = 0; else while (state->cursor > 0 && STB_TEXTEDIT_GETCHAR(str, state->cursor-1) != STB_TEXTEDIT_NEWLINE) --state->cursor; state->has_preferred_x = 0; break; #ifdef STB_TEXTEDIT_K_LINEEND2 case STB_TEXTEDIT_K_LINEEND2: #endif case STB_TEXTEDIT_K_LINEEND: { int n = STB_TEXTEDIT_STRINGLEN(str); stb_textedit_clamp(str, state); stb_textedit_move_to_first(state); if (state->single_line) state->cursor = n; else while (state->cursor < n && STB_TEXTEDIT_GETCHAR(str, state->cursor) != STB_TEXTEDIT_NEWLINE) ++state->cursor; state->has_preferred_x = 0; break; } #ifdef STB_TEXTEDIT_K_LINESTART2 case STB_TEXTEDIT_K_LINESTART2 | STB_TEXTEDIT_K_SHIFT: #endif case STB_TEXTEDIT_K_LINESTART | STB_TEXTEDIT_K_SHIFT: stb_textedit_clamp(str, state); stb_textedit_prep_selection_at_cursor(state); if (state->single_line) state->cursor = 0; else while (state->cursor > 0 && STB_TEXTEDIT_GETCHAR(str, state->cursor-1) != STB_TEXTEDIT_NEWLINE) --state->cursor; state->select_end = state->cursor; state->has_preferred_x = 0; break; #ifdef STB_TEXTEDIT_K_LINEEND2 case STB_TEXTEDIT_K_LINEEND2 | STB_TEXTEDIT_K_SHIFT: #endif case STB_TEXTEDIT_K_LINEEND | STB_TEXTEDIT_K_SHIFT: { int n = STB_TEXTEDIT_STRINGLEN(str); stb_textedit_clamp(str, state); stb_textedit_prep_selection_at_cursor(state); if (state->single_line) state->cursor = n; else while (state->cursor < n && STB_TEXTEDIT_GETCHAR(str, state->cursor) != STB_TEXTEDIT_NEWLINE) ++state->cursor; state->select_end = state->cursor; state->has_preferred_x = 0; break; } } } ///////////////////////////////////////////////////////////////////////////// // // Undo processing // // @OPTIMIZE: the undo/redo buffer should be circular static void stb_textedit_flush_redo(StbUndoState *state) { state->redo_point = IMSTB_TEXTEDIT_UNDOSTATECOUNT; state->redo_char_point = IMSTB_TEXTEDIT_UNDOCHARCOUNT; } // discard the oldest entry in the undo list static void stb_textedit_discard_undo(StbUndoState *state) { if (state->undo_point > 0) { // if the 0th undo state has characters, clean those up if (state->undo_rec[0].char_storage >= 0) { int n = state->undo_rec[0].insert_length, i; // delete n characters from all other records state->undo_char_point -= n; IMSTB_TEXTEDIT_memmove(state->undo_char, state->undo_char + n, (size_t) (state->undo_char_point*sizeof(IMSTB_TEXTEDIT_CHARTYPE))); for (i=0; i < state->undo_point; ++i) if (state->undo_rec[i].char_storage >= 0) state->undo_rec[i].char_storage -= n; // @OPTIMIZE: get rid of char_storage and infer it } --state->undo_point; IMSTB_TEXTEDIT_memmove(state->undo_rec, state->undo_rec+1, (size_t) (state->undo_point*sizeof(state->undo_rec[0]))); } } // discard the oldest entry in the redo list--it's bad if this // ever happens, but because undo & redo have to store the actual // characters in different cases, the redo character buffer can // fill up even though the undo buffer didn't static void stb_textedit_discard_redo(StbUndoState *state) { int k = IMSTB_TEXTEDIT_UNDOSTATECOUNT-1; if (state->redo_point <= k) { // if the k'th undo state has characters, clean those up if (state->undo_rec[k].char_storage >= 0) { int n = state->undo_rec[k].insert_length, i; // move the remaining redo character data to the end of the buffer state->redo_char_point += n; IMSTB_TEXTEDIT_memmove(state->undo_char + state->redo_char_point, state->undo_char + state->redo_char_point-n, (size_t) ((IMSTB_TEXTEDIT_UNDOCHARCOUNT - state->redo_char_point)*sizeof(IMSTB_TEXTEDIT_CHARTYPE))); // adjust the position of all the other records to account for above memmove for (i=state->redo_point; i < k; ++i) if (state->undo_rec[i].char_storage >= 0) state->undo_rec[i].char_storage += n; } // now move all the redo records towards the end of the buffer; the first one is at 'redo_point' // [DEAR IMGUI] size_t move_size = (size_t)((IMSTB_TEXTEDIT_UNDOSTATECOUNT - state->redo_point - 1) * sizeof(state->undo_rec[0])); const char* buf_begin = (char*)state->undo_rec; (void)buf_begin; const char* buf_end = (char*)state->undo_rec + sizeof(state->undo_rec); (void)buf_end; IM_ASSERT(((char*)(state->undo_rec + state->redo_point)) >= buf_begin); IM_ASSERT(((char*)(state->undo_rec + state->redo_point + 1) + move_size) <= buf_end); IMSTB_TEXTEDIT_memmove(state->undo_rec + state->redo_point+1, state->undo_rec + state->redo_point, move_size); // now move redo_point to point to the new one ++state->redo_point; } } static StbUndoRecord *stb_text_create_undo_record(StbUndoState *state, int numchars) { // any time we create a new undo record, we discard redo stb_textedit_flush_redo(state); // if we have no free records, we have to make room, by sliding the // existing records down if (state->undo_point == IMSTB_TEXTEDIT_UNDOSTATECOUNT) stb_textedit_discard_undo(state); // if the characters to store won't possibly fit in the buffer, we can't undo if (numchars > IMSTB_TEXTEDIT_UNDOCHARCOUNT) { state->undo_point = 0; state->undo_char_point = 0; return NULL; } // if we don't have enough free characters in the buffer, we have to make room while (state->undo_char_point + numchars > IMSTB_TEXTEDIT_UNDOCHARCOUNT) stb_textedit_discard_undo(state); return &state->undo_rec[state->undo_point++]; } static IMSTB_TEXTEDIT_CHARTYPE *stb_text_createundo(StbUndoState *state, int pos, int insert_len, int delete_len) { StbUndoRecord *r = stb_text_create_undo_record(state, insert_len); if (r == NULL) return NULL; r->where = pos; r->insert_length = (IMSTB_TEXTEDIT_POSITIONTYPE) insert_len; r->delete_length = (IMSTB_TEXTEDIT_POSITIONTYPE) delete_len; if (insert_len == 0) { r->char_storage = -1; return NULL; } else { r->char_storage = state->undo_char_point; state->undo_char_point += insert_len; return &state->undo_char[r->char_storage]; } } static void stb_text_undo(IMSTB_TEXTEDIT_STRING *str, STB_TexteditState *state) { StbUndoState *s = &state->undostate; StbUndoRecord u, *r; if (s->undo_point == 0) return; // we need to do two things: apply the undo record, and create a redo record u = s->undo_rec[s->undo_point-1]; r = &s->undo_rec[s->redo_point-1]; r->char_storage = -1; r->insert_length = u.delete_length; r->delete_length = u.insert_length; r->where = u.where; if (u.delete_length) { // if the undo record says to delete characters, then the redo record will // need to re-insert the characters that get deleted, so we need to store // them. // there are three cases: // there's enough room to store the characters // characters stored for *redoing* don't leave room for redo // characters stored for *undoing* don't leave room for redo // if the last is true, we have to bail if (s->undo_char_point + u.delete_length >= IMSTB_TEXTEDIT_UNDOCHARCOUNT) { // the undo records take up too much character space; there's no space to store the redo characters r->insert_length = 0; } else { int i; // there's definitely room to store the characters eventually while (s->undo_char_point + u.delete_length > s->redo_char_point) { // should never happen: if (s->redo_point == IMSTB_TEXTEDIT_UNDOSTATECOUNT) return; // there's currently not enough room, so discard a redo record stb_textedit_discard_redo(s); } r = &s->undo_rec[s->redo_point-1]; r->char_storage = s->redo_char_point - u.delete_length; s->redo_char_point = s->redo_char_point - u.delete_length; // now save the characters for (i=0; i < u.delete_length; ++i) s->undo_char[r->char_storage + i] = STB_TEXTEDIT_GETCHAR(str, u.where + i); } // now we can carry out the deletion STB_TEXTEDIT_DELETECHARS(str, u.where, u.delete_length); } // check type of recorded action: if (u.insert_length) { // easy case: was a deletion, so we need to insert n characters STB_TEXTEDIT_INSERTCHARS(str, u.where, &s->undo_char[u.char_storage], u.insert_length); s->undo_char_point -= u.insert_length; } state->cursor = u.where + u.insert_length; s->undo_point--; s->redo_point--; } static void stb_text_redo(IMSTB_TEXTEDIT_STRING *str, STB_TexteditState *state) { StbUndoState *s = &state->undostate; StbUndoRecord *u, r; if (s->redo_point == IMSTB_TEXTEDIT_UNDOSTATECOUNT) return; // we need to do two things: apply the redo record, and create an undo record u = &s->undo_rec[s->undo_point]; r = s->undo_rec[s->redo_point]; // we KNOW there must be room for the undo record, because the redo record // was derived from an undo record u->delete_length = r.insert_length; u->insert_length = r.delete_length; u->where = r.where; u->char_storage = -1; if (r.delete_length) { // the redo record requires us to delete characters, so the undo record // needs to store the characters if (s->undo_char_point + u->insert_length > s->redo_char_point) { u->insert_length = 0; u->delete_length = 0; } else { int i; u->char_storage = s->undo_char_point; s->undo_char_point = s->undo_char_point + u->insert_length; // now save the characters for (i=0; i < u->insert_length; ++i) s->undo_char[u->char_storage + i] = STB_TEXTEDIT_GETCHAR(str, u->where + i); } STB_TEXTEDIT_DELETECHARS(str, r.where, r.delete_length); } if (r.insert_length) { // easy case: need to insert n characters STB_TEXTEDIT_INSERTCHARS(str, r.where, &s->undo_char[r.char_storage], r.insert_length); s->redo_char_point += r.insert_length; } state->cursor = r.where + r.insert_length; s->undo_point++; s->redo_point++; } static void stb_text_makeundo_insert(STB_TexteditState *state, int where, int length) { stb_text_createundo(&state->undostate, where, 0, length); } static void stb_text_makeundo_delete(IMSTB_TEXTEDIT_STRING *str, STB_TexteditState *state, int where, int length) { int i; IMSTB_TEXTEDIT_CHARTYPE *p = stb_text_createundo(&state->undostate, where, length, 0); if (p) { for (i=0; i < length; ++i) p[i] = STB_TEXTEDIT_GETCHAR(str, where+i); } } static void stb_text_makeundo_replace(IMSTB_TEXTEDIT_STRING *str, STB_TexteditState *state, int where, int old_length, int new_length) { int i; IMSTB_TEXTEDIT_CHARTYPE *p = stb_text_createundo(&state->undostate, where, old_length, new_length); if (p) { for (i=0; i < old_length; ++i) p[i] = STB_TEXTEDIT_GETCHAR(str, where+i); } } // reset the state to default static void stb_textedit_clear_state(STB_TexteditState *state, int is_single_line) { state->undostate.undo_point = 0; state->undostate.undo_char_point = 0; state->undostate.redo_point = IMSTB_TEXTEDIT_UNDOSTATECOUNT; state->undostate.redo_char_point = IMSTB_TEXTEDIT_UNDOCHARCOUNT; state->select_end = state->select_start = 0; state->cursor = 0; state->has_preferred_x = 0; state->preferred_x = 0; state->cursor_at_end_of_line = 0; state->initialized = 1; state->single_line = (unsigned char) is_single_line; state->insert_mode = 0; state->row_count_per_page = 0; } // API initialize static void stb_textedit_initialize_state(STB_TexteditState *state, int is_single_line) { stb_textedit_clear_state(state, is_single_line); } #if defined(__GNUC__) || defined(__clang__) #pragma GCC diagnostic push #pragma GCC diagnostic ignored "-Wcast-qual" #endif static int stb_textedit_paste(IMSTB_TEXTEDIT_STRING *str, STB_TexteditState *state, IMSTB_TEXTEDIT_CHARTYPE const *ctext, int len) { return stb_textedit_paste_internal(str, state, (IMSTB_TEXTEDIT_CHARTYPE *) ctext, len); } #if defined(__GNUC__) || defined(__clang__) #pragma GCC diagnostic pop #endif #endif//IMSTB_TEXTEDIT_IMPLEMENTATION /* ------------------------------------------------------------------------------ This software is available under 2 licenses -- choose whichever you prefer. ------------------------------------------------------------------------------ ALTERNATIVE A - MIT License Copyright (c) 2017 Sean Barrett Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ------------------------------------------------------------------------------ ALTERNATIVE B - Public Domain (www.unlicense.org) This is free and unencumbered software released into the public domain. Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means. In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ------------------------------------------------------------------------------ */ ================================================ FILE: src/DesktopPlusUI/imgui/imstb_truetype.h ================================================ // [DEAR IMGUI] // This is a slightly modified version of stb_truetype.h 1.26. // Mostly fixing for compiler and static analyzer warnings. // Grep for [DEAR IMGUI] to find the changes. // stb_truetype.h - v1.26 - public domain // authored from 2009-2021 by Sean Barrett / RAD Game Tools // // ======================================================================= // // NO SECURITY GUARANTEE -- DO NOT USE THIS ON UNTRUSTED FONT FILES // // This library does no range checking of the offsets found in the file, // meaning an attacker can use it to read arbitrary memory. // // ======================================================================= // // This library processes TrueType files: // parse files // extract glyph metrics // extract glyph shapes // render glyphs to one-channel bitmaps with antialiasing (box filter) // render glyphs to one-channel SDF bitmaps (signed-distance field/function) // // Todo: // non-MS cmaps // crashproof on bad data // hinting? (no longer patented) // cleartype-style AA? // optimize: use simple memory allocator for intermediates // optimize: build edge-list directly from curves // optimize: rasterize directly from curves? // // ADDITIONAL CONTRIBUTORS // // Mikko Mononen: compound shape support, more cmap formats // Tor Andersson: kerning, subpixel rendering // Dougall Johnson: OpenType / Type 2 font handling // Daniel Ribeiro Maciel: basic GPOS-based kerning // // Misc other: // Ryan Gordon // Simon Glass // github:IntellectualKitty // Imanol Celaya // Daniel Ribeiro Maciel // // Bug/warning reports/fixes: // "Zer" on mollyrocket Fabian "ryg" Giesen github:NiLuJe // Cass Everitt Martins Mozeiko github:aloucks // stoiko (Haemimont Games) Cap Petschulat github:oyvindjam // Brian Hook Omar Cornut github:vassvik // Walter van Niftrik Ryan Griege // David Gow Peter LaValle // David Given Sergey Popov // Ivan-Assen Ivanov Giumo X. Clanjor // Anthony Pesch Higor Euripedes // Johan Duparc Thomas Fields // Hou Qiming Derek Vinyard // Rob Loach Cort Stratton // Kenney Phillis Jr. Brian Costabile // Ken Voskuil (kaesve) // // VERSION HISTORY // // 1.26 (2021-08-28) fix broken rasterizer // 1.25 (2021-07-11) many fixes // 1.24 (2020-02-05) fix warning // 1.23 (2020-02-02) query SVG data for glyphs; query whole kerning table (but only kern not GPOS) // 1.22 (2019-08-11) minimize missing-glyph duplication; fix kerning if both 'GPOS' and 'kern' are defined // 1.21 (2019-02-25) fix warning // 1.20 (2019-02-07) PackFontRange skips missing codepoints; GetScaleFontVMetrics() // 1.19 (2018-02-11) GPOS kerning, STBTT_fmod // 1.18 (2018-01-29) add missing function // 1.17 (2017-07-23) make more arguments const; doc fix // 1.16 (2017-07-12) SDF support // 1.15 (2017-03-03) make more arguments const // 1.14 (2017-01-16) num-fonts-in-TTC function // 1.13 (2017-01-02) support OpenType fonts, certain Apple fonts // 1.12 (2016-10-25) suppress warnings about casting away const with -Wcast-qual // 1.11 (2016-04-02) fix unused-variable warning // 1.10 (2016-04-02) user-defined fabs(); rare memory leak; remove duplicate typedef // 1.09 (2016-01-16) warning fix; avoid crash on outofmem; use allocation userdata properly // 1.08 (2015-09-13) document stbtt_Rasterize(); fixes for vertical & horizontal edges // 1.07 (2015-08-01) allow PackFontRanges to accept arrays of sparse codepoints; // variant PackFontRanges to pack and render in separate phases; // fix stbtt_GetFontOFfsetForIndex (never worked for non-0 input?); // fixed an assert() bug in the new rasterizer // replace assert() with STBTT_assert() in new rasterizer // // Full history can be found at the end of this file. // // LICENSE // // See end of file for license information. // // USAGE // // Include this file in whatever places need to refer to it. In ONE C/C++ // file, write: // #define STB_TRUETYPE_IMPLEMENTATION // before the #include of this file. This expands out the actual // implementation into that C/C++ file. // // To make the implementation private to the file that generates the implementation, // #define STBTT_STATIC // // Simple 3D API (don't ship this, but it's fine for tools and quick start) // stbtt_BakeFontBitmap() -- bake a font to a bitmap for use as texture // stbtt_GetBakedQuad() -- compute quad to draw for a given char // // Improved 3D API (more shippable): // #include "stb_rect_pack.h" -- optional, but you really want it // stbtt_PackBegin() // stbtt_PackSetOversampling() -- for improved quality on small fonts // stbtt_PackFontRanges() -- pack and renders // stbtt_PackEnd() // stbtt_GetPackedQuad() // // "Load" a font file from a memory buffer (you have to keep the buffer loaded) // stbtt_InitFont() // stbtt_GetFontOffsetForIndex() -- indexing for TTC font collections // stbtt_GetNumberOfFonts() -- number of fonts for TTC font collections // // Render a unicode codepoint to a bitmap // stbtt_GetCodepointBitmap() -- allocates and returns a bitmap // stbtt_MakeCodepointBitmap() -- renders into bitmap you provide // stbtt_GetCodepointBitmapBox() -- how big the bitmap must be // // Character advance/positioning // stbtt_GetCodepointHMetrics() // stbtt_GetFontVMetrics() // stbtt_GetFontVMetricsOS2() // stbtt_GetCodepointKernAdvance() // // Starting with version 1.06, the rasterizer was replaced with a new, // faster and generally-more-precise rasterizer. The new rasterizer more // accurately measures pixel coverage for anti-aliasing, except in the case // where multiple shapes overlap, in which case it overestimates the AA pixel // coverage. Thus, anti-aliasing of intersecting shapes may look wrong. If // this turns out to be a problem, you can re-enable the old rasterizer with // #define STBTT_RASTERIZER_VERSION 1 // which will incur about a 15% speed hit. // // ADDITIONAL DOCUMENTATION // // Immediately after this block comment are a series of sample programs. // // After the sample programs is the "header file" section. This section // includes documentation for each API function. // // Some important concepts to understand to use this library: // // Codepoint // Characters are defined by unicode codepoints, e.g. 65 is // uppercase A, 231 is lowercase c with a cedilla, 0x7e30 is // the hiragana for "ma". // // Glyph // A visual character shape (every codepoint is rendered as // some glyph) // // Glyph index // A font-specific integer ID representing a glyph // // Baseline // Glyph shapes are defined relative to a baseline, which is the // bottom of uppercase characters. Characters extend both above // and below the baseline. // // Current Point // As you draw text to the screen, you keep track of a "current point" // which is the origin of each character. The current point's vertical // position is the baseline. Even "baked fonts" use this model. // // Vertical Font Metrics // The vertical qualities of the font, used to vertically position // and space the characters. See docs for stbtt_GetFontVMetrics. // // Font Size in Pixels or Points // The preferred interface for specifying font sizes in stb_truetype // is to specify how tall the font's vertical extent should be in pixels. // If that sounds good enough, skip the next paragraph. // // Most font APIs instead use "points", which are a common typographic // measurement for describing font size, defined as 72 points per inch. // stb_truetype provides a point API for compatibility. However, true // "per inch" conventions don't make much sense on computer displays // since different monitors have different number of pixels per // inch. For example, Windows traditionally uses a convention that // there are 96 pixels per inch, thus making 'inch' measurements have // nothing to do with inches, and thus effectively defining a point to // be 1.333 pixels. Additionally, the TrueType font data provides // an explicit scale factor to scale a given font's glyphs to points, // but the author has observed that this scale factor is often wrong // for non-commercial fonts, thus making fonts scaled in points // according to the TrueType spec incoherently sized in practice. // // DETAILED USAGE: // // Scale: // Select how high you want the font to be, in points or pixels. // Call ScaleForPixelHeight or ScaleForMappingEmToPixels to compute // a scale factor SF that will be used by all other functions. // // Baseline: // You need to select a y-coordinate that is the baseline of where // your text will appear. Call GetFontBoundingBox to get the baseline-relative // bounding box for all characters. SF*-y0 will be the distance in pixels // that the worst-case character could extend above the baseline, so if // you want the top edge of characters to appear at the top of the // screen where y=0, then you would set the baseline to SF*-y0. // // Current point: // Set the current point where the first character will appear. The // first character could extend left of the current point; this is font // dependent. You can either choose a current point that is the leftmost // point and hope, or add some padding, or check the bounding box or // left-side-bearing of the first character to be displayed and set // the current point based on that. // // Displaying a character: // Compute the bounding box of the character. It will contain signed values // relative to . I.e. if it returns x0,y0,x1,y1, // then the character should be displayed in the rectangle from // to = 32 && *text < 128) { stbtt_aligned_quad q; stbtt_GetBakedQuad(cdata, 512,512, *text-32, &x,&y,&q,1);//1=opengl & d3d10+,0=d3d9 glTexCoord2f(q.s0,q.t0); glVertex2f(q.x0,q.y0); glTexCoord2f(q.s1,q.t0); glVertex2f(q.x1,q.y0); glTexCoord2f(q.s1,q.t1); glVertex2f(q.x1,q.y1); glTexCoord2f(q.s0,q.t1); glVertex2f(q.x0,q.y1); } ++text; } glEnd(); } #endif // // ////////////////////////////////////////////////////////////////////////////// // // Complete program (this compiles): get a single bitmap, print as ASCII art // #if 0 #include #define STB_TRUETYPE_IMPLEMENTATION // force following include to generate implementation #include "stb_truetype.h" char ttf_buffer[1<<25]; int main(int argc, char **argv) { stbtt_fontinfo font; unsigned char *bitmap; int w,h,i,j,c = (argc > 1 ? atoi(argv[1]) : 'a'), s = (argc > 2 ? atoi(argv[2]) : 20); fread(ttf_buffer, 1, 1<<25, fopen(argc > 3 ? argv[3] : "c:/windows/fonts/arialbd.ttf", "rb")); stbtt_InitFont(&font, ttf_buffer, stbtt_GetFontOffsetForIndex(ttf_buffer,0)); bitmap = stbtt_GetCodepointBitmap(&font, 0,stbtt_ScaleForPixelHeight(&font, s), c, &w, &h, 0,0); for (j=0; j < h; ++j) { for (i=0; i < w; ++i) putchar(" .:ioVM@"[bitmap[j*w+i]>>5]); putchar('\n'); } return 0; } #endif // // Output: // // .ii. // @@@@@@. // V@Mio@@o // :i. V@V // :oM@@M // :@@@MM@M // @@o o@M // :@@. M@M // @@@o@@@@ // :M@@V:@@. // ////////////////////////////////////////////////////////////////////////////// // // Complete program: print "Hello World!" banner, with bugs // #if 0 char buffer[24<<20]; unsigned char screen[20][79]; int main(int arg, char **argv) { stbtt_fontinfo font; int i,j,ascent,baseline,ch=0; float scale, xpos=2; // leave a little padding in case the character extends left char *text = "Heljo World!"; // intentionally misspelled to show 'lj' brokenness fread(buffer, 1, 1000000, fopen("c:/windows/fonts/arialbd.ttf", "rb")); stbtt_InitFont(&font, buffer, 0); scale = stbtt_ScaleForPixelHeight(&font, 15); stbtt_GetFontVMetrics(&font, &ascent,0,0); baseline = (int) (ascent*scale); while (text[ch]) { int advance,lsb,x0,y0,x1,y1; float x_shift = xpos - (float) floor(xpos); stbtt_GetCodepointHMetrics(&font, text[ch], &advance, &lsb); stbtt_GetCodepointBitmapBoxSubpixel(&font, text[ch], scale,scale,x_shift,0, &x0,&y0,&x1,&y1); stbtt_MakeCodepointBitmapSubpixel(&font, &screen[baseline + y0][(int) xpos + x0], x1-x0,y1-y0, 79, scale,scale,x_shift,0, text[ch]); // note that this stomps the old data, so where character boxes overlap (e.g. 'lj') it's wrong // because this API is really for baking character bitmaps into textures. if you want to render // a sequence of characters, you really need to render each bitmap to a temp buffer, then // "alpha blend" that into the working buffer xpos += (advance * scale); if (text[ch+1]) xpos += scale*stbtt_GetCodepointKernAdvance(&font, text[ch],text[ch+1]); ++ch; } for (j=0; j < 20; ++j) { for (i=0; i < 78; ++i) putchar(" .:ioVM@"[screen[j][i]>>5]); putchar('\n'); } return 0; } #endif ////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////// //// //// INTEGRATION WITH YOUR CODEBASE //// //// The following sections allow you to supply alternate definitions //// of C library functions used by stb_truetype, e.g. if you don't //// link with the C runtime library. #ifdef STB_TRUETYPE_IMPLEMENTATION // #define your own (u)stbtt_int8/16/32 before including to override this #ifndef stbtt_uint8 typedef unsigned char stbtt_uint8; typedef signed char stbtt_int8; typedef unsigned short stbtt_uint16; typedef signed short stbtt_int16; typedef unsigned int stbtt_uint32; typedef signed int stbtt_int32; #endif typedef char stbtt__check_size32[sizeof(stbtt_int32)==4 ? 1 : -1]; typedef char stbtt__check_size16[sizeof(stbtt_int16)==2 ? 1 : -1]; // e.g. #define your own STBTT_ifloor/STBTT_iceil() to avoid math.h #ifndef STBTT_ifloor #include #define STBTT_ifloor(x) ((int) floor(x)) #define STBTT_iceil(x) ((int) ceil(x)) #endif #ifndef STBTT_sqrt #include #define STBTT_sqrt(x) sqrt(x) #define STBTT_pow(x,y) pow(x,y) #endif #ifndef STBTT_fmod #include #define STBTT_fmod(x,y) fmod(x,y) #endif #ifndef STBTT_cos #include #define STBTT_cos(x) cos(x) #define STBTT_acos(x) acos(x) #endif #ifndef STBTT_fabs #include #define STBTT_fabs(x) fabs(x) #endif // #define your own functions "STBTT_malloc" / "STBTT_free" to avoid malloc.h #ifndef STBTT_malloc #include #define STBTT_malloc(x,u) ((void)(u),malloc(x)) #define STBTT_free(x,u) ((void)(u),free(x)) #endif #ifndef STBTT_assert #include #define STBTT_assert(x) assert(x) #endif #ifndef STBTT_strlen #include #define STBTT_strlen(x) strlen(x) #endif #ifndef STBTT_memcpy #include #define STBTT_memcpy memcpy #define STBTT_memset memset #endif #endif /////////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////// //// //// INTERFACE //// //// #ifndef __STB_INCLUDE_STB_TRUETYPE_H__ #define __STB_INCLUDE_STB_TRUETYPE_H__ #ifdef STBTT_STATIC #define STBTT_DEF static #else #define STBTT_DEF extern #endif #ifdef __cplusplus extern "C" { #endif // private structure typedef struct { unsigned char *data; int cursor; int size; } stbtt__buf; ////////////////////////////////////////////////////////////////////////////// // // TEXTURE BAKING API // // If you use this API, you only have to call two functions ever. // typedef struct { unsigned short x0,y0,x1,y1; // coordinates of bbox in bitmap float xoff,yoff,xadvance; } stbtt_bakedchar; STBTT_DEF int stbtt_BakeFontBitmap(const unsigned char *data, int offset, // font location (use offset=0 for plain .ttf) float pixel_height, // height of font in pixels unsigned char *pixels, int pw, int ph, // bitmap to be filled in int first_char, int num_chars, // characters to bake stbtt_bakedchar *chardata); // you allocate this, it's num_chars long // if return is positive, the first unused row of the bitmap // if return is negative, returns the negative of the number of characters that fit // if return is 0, no characters fit and no rows were used // This uses a very crappy packing. typedef struct { float x0,y0,s0,t0; // top-left float x1,y1,s1,t1; // bottom-right } stbtt_aligned_quad; STBTT_DEF void stbtt_GetBakedQuad(const stbtt_bakedchar *chardata, int pw, int ph, // same data as above int char_index, // character to display float *xpos, float *ypos, // pointers to current position in screen pixel space stbtt_aligned_quad *q, // output: quad to draw int opengl_fillrule); // true if opengl fill rule; false if DX9 or earlier // Call GetBakedQuad with char_index = 'character - first_char', and it // creates the quad you need to draw and advances the current position. // // The coordinate system used assumes y increases downwards. // // Characters will extend both above and below the current position; // see discussion of "BASELINE" above. // // It's inefficient; you might want to c&p it and optimize it. STBTT_DEF void stbtt_GetScaledFontVMetrics(const unsigned char *fontdata, int index, float size, float *ascent, float *descent, float *lineGap); // Query the font vertical metrics without having to create a font first. ////////////////////////////////////////////////////////////////////////////// // // NEW TEXTURE BAKING API // // This provides options for packing multiple fonts into one atlas, not // perfectly but better than nothing. typedef struct { unsigned short x0,y0,x1,y1; // coordinates of bbox in bitmap float xoff,yoff,xadvance; float xoff2,yoff2; } stbtt_packedchar; typedef struct stbtt_pack_context stbtt_pack_context; typedef struct stbtt_fontinfo stbtt_fontinfo; #ifndef STB_RECT_PACK_VERSION typedef struct stbrp_rect stbrp_rect; #endif STBTT_DEF int stbtt_PackBegin(stbtt_pack_context *spc, unsigned char *pixels, int width, int height, int stride_in_bytes, int padding, void *alloc_context); // Initializes a packing context stored in the passed-in stbtt_pack_context. // Future calls using this context will pack characters into the bitmap passed // in here: a 1-channel bitmap that is width * height. stride_in_bytes is // the distance from one row to the next (or 0 to mean they are packed tightly // together). "padding" is the amount of padding to leave between each // character (normally you want '1' for bitmaps you'll use as textures with // bilinear filtering). // // Returns 0 on failure, 1 on success. STBTT_DEF void stbtt_PackEnd (stbtt_pack_context *spc); // Cleans up the packing context and frees all memory. #define STBTT_POINT_SIZE(x) (-(x)) STBTT_DEF int stbtt_PackFontRange(stbtt_pack_context *spc, const unsigned char *fontdata, int font_index, float font_size, int first_unicode_char_in_range, int num_chars_in_range, stbtt_packedchar *chardata_for_range); // Creates character bitmaps from the font_index'th font found in fontdata (use // font_index=0 if you don't know what that is). It creates num_chars_in_range // bitmaps for characters with unicode values starting at first_unicode_char_in_range // and increasing. Data for how to render them is stored in chardata_for_range; // pass these to stbtt_GetPackedQuad to get back renderable quads. // // font_size is the full height of the character from ascender to descender, // as computed by stbtt_ScaleForPixelHeight. To use a point size as computed // by stbtt_ScaleForMappingEmToPixels, wrap the point size in STBTT_POINT_SIZE() // and pass that result as 'font_size': // ..., 20 , ... // font max minus min y is 20 pixels tall // ..., STBTT_POINT_SIZE(20), ... // 'M' is 20 pixels tall typedef struct { float font_size; int first_unicode_codepoint_in_range; // if non-zero, then the chars are continuous, and this is the first codepoint int *array_of_unicode_codepoints; // if non-zero, then this is an array of unicode codepoints int num_chars; stbtt_packedchar *chardata_for_range; // output unsigned char h_oversample, v_oversample; // don't set these, they're used internally } stbtt_pack_range; STBTT_DEF int stbtt_PackFontRanges(stbtt_pack_context *spc, const unsigned char *fontdata, int font_index, stbtt_pack_range *ranges, int num_ranges); // Creates character bitmaps from multiple ranges of characters stored in // ranges. This will usually create a better-packed bitmap than multiple // calls to stbtt_PackFontRange. Note that you can call this multiple // times within a single PackBegin/PackEnd. STBTT_DEF void stbtt_PackSetOversampling(stbtt_pack_context *spc, unsigned int h_oversample, unsigned int v_oversample); // Oversampling a font increases the quality by allowing higher-quality subpixel // positioning, and is especially valuable at smaller text sizes. // // This function sets the amount of oversampling for all following calls to // stbtt_PackFontRange(s) or stbtt_PackFontRangesGatherRects for a given // pack context. The default (no oversampling) is achieved by h_oversample=1 // and v_oversample=1. The total number of pixels required is // h_oversample*v_oversample larger than the default; for example, 2x2 // oversampling requires 4x the storage of 1x1. For best results, render // oversampled textures with bilinear filtering. Look at the readme in // stb/tests/oversample for information about oversampled fonts // // To use with PackFontRangesGather etc., you must set it before calls // call to PackFontRangesGatherRects. STBTT_DEF void stbtt_PackSetSkipMissingCodepoints(stbtt_pack_context *spc, int skip); // If skip != 0, this tells stb_truetype to skip any codepoints for which // there is no corresponding glyph. If skip=0, which is the default, then // codepoints without a glyph received the font's "missing character" glyph, // typically an empty box by convention. STBTT_DEF void stbtt_GetPackedQuad(const stbtt_packedchar *chardata, int pw, int ph, // same data as above int char_index, // character to display float *xpos, float *ypos, // pointers to current position in screen pixel space stbtt_aligned_quad *q, // output: quad to draw int align_to_integer); STBTT_DEF int stbtt_PackFontRangesGatherRects(stbtt_pack_context *spc, const stbtt_fontinfo *info, stbtt_pack_range *ranges, int num_ranges, stbrp_rect *rects); STBTT_DEF void stbtt_PackFontRangesPackRects(stbtt_pack_context *spc, stbrp_rect *rects, int num_rects); STBTT_DEF int stbtt_PackFontRangesRenderIntoRects(stbtt_pack_context *spc, const stbtt_fontinfo *info, stbtt_pack_range *ranges, int num_ranges, stbrp_rect *rects); // Calling these functions in sequence is roughly equivalent to calling // stbtt_PackFontRanges(). If you more control over the packing of multiple // fonts, or if you want to pack custom data into a font texture, take a look // at the source to of stbtt_PackFontRanges() and create a custom version // using these functions, e.g. call GatherRects multiple times, // building up a single array of rects, then call PackRects once, // then call RenderIntoRects repeatedly. This may result in a // better packing than calling PackFontRanges multiple times // (or it may not). // this is an opaque structure that you shouldn't mess with which holds // all the context needed from PackBegin to PackEnd. struct stbtt_pack_context { void *user_allocator_context; void *pack_info; int width; int height; int stride_in_bytes; int padding; int skip_missing; unsigned int h_oversample, v_oversample; unsigned char *pixels; void *nodes; }; ////////////////////////////////////////////////////////////////////////////// // // FONT LOADING // // STBTT_DEF int stbtt_GetNumberOfFonts(const unsigned char *data); // This function will determine the number of fonts in a font file. TrueType // collection (.ttc) files may contain multiple fonts, while TrueType font // (.ttf) files only contain one font. The number of fonts can be used for // indexing with the previous function where the index is between zero and one // less than the total fonts. If an error occurs, -1 is returned. STBTT_DEF int stbtt_GetFontOffsetForIndex(const unsigned char *data, int index); // Each .ttf/.ttc file may have more than one font. Each font has a sequential // index number starting from 0. Call this function to get the font offset for // a given index; it returns -1 if the index is out of range. A regular .ttf // file will only define one font and it always be at offset 0, so it will // return '0' for index 0, and -1 for all other indices. // The following structure is defined publicly so you can declare one on // the stack or as a global or etc, but you should treat it as opaque. struct stbtt_fontinfo { void * userdata; unsigned char * data; // pointer to .ttf file int fontstart; // offset of start of font int numGlyphs; // number of glyphs, needed for range checking int loca,head,glyf,hhea,hmtx,kern,gpos,svg; // table locations as offset from start of .ttf int index_map; // a cmap mapping for our chosen character encoding int indexToLocFormat; // format needed to map from glyph index to glyph stbtt__buf cff; // cff font data stbtt__buf charstrings; // the charstring index stbtt__buf gsubrs; // global charstring subroutines index stbtt__buf subrs; // private charstring subroutines index stbtt__buf fontdicts; // array of font dicts stbtt__buf fdselect; // map from glyph to fontdict }; STBTT_DEF int stbtt_InitFont(stbtt_fontinfo *info, const unsigned char *data, int offset); // Given an offset into the file that defines a font, this function builds // the necessary cached info for the rest of the system. You must allocate // the stbtt_fontinfo yourself, and stbtt_InitFont will fill it out. You don't // need to do anything special to free it, because the contents are pure // value data with no additional data structures. Returns 0 on failure. ////////////////////////////////////////////////////////////////////////////// // // CHARACTER TO GLYPH-INDEX CONVERSIOn STBTT_DEF int stbtt_FindGlyphIndex(const stbtt_fontinfo *info, int unicode_codepoint); // If you're going to perform multiple operations on the same character // and you want a speed-up, call this function with the character you're // going to process, then use glyph-based functions instead of the // codepoint-based functions. // Returns 0 if the character codepoint is not defined in the font. ////////////////////////////////////////////////////////////////////////////// // // CHARACTER PROPERTIES // STBTT_DEF float stbtt_ScaleForPixelHeight(const stbtt_fontinfo *info, float pixels); // computes a scale factor to produce a font whose "height" is 'pixels' tall. // Height is measured as the distance from the highest ascender to the lowest // descender; in other words, it's equivalent to calling stbtt_GetFontVMetrics // and computing: // scale = pixels / (ascent - descent) // so if you prefer to measure height by the ascent only, use a similar calculation. STBTT_DEF float stbtt_ScaleForMappingEmToPixels(const stbtt_fontinfo *info, float pixels); // computes a scale factor to produce a font whose EM size is mapped to // 'pixels' tall. This is probably what traditional APIs compute, but // I'm not positive. STBTT_DEF void stbtt_GetFontVMetrics(const stbtt_fontinfo *info, int *ascent, int *descent, int *lineGap); // ascent is the coordinate above the baseline the font extends; descent // is the coordinate below the baseline the font extends (i.e. it is typically negative) // lineGap is the spacing between one row's descent and the next row's ascent... // so you should advance the vertical position by "*ascent - *descent + *lineGap" // these are expressed in unscaled coordinates, so you must multiply by // the scale factor for a given size STBTT_DEF int stbtt_GetFontVMetricsOS2(const stbtt_fontinfo *info, int *typoAscent, int *typoDescent, int *typoLineGap); // analogous to GetFontVMetrics, but returns the "typographic" values from the OS/2 // table (specific to MS/Windows TTF files). // // Returns 1 on success (table present), 0 on failure. STBTT_DEF void stbtt_GetFontBoundingBox(const stbtt_fontinfo *info, int *x0, int *y0, int *x1, int *y1); // the bounding box around all possible characters STBTT_DEF void stbtt_GetCodepointHMetrics(const stbtt_fontinfo *info, int codepoint, int *advanceWidth, int *leftSideBearing); // leftSideBearing is the offset from the current horizontal position to the left edge of the character // advanceWidth is the offset from the current horizontal position to the next horizontal position // these are expressed in unscaled coordinates STBTT_DEF int stbtt_GetCodepointKernAdvance(const stbtt_fontinfo *info, int ch1, int ch2); // an additional amount to add to the 'advance' value between ch1 and ch2 STBTT_DEF int stbtt_GetCodepointBox(const stbtt_fontinfo *info, int codepoint, int *x0, int *y0, int *x1, int *y1); // Gets the bounding box of the visible part of the glyph, in unscaled coordinates STBTT_DEF void stbtt_GetGlyphHMetrics(const stbtt_fontinfo *info, int glyph_index, int *advanceWidth, int *leftSideBearing); STBTT_DEF int stbtt_GetGlyphKernAdvance(const stbtt_fontinfo *info, int glyph1, int glyph2); STBTT_DEF int stbtt_GetGlyphBox(const stbtt_fontinfo *info, int glyph_index, int *x0, int *y0, int *x1, int *y1); // as above, but takes one or more glyph indices for greater efficiency typedef struct stbtt_kerningentry { int glyph1; // use stbtt_FindGlyphIndex int glyph2; int advance; } stbtt_kerningentry; STBTT_DEF int stbtt_GetKerningTableLength(const stbtt_fontinfo *info); STBTT_DEF int stbtt_GetKerningTable(const stbtt_fontinfo *info, stbtt_kerningentry* table, int table_length); // Retrieves a complete list of all of the kerning pairs provided by the font // stbtt_GetKerningTable never writes more than table_length entries and returns how many entries it did write. // The table will be sorted by (a.glyph1 == b.glyph1)?(a.glyph2 < b.glyph2):(a.glyph1 < b.glyph1) ////////////////////////////////////////////////////////////////////////////// // // GLYPH SHAPES (you probably don't need these, but they have to go before // the bitmaps for C declaration-order reasons) // #ifndef STBTT_vmove // you can predefine these to use different values (but why?) enum { STBTT_vmove=1, STBTT_vline, STBTT_vcurve, STBTT_vcubic }; #endif #ifndef stbtt_vertex // you can predefine this to use different values // (we share this with other code at RAD) #define stbtt_vertex_type short // can't use stbtt_int16 because that's not visible in the header file typedef struct { stbtt_vertex_type x,y,cx,cy,cx1,cy1; unsigned char type,padding; } stbtt_vertex; #endif STBTT_DEF int stbtt_IsGlyphEmpty(const stbtt_fontinfo *info, int glyph_index); // returns non-zero if nothing is drawn for this glyph STBTT_DEF int stbtt_GetCodepointShape(const stbtt_fontinfo *info, int unicode_codepoint, stbtt_vertex **vertices); STBTT_DEF int stbtt_GetGlyphShape(const stbtt_fontinfo *info, int glyph_index, stbtt_vertex **vertices); // returns # of vertices and fills *vertices with the pointer to them // these are expressed in "unscaled" coordinates // // The shape is a series of contours. Each one starts with // a STBTT_moveto, then consists of a series of mixed // STBTT_lineto and STBTT_curveto segments. A lineto // draws a line from previous endpoint to its x,y; a curveto // draws a quadratic bezier from previous endpoint to // its x,y, using cx,cy as the bezier control point. STBTT_DEF void stbtt_FreeShape(const stbtt_fontinfo *info, stbtt_vertex *vertices); // frees the data allocated above STBTT_DEF unsigned char *stbtt_FindSVGDoc(const stbtt_fontinfo *info, int gl); STBTT_DEF int stbtt_GetCodepointSVG(const stbtt_fontinfo *info, int unicode_codepoint, const char **svg); STBTT_DEF int stbtt_GetGlyphSVG(const stbtt_fontinfo *info, int gl, const char **svg); // fills svg with the character's SVG data. // returns data size or 0 if SVG not found. ////////////////////////////////////////////////////////////////////////////// // // BITMAP RENDERING // STBTT_DEF void stbtt_FreeBitmap(unsigned char *bitmap, void *userdata); // frees the bitmap allocated below STBTT_DEF unsigned char *stbtt_GetCodepointBitmap(const stbtt_fontinfo *info, float scale_x, float scale_y, int codepoint, int *width, int *height, int *xoff, int *yoff); // allocates a large-enough single-channel 8bpp bitmap and renders the // specified character/glyph at the specified scale into it, with // antialiasing. 0 is no coverage (transparent), 255 is fully covered (opaque). // *width & *height are filled out with the width & height of the bitmap, // which is stored left-to-right, top-to-bottom. // // xoff/yoff are the offset it pixel space from the glyph origin to the top-left of the bitmap STBTT_DEF unsigned char *stbtt_GetCodepointBitmapSubpixel(const stbtt_fontinfo *info, float scale_x, float scale_y, float shift_x, float shift_y, int codepoint, int *width, int *height, int *xoff, int *yoff); // the same as stbtt_GetCodepoitnBitmap, but you can specify a subpixel // shift for the character STBTT_DEF void stbtt_MakeCodepointBitmap(const stbtt_fontinfo *info, unsigned char *output, int out_w, int out_h, int out_stride, float scale_x, float scale_y, int codepoint); // the same as stbtt_GetCodepointBitmap, but you pass in storage for the bitmap // in the form of 'output', with row spacing of 'out_stride' bytes. the bitmap // is clipped to out_w/out_h bytes. Call stbtt_GetCodepointBitmapBox to get the // width and height and positioning info for it first. STBTT_DEF void stbtt_MakeCodepointBitmapSubpixel(const stbtt_fontinfo *info, unsigned char *output, int out_w, int out_h, int out_stride, float scale_x, float scale_y, float shift_x, float shift_y, int codepoint); // same as stbtt_MakeCodepointBitmap, but you can specify a subpixel // shift for the character STBTT_DEF void stbtt_MakeCodepointBitmapSubpixelPrefilter(const stbtt_fontinfo *info, unsigned char *output, int out_w, int out_h, int out_stride, float scale_x, float scale_y, float shift_x, float shift_y, int oversample_x, int oversample_y, float *sub_x, float *sub_y, int codepoint); // same as stbtt_MakeCodepointBitmapSubpixel, but prefiltering // is performed (see stbtt_PackSetOversampling) STBTT_DEF void stbtt_GetCodepointBitmapBox(const stbtt_fontinfo *font, int codepoint, float scale_x, float scale_y, int *ix0, int *iy0, int *ix1, int *iy1); // get the bbox of the bitmap centered around the glyph origin; so the // bitmap width is ix1-ix0, height is iy1-iy0, and location to place // the bitmap top left is (leftSideBearing*scale,iy0). // (Note that the bitmap uses y-increases-down, but the shape uses // y-increases-up, so CodepointBitmapBox and CodepointBox are inverted.) STBTT_DEF void stbtt_GetCodepointBitmapBoxSubpixel(const stbtt_fontinfo *font, int codepoint, float scale_x, float scale_y, float shift_x, float shift_y, int *ix0, int *iy0, int *ix1, int *iy1); // same as stbtt_GetCodepointBitmapBox, but you can specify a subpixel // shift for the character // the following functions are equivalent to the above functions, but operate // on glyph indices instead of Unicode codepoints (for efficiency) STBTT_DEF unsigned char *stbtt_GetGlyphBitmap(const stbtt_fontinfo *info, float scale_x, float scale_y, int glyph, int *width, int *height, int *xoff, int *yoff); STBTT_DEF unsigned char *stbtt_GetGlyphBitmapSubpixel(const stbtt_fontinfo *info, float scale_x, float scale_y, float shift_x, float shift_y, int glyph, int *width, int *height, int *xoff, int *yoff); STBTT_DEF void stbtt_MakeGlyphBitmap(const stbtt_fontinfo *info, unsigned char *output, int out_w, int out_h, int out_stride, float scale_x, float scale_y, int glyph); STBTT_DEF void stbtt_MakeGlyphBitmapSubpixel(const stbtt_fontinfo *info, unsigned char *output, int out_w, int out_h, int out_stride, float scale_x, float scale_y, float shift_x, float shift_y, int glyph); STBTT_DEF void stbtt_MakeGlyphBitmapSubpixelPrefilter(const stbtt_fontinfo *info, unsigned char *output, int out_w, int out_h, int out_stride, float scale_x, float scale_y, float shift_x, float shift_y, int oversample_x, int oversample_y, float *sub_x, float *sub_y, int glyph); STBTT_DEF void stbtt_GetGlyphBitmapBox(const stbtt_fontinfo *font, int glyph, float scale_x, float scale_y, int *ix0, int *iy0, int *ix1, int *iy1); STBTT_DEF void stbtt_GetGlyphBitmapBoxSubpixel(const stbtt_fontinfo *font, int glyph, float scale_x, float scale_y,float shift_x, float shift_y, int *ix0, int *iy0, int *ix1, int *iy1); // @TODO: don't expose this structure typedef struct { int w,h,stride; unsigned char *pixels; } stbtt__bitmap; // rasterize a shape with quadratic beziers into a bitmap STBTT_DEF void stbtt_Rasterize(stbtt__bitmap *result, // 1-channel bitmap to draw into float flatness_in_pixels, // allowable error of curve in pixels stbtt_vertex *vertices, // array of vertices defining shape int num_verts, // number of vertices in above array float scale_x, float scale_y, // scale applied to input vertices float shift_x, float shift_y, // translation applied to input vertices int x_off, int y_off, // another translation applied to input int invert, // if non-zero, vertically flip shape void *userdata); // context for to STBTT_MALLOC ////////////////////////////////////////////////////////////////////////////// // // Signed Distance Function (or Field) rendering STBTT_DEF void stbtt_FreeSDF(unsigned char *bitmap, void *userdata); // frees the SDF bitmap allocated below STBTT_DEF unsigned char * stbtt_GetGlyphSDF(const stbtt_fontinfo *info, float scale, int glyph, int padding, unsigned char onedge_value, float pixel_dist_scale, int *width, int *height, int *xoff, int *yoff); STBTT_DEF unsigned char * stbtt_GetCodepointSDF(const stbtt_fontinfo *info, float scale, int codepoint, int padding, unsigned char onedge_value, float pixel_dist_scale, int *width, int *height, int *xoff, int *yoff); // These functions compute a discretized SDF field for a single character, suitable for storing // in a single-channel texture, sampling with bilinear filtering, and testing against // larger than some threshold to produce scalable fonts. // info -- the font // scale -- controls the size of the resulting SDF bitmap, same as it would be creating a regular bitmap // glyph/codepoint -- the character to generate the SDF for // padding -- extra "pixels" around the character which are filled with the distance to the character (not 0), // which allows effects like bit outlines // onedge_value -- value 0-255 to test the SDF against to reconstruct the character (i.e. the isocontour of the character) // pixel_dist_scale -- what value the SDF should increase by when moving one SDF "pixel" away from the edge (on the 0..255 scale) // if positive, > onedge_value is inside; if negative, < onedge_value is inside // width,height -- output height & width of the SDF bitmap (including padding) // xoff,yoff -- output origin of the character // return value -- a 2D array of bytes 0..255, width*height in size // // pixel_dist_scale & onedge_value are a scale & bias that allows you to make // optimal use of the limited 0..255 for your application, trading off precision // and special effects. SDF values outside the range 0..255 are clamped to 0..255. // // Example: // scale = stbtt_ScaleForPixelHeight(22) // padding = 5 // onedge_value = 180 // pixel_dist_scale = 180/5.0 = 36.0 // // This will create an SDF bitmap in which the character is about 22 pixels // high but the whole bitmap is about 22+5+5=32 pixels high. To produce a filled // shape, sample the SDF at each pixel and fill the pixel if the SDF value // is greater than or equal to 180/255. (You'll actually want to antialias, // which is beyond the scope of this example.) Additionally, you can compute // offset outlines (e.g. to stroke the character border inside & outside, // or only outside). For example, to fill outside the character up to 3 SDF // pixels, you would compare against (180-36.0*3)/255 = 72/255. The above // choice of variables maps a range from 5 pixels outside the shape to // 2 pixels inside the shape to 0..255; this is intended primarily for apply // outside effects only (the interior range is needed to allow proper // antialiasing of the font at *smaller* sizes) // // The function computes the SDF analytically at each SDF pixel, not by e.g. // building a higher-res bitmap and approximating it. In theory the quality // should be as high as possible for an SDF of this size & representation, but // unclear if this is true in practice (perhaps building a higher-res bitmap // and computing from that can allow drop-out prevention). // // The algorithm has not been optimized at all, so expect it to be slow // if computing lots of characters or very large sizes. ////////////////////////////////////////////////////////////////////////////// // // Finding the right font... // // You should really just solve this offline, keep your own tables // of what font is what, and don't try to get it out of the .ttf file. // That's because getting it out of the .ttf file is really hard, because // the names in the file can appear in many possible encodings, in many // possible languages, and e.g. if you need a case-insensitive comparison, // the details of that depend on the encoding & language in a complex way // (actually underspecified in truetype, but also gigantic). // // But you can use the provided functions in two possible ways: // stbtt_FindMatchingFont() will use *case-sensitive* comparisons on // unicode-encoded names to try to find the font you want; // you can run this before calling stbtt_InitFont() // // stbtt_GetFontNameString() lets you get any of the various strings // from the file yourself and do your own comparisons on them. // You have to have called stbtt_InitFont() first. STBTT_DEF int stbtt_FindMatchingFont(const unsigned char *fontdata, const char *name, int flags); // returns the offset (not index) of the font that matches, or -1 if none // if you use STBTT_MACSTYLE_DONTCARE, use a font name like "Arial Bold". // if you use any other flag, use a font name like "Arial"; this checks // the 'macStyle' header field; i don't know if fonts set this consistently #define STBTT_MACSTYLE_DONTCARE 0 #define STBTT_MACSTYLE_BOLD 1 #define STBTT_MACSTYLE_ITALIC 2 #define STBTT_MACSTYLE_UNDERSCORE 4 #define STBTT_MACSTYLE_NONE 8 // <= not same as 0, this makes us check the bitfield is 0 STBTT_DEF int stbtt_CompareUTF8toUTF16_bigendian(const char *s1, int len1, const char *s2, int len2); // returns 1/0 whether the first string interpreted as utf8 is identical to // the second string interpreted as big-endian utf16... useful for strings from next func STBTT_DEF const char *stbtt_GetFontNameString(const stbtt_fontinfo *font, int *length, int platformID, int encodingID, int languageID, int nameID); // returns the string (which may be big-endian double byte, e.g. for unicode) // and puts the length in bytes in *length. // // some of the values for the IDs are below; for more see the truetype spec: // http://developer.apple.com/textfonts/TTRefMan/RM06/Chap6name.html // http://www.microsoft.com/typography/otspec/name.htm enum { // platformID STBTT_PLATFORM_ID_UNICODE =0, STBTT_PLATFORM_ID_MAC =1, STBTT_PLATFORM_ID_ISO =2, STBTT_PLATFORM_ID_MICROSOFT =3 }; enum { // encodingID for STBTT_PLATFORM_ID_UNICODE STBTT_UNICODE_EID_UNICODE_1_0 =0, STBTT_UNICODE_EID_UNICODE_1_1 =1, STBTT_UNICODE_EID_ISO_10646 =2, STBTT_UNICODE_EID_UNICODE_2_0_BMP=3, STBTT_UNICODE_EID_UNICODE_2_0_FULL=4 }; enum { // encodingID for STBTT_PLATFORM_ID_MICROSOFT STBTT_MS_EID_SYMBOL =0, STBTT_MS_EID_UNICODE_BMP =1, STBTT_MS_EID_SHIFTJIS =2, STBTT_MS_EID_UNICODE_FULL =10 }; enum { // encodingID for STBTT_PLATFORM_ID_MAC; same as Script Manager codes STBTT_MAC_EID_ROMAN =0, STBTT_MAC_EID_ARABIC =4, STBTT_MAC_EID_JAPANESE =1, STBTT_MAC_EID_HEBREW =5, STBTT_MAC_EID_CHINESE_TRAD =2, STBTT_MAC_EID_GREEK =6, STBTT_MAC_EID_KOREAN =3, STBTT_MAC_EID_RUSSIAN =7 }; enum { // languageID for STBTT_PLATFORM_ID_MICROSOFT; same as LCID... // problematic because there are e.g. 16 english LCIDs and 16 arabic LCIDs STBTT_MS_LANG_ENGLISH =0x0409, STBTT_MS_LANG_ITALIAN =0x0410, STBTT_MS_LANG_CHINESE =0x0804, STBTT_MS_LANG_JAPANESE =0x0411, STBTT_MS_LANG_DUTCH =0x0413, STBTT_MS_LANG_KOREAN =0x0412, STBTT_MS_LANG_FRENCH =0x040c, STBTT_MS_LANG_RUSSIAN =0x0419, STBTT_MS_LANG_GERMAN =0x0407, STBTT_MS_LANG_SPANISH =0x0409, STBTT_MS_LANG_HEBREW =0x040d, STBTT_MS_LANG_SWEDISH =0x041D }; enum { // languageID for STBTT_PLATFORM_ID_MAC STBTT_MAC_LANG_ENGLISH =0 , STBTT_MAC_LANG_JAPANESE =11, STBTT_MAC_LANG_ARABIC =12, STBTT_MAC_LANG_KOREAN =23, STBTT_MAC_LANG_DUTCH =4 , STBTT_MAC_LANG_RUSSIAN =32, STBTT_MAC_LANG_FRENCH =1 , STBTT_MAC_LANG_SPANISH =6 , STBTT_MAC_LANG_GERMAN =2 , STBTT_MAC_LANG_SWEDISH =5 , STBTT_MAC_LANG_HEBREW =10, STBTT_MAC_LANG_CHINESE_SIMPLIFIED =33, STBTT_MAC_LANG_ITALIAN =3 , STBTT_MAC_LANG_CHINESE_TRAD =19 }; #ifdef __cplusplus } #endif #endif // __STB_INCLUDE_STB_TRUETYPE_H__ /////////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////// //// //// IMPLEMENTATION //// //// #ifdef STB_TRUETYPE_IMPLEMENTATION #ifndef STBTT_MAX_OVERSAMPLE #define STBTT_MAX_OVERSAMPLE 8 #endif #if STBTT_MAX_OVERSAMPLE > 255 #error "STBTT_MAX_OVERSAMPLE cannot be > 255" #endif typedef int stbtt__test_oversample_pow2[(STBTT_MAX_OVERSAMPLE & (STBTT_MAX_OVERSAMPLE-1)) == 0 ? 1 : -1]; #ifndef STBTT_RASTERIZER_VERSION #define STBTT_RASTERIZER_VERSION 2 #endif #ifdef _MSC_VER #define STBTT__NOTUSED(v) (void)(v) #else #define STBTT__NOTUSED(v) (void)sizeof(v) #endif ////////////////////////////////////////////////////////////////////////// // // stbtt__buf helpers to parse data from file // static stbtt_uint8 stbtt__buf_get8(stbtt__buf *b) { if (b->cursor >= b->size) return 0; return b->data[b->cursor++]; } static stbtt_uint8 stbtt__buf_peek8(stbtt__buf *b) { if (b->cursor >= b->size) return 0; return b->data[b->cursor]; } static void stbtt__buf_seek(stbtt__buf *b, int o) { STBTT_assert(!(o > b->size || o < 0)); b->cursor = (o > b->size || o < 0) ? b->size : o; } static void stbtt__buf_skip(stbtt__buf *b, int o) { stbtt__buf_seek(b, b->cursor + o); } static stbtt_uint32 stbtt__buf_get(stbtt__buf *b, int n) { stbtt_uint32 v = 0; int i; STBTT_assert(n >= 1 && n <= 4); for (i = 0; i < n; i++) v = (v << 8) | stbtt__buf_get8(b); return v; } static stbtt__buf stbtt__new_buf(const void *p, size_t size) { stbtt__buf r; STBTT_assert(size < 0x40000000); r.data = (stbtt_uint8*) p; r.size = (int) size; r.cursor = 0; return r; } #define stbtt__buf_get16(b) stbtt__buf_get((b), 2) #define stbtt__buf_get32(b) stbtt__buf_get((b), 4) static stbtt__buf stbtt__buf_range(const stbtt__buf *b, int o, int s) { stbtt__buf r = stbtt__new_buf(NULL, 0); if (o < 0 || s < 0 || o > b->size || s > b->size - o) return r; r.data = b->data + o; r.size = s; return r; } static stbtt__buf stbtt__cff_get_index(stbtt__buf *b) { int count, start, offsize; start = b->cursor; count = stbtt__buf_get16(b); if (count) { offsize = stbtt__buf_get8(b); STBTT_assert(offsize >= 1 && offsize <= 4); stbtt__buf_skip(b, offsize * count); stbtt__buf_skip(b, stbtt__buf_get(b, offsize) - 1); } return stbtt__buf_range(b, start, b->cursor - start); } static stbtt_uint32 stbtt__cff_int(stbtt__buf *b) { int b0 = stbtt__buf_get8(b); if (b0 >= 32 && b0 <= 246) return b0 - 139; else if (b0 >= 247 && b0 <= 250) return (b0 - 247)*256 + stbtt__buf_get8(b) + 108; else if (b0 >= 251 && b0 <= 254) return -(b0 - 251)*256 - stbtt__buf_get8(b) - 108; else if (b0 == 28) return stbtt__buf_get16(b); else if (b0 == 29) return stbtt__buf_get32(b); STBTT_assert(0); return 0; } static void stbtt__cff_skip_operand(stbtt__buf *b) { int v, b0 = stbtt__buf_peek8(b); STBTT_assert(b0 >= 28); if (b0 == 30) { stbtt__buf_skip(b, 1); while (b->cursor < b->size) { v = stbtt__buf_get8(b); if ((v & 0xF) == 0xF || (v >> 4) == 0xF) break; } } else { stbtt__cff_int(b); } } static stbtt__buf stbtt__dict_get(stbtt__buf *b, int key) { stbtt__buf_seek(b, 0); while (b->cursor < b->size) { int start = b->cursor, end, op; while (stbtt__buf_peek8(b) >= 28) stbtt__cff_skip_operand(b); end = b->cursor; op = stbtt__buf_get8(b); if (op == 12) op = stbtt__buf_get8(b) | 0x100; if (op == key) return stbtt__buf_range(b, start, end-start); } return stbtt__buf_range(b, 0, 0); } static void stbtt__dict_get_ints(stbtt__buf *b, int key, int outcount, stbtt_uint32 *out) { int i; stbtt__buf operands = stbtt__dict_get(b, key); for (i = 0; i < outcount && operands.cursor < operands.size; i++) out[i] = stbtt__cff_int(&operands); } static int stbtt__cff_index_count(stbtt__buf *b) { stbtt__buf_seek(b, 0); return stbtt__buf_get16(b); } static stbtt__buf stbtt__cff_index_get(stbtt__buf b, int i) { int count, offsize, start, end; stbtt__buf_seek(&b, 0); count = stbtt__buf_get16(&b); offsize = stbtt__buf_get8(&b); STBTT_assert(i >= 0 && i < count); STBTT_assert(offsize >= 1 && offsize <= 4); stbtt__buf_skip(&b, i*offsize); start = stbtt__buf_get(&b, offsize); end = stbtt__buf_get(&b, offsize); return stbtt__buf_range(&b, 2+(count+1)*offsize+start, end - start); } ////////////////////////////////////////////////////////////////////////// // // accessors to parse data from file // // on platforms that don't allow misaligned reads, if we want to allow // truetype fonts that aren't padded to alignment, define ALLOW_UNALIGNED_TRUETYPE #define ttBYTE(p) (* (stbtt_uint8 *) (p)) #define ttCHAR(p) (* (stbtt_int8 *) (p)) #define ttFixed(p) ttLONG(p) static stbtt_uint16 ttUSHORT(stbtt_uint8 *p) { return p[0]*256 + p[1]; } static stbtt_int16 ttSHORT(stbtt_uint8 *p) { return p[0]*256 + p[1]; } static stbtt_uint32 ttULONG(stbtt_uint8 *p) { return (p[0]<<24) + (p[1]<<16) + (p[2]<<8) + p[3]; } static stbtt_int32 ttLONG(stbtt_uint8 *p) { return (p[0]<<24) + (p[1]<<16) + (p[2]<<8) + p[3]; } #define stbtt_tag4(p,c0,c1,c2,c3) ((p)[0] == (c0) && (p)[1] == (c1) && (p)[2] == (c2) && (p)[3] == (c3)) #define stbtt_tag(p,str) stbtt_tag4(p,str[0],str[1],str[2],str[3]) static int stbtt__isfont(stbtt_uint8 *font) { // check the version number if (stbtt_tag4(font, '1',0,0,0)) return 1; // TrueType 1 if (stbtt_tag(font, "typ1")) return 1; // TrueType with type 1 font -- we don't support this! if (stbtt_tag(font, "OTTO")) return 1; // OpenType with CFF if (stbtt_tag4(font, 0,1,0,0)) return 1; // OpenType 1.0 if (stbtt_tag(font, "true")) return 1; // Apple specification for TrueType fonts return 0; } // @OPTIMIZE: binary search static stbtt_uint32 stbtt__find_table(stbtt_uint8 *data, stbtt_uint32 fontstart, const char *tag) { stbtt_int32 num_tables = ttUSHORT(data+fontstart+4); stbtt_uint32 tabledir = fontstart + 12; stbtt_int32 i; for (i=0; i < num_tables; ++i) { stbtt_uint32 loc = tabledir + 16*i; if (stbtt_tag(data+loc+0, tag)) return ttULONG(data+loc+8); } return 0; } static int stbtt_GetFontOffsetForIndex_internal(unsigned char *font_collection, int index) { // if it's just a font, there's only one valid index if (stbtt__isfont(font_collection)) return index == 0 ? 0 : -1; // check if it's a TTC if (stbtt_tag(font_collection, "ttcf")) { // version 1? if (ttULONG(font_collection+4) == 0x00010000 || ttULONG(font_collection+4) == 0x00020000) { stbtt_int32 n = ttLONG(font_collection+8); if (index >= n) return -1; return ttULONG(font_collection+12+index*4); } } return -1; } static int stbtt_GetNumberOfFonts_internal(unsigned char *font_collection) { // if it's just a font, there's only one valid font if (stbtt__isfont(font_collection)) return 1; // check if it's a TTC if (stbtt_tag(font_collection, "ttcf")) { // version 1? if (ttULONG(font_collection+4) == 0x00010000 || ttULONG(font_collection+4) == 0x00020000) { return ttLONG(font_collection+8); } } return 0; } static stbtt__buf stbtt__get_subrs(stbtt__buf cff, stbtt__buf fontdict) { stbtt_uint32 subrsoff = 0, private_loc[2] = { 0, 0 }; stbtt__buf pdict; stbtt__dict_get_ints(&fontdict, 18, 2, private_loc); if (!private_loc[1] || !private_loc[0]) return stbtt__new_buf(NULL, 0); pdict = stbtt__buf_range(&cff, private_loc[1], private_loc[0]); stbtt__dict_get_ints(&pdict, 19, 1, &subrsoff); if (!subrsoff) return stbtt__new_buf(NULL, 0); stbtt__buf_seek(&cff, private_loc[1]+subrsoff); return stbtt__cff_get_index(&cff); } // since most people won't use this, find this table the first time it's needed static int stbtt__get_svg(stbtt_fontinfo *info) { stbtt_uint32 t; if (info->svg < 0) { t = stbtt__find_table(info->data, info->fontstart, "SVG "); if (t) { stbtt_uint32 offset = ttULONG(info->data + t + 2); info->svg = t + offset; } else { info->svg = 0; } } return info->svg; } static int stbtt_InitFont_internal(stbtt_fontinfo *info, unsigned char *data, int fontstart) { stbtt_uint32 cmap, t; stbtt_int32 i,numTables; info->data = data; info->fontstart = fontstart; info->cff = stbtt__new_buf(NULL, 0); cmap = stbtt__find_table(data, fontstart, "cmap"); // required info->loca = stbtt__find_table(data, fontstart, "loca"); // required info->head = stbtt__find_table(data, fontstart, "head"); // required info->glyf = stbtt__find_table(data, fontstart, "glyf"); // required info->hhea = stbtt__find_table(data, fontstart, "hhea"); // required info->hmtx = stbtt__find_table(data, fontstart, "hmtx"); // required info->kern = stbtt__find_table(data, fontstart, "kern"); // not required info->gpos = stbtt__find_table(data, fontstart, "GPOS"); // not required if (!cmap || !info->head || !info->hhea || !info->hmtx) return 0; if (info->glyf) { // required for truetype if (!info->loca) return 0; } else { // initialization for CFF / Type2 fonts (OTF) stbtt__buf b, topdict, topdictidx; stbtt_uint32 cstype = 2, charstrings = 0, fdarrayoff = 0, fdselectoff = 0; stbtt_uint32 cff; cff = stbtt__find_table(data, fontstart, "CFF "); if (!cff) return 0; info->fontdicts = stbtt__new_buf(NULL, 0); info->fdselect = stbtt__new_buf(NULL, 0); // @TODO this should use size from table (not 512MB) info->cff = stbtt__new_buf(data+cff, 512*1024*1024); b = info->cff; // read the header stbtt__buf_skip(&b, 2); stbtt__buf_seek(&b, stbtt__buf_get8(&b)); // hdrsize // @TODO the name INDEX could list multiple fonts, // but we just use the first one. stbtt__cff_get_index(&b); // name INDEX topdictidx = stbtt__cff_get_index(&b); topdict = stbtt__cff_index_get(topdictidx, 0); stbtt__cff_get_index(&b); // string INDEX info->gsubrs = stbtt__cff_get_index(&b); stbtt__dict_get_ints(&topdict, 17, 1, &charstrings); stbtt__dict_get_ints(&topdict, 0x100 | 6, 1, &cstype); stbtt__dict_get_ints(&topdict, 0x100 | 36, 1, &fdarrayoff); stbtt__dict_get_ints(&topdict, 0x100 | 37, 1, &fdselectoff); info->subrs = stbtt__get_subrs(b, topdict); // we only support Type 2 charstrings if (cstype != 2) return 0; if (charstrings == 0) return 0; if (fdarrayoff) { // looks like a CID font if (!fdselectoff) return 0; stbtt__buf_seek(&b, fdarrayoff); info->fontdicts = stbtt__cff_get_index(&b); info->fdselect = stbtt__buf_range(&b, fdselectoff, b.size-fdselectoff); } stbtt__buf_seek(&b, charstrings); info->charstrings = stbtt__cff_get_index(&b); } t = stbtt__find_table(data, fontstart, "maxp"); if (t) info->numGlyphs = ttUSHORT(data+t+4); else info->numGlyphs = 0xffff; info->svg = -1; // find a cmap encoding table we understand *now* to avoid searching // later. (todo: could make this installable) // the same regardless of glyph. numTables = ttUSHORT(data + cmap + 2); info->index_map = 0; for (i=0; i < numTables; ++i) { stbtt_uint32 encoding_record = cmap + 4 + 8 * i; // find an encoding we understand: switch(ttUSHORT(data+encoding_record)) { case STBTT_PLATFORM_ID_MICROSOFT: switch (ttUSHORT(data+encoding_record+2)) { case STBTT_MS_EID_UNICODE_BMP: case STBTT_MS_EID_UNICODE_FULL: // MS/Unicode info->index_map = cmap + ttULONG(data+encoding_record+4); break; } break; case STBTT_PLATFORM_ID_UNICODE: // Mac/iOS has these // all the encodingIDs are unicode, so we don't bother to check it info->index_map = cmap + ttULONG(data+encoding_record+4); break; } } if (info->index_map == 0) return 0; info->indexToLocFormat = ttUSHORT(data+info->head + 50); return 1; } STBTT_DEF int stbtt_FindGlyphIndex(const stbtt_fontinfo *info, int unicode_codepoint) { stbtt_uint8 *data = info->data; stbtt_uint32 index_map = info->index_map; stbtt_uint16 format = ttUSHORT(data + index_map + 0); if (format == 0) { // apple byte encoding stbtt_int32 bytes = ttUSHORT(data + index_map + 2); if (unicode_codepoint < bytes-6) return ttBYTE(data + index_map + 6 + unicode_codepoint); return 0; } else if (format == 6) { stbtt_uint32 first = ttUSHORT(data + index_map + 6); stbtt_uint32 count = ttUSHORT(data + index_map + 8); if ((stbtt_uint32) unicode_codepoint >= first && (stbtt_uint32) unicode_codepoint < first+count) return ttUSHORT(data + index_map + 10 + (unicode_codepoint - first)*2); return 0; } else if (format == 2) { STBTT_assert(0); // @TODO: high-byte mapping for japanese/chinese/korean return 0; } else if (format == 4) { // standard mapping for windows fonts: binary search collection of ranges stbtt_uint16 segcount = ttUSHORT(data+index_map+6) >> 1; stbtt_uint16 searchRange = ttUSHORT(data+index_map+8) >> 1; stbtt_uint16 entrySelector = ttUSHORT(data+index_map+10); stbtt_uint16 rangeShift = ttUSHORT(data+index_map+12) >> 1; // do a binary search of the segments stbtt_uint32 endCount = index_map + 14; stbtt_uint32 search = endCount; if (unicode_codepoint > 0xffff) return 0; // they lie from endCount .. endCount + segCount // but searchRange is the nearest power of two, so... if (unicode_codepoint >= ttUSHORT(data + search + rangeShift*2)) search += rangeShift*2; // now decrement to bias correctly to find smallest search -= 2; while (entrySelector) { stbtt_uint16 end; searchRange >>= 1; end = ttUSHORT(data + search + searchRange*2); if (unicode_codepoint > end) search += searchRange*2; --entrySelector; } search += 2; { stbtt_uint16 offset, start, last; stbtt_uint16 item = (stbtt_uint16) ((search - endCount) >> 1); start = ttUSHORT(data + index_map + 14 + segcount*2 + 2 + 2*item); last = ttUSHORT(data + endCount + 2*item); if (unicode_codepoint < start || unicode_codepoint > last) return 0; offset = ttUSHORT(data + index_map + 14 + segcount*6 + 2 + 2*item); if (offset == 0) return (stbtt_uint16) (unicode_codepoint + ttSHORT(data + index_map + 14 + segcount*4 + 2 + 2*item)); return ttUSHORT(data + offset + (unicode_codepoint-start)*2 + index_map + 14 + segcount*6 + 2 + 2*item); } } else if (format == 12 || format == 13) { stbtt_uint32 ngroups = ttULONG(data+index_map+12); stbtt_int32 low,high; low = 0; high = (stbtt_int32)ngroups; // Binary search the right group. while (low < high) { stbtt_int32 mid = low + ((high-low) >> 1); // rounds down, so low <= mid < high stbtt_uint32 start_char = ttULONG(data+index_map+16+mid*12); stbtt_uint32 end_char = ttULONG(data+index_map+16+mid*12+4); if ((stbtt_uint32) unicode_codepoint < start_char) high = mid; else if ((stbtt_uint32) unicode_codepoint > end_char) low = mid+1; else { stbtt_uint32 start_glyph = ttULONG(data+index_map+16+mid*12+8); if (format == 12) return start_glyph + unicode_codepoint-start_char; else // format == 13 return start_glyph; } } return 0; // not found } // @TODO STBTT_assert(0); return 0; } STBTT_DEF int stbtt_GetCodepointShape(const stbtt_fontinfo *info, int unicode_codepoint, stbtt_vertex **vertices) { return stbtt_GetGlyphShape(info, stbtt_FindGlyphIndex(info, unicode_codepoint), vertices); } static void stbtt_setvertex(stbtt_vertex *v, stbtt_uint8 type, stbtt_int32 x, stbtt_int32 y, stbtt_int32 cx, stbtt_int32 cy) { v->type = type; v->x = (stbtt_int16) x; v->y = (stbtt_int16) y; v->cx = (stbtt_int16) cx; v->cy = (stbtt_int16) cy; } static int stbtt__GetGlyfOffset(const stbtt_fontinfo *info, int glyph_index) { int g1,g2; STBTT_assert(!info->cff.size); if (glyph_index >= info->numGlyphs) return -1; // glyph index out of range if (info->indexToLocFormat >= 2) return -1; // unknown index->glyph map format if (info->indexToLocFormat == 0) { g1 = info->glyf + ttUSHORT(info->data + info->loca + glyph_index * 2) * 2; g2 = info->glyf + ttUSHORT(info->data + info->loca + glyph_index * 2 + 2) * 2; } else { g1 = info->glyf + ttULONG (info->data + info->loca + glyph_index * 4); g2 = info->glyf + ttULONG (info->data + info->loca + glyph_index * 4 + 4); } return g1==g2 ? -1 : g1; // if length is 0, return -1 } static int stbtt__GetGlyphInfoT2(const stbtt_fontinfo *info, int glyph_index, int *x0, int *y0, int *x1, int *y1); STBTT_DEF int stbtt_GetGlyphBox(const stbtt_fontinfo *info, int glyph_index, int *x0, int *y0, int *x1, int *y1) { if (info->cff.size) { stbtt__GetGlyphInfoT2(info, glyph_index, x0, y0, x1, y1); } else { int g = stbtt__GetGlyfOffset(info, glyph_index); if (g < 0) return 0; if (x0) *x0 = ttSHORT(info->data + g + 2); if (y0) *y0 = ttSHORT(info->data + g + 4); if (x1) *x1 = ttSHORT(info->data + g + 6); if (y1) *y1 = ttSHORT(info->data + g + 8); } return 1; } STBTT_DEF int stbtt_GetCodepointBox(const stbtt_fontinfo *info, int codepoint, int *x0, int *y0, int *x1, int *y1) { return stbtt_GetGlyphBox(info, stbtt_FindGlyphIndex(info,codepoint), x0,y0,x1,y1); } STBTT_DEF int stbtt_IsGlyphEmpty(const stbtt_fontinfo *info, int glyph_index) { stbtt_int16 numberOfContours; int g; if (info->cff.size) return stbtt__GetGlyphInfoT2(info, glyph_index, NULL, NULL, NULL, NULL) == 0; g = stbtt__GetGlyfOffset(info, glyph_index); if (g < 0) return 1; numberOfContours = ttSHORT(info->data + g); return numberOfContours == 0; } static int stbtt__close_shape(stbtt_vertex *vertices, int num_vertices, int was_off, int start_off, stbtt_int32 sx, stbtt_int32 sy, stbtt_int32 scx, stbtt_int32 scy, stbtt_int32 cx, stbtt_int32 cy) { if (start_off) { if (was_off) stbtt_setvertex(&vertices[num_vertices++], STBTT_vcurve, (cx+scx)>>1, (cy+scy)>>1, cx,cy); stbtt_setvertex(&vertices[num_vertices++], STBTT_vcurve, sx,sy,scx,scy); } else { if (was_off) stbtt_setvertex(&vertices[num_vertices++], STBTT_vcurve,sx,sy,cx,cy); else stbtt_setvertex(&vertices[num_vertices++], STBTT_vline,sx,sy,0,0); } return num_vertices; } static int stbtt__GetGlyphShapeTT(const stbtt_fontinfo *info, int glyph_index, stbtt_vertex **pvertices) { stbtt_int16 numberOfContours; stbtt_uint8 *endPtsOfContours; stbtt_uint8 *data = info->data; stbtt_vertex *vertices=0; int num_vertices=0; int g = stbtt__GetGlyfOffset(info, glyph_index); *pvertices = NULL; if (g < 0) return 0; numberOfContours = ttSHORT(data + g); if (numberOfContours > 0) { stbtt_uint8 flags=0,flagcount; stbtt_int32 ins, i,j=0,m,n, next_move, was_off=0, off, start_off=0; stbtt_int32 x,y,cx,cy,sx,sy, scx,scy; stbtt_uint8 *points; endPtsOfContours = (data + g + 10); ins = ttUSHORT(data + g + 10 + numberOfContours * 2); points = data + g + 10 + numberOfContours * 2 + 2 + ins; n = 1+ttUSHORT(endPtsOfContours + numberOfContours*2-2); m = n + 2*numberOfContours; // a loose bound on how many vertices we might need vertices = (stbtt_vertex *) STBTT_malloc(m * sizeof(vertices[0]), info->userdata); if (vertices == 0) return 0; next_move = 0; flagcount=0; // in first pass, we load uninterpreted data into the allocated array // above, shifted to the end of the array so we won't overwrite it when // we create our final data starting from the front off = m - n; // starting offset for uninterpreted data, regardless of how m ends up being calculated // first load flags for (i=0; i < n; ++i) { if (flagcount == 0) { flags = *points++; if (flags & 8) flagcount = *points++; } else --flagcount; vertices[off+i].type = flags; } // now load x coordinates x=0; for (i=0; i < n; ++i) { flags = vertices[off+i].type; if (flags & 2) { stbtt_int16 dx = *points++; x += (flags & 16) ? dx : -dx; // ??? } else { if (!(flags & 16)) { x = x + (stbtt_int16) (points[0]*256 + points[1]); points += 2; } } vertices[off+i].x = (stbtt_int16) x; } // now load y coordinates y=0; for (i=0; i < n; ++i) { flags = vertices[off+i].type; if (flags & 4) { stbtt_int16 dy = *points++; y += (flags & 32) ? dy : -dy; // ??? } else { if (!(flags & 32)) { y = y + (stbtt_int16) (points[0]*256 + points[1]); points += 2; } } vertices[off+i].y = (stbtt_int16) y; } // now convert them to our format num_vertices=0; sx = sy = cx = cy = scx = scy = 0; for (i=0; i < n; ++i) { flags = vertices[off+i].type; x = (stbtt_int16) vertices[off+i].x; y = (stbtt_int16) vertices[off+i].y; if (next_move == i) { if (i != 0) num_vertices = stbtt__close_shape(vertices, num_vertices, was_off, start_off, sx,sy,scx,scy,cx,cy); // now start the new one start_off = !(flags & 1); if (start_off) { // if we start off with an off-curve point, then when we need to find a point on the curve // where we can start, and we need to save some state for when we wraparound. scx = x; scy = y; if (!(vertices[off+i+1].type & 1)) { // next point is also a curve point, so interpolate an on-point curve sx = (x + (stbtt_int32) vertices[off+i+1].x) >> 1; sy = (y + (stbtt_int32) vertices[off+i+1].y) >> 1; } else { // otherwise just use the next point as our start point sx = (stbtt_int32) vertices[off+i+1].x; sy = (stbtt_int32) vertices[off+i+1].y; ++i; // we're using point i+1 as the starting point, so skip it } } else { sx = x; sy = y; } stbtt_setvertex(&vertices[num_vertices++], STBTT_vmove,sx,sy,0,0); was_off = 0; next_move = 1 + ttUSHORT(endPtsOfContours+j*2); ++j; } else { if (!(flags & 1)) { // if it's a curve if (was_off) // two off-curve control points in a row means interpolate an on-curve midpoint stbtt_setvertex(&vertices[num_vertices++], STBTT_vcurve, (cx+x)>>1, (cy+y)>>1, cx, cy); cx = x; cy = y; was_off = 1; } else { if (was_off) stbtt_setvertex(&vertices[num_vertices++], STBTT_vcurve, x,y, cx, cy); else stbtt_setvertex(&vertices[num_vertices++], STBTT_vline, x,y,0,0); was_off = 0; } } } num_vertices = stbtt__close_shape(vertices, num_vertices, was_off, start_off, sx,sy,scx,scy,cx,cy); } else if (numberOfContours < 0) { // Compound shapes. int more = 1; stbtt_uint8 *comp = data + g + 10; num_vertices = 0; vertices = 0; while (more) { stbtt_uint16 flags, gidx; int comp_num_verts = 0, i; stbtt_vertex *comp_verts = 0, *tmp = 0; float mtx[6] = {1,0,0,1,0,0}, m, n; flags = ttSHORT(comp); comp+=2; gidx = ttSHORT(comp); comp+=2; if (flags & 2) { // XY values if (flags & 1) { // shorts mtx[4] = ttSHORT(comp); comp+=2; mtx[5] = ttSHORT(comp); comp+=2; } else { mtx[4] = ttCHAR(comp); comp+=1; mtx[5] = ttCHAR(comp); comp+=1; } } else { // @TODO handle matching point STBTT_assert(0); } if (flags & (1<<3)) { // WE_HAVE_A_SCALE mtx[0] = mtx[3] = ttSHORT(comp)/16384.0f; comp+=2; mtx[1] = mtx[2] = 0; } else if (flags & (1<<6)) { // WE_HAVE_AN_X_AND_YSCALE mtx[0] = ttSHORT(comp)/16384.0f; comp+=2; mtx[1] = mtx[2] = 0; mtx[3] = ttSHORT(comp)/16384.0f; comp+=2; } else if (flags & (1<<7)) { // WE_HAVE_A_TWO_BY_TWO mtx[0] = ttSHORT(comp)/16384.0f; comp+=2; mtx[1] = ttSHORT(comp)/16384.0f; comp+=2; mtx[2] = ttSHORT(comp)/16384.0f; comp+=2; mtx[3] = ttSHORT(comp)/16384.0f; comp+=2; } // Find transformation scales. m = (float) STBTT_sqrt(mtx[0]*mtx[0] + mtx[1]*mtx[1]); n = (float) STBTT_sqrt(mtx[2]*mtx[2] + mtx[3]*mtx[3]); // Get indexed glyph. comp_num_verts = stbtt_GetGlyphShape(info, gidx, &comp_verts); if (comp_num_verts > 0) { // Transform vertices. for (i = 0; i < comp_num_verts; ++i) { stbtt_vertex* v = &comp_verts[i]; stbtt_vertex_type x,y; x=v->x; y=v->y; v->x = (stbtt_vertex_type)(m * (mtx[0]*x + mtx[2]*y + mtx[4])); v->y = (stbtt_vertex_type)(n * (mtx[1]*x + mtx[3]*y + mtx[5])); x=v->cx; y=v->cy; v->cx = (stbtt_vertex_type)(m * (mtx[0]*x + mtx[2]*y + mtx[4])); v->cy = (stbtt_vertex_type)(n * (mtx[1]*x + mtx[3]*y + mtx[5])); } // Append vertices. tmp = (stbtt_vertex*)STBTT_malloc((num_vertices+comp_num_verts)*sizeof(stbtt_vertex), info->userdata); if (!tmp) { if (vertices) STBTT_free(vertices, info->userdata); if (comp_verts) STBTT_free(comp_verts, info->userdata); return 0; } if (num_vertices > 0 && vertices) STBTT_memcpy(tmp, vertices, num_vertices*sizeof(stbtt_vertex)); STBTT_memcpy(tmp+num_vertices, comp_verts, comp_num_verts*sizeof(stbtt_vertex)); if (vertices) STBTT_free(vertices, info->userdata); vertices = tmp; STBTT_free(comp_verts, info->userdata); num_vertices += comp_num_verts; } // More components ? more = flags & (1<<5); } } else { // numberOfCounters == 0, do nothing } *pvertices = vertices; return num_vertices; } typedef struct { int bounds; int started; float first_x, first_y; float x, y; stbtt_int32 min_x, max_x, min_y, max_y; stbtt_vertex *pvertices; int num_vertices; } stbtt__csctx; #define STBTT__CSCTX_INIT(bounds) {bounds,0, 0,0, 0,0, 0,0,0,0, NULL, 0} static void stbtt__track_vertex(stbtt__csctx *c, stbtt_int32 x, stbtt_int32 y) { if (x > c->max_x || !c->started) c->max_x = x; if (y > c->max_y || !c->started) c->max_y = y; if (x < c->min_x || !c->started) c->min_x = x; if (y < c->min_y || !c->started) c->min_y = y; c->started = 1; } static void stbtt__csctx_v(stbtt__csctx *c, stbtt_uint8 type, stbtt_int32 x, stbtt_int32 y, stbtt_int32 cx, stbtt_int32 cy, stbtt_int32 cx1, stbtt_int32 cy1) { if (c->bounds) { stbtt__track_vertex(c, x, y); if (type == STBTT_vcubic) { stbtt__track_vertex(c, cx, cy); stbtt__track_vertex(c, cx1, cy1); } } else { stbtt_setvertex(&c->pvertices[c->num_vertices], type, x, y, cx, cy); c->pvertices[c->num_vertices].cx1 = (stbtt_int16) cx1; c->pvertices[c->num_vertices].cy1 = (stbtt_int16) cy1; } c->num_vertices++; } static void stbtt__csctx_close_shape(stbtt__csctx *ctx) { if (ctx->first_x != ctx->x || ctx->first_y != ctx->y) stbtt__csctx_v(ctx, STBTT_vline, (int)ctx->first_x, (int)ctx->first_y, 0, 0, 0, 0); } static void stbtt__csctx_rmove_to(stbtt__csctx *ctx, float dx, float dy) { stbtt__csctx_close_shape(ctx); ctx->first_x = ctx->x = ctx->x + dx; ctx->first_y = ctx->y = ctx->y + dy; stbtt__csctx_v(ctx, STBTT_vmove, (int)ctx->x, (int)ctx->y, 0, 0, 0, 0); } static void stbtt__csctx_rline_to(stbtt__csctx *ctx, float dx, float dy) { ctx->x += dx; ctx->y += dy; stbtt__csctx_v(ctx, STBTT_vline, (int)ctx->x, (int)ctx->y, 0, 0, 0, 0); } static void stbtt__csctx_rccurve_to(stbtt__csctx *ctx, float dx1, float dy1, float dx2, float dy2, float dx3, float dy3) { float cx1 = ctx->x + dx1; float cy1 = ctx->y + dy1; float cx2 = cx1 + dx2; float cy2 = cy1 + dy2; ctx->x = cx2 + dx3; ctx->y = cy2 + dy3; stbtt__csctx_v(ctx, STBTT_vcubic, (int)ctx->x, (int)ctx->y, (int)cx1, (int)cy1, (int)cx2, (int)cy2); } static stbtt__buf stbtt__get_subr(stbtt__buf idx, int n) { int count = stbtt__cff_index_count(&idx); int bias = 107; if (count >= 33900) bias = 32768; else if (count >= 1240) bias = 1131; n += bias; if (n < 0 || n >= count) return stbtt__new_buf(NULL, 0); return stbtt__cff_index_get(idx, n); } static stbtt__buf stbtt__cid_get_glyph_subrs(const stbtt_fontinfo *info, int glyph_index) { stbtt__buf fdselect = info->fdselect; int nranges, start, end, v, fmt, fdselector = -1, i; stbtt__buf_seek(&fdselect, 0); fmt = stbtt__buf_get8(&fdselect); if (fmt == 0) { // untested stbtt__buf_skip(&fdselect, glyph_index); fdselector = stbtt__buf_get8(&fdselect); } else if (fmt == 3) { nranges = stbtt__buf_get16(&fdselect); start = stbtt__buf_get16(&fdselect); for (i = 0; i < nranges; i++) { v = stbtt__buf_get8(&fdselect); end = stbtt__buf_get16(&fdselect); if (glyph_index >= start && glyph_index < end) { fdselector = v; break; } start = end; } } if (fdselector == -1) return stbtt__new_buf(NULL, 0); // [DEAR IMGUI] fixed, see #6007 and nothings/stb#1422 return stbtt__get_subrs(info->cff, stbtt__cff_index_get(info->fontdicts, fdselector)); } static int stbtt__run_charstring(const stbtt_fontinfo *info, int glyph_index, stbtt__csctx *c) { int in_header = 1, maskbits = 0, subr_stack_height = 0, sp = 0, v, i, b0; int has_subrs = 0, clear_stack; float s[48]; stbtt__buf subr_stack[10], subrs = info->subrs, b; float f; #define STBTT__CSERR(s) (0) // this currently ignores the initial width value, which isn't needed if we have hmtx b = stbtt__cff_index_get(info->charstrings, glyph_index); while (b.cursor < b.size) { i = 0; clear_stack = 1; b0 = stbtt__buf_get8(&b); switch (b0) { // @TODO implement hinting case 0x13: // hintmask case 0x14: // cntrmask if (in_header) maskbits += (sp / 2); // implicit "vstem" in_header = 0; stbtt__buf_skip(&b, (maskbits + 7) / 8); break; case 0x01: // hstem case 0x03: // vstem case 0x12: // hstemhm case 0x17: // vstemhm maskbits += (sp / 2); break; case 0x15: // rmoveto in_header = 0; if (sp < 2) return STBTT__CSERR("rmoveto stack"); stbtt__csctx_rmove_to(c, s[sp-2], s[sp-1]); break; case 0x04: // vmoveto in_header = 0; if (sp < 1) return STBTT__CSERR("vmoveto stack"); stbtt__csctx_rmove_to(c, 0, s[sp-1]); break; case 0x16: // hmoveto in_header = 0; if (sp < 1) return STBTT__CSERR("hmoveto stack"); stbtt__csctx_rmove_to(c, s[sp-1], 0); break; case 0x05: // rlineto if (sp < 2) return STBTT__CSERR("rlineto stack"); for (; i + 1 < sp; i += 2) stbtt__csctx_rline_to(c, s[i], s[i+1]); break; // hlineto/vlineto and vhcurveto/hvcurveto alternate horizontal and vertical // starting from a different place. case 0x07: // vlineto if (sp < 1) return STBTT__CSERR("vlineto stack"); goto vlineto; case 0x06: // hlineto if (sp < 1) return STBTT__CSERR("hlineto stack"); for (;;) { if (i >= sp) break; stbtt__csctx_rline_to(c, s[i], 0); i++; vlineto: if (i >= sp) break; stbtt__csctx_rline_to(c, 0, s[i]); i++; } break; case 0x1F: // hvcurveto if (sp < 4) return STBTT__CSERR("hvcurveto stack"); goto hvcurveto; case 0x1E: // vhcurveto if (sp < 4) return STBTT__CSERR("vhcurveto stack"); for (;;) { if (i + 3 >= sp) break; stbtt__csctx_rccurve_to(c, 0, s[i], s[i+1], s[i+2], s[i+3], (sp - i == 5) ? s[i + 4] : 0.0f); i += 4; hvcurveto: if (i + 3 >= sp) break; stbtt__csctx_rccurve_to(c, s[i], 0, s[i+1], s[i+2], (sp - i == 5) ? s[i+4] : 0.0f, s[i+3]); i += 4; } break; case 0x08: // rrcurveto if (sp < 6) return STBTT__CSERR("rcurveline stack"); for (; i + 5 < sp; i += 6) stbtt__csctx_rccurve_to(c, s[i], s[i+1], s[i+2], s[i+3], s[i+4], s[i+5]); break; case 0x18: // rcurveline if (sp < 8) return STBTT__CSERR("rcurveline stack"); for (; i + 5 < sp - 2; i += 6) stbtt__csctx_rccurve_to(c, s[i], s[i+1], s[i+2], s[i+3], s[i+4], s[i+5]); if (i + 1 >= sp) return STBTT__CSERR("rcurveline stack"); stbtt__csctx_rline_to(c, s[i], s[i+1]); break; case 0x19: // rlinecurve if (sp < 8) return STBTT__CSERR("rlinecurve stack"); for (; i + 1 < sp - 6; i += 2) stbtt__csctx_rline_to(c, s[i], s[i+1]); if (i + 5 >= sp) return STBTT__CSERR("rlinecurve stack"); stbtt__csctx_rccurve_to(c, s[i], s[i+1], s[i+2], s[i+3], s[i+4], s[i+5]); break; case 0x1A: // vvcurveto case 0x1B: // hhcurveto if (sp < 4) return STBTT__CSERR("(vv|hh)curveto stack"); f = 0.0; if (sp & 1) { f = s[i]; i++; } for (; i + 3 < sp; i += 4) { if (b0 == 0x1B) stbtt__csctx_rccurve_to(c, s[i], f, s[i+1], s[i+2], s[i+3], 0.0); else stbtt__csctx_rccurve_to(c, f, s[i], s[i+1], s[i+2], 0.0, s[i+3]); f = 0.0; } break; case 0x0A: // callsubr if (!has_subrs) { if (info->fdselect.size) subrs = stbtt__cid_get_glyph_subrs(info, glyph_index); has_subrs = 1; } // FALLTHROUGH case 0x1D: // callgsubr if (sp < 1) return STBTT__CSERR("call(g|)subr stack"); v = (int) s[--sp]; if (subr_stack_height >= 10) return STBTT__CSERR("recursion limit"); subr_stack[subr_stack_height++] = b; b = stbtt__get_subr(b0 == 0x0A ? subrs : info->gsubrs, v); if (b.size == 0) return STBTT__CSERR("subr not found"); b.cursor = 0; clear_stack = 0; break; case 0x0B: // return if (subr_stack_height <= 0) return STBTT__CSERR("return outside subr"); b = subr_stack[--subr_stack_height]; clear_stack = 0; break; case 0x0E: // endchar stbtt__csctx_close_shape(c); return 1; case 0x0C: { // two-byte escape float dx1, dx2, dx3, dx4, dx5, dx6, dy1, dy2, dy3, dy4, dy5, dy6; float dx, dy; int b1 = stbtt__buf_get8(&b); switch (b1) { // @TODO These "flex" implementations ignore the flex-depth and resolution, // and always draw beziers. case 0x22: // hflex if (sp < 7) return STBTT__CSERR("hflex stack"); dx1 = s[0]; dx2 = s[1]; dy2 = s[2]; dx3 = s[3]; dx4 = s[4]; dx5 = s[5]; dx6 = s[6]; stbtt__csctx_rccurve_to(c, dx1, 0, dx2, dy2, dx3, 0); stbtt__csctx_rccurve_to(c, dx4, 0, dx5, -dy2, dx6, 0); break; case 0x23: // flex if (sp < 13) return STBTT__CSERR("flex stack"); dx1 = s[0]; dy1 = s[1]; dx2 = s[2]; dy2 = s[3]; dx3 = s[4]; dy3 = s[5]; dx4 = s[6]; dy4 = s[7]; dx5 = s[8]; dy5 = s[9]; dx6 = s[10]; dy6 = s[11]; //fd is s[12] stbtt__csctx_rccurve_to(c, dx1, dy1, dx2, dy2, dx3, dy3); stbtt__csctx_rccurve_to(c, dx4, dy4, dx5, dy5, dx6, dy6); break; case 0x24: // hflex1 if (sp < 9) return STBTT__CSERR("hflex1 stack"); dx1 = s[0]; dy1 = s[1]; dx2 = s[2]; dy2 = s[3]; dx3 = s[4]; dx4 = s[5]; dx5 = s[6]; dy5 = s[7]; dx6 = s[8]; stbtt__csctx_rccurve_to(c, dx1, dy1, dx2, dy2, dx3, 0); stbtt__csctx_rccurve_to(c, dx4, 0, dx5, dy5, dx6, -(dy1+dy2+dy5)); break; case 0x25: // flex1 if (sp < 11) return STBTT__CSERR("flex1 stack"); dx1 = s[0]; dy1 = s[1]; dx2 = s[2]; dy2 = s[3]; dx3 = s[4]; dy3 = s[5]; dx4 = s[6]; dy4 = s[7]; dx5 = s[8]; dy5 = s[9]; dx6 = dy6 = s[10]; dx = dx1+dx2+dx3+dx4+dx5; dy = dy1+dy2+dy3+dy4+dy5; if (STBTT_fabs(dx) > STBTT_fabs(dy)) dy6 = -dy; else dx6 = -dx; stbtt__csctx_rccurve_to(c, dx1, dy1, dx2, dy2, dx3, dy3); stbtt__csctx_rccurve_to(c, dx4, dy4, dx5, dy5, dx6, dy6); break; default: return STBTT__CSERR("unimplemented"); } } break; default: if (b0 != 255 && b0 != 28 && b0 < 32) return STBTT__CSERR("reserved operator"); // push immediate if (b0 == 255) { f = (float)(stbtt_int32)stbtt__buf_get32(&b) / 0x10000; } else { stbtt__buf_skip(&b, -1); f = (float)(stbtt_int16)stbtt__cff_int(&b); } if (sp >= 48) return STBTT__CSERR("push stack overflow"); s[sp++] = f; clear_stack = 0; break; } if (clear_stack) sp = 0; } return STBTT__CSERR("no endchar"); #undef STBTT__CSERR } static int stbtt__GetGlyphShapeT2(const stbtt_fontinfo *info, int glyph_index, stbtt_vertex **pvertices) { // runs the charstring twice, once to count and once to output (to avoid realloc) stbtt__csctx count_ctx = STBTT__CSCTX_INIT(1); stbtt__csctx output_ctx = STBTT__CSCTX_INIT(0); if (stbtt__run_charstring(info, glyph_index, &count_ctx)) { *pvertices = (stbtt_vertex*)STBTT_malloc(count_ctx.num_vertices*sizeof(stbtt_vertex), info->userdata); output_ctx.pvertices = *pvertices; if (stbtt__run_charstring(info, glyph_index, &output_ctx)) { STBTT_assert(output_ctx.num_vertices == count_ctx.num_vertices); return output_ctx.num_vertices; } } *pvertices = NULL; return 0; } static int stbtt__GetGlyphInfoT2(const stbtt_fontinfo *info, int glyph_index, int *x0, int *y0, int *x1, int *y1) { stbtt__csctx c = STBTT__CSCTX_INIT(1); int r = stbtt__run_charstring(info, glyph_index, &c); if (x0) *x0 = r ? c.min_x : 0; if (y0) *y0 = r ? c.min_y : 0; if (x1) *x1 = r ? c.max_x : 0; if (y1) *y1 = r ? c.max_y : 0; return r ? c.num_vertices : 0; } STBTT_DEF int stbtt_GetGlyphShape(const stbtt_fontinfo *info, int glyph_index, stbtt_vertex **pvertices) { if (!info->cff.size) return stbtt__GetGlyphShapeTT(info, glyph_index, pvertices); else return stbtt__GetGlyphShapeT2(info, glyph_index, pvertices); } STBTT_DEF void stbtt_GetGlyphHMetrics(const stbtt_fontinfo *info, int glyph_index, int *advanceWidth, int *leftSideBearing) { stbtt_uint16 numOfLongHorMetrics = ttUSHORT(info->data+info->hhea + 34); if (glyph_index < numOfLongHorMetrics) { if (advanceWidth) *advanceWidth = ttSHORT(info->data + info->hmtx + 4*glyph_index); if (leftSideBearing) *leftSideBearing = ttSHORT(info->data + info->hmtx + 4*glyph_index + 2); } else { if (advanceWidth) *advanceWidth = ttSHORT(info->data + info->hmtx + 4*(numOfLongHorMetrics-1)); if (leftSideBearing) *leftSideBearing = ttSHORT(info->data + info->hmtx + 4*numOfLongHorMetrics + 2*(glyph_index - numOfLongHorMetrics)); } } STBTT_DEF int stbtt_GetKerningTableLength(const stbtt_fontinfo *info) { stbtt_uint8 *data = info->data + info->kern; // we only look at the first table. it must be 'horizontal' and format 0. if (!info->kern) return 0; if (ttUSHORT(data+2) < 1) // number of tables, need at least 1 return 0; if (ttUSHORT(data+8) != 1) // horizontal flag must be set in format return 0; return ttUSHORT(data+10); } STBTT_DEF int stbtt_GetKerningTable(const stbtt_fontinfo *info, stbtt_kerningentry* table, int table_length) { stbtt_uint8 *data = info->data + info->kern; int k, length; // we only look at the first table. it must be 'horizontal' and format 0. if (!info->kern) return 0; if (ttUSHORT(data+2) < 1) // number of tables, need at least 1 return 0; if (ttUSHORT(data+8) != 1) // horizontal flag must be set in format return 0; length = ttUSHORT(data+10); if (table_length < length) length = table_length; for (k = 0; k < length; k++) { table[k].glyph1 = ttUSHORT(data+18+(k*6)); table[k].glyph2 = ttUSHORT(data+20+(k*6)); table[k].advance = ttSHORT(data+22+(k*6)); } return length; } static int stbtt__GetGlyphKernInfoAdvance(const stbtt_fontinfo *info, int glyph1, int glyph2) { stbtt_uint8 *data = info->data + info->kern; stbtt_uint32 needle, straw; int l, r, m; // we only look at the first table. it must be 'horizontal' and format 0. if (!info->kern) return 0; if (ttUSHORT(data+2) < 1) // number of tables, need at least 1 return 0; if (ttUSHORT(data+8) != 1) // horizontal flag must be set in format return 0; l = 0; r = ttUSHORT(data+10) - 1; needle = glyph1 << 16 | glyph2; while (l <= r) { m = (l + r) >> 1; straw = ttULONG(data+18+(m*6)); // note: unaligned read if (needle < straw) r = m - 1; else if (needle > straw) l = m + 1; else return ttSHORT(data+22+(m*6)); } return 0; } static stbtt_int32 stbtt__GetCoverageIndex(stbtt_uint8 *coverageTable, int glyph) { stbtt_uint16 coverageFormat = ttUSHORT(coverageTable); switch (coverageFormat) { case 1: { stbtt_uint16 glyphCount = ttUSHORT(coverageTable + 2); // Binary search. stbtt_int32 l=0, r=glyphCount-1, m; int straw, needle=glyph; while (l <= r) { stbtt_uint8 *glyphArray = coverageTable + 4; stbtt_uint16 glyphID; m = (l + r) >> 1; glyphID = ttUSHORT(glyphArray + 2 * m); straw = glyphID; if (needle < straw) r = m - 1; else if (needle > straw) l = m + 1; else { return m; } } break; } case 2: { stbtt_uint16 rangeCount = ttUSHORT(coverageTable + 2); stbtt_uint8 *rangeArray = coverageTable + 4; // Binary search. stbtt_int32 l=0, r=rangeCount-1, m; int strawStart, strawEnd, needle=glyph; while (l <= r) { stbtt_uint8 *rangeRecord; m = (l + r) >> 1; rangeRecord = rangeArray + 6 * m; strawStart = ttUSHORT(rangeRecord); strawEnd = ttUSHORT(rangeRecord + 2); if (needle < strawStart) r = m - 1; else if (needle > strawEnd) l = m + 1; else { stbtt_uint16 startCoverageIndex = ttUSHORT(rangeRecord + 4); return startCoverageIndex + glyph - strawStart; } } break; } default: return -1; // unsupported } return -1; } static stbtt_int32 stbtt__GetGlyphClass(stbtt_uint8 *classDefTable, int glyph) { stbtt_uint16 classDefFormat = ttUSHORT(classDefTable); switch (classDefFormat) { case 1: { stbtt_uint16 startGlyphID = ttUSHORT(classDefTable + 2); stbtt_uint16 glyphCount = ttUSHORT(classDefTable + 4); stbtt_uint8 *classDef1ValueArray = classDefTable + 6; if (glyph >= startGlyphID && glyph < startGlyphID + glyphCount) return (stbtt_int32)ttUSHORT(classDef1ValueArray + 2 * (glyph - startGlyphID)); break; } case 2: { stbtt_uint16 classRangeCount = ttUSHORT(classDefTable + 2); stbtt_uint8 *classRangeRecords = classDefTable + 4; // Binary search. stbtt_int32 l=0, r=classRangeCount-1, m; int strawStart, strawEnd, needle=glyph; while (l <= r) { stbtt_uint8 *classRangeRecord; m = (l + r) >> 1; classRangeRecord = classRangeRecords + 6 * m; strawStart = ttUSHORT(classRangeRecord); strawEnd = ttUSHORT(classRangeRecord + 2); if (needle < strawStart) r = m - 1; else if (needle > strawEnd) l = m + 1; else return (stbtt_int32)ttUSHORT(classRangeRecord + 4); } break; } default: return -1; // Unsupported definition type, return an error. } // "All glyphs not assigned to a class fall into class 0". (OpenType spec) return 0; } // Define to STBTT_assert(x) if you want to break on unimplemented formats. #define STBTT_GPOS_TODO_assert(x) static stbtt_int32 stbtt__GetGlyphGPOSInfoAdvance(const stbtt_fontinfo *info, int glyph1, int glyph2) { stbtt_uint16 lookupListOffset; stbtt_uint8 *lookupList; stbtt_uint16 lookupCount; stbtt_uint8 *data; stbtt_int32 i, sti; if (!info->gpos) return 0; data = info->data + info->gpos; if (ttUSHORT(data+0) != 1) return 0; // Major version 1 if (ttUSHORT(data+2) != 0) return 0; // Minor version 0 lookupListOffset = ttUSHORT(data+8); lookupList = data + lookupListOffset; lookupCount = ttUSHORT(lookupList); for (i=0; i= pairSetCount) return 0; needle=glyph2; r=pairValueCount-1; l=0; // Binary search. while (l <= r) { stbtt_uint16 secondGlyph; stbtt_uint8 *pairValue; m = (l + r) >> 1; pairValue = pairValueArray + (2 + valueRecordPairSizeInBytes) * m; secondGlyph = ttUSHORT(pairValue); straw = secondGlyph; if (needle < straw) r = m - 1; else if (needle > straw) l = m + 1; else { stbtt_int16 xAdvance = ttSHORT(pairValue + 2); return xAdvance; } } } else return 0; break; } case 2: { stbtt_uint16 valueFormat1 = ttUSHORT(table + 4); stbtt_uint16 valueFormat2 = ttUSHORT(table + 6); if (valueFormat1 == 4 && valueFormat2 == 0) { // Support more formats? stbtt_uint16 classDef1Offset = ttUSHORT(table + 8); stbtt_uint16 classDef2Offset = ttUSHORT(table + 10); int glyph1class = stbtt__GetGlyphClass(table + classDef1Offset, glyph1); int glyph2class = stbtt__GetGlyphClass(table + classDef2Offset, glyph2); stbtt_uint16 class1Count = ttUSHORT(table + 12); stbtt_uint16 class2Count = ttUSHORT(table + 14); stbtt_uint8 *class1Records, *class2Records; stbtt_int16 xAdvance; if (glyph1class < 0 || glyph1class >= class1Count) return 0; // malformed if (glyph2class < 0 || glyph2class >= class2Count) return 0; // malformed class1Records = table + 16; class2Records = class1Records + 2 * (glyph1class * class2Count); xAdvance = ttSHORT(class2Records + 2 * glyph2class); return xAdvance; } else return 0; break; } default: return 0; // Unsupported position format } } } return 0; } STBTT_DEF int stbtt_GetGlyphKernAdvance(const stbtt_fontinfo *info, int g1, int g2) { int xAdvance = 0; if (info->gpos) xAdvance += stbtt__GetGlyphGPOSInfoAdvance(info, g1, g2); else if (info->kern) xAdvance += stbtt__GetGlyphKernInfoAdvance(info, g1, g2); return xAdvance; } STBTT_DEF int stbtt_GetCodepointKernAdvance(const stbtt_fontinfo *info, int ch1, int ch2) { if (!info->kern && !info->gpos) // if no kerning table, don't waste time looking up both codepoint->glyphs return 0; return stbtt_GetGlyphKernAdvance(info, stbtt_FindGlyphIndex(info,ch1), stbtt_FindGlyphIndex(info,ch2)); } STBTT_DEF void stbtt_GetCodepointHMetrics(const stbtt_fontinfo *info, int codepoint, int *advanceWidth, int *leftSideBearing) { stbtt_GetGlyphHMetrics(info, stbtt_FindGlyphIndex(info,codepoint), advanceWidth, leftSideBearing); } STBTT_DEF void stbtt_GetFontVMetrics(const stbtt_fontinfo *info, int *ascent, int *descent, int *lineGap) { if (ascent ) *ascent = ttSHORT(info->data+info->hhea + 4); if (descent) *descent = ttSHORT(info->data+info->hhea + 6); if (lineGap) *lineGap = ttSHORT(info->data+info->hhea + 8); } STBTT_DEF int stbtt_GetFontVMetricsOS2(const stbtt_fontinfo *info, int *typoAscent, int *typoDescent, int *typoLineGap) { int tab = stbtt__find_table(info->data, info->fontstart, "OS/2"); if (!tab) return 0; if (typoAscent ) *typoAscent = ttSHORT(info->data+tab + 68); if (typoDescent) *typoDescent = ttSHORT(info->data+tab + 70); if (typoLineGap) *typoLineGap = ttSHORT(info->data+tab + 72); return 1; } STBTT_DEF void stbtt_GetFontBoundingBox(const stbtt_fontinfo *info, int *x0, int *y0, int *x1, int *y1) { *x0 = ttSHORT(info->data + info->head + 36); *y0 = ttSHORT(info->data + info->head + 38); *x1 = ttSHORT(info->data + info->head + 40); *y1 = ttSHORT(info->data + info->head + 42); } STBTT_DEF float stbtt_ScaleForPixelHeight(const stbtt_fontinfo *info, float height) { int fheight = ttSHORT(info->data + info->hhea + 4) - ttSHORT(info->data + info->hhea + 6); return (float) height / fheight; } STBTT_DEF float stbtt_ScaleForMappingEmToPixels(const stbtt_fontinfo *info, float pixels) { int unitsPerEm = ttUSHORT(info->data + info->head + 18); return pixels / unitsPerEm; } STBTT_DEF void stbtt_FreeShape(const stbtt_fontinfo *info, stbtt_vertex *v) { STBTT_free(v, info->userdata); } STBTT_DEF stbtt_uint8 *stbtt_FindSVGDoc(const stbtt_fontinfo *info, int gl) { int i; stbtt_uint8 *data = info->data; stbtt_uint8 *svg_doc_list = data + stbtt__get_svg((stbtt_fontinfo *) info); int numEntries = ttUSHORT(svg_doc_list); stbtt_uint8 *svg_docs = svg_doc_list + 2; for(i=0; i= ttUSHORT(svg_doc)) && (gl <= ttUSHORT(svg_doc + 2))) return svg_doc; } return 0; } STBTT_DEF int stbtt_GetGlyphSVG(const stbtt_fontinfo *info, int gl, const char **svg) { stbtt_uint8 *data = info->data; stbtt_uint8 *svg_doc; if (info->svg == 0) return 0; svg_doc = stbtt_FindSVGDoc(info, gl); if (svg_doc != NULL) { *svg = (char *) data + info->svg + ttULONG(svg_doc + 4); return ttULONG(svg_doc + 8); } else { return 0; } } STBTT_DEF int stbtt_GetCodepointSVG(const stbtt_fontinfo *info, int unicode_codepoint, const char **svg) { return stbtt_GetGlyphSVG(info, stbtt_FindGlyphIndex(info, unicode_codepoint), svg); } ////////////////////////////////////////////////////////////////////////////// // // antialiasing software rasterizer // STBTT_DEF void stbtt_GetGlyphBitmapBoxSubpixel(const stbtt_fontinfo *font, int glyph, float scale_x, float scale_y,float shift_x, float shift_y, int *ix0, int *iy0, int *ix1, int *iy1) { int x0=0,y0=0,x1,y1; // =0 suppresses compiler warning if (!stbtt_GetGlyphBox(font, glyph, &x0,&y0,&x1,&y1)) { // e.g. space character if (ix0) *ix0 = 0; if (iy0) *iy0 = 0; if (ix1) *ix1 = 0; if (iy1) *iy1 = 0; } else { // move to integral bboxes (treating pixels as little squares, what pixels get touched)? if (ix0) *ix0 = STBTT_ifloor( x0 * scale_x + shift_x); if (iy0) *iy0 = STBTT_ifloor(-y1 * scale_y + shift_y); if (ix1) *ix1 = STBTT_iceil ( x1 * scale_x + shift_x); if (iy1) *iy1 = STBTT_iceil (-y0 * scale_y + shift_y); } } STBTT_DEF void stbtt_GetGlyphBitmapBox(const stbtt_fontinfo *font, int glyph, float scale_x, float scale_y, int *ix0, int *iy0, int *ix1, int *iy1) { stbtt_GetGlyphBitmapBoxSubpixel(font, glyph, scale_x, scale_y,0.0f,0.0f, ix0, iy0, ix1, iy1); } STBTT_DEF void stbtt_GetCodepointBitmapBoxSubpixel(const stbtt_fontinfo *font, int codepoint, float scale_x, float scale_y, float shift_x, float shift_y, int *ix0, int *iy0, int *ix1, int *iy1) { stbtt_GetGlyphBitmapBoxSubpixel(font, stbtt_FindGlyphIndex(font,codepoint), scale_x, scale_y,shift_x,shift_y, ix0,iy0,ix1,iy1); } STBTT_DEF void stbtt_GetCodepointBitmapBox(const stbtt_fontinfo *font, int codepoint, float scale_x, float scale_y, int *ix0, int *iy0, int *ix1, int *iy1) { stbtt_GetCodepointBitmapBoxSubpixel(font, codepoint, scale_x, scale_y,0.0f,0.0f, ix0,iy0,ix1,iy1); } ////////////////////////////////////////////////////////////////////////////// // // Rasterizer typedef struct stbtt__hheap_chunk { struct stbtt__hheap_chunk *next; } stbtt__hheap_chunk; typedef struct stbtt__hheap { struct stbtt__hheap_chunk *head; void *first_free; int num_remaining_in_head_chunk; } stbtt__hheap; static void *stbtt__hheap_alloc(stbtt__hheap *hh, size_t size, void *userdata) { if (hh->first_free) { void *p = hh->first_free; hh->first_free = * (void **) p; return p; } else { if (hh->num_remaining_in_head_chunk == 0) { int count = (size < 32 ? 2000 : size < 128 ? 800 : 100); stbtt__hheap_chunk *c = (stbtt__hheap_chunk *) STBTT_malloc(sizeof(stbtt__hheap_chunk) + size * count, userdata); if (c == NULL) return NULL; c->next = hh->head; hh->head = c; hh->num_remaining_in_head_chunk = count; } --hh->num_remaining_in_head_chunk; return (char *) (hh->head) + sizeof(stbtt__hheap_chunk) + size * hh->num_remaining_in_head_chunk; } } static void stbtt__hheap_free(stbtt__hheap *hh, void *p) { *(void **) p = hh->first_free; hh->first_free = p; } static void stbtt__hheap_cleanup(stbtt__hheap *hh, void *userdata) { stbtt__hheap_chunk *c = hh->head; while (c) { stbtt__hheap_chunk *n = c->next; STBTT_free(c, userdata); c = n; } } typedef struct stbtt__edge { float x0,y0, x1,y1; int invert; } stbtt__edge; typedef struct stbtt__active_edge { struct stbtt__active_edge *next; #if STBTT_RASTERIZER_VERSION==1 int x,dx; float ey; int direction; #elif STBTT_RASTERIZER_VERSION==2 float fx,fdx,fdy; float direction; float sy; float ey; #else #error "Unrecognized value of STBTT_RASTERIZER_VERSION" #endif } stbtt__active_edge; #if STBTT_RASTERIZER_VERSION == 1 #define STBTT_FIXSHIFT 10 #define STBTT_FIX (1 << STBTT_FIXSHIFT) #define STBTT_FIXMASK (STBTT_FIX-1) static stbtt__active_edge *stbtt__new_active(stbtt__hheap *hh, stbtt__edge *e, int off_x, float start_point, void *userdata) { stbtt__active_edge *z = (stbtt__active_edge *) stbtt__hheap_alloc(hh, sizeof(*z), userdata); float dxdy = (e->x1 - e->x0) / (e->y1 - e->y0); STBTT_assert(z != NULL); if (!z) return z; // round dx down to avoid overshooting if (dxdy < 0) z->dx = -STBTT_ifloor(STBTT_FIX * -dxdy); else z->dx = STBTT_ifloor(STBTT_FIX * dxdy); z->x = STBTT_ifloor(STBTT_FIX * e->x0 + z->dx * (start_point - e->y0)); // use z->dx so when we offset later it's by the same amount z->x -= off_x * STBTT_FIX; z->ey = e->y1; z->next = 0; z->direction = e->invert ? 1 : -1; return z; } #elif STBTT_RASTERIZER_VERSION == 2 static stbtt__active_edge *stbtt__new_active(stbtt__hheap *hh, stbtt__edge *e, int off_x, float start_point, void *userdata) { stbtt__active_edge *z = (stbtt__active_edge *) stbtt__hheap_alloc(hh, sizeof(*z), userdata); float dxdy = (e->x1 - e->x0) / (e->y1 - e->y0); STBTT_assert(z != NULL); //STBTT_assert(e->y0 <= start_point); if (!z) return z; z->fdx = dxdy; z->fdy = dxdy != 0.0f ? (1.0f/dxdy) : 0.0f; z->fx = e->x0 + dxdy * (start_point - e->y0); z->fx -= off_x; z->direction = e->invert ? 1.0f : -1.0f; z->sy = e->y0; z->ey = e->y1; z->next = 0; return z; } #else #error "Unrecognized value of STBTT_RASTERIZER_VERSION" #endif #if STBTT_RASTERIZER_VERSION == 1 // note: this routine clips fills that extend off the edges... ideally this // wouldn't happen, but it could happen if the truetype glyph bounding boxes // are wrong, or if the user supplies a too-small bitmap static void stbtt__fill_active_edges(unsigned char *scanline, int len, stbtt__active_edge *e, int max_weight) { // non-zero winding fill int x0=0, w=0; while (e) { if (w == 0) { // if we're currently at zero, we need to record the edge start point x0 = e->x; w += e->direction; } else { int x1 = e->x; w += e->direction; // if we went to zero, we need to draw if (w == 0) { int i = x0 >> STBTT_FIXSHIFT; int j = x1 >> STBTT_FIXSHIFT; if (i < len && j >= 0) { if (i == j) { // x0,x1 are the same pixel, so compute combined coverage scanline[i] = scanline[i] + (stbtt_uint8) ((x1 - x0) * max_weight >> STBTT_FIXSHIFT); } else { if (i >= 0) // add antialiasing for x0 scanline[i] = scanline[i] + (stbtt_uint8) (((STBTT_FIX - (x0 & STBTT_FIXMASK)) * max_weight) >> STBTT_FIXSHIFT); else i = -1; // clip if (j < len) // add antialiasing for x1 scanline[j] = scanline[j] + (stbtt_uint8) (((x1 & STBTT_FIXMASK) * max_weight) >> STBTT_FIXSHIFT); else j = len; // clip for (++i; i < j; ++i) // fill pixels between x0 and x1 scanline[i] = scanline[i] + (stbtt_uint8) max_weight; } } } } e = e->next; } } static void stbtt__rasterize_sorted_edges(stbtt__bitmap *result, stbtt__edge *e, int n, int vsubsample, int off_x, int off_y, void *userdata) { stbtt__hheap hh = { 0, 0, 0 }; stbtt__active_edge *active = NULL; int y,j=0; int max_weight = (255 / vsubsample); // weight per vertical scanline int s; // vertical subsample index unsigned char scanline_data[512], *scanline; if (result->w > 512) scanline = (unsigned char *) STBTT_malloc(result->w, userdata); else scanline = scanline_data; y = off_y * vsubsample; e[n].y0 = (off_y + result->h) * (float) vsubsample + 1; while (j < result->h) { STBTT_memset(scanline, 0, result->w); for (s=0; s < vsubsample; ++s) { // find center of pixel for this scanline float scan_y = y + 0.5f; stbtt__active_edge **step = &active; // update all active edges; // remove all active edges that terminate before the center of this scanline while (*step) { stbtt__active_edge * z = *step; if (z->ey <= scan_y) { *step = z->next; // delete from list STBTT_assert(z->direction); z->direction = 0; stbtt__hheap_free(&hh, z); } else { z->x += z->dx; // advance to position for current scanline step = &((*step)->next); // advance through list } } // resort the list if needed for(;;) { int changed=0; step = &active; while (*step && (*step)->next) { if ((*step)->x > (*step)->next->x) { stbtt__active_edge *t = *step; stbtt__active_edge *q = t->next; t->next = q->next; q->next = t; *step = q; changed = 1; } step = &(*step)->next; } if (!changed) break; } // insert all edges that start before the center of this scanline -- omit ones that also end on this scanline while (e->y0 <= scan_y) { if (e->y1 > scan_y) { stbtt__active_edge *z = stbtt__new_active(&hh, e, off_x, scan_y, userdata); if (z != NULL) { // find insertion point if (active == NULL) active = z; else if (z->x < active->x) { // insert at front z->next = active; active = z; } else { // find thing to insert AFTER stbtt__active_edge *p = active; while (p->next && p->next->x < z->x) p = p->next; // at this point, p->next->x is NOT < z->x z->next = p->next; p->next = z; } } } ++e; } // now process all active edges in XOR fashion if (active) stbtt__fill_active_edges(scanline, result->w, active, max_weight); ++y; } STBTT_memcpy(result->pixels + j * result->stride, scanline, result->w); ++j; } stbtt__hheap_cleanup(&hh, userdata); if (scanline != scanline_data) STBTT_free(scanline, userdata); } #elif STBTT_RASTERIZER_VERSION == 2 // the edge passed in here does not cross the vertical line at x or the vertical line at x+1 // (i.e. it has already been clipped to those) static void stbtt__handle_clipped_edge(float *scanline, int x, stbtt__active_edge *e, float x0, float y0, float x1, float y1) { if (y0 == y1) return; STBTT_assert(y0 < y1); STBTT_assert(e->sy <= e->ey); if (y0 > e->ey) return; if (y1 < e->sy) return; if (y0 < e->sy) { x0 += (x1-x0) * (e->sy - y0) / (y1-y0); y0 = e->sy; } if (y1 > e->ey) { x1 += (x1-x0) * (e->ey - y1) / (y1-y0); y1 = e->ey; } if (x0 == x) STBTT_assert(x1 <= x+1); else if (x0 == x+1) STBTT_assert(x1 >= x); else if (x0 <= x) STBTT_assert(x1 <= x); else if (x0 >= x+1) STBTT_assert(x1 >= x+1); else STBTT_assert(x1 >= x && x1 <= x+1); if (x0 <= x && x1 <= x) scanline[x] += e->direction * (y1-y0); else if (x0 >= x+1 && x1 >= x+1) ; else { STBTT_assert(x0 >= x && x0 <= x+1 && x1 >= x && x1 <= x+1); scanline[x] += e->direction * (y1-y0) * (1-((x0-x)+(x1-x))/2); // coverage = 1 - average x position } } static float stbtt__sized_trapezoid_area(float height, float top_width, float bottom_width) { STBTT_assert(top_width >= 0); STBTT_assert(bottom_width >= 0); return (top_width + bottom_width) / 2.0f * height; } static float stbtt__position_trapezoid_area(float height, float tx0, float tx1, float bx0, float bx1) { return stbtt__sized_trapezoid_area(height, tx1 - tx0, bx1 - bx0); } static float stbtt__sized_triangle_area(float height, float width) { return height * width / 2; } static void stbtt__fill_active_edges_new(float *scanline, float *scanline_fill, int len, stbtt__active_edge *e, float y_top) { float y_bottom = y_top+1; while (e) { // brute force every pixel // compute intersection points with top & bottom STBTT_assert(e->ey >= y_top); if (e->fdx == 0) { float x0 = e->fx; if (x0 < len) { if (x0 >= 0) { stbtt__handle_clipped_edge(scanline,(int) x0,e, x0,y_top, x0,y_bottom); stbtt__handle_clipped_edge(scanline_fill-1,(int) x0+1,e, x0,y_top, x0,y_bottom); } else { stbtt__handle_clipped_edge(scanline_fill-1,0,e, x0,y_top, x0,y_bottom); } } } else { float x0 = e->fx; float dx = e->fdx; float xb = x0 + dx; float x_top, x_bottom; float sy0,sy1; float dy = e->fdy; STBTT_assert(e->sy <= y_bottom && e->ey >= y_top); // compute endpoints of line segment clipped to this scanline (if the // line segment starts on this scanline. x0 is the intersection of the // line with y_top, but that may be off the line segment. if (e->sy > y_top) { x_top = x0 + dx * (e->sy - y_top); sy0 = e->sy; } else { x_top = x0; sy0 = y_top; } if (e->ey < y_bottom) { x_bottom = x0 + dx * (e->ey - y_top); sy1 = e->ey; } else { x_bottom = xb; sy1 = y_bottom; } if (x_top >= 0 && x_bottom >= 0 && x_top < len && x_bottom < len) { // from here on, we don't have to range check x values if ((int) x_top == (int) x_bottom) { float height; // simple case, only spans one pixel int x = (int) x_top; height = (sy1 - sy0) * e->direction; STBTT_assert(x >= 0 && x < len); scanline[x] += stbtt__position_trapezoid_area(height, x_top, x+1.0f, x_bottom, x+1.0f); scanline_fill[x] += height; // everything right of this pixel is filled } else { int x,x1,x2; float y_crossing, y_final, step, sign, area; // covers 2+ pixels if (x_top > x_bottom) { // flip scanline vertically; signed area is the same float t; sy0 = y_bottom - (sy0 - y_top); sy1 = y_bottom - (sy1 - y_top); t = sy0, sy0 = sy1, sy1 = t; t = x_bottom, x_bottom = x_top, x_top = t; dx = -dx; dy = -dy; t = x0, x0 = xb, xb = t; } STBTT_assert(dy >= 0); STBTT_assert(dx >= 0); x1 = (int) x_top; x2 = (int) x_bottom; // compute intersection with y axis at x1+1 y_crossing = y_top + dy * (x1+1 - x0); // compute intersection with y axis at x2 y_final = y_top + dy * (x2 - x0); // x1 x_top x2 x_bottom // y_top +------|-----+------------+------------+--------|---+------------+ // | | | | | | // | | | | | | // sy0 | Txxxxx|............|............|............|............| // y_crossing | *xxxxx.......|............|............|............| // | | xxxxx..|............|............|............| // | | /- xx*xxxx........|............|............| // | | dy < | xxxxxx..|............|............| // y_final | | \- | xx*xxx.........|............| // sy1 | | | | xxxxxB...|............| // | | | | | | // | | | | | | // y_bottom +------------+------------+------------+------------+------------+ // // goal is to measure the area covered by '.' in each pixel // if x2 is right at the right edge of x1, y_crossing can blow up, github #1057 // @TODO: maybe test against sy1 rather than y_bottom? if (y_crossing > y_bottom) y_crossing = y_bottom; sign = e->direction; // area of the rectangle covered from sy0..y_crossing area = sign * (y_crossing-sy0); // area of the triangle (x_top,sy0), (x1+1,sy0), (x1+1,y_crossing) scanline[x1] += stbtt__sized_triangle_area(area, x1+1 - x_top); // check if final y_crossing is blown up; no test case for this if (y_final > y_bottom) { int denom = (x2 - (x1+1)); y_final = y_bottom; if (denom != 0) { // [DEAR IMGUI] Avoid div by zero (https://github.com/nothings/stb/issues/1316) dy = (y_final - y_crossing ) / denom; // if denom=0, y_final = y_crossing, so y_final <= y_bottom } } // in second pixel, area covered by line segment found in first pixel // is always a rectangle 1 wide * the height of that line segment; this // is exactly what the variable 'area' stores. it also gets a contribution // from the line segment within it. the THIRD pixel will get the first // pixel's rectangle contribution, the second pixel's rectangle contribution, // and its own contribution. the 'own contribution' is the same in every pixel except // the leftmost and rightmost, a trapezoid that slides down in each pixel. // the second pixel's contribution to the third pixel will be the // rectangle 1 wide times the height change in the second pixel, which is dy. step = sign * dy * 1; // dy is dy/dx, change in y for every 1 change in x, // which multiplied by 1-pixel-width is how much pixel area changes for each step in x // so the area advances by 'step' every time for (x = x1+1; x < x2; ++x) { scanline[x] += area + step/2; // area of trapezoid is 1*step/2 area += step; } STBTT_assert(STBTT_fabs(area) <= 1.01f); // accumulated error from area += step unless we round step down STBTT_assert(sy1 > y_final-0.01f); // area covered in the last pixel is the rectangle from all the pixels to the left, // plus the trapezoid filled by the line segment in this pixel all the way to the right edge scanline[x2] += area + sign * stbtt__position_trapezoid_area(sy1-y_final, (float) x2, x2+1.0f, x_bottom, x2+1.0f); // the rest of the line is filled based on the total height of the line segment in this pixel scanline_fill[x2] += sign * (sy1-sy0); } } else { // if edge goes outside of box we're drawing, we require // clipping logic. since this does not match the intended use // of this library, we use a different, very slow brute // force implementation // note though that this does happen some of the time because // x_top and x_bottom can be extrapolated at the top & bottom of // the shape and actually lie outside the bounding box int x; for (x=0; x < len; ++x) { // cases: // // there can be up to two intersections with the pixel. any intersection // with left or right edges can be handled by splitting into two (or three) // regions. intersections with top & bottom do not necessitate case-wise logic. // // the old way of doing this found the intersections with the left & right edges, // then used some simple logic to produce up to three segments in sorted order // from top-to-bottom. however, this had a problem: if an x edge was epsilon // across the x border, then the corresponding y position might not be distinct // from the other y segment, and it might ignored as an empty segment. to avoid // that, we need to explicitly produce segments based on x positions. // rename variables to clearly-defined pairs float y0 = y_top; float x1 = (float) (x); float x2 = (float) (x+1); float x3 = xb; float y3 = y_bottom; // x = e->x + e->dx * (y-y_top) // (y-y_top) = (x - e->x) / e->dx // y = (x - e->x) / e->dx + y_top float y1 = (x - x0) / dx + y_top; float y2 = (x+1 - x0) / dx + y_top; if (x0 < x1 && x3 > x2) { // three segments descending down-right stbtt__handle_clipped_edge(scanline,x,e, x0,y0, x1,y1); stbtt__handle_clipped_edge(scanline,x,e, x1,y1, x2,y2); stbtt__handle_clipped_edge(scanline,x,e, x2,y2, x3,y3); } else if (x3 < x1 && x0 > x2) { // three segments descending down-left stbtt__handle_clipped_edge(scanline,x,e, x0,y0, x2,y2); stbtt__handle_clipped_edge(scanline,x,e, x2,y2, x1,y1); stbtt__handle_clipped_edge(scanline,x,e, x1,y1, x3,y3); } else if (x0 < x1 && x3 > x1) { // two segments across x, down-right stbtt__handle_clipped_edge(scanline,x,e, x0,y0, x1,y1); stbtt__handle_clipped_edge(scanline,x,e, x1,y1, x3,y3); } else if (x3 < x1 && x0 > x1) { // two segments across x, down-left stbtt__handle_clipped_edge(scanline,x,e, x0,y0, x1,y1); stbtt__handle_clipped_edge(scanline,x,e, x1,y1, x3,y3); } else if (x0 < x2 && x3 > x2) { // two segments across x+1, down-right stbtt__handle_clipped_edge(scanline,x,e, x0,y0, x2,y2); stbtt__handle_clipped_edge(scanline,x,e, x2,y2, x3,y3); } else if (x3 < x2 && x0 > x2) { // two segments across x+1, down-left stbtt__handle_clipped_edge(scanline,x,e, x0,y0, x2,y2); stbtt__handle_clipped_edge(scanline,x,e, x2,y2, x3,y3); } else { // one segment stbtt__handle_clipped_edge(scanline,x,e, x0,y0, x3,y3); } } } } e = e->next; } } // directly AA rasterize edges w/o supersampling static void stbtt__rasterize_sorted_edges(stbtt__bitmap *result, stbtt__edge *e, int n, int vsubsample, int off_x, int off_y, void *userdata) { stbtt__hheap hh = { 0, 0, 0 }; stbtt__active_edge *active = NULL; int y,j=0, i; float scanline_data[129], *scanline, *scanline2; STBTT__NOTUSED(vsubsample); if (result->w > 64) scanline = (float *) STBTT_malloc((result->w*2+1) * sizeof(float), userdata); else scanline = scanline_data; scanline2 = scanline + result->w; y = off_y; e[n].y0 = (float) (off_y + result->h) + 1; while (j < result->h) { // find center of pixel for this scanline float scan_y_top = y + 0.0f; float scan_y_bottom = y + 1.0f; stbtt__active_edge **step = &active; STBTT_memset(scanline , 0, result->w*sizeof(scanline[0])); STBTT_memset(scanline2, 0, (result->w+1)*sizeof(scanline[0])); // update all active edges; // remove all active edges that terminate before the top of this scanline while (*step) { stbtt__active_edge * z = *step; if (z->ey <= scan_y_top) { *step = z->next; // delete from list STBTT_assert(z->direction); z->direction = 0; stbtt__hheap_free(&hh, z); } else { step = &((*step)->next); // advance through list } } // insert all edges that start before the bottom of this scanline while (e->y0 <= scan_y_bottom) { if (e->y0 != e->y1) { stbtt__active_edge *z = stbtt__new_active(&hh, e, off_x, scan_y_top, userdata); if (z != NULL) { if (j == 0 && off_y != 0) { if (z->ey < scan_y_top) { // this can happen due to subpixel positioning and some kind of fp rounding error i think z->ey = scan_y_top; } } STBTT_assert(z->ey >= scan_y_top); // if we get really unlucky a tiny bit of an edge can be out of bounds // insert at front z->next = active; active = z; } } ++e; } // now process all active edges if (active) stbtt__fill_active_edges_new(scanline, scanline2+1, result->w, active, scan_y_top); { float sum = 0; for (i=0; i < result->w; ++i) { float k; int m; sum += scanline2[i]; k = scanline[i] + sum; k = (float) STBTT_fabs(k)*255 + 0.5f; m = (int) k; if (m > 255) m = 255; result->pixels[j*result->stride + i] = (unsigned char) m; } } // advance all the edges step = &active; while (*step) { stbtt__active_edge *z = *step; z->fx += z->fdx; // advance to position for current scanline step = &((*step)->next); // advance through list } ++y; ++j; } stbtt__hheap_cleanup(&hh, userdata); if (scanline != scanline_data) STBTT_free(scanline, userdata); } #else #error "Unrecognized value of STBTT_RASTERIZER_VERSION" #endif #define STBTT__COMPARE(a,b) ((a)->y0 < (b)->y0) static void stbtt__sort_edges_ins_sort(stbtt__edge *p, int n) { int i,j; for (i=1; i < n; ++i) { stbtt__edge t = p[i], *a = &t; j = i; while (j > 0) { stbtt__edge *b = &p[j-1]; int c = STBTT__COMPARE(a,b); if (!c) break; p[j] = p[j-1]; --j; } if (i != j) p[j] = t; } } static void stbtt__sort_edges_quicksort(stbtt__edge *p, int n) { /* threshold for transitioning to insertion sort */ while (n > 12) { stbtt__edge t; int c01,c12,c,m,i,j; /* compute median of three */ m = n >> 1; c01 = STBTT__COMPARE(&p[0],&p[m]); c12 = STBTT__COMPARE(&p[m],&p[n-1]); /* if 0 >= mid >= end, or 0 < mid < end, then use mid */ if (c01 != c12) { /* otherwise, we'll need to swap something else to middle */ int z; c = STBTT__COMPARE(&p[0],&p[n-1]); /* 0>mid && midn => n; 0 0 */ /* 0n: 0>n => 0; 0 n */ z = (c == c12) ? 0 : n-1; t = p[z]; p[z] = p[m]; p[m] = t; } /* now p[m] is the median-of-three */ /* swap it to the beginning so it won't move around */ t = p[0]; p[0] = p[m]; p[m] = t; /* partition loop */ i=1; j=n-1; for(;;) { /* handling of equality is crucial here */ /* for sentinels & efficiency with duplicates */ for (;;++i) { if (!STBTT__COMPARE(&p[i], &p[0])) break; } for (;;--j) { if (!STBTT__COMPARE(&p[0], &p[j])) break; } /* make sure we haven't crossed */ if (i >= j) break; t = p[i]; p[i] = p[j]; p[j] = t; ++i; --j; } /* recurse on smaller side, iterate on larger */ if (j < (n-i)) { stbtt__sort_edges_quicksort(p,j); p = p+i; n = n-i; } else { stbtt__sort_edges_quicksort(p+i, n-i); n = j; } } } static void stbtt__sort_edges(stbtt__edge *p, int n) { stbtt__sort_edges_quicksort(p, n); stbtt__sort_edges_ins_sort(p, n); } typedef struct { float x,y; } stbtt__point; static void stbtt__rasterize(stbtt__bitmap *result, stbtt__point *pts, int *wcount, int windings, float scale_x, float scale_y, float shift_x, float shift_y, int off_x, int off_y, int invert, void *userdata) { float y_scale_inv = invert ? -scale_y : scale_y; stbtt__edge *e; int n,i,j,k,m; #if STBTT_RASTERIZER_VERSION == 1 int vsubsample = result->h < 8 ? 15 : 5; #elif STBTT_RASTERIZER_VERSION == 2 int vsubsample = 1; #else #error "Unrecognized value of STBTT_RASTERIZER_VERSION" #endif // vsubsample should divide 255 evenly; otherwise we won't reach full opacity // now we have to blow out the windings into explicit edge lists n = 0; for (i=0; i < windings; ++i) n += wcount[i]; e = (stbtt__edge *) STBTT_malloc(sizeof(*e) * (n+1), userdata); // add an extra one as a sentinel if (e == 0) return; n = 0; m=0; for (i=0; i < windings; ++i) { stbtt__point *p = pts + m; m += wcount[i]; j = wcount[i]-1; for (k=0; k < wcount[i]; j=k++) { int a=k,b=j; // skip the edge if horizontal if (p[j].y == p[k].y) continue; // add edge from j to k to the list e[n].invert = 0; if (invert ? p[j].y > p[k].y : p[j].y < p[k].y) { e[n].invert = 1; a=j,b=k; } e[n].x0 = p[a].x * scale_x + shift_x; e[n].y0 = (p[a].y * y_scale_inv + shift_y) * vsubsample; e[n].x1 = p[b].x * scale_x + shift_x; e[n].y1 = (p[b].y * y_scale_inv + shift_y) * vsubsample; ++n; } } // now sort the edges by their highest point (should snap to integer, and then by x) //STBTT_sort(e, n, sizeof(e[0]), stbtt__edge_compare); stbtt__sort_edges(e, n); // now, traverse the scanlines and find the intersections on each scanline, use xor winding rule stbtt__rasterize_sorted_edges(result, e, n, vsubsample, off_x, off_y, userdata); STBTT_free(e, userdata); } static void stbtt__add_point(stbtt__point *points, int n, float x, float y) { if (!points) return; // during first pass, it's unallocated points[n].x = x; points[n].y = y; } // tessellate until threshold p is happy... @TODO warped to compensate for non-linear stretching static int stbtt__tesselate_curve(stbtt__point *points, int *num_points, float x0, float y0, float x1, float y1, float x2, float y2, float objspace_flatness_squared, int n) { // midpoint float mx = (x0 + 2*x1 + x2)/4; float my = (y0 + 2*y1 + y2)/4; // versus directly drawn line float dx = (x0+x2)/2 - mx; float dy = (y0+y2)/2 - my; if (n > 16) // 65536 segments on one curve better be enough! return 1; if (dx*dx+dy*dy > objspace_flatness_squared) { // half-pixel error allowed... need to be smaller if AA stbtt__tesselate_curve(points, num_points, x0,y0, (x0+x1)/2.0f,(y0+y1)/2.0f, mx,my, objspace_flatness_squared,n+1); stbtt__tesselate_curve(points, num_points, mx,my, (x1+x2)/2.0f,(y1+y2)/2.0f, x2,y2, objspace_flatness_squared,n+1); } else { stbtt__add_point(points, *num_points,x2,y2); *num_points = *num_points+1; } return 1; } static void stbtt__tesselate_cubic(stbtt__point *points, int *num_points, float x0, float y0, float x1, float y1, float x2, float y2, float x3, float y3, float objspace_flatness_squared, int n) { // @TODO this "flatness" calculation is just made-up nonsense that seems to work well enough float dx0 = x1-x0; float dy0 = y1-y0; float dx1 = x2-x1; float dy1 = y2-y1; float dx2 = x3-x2; float dy2 = y3-y2; float dx = x3-x0; float dy = y3-y0; float longlen = (float) (STBTT_sqrt(dx0*dx0+dy0*dy0)+STBTT_sqrt(dx1*dx1+dy1*dy1)+STBTT_sqrt(dx2*dx2+dy2*dy2)); float shortlen = (float) STBTT_sqrt(dx*dx+dy*dy); float flatness_squared = longlen*longlen-shortlen*shortlen; if (n > 16) // 65536 segments on one curve better be enough! return; if (flatness_squared > objspace_flatness_squared) { float x01 = (x0+x1)/2; float y01 = (y0+y1)/2; float x12 = (x1+x2)/2; float y12 = (y1+y2)/2; float x23 = (x2+x3)/2; float y23 = (y2+y3)/2; float xa = (x01+x12)/2; float ya = (y01+y12)/2; float xb = (x12+x23)/2; float yb = (y12+y23)/2; float mx = (xa+xb)/2; float my = (ya+yb)/2; stbtt__tesselate_cubic(points, num_points, x0,y0, x01,y01, xa,ya, mx,my, objspace_flatness_squared,n+1); stbtt__tesselate_cubic(points, num_points, mx,my, xb,yb, x23,y23, x3,y3, objspace_flatness_squared,n+1); } else { stbtt__add_point(points, *num_points,x3,y3); *num_points = *num_points+1; } } // returns number of contours static stbtt__point *stbtt_FlattenCurves(stbtt_vertex *vertices, int num_verts, float objspace_flatness, int **contour_lengths, int *num_contours, void *userdata) { stbtt__point *points=0; int num_points=0; float objspace_flatness_squared = objspace_flatness * objspace_flatness; int i,n=0,start=0, pass; // count how many "moves" there are to get the contour count for (i=0; i < num_verts; ++i) if (vertices[i].type == STBTT_vmove) ++n; *num_contours = n; if (n == 0) return 0; *contour_lengths = (int *) STBTT_malloc(sizeof(**contour_lengths) * n, userdata); if (*contour_lengths == 0) { *num_contours = 0; return 0; } // make two passes through the points so we don't need to realloc for (pass=0; pass < 2; ++pass) { float x=0,y=0; if (pass == 1) { points = (stbtt__point *) STBTT_malloc(num_points * sizeof(points[0]), userdata); if (points == NULL) goto error; } num_points = 0; n= -1; for (i=0; i < num_verts; ++i) { switch (vertices[i].type) { case STBTT_vmove: // start the next contour if (n >= 0) (*contour_lengths)[n] = num_points - start; ++n; start = num_points; x = vertices[i].x, y = vertices[i].y; stbtt__add_point(points, num_points++, x,y); break; case STBTT_vline: x = vertices[i].x, y = vertices[i].y; stbtt__add_point(points, num_points++, x, y); break; case STBTT_vcurve: stbtt__tesselate_curve(points, &num_points, x,y, vertices[i].cx, vertices[i].cy, vertices[i].x, vertices[i].y, objspace_flatness_squared, 0); x = vertices[i].x, y = vertices[i].y; break; case STBTT_vcubic: stbtt__tesselate_cubic(points, &num_points, x,y, vertices[i].cx, vertices[i].cy, vertices[i].cx1, vertices[i].cy1, vertices[i].x, vertices[i].y, objspace_flatness_squared, 0); x = vertices[i].x, y = vertices[i].y; break; } } (*contour_lengths)[n] = num_points - start; } return points; error: STBTT_free(points, userdata); STBTT_free(*contour_lengths, userdata); *contour_lengths = 0; *num_contours = 0; return NULL; } STBTT_DEF void stbtt_Rasterize(stbtt__bitmap *result, float flatness_in_pixels, stbtt_vertex *vertices, int num_verts, float scale_x, float scale_y, float shift_x, float shift_y, int x_off, int y_off, int invert, void *userdata) { float scale = scale_x > scale_y ? scale_y : scale_x; int winding_count = 0; int *winding_lengths = NULL; stbtt__point *windings = stbtt_FlattenCurves(vertices, num_verts, flatness_in_pixels / scale, &winding_lengths, &winding_count, userdata); if (windings) { stbtt__rasterize(result, windings, winding_lengths, winding_count, scale_x, scale_y, shift_x, shift_y, x_off, y_off, invert, userdata); STBTT_free(winding_lengths, userdata); STBTT_free(windings, userdata); } } STBTT_DEF void stbtt_FreeBitmap(unsigned char *bitmap, void *userdata) { STBTT_free(bitmap, userdata); } STBTT_DEF unsigned char *stbtt_GetGlyphBitmapSubpixel(const stbtt_fontinfo *info, float scale_x, float scale_y, float shift_x, float shift_y, int glyph, int *width, int *height, int *xoff, int *yoff) { int ix0,iy0,ix1,iy1; stbtt__bitmap gbm; stbtt_vertex *vertices; int num_verts = stbtt_GetGlyphShape(info, glyph, &vertices); if (scale_x == 0) scale_x = scale_y; if (scale_y == 0) { if (scale_x == 0) { STBTT_free(vertices, info->userdata); return NULL; } scale_y = scale_x; } stbtt_GetGlyphBitmapBoxSubpixel(info, glyph, scale_x, scale_y, shift_x, shift_y, &ix0,&iy0,&ix1,&iy1); // now we get the size gbm.w = (ix1 - ix0); gbm.h = (iy1 - iy0); gbm.pixels = NULL; // in case we error if (width ) *width = gbm.w; if (height) *height = gbm.h; if (xoff ) *xoff = ix0; if (yoff ) *yoff = iy0; if (gbm.w && gbm.h) { gbm.pixels = (unsigned char *) STBTT_malloc(gbm.w * gbm.h, info->userdata); if (gbm.pixels) { gbm.stride = gbm.w; stbtt_Rasterize(&gbm, 0.35f, vertices, num_verts, scale_x, scale_y, shift_x, shift_y, ix0, iy0, 1, info->userdata); } } STBTT_free(vertices, info->userdata); return gbm.pixels; } STBTT_DEF unsigned char *stbtt_GetGlyphBitmap(const stbtt_fontinfo *info, float scale_x, float scale_y, int glyph, int *width, int *height, int *xoff, int *yoff) { return stbtt_GetGlyphBitmapSubpixel(info, scale_x, scale_y, 0.0f, 0.0f, glyph, width, height, xoff, yoff); } STBTT_DEF void stbtt_MakeGlyphBitmapSubpixel(const stbtt_fontinfo *info, unsigned char *output, int out_w, int out_h, int out_stride, float scale_x, float scale_y, float shift_x, float shift_y, int glyph) { int ix0,iy0; stbtt_vertex *vertices; int num_verts = stbtt_GetGlyphShape(info, glyph, &vertices); stbtt__bitmap gbm; stbtt_GetGlyphBitmapBoxSubpixel(info, glyph, scale_x, scale_y, shift_x, shift_y, &ix0,&iy0,0,0); gbm.pixels = output; gbm.w = out_w; gbm.h = out_h; gbm.stride = out_stride; if (gbm.w && gbm.h) stbtt_Rasterize(&gbm, 0.35f, vertices, num_verts, scale_x, scale_y, shift_x, shift_y, ix0,iy0, 1, info->userdata); STBTT_free(vertices, info->userdata); } STBTT_DEF void stbtt_MakeGlyphBitmap(const stbtt_fontinfo *info, unsigned char *output, int out_w, int out_h, int out_stride, float scale_x, float scale_y, int glyph) { stbtt_MakeGlyphBitmapSubpixel(info, output, out_w, out_h, out_stride, scale_x, scale_y, 0.0f,0.0f, glyph); } STBTT_DEF unsigned char *stbtt_GetCodepointBitmapSubpixel(const stbtt_fontinfo *info, float scale_x, float scale_y, float shift_x, float shift_y, int codepoint, int *width, int *height, int *xoff, int *yoff) { return stbtt_GetGlyphBitmapSubpixel(info, scale_x, scale_y,shift_x,shift_y, stbtt_FindGlyphIndex(info,codepoint), width,height,xoff,yoff); } STBTT_DEF void stbtt_MakeCodepointBitmapSubpixelPrefilter(const stbtt_fontinfo *info, unsigned char *output, int out_w, int out_h, int out_stride, float scale_x, float scale_y, float shift_x, float shift_y, int oversample_x, int oversample_y, float *sub_x, float *sub_y, int codepoint) { stbtt_MakeGlyphBitmapSubpixelPrefilter(info, output, out_w, out_h, out_stride, scale_x, scale_y, shift_x, shift_y, oversample_x, oversample_y, sub_x, sub_y, stbtt_FindGlyphIndex(info,codepoint)); } STBTT_DEF void stbtt_MakeCodepointBitmapSubpixel(const stbtt_fontinfo *info, unsigned char *output, int out_w, int out_h, int out_stride, float scale_x, float scale_y, float shift_x, float shift_y, int codepoint) { stbtt_MakeGlyphBitmapSubpixel(info, output, out_w, out_h, out_stride, scale_x, scale_y, shift_x, shift_y, stbtt_FindGlyphIndex(info,codepoint)); } STBTT_DEF unsigned char *stbtt_GetCodepointBitmap(const stbtt_fontinfo *info, float scale_x, float scale_y, int codepoint, int *width, int *height, int *xoff, int *yoff) { return stbtt_GetCodepointBitmapSubpixel(info, scale_x, scale_y, 0.0f,0.0f, codepoint, width,height,xoff,yoff); } STBTT_DEF void stbtt_MakeCodepointBitmap(const stbtt_fontinfo *info, unsigned char *output, int out_w, int out_h, int out_stride, float scale_x, float scale_y, int codepoint) { stbtt_MakeCodepointBitmapSubpixel(info, output, out_w, out_h, out_stride, scale_x, scale_y, 0.0f,0.0f, codepoint); } ////////////////////////////////////////////////////////////////////////////// // // bitmap baking // // This is SUPER-CRAPPY packing to keep source code small static int stbtt_BakeFontBitmap_internal(unsigned char *data, int offset, // font location (use offset=0 for plain .ttf) float pixel_height, // height of font in pixels unsigned char *pixels, int pw, int ph, // bitmap to be filled in int first_char, int num_chars, // characters to bake stbtt_bakedchar *chardata) { float scale; int x,y,bottom_y, i; stbtt_fontinfo f; f.userdata = NULL; if (!stbtt_InitFont(&f, data, offset)) return -1; STBTT_memset(pixels, 0, pw*ph); // background of 0 around pixels x=y=1; bottom_y = 1; scale = stbtt_ScaleForPixelHeight(&f, pixel_height); for (i=0; i < num_chars; ++i) { int advance, lsb, x0,y0,x1,y1,gw,gh; int g = stbtt_FindGlyphIndex(&f, first_char + i); stbtt_GetGlyphHMetrics(&f, g, &advance, &lsb); stbtt_GetGlyphBitmapBox(&f, g, scale,scale, &x0,&y0,&x1,&y1); gw = x1-x0; gh = y1-y0; if (x + gw + 1 >= pw) y = bottom_y, x = 1; // advance to next row if (y + gh + 1 >= ph) // check if it fits vertically AFTER potentially moving to next row return -i; STBTT_assert(x+gw < pw); STBTT_assert(y+gh < ph); stbtt_MakeGlyphBitmap(&f, pixels+x+y*pw, gw,gh,pw, scale,scale, g); chardata[i].x0 = (stbtt_int16) x; chardata[i].y0 = (stbtt_int16) y; chardata[i].x1 = (stbtt_int16) (x + gw); chardata[i].y1 = (stbtt_int16) (y + gh); chardata[i].xadvance = scale * advance; chardata[i].xoff = (float) x0; chardata[i].yoff = (float) y0; x = x + gw + 1; if (y+gh+1 > bottom_y) bottom_y = y+gh+1; } return bottom_y; } STBTT_DEF void stbtt_GetBakedQuad(const stbtt_bakedchar *chardata, int pw, int ph, int char_index, float *xpos, float *ypos, stbtt_aligned_quad *q, int opengl_fillrule) { float d3d_bias = opengl_fillrule ? 0 : -0.5f; float ipw = 1.0f / pw, iph = 1.0f / ph; const stbtt_bakedchar *b = chardata + char_index; int round_x = STBTT_ifloor((*xpos + b->xoff) + 0.5f); int round_y = STBTT_ifloor((*ypos + b->yoff) + 0.5f); q->x0 = round_x + d3d_bias; q->y0 = round_y + d3d_bias; q->x1 = round_x + b->x1 - b->x0 + d3d_bias; q->y1 = round_y + b->y1 - b->y0 + d3d_bias; q->s0 = b->x0 * ipw; q->t0 = b->y0 * iph; q->s1 = b->x1 * ipw; q->t1 = b->y1 * iph; *xpos += b->xadvance; } ////////////////////////////////////////////////////////////////////////////// // // rectangle packing replacement routines if you don't have stb_rect_pack.h // #ifndef STB_RECT_PACK_VERSION typedef int stbrp_coord; //////////////////////////////////////////////////////////////////////////////////// // // // // // COMPILER WARNING ?!?!? // // // // // // if you get a compile warning due to these symbols being defined more than // // once, move #include "stb_rect_pack.h" before #include "stb_truetype.h" // // // //////////////////////////////////////////////////////////////////////////////////// typedef struct { int width,height; int x,y,bottom_y; } stbrp_context; typedef struct { unsigned char x; } stbrp_node; struct stbrp_rect { stbrp_coord x,y; int id,w,h,was_packed; }; static void stbrp_init_target(stbrp_context *con, int pw, int ph, stbrp_node *nodes, int num_nodes) { con->width = pw; con->height = ph; con->x = 0; con->y = 0; con->bottom_y = 0; STBTT__NOTUSED(nodes); STBTT__NOTUSED(num_nodes); } static void stbrp_pack_rects(stbrp_context *con, stbrp_rect *rects, int num_rects) { int i; for (i=0; i < num_rects; ++i) { if (con->x + rects[i].w > con->width) { con->x = 0; con->y = con->bottom_y; } if (con->y + rects[i].h > con->height) break; rects[i].x = con->x; rects[i].y = con->y; rects[i].was_packed = 1; con->x += rects[i].w; if (con->y + rects[i].h > con->bottom_y) con->bottom_y = con->y + rects[i].h; } for ( ; i < num_rects; ++i) rects[i].was_packed = 0; } #endif ////////////////////////////////////////////////////////////////////////////// // // bitmap baking // // This is SUPER-AWESOME (tm Ryan Gordon) packing using stb_rect_pack.h. If // stb_rect_pack.h isn't available, it uses the BakeFontBitmap strategy. STBTT_DEF int stbtt_PackBegin(stbtt_pack_context *spc, unsigned char *pixels, int pw, int ph, int stride_in_bytes, int padding, void *alloc_context) { stbrp_context *context = (stbrp_context *) STBTT_malloc(sizeof(*context) ,alloc_context); int num_nodes = pw - padding; stbrp_node *nodes = (stbrp_node *) STBTT_malloc(sizeof(*nodes ) * num_nodes,alloc_context); if (context == NULL || nodes == NULL) { if (context != NULL) STBTT_free(context, alloc_context); if (nodes != NULL) STBTT_free(nodes , alloc_context); return 0; } spc->user_allocator_context = alloc_context; spc->width = pw; spc->height = ph; spc->pixels = pixels; spc->pack_info = context; spc->nodes = nodes; spc->padding = padding; spc->stride_in_bytes = stride_in_bytes != 0 ? stride_in_bytes : pw; spc->h_oversample = 1; spc->v_oversample = 1; spc->skip_missing = 0; stbrp_init_target(context, pw-padding, ph-padding, nodes, num_nodes); if (pixels) STBTT_memset(pixels, 0, pw*ph); // background of 0 around pixels return 1; } STBTT_DEF void stbtt_PackEnd (stbtt_pack_context *spc) { STBTT_free(spc->nodes , spc->user_allocator_context); STBTT_free(spc->pack_info, spc->user_allocator_context); } STBTT_DEF void stbtt_PackSetOversampling(stbtt_pack_context *spc, unsigned int h_oversample, unsigned int v_oversample) { STBTT_assert(h_oversample <= STBTT_MAX_OVERSAMPLE); STBTT_assert(v_oversample <= STBTT_MAX_OVERSAMPLE); if (h_oversample <= STBTT_MAX_OVERSAMPLE) spc->h_oversample = h_oversample; if (v_oversample <= STBTT_MAX_OVERSAMPLE) spc->v_oversample = v_oversample; } STBTT_DEF void stbtt_PackSetSkipMissingCodepoints(stbtt_pack_context *spc, int skip) { spc->skip_missing = skip; } #define STBTT__OVER_MASK (STBTT_MAX_OVERSAMPLE-1) static void stbtt__h_prefilter(unsigned char *pixels, int w, int h, int stride_in_bytes, unsigned int kernel_width) { unsigned char buffer[STBTT_MAX_OVERSAMPLE]; int safe_w = w - kernel_width; int j; STBTT_memset(buffer, 0, STBTT_MAX_OVERSAMPLE); // suppress bogus warning from VS2013 -analyze for (j=0; j < h; ++j) { int i; unsigned int total; STBTT_memset(buffer, 0, kernel_width); total = 0; // make kernel_width a constant in common cases so compiler can optimize out the divide switch (kernel_width) { case 2: for (i=0; i <= safe_w; ++i) { total += pixels[i] - buffer[i & STBTT__OVER_MASK]; buffer[(i+kernel_width) & STBTT__OVER_MASK] = pixels[i]; pixels[i] = (unsigned char) (total / 2); } break; case 3: for (i=0; i <= safe_w; ++i) { total += pixels[i] - buffer[i & STBTT__OVER_MASK]; buffer[(i+kernel_width) & STBTT__OVER_MASK] = pixels[i]; pixels[i] = (unsigned char) (total / 3); } break; case 4: for (i=0; i <= safe_w; ++i) { total += pixels[i] - buffer[i & STBTT__OVER_MASK]; buffer[(i+kernel_width) & STBTT__OVER_MASK] = pixels[i]; pixels[i] = (unsigned char) (total / 4); } break; case 5: for (i=0; i <= safe_w; ++i) { total += pixels[i] - buffer[i & STBTT__OVER_MASK]; buffer[(i+kernel_width) & STBTT__OVER_MASK] = pixels[i]; pixels[i] = (unsigned char) (total / 5); } break; default: for (i=0; i <= safe_w; ++i) { total += pixels[i] - buffer[i & STBTT__OVER_MASK]; buffer[(i+kernel_width) & STBTT__OVER_MASK] = pixels[i]; pixels[i] = (unsigned char) (total / kernel_width); } break; } for (; i < w; ++i) { STBTT_assert(pixels[i] == 0); total -= buffer[i & STBTT__OVER_MASK]; pixels[i] = (unsigned char) (total / kernel_width); } pixels += stride_in_bytes; } } static void stbtt__v_prefilter(unsigned char *pixels, int w, int h, int stride_in_bytes, unsigned int kernel_width) { unsigned char buffer[STBTT_MAX_OVERSAMPLE]; int safe_h = h - kernel_width; int j; STBTT_memset(buffer, 0, STBTT_MAX_OVERSAMPLE); // suppress bogus warning from VS2013 -analyze for (j=0; j < w; ++j) { int i; unsigned int total; STBTT_memset(buffer, 0, kernel_width); total = 0; // make kernel_width a constant in common cases so compiler can optimize out the divide switch (kernel_width) { case 2: for (i=0; i <= safe_h; ++i) { total += pixels[i*stride_in_bytes] - buffer[i & STBTT__OVER_MASK]; buffer[(i+kernel_width) & STBTT__OVER_MASK] = pixels[i*stride_in_bytes]; pixels[i*stride_in_bytes] = (unsigned char) (total / 2); } break; case 3: for (i=0; i <= safe_h; ++i) { total += pixels[i*stride_in_bytes] - buffer[i & STBTT__OVER_MASK]; buffer[(i+kernel_width) & STBTT__OVER_MASK] = pixels[i*stride_in_bytes]; pixels[i*stride_in_bytes] = (unsigned char) (total / 3); } break; case 4: for (i=0; i <= safe_h; ++i) { total += pixels[i*stride_in_bytes] - buffer[i & STBTT__OVER_MASK]; buffer[(i+kernel_width) & STBTT__OVER_MASK] = pixels[i*stride_in_bytes]; pixels[i*stride_in_bytes] = (unsigned char) (total / 4); } break; case 5: for (i=0; i <= safe_h; ++i) { total += pixels[i*stride_in_bytes] - buffer[i & STBTT__OVER_MASK]; buffer[(i+kernel_width) & STBTT__OVER_MASK] = pixels[i*stride_in_bytes]; pixels[i*stride_in_bytes] = (unsigned char) (total / 5); } break; default: for (i=0; i <= safe_h; ++i) { total += pixels[i*stride_in_bytes] - buffer[i & STBTT__OVER_MASK]; buffer[(i+kernel_width) & STBTT__OVER_MASK] = pixels[i*stride_in_bytes]; pixels[i*stride_in_bytes] = (unsigned char) (total / kernel_width); } break; } for (; i < h; ++i) { STBTT_assert(pixels[i*stride_in_bytes] == 0); total -= buffer[i & STBTT__OVER_MASK]; pixels[i*stride_in_bytes] = (unsigned char) (total / kernel_width); } pixels += 1; } } static float stbtt__oversample_shift(int oversample) { if (!oversample) return 0.0f; // The prefilter is a box filter of width "oversample", // which shifts phase by (oversample - 1)/2 pixels in // oversampled space. We want to shift in the opposite // direction to counter this. return (float)-(oversample - 1) / (2.0f * (float)oversample); } // rects array must be big enough to accommodate all characters in the given ranges STBTT_DEF int stbtt_PackFontRangesGatherRects(stbtt_pack_context *spc, const stbtt_fontinfo *info, stbtt_pack_range *ranges, int num_ranges, stbrp_rect *rects) { int i,j,k; int missing_glyph_added = 0; k=0; for (i=0; i < num_ranges; ++i) { float fh = ranges[i].font_size; float scale = fh > 0 ? stbtt_ScaleForPixelHeight(info, fh) : stbtt_ScaleForMappingEmToPixels(info, -fh); ranges[i].h_oversample = (unsigned char) spc->h_oversample; ranges[i].v_oversample = (unsigned char) spc->v_oversample; for (j=0; j < ranges[i].num_chars; ++j) { int x0,y0,x1,y1; int codepoint = ranges[i].array_of_unicode_codepoints == NULL ? ranges[i].first_unicode_codepoint_in_range + j : ranges[i].array_of_unicode_codepoints[j]; int glyph = stbtt_FindGlyphIndex(info, codepoint); if (glyph == 0 && (spc->skip_missing || missing_glyph_added)) { rects[k].w = rects[k].h = 0; } else { stbtt_GetGlyphBitmapBoxSubpixel(info,glyph, scale * spc->h_oversample, scale * spc->v_oversample, 0,0, &x0,&y0,&x1,&y1); rects[k].w = (stbrp_coord) (x1-x0 + spc->padding + spc->h_oversample-1); rects[k].h = (stbrp_coord) (y1-y0 + spc->padding + spc->v_oversample-1); if (glyph == 0) missing_glyph_added = 1; } ++k; } } return k; } STBTT_DEF void stbtt_MakeGlyphBitmapSubpixelPrefilter(const stbtt_fontinfo *info, unsigned char *output, int out_w, int out_h, int out_stride, float scale_x, float scale_y, float shift_x, float shift_y, int prefilter_x, int prefilter_y, float *sub_x, float *sub_y, int glyph) { stbtt_MakeGlyphBitmapSubpixel(info, output, out_w - (prefilter_x - 1), out_h - (prefilter_y - 1), out_stride, scale_x, scale_y, shift_x, shift_y, glyph); if (prefilter_x > 1) stbtt__h_prefilter(output, out_w, out_h, out_stride, prefilter_x); if (prefilter_y > 1) stbtt__v_prefilter(output, out_w, out_h, out_stride, prefilter_y); *sub_x = stbtt__oversample_shift(prefilter_x); *sub_y = stbtt__oversample_shift(prefilter_y); } // rects array must be big enough to accommodate all characters in the given ranges STBTT_DEF int stbtt_PackFontRangesRenderIntoRects(stbtt_pack_context *spc, const stbtt_fontinfo *info, stbtt_pack_range *ranges, int num_ranges, stbrp_rect *rects) { int i,j,k, missing_glyph = -1, return_value = 1; // save current values int old_h_over = spc->h_oversample; int old_v_over = spc->v_oversample; k = 0; for (i=0; i < num_ranges; ++i) { float fh = ranges[i].font_size; float scale = fh > 0 ? stbtt_ScaleForPixelHeight(info, fh) : stbtt_ScaleForMappingEmToPixels(info, -fh); float recip_h,recip_v,sub_x,sub_y; spc->h_oversample = ranges[i].h_oversample; spc->v_oversample = ranges[i].v_oversample; recip_h = 1.0f / spc->h_oversample; recip_v = 1.0f / spc->v_oversample; sub_x = stbtt__oversample_shift(spc->h_oversample); sub_y = stbtt__oversample_shift(spc->v_oversample); for (j=0; j < ranges[i].num_chars; ++j) { stbrp_rect *r = &rects[k]; if (r->was_packed && r->w != 0 && r->h != 0) { stbtt_packedchar *bc = &ranges[i].chardata_for_range[j]; int advance, lsb, x0,y0,x1,y1; int codepoint = ranges[i].array_of_unicode_codepoints == NULL ? ranges[i].first_unicode_codepoint_in_range + j : ranges[i].array_of_unicode_codepoints[j]; int glyph = stbtt_FindGlyphIndex(info, codepoint); stbrp_coord pad = (stbrp_coord) spc->padding; // pad on left and top r->x += pad; r->y += pad; r->w -= pad; r->h -= pad; stbtt_GetGlyphHMetrics(info, glyph, &advance, &lsb); stbtt_GetGlyphBitmapBox(info, glyph, scale * spc->h_oversample, scale * spc->v_oversample, &x0,&y0,&x1,&y1); stbtt_MakeGlyphBitmapSubpixel(info, spc->pixels + r->x + r->y*spc->stride_in_bytes, r->w - spc->h_oversample+1, r->h - spc->v_oversample+1, spc->stride_in_bytes, scale * spc->h_oversample, scale * spc->v_oversample, 0,0, glyph); if (spc->h_oversample > 1) stbtt__h_prefilter(spc->pixels + r->x + r->y*spc->stride_in_bytes, r->w, r->h, spc->stride_in_bytes, spc->h_oversample); if (spc->v_oversample > 1) stbtt__v_prefilter(spc->pixels + r->x + r->y*spc->stride_in_bytes, r->w, r->h, spc->stride_in_bytes, spc->v_oversample); bc->x0 = (stbtt_int16) r->x; bc->y0 = (stbtt_int16) r->y; bc->x1 = (stbtt_int16) (r->x + r->w); bc->y1 = (stbtt_int16) (r->y + r->h); bc->xadvance = scale * advance; bc->xoff = (float) x0 * recip_h + sub_x; bc->yoff = (float) y0 * recip_v + sub_y; bc->xoff2 = (x0 + r->w) * recip_h + sub_x; bc->yoff2 = (y0 + r->h) * recip_v + sub_y; if (glyph == 0) missing_glyph = j; } else if (spc->skip_missing) { return_value = 0; } else if (r->was_packed && r->w == 0 && r->h == 0 && missing_glyph >= 0) { ranges[i].chardata_for_range[j] = ranges[i].chardata_for_range[missing_glyph]; } else { return_value = 0; // if any fail, report failure } ++k; } } // restore original values spc->h_oversample = old_h_over; spc->v_oversample = old_v_over; return return_value; } STBTT_DEF void stbtt_PackFontRangesPackRects(stbtt_pack_context *spc, stbrp_rect *rects, int num_rects) { stbrp_pack_rects((stbrp_context *) spc->pack_info, rects, num_rects); } STBTT_DEF int stbtt_PackFontRanges(stbtt_pack_context *spc, const unsigned char *fontdata, int font_index, stbtt_pack_range *ranges, int num_ranges) { stbtt_fontinfo info; int i, j, n, return_value; // [DEAR IMGUI] removed = 1; //stbrp_context *context = (stbrp_context *) spc->pack_info; stbrp_rect *rects; // flag all characters as NOT packed for (i=0; i < num_ranges; ++i) for (j=0; j < ranges[i].num_chars; ++j) ranges[i].chardata_for_range[j].x0 = ranges[i].chardata_for_range[j].y0 = ranges[i].chardata_for_range[j].x1 = ranges[i].chardata_for_range[j].y1 = 0; n = 0; for (i=0; i < num_ranges; ++i) n += ranges[i].num_chars; rects = (stbrp_rect *) STBTT_malloc(sizeof(*rects) * n, spc->user_allocator_context); if (rects == NULL) return 0; info.userdata = spc->user_allocator_context; stbtt_InitFont(&info, fontdata, stbtt_GetFontOffsetForIndex(fontdata,font_index)); n = stbtt_PackFontRangesGatherRects(spc, &info, ranges, num_ranges, rects); stbtt_PackFontRangesPackRects(spc, rects, n); return_value = stbtt_PackFontRangesRenderIntoRects(spc, &info, ranges, num_ranges, rects); STBTT_free(rects, spc->user_allocator_context); return return_value; } STBTT_DEF int stbtt_PackFontRange(stbtt_pack_context *spc, const unsigned char *fontdata, int font_index, float font_size, int first_unicode_codepoint_in_range, int num_chars_in_range, stbtt_packedchar *chardata_for_range) { stbtt_pack_range range; range.first_unicode_codepoint_in_range = first_unicode_codepoint_in_range; range.array_of_unicode_codepoints = NULL; range.num_chars = num_chars_in_range; range.chardata_for_range = chardata_for_range; range.font_size = font_size; return stbtt_PackFontRanges(spc, fontdata, font_index, &range, 1); } STBTT_DEF void stbtt_GetScaledFontVMetrics(const unsigned char *fontdata, int index, float size, float *ascent, float *descent, float *lineGap) { int i_ascent, i_descent, i_lineGap; float scale; stbtt_fontinfo info; stbtt_InitFont(&info, fontdata, stbtt_GetFontOffsetForIndex(fontdata, index)); scale = size > 0 ? stbtt_ScaleForPixelHeight(&info, size) : stbtt_ScaleForMappingEmToPixels(&info, -size); stbtt_GetFontVMetrics(&info, &i_ascent, &i_descent, &i_lineGap); *ascent = (float) i_ascent * scale; *descent = (float) i_descent * scale; *lineGap = (float) i_lineGap * scale; } STBTT_DEF void stbtt_GetPackedQuad(const stbtt_packedchar *chardata, int pw, int ph, int char_index, float *xpos, float *ypos, stbtt_aligned_quad *q, int align_to_integer) { float ipw = 1.0f / pw, iph = 1.0f / ph; const stbtt_packedchar *b = chardata + char_index; if (align_to_integer) { float x = (float) STBTT_ifloor((*xpos + b->xoff) + 0.5f); float y = (float) STBTT_ifloor((*ypos + b->yoff) + 0.5f); q->x0 = x; q->y0 = y; q->x1 = x + b->xoff2 - b->xoff; q->y1 = y + b->yoff2 - b->yoff; } else { q->x0 = *xpos + b->xoff; q->y0 = *ypos + b->yoff; q->x1 = *xpos + b->xoff2; q->y1 = *ypos + b->yoff2; } q->s0 = b->x0 * ipw; q->t0 = b->y0 * iph; q->s1 = b->x1 * ipw; q->t1 = b->y1 * iph; *xpos += b->xadvance; } ////////////////////////////////////////////////////////////////////////////// // // sdf computation // #define STBTT_min(a,b) ((a) < (b) ? (a) : (b)) #define STBTT_max(a,b) ((a) < (b) ? (b) : (a)) static int stbtt__ray_intersect_bezier(float orig[2], float ray[2], float q0[2], float q1[2], float q2[2], float hits[2][2]) { float q0perp = q0[1]*ray[0] - q0[0]*ray[1]; float q1perp = q1[1]*ray[0] - q1[0]*ray[1]; float q2perp = q2[1]*ray[0] - q2[0]*ray[1]; float roperp = orig[1]*ray[0] - orig[0]*ray[1]; float a = q0perp - 2*q1perp + q2perp; float b = q1perp - q0perp; float c = q0perp - roperp; float s0 = 0., s1 = 0.; int num_s = 0; if (a != 0.0) { float discr = b*b - a*c; if (discr > 0.0) { float rcpna = -1 / a; float d = (float) STBTT_sqrt(discr); s0 = (b+d) * rcpna; s1 = (b-d) * rcpna; if (s0 >= 0.0 && s0 <= 1.0) num_s = 1; if (d > 0.0 && s1 >= 0.0 && s1 <= 1.0) { if (num_s == 0) s0 = s1; ++num_s; } } } else { // 2*b*s + c = 0 // s = -c / (2*b) s0 = c / (-2 * b); if (s0 >= 0.0 && s0 <= 1.0) num_s = 1; } if (num_s == 0) return 0; else { float rcp_len2 = 1 / (ray[0]*ray[0] + ray[1]*ray[1]); float rayn_x = ray[0] * rcp_len2, rayn_y = ray[1] * rcp_len2; float q0d = q0[0]*rayn_x + q0[1]*rayn_y; float q1d = q1[0]*rayn_x + q1[1]*rayn_y; float q2d = q2[0]*rayn_x + q2[1]*rayn_y; float rod = orig[0]*rayn_x + orig[1]*rayn_y; float q10d = q1d - q0d; float q20d = q2d - q0d; float q0rd = q0d - rod; hits[0][0] = q0rd + s0*(2.0f - 2.0f*s0)*q10d + s0*s0*q20d; hits[0][1] = a*s0+b; if (num_s > 1) { hits[1][0] = q0rd + s1*(2.0f - 2.0f*s1)*q10d + s1*s1*q20d; hits[1][1] = a*s1+b; return 2; } else { return 1; } } } static int equal(float *a, float *b) { return (a[0] == b[0] && a[1] == b[1]); } static int stbtt__compute_crossings_x(float x, float y, int nverts, stbtt_vertex *verts) { int i; float orig[2], ray[2] = { 1, 0 }; float y_frac; int winding = 0; // make sure y never passes through a vertex of the shape y_frac = (float) STBTT_fmod(y, 1.0f); if (y_frac < 0.01f) y += 0.01f; else if (y_frac > 0.99f) y -= 0.01f; orig[0] = x; orig[1] = y; // test a ray from (-infinity,y) to (x,y) for (i=0; i < nverts; ++i) { if (verts[i].type == STBTT_vline) { int x0 = (int) verts[i-1].x, y0 = (int) verts[i-1].y; int x1 = (int) verts[i ].x, y1 = (int) verts[i ].y; if (y > STBTT_min(y0,y1) && y < STBTT_max(y0,y1) && x > STBTT_min(x0,x1)) { float x_inter = (y - y0) / (y1 - y0) * (x1-x0) + x0; if (x_inter < x) winding += (y0 < y1) ? 1 : -1; } } if (verts[i].type == STBTT_vcurve) { int x0 = (int) verts[i-1].x , y0 = (int) verts[i-1].y ; int x1 = (int) verts[i ].cx, y1 = (int) verts[i ].cy; int x2 = (int) verts[i ].x , y2 = (int) verts[i ].y ; int ax = STBTT_min(x0,STBTT_min(x1,x2)), ay = STBTT_min(y0,STBTT_min(y1,y2)); int by = STBTT_max(y0,STBTT_max(y1,y2)); if (y > ay && y < by && x > ax) { float q0[2],q1[2],q2[2]; float hits[2][2]; q0[0] = (float)x0; q0[1] = (float)y0; q1[0] = (float)x1; q1[1] = (float)y1; q2[0] = (float)x2; q2[1] = (float)y2; if (equal(q0,q1) || equal(q1,q2)) { x0 = (int)verts[i-1].x; y0 = (int)verts[i-1].y; x1 = (int)verts[i ].x; y1 = (int)verts[i ].y; if (y > STBTT_min(y0,y1) && y < STBTT_max(y0,y1) && x > STBTT_min(x0,x1)) { float x_inter = (y - y0) / (y1 - y0) * (x1-x0) + x0; if (x_inter < x) winding += (y0 < y1) ? 1 : -1; } } else { int num_hits = stbtt__ray_intersect_bezier(orig, ray, q0, q1, q2, hits); if (num_hits >= 1) if (hits[0][0] < 0) winding += (hits[0][1] < 0 ? -1 : 1); if (num_hits >= 2) if (hits[1][0] < 0) winding += (hits[1][1] < 0 ? -1 : 1); } } } } return winding; } static float stbtt__cuberoot( float x ) { if (x<0) return -(float) STBTT_pow(-x,1.0f/3.0f); else return (float) STBTT_pow( x,1.0f/3.0f); } // x^3 + a*x^2 + b*x + c = 0 static int stbtt__solve_cubic(float a, float b, float c, float* r) { float s = -a / 3; float p = b - a*a / 3; float q = a * (2*a*a - 9*b) / 27 + c; float p3 = p*p*p; float d = q*q + 4*p3 / 27; if (d >= 0) { float z = (float) STBTT_sqrt(d); float u = (-q + z) / 2; float v = (-q - z) / 2; u = stbtt__cuberoot(u); v = stbtt__cuberoot(v); r[0] = s + u + v; return 1; } else { float u = (float) STBTT_sqrt(-p/3); float v = (float) STBTT_acos(-STBTT_sqrt(-27/p3) * q / 2) / 3; // p3 must be negative, since d is negative float m = (float) STBTT_cos(v); float n = (float) STBTT_cos(v-3.141592/2)*1.732050808f; r[0] = s + u * 2 * m; r[1] = s - u * (m + n); r[2] = s - u * (m - n); //STBTT_assert( STBTT_fabs(((r[0]+a)*r[0]+b)*r[0]+c) < 0.05f); // these asserts may not be safe at all scales, though they're in bezier t parameter units so maybe? //STBTT_assert( STBTT_fabs(((r[1]+a)*r[1]+b)*r[1]+c) < 0.05f); //STBTT_assert( STBTT_fabs(((r[2]+a)*r[2]+b)*r[2]+c) < 0.05f); return 3; } } STBTT_DEF unsigned char * stbtt_GetGlyphSDF(const stbtt_fontinfo *info, float scale, int glyph, int padding, unsigned char onedge_value, float pixel_dist_scale, int *width, int *height, int *xoff, int *yoff) { float scale_x = scale, scale_y = scale; int ix0,iy0,ix1,iy1; int w,h; unsigned char *data; if (scale == 0) return NULL; stbtt_GetGlyphBitmapBoxSubpixel(info, glyph, scale, scale, 0.0f,0.0f, &ix0,&iy0,&ix1,&iy1); // if empty, return NULL if (ix0 == ix1 || iy0 == iy1) return NULL; ix0 -= padding; iy0 -= padding; ix1 += padding; iy1 += padding; w = (ix1 - ix0); h = (iy1 - iy0); if (width ) *width = w; if (height) *height = h; if (xoff ) *xoff = ix0; if (yoff ) *yoff = iy0; // invert for y-downwards bitmaps scale_y = -scale_y; { int x,y,i,j; float *precompute; stbtt_vertex *verts; int num_verts = stbtt_GetGlyphShape(info, glyph, &verts); data = (unsigned char *) STBTT_malloc(w * h, info->userdata); precompute = (float *) STBTT_malloc(num_verts * sizeof(float), info->userdata); for (i=0,j=num_verts-1; i < num_verts; j=i++) { if (verts[i].type == STBTT_vline) { float x0 = verts[i].x*scale_x, y0 = verts[i].y*scale_y; float x1 = verts[j].x*scale_x, y1 = verts[j].y*scale_y; float dist = (float) STBTT_sqrt((x1-x0)*(x1-x0) + (y1-y0)*(y1-y0)); precompute[i] = (dist == 0) ? 0.0f : 1.0f / dist; } else if (verts[i].type == STBTT_vcurve) { float x2 = verts[j].x *scale_x, y2 = verts[j].y *scale_y; float x1 = verts[i].cx*scale_x, y1 = verts[i].cy*scale_y; float x0 = verts[i].x *scale_x, y0 = verts[i].y *scale_y; float bx = x0 - 2*x1 + x2, by = y0 - 2*y1 + y2; float len2 = bx*bx + by*by; if (len2 != 0.0f) precompute[i] = 1.0f / (bx*bx + by*by); else precompute[i] = 0.0f; } else precompute[i] = 0.0f; } for (y=iy0; y < iy1; ++y) { for (x=ix0; x < ix1; ++x) { float val; float min_dist = 999999.0f; float sx = (float) x + 0.5f; float sy = (float) y + 0.5f; float x_gspace = (sx / scale_x); float y_gspace = (sy / scale_y); int winding = stbtt__compute_crossings_x(x_gspace, y_gspace, num_verts, verts); // @OPTIMIZE: this could just be a rasterization, but needs to be line vs. non-tesselated curves so a new path for (i=0; i < num_verts; ++i) { float x0 = verts[i].x*scale_x, y0 = verts[i].y*scale_y; if (verts[i].type == STBTT_vline && precompute[i] != 0.0f) { float x1 = verts[i-1].x*scale_x, y1 = verts[i-1].y*scale_y; float dist,dist2 = (x0-sx)*(x0-sx) + (y0-sy)*(y0-sy); if (dist2 < min_dist*min_dist) min_dist = (float) STBTT_sqrt(dist2); // coarse culling against bbox //if (sx > STBTT_min(x0,x1)-min_dist && sx < STBTT_max(x0,x1)+min_dist && // sy > STBTT_min(y0,y1)-min_dist && sy < STBTT_max(y0,y1)+min_dist) dist = (float) STBTT_fabs((x1-x0)*(y0-sy) - (y1-y0)*(x0-sx)) * precompute[i]; STBTT_assert(i != 0); if (dist < min_dist) { // check position along line // x' = x0 + t*(x1-x0), y' = y0 + t*(y1-y0) // minimize (x'-sx)*(x'-sx)+(y'-sy)*(y'-sy) float dx = x1-x0, dy = y1-y0; float px = x0-sx, py = y0-sy; // minimize (px+t*dx)^2 + (py+t*dy)^2 = px*px + 2*px*dx*t + t^2*dx*dx + py*py + 2*py*dy*t + t^2*dy*dy // derivative: 2*px*dx + 2*py*dy + (2*dx*dx+2*dy*dy)*t, set to 0 and solve float t = -(px*dx + py*dy) / (dx*dx + dy*dy); if (t >= 0.0f && t <= 1.0f) min_dist = dist; } } else if (verts[i].type == STBTT_vcurve) { float x2 = verts[i-1].x *scale_x, y2 = verts[i-1].y *scale_y; float x1 = verts[i ].cx*scale_x, y1 = verts[i ].cy*scale_y; float box_x0 = STBTT_min(STBTT_min(x0,x1),x2); float box_y0 = STBTT_min(STBTT_min(y0,y1),y2); float box_x1 = STBTT_max(STBTT_max(x0,x1),x2); float box_y1 = STBTT_max(STBTT_max(y0,y1),y2); // coarse culling against bbox to avoid computing cubic unnecessarily if (sx > box_x0-min_dist && sx < box_x1+min_dist && sy > box_y0-min_dist && sy < box_y1+min_dist) { int num=0; float ax = x1-x0, ay = y1-y0; float bx = x0 - 2*x1 + x2, by = y0 - 2*y1 + y2; float mx = x0 - sx, my = y0 - sy; float res[3] = {0.f,0.f,0.f}; float px,py,t,it,dist2; float a_inv = precompute[i]; if (a_inv == 0.0) { // if a_inv is 0, it's 2nd degree so use quadratic formula float a = 3*(ax*bx + ay*by); float b = 2*(ax*ax + ay*ay) + (mx*bx+my*by); float c = mx*ax+my*ay; if (a == 0.0) { // if a is 0, it's linear if (b != 0.0) { res[num++] = -c/b; } } else { float discriminant = b*b - 4*a*c; if (discriminant < 0) num = 0; else { float root = (float) STBTT_sqrt(discriminant); res[0] = (-b - root)/(2*a); res[1] = (-b + root)/(2*a); num = 2; // don't bother distinguishing 1-solution case, as code below will still work } } } else { float b = 3*(ax*bx + ay*by) * a_inv; // could precompute this as it doesn't depend on sample point float c = (2*(ax*ax + ay*ay) + (mx*bx+my*by)) * a_inv; float d = (mx*ax+my*ay) * a_inv; num = stbtt__solve_cubic(b, c, d, res); } dist2 = (x0-sx)*(x0-sx) + (y0-sy)*(y0-sy); if (dist2 < min_dist*min_dist) min_dist = (float) STBTT_sqrt(dist2); if (num >= 1 && res[0] >= 0.0f && res[0] <= 1.0f) { t = res[0], it = 1.0f - t; px = it*it*x0 + 2*t*it*x1 + t*t*x2; py = it*it*y0 + 2*t*it*y1 + t*t*y2; dist2 = (px-sx)*(px-sx) + (py-sy)*(py-sy); if (dist2 < min_dist * min_dist) min_dist = (float) STBTT_sqrt(dist2); } if (num >= 2 && res[1] >= 0.0f && res[1] <= 1.0f) { t = res[1], it = 1.0f - t; px = it*it*x0 + 2*t*it*x1 + t*t*x2; py = it*it*y0 + 2*t*it*y1 + t*t*y2; dist2 = (px-sx)*(px-sx) + (py-sy)*(py-sy); if (dist2 < min_dist * min_dist) min_dist = (float) STBTT_sqrt(dist2); } if (num >= 3 && res[2] >= 0.0f && res[2] <= 1.0f) { t = res[2], it = 1.0f - t; px = it*it*x0 + 2*t*it*x1 + t*t*x2; py = it*it*y0 + 2*t*it*y1 + t*t*y2; dist2 = (px-sx)*(px-sx) + (py-sy)*(py-sy); if (dist2 < min_dist * min_dist) min_dist = (float) STBTT_sqrt(dist2); } } } } if (winding == 0) min_dist = -min_dist; // if outside the shape, value is negative val = onedge_value + pixel_dist_scale * min_dist; if (val < 0) val = 0; else if (val > 255) val = 255; data[(y-iy0)*w+(x-ix0)] = (unsigned char) val; } } STBTT_free(precompute, info->userdata); STBTT_free(verts, info->userdata); } return data; } STBTT_DEF unsigned char * stbtt_GetCodepointSDF(const stbtt_fontinfo *info, float scale, int codepoint, int padding, unsigned char onedge_value, float pixel_dist_scale, int *width, int *height, int *xoff, int *yoff) { return stbtt_GetGlyphSDF(info, scale, stbtt_FindGlyphIndex(info, codepoint), padding, onedge_value, pixel_dist_scale, width, height, xoff, yoff); } STBTT_DEF void stbtt_FreeSDF(unsigned char *bitmap, void *userdata) { STBTT_free(bitmap, userdata); } ////////////////////////////////////////////////////////////////////////////// // // font name matching -- recommended not to use this // // check if a utf8 string contains a prefix which is the utf16 string; if so return length of matching utf8 string static stbtt_int32 stbtt__CompareUTF8toUTF16_bigendian_prefix(stbtt_uint8 *s1, stbtt_int32 len1, stbtt_uint8 *s2, stbtt_int32 len2) { stbtt_int32 i=0; // convert utf16 to utf8 and compare the results while converting while (len2) { stbtt_uint16 ch = s2[0]*256 + s2[1]; if (ch < 0x80) { if (i >= len1) return -1; if (s1[i++] != ch) return -1; } else if (ch < 0x800) { if (i+1 >= len1) return -1; if (s1[i++] != 0xc0 + (ch >> 6)) return -1; if (s1[i++] != 0x80 + (ch & 0x3f)) return -1; } else if (ch >= 0xd800 && ch < 0xdc00) { stbtt_uint32 c; stbtt_uint16 ch2 = s2[2]*256 + s2[3]; if (i+3 >= len1) return -1; c = ((ch - 0xd800) << 10) + (ch2 - 0xdc00) + 0x10000; if (s1[i++] != 0xf0 + (c >> 18)) return -1; if (s1[i++] != 0x80 + ((c >> 12) & 0x3f)) return -1; if (s1[i++] != 0x80 + ((c >> 6) & 0x3f)) return -1; if (s1[i++] != 0x80 + ((c ) & 0x3f)) return -1; s2 += 2; // plus another 2 below len2 -= 2; } else if (ch >= 0xdc00 && ch < 0xe000) { return -1; } else { if (i+2 >= len1) return -1; if (s1[i++] != 0xe0 + (ch >> 12)) return -1; if (s1[i++] != 0x80 + ((ch >> 6) & 0x3f)) return -1; if (s1[i++] != 0x80 + ((ch ) & 0x3f)) return -1; } s2 += 2; len2 -= 2; } return i; } static int stbtt_CompareUTF8toUTF16_bigendian_internal(char *s1, int len1, char *s2, int len2) { return len1 == stbtt__CompareUTF8toUTF16_bigendian_prefix((stbtt_uint8*) s1, len1, (stbtt_uint8*) s2, len2); } // returns results in whatever encoding you request... but note that 2-byte encodings // will be BIG-ENDIAN... use stbtt_CompareUTF8toUTF16_bigendian() to compare STBTT_DEF const char *stbtt_GetFontNameString(const stbtt_fontinfo *font, int *length, int platformID, int encodingID, int languageID, int nameID) { stbtt_int32 i,count,stringOffset; stbtt_uint8 *fc = font->data; stbtt_uint32 offset = font->fontstart; stbtt_uint32 nm = stbtt__find_table(fc, offset, "name"); if (!nm) return NULL; count = ttUSHORT(fc+nm+2); stringOffset = nm + ttUSHORT(fc+nm+4); for (i=0; i < count; ++i) { stbtt_uint32 loc = nm + 6 + 12 * i; if (platformID == ttUSHORT(fc+loc+0) && encodingID == ttUSHORT(fc+loc+2) && languageID == ttUSHORT(fc+loc+4) && nameID == ttUSHORT(fc+loc+6)) { *length = ttUSHORT(fc+loc+8); return (const char *) (fc+stringOffset+ttUSHORT(fc+loc+10)); } } return NULL; } static int stbtt__matchpair(stbtt_uint8 *fc, stbtt_uint32 nm, stbtt_uint8 *name, stbtt_int32 nlen, stbtt_int32 target_id, stbtt_int32 next_id) { stbtt_int32 i; stbtt_int32 count = ttUSHORT(fc+nm+2); stbtt_int32 stringOffset = nm + ttUSHORT(fc+nm+4); for (i=0; i < count; ++i) { stbtt_uint32 loc = nm + 6 + 12 * i; stbtt_int32 id = ttUSHORT(fc+loc+6); if (id == target_id) { // find the encoding stbtt_int32 platform = ttUSHORT(fc+loc+0), encoding = ttUSHORT(fc+loc+2), language = ttUSHORT(fc+loc+4); // is this a Unicode encoding? if (platform == 0 || (platform == 3 && encoding == 1) || (platform == 3 && encoding == 10)) { stbtt_int32 slen = ttUSHORT(fc+loc+8); stbtt_int32 off = ttUSHORT(fc+loc+10); // check if there's a prefix match stbtt_int32 matchlen = stbtt__CompareUTF8toUTF16_bigendian_prefix(name, nlen, fc+stringOffset+off,slen); if (matchlen >= 0) { // check for target_id+1 immediately following, with same encoding & language if (i+1 < count && ttUSHORT(fc+loc+12+6) == next_id && ttUSHORT(fc+loc+12) == platform && ttUSHORT(fc+loc+12+2) == encoding && ttUSHORT(fc+loc+12+4) == language) { slen = ttUSHORT(fc+loc+12+8); off = ttUSHORT(fc+loc+12+10); if (slen == 0) { if (matchlen == nlen) return 1; } else if (matchlen < nlen && name[matchlen] == ' ') { ++matchlen; if (stbtt_CompareUTF8toUTF16_bigendian_internal((char*) (name+matchlen), nlen-matchlen, (char*)(fc+stringOffset+off),slen)) return 1; } } else { // if nothing immediately following if (matchlen == nlen) return 1; } } } // @TODO handle other encodings } } return 0; } static int stbtt__matches(stbtt_uint8 *fc, stbtt_uint32 offset, stbtt_uint8 *name, stbtt_int32 flags) { stbtt_int32 nlen = (stbtt_int32) STBTT_strlen((char *) name); stbtt_uint32 nm,hd; if (!stbtt__isfont(fc+offset)) return 0; // check italics/bold/underline flags in macStyle... if (flags) { hd = stbtt__find_table(fc, offset, "head"); if ((ttUSHORT(fc+hd+44) & 7) != (flags & 7)) return 0; } nm = stbtt__find_table(fc, offset, "name"); if (!nm) return 0; if (flags) { // if we checked the macStyle flags, then just check the family and ignore the subfamily if (stbtt__matchpair(fc, nm, name, nlen, 16, -1)) return 1; if (stbtt__matchpair(fc, nm, name, nlen, 1, -1)) return 1; if (stbtt__matchpair(fc, nm, name, nlen, 3, -1)) return 1; } else { if (stbtt__matchpair(fc, nm, name, nlen, 16, 17)) return 1; if (stbtt__matchpair(fc, nm, name, nlen, 1, 2)) return 1; if (stbtt__matchpair(fc, nm, name, nlen, 3, -1)) return 1; } return 0; } static int stbtt_FindMatchingFont_internal(unsigned char *font_collection, char *name_utf8, stbtt_int32 flags) { stbtt_int32 i; for (i=0;;++i) { stbtt_int32 off = stbtt_GetFontOffsetForIndex(font_collection, i); if (off < 0) return off; if (stbtt__matches((stbtt_uint8 *) font_collection, off, (stbtt_uint8*) name_utf8, flags)) return off; } } #if defined(__GNUC__) || defined(__clang__) #pragma GCC diagnostic push #pragma GCC diagnostic ignored "-Wcast-qual" #endif STBTT_DEF int stbtt_BakeFontBitmap(const unsigned char *data, int offset, float pixel_height, unsigned char *pixels, int pw, int ph, int first_char, int num_chars, stbtt_bakedchar *chardata) { return stbtt_BakeFontBitmap_internal((unsigned char *) data, offset, pixel_height, pixels, pw, ph, first_char, num_chars, chardata); } STBTT_DEF int stbtt_GetFontOffsetForIndex(const unsigned char *data, int index) { return stbtt_GetFontOffsetForIndex_internal((unsigned char *) data, index); } STBTT_DEF int stbtt_GetNumberOfFonts(const unsigned char *data) { return stbtt_GetNumberOfFonts_internal((unsigned char *) data); } STBTT_DEF int stbtt_InitFont(stbtt_fontinfo *info, const unsigned char *data, int offset) { return stbtt_InitFont_internal(info, (unsigned char *) data, offset); } STBTT_DEF int stbtt_FindMatchingFont(const unsigned char *fontdata, const char *name, int flags) { return stbtt_FindMatchingFont_internal((unsigned char *) fontdata, (char *) name, flags); } STBTT_DEF int stbtt_CompareUTF8toUTF16_bigendian(const char *s1, int len1, const char *s2, int len2) { return stbtt_CompareUTF8toUTF16_bigendian_internal((char *) s1, len1, (char *) s2, len2); } #if defined(__GNUC__) || defined(__clang__) #pragma GCC diagnostic pop #endif #endif // STB_TRUETYPE_IMPLEMENTATION // FULL VERSION HISTORY // // 1.25 (2021-07-11) many fixes // 1.24 (2020-02-05) fix warning // 1.23 (2020-02-02) query SVG data for glyphs; query whole kerning table (but only kern not GPOS) // 1.22 (2019-08-11) minimize missing-glyph duplication; fix kerning if both 'GPOS' and 'kern' are defined // 1.21 (2019-02-25) fix warning // 1.20 (2019-02-07) PackFontRange skips missing codepoints; GetScaleFontVMetrics() // 1.19 (2018-02-11) OpenType GPOS kerning (horizontal only), STBTT_fmod // 1.18 (2018-01-29) add missing function // 1.17 (2017-07-23) make more arguments const; doc fix // 1.16 (2017-07-12) SDF support // 1.15 (2017-03-03) make more arguments const // 1.14 (2017-01-16) num-fonts-in-TTC function // 1.13 (2017-01-02) support OpenType fonts, certain Apple fonts // 1.12 (2016-10-25) suppress warnings about casting away const with -Wcast-qual // 1.11 (2016-04-02) fix unused-variable warning // 1.10 (2016-04-02) allow user-defined fabs() replacement // fix memory leak if fontsize=0.0 // fix warning from duplicate typedef // 1.09 (2016-01-16) warning fix; avoid crash on outofmem; use alloc userdata for PackFontRanges // 1.08 (2015-09-13) document stbtt_Rasterize(); fixes for vertical & horizontal edges // 1.07 (2015-08-01) allow PackFontRanges to accept arrays of sparse codepoints; // allow PackFontRanges to pack and render in separate phases; // fix stbtt_GetFontOFfsetForIndex (never worked for non-0 input?); // fixed an assert() bug in the new rasterizer // replace assert() with STBTT_assert() in new rasterizer // 1.06 (2015-07-14) performance improvements (~35% faster on x86 and x64 on test machine) // also more precise AA rasterizer, except if shapes overlap // remove need for STBTT_sort // 1.05 (2015-04-15) fix misplaced definitions for STBTT_STATIC // 1.04 (2015-04-15) typo in example // 1.03 (2015-04-12) STBTT_STATIC, fix memory leak in new packing, various fixes // 1.02 (2014-12-10) fix various warnings & compile issues w/ stb_rect_pack, C++ // 1.01 (2014-12-08) fix subpixel position when oversampling to exactly match // non-oversampled; STBTT_POINT_SIZE for packed case only // 1.00 (2014-12-06) add new PackBegin etc. API, w/ support for oversampling // 0.99 (2014-09-18) fix multiple bugs with subpixel rendering (ryg) // 0.9 (2014-08-07) support certain mac/iOS fonts without an MS platformID // 0.8b (2014-07-07) fix a warning // 0.8 (2014-05-25) fix a few more warnings // 0.7 (2013-09-25) bugfix: subpixel glyph bug fixed in 0.5 had come back // 0.6c (2012-07-24) improve documentation // 0.6b (2012-07-20) fix a few more warnings // 0.6 (2012-07-17) fix warnings; added stbtt_ScaleForMappingEmToPixels, // stbtt_GetFontBoundingBox, stbtt_IsGlyphEmpty // 0.5 (2011-12-09) bugfixes: // subpixel glyph renderer computed wrong bounding box // first vertex of shape can be off-curve (FreeSans) // 0.4b (2011-12-03) fixed an error in the font baking example // 0.4 (2011-12-01) kerning, subpixel rendering (tor) // bugfixes for: // codepoint-to-glyph conversion using table fmt=12 // codepoint-to-glyph conversion using table fmt=4 // stbtt_GetBakedQuad with non-square texture (Zer) // updated Hello World! sample to use kerning and subpixel // fixed some warnings // 0.3 (2009-06-24) cmap fmt=12, compound shapes (MM) // userdata, malloc-from-userdata, non-zero fill (stb) // 0.2 (2009-03-11) Fix unsigned/signed char warnings // 0.1 (2009-03-09) First public release // /* ------------------------------------------------------------------------------ This software is available under 2 licenses -- choose whichever you prefer. ------------------------------------------------------------------------------ ALTERNATIVE A - MIT License Copyright (c) 2017 Sean Barrett Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ------------------------------------------------------------------------------ ALTERNATIVE B - Public Domain (www.unlicense.org) This is free and unencumbered software released into the public domain. Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means. In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ------------------------------------------------------------------------------ */ ================================================ FILE: src/DesktopPlusUI/imgui_win32_dx11_openvr/PixelShaderImGui.hlsl ================================================ struct PS_INPUT { float4 pos : SV_POSITION; float4 col : COLOR0; float2 uv : TEXCOORD0; }; sampler sampler0; Texture2D texture0; float4 PS(PS_INPUT input) : SV_Target { return input.col * texture0.Sample(sampler0, input.uv); } ================================================ FILE: src/DesktopPlusUI/imgui_win32_dx11_openvr/VertexShaderImGui.hlsl ================================================ cbuffer vertexBuffer : register(b0) { float4x4 ProjectionMatrix; }; struct VS_INPUT { float2 pos : POSITION; float4 col : COLOR0; float2 uv : TEXCOORD0; }; struct PS_INPUT { float4 pos : SV_POSITION; float4 col : COLOR0; float2 uv : TEXCOORD0; }; PS_INPUT VS(VS_INPUT input) { PS_INPUT output; output.pos = mul(ProjectionMatrix, float4(input.pos.xy, 0.f, 1.f)); output.col = input.col; output.uv = input.uv; return output; } ================================================ FILE: src/DesktopPlusUI/imgui_win32_dx11_openvr/imgui_impl_dx11_openvr.cpp ================================================ // Desktop+UI: Modified for OpenVR compatibility // dear imgui: Renderer Backend for DirectX11 // This needs to be used along with a Platform Backend (e.g. Win32) // Implemented features: // [X] Renderer: User texture binding. Use 'ID3D11ShaderResourceView*' as ImTextureID. Read the FAQ about ImTextureID! // [X] Renderer: Large meshes support (64k+ vertices) even with 16-bit indices (ImGuiBackendFlags_RendererHasVtxOffset). // [X] Renderer: Expose selected render state for draw callbacks to use. Access in '(ImGui_ImplXXXX_RenderState*)GetPlatformIO().Renderer_RenderState'. // You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this. // Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need. // Learn about Dear ImGui: // - FAQ https://dearimgui.com/faq // - Getting Started https://dearimgui.com/getting-started // - Documentation https://dearimgui.com/docs (same as your local docs/ folder). // - Introduction, links and more at the top of imgui.cpp // CHANGELOG // (minor and older changes stripped away, please see git history for details) // 2025-01-06: DirectX11: Expose VertexConstantBuffer in ImGui_ImplDX11_RenderState. Reset projection matrix in ImDrawCallback_ResetRenderState handler. // 2024-10-07: DirectX11: Changed default texture sampler to Clamp instead of Repeat/Wrap. // 2024-10-07: DirectX11: Expose selected render state in ImGui_ImplDX11_RenderState, which you can access in 'void* platform_io.Renderer_RenderState' during draw callbacks. // 2022-10-11: Using 'nullptr' instead of 'NULL' as per our switch to C++11. // 2021-06-29: Reorganized backend to pull data from a single structure to facilitate usage with multiple-contexts (all g_XXXX access changed to bd->XXXX). // 2021-05-19: DirectX11: Replaced direct access to ImDrawCmd::TextureId with a call to ImDrawCmd::GetTexID(). (will become a requirement) // 2021-02-18: DirectX11: Change blending equation to preserve alpha in output buffer. // 2019-08-01: DirectX11: Fixed code querying the Geometry Shader state (would generally error with Debug layer enabled). // 2019-07-21: DirectX11: Backup, clear and restore Geometry Shader is any is bound when calling ImGui_ImplDX11_RenderDrawData. Clearing Hull/Domain/Compute shaders without backup/restore. // 2019-05-29: DirectX11: Added support for large mesh (64K+ vertices), enable ImGuiBackendFlags_RendererHasVtxOffset flag. // 2019-04-30: DirectX11: Added support for special ImDrawCallback_ResetRenderState callback to reset render state. // 2018-12-03: Misc: Added #pragma comment statement to automatically link with d3dcompiler.lib when using D3DCompile(). // 2018-11-30: Misc: Setting up io.BackendRendererName so it can be displayed in the About Window. // 2018-08-01: DirectX11: Querying for IDXGIFactory instead of IDXGIFactory1 to increase compatibility. // 2018-07-13: DirectX11: Fixed unreleased resources in Init and Shutdown functions. // 2018-06-08: Misc: Extracted imgui_impl_dx11.cpp/.h away from the old combined DX11+Win32 example. // 2018-06-08: DirectX11: Use draw_data->DisplayPos and draw_data->DisplaySize to setup projection matrix and clipping rectangle. // 2018-02-16: Misc: Obsoleted the io.RenderDrawListsFn callback and exposed ImGui_ImplDX11_RenderDrawData() in the .h file so you can call it yourself. // 2018-02-06: Misc: Removed call to ImGui::Shutdown() which is not available from 1.60 WIP, user needs to call CreateContext/DestroyContext themselves. // 2016-05-07: DirectX11: Disabling depth-write. #include "imgui.h" #ifndef IMGUI_DISABLE #include "imgui_impl_dx11_openvr.h" // DirectX #include #include #include "VertexShaderImGui.h" #include "PixelShaderImGui.h" // DirectX11 data struct ImGui_ImplDX11_Data { ID3D11Device* pd3dDevice; ID3D11DeviceContext* pd3dDeviceContext; IDXGIFactory* pFactory; ID3D11Buffer* pVB; ID3D11Buffer* pIB; ID3D11VertexShader* pVertexShader; ID3D11InputLayout* pInputLayout; ID3D11Buffer* pVertexConstantBuffer; ID3D11PixelShader* pPixelShader; ID3D11SamplerState* pFontSampler; ID3D11ShaderResourceView* pFontTextureView; ID3D11RasterizerState* pRasterizerState; ID3D11BlendState* pBlendState; ID3D11DepthStencilState* pDepthStencilState; int VertexBufferSize; int IndexBufferSize; ImGui_ImplDX11_Data() { memset((void*)this, 0, sizeof(*this)); VertexBufferSize = 5000; IndexBufferSize = 10000; } }; struct VERTEX_CONSTANT_BUFFER_DX11 { float mvp[4][4]; }; // Backend data stored in io.BackendRendererUserData to allow support for multiple Dear ImGui contexts // It is STRONGLY preferred that you use docking branch with multi-viewports (== single Dear ImGui context + multiple windows) instead of multiple Dear ImGui contexts. static ImGui_ImplDX11_Data* ImGui_ImplDX11_GetBackendData() { return ImGui::GetCurrentContext() ? (ImGui_ImplDX11_Data*)ImGui::GetIO().BackendRendererUserData : nullptr; } // Functions static void ImGui_ImplDX11_SetupRenderState(ImDrawData* draw_data, ID3D11DeviceContext* device_ctx) { ImGui_ImplDX11_Data* bd = ImGui_ImplDX11_GetBackendData(); // Setup viewport D3D11_VIEWPORT vp = {}; vp.Width = draw_data->DisplaySize.x; vp.Height = draw_data->DisplaySize.y; vp.MinDepth = 0.0f; vp.MaxDepth = 1.0f; vp.TopLeftX = vp.TopLeftY = 0; device_ctx->RSSetViewports(1, &vp); // Setup orthographic projection matrix into our constant buffer // Our visible imgui space lies from draw_data->DisplayPos (top left) to draw_data->DisplayPos+data_data->DisplaySize (bottom right). DisplayPos is (0,0) for single viewport apps. D3D11_MAPPED_SUBRESOURCE mapped_resource; if (device_ctx->Map(bd->pVertexConstantBuffer, 0, D3D11_MAP_WRITE_DISCARD, 0, &mapped_resource) == S_OK) { VERTEX_CONSTANT_BUFFER_DX11* constant_buffer = (VERTEX_CONSTANT_BUFFER_DX11*)mapped_resource.pData; float L = draw_data->DisplayPos.x; float R = draw_data->DisplayPos.x + draw_data->DisplaySize.x; float T = draw_data->DisplayPos.y; float B = draw_data->DisplayPos.y + draw_data->DisplaySize.y; float mvp[4][4] = { { 2.0f/(R-L), 0.0f, 0.0f, 0.0f }, { 0.0f, 2.0f/(T-B), 0.0f, 0.0f }, { 0.0f, 0.0f, 0.5f, 0.0f }, { (R+L)/(L-R), (T+B)/(B-T), 0.5f, 1.0f }, }; memcpy(&constant_buffer->mvp, mvp, sizeof(mvp)); device_ctx->Unmap(bd->pVertexConstantBuffer, 0); } // Setup shader and vertex buffers unsigned int stride = sizeof(ImDrawVert); unsigned int offset = 0; device_ctx->IASetInputLayout(bd->pInputLayout); device_ctx->IASetVertexBuffers(0, 1, &bd->pVB, &stride, &offset); device_ctx->IASetIndexBuffer(bd->pIB, sizeof(ImDrawIdx) == 2 ? DXGI_FORMAT_R16_UINT : DXGI_FORMAT_R32_UINT, 0); device_ctx->IASetPrimitiveTopology(D3D11_PRIMITIVE_TOPOLOGY_TRIANGLELIST); device_ctx->VSSetShader(bd->pVertexShader, nullptr, 0); device_ctx->VSSetConstantBuffers(0, 1, &bd->pVertexConstantBuffer); device_ctx->PSSetShader(bd->pPixelShader, nullptr, 0); device_ctx->PSSetSamplers(0, 1, &bd->pFontSampler); device_ctx->GSSetShader(nullptr, nullptr, 0); device_ctx->HSSetShader(nullptr, nullptr, 0); // In theory we should backup and restore this as well.. very infrequently used.. device_ctx->DSSetShader(nullptr, nullptr, 0); // In theory we should backup and restore this as well.. very infrequently used.. device_ctx->CSSetShader(nullptr, nullptr, 0); // In theory we should backup and restore this as well.. very infrequently used.. // Setup render state const float blend_factor[4] = { 0.f, 0.f, 0.f, 0.f }; device_ctx->OMSetBlendState(bd->pBlendState, blend_factor, 0xffffffff); device_ctx->OMSetDepthStencilState(bd->pDepthStencilState, 0); device_ctx->RSSetState(bd->pRasterizerState); } // Render function void ImGui_ImplDX11_RenderDrawData(ImDrawData* draw_data) { // Avoid rendering when minimized if (draw_data->DisplaySize.x <= 0.0f || draw_data->DisplaySize.y <= 0.0f) return; ImGui_ImplDX11_Data* bd = ImGui_ImplDX11_GetBackendData(); ID3D11DeviceContext* device = bd->pd3dDeviceContext; // Create and grow vertex/index buffers if needed if (!bd->pVB || bd->VertexBufferSize < draw_data->TotalVtxCount) { if (bd->pVB) { bd->pVB->Release(); bd->pVB = nullptr; } bd->VertexBufferSize = draw_data->TotalVtxCount + 5000; D3D11_BUFFER_DESC desc = {}; desc.Usage = D3D11_USAGE_DYNAMIC; desc.ByteWidth = bd->VertexBufferSize * sizeof(ImDrawVert); desc.BindFlags = D3D11_BIND_VERTEX_BUFFER; desc.CPUAccessFlags = D3D11_CPU_ACCESS_WRITE; desc.MiscFlags = 0; if (bd->pd3dDevice->CreateBuffer(&desc, nullptr, &bd->pVB) < 0) return; } if (!bd->pIB || bd->IndexBufferSize < draw_data->TotalIdxCount) { if (bd->pIB) { bd->pIB->Release(); bd->pIB = nullptr; } bd->IndexBufferSize = draw_data->TotalIdxCount + 10000; D3D11_BUFFER_DESC desc = {}; desc.Usage = D3D11_USAGE_DYNAMIC; desc.ByteWidth = bd->IndexBufferSize * sizeof(ImDrawIdx); desc.BindFlags = D3D11_BIND_INDEX_BUFFER; desc.CPUAccessFlags = D3D11_CPU_ACCESS_WRITE; if (bd->pd3dDevice->CreateBuffer(&desc, nullptr, &bd->pIB) < 0) return; } // Upload vertex/index data into a single contiguous GPU buffer D3D11_MAPPED_SUBRESOURCE vtx_resource, idx_resource; if (device->Map(bd->pVB, 0, D3D11_MAP_WRITE_DISCARD, 0, &vtx_resource) != S_OK) return; if (device->Map(bd->pIB, 0, D3D11_MAP_WRITE_DISCARD, 0, &idx_resource) != S_OK) return; ImDrawVert* vtx_dst = (ImDrawVert*)vtx_resource.pData; ImDrawIdx* idx_dst = (ImDrawIdx*)idx_resource.pData; for (int n = 0; n < draw_data->CmdListsCount; n++) { const ImDrawList* draw_list = draw_data->CmdLists[n]; memcpy(vtx_dst, draw_list->VtxBuffer.Data, draw_list->VtxBuffer.Size * sizeof(ImDrawVert)); memcpy(idx_dst, draw_list->IdxBuffer.Data, draw_list->IdxBuffer.Size * sizeof(ImDrawIdx)); vtx_dst += draw_list->VtxBuffer.Size; idx_dst += draw_list->IdxBuffer.Size; } device->Unmap(bd->pVB, 0); device->Unmap(bd->pIB, 0); // Backup DX state that will be modified to restore it afterwards (unfortunately this is very ugly looking and verbose. Close your eyes!) struct BACKUP_DX11_STATE { UINT ScissorRectsCount, ViewportsCount; D3D11_RECT ScissorRects[D3D11_VIEWPORT_AND_SCISSORRECT_OBJECT_COUNT_PER_PIPELINE]; D3D11_VIEWPORT Viewports[D3D11_VIEWPORT_AND_SCISSORRECT_OBJECT_COUNT_PER_PIPELINE]; ID3D11RasterizerState* RS; ID3D11BlendState* BlendState; FLOAT BlendFactor[4]; UINT SampleMask; UINT StencilRef; ID3D11DepthStencilState* DepthStencilState; ID3D11ShaderResourceView* PSShaderResource; ID3D11SamplerState* PSSampler; ID3D11PixelShader* PS; ID3D11VertexShader* VS; ID3D11GeometryShader* GS; UINT PSInstancesCount, VSInstancesCount, GSInstancesCount; ID3D11ClassInstance *PSInstances[256], *VSInstances[256], *GSInstances[256]; // 256 is max according to PSSetShader documentation D3D11_PRIMITIVE_TOPOLOGY PrimitiveTopology; ID3D11Buffer* IndexBuffer, *VertexBuffer, *VSConstantBuffer; UINT IndexBufferOffset, VertexBufferStride, VertexBufferOffset; DXGI_FORMAT IndexBufferFormat; ID3D11InputLayout* InputLayout; }; BACKUP_DX11_STATE old = {}; old.ScissorRectsCount = old.ViewportsCount = D3D11_VIEWPORT_AND_SCISSORRECT_OBJECT_COUNT_PER_PIPELINE; device->RSGetScissorRects(&old.ScissorRectsCount, old.ScissorRects); device->RSGetViewports(&old.ViewportsCount, old.Viewports); device->RSGetState(&old.RS); device->OMGetBlendState(&old.BlendState, old.BlendFactor, &old.SampleMask); device->OMGetDepthStencilState(&old.DepthStencilState, &old.StencilRef); device->PSGetShaderResources(0, 1, &old.PSShaderResource); device->PSGetSamplers(0, 1, &old.PSSampler); old.PSInstancesCount = old.VSInstancesCount = old.GSInstancesCount = 256; device->PSGetShader(&old.PS, old.PSInstances, &old.PSInstancesCount); device->VSGetShader(&old.VS, old.VSInstances, &old.VSInstancesCount); device->VSGetConstantBuffers(0, 1, &old.VSConstantBuffer); device->GSGetShader(&old.GS, old.GSInstances, &old.GSInstancesCount); device->IAGetPrimitiveTopology(&old.PrimitiveTopology); device->IAGetIndexBuffer(&old.IndexBuffer, &old.IndexBufferFormat, &old.IndexBufferOffset); device->IAGetVertexBuffers(0, 1, &old.VertexBuffer, &old.VertexBufferStride, &old.VertexBufferOffset); device->IAGetInputLayout(&old.InputLayout); // Setup desired DX state ImGui_ImplDX11_SetupRenderState(draw_data, device); // Setup render state structure (for callbacks and custom texture bindings) ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO(); ImGui_ImplDX11_RenderState render_state; render_state.Device = bd->pd3dDevice; render_state.DeviceContext = bd->pd3dDeviceContext; render_state.SamplerDefault = bd->pFontSampler; render_state.VertexConstantBuffer = bd->pVertexConstantBuffer; platform_io.Renderer_RenderState = &render_state; // Render command lists // (Because we merged all buffers into a single one, we maintain our own offset into them) int global_idx_offset = 0; int global_vtx_offset = 0; ImVec2 clip_off = draw_data->DisplayPos; for (int n = 0; n < draw_data->CmdListsCount; n++) { const ImDrawList* draw_list = draw_data->CmdLists[n]; for (int cmd_i = 0; cmd_i < draw_list->CmdBuffer.Size; cmd_i++) { const ImDrawCmd* pcmd = &draw_list->CmdBuffer[cmd_i]; if (pcmd->UserCallback != nullptr) { // User callback, registered via ImDrawList::AddCallback() // (ImDrawCallback_ResetRenderState is a special callback value used by the user to request the renderer to reset render state.) if (pcmd->UserCallback == ImDrawCallback_ResetRenderState) ImGui_ImplDX11_SetupRenderState(draw_data, device); else pcmd->UserCallback(draw_list, pcmd); } else { // Project scissor/clipping rectangles into framebuffer space ImVec2 clip_min(pcmd->ClipRect.x - clip_off.x, pcmd->ClipRect.y - clip_off.y); ImVec2 clip_max(pcmd->ClipRect.z - clip_off.x, pcmd->ClipRect.w - clip_off.y); if (clip_max.x <= clip_min.x || clip_max.y <= clip_min.y) continue; // Apply scissor/clipping rectangle const D3D11_RECT r = { (LONG)clip_min.x, (LONG)clip_min.y, (LONG)clip_max.x, (LONG)clip_max.y }; device->RSSetScissorRects(1, &r); // Bind texture, Draw ID3D11ShaderResourceView* texture_srv = (ID3D11ShaderResourceView*)pcmd->GetTexID(); device->PSSetShaderResources(0, 1, &texture_srv); device->DrawIndexed(pcmd->ElemCount, pcmd->IdxOffset + global_idx_offset, pcmd->VtxOffset + global_vtx_offset); } } global_idx_offset += draw_list->IdxBuffer.Size; global_vtx_offset += draw_list->VtxBuffer.Size; } platform_io.Renderer_RenderState = nullptr; // Restore modified DX state device->RSSetScissorRects(old.ScissorRectsCount, old.ScissorRects); device->RSSetViewports(old.ViewportsCount, old.Viewports); device->RSSetState(old.RS); if (old.RS) old.RS->Release(); device->OMSetBlendState(old.BlendState, old.BlendFactor, old.SampleMask); if (old.BlendState) old.BlendState->Release(); device->OMSetDepthStencilState(old.DepthStencilState, old.StencilRef); if (old.DepthStencilState) old.DepthStencilState->Release(); device->PSSetShaderResources(0, 1, &old.PSShaderResource); if (old.PSShaderResource) old.PSShaderResource->Release(); device->PSSetSamplers(0, 1, &old.PSSampler); if (old.PSSampler) old.PSSampler->Release(); device->PSSetShader(old.PS, old.PSInstances, old.PSInstancesCount); if (old.PS) old.PS->Release(); for (UINT i = 0; i < old.PSInstancesCount; i++) if (old.PSInstances[i]) old.PSInstances[i]->Release(); device->VSSetShader(old.VS, old.VSInstances, old.VSInstancesCount); if (old.VS) old.VS->Release(); device->VSSetConstantBuffers(0, 1, &old.VSConstantBuffer); if (old.VSConstantBuffer) old.VSConstantBuffer->Release(); device->GSSetShader(old.GS, old.GSInstances, old.GSInstancesCount); if (old.GS) old.GS->Release(); for (UINT i = 0; i < old.VSInstancesCount; i++) if (old.VSInstances[i]) old.VSInstances[i]->Release(); device->IASetPrimitiveTopology(old.PrimitiveTopology); device->IASetIndexBuffer(old.IndexBuffer, old.IndexBufferFormat, old.IndexBufferOffset); if (old.IndexBuffer) old.IndexBuffer->Release(); device->IASetVertexBuffers(0, 1, &old.VertexBuffer, &old.VertexBufferStride, &old.VertexBufferOffset); if (old.VertexBuffer) old.VertexBuffer->Release(); device->IASetInputLayout(old.InputLayout); if (old.InputLayout) old.InputLayout->Release(); } static void ImGui_ImplDX11_CreateFontsTexture() { // Build texture atlas ImGuiIO& io = ImGui::GetIO(); ImGui_ImplDX11_Data* bd = ImGui_ImplDX11_GetBackendData(); unsigned char* pixels; int width, height; io.Fonts->GetTexDataAsRGBA32(&pixels, &width, &height); // Upload texture to graphics system { D3D11_TEXTURE2D_DESC desc; ZeroMemory(&desc, sizeof(desc)); desc.Width = width; desc.Height = height; desc.MipLevels = 1; desc.ArraySize = 1; desc.Format = DXGI_FORMAT_R8G8B8A8_UNORM; desc.SampleDesc.Count = 1; desc.Usage = D3D11_USAGE_DEFAULT; desc.BindFlags = D3D11_BIND_SHADER_RESOURCE; desc.CPUAccessFlags = 0; ID3D11Texture2D* pTexture = nullptr; D3D11_SUBRESOURCE_DATA subResource; subResource.pSysMem = pixels; subResource.SysMemPitch = desc.Width * 4; subResource.SysMemSlicePitch = 0; bd->pd3dDevice->CreateTexture2D(&desc, &subResource, &pTexture); IM_ASSERT(pTexture != nullptr); // Create texture view D3D11_SHADER_RESOURCE_VIEW_DESC srvDesc; ZeroMemory(&srvDesc, sizeof(srvDesc)); srvDesc.Format = DXGI_FORMAT_R8G8B8A8_UNORM; srvDesc.ViewDimension = D3D11_SRV_DIMENSION_TEXTURE2D; srvDesc.Texture2D.MipLevels = desc.MipLevels; srvDesc.Texture2D.MostDetailedMip = 0; bd->pd3dDevice->CreateShaderResourceView(pTexture, &srvDesc, &bd->pFontTextureView); pTexture->Release(); } // Store our identifier io.Fonts->SetTexID((ImTextureID)bd->pFontTextureView); } static void ImGui_ImplDX11_DestroyFontsTexture() { ImGui_ImplDX11_Data* bd = ImGui_ImplDX11_GetBackendData(); if (bd->pFontTextureView) { bd->pFontTextureView->Release(); bd->pFontTextureView = nullptr; ImGui::GetIO().Fonts->SetTexID(0); // We copied data->pFontTextureView to io.Fonts->TexID so let's clear that as well. } } bool ImGui_ImplDX11_CreateDeviceObjects() { ImGui_ImplDX11_Data* bd = ImGui_ImplDX11_GetBackendData(); if (!bd->pd3dDevice) return false; if (bd->pFontSampler) ImGui_ImplDX11_InvalidateDeviceObjects(); // Create the vertex shader { if (bd->pd3dDevice->CreateVertexShader(g_VS, ARRAYSIZE(g_VS), nullptr, &bd->pVertexShader) != S_OK) return false; // Create the input layout D3D11_INPUT_ELEMENT_DESC local_layout[] = { { "POSITION", 0, DXGI_FORMAT_R32G32_FLOAT, 0, (UINT)offsetof(ImDrawVert, pos), D3D11_INPUT_PER_VERTEX_DATA, 0 }, { "TEXCOORD", 0, DXGI_FORMAT_R32G32_FLOAT, 0, (UINT)offsetof(ImDrawVert, uv), D3D11_INPUT_PER_VERTEX_DATA, 0 }, { "COLOR", 0, DXGI_FORMAT_R8G8B8A8_UNORM, 0, (UINT)offsetof(ImDrawVert, col), D3D11_INPUT_PER_VERTEX_DATA, 0 }, }; if (bd->pd3dDevice->CreateInputLayout(local_layout, 3, g_VS, ARRAYSIZE(g_VS), &bd->pInputLayout) != S_OK) return false; // Create the constant buffer { D3D11_BUFFER_DESC desc = {}; desc.ByteWidth = sizeof(VERTEX_CONSTANT_BUFFER_DX11); desc.Usage = D3D11_USAGE_DYNAMIC; desc.BindFlags = D3D11_BIND_CONSTANT_BUFFER; desc.CPUAccessFlags = D3D11_CPU_ACCESS_WRITE; desc.MiscFlags = 0; bd->pd3dDevice->CreateBuffer(&desc, nullptr, &bd->pVertexConstantBuffer); } } // Create the pixel shader { if (bd->pd3dDevice->CreatePixelShader(g_PS, ARRAYSIZE(g_PS), nullptr, &bd->pPixelShader) != S_OK) return false; } // Create the blending setup { D3D11_BLEND_DESC desc; ZeroMemory(&desc, sizeof(desc)); desc.AlphaToCoverageEnable = false; desc.RenderTarget[0].BlendEnable = true; desc.RenderTarget[0].SrcBlend = D3D11_BLEND_SRC_ALPHA; desc.RenderTarget[0].DestBlend = D3D11_BLEND_INV_SRC_ALPHA; desc.RenderTarget[0].BlendOp = D3D11_BLEND_OP_ADD; desc.RenderTarget[0].SrcBlendAlpha = D3D11_BLEND_ONE; desc.RenderTarget[0].DestBlendAlpha = D3D11_BLEND_INV_SRC_ALPHA; desc.RenderTarget[0].BlendOpAlpha = D3D11_BLEND_OP_ADD; desc.RenderTarget[0].RenderTargetWriteMask = D3D11_COLOR_WRITE_ENABLE_ALL; bd->pd3dDevice->CreateBlendState(&desc, &bd->pBlendState); } // Create the rasterizer state { D3D11_RASTERIZER_DESC desc; ZeroMemory(&desc, sizeof(desc)); desc.FillMode = D3D11_FILL_SOLID; desc.CullMode = D3D11_CULL_NONE; desc.ScissorEnable = true; desc.DepthClipEnable = true; bd->pd3dDevice->CreateRasterizerState(&desc, &bd->pRasterizerState); } // Create depth-stencil State { D3D11_DEPTH_STENCIL_DESC desc; ZeroMemory(&desc, sizeof(desc)); desc.DepthEnable = false; desc.DepthWriteMask = D3D11_DEPTH_WRITE_MASK_ALL; desc.DepthFunc = D3D11_COMPARISON_ALWAYS; desc.StencilEnable = false; desc.FrontFace.StencilFailOp = desc.FrontFace.StencilDepthFailOp = desc.FrontFace.StencilPassOp = D3D11_STENCIL_OP_KEEP; desc.FrontFace.StencilFunc = D3D11_COMPARISON_ALWAYS; desc.BackFace = desc.FrontFace; bd->pd3dDevice->CreateDepthStencilState(&desc, &bd->pDepthStencilState); } // Create texture sampler // (Bilinear sampling is required by default. Set 'io.Fonts->Flags |= ImFontAtlasFlags_NoBakedLines' or 'style.AntiAliasedLinesUseTex = false' to allow point/nearest sampling) { D3D11_SAMPLER_DESC desc; ZeroMemory(&desc, sizeof(desc)); desc.Filter = D3D11_FILTER_MIN_MAG_MIP_LINEAR; desc.AddressU = D3D11_TEXTURE_ADDRESS_CLAMP; desc.AddressV = D3D11_TEXTURE_ADDRESS_CLAMP; desc.AddressW = D3D11_TEXTURE_ADDRESS_CLAMP; desc.MipLODBias = 0.f; desc.ComparisonFunc = D3D11_COMPARISON_ALWAYS; desc.MinLOD = 0.f; desc.MaxLOD = 0.f; bd->pd3dDevice->CreateSamplerState(&desc, &bd->pFontSampler); } ImGui_ImplDX11_CreateFontsTexture(); return true; } void ImGui_ImplDX11_InvalidateDeviceObjects() { ImGui_ImplDX11_Data* bd = ImGui_ImplDX11_GetBackendData(); if (!bd->pd3dDevice) return; ImGui_ImplDX11_DestroyFontsTexture(); if (bd->pFontSampler) { bd->pFontSampler->Release(); bd->pFontSampler = nullptr; } if (bd->pIB) { bd->pIB->Release(); bd->pIB = nullptr; } if (bd->pVB) { bd->pVB->Release(); bd->pVB = nullptr; } if (bd->pBlendState) { bd->pBlendState->Release(); bd->pBlendState = nullptr; } if (bd->pDepthStencilState) { bd->pDepthStencilState->Release(); bd->pDepthStencilState = nullptr; } if (bd->pRasterizerState) { bd->pRasterizerState->Release(); bd->pRasterizerState = nullptr; } if (bd->pPixelShader) { bd->pPixelShader->Release(); bd->pPixelShader = nullptr; } if (bd->pVertexConstantBuffer) { bd->pVertexConstantBuffer->Release(); bd->pVertexConstantBuffer = nullptr; } if (bd->pInputLayout) { bd->pInputLayout->Release(); bd->pInputLayout = nullptr; } if (bd->pVertexShader) { bd->pVertexShader->Release(); bd->pVertexShader = nullptr; } } bool ImGui_ImplDX11_Init(ID3D11Device* device, ID3D11DeviceContext* device_context) { ImGuiIO& io = ImGui::GetIO(); IMGUI_CHECKVERSION(); IM_ASSERT(io.BackendRendererUserData == nullptr && "Already initialized a renderer backend!"); // Setup backend capabilities flags ImGui_ImplDX11_Data* bd = IM_NEW(ImGui_ImplDX11_Data)(); io.BackendRendererUserData = (void*)bd; io.BackendRendererName = "imgui_impl_dx11_openvr"; io.BackendFlags |= ImGuiBackendFlags_RendererHasVtxOffset; // We can honor the ImDrawCmd::VtxOffset field, allowing for large meshes. // Get factory from device IDXGIDevice* pDXGIDevice = nullptr; IDXGIAdapter* pDXGIAdapter = nullptr; IDXGIFactory* pFactory = nullptr; if (device->QueryInterface(IID_PPV_ARGS(&pDXGIDevice)) == S_OK) if (pDXGIDevice->GetParent(IID_PPV_ARGS(&pDXGIAdapter)) == S_OK) if (pDXGIAdapter->GetParent(IID_PPV_ARGS(&pFactory)) == S_OK) { bd->pd3dDevice = device; bd->pd3dDeviceContext = device_context; bd->pFactory = pFactory; } if (pDXGIDevice) pDXGIDevice->Release(); if (pDXGIAdapter) pDXGIAdapter->Release(); bd->pd3dDevice->AddRef(); bd->pd3dDeviceContext->AddRef(); return true; } void ImGui_ImplDX11_Shutdown() { ImGui_ImplDX11_Data* bd = ImGui_ImplDX11_GetBackendData(); IM_ASSERT(bd != nullptr && "No renderer backend to shutdown, or already shutdown?"); ImGuiIO& io = ImGui::GetIO(); ImGui_ImplDX11_InvalidateDeviceObjects(); if (bd->pFactory) { bd->pFactory->Release(); } if (bd->pd3dDevice) { bd->pd3dDevice->Release(); } if (bd->pd3dDeviceContext) { bd->pd3dDeviceContext->Release(); } io.BackendRendererName = nullptr; io.BackendRendererUserData = nullptr; io.BackendFlags &= ~ImGuiBackendFlags_RendererHasVtxOffset; IM_DELETE(bd); } void ImGui_ImplDX11_NewFrame() { ImGui_ImplDX11_Data* bd = ImGui_ImplDX11_GetBackendData(); IM_ASSERT(bd != nullptr && "Context or backend not initialized! Did you call ImGui_ImplDX11_Init()?"); if (!bd->pFontSampler) ImGui_ImplDX11_CreateDeviceObjects(); } //----------------------------------------------------------------------------- #endif // #ifndef IMGUI_DISABLE ================================================ FILE: src/DesktopPlusUI/imgui_win32_dx11_openvr/imgui_impl_dx11_openvr.h ================================================ // Desktop+UI: Modified for OpenVR compatibility // dear imgui: Renderer Backend for DirectX11 // This needs to be used along with a Platform Backend (e.g. Win32) // Implemented features: // [X] Renderer: User texture binding. Use 'ID3D11ShaderResourceView*' as ImTextureID. Read the FAQ about ImTextureID! // [X] Renderer: Large meshes support (64k+ vertices) even with 16-bit indices (ImGuiBackendFlags_RendererHasVtxOffset). // [X] Renderer: Expose selected render state for draw callbacks to use. Access in '(ImGui_ImplXXXX_RenderState*)GetPlatformIO().Renderer_RenderState'. // You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this. // Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need. // Learn about Dear ImGui: // - FAQ https://dearimgui.com/faq // - Getting Started https://dearimgui.com/getting-started // - Documentation https://dearimgui.com/docs (same as your local docs/ folder). // - Introduction, links and more at the top of imgui.cpp #pragma once #include "imgui.h" // IMGUI_IMPL_API #ifndef IMGUI_DISABLE struct ID3D11Device; struct ID3D11DeviceContext; struct ID3D11SamplerState; struct ID3D11Buffer; // Follow "Getting Started" link and check examples/ folder to learn about using backends! IMGUI_IMPL_API bool ImGui_ImplDX11_Init(ID3D11Device* device, ID3D11DeviceContext* device_context); IMGUI_IMPL_API void ImGui_ImplDX11_Shutdown(); IMGUI_IMPL_API void ImGui_ImplDX11_NewFrame(); IMGUI_IMPL_API void ImGui_ImplDX11_RenderDrawData(ImDrawData* draw_data); // Use if you want to reset your rendering device without losing Dear ImGui state. IMGUI_IMPL_API void ImGui_ImplDX11_InvalidateDeviceObjects(); IMGUI_IMPL_API bool ImGui_ImplDX11_CreateDeviceObjects(); // [BETA] Selected render state data shared with callbacks. // This is temporarily stored in GetPlatformIO().Renderer_RenderState during the ImGui_ImplDX11_RenderDrawData() call. // (Please open an issue if you feel you need access to more data) struct ImGui_ImplDX11_RenderState { ID3D11Device* Device; ID3D11DeviceContext* DeviceContext; ID3D11SamplerState* SamplerDefault; ID3D11Buffer* VertexConstantBuffer; }; #endif // #ifndef IMGUI_DISABLE ================================================ FILE: src/DesktopPlusUI/imgui_win32_dx11_openvr/imgui_impl_win32_openvr.cpp ================================================ // Desktop+UI: Modified for OpenVR compatibility // dear imgui: Platform Backend for Windows (standard windows API for 32-bits AND 64-bits applications) // This needs to be used along with a Renderer (e.g. DirectX11, OpenGL3, Vulkan..) // Implemented features (imgui_impl_win32): // [X] Platform: Clipboard support (for Win32 this is actually part of core dear imgui) // [X] Platform: Mouse support. Can discriminate Mouse/TouchScreen/Pen. // [X] Platform: Keyboard support. Since 1.87 we are using the io.AddKeyEvent() function. Pass ImGuiKey values to all key functions e.g. ImGui::IsKeyPressed(ImGuiKey_Space). [Legacy VK_* values are obsolete since 1.87 and not supported since 1.91.5] // [X] Platform: Gamepad support. Enabled with 'io.ConfigFlags |= ImGuiConfigFlags_NavEnableGamepad'. // [X] Platform: Mouse cursor shape and visibility (ImGuiBackendFlags_HasMouseCursors). Disable with 'io.ConfigFlags |= ImGuiConfigFlags_NoMouseCursorChange'. // You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this. // Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need. // Learn about Dear ImGui: // - FAQ https://dearimgui.com/faq // - Getting Started https://dearimgui.com/getting-started // - Documentation https://dearimgui.com/docs (same as your local docs/ folder). // - Introduction, links and more at the top of imgui.cpp // Configuration flags to add in your imconfig file: //#define IMGUI_IMPL_WIN32_DISABLE_GAMEPAD // Disable gamepad support. This was meaningful before <1.81 but we now load XInput dynamically so the option is now less relevant. // CHANGELOG (imgui_impl_win32) // (minor and older changes stripped away, please see git history for details) // 2025-03-10: When dealing with OEM keys, use scancodes instead of translated keycodes to choose ImGuiKey values. (#7136, #7201, #7206, #7306, #7670, #7672, #8468) // 2025-02-18: Added ImGuiMouseCursor_Wait and ImGuiMouseCursor_Progress mouse cursor support. // 2024-07-08: Inputs: Fixed ImGuiMod_Super being mapped to VK_APPS instead of VK_LWIN||VK_RWIN. (#7768) // 2023-10-05: Inputs: Added support for extra ImGuiKey values: F13 to F24 function keys, app back/forward keys. // 2023-09-25: Inputs: Synthesize key-down event on key-up for VK_SNAPSHOT / ImGuiKey_PrintScreen as Windows doesn't emit it (same behavior as GLFW/SDL). // 2023-09-07: Inputs: Added support for keyboard codepage conversion for when application is compiled in MBCS mode and using a non-Unicode window. // 2023-04-19: Added ImGui_ImplWin32_InitForOpenGL() to facilitate combining raw Win32/Winapi with OpenGL. (#3218) // 2023-04-04: Inputs: Added support for io.AddMouseSourceEvent() to discriminate ImGuiMouseSource_Mouse/ImGuiMouseSource_TouchScreen/ImGuiMouseSource_Pen. (#2702) // 2023-02-15: Inputs: Use WM_NCMOUSEMOVE / WM_NCMOUSELEAVE to track mouse position over non-client area (e.g. OS decorations) when app is not focused. (#6045, #6162) // 2023-02-02: Inputs: Flipping WM_MOUSEHWHEEL (horizontal mouse-wheel) value to match other backends and offer consistent horizontal scrolling direction. (#4019, #6096, #1463) // 2022-10-11: Using 'nullptr' instead of 'NULL' as per our switch to C++11. // 2022-09-28: Inputs: Convert WM_CHAR values with MultiByteToWideChar() when window class was registered as MBCS (not Unicode). // 2022-09-26: Inputs: Renamed ImGuiKey_ModXXX introduced in 1.87 to ImGuiMod_XXX (old names still supported). // 2022-01-26: Inputs: replaced short-lived io.AddKeyModsEvent() (added two weeks ago) with io.AddKeyEvent() using ImGuiKey_ModXXX flags. Sorry for the confusion. // 2021-01-20: Inputs: calling new io.AddKeyAnalogEvent() for gamepad support, instead of writing directly to io.NavInputs[]. // 2022-01-17: Inputs: calling new io.AddMousePosEvent(), io.AddMouseButtonEvent(), io.AddMouseWheelEvent() API (1.87+). // 2022-01-17: Inputs: always update key mods next and before a key event (not in NewFrame) to fix input queue with very low framerates. // 2022-01-12: Inputs: Update mouse inputs using WM_MOUSEMOVE/WM_MOUSELEAVE + fallback to provide it when focused but not hovered/captured. More standard and will allow us to pass it to future input queue API. // 2022-01-12: Inputs: Maintain our own copy of MouseButtonsDown mask instead of using ImGui::IsAnyMouseDown() which will be obsoleted. // 2022-01-10: Inputs: calling new io.AddKeyEvent(), io.AddKeyModsEvent() + io.SetKeyEventNativeData() API (1.87+). Support for full ImGuiKey range. // 2021-12-16: Inputs: Fill VK_LCONTROL/VK_RCONTROL/VK_LSHIFT/VK_RSHIFT/VK_LMENU/VK_RMENU for completeness. // 2021-08-17: Calling io.AddFocusEvent() on WM_SETFOCUS/WM_KILLFOCUS messages. // 2021-08-02: Inputs: Fixed keyboard modifiers being reported when host window doesn't have focus. // 2021-07-29: Inputs: MousePos is correctly reported when the host platform window is hovered but not focused (using TrackMouseEvent() to receive WM_MOUSELEAVE events). // 2021-06-29: Reorganized backend to pull data from a single structure to facilitate usage with multiple-contexts (all g_XXXX access changed to bd->XXXX). // 2021-06-08: Fixed ImGui_ImplWin32_EnableDpiAwareness() and ImGui_ImplWin32_GetDpiScaleForMonitor() to handle Windows 8.1/10 features without a manifest (per-monitor DPI, and properly calls SetProcessDpiAwareness() on 8.1). // 2021-03-23: Inputs: Clearing keyboard down array when losing focus (WM_KILLFOCUS). // 2021-02-18: Added ImGui_ImplWin32_EnableAlphaCompositing(). Non Visual Studio users will need to link with dwmapi.lib (MinGW/gcc: use -ldwmapi). // 2021-02-17: Fixed ImGui_ImplWin32_EnableDpiAwareness() attempting to get SetProcessDpiAwareness from shcore.dll on Windows 8 whereas it is only supported on Windows 8.1. // 2021-01-25: Inputs: Dynamically loading XInput DLL. // 2020-12-04: Misc: Fixed setting of io.DisplaySize to invalid/uninitialized data when after hwnd has been closed. // 2020-03-03: Inputs: Calling AddInputCharacterUTF16() to support surrogate pairs leading to codepoint >= 0x10000 (for more complete CJK inputs) // 2020-02-17: Added ImGui_ImplWin32_EnableDpiAwareness(), ImGui_ImplWin32_GetDpiScaleForHwnd(), ImGui_ImplWin32_GetDpiScaleForMonitor() helper functions. // 2020-01-14: Inputs: Added support for #define IMGUI_IMPL_WIN32_DISABLE_GAMEPAD/IMGUI_IMPL_WIN32_DISABLE_LINKING_XINPUT. // 2019-12-05: Inputs: Added support for ImGuiMouseCursor_NotAllowed mouse cursor. // 2019-05-11: Inputs: Don't filter value from WM_CHAR before calling AddInputCharacter(). // 2019-01-17: Misc: Using GetForegroundWindow()+IsChild() instead of GetActiveWindow() to be compatible with windows created in a different thread or parent. // 2019-01-17: Inputs: Added support for mouse buttons 4 and 5 via WM_XBUTTON* messages. // 2019-01-15: Inputs: Added support for XInput gamepads (if ImGuiConfigFlags_NavEnableGamepad is set by user application). // 2018-11-30: Misc: Setting up io.BackendPlatformName so it can be displayed in the About Window. // 2018-06-29: Inputs: Added support for the ImGuiMouseCursor_Hand cursor. // 2018-06-10: Inputs: Fixed handling of mouse wheel messages to support fine position messages (typically sent by track-pads). // 2018-06-08: Misc: Extracted imgui_impl_win32.cpp/.h away from the old combined DX9/DX10/DX11/DX12 examples. // 2018-03-20: Misc: Setup io.BackendFlags ImGuiBackendFlags_HasMouseCursors and ImGuiBackendFlags_HasSetMousePos flags + honor ImGuiConfigFlags_NoMouseCursorChange flag. // 2018-02-20: Inputs: Added support for mouse cursors (ImGui::GetMouseCursor() value and WM_SETCURSOR message handling). // 2018-02-06: Inputs: Added mapping for ImGuiKey_Space. // 2018-02-06: Inputs: Honoring the io.WantSetMousePos by repositioning the mouse (when using navigation and ImGuiConfigFlags_NavMoveMouse is set). // 2018-02-06: Misc: Removed call to ImGui::Shutdown() which is not available from 1.60 WIP, user needs to call CreateContext/DestroyContext themselves. // 2018-01-20: Inputs: Added Horizontal Mouse Wheel support. // 2018-01-08: Inputs: Added mapping for ImGuiKey_Insert. // 2018-01-05: Inputs: Added WM_LBUTTONDBLCLK double-click handlers for window classes with the CS_DBLCLKS flag. // 2017-10-23: Inputs: Added WM_SYSKEYDOWN / WM_SYSKEYUP handlers so e.g. the VK_MENU key can be read. // 2017-10-23: Inputs: Using Win32 ::SetCapture/::GetCapture() to retrieve mouse positions outside the client area when dragging. // 2016-11-12: Inputs: Only call Win32 ::SetCursor(nullptr) when io.MouseDrawCursor is set. #include "imgui.h" #ifndef IMGUI_DISABLE #include "imgui_internal.h" #include "imgui_impl_win32_openvr.h" #ifndef WIN32_LEAN_AND_MEAN #define WIN32_LEAN_AND_MEAN #endif #include #include // GET_X_LPARAM(), GET_Y_LPARAM() #include #include // Using XInput for gamepad (will load DLL dynamically) #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD #include typedef DWORD(WINAPI* PFN_XInputGetCapabilities)(DWORD, DWORD, XINPUT_CAPABILITIES*); typedef DWORD(WINAPI* PFN_XInputGetState)(DWORD, XINPUT_STATE*); #endif // Clang/GCC warnings with -Weverything #if defined(__clang__) #pragma clang diagnostic push #pragma clang diagnostic ignored "-Wcast-function-type" // warning: cast between incompatible function types (for loader) #endif #if defined(__GNUC__) #pragma GCC diagnostic push #pragma GCC diagnostic ignored "-Wpragmas" // warning: unknown option after '#pragma GCC diagnostic' kind #pragma GCC diagnostic ignored "-Wcast-function-type" // warning: cast between incompatible function types (for loader) #endif #include #include //Additional VRMouseButton values only sent by Desktop+ laser pointer inputs, map to mouse button X1/X2 #define VRMouseButton_DP_Aux01 0x0008 #define VRMouseButton_DP_Aux02 0x0010 struct ImGui_ImplWin32_Data { HWND hWnd; HWND MouseHwnd; int MouseTrackedArea; // 0: not tracked, 1: client area, 2: non-client area int MouseButtonsDown; INT64 Time; INT64 TicksPerSecond; ImGuiMouseCursor LastMouseCursor; UINT32 KeyboardCodePage; #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD bool HasGamepad; bool WantUpdateHasGamepad; HMODULE XInputDLL; PFN_XInputGetCapabilities XInputGetCapabilities; PFN_XInputGetState XInputGetState; #endif ImGui_ImplWin32_Data() { memset((void*)this, 0, sizeof(*this)); } }; // Backend data stored in io.BackendPlatformUserData to allow support for multiple Dear ImGui contexts // It is STRONGLY preferred that you use docking branch with multi-viewports (== single Dear ImGui context + multiple windows) instead of multiple Dear ImGui contexts. // FIXME: multi-context support is not well tested and probably dysfunctional in this backend. // FIXME: some shared resources (mouse cursor shape, gamepad) are mishandled when using multi-context. static ImGui_ImplWin32_Data* ImGui_ImplWin32_GetBackendData() { return ImGui::GetCurrentContext() ? (ImGui_ImplWin32_Data*)ImGui::GetIO().BackendPlatformUserData : nullptr; } static ImGui_ImplWin32_Data* ImGui_ImplWin32_GetBackendData(ImGuiIO& io) { return (ImGui_ImplWin32_Data*)io.BackendPlatformUserData; } // OpenVR Data static std::queue g_OnScreenKeyboardQueue; static int g_OnScreenKeyboardQueueDelay = 0; static bool g_OnScreenKeyboardShown = false; static bool g_OnScreenKeyboardDismissedLastFrame = false; // Functions static void ImGui_ImplWin32_UpdateKeyboardCodePage(ImGuiIO& io) { // Retrieve keyboard code page, required for handling of non-Unicode Windows. ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData(io); HKL keyboard_layout = ::GetKeyboardLayout(0); LCID keyboard_lcid = MAKELCID(HIWORD(keyboard_layout), SORT_DEFAULT); if (::GetLocaleInfoA(keyboard_lcid, (LOCALE_RETURN_NUMBER | LOCALE_IDEFAULTANSICODEPAGE), (LPSTR)&bd->KeyboardCodePage, sizeof(bd->KeyboardCodePage)) == 0) bd->KeyboardCodePage = CP_ACP; // Fallback to default ANSI code page when fails. } static bool ImGui_ImplWin32_InitEx(void* hwnd, bool platform_has_own_dc) { ImGuiIO& io = ImGui::GetIO(); IMGUI_CHECKVERSION(); IM_ASSERT(io.BackendPlatformUserData == nullptr && "Already initialized a platform backend!"); INT64 perf_frequency, perf_counter; if (!::QueryPerformanceFrequency((LARGE_INTEGER*)&perf_frequency)) return false; if (!::QueryPerformanceCounter((LARGE_INTEGER*)&perf_counter)) return false; // Setup backend capabilities flags ImGui_ImplWin32_Data* bd = IM_NEW(ImGui_ImplWin32_Data)(); io.BackendPlatformUserData = (void*)bd; io.BackendPlatformName = "imgui_impl_win32_openvr"; io.BackendFlags |= ImGuiBackendFlags_HasMouseCursors; // We can honor GetMouseCursor() values (optional) io.BackendFlags |= ImGuiBackendFlags_HasSetMousePos; // We can honor io.WantSetMousePos requests (optional, rarely used) bd->hWnd = (HWND)hwnd; bd->TicksPerSecond = perf_frequency; bd->Time = perf_counter; bd->LastMouseCursor = ImGuiMouseCursor_COUNT; ImGui_ImplWin32_UpdateKeyboardCodePage(io); // Set platform dependent data in viewport ImGuiViewport* main_viewport = ImGui::GetMainViewport(); main_viewport->PlatformHandle = main_viewport->PlatformHandleRaw = (void*)bd->hWnd; IM_UNUSED(platform_has_own_dc); // Used in 'docking' branch // Dynamically load XInput library #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD bd->WantUpdateHasGamepad = true; const char* xinput_dll_names[] = { "xinput1_4.dll", // Windows 8+ "xinput1_3.dll", // DirectX SDK "xinput9_1_0.dll", // Windows Vista, Windows 7 "xinput1_2.dll", // DirectX SDK "xinput1_1.dll" // DirectX SDK }; for (int n = 0; n < IM_ARRAYSIZE(xinput_dll_names); n++) if (HMODULE dll = ::LoadLibraryA(xinput_dll_names[n])) { bd->XInputDLL = dll; bd->XInputGetCapabilities = (PFN_XInputGetCapabilities)::GetProcAddress(dll, "XInputGetCapabilities"); bd->XInputGetState = (PFN_XInputGetState)::GetProcAddress(dll, "XInputGetState"); break; } #endif // IMGUI_IMPL_WIN32_DISABLE_GAMEPAD return true; } IMGUI_IMPL_API bool ImGui_ImplWin32_Init(void* hwnd) { return ImGui_ImplWin32_InitEx(hwnd, false); } IMGUI_IMPL_API bool ImGui_ImplWin32_InitForOpenGL(void* hwnd) { // OpenGL needs CS_OWNDC return ImGui_ImplWin32_InitEx(hwnd, true); } void ImGui_ImplWin32_Shutdown() { ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData(); IM_ASSERT(bd != nullptr && "No platform backend to shutdown, or already shutdown?"); ImGuiIO& io = ImGui::GetIO(); // Unload XInput library #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD if (bd->XInputDLL) ::FreeLibrary(bd->XInputDLL); #endif // IMGUI_IMPL_WIN32_DISABLE_GAMEPAD io.BackendPlatformName = nullptr; io.BackendPlatformUserData = nullptr; io.BackendFlags &= ~(ImGuiBackendFlags_HasMouseCursors | ImGuiBackendFlags_HasSetMousePos | ImGuiBackendFlags_HasGamepad); IM_DELETE(bd); } static bool ImGui_ImplWin32_UpdateMouseCursor(ImGuiIO& io, ImGuiMouseCursor imgui_cursor) { if (io.ConfigFlags & ImGuiConfigFlags_NoMouseCursorChange) return false; if (imgui_cursor == ImGuiMouseCursor_None || io.MouseDrawCursor) { // Hide OS mouse cursor if imgui is drawing it or if it wants no cursor ::SetCursor(nullptr); } else { // Show OS mouse cursor LPTSTR win32_cursor = IDC_ARROW; switch (imgui_cursor) { case ImGuiMouseCursor_Arrow: win32_cursor = IDC_ARROW; break; case ImGuiMouseCursor_TextInput: win32_cursor = IDC_IBEAM; break; case ImGuiMouseCursor_ResizeAll: win32_cursor = IDC_SIZEALL; break; case ImGuiMouseCursor_ResizeEW: win32_cursor = IDC_SIZEWE; break; case ImGuiMouseCursor_ResizeNS: win32_cursor = IDC_SIZENS; break; case ImGuiMouseCursor_ResizeNESW: win32_cursor = IDC_SIZENESW; break; case ImGuiMouseCursor_ResizeNWSE: win32_cursor = IDC_SIZENWSE; break; case ImGuiMouseCursor_Hand: win32_cursor = IDC_HAND; break; case ImGuiMouseCursor_Wait: win32_cursor = IDC_WAIT; break; case ImGuiMouseCursor_Progress: win32_cursor = IDC_APPSTARTING; break; case ImGuiMouseCursor_NotAllowed: win32_cursor = IDC_NO; break; } ::SetCursor(::LoadCursor(nullptr, win32_cursor)); } return true; } static bool IsVkDown(int vk) { return (::GetKeyState(vk) & 0x8000) != 0; } static void ImGui_ImplWin32_AddKeyEvent(ImGuiIO& io, ImGuiKey key, bool down, int native_keycode, int native_scancode = -1) { io.AddKeyEvent(key, down); io.SetKeyEventNativeData(key, native_keycode, native_scancode); // To support legacy indexing (<1.87 user code) IM_UNUSED(native_scancode); } static void ImGui_ImplWin32_ProcessKeyEventsWorkarounds(ImGuiIO& io) { // Left & right Shift keys: when both are pressed together, Windows tend to not generate the WM_KEYUP event for the first released one. if (ImGui::IsKeyDown(ImGuiKey_LeftShift) && !IsVkDown(VK_LSHIFT)) ImGui_ImplWin32_AddKeyEvent(io, ImGuiKey_LeftShift, false, VK_LSHIFT); if (ImGui::IsKeyDown(ImGuiKey_RightShift) && !IsVkDown(VK_RSHIFT)) ImGui_ImplWin32_AddKeyEvent(io, ImGuiKey_RightShift, false, VK_RSHIFT); // Sometimes WM_KEYUP for Win key is not passed down to the app (e.g. for Win+V on some setups, according to GLFW). if (ImGui::IsKeyDown(ImGuiKey_LeftSuper) && !IsVkDown(VK_LWIN)) ImGui_ImplWin32_AddKeyEvent(io, ImGuiKey_LeftSuper, false, VK_LWIN); if (ImGui::IsKeyDown(ImGuiKey_RightSuper) && !IsVkDown(VK_RWIN)) ImGui_ImplWin32_AddKeyEvent(io, ImGuiKey_RightSuper, false, VK_RWIN); } static void ImGui_ImplWin32_UpdateKeyModifiers(ImGuiIO& io) { io.AddKeyEvent(ImGuiMod_Ctrl, IsVkDown(VK_CONTROL)); io.AddKeyEvent(ImGuiMod_Shift, IsVkDown(VK_SHIFT)); io.AddKeyEvent(ImGuiMod_Alt, IsVkDown(VK_MENU)); io.AddKeyEvent(ImGuiMod_Super, IsVkDown(VK_LWIN) || IsVkDown(VK_RWIN)); } static void ImGui_ImplWin32_UpdateMouseData(ImGuiIO& io) { ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData(io); IM_ASSERT(bd->hWnd != 0); HWND focused_window = ::GetForegroundWindow(); const bool is_app_focused = (focused_window == bd->hWnd); if (is_app_focused) { // (Optional) Set OS mouse position from Dear ImGui if requested (rarely used, only when io.ConfigNavMoveSetMousePos is enabled by user) if (io.WantSetMousePos) { POINT pos = { (int)io.MousePos.x, (int)io.MousePos.y }; if (::ClientToScreen(bd->hWnd, &pos)) ::SetCursorPos(pos.x, pos.y); } // (Optional) Fallback to provide mouse position when focused (WM_MOUSEMOVE already provides this when hovered or captured) // This also fills a short gap when clicking non-client area: WM_NCMOUSELEAVE -> modal OS move -> gap -> WM_NCMOUSEMOVE if (!io.WantSetMousePos && bd->MouseTrackedArea == 0) { POINT pos; if (::GetCursorPos(&pos) && ::ScreenToClient(bd->hWnd, &pos)) io.AddMousePosEvent((float)pos.x, (float)pos.y); } } } // Gamepad navigation mapping static void ImGui_ImplWin32_UpdateGamepads(ImGuiIO& io) { #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData(io); //if ((io.ConfigFlags & ImGuiConfigFlags_NavEnableGamepad) == 0) // FIXME: Technically feeding gamepad shouldn't depend on this now that they are regular inputs. // return; // Calling XInputGetState() every frame on disconnected gamepads is unfortunately too slow. // Instead we refresh gamepad availability by calling XInputGetCapabilities() _only_ after receiving WM_DEVICECHANGE. if (bd->WantUpdateHasGamepad) { XINPUT_CAPABILITIES caps = {}; bd->HasGamepad = bd->XInputGetCapabilities ? (bd->XInputGetCapabilities(0, XINPUT_FLAG_GAMEPAD, &caps) == ERROR_SUCCESS) : false; bd->WantUpdateHasGamepad = false; } io.BackendFlags &= ~ImGuiBackendFlags_HasGamepad; XINPUT_STATE xinput_state; XINPUT_GAMEPAD& gamepad = xinput_state.Gamepad; if (!bd->HasGamepad || bd->XInputGetState == nullptr || bd->XInputGetState(0, &xinput_state) != ERROR_SUCCESS) return; io.BackendFlags |= ImGuiBackendFlags_HasGamepad; #define IM_SATURATE(V) (V < 0.0f ? 0.0f : V > 1.0f ? 1.0f : V) #define MAP_BUTTON(KEY_NO, BUTTON_ENUM) { io.AddKeyEvent(KEY_NO, (gamepad.wButtons & BUTTON_ENUM) != 0); } #define MAP_ANALOG(KEY_NO, VALUE, V0, V1) { float vn = (float)(VALUE - V0) / (float)(V1 - V0); io.AddKeyAnalogEvent(KEY_NO, vn > 0.10f, IM_SATURATE(vn)); } MAP_BUTTON(ImGuiKey_GamepadStart, XINPUT_GAMEPAD_START); MAP_BUTTON(ImGuiKey_GamepadBack, XINPUT_GAMEPAD_BACK); MAP_BUTTON(ImGuiKey_GamepadFaceLeft, XINPUT_GAMEPAD_X); MAP_BUTTON(ImGuiKey_GamepadFaceRight, XINPUT_GAMEPAD_B); MAP_BUTTON(ImGuiKey_GamepadFaceUp, XINPUT_GAMEPAD_Y); MAP_BUTTON(ImGuiKey_GamepadFaceDown, XINPUT_GAMEPAD_A); MAP_BUTTON(ImGuiKey_GamepadDpadLeft, XINPUT_GAMEPAD_DPAD_LEFT); MAP_BUTTON(ImGuiKey_GamepadDpadRight, XINPUT_GAMEPAD_DPAD_RIGHT); MAP_BUTTON(ImGuiKey_GamepadDpadUp, XINPUT_GAMEPAD_DPAD_UP); MAP_BUTTON(ImGuiKey_GamepadDpadDown, XINPUT_GAMEPAD_DPAD_DOWN); MAP_BUTTON(ImGuiKey_GamepadL1, XINPUT_GAMEPAD_LEFT_SHOULDER); MAP_BUTTON(ImGuiKey_GamepadR1, XINPUT_GAMEPAD_RIGHT_SHOULDER); MAP_ANALOG(ImGuiKey_GamepadL2, gamepad.bLeftTrigger, XINPUT_GAMEPAD_TRIGGER_THRESHOLD, 255); MAP_ANALOG(ImGuiKey_GamepadR2, gamepad.bRightTrigger, XINPUT_GAMEPAD_TRIGGER_THRESHOLD, 255); MAP_BUTTON(ImGuiKey_GamepadL3, XINPUT_GAMEPAD_LEFT_THUMB); MAP_BUTTON(ImGuiKey_GamepadR3, XINPUT_GAMEPAD_RIGHT_THUMB); MAP_ANALOG(ImGuiKey_GamepadLStickLeft, gamepad.sThumbLX, -XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, -32768); MAP_ANALOG(ImGuiKey_GamepadLStickRight, gamepad.sThumbLX, +XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, +32767); MAP_ANALOG(ImGuiKey_GamepadLStickUp, gamepad.sThumbLY, +XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, +32767); MAP_ANALOG(ImGuiKey_GamepadLStickDown, gamepad.sThumbLY, -XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, -32768); MAP_ANALOG(ImGuiKey_GamepadRStickLeft, gamepad.sThumbRX, -XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, -32768); MAP_ANALOG(ImGuiKey_GamepadRStickRight, gamepad.sThumbRX, +XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, +32767); MAP_ANALOG(ImGuiKey_GamepadRStickUp, gamepad.sThumbRY, +XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, +32767); MAP_ANALOG(ImGuiKey_GamepadRStickDown, gamepad.sThumbRY, -XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, -32768); #undef MAP_BUTTON #undef MAP_ANALOG #else // #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD IM_UNUSED(io); #endif } void ImGui_ImplWin32_NewFrame() { ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData(); IM_ASSERT(bd != nullptr && "Context or backend not initialized? Did you call ImGui_ImplWin32_Init()?"); ImGuiIO& io = ImGui::GetIO(); // Setup display size (every frame to accommodate for window resizing) RECT rect = { 0, 0, 0, 0 }; ::GetClientRect(bd->hWnd, &rect); io.DisplaySize = ImVec2((float)(rect.right - rect.left), (float)(rect.bottom - rect.top)); // Setup time step INT64 current_time = 0; ::QueryPerformanceCounter((LARGE_INTEGER*)¤t_time); io.DeltaTime = (float)(current_time - bd->Time) / bd->TicksPerSecond; bd->Time = current_time; // Update OS mouse position ImGui_ImplWin32_UpdateMouseData(io); // Process workarounds for known Windows key handling issues ImGui_ImplWin32_ProcessKeyEventsWorkarounds(io); // Update OS mouse cursor with the cursor requested by imgui ImGuiMouseCursor mouse_cursor = io.MouseDrawCursor ? ImGuiMouseCursor_None : ImGui::GetMouseCursor(); if (bd->LastMouseCursor != mouse_cursor) { bd->LastMouseCursor = mouse_cursor; ImGui_ImplWin32_UpdateMouseCursor(io, mouse_cursor); } // Update game controllers (if enabled and available) ImGui_ImplWin32_UpdateGamepads(io); } // Map VK_xxx to ImGuiKey_xxx. // Not static to allow third-party code to use that if they want to (but undocumented) ImGuiKey ImGui_ImplWin32_KeyEventToImGuiKey(uint64_t wParam, int64_t lParam); ImGuiKey ImGui_ImplWin32_KeyEventToImGuiKey(uint64_t wParam, int64_t lParam) { // There is no distinct VK_xxx for keypad enter, instead it is VK_RETURN + KF_EXTENDED. if ((wParam == VK_RETURN) && (HIWORD(lParam) & KF_EXTENDED)) return ImGuiKey_KeypadEnter; const int scancode = (int)LOBYTE(HIWORD(lParam)); //IMGUI_DEBUG_LOG("scancode %3d, keycode = 0x%02X\n", scancode, wParam); switch (wParam) { case VK_TAB: return ImGuiKey_Tab; case VK_LEFT: return ImGuiKey_LeftArrow; case VK_RIGHT: return ImGuiKey_RightArrow; case VK_UP: return ImGuiKey_UpArrow; case VK_DOWN: return ImGuiKey_DownArrow; case VK_PRIOR: return ImGuiKey_PageUp; case VK_NEXT: return ImGuiKey_PageDown; case VK_HOME: return ImGuiKey_Home; case VK_END: return ImGuiKey_End; case VK_INSERT: return ImGuiKey_Insert; case VK_DELETE: return ImGuiKey_Delete; case VK_BACK: return ImGuiKey_Backspace; case VK_SPACE: return ImGuiKey_Space; case VK_RETURN: return ImGuiKey_Enter; case VK_ESCAPE: return ImGuiKey_Escape; //case VK_OEM_7: return ImGuiKey_Apostrophe; case VK_OEM_COMMA: return ImGuiKey_Comma; //case VK_OEM_MINUS: return ImGuiKey_Minus; case VK_OEM_PERIOD: return ImGuiKey_Period; //case VK_OEM_2: return ImGuiKey_Slash; //case VK_OEM_1: return ImGuiKey_Semicolon; //case VK_OEM_PLUS: return ImGuiKey_Equal; //case VK_OEM_4: return ImGuiKey_LeftBracket; //case VK_OEM_5: return ImGuiKey_Backslash; //case VK_OEM_6: return ImGuiKey_RightBracket; //case VK_OEM_3: return ImGuiKey_GraveAccent; case VK_CAPITAL: return ImGuiKey_CapsLock; case VK_SCROLL: return ImGuiKey_ScrollLock; case VK_NUMLOCK: return ImGuiKey_NumLock; case VK_SNAPSHOT: return ImGuiKey_PrintScreen; case VK_PAUSE: return ImGuiKey_Pause; case VK_NUMPAD0: return ImGuiKey_Keypad0; case VK_NUMPAD1: return ImGuiKey_Keypad1; case VK_NUMPAD2: return ImGuiKey_Keypad2; case VK_NUMPAD3: return ImGuiKey_Keypad3; case VK_NUMPAD4: return ImGuiKey_Keypad4; case VK_NUMPAD5: return ImGuiKey_Keypad5; case VK_NUMPAD6: return ImGuiKey_Keypad6; case VK_NUMPAD7: return ImGuiKey_Keypad7; case VK_NUMPAD8: return ImGuiKey_Keypad8; case VK_NUMPAD9: return ImGuiKey_Keypad9; case VK_DECIMAL: return ImGuiKey_KeypadDecimal; case VK_DIVIDE: return ImGuiKey_KeypadDivide; case VK_MULTIPLY: return ImGuiKey_KeypadMultiply; case VK_SUBTRACT: return ImGuiKey_KeypadSubtract; case VK_ADD: return ImGuiKey_KeypadAdd; case VK_LSHIFT: return ImGuiKey_LeftShift; case VK_LCONTROL: return ImGuiKey_LeftCtrl; case VK_LMENU: return ImGuiKey_LeftAlt; case VK_LWIN: return ImGuiKey_LeftSuper; case VK_RSHIFT: return ImGuiKey_RightShift; case VK_RCONTROL: return ImGuiKey_RightCtrl; case VK_RMENU: return ImGuiKey_RightAlt; case VK_RWIN: return ImGuiKey_RightSuper; case VK_APPS: return ImGuiKey_Menu; case '0': return ImGuiKey_0; case '1': return ImGuiKey_1; case '2': return ImGuiKey_2; case '3': return ImGuiKey_3; case '4': return ImGuiKey_4; case '5': return ImGuiKey_5; case '6': return ImGuiKey_6; case '7': return ImGuiKey_7; case '8': return ImGuiKey_8; case '9': return ImGuiKey_9; case 'A': return ImGuiKey_A; case 'B': return ImGuiKey_B; case 'C': return ImGuiKey_C; case 'D': return ImGuiKey_D; case 'E': return ImGuiKey_E; case 'F': return ImGuiKey_F; case 'G': return ImGuiKey_G; case 'H': return ImGuiKey_H; case 'I': return ImGuiKey_I; case 'J': return ImGuiKey_J; case 'K': return ImGuiKey_K; case 'L': return ImGuiKey_L; case 'M': return ImGuiKey_M; case 'N': return ImGuiKey_N; case 'O': return ImGuiKey_O; case 'P': return ImGuiKey_P; case 'Q': return ImGuiKey_Q; case 'R': return ImGuiKey_R; case 'S': return ImGuiKey_S; case 'T': return ImGuiKey_T; case 'U': return ImGuiKey_U; case 'V': return ImGuiKey_V; case 'W': return ImGuiKey_W; case 'X': return ImGuiKey_X; case 'Y': return ImGuiKey_Y; case 'Z': return ImGuiKey_Z; case VK_F1: return ImGuiKey_F1; case VK_F2: return ImGuiKey_F2; case VK_F3: return ImGuiKey_F3; case VK_F4: return ImGuiKey_F4; case VK_F5: return ImGuiKey_F5; case VK_F6: return ImGuiKey_F6; case VK_F7: return ImGuiKey_F7; case VK_F8: return ImGuiKey_F8; case VK_F9: return ImGuiKey_F9; case VK_F10: return ImGuiKey_F10; case VK_F11: return ImGuiKey_F11; case VK_F12: return ImGuiKey_F12; case VK_F13: return ImGuiKey_F13; case VK_F14: return ImGuiKey_F14; case VK_F15: return ImGuiKey_F15; case VK_F16: return ImGuiKey_F16; case VK_F17: return ImGuiKey_F17; case VK_F18: return ImGuiKey_F18; case VK_F19: return ImGuiKey_F19; case VK_F20: return ImGuiKey_F20; case VK_F21: return ImGuiKey_F21; case VK_F22: return ImGuiKey_F22; case VK_F23: return ImGuiKey_F23; case VK_F24: return ImGuiKey_F24; case VK_BROWSER_BACK: return ImGuiKey_AppBack; case VK_BROWSER_FORWARD: return ImGuiKey_AppForward; default: break; } // Fallback to scancode // https://handmade.network/forums/t/2011-keyboard_inputs_-_scancodes,_raw_input,_text_input,_key_names switch (scancode) { case 41: return ImGuiKey_GraveAccent; // VK_OEM_8 in EN-UK, VK_OEM_3 in EN-US, VK_OEM_7 in FR, VK_OEM_5 in DE, etc. case 12: return ImGuiKey_Minus; case 13: return ImGuiKey_Equal; case 26: return ImGuiKey_LeftBracket; case 27: return ImGuiKey_RightBracket; case 86: return ImGuiKey_Oem102; case 43: return ImGuiKey_Backslash; case 39: return ImGuiKey_Semicolon; case 40: return ImGuiKey_Apostrophe; case 51: return ImGuiKey_Comma; case 52: return ImGuiKey_Period; case 53: return ImGuiKey_Slash; } return ImGuiKey_None; } // Allow compilation with old Windows SDK. MinGW doesn't have default _WIN32_WINNT/WINVER versions. #ifndef WM_MOUSEHWHEEL #define WM_MOUSEHWHEEL 0x020E #endif #ifndef DBT_DEVNODES_CHANGED #define DBT_DEVNODES_CHANGED 0x0007 #endif // Helper to obtain the source of mouse messages. // See https://learn.microsoft.com/en-us/windows/win32/tablet/system-events-and-mouse-messages // Prefer to call this at the top of the message handler to avoid the possibility of other Win32 calls interfering with this. static ImGuiMouseSource ImGui_ImplWin32_GetMouseSourceFromMessageExtraInfo() { LPARAM extra_info = ::GetMessageExtraInfo(); if ((extra_info & 0xFFFFFF80) == 0xFF515700) return ImGuiMouseSource_Pen; if ((extra_info & 0xFFFFFF80) == 0xFF515780) return ImGuiMouseSource_TouchScreen; return ImGuiMouseSource_Mouse; } // Win32 message handler (process Win32 mouse/keyboard inputs, etc.) // Call from your application's message handler. Keep calling your message handler unless this function returns TRUE. // When implementing your own backend, you can read the io.WantCaptureMouse, io.WantCaptureKeyboard flags to tell if Dear ImGui wants to use your inputs. // - When io.WantCaptureMouse is true, do not dispatch mouse input data to your main application, or clear/overwrite your copy of the mouse data. // - When io.WantCaptureKeyboard is true, do not dispatch keyboard input data to your main application, or clear/overwrite your copy of the keyboard data. // Generally you may always pass all inputs to Dear ImGui, and hide them from your application based on those two flags. // PS: We treat DBLCLK messages as regular mouse down messages, so this code will work on windows classes that have the CS_DBLCLKS flag set. Our own example app code doesn't set this flag. // Copy either line into your .cpp file to forward declare the function: extern IMGUI_IMPL_API LRESULT ImGui_ImplWin32_WndProcHandler(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam); // Use ImGui::GetCurrentContext() extern IMGUI_IMPL_API LRESULT ImGui_ImplWin32_WndProcHandlerEx(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam, ImGuiIO& io); // Doesn't use ImGui::GetCurrentContext() IMGUI_IMPL_API LRESULT ImGui_ImplWin32_WndProcHandler(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam) { // Most backends don't have silent checks like this one, but we need it because WndProc are called early in CreateWindow(). // We silently allow both context or just only backend data to be nullptr. if (ImGui::GetCurrentContext() == nullptr) return 0; return ImGui_ImplWin32_WndProcHandlerEx(hwnd, msg, wParam, lParam, ImGui::GetIO()); } // This version is in theory thread-safe in the sense that no path should access ImGui::GetCurrentContext(). IMGUI_IMPL_API LRESULT ImGui_ImplWin32_WndProcHandlerEx(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam, ImGuiIO& io) { ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData(io); if (bd == nullptr) return 0; switch (msg) { case WM_MOUSEMOVE: case WM_NCMOUSEMOVE: { // We need to call TrackMouseEvent in order to receive WM_MOUSELEAVE events ImGuiMouseSource mouse_source = ImGui_ImplWin32_GetMouseSourceFromMessageExtraInfo(); const int area = (msg == WM_MOUSEMOVE) ? 1 : 2; bd->MouseHwnd = hwnd; if (bd->MouseTrackedArea != area) { TRACKMOUSEEVENT tme_cancel = { sizeof(tme_cancel), TME_CANCEL, hwnd, 0 }; TRACKMOUSEEVENT tme_track = { sizeof(tme_track), (DWORD)((area == 2) ? (TME_LEAVE | TME_NONCLIENT) : TME_LEAVE), hwnd, 0 }; if (bd->MouseTrackedArea != 0) ::TrackMouseEvent(&tme_cancel); ::TrackMouseEvent(&tme_track); bd->MouseTrackedArea = area; } POINT mouse_pos = { (LONG)GET_X_LPARAM(lParam), (LONG)GET_Y_LPARAM(lParam) }; if (msg == WM_NCMOUSEMOVE && ::ScreenToClient(hwnd, &mouse_pos) == FALSE) // WM_NCMOUSEMOVE are provided in absolute coordinates. return 0; io.AddMouseSourceEvent(mouse_source); io.AddMousePosEvent((float)mouse_pos.x, (float)mouse_pos.y); return 0; } case WM_MOUSELEAVE: case WM_NCMOUSELEAVE: { const int area = (msg == WM_MOUSELEAVE) ? 1 : 2; if (bd->MouseTrackedArea == area) { if (bd->MouseHwnd == hwnd) bd->MouseHwnd = nullptr; bd->MouseTrackedArea = 0; io.AddMousePosEvent(-FLT_MAX, -FLT_MAX); } return 0; } case WM_DESTROY: if (bd->MouseHwnd == hwnd && bd->MouseTrackedArea != 0) { TRACKMOUSEEVENT tme_cancel = { sizeof(tme_cancel), TME_CANCEL, hwnd, 0 }; ::TrackMouseEvent(&tme_cancel); bd->MouseHwnd = nullptr; bd->MouseTrackedArea = 0; io.AddMousePosEvent(-FLT_MAX, -FLT_MAX); } return 0; case WM_LBUTTONDOWN: case WM_LBUTTONDBLCLK: case WM_RBUTTONDOWN: case WM_RBUTTONDBLCLK: case WM_MBUTTONDOWN: case WM_MBUTTONDBLCLK: case WM_XBUTTONDOWN: case WM_XBUTTONDBLCLK: { ImGuiMouseSource mouse_source = ImGui_ImplWin32_GetMouseSourceFromMessageExtraInfo(); int button = 0; if (msg == WM_LBUTTONDOWN || msg == WM_LBUTTONDBLCLK) { button = 0; } if (msg == WM_RBUTTONDOWN || msg == WM_RBUTTONDBLCLK) { button = 1; } if (msg == WM_MBUTTONDOWN || msg == WM_MBUTTONDBLCLK) { button = 2; } if (msg == WM_XBUTTONDOWN || msg == WM_XBUTTONDBLCLK) { button = (GET_XBUTTON_WPARAM(wParam) == XBUTTON1) ? 3 : 4; } if (bd->MouseButtonsDown == 0 && ::GetCapture() == nullptr) ::SetCapture(hwnd); // Allow us to read mouse coordinates when dragging mouse outside of our window bounds. bd->MouseButtonsDown |= 1 << button; io.AddMouseSourceEvent(mouse_source); io.AddMouseButtonEvent(button, true); return 0; } case WM_LBUTTONUP: case WM_RBUTTONUP: case WM_MBUTTONUP: case WM_XBUTTONUP: { ImGuiMouseSource mouse_source = ImGui_ImplWin32_GetMouseSourceFromMessageExtraInfo(); int button = 0; if (msg == WM_LBUTTONUP) { button = 0; } if (msg == WM_RBUTTONUP) { button = 1; } if (msg == WM_MBUTTONUP) { button = 2; } if (msg == WM_XBUTTONUP) { button = (GET_XBUTTON_WPARAM(wParam) == XBUTTON1) ? 3 : 4; } bd->MouseButtonsDown &= ~(1 << button); if (bd->MouseButtonsDown == 0 && ::GetCapture() == hwnd) ::ReleaseCapture(); io.AddMouseSourceEvent(mouse_source); io.AddMouseButtonEvent(button, false); return 0; } case WM_MOUSEWHEEL: io.AddMouseWheelEvent(0.0f, (float)GET_WHEEL_DELTA_WPARAM(wParam) / (float)WHEEL_DELTA); return 0; case WM_MOUSEHWHEEL: io.AddMouseWheelEvent(-(float)GET_WHEEL_DELTA_WPARAM(wParam) / (float)WHEEL_DELTA, 0.0f); return 0; case WM_KEYDOWN: case WM_KEYUP: case WM_SYSKEYDOWN: case WM_SYSKEYUP: { const bool is_key_down = (msg == WM_KEYDOWN || msg == WM_SYSKEYDOWN); if (wParam < 256) { // Submit modifiers ImGui_ImplWin32_UpdateKeyModifiers(io); // Obtain virtual key code and convert to ImGuiKey const ImGuiKey key = ImGui_ImplWin32_KeyEventToImGuiKey(wParam, lParam); const int vk = (int)wParam; const int scancode = (int)LOBYTE(HIWORD(lParam)); // Special behavior for VK_SNAPSHOT / ImGuiKey_PrintScreen as Windows doesn't emit the key down event. if (key == ImGuiKey_PrintScreen && !is_key_down) ImGui_ImplWin32_AddKeyEvent(io, key, true, vk, scancode); // Submit key event if (key != ImGuiKey_None) ImGui_ImplWin32_AddKeyEvent(io, key, is_key_down, vk, scancode); // Submit individual left/right modifier events if (vk == VK_SHIFT) { // Important: Shift keys tend to get stuck when pressed together, missing key-up events are corrected in ImGui_ImplWin32_ProcessKeyEventsWorkarounds() if (IsVkDown(VK_LSHIFT) == is_key_down) { ImGui_ImplWin32_AddKeyEvent(io, ImGuiKey_LeftShift, is_key_down, VK_LSHIFT, scancode); } if (IsVkDown(VK_RSHIFT) == is_key_down) { ImGui_ImplWin32_AddKeyEvent(io, ImGuiKey_RightShift, is_key_down, VK_RSHIFT, scancode); } } else if (vk == VK_CONTROL) { if (IsVkDown(VK_LCONTROL) == is_key_down) { ImGui_ImplWin32_AddKeyEvent(io, ImGuiKey_LeftCtrl, is_key_down, VK_LCONTROL, scancode); } if (IsVkDown(VK_RCONTROL) == is_key_down) { ImGui_ImplWin32_AddKeyEvent(io, ImGuiKey_RightCtrl, is_key_down, VK_RCONTROL, scancode); } } else if (vk == VK_MENU) { if (IsVkDown(VK_LMENU) == is_key_down) { ImGui_ImplWin32_AddKeyEvent(io, ImGuiKey_LeftAlt, is_key_down, VK_LMENU, scancode); } if (IsVkDown(VK_RMENU) == is_key_down) { ImGui_ImplWin32_AddKeyEvent(io, ImGuiKey_RightAlt, is_key_down, VK_RMENU, scancode); } } } return 0; } case WM_SETFOCUS: case WM_KILLFOCUS: io.AddFocusEvent(msg == WM_SETFOCUS); return 0; case WM_INPUTLANGCHANGE: ImGui_ImplWin32_UpdateKeyboardCodePage(io); return 0; case WM_CHAR: if (::IsWindowUnicode(hwnd)) { // You can also use ToAscii()+GetKeyboardState() to retrieve characters. if (wParam > 0 && wParam < 0x10000) io.AddInputCharacterUTF16((unsigned short)wParam); } else { wchar_t wch = 0; ::MultiByteToWideChar(bd->KeyboardCodePage, MB_PRECOMPOSED, (char*)&wParam, 1, &wch, 1); io.AddInputCharacter(wch); } return 0; case WM_SETCURSOR: // This is required to restore cursor when transitioning from e.g resize borders to client area. if (LOWORD(lParam) == HTCLIENT && ImGui_ImplWin32_UpdateMouseCursor(io, bd->LastMouseCursor)) return 1; return 0; case WM_DEVICECHANGE: #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD if ((UINT)wParam == DBT_DEVNODES_CHANGED) bd->WantUpdateHasGamepad = true; #endif return 0; } return 0; } //-------------------------------------------------------------------------------------------------------- // DPI-related helpers (optional) //-------------------------------------------------------------------------------------------------------- // - Use to enable DPI awareness without having to create an application manifest. // - Your own app may already do this via a manifest or explicit calls. This is mostly useful for our examples/ apps. // - In theory we could call simple functions from Windows SDK such as SetProcessDPIAware(), SetProcessDpiAwareness(), etc. // but most of the functions provided by Microsoft require Windows 8.1/10+ SDK at compile time and Windows 8/10+ at runtime, // neither we want to require the user to have. So we dynamically select and load those functions to avoid dependencies. //--------------------------------------------------------------------------------------------------------- // This is the scheme successfully used by GLFW (from which we borrowed some of the code) and other apps aiming to be highly portable. // ImGui_ImplWin32_EnableDpiAwareness() is just a helper called by main.cpp, we don't call it automatically. // If you are trying to implement your own backend for your own engine, you may ignore that noise. //--------------------------------------------------------------------------------------------------------- // Perform our own check with RtlVerifyVersionInfo() instead of using functions from as they // require a manifest to be functional for checks above 8.1. See https://github.com/ocornut/imgui/issues/4200 static BOOL _IsWindowsVersionOrGreater(WORD major, WORD minor, WORD) { typedef LONG(WINAPI* PFN_RtlVerifyVersionInfo)(OSVERSIONINFOEXW*, ULONG, ULONGLONG); static PFN_RtlVerifyVersionInfo RtlVerifyVersionInfoFn = nullptr; if (RtlVerifyVersionInfoFn == nullptr) if (HMODULE ntdllModule = ::GetModuleHandleA("ntdll.dll")) RtlVerifyVersionInfoFn = (PFN_RtlVerifyVersionInfo)GetProcAddress(ntdllModule, "RtlVerifyVersionInfo"); if (RtlVerifyVersionInfoFn == nullptr) return FALSE; RTL_OSVERSIONINFOEXW versionInfo = { }; ULONGLONG conditionMask = 0; versionInfo.dwOSVersionInfoSize = sizeof(RTL_OSVERSIONINFOEXW); versionInfo.dwMajorVersion = major; versionInfo.dwMinorVersion = minor; VER_SET_CONDITION(conditionMask, VER_MAJORVERSION, VER_GREATER_EQUAL); VER_SET_CONDITION(conditionMask, VER_MINORVERSION, VER_GREATER_EQUAL); return (RtlVerifyVersionInfoFn(&versionInfo, VER_MAJORVERSION | VER_MINORVERSION, conditionMask) == 0) ? TRUE : FALSE; } #define _IsWindowsVistaOrGreater() _IsWindowsVersionOrGreater(HIBYTE(0x0600), LOBYTE(0x0600), 0) // _WIN32_WINNT_VISTA #define _IsWindows8OrGreater() _IsWindowsVersionOrGreater(HIBYTE(0x0602), LOBYTE(0x0602), 0) // _WIN32_WINNT_WIN8 #define _IsWindows8Point1OrGreater() _IsWindowsVersionOrGreater(HIBYTE(0x0603), LOBYTE(0x0603), 0) // _WIN32_WINNT_WINBLUE #define _IsWindows10OrGreater() _IsWindowsVersionOrGreater(HIBYTE(0x0A00), LOBYTE(0x0A00), 0) // _WIN32_WINNT_WINTHRESHOLD / _WIN32_WINNT_WIN10 #ifndef DPI_ENUMS_DECLARED typedef enum { PROCESS_DPI_UNAWARE = 0, PROCESS_SYSTEM_DPI_AWARE = 1, PROCESS_PER_MONITOR_DPI_AWARE = 2 } PROCESS_DPI_AWARENESS; typedef enum { MDT_EFFECTIVE_DPI = 0, MDT_ANGULAR_DPI = 1, MDT_RAW_DPI = 2, MDT_DEFAULT = MDT_EFFECTIVE_DPI } MONITOR_DPI_TYPE; #endif #ifndef _DPI_AWARENESS_CONTEXTS_ DECLARE_HANDLE(DPI_AWARENESS_CONTEXT); #define DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE (DPI_AWARENESS_CONTEXT)-3 #endif #ifndef DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE_V2 #define DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE_V2 (DPI_AWARENESS_CONTEXT)-4 #endif typedef HRESULT(WINAPI* PFN_SetProcessDpiAwareness)(PROCESS_DPI_AWARENESS); // Shcore.lib + dll, Windows 8.1+ typedef HRESULT(WINAPI* PFN_GetDpiForMonitor)(HMONITOR, MONITOR_DPI_TYPE, UINT*, UINT*); // Shcore.lib + dll, Windows 8.1+ typedef DPI_AWARENESS_CONTEXT(WINAPI* PFN_SetThreadDpiAwarenessContext)(DPI_AWARENESS_CONTEXT); // User32.lib + dll, Windows 10 v1607+ (Creators Update) // Helper function to enable DPI awareness without setting up a manifest void ImGui_ImplWin32_EnableDpiAwareness() { if (_IsWindows10OrGreater()) { static HINSTANCE user32_dll = ::LoadLibraryA("user32.dll"); // Reference counted per-process if (PFN_SetThreadDpiAwarenessContext SetThreadDpiAwarenessContextFn = (PFN_SetThreadDpiAwarenessContext)::GetProcAddress(user32_dll, "SetThreadDpiAwarenessContext")) { SetThreadDpiAwarenessContextFn(DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE_V2); return; } } if (_IsWindows8Point1OrGreater()) { static HINSTANCE shcore_dll = ::LoadLibraryA("shcore.dll"); // Reference counted per-process if (PFN_SetProcessDpiAwareness SetProcessDpiAwarenessFn = (PFN_SetProcessDpiAwareness)::GetProcAddress(shcore_dll, "SetProcessDpiAwareness")) { SetProcessDpiAwarenessFn(PROCESS_PER_MONITOR_DPI_AWARE); return; } } #if _WIN32_WINNT >= 0x0600 ::SetProcessDPIAware(); #endif } #if defined(_MSC_VER) && !defined(NOGDI) #pragma comment(lib, "gdi32") // Link with gdi32.lib for GetDeviceCaps(). MinGW will require linking with '-lgdi32' #endif float ImGui_ImplWin32_GetDpiScaleForMonitor(void* monitor) { UINT xdpi = 96, ydpi = 96; if (_IsWindows8Point1OrGreater()) { static HINSTANCE shcore_dll = ::LoadLibraryA("shcore.dll"); // Reference counted per-process static PFN_GetDpiForMonitor GetDpiForMonitorFn = nullptr; if (GetDpiForMonitorFn == nullptr && shcore_dll != nullptr) GetDpiForMonitorFn = (PFN_GetDpiForMonitor)::GetProcAddress(shcore_dll, "GetDpiForMonitor"); if (GetDpiForMonitorFn != nullptr) { GetDpiForMonitorFn((HMONITOR)monitor, MDT_EFFECTIVE_DPI, &xdpi, &ydpi); IM_ASSERT(xdpi == ydpi); // Please contact me if you hit this assert! return xdpi / 96.0f; } } #ifndef NOGDI const HDC dc = ::GetDC(nullptr); xdpi = ::GetDeviceCaps(dc, LOGPIXELSX); ydpi = ::GetDeviceCaps(dc, LOGPIXELSY); IM_ASSERT(xdpi == ydpi); // Please contact me if you hit this assert! ::ReleaseDC(nullptr, dc); #endif return xdpi / 96.0f; } float ImGui_ImplWin32_GetDpiScaleForHwnd(void* hwnd) { HMONITOR monitor = ::MonitorFromWindow((HWND)hwnd, MONITOR_DEFAULTTONEAREST); return ImGui_ImplWin32_GetDpiScaleForMonitor(monitor); } //--------------------------------------------------------------------------------------------------------- // Transparency related helpers (optional) //-------------------------------------------------------------------------------------------------------- #if defined(_MSC_VER) #pragma comment(lib, "dwmapi") // Link with dwmapi.lib. MinGW will require linking with '-ldwmapi' #endif // [experimental] // Borrowed from GLFW's function updateFramebufferTransparency() in src/win32_window.c // (the Dwm* functions are Vista era functions but we are borrowing logic from GLFW) void ImGui_ImplWin32_EnableAlphaCompositing(void* hwnd) { if (!_IsWindowsVistaOrGreater()) return; BOOL composition; if (FAILED(::DwmIsCompositionEnabled(&composition)) || !composition) return; BOOL opaque; DWORD color; if (_IsWindows8OrGreater() || (SUCCEEDED(::DwmGetColorizationColor(&color, &opaque)) && !opaque)) { HRGN region = ::CreateRectRgn(0, 0, -1, -1); DWM_BLURBEHIND bb = {}; bb.dwFlags = DWM_BB_ENABLE | DWM_BB_BLURREGION; bb.hRgnBlur = region; bb.fEnable = TRUE; ::DwmEnableBlurBehindWindow((HWND)hwnd, &bb); ::DeleteObject(region); } else { DWM_BLURBEHIND bb = {}; bb.dwFlags = DWM_BB_ENABLE; ::DwmEnableBlurBehindWindow((HWND)hwnd, &bb); } } //--------------------------------------------------------------------------------------------------------- IMGUI_IMPL_API void ImGui_ImplOpenVR_NewFrame() { ImGuiIO& io = ImGui::GetIO(); ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData(); IM_ASSERT(bd != NULL && "Did you call ImGui_ImplWin32_Init()?"); // Setup time step INT64 current_time = 0; ::QueryPerformanceCounter((LARGE_INTEGER*)¤t_time); io.DeltaTime = (float)(current_time - bd->Time) / bd->TicksPerSecond; bd->Time = current_time; //No Gamepad support for now //Process on-screen keyboard queue if ( (!ImGui::IsKeyDown(ImGuiKey_Backspace)) && (!ImGui::IsKeyDown(ImGuiKey_Enter)) ) { if ( (io.InputQueueCharacters.empty()) && (!g_OnScreenKeyboardQueue.empty()) ) { g_OnScreenKeyboardQueueDelay++; //This delay stuff may make this hacky and not that visually pleasing, but it seems required to reliably execute //the multiple backspaces SteamVR sends to autocorrect spelling when using suggestions on the on-screen keyboard //...meanwhile Valve removed suggestions from the minimal on-screen keyboard so this isn't technically needed anymore. //Doesn't hurt to have it, though. if (g_OnScreenKeyboardQueueDelay == 2) { g_OnScreenKeyboardQueueDelay = 0; ImGui_ImplOpenVR_AddInputFromOSK(g_OnScreenKeyboardQueue.front().c_str()); g_OnScreenKeyboardQueue.pop(); } } } } // Process OpenVR events related to ImGui inputs // returns true if the event was handled IMGUI_IMPL_API bool ImGui_ImplOpenVR_InputEventHandler(const vr::VREvent_t& vr_event, ImVec4* mouse_clamp_rect) { if (ImGui::GetCurrentContext() == nullptr) return false; ImGuiIO& io = ImGui::GetIO(); switch (vr_event.eventType) { case vr::VREvent_MouseMove: { ImVec2 mouse_pos(vr_event.data.mouse.x, -vr_event.data.mouse.y + io.DisplaySize.y); if (mouse_clamp_rect != nullptr) { mouse_pos.x = ImClamp(mouse_pos.x, mouse_clamp_rect->x, mouse_clamp_rect->z); mouse_pos.y = ImClamp(mouse_pos.y, mouse_clamp_rect->y, mouse_clamp_rect->w); } io.AddMousePosEvent(mouse_pos.x, mouse_pos.y); return true; } case vr::VREvent_FocusLeave: { //Pointer left the overlay io.AddMousePosEvent(-FLT_MAX, -FLT_MAX); //Release mouse buttons if they're still down (not the case in most situations) for (ImGuiMouseButton button = ImGuiMouseButton_Left; button < ImGuiMouseButton_COUNT; ++button) { io.AddMouseButtonEvent(button, false); } return true; } case vr::VREvent_MouseButtonDown: case vr::VREvent_MouseButtonUp: { int button = ImGuiMouseButton_Left; switch (vr_event.data.mouse.button) { case vr::VRMouseButton_Left: button = ImGuiMouseButton_Left; break; case vr::VRMouseButton_Right: button = ImGuiMouseButton_Right; break; case vr::VRMouseButton_Middle: button = ImGuiMouseButton_Middle; break; case VRMouseButton_DP_Aux01: button = ImGuiMouseButton_Middle + 1; break; case VRMouseButton_DP_Aux02: button = ImGuiMouseButton_Middle + 2; break; } io.AddMouseButtonEvent(button, (vr_event.eventType == vr::VREvent_MouseButtonDown)); return true; } case vr::VREvent_ScrollDiscrete: case vr::VREvent_ScrollSmooth: { io.AddMouseWheelEvent(vr_event.data.scroll.xdelta, vr_event.data.scroll.ydelta); return true; } case vr::VREvent_KeyboardCharInput: { ImGui_ImplOpenVR_AddInputFromOSK(vr_event.data.keyboard.cNewInput); return true; } case vr::VREvent_KeyboardClosed: { ImGui_ImplOpenVR_InputOnVRKeyboardClosed(); return true; } } return false; } IMGUI_IMPL_API vr::EVROverlayError ImGui_ImplOpenVR_InputResetVRKeyboard(vr::VROverlayHandle_t overlay_handle) { vr::EVROverlayError keyboard_error = vr::VROverlayError_None; ImGuiIO& io = ImGui::GetIO(); //Reset these keys in case they were pressed by the VR keyboard io.AddKeyEvent(ImGuiKey_Backspace, false); io.AddKeyEvent(ImGuiKey_Enter, false); //Show keyboard if needed if (io.WantTextInput) { if ( (!g_OnScreenKeyboardShown) && (!g_OnScreenKeyboardDismissedLastFrame) ) { keyboard_error = vr::VROverlay()->ShowKeyboardForOverlay(overlay_handle, vr::k_EGamepadTextInputModeNormal, vr::k_EGamepadTextInputLineModeSingleLine, vr::KeyboardFlag_Minimal, "ImGuiInput", 1024, "", 0); if (keyboard_error == vr::VROverlayError_None) { //Covers whole overlay vr::HmdRect2_t keyrect; keyrect.vTopLeft = {0.0f, 1.0f}; keyrect.vBottomRight = {1.0f, 0.0f}; vr::VROverlay()->SetKeyboardPositionForOverlay(overlay_handle, keyrect); //Avoid covering the overlay with the keyboard g_OnScreenKeyboardShown = true; } } } else if (g_OnScreenKeyboardShown) { vr::VROverlay()->HideKeyboard(); g_OnScreenKeyboardShown = false; } g_OnScreenKeyboardDismissedLastFrame = false; return keyboard_error; } IMGUI_IMPL_API void ImGui_ImplOpenVR_InputOnVRKeyboardClosed() { ImGuiIO& io = ImGui::GetIO(); if (io.WantTextInput) { ImGui::ClearActiveID(); io.WantTextInput = false; g_OnScreenKeyboardDismissedLastFrame = true; //Widgets will request the keyboard for the next frame anyways, so we prevent showing it again right away with this flag } g_OnScreenKeyboardShown = false; } IMGUI_IMPL_API void ImGui_ImplOpenVR_SetIntersectionMaskFromWindows(vr::VROverlayHandle_t* overlay_handles, size_t overlay_count, std::vector* primitives_out) { ImGuiContext& g = *ImGui::GetCurrentContext(); std::vector primitives; primitives.reserve(g.Windows.Size); //Avoid resizing in the loop for (int n = 0; n < g.Windows.Size; n++) { ImGuiWindow* window = g.Windows[n]; if (!window->WasActive) continue; if (!(window->Flags & ImGuiWindowFlags_ChildWindow)) { vr::VROverlayIntersectionMaskPrimitive_t primitive; primitive.m_nPrimitiveType = vr::OverlayIntersectionPrimitiveType_Rectangle; primitive.m_Primitive.m_Rectangle.m_flTopLeftX = window->OuterRectClipped.GetTL().x; primitive.m_Primitive.m_Rectangle.m_flTopLeftY = window->OuterRectClipped.GetTL().y; primitive.m_Primitive.m_Rectangle.m_flWidth = window->OuterRectClipped.GetWidth(); primitive.m_Primitive.m_Rectangle.m_flHeight = window->OuterRectClipped.GetHeight(); primitives.push_back(primitive); } } for (size_t i = 0; i < overlay_count; ++i) { vr::VROverlay()->SetOverlayIntersectionMask(overlay_handles[i], primitives.data(), (uint32_t)primitives.size()); } if (primitives_out != nullptr) { *primitives_out = std::move(primitives); } } void ImGui_ImplOpenVR_AddInputFromOSK(const char* input) { ImGuiIO& io = ImGui::GetIO(); //If backspace is already being pressed, we have to queue the remaining inputs up and delay them 1 frame if (ImGui::IsKeyDown(ImGuiKey_Backspace)) { g_OnScreenKeyboardQueue.push(input); } else { if (*input == '\b') { io.AddKeyEvent(ImGuiKey_Backspace, true); } else if (*input == '\n') { io.AddKeyEvent(ImGuiKey_Enter, true); } else { io.AddInputCharactersUTF8(input); } } } #if defined(__GNUC__) #pragma GCC diagnostic pop #endif #if defined(__clang__) #pragma clang diagnostic pop #endif #endif // #ifndef IMGUI_DISABLE ================================================ FILE: src/DesktopPlusUI/imgui_win32_dx11_openvr/imgui_impl_win32_openvr.h ================================================ // Desktop+UI: Modified for OpenVR compatibility // dear imgui: Platform Backend for Windows (standard windows API for 32-bits AND 64-bits applications) // This needs to be used along with a Renderer (e.g. DirectX11, OpenGL3, Vulkan..) // Implemented features: // [X] Platform: Clipboard support (for Win32 this is actually part of core dear imgui) // [X] Platform: Mouse support. Can discriminate Mouse/TouchScreen/Pen. // [X] Platform: Keyboard support. Since 1.87 we are using the io.AddKeyEvent() function. Pass ImGuiKey values to all key functions e.g. ImGui::IsKeyPressed(ImGuiKey_Space). [Legacy VK_* values are obsolete since 1.87 and not supported since 1.91.5] // [X] Platform: Gamepad support. Enabled with 'io.ConfigFlags |= ImGuiConfigFlags_NavEnableGamepad'. // [X] Platform: Mouse cursor shape and visibility (ImGuiBackendFlags_HasMouseCursors). Disable with 'io.ConfigFlags |= ImGuiConfigFlags_NoMouseCursorChange'. // You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this. // Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need. // Learn about Dear ImGui: // - FAQ https://dearimgui.com/faq // - Getting Started https://dearimgui.com/getting-started // - Documentation https://dearimgui.com/docs (same as your local docs/ folder). // - Introduction, links and more at the top of imgui.cpp #pragma once #include "imgui.h" // IMGUI_IMPL_API #ifndef IMGUI_DISABLE #include // Follow "Getting Started" link and check examples/ folder to learn about using backends! IMGUI_IMPL_API bool ImGui_ImplWin32_Init(void* hwnd); IMGUI_IMPL_API bool ImGui_ImplWin32_InitForOpenGL(void* hwnd); IMGUI_IMPL_API void ImGui_ImplWin32_Shutdown(); IMGUI_IMPL_API void ImGui_ImplWin32_NewFrame(); IMGUI_IMPL_API ImGuiKey ImGui_ImplWin32_KeyEventToImGuiKey(uint64_t wParam, int64_t lParam); //Exposed for VRKeyboard // Win32 message handler your application need to call. // - Intentionally commented out in a '#if 0' block to avoid dragging dependencies on from this helper. // - You should COPY the line below into your .cpp code to forward declare the function and then you can call it. // - Call from your application's message handler. Keep calling your message handler unless this function returns TRUE. #if 0 extern IMGUI_IMPL_API LRESULT ImGui_ImplWin32_WndProcHandler(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam); #endif // DPI-related helpers (optional) // - Use to enable DPI awareness without having to create an application manifest. // - Your own app may already do this via a manifest or explicit calls. This is mostly useful for our examples/ apps. // - In theory we could call simple functions from Windows SDK such as SetProcessDPIAware(), SetProcessDpiAwareness(), etc. // but most of the functions provided by Microsoft require Windows 8.1/10+ SDK at compile time and Windows 8/10+ at runtime, // neither we want to require the user to have. So we dynamically select and load those functions to avoid dependencies. IMGUI_IMPL_API void ImGui_ImplWin32_EnableDpiAwareness(); IMGUI_IMPL_API float ImGui_ImplWin32_GetDpiScaleForHwnd(void* hwnd); // HWND hwnd IMGUI_IMPL_API float ImGui_ImplWin32_GetDpiScaleForMonitor(void* monitor); // HMONITOR monitor // Transparency related helpers (optional) [experimental] // - Use to enable alpha compositing transparency with the desktop. // - Use together with e.g. clearing your framebuffer with zero-alpha. IMGUI_IMPL_API void ImGui_ImplWin32_EnableAlphaCompositing(void* hwnd); // HWND hwnd #include #include "openvr.h" // If this is called, do not call ImGui_ImplWin32_NewFrame(). ImGui_ImplWin32_NewFrame() can still be used for a normal desktop mode or similar. IMGUI_IMPL_API void ImGui_ImplOpenVR_NewFrame(); // Handler for OpenVR Events // mouse_clamp_rect is optional rectangle used to clamp mouse coordinates (x min, y min, x max, y max) // Returns true if the event was handled IMGUI_IMPL_API bool ImGui_ImplOpenVR_InputEventHandler(const vr::VREvent_t& vr_event, ImVec4* mouse_clamp_rect = nullptr); // Resets internal extra keyboard state for VR keyboard handling // This needs to be called before a NewFrame and handling the OpenVR events // Returns the overlay error returned by IVROverlay::ShowKeyboardForOverlay() IMGUI_IMPL_API vr::EVROverlayError ImGui_ImplOpenVR_InputResetVRKeyboard(vr::VROverlayHandle_t overlay_handle); // Called on VREvent_KeyboardClosed // Exposed for application to call if the keyboard is handled by something else IMGUI_IMPL_API void ImGui_ImplOpenVR_InputOnVRKeyboardClosed(); // Called on VREvent_KeyboardCharInput // Exposed for application to call if the keyboard is handled by something else IMGUI_IMPL_API void ImGui_ImplOpenVR_AddInputFromOSK(const char* input); // Set overlay intersection mask from current top-level window outer rects, optionally writes primitives sent to SteamVR into primitves_out IMGUI_IMPL_API void ImGui_ImplOpenVR_SetIntersectionMaskFromWindows(vr::VROverlayHandle_t* overlay_handles, size_t overlay_count, std::vector* primitives_out = nullptr); #endif // #ifndef IMGUI_DISABLE ================================================ FILE: src/DesktopPlusUI/implot/implot.cpp ================================================ // MIT License // Copyright (c) 2023 Evan Pezent // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files (the "Software"), to deal // in the Software without restriction, including without limitation the rights // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell // copies of the Software, and to permit persons to whom the Software is // furnished to do so, subject to the following conditions: // The above copyright notice and this permission notice shall be included in all // copies or substantial portions of the Software. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE // SOFTWARE. // ImPlot v0.16 /* API BREAKING CHANGES ==================== Occasionally introducing changes that are breaking the API. We try to make the breakage minor and easy to fix. Below is a change-log of API breaking changes only. If you are using one of the functions listed, expect to have to fix some code. When you are not sure about a old symbol or function name, try using the Search/Find function of your IDE to look for comments or references in all implot files. You can read releases logs https://github.com/epezent/implot/releases for more details. - 2023/06/26 (0.15) - Various build fixes related to updates in Dear ImGui internals. - 2022/11/25 (0.15) - Make PlotText honor ImPlotItemFlags_NoFit. - 2022/06/19 (0.14) - The signature of ColormapScale has changed to accommodate a new ImPlotColormapScaleFlags parameter - 2022/06/17 (0.14) - **IMPORTANT** All PlotX functions now take an ImPlotX_Flags `flags` parameter. Where applicable, it is located before the existing `offset` and `stride` parameters. If you were providing offset and stride values, you will need to update your function call to include a `flags` value. If you fail to do this, you will likely see unexpected results or crashes without a compiler warning since these three are all default args. We apologize for the inconvenience, but this was a necessary evil. - PlotBarsH has been removed; use PlotBars + ImPlotBarsFlags_Horizontal instead - PlotErrorBarsH has been removed; use PlotErrorBars + ImPlotErrorBarsFlags_Horizontal - PlotHistogram/PlotHistogram2D signatures changed; `cumulative`, `density`, and `outliers` options now specified via ImPlotHistogramFlags - PlotPieChart signature changed; `normalize` option now specified via ImPlotPieChartFlags - PlotText signature changes; `vertical` option now specified via `ImPlotTextFlags_Vertical` - `PlotVLines` and `PlotHLines` replaced with `PlotInfLines` (+ ImPlotInfLinesFlags_Horizontal ) - arguments of ImPlotGetter have been reversed to be consistent with other API callbacks - SetupAxisScale + ImPlotScale have replaced ImPlotAxisFlags_LogScale and ImPlotAxisFlags_Time flags - ImPlotFormatters should now return an int indicating the size written - the signature of ImPlotGetter has been reversed so that void* user_data is the last argument and consistent with other callbacks - 2021/10/19 (0.13) - MAJOR API OVERHAUL! See #168 and #272 - TRIVIAL RENAME: - ImPlotLimits -> ImPlotRect - ImPlotYAxis_ -> ImAxis_ - SetPlotYAxis -> SetAxis - BeginDragDropTarget -> BeginDragDropTargetPlot - BeginDragDropSource -> BeginDragDropSourcePlot - ImPlotFlags_NoMousePos -> ImPlotFlags_NoMouseText - SetNextPlotLimits -> SetNextAxesLimits - SetMouseTextLocation -> SetupMouseText - SIGNATURE MODIFIED: - PixelsToPlot/PlotToPixels -> added optional X-Axis arg - GetPlotMousePos -> added optional X-Axis arg - GetPlotLimits -> added optional X-Axis arg - GetPlotSelection -> added optional X-Axis arg - DragLineX/Y/DragPoint -> now takes int id; removed labels (render with Annotation/Tag instead) - REPLACED: - IsPlotXAxisHovered/IsPlotXYAxisHovered -> IsAxisHovered(ImAxis) - BeginDragDropTargetX/BeginDragDropTargetY -> BeginDragDropTargetAxis(ImAxis) - BeginDragDropSourceX/BeginDragDropSourceY -> BeginDragDropSourceAxis(ImAxis) - ImPlotCol_XAxis, ImPlotCol_YAxis1, etc. -> ImPlotCol_AxisText (push/pop this around SetupAxis to style individual axes) - ImPlotCol_XAxisGrid, ImPlotCol_Y1AxisGrid -> ImPlotCol_AxisGrid (push/pop this around SetupAxis to style individual axes) - SetNextPlotLimitsX/Y -> SetNextAxisLimits(ImAxis) - LinkNextPlotLimits -> SetNextAxisLinks(ImAxis) - FitNextPlotAxes -> SetNextAxisToFit(ImAxis)/SetNextAxesToFit - SetLegendLocation -> SetupLegend - ImPlotFlags_NoHighlight -> ImPlotLegendFlags_NoHighlight - ImPlotOrientation -> ImPlotLegendFlags_Horizontal - Annotate -> Annotation - REMOVED: - GetPlotQuery, SetPlotQuery, IsPlotQueried -> use DragRect - SetNextPlotTicksX, SetNextPlotTicksY -> use SetupAxisTicks - SetNextPlotFormatX, SetNextPlotFormatY -> use SetupAxisFormat - AnnotateClamped -> use Annotation(bool clamp = true) - OBSOLETED: - BeginPlot (original signature) -> use simplified signature + Setup API - 2021/07/30 (0.12) - The offset argument of `PlotXG` functions was been removed. Implement offsetting in your getter callback instead. - 2021/03/08 (0.9) - SetColormap and PushColormap(ImVec4*) were removed. Use AddColormap for custom colormap support. LerpColormap was changed to SampleColormap. ShowColormapScale was changed to ColormapScale and requires additional arguments. - 2021/03/07 (0.9) - The signature of ShowColormapScale was modified to accept a ImVec2 size. - 2021/02/28 (0.9) - BeginLegendDragDropSource was changed to BeginDragDropSourceItem with a number of other drag and drop improvements. - 2021/01/18 (0.9) - The default behavior for opening context menus was change from double right-click to single right-click. ImPlotInputMap and related functions were moved to implot_internal.h due to its immaturity. - 2020/10/16 (0.8) - ImPlotStyleVar_InfoPadding was changed to ImPlotStyleVar_MousePosPadding - 2020/09/10 (0.8) - The single array versions of PlotLine, PlotScatter, PlotStems, and PlotShaded were given additional arguments for x-scale and x0. - 2020/09/07 (0.8) - Plotting functions which accept a custom getter function pointer have been post-fixed with a G (e.g. PlotLineG) - 2020/09/06 (0.7) - Several flags under ImPlotFlags and ImPlotAxisFlags were inverted (e.g. ImPlotFlags_Legend -> ImPlotFlags_NoLegend) so that the default flagset is simply 0. This more closely matches ImGui's style and makes it easier to enable non-default but commonly used flags (e.g. ImPlotAxisFlags_Time). - 2020/08/28 (0.5) - ImPlotMarker_ can no longer be combined with bitwise OR, |. This features caused unecessary slow-down, and almost no one used it. - 2020/08/25 (0.5) - ImPlotAxisFlags_Scientific was removed. Logarithmic axes automatically uses scientific notation. - 2020/08/17 (0.5) - PlotText was changed so that text is centered horizontally and vertically about the desired point. - 2020/08/16 (0.5) - An ImPlotContext must be explicitly created and destroyed now with `CreateContext` and `DestroyContext`. Previously, the context was statically initialized in this source file. - 2020/06/13 (0.4) - The flags `ImPlotAxisFlag_Adaptive` and `ImPlotFlags_Cull` were removed. Both are now done internally by default. - 2020/06/03 (0.3) - The signature and behavior of PlotPieChart was changed so that data with sum less than 1 can optionally be normalized. The label format can now be specified as well. - 2020/06/01 (0.3) - SetPalette was changed to `SetColormap` for consistency with other plotting libraries. `RestorePalette` was removed. Use `SetColormap(ImPlotColormap_Default)`. - 2020/05/31 (0.3) - Plot functions taking custom ImVec2* getters were removed. Use the ImPlotPoint* getter versions instead. - 2020/05/29 (0.3) - The signature of ImPlotLimits::Contains was changed to take two doubles instead of ImVec2 - 2020/05/16 (0.2) - All plotting functions were reverted to being prefixed with "Plot" to maintain a consistent VerbNoun style. `Plot` was split into `PlotLine` and `PlotScatter` (however, `PlotLine` can still be used to plot scatter points as `Plot` did before.). `Bar` is not `PlotBars`, to indicate that multiple bars will be plotted. - 2020/05/13 (0.2) - `ImMarker` was change to `ImPlotMarker` and `ImAxisFlags` was changed to `ImPlotAxisFlags`. - 2020/05/11 (0.2) - `ImPlotFlags_Selection` was changed to `ImPlotFlags_BoxSelect` - 2020/05/11 (0.2) - The namespace ImGui:: was replaced with ImPlot::. As a result, the following additional changes were made: - Functions that were prefixed or decorated with the word "Plot" have been truncated. E.g., `ImGui::PlotBars` is now just `ImPlot::Bar`. It should be fairly obvious what was what. - Some functions have been given names that would have otherwise collided with the ImGui namespace. This has been done to maintain a consistent style with ImGui. E.g., 'ImGui::PushPlotStyleVar` is now 'ImPlot::PushStyleVar'. - 2020/05/10 (0.2) - The following function/struct names were changes: - ImPlotRange -> ImPlotLimits - GetPlotRange() -> GetPlotLimits() - SetNextPlotRange -> SetNextPlotLimits - SetNextPlotRangeX -> SetNextPlotLimitsX - SetNextPlotRangeY -> SetNextPlotLimitsY - 2020/05/10 (0.2) - Plot queries are pixel based by default. Query rects that maintain relative plot position have been removed. This was done to support multi-y-axis. */ #define IMGUI_DEFINE_MATH_OPERATORS #include "implot.h" #include "implot_internal.h" #include // Support for pre-1.82 versions. Users on 1.82+ can use 0 (default) flags to mean "all corners" but in order to support older versions we are more explicit. #if (IMGUI_VERSION_NUM < 18102) && !defined(ImDrawFlags_RoundCornersAll) #define ImDrawFlags_RoundCornersAll ImDrawCornerFlags_All #endif // Support for pre-1.89.7 versions. #if (IMGUI_VERSION_NUM < 18966) #define ImGuiButtonFlags_AllowOverlap ImGuiButtonFlags_AllowItemOverlap #endif // Visual Studio warnings #ifdef _MSC_VER #pragma warning (disable: 4996) // 'This function or variable may be unsafe': strcpy, strdup, sprintf, vsnprintf, sscanf, fopen #endif // Clang/GCC warnings with -Weverything #if defined(__clang__) #pragma clang diagnostic ignored "-Wformat-nonliteral" // warning: format string is not a string literal #elif defined(__GNUC__) #pragma GCC diagnostic ignored "-Wformat-nonliteral" // warning: format not a string literal, format string not checked #endif // Global plot context #ifndef GImPlot ImPlotContext* GImPlot = nullptr; #endif //----------------------------------------------------------------------------- // Struct Implementations //----------------------------------------------------------------------------- ImPlotInputMap::ImPlotInputMap() { ImPlot::MapInputDefault(this); } ImPlotStyle::ImPlotStyle() { LineWeight = 1; Marker = ImPlotMarker_None; MarkerSize = 4; MarkerWeight = 1; FillAlpha = 1; ErrorBarSize = 5; ErrorBarWeight = 1.5f; DigitalBitHeight = 8; DigitalBitGap = 4; PlotBorderSize = 1; MinorAlpha = 0.25f; MajorTickLen = ImVec2(10,10); MinorTickLen = ImVec2(5,5); MajorTickSize = ImVec2(1,1); MinorTickSize = ImVec2(1,1); MajorGridSize = ImVec2(1,1); MinorGridSize = ImVec2(1,1); PlotPadding = ImVec2(10,10); LabelPadding = ImVec2(5,5); LegendPadding = ImVec2(10,10); LegendInnerPadding = ImVec2(5,5); LegendSpacing = ImVec2(5,0); MousePosPadding = ImVec2(10,10); AnnotationPadding = ImVec2(2,2); FitPadding = ImVec2(0,0); PlotDefaultSize = ImVec2(400,300); PlotMinSize = ImVec2(200,150); ImPlot::StyleColorsAuto(this); Colormap = ImPlotColormap_Deep; UseLocalTime = false; Use24HourClock = false; UseISO8601 = false; } //----------------------------------------------------------------------------- // Style //----------------------------------------------------------------------------- namespace ImPlot { const char* GetStyleColorName(ImPlotCol col) { static const char* col_names[ImPlotCol_COUNT] = { "Line", "Fill", "MarkerOutline", "MarkerFill", "ErrorBar", "FrameBg", "PlotBg", "PlotBorder", "LegendBg", "LegendBorder", "LegendText", "TitleText", "InlayText", "AxisText", "AxisGrid", "AxisTick", "AxisBg", "AxisBgHovered", "AxisBgActive", "Selection", "Crosshairs" }; return col_names[col]; } const char* GetMarkerName(ImPlotMarker marker) { switch (marker) { case ImPlotMarker_None: return "None"; case ImPlotMarker_Circle: return "Circle"; case ImPlotMarker_Square: return "Square"; case ImPlotMarker_Diamond: return "Diamond"; case ImPlotMarker_Up: return "Up"; case ImPlotMarker_Down: return "Down"; case ImPlotMarker_Left: return "Left"; case ImPlotMarker_Right: return "Right"; case ImPlotMarker_Cross: return "Cross"; case ImPlotMarker_Plus: return "Plus"; case ImPlotMarker_Asterisk: return "Asterisk"; default: return ""; } } ImVec4 GetAutoColor(ImPlotCol idx) { ImVec4 col(0,0,0,1); switch(idx) { case ImPlotCol_Line: return col; // these are plot dependent! case ImPlotCol_Fill: return col; // these are plot dependent! case ImPlotCol_MarkerOutline: return col; // these are plot dependent! case ImPlotCol_MarkerFill: return col; // these are plot dependent! case ImPlotCol_ErrorBar: return ImGui::GetStyleColorVec4(ImGuiCol_Text); case ImPlotCol_FrameBg: return ImGui::GetStyleColorVec4(ImGuiCol_FrameBg); case ImPlotCol_PlotBg: return ImGui::GetStyleColorVec4(ImGuiCol_WindowBg); case ImPlotCol_PlotBorder: return ImGui::GetStyleColorVec4(ImGuiCol_Border); case ImPlotCol_LegendBg: return ImGui::GetStyleColorVec4(ImGuiCol_PopupBg); case ImPlotCol_LegendBorder: return GetStyleColorVec4(ImPlotCol_PlotBorder); case ImPlotCol_LegendText: return GetStyleColorVec4(ImPlotCol_InlayText); case ImPlotCol_TitleText: return ImGui::GetStyleColorVec4(ImGuiCol_Text); case ImPlotCol_InlayText: return ImGui::GetStyleColorVec4(ImGuiCol_Text); case ImPlotCol_AxisText: return ImGui::GetStyleColorVec4(ImGuiCol_Text); case ImPlotCol_AxisGrid: return GetStyleColorVec4(ImPlotCol_AxisText) * ImVec4(1,1,1,0.25f); case ImPlotCol_AxisTick: return GetStyleColorVec4(ImPlotCol_AxisGrid); case ImPlotCol_AxisBg: return ImVec4(0,0,0,0); case ImPlotCol_AxisBgHovered: return ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered); case ImPlotCol_AxisBgActive: return ImGui::GetStyleColorVec4(ImGuiCol_ButtonActive); case ImPlotCol_Selection: return ImVec4(1,1,0,1); case ImPlotCol_Crosshairs: return GetStyleColorVec4(ImPlotCol_PlotBorder); default: return col; } } struct ImPlotStyleVarInfo { ImGuiDataType Type; ImU32 Count; ImU32 Offset; void* GetVarPtr(ImPlotStyle* style) const { return (void*)((unsigned char*)style + Offset); } }; static const ImPlotStyleVarInfo GPlotStyleVarInfo[] = { { ImGuiDataType_Float, 1, (ImU32)offsetof(ImPlotStyle, LineWeight) }, // ImPlotStyleVar_LineWeight { ImGuiDataType_S32, 1, (ImU32)offsetof(ImPlotStyle, Marker) }, // ImPlotStyleVar_Marker { ImGuiDataType_Float, 1, (ImU32)offsetof(ImPlotStyle, MarkerSize) }, // ImPlotStyleVar_MarkerSize { ImGuiDataType_Float, 1, (ImU32)offsetof(ImPlotStyle, MarkerWeight) }, // ImPlotStyleVar_MarkerWeight { ImGuiDataType_Float, 1, (ImU32)offsetof(ImPlotStyle, FillAlpha) }, // ImPlotStyleVar_FillAlpha { ImGuiDataType_Float, 1, (ImU32)offsetof(ImPlotStyle, ErrorBarSize) }, // ImPlotStyleVar_ErrorBarSize { ImGuiDataType_Float, 1, (ImU32)offsetof(ImPlotStyle, ErrorBarWeight) }, // ImPlotStyleVar_ErrorBarWeight { ImGuiDataType_Float, 1, (ImU32)offsetof(ImPlotStyle, DigitalBitHeight) }, // ImPlotStyleVar_DigitalBitHeight { ImGuiDataType_Float, 1, (ImU32)offsetof(ImPlotStyle, DigitalBitGap) }, // ImPlotStyleVar_DigitalBitGap { ImGuiDataType_Float, 1, (ImU32)offsetof(ImPlotStyle, PlotBorderSize) }, // ImPlotStyleVar_PlotBorderSize { ImGuiDataType_Float, 1, (ImU32)offsetof(ImPlotStyle, MinorAlpha) }, // ImPlotStyleVar_MinorAlpha { ImGuiDataType_Float, 2, (ImU32)offsetof(ImPlotStyle, MajorTickLen) }, // ImPlotStyleVar_MajorTickLen { ImGuiDataType_Float, 2, (ImU32)offsetof(ImPlotStyle, MinorTickLen) }, // ImPlotStyleVar_MinorTickLen { ImGuiDataType_Float, 2, (ImU32)offsetof(ImPlotStyle, MajorTickSize) }, // ImPlotStyleVar_MajorTickSize { ImGuiDataType_Float, 2, (ImU32)offsetof(ImPlotStyle, MinorTickSize) }, // ImPlotStyleVar_MinorTickSize { ImGuiDataType_Float, 2, (ImU32)offsetof(ImPlotStyle, MajorGridSize) }, // ImPlotStyleVar_MajorGridSize { ImGuiDataType_Float, 2, (ImU32)offsetof(ImPlotStyle, MinorGridSize) }, // ImPlotStyleVar_MinorGridSize { ImGuiDataType_Float, 2, (ImU32)offsetof(ImPlotStyle, PlotPadding) }, // ImPlotStyleVar_PlotPadding { ImGuiDataType_Float, 2, (ImU32)offsetof(ImPlotStyle, LabelPadding) }, // ImPlotStyleVar_LabelPaddine { ImGuiDataType_Float, 2, (ImU32)offsetof(ImPlotStyle, LegendPadding) }, // ImPlotStyleVar_LegendPadding { ImGuiDataType_Float, 2, (ImU32)offsetof(ImPlotStyle, LegendInnerPadding) }, // ImPlotStyleVar_LegendInnerPadding { ImGuiDataType_Float, 2, (ImU32)offsetof(ImPlotStyle, LegendSpacing) }, // ImPlotStyleVar_LegendSpacing { ImGuiDataType_Float, 2, (ImU32)offsetof(ImPlotStyle, MousePosPadding) }, // ImPlotStyleVar_MousePosPadding { ImGuiDataType_Float, 2, (ImU32)offsetof(ImPlotStyle, AnnotationPadding) }, // ImPlotStyleVar_AnnotationPadding { ImGuiDataType_Float, 2, (ImU32)offsetof(ImPlotStyle, FitPadding) }, // ImPlotStyleVar_FitPadding { ImGuiDataType_Float, 2, (ImU32)offsetof(ImPlotStyle, PlotDefaultSize) }, // ImPlotStyleVar_PlotDefaultSize { ImGuiDataType_Float, 2, (ImU32)offsetof(ImPlotStyle, PlotMinSize) } // ImPlotStyleVar_PlotMinSize }; static const ImPlotStyleVarInfo* GetPlotStyleVarInfo(ImPlotStyleVar idx) { IM_ASSERT(idx >= 0 && idx < ImPlotStyleVar_COUNT); IM_ASSERT(IM_ARRAYSIZE(GPlotStyleVarInfo) == ImPlotStyleVar_COUNT); return &GPlotStyleVarInfo[idx]; } //----------------------------------------------------------------------------- // Generic Helpers //----------------------------------------------------------------------------- void AddTextVertical(ImDrawList *DrawList, ImVec2 pos, ImU32 col, const char *text_begin, const char* text_end) { // the code below is based loosely on ImFont::RenderText if (!text_end) text_end = text_begin + strlen(text_begin); ImGuiContext& g = *GImGui; ImFont* font = g.Font; // Align to be pixel perfect pos.x = IM_TRUNC(pos.x); pos.y = IM_TRUNC(pos.y); const float scale = g.FontSize / font->FontSize; const char* s = text_begin; int chars_exp = (int)(text_end - s); int chars_rnd = 0; const int vtx_count_max = chars_exp * 4; const int idx_count_max = chars_exp * 6; DrawList->PrimReserve(idx_count_max, vtx_count_max); while (s < text_end) { unsigned int c = (unsigned int)*s; if (c < 0x80) { s += 1; } else { s += ImTextCharFromUtf8(&c, s, text_end); if (c == 0) // Malformed UTF-8? break; } const ImFontGlyph * glyph = font->FindGlyph((ImWchar)c); if (glyph == nullptr) { continue; } DrawList->PrimQuadUV(pos + ImVec2(glyph->Y0, -glyph->X0) * scale, pos + ImVec2(glyph->Y0, -glyph->X1) * scale, pos + ImVec2(glyph->Y1, -glyph->X1) * scale, pos + ImVec2(glyph->Y1, -glyph->X0) * scale, ImVec2(glyph->U0, glyph->V0), ImVec2(glyph->U1, glyph->V0), ImVec2(glyph->U1, glyph->V1), ImVec2(glyph->U0, glyph->V1), col); pos.y -= glyph->AdvanceX * scale; chars_rnd++; } // Give back unused vertices int chars_skp = chars_exp-chars_rnd; DrawList->PrimUnreserve(chars_skp*6, chars_skp*4); } void AddTextCentered(ImDrawList* DrawList, ImVec2 top_center, ImU32 col, const char* text_begin, const char* text_end) { float txt_ht = ImGui::GetTextLineHeight(); const char* title_end = ImGui::FindRenderedTextEnd(text_begin, text_end); ImVec2 text_size; float y = 0; while (const char* tmp = (const char*)memchr(text_begin, '\n', title_end-text_begin)) { text_size = ImGui::CalcTextSize(text_begin,tmp,true); DrawList->AddText(ImVec2(top_center.x - text_size.x * 0.5f, top_center.y+y),col,text_begin,tmp); text_begin = tmp + 1; y += txt_ht; } text_size = ImGui::CalcTextSize(text_begin,title_end,true); DrawList->AddText(ImVec2(top_center.x - text_size.x * 0.5f, top_center.y+y),col,text_begin,title_end); } double NiceNum(double x, bool round) { double f; double nf; int expv = (int)floor(ImLog10(x)); f = x / ImPow(10.0, (double)expv); if (round) if (f < 1.5) nf = 1; else if (f < 3) nf = 2; else if (f < 7) nf = 5; else nf = 10; else if (f <= 1) nf = 1; else if (f <= 2) nf = 2; else if (f <= 5) nf = 5; else nf = 10; return nf * ImPow(10.0, expv); } //----------------------------------------------------------------------------- // Context Utils //----------------------------------------------------------------------------- void SetImGuiContext(ImGuiContext* ctx) { ImGui::SetCurrentContext(ctx); } ImPlotContext* CreateContext() { ImPlotContext* ctx = IM_NEW(ImPlotContext)(); Initialize(ctx); if (GImPlot == nullptr) SetCurrentContext(ctx); return ctx; } void DestroyContext(ImPlotContext* ctx) { if (ctx == nullptr) ctx = GImPlot; if (GImPlot == ctx) SetCurrentContext(nullptr); IM_DELETE(ctx); } ImPlotContext* GetCurrentContext() { return GImPlot; } void SetCurrentContext(ImPlotContext* ctx) { GImPlot = ctx; } #define IMPLOT_APPEND_CMAP(name, qual) ctx->ColormapData.Append(#name, name, sizeof(name)/sizeof(ImU32), qual) #define IM_RGB(r,g,b) IM_COL32(r,g,b,255) void Initialize(ImPlotContext* ctx) { ResetCtxForNextPlot(ctx); ResetCtxForNextAlignedPlots(ctx); ResetCtxForNextSubplot(ctx); const ImU32 Deep[] = {4289753676, 4283598045, 4285048917, 4283584196, 4289950337, 4284512403, 4291005402, 4287401100, 4285839820, 4291671396 }; const ImU32 Dark[] = {4280031972, 4290281015, 4283084621, 4288892568, 4278222847, 4281597951, 4280833702, 4290740727, 4288256409 }; const ImU32 Pastel[] = {4289639675, 4293119411, 4291161036, 4293184478, 4289124862, 4291624959, 4290631909, 4293712637, 4294111986 }; const ImU32 Paired[] = {4293119554, 4290017311, 4287291314, 4281114675, 4288256763, 4280031971, 4285513725, 4278222847, 4292260554, 4288298346, 4288282623, 4280834481}; const ImU32 Viridis[] = {4283695428, 4285867080, 4287054913, 4287455029, 4287526954, 4287402273, 4286883874, 4285579076, 4283552122, 4280737725, 4280674301 }; const ImU32 Plasma[] = {4287039501, 4288480321, 4289200234, 4288941455, 4287638193, 4286072780, 4284638433, 4283139314, 4281771772, 4280667900, 4280416752 }; const ImU32 Hot[] = {4278190144, 4278190208, 4278190271, 4278190335, 4278206719, 4278223103, 4278239231, 4278255615, 4283826175, 4289396735, 4294967295 }; const ImU32 Cool[] = {4294967040, 4294960666, 4294954035, 4294947661, 4294941030, 4294934656, 4294928025, 4294921651, 4294915020, 4294908646, 4294902015 }; const ImU32 Pink[] = {4278190154, 4282532475, 4284308894, 4285690554, 4286879686, 4287870160, 4288794330, 4289651940, 4291685869, 4293392118, 4294967295 }; const ImU32 Jet[] = {4289331200, 4294901760, 4294923520, 4294945280, 4294967040, 4289396565, 4283826090, 4278255615, 4278233855, 4278212095, 4278190335 }; const ImU32 Twilight[] = {IM_RGB(226,217,226),IM_RGB(166,191,202),IM_RGB(109,144,192),IM_RGB(95,88,176),IM_RGB(83,30,124),IM_RGB(47,20,54),IM_RGB(100,25,75),IM_RGB(159,60,80),IM_RGB(192,117,94),IM_RGB(208,179,158),IM_RGB(226,217,226)}; const ImU32 RdBu[] = {IM_RGB(103,0,31),IM_RGB(178,24,43),IM_RGB(214,96,77),IM_RGB(244,165,130),IM_RGB(253,219,199),IM_RGB(247,247,247),IM_RGB(209,229,240),IM_RGB(146,197,222),IM_RGB(67,147,195),IM_RGB(33,102,172),IM_RGB(5,48,97)}; const ImU32 BrBG[] = {IM_RGB(84,48,5),IM_RGB(140,81,10),IM_RGB(191,129,45),IM_RGB(223,194,125),IM_RGB(246,232,195),IM_RGB(245,245,245),IM_RGB(199,234,229),IM_RGB(128,205,193),IM_RGB(53,151,143),IM_RGB(1,102,94),IM_RGB(0,60,48)}; const ImU32 PiYG[] = {IM_RGB(142,1,82),IM_RGB(197,27,125),IM_RGB(222,119,174),IM_RGB(241,182,218),IM_RGB(253,224,239),IM_RGB(247,247,247),IM_RGB(230,245,208),IM_RGB(184,225,134),IM_RGB(127,188,65),IM_RGB(77,146,33),IM_RGB(39,100,25)}; const ImU32 Spectral[] = {IM_RGB(158,1,66),IM_RGB(213,62,79),IM_RGB(244,109,67),IM_RGB(253,174,97),IM_RGB(254,224,139),IM_RGB(255,255,191),IM_RGB(230,245,152),IM_RGB(171,221,164),IM_RGB(102,194,165),IM_RGB(50,136,189),IM_RGB(94,79,162)}; const ImU32 Greys[] = {IM_COL32_WHITE, IM_COL32_BLACK }; IMPLOT_APPEND_CMAP(Deep, true); IMPLOT_APPEND_CMAP(Dark, true); IMPLOT_APPEND_CMAP(Pastel, true); IMPLOT_APPEND_CMAP(Paired, true); IMPLOT_APPEND_CMAP(Viridis, false); IMPLOT_APPEND_CMAP(Plasma, false); IMPLOT_APPEND_CMAP(Hot, false); IMPLOT_APPEND_CMAP(Cool, false); IMPLOT_APPEND_CMAP(Pink, false); IMPLOT_APPEND_CMAP(Jet, false); IMPLOT_APPEND_CMAP(Twilight, false); IMPLOT_APPEND_CMAP(RdBu, false); IMPLOT_APPEND_CMAP(BrBG, false); IMPLOT_APPEND_CMAP(PiYG, false); IMPLOT_APPEND_CMAP(Spectral, false); IMPLOT_APPEND_CMAP(Greys, false); } void ResetCtxForNextPlot(ImPlotContext* ctx) { // end child window if it was made if (ctx->ChildWindowMade) ImGui::EndChild(); ctx->ChildWindowMade = false; // reset the next plot/item data ctx->NextPlotData.Reset(); ctx->NextItemData.Reset(); // reset labels ctx->Annotations.Reset(); ctx->Tags.Reset(); // reset extents/fit ctx->OpenContextThisFrame = false; // reset digital plot items count ctx->DigitalPlotItemCnt = 0; ctx->DigitalPlotOffset = 0; // nullify plot ctx->CurrentPlot = nullptr; ctx->CurrentItem = nullptr; ctx->PreviousItem = nullptr; } void ResetCtxForNextAlignedPlots(ImPlotContext* ctx) { ctx->CurrentAlignmentH = nullptr; ctx->CurrentAlignmentV = nullptr; } void ResetCtxForNextSubplot(ImPlotContext* ctx) { ctx->CurrentSubplot = nullptr; ctx->CurrentAlignmentH = nullptr; ctx->CurrentAlignmentV = nullptr; } //----------------------------------------------------------------------------- // Plot Utils //----------------------------------------------------------------------------- ImPlotPlot* GetPlot(const char* title) { ImGuiWindow* Window = GImGui->CurrentWindow; const ImGuiID ID = Window->GetID(title); return GImPlot->Plots.GetByKey(ID); } ImPlotPlot* GetCurrentPlot() { return GImPlot->CurrentPlot; } void BustPlotCache() { ImPlotContext& gp = *GImPlot; gp.Plots.Clear(); gp.Subplots.Clear(); } //----------------------------------------------------------------------------- // Legend Utils //----------------------------------------------------------------------------- ImVec2 GetLocationPos(const ImRect& outer_rect, const ImVec2& inner_size, ImPlotLocation loc, const ImVec2& pad) { ImVec2 pos; if (ImHasFlag(loc, ImPlotLocation_West) && !ImHasFlag(loc, ImPlotLocation_East)) pos.x = outer_rect.Min.x + pad.x; else if (!ImHasFlag(loc, ImPlotLocation_West) && ImHasFlag(loc, ImPlotLocation_East)) pos.x = outer_rect.Max.x - pad.x - inner_size.x; else pos.x = outer_rect.GetCenter().x - inner_size.x * 0.5f; // legend reference point y if (ImHasFlag(loc, ImPlotLocation_North) && !ImHasFlag(loc, ImPlotLocation_South)) pos.y = outer_rect.Min.y + pad.y; else if (!ImHasFlag(loc, ImPlotLocation_North) && ImHasFlag(loc, ImPlotLocation_South)) pos.y = outer_rect.Max.y - pad.y - inner_size.y; else pos.y = outer_rect.GetCenter().y - inner_size.y * 0.5f; pos.x = IM_ROUND(pos.x); pos.y = IM_ROUND(pos.y); return pos; } ImVec2 CalcLegendSize(ImPlotItemGroup& items, const ImVec2& pad, const ImVec2& spacing, bool vertical) { // vars const int nItems = items.GetLegendCount(); const float txt_ht = ImGui::GetTextLineHeight(); const float icon_size = txt_ht; // get label max width float max_label_width = 0; float sum_label_width = 0; for (int i = 0; i < nItems; ++i) { const char* label = items.GetLegendLabel(i); const float label_width = ImGui::CalcTextSize(label, nullptr, true).x; max_label_width = label_width > max_label_width ? label_width : max_label_width; sum_label_width += label_width; } // calc legend size const ImVec2 legend_size = vertical ? ImVec2(pad.x * 2 + icon_size + max_label_width, pad.y * 2 + nItems * txt_ht + (nItems - 1) * spacing.y) : ImVec2(pad.x * 2 + icon_size * nItems + sum_label_width + (nItems - 1) * spacing.x, pad.y * 2 + txt_ht); return legend_size; } int LegendSortingComp(const void* _a, const void* _b) { ImPlotItemGroup* items = GImPlot->SortItems; const int a = *(const int*)_a; const int b = *(const int*)_b; const char* label_a = items->GetLegendLabel(a); const char* label_b = items->GetLegendLabel(b); return strcmp(label_a,label_b); } bool ShowLegendEntries(ImPlotItemGroup& items, const ImRect& legend_bb, bool hovered, const ImVec2& pad, const ImVec2& spacing, bool vertical, ImDrawList& DrawList) { // vars const float txt_ht = ImGui::GetTextLineHeight(); const float icon_size = txt_ht; const float icon_shrink = 2; ImU32 col_txt = GetStyleColorU32(ImPlotCol_LegendText); ImU32 col_txt_dis = ImAlphaU32(col_txt, 0.25f); // render each legend item float sum_label_width = 0; bool any_item_hovered = false; const int num_items = items.GetLegendCount(); if (num_items < 1) return hovered; // build render order ImPlotContext& gp = *GImPlot; ImVector& indices = gp.TempInt1; indices.resize(num_items); for (int i = 0; i < num_items; ++i) indices[i] = i; if (ImHasFlag(items.Legend.Flags, ImPlotLegendFlags_Sort) && num_items > 1) { gp.SortItems = &items; qsort(indices.Data, num_items, sizeof(int), LegendSortingComp); } // render for (int i = 0; i < num_items; ++i) { const int idx = indices[i]; ImPlotItem* item = items.GetLegendItem(idx); const char* label = items.GetLegendLabel(idx); const float label_width = ImGui::CalcTextSize(label, nullptr, true).x; const ImVec2 top_left = vertical ? legend_bb.Min + pad + ImVec2(0, i * (txt_ht + spacing.y)) : legend_bb.Min + pad + ImVec2(i * (icon_size + spacing.x) + sum_label_width, 0); sum_label_width += label_width; ImRect icon_bb; icon_bb.Min = top_left + ImVec2(icon_shrink,icon_shrink); icon_bb.Max = top_left + ImVec2(icon_size - icon_shrink, icon_size - icon_shrink); ImRect label_bb; label_bb.Min = top_left; label_bb.Max = top_left + ImVec2(label_width + icon_size, icon_size); ImU32 col_txt_hl; ImU32 col_item = ImAlphaU32(item->Color,1); ImRect button_bb(icon_bb.Min, label_bb.Max); ImGui::KeepAliveID(item->ID); bool item_hov = false; bool item_hld = false; bool item_clk = ImHasFlag(items.Legend.Flags, ImPlotLegendFlags_NoButtons) ? false : ImGui::ButtonBehavior(button_bb, item->ID, &item_hov, &item_hld); if (item_clk) item->Show = !item->Show; const bool can_hover = (item_hov) && (!ImHasFlag(items.Legend.Flags, ImPlotLegendFlags_NoHighlightItem) || !ImHasFlag(items.Legend.Flags, ImPlotLegendFlags_NoHighlightAxis)); if (can_hover) { item->LegendHoverRect.Min = icon_bb.Min; item->LegendHoverRect.Max = label_bb.Max; item->LegendHovered = true; col_txt_hl = ImMixU32(col_txt, col_item, 64); any_item_hovered = true; } else { col_txt_hl = ImGui::GetColorU32(col_txt); } ImU32 col_icon; if (item_hld) col_icon = item->Show ? ImAlphaU32(col_item,0.5f) : ImGui::GetColorU32(ImGuiCol_TextDisabled, 0.5f); else if (item_hov) col_icon = item->Show ? ImAlphaU32(col_item,0.75f) : ImGui::GetColorU32(ImGuiCol_TextDisabled, 0.75f); else col_icon = item->Show ? col_item : col_txt_dis; DrawList.AddRectFilled(icon_bb.Min, icon_bb.Max, col_icon); const char* text_display_end = ImGui::FindRenderedTextEnd(label, nullptr); if (label != text_display_end) DrawList.AddText(top_left + ImVec2(icon_size, 0), item->Show ? col_txt_hl : col_txt_dis, label, text_display_end); } return hovered && !any_item_hovered; } //----------------------------------------------------------------------------- // Locators //----------------------------------------------------------------------------- static const float TICK_FILL_X = 0.8f; static const float TICK_FILL_Y = 1.0f; void Locator_Default(ImPlotTicker& ticker, const ImPlotRange& range, float pixels, bool vertical, ImPlotFormatter formatter, void* formatter_data) { if (range.Min == range.Max) return; const int nMinor = 10; const int nMajor = ImMax(2, (int)IM_ROUND(pixels / (vertical ? 300.0f : 400.0f))); const double nice_range = NiceNum(range.Size() * 0.99, false); const double interval = NiceNum(nice_range / (nMajor - 1), true); const double graphmin = floor(range.Min / interval) * interval; const double graphmax = ceil(range.Max / interval) * interval; bool first_major_set = false; int first_major_idx = 0; const int idx0 = ticker.TickCount(); // ticker may have user custom ticks ImVec2 total_size(0,0); for (double major = graphmin; major < graphmax + 0.5 * interval; major += interval) { // is this zero? combat zero formatting issues if (major-interval < 0 && major+interval > 0) major = 0; if (range.Contains(major)) { if (!first_major_set) { first_major_idx = ticker.TickCount(); first_major_set = true; } total_size += ticker.AddTick(major, true, 0, true, formatter, formatter_data).LabelSize; } for (int i = 1; i < nMinor; ++i) { double minor = major + i * interval / nMinor; if (range.Contains(minor)) { total_size += ticker.AddTick(minor, false, 0, true, formatter, formatter_data).LabelSize; } } } // prune if necessary if ((!vertical && total_size.x > pixels*TICK_FILL_X) || (vertical && total_size.y > pixels*TICK_FILL_Y)) { for (int i = first_major_idx-1; i >= idx0; i -= 2) ticker.Ticks[i].ShowLabel = false; for (int i = first_major_idx+1; i < ticker.TickCount(); i += 2) ticker.Ticks[i].ShowLabel = false; } } bool CalcLogarithmicExponents(const ImPlotRange& range, float pix, bool vertical, int& exp_min, int& exp_max, int& exp_step) { if (range.Min * range.Max > 0) { const int nMajor = vertical ? ImMax(2, (int)IM_ROUND(pix * 0.02f)) : ImMax(2, (int)IM_ROUND(pix * 0.01f)); // TODO: magic numbers double log_min = ImLog10(ImAbs(range.Min)); double log_max = ImLog10(ImAbs(range.Max)); double log_a = ImMin(log_min,log_max); double log_b = ImMax(log_min,log_max); exp_step = ImMax(1,(int)(log_b - log_a) / nMajor); exp_min = (int)log_a; exp_max = (int)log_b; if (exp_step != 1) { while(exp_step % 3 != 0) exp_step++; // make step size multiple of three while(exp_min % exp_step != 0) exp_min--; // decrease exp_min until exp_min + N * exp_step will be 0 } return true; } return false; } void AddTicksLogarithmic(const ImPlotRange& range, int exp_min, int exp_max, int exp_step, ImPlotTicker& ticker, ImPlotFormatter formatter, void* data) { const double sign = ImSign(range.Max); for (int e = exp_min - exp_step; e < (exp_max + exp_step); e += exp_step) { double major1 = sign*ImPow(10, (double)(e)); double major2 = sign*ImPow(10, (double)(e + 1)); double interval = (major2 - major1) / 9; if (major1 >= (range.Min - DBL_EPSILON) && major1 <= (range.Max + DBL_EPSILON)) ticker.AddTick(major1, true, 0, true, formatter, data); for (int j = 0; j < exp_step; ++j) { major1 = sign*ImPow(10, (double)(e+j)); major2 = sign*ImPow(10, (double)(e+j+1)); interval = (major2 - major1) / 9; for (int i = 1; i < (9 + (int)(j < (exp_step - 1))); ++i) { double minor = major1 + i * interval; if (minor >= (range.Min - DBL_EPSILON) && minor <= (range.Max + DBL_EPSILON)) ticker.AddTick(minor, false, 0, false, formatter, data); } } } } void Locator_Log10(ImPlotTicker& ticker, const ImPlotRange& range, float pixels, bool vertical, ImPlotFormatter formatter, void* formatter_data) { int exp_min, exp_max, exp_step; if (CalcLogarithmicExponents(range, pixels, vertical, exp_min, exp_max, exp_step)) AddTicksLogarithmic(range, exp_min, exp_max, exp_step, ticker, formatter, formatter_data); } float CalcSymLogPixel(double plt, const ImPlotRange& range, float pixels) { double scaleToPixels = pixels / range.Size(); double scaleMin = TransformForward_SymLog(range.Min,nullptr); double scaleMax = TransformForward_SymLog(range.Max,nullptr); double s = TransformForward_SymLog(plt, nullptr); double t = (s - scaleMin) / (scaleMax - scaleMin); plt = range.Min + range.Size() * t; return (float)(0 + scaleToPixels * (plt - range.Min)); } void Locator_SymLog(ImPlotTicker& ticker, const ImPlotRange& range, float pixels, bool vertical, ImPlotFormatter formatter, void* formatter_data) { if (range.Min >= -1 && range.Max <= 1) { Locator_Default(ticker, range, pixels, vertical, formatter, formatter_data); } else if (range.Min * range.Max < 0) { // cross zero const float pix_min = 0; const float pix_max = pixels; const float pix_p1 = CalcSymLogPixel(1, range, pixels); const float pix_n1 = CalcSymLogPixel(-1, range, pixels); int exp_min_p, exp_max_p, exp_step_p; int exp_min_n, exp_max_n, exp_step_n; CalcLogarithmicExponents(ImPlotRange(1,range.Max), ImAbs(pix_max-pix_p1),vertical,exp_min_p,exp_max_p,exp_step_p); CalcLogarithmicExponents(ImPlotRange(range.Min,-1),ImAbs(pix_n1-pix_min),vertical,exp_min_n,exp_max_n,exp_step_n); int exp_step = ImMax(exp_step_n, exp_step_p); ticker.AddTick(0,true,0,true,formatter,formatter_data); AddTicksLogarithmic(ImPlotRange(1,range.Max), exp_min_p,exp_max_p,exp_step,ticker,formatter,formatter_data); AddTicksLogarithmic(ImPlotRange(range.Min,-1),exp_min_n,exp_max_n,exp_step,ticker,formatter,formatter_data); } else { Locator_Log10(ticker, range, pixels, vertical, formatter, formatter_data); } } void AddTicksCustom(const double* values, const char* const labels[], int n, ImPlotTicker& ticker, ImPlotFormatter formatter, void* data) { for (int i = 0; i < n; ++i) { if (labels != nullptr) ticker.AddTick(values[i], false, 0, true, labels[i]); else ticker.AddTick(values[i], false, 0, true, formatter, data); } } //----------------------------------------------------------------------------- // Time Ticks and Utils //----------------------------------------------------------------------------- // this may not be thread safe? static const double TimeUnitSpans[ImPlotTimeUnit_COUNT] = { 0.000001, 0.001, 1, 60, 3600, 86400, 2629800, 31557600 }; inline ImPlotTimeUnit GetUnitForRange(double range) { static double cutoffs[ImPlotTimeUnit_COUNT] = {0.001, 1, 60, 3600, 86400, 2629800, 31557600, IMPLOT_MAX_TIME}; for (int i = 0; i < ImPlotTimeUnit_COUNT; ++i) { if (range <= cutoffs[i]) return (ImPlotTimeUnit)i; } return ImPlotTimeUnit_Yr; } inline int LowerBoundStep(int max_divs, const int* divs, const int* step, int size) { if (max_divs < divs[0]) return 0; for (int i = 1; i < size; ++i) { if (max_divs < divs[i]) return step[i-1]; } return step[size-1]; } inline int GetTimeStep(int max_divs, ImPlotTimeUnit unit) { if (unit == ImPlotTimeUnit_Ms || unit == ImPlotTimeUnit_Us) { static const int step[] = {500,250,200,100,50,25,20,10,5,2,1}; static const int divs[] = {2,4,5,10,20,40,50,100,200,500,1000}; return LowerBoundStep(max_divs, divs, step, 11); } if (unit == ImPlotTimeUnit_S || unit == ImPlotTimeUnit_Min) { static const int step[] = {30,15,10,5,1}; static const int divs[] = {2,4,6,12,60}; return LowerBoundStep(max_divs, divs, step, 5); } else if (unit == ImPlotTimeUnit_Hr) { static const int step[] = {12,6,3,2,1}; static const int divs[] = {2,4,8,12,24}; return LowerBoundStep(max_divs, divs, step, 5); } else if (unit == ImPlotTimeUnit_Day) { static const int step[] = {14,7,2,1}; static const int divs[] = {2,4,14,28}; return LowerBoundStep(max_divs, divs, step, 4); } else if (unit == ImPlotTimeUnit_Mo) { static const int step[] = {6,3,2,1}; static const int divs[] = {2,4,6,12}; return LowerBoundStep(max_divs, divs, step, 4); } return 0; } ImPlotTime MkGmtTime(struct tm *ptm) { ImPlotTime t; #ifdef _WIN32 t.S = _mkgmtime(ptm); #else t.S = timegm(ptm); #endif if (t.S < 0) t.S = 0; return t; } tm* GetGmtTime(const ImPlotTime& t, tm* ptm) { #ifdef _WIN32 if (gmtime_s(ptm, &t.S) == 0) return ptm; else return nullptr; #else return gmtime_r(&t.S, ptm); #endif } ImPlotTime MkLocTime(struct tm *ptm) { ImPlotTime t; t.S = mktime(ptm); if (t.S < 0) t.S = 0; return t; } tm* GetLocTime(const ImPlotTime& t, tm* ptm) { #ifdef _WIN32 if (localtime_s(ptm, &t.S) == 0) return ptm; else return nullptr; #else return localtime_r(&t.S, ptm); #endif } inline ImPlotTime MkTime(struct tm *ptm) { if (GetStyle().UseLocalTime) return MkLocTime(ptm); else return MkGmtTime(ptm); } inline tm* GetTime(const ImPlotTime& t, tm* ptm) { if (GetStyle().UseLocalTime) return GetLocTime(t,ptm); else return GetGmtTime(t,ptm); } ImPlotTime MakeTime(int year, int month, int day, int hour, int min, int sec, int us) { tm& Tm = GImPlot->Tm; int yr = year - 1900; if (yr < 0) yr = 0; sec = sec + us / 1000000; us = us % 1000000; Tm.tm_sec = sec; Tm.tm_min = min; Tm.tm_hour = hour; Tm.tm_mday = day; Tm.tm_mon = month; Tm.tm_year = yr; ImPlotTime t = MkTime(&Tm); t.Us = us; return t; } int GetYear(const ImPlotTime& t) { tm& Tm = GImPlot->Tm; GetTime(t, &Tm); return Tm.tm_year + 1900; } ImPlotTime AddTime(const ImPlotTime& t, ImPlotTimeUnit unit, int count) { tm& Tm = GImPlot->Tm; ImPlotTime t_out = t; switch(unit) { case ImPlotTimeUnit_Us: t_out.Us += count; break; case ImPlotTimeUnit_Ms: t_out.Us += count * 1000; break; case ImPlotTimeUnit_S: t_out.S += count; break; case ImPlotTimeUnit_Min: t_out.S += count * 60; break; case ImPlotTimeUnit_Hr: t_out.S += count * 3600; break; case ImPlotTimeUnit_Day: t_out.S += count * 86400; break; case ImPlotTimeUnit_Mo: for (int i = 0; i < abs(count); ++i) { GetTime(t_out, &Tm); if (count > 0) t_out.S += 86400 * GetDaysInMonth(Tm.tm_year + 1900, Tm.tm_mon); else if (count < 0) t_out.S -= 86400 * GetDaysInMonth(Tm.tm_year + 1900 - (Tm.tm_mon == 0 ? 1 : 0), Tm.tm_mon == 0 ? 11 : Tm.tm_mon - 1); // NOT WORKING } break; case ImPlotTimeUnit_Yr: for (int i = 0; i < abs(count); ++i) { if (count > 0) t_out.S += 86400 * (365 + (int)IsLeapYear(GetYear(t_out))); else if (count < 0) t_out.S -= 86400 * (365 + (int)IsLeapYear(GetYear(t_out) - 1)); // this is incorrect if leap year and we are past Feb 28 } break; default: break; } t_out.RollOver(); return t_out; } ImPlotTime FloorTime(const ImPlotTime& t, ImPlotTimeUnit unit) { ImPlotContext& gp = *GImPlot; GetTime(t, &gp.Tm); switch (unit) { case ImPlotTimeUnit_S: return ImPlotTime(t.S, 0); case ImPlotTimeUnit_Ms: return ImPlotTime(t.S, (t.Us / 1000) * 1000); case ImPlotTimeUnit_Us: return t; case ImPlotTimeUnit_Yr: gp.Tm.tm_mon = 0; // fall-through case ImPlotTimeUnit_Mo: gp.Tm.tm_mday = 1; // fall-through case ImPlotTimeUnit_Day: gp.Tm.tm_hour = 0; // fall-through case ImPlotTimeUnit_Hr: gp.Tm.tm_min = 0; // fall-through case ImPlotTimeUnit_Min: gp.Tm.tm_sec = 0; break; default: return t; } return MkTime(&gp.Tm); } ImPlotTime CeilTime(const ImPlotTime& t, ImPlotTimeUnit unit) { return AddTime(FloorTime(t, unit), unit, 1); } ImPlotTime RoundTime(const ImPlotTime& t, ImPlotTimeUnit unit) { ImPlotTime t1 = FloorTime(t, unit); ImPlotTime t2 = AddTime(t1,unit,1); if (t1.S == t2.S) return t.Us - t1.Us < t2.Us - t.Us ? t1 : t2; return t.S - t1.S < t2.S - t.S ? t1 : t2; } ImPlotTime CombineDateTime(const ImPlotTime& date_part, const ImPlotTime& tod_part) { ImPlotContext& gp = *GImPlot; tm& Tm = gp.Tm; GetTime(date_part, &gp.Tm); int y = Tm.tm_year; int m = Tm.tm_mon; int d = Tm.tm_mday; GetTime(tod_part, &gp.Tm); Tm.tm_year = y; Tm.tm_mon = m; Tm.tm_mday = d; ImPlotTime t = MkTime(&Tm); t.Us = tod_part.Us; return t; } // TODO: allow users to define these static const char* MONTH_NAMES[] = {"January","February","March","April","May","June","July","August","September","October","November","December"}; static const char* WD_ABRVS[] = {"Su","Mo","Tu","We","Th","Fr","Sa"}; static const char* MONTH_ABRVS[] = {"Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec"}; int FormatTime(const ImPlotTime& t, char* buffer, int size, ImPlotTimeFmt fmt, bool use_24_hr_clk) { tm& Tm = GImPlot->Tm; GetTime(t, &Tm); const int us = t.Us % 1000; const int ms = t.Us / 1000; const int sec = Tm.tm_sec; const int min = Tm.tm_min; if (use_24_hr_clk) { const int hr = Tm.tm_hour; switch(fmt) { case ImPlotTimeFmt_Us: return ImFormatString(buffer, size, ".%03d %03d", ms, us); case ImPlotTimeFmt_SUs: return ImFormatString(buffer, size, ":%02d.%03d %03d", sec, ms, us); case ImPlotTimeFmt_SMs: return ImFormatString(buffer, size, ":%02d.%03d", sec, ms); case ImPlotTimeFmt_S: return ImFormatString(buffer, size, ":%02d", sec); case ImPlotTimeFmt_MinSMs: return ImFormatString(buffer, size, ":%02d:%02d.%03d", min, sec, ms); case ImPlotTimeFmt_HrMinSMs: return ImFormatString(buffer, size, "%02d:%02d:%02d.%03d", hr, min, sec, ms); case ImPlotTimeFmt_HrMinS: return ImFormatString(buffer, size, "%02d:%02d:%02d", hr, min, sec); case ImPlotTimeFmt_HrMin: return ImFormatString(buffer, size, "%02d:%02d", hr, min); case ImPlotTimeFmt_Hr: return ImFormatString(buffer, size, "%02d:00", hr); default: return 0; } } else { const char* ap = Tm.tm_hour < 12 ? "am" : "pm"; const int hr = (Tm.tm_hour == 0 || Tm.tm_hour == 12) ? 12 : Tm.tm_hour % 12; switch(fmt) { case ImPlotTimeFmt_Us: return ImFormatString(buffer, size, ".%03d %03d", ms, us); case ImPlotTimeFmt_SUs: return ImFormatString(buffer, size, ":%02d.%03d %03d", sec, ms, us); case ImPlotTimeFmt_SMs: return ImFormatString(buffer, size, ":%02d.%03d", sec, ms); case ImPlotTimeFmt_S: return ImFormatString(buffer, size, ":%02d", sec); case ImPlotTimeFmt_MinSMs: return ImFormatString(buffer, size, ":%02d:%02d.%03d", min, sec, ms); case ImPlotTimeFmt_HrMinSMs: return ImFormatString(buffer, size, "%d:%02d:%02d.%03d%s", hr, min, sec, ms, ap); case ImPlotTimeFmt_HrMinS: return ImFormatString(buffer, size, "%d:%02d:%02d%s", hr, min, sec, ap); case ImPlotTimeFmt_HrMin: return ImFormatString(buffer, size, "%d:%02d%s", hr, min, ap); case ImPlotTimeFmt_Hr: return ImFormatString(buffer, size, "%d%s", hr, ap); default: return 0; } } } int FormatDate(const ImPlotTime& t, char* buffer, int size, ImPlotDateFmt fmt, bool use_iso_8601) { tm& Tm = GImPlot->Tm; GetTime(t, &Tm); const int day = Tm.tm_mday; const int mon = Tm.tm_mon + 1; const int year = Tm.tm_year + 1900; const int yr = year % 100; if (use_iso_8601) { switch (fmt) { case ImPlotDateFmt_DayMo: return ImFormatString(buffer, size, "--%02d-%02d", mon, day); case ImPlotDateFmt_DayMoYr: return ImFormatString(buffer, size, "%d-%02d-%02d", year, mon, day); case ImPlotDateFmt_MoYr: return ImFormatString(buffer, size, "%d-%02d", year, mon); case ImPlotDateFmt_Mo: return ImFormatString(buffer, size, "--%02d", mon); case ImPlotDateFmt_Yr: return ImFormatString(buffer, size, "%d", year); default: return 0; } } else { switch (fmt) { case ImPlotDateFmt_DayMo: return ImFormatString(buffer, size, "%d/%d", mon, day); case ImPlotDateFmt_DayMoYr: return ImFormatString(buffer, size, "%d/%d/%02d", mon, day, yr); case ImPlotDateFmt_MoYr: return ImFormatString(buffer, size, "%s %d", MONTH_ABRVS[Tm.tm_mon], year); case ImPlotDateFmt_Mo: return ImFormatString(buffer, size, "%s", MONTH_ABRVS[Tm.tm_mon]); case ImPlotDateFmt_Yr: return ImFormatString(buffer, size, "%d", year); default: return 0; } } } int FormatDateTime(const ImPlotTime& t, char* buffer, int size, ImPlotDateTimeSpec fmt) { int written = 0; if (fmt.Date != ImPlotDateFmt_None) written += FormatDate(t, buffer, size, fmt.Date, fmt.UseISO8601); if (fmt.Time != ImPlotTimeFmt_None) { if (fmt.Date != ImPlotDateFmt_None) buffer[written++] = ' '; written += FormatTime(t, &buffer[written], size - written, fmt.Time, fmt.Use24HourClock); } return written; } inline float GetDateTimeWidth(ImPlotDateTimeSpec fmt) { static const ImPlotTime t_max_width = MakeTime(2888, 12, 22, 12, 58, 58, 888888); // best guess at time that maximizes pixel width char buffer[32]; FormatDateTime(t_max_width, buffer, 32, fmt); return ImGui::CalcTextSize(buffer).x; } inline bool TimeLabelSame(const char* l1, const char* l2) { size_t len1 = strlen(l1); size_t len2 = strlen(l2); size_t n = len1 < len2 ? len1 : len2; return strcmp(l1 + len1 - n, l2 + len2 - n) == 0; } static const ImPlotDateTimeSpec TimeFormatLevel0[ImPlotTimeUnit_COUNT] = { ImPlotDateTimeSpec(ImPlotDateFmt_None, ImPlotTimeFmt_Us), ImPlotDateTimeSpec(ImPlotDateFmt_None, ImPlotTimeFmt_SMs), ImPlotDateTimeSpec(ImPlotDateFmt_None, ImPlotTimeFmt_S), ImPlotDateTimeSpec(ImPlotDateFmt_None, ImPlotTimeFmt_HrMin), ImPlotDateTimeSpec(ImPlotDateFmt_None, ImPlotTimeFmt_Hr), ImPlotDateTimeSpec(ImPlotDateFmt_DayMo, ImPlotTimeFmt_None), ImPlotDateTimeSpec(ImPlotDateFmt_Mo, ImPlotTimeFmt_None), ImPlotDateTimeSpec(ImPlotDateFmt_Yr, ImPlotTimeFmt_None) }; static const ImPlotDateTimeSpec TimeFormatLevel1[ImPlotTimeUnit_COUNT] = { ImPlotDateTimeSpec(ImPlotDateFmt_None, ImPlotTimeFmt_HrMin), ImPlotDateTimeSpec(ImPlotDateFmt_None, ImPlotTimeFmt_HrMinS), ImPlotDateTimeSpec(ImPlotDateFmt_None, ImPlotTimeFmt_HrMin), ImPlotDateTimeSpec(ImPlotDateFmt_None, ImPlotTimeFmt_HrMin), ImPlotDateTimeSpec(ImPlotDateFmt_DayMoYr, ImPlotTimeFmt_None), ImPlotDateTimeSpec(ImPlotDateFmt_DayMoYr, ImPlotTimeFmt_None), ImPlotDateTimeSpec(ImPlotDateFmt_Yr, ImPlotTimeFmt_None), ImPlotDateTimeSpec(ImPlotDateFmt_Yr, ImPlotTimeFmt_None) }; static const ImPlotDateTimeSpec TimeFormatLevel1First[ImPlotTimeUnit_COUNT] = { ImPlotDateTimeSpec(ImPlotDateFmt_DayMoYr, ImPlotTimeFmt_HrMinS), ImPlotDateTimeSpec(ImPlotDateFmt_DayMoYr, ImPlotTimeFmt_HrMinS), ImPlotDateTimeSpec(ImPlotDateFmt_DayMoYr, ImPlotTimeFmt_HrMin), ImPlotDateTimeSpec(ImPlotDateFmt_DayMoYr, ImPlotTimeFmt_HrMin), ImPlotDateTimeSpec(ImPlotDateFmt_DayMoYr, ImPlotTimeFmt_None), ImPlotDateTimeSpec(ImPlotDateFmt_DayMoYr, ImPlotTimeFmt_None), ImPlotDateTimeSpec(ImPlotDateFmt_Yr, ImPlotTimeFmt_None), ImPlotDateTimeSpec(ImPlotDateFmt_Yr, ImPlotTimeFmt_None) }; static const ImPlotDateTimeSpec TimeFormatMouseCursor[ImPlotTimeUnit_COUNT] = { ImPlotDateTimeSpec(ImPlotDateFmt_None, ImPlotTimeFmt_Us), ImPlotDateTimeSpec(ImPlotDateFmt_None, ImPlotTimeFmt_SUs), ImPlotDateTimeSpec(ImPlotDateFmt_None, ImPlotTimeFmt_SMs), ImPlotDateTimeSpec(ImPlotDateFmt_None, ImPlotTimeFmt_HrMinS), ImPlotDateTimeSpec(ImPlotDateFmt_None, ImPlotTimeFmt_HrMin), ImPlotDateTimeSpec(ImPlotDateFmt_DayMo, ImPlotTimeFmt_Hr), ImPlotDateTimeSpec(ImPlotDateFmt_DayMoYr, ImPlotTimeFmt_None), ImPlotDateTimeSpec(ImPlotDateFmt_MoYr, ImPlotTimeFmt_None) }; inline ImPlotDateTimeSpec GetDateTimeFmt(const ImPlotDateTimeSpec* ctx, ImPlotTimeUnit idx) { ImPlotStyle& style = GetStyle(); ImPlotDateTimeSpec fmt = ctx[idx]; fmt.UseISO8601 = style.UseISO8601; fmt.Use24HourClock = style.Use24HourClock; return fmt; } void Locator_Time(ImPlotTicker& ticker, const ImPlotRange& range, float pixels, bool vertical, ImPlotFormatter formatter, void* formatter_data) { IM_ASSERT_USER_ERROR(vertical == false, "Cannot locate Time ticks on vertical axis!"); (void)vertical; // get units for level 0 and level 1 labels const ImPlotTimeUnit unit0 = GetUnitForRange(range.Size() / (pixels / 100)); // level = 0 (top) const ImPlotTimeUnit unit1 = ImClamp(unit0 + 1, 0, ImPlotTimeUnit_COUNT-1); // level = 1 (bottom) // get time format specs const ImPlotDateTimeSpec fmt0 = GetDateTimeFmt(TimeFormatLevel0, unit0); const ImPlotDateTimeSpec fmt1 = GetDateTimeFmt(TimeFormatLevel1, unit1); const ImPlotDateTimeSpec fmtf = GetDateTimeFmt(TimeFormatLevel1First, unit1); // min max times const ImPlotTime t_min = ImPlotTime::FromDouble(range.Min); const ImPlotTime t_max = ImPlotTime::FromDouble(range.Max); // maximum allowable density of labels const float max_density = 0.5f; // book keeping int last_major_offset = -1; // formatter data Formatter_Time_Data ftd; ftd.UserFormatter = formatter; ftd.UserFormatterData = formatter_data; if (unit0 != ImPlotTimeUnit_Yr) { // pixels per major (level 1) division const float pix_per_major_div = pixels / (float)(range.Size() / TimeUnitSpans[unit1]); // nominal pixels taken up by labels const float fmt0_width = GetDateTimeWidth(fmt0); const float fmt1_width = GetDateTimeWidth(fmt1); const float fmtf_width = GetDateTimeWidth(fmtf); // the maximum number of minor (level 0) labels that can fit between major (level 1) divisions const int minor_per_major = (int)(max_density * pix_per_major_div / fmt0_width); // the minor step size (level 0) const int step = GetTimeStep(minor_per_major, unit0); // generate ticks ImPlotTime t1 = FloorTime(ImPlotTime::FromDouble(range.Min), unit1); while (t1 < t_max) { // get next major const ImPlotTime t2 = AddTime(t1, unit1, 1); // add major tick if (t1 >= t_min && t1 <= t_max) { // minor level 0 tick ftd.Time = t1; ftd.Spec = fmt0; ticker.AddTick(t1.ToDouble(), true, 0, true, Formatter_Time, &ftd); // major level 1 tick ftd.Time = t1; ftd.Spec = last_major_offset < 0 ? fmtf : fmt1; ImPlotTick& tick_maj = ticker.AddTick(t1.ToDouble(), true, 1, true, Formatter_Time, &ftd); const char* this_major = ticker.GetText(tick_maj); if (last_major_offset >= 0 && TimeLabelSame(ticker.TextBuffer.Buf.Data + last_major_offset, this_major)) tick_maj.ShowLabel = false; last_major_offset = tick_maj.TextOffset; } // add minor ticks up until next major if (minor_per_major > 1 && (t_min <= t2 && t1 <= t_max)) { ImPlotTime t12 = AddTime(t1, unit0, step); while (t12 < t2) { float px_to_t2 = (float)((t2 - t12).ToDouble()/range.Size()) * pixels; if (t12 >= t_min && t12 <= t_max) { ftd.Time = t12; ftd.Spec = fmt0; ticker.AddTick(t12.ToDouble(), false, 0, px_to_t2 >= fmt0_width, Formatter_Time, &ftd); if (last_major_offset < 0 && px_to_t2 >= fmt0_width && px_to_t2 >= (fmt1_width + fmtf_width) / 2) { ftd.Time = t12; ftd.Spec = fmtf; ImPlotTick& tick_maj = ticker.AddTick(t12.ToDouble(), true, 1, true, Formatter_Time, &ftd); last_major_offset = tick_maj.TextOffset; } } t12 = AddTime(t12, unit0, step); } } t1 = t2; } } else { const ImPlotDateTimeSpec fmty = GetDateTimeFmt(TimeFormatLevel0, ImPlotTimeUnit_Yr); const float label_width = GetDateTimeWidth(fmty); const int max_labels = (int)(max_density * pixels / label_width); const int year_min = GetYear(t_min); const int year_max = GetYear(CeilTime(t_max, ImPlotTimeUnit_Yr)); const double nice_range = NiceNum((year_max - year_min)*0.99,false); const double interval = NiceNum(nice_range / (max_labels - 1), true); const int graphmin = (int)(floor(year_min / interval) * interval); const int graphmax = (int)(ceil(year_max / interval) * interval); const int step = (int)interval <= 0 ? 1 : (int)interval; for (int y = graphmin; y < graphmax; y += step) { ImPlotTime t = MakeTime(y); if (t >= t_min && t <= t_max) { ftd.Time = t; ftd.Spec = fmty; ticker.AddTick(t.ToDouble(), true, 0, true, Formatter_Time, &ftd); } } } } //----------------------------------------------------------------------------- // Context Menu //----------------------------------------------------------------------------- template bool DragFloat(const char*, F*, float, F, F) { return false; } template <> bool DragFloat(const char* label, double* v, float v_speed, double v_min, double v_max) { return ImGui::DragScalar(label, ImGuiDataType_Double, v, v_speed, &v_min, &v_max, "%.3g", 1); } template <> bool DragFloat(const char* label, float* v, float v_speed, float v_min, float v_max) { return ImGui::DragScalar(label, ImGuiDataType_Float, v, v_speed, &v_min, &v_max, "%.3g", 1); } inline void BeginDisabledControls(bool cond) { if (cond) { ImGui::PushItemFlag(ImGuiItemFlags_Disabled, true); ImGui::PushStyleVar(ImGuiStyleVar_Alpha, ImGui::GetStyle().Alpha * 0.25f); } } inline void EndDisabledControls(bool cond) { if (cond) { ImGui::PopItemFlag(); ImGui::PopStyleVar(); } } void ShowAxisContextMenu(ImPlotAxis& axis, ImPlotAxis* equal_axis, bool /*time_allowed*/) { ImGui::PushItemWidth(75); bool always_locked = axis.IsRangeLocked() || axis.IsAutoFitting(); bool label = axis.HasLabel(); bool grid = axis.HasGridLines(); bool ticks = axis.HasTickMarks(); bool labels = axis.HasTickLabels(); double drag_speed = (axis.Range.Size() <= DBL_EPSILON) ? DBL_EPSILON * 1.0e+13 : 0.01 * axis.Range.Size(); // recover from almost equal axis limits. if (axis.Scale == ImPlotScale_Time) { ImPlotTime tmin = ImPlotTime::FromDouble(axis.Range.Min); ImPlotTime tmax = ImPlotTime::FromDouble(axis.Range.Max); BeginDisabledControls(always_locked); ImGui::CheckboxFlags("##LockMin", (unsigned int*)&axis.Flags, ImPlotAxisFlags_LockMin); EndDisabledControls(always_locked); ImGui::SameLine(); BeginDisabledControls(axis.IsLockedMin() || always_locked); if (ImGui::BeginMenu("Min Time")) { if (ShowTimePicker("mintime", &tmin)) { if (tmin >= tmax) tmax = AddTime(tmin, ImPlotTimeUnit_S, 1); axis.SetRange(tmin.ToDouble(),tmax.ToDouble()); } ImGui::Separator(); if (ShowDatePicker("mindate",&axis.PickerLevel,&axis.PickerTimeMin,&tmin,&tmax)) { tmin = CombineDateTime(axis.PickerTimeMin, tmin); if (tmin >= tmax) tmax = AddTime(tmin, ImPlotTimeUnit_S, 1); axis.SetRange(tmin.ToDouble(), tmax.ToDouble()); } ImGui::EndMenu(); } EndDisabledControls(axis.IsLockedMin() || always_locked); BeginDisabledControls(always_locked); ImGui::CheckboxFlags("##LockMax", (unsigned int*)&axis.Flags, ImPlotAxisFlags_LockMax); EndDisabledControls(always_locked); ImGui::SameLine(); BeginDisabledControls(axis.IsLockedMax() || always_locked); if (ImGui::BeginMenu("Max Time")) { if (ShowTimePicker("maxtime", &tmax)) { if (tmax <= tmin) tmin = AddTime(tmax, ImPlotTimeUnit_S, -1); axis.SetRange(tmin.ToDouble(),tmax.ToDouble()); } ImGui::Separator(); if (ShowDatePicker("maxdate",&axis.PickerLevel,&axis.PickerTimeMax,&tmin,&tmax)) { tmax = CombineDateTime(axis.PickerTimeMax, tmax); if (tmax <= tmin) tmin = AddTime(tmax, ImPlotTimeUnit_S, -1); axis.SetRange(tmin.ToDouble(), tmax.ToDouble()); } ImGui::EndMenu(); } EndDisabledControls(axis.IsLockedMax() || always_locked); } else { BeginDisabledControls(always_locked); ImGui::CheckboxFlags("##LockMin", (unsigned int*)&axis.Flags, ImPlotAxisFlags_LockMin); EndDisabledControls(always_locked); ImGui::SameLine(); BeginDisabledControls(axis.IsLockedMin() || always_locked); double temp_min = axis.Range.Min; if (DragFloat("Min", &temp_min, (float)drag_speed, -HUGE_VAL, axis.Range.Max - DBL_EPSILON)) { axis.SetMin(temp_min,true); if (equal_axis != nullptr) equal_axis->SetAspect(axis.GetAspect()); } EndDisabledControls(axis.IsLockedMin() || always_locked); BeginDisabledControls(always_locked); ImGui::CheckboxFlags("##LockMax", (unsigned int*)&axis.Flags, ImPlotAxisFlags_LockMax); EndDisabledControls(always_locked); ImGui::SameLine(); BeginDisabledControls(axis.IsLockedMax() || always_locked); double temp_max = axis.Range.Max; if (DragFloat("Max", &temp_max, (float)drag_speed, axis.Range.Min + DBL_EPSILON, HUGE_VAL)) { axis.SetMax(temp_max,true); if (equal_axis != nullptr) equal_axis->SetAspect(axis.GetAspect()); } EndDisabledControls(axis.IsLockedMax() || always_locked); } ImGui::Separator(); ImGui::CheckboxFlags("Auto-Fit",(unsigned int*)&axis.Flags, ImPlotAxisFlags_AutoFit); // TODO // BeginDisabledControls(axis.IsTime() && time_allowed); // ImGui::CheckboxFlags("Log Scale",(unsigned int*)&axis.Flags, ImPlotAxisFlags_LogScale); // EndDisabledControls(axis.IsTime() && time_allowed); // if (time_allowed) { // BeginDisabledControls(axis.IsLog() || axis.IsSymLog()); // ImGui::CheckboxFlags("Time",(unsigned int*)&axis.Flags, ImPlotAxisFlags_Time); // EndDisabledControls(axis.IsLog() || axis.IsSymLog()); // } ImGui::Separator(); ImGui::CheckboxFlags("Invert",(unsigned int*)&axis.Flags, ImPlotAxisFlags_Invert); ImGui::CheckboxFlags("Opposite",(unsigned int*)&axis.Flags, ImPlotAxisFlags_Opposite); ImGui::Separator(); BeginDisabledControls(axis.LabelOffset == -1); if (ImGui::Checkbox("Label", &label)) ImFlipFlag(axis.Flags, ImPlotAxisFlags_NoLabel); EndDisabledControls(axis.LabelOffset == -1); if (ImGui::Checkbox("Grid Lines", &grid)) ImFlipFlag(axis.Flags, ImPlotAxisFlags_NoGridLines); if (ImGui::Checkbox("Tick Marks", &ticks)) ImFlipFlag(axis.Flags, ImPlotAxisFlags_NoTickMarks); if (ImGui::Checkbox("Tick Labels", &labels)) ImFlipFlag(axis.Flags, ImPlotAxisFlags_NoTickLabels); } bool ShowLegendContextMenu(ImPlotLegend& legend, bool visible) { const float s = ImGui::GetFrameHeight(); bool ret = false; if (ImGui::Checkbox("Show",&visible)) ret = true; if (legend.CanGoInside) ImGui::CheckboxFlags("Outside",(unsigned int*)&legend.Flags, ImPlotLegendFlags_Outside); if (ImGui::RadioButton("H", ImHasFlag(legend.Flags, ImPlotLegendFlags_Horizontal))) legend.Flags |= ImPlotLegendFlags_Horizontal; ImGui::SameLine(); if (ImGui::RadioButton("V", !ImHasFlag(legend.Flags, ImPlotLegendFlags_Horizontal))) legend.Flags &= ~ImPlotLegendFlags_Horizontal; ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, ImVec2(2,2)); if (ImGui::Button("NW",ImVec2(1.5f*s,s))) { legend.Location = ImPlotLocation_NorthWest; } ImGui::SameLine(); if (ImGui::Button("N", ImVec2(1.5f*s,s))) { legend.Location = ImPlotLocation_North; } ImGui::SameLine(); if (ImGui::Button("NE",ImVec2(1.5f*s,s))) { legend.Location = ImPlotLocation_NorthEast; } if (ImGui::Button("W", ImVec2(1.5f*s,s))) { legend.Location = ImPlotLocation_West; } ImGui::SameLine(); if (ImGui::InvisibleButton("C", ImVec2(1.5f*s,s))) { } ImGui::SameLine(); if (ImGui::Button("E", ImVec2(1.5f*s,s))) { legend.Location = ImPlotLocation_East; } if (ImGui::Button("SW",ImVec2(1.5f*s,s))) { legend.Location = ImPlotLocation_SouthWest; } ImGui::SameLine(); if (ImGui::Button("S", ImVec2(1.5f*s,s))) { legend.Location = ImPlotLocation_South; } ImGui::SameLine(); if (ImGui::Button("SE",ImVec2(1.5f*s,s))) { legend.Location = ImPlotLocation_SouthEast; } ImGui::PopStyleVar(); return ret; } void ShowSubplotsContextMenu(ImPlotSubplot& subplot) { if ((ImGui::BeginMenu("Linking"))) { if (ImGui::MenuItem("Link Rows",nullptr,ImHasFlag(subplot.Flags, ImPlotSubplotFlags_LinkRows))) ImFlipFlag(subplot.Flags, ImPlotSubplotFlags_LinkRows); if (ImGui::MenuItem("Link Cols",nullptr,ImHasFlag(subplot.Flags, ImPlotSubplotFlags_LinkCols))) ImFlipFlag(subplot.Flags, ImPlotSubplotFlags_LinkCols); if (ImGui::MenuItem("Link All X",nullptr,ImHasFlag(subplot.Flags, ImPlotSubplotFlags_LinkAllX))) ImFlipFlag(subplot.Flags, ImPlotSubplotFlags_LinkAllX); if (ImGui::MenuItem("Link All Y",nullptr,ImHasFlag(subplot.Flags, ImPlotSubplotFlags_LinkAllY))) ImFlipFlag(subplot.Flags, ImPlotSubplotFlags_LinkAllY); ImGui::EndMenu(); } if ((ImGui::BeginMenu("Settings"))) { BeginDisabledControls(!subplot.HasTitle); if (ImGui::MenuItem("Title",nullptr,subplot.HasTitle && !ImHasFlag(subplot.Flags, ImPlotSubplotFlags_NoTitle))) ImFlipFlag(subplot.Flags, ImPlotSubplotFlags_NoTitle); EndDisabledControls(!subplot.HasTitle); if (ImGui::MenuItem("Resizable",nullptr,!ImHasFlag(subplot.Flags, ImPlotSubplotFlags_NoResize))) ImFlipFlag(subplot.Flags, ImPlotSubplotFlags_NoResize); if (ImGui::MenuItem("Align",nullptr,!ImHasFlag(subplot.Flags, ImPlotSubplotFlags_NoAlign))) ImFlipFlag(subplot.Flags, ImPlotSubplotFlags_NoAlign); if (ImGui::MenuItem("Share Items",nullptr,ImHasFlag(subplot.Flags, ImPlotSubplotFlags_ShareItems))) ImFlipFlag(subplot.Flags, ImPlotSubplotFlags_ShareItems); ImGui::EndMenu(); } } void ShowPlotContextMenu(ImPlotPlot& plot) { ImPlotContext& gp = *GImPlot; const bool owns_legend = gp.CurrentItems == &plot.Items; const bool equal = ImHasFlag(plot.Flags, ImPlotFlags_Equal); char buf[16] = {}; for (int i = 0; i < IMPLOT_NUM_X_AXES; i++) { ImPlotAxis& x_axis = plot.XAxis(i); if (!x_axis.Enabled || !x_axis.HasMenus()) continue; ImGui::PushID(i); ImFormatString(buf, sizeof(buf) - 1, i == 0 ? "X-Axis" : "X-Axis %d", i + 1); if (ImGui::BeginMenu(x_axis.HasLabel() ? plot.GetAxisLabel(x_axis) : buf)) { ShowAxisContextMenu(x_axis, equal ? x_axis.OrthoAxis : nullptr, false); ImGui::EndMenu(); } ImGui::PopID(); } for (int i = 0; i < IMPLOT_NUM_Y_AXES; i++) { ImPlotAxis& y_axis = plot.YAxis(i); if (!y_axis.Enabled || !y_axis.HasMenus()) continue; ImGui::PushID(i); ImFormatString(buf, sizeof(buf) - 1, i == 0 ? "Y-Axis" : "Y-Axis %d", i + 1); if (ImGui::BeginMenu(y_axis.HasLabel() ? plot.GetAxisLabel(y_axis) : buf)) { ShowAxisContextMenu(y_axis, equal ? y_axis.OrthoAxis : nullptr, false); ImGui::EndMenu(); } ImGui::PopID(); } ImGui::Separator(); if (!ImHasFlag(gp.CurrentItems->Legend.Flags, ImPlotLegendFlags_NoMenus)) { if ((ImGui::BeginMenu("Legend"))) { if (owns_legend) { if (ShowLegendContextMenu(plot.Items.Legend, !ImHasFlag(plot.Flags, ImPlotFlags_NoLegend))) ImFlipFlag(plot.Flags, ImPlotFlags_NoLegend); } else if (gp.CurrentSubplot != nullptr) { if (ShowLegendContextMenu(gp.CurrentSubplot->Items.Legend, !ImHasFlag(gp.CurrentSubplot->Flags, ImPlotSubplotFlags_NoLegend))) ImFlipFlag(gp.CurrentSubplot->Flags, ImPlotSubplotFlags_NoLegend); } ImGui::EndMenu(); } } if ((ImGui::BeginMenu("Settings"))) { if (ImGui::MenuItem("Equal", nullptr, ImHasFlag(plot.Flags, ImPlotFlags_Equal))) ImFlipFlag(plot.Flags, ImPlotFlags_Equal); if (ImGui::MenuItem("Box Select",nullptr,!ImHasFlag(plot.Flags, ImPlotFlags_NoBoxSelect))) ImFlipFlag(plot.Flags, ImPlotFlags_NoBoxSelect); BeginDisabledControls(plot.TitleOffset == -1); if (ImGui::MenuItem("Title",nullptr,plot.HasTitle())) ImFlipFlag(plot.Flags, ImPlotFlags_NoTitle); EndDisabledControls(plot.TitleOffset == -1); if (ImGui::MenuItem("Mouse Position",nullptr,!ImHasFlag(plot.Flags, ImPlotFlags_NoMouseText))) ImFlipFlag(plot.Flags, ImPlotFlags_NoMouseText); if (ImGui::MenuItem("Crosshairs",nullptr,ImHasFlag(plot.Flags, ImPlotFlags_Crosshairs))) ImFlipFlag(plot.Flags, ImPlotFlags_Crosshairs); ImGui::EndMenu(); } if (gp.CurrentSubplot != nullptr && !ImHasFlag(gp.CurrentSubplot->Flags, ImPlotSubplotFlags_NoMenus)) { ImGui::Separator(); if ((ImGui::BeginMenu("Subplots"))) { ShowSubplotsContextMenu(*gp.CurrentSubplot); ImGui::EndMenu(); } } } //----------------------------------------------------------------------------- // Axis Utils //----------------------------------------------------------------------------- static inline int AxisPrecision(const ImPlotAxis& axis) { const double range = axis.Ticker.TickCount() > 1 ? (axis.Ticker.Ticks[1].PlotPos - axis.Ticker.Ticks[0].PlotPos) : axis.Range.Size(); return Precision(range); } static inline double RoundAxisValue(const ImPlotAxis& axis, double value) { return RoundTo(value, AxisPrecision(axis)); } void LabelAxisValue(const ImPlotAxis& axis, double value, char* buff, int size, bool round) { ImPlotContext& gp = *GImPlot; // TODO: We shouldn't explicitly check that the axis is Time here. Ideally, // Formatter_Time would handle the formatting for us, but the code below // needs additional arguments which are not currently available in ImPlotFormatter if (axis.Locator == Locator_Time) { ImPlotTimeUnit unit = axis.Vertical ? GetUnitForRange(axis.Range.Size() / (gp.CurrentPlot->PlotRect.GetHeight() / 100)) // TODO: magic value! : GetUnitForRange(axis.Range.Size() / (gp.CurrentPlot->PlotRect.GetWidth() / 100)); // TODO: magic value! FormatDateTime(ImPlotTime::FromDouble(value), buff, size, GetDateTimeFmt(TimeFormatMouseCursor, unit)); } else { if (round) value = RoundAxisValue(axis, value); axis.Formatter(value, buff, size, axis.FormatterData); } } void UpdateAxisColors(ImPlotAxis& axis) { const ImVec4 col_grid = GetStyleColorVec4(ImPlotCol_AxisGrid); axis.ColorMaj = ImGui::GetColorU32(col_grid); axis.ColorMin = ImGui::GetColorU32(col_grid*ImVec4(1,1,1,GImPlot->Style.MinorAlpha)); axis.ColorTick = GetStyleColorU32(ImPlotCol_AxisTick); axis.ColorTxt = GetStyleColorU32(ImPlotCol_AxisText); axis.ColorBg = GetStyleColorU32(ImPlotCol_AxisBg); axis.ColorHov = GetStyleColorU32(ImPlotCol_AxisBgHovered); axis.ColorAct = GetStyleColorU32(ImPlotCol_AxisBgActive); // axis.ColorHiLi = IM_COL32_BLACK_TRANS; } void PadAndDatumAxesX(ImPlotPlot& plot, float& pad_T, float& pad_B, ImPlotAlignmentData* align) { ImPlotContext& gp = *GImPlot; const float T = ImGui::GetTextLineHeight(); const float P = gp.Style.LabelPadding.y; const float K = gp.Style.MinorTickLen.x; int count_T = 0; int count_B = 0; float last_T = plot.AxesRect.Min.y; float last_B = plot.AxesRect.Max.y; for (int i = IMPLOT_NUM_X_AXES; i-- > 0;) { // FYI: can iterate forward ImPlotAxis& axis = plot.XAxis(i); if (!axis.Enabled) continue; const bool label = axis.HasLabel(); const bool ticks = axis.HasTickLabels(); const bool opp = axis.IsOpposite(); const bool time = axis.Scale == ImPlotScale_Time; if (opp) { if (count_T++ > 0) pad_T += K + P; if (label) pad_T += T + P; if (ticks) pad_T += ImMax(T, axis.Ticker.MaxSize.y) + P + (time ? T + P : 0); axis.Datum1 = plot.CanvasRect.Min.y + pad_T; axis.Datum2 = last_T; last_T = axis.Datum1; } else { if (count_B++ > 0) pad_B += K + P; if (label) pad_B += T + P; if (ticks) pad_B += ImMax(T, axis.Ticker.MaxSize.y) + P + (time ? T + P : 0); axis.Datum1 = plot.CanvasRect.Max.y - pad_B; axis.Datum2 = last_B; last_B = axis.Datum1; } } if (align) { count_T = count_B = 0; float delta_T, delta_B; align->Update(pad_T,pad_B,delta_T,delta_B); for (int i = IMPLOT_NUM_X_AXES; i-- > 0;) { ImPlotAxis& axis = plot.XAxis(i); if (!axis.Enabled) continue; if (axis.IsOpposite()) { axis.Datum1 += delta_T; axis.Datum2 += count_T++ > 1 ? delta_T : 0; } else { axis.Datum1 -= delta_B; axis.Datum2 -= count_B++ > 1 ? delta_B : 0; } } } } void PadAndDatumAxesY(ImPlotPlot& plot, float& pad_L, float& pad_R, ImPlotAlignmentData* align) { // [ pad_L ] [ pad_R ] // .................CanvasRect................ // :TPWPK.PTPWP _____PlotRect____ PWPTP.KPWPT: // :A # |- A # |- -| # A -| # A: // :X | X | | X | x: // :I # |- I # |- -| # I -| # I: // :S | S | | S | S: // :3 # |- 0 # |-_______________-| # 1 -| # 2: // :.........................................: // // T = text height // P = label padding // K = minor tick length // W = label width ImPlotContext& gp = *GImPlot; const float T = ImGui::GetTextLineHeight(); const float P = gp.Style.LabelPadding.x; const float K = gp.Style.MinorTickLen.y; int count_L = 0; int count_R = 0; float last_L = plot.AxesRect.Min.x; float last_R = plot.AxesRect.Max.x; for (int i = IMPLOT_NUM_Y_AXES; i-- > 0;) { // FYI: can iterate forward ImPlotAxis& axis = plot.YAxis(i); if (!axis.Enabled) continue; const bool label = axis.HasLabel(); const bool ticks = axis.HasTickLabels(); const bool opp = axis.IsOpposite(); if (opp) { if (count_R++ > 0) pad_R += K + P; if (label) pad_R += T + P; if (ticks) pad_R += axis.Ticker.MaxSize.x + P; axis.Datum1 = plot.CanvasRect.Max.x - pad_R; axis.Datum2 = last_R; last_R = axis.Datum1; } else { if (count_L++ > 0) pad_L += K + P; if (label) pad_L += T + P; if (ticks) pad_L += axis.Ticker.MaxSize.x + P; axis.Datum1 = plot.CanvasRect.Min.x + pad_L; axis.Datum2 = last_L; last_L = axis.Datum1; } } plot.PlotRect.Min.x = plot.CanvasRect.Min.x + pad_L; plot.PlotRect.Max.x = plot.CanvasRect.Max.x - pad_R; if (align) { count_L = count_R = 0; float delta_L, delta_R; align->Update(pad_L,pad_R,delta_L,delta_R); for (int i = IMPLOT_NUM_Y_AXES; i-- > 0;) { ImPlotAxis& axis = plot.YAxis(i); if (!axis.Enabled) continue; if (axis.IsOpposite()) { axis.Datum1 -= delta_R; axis.Datum2 -= count_R++ > 1 ? delta_R : 0; } else { axis.Datum1 += delta_L; axis.Datum2 += count_L++ > 1 ? delta_L : 0; } } } } //----------------------------------------------------------------------------- // RENDERING //----------------------------------------------------------------------------- static inline void RenderGridLinesX(ImDrawList& DrawList, const ImPlotTicker& ticker, const ImRect& rect, ImU32 col_maj, ImU32 col_min, float size_maj, float size_min) { const float density = ticker.TickCount() / rect.GetWidth(); ImVec4 col_min4 = ImGui::ColorConvertU32ToFloat4(col_min); col_min4.w *= ImClamp(ImRemap(density, 0.1f, 0.2f, 1.0f, 0.0f), 0.0f, 1.0f); col_min = ImGui::ColorConvertFloat4ToU32(col_min4); for (int t = 0; t < ticker.TickCount(); t++) { const ImPlotTick& xt = ticker.Ticks[t]; if (xt.PixelPos < rect.Min.x || xt.PixelPos > rect.Max.x) continue; if (xt.Level == 0) { if (xt.Major) DrawList.AddLine(ImVec2(xt.PixelPos, rect.Min.y), ImVec2(xt.PixelPos, rect.Max.y), col_maj, size_maj); else if (density < 0.2f) DrawList.AddLine(ImVec2(xt.PixelPos, rect.Min.y), ImVec2(xt.PixelPos, rect.Max.y), col_min, size_min); } } } static inline void RenderGridLinesY(ImDrawList& DrawList, const ImPlotTicker& ticker, const ImRect& rect, ImU32 col_maj, ImU32 col_min, float size_maj, float size_min) { const float density = ticker.TickCount() / rect.GetHeight(); ImVec4 col_min4 = ImGui::ColorConvertU32ToFloat4(col_min); col_min4.w *= ImClamp(ImRemap(density, 0.1f, 0.2f, 1.0f, 0.0f), 0.0f, 1.0f); col_min = ImGui::ColorConvertFloat4ToU32(col_min4); for (int t = 0; t < ticker.TickCount(); t++) { const ImPlotTick& yt = ticker.Ticks[t]; if (yt.PixelPos < rect.Min.y || yt.PixelPos > rect.Max.y) continue; if (yt.Major) DrawList.AddLine(ImVec2(rect.Min.x, yt.PixelPos), ImVec2(rect.Max.x, yt.PixelPos), col_maj, size_maj); else if (density < 0.2f) DrawList.AddLine(ImVec2(rect.Min.x, yt.PixelPos), ImVec2(rect.Max.x, yt.PixelPos), col_min, size_min); } } static inline void RenderSelectionRect(ImDrawList& DrawList, const ImVec2& p_min, const ImVec2& p_max, const ImVec4& col) { const ImU32 col_bg = ImGui::GetColorU32(col * ImVec4(1,1,1,0.25f)); const ImU32 col_bd = ImGui::GetColorU32(col); DrawList.AddRectFilled(p_min, p_max, col_bg); DrawList.AddRect(p_min, p_max, col_bd); } //----------------------------------------------------------------------------- // Input Handling //----------------------------------------------------------------------------- static const float MOUSE_CURSOR_DRAG_THRESHOLD = 5.0f; static const float BOX_SELECT_DRAG_THRESHOLD = 4.0f; bool UpdateInput(ImPlotPlot& plot) { bool changed = false; ImPlotContext& gp = *GImPlot; ImGuiIO& IO = ImGui::GetIO(); // BUTTON STATE ----------------------------------------------------------- const ImGuiButtonFlags plot_button_flags = ImGuiButtonFlags_AllowOverlap | ImGuiButtonFlags_PressedOnClick | ImGuiButtonFlags_PressedOnDoubleClick | ImGuiButtonFlags_MouseButtonLeft | ImGuiButtonFlags_MouseButtonRight | ImGuiButtonFlags_MouseButtonMiddle; const ImGuiButtonFlags axis_button_flags = ImGuiButtonFlags_FlattenChildren | plot_button_flags; const bool plot_clicked = ImGui::ButtonBehavior(plot.PlotRect,plot.ID,&plot.Hovered,&plot.Held,plot_button_flags); #if (IMGUI_VERSION_NUM < 18966) ImGui::SetItemAllowOverlap(); // Handled by ButtonBehavior() #endif if (plot_clicked) { if (!ImHasFlag(plot.Flags, ImPlotFlags_NoBoxSelect) && IO.MouseClicked[gp.InputMap.Select] && ImHasFlag(IO.KeyMods, gp.InputMap.SelectMod)) { plot.Selecting = true; plot.SelectStart = IO.MousePos; plot.SelectRect = ImRect(0,0,0,0); } if (IO.MouseDoubleClicked[gp.InputMap.Fit]) { plot.FitThisFrame = true; for (int i = 0; i < ImAxis_COUNT; ++i) plot.Axes[i].FitThisFrame = true; } } const bool can_pan = IO.MouseDown[gp.InputMap.Pan] && ImHasFlag(IO.KeyMods, gp.InputMap.PanMod); plot.Held = plot.Held && can_pan; bool x_click[IMPLOT_NUM_X_AXES] = {false}; bool x_held[IMPLOT_NUM_X_AXES] = {false}; bool x_hov[IMPLOT_NUM_X_AXES] = {false}; bool y_click[IMPLOT_NUM_Y_AXES] = {false}; bool y_held[IMPLOT_NUM_Y_AXES] = {false}; bool y_hov[IMPLOT_NUM_Y_AXES] = {false}; for (int i = 0; i < IMPLOT_NUM_X_AXES; ++i) { ImPlotAxis& xax = plot.XAxis(i); if (xax.Enabled) { ImGui::KeepAliveID(xax.ID); x_click[i] = ImGui::ButtonBehavior(xax.HoverRect,xax.ID,&xax.Hovered,&xax.Held,axis_button_flags); if (x_click[i] && IO.MouseDoubleClicked[gp.InputMap.Fit]) plot.FitThisFrame = xax.FitThisFrame = true; xax.Held = xax.Held && can_pan; x_hov[i] = xax.Hovered || plot.Hovered; x_held[i] = xax.Held || plot.Held; } } for (int i = 0; i < IMPLOT_NUM_Y_AXES; ++i) { ImPlotAxis& yax = plot.YAxis(i); if (yax.Enabled) { ImGui::KeepAliveID(yax.ID); y_click[i] = ImGui::ButtonBehavior(yax.HoverRect,yax.ID,&yax.Hovered,&yax.Held,axis_button_flags); if (y_click[i] && IO.MouseDoubleClicked[gp.InputMap.Fit]) plot.FitThisFrame = yax.FitThisFrame = true; yax.Held = yax.Held && can_pan; y_hov[i] = yax.Hovered || plot.Hovered; y_held[i] = yax.Held || plot.Held; } } // cancel due to DND activity if (GImGui->DragDropActive || (IO.KeyMods == gp.InputMap.OverrideMod && gp.InputMap.OverrideMod != 0)) return false; // STATE ------------------------------------------------------------------- const bool axis_equal = ImHasFlag(plot.Flags, ImPlotFlags_Equal); const bool any_x_hov = plot.Hovered || AnyAxesHovered(&plot.Axes[ImAxis_X1], IMPLOT_NUM_X_AXES); const bool any_x_held = plot.Held || AnyAxesHeld(&plot.Axes[ImAxis_X1], IMPLOT_NUM_X_AXES); const bool any_y_hov = plot.Hovered || AnyAxesHovered(&plot.Axes[ImAxis_Y1], IMPLOT_NUM_Y_AXES); const bool any_y_held = plot.Held || AnyAxesHeld(&plot.Axes[ImAxis_Y1], IMPLOT_NUM_Y_AXES); const bool any_hov = any_x_hov || any_y_hov; const bool any_held = any_x_held || any_y_held; const ImVec2 select_drag = ImGui::GetMouseDragDelta(gp.InputMap.Select); const ImVec2 pan_drag = ImGui::GetMouseDragDelta(gp.InputMap.Pan); const float select_drag_sq = ImLengthSqr(select_drag); const float pan_drag_sq = ImLengthSqr(pan_drag); const bool selecting = plot.Selecting && select_drag_sq > MOUSE_CURSOR_DRAG_THRESHOLD; const bool panning = any_held && pan_drag_sq > MOUSE_CURSOR_DRAG_THRESHOLD; // CONTEXT MENU ----------------------------------------------------------- if (IO.MouseReleased[gp.InputMap.Menu] && !plot.ContextLocked) gp.OpenContextThisFrame = true; if (selecting || panning) plot.ContextLocked = true; else if (!(IO.MouseDown[gp.InputMap.Menu] || IO.MouseReleased[gp.InputMap.Menu])) plot.ContextLocked = false; // DRAG INPUT ------------------------------------------------------------- if (any_held && !plot.Selecting) { int drag_direction = 0; for (int i = 0; i < IMPLOT_NUM_X_AXES; i++) { ImPlotAxis& x_axis = plot.XAxis(i); if (x_held[i] && !x_axis.IsInputLocked()) { drag_direction |= (1 << 1); bool increasing = x_axis.IsInverted() ? IO.MouseDelta.x > 0 : IO.MouseDelta.x < 0; if (IO.MouseDelta.x != 0 && !x_axis.IsPanLocked(increasing)) { const double plot_l = x_axis.PixelsToPlot(plot.PlotRect.Min.x - IO.MouseDelta.x); const double plot_r = x_axis.PixelsToPlot(plot.PlotRect.Max.x - IO.MouseDelta.x); x_axis.SetMin(x_axis.IsInverted() ? plot_r : plot_l); x_axis.SetMax(x_axis.IsInverted() ? plot_l : plot_r); if (axis_equal && x_axis.OrthoAxis != nullptr) x_axis.OrthoAxis->SetAspect(x_axis.GetAspect()); changed = true; } } } for (int i = 0; i < IMPLOT_NUM_Y_AXES; i++) { ImPlotAxis& y_axis = plot.YAxis(i); if (y_held[i] && !y_axis.IsInputLocked()) { drag_direction |= (1 << 2); bool increasing = y_axis.IsInverted() ? IO.MouseDelta.y < 0 : IO.MouseDelta.y > 0; if (IO.MouseDelta.y != 0 && !y_axis.IsPanLocked(increasing)) { const double plot_t = y_axis.PixelsToPlot(plot.PlotRect.Min.y - IO.MouseDelta.y); const double plot_b = y_axis.PixelsToPlot(plot.PlotRect.Max.y - IO.MouseDelta.y); y_axis.SetMin(y_axis.IsInverted() ? plot_t : plot_b); y_axis.SetMax(y_axis.IsInverted() ? plot_b : plot_t); if (axis_equal && y_axis.OrthoAxis != nullptr) y_axis.OrthoAxis->SetAspect(y_axis.GetAspect()); changed = true; } } } if (IO.MouseDragMaxDistanceSqr[gp.InputMap.Pan] > MOUSE_CURSOR_DRAG_THRESHOLD) { switch (drag_direction) { case 0 : ImGui::SetMouseCursor(ImGuiMouseCursor_NotAllowed); break; case (1 << 1) : ImGui::SetMouseCursor(ImGuiMouseCursor_ResizeEW); break; case (1 << 2) : ImGui::SetMouseCursor(ImGuiMouseCursor_ResizeNS); break; default : ImGui::SetMouseCursor(ImGuiMouseCursor_ResizeAll); break; } } } // SCROLL INPUT ----------------------------------------------------------- if (any_hov && IO.MouseWheel != 0 && ImHasFlag(IO.KeyMods, gp.InputMap.ZoomMod)) { float zoom_rate = gp.InputMap.ZoomRate; if (IO.MouseWheel > 0) zoom_rate = (-zoom_rate) / (1.0f + (2.0f * zoom_rate)); ImVec2 rect_size = plot.PlotRect.GetSize(); float tx = ImRemap(IO.MousePos.x, plot.PlotRect.Min.x, plot.PlotRect.Max.x, 0.0f, 1.0f); float ty = ImRemap(IO.MousePos.y, plot.PlotRect.Min.y, plot.PlotRect.Max.y, 0.0f, 1.0f); for (int i = 0; i < IMPLOT_NUM_X_AXES; i++) { ImPlotAxis& x_axis = plot.XAxis(i); const bool equal_zoom = axis_equal && x_axis.OrthoAxis != nullptr; const bool equal_locked = (equal_zoom != false) && x_axis.OrthoAxis->IsInputLocked(); if (x_hov[i] && !x_axis.IsInputLocked() && !equal_locked) { float correction = (plot.Hovered && equal_zoom) ? 0.5f : 1.0f; const double plot_l = x_axis.PixelsToPlot(plot.PlotRect.Min.x - rect_size.x * tx * zoom_rate * correction); const double plot_r = x_axis.PixelsToPlot(plot.PlotRect.Max.x + rect_size.x * (1 - tx) * zoom_rate * correction); x_axis.SetMin(x_axis.IsInverted() ? plot_r : plot_l); x_axis.SetMax(x_axis.IsInverted() ? plot_l : plot_r); if (axis_equal && x_axis.OrthoAxis != nullptr) x_axis.OrthoAxis->SetAspect(x_axis.GetAspect()); changed = true; } } for (int i = 0; i < IMPLOT_NUM_Y_AXES; i++) { ImPlotAxis& y_axis = plot.YAxis(i); const bool equal_zoom = axis_equal && y_axis.OrthoAxis != nullptr; const bool equal_locked = equal_zoom && y_axis.OrthoAxis->IsInputLocked(); if (y_hov[i] && !y_axis.IsInputLocked() && !equal_locked) { float correction = (plot.Hovered && equal_zoom) ? 0.5f : 1.0f; const double plot_t = y_axis.PixelsToPlot(plot.PlotRect.Min.y - rect_size.y * ty * zoom_rate * correction); const double plot_b = y_axis.PixelsToPlot(plot.PlotRect.Max.y + rect_size.y * (1 - ty) * zoom_rate * correction); y_axis.SetMin(y_axis.IsInverted() ? plot_t : plot_b); y_axis.SetMax(y_axis.IsInverted() ? plot_b : plot_t); if (axis_equal && y_axis.OrthoAxis != nullptr) y_axis.OrthoAxis->SetAspect(y_axis.GetAspect()); changed = true; } } } // BOX-SELECTION ---------------------------------------------------------- if (plot.Selecting) { const ImVec2 d = plot.SelectStart - IO.MousePos; const bool x_can_change = !ImHasFlag(IO.KeyMods,gp.InputMap.SelectHorzMod) && ImFabs(d.x) > 2; const bool y_can_change = !ImHasFlag(IO.KeyMods,gp.InputMap.SelectVertMod) && ImFabs(d.y) > 2; // confirm if (IO.MouseReleased[gp.InputMap.Select]) { for (int i = 0; i < IMPLOT_NUM_X_AXES; i++) { ImPlotAxis& x_axis = plot.XAxis(i); if (!x_axis.IsInputLocked() && x_can_change) { const double p1 = x_axis.PixelsToPlot(plot.SelectStart.x); const double p2 = x_axis.PixelsToPlot(IO.MousePos.x); x_axis.SetMin(ImMin(p1, p2)); x_axis.SetMax(ImMax(p1, p2)); changed = true; } } for (int i = 0; i < IMPLOT_NUM_Y_AXES; i++) { ImPlotAxis& y_axis = plot.YAxis(i); if (!y_axis.IsInputLocked() && y_can_change) { const double p1 = y_axis.PixelsToPlot(plot.SelectStart.y); const double p2 = y_axis.PixelsToPlot(IO.MousePos.y); y_axis.SetMin(ImMin(p1, p2)); y_axis.SetMax(ImMax(p1, p2)); changed = true; } } if (x_can_change || y_can_change || (ImHasFlag(IO.KeyMods,gp.InputMap.SelectHorzMod) && ImHasFlag(IO.KeyMods,gp.InputMap.SelectVertMod))) gp.OpenContextThisFrame = false; plot.Selected = plot.Selecting = false; } // cancel else if (IO.MouseReleased[gp.InputMap.SelectCancel]) { plot.Selected = plot.Selecting = false; gp.OpenContextThisFrame = false; } else if (ImLengthSqr(d) > BOX_SELECT_DRAG_THRESHOLD) { // bad selection if (plot.IsInputLocked()) { ImGui::SetMouseCursor(ImGuiMouseCursor_NotAllowed); gp.OpenContextThisFrame = false; plot.Selected = false; } else { // TODO: Handle only min or max locked cases const bool full_width = ImHasFlag(IO.KeyMods, gp.InputMap.SelectHorzMod) || AllAxesInputLocked(&plot.Axes[ImAxis_X1], IMPLOT_NUM_X_AXES); const bool full_height = ImHasFlag(IO.KeyMods, gp.InputMap.SelectVertMod) || AllAxesInputLocked(&plot.Axes[ImAxis_Y1], IMPLOT_NUM_Y_AXES); plot.SelectRect.Min.x = full_width ? plot.PlotRect.Min.x : ImMin(plot.SelectStart.x, IO.MousePos.x); plot.SelectRect.Max.x = full_width ? plot.PlotRect.Max.x : ImMax(plot.SelectStart.x, IO.MousePos.x); plot.SelectRect.Min.y = full_height ? plot.PlotRect.Min.y : ImMin(plot.SelectStart.y, IO.MousePos.y); plot.SelectRect.Max.y = full_height ? plot.PlotRect.Max.y : ImMax(plot.SelectStart.y, IO.MousePos.y); plot.SelectRect.Min -= plot.PlotRect.Min; plot.SelectRect.Max -= plot.PlotRect.Min; plot.Selected = true; } } else { plot.Selected = false; } } return changed; } //----------------------------------------------------------------------------- // Next Plot Data (Legacy) //----------------------------------------------------------------------------- void ApplyNextPlotData(ImAxis idx) { ImPlotContext& gp = *GImPlot; ImPlotPlot& plot = *gp.CurrentPlot; ImPlotAxis& axis = plot.Axes[idx]; if (!axis.Enabled) return; double* npd_lmin = gp.NextPlotData.LinkedMin[idx]; double* npd_lmax = gp.NextPlotData.LinkedMax[idx]; bool npd_rngh = gp.NextPlotData.HasRange[idx]; ImPlotCond npd_rngc = gp.NextPlotData.RangeCond[idx]; ImPlotRange npd_rngv = gp.NextPlotData.Range[idx]; axis.LinkedMin = npd_lmin; axis.LinkedMax = npd_lmax; axis.PullLinks(); if (npd_rngh) { if (!plot.Initialized || npd_rngc == ImPlotCond_Always) axis.SetRange(npd_rngv); } axis.HasRange = npd_rngh; axis.RangeCond = npd_rngc; } //----------------------------------------------------------------------------- // Setup //----------------------------------------------------------------------------- void SetupAxis(ImAxis idx, const char* label, ImPlotAxisFlags flags) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr && !gp.CurrentPlot->SetupLocked, "Setup needs to be called after BeginPlot and before any setup locking functions (e.g. PlotX)!"); // get plot and axis ImPlotPlot& plot = *gp.CurrentPlot; ImPlotAxis& axis = plot.Axes[idx]; // set ID axis.ID = plot.ID + idx + 1; // check and set flags if (plot.JustCreated || flags != axis.PreviousFlags) axis.Flags = flags; axis.PreviousFlags = flags; // enable axis axis.Enabled = true; // set label plot.SetAxisLabel(axis,label); // cache colors UpdateAxisColors(axis); } void SetupAxisLimits(ImAxis idx, double min_lim, double max_lim, ImPlotCond cond) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr && !gp.CurrentPlot->SetupLocked, "Setup needs to be called after BeginPlot and before any setup locking functions (e.g. PlotX)!"); // get plot and axis ImPlotPlot& plot = *gp.CurrentPlot; ImPlotAxis& axis = plot.Axes[idx]; IM_ASSERT_USER_ERROR(axis.Enabled, "Axis is not enabled! Did you forget to call SetupAxis()?"); if (!plot.Initialized || cond == ImPlotCond_Always) axis.SetRange(min_lim, max_lim); axis.HasRange = true; axis.RangeCond = cond; } void SetupAxisFormat(ImAxis idx, const char* fmt) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr && !gp.CurrentPlot->SetupLocked, "Setup needs to be called after BeginPlot and before any setup locking functions (e.g. PlotX)!"); ImPlotPlot& plot = *gp.CurrentPlot; ImPlotAxis& axis = plot.Axes[idx]; IM_ASSERT_USER_ERROR(axis.Enabled, "Axis is not enabled! Did you forget to call SetupAxis()?"); axis.HasFormatSpec = fmt != nullptr; if (fmt != nullptr) ImStrncpy(axis.FormatSpec,fmt,sizeof(axis.FormatSpec)); } void SetupAxisLinks(ImAxis idx, double* min_lnk, double* max_lnk) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr && !gp.CurrentPlot->SetupLocked, "Setup needs to be called after BeginPlot and before any setup locking functions (e.g. PlotX)!"); ImPlotPlot& plot = *gp.CurrentPlot; ImPlotAxis& axis = plot.Axes[idx]; IM_ASSERT_USER_ERROR(axis.Enabled, "Axis is not enabled! Did you forget to call SetupAxis()?"); axis.LinkedMin = min_lnk; axis.LinkedMax = max_lnk; axis.PullLinks(); } void SetupAxisFormat(ImAxis idx, ImPlotFormatter formatter, void* data) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr && !gp.CurrentPlot->SetupLocked, "Setup needs to be called after BeginPlot and before any setup locking functions (e.g. PlotX)!"); ImPlotPlot& plot = *gp.CurrentPlot; ImPlotAxis& axis = plot.Axes[idx]; IM_ASSERT_USER_ERROR(axis.Enabled, "Axis is not enabled! Did you forget to call SetupAxis()?"); axis.Formatter = formatter; axis.FormatterData = data; } void SetupAxisTicks(ImAxis idx, const double* values, int n_ticks, const char* const labels[], bool show_default) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr && !gp.CurrentPlot->SetupLocked, "Setup needs to be called after BeginPlot and before any setup locking functions (e.g. PlotX)!"); ImPlotPlot& plot = *gp.CurrentPlot; ImPlotAxis& axis = plot.Axes[idx]; IM_ASSERT_USER_ERROR(axis.Enabled, "Axis is not enabled! Did you forget to call SetupAxis()?"); axis.ShowDefaultTicks = show_default; AddTicksCustom(values, labels, n_ticks, axis.Ticker, axis.Formatter ? axis.Formatter : Formatter_Default, (axis.Formatter && axis.FormatterData) ? axis.FormatterData : axis.HasFormatSpec ? axis.FormatSpec : (void*)IMPLOT_LABEL_FORMAT); } void SetupAxisTicks(ImAxis idx, double v_min, double v_max, int n_ticks, const char* const labels[], bool show_default) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr && !gp.CurrentPlot->SetupLocked, "Setup needs to be called after BeginPlot and before any setup locking functions (e.g. PlotX)!"); n_ticks = n_ticks < 2 ? 2 : n_ticks; FillRange(gp.TempDouble1, n_ticks, v_min, v_max); SetupAxisTicks(idx, gp.TempDouble1.Data, n_ticks, labels, show_default); } void SetupAxisScale(ImAxis idx, ImPlotScale scale) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr && !gp.CurrentPlot->SetupLocked, "Setup needs to be called after BeginPlot and before any setup locking functions (e.g. PlotX)!"); ImPlotPlot& plot = *gp.CurrentPlot; ImPlotAxis& axis = plot.Axes[idx]; IM_ASSERT_USER_ERROR(axis.Enabled, "Axis is not enabled! Did you forget to call SetupAxis()?"); axis.Scale = scale; switch (scale) { case ImPlotScale_Time: axis.TransformForward = nullptr; axis.TransformInverse = nullptr; axis.TransformData = nullptr; axis.Locator = Locator_Time; axis.ConstraintRange = ImPlotRange(IMPLOT_MIN_TIME, IMPLOT_MAX_TIME); axis.Ticker.Levels = 2; break; case ImPlotScale_Log10: axis.TransformForward = TransformForward_Log10; axis.TransformInverse = TransformInverse_Log10; axis.TransformData = nullptr; axis.Locator = Locator_Log10; axis.ConstraintRange = ImPlotRange(DBL_MIN, INFINITY); break; case ImPlotScale_SymLog: axis.TransformForward = TransformForward_SymLog; axis.TransformInverse = TransformInverse_SymLog; axis.TransformData = nullptr; axis.Locator = Locator_SymLog; axis.ConstraintRange = ImPlotRange(-INFINITY, INFINITY); break; default: axis.TransformForward = nullptr; axis.TransformInverse = nullptr; axis.TransformData = nullptr; axis.Locator = nullptr; axis.ConstraintRange = ImPlotRange(-INFINITY, INFINITY); break; } } void SetupAxisScale(ImAxis idx, ImPlotTransform fwd, ImPlotTransform inv, void* data) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr && !gp.CurrentPlot->SetupLocked, "Setup needs to be called after BeginPlot and before any setup locking functions (e.g. PlotX)!"); ImPlotPlot& plot = *gp.CurrentPlot; ImPlotAxis& axis = plot.Axes[idx]; IM_ASSERT_USER_ERROR(axis.Enabled, "Axis is not enabled! Did you forget to call SetupAxis()?"); axis.Scale = IMPLOT_AUTO; axis.TransformForward = fwd; axis.TransformInverse = inv; axis.TransformData = data; } void SetupAxisLimitsConstraints(ImAxis idx, double v_min, double v_max) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr && !gp.CurrentPlot->SetupLocked, "Setup needs to be called after BeginPlot and before any setup locking functions (e.g. PlotX)!"); ImPlotPlot& plot = *gp.CurrentPlot; ImPlotAxis& axis = plot.Axes[idx]; IM_ASSERT_USER_ERROR(axis.Enabled, "Axis is not enabled! Did you forget to call SetupAxis()?"); axis.ConstraintRange.Min = v_min; axis.ConstraintRange.Max = v_max; } void SetupAxisZoomConstraints(ImAxis idx, double z_min, double z_max) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr && !gp.CurrentPlot->SetupLocked, "Setup needs to be called after BeginPlot and before any setup locking functions (e.g. PlotX)!"); ImPlotPlot& plot = *gp.CurrentPlot; ImPlotAxis& axis = plot.Axes[idx]; IM_ASSERT_USER_ERROR(axis.Enabled, "Axis is not enabled! Did you forget to call SetupAxis()?"); axis.ConstraintZoom.Min = z_min; axis.ConstraintZoom.Max = z_max; } void SetupAxes(const char* x_label, const char* y_label, ImPlotAxisFlags x_flags, ImPlotAxisFlags y_flags) { SetupAxis(ImAxis_X1, x_label, x_flags); SetupAxis(ImAxis_Y1, y_label, y_flags); } void SetupAxesLimits(double x_min, double x_max, double y_min, double y_max, ImPlotCond cond) { SetupAxisLimits(ImAxis_X1, x_min, x_max, cond); SetupAxisLimits(ImAxis_Y1, y_min, y_max, cond); } void SetupLegend(ImPlotLocation location, ImPlotLegendFlags flags) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr && !gp.CurrentPlot->SetupLocked, "Setup needs to be called after BeginPlot and before any setup locking functions (e.g. PlotX)!"); IM_ASSERT_USER_ERROR(gp.CurrentItems != nullptr, "SetupLegend() needs to be called within an itemized context!"); ImPlotLegend& legend = gp.CurrentItems->Legend; // check and set location if (location != legend.PreviousLocation) legend.Location = location; legend.PreviousLocation = location; // check and set flags if (flags != legend.PreviousFlags) legend.Flags = flags; legend.PreviousFlags = flags; } void SetupMouseText(ImPlotLocation location, ImPlotMouseTextFlags flags) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr && !gp.CurrentPlot->SetupLocked, "Setup needs to be called after BeginPlot and before any setup locking functions (e.g. PlotX)!"); gp.CurrentPlot->MouseTextLocation = location; gp.CurrentPlot->MouseTextFlags = flags; } //----------------------------------------------------------------------------- // SetNext //----------------------------------------------------------------------------- void SetNextAxisLimits(ImAxis axis, double v_min, double v_max, ImPlotCond cond) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot == nullptr, "SetNextAxisLimits() needs to be called before BeginPlot()!"); IM_ASSERT(cond == 0 || ImIsPowerOfTwo(cond)); // Make sure the user doesn't attempt to combine multiple condition flags. gp.NextPlotData.HasRange[axis] = true; gp.NextPlotData.RangeCond[axis] = cond; gp.NextPlotData.Range[axis].Min = v_min; gp.NextPlotData.Range[axis].Max = v_max; } void SetNextAxisLinks(ImAxis axis, double* link_min, double* link_max) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot == nullptr, "SetNextAxisLinks() needs to be called before BeginPlot()!"); gp.NextPlotData.LinkedMin[axis] = link_min; gp.NextPlotData.LinkedMax[axis] = link_max; } void SetNextAxisToFit(ImAxis axis) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot == nullptr, "SetNextAxisToFit() needs to be called before BeginPlot()!"); gp.NextPlotData.Fit[axis] = true; } void SetNextAxesLimits(double x_min, double x_max, double y_min, double y_max, ImPlotCond cond) { SetNextAxisLimits(ImAxis_X1, x_min, x_max, cond); SetNextAxisLimits(ImAxis_Y1, y_min, y_max, cond); } void SetNextAxesToFit() { for (int i = 0; i < ImAxis_COUNT; ++i) SetNextAxisToFit(i); } //----------------------------------------------------------------------------- // BeginPlot //----------------------------------------------------------------------------- bool BeginPlot(const char* title_id, const ImVec2& size, ImPlotFlags flags) { IM_ASSERT_USER_ERROR(GImPlot != nullptr, "No current context. Did you call ImPlot::CreateContext() or ImPlot::SetCurrentContext()?"); ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot == nullptr, "Mismatched BeginPlot()/EndPlot()!"); // FRONT MATTER ----------------------------------------------------------- if (gp.CurrentSubplot != nullptr) ImGui::PushID(gp.CurrentSubplot->CurrentIdx); // get globals ImGuiContext &G = *GImGui; ImGuiWindow* Window = G.CurrentWindow; // skip if needed if (Window->SkipItems && !gp.CurrentSubplot) { ResetCtxForNextPlot(GImPlot); return false; } // ID and age (TODO: keep track of plot age in frames) const ImGuiID ID = Window->GetID(title_id); const bool just_created = gp.Plots.GetByKey(ID) == nullptr; gp.CurrentPlot = gp.Plots.GetOrAddByKey(ID); ImPlotPlot &plot = *gp.CurrentPlot; plot.ID = ID; plot.Items.ID = ID - 1; plot.JustCreated = just_created; plot.SetupLocked = false; // check flags if (plot.JustCreated) plot.Flags = flags; else if (flags != plot.PreviousFlags) plot.Flags = flags; plot.PreviousFlags = flags; // setup default axes if (plot.JustCreated) { SetupAxis(ImAxis_X1); SetupAxis(ImAxis_Y1); } // reset axes for (int i = 0; i < ImAxis_COUNT; ++i) { plot.Axes[i].Reset(); UpdateAxisColors(plot.Axes[i]); } // ensure first axes enabled plot.Axes[ImAxis_X1].Enabled = true; plot.Axes[ImAxis_Y1].Enabled = true; // set initial axes plot.CurrentX = ImAxis_X1; plot.CurrentY = ImAxis_Y1; // process next plot data (legacy) for (int i = 0; i < ImAxis_COUNT; ++i) ApplyNextPlotData(i); // capture scroll with a child region if (!ImHasFlag(plot.Flags, ImPlotFlags_NoChild)) { ImVec2 child_size; if (gp.CurrentSubplot != nullptr) child_size = gp.CurrentSubplot->CellSize; else child_size = ImVec2(size.x == 0 ? gp.Style.PlotDefaultSize.x : size.x, size.y == 0 ? gp.Style.PlotDefaultSize.y : size.y); ImGui::BeginChild(title_id, child_size, false, ImGuiWindowFlags_NoScrollbar); Window = ImGui::GetCurrentWindow(); Window->ScrollMax.y = 1.0f; gp.ChildWindowMade = true; } else { gp.ChildWindowMade = false; } // clear text buffers plot.ClearTextBuffer(); plot.SetTitle(title_id); // set frame size ImVec2 frame_size; if (gp.CurrentSubplot != nullptr) frame_size = gp.CurrentSubplot->CellSize; else frame_size = ImGui::CalcItemSize(size, gp.Style.PlotDefaultSize.x, gp.Style.PlotDefaultSize.y); if (frame_size.x < gp.Style.PlotMinSize.x && (size.x < 0.0f || gp.CurrentSubplot != nullptr)) frame_size.x = gp.Style.PlotMinSize.x; if (frame_size.y < gp.Style.PlotMinSize.y && (size.y < 0.0f || gp.CurrentSubplot != nullptr)) frame_size.y = gp.Style.PlotMinSize.y; plot.FrameRect = ImRect(Window->DC.CursorPos, Window->DC.CursorPos + frame_size); ImGui::ItemSize(plot.FrameRect); if (!ImGui::ItemAdd(plot.FrameRect, plot.ID, &plot.FrameRect) && !gp.CurrentSubplot) { ResetCtxForNextPlot(GImPlot); return false; } // setup items (or dont) if (gp.CurrentItems == nullptr) gp.CurrentItems = &plot.Items; return true; } //----------------------------------------------------------------------------- // SetupFinish //----------------------------------------------------------------------------- void SetupFinish() { IM_ASSERT_USER_ERROR(GImPlot != nullptr, "No current context. Did you call ImPlot::CreateContext() or ImPlot::SetCurrentContext()?"); ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr, "SetupFinish needs to be called after BeginPlot!"); ImGuiContext& G = *GImGui; ImDrawList& DrawList = *G.CurrentWindow->DrawList; const ImGuiStyle& Style = G.Style; ImPlotPlot &plot = *gp.CurrentPlot; // lock setup plot.SetupLocked = true; // finalize axes and set default formatter/locator for (int i = 0; i < ImAxis_COUNT; ++i) { ImPlotAxis& axis = plot.Axes[i]; if (axis.Enabled) { axis.Constrain(); if (!plot.Initialized && axis.CanInitFit()) plot.FitThisFrame = axis.FitThisFrame = true; } if (axis.Formatter == nullptr) { axis.Formatter = Formatter_Default; if (axis.HasFormatSpec) axis.FormatterData = axis.FormatSpec; else axis.FormatterData = (void*)IMPLOT_LABEL_FORMAT; } if (axis.Locator == nullptr) { axis.Locator = Locator_Default; } } // setup nullptr orthogonal axes const bool axis_equal = ImHasFlag(plot.Flags, ImPlotFlags_Equal); for (int ix = ImAxis_X1, iy = ImAxis_Y1; ix < ImAxis_Y1 || iy < ImAxis_COUNT; ++ix, ++iy) { ImPlotAxis& x_axis = plot.Axes[ix]; ImPlotAxis& y_axis = plot.Axes[iy]; if (x_axis.Enabled && y_axis.Enabled) { if (x_axis.OrthoAxis == nullptr) x_axis.OrthoAxis = &y_axis; if (y_axis.OrthoAxis == nullptr) y_axis.OrthoAxis = &x_axis; } else if (x_axis.Enabled) { if (x_axis.OrthoAxis == nullptr && !axis_equal) x_axis.OrthoAxis = &plot.Axes[ImAxis_Y1]; } else if (y_axis.Enabled) { if (y_axis.OrthoAxis == nullptr && !axis_equal) y_axis.OrthoAxis = &plot.Axes[ImAxis_X1]; } } // canvas/axes bb plot.CanvasRect = ImRect(plot.FrameRect.Min + gp.Style.PlotPadding, plot.FrameRect.Max - gp.Style.PlotPadding); plot.AxesRect = plot.FrameRect; // outside legend adjustments if (!ImHasFlag(plot.Flags, ImPlotFlags_NoLegend) && plot.Items.GetLegendCount() > 0 && ImHasFlag(plot.Items.Legend.Flags, ImPlotLegendFlags_Outside)) { ImPlotLegend& legend = plot.Items.Legend; const bool horz = ImHasFlag(legend.Flags, ImPlotLegendFlags_Horizontal); const ImVec2 legend_size = CalcLegendSize(plot.Items, gp.Style.LegendInnerPadding, gp.Style.LegendSpacing, !horz); const bool west = ImHasFlag(legend.Location, ImPlotLocation_West) && !ImHasFlag(legend.Location, ImPlotLocation_East); const bool east = ImHasFlag(legend.Location, ImPlotLocation_East) && !ImHasFlag(legend.Location, ImPlotLocation_West); const bool north = ImHasFlag(legend.Location, ImPlotLocation_North) && !ImHasFlag(legend.Location, ImPlotLocation_South); const bool south = ImHasFlag(legend.Location, ImPlotLocation_South) && !ImHasFlag(legend.Location, ImPlotLocation_North); if ((west && !horz) || (west && horz && !north && !south)) { plot.CanvasRect.Min.x += (legend_size.x + gp.Style.LegendPadding.x); plot.AxesRect.Min.x += (legend_size.x + gp.Style.PlotPadding.x); } if ((east && !horz) || (east && horz && !north && !south)) { plot.CanvasRect.Max.x -= (legend_size.x + gp.Style.LegendPadding.x); plot.AxesRect.Max.x -= (legend_size.x + gp.Style.PlotPadding.x); } if ((north && horz) || (north && !horz && !west && !east)) { plot.CanvasRect.Min.y += (legend_size.y + gp.Style.LegendPadding.y); plot.AxesRect.Min.y += (legend_size.y + gp.Style.PlotPadding.y); } if ((south && horz) || (south && !horz && !west && !east)) { plot.CanvasRect.Max.y -= (legend_size.y + gp.Style.LegendPadding.y); plot.AxesRect.Max.y -= (legend_size.y + gp.Style.PlotPadding.y); } } // plot bb float pad_top = 0, pad_bot = 0, pad_left = 0, pad_right = 0; // (0) calc top padding form title ImVec2 title_size(0.0f, 0.0f); if (plot.HasTitle()) title_size = ImGui::CalcTextSize(plot.GetTitle(), nullptr, true); if (title_size.x > 0) { pad_top += title_size.y + gp.Style.LabelPadding.y; plot.AxesRect.Min.y += gp.Style.PlotPadding.y + pad_top; } // (1) calc addition top padding and bot padding PadAndDatumAxesX(plot,pad_top,pad_bot,gp.CurrentAlignmentH); const float plot_height = plot.CanvasRect.GetHeight() - pad_top - pad_bot; // (2) get y tick labels (needed for left/right pad) for (int i = 0; i < IMPLOT_NUM_Y_AXES; i++) { ImPlotAxis& axis = plot.YAxis(i); if (axis.WillRender() && axis.ShowDefaultTicks && plot_height > 0) { axis.Locator(axis.Ticker, axis.Range, plot_height, true, axis.Formatter, axis.FormatterData); } } // (3) calc left/right pad PadAndDatumAxesY(plot,pad_left,pad_right,gp.CurrentAlignmentV); const float plot_width = plot.CanvasRect.GetWidth() - pad_left - pad_right; // (4) get x ticks for (int i = 0; i < IMPLOT_NUM_X_AXES; i++) { ImPlotAxis& axis = plot.XAxis(i); if (axis.WillRender() && axis.ShowDefaultTicks && plot_width > 0) { axis.Locator(axis.Ticker, axis.Range, plot_width, false, axis.Formatter, axis.FormatterData); } } // (5) calc plot bb plot.PlotRect = ImRect(plot.CanvasRect.Min + ImVec2(pad_left, pad_top), plot.CanvasRect.Max - ImVec2(pad_right, pad_bot)); // HOVER------------------------------------------------------------ // axes hover rect, pixel ranges for (int i = 0; i < IMPLOT_NUM_X_AXES; ++i) { ImPlotAxis& xax = plot.XAxis(i); xax.HoverRect = ImRect(ImVec2(plot.PlotRect.Min.x, ImMin(xax.Datum1,xax.Datum2)), ImVec2(plot.PlotRect.Max.x, ImMax(xax.Datum1,xax.Datum2))); xax.PixelMin = xax.IsInverted() ? plot.PlotRect.Max.x : plot.PlotRect.Min.x; xax.PixelMax = xax.IsInverted() ? plot.PlotRect.Min.x : plot.PlotRect.Max.x; xax.UpdateTransformCache(); } for (int i = 0; i < IMPLOT_NUM_Y_AXES; ++i) { ImPlotAxis& yax = plot.YAxis(i); yax.HoverRect = ImRect(ImVec2(ImMin(yax.Datum1,yax.Datum2),plot.PlotRect.Min.y), ImVec2(ImMax(yax.Datum1,yax.Datum2),plot.PlotRect.Max.y)); yax.PixelMin = yax.IsInverted() ? plot.PlotRect.Min.y : plot.PlotRect.Max.y; yax.PixelMax = yax.IsInverted() ? plot.PlotRect.Max.y : plot.PlotRect.Min.y; yax.UpdateTransformCache(); } // Equal axis constraint. Must happen after we set Pixels // constrain equal axes for primary x and y if not approximately equal // constrains x to y since x pixel size depends on y labels width, and causes feedback loops in opposite case if (axis_equal) { for (int i = 0; i < IMPLOT_NUM_X_AXES; ++i) { ImPlotAxis& x_axis = plot.XAxis(i); if (x_axis.OrthoAxis == nullptr) continue; double xar = x_axis.GetAspect(); double yar = x_axis.OrthoAxis->GetAspect(); // edge case: user has set x range this frame, so fit y to x so that we honor their request for x range // NB: because of feedback across several frames, the user's x request may not be perfectly honored if (x_axis.HasRange) x_axis.OrthoAxis->SetAspect(xar); else if (!ImAlmostEqual(xar,yar) && !x_axis.OrthoAxis->IsInputLocked()) x_axis.SetAspect(yar); } } // INPUT ------------------------------------------------------------------ if (!ImHasFlag(plot.Flags, ImPlotFlags_NoInputs)) UpdateInput(plot); // fit from FitNextPlotAxes or auto fit for (int i = 0; i < ImAxis_COUNT; ++i) { if (gp.NextPlotData.Fit[i] || plot.Axes[i].IsAutoFitting()) { plot.FitThisFrame = true; plot.Axes[i].FitThisFrame = true; } } // RENDER ----------------------------------------------------------------- const float txt_height = ImGui::GetTextLineHeight(); // render frame if (!ImHasFlag(plot.Flags, ImPlotFlags_NoFrame)) ImGui::RenderFrame(plot.FrameRect.Min, plot.FrameRect.Max, GetStyleColorU32(ImPlotCol_FrameBg), true, Style.FrameRounding); // grid bg DrawList.AddRectFilled(plot.PlotRect.Min, plot.PlotRect.Max, GetStyleColorU32(ImPlotCol_PlotBg)); // transform ticks for (int i = 0; i < ImAxis_COUNT; i++) { ImPlotAxis& axis = plot.Axes[i]; if (axis.WillRender()) { for (int t = 0; t < axis.Ticker.TickCount(); t++) { ImPlotTick& tk = axis.Ticker.Ticks[t]; tk.PixelPos = IM_ROUND(axis.PlotToPixels(tk.PlotPos)); } } } // render grid (background) for (int i = 0; i < IMPLOT_NUM_X_AXES; i++) { ImPlotAxis& x_axis = plot.XAxis(i); if (x_axis.Enabled && x_axis.HasGridLines() && !x_axis.IsForeground()) RenderGridLinesX(DrawList, x_axis.Ticker, plot.PlotRect, x_axis.ColorMaj, x_axis.ColorMin, gp.Style.MajorGridSize.x, gp.Style.MinorGridSize.x); } for (int i = 0; i < IMPLOT_NUM_Y_AXES; i++) { ImPlotAxis& y_axis = plot.YAxis(i); if (y_axis.Enabled && y_axis.HasGridLines() && !y_axis.IsForeground()) RenderGridLinesY(DrawList, y_axis.Ticker, plot.PlotRect, y_axis.ColorMaj, y_axis.ColorMin, gp.Style.MajorGridSize.y, gp.Style.MinorGridSize.y); } // render x axis button, label, tick labels for (int i = 0; i < IMPLOT_NUM_X_AXES; i++) { ImPlotAxis& ax = plot.XAxis(i); if (!ax.Enabled) continue; if ((ax.Hovered || ax.Held) && !plot.Held && !ImHasFlag(ax.Flags, ImPlotAxisFlags_NoHighlight)) DrawList.AddRectFilled(ax.HoverRect.Min, ax.HoverRect.Max, ax.Held ? ax.ColorAct : ax.ColorHov); else if (ax.ColorHiLi != IM_COL32_BLACK_TRANS) { DrawList.AddRectFilled(ax.HoverRect.Min, ax.HoverRect.Max, ax.ColorHiLi); ax.ColorHiLi = IM_COL32_BLACK_TRANS; } else if (ax.ColorBg != IM_COL32_BLACK_TRANS) { DrawList.AddRectFilled(ax.HoverRect.Min, ax.HoverRect.Max, ax.ColorBg); } const ImPlotTicker& tkr = ax.Ticker; const bool opp = ax.IsOpposite(); if (ax.HasLabel()) { const char* label = plot.GetAxisLabel(ax); const ImVec2 label_size = ImGui::CalcTextSize(label); const float label_offset = (ax.HasTickLabels() ? tkr.MaxSize.y + gp.Style.LabelPadding.y : 0.0f) + (tkr.Levels - 1) * (txt_height + gp.Style.LabelPadding.y) + gp.Style.LabelPadding.y; const ImVec2 label_pos(plot.PlotRect.GetCenter().x - label_size.x * 0.5f, opp ? ax.Datum1 - label_offset - label_size.y : ax.Datum1 + label_offset); DrawList.AddText(label_pos, ax.ColorTxt, label); } if (ax.HasTickLabels()) { for (int j = 0; j < tkr.TickCount(); ++j) { const ImPlotTick& tk = tkr.Ticks[j]; const float datum = ax.Datum1 + (opp ? (-gp.Style.LabelPadding.y -txt_height -tk.Level * (txt_height + gp.Style.LabelPadding.y)) : gp.Style.LabelPadding.y + tk.Level * (txt_height + gp.Style.LabelPadding.y)); if (tk.ShowLabel && tk.PixelPos >= plot.PlotRect.Min.x - 1 && tk.PixelPos <= plot.PlotRect.Max.x + 1) { ImVec2 start(tk.PixelPos - 0.5f * tk.LabelSize.x, datum); DrawList.AddText(start, ax.ColorTxt, tkr.GetText(j)); } } } } // render y axis button, label, tick labels for (int i = 0; i < IMPLOT_NUM_Y_AXES; i++) { ImPlotAxis& ax = plot.YAxis(i); if (!ax.Enabled) continue; if ((ax.Hovered || ax.Held) && !plot.Held && !ImHasFlag(ax.Flags, ImPlotAxisFlags_NoHighlight)) DrawList.AddRectFilled(ax.HoverRect.Min, ax.HoverRect.Max, ax.Held ? ax.ColorAct : ax.ColorHov); else if (ax.ColorHiLi != IM_COL32_BLACK_TRANS) { DrawList.AddRectFilled(ax.HoverRect.Min, ax.HoverRect.Max, ax.ColorHiLi); ax.ColorHiLi = IM_COL32_BLACK_TRANS; } else if (ax.ColorBg != IM_COL32_BLACK_TRANS) { DrawList.AddRectFilled(ax.HoverRect.Min, ax.HoverRect.Max, ax.ColorBg); } const ImPlotTicker& tkr = ax.Ticker; const bool opp = ax.IsOpposite(); if (ax.HasLabel()) { const char* label = plot.GetAxisLabel(ax); const ImVec2 label_size = CalcTextSizeVertical(label); const float label_offset = (ax.HasTickLabels() ? tkr.MaxSize.x + gp.Style.LabelPadding.x : 0.0f) + gp.Style.LabelPadding.x; const ImVec2 label_pos(opp ? ax.Datum1 + label_offset : ax.Datum1 - label_offset - label_size.x, plot.PlotRect.GetCenter().y + label_size.y * 0.5f); AddTextVertical(&DrawList, label_pos, ax.ColorTxt, label); } if (ax.HasTickLabels()) { for (int j = 0; j < tkr.TickCount(); ++j) { const ImPlotTick& tk = tkr.Ticks[j]; const float datum = ax.Datum1 + (opp ? gp.Style.LabelPadding.x : (-gp.Style.LabelPadding.x - tk.LabelSize.x)); if (tk.ShowLabel && tk.PixelPos >= plot.PlotRect.Min.y - 1 && tk.PixelPos <= plot.PlotRect.Max.y + 1) { ImVec2 start(datum, tk.PixelPos - 0.5f * tk.LabelSize.y); DrawList.AddText(start, ax.ColorTxt, tkr.GetText(j)); } } } } // clear legend (TODO: put elsewhere) plot.Items.Legend.Reset(); // push ID to set item hashes (NB: !!!THIS PROBABLY NEEDS TO BE IN BEGIN PLOT!!!!) ImGui::PushOverrideID(gp.CurrentItems->ID); } //----------------------------------------------------------------------------- // EndPlot() //----------------------------------------------------------------------------- void EndPlot() { IM_ASSERT_USER_ERROR(GImPlot != nullptr, "No current context. Did you call ImPlot::CreateContext() or ImPlot::SetCurrentContext()?"); ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr, "Mismatched BeginPlot()/EndPlot()!"); SetupLock(); ImGuiContext &G = *GImGui; ImPlotPlot &plot = *gp.CurrentPlot; ImGuiWindow * Window = G.CurrentWindow; ImDrawList & DrawList = *Window->DrawList; const ImGuiIO & IO = ImGui::GetIO(); // FINAL RENDER ----------------------------------------------------------- const bool render_border = gp.Style.PlotBorderSize > 0 && GetStyleColorVec4(ImPlotCol_PlotBorder).w > 0; const bool any_x_held = plot.Held || AnyAxesHeld(&plot.Axes[ImAxis_X1], IMPLOT_NUM_X_AXES); const bool any_y_held = plot.Held || AnyAxesHeld(&plot.Axes[ImAxis_Y1], IMPLOT_NUM_Y_AXES); ImGui::PushClipRect(plot.FrameRect.Min, plot.FrameRect.Max, true); // render grid (foreground) for (int i = 0; i < IMPLOT_NUM_X_AXES; i++) { ImPlotAxis& x_axis = plot.XAxis(i); if (x_axis.Enabled && x_axis.HasGridLines() && x_axis.IsForeground()) RenderGridLinesX(DrawList, x_axis.Ticker, plot.PlotRect, x_axis.ColorMaj, x_axis.ColorMin, gp.Style.MajorGridSize.x, gp.Style.MinorGridSize.x); } for (int i = 0; i < IMPLOT_NUM_Y_AXES; i++) { ImPlotAxis& y_axis = plot.YAxis(i); if (y_axis.Enabled && y_axis.HasGridLines() && y_axis.IsForeground()) RenderGridLinesY(DrawList, y_axis.Ticker, plot.PlotRect, y_axis.ColorMaj, y_axis.ColorMin, gp.Style.MajorGridSize.y, gp.Style.MinorGridSize.y); } // render title if (plot.HasTitle()) { ImU32 col = GetStyleColorU32(ImPlotCol_TitleText); AddTextCentered(&DrawList,ImVec2(plot.PlotRect.GetCenter().x, plot.CanvasRect.Min.y),col,plot.GetTitle()); } // render x ticks int count_B = 0, count_T = 0; for (int i = 0; i < IMPLOT_NUM_X_AXES; i++) { const ImPlotAxis& ax = plot.XAxis(i); if (!ax.Enabled) continue; const ImPlotTicker& tkr = ax.Ticker; const bool opp = ax.IsOpposite(); const bool aux = ((opp && count_T > 0)||(!opp && count_B > 0)); if (ax.HasTickMarks()) { const float direction = opp ? 1.0f : -1.0f; for (int j = 0; j < tkr.TickCount(); ++j) { const ImPlotTick& tk = tkr.Ticks[j]; if (tk.Level != 0 || tk.PixelPos < plot.PlotRect.Min.x || tk.PixelPos > plot.PlotRect.Max.x) continue; const ImVec2 start(tk.PixelPos, ax.Datum1); const float len = (!aux && tk.Major) ? gp.Style.MajorTickLen.x : gp.Style.MinorTickLen.x; const float thk = (!aux && tk.Major) ? gp.Style.MajorTickSize.x : gp.Style.MinorTickSize.x; DrawList.AddLine(start, start + ImVec2(0,direction*len), ax.ColorTick, thk); } if (aux || !render_border) DrawList.AddLine(ImVec2(plot.PlotRect.Min.x,ax.Datum1), ImVec2(plot.PlotRect.Max.x,ax.Datum1), ax.ColorTick, gp.Style.MinorTickSize.x); } count_B += !opp; count_T += opp; } // render y ticks int count_L = 0, count_R = 0; for (int i = 0; i < IMPLOT_NUM_Y_AXES; i++) { const ImPlotAxis& ax = plot.YAxis(i); if (!ax.Enabled) continue; const ImPlotTicker& tkr = ax.Ticker; const bool opp = ax.IsOpposite(); const bool aux = ((opp && count_R > 0)||(!opp && count_L > 0)); if (ax.HasTickMarks()) { const float direction = opp ? -1.0f : 1.0f; for (int j = 0; j < tkr.TickCount(); ++j) { const ImPlotTick& tk = tkr.Ticks[j]; if (tk.Level != 0 || tk.PixelPos < plot.PlotRect.Min.y || tk.PixelPos > plot.PlotRect.Max.y) continue; const ImVec2 start(ax.Datum1, tk.PixelPos); const float len = (!aux && tk.Major) ? gp.Style.MajorTickLen.y : gp.Style.MinorTickLen.y; const float thk = (!aux && tk.Major) ? gp.Style.MajorTickSize.y : gp.Style.MinorTickSize.y; DrawList.AddLine(start, start + ImVec2(direction*len,0), ax.ColorTick, thk); } if (aux || !render_border) DrawList.AddLine(ImVec2(ax.Datum1, plot.PlotRect.Min.y), ImVec2(ax.Datum1, plot.PlotRect.Max.y), ax.ColorTick, gp.Style.MinorTickSize.y); } count_L += !opp; count_R += opp; } ImGui::PopClipRect(); // render annotations PushPlotClipRect(); for (int i = 0; i < gp.Annotations.Size; ++i) { const char* txt = gp.Annotations.GetText(i); ImPlotAnnotation& an = gp.Annotations.Annotations[i]; const ImVec2 txt_size = ImGui::CalcTextSize(txt); const ImVec2 size = txt_size + gp.Style.AnnotationPadding * 2; ImVec2 pos = an.Pos; if (an.Offset.x == 0) pos.x -= size.x / 2; else if (an.Offset.x > 0) pos.x += an.Offset.x; else pos.x -= size.x - an.Offset.x; if (an.Offset.y == 0) pos.y -= size.y / 2; else if (an.Offset.y > 0) pos.y += an.Offset.y; else pos.y -= size.y - an.Offset.y; if (an.Clamp) pos = ClampLabelPos(pos, size, plot.PlotRect.Min, plot.PlotRect.Max); ImRect rect(pos,pos+size); if (an.Offset.x != 0 || an.Offset.y != 0) { ImVec2 corners[4] = {rect.GetTL(), rect.GetTR(), rect.GetBR(), rect.GetBL()}; int min_corner = 0; float min_len = FLT_MAX; for (int c = 0; c < 4; ++c) { float len = ImLengthSqr(an.Pos - corners[c]); if (len < min_len) { min_corner = c; min_len = len; } } DrawList.AddLine(an.Pos, corners[min_corner], an.ColorBg); } DrawList.AddRectFilled(rect.Min, rect.Max, an.ColorBg); DrawList.AddText(pos + gp.Style.AnnotationPadding, an.ColorFg, txt); } // render selection if (plot.Selected) RenderSelectionRect(DrawList, plot.SelectRect.Min + plot.PlotRect.Min, plot.SelectRect.Max + plot.PlotRect.Min, GetStyleColorVec4(ImPlotCol_Selection)); // render crosshairs if (ImHasFlag(plot.Flags, ImPlotFlags_Crosshairs) && plot.Hovered && !(any_x_held || any_y_held) && !plot.Selecting && !plot.Items.Legend.Hovered) { ImGui::SetMouseCursor(ImGuiMouseCursor_None); ImVec2 xy = IO.MousePos; ImVec2 h1(plot.PlotRect.Min.x, xy.y); ImVec2 h2(xy.x - 5, xy.y); ImVec2 h3(xy.x + 5, xy.y); ImVec2 h4(plot.PlotRect.Max.x, xy.y); ImVec2 v1(xy.x, plot.PlotRect.Min.y); ImVec2 v2(xy.x, xy.y - 5); ImVec2 v3(xy.x, xy.y + 5); ImVec2 v4(xy.x, plot.PlotRect.Max.y); ImU32 col = GetStyleColorU32(ImPlotCol_Crosshairs); DrawList.AddLine(h1, h2, col); DrawList.AddLine(h3, h4, col); DrawList.AddLine(v1, v2, col); DrawList.AddLine(v3, v4, col); } // render mouse pos if (!ImHasFlag(plot.Flags, ImPlotFlags_NoMouseText) && (plot.Hovered || ImHasFlag(plot.MouseTextFlags, ImPlotMouseTextFlags_ShowAlways))) { const bool no_aux = ImHasFlag(plot.MouseTextFlags, ImPlotMouseTextFlags_NoAuxAxes); const bool no_fmt = ImHasFlag(plot.MouseTextFlags, ImPlotMouseTextFlags_NoFormat); ImGuiTextBuffer& builder = gp.MousePosStringBuilder; builder.Buf.shrink(0); char buff[IMPLOT_LABEL_MAX_SIZE]; const int num_x = no_aux ? 1 : IMPLOT_NUM_X_AXES; for (int i = 0; i < num_x; ++i) { ImPlotAxis& x_axis = plot.XAxis(i); if (!x_axis.Enabled) continue; if (i > 0) builder.append(", ("); double v = x_axis.PixelsToPlot(IO.MousePos.x); if (no_fmt) Formatter_Default(v,buff,IMPLOT_LABEL_MAX_SIZE,(void*)IMPLOT_LABEL_FORMAT); else LabelAxisValue(x_axis,v,buff,IMPLOT_LABEL_MAX_SIZE,true); builder.append(buff); if (i > 0) builder.append(")"); } builder.append(", "); const int num_y = no_aux ? 1 : IMPLOT_NUM_Y_AXES; for (int i = 0; i < num_y; ++i) { ImPlotAxis& y_axis = plot.YAxis(i); if (!y_axis.Enabled) continue; if (i > 0) builder.append(", ("); double v = y_axis.PixelsToPlot(IO.MousePos.y); if (no_fmt) Formatter_Default(v,buff,IMPLOT_LABEL_MAX_SIZE,(void*)IMPLOT_LABEL_FORMAT); else LabelAxisValue(y_axis,v,buff,IMPLOT_LABEL_MAX_SIZE,true); builder.append(buff); if (i > 0) builder.append(")"); } if (!builder.empty()) { const ImVec2 size = ImGui::CalcTextSize(builder.c_str()); const ImVec2 pos = GetLocationPos(plot.PlotRect, size, plot.MouseTextLocation, gp.Style.MousePosPadding); DrawList.AddText(pos, GetStyleColorU32(ImPlotCol_InlayText), builder.c_str()); } } PopPlotClipRect(); // axis side switch if (!plot.Held) { ImVec2 mouse_pos = ImGui::GetIO().MousePos; ImRect trigger_rect = plot.PlotRect; trigger_rect.Expand(-10); for (int i = 0; i < IMPLOT_NUM_X_AXES; ++i) { ImPlotAxis& x_axis = plot.XAxis(i); if (ImHasFlag(x_axis.Flags, ImPlotAxisFlags_NoSideSwitch)) continue; if (x_axis.Held && plot.PlotRect.Contains(mouse_pos)) { const bool opp = ImHasFlag(x_axis.Flags, ImPlotAxisFlags_Opposite); if (!opp) { ImRect rect(plot.PlotRect.Min.x - 5, plot.PlotRect.Min.y - 5, plot.PlotRect.Max.x + 5, plot.PlotRect.Min.y + 5); if (mouse_pos.y < plot.PlotRect.Max.y - 10) DrawList.AddRectFilled(rect.Min, rect.Max, x_axis.ColorHov); if (rect.Contains(mouse_pos)) x_axis.Flags |= ImPlotAxisFlags_Opposite; } else { ImRect rect(plot.PlotRect.Min.x - 5, plot.PlotRect.Max.y - 5, plot.PlotRect.Max.x + 5, plot.PlotRect.Max.y + 5); if (mouse_pos.y > plot.PlotRect.Min.y + 10) DrawList.AddRectFilled(rect.Min, rect.Max, x_axis.ColorHov); if (rect.Contains(mouse_pos)) x_axis.Flags &= ~ImPlotAxisFlags_Opposite; } } } for (int i = 0; i < IMPLOT_NUM_Y_AXES; ++i) { ImPlotAxis& y_axis = plot.YAxis(i); if (ImHasFlag(y_axis.Flags, ImPlotAxisFlags_NoSideSwitch)) continue; if (y_axis.Held && plot.PlotRect.Contains(mouse_pos)) { const bool opp = ImHasFlag(y_axis.Flags, ImPlotAxisFlags_Opposite); if (!opp) { ImRect rect(plot.PlotRect.Max.x - 5, plot.PlotRect.Min.y - 5, plot.PlotRect.Max.x + 5, plot.PlotRect.Max.y + 5); if (mouse_pos.x > plot.PlotRect.Min.x + 10) DrawList.AddRectFilled(rect.Min, rect.Max, y_axis.ColorHov); if (rect.Contains(mouse_pos)) y_axis.Flags |= ImPlotAxisFlags_Opposite; } else { ImRect rect(plot.PlotRect.Min.x - 5, plot.PlotRect.Min.y - 5, plot.PlotRect.Min.x + 5, plot.PlotRect.Max.y + 5); if (mouse_pos.x < plot.PlotRect.Max.x - 10) DrawList.AddRectFilled(rect.Min, rect.Max, y_axis.ColorHov); if (rect.Contains(mouse_pos)) y_axis.Flags &= ~ImPlotAxisFlags_Opposite; } } } } // reset legend hovers plot.Items.Legend.Hovered = false; for (int i = 0; i < plot.Items.GetItemCount(); ++i) plot.Items.GetItemByIndex(i)->LegendHovered = false; // render legend if (!ImHasFlag(plot.Flags, ImPlotFlags_NoLegend) && plot.Items.GetLegendCount() > 0) { ImPlotLegend& legend = plot.Items.Legend; const bool legend_out = ImHasFlag(legend.Flags, ImPlotLegendFlags_Outside); const bool legend_horz = ImHasFlag(legend.Flags, ImPlotLegendFlags_Horizontal); const ImVec2 legend_size = CalcLegendSize(plot.Items, gp.Style.LegendInnerPadding, gp.Style.LegendSpacing, !legend_horz); const ImVec2 legend_pos = GetLocationPos(legend_out ? plot.FrameRect : plot.PlotRect, legend_size, legend.Location, legend_out ? gp.Style.PlotPadding : gp.Style.LegendPadding); legend.Rect = ImRect(legend_pos, legend_pos + legend_size); // test hover legend.Hovered = ImGui::IsWindowHovered() && legend.Rect.Contains(IO.MousePos); if (legend_out) ImGui::PushClipRect(plot.FrameRect.Min, plot.FrameRect.Max, true); else PushPlotClipRect(); ImU32 col_bg = GetStyleColorU32(ImPlotCol_LegendBg); ImU32 col_bd = GetStyleColorU32(ImPlotCol_LegendBorder); DrawList.AddRectFilled(legend.Rect.Min, legend.Rect.Max, col_bg); DrawList.AddRect(legend.Rect.Min, legend.Rect.Max, col_bd); bool legend_contextable = ShowLegendEntries(plot.Items, legend.Rect, legend.Hovered, gp.Style.LegendInnerPadding, gp.Style.LegendSpacing, !legend_horz, DrawList) && !ImHasFlag(legend.Flags, ImPlotLegendFlags_NoMenus); // main ctx menu if (gp.OpenContextThisFrame && legend_contextable && !ImHasFlag(plot.Flags, ImPlotFlags_NoMenus)) ImGui::OpenPopup("##LegendContext"); ImGui::PopClipRect(); if (ImGui::BeginPopup("##LegendContext")) { ImGui::Text("Legend"); ImGui::Separator(); if (ShowLegendContextMenu(legend, !ImHasFlag(plot.Flags, ImPlotFlags_NoLegend))) ImFlipFlag(plot.Flags, ImPlotFlags_NoLegend); ImGui::EndPopup(); } } else { plot.Items.Legend.Rect = ImRect(); } // render border if (render_border) DrawList.AddRect(plot.PlotRect.Min, plot.PlotRect.Max, GetStyleColorU32(ImPlotCol_PlotBorder), 0, ImDrawFlags_RoundCornersAll, gp.Style.PlotBorderSize); // render tags for (int i = 0; i < gp.Tags.Size; ++i) { ImPlotTag& tag = gp.Tags.Tags[i]; ImPlotAxis& axis = plot.Axes[tag.Axis]; if (!axis.Enabled || !axis.Range.Contains(tag.Value)) continue; const char* txt = gp.Tags.GetText(i); ImVec2 text_size = ImGui::CalcTextSize(txt); ImVec2 size = text_size + gp.Style.AnnotationPadding * 2; ImVec2 pos; axis.Ticker.OverrideSizeLate(size); float pix = IM_ROUND(axis.PlotToPixels(tag.Value)); if (axis.Vertical) { if (axis.IsOpposite()) { pos = ImVec2(axis.Datum1 + gp.Style.LabelPadding.x, pix - size.y * 0.5f); DrawList.AddTriangleFilled(ImVec2(axis.Datum1,pix), pos, pos + ImVec2(0,size.y), tag.ColorBg); } else { pos = ImVec2(axis.Datum1 - size.x - gp.Style.LabelPadding.x, pix - size.y * 0.5f); DrawList.AddTriangleFilled(pos + ImVec2(size.x,0), ImVec2(axis.Datum1,pix), pos+size, tag.ColorBg); } } else { if (axis.IsOpposite()) { pos = ImVec2(pix - size.x * 0.5f, axis.Datum1 - size.y - gp.Style.LabelPadding.y ); DrawList.AddTriangleFilled(pos + ImVec2(0,size.y), pos + size, ImVec2(pix,axis.Datum1), tag.ColorBg); } else { pos = ImVec2(pix - size.x * 0.5f, axis.Datum1 + gp.Style.LabelPadding.y); DrawList.AddTriangleFilled(pos, ImVec2(pix,axis.Datum1), pos + ImVec2(size.x, 0), tag.ColorBg); } } DrawList.AddRectFilled(pos,pos+size,tag.ColorBg); DrawList.AddText(pos+gp.Style.AnnotationPadding,tag.ColorFg,txt); } // FIT DATA -------------------------------------------------------------- const bool axis_equal = ImHasFlag(plot.Flags, ImPlotFlags_Equal); if (plot.FitThisFrame) { for (int i = 0; i < IMPLOT_NUM_X_AXES; i++) { ImPlotAxis& x_axis = plot.XAxis(i); if (x_axis.FitThisFrame) { x_axis.ApplyFit(gp.Style.FitPadding.x); if (axis_equal && x_axis.OrthoAxis != nullptr) { double aspect = x_axis.GetAspect(); ImPlotAxis& y_axis = *x_axis.OrthoAxis; if (y_axis.FitThisFrame) { y_axis.ApplyFit(gp.Style.FitPadding.y); y_axis.FitThisFrame = false; aspect = ImMax(aspect, y_axis.GetAspect()); } x_axis.SetAspect(aspect); y_axis.SetAspect(aspect); } } } for (int i = 0; i < IMPLOT_NUM_Y_AXES; i++) { ImPlotAxis& y_axis = plot.YAxis(i); if (y_axis.FitThisFrame) { y_axis.ApplyFit(gp.Style.FitPadding.y); if (axis_equal && y_axis.OrthoAxis != nullptr) { double aspect = y_axis.GetAspect(); ImPlotAxis& x_axis = *y_axis.OrthoAxis; if (x_axis.FitThisFrame) { x_axis.ApplyFit(gp.Style.FitPadding.x); x_axis.FitThisFrame = false; aspect = ImMax(x_axis.GetAspect(), aspect); } x_axis.SetAspect(aspect); y_axis.SetAspect(aspect); } } } plot.FitThisFrame = false; } // CONTEXT MENUS ----------------------------------------------------------- ImGui::PushOverrideID(plot.ID); const bool can_ctx = gp.OpenContextThisFrame && !ImHasFlag(plot.Flags, ImPlotFlags_NoMenus) && !plot.Items.Legend.Hovered; // main ctx menu if (can_ctx && plot.Hovered) ImGui::OpenPopup("##PlotContext"); if (ImGui::BeginPopup("##PlotContext")) { ShowPlotContextMenu(plot); ImGui::EndPopup(); } // axes ctx menus for (int i = 0; i < IMPLOT_NUM_X_AXES; ++i) { ImGui::PushID(i); ImPlotAxis& x_axis = plot.XAxis(i); if (can_ctx && x_axis.Hovered && x_axis.HasMenus()) ImGui::OpenPopup("##XContext"); if (ImGui::BeginPopup("##XContext")) { ImGui::Text(x_axis.HasLabel() ? plot.GetAxisLabel(x_axis) : i == 0 ? "X-Axis" : "X-Axis %d", i + 1); ImGui::Separator(); ShowAxisContextMenu(x_axis, axis_equal ? x_axis.OrthoAxis : nullptr, true); ImGui::EndPopup(); } ImGui::PopID(); } for (int i = 0; i < IMPLOT_NUM_Y_AXES; ++i) { ImGui::PushID(i); ImPlotAxis& y_axis = plot.YAxis(i); if (can_ctx && y_axis.Hovered && y_axis.HasMenus()) ImGui::OpenPopup("##YContext"); if (ImGui::BeginPopup("##YContext")) { ImGui::Text(y_axis.HasLabel() ? plot.GetAxisLabel(y_axis) : i == 0 ? "Y-Axis" : "Y-Axis %d", i + 1); ImGui::Separator(); ShowAxisContextMenu(y_axis, axis_equal ? y_axis.OrthoAxis : nullptr, false); ImGui::EndPopup(); } ImGui::PopID(); } ImGui::PopID(); // LINKED AXES ------------------------------------------------------------ for (int i = 0; i < ImAxis_COUNT; ++i) plot.Axes[i].PushLinks(); // CLEANUP ---------------------------------------------------------------- // remove items if (gp.CurrentItems == &plot.Items) gp.CurrentItems = nullptr; // reset the plot items for the next frame for (int i = 0; i < plot.Items.GetItemCount(); ++i) { plot.Items.GetItemByIndex(i)->SeenThisFrame = false; } // mark the plot as initialized, i.e. having made it through one frame completely plot.Initialized = true; // Pop ImGui::PushID at the end of BeginPlot ImGui::PopID(); // Reset context for next plot ResetCtxForNextPlot(GImPlot); // setup next subplot if (gp.CurrentSubplot != nullptr) { ImGui::PopID(); SubplotNextCell(); } } //----------------------------------------------------------------------------- // BEGIN/END SUBPLOT //----------------------------------------------------------------------------- static const float SUBPLOT_BORDER_SIZE = 1.0f; static const float SUBPLOT_SPLITTER_HALF_THICKNESS = 4.0f; static const float SUBPLOT_SPLITTER_FEEDBACK_TIMER = 0.06f; void SubplotSetCell(int row, int col) { ImPlotContext& gp = *GImPlot; ImPlotSubplot& subplot = *gp.CurrentSubplot; if (row >= subplot.Rows || col >= subplot.Cols) return; float xoff = 0; float yoff = 0; for (int c = 0; c < col; ++c) xoff += subplot.ColRatios[c]; for (int r = 0; r < row; ++r) yoff += subplot.RowRatios[r]; const ImVec2 grid_size = subplot.GridRect.GetSize(); ImVec2 cpos = subplot.GridRect.Min + ImVec2(xoff*grid_size.x,yoff*grid_size.y); cpos.x = IM_ROUND(cpos.x); cpos.y = IM_ROUND(cpos.y); ImGui::GetCurrentWindow()->DC.CursorPos = cpos; // set cell size subplot.CellSize.x = IM_ROUND(subplot.GridRect.GetWidth() * subplot.ColRatios[col]); subplot.CellSize.y = IM_ROUND(subplot.GridRect.GetHeight() * subplot.RowRatios[row]); // setup links const bool lx = ImHasFlag(subplot.Flags, ImPlotSubplotFlags_LinkAllX); const bool ly = ImHasFlag(subplot.Flags, ImPlotSubplotFlags_LinkAllY); const bool lr = ImHasFlag(subplot.Flags, ImPlotSubplotFlags_LinkRows); const bool lc = ImHasFlag(subplot.Flags, ImPlotSubplotFlags_LinkCols); SetNextAxisLinks(ImAxis_X1, lx ? &subplot.ColLinkData[0].Min : lc ? &subplot.ColLinkData[col].Min : nullptr, lx ? &subplot.ColLinkData[0].Max : lc ? &subplot.ColLinkData[col].Max : nullptr); SetNextAxisLinks(ImAxis_Y1, ly ? &subplot.RowLinkData[0].Min : lr ? &subplot.RowLinkData[row].Min : nullptr, ly ? &subplot.RowLinkData[0].Max : lr ? &subplot.RowLinkData[row].Max : nullptr); // setup alignment if (!ImHasFlag(subplot.Flags, ImPlotSubplotFlags_NoAlign)) { gp.CurrentAlignmentH = &subplot.RowAlignmentData[row]; gp.CurrentAlignmentV = &subplot.ColAlignmentData[col]; } // set idx if (ImHasFlag(subplot.Flags, ImPlotSubplotFlags_ColMajor)) subplot.CurrentIdx = col * subplot.Rows + row; else subplot.CurrentIdx = row * subplot.Cols + col; } void SubplotSetCell(int idx) { ImPlotContext& gp = *GImPlot; ImPlotSubplot& subplot = *gp.CurrentSubplot; if (idx >= subplot.Rows * subplot.Cols) return; int row = 0, col = 0; if (ImHasFlag(subplot.Flags, ImPlotSubplotFlags_ColMajor)) { row = idx % subplot.Rows; col = idx / subplot.Rows; } else { row = idx / subplot.Cols; col = idx % subplot.Cols; } return SubplotSetCell(row, col); } void SubplotNextCell() { ImPlotContext& gp = *GImPlot; ImPlotSubplot& subplot = *gp.CurrentSubplot; SubplotSetCell(++subplot.CurrentIdx); } bool BeginSubplots(const char* title, int rows, int cols, const ImVec2& size, ImPlotSubplotFlags flags, float* row_sizes, float* col_sizes) { IM_ASSERT_USER_ERROR(rows > 0 && cols > 0, "Invalid sizing arguments!"); IM_ASSERT_USER_ERROR(GImPlot != nullptr, "No current context. Did you call ImPlot::CreateContext() or ImPlot::SetCurrentContext()?"); ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentSubplot == nullptr, "Mismatched BeginSubplots()/EndSubplots()!"); ImGuiContext &G = *GImGui; ImGuiWindow * Window = G.CurrentWindow; if (Window->SkipItems) return false; const ImGuiID ID = Window->GetID(title); bool just_created = gp.Subplots.GetByKey(ID) == nullptr; gp.CurrentSubplot = gp.Subplots.GetOrAddByKey(ID); ImPlotSubplot& subplot = *gp.CurrentSubplot; subplot.ID = ID; subplot.Items.ID = ID - 1; subplot.HasTitle = ImGui::FindRenderedTextEnd(title, nullptr) != title; // push ID ImGui::PushID(ID); if (just_created) subplot.Flags = flags; else if (flags != subplot.PreviousFlags) subplot.Flags = flags; subplot.PreviousFlags = flags; // check for change in rows and cols if (subplot.Rows != rows || subplot.Cols != cols) { subplot.RowAlignmentData.resize(rows); subplot.RowLinkData.resize(rows); subplot.RowRatios.resize(rows); for (int r = 0; r < rows; ++r) { subplot.RowAlignmentData[r].Reset(); subplot.RowLinkData[r] = ImPlotRange(0,1); subplot.RowRatios[r] = 1.0f / rows; } subplot.ColAlignmentData.resize(cols); subplot.ColLinkData.resize(cols); subplot.ColRatios.resize(cols); for (int c = 0; c < cols; ++c) { subplot.ColAlignmentData[c].Reset(); subplot.ColLinkData[c] = ImPlotRange(0,1); subplot.ColRatios[c] = 1.0f / cols; } } // check incoming size requests float row_sum = 0, col_sum = 0; if (row_sizes != nullptr) { row_sum = ImSum(row_sizes, rows); for (int r = 0; r < rows; ++r) subplot.RowRatios[r] = row_sizes[r] / row_sum; } if (col_sizes != nullptr) { col_sum = ImSum(col_sizes, cols); for (int c = 0; c < cols; ++c) subplot.ColRatios[c] = col_sizes[c] / col_sum; } subplot.Rows = rows; subplot.Cols = cols; // calc plot frame sizes ImVec2 title_size(0.0f, 0.0f); if (!ImHasFlag(subplot.Flags, ImPlotSubplotFlags_NoTitle)) title_size = ImGui::CalcTextSize(title, nullptr, true); const float pad_top = title_size.x > 0.0f ? title_size.y + gp.Style.LabelPadding.y : 0; const ImVec2 half_pad = gp.Style.PlotPadding/2; const ImVec2 frame_size = ImGui::CalcItemSize(size, gp.Style.PlotDefaultSize.x, gp.Style.PlotDefaultSize.y); subplot.FrameRect = ImRect(Window->DC.CursorPos, Window->DC.CursorPos + frame_size); subplot.GridRect.Min = subplot.FrameRect.Min + half_pad + ImVec2(0,pad_top); subplot.GridRect.Max = subplot.FrameRect.Max - half_pad; subplot.FrameHovered = subplot.FrameRect.Contains(ImGui::GetMousePos()) && ImGui::IsWindowHovered(ImGuiHoveredFlags_ChildWindows|ImGuiHoveredFlags_AllowWhenBlockedByActiveItem); // outside legend adjustments (TODO: make function) const bool share_items = ImHasFlag(subplot.Flags, ImPlotSubplotFlags_ShareItems); if (share_items) gp.CurrentItems = &subplot.Items; if (share_items && !ImHasFlag(subplot.Flags, ImPlotSubplotFlags_NoLegend) && subplot.Items.GetLegendCount() > 0) { ImPlotLegend& legend = subplot.Items.Legend; const bool horz = ImHasFlag(legend.Flags, ImPlotLegendFlags_Horizontal); const ImVec2 legend_size = CalcLegendSize(subplot.Items, gp.Style.LegendInnerPadding, gp.Style.LegendSpacing, !horz); const bool west = ImHasFlag(legend.Location, ImPlotLocation_West) && !ImHasFlag(legend.Location, ImPlotLocation_East); const bool east = ImHasFlag(legend.Location, ImPlotLocation_East) && !ImHasFlag(legend.Location, ImPlotLocation_West); const bool north = ImHasFlag(legend.Location, ImPlotLocation_North) && !ImHasFlag(legend.Location, ImPlotLocation_South); const bool south = ImHasFlag(legend.Location, ImPlotLocation_South) && !ImHasFlag(legend.Location, ImPlotLocation_North); if ((west && !horz) || (west && horz && !north && !south)) subplot.GridRect.Min.x += (legend_size.x + gp.Style.LegendPadding.x); if ((east && !horz) || (east && horz && !north && !south)) subplot.GridRect.Max.x -= (legend_size.x + gp.Style.LegendPadding.x); if ((north && horz) || (north && !horz && !west && !east)) subplot.GridRect.Min.y += (legend_size.y + gp.Style.LegendPadding.y); if ((south && horz) || (south && !horz && !west && !east)) subplot.GridRect.Max.y -= (legend_size.y + gp.Style.LegendPadding.y); } // render single background frame ImGui::RenderFrame(subplot.FrameRect.Min, subplot.FrameRect.Max, GetStyleColorU32(ImPlotCol_FrameBg), true, ImGui::GetStyle().FrameRounding); // render title if (title_size.x > 0.0f && !ImHasFlag(subplot.Flags, ImPlotFlags_NoTitle)) { const ImU32 col = GetStyleColorU32(ImPlotCol_TitleText); AddTextCentered(ImGui::GetWindowDrawList(),ImVec2(subplot.GridRect.GetCenter().x, subplot.GridRect.Min.y - pad_top + half_pad.y),col,title); } // render splitters if (!ImHasFlag(subplot.Flags, ImPlotSubplotFlags_NoResize)) { ImDrawList& DrawList = *ImGui::GetWindowDrawList(); const ImU32 hov_col = ImGui::ColorConvertFloat4ToU32(GImGui->Style.Colors[ImGuiCol_SeparatorHovered]); const ImU32 act_col = ImGui::ColorConvertFloat4ToU32(GImGui->Style.Colors[ImGuiCol_SeparatorActive]); float xpos = subplot.GridRect.Min.x; float ypos = subplot.GridRect.Min.y; int separator = 1; // bool pass = false; for (int r = 0; r < subplot.Rows-1; ++r) { ypos += subplot.RowRatios[r] * subplot.GridRect.GetHeight(); const ImGuiID sep_id = subplot.ID + separator; ImGui::KeepAliveID(sep_id); const ImRect sep_bb = ImRect(subplot.GridRect.Min.x, ypos-SUBPLOT_SPLITTER_HALF_THICKNESS, subplot.GridRect.Max.x, ypos+SUBPLOT_SPLITTER_HALF_THICKNESS); bool sep_hov = false, sep_hld = false; const bool sep_clk = ImGui::ButtonBehavior(sep_bb, sep_id, &sep_hov, &sep_hld, ImGuiButtonFlags_FlattenChildren | ImGuiButtonFlags_PressedOnClick | ImGuiButtonFlags_PressedOnDoubleClick); if ((sep_hov && G.HoveredIdTimer > SUBPLOT_SPLITTER_FEEDBACK_TIMER) || sep_hld) { if (sep_clk && ImGui::IsMouseDoubleClicked(0)) { float p = (subplot.RowRatios[r] + subplot.RowRatios[r+1])/2; subplot.RowRatios[r] = subplot.RowRatios[r+1] = p; } if (sep_clk) { subplot.TempSizes[0] = subplot.RowRatios[r]; subplot.TempSizes[1] = subplot.RowRatios[r+1]; } if (sep_hld) { float dp = ImGui::GetMouseDragDelta(0).y / subplot.GridRect.GetHeight(); if (subplot.TempSizes[0] + dp > 0.1f && subplot.TempSizes[1] - dp > 0.1f) { subplot.RowRatios[r] = subplot.TempSizes[0] + dp; subplot.RowRatios[r+1] = subplot.TempSizes[1] - dp; } } DrawList.AddLine(ImVec2(IM_ROUND(subplot.GridRect.Min.x),IM_ROUND(ypos)), ImVec2(IM_ROUND(subplot.GridRect.Max.x),IM_ROUND(ypos)), sep_hld ? act_col : hov_col, SUBPLOT_BORDER_SIZE); ImGui::SetMouseCursor(ImGuiMouseCursor_ResizeNS); } separator++; } for (int c = 0; c < subplot.Cols-1; ++c) { xpos += subplot.ColRatios[c] * subplot.GridRect.GetWidth(); const ImGuiID sep_id = subplot.ID + separator; ImGui::KeepAliveID(sep_id); const ImRect sep_bb = ImRect(xpos-SUBPLOT_SPLITTER_HALF_THICKNESS, subplot.GridRect.Min.y, xpos+SUBPLOT_SPLITTER_HALF_THICKNESS, subplot.GridRect.Max.y); bool sep_hov = false, sep_hld = false; const bool sep_clk = ImGui::ButtonBehavior(sep_bb, sep_id, &sep_hov, &sep_hld, ImGuiButtonFlags_FlattenChildren | ImGuiButtonFlags_PressedOnClick | ImGuiButtonFlags_PressedOnDoubleClick); if ((sep_hov && G.HoveredIdTimer > SUBPLOT_SPLITTER_FEEDBACK_TIMER) || sep_hld) { if (sep_clk && ImGui::IsMouseDoubleClicked(0)) { float p = (subplot.ColRatios[c] + subplot.ColRatios[c+1])/2; subplot.ColRatios[c] = subplot.ColRatios[c+1] = p; } if (sep_clk) { subplot.TempSizes[0] = subplot.ColRatios[c]; subplot.TempSizes[1] = subplot.ColRatios[c+1]; } if (sep_hld) { float dp = ImGui::GetMouseDragDelta(0).x / subplot.GridRect.GetWidth(); if (subplot.TempSizes[0] + dp > 0.1f && subplot.TempSizes[1] - dp > 0.1f) { subplot.ColRatios[c] = subplot.TempSizes[0] + dp; subplot.ColRatios[c+1] = subplot.TempSizes[1] - dp; } } DrawList.AddLine(ImVec2(IM_ROUND(xpos),IM_ROUND(subplot.GridRect.Min.y)), ImVec2(IM_ROUND(xpos),IM_ROUND(subplot.GridRect.Max.y)), sep_hld ? act_col : hov_col, SUBPLOT_BORDER_SIZE); ImGui::SetMouseCursor(ImGuiMouseCursor_ResizeEW); } separator++; } } // set outgoing sizes if (row_sizes != nullptr) { for (int r = 0; r < rows; ++r) row_sizes[r] = subplot.RowRatios[r] * row_sum; } if (col_sizes != nullptr) { for (int c = 0; c < cols; ++c) col_sizes[c] = subplot.ColRatios[c] * col_sum; } // push styling PushStyleColor(ImPlotCol_FrameBg, IM_COL32_BLACK_TRANS); PushStyleVar(ImPlotStyleVar_PlotPadding, half_pad); PushStyleVar(ImPlotStyleVar_PlotMinSize, ImVec2(0,0)); ImGui::PushStyleVar(ImGuiStyleVar_FrameBorderSize,0); // set initial cursor pos Window->DC.CursorPos = subplot.GridRect.Min; // begin alignments for (int r = 0; r < subplot.Rows; ++r) subplot.RowAlignmentData[r].Begin(); for (int c = 0; c < subplot.Cols; ++c) subplot.ColAlignmentData[c].Begin(); // clear legend data subplot.Items.Legend.Reset(); // Setup first subplot SubplotSetCell(0,0); return true; } void EndSubplots() { IM_ASSERT_USER_ERROR(GImPlot != nullptr, "No current context. Did you call ImPlot::CreateContext() or ImPlot::SetCurrentContext()?"); ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentSubplot != nullptr, "Mismatched BeginSubplots()/EndSubplots()!"); ImPlotSubplot& subplot = *gp.CurrentSubplot; // set alignments for (int r = 0; r < subplot.Rows; ++r) subplot.RowAlignmentData[r].End(); for (int c = 0; c < subplot.Cols; ++c) subplot.ColAlignmentData[c].End(); // pop styling PopStyleColor(); PopStyleVar(); PopStyleVar(); ImGui::PopStyleVar(); // legend subplot.Items.Legend.Hovered = false; for (int i = 0; i < subplot.Items.GetItemCount(); ++i) subplot.Items.GetItemByIndex(i)->LegendHovered = false; // render legend const bool share_items = ImHasFlag(subplot.Flags, ImPlotSubplotFlags_ShareItems); ImDrawList& DrawList = *ImGui::GetWindowDrawList(); if (share_items && !ImHasFlag(subplot.Flags, ImPlotSubplotFlags_NoLegend) && subplot.Items.GetLegendCount() > 0) { const bool legend_horz = ImHasFlag(subplot.Items.Legend.Flags, ImPlotLegendFlags_Horizontal); const ImVec2 legend_size = CalcLegendSize(subplot.Items, gp.Style.LegendInnerPadding, gp.Style.LegendSpacing, !legend_horz); const ImVec2 legend_pos = GetLocationPos(subplot.FrameRect, legend_size, subplot.Items.Legend.Location, gp.Style.PlotPadding); subplot.Items.Legend.Rect = ImRect(legend_pos, legend_pos + legend_size); subplot.Items.Legend.Hovered = subplot.FrameHovered && subplot.Items.Legend.Rect.Contains(ImGui::GetIO().MousePos); ImGui::PushClipRect(subplot.FrameRect.Min, subplot.FrameRect.Max, true); ImU32 col_bg = GetStyleColorU32(ImPlotCol_LegendBg); ImU32 col_bd = GetStyleColorU32(ImPlotCol_LegendBorder); DrawList.AddRectFilled(subplot.Items.Legend.Rect.Min, subplot.Items.Legend.Rect.Max, col_bg); DrawList.AddRect(subplot.Items.Legend.Rect.Min, subplot.Items.Legend.Rect.Max, col_bd); bool legend_contextable = ShowLegendEntries(subplot.Items, subplot.Items.Legend.Rect, subplot.Items.Legend.Hovered, gp.Style.LegendInnerPadding, gp.Style.LegendSpacing, !legend_horz, DrawList) && !ImHasFlag(subplot.Items.Legend.Flags, ImPlotLegendFlags_NoMenus); if (legend_contextable && !ImHasFlag(subplot.Flags, ImPlotSubplotFlags_NoMenus) && ImGui::GetIO().MouseReleased[gp.InputMap.Menu]) ImGui::OpenPopup("##LegendContext"); ImGui::PopClipRect(); if (ImGui::BeginPopup("##LegendContext")) { ImGui::Text("Legend"); ImGui::Separator(); if (ShowLegendContextMenu(subplot.Items.Legend, !ImHasFlag(subplot.Flags, ImPlotFlags_NoLegend))) ImFlipFlag(subplot.Flags, ImPlotFlags_NoLegend); ImGui::EndPopup(); } } else { subplot.Items.Legend.Rect = ImRect(); } // remove items if (gp.CurrentItems == &subplot.Items) gp.CurrentItems = nullptr; // reset the plot items for the next frame (TODO: put this elswhere) for (int i = 0; i < subplot.Items.GetItemCount(); ++i) { subplot.Items.GetItemByIndex(i)->SeenThisFrame = false; } // pop id ImGui::PopID(); // set DC back correctly GImGui->CurrentWindow->DC.CursorPos = subplot.FrameRect.Min; ImGui::Dummy(subplot.FrameRect.GetSize()); ResetCtxForNextSubplot(GImPlot); } //----------------------------------------------------------------------------- // [SECTION] Plot Utils //----------------------------------------------------------------------------- void SetAxis(ImAxis axis) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr, "SetAxis() needs to be called between BeginPlot() and EndPlot()!"); IM_ASSERT_USER_ERROR(axis >= ImAxis_X1 && axis < ImAxis_COUNT, "Axis index out of bounds!"); IM_ASSERT_USER_ERROR(gp.CurrentPlot->Axes[axis].Enabled, "Axis is not enabled! Did you forget to call SetupAxis()?"); SetupLock(); if (axis < ImAxis_Y1) gp.CurrentPlot->CurrentX = axis; else gp.CurrentPlot->CurrentY = axis; } void SetAxes(ImAxis x_idx, ImAxis y_idx) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr, "SetAxes() needs to be called between BeginPlot() and EndPlot()!"); IM_ASSERT_USER_ERROR(x_idx >= ImAxis_X1 && x_idx < ImAxis_Y1, "X-Axis index out of bounds!"); IM_ASSERT_USER_ERROR(y_idx >= ImAxis_Y1 && y_idx < ImAxis_COUNT, "Y-Axis index out of bounds!"); IM_ASSERT_USER_ERROR(gp.CurrentPlot->Axes[x_idx].Enabled, "Axis is not enabled! Did you forget to call SetupAxis()?"); IM_ASSERT_USER_ERROR(gp.CurrentPlot->Axes[y_idx].Enabled, "Axis is not enabled! Did you forget to call SetupAxis()?"); SetupLock(); gp.CurrentPlot->CurrentX = x_idx; gp.CurrentPlot->CurrentY = y_idx; } ImPlotPoint PixelsToPlot(float x, float y, ImAxis x_idx, ImAxis y_idx) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr, "PixelsToPlot() needs to be called between BeginPlot() and EndPlot()!"); IM_ASSERT_USER_ERROR(x_idx == IMPLOT_AUTO || (x_idx >= ImAxis_X1 && x_idx < ImAxis_Y1), "X-Axis index out of bounds!"); IM_ASSERT_USER_ERROR(y_idx == IMPLOT_AUTO || (y_idx >= ImAxis_Y1 && y_idx < ImAxis_COUNT), "Y-Axis index out of bounds!"); SetupLock(); ImPlotPlot& plot = *gp.CurrentPlot; ImPlotAxis& x_axis = x_idx == IMPLOT_AUTO ? plot.Axes[plot.CurrentX] : plot.Axes[x_idx]; ImPlotAxis& y_axis = y_idx == IMPLOT_AUTO ? plot.Axes[plot.CurrentY] : plot.Axes[y_idx]; return ImPlotPoint( x_axis.PixelsToPlot(x), y_axis.PixelsToPlot(y) ); } ImPlotPoint PixelsToPlot(const ImVec2& pix, ImAxis x_idx, ImAxis y_idx) { return PixelsToPlot(pix.x, pix.y, x_idx, y_idx); } ImVec2 PlotToPixels(double x, double y, ImAxis x_idx, ImAxis y_idx) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr, "PlotToPixels() needs to be called between BeginPlot() and EndPlot()!"); IM_ASSERT_USER_ERROR(x_idx == IMPLOT_AUTO || (x_idx >= ImAxis_X1 && x_idx < ImAxis_Y1), "X-Axis index out of bounds!"); IM_ASSERT_USER_ERROR(y_idx == IMPLOT_AUTO || (y_idx >= ImAxis_Y1 && y_idx < ImAxis_COUNT), "Y-Axis index out of bounds!"); SetupLock(); ImPlotPlot& plot = *gp.CurrentPlot; ImPlotAxis& x_axis = x_idx == IMPLOT_AUTO ? plot.Axes[plot.CurrentX] : plot.Axes[x_idx]; ImPlotAxis& y_axis = y_idx == IMPLOT_AUTO ? plot.Axes[plot.CurrentY] : plot.Axes[y_idx]; return ImVec2( x_axis.PlotToPixels(x), y_axis.PlotToPixels(y) ); } ImVec2 PlotToPixels(const ImPlotPoint& plt, ImAxis x_idx, ImAxis y_idx) { return PlotToPixels(plt.x, plt.y, x_idx, y_idx); } ImVec2 GetPlotPos() { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr, "GetPlotPos() needs to be called between BeginPlot() and EndPlot()!"); SetupLock(); return gp.CurrentPlot->PlotRect.Min; } ImVec2 GetPlotSize() { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr, "GetPlotSize() needs to be called between BeginPlot() and EndPlot()!"); SetupLock(); return gp.CurrentPlot->PlotRect.GetSize(); } ImPlotPoint GetPlotMousePos(ImAxis x_idx, ImAxis y_idx) { IM_ASSERT_USER_ERROR(GImPlot->CurrentPlot != nullptr, "GetPlotMousePos() needs to be called between BeginPlot() and EndPlot()!"); SetupLock(); return PixelsToPlot(ImGui::GetMousePos(), x_idx, y_idx); } ImPlotRect GetPlotLimits(ImAxis x_idx, ImAxis y_idx) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr, "GetPlotLimits() needs to be called between BeginPlot() and EndPlot()!"); IM_ASSERT_USER_ERROR(x_idx == IMPLOT_AUTO || (x_idx >= ImAxis_X1 && x_idx < ImAxis_Y1), "X-Axis index out of bounds!"); IM_ASSERT_USER_ERROR(y_idx == IMPLOT_AUTO || (y_idx >= ImAxis_Y1 && y_idx < ImAxis_COUNT), "Y-Axis index out of bounds!"); SetupLock(); ImPlotPlot& plot = *gp.CurrentPlot; ImPlotAxis& x_axis = x_idx == IMPLOT_AUTO ? plot.Axes[plot.CurrentX] : plot.Axes[x_idx]; ImPlotAxis& y_axis = y_idx == IMPLOT_AUTO ? plot.Axes[plot.CurrentY] : plot.Axes[y_idx]; ImPlotRect limits; limits.X = x_axis.Range; limits.Y = y_axis.Range; return limits; } bool IsPlotHovered() { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr, "IsPlotHovered() needs to be called between BeginPlot() and EndPlot()!"); SetupLock(); return gp.CurrentPlot->Hovered; } bool IsAxisHovered(ImAxis axis) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr, "IsPlotXAxisHovered() needs to be called between BeginPlot() and EndPlot()!"); SetupLock(); return gp.CurrentPlot->Axes[axis].Hovered; } bool IsSubplotsHovered() { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentSubplot != nullptr, "IsSubplotsHovered() needs to be called between BeginSubplots() and EndSubplots()!"); return gp.CurrentSubplot->FrameHovered; } bool IsPlotSelected() { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr, "IsPlotSelected() needs to be called between BeginPlot() and EndPlot()!"); SetupLock(); return gp.CurrentPlot->Selected; } ImPlotRect GetPlotSelection(ImAxis x_idx, ImAxis y_idx) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr, "GetPlotSelection() needs to be called between BeginPlot() and EndPlot()!"); SetupLock(); ImPlotPlot& plot = *gp.CurrentPlot; if (!plot.Selected) return ImPlotRect(0,0,0,0); ImPlotPoint p1 = PixelsToPlot(plot.SelectRect.Min + plot.PlotRect.Min, x_idx, y_idx); ImPlotPoint p2 = PixelsToPlot(plot.SelectRect.Max + plot.PlotRect.Min, x_idx, y_idx); ImPlotRect result; result.X.Min = ImMin(p1.x, p2.x); result.X.Max = ImMax(p1.x, p2.x); result.Y.Min = ImMin(p1.y, p2.y); result.Y.Max = ImMax(p1.y, p2.y); return result; } void CancelPlotSelection() { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr, "CancelPlotSelection() needs to be called between BeginPlot() and EndPlot()!"); SetupLock(); ImPlotPlot& plot = *gp.CurrentPlot; if (plot.Selected) plot.Selected = plot.Selecting = false; } void HideNextItem(bool hidden, ImPlotCond cond) { ImPlotContext& gp = *GImPlot; gp.NextItemData.HasHidden = true; gp.NextItemData.Hidden = hidden; gp.NextItemData.HiddenCond = cond; } //----------------------------------------------------------------------------- // [SECTION] Plot Tools //----------------------------------------------------------------------------- void Annotation(double x, double y, const ImVec4& col, const ImVec2& offset, bool clamp, bool round) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr, "Annotation() needs to be called between BeginPlot() and EndPlot()!"); SetupLock(); char x_buff[IMPLOT_LABEL_MAX_SIZE]; char y_buff[IMPLOT_LABEL_MAX_SIZE]; ImPlotAxis& x_axis = gp.CurrentPlot->Axes[gp.CurrentPlot->CurrentX]; ImPlotAxis& y_axis = gp.CurrentPlot->Axes[gp.CurrentPlot->CurrentY]; LabelAxisValue(x_axis, x, x_buff, sizeof(x_buff), round); LabelAxisValue(y_axis, y, y_buff, sizeof(y_buff), round); Annotation(x,y,col,offset,clamp,"%s, %s",x_buff,y_buff); } void AnnotationV(double x, double y, const ImVec4& col, const ImVec2& offset, bool clamp, const char* fmt, va_list args) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr, "Annotation() needs to be called between BeginPlot() and EndPlot()!"); SetupLock(); ImVec2 pos = PlotToPixels(x,y,IMPLOT_AUTO,IMPLOT_AUTO); ImU32 bg = ImGui::GetColorU32(col); ImU32 fg = col.w == 0 ? GetStyleColorU32(ImPlotCol_InlayText) : CalcTextColor(col); gp.Annotations.AppendV(pos, offset, bg, fg, clamp, fmt, args); } void Annotation(double x, double y, const ImVec4& col, const ImVec2& offset, bool clamp, const char* fmt, ...) { va_list args; va_start(args, fmt); AnnotationV(x,y,col,offset,clamp,fmt,args); va_end(args); } void TagV(ImAxis axis, double v, const ImVec4& col, const char* fmt, va_list args) { ImPlotContext& gp = *GImPlot; SetupLock(); ImU32 bg = ImGui::GetColorU32(col); ImU32 fg = col.w == 0 ? GetStyleColorU32(ImPlotCol_AxisText) : CalcTextColor(col); gp.Tags.AppendV(axis,v,bg,fg,fmt,args); } void Tag(ImAxis axis, double v, const ImVec4& col, const char* fmt, ...) { va_list args; va_start(args, fmt); TagV(axis,v,col,fmt,args); va_end(args); } void Tag(ImAxis axis, double v, const ImVec4& color, bool round) { ImPlotContext& gp = *GImPlot; SetupLock(); char buff[IMPLOT_LABEL_MAX_SIZE]; ImPlotAxis& ax = gp.CurrentPlot->Axes[axis]; LabelAxisValue(ax, v, buff, sizeof(buff), round); Tag(axis,v,color,"%s",buff); } IMPLOT_API void TagX(double x, const ImVec4& color, bool round) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr, "TagX() needs to be called between BeginPlot() and EndPlot()!"); Tag(gp.CurrentPlot->CurrentX, x, color, round); } IMPLOT_API void TagX(double x, const ImVec4& color, const char* fmt, ...) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr, "TagX() needs to be called between BeginPlot() and EndPlot()!"); va_list args; va_start(args, fmt); TagV(gp.CurrentPlot->CurrentX,x,color,fmt,args); va_end(args); } IMPLOT_API void TagXV(double x, const ImVec4& color, const char* fmt, va_list args) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr, "TagX() needs to be called between BeginPlot() and EndPlot()!"); TagV(gp.CurrentPlot->CurrentX, x, color, fmt, args); } IMPLOT_API void TagY(double y, const ImVec4& color, bool round) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr, "TagY() needs to be called between BeginPlot() and EndPlot()!"); Tag(gp.CurrentPlot->CurrentY, y, color, round); } IMPLOT_API void TagY(double y, const ImVec4& color, const char* fmt, ...) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr, "TagY() needs to be called between BeginPlot() and EndPlot()!"); va_list args; va_start(args, fmt); TagV(gp.CurrentPlot->CurrentY,y,color,fmt,args); va_end(args); } IMPLOT_API void TagYV(double y, const ImVec4& color, const char* fmt, va_list args) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr, "TagY() needs to be called between BeginPlot() and EndPlot()!"); TagV(gp.CurrentPlot->CurrentY, y, color, fmt, args); } static const float DRAG_GRAB_HALF_SIZE = 4.0f; bool DragPoint(int n_id, double* x, double* y, const ImVec4& col, float radius, ImPlotDragToolFlags flags) { ImGui::PushID("#IMPLOT_DRAG_POINT"); IM_ASSERT_USER_ERROR(GImPlot->CurrentPlot != nullptr, "DragPoint() needs to be called between BeginPlot() and EndPlot()!"); SetupLock(); if (!ImHasFlag(flags,ImPlotDragToolFlags_NoFit) && FitThisFrame()) { FitPoint(ImPlotPoint(*x,*y)); } const bool input = !ImHasFlag(flags, ImPlotDragToolFlags_NoInputs); const bool show_curs = !ImHasFlag(flags, ImPlotDragToolFlags_NoCursors); const bool no_delay = !ImHasFlag(flags, ImPlotDragToolFlags_Delayed); const float grab_half_size = ImMax(DRAG_GRAB_HALF_SIZE, radius); const ImVec4 color = IsColorAuto(col) ? ImGui::GetStyleColorVec4(ImGuiCol_Text) : col; const ImU32 col32 = ImGui::ColorConvertFloat4ToU32(color); ImVec2 pos = PlotToPixels(*x,*y,IMPLOT_AUTO,IMPLOT_AUTO); const ImGuiID id = ImGui::GetCurrentWindow()->GetID(n_id); ImRect rect(pos.x-grab_half_size,pos.y-grab_half_size,pos.x+grab_half_size,pos.y+grab_half_size); bool hovered = false, held = false; ImGui::KeepAliveID(id); if (input) ImGui::ButtonBehavior(rect,id,&hovered,&held); bool dragging = false; if (held && ImGui::IsMouseDragging(0)) { *x = ImPlot::GetPlotMousePos(IMPLOT_AUTO,IMPLOT_AUTO).x; *y = ImPlot::GetPlotMousePos(IMPLOT_AUTO,IMPLOT_AUTO).y; dragging = true; } PushPlotClipRect(); ImDrawList& DrawList = *GetPlotDrawList(); if ((hovered || held) && show_curs) ImGui::SetMouseCursor(ImGuiMouseCursor_Hand); if (dragging && no_delay) pos = PlotToPixels(*x,*y,IMPLOT_AUTO,IMPLOT_AUTO); DrawList.AddCircleFilled(pos, radius, col32); PopPlotClipRect(); ImGui::PopID(); return dragging; } bool DragLineX(int n_id, double* value, const ImVec4& col, float thickness, ImPlotDragToolFlags flags) { // ImGui::PushID("#IMPLOT_DRAG_LINE_X"); ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr, "DragLineX() needs to be called between BeginPlot() and EndPlot()!"); SetupLock(); if (!ImHasFlag(flags,ImPlotDragToolFlags_NoFit) && FitThisFrame()) { FitPointX(*value); } const bool input = !ImHasFlag(flags, ImPlotDragToolFlags_NoInputs); const bool show_curs = !ImHasFlag(flags, ImPlotDragToolFlags_NoCursors); const bool no_delay = !ImHasFlag(flags, ImPlotDragToolFlags_Delayed); const float grab_half_size = ImMax(DRAG_GRAB_HALF_SIZE, thickness/2); float yt = gp.CurrentPlot->PlotRect.Min.y; float yb = gp.CurrentPlot->PlotRect.Max.y; float x = IM_ROUND(PlotToPixels(*value,0,IMPLOT_AUTO,IMPLOT_AUTO).x); const ImGuiID id = ImGui::GetCurrentWindow()->GetID(n_id); ImRect rect(x-grab_half_size,yt,x+grab_half_size,yb); bool hovered = false, held = false; ImGui::KeepAliveID(id); if (input) ImGui::ButtonBehavior(rect,id,&hovered,&held); if ((hovered || held) && show_curs) ImGui::SetMouseCursor(ImGuiMouseCursor_ResizeEW); float len = gp.Style.MajorTickLen.x; ImVec4 color = IsColorAuto(col) ? ImGui::GetStyleColorVec4(ImGuiCol_Text) : col; ImU32 col32 = ImGui::ColorConvertFloat4ToU32(color); bool dragging = false; if (held && ImGui::IsMouseDragging(0)) { *value = ImPlot::GetPlotMousePos(IMPLOT_AUTO,IMPLOT_AUTO).x; dragging = true; } PushPlotClipRect(); ImDrawList& DrawList = *GetPlotDrawList(); if (dragging && no_delay) x = IM_ROUND(PlotToPixels(*value,0,IMPLOT_AUTO,IMPLOT_AUTO).x); DrawList.AddLine(ImVec2(x,yt), ImVec2(x,yb), col32, thickness); DrawList.AddLine(ImVec2(x,yt), ImVec2(x,yt+len), col32, 3*thickness); DrawList.AddLine(ImVec2(x,yb), ImVec2(x,yb-len), col32, 3*thickness); PopPlotClipRect(); // ImGui::PopID(); return dragging; } bool DragLineY(int n_id, double* value, const ImVec4& col, float thickness, ImPlotDragToolFlags flags) { ImGui::PushID("#IMPLOT_DRAG_LINE_Y"); ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr, "DragLineY() needs to be called between BeginPlot() and EndPlot()!"); SetupLock(); if (!ImHasFlag(flags,ImPlotDragToolFlags_NoFit) && FitThisFrame()) { FitPointY(*value); } const bool input = !ImHasFlag(flags, ImPlotDragToolFlags_NoInputs); const bool show_curs = !ImHasFlag(flags, ImPlotDragToolFlags_NoCursors); const bool no_delay = !ImHasFlag(flags, ImPlotDragToolFlags_Delayed); const float grab_half_size = ImMax(DRAG_GRAB_HALF_SIZE, thickness/2); float xl = gp.CurrentPlot->PlotRect.Min.x; float xr = gp.CurrentPlot->PlotRect.Max.x; float y = IM_ROUND(PlotToPixels(0, *value,IMPLOT_AUTO,IMPLOT_AUTO).y); const ImGuiID id = ImGui::GetCurrentWindow()->GetID(n_id); ImRect rect(xl,y-grab_half_size,xr,y+grab_half_size); bool hovered = false, held = false; ImGui::KeepAliveID(id); if (input) ImGui::ButtonBehavior(rect,id,&hovered,&held); if ((hovered || held) && show_curs) ImGui::SetMouseCursor(ImGuiMouseCursor_ResizeNS); float len = gp.Style.MajorTickLen.y; ImVec4 color = IsColorAuto(col) ? ImGui::GetStyleColorVec4(ImGuiCol_Text) : col; ImU32 col32 = ImGui::ColorConvertFloat4ToU32(color); bool dragging = false; if (held && ImGui::IsMouseDragging(0)) { *value = ImPlot::GetPlotMousePos(IMPLOT_AUTO,IMPLOT_AUTO).y; dragging = true; } PushPlotClipRect(); ImDrawList& DrawList = *GetPlotDrawList(); if (dragging && no_delay) y = IM_ROUND(PlotToPixels(0, *value,IMPLOT_AUTO,IMPLOT_AUTO).y); DrawList.AddLine(ImVec2(xl,y), ImVec2(xr,y), col32, thickness); DrawList.AddLine(ImVec2(xl,y), ImVec2(xl+len,y), col32, 3*thickness); DrawList.AddLine(ImVec2(xr,y), ImVec2(xr-len,y), col32, 3*thickness); PopPlotClipRect(); ImGui::PopID(); return dragging; } bool DragRect(int n_id, double* x_min, double* y_min, double* x_max, double* y_max, const ImVec4& col, ImPlotDragToolFlags flags) { ImGui::PushID("#IMPLOT_DRAG_RECT"); IM_ASSERT_USER_ERROR(GImPlot->CurrentPlot != nullptr, "DragRect() needs to be called between BeginPlot() and EndPlot()!"); SetupLock(); if (!ImHasFlag(flags,ImPlotDragToolFlags_NoFit) && FitThisFrame()) { FitPoint(ImPlotPoint(*x_min,*y_min)); FitPoint(ImPlotPoint(*x_max,*y_max)); } const bool input = !ImHasFlag(flags, ImPlotDragToolFlags_NoInputs); const bool show_curs = !ImHasFlag(flags, ImPlotDragToolFlags_NoCursors); const bool no_delay = !ImHasFlag(flags, ImPlotDragToolFlags_Delayed); bool h[] = {true,false,true,false}; double* x[] = {x_min,x_max,x_max,x_min}; double* y[] = {y_min,y_min,y_max,y_max}; ImVec2 p[4]; for (int i = 0; i < 4; ++i) p[i] = PlotToPixels(*x[i],*y[i],IMPLOT_AUTO,IMPLOT_AUTO); ImVec2 pc = PlotToPixels((*x_min+*x_max)/2,(*y_min+*y_max)/2,IMPLOT_AUTO,IMPLOT_AUTO); ImRect rect(ImMin(p[0],p[2]),ImMax(p[0],p[2])); ImRect rect_grab = rect; rect_grab.Expand(DRAG_GRAB_HALF_SIZE); ImGuiMouseCursor cur[4]; if (show_curs) { cur[0] = (rect.Min.x == p[0].x && rect.Min.y == p[0].y) || (rect.Max.x == p[0].x && rect.Max.y == p[0].y) ? ImGuiMouseCursor_ResizeNWSE : ImGuiMouseCursor_ResizeNESW; cur[1] = cur[0] == ImGuiMouseCursor_ResizeNWSE ? ImGuiMouseCursor_ResizeNESW : ImGuiMouseCursor_ResizeNWSE; cur[2] = cur[1] == ImGuiMouseCursor_ResizeNWSE ? ImGuiMouseCursor_ResizeNESW : ImGuiMouseCursor_ResizeNWSE; cur[3] = cur[2] == ImGuiMouseCursor_ResizeNWSE ? ImGuiMouseCursor_ResizeNESW : ImGuiMouseCursor_ResizeNWSE; } ImVec4 color = IsColorAuto(col) ? ImGui::GetStyleColorVec4(ImGuiCol_Text) : col; ImU32 col32 = ImGui::ColorConvertFloat4ToU32(color); color.w *= 0.25f; ImU32 col32_a = ImGui::ColorConvertFloat4ToU32(color); const ImGuiID id = ImGui::GetCurrentWindow()->GetID(n_id); bool dragging = false; bool hovered = false, held = false; ImRect b_rect(pc.x-DRAG_GRAB_HALF_SIZE,pc.y-DRAG_GRAB_HALF_SIZE,pc.x+DRAG_GRAB_HALF_SIZE,pc.y+DRAG_GRAB_HALF_SIZE); ImGui::KeepAliveID(id); if (input) ImGui::ButtonBehavior(b_rect,id,&hovered,&held); if ((hovered || held) && show_curs) ImGui::SetMouseCursor(ImGuiMouseCursor_ResizeAll); if (held && ImGui::IsMouseDragging(0)) { for (int i = 0; i < 4; ++i) { ImPlotPoint pp = PixelsToPlot(p[i] + ImGui::GetIO().MouseDelta,IMPLOT_AUTO,IMPLOT_AUTO); *y[i] = pp.y; *x[i] = pp.x; } dragging = true; } for (int i = 0; i < 4; ++i) { // points b_rect = ImRect(p[i].x-DRAG_GRAB_HALF_SIZE,p[i].y-DRAG_GRAB_HALF_SIZE,p[i].x+DRAG_GRAB_HALF_SIZE,p[i].y+DRAG_GRAB_HALF_SIZE); ImGuiID p_id = id + i + 1; ImGui::KeepAliveID(p_id); if (input) ImGui::ButtonBehavior(b_rect,p_id,&hovered,&held); if ((hovered || held) && show_curs) ImGui::SetMouseCursor(cur[i]); if (held && ImGui::IsMouseDragging(0)) { *x[i] = ImPlot::GetPlotMousePos(IMPLOT_AUTO,IMPLOT_AUTO).x; *y[i] = ImPlot::GetPlotMousePos(IMPLOT_AUTO,IMPLOT_AUTO).y; dragging = true; } // edges ImVec2 e_min = ImMin(p[i],p[(i+1)%4]); ImVec2 e_max = ImMax(p[i],p[(i+1)%4]); b_rect = h[i] ? ImRect(e_min.x + DRAG_GRAB_HALF_SIZE, e_min.y - DRAG_GRAB_HALF_SIZE, e_max.x - DRAG_GRAB_HALF_SIZE, e_max.y + DRAG_GRAB_HALF_SIZE) : ImRect(e_min.x - DRAG_GRAB_HALF_SIZE, e_min.y + DRAG_GRAB_HALF_SIZE, e_max.x + DRAG_GRAB_HALF_SIZE, e_max.y - DRAG_GRAB_HALF_SIZE); ImGuiID e_id = id + i + 5; ImGui::KeepAliveID(e_id); if (input) ImGui::ButtonBehavior(b_rect,e_id,&hovered,&held); if ((hovered || held) && show_curs) h[i] ? ImGui::SetMouseCursor(ImGuiMouseCursor_ResizeNS) : ImGui::SetMouseCursor(ImGuiMouseCursor_ResizeEW); if (held && ImGui::IsMouseDragging(0)) { if (h[i]) *y[i] = ImPlot::GetPlotMousePos(IMPLOT_AUTO,IMPLOT_AUTO).y; else *x[i] = ImPlot::GetPlotMousePos(IMPLOT_AUTO,IMPLOT_AUTO).x; dragging = true; } if (hovered && ImGui::IsMouseDoubleClicked(0)) { ImPlotRect b = GetPlotLimits(IMPLOT_AUTO,IMPLOT_AUTO); if (h[i]) *y[i] = ((y[i] == y_min && *y_min < *y_max) || (y[i] == y_max && *y_max < *y_min)) ? b.Y.Min : b.Y.Max; else *x[i] = ((x[i] == x_min && *x_min < *x_max) || (x[i] == x_max && *x_max < *x_min)) ? b.X.Min : b.X.Max; dragging = true; } } PushPlotClipRect(); ImDrawList& DrawList = *GetPlotDrawList(); if (dragging && no_delay) { for (int i = 0; i < 4; ++i) p[i] = PlotToPixels(*x[i],*y[i],IMPLOT_AUTO,IMPLOT_AUTO); pc = PlotToPixels((*x_min+*x_max)/2,(*y_min+*y_max)/2,IMPLOT_AUTO,IMPLOT_AUTO); rect = ImRect(ImMin(p[0],p[2]),ImMax(p[0],p[2])); } DrawList.AddRectFilled(rect.Min, rect.Max, col32_a); DrawList.AddRect(rect.Min, rect.Max, col32); if (input && (dragging || rect_grab.Contains(ImGui::GetMousePos()))) { DrawList.AddCircleFilled(pc,DRAG_GRAB_HALF_SIZE,col32); for (int i = 0; i < 4; ++i) DrawList.AddCircleFilled(p[i],DRAG_GRAB_HALF_SIZE,col32); } PopPlotClipRect(); ImGui::PopID(); return dragging; } bool DragRect(int id, ImPlotRect* bounds, const ImVec4& col, ImPlotDragToolFlags flags) { return DragRect(id, &bounds->X.Min, &bounds->Y.Min,&bounds->X.Max, &bounds->Y.Max, col, flags); } //----------------------------------------------------------------------------- // [SECTION] Legend Utils and Tools //----------------------------------------------------------------------------- bool IsLegendEntryHovered(const char* label_id) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentItems != nullptr, "IsPlotItemHighlight() needs to be called within an itemized context!"); SetupLock(); ImGuiID id = ImGui::GetIDWithSeed(label_id, nullptr, gp.CurrentItems->ID); ImPlotItem* item = gp.CurrentItems->GetItem(id); return item && item->LegendHovered; } bool BeginLegendPopup(const char* label_id, ImGuiMouseButton mouse_button) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentItems != nullptr, "BeginLegendPopup() needs to be called within an itemized context!"); SetupLock(); ImGuiWindow* window = GImGui->CurrentWindow; if (window->SkipItems) return false; ImGuiID id = ImGui::GetIDWithSeed(label_id, nullptr, gp.CurrentItems->ID); if (ImGui::IsMouseReleased(mouse_button)) { ImPlotItem* item = gp.CurrentItems->GetItem(id); if (item && item->LegendHovered) ImGui::OpenPopupEx(id); } return ImGui::BeginPopupEx(id, ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoSavedSettings); } void EndLegendPopup() { SetupLock(); ImGui::EndPopup(); } void ShowAltLegend(const char* title_id, bool vertical, const ImVec2 size, bool interactable) { ImPlotContext& gp = *GImPlot; ImGuiContext &G = *GImGui; ImGuiWindow * Window = G.CurrentWindow; if (Window->SkipItems) return; ImDrawList &DrawList = *Window->DrawList; ImPlotPlot* plot = GetPlot(title_id); ImVec2 legend_size; ImVec2 default_size = gp.Style.LegendPadding * 2; if (plot != nullptr) { legend_size = CalcLegendSize(plot->Items, gp.Style.LegendInnerPadding, gp.Style.LegendSpacing, vertical); default_size = legend_size + gp.Style.LegendPadding * 2; } ImVec2 frame_size = ImGui::CalcItemSize(size, default_size.x, default_size.y); ImRect bb_frame = ImRect(Window->DC.CursorPos, Window->DC.CursorPos + frame_size); ImGui::ItemSize(bb_frame); if (!ImGui::ItemAdd(bb_frame, 0, &bb_frame)) return; ImGui::RenderFrame(bb_frame.Min, bb_frame.Max, GetStyleColorU32(ImPlotCol_FrameBg), true, G.Style.FrameRounding); DrawList.PushClipRect(bb_frame.Min, bb_frame.Max, true); if (plot != nullptr) { const ImVec2 legend_pos = GetLocationPos(bb_frame, legend_size, 0, gp.Style.LegendPadding); const ImRect legend_bb(legend_pos, legend_pos + legend_size); interactable = interactable && bb_frame.Contains(ImGui::GetIO().MousePos); // render legend box ImU32 col_bg = GetStyleColorU32(ImPlotCol_LegendBg); ImU32 col_bd = GetStyleColorU32(ImPlotCol_LegendBorder); DrawList.AddRectFilled(legend_bb.Min, legend_bb.Max, col_bg); DrawList.AddRect(legend_bb.Min, legend_bb.Max, col_bd); // render entries ShowLegendEntries(plot->Items, legend_bb, interactable, gp.Style.LegendInnerPadding, gp.Style.LegendSpacing, vertical, DrawList); } DrawList.PopClipRect(); } //----------------------------------------------------------------------------- // [SECTION] Drag and Drop Utils //----------------------------------------------------------------------------- bool BeginDragDropTargetPlot() { SetupLock(); ImPlotContext& gp = *GImPlot; ImRect rect = gp.CurrentPlot->PlotRect; return ImGui::BeginDragDropTargetCustom(rect, gp.CurrentPlot->ID); } bool BeginDragDropTargetAxis(ImAxis axis) { SetupLock(); ImPlotPlot& plot = *GImPlot->CurrentPlot; ImPlotAxis& ax = plot.Axes[axis]; ImRect rect = ax.HoverRect; rect.Expand(-3.5f); return ImGui::BeginDragDropTargetCustom(rect, ax.ID); } bool BeginDragDropTargetLegend() { SetupLock(); ImPlotItemGroup& items = *GImPlot->CurrentItems; ImRect rect = items.Legend.Rect; return ImGui::BeginDragDropTargetCustom(rect, items.ID); } void EndDragDropTarget() { SetupLock(); ImGui::EndDragDropTarget(); } bool BeginDragDropSourcePlot(ImGuiDragDropFlags flags) { SetupLock(); ImPlotContext& gp = *GImPlot; ImPlotPlot* plot = gp.CurrentPlot; if (GImGui->IO.KeyMods == gp.InputMap.OverrideMod || GImGui->DragDropPayload.SourceId == plot->ID) return ImGui::ItemAdd(plot->PlotRect, plot->ID) && ImGui::BeginDragDropSource(flags); return false; } bool BeginDragDropSourceAxis(ImAxis idx, ImGuiDragDropFlags flags) { SetupLock(); ImPlotContext& gp = *GImPlot; ImPlotAxis& axis = gp.CurrentPlot->Axes[idx]; if (GImGui->IO.KeyMods == gp.InputMap.OverrideMod || GImGui->DragDropPayload.SourceId == axis.ID) return ImGui::ItemAdd(axis.HoverRect, axis.ID) && ImGui::BeginDragDropSource(flags); return false; } bool BeginDragDropSourceItem(const char* label_id, ImGuiDragDropFlags flags) { SetupLock(); ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentItems != nullptr, "BeginDragDropSourceItem() needs to be called within an itemized context!"); ImGuiID item_id = ImGui::GetIDWithSeed(label_id, nullptr, gp.CurrentItems->ID); ImPlotItem* item = gp.CurrentItems->GetItem(item_id); if (item != nullptr) { return ImGui::ItemAdd(item->LegendHoverRect, item->ID) && ImGui::BeginDragDropSource(flags); } return false; } void EndDragDropSource() { SetupLock(); ImGui::EndDragDropSource(); } //----------------------------------------------------------------------------- // [SECTION] Aligned Plots //----------------------------------------------------------------------------- bool BeginAlignedPlots(const char* group_id, bool vertical) { IM_ASSERT_USER_ERROR(GImPlot != nullptr, "No current context. Did you call ImPlot::CreateContext() or ImPlot::SetCurrentContext()?"); ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentAlignmentH == nullptr && gp.CurrentAlignmentV == nullptr, "Mismatched BeginAlignedPlots()/EndAlignedPlots()!"); ImGuiContext &G = *GImGui; ImGuiWindow * Window = G.CurrentWindow; if (Window->SkipItems) return false; const ImGuiID ID = Window->GetID(group_id); ImPlotAlignmentData* alignment = gp.AlignmentData.GetOrAddByKey(ID); if (vertical) gp.CurrentAlignmentV = alignment; else gp.CurrentAlignmentH = alignment; if (alignment->Vertical != vertical) alignment->Reset(); alignment->Vertical = vertical; alignment->Begin(); return true; } void EndAlignedPlots() { IM_ASSERT_USER_ERROR(GImPlot != nullptr, "No current context. Did you call ImPlot::CreateContext() or ImPlot::SetCurrentContext()?"); ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentAlignmentH != nullptr || gp.CurrentAlignmentV != nullptr, "Mismatched BeginAlignedPlots()/EndAlignedPlots()!"); ImPlotAlignmentData* alignment = gp.CurrentAlignmentH != nullptr ? gp.CurrentAlignmentH : (gp.CurrentAlignmentV != nullptr ? gp.CurrentAlignmentV : nullptr); if (alignment) alignment->End(); ResetCtxForNextAlignedPlots(GImPlot); } //----------------------------------------------------------------------------- // [SECTION] Plot and Item Styling //----------------------------------------------------------------------------- ImPlotStyle& GetStyle() { IM_ASSERT_USER_ERROR(GImPlot != nullptr, "No current context. Did you call ImPlot::CreateContext() or ImPlot::SetCurrentContext()?"); ImPlotContext& gp = *GImPlot; return gp.Style; } void PushStyleColor(ImPlotCol idx, ImU32 col) { ImPlotContext& gp = *GImPlot; ImGuiColorMod backup; backup.Col = (ImGuiCol)idx; backup.BackupValue = gp.Style.Colors[idx]; gp.ColorModifiers.push_back(backup); gp.Style.Colors[idx] = ImGui::ColorConvertU32ToFloat4(col); } void PushStyleColor(ImPlotCol idx, const ImVec4& col) { ImPlotContext& gp = *GImPlot; ImGuiColorMod backup; backup.Col = (ImGuiCol)idx; backup.BackupValue = gp.Style.Colors[idx]; gp.ColorModifiers.push_back(backup); gp.Style.Colors[idx] = col; } void PopStyleColor(int count) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(count <= gp.ColorModifiers.Size, "You can't pop more modifiers than have been pushed!"); while (count > 0) { ImGuiColorMod& backup = gp.ColorModifiers.back(); gp.Style.Colors[backup.Col] = backup.BackupValue; gp.ColorModifiers.pop_back(); count--; } } void PushStyleVar(ImPlotStyleVar idx, float val) { ImPlotContext& gp = *GImPlot; const ImPlotStyleVarInfo* var_info = GetPlotStyleVarInfo(idx); if (var_info->Type == ImGuiDataType_Float && var_info->Count == 1) { float* pvar = (float*)var_info->GetVarPtr(&gp.Style); gp.StyleModifiers.push_back(ImGuiStyleMod((ImGuiStyleVar)idx, *pvar)); *pvar = val; return; } IM_ASSERT(0 && "Called PushStyleVar() float variant but variable is not a float!"); } void PushStyleVar(ImPlotStyleVar idx, int val) { ImPlotContext& gp = *GImPlot; const ImPlotStyleVarInfo* var_info = GetPlotStyleVarInfo(idx); if (var_info->Type == ImGuiDataType_S32 && var_info->Count == 1) { int* pvar = (int*)var_info->GetVarPtr(&gp.Style); gp.StyleModifiers.push_back(ImGuiStyleMod((ImGuiStyleVar)idx, *pvar)); *pvar = val; return; } else if (var_info->Type == ImGuiDataType_Float && var_info->Count == 1) { float* pvar = (float*)var_info->GetVarPtr(&gp.Style); gp.StyleModifiers.push_back(ImGuiStyleMod((ImGuiStyleVar)idx, *pvar)); *pvar = (float)val; return; } IM_ASSERT(0 && "Called PushStyleVar() int variant but variable is not a int!"); } void PushStyleVar(ImPlotStyleVar idx, const ImVec2& val) { ImPlotContext& gp = *GImPlot; const ImPlotStyleVarInfo* var_info = GetPlotStyleVarInfo(idx); if (var_info->Type == ImGuiDataType_Float && var_info->Count == 2) { ImVec2* pvar = (ImVec2*)var_info->GetVarPtr(&gp.Style); gp.StyleModifiers.push_back(ImGuiStyleMod((ImGuiStyleVar)idx, *pvar)); *pvar = val; return; } IM_ASSERT(0 && "Called PushStyleVar() ImVec2 variant but variable is not a ImVec2!"); } void PopStyleVar(int count) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(count <= gp.StyleModifiers.Size, "You can't pop more modifiers than have been pushed!"); while (count > 0) { ImGuiStyleMod& backup = gp.StyleModifiers.back(); const ImPlotStyleVarInfo* info = GetPlotStyleVarInfo(backup.VarIdx); void* data = info->GetVarPtr(&gp.Style); if (info->Type == ImGuiDataType_Float && info->Count == 1) { ((float*)data)[0] = backup.BackupFloat[0]; } else if (info->Type == ImGuiDataType_Float && info->Count == 2) { ((float*)data)[0] = backup.BackupFloat[0]; ((float*)data)[1] = backup.BackupFloat[1]; } else if (info->Type == ImGuiDataType_S32 && info->Count == 1) { ((int*)data)[0] = backup.BackupInt[0]; } gp.StyleModifiers.pop_back(); count--; } } //------------------------------------------------------------------------------ // [Section] Colormaps //------------------------------------------------------------------------------ ImPlotColormap AddColormap(const char* name, const ImVec4* colormap, int size, bool qual) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(size > 1, "The colormap size must be greater than 1!"); IM_ASSERT_USER_ERROR(gp.ColormapData.GetIndex(name) == -1, "The colormap name has already been used!"); ImVector buffer; buffer.resize(size); for (int i = 0; i < size; ++i) buffer[i] = ImGui::ColorConvertFloat4ToU32(colormap[i]); return gp.ColormapData.Append(name, buffer.Data, size, qual); } ImPlotColormap AddColormap(const char* name, const ImU32* colormap, int size, bool qual) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(size > 1, "The colormap size must be greater than 1!"); IM_ASSERT_USER_ERROR(gp.ColormapData.GetIndex(name) == -1, "The colormap name has already be used!"); return gp.ColormapData.Append(name, colormap, size, qual); } int GetColormapCount() { ImPlotContext& gp = *GImPlot; return gp.ColormapData.Count; } const char* GetColormapName(ImPlotColormap colormap) { ImPlotContext& gp = *GImPlot; return gp.ColormapData.GetName(colormap); } ImPlotColormap GetColormapIndex(const char* name) { ImPlotContext& gp = *GImPlot; return gp.ColormapData.GetIndex(name); } void PushColormap(ImPlotColormap colormap) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(colormap >= 0 && colormap < gp.ColormapData.Count, "The colormap index is invalid!"); gp.ColormapModifiers.push_back(gp.Style.Colormap); gp.Style.Colormap = colormap; } void PushColormap(const char* name) { ImPlotContext& gp = *GImPlot; ImPlotColormap idx = gp.ColormapData.GetIndex(name); IM_ASSERT_USER_ERROR(idx != -1, "The colormap name is invalid!"); PushColormap(idx); } void PopColormap(int count) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(count <= gp.ColormapModifiers.Size, "You can't pop more modifiers than have been pushed!"); while (count > 0) { const ImPlotColormap& backup = gp.ColormapModifiers.back(); gp.Style.Colormap = backup; gp.ColormapModifiers.pop_back(); count--; } } ImU32 NextColormapColorU32() { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentItems != nullptr, "NextColormapColor() needs to be called between BeginPlot() and EndPlot()!"); int idx = gp.CurrentItems->ColormapIdx % gp.ColormapData.GetKeyCount(gp.Style.Colormap); ImU32 col = gp.ColormapData.GetKeyColor(gp.Style.Colormap, idx); gp.CurrentItems->ColormapIdx++; return col; } ImVec4 NextColormapColor() { return ImGui::ColorConvertU32ToFloat4(NextColormapColorU32()); } int GetColormapSize(ImPlotColormap cmap) { ImPlotContext& gp = *GImPlot; cmap = cmap == IMPLOT_AUTO ? gp.Style.Colormap : cmap; IM_ASSERT_USER_ERROR(cmap >= 0 && cmap < gp.ColormapData.Count, "Invalid colormap index!"); return gp.ColormapData.GetKeyCount(cmap); } ImU32 GetColormapColorU32(int idx, ImPlotColormap cmap) { ImPlotContext& gp = *GImPlot; cmap = cmap == IMPLOT_AUTO ? gp.Style.Colormap : cmap; IM_ASSERT_USER_ERROR(cmap >= 0 && cmap < gp.ColormapData.Count, "Invalid colormap index!"); idx = idx % gp.ColormapData.GetKeyCount(cmap); return gp.ColormapData.GetKeyColor(cmap, idx); } ImVec4 GetColormapColor(int idx, ImPlotColormap cmap) { return ImGui::ColorConvertU32ToFloat4(GetColormapColorU32(idx,cmap)); } ImU32 SampleColormapU32(float t, ImPlotColormap cmap) { ImPlotContext& gp = *GImPlot; cmap = cmap == IMPLOT_AUTO ? gp.Style.Colormap : cmap; IM_ASSERT_USER_ERROR(cmap >= 0 && cmap < gp.ColormapData.Count, "Invalid colormap index!"); return gp.ColormapData.LerpTable(cmap, t); } ImVec4 SampleColormap(float t, ImPlotColormap cmap) { return ImGui::ColorConvertU32ToFloat4(SampleColormapU32(t,cmap)); } void RenderColorBar(const ImU32* colors, int size, ImDrawList& DrawList, const ImRect& bounds, bool vert, bool reversed, bool continuous) { const int n = continuous ? size - 1 : size; ImU32 col1, col2; if (vert) { const float step = bounds.GetHeight() / n; ImRect rect(bounds.Min.x, bounds.Min.y, bounds.Max.x, bounds.Min.y + step); for (int i = 0; i < n; ++i) { if (reversed) { col1 = colors[size-i-1]; col2 = continuous ? colors[size-i-2] : col1; } else { col1 = colors[i]; col2 = continuous ? colors[i+1] : col1; } DrawList.AddRectFilledMultiColor(rect.Min, rect.Max, col1, col1, col2, col2); rect.TranslateY(step); } } else { const float step = bounds.GetWidth() / n; ImRect rect(bounds.Min.x, bounds.Min.y, bounds.Min.x + step, bounds.Max.y); for (int i = 0; i < n; ++i) { if (reversed) { col1 = colors[size-i-1]; col2 = continuous ? colors[size-i-2] : col1; } else { col1 = colors[i]; col2 = continuous ? colors[i+1] : col1; } DrawList.AddRectFilledMultiColor(rect.Min, rect.Max, col1, col2, col2, col1); rect.TranslateX(step); } } } void ColormapScale(const char* label, double scale_min, double scale_max, const ImVec2& size, const char* format, ImPlotColormapScaleFlags flags, ImPlotColormap cmap) { ImGuiContext &G = *GImGui; ImGuiWindow * Window = G.CurrentWindow; if (Window->SkipItems) return; const ImGuiID ID = Window->GetID(label); ImVec2 label_size(0,0); if (!ImHasFlag(flags, ImPlotColormapScaleFlags_NoLabel)) { label_size = ImGui::CalcTextSize(label,nullptr,true); } ImPlotContext& gp = *GImPlot; cmap = cmap == IMPLOT_AUTO ? gp.Style.Colormap : cmap; IM_ASSERT_USER_ERROR(cmap >= 0 && cmap < gp.ColormapData.Count, "Invalid colormap index!"); ImVec2 frame_size = ImGui::CalcItemSize(size, 0, gp.Style.PlotDefaultSize.y); if (frame_size.y < gp.Style.PlotMinSize.y && size.y < 0.0f) frame_size.y = gp.Style.PlotMinSize.y; ImPlotRange range(ImMin(scale_min,scale_max), ImMax(scale_min,scale_max)); gp.CTicker.Reset(); Locator_Default(gp.CTicker, range, frame_size.y, true, Formatter_Default, (void*)format); const bool rend_label = label_size.x > 0; const float txt_off = gp.Style.LabelPadding.x; const float pad = txt_off + gp.CTicker.MaxSize.x + (rend_label ? txt_off + label_size.y : 0); float bar_w = 20; if (frame_size.x == 0) frame_size.x = bar_w + pad + 2 * gp.Style.PlotPadding.x; else { bar_w = frame_size.x - (pad + 2 * gp.Style.PlotPadding.x); if (bar_w < gp.Style.MajorTickLen.y) bar_w = gp.Style.MajorTickLen.y; } ImDrawList &DrawList = *Window->DrawList; ImRect bb_frame = ImRect(Window->DC.CursorPos, Window->DC.CursorPos + frame_size); ImGui::ItemSize(bb_frame); if (!ImGui::ItemAdd(bb_frame, ID, &bb_frame)) return; ImGui::RenderFrame(bb_frame.Min, bb_frame.Max, GetStyleColorU32(ImPlotCol_FrameBg), true, G.Style.FrameRounding); const bool opposite = ImHasFlag(flags, ImPlotColormapScaleFlags_Opposite); const bool inverted = ImHasFlag(flags, ImPlotColormapScaleFlags_Invert); const bool reversed = scale_min > scale_max; float bb_grad_shift = opposite ? pad : 0; ImRect bb_grad(bb_frame.Min + gp.Style.PlotPadding + ImVec2(bb_grad_shift, 0), bb_frame.Min + ImVec2(bar_w + gp.Style.PlotPadding.x + bb_grad_shift, frame_size.y - gp.Style.PlotPadding.y)); ImGui::PushClipRect(bb_frame.Min, bb_frame.Max, true); const ImU32 col_text = ImGui::GetColorU32(ImGuiCol_Text); const bool invert_scale = inverted ? (reversed ? false : true) : (reversed ? true : false); const float y_min = invert_scale ? bb_grad.Max.y : bb_grad.Min.y; const float y_max = invert_scale ? bb_grad.Min.y : bb_grad.Max.y; RenderColorBar(gp.ColormapData.GetKeys(cmap), gp.ColormapData.GetKeyCount(cmap), DrawList, bb_grad, true, !inverted, !gp.ColormapData.IsQual(cmap)); for (int i = 0; i < gp.CTicker.TickCount(); ++i) { const double y_pos_plt = gp.CTicker.Ticks[i].PlotPos; const float y_pos = ImRemap((float)y_pos_plt, (float)range.Max, (float)range.Min, y_min, y_max); const float tick_width = gp.CTicker.Ticks[i].Major ? gp.Style.MajorTickLen.y : gp.Style.MinorTickLen.y; const float tick_thick = gp.CTicker.Ticks[i].Major ? gp.Style.MajorTickSize.y : gp.Style.MinorTickSize.y; const float tick_t = (float)((y_pos_plt - scale_min) / (scale_max - scale_min)); const ImU32 tick_col = CalcTextColor(gp.ColormapData.LerpTable(cmap,tick_t)); if (y_pos < bb_grad.Max.y - 2 && y_pos > bb_grad.Min.y + 2) { DrawList.AddLine(opposite ? ImVec2(bb_grad.Min.x+1, y_pos) : ImVec2(bb_grad.Max.x-1, y_pos), opposite ? ImVec2(bb_grad.Min.x + tick_width, y_pos) : ImVec2(bb_grad.Max.x - tick_width, y_pos), tick_col, tick_thick); } const float txt_x = opposite ? bb_grad.Min.x - txt_off - gp.CTicker.Ticks[i].LabelSize.x : bb_grad.Max.x + txt_off; const float txt_y = y_pos - gp.CTicker.Ticks[i].LabelSize.y * 0.5f; DrawList.AddText(ImVec2(txt_x, txt_y), col_text, gp.CTicker.GetText(i)); } if (rend_label) { const float pos_x = opposite ? bb_frame.Min.x + gp.Style.PlotPadding.x : bb_grad.Max.x + 2 * txt_off + gp.CTicker.MaxSize.x; const float pos_y = bb_grad.GetCenter().y + label_size.x * 0.5f; const char* label_end = ImGui::FindRenderedTextEnd(label); AddTextVertical(&DrawList,ImVec2(pos_x,pos_y),col_text,label,label_end); } DrawList.AddRect(bb_grad.Min, bb_grad.Max, GetStyleColorU32(ImPlotCol_PlotBorder)); ImGui::PopClipRect(); } bool ColormapSlider(const char* label, float* t, ImVec4* out, const char* format, ImPlotColormap cmap) { *t = ImClamp(*t,0.0f,1.0f); ImGuiContext &G = *GImGui; ImGuiWindow * Window = G.CurrentWindow; if (Window->SkipItems) return false; ImPlotContext& gp = *GImPlot; cmap = cmap == IMPLOT_AUTO ? gp.Style.Colormap : cmap; IM_ASSERT_USER_ERROR(cmap >= 0 && cmap < gp.ColormapData.Count, "Invalid colormap index!"); const ImU32* keys = gp.ColormapData.GetKeys(cmap); const int count = gp.ColormapData.GetKeyCount(cmap); const bool qual = gp.ColormapData.IsQual(cmap); const ImVec2 pos = ImGui::GetCurrentWindow()->DC.CursorPos; const float w = ImGui::CalcItemWidth(); const float h = ImGui::GetFrameHeight(); const ImRect rect = ImRect(pos.x,pos.y,pos.x+w,pos.y+h); RenderColorBar(keys,count,*ImGui::GetWindowDrawList(),rect,false,false,!qual); const ImU32 grab = CalcTextColor(gp.ColormapData.LerpTable(cmap,*t)); // const ImU32 text = CalcTextColor(gp.ColormapData.LerpTable(cmap,0.5f)); ImGui::PushStyleColor(ImGuiCol_FrameBg,IM_COL32_BLACK_TRANS); ImGui::PushStyleColor(ImGuiCol_FrameBgActive,IM_COL32_BLACK_TRANS); ImGui::PushStyleColor(ImGuiCol_FrameBgHovered,ImVec4(1,1,1,0.1f)); ImGui::PushStyleColor(ImGuiCol_SliderGrab,grab); ImGui::PushStyleColor(ImGuiCol_SliderGrabActive, grab); ImGui::PushStyleVar(ImGuiStyleVar_GrabMinSize,2); ImGui::PushStyleVar(ImGuiStyleVar_FrameRounding,0); const bool changed = ImGui::SliderFloat(label,t,0,1,format); ImGui::PopStyleColor(5); ImGui::PopStyleVar(2); if (out != nullptr) *out = ImGui::ColorConvertU32ToFloat4(gp.ColormapData.LerpTable(cmap,*t)); return changed; } bool ColormapButton(const char* label, const ImVec2& size_arg, ImPlotColormap cmap) { ImGuiContext &G = *GImGui; const ImGuiStyle& style = G.Style; ImGuiWindow * Window = G.CurrentWindow; if (Window->SkipItems) return false; ImPlotContext& gp = *GImPlot; cmap = cmap == IMPLOT_AUTO ? gp.Style.Colormap : cmap; IM_ASSERT_USER_ERROR(cmap >= 0 && cmap < gp.ColormapData.Count, "Invalid colormap index!"); const ImU32* keys = gp.ColormapData.GetKeys(cmap); const int count = gp.ColormapData.GetKeyCount(cmap); const bool qual = gp.ColormapData.IsQual(cmap); const ImVec2 pos = ImGui::GetCurrentWindow()->DC.CursorPos; const ImVec2 label_size = ImGui::CalcTextSize(label, nullptr, true); ImVec2 size = ImGui::CalcItemSize(size_arg, label_size.x + style.FramePadding.x * 2.0f, label_size.y + style.FramePadding.y * 2.0f); const ImRect rect = ImRect(pos.x,pos.y,pos.x+size.x,pos.y+size.y); RenderColorBar(keys,count,*ImGui::GetWindowDrawList(),rect,false,false,!qual); const ImU32 text = CalcTextColor(gp.ColormapData.LerpTable(cmap,G.Style.ButtonTextAlign.x)); ImGui::PushStyleColor(ImGuiCol_Button,IM_COL32_BLACK_TRANS); ImGui::PushStyleColor(ImGuiCol_ButtonHovered,ImVec4(1,1,1,0.1f)); ImGui::PushStyleColor(ImGuiCol_ButtonActive,ImVec4(1,1,1,0.2f)); ImGui::PushStyleColor(ImGuiCol_Text,text); ImGui::PushStyleVar(ImGuiStyleVar_FrameRounding,0); const bool pressed = ImGui::Button(label,size); ImGui::PopStyleColor(4); ImGui::PopStyleVar(1); return pressed; } //----------------------------------------------------------------------------- // [Section] Miscellaneous //----------------------------------------------------------------------------- ImPlotInputMap& GetInputMap() { IM_ASSERT_USER_ERROR(GImPlot != nullptr, "No current context. Did you call ImPlot::CreateContext() or ImPlot::SetCurrentContext()?"); ImPlotContext& gp = *GImPlot; return gp.InputMap; } void MapInputDefault(ImPlotInputMap* dst) { ImPlotInputMap& map = dst ? *dst : GetInputMap(); map.Pan = ImGuiMouseButton_Left; map.PanMod = ImGuiMod_None; map.Fit = ImGuiMouseButton_Left; map.Menu = ImGuiMouseButton_Right; map.Select = ImGuiMouseButton_Right; map.SelectMod = ImGuiMod_None; map.SelectCancel = ImGuiMouseButton_Left; map.SelectHorzMod = ImGuiMod_Alt; map.SelectVertMod = ImGuiMod_Shift; map.OverrideMod = ImGuiMod_Ctrl; map.ZoomMod = ImGuiMod_None; map.ZoomRate = 0.1f; } void MapInputReverse(ImPlotInputMap* dst) { ImPlotInputMap& map = dst ? *dst : GetInputMap(); map.Pan = ImGuiMouseButton_Right; map.PanMod = ImGuiMod_None; map.Fit = ImGuiMouseButton_Left; map.Menu = ImGuiMouseButton_Right; map.Select = ImGuiMouseButton_Left; map.SelectMod = ImGuiMod_None; map.SelectCancel = ImGuiMouseButton_Right; map.SelectHorzMod = ImGuiMod_Alt; map.SelectVertMod = ImGuiMod_Shift; map.OverrideMod = ImGuiMod_Ctrl; map.ZoomMod = ImGuiMod_None; map.ZoomRate = 0.1f; } //----------------------------------------------------------------------------- // [Section] Miscellaneous //----------------------------------------------------------------------------- void ItemIcon(const ImVec4& col) { ItemIcon(ImGui::ColorConvertFloat4ToU32(col)); } void ItemIcon(ImU32 col) { const float txt_size = ImGui::GetTextLineHeight(); ImVec2 size(txt_size-4,txt_size); ImGuiWindow* window = ImGui::GetCurrentWindow(); ImVec2 pos = window->DC.CursorPos; ImGui::GetWindowDrawList()->AddRectFilled(pos + ImVec2(0,2), pos + size - ImVec2(0,2), col); ImGui::Dummy(size); } void ColormapIcon(ImPlotColormap cmap) { ImPlotContext& gp = *GImPlot; const float txt_size = ImGui::GetTextLineHeight(); ImVec2 size(txt_size-4,txt_size); ImGuiWindow* window = ImGui::GetCurrentWindow(); ImVec2 pos = window->DC.CursorPos; ImRect rect(pos+ImVec2(0,2),pos+size-ImVec2(0,2)); ImDrawList& DrawList = *ImGui::GetWindowDrawList(); RenderColorBar(gp.ColormapData.GetKeys(cmap),gp.ColormapData.GetKeyCount(cmap),DrawList,rect,false,false,!gp.ColormapData.IsQual(cmap)); ImGui::Dummy(size); } ImDrawList* GetPlotDrawList() { return ImGui::GetWindowDrawList(); } void PushPlotClipRect(float expand) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr, "PushPlotClipRect() needs to be called between BeginPlot() and EndPlot()!"); SetupLock(); ImRect rect = gp.CurrentPlot->PlotRect; rect.Expand(expand); ImGui::PushClipRect(rect.Min, rect.Max, true); } void PopPlotClipRect() { SetupLock(); ImGui::PopClipRect(); } static void HelpMarker(const char* desc) { ImGui::TextDisabled("(?)"); if (ImGui::IsItemHovered()) { ImGui::BeginTooltip(); ImGui::PushTextWrapPos(ImGui::GetFontSize() * 35.0f); ImGui::TextUnformatted(desc); ImGui::PopTextWrapPos(); ImGui::EndTooltip(); } } bool ShowStyleSelector(const char* label) { static int style_idx = -1; if (ImGui::Combo(label, &style_idx, "Auto\0Classic\0Dark\0Light\0")) { switch (style_idx) { case 0: StyleColorsAuto(); break; case 1: StyleColorsClassic(); break; case 2: StyleColorsDark(); break; case 3: StyleColorsLight(); break; } return true; } return false; } bool ShowColormapSelector(const char* label) { ImPlotContext& gp = *GImPlot; bool set = false; if (ImGui::BeginCombo(label, gp.ColormapData.GetName(gp.Style.Colormap))) { for (int i = 0; i < gp.ColormapData.Count; ++i) { const char* name = gp.ColormapData.GetName(i); if (ImGui::Selectable(name, gp.Style.Colormap == i)) { gp.Style.Colormap = i; ImPlot::BustItemCache(); set = true; } } ImGui::EndCombo(); } return set; } bool ShowInputMapSelector(const char* label) { static int map_idx = -1; if (ImGui::Combo(label, &map_idx, "Default\0Reversed\0")) { switch (map_idx) { case 0: MapInputDefault(); break; case 1: MapInputReverse(); break; } return true; } return false; } void ShowStyleEditor(ImPlotStyle* ref) { ImPlotContext& gp = *GImPlot; ImPlotStyle& style = GetStyle(); static ImPlotStyle ref_saved_style; // Default to using internal storage as reference static bool init = true; if (init && ref == nullptr) ref_saved_style = style; init = false; if (ref == nullptr) ref = &ref_saved_style; if (ImPlot::ShowStyleSelector("Colors##Selector")) ref_saved_style = style; // Save/Revert button if (ImGui::Button("Save Ref")) *ref = ref_saved_style = style; ImGui::SameLine(); if (ImGui::Button("Revert Ref")) style = *ref; ImGui::SameLine(); HelpMarker("Save/Revert in local non-persistent storage. Default Colors definition are not affected. " "Use \"Export\" below to save them somewhere."); if (ImGui::BeginTabBar("##StyleEditor")) { if (ImGui::BeginTabItem("Variables")) { ImGui::Text("Item Styling"); ImGui::SliderFloat("LineWeight", &style.LineWeight, 0.0f, 5.0f, "%.1f"); ImGui::SliderFloat("MarkerSize", &style.MarkerSize, 2.0f, 10.0f, "%.1f"); ImGui::SliderFloat("MarkerWeight", &style.MarkerWeight, 0.0f, 5.0f, "%.1f"); ImGui::SliderFloat("FillAlpha", &style.FillAlpha, 0.0f, 1.0f, "%.2f"); ImGui::SliderFloat("ErrorBarSize", &style.ErrorBarSize, 0.0f, 10.0f, "%.1f"); ImGui::SliderFloat("ErrorBarWeight", &style.ErrorBarWeight, 0.0f, 5.0f, "%.1f"); ImGui::SliderFloat("DigitalBitHeight", &style.DigitalBitHeight, 0.0f, 20.0f, "%.1f"); ImGui::SliderFloat("DigitalBitGap", &style.DigitalBitGap, 0.0f, 20.0f, "%.1f"); ImGui::Text("Plot Styling"); ImGui::SliderFloat("PlotBorderSize", &style.PlotBorderSize, 0.0f, 2.0f, "%.0f"); ImGui::SliderFloat("MinorAlpha", &style.MinorAlpha, 0.0f, 1.0f, "%.2f"); ImGui::SliderFloat2("MajorTickLen", (float*)&style.MajorTickLen, 0.0f, 20.0f, "%.0f"); ImGui::SliderFloat2("MinorTickLen", (float*)&style.MinorTickLen, 0.0f, 20.0f, "%.0f"); ImGui::SliderFloat2("MajorTickSize", (float*)&style.MajorTickSize, 0.0f, 2.0f, "%.1f"); ImGui::SliderFloat2("MinorTickSize", (float*)&style.MinorTickSize, 0.0f, 2.0f, "%.1f"); ImGui::SliderFloat2("MajorGridSize", (float*)&style.MajorGridSize, 0.0f, 2.0f, "%.1f"); ImGui::SliderFloat2("MinorGridSize", (float*)&style.MinorGridSize, 0.0f, 2.0f, "%.1f"); ImGui::SliderFloat2("PlotDefaultSize", (float*)&style.PlotDefaultSize, 0.0f, 1000, "%.0f"); ImGui::SliderFloat2("PlotMinSize", (float*)&style.PlotMinSize, 0.0f, 300, "%.0f"); ImGui::Text("Plot Padding"); ImGui::SliderFloat2("PlotPadding", (float*)&style.PlotPadding, 0.0f, 20.0f, "%.0f"); ImGui::SliderFloat2("LabelPadding", (float*)&style.LabelPadding, 0.0f, 20.0f, "%.0f"); ImGui::SliderFloat2("LegendPadding", (float*)&style.LegendPadding, 0.0f, 20.0f, "%.0f"); ImGui::SliderFloat2("LegendInnerPadding", (float*)&style.LegendInnerPadding, 0.0f, 10.0f, "%.0f"); ImGui::SliderFloat2("LegendSpacing", (float*)&style.LegendSpacing, 0.0f, 5.0f, "%.0f"); ImGui::SliderFloat2("MousePosPadding", (float*)&style.MousePosPadding, 0.0f, 20.0f, "%.0f"); ImGui::SliderFloat2("AnnotationPadding", (float*)&style.AnnotationPadding, 0.0f, 5.0f, "%.0f"); ImGui::SliderFloat2("FitPadding", (float*)&style.FitPadding, 0, 0.2f, "%.2f"); ImGui::EndTabItem(); } if (ImGui::BeginTabItem("Colors")) { static int output_dest = 0; static bool output_only_modified = false; if (ImGui::Button("Export", ImVec2(75,0))) { if (output_dest == 0) ImGui::LogToClipboard(); else ImGui::LogToTTY(); ImGui::LogText("ImVec4* colors = ImPlot::GetStyle().Colors;\n"); for (int i = 0; i < ImPlotCol_COUNT; i++) { const ImVec4& col = style.Colors[i]; const char* name = ImPlot::GetStyleColorName(i); if (!output_only_modified || memcmp(&col, &ref->Colors[i], sizeof(ImVec4)) != 0) { if (IsColorAuto(i)) ImGui::LogText("colors[ImPlotCol_%s]%*s= IMPLOT_AUTO_COL;\n",name,14 - (int)strlen(name), ""); else ImGui::LogText("colors[ImPlotCol_%s]%*s= ImVec4(%.2ff, %.2ff, %.2ff, %.2ff);\n", name, 14 - (int)strlen(name), "", col.x, col.y, col.z, col.w); } } ImGui::LogFinish(); } ImGui::SameLine(); ImGui::SetNextItemWidth(120); ImGui::Combo("##output_type", &output_dest, "To Clipboard\0To TTY\0"); ImGui::SameLine(); ImGui::Checkbox("Only Modified Colors", &output_only_modified); static ImGuiTextFilter filter; filter.Draw("Filter colors", ImGui::GetFontSize() * 16); static ImGuiColorEditFlags alpha_flags = ImGuiColorEditFlags_AlphaPreviewHalf; if (ImGui::RadioButton("Opaque", alpha_flags == ImGuiColorEditFlags_AlphaOpaque)) { alpha_flags = ImGuiColorEditFlags_AlphaOpaque; } ImGui::SameLine(); if (ImGui::RadioButton("Alpha", alpha_flags == ImGuiColorEditFlags_None)) { alpha_flags = ImGuiColorEditFlags_None; } ImGui::SameLine(); if (ImGui::RadioButton("Both", alpha_flags == ImGuiColorEditFlags_AlphaPreviewHalf)) { alpha_flags = ImGuiColorEditFlags_AlphaPreviewHalf; } ImGui::SameLine(); HelpMarker( "In the color list:\n" "Left-click on colored square to open color picker,\n" "Right-click to open edit options menu."); ImGui::Separator(); ImGui::PushItemWidth(-160); for (int i = 0; i < ImPlotCol_COUNT; i++) { const char* name = ImPlot::GetStyleColorName(i); if (!filter.PassFilter(name)) continue; ImGui::PushID(i); ImVec4 temp = GetStyleColorVec4(i); const bool is_auto = IsColorAuto(i); if (!is_auto) ImGui::PushStyleVar(ImGuiStyleVar_Alpha, 0.25f); if (ImGui::Button("Auto")) { if (is_auto) style.Colors[i] = temp; else style.Colors[i] = IMPLOT_AUTO_COL; BustItemCache(); } if (!is_auto) ImGui::PopStyleVar(); ImGui::SameLine(); if (ImGui::ColorEdit4(name, &temp.x, ImGuiColorEditFlags_NoInputs | alpha_flags)) { style.Colors[i] = temp; BustItemCache(); } if (memcmp(&style.Colors[i], &ref->Colors[i], sizeof(ImVec4)) != 0) { ImGui::SameLine(175); if (ImGui::Button("Save")) { ref->Colors[i] = style.Colors[i]; } ImGui::SameLine(); if (ImGui::Button("Revert")) { style.Colors[i] = ref->Colors[i]; BustItemCache(); } } ImGui::PopID(); } ImGui::PopItemWidth(); ImGui::Separator(); ImGui::Text("Colors that are set to Auto (i.e. IMPLOT_AUTO_COL) will\n" "be automatically deduced from your ImGui style or the\n" "current ImPlot Colormap. If you want to style individual\n" "plot items, use Push/PopStyleColor around its function."); ImGui::EndTabItem(); } if (ImGui::BeginTabItem("Colormaps")) { static int output_dest = 0; if (ImGui::Button("Export", ImVec2(75,0))) { if (output_dest == 0) ImGui::LogToClipboard(); else ImGui::LogToTTY(); int size = GetColormapSize(); const char* name = GetColormapName(gp.Style.Colormap); ImGui::LogText("static const ImU32 %s_Data[%d] = {\n", name, size); for (int i = 0; i < size; ++i) { ImU32 col = GetColormapColorU32(i,gp.Style.Colormap); ImGui::LogText(" %u%s\n", col, i == size - 1 ? "" : ","); } ImGui::LogText("};\nImPlotColormap %s = ImPlot::AddColormap(\"%s\", %s_Data, %d);", name, name, name, size); ImGui::LogFinish(); } ImGui::SameLine(); ImGui::SetNextItemWidth(120); ImGui::Combo("##output_type", &output_dest, "To Clipboard\0To TTY\0"); ImGui::SameLine(); static bool edit = false; ImGui::Checkbox("Edit Mode",&edit); // built-in/added ImGui::Separator(); for (int i = 0; i < gp.ColormapData.Count; ++i) { ImGui::PushID(i); int size = gp.ColormapData.GetKeyCount(i); bool selected = i == gp.Style.Colormap; const char* name = GetColormapName(i); if (!selected) ImGui::PushStyleVar(ImGuiStyleVar_Alpha, 0.25f); if (ImGui::Button(name, ImVec2(100,0))) { gp.Style.Colormap = i; BustItemCache(); } if (!selected) ImGui::PopStyleVar(); ImGui::SameLine(); ImGui::BeginGroup(); if (edit) { for (int c = 0; c < size; ++c) { ImGui::PushID(c); ImVec4 col4 = ImGui::ColorConvertU32ToFloat4(gp.ColormapData.GetKeyColor(i,c)); if (ImGui::ColorEdit4("",&col4.x,ImGuiColorEditFlags_NoInputs)) { ImU32 col32 = ImGui::ColorConvertFloat4ToU32(col4); gp.ColormapData.SetKeyColor(i,c,col32); BustItemCache(); } if ((c + 1) % 12 != 0 && c != size -1) ImGui::SameLine(); ImGui::PopID(); } } else { if (ImPlot::ColormapButton("##",ImVec2(-1,0),i)) edit = true; } ImGui::EndGroup(); ImGui::PopID(); } static ImVector custom; if (custom.Size == 0) { custom.push_back(ImVec4(1,0,0,1)); custom.push_back(ImVec4(0,1,0,1)); custom.push_back(ImVec4(0,0,1,1)); } ImGui::Separator(); ImGui::BeginGroup(); static char name[16] = "MyColormap"; if (ImGui::Button("+", ImVec2((100 - ImGui::GetStyle().ItemSpacing.x)/2,0))) custom.push_back(ImVec4(0,0,0,1)); ImGui::SameLine(); if (ImGui::Button("-", ImVec2((100 - ImGui::GetStyle().ItemSpacing.x)/2,0)) && custom.Size > 2) custom.pop_back(); ImGui::SetNextItemWidth(100); ImGui::InputText("##Name",name,16,ImGuiInputTextFlags_CharsNoBlank); static bool qual = true; ImGui::Checkbox("Qualitative",&qual); if (ImGui::Button("Add", ImVec2(100, 0)) && gp.ColormapData.GetIndex(name)==-1) AddColormap(name,custom.Data,custom.Size,qual); ImGui::EndGroup(); ImGui::SameLine(); ImGui::BeginGroup(); for (int c = 0; c < custom.Size; ++c) { ImGui::PushID(c); if (ImGui::ColorEdit4("##Col1", &custom[c].x, ImGuiColorEditFlags_NoInputs)) { } if ((c + 1) % 12 != 0) ImGui::SameLine(); ImGui::PopID(); } ImGui::EndGroup(); ImGui::EndTabItem(); } ImGui::EndTabBar(); } } void ShowUserGuide() { ImGui::BulletText("Left-click drag within the plot area to pan X and Y axes."); ImGui::Indent(); ImGui::BulletText("Left-click drag on axis labels to pan an individual axis."); ImGui::Unindent(); ImGui::BulletText("Scroll in the plot area to zoom both X any Y axes."); ImGui::Indent(); ImGui::BulletText("Scroll on axis labels to zoom an individual axis."); ImGui::Unindent(); ImGui::BulletText("Right-click drag to box select data."); ImGui::Indent(); ImGui::BulletText("Hold Alt to expand box selection horizontally."); ImGui::BulletText("Hold Shift to expand box selection vertically."); ImGui::BulletText("Left-click while box selecting to cancel the selection."); ImGui::Unindent(); ImGui::BulletText("Double left-click to fit all visible data."); ImGui::Indent(); ImGui::BulletText("Double left-click axis labels to fit the individual axis."); ImGui::Unindent(); ImGui::BulletText("Right-click open the full plot context menu."); ImGui::Indent(); ImGui::BulletText("Right-click axis labels to open an individual axis context menu."); ImGui::Unindent(); ImGui::BulletText("Click legend label icons to show/hide plot items."); } void ShowTicksMetrics(const ImPlotTicker& ticker) { ImGui::BulletText("Size: %d", ticker.TickCount()); ImGui::BulletText("MaxSize: [%f,%f]", ticker.MaxSize.x, ticker.MaxSize.y); } void ShowAxisMetrics(const ImPlotPlot& plot, const ImPlotAxis& axis) { ImGui::BulletText("Label: %s", axis.LabelOffset == -1 ? "[none]" : plot.GetAxisLabel(axis)); ImGui::BulletText("Flags: 0x%08X", axis.Flags); ImGui::BulletText("Range: [%f,%f]",axis.Range.Min, axis.Range.Max); ImGui::BulletText("Pixels: %f", axis.PixelSize()); ImGui::BulletText("Aspect: %f", axis.GetAspect()); ImGui::BulletText(axis.OrthoAxis == nullptr ? "OrtherAxis: NULL" : "OrthoAxis: 0x%08X", axis.OrthoAxis->ID); ImGui::BulletText("LinkedMin: %p", (void*)axis.LinkedMin); ImGui::BulletText("LinkedMax: %p", (void*)axis.LinkedMax); ImGui::BulletText("HasRange: %s", axis.HasRange ? "true" : "false"); ImGui::BulletText("Hovered: %s", axis.Hovered ? "true" : "false"); ImGui::BulletText("Held: %s", axis.Held ? "true" : "false"); if (ImGui::TreeNode("Transform")) { ImGui::BulletText("PixelMin: %f", axis.PixelMin); ImGui::BulletText("PixelMax: %f", axis.PixelMax); ImGui::BulletText("ScaleToPixel: %f", axis.ScaleToPixel); ImGui::BulletText("ScaleMax: %f", axis.ScaleMax); ImGui::TreePop(); } if (ImGui::TreeNode("Ticks")) { ShowTicksMetrics(axis.Ticker); ImGui::TreePop(); } } void ShowMetricsWindow(bool* p_popen) { static bool show_plot_rects = false; static bool show_axes_rects = false; static bool show_axis_rects = false; static bool show_canvas_rects = false; static bool show_frame_rects = false; static bool show_subplot_frame_rects = false; static bool show_subplot_grid_rects = false; ImDrawList& fg = *ImGui::GetForegroundDrawList(); ImPlotContext& gp = *GImPlot; // ImGuiContext& g = *GImGui; ImGuiIO& io = ImGui::GetIO(); ImGui::Begin("ImPlot Metrics", p_popen); ImGui::Text("ImPlot " IMPLOT_VERSION); ImGui::Text("Application average %.3f ms/frame (%.1f FPS)", 1000.0f / io.Framerate, io.Framerate); ImGui::Text("Mouse Position: [%.0f,%.0f]", io.MousePos.x, io.MousePos.y); ImGui::Separator(); if (ImGui::TreeNode("Tools")) { if (ImGui::Button("Bust Plot Cache")) BustPlotCache(); ImGui::SameLine(); if (ImGui::Button("Bust Item Cache")) BustItemCache(); ImGui::Checkbox("Show Frame Rects", &show_frame_rects); ImGui::Checkbox("Show Canvas Rects",&show_canvas_rects); ImGui::Checkbox("Show Plot Rects", &show_plot_rects); ImGui::Checkbox("Show Axes Rects", &show_axes_rects); ImGui::Checkbox("Show Axis Rects", &show_axis_rects); ImGui::Checkbox("Show Subplot Frame Rects", &show_subplot_frame_rects); ImGui::Checkbox("Show Subplot Grid Rects", &show_subplot_grid_rects); ImGui::TreePop(); } const int n_plots = gp.Plots.GetBufSize(); const int n_subplots = gp.Subplots.GetBufSize(); // render rects for (int p = 0; p < n_plots; ++p) { ImPlotPlot* plot = gp.Plots.GetByIndex(p); if (show_frame_rects) fg.AddRect(plot->FrameRect.Min, plot->FrameRect.Max, IM_COL32(255,0,255,255)); if (show_canvas_rects) fg.AddRect(plot->CanvasRect.Min, plot->CanvasRect.Max, IM_COL32(0,255,255,255)); if (show_plot_rects) fg.AddRect(plot->PlotRect.Min, plot->PlotRect.Max, IM_COL32(255,255,0,255)); if (show_axes_rects) fg.AddRect(plot->AxesRect.Min, plot->AxesRect.Max, IM_COL32(0,255,128,255)); if (show_axis_rects) { for (int i = 0; i < ImAxis_COUNT; ++i) { if (plot->Axes[i].Enabled) fg.AddRect(plot->Axes[i].HoverRect.Min, plot->Axes[i].HoverRect.Max, IM_COL32(0,255,0,255)); } } } for (int p = 0; p < n_subplots; ++p) { ImPlotSubplot* subplot = gp.Subplots.GetByIndex(p); if (show_subplot_frame_rects) fg.AddRect(subplot->FrameRect.Min, subplot->FrameRect.Max, IM_COL32(255,0,0,255)); if (show_subplot_grid_rects) fg.AddRect(subplot->GridRect.Min, subplot->GridRect.Max, IM_COL32(0,0,255,255)); } if (ImGui::TreeNode("Plots","Plots (%d)", n_plots)) { for (int p = 0; p < n_plots; ++p) { // plot ImPlotPlot& plot = *gp.Plots.GetByIndex(p); ImGui::PushID(p); if (ImGui::TreeNode("Plot", "Plot [0x%08X]", plot.ID)) { int n_items = plot.Items.GetItemCount(); if (ImGui::TreeNode("Items", "Items (%d)", n_items)) { for (int i = 0; i < n_items; ++i) { ImPlotItem* item = plot.Items.GetItemByIndex(i); ImGui::PushID(i); if (ImGui::TreeNode("Item", "Item [0x%08X]", item->ID)) { ImGui::Bullet(); ImGui::Checkbox("Show", &item->Show); ImGui::Bullet(); ImVec4 temp = ImGui::ColorConvertU32ToFloat4(item->Color); if (ImGui::ColorEdit4("Color",&temp.x, ImGuiColorEditFlags_NoInputs)) item->Color = ImGui::ColorConvertFloat4ToU32(temp); ImGui::BulletText("NameOffset: %d",item->NameOffset); ImGui::BulletText("Name: %s", item->NameOffset != -1 ? plot.Items.Legend.Labels.Buf.Data + item->NameOffset : "N/A"); ImGui::BulletText("Hovered: %s",item->LegendHovered ? "true" : "false"); ImGui::TreePop(); } ImGui::PopID(); } ImGui::TreePop(); } char buff[16]; for (int i = 0; i < IMPLOT_NUM_X_AXES; ++i) { ImFormatString(buff,16,"X-Axis %d", i+1); if (plot.XAxis(i).Enabled && ImGui::TreeNode(buff, "X-Axis %d [0x%08X]", i+1, plot.XAxis(i).ID)) { ShowAxisMetrics(plot, plot.XAxis(i)); ImGui::TreePop(); } } for (int i = 0; i < IMPLOT_NUM_Y_AXES; ++i) { ImFormatString(buff,16,"Y-Axis %d", i+1); if (plot.YAxis(i).Enabled && ImGui::TreeNode(buff, "Y-Axis %d [0x%08X]", i+1, plot.YAxis(i).ID)) { ShowAxisMetrics(plot, plot.YAxis(i)); ImGui::TreePop(); } } ImGui::BulletText("Title: %s", plot.HasTitle() ? plot.GetTitle() : "none"); ImGui::BulletText("Flags: 0x%08X", plot.Flags); ImGui::BulletText("Initialized: %s", plot.Initialized ? "true" : "false"); ImGui::BulletText("Selecting: %s", plot.Selecting ? "true" : "false"); ImGui::BulletText("Selected: %s", plot.Selected ? "true" : "false"); ImGui::BulletText("Hovered: %s", plot.Hovered ? "true" : "false"); ImGui::BulletText("Held: %s", plot.Held ? "true" : "false"); ImGui::BulletText("LegendHovered: %s", plot.Items.Legend.Hovered ? "true" : "false"); ImGui::BulletText("ContextLocked: %s", plot.ContextLocked ? "true" : "false"); ImGui::TreePop(); } ImGui::PopID(); } ImGui::TreePop(); } if (ImGui::TreeNode("Subplots","Subplots (%d)", n_subplots)) { for (int p = 0; p < n_subplots; ++p) { // plot ImPlotSubplot& plot = *gp.Subplots.GetByIndex(p); ImGui::PushID(p); if (ImGui::TreeNode("Subplot", "Subplot [0x%08X]", plot.ID)) { int n_items = plot.Items.GetItemCount(); if (ImGui::TreeNode("Items", "Items (%d)", n_items)) { for (int i = 0; i < n_items; ++i) { ImPlotItem* item = plot.Items.GetItemByIndex(i); ImGui::PushID(i); if (ImGui::TreeNode("Item", "Item [0x%08X]", item->ID)) { ImGui::Bullet(); ImGui::Checkbox("Show", &item->Show); ImGui::Bullet(); ImVec4 temp = ImGui::ColorConvertU32ToFloat4(item->Color); if (ImGui::ColorEdit4("Color",&temp.x, ImGuiColorEditFlags_NoInputs)) item->Color = ImGui::ColorConvertFloat4ToU32(temp); ImGui::BulletText("NameOffset: %d",item->NameOffset); ImGui::BulletText("Name: %s", item->NameOffset != -1 ? plot.Items.Legend.Labels.Buf.Data + item->NameOffset : "N/A"); ImGui::BulletText("Hovered: %s",item->LegendHovered ? "true" : "false"); ImGui::TreePop(); } ImGui::PopID(); } ImGui::TreePop(); } ImGui::BulletText("Flags: 0x%08X", plot.Flags); ImGui::BulletText("FrameHovered: %s", plot.FrameHovered ? "true" : "false"); ImGui::BulletText("LegendHovered: %s", plot.Items.Legend.Hovered ? "true" : "false"); ImGui::TreePop(); } ImGui::PopID(); } ImGui::TreePop(); } if (ImGui::TreeNode("Colormaps")) { ImGui::BulletText("Colormaps: %d", gp.ColormapData.Count); ImGui::BulletText("Memory: %d bytes", gp.ColormapData.Tables.Size * 4); if (ImGui::TreeNode("Data")) { for (int m = 0; m < gp.ColormapData.Count; ++m) { if (ImGui::TreeNode(gp.ColormapData.GetName(m))) { int count = gp.ColormapData.GetKeyCount(m); int size = gp.ColormapData.GetTableSize(m); bool qual = gp.ColormapData.IsQual(m); ImGui::BulletText("Qualitative: %s", qual ? "true" : "false"); ImGui::BulletText("Key Count: %d", count); ImGui::BulletText("Table Size: %d", size); ImGui::Indent(); static float t = 0.5; ImVec4 samp; float wid = 32 * 10 - ImGui::GetFrameHeight() - ImGui::GetStyle().ItemSpacing.x; ImGui::SetNextItemWidth(wid); ImPlot::ColormapSlider("##Sample",&t,&samp,"%.3f",m); ImGui::SameLine(); ImGui::ColorButton("Sampler",samp); ImGui::PushStyleColor(ImGuiCol_FrameBg, ImVec4(0,0,0,0)); ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, ImVec2(0,0)); for (int c = 0; c < size; ++c) { ImVec4 col = ImGui::ColorConvertU32ToFloat4(gp.ColormapData.GetTableColor(m,c)); ImGui::PushID(m*1000+c); ImGui::ColorButton("",col,0,ImVec2(10,10)); ImGui::PopID(); if ((c + 1) % 32 != 0 && c != size - 1) ImGui::SameLine(); } ImGui::PopStyleVar(); ImGui::PopStyleColor(); ImGui::Unindent(); ImGui::TreePop(); } } ImGui::TreePop(); } ImGui::TreePop(); } ImGui::End(); } bool ShowDatePicker(const char* id, int* level, ImPlotTime* t, const ImPlotTime* t1, const ImPlotTime* t2) { ImGui::PushID(id); ImGui::BeginGroup(); ImGuiStyle& style = ImGui::GetStyle(); ImVec4 col_txt = style.Colors[ImGuiCol_Text]; ImVec4 col_dis = style.Colors[ImGuiCol_TextDisabled]; ImVec4 col_btn = style.Colors[ImGuiCol_Button]; ImGui::PushStyleColor(ImGuiCol_Button, ImVec4(0,0,0,0)); ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, ImVec2(0,0)); const float ht = ImGui::GetFrameHeight(); ImVec2 cell_size(ht*1.25f,ht); char buff[32]; bool clk = false; tm& Tm = GImPlot->Tm; const int min_yr = 1970; const int max_yr = 2999; // t1 parts int t1_mo = 0; int t1_md = 0; int t1_yr = 0; if (t1 != nullptr) { GetTime(*t1,&Tm); t1_mo = Tm.tm_mon; t1_md = Tm.tm_mday; t1_yr = Tm.tm_year + 1900; } // t2 parts int t2_mo = 0; int t2_md = 0; int t2_yr = 0; if (t2 != nullptr) { GetTime(*t2,&Tm); t2_mo = Tm.tm_mon; t2_md = Tm.tm_mday; t2_yr = Tm.tm_year + 1900; } // day widget if (*level == 0) { *t = FloorTime(*t, ImPlotTimeUnit_Day); GetTime(*t, &Tm); const int this_year = Tm.tm_year + 1900; const int last_year = this_year - 1; const int next_year = this_year + 1; const int this_mon = Tm.tm_mon; const int last_mon = this_mon == 0 ? 11 : this_mon - 1; const int next_mon = this_mon == 11 ? 0 : this_mon + 1; const int days_this_mo = GetDaysInMonth(this_year, this_mon); const int days_last_mo = GetDaysInMonth(this_mon == 0 ? last_year : this_year, last_mon); ImPlotTime t_first_mo = FloorTime(*t,ImPlotTimeUnit_Mo); GetTime(t_first_mo,&Tm); const int first_wd = Tm.tm_wday; // month year ImFormatString(buff, 32, "%s %d", MONTH_NAMES[this_mon], this_year); if (ImGui::Button(buff)) *level = 1; ImGui::SameLine(5*cell_size.x); BeginDisabledControls(this_year <= min_yr && this_mon == 0); if (ImGui::ArrowButtonEx("##Up",ImGuiDir_Up,cell_size)) *t = AddTime(*t, ImPlotTimeUnit_Mo, -1); EndDisabledControls(this_year <= min_yr && this_mon == 0); ImGui::SameLine(); BeginDisabledControls(this_year >= max_yr && this_mon == 11); if (ImGui::ArrowButtonEx("##Down",ImGuiDir_Down,cell_size)) *t = AddTime(*t, ImPlotTimeUnit_Mo, 1); EndDisabledControls(this_year >= max_yr && this_mon == 11); // render weekday abbreviations ImGui::PushItemFlag(ImGuiItemFlags_Disabled, true); for (int i = 0; i < 7; ++i) { ImGui::Button(WD_ABRVS[i],cell_size); if (i != 6) { ImGui::SameLine(); } } ImGui::PopItemFlag(); // 0 = last mo, 1 = this mo, 2 = next mo int mo = first_wd > 0 ? 0 : 1; int day = mo == 1 ? 1 : days_last_mo - first_wd + 1; for (int i = 0; i < 6; ++i) { for (int j = 0; j < 7; ++j) { if (mo == 0 && day > days_last_mo) { mo = 1; day = 1; } else if (mo == 1 && day > days_this_mo) { mo = 2; day = 1; } const int now_yr = (mo == 0 && this_mon == 0) ? last_year : ((mo == 2 && this_mon == 11) ? next_year : this_year); const int now_mo = mo == 0 ? last_mon : (mo == 1 ? this_mon : next_mon); const int now_md = day; const bool off_mo = mo == 0 || mo == 2; const bool t1_or_t2 = (t1 != nullptr && t1_mo == now_mo && t1_yr == now_yr && t1_md == now_md) || (t2 != nullptr && t2_mo == now_mo && t2_yr == now_yr && t2_md == now_md); if (off_mo) ImGui::PushStyleColor(ImGuiCol_Text, col_dis); if (t1_or_t2) { ImGui::PushStyleColor(ImGuiCol_Button, col_btn); ImGui::PushStyleColor(ImGuiCol_Text, col_txt); } ImGui::PushID(i*7+j); ImFormatString(buff,32,"%d",day); if (now_yr == min_yr-1 || now_yr == max_yr+1) { ImGui::Dummy(cell_size); } else if (ImGui::Button(buff,cell_size) && !clk) { *t = MakeTime(now_yr, now_mo, now_md); clk = true; } ImGui::PopID(); if (t1_or_t2) ImGui::PopStyleColor(2); if (off_mo) ImGui::PopStyleColor(); if (j != 6) ImGui::SameLine(); day++; } } } // month widget else if (*level == 1) { *t = FloorTime(*t, ImPlotTimeUnit_Mo); GetTime(*t, &Tm); int this_yr = Tm.tm_year + 1900; ImFormatString(buff, 32, "%d", this_yr); if (ImGui::Button(buff)) *level = 2; BeginDisabledControls(this_yr <= min_yr); ImGui::SameLine(5*cell_size.x); if (ImGui::ArrowButtonEx("##Up",ImGuiDir_Up,cell_size)) *t = AddTime(*t, ImPlotTimeUnit_Yr, -1); EndDisabledControls(this_yr <= min_yr); ImGui::SameLine(); BeginDisabledControls(this_yr >= max_yr); if (ImGui::ArrowButtonEx("##Down",ImGuiDir_Down,cell_size)) *t = AddTime(*t, ImPlotTimeUnit_Yr, 1); EndDisabledControls(this_yr >= max_yr); // ImGui::Dummy(cell_size); cell_size.x *= 7.0f/4.0f; cell_size.y *= 7.0f/3.0f; int mo = 0; for (int i = 0; i < 3; ++i) { for (int j = 0; j < 4; ++j) { const bool t1_or_t2 = (t1 != nullptr && t1_yr == this_yr && t1_mo == mo) || (t2 != nullptr && t2_yr == this_yr && t2_mo == mo); if (t1_or_t2) ImGui::PushStyleColor(ImGuiCol_Button, col_btn); if (ImGui::Button(MONTH_ABRVS[mo],cell_size) && !clk) { *t = MakeTime(this_yr, mo); *level = 0; } if (t1_or_t2) ImGui::PopStyleColor(); if (j != 3) ImGui::SameLine(); mo++; } } } else if (*level == 2) { *t = FloorTime(*t, ImPlotTimeUnit_Yr); int this_yr = GetYear(*t); int yr = this_yr - this_yr % 20; ImGui::PushItemFlag(ImGuiItemFlags_Disabled, true); ImFormatString(buff,32,"%d-%d",yr,yr+19); ImGui::Button(buff); ImGui::PopItemFlag(); ImGui::SameLine(5*cell_size.x); BeginDisabledControls(yr <= min_yr); if (ImGui::ArrowButtonEx("##Up",ImGuiDir_Up,cell_size)) *t = MakeTime(yr-20); EndDisabledControls(yr <= min_yr); ImGui::SameLine(); BeginDisabledControls(yr + 20 >= max_yr); if (ImGui::ArrowButtonEx("##Down",ImGuiDir_Down,cell_size)) *t = MakeTime(yr+20); EndDisabledControls(yr+ 20 >= max_yr); // ImGui::Dummy(cell_size); cell_size.x *= 7.0f/4.0f; cell_size.y *= 7.0f/5.0f; for (int i = 0; i < 5; ++i) { for (int j = 0; j < 4; ++j) { const bool t1_or_t2 = (t1 != nullptr && t1_yr == yr) || (t2 != nullptr && t2_yr == yr); if (t1_or_t2) ImGui::PushStyleColor(ImGuiCol_Button, col_btn); ImFormatString(buff,32,"%d",yr); if (yr<1970||yr>3000) { ImGui::Dummy(cell_size); } else if (ImGui::Button(buff,cell_size)) { *t = MakeTime(yr); *level = 1; } if (t1_or_t2) ImGui::PopStyleColor(); if (j != 3) ImGui::SameLine(); yr++; } } } ImGui::PopStyleVar(); ImGui::PopStyleColor(); ImGui::EndGroup(); ImGui::PopID(); return clk; } bool ShowTimePicker(const char* id, ImPlotTime* t) { ImPlotContext& gp = *GImPlot; ImGui::PushID(id); tm& Tm = gp.Tm; GetTime(*t,&Tm); static const char* nums[] = { "00","01","02","03","04","05","06","07","08","09", "10","11","12","13","14","15","16","17","18","19", "20","21","22","23","24","25","26","27","28","29", "30","31","32","33","34","35","36","37","38","39", "40","41","42","43","44","45","46","47","48","49", "50","51","52","53","54","55","56","57","58","59"}; static const char* am_pm[] = {"am","pm"}; bool hour24 = gp.Style.Use24HourClock; int hr = hour24 ? Tm.tm_hour : ((Tm.tm_hour == 0 || Tm.tm_hour == 12) ? 12 : Tm.tm_hour % 12); int min = Tm.tm_min; int sec = Tm.tm_sec; int ap = Tm.tm_hour < 12 ? 0 : 1; bool changed = false; ImVec2 spacing = ImGui::GetStyle().ItemSpacing; spacing.x = 0; float width = ImGui::CalcTextSize("888").x; float height = ImGui::GetFrameHeight(); ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, spacing); ImGui::PushStyleVar(ImGuiStyleVar_ScrollbarSize,2.0f); ImGui::PushStyleColor(ImGuiCol_FrameBg, ImVec4(0,0,0,0)); ImGui::PushStyleColor(ImGuiCol_Button, ImVec4(0,0,0,0)); ImGui::PushStyleColor(ImGuiCol_FrameBgHovered, ImGui::GetStyleColorVec4(ImGuiCol_ButtonHovered)); ImGui::SetNextItemWidth(width); if (ImGui::BeginCombo("##hr",nums[hr],ImGuiComboFlags_NoArrowButton)) { const int ia = hour24 ? 0 : 1; const int ib = hour24 ? 24 : 13; for (int i = ia; i < ib; ++i) { if (ImGui::Selectable(nums[i],i==hr)) { hr = i; changed = true; } } ImGui::EndCombo(); } ImGui::SameLine(); ImGui::Text(":"); ImGui::SameLine(); ImGui::SetNextItemWidth(width); if (ImGui::BeginCombo("##min",nums[min],ImGuiComboFlags_NoArrowButton)) { for (int i = 0; i < 60; ++i) { if (ImGui::Selectable(nums[i],i==min)) { min = i; changed = true; } } ImGui::EndCombo(); } ImGui::SameLine(); ImGui::Text(":"); ImGui::SameLine(); ImGui::SetNextItemWidth(width); if (ImGui::BeginCombo("##sec",nums[sec],ImGuiComboFlags_NoArrowButton)) { for (int i = 0; i < 60; ++i) { if (ImGui::Selectable(nums[i],i==sec)) { sec = i; changed = true; } } ImGui::EndCombo(); } if (!hour24) { ImGui::SameLine(); if (ImGui::Button(am_pm[ap],ImVec2(0,height))) { ap = 1 - ap; changed = true; } } ImGui::PopStyleColor(3); ImGui::PopStyleVar(2); ImGui::PopID(); if (changed) { if (!hour24) hr = hr % 12 + ap * 12; Tm.tm_hour = hr; Tm.tm_min = min; Tm.tm_sec = sec; *t = MkTime(&Tm); } return changed; } void StyleColorsAuto(ImPlotStyle* dst) { ImPlotStyle* style = dst ? dst : &ImPlot::GetStyle(); ImVec4* colors = style->Colors; style->MinorAlpha = 0.25f; colors[ImPlotCol_Line] = IMPLOT_AUTO_COL; colors[ImPlotCol_Fill] = IMPLOT_AUTO_COL; colors[ImPlotCol_MarkerOutline] = IMPLOT_AUTO_COL; colors[ImPlotCol_MarkerFill] = IMPLOT_AUTO_COL; colors[ImPlotCol_ErrorBar] = IMPLOT_AUTO_COL; colors[ImPlotCol_FrameBg] = IMPLOT_AUTO_COL; colors[ImPlotCol_PlotBg] = IMPLOT_AUTO_COL; colors[ImPlotCol_PlotBorder] = IMPLOT_AUTO_COL; colors[ImPlotCol_LegendBg] = IMPLOT_AUTO_COL; colors[ImPlotCol_LegendBorder] = IMPLOT_AUTO_COL; colors[ImPlotCol_LegendText] = IMPLOT_AUTO_COL; colors[ImPlotCol_TitleText] = IMPLOT_AUTO_COL; colors[ImPlotCol_InlayText] = IMPLOT_AUTO_COL; colors[ImPlotCol_PlotBorder] = IMPLOT_AUTO_COL; colors[ImPlotCol_AxisText] = IMPLOT_AUTO_COL; colors[ImPlotCol_AxisGrid] = IMPLOT_AUTO_COL; colors[ImPlotCol_AxisTick] = IMPLOT_AUTO_COL; colors[ImPlotCol_AxisBg] = IMPLOT_AUTO_COL; colors[ImPlotCol_AxisBgHovered] = IMPLOT_AUTO_COL; colors[ImPlotCol_AxisBgActive] = IMPLOT_AUTO_COL; colors[ImPlotCol_Selection] = IMPLOT_AUTO_COL; colors[ImPlotCol_Crosshairs] = IMPLOT_AUTO_COL; } void StyleColorsClassic(ImPlotStyle* dst) { ImPlotStyle* style = dst ? dst : &ImPlot::GetStyle(); ImVec4* colors = style->Colors; style->MinorAlpha = 0.5f; colors[ImPlotCol_Line] = IMPLOT_AUTO_COL; colors[ImPlotCol_Fill] = IMPLOT_AUTO_COL; colors[ImPlotCol_MarkerOutline] = IMPLOT_AUTO_COL; colors[ImPlotCol_MarkerFill] = IMPLOT_AUTO_COL; colors[ImPlotCol_ErrorBar] = ImVec4(0.90f, 0.90f, 0.90f, 1.00f); colors[ImPlotCol_FrameBg] = ImVec4(0.43f, 0.43f, 0.43f, 0.39f); colors[ImPlotCol_PlotBg] = ImVec4(0.00f, 0.00f, 0.00f, 0.35f); colors[ImPlotCol_PlotBorder] = ImVec4(0.50f, 0.50f, 0.50f, 0.50f); colors[ImPlotCol_LegendBg] = ImVec4(0.11f, 0.11f, 0.14f, 0.92f); colors[ImPlotCol_LegendBorder] = ImVec4(0.50f, 0.50f, 0.50f, 0.50f); colors[ImPlotCol_LegendText] = ImVec4(0.90f, 0.90f, 0.90f, 1.00f); colors[ImPlotCol_TitleText] = ImVec4(0.90f, 0.90f, 0.90f, 1.00f); colors[ImPlotCol_InlayText] = ImVec4(0.90f, 0.90f, 0.90f, 1.00f); colors[ImPlotCol_AxisText] = ImVec4(0.90f, 0.90f, 0.90f, 1.00f); colors[ImPlotCol_AxisGrid] = ImVec4(0.90f, 0.90f, 0.90f, 0.25f); colors[ImPlotCol_AxisTick] = IMPLOT_AUTO_COL; // TODO colors[ImPlotCol_AxisBg] = IMPLOT_AUTO_COL; // TODO colors[ImPlotCol_AxisBgHovered] = IMPLOT_AUTO_COL; // TODO colors[ImPlotCol_AxisBgActive] = IMPLOT_AUTO_COL; // TODO colors[ImPlotCol_Selection] = ImVec4(0.97f, 0.97f, 0.39f, 1.00f); colors[ImPlotCol_Crosshairs] = ImVec4(0.50f, 0.50f, 0.50f, 0.75f); } void StyleColorsDark(ImPlotStyle* dst) { ImPlotStyle* style = dst ? dst : &ImPlot::GetStyle(); ImVec4* colors = style->Colors; style->MinorAlpha = 0.25f; colors[ImPlotCol_Line] = IMPLOT_AUTO_COL; colors[ImPlotCol_Fill] = IMPLOT_AUTO_COL; colors[ImPlotCol_MarkerOutline] = IMPLOT_AUTO_COL; colors[ImPlotCol_MarkerFill] = IMPLOT_AUTO_COL; colors[ImPlotCol_ErrorBar] = IMPLOT_AUTO_COL; colors[ImPlotCol_FrameBg] = ImVec4(1.00f, 1.00f, 1.00f, 0.07f); colors[ImPlotCol_PlotBg] = ImVec4(0.00f, 0.00f, 0.00f, 0.50f); colors[ImPlotCol_PlotBorder] = ImVec4(0.43f, 0.43f, 0.50f, 0.50f); colors[ImPlotCol_LegendBg] = ImVec4(0.08f, 0.08f, 0.08f, 0.94f); colors[ImPlotCol_LegendBorder] = ImVec4(0.43f, 0.43f, 0.50f, 0.50f); colors[ImPlotCol_LegendText] = ImVec4(1.00f, 1.00f, 1.00f, 1.00f); colors[ImPlotCol_TitleText] = ImVec4(1.00f, 1.00f, 1.00f, 1.00f); colors[ImPlotCol_InlayText] = ImVec4(1.00f, 1.00f, 1.00f, 1.00f); colors[ImPlotCol_AxisText] = ImVec4(1.00f, 1.00f, 1.00f, 1.00f); colors[ImPlotCol_AxisGrid] = ImVec4(1.00f, 1.00f, 1.00f, 0.25f); colors[ImPlotCol_AxisTick] = IMPLOT_AUTO_COL; // TODO colors[ImPlotCol_AxisBg] = IMPLOT_AUTO_COL; // TODO colors[ImPlotCol_AxisBgHovered] = IMPLOT_AUTO_COL; // TODO colors[ImPlotCol_AxisBgActive] = IMPLOT_AUTO_COL; // TODO colors[ImPlotCol_Selection] = ImVec4(1.00f, 0.60f, 0.00f, 1.00f); colors[ImPlotCol_Crosshairs] = ImVec4(1.00f, 1.00f, 1.00f, 0.50f); } void StyleColorsLight(ImPlotStyle* dst) { ImPlotStyle* style = dst ? dst : &ImPlot::GetStyle(); ImVec4* colors = style->Colors; style->MinorAlpha = 1.0f; colors[ImPlotCol_Line] = IMPLOT_AUTO_COL; colors[ImPlotCol_Fill] = IMPLOT_AUTO_COL; colors[ImPlotCol_MarkerOutline] = IMPLOT_AUTO_COL; colors[ImPlotCol_MarkerFill] = IMPLOT_AUTO_COL; colors[ImPlotCol_ErrorBar] = IMPLOT_AUTO_COL; colors[ImPlotCol_FrameBg] = ImVec4(1.00f, 1.00f, 1.00f, 1.00f); colors[ImPlotCol_PlotBg] = ImVec4(0.42f, 0.57f, 1.00f, 0.13f); colors[ImPlotCol_PlotBorder] = ImVec4(0.00f, 0.00f, 0.00f, 0.00f); colors[ImPlotCol_LegendBg] = ImVec4(1.00f, 1.00f, 1.00f, 0.98f); colors[ImPlotCol_LegendBorder] = ImVec4(0.82f, 0.82f, 0.82f, 0.80f); colors[ImPlotCol_LegendText] = ImVec4(0.00f, 0.00f, 0.00f, 1.00f); colors[ImPlotCol_TitleText] = ImVec4(0.00f, 0.00f, 0.00f, 1.00f); colors[ImPlotCol_InlayText] = ImVec4(0.00f, 0.00f, 0.00f, 1.00f); colors[ImPlotCol_AxisText] = ImVec4(0.00f, 0.00f, 0.00f, 1.00f); colors[ImPlotCol_AxisGrid] = ImVec4(1.00f, 1.00f, 1.00f, 1.00f); colors[ImPlotCol_AxisTick] = ImVec4(0.00f, 0.00f, 0.00f, 0.25f); colors[ImPlotCol_AxisBg] = IMPLOT_AUTO_COL; // TODO colors[ImPlotCol_AxisBgHovered] = IMPLOT_AUTO_COL; // TODO colors[ImPlotCol_AxisBgActive] = IMPLOT_AUTO_COL; // TODO colors[ImPlotCol_Selection] = ImVec4(0.82f, 0.64f, 0.03f, 1.00f); colors[ImPlotCol_Crosshairs] = ImVec4(0.00f, 0.00f, 0.00f, 0.50f); } //----------------------------------------------------------------------------- // [SECTION] Obsolete Functions/Types //----------------------------------------------------------------------------- #ifndef IMPLOT_DISABLE_OBSOLETE_FUNCTIONS bool BeginPlot(const char* title, const char* x_label, const char* y1_label, const ImVec2& size, ImPlotFlags flags, ImPlotAxisFlags x_flags, ImPlotAxisFlags y1_flags, ImPlotAxisFlags y2_flags, ImPlotAxisFlags y3_flags, const char* y2_label, const char* y3_label) { if (!BeginPlot(title, size, flags)) return false; SetupAxis(ImAxis_X1, x_label, x_flags); SetupAxis(ImAxis_Y1, y1_label, y1_flags); if (ImHasFlag(flags, ImPlotFlags_YAxis2)) SetupAxis(ImAxis_Y2, y2_label, y2_flags); if (ImHasFlag(flags, ImPlotFlags_YAxis3)) SetupAxis(ImAxis_Y3, y3_label, y3_flags); return true; } #endif } // namespace ImPlot ================================================ FILE: src/DesktopPlusUI/implot/implot.h ================================================ // MIT License // Copyright (c) 2023 Evan Pezent // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files (the "Software"), to deal // in the Software without restriction, including without limitation the rights // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell // copies of the Software, and to permit persons to whom the Software is // furnished to do so, subject to the following conditions: // The above copyright notice and this permission notice shall be included in all // copies or substantial portions of the Software. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE // SOFTWARE. // ImPlot v0.16 // Table of Contents: // // [SECTION] Macros and Defines // [SECTION] Enums and Types // [SECTION] Callbacks // [SECTION] Contexts // [SECTION] Begin/End Plot // [SECTION] Begin/End Subplot // [SECTION] Setup // [SECTION] SetNext // [SECTION] Plot Items // [SECTION] Plot Tools // [SECTION] Plot Utils // [SECTION] Legend Utils // [SECTION] Drag and Drop // [SECTION] Styling // [SECTION] Colormaps // [SECTION] Input Mapping // [SECTION] Miscellaneous // [SECTION] Demo // [SECTION] Obsolete API #pragma once #include "imgui.h" //----------------------------------------------------------------------------- // [SECTION] Macros and Defines //----------------------------------------------------------------------------- // Define attributes of all API symbols declarations (e.g. for DLL under Windows) // Using ImPlot via a shared library is not recommended, because we don't guarantee // backward nor forward ABI compatibility and also function call overhead. If you // do use ImPlot as a DLL, be sure to call SetImGuiContext (see Miscellanous section). #ifndef IMPLOT_API #define IMPLOT_API #endif // ImPlot version string. #define IMPLOT_VERSION "0.16" // Indicates variable should deduced automatically. #define IMPLOT_AUTO -1 // Special color used to indicate that a color should be deduced automatically. #define IMPLOT_AUTO_COL ImVec4(0,0,0,-1) // Macro for templated plotting functions; keeps header clean. #define IMPLOT_TMP template IMPLOT_API //----------------------------------------------------------------------------- // [SECTION] Enums and Types //----------------------------------------------------------------------------- // Forward declarations struct ImPlotContext; // ImPlot context (opaque struct, see implot_internal.h) // Enums/Flags typedef int ImAxis; // -> enum ImAxis_ typedef int ImPlotFlags; // -> enum ImPlotFlags_ typedef int ImPlotAxisFlags; // -> enum ImPlotAxisFlags_ typedef int ImPlotSubplotFlags; // -> enum ImPlotSubplotFlags_ typedef int ImPlotLegendFlags; // -> enum ImPlotLegendFlags_ typedef int ImPlotMouseTextFlags; // -> enum ImPlotMouseTextFlags_ typedef int ImPlotDragToolFlags; // -> ImPlotDragToolFlags_ typedef int ImPlotColormapScaleFlags; // -> ImPlotColormapScaleFlags_ typedef int ImPlotItemFlags; // -> ImPlotItemFlags_ typedef int ImPlotLineFlags; // -> ImPlotLineFlags_ typedef int ImPlotScatterFlags; // -> ImPlotScatterFlags typedef int ImPlotStairsFlags; // -> ImPlotStairsFlags_ typedef int ImPlotShadedFlags; // -> ImPlotShadedFlags_ typedef int ImPlotBarsFlags; // -> ImPlotBarsFlags_ typedef int ImPlotBarGroupsFlags; // -> ImPlotBarGroupsFlags_ typedef int ImPlotErrorBarsFlags; // -> ImPlotErrorBarsFlags_ typedef int ImPlotStemsFlags; // -> ImPlotStemsFlags_ typedef int ImPlotInfLinesFlags; // -> ImPlotInfLinesFlags_ typedef int ImPlotPieChartFlags; // -> ImPlotPieChartFlags_ typedef int ImPlotHeatmapFlags; // -> ImPlotHeatmapFlags_ typedef int ImPlotHistogramFlags; // -> ImPlotHistogramFlags_ typedef int ImPlotDigitalFlags; // -> ImPlotDigitalFlags_ typedef int ImPlotImageFlags; // -> ImPlotImageFlags_ typedef int ImPlotTextFlags; // -> ImPlotTextFlags_ typedef int ImPlotDummyFlags; // -> ImPlotDummyFlags_ typedef int ImPlotCond; // -> enum ImPlotCond_ typedef int ImPlotCol; // -> enum ImPlotCol_ typedef int ImPlotStyleVar; // -> enum ImPlotStyleVar_ typedef int ImPlotScale; // -> enum ImPlotScale_ typedef int ImPlotMarker; // -> enum ImPlotMarker_ typedef int ImPlotColormap; // -> enum ImPlotColormap_ typedef int ImPlotLocation; // -> enum ImPlotLocation_ typedef int ImPlotBin; // -> enum ImPlotBin_ // Axis indices. The values assigned may change; NEVER hardcode these. enum ImAxis_ { // horizontal axes ImAxis_X1 = 0, // enabled by default ImAxis_X2, // disabled by default ImAxis_X3, // disabled by default // vertical axes ImAxis_Y1, // enabled by default ImAxis_Y2, // disabled by default ImAxis_Y3, // disabled by default // bookeeping ImAxis_COUNT }; // Options for plots (see BeginPlot). enum ImPlotFlags_ { ImPlotFlags_None = 0, // default ImPlotFlags_NoTitle = 1 << 0, // the plot title will not be displayed (titles are also hidden if preceeded by double hashes, e.g. "##MyPlot") ImPlotFlags_NoLegend = 1 << 1, // the legend will not be displayed ImPlotFlags_NoMouseText = 1 << 2, // the mouse position, in plot coordinates, will not be displayed inside of the plot ImPlotFlags_NoInputs = 1 << 3, // the user will not be able to interact with the plot ImPlotFlags_NoMenus = 1 << 4, // the user will not be able to open context menus ImPlotFlags_NoBoxSelect = 1 << 5, // the user will not be able to box-select ImPlotFlags_NoChild = 1 << 6, // a child window region will not be used to capture mouse scroll (can boost performance for single ImGui window applications) ImPlotFlags_NoFrame = 1 << 7, // the ImGui frame will not be rendered ImPlotFlags_Equal = 1 << 8, // x and y axes pairs will be constrained to have the same units/pixel ImPlotFlags_Crosshairs = 1 << 9, // the default mouse cursor will be replaced with a crosshair when hovered ImPlotFlags_CanvasOnly = ImPlotFlags_NoTitle | ImPlotFlags_NoLegend | ImPlotFlags_NoMenus | ImPlotFlags_NoBoxSelect | ImPlotFlags_NoMouseText }; // Options for plot axes (see SetupAxis). enum ImPlotAxisFlags_ { ImPlotAxisFlags_None = 0, // default ImPlotAxisFlags_NoLabel = 1 << 0, // the axis label will not be displayed (axis labels are also hidden if the supplied string name is nullptr) ImPlotAxisFlags_NoGridLines = 1 << 1, // no grid lines will be displayed ImPlotAxisFlags_NoTickMarks = 1 << 2, // no tick marks will be displayed ImPlotAxisFlags_NoTickLabels = 1 << 3, // no text labels will be displayed ImPlotAxisFlags_NoInitialFit = 1 << 4, // axis will not be initially fit to data extents on the first rendered frame ImPlotAxisFlags_NoMenus = 1 << 5, // the user will not be able to open context menus with right-click ImPlotAxisFlags_NoSideSwitch = 1 << 6, // the user will not be able to switch the axis side by dragging it ImPlotAxisFlags_NoHighlight = 1 << 7, // the axis will not have its background highlighted when hovered or held ImPlotAxisFlags_Opposite = 1 << 8, // axis ticks and labels will be rendered on the conventionally opposite side (i.e, right or top) ImPlotAxisFlags_Foreground = 1 << 9, // grid lines will be displayed in the foreground (i.e. on top of data) instead of the background ImPlotAxisFlags_Invert = 1 << 10, // the axis will be inverted ImPlotAxisFlags_AutoFit = 1 << 11, // axis will be auto-fitting to data extents ImPlotAxisFlags_RangeFit = 1 << 12, // axis will only fit points if the point is in the visible range of the **orthogonal** axis ImPlotAxisFlags_PanStretch = 1 << 13, // panning in a locked or constrained state will cause the axis to stretch if possible ImPlotAxisFlags_LockMin = 1 << 14, // the axis minimum value will be locked when panning/zooming ImPlotAxisFlags_LockMax = 1 << 15, // the axis maximum value will be locked when panning/zooming ImPlotAxisFlags_Lock = ImPlotAxisFlags_LockMin | ImPlotAxisFlags_LockMax, ImPlotAxisFlags_NoDecorations = ImPlotAxisFlags_NoLabel | ImPlotAxisFlags_NoGridLines | ImPlotAxisFlags_NoTickMarks | ImPlotAxisFlags_NoTickLabels, ImPlotAxisFlags_AuxDefault = ImPlotAxisFlags_NoGridLines | ImPlotAxisFlags_Opposite }; // Options for subplots (see BeginSubplot) enum ImPlotSubplotFlags_ { ImPlotSubplotFlags_None = 0, // default ImPlotSubplotFlags_NoTitle = 1 << 0, // the subplot title will not be displayed (titles are also hidden if preceeded by double hashes, e.g. "##MySubplot") ImPlotSubplotFlags_NoLegend = 1 << 1, // the legend will not be displayed (only applicable if ImPlotSubplotFlags_ShareItems is enabled) ImPlotSubplotFlags_NoMenus = 1 << 2, // the user will not be able to open context menus with right-click ImPlotSubplotFlags_NoResize = 1 << 3, // resize splitters between subplot cells will be not be provided ImPlotSubplotFlags_NoAlign = 1 << 4, // subplot edges will not be aligned vertically or horizontally ImPlotSubplotFlags_ShareItems = 1 << 5, // items across all subplots will be shared and rendered into a single legend entry ImPlotSubplotFlags_LinkRows = 1 << 6, // link the y-axis limits of all plots in each row (does not apply to auxiliary axes) ImPlotSubplotFlags_LinkCols = 1 << 7, // link the x-axis limits of all plots in each column (does not apply to auxiliary axes) ImPlotSubplotFlags_LinkAllX = 1 << 8, // link the x-axis limits in every plot in the subplot (does not apply to auxiliary axes) ImPlotSubplotFlags_LinkAllY = 1 << 9, // link the y-axis limits in every plot in the subplot (does not apply to auxiliary axes) ImPlotSubplotFlags_ColMajor = 1 << 10 // subplots are added in column major order instead of the default row major order }; // Options for legends (see SetupLegend) enum ImPlotLegendFlags_ { ImPlotLegendFlags_None = 0, // default ImPlotLegendFlags_NoButtons = 1 << 0, // legend icons will not function as hide/show buttons ImPlotLegendFlags_NoHighlightItem = 1 << 1, // plot items will not be highlighted when their legend entry is hovered ImPlotLegendFlags_NoHighlightAxis = 1 << 2, // axes will not be highlighted when legend entries are hovered (only relevant if x/y-axis count > 1) ImPlotLegendFlags_NoMenus = 1 << 3, // the user will not be able to open context menus with right-click ImPlotLegendFlags_Outside = 1 << 4, // legend will be rendered outside of the plot area ImPlotLegendFlags_Horizontal = 1 << 5, // legend entries will be displayed horizontally ImPlotLegendFlags_Sort = 1 << 6, // legend entries will be displayed in alphabetical order }; // Options for mouse hover text (see SetupMouseText) enum ImPlotMouseTextFlags_ { ImPlotMouseTextFlags_None = 0, // default ImPlotMouseTextFlags_NoAuxAxes = 1 << 0, // only show the mouse position for primary axes ImPlotMouseTextFlags_NoFormat = 1 << 1, // axes label formatters won't be used to render text ImPlotMouseTextFlags_ShowAlways = 1 << 2, // always display mouse position even if plot not hovered }; // Options for DragPoint, DragLine, DragRect enum ImPlotDragToolFlags_ { ImPlotDragToolFlags_None = 0, // default ImPlotDragToolFlags_NoCursors = 1 << 0, // drag tools won't change cursor icons when hovered or held ImPlotDragToolFlags_NoFit = 1 << 1, // the drag tool won't be considered for plot fits ImPlotDragToolFlags_NoInputs = 1 << 2, // lock the tool from user inputs ImPlotDragToolFlags_Delayed = 1 << 3, // tool rendering will be delayed one frame; useful when applying position-constraints }; // Flags for ColormapScale enum ImPlotColormapScaleFlags_ { ImPlotColormapScaleFlags_None = 0, // default ImPlotColormapScaleFlags_NoLabel = 1 << 0, // the colormap axis label will not be displayed ImPlotColormapScaleFlags_Opposite = 1 << 1, // render the colormap label and tick labels on the opposite side ImPlotColormapScaleFlags_Invert = 1 << 2, // invert the colormap bar and axis scale (this only affects rendering; if you only want to reverse the scale mapping, make scale_min > scale_max) }; // Flags for ANY PlotX function enum ImPlotItemFlags_ { ImPlotItemFlags_None = 0, ImPlotItemFlags_NoLegend = 1 << 0, // the item won't have a legend entry displayed ImPlotItemFlags_NoFit = 1 << 1, // the item won't be considered for plot fits }; // Flags for PlotLine enum ImPlotLineFlags_ { ImPlotLineFlags_None = 0, // default ImPlotLineFlags_Segments = 1 << 10, // a line segment will be rendered from every two consecutive points ImPlotLineFlags_Loop = 1 << 11, // the last and first point will be connected to form a closed loop ImPlotLineFlags_SkipNaN = 1 << 12, // NaNs values will be skipped instead of rendered as missing data ImPlotLineFlags_NoClip = 1 << 13, // markers (if displayed) on the edge of a plot will not be clipped ImPlotLineFlags_Shaded = 1 << 14, // a filled region between the line and horizontal origin will be rendered; use PlotShaded for more advanced cases }; // Flags for PlotScatter enum ImPlotScatterFlags_ { ImPlotScatterFlags_None = 0, // default ImPlotScatterFlags_NoClip = 1 << 10, // markers on the edge of a plot will not be clipped }; // Flags for PlotStairs enum ImPlotStairsFlags_ { ImPlotStairsFlags_None = 0, // default ImPlotStairsFlags_PreStep = 1 << 10, // the y value is continued constantly to the left from every x position, i.e. the interval (x[i-1], x[i]] has the value y[i] ImPlotStairsFlags_Shaded = 1 << 11 // a filled region between the stairs and horizontal origin will be rendered; use PlotShaded for more advanced cases }; // Flags for PlotShaded (placeholder) enum ImPlotShadedFlags_ { ImPlotShadedFlags_None = 0 // default }; // Flags for PlotBars enum ImPlotBarsFlags_ { ImPlotBarsFlags_None = 0, // default ImPlotBarsFlags_Horizontal = 1 << 10, // bars will be rendered horizontally on the current y-axis }; // Flags for PlotBarGroups enum ImPlotBarGroupsFlags_ { ImPlotBarGroupsFlags_None = 0, // default ImPlotBarGroupsFlags_Horizontal = 1 << 10, // bar groups will be rendered horizontally on the current y-axis ImPlotBarGroupsFlags_Stacked = 1 << 11, // items in a group will be stacked on top of each other }; // Flags for PlotErrorBars enum ImPlotErrorBarsFlags_ { ImPlotErrorBarsFlags_None = 0, // default ImPlotErrorBarsFlags_Horizontal = 1 << 10, // error bars will be rendered horizontally on the current y-axis }; // Flags for PlotStems enum ImPlotStemsFlags_ { ImPlotStemsFlags_None = 0, // default ImPlotStemsFlags_Horizontal = 1 << 10, // stems will be rendered horizontally on the current y-axis }; // Flags for PlotInfLines enum ImPlotInfLinesFlags_ { ImPlotInfLinesFlags_None = 0, // default ImPlotInfLinesFlags_Horizontal = 1 << 10 // lines will be rendered horizontally on the current y-axis }; // Flags for PlotPieChart enum ImPlotPieChartFlags_ { ImPlotPieChartFlags_None = 0, // default ImPlotPieChartFlags_Normalize = 1 << 10 // force normalization of pie chart values (i.e. always make a full circle if sum < 0) }; // Flags for PlotHeatmap enum ImPlotHeatmapFlags_ { ImPlotHeatmapFlags_None = 0, // default ImPlotHeatmapFlags_ColMajor = 1 << 10, // data will be read in column major order }; // Flags for PlotHistogram and PlotHistogram2D enum ImPlotHistogramFlags_ { ImPlotHistogramFlags_None = 0, // default ImPlotHistogramFlags_Horizontal = 1 << 10, // histogram bars will be rendered horizontally (not supported by PlotHistogram2D) ImPlotHistogramFlags_Cumulative = 1 << 11, // each bin will contain its count plus the counts of all previous bins (not supported by PlotHistogram2D) ImPlotHistogramFlags_Density = 1 << 12, // counts will be normalized, i.e. the PDF will be visualized, or the CDF will be visualized if Cumulative is also set ImPlotHistogramFlags_NoOutliers = 1 << 13, // exclude values outside the specifed histogram range from the count toward normalizing and cumulative counts ImPlotHistogramFlags_ColMajor = 1 << 14 // data will be read in column major order (not supported by PlotHistogram) }; // Flags for PlotDigital (placeholder) enum ImPlotDigitalFlags_ { ImPlotDigitalFlags_None = 0 // default }; // Flags for PlotImage (placeholder) enum ImPlotImageFlags_ { ImPlotImageFlags_None = 0 // default }; // Flags for PlotText enum ImPlotTextFlags_ { ImPlotTextFlags_None = 0, // default ImPlotTextFlags_Vertical = 1 << 10 // text will be rendered vertically }; // Flags for PlotDummy (placeholder) enum ImPlotDummyFlags_ { ImPlotDummyFlags_None = 0 // default }; // Represents a condition for SetupAxisLimits etc. (same as ImGuiCond, but we only support a subset of those enums) enum ImPlotCond_ { ImPlotCond_None = ImGuiCond_None, // No condition (always set the variable), same as _Always ImPlotCond_Always = ImGuiCond_Always, // No condition (always set the variable) ImPlotCond_Once = ImGuiCond_Once, // Set the variable once per runtime session (only the first call will succeed) }; // Plot styling colors. enum ImPlotCol_ { // item styling colors ImPlotCol_Line, // plot line/outline color (defaults to next unused color in current colormap) ImPlotCol_Fill, // plot fill color for bars (defaults to the current line color) ImPlotCol_MarkerOutline, // marker outline color (defaults to the current line color) ImPlotCol_MarkerFill, // marker fill color (defaults to the current line color) ImPlotCol_ErrorBar, // error bar color (defaults to ImGuiCol_Text) // plot styling colors ImPlotCol_FrameBg, // plot frame background color (defaults to ImGuiCol_FrameBg) ImPlotCol_PlotBg, // plot area background color (defaults to ImGuiCol_WindowBg) ImPlotCol_PlotBorder, // plot area border color (defaults to ImGuiCol_Border) ImPlotCol_LegendBg, // legend background color (defaults to ImGuiCol_PopupBg) ImPlotCol_LegendBorder, // legend border color (defaults to ImPlotCol_PlotBorder) ImPlotCol_LegendText, // legend text color (defaults to ImPlotCol_InlayText) ImPlotCol_TitleText, // plot title text color (defaults to ImGuiCol_Text) ImPlotCol_InlayText, // color of text appearing inside of plots (defaults to ImGuiCol_Text) ImPlotCol_AxisText, // axis label and tick lables color (defaults to ImGuiCol_Text) ImPlotCol_AxisGrid, // axis grid color (defaults to 25% ImPlotCol_AxisText) ImPlotCol_AxisTick, // axis tick color (defaults to AxisGrid) ImPlotCol_AxisBg, // background color of axis hover region (defaults to transparent) ImPlotCol_AxisBgHovered, // axis hover color (defaults to ImGuiCol_ButtonHovered) ImPlotCol_AxisBgActive, // axis active color (defaults to ImGuiCol_ButtonActive) ImPlotCol_Selection, // box-selection color (defaults to yellow) ImPlotCol_Crosshairs, // crosshairs color (defaults to ImPlotCol_PlotBorder) ImPlotCol_COUNT }; // Plot styling variables. enum ImPlotStyleVar_ { // item styling variables ImPlotStyleVar_LineWeight, // float, plot item line weight in pixels ImPlotStyleVar_Marker, // int, marker specification ImPlotStyleVar_MarkerSize, // float, marker size in pixels (roughly the marker's "radius") ImPlotStyleVar_MarkerWeight, // float, plot outline weight of markers in pixels ImPlotStyleVar_FillAlpha, // float, alpha modifier applied to all plot item fills ImPlotStyleVar_ErrorBarSize, // float, error bar whisker width in pixels ImPlotStyleVar_ErrorBarWeight, // float, error bar whisker weight in pixels ImPlotStyleVar_DigitalBitHeight, // float, digital channels bit height (at 1) in pixels ImPlotStyleVar_DigitalBitGap, // float, digital channels bit padding gap in pixels // plot styling variables ImPlotStyleVar_PlotBorderSize, // float, thickness of border around plot area ImPlotStyleVar_MinorAlpha, // float, alpha multiplier applied to minor axis grid lines ImPlotStyleVar_MajorTickLen, // ImVec2, major tick lengths for X and Y axes ImPlotStyleVar_MinorTickLen, // ImVec2, minor tick lengths for X and Y axes ImPlotStyleVar_MajorTickSize, // ImVec2, line thickness of major ticks ImPlotStyleVar_MinorTickSize, // ImVec2, line thickness of minor ticks ImPlotStyleVar_MajorGridSize, // ImVec2, line thickness of major grid lines ImPlotStyleVar_MinorGridSize, // ImVec2, line thickness of minor grid lines ImPlotStyleVar_PlotPadding, // ImVec2, padding between widget frame and plot area, labels, or outside legends (i.e. main padding) ImPlotStyleVar_LabelPadding, // ImVec2, padding between axes labels, tick labels, and plot edge ImPlotStyleVar_LegendPadding, // ImVec2, legend padding from plot edges ImPlotStyleVar_LegendInnerPadding, // ImVec2, legend inner padding from legend edges ImPlotStyleVar_LegendSpacing, // ImVec2, spacing between legend entries ImPlotStyleVar_MousePosPadding, // ImVec2, padding between plot edge and interior info text ImPlotStyleVar_AnnotationPadding, // ImVec2, text padding around annotation labels ImPlotStyleVar_FitPadding, // ImVec2, additional fit padding as a percentage of the fit extents (e.g. ImVec2(0.1f,0.1f) adds 10% to the fit extents of X and Y) ImPlotStyleVar_PlotDefaultSize, // ImVec2, default size used when ImVec2(0,0) is passed to BeginPlot ImPlotStyleVar_PlotMinSize, // ImVec2, minimum size plot frame can be when shrunk ImPlotStyleVar_COUNT }; // Axis scale enum ImPlotScale_ { ImPlotScale_Linear = 0, // default linear scale ImPlotScale_Time, // date/time scale ImPlotScale_Log10, // base 10 logartithmic scale ImPlotScale_SymLog, // symmetric log scale }; // Marker specifications. enum ImPlotMarker_ { ImPlotMarker_None = -1, // no marker ImPlotMarker_Circle, // a circle marker (default) ImPlotMarker_Square, // a square maker ImPlotMarker_Diamond, // a diamond marker ImPlotMarker_Up, // an upward-pointing triangle marker ImPlotMarker_Down, // an downward-pointing triangle marker ImPlotMarker_Left, // an leftward-pointing triangle marker ImPlotMarker_Right, // an rightward-pointing triangle marker ImPlotMarker_Cross, // a cross marker (not fillable) ImPlotMarker_Plus, // a plus marker (not fillable) ImPlotMarker_Asterisk, // a asterisk marker (not fillable) ImPlotMarker_COUNT }; // Built-in colormaps enum ImPlotColormap_ { ImPlotColormap_Deep = 0, // a.k.a. seaborn deep (qual=true, n=10) (default) ImPlotColormap_Dark = 1, // a.k.a. matplotlib "Set1" (qual=true, n=9 ) ImPlotColormap_Pastel = 2, // a.k.a. matplotlib "Pastel1" (qual=true, n=9 ) ImPlotColormap_Paired = 3, // a.k.a. matplotlib "Paired" (qual=true, n=12) ImPlotColormap_Viridis = 4, // a.k.a. matplotlib "viridis" (qual=false, n=11) ImPlotColormap_Plasma = 5, // a.k.a. matplotlib "plasma" (qual=false, n=11) ImPlotColormap_Hot = 6, // a.k.a. matplotlib/MATLAB "hot" (qual=false, n=11) ImPlotColormap_Cool = 7, // a.k.a. matplotlib/MATLAB "cool" (qual=false, n=11) ImPlotColormap_Pink = 8, // a.k.a. matplotlib/MATLAB "pink" (qual=false, n=11) ImPlotColormap_Jet = 9, // a.k.a. MATLAB "jet" (qual=false, n=11) ImPlotColormap_Twilight = 10, // a.k.a. matplotlib "twilight" (qual=false, n=11) ImPlotColormap_RdBu = 11, // red/blue, Color Brewer (qual=false, n=11) ImPlotColormap_BrBG = 12, // brown/blue-green, Color Brewer (qual=false, n=11) ImPlotColormap_PiYG = 13, // pink/yellow-green, Color Brewer (qual=false, n=11) ImPlotColormap_Spectral = 14, // color spectrum, Color Brewer (qual=false, n=11) ImPlotColormap_Greys = 15, // white/black (qual=false, n=2 ) }; // Used to position items on a plot (e.g. legends, labels, etc.) enum ImPlotLocation_ { ImPlotLocation_Center = 0, // center-center ImPlotLocation_North = 1 << 0, // top-center ImPlotLocation_South = 1 << 1, // bottom-center ImPlotLocation_West = 1 << 2, // center-left ImPlotLocation_East = 1 << 3, // center-right ImPlotLocation_NorthWest = ImPlotLocation_North | ImPlotLocation_West, // top-left ImPlotLocation_NorthEast = ImPlotLocation_North | ImPlotLocation_East, // top-right ImPlotLocation_SouthWest = ImPlotLocation_South | ImPlotLocation_West, // bottom-left ImPlotLocation_SouthEast = ImPlotLocation_South | ImPlotLocation_East // bottom-right }; // Enums for different automatic histogram binning methods (k = bin count or w = bin width) enum ImPlotBin_ { ImPlotBin_Sqrt = -1, // k = sqrt(n) ImPlotBin_Sturges = -2, // k = 1 + log2(n) ImPlotBin_Rice = -3, // k = 2 * cbrt(n) ImPlotBin_Scott = -4, // w = 3.49 * sigma / cbrt(n) }; // Double precision version of ImVec2 used by ImPlot. Extensible by end users. struct ImPlotPoint { double x, y; ImPlotPoint() { x = y = 0.0; } ImPlotPoint(double _x, double _y) { x = _x; y = _y; } ImPlotPoint(const ImVec2& p) { x = (double)p.x; y = (double)p.y; } double operator[] (size_t idx) const { return (&x)[idx]; } double& operator[] (size_t idx) { return (&x)[idx]; } #ifdef IMPLOT_POINT_CLASS_EXTRA IMPLOT_POINT_CLASS_EXTRA // Define additional constructors and implicit cast operators in imconfig.h // to convert back and forth between your math types and ImPlotPoint. #endif }; // Range defined by a min/max value. struct ImPlotRange { double Min, Max; ImPlotRange() { Min = 0; Max = 0; } ImPlotRange(double _min, double _max) { Min = _min; Max = _max; } bool Contains(double value) const { return value >= Min && value <= Max; } double Size() const { return Max - Min; } double Clamp(double value) const { return (value < Min) ? Min : (value > Max) ? Max : value; } }; // Combination of two range limits for X and Y axes. Also an AABB defined by Min()/Max(). struct ImPlotRect { ImPlotRange X, Y; ImPlotRect() { } ImPlotRect(double x_min, double x_max, double y_min, double y_max) { X.Min = x_min; X.Max = x_max; Y.Min = y_min; Y.Max = y_max; } bool Contains(const ImPlotPoint& p) const { return Contains(p.x, p.y); } bool Contains(double x, double y) const { return X.Contains(x) && Y.Contains(y); } ImPlotPoint Size() const { return ImPlotPoint(X.Size(), Y.Size()); } ImPlotPoint Clamp(const ImPlotPoint& p) { return Clamp(p.x, p.y); } ImPlotPoint Clamp(double x, double y) { return ImPlotPoint(X.Clamp(x),Y.Clamp(y)); } ImPlotPoint Min() const { return ImPlotPoint(X.Min, Y.Min); } ImPlotPoint Max() const { return ImPlotPoint(X.Max, Y.Max); } }; // Plot style structure struct ImPlotStyle { // item styling variables float LineWeight; // = 1, item line weight in pixels int Marker; // = ImPlotMarker_None, marker specification float MarkerSize; // = 4, marker size in pixels (roughly the marker's "radius") float MarkerWeight; // = 1, outline weight of markers in pixels float FillAlpha; // = 1, alpha modifier applied to plot fills float ErrorBarSize; // = 5, error bar whisker width in pixels float ErrorBarWeight; // = 1.5, error bar whisker weight in pixels float DigitalBitHeight; // = 8, digital channels bit height (at y = 1.0f) in pixels float DigitalBitGap; // = 4, digital channels bit padding gap in pixels // plot styling variables float PlotBorderSize; // = 1, line thickness of border around plot area float MinorAlpha; // = 0.25 alpha multiplier applied to minor axis grid lines ImVec2 MajorTickLen; // = 10,10 major tick lengths for X and Y axes ImVec2 MinorTickLen; // = 5,5 minor tick lengths for X and Y axes ImVec2 MajorTickSize; // = 1,1 line thickness of major ticks ImVec2 MinorTickSize; // = 1,1 line thickness of minor ticks ImVec2 MajorGridSize; // = 1,1 line thickness of major grid lines ImVec2 MinorGridSize; // = 1,1 line thickness of minor grid lines ImVec2 PlotPadding; // = 10,10 padding between widget frame and plot area, labels, or outside legends (i.e. main padding) ImVec2 LabelPadding; // = 5,5 padding between axes labels, tick labels, and plot edge ImVec2 LegendPadding; // = 10,10 legend padding from plot edges ImVec2 LegendInnerPadding; // = 5,5 legend inner padding from legend edges ImVec2 LegendSpacing; // = 5,0 spacing between legend entries ImVec2 MousePosPadding; // = 10,10 padding between plot edge and interior mouse location text ImVec2 AnnotationPadding; // = 2,2 text padding around annotation labels ImVec2 FitPadding; // = 0,0 additional fit padding as a percentage of the fit extents (e.g. ImVec2(0.1f,0.1f) adds 10% to the fit extents of X and Y) ImVec2 PlotDefaultSize; // = 400,300 default size used when ImVec2(0,0) is passed to BeginPlot ImVec2 PlotMinSize; // = 200,150 minimum size plot frame can be when shrunk // style colors ImVec4 Colors[ImPlotCol_COUNT]; // Array of styling colors. Indexable with ImPlotCol_ enums. // colormap ImPlotColormap Colormap; // The current colormap. Set this to either an ImPlotColormap_ enum or an index returned by AddColormap. // settings/flags bool UseLocalTime; // = false, axis labels will be formatted for your timezone when ImPlotAxisFlag_Time is enabled bool UseISO8601; // = false, dates will be formatted according to ISO 8601 where applicable (e.g. YYYY-MM-DD, YYYY-MM, --MM-DD, etc.) bool Use24HourClock; // = false, times will be formatted using a 24 hour clock IMPLOT_API ImPlotStyle(); }; // Support for legacy versions #if (IMGUI_VERSION_NUM < 18716) // Renamed in 1.88 #define ImGuiMod_None 0 #define ImGuiMod_Ctrl ImGuiKeyModFlags_Ctrl #define ImGuiMod_Shift ImGuiKeyModFlags_Shift #define ImGuiMod_Alt ImGuiKeyModFlags_Alt #define ImGuiMod_Super ImGuiKeyModFlags_Super #elif (IMGUI_VERSION_NUM < 18823) // Renamed in 1.89, sorry #define ImGuiMod_None 0 #define ImGuiMod_Ctrl ImGuiModFlags_Ctrl #define ImGuiMod_Shift ImGuiModFlags_Shift #define ImGuiMod_Alt ImGuiModFlags_Alt #define ImGuiMod_Super ImGuiModFlags_Super #endif // Input mapping structure. Default values listed. See also MapInputDefault, MapInputReverse. struct ImPlotInputMap { ImGuiMouseButton Pan; // LMB enables panning when held, int PanMod; // none optional modifier that must be held for panning/fitting ImGuiMouseButton Fit; // LMB initiates fit when double clicked ImGuiMouseButton Select; // RMB begins box selection when pressed and confirms selection when released ImGuiMouseButton SelectCancel; // LMB cancels active box selection when pressed; cannot be same as Select int SelectMod; // none optional modifier that must be held for box selection int SelectHorzMod; // Alt expands active box selection horizontally to plot edge when held int SelectVertMod; // Shift expands active box selection vertically to plot edge when held ImGuiMouseButton Menu; // RMB opens context menus (if enabled) when clicked int OverrideMod; // Ctrl when held, all input is ignored; used to enable axis/plots as DND sources int ZoomMod; // none optional modifier that must be held for scroll wheel zooming float ZoomRate; // 0.1f zoom rate for scroll (e.g. 0.1f = 10% plot range every scroll click); make negative to invert IMPLOT_API ImPlotInputMap(); }; //----------------------------------------------------------------------------- // [SECTION] Callbacks //----------------------------------------------------------------------------- // Callback signature for axis tick label formatter. typedef int (*ImPlotFormatter)(double value, char* buff, int size, void* user_data); // Callback signature for data getter. typedef ImPlotPoint (*ImPlotGetter)(int idx, void* user_data); // Callback signature for axis transform. typedef double (*ImPlotTransform)(double value, void* user_data); namespace ImPlot { //----------------------------------------------------------------------------- // [SECTION] Contexts //----------------------------------------------------------------------------- // Creates a new ImPlot context. Call this after ImGui::CreateContext. IMPLOT_API ImPlotContext* CreateContext(); // Destroys an ImPlot context. Call this before ImGui::DestroyContext. nullptr = destroy current context. IMPLOT_API void DestroyContext(ImPlotContext* ctx = nullptr); // Returns the current ImPlot context. nullptr if no context has ben set. IMPLOT_API ImPlotContext* GetCurrentContext(); // Sets the current ImPlot context. IMPLOT_API void SetCurrentContext(ImPlotContext* ctx); // Sets the current **ImGui** context. This is ONLY necessary if you are compiling // ImPlot as a DLL (not recommended) separate from your ImGui compilation. It // sets the global variable GImGui, which is not shared across DLL boundaries. // See GImGui documentation in imgui.cpp for more details. IMPLOT_API void SetImGuiContext(ImGuiContext* ctx); //----------------------------------------------------------------------------- // [SECTION] Begin/End Plot //----------------------------------------------------------------------------- // Starts a 2D plotting context. If this function returns true, EndPlot() MUST // be called! You are encouraged to use the following convention: // // if (BeginPlot(...)) { // PlotLine(...); // ... // EndPlot(); // } // // Important notes: // // - #title_id must be unique to the current ImGui ID scope. If you need to avoid ID // collisions or don't want to display a title in the plot, use double hashes // (e.g. "MyPlot##HiddenIdText" or "##NoTitle"). // - #size is the **frame** size of the plot widget, not the plot area. The default // size of plots (i.e. when ImVec2(0,0)) can be modified in your ImPlotStyle. IMPLOT_API bool BeginPlot(const char* title_id, const ImVec2& size=ImVec2(-1,0), ImPlotFlags flags=0); // Only call EndPlot() if BeginPlot() returns true! Typically called at the end // of an if statement conditioned on BeginPlot(). See example above. IMPLOT_API void EndPlot(); //----------------------------------------------------------------------------- // [SECTION] Begin/End Subplots //----------------------------------------------------------------------------- // Starts a subdivided plotting context. If the function returns true, // EndSubplots() MUST be called! Call BeginPlot/EndPlot AT MOST [rows*cols] // times in between the begining and end of the subplot context. Plots are // added in row major order. // // Example: // // if (BeginSubplots("My Subplot",2,3,ImVec2(800,400)) { // for (int i = 0; i < 6; ++i) { // if (BeginPlot(...)) { // ImPlot::PlotLine(...); // ... // EndPlot(); // } // } // EndSubplots(); // } // // Produces: // // [0] | [1] | [2] // ----|-----|---- // [3] | [4] | [5] // // Important notes: // // - #title_id must be unique to the current ImGui ID scope. If you need to avoid ID // collisions or don't want to display a title in the plot, use double hashes // (e.g. "MySubplot##HiddenIdText" or "##NoTitle"). // - #rows and #cols must be greater than 0. // - #size is the size of the entire grid of subplots, not the individual plots // - #row_ratios and #col_ratios must have AT LEAST #rows and #cols elements, // respectively. These are the sizes of the rows and columns expressed in ratios. // If the user adjusts the dimensions, the arrays are updated with new ratios. // // Important notes regarding BeginPlot from inside of BeginSubplots: // // - The #title_id parameter of _BeginPlot_ (see above) does NOT have to be // unique when called inside of a subplot context. Subplot IDs are hashed // for your convenience so you don't have call PushID or generate unique title // strings. Simply pass an empty string to BeginPlot unless you want to title // each subplot. // - The #size parameter of _BeginPlot_ (see above) is ignored when inside of a // subplot context. The actual size of the subplot will be based on the // #size value you pass to _BeginSubplots_ and #row/#col_ratios if provided. IMPLOT_API bool BeginSubplots(const char* title_id, int rows, int cols, const ImVec2& size, ImPlotSubplotFlags flags = 0, float* row_ratios = nullptr, float* col_ratios = nullptr); // Only call EndSubplots() if BeginSubplots() returns true! Typically called at the end // of an if statement conditioned on BeginSublots(). See example above. IMPLOT_API void EndSubplots(); //----------------------------------------------------------------------------- // [SECTION] Setup //----------------------------------------------------------------------------- // The following API allows you to setup and customize various aspects of the // current plot. The functions should be called immediately after BeginPlot // and before any other API calls. Typical usage is as follows: // if (BeginPlot(...)) { 1) begin a new plot // SetupAxis(ImAxis_X1, "My X-Axis"); 2) make Setup calls // SetupAxis(ImAxis_Y1, "My Y-Axis"); // SetupLegend(ImPlotLocation_North); // ... // SetupFinish(); 3) [optional] explicitly finish setup // PlotLine(...); 4) plot items // ... // EndPlot(); 5) end the plot // } // // Important notes: // // - Always call Setup code at the top of your BeginPlot conditional statement. // - Setup is locked once you start plotting or explicitly call SetupFinish. // Do NOT call Setup code after you begin plotting or after you make // any non-Setup API calls (e.g. utils like PlotToPixels also lock Setup) // - Calling SetupFinish is OPTIONAL, but probably good practice. If you do not // call it yourself, then the first subsequent plotting or utility function will // call it for you. // Enables an axis or sets the label and/or flags for an existing axis. Leave #label = nullptr for no label. IMPLOT_API void SetupAxis(ImAxis axis, const char* label=nullptr, ImPlotAxisFlags flags=0); // Sets an axis range limits. If ImPlotCond_Always is used, the axes limits will be locked. Inversion with v_min > v_max is not supported; use SetupAxisLimits instead. IMPLOT_API void SetupAxisLimits(ImAxis axis, double v_min, double v_max, ImPlotCond cond = ImPlotCond_Once); // Links an axis range limits to external values. Set to nullptr for no linkage. The pointer data must remain valid until EndPlot. IMPLOT_API void SetupAxisLinks(ImAxis axis, double* link_min, double* link_max); // Sets the format of numeric axis labels via formater specifier (default="%g"). Formated values will be double (i.e. use %f). IMPLOT_API void SetupAxisFormat(ImAxis axis, const char* fmt); // Sets the format of numeric axis labels via formatter callback. Given #value, write a label into #buff. Optionally pass user data. IMPLOT_API void SetupAxisFormat(ImAxis axis, ImPlotFormatter formatter, void* data=nullptr); // Sets an axis' ticks and optionally the labels. To keep the default ticks, set #keep_default=true. IMPLOT_API void SetupAxisTicks(ImAxis axis, const double* values, int n_ticks, const char* const labels[]=nullptr, bool keep_default=false); // Sets an axis' ticks and optionally the labels for the next plot. To keep the default ticks, set #keep_default=true. IMPLOT_API void SetupAxisTicks(ImAxis axis, double v_min, double v_max, int n_ticks, const char* const labels[]=nullptr, bool keep_default=false); // Sets an axis' scale using built-in options. IMPLOT_API void SetupAxisScale(ImAxis axis, ImPlotScale scale); // Sets an axis' scale using user supplied forward and inverse transfroms. IMPLOT_API void SetupAxisScale(ImAxis axis, ImPlotTransform forward, ImPlotTransform inverse, void* data=nullptr); // Sets an axis' limits constraints. IMPLOT_API void SetupAxisLimitsConstraints(ImAxis axis, double v_min, double v_max); // Sets an axis' zoom constraints. IMPLOT_API void SetupAxisZoomConstraints(ImAxis axis, double z_min, double z_max); // Sets the label and/or flags for primary X and Y axes (shorthand for two calls to SetupAxis). IMPLOT_API void SetupAxes(const char* x_label, const char* y_label, ImPlotAxisFlags x_flags=0, ImPlotAxisFlags y_flags=0); // Sets the primary X and Y axes range limits. If ImPlotCond_Always is used, the axes limits will be locked (shorthand for two calls to SetupAxisLimits). IMPLOT_API void SetupAxesLimits(double x_min, double x_max, double y_min, double y_max, ImPlotCond cond = ImPlotCond_Once); // Sets up the plot legend. IMPLOT_API void SetupLegend(ImPlotLocation location, ImPlotLegendFlags flags=0); // Set the location of the current plot's mouse position text (default = South|East). IMPLOT_API void SetupMouseText(ImPlotLocation location, ImPlotMouseTextFlags flags=0); // Explicitly finalize plot setup. Once you call this, you cannot make anymore Setup calls for the current plot! // Note that calling this function is OPTIONAL; it will be called by the first subsequent setup-locking API call. IMPLOT_API void SetupFinish(); //----------------------------------------------------------------------------- // [SECTION] SetNext //----------------------------------------------------------------------------- // Though you should default to the `Setup` API above, there are some scenarios // where (re)configuring a plot or axis before `BeginPlot` is needed (e.g. if // using a preceding button or slider widget to change the plot limits). In // this case, you can use the `SetNext` API below. While this is not as feature // rich as the Setup API, most common needs are provided. These functions can be // called anwhere except for inside of `Begin/EndPlot`. For example: // if (ImGui::Button("Center Plot")) // ImPlot::SetNextPlotLimits(-1,1,-1,1); // if (ImPlot::BeginPlot(...)) { // ... // ImPlot::EndPlot(); // } // // Important notes: // // - You must still enable non-default axes with SetupAxis for these functions // to work properly. // Sets an upcoming axis range limits. If ImPlotCond_Always is used, the axes limits will be locked. IMPLOT_API void SetNextAxisLimits(ImAxis axis, double v_min, double v_max, ImPlotCond cond = ImPlotCond_Once); // Links an upcoming axis range limits to external values. Set to nullptr for no linkage. The pointer data must remain valid until EndPlot! IMPLOT_API void SetNextAxisLinks(ImAxis axis, double* link_min, double* link_max); // Set an upcoming axis to auto fit to its data. IMPLOT_API void SetNextAxisToFit(ImAxis axis); // Sets the upcoming primary X and Y axes range limits. If ImPlotCond_Always is used, the axes limits will be locked (shorthand for two calls to SetupAxisLimits). IMPLOT_API void SetNextAxesLimits(double x_min, double x_max, double y_min, double y_max, ImPlotCond cond = ImPlotCond_Once); // Sets all upcoming axes to auto fit to their data. IMPLOT_API void SetNextAxesToFit(); //----------------------------------------------------------------------------- // [SECTION] Plot Items //----------------------------------------------------------------------------- // The main plotting API is provied below. Call these functions between // Begin/EndPlot and after any Setup API calls. Each plots data on the current // x and y axes, which can be changed with `SetAxis/Axes`. // // The templated functions are explicitly instantiated in implot_items.cpp. // They are not intended to be used generically with custom types. You will get // a linker error if you try! All functions support the following scalar types: // // float, double, ImS8, ImU8, ImS16, ImU16, ImS32, ImU32, ImS64, ImU64 // // // If you need to plot custom or non-homogenous data you have a few options: // // 1. If your data is a simple struct/class (e.g. Vector2f), you can use striding. // This is the most performant option if applicable. // // struct Vector2f { float X, Y; }; // ... // Vector2f data[42]; // ImPlot::PlotLine("line", &data[0].x, &data[0].y, 42, 0, 0, sizeof(Vector2f)); // // 2. Write a custom getter C function or C++ lambda and pass it and optionally your data to // an ImPlot function post-fixed with a G (e.g. PlotScatterG). This has a slight performance // cost, but probably not enough to worry about unless your data is very large. Examples: // // ImPlotPoint MyDataGetter(void* data, int idx) { // MyData* my_data = (MyData*)data; // ImPlotPoint p; // p.x = my_data->GetTime(idx); // p.y = my_data->GetValue(idx); // return p // } // ... // auto my_lambda = [](int idx, void*) { // double t = idx / 999.0; // return ImPlotPoint(t, 0.5+0.5*std::sin(2*PI*10*t)); // }; // ... // if (ImPlot::BeginPlot("MyPlot")) { // MyData my_data; // ImPlot::PlotScatterG("scatter", MyDataGetter, &my_data, my_data.Size()); // ImPlot::PlotLineG("line", my_lambda, nullptr, 1000); // ImPlot::EndPlot(); // } // // NB: All types are converted to double before plotting. You may lose information // if you try plotting extremely large 64-bit integral types. Proceed with caution! // Plots a standard 2D line plot. IMPLOT_TMP void PlotLine(const char* label_id, const T* values, int count, double xscale=1, double xstart=0, ImPlotLineFlags flags=0, int offset=0, int stride=sizeof(T)); IMPLOT_TMP void PlotLine(const char* label_id, const T* xs, const T* ys, int count, ImPlotLineFlags flags=0, int offset=0, int stride=sizeof(T)); IMPLOT_API void PlotLineG(const char* label_id, ImPlotGetter getter, void* data, int count, ImPlotLineFlags flags=0); // Plots a standard 2D scatter plot. Default marker is ImPlotMarker_Circle. IMPLOT_TMP void PlotScatter(const char* label_id, const T* values, int count, double xscale=1, double xstart=0, ImPlotScatterFlags flags=0, int offset=0, int stride=sizeof(T)); IMPLOT_TMP void PlotScatter(const char* label_id, const T* xs, const T* ys, int count, ImPlotScatterFlags flags=0, int offset=0, int stride=sizeof(T)); IMPLOT_API void PlotScatterG(const char* label_id, ImPlotGetter getter, void* data, int count, ImPlotScatterFlags flags=0); // Plots a a stairstep graph. The y value is continued constantly to the right from every x position, i.e. the interval [x[i], x[i+1]) has the value y[i] IMPLOT_TMP void PlotStairs(const char* label_id, const T* values, int count, double xscale=1, double xstart=0, ImPlotStairsFlags flags=0, int offset=0, int stride=sizeof(T)); IMPLOT_TMP void PlotStairs(const char* label_id, const T* xs, const T* ys, int count, ImPlotStairsFlags flags=0, int offset=0, int stride=sizeof(T)); IMPLOT_API void PlotStairsG(const char* label_id, ImPlotGetter getter, void* data, int count, ImPlotStairsFlags flags=0); // Plots a shaded (filled) region between two lines, or a line and a horizontal reference. Set yref to +/-INFINITY for infinite fill extents. IMPLOT_TMP void PlotShaded(const char* label_id, const T* values, int count, double yref=0, double xscale=1, double xstart=0, ImPlotShadedFlags flags=0, int offset=0, int stride=sizeof(T)); IMPLOT_TMP void PlotShaded(const char* label_id, const T* xs, const T* ys, int count, double yref=0, ImPlotShadedFlags flags=0, int offset=0, int stride=sizeof(T)); IMPLOT_TMP void PlotShaded(const char* label_id, const T* xs, const T* ys1, const T* ys2, int count, ImPlotShadedFlags flags=0, int offset=0, int stride=sizeof(T)); IMPLOT_API void PlotShadedG(const char* label_id, ImPlotGetter getter1, void* data1, ImPlotGetter getter2, void* data2, int count, ImPlotShadedFlags flags=0); // Plots a bar graph. Vertical by default. #bar_size and #shift are in plot units. IMPLOT_TMP void PlotBars(const char* label_id, const T* values, int count, double bar_size=0.67, double shift=0, ImPlotBarsFlags flags=0, int offset=0, int stride=sizeof(T)); IMPLOT_TMP void PlotBars(const char* label_id, const T* xs, const T* ys, int count, double bar_size, ImPlotBarsFlags flags=0, int offset=0, int stride=sizeof(T)); IMPLOT_API void PlotBarsG(const char* label_id, ImPlotGetter getter, void* data, int count, double bar_size, ImPlotBarsFlags flags=0); // Plots a group of bars. #values is a row-major matrix with #item_count rows and #group_count cols. #label_ids should have #item_count elements. IMPLOT_TMP void PlotBarGroups(const char* const label_ids[], const T* values, int item_count, int group_count, double group_size=0.67, double shift=0, ImPlotBarGroupsFlags flags=0); // Plots vertical error bar. The label_id should be the same as the label_id of the associated line or bar plot. IMPLOT_TMP void PlotErrorBars(const char* label_id, const T* xs, const T* ys, const T* err, int count, ImPlotErrorBarsFlags flags=0, int offset=0, int stride=sizeof(T)); IMPLOT_TMP void PlotErrorBars(const char* label_id, const T* xs, const T* ys, const T* neg, const T* pos, int count, ImPlotErrorBarsFlags flags=0, int offset=0, int stride=sizeof(T)); // Plots stems. Vertical by default. IMPLOT_TMP void PlotStems(const char* label_id, const T* values, int count, double ref=0, double scale=1, double start=0, ImPlotStemsFlags flags=0, int offset=0, int stride=sizeof(T)); IMPLOT_TMP void PlotStems(const char* label_id, const T* xs, const T* ys, int count, double ref=0, ImPlotStemsFlags flags=0, int offset=0, int stride=sizeof(T)); // Plots infinite vertical or horizontal lines (e.g. for references or asymptotes). IMPLOT_TMP void PlotInfLines(const char* label_id, const T* values, int count, ImPlotInfLinesFlags flags=0, int offset=0, int stride=sizeof(T)); // Plots a pie chart. Center and radius are in plot units. #label_fmt can be set to nullptr for no labels. IMPLOT_TMP void PlotPieChart(const char* const label_ids[], const T* values, int count, double x, double y, double radius, const char* label_fmt="%.1f", double angle0=90, ImPlotPieChartFlags flags=0); // Plots a 2D heatmap chart. Values are expected to be in row-major order by default. Leave #scale_min and scale_max both at 0 for automatic color scaling, or set them to a predefined range. #label_fmt can be set to nullptr for no labels. IMPLOT_TMP void PlotHeatmap(const char* label_id, const T* values, int rows, int cols, double scale_min=0, double scale_max=0, const char* label_fmt="%.1f", const ImPlotPoint& bounds_min=ImPlotPoint(0,0), const ImPlotPoint& bounds_max=ImPlotPoint(1,1), ImPlotHeatmapFlags flags=0); // Plots a horizontal histogram. #bins can be a positive integer or an ImPlotBin_ method. If #range is left unspecified, the min/max of #values will be used as the range. // Otherwise, outlier values outside of the range are not binned. The largest bin count or density is returned. IMPLOT_TMP double PlotHistogram(const char* label_id, const T* values, int count, int bins=ImPlotBin_Sturges, double bar_scale=1.0, ImPlotRange range=ImPlotRange(), ImPlotHistogramFlags flags=0); // Plots two dimensional, bivariate histogram as a heatmap. #x_bins and #y_bins can be a positive integer or an ImPlotBin. If #range is left unspecified, the min/max of // #xs an #ys will be used as the ranges. Otherwise, outlier values outside of range are not binned. The largest bin count or density is returned. IMPLOT_TMP double PlotHistogram2D(const char* label_id, const T* xs, const T* ys, int count, int x_bins=ImPlotBin_Sturges, int y_bins=ImPlotBin_Sturges, ImPlotRect range=ImPlotRect(), ImPlotHistogramFlags flags=0); // Plots digital data. Digital plots do not respond to y drag or zoom, and are always referenced to the bottom of the plot. IMPLOT_TMP void PlotDigital(const char* label_id, const T* xs, const T* ys, int count, ImPlotDigitalFlags flags=0, int offset=0, int stride=sizeof(T)); IMPLOT_API void PlotDigitalG(const char* label_id, ImPlotGetter getter, void* data, int count, ImPlotDigitalFlags flags=0); // Plots an axis-aligned image. #bounds_min/bounds_max are in plot coordinates (y-up) and #uv0/uv1 are in texture coordinates (y-down). IMPLOT_API void PlotImage(const char* label_id, ImTextureID user_texture_id, const ImPlotPoint& bounds_min, const ImPlotPoint& bounds_max, const ImVec2& uv0=ImVec2(0,0), const ImVec2& uv1=ImVec2(1,1), const ImVec4& tint_col=ImVec4(1,1,1,1), ImPlotImageFlags flags=0); // Plots a centered text label at point x,y with an optional pixel offset. Text color can be changed with ImPlot::PushStyleColor(ImPlotCol_InlayText, ...). IMPLOT_API void PlotText(const char* text, double x, double y, const ImVec2& pix_offset=ImVec2(0,0), ImPlotTextFlags flags=0); // Plots a dummy item (i.e. adds a legend entry colored by ImPlotCol_Line) IMPLOT_API void PlotDummy(const char* label_id, ImPlotDummyFlags flags=0); //----------------------------------------------------------------------------- // [SECTION] Plot Tools //----------------------------------------------------------------------------- // The following can be used to render interactive elements and/or annotations. // Like the item plotting functions above, they apply to the current x and y // axes, which can be changed with `SetAxis/SetAxes`. // Shows a draggable point at x,y. #col defaults to ImGuiCol_Text. IMPLOT_API bool DragPoint(int id, double* x, double* y, const ImVec4& col, float size = 4, ImPlotDragToolFlags flags=0); // Shows a draggable vertical guide line at an x-value. #col defaults to ImGuiCol_Text. IMPLOT_API bool DragLineX(int id, double* x, const ImVec4& col, float thickness = 1, ImPlotDragToolFlags flags=0); // Shows a draggable horizontal guide line at a y-value. #col defaults to ImGuiCol_Text. IMPLOT_API bool DragLineY(int id, double* y, const ImVec4& col, float thickness = 1, ImPlotDragToolFlags flags=0); // Shows a draggable and resizeable rectangle. IMPLOT_API bool DragRect(int id, double* x1, double* y1, double* x2, double* y2, const ImVec4& col, ImPlotDragToolFlags flags=0); // Shows an annotation callout at a chosen point. Clamping keeps annotations in the plot area. Annotations are always rendered on top. IMPLOT_API void Annotation(double x, double y, const ImVec4& col, const ImVec2& pix_offset, bool clamp, bool round = false); IMPLOT_API void Annotation(double x, double y, const ImVec4& col, const ImVec2& pix_offset, bool clamp, const char* fmt, ...) IM_FMTARGS(6); IMPLOT_API void AnnotationV(double x, double y, const ImVec4& col, const ImVec2& pix_offset, bool clamp, const char* fmt, va_list args) IM_FMTLIST(6); // Shows a x-axis tag at the specified coordinate value. IMPLOT_API void TagX(double x, const ImVec4& col, bool round = false); IMPLOT_API void TagX(double x, const ImVec4& col, const char* fmt, ...) IM_FMTARGS(3); IMPLOT_API void TagXV(double x, const ImVec4& col, const char* fmt, va_list args) IM_FMTLIST(3); // Shows a y-axis tag at the specified coordinate value. IMPLOT_API void TagY(double y, const ImVec4& col, bool round = false); IMPLOT_API void TagY(double y, const ImVec4& col, const char* fmt, ...) IM_FMTARGS(3); IMPLOT_API void TagYV(double y, const ImVec4& col, const char* fmt, va_list args) IM_FMTLIST(3); //----------------------------------------------------------------------------- // [SECTION] Plot Utils //----------------------------------------------------------------------------- // Select which axis/axes will be used for subsequent plot elements. IMPLOT_API void SetAxis(ImAxis axis); IMPLOT_API void SetAxes(ImAxis x_axis, ImAxis y_axis); // Convert pixels to a position in the current plot's coordinate system. Passing IMPLOT_AUTO uses the current axes. IMPLOT_API ImPlotPoint PixelsToPlot(const ImVec2& pix, ImAxis x_axis = IMPLOT_AUTO, ImAxis y_axis = IMPLOT_AUTO); IMPLOT_API ImPlotPoint PixelsToPlot(float x, float y, ImAxis x_axis = IMPLOT_AUTO, ImAxis y_axis = IMPLOT_AUTO); // Convert a position in the current plot's coordinate system to pixels. Passing IMPLOT_AUTO uses the current axes. IMPLOT_API ImVec2 PlotToPixels(const ImPlotPoint& plt, ImAxis x_axis = IMPLOT_AUTO, ImAxis y_axis = IMPLOT_AUTO); IMPLOT_API ImVec2 PlotToPixels(double x, double y, ImAxis x_axis = IMPLOT_AUTO, ImAxis y_axis = IMPLOT_AUTO); // Get the current Plot position (top-left) in pixels. IMPLOT_API ImVec2 GetPlotPos(); // Get the curent Plot size in pixels. IMPLOT_API ImVec2 GetPlotSize(); // Returns the mouse position in x,y coordinates of the current plot. Passing IMPLOT_AUTO uses the current axes. IMPLOT_API ImPlotPoint GetPlotMousePos(ImAxis x_axis = IMPLOT_AUTO, ImAxis y_axis = IMPLOT_AUTO); // Returns the current plot axis range. IMPLOT_API ImPlotRect GetPlotLimits(ImAxis x_axis = IMPLOT_AUTO, ImAxis y_axis = IMPLOT_AUTO); // Returns true if the plot area in the current plot is hovered. IMPLOT_API bool IsPlotHovered(); // Returns true if the axis label area in the current plot is hovered. IMPLOT_API bool IsAxisHovered(ImAxis axis); // Returns true if the bounding frame of a subplot is hovered. IMPLOT_API bool IsSubplotsHovered(); // Returns true if the current plot is being box selected. IMPLOT_API bool IsPlotSelected(); // Returns the current plot box selection bounds. Passing IMPLOT_AUTO uses the current axes. IMPLOT_API ImPlotRect GetPlotSelection(ImAxis x_axis = IMPLOT_AUTO, ImAxis y_axis = IMPLOT_AUTO); // Cancels a the current plot box selection. IMPLOT_API void CancelPlotSelection(); // Hides or shows the next plot item (i.e. as if it were toggled from the legend). // Use ImPlotCond_Always if you need to forcefully set this every frame. IMPLOT_API void HideNextItem(bool hidden = true, ImPlotCond cond = ImPlotCond_Once); // Use the following around calls to Begin/EndPlot to align l/r/t/b padding. // Consider using Begin/EndSubplots first. They are more feature rich and // accomplish the same behaviour by default. The functions below offer lower // level control of plot alignment. // Align axis padding over multiple plots in a single row or column. #group_id must // be unique. If this function returns true, EndAlignedPlots() must be called. IMPLOT_API bool BeginAlignedPlots(const char* group_id, bool vertical = true); // Only call EndAlignedPlots() if BeginAlignedPlots() returns true! IMPLOT_API void EndAlignedPlots(); //----------------------------------------------------------------------------- // [SECTION] Legend Utils //----------------------------------------------------------------------------- // Begin a popup for a legend entry. IMPLOT_API bool BeginLegendPopup(const char* label_id, ImGuiMouseButton mouse_button=1); // End a popup for a legend entry. IMPLOT_API void EndLegendPopup(); // Returns true if a plot item legend entry is hovered. IMPLOT_API bool IsLegendEntryHovered(const char* label_id); //----------------------------------------------------------------------------- // [SECTION] Drag and Drop //----------------------------------------------------------------------------- // Turns the current plot's plotting area into a drag and drop target. Don't forget to call EndDragDropTarget! IMPLOT_API bool BeginDragDropTargetPlot(); // Turns the current plot's X-axis into a drag and drop target. Don't forget to call EndDragDropTarget! IMPLOT_API bool BeginDragDropTargetAxis(ImAxis axis); // Turns the current plot's legend into a drag and drop target. Don't forget to call EndDragDropTarget! IMPLOT_API bool BeginDragDropTargetLegend(); // Ends a drag and drop target (currently just an alias for ImGui::EndDragDropTarget). IMPLOT_API void EndDragDropTarget(); // NB: By default, plot and axes drag and drop *sources* require holding the Ctrl modifier to initiate the drag. // You can change the modifier if desired. If ImGuiMod_None is provided, the axes will be locked from panning. // Turns the current plot's plotting area into a drag and drop source. You must hold Ctrl. Don't forget to call EndDragDropSource! IMPLOT_API bool BeginDragDropSourcePlot(ImGuiDragDropFlags flags=0); // Turns the current plot's X-axis into a drag and drop source. You must hold Ctrl. Don't forget to call EndDragDropSource! IMPLOT_API bool BeginDragDropSourceAxis(ImAxis axis, ImGuiDragDropFlags flags=0); // Turns an item in the current plot's legend into drag and drop source. Don't forget to call EndDragDropSource! IMPLOT_API bool BeginDragDropSourceItem(const char* label_id, ImGuiDragDropFlags flags=0); // Ends a drag and drop source (currently just an alias for ImGui::EndDragDropSource). IMPLOT_API void EndDragDropSource(); //----------------------------------------------------------------------------- // [SECTION] Styling //----------------------------------------------------------------------------- // Styling colors in ImPlot works similarly to styling colors in ImGui, but // with one important difference. Like ImGui, all style colors are stored in an // indexable array in ImPlotStyle. You can permanently modify these values through // GetStyle().Colors, or temporarily modify them with Push/Pop functions below. // However, by default all style colors in ImPlot default to a special color // IMPLOT_AUTO_COL. The behavior of this color depends upon the style color to // which it as applied: // // 1) For style colors associated with plot items (e.g. ImPlotCol_Line), // IMPLOT_AUTO_COL tells ImPlot to color the item with the next unused // color in the current colormap. Thus, every item will have a different // color up to the number of colors in the colormap, at which point the // colormap will roll over. For most use cases, you should not need to // set these style colors to anything but IMPLOT_COL_AUTO; you are // probably better off changing the current colormap. However, if you // need to explicitly color a particular item you may either Push/Pop // the style color around the item in question, or use the SetNextXXXStyle // API below. If you permanently set one of these style colors to a specific // color, or forget to call Pop, then all subsequent items will be styled // with the color you set. // // 2) For style colors associated with plot styling (e.g. ImPlotCol_PlotBg), // IMPLOT_AUTO_COL tells ImPlot to set that color from color data in your // **ImGuiStyle**. The ImGuiCol_ that these style colors default to are // detailed above, and in general have been mapped to produce plots visually // consistent with your current ImGui style. Of course, you are free to // manually set these colors to whatever you like, and further can Push/Pop // them around individual plots for plot-specific styling (e.g. coloring axes). // Provides access to plot style structure for permanant modifications to colors, sizes, etc. IMPLOT_API ImPlotStyle& GetStyle(); // Style plot colors for current ImGui style (default). IMPLOT_API void StyleColorsAuto(ImPlotStyle* dst = nullptr); // Style plot colors for ImGui "Classic". IMPLOT_API void StyleColorsClassic(ImPlotStyle* dst = nullptr); // Style plot colors for ImGui "Dark". IMPLOT_API void StyleColorsDark(ImPlotStyle* dst = nullptr); // Style plot colors for ImGui "Light". IMPLOT_API void StyleColorsLight(ImPlotStyle* dst = nullptr); // Use PushStyleX to temporarily modify your ImPlotStyle. The modification // will last until the matching call to PopStyleX. You MUST call a pop for // every push, otherwise you will leak memory! This behaves just like ImGui. // Temporarily modify a style color. Don't forget to call PopStyleColor! IMPLOT_API void PushStyleColor(ImPlotCol idx, ImU32 col); IMPLOT_API void PushStyleColor(ImPlotCol idx, const ImVec4& col); // Undo temporary style color modification(s). Undo multiple pushes at once by increasing count. IMPLOT_API void PopStyleColor(int count = 1); // Temporarily modify a style variable of float type. Don't forget to call PopStyleVar! IMPLOT_API void PushStyleVar(ImPlotStyleVar idx, float val); // Temporarily modify a style variable of int type. Don't forget to call PopStyleVar! IMPLOT_API void PushStyleVar(ImPlotStyleVar idx, int val); // Temporarily modify a style variable of ImVec2 type. Don't forget to call PopStyleVar! IMPLOT_API void PushStyleVar(ImPlotStyleVar idx, const ImVec2& val); // Undo temporary style variable modification(s). Undo multiple pushes at once by increasing count. IMPLOT_API void PopStyleVar(int count = 1); // The following can be used to modify the style of the next plot item ONLY. They do // NOT require calls to PopStyleX. Leave style attributes you don't want modified to // IMPLOT_AUTO or IMPLOT_AUTO_COL. Automatic styles will be deduced from the current // values in your ImPlotStyle or from Colormap data. // Set the line color and weight for the next item only. IMPLOT_API void SetNextLineStyle(const ImVec4& col = IMPLOT_AUTO_COL, float weight = IMPLOT_AUTO); // Set the fill color for the next item only. IMPLOT_API void SetNextFillStyle(const ImVec4& col = IMPLOT_AUTO_COL, float alpha_mod = IMPLOT_AUTO); // Set the marker style for the next item only. IMPLOT_API void SetNextMarkerStyle(ImPlotMarker marker = IMPLOT_AUTO, float size = IMPLOT_AUTO, const ImVec4& fill = IMPLOT_AUTO_COL, float weight = IMPLOT_AUTO, const ImVec4& outline = IMPLOT_AUTO_COL); // Set the error bar style for the next item only. IMPLOT_API void SetNextErrorBarStyle(const ImVec4& col = IMPLOT_AUTO_COL, float size = IMPLOT_AUTO, float weight = IMPLOT_AUTO); // Gets the last item primary color (i.e. its legend icon color) IMPLOT_API ImVec4 GetLastItemColor(); // Returns the null terminated string name for an ImPlotCol. IMPLOT_API const char* GetStyleColorName(ImPlotCol idx); // Returns the null terminated string name for an ImPlotMarker. IMPLOT_API const char* GetMarkerName(ImPlotMarker idx); //----------------------------------------------------------------------------- // [SECTION] Colormaps //----------------------------------------------------------------------------- // Item styling is based on colormaps when the relevant ImPlotCol_XXX is set to // IMPLOT_AUTO_COL (default). Several built-in colormaps are available. You can // add and then push/pop your own colormaps as well. To permanently set a colormap, // modify the Colormap index member of your ImPlotStyle. // Colormap data will be ignored and a custom color will be used if you have done one of the following: // 1) Modified an item style color in your ImPlotStyle to anything other than IMPLOT_AUTO_COL. // 2) Pushed an item style color using PushStyleColor(). // 3) Set the next item style with a SetNextXXXStyle function. // Add a new colormap. The color data will be copied. The colormap can be used by pushing either the returned index or the // string name with PushColormap. The colormap name must be unique and the size must be greater than 1. You will receive // an assert otherwise! By default colormaps are considered to be qualitative (i.e. discrete). If you want to create a // continuous colormap, set #qual=false. This will treat the colors you provide as keys, and ImPlot will build a linearly // interpolated lookup table. The memory footprint of this table will be exactly ((size-1)*255+1)*4 bytes. IMPLOT_API ImPlotColormap AddColormap(const char* name, const ImVec4* cols, int size, bool qual=true); IMPLOT_API ImPlotColormap AddColormap(const char* name, const ImU32* cols, int size, bool qual=true); // Returns the number of available colormaps (i.e. the built-in + user-added count). IMPLOT_API int GetColormapCount(); // Returns a null terminated string name for a colormap given an index. Returns nullptr if index is invalid. IMPLOT_API const char* GetColormapName(ImPlotColormap cmap); // Returns an index number for a colormap given a valid string name. Returns -1 if name is invalid. IMPLOT_API ImPlotColormap GetColormapIndex(const char* name); // Temporarily switch to one of the built-in (i.e. ImPlotColormap_XXX) or user-added colormaps (i.e. a return value of AddColormap). Don't forget to call PopColormap! IMPLOT_API void PushColormap(ImPlotColormap cmap); // Push a colormap by string name. Use built-in names such as "Default", "Deep", "Jet", etc. or a string you provided to AddColormap. Don't forget to call PopColormap! IMPLOT_API void PushColormap(const char* name); // Undo temporary colormap modification(s). Undo multiple pushes at once by increasing count. IMPLOT_API void PopColormap(int count = 1); // Returns the next color from the current colormap and advances the colormap for the current plot. // Can also be used with no return value to skip colors if desired. You need to call this between Begin/EndPlot! IMPLOT_API ImVec4 NextColormapColor(); // Colormap utils. If cmap = IMPLOT_AUTO (default), the current colormap is assumed. // Pass an explicit colormap index (built-in or user-added) to specify otherwise. // Returns the size of a colormap. IMPLOT_API int GetColormapSize(ImPlotColormap cmap = IMPLOT_AUTO); // Returns a color from a colormap given an index >= 0 (modulo will be performed). IMPLOT_API ImVec4 GetColormapColor(int idx, ImPlotColormap cmap = IMPLOT_AUTO); // Sample a color from the current colormap given t between 0 and 1. IMPLOT_API ImVec4 SampleColormap(float t, ImPlotColormap cmap = IMPLOT_AUTO); // Shows a vertical color scale with linear spaced ticks using the specified color map. Use double hashes to hide label (e.g. "##NoLabel"). If scale_min > scale_max, the scale to color mapping will be reversed. IMPLOT_API void ColormapScale(const char* label, double scale_min, double scale_max, const ImVec2& size = ImVec2(0,0), const char* format = "%g", ImPlotColormapScaleFlags flags = 0, ImPlotColormap cmap = IMPLOT_AUTO); // Shows a horizontal slider with a colormap gradient background. Optionally returns the color sampled at t in [0 1]. IMPLOT_API bool ColormapSlider(const char* label, float* t, ImVec4* out = nullptr, const char* format = "", ImPlotColormap cmap = IMPLOT_AUTO); // Shows a button with a colormap gradient brackground. IMPLOT_API bool ColormapButton(const char* label, const ImVec2& size = ImVec2(0,0), ImPlotColormap cmap = IMPLOT_AUTO); // When items in a plot sample their color from a colormap, the color is cached and does not change // unless explicitly overriden. Therefore, if you change the colormap after the item has already been plotted, // item colors will NOT update. If you need item colors to resample the new colormap, then use this // function to bust the cached colors. If #plot_title_id is nullptr, then every item in EVERY existing plot // will be cache busted. Otherwise only the plot specified by #plot_title_id will be busted. For the // latter, this function must be called in the same ImGui ID scope that the plot is in. You should rarely if ever // need this function, but it is available for applications that require runtime colormap swaps (e.g. Heatmaps demo). IMPLOT_API void BustColorCache(const char* plot_title_id = nullptr); //----------------------------------------------------------------------------- // [SECTION] Input Mapping //----------------------------------------------------------------------------- // Provides access to input mapping structure for permanant modifications to controls for pan, select, etc. IMPLOT_API ImPlotInputMap& GetInputMap(); // Default input mapping: pan = LMB drag, box select = RMB drag, fit = LMB double click, context menu = RMB click, zoom = scroll. IMPLOT_API void MapInputDefault(ImPlotInputMap* dst = nullptr); // Reverse input mapping: pan = RMB drag, box select = LMB drag, fit = LMB double click, context menu = RMB click, zoom = scroll. IMPLOT_API void MapInputReverse(ImPlotInputMap* dst = nullptr); //----------------------------------------------------------------------------- // [SECTION] Miscellaneous //----------------------------------------------------------------------------- // Render icons similar to those that appear in legends (nifty for data lists). IMPLOT_API void ItemIcon(const ImVec4& col); IMPLOT_API void ItemIcon(ImU32 col); IMPLOT_API void ColormapIcon(ImPlotColormap cmap); // Get the plot draw list for custom rendering to the current plot area. Call between Begin/EndPlot. IMPLOT_API ImDrawList* GetPlotDrawList(); // Push clip rect for rendering to current plot area. The rect can be expanded or contracted by #expand pixels. Call between Begin/EndPlot. IMPLOT_API void PushPlotClipRect(float expand=0); // Pop plot clip rect. Call between Begin/EndPlot. IMPLOT_API void PopPlotClipRect(); // Shows ImPlot style selector dropdown menu. IMPLOT_API bool ShowStyleSelector(const char* label); // Shows ImPlot colormap selector dropdown menu. IMPLOT_API bool ShowColormapSelector(const char* label); // Shows ImPlot input map selector dropdown menu. IMPLOT_API bool ShowInputMapSelector(const char* label); // Shows ImPlot style editor block (not a window). IMPLOT_API void ShowStyleEditor(ImPlotStyle* ref = nullptr); // Add basic help/info block for end users (not a window). IMPLOT_API void ShowUserGuide(); // Shows ImPlot metrics/debug information window. IMPLOT_API void ShowMetricsWindow(bool* p_popen = nullptr); //----------------------------------------------------------------------------- // [SECTION] Demo //----------------------------------------------------------------------------- // Shows the ImPlot demo window (add implot_demo.cpp to your sources!) IMPLOT_API void ShowDemoWindow(bool* p_open = nullptr); } // namespace ImPlot //----------------------------------------------------------------------------- // [SECTION] Obsolete API //----------------------------------------------------------------------------- // The following functions will be removed! Keep your copy of implot up to date! // Occasionally set '#define IMPLOT_DISABLE_OBSOLETE_FUNCTIONS' to stay ahead. // If you absolutely must use these functions and do not want to receive compiler // warnings, set '#define IMPLOT_DISABLE_OBSOLETE_WARNINGS'. #ifndef IMPLOT_DISABLE_OBSOLETE_FUNCTIONS #ifndef IMPLOT_DISABLE_DEPRECATED_WARNINGS #if __cplusplus > 201402L #define IMPLOT_DEPRECATED(method) [[deprecated]] method #elif defined( __GNUC__ ) && !defined( __INTEL_COMPILER ) && ( __GNUC__ > 3 || ( __GNUC__ == 3 && __GNUC_MINOR__ >= 1 ) ) #define IMPLOT_DEPRECATED(method) method __attribute__( ( deprecated ) ) #elif defined( _MSC_VER ) #define IMPLOT_DEPRECATED(method) __declspec(deprecated) method #else #define IMPLOT_DEPRECATED(method) method #endif #else #define IMPLOT_DEPRECATED(method) method #endif enum ImPlotFlagsObsolete_ { ImPlotFlags_YAxis2 = 1 << 20, ImPlotFlags_YAxis3 = 1 << 21, }; namespace ImPlot { // OBSOLETED in v0.13 -> PLANNED REMOVAL in v1.0 IMPLOT_DEPRECATED( IMPLOT_API bool BeginPlot(const char* title_id, const char* x_label, // = nullptr, const char* y_label, // = nullptr, const ImVec2& size = ImVec2(-1,0), ImPlotFlags flags = ImPlotFlags_None, ImPlotAxisFlags x_flags = 0, ImPlotAxisFlags y_flags = 0, ImPlotAxisFlags y2_flags = ImPlotAxisFlags_AuxDefault, ImPlotAxisFlags y3_flags = ImPlotAxisFlags_AuxDefault, const char* y2_label = nullptr, const char* y3_label = nullptr) ); } // namespace ImPlot #endif ================================================ FILE: src/DesktopPlusUI/implot/implot_internal.h ================================================ // MIT License // Copyright (c) 2023 Evan Pezent // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files (the "Software"), to deal // in the Software without restriction, including without limitation the rights // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell // copies of the Software, and to permit persons to whom the Software is // furnished to do so, subject to the following conditions: // The above copyright notice and this permission notice shall be included in all // copies or substantial portions of the Software. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE // SOFTWARE. // ImPlot v0.16 // You may use this file to debug, understand or extend ImPlot features but we // don't provide any guarantee of forward compatibility! //----------------------------------------------------------------------------- // [SECTION] Header Mess //----------------------------------------------------------------------------- #pragma once #include #include "imgui_internal.h" #ifndef IMPLOT_VERSION #error Must include implot.h before implot_internal.h #endif // Support for pre-1.84 versions. ImPool's GetSize() -> GetBufSize() #if (IMGUI_VERSION_NUM < 18303) #define GetBufSize GetSize #endif //----------------------------------------------------------------------------- // [SECTION] Constants //----------------------------------------------------------------------------- // Constants can be changed unless stated otherwise. We may move some of these // to ImPlotStyleVar_ over time. // Mimimum allowable timestamp value 01/01/1970 @ 12:00am (UTC) (DO NOT DECREASE THIS) #define IMPLOT_MIN_TIME 0 // Maximum allowable timestamp value 01/01/3000 @ 12:00am (UTC) (DO NOT INCREASE THIS) #define IMPLOT_MAX_TIME 32503680000 // Default label format for axis labels #define IMPLOT_LABEL_FORMAT "%g" // Max character size for tick labels #define IMPLOT_LABEL_MAX_SIZE 32 //----------------------------------------------------------------------------- // [SECTION] Macros //----------------------------------------------------------------------------- #define IMPLOT_NUM_X_AXES ImAxis_Y1 #define IMPLOT_NUM_Y_AXES (ImAxis_COUNT - IMPLOT_NUM_X_AXES) // Split ImU32 color into RGB components [0 255] #define IM_COL32_SPLIT_RGB(col,r,g,b) \ ImU32 r = ((col >> IM_COL32_R_SHIFT) & 0xFF); \ ImU32 g = ((col >> IM_COL32_G_SHIFT) & 0xFF); \ ImU32 b = ((col >> IM_COL32_B_SHIFT) & 0xFF); //----------------------------------------------------------------------------- // [SECTION] Forward Declarations //----------------------------------------------------------------------------- struct ImPlotTick; struct ImPlotAxis; struct ImPlotAxisColor; struct ImPlotItem; struct ImPlotLegend; struct ImPlotPlot; struct ImPlotNextPlotData; struct ImPlotTicker; //----------------------------------------------------------------------------- // [SECTION] Context Pointer //----------------------------------------------------------------------------- #ifndef GImPlot extern IMPLOT_API ImPlotContext* GImPlot; // Current implicit context pointer #endif //----------------------------------------------------------------------------- // [SECTION] Generic Helpers //----------------------------------------------------------------------------- // Computes the common (base-10) logarithm static inline float ImLog10(float x) { return log10f(x); } static inline double ImLog10(double x) { return log10(x); } static inline float ImSinh(float x) { return sinhf(x); } static inline double ImSinh(double x) { return sinh(x); } static inline float ImAsinh(float x) { return asinhf(x); } static inline double ImAsinh(double x) { return asinh(x); } // Returns true if a flag is set template static inline bool ImHasFlag(TSet set, TFlag flag) { return (set & flag) == flag; } // Flips a flag in a flagset template static inline void ImFlipFlag(TSet& set, TFlag flag) { ImHasFlag(set, flag) ? set &= ~flag : set |= flag; } // Linearly remaps x from [x0 x1] to [y0 y1]. template static inline T ImRemap(T x, T x0, T x1, T y0, T y1) { return y0 + (x - x0) * (y1 - y0) / (x1 - x0); } // Linear rempas x from [x0 x1] to [0 1] template static inline T ImRemap01(T x, T x0, T x1) { return (x - x0) / (x1 - x0); } // Returns always positive modulo (assumes r != 0) static inline int ImPosMod(int l, int r) { return (l % r + r) % r; } // Returns true if val is NAN static inline bool ImNan(double val) { return isnan(val); } // Returns true if val is NAN or INFINITY static inline bool ImNanOrInf(double val) { return !(val >= -DBL_MAX && val <= DBL_MAX) || ImNan(val); } // Turns NANs to 0s static inline double ImConstrainNan(double val) { return ImNan(val) ? 0 : val; } // Turns infinity to floating point maximums static inline double ImConstrainInf(double val) { return val >= DBL_MAX ? DBL_MAX : val <= -DBL_MAX ? - DBL_MAX : val; } // Turns numbers less than or equal to 0 to 0.001 (sort of arbitrary, is there a better way?) static inline double ImConstrainLog(double val) { return val <= 0 ? 0.001f : val; } // Turns numbers less than 0 to zero static inline double ImConstrainTime(double val) { return val < IMPLOT_MIN_TIME ? IMPLOT_MIN_TIME : (val > IMPLOT_MAX_TIME ? IMPLOT_MAX_TIME : val); } // True if two numbers are approximately equal using units in the last place. static inline bool ImAlmostEqual(double v1, double v2, int ulp = 2) { return ImAbs(v1-v2) < DBL_EPSILON * ImAbs(v1+v2) * ulp || ImAbs(v1-v2) < DBL_MIN; } // Finds min value in an unsorted array template static inline T ImMinArray(const T* values, int count) { T m = values[0]; for (int i = 1; i < count; ++i) { if (values[i] < m) { m = values[i]; } } return m; } // Finds the max value in an unsorted array template static inline T ImMaxArray(const T* values, int count) { T m = values[0]; for (int i = 1; i < count; ++i) { if (values[i] > m) { m = values[i]; } } return m; } // Finds the min and max value in an unsorted array template static inline void ImMinMaxArray(const T* values, int count, T* min_out, T* max_out) { T Min = values[0]; T Max = values[0]; for (int i = 1; i < count; ++i) { if (values[i] < Min) { Min = values[i]; } if (values[i] > Max) { Max = values[i]; } } *min_out = Min; *max_out = Max; } // Finds the sim of an array template static inline T ImSum(const T* values, int count) { T sum = 0; for (int i = 0; i < count; ++i) sum += values[i]; return sum; } // Finds the mean of an array template static inline double ImMean(const T* values, int count) { double den = 1.0 / count; double mu = 0; for (int i = 0; i < count; ++i) mu += (double)values[i] * den; return mu; } // Finds the sample standard deviation of an array template static inline double ImStdDev(const T* values, int count) { double den = 1.0 / (count - 1.0); double mu = ImMean(values, count); double x = 0; for (int i = 0; i < count; ++i) x += ((double)values[i] - mu) * ((double)values[i] - mu) * den; return sqrt(x); } // Mix color a and b by factor s in [0 256] static inline ImU32 ImMixU32(ImU32 a, ImU32 b, ImU32 s) { #ifdef IMPLOT_MIX64 const ImU32 af = 256-s; const ImU32 bf = s; const ImU64 al = (a & 0x00ff00ff) | (((ImU64)(a & 0xff00ff00)) << 24); const ImU64 bl = (b & 0x00ff00ff) | (((ImU64)(b & 0xff00ff00)) << 24); const ImU64 mix = (al * af + bl * bf); return ((mix >> 32) & 0xff00ff00) | ((mix & 0xff00ff00) >> 8); #else const ImU32 af = 256-s; const ImU32 bf = s; const ImU32 al = (a & 0x00ff00ff); const ImU32 ah = (a & 0xff00ff00) >> 8; const ImU32 bl = (b & 0x00ff00ff); const ImU32 bh = (b & 0xff00ff00) >> 8; const ImU32 ml = (al * af + bl * bf); const ImU32 mh = (ah * af + bh * bf); return (mh & 0xff00ff00) | ((ml & 0xff00ff00) >> 8); #endif } // Lerp across an array of 32-bit collors given t in [0.0 1.0] static inline ImU32 ImLerpU32(const ImU32* colors, int size, float t) { int i1 = (int)((size - 1 ) * t); int i2 = i1 + 1; if (i2 == size || size == 1) return colors[i1]; float den = 1.0f / (size - 1); float t1 = i1 * den; float t2 = i2 * den; float tr = ImRemap01(t, t1, t2); return ImMixU32(colors[i1], colors[i2], (ImU32)(tr*256)); } // Set alpha channel of 32-bit color from float in range [0.0 1.0] static inline ImU32 ImAlphaU32(ImU32 col, float alpha) { return col & ~((ImU32)((1.0f-alpha)*255)< static inline bool ImOverlaps(T min_a, T max_a, T min_b, T max_b) { return min_a <= max_b && min_b <= max_a; } //----------------------------------------------------------------------------- // [SECTION] ImPlot Enums //----------------------------------------------------------------------------- typedef int ImPlotTimeUnit; // -> enum ImPlotTimeUnit_ typedef int ImPlotDateFmt; // -> enum ImPlotDateFmt_ typedef int ImPlotTimeFmt; // -> enum ImPlotTimeFmt_ enum ImPlotTimeUnit_ { ImPlotTimeUnit_Us, // microsecond ImPlotTimeUnit_Ms, // millisecond ImPlotTimeUnit_S, // second ImPlotTimeUnit_Min, // minute ImPlotTimeUnit_Hr, // hour ImPlotTimeUnit_Day, // day ImPlotTimeUnit_Mo, // month ImPlotTimeUnit_Yr, // year ImPlotTimeUnit_COUNT }; enum ImPlotDateFmt_ { // default [ ISO 8601 ] ImPlotDateFmt_None = 0, ImPlotDateFmt_DayMo, // 10/3 [ --10-03 ] ImPlotDateFmt_DayMoYr, // 10/3/91 [ 1991-10-03 ] ImPlotDateFmt_MoYr, // Oct 1991 [ 1991-10 ] ImPlotDateFmt_Mo, // Oct [ --10 ] ImPlotDateFmt_Yr // 1991 [ 1991 ] }; enum ImPlotTimeFmt_ { // default [ 24 Hour Clock ] ImPlotTimeFmt_None = 0, ImPlotTimeFmt_Us, // .428 552 [ .428 552 ] ImPlotTimeFmt_SUs, // :29.428 552 [ :29.428 552 ] ImPlotTimeFmt_SMs, // :29.428 [ :29.428 ] ImPlotTimeFmt_S, // :29 [ :29 ] ImPlotTimeFmt_MinSMs, // 21:29.428 [ 21:29.428 ] ImPlotTimeFmt_HrMinSMs, // 7:21:29.428pm [ 19:21:29.428 ] ImPlotTimeFmt_HrMinS, // 7:21:29pm [ 19:21:29 ] ImPlotTimeFmt_HrMin, // 7:21pm [ 19:21 ] ImPlotTimeFmt_Hr // 7pm [ 19:00 ] }; //----------------------------------------------------------------------------- // [SECTION] Callbacks //----------------------------------------------------------------------------- typedef void (*ImPlotLocator)(ImPlotTicker& ticker, const ImPlotRange& range, float pixels, bool vertical, ImPlotFormatter formatter, void* formatter_data); //----------------------------------------------------------------------------- // [SECTION] Structs //----------------------------------------------------------------------------- // Combined date/time format spec struct ImPlotDateTimeSpec { ImPlotDateTimeSpec() {} ImPlotDateTimeSpec(ImPlotDateFmt date_fmt, ImPlotTimeFmt time_fmt, bool use_24_hr_clk = false, bool use_iso_8601 = false) { Date = date_fmt; Time = time_fmt; UseISO8601 = use_iso_8601; Use24HourClock = use_24_hr_clk; } ImPlotDateFmt Date; ImPlotTimeFmt Time; bool UseISO8601; bool Use24HourClock; }; // Two part timestamp struct. struct ImPlotTime { time_t S; // second part int Us; // microsecond part ImPlotTime() { S = 0; Us = 0; } ImPlotTime(time_t s, int us = 0) { S = s + us / 1000000; Us = us % 1000000; } void RollOver() { S = S + Us / 1000000; Us = Us % 1000000; } double ToDouble() const { return (double)S + (double)Us / 1000000.0; } static ImPlotTime FromDouble(double t) { return ImPlotTime((time_t)t, (int)(t * 1000000 - floor(t) * 1000000)); } }; static inline ImPlotTime operator+(const ImPlotTime& lhs, const ImPlotTime& rhs) { return ImPlotTime(lhs.S + rhs.S, lhs.Us + rhs.Us); } static inline ImPlotTime operator-(const ImPlotTime& lhs, const ImPlotTime& rhs) { return ImPlotTime(lhs.S - rhs.S, lhs.Us - rhs.Us); } static inline bool operator==(const ImPlotTime& lhs, const ImPlotTime& rhs) { return lhs.S == rhs.S && lhs.Us == rhs.Us; } static inline bool operator<(const ImPlotTime& lhs, const ImPlotTime& rhs) { return lhs.S == rhs.S ? lhs.Us < rhs.Us : lhs.S < rhs.S; } static inline bool operator>(const ImPlotTime& lhs, const ImPlotTime& rhs) { return rhs < lhs; } static inline bool operator<=(const ImPlotTime& lhs, const ImPlotTime& rhs) { return lhs < rhs || lhs == rhs; } static inline bool operator>=(const ImPlotTime& lhs, const ImPlotTime& rhs) { return lhs > rhs || lhs == rhs; } // Colormap data storage struct ImPlotColormapData { ImVector Keys; ImVector KeyCounts; ImVector KeyOffsets; ImVector Tables; ImVector TableSizes; ImVector TableOffsets; ImGuiTextBuffer Text; ImVector TextOffsets; ImVector Quals; ImGuiStorage Map; int Count; ImPlotColormapData() { Count = 0; } int Append(const char* name, const ImU32* keys, int count, bool qual) { if (GetIndex(name) != -1) return -1; KeyOffsets.push_back(Keys.size()); KeyCounts.push_back(count); Keys.reserve(Keys.size()+count); for (int i = 0; i < count; ++i) Keys.push_back(keys[i]); TextOffsets.push_back(Text.size()); Text.append(name, name + strlen(name) + 1); Quals.push_back(qual); ImGuiID id = ImHashStr(name); int idx = Count++; Map.SetInt(id,idx); _AppendTable(idx); return idx; } void _AppendTable(ImPlotColormap cmap) { int key_count = GetKeyCount(cmap); const ImU32* keys = GetKeys(cmap); int off = Tables.size(); TableOffsets.push_back(off); if (IsQual(cmap)) { Tables.reserve(key_count); for (int i = 0; i < key_count; ++i) Tables.push_back(keys[i]); TableSizes.push_back(key_count); } else { int max_size = 255 * (key_count-1) + 1; Tables.reserve(off + max_size); // ImU32 last = keys[0]; // Tables.push_back(last); // int n = 1; for (int i = 0; i < key_count-1; ++i) { for (int s = 0; s < 255; ++s) { ImU32 a = keys[i]; ImU32 b = keys[i+1]; ImU32 c = ImMixU32(a,b,s); // if (c != last) { Tables.push_back(c); // last = c; // n++; // } } } ImU32 c = keys[key_count-1]; // if (c != last) { Tables.push_back(c); // n++; // } // TableSizes.push_back(n); TableSizes.push_back(max_size); } } void RebuildTables() { Tables.resize(0); TableSizes.resize(0); TableOffsets.resize(0); for (int i = 0; i < Count; ++i) _AppendTable(i); } inline bool IsQual(ImPlotColormap cmap) const { return Quals[cmap]; } inline const char* GetName(ImPlotColormap cmap) const { return cmap < Count ? Text.Buf.Data + TextOffsets[cmap] : nullptr; } inline ImPlotColormap GetIndex(const char* name) const { ImGuiID key = ImHashStr(name); return Map.GetInt(key,-1); } inline const ImU32* GetKeys(ImPlotColormap cmap) const { return &Keys[KeyOffsets[cmap]]; } inline int GetKeyCount(ImPlotColormap cmap) const { return KeyCounts[cmap]; } inline ImU32 GetKeyColor(ImPlotColormap cmap, int idx) const { return Keys[KeyOffsets[cmap]+idx]; } inline void SetKeyColor(ImPlotColormap cmap, int idx, ImU32 value) { Keys[KeyOffsets[cmap]+idx] = value; RebuildTables(); } inline const ImU32* GetTable(ImPlotColormap cmap) const { return &Tables[TableOffsets[cmap]]; } inline int GetTableSize(ImPlotColormap cmap) const { return TableSizes[cmap]; } inline ImU32 GetTableColor(ImPlotColormap cmap, int idx) const { return Tables[TableOffsets[cmap]+idx]; } inline ImU32 LerpTable(ImPlotColormap cmap, float t) const { int off = TableOffsets[cmap]; int siz = TableSizes[cmap]; int idx = Quals[cmap] ? ImClamp((int)(siz*t),0,siz-1) : (int)((siz - 1) * t + 0.5f); return Tables[off + idx]; } }; // ImPlotPoint with positive/negative error values struct ImPlotPointError { double X, Y, Neg, Pos; ImPlotPointError(double x, double y, double neg, double pos) { X = x; Y = y; Neg = neg; Pos = pos; } }; // Interior plot label/annotation struct ImPlotAnnotation { ImVec2 Pos; ImVec2 Offset; ImU32 ColorBg; ImU32 ColorFg; int TextOffset; bool Clamp; ImPlotAnnotation() { ColorBg = ColorFg = 0; TextOffset = 0; Clamp = false; } }; // Collection of plot labels struct ImPlotAnnotationCollection { ImVector Annotations; ImGuiTextBuffer TextBuffer; int Size; ImPlotAnnotationCollection() { Reset(); } void AppendV(const ImVec2& pos, const ImVec2& off, ImU32 bg, ImU32 fg, bool clamp, const char* fmt, va_list args) IM_FMTLIST(7) { ImPlotAnnotation an; an.Pos = pos; an.Offset = off; an.ColorBg = bg; an.ColorFg = fg; an.TextOffset = TextBuffer.size(); an.Clamp = clamp; Annotations.push_back(an); TextBuffer.appendfv(fmt, args); const char nul[] = ""; TextBuffer.append(nul,nul+1); Size++; } void Append(const ImVec2& pos, const ImVec2& off, ImU32 bg, ImU32 fg, bool clamp, const char* fmt, ...) IM_FMTARGS(7) { va_list args; va_start(args, fmt); AppendV(pos, off, bg, fg, clamp, fmt, args); va_end(args); } const char* GetText(int idx) { return TextBuffer.Buf.Data + Annotations[idx].TextOffset; } void Reset() { Annotations.shrink(0); TextBuffer.Buf.shrink(0); Size = 0; } }; struct ImPlotTag { ImAxis Axis; double Value; ImU32 ColorBg; ImU32 ColorFg; int TextOffset; }; struct ImPlotTagCollection { ImVector Tags; ImGuiTextBuffer TextBuffer; int Size; ImPlotTagCollection() { Reset(); } void AppendV(ImAxis axis, double value, ImU32 bg, ImU32 fg, const char* fmt, va_list args) IM_FMTLIST(6) { ImPlotTag tag; tag.Axis = axis; tag.Value = value; tag.ColorBg = bg; tag.ColorFg = fg; tag.TextOffset = TextBuffer.size(); Tags.push_back(tag); TextBuffer.appendfv(fmt, args); const char nul[] = ""; TextBuffer.append(nul,nul+1); Size++; } void Append(ImAxis axis, double value, ImU32 bg, ImU32 fg, const char* fmt, ...) IM_FMTARGS(6) { va_list args; va_start(args, fmt); AppendV(axis, value, bg, fg, fmt, args); va_end(args); } const char* GetText(int idx) { return TextBuffer.Buf.Data + Tags[idx].TextOffset; } void Reset() { Tags.shrink(0); TextBuffer.Buf.shrink(0); Size = 0; } }; // Tick mark info struct ImPlotTick { double PlotPos; float PixelPos; ImVec2 LabelSize; int TextOffset; bool Major; bool ShowLabel; int Level; int Idx; ImPlotTick(double value, bool major, int level, bool show_label) { PixelPos = 0; PlotPos = value; Major = major; ShowLabel = show_label; Level = level; TextOffset = -1; } }; // Collection of ticks struct ImPlotTicker { ImVector Ticks; ImGuiTextBuffer TextBuffer; ImVec2 MaxSize; ImVec2 LateSize; int Levels; ImPlotTicker() { Reset(); } ImPlotTick& AddTick(double value, bool major, int level, bool show_label, const char* label) { ImPlotTick tick(value, major, level, show_label); if (show_label && label != nullptr) { tick.TextOffset = TextBuffer.size(); TextBuffer.append(label, label + strlen(label) + 1); tick.LabelSize = ImGui::CalcTextSize(TextBuffer.Buf.Data + tick.TextOffset); } return AddTick(tick); } ImPlotTick& AddTick(double value, bool major, int level, bool show_label, ImPlotFormatter formatter, void* data) { ImPlotTick tick(value, major, level, show_label); if (show_label && formatter != nullptr) { char buff[IMPLOT_LABEL_MAX_SIZE]; tick.TextOffset = TextBuffer.size(); formatter(tick.PlotPos, buff, sizeof(buff), data); TextBuffer.append(buff, buff + strlen(buff) + 1); tick.LabelSize = ImGui::CalcTextSize(TextBuffer.Buf.Data + tick.TextOffset); } return AddTick(tick); } inline ImPlotTick& AddTick(ImPlotTick tick) { if (tick.ShowLabel) { MaxSize.x = tick.LabelSize.x > MaxSize.x ? tick.LabelSize.x : MaxSize.x; MaxSize.y = tick.LabelSize.y > MaxSize.y ? tick.LabelSize.y : MaxSize.y; } tick.Idx = Ticks.size(); Ticks.push_back(tick); return Ticks.back(); } const char* GetText(int idx) const { return TextBuffer.Buf.Data + Ticks[idx].TextOffset; } const char* GetText(const ImPlotTick& tick) { return GetText(tick.Idx); } void OverrideSizeLate(const ImVec2& size) { LateSize.x = size.x > LateSize.x ? size.x : LateSize.x; LateSize.y = size.y > LateSize.y ? size.y : LateSize.y; } void Reset() { Ticks.shrink(0); TextBuffer.Buf.shrink(0); MaxSize = LateSize; LateSize = ImVec2(0,0); Levels = 1; } int TickCount() const { return Ticks.Size; } }; // Axis state information that must persist after EndPlot struct ImPlotAxis { ImGuiID ID; ImPlotAxisFlags Flags; ImPlotAxisFlags PreviousFlags; ImPlotRange Range; ImPlotCond RangeCond; ImPlotScale Scale; ImPlotRange FitExtents; ImPlotAxis* OrthoAxis; ImPlotRange ConstraintRange; ImPlotRange ConstraintZoom; ImPlotTicker Ticker; ImPlotFormatter Formatter; void* FormatterData; char FormatSpec[16]; ImPlotLocator Locator; double* LinkedMin; double* LinkedMax; int PickerLevel; ImPlotTime PickerTimeMin, PickerTimeMax; ImPlotTransform TransformForward; ImPlotTransform TransformInverse; void* TransformData; float PixelMin, PixelMax; double ScaleMin, ScaleMax; double ScaleToPixel; float Datum1, Datum2; ImRect HoverRect; int LabelOffset; ImU32 ColorMaj, ColorMin, ColorTick, ColorTxt, ColorBg, ColorHov, ColorAct, ColorHiLi; bool Enabled; bool Vertical; bool FitThisFrame; bool HasRange; bool HasFormatSpec; bool ShowDefaultTicks; bool Hovered; bool Held; ImPlotAxis() { ID = 0; Flags = PreviousFlags = ImPlotAxisFlags_None; Range.Min = 0; Range.Max = 1; Scale = ImPlotScale_Linear; TransformForward = TransformInverse = nullptr; TransformData = nullptr; FitExtents.Min = HUGE_VAL; FitExtents.Max = -HUGE_VAL; OrthoAxis = nullptr; ConstraintRange = ImPlotRange(-INFINITY,INFINITY); ConstraintZoom = ImPlotRange(DBL_MIN,INFINITY); LinkedMin = LinkedMax = nullptr; PickerLevel = 0; Datum1 = Datum2 = 0; PixelMin = PixelMax = 0; LabelOffset = -1; ColorMaj = ColorMin = ColorTick = ColorTxt = ColorBg = ColorHov = ColorAct = 0; ColorHiLi = IM_COL32_BLACK_TRANS; Formatter = nullptr; FormatterData = nullptr; Locator = nullptr; Enabled = Hovered = Held = FitThisFrame = HasRange = HasFormatSpec = false; ShowDefaultTicks = true; } inline void Reset() { Enabled = false; Scale = ImPlotScale_Linear; TransformForward = TransformInverse = nullptr; TransformData = nullptr; LabelOffset = -1; HasFormatSpec = false; Formatter = nullptr; FormatterData = nullptr; Locator = nullptr; ShowDefaultTicks = true; FitThisFrame = false; FitExtents.Min = HUGE_VAL; FitExtents.Max = -HUGE_VAL; OrthoAxis = nullptr; ConstraintRange = ImPlotRange(-INFINITY,INFINITY); ConstraintZoom = ImPlotRange(DBL_MIN,INFINITY); Ticker.Reset(); } inline bool SetMin(double _min, bool force=false) { if (!force && IsLockedMin()) return false; _min = ImConstrainNan(ImConstrainInf(_min)); if (_min < ConstraintRange.Min) _min = ConstraintRange.Min; double z = Range.Max - _min; if (z < ConstraintZoom.Min) _min = Range.Max - ConstraintZoom.Min; if (z > ConstraintZoom.Max) _min = Range.Max - ConstraintZoom.Max; if (_min >= Range.Max) return false; Range.Min = _min; PickerTimeMin = ImPlotTime::FromDouble(Range.Min); UpdateTransformCache(); return true; }; inline bool SetMax(double _max, bool force=false) { if (!force && IsLockedMax()) return false; _max = ImConstrainNan(ImConstrainInf(_max)); if (_max > ConstraintRange.Max) _max = ConstraintRange.Max; double z = _max - Range.Min; if (z < ConstraintZoom.Min) _max = Range.Min + ConstraintZoom.Min; if (z > ConstraintZoom.Max) _max = Range.Min + ConstraintZoom.Max; if (_max <= Range.Min) return false; Range.Max = _max; PickerTimeMax = ImPlotTime::FromDouble(Range.Max); UpdateTransformCache(); return true; }; inline void SetRange(double v1, double v2) { Range.Min = ImMin(v1,v2); Range.Max = ImMax(v1,v2); Constrain(); PickerTimeMin = ImPlotTime::FromDouble(Range.Min); PickerTimeMax = ImPlotTime::FromDouble(Range.Max); UpdateTransformCache(); } inline void SetRange(const ImPlotRange& range) { SetRange(range.Min, range.Max); } inline void SetAspect(double unit_per_pix) { double new_size = unit_per_pix * PixelSize(); double delta = (new_size - Range.Size()) * 0.5; if (IsLocked()) return; else if (IsLockedMin() && !IsLockedMax()) SetRange(Range.Min, Range.Max + 2*delta); else if (!IsLockedMin() && IsLockedMax()) SetRange(Range.Min - 2*delta, Range.Max); else SetRange(Range.Min - delta, Range.Max + delta); } inline float PixelSize() const { return ImAbs(PixelMax - PixelMin); } inline double GetAspect() const { return Range.Size() / PixelSize(); } inline void Constrain() { Range.Min = ImConstrainNan(ImConstrainInf(Range.Min)); Range.Max = ImConstrainNan(ImConstrainInf(Range.Max)); if (Range.Min < ConstraintRange.Min) Range.Min = ConstraintRange.Min; if (Range.Max > ConstraintRange.Max) Range.Max = ConstraintRange.Max; double z = Range.Size(); if (z < ConstraintZoom.Min) { double delta = (ConstraintZoom.Min - z) * 0.5; Range.Min -= delta; Range.Max += delta; } if (z > ConstraintZoom.Max) { double delta = (z - ConstraintZoom.Max) * 0.5; Range.Min += delta; Range.Max -= delta; } if (Range.Max <= Range.Min) Range.Max = Range.Min + DBL_EPSILON; } inline void UpdateTransformCache() { ScaleToPixel = (PixelMax - PixelMin) / Range.Size(); if (TransformForward != nullptr) { ScaleMin = TransformForward(Range.Min, TransformData); ScaleMax = TransformForward(Range.Max, TransformData); } else { ScaleMin = Range.Min; ScaleMax = Range.Max; } } inline float PlotToPixels(double plt) const { if (TransformForward != nullptr) { double s = TransformForward(plt, TransformData); double t = (s - ScaleMin) / (ScaleMax - ScaleMin); plt = Range.Min + Range.Size() * t; } return (float)(PixelMin + ScaleToPixel * (plt - Range.Min)); } inline double PixelsToPlot(float pix) const { double plt = (pix - PixelMin) / ScaleToPixel + Range.Min; if (TransformInverse != nullptr) { double t = (plt - Range.Min) / Range.Size(); double s = t * (ScaleMax - ScaleMin) + ScaleMin; plt = TransformInverse(s, TransformData); } return plt; } inline void ExtendFit(double v) { if (!ImNanOrInf(v) && v >= ConstraintRange.Min && v <= ConstraintRange.Max) { FitExtents.Min = v < FitExtents.Min ? v : FitExtents.Min; FitExtents.Max = v > FitExtents.Max ? v : FitExtents.Max; } } inline void ExtendFitWith(ImPlotAxis& alt, double v, double v_alt) { if (ImHasFlag(Flags, ImPlotAxisFlags_RangeFit) && !alt.Range.Contains(v_alt)) return; if (!ImNanOrInf(v) && v >= ConstraintRange.Min && v <= ConstraintRange.Max) { FitExtents.Min = v < FitExtents.Min ? v : FitExtents.Min; FitExtents.Max = v > FitExtents.Max ? v : FitExtents.Max; } } inline void ApplyFit(float padding) { const double ext_size = FitExtents.Size() * 0.5; FitExtents.Min -= ext_size * padding; FitExtents.Max += ext_size * padding; if (!IsLockedMin() && !ImNanOrInf(FitExtents.Min)) Range.Min = FitExtents.Min; if (!IsLockedMax() && !ImNanOrInf(FitExtents.Max)) Range.Max = FitExtents.Max; if (ImAlmostEqual(Range.Min, Range.Max)) { Range.Max += 0.5; Range.Min -= 0.5; } Constrain(); UpdateTransformCache(); } inline bool HasLabel() const { return LabelOffset != -1 && !ImHasFlag(Flags, ImPlotAxisFlags_NoLabel); } inline bool HasGridLines() const { return !ImHasFlag(Flags, ImPlotAxisFlags_NoGridLines); } inline bool HasTickLabels() const { return !ImHasFlag(Flags, ImPlotAxisFlags_NoTickLabels); } inline bool HasTickMarks() const { return !ImHasFlag(Flags, ImPlotAxisFlags_NoTickMarks); } inline bool WillRender() const { return Enabled && (HasGridLines() || HasTickLabels() || HasTickMarks()); } inline bool IsOpposite() const { return ImHasFlag(Flags, ImPlotAxisFlags_Opposite); } inline bool IsInverted() const { return ImHasFlag(Flags, ImPlotAxisFlags_Invert); } inline bool IsForeground() const { return ImHasFlag(Flags, ImPlotAxisFlags_Foreground); } inline bool IsAutoFitting() const { return ImHasFlag(Flags, ImPlotAxisFlags_AutoFit); } inline bool CanInitFit() const { return !ImHasFlag(Flags, ImPlotAxisFlags_NoInitialFit) && !HasRange && !LinkedMin && !LinkedMax; } inline bool IsRangeLocked() const { return HasRange && RangeCond == ImPlotCond_Always; } inline bool IsLockedMin() const { return !Enabled || IsRangeLocked() || ImHasFlag(Flags, ImPlotAxisFlags_LockMin); } inline bool IsLockedMax() const { return !Enabled || IsRangeLocked() || ImHasFlag(Flags, ImPlotAxisFlags_LockMax); } inline bool IsLocked() const { return IsLockedMin() && IsLockedMax(); } inline bool IsInputLockedMin() const { return IsLockedMin() || IsAutoFitting(); } inline bool IsInputLockedMax() const { return IsLockedMax() || IsAutoFitting(); } inline bool IsInputLocked() const { return IsLocked() || IsAutoFitting(); } inline bool HasMenus() const { return !ImHasFlag(Flags, ImPlotAxisFlags_NoMenus); } inline bool IsPanLocked(bool increasing) { if (ImHasFlag(Flags, ImPlotAxisFlags_PanStretch)) { return IsInputLocked(); } else { if (IsLockedMin() || IsLockedMax() || IsAutoFitting()) return false; if (increasing) return Range.Max == ConstraintRange.Max; else return Range.Min == ConstraintRange.Min; } } void PushLinks() { if (LinkedMin) { *LinkedMin = Range.Min; } if (LinkedMax) { *LinkedMax = Range.Max; } } void PullLinks() { if (LinkedMin && LinkedMax) { SetRange(*LinkedMin, *LinkedMax); } else if (LinkedMin) { SetMin(*LinkedMin,true); } else if (LinkedMax) { SetMax(*LinkedMax,true); } } }; // Align plots group data struct ImPlotAlignmentData { bool Vertical; float PadA; float PadB; float PadAMax; float PadBMax; ImPlotAlignmentData() { Vertical = true; PadA = PadB = PadAMax = PadBMax = 0; } void Begin() { PadAMax = PadBMax = 0; } void Update(float& pad_a, float& pad_b, float& delta_a, float& delta_b) { float bak_a = pad_a; float bak_b = pad_b; if (PadAMax < pad_a) { PadAMax = pad_a; } if (PadBMax < pad_b) { PadBMax = pad_b; } if (pad_a < PadA) { pad_a = PadA; delta_a = pad_a - bak_a; } else { delta_a = 0; } if (pad_b < PadB) { pad_b = PadB; delta_b = pad_b - bak_b; } else { delta_b = 0; } } void End() { PadA = PadAMax; PadB = PadBMax; } void Reset() { PadA = PadB = PadAMax = PadBMax = 0; } }; // State information for Plot items struct ImPlotItem { ImGuiID ID; ImU32 Color; ImRect LegendHoverRect; int NameOffset; bool Show; bool LegendHovered; bool SeenThisFrame; ImPlotItem() { ID = 0; Color = IM_COL32_WHITE; NameOffset = -1; Show = true; SeenThisFrame = false; LegendHovered = false; } ~ImPlotItem() { ID = 0; } }; // Holds Legend state struct ImPlotLegend { ImPlotLegendFlags Flags; ImPlotLegendFlags PreviousFlags; ImPlotLocation Location; ImPlotLocation PreviousLocation; ImVector Indices; ImGuiTextBuffer Labels; ImRect Rect; bool Hovered; bool Held; bool CanGoInside; ImPlotLegend() { Flags = PreviousFlags = ImPlotLegendFlags_None; CanGoInside = true; Hovered = Held = false; Location = PreviousLocation = ImPlotLocation_NorthWest; } void Reset() { Indices.shrink(0); Labels.Buf.shrink(0); } }; // Holds Items and Legend data struct ImPlotItemGroup { ImGuiID ID; ImPlotLegend Legend; ImPool ItemPool; int ColormapIdx; ImPlotItemGroup() { ID = 0; ColormapIdx = 0; } int GetItemCount() const { return ItemPool.GetBufSize(); } ImGuiID GetItemID(const char* label_id) { return ImGui::GetID(label_id); /* GetIDWithSeed */ } ImPlotItem* GetItem(ImGuiID id) { return ItemPool.GetByKey(id); } ImPlotItem* GetItem(const char* label_id) { return GetItem(GetItemID(label_id)); } ImPlotItem* GetOrAddItem(ImGuiID id) { return ItemPool.GetOrAddByKey(id); } ImPlotItem* GetItemByIndex(int i) { return ItemPool.GetByIndex(i); } int GetItemIndex(ImPlotItem* item) { return ItemPool.GetIndex(item); } int GetLegendCount() const { return Legend.Indices.size(); } ImPlotItem* GetLegendItem(int i) { return ItemPool.GetByIndex(Legend.Indices[i]); } const char* GetLegendLabel(int i) { return Legend.Labels.Buf.Data + GetLegendItem(i)->NameOffset; } void Reset() { ItemPool.Clear(); Legend.Reset(); ColormapIdx = 0; } }; // Holds Plot state information that must persist after EndPlot struct ImPlotPlot { ImGuiID ID; ImPlotFlags Flags; ImPlotFlags PreviousFlags; ImPlotLocation MouseTextLocation; ImPlotMouseTextFlags MouseTextFlags; ImPlotAxis Axes[ImAxis_COUNT]; ImGuiTextBuffer TextBuffer; ImPlotItemGroup Items; ImAxis CurrentX; ImAxis CurrentY; ImRect FrameRect; ImRect CanvasRect; ImRect PlotRect; ImRect AxesRect; ImRect SelectRect; ImVec2 SelectStart; int TitleOffset; bool JustCreated; bool Initialized; bool SetupLocked; bool FitThisFrame; bool Hovered; bool Held; bool Selecting; bool Selected; bool ContextLocked; ImPlotPlot() { Flags = PreviousFlags = ImPlotFlags_None; for (int i = 0; i < IMPLOT_NUM_X_AXES; ++i) XAxis(i).Vertical = false; for (int i = 0; i < IMPLOT_NUM_Y_AXES; ++i) YAxis(i).Vertical = true; SelectStart = ImVec2(0,0); CurrentX = ImAxis_X1; CurrentY = ImAxis_Y1; MouseTextLocation = ImPlotLocation_South | ImPlotLocation_East; MouseTextFlags = ImPlotMouseTextFlags_None; TitleOffset = -1; JustCreated = true; Initialized = SetupLocked = FitThisFrame = false; Hovered = Held = Selected = Selecting = ContextLocked = false; } inline bool IsInputLocked() const { for (int i = 0; i < IMPLOT_NUM_X_AXES; ++i) { if (!XAxis(i).IsInputLocked()) return false; } for (int i = 0; i < IMPLOT_NUM_Y_AXES; ++i) { if (!YAxis(i).IsInputLocked()) return false; } return true; } inline void ClearTextBuffer() { TextBuffer.Buf.shrink(0); } inline void SetTitle(const char* title) { if (title && ImGui::FindRenderedTextEnd(title, nullptr) != title) { TitleOffset = TextBuffer.size(); TextBuffer.append(title, title + strlen(title) + 1); } else { TitleOffset = -1; } } inline bool HasTitle() const { return TitleOffset != -1 && !ImHasFlag(Flags, ImPlotFlags_NoTitle); } inline const char* GetTitle() const { return TextBuffer.Buf.Data + TitleOffset; } inline ImPlotAxis& XAxis(int i) { return Axes[ImAxis_X1 + i]; } inline const ImPlotAxis& XAxis(int i) const { return Axes[ImAxis_X1 + i]; } inline ImPlotAxis& YAxis(int i) { return Axes[ImAxis_Y1 + i]; } inline const ImPlotAxis& YAxis(int i) const { return Axes[ImAxis_Y1 + i]; } inline int EnabledAxesX() { int cnt = 0; for (int i = 0; i < IMPLOT_NUM_X_AXES; ++i) cnt += XAxis(i).Enabled; return cnt; } inline int EnabledAxesY() { int cnt = 0; for (int i = 0; i < IMPLOT_NUM_Y_AXES; ++i) cnt += YAxis(i).Enabled; return cnt; } inline void SetAxisLabel(ImPlotAxis& axis, const char* label) { if (label && ImGui::FindRenderedTextEnd(label, nullptr) != label) { axis.LabelOffset = TextBuffer.size(); TextBuffer.append(label, label + strlen(label) + 1); } else { axis.LabelOffset = -1; } } inline const char* GetAxisLabel(const ImPlotAxis& axis) const { return TextBuffer.Buf.Data + axis.LabelOffset; } }; // Holds subplot data that must persist after EndSubplot struct ImPlotSubplot { ImGuiID ID; ImPlotSubplotFlags Flags; ImPlotSubplotFlags PreviousFlags; ImPlotItemGroup Items; int Rows; int Cols; int CurrentIdx; ImRect FrameRect; ImRect GridRect; ImVec2 CellSize; ImVector RowAlignmentData; ImVector ColAlignmentData; ImVector RowRatios; ImVector ColRatios; ImVector RowLinkData; ImVector ColLinkData; float TempSizes[2]; bool FrameHovered; bool HasTitle; ImPlotSubplot() { ID = 0; Flags = PreviousFlags = ImPlotSubplotFlags_None; Rows = Cols = CurrentIdx = 0; Items.Legend.Location = ImPlotLocation_North; Items.Legend.Flags = ImPlotLegendFlags_Horizontal|ImPlotLegendFlags_Outside; Items.Legend.CanGoInside = false; TempSizes[0] = TempSizes[1] = 0; FrameHovered = false; HasTitle = false; } }; // Temporary data storage for upcoming plot struct ImPlotNextPlotData { ImPlotCond RangeCond[ImAxis_COUNT]; ImPlotRange Range[ImAxis_COUNT]; bool HasRange[ImAxis_COUNT]; bool Fit[ImAxis_COUNT]; double* LinkedMin[ImAxis_COUNT]; double* LinkedMax[ImAxis_COUNT]; ImPlotNextPlotData() { Reset(); } void Reset() { for (int i = 0; i < ImAxis_COUNT; ++i) { HasRange[i] = false; Fit[i] = false; LinkedMin[i] = LinkedMax[i] = nullptr; } } }; // Temporary data storage for upcoming item struct ImPlotNextItemData { ImVec4 Colors[5]; // ImPlotCol_Line, ImPlotCol_Fill, ImPlotCol_MarkerOutline, ImPlotCol_MarkerFill, ImPlotCol_ErrorBar float LineWeight; ImPlotMarker Marker; float MarkerSize; float MarkerWeight; float FillAlpha; float ErrorBarSize; float ErrorBarWeight; float DigitalBitHeight; float DigitalBitGap; bool RenderLine; bool RenderFill; bool RenderMarkerLine; bool RenderMarkerFill; bool HasHidden; bool Hidden; ImPlotCond HiddenCond; ImPlotNextItemData() { Reset(); } void Reset() { for (int i = 0; i < 5; ++i) Colors[i] = IMPLOT_AUTO_COL; LineWeight = MarkerSize = MarkerWeight = FillAlpha = ErrorBarSize = ErrorBarWeight = DigitalBitHeight = DigitalBitGap = IMPLOT_AUTO; Marker = IMPLOT_AUTO; HasHidden = Hidden = false; } }; // Holds state information that must persist between calls to BeginPlot()/EndPlot() struct ImPlotContext { // Plot States ImPool Plots; ImPool Subplots; ImPlotPlot* CurrentPlot; ImPlotSubplot* CurrentSubplot; ImPlotItemGroup* CurrentItems; ImPlotItem* CurrentItem; ImPlotItem* PreviousItem; // Tick Marks and Labels ImPlotTicker CTicker; // Annotation and Tabs ImPlotAnnotationCollection Annotations; ImPlotTagCollection Tags; // Flags bool ChildWindowMade; // Style and Colormaps ImPlotStyle Style; ImVector ColorModifiers; ImVector StyleModifiers; ImPlotColormapData ColormapData; ImVector ColormapModifiers; // Time tm Tm; // Temp data for general use ImVector TempDouble1, TempDouble2; ImVector TempInt1; // Misc int DigitalPlotItemCnt; int DigitalPlotOffset; ImPlotNextPlotData NextPlotData; ImPlotNextItemData NextItemData; ImPlotInputMap InputMap; bool OpenContextThisFrame; ImGuiTextBuffer MousePosStringBuilder; ImPlotItemGroup* SortItems; // Align plots ImPool AlignmentData; ImPlotAlignmentData* CurrentAlignmentH; ImPlotAlignmentData* CurrentAlignmentV; }; //----------------------------------------------------------------------------- // [SECTION] Internal API // No guarantee of forward compatibility here! //----------------------------------------------------------------------------- namespace ImPlot { //----------------------------------------------------------------------------- // [SECTION] Context Utils //----------------------------------------------------------------------------- // Initializes an ImPlotContext IMPLOT_API void Initialize(ImPlotContext* ctx); // Resets an ImPlot context for the next call to BeginPlot IMPLOT_API void ResetCtxForNextPlot(ImPlotContext* ctx); // Resets an ImPlot context for the next call to BeginAlignedPlots IMPLOT_API void ResetCtxForNextAlignedPlots(ImPlotContext* ctx); // Resets an ImPlot context for the next call to BeginSubplot IMPLOT_API void ResetCtxForNextSubplot(ImPlotContext* ctx); //----------------------------------------------------------------------------- // [SECTION] Plot Utils //----------------------------------------------------------------------------- // Gets a plot from the current ImPlotContext IMPLOT_API ImPlotPlot* GetPlot(const char* title); // Gets the current plot from the current ImPlotContext IMPLOT_API ImPlotPlot* GetCurrentPlot(); // Busts the cache for every plot in the current context IMPLOT_API void BustPlotCache(); // Shows a plot's context menu. IMPLOT_API void ShowPlotContextMenu(ImPlotPlot& plot); //----------------------------------------------------------------------------- // [SECTION] Setup Utils //----------------------------------------------------------------------------- // Lock Setup and call SetupFinish if necessary. static inline void SetupLock() { ImPlotContext& gp = *GImPlot; if (!gp.CurrentPlot->SetupLocked) SetupFinish(); gp.CurrentPlot->SetupLocked = true; } //----------------------------------------------------------------------------- // [SECTION] Subplot Utils //----------------------------------------------------------------------------- // Advances to next subplot IMPLOT_API void SubplotNextCell(); // Shows a subplot's context menu. IMPLOT_API void ShowSubplotsContextMenu(ImPlotSubplot& subplot); //----------------------------------------------------------------------------- // [SECTION] Item Utils //----------------------------------------------------------------------------- // Begins a new item. Returns false if the item should not be plotted. Pushes PlotClipRect. IMPLOT_API bool BeginItem(const char* label_id, ImPlotItemFlags flags=0, ImPlotCol recolor_from=IMPLOT_AUTO); // Same as above but with fitting functionality. template bool BeginItemEx(const char* label_id, const _Fitter& fitter, ImPlotItemFlags flags=0, ImPlotCol recolor_from=IMPLOT_AUTO) { if (BeginItem(label_id, flags, recolor_from)) { ImPlotPlot& plot = *GetCurrentPlot(); if (plot.FitThisFrame && !ImHasFlag(flags, ImPlotItemFlags_NoFit)) fitter.Fit(plot.Axes[plot.CurrentX], plot.Axes[plot.CurrentY]); return true; } return false; } // Ends an item (call only if BeginItem returns true). Pops PlotClipRect. IMPLOT_API void EndItem(); // Register or get an existing item from the current plot. IMPLOT_API ImPlotItem* RegisterOrGetItem(const char* label_id, ImPlotItemFlags flags, bool* just_created = nullptr); // Get a plot item from the current plot. IMPLOT_API ImPlotItem* GetItem(const char* label_id); // Gets the current item. IMPLOT_API ImPlotItem* GetCurrentItem(); // Busts the cache for every item for every plot in the current context. IMPLOT_API void BustItemCache(); //----------------------------------------------------------------------------- // [SECTION] Axis Utils //----------------------------------------------------------------------------- // Returns true if any enabled axis is locked from user input. static inline bool AnyAxesInputLocked(ImPlotAxis* axes, int count) { for (int i = 0; i < count; ++i) { if (axes[i].Enabled && axes[i].IsInputLocked()) return true; } return false; } // Returns true if all enabled axes are locked from user input. static inline bool AllAxesInputLocked(ImPlotAxis* axes, int count) { for (int i = 0; i < count; ++i) { if (axes[i].Enabled && !axes[i].IsInputLocked()) return false; } return true; } static inline bool AnyAxesHeld(ImPlotAxis* axes, int count) { for (int i = 0; i < count; ++i) { if (axes[i].Enabled && axes[i].Held) return true; } return false; } static inline bool AnyAxesHovered(ImPlotAxis* axes, int count) { for (int i = 0; i < count; ++i) { if (axes[i].Enabled && axes[i].Hovered) return true; } return false; } // Returns true if the user has requested data to be fit. static inline bool FitThisFrame() { return GImPlot->CurrentPlot->FitThisFrame; } // Extends the current plot's axes so that it encompasses a vertical line at x static inline void FitPointX(double x) { ImPlotPlot& plot = *GetCurrentPlot(); ImPlotAxis& x_axis = plot.Axes[plot.CurrentX]; x_axis.ExtendFit(x); } // Extends the current plot's axes so that it encompasses a horizontal line at y static inline void FitPointY(double y) { ImPlotPlot& plot = *GetCurrentPlot(); ImPlotAxis& y_axis = plot.Axes[plot.CurrentY]; y_axis.ExtendFit(y); } // Extends the current plot's axes so that it encompasses point p static inline void FitPoint(const ImPlotPoint& p) { ImPlotPlot& plot = *GetCurrentPlot(); ImPlotAxis& x_axis = plot.Axes[plot.CurrentX]; ImPlotAxis& y_axis = plot.Axes[plot.CurrentY]; x_axis.ExtendFitWith(y_axis, p.x, p.y); y_axis.ExtendFitWith(x_axis, p.y, p.x); } // Returns true if two ranges overlap static inline bool RangesOverlap(const ImPlotRange& r1, const ImPlotRange& r2) { return r1.Min <= r2.Max && r2.Min <= r1.Max; } // Shows an axis's context menu. IMPLOT_API void ShowAxisContextMenu(ImPlotAxis& axis, ImPlotAxis* equal_axis, bool time_allowed = false); //----------------------------------------------------------------------------- // [SECTION] Legend Utils //----------------------------------------------------------------------------- // Gets the position of an inner rect that is located inside of an outer rect according to an ImPlotLocation and padding amount. IMPLOT_API ImVec2 GetLocationPos(const ImRect& outer_rect, const ImVec2& inner_size, ImPlotLocation location, const ImVec2& pad = ImVec2(0,0)); // Calculates the bounding box size of a legend IMPLOT_API ImVec2 CalcLegendSize(ImPlotItemGroup& items, const ImVec2& pad, const ImVec2& spacing, bool vertical); // Renders legend entries into a bounding box IMPLOT_API bool ShowLegendEntries(ImPlotItemGroup& items, const ImRect& legend_bb, bool interactable, const ImVec2& pad, const ImVec2& spacing, bool vertical, ImDrawList& DrawList); // Shows an alternate legend for the plot identified by #title_id, outside of the plot frame (can be called before or after of Begin/EndPlot but must occur in the same ImGui window!). IMPLOT_API void ShowAltLegend(const char* title_id, bool vertical = true, const ImVec2 size = ImVec2(0,0), bool interactable = true); // Shows an legends's context menu. IMPLOT_API bool ShowLegendContextMenu(ImPlotLegend& legend, bool visible); //----------------------------------------------------------------------------- // [SECTION] Label Utils //----------------------------------------------------------------------------- // Create a a string label for a an axis value IMPLOT_API void LabelAxisValue(const ImPlotAxis& axis, double value, char* buff, int size, bool round = false); //----------------------------------------------------------------------------- // [SECTION] Styling Utils //----------------------------------------------------------------------------- // Get styling data for next item (call between Begin/EndItem) static inline const ImPlotNextItemData& GetItemData() { return GImPlot->NextItemData; } // Returns true if a color is set to be automatically determined static inline bool IsColorAuto(const ImVec4& col) { return col.w == -1; } // Returns true if a style color is set to be automatically determined static inline bool IsColorAuto(ImPlotCol idx) { return IsColorAuto(GImPlot->Style.Colors[idx]); } // Returns the automatically deduced style color IMPLOT_API ImVec4 GetAutoColor(ImPlotCol idx); // Returns the style color whether it is automatic or custom set static inline ImVec4 GetStyleColorVec4(ImPlotCol idx) { return IsColorAuto(idx) ? GetAutoColor(idx) : GImPlot->Style.Colors[idx]; } static inline ImU32 GetStyleColorU32(ImPlotCol idx) { return ImGui::ColorConvertFloat4ToU32(GetStyleColorVec4(idx)); } // Draws vertical text. The position is the bottom left of the text rect. IMPLOT_API void AddTextVertical(ImDrawList *DrawList, ImVec2 pos, ImU32 col, const char* text_begin, const char* text_end = nullptr); // Draws multiline horizontal text centered. IMPLOT_API void AddTextCentered(ImDrawList* DrawList, ImVec2 top_center, ImU32 col, const char* text_begin, const char* text_end = nullptr); // Calculates the size of vertical text static inline ImVec2 CalcTextSizeVertical(const char *text) { ImVec2 sz = ImGui::CalcTextSize(text); return ImVec2(sz.y, sz.x); } // Returns white or black text given background color static inline ImU32 CalcTextColor(const ImVec4& bg) { return (bg.x * 0.299f + bg.y * 0.587f + bg.z * 0.114f) > 0.5f ? IM_COL32_BLACK : IM_COL32_WHITE; } static inline ImU32 CalcTextColor(ImU32 bg) { return CalcTextColor(ImGui::ColorConvertU32ToFloat4(bg)); } // Lightens or darkens a color for hover static inline ImU32 CalcHoverColor(ImU32 col) { return ImMixU32(col, CalcTextColor(col), 32); } // Clamps a label position so that it fits a rect defined by Min/Max static inline ImVec2 ClampLabelPos(ImVec2 pos, const ImVec2& size, const ImVec2& Min, const ImVec2& Max) { if (pos.x < Min.x) pos.x = Min.x; if (pos.y < Min.y) pos.y = Min.y; if ((pos.x + size.x) > Max.x) pos.x = Max.x - size.x; if ((pos.y + size.y) > Max.y) pos.y = Max.y - size.y; return pos; } // Returns a color from the Color map given an index >= 0 (modulo will be performed). IMPLOT_API ImU32 GetColormapColorU32(int idx, ImPlotColormap cmap); // Returns the next unused colormap color and advances the colormap. Can be used to skip colors if desired. IMPLOT_API ImU32 NextColormapColorU32(); // Linearly interpolates a color from the current colormap given t between 0 and 1. IMPLOT_API ImU32 SampleColormapU32(float t, ImPlotColormap cmap); // Render a colormap bar IMPLOT_API void RenderColorBar(const ImU32* colors, int size, ImDrawList& DrawList, const ImRect& bounds, bool vert, bool reversed, bool continuous); //----------------------------------------------------------------------------- // [SECTION] Math and Misc Utils //----------------------------------------------------------------------------- // Rounds x to powers of 2,5 and 10 for generating axis labels (from Graphics Gems 1 Chapter 11.2) IMPLOT_API double NiceNum(double x, bool round); // Computes order of magnitude of double. static inline int OrderOfMagnitude(double val) { return val == 0 ? 0 : (int)(floor(log10(fabs(val)))); } // Returns the precision required for a order of magnitude. static inline int OrderToPrecision(int order) { return order > 0 ? 0 : 1 - order; } // Returns a floating point precision to use given a value static inline int Precision(double val) { return OrderToPrecision(OrderOfMagnitude(val)); } // Round a value to a given precision static inline double RoundTo(double val, int prec) { double p = pow(10,(double)prec); return floor(val*p+0.5)/p; } // Returns the intersection point of two lines A and B (assumes they are not parallel!) static inline ImVec2 Intersection(const ImVec2& a1, const ImVec2& a2, const ImVec2& b1, const ImVec2& b2) { float v1 = (a1.x * a2.y - a1.y * a2.x); float v2 = (b1.x * b2.y - b1.y * b2.x); float v3 = ((a1.x - a2.x) * (b1.y - b2.y) - (a1.y - a2.y) * (b1.x - b2.x)); return ImVec2((v1 * (b1.x - b2.x) - v2 * (a1.x - a2.x)) / v3, (v1 * (b1.y - b2.y) - v2 * (a1.y - a2.y)) / v3); } // Fills a buffer with n samples linear interpolated from vmin to vmax template void FillRange(ImVector& buffer, int n, T vmin, T vmax) { buffer.resize(n); T step = (vmax - vmin) / (n - 1); for (int i = 0; i < n; ++i) { buffer[i] = vmin + i * step; } } // Calculate histogram bin counts and widths template static inline void CalculateBins(const T* values, int count, ImPlotBin meth, const ImPlotRange& range, int& bins_out, double& width_out) { switch (meth) { case ImPlotBin_Sqrt: bins_out = (int)ceil(sqrt(count)); break; case ImPlotBin_Sturges: bins_out = (int)ceil(1.0 + log2(count)); break; case ImPlotBin_Rice: bins_out = (int)ceil(2 * cbrt(count)); break; case ImPlotBin_Scott: width_out = 3.49 * ImStdDev(values, count) / cbrt(count); bins_out = (int)round(range.Size() / width_out); break; } width_out = range.Size() / bins_out; } //----------------------------------------------------------------------------- // Time Utils //----------------------------------------------------------------------------- // Returns true if year is leap year (366 days long) static inline bool IsLeapYear(int year) { return year % 4 == 0 && (year % 100 != 0 || year % 400 == 0); } // Returns the number of days in a month, accounting for Feb. leap years. #month is zero indexed. static inline int GetDaysInMonth(int year, int month) { static const int days[12] = {31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31}; return days[month] + (int)(month == 1 && IsLeapYear(year)); } // Make a UNIX timestamp from a tm struct expressed in UTC time (i.e. GMT timezone). IMPLOT_API ImPlotTime MkGmtTime(struct tm *ptm); // Make a tm struct expressed in UTC time (i.e. GMT timezone) from a UNIX timestamp. IMPLOT_API tm* GetGmtTime(const ImPlotTime& t, tm* ptm); // Make a UNIX timestamp from a tm struct expressed in local time. IMPLOT_API ImPlotTime MkLocTime(struct tm *ptm); // Make a tm struct expressed in local time from a UNIX timestamp. IMPLOT_API tm* GetLocTime(const ImPlotTime& t, tm* ptm); // NB: The following functions only work if there is a current ImPlotContext because the // internal tm struct is owned by the context! They are aware of ImPlotStyle.UseLocalTime. // Make a timestamp from time components. // year[1970-3000], month[0-11], day[1-31], hour[0-23], min[0-59], sec[0-59], us[0,999999] IMPLOT_API ImPlotTime MakeTime(int year, int month = 0, int day = 1, int hour = 0, int min = 0, int sec = 0, int us = 0); // Get year component from timestamp [1970-3000] IMPLOT_API int GetYear(const ImPlotTime& t); // Adds or subtracts time from a timestamp. #count > 0 to add, < 0 to subtract. IMPLOT_API ImPlotTime AddTime(const ImPlotTime& t, ImPlotTimeUnit unit, int count); // Rounds a timestamp down to nearest unit. IMPLOT_API ImPlotTime FloorTime(const ImPlotTime& t, ImPlotTimeUnit unit); // Rounds a timestamp up to the nearest unit. IMPLOT_API ImPlotTime CeilTime(const ImPlotTime& t, ImPlotTimeUnit unit); // Rounds a timestamp up or down to the nearest unit. IMPLOT_API ImPlotTime RoundTime(const ImPlotTime& t, ImPlotTimeUnit unit); // Combines the date of one timestamp with the time-of-day of another timestamp. IMPLOT_API ImPlotTime CombineDateTime(const ImPlotTime& date_part, const ImPlotTime& time_part); // Formats the time part of timestamp t into a buffer according to #fmt IMPLOT_API int FormatTime(const ImPlotTime& t, char* buffer, int size, ImPlotTimeFmt fmt, bool use_24_hr_clk); // Formats the date part of timestamp t into a buffer according to #fmt IMPLOT_API int FormatDate(const ImPlotTime& t, char* buffer, int size, ImPlotDateFmt fmt, bool use_iso_8601); // Formats the time and/or date parts of a timestamp t into a buffer according to #fmt IMPLOT_API int FormatDateTime(const ImPlotTime& t, char* buffer, int size, ImPlotDateTimeSpec fmt); // Shows a date picker widget block (year/month/day). // #level = 0 for day, 1 for month, 2 for year. Modified by user interaction. // #t will be set when a day is clicked and the function will return true. // #t1 and #t2 are optional dates to highlight. IMPLOT_API bool ShowDatePicker(const char* id, int* level, ImPlotTime* t, const ImPlotTime* t1 = nullptr, const ImPlotTime* t2 = nullptr); // Shows a time picker widget block (hour/min/sec). // #t will be set when a new hour, minute, or sec is selected or am/pm is toggled, and the function will return true. IMPLOT_API bool ShowTimePicker(const char* id, ImPlotTime* t); //----------------------------------------------------------------------------- // [SECTION] Transforms //----------------------------------------------------------------------------- static inline double TransformForward_Log10(double v, void*) { v = v <= 0.0 ? DBL_MIN : v; return ImLog10(v); } static inline double TransformInverse_Log10(double v, void*) { return ImPow(10, v); } static inline double TransformForward_SymLog(double v, void*) { return 2.0 * ImAsinh(v / 2.0); } static inline double TransformInverse_SymLog(double v, void*) { return 2.0 * ImSinh(v / 2.0); } static inline double TransformForward_Logit(double v, void*) { v = ImClamp(v, DBL_MIN, 1.0 - DBL_EPSILON); return ImLog10(v / (1 - v)); } static inline double TransformInverse_Logit(double v, void*) { return 1.0 / (1.0 + ImPow(10,-v)); } //----------------------------------------------------------------------------- // [SECTION] Formatters //----------------------------------------------------------------------------- static inline int Formatter_Default(double value, char* buff, int size, void* data) { char* fmt = (char*)data; return ImFormatString(buff, size, fmt, value); } static inline int Formatter_Logit(double value, char* buff, int size, void*) { if (value == 0.5) return ImFormatString(buff,size,"1/2"); else if (value < 0.5) return ImFormatString(buff,size,"%g", value); else return ImFormatString(buff,size,"1 - %g", 1 - value); } struct Formatter_Time_Data { ImPlotTime Time; ImPlotDateTimeSpec Spec; ImPlotFormatter UserFormatter; void* UserFormatterData; }; static inline int Formatter_Time(double, char* buff, int size, void* data) { Formatter_Time_Data* ftd = (Formatter_Time_Data*)data; return FormatDateTime(ftd->Time, buff, size, ftd->Spec); } //------------------------------------------------------------------------------ // [SECTION] Locator //------------------------------------------------------------------------------ void Locator_Default(ImPlotTicker& ticker, const ImPlotRange& range, float pixels, bool vertical, ImPlotFormatter formatter, void* formatter_data); void Locator_Time(ImPlotTicker& ticker, const ImPlotRange& range, float pixels, bool vertical, ImPlotFormatter formatter, void* formatter_data); void Locator_Log10(ImPlotTicker& ticker, const ImPlotRange& range, float pixels, bool vertical, ImPlotFormatter formatter, void* formatter_data); void Locator_SymLog(ImPlotTicker& ticker, const ImPlotRange& range, float pixels, bool vertical, ImPlotFormatter formatter, void* formatter_data); } // namespace ImPlot ================================================ FILE: src/DesktopPlusUI/implot/implot_items.cpp ================================================ // MIT License // Copyright (c) 2023 Evan Pezent // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files (the "Software"), to deal // in the Software without restriction, including without limitation the rights // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell // copies of the Software, and to permit persons to whom the Software is // furnished to do so, subject to the following conditions: // The above copyright notice and this permission notice shall be included in all // copies or substantial portions of the Software. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE // SOFTWARE. // ImPlot v0.16 #define IMGUI_DEFINE_MATH_OPERATORS #include "implot.h" #include "implot_internal.h" //----------------------------------------------------------------------------- // [SECTION] Macros and Defines //----------------------------------------------------------------------------- #define SQRT_1_2 0.70710678118f #define SQRT_3_2 0.86602540378f #ifndef IMPLOT_NO_FORCE_INLINE #ifdef _MSC_VER #define IMPLOT_INLINE __forceinline #elif defined(__GNUC__) #define IMPLOT_INLINE inline __attribute__((__always_inline__)) #elif defined(__CLANG__) #if __has_attribute(__always_inline__) #define IMPLOT_INLINE inline __attribute__((__always_inline__)) #else #define IMPLOT_INLINE inline #endif #else #define IMPLOT_INLINE inline #endif #else #define IMPLOT_INLINE inline #endif #if defined __SSE__ || defined __x86_64__ || defined _M_X64 #ifndef IMGUI_ENABLE_SSE #include #endif static IMPLOT_INLINE float ImInvSqrt(float x) { return _mm_cvtss_f32(_mm_rsqrt_ss(_mm_set_ss(x))); } #else static IMPLOT_INLINE float ImInvSqrt(float x) { return 1.0f / sqrtf(x); } #endif #define IMPLOT_NORMALIZE2F_OVER_ZERO(VX,VY) do { float d2 = VX*VX + VY*VY; if (d2 > 0.0f) { float inv_len = ImInvSqrt(d2); VX *= inv_len; VY *= inv_len; } } while (0) // Support for pre-1.82 versions. Users on 1.82+ can use 0 (default) flags to mean "all corners" but in order to support older versions we are more explicit. #if (IMGUI_VERSION_NUM < 18102) && !defined(ImDrawFlags_RoundCornersAll) #define ImDrawFlags_RoundCornersAll ImDrawCornerFlags_All #endif //----------------------------------------------------------------------------- // [SECTION] Template instantiation utility //----------------------------------------------------------------------------- // By default, templates are instantiated for `float`, `double`, and for the following integer types, which are defined in imgui.h: // signed char ImS8; // 8-bit signed integer // unsigned char ImU8; // 8-bit unsigned integer // signed short ImS16; // 16-bit signed integer // unsigned short ImU16; // 16-bit unsigned integer // signed int ImS32; // 32-bit signed integer == int // unsigned int ImU32; // 32-bit unsigned integer // signed long long ImS64; // 64-bit signed integer // unsigned long long ImU64; // 64-bit unsigned integer // (note: this list does *not* include `long`, `unsigned long` and `long double`) // // You can customize the supported types by defining IMPLOT_CUSTOM_NUMERIC_TYPES at compile time to define your own type list. // As an example, you could use the compile time define given by the line below in order to support only float and double. // -DIMPLOT_CUSTOM_NUMERIC_TYPES="(float)(double)" // In order to support all known C++ types, use: // -DIMPLOT_CUSTOM_NUMERIC_TYPES="(signed char)(unsigned char)(signed short)(unsigned short)(signed int)(unsigned int)(signed long)(unsigned long)(signed long long)(unsigned long long)(float)(double)(long double)" #ifdef IMPLOT_CUSTOM_NUMERIC_TYPES #define IMPLOT_NUMERIC_TYPES IMPLOT_CUSTOM_NUMERIC_TYPES #else #define IMPLOT_NUMERIC_TYPES (ImS8)(ImU8)(ImS16)(ImU16)(ImS32)(ImU32)(ImS64)(ImU64)(float)(double) #endif // CALL_INSTANTIATE_FOR_NUMERIC_TYPES will duplicate the template instantion code `INSTANTIATE_MACRO(T)` on supported types. #define _CAT(x, y) _CAT_(x, y) #define _CAT_(x,y) x ## y #define _INSTANTIATE_FOR_NUMERIC_TYPES(chain) _CAT(_INSTANTIATE_FOR_NUMERIC_TYPES_1 chain, _END) #define _INSTANTIATE_FOR_NUMERIC_TYPES_1(T) INSTANTIATE_MACRO(T) _INSTANTIATE_FOR_NUMERIC_TYPES_2 #define _INSTANTIATE_FOR_NUMERIC_TYPES_2(T) INSTANTIATE_MACRO(T) _INSTANTIATE_FOR_NUMERIC_TYPES_1 #define _INSTANTIATE_FOR_NUMERIC_TYPES_1_END #define _INSTANTIATE_FOR_NUMERIC_TYPES_2_END #define CALL_INSTANTIATE_FOR_NUMERIC_TYPES() _INSTANTIATE_FOR_NUMERIC_TYPES(IMPLOT_NUMERIC_TYPES) namespace ImPlot { //----------------------------------------------------------------------------- // [SECTION] Utils //----------------------------------------------------------------------------- // Calc maximum index size of ImDrawIdx template struct MaxIdx { static const unsigned int Value; }; template <> const unsigned int MaxIdx::Value = 65535; template <> const unsigned int MaxIdx::Value = 4294967295; IMPLOT_INLINE void GetLineRenderProps(const ImDrawList& draw_list, float& half_weight, ImVec2& tex_uv0, ImVec2& tex_uv1) { const bool aa = ImHasFlag(draw_list.Flags, ImDrawListFlags_AntiAliasedLines) && ImHasFlag(draw_list.Flags, ImDrawListFlags_AntiAliasedLinesUseTex); if (aa) { ImVec4 tex_uvs = draw_list._Data->TexUvLines[(int)(half_weight*2)]; tex_uv0 = ImVec2(tex_uvs.x, tex_uvs.y); tex_uv1 = ImVec2(tex_uvs.z, tex_uvs.w); half_weight += 1; } else { tex_uv0 = tex_uv1 = draw_list._Data->TexUvWhitePixel; } } IMPLOT_INLINE void PrimLine(ImDrawList& draw_list, const ImVec2& P1, const ImVec2& P2, float half_weight, ImU32 col, const ImVec2& tex_uv0, const ImVec2 tex_uv1) { float dx = P2.x - P1.x; float dy = P2.y - P1.y; IMPLOT_NORMALIZE2F_OVER_ZERO(dx, dy); dx *= half_weight; dy *= half_weight; draw_list._VtxWritePtr[0].pos.x = P1.x + dy; draw_list._VtxWritePtr[0].pos.y = P1.y - dx; draw_list._VtxWritePtr[0].uv = tex_uv0; draw_list._VtxWritePtr[0].col = col; draw_list._VtxWritePtr[1].pos.x = P2.x + dy; draw_list._VtxWritePtr[1].pos.y = P2.y - dx; draw_list._VtxWritePtr[1].uv = tex_uv0; draw_list._VtxWritePtr[1].col = col; draw_list._VtxWritePtr[2].pos.x = P2.x - dy; draw_list._VtxWritePtr[2].pos.y = P2.y + dx; draw_list._VtxWritePtr[2].uv = tex_uv1; draw_list._VtxWritePtr[2].col = col; draw_list._VtxWritePtr[3].pos.x = P1.x - dy; draw_list._VtxWritePtr[3].pos.y = P1.y + dx; draw_list._VtxWritePtr[3].uv = tex_uv1; draw_list._VtxWritePtr[3].col = col; draw_list._VtxWritePtr += 4; draw_list._IdxWritePtr[0] = (ImDrawIdx)(draw_list._VtxCurrentIdx); draw_list._IdxWritePtr[1] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 1); draw_list._IdxWritePtr[2] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 2); draw_list._IdxWritePtr[3] = (ImDrawIdx)(draw_list._VtxCurrentIdx); draw_list._IdxWritePtr[4] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 2); draw_list._IdxWritePtr[5] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 3); draw_list._IdxWritePtr += 6; draw_list._VtxCurrentIdx += 4; } IMPLOT_INLINE void PrimRectFill(ImDrawList& draw_list, const ImVec2& Pmin, const ImVec2& Pmax, ImU32 col, const ImVec2& uv) { draw_list._VtxWritePtr[0].pos = Pmin; draw_list._VtxWritePtr[0].uv = uv; draw_list._VtxWritePtr[0].col = col; draw_list._VtxWritePtr[1].pos = Pmax; draw_list._VtxWritePtr[1].uv = uv; draw_list._VtxWritePtr[1].col = col; draw_list._VtxWritePtr[2].pos.x = Pmin.x; draw_list._VtxWritePtr[2].pos.y = Pmax.y; draw_list._VtxWritePtr[2].uv = uv; draw_list._VtxWritePtr[2].col = col; draw_list._VtxWritePtr[3].pos.x = Pmax.x; draw_list._VtxWritePtr[3].pos.y = Pmin.y; draw_list._VtxWritePtr[3].uv = uv; draw_list._VtxWritePtr[3].col = col; draw_list._VtxWritePtr += 4; draw_list._IdxWritePtr[0] = (ImDrawIdx)(draw_list._VtxCurrentIdx); draw_list._IdxWritePtr[1] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 1); draw_list._IdxWritePtr[2] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 2); draw_list._IdxWritePtr[3] = (ImDrawIdx)(draw_list._VtxCurrentIdx); draw_list._IdxWritePtr[4] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 1); draw_list._IdxWritePtr[5] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 3); draw_list._IdxWritePtr += 6; draw_list._VtxCurrentIdx += 4; } IMPLOT_INLINE void PrimRectLine(ImDrawList& draw_list, const ImVec2& Pmin, const ImVec2& Pmax, float weight, ImU32 col, const ImVec2& uv) { draw_list._VtxWritePtr[0].pos.x = Pmin.x; draw_list._VtxWritePtr[0].pos.y = Pmin.y; draw_list._VtxWritePtr[0].uv = uv; draw_list._VtxWritePtr[0].col = col; draw_list._VtxWritePtr[1].pos.x = Pmin.x; draw_list._VtxWritePtr[1].pos.y = Pmax.y; draw_list._VtxWritePtr[1].uv = uv; draw_list._VtxWritePtr[1].col = col; draw_list._VtxWritePtr[2].pos.x = Pmax.x; draw_list._VtxWritePtr[2].pos.y = Pmax.y; draw_list._VtxWritePtr[2].uv = uv; draw_list._VtxWritePtr[2].col = col; draw_list._VtxWritePtr[3].pos.x = Pmax.x; draw_list._VtxWritePtr[3].pos.y = Pmin.y; draw_list._VtxWritePtr[3].uv = uv; draw_list._VtxWritePtr[3].col = col; draw_list._VtxWritePtr[4].pos.x = Pmin.x + weight; draw_list._VtxWritePtr[4].pos.y = Pmin.y + weight; draw_list._VtxWritePtr[4].uv = uv; draw_list._VtxWritePtr[4].col = col; draw_list._VtxWritePtr[5].pos.x = Pmin.x + weight; draw_list._VtxWritePtr[5].pos.y = Pmax.y - weight; draw_list._VtxWritePtr[5].uv = uv; draw_list._VtxWritePtr[5].col = col; draw_list._VtxWritePtr[6].pos.x = Pmax.x - weight; draw_list._VtxWritePtr[6].pos.y = Pmax.y - weight; draw_list._VtxWritePtr[6].uv = uv; draw_list._VtxWritePtr[6].col = col; draw_list._VtxWritePtr[7].pos.x = Pmax.x - weight; draw_list._VtxWritePtr[7].pos.y = Pmin.y + weight; draw_list._VtxWritePtr[7].uv = uv; draw_list._VtxWritePtr[7].col = col; draw_list._VtxWritePtr += 8; draw_list._IdxWritePtr[0] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 0); draw_list._IdxWritePtr[1] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 1); draw_list._IdxWritePtr[2] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 5); draw_list._IdxWritePtr += 3; draw_list._IdxWritePtr[0] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 0); draw_list._IdxWritePtr[1] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 5); draw_list._IdxWritePtr[2] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 4); draw_list._IdxWritePtr += 3; draw_list._IdxWritePtr[0] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 1); draw_list._IdxWritePtr[1] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 2); draw_list._IdxWritePtr[2] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 6); draw_list._IdxWritePtr += 3; draw_list._IdxWritePtr[0] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 1); draw_list._IdxWritePtr[1] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 6); draw_list._IdxWritePtr[2] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 5); draw_list._IdxWritePtr += 3; draw_list._IdxWritePtr[0] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 2); draw_list._IdxWritePtr[1] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 3); draw_list._IdxWritePtr[2] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 7); draw_list._IdxWritePtr += 3; draw_list._IdxWritePtr[0] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 2); draw_list._IdxWritePtr[1] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 7); draw_list._IdxWritePtr[2] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 6); draw_list._IdxWritePtr += 3; draw_list._IdxWritePtr[0] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 3); draw_list._IdxWritePtr[1] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 0); draw_list._IdxWritePtr[2] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 4); draw_list._IdxWritePtr += 3; draw_list._IdxWritePtr[0] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 3); draw_list._IdxWritePtr[1] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 4); draw_list._IdxWritePtr[2] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 7); draw_list._IdxWritePtr += 3; draw_list._VtxCurrentIdx += 8; } //----------------------------------------------------------------------------- // [SECTION] Item Utils //----------------------------------------------------------------------------- ImPlotItem* RegisterOrGetItem(const char* label_id, ImPlotItemFlags flags, bool* just_created) { ImPlotContext& gp = *GImPlot; ImPlotItemGroup& Items = *gp.CurrentItems; ImGuiID id = Items.GetItemID(label_id); if (just_created != nullptr) *just_created = Items.GetItem(id) == nullptr; ImPlotItem* item = Items.GetOrAddItem(id); if (item->SeenThisFrame) return item; item->SeenThisFrame = true; int idx = Items.GetItemIndex(item); item->ID = id; if (!ImHasFlag(flags, ImPlotItemFlags_NoLegend) && ImGui::FindRenderedTextEnd(label_id, nullptr) != label_id) { Items.Legend.Indices.push_back(idx); item->NameOffset = Items.Legend.Labels.size(); Items.Legend.Labels.append(label_id, label_id + strlen(label_id) + 1); } else { item->Show = true; } return item; } ImPlotItem* GetItem(const char* label_id) { ImPlotContext& gp = *GImPlot; return gp.CurrentItems->GetItem(label_id); } bool IsItemHidden(const char* label_id) { ImPlotItem* item = GetItem(label_id); return item != nullptr && !item->Show; } ImPlotItem* GetCurrentItem() { ImPlotContext& gp = *GImPlot; return gp.CurrentItem; } void SetNextLineStyle(const ImVec4& col, float weight) { ImPlotContext& gp = *GImPlot; gp.NextItemData.Colors[ImPlotCol_Line] = col; gp.NextItemData.LineWeight = weight; } void SetNextFillStyle(const ImVec4& col, float alpha) { ImPlotContext& gp = *GImPlot; gp.NextItemData.Colors[ImPlotCol_Fill] = col; gp.NextItemData.FillAlpha = alpha; } void SetNextMarkerStyle(ImPlotMarker marker, float size, const ImVec4& fill, float weight, const ImVec4& outline) { ImPlotContext& gp = *GImPlot; gp.NextItemData.Marker = marker; gp.NextItemData.Colors[ImPlotCol_MarkerFill] = fill; gp.NextItemData.MarkerSize = size; gp.NextItemData.Colors[ImPlotCol_MarkerOutline] = outline; gp.NextItemData.MarkerWeight = weight; } void SetNextErrorBarStyle(const ImVec4& col, float size, float weight) { ImPlotContext& gp = *GImPlot; gp.NextItemData.Colors[ImPlotCol_ErrorBar] = col; gp.NextItemData.ErrorBarSize = size; gp.NextItemData.ErrorBarWeight = weight; } ImVec4 GetLastItemColor() { ImPlotContext& gp = *GImPlot; if (gp.PreviousItem) return ImGui::ColorConvertU32ToFloat4(gp.PreviousItem->Color); return ImVec4(); } void BustItemCache() { ImPlotContext& gp = *GImPlot; for (int p = 0; p < gp.Plots.GetBufSize(); ++p) { ImPlotPlot& plot = *gp.Plots.GetByIndex(p); plot.Items.Reset(); } for (int p = 0; p < gp.Subplots.GetBufSize(); ++p) { ImPlotSubplot& subplot = *gp.Subplots.GetByIndex(p); subplot.Items.Reset(); } } void BustColorCache(const char* plot_title_id) { ImPlotContext& gp = *GImPlot; if (plot_title_id == nullptr) { BustItemCache(); } else { ImGuiID id = ImGui::GetCurrentWindow()->GetID(plot_title_id); ImPlotPlot* plot = gp.Plots.GetByKey(id); if (plot != nullptr) plot->Items.Reset(); else { ImPlotSubplot* subplot = gp.Subplots.GetByKey(id); if (subplot != nullptr) subplot->Items.Reset(); } } } //----------------------------------------------------------------------------- // [SECTION] BeginItem / EndItem //----------------------------------------------------------------------------- static const float ITEM_HIGHLIGHT_LINE_SCALE = 2.0f; static const float ITEM_HIGHLIGHT_MARK_SCALE = 1.25f; // Begins a new item. Returns false if the item should not be plotted. bool BeginItem(const char* label_id, ImPlotItemFlags flags, ImPlotCol recolor_from) { ImPlotContext& gp = *GImPlot; IM_ASSERT_USER_ERROR(gp.CurrentPlot != nullptr, "PlotX() needs to be called between BeginPlot() and EndPlot()!"); SetupLock(); bool just_created; ImPlotItem* item = RegisterOrGetItem(label_id, flags, &just_created); // set current item gp.CurrentItem = item; ImPlotNextItemData& s = gp.NextItemData; // set/override item color if (recolor_from != -1) { if (!IsColorAuto(s.Colors[recolor_from])) item->Color = ImGui::ColorConvertFloat4ToU32(s.Colors[recolor_from]); else if (!IsColorAuto(gp.Style.Colors[recolor_from])) item->Color = ImGui::ColorConvertFloat4ToU32(gp.Style.Colors[recolor_from]); else if (just_created) item->Color = NextColormapColorU32(); } else if (just_created) { item->Color = NextColormapColorU32(); } // hide/show item if (gp.NextItemData.HasHidden) { if (just_created || gp.NextItemData.HiddenCond == ImGuiCond_Always) item->Show = !gp.NextItemData.Hidden; } if (!item->Show) { // reset next item data gp.NextItemData.Reset(); gp.PreviousItem = item; gp.CurrentItem = nullptr; return false; } else { ImVec4 item_color = ImGui::ColorConvertU32ToFloat4(item->Color); // stage next item colors s.Colors[ImPlotCol_Line] = IsColorAuto(s.Colors[ImPlotCol_Line]) ? ( IsColorAuto(ImPlotCol_Line) ? item_color : gp.Style.Colors[ImPlotCol_Line] ) : s.Colors[ImPlotCol_Line]; s.Colors[ImPlotCol_Fill] = IsColorAuto(s.Colors[ImPlotCol_Fill]) ? ( IsColorAuto(ImPlotCol_Fill) ? item_color : gp.Style.Colors[ImPlotCol_Fill] ) : s.Colors[ImPlotCol_Fill]; s.Colors[ImPlotCol_MarkerOutline] = IsColorAuto(s.Colors[ImPlotCol_MarkerOutline]) ? ( IsColorAuto(ImPlotCol_MarkerOutline) ? s.Colors[ImPlotCol_Line] : gp.Style.Colors[ImPlotCol_MarkerOutline] ) : s.Colors[ImPlotCol_MarkerOutline]; s.Colors[ImPlotCol_MarkerFill] = IsColorAuto(s.Colors[ImPlotCol_MarkerFill]) ? ( IsColorAuto(ImPlotCol_MarkerFill) ? s.Colors[ImPlotCol_Line] : gp.Style.Colors[ImPlotCol_MarkerFill] ) : s.Colors[ImPlotCol_MarkerFill]; s.Colors[ImPlotCol_ErrorBar] = IsColorAuto(s.Colors[ImPlotCol_ErrorBar]) ? ( GetStyleColorVec4(ImPlotCol_ErrorBar) ) : s.Colors[ImPlotCol_ErrorBar]; // stage next item style vars s.LineWeight = s.LineWeight < 0 ? gp.Style.LineWeight : s.LineWeight; s.Marker = s.Marker < 0 ? gp.Style.Marker : s.Marker; s.MarkerSize = s.MarkerSize < 0 ? gp.Style.MarkerSize : s.MarkerSize; s.MarkerWeight = s.MarkerWeight < 0 ? gp.Style.MarkerWeight : s.MarkerWeight; s.FillAlpha = s.FillAlpha < 0 ? gp.Style.FillAlpha : s.FillAlpha; s.ErrorBarSize = s.ErrorBarSize < 0 ? gp.Style.ErrorBarSize : s.ErrorBarSize; s.ErrorBarWeight = s.ErrorBarWeight < 0 ? gp.Style.ErrorBarWeight : s.ErrorBarWeight; s.DigitalBitHeight = s.DigitalBitHeight < 0 ? gp.Style.DigitalBitHeight : s.DigitalBitHeight; s.DigitalBitGap = s.DigitalBitGap < 0 ? gp.Style.DigitalBitGap : s.DigitalBitGap; // apply alpha modifier(s) s.Colors[ImPlotCol_Fill].w *= s.FillAlpha; s.Colors[ImPlotCol_MarkerFill].w *= s.FillAlpha; // TODO: this should be separate, if it at all // apply highlight mods if (item->LegendHovered) { if (!ImHasFlag(gp.CurrentItems->Legend.Flags, ImPlotLegendFlags_NoHighlightItem)) { s.LineWeight *= ITEM_HIGHLIGHT_LINE_SCALE; s.MarkerSize *= ITEM_HIGHLIGHT_MARK_SCALE; s.MarkerWeight *= ITEM_HIGHLIGHT_LINE_SCALE; // TODO: how to highlight fills? } if (!ImHasFlag(gp.CurrentItems->Legend.Flags, ImPlotLegendFlags_NoHighlightAxis)) { if (gp.CurrentPlot->EnabledAxesX() > 1) gp.CurrentPlot->Axes[gp.CurrentPlot->CurrentX].ColorHiLi = item->Color; if (gp.CurrentPlot->EnabledAxesY() > 1) gp.CurrentPlot->Axes[gp.CurrentPlot->CurrentY].ColorHiLi = item->Color; } } // set render flags s.RenderLine = s.Colors[ImPlotCol_Line].w > 0 && s.LineWeight > 0; s.RenderFill = s.Colors[ImPlotCol_Fill].w > 0; s.RenderMarkerFill = s.Colors[ImPlotCol_MarkerFill].w > 0; s.RenderMarkerLine = s.Colors[ImPlotCol_MarkerOutline].w > 0 && s.MarkerWeight > 0; // push rendering clip rect PushPlotClipRect(); return true; } } // Ends an item (call only if BeginItem returns true) void EndItem() { ImPlotContext& gp = *GImPlot; // pop rendering clip rect PopPlotClipRect(); // reset next item data gp.NextItemData.Reset(); // set current item gp.PreviousItem = gp.CurrentItem; gp.CurrentItem = nullptr; } //----------------------------------------------------------------------------- // [SECTION] Indexers //----------------------------------------------------------------------------- template IMPLOT_INLINE T IndexData(const T* data, int idx, int count, int offset, int stride) { const int s = ((offset == 0) << 0) | ((stride == sizeof(T)) << 1); switch (s) { case 3 : return data[idx]; case 2 : return data[(offset + idx) % count]; case 1 : return *(const T*)(const void*)((const unsigned char*)data + (size_t)((idx) ) * stride); case 0 : return *(const T*)(const void*)((const unsigned char*)data + (size_t)((offset + idx) % count) * stride); default: return T(0); } } template struct IndexerIdx { IndexerIdx(const T* data, int count, int offset = 0, int stride = sizeof(T)) : Data(data), Count(count), Offset(count ? ImPosMod(offset, count) : 0), Stride(stride) { } template IMPLOT_INLINE double operator()(I idx) const { return (double)IndexData(Data, idx, Count, Offset, Stride); } const T* Data; int Count; int Offset; int Stride; }; template struct IndexerAdd { IndexerAdd(const _Indexer1& indexer1, const _Indexer2& indexer2, double scale1 = 1, double scale2 = 1) : Indexer1(indexer1), Indexer2(indexer2), Scale1(scale1), Scale2(scale2), Count(ImMin(Indexer1.Count, Indexer2.Count)) { } template IMPLOT_INLINE double operator()(I idx) const { return Scale1 * Indexer1(idx) + Scale2 * Indexer2(idx); } const _Indexer1& Indexer1; const _Indexer2& Indexer2; double Scale1; double Scale2; int Count; }; struct IndexerLin { IndexerLin(double m, double b) : M(m), B(b) { } template IMPLOT_INLINE double operator()(I idx) const { return M * idx + B; } const double M; const double B; }; struct IndexerConst { IndexerConst(double ref) : Ref(ref) { } template IMPLOT_INLINE double operator()(I) const { return Ref; } const double Ref; }; //----------------------------------------------------------------------------- // [SECTION] Getters //----------------------------------------------------------------------------- template struct GetterXY { GetterXY(_IndexerX x, _IndexerY y, int count) : IndxerX(x), IndxerY(y), Count(count) { } template IMPLOT_INLINE ImPlotPoint operator()(I idx) const { return ImPlotPoint(IndxerX(idx),IndxerY(idx)); } const _IndexerX IndxerX; const _IndexerY IndxerY; const int Count; }; /// Interprets a user's function pointer as ImPlotPoints struct GetterFuncPtr { GetterFuncPtr(ImPlotGetter getter, void* data, int count) : Getter(getter), Data(data), Count(count) { } template IMPLOT_INLINE ImPlotPoint operator()(I idx) const { return Getter(idx, Data); } ImPlotGetter Getter; void* const Data; const int Count; }; template struct GetterOverrideX { GetterOverrideX(_Getter getter, double x) : Getter(getter), X(x), Count(getter.Count) { } template IMPLOT_INLINE ImPlotPoint operator()(I idx) const { ImPlotPoint p = Getter(idx); p.x = X; return p; } const _Getter Getter; const double X; const int Count; }; template struct GetterOverrideY { GetterOverrideY(_Getter getter, double y) : Getter(getter), Y(y), Count(getter.Count) { } template IMPLOT_INLINE ImPlotPoint operator()(I idx) const { ImPlotPoint p = Getter(idx); p.y = Y; return p; } const _Getter Getter; const double Y; const int Count; }; template struct GetterLoop { GetterLoop(_Getter getter) : Getter(getter), Count(getter.Count + 1) { } template IMPLOT_INLINE ImPlotPoint operator()(I idx) const { idx = idx % (Count - 1); return Getter(idx); } const _Getter Getter; const int Count; }; template struct GetterError { GetterError(const T* xs, const T* ys, const T* neg, const T* pos, int count, int offset, int stride) : Xs(xs), Ys(ys), Neg(neg), Pos(pos), Count(count), Offset(count ? ImPosMod(offset, count) : 0), Stride(stride) { } template IMPLOT_INLINE ImPlotPointError operator()(I idx) const { return ImPlotPointError((double)IndexData(Xs, idx, Count, Offset, Stride), (double)IndexData(Ys, idx, Count, Offset, Stride), (double)IndexData(Neg, idx, Count, Offset, Stride), (double)IndexData(Pos, idx, Count, Offset, Stride)); } const T* const Xs; const T* const Ys; const T* const Neg; const T* const Pos; const int Count; const int Offset; const int Stride; }; //----------------------------------------------------------------------------- // [SECTION] Fitters //----------------------------------------------------------------------------- template struct Fitter1 { Fitter1(const _Getter1& getter) : Getter(getter) { } void Fit(ImPlotAxis& x_axis, ImPlotAxis& y_axis) const { for (int i = 0; i < Getter.Count; ++i) { ImPlotPoint p = Getter(i); x_axis.ExtendFitWith(y_axis, p.x, p.y); y_axis.ExtendFitWith(x_axis, p.y, p.x); } } const _Getter1& Getter; }; template struct FitterX { FitterX(const _Getter1& getter) : Getter(getter) { } void Fit(ImPlotAxis& x_axis, ImPlotAxis&) const { for (int i = 0; i < Getter.Count; ++i) { ImPlotPoint p = Getter(i); x_axis.ExtendFit(p.x); } } const _Getter1& Getter; }; template struct FitterY { FitterY(const _Getter1& getter) : Getter(getter) { } void Fit(ImPlotAxis&, ImPlotAxis& y_axis) const { for (int i = 0; i < Getter.Count; ++i) { ImPlotPoint p = Getter(i); y_axis.ExtendFit(p.y); } } const _Getter1& Getter; }; template struct Fitter2 { Fitter2(const _Getter1& getter1, const _Getter2& getter2) : Getter1(getter1), Getter2(getter2) { } void Fit(ImPlotAxis& x_axis, ImPlotAxis& y_axis) const { for (int i = 0; i < Getter1.Count; ++i) { ImPlotPoint p = Getter1(i); x_axis.ExtendFitWith(y_axis, p.x, p.y); y_axis.ExtendFitWith(x_axis, p.y, p.x); } for (int i = 0; i < Getter2.Count; ++i) { ImPlotPoint p = Getter2(i); x_axis.ExtendFitWith(y_axis, p.x, p.y); y_axis.ExtendFitWith(x_axis, p.y, p.x); } } const _Getter1& Getter1; const _Getter2& Getter2; }; template struct FitterBarV { FitterBarV(const _Getter1& getter1, const _Getter2& getter2, double width) : Getter1(getter1), Getter2(getter2), HalfWidth(width*0.5) { } void Fit(ImPlotAxis& x_axis, ImPlotAxis& y_axis) const { int count = ImMin(Getter1.Count, Getter2.Count); for (int i = 0; i < count; ++i) { ImPlotPoint p1 = Getter1(i); p1.x -= HalfWidth; ImPlotPoint p2 = Getter2(i); p2.x += HalfWidth; x_axis.ExtendFitWith(y_axis, p1.x, p1.y); y_axis.ExtendFitWith(x_axis, p1.y, p1.x); x_axis.ExtendFitWith(y_axis, p2.x, p2.y); y_axis.ExtendFitWith(x_axis, p2.y, p2.x); } } const _Getter1& Getter1; const _Getter2& Getter2; const double HalfWidth; }; template struct FitterBarH { FitterBarH(const _Getter1& getter1, const _Getter2& getter2, double height) : Getter1(getter1), Getter2(getter2), HalfHeight(height*0.5) { } void Fit(ImPlotAxis& x_axis, ImPlotAxis& y_axis) const { int count = ImMin(Getter1.Count, Getter2.Count); for (int i = 0; i < count; ++i) { ImPlotPoint p1 = Getter1(i); p1.y -= HalfHeight; ImPlotPoint p2 = Getter2(i); p2.y += HalfHeight; x_axis.ExtendFitWith(y_axis, p1.x, p1.y); y_axis.ExtendFitWith(x_axis, p1.y, p1.x); x_axis.ExtendFitWith(y_axis, p2.x, p2.y); y_axis.ExtendFitWith(x_axis, p2.y, p2.x); } } const _Getter1& Getter1; const _Getter2& Getter2; const double HalfHeight; }; struct FitterRect { FitterRect(const ImPlotPoint& pmin, const ImPlotPoint& pmax) : Pmin(pmin), Pmax(pmax) { } FitterRect(const ImPlotRect& rect) : FitterRect(rect.Min(), rect.Max()) { } void Fit(ImPlotAxis& x_axis, ImPlotAxis& y_axis) const { x_axis.ExtendFitWith(y_axis, Pmin.x, Pmin.y); y_axis.ExtendFitWith(x_axis, Pmin.y, Pmin.x); x_axis.ExtendFitWith(y_axis, Pmax.x, Pmax.y); y_axis.ExtendFitWith(x_axis, Pmax.y, Pmax.x); } const ImPlotPoint Pmin; const ImPlotPoint Pmax; }; //----------------------------------------------------------------------------- // [SECTION] Transformers //----------------------------------------------------------------------------- struct Transformer1 { Transformer1(double pixMin, double pltMin, double pltMax, double m, double scaMin, double scaMax, ImPlotTransform fwd, void* data) : ScaMin(scaMin), ScaMax(scaMax), PltMin(pltMin), PltMax(pltMax), PixMin(pixMin), M(m), TransformFwd(fwd), TransformData(data) { } template IMPLOT_INLINE float operator()(T p) const { if (TransformFwd != nullptr) { double s = TransformFwd(p, TransformData); double t = (s - ScaMin) / (ScaMax - ScaMin); p = PltMin + (PltMax - PltMin) * t; } return (float)(PixMin + M * (p - PltMin)); } double ScaMin, ScaMax, PltMin, PltMax, PixMin, M; ImPlotTransform TransformFwd; void* TransformData; }; struct Transformer2 { Transformer2(const ImPlotAxis& x_axis, const ImPlotAxis& y_axis) : Tx(x_axis.PixelMin, x_axis.Range.Min, x_axis.Range.Max, x_axis.ScaleToPixel, x_axis.ScaleMin, x_axis.ScaleMax, x_axis.TransformForward, x_axis.TransformData), Ty(y_axis.PixelMin, y_axis.Range.Min, y_axis.Range.Max, y_axis.ScaleToPixel, y_axis.ScaleMin, y_axis.ScaleMax, y_axis.TransformForward, y_axis.TransformData) { } Transformer2(const ImPlotPlot& plot) : Transformer2(plot.Axes[plot.CurrentX], plot.Axes[plot.CurrentY]) { } Transformer2() : Transformer2(*GImPlot->CurrentPlot) { } template IMPLOT_INLINE ImVec2 operator()(const P& plt) const { ImVec2 out; out.x = Tx(plt.x); out.y = Ty(plt.y); return out; } template IMPLOT_INLINE ImVec2 operator()(T x, T y) const { ImVec2 out; out.x = Tx(x); out.y = Ty(y); return out; } Transformer1 Tx; Transformer1 Ty; }; //----------------------------------------------------------------------------- // [SECTION] Renderers //----------------------------------------------------------------------------- struct RendererBase { RendererBase(int prims, int idx_consumed, int vtx_consumed) : Prims(prims), IdxConsumed(idx_consumed), VtxConsumed(vtx_consumed) { } const int Prims; Transformer2 Transformer; const int IdxConsumed; const int VtxConsumed; }; template struct RendererLineStrip : RendererBase { RendererLineStrip(const _Getter& getter, ImU32 col, float weight) : RendererBase(getter.Count - 1, 6, 4), Getter(getter), Col(col), HalfWeight(ImMax(1.0f,weight)*0.5f) { P1 = this->Transformer(Getter(0)); } void Init(ImDrawList& draw_list) const { GetLineRenderProps(draw_list, HalfWeight, UV0, UV1); } IMPLOT_INLINE bool Render(ImDrawList& draw_list, const ImRect& cull_rect, int prim) const { ImVec2 P2 = this->Transformer(Getter(prim + 1)); if (!cull_rect.Overlaps(ImRect(ImMin(P1, P2), ImMax(P1, P2)))) { P1 = P2; return false; } PrimLine(draw_list,P1,P2,HalfWeight,Col,UV0,UV1); P1 = P2; return true; } const _Getter& Getter; const ImU32 Col; mutable float HalfWeight; mutable ImVec2 P1; mutable ImVec2 UV0; mutable ImVec2 UV1; }; template struct RendererLineStripSkip : RendererBase { RendererLineStripSkip(const _Getter& getter, ImU32 col, float weight) : RendererBase(getter.Count - 1, 6, 4), Getter(getter), Col(col), HalfWeight(ImMax(1.0f,weight)*0.5f) { P1 = this->Transformer(Getter(0)); } void Init(ImDrawList& draw_list) const { GetLineRenderProps(draw_list, HalfWeight, UV0, UV1); } IMPLOT_INLINE bool Render(ImDrawList& draw_list, const ImRect& cull_rect, int prim) const { ImVec2 P2 = this->Transformer(Getter(prim + 1)); if (!cull_rect.Overlaps(ImRect(ImMin(P1, P2), ImMax(P1, P2)))) { if (!ImNan(P2.x) && !ImNan(P2.y)) P1 = P2; return false; } PrimLine(draw_list,P1,P2,HalfWeight,Col,UV0,UV1); if (!ImNan(P2.x) && !ImNan(P2.y)) P1 = P2; return true; } const _Getter& Getter; const ImU32 Col; mutable float HalfWeight; mutable ImVec2 P1; mutable ImVec2 UV0; mutable ImVec2 UV1; }; template struct RendererLineSegments1 : RendererBase { RendererLineSegments1(const _Getter& getter, ImU32 col, float weight) : RendererBase(getter.Count / 2, 6, 4), Getter(getter), Col(col), HalfWeight(ImMax(1.0f,weight)*0.5f) { } void Init(ImDrawList& draw_list) const { GetLineRenderProps(draw_list, HalfWeight, UV0, UV1); } IMPLOT_INLINE bool Render(ImDrawList& draw_list, const ImRect& cull_rect, int prim) const { ImVec2 P1 = this->Transformer(Getter(prim*2+0)); ImVec2 P2 = this->Transformer(Getter(prim*2+1)); if (!cull_rect.Overlaps(ImRect(ImMin(P1, P2), ImMax(P1, P2)))) return false; PrimLine(draw_list,P1,P2,HalfWeight,Col,UV0,UV1); return true; } const _Getter& Getter; const ImU32 Col; mutable float HalfWeight; mutable ImVec2 UV0; mutable ImVec2 UV1; }; template struct RendererLineSegments2 : RendererBase { RendererLineSegments2(const _Getter1& getter1, const _Getter2& getter2, ImU32 col, float weight) : RendererBase(ImMin(getter1.Count, getter1.Count), 6, 4), Getter1(getter1), Getter2(getter2), Col(col), HalfWeight(ImMax(1.0f,weight)*0.5f) {} void Init(ImDrawList& draw_list) const { GetLineRenderProps(draw_list, HalfWeight, UV0, UV1); } IMPLOT_INLINE bool Render(ImDrawList& draw_list, const ImRect& cull_rect, int prim) const { ImVec2 P1 = this->Transformer(Getter1(prim)); ImVec2 P2 = this->Transformer(Getter2(prim)); if (!cull_rect.Overlaps(ImRect(ImMin(P1, P2), ImMax(P1, P2)))) return false; PrimLine(draw_list,P1,P2,HalfWeight,Col,UV0,UV1); return true; } const _Getter1& Getter1; const _Getter2& Getter2; const ImU32 Col; mutable float HalfWeight; mutable ImVec2 UV0; mutable ImVec2 UV1; }; template struct RendererBarsFillV : RendererBase { RendererBarsFillV(const _Getter1& getter1, const _Getter2& getter2, ImU32 col, double width) : RendererBase(ImMin(getter1.Count, getter1.Count), 6, 4), Getter1(getter1), Getter2(getter2), Col(col), HalfWidth(width/2) {} void Init(ImDrawList& draw_list) const { UV = draw_list._Data->TexUvWhitePixel; } IMPLOT_INLINE bool Render(ImDrawList& draw_list, const ImRect& cull_rect, int prim) const { ImPlotPoint p1 = Getter1(prim); ImPlotPoint p2 = Getter2(prim); p1.x += HalfWidth; p2.x -= HalfWidth; ImVec2 P1 = this->Transformer(p1); ImVec2 P2 = this->Transformer(p2); float width_px = ImAbs(P1.x-P2.x); if (width_px < 1.0f) { P1.x += P1.x > P2.x ? (1-width_px) / 2 : (width_px-1) / 2; P2.x += P2.x > P1.x ? (1-width_px) / 2 : (width_px-1) / 2; } ImVec2 PMin = ImMin(P1, P2); ImVec2 PMax = ImMax(P1, P2); if (!cull_rect.Overlaps(ImRect(PMin, PMax))) return false; PrimRectFill(draw_list,PMin,PMax,Col,UV); return true; } const _Getter1& Getter1; const _Getter2& Getter2; const ImU32 Col; const double HalfWidth; mutable ImVec2 UV; }; template struct RendererBarsFillH : RendererBase { RendererBarsFillH(const _Getter1& getter1, const _Getter2& getter2, ImU32 col, double height) : RendererBase(ImMin(getter1.Count, getter1.Count), 6, 4), Getter1(getter1), Getter2(getter2), Col(col), HalfHeight(height/2) {} void Init(ImDrawList& draw_list) const { UV = draw_list._Data->TexUvWhitePixel; } IMPLOT_INLINE bool Render(ImDrawList& draw_list, const ImRect& cull_rect, int prim) const { ImPlotPoint p1 = Getter1(prim); ImPlotPoint p2 = Getter2(prim); p1.y += HalfHeight; p2.y -= HalfHeight; ImVec2 P1 = this->Transformer(p1); ImVec2 P2 = this->Transformer(p2); float height_px = ImAbs(P1.y-P2.y); if (height_px < 1.0f) { P1.y += P1.y > P2.y ? (1-height_px) / 2 : (height_px-1) / 2; P2.y += P2.y > P1.y ? (1-height_px) / 2 : (height_px-1) / 2; } ImVec2 PMin = ImMin(P1, P2); ImVec2 PMax = ImMax(P1, P2); if (!cull_rect.Overlaps(ImRect(PMin, PMax))) return false; PrimRectFill(draw_list,PMin,PMax,Col,UV); return true; } const _Getter1& Getter1; const _Getter2& Getter2; const ImU32 Col; const double HalfHeight; mutable ImVec2 UV; }; template struct RendererBarsLineV : RendererBase { RendererBarsLineV(const _Getter1& getter1, const _Getter2& getter2, ImU32 col, double width, float weight) : RendererBase(ImMin(getter1.Count, getter1.Count), 24, 8), Getter1(getter1), Getter2(getter2), Col(col), HalfWidth(width/2), Weight(weight) {} void Init(ImDrawList& draw_list) const { UV = draw_list._Data->TexUvWhitePixel; } IMPLOT_INLINE bool Render(ImDrawList& draw_list, const ImRect& cull_rect, int prim) const { ImPlotPoint p1 = Getter1(prim); ImPlotPoint p2 = Getter2(prim); p1.x += HalfWidth; p2.x -= HalfWidth; ImVec2 P1 = this->Transformer(p1); ImVec2 P2 = this->Transformer(p2); float width_px = ImAbs(P1.x-P2.x); if (width_px < 1.0f) { P1.x += P1.x > P2.x ? (1-width_px) / 2 : (width_px-1) / 2; P2.x += P2.x > P1.x ? (1-width_px) / 2 : (width_px-1) / 2; } ImVec2 PMin = ImMin(P1, P2); ImVec2 PMax = ImMax(P1, P2); if (!cull_rect.Overlaps(ImRect(PMin, PMax))) return false; PrimRectLine(draw_list,PMin,PMax,Weight,Col,UV); return true; } const _Getter1& Getter1; const _Getter2& Getter2; const ImU32 Col; const double HalfWidth; const float Weight; mutable ImVec2 UV; }; template struct RendererBarsLineH : RendererBase { RendererBarsLineH(const _Getter1& getter1, const _Getter2& getter2, ImU32 col, double height, float weight) : RendererBase(ImMin(getter1.Count, getter1.Count), 24, 8), Getter1(getter1), Getter2(getter2), Col(col), HalfHeight(height/2), Weight(weight) {} void Init(ImDrawList& draw_list) const { UV = draw_list._Data->TexUvWhitePixel; } IMPLOT_INLINE bool Render(ImDrawList& draw_list, const ImRect& cull_rect, int prim) const { ImPlotPoint p1 = Getter1(prim); ImPlotPoint p2 = Getter2(prim); p1.y += HalfHeight; p2.y -= HalfHeight; ImVec2 P1 = this->Transformer(p1); ImVec2 P2 = this->Transformer(p2); float height_px = ImAbs(P1.y-P2.y); if (height_px < 1.0f) { P1.y += P1.y > P2.y ? (1-height_px) / 2 : (height_px-1) / 2; P2.y += P2.y > P1.y ? (1-height_px) / 2 : (height_px-1) / 2; } ImVec2 PMin = ImMin(P1, P2); ImVec2 PMax = ImMax(P1, P2); if (!cull_rect.Overlaps(ImRect(PMin, PMax))) return false; PrimRectLine(draw_list,PMin,PMax,Weight,Col,UV); return true; } const _Getter1& Getter1; const _Getter2& Getter2; const ImU32 Col; const double HalfHeight; const float Weight; mutable ImVec2 UV; }; template struct RendererStairsPre : RendererBase { RendererStairsPre(const _Getter& getter, ImU32 col, float weight) : RendererBase(getter.Count - 1, 12, 8), Getter(getter), Col(col), HalfWeight(ImMax(1.0f,weight)*0.5f) { P1 = this->Transformer(Getter(0)); } void Init(ImDrawList& draw_list) const { UV = draw_list._Data->TexUvWhitePixel; } IMPLOT_INLINE bool Render(ImDrawList& draw_list, const ImRect& cull_rect, int prim) const { ImVec2 P2 = this->Transformer(Getter(prim + 1)); if (!cull_rect.Overlaps(ImRect(ImMin(P1, P2), ImMax(P1, P2)))) { P1 = P2; return false; } PrimRectFill(draw_list, ImVec2(P1.x - HalfWeight, P1.y), ImVec2(P1.x + HalfWeight, P2.y), Col, UV); PrimRectFill(draw_list, ImVec2(P1.x, P2.y + HalfWeight), ImVec2(P2.x, P2.y - HalfWeight), Col, UV); P1 = P2; return true; } const _Getter& Getter; const ImU32 Col; mutable float HalfWeight; mutable ImVec2 P1; mutable ImVec2 UV; }; template struct RendererStairsPost : RendererBase { RendererStairsPost(const _Getter& getter, ImU32 col, float weight) : RendererBase(getter.Count - 1, 12, 8), Getter(getter), Col(col), HalfWeight(ImMax(1.0f,weight) * 0.5f) { P1 = this->Transformer(Getter(0)); } void Init(ImDrawList& draw_list) const { UV = draw_list._Data->TexUvWhitePixel; } IMPLOT_INLINE bool Render(ImDrawList& draw_list, const ImRect& cull_rect, int prim) const { ImVec2 P2 = this->Transformer(Getter(prim + 1)); if (!cull_rect.Overlaps(ImRect(ImMin(P1, P2), ImMax(P1, P2)))) { P1 = P2; return false; } PrimRectFill(draw_list, ImVec2(P1.x, P1.y + HalfWeight), ImVec2(P2.x, P1.y - HalfWeight), Col, UV); PrimRectFill(draw_list, ImVec2(P2.x - HalfWeight, P2.y), ImVec2(P2.x + HalfWeight, P1.y), Col, UV); P1 = P2; return true; } const _Getter& Getter; const ImU32 Col; mutable float HalfWeight; mutable ImVec2 P1; mutable ImVec2 UV; }; template struct RendererStairsPreShaded : RendererBase { RendererStairsPreShaded(const _Getter& getter, ImU32 col) : RendererBase(getter.Count - 1, 6, 4), Getter(getter), Col(col) { P1 = this->Transformer(Getter(0)); Y0 = this->Transformer(ImPlotPoint(0,0)).y; } void Init(ImDrawList& draw_list) const { UV = draw_list._Data->TexUvWhitePixel; } IMPLOT_INLINE bool Render(ImDrawList& draw_list, const ImRect& cull_rect, int prim) const { ImVec2 P2 = this->Transformer(Getter(prim + 1)); ImVec2 PMin(ImMin(P1.x, P2.x), ImMin(Y0, P2.y)); ImVec2 PMax(ImMax(P1.x, P2.x), ImMax(Y0, P2.y)); if (!cull_rect.Overlaps(ImRect(PMin, PMax))) { P1 = P2; return false; } PrimRectFill(draw_list, PMin, PMax, Col, UV); P1 = P2; return true; } const _Getter& Getter; const ImU32 Col; float Y0; mutable ImVec2 P1; mutable ImVec2 UV; }; template struct RendererStairsPostShaded : RendererBase { RendererStairsPostShaded(const _Getter& getter, ImU32 col) : RendererBase(getter.Count - 1, 6, 4), Getter(getter), Col(col) { P1 = this->Transformer(Getter(0)); Y0 = this->Transformer(ImPlotPoint(0,0)).y; } void Init(ImDrawList& draw_list) const { UV = draw_list._Data->TexUvWhitePixel; } IMPLOT_INLINE bool Render(ImDrawList& draw_list, const ImRect& cull_rect, int prim) const { ImVec2 P2 = this->Transformer(Getter(prim + 1)); ImVec2 PMin(ImMin(P1.x, P2.x), ImMin(P1.y, Y0)); ImVec2 PMax(ImMax(P1.x, P2.x), ImMax(P1.y, Y0)); if (!cull_rect.Overlaps(ImRect(PMin, PMax))) { P1 = P2; return false; } PrimRectFill(draw_list, PMin, PMax, Col, UV); P1 = P2; return true; } const _Getter& Getter; const ImU32 Col; float Y0; mutable ImVec2 P1; mutable ImVec2 UV; }; template struct RendererShaded : RendererBase { RendererShaded(const _Getter1& getter1, const _Getter2& getter2, ImU32 col) : RendererBase(ImMin(getter1.Count, getter2.Count) - 1, 6, 5), Getter1(getter1), Getter2(getter2), Col(col) { P11 = this->Transformer(Getter1(0)); P12 = this->Transformer(Getter2(0)); } void Init(ImDrawList& draw_list) const { UV = draw_list._Data->TexUvWhitePixel; } IMPLOT_INLINE bool Render(ImDrawList& draw_list, const ImRect& cull_rect, int prim) const { ImVec2 P21 = this->Transformer(Getter1(prim+1)); ImVec2 P22 = this->Transformer(Getter2(prim+1)); ImRect rect(ImMin(ImMin(ImMin(P11,P12),P21),P22), ImMax(ImMax(ImMax(P11,P12),P21),P22)); if (!cull_rect.Overlaps(rect)) { P11 = P21; P12 = P22; return false; } const int intersect = (P11.y > P12.y && P22.y > P21.y) || (P12.y > P11.y && P21.y > P22.y); ImVec2 intersection = Intersection(P11,P21,P12,P22); draw_list._VtxWritePtr[0].pos = P11; draw_list._VtxWritePtr[0].uv = UV; draw_list._VtxWritePtr[0].col = Col; draw_list._VtxWritePtr[1].pos = P21; draw_list._VtxWritePtr[1].uv = UV; draw_list._VtxWritePtr[1].col = Col; draw_list._VtxWritePtr[2].pos = intersection; draw_list._VtxWritePtr[2].uv = UV; draw_list._VtxWritePtr[2].col = Col; draw_list._VtxWritePtr[3].pos = P12; draw_list._VtxWritePtr[3].uv = UV; draw_list._VtxWritePtr[3].col = Col; draw_list._VtxWritePtr[4].pos = P22; draw_list._VtxWritePtr[4].uv = UV; draw_list._VtxWritePtr[4].col = Col; draw_list._VtxWritePtr += 5; draw_list._IdxWritePtr[0] = (ImDrawIdx)(draw_list._VtxCurrentIdx); draw_list._IdxWritePtr[1] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 1 + intersect); draw_list._IdxWritePtr[2] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 3); draw_list._IdxWritePtr[3] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 1); draw_list._IdxWritePtr[4] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 4); draw_list._IdxWritePtr[5] = (ImDrawIdx)(draw_list._VtxCurrentIdx + 3 - intersect); draw_list._IdxWritePtr += 6; draw_list._VtxCurrentIdx += 5; P11 = P21; P12 = P22; return true; } const _Getter1& Getter1; const _Getter2& Getter2; const ImU32 Col; mutable ImVec2 P11; mutable ImVec2 P12; mutable ImVec2 UV; }; struct RectC { ImPlotPoint Pos; ImPlotPoint HalfSize; ImU32 Color; }; template struct RendererRectC : RendererBase { RendererRectC(const _Getter& getter) : RendererBase(getter.Count, 6, 4), Getter(getter) {} void Init(ImDrawList& draw_list) const { UV = draw_list._Data->TexUvWhitePixel; } IMPLOT_INLINE bool Render(ImDrawList& draw_list, const ImRect& cull_rect, int prim) const { RectC rect = Getter(prim); ImVec2 P1 = this->Transformer(rect.Pos.x - rect.HalfSize.x , rect.Pos.y - rect.HalfSize.y); ImVec2 P2 = this->Transformer(rect.Pos.x + rect.HalfSize.x , rect.Pos.y + rect.HalfSize.y); if ((rect.Color & IM_COL32_A_MASK) == 0 || !cull_rect.Overlaps(ImRect(ImMin(P1, P2), ImMax(P1, P2)))) return false; PrimRectFill(draw_list,P1,P2,rect.Color,UV); return true; } const _Getter& Getter; mutable ImVec2 UV; }; //----------------------------------------------------------------------------- // [SECTION] RenderPrimitives //----------------------------------------------------------------------------- /// Renders primitive shapes in bulk as efficiently as possible. template void RenderPrimitivesEx(const _Renderer& renderer, ImDrawList& draw_list, const ImRect& cull_rect) { unsigned int prims = renderer.Prims; unsigned int prims_culled = 0; unsigned int idx = 0; renderer.Init(draw_list); while (prims) { // find how many can be reserved up to end of current draw command's limit unsigned int cnt = ImMin(prims, (MaxIdx::Value - draw_list._VtxCurrentIdx) / renderer.VtxConsumed); // make sure at least this many elements can be rendered to avoid situations where at the end of buffer this slow path is not taken all the time if (cnt >= ImMin(64u, prims)) { if (prims_culled >= cnt) prims_culled -= cnt; // reuse previous reservation else { // add more elements to previous reservation draw_list.PrimReserve((cnt - prims_culled) * renderer.IdxConsumed, (cnt - prims_culled) * renderer.VtxConsumed); prims_culled = 0; } } else { if (prims_culled > 0) { draw_list.PrimUnreserve(prims_culled * renderer.IdxConsumed, prims_culled * renderer.VtxConsumed); prims_culled = 0; } cnt = ImMin(prims, (MaxIdx::Value - 0/*draw_list._VtxCurrentIdx*/) / renderer.VtxConsumed); // reserve new draw command draw_list.PrimReserve(cnt * renderer.IdxConsumed, cnt * renderer.VtxConsumed); } prims -= cnt; for (unsigned int ie = idx + cnt; idx != ie; ++idx) { if (!renderer.Render(draw_list, cull_rect, idx)) prims_culled++; } } if (prims_culled > 0) draw_list.PrimUnreserve(prims_culled * renderer.IdxConsumed, prims_culled * renderer.VtxConsumed); } template