kekw
This commit is contained in:
Camille Chauvet
93
minilibx-linux/man/man1/mlx.1
Normal file
93
minilibx-linux/man/man1/mlx.1
Normal file
@ -0,0 +1,93 @@
|
||||
.TH MiniLibX 3 "September 19, 2002"
|
||||
.SH NAME
|
||||
MiniLibX - Simple X-Window Interface Library for students
|
||||
.SH SYNOPSYS
|
||||
#include <mlx.h>
|
||||
|
||||
.nf
|
||||
.I void *
|
||||
.fi
|
||||
.B mlx_init
|
||||
();
|
||||
|
||||
.SH DESCRIPTION
|
||||
MiniLibX is an easy way to create graphical software,
|
||||
without any X-Window programming knowledge. It provides
|
||||
simple window creation, a drawing tool, image and basic events
|
||||
management.
|
||||
|
||||
.SH X-WINDOW CONCEPT
|
||||
|
||||
X-Window is a network-oriented graphical system for Unix.
|
||||
It is based on two main parts:
|
||||
.br
|
||||
On one side, your software wants to draw something on the screen and/or
|
||||
get keyboard & mouse entries.
|
||||
.br
|
||||
On the other side, the X-Server manages the screen, keyboard and mouse
|
||||
(It is often refered to as a "display").
|
||||
.br
|
||||
A network connection must be established between these two entities to send
|
||||
drawing orders (from the software to the X-Server), and keyboard/mouse
|
||||
events (from the X-Server to the software).
|
||||
|
||||
.SH INCLUDE FILE
|
||||
.B mlx.h
|
||||
should be included for a correct use of the MiniLibX API.
|
||||
It only contains function prototypes, no structure is needed.
|
||||
|
||||
.SH LIBRARY FUNCTIONS
|
||||
.P
|
||||
First of all, you need to initialize the connection
|
||||
between your software and the display.
|
||||
Once this connection is established, you'll be able to
|
||||
use other MiniLibX functions to send the X-Server messages,
|
||||
like "I want to draw a yellow pixel in this window" or "did the
|
||||
user hit a key?".
|
||||
.P
|
||||
The
|
||||
.B mlx_init
|
||||
function will create this connection. No parameters are needed, ant it will
|
||||
return a
|
||||
.I "void *"
|
||||
identifier, used for further calls to the library routines.
|
||||
.P
|
||||
All other MiniLibX functions are described in the following man pages:
|
||||
|
||||
.TP 20
|
||||
.B mlx_new_window
|
||||
: manage windows
|
||||
.TP 20
|
||||
.B mlx_pixel_put
|
||||
: draw inside window
|
||||
.TP 20
|
||||
.B mlx_new_image
|
||||
: manipulate images
|
||||
.TP 20
|
||||
.B mlx_loop
|
||||
: handle keyboard or mouse events
|
||||
|
||||
.SH LINKING MiniLibX
|
||||
To use MiniLibX functions, you'll need to link
|
||||
your software with several libraries, including the MiniLibX library itself.
|
||||
To do this, simply add the following arguments at linking time:
|
||||
|
||||
.B -lmlx -lXext -lX11
|
||||
|
||||
You may also need to specify the path to these libraries, using
|
||||
the
|
||||
.B -L
|
||||
flag.
|
||||
|
||||
|
||||
.SH RETURN VALUES
|
||||
If
|
||||
.B mlx_init()
|
||||
fails to set up the connection to the X server, it will return NULL, otherwise
|
||||
a non-null pointer is returned as a connection identifier.
|
||||
|
||||
.SH SEE ALSO
|
||||
mlx_new_window(3), mlx_pixel_put(3), mlx_new_image(3), mlx_loop(3)
|
||||
|
||||
.SH AUTHOR
|
||||
Copyright ol@ - 2002-2014 - Olivier Crouzet
|
||||
141
minilibx-linux/man/man1/mlx_loop.1
Normal file
141
minilibx-linux/man/man1/mlx_loop.1
Normal file
@ -0,0 +1,141 @@
|
||||
.TH MiniLibX 3 "September 19, 2002"
|
||||
.SH NAME
|
||||
MiniLibX - Handle events
|
||||
.SH SYNOPSYS
|
||||
|
||||
.nf
|
||||
.I int
|
||||
.fi
|
||||
.B mlx_loop
|
||||
(
|
||||
.I void *mlx_ptr
|
||||
);
|
||||
|
||||
.nf
|
||||
.I int
|
||||
.fi
|
||||
.B mlx_key_hook
|
||||
(
|
||||
.I void *win_ptr, int (*funct_ptr)(), void *param
|
||||
);
|
||||
|
||||
.nf
|
||||
.I int
|
||||
.fi
|
||||
.B mlx_mouse_hook
|
||||
(
|
||||
.I void *win_ptr, int (*funct_ptr)(), void *param
|
||||
);
|
||||
|
||||
.nf
|
||||
.I int
|
||||
.fi
|
||||
.B mlx_expose_hook
|
||||
(
|
||||
.I void *win_ptr, int (*funct_ptr)(), void *param
|
||||
);
|
||||
|
||||
.nf
|
||||
.I int
|
||||
.fi
|
||||
.B mlx_loop_hook
|
||||
(
|
||||
.I void *mlx_ptr, int (*funct_ptr)(), void *param
|
||||
);
|
||||
|
||||
.SH X-WINDOW EVENTS
|
||||
|
||||
The X-Window system is bi-directionnal. On one hand, the program sends orders to
|
||||
the screen to display pixels, images, and so on. On the other hand,
|
||||
it can get information from the keyboard and mouse associated to
|
||||
the screen. To do so, the program receives "events" from the keyboard or the
|
||||
mouse.
|
||||
|
||||
.SH DESCRIPTION
|
||||
|
||||
To receive events, you must use
|
||||
.B mlx_loop
|
||||
(). This function never returns. It is an infinite loop that waits for
|
||||
an event, and then calls a user-defined function associated with this event.
|
||||
A single parameter is needed, the connection identifier
|
||||
.I mlx_ptr
|
||||
(see the
|
||||
.B mlx manual).
|
||||
|
||||
You can assign different functions to the three following events:
|
||||
.br
|
||||
- A key is pressed
|
||||
.br
|
||||
- The mouse button is pressed
|
||||
.br
|
||||
- A part of the window should be re-drawn
|
||||
(this is called an "expose" event, and it is your program's job to handle it).
|
||||
.br
|
||||
|
||||
Each window can define a different function for the same event.
|
||||
|
||||
The three functions
|
||||
.B mlx_key_hook
|
||||
(),
|
||||
.B mlx_mouse_hook
|
||||
() and
|
||||
.B mlx_expose_hook
|
||||
() work exactly the same way.
|
||||
.I funct_ptr
|
||||
is a pointer to the function you want to be called
|
||||
when an event occurs. This assignment is specific to the window defined by the
|
||||
.I win_ptr
|
||||
identifier. The
|
||||
.I param
|
||||
adress will be passed to the function everytime it is called, and should be
|
||||
used to store the parameters it might need.
|
||||
|
||||
The syntax for the
|
||||
.B mlx_loop_hook
|
||||
() function is identical to the previous ones, but the given function will be
|
||||
called when no event occurs.
|
||||
|
||||
When it catches an event, the MiniLibX calls the corresponding function
|
||||
with fixed parameters:
|
||||
.nf
|
||||
|
||||
expose_hook(void *param);
|
||||
key_hook(int keycode,void *param);
|
||||
mouse_hook(int button,int x,int y,void *param);
|
||||
loop_hook(void *param);
|
||||
|
||||
.fi
|
||||
These function names are arbitrary. They here are used to distinguish
|
||||
parameters according to the event. These functions are NOT part of the
|
||||
MiniLibX.
|
||||
|
||||
.I param
|
||||
is the address specified in the mlx_*_hook calls. This address is never
|
||||
used nor modified by the MiniLibX. On key and mouse events, additional
|
||||
information is passed:
|
||||
.I keycode
|
||||
tells you which key is pressed (look for the X11 include file "keysymdef.h"),
|
||||
(
|
||||
.I x
|
||||
,
|
||||
.I y
|
||||
) are the coordinates of the mouse click in the window, and
|
||||
.I button
|
||||
tells you which mouse button was pressed.
|
||||
|
||||
.SH GOING FURTHER WITH EVENTS
|
||||
The MiniLibX provides a much generic access to all X-Window events. The
|
||||
.I mlx.h
|
||||
include define
|
||||
.B mlx_hook()
|
||||
in the same manner mlx_*_hook functions work. The event and mask values
|
||||
will be taken from the X11 include file "X.h".
|
||||
|
||||
See source code of mlx_int_param_event.c to find out how the MiniLibX will
|
||||
call your own function for a specific event.
|
||||
|
||||
.SH SEE ALSO
|
||||
mlx(3), mlx_new_window(3), mlx_pixel_put(3), mlx_new_image(3)
|
||||
|
||||
.SH AUTHOR
|
||||
Copyright ol@ - 2002-2014 - Olivier Crouzet
|
||||
192
minilibx-linux/man/man1/mlx_new_image.1
Normal file
192
minilibx-linux/man/man1/mlx_new_image.1
Normal file
@ -0,0 +1,192 @@
|
||||
.TH MiniLibX 3 "September 19, 2002"
|
||||
.SH NAME
|
||||
MiniLibX - Manipulating images
|
||||
.SH SYNOPSYS
|
||||
|
||||
.nf
|
||||
.I void *
|
||||
.fi
|
||||
.B mlx_new_image
|
||||
(
|
||||
.I void *mlx_ptr, int width, int height
|
||||
);
|
||||
|
||||
.nf
|
||||
.I char *
|
||||
.fi
|
||||
.B mlx_get_data_addr
|
||||
(
|
||||
.I void *img_ptr, int *bits_per_pixel, int *size_line, int *endian
|
||||
);
|
||||
|
||||
.nf
|
||||
.I int
|
||||
.fi
|
||||
.B mlx_put_image_to_window
|
||||
(
|
||||
.I void *mlx_ptr, void *win_ptr, void *img_ptr, int x, int y
|
||||
);
|
||||
|
||||
.nf
|
||||
.I unsigned int
|
||||
.fi
|
||||
.B mlx_get_color_value
|
||||
(
|
||||
.I void *mlx_ptr, int color
|
||||
);
|
||||
|
||||
.nf
|
||||
.I void *
|
||||
.fi
|
||||
.B mlx_xpm_to_image
|
||||
(
|
||||
.I void *mlx_ptr, char **xpm_data, int *width, int *height
|
||||
);
|
||||
|
||||
.nf
|
||||
.I void *
|
||||
.fi
|
||||
.B mlx_xpm_file_to_image
|
||||
(
|
||||
.I void *mlx_ptr, char *filename, int *width, int *height
|
||||
);
|
||||
|
||||
.nf
|
||||
.I int
|
||||
.fi
|
||||
.B mlx_destroy_image
|
||||
(
|
||||
.I void *mlx_ptr, void *img_ptr
|
||||
);
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
|
||||
.B mlx_new_image
|
||||
() creates a new image in memory. It returns a
|
||||
.I void *
|
||||
identifier needed to manipulate this image later. It only needs
|
||||
the size of the image to be created, using the
|
||||
.I width
|
||||
and
|
||||
.I height
|
||||
parameters, and the
|
||||
.I mlx_ptr
|
||||
connection identifier (see the
|
||||
.B mlx
|
||||
manual).
|
||||
|
||||
The user can draw inside the image (see below), and
|
||||
can dump the image inside a specified window at any time to
|
||||
display it on the screen. This is done using
|
||||
.B mlx_put_image_to_window
|
||||
(). Three identifiers are needed here, for the connection to the
|
||||
display, the window to use, and the image (respectively
|
||||
.I mlx_ptr
|
||||
,
|
||||
.I win_ptr
|
||||
and
|
||||
.I img_ptr
|
||||
). The (
|
||||
.I x
|
||||
,
|
||||
.I y
|
||||
) coordinates define where the image should be placed in the window.
|
||||
|
||||
.B mlx_get_data_addr
|
||||
() returns information about the created image, allowing a user
|
||||
to modify it later. The
|
||||
.I img_ptr
|
||||
parameter specifies the image to use. The three next parameters should
|
||||
be the addresses of three different valid integers.
|
||||
.I bits_per_pixel
|
||||
will be filled with the number of bits needed to represent a pixel color
|
||||
(also called the depth of the image).
|
||||
.I size_line
|
||||
is the number of bytes used to store one line of the image in memory.
|
||||
This information is needed to move from one line to another in the image.
|
||||
.I endian
|
||||
tells you wether the pixel color in the image needs to be stored in
|
||||
little endian (
|
||||
.I endian
|
||||
== 0), or big endian (
|
||||
.I endian
|
||||
== 1).
|
||||
|
||||
.B mlx_get_data_addr
|
||||
returns a
|
||||
.I char *
|
||||
address that represents the begining of the memory area where the image
|
||||
is stored. From this adress, the first
|
||||
.I bits_per_pixel
|
||||
bits represent the color of the first pixel in the first line of
|
||||
the image. The second group of
|
||||
.I bits_per_pixel
|
||||
bits represent the second pixel of the first line, and so on.
|
||||
Add
|
||||
.I size_line
|
||||
to the adress to get the begining of the second line. You can reach any
|
||||
pixels of the image that way.
|
||||
|
||||
.B mlx_destroy_image
|
||||
destroys the given image (
|
||||
.I img_ptr
|
||||
).
|
||||
|
||||
.SH STORING COLOR INSIDE IMAGES
|
||||
|
||||
Depending on the display, the number of bits used to store a pixel color
|
||||
can change. The user usually represents a color in RGB mode, using
|
||||
one byte for each component (see
|
||||
.B mlx_pixel_put
|
||||
manual). This must be translated to fit the
|
||||
.I bits_per_pixel
|
||||
requirement of the image, and make the color understandable to the X-Server.
|
||||
That is the purpose of the
|
||||
.B mlx_get_color_value
|
||||
() function. It takes a standard RGB
|
||||
.I color
|
||||
parameter, and returns an
|
||||
.I unsigned int
|
||||
value.
|
||||
The
|
||||
.I bits_per_pixel
|
||||
least significant bits of this value can be stored in the image.
|
||||
|
||||
Keep in mind that the least significant bits position depends on the local
|
||||
computer's endian. If the endian of the image (in fact the endian of
|
||||
the X-Server's computer) differs from the local endian, then the value should
|
||||
be transformed before being used.
|
||||
|
||||
.SH XPM IMAGES
|
||||
|
||||
The
|
||||
.B mlx_xpm_to_image
|
||||
() and
|
||||
.B mlx_xpm_file_to_image
|
||||
() functions will create a new image the same way.
|
||||
They will fill it using the specified
|
||||
.I xpm_data
|
||||
or
|
||||
.I filename
|
||||
, depending on which function is used.
|
||||
Note that MiniLibX does not use the standard
|
||||
Xpm library to deal with xpm images. You may not be able to
|
||||
read all types of xpm images. It however handles transparency.
|
||||
|
||||
.SH RETURN VALUES
|
||||
The three functions that create images,
|
||||
.B mlx_new_image()
|
||||
,
|
||||
.B mlx_xpm_to_image()
|
||||
and
|
||||
.B mlx_xpm_file_to_image()
|
||||
, will return NULL if an error occurs. Otherwise they return a non-null pointer
|
||||
as an image identifier.
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
mlx(3), mlx_new_window(3), mlx_pixel_put(3), mlx_loop(3)
|
||||
|
||||
.SH AUTHOR
|
||||
Copyright ol@ - 2002-2014 - Olivier Crouzet
|
||||
79
minilibx-linux/man/man1/mlx_new_window.1
Normal file
79
minilibx-linux/man/man1/mlx_new_window.1
Normal file
@ -0,0 +1,79 @@
|
||||
.TH MiniLibX 3 "September 19, 2002"
|
||||
.SH NAME
|
||||
MiniLibX - Managing windows
|
||||
.SH SYNOPSYS
|
||||
|
||||
.nf
|
||||
.I void *
|
||||
.fi
|
||||
.B mlx_new_window
|
||||
(
|
||||
.I void *mlx_ptr, int size_x, int size_y, char *title
|
||||
);
|
||||
|
||||
.nf
|
||||
.I int
|
||||
.fi
|
||||
.B mlx_clear_window
|
||||
(
|
||||
.I void *mlx_ptr, void *win_ptr
|
||||
);
|
||||
|
||||
.nf
|
||||
.I int
|
||||
.fi
|
||||
.B mlx_destroy_window
|
||||
(
|
||||
.I void *mlx_ptr, void *win_ptr
|
||||
);
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
The
|
||||
.B mlx_new_window
|
||||
() function creates a new window on the screen, using the
|
||||
.I size_x
|
||||
and
|
||||
.I size_y
|
||||
parameters to determine its size, and
|
||||
.I title
|
||||
as the text that should be displayed in the window's title bar.
|
||||
The
|
||||
.I mlx_ptr
|
||||
parameter is the connection identifier returned by
|
||||
.B mlx_init
|
||||
() (see the
|
||||
.B mlx
|
||||
man page).
|
||||
.B mlx_new_window
|
||||
() returns a
|
||||
.I void *
|
||||
window identifier that can be used by other MiniLibX calls.
|
||||
Note that the MiniLibX
|
||||
can handle an arbitrary number of separate windows.
|
||||
|
||||
.B mlx_clear_window
|
||||
() and
|
||||
.B mlx_destroy_window
|
||||
() respectively clear (in black) and destroy the given window. They both have
|
||||
the same parameters:
|
||||
.I mlx_ptr
|
||||
is the screen connection identifier, and
|
||||
.I win_ptr
|
||||
is a window identifier.
|
||||
|
||||
.SH RETURN VALUES
|
||||
If
|
||||
.B mlx_new_window()
|
||||
fails to create a new window (for wathever reason), it will return NULL,
|
||||
otherwise a non-null pointer is returned as a window identifier.
|
||||
.B mlx_clear_window
|
||||
and
|
||||
.B mlx_destroy_window
|
||||
right now return nothing.
|
||||
|
||||
.SH SEE ALSO
|
||||
mlx(3), mlx_pixel_put(3), mlx_new_image(3), mlx_loop(3)
|
||||
|
||||
.SH AUTHOR
|
||||
Copyright ol@ - 2002-2014 - Olivier Crouzet
|
||||
84
minilibx-linux/man/man1/mlx_pixel_put.1
Normal file
84
minilibx-linux/man/man1/mlx_pixel_put.1
Normal file
@ -0,0 +1,84 @@
|
||||
.TH MiniLibX 3 "September 19, 2002"
|
||||
.SH NAME
|
||||
MiniLibX - Drawing inside windows
|
||||
.SH SYNOPSYS
|
||||
|
||||
.nf
|
||||
.I int
|
||||
.fi
|
||||
.B mlx_pixel_put
|
||||
(
|
||||
.I void *mlx_ptr, void *win_ptr, int x, int y, int color
|
||||
);
|
||||
|
||||
.nf
|
||||
.I int
|
||||
.fi
|
||||
.B mlx_string_put
|
||||
(
|
||||
.I void *mlx_ptr, void *win_ptr, int x, int y, int color, char *string
|
||||
);
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
The
|
||||
.B mlx_pixel_put
|
||||
() function draws a defined pixel in the window
|
||||
.I win_ptr
|
||||
using the (
|
||||
.I x
|
||||
,
|
||||
.I y
|
||||
) coordinates, and the specified
|
||||
.I color
|
||||
\&. The origin (0,0) is the upper left corner of the window, the x and y axis
|
||||
respectively pointing right and down. The connection
|
||||
identifier,
|
||||
.I mlx_ptr
|
||||
, is needed (see the
|
||||
.B mlx
|
||||
man page).
|
||||
|
||||
Parameters for
|
||||
.B mlx_string_put
|
||||
() have the same meaning. Instead of a simple pixel, the specified
|
||||
.I string
|
||||
will be displayed at (
|
||||
.I x
|
||||
,
|
||||
.I y
|
||||
).
|
||||
|
||||
In both functions, it is impossible to display anything outside the
|
||||
specified window, nor display in another window in front of the selected one.
|
||||
|
||||
.SH COLOR MANAGEMENT
|
||||
The
|
||||
.I color
|
||||
parameter has an integer type. The displayed color needs to be encoded
|
||||
in this integer, following a defined scheme. All displayable colors
|
||||
can be split in 3 basic colors: red, green and blue. Three associated
|
||||
values, in the 0-255 range, represent how much of each color is mixed up
|
||||
to create the original color. Theses three values must be set inside the
|
||||
integer to display the right color. The three least significant bytes of
|
||||
this integer are filled as shown in the picture below:
|
||||
|
||||
.TS
|
||||
allbox;
|
||||
c s s s s
|
||||
r c c c c.
|
||||
Color Integer
|
||||
Interpretation \[*a] R G B
|
||||
Bit numbers 31..24 23..16 15..8 7..0
|
||||
.TE
|
||||
|
||||
While filling the integer, make sure you avoid endian problems. Remember
|
||||
that the "blue" byte should always be the least significant one.
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
mlx(3), mlx_new_window(3), mlx_new_image(3), mlx_loop(3)
|
||||
|
||||
|
||||
.SH AUTHOR
|
||||
Copyright ol@ - 2002-2014 - Olivier Crouzet
|
||||
93
minilibx-linux/man/man3/mlx.3
Normal file
93
minilibx-linux/man/man3/mlx.3
Normal file
@ -0,0 +1,93 @@
|
||||
.TH MiniLibX 3 "September 19, 2002"
|
||||
.SH NAME
|
||||
MiniLibX - Simple X-Window Interface Library for students
|
||||
.SH SYNOPSYS
|
||||
#include <mlx.h>
|
||||
|
||||
.nf
|
||||
.I void *
|
||||
.fi
|
||||
.B mlx_init
|
||||
();
|
||||
|
||||
.SH DESCRIPTION
|
||||
MiniLibX is an easy way to create graphical software,
|
||||
without any X-Window programming knowledge. It provides
|
||||
simple window creation, a drawing tool, image and basic events
|
||||
management.
|
||||
|
||||
.SH X-WINDOW CONCEPT
|
||||
|
||||
X-Window is a network-oriented graphical system for Unix.
|
||||
It is based on two main parts:
|
||||
.br
|
||||
On one side, your software wants to draw something on the screen and/or
|
||||
get keyboard & mouse entries.
|
||||
.br
|
||||
On the other side, the X-Server manages the screen, keyboard and mouse
|
||||
(It is often refered to as a "display").
|
||||
.br
|
||||
A network connection must be established between these two entities to send
|
||||
drawing orders (from the software to the X-Server), and keyboard/mouse
|
||||
events (from the X-Server to the software).
|
||||
|
||||
.SH INCLUDE FILE
|
||||
.B mlx.h
|
||||
should be included for a correct use of the MiniLibX API.
|
||||
It only contains function prototypes, no structure is needed.
|
||||
|
||||
.SH LIBRARY FUNCTIONS
|
||||
.P
|
||||
First of all, you need to initialize the connection
|
||||
between your software and the display.
|
||||
Once this connection is established, you'll be able to
|
||||
use other MiniLibX functions to send the X-Server messages,
|
||||
like "I want to draw a yellow pixel in this window" or "did the
|
||||
user hit a key?".
|
||||
.P
|
||||
The
|
||||
.B mlx_init
|
||||
function will create this connection. No parameters are needed, ant it will
|
||||
return a
|
||||
.I "void *"
|
||||
identifier, used for further calls to the library routines.
|
||||
.P
|
||||
All other MiniLibX functions are described in the following man pages:
|
||||
|
||||
.TP 20
|
||||
.B mlx_new_window
|
||||
: manage windows
|
||||
.TP 20
|
||||
.B mlx_pixel_put
|
||||
: draw inside window
|
||||
.TP 20
|
||||
.B mlx_new_image
|
||||
: manipulate images
|
||||
.TP 20
|
||||
.B mlx_loop
|
||||
: handle keyboard or mouse events
|
||||
|
||||
.SH LINKING MiniLibX
|
||||
To use MiniLibX functions, you'll need to link
|
||||
your software with several libraries, including the MiniLibX library itself.
|
||||
To do this, simply add the following arguments at linking time:
|
||||
|
||||
.B -lmlx -lXext -lX11
|
||||
|
||||
You may also need to specify the path to these libraries, using
|
||||
the
|
||||
.B -L
|
||||
flag.
|
||||
|
||||
|
||||
.SH RETURN VALUES
|
||||
If
|
||||
.B mlx_init()
|
||||
fails to set up the connection to the X server, it will return NULL, otherwise
|
||||
a non-null pointer is returned as a connection identifier.
|
||||
|
||||
.SH SEE ALSO
|
||||
mlx_new_window(3), mlx_pixel_put(3), mlx_new_image(3), mlx_loop(3)
|
||||
|
||||
.SH AUTHOR
|
||||
Copyright ol@ - 2002-2014 - Olivier Crouzet
|
||||
141
minilibx-linux/man/man3/mlx_loop.3
Normal file
141
minilibx-linux/man/man3/mlx_loop.3
Normal file
@ -0,0 +1,141 @@
|
||||
.TH MiniLibX 3 "September 19, 2002"
|
||||
.SH NAME
|
||||
MiniLibX - Handle events
|
||||
.SH SYNOPSYS
|
||||
|
||||
.nf
|
||||
.I int
|
||||
.fi
|
||||
.B mlx_loop
|
||||
(
|
||||
.I void *mlx_ptr
|
||||
);
|
||||
|
||||
.nf
|
||||
.I int
|
||||
.fi
|
||||
.B mlx_key_hook
|
||||
(
|
||||
.I void *win_ptr, int (*funct_ptr)(), void *param
|
||||
);
|
||||
|
||||
.nf
|
||||
.I int
|
||||
.fi
|
||||
.B mlx_mouse_hook
|
||||
(
|
||||
.I void *win_ptr, int (*funct_ptr)(), void *param
|
||||
);
|
||||
|
||||
.nf
|
||||
.I int
|
||||
.fi
|
||||
.B mlx_expose_hook
|
||||
(
|
||||
.I void *win_ptr, int (*funct_ptr)(), void *param
|
||||
);
|
||||
|
||||
.nf
|
||||
.I int
|
||||
.fi
|
||||
.B mlx_loop_hook
|
||||
(
|
||||
.I void *mlx_ptr, int (*funct_ptr)(), void *param
|
||||
);
|
||||
|
||||
.SH X-WINDOW EVENTS
|
||||
|
||||
The X-Window system is bi-directionnal. On one hand, the program sends orders to
|
||||
the screen to display pixels, images, and so on. On the other hand,
|
||||
it can get information from the keyboard and mouse associated to
|
||||
the screen. To do so, the program receives "events" from the keyboard or the
|
||||
mouse.
|
||||
|
||||
.SH DESCRIPTION
|
||||
|
||||
To receive events, you must use
|
||||
.B mlx_loop
|
||||
(). This function never returns. It is an infinite loop that waits for
|
||||
an event, and then calls a user-defined function associated with this event.
|
||||
A single parameter is needed, the connection identifier
|
||||
.I mlx_ptr
|
||||
(see the
|
||||
.B mlx manual).
|
||||
|
||||
You can assign different functions to the three following events:
|
||||
.br
|
||||
- A key is pressed
|
||||
.br
|
||||
- The mouse button is pressed
|
||||
.br
|
||||
- A part of the window should be re-drawn
|
||||
(this is called an "expose" event, and it is your program's job to handle it).
|
||||
.br
|
||||
|
||||
Each window can define a different function for the same event.
|
||||
|
||||
The three functions
|
||||
.B mlx_key_hook
|
||||
(),
|
||||
.B mlx_mouse_hook
|
||||
() and
|
||||
.B mlx_expose_hook
|
||||
() work exactly the same way.
|
||||
.I funct_ptr
|
||||
is a pointer to the function you want to be called
|
||||
when an event occurs. This assignment is specific to the window defined by the
|
||||
.I win_ptr
|
||||
identifier. The
|
||||
.I param
|
||||
adress will be passed to the function everytime it is called, and should be
|
||||
used to store the parameters it might need.
|
||||
|
||||
The syntax for the
|
||||
.B mlx_loop_hook
|
||||
() function is identical to the previous ones, but the given function will be
|
||||
called when no event occurs.
|
||||
|
||||
When it catches an event, the MiniLibX calls the corresponding function
|
||||
with fixed parameters:
|
||||
.nf
|
||||
|
||||
expose_hook(void *param);
|
||||
key_hook(int keycode,void *param);
|
||||
mouse_hook(int button,int x,int y,void *param);
|
||||
loop_hook(void *param);
|
||||
|
||||
.fi
|
||||
These function names are arbitrary. They here are used to distinguish
|
||||
parameters according to the event. These functions are NOT part of the
|
||||
MiniLibX.
|
||||
|
||||
.I param
|
||||
is the address specified in the mlx_*_hook calls. This address is never
|
||||
used nor modified by the MiniLibX. On key and mouse events, additional
|
||||
information is passed:
|
||||
.I keycode
|
||||
tells you which key is pressed (look for the X11 include file "keysymdef.h"),
|
||||
(
|
||||
.I x
|
||||
,
|
||||
.I y
|
||||
) are the coordinates of the mouse click in the window, and
|
||||
.I button
|
||||
tells you which mouse button was pressed.
|
||||
|
||||
.SH GOING FURTHER WITH EVENTS
|
||||
The MiniLibX provides a much generic access to all X-Window events. The
|
||||
.I mlx.h
|
||||
include define
|
||||
.B mlx_hook()
|
||||
in the same manner mlx_*_hook functions work. The event and mask values
|
||||
will be taken from the X11 include file "X.h".
|
||||
|
||||
See source code of mlx_int_param_event.c to find out how the MiniLibX will
|
||||
call your own function for a specific event.
|
||||
|
||||
.SH SEE ALSO
|
||||
mlx(3), mlx_new_window(3), mlx_pixel_put(3), mlx_new_image(3)
|
||||
|
||||
.SH AUTHOR
|
||||
Copyright ol@ - 2002-2014 - Olivier Crouzet
|
||||
192
minilibx-linux/man/man3/mlx_new_image.3
Normal file
192
minilibx-linux/man/man3/mlx_new_image.3
Normal file
@ -0,0 +1,192 @@
|
||||
.TH MiniLibX 3 "September 19, 2002"
|
||||
.SH NAME
|
||||
MiniLibX - Manipulating images
|
||||
.SH SYNOPSYS
|
||||
|
||||
.nf
|
||||
.I void *
|
||||
.fi
|
||||
.B mlx_new_image
|
||||
(
|
||||
.I void *mlx_ptr, int width, int height
|
||||
);
|
||||
|
||||
.nf
|
||||
.I char *
|
||||
.fi
|
||||
.B mlx_get_data_addr
|
||||
(
|
||||
.I void *img_ptr, int *bits_per_pixel, int *size_line, int *endian
|
||||
);
|
||||
|
||||
.nf
|
||||
.I int
|
||||
.fi
|
||||
.B mlx_put_image_to_window
|
||||
(
|
||||
.I void *mlx_ptr, void *win_ptr, void *img_ptr, int x, int y
|
||||
);
|
||||
|
||||
.nf
|
||||
.I unsigned int
|
||||
.fi
|
||||
.B mlx_get_color_value
|
||||
(
|
||||
.I void *mlx_ptr, int color
|
||||
);
|
||||
|
||||
.nf
|
||||
.I void *
|
||||
.fi
|
||||
.B mlx_xpm_to_image
|
||||
(
|
||||
.I void *mlx_ptr, char **xpm_data, int *width, int *height
|
||||
);
|
||||
|
||||
.nf
|
||||
.I void *
|
||||
.fi
|
||||
.B mlx_xpm_file_to_image
|
||||
(
|
||||
.I void *mlx_ptr, char *filename, int *width, int *height
|
||||
);
|
||||
|
||||
.nf
|
||||
.I int
|
||||
.fi
|
||||
.B mlx_destroy_image
|
||||
(
|
||||
.I void *mlx_ptr, void *img_ptr
|
||||
);
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
|
||||
.B mlx_new_image
|
||||
() creates a new image in memory. It returns a
|
||||
.I void *
|
||||
identifier needed to manipulate this image later. It only needs
|
||||
the size of the image to be created, using the
|
||||
.I width
|
||||
and
|
||||
.I height
|
||||
parameters, and the
|
||||
.I mlx_ptr
|
||||
connection identifier (see the
|
||||
.B mlx
|
||||
manual).
|
||||
|
||||
The user can draw inside the image (see below), and
|
||||
can dump the image inside a specified window at any time to
|
||||
display it on the screen. This is done using
|
||||
.B mlx_put_image_to_window
|
||||
(). Three identifiers are needed here, for the connection to the
|
||||
display, the window to use, and the image (respectively
|
||||
.I mlx_ptr
|
||||
,
|
||||
.I win_ptr
|
||||
and
|
||||
.I img_ptr
|
||||
). The (
|
||||
.I x
|
||||
,
|
||||
.I y
|
||||
) coordinates define where the image should be placed in the window.
|
||||
|
||||
.B mlx_get_data_addr
|
||||
() returns information about the created image, allowing a user
|
||||
to modify it later. The
|
||||
.I img_ptr
|
||||
parameter specifies the image to use. The three next parameters should
|
||||
be the addresses of three different valid integers.
|
||||
.I bits_per_pixel
|
||||
will be filled with the number of bits needed to represent a pixel color
|
||||
(also called the depth of the image).
|
||||
.I size_line
|
||||
is the number of bytes used to store one line of the image in memory.
|
||||
This information is needed to move from one line to another in the image.
|
||||
.I endian
|
||||
tells you wether the pixel color in the image needs to be stored in
|
||||
little endian (
|
||||
.I endian
|
||||
== 0), or big endian (
|
||||
.I endian
|
||||
== 1).
|
||||
|
||||
.B mlx_get_data_addr
|
||||
returns a
|
||||
.I char *
|
||||
address that represents the begining of the memory area where the image
|
||||
is stored. From this adress, the first
|
||||
.I bits_per_pixel
|
||||
bits represent the color of the first pixel in the first line of
|
||||
the image. The second group of
|
||||
.I bits_per_pixel
|
||||
bits represent the second pixel of the first line, and so on.
|
||||
Add
|
||||
.I size_line
|
||||
to the adress to get the begining of the second line. You can reach any
|
||||
pixels of the image that way.
|
||||
|
||||
.B mlx_destroy_image
|
||||
destroys the given image (
|
||||
.I img_ptr
|
||||
).
|
||||
|
||||
.SH STORING COLOR INSIDE IMAGES
|
||||
|
||||
Depending on the display, the number of bits used to store a pixel color
|
||||
can change. The user usually represents a color in RGB mode, using
|
||||
one byte for each component (see
|
||||
.B mlx_pixel_put
|
||||
manual). This must be translated to fit the
|
||||
.I bits_per_pixel
|
||||
requirement of the image, and make the color understandable to the X-Server.
|
||||
That is the purpose of the
|
||||
.B mlx_get_color_value
|
||||
() function. It takes a standard RGB
|
||||
.I color
|
||||
parameter, and returns an
|
||||
.I unsigned int
|
||||
value.
|
||||
The
|
||||
.I bits_per_pixel
|
||||
least significant bits of this value can be stored in the image.
|
||||
|
||||
Keep in mind that the least significant bits position depends on the local
|
||||
computer's endian. If the endian of the image (in fact the endian of
|
||||
the X-Server's computer) differs from the local endian, then the value should
|
||||
be transformed before being used.
|
||||
|
||||
.SH XPM IMAGES
|
||||
|
||||
The
|
||||
.B mlx_xpm_to_image
|
||||
() and
|
||||
.B mlx_xpm_file_to_image
|
||||
() functions will create a new image the same way.
|
||||
They will fill it using the specified
|
||||
.I xpm_data
|
||||
or
|
||||
.I filename
|
||||
, depending on which function is used.
|
||||
Note that MiniLibX does not use the standard
|
||||
Xpm library to deal with xpm images. You may not be able to
|
||||
read all types of xpm images. It however handles transparency.
|
||||
|
||||
.SH RETURN VALUES
|
||||
The three functions that create images,
|
||||
.B mlx_new_image()
|
||||
,
|
||||
.B mlx_xpm_to_image()
|
||||
and
|
||||
.B mlx_xpm_file_to_image()
|
||||
, will return NULL if an error occurs. Otherwise they return a non-null pointer
|
||||
as an image identifier.
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
mlx(3), mlx_new_window(3), mlx_pixel_put(3), mlx_loop(3)
|
||||
|
||||
.SH AUTHOR
|
||||
Copyright ol@ - 2002-2014 - Olivier Crouzet
|
||||
79
minilibx-linux/man/man3/mlx_new_window.3
Normal file
79
minilibx-linux/man/man3/mlx_new_window.3
Normal file
@ -0,0 +1,79 @@
|
||||
.TH MiniLibX 3 "September 19, 2002"
|
||||
.SH NAME
|
||||
MiniLibX - Managing windows
|
||||
.SH SYNOPSYS
|
||||
|
||||
.nf
|
||||
.I void *
|
||||
.fi
|
||||
.B mlx_new_window
|
||||
(
|
||||
.I void *mlx_ptr, int size_x, int size_y, char *title
|
||||
);
|
||||
|
||||
.nf
|
||||
.I int
|
||||
.fi
|
||||
.B mlx_clear_window
|
||||
(
|
||||
.I void *mlx_ptr, void *win_ptr
|
||||
);
|
||||
|
||||
.nf
|
||||
.I int
|
||||
.fi
|
||||
.B mlx_destroy_window
|
||||
(
|
||||
.I void *mlx_ptr, void *win_ptr
|
||||
);
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
The
|
||||
.B mlx_new_window
|
||||
() function creates a new window on the screen, using the
|
||||
.I size_x
|
||||
and
|
||||
.I size_y
|
||||
parameters to determine its size, and
|
||||
.I title
|
||||
as the text that should be displayed in the window's title bar.
|
||||
The
|
||||
.I mlx_ptr
|
||||
parameter is the connection identifier returned by
|
||||
.B mlx_init
|
||||
() (see the
|
||||
.B mlx
|
||||
man page).
|
||||
.B mlx_new_window
|
||||
() returns a
|
||||
.I void *
|
||||
window identifier that can be used by other MiniLibX calls.
|
||||
Note that the MiniLibX
|
||||
can handle an arbitrary number of separate windows.
|
||||
|
||||
.B mlx_clear_window
|
||||
() and
|
||||
.B mlx_destroy_window
|
||||
() respectively clear (in black) and destroy the given window. They both have
|
||||
the same parameters:
|
||||
.I mlx_ptr
|
||||
is the screen connection identifier, and
|
||||
.I win_ptr
|
||||
is a window identifier.
|
||||
|
||||
.SH RETURN VALUES
|
||||
If
|
||||
.B mlx_new_window()
|
||||
fails to create a new window (for wathever reason), it will return NULL,
|
||||
otherwise a non-null pointer is returned as a window identifier.
|
||||
.B mlx_clear_window
|
||||
and
|
||||
.B mlx_destroy_window
|
||||
right now return nothing.
|
||||
|
||||
.SH SEE ALSO
|
||||
mlx(3), mlx_pixel_put(3), mlx_new_image(3), mlx_loop(3)
|
||||
|
||||
.SH AUTHOR
|
||||
Copyright ol@ - 2002-2014 - Olivier Crouzet
|
||||
81
minilibx-linux/man/man3/mlx_pixel_put.3
Normal file
81
minilibx-linux/man/man3/mlx_pixel_put.3
Normal file
@ -0,0 +1,81 @@
|
||||
.TH MiniLibX 3 "September 19, 2002"
|
||||
.SH NAME
|
||||
MiniLibX - Drawing inside windows
|
||||
.SH SYNOPSYS
|
||||
|
||||
.nf
|
||||
.I int
|
||||
.fi
|
||||
.B mlx_pixel_put
|
||||
(
|
||||
.I void *mlx_ptr, void *win_ptr, int x, int y, int color
|
||||
);
|
||||
|
||||
.nf
|
||||
.I int
|
||||
.fi
|
||||
.B mlx_string_put
|
||||
(
|
||||
.I void *mlx_ptr, void *win_ptr, int x, int y, int color, char *string
|
||||
);
|
||||
|
||||
|
||||
.SH DESCRIPTION
|
||||
The
|
||||
.B mlx_pixel_put
|
||||
() function draws a defined pixel in the window
|
||||
.I win_ptr
|
||||
using the (
|
||||
.I x
|
||||
,
|
||||
.I y
|
||||
) coordinates, and the specified
|
||||
.I color
|
||||
\&. The origin (0,0) is the upper left corner of the window, the x and y axis
|
||||
respectively pointing right and down. The connection
|
||||
identifier,
|
||||
.I mlx_ptr
|
||||
, is needed (see the
|
||||
.B mlx
|
||||
man page).
|
||||
|
||||
Parameters for
|
||||
.B mlx_string_put
|
||||
() have the same meaning. Instead of a simple pixel, the specified
|
||||
.I string
|
||||
will be displayed at (
|
||||
.I x
|
||||
,
|
||||
.I y
|
||||
).
|
||||
|
||||
In both functions, it is impossible to display anything outside the
|
||||
specified window, nor display in another window in front of the selected one.
|
||||
|
||||
.SH COLOR MANAGEMENT
|
||||
The
|
||||
.I color
|
||||
parameter has an integer type. The displayed color needs to be encoded
|
||||
in this integer, following a defined scheme. All displayable colors
|
||||
can be split in 3 basic colors: red, green and blue. Three associated
|
||||
values, in the 0-255 range, represent how much of each color is mixed up
|
||||
to create the original color. Theses three values must be set inside the
|
||||
integer to display the right color. The three least significant bytes of
|
||||
this integer are filled as shown in the picture below:
|
||||
|
||||
.nf
|
||||
| 0 | R | G | B | color integer
|
||||
+---+---+---+---+
|
||||
.fi
|
||||
|
||||
|
||||
While filling the integer, make sure you avoid endian problems. Remember
|
||||
that the "blue" byte should always be the least significant one.
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
mlx(3), mlx_new_window(3), mlx_new_image(3), mlx_loop(3)
|
||||
|
||||
|
||||
.SH AUTHOR
|
||||
Copyright ol@ - 2002-2014 - Olivier Crouzet
|
||||
Reference in New Issue
Block a user