Debian Codegraph @

doc/doxygen-doc/man/man3/hwlocality_gl.3

raw
1 .TH "hwlocality_gl" 3 "Version 2.14.0" "Hardware Locality (hwloc)" \" -*- nroff -*-
2 .ad l
3 .nh
4 .SH NAME
5 hwlocality_gl \- Interoperability with OpenGL displays
6 .SH SYNOPSIS
7 .br
8 .PP
9 .SS "Functions"
10
11 .in +1c
12 .ti -1c
13 .RI "\fBhwloc_obj_t\fP \fBhwloc_gl_get_display_osdev_by_port_device\fP (\fBhwloc_topology_t\fP topology, unsigned port, unsigned device)"
14 .br
15 .ti -1c
16 .RI "\fBhwloc_obj_t\fP \fBhwloc_gl_get_display_osdev_by_name\fP (\fBhwloc_topology_t\fP topology, const char *name)"
17 .br
18 .ti -1c
19 .RI "int \fBhwloc_gl_get_display_by_osdev\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_obj_t\fP osdev, unsigned *port, unsigned *device)"
20 .br
21 .in -1c
22 .SH "Detailed Description"
23 .PP
24 This interface offers ways to retrieve topology information about OpenGL displays\&.
25
26 .PP
27 Only the NVIDIA display locality information is currently available, using the NV-CONTROL X11 extension and the NVCtrl library\&.
28
29 .PP
30 This code may hang when trying to connect to the X server\&. Hence the GL component is disabled unless HWLOC_GL=1 in the environment\&.
31 .SH "Function Documentation"
32 .PP
33 .SS "int hwloc_gl_get_display_by_osdev (\fBhwloc_topology_t\fP topology, \fBhwloc_obj_t\fP osdev, unsigned * port, unsigned * device)\fR [inline]\fP"
34
35 .PP
36 Get the OpenGL display port and device corresponding to the given hwloc OS object\&. Retrieves the OpenGL display port (server) in \fRport\fP and device (screen) in \fRscreen\fP that correspond to the given hwloc OS device object\&.
37
38 .PP
39 \fBReturns\fP
40 .RS 4
41 0 on success\&.
42
43 .PP
44 -1 if none could be found\&.
45 .RE
46 .PP
47 The topology \fRtopology\fP does not necessarily have to match the current machine\&. For instance the topology may be an XML import of a remote host\&. I/O devices detection and the GL component must be enabled in the topology\&.
48
49 .PP
50 \fBNote\fP
51 .RS 4
52 The GL backend creating these OS devices is disabled by default since it may cause hwloc to hang when trying to connect to the X server\&. Set HWLOC_GL=1 in the environment to reenable it\&.
53 .RE
54 .PP
55
56 .SS "\fBhwloc_obj_t\fP hwloc_gl_get_display_osdev_by_name (\fBhwloc_topology_t\fP topology, const char * name)\fR [inline]\fP"
57
58 .PP
59 Get the hwloc OS device object corresponding to the OpenGL display given by name\&.
60 .PP
61 \fBReturns\fP
62 .RS 4
63 The hwloc OS device object describing the OpenGL display whose name is \fRname\fP, built as ":port\&.device" such as ":0\&.0" \&.
64
65 .PP
66 \fRNULL\fP if none could be found\&.
67 .RE
68 .PP
69 The topology \fRtopology\fP does not necessarily have to match the current machine\&. For instance the topology may be an XML import of a remote host\&. I/O devices detection and the GL component must be enabled in the topology\&.
70
71 .PP
72 \fBNote\fP
73 .RS 4
74 The GL backend creating these OS devices is disabled by default since it may cause hwloc to hang when trying to connect to the X server\&. Set HWLOC_GL=1 in the environment to reenable it\&.
75
76 .PP
77 The corresponding PCI device object can be obtained by looking at the OS device parent object (unless PCI devices are filtered out)\&.
78 .RE
79 .PP
80
81 .SS "\fBhwloc_obj_t\fP hwloc_gl_get_display_osdev_by_port_device (\fBhwloc_topology_t\fP topology, unsigned port, unsigned device)\fR [inline]\fP"
82
83 .PP
84 Get the hwloc OS device object corresponding to the OpenGL display given by port and device index\&.
85 .PP
86 \fBReturns\fP
87 .RS 4
88 The hwloc OS device object describing the OpenGL display whose port (server) is \fRport\fP and device (screen) is \fRdevice\fP\&.
89
90 .PP
91 \fRNULL\fP if none could be found\&.
92 .RE
93 .PP
94 The topology \fRtopology\fP does not necessarily have to match the current machine\&. For instance the topology may be an XML import of a remote host\&. I/O devices detection and the GL component must be enabled in the topology\&.
95
96 .PP
97 \fBNote\fP
98 .RS 4
99 The GL backend creating these OS devices is disabled by default since it may cause hwloc to hang when trying to connect to the X server\&. Set HWLOC_GL=1 in the environment to reenable it\&.
100
101 .PP
102 The corresponding PCI device object can be obtained by looking at the OS device parent object (unless PCI devices are filtered out)\&.
103 .RE
104 .PP
105
106 .SH "Author"
107 .PP
108 Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&.