al_emit_user_event man page on DragonFly

Man page or keyword search:  
man Server   44335 pages
apropos Keyword Search (all sections)
Output format
DragonFly logo
[printable version]

al_emit_user_event(3)					 al_emit_user_event(3)

NAME
       al_emit_user_event - Allegro 5 API

SYNOPSIS
	      #include <allegro5/allegro.h>

	      bool al_emit_user_event(ALLEGRO_EVENT_SOURCE *src,
		 ALLEGRO_EVENT *event, void (*dtor)(ALLEGRO_USER_EVENT *))

DESCRIPTION
       Emit  a	user  event.  The event source must have been initialised with
       al_init_user_event_source(3).  Returns false if the event source	 isn't
       registered  with	 any queues, hence the event wouldn't have been delivā€
       ered into any queues.

       Events are copied in and out of event queues, so	 after	this  function
       returns	the  memory  pointed to by event may be freed or reused.  Some
       fields of the event being passed in may be modified by the function.

       Reference counting will be performed if dtor is not NULL.   Whenever  a
       copy  of the event is made, the reference count increases.  You need to
       call al_unref_user_event(3) to decrease the reference  count  once  you
       are   done   with   a   user   event   that   you  have	received  from
       al_get_next_event(3), al_peek_next_event(3), al_wait_for_event(3), etc.

       Once the reference count drops to zero dtor will be called with a  copy
       of  the	event as an argument.  It should free the resources associated
       with the event, but not the event itself (since it is just a copy).

       If dtor is NULL then reference counting will not be performed.	It  is
       safe,  but unnecessary, to call al_unref_user_event(3) on non-reference
       counted user events.

SEE ALSO
       ALLEGRO_USER_EVENT(3), al_unref_user_event(3)

Allegro reference manual				 al_emit_user_event(3)
[top]

List of man pages available for DragonFly

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net