Aardvark.Base


PixImage

Constructors

ConstructorDescription
new()
Signature: unit -> unit
new(format)
Signature: format:Format -> unit

Instance members

Instance memberDescription
Array
Signature: Array
Modifiers: abstract
AspectRatio
Signature: float

Width/height.

AsPixImage()
Signature: unit -> PixImage<'T>
Type parameters: 'T
ChannelCount
Signature: int
Modifiers: abstract
ChannelCountL
Signature: int64
Modifiers: abstract
CopyChannelTo(channelIndex, target)
Signature: (channelIndex:int64 * target:Matrix<'Tv>) -> unit
Modifiers: abstract
Type parameters: 'Tv
CopyToPixImage()
Signature: unit -> PixImage
Modifiers: abstract
CopyToPixImageWithCanonicalDenseLayout()
Signature: unit -> PixImage
Modifiers: abstract
Data
Signature: Array
Modifiers: abstract
Info
Signature: PixImageInfo
IntStride
Signature: int
Modifiers: abstract
NumberOfPixels
Signature: int

Size.X * Size.Y.

Op(op)
Signature: op:IPixOp<'Tr> -> 'Tr
Modifiers: abstract
Type parameters: 'Tr
PixFormat
Signature: PixFormat
Modifiers: abstract
RemappedPixImage(xMap, yMap, ip)
Signature: (xMap:Matrix<float32> * yMap:Matrix<float32> * ip:ImageInterpolation) -> PixImage
Modifiers: abstract
ResizedPixImage(size, ip)
Signature: (size:V2i * ip:ImageInterpolation) -> PixImage
Modifiers: abstract
RotatedPixImage(...)
Signature: (angleInRadiansCCW:float * resize:bool * ip:ImageInterpolation) -> PixImage
Modifiers: abstract
SaveAsImage(...)
Signature: (stream:Stream * fileFormat:PixFileFormat * options:PixSaveOptions * qualityLevel:int) -> unit
SaveAsImage(...)
Signature: (filename:string * fileFormat:PixFileFormat * options:PixSaveOptions * qualityLevel:int) -> unit
SaveAsImage(filename)
Signature: filename:string -> unit

Automatically detects file format from filename extension. Throws exception if file name does not end in known format extension.

ScaledPixImage(scaleFactor, ip)
Signature: (scaleFactor:V2d * ip:ImageInterpolation) -> PixImage
Modifiers: abstract
Size
Signature: V2i
Modifiers: abstract
SizeL
Signature: V2l
Modifiers: abstract
ToBitmap()
Signature: unit -> Bitmap
ToCanonicalDenseLayout()
Signature: unit -> PixImage
Modifiers: abstract
ToMemoryStream(...)
Signature: (fileFormat:PixFileFormat * options:PixSaveOptions * qualityLevel:int) -> MemoryStream
ToMemoryStream(qualityLevel)
Signature: qualityLevel:int -> MemoryStream
ToPixImage()
Signature: unit -> PixImage<'T1>
Modifiers: abstract
Type parameters: 'T1
ToPixImage(format)
Signature: format:Format -> PixImage<'T>
Type parameters: 'T
ToPixImage(format)
Signature: format:Format -> PixImage
Modifiers: abstract
Transformed(trafo)
Signature: trafo:ImageTrafo -> PixImage
Modifiers: abstract
Visit(visitor)
Signature: visitor:IPixImageVisitor<'T> -> 'T
Modifiers: abstract
Type parameters: 'T
VolumeInfo
Signature: VolumeInfo
Modifiers: abstract

Static members

Static memberDescription
CompressPixels(pixImage, bitImage)
Signature: (pixImage:PixImage<byte> * bitImage:PixImage<byte>) -> unit

Compress BW images from 1 bit per byte to 8 bits per byte.

Create(pixFormat, sx, sy, ch)
Signature: (pixFormat:PixFormat * sx:int64 * sy:int64 * ch:int64) -> PixImage
Create(pixFormat, sx, sy)
Signature: (pixFormat:PixFormat * sx:int64 * sy:int64) -> PixImage
Create(array, format, sx, sy, ch)
Signature: (array:Array * format:Format * sx:int64 * sy:int64 * ch:int64) -> PixImage
Create(array, format, sx, sy)
Signature: (array:Array * format:Format * sx:int64 * sy:int64) -> PixImage
Create(filename, options)
Signature: (filename:string * options:PixLoadOptions) -> PixImage

Create a new image from the file. This is the standard way of loading images if they do not need to be converted to a specific format.

Create(filenames)
Signature: filenames:IEnumerable<string> -> IEnumerable<PixImage>
Create(stream, options)
Signature: (stream:Stream * options:PixLoadOptions) -> PixImage
Create(bitmap)
Signature: bitmap:Bitmap -> PixImage
CreateCubeMapSide(...)
Signature: (cubeSide:int * size:int * channelCount:int * vec_colFun:Func<V3d,'Tcol>) -> PixImage<'T>
Type parameters: 'T, 'Tcol

Returns 6 square PixImages of the supplied size containing the textures of a cube map in the following arrangement (right-handed): UV -> | | 4 | v | 0 | 1 | 2 | 3 | | 5 | XN YP XP YN ZP ZN

CreateCylinder(...)
Signature: (width:int * height:int * channelCount:int * phi_theta_colFun:Func<float,float,'Tcol>) -> PixImage<'T>
Type parameters: 'T, 'Tcol
CreateDome(...)
Signature: (width:int * height:int * channelCount:int * phi_theta_colFun:Func<float,float,'Tcol>) -> PixImage<'T>
Type parameters: 'T, 'Tcol
CreateRaw(filename, options)
Signature: (filename:string * options:PixLoadOptions) -> PixImage
CreateRaw(stream, options)
Signature: (stream:Stream * options:PixLoadOptions) -> PixImage
CreateVolume(size)
Signature: size:V3i -> Volume<'T>
Type parameters: 'T
CreateVolume(size)
Signature: size:V3l -> Volume<'T>
Type parameters: 'T
CreateVolume(sizeX, sizeY, channelCount)
Signature: (sizeX:int64 * sizeY:int64 * channelCount:int64) -> Volume<'T>
Type parameters: 'T
ExpandPixels(bitImage, pixImage)
Signature: (bitImage:PixImage<byte> * pixImage:PixImage<byte>) -> unit

Expand BW images from 8 bit per byte to 1 bit per byte.

GetPreferredExtensionOfFormat(format)
Signature: format:PixFileFormat -> string
InfoFromFileName(fileName, options)
Signature: (fileName:string * options:PixLoadOptions) -> PixImageInfo

Gets info about a PixImage without loading the entire image into memory.

InfoFromFileNameBitmap(...)
Signature: (fileName:string * options:PixLoadOptions) -> PixImageInfo

Gets info about a PixImage without loading the entire image into memory.

InfoFromFileNameDevil(fileName, options)
Signature: (fileName:string * options:PixLoadOptions) -> PixImageInfo

Gets info about a PixImage without loading the entire image into memory.

InitDevil()
Signature: unit -> unit
NormalizedFileName(fileName, format)
Signature: (fileName:string * format:PixFileFormat) -> string

Makes the file name valid for the given format. E.g. for PixFileFormat.Png: "foo.png" -> "foo.png", "foo" -> "foo.png", "foo.jpg" -> "foo.jpg.png", "foo.2011" -> "foo.2011.png",

RegisterLoadingLib(...)
Signature: (fileLoad:Func<string,PixLoadOptions,PixImage> * streamLoad:Func<Stream,PixLoadOptions,PixImage> * fileSave:Func<string,PixSaveOptions,PixFileFormat,int,PixImage,bool> * streamSave:Func<Stream,PixSaveOptions,PixFileFormat,int,PixImage,bool> * imageInfo:Func<string,PixImageInfo>) -> unit
Fork me on GitHub