Don't use refs for unmanaged bitmaps #84
Conversation
| assert(this != nil) | ||
|
|
||
| if this.isNil: | ||
| assert(not this.isNil) |
There was a problem hiding this comment.
Are you forcing a crash here to point debuggers to the cause? That could be a good idea, just wondering
| @@ -390,7 +420,7 @@ proc setBitmapMask*( | |||
|
|
|||
| proc getBitmapMask*(this: LCDBitmap): LCDBitmap = | |||
| privateAccess(PlaydateGraphics) | |||
| return LCDBitmap(resource: playdate.graphics.getBitmapMask(this.resource), free: false) # Who should manage this memory? Not clear. Not auto-managed right now. | |||
| return newUnmanagedBitmap(playdate.graphics.getBitmapMask(this.resource)) | |||
There was a problem hiding this comment.
LCDBitmap* playdate->graphics->getBitmapMask(LCDBitmap* bitmap);
Gets a mask image for the given bitmap, or returns NULL if the bitmap doesn’t have a mask layer. The returned image points to bitmap's data, so drawing into the mask image affects the source bitmap directly. The caller takes ownership of the returned LCDBitmap and is responsible for freeing it when it’s no longer in use.
I'd say this means the returned bitmap is managed
|
|
||
| proc `=copy`(a: var LCDBitmapObj, b: LCDBitmapObj) {.error.} | ||
|
|
||
| proc newUnmanagedBitmap(point: LCDBitmapPtr): auto = |
There was a problem hiding this comment.
Can you rename this to bitmapPointer. Very strong associations with a 2d point here.
Same for newManagedBitmap
| @@ -93,8 +93,8 @@ proc handler(event: PDSystemEvent, keycode: uint) {.raises: [].} = | |||
| font = try: playdate.graphics.newFont(FONT_PATH) except: nil | |||
There was a problem hiding this comment.
(not related to this file specifically)
Although we are not changing the API here, I'd still recommend targeting the dev branch for this PR so that we can track any new bugs to a specific release and have a sense of what is in the public release and what isn't
There was a problem hiding this comment.
You can change it by pressing the edit button next to the PR title and then using the dropdown
This reduces the number of small memory allocations that happens when working with bitmaps. Bitmaps are split into two categories: managed and unmanaged. Unmanaged bitmaps are passed around by copying pointers, managed bitmaps are passed around using nim object refs.