PixbufFormatProtocol

public protocol PixbufFormatProtocol

A GdkPixbufFormat contains information about the image format accepted by a module.

Only modules should access the fields directly, applications should use the gdk_pixbuf_format_* family of functions.

The PixbufFormatProtocol protocol exposes the methods and properties of an underlying GdkPixbufFormat instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see PixbufFormat. Alternatively, use PixbufFormatRef as a lighweight, unowned reference if you already have an instance you just want to use.

Show on GitHub
  • ptr

    Untyped pointer to the underlying GdkPixbufFormat instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
    Show on GitHub
  • pixbuf_format_ptr Default implementation

    Typed pointer to the underlying GdkPixbufFormat instance.

    Default Implementation

    Return the stored, untyped pointer as a typed pointer to the GdkPixbufFormat instance.

    Declaration

    Swift

    var pixbuf_format_ptr: UnsafeMutablePointer<GdkPixbufFormat>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to PixbufFormatProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

PixbufFormat Record: PixbufFormatProtocol extension (methods and fields)

  • copy() Extension method

    Creates a copy of format.

    Declaration

    Swift

    @inlinable
func copy() -> GdkPixBuf.PixbufFormatRef!
    Show on GitHub
  • free() Extension method

    Frees the resources allocated when copying a GdkPixbufFormat using gdk_pixbuf_format_copy()

    Declaration

    Swift

    @inlinable
func free()
    Show on GitHub
  • getDescription() Extension method

    Returns a description of the format.

    Declaration

    Swift

    @inlinable
func getDescription() -> String!
    Show on GitHub
  • getExtensions() Extension method

    Returns the filename extensions typically used for files in the given format.

    Declaration

    Swift

    @inlinable
func getExtensions() -> UnsafeMutablePointer<UnsafeMutablePointer<gchar>?>!
    Show on GitHub
  • getLicense() Extension method

    Returns information about the license of the image loader for the format.

    The returned string should be a shorthand for a well known license, e.g. “LGPL”, “GPL”, “QPL”, “GPL/QPL”, or “other” to indicate some other license.

    Declaration

    Swift

    @inlinable
func getLicense() -> String!
    Show on GitHub
  • getMimeTypes() Extension method

    Returns the mime types supported by the format.

    Declaration

    Swift

    @inlinable
func getMimeTypes() -> UnsafeMutablePointer<UnsafeMutablePointer<gchar>?>!
    Show on GitHub
  • getName() Extension method

    Returns the name of the format.

    Declaration

    Swift

    @inlinable
func getName() -> String!
    Show on GitHub

  • Returns TRUE if the save option specified by option_key is supported when saving a pixbuf using the module implementing format.

    See gdk_pixbuf_save() for more information about option keys.

    Declaration

    Swift

    @inlinable
func isSaveOptionSupported(optionKey: UnsafePointer<gchar>!) -> Bool
    Show on GitHub
  • set(disabled:) Extension method

    Disables or enables an image format.

    If a format is disabled, GdkPixbuf won’t use the image loader for this format to load images.

    Applications can use this to avoid using image loaders with an inappropriate license, see gdk_pixbuf_format_get_license().

    Declaration

    Swift

    @inlinable
func set(disabled: Bool)
    Show on GitHub
  • description Extension method

    Returns a description of the format.

    Declaration

    Swift

    @inlinable
var description: String! { get }
    Show on GitHub
  • extensions Extension method

    Returns the filename extensions typically used for files in the given format.

    Declaration

    Swift

    @inlinable
var extensions: UnsafeMutablePointer<UnsafeMutablePointer<gchar>?>! { get }
    Show on GitHub
  • isDisabled Extension method

    Returns whether this image format is disabled.

    See gdk_pixbuf_format_set_disabled().

    Declaration

    Swift

    @inlinable
var isDisabled: Bool { get }
    Show on GitHub
  • isScalable Extension method

    Returns whether this image format is scalable.

    If a file is in a scalable format, it is preferable to load it at the desired size, rather than loading it at the default size and scaling the resulting pixbuf to the desired size.

    Declaration

    Swift

    @inlinable
var isScalable: Bool { get }
    Show on GitHub
  • isWritable Extension method

    Returns whether pixbufs can be saved in the given format.

    Declaration

    Swift

    @inlinable
var isWritable: Bool { get }
    Show on GitHub
  • license Extension method

    Returns information about the license of the image loader for the format.

    The returned string should be a shorthand for a well known license, e.g. “LGPL”, “GPL”, “QPL”, “GPL/QPL”, or “other” to indicate some other license.

    Declaration

    Swift

    @inlinable
var license: String! { get }
    Show on GitHub
  • mimeTypes Extension method

    Returns the mime types supported by the format.

    Declaration

    Swift

    @inlinable
var mimeTypes: UnsafeMutablePointer<UnsafeMutablePointer<gchar>?>! { get }
    Show on GitHub
  • name Extension method

    Returns the name of the format.

    Declaration

    Swift

    @inlinable
var name: String! { get }
    Show on GitHub
  • _name Extension method

    the name of the image format

    Declaration

    Swift

    @inlinable
var _name: UnsafeMutablePointer<gchar>! { get set }
    Show on GitHub
  • signature Extension method

    the signature of the module

    Declaration

    Swift

    @inlinable
var signature: PixbufModulePatternRef! { get set }
    Show on GitHub
  • domain Extension method

    the message domain for the description

    Declaration

    Swift

    @inlinable
var domain: UnsafeMutablePointer<gchar>! { get set }
    Show on GitHub
  • _description Extension method

    a description of the image format

    Declaration

    Swift

    @inlinable
var _description: UnsafeMutablePointer<gchar>! { get set }
    Show on GitHub
  • _mimeTypes Extension method

    the MIME types for the image format

    Declaration

    Swift

    @inlinable
var _mimeTypes: UnsafeMutablePointer<UnsafeMutablePointer<gchar>?>! { get set }
    Show on GitHub
  • _extensions Extension method

    typical filename extensions for the image format

    Declaration

    Swift

    @inlinable
var _extensions: UnsafeMutablePointer<UnsafeMutablePointer<gchar>?>! { get set }
    Show on GitHub
  • flags Extension method

    a combination of GdkPixbufFormatFlags

    Declaration

    Swift

    @inlinable
var flags: guint32 { get set }
    Show on GitHub
  • disabled Extension method

    a boolean determining whether the loader is disabled`

    Declaration

    Swift

    @inlinable
var disabled: gboolean { get set }
    Show on GitHub
  • _license Extension method

    a string containing license information, typically set to shorthands like “GPL”, “LGPL”, etc.

    Declaration

    Swift

    @inlinable
var _license: UnsafeMutablePointer<gchar>! { get set }
    Show on GitHub