gtkmm: Gdk::GLTexture Class Reference

A Gdk::Texture representing a GL texture object. More...

#include <gdkmm/gltexture.h>

Inheritance diagram for Gdk::GLTexture:

[legend]

Public Types
using	SlotGLReleased = sigc::slot< void()>
	For instance, void on_gl_resources_released();.

Public Types inherited from Glib::Object
typedef void(*)(gpointer data	DestroyNotify)

Public Types inherited from sigc::trackable
typedef internal::func_destroy_notify	func_destroy_notify

Public Types inherited from sigc::notifiable
typedef internal::func_destroy_notify	func_destroy_notify

Public Types inherited from Gdk::Paintable
enum class	Flags { Flags::STATIC_SIZE = 1 << 0 , Flags::STATIC_CONTENTS = 1 << 1 }
	Flags about a paintable object. More...

Public Member Functions
	GLTexture (GLTexture &&src) noexcept

GLTexture &	operator= (GLTexture &&src) noexcept

	~GLTexture () noexcept override

GdkGLTexture *	gobj ()
	Provides access to the underlying C GObject.

const GdkGLTexture *	gobj () const
	Provides access to the underlying C GObject.

GdkGLTexture *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

void	release ()
	Releases the GL resources held by a `Gdk::GLTexture`.

Public Member Functions inherited from Gdk::Texture
	Texture (Texture &&src) noexcept

Texture &	operator= (Texture &&src) noexcept

	~Texture () noexcept override

GdkTexture *	gobj ()
	Provides access to the underlying C GObject.

const GdkTexture *	gobj () const
	Provides access to the underlying C GObject.

GdkTexture *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

int	get_width () const
	Returns the width of texture, in pixels.

int	get_height () const
	Returns the height of the texture, in pixels.

MemoryFormat	get_format () const
	Gets the memory format most closely associated with the data of the texture.

Glib::RefPtr< ColorState >	get_color_state () const
	Returns the color state associated with the texture.

void	download (guchar *data, gsize stride) const
	Downloads the texture into local memory.

bool	save_to_png (const Glib::ustring &filename) const
	Store the given texture to the filename as a PNG file.

Glib::RefPtr< Glib::Bytes >	save_to_png_bytes () const
	Store the given texture in memory as a PNG file.

bool	save_to_tiff (const std::string &filename) const
	Store the given texture to the filename as a TIFF file.

Glib::RefPtr< Glib::Bytes >	save_to_tiff_bytes () const
	Store the given texture in memory as a TIFF file.

Glib::PropertyProxy_ReadOnly< int >	property_width () const
	The width of the texture, in pixels.

Glib::PropertyProxy_ReadOnly< int >	property_height () const
	The height of the texture, in pixels.

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< ColorState > >	property_color_state () const
	The color state of the texture.

Public Member Functions inherited from Glib::Object
	Object (const Object &)=delete

Object &	operator= (const Object &)=delete

	Object (Object &&src) noexcept

Object &	operator= (Object &&src) noexcept

void *	get_data (const QueryQuark &key)

void	set_data (const Quark &key, void *data)

void	set_data_with_c_callback (const Quark &key, void *data, GDestroyNotify notify)

void	set_data (const Quark &key, void *data, DestroyNotify notify)

void	remove_data (const QueryQuark &quark)

void *	steal_data (const QueryQuark &quark)

Glib::RefPtr< Glib::Object >	wrap (GObject *object, bool take_copy=false)

Public Member Functions inherited from Glib::ObjectBase
	ObjectBase (const ObjectBase &)=delete

ObjectBase &	operator= (const ObjectBase &)=delete

void	set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value)

void	get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const

void	set_property (const Glib::ustring &property_name, const PropertyType &value)

void	get_property (const Glib::ustring &property_name, PropertyType &value) const

PropertyType	get_property (const Glib::ustring &property_name) const

sigc::connection	connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void()> &slot)

sigc::connection	connect_property_changed (const Glib::ustring &property_name, sigc::slot< void()> &&slot)

void	freeze_notify ()

void	thaw_notify ()

virtual void	reference () const

