efa98f7ca2aafad596d07127eb237ea999a9c91a
[blender.git] / source / blender / gpu / GPU_texture.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2005 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Brecht Van Lommel.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file GPU_texture.h
29  *  \ingroup gpu
30  */
31
32 #ifndef __GPU_TEXTURE_H__
33 #define __GPU_TEXTURE_H__
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 struct Image;
40 struct ImageUser;
41 struct PreviewImage;
42         
43 struct GPUFrameBuffer;
44 typedef struct GPUTexture GPUTexture;
45
46 /* GPU Texture
47  * - always returns unsigned char RGBA textures
48  * - if texture with non square dimensions is created, depending on the
49  *   graphics card capabilities the texture may actually be stored in a
50  *   larger texture with power of two dimensions.
51  * - can use reference counting:
52  *     - reference counter after GPU_texture_create is 1
53  *     - GPU_texture_ref increases by one
54  *     - GPU_texture_free decreases by one, and frees if 0
55  *  - if created with from_blender, will not free the texture
56  */
57
58 typedef enum GPUHDRType {
59         GPU_HDR_NONE =       0,
60         GPU_HDR_HALF_FLOAT = 1,
61         GPU_HDR_FULL_FLOAT = (1 << 1),
62 } GPUHDRType;
63
64 GPUTexture *GPU_texture_create_1D(int w, const float *pixels, char err_out[256]);
65 GPUTexture *GPU_texture_create_2D(int w, int h, const float *pixels, GPUHDRType hdr, char err_out[256]);
66 GPUTexture *GPU_texture_create_3D(int w, int h, int depth, int channels, const float *fpixels);
67 GPUTexture *GPU_texture_create_depth(int w, int h, char err_out[256]);
68 GPUTexture *GPU_texture_create_vsm_shadow_map(int size, char err_out[256]);
69 GPUTexture *GPU_texture_create_2D_procedural(int w, int h, const float *pixels, bool repeat, char err_out[256]);
70 GPUTexture *GPU_texture_create_1D_procedural(int w, const float *pixels, char err_out[256]);
71 GPUTexture *GPU_texture_create_2D_multisample(
72         int w, int h, const float *pixels, GPUHDRType hdr, int samples, char err_out[256]);
73 GPUTexture *GPU_texture_create_depth_multisample(int w, int h, int samples, char err_out[256]);
74 GPUTexture *GPU_texture_from_blender(
75                 struct Image *ima, struct ImageUser *iuser, int textarget, bool is_data, double time, int mipmap);
76 GPUTexture *GPU_texture_from_preview(struct PreviewImage *prv, int mipmap);
77 void GPU_invalid_tex_init(void);
78 void GPU_invalid_tex_bind(int mode);
79 void GPU_invalid_tex_free(void);
80
81 void GPU_texture_free(GPUTexture *tex);
82
83 void GPU_texture_ref(GPUTexture *tex);
84
85 void GPU_texture_bind(GPUTexture *tex, int number);
86 void GPU_texture_unbind(GPUTexture *tex);
87 int GPU_texture_bound_number(GPUTexture *tex);
88
89 void GPU_texture_filter_mode(GPUTexture *tex, bool compare, bool use_filter);
90
91 struct GPUFrameBuffer *GPU_texture_framebuffer(GPUTexture *tex);
92 int GPU_texture_framebuffer_attachment(GPUTexture *tex);
93 void GPU_texture_framebuffer_set(GPUTexture *tex, struct GPUFrameBuffer *fb, int attachment);
94
95 int GPU_texture_target(const GPUTexture *tex);
96 int GPU_texture_width(const GPUTexture *tex);
97 int GPU_texture_height(const GPUTexture *tex);
98 int GPU_texture_depth(const GPUTexture *tex);
99 int GPU_texture_opengl_bindcode(const GPUTexture *tex);
100
101 #ifdef __cplusplus
102 }
103 #endif
104
105 #endif  /* __GPU_TEXTURE_H__ */