Microsoft Windows 10 Visuals API

The Visuals API from Microsoft Windows 10 — 1 operation(s) for visuals.

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/uwp/api/
📖
GettingStarted
https://learn.microsoft.com/en-us/windows/uwp/get-started/
📖
Documentation
https://learn.microsoft.com/en-us/windows/win32/apiindex/windows-api-list
📖
GettingStarted
https://learn.microsoft.com/en-us/windows/win32/desktop-programming
📖
Documentation
https://learn.microsoft.com/en-us/windows/uwp/design/shell/tiles-and-notifications/adaptive-interactive-toasts
📖
Documentation
https://learn.microsoft.com/en-us/windows/ai/windows-ml/api-reference
📖
GettingStarted
https://learn.microsoft.com/en-us/windows/ai/windows-ml/get-started
📖
Documentation
https://learn.microsoft.com/en-us/uwp/api/windows.storage
📖
GettingStarted
https://learn.microsoft.com/en-us/windows/uwp/files/
📖
Documentation
https://learn.microsoft.com/en-us/cortana/voice-commands/vcd
📖
Documentation
https://learn.microsoft.com/en-us/uwp/api/windows.ui.input.inking
📖
GettingStarted
https://learn.microsoft.com/en-us/windows/uwp/design/input/pen-and-stylus-interactions
📖
Documentation
https://learn.microsoft.com/en-us/windows/uwp/composition/visual-layer
📖
GettingStarted
https://learn.microsoft.com/en-us/windows/uwp/composition/using-the-visual-layer-with-xaml
📖
Documentation
https://learn.microsoft.com/en-us/windows/win32/directx
📖
GettingStarted
https://learn.microsoft.com/en-us/windows/win32/getting-started-with-directx-graphics
📖
Documentation
https://learn.microsoft.com/en-us/windows/apps/develop/audio-video-camera
📖
GettingStarted
https://learn.microsoft.com/en-us/windows/win32/medfound/audio-video-capture-in-media-foundation
📖
Documentation
https://learn.microsoft.com/en-us/windows/uwp/networking/which-networking-technology
📖
Documentation
https://learn.microsoft.com/en-us/windows/uwp/devices-sensors/bluetooth-dev-faq
📖
GettingStarted
https://learn.microsoft.com/en-us/windows/win32/bluetooth/bluetooth-programming-with-windows-sockets
📖
Documentation
https://learn.microsoft.com/en-us/uwp/api/windows.devices.geolocation
📖
Documentation
https://learn.microsoft.com/en-us/windows/win32/sensorsapi/introduction-to-the-sensor-and-location-platform-in-windows
📖
Documentation
https://learn.microsoft.com/en-us/windows/apps/develop/security/windows-hello
📖
GettingStarted
https://learn.microsoft.com/en-us/windows/apps/develop/security/windows-hello-auth-service
📖
Documentation
https://learn.microsoft.com/en-us/windows/apps/winui/winui2/
📖
GettingStarted
https://learn.microsoft.com/en-us/windows/apps/winui/winui2/getting-started
📖
Documentation
https://learn.microsoft.com/en-us/windows/apps/windows-app-sdk/applifecycle/background-tasks

Specifications

Other Resources

🔗
Samples
https://github.com/Microsoft/Windows-universal-samples
🔗
Reference
https://learn.microsoft.com/en-us/uwp/api/
🔗
SDKs
https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk/
🔗
Reference
https://learn.microsoft.com/en-us/windows/win32/api/
🔗
Samples
https://github.com/microsoft/Windows-classic-samples
🔗
Samples
https://github.com/WindowsNotifications/quickstart-sending-local-toast-win10
🔗
Reference
https://learn.microsoft.com/en-us/uwp/api/windows.ui.notifications
🔗
Tutorials
https://learn.microsoft.com/en-us/windows/ai/windows-ml/tutorials
🔗
Samples
https://github.com/Microsoft/Windows-Machine-Learning
🔗
Best Practices
https://learn.microsoft.com/en-us/windows/uwp/files/best-practices-for-writing-to-files
🔗
Guidelines
https://learn.microsoft.com/en-us/cortana/voice-commands/voicecommand-design-guidelines
🔗
Samples
https://github.com/Microsoft/Windows-universal-samples/tree/master/Samples/SimpleInk
🔗
Reference
https://learn.microsoft.com/en-us/uwp/api/windows.ui.composition
🔗
Samples
https://github.com/microsoft/Windows.UI.Composition-Win32-Samples
🔗
Samples
https://github.com/microsoft/DirectX-Graphics-Samples
🔗
Reference
https://microsoft.github.io/DirectX-Specs/
🔗
Reference
https://learn.microsoft.com/en-us/uwp/api/windows.media.capture
🔗
Reference
https://learn.microsoft.com/en-us/uwp/api/windows.networking.sockets
🔗
Samples
https://learn.microsoft.com/en-us/samples/microsoft/windows-universal-samples/websocket/
🔗
Reference
https://learn.microsoft.com/en-us/windows/win32/api/_bluetooth/
🔗
Reference
https://learn.microsoft.com/en-us/windows/win32/locationapi/windows-location-api-portal
🔗
Samples
https://learn.microsoft.com/en-us/samples/microsoft/windows-universal-samples/geolocation/
🔗
Reference
https://learn.microsoft.com/en-us/uwp/api/windows.devices.sensors
🔗
Reference
https://learn.microsoft.com/en-us/windows/security/identity-protection/hello-for-business/webauthn-apis
🔗
Reference
https://learn.microsoft.com/en-us/windows/winui/api/microsoft.ui.xaml.controls
🔗
Samples
https://github.com/microsoft/microsoft-ui-xaml
🔗
Samples
https://learn.microsoft.com/en-us/samples/microsoft/windows-universal-samples/backgroundtask/

