[ Web Proxy ]
URL:
Viewing: https://docs.unity3d.com/ScriptReference/Handles.CapFunction.html [Back]  [Original]
Unity - Scripting API: Handles.CapFunction
Version: Unity 6.5 (6000.5)
    • Supported
    • Legacy
    LanguageEnglish
    • C#

    Handles.CapFunction

    Leave feedback
    Suggest a change

    Success!

    Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

    Close

    Submission failed

    For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

    Close
    Your name Your email Suggestion* Submit suggestion

    Cancel

    Declaration

    public delegate void CapFunction(int controlID, Vector3 position, Quaternion rotation, float size, EventType eventType);

    Parameters

    Parameter Description
    controlID The control ID for the handle.
    position The position of the handle in the space of Handles.matrix.
    rotation The rotation of the handle in the space of Handles.matrix.
    size The size of the handle in world-space units.
    eventType Event type for the handle to act upon. By design it handles EventType.Layout and EventType.Repaint events.

    Description

    The function to use for drawing the handle e.g. Handles.RectangleCap.

    Custom CapFunction has two responsibilities:

    1. For EventType.Layout event, call HandleUtility.AddControl to inform Unity about the distance of the handle from mouse position.
    2. For EventType.Repaint event, render the actual handle.

    Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

    Copyright 2005-2026 Unity Technologies. All rights reserved. Built from job ID 74033673. Built on: 2026-08-24.
    Tutorials Community Answers Knowledge Base Forums Asset Store Terms of use Legal Privacy Policy Cookies Documentation Terms of Use Do Not Sell or Share My Personal Information
    Web Proxy Viewer  |  New URL  |  Original Page