1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT
#[cfg(any(feature = "v4_10", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_10")))]
use crate::MemoryFormat;
use crate::Paintable;
use glib::{prelude::*, translate::*};
use std::{fmt, ptr};
glib::wrapper! {
/// [`Texture`][crate::Texture] is the basic element used to refer to pixel data.
///
/// It is primarily meant for pixel data that will not change over
/// multiple frames, and will be used for a long time.
///
/// There are various ways to create [`Texture`][crate::Texture] objects from a
/// [`gdk_pixbuf::Pixbuf`][crate::gdk_pixbuf::Pixbuf], or a Cairo surface, or other pixel data.
///
/// The ownership of the pixel data is transferred to the [`Texture`][crate::Texture]
/// instance; you can only make a copy of it, via [`TextureExtManual::download()`][crate::prelude::TextureExtManual::download()].
///
/// [`Texture`][crate::Texture] is an immutable object: That means you cannot change
/// anything about it other than increasing the reference count via
/// `GObject::Object::ref()`, and consequently, it is a thread-safe object.
///
/// This is an Abstract Base Class, you cannot instantiate it.
///
/// ## Properties
///
///
/// #### `height`
/// The height of the texture, in pixels.
///
/// Readable | Writeable | Construct Only
///
///
/// #### `width`
/// The width of the texture, in pixels.
///
/// Readable | Writeable | Construct Only
///
/// # Implements
///
/// [`TextureExt`][trait@crate::prelude::TextureExt], [`PaintableExt`][trait@crate::prelude::PaintableExt], [`trait@gio::prelude::IconExt`], [`trait@gio::prelude::LoadableIconExt`], [`TextureExtManual`][trait@crate::prelude::TextureExtManual]
#[doc(alias = "GdkTexture")]
pub struct Texture(Object<ffi::GdkTexture, ffi::GdkTextureClass>) @implements Paintable, gio::Icon, gio::LoadableIcon;
match fn {
type_ => || ffi::gdk_texture_get_type(),
}
}
impl Texture {
pub const NONE: Option<&'static Texture> = None;
/// Creates a new texture object representing the [`gdk_pixbuf::Pixbuf`][crate::gdk_pixbuf::Pixbuf].
///
/// This function is threadsafe, so that you can e.g. use GTask
/// and `Gio::Task::run_in_thread()` to avoid blocking the main thread
/// while loading a big image.
/// ## `pixbuf`
/// a [`gdk_pixbuf::Pixbuf`][crate::gdk_pixbuf::Pixbuf]
///
/// # Returns
///
/// a new [`Texture`][crate::Texture]
#[doc(alias = "gdk_texture_new_for_pixbuf")]
#[doc(alias = "new_for_pixbuf")]
pub fn for_pixbuf(pixbuf: &gdk_pixbuf::Pixbuf) -> Texture {
assert_initialized_main_thread!();
unsafe { from_glib_full(ffi::gdk_texture_new_for_pixbuf(pixbuf.to_glib_none().0)) }
}
/// Creates a new texture by loading an image from memory,
///
/// The file format is detected automatically. The supported formats
/// are PNG, JPEG and TIFF, though more formats might be available.
///
/// If [`None`] is returned, then @error will be set.
///
/// This function is threadsafe, so that you can e.g. use GTask
/// and `Gio::Task::run_in_thread()` to avoid blocking the main thread
/// while loading a big image.
/// ## `bytes`
/// a `GBytes` containing the data to load
///
/// # Returns
///
/// A newly-created [`Texture`][crate::Texture]
#[cfg(any(feature = "v4_6", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_6")))]
#[doc(alias = "gdk_texture_new_from_bytes")]
#[doc(alias = "new_from_bytes")]
pub fn from_bytes(bytes: &glib::Bytes) -> Result<Texture, glib::Error> {
assert_initialized_main_thread!();
unsafe {
let mut error = ptr::null_mut();
let ret = ffi::gdk_texture_new_from_bytes(bytes.to_glib_none().0, &mut error);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Creates a new texture by loading an image from a file.
///
/// The file format is detected automatically. The supported formats
/// are PNG, JPEG and TIFF, though more formats might be available.
///
/// If [`None`] is returned, then @error will be set.
///
/// This function is threadsafe, so that you can e.g. use GTask
/// and `Gio::Task::run_in_thread()` to avoid blocking the main thread
/// while loading a big image.
/// ## `file`
/// `GFile` to load
///
/// # Returns
///
/// A newly-created [`Texture`][crate::Texture]
#[doc(alias = "gdk_texture_new_from_file")]
#[doc(alias = "new_from_file")]
pub fn from_file(file: &impl IsA<gio::File>) -> Result<Texture, glib::Error> {
assert_initialized_main_thread!();
unsafe {
let mut error = ptr::null_mut();
let ret = ffi::gdk_texture_new_from_file(file.as_ref().to_glib_none().0, &mut error);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Creates a new texture by loading an image from a file.
///
/// The file format is detected automatically. The supported formats
/// are PNG, JPEG and TIFF, though more formats might be available.
///
/// If [`None`] is returned, then @error will be set.
///
/// This function is threadsafe, so that you can e.g. use GTask
/// and `Gio::Task::run_in_thread()` to avoid blocking the main thread
/// while loading a big image.
/// ## `path`
/// the filename to load
///
/// # Returns
///
/// A newly-created [`Texture`][crate::Texture]
#[cfg(any(feature = "v4_6", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_6")))]
#[doc(alias = "gdk_texture_new_from_filename")]
#[doc(alias = "new_from_filename")]
pub fn from_filename(path: impl AsRef<std::path::Path>) -> Result<Texture, glib::Error> {
assert_initialized_main_thread!();
unsafe {
let mut error = ptr::null_mut();
let ret =
ffi::gdk_texture_new_from_filename(path.as_ref().to_glib_none().0, &mut error);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Creates a new texture by loading an image from a resource.
///
/// The file format is detected automatically. The supported formats
/// are PNG and JPEG, though more formats might be available.
///
/// It is a fatal error if @resource_path does not specify a valid
/// image resource and the program will abort if that happens.
/// If you are unsure about the validity of a resource, use
/// [`from_file()`][Self::from_file()] to load it.
///
/// This function is threadsafe, so that you can e.g. use GTask
/// and `Gio::Task::run_in_thread()` to avoid blocking the main thread
/// while loading a big image.
/// ## `resource_path`
/// the path of the resource file
///
/// # Returns
///
/// A newly-created [`Texture`][crate::Texture]
#[doc(alias = "gdk_texture_new_from_resource")]
#[doc(alias = "new_from_resource")]
pub fn from_resource(resource_path: &str) -> Texture {
assert_initialized_main_thread!();
unsafe {
from_glib_full(ffi::gdk_texture_new_from_resource(
resource_path.to_glib_none().0,
))
}
}
}
unsafe impl Send for Texture {}
unsafe impl Sync for Texture {}
/// Trait containing all [`struct@Texture`] methods.
///
/// # Implementors
///
/// [`GLTexture`][struct@crate::GLTexture], [`MemoryTexture`][struct@crate::MemoryTexture], [`Texture`][struct@crate::Texture]
pub trait TextureExt: 'static {
/// Gets the memory format most closely associated with the data of
/// the texture.
///
/// Note that it may not be an exact match for texture data
/// stored on the GPU or with compression.
///
/// The format can give an indication about the bit depth and opacity
/// of the texture and is useful to determine the best format for
/// downloading the texture.
///
/// # Returns
///
/// the preferred format for the texture's data
#[cfg(any(feature = "v4_10", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_10")))]
#[doc(alias = "gdk_texture_get_format")]
#[doc(alias = "get_format")]
fn format(&self) -> MemoryFormat;
/// Returns the height of the @self, in pixels.
///
/// # Returns
///
/// the height of the [`Texture`][crate::Texture]
#[doc(alias = "gdk_texture_get_height")]
#[doc(alias = "get_height")]
fn height(&self) -> i32;
/// Returns the width of @self, in pixels.
///
/// # Returns
///
/// the width of the [`Texture`][crate::Texture]
#[doc(alias = "gdk_texture_get_width")]
#[doc(alias = "get_width")]
fn width(&self) -> i32;
/// Store the given @self to the @filename as a PNG file.
///
/// This is a utility function intended for debugging and testing.
/// If you want more control over formats, proper error handling or
/// want to store to a [`gio::File`][crate::gio::File] or other location, you might want to
/// use [`save_to_png_bytes()`][Self::save_to_png_bytes()] or look into the
/// gdk-pixbuf library.
/// ## `filename`
/// the filename to store to
///
/// # Returns
///
/// [`true`] if saving succeeded, [`false`] on failure.
#[doc(alias = "gdk_texture_save_to_png")]
fn save_to_png(
&self,
filename: impl AsRef<std::path::Path>,
) -> Result<(), glib::error::BoolError>;
#[cfg(any(feature = "v4_6", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_6")))]
#[doc(alias = "gdk_texture_save_to_png_bytes")]
fn save_to_png_bytes(&self) -> glib::Bytes;
#[cfg(any(feature = "v4_6", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_6")))]
#[doc(alias = "gdk_texture_save_to_tiff")]
fn save_to_tiff(
&self,
filename: impl AsRef<std::path::Path>,
) -> Result<(), glib::error::BoolError>;
#[cfg(any(feature = "v4_6", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_6")))]
#[doc(alias = "gdk_texture_save_to_tiff_bytes")]
fn save_to_tiff_bytes(&self) -> glib::Bytes;
}
impl<O: IsA<Texture>> TextureExt for O {
#[cfg(any(feature = "v4_10", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_10")))]
fn format(&self) -> MemoryFormat {
unsafe { from_glib(ffi::gdk_texture_get_format(self.as_ref().to_glib_none().0)) }
}
fn height(&self) -> i32 {
unsafe { ffi::gdk_texture_get_height(self.as_ref().to_glib_none().0) }
}
fn width(&self) -> i32 {
unsafe { ffi::gdk_texture_get_width(self.as_ref().to_glib_none().0) }
}
fn save_to_png(
&self,
filename: impl AsRef<std::path::Path>,
) -> Result<(), glib::error::BoolError> {
unsafe {
glib::result_from_gboolean!(
ffi::gdk_texture_save_to_png(
self.as_ref().to_glib_none().0,
filename.as_ref().to_glib_none().0
),
"Failed to save the texture as png"
)
}
}
#[cfg(any(feature = "v4_6", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_6")))]
fn save_to_png_bytes(&self) -> glib::Bytes {
unsafe {
from_glib_full(ffi::gdk_texture_save_to_png_bytes(
self.as_ref().to_glib_none().0,
))
}
}
#[cfg(any(feature = "v4_6", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_6")))]
fn save_to_tiff(
&self,
filename: impl AsRef<std::path::Path>,
) -> Result<(), glib::error::BoolError> {
unsafe {
glib::result_from_gboolean!(
ffi::gdk_texture_save_to_tiff(
self.as_ref().to_glib_none().0,
filename.as_ref().to_glib_none().0
),
"Failed to save the texture as tiff"
)
}
}
#[cfg(any(feature = "v4_6", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_6")))]
fn save_to_tiff_bytes(&self) -> glib::Bytes {
unsafe {
from_glib_full(ffi::gdk_texture_save_to_tiff_bytes(
self.as_ref().to_glib_none().0,
))
}
}
}
impl fmt::Display for Texture {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("Texture")
}
}