Class Surface.PropertyNames

Namespace

Sdl3Sharp.Video

Assembly

Sdl3Sharp.dll

Provides property names for Surface properties

public static class Surface.PropertyNames

Inheritance

object

Surface.PropertyNames

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Fields

HdrHeadroomFloat

The name of a property that holds the maximum dynamic range for HDR10 and floating point Surfaces

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

Field Value

string

Remarks

For HDR10 and floating point Surfaces, the value of the property defines the maximum dynamic range used by the content, in terms of the SDR white point. This defaults to 0.0, which disables tone mapping.

HotspotXNumber

The name of a property that holds the hotspot pixel offset from the left edge for a cursor

public const string HotspotXNumber = "SDL.surface.hotspot.x"

Field Value

string

Remarks

The value of the property defines the pixel offset to the hotspot from the left edge of the Surface used as a cursor.

HotspotYNumber

The name of a property that holds the hotspot pixel offset from the top edge for a cursor

public const string HotspotYNumber = "SDL.surface.hotspot.y"

Field Value

string

Remarks

The value of the property defines the pixel offset to the hotspot from the top edge of the Surface used as a cursor.

RotationFloat

The name of a property that holds the rotation angle in degrees for the Surface

public const string RotationFloat = "SDL.surface.rotation"

Field Value

string

Remarks

The value of the property defines the number of degrees a Surface's pixel data is meant to be rotated clockwise to make the image right-side up. This defaults to 0.

This is used by the camera API, if a mobile device is oriented differently than what its camera provides (i.e. the camera always provides portrait images but the phone is being held in landscape orientation).

SdrWhitePointFloat

The name of a property that holds the defining value for 100% diffuse white for HDR10 and floating point Surfaces

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

Field Value

string

Remarks

For HDR10 and floating point Surfaces, 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 203 for HDR10 surfaces and 1.0 for floating point surfaces.

TonemapOperatorString

The name of a property that holds the expression of the tone mapping operator used when compressing from a higher dynamic range to a lower dynamic range

public const string TonemapOperatorString = "SDL.surface.tonemap"

Field Value

string

Remarks

The value of the property defines the tone mapping operator used when compressing from a Surface with high dynamic range to another with lower dynamic range. Currently this supports the following values:

• "chrome"The same tone mapping that Chrome uses for HDR content
• "*=N" where N is a floating point numberN is a floating point scale factor applied in linear. E.g. "*=0.5".
• "none"Tone mapping is disabled

This defaults to "chrome".