Class Texture.PropertyNames

Namespace

Sdl3Sharp.Video.Rendering

Assembly

Sdl3Sharp.dll

Provides property names for Texture properties

public abstract class Texture.PropertyNames

Inheritance

object

Texture.PropertyNames

Derived

Texture<TDriver>.PropertyNames

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Fields

AccessNumber

The name of a read-only property that holds the access mode of the texture

public const string AccessNumber = "SDL.texture.access"

Field Value

string

Remarks

The value of the associated property is any of the pre-defined TextureAccess values.

ColorSpaceNumber

The name of a read-only property that holds the color space of the texture

public const string ColorSpaceNumber = "SDL.texture.colorspace"

Field Value

string

Remarks

The value of the associated property is a ColorSpace describing the color space used by the texture.

CreateAccessNumber

The name of a property used when creating a that holds the access mode of the texture to create

public const string CreateAccessNumber = "SDL.texture.create.access"

Field Value

string

Remarks

The value of the associated property should be any of the pre-defined TextureAccess values describing the access mode that should be used by the newly created texture. This defaults to Static.

CreateColorSpaceNumber

The name of a property used when creating a that holds the color space of the texture to create

public const string CreateColorSpaceNumber = "SDL.texture.create.colorspace"

Field Value

string

Remarks

The value of the associated property should be a ColorSpace describing the color space that should be used by the newly created texture. This defaults to SrgbLinear for floating point textures, Hdr10 for 10-bit textures, Srgb for RGB textures and Jpeg for YUV textures.

CreateFormatNumber

The name of a property used when creating a that holds the pixel format of the texture to create

public const string CreateFormatNumber = "SDL.texture.create.format"

Field Value

string

Remarks

The value of the associated property should be any of the pre-defined PixelFormat values describing the pixel format that should be used by the newly created texture. This defaults to the best RGBA format for the renderer that creates the texture.

CreateHdrHeadroomFloat

The name of a property used when creating a that holds the maximum dynamic range for HDR10 and floating point Textures when creating them

public const string CreateHdrHeadroomFloat = "SDL.texture.create.HDR_headroom"

Field Value

string

Remarks

For HDR10 and floating point Textures, the value of the property defines the maximum dynamic range used by the content of the newly created texture, in terms of the SDR white point. This would be equivalent to the maximum content light level (maxCLL) divided by the SDR white point for HDR10 content. If the associated property is defined, any values outside of the range supported by the display will be scaled into the available HDR headroom, otherwise they will be clipped.

CreateHeightNumber

The name of a property used when creating a that holds the height of the texture to create

public const string CreateHeightNumber = "SDL.texture.create.height"

Field Value

string

Remarks

The height of the texture to create is given in pixels. This property is required when creating a texture. Although, you don't need to explicitly specify this property if you set the height parameter in a call to the TryCreateTexture(out Texture?, ColorSpace?, PixelFormat?, TextureAccess?, int?, int?, Palette?, float?, float?, Properties?) method.

CreatePalettePointer

The name of a property used when creating a that holds the palette to use when creating a Texture with a palettized pixel format

public const string CreatePalettePointer = "SDL.texture.create.palette"

Field Value

string

Remarks

This can be set or changed later using the Palette property of a Texture.

CreateSdrWhitePointFloat

The name of a property used when creating a that holds the defining value for 100% diffuse white for HDR10 and floating point Textures when creating them

public const string CreateSdrWhitePointFloat = "SDL.texture.create.SDR_white_point"

Field Value

string

Remarks

For HDR10 and floating point Textures, the value of the property defines the value of 100% diffuse white that should be used by the newly created texture, with higher values being displayed in the High Dynamic Range headroom. This defaults to 100 for HDR10 textures and 1.0 for other textures.

CreateWidthNumber

The name of a property used when creating a that holds the width of the texture to create

public const string CreateWidthNumber = "SDL.texture.create.width"

Field Value

string

Remarks

The width of the texture to create is given in pixels. This property is required when creating a texture. Although, you don't need to explicitly specify this property if you set the width parameter in a call to the TryCreateTexture(out Texture?, ColorSpace?, PixelFormat?, TextureAccess?, int?, int?, Palette?, float?, float?, Properties?) method.

FormatNumber

The name of a read-only property that holds the pixel format of the texture

public const string FormatNumber = "SDL.texture.format"

Field Value

string

Remarks

The value of the associated property is any of the pre-defined PixelFormat values.

HdrHeadroomFloat

The name of a read-only property that holds the maximum dynamic range for HDR10 and floating point Textures

public const string HdrHeadroomFloat = "SDL.texture.HDR_headroom"

Field Value

string

Remarks

For HDR10 and floating point Textures, the value of the property defines the maximum dynamic range used by the content, in terms of the SDR white point. If the associated property is defined, any values outside of the range supported by the display will be scaled into the available HDR headroom, otherwise they will be clipped. This defaults to 1.0 for SDR textures, 4.0 for HDR10 textures and has no default for floating point textures.

HeightNumber

The name of a read-only property that holds the height of the texture

public const string HeightNumber = "SDL.texture.height"

Field Value

string

Remarks

The height of the texture is given in pixels.

SdrWhitePointFloat

The name of a read-only property that holds the defining value for 100% diffuse white for HDR10 and floating point Textures

public const string SdrWhitePointFloat = "SDL.texture.SDR_white_point"

Field Value

string

Remarks

For HDR10 and floating point Textures, the value of the property defines the value of 100% diffuse white, with higher values being displayed in the High Dynamic Range headroom. This defaults to 100 for HDR10 textures and 1.0 for other textures.

WidthNumber

The name of a read-only property that holds the width of the texture

public const string WidthNumber = "SDL.texture.width"

Field Value

string

Remarks

The width of the texture is given in pixels.