File: al_set_shader_sampler.3

package info (click to toggle)
allegro5 2%3A5.2.2-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 23,032 kB
  • sloc: ansic: 120,340; cpp: 15,707; objc: 4,805; python: 2,915; java: 2,195; sh: 887; xml: 86; makefile: 49; perl: 37; pascal: 24
file content (41 lines) | stat: -rw-r--r-- 1,194 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
.TH "al_set_shader_sampler" "3" "" "Allegro reference manual" ""
.SH NAME
.PP
al_set_shader_sampler \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>

bool\ al_set_shader_sampler(const\ char\ *name,
\ \ \ ALLEGRO_BITMAP\ *bitmap,\ int\ unit)
\f[]
.fi
.SH DESCRIPTION
.PP
Sets a texture sampler uniform and texture unit of the current target
bitmap\[aq]s shader.
The given bitmap must be a video bitmap.
.PP
Different samplers should use different units.
The bitmap passed to Allegro\[aq]s drawing functions uses the 0th unit,
so if you\[aq]re planning on using the \f[C]al_tex\f[] variable in your
pixel shader as well as another sampler, set the other sampler to use a
unit different from 0.
With the primitives addon, it is possible to free up the 0th unit by
passing \f[C]NULL\f[] as the texture argument to the relevant drawing
functions.
In this case, you may set a sampler to use the 0th unit and thus not use
\f[C]al_tex\f[] (the \f[C]al_use_tex\f[] variable will be set to
\f[C]false\f[]).
.PP
Returns true on success.
Otherwise returns false, e.g.
if the uniform by that name does not exist in the shader.
.SH SINCE
.PP
5.1.0
.SH SEE ALSO
.PP
al_use_shader(3)