| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
GI.Vips.Flags
Description
Synopsis
- data ArgumentFlags
- data ForeignFlags
- data ForeignKeep
- data ForeignPngFilter
- data OperationFlags
Flags
ArgumentFlags
data ArgumentFlags Source #
Flags we associate with each object argument.
Have separate input & output flags. Both set is an error; neither set is OK.
Input gobjects are automatically reffed, output gobjects automatically ref us. We also automatically watch for "destroy" and unlink.
vIPSARGUMENTSETALWAYS is handy for arguments which are set from C. For
example, VipsImagewidth is a property that gives access to the Xsize
member of struct _VipsImage. We default its 'assigned' to TRUE
since the field is always set directly by C.
vIPSARGUMENTDEPRECATED arguments are not shown in help text, are not
looked for if required, are not checked for "have-been-set". You can
deprecate a required argument, but you must obviously add a new required
argument if you do.
Input args with vIPSARGUMENTMODIFY will be modified by the operation.
This is used for things like the in-place drawing operations.
vIPSARGUMENTNONHASHABLE stops the argument being used in hash and
equality tests. It's useful for arguments like revalidate which
control the behaviour of the operator cache.
Constructors
| ArgumentFlagsNone | no flags |
| ArgumentFlagsRequired | must be set in the constructor |
| ArgumentFlagsConstruct | can only be set in the constructor |
| ArgumentFlagsSetOnce | can only be set once |
| ArgumentFlagsSetAlways | don't do use-before-set checks |
| ArgumentFlagsInput | is an input argument (one we depend on) |
| ArgumentFlagsOutput | is an output argument (depends on us) |
| ArgumentFlagsDeprecated | just there for back-compat, hide |
| ArgumentFlagsModify | the input argument will be modified |
| ArgumentFlagsNonHashable | the argument is non-hashable |
| AnotherArgumentFlags Int | Catch-all for unknown values |
Instances
ForeignFlags
data ForeignFlags Source #
Some hints about the image loader.
VIPS_FOREIGN_PARTIAL means that the image can be read directly from the
file without needing to be unpacked to a temporary image first.
VIPS_FOREIGN_SEQUENTIAL means that the loader supports lazy reading, but
only top-to-bottom (sequential) access. Formats like PNG can read sets of
scanlines, for example, but only in order.
If neither PARTIAL or SEQUENTIAL is set, the loader only supports whole image read. Setting both PARTIAL and SEQUENTIAL is an error.
VIPS_FOREIGN_BIGENDIAN means that image pixels are most-significant byte
first. Depending on the native byte order of the host machine, you may
need to swap bytes. See vips_copy().
Constructors
| ForeignFlagsNone | no flags set |
| ForeignFlagsPartial | the image may be read lazilly |
| ForeignFlagsBigendian | image pixels are most-significant byte first |
| ForeignFlagsSequential | top-to-bottom lazy reading |
| ForeignFlagsAll | No description available in the introspection data. |
| AnotherForeignFlags Int | Catch-all for unknown values |
Instances
ForeignKeep
data ForeignKeep Source #
Which metadata to retain.
Constructors
| ForeignKeepNone | don't attach metadata |
| ForeignKeepExif | keep Exif metadata |
| ForeignKeepXmp | keep XMP metadata |
| ForeignKeepIptc | keep IPTC metadata |
| ForeignKeepIcc | keep ICC metadata |
| ForeignKeepOther | keep other metadata (e.g. PNG comments and some TIFF tags) |
| ForeignKeepAll | keep all metadata |
| AnotherForeignKeep Int | Catch-all for unknown values |
Instances
ForeignPngFilter
data ForeignPngFilter Source #
http://www.w3.org/TR/PNG-Filters.html The values mirror those of png.h in libpng.
Constructors
| ForeignPngFilterNone | no filtering |
| ForeignPngFilterSub | difference to the left |
| ForeignPngFilterUp | difference up |
| ForeignPngFilterAvg | average of left and up |
| ForeignPngFilterPaeth | pick best neighbor predictor automatically |
| ForeignPngFilterAll | adaptive |
| AnotherForeignPngFilter Int | Catch-all for unknown values |
Instances
OperationFlags
data OperationFlags Source #
Flags we associate with an operation.
vIPSOPERATIONSEQUENTIAL means that the operation works like vips_conv():
it can process images top-to-bottom with only small non-local
references.
Every scan-line must be requested, you are not allowed to skip ahead, but as a special case, the very first request can be for a region not at the top of the image. In this case, the first part of the image will be read and discarded
Every scan-line must be requested, you are not allowed to skip ahead, but as a special case, the very first request can be for a region not at the top of the image. In this case, the first part of the image will be read and discarded
vIPSOPERATIONNOCACHE means that the operation must not be cached by
vips.
vIPSOPERATIONDEPRECATED means this is an old operation kept in vips for
compatibility only and should be hidden from users.
vIPSOPERATIONUNTRUSTED means the operation depends on external libraries
which have not been hardened against attack. It should probably not be used
on untrusted input. Use blockUntrustedSet to block all
untrusted operations.
vIPSOPERATIONBLOCKED means the operation is prevented from executing. Use
operationBlockSet to enable and disable groups of operations.
vIPSOPERATIONREVALIDATE force the operation to run, updating the cache
with the new value. This is used by eg. VipsForeignLoad to implement the
"revalidate" argument.
Constructors
| OperationFlagsNone | no flags |
| OperationFlagsSequential | can work sequentially with a small buffer |
| OperationFlagsSequentialUnbuffered | No description available in the introspection data. |
| OperationFlagsNocache | must not be cached |
| OperationFlagsDeprecated | a compatibility thing |
| OperationFlagsUntrusted | not hardened for untrusted input |
| OperationFlagsBlocked | prevent this operation from running |
| OperationFlagsRevalidate | force the operation to run |
| AnotherOperationFlags Int | Catch-all for unknown values |