Bitwig Studio Control Surface API  5.0.11
Bitmap Interface Reference
+ Inheritance diagram for Bitmap:

Public Member Functions

int getWidth ()
 
int getHeight ()
 
BitmapFormat getFormat ()
 
MemoryBlock getMemoryBlock ()
 
void render (Renderer renderer)
 
void showDisplayWindow ()
 
void setDisplayWindowTitle (String title)
 
void saveToDiskAsPPM (String path)
 

Detailed Description

Represents a bitmap image which can be painted via render(Renderer).

Since
API version 7

Member Function Documentation

◆ getHeight()

int getHeight ( )

Returns the height

Implements Image.

◆ getWidth()

int getWidth ( )

Returns the width

Implements Image.

◆ render()

void render ( Renderer  renderer)

Call this method to start painting the bitmap. This method will take care of disposing allocated patterns during the rendering.

Since
API version 7

◆ saveToDiskAsPPM()

void saveToDiskAsPPM ( String  path)

Saves the image as a PPM file.

Parameters
paththe location of the target file.
Since
API version 7

◆ setDisplayWindowTitle()

void setDisplayWindowTitle ( String  title)

Updates the display window title.

Since
API version 7

◆ showDisplayWindow()

void showDisplayWindow ( )

Call this method to show a window which displays the bitmap. You should see this as a debug utility rather than a Control Surface API feature.

Since
API version 7

The documentation for this interface was generated from the following file: