Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
al_set_new...play_flags(3) Library Functions Manual al_set_new...play_flags(3)

NAME
       al_set_new_display_flags	- Allegro 5 API

SYNOPSIS
	      #include <allegro5/allegro.h>

	      void al_set_new_display_flags(int	flags)

DESCRIPTION
       Sets various flags to be	used when creating new displays	on the calling
       thread.	 flags	is a bitfield containing any reasonable	combination of
       the following:

       ALLEGRO_WINDOWED
	      Prefer a windowed	mode.
	      Under multi-head X (not XRandR/TwinView),	the use	of  more  than
	      one  adapter  is	impossible  due	to bugs	in X and GLX.  al_cre-
	      ate_display(3) will fail if more than one	adapter	 is  attempted
	      to be used.

       ALLEGRO_FULLSCREEN_WINDOW
	      Make   the   window   span  the  entire  screen.	 Unlike	 ALLE-
	      GRO_FULLSCREEN this will never attempt to	modify the screen res-
	      olution.	Instead	the pixel dimensions of	 the  created  display
	      will be the same as the desktop.
	      The  passed  width  and  height  are  only used if the window is
	      switched out of fullscreen mode later but	will be	 ignored  ini-
	      tially.  Under Windows and X11 a fullscreen display created with
	      this  flag will behave differently from one created with the AL-
	      LEGRO_FULLSCREEN flag - even if the  ALLEGRO_FULLSCREEN  display
	      is passed	the desktop dimensions.	 The exact difference is plat-
	      form  dependent,	but  some things which may be different	is how
	      alt-tab works, how fast you can toggle  between  fullscreen/win-
	      dowed  mode or how additional monitors behave while your display
	      is in fullscreen mode.  Additionally under X, the	 use  of  more
	      than  one	 adapter  in multi-head	mode or	with true Xinerama en-
	      abled is impossible due to bugs in X/GLX,	creation will fail  if
	      more than	one adapter is attempted to be used.

       ALLEGRO_FULLSCREEN
	      Prefer a fullscreen mode.
	      Under  X	the use	of more	than one FULLSCREEN display when using
	      multi-head X, or true Xinerama is	not possible due to bugs in  X
	      and  GLX,	display	creation will fail if more than	one adapter is
	      attempted	to be used.

		     Note: Prefer using	ALLEGRO_FULLSCREEN_WINDOW as it	 typi-
		     cally  provides  a	 better	user experience	as the monitor
		     doesn't change resolution and switching  away  from  your
		     game  via	Alt-Tab	works smoothly.	 ALLEGRO_FULLSCREEN is
		     typically	less  well   supported	 compared   to	 ALLE-
		     GRO_FULLSCREEN_WINDOW.

       ALLEGRO_RESIZABLE
	      The display is resizable (only applicable	if combined with ALLE-
	      GRO_WINDOWED).

       ALLEGRO_MAXIMIZED
	      The  display  window  will be maximized (only applicable if com-
	      bined with ALLEGRO_RESIZABLE).  Since: 5.1.12

       ALLEGRO_OPENGL
	      Require the driver to provide an initialized OpenGL context  af-
	      ter returning successfully.

       ALLEGRO_OPENGL_3_0
	      Require the driver to provide an initialized OpenGL context com-
	      patible with OpenGL version 3.0.

       ALLEGRO_OPENGL_FORWARD_COMPATIBLE
	      If  this	flag  is  set,	the  OpenGL context created with ALLE-
	      GRO_OPENGL_3_0 will be forward compatible	only, meaning that all
	      of the OpenGL API	declared deprecated in OpenGL 3.0 will not  be
	      supported.  Currently, a display created with this flag will not
	      be  compatible with Allegro drawing routines; the	display	option
	      ALLEGRO_COMPATIBLE_DISPLAY will be set to	false.

       ALLEGRO_OPENGL_ES_PROFILE
	      Used together with ALLEGRO_OPENGL, requests that the OpenGL con-
	      text uses	the OpenGL ES profile.	A specific version can be  re-
	      quested with al_set_new_display_option(3).  Note:	Currently this
	      is only supported	by the X11/GLX driver.	Since: 5.1.13

       ALLEGRO_OPENGL_CORE_PROFILE
	      Used together with ALLEGRO_OPENGL, requests that the OpenGL con-
	      text  uses  the  OpenGL Core profile.  A specific	version	can be
	      requested	with  al_set_new_display_option(3).   Note:  Currently
	      this is only supported by	the X11/GLX driver.  Since: 5.2.7

       ALLEGRO_DIRECT3D
	      Require  the  driver to do rendering with	Direct3D and provide a
	      Direct3D device.

       ALLEGRO_PROGRAMMABLE_PIPELINE
	      Require a	programmable graphics pipeline.	 This flag is required
	      to use ALLEGRO_SHADER(3) objects.	 Since:	5.1.6

       ALLEGRO_FRAMELESS
	      Try to create a window without a frame (i.e. no border or	title-
	      bar).  This usually does nothing for fullscreen modes, and  even
	      in  windowed modes it depends on the underlying platform whether
	      it is supported or not.  Since: 5.0.7, 5.1.2

       ALLEGRO_NOFRAME
	      Original name for	ALLEGRO_FRAMELESS.  This works with older ver-
	      sions of Allegro.

       ALLEGRO_GENERATE_EXPOSE_EVENTS
	      Let the display generate expose events.

       ALLEGRO_GTK_TOPLEVEL
	      Create a GTK toplevel window for the display, on X. This flag is
	      conditionally defined by the native dialog addon.	 You must call
	      al_init_native_dialog_addon(3)  for  it	to   succeed.	 ALLE-
	      GRO_GTK_TOPLEVEL	 is   incompatible   with  ALLEGRO_FULLSCREEN.
	      Since: 5.1.5

       ALLEGRO_DRAG_AND_DROP
	      If a display is created with the ALLEGRO_DRAG_AND_DROP  flag  it
	      will  generate  ALLEGRO_EVENT_DROP events	when files or text are
	      dropped over the display.

		     [Unstable API]: This is an	experimental feature and  cur-
		     rently only works for the X11 backend.
	      Since: 5.2.9

       0 can be	used for default values.

SEE ALSO
       al_set_new_display_option(3),   al_get_display_option(3),   al_set_dis-
       play_option(3)

Allegro	reference manual			    al_set_new...play_flags(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=al_set_new_display_flags&sektion=3&manpath=FreeBSD+Ports+15.0>

home | help