forked from AuroraMiddleware/gtk
c9f54ca371
The API docs outline why quite well. This should make it possible to do saving of textures to image files without any private API with the same featureset that GTK uses. Also remove the gsktextureprivate.h include where gdk_texture_get_format() was the only reason for it.
109 lines
4.3 KiB
C
109 lines
4.3 KiB
C
/* gdktexture.h
|
|
*
|
|
* Copyright 2016 Benjamin Otte
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef __GDK_TEXTURE_H__
|
|
#define __GDK_TEXTURE_H__
|
|
|
|
#if !defined (__GDK_H_INSIDE__) && !defined (GTK_COMPILATION)
|
|
#error "Only <gdk/gdk.h> can be included directly."
|
|
#endif
|
|
|
|
#include <gdk/gdkversionmacros.h>
|
|
#include <gdk/gdkenums.h>
|
|
#include <gdk/gdktypes.h>
|
|
#include <gdk-pixbuf/gdk-pixbuf.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
#define GDK_TYPE_TEXTURE (gdk_texture_get_type ())
|
|
|
|
#define GDK_TEXTURE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GDK_TYPE_TEXTURE, GdkTexture))
|
|
#define GDK_IS_TEXTURE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GDK_TYPE_TEXTURE))
|
|
|
|
typedef struct _GdkTextureClass GdkTextureClass;
|
|
|
|
#define GDK_TEXTURE_ERROR (gdk_texture_error_quark ())
|
|
|
|
GDK_AVAILABLE_IN_4_6
|
|
GQuark gdk_texture_error_quark (void);
|
|
|
|
/**
|
|
* GdkTextureError:
|
|
* @GDK_TEXTURE_ERROR_TOO_LARGE: Not enough memory to handle this image
|
|
* @GDK_TEXTURE_ERROR_CORRUPT_IMAGE: The image data appears corrupted
|
|
* @GDK_TEXTURE_ERROR_UNSUPPORTED_CONTENT: The image contains features
|
|
* that cannot be loaded
|
|
* @GDK_TEXTURE_ERROR_UNSUPPORTED_FORMAT: The image format is not supported
|
|
*
|
|
* Possible errors that can be returned by `GdkTexture` constructors.
|
|
*
|
|
* Since: 4.6
|
|
*/
|
|
typedef enum
|
|
{
|
|
GDK_TEXTURE_ERROR_TOO_LARGE,
|
|
GDK_TEXTURE_ERROR_CORRUPT_IMAGE,
|
|
GDK_TEXTURE_ERROR_UNSUPPORTED_CONTENT,
|
|
GDK_TEXTURE_ERROR_UNSUPPORTED_FORMAT,
|
|
} GdkTextureError;
|
|
|
|
GDK_AVAILABLE_IN_ALL
|
|
GType gdk_texture_get_type (void) G_GNUC_CONST;
|
|
|
|
GDK_AVAILABLE_IN_ALL
|
|
GdkTexture * gdk_texture_new_for_pixbuf (GdkPixbuf *pixbuf);
|
|
GDK_AVAILABLE_IN_ALL
|
|
GdkTexture * gdk_texture_new_from_resource (const char *resource_path);
|
|
GDK_AVAILABLE_IN_ALL
|
|
GdkTexture * gdk_texture_new_from_file (GFile *file,
|
|
GError **error);
|
|
GDK_AVAILABLE_IN_4_6
|
|
GdkTexture * gdk_texture_new_from_filename (const char *path,
|
|
GError **error);
|
|
GDK_AVAILABLE_IN_4_6
|
|
GdkTexture * gdk_texture_new_from_bytes (GBytes *bytes,
|
|
GError **error);
|
|
|
|
GDK_AVAILABLE_IN_ALL
|
|
int gdk_texture_get_width (GdkTexture *texture) G_GNUC_PURE;
|
|
GDK_AVAILABLE_IN_ALL
|
|
int gdk_texture_get_height (GdkTexture *texture) G_GNUC_PURE;
|
|
GDK_AVAILABLE_IN_4_10
|
|
GdkMemoryFormat gdk_texture_get_format (GdkTexture *self) G_GNUC_PURE;
|
|
|
|
GDK_AVAILABLE_IN_ALL
|
|
void gdk_texture_download (GdkTexture *texture,
|
|
guchar *data,
|
|
gsize stride);
|
|
GDK_AVAILABLE_IN_ALL
|
|
gboolean gdk_texture_save_to_png (GdkTexture *texture,
|
|
const char *filename);
|
|
GDK_AVAILABLE_IN_4_6
|
|
GBytes * gdk_texture_save_to_png_bytes (GdkTexture *texture);
|
|
GDK_AVAILABLE_IN_4_6
|
|
gboolean gdk_texture_save_to_tiff (GdkTexture *texture,
|
|
const char *filename);
|
|
GDK_AVAILABLE_IN_4_6
|
|
GBytes * gdk_texture_save_to_tiff_bytes (GdkTexture *texture);
|
|
|
|
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GdkTexture, g_object_unref)
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __GDK_TEXTURE_H__ */
|