OpenAPI Specification

microsoft-windows-10-visuals-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Microsoft Windows 10 Windows Background Tasks Accelerometer Visuals API
  description: API for running code in the background when an application is suspended or not running. Based on the Windows.ApplicationModel.Background namespace, it supports time-triggered, system-triggered, and maintenance-triggered background tasks. Key classes include BackgroundTaskBuilder, BackgroundTaskRegistration, SystemTrigger, TimeTrigger, and BackgroundTaskCompletedEventArgs.
  version: 1.0.0
  contact:
    name: Microsoft Developer Support
    url: https://learn.microsoft.com/en-us/windows/apps/windows-app-sdk/applifecycle/background-tasks
  license:
    name: Microsoft Software License
    url: https://www.microsoft.com/en-us/legal/terms-of-use
servers:
- url: https://api.windows.com
  description: Windows Platform API
tags:
- name: Visuals
paths:
  /composition/visuals:
    get:
      operationId: listVisuals
      summary: Microsoft Windows 10 List composition visuals
      description: Retrieves the list of visual objects in the composition tree. Visuals are the base building blocks of the visual layer, representing rectangular areas that can have size, position, opacity, clip, and transform properties. Types include SpriteVisual, ContainerVisual, LayerVisual, ShapeVisual, and RedirectVisual.
      tags:
      - Visuals
      responses:
        '200':
          description: Successful retrieval of visuals
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompositionVisual'
    post:
      operationId: createVisual
      summary: Microsoft Windows 10 Create a composition visual
      description: Creates a new visual object using the Compositor factory methods such as Compositor.CreateSpriteVisual, CreateContainerVisual, or CreateLayerVisual. The visual must be added to a visual tree to be rendered.
      tags:
      - Visuals
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateVisualRequest'
      responses:
        '201':
          description: Visual created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompositionVisual'
        '400':
          description: Invalid visual configuration
components:
  schemas:
    Vector3:
      type: object
      properties:
        x:
          type: number
          format: float
        y:
          type: number
          format: float
        z:
          type: number
          format: float
    CompositionVisual:
      type: object
      description: A composition visual object
      properties:
        id:
          type: string
          description: Visual identifier
        type:
          type: string
          enum:
          - SpriteVisual
          - ContainerVisual
          - LayerVisual
          - ShapeVisual
          - RedirectVisual
          description: Visual type
        offset:
          $ref: '#/components/schemas/Vector3'
        size:
          $ref: '#/components/schemas/Vector2'
        opacity:
          type: number
          format: float
          description: Opacity (0.0 to 1.0)
        rotationAngleInDegrees:
          type: number
          format: float
        scale:
          $ref: '#/components/schemas/Vector3'
        isVisible:
          type: boolean
        comment:
          type: string
          description: Developer comment for debugging
      required:
      - id
      - type
    Vector2:
      type: object
      properties:
        x:
          type: number
          format: float
        y:
          type: number
          format: float
    CreateVisualRequest:
      type: object
      properties:
        type:
          type: string
          enum:
          - SpriteVisual
          - ContainerVisual
          - LayerVisual
          - ShapeVisual
          description: Type of visual to create
        offset:
          $ref: '#/components/schemas/Vector3'
        size:
          $ref: '#/components/schemas/Vector2'
        opacity:
          type: number
          format: float
          default: 1.0
      required:
      - type
externalDocs:
  description: Background Tasks Documentation
  url: https://learn.microsoft.com/en-us/windows/apps/windows-app-sdk/applifecycle/background-tasks