GI.GdkPixbuf.Structs.Pixdata

A Pixdata contains pixbuf information in a form suitable for serialization and streaming.

Exported types

newtype Pixdata

Constructors

Pixdata (ManagedPtr Pixdata)

Instances

WrappedPtr Pixdata

Methods

wrappedPtrCalloc :: IO (Ptr Pixdata)

wrappedPtrCopy :: Pixdata -> IO Pixdata

wrappedPtrFree :: Maybe (FunPtr (Ptr Pixdata -> IO ()))

(~) AttrOpTag tag AttrSet => Constructible Pixdata tag

Methods

new :: MonadIO m => (ManagedPtr Pixdata -> Pixdata) -> [AttrOp Pixdata tag] -> m Pixdata

((~) * info (ResolvePixdataMethod t Pixdata), MethodInfo * info Pixdata p) => IsLabel t (Pixdata -> p)

Methods

fromLabel :: Proxy# Symbol t -> Pixdata -> p

((~) * info (ResolvePixdataMethod t Pixdata), MethodInfo * info Pixdata p) => IsLabelProxy t (Pixdata -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> Pixdata -> p

HasAttributeList * Pixdata

((~) * signature (Text -> [PixdataDumpType] -> m String), MonadIO m) => MethodInfo * PixdataToCsourceMethodInfo Pixdata signature

Methods

overloadedMethod :: MethodProxy PixdataToCsourceMethodInfo Pixdata -> signature -> s

((~) * signature (m ByteString), MonadIO m) => MethodInfo * PixdataSerializeMethodInfo Pixdata signature

Methods

overloadedMethod :: MethodProxy PixdataSerializeMethodInfo Pixdata -> signature -> s

((~) * signature (ByteString -> m ()), MonadIO m) => MethodInfo * PixdataDeserializeMethodInfo Pixdata signature

Methods

overloadedMethod :: MethodProxy PixdataDeserializeMethodInfo Pixdata -> signature -> s

type AttributeList Pixdata

type AttributeList Pixdata

newZeroPixdata :: MonadIO m => m Pixdata

Construct a Pixdata struct initialized to zero.

noPixdata :: Maybe Pixdata

Methods

deserialize

data PixdataDeserializeMethodInfo

Instances

((~) * signature (ByteString -> m ()), MonadIO m) => MethodInfo * PixdataDeserializeMethodInfo Pixdata signature

Methods

overloadedMethod :: MethodProxy PixdataDeserializeMethodInfo Pixdata -> signature -> s

pixdataDeserialize

Arguments

:: (HasCallStack, MonadIO m)

=> Pixdata

pixdata: a Pixdata structure to be filled in.

-> ByteString

stream: stream of bytes containing a serialized Pixdata structure.

-> m ()

(Can throw GError)

Deprecated: (Since version 2.32)Use Resource instead.

Deserializes (reconstruct) a Pixdata structure from a byte stream. The byte stream consists of a straightforward writeout of the Pixdata fields in network byte order, plus the pixelData bytes the structure points to. The pixdata contents are reconstructed byte by byte and are checked for validity. This function may fail with PixbufErrorCorruptImage or PixbufErrorUnknownType.

serialize

data PixdataSerializeMethodInfo

Instances

((~) * signature (m ByteString), MonadIO m) => MethodInfo * PixdataSerializeMethodInfo Pixdata signature

Methods

overloadedMethod :: MethodProxy PixdataSerializeMethodInfo Pixdata -> signature -> s

pixdataSerialize

Arguments

:: (HasCallStack, MonadIO m)

=> Pixdata

pixdata: a valid Pixdata structure to serialize.

-> m ByteString

Returns: A newly-allocated string containing the serialized Pixdata structure.

Deprecated: (Since version 2.32)Use Resource instead.

Serializes a Pixdata structure into a byte stream. The byte stream consists of a straightforward writeout of the Pixdata fields in network byte order, plus the pixelData bytes the structure points to.

toCsource

data PixdataToCsourceMethodInfo

Instances

((~) * signature (Text -> [PixdataDumpType] -> m String), MonadIO m) => MethodInfo * PixdataToCsourceMethodInfo Pixdata signature

Methods

overloadedMethod :: MethodProxy PixdataToCsourceMethodInfo Pixdata -> signature -> s

pixdataToCsource

Arguments

:: (HasCallStack, MonadIO m)

=> Pixdata

pixdata: a Pixdata to convert to C source.

-> Text

name: used for naming generated data structures or macros.

-> [PixdataDumpType]

dumpType: a PixdataDumpType determining the kind of C source to be generated.

-> m String

Returns: a newly-allocated string containing the C source form of pixdata.

Deprecated: (Since version 2.32)Use Resource instead.

Generates C source code suitable for compiling images directly into programs.

gdk-pixbuf ships with a program called [gdk-pixbuf-csource][gdk-pixbuf-csource], which offers a command line interface to this function.

Properties

height

getPixdataHeight :: MonadIO m => Pixdata -> m Word32

pixdata_height :: AttrLabelProxy "height"

setPixdataHeight :: MonadIO m => Pixdata -> Word32 -> m ()

length

getPixdataLength :: MonadIO m => Pixdata -> m Int32

pixdata_length :: AttrLabelProxy "length"

setPixdataLength :: MonadIO m => Pixdata -> Int32 -> m ()

magic

getPixdataMagic :: MonadIO m => Pixdata -> m Word32

pixdata_magic :: AttrLabelProxy "magic"

setPixdataMagic :: MonadIO m => Pixdata -> Word32 -> m ()

pixdataType

getPixdataPixdataType :: MonadIO m => Pixdata -> m Word32

pixdata_pixdataType :: AttrLabelProxy "pixdataType"

setPixdataPixdataType :: MonadIO m => Pixdata -> Word32 -> m ()

pixelData

clearPixdataPixelData :: MonadIO m => Pixdata -> m ()

getPixdataPixelData :: MonadIO m => Pixdata -> m (Maybe (Ptr Word8))

pixdata_pixelData :: AttrLabelProxy "pixelData"

setPixdataPixelData :: MonadIO m => Pixdata -> Ptr Word8 -> m ()

rowstride

getPixdataRowstride :: MonadIO m => Pixdata -> m Word32

pixdata_rowstride :: AttrLabelProxy "rowstride"

setPixdataRowstride :: MonadIO m => Pixdata -> Word32 -> m ()

width

getPixdataWidth :: MonadIO m => Pixdata -> m Word32

pixdata_width :: AttrLabelProxy "width"

setPixdataWidth :: MonadIO m => Pixdata -> Word32 -> m ()