cgv
Loading...
Searching...
No Matches
texture.h
1#pragma once
2
3#include <cgv/data/data_format.h>
4#include <cgv/data/data_view.h>
5#include <cgv/render/context.h>
6
7#include "lib_begin.h"
8
9namespace cgv {
10 namespace render {
11
14class CGV_API texture : public texture_base, public cgv::data::data_format
15{
16protected:
17 mutable bool state_out_of_date;
18 int tex_unit;
19 bool complete_create(const context& ctx, bool created);
20public:
21 using render_component::last_error;
22
25
29 texture(const std::string& description = "uint8[R,G,B,A]",
30 TextureFilter _mag_filter = TF_LINEAR,
31 TextureFilter _min_filter = TF_LINEAR,
32 TextureWrap _wrap_s = TW_CLAMP_TO_EDGE,
33 TextureWrap _wrap_t = TW_CLAMP_TO_EDGE,
34 TextureWrap _wrap_r = TW_CLAMP_TO_EDGE);
38 ~texture();
40 bool set_data_format(const std::string& description);
42 void set_component_format(const component_format& cf);
44 void set_component_format(const std::string& description);
46 void set_wrap_s(TextureWrap _wrap_s);
48 void set_wrap_t(TextureWrap _wrap_t);
50 void set_wrap_r(TextureWrap _wrap_r);
52 TextureWrap get_wrap_s() const;
54 TextureWrap get_wrap_t() const;
56 TextureWrap get_wrap_r() const;
58 void set_border_color(const float* rgba) { set_border_color(rgba[0],rgba[1],rgba[2],rgba[3]); }
60 void set_border_color(float r, float g, float b, float a = 1.0f);
62 cgv::vec4 get_border_color() const;
65 void set_min_filter(TextureFilter _min_filter, float _anisotropy = 2.0f);
67 TextureFilter get_min_filter() const;
69 float get_anisotropy() const;
71 void set_mag_filter(TextureFilter _mag_filter);
73 TextureFilter get_mag_filter() const;
75 void set_priority(float _priority);
77 float get_priority() const;
79 void set_compare_mode(bool use_compare_function);
81 bool get_compare_mode() const;
83 void set_compare_function(CompareFunction compare_function);
85 CompareFunction get_compare_function() const;
87 bool mipmaps_created() const;
89 void set_nr_multi_samples(unsigned _nr_samples);
91 unsigned get_nr_multi_samples() const { return nr_multi_samples; }
93 bool use_fixed_sample_locations() const { return fixed_sample_locations; }
95 void set_fixed_sample_locations(bool use);
97 void ensure_state(const context& ctx) const;
99 bool is_enabled() const;
101 int get_tex_unit() const;
103
106
107 void find_best_format(const context& ctx, const std::vector<cgv::data::data_view>* palettes = 0);
112 bool create(const context& ctx, TextureType _tt = TT_UNDEF, unsigned width=-1, unsigned height=-1, unsigned depth=-1);
122 bool create_from_image(const context& ctx, const std::string& file_name = "",
123 int* image_width_ptr = 0, int* image_height_ptr = 0,
124 unsigned char* clear_color_ptr = 0, int level = -1, int cube_side = -1);
128 bool create_from_image(cgv::data::data_format& df, cgv::data::data_view& dv, const context& ctx, const std::string& file_name = "",
129 unsigned char* clear_color_ptr = 0, int level = -1, int cube_side = -1);
131
133 static bool deduce_file_names(const std::string& file_names, std::vector<std::string>& deduced_names);
135
152 bool create_from_images(const context& ctx, const std::string& file_names, int level = -1);
154 bool write_to_file(context& ctx, const std::string& file_name, unsigned int z_or_cube_side = -1, float depth_map_gamma = 1.0f, const std::string& options = "") const;
156 bool create_mipmaps(const context& ctx);
159 bool generate_mipmaps(const context& ctx);
165 bool create_from_buffer(const context& ctx, int x, int y, int width, int height, int level = -1);
178 bool create(const context& ctx, const cgv::data::const_data_view& data, int level = -1, int cube_side = -1, int num_array_layers = 0, const std::vector<cgv::data::data_view>* palettes = 0);
182 bool replace(const context& ctx, int x, const cgv::data::const_data_view& data, int level = -1, const std::vector<cgv::data::data_view>* palettes = 0);
186 bool replace(const context& ctx, int x, int y, const cgv::data::const_data_view& data, int level = -1, const std::vector<cgv::data::data_view>* palettes = 0);
191 bool replace(const context& ctx, int x, int y, int z_or_cube_side, const cgv::data::const_data_view& data, int level = -1, const std::vector<cgv::data::data_view>* palettes = 0);
193 bool replace_from_buffer(const context& ctx, int x, int y, int x_buffer,
194 int y_buffer, int width, int height, int level = -1);
196 bool replace_from_buffer(const context& ctx, int x, int y, int z_or_cube_side, int x_buffer,
197 int y_buffer, int width, int height, int level);
199 bool replace_from_image(const context& ctx, const std::string& file_name, int x, int y, int z_or_cube_side, int level);
202 bool replace_from_image(cgv::data::data_format& df, cgv::data::data_view& dv, const context& ctx,
203 const std::string& file_name, int x, int y, int z_or_cube_side, int level);
206 bool copy(const context& ctx, cgv::data::data_view& dv, int level = -1) const;
208 bool destruct(const context& ctx);
210
213
215 bool enable(const context& ctx, int tex_unit = -1);
217 bool disable(const context& ctx);
218
227 bool bind_as_image(const context& ctx, int tex_unit, int level = 0, bool bind_array = false, int layer = 0, AccessType access = AT_WRITE_ONLY);
229};
230
231 }
232}
233
234#include <cgv/config/lib_end.h>
cgv::data::component_format::component_format
component_format(const std::string &description)
construct from description string, see set_component_format for docu
Definition component_format.cxx:85
cgv::data::const_data_view
The const_data_view has the functionality of the data_view but uses a const pointer and therefore doe...
Definition data_view.h:221
cgv::data::data_format
A data_format describes a multidimensional data block of data entries.
Definition data_format.h:17
cgv::data::data_view
the data view gives access to a data array of one, two, three or four dimensions.
Definition data_view.h:153
cgv::render::context
base class for all drawables, which is independent of the used rendering API.
Definition context.h:670
cgv::render::render_component::last_error
std::string last_error
a string that contains the last error
Definition context.h:365
cgv::render::texture_base::texture_base
texture_base(TextureType _tt=TT_UNDEF)
initialize members
Definition context.cxx:2251
cgv::render::texture::get_wrap_s
TextureWrap get_wrap_s() const
return the texture wrap behaviour in s direction
Definition texture.cxx:96
cgv::render::texture::set_data_format
bool set_data_format(const std::string &description)
change the data format and clear internal format
Definition texture.cxx:53
cgv::render::texture::get_wrap_r
TextureWrap get_wrap_r() const
return the texture wrap behaviour in r direction
Definition texture.cxx:106
cgv::render::texture::use_fixed_sample_locations
bool use_fixed_sample_locations() const
whether multi sampling uses fixed sample locations
Definition texture.h:93
cgv::render::texture::texture
texture(const std::string &description="uint8[R,G,B,A]", TextureFilter _mag_filter=TF_LINEAR, TextureFilter _min_filter=TF_LINEAR, TextureWrap _wrap_s=TW_CLAMP_TO_EDGE, TextureWrap _wrap_t=TW_CLAMP_TO_EDGE, TextureWrap _wrap_r=TW_CLAMP_TO_EDGE)
construct from description string (which defaults to rgba format) and most commonly used texture para...
Definition texture.cxx:23
cgv::render::texture::set_wrap_t
void set_wrap_t(TextureWrap _wrap_t)
set the texture wrap behaviour in t direction
Definition texture.cxx:84
cgv::render::texture::set_wrap_s
void set_wrap_s(TextureWrap _wrap_s)
set the texture wrap behaviour in s direction
Definition texture.cxx:78
cgv::render::texture::set_component_format
void set_component_format(const component_format &cf)
change component format and clear internal format
Definition texture.cxx:62
cgv::render::texture::set_border_color
void set_border_color(const float *rgba)
set the border color
Definition texture.h:58
cgv::render::texture::get_wrap_t
TextureWrap get_wrap_t() const
return the texture wrap behaviour in t direction
Definition texture.cxx:101
cgv::render::texture::set_wrap_r
void set_wrap_r(TextureWrap _wrap_r)
set the texture wrap behaviour in r direction
Definition texture.cxx:90
cgv::render::texture::get_nr_multi_samples
unsigned get_nr_multi_samples() const
return number of multi samples for textures of type TT_MULTISAMPLE_2D and TT_MULTISAMPLE_2D_ARRAY
Definition texture.h:91
cgv::data
namespace for data management components
Definition ascii_io_reflection_handlers.cxx:15
cgv::render
namespace for api independent GPU programming
Definition attribute_array_binding.cxx:7
cgv::render::AccessType
AccessType
different access types
Definition context.h:322
cgv::render::TextureFilter
TextureFilter
different texture filter
Definition context.h:245
cgv::render::TextureWrap
TextureWrap
different texture wrap modes
Definition context.h:229
cgv::render::TextureType
TextureType
different texture types
Definition context.h:257
cgv::render::CompareFunction
CompareFunction
different comparison functions used for depth testing or texture comparisons
Definition context.h:310
cgv
this header is dependency free
Definition print.h:11
cgv::vec4
cgv::math::fvec< float, 4 > vec4
declare type of 4d single precision floating point vectors (used for homogeneous coordinates)
Definition fvec.h:696
cgv::rgba
cgv::media::color< float, cgv::media::RGB, cgv::media::OPACITY > rgba
declare rgba color type with 32 bit components
Definition color.h:898