virtual void	unreference () const

GObject *	gobj ()

const GObject *	gobj () const

GObject *	gobj_copy () const

Public Member Functions inherited from sigc::trackable
	trackable () noexcept

	trackable (const trackable &src) noexcept

	trackable (trackable &&src) noexcept

	~trackable ()

void	add_destroy_notify_callback (notifiable *data, func_destroy_notify func) const

void	notify_callbacks ()

trackable &	operator= (const trackable &src)

trackable &	operator= (trackable &&src) noexcept

void	remove_destroy_notify_callback (notifiable *data) const

Public Member Functions inherited from Gdk::Paintable
	Paintable (Paintable &&src) noexcept

Paintable &	operator= (Paintable &&src) noexcept

	~Paintable () noexcept override

GdkPaintable *	gobj ()
	Provides access to the underlying C GObject.

const GdkPaintable *	gobj () const
	Provides access to the underlying C GObject.

void	snapshot (const Glib::RefPtr< Gdk::Snapshot > & snapshot, double width, double height)
	Snapshots the given paintable with the given width and height.

Glib::RefPtr< const Paintable >	get_current_image () const
	Gets an immutable paintable for the current contents displayed by paintable.

Flags	get_flags () const
	Get flags for the paintable.

int	get_intrinsic_width () const
	Gets the preferred width the paintable would like to be displayed at.

int	get_intrinsic_height () const
	Gets the preferred height the paintable would like to be displayed at.

double	get_intrinsic_aspect_ratio () const
	Gets the preferred aspect ratio the paintable would like to be displayed at.

void	compute_concrete_size (double specified_width, double specified_height, double default_width, double default_height, double &concrete_width, double &concrete_height) const
	Compute a concrete size for the `Gdk::Paintable`.

void	invalidate_contents ()
	Called by implementations of `Gdk::Paintable` to invalidate their contents.

void	invalidate_size ()
	Called by implementations of `Gdk::Paintable` to invalidate their size.

Glib::SignalProxy< void()>	signal_invalidate_contents ()

Glib::SignalProxy< void()>	signal_invalidate_size ()

Public Member Functions inherited from Glib::Interface
	Interface ()

	Interface (Interface &&src) noexcept

Interface &	operator= (Interface &&src) noexcept

	Interface (const Glib::Interface_Class &interface_class)

	Interface (GObject *castitem)

	~Interface () noexcept override

	Interface (const Interface &)=delete

Interface &	operator= (const Interface &)=delete

GObject *	gobj ()

const GObject *	gobj () const

Static Public Member Functions
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.

static Glib::RefPtr< Texture >	create (const Glib::RefPtr< GLContext > &context, guint id, int width, int height, const SlotGLReleased & slot={})
	Creates a new texture for an existing GL texture.

Static Public Member Functions inherited from Gdk::Texture
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.

static Glib::RefPtr< Texture >	create_for_pixbuf (const Glib::RefPtr< Pixbuf > &pixbuf)
	Creates a new texture object representing the `Gdk::Pixbuf`.

static Glib::RefPtr< Texture >	create_from_resource (const std::string &resource_path)
	Creates a new texture by loading an image from a resource.

static Glib::RefPtr< Texture >	create_from_file (const Glib::RefPtr< Gio::File > & file)
	Creates a new texture by loading an image from a file.

static Glib::RefPtr< Texture >	create_from_filename (const std::string & path)
	Creates a new texture by loading an image from a file.

static Glib::RefPtr< Texture >	create_from_bytes (const Glib::RefPtr< const Glib::Bytes > & bytes)
	Creates a new texture by loading an image from memory,.

Static Public Member Functions inherited from Gdk::Paintable
static void	add_interface (GType gtype_implementer)

static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.

Protected Member Functions
	GLTexture ()

Protected Member Functions inherited from Gdk::Texture
	Texture ()

Protected Member Functions inherited from Glib::Object
	Object ()

	Object (const Glib::ConstructParams &construct_params)

	Object (GObject *castitem)

	~Object () noexcept override

