memoryBitmap.*

Type Library
Revision Release 2024.3703
Keywords memoryBitmap, bitmap
Platforms Android, iOS, macOS, Windows, tvOS
Sample https://github.com/coronalabs/plugins-sample-memoryBitmap

Overview

This plugin provides the ability to create and manipulate in-memory bitmaps.

Syntax

local memoryBitmap = require( "plugin.memoryBitmap" )

Functions

Types

Project Settings

To use this plugin, add an entry into the plugins table of build.settings. When added, the build server will integrate the plugin during the build phase.

settings =
{
    plugins =
    {
        ["plugin.memoryBitmap"] =
        {
            publisherId = "com.coronalabs"
        },
    },
}

Examples

Setting/Getting Pixel
local memoryBitmap = require( "plugin.memoryBitmap" )

-- Create bitmap texture
local tex = memoryBitmap.newTexture(
    {
        width = 100,
        height = 100,
        -- format = "rgba"  -- (default)
        -- format = "rgb"
        -- format = "mask"
    })

-- Create image using the bitmap texture
local bitmap = display.newImageRect( tex.filename, tex.baseDir, 100, 100 )
bitmap.x = display.contentCenterX
bitmap.y = display.contentCenterY

-- Set a pixel color in the bitmap
tex:setPixel( 10, 10, 1, 0, 0, 1 )  -- Set pixel at (10,10) to be red
-- tex:setPixel( 10, 10, {1,0,0,1} )  -- Same using table syntax for RGB+A color

-- Get a pixel color from the bitmap
print( tex:getPixel( 10, 10 ) )  --> 1 0 0 1

-- Submit texture to be updated
tex:invalidate()
Setting Multiple Pixels
local memoryBitmap = require( "plugin.memoryBitmap" )

-- Create bitmap texture
local tex = memoryBitmap.newTexture(
    {
        width = 100,
        height = 100,
        -- format = "rgba"  -- (default)
        -- format = "rgb"
        -- format = "mask"
    })

-- Create image using the bitmap texture
local bitmap = display.newImageRect( tex.filename, tex.baseDir, 100, 100 )
bitmap.x = display.contentCenterX
bitmap.y = display.contentCenterY

-- Loop through all pixels and set green channel to 1
for y = 1,tex.height do
    for x = 1,tex.width do
        tex:setPixel( x, y, nil, 1, nil, nil )
        tex:invalidate()
    end
end

-- If no more modifications are required, release the texture
tex:releaseSelf()