Screen Module - LostShadowGD/lpp-3ds-docs GitHub Wiki

Screen.waitVblankStart

void Screen.waitVblankStart(void)

Wait Screen Refresh.

Sample usage:

Screen.waitVblankStart()

---

Screen.flip

void Screen.flip(void)

Flip screen (Needed for every Screen function).

Sample usage:

Screen.flip()

---

Screen.debugPrint

void Screen.debugPrint(int x, int y, string text, u32 color, Image_id screen_id, [Eye_id] eye)

Write a string on screen or image.

Sample usage:

Screen.debugPrint(0, 0, "Hello World", Color.new(255,255,255), TOP_SCREEN)

---

Screen.refresh

void Screen.refresh(void)

Refresh screen buffers.

Sample usage:

Screen.refresh()

---

Screen.clear

void Screen.clear(Image_id screen_id)

Clear screen.

Sample usage:

Screen.clear(TOP_SCREEN)

---

Screen.fillRect

void Screen.fillRect(int x1, int x2, int y1, int y2, u32 color, Image_id screen_id, [Eye_id] eye)

Draw a rectangle.

Sample usage:

Screen.fillRect(5, 20, 5, 40, Color.new(255,0,0), BOTTOM_SCREEN)

---

Screen.fillEmptyRect

void Screen.fillEmptyRect(int x1, int x2, int y1, int y2, u32 color, Image_id screen_id, [Eye_id] eye)

Draw a rectangular box.

Sample usage:

Screen.fillEmptyRect(5, 20, 5, 40, Color.new(255,0,0), BOTTOM_SCREEN)

---

Screen.drawLine

void Screen.drawLine(int x1, int x2, int y1, int y2, u32 color, Image_id screen_id, [Eye_id] eye)

Draw a line.

Sample usage:

Screen.drawLine(5, 20, 5, 40, Color.new(255,0,0), BOTTOM_SCREEN)

---

Screen.drawPixel

void Screen.drawPixel(int x, int y, u32 color, Image_id screen_id, [Eye_id] eye)

Draw a pixel.

Sample usage:

Screen.drawPixel(5, 5, Color.new(255,0,0), BOTTOM_SCREEN)

---

Screen.getPixel

u32 Screen.getPixel(int x, int y, Image_id screen_id, [Eye_id] eye)

Get the color of a pixel.

Sample usage:

Screen.getPixel(5, 5, BOTTOM_SCREEN)

---

Screen.loadImage

Image_id Screen.loadImage(string filename)

Load a BMP, PNG or JPG image file.

Sample usage:

bitmap = Screen.loadImage("/file.bmp")

---

Screen.drawImage

void Screen.drawImage(int x, int y, Image_id image, Image_id screen_id, [Eye_id] eye)

Draw an image.

Sample usage:

Screen.drawImage(10, 20, bitmap, TOP_SCREEN)

---

Screen.drawPartialImage

void Screen.drawPartialImage(int x, int y, int image_x, int image_y, int width, int height, Image_id image, Image_id screen_id, [Eye_id] eye)

Draw a part of an image.

Sample usage:

Screen.drawPartialImage(10, 20, 0, 0, 100, 100, bitmap, BOTTOM_SCREEN)

---

Screen.getImageWidth

int Screen.getImageWidth(Image_id image)

Get width of an image.

Sample usage:

width = Screen.getImageWidth(bitmap_file)

---

Screen.getImageHeight

int Screen.getImageHeight(Image_id image)

Get height of an image.

Sample usage:

height = Screen.getImageHeight(bitmap_file)

---

Screen.flipImage

void Screen.flipImage(Image_id source, Image_id destination)

Flip an image.

Sample usage:

Screen.flipImage(image, flipped_image)

---

Screen.createImage

Image_id Screen.createImage(int width, int height, u32 color)

Create an empty image.

Sample usage:

image = Screen.createImage(10, 10, Color.new(255,255,255))

---

Screen.freeImage

void Screen.freeImage(Image_id image)

Delete an image from memory.

Sample usage:

Screen.freeImage(image)

---

Screen.saveImage

void Screen.saveImage(Image_id image, string file, bool jpg_compression)

Save an image as BMP/JPG file.

Sample usage:

Screen.saveImage(image, "/file.bmp", false)

---

Screen.enable3D

void Screen.enable3D(void)

Enable stereoscopic 3D.

Sample usage:

Screen.enable3D()

---

Screen.disable3D

void Screen.disable3D(void)

Disable stereoscopic 3D.

Sample usage:

Screen.disable3D()

---

Screen.get3DLevel

float Screen.get3DLevel(void)

Get current stereoscopic 3D slide level.

Sample usage:

lvl_3d = Screen.get3DLevel()