File: __opengl_info__.m

package info (click to toggle)
octave 9.4.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 144,300 kB
  • sloc: cpp: 332,784; ansic: 77,239; fortran: 20,963; objc: 9,396; sh: 8,213; yacc: 4,925; lex: 4,389; perl: 1,544; java: 1,366; awk: 1,259; makefile: 648; xml: 189
file content (161 lines) | stat: -rw-r--r-- 4,584 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
########################################################################
##
## Copyright (C) 2016-2024 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## This file is part of Octave.
##
## Octave is free software: you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING.  If not, see
## <https://www.gnu.org/licenses/>.
##
########################################################################

## -*- texinfo -*-
## @deftypefn  {} {} __opengl_info__
## @deftypefnx {} {@var{retval} =} __opengl_info__ ()
##
## Get OpenGL driver information.
##
## If no output values are requested, display information about the
## OpenGL subsystem.  If an output is requested, return the information
## in a structure.
##
## Fields in the structure are:
##
## @table @asis
## @item version
## OpenGL Driver version string
##
## @item vendor
## OpenGL Driver vendor string
##
## @item renderer
## OpenGL renderer string
##
## @item extensions
## List of enabled extensions for the OpenGL driver.
## @end table
##
## Example Code:
##
## @example
## glinfo = __opengl_info__ ();
## @end example
##
## @end deftypefn

function retval = __opengl_info__ ()

  [info, msg] = gl_info ();

  if (! isempty (msg))
    warning (msg);
  else
    if (nargout == 0)
      printf ("   version: %s\n", info.version);
      printf ("    vendor: %s\n", info.vendor);
      printf ("  renderer: %s\n", info.renderer);
      printf ("extensions:\n");
      printf ("  %s\n", info.extensions{:});
    else
      retval = info;
    endif
  endif

endfunction

function info = fig_gl_info (h)

  info = [];

  if (ishghandle (h) && strcmp (get (h, "renderer"), "opengl"))
    vend = get (h, "__gl_vendor__");
    if (isempty (vend))
      return;
    endif
    info.vendor   = vend;
    info.version  = get (h, "__gl_version__");
    info.renderer = get (h, "__gl_renderer__");
    info.extensions = strsplit (strtrim (get (h, "__gl_extensions__")));
  endif

endfunction

function [info, msg] = gl_info ()

  info = [];
  msg = "";

  ## If we have any open figures, take a look there for OpenGL info.
  figs = findall (0, "type", "figure");

  for hf = figs.'
    info = fig_gl_info (hf);
    if (! isempty (info))
      break;
    endif
  endfor

  ## If no info yet, try open a figure to get the info.
  attempts = 1;
  while (isempty (info) && attempts++ <= 3)
    ## Need to create a figure, place an OpenGL object, and force drawing.
    hf = figure ("position", [0,0,1,1], "toolbar", "none", "menubar", "none");
    hax = axes ();
    ## FIXME: Race condition means this delay may not always work.
    pause (0.1 * attempts);
    refresh (hf);
    info = fig_gl_info (hf);
    close (hf);
  endwhile

  if (isempty (info))
    msg = "__opengl_info__: can not obtain OpenGL information";
  endif

endfunction


## FIXME: This is really an internal function as indicated by the leading and
## trailing underscores.  As such, it doesn't require tests.  In addition,
## during the running of the test suite this function will throw up a figure
## which is undesirable.  The tests have been commented out, but are still
## available in case someone wants to hand-test the function by executing the
## code.

%!#testif HAVE_OPENGL, HAVE_FLTK; have_window_system () && any (strcmp ("fltk", available_graphics_toolkits ()))
%! old_toolkit = graphics_toolkit ();
%! unwind_protect
%!   graphics_toolkit ("fltk");
%!   a = __opengl_info__ ();
%! unwind_protect_cleanup
%!   graphics_toolkit (old_toolkit);
%! end_unwind_protect
%! assert (! isempty (a));
%! assert (isfield (a, "version"));

%!#testif HAVE_OPENGL, HAVE_QT; have_window_system () && any (strcmp ("qt", available_graphics_toolkits ()))
%! old_toolkit = graphics_toolkit ();
%! unwind_protect
%!   graphics_toolkit ("qt");
%!   a = __opengl_info__ ();
%! unwind_protect_cleanup
%!   graphics_toolkit (old_toolkit);
%! end_unwind_protect
%! assert (! isempty (a));
%! assert (isfield (a, "version"));

%!error __opengl_info ("foobar")