PsdImage Class
A PSD image.
Inheritance Hierarchy

Namespace: Aspose.PSD.FileFormats.Psd
Assembly: Aspose.PSD (in Aspose.PSD.dll) Version: 20.6
Syntax
public sealed class PsdImage : RasterCachedImage

The PsdImage type exposes the following members.

Constructors
  NameDescription
Public methodPsdImage(Stream)
Initializes a new instance of the PsdImage class from specified path from raster image (not psd image in stream). Used to initialize psd image with default parameters - Color mode - rgb, 4 channels, 8 bit per channel, Compression - Raw.
Public methodPsdImage(String)
Initializes a new instance of the PsdImage class from specified path from raster image (not psd image in path). Used to initialize psd image with default parameters - Color mode - rgb, 4 channels, 8 bit per channel, Compression - Raw.
Public methodPsdImage(RasterImage)
Initializes a new instance of the PsdImage class from existing raster image (not psd image) with RGB color mode with 4 channels 8 bit/channel and no compression.
Public methodPsdImage(Int32, Int32)
Initializes a new instance of the PsdImage class with specified width and height. Used to initialize empty psd image.
Public methodPsdImage(Stream, ColorModes, Int16, Int16, Int32, CompressionMethod)
Initializes a new instance of the PsdImage class from specified path from raster image (not psd image in stream) with constructor parameters.
Public methodPsdImage(String, ColorModes, Int16, Int16, Int32, CompressionMethod)
Initializes a new instance of the PsdImage class from specified path from raster image (not psd image in path) with constructor parameters.
Public methodPsdImage(RasterImage, ColorModes, Int16, Int16, Int32, CompressionMethod)
Initializes a new instance of the PsdImage class from existing raster image (not psd image) with constructor parameters.
Public methodPsdImage(Int32, Int32, IColorPalette, ColorModes, Int16, Int16, Int32, CompressionMethod)
Initializes a new instance of the PsdImage class with specified width,height, paletter, color mode, channels count and channels bit-length and specified compression mode parameters. Used to initialize empty psd image.
Properties
  NameDescription
