Features, Breaking Changes & Deprecation

[ful1e5]

Subscribe to this discussion to receive updates on breaking changes and deprecations.

[ful1e5]

Changelog-08172023

Date: August 17, 2023
Ref: 8d2b722

In the configuration file, the [config] section no longer supports the 'win_size' and 'x11_sizes' options. Instead, utilize the 'win_sizes' and 'x11_sizes' settings within each cursor's configuration.

Alternatively, you can assign them to [cursors.fallback_settings].

Here's the updated configuration:

# Deprecated - Avoid using these settings
[config]
# ...
- x11_sizes = [21, 24, 28, 32, 40, 48, 56, 64, 72, 80, 88, 96]
- win_size = 32

[cursors]

# Use this as the fallback for cursor sizes
[cursors.fallback_settings]
# ...
+ x11_sizes = [21, 24, 28, 32, 40, 48, 56, 64, 72, 80, 88, 96]
+ win_sizes = [32, 48]

[cursors.fake_pointer]
# ...
+ x11_sizes = [28, 32, 88, 96] # Adjust sizes for XCursors and...
+ win_sizes = [20] # ...Windows Cursors for this specific cursor

[ful1e5]

Changelog-05212024

Date: May 21, 2024
Ref: 0f6e9b8 706fbbe

Clickgen now allows cursor bitmap re-canvasing by specifying sizes using the cursor_size:canvas_size format.

Caveats

• To utilize canvasing in config files, all sizes must be passed in List[string] format in both config files and Python code.

Using the library:

#!/usr/bin/env python
# -*- coding: utf-8 -*-

from clickgen.parser import open_blob


if __name__ == "__main__":
    # ...

    open_blob(pngs, hotspot=(100, 100), sizes=["24:32", "32"])  # ✅ Correct [CANVASING]
    open_blob(pngs, hotspot=(100, 100), sizes=["24", "32"])     # ✅ Correct [NORMAL]
    open_blob(pngs, hotspot=(100, 100), sizes=[24, 32])         # ✅ Correct [NORMAL]

    open_blob(pngs, hotspot=(100, 100), sizes=["24", 32])       # ❌ Error [NORMAL]
    open_blob(pngs, hotspot=(100, 100), sizes=["24:32", 32])    # ❌ Error [CANVASING]

Using the clickgen CLI:

clickgen samples/pngs/pointer.png -x 10 -y 10 -s "22:32" "24" "32" -p x11   # ✅ Correct [CANVASING]
clickgen samples/pngs/pointer.png -x 10 -y 10 -s "22" "24" "32" -p x11      # ✅ Correct [NORMAL]
clickgen samples/pngs/pointer.png -x 10 -y 10 -s 22 24 32 -p x11            # ✅ Correct [NORMAL]

clickgen samples/pngs/pointer.png -x 10 -y 10 -s "22" 24 32 -p x11          # ✅ Correct [NORMAL]
clickgen samples/pngs/pointer.png -x 10 -y 10 -s "22:32" 24 32 -p x11       # ✅ Correct [CANVASING]

Using the ctgen CLI:

ctgen samples/sample.toml -s "22:32" "24" "32" -p x11   # ✅ Correct [CANVASING]
ctgen samples/sample.toml -s "22" "24" "32" -p x11      # ✅ Correct [NORMAL]
ctgen samples/sample.toml -s 22 24 32 -p x11            # ✅ Correct [NORMAL]

ctgen samples/sample.toml -s "22" 24 32 -p x11          # ✅ Correct [NORMAL]
ctgen samples/sample.toml -s "22:32" 24 32 -p x11       # ✅ Correct [CANVASING]

Using the config files

TOML config

# ...

[cursors]
[cursors.fallback_settings]
x11_sizes = [16, 20, 24, 28, 32, 40, 48, 56, 64, 72, 80, 88, 96]

win_sizes = ['24:32', '32', '48', '64', '96']         # ✅ Correct [CANVASING]
win_sizes = ['24', '32', '48', '64', '96']            # ✅ Correct [NORMAL]
win_sizes = [24, 32, 48, 64, 96]                      # ✅ Correct [NORMAL]

win_sizes = ['24', 32, 48, 64, 96]                    # ❌ Error [NORMAL]
win_sizes = ['24:32', 32, 48, 64, 96]                 # ❌ Error [CANVASING]

[cursors.pointer1]
png = 'pointer.png'
win_name = 'Default'
x11_name = 'pointer1'
x11_symlinks = ['link1']
x11_sizes = [24, 32]

# ...

JSON config

{
    // ...

    "cursors": {
        "fallback_settings": {
            "x11_sizes": [16, 20, 24, 28, 32, 40, 48, 56, 64, 72, 80, 88, 96],
            "win_sizes": ["24:32", "32", "48", "64", "96"]         // ✅ Correct [CANVASING]
            "win_sizes": ["24", "32", "48", "64", "96"],           // ✅ Correct [NORMAL]
            "win_sizes": [24, 32, 48, 64, 96],                     // ✅ Correct [NORMAL]

            "win_sizes": ["24", 32, 48, 64, 96],                   // ❌ Error [NORMAL]
            "win_sizes": ["24:32", 32, 48, 64, 96]                 // ❌ Error [CANVASING]
        },
        "pointer1": {
            "png": "pointer.png",
            "win_name": "Default",
            "x11_name": "pointer1",
            "x11_symlinks": ["link1"],
            "x11_sizes": [24, 32]
        }

        // ...
    },
}

YAML config

# ...

cursors:
  fallback_settings:
    x11_sizes: [16, 20, 24, 28, 32, 40, 48, 56, 64, 72, 80, 88, 96]

    win_sizes: ['24:32', '32', '48', '64', '96']         # ✅ Correct [CANVASING]
    win_sizes: ['24', '32', '48', '64', '96']            # ✅ Correct [NORMAL]
    win_sizes: [24, 32, 48, 64, 96]                      # ✅ Correct [NORMAL]

    win_sizes: ['24', 32, 48, 64, 96]                    # ❌ Error [NORMAL]
    win_sizes: ['24:32', 32, 48, 64, 96]                 # ❌ Error [CANVASING]

  pointer1:
    png: 'pointer.png'
    win_name: 'Default'
    x11_name: 'pointer1'
    x11_symlinks: ['link1']
    x11_sizes: [24, 32]

  # ...