pxt-calliope/libs/microbit/images.ts

//% color=45 weight=31
namespace images {
    /**
     * Creates an image that fits on the LED screen.
     */
    //% weight=75 help=images/create-image
    //% blockId=device_build_image block="create image" imageLiteral=1
    export function createImage(leds: string): Image {
        return null;
    }

    /**
     * Creates an image with 2 frames.
     */
    //% weight=74 help=images/create-big-image
    //% blockId=device_build_big_image block="create big image" imageLiteral=2
    export function createBigImage(leds: string): Image {
        return null;
    }
    
    export class Image {
        /**
         * Shows an frame from the image at offset ``x offset``.
         * @param xOffset TODO
         */
        //% help=images/show-image weight=80 shim=micro_bit::showImage
        //% blockId=device_show_image_offset block="show image %sprite|at offset %offset" blockGap=8
        public showImage(xOffset: number = 0): void {}
        
        /**
         * Scrolls an image .
         * @param frameOffset x offset moved on each animation step, eg: 5, 1, -1
         * @param interval time between each animation step in milli seconds, eg: 200
         */
        //% help=images/show-image weight=79 shim=micro_bit::scrollImage async
        //% blockId=device_scroll_image block="scroll image %sprite|with offset %frameoffset|and interval (ms) %delay" blockGap=8
        public scrollImage(frameOffset: number = 0, interval : number = 200) {            
        }


        /**
         * Plots the image at a given column to the screen
         */            
        public plotImage(xOffset: number = 0): void {}

        /**
         * Sets all pixels off.
         */
        public clear(): void {}

        /**
         * Sets a specific pixel brightness at a given position
         */
        public setPixelBrightness(x: number, y: number, v: number): void {}

        /**
         * Gets the pixel brightness ([0..255]) at a given position
         */
        public pixelBrightness(x: number, y: number): number {
            return 0;
        }
    }
}