Skip to content

README.md

Latest commit

 

History

History
104 lines (80 loc) · 3.9 KB

README.md

File metadata and controls

104 lines (80 loc) · 3.9 KB

hxWindowColorMode

hxWindowColorMode is a haxelib containing C++ functions for setting the window border & header to dark mode, light mode, and even custom colors!

Installation

Use the following command to install hxWindowColorMode into your haxelib library:

For stable releases, use: haxelib install hxWindowColorMode

If you want to get the latest Github releases of hxWindowColorMode, use: haxelib git hxWindowColorMode https://github.com/TBar09/hxWindowColorMode-main.git

For OpenFL / Haxeflixel projects

Add this to "project.xml` in your project's source code.

<haxelib name="hxWindowColorMode"/>

Haxe Projects

Add this to build.hxml.

-lib hxWindowColorMode

Docs / Usage

To use the library, import this in a class of your choice: import hxwindowmode.WindowColorMode;

Here are the functions present in the haxelib currently (as of 0.2.1):

	// FUNCTIONS //

	// Sets the window to dark mode. (returns true if it was successful)
	WindowColorMode.setDarkMode();

	// Sets the window to light mode (default). (returns true if it was successful)
	WindowColorMode.setLightMode();

	// Shortcut to both setLightMode and setDarkMode. (returns true if it was successful)
	WindowColorMode.setWindowColorMode(isDark:Bool = true);
	
	// Sets the header and/or border to a color of your choosing. (Only Windows 11 supports this).
	WindowColorMode.setWindowBorderColor(color:Array<Int>, setHeader:Bool = true, setBorder:Bool = true);

	// Sets the title text to a color of your choosing. (Only Windows 11 supports this).
	WindowColorMode.setWindowTitleColor(color:Array<Int>);

	// Sets the window's corners, usually rounded or square shaped. (Only Windows 11 supports this).
	WindowColorMode.setWindowCornerType(cornerType:Int = 0);

	// (deprecated, use redrawWindowHeader) Resets the window.
	WindowColorMode.resetScreenSize();

	// Resets the window. It is recommended to use this after running any of the functions above so the effect is drawn immediately.
	// (Windows 11 doesn't need this, but it's needed on Windows 10, or else the effect won't take place until you unfocus/refocus the window).
	WindowColorMode.redrawWindowHeader();

	// VARIABLES //
	WindowColorMode.isDarkMode // (Boolean) returns true if the window is dark mode.
	WindowColorMode.windowHeaderColor // (Array<Int>) returns the current color of the header.
	WindowColorMode.windowBorderColor // (Array<Int>) returns the current color of the border.
	WindowColorMode.windowTitleColor // (Array<Int>) returns the current color of the title text.
	WindowColorMode.windowCornerType // (Int) returns the current corner type of the window.
	WindowColorMode.isWindows10 // (Boolean) returns if the current OS is Windows 10.

Here is an example of setting the window to dark mode when you press the TAB key.

	override function update(elapsed:Float) {
		if(flixel.FlxG.keys.justPressed.TAB) {
			WindowColorMode.setDarkMode();
			WindowColorMode.redrawWindowHeader();
		}
	}

Here is an example of setting just the window's header to red.

	override function create() {
		WindowColorMode.setWindowBorderColor([255, 0, 0], true, false);
	}

Here is an example of setting the window's header and border to green on create, then turns blue on destroy, while also setting the window's title text to the original color of the header (which was green).

	override function create() {
		WindowColorMode.setWindowBorderColor([0, 255, 0], true, true);
	}
	
	override function destroy() {
		WindowColorMode.setWindowTitleColor(WindowColorMode.windowHeaderColor);
		WindowColorMode.setWindowBorderColor([0, 0, 255], true, true);
	}

Extras