Protected Member Functions inherited from Glib::ObjectBase
	ObjectBase ()

	ObjectBase (const char *custom_type_name)

	ObjectBase (const std::type_info &custom_type_info)

	ObjectBase (ObjectBase &&src) noexcept

ObjectBase &	operator= (ObjectBase &&src) noexcept

virtual	~ObjectBase () noexcept=0

void	initialize (GObject *castitem)

void	initialize_move (GObject castitem, Glib::ObjectBase previous_wrapper)

Protected Member Functions inherited from Gdk::Paintable
	Paintable ()
	You should derive from this class to use it.

virtual void	snapshot_vfunc (const Glib::RefPtr< Gdk::Snapshot > &snapshot, double width, double height)

virtual Glib::RefPtr< Paintable >	get_current_image_vfunc () const

virtual Flags	get_flags_vfunc () const

virtual int	get_intrinsic_width_vfunc () const

virtual int	get_intrinsic_height_vfunc () const

virtual double	get_intrinsic_aspect_ratio_vfunc () const

Related Symbols
(Note that these are not member symbols.)
Glib::RefPtr< Gdk::GLTexture >	wrap (GdkGLTexture *object, bool take_copy=false)
	A Glib::wrap() method for this object.

Related Symbols inherited from Gdk::Texture
Glib::RefPtr< Gdk::Texture >	wrap (GdkTexture *object, bool take_copy=false)
	A Glib::wrap() method for this object.

Related Symbols inherited from Gdk::Paintable
Glib::RefPtr< Gdk::Paintable >	wrap (GdkPaintable *object, bool take_copy=false)
	A Glib::wrap() method for this object.

Detailed Description

A Gdk::Texture representing a GL texture object.

Since gtkmm 3.94:

Member Typedef Documentation

◆ SlotGLReleased

using Gdk::GLTexture::SlotGLReleased = sigc::slot<void()>

For instance, void on_gl_resources_released();.

Constructor & Destructor Documentation

◆ GLTexture() [1/2]

Gdk::GLTexture::GLTexture ( GLTexture && src )

noexcept

◆ ~GLTexture()

Gdk::GLTexture::~GLTexture ( )

overridenoexcept

◆ GLTexture() [2/2]

Gdk::GLTexture::GLTexture ( )

protected

Member Function Documentation

◆ create()

static Glib::RefPtr< Texture > Gdk::GLTexture::create	(	const Glib::RefPtr< GLContext > &	context,
		guint	id,
		int	width,
		int	height,
		const SlotGLReleased &	slot = `{}`
	)

static

Creates a new texture for an existing GL texture.

Note that the GL texture must not be modified until slot is called, which will happen when the GdkTexture object is finalized, or due to an explicit call of release().

Deprecated: 4.12: Gdk::GLTextureBuilder supersedes this function and provides extended functionality for creating GL textures.

Deprecated:: Gdk::GLTextureBuilder supercedes this function and provides extended functionality for creating GL textures.

Parameters

context	A `Gdk::GLContext`.
id	The ID of a texture that was created with context.
width	The nominal width of the texture.
height	The nominal height of the texture.
slot	A destroy notify that will be called when the GL resources are released.

Returns: A newly-created Gdk::Texture.

◆ get_type()

static GType Gdk::GLTexture::get_type ( )

static

Get the GType for this class, for use with the underlying GObject type system.

◆ gobj() [1/2]

GdkGLTexture * Gdk::GLTexture::gobj ( )

inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GdkGLTexture * Gdk::GLTexture::gobj ( ) const

inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GdkGLTexture * Gdk::GLTexture::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

◆ operator=()

GLTexture & Gdk::GLTexture::operator= ( GLTexture && src )

noexcept

◆ release()

void Gdk::GLTexture::release ( )

Releases the GL resources held by a Gdk::GLTexture.

The texture contents are still available via the Gdk::Texture::download() function, after this function has been called.

Friends And Related Symbol Documentation

◆ wrap()

Glib::RefPtr< Gdk::GLTexture > wrap	(	GdkGLTexture *	object,
		bool	take_copy = `false`
	)

A Glib::wrap() method for this object.