GI.GdkPixbuf.Structs.PixbufFormat

No description available in the introspection data.

Exported types

newtype PixbufFormat

Memory-managed wrapper type.

Constructors

PixbufFormat (ManagedPtr PixbufFormat)

Instances

Eq PixbufFormat

Defined in GI.GdkPixbuf.Structs.PixbufFormat

Methods

(==) :: PixbufFormat -> PixbufFormat -> Bool

(/=) :: PixbufFormat -> PixbufFormat -> Bool

IsGValue PixbufFormat

Convert PixbufFormat to and from GValue with toGValue and fromGValue.

Defined in GI.GdkPixbuf.Structs.PixbufFormat

Methods

toGValue :: PixbufFormat -> IO GValue

fromGValue :: GValue -> IO PixbufFormat

BoxedObject PixbufFormat

Defined in GI.GdkPixbuf.Structs.PixbufFormat

Methods

boxedType :: PixbufFormat -> IO GType

noPixbufFormat :: Maybe PixbufFormat

A convenience alias for Nothing :: Maybe PixbufFormat.

Methods

Overloaded methods

copy

pixbufFormatCopy

Arguments

:: (HasCallStack, MonadIO m)

=> PixbufFormat

format: a PixbufFormat

-> m PixbufFormat

Returns: the newly allocated copy of a PixbufFormat. Use pixbufFormatFree to free the resources when done

Creates a copy of format

Since: 2.22

free

pixbufFormatFree

Arguments

:: (HasCallStack, MonadIO m)

=> PixbufFormat

format: a PixbufFormat

-> m ()

Frees the resources allocated when copying a PixbufFormat using pixbufFormatCopy

Since: 2.22

getDescription

pixbufFormatGetDescription

Arguments

:: (HasCallStack, MonadIO m)

=> PixbufFormat

format: a PixbufFormat

-> m Text

Returns: a description of the format.

Returns a description of the format.

Since: 2.2

getExtensions

pixbufFormatGetExtensions

Arguments

:: (HasCallStack, MonadIO m)

=> PixbufFormat

format: a PixbufFormat

-> m [Text]

Returns: a Nothing-terminated array of filename extensions which must be freed with strfreev when it is no longer needed.

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

Since: 2.2

getLicense

pixbufFormatGetLicense

Arguments

:: (HasCallStack, MonadIO m)

=> PixbufFormat

format: a PixbufFormat

-> m Text

Returns: a string describing the license of format.

Returns information about the license of the image loader for the format. The returned string should be a shorthand for a wellknown license, e.g. "LGPL", "GPL", "QPL", "GPL/QPL", or "other" to indicate some other license. This string should be freed with free when it's no longer needed.

Since: 2.6

getMimeTypes

pixbufFormatGetMimeTypes

Arguments

:: (HasCallStack, MonadIO m)

=> PixbufFormat

format: a PixbufFormat

-> m [Text]

Returns: a Nothing-terminated array of mime types which must be freed with strfreev when it is no longer needed.

Returns the mime types supported by the format.

Since: 2.2

getName

pixbufFormatGetName

Arguments

:: (HasCallStack, MonadIO m)

=> PixbufFormat

format: a PixbufFormat

-> m Text

Returns: the name of the format.

Returns the name of the format.

Since: 2.2

isDisabled

pixbufFormatIsDisabled

Arguments

:: (HasCallStack, MonadIO m)

=> PixbufFormat

format: a PixbufFormat

-> m Bool

Returns: whether this image format is disabled.

Returns whether this image format is disabled. See pixbufFormatSetDisabled.

Since: 2.6

isSaveOptionSupported

pixbufFormatIsSaveOptionSupported

Arguments

:: (HasCallStack, MonadIO m)

=> PixbufFormat

format: a PixbufFormat

-> Text

optionKey: the name of an option

-> m Bool

Returns: True if the specified option is supported

Returns True if the save option specified by optionKey is supported when saving a pixbuf using the module implementing format. See gdk_pixbuf_save() for more information about option keys.

Since: 2.36

isScalable

pixbufFormatIsScalable

Arguments

:: (HasCallStack, MonadIO m)

=> PixbufFormat

format: a PixbufFormat

-> m Bool

Returns: whether this image format is scalable.

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.

Since: 2.6

isWritable

pixbufFormatIsWritable

Arguments

:: (HasCallStack, MonadIO m)

=> PixbufFormat

format: a PixbufFormat

-> m Bool

Returns: whether pixbufs can be saved in the given format.

Returns whether pixbufs can be saved in the given format.

Since: 2.2

setDisabled

pixbufFormatSetDisabled

Arguments

:: (HasCallStack, MonadIO m)

=> PixbufFormat

format: a PixbufFormat

-> Bool

disabled: True to disable the format format

-> m ()

Disables or enables an image format. If a format is disabled, gdk-pixbuf 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 pixbufFormatGetLicense.

Since: 2.6