GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  ALLEGRO_LOCKED_REGION (3)

NAME

ALLEGRO_LOCKED_REGION - Allegro 5 API

CONTENTS

Synopsis
Description
See Also

SYNOPSIS

C]
#include <allegro5/allegro.h>

typedef struct ALLEGRO_LOCKED_REGION ALLEGRO_LOCKED_REGION; ]

DESCRIPTION

Users who wish to manually edit or read from a bitmap are required to lock it first. The ALLEGRO_LOCKED_REGION structure represents the locked region of the bitmap. This call will work with any bitmap, including memory bitmaps.
C]
typedef struct ALLEGRO_LOCKED_REGION {
    void *data;
    int format;
    int pitch;
    int pixel_size;
} ALLEGRO_LOCKED_REGION;
]

[bu] I]data] points to the leftmost pixel of the first row (row 0) of the locked region.
[bu] I]format] indicates the pixel format of the data.
[bu] I]pitch] gives the size in bytes of a single row (also known as the stride). The pitch may be greater than C]width * pixel_size] due to padding; this is not uncommon. It is also I]not] uncommon for the pitch to be negative (the bitmap may be upside down).
[bu] I]pixel_size] is the number of bytes used to represent a single pixel.

SEE ALSO

al_lock_bitmap(3), al_lock_bitmap_region(3), al_unlock_bitmap(3), ALLEGRO_PIXEL_FORMAT(3)

Search for    or go to Top of page |  Section 3 |  Main Index


Allegro reference manual ALLEGRO_LOCKED_REGION (3)

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.