summaryrefslogtreecommitdiff
path: root/doc/graphics/texture.texi
diff options
context:
space:
mode:
authorDavid Thompson <dthompson@member.fsf.org>2013-09-24 21:06:41 -0400
committerDavid Thompson <dthompson@member.fsf.org>2013-09-24 21:06:41 -0400
commit1f1deea662da4328bf588c0642c8a90c7b1f2144 (patch)
treea7973b46b580ca2a9e8fb65f459e0004ae87b64f /doc/graphics/texture.texi
parent7937b85219607a6e7755907e0752343344ed036c (diff)
Rough draft of manual.
Diffstat (limited to 'doc/graphics/texture.texi')
-rw-r--r--doc/graphics/texture.texi65
1 files changed, 65 insertions, 0 deletions
diff --git a/doc/graphics/texture.texi b/doc/graphics/texture.texi
new file mode 100644
index 0000000..2ac1503
--- /dev/null
+++ b/doc/graphics/texture.texi
@@ -0,0 +1,65 @@
+@node Textures
+@section Textures
+
+Textures are images loaded in graphics memory. Guile-2D supports many
+texture formats via the FreeImage library. A texture object can
+describe a full image or a rectangular section of an image.
+
+@anchor{2d texture make-texture}@defun make-texture id parent width height s1 t1 s2 t2
+Create a new texture object. ID is the OpenGL texture id. PARENT is a
+texture object (if this texture only represents a region of another
+texture) or #f. WIDTH and HEIGHT are the texture dimensions in pixels.
+S1, T1, S2, and T2 are the OpenGL texture coordinates representing the
+area of the texture that will be rendered.
+
+@end defun
+
+@anchor{2d texture make-texture-region}@defun make-texture-region texture x y width height
+Creates new texture region object. TEXTURE is the region's parent
+texture. X, Y, WIDTH, and HEIGHT represent the region of the texture
+that will be rendered, in pixels.
+
+@end defun
+
+@anchor{2d texture load-texture}@defun load-texture filename
+Load a texture from an image file at FILENAME.
+
+@end defun
+
+@anchor{2d texture texture?}@defspec texture?
+@end defspec
+
+@anchor{2d texture texture-region?}@defun texture-region? texture
+Return #t if TEXTURE has a parent texture.
+
+@end defun
+
+@anchor{2d texture texture-id}@defspec texture-id
+@end defspec
+
+@anchor{2d texture texture-width}@defspec texture-width
+@end defspec
+
+@anchor{2d texture texture-height}@defspec texture-height
+@end defspec
+
+@anchor{2d texture texture-s1}@defspec texture-s1
+@end defspec
+
+@anchor{2d texture texture-t1}@defspec texture-t1
+@end defspec
+
+@anchor{2d texture texture-s2}@defspec texture-s2
+@end defspec
+
+@anchor{2d texture texture-t2}@defspec texture-t2
+@end defspec
+
+@anchor{2d texture surface->texture}@defvar surface->texture
+[unbound!]
+@end defvar
+
+@anchor{2d texture draw-texture}@defun draw-texture texture x y [color]
+Render a textured quad in GL immediate mode.
+
+@end defun