# gvr::Frame

`#include <gvr.h>`

Convenience C++ wrapper for gvr_frame, which represents a single frame acquired for rendering from the swap chain.

## Summary

### Inheritance

Inherits from: [gvr::WrapperBase\< gvr_frame \>](https://developers.google.com/vr/reference/android-ndk/class/gvr/wrapper-base)

| ### Public functions ||
|---|---|
| `https://developers.google.com/vr/reference/android-ndk/class/gvr/frame#classgvr_1_1_frame_1aa41c96f4d48473872297d40f75d7da37(int32_t index)` | `void` For more information, see [gvr_frame_bind_buffer()](https://developers.google.com/vr/reference/android-ndk/group/swap-chain#group__swap__chain_1ga2b4c3bcbafd91f8ffec65d8d0f2b6164). |
| `https://developers.google.com/vr/reference/android-ndk/class/gvr/frame#classgvr_1_1_frame_1abca8ed215676db354495e3edcf67d41e(int32_t index) const ` | `https://developers.google.com/vr/reference/android-ndk/struct/gvr-sizei#structgvr__sizei` For more information, see [gvr_frame_get_buffer_size()](https://developers.google.com/vr/reference/android-ndk/group/swap-chain#group__swap__chain_1ga9c9c1429032421a66eb1aa5cdd6f3e84). |
| `https://developers.google.com/vr/reference/android-ndk/class/gvr/frame#classgvr_1_1_frame_1aa7035edab6359aa95c407fcbf21c000a(int32_t index) const ` | `int32_t` For more information, see [gvr_frame_get_framebuffer_object()](https://developers.google.com/vr/reference/android-ndk/group/swap-chain#group__swap__chain_1gaed7412f1ec9f3ef887d8ce08c7940f23). |
| `https://developers.google.com/vr/reference/android-ndk/class/gvr/frame#classgvr_1_1_frame_1a1d8e4c4a8bb3a1b8c51e77a88b0fe7eb(int32_t index) const ` | `void *` For more information, see [gvr_frame_get_hardware_buffer()](https://developers.google.com/vr/reference/android-ndk/group/swap-chain#group__swap__chain_1gaf878e168841607c080e8f41bc39b4e82). |
| `https://developers.google.com/vr/reference/android-ndk/class/gvr/frame#classgvr_1_1_frame_1ad8126bad1830d06af5741b8773871ca5(const https://developers.google.com/vr/reference/android-ndk/class/gvr/buffer-viewport-list#classgvr_1_1_buffer_viewport_list & viewport_list, const https://developers.google.com/vr/reference/android-ndk/struct/gvr-mat4f#structgvr__mat4f & head_space_from_start_space)` | `void` For more information, see [gvr_frame_submit()](https://developers.google.com/vr/reference/android-ndk/group/swap-chain#group__swap__chain_1ga5dc0908bf831ecfb22d8393bff87b690). |
| `https://developers.google.com/vr/reference/android-ndk/class/gvr/frame#classgvr_1_1_frame_1a8b3ff9ef03186b87b614784c5cbe3639()` | `void` For more information, see [gvr_frame_unbind()](https://developers.google.com/vr/reference/android-ndk/group/swap-chain#group__swap__chain_1gabe21d16b332a8f8a1f2219d0c5e535ce). |

## Public functions

### BindBuffer

```
void BindBuffer(
  int32_t index
)
```
For more information, see [gvr_frame_bind_buffer()](https://developers.google.com/vr/reference/android-ndk/group/swap-chain#group__swap__chain_1ga2b4c3bcbafd91f8ffec65d8d0f2b6164).

### GetBufferSize

```
Sizei GetBufferSize(
  int32_t index
) const 
```
For more information, see [gvr_frame_get_buffer_size()](https://developers.google.com/vr/reference/android-ndk/group/swap-chain#group__swap__chain_1ga9c9c1429032421a66eb1aa5cdd6f3e84).

### GetFramebufferObject

```
int32_t GetFramebufferObject(
  int32_t index
) const 
```
For more information, see [gvr_frame_get_framebuffer_object()](https://developers.google.com/vr/reference/android-ndk/group/swap-chain#group__swap__chain_1gaed7412f1ec9f3ef887d8ce08c7940f23).

### GetHardwareBuffer

```
void * GetHardwareBuffer(
  int32_t index
) const 
```
For more information, see [gvr_frame_get_hardware_buffer()](https://developers.google.com/vr/reference/android-ndk/group/swap-chain#group__swap__chain_1gaf878e168841607c080e8f41bc39b4e82).

### Submit

```
void Submit(
  const BufferViewportList & viewport_list,
  const Mat4f & head_space_from_start_space
)
```
For more information, see [gvr_frame_submit()](https://developers.google.com/vr/reference/android-ndk/group/swap-chain#group__swap__chain_1ga5dc0908bf831ecfb22d8393bff87b690).

### Unbind

```
void Unbind()
```
For more information, see [gvr_frame_unbind()](https://developers.google.com/vr/reference/android-ndk/group/swap-chain#group__swap__chain_1gabe21d16b332a8f8a1f2219d0c5e535ce).