Public propertyActiveLayer
Gets or sets the active layer.
Public propertyAutoAdjustPalette
Gets or sets a value indicating whether automatic adjust palette.
(Inherited from Image.)
Public propertyBackgroundColor
Gets or sets a value for the background color.
(Inherited from Image.)
Public propertyBitsPerChannel
Gets the bits per channel.
Public propertyBitsPerPixel
Gets the image bits per pixel count.
(Overrides ImageBitsPerPixel.)
Public propertyBounds
Gets the image bounds.
(Inherited from Image.)
Public propertyBufferSizeHint
Gets or sets the buffer size hint which is defined max allowed size for all internal buffers.
(Inherited from Image.)
Public propertyChannelsCount
Gets the PSD channels count.
Public propertyCmykColorProfile
Gets or sets the CMYK color profile for CMYK PSD images. Must be in pair with RgbColorProfile for correct color conversion.
Public propertyColorMode
Gets or sets the color mode.
Public propertyCompression
Gets the compression method.
Public propertyContainer
Gets the Image container.
(Inherited from Image.)
Public propertyDataStreamContainer
Gets the object's data stream.
(Inherited from DataStreamSupporter.)
Public propertyDisposed
Gets a value indicating whether this instance is disposed.
(Inherited from DisposableObject.)
Public propertyFileFormat
Gets a value of file format
(Overrides ImageFileFormat.)
Public propertyCode exampleGlobalAngle
Gets or sets the global angle.
Public propertyGlobalLayerMaskInfo
Gets the global layer mask info.
Public propertyGlobalLayerResources
Gets or sets the global layer resources.
Public propertyGrayColorProfile
Gets or sets the GRAY (monochrome) color profile for Grayscale PSD images.
Public propertyHasAlpha
Gets or sets the vertical resolution, in pixels per inch, of this RasterImage.
(Overrides RasterImageHasAlpha.)
Public propertyHasBackgroundColor
Gets or sets a value indicating whether image has background color.
(Inherited from Image.)
Public propertyHasTransparencyData
Gets or sets a value indicating whether first alpha channel contains the transparency data for the merged result when specifying layers data.
Public propertyHasTransparentColor
Gets a value indicating whether image has transparent color.
(Inherited from RasterImage.)
Public propertyHeight
Gets the image height.
(Overrides ImageHeight.)
Public propertyHorizontalResolution
Gets or sets the horizontal resolution, in pixels per inch, of this PsdImage.
(Overrides RasterImageHorizontalResolution.)
Public propertyImageOpacity
Gets opacity of this image.
(Inherited from RasterImage.)
Public propertyImageResources
Gets or sets the PSD image resources.
Public propertyInterruptMonitor
Gets or sets the interrupt monitor.
(Inherited from Image.)
Public propertyIsCached
Gets a value indicating whether image data is cached currently.
(Inherited from RasterCachedImage.)
Public propertyIsFlatten
Gets a value indicating whether psd image is flattened.
Public propertyIsRawDataAvailable
Gets a value indicating whether raw data loading is available.
(Inherited from RasterImage.)
Public propertyLayers
Gets or sets the PSD layers.
Public propertyLinkedLayersManager
Gets the linked layers manager.
Public propertyPalette
Gets or sets the color palette.
(Inherited from Image.)
Public propertyPremultiplyComponents
Gets or sets a value indicating whether the image components must be premultiplied.
(Inherited from RasterImage.)
Public propertyRawCustomColorConverter
Gets or sets the custom color converter
(Inherited from RasterImage.)
Public propertyRawDataFormat
Gets the raw data format.
(Overrides RasterImageRawDataFormat.)
Public propertyRawDataSettings
Gets the current raw data settings. Note when using these settings the data loads without conversion.
(Inherited from RasterImage.)
Public propertyRawFallbackIndex
Gets or sets the fallback index to use when palette index is out of bounds
(Inherited from RasterImage.)
Public propertyRawIndexedColorConverter
Gets or sets the indexed color converter
(Inherited from RasterImage.)
Public propertyRawLineSize
Gets the raw line size in bytes.
(Inherited from RasterImage.)
Public propertyRgbColorProfile
Gets or sets the RGB color profile for CMYK PSD images. Must be in pair with CmykColorProfile for correct color conversion.
Public propertySize
Gets the image size.
(Inherited from Image.)
Public propertyTransparentColor
Gets the image transparent color.
(Inherited from RasterImage.)
Public propertyUpdateXmpData
Gets or sets a value indicating whether to update the XMP metadata.
(Inherited from RasterImage.)
Public propertyUseRawData
Gets or sets a value indicating whether to use raw data loading when the raw data loading is available.
(Inherited from RasterImage.)
Public propertyVersion
Gets or sets the version.
Public propertyVerticalResolution
Gets or sets the vertical resolution, in pixels per inch, of this PsdImage.
(Overrides RasterImageVerticalResolution.)
Public propertyWidth
Gets the image width.
(Overrides ImageWidth.)
Public propertyXmpData
Gets or sets the XMP metadata.
(Overrides RasterImageXmpData.)
Methods
  NameDescription
