Documentation de SFML 2.5.1

Texture.hpp
1 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
5 //
6 // This software is provided 'as-is', without any express or implied warranty.
7 // In no event will the authors be held liable for any damages arising from the use of this software.
8 //
9 // Permission is granted to anyone to use this software for any purpose,
10 // including commercial applications, and to alter it and redistribute it freely,
11 // subject to the following restrictions:
12 //
13 // 1. The origin of this software must not be misrepresented;
14 // you must not claim that you wrote the original software.
15 // If you use this software in a product, an acknowledgment
16 // in the product documentation would be appreciated but is not required.
17 //
18 // 2. Altered source versions must be plainly marked as such,
19 // and must not be misrepresented as being the original software.
20 //
21 // 3. This notice may not be removed or altered from any source distribution.
22 //
24 
25 #ifndef SFML_TEXTURE_HPP
26 #define SFML_TEXTURE_HPP
27 
29 // Headers
31 #include <SFML/Graphics/Export.hpp>
32 #include <SFML/Graphics/Image.hpp>
33 #include <SFML/Window/GlResource.hpp>
34 
35 
36 namespace sf
37 {
38 class InputStream;
39 class RenderTarget;
40 class RenderTexture;
41 class Text;
42 class Window;
43 
48 class SFML_GRAPHICS_API Texture : GlResource
49 {
50 public:
51 
57  {
59  Pixels
60  };
61 
62 public:
63 
70  Texture();
71 
78  Texture(const Texture& copy);
79 
84  ~Texture();
85 
97  bool create(unsigned int width, unsigned int height);
98 
128  bool loadFromFile(const std::string& filename, const IntRect& area = IntRect());
129 
160  bool loadFromMemory(const void* data, std::size_t size, const IntRect& area = IntRect());
161 
191  bool loadFromStream(InputStream& stream, const IntRect& area = IntRect());
192 
215  bool loadFromImage(const Image& image, const IntRect& area = IntRect());
216 
223  Vector2u getSize() const;
224 
238  Image copyToImage() const;
239 
256  void update(const Uint8* pixels);
257 
278  void update(const Uint8* pixels, unsigned int width, unsigned int height, unsigned int x, unsigned int y);
279 
298  void update(const Texture& texture);
299 
315  void update(const Texture& texture, unsigned int x, unsigned int y);
316 
335  void update(const Image& image);
336 
352  void update(const Image& image, unsigned int x, unsigned int y);
353 
372  void update(const Window& window);
373 
389  void update(const Window& window, unsigned int x, unsigned int y);
390 
405  void setSmooth(bool smooth);
406 
415  bool isSmooth() const;
416 
440  void setSrgb(bool sRgb);
441 
450  bool isSrgb() const;
451 
474  void setRepeated(bool repeated);
475 
484  bool isRepeated() const;
485 
509  bool generateMipmap();
510 
519  Texture& operator =(const Texture& right);
520 
527  void swap(Texture& right);
528 
539  unsigned int getNativeHandle() const;
540 
572  static void bind(const Texture* texture, CoordinateType coordinateType = Normalized);
573 
584  static unsigned int getMaximumSize();
585 
586 private:
587 
588  friend class Text;
589  friend class RenderTexture;
590  friend class RenderTarget;
591 
605  static unsigned int getValidSize(unsigned int size);
606 
614  void invalidateMipmap();
615 
617  // Member data
619  Vector2u m_size;
620  Vector2u m_actualSize;
621  unsigned int m_texture;
622  bool m_isSmooth;
623  bool m_sRgb;
624  bool m_isRepeated;
625  mutable bool m_pixelsFlipped;
626  bool m_fboAttachment;
627  bool m_hasMipmap;
628  Uint64 m_cacheId;
629 };
630 
631 } // namespace sf
632 
633 
634 #endif // SFML_TEXTURE_HPP
635 
Abstract class for custom file input streams.
Definition: InputStream.hpp:41
Graphical text that can be drawn to a render target.
Definition: Text.hpp:48
Base class for classes that require an OpenGL context.
Definition: GlResource.hpp:46
Target for off-screen 2D rendering into a texture.
Image living on the graphics card that can be used for drawing.
Definition: Texture.hpp:48
Window that serves as a target for OpenGL rendering.
CoordinateType
Types of texture coordinates that can be used for rendering.
Definition: Texture.hpp:56
Base class for all render targets (window, texture, ...)
Class for loading, manipulating and saving images.
Definition: Image.hpp:46
Texture coordinates in range [0 .. 1].
Definition: Texture.hpp:58