Class Renderer.PropertyNames
Provides property names for Renderer properties
public abstract class Renderer.PropertyNames- Inheritance
-
Renderer.PropertyNames
- Derived
- Inherited Members
Fields
CreateNameString
The name of a property used when creating a that holds the name of the rendering driver that the renderer should use
public const string CreateNameString = "SDL.renderer.create.name"Field Value
Remarks
If this property is specified when creating a renderer, SDL will attempt to use that specific rendering driver and if it fails, the renderer creation will fail. Otherwise, if this property is not specified when creating a renderer, SDL will attempt to choose the "best" rendering driver available for you.
CreateOutputColorSpaceNumber
The name of a property used when creating a that hold the color space that the renderer should use for presenting to the output display
public const string CreateOutputColorSpaceNumber = "SDL.renderer.create.output_colorspace"Field Value
Remarks
The Direct3D 11, Direct3D 12, and Metal renderers support SrgbLinear,
which is a linear color space and supports HDR output. In that case, drawing still uses the sRGB color space, but individual values can go beyond 1.0
and floating point textures can be used for HDR content.
This defaults to Srgb.
CreatePresentVSyncNumber
The name of a property used when creating a that holds the initial vsync setting of the renderer
public const string CreatePresentVSyncNumber = "SDL.renderer.create.present_vsync"Field Value
Remarks
See RendererVSync and RendererVSyncExtensions for more information about the possible values of this property and their meaning.
CreateWindowPointer
The name of a property used when creating a that holds a pointer to the Window that the renderer should be associated with
public const string CreateWindowPointer = "SDL.renderer.create.window"Field Value
Remarks
Specifying this property is required when creating a renderer, except when you want to create a software renderer that's associated with a Surface instead, in which case you're required to specify the Sdl3Sharp.Video.Rendering.RendererExtensions.get_CreateSoftwareSurfacePointer() property instead.
If you don't specify this property (or Sdl3Sharp.Video.Rendering.RendererExtensions.get_CreateSoftwareSurfacePointer() when creating a software renderer), the renderer creation will fail.
HdrEnabledBoolean
The name of a read-only property that holds whether the renderer is presenting to a display with HDR enabled
public const string HdrEnabledBoolean = "SDL.renderer.HDR_enabled"Field Value
Remarks
The value of the associated property can change dynamically at runtime when a WindowHdrStateChanged event (WindowEvent) is sent.
HdrHeadroomFloat
The name of a read-only property that holds the additional high dynamic range that can be displayed, in terms of the SDR white point
public const string HdrHeadroomFloat = "SDL.renderer.HDR_headroom"Field Value
Remarks
The value of the associated property will be 1.0 when HDR is not enabled.
This property can change dynamically at runtime when a WindowHdrStateChanged event (WindowEvent) is sent.
MaxTextureSizeNumber
The name of a read-only property that holds the maximum texture size supported by the renderer
public const string MaxTextureSizeNumber = "SDL.renderer.max_texture_size"Field Value
Remarks
The value of the associated property is in regards to both width and height of the texture.
E.g. if the value is 4096, then the renderer supports textures up to 4096тип4096 in size.
NameString
The name of a read-only property that holds the name of the rendering driver of the renderer
public const string NameString = "SDL.renderer.name"Field Value
Remarks
The value of the associated property can be compared against the name of any pre-defined rendering driver implementing the IRenderingDriver interface to determine whether the renderer is using that driver.
OutputColorSpaceNumber
The name of a read-only property that holds the color space used by the renderer for presenting to the output display
public const string OutputColorSpaceNumber = "SDL.renderer.output_colorspace"Field Value
Remarks
The value of the associated property defaults to Srgb.
SdrWhitePointFloat
The name of a read-only property that holds the SDR white point in the SrgbLinear color space
public const string SdrWhitePointFloat = "SDL.renderer.SDR_white_point"Field Value
Remarks
The value of the associated property is automatically multiplied into the color scale when HDR is enabled. This property can change dynamically at runtime when a WindowHdrStateChanged event (WindowEvent) is sent.
TextureFormatsPointer
The name of a read-only property that holds a pointer to an array of pixel formats supported by textures created by the renderer
public const string TextureFormatsPointer = "SDL.renderer.texture_formats"Field Value
Remarks
The array pointed by the value of the associated property is terminated by a Unknown value.
TextureWrappingBoolean
The name of a read-only property that holds whether the renderer supports texture address wrapping on non-power-of-two textures
public const string TextureWrappingBoolean = "SDL.renderer.texture_wrapping"Field Value
Remarks
The value of the associated property determines whether the renderer supports Wrap on textures that don't have power-of-two dimensions.
VSyncNumber
The name of a read-only property that holds the current vsync setting of the renderer
public const string VSyncNumber = "SDL.renderer.vsync"Field Value
Remarks
See RendererVSync and RendererVSyncExtensions for more information about the possible values of this property and their meaning.
WindowPointer
The name of a read-only property that holds the window associated with the renderer, if any
public const string WindowPointer = "SDL.renderer.window"Field Value
Remarks
The value of the associated property can be the null pointer if the renderer is a software renderer that's associated with a Surface instead.