# Struct ocl_core::types::structs::BufferRegion [−] [src]

    pub struct BufferRegion<T> { /* fields omitted */ }

Defines a buffer region for creating a sub-buffer.

### Info (from SDK)

(origin, size) defines the offset and size in bytes in buffer.

If buffer is created with CL_MEM_USE_HOST_PTR, the host_ptr associated with the buffer object returned is host_ptr + origin.

The buffer object returned references the data store allocated for buffer and points to a specific region given by (origin, size) in this data store.

CL_INVALID_VALUE is returned in errcode_ret if the region specified by (origin, size) is out of bounds in buffer.

CL_INVALID_BUFFER_SIZE if size is 0.

CL_MISALIGNED_SUB_BUFFER_OFFSET is returned in errcode_ret if there are no devices in context associated with buffer for which the origin value is aligned to the CL_DEVICE_MEM_BASE_ADDR_ALIGN value.

## Methods

### `impl<T: OclPrm> BufferRegion<T>`
[src]

#### `pub fn new(origin: usize, len: usize) -> BufferRegion<T>`
[src]

#### `pub fn to_bytes(&self) -> cl_buffer_region`
[src]

#### `pub fn from_bytes(ffi_struct: cl_buffer_region) -> BufferRegion<T>`
[src]

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)