libmonochrome/man/man3/ML_VRAM.3

60 lines
2.3 KiB
Groff

'\" t
.\" Title: ml_vram
.\" Author: Thomas "Cakeisalie5" Touhey <thomas@touhey.fr>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 07/18/2016
.\" Manual: libmonochrome
.\" Source: libmonochrome
.\" Language: English
.\"
.TH "ML_VRAM" "3" "07/18/2016" "libmonochrome" "libmonochrome"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ML_VRAM \- Video RAM and Display Driver management functions from libmonochrome
.SH "SYNOPSIS"
.sp
.nf
#include <monochrome\&.h>
char* ML_vram_address();
void ML_clear_vram();
void ML_clear_screen();
void ML_display_vram();
.fi
.SH "DESCRIPTION"
.sp
libmonochrome uses natively a double\-buffering technique : the user program draws on a working space, the VRAM, and when he finished drawing the frame, this frame is sent to the Display Driver so it can appear on the screen\&.
.sp
ML_vram_adress is a system call that returns the address of the VRAM allocated by the system\&. It is mainly meant for internal purposes, but if you want to use the VRAM directly, you can use it\&.
.sp
ML_clear_screen sends a bunch of zeros to the Display Driver so the screen content gets erased, but the VRAM stays as it is\&. ML_clear_vram does the opposite : it clears the VRAM content while leaving the screen\(cqs one\&.
.sp
ML_display_vram sends the VRAM content to the Display Driver, so it can appear on the screen\&.
.SH "SEE ALSO"
.sp
libmonochrome(3)
.SH "AUTHOR"
.PP
\fBThomas "Cakeisalie5" Touhey\fR <\&thomas@touhey\&.fr\&>
.RS 4
Author.
.RE