Project

ImagePlayground

Automate image processing, codes, metadata, charts, topology, and visual stories from PowerShell.

Stars 100
Forks 7
Total downloads 712,347
Release ImagePlayground-PowerShellModule.v3.2.7
Language: C# Updated: 2026-08-25

API Reference

Command

Get-Image

Namespace ImagePlayground
Inputs
System.String

Loads an image from disk.

Remarks

Returns a SixLabors.ImageSharp.Image object for further processing.

Examples

Authored help example

Read an image


$img = Get-Image -FilePath sample.png
        

Check dimensions


(Get-Image -FilePath sample.png).Width
        

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

Get-Image -FilePath <String> [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

FilePath String requiredposition: 0pipeline: True (ByValue)
The file must exist.