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.
CloseFor 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| ptr | A pointer to the memory location of the struct. Ensure the pointer is valid and correctly allocated. |
T
A reference to the struct of type T. This reference allows changes to the struct at its current memory location.
Gets a reference to a struct at a specific memory location.
The AsRef method provides a reference to a struct directly in memory. This allows efficient data manipulation without copying. Use this method when performance is critical, and you must access data in-place. Improper use can lead to memory corruption, so always ensure pointer validity.
using UnityEngine; using Unity.Collections.LowLevel.Unsafe;
public class AsRefExample : MonoBehaviour { struct Position { public float X; public float Y; public float Z; }
void Start() { // Allocate memory for Position using stackalloc unsafe { Position* positionPtr = stackalloc Position[1];
// Set initial values positionPtr->X = 1.0f; positionPtr->Y = 2.0f; positionPtr->Z = 3.0f;
// Use AsRef to get a reference to the struct ref Position positionRef = ref UnsafeUtility.AsRef<Position>(positionPtr);
// Modify the struct through the reference positionRef.X = 10.0f; positionRef.Y = 20.0f; positionRef.Z = 30.0f;
// Output the modified values Debug.Log($"Modified Position: X = {positionPtr->X}, Y = {positionPtr->Y}, Z = {positionPtr->Z}"); } } }
Additional resources: UnsafeUtility.As.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.