[#llvm-GCRoot]
= xref:llvm.adoc[llvm]::GCRoot
:relfileprefix: ../
:mrdocs:

GCRoot ‐ Metadata for a pointer to an object managed by the garbage collector.

== Synopsis

Declared in `<llvm/CodeGen/GCMetadata.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
struct GCRoot;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/GCRoot/2constructor.adoc[`GCRoot`]         [.small]#[constructor]#
| Construct a stack‐root record.
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:llvm/GCRoot/Metadata.adoc[`Metadata`] 
| Metadata straight from the call to llvm.gcroot.
| xref:llvm/GCRoot/Num.adoc[`Num`] 
| Usually a frame index.
| xref:llvm/GCRoot/StackOffset.adoc[`StackOffset`] 
| Offset from the stack pointer.
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#