Api changes and other compatibility notes

pillow advice:

  • if using pyglet < 1.5.9 then use pillow < 8.0

  • in py39 + windows pillow supports only pillow>8; use with pyglet>=1.5.9 and <2

pyglet advice:

cocos 0.6.10

Tested with python 3.11 and 3.8, pyglet 1.5.9 and 1.5.27

Noticed with some AMD graphics drivers on Windows that programs randomly die before showing the cocos window, no traceback nor error mesages; fixed using drivers from whql-amd-software-adrenalin-edition-23.7.1-win10-win11-july6.exe

cocos 0.6.9

Removed deprecated features

  • Director.init : kwparam do_not_scale removed, use its negation, kwparam autoscale

  • Director will not publish an ‘on_resize’ event, use the ‘on_cocos_resize’ Director event, see issue #154

TMX related changes

  • properties for nodes in a tmx (Tiled Editor) file were captured only as int or str, now all types in Tiled 1.3 are traslated, as in

  • ‘string’ -> str

  • ‘int’ -> int

  • ‘bool’ -> bool

  • ‘float’ -> float

  • ‘color’ #AARRGGBB -> tuple color4u, (intRR, intGG, intBB, intAA)

  • ‘file’ -> os.abspath(os.path.join(map_path, value))

User code that parsed a property to do conversion will need to be adjusted.

  • path resolution in tmx resources now follow the Tiled Editor spec

    • a path in a “source” attrib is relative to the node where the “source” happens

    • a property of type “file” is relative to the <map> node

cocos 0.6.8

Tested with python 3.6+ , python 2.x not supported but should run No changes in cocos API Prefered pyglet 1.4.10+ (2.x unsupported, 1.5 unstable)

cocos 0.6.7

First cocos version to run with the pyglet 1.4 series, needs at least pyglet 1.4.3

This cocos version will not run with previous pyglet versions

Signature changes that break compatibilty

  • Class cocos.fps.InfoLabel.__init__

For compatibilty with pyglet 1.4 some cocos’s classes internal state has changed, which only matters if your code subclass those classes, and / or instantiate and modify instance state from outside. Classes affected:

  • cocos.fps.InfoLabel: member .text changed to .label ; it now holds a pyglet.text.Label

  • cocos.scenes.pause.PauseLayer : member .text changed to .label ; it now holds a pyglet.text.Label

Old user code that access underlying pyglet objects may need to adjust to breaking changes in pyglet 1.4; the ones we encountered were:

pyglet.font.Text no longer exists; pyglet sugestion is to replace with pyglet.text.Label. Not a drop-in replacement because the API is diferent, pay attention to differences in parameters types.

pyglet.clock.ClockDisplay no longer exists, use pyglet.clock.FPSDisplay

pyglet constants for text layout like pyglet.font.LEFT no longer exist, use the string lowercase of last member, “left”

When calling .push_handlers(foo) the pyglet event dispatcher will (roughtly) retain a weak reference to foo. If you don’t keept a reference to foo in your code it will go out of scope after the call to .push_handlers(foo), so your handler will never be called. In particular something like window.push_handlers(MyEventsHandlerClass()) will not work in pyglet 1.4

Some classes in pyglet.image eliminated some properties. The sugested fix is to change pyglet.image.SomeClass.foo with …SomeClass.get_foo(…) for read and SomeClass.set_foo(…) for write if code working with pyglet<1.4 tracebacks with “AttributeError: ‘SomeClass’ object has no attribute ‘foo’ “ with pyglet 1.4. Concrete cases found while fixing cocos compatibility with pyglet:

  • ImageDataRegion: image.texture.target -> image.get_texture().target , image.texture.id -> image.get_texture().id

  • TextureRegion: same

pyglet does not support anymore AVBin audio / video, now it uses ffmpeg v4

cocos 0.6.6

  • this is exactly 0.6.5 except that pip or setup.py install will select pyglet < 1.4

  • this version is not compatible with pyglet 1.4

cocos 0.6.5

  • First cocos version to support pyglet 1.3 , tested against pyglet 1.3.rc1

  • Does not support pyglet 1.4 series

  • This cocos version can also run with pyglet 1.2.x

  • Next cocos version will drop support for python 2.6

  • Python 2.7 support can end at any future cocos release, without further advice: if pyglet drops it or a cocos new feature requires more than trivial compatibility code, then cocos will be py3 only

cocos 0.6.4

Imports in cocos library are more specific, so user code that were doing from cocos.somemodule import * may fail to find some symbols. To fix that user code, add explicit exports as needed.

MapColliders classes changed API to be more useful and clear.

Rect.intersects() now it only intersects if some interior points overlaps.

Removed Scene methods push_all_handlers() and remove_all_handlers().

In ScrollingManager two methods have been renamed, the old name is still valid but will be removed in the future:

  • pixel_from_screen() -> screen_to_world()

  • pixel_to_screen() -> world_to_screen()