VirtualSurfaceImageSource
VirtualSurfaceImageSource
VirtualSurfaceImageSource
VirtualSurfaceImageSource
Class
Definition
Extends SurfaceImageSource to support scenarios when the content is potentially larger than what can fit on screen and the content must be virtualized to render optimally.
public : sealed class VirtualSurfaceImageSource : SurfaceImageSource, IVirtualSurfaceImageSourcepublic sealed class VirtualSurfaceImageSource : SurfaceImageSource, IVirtualSurfaceImageSourcePublic NotInheritable Class VirtualSurfaceImageSource Inherits SurfaceImageSource Implements IVirtualSurfaceImageSource// This API is not available in Javascript.
- Inheritance
-
VirtualSurfaceImageSourceVirtualSurfaceImageSourceVirtualSurfaceImageSourceVirtualSurfaceImageSource
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Inherited Members
Inherited methods
Inherited properties
Remarks
This class has additional API, but those API are for Microsoft DirectX interoperation and are not part of the general app programming model otherwise described in this documentation. For example, from the Microsoft DirectX side, you can call BeginDraw. For more info on how to draw to a VirtualSurfaceImageSource, including sample code, see DirectX and XAML interop.
Constructors
VirtualSurfaceImageSource(Int32, Int32) VirtualSurfaceImageSource(Int32, Int32) VirtualSurfaceImageSource(Int32, Int32) VirtualSurfaceImageSource(Int32, Int32)
Initializes a new instance of the VirtualSurfaceImageSource class, specifying the size of the drawing area.
public : VirtualSurfaceImageSource(int pixelWidth, int pixelHeight)public VirtualSurfaceImageSource(Int32 pixelWidth, Int32 pixelHeight)Public Sub New(pixelWidth As Int32, pixelHeight As Int32)// This API is not available in Javascript.
- pixelWidth
- int Int32 Int32 Int32
Width of the drawing area in pixels.
- pixelHeight
- int Int32 Int32 Int32
Height of the drawing area in pixels.
Remarks
Windows 8 behavior
Windows 8 validates that pixelWidth and pixelHeight are under 100 million (100,000,000). Starting with Windows 8.1 the validation limit is 17 million (17,000,000) in each dimension. > [!NOTE]
Other factors might impact how much content can be rendered in a single VirtualSurfaceImageSource. For example, placing a VirtualSurfaceImageSource in a ScrollViewer might further reduce the effective size based on the ScrollViewer 's limits.
- See Also
VirtualSurfaceImageSource(Int32, Int32, Boolean) VirtualSurfaceImageSource(Int32, Int32, Boolean) VirtualSurfaceImageSource(Int32, Int32, Boolean) VirtualSurfaceImageSource(Int32, Int32, Boolean)
Initializes a new instance of the VirtualSurfaceImageSource class, specifying the size of the drawing area and a preference for whether to render with an alpha transparency.
public : VirtualSurfaceImageSource(int pixelWidth, int pixelHeight, bool isOpaque)public VirtualSurfaceImageSource(Int32 pixelWidth, Int32 pixelHeight, Boolean isOpaque)Public Sub New(pixelWidth As Int32, pixelHeight As Int32, isOpaque As Boolean)// This API is not available in Javascript.
- pixelWidth
- int Int32 Int32 Int32
Width of the drawing area in pixels.
- pixelHeight
- int Int32 Int32 Int32
Height of the drawing area in pixels.
- isOpaque
- bool Boolean Boolean Boolean
true if the area should render opaque. false to render with possible alpha transparency.
Remarks
Windows 8 behavior
Windows 8 validates that pixelWidth and pixelHeight are under 100 million (100,000,000). Starting with Windows 8.1 the validation limit is 17 million (17,000,000) in each dimension. > [!NOTE]
Other factors might impact how much content can be rendered in a single VirtualSurfaceImageSource. For example, placing a VirtualSurfaceImageSource in a ScrollViewer might further reduce the effective size based on the ScrollViewer 's limits.
- See Also