flecs::table_range Struct Reference

Table range. More...

#include <table.hpp>

Public Member Functions
	table_range ()
	Default constructor.
	table_range (world_t *world, table_t *t, int32_t offset, int32_t count)
	Construct a table range from a world, table, offset, and count.
int32_t	offset () const
	Get the offset of the range.
int32_t	count () const
	Get the number of entities in the range.
void *	get_column (int32_t index) const override
	Get a pointer to the component array by column index.
Public Member Functions inherited from flecs::table
	table ()
	Default constructor.
	table (world_t *world, table_t *t)
	Construct a table from a world and C table pointer.
virtual	~table ()
	Destructor.
flecs::string	str () const
	Convert the table type to a string.
flecs::type	type () const
	Get the table type.
int32_t	count () const
	Get the table count.
int32_t	size () const
	Get the number of allocated elements in the table.
const flecs::entity_t *	entities () const
	Get the array of entity IDs.
void	clear_entities () const
	Delete entities in the table.
template<typename... T, typename... Args>
int32_t	type_index (Args... args) const
template<typename... T, typename... Args>
int32_t	column_index (Args... args) const
template<typename... T, typename... Args>
bool	has (Args... args) const
template<typename... T, typename... Args>
auto	try_get (Args... args) const
template<typename... T, typename... Args>
auto	get (Args... args) const
size_t	column_size (int32_t index) const
	Get the column size.
int32_t	depth (flecs::entity_t rel) const
	Get the depth for a given relationship.
template<typename Rel>
int32_t	depth () const
	Get the depth for a given relationship.
ecs_table_records_t	records () const
	Get the table records array.
uint64_t	id () const
	Get the table ID.
void	lock () const
	Lock the table.
void	unlock () const
	Unlock the table.
bool	has_flags (ecs_flags32_t flags) const
	Check if the table has flags.
table_t *	get_table () const
	Get the table.
	operator table_t * () const
	Implicit conversion to table_t*.

Additional Inherited Members
Protected Attributes inherited from flecs::table
world_t *	world_
table_t *	table_

Detailed Description

Table range.

A table range represents a contiguous range of entities in a table.

Definition at line 205 of file table.hpp.

Constructor & Destructor Documentation

table_range() [1/2]

flecs::table_range::table_range ( )

inline

Default constructor.

Definition at line 207 of file table.hpp.

table_range() [2/2]

flecs::table_range::table_range ( world_t * world, table_t * t, int32_t offset, int32_t count )

inline

Construct a table range from a world, table, offset, and count.

Parameters

world	The world.
t	Pointer to the C table.
offset	The starting row offset.
count	The number of rows in the range.

Definition at line 219 of file table.hpp.

Member Function Documentation

count()

int32_t flecs::table_range::count ( ) const

inline

Get the number of entities in the range.

Definition at line 230 of file table.hpp.

get_column()

void * flecs::table_range::get_column ( int32_t index ) const

inlineoverridevirtual

Get a pointer to the component array by column index.

Parameters

index

The column index.

Returns

Pointer to the column, nullptr if not a component.

Reimplemented from flecs::table.

Definition at line 239 of file table.hpp.

offset()

int32_t flecs::table_range::offset ( ) const

inline

Get the offset of the range.

Definition at line 225 of file table.hpp.

---

The documentation for this struct was generated from the following file:

• include/flecs/addons/cpp/table.hpp