Enum
ImageProtocol
ConsoleMonster.Capabilities
How an inline image can be drawn. TerminalProfile.ImageProtocol reports the protocol an output may use: redirected, CI, plain, no-colour and 16-colour output always get ImageProtocol.None.
Inheritance
- Enum
- ImageProtocol
Usage
Explore 7 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 6
- Field ImageProtocol.HalfBlock
- Field ImageProtocol.ITerm2
- Field ImageProtocol.Kitty
- Field ImageProtocol.None
- Field ImageProtocol.Sixel
- Property TerminalProfile.ImageProtocol
Accepted by parameters 1
Inherited Methods
ToString 4 overloads
public string ToString(IFormatProvider? provider) #Inherited from Enum
Obsolete("The provider argument is not used. Use ToString() instead.")Parameters
- provider IFormatProvider?
Returns
stringpublic string ToString(string? format, IFormatProvider? provider) #Inherited from Enum
Obsolete("The provider argument is not used. Use ToString(String) instead.")Parameters
- format string?
- provider IFormatProvider?
Returns
stringValues
public const ImageProtocol None #No pixels: a text placeholder such as [image: chart.png 560x272] (no colour, redirected or CI output).
Value:
0public const ImageProtocol HalfBlock #Half blocks (▀) with a foreground and a background colour per cell, on any 256-colour or truecolor terminal.
Value:
1public const ImageProtocol Sixel #DEC Sixel graphics (Windows Terminal 1.22 and later), drawn on Windows Terminal's 10×20-pixel sixel cell.
Value:
2public const ImageProtocol ITerm2 #The iTerm2 inline image protocol, OSC 1337 File (iTerm2, WezTerm).
Value:
3