Public methodCode exampleAddBlackWhiteAdjustmentLayer
Adds the black white adjustment layer.
Public methodAddBrightnessContrastAdjustmentLayer
Adds the brightness/contrast adjustment layer.
Public methodAddChannelMixerAdjustmentLayer
Adds the channel mixer adjustment layer with default parameters
Public methodAddColorBalanceAdjustmentLayer
Adds the color balance adjustment layer.
Public methodAddCurvesAdjustmentLayer
Adds the Curves Adjustment layer.
Public methodAddExposureAdjustmentLayer
Adds the exposure adjustment layer.
Public methodAddExposureLayer
Adds the exposure adjustment layer.
Public methodAddHueSaturationAdjustmentLayer
Adds the hue/saturation adjustment layer.
Public methodCode exampleAddInvertAdjustmentLayer
Adds an invert adjustment layer.
Public methodCode exampleAddLayer
Adds the layer.
Public methodAddLayerGroup
Adds the layer group.
Public methodAddLevelsAdjustmentLayer
Adds the Levels adjustment layer.
Public methodAddPhotoFilterLayer
Adds the PhotoFilter layer.
Public methodCode exampleAddRegularLayer
Adds a new regular layer.
Public methodAddTextLayer
Adds a new Text layer.
Public methodAdjustBrightness
Adjust of a brightness for image.
(Overrides RasterCachedImageAdjustBrightness(Int32).)
Public methodAdjustContrast
Image contrasting
(Overrides RasterCachedImageAdjustContrast(Single).)
Public methodAdjustGamma(Single)
Gamma-correction of an image.
(Overrides RasterCachedImageAdjustGamma(Single).)
Public methodAdjustGamma(Single, Single, Single)
Gamma-correction of an image.
(Overrides RasterCachedImageAdjustGamma(Single, Single, Single).)
Public methodBinarizeBradley(Double)
Binarization of an image using Bradley's adaptive thresholding algorithm using the integral image thresholding
(Overrides RasterCachedImageBinarizeBradley(Double).)
Public methodBinarizeBradley(Double, Int32)
Binarization of an image using Bradley's adaptive thresholding algorithm using the integral image thresholding
(Overrides RasterCachedImageBinarizeBradley(Double, Int32).)
Public methodBinarizeFixed
Binarization of an image with predefined threshold
(Overrides RasterCachedImageBinarizeFixed(Byte).)
Public methodBinarizeOtsu
Binarization of an image with Otsu thresholding
(Overrides RasterCachedImageBinarizeOtsu.)
Public methodCacheData
Caches the data and ensures no additional data loading will be performed from the underlying DataStreamContainer.
(Inherited from RasterCachedImage.)
Public methodCanSave
Determines whether image can be saved to the specified file format represented by the passed save options.
(Inherited from Image.)
Public methodCrop(Rectangle)
Cropping the image.
(Overrides RasterCachedImageCrop(Rectangle).)
Public methodCrop(Int32, Int32, Int32, Int32)
Crop image with shifts.
(Inherited from RasterImage.)
Public methodDispose
Disposes the current instance.
(Inherited from DisposableObject.)
Public methodDither(DitheringMethod, Int32)
Performs dithering on the current image.
(Inherited from RasterImage.)
Public methodDither(DitheringMethod, Int32, IColorPalette)
Performs dithering on the current image.
(Overrides RasterCachedImageDither(DitheringMethod, Int32, IColorPalette).)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFilter
Filters the specified rectangle.
(Overrides RasterImageFilter(Rectangle, FilterOptionsBase).)
Public methodFlattenImage
Flattens all layers.
Public methodGetArgb32Pixel
Gets an image 32-bit ARGB pixel.
(Inherited from RasterImage.)
Public methodGetDefaultArgb32Pixels
Gets the default 32-bit ARGB pixels array.
(Inherited from RasterImage.)
Public methodGetDefaultOptions
Gets the default options.
(Inherited from Image.)
Public methodGetDefaultPixels
Gets the default pixels array using partial pixel loader.
(Inherited from RasterImage.)
Public methodGetDefaultRawData(Rectangle, RawDataSettings)
Gets the default raw data array.
(Inherited from RasterImage.)
Public methodGetDefaultRawData(Rectangle, IPartialRawDataLoader, RawDataSettings)
Gets the default raw data array using partial pixel loader.
(Inherited from RasterImage.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetModifyDate
Gets the date and time the resource image was last modified.
(Inherited from RasterImage.)
Public methodGetOriginalOptions
Gets the options based on the original file settings. This can be helpful to keep bit-depth and other parameters of the original image unchanged. For example, if we load a black-white PNG image with 1 bit per pixel and then save it using the Save(String) method, the output PNG image with 8-bit per pixel will be produced. To avoid it and save PNG image with 1-bit per pixel, use this method to get corresponding saving options and pass them to the Save(String, ImageOptionsBase) method as the second parameter.
(Inherited from Image.)
Public methodGetPixel
Gets an image pixel.
(Inherited from RasterImage.)
Public methodGetSkewAngle
Gets the skew angle. This method is applicable to scanned text documents, to determine the skew angle when scanning.
(Inherited from RasterImage.)
Public methodGetType
Gets the type of the current instance.
(Inherited from Object.)
Public methodGrayscale
Transformation of an image to its grayscale representation
(Overrides RasterCachedImageGrayscale.)
Public methodLoadArgb32Pixels
Loads 32-bit ARGB pixels.
(Inherited from RasterImage.)
Public methodLoadArgb64Pixels
Loads 64-bit ARGB pixels.
(Inherited from RasterImage.)
Public methodLoadCmyk32Pixels
Loads pixels in CMYK format.
(Inherited from RasterImage.)
Public methodLoadCmykPixels Obsolete.
Loads pixels in CMYK format. This method is deprecated. Please use more effective the LoadCmyk32Pixels(Rectangle) method.
(Inherited from RasterImage.)
Public methodLoadPartialArgb32Pixels
Loads 32-bit ARGB pixels partially by packs.
(Inherited from RasterImage.)
Public methodLoadPartialPixels
Loads pixels partially by packs.
(Inherited from RasterImage.)
Public methodCode exampleLoadPixels
Loads pixels.
(Inherited from RasterImage.)
Public methodLoadRawData(Rectangle, RawDataSettings, IPartialRawDataLoader)
Loads raw data.
(Inherited from RasterImage.)
Public methodLoadRawData(Rectangle, Rectangle, RawDataSettings, IPartialRawDataLoader)
Loads raw data.
(Inherited from RasterImage.)
Public methodMergeLayers
Merges the layers.
Public methodNormalizeAngle
Normalizes the angle. This method is applicable to scanned text documents to get rid of the skewed scan. This method uses GetSkewAngle and Rotate(Single) methods.
(Inherited from RasterImage.)
Public methodNormalizeAngle(Boolean, Color)
Normalizes the angle. This method is applicable to scanned text documents to get rid of the skewed scan. This method uses GetSkewAngle and Rotate(Single, Boolean, Color) methods.
(Inherited from RasterImage.)
Public methodReadArgb32ScanLine
Reads the whole scan line by the specified scan line index.
(Inherited from RasterImage.)
Public methodReadScanLine
Reads the whole scan line by the specified scan line index.
(Inherited from RasterImage.)
Public methodReplaceColor(Int32, Byte, Int32)
Replaces one color to another with allowed difference and preserves original alpha value to save smooth edges.
(Overrides RasterImageReplaceColor(Int32, Byte, Int32).)
Public methodReplaceColor(Color, Byte, Color)
Replaces one color to another with allowed difference and preserves original alpha value to save smooth edges.
(Inherited from RasterImage.)
Public methodReplaceNonTransparentColors(Int32)
Replaces all non-transparent colors with new color and preserves original alpha value to save smooth edges. Note: if you use it on images without transparency, all colors will be replaced with a single one.
(Overrides RasterImageReplaceNonTransparentColors(Int32).)
Public methodReplaceNonTransparentColors(Color)
Replaces all non-transparent colors with new color and preserves original alpha value to save smooth edges. Note: if you use it on images without transparency, all colors will be replaced with a single one.
(Inherited from RasterImage.)
Public methodCode exampleResize(Int32, Int32)
Resizes the image. The default LeftTopToLeftTop is used.
(Inherited from Image.)
Public methodResize(Int32, Int32, ImageResizeSettings)
Resizes the image.
(Inherited from RasterCachedImage.)
Public methodCode exampleResize(Int32, Int32, ResizeType)
Resizes the image.
(Inherited from RasterCachedImage.)
Public methodResizeHeightProportionally(Int32)
Resizes the height proportionally.
(Inherited from Image.)
Public methodResizeHeightProportionally(Int32, ImageResizeSettings)
Resizes the height proportionally.
(Overrides ImageResizeHeightProportionally(Int32, ImageResizeSettings).)
Public methodResizeHeightProportionally(Int32, ResizeType)
Resizes the height proportionally.
(Overrides ImageResizeHeightProportionally(Int32, ResizeType).)
Public methodResizeWidthProportionally(Int32)
Resizes the width proportionally.
(Inherited from Image.)
Public methodResizeWidthProportionally(Int32, ImageResizeSettings)
Resizes the width proportionally.
(Overrides ImageResizeWidthProportionally(Int32, ImageResizeSettings).)
Public methodResizeWidthProportionally(Int32, ResizeType)
Resizes the width proportionally.
(Overrides ImageResizeWidthProportionally(Int32, ResizeType).)
Public methodCode exampleRotate(Single)
Rotate image around the center.
(Overrides RasterImageRotate(Single).)
Public methodRotate(Single, Boolean, Color)
Rotate image around the center.
(Overrides RasterCachedImageRotate(Single, Boolean, Color).)
Public methodCode exampleRotateFlip
Rotates, flips, or rotates and flips the image.
(Inherited from RasterCachedImage.)
Public methodSave
Saves the image data to the underlying stream.
(Inherited from Image.)
Public methodSave(Stream)
Saves the object's data to the specified stream.
(Inherited from DataStreamSupporter.)
Public methodSave(String)
Saves the object's data to the specified file location.
(Inherited from DataStreamSupporter.)
Public methodSave(String, Boolean)
Saves the object's data to the specified file location.
(Inherited from DataStreamSupporter.)
Public methodCode exampleSave(Stream, ImageOptionsBase)
Saves the image's data to the specified stream in the specified file format according to save options.
(Inherited from Image.)
Public methodCode exampleSave(String, ImageOptionsBase)
Saves the object's data to the specified file location in the specified file format according to save options.
(Inherited from Image.)
Public methodSave(Stream, ImageOptionsBase, Rectangle)
Saves the image's data to the specified stream in the specified file format according to save options.
(Inherited from Image.)
Public methodSave(String, ImageOptionsBase, Rectangle)
Saves the object's data to the specified file location in the specified file format according to save options.
(Inherited from Image.)
Public methodSaveArgb32Pixels
Saves the 32-bit ARGB pixels.
(Inherited from RasterImage.)
Public methodSaveCmyk32Pixels
Saves the pixels.
(Inherited from RasterImage.)
Public methodSaveCmykPixels Obsolete. (Inherited from RasterImage.)
Public methodCode exampleSavePixels
Saves the pixels.
(Inherited from RasterImage.)
Public methodSaveRawData
Saves the raw data.
(Inherited from RasterImage.)
Public methodSetArgb32Pixel
Sets an image 32-bit ARGB pixel for the specified position.
(Inherited from RasterImage.)
Public methodSetPalette
Sets the image palette.
(Inherited from RasterImage.)
Public methodSetPixel
Sets an image pixel for the specified position.
(Inherited from RasterImage.)
Public methodSetResolution
Sets the resolution for this RasterImage.
(Inherited from RasterImage.)
Public methodToBitmap
Converts raster image to the bitmap.
(Inherited from RasterImage.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodWriteArgb32ScanLine
Writes the whole scan line to the specified scan line index.
(Inherited from RasterImage.)
Public methodWriteScanLine
Writes the whole scan line to the specified scan line index.
(Inherited from RasterImage.)
Fields
  NameDescription
Public fieldStatic memberDefaultVersion
The default PSD version.
Examples
The following code demonstrates ability to rotate the image by specific angle value.
[C#]

string sourceFileName = "TheHat.psd";
var pngOptions = new PngOptions() { ColorType = PngColorType.TruecolorWithAlpha };

// Whole image rotating
using (PsdImage image = (PsdImage)Image.Load(sourceFileName))
{
    for (int i = 0; i < 4; i++)
    {
        int angle = i * 45;
        image.Rotate(angle);

        string outFileName = "TheHatRotated" + angle + ".png";

        image.Save(outFileName, pngOptions);
    }
}

// Layer rotating
using (PsdImage image = (PsdImage)Image.Load(sourceFileName))
{
    for (int i = 0; i < 4; i++)
    {
        int angle = i * 45;
        image.Layers[1].Rotate(angle);

        string outFileName = "TheHatLayerRotated" + angle + ".png";

        image.Save(outFileName, pngOptions);
    }
}
See Also